diff --git a/raw/rel-18/29_series/29002/0a75caa32bf3096417c03cfc94efb1f5_img.jpg b/raw/rel-18/29_series/29002/0a75caa32bf3096417c03cfc94efb1f5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..add8666601ac4e670c4cc6ec966f7f1598c8c110 --- /dev/null +++ b/raw/rel-18/29_series/29002/0a75caa32bf3096417c03cfc94efb1f5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:65243b91569df1158e6e0ae08934bade844ca5529843e2b7e4a71ce6fbc45109 +size 123174 diff --git a/raw/rel-18/29_series/29002/0d333f1ed20780e733957984b3ee1a76_img.jpg b/raw/rel-18/29_series/29002/0d333f1ed20780e733957984b3ee1a76_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..258cca8c1120300f9b4ae8ab3ff3fa67f66b2e4d --- /dev/null +++ b/raw/rel-18/29_series/29002/0d333f1ed20780e733957984b3ee1a76_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8f78bbe37a2d00dcdbf99482727756f5148899bb62e6177af03b34a8462bd82a +size 76258 diff --git a/raw/rel-18/29_series/29002/14aaccd030ccca62597f3c5034f49061_img.jpg b/raw/rel-18/29_series/29002/14aaccd030ccca62597f3c5034f49061_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2e165259ba2b145f919b9f51e725a742178b827a --- /dev/null +++ b/raw/rel-18/29_series/29002/14aaccd030ccca62597f3c5034f49061_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4e79ea1858ae3d0738a8372b646090fd99c9383e357493a59416b41fefed2465 +size 75338 diff --git a/raw/rel-18/29_series/29002/157b9aaba9418b037266b482404acae7_img.jpg b/raw/rel-18/29_series/29002/157b9aaba9418b037266b482404acae7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a98147c7a15f9690055ce754379ab15f1e1ffedc --- /dev/null +++ b/raw/rel-18/29_series/29002/157b9aaba9418b037266b482404acae7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c97eb5ec46758a15a9c5e598996e963a49037f722386d136cf00a401fa0c996d +size 106910 diff --git a/raw/rel-18/29_series/29002/1f3c29c51892700d40eaee37ed6b870c_img.jpg b/raw/rel-18/29_series/29002/1f3c29c51892700d40eaee37ed6b870c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..50822086c5cf5db05ac3bdd38f625260c6a6f044 --- /dev/null +++ b/raw/rel-18/29_series/29002/1f3c29c51892700d40eaee37ed6b870c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f1a5e08f40f198ebf0df80bb0417dd3dfdad9d3240128ae2bb2c193154adfe32 +size 96348 diff --git a/raw/rel-18/29_series/29002/1fc0375eeb03547ee607c15fef041f56_img.jpg b/raw/rel-18/29_series/29002/1fc0375eeb03547ee607c15fef041f56_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8cf53b370731fb138413716f329d5b48db4878ef --- /dev/null +++ b/raw/rel-18/29_series/29002/1fc0375eeb03547ee607c15fef041f56_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c20868cf90ecbb4e18155b8a0040a69cd66e2008604456923a45ca8d51a68898 +size 86921 diff --git a/raw/rel-18/29_series/29002/24508c55181829a29c6681322035ca67_img.jpg b/raw/rel-18/29_series/29002/24508c55181829a29c6681322035ca67_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3e3ddb9bc7b13becb4bc6c85076d487543caa013 --- /dev/null +++ b/raw/rel-18/29_series/29002/24508c55181829a29c6681322035ca67_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fdd3dc3414df9a946f5813fc5a6d4063753a3cf83a7890af7236a9f3cecbb06f +size 127259 diff --git a/raw/rel-18/29_series/29002/25bc80f6f672ad2534ff1e7eae570971_img.jpg b/raw/rel-18/29_series/29002/25bc80f6f672ad2534ff1e7eae570971_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..58f840b2ee1af80c973aede870d5686596b0a6ec --- /dev/null +++ b/raw/rel-18/29_series/29002/25bc80f6f672ad2534ff1e7eae570971_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c3940c720e2196f7e09b8f9f2c3548aeb13acfedf4542e69804b10a9d45e0ba9 +size 55864 diff --git a/raw/rel-18/29_series/29002/33449456be26bf6ac2d988e9db39ba2f_img.jpg b/raw/rel-18/29_series/29002/33449456be26bf6ac2d988e9db39ba2f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e07a63ee44e99342165091764dfdb5eb90f854ed --- /dev/null +++ b/raw/rel-18/29_series/29002/33449456be26bf6ac2d988e9db39ba2f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:217860f399d5b91df2d23fac87c641ecf0895b4114e1f4d5f2e640b63890b4d2 +size 107688 diff --git a/raw/rel-18/29_series/29002/436937dfff8d225780cc49207a18e87f_img.jpg b/raw/rel-18/29_series/29002/436937dfff8d225780cc49207a18e87f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..98ce2d72bb499ed758df5ea052618715a71c808f --- /dev/null +++ b/raw/rel-18/29_series/29002/436937dfff8d225780cc49207a18e87f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:58358c4ee8b5b68265208ec0d4985518817eb59d55fbb27bc13e7d3bb9718ca1 +size 11578 diff --git a/raw/rel-18/29_series/29002/43cfb9718d89aae4f22d31e2cdc704f1_img.jpg b/raw/rel-18/29_series/29002/43cfb9718d89aae4f22d31e2cdc704f1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fdb81b2245a7d7fe3dfad8619130c65a9640f04b --- /dev/null +++ b/raw/rel-18/29_series/29002/43cfb9718d89aae4f22d31e2cdc704f1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4952090a098a189de6fff08af106be09a736f3d06e05c7c99e3c4ce5850e13c7 +size 38328 diff --git a/raw/rel-18/29_series/29002/478a57893fbff452d4943a78b725a07e_img.jpg b/raw/rel-18/29_series/29002/478a57893fbff452d4943a78b725a07e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0acb5f5e5333616883f54a3b7992dc92e2814491 --- /dev/null +++ b/raw/rel-18/29_series/29002/478a57893fbff452d4943a78b725a07e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bb091885fead6492f6bacb4a6ea2c2a802dd69f25684063342dc8f6d85ba0096 +size 14139 diff --git a/raw/rel-18/29_series/29002/4965ba9124b08743865ab2ca64355ac0_img.jpg b/raw/rel-18/29_series/29002/4965ba9124b08743865ab2ca64355ac0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..66c073e4b15b6042b88303ae9852c2d44e97339d --- /dev/null +++ b/raw/rel-18/29_series/29002/4965ba9124b08743865ab2ca64355ac0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:23a60b690934f3596a9d3b358ffca8d3b95359e5f9ec029d605d6b12aad3289f +size 13564 diff --git a/raw/rel-18/29_series/29002/4ca9477ab422c43c6f5ac022fa8b7baa_img.jpg b/raw/rel-18/29_series/29002/4ca9477ab422c43c6f5ac022fa8b7baa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ed93aa986a5ef0aee88027e55f54dec0b540d4e5 --- /dev/null +++ b/raw/rel-18/29_series/29002/4ca9477ab422c43c6f5ac022fa8b7baa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:530aec195a781a58cc92e89b2b350f3be12fd95d0b2d3470421cb55cc41d9f2b +size 103584 diff --git a/raw/rel-18/29_series/29002/514150054ea2e72f86da03de4e230d7d_img.jpg b/raw/rel-18/29_series/29002/514150054ea2e72f86da03de4e230d7d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..43a6bf06903ab43ca3f0d44f66b53f99a89d5a3c --- /dev/null +++ b/raw/rel-18/29_series/29002/514150054ea2e72f86da03de4e230d7d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:675702786e36a63b38441c0877ed41253cde5a348fdc37e9d547f8caef25f623 +size 57470 diff --git a/raw/rel-18/29_series/29002/5175a695be4c949bfb94d01307f8e0fa_img.jpg b/raw/rel-18/29_series/29002/5175a695be4c949bfb94d01307f8e0fa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2a1598d78d989389e35921c7d16725a5d0b769ad --- /dev/null +++ b/raw/rel-18/29_series/29002/5175a695be4c949bfb94d01307f8e0fa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1a9d5a6f1e9a321987813ec52fb9e4168736ba11f80e82f3b15184ed0f0f151a +size 66883 diff --git a/raw/rel-18/29_series/29002/524bf86b6b42612b7ec0d0a04b04a708_img.jpg b/raw/rel-18/29_series/29002/524bf86b6b42612b7ec0d0a04b04a708_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..82df834705cc601220cfa9f47b34656fc895ee95 --- /dev/null +++ b/raw/rel-18/29_series/29002/524bf86b6b42612b7ec0d0a04b04a708_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b068f5559f9303d445b4ce454ece823de5d1bc0040f34ff78843d6d211ad5236 +size 73629 diff --git a/raw/rel-18/29_series/29002/5663991a761141b2ebb40327ca5231de_img.jpg b/raw/rel-18/29_series/29002/5663991a761141b2ebb40327ca5231de_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f577a7aca8a28bbdb92f3f4000cd0a941a577368 --- /dev/null +++ b/raw/rel-18/29_series/29002/5663991a761141b2ebb40327ca5231de_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:61e197b6c2a6b5bd3e7508f2bf028f0bfd343e7b9f490818f84978389a2aa13a +size 109588 diff --git a/raw/rel-18/29_series/29002/56649cc9e7ebcf10ce69f4c018e67419_img.jpg b/raw/rel-18/29_series/29002/56649cc9e7ebcf10ce69f4c018e67419_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1853624f8862fd53dcc95766083a47ec990f8190 --- /dev/null +++ b/raw/rel-18/29_series/29002/56649cc9e7ebcf10ce69f4c018e67419_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:13a4a35e18681a26123f08c39b814ba43dbaa023dac4ffd54a34289bebb69264 +size 121939 diff --git a/raw/rel-18/29_series/29002/5a0427b4033881484e387d85b8d8fa77_img.jpg b/raw/rel-18/29_series/29002/5a0427b4033881484e387d85b8d8fa77_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f254189bf7fe9ff925198ed5939e31360c82d64e --- /dev/null +++ b/raw/rel-18/29_series/29002/5a0427b4033881484e387d85b8d8fa77_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:abcb5c5cceb239491e13429503327cdc157afd1d3634432364ee442a412f0f53 +size 38377 diff --git a/raw/rel-18/29_series/29002/63db7f66a26834861edbcf76049f647c_img.jpg b/raw/rel-18/29_series/29002/63db7f66a26834861edbcf76049f647c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3e400e3735d328912b5105c59afeeabd38031466 --- /dev/null +++ b/raw/rel-18/29_series/29002/63db7f66a26834861edbcf76049f647c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5247b061dcb7105b64b056654651878059f2dbcbea4e04975b92492fdc361343 +size 142630 diff --git a/raw/rel-18/29_series/29002/6994939b855d6bde94efb2f31dee555e_img.jpg b/raw/rel-18/29_series/29002/6994939b855d6bde94efb2f31dee555e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c234fe338b5567ab95d5f87744d01c7c8aded52b --- /dev/null +++ b/raw/rel-18/29_series/29002/6994939b855d6bde94efb2f31dee555e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:374beae1d25eb018facb5def9e95f32e0dabfe948fbe449e349334151266ea69 +size 111448 diff --git a/raw/rel-18/29_series/29002/7ef58acaae097f1a37dac2a742e93445_img.jpg b/raw/rel-18/29_series/29002/7ef58acaae097f1a37dac2a742e93445_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7f4f83b3ecc615e2f198d682bcbcd9ea95a0ac7b --- /dev/null +++ b/raw/rel-18/29_series/29002/7ef58acaae097f1a37dac2a742e93445_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7eb17f5e449f792d5d2b192fef844cce65d8ec2951d7fa7c75570d4287acc3b2 +size 118080 diff --git a/raw/rel-18/29_series/29002/86de25c748dbfa7189a602dbda537b3b_img.jpg b/raw/rel-18/29_series/29002/86de25c748dbfa7189a602dbda537b3b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e5365b197023cabee1c36017ef9038d43d09aaec --- /dev/null +++ b/raw/rel-18/29_series/29002/86de25c748dbfa7189a602dbda537b3b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:408b5defa79c1d96cec86c6d86f55a9bfbd0910b1b5b7a4c9593e0cb3016c0a7 +size 51254 diff --git a/raw/rel-18/29_series/29002/89f8aefc01866631793087542316cef2_img.jpg b/raw/rel-18/29_series/29002/89f8aefc01866631793087542316cef2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eaf922d9916305f3fd3cf41a9b8515d65c297fdb --- /dev/null +++ b/raw/rel-18/29_series/29002/89f8aefc01866631793087542316cef2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:daa0ee1cfb565071e70c9008d2eca8cd03bc36a722cc08fec807e3b5ef1b0832 +size 20290 diff --git a/raw/rel-18/29_series/29002/8b7c6cbcb1fb65cd6c4cdd48a79c3ac4_img.jpg b/raw/rel-18/29_series/29002/8b7c6cbcb1fb65cd6c4cdd48a79c3ac4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..40b4c240c5bbf921622cb4f525e2c43dcd1be24c --- /dev/null +++ b/raw/rel-18/29_series/29002/8b7c6cbcb1fb65cd6c4cdd48a79c3ac4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e8d41bd3d4ca9eb8500baae067574d3572adc8763066b992d891ca360bfbccba +size 142222 diff --git a/raw/rel-18/29_series/29002/a014601c1ffe7fbee64d9b81187c4d86_img.jpg b/raw/rel-18/29_series/29002/a014601c1ffe7fbee64d9b81187c4d86_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..683cdf54b7a88d6ab1d427f7a517e6f7a498219e --- /dev/null +++ b/raw/rel-18/29_series/29002/a014601c1ffe7fbee64d9b81187c4d86_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d7d3d4329784dec93351da76b533782de2c8a2fdb5ba3455e3f6987f2b4bb87e +size 101520 diff --git a/raw/rel-18/29_series/29002/a4dfbebcb37369374ba8d65c7a9bd887_img.jpg b/raw/rel-18/29_series/29002/a4dfbebcb37369374ba8d65c7a9bd887_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..35d98cbfcd69707c0a918137c8d9559532d760bd --- /dev/null +++ b/raw/rel-18/29_series/29002/a4dfbebcb37369374ba8d65c7a9bd887_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:782d3136252c58aaf350e7db118aa9ef16a42e41fa103b1270ec76ccbdd6a5e6 +size 75072 diff --git a/raw/rel-18/29_series/29002/a97065d6f7f90c18eb5af01c0afaec5b_img.jpg b/raw/rel-18/29_series/29002/a97065d6f7f90c18eb5af01c0afaec5b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..705356f572bc7eaa898226e6b45407cb540a521a --- /dev/null +++ b/raw/rel-18/29_series/29002/a97065d6f7f90c18eb5af01c0afaec5b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:65c372b1edda04c1f60af95a34f8b451c802f9e35abfcda67bb612bd4e4e040d +size 120771 diff --git a/raw/rel-18/29_series/29002/b926b978b58fbca2dc80f670f4b52736_img.jpg b/raw/rel-18/29_series/29002/b926b978b58fbca2dc80f670f4b52736_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9d255e8c62ca23067e3e0847aef3457a27624c69 --- /dev/null +++ b/raw/rel-18/29_series/29002/b926b978b58fbca2dc80f670f4b52736_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4546a25132a032951b3a53d6ab4417427aa384bb68a386bd7d03cb786177b0a5 +size 166293 diff --git a/raw/rel-18/29_series/29002/bc70af19359c8df5ba8a1d98926b9477_img.jpg b/raw/rel-18/29_series/29002/bc70af19359c8df5ba8a1d98926b9477_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9beaaedf400212fa7a086212bd799cae9c033fcb --- /dev/null +++ b/raw/rel-18/29_series/29002/bc70af19359c8df5ba8a1d98926b9477_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c2e962cd5e178312d7eb3b9936a702acb26184f10fb0905f895b45c61d960286 +size 111834 diff --git a/raw/rel-18/29_series/29002/be5db98077bb821cfe2d717c02215f0b_img.jpg b/raw/rel-18/29_series/29002/be5db98077bb821cfe2d717c02215f0b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a42d2ffb0a77ae47cdc9962a27bb1a0e284202a7 --- /dev/null +++ b/raw/rel-18/29_series/29002/be5db98077bb821cfe2d717c02215f0b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:28df81801e82154211831873d5a1e619f369cf3f3510b233f090ed79d5058216 +size 174534 diff --git a/raw/rel-18/29_series/29002/ca9c21b01f6bef8651e2f6d0c4d2e882_img.jpg b/raw/rel-18/29_series/29002/ca9c21b01f6bef8651e2f6d0c4d2e882_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..18f5c8e49ab216d851736856b1296302eec0582a --- /dev/null +++ b/raw/rel-18/29_series/29002/ca9c21b01f6bef8651e2f6d0c4d2e882_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2ecb0c2f130119c08dc665925a08e0bf953f467af6f615924628bb15007bafe1 +size 88248 diff --git a/raw/rel-18/29_series/29002/cfea3ca54d33b18d2069ba64e3cedaa4_img.jpg b/raw/rel-18/29_series/29002/cfea3ca54d33b18d2069ba64e3cedaa4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eac5b9e095f152f4581f100be9b824e1febb2600 --- /dev/null +++ b/raw/rel-18/29_series/29002/cfea3ca54d33b18d2069ba64e3cedaa4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0fb06edc91d5392f93738541c42cc25dfc254318cbb49f11f0e1a86c72003ca1 +size 66226 diff --git a/raw/rel-18/29_series/29002/dc16cec51c6540030d965176f36e4810_img.jpg b/raw/rel-18/29_series/29002/dc16cec51c6540030d965176f36e4810_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4d14bdc286023d7292060999098d4136dbe3642b --- /dev/null +++ b/raw/rel-18/29_series/29002/dc16cec51c6540030d965176f36e4810_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20350e259a9a114216f6f51e8f35ba7d2518dd602d914eafe869f337b04b2614 +size 64933 diff --git a/raw/rel-18/29_series/29002/e343a5925678a3d9126523971922bd1c_img.jpg b/raw/rel-18/29_series/29002/e343a5925678a3d9126523971922bd1c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3ef68e9ffd68ffc512221edf04d98cdb4d7f6d58 --- /dev/null +++ b/raw/rel-18/29_series/29002/e343a5925678a3d9126523971922bd1c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:12020fa1d339604ac54764be5263e6fa9ffe0ebeaaf4e98ae76cfeb8e38f933c +size 102363 diff --git a/raw/rel-18/29_series/29002/f72079d5107eb4d888c7d6c24dfed66e_img.jpg b/raw/rel-18/29_series/29002/f72079d5107eb4d888c7d6c24dfed66e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9cd961ee1e8485e42d64056c9d04149f4cff2117 --- /dev/null +++ b/raw/rel-18/29_series/29002/f72079d5107eb4d888c7d6c24dfed66e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7a0faf92f1178e3b28db69e3178d0308417b712ff46026d282b56fa985c42905 +size 95879 diff --git a/raw/rel-18/29_series/29002/fb4503cfc4abdcdf439a898cde5bab68_img.jpg b/raw/rel-18/29_series/29002/fb4503cfc4abdcdf439a898cde5bab68_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..44b1508c353e7ad0c8a2ef28392fa4a66c449115 --- /dev/null +++ b/raw/rel-18/29_series/29002/fb4503cfc4abdcdf439a898cde5bab68_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ddd63bce505d11e9c18e7dd18b677d4e7e6c373f5589ee23d292f1146aac91fd +size 42665 diff --git a/raw/rel-18/29_series/29002/fdbf814083ff2d7d499496be85b828a1_img.jpg b/raw/rel-18/29_series/29002/fdbf814083ff2d7d499496be85b828a1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f0d0f5ced4c2c4738593b33f64263c7969f1b0ad --- /dev/null +++ b/raw/rel-18/29_series/29002/fdbf814083ff2d7d499496be85b828a1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b7e441040294c671e438e86d6bbe0a964a08794cee8137b369303ea4615df4b9 +size 99911 diff --git a/raw/rel-18/29_series/29061/00504fc688ebcf131ccbeff94dfc9939_img.jpg b/raw/rel-18/29_series/29061/00504fc688ebcf131ccbeff94dfc9939_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dca0fe0f3fbbb77a41cf7d0b7d486e5001da8802 --- /dev/null +++ b/raw/rel-18/29_series/29061/00504fc688ebcf131ccbeff94dfc9939_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:574a8ee31de3ffd354a119a28f5a47ddaeae66b9b2f73f32d0072aa1d0c7b514 +size 168454 diff --git a/raw/rel-18/29_series/29061/03d9aaba6c1af8bfd8e42c1d2422ae5c_img.jpg b/raw/rel-18/29_series/29061/03d9aaba6c1af8bfd8e42c1d2422ae5c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..380431e7241addac46bb4f8cf5e296ceba07cef6 --- /dev/null +++ b/raw/rel-18/29_series/29061/03d9aaba6c1af8bfd8e42c1d2422ae5c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b3f13a5d10eab10b5cfd25044a3641e99d28d7e7f173ec6f8a5ad4fd47db36f7 +size 26108 diff --git a/raw/rel-18/29_series/29061/0931f3e098bd4539041de11c50cec2d2_img.jpg b/raw/rel-18/29_series/29061/0931f3e098bd4539041de11c50cec2d2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3d9ed44a82b7c7d39f91e3df82f44dba2c2a5e41 --- /dev/null +++ b/raw/rel-18/29_series/29061/0931f3e098bd4539041de11c50cec2d2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4650eda7b0e58c6d59c00a5b956ad40d4f4afe57805f1039d3dbad4c96c34c51 +size 43296 diff --git a/raw/rel-18/29_series/29061/0b3d9fe35da3ee0c88f1420bb9ed7a03_img.jpg b/raw/rel-18/29_series/29061/0b3d9fe35da3ee0c88f1420bb9ed7a03_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c75b89a91ae129cc2cd2f6e99f2682bc83a25dc3 --- /dev/null +++ b/raw/rel-18/29_series/29061/0b3d9fe35da3ee0c88f1420bb9ed7a03_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:77e053c1037ef55dbf007d94039db0d22c8f81e2e46c3c6e6a6212a094de4262 +size 36545 diff --git a/raw/rel-18/29_series/29061/0b452c5334567cbdc22ee9817e1246f5_img.jpg b/raw/rel-18/29_series/29061/0b452c5334567cbdc22ee9817e1246f5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4270ddd353680b6e6d7bc7a8953dcf6cb5eb4005 --- /dev/null +++ b/raw/rel-18/29_series/29061/0b452c5334567cbdc22ee9817e1246f5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:48ec3029cc12a9c96981ef621125ad0a681f2c516184f2757d786733076fdc00 +size 45819 diff --git a/raw/rel-18/29_series/29061/0db3cccd1279034258e5ad5b6fdcff01_img.jpg b/raw/rel-18/29_series/29061/0db3cccd1279034258e5ad5b6fdcff01_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0183bf31cc7aec2f20eebd77a578d2c2a414e24e --- /dev/null +++ b/raw/rel-18/29_series/29061/0db3cccd1279034258e5ad5b6fdcff01_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b0e29e051bc0650e0f95f3c01de0ff789aa1bea5815f125d93f433fc12c5eb6 +size 78501 diff --git a/raw/rel-18/29_series/29061/0eb348bf17d67bf96326e07011d1c1ad_img.jpg b/raw/rel-18/29_series/29061/0eb348bf17d67bf96326e07011d1c1ad_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0fb1b00b1485f707575e71eb75a4f7f3356e986e --- /dev/null +++ b/raw/rel-18/29_series/29061/0eb348bf17d67bf96326e07011d1c1ad_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e3713c4ac8d578730a0769c460d1411048ed2d019b00c23cf3dab7cd2a71bf81 +size 14724 diff --git a/raw/rel-18/29_series/29061/124c6108c63173818afb8ed49521e22d_img.jpg b/raw/rel-18/29_series/29061/124c6108c63173818afb8ed49521e22d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..45167c797ea0243287d885787c36c19496a330ed --- /dev/null +++ b/raw/rel-18/29_series/29061/124c6108c63173818afb8ed49521e22d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe4d7f1dca8f9cef9a222aa4aa9b79ef535b0cbb18943ca8b944fe0b18322c68 +size 51316 diff --git a/raw/rel-18/29_series/29061/13fde41de77bf026013a0b81684d1fc9_img.jpg b/raw/rel-18/29_series/29061/13fde41de77bf026013a0b81684d1fc9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2ad3adb863ae3870788d485d7fb8c6f53cc1d58c --- /dev/null +++ b/raw/rel-18/29_series/29061/13fde41de77bf026013a0b81684d1fc9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e0124f66a476713abd45d9aa00a667076b1edaa9c0c1fbf8fb5660e7a3443d6 +size 88489 diff --git a/raw/rel-18/29_series/29061/187d05bf7ead21e1394b61320d8b3632_img.jpg b/raw/rel-18/29_series/29061/187d05bf7ead21e1394b61320d8b3632_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f4bc2bce3d2ccecd1b15e431a122fef017708f25 --- /dev/null +++ b/raw/rel-18/29_series/29061/187d05bf7ead21e1394b61320d8b3632_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:afcf6f768410b316ac5b709c2b20ca14069ada5e349dce76d2caa9f4a0390447 +size 46548 diff --git a/raw/rel-18/29_series/29061/18b87e4ce7ef441f5620b8d6539a2939_img.jpg b/raw/rel-18/29_series/29061/18b87e4ce7ef441f5620b8d6539a2939_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2c299719d0978183ccb9b6ac3e5fcbca6a4225e8 --- /dev/null +++ b/raw/rel-18/29_series/29061/18b87e4ce7ef441f5620b8d6539a2939_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee79ecc0c4515e14a9500c025cc7f529168ccd7dd65162341ef6147b0aefec75 +size 73870 diff --git a/raw/rel-18/29_series/29061/1f1614411edea7edfc86c839a608e1fc_img.jpg b/raw/rel-18/29_series/29061/1f1614411edea7edfc86c839a608e1fc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b7dc689484a27d8a64d00380f29898a989342421 --- /dev/null +++ b/raw/rel-18/29_series/29061/1f1614411edea7edfc86c839a608e1fc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d5c3151ce1ea179416257fd4783a8ab78c34fa182b1ba9508141a930a2df33a4 +size 23729 diff --git a/raw/rel-18/29_series/29061/26d664119ad25250780f554633444e54_img.jpg b/raw/rel-18/29_series/29061/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fa769437b1950fac68efc09749727a7f56259e49 --- /dev/null +++ b/raw/rel-18/29_series/29061/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dcd614623ad2c449e87c5ca93e32a0610f415c26b3bdd18f03136408fe0ba031 +size 156877 diff --git a/raw/rel-18/29_series/29061/2837ffdadcdb1e5bababa56b564e56ed_img.jpg b/raw/rel-18/29_series/29061/2837ffdadcdb1e5bababa56b564e56ed_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..93f53deb2dc4f593c1e4f8752251c4571ca1f704 --- /dev/null +++ b/raw/rel-18/29_series/29061/2837ffdadcdb1e5bababa56b564e56ed_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:011bcf74ea5911deffc9d37678af076aaa35e09c7f53aa1371a52b1a2b8afa25 +size 67199 diff --git a/raw/rel-18/29_series/29061/29997432244f81212ee1e6c94f308f1b_img.jpg b/raw/rel-18/29_series/29061/29997432244f81212ee1e6c94f308f1b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f1d5a197def9180aec6a7d10a7abecdd430bdc3c --- /dev/null +++ b/raw/rel-18/29_series/29061/29997432244f81212ee1e6c94f308f1b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:142a0a943f993a1818149dc17b9a4a38b1775993b520c20cdbcb05e42bdf85b5 +size 98936 diff --git a/raw/rel-18/29_series/29061/2a476a0b3dbc3429436246db4784ff9f_img.jpg b/raw/rel-18/29_series/29061/2a476a0b3dbc3429436246db4784ff9f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8a8994830770975340e55f522b44979c3e8002f1 --- /dev/null +++ b/raw/rel-18/29_series/29061/2a476a0b3dbc3429436246db4784ff9f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:25d4d79ff830bb41521f0ce5e31749b8ddd79f2060a6a8c578c1d4c8f4941f1a +size 68785 diff --git a/raw/rel-18/29_series/29061/2eb23c2210154279f8013a1594fbcc5a_img.jpg b/raw/rel-18/29_series/29061/2eb23c2210154279f8013a1594fbcc5a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..68b5d82e6ca0c92022abbefc850ccfc9fa90500b --- /dev/null +++ b/raw/rel-18/29_series/29061/2eb23c2210154279f8013a1594fbcc5a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:725db1f745a17b24237bebad211481abb526cbb651d80c58bea68affd92bce09 +size 36662 diff --git a/raw/rel-18/29_series/29061/2f108a589e99e93fd7aa8fac626398c7_img.jpg b/raw/rel-18/29_series/29061/2f108a589e99e93fd7aa8fac626398c7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a5b9a7bdf0990c96f92272c661d196827d58a217 --- /dev/null +++ b/raw/rel-18/29_series/29061/2f108a589e99e93fd7aa8fac626398c7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4de1ebe5d8e1adcbf70096e3c5a620fbf4aea13faa1a76cd924b33155d91bc31 +size 75818 diff --git a/raw/rel-18/29_series/29061/329c96049bb432e9c2cbda4e224a0c9c_img.jpg b/raw/rel-18/29_series/29061/329c96049bb432e9c2cbda4e224a0c9c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4e2737810274151812a24888d48ae61084b50cb4 --- /dev/null +++ b/raw/rel-18/29_series/29061/329c96049bb432e9c2cbda4e224a0c9c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:43d0abd66baa6ca52fc1f0ad8c6818e537cfa8dff56368fce07974e690971211 +size 39629 diff --git a/raw/rel-18/29_series/29061/32ff77da4286b58c4778033acaa10836_img.jpg b/raw/rel-18/29_series/29061/32ff77da4286b58c4778033acaa10836_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d2c6bac9d7bd35552b6f0fb7f69288e9d1354050 --- /dev/null +++ b/raw/rel-18/29_series/29061/32ff77da4286b58c4778033acaa10836_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f92d579d074dc703c18bfea92f5575c89c656df6e510d6e3a5472a1f00efaf4 +size 114619 diff --git a/raw/rel-18/29_series/29061/3337af75dfee8af7687b4f49914d6c93_img.jpg b/raw/rel-18/29_series/29061/3337af75dfee8af7687b4f49914d6c93_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7aaef70f70518c2c4c6dd9b547cce6733df7ab59 --- /dev/null +++ b/raw/rel-18/29_series/29061/3337af75dfee8af7687b4f49914d6c93_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e0632460df86df7b3f4eb803977bae284a30939de9bd6630537d6bfd10fabb4e +size 22487 diff --git a/raw/rel-18/29_series/29061/347010b7ac06d3ae97927fde0f784d7c_img.jpg b/raw/rel-18/29_series/29061/347010b7ac06d3ae97927fde0f784d7c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1e3e207d2a5478d9f05c364fdfcfae818a030e02 --- /dev/null +++ b/raw/rel-18/29_series/29061/347010b7ac06d3ae97927fde0f784d7c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c5b7b727daf2e1479115ad1799ac36d5867c8102599986e9864cfb136774fed5 +size 39358 diff --git a/raw/rel-18/29_series/29061/367378559e35017a5e1a6f5c30798c5a_img.jpg b/raw/rel-18/29_series/29061/367378559e35017a5e1a6f5c30798c5a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e07bdb3a103af3ec317c5ed9295d97651e1cb7bb --- /dev/null +++ b/raw/rel-18/29_series/29061/367378559e35017a5e1a6f5c30798c5a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7538cce594042a13569d7fa569bf83d37041b419b5e4d23b7f185dd2d3b6e47d +size 42083 diff --git a/raw/rel-18/29_series/29061/3adb4bad764bde2c7c001c4e7fed57ad_img.jpg b/raw/rel-18/29_series/29061/3adb4bad764bde2c7c001c4e7fed57ad_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ab074ed800ed340e97dbfbf6291b5a92e7ae4215 --- /dev/null +++ b/raw/rel-18/29_series/29061/3adb4bad764bde2c7c001c4e7fed57ad_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:37ee94d7bb433dac05d78cdf8b9ff9aeab87657a45622b8ba372b264cd2461b1 +size 17933 diff --git a/raw/rel-18/29_series/29061/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg b/raw/rel-18/29_series/29061/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9bd74238babf2cbc8a9004d44ef6f6ebe2a6c5ea --- /dev/null +++ b/raw/rel-18/29_series/29061/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:59e3842e8741042be3abdc2028287ddb23c4ae344b28357c97f934b3eafffb50 +size 33387 diff --git a/raw/rel-18/29_series/29061/43837b056625d3d6ce615e4c02f163bb_img.jpg b/raw/rel-18/29_series/29061/43837b056625d3d6ce615e4c02f163bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..81e3c7886516aa79a88052d58cf87210c5c0b9e0 --- /dev/null +++ b/raw/rel-18/29_series/29061/43837b056625d3d6ce615e4c02f163bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e73b7a6617914780868b2e96815ebb9ebc0b9eeb24cfba294e59dff8bd84afc5 +size 38243 diff --git a/raw/rel-18/29_series/29061/458fdbcb4015a4ee90bd84809afc4aac_img.jpg b/raw/rel-18/29_series/29061/458fdbcb4015a4ee90bd84809afc4aac_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..37dd6d4b438632dae00c9d1909c7418600729d68 --- /dev/null +++ b/raw/rel-18/29_series/29061/458fdbcb4015a4ee90bd84809afc4aac_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb0a761e5f40bd98ef9dc10187d8adefe9b465f8ff7b95c921f0d7ebf83a4a28 +size 50632 diff --git a/raw/rel-18/29_series/29061/4b398c5e8c4fd656d5b7a61806400650_img.jpg b/raw/rel-18/29_series/29061/4b398c5e8c4fd656d5b7a61806400650_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e86ffaca966d672dc404be807d24d8255c40f26d --- /dev/null +++ b/raw/rel-18/29_series/29061/4b398c5e8c4fd656d5b7a61806400650_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe214721538f09a6948f468e8f6c29565a70a3d6100b8473870e8c7e4444a4b8 +size 44560 diff --git a/raw/rel-18/29_series/29061/5c65cabec7c5062117fb0d578916cf8b_img.jpg b/raw/rel-18/29_series/29061/5c65cabec7c5062117fb0d578916cf8b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..36f30225bfec75ef5ef1d06f6659b0703e42d615 --- /dev/null +++ b/raw/rel-18/29_series/29061/5c65cabec7c5062117fb0d578916cf8b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0c33c3ab7b15ca5aa668bdadce511051301280f9b87ac48bfde9ad07332caf2b +size 34460 diff --git a/raw/rel-18/29_series/29061/5efe6377e22b9ab76a19a70da29976b9_img.jpg b/raw/rel-18/29_series/29061/5efe6377e22b9ab76a19a70da29976b9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..559b8e6fb729ce88d3721e6e5d5b5fc8815e2c76 --- /dev/null +++ b/raw/rel-18/29_series/29061/5efe6377e22b9ab76a19a70da29976b9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d4cae777d574d172f3fea32dff4af6700130f3b99d000415c592ce498395f905 +size 105460 diff --git a/raw/rel-18/29_series/29061/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29061/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5d96f3f60573f738f13ac4b8e2d0970412a5d651 --- /dev/null +++ b/raw/rel-18/29_series/29061/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:15bd801abca0e74f4311f792927a13e05d1eb264e32aa289242e33c2b3a9306a +size 9410 diff --git a/raw/rel-18/29_series/29061/5fbb4f0de01736f1293333e599410c99_img.jpg b/raw/rel-18/29_series/29061/5fbb4f0de01736f1293333e599410c99_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2e28cbc869ead4005ec35fe444b012726bec97be --- /dev/null +++ b/raw/rel-18/29_series/29061/5fbb4f0de01736f1293333e599410c99_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b0b37e392665e80b1461f70f123b3e4977b6baa7ca2e362547b0cb0428e27503 +size 37834 diff --git a/raw/rel-18/29_series/29061/6031b46d356ee24f96bfe37ee2cb7616_img.jpg b/raw/rel-18/29_series/29061/6031b46d356ee24f96bfe37ee2cb7616_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d22e8937c1545ecd11e1de54013d614b36573c90 --- /dev/null +++ b/raw/rel-18/29_series/29061/6031b46d356ee24f96bfe37ee2cb7616_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:46f0aa0c339ca2bb64eb8c7104311d1dcb9cdb4e492663682d8811eaf15ccb15 +size 97571 diff --git a/raw/rel-18/29_series/29061/629606c93e8d5f98d72a90044ef4b15a_img.jpg b/raw/rel-18/29_series/29061/629606c93e8d5f98d72a90044ef4b15a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..829065d7f1b62f37c22b83532b0dd6f069169d37 --- /dev/null +++ b/raw/rel-18/29_series/29061/629606c93e8d5f98d72a90044ef4b15a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7ecf2395a0d2da88d1f72c0cfedc9b3f400e6bfb4a483df0edfb53c7beda42cb +size 30291 diff --git a/raw/rel-18/29_series/29061/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29061/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a03472f2c5a154de63161ff395418e0d63b8d152 --- /dev/null +++ b/raw/rel-18/29_series/29061/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2589a3ca1f7491db920b0f2aa3940ec61d9d7f17dfdff6aea51e469674537180 +size 6739 diff --git a/raw/rel-18/29_series/29061/6be06b7dc72bb42afcb3465394667c3b_img.jpg b/raw/rel-18/29_series/29061/6be06b7dc72bb42afcb3465394667c3b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d72c1aee1bd455abcd3ae71354a19121de4bcb6b --- /dev/null +++ b/raw/rel-18/29_series/29061/6be06b7dc72bb42afcb3465394667c3b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d537ee3ab95fbe4558844d12a0e6ff26f55e52aa5a79395ea95dcfe58abdab76 +size 47778 diff --git a/raw/rel-18/29_series/29061/6e15fc9ea763541c5913d26f85072ae1_img.jpg b/raw/rel-18/29_series/29061/6e15fc9ea763541c5913d26f85072ae1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4b5fb02226be2b5e9d2067ae63829a6f70423e9f --- /dev/null +++ b/raw/rel-18/29_series/29061/6e15fc9ea763541c5913d26f85072ae1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cbe1f76facc6f2e1665ad263bcc078d68479bc04cef0115ea5d468ef7f0ccde1 +size 44034 diff --git a/raw/rel-18/29_series/29061/71b0a68b4dd64961465d2b0e790538de_img.jpg b/raw/rel-18/29_series/29061/71b0a68b4dd64961465d2b0e790538de_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a9f13b404d7bddc74d818b8b02c04955c7cf9c5a --- /dev/null +++ b/raw/rel-18/29_series/29061/71b0a68b4dd64961465d2b0e790538de_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6d7d64cac71022a7556c71271653a930c22c50a7f4784244408a98c4ae10f31e +size 39037 diff --git a/raw/rel-18/29_series/29061/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg b/raw/rel-18/29_series/29061/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4854a26bbe7a2ff424fe72b1c94bdd7ed38915f7 --- /dev/null +++ b/raw/rel-18/29_series/29061/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d06478c290a1e67d2c8542264fd0da681b12d938b081ddef114763244298b72 +size 60104 diff --git a/raw/rel-18/29_series/29061/7f950d8071cc74c5c726756baed72584_img.jpg b/raw/rel-18/29_series/29061/7f950d8071cc74c5c726756baed72584_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c4f9897bb8c1c1eb9dcd7a5ba99037c1c2527a9 --- /dev/null +++ b/raw/rel-18/29_series/29061/7f950d8071cc74c5c726756baed72584_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5cb7b94062c93ff148e88b62419333a1092da863b3bc13a631ab1ce40320af1d +size 15123 diff --git a/raw/rel-18/29_series/29061/7fe5741e83bc9702d1b1d7585ddf66bd_img.jpg b/raw/rel-18/29_series/29061/7fe5741e83bc9702d1b1d7585ddf66bd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..da7ffe0a2757add0c029f3ddfd72d79eea9f2abf --- /dev/null +++ b/raw/rel-18/29_series/29061/7fe5741e83bc9702d1b1d7585ddf66bd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:864603bd79114943a0b6f01411e6d6a8df1cde06849e067db6087a9608c1fae4 +size 43893 diff --git a/raw/rel-18/29_series/29061/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg b/raw/rel-18/29_series/29061/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..19def06fe43a16a1d730353cc7d4cc86581ea28d --- /dev/null +++ b/raw/rel-18/29_series/29061/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:480303d4eb0b8136f0984e6ce2ac55807da0595beb7daba8612330367e3dde89 +size 47300 diff --git a/raw/rel-18/29_series/29061/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg b/raw/rel-18/29_series/29061/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cafbff2d2e9d55af1ac58d9db7344a13729772a9 --- /dev/null +++ b/raw/rel-18/29_series/29061/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8e05f628604f22edbb5b99d6e787d6fe09ba265af8f0ec43b578e7bf4007337a +size 50857 diff --git a/raw/rel-18/29_series/29061/8fce89f02626b8a0c50e2245bc3e7ce7_img.jpg b/raw/rel-18/29_series/29061/8fce89f02626b8a0c50e2245bc3e7ce7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0dec767f221f5fa232d642a284e163cd0f29bc0a --- /dev/null +++ b/raw/rel-18/29_series/29061/8fce89f02626b8a0c50e2245bc3e7ce7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb92555ac5a3cdc8c4dd46ee20a59b619a382aeb7ab053619e9af074b3c7e3a2 +size 41194 diff --git a/raw/rel-18/29_series/29061/90ddf538ef276510e2b631f7b96654e6_img.jpg b/raw/rel-18/29_series/29061/90ddf538ef276510e2b631f7b96654e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..923334fdafb712efae04ef641d3b6d4cf6da99e8 --- /dev/null +++ b/raw/rel-18/29_series/29061/90ddf538ef276510e2b631f7b96654e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8bace6cebd3782f2739002442a08be6dc32023b69527102ee896cf0b7e3765dd +size 30317 diff --git a/raw/rel-18/29_series/29061/91b12db3c85bbf466ad27eb3665a1b06_img.jpg b/raw/rel-18/29_series/29061/91b12db3c85bbf466ad27eb3665a1b06_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b05f8734438ca2f7205dba566cd35117626bb2a6 --- /dev/null +++ b/raw/rel-18/29_series/29061/91b12db3c85bbf466ad27eb3665a1b06_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cf2dba262a4fada373900ca3f9169b8b5f05105255adedad96bd7217f591f279 +size 15055 diff --git a/raw/rel-18/29_series/29061/93699fb71e95b4df5a3871fdcf818982_img.jpg b/raw/rel-18/29_series/29061/93699fb71e95b4df5a3871fdcf818982_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..425b47d71b16f0e892a9a0af2af2e28440a118be --- /dev/null +++ b/raw/rel-18/29_series/29061/93699fb71e95b4df5a3871fdcf818982_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:daa7501f57e49002d9355954f04942bcdb1b3032357091d49b97698984cdc73c +size 93692 diff --git a/raw/rel-18/29_series/29061/93bd00a00fa28558486f0664550699b1_img.jpg b/raw/rel-18/29_series/29061/93bd00a00fa28558486f0664550699b1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2a438c546c77b09f7125e5aa649266e07af0044d --- /dev/null +++ b/raw/rel-18/29_series/29061/93bd00a00fa28558486f0664550699b1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:34481ba94f53bf39d53173c3c504c4df62a0b9424fd85e58ed6fae58285ec644 +size 14990 diff --git a/raw/rel-18/29_series/29061/9b39a1d27e49bccd8767e8d5fc0be7fd_img.jpg b/raw/rel-18/29_series/29061/9b39a1d27e49bccd8767e8d5fc0be7fd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7f1188fe55f6fdf45d7da49454ee97537df49cd4 --- /dev/null +++ b/raw/rel-18/29_series/29061/9b39a1d27e49bccd8767e8d5fc0be7fd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9b917dcd1a60605277fe48f144f2f69ca27020b6cd15e9aedd1a4a5ce4ed04c1 +size 69504 diff --git a/raw/rel-18/29_series/29061/9b62a616c7a1097c5da57f001ab6dd64_img.jpg b/raw/rel-18/29_series/29061/9b62a616c7a1097c5da57f001ab6dd64_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c1fa468eaaab45df14e8f3e4dfb7ac7cc9cacf48 --- /dev/null +++ b/raw/rel-18/29_series/29061/9b62a616c7a1097c5da57f001ab6dd64_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5e2936ec9059c90086f87e5a39fd0c127dbf31b63b3968add748125d15c802df +size 30075 diff --git a/raw/rel-18/29_series/29061/9b9262a549828579ab904148450734f6_img.jpg b/raw/rel-18/29_series/29061/9b9262a549828579ab904148450734f6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..363e1eb91bca97a8a56b8eb6beb8023ac31bbedf --- /dev/null +++ b/raw/rel-18/29_series/29061/9b9262a549828579ab904148450734f6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b36f3a2544c3c0b24401f51d85964c6cabf840532f1ed6b685179023b94eb5da +size 119236 diff --git a/raw/rel-18/29_series/29061/9e4f582a5d5f6742d1372956db0f8f0b_img.jpg b/raw/rel-18/29_series/29061/9e4f582a5d5f6742d1372956db0f8f0b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1a77ad9278b0f5d53d8066185deca1ee5510443c --- /dev/null +++ b/raw/rel-18/29_series/29061/9e4f582a5d5f6742d1372956db0f8f0b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1656b738729fb82920f8a3314991b4998210fdd898f8d22a1f49bd7df367bce6 +size 42080 diff --git a/raw/rel-18/29_series/29061/a057800564be3506d2d87b6a4daee25b_img.jpg b/raw/rel-18/29_series/29061/a057800564be3506d2d87b6a4daee25b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0b7f85815af42403651f3c9dcaf38d595876dd8f --- /dev/null +++ b/raw/rel-18/29_series/29061/a057800564be3506d2d87b6a4daee25b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3944d1109593144c321b5683f0976b1244718b83d1c8ff5fc99e9a2c1fa9271a +size 25079 diff --git a/raw/rel-18/29_series/29061/b4f6d3668f7e851eaff07ccf26001623_img.jpg b/raw/rel-18/29_series/29061/b4f6d3668f7e851eaff07ccf26001623_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..586a0d2ba5e07b3056b9a7bd8ae732efc70744ba --- /dev/null +++ b/raw/rel-18/29_series/29061/b4f6d3668f7e851eaff07ccf26001623_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bd40d7adaafb46aa44fb2fc7023e6743a857f323d958b2633f134d6406526a1d +size 46194 diff --git a/raw/rel-18/29_series/29061/bdbdf9152f5224e9ced4fc6f402fbe45_img.jpg b/raw/rel-18/29_series/29061/bdbdf9152f5224e9ced4fc6f402fbe45_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..599f91388c801f235b64775cfc0f197e71e14c77 --- /dev/null +++ b/raw/rel-18/29_series/29061/bdbdf9152f5224e9ced4fc6f402fbe45_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8f6ee70a9a45f57d984fe369c49a01160ab02da1e875a47d9559c74ed042c8ba +size 16604 diff --git a/raw/rel-18/29_series/29061/c0438093a10a593c42106b1e5dbb4331_img.jpg b/raw/rel-18/29_series/29061/c0438093a10a593c42106b1e5dbb4331_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3a5612f72a05a6d091b8f914124eb8f57cf6289f --- /dev/null +++ b/raw/rel-18/29_series/29061/c0438093a10a593c42106b1e5dbb4331_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1d17814f4a2e7891ec8af54b8a5f6374893c57cdc9c5083d8f6658058a904d99 +size 17443 diff --git a/raw/rel-18/29_series/29061/c15cb6383bc35906e6b3c7c3aac621ed_img.jpg b/raw/rel-18/29_series/29061/c15cb6383bc35906e6b3c7c3aac621ed_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fa2266c0f0381320a37f01e6babd5383705578b8 --- /dev/null +++ b/raw/rel-18/29_series/29061/c15cb6383bc35906e6b3c7c3aac621ed_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0ee141f432947f6eeda88885e0872187991e8585281c3ecbde52b4494aefb000 +size 73581 diff --git a/raw/rel-18/29_series/29061/c71fd22661fbd344a66043940bbd84fc_img.jpg b/raw/rel-18/29_series/29061/c71fd22661fbd344a66043940bbd84fc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1c806a813a7db09b272f6deeb5e5e9eaa0fd8b7c --- /dev/null +++ b/raw/rel-18/29_series/29061/c71fd22661fbd344a66043940bbd84fc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa883083a7164a62605fee2dbb2bd87253d38801f8fc684cd122afb087b1db38 +size 12233 diff --git a/raw/rel-18/29_series/29061/c879d6feb77f5e629e8feb3b42d5a139_img.jpg b/raw/rel-18/29_series/29061/c879d6feb77f5e629e8feb3b42d5a139_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6f234a879bfe0b2c4f834c17e3adae309c1ee5f4 --- /dev/null +++ b/raw/rel-18/29_series/29061/c879d6feb77f5e629e8feb3b42d5a139_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dfaeda2ca3ebd036cbea760814ca59fc9db8b6690c867b30d3c7714ac63e5656 +size 18223 diff --git a/raw/rel-18/29_series/29061/ca9fd3bd2fe73a46244dd1d017ffa3b5_img.jpg b/raw/rel-18/29_series/29061/ca9fd3bd2fe73a46244dd1d017ffa3b5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..05bed61c9d22d3baf969c6618c40317b8155e68f --- /dev/null +++ b/raw/rel-18/29_series/29061/ca9fd3bd2fe73a46244dd1d017ffa3b5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7e4ad89df6e277b83334f5927ccae74d782870b34960c0597ab75d3a3f4b69f1 +size 16504 diff --git a/raw/rel-18/29_series/29061/cc542843836eecb036b99cb270b54a1e_img.jpg b/raw/rel-18/29_series/29061/cc542843836eecb036b99cb270b54a1e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..760453b3c8ef4fcaf11dc003be04b5c9c6f9e070 --- /dev/null +++ b/raw/rel-18/29_series/29061/cc542843836eecb036b99cb270b54a1e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20a3bce690adb5dc37c638c12bb3c9ec58dbf7695134dc206c081311fc4c5de8 +size 28529 diff --git a/raw/rel-18/29_series/29061/cc6f9dbfc36aa5821d9749ca84861f93_img.jpg b/raw/rel-18/29_series/29061/cc6f9dbfc36aa5821d9749ca84861f93_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a3c580fa0e0ebc201faf6f096a02521a38f0d31a --- /dev/null +++ b/raw/rel-18/29_series/29061/cc6f9dbfc36aa5821d9749ca84861f93_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6cac85c47fb8ef852f9f1ec4ac8e6a2e3b22686ffdd84dabe51714083d530cdf +size 75458 diff --git a/raw/rel-18/29_series/29061/ccdeaf31dbe65613f2f87a7b2b06e391_img.jpg b/raw/rel-18/29_series/29061/ccdeaf31dbe65613f2f87a7b2b06e391_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b8d4a27bba6304a6c69486f6afa86d9c0cc686da --- /dev/null +++ b/raw/rel-18/29_series/29061/ccdeaf31dbe65613f2f87a7b2b06e391_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3a66581af275ee14b54b9c3ce7f122b4daeff20dc67a955d2bfcbd7600a2ed5d +size 41442 diff --git a/raw/rel-18/29_series/29061/cdcbafff3cef7d54a001e3d0a4d9841e_img.jpg b/raw/rel-18/29_series/29061/cdcbafff3cef7d54a001e3d0a4d9841e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b3f1a3382345a65191a07e8491fa3fd2c23cfb6 --- /dev/null +++ b/raw/rel-18/29_series/29061/cdcbafff3cef7d54a001e3d0a4d9841e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2a600170d326bb665bd1f1062c637be0284e567feae6cdee340dd96d2fb72a89 +size 59687 diff --git a/raw/rel-18/29_series/29061/d22fb161d760fcf9fe3fb7b36f81c6fb_img.jpg b/raw/rel-18/29_series/29061/d22fb161d760fcf9fe3fb7b36f81c6fb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b87bd603b54c4624205bfa263be0d30f1d4e921d --- /dev/null +++ b/raw/rel-18/29_series/29061/d22fb161d760fcf9fe3fb7b36f81c6fb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b1ea940a990dd32a134f7d6e3503c03f941b081d04d140545c6fad1cbe236d11 +size 30400 diff --git a/raw/rel-18/29_series/29061/d4a9a1e5b2d8b51e6bf1abacd2421c83_img.jpg b/raw/rel-18/29_series/29061/d4a9a1e5b2d8b51e6bf1abacd2421c83_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9820369140af93d573f6f261d5ff854bec3d920f --- /dev/null +++ b/raw/rel-18/29_series/29061/d4a9a1e5b2d8b51e6bf1abacd2421c83_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7bb300a4ecb253d31b86cb492284b0f481034b4d1f89aae7497c5f253f57c262 +size 44762 diff --git a/raw/rel-18/29_series/29061/da85343976fdbb19f866d9ddbdad0eae_img.jpg b/raw/rel-18/29_series/29061/da85343976fdbb19f866d9ddbdad0eae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ca5b8e58c0d5c3e1d4249da42041daf0c2d98987 --- /dev/null +++ b/raw/rel-18/29_series/29061/da85343976fdbb19f866d9ddbdad0eae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:38bc5b78f872090cdddd999cb2b61b6175257eb141fa46de999c663ef2d83beb +size 43441 diff --git a/raw/rel-18/29_series/29061/db184eff73ec14dc2dde56126813517f_img.jpg b/raw/rel-18/29_series/29061/db184eff73ec14dc2dde56126813517f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4bfb45ede62d42a50ebfe2b2eaad3821f5dd3ec7 --- /dev/null +++ b/raw/rel-18/29_series/29061/db184eff73ec14dc2dde56126813517f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9e2ed2d016007834343f7c9325cc80f92eac7b7df7e078c78eceaa0ea0871b89 +size 14978 diff --git a/raw/rel-18/29_series/29061/e01c6273c4177746475715ee9c17a882_img.jpg b/raw/rel-18/29_series/29061/e01c6273c4177746475715ee9c17a882_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..db10db513623869b331d11971d3780c0b2e23fd0 --- /dev/null +++ b/raw/rel-18/29_series/29061/e01c6273c4177746475715ee9c17a882_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aed1fe6f2d6a5597b61a72e6645855402581715914b29e8d22a1c56799694c46 +size 13735 diff --git a/raw/rel-18/29_series/29061/e0774c1e190583a6c13ea92ada80aa9e_img.jpg b/raw/rel-18/29_series/29061/e0774c1e190583a6c13ea92ada80aa9e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ea5378eca4bf1b00a66dfb070b4269a25424f5d6 --- /dev/null +++ b/raw/rel-18/29_series/29061/e0774c1e190583a6c13ea92ada80aa9e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e202d1b4f9c101cce59a35deeef34fe439125dfdc7fa06b38bb7f44b69c80d6c +size 15265 diff --git a/raw/rel-18/29_series/29061/e4aab374983ba0fc24496fe7cd11c06c_img.jpg b/raw/rel-18/29_series/29061/e4aab374983ba0fc24496fe7cd11c06c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..98b7a9dd9935d867deec15fd066327650b1edf59 --- /dev/null +++ b/raw/rel-18/29_series/29061/e4aab374983ba0fc24496fe7cd11c06c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b7ea326f7d56361f6efb76fc1630816ec44b885f7efa7868d0b9345d7d06f208 +size 16343 diff --git a/raw/rel-18/29_series/29061/eabcb2f8b9acedb194571d5bc734b463_img.jpg b/raw/rel-18/29_series/29061/eabcb2f8b9acedb194571d5bc734b463_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5d84764083efd1ec0c747c98d479d3a45b284a06 --- /dev/null +++ b/raw/rel-18/29_series/29061/eabcb2f8b9acedb194571d5bc734b463_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2b619d6787b86ed7ff74ed5663b2c534bf354a618054265909e80a7e3ef77999 +size 119355 diff --git a/raw/rel-18/29_series/29061/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/raw/rel-18/29_series/29061/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..15501368b227db67a7d17e42df5aac0e0d78c7b9 --- /dev/null +++ b/raw/rel-18/29_series/29061/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9619d6148d09e197781a6bdb8f85b24dd6c4db6bd0f94dcf51aee7c811954fde +size 50073 diff --git a/raw/rel-18/29_series/29061/eea0bd1826a6e1bdcadff03936a7b20a_img.jpg b/raw/rel-18/29_series/29061/eea0bd1826a6e1bdcadff03936a7b20a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e48ec4396ea951a145959656e8beff909f5ae7f0 --- /dev/null +++ b/raw/rel-18/29_series/29061/eea0bd1826a6e1bdcadff03936a7b20a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:394928ee1da97461d1c7f135fde0ac0aee233512856dd5c4bc556563386257d6 +size 16374 diff --git a/raw/rel-18/29_series/29061/ef45b00396c293be0b18d32b97118bf4_img.jpg b/raw/rel-18/29_series/29061/ef45b00396c293be0b18d32b97118bf4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..88a024fc416b8614081f8ce633cad5e25b6c597b --- /dev/null +++ b/raw/rel-18/29_series/29061/ef45b00396c293be0b18d32b97118bf4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c801382b63f4ce399c408a9dc7b8aa0479b1ee28c3d1cda329bc4e3a28024efe +size 38765 diff --git a/raw/rel-18/29_series/29061/f0e3f79f8b55cbaba4a467e762854eae_img.jpg b/raw/rel-18/29_series/29061/f0e3f79f8b55cbaba4a467e762854eae_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..19b0e4a763c6242eb1177d5073034644ad7f7133 --- /dev/null +++ b/raw/rel-18/29_series/29061/f0e3f79f8b55cbaba4a467e762854eae_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ecdbc9e86a33f1f3bbd64e58e7b41d7d3531d80432a131fe83b4e9d646dcae0e +size 41132 diff --git a/raw/rel-18/29_series/29061/f4e5a86da5c799372a7c1ea2397dedb7_img.jpg b/raw/rel-18/29_series/29061/f4e5a86da5c799372a7c1ea2397dedb7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..75f05898954745afed6ae0accb39272ad28b1e8b --- /dev/null +++ b/raw/rel-18/29_series/29061/f4e5a86da5c799372a7c1ea2397dedb7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c1217a3894ebcb3cdbb2fe028d42d9f9d84166db7a190e8ac743e0b7d4083703 +size 13480 diff --git a/raw/rel-18/29_series/29061/ffb6acd27b8e3a54392840948a75869f_img.jpg b/raw/rel-18/29_series/29061/ffb6acd27b8e3a54392840948a75869f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..affa504ec0842ee7dcbbc403264eb5bec517f88a --- /dev/null +++ b/raw/rel-18/29_series/29061/ffb6acd27b8e3a54392840948a75869f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8acee7bf9f3c15b9cb0f3979fcb99aeac2dc1949019e36808601c95b93d23030 +size 38811 diff --git a/raw/rel-18/29_series/29122/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29122/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..165d6b2a32ff675437cf1cd496a43e1671dcadca --- /dev/null +++ b/raw/rel-18/29_series/29122/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a1f8db982a32b56e11f20e3a53415766a194668048f6c29d2c7b8d9c92b45c8a +size 5672 diff --git a/raw/rel-18/29_series/29165/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29165/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e7c3fc4ea6e2188e2139b2a607c8be64514da73a --- /dev/null +++ b/raw/rel-18/29_series/29165/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:130f3157ee1c56a7baa5236a99129204d6b38fd2a13a2ba450cc4995144e0749 +size 9460 diff --git a/raw/rel-18/29_series/29165/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29165/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c37d536f77a90b8f3955ec4459e5b26419038eab --- /dev/null +++ b/raw/rel-18/29_series/29165/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ce2aaf3db01c405afd4ebdba25ffa271138b59d1408b4a9432be97d3d69be2c2 +size 5740 diff --git a/raw/rel-18/29_series/29165/79e1709a7317ead45379cbb8ff3ba802_img.jpg b/raw/rel-18/29_series/29165/79e1709a7317ead45379cbb8ff3ba802_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..472d85332829dcd0a326710512ceeeb1dc989f2c --- /dev/null +++ b/raw/rel-18/29_series/29165/79e1709a7317ead45379cbb8ff3ba802_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:38f63b7860b73dc0fb90cff26119a80105805e8392b1709a8a4cdc5c4ab48881 +size 17692 diff --git a/raw/rel-18/29_series/29165/ab846b81e78dbc8da2a6f9511e2f248a_img.jpg b/raw/rel-18/29_series/29165/ab846b81e78dbc8da2a6f9511e2f248a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7b3c871bb644111c81b9ffb2a255af6d39681829 --- /dev/null +++ b/raw/rel-18/29_series/29165/ab846b81e78dbc8da2a6f9511e2f248a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:77c3e8cacd13f8b7979119bfc5f874fed8d70d89ac735c8930274220c31821bf +size 59745 diff --git a/raw/rel-18/29_series/29172/426efb7efdc753a13f2fa16f7bff9429_img.jpg b/raw/rel-18/29_series/29172/426efb7efdc753a13f2fa16f7bff9429_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..79d22ad5bdbfa897cae5a685d825304daa6af5e7 --- /dev/null +++ b/raw/rel-18/29_series/29172/426efb7efdc753a13f2fa16f7bff9429_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cc8acc4dda2840712b64cf2e4c362e25abc31aeda3dedafcf44328a199c5b455 +size 26422 diff --git a/raw/rel-18/29_series/29172/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29172/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fdfeb07984b4a694aec22387177ba0720d72f0d3 --- /dev/null +++ b/raw/rel-18/29_series/29172/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:86db975150b654017c0cca20d96eb54aa40664dcc645706107be41c423005743 +size 10228 diff --git a/raw/rel-18/29_series/29172/b0d4609bc46c2d88a8318706bb5321f7_img.jpg b/raw/rel-18/29_series/29172/b0d4609bc46c2d88a8318706bb5321f7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df590cfa4292b24d2b5886b7b15b1287a7549c61 --- /dev/null +++ b/raw/rel-18/29_series/29172/b0d4609bc46c2d88a8318706bb5321f7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d0daae072e6c3092052cd3d545abbe0295fca877fc0240163caaf35c8040a5e3 +size 24793 diff --git a/raw/rel-18/29_series/29172/e6df2733626a85205c1db682e6259c46_img.jpg b/raw/rel-18/29_series/29172/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5c4a568f678a6b93a64b0877f0cb92b0aa3e2df8 --- /dev/null +++ b/raw/rel-18/29_series/29172/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ade4bb15b871c912cda8423ec0c67fba22a202c2e832d7b6ef05c89582d37ed5 +size 25340 diff --git a/raw/rel-18/29_series/29176/053f1077d592e6622cd21dc4bb4cb366_img.jpg b/raw/rel-18/29_series/29176/053f1077d592e6622cd21dc4bb4cb366_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d61aa002cf4b02cf3d3681dc522d55b134f389b1 --- /dev/null +++ b/raw/rel-18/29_series/29176/053f1077d592e6622cd21dc4bb4cb366_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2464ce25f6780cf82e7099cc06b64aabadba420d63e02f47654ca7c4667169ce +size 28861 diff --git a/raw/rel-18/29_series/29176/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg b/raw/rel-18/29_series/29176/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..68ad38be8bd33adbde6e26dc6d619cc98bb82406 --- /dev/null +++ b/raw/rel-18/29_series/29176/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8e04d6d708384d1c662b4ed6358d7312cbc594c835ed2e2b81d19bdffc65876a +size 13420 diff --git a/raw/rel-18/29_series/29176/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29176/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ce540fe20b7a0b2c41091ece627f144e6db2d30f --- /dev/null +++ b/raw/rel-18/29_series/29176/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:baa7964e20a7a9cab0bc2d84924bc6f05aa70b210e6c80afe1d996dc71116799 +size 9604 diff --git a/raw/rel-18/29_series/29176/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29176/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8100a15c900e98697870ba4c1afddbe7c9b3ee68 --- /dev/null +++ b/raw/rel-18/29_series/29176/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb40bc9f76c66728d07c34b52e7e2c983ae7e9e2ffb632d60220ebfd237c17a3 +size 5694 diff --git a/raw/rel-18/29_series/29176/98a45dd7d474e067b7533cc966c11e95_img.jpg b/raw/rel-18/29_series/29176/98a45dd7d474e067b7533cc966c11e95_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..471ad6f5d645ab80ba938663c4e506eeecbd9870 --- /dev/null +++ b/raw/rel-18/29_series/29176/98a45dd7d474e067b7533cc966c11e95_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bc545ab0798c4478dd7d7e27cda5aefdbf9927d8353639ce733ffc848ad05d72 +size 6209 diff --git a/raw/rel-18/29_series/29176/af6be343f0c0a8f155f965dcf337b8af_img.jpg b/raw/rel-18/29_series/29176/af6be343f0c0a8f155f965dcf337b8af_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..116edfe859e986ec38c7da84528c85de38665ba7 --- /dev/null +++ b/raw/rel-18/29_series/29176/af6be343f0c0a8f155f965dcf337b8af_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:95ec7a3054fc80f1b7ab2e723695895c76cb22ea67cddbcd67ae6c1a011542c5 +size 29894 diff --git a/raw/rel-18/29_series/29176/ec98c4d2d93f28dfc8eb9d5e5730f62d_img.jpg b/raw/rel-18/29_series/29176/ec98c4d2d93f28dfc8eb9d5e5730f62d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..30a0b8604286f7cc643d9d914c03cb4009b339d0 --- /dev/null +++ b/raw/rel-18/29_series/29176/ec98c4d2d93f28dfc8eb9d5e5730f62d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:299c690223dd205ff3236efe859282367b6534af51149664f5d96db455ee5b08 +size 32681 diff --git a/raw/rel-18/29_series/29213/0236eff05bcb8f3a343ea7933aaa306b_img.jpg b/raw/rel-18/29_series/29213/0236eff05bcb8f3a343ea7933aaa306b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..68227aac855b2c783b2b743cb7b9b1833f204dd7 --- /dev/null +++ b/raw/rel-18/29_series/29213/0236eff05bcb8f3a343ea7933aaa306b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:de25dbfe4b4b13a3675543df61319a3a5fda17e79567a774a9d615ad44f70923 +size 62445 diff --git a/raw/rel-18/29_series/29213/08441fa90c5fd11994626f662ac13f19_img.jpg b/raw/rel-18/29_series/29213/08441fa90c5fd11994626f662ac13f19_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..414b31e9485dc2a845209c53286a988ea5026062 --- /dev/null +++ b/raw/rel-18/29_series/29213/08441fa90c5fd11994626f662ac13f19_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e43041a3217852f9e7d4ef7174e96ae0693d36e3f33334a7a7e3a9d9d8fb579a +size 16715 diff --git a/raw/rel-18/29_series/29213/0b87abe67b21a93777287649c33e755d_img.jpg b/raw/rel-18/29_series/29213/0b87abe67b21a93777287649c33e755d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b48f7c0c9ac722c47459e679313e7fbf1c789fee --- /dev/null +++ b/raw/rel-18/29_series/29213/0b87abe67b21a93777287649c33e755d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e86be0747c8ba142cc51616d99ba794c8e8ec9fd2086617bd7e1d6b8d5c8dbb7 +size 22311 diff --git a/raw/rel-18/29_series/29213/10781f43062bf3e9601a1e086710556c_img.jpg b/raw/rel-18/29_series/29213/10781f43062bf3e9601a1e086710556c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d7105f0e23a7531333daab9f4fe2326ac53d1d53 --- /dev/null +++ b/raw/rel-18/29_series/29213/10781f43062bf3e9601a1e086710556c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bf5f5158488d84a1f616eff0b2945c975e5a55022600a210b33a4673ba1933fe +size 132666 diff --git a/raw/rel-18/29_series/29213/12a6537c92844d5b393104c02e8dfc2f_img.jpg b/raw/rel-18/29_series/29213/12a6537c92844d5b393104c02e8dfc2f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3db2b7fc22e302970c4c97c40b6cec87def4f165 --- /dev/null +++ b/raw/rel-18/29_series/29213/12a6537c92844d5b393104c02e8dfc2f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:34925d429aa9958cd105448d3ff2250ea68a58f0f299edd6805bc8b450c2b664 +size 39117 diff --git a/raw/rel-18/29_series/29213/163688ca8da9787f5d48edd68d8cc75b_img.jpg b/raw/rel-18/29_series/29213/163688ca8da9787f5d48edd68d8cc75b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..86b93f2fe9f1010fc79b61400a4e1ae102633dd8 --- /dev/null +++ b/raw/rel-18/29_series/29213/163688ca8da9787f5d48edd68d8cc75b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8394c968cea7c9c974ac008ecbf06bd2f7eec131674f3a1248734bcc8291f6e3 +size 56115 diff --git a/raw/rel-18/29_series/29213/164d1b48231be457522b31965610ea3b_img.jpg b/raw/rel-18/29_series/29213/164d1b48231be457522b31965610ea3b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d55ec8d8bf12e62be614f6cf695ac7cf7603b593 --- /dev/null +++ b/raw/rel-18/29_series/29213/164d1b48231be457522b31965610ea3b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:81503102aa42ee16681ee84122b8e99eae4009483c26962fa500dfa9ef120052 +size 87854 diff --git a/raw/rel-18/29_series/29213/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg b/raw/rel-18/29_series/29213/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fc6051b478f07e12405698003d794da47aa8b437 --- /dev/null +++ b/raw/rel-18/29_series/29213/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f6f959f068807e7dcf9f9ac18fa708f0f6877ddc38f3f0e0b619aaa33dd6b7bc +size 107060 diff --git a/raw/rel-18/29_series/29213/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/raw/rel-18/29_series/29213/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f9a2d64523d3df72538d42a6faecc390e7ce8107 --- /dev/null +++ b/raw/rel-18/29_series/29213/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c3741cab3d4cd4ee2edb8c05861afe9d9f076f62658c94d123e99d6cd20a4fe0 +size 115683 diff --git a/raw/rel-18/29_series/29213/1b5a812c8aa20fd5cba28e97001d32de_img.jpg b/raw/rel-18/29_series/29213/1b5a812c8aa20fd5cba28e97001d32de_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..af14cee71d201f39a4546c309052713501c17041 --- /dev/null +++ b/raw/rel-18/29_series/29213/1b5a812c8aa20fd5cba28e97001d32de_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c7abe694b6a6b7f0aabea2ca02adbb19c5d5206cc37022f443cf29b908065ca +size 15067 diff --git a/raw/rel-18/29_series/29213/21ad58fee90f2be50708ff541d225507_img.jpg b/raw/rel-18/29_series/29213/21ad58fee90f2be50708ff541d225507_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2c8499fca0f2b702e2a37502760ba168f4dd61d4 --- /dev/null +++ b/raw/rel-18/29_series/29213/21ad58fee90f2be50708ff541d225507_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:66fe556ba2c585b41229d3412bdd75d5ad72599f2d2c428293b5a7c096273a9f +size 30492 diff --git a/raw/rel-18/29_series/29213/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/raw/rel-18/29_series/29213/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bf1b66668ac679efa2df08f01be2b266090481bd --- /dev/null +++ b/raw/rel-18/29_series/29213/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3e62cd0c69513673857393fe0489feba955f78c16b2db21082d212568a15b1da +size 70671 diff --git a/raw/rel-18/29_series/29213/4356776ca004ecba5d599667a155d7d4_img.jpg b/raw/rel-18/29_series/29213/4356776ca004ecba5d599667a155d7d4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..279db0cea46fe8423cde0bd339b7961f04ebd342 --- /dev/null +++ b/raw/rel-18/29_series/29213/4356776ca004ecba5d599667a155d7d4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:09f7c8c0af30ea186bf7492a3dd0794e0f1107ed4f738224b4468d8fa6d0bfba +size 102313 diff --git a/raw/rel-18/29_series/29213/4792a2ccd62226861fadc22117edb7b1_img.jpg b/raw/rel-18/29_series/29213/4792a2ccd62226861fadc22117edb7b1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c22f387d41f087a149304f774dbd998b486cb97b --- /dev/null +++ b/raw/rel-18/29_series/29213/4792a2ccd62226861fadc22117edb7b1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f2c7f51893fafefd66924099fa3b9e693e1974603a0b20df5ce5bcf2dad0b671 +size 58225 diff --git a/raw/rel-18/29_series/29213/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg b/raw/rel-18/29_series/29213/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1e6d149bae77bb6a9558a6ee61a40620cb86109f --- /dev/null +++ b/raw/rel-18/29_series/29213/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:37987a34935a183a4d4491d4f5a91a7fb72a2fd0a59d6a1de2bc3901215a241c +size 64259 diff --git a/raw/rel-18/29_series/29213/536951b2bbd94325ae266d8d1363df8f_img.jpg b/raw/rel-18/29_series/29213/536951b2bbd94325ae266d8d1363df8f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..304072ece05f27149b9b9c16511bd5b3e9a751b6 --- /dev/null +++ b/raw/rel-18/29_series/29213/536951b2bbd94325ae266d8d1363df8f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:79268afd164305e7cde8e0e6bd47d38ca880ab15038673d6c5511c0865758d17 +size 71180 diff --git a/raw/rel-18/29_series/29213/54a53f959bb7758332532c1cd5f0ad75_img.jpg b/raw/rel-18/29_series/29213/54a53f959bb7758332532c1cd5f0ad75_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..34066f04f577feb0ef2a97d511126511648db662 --- /dev/null +++ b/raw/rel-18/29_series/29213/54a53f959bb7758332532c1cd5f0ad75_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5cb6c0e6ca755e8210969b7bf68921c2bad1b50b9af8ce9234dd7208dfd843df +size 107229 diff --git a/raw/rel-18/29_series/29213/54fabc351eda5228d2fa28cd9ba07971_img.jpg b/raw/rel-18/29_series/29213/54fabc351eda5228d2fa28cd9ba07971_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..843d4b91de96b27cd103554165ac24b109c466f3 --- /dev/null +++ b/raw/rel-18/29_series/29213/54fabc351eda5228d2fa28cd9ba07971_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9794daf8a818320eb0ec38ab1b881cf80b1ed632a216b79a16c24f095eb44d44 +size 23493 diff --git a/raw/rel-18/29_series/29213/573c8f9e728e343b6864e1070c14b8cf_img.jpg b/raw/rel-18/29_series/29213/573c8f9e728e343b6864e1070c14b8cf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..09c7a5cd3009b164641638a4273993260cda6355 --- /dev/null +++ b/raw/rel-18/29_series/29213/573c8f9e728e343b6864e1070c14b8cf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c585a7ddb62bcf2ff706b515f6804416d45b0c164796eb198263c09684871497 +size 64795 diff --git a/raw/rel-18/29_series/29213/5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg b/raw/rel-18/29_series/29213/5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f63c746e54cf29a3c430e615f9f0f8b9acccd483 --- /dev/null +++ b/raw/rel-18/29_series/29213/5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee01bc700efd7a25421e227d8b3c19fe21c38f2571b581b8690eca927924a233 +size 77491 diff --git a/raw/rel-18/29_series/29213/5a24ac755b962fd5f0183f13de0726de_img.jpg b/raw/rel-18/29_series/29213/5a24ac755b962fd5f0183f13de0726de_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7115c719973f63bc1df965e9734705b777504a6f --- /dev/null +++ b/raw/rel-18/29_series/29213/5a24ac755b962fd5f0183f13de0726de_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5410698f225c84fb0a82e8ee13440b5841fd67a2b6c89481547b96ba77d0d434 +size 37503 diff --git a/raw/rel-18/29_series/29213/5a4e62bead259c258d069fd3663ea670_img.jpg b/raw/rel-18/29_series/29213/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c8f65d5275b507bff34d1749fc6336002aaf68c --- /dev/null +++ b/raw/rel-18/29_series/29213/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85aec28a0a04b36baa34bb1879ed8a30d7a6fd0162d20ee2d9f4f179e70c9517 +size 69146 diff --git a/raw/rel-18/29_series/29213/5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg b/raw/rel-18/29_series/29213/5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ab800dd9274c806b4703a53ede2ac20569861b7a --- /dev/null +++ b/raw/rel-18/29_series/29213/5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5dacea3b0c1121362641b7eb701023ce632f3cf2fb8e0cee794b14deb7245463 +size 42928 diff --git a/raw/rel-18/29_series/29213/5e92d9e8e9ce204e405bff2367f88176_img.jpg b/raw/rel-18/29_series/29213/5e92d9e8e9ce204e405bff2367f88176_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6c4f56ec01b339226e08a1651d0fc39ea37d5b98 --- /dev/null +++ b/raw/rel-18/29_series/29213/5e92d9e8e9ce204e405bff2367f88176_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:30f492f452f2c8d117cfc9019c1c93bfabbc67b6dad251b9ed6c31270bac966c +size 21637 diff --git a/raw/rel-18/29_series/29213/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29213/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..01d955e85ce4b36b12507d7a1aa2af028fb68b3a --- /dev/null +++ b/raw/rel-18/29_series/29213/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e3bb8c49c893cfd5d1b755529afd464d0fca4c4d92fe06ebb419bc9ecc7d432e +size 9482 diff --git a/raw/rel-18/29_series/29213/627c5195eaae3bc7e34cbc4dbdb6f9a8_img.jpg b/raw/rel-18/29_series/29213/627c5195eaae3bc7e34cbc4dbdb6f9a8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ee94be248a81b385ac93dc1193ffb5d4a7b0a836 --- /dev/null +++ b/raw/rel-18/29_series/29213/627c5195eaae3bc7e34cbc4dbdb6f9a8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d72d5c6765c0e110cab1f372f3026fa8083fa029de00a5b865f4a38ef8e48437 +size 93625 diff --git a/raw/rel-18/29_series/29213/6324b252294c0f5d4e34dad4a1202075_img.jpg b/raw/rel-18/29_series/29213/6324b252294c0f5d4e34dad4a1202075_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3fb960a23041f85eac52d6f60ccf0f32fef2e17e --- /dev/null +++ b/raw/rel-18/29_series/29213/6324b252294c0f5d4e34dad4a1202075_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c842862e74bf5043c1628b9a12d45b87af5a8895506886b7faa1acbeb00c66fe +size 54605 diff --git a/raw/rel-18/29_series/29213/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29213/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ff7544089b6d1627b83cf38c2b70dd1b084033e6 --- /dev/null +++ b/raw/rel-18/29_series/29213/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8dce0eaac534f66b26ceadc42caea5818ad487246f3705865ad3e6bb5af4541c +size 5532 diff --git a/raw/rel-18/29_series/29213/68d50e85fb8de4fae0e0eafaf20e63c0_img.jpg b/raw/rel-18/29_series/29213/68d50e85fb8de4fae0e0eafaf20e63c0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..61d392c98444ead03a73972ee9926f0980484b87 --- /dev/null +++ b/raw/rel-18/29_series/29213/68d50e85fb8de4fae0e0eafaf20e63c0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c069c264d0cba165d836077eb32d8bf7b7c668ad4681aaf1cc2c6800846de91b +size 97303 diff --git a/raw/rel-18/29_series/29213/69edc2887e907309499ac95b47ab6905_img.jpg b/raw/rel-18/29_series/29213/69edc2887e907309499ac95b47ab6905_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e781cf64a5cbc3cb942479046c159d1adf5f0fec --- /dev/null +++ b/raw/rel-18/29_series/29213/69edc2887e907309499ac95b47ab6905_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:525360ec52a2872bf582042f4f49a6642ffe15dc661fbb1cc6329bc83a494cef +size 65327 diff --git a/raw/rel-18/29_series/29213/6d6670b8e65d3ff8126e5ab9aeaffbd8_img.jpg b/raw/rel-18/29_series/29213/6d6670b8e65d3ff8126e5ab9aeaffbd8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..67e89a7397142b97a0d0433bc061c697f2c3577b --- /dev/null +++ b/raw/rel-18/29_series/29213/6d6670b8e65d3ff8126e5ab9aeaffbd8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:15b6740c9c7fbfa1dc42a1298e1459a120b13c721d66071d8faaab9af809ffbe +size 56990 diff --git a/raw/rel-18/29_series/29213/705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg b/raw/rel-18/29_series/29213/705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a907d6f87a59cb07792903d76b83ca2278c1fa22 --- /dev/null +++ b/raw/rel-18/29_series/29213/705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eb4cec3427e769568962feeed1c929dcc733cd0c4cf4d3e83bb6aaef46736ab0 +size 94885 diff --git a/raw/rel-18/29_series/29213/715219db84ec2a5622d09f9d822b4550_img.jpg b/raw/rel-18/29_series/29213/715219db84ec2a5622d09f9d822b4550_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e63f0b070ae0ba12b7052a13d7837bcf79d87380 --- /dev/null +++ b/raw/rel-18/29_series/29213/715219db84ec2a5622d09f9d822b4550_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:14664bd50c4e8cabe4a7c2fe130483a948b36aaeeb747b1b402f0b9e64f19d6e +size 51769 diff --git a/raw/rel-18/29_series/29213/7a1dee155822446f7828dcb055c465c3_img.jpg b/raw/rel-18/29_series/29213/7a1dee155822446f7828dcb055c465c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c9457fa99b27841122c6de7ac8181477038da11 --- /dev/null +++ b/raw/rel-18/29_series/29213/7a1dee155822446f7828dcb055c465c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:02894546040f26eb542414b089364c5546c73067407b4dae267d8df0db15a511 +size 45809 diff --git a/raw/rel-18/29_series/29213/7e670a2b556b53ea9002dfff3a420e08_img.jpg b/raw/rel-18/29_series/29213/7e670a2b556b53ea9002dfff3a420e08_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f4a0ddf38ff9e418c7e348db7aa8f2a2b313f878 --- /dev/null +++ b/raw/rel-18/29_series/29213/7e670a2b556b53ea9002dfff3a420e08_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9da656a29d23f92a0828cfafba56e62cd0f21bd37cc0aa97e91ac861b1dfd265 +size 39039 diff --git a/raw/rel-18/29_series/29213/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/raw/rel-18/29_series/29213/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..882985c2e74e7f65df8cb6d07d3ea40d8e5d3eb1 --- /dev/null +++ b/raw/rel-18/29_series/29213/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5f61a9169ff3131d2756b92760dab311fbb69469fd13e5f3f10c63f4cc8317e +size 16715 diff --git a/raw/rel-18/29_series/29213/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg b/raw/rel-18/29_series/29213/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ddd493a00faaf59bf874feace6d4aeb9de6281e3 --- /dev/null +++ b/raw/rel-18/29_series/29213/81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d1f8c9d71e4006b23c4a4986ab12df779510c4fdff21995e9e6fb241c29e63a8 +size 131588 diff --git a/raw/rel-18/29_series/29213/820515db47ded68f5e0b625f4ec7d2c1_img.jpg b/raw/rel-18/29_series/29213/820515db47ded68f5e0b625f4ec7d2c1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..174018dcaafc579d9682bfb524516483fa894632 --- /dev/null +++ b/raw/rel-18/29_series/29213/820515db47ded68f5e0b625f4ec7d2c1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:276cabecf386e09186e477de6c08ca618d2cda493264a095f9a9e40f9d37522b +size 224761 diff --git a/raw/rel-18/29_series/29213/8307f6b04df072c9332f9987e034272c_img.jpg b/raw/rel-18/29_series/29213/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1e4a2bdb991aa3e4220dca8ae7557f16249ee12a --- /dev/null +++ b/raw/rel-18/29_series/29213/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:605136e73456537e1c8cf775d9f906b9fdb8821cf709dca7ed6ba942684bf734 +size 130217 diff --git a/raw/rel-18/29_series/29213/838c31609fac483fa2c01c7896a2fd6d_img.jpg b/raw/rel-18/29_series/29213/838c31609fac483fa2c01c7896a2fd6d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1f0e3e9fcbe914938b304c67b805196ba72ad707 --- /dev/null +++ b/raw/rel-18/29_series/29213/838c31609fac483fa2c01c7896a2fd6d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ba1a2feb7dd9afe18d10c049a2a1d90c5a23845bea1527416284fa97a1c8b76 +size 62844 diff --git a/raw/rel-18/29_series/29213/88b0f3f4393228e9ea4d6542aef7c399_img.jpg b/raw/rel-18/29_series/29213/88b0f3f4393228e9ea4d6542aef7c399_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f08d72016d347858dc1829f6b6360c99e055e78f --- /dev/null +++ b/raw/rel-18/29_series/29213/88b0f3f4393228e9ea4d6542aef7c399_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:edb5ad5dc0e72dece8401eace8ff4a4705a0ca2778a8368ccd2208423fd24b80 +size 140575 diff --git a/raw/rel-18/29_series/29213/8e80de0cac529b2c3775d677c5203133_img.jpg b/raw/rel-18/29_series/29213/8e80de0cac529b2c3775d677c5203133_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..61baeda38b18e808feac1888f60c0c1422d86fdc --- /dev/null +++ b/raw/rel-18/29_series/29213/8e80de0cac529b2c3775d677c5203133_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:93b95ef8b75cbc5c63b38ba933fd743d73333906188b048b69044f3b7d07a705 +size 67097 diff --git a/raw/rel-18/29_series/29213/8fa679f79a1bb1f527cba9f29e784e89_img.jpg b/raw/rel-18/29_series/29213/8fa679f79a1bb1f527cba9f29e784e89_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2024c5ffe880f4add5adeaf4cede87eb7dba4b60 --- /dev/null +++ b/raw/rel-18/29_series/29213/8fa679f79a1bb1f527cba9f29e784e89_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:187ed45ea045f7bbb553da6d884667428b7c04bfaff21b9f961e8613ea2b5b01 +size 153696 diff --git a/raw/rel-18/29_series/29213/997233d405f0d4b89ddeb7683e047f66_img.jpg b/raw/rel-18/29_series/29213/997233d405f0d4b89ddeb7683e047f66_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a1871766556607248ceaefe891a8742d1ff0fb0e --- /dev/null +++ b/raw/rel-18/29_series/29213/997233d405f0d4b89ddeb7683e047f66_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:79d334952d0cb8f07e5a039d8101de20dd6d6fac1a5fecdb8c4a828a08c3a9b8 +size 103129 diff --git a/raw/rel-18/29_series/29213/a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg b/raw/rel-18/29_series/29213/a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3dcdb4419abf1679d043a8dd113440fb99bddb57 --- /dev/null +++ b/raw/rel-18/29_series/29213/a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d33418ec1b810cf5317ad5619fc440d1047eae360acb01e3b8a51a8bfc83b0f0 +size 60598 diff --git a/raw/rel-18/29_series/29213/a0739aaf13fa5a632d4faa830f6b2708_img.jpg b/raw/rel-18/29_series/29213/a0739aaf13fa5a632d4faa830f6b2708_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b3ef8a4bd46e84dd1b8aca63f6d70c2d65145f49 --- /dev/null +++ b/raw/rel-18/29_series/29213/a0739aaf13fa5a632d4faa830f6b2708_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:043bbb192b0e72264b543420172f75980ab8da2276e36897a181eb4144759b14 +size 102995 diff --git a/raw/rel-18/29_series/29213/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/raw/rel-18/29_series/29213/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..982ca9f3626e384e752ef95a297ca60670d6bf06 --- /dev/null +++ b/raw/rel-18/29_series/29213/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4a84b045ec405990e72c411308ea977f68428b46979386db175f51a5d0137184 +size 188999 diff --git a/raw/rel-18/29_series/29213/a3472689858b068ef469213682965325_img.jpg b/raw/rel-18/29_series/29213/a3472689858b068ef469213682965325_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5326bbbfa2d48d7f68c1ad347e82eb2ce8278949 --- /dev/null +++ b/raw/rel-18/29_series/29213/a3472689858b068ef469213682965325_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e98cd62d5c1db16314abc848ee0a624cc705016b62ebdd1e223783fa35df82f7 +size 126471 diff --git a/raw/rel-18/29_series/29213/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg b/raw/rel-18/29_series/29213/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5f27b5c233f3689b078bd2ffa2993a9377c57082 --- /dev/null +++ b/raw/rel-18/29_series/29213/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3544ab70ab109ec1b00e0a678b90eb12d01dc18d2616c6dbccac1c79f19c3c64 +size 22536 diff --git a/raw/rel-18/29_series/29213/aa81b9b80bd1e3d723922b3a033564a2_img.jpg b/raw/rel-18/29_series/29213/aa81b9b80bd1e3d723922b3a033564a2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7af8d9b249f672095f6a31b965ddf05ccc1c245e --- /dev/null +++ b/raw/rel-18/29_series/29213/aa81b9b80bd1e3d723922b3a033564a2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f6bf0dd6aab890139cba15fcc8fa40ac9d3cc95efcb17bb2c9507f2008696791 +size 49452 diff --git a/raw/rel-18/29_series/29213/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg b/raw/rel-18/29_series/29213/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..58711da53cb44ae6c60ca794caba97861aaa4c89 --- /dev/null +++ b/raw/rel-18/29_series/29213/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f95c198a8d994c654a723ed94390de91623c4ff98f78332cd36f1da626c4c56a +size 192675 diff --git a/raw/rel-18/29_series/29213/af6be343f0c0a8f155f965dcf337b8af_img.jpg b/raw/rel-18/29_series/29213/af6be343f0c0a8f155f965dcf337b8af_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df6d3640b9f89d9f8f84d0629d998fa9f3207d0d --- /dev/null +++ b/raw/rel-18/29_series/29213/af6be343f0c0a8f155f965dcf337b8af_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:01f0e820fe32e3bf4ecd361859b221c55c24dd38e99be34040b17cc6334ac1b9 +size 16694 diff --git a/raw/rel-18/29_series/29213/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/raw/rel-18/29_series/29213/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a85dbda3f5697fa85123894492d1975e346f311e --- /dev/null +++ b/raw/rel-18/29_series/29213/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6222b37646b262d184850a5775ea466e33a4860f7d4adde3bc0d9c170631a375 +size 46478 diff --git a/raw/rel-18/29_series/29213/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg b/raw/rel-18/29_series/29213/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ea99b002a25db466b58428bee0dda63110809a3a --- /dev/null +++ b/raw/rel-18/29_series/29213/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bf67da0c1f7e8319cd7ba26cdf170d65ec3f3bfc536a1c67ce959c21871af9b5 +size 95404 diff --git a/raw/rel-18/29_series/29213/be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg b/raw/rel-18/29_series/29213/be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e6819dfcb9513efd86949450e4bc91443ae206d7 --- /dev/null +++ b/raw/rel-18/29_series/29213/be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4db1752859ba2ee6be812a5a042b7afaf3840a8fa5b6e71688af57e84de82517 +size 61357 diff --git a/raw/rel-18/29_series/29213/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg b/raw/rel-18/29_series/29213/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4b24b6cd88bfc17ab309fb2a20c75dae8dda4456 --- /dev/null +++ b/raw/rel-18/29_series/29213/c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8055cec96a9de866a0047567addf68c299117840ba7b46c73c62271c45d8a5c1 +size 105504 diff --git a/raw/rel-18/29_series/29213/c2fc2621e8206d24427b56bcb2398fc0_img.jpg b/raw/rel-18/29_series/29213/c2fc2621e8206d24427b56bcb2398fc0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e2a83d214aff21316f746e44307e9a883c0917bf --- /dev/null +++ b/raw/rel-18/29_series/29213/c2fc2621e8206d24427b56bcb2398fc0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6bbdab79d2ad66dfca9e11323b982ec5e13d4230ccc27ccd5813427af2839e78 +size 35029 diff --git a/raw/rel-18/29_series/29213/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg b/raw/rel-18/29_series/29213/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..76af9ecc82ed88d2d5420c05b89206a0a57df6ba --- /dev/null +++ b/raw/rel-18/29_series/29213/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99da2772ec5db58f18c21038413582da1284aa34f258b3c57e8be1cecc3634ff +size 16656 diff --git a/raw/rel-18/29_series/29213/c78c2eefd86269d1740ab85a916f24f2_img.jpg b/raw/rel-18/29_series/29213/c78c2eefd86269d1740ab85a916f24f2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a0a435b340b2a7ca9084b2f1a31071bd6ff28516 --- /dev/null +++ b/raw/rel-18/29_series/29213/c78c2eefd86269d1740ab85a916f24f2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:77afab273d856329f2a785ab8835ae94e7202f26cd748bb9987f10ff9e105f8a +size 106101 diff --git a/raw/rel-18/29_series/29213/ca5566458a134032dd860e88fdaa0d2b_img.jpg b/raw/rel-18/29_series/29213/ca5566458a134032dd860e88fdaa0d2b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6bce13b6df05c0f54ff09c4c1a0979e20cfc3bb6 --- /dev/null +++ b/raw/rel-18/29_series/29213/ca5566458a134032dd860e88fdaa0d2b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:77e8093ff220c973ce4a22ee5796fece96cfbfbb204334741c7713105bcaec81 +size 110239 diff --git a/raw/rel-18/29_series/29213/cab0834804fb031b43865554cc8d06ab_img.jpg b/raw/rel-18/29_series/29213/cab0834804fb031b43865554cc8d06ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..41e8342c1c2c2abbfe08c8de29295448a5983736 --- /dev/null +++ b/raw/rel-18/29_series/29213/cab0834804fb031b43865554cc8d06ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7a4be528e3133cf528d747f12d56417c62f08843e163a394111ef08a269fc1de +size 93154 diff --git a/raw/rel-18/29_series/29213/cf8bd014a50b7c69435e804f67f9617f_img.jpg b/raw/rel-18/29_series/29213/cf8bd014a50b7c69435e804f67f9617f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ff91c98635ac81b0d26d55d3fc5323f2d2c0d280 --- /dev/null +++ b/raw/rel-18/29_series/29213/cf8bd014a50b7c69435e804f67f9617f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:21b83c054be38b162693f32a79f9889fdbc1fea6ec94518756d16da29e34bd2f +size 70149 diff --git a/raw/rel-18/29_series/29213/d0abac95583b52a3b35f74a215567334_img.jpg b/raw/rel-18/29_series/29213/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4998a60f9a7feb6997683c6f43ac37d3cddda25f --- /dev/null +++ b/raw/rel-18/29_series/29213/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e2c4658a9b9ffe2d16d57ee23990983b0ab4844d762b1800bdda21dcc0b16c40 +size 45589 diff --git a/raw/rel-18/29_series/29213/d3ca266c298aeb34b019960c6c36f187_img.jpg b/raw/rel-18/29_series/29213/d3ca266c298aeb34b019960c6c36f187_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4764e49c2c92bc4d33206e44937030cde77cfe37 --- /dev/null +++ b/raw/rel-18/29_series/29213/d3ca266c298aeb34b019960c6c36f187_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f41bffd3c42335a2e4573471558943c7a4e8a7f2bc68c50b412f6fb373ff1aa8 +size 32852 diff --git a/raw/rel-18/29_series/29213/d793cf7c174b89eb024d132f00679787_img.jpg b/raw/rel-18/29_series/29213/d793cf7c174b89eb024d132f00679787_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a4f8ebf322f0df8337dbbc4da84464d40119c740 --- /dev/null +++ b/raw/rel-18/29_series/29213/d793cf7c174b89eb024d132f00679787_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3d9b72153d8a74073f64089d366ff087e272919ca25b277059178ee231a46662 +size 82617 diff --git a/raw/rel-18/29_series/29213/d980a3f9608055996a07f31788baf827_img.jpg b/raw/rel-18/29_series/29213/d980a3f9608055996a07f31788baf827_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..958cef9e297489a5655d0f13559151bfefbf7e86 --- /dev/null +++ b/raw/rel-18/29_series/29213/d980a3f9608055996a07f31788baf827_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5db95aea59148becf2e97086ca2b068a4b1b77c8fdede3795e65f52d4f12a989 +size 53313 diff --git a/raw/rel-18/29_series/29213/daa4a6fa7e2ba1954258f86b4928eb32_img.jpg b/raw/rel-18/29_series/29213/daa4a6fa7e2ba1954258f86b4928eb32_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f56638f669d168972c93abc04135314a7d90302f --- /dev/null +++ b/raw/rel-18/29_series/29213/daa4a6fa7e2ba1954258f86b4928eb32_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aeb07c99a3fb0cf93301ba2389d95cd92e494b0b839aba258a1c2591342761c6 +size 97465 diff --git a/raw/rel-18/29_series/29213/dd5771673aececa53d42ece89218299d_img.jpg b/raw/rel-18/29_series/29213/dd5771673aececa53d42ece89218299d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1596be91d77ae38a013c27188c91847e91ee7901 --- /dev/null +++ b/raw/rel-18/29_series/29213/dd5771673aececa53d42ece89218299d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d04190f084e3efc4ef120f45e1c467dd075f8f4cbb1970cf68f7819072da5a8c +size 51931 diff --git a/raw/rel-18/29_series/29213/ddc7460821484f1ae2835c67955c554c_img.jpg b/raw/rel-18/29_series/29213/ddc7460821484f1ae2835c67955c554c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d24e8d8c41e3e5d451d485753a47895b91c51669 --- /dev/null +++ b/raw/rel-18/29_series/29213/ddc7460821484f1ae2835c67955c554c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6b5b44960b84b58053e996e306afe3d81dfca36c618b4a10449b278954e973fc +size 15177 diff --git a/raw/rel-18/29_series/29213/ddee3e67e0dfc22e25188fa635a19558_img.jpg b/raw/rel-18/29_series/29213/ddee3e67e0dfc22e25188fa635a19558_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..708369563ec9c0951bb46896c9cb93264a2e60b0 --- /dev/null +++ b/raw/rel-18/29_series/29213/ddee3e67e0dfc22e25188fa635a19558_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:384f875d3569ed74ea9e2d492fa2cdddbfb2fe0080b3d6520537404ff1a32744 +size 56848 diff --git a/raw/rel-18/29_series/29213/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/raw/rel-18/29_series/29213/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..93c02c5a674fe761df28ecb3fffda9c50dfc3690 --- /dev/null +++ b/raw/rel-18/29_series/29213/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0d8c3daf311c7b2997262a5545d2824267db80cb8d4ba1fb3c77bba13fb8f150 +size 114199 diff --git a/raw/rel-18/29_series/29213/e1a0d046fbe7f28f5e93a47091851747_img.jpg b/raw/rel-18/29_series/29213/e1a0d046fbe7f28f5e93a47091851747_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a0a68b6bf0bcb1074cdf35ab81993b2266274f07 --- /dev/null +++ b/raw/rel-18/29_series/29213/e1a0d046fbe7f28f5e93a47091851747_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a47ce3e2e1e9a4d3169dccac29313d68191454b1faf80a38e1aff96e1302afcb +size 34938 diff --git a/raw/rel-18/29_series/29213/e636d7ccca0ad14c6b95201404324823_img.jpg b/raw/rel-18/29_series/29213/e636d7ccca0ad14c6b95201404324823_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..376195739f8d1594f3e685d4560d5a7ba5a348b8 --- /dev/null +++ b/raw/rel-18/29_series/29213/e636d7ccca0ad14c6b95201404324823_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c50158f6eb0b41f25a2e84f675f55be26b0f41fb5c63c7f31ac033b4de8c5dd9 +size 106235 diff --git a/raw/rel-18/29_series/29213/e6df2733626a85205c1db682e6259c46_img.jpg b/raw/rel-18/29_series/29213/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5d205961b4359764b52eb5db02ce53f231705449 --- /dev/null +++ b/raw/rel-18/29_series/29213/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae30091fdf59365ae63725431c679f8ea3d0a037ee5616607c58abc0782532a0 +size 70413 diff --git a/raw/rel-18/29_series/29213/e90987faabad6a6665cd8ed1151dc474_img.jpg b/raw/rel-18/29_series/29213/e90987faabad6a6665cd8ed1151dc474_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..578d14e6b775e9c472ed45236388a68aae4cd7af --- /dev/null +++ b/raw/rel-18/29_series/29213/e90987faabad6a6665cd8ed1151dc474_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2342a7d101a04585ce28746a8b7f6e00e897a7d92c7f848c9198fa9bd21569e2 +size 104451 diff --git a/raw/rel-18/29_series/29213/f0bae10b54c4f3cf8d0e33f5e2fb7cfa_img.jpg b/raw/rel-18/29_series/29213/f0bae10b54c4f3cf8d0e33f5e2fb7cfa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ca95d2c602d5f9d7a884a709ece944e3561e85b7 --- /dev/null +++ b/raw/rel-18/29_series/29213/f0bae10b54c4f3cf8d0e33f5e2fb7cfa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8d91f843c77dafbf9dcecb04c8d0bce95b8a228a2c8325d379b67935a2361244 +size 46535 diff --git a/raw/rel-18/29_series/29213/f57a881fcbcaf494a7dedc4f61224991_img.jpg b/raw/rel-18/29_series/29213/f57a881fcbcaf494a7dedc4f61224991_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3948ec10820316764ba75cc035f5e757603efdbd --- /dev/null +++ b/raw/rel-18/29_series/29213/f57a881fcbcaf494a7dedc4f61224991_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3fc0e0f1120d32c6b00347daadfd9cdcd4794251821666dad04397ae8491194b +size 16559 diff --git a/raw/rel-18/29_series/29213/f6d72d7c790e7f585532140f3971639a_img.jpg b/raw/rel-18/29_series/29213/f6d72d7c790e7f585532140f3971639a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..84da8695ce39f77312b72b101f54148415ad4522 --- /dev/null +++ b/raw/rel-18/29_series/29213/f6d72d7c790e7f585532140f3971639a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e535c2d391774b123e55d517daba5179c727a5e0715aa5f9f13230f3968bb349 +size 38296 diff --git a/raw/rel-18/29_series/29213/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/raw/rel-18/29_series/29213/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4429b15100ece29b863f83180e88dc03f60bf059 --- /dev/null +++ b/raw/rel-18/29_series/29213/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:64b511dc01ac928128851d834b12ae87b9ee874fbabd9f7b85d534b94e15f2ec +size 101787 diff --git a/raw/rel-18/29_series/29214/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29214/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e303aa4eff2a867bcee8a632c027faa2271e2e8b --- /dev/null +++ b/raw/rel-18/29_series/29214/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:da107141baa695be71f34e7da9ddacad53052312c4fa98a79efc90ac23fe118a +size 9140 diff --git a/raw/rel-18/29_series/29214/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29214/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8d514545d009295be219934f53d6750e6a52596b --- /dev/null +++ b/raw/rel-18/29_series/29214/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:54e42a4e1e5acec60d665da8831fe9d9fdc8b5d54fa89a4ae59ab7707b456656 +size 6846 diff --git a/raw/rel-18/29_series/29214/cdd0f1dd36631f2c4b17d7ca0f174d80_img.jpg b/raw/rel-18/29_series/29214/cdd0f1dd36631f2c4b17d7ca0f174d80_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ccc6ef0aaae5c9858211204b6ae58911f7d58662 --- /dev/null +++ b/raw/rel-18/29_series/29214/cdd0f1dd36631f2c4b17d7ca0f174d80_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e5f0750ace989cf2b529bd13d1576e66470ceabfc4549e7320bd01dc108eadc4 +size 8243 diff --git a/raw/rel-18/29_series/29214/ea37ab05b033e59cfdf7b074161aaf5a_img.jpg b/raw/rel-18/29_series/29214/ea37ab05b033e59cfdf7b074161aaf5a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a99555839a71cdb9bc530e252708493771cbb5e9 --- /dev/null +++ b/raw/rel-18/29_series/29214/ea37ab05b033e59cfdf7b074161aaf5a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cd89e26ffcfd2f7e14453298a20c6e3b5f9b7ccebd131e070c0c0c04a387eeaf +size 5580 diff --git a/raw/rel-18/29_series/29222/0a73b03fba21af142d619a9a662e6490_img.jpg b/raw/rel-18/29_series/29222/0a73b03fba21af142d619a9a662e6490_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4c2830274d89a97f61b65c792169be6f229c0d10 --- /dev/null +++ b/raw/rel-18/29_series/29222/0a73b03fba21af142d619a9a662e6490_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:773444faa34ba3435ebc8a58a979aafec7cbbc5993157cbbb30b57ad2007b553 +size 24178 diff --git a/raw/rel-18/29_series/29222/471c91d9988fb84924ddb6b71bb16fa1_img.jpg b/raw/rel-18/29_series/29222/471c91d9988fb84924ddb6b71bb16fa1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e0fcfd8f84e03df555d1a73edc6479693fda66af --- /dev/null +++ b/raw/rel-18/29_series/29222/471c91d9988fb84924ddb6b71bb16fa1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ef27bac895737b4e674ff152cef7817fd4f5dc0ac34515876daea2579110e9e3 +size 11260 diff --git a/raw/rel-18/29_series/29222/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29222/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f05292f7828cf69ee875a85eb0c64ef7288ddf4d --- /dev/null +++ b/raw/rel-18/29_series/29222/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:338cf2ce29350c6b629433f9cd0b0c35025bdc96800b7a0f955b590d768c0890 +size 9324 diff --git a/raw/rel-18/29_series/29222/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29222/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cbfbc91a44671ca87e7908f42406157a3304abd8 --- /dev/null +++ b/raw/rel-18/29_series/29222/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:71d704f7a9474f1eb58ba2fc3c3b6fee4a752893d956e0ec652c344cec6f4ce2 +size 5712 diff --git a/raw/rel-18/29_series/29222/896f6ec457b6252d4af32a634299218c_img.jpg b/raw/rel-18/29_series/29222/896f6ec457b6252d4af32a634299218c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dd29f20c22f03f0cca3e8318082f6f230be426cc --- /dev/null +++ b/raw/rel-18/29_series/29222/896f6ec457b6252d4af32a634299218c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8019cf8bba3109ccd18b3efcd94fcff058a20e4305d4e5ce55b732ef6730913d +size 30051 diff --git a/raw/rel-18/29_series/29222/8faeb7db381e28ab1ba06e9f48c19c6e_img.jpg b/raw/rel-18/29_series/29222/8faeb7db381e28ab1ba06e9f48c19c6e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0b5754bedf22b26e7c3063fe0f7149bd5e6bd137 --- /dev/null +++ b/raw/rel-18/29_series/29222/8faeb7db381e28ab1ba06e9f48c19c6e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2162563769b44f3036022463e45e342a3528115f11c40d91666397e97ac8a123 +size 23113 diff --git a/raw/rel-18/29_series/29222/9a7872f64558de06ee8b85b87e920b7e_img.jpg b/raw/rel-18/29_series/29222/9a7872f64558de06ee8b85b87e920b7e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b521ef2b25d7409d592b97f60e3cd0dfd9d20c73 --- /dev/null +++ b/raw/rel-18/29_series/29222/9a7872f64558de06ee8b85b87e920b7e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:17509412af2976e7c16115e170791302f0ce7c9bbf1115e33b04036b479165a3 +size 20978 diff --git a/raw/rel-18/29_series/29222/9cd6ff4a43174e4afe1cc5e4ea2fcae4_img.jpg b/raw/rel-18/29_series/29222/9cd6ff4a43174e4afe1cc5e4ea2fcae4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f0df68db2cd2030a247aee875ddcaf38164dfd93 --- /dev/null +++ b/raw/rel-18/29_series/29222/9cd6ff4a43174e4afe1cc5e4ea2fcae4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0255311613b16433841bd7ac23ed13892484764d32fda0eb26239969add63b10 +size 19516 diff --git a/raw/rel-18/29_series/29222/a6f9ef297168667527ab18da412f917d_img.jpg b/raw/rel-18/29_series/29222/a6f9ef297168667527ab18da412f917d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fda5d67a2e487f6b447b37f11caa3da51b0a8cc0 --- /dev/null +++ b/raw/rel-18/29_series/29222/a6f9ef297168667527ab18da412f917d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c460aaece65440bc2132fa5038b3a5d343676c99e07784621ba2612076a117a6 +size 26028 diff --git a/raw/rel-18/29_series/29222/b02ba0b73e95416eb547976f6145b169_img.jpg b/raw/rel-18/29_series/29222/b02ba0b73e95416eb547976f6145b169_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3ff194673d1153370cab2c7d46e3a4ecee9950a1 --- /dev/null +++ b/raw/rel-18/29_series/29222/b02ba0b73e95416eb547976f6145b169_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:699627ff32391ec605d5159eca15439c0e6e534f881c0583b6ee0cd33b13b74b +size 13279 diff --git a/raw/rel-18/29_series/29222/c07e21a8d65991db04263322f859c94f_img.jpg b/raw/rel-18/29_series/29222/c07e21a8d65991db04263322f859c94f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fc18db8e0b7de216de937fbf61c47097ea1630c2 --- /dev/null +++ b/raw/rel-18/29_series/29222/c07e21a8d65991db04263322f859c94f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4601d64137c82882b81a44b177adfd9ed585457d5a201b1e70bffd3f8736e68d +size 23782 diff --git a/raw/rel-18/29_series/29222/fc07df3b799d63e7e6c7760ca077ee99_img.jpg b/raw/rel-18/29_series/29222/fc07df3b799d63e7e6c7760ca077ee99_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c55237771836a09f0caa8127f2127d542df5d152 --- /dev/null +++ b/raw/rel-18/29_series/29222/fc07df3b799d63e7e6c7760ca077ee99_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:716ff75c1ed08c492de6f653da9d03c3b97c4cad4e36011ee992b01b2e2dbefa +size 13471 diff --git a/raw/rel-18/29_series/29244/raw.md b/raw/rel-18/29_series/29244/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..994cac8f8ea2083e36a62a2a0173ee8e95bf3f06 --- /dev/null +++ b/raw/rel-18/29_series/29244/raw.md @@ -0,0 +1,15588 @@ + + +# 3GPP TS 29.244 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Interface between the Control Plane and the User Plane Nodes; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------|----| +| Foreword..... | 16 | +| 1 Scope..... | 17 | +| 2 References..... | 17 | +| 3 Definitions, symbols and abbreviations..... | 20 | +| 3.1 Definitions..... | 20 | +| 3.2 Abbreviations..... | 21 | +| 4 Protocol Stack..... | 23 | +| 4.1 Introduction..... | 23 | +| 4.2 UDP Header and Port Numbers..... | 24 | +| 4.2.1 General..... | 24 | +| 4.2.2 Request Message..... | 24 | +| 4.2.3 Response Message..... | 24 | +| 4.3 IP Header and IP Addresses..... | 24 | +| 4.3.1 General..... | 24 | +| 4.3.2 Request Message..... | 24 | +| 4.3.3 Response Message..... | 25 | +| 4.4 Layer 2..... | 25 | +| 4.5 Layer 1..... | 25 | +| 5 General description..... | 25 | +| 5.1 Introduction..... | 25 | +| 5.2 Packet Forwarding Model..... | 25 | +| 5.2.1 General..... | 25 | +| 5.2.1A Packet Detection Rule Handling..... | 28 | +| 5.2.1A.1 General..... | 28 | +| 5.2.1A.2 PDI Optimization..... | 29 | +| 5.2.1A.2A Provisioning of SDF filters..... | 29 | +| 5.2.1A.3 Bidirectional SDF Filters..... | 30 | +| 5.2.1A.4 Application detection with PFD..... | 30 | +| 5.2.2 Usage Reporting Rule Handling..... | 30 | +| 5.2.2.1 General..... | 30 | +| 5.2.2.2 Provisioning of Usage Reporting Rule in the UP function..... | 31 | +| 5.2.2.2.1 General..... | 31 | +| 5.2.2.2.2 Credit pooling (for EPC)..... | 35 | +| 5.2.2.3 Reporting of Usage Report to the CP function..... | 36 | +| 5.2.2.3.1 General..... | 36 | +| 5.2.2.3.2 Credit pooling..... | 40 | +| 5.2.2.3.3 Traffic Usage Reporting with Redundant Transmission..... | 41 | +| 5.2.2.4 Reporting of Linked Usage Reports to the CP function..... | 41 | +| 5.2.2.5 End Marker Reception Reporting..... | 41 | +| 5.2.3 Forwarding Action Rule Handling..... | 42 | +| 5.2.3.1 General..... | 42 | +| 5.2.4 Buffering Action Rule Handling..... | 44 | +| 5.2.4.1 General..... | 44 | +| 5.2.4.2 Provisioning of Buffering Action Rule in the UP function..... | 44 | +| 5.2.5 QoS Enforcement Rule Handling..... | 45 | +| 5.2.5.1 General..... | 45 | +| 5.2.5.2 Provisioning of QoS Enforcement Rule in the UP function..... | 45 | +| 5.2.5.3 Reflective QoS (for 5GC)..... | 45 | +| 5.2.6 Combined SGW/PGW Architecture..... | 45 | +| 5.2.7 Multi-Access Rule Handling (for 5GC)..... | 46 | +| 5.2.7.1 General..... | 46 | +| 5.2.8 Session Reporting Rule Handling..... | 47 | +| 5.2.8.1 General..... | 47 | +| 5.2.8.2 Provisioning of Session Reporting Rule in the UP function..... | 47 | +| 5.2.8.2.1 General..... | 47 | + +| | | | +|-----------|----------------------------------------------------------------------------------------------------|----| +| 5.2.8.3 | Reporting of Session Report to the CP function..... | 48 | +| 5.2.8.3.1 | General..... | 48 | +| 5.2.9 | Handling of Rules that cannot be activated..... | 48 | +| 5.3 | Data Forwarding between the CP and UP Functions..... | 48 | +| 5.3.1 | General..... | 48 | +| 5.3.2 | Sending of End Marker Packets..... | 50 | +| 5.3.3 | Forwarding of Packets Subject to Buffering in the CP Function..... | 50 | +| 5.3.3.1 | General..... | 50 | +| 5.3.3.2 | Forwarding of Packets from the UP Function to the CP Function..... | 50 | +| 5.3.3.3 | Forwarding of Packets from the CP Function to the UP Function..... | 51 | +| 5.3.4 | Data Forwarding between the CP and UP Functions with one PFCP-u Tunnel per UP Function or PDN..... | 52 | +| 5.3.4.1 | General..... | 52 | +| 5.3.4.2 | Forwarding of Packets from the UP Function to the CP Function..... | 52 | +| 5.3.4.3 | Forwarding of Packets from the CP Function to the UP Function..... | 52 | +| 5.3.5 | Forwarding of user data using Control Plane CIoT 5GS Optimisation (for 5GC)..... | 52 | +| 5.3.5.1 | General..... | 52 | +| 5.3.5.2 | Forwarding of Packets from the UP Function to the CP Function..... | 53 | +| 5.3.5.3 | Forwarding of Packets from the CP Function to the UP Function..... | 53 | +| 5.4 | Policy and Charging Control..... | 53 | +| 5.4.1 | General..... | 53 | +| 5.4.2 | Service Detection and Bearer/GoS Flow Binding..... | 53 | +| 5.4.3 | Gating Control..... | 54 | +| 5.4.4 | QoS Control..... | 55 | +| 5.4.5 | DL Flow Level Marking for Application Detection..... | 55 | +| 5.4.6 | Usage Monitoring..... | 56 | +| 5.4.7 | Traffic Redirection..... | 56 | +| 5.4.8 | Traffic Steering..... | 57 | +| 5.4.9 | Provisioning of Predefined PCC/ADC Rules..... | 58 | +| 5.4.10 | Charging..... | 59 | +| 5.4.11 | (Un)solicited Application Reporting..... | 60 | +| 5.4.12 | Service Identification for Improved Radio Utilisation for GERAN..... | 61 | +| 5.4.13 | Transport Level Marking..... | 61 | +| 5.4.14 | Deferred PDR activation and deactivation..... | 61 | +| 5.4.15 | Packet Rate enforcement..... | 62 | +| 5.4.15.1 | General..... | 62 | +| 5.4.15.2 | Packet rate enforcement over Sxb and N4 interfaces..... | 62 | +| 5.4.15.3 | PGW and SMF behaviour..... | 63 | +| 5.4.16 | QoS differentiation for Stand-alone Non-Public Network (SNPN)..... | 64 | +| 5.4.16.1 | General..... | 64 | +| 5.4.16.2 | Access to PLMN services via SNPN..... | 64 | +| 5.4.16.3 | Access to SNPN services via PLMN..... | 64 | +| 5.4.17 | QoS differentiation for UEs behind RG..... | 65 | +| 5.5 | F-TEID Allocation and Release..... | 65 | +| 5.5.1 | General..... | 65 | +| 5.5.2 | Void..... | 65 | +| 5.5.3 | F-TEID allocation in the UP function..... | 65 | +| 5.6 | PFCP Session Handling..... | 66 | +| 5.6.1 | General..... | 66 | +| 5.6.2 | Session Endpoint Identifier Handling..... | 66 | +| 5.6.3 | Modifying the Rules of an Existing PFCP Session..... | 66 | +| 5.7 | Support of Lawful Interception..... | 66 | +| 5.7.1 | General..... | 66 | +| 5.7.2 | Lawful Interception in EPC..... | 67 | +| 5.7.3 | Lawful Interception in 5GC..... | 67 | +| 5.8 | PFCP Association..... | 67 | +| 5.8.1 | General..... | 67 | +| 5.8.2 | Behaviour with an Established PFCP Association..... | 68 | +| 5.8.3 | Behaviour without an Established PFCP Association..... | 68 | +| 5.9 | Usage of Vendor-specific IE..... | 69 | +| 5.10 | Error Indication Handling..... | 69 | + +| | | | +|-----------|------------------------------------------------------------------------------------------------|----| +| 5.11 | User plane inactivity detection and reporting..... | 69 | +| 5.11.1 | General..... | 69 | +| 5.11.2 | User plane inactivity detection and reporting per PDN connection or PDU session..... | 69 | +| 5.11.3 | User plane inactivity detection and reporting per PDR..... | 70 | +| 5.12 | Suspend and Resume Notification procedures..... | 70 | +| 5.13 | Ethernet traffic (for 5GC)..... | 71 | +| 5.13.1 | General..... | 71 | +| 5.13.2 | Address Resolution Protocol or IPv6 Neighbour Solicitation Response by SMF..... | 72 | +| 5.13.3 | Address Resolution Protocol or IPv6 Neighbour Solicitation Response by UPF..... | 72 | +| 5.13.3A | Provisioning of MAC addresses and SDF filters in Ethernet Packet Filters..... | 72 | +| 5.13.4 | Bidirectional Ethernet Filters..... | 73 | +| 5.13.5 | Reporting of UE MAC addresses to the SMF..... | 73 | +| 5.13.6 | Ethernet PDU session anchor relocation..... | 73 | +| 5.14 | Support IPv6 Prefix Delegation..... | 74 | +| 5.15 | Signalling based Trace (De)Activation..... | 74 | +| 5.16 | Framed Routing..... | 75 | +| 5.17 | 5G UPF (for 5GC)..... | 75 | +| 5.17.1 | Introduction..... | 75 | +| 5.17.2 | Uplink Classifier and Branching Point..... | 75 | +| 5.17.3 | Data forwarding during handovers between 5GS and EPS..... | 76 | +| 5.18 | Enhanced PFCP Association Release..... | 76 | +| 5.18.1 | General..... | 76 | +| 5.18.2 | UP Function Initiated PFCP Session Release..... | 77 | +| 5.19 | Activation and Deactivation of Pre-defined PDRs..... | 77 | +| 5.20 | Support of Access Traffic Steering, Switching and Splitting for 5GC..... | 78 | +| 5.20.1 | General..... | 78 | +| 5.20.2 | MPTCP functionality..... | 79 | +| 5.20.2.1 | General..... | 79 | +| 5.20.2.2 | Activate MPTCP functionality and Exchange MPTCP Parameters..... | 79 | +| 5.20.2.3 | Control of Multipath TCP Connection Establishment by MPTCP Proxy..... | 80 | +| 5.20.2.4 | Traffic Steering and IP Translation by MPTCP Proxy..... | 80 | +| 5.20.2A | MPQUIC functionality..... | 80 | +| 5.20.2A.1 | General..... | 80 | +| 5.20.2A.2 | Activate MPQUIC functionality and Exchange MPQUIC Parameters..... | 80 | +| 5.20.2A.3 | Control of Multipath QUIC Connection Establishment by MPQUIC Proxy..... | 81 | +| 5.20.2A.4 | Traffic Steering and IP Translation by MPQUIC Proxy..... | 81 | +| 5.20.3 | ATSSS-LL functionality..... | 82 | +| 5.20.3.1 | Activate ATSSS-LL functionality and Exchange ATSSS-LL Parameters..... | 82 | +| 5.20.4 | Handling of GBR traffic of a MA PDU session..... | 82 | +| 5.20.4.1 | General..... | 82 | +| 5.20.4.2 | Access Availability Reporting..... | 83 | +| 5.20.5 | Access type of an MA PDU session becoming (un)available..... | 83 | +| 5.20.6 | PMFP message handling in UPF..... | 83 | +| 5.21 | UE IP address/prefix Allocation and Release..... | 84 | +| 5.21.1 | General..... | 84 | +| 5.21.2 | UE IP address/prefix allocation in the CP function..... | 85 | +| 5.21.2.1 | General..... | 85 | +| 5.21.2.2 | UE IP Address/prefix allocation using DHCP or AAA server..... | 85 | +| 5.21.3 | UE IP address/prefix allocation in the UP function..... | 85 | +| 5.21.3.1 | General..... | 85 | +| 5.21.3.2 | Reporting UE IP Address Usage to the CP function..... | 86 | +| 5.22 | PFCP sessions successively controlled by different SMFs of an SMF set (for 5GC)..... | 87 | +| 5.22.1 | General..... | 87 | +| 5.22.2 | With one PFCP association per SMF Set and UPF..... | 87 | +| 5.22.3 | With one PFCP association per SMF and UPF..... | 88 | +| 5.22.4 | Restoration of PFCP Sessions associated with an FQ-CSID, Group ID or PGW-C/SMF IP Address..... | 90 | +| 5.23 | 5G VN Group Communication (for 5GC)..... | 90 | +| 5.23.1 | General..... | 90 | +| 5.23.2 | 5G VN group communication without N6-based forwarding..... | 91 | +| 5.24 | Support of Ultra Reliable Low Latency Communication for 5GC..... | 92 | +| 5.24.1 | General..... | 92 | + +| | | | +|-----------|-------------------------------------------------------------------------------------------------------------------------------------|-----| +| 5.24.2 | Redundant Transmission on N3/N9 interfaces..... | 92 | +| 5.24.2.1 | General..... | 92 | +| 5.24.2.2 | GTP-U tunnel setup for redundant transmission..... | 92 | +| 5.24.2.3 | Duplicating downlink packets for redundant transmission..... | 93 | +| 5.24.2.4 | Eliminating duplicated uplink packets..... | 93 | +| 5.24.3 | Redundant Transmission at transport layer..... | 93 | +| 5.24.4 | Per QoS Flow Per UE QoS Monitoring..... | 94 | +| 5.24.4.1 | General..... | 94 | +| 5.24.4.2 | QoS Monitoring Control..... | 94 | +| 5.24.4.3 | QoS Monitoring Reporting..... | 94 | +| 5.24.5 | Per GTP-U Path QoS Monitoring..... | 95 | +| 5.24.5.1 | General..... | 95 | +| 5.24.5.2 | GTP-U path monitoring..... | 95 | +| 5.24.5.3 | QoS monitoring of a PDU session based on GTP-U path monitoring..... | 96 | +| 5.24.5.4 | QoS Monitoring Reporting..... | 96 | +| 5.25 | Support of IPTV (for 5GC)..... | 97 | +| 5.26 | Support of Time Sensitive Communication, Time Synchronization, 5GS integration with TSN and Deterministic Networking (for 5GC)..... | 98 | +| 5.26.1 | General..... | 98 | +| 5.26.2 | 5GS User Plane Node management..... | 98 | +| 5.26.3 | Transfer of 5GS user plane node and port management information..... | 99 | +| 5.26.3.1 | General..... | 99 | +| 5.26.3.2 | Direct Reporting of TSC management information event to TSN AF or TSCTSF..... | 99 | +| 5.26.4 | Reporting clock drift between External and 5GS times from UPF to SMF..... | 100 | +| 5.26A | Support of TSN enabled Transport Network..... | 100 | +| 5.26A.1 | General..... | 100 | +| 5.27 | Inter-PLMN User Plane Security..... | 101 | +| 5.28 | Downlink data delivery status with UPF buffering (for 5GC)..... | 101 | +| 5.28.1 | General..... | 101 | +| 5.29 | Support Reliable Data Service..... | 102 | +| 5.30 | Notifying Start Pause of Charging..... | 102 | +| 5.31 | Support of L2TP..... | 103 | +| 5.31.1 | General..... | 103 | +| 5.31.2 | L2TP Tunnel and L2TP Session Setup..... | 104 | +| 5.31.3 | L2TP Session and L2TP Tunnel Release..... | 105 | +| 5.32 | Support of Uplink packets buffering..... | 105 | +| 5.32.1 | General..... | 105 | +| 5.32.2 | Uplink packets buffering for on-line charging..... | 105 | +| 5.32.3 | Uplink packets buffering during EAS relocation..... | 105 | +| 5.33 | Support of enhancement of Edge Computing (for 5GC)..... | 105 | +| 5.33.1 | General..... | 105 | +| 5.33.2 | Uplink packet buffering for low packet loss during EAS relocation..... | 106 | +| 5.33.3 | Edge Relocation using EAS IP address and Port number Replacement..... | 106 | +| 5.33.4 | EAS Discovery procedure with Local DNS Server/Resolver..... | 106 | +| 5.33.5 | Direct Reporting of QoS monitoring events to Local NEF or AF..... | 106 | +| 5.34 | Support of 5G Multicast and Broadcast Service..... | 107 | +| 5.34.1 | General..... | 107 | +| 5.34.2 | N4mb requirements..... | 107 | +| 5.34.2.1 | General..... | 107 | +| 5.34.2.1A | PFCP protocol extensions for N4mb..... | 107 | +| 5.34.2.2 | Instructing the MB-UPF to forward MBS data using multicast and/or unicast transport..... | 108 | +| 5.34.2.3 | Detecting and reporting user plane (in)activity of an MBS session..... | 109 | +| 5.34.2.4 | Activation and Deactivation of a Multicast MBS session..... | 109 | +| 5.34.3 | N4 requirements..... | 110 | +| 5.34.3.1 | General..... | 110 | +| 5.34.3.2 | Instructing the UPF to forward (or stop forwarding) multicast MBS data to associated PDU sessions..... | 110 | +| 5.34.3.3 | Instructing a combined UPF/MBS-UPF to forward multicast MBS data to associated PDU sessions..... | 113 | +| 5.35 | Support of Per Slice UP Resource Allocation and Usage Reporting by the UP Function..... | 113 | +| 5.35.1 | General..... | 113 | + +| | | | +|-----------|------------------------------------------------------------------------------------------------------------|-----| +| 5.36 | Paging Policy Indicator Provisioning..... | 114 | +| 5.36.1 | General..... | 114 | +| 5.36.2 | Enhanced Paging Policy Indicator Provisioning..... | 114 | +| 5.37 | Traffic Parameters Measurement per QoS flow..... | 115 | +| 5.37.1 | General..... | 115 | +| 5.37.2 | Traffic Parameter Measurement Control..... | 115 | +| 5.37.3 | Traffic Parameter Measurement Report..... | 115 | +| 5.38 | Support for high data rate low latency services, (eXtended Reality) XR and interactive media services..... | 115 | +| 5.38.0 | General..... | 115 | +| 5.38.1 | Support of ECN marking for L4S..... | 116 | +| 5.38.2 | Support of Network Exposure of 5GS information..... | 117 | +| 5.38.3 | Support of PDU Set based QoS Handling..... | 117 | +| 5.38.4 | N6 Jitter Measurement and End of Data Burst Indication..... | 118 | +| 5.38.4.1 | General..... | 118 | +| 5.38.4.2 | N6 Jitter and UL/DL Periodicity Measurement Control..... | 118 | +| 5.38.4.3 | N6 Jitter and UL/DL Periodicity Measurement Report..... | 118 | +| 5.38.4.4 | End of Data Burst Marking..... | 119 | +| 5.39 | QoS flow related QoS monitoring and reporting..... | 119 | +| 5.39.1 | General..... | 119 | +| 5.39.2 | QoS Monitoring Control..... | 119 | +| 5.39.3 | Measurable QoS parameters and specific requirements for their measurement..... | 120 | +| 5.39.3.1 | General..... | 120 | +| 5.39.3.2 | Packet delay monitoring..... | 120 | +| 5.39.3.3 | Congestion information monitoring..... | 120 | +| 5.39.3.4 | Data rate monitoring..... | 121 | +| 5.39.4 | QoS Monitoring Reporting..... | 121 | +| 6 | Procedures..... | 122 | +| 6.1 | Introduction..... | 122 | +| 6.2 | PFCP Node Related Procedures..... | 122 | +| 6.2.1 | General..... | 122 | +| 6.2.2 | Heartbeat Procedure..... | 122 | +| 6.2.2.1 | General..... | 122 | +| 6.2.2.2 | Heartbeat Request..... | 122 | +| 6.2.2.3 | Heartbeat Response..... | 122 | +| 6.2.3 | Load Control Procedure..... | 122 | +| 6.2.3.1 | General..... | 122 | +| 6.2.3.2 | Principles..... | 123 | +| 6.2.3.3 | Load Control Information..... | 123 | +| 6.2.3.3.1 | General Description..... | 123 | +| 6.2.3.3.2 | Parameters..... | 124 | +| 6.2.3.3.3 | Frequency of Inclusion..... | 124 | +| 6.2.4 | Overload Control Procedure..... | 125 | +| 6.2.4.1 | General..... | 125 | +| 6.2.4.2 | Principles..... | 125 | +| 6.2.4.3 | Overload Control Information..... | 126 | +| 6.2.4.3.1 | General Description..... | 126 | +| 6.2.4.3.2 | Parameters..... | 126 | +| 6.2.4.3.3 | Frequency of Inclusion..... | 128 | +| 6.2.4.4 | Message Throttling..... | 128 | +| 6.2.4.4.1 | General..... | 128 | +| 6.2.4.4.2 | Throttling algorithm – "Loss"..... | 129 | +| 6.2.4.5 | Message Prioritization..... | 129 | +| 6.2.4.5.1 | Description..... | 129 | +| 6.2.4.5.2 | Based on the Message Priority Signalled in the PFCP Message..... | 130 | +| 6.2.5 | PFCP PFD Management Procedure..... | 130 | +| 6.2.5.1 | General..... | 130 | +| 6.2.5.2 | CP Function Behaviour..... | 130 | +| 6.2.5.3 | UP Function Behaviour..... | 130 | +| 6.2.6 | PFCP Association Setup Procedure..... | 131 | +| 6.2.6.1 | General..... | 131 | +| 6.2.6.2 | PFCP Association Setup Initiated by the CP Function..... | 131 | + +| | | | +|-----------|---------------------------------------------------------------------|-----| +| 6.2.6.2.1 | CP Function Behaviour..... | 131 | +| 6.2.6.2.2 | UP Function behaviour..... | 132 | +| 6.2.6.3 | PFCP Association Setup Initiated by the UP Function..... | 132 | +| 6.2.6.3.1 | UP Function Behaviour..... | 132 | +| 6.2.6.3.2 | CP Function Behaviour..... | 133 | +| 6.2.7 | PFCP Association Update Procedure..... | 133 | +| 6.2.7.1 | General..... | 133 | +| 6.2.7.2 | PFCP Association Update Procedure Initiated by the CP Function..... | 133 | +| 6.2.7.2.1 | CP Function Behaviour..... | 133 | +| 6.2.7.2.2 | UP Function Behaviour..... | 133 | +| 6.2.7.3 | PFCP Association Update Procedure Initiated by UP Function..... | 134 | +| 6.2.7.3.1 | UP Function Behaviour..... | 134 | +| 6.2.7.3.2 | CP Function Behaviour..... | 134 | +| 6.2.8 | PFCP Association Release Procedure..... | 135 | +| 6.2.8.1 | General..... | 135 | +| 6.2.8.2 | CP Function Behaviour..... | 135 | +| 6.2.8.3 | UP Function behaviour..... | 135 | +| 6.2.9 | PFCP Node Report Procedure..... | 135 | +| 6.2.9.1 | General..... | 135 | +| 6.2.9.2 | UP Function Behaviour..... | 135 | +| 6.2.9.3 | CP Function behaviour..... | 135 | +| 6.3 | PFCP Session Related Procedures..... | 136 | +| 6.3.1 | General..... | 136 | +| 6.3.2 | PFCP Session Establishment Procedure..... | 136 | +| 6.3.2.1 | General..... | 136 | +| 6.3.2.2 | CP Function Behaviour..... | 136 | +| 6.3.2.3 | UP Function Behaviour..... | 136 | +| 6.3.3 | PFCP Session Modification Procedure..... | 136 | +| 6.3.3.1 | General..... | 136 | +| 6.3.3.2 | CP Function behaviour..... | 137 | +| 6.3.3.3 | UP Function Behaviour..... | 137 | +| 6.3.4 | PFCP Session Deletion Procedure..... | 137 | +| 6.3.4.1 | General..... | 137 | +| 6.3.4.2 | CP Function Behaviour..... | 137 | +| 6.3.4.3 | UP Function Behaviour..... | 138 | +| 6.3.5 | PFCP Session Report Procedure..... | 138 | +| 6.3.5.1 | General..... | 138 | +| 6.3.5.2 | UP Function Behaviour..... | 138 | +| 6.3.5.3 | CP Function Behaviour..... | 138 | +| 6.4 | Reliable Delivery of PFCP Messages..... | 138 | +| 6.5 | PFCP messages bundling..... | 139 | +| 7 | Messages and Message Formats..... | 140 | +| 7.1 | Transmission Order and Bit Definitions..... | 140 | +| 7.2 | Message Format..... | 140 | +| 7.2.1 | General..... | 140 | +| 7.2.1A | PFCP messages bundled in one UDP/IP packet..... | 140 | +| 7.2.2 | Message Header..... | 141 | +| 7.2.2.1 | General Format..... | 141 | +| 7.2.2.2 | PFCP Header for Node Related Messages..... | 141 | +| 7.2.2.3 | PFCP Header for Session Related Messages..... | 142 | +| 7.2.2.4 | Usage of the PFCP Header..... | 142 | +| 7.2.2.4.1 | General..... | 142 | +| 7.2.2.4.2 | Conditions for Sending SEID=0 in PFCP Header..... | 143 | +| 7.2.3 | Information Elements..... | 143 | +| 7.2.3.1 | General..... | 143 | +| 7.2.3.2 | Presence Requirements of Information Elements..... | 143 | +| 7.2.3.3 | Grouped Information Elements..... | 144 | +| 7.2.3.4 | Information Element Type..... | 145 | +| 7.3 | Message Types..... | 145 | +| 7.4 | PFCP Node Related Messages..... | 146 | +| 7.4.1 | General..... | 146 | + +| | | | +|-----------|-----------------------------------------------------------------------------------------|-----| +| 7.4.2 | Heartbeat Messages..... | 146 | +| 7.4.2.1 | Heartbeat Request..... | 146 | +| 7.4.2.2 | Heartbeat Response..... | 147 | +| 7.4.3 | PFCP PFD Management..... | 147 | +| 7.4.3.1 | PFCP PFD Management Request..... | 147 | +| 7.4.3.2 | PFCP PFD Management Response..... | 148 | +| 7.4.4 | PFCP Association messages..... | 149 | +| 7.4.4.1 | PFCP Association Setup Request..... | 149 | +| 7.4.4.1.1 | General..... | 149 | +| 7.4.4.1.2 | Clock Drift Control Information IE within PFCP Association Setup Request..... | 151 | +| 7.4.4.1.3 | GTP-U Path QoS Control Information IE within PFCP Association Setup Request..... | 152 | +| 7.4.4.2 | PFCP Association Setup Response..... | 154 | +| 7.4.4.3 | PFCP Association Update Request..... | 157 | +| 7.4.4.3.1 | UE IP Address Usage Information IE within PFCP Association Update Request..... | 159 | +| 7.4.4.4 | PFCP Association Update Response..... | 161 | +| 7.4.4.5 | PFCP Association Release Request..... | 161 | +| 7.4.4.6 | PFCP Association Release Response..... | 161 | +| 7.4.4.7 | PFCP Version Not Supported Response..... | 161 | +| 7.4.5 | PFCP Node Report Procedure..... | 162 | +| 7.4.5.1 | PFCP Node Report Request..... | 162 | +| 7.4.5.1.1 | General..... | 162 | +| 7.4.5.1.2 | User Plane Path Failure Report IE within PFCP Node Report Request..... | 162 | +| 7.4.5.1.3 | User Plane Path Recovery Report IE within PFCP Node Report Request..... | 163 | +| 7.4.5.1.4 | Clock Drift Report IE within PFCP Node Report Request..... | 163 | +| 7.4.5.1.5 | GTP-U Path QoS Report IE within PFCP Node Report Request..... | 163 | +| 7.4.5.1.6 | QoS Information in GTP-U Path QoS Report IE..... | 164 | +| 7.4.5.1.7 | Peer UP Restart Report IE within PFCP Node Report Request..... | 164 | +| 7.4.5.2 | PFCP Node Report Response..... | 164 | +| 7.4.5.2.1 | General..... | 164 | +| 7.4.6 | PFCP Session Set Deletion..... | 165 | +| 7.4.6.1 | PFCP Session Set Deletion Request..... | 165 | +| 7.4.6.2 | PFCP Session Set Deletion Response..... | 165 | +| 7.4.7 | PFCP Session Set Modification..... | 166 | +| 7.4.7.1 | PFCP Session Set Modification Request..... | 166 | +| 7.4.7.2 | PFCP Session Set Modification Response..... | 167 | +| 7.5 | PFCP Session Related Messages..... | 168 | +| 7.5.1 | General..... | 168 | +| 7.5.2 | PFCP Session Establishment Request..... | 168 | +| 7.5.2.1 | General..... | 168 | +| 7.5.2.2 | Create PDR IE within PFCP Session Establishment Request..... | 174 | +| 7.5.2.3 | Create FAR IE within PFCP Session Establishment Request..... | 182 | +| 7.5.2.4 | Create URR IE within PFCP Session Establishment Request..... | 188 | +| 7.5.2.5 | Create QER IE within PFCP Session Establishment Request..... | 193 | +| 7.5.2.6 | Create BAR IE within PFCP Session Establishment Request..... | 197 | +| 7.5.2.7 | Create Traffic Endpoint IE within PFCP Session Establishment Request..... | 198 | +| 7.5.2.8 | Create MAR IE within PFCP Session Establishment Request..... | 201 | +| 7.5.2.9 | Create SRR IE within PFCP Session Establishment Request..... | 203 | +| 7.5.2.10 | Provide ATSSS Control Information IE within PFCP Session Establishment Request..... | 207 | +| 7.5.2.11 | Provide RDS Configuration Information IE within PFCP Session Establishment Request..... | 208 | +| 7.5.3 | PFCP Session Establishment Response..... | 208 | +| 7.5.3.1 | General..... | 208 | +| 7.5.3.2 | Created PDR IE within PFCP Session Establishment Response..... | 211 | +| 7.5.3.3 | Load Control Information IE within PFCP Session Establishment Response..... | 212 | +| 7.5.3.4 | Overload Control Information IE within PFCP Session Establishment Response..... | 212 | +| 7.5.3.5 | Created Traffic Endpoint IE within PFCP Session Establishment Response..... | 212 | +| 7.5.3.6 | Created Bridge/Router Info IE within PFCP Session Establishment Response..... | 213 | +| 7.5.3.7 | ATSSS Control Parameters IE within PFCP Session Establishment Response..... | 213 | +| 7.5.3.8 | Void..... | 215 | +| 7.5.4 | PFCP Session Modification Request..... | 215 | +| 7.5.4.1 | General..... | 215 | +| 7.5.4.2 | Update PDR IE within PFCP Session Modification Request..... | 220 | + +| | | | +|----------|----------------------------------------------------------------------------------|-----| +| 7.5.4.3 | Update FAR IE within PFCP Session Modification Request..... | 222 | +| 7.5.4.4 | Update URR IE within PFCP Session Modification Request..... | 225 | +| 7.5.4.5 | Update QER IE within PFCP Session Modification Request..... | 229 | +| 7.5.4.6 | Remove PDR IE within PFCP Session Modification Request..... | 232 | +| 7.5.4.7 | Remove FAR IE within PFCP Session Modification Request..... | 232 | +| 7.5.4.8 | Remove URR IE within PFCP Session Modification Request..... | 233 | +| 7.5.4.9 | Remove QER IE PFCP Session Modification Request..... | 233 | +| 7.5.4.10 | Query URR IE within PFCP Session Modification Request..... | 233 | +| 7.5.4.11 | Update BAR IE within PFCP Session Modification Request..... | 233 | +| 7.5.4.12 | Remove BAR IE within PFCP Session Modification Request..... | 234 | +| 7.5.4.13 | Update Traffic Endpoint IE within PFCP Session Modification Request..... | 234 | +| 7.5.4.14 | Remove Traffic Endpoint IE within PFCP Session Modification Request..... | 236 | +| 7.5.4.15 | Remove MAR IE within PFCP Session Modification Request..... | 236 | +| 7.5.4.16 | Update MAR IE within PFCP Session Modification Request..... | 236 | +| 7.5.4.17 | Create PDR/FAR/URR/QER/BAR/MAR IEs within PFCP Session Modification Request..... | 238 | +| 7.5.4.18 | TSC Management Information IE within PFCP Session Modification Request..... | 238 | +| 7.5.4.19 | Remove SRR IE within PFCP Session Modification Request..... | 238 | +| 7.5.4.20 | Update SRR IE within PFCP Session Modification Request..... | 239 | +| 7.5.4.21 | Ethernet Context Information within PFCP Session Modification Request..... | 239 | +| 7.5.4.22 | Query Packet Rate Status IE within PFCP Session Modification Request..... | 240 | +| 7.5.5 | PFCP Session Modification Response..... | 240 | +| 7.5.5.1 | General..... | 240 | +| 7.5.5.2 | Usage Report IE within PFCP Session Modification Response..... | 243 | +| 7.5.5.3 | TSC Management Information IE within PFCP Session Modification Response..... | 244 | +| 7.5.5.4 | Packet Rate Status Report IE within PFCP Session Modification Response..... | 244 | +| 7.5.5.5 | Updated PDR IE within PFCP Session Modification Response..... | 244 | +| 7.5.6 | PFCP Session Deletion Request..... | 245 | +| 7.5.7 | PFCP Session Deletion Response..... | 245 | +| 7.5.7.1 | General..... | 245 | +| 7.5.7.2 | Usage Report IE within PFCP Session Deletion Response..... | 247 | +| 7.5.8 | PFCP Session Report Request..... | 247 | +| 7.5.8.1 | General..... | 247 | +| 7.5.8.2 | Downlink Data Report IE within PFCP Session Report Request..... | 250 | +| 7.5.8.3 | Usage Report IE within PFCP Session Report Request..... | 251 | +| 7.5.8.4 | Error Indication Report IE within PFCP Session Report Request..... | 254 | +| 7.5.8.5 | TSC Management Information IE within PFCP Session Report Request..... | 254 | +| 7.5.8.6 | Session Report IE within PFCP Session Report Request..... | 255 | +| 7.5.9 | PFCP Session Report Response..... | 256 | +| 7.5.9.1 | General..... | 256 | +| 7.5.9.2 | Update BAR IE within PFCP Session Report Response..... | 258 | +| 7.6 | Error Handling..... | 258 | +| 7.6.1 | Protocol Errors..... | 258 | +| 7.6.2 | Different PFCP Versions..... | 259 | +| 7.6.3 | PFCP Message of Invalid Length..... | 259 | +| 7.6.4 | Unknown PFCP Message..... | 259 | +| 7.6.5 | Unexpected PFCP Message..... | 259 | +| 7.6.6 | Missing Information Elements..... | 259 | +| 7.6.7 | Invalid Length Information Element..... | 260 | +| 7.6.8 | Semantically incorrect Information Element..... | 260 | +| 7.6.9 | Unknown or unexpected Information Element..... | 260 | +| 7.6.10 | Repeated Information Elements..... | 261 | +| 8 | Information Elements..... | 261 | +| 8.1 | Information Elements Format..... | 261 | +| 8.1.1 | Information Element Format..... | 261 | +| 8.1.2 | Information Element Types..... | 262 | +| 8.2 | Information Elements..... | 270 | +| 8.2.1 | Cause..... | 270 | +| 8.2.2 | Source Interface..... | 272 | +| 8.2.3 | F-TEID..... | 273 | +| 8.2.4 | Network Instance..... | 274 | +| 8.2.5 | SDF Filter..... | 274 | + +| | | | +|--------|--------------------------------------------------------------|-----| +| 8.2.6 | Application ID..... | 275 | +| 8.2.7 | Gate Status..... | 276 | +| 8.2.8 | MBR..... | 276 | +| 8.2.9 | GBR..... | 277 | +| 8.2.10 | QER Correlation ID..... | 277 | +| 8.2.11 | Precedence..... | 277 | +| 8.2.12 | Transport Level Marking..... | 278 | +| 8.2.13 | Volume Threshold..... | 278 | +| 8.2.14 | Time Threshold..... | 279 | +| 8.2.15 | Monitoring Time..... | 279 | +| 8.2.16 | Subsequent Volume Threshold..... | 279 | +| 8.2.17 | Subsequent Time Threshold..... | 280 | +| 8.2.18 | Inactivity Detection Time..... | 280 | +| 8.2.19 | Reporting Triggers..... | 280 | +| 8.2.20 | Redirect Information..... | 282 | +| 8.2.21 | Report Type..... | 283 | +| 8.2.22 | Offending IE..... | 283 | +| 8.2.23 | Forwarding Policy..... | 284 | +| 8.2.24 | Destination Interface..... | 284 | +| 8.2.25 | UP Function Features..... | 285 | +| 8.2.26 | Apply Action..... | 289 | +| 8.2.27 | Downlink Data Service Information..... | 291 | +| 8.2.28 | Downlink Data Notification Delay..... | 291 | +| 8.2.29 | DL Buffering Duration..... | 291 | +| 8.2.30 | DL Buffering Suggested Packet Count..... | 292 | +| 8.2.31 | PFCPSMReq-Flags..... | 292 | +| 8.2.32 | PFCPSRRsp-Flags..... | 293 | +| 8.2.33 | Sequence Number..... | 294 | +| 8.2.34 | Metric..... | 294 | +| 8.2.35 | Timer..... | 294 | +| 8.2.36 | Packet Detection Rule ID (PDR ID)..... | 295 | +| 8.2.37 | F-SEID..... | 295 | +| 8.2.38 | Node ID..... | 296 | +| 8.2.39 | PFD Contents..... | 296 | +| 8.2.40 | Measurement Method..... | 298 | +| 8.2.41 | Usage Report Trigger..... | 299 | +| 8.2.42 | Measurement Period..... | 300 | +| 8.2.43 | Fully qualified PDN Connection Set Identifier (FQ-CSID)..... | 301 | +| 8.2.44 | Volume Measurement..... | 302 | +| 8.2.45 | Duration Measurement..... | 302 | +| 8.2.46 | Time of First Packet..... | 303 | +| 8.2.47 | Time of Last Packet..... | 303 | +| 8.2.48 | Quota Holding Time..... | 303 | +| 8.2.49 | Dropped DL Traffic Threshold..... | 304 | +| 8.2.50 | Volume Quota..... | 304 | +| 8.2.51 | Time Quota..... | 305 | +| 8.2.52 | Start Time..... | 305 | +| 8.2.53 | End Time..... | 305 | +| 8.2.54 | URR ID..... | 306 | +| 8.2.55 | Linked URR ID IE..... | 306 | +| 8.2.56 | Outer Header Creation..... | 306 | +| 8.2.57 | BAR ID..... | 308 | +| 8.2.58 | CP Function Features..... | 308 | +| 8.2.59 | Usage Information..... | 309 | +| 8.2.60 | Application Instance ID..... | 310 | +| 8.2.61 | Flow Information..... | 310 | +| 8.2.62 | UE IP Address..... | 310 | +| 8.2.63 | Packet Rate..... | 311 | +| 8.2.64 | Outer Header Removal..... | 313 | +| 8.2.65 | Recovery Time Stamp..... | 314 | +| 8.2.66 | DL Flow Level Marking..... | 315 | + +| | | | +|---------|-------------------------------------------|-----| +| 8.2.67 | Header Enrichment..... | 315 | +| 8.2.68 | Measurement Information..... | 316 | +| 8.2.69 | Node Report Type..... | 317 | +| 8.2.70 | Remote GTP-U Peer..... | 317 | +| 8.2.71 | UR-SEQN..... | 318 | +| 8.2.72 | Activate Predefined Rules..... | 319 | +| 8.2.73 | Deactivate Predefined Rules..... | 319 | +| 8.2.74 | FAR ID..... | 319 | +| 8.2.75 | QER ID..... | 320 | +| 8.2.76 | OCI Flags..... | 320 | +| 8.2.77 | PFCP Association Release Request..... | 320 | +| 8.2.78 | Graceful Release Period..... | 321 | +| 8.2.79 | PDN Type..... | 321 | +| 8.2.80 | Failed Rule ID..... | 322 | +| 8.2.81 | Time Quota Mechanism..... | 322 | +| 8.2.82 | Void..... | 323 | +| 8.2.83 | User Plane Inactivity Timer..... | 323 | +| 8.2.84 | Multiplier..... | 323 | +| 8.2.85 | Aggregated URR ID IE..... | 324 | +| 8.2.86 | Subsequent Volume Quota..... | 324 | +| 8.2.87 | Subsequent Time Quota..... | 324 | +| 8.2.88 | RQI..... | 325 | +| 8.2.89 | QFI..... | 325 | +| 8.2.90 | Query URR Reference..... | 325 | +| 8.2.91 | Additional Usage Reports Information..... | 326 | +| 8.2.92 | Traffic Endpoint ID..... | 326 | +| 8.2.93 | MAC address..... | 326 | +| 8.2.94 | C-TAG (Customer-VLAN tag)..... | 327 | +| 8.2.95 | S-TAG (Service-VLAN tag)..... | 328 | +| 8.2.96 | Ethertype..... | 328 | +| 8.2.97 | Proxying..... | 329 | +| 8.2.98 | Ethernet Filter ID..... | 329 | +| 8.2.99 | Ethernet Filter Properties..... | 329 | +| 8.2.100 | Suggested Buffering Packets Count..... | 330 | +| 8.2.101 | User ID..... | 330 | +| 8.2.102 | Ethernet PDU Session Information..... | 331 | +| 8.2.103 | MAC Addresses Detected..... | 332 | +| 8.2.104 | MAC Addresses Removed..... | 332 | +| 8.2.105 | Ethernet Inactivity Timer..... | 333 | +| 8.2.106 | Subsequent Event Quota..... | 333 | +| 8.2.107 | Subsequent Event Threshold..... | 333 | +| 8.2.108 | Trace Information..... | 334 | +| 8.2.109 | Framed-Route..... | 334 | +| 8.2.110 | Framed-Routing..... | 334 | +| 8.2.111 | Framed-IPv6-Route..... | 335 | +| 8.2.112 | Event Quota..... | 335 | +| 8.2.113 | Event Threshold..... | 335 | +| 8.2.114 | Time Stamp..... | 336 | +| 8.2.115 | Averaging Window..... | 336 | +| 8.2.116 | Paging Policy Indicator (PPI)..... | 336 | +| 8.2.117 | APN/DNN..... | 336 | +| 8.2.118 | 3GPP Interface Type..... | 337 | +| 8.2.119 | PFCPSRReq-Flags..... | 338 | +| 8.2.120 | PFCPAUReq-Flags..... | 339 | +| 8.2.121 | Activation Time..... | 339 | +| 8.2.122 | Deactivation Time..... | 339 | +| 8.2.123 | MAR ID..... | 340 | +| 8.2.124 | Steering Functionality..... | 340 | +| 8.2.125 | Steering Mode..... | 340 | +| 8.2.126 | Weight..... | 341 | +| 8.2.127 | Priority..... | 341 | + +| | | | +|---------|------------------------------------------------------------|-----| +| 8.2.128 | UE IP address Pool Identity..... | 342 | +| 8.2.129 | Alternative SMF IP Address..... | 342 | +| 8.2.130 | Packet Replication and Detection Carry-On Information..... | 343 | +| 8.2.131 | SMF Set ID..... | 343 | +| 8.2.132 | Quota Validity Time..... | 344 | +| 8.2.133 | Number of Reports..... | 344 | +| 8.2.134 | PFCPASRsp-Flags..... | 344 | +| 8.2.135 | CP PFCP Entity IP Address..... | 345 | +| 8.2.136 | PFCPSEReq-Flags..... | 345 | +| 8.2.137 | IP Multicast Address..... | 345 | +| 8.2.138 | Source IP Address..... | 346 | +| 8.2.139 | Packet Rate Status..... | 347 | +| 8.2.140 | Create Bridge/Router Info IE..... | 348 | +| 8.2.141 | Port Number..... | 348 | +| 8.2.142 | NW-TT Port Number..... | 348 | +| 8.2.143 | 5GS User Plane Node ID..... | 349 | +| 8.2.144 | Port Management Information Container..... | 349 | +| 8.2.145 | Requested Clock Drift Information..... | 350 | +| 8.2.146 | Time Domain Number..... | 350 | +| 8.2.147 | Time Offset Threshold..... | 350 | +| 8.2.148 | Cumulative rateRatio Threshold..... | 351 | +| 8.2.149 | Time Offset Measurement..... | 351 | +| 8.2.150 | Cumulative rateRatio Measurement..... | 351 | +| 8.2.151 | SRR ID..... | 351 | +| 8.2.152 | Requested Access Availability Information..... | 352 | +| 8.2.153 | Access Availability Information..... | 352 | +| 8.2.154 | MPTCP Control Information..... | 353 | +| 8.2.155 | ATSSS-LL Control Information..... | 353 | +| 8.2.156 | PMF Control Information..... | 353 | +| 8.2.157 | MPTCP Address Information..... | 354 | +| 8.2.158 | Link-Specific Multipath IP Address..... | 355 | +| 8.2.159 | PMF Address Information..... | 355 | +| 8.2.160 | ATSSS-LL Information..... | 356 | +| 8.2.161 | Data Network Access Identifier..... | 357 | +| 8.2.162 | Average Packet Delay..... | 357 | +| 8.2.163 | Minimum Packet Delay..... | 357 | +| 8.2.164 | Maximum Packet Delay..... | 357 | +| 8.2.165 | QoS Report Trigger..... | 358 | +| 8.2.166 | GTP-U Path Interface Type..... | 358 | +| 8.2.167 | Requested Qos Monitoring..... | 358 | +| 8.2.168 | Reporting Frequency..... | 359 | +| 8.2.169 | Packet Delay Thresholds..... | 360 | +| 8.2.170 | Minimum Wait Time..... | 360 | +| 8.2.171 | QoS Monitoring Measurement..... | 361 | +| 8.2.172 | MT-EDT Control Information..... | 362 | +| 8.2.173 | DL Data Packets Size..... | 362 | +| 8.2.174 | QER Control Indications..... | 362 | +| 8.2.175 | NF Instance ID..... | 363 | +| 8.2.176 | S-NSSAI..... | 363 | +| 8.2.177 | IP version..... | 363 | +| 8.2.178 | PFCPASReq-Flags..... | 363 | +| 8.2.179 | Data Status..... | 364 | +| 8.2.180 | RDS Configuration Information..... | 364 | +| 8.2.181 | Multipath Applicable Indication..... | 365 | +| 8.2.182 | User Plane Node Management Information Container..... | 365 | +| 8.2.183 | Number of UE IP Addresses..... | 365 | +| 8.2.184 | Validity Timer..... | 366 | +| 8.2.185 | Offending IE Information..... | 366 | +| 8.2.186 | RAT Type..... | 366 | +| 8.2.187 | L2TP User Authentication..... | 367 | +| 8.2.188 | LNS Address..... | 368 | + +| | | | +|---------|-----------------------------------------------|-----| +| 8.2.189 | Tunnel Preference..... | 368 | +| 8.2.190 | Calling Number..... | 368 | +| 8.2.191 | Called Number..... | 368 | +| 8.2.192 | L2TP Session Indications..... | 369 | +| 8.2.193 | DNS Server Address..... | 369 | +| 8.2.194 | NBNS Server Address..... | 369 | +| 8.2.195 | Maximum Receive Unit..... | 370 | +| 8.2.196 | Thresholds..... | 370 | +| 8.2.197 | Steering Mode Indicator..... | 370 | +| 8.2.198 | Group Id..... | 371 | +| 8.2.199 | CP IP Address..... | 371 | +| 8.2.200 | IP Address and Port Number Replacement..... | 372 | +| 8.2.201 | DNS Query Filter..... | 372 | +| 8.2.202 | Event Notification URI..... | 373 | +| 8.2.203 | Notification Correlation ID..... | 373 | +| 8.2.204 | Reporting Flags..... | 373 | +| 8.2.205 | Predefined Rules Name..... | 374 | +| 8.2.206 | MBS Session Identifier..... | 374 | +| 8.2.207 | Multicast Transport Information..... | 375 | +| 8.2.208 | MBSN4mbReq-Flags..... | 375 | +| 8.2.209 | Local Ingress Tunnel..... | 376 | +| 8.2.210 | MBS Unicast Parameters ID..... | 377 | +| 8.2.211 | MBSN4Resp-Flags..... | 377 | +| 8.2.212 | Tunnel Password..... | 377 | +| 8.2.213 | Area Session ID..... | 378 | +| 8.2.214 | DSCP to PPI Mapping Information..... | 378 | +| 8.2.215 | PFCPSDRsp-Flags..... | 378 | +| 8.2.216 | QER Indications..... | 379 | +| 8.2.217 | Vendor-Specific Node Report Type..... | 379 | +| 8.2.218 | Configured Time Domain..... | 380 | +| 8.2.219 | Metadata..... | 380 | +| 8.2.223 | Traffic Parameter Measurement Indication..... | 382 | +| 8.2.225 | MPQUIC Control Information..... | 383 | +| 8.2.226 | MPQUIC Address Information..... | 383 | +| 8.2.227 | Transport Mode..... | 384 | +| 8.2.228 | Void..... | 384 | +| 8.2.229 | Reporting Suggestion Info..... | 384 | +| 8.2.230 | TL-Container..... | 385 | +| 8.2.231 | Measurement Indication IE..... | 385 | +| 8.2.232 | HPLMN S-NSSAI..... | 385 | +| 8.2.233 | Media Transport Protocol..... | 386 | +| 8.2.234 | RTP Header Extension Type..... | 386 | +| 8.2.235 | RTP Header Extension ID..... | 386 | +| 8.2.236 | RTP Payload Type..... | 387 | +| 8.2.237 | RTP Payload Format..... | 387 | +| A.1 | Throttling Algorithms..... | 388 | +| A.1.1 | "Loss" Throttling Algorithm..... | 388 | +| A.1.1.1 | Example of Possible Implementation..... | 388 | +| B.1 | CP Selection Function..... | 388 | +| B.1.1 | General..... | 388 | +| B.2 | UP Selection Function..... | 389 | +| B.2.1 | General..... | 389 | +| B.2.2 | SGW-U Selection Function..... | 389 | +| B.2.3 | PGW-U Selection Function..... | 389 | +| B.2.4 | Combined SGW-U/PGW-U Selection Function..... | 390 | +| B.2.5 | TDF-U selection function..... | 390 | +| B.2.6 | UP Selection Function Based on DNS..... | 391 | +| B.2.6.1 | General..... | 391 | +| B.2.6.2 | SGW-U Selection Function Based on DNS..... | 391 | +| B.2.6.3 | PGW-U Selection Function Based on DNS..... | 391 | + +| | | | +|-----------|-----------------------------------------------------------------------------|-----| +| B.2.6.4 | Combined SGW-U/PGW-U Selection Function Based on DNS..... | 391 | +| C.1 | General..... | 391 | +| C.2 | Charging Support..... | 392 | +| C.2.1 | Online Charging..... | 392 | +| C.2.1.1 | Online Charging Call Flow – Normal Scenario..... | 392 | +| C.2.1.2 | Online Charging Call Flow with Credit Pooling..... | 394 | +| C.2.1.2.1 | General..... | 394 | +| C.2.1.2.2 | Example Call Flow 1..... | 394 | +| C.2.1.2.3 | Example Call Flow 2..... | 396 | +| D.1 | General..... | 398 | +| D.2 | Procedures..... | 399 | +| D.2.1 | Addition of PSA and UL CL/BP controlled by I-SMF..... | 399 | +| D.2.2 | Removal of PSA and UL CL/BP..... | 403 | +| D.2.3 | Change of PSA..... | 403 | +| D.2.4 | Traffic Usage Reporting..... | 403 | +| D.2.5 | Updating N4 information towards I-SMF..... | 403 | +| D.2.6 | PDU session release..... | 403 | +| D.2.7 | Simultaneous change of UL CL/BP and PSA controlled by I-SMF..... | 404 | +| D.2.8 | Simultaneous change of UL CL/BP and PSA controlled by different I-SMFs..... | 407 | +| E.1 | General..... | 408 | +| E.2 | Multipath TCP Connection Setup..... | 409 | +| E.2.1 | General..... | 409 | +| E.2.2 | Outgoing Multipath TCP Connection Setup..... | 409 | +| E.2.3 | Incoming Multipath TCP Connection Setup..... | 409 | +| E.2.4 | MPTCP Session Entry Stored in MPTCP Proxy..... | 409 | +| E.3 | IP Translation Procedure..... | 410 | +| E.3.1 | General..... | 410 | +| E.3.2 | IP Translation on Uplink IP Packets..... | 410 | +| E.3.3 | IP Translation on Downlink IP Packets..... | 411 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document +- might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the Packet Forwarding Control Protocol (PFCP) used on the interface between the control plane and the user plane function. + +PFCP shall be used over: + +- the Sxa, Sxb, Sxc and the combined Sxa/Sxb reference points specified in 3GPP TS 23.214 [2]. +- the Sxa' and Sxb' reference points specified in 3GPP TS 33.107 [20]. In the rest of this specification, no difference is made between Sxa and Sxa', or between Sxb and Sxb'. The Sxa' and Sxb' reference points reuse the protocol specified for the Sxa and Sxb reference points, but comply in addition with the security requirements specified in clause 8 of 3GPP 33.107 [20]. +- the N4 interface specified in 3GPP TS 23.501 [28] and 3GPP TS 23.502 [29]. +- the N4mb interface specified in 3GPP TS 23.247 [72]. + +In this specification the term CP function applies to control plane nodes such as SGW-C, PGW-C, TDF-C, SMF and MB-SMF. + +In this specification the term UP function applies to user plane nodes such as SGW-U, PGW-U, TDF-U, UPF and MB-UPF. + +The prefix PFCP in message and procedure names is used to indicate that messages and procedures are common and used on Sx, N4 and N4mb reference points. A PFCP session refers to both Sx and/or N4 sessions, or to an N4mb session. A PFCP association is established between a CP function and a UP function, i.e., for EPC, between an SGW-C/PGW-C/TDF-C and an SGW-U/PGW-U/TDF-U, and for 5GC, between an SMF and a UPF or between an MB-SMF and MB-UPF. + +In the related stage 2 specifications the prefix Sx, N4 and N4mb is used for these common procedures realised by PFCP. + +Clauses or paragraphs that only apply to EPC or 5GC are indicated by the label "for EPC" or "for 5GC". + +--- + +## 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.214: "Architecture enhancements for control and user plane separation of EPC nodes; Stage 2". +- [3] 3GPP TS 29.281: "General Packet Radio System (GPRS) Tunnelling Protocol User Plane (GTPv1-U)". + +- [4] IETF RFC 768: "User Datagram Protocol". +- [5] IETF RFC 791: "Internet Protocol". +- [6] IETF RFC 2460: "Internet Protocol, Version 6 (IPv6) Specification". +- [7] 3GPP TS 23.203: "Policy and charging control architecture; Stage 2". +- [8] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [9] 3GPP TS 29.274: "3GPP Evolved Packet System. Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [10] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [11] 3GPP TS 29.213: "Policy and Charging Control signalling flows and Quality of Service (QoS) parameter mapping". +- [12] IETF RFC 5905: "Network Time Protocol Version 4: Protocol and Algorithms Specification". +- [13] IETF RFC 2474: "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [14] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [15] 3GPP TS 22.153: "Multimedia Priority Service". +- [16] IETF RFC 4006: "Diameter Credit Control Application". +- [17] 3GPP TS 32.251: "Telecommunication management; Charging management; Packet Switched (PS) domain charging". +- [18] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging application". +- [19] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [20] 3GPP TS 33.107: "3G security; Lawful interception architecture and functions". +- [21] 3GPP TS 29.251: "Gw and Gwn reference points for sponsored data connectivity". +- [22] IETF RFC 2474, "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [23] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing". +- [24] 3GPP TS 23.007: "Restoration procedures". +- [25] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3" +- [26] IETF RFC 5905: "Network Time Protocol Version 4: Protocol and Algorithms Specification". +- [27] IETF RFC 1035: "Domain Names - Implementation and Specification". +- [28] 3GPP TS 23.501:"System Architecture for the 5G System" +- [29] 3GPP TS 23.502:"Procedures for the 5G System" +- [30] IEEE 802.1Q: "Virtual Bridged Local Area Networks" +- [31] IEEE 802.3: "IEEE Standard for Ethernet" +- [32] IETF RFC 826: "An Ethernet Address Resolution Protocol or Converting Network Protocol Addresses". +- [33] IETF RFC 4861: "Neighbor Discovery for IP version 6 (IPv6)". . + +- [34] 3GPP TS 38.415: "NG-RAN; PDU Session User Plane Protocol". +- [35] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [36] IETF RFC 4282: "The Network Access Identifier". +- [37] IETF RFC 2865: "Remote Authentication Dial In User Service (RADIUS)". +- [38] IETF RFC 3162: "RADIUS and IPv6". +- [39] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [40] 3GPP TS 23.527: "5G System; Restoration procedures". +- [41] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [42] 3GPP TS 38.300: "NR; NR and NG-RAN Overall Description; Stage 2". +- [43] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [44] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System". +- [45] 3GPP TS 32.255: "Telecommunication management; Charging management; 5G data connectivity domain charging; Stage 2". +- [46] 3GPP TS 29.512: "Session Management Policy Control Service, Stage 3". +- [47] 3GPP TS 33.127: "Security; Lawful Interception (LI) architecture and functions". +- [48] 3GPP TS 23.003: "Numbering, addressing and identification". +- [49] 3GPP TS 29.561: "5G System; Interworking between 5G Network and external Data Networks; Stage 3". +- [50] 3GPP TS 29.502: "5G System, Session Management Services; Stage 3". +- [51] Void +- [52] IETF RFC 2236: "Internet Group Management Protocol, Version 2". +- [53] IETF RFC 3376: "Internet Group Management Protocol, Version 3". +- [54] IETF RFC 4604: "Using Internet Group Management Protocol Version 3 (IGMPv3) and Multicast Listener Discovery Protocol Version 2 (MLDv2) for Source-Specific Multicast". +- [55] IETF RFC 2710: "Multicast Listener Discovery (MLD) for IPv6". +- [56] Void +- [57] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [58] IEEE Std 802.1AS-2020: "IEEE Standard for Local and metropolitan area networks--Timing and Synchronization for Time-Sensitive Applications". +- [59] 3GPP TS 24.193: "Access Traffic Steering, Switching and Splitting; Stage 3". +- [60] IETF RFC 8803: "0-RTT TCP Convert Protocol". +- [61] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [62] IETF RFC 8684: "TCP Extensions for Multipath Operation with Multiple Addresses". +- [63] 3GPP TS 24.539: "5G System (5GS); Network to TSN translator (TT) protocol aspects; Stage 3". +- [64] 3GPP TS 33.501: "Security architecture and procedures for 5G system". + +- [65] 3GPP TS 24.250: "Protocol for Reliable Data Service; Stage 3". +- [66] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [67] IETF RFC 2661: Layer Two Tunneling Protocol "L2TP" +- [68] IETF RFC 2868: RADIUS Attributes for Tunnel Protocol Support +- [69] 3GPP TS 23.548: "5G System Enhancements for Edge Computing; Stage 2". +- [70] Void +- [71] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [72] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services; Stage 2". +- [73] 3GPP TS 29.564: "5G System; User Plane Function Services; Stage 3". +- [74] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [75] IETF RFC 4122: "A Universally Unique Identifier (UUID) URN Namespace". +- [76] IETF RFC 9000: "QUIC: A UDP-Based Multiplexed and Secure Transport". +- [77] IETF RFC 9114: "Hypertext Transfer Protocol Version 3 (HTTP/3)". +- [78] IETF RFC 9298: "Proxying UDP in HTTP". +- [79] 3GPP TS 26.522: "5G Real-time Media Transport Protocol Configurations". +- [80] 3GPP TS 29.585: "5G System (5GS); Session Management Function (SMF) / Centralized User Configuration (CUC) to Access Network Talker Listener (AN-TL) and Core Network Talker Listener (CN-TL) protocol aspects; Stage 3". +- [81] IETF RFC 9331: "Explicit Congestion Notification (ECN) Protocol for Very Low Queuing Delay (L4S)". +- [82] IETF RFC 3550: "RTP: A Transport Protocol for Real-Time Applications". +- [83] IETF RFC 3711: The Secure Real-time Transport Protocol (SRTP) +- [84] IETF RFC 6184: "RTP Payload Format for H.264 Video" +- [85] IETF RFC 7798: "RTP Payload Format for High Efficiency Video Coding (HEVC)" +- [86] IETF RFC 8285: "A General Mechanism for RTP Header Extensions". + +--- + +## 3 Definitions, symbols and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Associated PDU Session:** A PDU Session associated to a multicast session that is used for 5GC Individual MBS traffic delivery method and for signalling related to a user's participation in a multicast session such as join and leave requests. + +**Associated QoS Flow:** A unicast QoS Flow that belongs to the associated PDU Session and is used for 5GC Individual MBS traffic delivery method. The associated QoS Flow is mapped from a multicast QoS Flow in a multicast MBS session. + +**Common Tunnel EndPoint Identifier (C-TEID):** See definition in clause 3.1 of 3GPP TS 29.281 [3]. It is used for the delivery of user plane traffic using multicast transport via a common GTP-U tunnel to NG-RAN nodes over N3mb and/or to UPFs over N19mb. + +**CP function:** A node with a Control Plane function (see 3GPP TS 23.214 [2]) supporting one or more PFCP entities. A Control Plane function, i.e. a Control Plane Node, is identified by the Node ID that is set to either an FQDN or an IP address. + +**Low Layer Source Specific Multicast address (LLSSM):** It is used to deliver user plane traffic using multicast transport to NG-RAN nodes over N3mb and/or to UPFs over N19mb. The destination multicast IP address identifies the multicast group, while the related unicast source IP address identifies the source of the multicast traffic (MB-UPF). The MB-UPF sets the outer header of the DL UP packets with the respective source IP address and destination multicast IP address. + +**Match Field:** a field of the Packet Detection Information of a Packet Detection Rule against which a packet is attempted to be matched. + +**Matching:** comparing the set of header fields of a packet to the match fields of the Packet Detection Information of a Packet Detection Rule. + +**MBS ingress address:** It is used for the delivery of DL MBS UP traffic using unicast transport to the MB-UPF over N6mb or Nmb9 interface. The MBS ingress address identifies the MB-UPF's unicast IP address and port number for receiving DL data. + +**Multicast transport:** the delivery of user plane traffic by IP multicast transport, as opposed to IP unicast transport. Multicast transport is supported over N3mb, N19mb and N6mb interfaces, but is not supported over Nmb9. + +**Node:** Either a CP function or an UP function supporting one or more PFCP entities. A Node is identified by the Node ID, which is set to either an FQDN or an IP address. + +**PFCP Entity:** An endpoint in a CP (or UP) function supporting PFCP, that is identified by the IP address. The IP address of a PFCP entity may or may not be the IP address included in the Node ID. + +**Source Specific Multicast address (SSM):** It is used to deliver user plane traffic using multicast transport. The destination multicast IP address identifies the multicast group, while the related unicast source IP address identifies the source of the multicast data (e.g. AF/AS or MBSTF). + +**Unicast transport:** the delivery of user plane traffic by IP unicast transport, as opposed to IP multicast transport. For MBS, unicast transport is supported over N3mb, N19mb, N6mb and Nmb9 interfaces. + +**UP function:** A node with a User Plane function (see 3GPP TS 23.214 [2]) supporting one or more PFCP entities. A User Plane function, i.e. a User Plane Node, is identified by the Node ID that is set to either a FQDN or an IP address. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|---------------------------------------------------------------| +| 5MBS | 5G Multicast-Broadcast Service | +| ADC | Application Detection and Control | +| ATSSS | Access Traffic Steering, Switching, Splitting | +| ATSSS-LL | ATSSS Low Layer | +| BAR | Buffering Action Rule | +| BP | Branching Point | +| CN-TL | Core Network Talker Listener function | +| CP | Control Plane | +| CUC | Centralized User Configuration | +| DDDS | Downlink Data Delivery Status notification with UPF buffering | +| DDoS | Distributed Denial of Service | +| DEI | Drop Eligible Indicator | +| DetNet | Deterministic Networking | +| DNAI | Data Network Access Identifier | + +| | | +|--------|-------------------------------------------------------| +| DSCP | Differentiated Services Code Point | +| DS-TT | Device-Side TSN Translator | +| eMPS | enhanced Multimedia Priority Service | +| FAR | Forwarding Action Rule | +| F-SEID | Fully Qualified SEID | +| F-TEID | Fully Qualified TEID | +| IP | Internet Protocol | +| IPUPS | Inter-PLMN User Plane Security | +| IPv4 | Internet Protocol version 4 | +| IPv6 | Internet Protocol version 6 | +| I-SMF | Intermediate SMF | +| L2TP | Layer 2 Tunneling Protocol | +| L4S | Low Latency, Low Loss and Scalable Throughput | +| LAC | L2TP Access Concentrator | +| LMISF | LI Mirror IMS State Function | +| LNS | L2TP Network Server | +| MA | Multi-Access | +| MA | Multi-Access | +| MAR | Multi-Access Rule | +| MBS | Multicast/Broadcast Service | +| MB-SMF | Multicast/Broadcast Session Management Function | +| MB-UPF | Multicast/Broadcast User Plane Function | +| MBSF | Multicast/Broadcast Service Function | +| MBSTF | Multicast/Broadcast Service Transport Function | +| MPQUIC | Multi-Path QUIC | +| MPTCP | Multi-Path TCP Protocol | +| MT-EDT | Mobile Terminated Early Data TransmissionNR New Radio | +| NPN | Non-Public Network | +| NW-TT | Network-side TSN Translator | +| PCC | Policy and Charging Control | +| PCP | Priority Code Point | +| PCEF | Policy and Charging Enforcement Function | +| PCRF | Policy and Charging Rule Function | +| PDI | Packet Detection Information | +| PDR | Packet Detection Rule | +| PFCP | Packet Forwarding Control Protocol | +| PFD | Packet Flow Description | +| PGW | PDN Gateway | +| PGW-C | PDN Gateway Control plane function | +| PGW-U | PDN Gateway User plane function | +| PIN | Personal IoT Network | +| PLR | Packet Loss Rate | +| PMF | Performance Measurement Function | +| PMIC | Port Management Information Container | +| PSA | PDU Session Anchor | +| PTP | Precision Time Protocol | +| QER | QoS Enforcement Rule | +| RDS | Reliable Data Service | +| RTT | Round Trip Time | +| S8HR | S8 Home Routed | +| SDF | Service Data Flow | +| SEID | Session Endpoint Identifier | +| SGW | Serving Gateway | +| SGW-C | Serving Gateway Control plane function | +| SGW-U | Serving Gateway User plane function | +| SMF | Session Management Function | +| SNPN | Stand-alone Non-Public Network | +| SRR | Session Reporting Rule | +| SX3LIF | Split X3 LI Interworking Function | +| TDF | Traffic Detection Function | +| TDF-C | Traffic Detection Function Control plane function | + +| | | +|--------|----------------------------------------------------------------| +| TDF-U | Traffic Detection Function User plane function | +| TL | Talker Listener | +| TMGI | Temporary Mobile Group Identity | +| TN | Transport Network | +| ToS | Type of Service | +| TSC | Time Sensitive Communication | +| TSCTS | Time Sensitive Communication and Time Synchronization | +| TSCTSF | Time Sensitive Communication and Time Synchronization function | +| TSN | Time Sensitive Networking | +| TSSF | Traffic Steering Support Function | +| UDP | User Datagram Protocol | +| UL CL | Uplink Classifier | +| UMIC | User Plane Node Management Information Container | +| UP | User Plane | +| UPF | User Plane Function | +| URR | Usage Reporting Rule | +| VID | VLAN Identifier | + +## 4 Protocol Stack + +### 4.1 Introduction + +The protocol stack for the control plane over the Sxa, Sxb, Sxc, combined Sxa/Sxb, N4 and N4mb reference points shall be as depicted in Figure 4.1-1. Clauses 4.2 and 4.3 further specify the related UDP and IP requirements. + +![Diagram of the Control Plane stack over Sxa, Sxb, Sxc, combined Sxa/Sxb, N4 and N4mb reference points. The diagram shows two identical protocol stacks separated by a dashed vertical line representing the reference point. The left stack is labeled 'CP function' and the right stack is labeled 'UP function'. Both stacks consist of five layers: PFCP, UDP, IP, L2, and L1. The layers are connected by horizontal lines, and the entire stack is enclosed in a rectangular box. The reference point is labeled 'Sx, N4 and N4mb reference point' at the bottom center.](86b4670fc1a5a694821ee92b99c1209a_img.jpg) + +Diagram of the Control Plane stack over Sxa, Sxb, Sxc, combined Sxa/Sxb, N4 and N4mb reference points. The diagram shows two identical protocol stacks separated by a dashed vertical line representing the reference point. The left stack is labeled 'CP function' and the right stack is labeled 'UP function'. Both stacks consist of five layers: PFCP, UDP, IP, L2, and L1. The layers are connected by horizontal lines, and the entire stack is enclosed in a rectangular box. The reference point is labeled 'Sx, N4 and N4mb reference point' at the bottom center. + +**Figure 4.1-1: Control Plane stack over Sxa, Sxb, Sxc, combined Sxa/Sxb, N4 and N4mb** + +The protocol stack for the user plane over the Sxa, Sxb and N4 reference points (see clause 5.3) shall be as depicted in Figure 4.1-2. 3GPP TS 29.281 [3] further specifies the related GTP-U, UDP and IP requirements. Both IPv4 and IPv6 shall be supported. + +![Diagram of User Plane stack over Sx, Sxb, combined Sxa/Sxb and N4 reference points. The diagram shows two protocol stacks separated by a dashed vertical line. The left stack is labeled 'CP function' and the right stack is labeled 'UP function'. Both stacks consist of five layers: GTP-U, UDP, IP, L2, and L1. The layers are connected by horizontal lines, and the entire diagram is enclosed in a rectangular box labeled 'Sx and N4 reference point' at the bottom.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +Diagram of User Plane stack over Sx, Sxb, combined Sxa/Sxb and N4 reference points. The diagram shows two protocol stacks separated by a dashed vertical line. The left stack is labeled 'CP function' and the right stack is labeled 'UP function'. Both stacks consist of five layers: GTP-U, UDP, IP, L2, and L1. The layers are connected by horizontal lines, and the entire diagram is enclosed in a rectangular box labeled 'Sx and N4 reference point' at the bottom. + +Figure 4.1-2: User Plane stack over Sxa, Sxb, combined Sxa/Sxb and N4 + +## 4.2 UDP Header and Port Numbers + +### 4.2.1 General + +A User Datagram Protocol (UDP) compliant with IETF RFC 768 [4] shall be used. + +### 4.2.2 Request Message + +The UDP Destination Port number for a Request message shall be 8805. It is the registered port number for PFCP. + +The UDP Source Port for a Request message is a locally allocated port number at the sending entity. + +NOTE: The locally allocated source port number can be reused for multiple Request messages. + +### 4.2.3 Response Message + +The UDP Destination Port value of a Response message shall be the value of the UDP Source Port of the corresponding Request message. + +The UDP Source Port of a Response message shall be the value from the UDP Destination Port of the corresponding message. + +## 4.3 IP Header and IP Addresses + +### 4.3.1 General + +In this clause, "IP" refers either to IPv4 as defined by IETF RFC 791 [5] or IPv6 as defined by IETF RFC 2460 [6]. A PFCP entity shall support both IPv4 and IPv6. + +### 4.3.2 Request Message + +The IP Destination Address of a Request message shall be an IP address of the peer entity. + +During the establishment of a PFCP Session, the CP and the UP functions select and communicate to each other the IP Destination Address at which they expect to receive subsequent Request messages related to that PFCP Session. The CP and the UP functions may change this IP address subsequently during a PFCP Session Modification procedure. + +The IP Source Address of a Request message shall be an IP address of the sending entity. + +### 4.3.3 Response Message + +The IP Destination Address of a Response message shall be copied from the IP Source Address of the corresponding Request message. + +The IP Source Address of a Response message shall be copied from the IP destination address of the corresponding Request message. + +## 4.4 Layer 2 + +Typically Ethernet should be used as a Layer 2 protocol, but operators may use any other technology. + +## 4.5 Layer 1 + +Operators may use any appropriate Layer 1 technology. + +--- + +# 5 General description + +## 5.1 Introduction + +The architecture reference model with Control and User Plane Separation of EPC nodes is described in clause 4.2 of 3GPP TS 23.214 [2]. + +The architecture reference model with SMF and UPF of 5GC nodes is described in clause 4.2 of 3GPP TS 23.501 [28]. + +The architecture reference model with MB-SMF and MB-UPF of 5GC nodes is described in clause 6.7 of 3GPP TS 23.247 [72]. + +This clause specifies the high level principles of the PFCP protocol and describe how 3GPP functionalities are realised on the Sxa, Sxb, Sxc, N4 and N4mb reference points, e.g. Packet Forwarding, Policy and Charging Control, Lawful Interception. + +## 5.2 Packet Forwarding Model + +### 5.2.1 General + +The packet forwarding scenarios supported over the Sxa, Sxb and Sxc reference points are specified in 3GPP TS 23.214 [2]. + +The packet forwarding scenarios supported over the N4 reference point are specified in 3GPP TS 23.501 [28] and 3GPP TS 23.502 [29]. + +The packet forwarding scenarios supported over the N4mb reference point are specified in 3GPP TS 23.247 [72]. + +The CP function controls the packet processing in the UP function by establishing, modifying or deleting PFCP Session contexts and by provisioning (i.e. adding, modifying or deleting) PDRs, FARs, QERs, URRs, BAR and/or MAR or by activating/deactivating pre-defined PDRs, FARs, QERs, URRs, per PFCP session context, whereby a PFCP session context may correspond: + +- for EPC, to an individual PDN connection, a TDF session, or a standalone session not tied to any PDN connection or TDF session used e.g. for forwarding Radius, Diameter or DHCP signalling between the PGW-C and the PDN. +- for 5GC, to an individual PDU session, a standalone PFCP session not tied to any PDU session or an MBS session. + +Each PDR shall contain a PDI, i.e. one or more match fields against which incoming packets are matched, and may be associated to the following rules providing the set of instructions to apply to packets matching the PDI: + +- one or more FARs, which contains instructions related to the processing of the packets as follows: + - an Apply Action parameter, which indicates whether the UP function shall: + - forward, duplicate, drop or buffer the packet with or without notifying the CP function about the arrival of a DL packet; + - accept or deny UE requests to join an IP multicast group; + - forward, duplicate, drop or buffer the UL packet; or + - forward the MBS session data to a Low Layer Source Specific Multicast (LL SSM) address (using multicast transport) and/or forward and replicate the MBS session data to multiple GTP-u peers (using unicast transport). + - forwarding, buffering and/or duplicating parameters, which the UP function shall use if the Apply Action parameter requests the packets to be forwarded, buffered or duplicated respectively. These parameters may remain configured in the FAR regardless of the Apply Action parameter value, to minimize the changes to the FAR during the transitions of the UE between the idle and connected modes. The buffering parameters, when present, shall be provisioned in a BAR created at the PFCP session level and referenced by the FAR. + +NOTE 1: Buffering refers here to the buffering of the packet in the UP function. The UP function is instructed to forward DL packets to the CP function when applying buffering in the CP function. See clause 5.3.1. + +- zero, one or more QERs, which contains instructions related to the QoS enforcement of the traffic; +- zero, one or more URRs, which contains instructions related to traffic measurement and reporting. +- zero or one MAR, which contains instructions related to Access Traffic Steering, Switching and Splitting (ATSSS) for the downlink traffic of a Multi-Access (MA) PDU session. See clause 5.2.7. + +NOTE 2: A downlink PDR can be associated with two FARs for an N4 session established for an MA PDU session as an MAR contains two FARs for 3GPP and non-3GPP respectively. + +A FAR, a QER, an URR and an MAR shall only be associated to one or multiple PDRs of the same PFCP session context. + +The QoS Enforcement Rule Correlation ID shall be assigned by the CP function to correlate QERs from multiple PFCP session contexts. For instance, the enforcement of APN-AMBR in the PGW-U shall be achieved by setting the same QoS Enforcement Rule Correlation ID to the QERs from different PFCP sessions associated with all the PDRs corresponding to the non-GBR bearers of all the UE's PDN connections to the same APN. The QERs that are associated to the same QoS Enforcement Rule Correlation ID in multiple PFCP sessions shall be provisioned, with the same QER contents, in each of these PFCP sessions. The QoS Enforcement Rule Correlation ID shall be only used to enforce the APN-AMBR when the UE is in EPC, it may be provided by the CP function over N4 to the UP function for a PDU session may move to EPC in a later stage. + +The following principles shall apply for the provisioning of PDRs in the UP function: + +- Every PDR provisioned for a PFCP session shall allow to identify the PFCP session, i.e. every PDR shall contain the information element(s) to identify the PFCP session, which is either a Traffic Endpoint Identifier (if the PDI Optimization feature is supported) or equivalent information, e.g. UE IP address, Local F-TEID, Framed-Route, in the PDI IE. +- The CP function shall not provision more than one PDR with the same match fields in the PDI (i.e. with the same set of match fields and with the same value). The CP function may provision PDRs with the same value for a subset of the match fields of the PDI but not all; +- different PDRs of a same PFCP session may overlap, e.g. the CP function may provision two PDRs which differ by having one match field set to a specific value in one PDR and the same match field not included in the other PDR (thus matching any possible value); + +- different PDRs of different PFCP sessions, not including the Packet Replication and Detection Carry-On Information IE, shall not overlap, i.e. PDRs in each PFCP session shall differ by at least one different (and not wildcarded) match field in their PDI, such that any incoming user plane packet may only match PDRs of a single PFCP session; +- As an exception to the previous principle, the CP function may provision a PDR with all match fields wildcarded (i.e. all match fields omitted in the PDI) in a separate PFCP session, to control how the UP function shall process packets unmatched by any PDRs of any other PFCP session. The CP function may provision the UP function to send these packets to the CP function or to drop them. The UP function shall grant the lowest precedence to this PDR. +- different PDRs of different PFCP sessions, including the Packet Replication and Detection Carry-On Information IE, may overlap. The Detection Carry-On Indication indicates that the UP function shall proceed with the look-up of other PDRs of other PFCP sessions matching the packet. This is used for broadcast traffic forwarding in 5G VN Group Communication. +- different downlink PDRs of different PFCP sessions, with a PDI including the IP multicast IP address IE, may overlap. The UP function shall proceed with the look-up of other PDRs of other PFCP sessions matching the packet. This is used for downlink IP multicast traffic for IPTV service (see clause 5.25). +- different downlink PDRs of different PFCP sessions, with a PDI including the MBS Session Identifier, may overlap. The UPF shall proceed with the look-up of other PDRs of other PFCP sessions with the same MBS Session Identifier matching the packets. This is used for multicast MBS services in 5GS using 5GC Individual Traffic Delivery (see clause 5.34). + +On receipt of a user plane packet, the UP function shall perform a lookup of the provisioned PDRs in the UP function to identify only one PDR in a PFCP session according to the following steps: + +- identify first the PFCP session to which the packet corresponds; and +- find the first PDR matching the incoming packet, among all the PDRs provisioned for this PFCP session, starting with the PDRs with the highest precedence and continuing then with PDRs in decreasing order of precedence. Only the highest precedence PDR matching the packet shall be selected, i.e. the UP function shall stop the PDRs lookup once a matching PDR is found. + +A packet matches a PDR if all the match fields which are identified with different IE type in the PDI of the PDR are matching the corresponding packet header fields unless specified otherwise. If a match field is not included in the PDI, it shall be considered as matching all possible values in the header field of the packet. If the match field is present and does not include a mask, the match field shall be considered as matching the corresponding header field of the packet if it has the same value. If the match field is present and includes a mask (e.g. IP address with a prefix mask), the match field shall be considered as matching the corresponding header field of the packet if it has the same value for the bits which are set in the mask. If a match field has multiple instances, i.e. there are several IEs with the same IE type, a packet matches this match field if any instance is matching the corresponding packet header field. + +The match fields of the PDI shall correspond to outer and/or inner packet header fields, e.g. uplink bearer binding verification in the PGW-U may be achieved by configuring a PDR with the PDI containing the local GTP-U F-TEID (for outer IP packet matching) and the SDF filters of the data flows mapped to the bearer (for inner IP packet matching). + +NOTE 3: A DL PDR can be provisioned with a UE IP address together with a Framed-Route or a Framed-IPv6-Route either in the PDI IE or in the Create Traffic Endpoint IE; in such case, the PDR is matched if the packet matches either the UE IP address or the Framed-Route (Framed-IPv6-Route). + +When one or more pre-defined PDR(s) are activated for a given PDR (see clause 5.19), an incoming packet matches the PDR if it matches one of activated pre-defined PDR(s). + +The UP function should drop packets unmatched by any PDRs. + +The packet processing flow in the UP function is illustrated in Figure 5.2.1-1. + +![Figure 5.2.1-1: Packet processing flow in the UP function. The diagram shows a flow from 'Packet In' on the left to 'Packet Out' on the right. The process starts with 'PFCP Session look up (find PFCP session with a matching PDR)'. This leads to 'PFCP session's PDR look up (find matching PDR of the PFCP session with highest precedence)'. From there, it points to a vertical stack of 'PDR' boxes, with an arrow pointing to the third one. Below the stack is an ellipsis. An arrow from the third 'PDR' box points to a horizontal row of four dashed boxes labeled 'MARs', 'FARs', 'QERs', and 'URRs'. Below this row is a box labeled 'Apply Instructions set in the matching PDR'. Finally, an arrow points from the 'Apply Instructions set in the matching PDR' box to 'Packet Out' on the right.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +Figure 5.2.1-1: Packet processing flow in the UP function. The diagram shows a flow from 'Packet In' on the left to 'Packet Out' on the right. The process starts with 'PFCP Session look up (find PFCP session with a matching PDR)'. This leads to 'PFCP session's PDR look up (find matching PDR of the PFCP session with highest precedence)'. From there, it points to a vertical stack of 'PDR' boxes, with an arrow pointing to the third one. Below the stack is an ellipsis. An arrow from the third 'PDR' box points to a horizontal row of four dashed boxes labeled 'MARs', 'FARs', 'QERs', and 'URRs'. Below this row is a box labeled 'Apply Instructions set in the matching PDR'. Finally, an arrow points from the 'Apply Instructions set in the matching PDR' box to 'Packet Out' on the right. + +**Figure 5.2.1-1: Packet processing flow in the UP function** + +At the deletion of a PFCP session, the UP function shall delete the PFCP session context and all the associated non-preconfigured rules. + +NOTE 4: Deleting a QER in one PFCP session does not result in deleting another QER in another PFCP session even when these two QERs have the same QER ID and/or are associated with the same QER Correlation ID. + +A UP Function controlled by multiple CP functions shall handle Rule IDs from the different CP functions independently from each other. + +Rule ID used for PDR, FAR, BAR, QER, URR or MAR is uniquely identifying a rule of the corresponding rule type within a session. + +For an MA-PDU session, IP addresses translation for MPTCP traffic (see Annex E.3) is independent from the handling of URR/QER/BAR, but it shall be performed before applying the FAR (e.g. before creating the outer header and forwarding the packet). + +## 5.2.1A Packet Detection Rule Handling + +### 5.2.1A.1 General + +When provisioning a PDR in the UP function, the CP function shall provide the PDI with the following information: + +- the source interface of the incoming packets; +- a combination of the parameters, that incoming packets are requested to match, among: Local F-TEID, Network Instance, UE IP address(es), SDF Filter(s) and/or Application ID. For 5GC, the PDI may additionally contain one or more QFI(s) to detect traffic pertaining to specific QoS flow(s), Ethernet Packet Filter(s), Ethernet PDU Session Information (see clause 5.13.1) and/or DNS Query Filter(s). + +The requirements for provisioning an SDF filter in the PDI are specified in clauses 5.2.1A.2A and 5.2.1A.3. + +The CP function may provision the parameters, that incoming packets are requested to match, in the UP function by: + +- providing the parameters individually in each PDI of the PFCP session; or +- optionally, if the PDI Optimization feature is supported by the UP function, by providing the parameters which may be common to multiple PDIs of a same PFCP session in a Traffic Endpoint IE and by referencing this Traffic Endpoint in the PDI(s) of the PFCP session. See clause 5.2.1A.2. A Traffic Endpoint may include a Local F-TEID, Network Instance, UE IP address(es) and/or Ethernet PDU Session Information (see clause 5.13.1). + +NOTE: A Traffic Endpoint can correspond to a GTP-u endpoint, an SGi or an N6 endpoint. + +### 5.2.1A.2 PDI Optimization + +The PDI Optimization feature should be supported by CP and UP functions complying with this release of the specification. This feature allows the CP function to optimize the signaling towards the UP function by creating the information that are common to multiple PDRs as a Traffic Endpoint with a Traffic Endpoint ID and then referring to this common information from multiple PDRs. The Traffic Endpoint ID shall be unique within a PFCP session. If MTE feature is supported, one PDI may refer to more than one Traffic Endpoints. When a PDI refers to a Traffic Endpoint, the parameters that are in the Traffic Endpoint shall not be once again provided in the PDI. The CP function may update the Traffic Endpoint at any time. + +If a Traffic Endpoint is updated, all the PDRs that refer to this Traffic Endpoint in the UP function shall use the updated information. + +The UP function shall allocate and store the F-TEID associated to the Traffic Endpoint. When the UP function provides the allocated F-TEID to the CP function in the PFCP Session Establishment response or PFCP Session Modification response message, the CP function shall update the Traffic Endpoint information stored in the CP function with the received F-TEID. + +The CP function should use a Traffic Endpoint ID created in a different PFCP message only after getting the confirmation from the UP function of the Traffic Endpoint ID creation. + +If the CP function deletes a Traffic Endpoint, the UP Function shall delete all the PDRs that refer to this Traffic Endpoint. + +NOTE 1: The requirements specified in clause 5.2.2.3.1 for reporting usage reports to the CP function also apply if the deletion of the Traffic Endpoint results in deleting the last PDR associated to a URR. + +NOTE2: For EPC, the Remove Traffic Endpoint IE can be used to delete a bearer for which multiple PDRs exist (with the same Traffic Endpoint ID). + +### 5.2.1A.2A Provisioning of SDF filters + +When provisioning an SDF Filter in a PDI, the CP function shall: + +- copy the Flow Description if it is received from the PCRF (or PCF), in the corresponding PDI of a PDR regardless of whether the PDR is for matching uplink or downlink traffic; + +NOTE 1 The Flow Description received from the PCRF (or PCF) is set assuming downlink flows only, see clause 5.4.2 of 3GPP TS 29.212 [8]. The CP function uses the Flow-Direction AVP received from the PCRF (or PCF) to determine the actual direction and thus the source interface of the packet flows described in the Flow Description. + +- for traffic from CP-function or SGi-LAN: + - If the traffic is intended to be forwarded to the UE, the CP function shall provision the Flow Description with IPFilterRule "source" parameters set to correspond to the CP function or SGi-LAN and the IPFilterRule "destination" parameters correspond to the UE; + - If the traffic is intended to be forwarded to the PDN, the CP function shall provision the Flow Description with IPFilterRule "source" parameters set to correspond to the CP function or SGi-LAN and the IPFilterRule "destination" parameters correspond to the PDN. + +The UP function shall apply the SDF filter based on the Source Interface of the PDR as follows (see also clause 8.2.5): + +- when the Source Interface is CORE, this indicates that the filter is for downlink data flow, so the UP function shall apply the Flow Description as is; +- when the Source Interface is ACCESS, this indicates that the filter is for uplink data flow, so the UP function shall swap the source and destination address/port in the Flow Description; +- when the Source Interface is CP-function or SGi-LAN, the UP function shall use the Flow Description as is. + +### 5.2.1A.3 Bidirectional SDF Filters + +The CP function may provision bidirectional SDF Filters in the UP function (see clause 8.2.5), i.e. SDF Filters that may be associated to both uplink and downlink PDRs of a same PFCP/N4 session, as follows: + +- when provisioning a bidirectional SDF Filter the first time for a PFCP/N4 session, the CP function shall provision the SDF filter definition together with a SDF Filter ID uniquely identifying the SDF Filter among all the SDF Filters provisioned for a given PFCP/N4 Session; +- the CP function may then provision a PDR for the same PFCP/N4 session but the opposite direction, by provisioning the SDF Filter ID in the SDF filter ID field of the PDI, without provisioning again the SDF filter definition; +- the UP function shall apply any modification of a bidirectional SDF Filter to all PDRs of the PFCP/N4 session making use of this SDF Filter; +- upon deletion of a PDR making use of a bidirectional SDF Filter, the UP function shall still apply the SDF Filter for any other PDR making use of the SDF Filter. + +The requirements specified for provisioning SDF filters in clause 5.2.1A.2A shall also apply when provisioning bidirectional SDF Filters. + +### 5.2.1A.4 Application detection with PFD + +The detection information for a given application may be provisioned by the CP function to the UP function via PFD management procedure. See clause 6.2.5. + +The PFDE (PFD Enhancement) feature may be optionally supported by the CP function and UP function. When the feature is supported in both the CP function and UP function, the CP function may provision a PFD Contents IE including a property (i.e. either flow description, or URL or Domain Name/Domain Name Protocol) with multiple values. + +NOTE 1: It is assumed, when the PFDE feature is not supported, a PFD Contents can only include a property with one value. + +When the UP function attempts to detect the traffic pertaining to an application by using the application's PFDs (see clause 7.4.3.1 and 8.2.39), the UP function shall consider: + +- the application is detected if the incoming traffic matches at least one PFD Contents; +- one PFD Contents is matched if the incoming traffic matches every property contained in the corresponding PFD Contents IE; +- the incoming traffic matches one property (i.e. flow description, URL and Domain Name/Domain Name Protocol) if it matches at least one value of the property. + +NOTE 2: Interpretation of the Custom PFD Content is implementation specific. + +## 5.2.2 Usage Reporting Rule Handling + +### 5.2.2.1 General + +The CP function shall provision URR(s) for a PFCP session in a PFCP Session Establishment Request or a PFCP Session Modification Request to request the UP function to: + +- measure the network resources usage in terms of traffic data volume, duration (i.e. time) and/or events, according to the provisioned Measurement Method; and +- send a usage report to the CP function, when the measurement reaches a certain threshold, periodically or when detecting a certain event, according to the provisioned Reporting Triggers or when an immediate report is requested within a PFCP Session Modification Request. + +NOTE: The UP function sends a usage report without performing network resources usage measurements when being requested to detect and report the start of an SDF or application traffic. + +## 5.2.2.2 Provisioning of Usage Reporting Rule in the UP function + +### 5.2.2.2.1 General + +When provisioning a URR, the CP function shall provide the reporting trigger(s) in the Reporting Triggers IE of the URR which shall cause the UP function to generate and send a Usage Report for this URR to the CP function. When adding or removing reporting trigger(s) to or from the URR, the CP function shall provide the new complete list of applicable reporting triggers in the Reporting Triggers IE in the PFCP Session Modification Request message. + +For the volume-based measurement method, the CP function may provision: + +- the Volume Threshold IE, to request the UP function to generate a usage report when the measured traffic reaches the threshold; +- the Volume Quota IE, to request the UP function to stop forwarding packets (or only allow forwarding of some limited user plane traffic, based on operator policy in the UP function) and, if no Volume Threshold is provisioned, to also generate a usage report, when the measured traffic reaches the quota; +- the Dropped DL Traffic Threshold IE, to request the UP function to generate a usage report when the downlink traffic that is being dropped reaches the threshold; and/or + +NOTE 1: For EPC, the Dropped DL Traffic Threshold can be armed in a SGW-U for triggering the PGW Pause of Charging feature (see 3GPP TS 23.401 [14]). For 5GC, the Dropped DL Traffic Threshold can be armed in a UPF for triggering the SMF Pause of Charging feature (see 3GPP TS 23.502 [29]). + +- a Measurement Information with the 'Measurement Before QoS Enforcement' flag set to "1", to request the UP function to measure the traffic usage before any enforcement, e.g. bitrate enforcement for QoS, Gate control enforcement (as specified in clause 5.4.3) or packets dropped as requested by the FAR; +- a Measurement Information with the 'Measurement of Number of Packets' flag set to "1", to request the UP function to measure the number of packets be transferred in UL/DL/Total in addition to the measurement in octets, if the UP function supports the MNOP feature. + +For the time-based measurement method, the CP function may provision: + +- a Time Threshold IE, to request the UP function to generate a usage report when the measured traffic reaches the threshold; +- a Time Quota, to request the UP function to stop forwarding packets (or only allow forwarding of some limited user plane traffic, based on operator policy in the UP function) and, if no Time Threshold is provisioned, to also generate a usage report, when the measured traffic reaches the quota; +- a Measurement Information with the "Immediate Start Time Metering" flag set to "1", to request the UP function to start time metering immediately at receiving the flag; otherwise, the UP function shall start time metering when the first packet is received; and/or +- an Inactivity Detection Time, to request the UP function to suspend the time measurement when no packets are received during the provisioned Inactivity Detection Time. The time measurement shall then be resumed by the UP function when subsequent traffic is received. If an Inactivity Detection Time value of zero is provided, or if no Inactivity Detection Time has been provided by the CP function, the time measurement shall be performed continuously until a new non-zero Inactivity Detection Time is received or the time-based usage measurement is stopped. See Figure 5.2.2.2-1: + +![Diagram for IDT based charging showing a timeline with a vertical start line and a legend with blue, white, and grey boxes.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +The diagram illustrates IDT based charging. It features a horizontal timeline with an arrow pointing to the right. A vertical line intersects the timeline, marking the start of the measurement period. To the right of the timeline, there is a legend consisting of three vertically stacked rectangular boxes: the top box is blue, the middle box is white, and the bottom box is grey. + +Diagram for IDT based charging showing a timeline with a vertical start line and a legend with blue, white, and grey boxes. + +**Figure 5.2.2.2-1: IDT based charging** + +NOTE 2: The Inactivity Detection Time can be set to the Quota Consumption Timer if received. The Inactivity Detection Time is not used to control when the time metering starts. + +- For EPC, a Time Quota Mechanism, including a Base Time Interval Type, which is either Continuous Time Period (CTP) or Discrete Time Period (DTP), and a Base Time Interval (BTI), to the UP function. See clause 6.5.7 in 3GPP TS 32.299 [18]. +- For CTP (Continuous Time Period), the time measurement starts from the time that traffic has occurred up to the first Base Time Interval (BTI) which contains no traffic. The time measurement shall include the last Base Time Interval, i.e. the one which contained no traffic. The time measurement resumes by the UP function when subsequent traffic is received. See Figure 5.2.2.2-2: + +![Diagram for CTP based charging showing a timeline with a vertical start line.](94fd137860c16c8dfd75512f10161fe8_img.jpg) + +The diagram illustrates CTP based charging. It features a horizontal timeline with an arrow pointing to the right. A vertical line intersects the timeline, marking the start of the measurement period. + +Diagram for CTP based charging showing a timeline with a vertical start line. + +**Figure 5.2.2.2-2: CTP based charging** + +- For DTP (Discrete Time Period), the time measurement starts from the time that traffic has occurred up to the Base Time Interval end. The time measurement shall be resumed by the UP function when subsequent traffic is received. See Figure 5.2.2.2-3: + +![A diagram showing a horizontal line with an arrow pointing to the right, intersected by a vertical line near the left end, forming a simple coordinate system or timeline indicator.](a1fad9ca0c696e710c9a7ae5622401e4_img.jpg) + +A diagram showing a horizontal line with an arrow pointing to the right, intersected by a vertical line near the left end, forming a simple coordinate system or timeline indicator. + +**Figure 5.2.2.2-3: DTP based charging** + +When the time-based measurement method applies, and when the Envelope Reporting is required for EPC, the CP function shall request the UP function to report the usage by setting the reporting trigger to Envelope Closure in addition to other Reporting Trigger(s), in the Reporting Triggers IE. The CP function may indicate the UP function to report for just time, time and volume, time and events, or time and volume and number of events by setting Measurement Method accordingly. The CP function may set the Reduced Application Detection Information flag in the Measurement Information of the URR, when requesting the detection of start and stop of an application solely for the purpose of envelope reporting for EPC. + +The CP function may provision a Volume Threshold IE, a Volume Quota IE, or both (and/or respectively a Time/Event Threshold IE, a Time/Event Quota IE, or both). In such a case, the CP function may set the reporting trigger for threshold (VOLTH/TIMTH/EVETH) and/or the reporting trigger for quota (VOLQU/TIMQU/EVEQU)) in the Reporting Triggers IE. + +When both a Volume (or Time or Event) Threshold IE and a Volume (or Time or Event) Quota IE are provisioned and only the reporting trigger for threshold (VOLTH/TIMTH/EVETH) is set, the UP function shall send a usage report only when reaching the Volume (or Time or Event) Threshold. When subsequently reaching the Volume (or Time or Event) Quota, the UP function shall stop forwarding packets (or only allow forwarding of some limited user plane traffic, based on operator policy in the UP function) without sending a new usage report to the CP function. + +If both a Volume (or Time or Event) Threshold IE and a Volume (or Time or Event) Quota IE are provisioned and both of the respective Threshold and Quota reporting triggers are set, the UP function shall send a usage report when reaching the Volume (or Time or Event) Threshold and also later on when subsequently reaching the Volume (or Time or Event) Quota. + +NOTE 3: A UP Function complying with Release 14 or Release 15 of the specification only sends one usage report when the threshold is reached, even if both reporting triggers (for the threshold and the quota) are set. + +NOTE 4: After sending a usage report on reaching a threshold, the UP function typically gets a new quota before the earlier provisioned quota exhausts. This implies that the UP function typically sends a quota report when reaching the final quota. + +NOTE 5: For online charging, the Volume Threshold (or Time Threshold) can be set in a PGW-U or TDF-U to the value of the granted volume (or time) quota minus the volume (or time) quota threshold, such as to get a usage report from the UP function when the volume (or time) based credit falls below the remaining quota thresholds provided by the OCS. + +NOTE 6: The Volume Quota or Time Quota can be armed in a PGW-U or TDF-U for online charging to enable the traffic to be forwarded up to an intermediate or final quotas granted by the OCS. The CP function can provision both a Volume (or Time) Threshold and a Volume (or Time) Quota to request the UP function to: + +- send a usage report when the consumed resources reach the volume (or time) usage threshold provided by the OCS, and +- to stop forwarding packets (or only allow forwarding of some limited user plane traffic, based on operator policy in the UP function), without sending a second usage report, when the granted volume (or time) quota is exhausted. + +For event based measurement method, the CP function may provision: + +- the Event Threshold IE, to request the UP function to generate a usage report when the number of events reaches the event threshold; +- the Event Quota IE, to request the UP function to stop forwarding packets applicable to the event (or only allow forwarding of some limited user plane traffic, based on operator policy in the UP function) and, if no Event threshold is provisioned, to also generate a usage report, when the number of events reaches the event quota; + +NOTE 7: An event is preconfigured with one or more event detection logic in the UPF. Each event detection logic is associated with an Application ID. The CP function activates the detection and reporting of an event by provisioning PDR(s) with the PDI set to an Application ID and by provisioning a URR with an event threshold or event quota reporting trigger. The CP function identifies an event reported in a Usage Report by the URR ID. + +For all the measurement methods (i.e. volume, time or event), the CP function may also provision: + +- a Quota Holding Time, to request the UP function to send a usage report and to also stop forwarding packets (or only allow forwarding of some limited user plane traffic, based on operator policy in the UP function) when no packets have been received for the duration indicated in this parameter; + +NOTE 8: A Quota Holding Time can be armed in a PGW-U or TDF-U for online charging to request the UP function to send a Usage Report when the Quota Holding Time provided by the OCS (see 3GPP TS 32.299 [18]) expires. The UP function can be instructed in the same Usage Reporting Rule with the Report Triggers – START to generate a new Usage Report upon receiving any subsequent packets associated with this URR. + +- a Quota Validity Time, if the VTIME feature is supported by UP function, to request the UP function to send a usage report after the validity duration is over. After Quota validity timer expiry, if packets are received on UPF, the UPF shall stop forwarding packets or only allow forwarding of limited user plane traffic, based on operator's policy in the UP function; + +NOTE 9: After sending the usage report triggered by the QUHTI or QUVTI (i.e. the Quota Holding Time or Quota Validity Time expires), any remaining quota for the URR is discarded in the UP function. + +- a Monitoring Time IE and zero or more Additional Monitoring IEs, to request the UP function to measure the network resources usage before and after the monitoring time in separate counts and to re-apply the volume and/or time, and/or event thresholds at the monitoring time. The CP function may additionally provision a Subsequent Volume (or Time or Event) Threshold IE and/or a Subsequent Volume (or Time or Event) Quota IE, for a volume (or time or event) based measurement. When being provisioned with a Monitoring Time, the UP function shall: + - reset its usage thresholds at the monitoring time to the value provided in the Subsequent Volume (or Time or Event) Threshold IE, if provisioned in the URR, or to the remaining value of the Volume (or Time or Event) threshold used before the monitoring time (i.e. excluding the already accumulated volume or time usage); + - shall indicate the usage up to the Monitoring time and usage after the Monitoring time in separate usage reports as specified in clause 5.2.2.3.1; +- an Measurement Period, indicating the period to generate periodic usage reports to the CP function. +- an User Plane Inactivity Timer, to request the UP function to send an usage report when no packets have been received for any of the PDRs associated to the URR for the duration indicated in this parameter. + +If the UP function indicated support of the Quota Action feature in the UP Function Features IE, when the CP function provisions a Volume Quota or Time Quota or Event Quota in a URR, the CP function may also provision the "FAR ID for Quota Action" IE identifying the substitute FAR the UP function shall apply, for the traffic identified by the PDR to which the URR is associated, when exhausting any of these quotas. This FAR may require the UP function to drop the packets or buffer the packets or redirect the traffic towards a redirect destination as specified in clause 5.4.7. + +If the UP function has indicated support of the QUASF feature as specified in clause 8.2.25, and when the CP function provisions a Volume Quota, Time Quota, or Event Quota in a URR, the CP function may also provision the Exempted Application ID for Quota Action IE or the Exempted SDF Filter for Quota Action IE, to instruct the UP function, that traffic matching the associated PDR(s) and matching the Application ID(s) or SDF Filter(s) shall be handled based on the FAR associated with the PDR as normal, even when the quota has been exhausted. + +NOTE 10: The traffic forwarded after the quota has been exhausted need not to be measured. + +NOTE 11: A PDR can be associated with multiple URRs. If one of these URRs requires the UP function to drop the user data packets, e.g. when the Quota has been exhausted, the other URRs associated to the PDR need also to stop their measurements, except for URRs including the Measurement Information with the 'Measurement Before QoS Enforcement' flag set to "1". + +The CP function may request at any time the UP function to activate or deactivate a network resources usage measurement, using the Inactive Measurement flag of the Measurement Information IE of the URR. + +NOTE 12: This can be used in a PGW-U for the PGW Pause of Charging procedure (see 3GPP TS 23.401 [14]). + +When the NSPOC feature as specified in clause 5.30 is supported by the CP and UP function, the CP function may provision: + +- an Measurement Information with the 'Send Start Pause of Charging' Flag set to "1", to request the UP function (SGW-U or I/V-UPF) to send a Start Pause of Charging indication to the upstream GTP-U entity(s) when the Dropped DL Traffic Threshold is reached. +- an Measurement Information with the 'Applicable for Start of Pause of Charging' Flag set to "1", to indicate the UP function to stop the usage measurement for the URR when receiving Start Pause of Charging indication from the peer downstream GTP-U entity. + +When the NSPOC feature is supported by the CP and UP functions, the CP function may use the "SUMPC" and "RUMUC" flags in the PFCPSMReq-Flags IE, and the "SUMPC" flag in the PFCPSEReq-Flags IE, to request the UP function to stop or resume the usage measurement for all URRs with the ASPOC flag set to "1". The CP function may set the "CIAM" flag in the Measurement Information IE in a Create URR or a Update URR IE to request the UP function to stop or resume the usage measurement according to the value of the Inactive Measurement flag for a specific URR with the "ASPOC" flag set to "1" if necessary. See also clause 5.30. + +The CP function may request the UP function to measure network resources usage and generate the corresponding Usage Reports only for a number of times, by provisioning the "Number of Reports" IE in a URR, if the UP function supports the NORP feature (see clause 8.2.25-1). If so, the URR shall become inactive in the UP function after the requested "Number of Reports" have been reported. + +The CP function may resume the measurement for an inactive URR by setting the Inactive Measurement flag of the Measurement Information IE of the URR to "0" in the Update URR IE in a PFCP Session Modification Request message, with or without the Number of Report IE if the URR was deactivated by setting the Inactive Measurement flag of the Measurement Information IE of the URR to from "0" to "1". + +For any other cases, i.e. the URR becoming inactive, which is not caused by changing the Inactive Measurement flag from "0" to "1", the CP may resume the URR: + +- by provisioning a Number of Report IE with a (new) non-zero value (to receive the corresponding number of usage reports) or with a null length (to request UP function to perform continuous measurement) when the requested Number of Reports has been reached; +- by setting the CIAM flag to "1" and the INAM flag to "0" if the URR was provisioned with ASPOC bit set to "1" in the Update URR (for the URR) when the CP function has requested to stop usage measurement for pause of charging by setting the SUMPC flag to "1"; or +- by associating (new) PDR(s) with the URR when the last PDR associated with the URR has been removed. + +If the CP function wishes the UP function to perform continuous measurement for a URR which was provisioned with a Number of Reports (i.e. to no longer limit the number of reports to be generated), the CP function shall provide the Number of Reports IE in the Update URR with a null length to delete the limit on the number of reports to be generated. + +NOTE 13: The Number of Reports can be provisioned in an URR regardless which Measurement Method is used. + +#### 5.2.2.2.2 Credit pooling (for EPC) + +For EPC, when the Credit Pool feature is supported and the CP function (e.g. PGW-C) is instructed to handle a Credit Pool for a given Gy Session, the CP function shall create a URR for the Credit Pool, and in this URR, the CP function: + +- shall include one Aggregated URR ID IE per URR sharing the credit pool, including the URR ID of the URR sharing the credit pool and the associated Multiplier to measure the abstract service units the corresponding traffic consumes from the credit pool; +- shall set the Time or Volume Threshold or Quota IE to the value calculated as specified in IETF RFC 4006 [16] according to the Measurement Method. + +NOTE 1: The value can be calculated using the following formula: + +$$S = Q1 * M1 + Q2 * M2 + \dots + Qn * Mn,$$ + +where the S is the quota for the credit pool, Qn is the quota and Mn is the multiplier for each Rating Group (RG) which are provided via the Multiple Services Credit Control from the OCS. + +An URRn is defined for each of RG. + +NOTE 2: When the Measurement Method is set to the combined volume/duration, the Time and Volume Threshold or Quota are calculated independently. + +- may set the Reporting Trigger to reporting upon reaching a volume or time threshold or quota; +- may set the Measurement Method to the data volume, duration (i.e. time), combined volume/duration according to the Measurement Method set in the URRs in the Credit Pool. + +NOTE 3: The UP function is instructed to handle a Credit Pool when a G-S-U-Pool-Reference AVP is included within a Multiple Services Credit Control from the OCS. A Credit Pool is identified by the G-S-U-Pool-Identifier AVP. See clause 6.3.11, 6.4.3 and 6.4.4 of 3GPP TS 32.299 [18]. + +In addition, the CP function shall also include the Linked URR IE, set to the Credit Pool URR ID, in all the URRs which are sharing the credit pool (i.e. which are associated with RGs sharing the Credit Pool). + +## 5.2.2.3 Reporting of Usage Report to the CP function + +### 5.2.2.3.1 General + +When detecting that a provisioned reporting trigger occurs, the UP function shall generate a Usage Report for the related URR and send it to the CP function by initiating the PFCP Session Report procedure. + +When providing usage report information for a URR in a message, the UP function shall include the UR-SEQN (Usage Report Sequence Number) identifying the order in which a Usage Report is generated for the given URR. The UR-SEQN (Usage Report Sequence Number) shall be set to "0" for the first Usage Report and incremented for every subsequent Usage Report generated by the UP function for the URR. The UP function shall also indicate the trigger that causes the usage report to be generated in the Usage Report Trigger IE. + +Upon generating a usage report for an URR towards the CP function, the UP function shall: + +- reset its ongoing measurement counts for the related URR (i.e. the UP function shall report in a usage report the network resources usage measurement since the last usage report for that URR); +- re-apply all the thresholds (Volume/Time/Event Threshold) provisioned for the related URR, if the usage report was triggered due to one of the thresholds being reached, i.e. upon the reporting triggers VOLTH/TIMTH/EVETH; otherwise, if the usage report was triggered for other reporting triggers, adjust the thresholds (Volume/Time/Event Threshold) respectively by subtracting the (volume/time/event) reported usage in the usage report to determine when to generate the next report for reporting triggers VOLTH/TIMTH/EVETH; +- when the quota (Volume/Time/Event Quota) is provisioned in the URR: + - adjust the quota for volume/time/event respectively by subtracting the (volume/time/event) reported usage in the usage report and use it when applying quota related handling, e.g. to drop or buffer the packets, or apply FAR ID for Quota Action (if provisioned) when the quota becomes "0" and to generate the relevant usage report if the corresponding reporting trigger(s)(VOLQU/TIMQU/EVEQU) is set; + - consider no quota left for the URR when the usage report was triggered for the reporting triggers QUHTI and QUVTI; and +- continue to apply the remaining provisioned parameters in the URR and perform the related network resources usage measurement(s), until getting any further instruction from the CP function. + +When receiving a new threshold and/or quota from the CP function for a measurement that is already ongoing in the UP function, the UP function shall consider its ongoing measurements counts for the related URR against the new threshold and/or quota to determine when to send its next usage report to the CP function or to apply quota handling, i.e. the UP function shall discard any remaining quota. + +At receiving a quota with value set to zero, the UP function shall: + +- handle packets based on the FAR associated with the PDR, if the packets match the Application ID(s) or the SDF Filter(s) provisioned in the IE Exempted Application ID for Quota Action or the Exempted SDF Filter for Quota Action; +- apply the FAR identified in the FAR ID for Quota Action IE if the CP function has provisioned it, otherwise the UP function shall stop forwarding packets (or only allow forwarding of some limited user plane traffic, based on operator policy in the UP function); and +- report in a usage report the network resources usage measurement since the last usage report for that URR, if applicable. + +When the UP function receives a non-zero quota for the same URR in one subsequent PFCP Session Modification Request message, the UP function shall apply the (normal) FAR associated with the PDR (detecting the application traffic) for the buffered traffic if the FAR ID for Quota Action was set to buffer the application traffic at zero quota (either be provisioned with zero quota earlier or the quota has been exhausted). + +NOTE 1: The UP function determines when to send its next usage report to the CP function by deducting from the newly provisioned threshold or quota the traffic it has forwarded since its last usage report. As an example, if the UP function has forwarded 10 Mbytes of traffic since its last usage report to the CP function and the CP function provisions a new volume threshold or quota of 100 Mbytes, the UP function sends its next usage report upon forwarding an additional 90 Mbytes traffic. + +NOTE 2: When receiving a new threshold or quota from the CP function for a measurement that is already ongoing in the UP function and if the UP function has already generated the usage report but had not sent it, the UP function can send the usage report before performing the update of the URR. + +NOTE 3: A URR with the quota set to 0 can be provisioned when a service data flow is not allowed to start before quota is allocated to the service. See clause 5.4.11. + +When reporting the network resources usage before and after a Monitoring Time, the UP function shall send two Usage Reports in the PFCP message (e.g. PFCP Session Report Request) for the same URR ID. Each Usage Report shall then include the Usage Information IE indicating whether the reported network resource usage was consumed before or after the Monitoring Time. Omission of this IE in a Usage Report indicates that no monitoring time has occurred. The UP function shall send Usage Reports soon after the occurrence of the Monitoring Time. For a URR, when multiple (Additional) Monitoring Time IEs are provisioned, or a new Monitoring Time is provisioned after the previous Monitoring Time has passed, the UP function may not be able to send the usage report with the Usage Information set to "AFT" for the previous Monitoring Time if there is no Reporting Trigger armed before the next Monitoring Time is reached; in such case, the UP function may send multiple usage reports with the Usage Information set to "BEF", together with one usage report with the Usage Information set to "AFT". + +NOTE 4: The UP function needs to take care to smooth the signalling load towards the CP function if Usage Reports need to be generated for a large number of PFCP sessions after the occurrence of the Monitoring Time. + +For the volume-based measurement method, the UP function shall report the traffic usage after any QoS enforcement. Additionally, if the CP function requested to measure the traffic usage before QoS enforcement, the UP function shall also report corresponding measurements, when measurements needs to be reported for the traffic usage after QoS enforcement, by sending two Usage Reports in the PFCP message (e.g. PFCP Session Report Request) for the same URR ID. Each Usage Report shall then include the Usage Information IE indicating whether the reported network resource usage corresponds to the traffic before or after QoS enforcement. Thresholds provisioned in a URR shall apply to the traffic usage after any QoS enforcement. + +For the volume-based measurement method, the UP function shall include all the counters (Total, Uplink and Downlink) of the URR in the Volume Measurement IE in the Usage Report IE; the UP function shall also include the number of packets counted for Total, Uplink, Downlink in the Volume Measurement IE if requested by the CP function and if the UP function supports the MNOP feature. + +An usage report triggered only due to the Dropped DL Traffic Threshold (DROTH) or Start of Traffic (START), or MAC Address Reporting (MACAR), or IP Multicast Join/Leave (IPMJL) shall not contain any measurement information, i.e. either the Volume/Duration Measurement set to zero or Volume/Duration Measurement IE is not present. + +When being instructed to remove a URR or the last PDR associated to a URR, the UP function shall stop its ongoing measurements for the URR and include a Usage Report in the PFCP Session Modification Response or in an additional PFCP Session Report Request if there are non-null measurements to report for the URR. When being instructed to remove the last PDR associated to a URR, the UP function shall keep the URR and reset any measurement for the URR. + +NOTE 5: A URR provisioned in a PFCP session can be provisioned/kept in the UP function without being associated with any PDR and the URR can be associated with a PDR in a later stage. The UP function will not remember any remaining quota and will consider the quota (if provisioned) as it was provisioned. + +When being instructed to deactivate a network resources usage measurement via the Inactive Measurement flag of the Measurement Information IE of the URR, the UP function shall stop measuring the network resources usage (against the volume/time/event threshold/quota) and store the current measurement counts which will be resumed when the URR is activated again. The UP function shall not generate a usage report upon the deactivation of the URR and it shall send a usage report during the period when the URR is deactivated for the following scenarios: + +- if the Quota Holding Time is expired and if the reporting trigger QUHTI is set; +- if the Quota Validity Time is expired and if the reporting trigger QUVTI is set; + +NOTE 6: The Quota Holding Time can have been started before the URR is deactivated or starts from the moment when the URR is deactivated since no quota will be consumed. + +- if it is the time for a periodic reporting and if the reporting trigger PERIO is set; +- if it is required to send a usage report for this URR when a usage report is reported for a linked URR and if the reporting trigger LIUSA is set; +- if it is required to send an immediate report upon a query for the URR, or the URR is removed, dissociated from the last PDR; + +NOTE 7: Multiple usage reports can be required to be reported to the CP function when deleting a PDR that is the last one to be associated to multiple URRs. + +- if the User Plane Inactivity Timer is expired and if the reporting trigger UPINT is set. + +NOTE 8: The User Plane Inactivity Timer can have been started before the URR is deactivated. + +The CP function may request the UP function, in a PFCP Session Modification Request, to report its ongoing network resources measurement for one or multiple URRs of the PFCP session. In this case, the UP function shall: + +- generate usage report(s) (based on the existing definition of any URR(s) included in the PFCP Session Modification Request message before any update) for the URR(s) being queried and for any associated linked usage reports (see clause 5.2.2.4) for which there are non-null measurements to report; +- include them in the PFCP Session Modification Response or in additional PFCP Session Report Request messages; and +- proceed as specified above upon generating a usage report for a URR towards the CP function, with the following additions: + - if the PFCP Session Modification Request includes the Update URR IE (for the URR being queried) with a Volume or Time Threshold, the UP function shall re-apply the threshold received in the request; + - otherwise, if a threshold and/or a quota had been set for the URR that is queried, since the usage report is not triggered due to the threshold being reached, the UP function shall adjust the threshold and/or quota by subtracting the time/volume reported in the usage report to determine when to generate the next report. + +NOTE 9: Upon reaching a threshold that was adjusted due to a URR query as specified above, the UP function re-applies then the threshold that was provisioned in the URR (i.e. not the value of the adjusted threshold). + +NOTE 10: The CP function can query a URR without including a Volume or Time Threshold in the PFCP Session Modification Request e.g. when it needs to close a traffic volume/service container (see clause 5.2.3.10.3 of 3GPP TS 32.251 [17]). + +NOTE 11: The CP function can query a URR including a Volume or Time Threshold in the PFCP Session Modification Request e.g. when it needs to close a CDR (see clause 5.2.3.10.3 of 3GPP TS 32.251 [17]). In such a case, the CP function can include the same threshold for the URR being queried in the Update URR IE in the PFCP Session Modification Request message to trigger the UP function to re-apply the threshold. + +NOTE 12: It is up to the CP function to request the UP function to generate an immediate report (or not) as specified above when the CP function modifies a URR or any other rules of the PFCP session. As an exception, the UP function always generates an immediate report when being instructed to remove a URR. + +When additional usage reports need to be sent in additional PFCP Session Report Request messages, i.e. when not all usage reports can be included in the PFCP Session Modification Response message, the UP function shall indicate, in the PFCP Session Modification Response message, either: + +- that more usage reports will follow, by setting the AURI flag to 1 in the Additional Usage Reports Information IE (see clause 8.2.91); or +- the total number of additional usage reports that will be sent in all the additional PFCP Session Report Request messages (i.e. that will be sent after the PFCP Session Modification/Deletion Response message), by setting this value in the Additional Usage Reports Information IE (see clause 8.2.91). + +In the former case (i.e. if the UP function indicates in the PFCP Session Modification Response message that more usage reports will follow), the UP function shall indicate, in one of the additional PFCP Session Report Request message, the total number of additional usage reports to be sent after the PFCP Session Modification Response message, by setting this value in the Additional Usage Reports Information IE. In both cases, the UP function may set the AURI flag to 1 in every additional PFCP Session Report Request message but the last one, to indicate that more usage reports will follow. + +Besides, if the PFCP Session Modification Request included the Query URR Reference IE, usage reports sent in response to the query in the PFCP Session Modification Response and/or additional PFCP Session Report Request messages shall include the Query URR Reference IE set to the same value as received in the PFCP Session Modification Request. + +When the reporting trigger "Envelope Closure" is set in the corresponding Usage Reporting Rule, the UP function shall generate a usage report with the measurement of the time and/or volume as instructed in the Measurement Method: + +- when the Inactivity Detection Time (if included) is expired; +- when detecting no usage for the first Base Time Interval if the Base Time Interval Type in the Time Quota Mechanism is set to CTP; or +- at the end of each of base time interval if the Base Time Interval Type in the Time Quota Mechanism is set to DTP. + +NOTE 13: Events (e.g. application detection information) are reported individually and independently from the usage report sent for envelope closure. + +When the UP function supports the NORP feature and if a URR is provisioned with a "Number of Reports" IE, the number of Usage Reports generated according to the Reporting Trigger(s) defined in the URR shall not be more than the value of "Number of Reports". If the UP function is requested to resume the measurement for an inactive URR, the UP function shall generate a maximum number of Usage Reports equal to the new value of the Number of Reports IE received in the Update URR if any, or equal to the value of the Number of Reports IE previously provisioned in the URR if any; if no Number of Reports IE was provisioned before, there is no limit on the number of reports to send. If the CP function provisions a "Number of Reports" IE together with a Monitoring Time and/or a Measurement Information where the "Measurement Before QoS Enforcement" flag is set to "1" in a URR, the UP function shall generate usage reports as required by the Monitoring Time and/or the Measurement Information where the "Measurement Before QoS Enforcement" flag is set to "1" in a URR, which may lead UP function to generate more usage reports than the value of the "Number of Reports" IE. + +NOTE 14: If the CP function expects to receive the exact number of usage reports as requested in the Number of Reports, it can abstain from provisioning a Number of Report IE together with a Monitoring Time and/or a Measurement Information where the "Measurement Before QoS Enforcement" flag is set to "1" in a URR. + +At the PFCP session termination, the UP function shall indicate to the CP function, in the PFCP Session Deletion Response, the resources that have been consumed for each URR that was provisioned in the PFCP session since the last usage report (respective to each URR). A CP function may indicate support of Additional Usage Reports in PFCP Session Deletion Request by setting the ARDR flag in the CP Function Features IE (see clause 8.2.58). When additional PFCP Session Report Request messages need to be sent: + +- the UP function shall: + - set the cause to "More Usage Report to send" in the PFCP Session Deletion Response; + - include the Additional Usage Reports Information IE in PFCP Session Deletion Response with either the AURI flag set to "1" or indicating the total number of additional usage reports that will be sent in all the additional PFCP Session Report Request messages; as described above: + - in the former case, the UP function shall indicate in one additional PFCP Session Report Request message the total number of additional usage reports that will be sent after the PFCP Session Deletion Response; + - in both cases, the UP function may set the AURI flag to 1 in every additional PFCP Session Report Request message but the last one, to indicate that more usage reports will follow. + - set the PSDBU flag to 1 in the last PFCP Session Report Request message. +- when the CP function receives a PFCP Session Deletion Response with the Cause set to "More Usage Report to send", the CP function shall not delete the PFCP session until it receives a PFCP Session Report Request message with the PSDBU flag set to "1" (that indicates this is the last report), or it has received the number of usage reports indicated in the Additional Usage Reports Information IE in PFCP Session Deletion Response, or until an implementation specific timer expires otherwise. + +At the PFCP session termination, the UP function shall set the PURU flag to "1" in the PFCP Session Deletion Response if it has pending PFCP Session Report Request messages which have not been acknowledged yet. This indicates that the CP function should wait for some time before deleting the PFCP Session. + +Upon receiving the Usage Report from the UP function, the CP function may initiate PFCP Session Modification procedure as result of the communication with the PCRF or OCS, as described in clause 5.3 of 3GPP TS 23.214 [2], e.g. by: + +- modifying the URR (e.g. changing the Volume/Time threshold, Volume/Time quota, disabling the usage monitoring); +- creating a new FAR (e.g. for redirect) and/or modifying the existing FAR; or +- modifying the QER (s) in the PFCP session. + +### 5.2.2.3.2 Credit pooling + +When a URR is received with at least one Aggregated URRs IE included, the UP function: + +- shall calculate the traffic usage of the URR by applying the Multiplier(s) and aggregating the traffic usage from all URRs indicated in the Aggregated URRs IE(s), as specified in IETF RFC 4006 [16]; + +NOTE 1: The usage of this URR is calculated using the following formula: + +$$C1*M1 + C2*M2 + \dots + Cn*Mn = U,$$ + +where U is the usage counted by this URR, Cn is the usage counted by each aggregated URR (i.e. URR for each RG sharing the credit pool), and Mn is the multiplier for each aggregated URR. + +- shall generate a report when the counted usage exceeds the threshold; +- shall generate a report if the threshold is not provided, and stop packets forwarding (or only allow forwarding of some limited user plane traffic, based on operator policy in the UP function) for all Aggregated URRs when the counted usage exceeds the quota. + +NOTE 2: The handling of the aggregated URR(s), e.g. generating a Usage Report upon the Reporting Trigger(s) is not impacted by handling of this URR for the Credit Pool. + +### 5.2.2.3.3 Traffic Usage Reporting with Redundant Transmission + +The following requirements shall apply when using Redundant Transmission on N3/N9 interfaces or Redundant Transmission at transport layer: + +- the UPF shall not count redundant packets in Usage Reports (e.g. Volume Measurement), i.e. it shall count the traffic only once in Usage Reports; +- the SMF shall provide the quota for the non-redundant transmission (i.e. not counting redundant traffic). + +### 5.2.2.4 Reporting of Linked Usage Reports to the CP function + +The CP function may instruct the UP function to generate a Usage Report for a URR "X" when a Usage Report is generated for another URR "Y", by: + +- provisioning the URR "X" with the Reporting Triggers IE set to Linked Usage Reporting; and +- including in the URR "X" the Linked URR ID IE set to the URR ID of the URR "Y". + +NOTE 1: This can be used by the CP function e.g. to request the UP function to report a Usage Report for an SDF (i.e. URR "X") when the UP function reports a Usage Report for a bearer (i.e. URR "Y"). + +NOTE 2: This can be used by the CP function e.g. to request the UP function to report a Usage Report for a RG (i.e. URR "X") when the UP function reports a Usage Report for a credit pool to which this RG pertain (i.e. URR "Y"). + +When a usage report is to be generated for the URR "Y", regardless of the condition which triggers the report, the UP function shall also send a Usage Report for the URR "X" with the accumulated usage information, and the Usage Report Trigger IE set to Linked Usage Reporting. + +NOTE 3: This also applies e.g. when an immediate usage report is requested for the URR "Y" within a PFCP session Modification Request. + +The URR "Y" may be linked to more URRs than just URR "X". + +A RG level URR may be linked to IP-CAN bearer level URR as well as IP-CAN Session level URR to enable the CP function to generate a CDR on the different level. In such case, a URR "X" may link to more URRs than just URR "Y". + +### 5.2.2.5 End Marker Reception Reporting + +The CP function may request the UP function to report the End Marker reception during UE Triggered Service Request with, or without I-SMF insertion/change/removal procedures (see clauses 4.2.3.2 and 4.23.4.3 in 3GPP TS 23.502 [29]): + +- If a new I-UPF is selected by the SMF to replace the old I-UPF, the SMF may provide two PDRs to the new I-UPF, e.g. PDR-1 for DL data from the PSA UPF, where the Apply Action IE in FAR-1 associated with PDR-1 is set to BUFF; and e.g. PDR-2 for receiving the buffered DL data from the old I-UPF, where the Apply Action IE in FAR-2 associated with PDR-2 is set to FORW. In this case, the SMF shall indicate to the new I-UPF to report the reception of the End Marker packet from the old I-UPF, by providing a URR related to PDR-2 with REEMR flag set to 1 in the Reporting Triggers IE, which is included in a Create URR IE within PFCP Session Establishment Request. +- If the SMF removes the old I-UPF but does not replace it with a new I-UPF, then the SMF may provide two PDRs to the PSA UPF, e.g. PDR-3 for receiving DL data across N6, where the Apply Action IE in FAR-3 associated with PDR-3 is set to BUFF; and e.g. PDR-4 for receiving the buffered DL data from the old I-UPF, where the Apply Action IE in FAR-4 associated with PDR-4 is set to FORW. The SMF shall indicate to the PSA UPF to report the reception of the End Marker packet from the old I-UPF, by providing a URR related to PDR-4 with REEMR flag set to 1 in the Reporting Triggers IE which is included in a Create URR IE within PFCP Session Modification Request. + +Once the End Marker packet is received from the old I-UPF, the UPF (either new I-UPF or the PSA UPF) shall inform the SMF about this by sending the PFCP Session Report Request with the Usage Report IE containing the usage measurement as instructed in the URR, where EMRRE flag shall be set to 1 in a Usage Report Trigger IE and shall discard the End Marker packet(s). The SMF shall instruct the UPF to start sending the buffered DL data identified by + +PDR-1 or PDR-3 by sending a PFCP Session Modification Request message, where the Apply Action IE in the FAR-1/FAR-3 related to PDR-1/PDR-3 shall be changed from BUFF to FORW. + +## 5.2.3 Forwarding Action Rule Handling + +### 5.2.3.1 General + +The CP function shall provision one and only one FAR for each PDR provisioned in a PFCP session. The FAR provides instructions to the UP function on how to process the packets matching the PDR. + +By setting the appropriate flag(s) in the Apply Action IE in the FAR (see clause 8.2.26), the CP function may request the UP function to: + +- drop the packets, by setting the DROP flag; +- forward the packets, by setting the FORW flag and by provisioning the Forwarding Parameters providing instructions on how to forward the packets; +- forward the MBS session data: + - using multicast transport, by setting the FSSM flag together with the MBS Multicast Parameters to forward the packets to a Low Layer source specific multicast address; and/or + - using unicast transport by setting the MBSU flag together with one or more MBS Unicast Parameters to forward and replicate the packets towards one or more GTP-U DL tunnels terminated at PSA UPF(s) and/or NG-RAN(s). +- buffer downlink or uplink packets by setting the BUFF flag and by optionally provisioning buffering parameters providing instructions on how to buffer the packets; +- notify the CP function about the arrival of a first DL packet being buffered, by setting the NOCP flag; +- notify the CP function about the first discarded DL packet for each service data flow identified by a PDR, when the CP function requests the UP function to buffer DL packets but the DL Buffering Duration or the DL Buffering Suggested Packet Count is exceeded, or when the CP function requests the UP function to drop DL packets and a packet is discarded directly, by setting the DDPN flag, if the UP function supports the DDDS feature; +- notify the CP function about first buffered DL packet for each service data flow identified by a PDR, by setting the BDPN flag, if the UP function supports the DDDS feature; +- duplicate the packets, by setting the DUPL flag and by provisioning the Duplicating Parameters providing instructions on how to forward the duplicated packets; +- accept or deny UE requests to join an IP multicast group (see clause 5.25), by setting the IPMA or IPMD flag; +- duplicate the packets for redundant transmission (see clause 5.24.2), by setting the DFRT flag and by provisioning the Redundant Transmission Forwarding Parameters IE providing instructions on how to forward the duplicated packets for redundant transmission; +- eliminate duplicate packets used for redundant transmission (see clause 5.24.2), by setting the EDRT flag and by provisioning the Redundant Transmission Detection Parameters IE providing instructions on how to detect the duplicated packets for redundant transmission. + +The CP function may request the UP function to duplicate packets that are to be dropped, forwarded or buffered. + +The CP function may request the UP function to forward the packets and duplicate the packets for redundant transmission. + +The CP function may request the UP function to forward the packets and eliminate duplicate packets used for redundant transmission. + +The CP function may provision one or more FAR(s) per PFCP session. Different FARs of a same PFCP session may be provisioned with a different Apply Action flags, e.g. to enable the forwarding of downlink data packets for some PDRs while requesting to buffer downlink data packets for other PDRs. + +NOTE 1: This is necessary to establish or release a partial set of radio access bearers in UTRAN. + +When instructed to buffer and notify the CP function about the arrival of a DL packet, the UP function shall notify the CP function, when it receives a first downlink packet for a given FAR (in EPC), or when it receives a first downlink packet for each QoS flow for a given FAR (in 5GC), by sending a PFCP Session Report Request including a Downlink Data Report IE identifying the PDR(s) for which downlink packets have been received. + +NOTE 2: Receipt of downlink packets on PDRs associated to different FARs can result in sending multiple PFCP Session Report Request messages for the same PFCP session. + +NOTE 3: Receipt of downlink packets pertaining to different QoS flows associated to the same FAR can result in sending multiple PFCP Session Report Request messages for the same PFCP session. The CP function identifies the QFI based on the PDR ID (when different PDRs are used for different QoS flows) or based on the Downlink Data Service Information IE. + +NOTE 4: The end marker packet is not considered as DL data packet so that it does not trigger the UP function to notify the CP function about the arrival of a DL packet. The UP function can discard the received end marker packet(s) silently, when it is not possible to be forwarded. + +If the UP function indicated support of Header Enrichment of UL traffic (see clause 8.2.25), the CP function may provide the UP function with header enrichment information for uplink traffic, by including one or more Header Enrichment IE(s) in the FAR. In this case, the UP function should use this information to enrich the header of the uplink traffic (e.g. HTTP header enrichment). + +NOTE 5: It is not defined how to support SGi PtP tunnelling mechanisms other than based on UDP/IP encapsulation (such as PMIPv6/GRE, L2TP, GTP-C/U, see clause 4.3.17.8.3.3.3 of 3GPP TS 23.401 [14]) for Non-IP PDN connections. + +If the UP function indicated support of PDI optimisation (see clause 8.2.25), the CP function may include in the forwarding parameters of the FAR the Linked Traffic Endpoint ID, if it is available, identifying the traffic Endpoint allocated for this PFCP session to receive the traffic in the reverse direction. + +NOTE 6: This information can enable an SGW-U or PGW-U to correlate the UL and DL traffic (i.e. PDRs) sent over a same bearer. + +Assuming for instance a PFCP session provisioned in a PGW-U with: + +- an UL PDR 1 (for an S5/S8 bearer 1) with Source Interface "Access" associated to an UL Traffic Endpoint ID "1" (comprising the IP address, a local TEID and optionally a network instance), +- a DL PDR 1 with Source Interface "Core", UE IP address and SDF 1, + +the CP function sets the Linked Traffic Endpoint in the DL FAR 1 (associated to DL PDR 1) to the UL Traffic Endpoint "1", which allows the PGW-U to correlate the uplink and downlink PDRs for the same bearer (i.e. that UL PDR 1 associated to UL Traffic Endpoint "1", and DL PDR 1 associated to DL FAR 1 with Linked Traffic Endpoint set to UL Traffic Endpoint "1", use the same S5/S8 bearer). + +NOTE 7: The Linked Traffic Endpoint can possibly refer to a Traffic Endpoint in the reverse direction requested to be created in the same PFCP request. + +## 5.2.4 Buffering Action Rule Handling + +### 5.2.4.1 General + +A BAR provides instructions to control the buffering behaviour of the UP function for all the FARs of the PFCP session set with an Apply Action parameter requesting the packets to be buffered and associated to this BAR. + +The CP function may create a BAR for a PFCP session and associate it to the FAR(s) of the PFCP session in a PFCP Session Establishment Request or a PFCP Session Modification Request to request the UP function to apply a specific buffering behaviour for packets requested to be buffered and associated to this BAR. + +The CP function may modify the following buffering instructions provided in a BAR as follows: + +- the Downlink Data Notification Delay in a PFCP Session Modification Request (for EPC); or + +- the Downlink Data Notification Delay (for EPC), DL Buffering Duration and/or DL Buffering Suggested Packet Count in a PFCP Session Report Response message or PFCP Session Modification Request. + +NOTE: The CP function needs to provision a (possibly empty) BAR and associate it to the FARs of the PFCP session when establishing or modifying the PFCP session to be able to modify the BAR in a PFCP Session Report Response. + +If the UP Function has indicated support of the feature UL/DL Buffering Control (UDBC), the CP function may provide the Suggested Buffering Packet Count IE in a BAR which is created during a PFCP Session Establishment procedure or a PFCP Session Modification procedure, and the CP function may modify it in a subsequent PFCP Session Modification Request, and/or a PFCP Session Report Response message. The same BAR may be associated with all the FARs in a PFCP session to indicate that all Service Data Flows in the PFCP Session share the same buffer in the UP function for the PFCP Session. + +If the SGW-U has indicated support of the feature MT-EDT, the CP function may provide the MT-EDT (Mobile Terminated Early Data Transmission) Control Information IE in a BAR when it is created and modified, to request the SGW-U to report the sum of DL Data Packets Size in byte when sending Downlink Data Report. + +In this release of the specification, at most one BAR may be created per PFCP session. + +## 5.2.4.2 Provisioning of Buffering Action Rule in the UP function + +The CP function may provision the following buffering parameters in a BAR: + +- For EPC, the Downlink Data Notification Delay IE, to request the UP function to delay the sending of a PFCP Session Report Request, between receiving a downlink data packet and notifying the CP function about it, if the UP function indicated support of the Downlink Data Notification Delay parameter (see clause 8.2.28); +- the DL Buffering Duration IE, to request the UP function to buffer the downlink data packet for an extended duration without sending any further notification to the CP function about the arrival of DL data packets, if the UP function indicated support of the DL Buffering Duration parameter in PFCP Session Report Response feature and/or support of the DL Buffering Duration parameter in PFCP Session Modification Request feature (see DLBD and DBDM features in clause 8.2.25); +- the DL Buffering Suggested Packet Count in PFCP Session Report Response, to request the UP function to buffer the suggested number of downlink data packets, when extended buffering of downlink data packet is required in the UP function. The DL Buffering Suggested Packet Count may also be included in PFCP Session Modification Request if the UP function indicated support of the DL Buffering Suggested Packet Count parameter in PFCP Session Modification Request feature (see DBDM feature in clause 8.2.25); +- the Suggested Buffering Packet Count IE if the UP Function has indicated support of the feature UDBC, to indicate the number of packets (including both uplink or downlink) that the CP function suggests to be buffered in the UP function, until it receives new instructions from the CP function, e.g. when the new Quota is granted. + +The UP function shall stop applying the DL Buffering Duration and DL Buffering Suggested Packet Count parameters and shall delete these parameters from the BAR (without explicit request from the CP function) when extended buffering of downlink data packets ends in the UP function. + +NOTE: The CP function will provide the DL Buffering Duration and DL Buffering Suggested Packet Count parameters again when re-invoking extended buffering of downlink data packets. + +The UP function shall stop applying buffering when new instruction is received from the CP function. The buffered packets shall be either dropped or forwarded following the packet forwarding model specified in clause 5.2.1 and taking into consideration that the buffered Packets have been already processed earlier. + +## 5.2.5 QoS Enforcement Rule Handling + +### 5.2.5.1 General + +The CP function shall provision QER(s) for a PFCP session in a PFCP Session Establishment Request or a PFCP Session Modification Request to request the UP function to perform QoS enforcement of the user plane traffic. + +### 5.2.5.2 Provisioning of QoS Enforcement Rule in the UP function + +The CP function may request the UP function to perform the following QoS enforcement actions in a QER: + +- Gating Control, as specified in clause 5.4.3; +- QoS Control, i.e. MBR, GBR or Packet Rate enforcement, as specified in clause 5.4.4; +- DL flow level marking for application detection, as specified in clause 5.4.5; +- SCI (Service Class Indicator) marking for service identification for improved radio utilisation for GERAN, as specified in clause 5.4.12; +- for 5GC reflective QoS for uplink traffic. + +### 5.2.5.3 Reflective QoS (for 5GC) + +The 5GS may support Reflective QoS functionality (see clauses 5.7.5 in 3GPP TS 23.501 [28]). + +When the 5GC determines to use Reflective QoS for a specific SDF, the SMF shall set the Reflective QoS Indication (RQI) bit to 1 in the QER associated to the DL PDR for this SDF in a PFCP Session Establishment Request or PFCP Session Modification Request message. + +The SMF may also provision the UPF to perform uplink QoS flow binding verification for the specific SDF as specified in clause 5.4.2. + +When the 5GC determines to no longer use Reflective QoS for a specific SDF, the SMF shall request the UPF to stop applying Reflective QoS for the corresponding downlink traffic, e.g. by setting the Reflective QoS Indication (RQI) bit to 0 in the QER that is associated to the DL PDR or by dissociating the QER from the DL PDR (as appropriate) in a PFCP Session Modification Request message. + +If the SMF had provisioned the UPF to perform uplink QoS flow binding verification for the specific SDF, after an operator configurable time, the SMF shall update the UL PDR(s) to no longer perform uplink QoS flow binding verification for the corresponding uplink traffic and QFI. + +## 5.2.6 Combined SGW/PGW Architecture + +The usage of a combined SGW/PGW remains possible in a deployment with separated control and user planes, see clause 4.2.2 of 3GPP TS 23.214 [2]. This is enabled by supporting a combined Sxa/Sxb interface with a common packet forwarding model, message and parameter structure for non-combined and combined cases. + +The following additional requirements shall apply to a combined Sxa/Sxb interface between a combined SGW/PGW-C and a combined SGW/PGW-U: + +- all the functionalities specified for Sxa and Sxb shall be supported, possibly concurrently, over a combined Sxa/Sxb association; +- a single PFCP session may be setup to support both the functionalities of an SGW-U and PGW-U; +- the CP function may provision PDRs, QERs, URRs, FARs (possibly with a buffering instruction) and BAR, possibly concurrently, for the same PFCP session; +- the CP function may provision concurrently parameters in a message or for the PFCP session that are applicable to Sxa and Sxb. + +## 5.2.7 Multi-Access Rule Handling (for 5GC) + +### 5.2.7.1 General + +The UP function (i.e. the UPF) shall support the Multi-Access Rule (MAR) if it supports the ATSSS feature (see MPTCP, ATSSS-LL and MPQUIC flags in UP Function Features, Table 8.2.25-1). + +The CP function (i.e. the SMF) shall provision in the UP function acting as the PDU Session Anchor (PSA) and supporting the ATSSS feature, one and only one MAR for every downlink PDR corresponding to non-GBR traffic of a PFCP session that is established for a Multi-Access (MA) PDU session. + +The CP function (i.e. the SMF) shall also provision in the UP function acting as the PDU Session Anchor (PSA) and supporting the ATSSS feature, one and only one MAR for every downlink PDR corresponding to GBR traffic of a PFCP session that is established for a Multi-Access (MA) PDU session, if the Steering Mode is "Redundant". + +The MAR provides instructions to the UP function on how to forward the packets matching the PDR over 3GPP and non-3GPP accesses. See clauses 5.8.2.11.8 and 5.32.8 in 3GPP TS 23.501 [28]. + +In an MAR, the CP function (i.e. the SMF) shall: + +- instruct the UPF which traffic steering functionality to use, i.e. either MPTCP, ATSSS-LL or MPQUIC, using the Steering Functionality IE (see clause 8.2.124); +- set the Steering Mode to instruct how the packets shall be distributed across 3GPP and non-3GPP accesses, e.g. "Active-Standby", "Smallest Delay", "Load Balancing", "Priority-based" and "Redundant" (see clause 8.2.125); +- provision access specific forwarding action information including: + - a FAR ID which control the packets forwarding either to 3GPP access or non-3GPP access; + - a Weight to indicate the proportion of traffic to be forwarded by the given FAR when the Steering Mode is set to "Load Sharing"; + - a Priority to indicate at which condition the traffic is to be forwarded by the given FAR when the Steering Mode is set to "Active-Standby" or "Priority-Based"; + - a list of URR IDs to enable the SMF to request separate usage report for different accesses. + +NOTE 1: How the SMF determines the steering functionality and steering mode is specified in clause 5.32.2 of 3GPP TS 23.501 [28]. + +As specified in clause 5.32.8 of 3GPP TS 23.501 [28], in an MAR, the CP function may: + +- provision Threshold values, including a Round Trip Time (RTT) and/or a Packet Loss Rate (PLR), if the Steering Mode is Load Balancing with fixed split percentages, Priority-based, or Redundant; if the Steering Mode is Redundant, either a (maximum) RTT or a (maximum) PLR may be provided, but not both; or +- provision the Priority IE in access specific forwarding action information set to "Primary" or "Secondary" if the Steering Mode is Redundant, to indicate that an access is a primary access or a secondary access; +- include a Steering Mode Indicator to indicate that the default steering parameters provided in the Steering Mode may be adjusted: + - set autonomous load-balance flag to allow the UPF to adjust the traffic steering based on its own decisions when the Steering Mode is Load Balancing; or + - set UE-assistance flag to allow the UPF to adjust the traffic steering based on the UE Assistance Data from UE when the Steering Mode is Load Balancing. + +NOTE 2: The autonomous load-balance flag and the UE-assistance flag can not be set to "1" at the same time. + +The CP function may set the Steering Mode "Redundant" only if the steering functionality is not set to "ATSSS-LL" and if the UP function supports the REDSM (Redundant Steering Mode) feature (see clause 8.2.25). + +The CP function may provision one or more MAR(s) (for different PDRs) per PFCP session. Different MARs of a same PFCP session may be provisioned with a different steering functionality and/or a different steering mode. Different MARs of a same PFCP session may be associated with the same FAR(s). + +If a UE indicates it supports MPTCP and ATSSS-LL, and if the network determines to apply both MPTCP functionality and ATSSS-LL functionality for the UE's PDU session, the CP function shall provision separate downlink PDRs for MPTCP traffic and for Non-MPTCP traffic. Correspondingly, different MARs shall be provisioned and associated with the separate downlink PDRs. The steering functionality shall be set to ATSSS-LL for the MAR associated with the downlink PDR for non MPTCP traffic. + +If a UE indicates it supports MPQUIC and ATSSS-LL, and if the network determines to apply both MPQUIC functionality and ATSSS-LL functionality for the UE's PDU session, the CP function shall provision separated downlink PDRs for MPQUIC traffic and for Non-MPQUIC traffic. Correspondingly, different MARs shall be + +provisioned and associated with the separate downlink PDRs. The steering functionality shall be set to ATSSS-LL for the MAR associated with the downlink PDR for non-MPQUIC traffic. + +If a UE indicates it supports MPTCP, MPQUIC and ATSSS-LL, and if the network determines to apply all MPTCP functionality, MPQUIC functionality and ATSSS-LL functionality for the UE's PDU session, the CP function shall provision separated downlink PDRs for MPTCP traffic, MPQUIC traffic and for non-MPQUIC and non-MPTCP traffic. Correspondingly, different MARs shall be provisioned and associated with the separated downlink PDRs. The steering functionality shall be set to ATSSS-LL for the MAR associated with the downlink PDR for non-MPTCP traffic and non-MPQUIC traffic. + +The UP function shall distribute the downlink traffic across the two access networks (and the two N3/N9 tunnels) according to the instructions received in the MAR and feedback information received from the UE via the user plane (e.g. access network Unavailability or Availability reports for ATSSS-LL received by PMF, see 3GPP TS 24.193 [59]), as specified in clause 5.32.8 of 3GPP TS 23.501 [28]. + +If the autonomous load-balance is set in the Steering Mode Indicator, the Weight shall be treated as the default percentages, and the UPF may autonomously determine its own percentages for traffic splitting to maximize the aggregated bandwidth in the downlink direction. If the UE-assistance is set in the Steering Mode Indicator, the UE may inform the UPF on how it decided to distribute the UL traffic of the matching SDF. + +## 5.2.8 Session Reporting Rule Handling + +### 5.2.8.1 General + +The CP function may provision SRR(s) for a PFCP session in a PFCP Session Establishment Request or a PFCP Session Modification Request to request the UP function to detect and report events for a PFCP session that are not related to specific PDRs of the PFCP session or that are not related to traffic usage measurement. + +- Change of 3GPP or non-3GPP access availability, for an MA PDU session (see clause 5.20.4.2). +- Per QoS flow QoS Monitoring and Reporting, as specified in clauses 5.45 and 5.33.3.2 of 3GPP TS 23.501 [28]. +- Per QoS Flow Traffic Parameter Measurement Report, as specified in clause 5.8.5.11 of 3GPP TS 23.501 [28]. + +### 5.2.8.2 Provisioning of Session Reporting Rule in the UP function + +#### 5.2.8.2.1 General + +When provisioning an SRR, the CP function shall provide control information identifying the events that the UPF is requested to detect and report. If Direct Reporting of QoS monitoring events to Local NEF or AF is supported and required, the CP function shall also provide Direct Reporting Information in the SRR (see clause 5.33.5). + +The CP function may modify an SRR in the PFCP Session Modification Request message. + +The CP function may request the UP function to stop the detection and reporting of specific events by removing the SRR or, if the SRR is used to control different types of events, by updating the SRR with a control information IE for the events to stop with a null length. When so instructed, the UP function shall stop detecting and reporting the corresponding events. + +### 5.2.8.3 Reporting of Session Report to the CP function + +#### 5.2.8.3.1 General + +When detecting that a provisioned event to report occurs, the UP function shall generate a Session Report for the related SRR and send it to the CP function by initiating the PFCP Session Report procedure, unless Direct Reporting of QoS monitoring events to Local NEF or AF applies (see clause 5.33.5). + +Upon generating a session report for an SRR towards the CP function or towards the Local NEF or AF if Direct Reporting of QoS monitoring event applies, the UP function shall continue to apply all the provisioned SRR(s), until getting any further instruction from the CP function. + +## 5.2.9 Handling of Rules that cannot be activated + +The CP function shall indicate support of the Partial Success (PSUCC) feature (see clause 8.2.58) during the PFCP association setup or update procedure, if it supports PFCP session establishment or modification with Partial Success, i.e. with the UP function partially accepting a PFCP session establishment or modification request when some rules requested to be created or modified cannot be applied, e.g. when a pre-defined rule name or pre-defined rule ID is not configured in the UP function. + +If the CP function indicated support of the the PSUCC feature, and if this feature is also supported by the UP function, the UP function should partially accept a PFCP session establishment or modification request, if possible, even when it fails to create or modify one or more rules. In such a case, the UP function shall set the cause to "Request partially accepted" in the response and include the Partial Failure Information IE identifying the rules that the UP function could not activate and the cause of the failure. + +NOTE: Partial acceptance of a request is not possible in some cases, when the failure to activate a rule would result in a PFCP session state that is not consistent, e.g. if no PDR or FAR would end up being activated for the PFCP session. Details on the conditions when a request can be partially accepted or not are left to UP function implementation. + +Upon receipt of a PFCP session establishment or modification response indicating a partial acceptance of the request, the CP function shall consider that not all rules were successfully activated in the UP function and determine those which failed to be activated based on the Partial Failure Information IE in the response. + +If the CP function or the UP function does not support the PSUCC feature, the UP function shall reject a PFCP session establishment or modification request if at least one rule fails to be applied. + +## 5.3 Data Forwarding between the CP and UP Functions + +### 5.3.1 General + +Forwarding of user plane data between the CP and UP functions may take place as part of the following scenarios (see 3GPP TS 23.214 [2] for EPC and 3GPP TS 23.501 [28] for 5GC). + +**Table 5.3.1-1: Data forwarding scenarios between the CP and UP functions** + +| | Scenario description | Data forwarding direction | For EPC applicable to | For 5GC applicable to | +|---|-----------------------------------------------------------------------------------------------|----------------------------------------|-----------------------|--------------------------| +| 1 | Forwarding of user-plane packets between the UE and the CP function. | UP to CP function
CP to UP function | PGW | UPF to SMF
SMF to UPF | +| 2 | Forwarding of packets between the CP function and the external PDN (over SGi) / DN (over N6). | UP to CP function
CP to UP function | PGW | UPF to SMF
SMF to UPF | +| 3 | Forwarding of packets subject to buffering in the CP function. | UP to CP function
CP to UP function | SGW | UPF to SMF
SMF to UPF | +| 4 | Forwarding of End Marker Packets constructed by the CP function to a downstream node. | CP to UP function | SGW, PGW | SMF to UPF | +| 5 | Forwarding of user data using Control Plane CLoT 5GS Optimisation | UP to CP function
CP to UP function | - | UPF to SMF
SMF to UPF | + +User plane packets shall be forwarded between the CP and UP functions by encapsulating the user plane packets using GTP-U encapsulation (see 3GPP TS 29.281 [3]). + +For forwarding data from the UP function to the CP function, the CP function shall provision PDR(s) per PFCP session context, with the PDI identifying the user plane traffic to forward to the CP function and with a FAR set with the Destination Interface "CP function side" and set to perform GTP-U encapsulation and to forward the packets to a GTP-u F-TEID uniquely assigned in the CP function per PFCP session and PDR. The CP function shall then identify the PDN connection and the bearer to which the forwarded data belongs by the F-TEID in the header of the encapsulating GTP-U packet. + +For forwarding data from the CP function to the UP function, the CP function shall provision one or more PDR(s) per PFCP session context, with the PDI set with the Source Interface "CP function side" and identifying the GTP-u F-TEID uniquely assigned in the UP function per PDR, and with a FAR set to perform GTP-U decapsulation and to forward the packets to the intended destination. URRs and QERs may also be configured. + +For EPC PFCP session contexts may correspond to individual PDN connections, TDF sessions, or standalone sessions not tied to any PDN connection or TDF session used e.g. for forwarding RADIUS, Diameter or DHCP signalling between the PGW-C and the PDN or for forwarding End Marker packets from the PGW-C or SGW-C to a downstream SGW-U or eNodeB. + +For 5GC PFCP session contexts may correspond to individual PDU sessions or standalone sessions not tied to any PDU sessions used e.g. for forwarding RADIUS, Diameter or DHCP signalling between the SMF and the DN or for forwarding End Marker packets from the SMF to a downstream UPF or NG-RAN. + +For EPC the CP function may establish one Sx-u tunnel per: + +- bearer of PDN connection e.g. for the data forwarding scenarios 1 and 3; +- UP function or PDN e.g. for the data forwarding scenario 1, 2 and 4. + +For 5GC the CP function may establish one N4-u tunnel per: + +- PDU session e.g. for the data forwarding scenarios 1, 3 and 5; +- UP function or DN e.g. for the data forwarding scenario 1, 2 and 4. + +Requirements for forwarding packets subject to buffering in the CP function between the UP and CP functions (scenario 3) are further specified in clause 5.3.3. + +Requirements for sending End Marker packets (scenario 4) are further specified in clause 5.3.2. + +Requirements for forwarding user data using Control Plane CIoT 5GS Optimisation between the UP and CP functions (scenario 5) are further specified in clause 5.3.5. + +## 5.3.2 Sending of End Marker Packets + +The construction of End Marker packets may either be done in the CP function or UP function, based on network configuration, as specified in clause 5.8 of 3GPP TS 23.214 [2] for EPC and in clause 5.8.2.9 of 3GPP TS 23.501 [28] for 5GC. The support of End Marker packets by the UP function is optional. + +A UP function complying with this release of the specification shall support constructing End Marker packets in the UP function and shall indicate so to the CP function by setting the EMPU flag in the UP Function Features (see clause 8.2.25). + +A CP function complying with this release of the specification should request the UP function to construct End Marker packets. If so, the CP function shall request the UP function to construct and send End Marker packets by sending a Session Modification Request including FAR(s) with the new downstream F-TEID and with the SNDEN (Send End Marker Packets) flag set. + +For End Marker packets constructed in the CP function, the CP function shall: + +- establish (once) one standalone PFCP session not tied to any PDN connection, per the UP function, for forwarding End Marker packets, and provision the UP function to perform one GTP-U decapsulation and to forward the resulting packets without any further change towards the destination IP address of these packets; +- construct the GTP-U End Marker packets, with the destination IP address and TEID set according to the old F-TEID value, and with a source IP address set according to the UP function's F-TEID value (e.g. S1 or Iu SGW F-TEID or NG-u UPF F-TEID); +- encapsulate the constructed GTP-U End Marker packets in GTP-U packets according to the principles specified in clause 5.3.1 for data forwarding between the CP function and the UP function, and send them towards the F-TEID assigned in the UP function for the above PFCP session, after receipt of the PFCP Session Modification Response indicating that the UP function has switched to a new F-TEID. + +Upon receipt of a PFCP Session Modification Request modifying the F-TEID in the Outer Header Creation of a FAR, the UP function shall send the Response message only after having switched to the new F-TEID. + +### 5.3.3 Forwarding of Packets Subject to Buffering in the CP Function + +#### 5.3.3.1 General + +The following requirements shall apply to the data forwarding scenario 3 of Table 5.3.1-1 in addition to the requirements specified in clause 5.3.1. + +The CP function shall establish one Sx-u tunnel per bearer of a PDN connection / one N4-u tunnel per PDU session when applying the data forwarding scenario 3. + +#### 5.3.3.2 Forwarding of Packets from the UP Function to the CP Function + +For EPC, regardless of whether the downlink traffic received by the UP function consists of T-PDUs (i.e. user data packet, see 3GPP TS 29.281 [3]) for a combined SGW/PGW-U, or G-PDUs (i.e. T-PDU plus a GTP-U header) for a SGW-U, the downlink traffic shall be forwarded from the UP function to the CP function as G-PDUs with the GTP-U header set to the IP address and TEID uniquely assigned in the CP function for the Sx-u tunnel corresponding to the bearer of the PDN connection. + +NOTE 1: An SGW-U receiving G-PDUs from an S5/S8 bearer forwards the same G-PDUs towards the SGW-C but with the IP address and TEID in the GTP-U header changed to the SGW-C IP address and TEID of the corresponding Sx-u tunnel. + +For 5GC, regardless of whether the downlink traffic received by the UP function consists of T-PDUs (i.e. user data packet, see 3GPP TS 29.281 [3]) for an PSA-UPF, or G-PDUs (i.e. T-PDU plus a GTP-U header) for an I-UPF, the downlink traffic shall be forwarded from the UP function to the CP function as G-PDUs with the GTP-U header set to the IP address and TEID uniquely assigned in the CP function for the N4-u tunnel corresponding to the PDU session of the PDN connection. + +NOTE 2: An I-UPF receiving G-PDUs from an N9 GTPU tunnel forwards the same G-PDUs towards the SMF but with the IP address and TEID in the GTP-U header changed to the SMF IP address and TEID of the corresponding N4-u tunnel. + +To forward the user plane data to be buffered in the CP function from the UP function, the CP function shall provision: + +- for EPC, a PDR per bearer of the PDN connection, matching the received downlink user plane packets and for a (non-combined) SGW-U, with the field Outer Header Removal Description in the Outer Header Removal IE set to "0" or "1" for IPv4 or IPv6 respectively; +- for 5GC, a PDR per PDU session, matching the received downlink user plane packets and for an I-UPF, with the field Outer Header Removal Description in the Outer Header Removal IE set to "0" or "1" for IPv4 or IPv6 respectively; +- a FAR instructing the UP function to forward the received downlink data to the CP function, with the field Outer Header Creation Description in the Outer Header Creation set to "0" or "1". + +NOTE 3: The PDR can be provisioned in the UP function before applying data forwarding to the CP function. + +For EPC, G-PDUs sent from the UP function to the CP function over the Sx-u tunnel shall include any GTP-U extension header(s): + +- possibly received by the UP function over the S5/S8 bearers and stored during the Outer Header Removal; +- possibly created by the UP function as part of a QER rule. + +For 5GC, G-PDUs sent from the UP function to the CP function over the N4-u tunnel shall include any GTP-U extension header(s): + +- possibly received by the UP function over the N9 PDU sessions and stored during the Outer Header Removal; +- possibly created by the UP function as part of a QER rule. + +### 5.3.3.3 Forwarding of Packets from the CP Function to the UP Function + +Likewise, when subsequently sending the downlink traffic buffered in the CP function back to the UP function, the downlink traffic shall be forwarded: + +- for EPC, over Sx-u as G-PDUs with the GTP-U header set to the IP address and TEID uniquely assigned in the UP function for the Sx-u tunnel set up for the corresponding bearer of the PDN connection; +- for 5GC, over N4-u as G-PDUs with the GTP-U header set to the IP address and TEID uniquely assigned in the UP function for the N4-u tunnel set up for the corresponding PDU session. + +G-PDUs sent over Sx-u / N4-u shall include GTP-U extension header(s) possibly received earlier from the UP function. + +To forward the user plane data from the CP function to the UP function, the CP function shall provision: + +a PDR per bearer of the PDN connection (for EPC) or per PDU session (for 5GC), with an IP address and TEID uniquely assigned in the UP function for the Sx-u / N4-u tunnel, and with the field Outer Header Removal Description in the Outer Header Removal IE set to "0" or "1"; + +- a FAR enabling the UP function to forward the received downlink data from the CP function towards the RAN, with the field Outer Header Creation Description in the Outer Header Creation set to "0" or "1". + +G-PDUs sent from the UP function towards the RAN shall include GTP-U extension header(s) possibly received from the CP function. + +## 5.3.4 Data Forwarding between the CP and UP Functions with one PFCP-u Tunnel per UP Function or PDN + +### 5.3.4.1 General + +The following requirements shall apply to the data forwarding scenario 1 and 2 of Table 5.3.1-1, when establishing one PFCP-u tunnel per UP function or PDN, in addition to the requirements specified in clause 5.3.1. + +### 5.3.4.2 Forwarding of Packets from the UP Function to the CP Function + +Regardless of whether the traffic received by the UP function consists of T-PDUs (i.e. user data packet, see 3GPP TS 29.281 [3]) from SGi / N6 or G-PDUs (i.e. T-PDU plus a GTP-U header) from the UE, the traffic shall be forwarded from the UP function to the CP function as G-PDUs with the GTP-U header set to the IP address and TEID uniquely assigned in the CP function for the PFCP-u tunnel corresponding to the UP function or PDN. + +To forward the user plane data to from the UP function, the CP function shall provision: + +- for supporting data forwarding scenario "1" as specified in clause 5.3.1, an additional PDR for a PFCP session established for a PDN connection or a PDU session which requires such data forwarding, matching the received user plane packets from uplink direction. The Outer Header Removal IE shall not be present if the complete G-PDU is required to be forwarded, otherwise the Outer Header Removal IE shall be present and set to "0" or "1" for IPv4 or IPv6 respectively; +- for supporting data forwarding scenario "2" as specified in clause 5.3.1, a PDR matching the received user plane packets from downlink direction; +- a FAR instructing the UP function to forward the received data to the CP function, with the field Outer Header Creation Description in the Outer Header Creation set to "0" or "1" for IPv4 or IPv6 respectively, and the Outer GTP-U header set to the IP address and TEID uniquely assigned in the CP function for the Sx-u tunnel. + +### 5.3.4.3 Forwarding of Packets from the CP Function to the UP Function + +When sending user plane data from the CP function, the traffic shall be forwarded over PFCP-u as: + +- T-PDUs encapsulated in GTP-U with the GTP-U header set to the IP address and TEID uniquely assigned in the UP function for the PFCP-u tunnel set up for the UP function or PDN or DN for traffic to be sent towards SGi or N6; or + +- G-PDUs encapsulated in GTP-U with the outer GTP-U header set to the IP address and TEID uniquely assigned in the UP function for the PFCP-u tunnel set up for the UP function and with the inner GTP-U header set to the F-TEID assigned by the downstreams GTP-U peer (e.g. SGW, I-UPF) to the bearer over which the data shall be sent. + +To forward the user plane data from the CP function to the UP function, the CP function shall provision: + +- a PDR per UP function, with an IP address and TEID uniquely assigned in the UP function for the PFCP-u tunnel, and with the field Outer Header Removal Description in the Outer Header Removal IE set to "0" or "1"; +- an FAR enabling the UP function to forward the received data from the CP function. + +### 5.3.5 Forwarding of user data using Control Plane CIoT 5GS Optimisation (for 5GC) + +#### 5.3.5.1 General + +The following requirements shall apply to the data forwarding scenario 5 of Table 5.3.1-1 in addition to the requirements specified in clause 5.3.1. + +The CP function shall establish one one N4-u tunnel per PDU session when applying the data forwarding scenario 5. + +#### 5.3.5.2 Forwarding of Packets from the UP Function to the CP Function + +Regardless of whether the downlink traffic received by the UP function consists of T-PDUs (i.e. user data packet, see 3GPP TS 29.281 [3]) from N6 or G-PDUs (i.e. T-PDU plus a GTP-U header) received from N9, the downlink traffic shall be forwarded from the UP function to the CP function as G-PDUs with the GTP-U header set to the IP address and TEID uniquely assigned in the CP function for the N4-u tunnel corresponding to the PDU session. + +- NOTE: A UPF receiving G-PDUs from N9 forwards the G-PDUs towards the SMF but with the IP address and TEID in the GTP-U header changed to the SMF IP address and TEID of the corresponding N4-u tunnel. + +To forward the user plane data from the UP function to the CP function, the CP function shall provision: + +- a PDR per PDU session, matching the received downlink user plane packets, and for traffic received from N9, with the field Outer Header Removal Description in the Outer Header Removal IE set to "0" or "1" for IPv4 or IPv6 respectively; +- a FAR instructing the UP function to forward the received downlink data to the CP function, with the field Outer Header Creation Description in the Outer Header Creation set to perform GTP-U/UDP/IPv4 or GTP-U/UDP/IPv6 encapsulation. + +- NOTE: The PDR can be provisioned in the UP function before applying data forwarding to the CP function. + +G-PDUs sent from the UP function to the CP function over the N4-u tunnel shall include any GTP-U extension header(s): + +- possibly received by the UP function over the N9 interface and stored during the Outer Header Removal; +- possibly created by the UP function as part of a QER rule. + +#### 5.3.5.3 Forwarding of Packets from the CP Function to the UP Function + +Likewise, when sending the uplink traffic received in the CP function to the UP function, the uplink traffic shall be forwarded over N4-u as G-PDUs with the GTP-U header set to the IP address and TEID uniquely assigned in the UP function for the N4-u tunnel set up for the corresponding PDU session. + +To forward the user plane data from the CP function to the UP function, the CP function shall provision: + +- a PDR per PDU session, with an IP address and TEID uniquely assigned in the UP function for the N4-u tunnel, and with the field Outer Header Removal Description in the Outer Header Removal IE set to "0" or "1"; +- an FAR enabling the UP function to forward the received uplink data from the CP function. + +## 5.4 Policy and Charging Control + +### 5.4.1 General + +This clause describes how Policy and Charging Control requirements are supported over the Sxa, Sxb, Sxc and N4 reference points. + +### 5.4.2 Service Detection and Bearer/QoS Flow Binding + +Service detection refers to the process that identifies the packets belonging to a service data flow or application. For EPC, see clauses 6.2.2.2 and 6.8.1 of 3GPP TS 23.203 [7]. For 5GC, see clause 6.2.2.2 of 3GPP TS 23.503 [44]. + +For EPC, bearer binding is the procedure that associates service data flow(s) to an IP-CAN bearer deemed to transport the service data flow. UL bearer binding verification refers to the process of discarding uplink packets due to no matching service data flow template for the uplink direction. See clauses 6.1.1.4 and 6.2.2.2 of 3GPP TS 23.203 [7]. + +For 5GC, QoS flow binding is the procedure that associates service data flow(s) to a QoS flow deemed to transport the service data flow. UL QoS flow binding verification refers to the process of discarding uplink packets due to no matching QoS flow for the uplink direction. See clause 6.1.3.2.4 of 3GPP TS 23.503 [44] and clause 5.7.1.7 of 3GPP TS 23.501 [28]. + +For 5MBS, QoS flow binding is the procedure that associates a PCC rule to a QoS Flow within an MBS Session. See clause 6.10 in 3GPP TS 23.247 [72]. + +Service detection is controlled over the Sxa, Sxb, Sxc and N4 reference points by configuring Packet Detection Information in PDRs to match the intended service data flows or application. + +For EPC, the mapping of DL traffic to bearers is achieved by configuring and associating FARs to the downlink PDRs, with FARs set to forward the packets to the appropriate downstream bearers (S5/S8 or S1/S12/S4/Iu). + +For 5GC, the mapping of DL traffic to QoS flows is achieved by configuring QERs with QFI(s) for the QoS flow marking and associating FARs to the downlink PDRs, with FARs set to forward the packets to the appropriate downstream GTP-U tunnel (N9 or N3). + +For EPC, uplink bearer binding verification is achieved by configuring Packet Detection Information in uplink PDRs containing the local F-TEID of the uplink bearer, the UE IP address (source IP address to match for the incoming packet), and the SDF filter(s) or the Application ID. As a result, uplink packets received on the uplink bearer but that do not match the SDF filter(s) or Application detection filter associated to the uplink PDRs are discarded. + +For 5GC, uplink QoS flow binding verification (see clause 5.7.1.7 of 3GPP TS 23.501 [28]) is achieved by configuring Packet Detection Information in uplink PDRs containing the local F-TEID of the uplink PDU session, the UE IP address (source IP address to match for the incoming packet), the QFI of the QoS flow and the SDF filter(s) or the Application ID. As a result, uplink packets received on the uplink PDU session but that do not match the SDF filter(s) or Application detection filter and QFI associated to the uplink PDRs are discarded. + +NOTE 1: For PCC Rules that contain an application identifier (i.e. that refer to an application detection filter), uplink traffic can be received on other IP-CAN bearers than the one determined by the binding mechanism. The detection of the uplink part of the service data flow can be activated in parallel on other bearers with non-GBR QCI (e.g. the default bearer) in addition to the bearer where the PCC rule is bound to. See clauses 6.1.1.1 and 6.2.2.2 of 3GPP TS 23.203 [7]. Therefore the uplink PDRs for these bearers can be provisioned with the PDI containing this service data flow and the local F-TEID of the uplink bearer. + +NOTE 2: To avoid the PGW-U discarding packets due to no matching service data flow template, the operator can apply open PCC rules (with wildcarded SDF filters) to allow for the passage of packets that do not match any other candidate SDF template. Therefore an uplink PDR can be provisioned with the PDI containing only the local F-TEID of the uplink bearer. + +NOTE 3: Uplink bearer binding does not apply to Non-IP PDN connections. + +NOTE 4: The UPF can be provisioned with a PDR (with low precedence) which contains the CN tunnel info, QFI and filter information that can detect any unwanted/unauthorized traffic with this QFI so that such traffic can be dropped with or without being counted before. + +### 5.4.3 Gating Control + +Gating control refers to the process within the user plane function (i.e. PGW-U and TDF-U for EPC, UPF for 5GC) of enabling or disabling the forwarding of IP packets, belonging to a service data flow or detected application's traffic, to pass through to the desired endpoint (for EPC see clause 4.3.2 of 3GPP TS 23.203 [7] and for 5GC see clause 4.3.3.1 of 3GPP TS 23.503 [44]). + +The PGW-C and TDF-C (for EPC) and the SMF (for 5GC) controls the gating in the PGW-U and TDF-U (for EPC) and in the UPF (for 5GC) by creating PDR(s) for the service data flow(s) or application's traffic to be detected, and by associating a QER, including the Gate Status IE, to the PDRs. + +The Gate Status IE indicates whether the service data flow or detected application traffic is allowed to be forwarded (the gate is open) or shall be discarded (the gate is closed) in the uplink and/or in downlink directions. + +The PGW-U and TDF-U (for EPC) and the UPF (for 5GC) shall identify UL and DL flows by the Source Interface IE in the PDI of the PDRs or the Destination Interface IE in the FARs. The PGW-U and TDF-U (for EPC) and the UPF (for 5GC) shall apply UL and DL gating accordingly. + +The UP function shall discard packets matching a PDR if the PDR is associated with at least one QER provisioned with the Gate Status set to CLOSED. + +### 5.4.4 QoS Control + +QoS control refers to the authorization and enforcement of the maximum QoS that is authorized: + +- for EPC, + - at the session level (APN-AMBR, TDF session UL and DL bitrates, or UL and DL Packet Rate of a PDN connection); + - at the bearer level (GBR, MBR for GBR bearers); + - at the service data flow (SDF) or application level. +- for 5GC, + - at the session level (Session-AMBR or UL and DL Packet Rate of a PDU session); + - at the QoS Flow level; + - at the service data flow (SDF) or application level. + +See clause 4.3.3 of 3GPP TS 23.203 [7] clause 4.5.5 of 3GPP TS 29.212 [8] and clause 4.7.7 of 3GPP TS 23.401 [14]. + +The CP function shall control the QoS enforcement in the UP function by: + +- creating the necessary PDR(s) to represent the service data flow, application, QoS Flow (for 5GC), bearer or session, if not already existing; +- creating QERs for the QoS enforcement at session level, SDF/application level; +- creating QERs for the QoS enforcement of the aggregate of SDFs with the same GBR QCI; +- creating QERs for the QoS enforcement of the aggregate of SDFs with the same GBR QFI (for 5GC); +- associating the session level QER to all the PDRs defined for the session; +- associating the SDF or application QER to the PDRs associated to the SDF or application; +- associating the QER of the aggregate of SDFs to the PDRs associated to SDFs or applications that share the QER. + +The same QER may be associated to UL and DL PDRs. The UP function shall identify the UL and DL flows by the Source Interface IE in the PDRs or the Destination Interface IE in the FARs. The UP function shall enforce the QoS for the UL or DL flows accordingly. + +The CP function shall map the precedence of a PCC rule to the precedence of the PDRs associated to the corresponding service data flows. + +## 5.4.5 DL Flow Level Marking for Application Detection + +DL flow level marking is performed using DL DSCP marking. DL DSCP marking for application indication refers to the process in the TDF of marking detected downlink application traffic with a DSCP value received within an installed ADC rule matching this traffic. See Annex U of 3GPP TS 23.203 [7] and clauses 4.5.2.7 and 4b.5.14 of 3GPP TS 29.212 [8]. + +DL DSCP marking for application indication is controlled by the TDF-C by associating a QER, including the ToS or Traffic Class within the DL Flow Level Marking IE, to the PDR matching the DL traffic to be marked. The TDF-U performs the DL DSCP marking for the detected DL traffic and sends the marked packet to the PGW-U. + +If a tunnelling protocol is used between the TDF-U and the PGW-U, the DSCP value for service data flow detection shall be carried in the inner IP header. + +The TDF-C may stop the DL DSCP marking for the application during the PFCP session by removing the related QER or removing the DL Flow Level Marking IE from the related QER, the TDF-U shall then stop such function consequently. + +Policy and charging control in the downlink direction by the PCEF for an application detected by the TDF is performed by the PGW-C configuring a PDR with a PDI containing an SDF Filter with the corresponding DSCP value. + +## 5.4.6 Usage Monitoring + +Usage Monitoring Control refers to the process of monitoring the user plane traffic in the PGW-U, TDF-U or UPF for the accumulated usage of network resources per: + +- individual or group of service data flows; +- individual or group of applications; +- PDU session, possibly excluding an individual SDF or a group of service data flow(s) (for 5GC); +- IP-CAN session, possibly excluding an individual SDF or a group of service data flow(s) (for EPC); and/or +- TDF session, possibly excluding an individual application or a group of application(s) (for EPC). + +For EPC, see clauses 4.4, 6.2.2.3 and 6.6 of 3GPP TS 23.203 [7] and clauses 4.5.16, 4.5.17, 4b.5.6, 4b.5.7 of 3GPP TS 29.212 [8]. + +For 5GC, see clauses 4.3.4 and 6.2.2.3 of 3GPP TS 23.503 [44] and clauses 4.2.2.10, 4.2.3.11, 4.2.4.10, 4.2.6.2.5, 4.2.6.5.3 of 3GPP TS 29.512 [41]. + +Usage Monitoring Control is supported over the Sxb, Sxc and N4 reference points by activating in the UP function the reporting of usage information towards the CP function, as specified in clauses 5.3 and 7.8.4 of 3GPP TS 23.214 [2] and in clause 5.8.2.6.2 of 3GPP TS 23.501 [28]. + +The CP function shall control the Usage Reporting in the UP function by: + +- creating the necessary PDR(s) to represent the service data flow, application or session; +- creating a URR for each Monitoring key; and +- associating the URR to: + - all the PDRs of the PFCP session, for usage monitoring at IP-CAN or TDF session level, possibly excluding the PDRs matching the SDFs or Applications excluded from the usage monitoring at session level; or + - the PDR(s) of the PFCP session associated to the individual or group of SDF(s) or Application(s), for usage monitoring at SDF or application level. + +## 5.4.7 Traffic Redirection + +Traffic Redirection refers to the process of redirecting uplink application traffic, in a PGW, TDF or UPF, towards a redirect destination, e.g. redirect some HTTP flows to a service provisioning page. For EPC, see clause 6.1.13 of 3GPP TS 23.203 [7] and clauses 4.5.2.6 and 4b.5.1.4 of 3GPP TS 29.212 [8]. For 5GC, see clause 6.1.3.12 of 3GPP TS 23.503 [44] and clause 4.2.6.2.4 of 3GPP TS 29.512 [46]. + +The redirect destination may be provided by the PCRF/PCF or be preconfigured in the CP function or in the UP function. + +For EPC and 5GC, the traffic redirection shall be enforced in the UP function. If the traffic that the UP function can support may be subject to traffic redirection, traffic redirection enforcement in the UP function shall be supported by the UP function. The UP function reports to the CP function whether it supports traffic redirection enforcement in the UP function via the UP Function Features IE (see clause 8.2.25). + +**NOTE:** A UP function that supports traffic not requiring traffic redirection does not need to support traffic redirection enforcement in the UP function. The CP function can select a UP function supporting traffic redirection enforcement in the UP function for users or services which may require traffic redirection. + +To enforce the traffic redirection in the UP function, the CP function shall: + +- create the necessary PDR(s) to represent the traffic to be redirected, if not already existing; + - create a FAR with: + - the Redirect Information IE including the redirect destination, if the traffic needs to be redirected towards a redirect destination provided by the CP function; a redirect destination provided by the CP function shall prevail over a redirect destination preconfigured in the UP function; + - For HTTP traffic redirection, the Redirection Address Type shall be set to "URL" and the CP function shall set the Destination Interface IE in the FAR to "Access" (to forward the HTTP response message with a status code indicating redirect). For other types of traffic redirection, the Destination Interface IE in the FAR may be set to "Core"; +- or +- the Forwarding Policy IE including the identifier of the forwarding policy to apply, if the traffic needs to be redirected towards a redirect destination preconfigured in the UP function; + - associate the FAR to the above PDRs of the PFCP session. + +## 5.4.8 Traffic Steering + +Traffic Steering refers to the process of applying a specific (S)Gi-LAN traffic steering policy in the PCEF or TDF (or TSSF), or a specific N6-LAN traffic steering policy in the UPF (PDU Session Anchor), for the purpose of steering the subscriber's traffic to appropriate operator or 3rd party service functions (e.g. NAT, antimalware, parental control, DDoS protection) in the (S)Gi-LAN or N6-LAN, per service data flows level or applications level. + +Application Function influencing traffic routing (see clause 5.6.7 of 3GPP TS 23.501 [28]) also uses traffic steering for the purpose of steering the subscriber's traffic over N6, e.g. to a local access to a Data Network. + +Application Function influence on Service Function Chaining (see clause 5.6.16.2 of 3GPP TS 23.501 [28]) enables an AF to request the steering of user plane traffic to a pre-configured chain of service functions on N6-LAN. + +The UP function shall set the TRST feature flag in the UP Function Features IE if it supports Traffic Steering (see clause 8.2.25). The UP function shall additionally set the AFSFC feature flag in the UP Function Features IE if it supports Traffic Steering and support using Metadata (see clause 8.2.25). + +Traffic Steering is supported over the Sxb, Sxc and N4 reference points by instructing the UP function to apply a specific Forwarding Policy, that is locally configured in the UP function and that can be used for the uplink, the downlink or for both directions. A Forwarding Policy is identified by a Forwarding Policy Identifier. Traffic steering is alternatively supported over the N4 reference point by instructing the UP function to route packets according to N6 routing information in the FAR (e.g. providing an IP address in the Outer Header Creation). + +When so instructed, the UP function shall perform the necessary actions to enforce the forwarding policy referenced by the CP function, e.g. performing packet marking and routing the traffic towards the service functions within the (S)Gi-LAN or N6-LAN. + +See 3GPP TS 23.203 [7], 3GPP TS 29.212 [8] and 3GPP TS 23.501 [28]. + +The CP function shall control Traffic Steering towards SGi-LAN, N6-LAN and/or N6 in the UP function by: + +- creating the necessary PDRs to represent the service data flows or applications to be steered; +- creating a FAR with the Forwarding Policy IE including the Forwarding Policy Identifier set to the Traffic Steering Policy Identifier, or creating a FAR with an Outer Header Creation with the destination IP address; and +- associating the FAR to the above PDRs of the PFCP session. + +The CP function shall control the processing of the traffic received from the (S)Gi-LAN or N6-LAN in the UP function as specified in the rest of this specification for traffic received from any other interface, but with PDR(s) including a PDI with the Source Interface indicating "SGi-LAN/N6-LAN". The UP function shall distinguish packets coming from (S)Gi-LAN/N6-LAN based on local configuration. + +**NOTE:** In some cases, the traffic needs be steered towards service chaining functions within the N6-LAN first and then the same traffic can come back to the UPF and be further steered towards the Data Network or UE. In such scenario, as an implementation and/or deployment option, e.g. for the uplink traffic, the CP function can generate two pairs of PDRs and FARs, one is to instruct the UP function to detect the relevant uplink traffic and to steer the traffic to the N6-LAN; the other is to instruct the UP function to detect the same traffic sent back from the Service Chaining Functions and steer it to the Data Network. It is assumed in both PDRs, the same packet filters and/or application ID on packet detection is used. + +## 5.4.9 Provisioning of Predefined PCC/ADC Rules + +A Predefined PCC rule is preconfigured in the PCEF, e.g. a PGW (for EPC) or SMF (for 5GC). Predefined PCC rules can be activated or deactivated by the PCRF/PCF at any time. The Predefined PCC rules may be grouped allowing the PCRF/PCF to dynamically activate a set of PCC rules. + +For EPC a predefined ADC rule is preconfigured in the TDF. In the case of solicited reporting, the Predefined ADC rules can be activated or deactivated by the PCRF at any time. Predefined ADC rules within the TDF may be grouped allowing the PCRF to dynamically activate a set of ADC rules. + +For the definition of PCC and ADC rules see clauses 4.3.1 and 4b.3.2 of 3GPP TS 29.212 [8] and clause 5.6.2.6 of 3GPP TS 29.512 [41]. + +The CP function may enforce an activated predefined PCC or ADC rule by the PCRF/PCF in the UP function by: + +- determining the service data filters or application IDs referred by the activated predefined PCC or ADC rule(s) and the corresponding QoS and charging control information respectively; +- creating the necessary PDR(s) to identify the service data flow(s), application(s) that the predefined PCC or ADC rule refer to, if not already existing; +- creating the necessary QER for the QoS enforcement at service data flow or application level accordingly; +- creating the necessary FAR if a new FAR needs to be created as result of Bearer binding (for EPC) or QoS flow binding (for 5GC) and QoS control for forwarding the detected service data flow or application traffic, or to redirect or to apply traffic steering control if included in the predefined PCC/ADC rule; +- creating the necessary URR(s) for each monitoring key, charging key, combination of Charging Key and Service ID, or combination of Charging Key, Sponsor ID and Application Service Provider Id if included in the predefined PCC or ADC rule; + +and then: + +- associating the created URR(s) to the newly created PDR(s); +- associating the existing FAR or the new FAR to the newly created PDR(s); + +Optionally, the traffic handling policies common to many PFCP sessions (i.e. predefined PDR(s) / QER(s) / FAR(s) / URR(s)) may be configured in the UP function. The CP function may activate these traffic handling policies by including the Activate Predefined Rules IE or by including predefined FAR/URR/QER ID(s) (of which the most significant bit is set to "1") within: + +- the Create PDR IE in an PFCP Session Establishment Request; or +- the Update PDR IE in an PFCP Session Modification Request. + +If the CP function activates the traffic handling policies by including predefined FAR/URR/QER ID(s), i.e. where bit 8 is set to "1", then Create/Update FAR/URR/QER IE(s) that shares the same ID shall not be present. + +If the received Create/Update PDR IE contains both the Activate Predefined Rules IE and a predefined FAR/URR/QER ID (bit 8 set to "1"), it is an implementation matter how the UPF handles the message. The UPF shall either overwrite the FAR/URR/QER referenced by the Activate Predefined Rules IE with those referenced by the received FAR/URR/QER ID, or reject the message with the Cause value "Rule creation/modification Failure" and the Failed Rule ID IE (see clause 8.2.1). + +NOTE 1: The Create/Update PDR IE can contain only dynamic FAR/URR/QER ID. Such dynamic rules provision the UPF with information that was not preconfigured, e.g. with a remote GTP-U F-TEID. + +For traffic matching PDR(s) associated with the activated predefined rules, the UP function shall enforce the rules, e.g. for URR, the UP function shall generate Usage Report(s) and send it to the CP function and the CP function shall be able to handle the usage reports as described in clause 5.2.2. + +NOTE 2: The URR IDs used in reports triggered by a predefined rule in UP function are also pre-configured at the CP function. + +The URR ID used in the usage report may be a predefined URR ID or a URR ID dynamically provisioned by the CP function. + +For deactivating predefined rules which have been activated in the UP function using a Predefined Rule Name, the CP function shall include the Deactivate Predefined Rules IE in the Update PDR IE in a PFCP Session Modification Request to inform the UP function to deactivate the corresponding predefined rules for the related PDR. + +For deactivating predefined FAR(s) /URR(s) / QER(s) which have been activated in the UP function by including predefined FAR/URR/QER ID(s) in the Create PDR IE or Update PDR IE, the CP function may include Remove FAR IE(s), Remove URR IE(s) and/or Remove QER IE(s) to delete the corresponding predefined FAR/URR/QER ID in an PFCP Session Modification Request message. + +NOTE 3: Using Remove FAR IE(s), Remove URR IE(s) and Remove QER IE(s) does not result in any change to predefined rules that was activated using the Activate Predefined Rules IE. Such predefined rules continue to apply if still activated for the PDR. + +## 5.4.10 Charging + +For EPC, the charging requirements for online and offline charging in the PS domain specified in 3GPP TS 32.251 [17] shall be preserved with a split SGW, PGW and TDF architecture. + +For 5GC, the charging requirements for online and offline charging in the 5G data connectivity domain are specified in 3GPP TS 32.255 [45]. + +Charging is supported by the CP function by activating in the UP function the measurement and reporting of the accumulated usage of network resources per: + +- for EPC: + - IP-CAN bearer, for an SGW; + - IP-CAN bearer, IP-CAN session and/or individual or group of service data flows, for a PGW; + - TDF session and/or individual or group of applications, for a TDF; +- for 5GC: + - PDU session and/or individual or group of service data flows, for an SMF; + - QoS Flow, for an SMF. + +See clauses 5.3 and 7.8.4 of 3GPP TS 23.214 [2]. + +The CP function shall control the usage measurement and reporting in the UP function by: + +- creating the necessary PDR(s) to represent the service data flow, application, bearer or session, if not already existing; + +- creating URR(s) for each Charging Key, combination of Charging Key and Service ID, or combination of Charging Key, Sponsor ID and Application Service Provider Id; +- associating the URR(s) to the relevant PDRs defined for the PFCP session, for usage reporting at IP-CAN bearer, IP-CAN session, TDF session, SDF or application level. + +For online charging, the CP function shall provision the URR with the Volume (or Time) Quota, and with the Volume (or Time) Quota if a quota threshold was received from the OCS, as specified in clause 5.2.2.2. Besides, when the OCS provides a final quota and requests to redirect the traffic towards a redirect destination when exhausting this quota, the CP function shall redirect the traffic towards a redirect destination as specified in clause 5.4.7 upon being notified that the final quota has been reached; to permit HTTP traffic redirection, the UP function should have at least one HTTP packet, e.g. the UP function may store one packet when reaching the Volume (or Time) Quota. An example call flow is depicted in Annex C.2.1.1. + +To avoid the risk of signalling storms between the CP and UP functions at times of tariff change, the CP function may include the Monitoring Time IE and zero or more Additional Monitoring IEs in the URR and set it to the time of tariff change to request the UP function to report separately the resource usage before and after the time of tariff change (see e.g. clause 6.3.7.1 of 3GPP TS 32.299 [18]). + +## 5.4.11 (Un)solicited Application Reporting + +For EPC, (un)solicited Application Reporting refers to the process of reporting the start or stop of applications by the TDF or PCEF. See 3GPP TS 23.203 [3] and 3GPP TS 29.212 [8]. + +For 5GC, solicited Application Reporting refers to the process of reporting the start or stop of applications by the SMF to the PCF. See 3GPP TS 23.503 [44] and 3GPP TS 29.512 [41]. Unsolicited application reporting is not applicable for 5GC. + +The CP function shall instruct the UP function to detect and report applications by: + +- creating the necessary PDR(s) to represent the applications to detect; +- creating a URR with the Reporting Trigger IE set to detect the start and/or stop of Traffic; + - the CP function may include a zero quota together with a FAR ID for Quota Action IE in the URR to instruct the UP function to drop or buffer the packets pertaining to the detected application traffic before the quota is granted in the subsequent PFCP Session Modification Request message. The FAR identified by the FAR ID for Quota Action shall be provisioned according to the "sdfHandl" instruction received from the PCF or the local policies as specified in 3GPP TS 29.512 [41]. + +NOTE 1: The (normal) FAR associated with the PDR detecting the application traffic is used when the URR is later on provisioned with a non-zero quota. + +- associating the URR to the PDR. + +For unsolicited application reporting, a PFCP session which is not linked to any specific TDF session may be established and the PDI in the PDR(s) does not contain any UE IP address. + +When detecting the start or stop of an application, the UP function shall then initiate the PFCP Session Report procedure and send a Usage Report with the Usage Report Trigger set to 'Start of Traffic' or 'Stop of Traffic'. The UP function shall also include the following information in the Usage Report: + +- when reporting the start of an application: + - the Application ID; + - the Flow Information including the Flow Description and the Flow Direction, if the traffic flow information is deducible; + - the Application-Instance-Identifier, if the traffic flow information is deducible; and + - if no UE IP address was provisioned in the PDI, the UE's IP address, and the Network instance when multiple PDNs with overlapping IP addresses are used in the UP function. + +NOTE 2: When the CP function instructs the UP function to perform unsolicited application reporting, the PDI in the corresponding PDR has no UE IP address. + +- when reporting the stop of an application: + +- the Application ID; +- the Application-Instance-Identifier, if an Application Identifier was provided when reporting the start of the application; +- if no UE IP address was provisioned in the PDI, the UE's IP address, and the Network instance when multiple PDNs with overlapping IP addresses are used in the UP function. + +The UP function shall only report the Application ID when detecting the start or stop of an application and the Reduced Application Detection Information flag is set in the Measurement Information of the URR, e.g. for envelope reporting. + +## 5.4.12 Service Identification for Improved Radio Utilisation for GERAN + +Service Identification for improved radio utilization for GERAN refers to the process in the PGW of marking DL user plane traffic with a Service Class Indicator (SCI) value. See clause 5.3.5.3 of 3GPP TS 23.060 [19]. + +This is controlled by the PGW-C by associating a QER, including the Service Class Indicator within the DL Flow Level Marking IE, to the PDR matching the DL traffic to be marked. The PGW-U performs the SCI marking for the detected DL traffic and sends the packet with the GTP-U Service Class Indicator Extension Header downstreams. + +The PGW-C may stop the SCI marking during the PFCP session by removing the related QER or removing the DL Flow Level Marking IE from the related QER, the PGW-U shall then stop such function consequently. + +## 5.4.13 Transport Level Marking + +For EPC, transport level marking is performed on a per EPS bearer basis in the SGW and PGW. Transport level marking refers to the process of marking traffic with a DSCP value based on the locally configured mapping from the QCI and optionally the ARP priority level. + +For 5GC, transport level marking is performed on a per QoS flow basis. Transport level marking refers to the process of marking traffic at the UPF/MB-UPF with a DSCP value based on the mapping from the 5QI, the Priority Level (if explicitly signalled) and optionally the ARP priority level configured at the SMF/MB-SMF. + +Transport level marking shall be controlled by the CP function by providing the DSCP in the ToS or Traffic Class within the Transport Level Marking IE in the FAR that is associated to the PDR matching the traffic to be marked. The UP function shall perform the transport level marking for the detected traffic and sends the marked packet to the peer entity. + +The CP function may change transport level marking by changing the Transport Level Marking IE in the related FAR. + +## 5.4.14 Deferred PDR activation and deactivation + +As specified in clause 6.3.2 of 3GPP TS 23.203 [7] and clauses 4.5.13 and 4a.5.13 of 3GPP TS 29.212 [8], Policy and charging control rule operations can be also performed in a deferred mode. To support such deferred PCC rule activation or deactivation, the CP function and UP function may optionally support the Deferred PDR activation and deactivation (DPDRA) as described below. + +If the feature DPDRA is supported in both CP function and UP function, and when a PCC rule is provisioned in a deferred mode, i.e. with a Rule-Activation-Time and/or Rule-Deactivation-Time, the CP function shall provision the corresponding PDR using Create PDR IE or Update PDR together with an Activation Time and/or Deactivation Time to enable the PDR being activated or deactivated at requested time. + +Without being provisioned together with an Activation Time or a Deactivation Time, a PDR shall be active immediately when it is received. When the status of a PDR is changed from active to inactive, the UP function shall keep storing the inactive PDR together with its associated FAR, URR(s) and QER(s), and then UP function shall apply the same behavior as if the PDR is deleted. + +The CP function shall control at what time the status of a PDR rule changes using Activation Time and/or Deactivation Time as exactly as being instructed by the PCRF using a Rule-Activation-Time and/or Rule-Deactivation-Time, as specified in clause 4.5.13 of 3GPP TS 29.212 [8]. + +- 1) If only Activation Time is specified and has not yet occurred, then the UP function shall set the PDR rule inactive and make it active at that time. If Activation Time has passed, then the UP function shall immediately set the PDR rule active. + +- 2) If only Deactivation Time is specified and has not yet occurred, then the UP function shall set the PDR rule active and make it inactive at that time. If Deactivation Time has passed, then the UP function shall immediately set the PDR rule inactive. +- 3) If both Activation Time and Deactivation Time are specified, and the Activation Time occurs before the Deactivation Time, and also when the PDR rule is provided before or at the time specified in the Deactivation Time, the UP function shall handle the rule as defined in 1) and then as defined in 2). +- 4) If both Activation Time and Deactivation Time are specified, and the Deactivation Time occurs before the Activation Time, and also when the PDR rule is provided before or at the time specified in the Activation Time, the UP function shall handle the rule as defined in 2) and then as defined in 1). +- 5) If both Activation Time and Deactivation Time are specified but time has already occurred for both, and the Activation Time occurs before the Deactivation Time, then the UP function shall immediately set the PDR rule inactive. + +NOTE 1: If the CP function receives both Rule-Activation-Time and Rule-Deactivation-Time from the PCRF, but time has already occurred for both, and the Rule-Activation-Time occurs before the Rule-Deactivation-Time, as alternative to above, the CP function can deactivate the corresponding PDR rule by provisioning a Deactivation Time which has occurred or removing the corresponding PDR rule. + +- 6) If both Activation Time and Deactivation Time are specified but time has passed for both, and the Deactivation Time occurs before the Activation Time, then the UP function shall immediately set the PDR rule active. + +NOTE 2: If the CP function receives both Rule-Activation-Time and Rule-Deactivation-Time from the PCRF, but time has passed for both, and the Rule-Deactivation-Time occurs before the Rule-Activation-Time, as alternative to above, the CP function can activate the corresponding PDR rule by provisioning an activation Time which has occurred in the Update PDR IE, or create the corresponding PDR rule if the PDR is not provisioned yet. + +## 5.4.15 Packet Rate enforcement + +### 5.4.15.1 General + +Packet rate enforcement refers to the process of limiting the rate of uplink and/or downlink packets allowed to be sent for a PDN connection or a PDU session. + +Packet rate enforcement shall be used to support: + +- APN rate control for UE's all PDN connections for a given APN in EPC, see 3GPP TS 23.401 [14] and 3GPP TS 23.502 [29]. APN rate control is enforced across N4 interface only for 5GC interworking with EPC scenario (see clause 4.3 in 3GPP TS 23.501 [28]); +- Small data rate control for a PDU session in 5GC, see 3GPP TS 23.501 [28] and 3GPP TS 23.502 [29]; +- Serving PLMN rate control, for downlink traffic, see 3GPP TS 23.401 [14] and 3GPP TS 23.501 [28]. + +### 5.4.15.2 Packet rate enforcement over Sxb and N4 interfaces + +The CP function may instruct the UP function to perform packet rate enforcement, during the establishment or the modification of a PFCP session, over the Sxb and N4 reference points. + +The CP function shall control packet rate enforcement in the UP function by: + +- 1) creating the necessary PDR(s) to represent the uplink or downlink traffic to be enforced, if not already existing; +- 2) creating QER(s) containing the Packet Rate IE with one or more of the following enforcement rules and information: + - Maximum Uplink/Downlink Packet Rates (i.e. Number of Uplink/Downlink Packets Allowed and Time units that determine the time periods for limiting the packet rates); + +- Additional Maximum Uplink/Downlink Packet Rates (i.e. Number of Additional Uplink/Downlink Packets Allowed and Time units that determine the time periods for limiting the packet rates), if additional packets are allowed to be sent beyond the maximum Uplink/Downlink Packet Rates; + +The QER may also contain the Packet Rate Status IE to indicate remaining numbers of allowed packets until a given time. + +The QER may also contain the QER Control Indications IE with the Rate Control Status Reporting (RCSR) flag, indicating the UP function shall report to the CP function the status of the packet rate usage when the PFCP session is released. + +- 3) associating the QER(s) to the UL and/or DL PDRs of the traffic for which packet rate enforcement is required. + +When so instructed, the UP function shall proceed as follows: + +- 1) the UP function shall count UL/DL packets within the time period (e.g. per minute, per day, etc.) and if the 'maximum allowed rate' is reached, the UP function shall discard or delay further packets. +- 2) If 'Additional Maximum Uplink/Downlink Packet Rates' are provided, the UPF shall consider 'maximum allowed rate' is equal to the 'number of packets per time unit' plus the 'number of additional allowed exception report packets per time unit'. Otherwise, the UPF shall consider 'maximum allowed rate' is equal to the 'number of packets per time unit'. +- 3) If the CP function has requested to report the rate control status, the UP function shall send to the CP function the Packet Rate Status IE, when the PFCP session is released. Otherwise, the UP function shall not send the Packet Rate Status IE to the CP function during the release of the PFCP session. +- 4) If the CP function provided Packet Rate Status information, then the UP function shall first enforce the rules in the Packet Rate Status IE until either the packet rate limits are reached, or the validity time expires. Only after this shall the UP function enforce the rules in the Packet Rate IE. + +### 5.4.15.3 PGW and SMF behaviour + +A PGW, SMF or SMF/PGW shall apply APN rate control, Small Data Rate Control and Serving PLMN rate control by instructing the UP function to perform packet rate enforcement as described in clause 5.4.15.2 with the following additions: + +- Serving PLMN rate control: + - the Maximum Downlink Packet Rate shall be set to the DL rate permitted by the Serving PLMN rate control parameters; + - the CP function shall indicate to the UP function to not report the status of the packet rate usage. + +NOTE 1: Serving PLMN rate control applies only to control plane PDU sessions and PDN connections. Uplink rate for Serving PLMN rate control is enforced by the MME or SMF, so it does not require support from the UP function. + +- Small Data Rate Control: + - the CP function shall indicate to the UP function to report the status of the packet rate usage; + - the QER shall be associated to all the DL/UL PDRs of the PDU session; +- APN rate control: + - the CP function shall indicate to the UP function to report the status of the packet rate usage; + - the QER shall be associated to all the PDRs of all the PDN connections of the UE to the same APN, using the QER Correlation ID (see clause 5.2.1). + +If both Serving PLMN rate control and Small Data Rate Control are applied in 5GS, or both Serving PLMN rate control and APN rate control are applied in EPS, the SMF/PGW-C may control packet rate enforcement in the UP function by provisioning: + +- a QER for Small Data Rate Control/APN rate control, and by associating DL/UL PDRs to the QER; or +- alternatively, different QERs for Serving PLMN rate control and for Small Data Rate Control/APN rate control, and by associating DL PDRs to both of the QER(s). + +APN rate control and Small Data Rate Control are distinct functionalities that apply in EPS and 5GS respectively. For PDU sessions supporting interworking with EPC, the SMF/PGW-C shall start APN rate control (if required for the UE's PDN connections to the APN) and stop Small Data Rate Control (if this was performed for the PDU session) upon 5GS to EPS mobility, and vice-versa upon EPS to 5GS mobility, e.g. by: + +- updating the information of the QER associated to the UL/DL PDRs with the packet rates and packet rate status (if available) applicable for APN rate control or Small Data Rate Control respectively, if the same QER is associated to UL/DL PDRs when the UE is in EPC and in 5GC; in this case, the SMF/PGW-C shall also request the UPF/PGW-U to report immediately the packet rate status at the time of the mobility between 5GS and EPS by including the Query Packet Rate Status IE in the PFCP Session Modification Request; or + +NOTE 2: Requesting the UPF/PGW-U to report immediately the packet rate status enables to retrieve the current rate status applicable to the source system before the UPF/PGW-U overwrites the QER parameters with the packet rates and packet rate status (if available) applicable to the target system. + +- provisioning different QERs for APN rate control and for Small Data Rate Control, and by associating UL/DL PDRs to the appropriate QER, when the UE is in EPC or in 5GC. In this case, when releasing the PFCP session, the UP function shall include the packet rate status for every QER for which this information has been requested in the corresponding QER Control Indications IE. + +Besides, if the SMF/PGW-C set up additional PDRs in the UP function for S5/S8 tunnels for a PDU session supporting interworking with EPS, these PDRs shall not be associated to the QER used to perform Small Data Rate Control. + +## 5.4.16 QoS differentiation for Stand-alone Non-Public Network (SNPN) + +### 5.4.16.1 General + +Support of QoS differentiation for SNPN is described in clause 5.30.2.7 and clause 5.30.2.8 of 3GPP TS 23.501 [28]. + +QoS differentiation procedures as described in the following clauses are optional and may be used when: + +- UE access to PLMN services via SNPN; +- UE access to SNPN services via PLMN. + +### 5.4.16.2 Access to PLMN services via SNPN + +The N3IWF in the PLMN uses the QoS profile and the Session-AMBR it receives from the SMF in the PLMN along with the mapping agreed in the SLA to derive a specific DSCP value for the User Plane IPsec Child SA. + +The SMF in SNPN shall provide PDR to the UPF in SNPN, based on the mapping rules including the mapping between the DSCP markings for the IPsec child SAs on NWu and the corresponding QoS requirement of the PLMN. The PDR may include specific DSCP and N3IWF IP address to enable UPF to detect the DL traffic. + +The SMF in SNPN may provide the QER associated to the PDR to ensure the QoS for the DL traffic if the related QoS Flow has been established in the SNPN. Otherwise, the SMF in SNPN may provide the URR associated to the PDR to request the reporting of the detected DL traffic, which may be used by the SMF in SNPN to trigger the PDU session modification procedure to establish the DL traffic related QoS Flow in SNPN. The URR may include the Reporting trigger "Start of application" to enable the UPF sending Usage report with the usage report trigger "START" to the SMF upon detection of the DL traffic with such DSCP and N3IWF IP address. + +The SMF in SNPN may also provide DSCP within the Transport Level Marking IE in the FAR that is associated to the PDR. UPF in SNPN shall perform the DSCP re-marking for the detected traffic and sends the marked packet to the NG-RAN. + +### 5.4.16.3 Access to SNPN services via PLMN + +The N3IWF in the SNPN uses the QoS profile and the Session-AMBR it receives from the SMF in the SNPN along with the mapping agreed in the SLA to derive a specific DSCP value for the User Plane IPsec Child SA. + +The SMF in PLMN shall provide PDR to the UPF in PLMN, based on the mapping rules including the mapping between the DSCP markings for the IPsec child SAs on NWu and the corresponding QoS requirement of the SNPN. The PDR may include specific DSCP and N3IWF IP address to enable UPF to detect the DL traffic. + +The SMF in PLMN may provide the QER associated to the PDR to ensure the QoS for the DL traffic if the related QoS Flow has been established in the PLMN. Otherwise, the SMF in PLMN may provide the URR associated to the PDR to request the reporting of the detected DL traffic, which may be used by the SMF in PLMN to trigger the PDU session modification procedure to establish the DL traffic related QoS Flow in PLMN. The URR may include the Reporting trigger "Start of application" to enable the UPF sending Usage report with the usage report trigger "START" to the SMF upon detection of the DL traffic with such DSCP and N3IWF IP address. + +The SMF in PLMN may also provide DSCP within the Transport Level Marking IE in the FAR that is associated to the PDR. UPF in PLMN shall perform the DSCP re-marking for the detected traffic and sends the marked packet to the NG-RAN. + +## 5.4.17 QoS differentiation for UEs behind RG + +Support of QoS differentiation for UEs behind RG is described in clause 4.10 and Annex B of 3GPP TS 23.316 [57]. + +QoS differentiation for UEs behind RG may be supported as described in clause 5.4.16.2 for the access to PLMN services via a SNPN, with the PLMN and SNPN being replaced by the UE's 5GC and the RG's 5GC respectively. + +# 5.5 F-TEID Allocation and Release + +## 5.5.1 General + +For EPC and 5GC, F-TEID shall be only allocated by the UP function, see clause 5.8.2.3 of 3GPP TS 23.501 [28]. + +The UP function shall set the FTUP feature flag in the UP Function Features IE (see clause 8.2.25) and the CP function shall request the UP function to allocate the F-TEID. The UP function shall reject a request to establish a new PDR with an F-TEID allocation in the CP function option, with the cause "Invalid F-TEID allocation option". As an exception, the UP Function shall accept the PFCP Session Establishment Request message with a PDR including an existing F-TEID to re-establish a PFCP session during a restoration procedure as specified in clause 4.3.2 of 3GPP TS 23.527 [40] and clauses 16.1A.4 and 17.1A.4 of 3GPP TS 23.007 [24]. + +## 5.5.2 Void + +## 5.5.3 F-TEID allocation in the UP function + +The CP function shall request the UP function to allocate the F-TEID by setting the CHOOSE flag in the Local F-TEID IE of the PDR IE (see Table 7.5.2.2-1). The Source Interface IE indicates for which interface the F-TEID is to be assigned. + +The CP function may request the UP function to allocate the same F-TEID to several PDRs to be created within one single PFCP Session Establishment Request or PFCP Session Modification Request by: + +- setting the CHOOSE flag in the Local F-TEID IE of each PDR to be created with a new F-TEID; and +- setting the CHOOSE ID field of the Local F-TEID IE, for each PDR to be created with the same F-TEID, with the same CHOOSE ID value; + +or, if the UP function indicated support of the PDI optimization (see clause 8.2.25), by: + +- including the Local F-TEID IE only in the Create Traffic Endpoint IE and by setting the CHOOSE flag in the Local F-TEID IE of this IE; and +- including the Traffic Endpoint ID in all the PDRs to be created with the same F-TEID. + +If the PDR(s) is created successfully, the UP function shall return the F-TEID(s) it has assigned to the PDR(s) or to the Traffic Endpoint(s) in the PFCP Session Establishment Response or PFCP Session Modification Response. + +Upon receiving a request to remove a PDR or a Traffic Endpoint, or to delete a PFCP session, the UP function shall free the F-TEID(s) that was assigned to the PDR if there is no more PDR with the same F-TEID, to the Traffic Endpoint or to the PFCP Session. + +When using redundant GTP-U transmission on N3/N9 interfaces (see clause 5.24.2), the CP function shall request the UP function to allocate the F-TEID for the redundant GTP-U tunnel following the same requirements as specified in this clause, using the "Local F-TEID for Redundant Transmission" IE instead of the "Local F-TEID" IE. + +## 5.6 PFCP Session Handling + +### 5.6.1 General + +The following clauses provide details on PFCP Sessions handling. + +### 5.6.2 Session Endpoint Identifier Handling + +The SEID uniquely identifies a PFCP session at an IP address of a PFCP entity. The F-SEID is the Fully Qualified SEID and it contains the SEID and IP address. The PFCP endpoint locally assigns the SEID value the peer PFCP side has to use when transmitting message. The SEID values are exchanged between PFCP endpoints using PFCP messages. The PFCP entity communicates to the peer PFCP entity the SEID value at which it expects to receive all subsequent control plane messages related to that PFCP session via the "F-SEID" IE. + +The PFCP session related messages shall share the same F-SEID for the PFCP session. An F-SEID shall be released after the PFCP session is released. + +### 5.6.3 Modifying the Rules of an Existing PFCP Session + +The following principles shall apply, unless specified otherwise in the specification. + +When modifying an existing PFCP session, the CP function shall only provide in the PFCP Request message the requested changes compared to what was previously provisioned in the UP function for this PFCP session, i.e. the CP function shall: + +- include IEs which needs to be newly provisioned in the UP function; +- include IEs which need to be provisioned with a modified value; +- remove IEs which need to be removed from the set of parameters previously provisioned in the UP function, as further specified below. + +The CP function shall remove IEs which needs to be removed by either: + +- removing the entire Rule if no other parameter of that rule needs to remain provisioned in the UP function, e.g. by including the Remove URR IE in the PFCP Session Modification Request; or +- updating the Rule including the IEs to be removed with a null length, e.g. by including the Update URR IE in the PFCP Session Modification Request with the IE(s) to be removed with a null length. For an IE with multiple occurrences, e.g. when the description of the IE contains the text "several IEs with the same IE type may be present", one occurrence of such an IE with a null length shall result in removing all the IEs with the same IE type. + +The CP function shall set a URR ID and/or QER ID with a length "0" in the Update PDR IE within PFCP Session Modification Request, to request the UP function to stop applying the URRs and/or QERs for this PDR. + +Upon receipt of a PFCP Request which modifies an existing PFCP session, the UP function shall add, update or remove the parameters as instructed by the CP function, as defined above, and shall keep unchanged the set of parameters previously provisioned in the UP function which are neither modified nor removed. + +## 5.7 Support of Lawful Interception + +### 5.7.1 General + +This clause specifies lawful interception with PFCP in EPC. + +## 5.7.2 Lawful Interception in EPC + +Requirements for support of Lawful Interception with a split SGW or PGW are specified in clauses 12.9 and 20.4 of 3GPP TS 33.107 [20]. + +User plane packets shall be forwarded from the UP function to the SX3LIF (or LMISF for S8HR) by encapsulating the user plane packets using GTP-U encapsulation (see 3GPP TS 29.281 [3]). + +The CP function shall instruct the UP function to duplicate the packets to be intercepted and to forward them to the SX3LIF (or to the LMISF for S8HR) as specified in clause 5.2.3. + +For forwarding data from the UP function to the SX3LIF (or LMISF for S8HR), the CP function shall set the DUPL flag in the Apply Action and set the Duplicating Parameters in the FAR, associated to the PDRs of the traffic to be intercepted, with the Destination Interface "LI Function" and set to perform GTP-U encapsulation and to forward the packets to a GTP-u F-TEID uniquely assigned in the SX3LIF (or LMISF for S8HR) for the traffic to be intercepted. The SX3LIF (or LMISF for S8HR) shall then identify the intercepted traffic by the F-TEID in the header of the encapsulating GTP-U packet. + +## 5.7.3 Lawful Interception in 5GC + +Requirements for support of Lawful Interception with SMF and UPF are specified in clause 6.2.3 of 3GPP TS 33.127 [47]. The PFCP protocol is not used for Lawful Interception in 5GC. + +# 5.8 PFCP Association + +## 5.8.1 General + +A PFCP Association shall be set up between the CP function and the UP function prior to establishing PFCP sessions on that UP function. Only one PFCP association shall be setup between a given pair of CP and UP functions, even if the CP and/or UP function exposes multiple IP addresses. A single PFCP association may also be setup between a SMF set and a UPF (see clause 5.22.2). + +The CP function and the UP function shall support the PFCP Association Setup procedure initiated by the CP function (see clause 6.2.6.2). The CP function and the UP function may additionally support the PFCP Association Setup procedure initiated by the UP function (see clause 6.2.6.3). + +A CP function may have PFCP Associations set up with multiple UP functions. A UP function may have PFCP Associations set up with multiple CP functions. + +In PFCP signaling, a CP function or a UP function shall be identified by a unique Node ID. A Node ID may be set to an FQDN or to an IP address (either IPv4 or IPv6, see clause 8.2.38). When set to an IP address, it indicates that the CP/UP function only exposes one IP address for the PFCP Association signalling. Once a PFCP association is set up between a CP function and a UP function, the same Node ID as signaled respectively by the CP function and the UP function during the PFCP association setup procedure shall be used in all subsequent PFCP node related messages (other than Heartbeat messages) until the PFCP association is released. + +NOTE 1: The control of a PFCP session can be taken over by a new SMF in an SMF set as specified in clause 5.22. When using the MPAS feature (see clause 5.22.3), when a different SMF takes over the control of the PFCP session, the UP function receives the NODE ID of the new SMF that is different from the NODE ID of the SMF that was handling the PFCP session earlier. + +The PFCP entities shall accept any new IP address allocated as part of F-SEID other than the one(s) communicated in the Node Id. + +NOTE 2: The source IP address to send PFCP Association Setup request can not be used as the destination IP address when the peer sends a PFCP Association Update Request message, e.g. for a scenario when a NAT is deployed in the network. + +Prior to establishing a PFCP Association, the function responsible for establishing the PFCP Association (e.g. CP function) shall look up a peer function (e.g. UP function), e.g. using DNS procedures (see 3GPP TS 29.303 [25]), NRF procedures (see 3GPP TS 29.510 [43]) or local configuration. If the peer function is found to support multiple IP + +addresses (in the look up information), one of these addresses (any one) shall be used as destination IP address to send the PFCP Association Setup Request. Once the PFCP Association is established, any of the IP addresses of the peer function (found during the look-up) may then be used to send subsequent PFCP node related messages and PFCP session establishment requests for that PFCP Association. + +NOTE 3: The look up information (e.g. in DNS, NRF or local configuration of the function responsible for establishing the PFCP association) needs to be configured consistently with the addressing information of the peer function. If a FQDN is configured to identify a function in DNS or NRF, then the Node ID of that function included in PFCP messages need to be set to the same FQDN. For instance, if the CP function is responsible for establishing the PFCP association, a UP function that exposes multiple IP addresses (for PFCP node related messages and PFCP session establishment requests) needs to be configured in the look up information as one (single) UP function that is associated to multiple IP addresses. The Node ID needs to be set to an SMF set FQDN when a single association is setup between an SMF set and UPF (see clause 5.22.2). + +NOTE 4: PFCP session related messages for sessions that are already established are sent to the IP address received in the F-SEID allocated by the peer function or to the IP address of an alternative SMF in the SMF set (see clause 5.22). The former IP address needs not be configured in the look up information. See clauses 4.3.2 and 4.3.3. + +## 5.8.2 Behaviour with an Established PFCP Association + +When a PFCP Association is established with a UP function, the CP function: + +- shall provision node related parameters (i.e. parameters that apply to all PFCP sessions) in the UP function, if any, e.g. PFDs; +- shall provision the UP function with the list of features (affecting the UP function behaviour) the CP function supports, if any, e.g. support of load and/or overload control; +- shall check the responsiveness of the UP function using the Heartbeat procedure as specified in clause 6.2.2; +- may establish PFCP sessions on that UP function; +- shall refrain from attempting to establish new PFCP sessions on the UP function, if the UP function has indicated it will shut down gracefully. + +When a PFCP Association is established with a CP function, the UP function: + +- shall update the CP function with the list of features it supports; +- shall update the CP function with its load and/or overload control information, if load and/or overload control is supported by the CP and UP functions; +- shall accept PFCP Session related messages from that CP function (unless prevented by other reasons, e.g. overload); +- shall check the responsiveness of the CP function using the Heartbeat procedure as specified in clause 6.2.2; +- shall indicate to the CP function if it will shut down within a graceful period and, when possible, if it fails and becomes out of service; +- may report UE IP address usage information to the CP function, if UE IP addresses are allocated by the UP function and the UE IP Address Usage Reporting feature is supported by the CP function (see clause 5.21.3.2). + +## 5.8.3 Behaviour without an Established PFCP Association + +When a PFCP Association is not established with a UP function, the CP function: + +- shall reject any incoming PFCP Session related messages from that UP function, with a cause indicating that no PFCP association exists with the peer entity. + +When a PFCP Association is not yet established with a CP function, the UP function: + +- shall reject any incoming PFCP Session related messages from that CP function, with a cause indicating that no PFCP association exists with the peer entity. + +## 5.9 Usage of Vendor-specific IE + +Vendor-specific IEs are defined to cover requirements and features not specified by 3GPP. + +NOTE 1: When an IE is intended to be used by more than one vendor, the definition of the IE is encouraged to be specified by 3GPP to ease implementation and interoperability. + +NOTE 2: The PFCP entities can use Vendor-specific IE(s) in the PFCP message relevant to the PFCP Association Setup procedure to learn which vendor specific enhancements are supported by the peer. + +Vendor-specific IE may be sent with any PFCP message. Vendor-specific IE may be added directly to a PFCP message, or by embedding it into a grouped IE. + +In a network with Vendor specific enhancements, unrecognized vendor specific IEs shall be handled as unknown optional IEs. + +## 5.10 Error Indication Handling + +Upon receipt of a GTP-U Error Indication message, the UP function: + +- shall identify the related PFCP session for which the message is received; and +- shall initiate a PFCP Session Report procedure, towards the CP function controlling this PFCP session, to send an Error Indication Report including the remote F-TEID signalled in the GTP-U Peer Address IE and the Tunnel Endpoint Identifier Data I IE of the GTP-U Error Indication (see clause 7.3.1 of 3GPP TS 29.281 [3]). + +For EPC, upon receipt of an Error Indication Report, the CP function shall then identify the bearer for which the Error Indication Report is received using the remote F-TEID included in the report and proceed as specified in clauses 21.7 and 21.8 of 3GPP TS 23.007 [24], i.e.: + +- modify the PFCP session to instruct the UP function to buffer DL packets; +- modify the PFCP session to delete the PDR and FAR, when having to delete a bearer; or +- delete the PFCP session, when having to delete the PDN connection. + +For 5GC, upon receipt of an Error Indication Report, the SMF shall proceed as specified in clause 5.3 of 3GPP TS 23.527 [40]. + +## 5.11 User plane inactivity detection and reporting + +### 5.11.1 General + +This clause specifies the support of user plane inactivity detection and reporting. + +### 5.11.2 User plane inactivity detection and reporting per PDN connection or PDU session + +Clause 5.4.4.1 of 3GPP TS 23.401 [14] requires the PGW to initiate the release of an inactive emergency PDN connection. + +Clauses 4.3.7 and 4.3.2.2.2 of 3GPP TS 23.502 [29] require the SMF to be able to initiate the deactivation of the UP connection of an existing PDU session without user plane activity for a given inactivity period, except for the H-SMF for the home routed roaming scenario or except for an always-on PDU session as described in clause 5.6.8 of 3GPP TS 23.501 [28]. + +Clauses 4.3.5.7, 4.23.9.4 and 4.23.9.5 of 3GPP TS 23.502 [29] requires the SMF to be able to initiate the deactivation of the UP connection of an existing PDU session in source UL CL or source UPF (e.g. PSA2) if no active traffic over the N9 forwarding tunnel is detected and reported by the Source UL CL. Clause 4.23.9.4 of 3GPP TS 23.502 [29] also requires the SMF to release the N9 forwarding tunnel of an existing PDU session in the target UL CL/BP if no active traffic over the N9 forwarding tunnel is detected and reported by the Source UL CL. + +Clause 7.2.5.3 of 3GPP TS 23.247 [72] requires the MB-SMF to be able to initiate the deactivation of an MBS session without user plane activity. + +Clauses 5.15.7.4 and 5.15.15.3 of 3GPP TS 23.501 [28] require the SMF that supports network slice usage behaviour control, to be able to configure slice specific inactivity timer for the PDU session at the UPF and initiate the release of the PDU session without user plane activity for a given slice specific inactivity time, based on the User Plane Inactivity Report from the UPF. + +If the slice specific inactivity timer for the PDU session is updated at SMF while the UPF had already been configured, the SMF shall update the UPF with the new inactivity timer for the PDU session. The UPF shall update the existing configured inactivity timer for the PDU session after the existing timer is stopped or expired. + +NOTE: For multi-access PDU session(s), the PDU session inactivity timer is independent of the access type. + +The CP function may request the UP function to detect and report when no user plane packets are received for a PFCP session, by provisioning the User Plane Inactivity Timer IE in the PFCP Session Establishment Request or PFCP Session Modification Request. + +Upon being provisioned with this IE, the UP function shall monitor the user plane activity of the PFCP session and report any user plane inactivity exceeding the duration indicated by this IE by sending a PFCP Session Report Request with the Report Type set to UPIR (User Plane Inactivity Report). The UP function shall then continue to process any further user plane packets as instructed by the rules provisioned for the PFCP session, until receiving any new instruction from the CP function. + +### 5.11.3 User plane inactivity detection and reporting per PDR + +Clause 4.23.9.5 of 3GPP TS 23.502 [29] requires the target I-SMF to be able to initiate the release of the N9 forwarding tunnel of an existing PDU session in the target UL CL/BP if no active traffic over the N9 forwarding tunnel is detected and reported by the target UL CL/BP. + +When both the CP function and the UP function support the UPIDP feature (see clause 8.2.25), the CP function may request the UP function to detect and report when no user plane packets are received for one or more PDRs, by provisioning a URR including the User Plane Inactivity Timer IE and by associating this URR with the PDR(s) in a PFCP Session Establishment Request or PFCP Session Modification Request. + +Upon being provisioned with this URR, the UP function shall monitor the user plane activity of all the PDR(s) associated with the URR and report user plane inactivity when no traffic has been received for any PDR(s) associated with the URR for the duration indicated in the User Plane Inactivity Timer IE by sending a PFCP Session Report Request with the Report Type set to USAR (Usage Report) and with the Usage Report Trigger IE set to UPINT (User Plane Inactivity Timer). + +## 5.12 Suspend and Resume Notification procedures + +Upon receipt of a Suspend Notification message, the PGW-C should request the PGW-U to discard packets received for the suspended PDN connection by: + +- setting the DROP flag in the Apply Action IE of the FARs of the corresponding PFCP session; or +- setting the gate fields in the Gate Status IE of QERs to the value CLOSED. + +Upon being requested to resume the PDN connection, the PGW-C should re-allow the PGW-U to forward the packets for the PDN connection (unless not permitted for other reasons) by: + +- setting the FORW flag in the Apply Action IE of the FARs of the corresponding PFCP session; or +- setting the gate fields in the Gate Status IE of QERs to the value OPEN. + +## 5.13 Ethernet traffic (for 5GC) + +### 5.13.1 General + +An SMF and UPF may support Ethernet PDU sessions, as specified in clause 5.6.10.2 of 3GPP TS 23.501 [28]. + +A combined PGW-C/SMF and PGW-U/UPF may support Ethernet PDU sessions as specified in clause 4.3.17.8a of 3GPP TS 23.401 [14] and clause 5.6.10.2 of 3GPP TS 23.501 [28]. In this case, the PGW-C/SMF and PGW-U/UPF shall follow, respectively, the requirements specified for the SMF and UPF by this clause. + +For a PFCP session set up for an Ethernet PDU session, the SMF shall: + +- include the PDN Type IE set to "Ethernet" in the PFCP Session Establishment Request; +- provision PDR(s), for uplink and/or downlink traffic, with Ethernet Packet Filter(s), based on at least any combination of: + - Source/destination MAC address; + - Ethertype as defined in IEEE 802.3 [31]; + - Customer-VLAN tag (C-TAG) and/or Service-VLAN tag (S-TAG) VID fields as defined in IEEE 802.1Q [30]; + - Customer-VLAN tag (C-TAG) and/or Service-VLAN tag (S-TAG) PCP/DEI fields as defined in IEEE 802.1Q [30]; + - IP Packet Filter Set, in case Ethertype indicates IPv4/IPv6 payload; + - Ethernet PDU Session Information, only possible for a DL PDR, that identifies all (DL) Ethernet packets matching the PDU session as follows, based on the N6 Ethernet configuration in the UPF for the associated Network Instance (see clause 5.6.10.2 of 3GPP TS 23.501 [28]): + - DL traffic based on the MAC address(es) and/or C-TAG and/or S-TAG used by the UE for the UL traffic, for configurations where more than one PDU Session to the same DNN (e.g. for more than one UE) corresponds to the same N6 interface; + - DL traffic from the N6 interface associated to the PDU session, for configurations where there is a one-to-one relationship between a PDU Session and a N6 interface (in which case the UPF does not need to be aware of MAC addresses and/or C-TAG and/or S-TAG used by the UE in order to route down-link traffic). + +NOTE 1: For instance, the SMF can provision a DL PDR with just an "Ethernet PDU Session Information", in a Traffic Endpoint ID or in a PDI, or Ethernet Packet Filters in a PDI, or both an "Ethernet PDU Session Information" in a Traffic Endpoint ID and Ethernet Packet Filters in a PDI. + +The SMF may also request a UPF, acting as a PDU session anchor, to: + +- redirect Address Resolution Protocol (ARP) (see IETF RFC 826 [32]) or IPv6 Neighbour Solicitation traffic (see IETF RFC 4861 [33]) to the SMF as specified in clause 5.13.2, or to respond to ARP or IPv6 Neighbour Solicitation based on the local cache information as specified in clause 5.13.3; +- report the MAC (Ethernet) addresses and possibly associated VLAN tag(s) used as source address of frames sent UL by the UE, as specified in clause 5.13.5; +- update its list of MAC addresses and possibly associated VLAN tag(s) associated to the PDU session, during an Ethernet PDU session anchor relocation, as specified in clause 5.13.6. + +For a PFCP session set up for an Ethernet PDU session, the UPF shall: + +- detect Ethernet traffic, based on Ethernet Packet Filter(s) provisioned in PDR(s) by the SMF, and process the Ethernet traffic as instructed in the FAR, QER(s) and URR(s) associated to the PDR(s); +- forward Address Resolution Protocol (see IETF RFC 826 [32]) or IPv6 Neighbour Solicitation messages (see IETF RFC 4861 [33]) to the SMF, as specified in clause 5.13.2, if so required by the SMF; +- respond to Address Resolution Protocol (see IETF RFC 826 [32]) or IPv6 Neighbour Solicitation (see IETF RFC 4861 [33]) based on the local cache information, as specified in clause 5.13.3, if so required by the SMF. + +NOTE 2: Ethernet Preamble and Start of Frame delimiter are not sent over 5GS. + +NOTE 3: How the UPF/SMF builds the ARP or the IPv6 Neighbour cache is not specified in this release and is implementation specific. + +### 5.13.2 Address Resolution Protocol or IPv6 Neighbour Solicitation Response by SMF + +If the SMF requests the UPF to forward all Address Resolution Protocol (ARP) (see IETF RFC 826 [32]) or IPv6 Neighbour Solicitation (see IETF RFC 4861 [33]) traffic to the SMF to respond to the ARP or IPv6 Neighbour Solicitation based on the local cache information for Ethernet PDU sessions, the SMF shall provision a PDR in the UPF with: + +- an Ethernet Packet Filter containing EtherType 2054 (hexadecimal 0x0806) and associate the PDR with a FAR, for forwarding ARP traffic to the SMF; and/or +- a PDI containing an application ID such that the identified application ID matches against EtherType 34525 (hexadecimal 0x86DD), IPv6 Next Header type as 58 and ICMP Field Type as 135 and associate the PDR with a FAR, for forwarding IPv6 Neighbour Solicitation traffic to the SMF. + +In this case, the user plane packets shall be forwarded between the CP and UP functions by encapsulating the user plane packets using GTP-U encapsulation (see clause 5.3.1). + +The SMF shall respond to ARP and/or IPv6 Neighbour Solicitation as specified in 3GPP TS 23.501 [28], clause 5.6.10.2 in this case. + +### 5.13.3 Address Resolution Protocol or IPv6 Neighbour Solicitation Response by UPF + +If the SMF requests the UPF to respond to Address Resolution Protocol (ARP) (see IETF RFC 826 [32]) or IPv6 Neighbour Solicitation (see IETF RFC 4861 [33]) based on the local cache information for an Ethernet PDU session, the SMF shall provision a PDR in the UPF with: + +- an Ethernet Packet Filter containing EtherType 2054 (hexadecimal 0x0806) and associate the PDR with a FAR that has the ARP bit in Proxying IE of the Forwarding Parameters IE set to "1"; or +- a PDI containing an application ID such that the identified application ID matches against EtherType 34525 (hexadecimal 0x86DD), IPv6 Next Header type as 58 and ICMP Field Type as 135 and associate the PDR with a FAR that has the INS bit in Proxying IE of the Forwarding Parameters IE set to "1". + +The UPF shall respond to ARP and/or IPv6 Neighbour Solicitation as specified in 3GPP TS 23.501 [28], clause 5.6.10.2 in this case. + +### 5.13.3A Provisioning of MAC addresses and SDF filters in Ethernet Packet Filters + +The provisioning of an SDF Filter in an Ethernet Packet Filter shall follow the requirements specified for provisioning an SDF Filter in clause 5.2.1A.2A. + +Likewise, the source and destination MAC addresses information, when provisioned, shall be set as for downlink Ethernet flows. The UP function shall apply source and destination MAC addresses information based on the Source Interface of the PDR, according to the same principles as specified in clause 5.2.1A.2A, e.g. swapping the source and destination MAC addresses information if the Source Interface is ACCESS, and applying them as provisioned if the Source Interface is CORE. + +### 5.13.4 Bidirectional Ethernet Filters + +The CP function may provision bidirectional Ethernet Filters in the UP function (see table 7.5.2.2-3), i.e. Ethernet filters that may be associated to both uplink and downlink PDRs of a same PFCP session, as follows: + +- when provisioning a bidirectional Ethernet Filter the first time for a PFCP session, the CP function shall set the BIDE (Bidirectional Ethernet Filter) flag in the Ethernet Filter Properties IE and provision the Ethernet filter + +definition together with a Ethernet Filter ID uniquely identifying the Ethernet Filter among all the Ethernet Filters provisioned for a given PFCP session; the source and destination MAC addresses information, in a bidirectional Ethernet filter, shall be set as for downlink Ethernet flows; + +- the CP function may then provision a PDR for the same PFCP session but the opposite direction, by provisioning the Ethernet Filter ID in the Ethernet filter ID field of the PDI, without provisioning again the Ethernet Filter Properties and Ethernet filter definition; +- when being provisioned with a bidirectional Ethernet Filter in a PDR, the UP function shall apply the Ethernet filter according to the direction of the PDR as specified in clause 5.13.3A, i.e. the UP function shall apply the Ethernet filter parameters provisioned for the Ethernet filter ID, but with swapping the source and destination MAC addresses, and the source and destination IP addresses if any, if the PDR is set for uplink Ethernet flows; +- the UP function shall apply any modification of a bidirectional Ethernet Filter to all PDRs of the PFCP session making use of this Ethernet Filter; +- upon deletion of a PDR making use of a bidirectional Ethernet Filter, the UP function shall still apply the Ethernet Filter for any other PDR making use of the Ethernet Filter. + +The requirements specified for provisioning of MAC addresses and SDF Filters in clause 5.13.A shall also apply when provisioning bidirectional Ethernet Filters. + +### 5.13.5 Reporting of UE MAC addresses to the SMF + +In a PFCP Session Establishment Request or a PFCP Session Modification Request, the SMF may request the UPF to start or stop (in a PFCP Session Modification Request only) reporting the UE MAC addresses, i.e. the different MAC (Ethernet) addresses used as source address of frames sent UL by the UE in a PDU Session, by: + +- creating a URR requesting the UPF to report Ethernet traffic information (i.e. with the Reporting Trigger set to 'MAC Addresses Reporting'); and +- associating the URR to the PDR provisioned for the UL traffic of the PDU session. + +The SMF may additionally request the UPF to detect and report when no user plane packets are received for an UE MAC address, by provisioning the Ethernet Inactivity Timer IE in the URR. + +When being requested to start reporting the UE MAC addresses, the UPF shall: + +- report immediately any UE MAC addresses (and possibly their associated VLAN tags) known to be associated to the PDU session (e.g. if the request to start monitoring of traffic is received after the PFCP session establishment and if the UPF monitors the UE MAC addresses for the routing of DL traffic); +- report new UE MAC addresses (and possibly their associated VLAN tags) that are detected subsequently; +- report UE MAC addresses (and possibly their associated VLAN tags) that are removed subsequently from the PDU session, based on the detection of absence of traffic during the Ethernet Inactivity Timer, if this timer is provisioned in the URR. + +NOTE: Numerous UE MAC addresses can be used by a same PDU session. The UP function can defer a bit the reporting of newly detected or removed UE MAC addresses to allow the reporting of multiple UE MAC addresses in a same usage report. Details are implementation specific. + +### 5.13.6 Ethernet PDU session anchor relocation + +The UPF (PSA) of an Ethernet PDU session may be relocated as specified in clause 4.3.5.8 of 3GPP TS 23.502 [29]. + +A UPF that supports the Ethernet PDU session relocation procedure shall set the ETHAR bit in the UP Function Features (see clause 8.2.25). + +If the UPF indicated support of Ethernet PDU session anchor relocation, the SMF may request the UPF to update its list of MAC addresses and possibly associated VLAN tag(s) associated to the PDU session, during an Ethernet PDU session relocation procedure, by sending a PFCP Session Modification Request with Ethernet context information including the MAC addresses (and possibly associated VLAN tag(s)) received from the old Ethernet PDU session anchor. + +Upon receipt of such information, the UPF shall consider these MAC addresses (and possibly associated VLAN tag(s)) as associated to the PDU session and the UPF may assist in the update of Ethernet forwarding tables of Ethernet switches in the DN as specified in clause 4.3.5.8 of 3GPP TS 23.502 [29]. + +## 5.14 Support IPv6 Prefix Delegation + +Clause 5.3.1.2.6 of 3GPP TS 23.401 [14], clause 4.6.2.3 of 3GPP TS 23.316 [57] and clause 5.8.2.2.4 of 3GPP TS 23.501 [28] specify requirements for IPv6 Prefix Delegation via DHCPv6, that allow assigning a single network prefix shorter than the default /64 prefix to a PDN connection or a PDU session. + +The CP function shall assign, or request the UP function to assign (if the UP function indicates support of the UEIP feature, see clause 8.2.25), the network prefix shorter than the default /64 prefix by provisioning the UE IP Address IE in the UP function with: + +- the IPv6D flag set to "1" and the IPv6 Prefix Delegation Bits field indicating the length of IPv6 Prefix for delegation (see clause 8.2.62); or +- the IP6PL flag set to "1" and the IPv6 Prefix Length field indicating the length of IPv6 Prefix for delegation (see clause 8.2.62), if the UP function supports the IP6PL feature (see clauses 5.21.1 and 8.2.25). + +When UP function is requested to perform UE IP address allocation and IPv6 prefix delegation is used, the IPv6 prefix length may be determined by the CP function or the UP function: + +- if it is determined by the CP function, the IPv6 Prefix Delegation Bits or IPv6 Prefix Length fields shall be set according to the desired IPv6 prefix length by the CP function; +- or if the IPv6 prefix length is determined by the UP function, the CP function shall set the IPv6 Prefix Delegation Bits or IPv6 Prefix Length fields to "0". + +NOTE: The IPv6 prefix shorter than the default /64 prefix for IPv6 Prefix Delegation can include the /64 default prefix used for IPv6 stateless autoconfiguration (in EPS and 5GS) or not (5GS). In the former case, the total IPv6 address space available for the PDU Session can be aggregated into one single IPv6 prefix and the UP function needs not support the IP6PL feature. In the latter case, the total IPv6 address space available for the PDU Session cannot be aggregated into one single IPv6 prefix; support of this latter case requires support of the IP6PL feature (see clauses 5.21.1 and 8.2.25). + +When assigning additional IPv6 prefixes (i.e. prefixes in addition to the default prefix) to a UE, the CP function shall provision/update the UE IP Address IE in the PDI which may be as part of a Create PDR IE or a Update PDR IE, or in the Create Traffic EndPoint IE or Update Traffic EndPoint IE to the UP function as described above. + +## 5.15 Signalling based Trace (De)Activation + +The UP function shall set the TRACE feature flag in the UP Function Features IE if it supports Trace (see 3GPP TS 32.422 [35]). + +If the UP function indicated support of Trace, the CP function may activate a trace session during a PFCP session establishment or a PFCP session modification procedure, by including the Trace Information IE in the PFCP Session Establishment Request or PFCP Session Modification Request. + +The CP function may deactivate an on-going trace session by including the Trace Information IE with a null length in a PFCP Session Modification Request. + +There shall be at most one trace session activated per PFCP session at a time. + +## 5.16 Framed Routing + +Framed routing allows to support an IP network behind a UE, such that a range of IP addresses or IPv6 prefixes is reachable over a single PDU session, e.g. for enterprise connectivity. Framed routes are IP routes behind the UE. The UPF advertizes relevant IP routes to receive packets destined to these destination IP addresses or IPv6 prefixes and to forward these packets over the PDU session. See clause 5.6.14 of 3GPP TS 23.501 [28], IETF RFC 2865 [37], + +IETF RFC 3162 [38]) and the Framed-Route, Framed-Routing and Framed-IPv6-Route AVPs specified in 3GPP TS 29.061 [39] and 3GPP TS 29.561 [49]. + +Framed routing is defined only for PDN connections and PDU sessions of the IP type (IPv4, IPv6, IPv4v6). + +A UPF may indicate support of framed routing by setting the FRRT flag in the UP Function Features IE. If so, the CP function may include Framed-Route IEs, the Framed-Routing IE and Framed-IPv6-Route IEs in PDRs to describe framed routes associated to the PDU session. + +The UP function shall: + +- match the source IP address of packets with IP Address(es) or IPv6 prefixes as indicated in the the Framed-Route IE or Framed-IPv6-Route IE if it is provisioned in a UL PDRs; +- match the destination IP address of packets with IP Address(es) or IPv6 prefixes as indicated in the the Framed-Route IE or Framed-IPv6-Route IE if it is provisioned in a DL PDRs. + +## 5.17 5G UPF (for 5GC) + +### 5.17.1 Introduction + +The following clauses describe the 5GS specific functionalities of a UP function. + +### 5.17.2 Uplink Classifier and Branching Point + +The Uplink Classifier and Branching Point functionalities refer to the capability of the UPF to route uplink traffic flows of the same PFCP session (PDU session) to two or more PDU Sessions Anchors, and to route the downlink traffic flows from these PDU Session Anchors on the tunnel towards the UE. They are defined in 3GPP TS 23.501 [28] and 3GPP TS 23.502 [29]. + +Uplink Classifier is supported for PDU sessions of type IPv4, IPv6, IPv4v6 or Ethernet. The routing of the uplink traffic flows to different PDU Session Anchors is based e.g. on the destination IP address/Prefix of the uplink packets for an IP PDU session. + +Branching Point is supported for multi-homed PDU sessions of type IPv6, i.e. PDU sessions with multiple IPv6 prefixes. The routing of the uplink traffic flows to different PDU Session Anchors is based on the source IP prefix of the uplink packets. + +The SMF may insert an Uplink Classifier or Branching Point, during a PDU session establishment or modification, by provisioning: + +- two or more UL PDRs, with the appropriate Packet Detection Information, and with corresponding FARs to route the uplink traffic flows towards the appropriate PDU Session Anchors; +- two or more DL PDRs, with the appropriate Packet Detection Information, and with one (or more FARs) to route the downlink traffic flows on the tunnel towards the UE. + +NOTE 1: This uses the generic functionalities of the PFCP protocol described in this specification, with two or more DL PDRs (for the traffic coming from the different PDU session anchors). + +NOTE 2: A UPF acting as an Uplink Classifier or Branching Point can also behave as a PDU Session Anchor for the PDU session. + +The SMF may remove an Uplink Classifier or Branching Point, during a PDU session modification, by removing the UL (or modifying the FAR associated to the UL PDR) and DL PDRs that were setup for the traffic to/from the PDU Session Anchor(s) to be removed. + +### 5.17.3 Data forwarding during handovers between 5GS and EPS + +Downlink data may be forwarded during an inter-system handover between 5GS and EPS using direct or indirect data forwarding. + +NOTE: Uplink data is not forwarded during an inter-system handover between 5GS and EPS in this release of the specification. + +Direct data forwarding is performed directly between the source and target RAN, without the involvement of any UPF to forward the data. + +Indirect data forwarding during handovers between 5GS and EPS is supported as follows (see 3GPP TS 38.300 [42]): + +- For 5G to 4G handover, the source NG-RAN node sends one or several end markers including one QFI of those QoS flows mapped to the same E-RAB and sends the end marker packets to the UPF over the PDU session tunnel. UPF removes the QFI and maps to an appropriate E-RAB tunnel towards SGW. +- For 4G to 5G handover, the source eNB forwards the received end markers in the EPS bearer tunnel to the SGW which forwards them to the UPF. The UPF adds one QFI among the QoS flows mapped to that E-RAB to the end markers and sends those end markers to the target NG-RAN node in the per PDU session tunnel. + +To forward data (G-PDUs and End Marker packets) during a 5GS to EPS handover, the SMF shall: + +- provision one PDR per E-RAB (that supports data forwarding for at least one QoS flow), with the list of QFIs that are mapped to the E-RAB; +- request the UPF to remove the GTP-U PDU Session Container extension header (including the QFI) from the data by including the GTP-U Extension Header Deletion field set to 'PDU Session Container' in the Outer Header Removal IE of the PDR(s); +- associate to each PDR a FAR to forward the data to the GTP-U tunnel of the corresponding E-RAB, i.e. with an Outer Header Creation IE containing the F-TEID of the (forwarding) SGW for the corresponding forwarding GTP-U tunnel. + +To forward data (G-PDUs and End Marker packets) during an EPS to 5GS handover, the SMF shall: + +- provision one PDR per E-RAB (that supports data forwarding for at least one QoS flow); +- create and associate one QER with each PDR, including the QFI IE set to the QFI value of one of the QoS flows mapped to the E-RAB, to request the UPF to insert a GTP-U PDU Session Container extension header including the QFI; +- create one FAR for each data forwarding tunnel in 5GS (i.e. per PDU session), with an Outer Header Creation IE containing the F-TEID of the target NG-RAN for the corresponding forwarding GTP-U tunnel; +- associate each PDR to the corresponding FAR (i.e. to forward the data of each E-RAB to the data forwarding tunnel of the corresponding PDU session). + +## 5.18 Enhanced PFCP Association Release + +### 5.18.1 General + +To ensure no loss of usage reports and signalling efficiency, during a PFCP Association Release procedure, which is either initiated by CP function, or upon request from the UP function, the CP function and UP function may support the Enhanced PFCP Association Release feature (EPFAR) as described below. + +When both the CP function and the UP function support the EPFAR feature, and when the CP (or UP) function determines that the PFCP association is to be released, the CP (or UP) function shall send a PFCP Association Update Request message with a "PFCP Association Release Preparation Start" flag to inform the peer UP (or CP) function that the PFCP Association is going to be released and the final non-zero usage reports are to be collected for these PFCP sessions which will be affected by PFCP association release. + +The CP function should stop establishing new PFCP sessions in the UP function after receiving or sending a PFCP Association Release Preparation Start indication. The CP(or UP) function shall send a PFCP Association Update Response with a successful cause value to the peer. + +Then the UP function shall initiate the PFCP Session Release procedure as specified in clause 5.18.2 by sending one or more PFCP Session Report Request messages for the PFCP sessions affected by the release of the PFCP association and that have non-zero usage reports to be reported. In the PFCP Session Report Request message, the UP function shall: + +- set the Usage Report Trigger to TEBUR (Termination By UP function Report) for the usage reports being reported; and +- set the PSDBU (PFCP Session Deleted By the UP function) flag to "1" to indicate to the CP function that the PFCP Session is being deleted in the UP function and the usage reports included in the message are the final usage reports for the given PFCP Session, if this is the last PFCP Session Report Request message sent for the PFCP session. + +When the UP function has sent all the non-zero usage reports for the PFCP sessions affected by the release of the PFCP Association, the UP function shall send a PFCP Association Update Request with the flag URSS (non-zero Usage Reports for the affected PFCP Sessions Sent) set to "1" to indicate to the CP function that all non-zero usage reports for the affected PFCP sessions have been sent to the CP function and the corresponding PFCP sessions in the UP function have been locally deleted. The CP function shall then send a PFCP Association Update Response with a successful cause to the peer to indicate the PFCP Association Update Request is handled successfully. + +The CP function shall then send a PFCP Association Release Request to release the PFCP Association as specified in clause 6.2.8. + +## 5.18.2 UP Function Initiated PFCP Session Release + +When the UP function needs delete a PFCP session, e.g. during the Enhanced PFCP Association Release as described in clause 5.18.1 or when it detects an error or partial failure, the UP function shall: + +- send one or more PFCP Session Report Request messages for this PFCP session; +- set the Report Type to "USAR" (Usage Report) if there is non-zero usage report for the PFCP session, or set the Report Type to "UISR" if there is no usage report to send (e.g. for a session without an URR provisioned or with an URR provisioned but with only null usage measurements); +- set the Usage Report Trigger to "TEBUR" for non-zero usage report(s), if usage reports are included in the PFCP Session Report Request message(s); and +- set the PSDBU flag to "1" to indicate to the CP function that the PFCP session is being deleted, in the last PFCP Session Report Request message sent for that PFCP session. + +NOTE: The UP Function can release one or more PFCP Sessions (without tearing down the entire PFCP Association) when there is a partial failure in the UP Function. + +## 5.19 Activation and Deactivation of Pre-defined PDRs + +To reduce the signalling overhead for establishing a PFCP session (for a PDU session or a PDN connection) and improve the signalling efficiency, the CP and UP functions may support the Activation and Deactivation of a Pre-defined PDR (ADPDP) feature as described below. + +When both the CP function and the UP function support the ADPDP feature, the CP function may activate one or more pre-defined PDRs for a PFCP session during a PFCP Session Establishment or a PFCP Session Modification procedure. A pre-defined PDR shall be configured in the UP function before it can be activated in a PFCP session. + +A pre-defined PDR may contain all the necessary packets detection information to identify a service data flow or application traffic which may be common to many PFCP sessions, and it may be configured in the UPF associated with a pre-defined FAR, one or more pre-defined QER(s), and/or one or more pre-defined URR(s). + +Any PFCP session specific information, e.g. traffic endpoint information, may not be part of a pre-defined PDR and is provisioned before or during the activation of the pre-defined PDR. + +To activate one or more pre-defined PDR(s), the CP function shall provide one or more Activate Predefined Rules IE(s) in a Create PDR IE in a PFCP Session Establishment Request, or in a Create PDR IE or an Update PDR IE in a PFCP Session Modification Request message, that references a pre-defined PDR configured in the UP function, with the following information in the Create PDR or Update PDR IE: + +- the traffic endpoint that the traffic shall match (e.g. Local F-TEID, UE IP Address or Traffic Endpoint ID); +- optionally the QFI that the traffic shall match, e.g. for a UL PDR where UL QoS flow binding verification is required (see clause 5.4.2); +- the precedence to be applied by the UP function among all PDRs of the PFCP session; +- optionally, an FAR containing instructions related to the processing of the packets matching the pre-defined PDR(s); when present, the UP function shall enforce it instead of the one defined in the pre-defined PDR(s) if any; +- optionally, one or more URRs to be used in addition to any URR(s) specified in the pre-defined PDR(s) (e.g. for session level Usage Monitoring); +- optionally, one or more QERs to be applied in addition to any QER(s) specified in the pre-defined PDR (e.g. for APN-AMBR enforcement). + +When a pre-defined PDR is activated for a given PDR, an incoming packet matches the PDR if it matches the traffic endpoint, and the QFI if provisioned and one of the activated pre-defined PDR(s). + +The CP function may update the use of pre-defined PDRs that are already activated in a PFCP session by including one or more Activate Predefined Rules IE(s) or Deactivate Predefined Rules IE(s) in a PFCP Session Modification Request and/or by updating the parameters provisioned in the PDR. + +NOTE: The CP function cannot change a pre-defined PDR via PFCP session related procedure. + +The CP function may deactivate a pre-defined PDR that is already activated in a PFCP session by including the Deactivate Predefined Rules IE in a PFCP Session Modification Request requesting to deactivate the predefined PDR(s). + +In addition, this feature allows to define a group of pre-defined PDRs which can be activated, updated, and deactivated together. This allows the CP function to further optimize the signaling towards the UP function. + +To activate, update, or deactivate a group of pre-defined PDRs, the CP shall follow the same procedure as for activating, updating, and deactivating a pre-defined PDR, but it shall use an Activate Predefined Rules IE that refers to a group of pre-defined PDRs. + +## 5.20 Support of Access Traffic Steering, Switching and Splitting for 5GC + +### 5.20.1 General + +The Access Traffic Steering, Switching and Splitting (ATSSS) feature enables the support of Multi-Access (MA) PDU sessions, using one 3GPP access network or one non-3GPP access network at a time, or simultaneously using one 3GPP access network and one non-3GPP access network as defined in clauses 4.2.10 and 5.32 of 3GPP TS 23.501 [28]. + +A Multi-Access (MA) PDU session may support: + +- both 3GPP access and non-3GPP access connected to 5GC, as specified in clause 4.22.2.1 and 4.22.2.2 of 3GPP TS 23.502 [29]; +- 3GPP access connected to EPC while non-3GPP access is connected to 5GC, as specified in clause 4.22.2.3 of 3GPP TS 23.502 [29], subject to corresponding support by the UE. +- non-3GPP access connected to ePDG/EPC while 3GPP access is connected to 5GC, as specified in clause 5.32.1 of 3GPP TS 23.501 [23], subject to corresponding support by the UE. + +The non-3GPP access network connected to 5GC may be an untrusted non-3GPP access network, a trusted non-3GPP access network or a wireline 5G access network. The support of the ATSSS feature is optional for the SMF and the UPF. + +When establishing a PFCP session for an MA PDU session, the SMF (H-SMF for a HR PDU session) shall: + +- select a PSA (UPF) supporting ATSSS (see MPTCP, MPQUIC and ATSSS-LL flags in UP Function Features, Table 8.2.25-1), i.e. ATSSS-LL, MPTCP, MPQUIC or all, and, if necessary, supporting the Redundant steering mode (see REDSM flag in UP Function Features, Table 8.2.25-1); and +- provision in the PSA (UPF) one Multi-Access Rule (MAR) for every downlink PDR matching non-GBR traffic sent towards the UE. See clause 5.2.7 for the handling of an MAR for non-GBR traffic; and +- provision in the PSA (UPF) one Multi-Access Rule (MAR) for every downlink PDR matching GBR traffic sent towards the UE, if the Steering Mode is "Redundant". See clause 5.2.7 for the handling of an MAR for GBR traffic. + +Distinct N3/N9 tunnels shall be established for each access network of the MA PDU session if the UE is registered to both 3GPP and non 3GPP access by: + +- providing two UL PDRs to the PSA UPF in PFCP Session Establishment Request or PFCP Session Modification Request message, e.g. PDR-1 for UL data from 3GPP access and PDR-2 for UL data from non-3GPP access, to trigger the PSA UPF to allocate two N3/N9 UL CN tunnels as specified in clause 4.22.2.1 and clause 4.22.3.2 of 3GPP TS 23.502 [29]; +- providing two FARs in one MAR associated to the DL PDR to the PSA UPF in PFCP Session Establishment Request or PFCP Session Modification Request message, e.g. FAR-1 for DL data forwarding to 3GPP access and FAR-2 for DL data forwarding to non-3GPP access. + +## 5.20.2 MPTCP functionality + +### 5.20.2.1 General + +The SMF shall instruct the UPF(PSA) to activate MPTCP steering functionality for a given MA-PDU session if MPTCP needs to be used for TCP traffic flows. + +The UPF(PSA) shall allocate resources for MPTCP steering functionality (e.g. MPTCP Proxy address, MPTCP link-specific multipath IP addresses, etc.), and perform traffic steering, switching and splitting according to the instructions from the SMF. + +### 5.20.2.2 Activate MPTCP functionality and Exchange MPTCP Parameters + +If MPTCP steering functionality is required for a Multi-Access PDU session, the SMF shall send MPTCP Control Information to the UPF in PFCP Session Establishment Request, to instruct the UPF to activate the MPTCP functionality for this PFCP session. The SMF may also request to activate the PMF functionality for this PFCP session by sending PMF Control Information to the UPF. As a result, the UPF(PSA) shall allocate necessary resources for MPTCP and PMF and return the corresponding MPTCP and PMF Parameters (e.g. MPTCP IP address and port, MPTCP link-specific multipath IP addresses, PMF IP address and port, etc.) to the SMF in PFCP Session Establishment Response. The SMF may also activate the MPQUIC functionality for this PFCP session as specified in clause 5.20.2.A.2. + +The SMF may send MPTCP Control Information and/or PMF Control Information (and/or MPQUIC Control Information if the MPQUIC functionality is also activated) to the UPF in PFCP Session Modification Request, with updated value, e.g. if the SMF receives updated ATSSS rules from the PCF. + +NOTE 1: Such MPTCP Parameters received by the SMF are sent to the UE together with the ATSSS rules, as specified in 3GPP TS 24.193 [59]. + +When provisioning an UL PDR for user plane traffic for which MPTCP is applicable, the SMF shall include an Multipath Applicable Indication IE with the MTIAI flag set to "1" in the Create PDR IE. + +NOTE 2: This indication can be used by the UPF to prepare itself for the reception of MPTCP traffic for the PDU session. + +### 5.20.2.3 Control of Multipath TCP Connection Establishment by MPTCP Proxy + +When MPTCP steering functionality is utilized, TCP connection establishment and data exchange between an UE and a remote host shall be proxied by the MPTCP Proxy in the UPF (PSA), using the mechanism specified in IETF RFC 8684 [62] and IETF RFC 8803 [60]. + +Once Multipath TCP connection is set up, the MPTCP Proxy shall store the MPTCP session entry which includes the following information: + +- MPTCP link-specific multipath IP addresses and the associated TCP ports; +- UE's MA-PDU session IP address and its TCP port, if the MA-PDU session IP address is used by the MPTCP Proxy for IP translation; +- the N6 routable IP address and its TCP port, if N6 routable IP address is used by the MPTCP Proxy for IP translation; +- the remote host IP address and its TCP port. + +The stored MPTCP session entry is used by MPTCP Proxy for subsequent IP translation when receiving uplink or downlink MPTCP traffic. + +An UPF implementation may use N6 routable IP address instead of UE's MA-PDU session IP address for IP translation. + +NOTE: The DL PDR from the SMF for MPTCP traffic carries the UE's MA-PDU session IP address. If the UPF uses a different N6 routable IP address, it is UPF implementation specific how to match DL PDRs for MPTCP traffic with downlink MPTCP traffic received with the destination address set to the N6 routable IP address. + +### 5.20.2.4 Traffic Steering and IP Translation by MPTCP Proxy + +Once traffic for which MPTCP is applicable is detected by the UPF, the UPF shall internally forward this traffic to the MPTCP Proxy for IP translation. The MPTCP Proxy shall use the stored information in MPTCP session entry to perform IP translation to the detected MPTCP IP packets, e.g. replace the source IP address+port and/or destination IP address+port accordingly. + +The UPF may detect the uplink IP packets for which MPTCP is applicable by checking whether the UL PDR matching the user plane traffic is set with an Multipath Applicable Indication, or (UPF implementation choice) by checking whether the source or destination IP address of the user plane packets (after removing the GTP-U header) correspond to MPTCP link-specific multipath IP address(es) and the MPTCP proxy IP address. + +The UPF may detect the downlink IP packets for which MPTCP is applicable, by checking the information in the associated MAR (e.g. checking if the steering functionality is set to MPTCP) or by checking the destination IP address. + +## 5.20.2A MPQUIC functionality + +### 5.20.2A.1 General + +The SMF shall instruct the UPF(PSA) to activate MPQUIC steering functionality for a given MA-PDU session if MPQUIC needs to be used for UDP traffic flows. + +The UPF(PSA) shall allocate resources for MPQUIC steering functionality (e.g. MPQUIC Proxy address, MPQUIC link-specific multipath IP addresses, etc.), and perform traffic steering, switching and splitting according to the instructions from the SMF. + +### 5.20.2A.2 Activate MPQUIC functionality and Exchange MPQUIC Parameters + +If MPQUIC steering functionality is required for a Multi-Access PDU session and if the UPF indicates supports of the MPQUIC feature (see clause 8.2.25), the SMF shall send MPQUIC Control information to the UPF in PFCP Session Establishment Request, to instruct the UPF to activate the MPQUIC functionality for this PFCP session. The SMF may also request to activate the PMF functionality for this PFCP session by sending PMF Control Information to the UPF. As a result, the UPF(PSA) shall allocate necessary resources for MPQUIC and PMF and return the corresponding + +MPQUIC Parameters (e.g. MPQUIC IP address and port, MPQUIC link-specific multipath IP address) and PMF Parameters (e.g. PMF IP address and port, etc.) to the SMF in PFCP Session Establishment Response. The SMF may also activate the MPTCP functionality for this PFCP session as specified in clause 5.20.2.2. + +The SMF may send MPQUIC Control Information and/or PMF Control Information (and/or MPTCP Control Information if the MPTCP functionality is also activated) to the UPF in PFCP Session Modification Request, with updated value, e.g. if the SMF receives updated ATSSS rules from the PCF. + +NOTE 1: Such MPQUIC Parameters received by the SMF are sent to the UE together with the ATSSS rules, as specified in 3GPP TS 24.193 [59]. + +When provisioning an UL PDR for user plane traffic for which MPQUIC is applicable, the SMF shall include a Multipath Application Indication IE with the MQAI flag set to "1" in the Create PDR IE. + +NOTE 2: This indication can be used by the UPF to prepare itself for the reception of MPQUIC traffic for the PDU session. + +### 5.20.2A.3 Control of Multipath QUIC Connection Establishment by MPQUIC Proxy + +When the MPQUIC steering functionality is utilized, UDP connection establishment and data exchange between an UE and a remote host shall be proxied by the MPQUIC Proxy in the UPF(PSA), using the mechanism defined in IETF RFC 9298 [78], which specifies how UDP traffic can be transferred between a client (UE) and a proxy (UPF) using the HTTP/3 protocol [77] on top of QUIC protocol [76]. + +Once Multipath QUIC connection is set up, the MPQUIC Proxy shall store the MPQUIC session entry which includes the following information: + +- MPQUIC link-specific multipath IP addresses and the associated UDP ports; +- UE's MA-PDU session IP address and its UDP port, if the MA-PDU session IP address is used by the MPQUIC Proxy for IP translation; +- the N6 routable IP address and its UDP port, if N6 routable IP address is used by the MPQUIC Proxy for IP translation; +- the remote host IP address and its UDP port. + +The stored MPQUIC session entry is used by MPQUIC Proxy for subsequent IP translation when receiving uplink or downlink MPQUIC traffic. + +An UPF implementation may use N6 routable IP address instead of UE's MA-PDU session IP address for IP translation. + +NOTE: The DL PDR from the SMF for MPQUIC traffic carries the UE's MA-PDU session IP address. If the UPF uses a different N6 routable IP address, it is UPF implementation specific how to match DL PDRs for the downlink MPQUIC traffic received with the destination address set to the N6 routable IP address. + +### 5.20.2A.4 Traffic Steering and IP Translation by MPQUIC Proxy + +Once traffic for which MPQUIC is applicable is detected by the UPF, the UPF shall internally forward this traffic to the MPQUIC Proxy for IP translation. The MPQUIC Proxy shall use the stored information in MPQUIC session entry to perform IP translation to the detected MPQUIC IP packets, e.g. replace the source IP address+port and/or destination IP address+port accordingly. + +The UPF may detect the uplink IP packets for which MPQUIC is applicable by checking whether the UL PDR matching the user plane traffic is set with a Multipath Applicable Indication, or (UPF implementation choice) by checking whether the source or destination IP address of the user plane packets (after removing the GTP-U header) correspond to MPQUIC link-specific multipath IP address(es) and the MPQUIC proxy IP address. + +The UPF may detect the downlink IP packets for which MPQUIC is applicable, by checking the information in the associated MAR (e.g. checking if the steering functionality is set to MPQUIC) or by checking the destination IP address. + +## 5.20.3 ATSSS-LL functionality + +### 5.20.3.1 Activate ATSSS-LL functionality and Exchange ATSSS-LL Parameters + +If ATSSS-LL steering functionality is required for a Multi-Access PDU session, the SMF shall send ATSSS-LL Control Information to the UPF in PFCP Session Establishment Request, to instruct the UPF to activate the ATSSS-LL functionality for this PFCP session. The SMF may also request to activate the PMF functionality for this PFCP session by sending PMF Control Information to the UPF. + +If PMF functionality is required to be activated for this MA PDU session, the SMF shall set the PMFI flag to 1 in the PMF Control Information IE, regardless whether per QoS flow access performance measurement is required. In addition, if the SMF determines that per QoS flow access performance measurements shall be applied for the MA PDU session, e.g. the threshold value(s) are received from PCF for the UL and/or DL traffic of the QoS flow, the SMF shall set the PQPM flag to 1 together with a list of QFI values for the QoS flows for which access performance measurements may be performed in the PMF Control Information IE. + +Upon receiving the request from the SMF with indicating ATSSS-LL Control Information IE and PMF Control Information IE, the UPF(PSA) shall allocate necessary resources for ATSSS-LL and PMF and return the corresponding ATSSS-LL and PMF Parameters (e.g. PMF IP address and port, etc) to the SMF in PFCP Session Establishment Response: + +- If per access performance measurements are required, i.e. PMFI flag set to 1 in the PMF Control Information IE, the UPF(PSA) shall allocate a default pair of access specific UDP ports (i.e. for IP PDU sessions) or MAC addresses (i.e. for Ethernet PDU sessions) and report them to the SMF in the PMF Address Information IE of a PMF Parameters IE not including the QoS flow identifier IE. +- If per QoS flow access performance measurements are required, i.e. PQPM flag is set to 1 in addition and a list of QFIs are indicated in the PMF Control Information IE, the UPF(PSA) shall allocate access specific UDP ports (i.e. for IP PDU sessions) or MAC addresses (i.e. for Ethernet PDU sessions) for each QoS flow indicated in the PMF Control Information and, for each QoS flow, report them to the SMF in the PMF Address Information IE of a PMF Parameters IE including the QoS flow identifier IE set to the corresponding QFI. + +If the SMF provisions the UPF to apply ATSSS-LL in downlink with "Smallest Delay" steering mode, the UE does not support PMF RTT measurements (see clause 5.32.2 of 3GPP TS 23.501 [28]) and the UPF supports RTT measurements without PMF, the SMF should instruct the UPF to not use PMF RTT measurements by setting the DRTTI flag to "1" in the PMF Control Information. + +NOTE 1: The UPF can measure RTT without using the PMF protocol by using other means not defined by 3GPP such as using the RTT measurements of MPTCP if there is an MPTCP connection established between the UE and UPF. + +The SMF shall not set the Steering Mode "Redundant" if the steering functionality is set to "ATSSS-LL". + +The SMF may send ATSSS-LL Control Information and/or PMF Control Information to the UPF in PFCP Session Modification Request, with updated value, e.g. if the SMF receives updated ATSSS rules from the PCF. + +NOTE 2: Such ATSSS-LL Parameters received by the SMF are sent to the UE together with the ATSSS rules, as specified in 3GPP TS 24.193 [59]. + +## 5.20.4 Handling of GBR traffic of a MA PDU session + +### 5.20.4.1 General + +Traffic splitting of a GBR traffic is not supported (see clause 5.32.4 of 3GPP TS 23.501 [28]). Besides, switching GBR traffic from one access to another access requires the SMF to send N1/N2 messages to the UE and AN. + +DL PDRs corresponding to GBR traffic shall be associated with DL FARs (i.e. no MAR). + +**Editor's note:** Rel-18 introduces the support of the Redundant steering mode that can apply to GBR and non-GBR QoS flows, with the SMF establishing resources in both 3GPP access and non-3GPP access. Accordingly, the text above that says that a MAR cannot be associated to DL PDRs corresponding to GBR traffic needs to be revisited. + +#### 5.20.4.2 Access Availability Reporting + +For an MA PDU session using the ATSSS Low Layer (ATSSS-LL), MPTCP or MPQUIC steering functionality, the SMF may request the UPF to report when it cannot send downlink GBR traffic over its on-going access, e.g. based on access availability and unavailability report from the UE, by provisioning an SRR with an Access Availability Control Information IE requesting the UPF to report when an access (3GPP or non-3GPP access) becomes available or unavailable. + +If so instructed, when detecting a change in an access availability, the UPF shall send an Access Availability Report to the SMF, indicating the access type and whether the access has become available or unavailable. + +#### 5.20.5 Access type of an MA PDU session becoming (un)available + +The access type of an MA PDU session may become unavailable permanently (e.g. when the UE de-registers from one access) or transiently (e.g. when the UE has lost coverage of the 3GPP access or non-3GPP access). + +When an access type of an MA PDU session becomes permanently unavailable, the SMF shall send a PFCP Session Modification Request with an Update MAR IE removing the Access Forwarding Information IE corresponding to the unavailable access. As a result, the UPF shall not send any more traffic on this access type. + +Reversely, when a new access type becomes available for an MA PDU session, e.g. when the UE registers on another access and requests to establish user plane resources for that access, the SMF shall send a PFCP Session Modification Request with an Update MAR IE adding the Access Forwarding Information IE corresponding to the new available access type. + +When an access type of an MA PDU session becomes transiently unavailable, the SMF shall notify the UPF that the access type has become unavailable by sending a PFCP Session Modification Request with the Access Availability Information IE indicating so. The SMF should then also notify the UPF when the access type becomes available again. + +When being notified by the SMF that an access type has become transiently unavailable, the UPF should stop sending DL traffic on this access until it receives the indication that the access becomes available again from the UE (i.e. PMF access available report) or the SMF. + +#### 5.20.6 PMFP message handling in UPF + +The access performance measurement supports the following procedures, as specified in clause 5.32.5.1 of 3GPP TS 23.501 [28]: + +- RTT measurement procedure initiated by the UE, or the UPF; +- Packet Loss Rate measurement procedure initiated by the UE, or the UPF; +- Access available/unavailable report procedure from the UE to the UPF; +- UE Assistance Data provisioning procedure from the UE to the UPF. +- Suspend or resume traffic duplication procedure from the UPF to UE. + +The per QoS flow access performance measurement procedure includes the RTT measurement and the Packet Loss Rate measurement, which may be initiated by the UE or the UPF(PSA). + +PMFP messages are used by the PMF functionality in the UE and the PMF functionality in the UPF (PSA) to perform the access performance measurement procedures, as specified in 3GPP TS 24.193 [59]. + +PMFP messages shall be exchanged between the UE and the UPF via the default QoS flow or a dedicated QoS flow, as specified in 3GPP TS 23.501 [28]. To support this, the UPF shall learn the QFI identifying the QoS flow on which PMFP messages from the UE are transmitted, and shall send downlink PMFP messages on that QoS flow when needed. + +Once an uplink PMFP message is detected, the UPF shall internally forward the PMFP message to the PMF functionality in the UPF, for subsequent handling. + +The PMF functionality in the UPF shall learn the UE's address information for PMFP from the received PMFP message, e.g. to detect the IP address and UDP port of the PMF in the UE (for IP PDU sessions) or the MAC address of + +the PMF in the UE (for Ethernet PDU sessions), and set the source and destination addresses of PMFP messages sent to the UE accordingly, as specified in clause 5.32.5.1A of 3GPP TS 23.501 [28]. + +If the Steering mode is set to Load-Balancing and the UE Assistance Indicator is set, when the UPF receives a PMF message with UE Assistance Data (i.e. PMF-UAD message) from the UE, the UPF may apply the split percentages in the UE Assistance Data to all DL traffic for which the SMF has enabled the UE assistance operation. Meanwhile, the UPF shall store the original split percentage (i.e. the weight included in 3GPP/Non-3GPP Access Forwarding Action Information IE in the MAR) provisioned by the SMF, and apply these when the UE assistance mode is terminated, i.e. when the UPF receives a PMF message indicating the termination of UE assistance mode (i.e. PMF-UAT message). + +When the steering mode is set to Redundant, the UPF may send a PMFP TDS REQUEST message to the UE to suspend traffic duplication over an access of the MA PDU session, e.g. during UPF congestion, and later if the UPF decides to resume traffic duplication for the UE, e.g. when the UPF detects that local congestion is diminished, the UPF may send a PMFP TDR REQUEST message to the UE, as specified in clause 5.32.5.63 of TS 3GPP 23.501 [28], clauses 5.4.10 and 5.4.11 of TS 3GPP 24.193 [59]. + +## 5.21 UE IP address/prefix Allocation and Release + +### 5.21.1 General + +Stage 2 requirements for UE IP address allocation in the EPC and 5GC are specified in clause 5.3.1 of 3GPP TS 23.401 [14], clause 5.8.2.2 of 3GPP TS 23.501 [28] and clause 4.6.2 of 3GPP TS 23.316 [57]. The following types of UE IP addresses may be assigned over N4 or Sxb: + +- IPv4 address; +- /64 IPv6 Prefix; +- IPv6 prefix other than default /64, including individual /128 IPv6 address, if the UPF indicates supports of the IP6PL feature (see clause 8.2.25), for IPv6 address allocation using DHCPv6 specified in clause 4.6.2.2 of 3GPP TS 23.316 [57]; +- IPv6 prefix shorter than the default /64 prefix for support of IPv6 prefix delegation as specified in clause 4.6.2.3 of 3GPP TS 23.316 [57], clause 5.8.2.2.4 of 3GPP TS 23.501 [28] and clause 5.14. + +More than one UE IP address may be assigned to a PDU session, if the UPF indicates supports of the IP6PL feature (see clause 8.2.25), by provisioning multiple instances of the UE IP Address IE in a same PDI or Traffic Endpoint, or by provisioning multiple PDIs or Traffic Endpoints with a different UE IP Address, where the UE IP addresses may correspond e.g. to: + +- multiple /128 IPv6 addresses; or +- an /64 default prefix used for IPv6 stateless autoconfiguration and an IPv6 prefix shorter than the default /64 prefix for IPv6 Prefix Delegation not including the /64 IPv6 Prefix (i.e. when the total IPv6 address space available for the PDU Session cannot be aggregated into one single IPv6 prefix); the IPv6 prefix shorter than the default /64 prefix may be assigned by setting either the IPv6D flag or the IP6PL flag as specified in clause 5.14. + +A UE IPv4 address or IPv6 prefix may be allocated by the CP function or the UP function. A given IP address pool shall be controlled by a unique entity (either the SMF/PGW-C or the UPF/PGW-U or an external server). + +The support of UE IP address/prefix allocation by the CP function is mandatory. The support of UE IP address/prefix allocation by the UP function is optional. See clause 5.8.2.2 of 3GPP TS 23.501 [28]. A UPF supporting the SSET feature (see clause 5.22.2) or the MPAS feature (see clause 5.22.3) shall support UE IP address/prefix allocation in the UP function. + +The UP function shall set the UEIP feature flag in the UP Function Features IE if it supports UE IP address/prefix allocation in the UP function (see clause 8.2.25). If so, the CP function shall determine whether UE IP address or prefix is allocated by the CP function or the UP function based on network configuration. + +If the SSET feature (see clause 5.22.2) or the MPAS feature (see clause 5.22.3) is supported, the SMFs in an SMF set may decide that the CP function should allocate the UE IP address or prefix. In such a case, the SMFs in the SMF set may query a DHCP or AAA server for UE IP address or prefix allocation as specified in clause 5.21.2.2. + +## 5.21.2 UE IP address/prefix allocation in the CP function + +### 5.21.2.1 General + +When performing UE IP address allocation in the CP function, the CP function shall assign the UE IP address/prefix and provide the assigned address/prefix to the UP function in the UE IP Address IE of the PDR IE (see Table 7.5.2.2-1) or of the Traffic Endpoint (see Table 7.5.2.7-1). The CP function shall always provide a full list of assigned address(es)/prefix(es) to the UP function in the PDI or Create/Update Traffic Endpoint IE. + +### 5.21.2.2 UE IP Address/prefix allocation using DHCP or AAA server + +When performing the UE IP address allocation by an SMF set, the SMFs in the SMF set may be configured to use DHCP or AAA server to allocate the UE IP address/prefix as specified in clause 10 of 3GPP TS 29.561 [49] and clauses 11 and clauses 12 of 3GPP TS 29.561 [49], with the following additions: + +- one (or more) DHCPv4 or DHCPv6 server or one (or more) AAA server may be deployed within the 5GC for resiliency; +- different SMFs of an SMF set may request, renew and release the IP address assigned to a given PDU session, e.g. when the PDU session is taken over by a different SMF during the lifetime of the PDU session. + +The lease time assigned by the DHCP or AAA server for IP addresses may be set by the operator to a long time to minimize the need for IP address renewal. When the lease time is approaching expiry, the SMF should request the DHCP server to renew the IP address (keeping the IP address unchanged) or the SMF should initiate a AAA re-authorization to renew the IP address (keeping the IP address unchanged). + +NOTE: The lease time is stored in the PDU session context (which is shared by the SMFs of the SMF set). So any SMF in the SMF set taking over the control of the PDU session can determine whether the lease time is approaching expiry. + +## 5.21.3 UE IP address/prefix allocation in the UP function + +### 5.21.3.1 General + +When performing UE IP address/prefix allocation in the UP function, the CP function shall request the UP function to allocate the UE IP address/prefix by: + +- setting the CHOOSE flags (CHOOSE IPV4 and/or CHOOSE IPV6) in the UE IP Address IE of the PDR IE (see Table 7.5.2.2-1) or of the Traffic Endpoint (see Table 7.5.2.7-1); the IPv6 prefix length shall be indicated in the UE IP Address if an IPv6 prefix other than default /64 and other than for IPv6 prefix delegation (see clause 5.14) is to be assigned and the UPF indicated support of the IP6PL feature (see clause 8.2.25); and +- including the Network Instance IE to indicate the IP address pool from which the UE IP address/prefix is to be assigned. +- optionally including the UE IP address Pool Identity from which the UE IP address shall be allocated by the UP function. + +The CP function may request the UP function to allocate the same UE IP address/prefix to several PDRs to be created (i.e. using Create PDR) within one single PFCP Session Establishment Request or PFCP Session Modification Request, or to several PDRs to be modified (i.e. using Update PDR) within one single PFCP Session Modification Request by: + +- setting the CHOOSE flags (CHOOSE IPV4 and/or CHOOSE IPV6) in the UE IP Address IE of each PDR to be created with a new UE IP address/prefix or each PDR to be modified; + +or, if the UP function indicated support of the PDI optimization (see clause 8.2.25), by: + +- including the UE IP Address IE in the Create Traffic Endpoint IE or Update Traffic Endpoint IE, and by setting the CHOOSE flags (CHOOSE IPV4 and/or CHOOSE IPV6) in that UE IP Address IE; and +- including the Traffic Endpoint ID in all the PDRs to be created with the same UE IP address or all PDRs to be modified with additional UE IP address(es). + +If the PDR(s) is created or modified successfully or the Traffic Endpoint(s) is created or modified successfully, the UP function shall always return the full list of UE IP address/prefix in the UE IP Address IE(s) it has assigned to the PDR(s) or to the Traffic Endpoint(s) in the PFCP Session Establishment Response or PFCP Session Modification Response. + +Upon receiving a request to delete a PFCP session, to remove a Traffic Endpoint associated with the UE IP address/prefix, or to remove the last PDR associated with the UE IP address/prefix, the UP function shall release the UE IP address/prefix that was assigned to the PFCP session, to the Traffic Endpoint, or to the PDR. + +NOTE 1: When the CP function requests additional UE IP Address in the Update PDR or Update Traffic Endpoint IE, it needs not include any existing UE IP Address(es). + +If the UP Function supports the "Per Slice UP Resource management" feature and if the feature is enabled in the UP Function, the UP Function shall take the S-NSSAI associated with the PFCP session into account when allocating UE IP address, together with other information present (e.g. Network Instance, UE IP address Pool Identity). + +### 5.21.3.2 Reporting UE IP Address Usage to the CP function + +The UE IP Address Usage Reporting feature (see clause 8.2.58) is an optional feature. The following requirements shall apply if UE IP addresses are allocated by the UP function and both the CP function and UP function support the UE IP Address Usage Reporting feature. + +The UP Function should report UE IP address usage information to the CP function for network instances and/or IP address pools whose ratio of occupied (i.e. already assigned) IP addresses to the configured IP addresses in the UP Function exceeds a configurable threshold. If the UP Function supports the "Per Slice UP Resource management" feature and if the feature is enabled in the UP Function, the UP Function shall additionally indicate the S-NSSAI associated with the UE IP address usage information. The UP function shall do so by sending one or more PFCP Association Update Request messages to the CP function, including a UE IP Address Usage Information IE per network instance and/or IP address pool. Each UE IP Address Usage Information IE shall include a validity timer that informs the CP function for how long the UE IP address Usage Information shall be considered as valid. Each UE IP Address Usage Information shall also contain a UE IP Address Usage Sequence Number, which enables the CP function to determine the latest UE IP Address Usage Information generated by the UP function for a given network instance and/or IP address pool. + +The UP function may update the UE IP address usage information reported to the CP function if needed, by sending subsequent PFCP Association Update Request/Response messages, including updated UE IP address Usage Information IEs with a (new) validity timer. The UP function shall increment the UE IP Address Usage Sequence Number when updating UE IP address usage information. The UP function shall also increment the UE IP Address Usage Sequence Number when the IP address usage has not changed but the validity timer needs to be renewed. + +NOTE 1: The threshold value in the UP function needs to be selected in such way that it avoids frequent UE IP address usage reporting for network instances and/or UE IP address pools with low usage. + +The CP function shall use the latest updated UE IP address Usage Information received for a given network instance and/or UE IP Address Pool. The CP function shall ignore a UE IP Address Usage Information IE received for a given network instance and/or IP address pool with a UE IP Address Usage Sequence Number smaller or equal to the UE IP Address Usage Sequence Number of an already received and stored information. + +If the validity timer has not expired, the CP function shall keep the latest updated UE IP Address Usage Information received for a given Network Instance and/or UE IP Address Pool if it receives a PFCP Association Update Request/Response not including a UE IP Address Usage Information IE for this network instance and/or UE IP Address Pool. + +NOTE 2: The UE IP Address Usage Information IE may be absent e.g. if the PFCP Association Update Request/Response is sent for other regular purposes, or if the ratio remains the same, or if the ratio has not changed enough to justify being reported again. + +The CP function shall delete UE IP Address Usage Information if its validity period has expired. + +## 5.22 PFCP sessions successively controlled by different SMFs of an SMF set (for 5GC) + +### 5.22.1 General + +A PFCP session may be controlled by different SMFs of an SMF Set using either one PFCP association per SMF Set and UPF as described in clause 5.22.2 (called SSET feature), or with each SMF of the SMF set establishing its own PFCP association with the UPF as described in clause 5.22.3 (called MPAS feature). + +A UPF complying with this version of the specification and that supports being controlled by an SMF set shall support the procedures specified in clauses 5.22.3 (i.e. MPAS feature) and may support the procedures specified in clause 5.22.2 (i.e. SSET feature). + +The requirements specified in this clause for the UPF, SMF and SMF set shall also apply to: + +- combined PGW-U/UPF, combined PGW-C/SMF and combined PGW-C/SMF Set respectively; +- MB-SMF and MB-UPF, for MB-SMFs deployed in an MB-SMF set; and +- combined SMF/MB-SMF, combined UPF/MB-UPF for combined SMF/MB-SMFs Set. + +An SMF supporting the SSET feature or the MAPS feature shall be ready to take over the control of a PFCP session from another SMF within the same SMF SET, upon receiving a request from a UPF requiring an SMF change, if possible. + +### 5.22.2 With one PFCP association per SMF Set and UPF + +When a UPF supports that a PFCP session can be successively controlled by different SMF(s) in the same SMF set, the following applies: + +- 1) One SMF in the SMF set shall establish one single PFCP Association with the UPF for the SMF set; the Node ID in the PFCP Association Setup Request shall be set to an FQDN representing the SMF set. + +The SMF shall indicate that it supports the SSET feature in the CP Function Features IE (see clause 8.2.58); this indicates to the UPF that the PFCP sessions established with this PFCP association can be successively controlled by different SMFs of an SMF set according to the procedure defined in this clause. + +The SMF may also indicate the IP addresses of alternative SMFs within the SMF Set and the IP addresses of alternative PFCP entities pertaining to the same SMF in the Alternative SMF IP Address IE(s) in the PFCP Association Setup Request and in the subsequent PFCP Association Update Request messages. Those Alternative SMF IP Address IE(s) with the PPE (Preferred PFCP Entity) flag set to "1" are alternative PFCP entities that the UPF shall select preferably when such reselection is required as specified in the following bullet 4. + +NOTE 1: Those Alternative SMF IP Address IE(s) with the PPE flag set to "1" are PFCP entities in the preferred binding entity corresponding to the binding level in the Binding Indication of the resource context created for the PDU session when binding procedures are supported in the SMF as specified in clause 6.12 of 3GPP TS 29.500 [74]. + +- 2) When establishing a PFCP session, the SEID that the SMF assigns in the CP F-SEID of the PFCP Session Establishment Request may be unique or not within the SMF set. However the assigned CP F-SEID shall be unique within the SMF set. + +NOTE 2: The UPF does not (need to) know whether the SEID in the CP F-SEID is uniquely assigned in the SMF set or not. + +- 3) Any SMF in the SMF set may issue requests to modify or delete the PFCP session, or to update or release the PFCP association. The UPF shall allow the related PFCP request to come from any other SMF from the same SMF set. +- 4) The UPF shall initiate PFCP session related requests (e.g. PFCP Session Report Request) towards another PFCP entity pertaining to the same SMF or another SMF of the SMF Set, if the IP address included in the CP F-SEID + +assigned to the PFCP session is not responsive, or if the UPF receives a GTP-U Error Indication from the SMF over the N4-u tunnel assigned to the N4 session for data forwarding if any. + +The UPF shall firstly use the IP addresses included in those Alternative SMF IP Address IE(s) with the PPE flag set to "1" (if available) whenever possible, then it may use the IP addresses included in the Alternative SMF IP Address IE(s) without the PPE flag set to "1", to contact an alternative PFCP entity. Otherwise the UPF shall use the SMF set FQDN in the CP Node ID to discover alternative SMFs within the SMF Set, e.g. by querying the DNS or by performing a discovery request towards the NRF. + +When sending the request to another PFCP entity pertaining to the same SMF or to the new SMF, the UPF shall set the SEID field to zero in the PFCP header of the PFCP request and include the CP F-SEID assigned by the previous SMF in the request. + +- 5) When receiving a request from a UPF with the SEID field set to zero and CP F-SEID assigned by previous SMF, the SMF shall take over the control of the PFCP session from the previous SMF, unless it is needed to redirect the request to a different SMF (e.g. due to high load or because the corresponding session context has already been taken over by a different SMF in the same SMF set). + +An SMF may redirect a UPF initiated PFCP session related request to another PFCP entity pertaining to the same SMF or to a different SMF in the SMF set by rejecting the request with the cause "Redirection Requested" and with the IP address of the new entity to contact. When sending the redirected request to the new entity, the UPF shall set the SEID field to zero in the header of the PFCP request and include the CP F-SEID assigned by the previous SMF in the request. + +Alternatively, an SMF may forward the UPF request to another PFCP entity pertaining to the same SMF or to a new SMF in the SMF set; the new PFCP entity or the new SMF answers to the UPF, including the CP F-SEID IE with the IPv4 or IPv6 address of the new entity respectively and the same or a modified SEID, and optionally including the N4-u F-TEID that the UPF shall use for sending data towards the new entity. + +NOTE 3: This allows to address cases where a different SMF would have been reselected in the 5GC for the PFCP session, e.g. by an AMF. + +- 6) An SMF may also update, at any time, a PFCP session by including the CP F-SEID with the IPv4 or IPv6 address of a new SMF and/or a new SEID assigned by the new SMF in a PFCP Session Modification Request. +- 7) The UPF shall not trigger the restoration procedures specified in 3GPP TS 23.527 [40] for a PFCP session that can be controlled by different SMFs of an SMF set when a heartbeat failure is detected for the IP address of the assigned CP F-SEID. Restoration procedures shall be triggered only if heartbeat procedures fail with all the IP addresses of all the SMFs in the SMF set. + +NOTE 4: The above requirements enable all SMFs of a same SMF set to successively control a given PFCP session without causing extra signalling over the N4 interface. + +- 8) A UPF supporting the SSET feature shall support UE IP address/prefix allocation in the UP function (see clause 5.21). + +### 5.22.3 With one PFCP association per SMF and UPF + +If multiple PFCP associations are setup between an UPF and the SMFs in an SMF set, the following applies: + +- 1) Each SMF in the SMF set shall establish its own PFCP association with the UPF and shall provide the Node ID IE set to an FQDN or IP address of the SMF and the SMF Set ID IE set to an FQDN representing the SMF set. All SMFs of an SMF set shall indicate the same SMF Set ID. Alternatively, if PFCP Association Setup is initiated by UPF as defined in clause 6.2.6.3, each SMF in the SMF set shall provide this information in PFCP Association Setup Response message. + +The SMF shall indicate that it supports the MPAS feature (Multiple PFCP Associations to the SMFs in an SMF set) in the CP Function Features IE (see clause 8.2.58); this indicates to the UPF that the PFCP sessions established with this PFCP association can be successively controlled by different SMFs of the same SMF set according to the procedure defined in this clause. + +The SMF may also provide a list of alternative IP addresses of PFCP entities pertaining to the same SMF in the + +Alternative SMF IP Address IE in the PFCP Association Setup Request message and in the subsequent PFCP Association Update Request messages. Those Alternative SMF IP Address IE(s) with the PPE flag set to "1" are alternative PFCP entities that the UPF shall select preferably when such reselection is required as specified in the following bullet 6. + +The UPF and SMF shall identify the PFCP association by the Node ID of the SMF and UPF respectively. + +Likewise, when an SMF is added or removed from the SMF set, this SMF shall establish or tear down its PFCP association with the UPF. Alternatively, when an SMF updates its SMF SET ID using the PFCP Association Update procedure, the UPF shall maintain the existing PFCP sessions served by this SMF and use the new SMF Set ID of the SMF if the UPF needs to later reselect a different SMF instance for these PFCP sessions (as defined in step 6). + +- 2) When establishing a PFCP session, the SEID that the SMF assigns in the CP F-SEID of the PFCP Session Establishment Request may be unique or not within the SMF set. However the assigned CP F-SEID shall be unique within the SMF set. + +NOTE 1: The UPF does not (need to) know whether the SEID in the CP F-SEID is uniquely assigned in the SMF set or not. The SMF and the UPF identifies the PFCP session by its own CP F-SEID and UP F-SEID respectively. + +- 3) Any SMF in the SMF set may issue requests to modify or delete the PFCP session. When the SMF controlling a PFCP session changes, the SMF that takes over the control of the PFCP session shall provide its own Node ID and may provide a new CP F-SEID. + +The UPF shall allow the PFCP session modification or deletion request to come from any other PFCP association from the same SMF set. + +- 4) At any time, an SMF may update a PFCP session by including the CP F-SEID with the IPv4 or IPv6 address of a new SMF and/or a new SEID assigned by the new SMF in a PFCP Session Modification Request. +- 5) When receiving a request from a UPF with the SEID field set to zero and CP F-SEID assigned by previous SMF, the SMF shall take over the control of the PFCP session from the previous SMF, unless it is needed to redirect the request to a different SMF in the same SMF set (e.g. due to high load or because the corresponding session context has already been taken over by a different SMF in the same SMF set). + +An SMF may redirect a UPF initiated PFCP session related request to another PFCP entity pertaining to the same SMF or to a different SMF in the SMF set by rejecting the request with the cause "Redirection Requested" and with the IP address of the new entity to contact. When sending the redirected request to another PFCP entity pertaining to the same SMF or to the new SMF, the UPF shall set the SEID field to zero in the header of the PFCP request and include the CP F-SEID assigned by the previous SMF in the request. + +Alternatively, an SMF may forward the UPF request to another PFCP entity pertaining to the same SMF or another SMF in the SMF set; the new PFCP entity or the new SMF answers to the UPF, including the CP F-SEID IE with the IPv4 or IPv6 address of the new entity respectively and the same or a modified SEID, and optionally including the N4-u F-TEID that the UPF shall use for sending data towards the new entity. + +NOTE 2: This allows to address cases where a different SMF would have been reselected in the 5GC for the PFCP session, e.g. by an AMF. + +- 6) The UPF shall initiate PFCP session related requests (e.g. PFCP Session Report Request) towards another PFCP entity pertaining to the same SMF or to another SMF in the SMF set with which the UPF has established associations with the same SMF Set ID, if the IP address included in the CP F-SEID assigned to the PFCP session is not responsive, heartbeat failure towards IP address of the CP F-SEID assigned to the PFCP session, or if the UPF receives a GTP-U Error Indication from the SMF over the N4-u tunnel assigned to the N4 session for data forwarding. + +The UPF shall firstly use the IP addresses included in those Alternative SMF IP Address IE(s) with the PPE flag set to "1" (if available) whenever possible, then it may use the IP addresses included in the Alternative SMF IP Address IE(s) without the PPE flag set to "1", to contact an alternative PFCP entity. + +When sending the request to the new entity, the UPF shall set the SEID field to zero in the PFCP header of the PFCP request and include the CP F-SEID assigned by the previous SMF in the request. + +- 7) The UPF shall not trigger the restoration procedures specified in 3GPP TS 23.527 [40] for a PFCP session that can be controlled by different SMFs of an SMF set when a heartbeat failure is detected. Restoration procedures shall be triggered only if heartbeat procedures fail with all of the SMFs in the SMF set (i.e. the SMFs with which the UPF has established associations with the same SMF Set ID). +- 8) If an SMF or UPF fails, the peer PFCP node that detects that error shall remove the PFCP association locally. +- 9) A UPF supporting the MPAS feature shall support UE IP address/prefix allocation in the UP function (see clause 5.21). + +## 5.22.4 Restoration of PFCP Sessions associated with an FQ-CSID, Group ID or PGW-C/SMF IP Address + +As specified in clause 31.6 of 3GPP TS 23.007 [24] and clause 4.6 of 3GPP TS 23.527[40], for deployments with PGW-C/SMF Set, the CP function (e.g. a PGW-C or a SMF) and the UP function (a PGW-U or a UPF) may support the feature "Restoration of PFCP Sessions associated with one or more PGW-C/SMF FQ-CSID(s), Group Id(s) or PGW-C/SMF IP address(es)". A CP function and a UP function that supports this feature shall behave as specified in clause 5.22.2 or 5.22.3 with the following additional requirements: + +- 1) A UP function that supports this feature shall indicate so to the CP function by setting the RESPS feature bit in the UP Function Feature IE (see clause 8.2.25). +- 2) The PGW-C/SMF in a PGW-C/SMF Set may allocate a globally unique Group Id to a PFCP session, in the PFCP Session Establishment Request message during the PFCP session establishment procedure and may update the Group Id associated to the PFCP session in a PFCP Session Modification Request message if necessary. The UP function shall store the Group Id associated to a PFCP session. At most one Group ID may be associated to a PFCP session. +- 3) Alternatively, if partial failure handling is supported, the PGW-C/SMF may assign an FQ-CSID to a PFCP session as specified in clause 31 of 3GPP TS 23.007 [24] and clause 4.6 of 3GPP TS 23.527 [40]. +- 4) The PGW-C/SMF (either the PGW-C/SMF serving the PFCP sessions or another PGW-C/SMF in the same Set taking over the control of the PFCP sessions) may send a PFCP Session Set Modification Request message to the PGW-U/UPF(s), including either one or more PGW-C/SMF FQ-CSID IE(s) allocated earlier, or one or more Group Id IE(s) allocated earlier, or one or more CP (PGW-C/SMF) IP Addresses and an Alternative SMF IP Address IE, to request the PGW-U/UPF(s) to send subsequent PFCP Session Report Request messages to the same or an alternative PGW-C/SMF (as indicated in the Alternative SMF IP Address IE) for the PFCP Sessions which are associated with the PGW-C/SMF FQ-CSID(s) or the Group Id IEs, or which have their F-SEID containing the CP IP Address. The PGW-C/SMF may instruct the UP function to move sessions associated with different PGW-C/SMF FQ-CSID(s), Group Ids or CP IP Addresses, to different PGW-C/SMF addresses. +- 5) When the PGW-U or UPF sends subsequent PFCP Session Report Request message to the indicated alternative PGW-C/SMF address, the PGW-U or UPF may receive either a new PGW-C/SMF FQ-CSID or a new Group Id for that PFCP session in the PFCP Session Report Response message from the new PGW-C/SMF. + +NOTE: The above procedure enables a PGW-C/SMF to move groups of sessions to one or more different PGW-C/SMF instances, e.g. during a partial failure in a PGW-C/SMF or when a PGW-C/SMF is shutting down (e.g. scale-in operation), in one signal PFCP message. This allows the PGW-C/SMF to control how PFCP sessions are re-distributed in the SMF set. + +## 5.23 5G VN Group Communication (for 5GC) + +### 5.23.1 General + +Stage 2 requirements for the support of 5G VN communication are specified in clauses 4.4.6 and 5.8.2.13 of 3GPP TS 23.501 [28]. + +The 5G VN group communication includes one to one communication and one to many communication. + +One to one communication supports forwarding of unicast traffic between two UEs within a 5G VN, or between a UE and a device on the DN. + +One to many communication supports forwarding of multicast traffic and broadcast traffic from one UE (or device on the DN) to many/all UEs within a 5G VN and/or devices on the DN. + +5G VN Group Communication is optional to support. The SMF may instruct the UPF to forward unicast and/or broadcast traffic as described below if the UPF has indicated support of 5G VN Group Communication (see feature GCOM in clause 8.2.25). + +There are 3 different traffic forwarding methods, i.e. UPF local switching, N6-based forwarding and N19-based forwarding, to forward traffic within the 5G VN group. + +For all methods, traffic forwarding within the 5G VN group is realized by using a UPF internal interface ("5G VN Internal") and a two-step detection and forwarding process. In the first step, the packets received from any 5G VN group member (via its PDU Session, via N6 or via N19) are forwarded to the UPF internal interface (i.e. Destination Interface set to "5G VN Internal"). In the second step, PDRs installed at the UPF internal interface (i.e. Source Interface set to "5G VN Internal") detect the packet and forward it to the respective 5G VN group member (via its PDU Session, via N6 or via N19). If more than one 5G VN group has to be supported, the Network Instance set to a value representing the 5G VN group is used in addition to the UPF internal interface to enable isolation of the 5G VN group communication during the packet detection and forwarding process. + +When N19-based forwarding is used, the SMF may correlate all the PDU sessions for the 5G VN Group members to generate the PDR and FAR corresponding to the group level N4-session for UPF as specified in clause 5.29.3 of 3GPP TS 23.501 [28]. + +For Ethernet unicast traffic on 5G VN Group Communication, the SMF may either explicitly configure DL PDR with the MAC addresses detected by the UPF on PDU Sessions supporting a 5G VN group, or rely on MAC address learning in UPF related with a 5G VN group by setting the Ethernet PDU Session Information indication in the DL PDR of the "5G VN internal" interface as specified in clause 5.8.2.13.0 of 3GPP TS 23.501 [28]. + +To enable IP or Ethernet type broadcast traffic forwarding of a 5G VN Group, the SMF may provide the PDRs related to the group level N4-session and each 5G VN group member' N4 Session to the UPF as specified in clause 5.8.2.13.3 of 3GPP TS 23.501 [28]. + +The details of the PDR and FAR setting over N4 for unicast traffic forwarding within a 5G VN are specified in clauses 5.8.2.13.1 and 5.8.2.13.2 of 3GPP TS 23.501 [28]. + +The details of the PDR and FAR setting over N4 for broadcast traffic forwarding within a 5G VN are specified in clause 5.8.2.13.3 of 3GPP TS 23.501 [28]. + +If a PIN has more than one PEGCs, 5G VN Group Communication may be used for the PIN as specified in clause 5.44.3 of 3GPP TS 23.501 [28]. In this case, separation of multiple PINs communication in the UPF uses different network instances as it is for 5G VN Group. + +The UPF local switching may be applied to PIN indirect communication when there are multiple PDU sessions for a PIN from different PEGCs connecting to the same UPF. The N6-based forwarding may be applied to PIN-DN communication. + +## 5.23.2 5G VN group communication without N6-based forwarding + +The 5G VN group communication may be either among the UEs within a 5G VN group and the devices on the DN, or among the UEs within a 5G VN group only. In case the 5G VN group communication is among the UEs within a 5G VN group only, the DN is excluded from the 5G VN group communication and only the traffic between the UEs within a VN group shall be handled by the UPF internal interface ("5G VN Internal"). In the latter case, the N6-based traffic forwarding method is not applicable. + +So, for each PFCP session of UEs within a 5G VN group, the SMF shall provide: + +- different PDRs/FARs to only forward the 5G VN group communication traffic to the UPF internal interface ("5G VN Internal") based on the IP/MAC address(es) of all the UEs in SDF filter IE or multicast/broadcast IP/MAC address(es), and to send the non-5G VN communication traffic directly to DN with a match-all Packet Filter and a Precedence set to the lowest precedence value; and +- different PDRs/FARs to forward 5G VN group communication traffic from UPF internal interface ("5G VN Internal") to the UE, and to forward the non-5G VN group communication traffic from the DN directly to the UE. + +Additionally, if the N19-based forwarding applies, the SMF shall not configure the group-level N4 Session to forward 5G VN group communication traffic to N6. + +## 5.24 Support of Ultra Reliable Low Latency Communication for 5GC + +### 5.24.1 General + +Stage 2 requirements for the support of Ultra Reliable Low Latency Communication (URLLC) are specified in clause 5.33 of 3GPP TS 23.501 [28]. + +NOTE 1: In this release of specification redundant transmission on N3/N9 interfaces for URLLC is not supported for PDU Sessions involving an I-SMF. See 3GPP TS 23.501 [28] clauses 5.34, 5.33.2.2 and 3GPP TS 23.502 [29] clause 4.24. + +Redundant transmission is applied for supporting the highly reliable URLLC services, there are three different methods: dual connectivity based end to end redundant user plane paths, redundant transmission on N3/N9 interfaces or redundant transmission at transport layer. + +NOTE 2: Dual connectivity based end to end redundant user plane paths has no impact to N4 interface. + +QoS Monitoring is applied for packet delay measurement. The packet delay between UE and PSA UPF is a combination of the uplink or downlink packet delay on Uu interface and uplink or downlink packet delay between NG-RAN and PSA UPF. The QoS Monitoring on uplink or downlink packet delay between NG-RAN and PSA UPF can be performed on different levels of granularities, i.e. per QoS Flow per UE level, or per GTP-U path level. + +Support of the URLLC feature is an optional for the SMF and UPF, for 5GC. + +### 5.24.2 Redundant Transmission on N3/N9 interfaces + +#### 5.24.2.1 General + +Stage 2 requirements for support of Redundant Transmission on N3/N9 interfaces for high reliability communication are specified in clause 5.33.2.2 of 3GPP TS 23.501 [28]. + +This requires duplicating downlink and uplink packets of QoS flows requiring redundant transmission of a PDU session via two independent N3 or N9 tunnels between the RAN and the UPF (PSA). + +The following requirements shall apply for QoS flows requiring redundant transmission. Requirements in clause 5.2.2.3.3 shall also apply for traffic usage reporting. + +#### 5.24.2.2 GTP-U tunnel setup for redundant transmission + +The SMF shall request the UPF (PSA) to establish two N3 or N9 tunnels for a PDU session with one or more Service Data Flows associated with QoS flow(s) requiring redundant transmission as follows: + +- when provisioning an UL PDR in the UPF (PSA), the SMF shall request the UPF to assign two Local F-TEIDs for the PDR, by provisioning the PDI or the Traffic Endpoint with the Redundant Transmission Detection Parameters IE. The SMF may provide two different Network Instances for these two F-TEIDs to achieve disjoint transport layer paths; +- alternatively, the SMF may request the UPF to assign one Local F-TEID for the related Network Instance when creating the UL PDR, and later request the UPF to assign another Local F-TEID with the same or a different Network Instance when updating the PDR, if the redundant transmission tunnels are not established during the PDU session establishment; +- when provisioning DL FAR in the UPF (PSA) corresponding to QoS flows requiring redundant transmission, the SMF shall request the UPF to duplicate the downlink packets for redundant transmission and the SMF shall provide two F-TEIDs of remote GTP-U tunnel endpoints in the FAR, as described in clause 5.24.2.3; + +- alternatively, the SMF may provide one remote endpoint F-TEID when creating the FAR and later provide another remote endpoint F-TEID when updating the FAR, if the redundant transmission tunnels are not established during the PDU session establishment. + +NOTE: To forward downlink packets pertaining to service data flows not requiring redundant transmission, the SMF can create a separate FAR not requiring to duplicate the packets. + +The PSA UPF shall assign the local F-TEID(s) for establishing the redundant tunnel and include the Local F-TEID(s) for Redundant Transmission IE in the PFCP Session Establishment Response or the PFCP Session Modification Response to the SMF if the Redundant Transmission Detection Parameters IE was received in the corresponding request message. + +The SMF shall request the UPF (PSA) to remove one N3 or N9 tunnel used for redundant transmission if redundant transmission is no longer needed as follows: + +- request the UPF to remove the local F-TEID for redundant transmission by updating the PDI or the Traffic Endpoint in UL PDR with a null length Redundant Transmission Detection Parameters IE; +- request the UPF to remove the F-TEID of remote GTP-U tunnel endpoint for redundant transmission by updating the FAR in DL PDR with a null length Redundant Transmission Forwarding Parameters IE; +- set the DFRT and EDRT flags to 0 in the FAR associated to the corresponding UL and DL PDRs, to stop duplicating packets and eliminating duplicate packets. + +When so instructed, the PSA UPF shall remove the local F-TEID for redundant transmission and the F-TEID of remote GTP-U tunnel endpoint for redundant transmission, stop duplicating packets and stop detecting/eliminating duplicate packets accordingly. + +### 5.24.2.3 Duplicating downlink packets for redundant transmission + +If redundant transmission is required for a QoS flow, the SMF shall instruct the PSA UPF to replicate each downlink packet of the QoS Flow and to assign a sequence number to them by provisioning a FAR with the following information in a PFCP Session Establishment Request or PFCP Session Modification Request: + +- the Redundant Transmission Forwarding Parameters IE including an Outer Header Creation IE set to the remote F-TEID of the redundant GTP-U tunnel, and if the GTP-U tunnel for redundant transmission uses a different network instance than the primary GTP-U tunnel, the Network Instance to be used for redundant transmission; +- the Apply Action IE with both the FORW and the DFRT flags set to "1". + +When so instructed, the PSA UPF shall replicate downlink packets associated to such a FAR and construct the duplicated downlink packets using the information included in the Redundant Transmission Forwarding Parameters IE and other information included in the Forwarding Parameters IE for information that is not part of the Redundant Transmission Forwarding Parameters IE. The PSA UPF shall add the same sequence number in the PDU Session Container extension header of the downlink packet and the related duplicated downlink packets as specified in 3GPP TS 38.415 [34]. + +### 5.24.2.4 Eliminating duplicated uplink packets + +For QoS flows for which redundant transmission is required, the SMF shall also instruct the PSA UPF to eliminate the duplicated uplink packets of the QoS Flow, based on their sequence numbers in the PDU Session Container extension header by setting the EDRT flag and the FORW flag in the Apply Action IE in the FAR IE to request the UPF to eliminate the duplicated uplink packets based on the sequence number, i.e. to forward the uplink packets and to drop duplicated uplink packets. When so instructed, the PSA UPF shall forward the only one copy of the uplink packets and drop duplicate uplink packets. + +## 5.24.3 Redundant Transmission at transport layer + +Stage 2 requirements for support of Redundant Transmission at transport layer for high reliability communication are specified in clause 5.33.2.3 of 3GPP TS 23.501 [28]. + +If it supports the redundant transmission at transport layer, the UP function shall set the RTTL feature flag in the UP Function Features IE (see clause 8.2.25). If so, during the UE requested PDU session establishment procedure, the CP function may select the UPF that supports redundant transmission at transport layer for the PDU session. + +Requirements in clause 5.2.2.3.3 shall apply for traffic usage reporting. + +NOTE: How the UPF perform the redundant transmission at transport layer is left up to UPF implementation. + +## 5.24.4 Per QoS Flow Per UE QoS Monitoring + +### 5.24.4.1 General + +Stage 2 requirements for support of per QoS flow per UE QoS monitoring are specified in clause 5.33.3.2 of 3GPP TS 23.501 [28]. + +The UPF shall set the QFQM feature flag in the UP Function Features IE if it supports per QoS flow per UE QoS monitoring for packet delay (see clause 8.2.25). If so, the SMF may request the UPF to perform per QoS flow per UE QoS monitoring during a PFCP session establishment or a PFCP session modification procedure. + +The SMF shall instruct the UPF to perform per QoS flow QoS monitoring for packet delay as specified in clause 5.24.4.2. + +The UPF shall report the QoS monitoring result of the QoS flows to the SMF by sending QoS Monitoring Report IEs to the SMF as specified in clause 5.24.4.3, or by reporting the QoS monitoring events directly to the Local NEF or AF (see clause 5.33.5). + +### 5.24.4.2 QoS Monitoring Control + +The SMF shall instruct the UPF to perform per QoS flow QoS monitoring for packet delay as specified in clause 5.39.2, with the following additions: + +- the Requested QoS Monitoring IE in the QoS Monitoring per QoS flow Control Information IE shall indicate a request to monitor the downlink packet delay, uplink packet delay, and/or the round-trip packet delay between the UPF (PSA) and UE; +- the Packet Delay Thresholds IE shall be present in the QoS Monitoring per QoS flow Control Information IE indicating thresholds for the downlink packet delay, uplink packet delay, and/or the round-trip packet delay to generate the QoS monitoring reports to the CP function, if the Event Triggered QoS monitoring reporting is required in the reporting frequency; and +- the Measurement Period IE shall be present in the QoS Monitoring per QoS flow Control Information IE, indicating the period to generate periodic usage reports to the SMF (if the periodic QoS monitoring reporting is required in the reporting frequency) and the period used to detect and report a QoS monitoring measurement failure (if Periodic QoS monitoring reporting or Event Triggered QoS monitoring reporting is required in the reporting frequency). + +### 5.24.4.3 QoS Monitoring Reporting + +If the UPF is requested to perform QoS Monitoring (i.e. it receives one or more QoS Monitoring per QoS flow Control Information IEs from the SMF), the UPF shall select one or more downlink payload packets pertaining to every requested QoS flow(s) whenever available or create one or more dummy downlink GTP-U packets (i.e. G-PDU messages without a T-PDU as specified in clause 5.2.2.7 of 3GPP TS 29.281 [3]) otherwise, and insert the time stamp, and set the QoS Monitoring Packet (QMP) flag to "1" and the corresponding QoS Flow Identifier (for the requested QoS flow) into the GTP-U PDU Session Container extension header (see 3GPP TS 38.415 [34]) of these downlink packets. + +When receiving the uplink packet related to the requested QoS flow(s), the UPF shall measure the packet delay(s) based on the time stamp(s) and packet delay(s) included in the GTP-U PDU Session Container extension header (see 3GPP TS 38.415 [34]) of the uplink packet, and generate a QoS monitoring report towards the SMF, if the packet delay(s) exceeds the defined Packet Delay Thresholds and Event Triggered QoS monitoring reporting is required in the reporting frequency. The UPF may send a next report only after the minimum waiting time indicated by the SMF. + +NOTE: The dummy GTP-U packet(s) are not forwarded to the UE neither to the Packet Data Network, thus they are not measured for usage reporting. An Intermediate UPF between the PSA UPF and the NG-RAN forwards any received dummy GTP-U packets together with the GTP-U PDU Session Container extension header to the next GTP-U entity. + +If the Periodic QoS monitoring reporting is required in the reporting frequency, the UPF shall generate QoS monitoring report based on the Measurement Period. + +The UPF shall send QoS Monitoring Report IE to the SMF in PFCP Session Report Request; several QoS Monitoring Report IEs may be present to report the packet delay(s) for multiple QoS flows. The UPF shall include the delay value (Downlink, Uplink and/or Round trip) in the QoS Monitoring Measurement IE in the QoS Monitoring Report IE. See clause 5.33.5 for reporting the QoS monitoring events directly to the Local NEF or AF. + +The UPF shall continue to apply all the provisioned SRR(s) and perform the related QoS monitoring measurement(s), until getting any further instruction from the CP function. + +When receiving a new threshold (Packet Delay Thresholds, Minimum Wait Time and/or Measurement Period) from the SMF for a measurement that is already ongoing in the UPF, the UPF shall consider its ongoing measurements against the new threshold to determine when to send its next QoS monitoring report to the SMF or to the Local NEF or AF (if direct reporting of QoS monitoring event applies, see clause 5.33.5). + +When receiving instruction from the SMF to stop the on-going QoS monitoring, the UPF shall generate a QoS monitoring report to the SMF or to the Local NEF or AF (if direct reporting of QoS monitoring event applies, see clause 5.33.5), to report the detected packet delay(s). + +If Periodic QoS monitoring reporting or Event Triggered QoS monitoring reporting is required in the reporting frequency and no time stamp is received in uplink packet for a delay exceeding the Measurement Period (i.e. no measurement result is available in the UPF within the reporting period), the UPF shall generate a QoS monitoring report indicating a packet delay measurement failure to the SMF or to the Local NEF or AF (if direct reporting of QoS monitoring event applies, see clause 5.33.5). + +## 5.24.5 Per GTP-U Path QoS Monitoring + +### 5.24.5.1 General + +Stage 2 requirements for support of per GTP-U path QoS monitoring are specified in clause 5.33.3.3 of 3GPP TS 23.501 [28]. + +The UPF shall set the GPQM feature flag in the UP Function Features IE if it supports per GTP-U Path QoS monitoring (see clause 8.2.25). + +### 5.24.5.2 GTP-U path monitoring + +If the UPF is known to support this feature (e.g. by the UP Function Features IE), the SMF may request the UPF to measure the packet delay for transport paths towards remote GTP-U peers during a PFCP association setup or a PFCP association update procedure, by provisioning GTP-U Path QoS Control Information including: + +- the identification of the GTP-U paths to be monitored, i.e.: + - the IP destination address of one or more remote GTP-U peers, and if available, the network instance used to reach each remote GTP-U peer and the DSCP value(s) to measure the packet delay; or + - the interface type(s) (i.e. N9 and/or N3) of the GTP-U paths; +- the values of the DSCP in the TOS/Traffic Class field to measure the packet delay, if available; +- the conditions and QoS parameters for the UPF to report measurements to the SMF, i.e. one or more of: + - immediate report; + - periodic report, with the reporting time period; and/or + - event triggered report, when the average, minimum and/or maximum packet delay on a GTP-U path exceeds corresponding thresholds. + +If so instructed, the UPF shall perform an estimation of the RTT for the GTP-U paths requested to be monitored, by sending Echo Request messages (with each requested DSCP value, if any) and measuring the time that elapses between the transmission of the Echo Request message and the reception of the Echo Response message. The UPF shall compute + +the packet delay by adding RTT/2 and the UPF internal processing time, thus the measured delay represents an estimated elapsed time for the GTP-U path (since a user plane packet entered the UPF and its reception by the next downstreams or upstreams GTP-U peer). The UPF shall send QoS reports to the SMF by including GTP-U Path QoS Report IE(s) in a PFCP Node Report Request message. + +If the GTP-U paths to be monitored are identified by their interface types (e.g. N9 and/or N3), the UPF shall monitor all GTP-U paths of all PFCP sessions established with a FAR including a matching Destination Interface Type. + +For event triggered reporting, the UPF shall send a first report when a reporting threshold is exceeded and a minimum waiting time shall be applied for the subsequent report for the same type of measurement (e.g. maximum packet delay) and the same remote GTP-U peer (if the threshold is exceeded after the waiting time). + +#### 5.24.5.3 QoS monitoring of a PDU session based on GTP-U path monitoring + +The SMF may request the UPF (PSA) to monitor the Uplink, Downlink or Round-Trip delay per QoS flow per UE, as specified in clause 5.24.4.2 with the following addition: + +- In the QoS Monitoring per QoS flow Control Information IE, the SMF shall indicate that QoS monitoring is performed based on GTP-U path monitoring by setting the GTPUM flag to 1 in the Requested QoS Monitoring IE. + +Additionally, for the UPF (PSA) and for any intermediate UPF in the path of the PDU session, the SMF (or I-SMF) shall request the UPF: + +- to measure the one-way delay of the GTP-U path with the preceding uplink GTP-U entity; this corresponds to the N3 path for a UPF connected to the RAN, and to a N9 path for a UPF connected to an intermediate UPF; +- to add this delay to the "N3/N9 Delay Result" field received in the GTP-U PDU Session Container extension header (see 3GPP TS 38.415 [34]) of the uplink packet; and +- for an intermediate UPF, to send the resulting value in the "N3/N9 Delay Result" field in the GTP-U PDU Session Container extension header (see 3GPP TS 38.415 [34]) of the uplink packet it forwards (towards the PSA). + +The SMF shall request the above to the UPF (PSA or I-UPF) by including the Transport Delay Reporting IE in the UL PDR(s) associated to the corresponding QoS flow to be monitored. Multiple QoS flows may be monitored for a given PDU session as specified in clause 5.24.5.4. + +When so requested, each UPF shall, for UL GTP-U packets with the PDU Session Container extension header including the RAN Uplink and/or Downlink fields, add the delay of the GTP-U path with the preceding uplink GTP-U entity. + +NOTE: The "N3/N9 Delay Result" field is computed by the intermediate UPF(s) and UPF (PSA). The RAN does not report the N3 path delay. The intermediate UPF connected to the RAN adds the N3 delay; the next intermediate UPF (if any) adds the N9 delay with the first intermediate UPF and the PSA adds the N9 delay of the last GTP-U path towards the PSA. If the PSA is directly connected to the RAN, the PSA measures the N3 delay. + +#### 5.24.5.4 QoS Monitoring Reporting + +QoS monitoring reporting by the PSA shall be performed as specified in clause 5.24.4.3, with the following modifications. + +The UP function shall not insert time stamps into the GTP-U PDU Session Container extension header (see 3GPP TS 38.415 [34]) of downlink packets. + +When receiving the uplink packet related to the requested QoS flow(s), the PSA shall measure the Uplink or Downlink delay by computing the sum of the end to end accumulated transport delay (computed as defined in clause 5.24.5.3) and the RAN UL or DL delay included in the GTP-U PDU Session Container extension header (see 3GPP TS 38.415 [34]) of the uplink packet. + +## 5.25 Support of IPTV (for 5GC) + +IPTV service is defined in clause 4.9.1 of 3GPP TS 23.316 [71]. Stage 2 procedures to support IPTV service are defined in clauses 4.6 and 7.7.1 of 3GPP TS 23.316 [71]. + +Support of IPTV service is optional for the SMF and UPF. The following requirements shall apply for IPTV service if the UPF supports the IPTV feature (see clause 8.2.25). + +This requires the UPF (PSA) to support: + +- terminating and managing IGMP or MLD messages received from the UE; +- acting as a Multicast Router as defined in in IETF RFC 2236 [52] and IETF RFC 3376 [53]; +- replicating IP multicast traffic received from the N6 interface over PDU sessions having joined the corresponding IP multicast group; +- notifying the SMF when a PDU session has joined or left a multicast group, if so requested by the SMF. + +NOTE: In this specification, "IGMP" refers to IGMPv2 and IGMPv3 and "MLD" refers to MLDv1 and MLDv2, unless specified otherwise. + +For a PDU session used for IPTV service, the SMF shall provision the following rules in the UPF to control the UL IGMP/MLD traffic and the DL IP multicast traffic as follows: + +- for the control of UL IGMP or MLD traffic: + - a PDR that shall identify IGMPv2 (see IETF RFC 2236 [52]), IGMPv3 (see IETF RFC 4604 [54]), MLD (see IETF RFC 2710 [55]) and/or MLD2 (see IETF RFC 4604 [54]) signalling, i.e.: + - with a PDI containing an SDF filter with a Flow Description identifying packets with IP Protocol number of 2, or with a pre-defined PDR matching the same, for IGMP traffic; + - with a pre-defined PDR matching traffic with IPv6 Next Header type value 58 and ICMP Field Type value 131 or 143, for MLD traffic. + - this PDR may also contain IP Multicast Addressing Info IE(s) identifying (ranges of) IP multicast group(s); if no IP Multicast Addressing Info IE is included, the PDR is meant to match any IP multicast group. + - an associated FAR containing the Apply Action IE with the IPMA (IP Multicast Accept) or the IPMD (IP Multicast Deny) flag set in order to request the UPF to accept or deny the UE requests to join the corresponding IP multicast group(s); +- for the control of DL IP multicast traffic + - a PDR including IP Multicast Addressing Info IE(s), identifying (ranges of) IP multicast addresses (DL IP multicast flows) or indicating any IP multicast address by the A (Any) flag set to "1"; + - an associated FAR containing the Apply Action IE set to forward or buffer the packets, and in the former case with the Outer Header Creation IE set to add the remote N3 or N9 GTP-U tunnel IP address and TEID related with the PDU session; + - optionally an associated QER indicating the QoS to use for the PDU session for the IP Multicast traffic that has been replicated. + +The UPF shall add or remove the PDU session to/from the DL replication tree associated with an IP Multicast flow, when the UE request to join the IP Multicast flow is accepted or when the UE requests to leave the IP Multicast flow. When receiving downlink IP multicast traffic, the UPF shall replicate the traffic towards each PDU session that has joined the corresponding IP multicast group and that is provisioned with a DL PDR enabling the forwarding of the corresponding IP multicast traffic. + +Additionally, the SMF may provision a URR, associated with the UL PDR controlling the IGMP or MLD traffic, with a Reporting trigger set to "IP multicast join/leave" to request the UPF to report to the SMF when it adds or remove the PDU session to/from the DL replication tree associated with an IP Multicast flow. Corresponding reports shall contain the Multicast IP address of the DL multicast flow and, if available, the Source specific IP address(es) of the DL IP multicast flow. + +## 5.26 Support of Time Sensitive Communication, Time Synchronization, 5GS integration with TSN and Deterministic Networking (for 5GC) + +### 5.26.1 General + +The 5G System may support enabling Time Sensitive Communication, Time Synchronization and Deterministic Networking including the following aspect as specified in clause 4.4.8 of 3GPP TS 23.501 [28]: + +- a) Integration of 5GS into a TSN data network (DN), i.e., as a bridge in an IEEE 802.1 Time Sensitive Networking (TSN), as illustrated in Figure 4.4.8.2-1 of 3GPP TS 23.501 [28] and further specified in clause 5.28 of 3GPP TS 23.501 [28]; +- b) Enablers for AF requested support of Time Synchronization and/or some aspects of Time Sensitive Communication (TSCTS) as illustrated in Figure 4.4.8.3-1 of 3GPP TS 23.501 [28] and further specified in clauses 4.4.8, 5.27 and 5.28 of 3GPP TS 23.501 [28]; +- c) Integration as a router in a Deterministic Network as illustrated in Figure 4.4.8.4-1 of 3GPP TS 23.501 [28], and further specified in clauses 4.4.8, 5.27 and 5.28 of 3GPP TS 23.501 [28]. + +NOTE: How the above features are supported for PDU Sessions involving an I-SMF is not specified in this release of specification. See 3GPP TS 23.501 [28] clause 5.34 and 3GPP TS 23.502 [29] clause 4.24. + +The related procedures between SMF and UPF defined in clauses 5.26.2, 5.26.3 and 5.26.4 to support bullet a) as described above are optional for the SMF and UPF and may apply if the UPF indicated support of the TSN feature (see clause 8.2.25). + +The related procedures between SMF and UPF defined in clauses 5.26.2, 5.26.3 and 5.26.4 to support bullet b) as described above are optional for the SMF and UPF and may apply if the UPF indicated support of the TSCTS feature (see clause 8.2.25). + +The related procedures between SMF and UPF defined in clauses 5.26.2, 5.26.3 to support bullet c) as described above are optional for the SMF and UPF and may apply if the UPF indicated support of the DETNET feature (see clause 8.2.25). + +For UE-UE TSC communications, the SMF may configure the UPF to apply local switching with existing technologies as specified in clauses 5.13 for Ethernet traffic or 5.23 for 5G VN Group Communication, such as to enable the UPF to locally forward uplink stream from one PDU session as downlink stream in another PDU session. + +### 5.26.2 5GS User Plane Node management + +5GS Bridge information reporting is defined in Annex F.1 of 3GPP TS 23.502 [29]. This procedure enables the SMF to report 5GS Bridge/User Plane Node information of a PDU session established for Time Sensitive Communication (TSC) to the TSN AF or TSCTSF via the PCF. + +5GS DetNet node information reporting is specified in Annex F.5 of 3GPP TS 23.502 [29] and clause 5.28.5.2 of 3GPP TS 23.501 [28]. This procedure enables the SMF to report 5GS User Plane Node information of a PDU session established for Deterministic Networking (DetNet) to the TSCTSF via the PCF. + +Identities of 5GS User Plane Node and UPF/NW-TT ports may be pre-configured in the UPF based on deployment. When establishing the PFCP session for the PDU session for TSC, the SMF shall provide the Network Instance IE and it may provide the APN/DNN IE and S-NSSAI IE to the UPF to enable the UPF to respond with the proper 5GS User Plane Node ID based on configuration information associated with the network instance or DNN and S-NSSAI pair. The 5GS User Plane Node IE shall contain the Bridge ID in case of IEEE TSN and may contain the Router ID in case of IETF DetNet. + +In order to establish a PDU Session for TSC, the SMF shall send a PFCP Session Establishment Request to the UPF to establish the corresponding PFCP session as specified in this specification. Additionally, the SMF shall request the UPF to allocate the port number for the PDU Session and provide the related 5GS User Plane Node ID by including the Create Bridge/Router Info IE with the Bridge Information Indication (BII) bit set to "1" (for TSN and TSCTS as described in clause 5.26.1) or with the Router Information Indication (RII) bit set to "1" (for DetNet), in the PFCP + +Session Establishment Request. If so requested, the UPF shall provide corresponding information to the SMF in the Created Bridge/Router Info IE in the PFCP Session Establishment Response message. + +NOTE 1: The port number for the PDU Session corresponds to the device side port of the 5GS bridge/router. When the device supports the DS-TT functionality, the port number represents the DS-TT port number of the PDU Session. + +NOTE 2: The port number for the PDU session and 5GS User Plane Node ID are not meant to be used in PDRs. + +NOTE 3: The port number is encoded differently between TSN/TSCTS and DetNet (see clauses 8.2.141 and 8.2.142). + +## 5.26.3 Transfer of 5GS user plane node and port management information + +### 5.26.3.1 General + +5GS User Plane Node and Port management information exchange is defined in clause 5.28.3 of 3GPP TS 23.501 [28] and in Annex F of 3GPP TS 23.502 [29]; this procedure enables the SMF to relay transparently user plane node and/or port related information between the TSN AF or TSCTSF and the NW-TT (and DS-TT). + +Port management information shall be transferred between the SMF and UPF in a Port Management Information Container (PMIC). If the NW-TT supports several ports, and port management information needs to be sent for several ports, a separate PMIC shall be used for each port. + +User Plane Node management information shall be transferred between the SMF and UPF in a User Plane Node Management Information Container (UMIC). + +The SMF and UPF may send a PMIC or a UMIC using PFCP session related procedures of any PFCP session associated with this NW-TT. The SMF may forward NW-TT related UMIC and/or PMIC(s) and/or related port number(s) to the UPF by sending a PFCP Session Modification Request to the UPF including the TSC Management Information IE. The UPF may send NW-TT related UMIC and/or PMIC(s) and/or related port number(s) to the SMF by sending a PFCP Session Modification Response or a PFCP Session Report Request including the TSC Management Information IE, if direct reporting of TSC management information event to TSN AF or TSCTSF as specified in clause 5.26.3.2 does not apply. + +The details of the User Plane Node and Port Management Container communication between NW-TT and TSN AF or TSCTSF is defined in the 3GPP TS 24.539 [63]. + +### 5.26.3.2 Direct Reporting of TSC management information event to TSN AF or TSCTSF + +A UPF may be instructed to report TSC management information events directly to a TSN AF or TSCTSF as specified in clause 5.28.3.1 of 3GPP TS 23.501 [28]. + +A UPF that supports this feature shall set the DRTSC (Direct Reporting of TSC management information events) flag in the UP Function Feature IE (see clause 8.2.25). + +An SMF shall instruct an UPF that supports the DRTSC feature to report user plane node and port management information in TSC management information events directly to a TSN AF or TSCTSF by including a Direct Reporting Information IE in the TSC Management Information IE in a PFCP Session Modification Request. + +NOTE: The TSN AF or TSCTSF can indicate inside the Port Management Information Container or user plane node Management Information Container that is sent to the UPF that it wants to retrieve port or user plane node management information or to subscribe for notifications as specified in clauses 6.2.1 and 6.3.1 of 3GPP TS 24.539 [63]. + +The Direct Reporting Information shall include the Event Notification URI towards which the events shall be sent, and if available, the Notification Correlation ID to be included in these events. + +An UPF that supports this feature shall send user plane node and port management information in TSC management information events directly to the TSN AF or TSCTSF, if the Direct Reporting Information IE was received in the TSC Management Information IE in a PFCP Session Modification Request. If so, the UPF shall send these events using the UPF Event Exposure service specified in 3GPP TS 29.564 [73] and using the notification URI received in the Direct + +Reporting Information IE, and the UPF shall not send any further user plane node and port management information in PFCP Session Report Request and PFCP Session Modification Response towards the SMF. + +If no Direct Reporting Information IE has been received in the TSC Management Information IE in any PFCP Session Modification Request, the UPF shall send user plane node and port management information to the SMF using PFCP as specified in clause 5.26.3.1. + +## 5.26.4 Reporting clock drift between External and 5GS times from UPF to SMF + +The SMF may request the UPF to measure and report the clock drift between the external time and 5GS time for one or more external time domains (see clause 5.27.2.4 of 3GPP TS 23.501 [28]), by provisioning one or more Clock Drift Control Information IE(s) in a PFCP Association Setup Request or a PFCP Association Update Request, with the following information: + +- Time Domain Number IE(s), identifying the working time domain(s), e.g. PTP (Precision Time Protocol) "domainNumber", for which clock drift needs to be measured and reported. This may be present if the Configured Time Domain IE is omitted. The SMF may omit the Time Domain Number IE in the request; if neither the Time Domain Number IE nor the Configured Time Domain IE is included, the UPF shall report the clock drift for all Time domains the UPF is connected to; +- Configured Time Domain IE with the CTDI (Configured Time Domain Indicator) flag set to "1", to indicate that clock drift needs to be measured and reported for the Time Domain Number configured in the NW-TT(s). This may be present if the Time Domain Number IE is omitted. +- the requested Clock Drift Information, indicating a request to report when the Time Offset Reporting Threshold is exceeded and/or when the cumulative RateRatio Reporting Thresholds is exceeded; +- the Time offset reporting threshold (i.e. the maximum time offset between the external time and 5G system time), if Time Offset Reporting is requested; +- the Cumulative rateRatio measurement threshold (i.e. related to cumulative rateRatio calculated at NW-TT(s)), if Cumulative RateRatio Reporting is requested. + +If so requested, when detecting either of the clock drift offset triggers exceeding the defined threshold, the UPF shall send a PFCP Node Report Request to the SMF, including one or more Clock Drift Reports, with the corresponding Time Domain Number(s), measurement information and Network Instance (if available) and the combination of DNN and S-NSSAI (if available). + +## 5.26A Support of TSN enabled Transport Network + +### 5.26A.1 General + +The 5GS may support interworking with IEEE 802.1 TSN deployed in the transport network as specified in clause 5.28a of 3GPP TS 23.501 [28] and Annex F of 3GPP TS 23.502 [29]. + +A UPF that supports the TSN Talker and Listener (TL) functionality (i.e. that implements the CN-TL) shall set the CN-TL flag in the UP Function Features IE (see clause 8.2.25). + +If the UPF supports the CN-TL feature, the SMF/CUC may communicate with the CN-TL via a TL-Container to retrieve the capabilities of the CN-TL or to configure TSN features in the CN-TL as defined in 3GPP TS 29.585 [80] and in clause 5.28a and Annex M of 3GPP TS 23.501 [28]. + +To communicate with the CN-TL, the SMF/CUC shall include: + +- one TL-Container IE (encapsulating a Get Request, see 3GPP TS 29.585 [80]) in the PFCP Session Establishment Request (for the related PDU session) sent to the UPF/CN-TL; or +- one or more TL-Container IE(s) (each encapsulating a Set Request for a TN stream, see 3GPP TS 29.585 [80]) in the PFCP Session Modification Request or PFCP Session Deletion Request message (for the related PDU session) sent to the UPF/CN-TL. + +The UPF/CN-TL shall then include: + +- one TL-Container (encapsulating a Get Response, see 3GPP TS 29.585 [80]) in the PFCP Session Establishment Response; or +- one or more TL-Container IE(s) (each encapsulating a Set Response for a TN stream, see 3GPP TS 29.585 [80]) in the PFCP Session Modification Response or PFCP Session Deletion Response message respectively. + +## 5.27 Inter-PLMN User Plane Security + +Stage 2 requirements for support of the Inter-PLMN User Plane Security (IPUPS) functionality are defined in clauses 4.2.4, 5.8.2.14, 6.2.3, and 6.3.3.3 of 3GPP TS 23.501 [28], and in clauses 4.2.2 and 5.9.3.4 of 3GPP TS 33.501 [64]. + +The IPUPS functionality shall be activated for the user plane traffic received over N9 interface across PLMNs, according to operator's policy. The SMF shall provision UL/DL PDR(s) to identify the user plane traffic received at the local F-TEID in the UPF and provision UL/DL FAR(s) to forward the user plane traffic to the remote F-TEID in the GTP-U peer. User plane packets not matching any PDR shall be dropped, using mechanisms defined in this specification, see e.g. clause 5.2.1. + +During a PFCP Association Setup procedure, an UPF, which is configured to be used for IPUPS shall indicate this with the UPF configured for IPUPS (UUPSI) flag, as specified in clause 7.4.4.2. + +**NOTE:** Any UPF can support the IPUPS functionality. In network deployments where specific UPFs are used to provide IPUPS, UPFs configured for providing IPUPS services (i.e. reporting the UUPSI flag) are selected to provide IPUPS function. + +## 5.28 Downlink data delivery status with UPF buffering (for 5GC) + +### 5.28.1 General + +Stage 2 requirements for the support of Downlink data delivery status notification with UPF buffering are specified in clause 5.8.3.2 of 3GPP TS 23.501 [28] and clauses 4.15.3.2.8 and 4.15.3.2.9 of 3GPP TS 23.502 [29]. + +If the UP function supports the Downlink data delivery status notification with UPF buffering, the UP function shall set the DDDS feature flag in the UP Function Features IE (see clause 8.2.25). If so, the CP function may request the UP function to notify the first buffered DL packet and / or the first discarded DL packet for the traffic matching the downlink PDR by set the BUFF flag, BDPN flag and DDPN flag in the Apply Action IE of the FAR. The CP function may also provide the DL Buffering Duration IE and DL Buffering Suggested Packet Count IE in the related BAR to the UP function. + +The UP function shall report the first buffered DL packet for each service data flow identified by a PDR, by sending a PFCP Session Report Request including a Downlink Data Report IE identifying the PDR(s) for which downlink packets have been received. The UP function shall also report the first discarded DL packet for each service data flow identified by a PDR if the DL Buffering Duration or DL Buffering Suggested Packet Count is exceeded. DL Data Status IE shall be included in the Downlink Data Report IE to indicate the report is triggered by the Downlink data delivery status with UPF buffering when the first DL packet is buffered or discarded. + +**NOTE** The CP function can request the UP function to report the first buffered DL packet by setting the BDPN flag and / or the NOCP flag in the Apply Action IE of the FAR. If the BDPN flag is set, the UP function reports the first buffered DL packet for each service data flow identified by a PDR associated to the FAR. If the NOCP flag is set, the UP function reports the first buffered DL packet of any PDR associated to the FAR, i.e. if there are subsequent DL packets (pertaining to different service data flow identified by other PDRs associated to the FAR), there is no new report sent to the CP function. + +If the UP function supports the Downlink data delivery status notification with UPF buffering, the CP function may also request the UP function to drop the DL packets directly and send a notification for the traffic matching the downlink PDR by set the DROP flag and DDPN flag in the Apply Action IE of the FAR. + +The UP function shall report the dropped DL packets for each service data flow identified by a PDR, by sending a PFCP Session Report Request including a Downlink Data Report IE identifying the PDR(s) for which downlink packets have been received. + +## 5.29 Support Reliable Data Service + +Clause 5.31.6 of 3GPP TS 23.501 [28], clause 4.3.2 of 3GPP TS 23.502 [29] and clause 4.5.14.3 of 3GPP TS 23.682 [66], specify that The Reliable Data Service (RDS) may be used between the UE and UP function when using a PDU Session of PDU Type 'Unstructured' in 5GS or using PDN Connection of PDN Type 'Non-IP' in EPS. The service is enabled or disabled based on DNN and NSSAI Configuration per SLA in 5GS or APN Configuration per SLA in EPS. + +If the UE indicates its capability of supporting RDS in the Protocol Configuration Options (PCO) and if the UP function indicated support of the RDS feature, the CP function may request the UP function to apply the RDS functionality for the PDU session by sending "Provide RDS Configuration Information" IE within PFCP Session Establishment Request message (see clause 7.5.2.11). + +If the UP function supports and accepts RDS, it should respond to CP function by setting RDS flag in "RDS Configuration Information" IE within PFCP Session Establishment Response message (see clause 7.5.3.8), and the UP function should place unstructured DL data from N6/SGi in the payload of RDS protocol and then insert it as GTP-U payload, and vice versa for UL data. + +Then the CP function should indicate to the UE, in the PCO, that the RDS shall be used if enabled in the DNN and NSSAI configuration in 5GS or APN configuration in EPS. The Reliable Data Service is enabled afterwards. + +Reliable Data Service protocol is defined in 3GPP TS 24.250 [65]. + +## 5.30 Notifying Start Pause of Charging + +The requirements for PGW Pause of Charging in EPC are specified in clause 5.3.6A of 3GPP TS 23.401 [14] and the requirements for SMF Pause of Charging feature for 5GC are specified in clause 4.4.4 of 3GPP TS 23.502 [29]. + +To reduce the charging discrepancy between SGW-C and PGW-C, or between I/V-SMF and (H-)SMF due to the signalling latency to notify start pause of charging, the CP function (SGW-C and PGW-C for EPC, I/V-SMF and (H-)SMF for 5GC) and UP function (SGW-U and PGW-U for EPC, I/V-UPF and PSA UPF) may support the Notify Start Pause of Charging via user plane feature (NSPOC) as described below. + +When both the CP function and the UP function support the NSPOC feature, and the peer CP function (PGW-C or (H-)SMF) and peer UP function (PGW-U or PSA UPF) are known to support the NSPOC feature as specified in 3GPP TS 29.274 [9] and 3GPP TS 29.502 [50], the CP function (SGW-C, or I/V-SMF) may set the NSPOC bit to "1" in the Measurement Information included in the URR when the Dropped DL Traffic Threshold is provisioned, to request the UP function (SGW-C, I/V-UPF) to send a Start Pause of Charging indication via one or more GTP-U Tunnel Status message to the upstream GTP-U entity(s) when the Dropped DL Traffic Threshold is reached. + +When both the CP function and the UP function support the NSPOC feature, the CP function (PGW-C, or (H-)SMF) may set the ASPOC bit to "1" in the Measurement Information included in the URR if the URR is intended for charging, to request the UP function to stop the usage measurement for the URR when receiving Start Pause of Charging indication from the peer downstream GTP-U entity, so that the UP function shall behave as if the Inactive Measurement flag had been set for the URR when it receives a Tunnel Status message with the Start Pause of Charging indication is set to "1" from the downstream peer GTP-U entity. + +Regardless of whether the NSPOC feature is supported and used, the procedures specified in clause 5.3.6A of 3GPP TS 23.401 [14] and clause 4.4.4 of 3GPP TS 23.502 [29] for starting and stopping Pause of Charging for EPC and 5GC respectively shall be performed, i.e. the UP function (SGW-U or I/V-UPF) shall still be instructed to generate a usage report when the Dropped DL Traffic Threshold is reached, the SGW-C or I/V-SMF shall request the PGW-C or (H-)SMF to start or stop charging, and the PGW-C or (H-)SMF shall instruct the UP function (PGW-U or PSA UPF) to inactivate or activate measurement for URR(s) applicable for charging. + +When the NSPOC feature is supported and used, the CP function (PGW-C or (H-)SMF) may: + +- set the "SUMPC" flag in PFCPSMReq-Flags IE to "1" to request the UP function to stop the usage measurement for all URRs with the "ASPOC" flag set to "1", e.g. when the CP function is informed to start Pause of Charging via control plane; +- set the "RUMUC" flag in PFCPSMReq-Flags IE to "1" to request the UP function to resume the usage measurement for all URRs with the "ASPOC" flag set to "1", e.g. when the CP function is informed to stop Pause of Charging via control plane;- set the "CIAM" flag together with Inactive Measurement flag in the Measurement Information IE in the Create URR IE or Update URR IE to stop or resume the usage measurement for a specific URR with the "ASPOC" flag set to "1". + +The UP function shall stop or resume the usage measurement for all the URRs with the "ASPOC" flag set to "1" upon receipt of a PFCP Session Establishment Request or PFCP Session Modification Request with the "SUMPC" or "RUMUC" flag set respectively, regardless the current value of the Inactive Measurement flag for a given URR. + +The UP function shall start the usage measurement for a URR with the "ASPOC" flag set to "1" unless both the "CIAM" and "INAM" flags are set to "1" or unless the "SUMPC" flag is set to 1 in the same message, when the URR is provisioned in a Create URR IE. + +NOTE 1: Only the "SUMPC" flag can be set in the PFCP Session Establishment Request message, e.g. during a restoration procedure for a UPF failure. + +The UP function shall stop or resume the usage measurement for a specific URR with the "ASPOC" flag set to "1" upon receipt of a PFCP Session Modification Request including an Update URR IE with the Measurement Information IE, according to the value of the "INAM" flag, if the "CIAM" flag is set to 1. If the "CIAM" flag is set to 0, the UP function shall ignore the "INAM" flag received in the Measurement Information for a URR with the "ASPOC" flag set to "1". + +NOTE 2: Notifying Start Pause of Charging via GTP-U fastens the triggering of charging pause in the PGW-U or UPF (PSA). If the GTP-U Tunnel Status messages are lost, charging is paused when receiving the corresponding instruction from the PGW-C/SMF. + +NOTE 3: The UP function will forward Tunnel Status message to the upstream GTP-U entity(s) if it is not a PSA UPF or PGW-U connecting to N6 or SGi interface. If the UP function is a UL/CL or BP, it needs send or forward the Tunnel Status message to all of PSA UPFs. + +NOTE 4: The UP function resumes the usage measurement for all URRs with the "ASPOC" flag set to "1" regardless if the usage measurement was stopped by the CP function using the "SUMPC" flag or using the Inactive Measurement flag per URR, or upon being notified by the downstream GTP-U entity using Tunnel Status message. + +NOTE 5: When the CP function uses Inactive Measurement flag to stop the usage measurement for a given URR, it can set the "ASPOC flag" to "0" if the CP function doesn't want that the usage measurement is resumed when applying "RUMUC". + +## 5.31 Support of L2TP + +### 5.31.1 General + +Stage 2 requirements for the support of Layer 2 Tunneling Protocol (L2TP) are specified in clause 5.8.2.16 of 3GPP TS 23.501 [28], clause 4.3.2.4 of 3GPP TS 23.502 [29] and clause 5.5 of 3GPP TS 23.214 [2]. + +It is optional for both the CP function and the UP function to support the L2TP feature. + +L2TP is specified in IETF RFC 2661 [67]. An L2TP Tunnel is setup between a L2TP Access Concentrator (LAC) and a L2TP Network Server (LNS) pair controlling the connection, that may contain one or more L2TP Sessions. More than one L2TP tunnel can be established between a LAC-LNS pair. + +The UP function shall act as the LAC. + +The CP function may request the UPF to setup an L2TP Session for a PDN connection or PDU session between the LAC and the LNS in the Data Network. + +One L2TP tunnel between the UP Function and the L2TP server may be shared by multiple PDN connection / PDU session using the same N6/SGi network instance and L2TP parameters (e.g. LNS address). A single L2TP tunnel may be shared by multiple PDN connections / PDU sessions created by the same CP Function or by different CP Functions. + +## 5.31.2 L2TP Tunnel and L2TP Session Setup + +When both the CP function and the UP function support the L2TP feature (see clause 8.2.25), if an L2TP session is required to support the PDN connection/PDU session, the CP function shall send a PFCP Session Establishment Request message including the following L2TP related IEs, to request the UP Function to setup an L2TP session towards the LNS: + +- one L2TP Session Information IE to control the L2TP session setup. The L2TP Session Information may include: + - the Called Number, Calling Number and the MRU (Maximum Receive Unit in LCP/PPP, to be set as the value of the MTU received from the UE or that may be configured in the CP function); + - the L2TP Session Indications IE to indicate that the UP function shall request the LNS to allocate an IP address for the PDN session/PDN connection, to provide DNS server address(es) and/or NBNS server address(es) for the session; +- the L2TP User Authentication IE including parameters such as authentication type, Username and Password, Challenge and Challenge Response which may either be sent by the UE through PCO or be configured in the CP0. +- One or more L2TP Tunnel Information IEs to provide parameters to control the establishment of a L2TP tunnel if such information is available in the CP function, e.g. if it is received from an AAA/Radius server or locally configured in the CP function. This IE shall include LNS IPv4/IPv6 address, and it may include Tunnel Password for L2TP tunnel authentication, Tunnel Preference if multiple L2TP Tunnel Information IEs are sent, as specified in 3GPP TS 29.061 [39] and 3GPP TS 29.561 [49]. + +NOTE 1: Multiple L2TP Tunnel Information IEs can be sent to provide the UP Function with a list of possible L2TP tunnels that can be used to establish the L2TP session. This can be used to ensure that the session is established even if a specific LNS is temporarily unavailable, or to load balance the setup of L2TP sessions over different LNS's. A given L2TP Tunnel Information IE includes Tunnel attributes, e.g. Tunnel-Server-Endpoint and Tunnel-Password, received over N6/SGi with the same Tag value (see IETF RFC 2868 [68]). See also 3GPP TS 29.061 [39] and 3GPP TS 29.561 [49]. + +NOTE 2: If the UE IP address is to be allocated by the UP function (or the LNS), the CP function indicates this in the UE IP Address IE in the Create PDR or Create Traffic Endpoint IE, regardless of whether the UE IP address is to be assigned by the LNS or the UPF. + +NOTE 3: If the L2TP tunnel parameters are configured in the UP Function, the UP Function determines how to establish the L2TP tunnel based on its local configuration. + +NOTE 4: An L2TP session cannot be modified once established as specified in IETF RFC 2661 [67]. + +Upon receiving the PFCP Session Establishment Request from the CP function, the UP function shall determine whether to use an already established L2TP tunnel (if any appropriate one has already been established) or establish a new L2TP tunnel. The UP function may have already established L2TP tunnel(s), e.g. based on locally configured L2TP Tunnel Information. If an existing L2TP Tunnel is used, the UP function shall only setup a new L2TP session within the existing L2TP tunnel. Otherwise, the UP function shall perform both L2TP tunnel and L2TP session setup. + +The UP function shall send a PFCP Session Establishment Response to the CP function, carrying the Created L2TP Session IE containing information about the established L2TP session, e.g. the used LNS Address, that may be used for statistics or diagnostics. The Cause IE in the response message may carry additional L2TP specific failure information to the CP function if the L2TP tunnel or L2TP session establishment failed. + +The PFCP Session Establishment Response message may also include the DNS Server Address IE(s) and/or NBNS Server Address IE(s) containing the DNS server and/or NBNS Server information, if this information was requested. + +If the UE IP address was allocated by the UP Function (or the LNS), the UP function shall provide the allocated IP address to the CP function in the UE IP Address IEs in the Created PDR IE and/or Created Traffic Endpoint IE (as specified in this specification). + +Upon receiving uplink user plane traffic pertaining to the PFCP session with a L2TP session established, the UP function shall forward the traffic via the L2TP tunnel towards the LNS server. + +### 5.31.3 L2TP Session and L2TP Tunnel Release + +Upon receiving a PFCP Session Deletion Request message from the CP function, the UP function shall release the corresponding L2TP session. The UP function may release the L2TP tunnel if there is no other L2TP session using the L2TP tunnel. + +NOTE 1: The UPF can alternatively retain the L2TP tunnel when all L2TP sessions are terminated. + +When the LNS terminates a L2TP session or an L2TP tunnel, the following applies: + +- If the LNS terminates an L2TP session, the UP function shall terminate the PFCP session and report to the CP Function that the PFCP session is deleted by sending a PFCP Session Report Request message to the CP function as described in clause 5.18.2, with the Cause indicating the reason for the termination. +- If the LNS terminates an L2TP tunnel, the UP function shall terminate all the PFCP sessions using the L2TP tunnel and report to all the CP functions controlling at least one such PFCP session that the respective PFCP sessions have been deleted by sending a PFCP Session Report Request message to the CP function for each affected PFCP session, as described in clause 5.18.2, with the Cause indicating the reason for the termination. +- If the UP function detects that the connectivity with an LNS is lost, the UP function shall terminate the PFCP sessions using the L2TP tunnel(s) towards that LNS and report to the CP that all the PFCP sessions affected have been deleted by sending a PFCP Session Report Request message to the CP function for each affected PFCP session, as described in clause 5.18.2, with the Cause indicating the reason for the termination. + +## 5.32 Support of Uplink packets buffering + +### 5.32.1 General + +This clause specifies the support of uplink packets buffering. + +### 5.32.2 Uplink packets buffering for on-line charging + +If the UP function indicated support of the Quota Action (QUOAC) feature in the UP Function Features IE and the FAR ID for Quota Action was set to buffer the application traffic at zero quota, the UP function shall buffer the related uplink packets if it is provisioned with zero quota earlier or the quota has been exhausted, as specified in clause 5.2.2.2.1. In addition, if the UP Function has indicated support of the feature UL/DL Buffering Control (UDBC), the UP function shall buffer the number of packets (including both uplink or downlink) based on the Suggested Buffering Packet Count IE in a BAR provided by the SMF, until it receives new instructions from the CP function, e.g. when the new Quota is granted. + +### 5.32.3 Uplink packets buffering during EAS relocation + +If the UP function supports uplink packets buffering during EAS relocation, the UP function shall set the UPBER bit in the UP Function Features (see clause 8.2.25). + +The SMF shall request the UPF (PSA) to buffer the uplink packets related to one or more Service Data Flows sent to the new EAS by setting the BUFF flag in Apply Action IE of the related FAR. The SMF shall set the FORW flag in Apply Action IE when the EAS relocation has been performed. + +## 5.33 Support of enhancement of Edge Computing (for 5GC) + +### 5.33.1 General + +Stage 2 requirements for support of enhancement of Edge Computing are specified in 3GPP TS 23.548 [69]. + +### 5.33.2 Uplink packet buffering for low packet loss during EAS relocation + +Support of uplink packets buffering for low packet loss during EAS relocation as specified in clause 6.3.5 of 3GPP TS 23.548 [69] is defined in clause 5.32.3. + +### 5.33.3 Edge Relocation using EAS IP address and Port number Replacement + +To support Edge Relocation using EAS IP address and Port number replacement as specified in clause 6.3.3 of 3GPP TS 23.548 [69], the SMF shall instruct the UPF to replace: + +- for the UL traffic, the destination IP address and/or port number of the outgoing IP packet with the Target EAS IP address and/or port number, by provisioning an UL FAR with an IP Address and Port Number Replacement IE containing the Target EAS IP address and/or port number; and +- for the DL traffic, the source IP address and/or port number of the incoming packet with the Source EAS IP address and/or port number, by provisioning a DL FAR with an IP Address and Port Number Replacement IE containing the Source EAS IP address and/or port number. + +A UPF that supports replacing the source and destination IP address and Port Number of an (inner) IP packet shall set the IPREP flag in the UP Function Features IE (see clause 8.2.25) and shall replace the source or destination IP address and/or Port Number of an (inner) IP packet as instructed by the SMF. + +### 5.33.4 EAS Discovery procedure with Local DNS Server/Resolver + +Clause 6.2.3.2.3 of 3GPP TS 23.548 [69] specifies two options (C and D) for scenarios where the DNS message is to be handled by a Local DNS server/resolver. + +In Option C, the SMF shall provision UL PDR(s) on the UL CL (including e.g. the Local DNS server address) or the BP (e.g. with the source IP prefix set to the IP prefix address assigned by the Local PSA) and associated FAR(s) to route traffic destined to the L-DN including the DNS query messages to the L-PSA, as specified in clause 5.17.2. + +In Option D, if the SMF has been configured that DNS Queries for an FQDN (range) query can be locally routed on the UL CL, the SMF shall instruct: + +- the UL CL to locally route DNS queries for the FQDN (range) to the Local DNS server, by provisioning an UL PDR with one or more DNS Query Filters or with a pre-defined PDR matching the requested DNS traffic and by associating a FAR to the UL PDR to forward the traffic towards the Local PSA. A UPF supporting this option shall indicate that it supports steering DNS traffic based on the target domain of the DNS Query by setting the DNSTS flag in the UP Function Features IE (see clause 8.2.25); and +- the Local PSA to send the DNS traffic to the Local DNS server, by provisioning a UL PDR with one or more DNS Query Filters, as described above for the UL CL, and by associating a FAR to the UL PDR to forward the traffic to the Local DNS server via tunneling (with the FAR including the Outer Header Creation IE) or via IP address replacement (with the FAR including the IP Address and Port number Replacement IE containing the IP address and/or port of the Local DNS server). + +### 5.33.5 Direct Reporting of QoS monitoring events to Local NEF or AF + +A UPF may be instructed to report QoS monitoring events directly to a local NEF or AF as specified in clause 6.4 of 3GPP TS 23.548 [69]. + +A UPF that supports this feature shall set the DRQOS (Direct Reporting of QoS monitoring events) flag in the UP Function Feature IE (see clause 8.2.25). + +An SMF shall instruct an UPF that supports the DRQOS feature to report Per QoS Flow Per UE QoS Monitoring events directly to a local NEF or AF by applying the requirements specified in clauses 5.24.4 or 5.24.5.3, and by additionally including a Direct Reporting Information IE in the SRR as specified in clauses 5.2.8.2 and 5.39.2. + +The UPF shall report the QoS monitoring result of the QoS flows as specified in clauses 5.39.4, 5.24.4.3 and 5.24.5.4. + +## 5.34 Support of 5G Multicast and Broadcast Service + +### 5.34.1 General + +This clause specifies N4mb and N4 specific requirements to support 5G Multicast and Broadcast Service. + +Stage 2 requirements for the support of 5G Multicast and Broadcast Service is specified in clause 6.7 of 3GPP TS 23.247 [72] and clause 5.8.2.11 of 3GPP TS 23.501 [28]. + +### 5.34.2 N4mb requirements + +#### 5.34.2.1 General + +This clause specifies N4mb specific requirements to support 5G Multicast and Broadcast Service. For a location dependent MBS service (see clause 6.2.3 of 3GPP TS 23.247 [72]), the MB-SMF shall establish one PFCP session per MBS session and MBS Session Area, following the requirements specified in clause 5.34.2.2. + +NOTE: A Location dependent MBS service enables distribution of different content data to different MBS service areas. The same MBS Session ID is used but a different Area Session ID is used for each MBS service area. + +#### 5.34.2.1A PFCP protocol extensions for N4mb + +When multicast transport is used for delivering user plane MBS traffic, the MB-SMF may set one or more of the following N4mb specific flags: + +- JMBSSM (Join MBS Session SSM) flag in the MBS Session N4mb Control Information IE in the PFCP Session Establishment Request. If set, the MB-UPF shall join the multicast tree towards the Source Specific Multicast (SSM) address information (provided by AF/AS or MBSTF for the MBS Session) indicated in the IP Multicast Addressing Info IE in the downlink PDR. +- this instructs the MB-UPF to receive MBS data using multicast transport over N6mb interface. +- PLLSSM (Provide Low Layer Source Specific Multicast address) flag in the MBS Session N4mb Control Information IE in the PFCP Session Establishment Request. If set, the MB-UPF shall provide a LLSSM address and a GTP-U Common Tunnel EndPoint Identifier (C-TEID) to the MB-SMF. +- this instructs the MB-UPF to provide the MB-SMF with a Low Layer Source Specific Multicast (LLSSM) address (i.e. multicast destination address and related source unicast IP address) for the delivery of MBS data using multicast transport over N3mb and/or N19mb interfaces. + +NOTE 1: The PLLSSM flag is not set in the PFCP Session Establishment Request message during the restoration procedure for an MB-UPF restart (see clause 8.2.2 in 3GPP TS 23.527 [40]) since in this procedure, the MB-SMF provides the MB-UPF with the LLSSM that was used for the MBS session before the MB-UPF restart, i.e. no new LLSSM needs to be assigned by the MB-UPF for the MBS session. + +- FSSM (Forward packets to lower layer SSM) flag in the Apply-Action IE of the Create FAR IE in the PFCP Session Establishment Request or in the Update FAR IE in the PFCP Session Modification Request. If set, the MB-UPF shall forward the MBS session data using the LLSSM and the C-TEID, which the MB-UPF has earlier assigned to the MBS session. +- this instructs the MB-UPF to forward MBS data using multicast transport over N3mb and/or N19mb interfaces. + +NOTE 2: The FSSM flag can be included in the Create FAR IE in the PFCP Session Establishment Request during the creation of an MBS session (see clauses 7.1.1.2 and 7.1.1.3 of 3GPP TS 23.247 [72]) or during an MBS restoration procedure (see e.g. clauses 8.2.2 and 8.2.3 in 3GPP TS 23.527 [40]). The FSSM flag can also be included in the Update FAR IE in the PFCP Session Modification Request e.g. during the Activation of a Multicast MBS session procedure (see clause 5.34.2.4). + +When unicast transport is used for delivering user plane MBS traffic, the MB-SMF may set the following N4mb specific flag: + +- MBSU (Forward and replicate MBS data using Unicast transport) flag in the Apply Action IE of the Update FAR IE in the PFCP Session Modification Request or in the Create FAR IE in the PFCP Session Establishment Request. If set, the MB-UPF shall either forward, or replicate and forward the MBS Session data towards the one or more GTP-U DL tunnels terminating at the NG-RAN nodes and/or PSA UPFs. The MB-SMF provides the MB-UPF with one or more DL GTP-U F-TEIDs (i.e. IP address and tunnel endpoint identifier). + +- this instructs the MB-UPF to forward MBS data using unicast transport over N3mb and/or N19mb. + +NOTE 3: The MBSU flag can be included in the Update FAR IE in the PFCP Session Modification e.g. after creating the MBS session when one or more NG-RAN node(s) and/or PSA UPF(s) provides a downlink GTP-U F-TEID (see clause 5.34.2.2), or e.g. during the Activation of a Multicast MBS session procedure (see clause 5.34.2.4). The MBSU flag can be included in the Create FAR IE in the PFCP Session Establishment Request during an MBS restoration procedure (see e.g. clauses 8.2.2 and 8.2.3 in 3GPP TS 23.527 [40]). + +### 5.34.2.2 Instructing the MB-UPF to forward MBS data using multicast and/or unicast transport + +When the MB-SMF receives an MBS Session Create Request from a NEF/MBSF to configure an MBS session, the MB-SMF shall select an MB-UPF and request that MB-UPF to allocate relevant user plane resource for the MBS session, or for the MBS session and MBS Service Area for a location dependent MBS service; to do so, the MB-SMF shall send a PFCP Session Establishment Request message to the MB-UPF to setup a PFCP session for the MBS Session, or for the MBS session and MBS Service Area for a location dependent MBS service, including the following information in the PFCP Session Establishment Request message: + +- the MBS Session Identifier identifying the MBS session (i.e. TMGI or SSM address); +- the Area Session ID, for a location dependent MBS service; +- the JMBSSM (Join MBS Session SSM) indication, if MBS data delivery using multicast transport is used over the N6mb interface to request the MB-UPF to join the multicast tree (see clause 5.34.2.1A). towards the Source Specific Multicast (SSM) address information provided by AF/AS or MBSTF for the MBS Session +- the PLLSSM (Provide Low Layer Source Specific Multicast address) indication, if MBS data delivery using multicast transport is used over the N3mb and/or N19mb interface to request the MB-UPF to provide a LLSSM address and C-TEID (see clause 5.34.2.1A). During the restoration procedure for an MB-UPF restart however the MB-SMF shall not set the PLLSSM flag (see clause 8.2.2 in 3GPP TS 23.527 [40]); +- for each MBS QoS flow: + - a Create PDR IE to provision a downlink PDR with PDI or a Create Tunnel Endpoint IE containing either: + - a "Local Ingress Tunnel" IE with the CHOOSE bit set to "1" to request the MB-UPF to allocate an ingress tunnel for Nmb9, or for N6mb if unicast transport is used over N6mb (the MB-UPF shall assign a single ingress tunnel address, regardless of the number of MBS QoS flows); if the Create PDR IE contains SDF Filter(s), these SDF Filter(s) shall relate to the inner IP layer within the unicast tunnel. + - or + - an IP Multicast Addressing Info IE to request the MB-UPF to retrieve the MBS session data from the IP Multicast Address, when using multicast transport over N6mb. +- a Create QER IE to provision a QER (associated with the PDR including the above PDI or Traffic EndPoint ID) instructing the MB-UPF to insert the QFI of the MBS QoS flow in user plane packets and possibly requesting the MB-UPF to apply specific QoS treatments; the IQFISN (Insert DL MBS QFI Sequence Number) flag in the Create QER IE shall be set to "1" to request the MB-UPF to insert the DL MBS QFI Sequence Number in the PDU session container in user plane packets; +- a Create FAR IE to provision a FAR (associated with the PDR including the above PDI or Traffic EndPoint ID) with the Apply Action set to: + - "FSSM", if multicast transport is used over N3mb or N19mb, with an MBS Multicast Parameters IE; and/or + - "MBSU", if unicast transport is used over N3mb or N19mb and N3mb/N19mb DL F-TEIDs are already known, e.g. during an MBS restoration for MB-UPF failure with or without restart procedure, together with one or more Add MBS Unicast Parameters to instruct the MB-UPF to forward and replicate MBS Session data towards the one or more GTP-U DL tunnels terminating at the NG-RAN(s) and/or PSA UPF(s); + +Otherwise to: + +- "DROP", if only unicast transport is used over N3mb or N19mb and N3mb/N19mb DL F-TEIDs are not known yet. + +The MBS Session Identifier, Area Session ID (for a location dependent MBS service) and the MBSN4mbReq-Flags are included in the group IE "MBS Session N4mb Control Information" at the PFCP message level. + +The MB-UPF shall return the allocated ingress tunnel information in the Created PDR IE or Created Traffic Endpoint IE and provide the LLSSM address if requested. + +For an MBS session using unicast transport over N3mb or N19mb, when one or more NG-RAN node(s) and/or PSA UPF(s) provides a downlink GTP-U F-TEID (i.e. IP address and tunnel endpoint identifier) to receive the MBS session data, the MB-SMF shall send a PFCP Session Modification Request to change the FAR by setting the Apply Action to "MBSU", together with one or more Add MBS Unicast Parameters to instruct the MB-UPF to forward and replicate MBS Session data towards the one or more GTP-U DL tunnels terminating at the NG-RAN(s) and/or PSA UPF(s). + +NOTE: FAR with the Apply Action set to "MBSU" together with one or more Add MBS Unicast Parameters is sent within a PFCP Session Establishment Request message during the MBS restoration procedures specified in 3GPP TS 23.527 [40], see e.g. clauses 8.2.2 and 8.2.3. + +For an MBS session using multicast transport over N3mb or N19mb, if the "FSSM" flag is set in the Apply Action, the MB-UPF shall forward the MBS session data using the Low Layer Source Specific Multicast address (i.e. destination IP multicast address and related source IP address) and C-TEID it allocated to the MBS session. + +Both the "FSSM" and "MBSU" flags shall be set in the Apply Action IE if the MB-UPF is requested to forward MBS data using both multicast and unicast transport over N3mb and/or N19mb interfaces. + +### 5.34.2.3 Detecting and reporting user plane (in)activity of an MBS session + +As specified in clauses 7.2.5.2 and 7.2.5.3 of 3GPP TS 23.247 [72], the MB-SMF may instruct the MB-UPF to detect and report when user plane inactivity or activity is detected for an MBS session, in order to deactivate or activate the MBS session (see also clause 5.34.2.4). + +User plane inactivity detection and reporting for an MBS session shall be supported as specified in clause 5.11. + +User plane activity detection and reporting for an MBS session shall be supported as specified in clauses 5.2.3.1, i.e. by setting the NOCP flag in the Apply Action IE of the FAR and by the MB-UPF sending a PFCP Session Report Request including a Downlink Data Report IE identifying the PDR(s) for which downlink packets have been received. + +### 5.34.2.4 Activation and Deactivation of a Multicast MBS session + +Activation and Deactivation of a Multicast MBS session is specified in clauses 7.2.5.2 and 7.2.5.3 of 3GPP TS 23.247 [72]. At deactivation of a Multicast MBS Session, e.g. triggered by receiving an user plane inactivity report from the MB-UPF, or by receiving an MBS session deactivation request from the AF, the MB-SMF shall send a PFCP Session Modification Request message to request the MB-UPF: + +- to stop forwarding the MBS session data and: + - to report the receipt of subsequent DL MBS session data, by setting the Apply Action IE from "FSSM and/or MBSU" to "BUFF and NOCP" in the FAR of the PFCP session corresponding to the MBS session, if the activation of the MBS session is to be triggered upon receiving DL data report from the MB-UPF; or + - to change the Apply Action IE from "FSSM and/or MBSU" to "DROP" or "BUFF" in the FAR of the PFCP session corresponding to the MBS session, if the deactivation is requested by the AF; +- optionally, to delete all unicast DL N3mb F-TEIDs and all unicast DL N19mb F-TEIDs, i.e. to delete all the information earlier received in all the Add MBS Unicast Parameters IEs, by setting the "DETEID" flag to "1" in the PFCPSMReq-Flags, if the MB-SMF stores N3mb F-TEIDs and N19mb F-TEIDs and does not want to keep these F-TEIDs in the MB-UPF when the MBS session is deactivated. Otherwise, MB-UPF will keep all unicast DL N3mb F-TEIDs and all unicast DL N19mb F-TEIDs when the MBS session is deactivated. + +At the (re)activation of a Multicast MBS Session, e.g. triggered by receiving the DL data report from the MB-UPF, or by receiving an MBS session activation request from the AF, the MB-SMF shall send a PFCP Session Modification Request message: + +- requesting the MB-UPF to forward the MBS session data towards NG-RANs and/or UPFs, by setting the Apply Action IE from "BUFF" (with or without NOCP") or "DROP" to "FSSM and/or MBSU" in the FAR of the PFCP session; +- provisioning all unicast NG-RAN DL N3mb F-TEIDs and UPF N19mb F-TEID (which are stored and were possibly updated in the MB-SMF) in the Add MBS Unicast Parameters IEs to request the MB-UPF to forward one copy of the MBS session data to these DL tunnels when the unicast transport is used, if all the DL N3mb and N19mb F-TEIDs were deleted during the MBS session deactivation procedure; and +- optionally including a User Plane Inactivity Timer IE to provision or update the user plane inactivity timer to request the MB-UPF to report user plane inactivity, if the deactivation of the MBS session is to be triggered upon user plane inactivity report from the MB-UPF. + +## 5.34.3 N4 requirements + +### 5.34.3.1 General + +This clause specifies the N4 requirements for the support of multicast MBS services using 5GC Individual MBS traffic delivery. The MBS data may be delivered from the MB-UPF to the UPF using multicast or unicast transport. It is optional for both the SMF and the UPF to support the multicast MBS service. The following requirements shall apply if the SMF and UPF support the MBSN4 feature (see clause 8.2.25). + +NOTE 1: There is no impact on N4 to support broadcast MBS services in the 5GS. + +NOTE 2: For an MBS session (or an MBS session towards an MBS service area for location dependent MBS), there is only one MB-SMF (set) and one MB-UPF. + +For a given multicast MBS session, or for a given multicast MBS session and MBS Service Area for a location dependent MBS service, only a single copy of MBS Session data is delivered from the MB-UPF to the UPF. The UPF shall allocate only one N19mb downlink tunnel to receive the MBS session data for the MBS session, or for the MBS session and MBS Service Area for a location dependent MBS service, if unicast transport applies over N19mb or the UPF shall join the multicast group to receive MBS session data if multicast transport applies over N19mb. + +### 5.34.3.2 Instructing the UPF to forward (or stop forwarding) multicast MBS data to associated PDU sessions + +When a PDU session needs to be associated with an MBS session (e.g. when a UE requests to join a multicast MBS session, 5GC Individual MBS traffic delivery is used and the request is accepted by the SMF), the SMF shall associate the PDU session with the multicast MBS session by sending a PFCP Session Establishment or Modification Request message to the UPF, for the PFCP session corresponding to the PDU session, with the following information: + +- the MBS Session N4 Control Information IE including the MBS Session Identifier, the Area Session ID, for a location dependent MBS service and, if IP multicast transport applies over N19mb (i.e. a multicast transport address has been received from the MB-SMF): + - the Multicast Transport Information IE for the given MBS session containing the Low Layer Source Specific Multicast address, i.e. the Multicast address and the source IP address and the GTP-U Common TEID which have been allocated by the MB-UPF for the MBS session, when the SMF considers it is the first PDU session to be associated with the MBS session (or with the MBS session and Area Session ID for a location dependent MBS service) in this UPF; the SMF may provide this information even if there are already other PDU sessions associated with the MBS session (or with the MBS session and Area Session ID for a location dependent MBS service) in this UPF; +- one or more new DL PDR(s) including: + - the MBS Session Identifier, the Area Session ID (for a location dependent MBS service), or a Traffic Endpoint IE which is including the MBS Session Identifier, and the Area Session ID (for a location dependent MBS service); this information shall be used by the UPF to: + - determine whether the UPF already receives the MBS session data, or if instead it needs to allocate a new N19mb DL tunnel (when using IP unicast transport over N19mb) or send an IGMP JOIN request to join the multicast tree (when using IP multicast transport over N19mb) to receive the MBS session data; the UPF shall allocate the same N19mb DL Tunnel ID when the SMF requests the UPF to allocate a DL F-TEID for N19mb and multiple UE/PDU sessions are already associated with the MBS session (or with + +the MBS session and Area Session ID for a location dependent MBS service) in the UPF (e.g. PDU sessions controlled by other SMFs, or when multiple PDU sessions served by the same SMF need to be associated concurrently with the MBS session). + +- identify the list of PDU sessions (served by the UPF) towards which any DL packet received for this MBS session shall be distributed; +- if unicast transport is used over N19mb: + - a local F-TEID to be allocated at the UPF, with the CHOOSE flag set to "1" in the "Local F-TEID" IE in the PDI IE or Create Traffic Endpoint IE, if the SMF has no "N19mb DL F-TEID" information available for the MBS Session, e.g. for the first PDU Session in the SMF to be associated with the MBS session (or with the MBS session and Area Session ID for a location dependent MBS service); otherwise + - the Local F-TEID set to the "N19mb DL F-TEID" for the MBS Session (or for the MBS session and Area Session ID for a location dependent MBS service) which is known by the SMF. +- multiple DL PDRs may be provisioned and associated with different QERs to apply different QoS treatments for different multicast QoS flows within the MBS session. For each multicast QoS flow, the SMF may instruct the UPF to modify the QFI of downlink packets of the multicast QoS flow (received from the MB-UPF) to the QFI assigned by the SMF for the Associated (unicast) QoS flow, by associating a DL PDR including the QFI of the multicast QoS flow with a QER including the QFI IE set to the QFI of the Associated QoS flow. +- the new DL PDR(s) may be associated with an (existing) Forwarding Action Rule to forward the received MBS session data to the UE via existing downlink N3/N9 tunnel, or with a new Forwarding Action Rule with the Apply Action set to "Drop" if the SMF wishes to maintain the MBS data reception over N19mb but suspends the delivery of the data to the UE's PDU session, e.g. when the UE is switching between 5GC Individual MBS traffic delivery and 5GC Shared MBS traffic delivery due to the UE moving back and forth between MBS non-supporting NG-RAN and MBS supporting NG-RAN. + +The UPF shall respond with a PFCP Session Establishment or Modification Response message to the SMF, and the UPF shall include an MBS Session N4 Information IE if any of the following information needs to be reported: + +- the allocated "N19mb DL Tunnel ID" if it was requested; +- an NN19DT (New N19mb Downlink Tunnel) indication in the MBSN4Resp-Flags IE indicating if the N19mb DL F-TEID has been newly allocated by the UPF or if a N19mb DL F-TEID had already been allocated by the UPF for the MBS session (or for the MBS session and Area Session ID for a location dependent MBS service), when the "N19mb DL Tunnel ID" is present; this information allows the SMF to determine if it needs to report this N19mb DL Tunnel ID to the MB-SMF; +- an indication "JMTI"(Joined N19mb Multicast Tree Indication) in the MBSN4Resp-Flags IE indicating if the UPF has joined the multicast tree from MB-UPF, if the Multicast Transport Information was included in the request message. + +NOTE: The indications "JMTI" and "NN19DT" are defined to help the SMF to determine if it needs to communicate with the MB-SMF, e.g., to report the newly allocated N19mb DL TEID in order to let the MB-SMF inform the MB-UPF to send a copy of MBS Session data to the UPF. The indication "JMTI" indicates to the SMF that no N19mb DL TEID needs to be allocated. + +If unicast transport is used over N19mb and if the NN19DT (New N19mb Downlink Tunnel) indication is not set in the MBSN4Resp-Flags IE within the PFCP Session Establishment or Modification Response (i.e. if the MBSN4Resp-Flags IE is present and the NN19DT indication is not set, or if the MBSN4Resp-Flags IE is absent), the SMF shall assume that the UPF had already allocated the N19mb DL TEID earlier than the PFCP Session Establishment or Modification Request. + +When a PDU Session should be no longer be associated with the MBS session, or with the MBS session and Area Session ID for a location dependent MBS service, (e.g. the PDU session leaves the MBS session, or when switching to 5GC Shared MBS traffic delivery), or when the MBS session to which the PDU session is associated is being deactivated, the SMF shall send a PFCP Session Modification Request message to remove the DL PDR(s) that were created to receive the MBS session data, unless the SMF decides to keep the UPF receiving MBS Session data from N19mb, in which case the PDR shall be associated with a FAR set to drop packets. In the former case, when all the DL PDR(s) that were created to receive the MBS session data have been removed, the UPF shall consider that the PFCP session (PDU session) is no longer associated with the MBS session (i.e. the UPF shall delete, from its PFCP session context, the MBS Session N4 Control Information corresponding to the MBS session). + +In the PFCP Session Modification Response message, the UPF shall include the indication "N19DTR" (N19mb Downlink Tunnel Removal) in the MBSN4Resp-Flags IE indicating the N19mb DL Tunnel is to be removed if the UPF + +was requested to remove the DL PDRs of the MBS session for the PFCP session and this was the last PFCP session associated with the N19mb DL Tunnel in the UPF. This tells the SMF that it shall request the MB-SMF to inform the MB-UPF to stop sending MBS Session data towards this N19mb DL Tunnel. + +The UPF shall also set the indication "N19DTR" (N19mb Downlink Tunnel Removal) in the MBSN4Resp-Flags IE indicating the N19mb DL Tunnel is to be removed in the PFCP Session Deletion Response message when the SMF deleted the last PFCP session who was associated with the N19mb DL Tunnel in the UPF. + +When the MBS session to which the PDU session is associated is being re-activated, the SMF shall send a PFCP Session Modification Request message to the UPF: + +- including the MBS Session N4 Control Information IE and re-creating the DL PDR(s) of the MBS QoS flows, following the same requirements as described above for associating the PDU session with the MBS session, if the SMF removed the DL PDR(s) that were created to receive the MBS session data when the MBS session was deactivated; or +- associating the DL PDR(s) of the MBS QoS flows with the FAR provisioned with the N3 DL F-TEID to forward packets, if the SMF decided to keep the UPF receiving MBS Session data from N19mb by associating these DL PDR(s) with a FAR set to drop packets when the MBS session was deactivated. + +During a restoration procedure for an MB-UPF failure without Restart (see clause 8.2.3 of 3GPP TS 23.527 []), if multicast transport is used over N19mb: + +- the SMF shall instruct the UPF to use the new Low Layer Source Specific Multicast address, i.e. the Multicast address and the source IP address and the GTP-U Common TEID which have been allocated by the new MB-UPF for the MBS session, by sending a PFCP Session Modification Request message with the MBS Session N4 Control Information IE including the MBS Session Identifier, the Area Session ID (for a location dependent MBS service) and the Multicast Transport Information IE containing the new LL SSM address and GTP-U Common TEID; +- upon receipt of such a request, the UPF shall send an IGMP JOIN request to join the multicast tree to receive the MBS session data from the new MB-UPF and it shall leave delivery from the previous multicast address that was in use for the MBS session. The UPF shall set the indication "JMTI"(Joined N19mb Multicast Tree Indication) in the MBSN4Resp-Flags IE in the PFCP Session Modification Response to indicate that the UPF has joined the multicast tree from MB-UPF. + +When receiving the MBS session data for a given MBS session, or for a given MBS session and Area Session ID for a location dependent MBS service, either from the N19mb DL Tunnel allocated for this MBS Session (where the packets shall be identified by N19mb DL TEID) when unicast transport is used, or from the low layer Multicast transport address (where the packets shall be identified by the low layer Multicast transport address) when multicast transport is used, the UPF shall replicate the MBS Session data to all PFCP sessions which are associated with the MBS Session, or with the MBS session and Area Session ID for a location dependent MBS service. + +The UPF shall forward the MBS DL QFI Sequence Number in the PDU Session Container (see 3GPP TS 38.415 [34]) of MBS data packets received from the MB-UPF unmodified. + +### 5.34.3.3 Instructing a combined UPF/MBS-UPF to forward multicast MBS data to associated PDU sessions + +The procedures and requirements to instruct a combined UPF/MB-UPF to associate a PDU session with an MBS session (or with the MBS session and Area Session ID for a location dependent MBS service) for which it serves as the MB-UPF shall be as specified in clauses 5.34.2.2 and 5.34.3.2, with the following additions: + +- the combined UPF/MB-UPF may determine that the PDU session is being associated with an MBS session (or with an MBS session and Area Session ID for a location dependent MBS service) for which it serves as MB-UPF by determining whether a specific PFCP session has been established for the MBS session (or with the MBS session and Area Session ID for a location dependent MBS service), as specified in clause 5.34.2.2; +- the SMF shall instruct the combined UPF/MB-UPF to associate the PDU session with the MBS session (or with the MBS session and Area Session ID for a location dependent MBS service) as specified in clause 5.34.3.2, as if the UPF and MB-UPF were not combined; this means in particular that the DL PDR of the PFCP session of the PDU session to be associated with the MBS session (or with the MBS session and Area Session ID for a location dependent MBS service) shall not contain an N6mb / Nmb9 address or IP multicast addressing information; + +NOTE 1: Only the PFCP session created for the MBS session (or for the MBS session and Area Session ID for a location dependent MBS service) as specified in clause 5.34.2.2 can contain a N6mb / Nmb9 address or IP multicast addressing information. + +- it is an implementation choice for such combined UPF/MB-UPF to allocate a (possibly virtual / internal) N19mb DL Tunnel ID (i.e. IP address and TEID) or to indicate to the SMF that it has joined the low layer multicast group assigned by the MB-UPF for the MBS session (or for the MBS session and Area Session ID for a location dependent MBS service), and the combined UPF/MB-UPF shall respond to the SMF accordingly, as if it is the UPF and MB-UPF were not combined; +- if the combined UPF/MB-UPF returns a N19mb DL Tunnel ID with the NN19DT (New N19mb Downlink Tunnel) indication set to 1, the SMF shall request the MB-SMF to (or the combined SMF/MB-SMF shall) instruct the MB-UPF to forward and replicate MBS Session data towards the (possibly virtual / internal) N19mb DL Tunnel ID as specified in clause 5.34.2.2, as if the UPF and MB-UPF were not combined. + +NOTE 2: The SMF, MB-SMF or a combined SMF/MB-SMF need not implement any additional logic when communicating with a combined UPF/MB-UPF. + +## 5.35 Support of Per Slice UP Resource Allocation and Usage Reporting by the UP Function + +### 5.35.1 General + +A UP Function may serve PDU sessions belonging to different network slices (i.e. S-NSSAIs). + +UP resources allocation per network slice may be achieved by: + +- the UP function allocating UP resources based on the Network Instance IE (and other N4 information such as PDU session type, IP Address Pool ID, ATSSS Control Information), with distinct Network Instance values being configured in the CP function and UP Function for different network slices; or + +NOTE 1: The above behavior does not require support of any specific PFCP protocol extension and can be supported by UP function implementations complying with earlier releases of the specification. + +- the UP function allocating UP resources based on the Network Instance IE and S-NSSAI IE (and other N4 information such as PDU session type, IP Address Pool ID, ATSSS Control Information), if the feature "Per Slice UP Resource Management" is supported by the UP function and if the UP function is configured to do so by operator policy. + +A UP function that supports allocating UP resources based on the Network Instance IE and S-NSSAI IE (and other N4 information) and that is configured to do so by operator policy, shall: + +- indicate support of the feature "Per Slice UP Resource Management" in the UP Function Features IE during the PFCP association setup procedure; and +- allocate resources in the UP function using the Network Instance and, if available, the S-NSSAI. + +A UP function that does not support allocating UP resources based on the Network Instance IE and S-NSSAI IE or that is not configured to do so by operator policy shall allocate UP resources based on the Network Instance IE (and other N4 information). + +If the UP function supports the UE IP Address Usage Reporting feature (see clause 5.21.3.2), the UP function shall report the UP IP address usage as specified in clause 5.21.3.2, by reporting the UE IP address usage: + +- per Network Instance, if the UP function does not support allocating UP resources based on the Network Instance IE and S-NSSAI IE or it is not configured to do so by operator policy; or + +NOTE 2: This allows to report UE IP address usage per network slice when using a distinct Network Instance value per network slice. + +- b) per Network Instance and S-NSSAI, if the UP function supports allocating UP resources based on the Network Instance IE and S-NSSAI IE and is configured to do so by operator policy. In this case, the UP Function shall report the UE IP address usage information associated with a specific S-NSSAI, as specified in clause 5.21.3. + +NOTE 3: If the UP function indicates that it supports the "Per Slice UP Resource Management" feature and if this feature is also supported by the CP function, the CP function can instruct the UP function to allocate UP resource taking into account the network slice by including the Network Instance IE and S-NSSAI IE in the PFCP session establishment procedure. Otherwise, a separate Network Instance needs to be configured for each S-NSSAI if support of multiple slices is needed. + +## 5.36 Paging Policy Indicator Provisioning + +### 5.36.1 General + +Stage 2 requirements for Paging Policy Differentiation are specified in clause 5.4.3.2 of 3GPP TS 23.501 [28]. + +For a UE in RRC Inactive state the NG-RAN can be required to enforce specific paging policies in the case of NG-RAN paging, based on 5QI, ARP and PPI associated with an incoming DL PDU. To support this, the SMF shall instruct the UPF to detect the DSCP in the TOS (IPv4) / TC (IPv6) value in the IP header of the DL PDU and insert the corresponding PPI as described below. When Paging Policy Differentiation is enabled in the network and a PPI needs to be inserted into DL PDU, the SMF shall: + +- provision a PDR for each PPI containing one or more DSCP code(s) to be matched against the DSCP in the TOS (IPv4) / TC (IPv6) value in the IP header of the DL PDUs, where these DSCP code(s) are to be mapped to the same PPI, in the PDI together with or without the service data flow detection information; + +NOTE 1: When service data flow level packet detection is not required, e.g. for an I/V-UPF, the PDR can be provisioned with one or more DSCP(s) to be matched in the PDI without any service data flow detection information. + +NOTE 2: When service data flow level packet detection is required, several PDRs with the same service data flow detection information but with different (set of) DSCP(s) (which are mapped to different PPI) need to be provisioned. + +- associate the PDR with a QER with the Paging Policy Indicator set to the mapped PPI to instruct UPF to insert the corresponding PPI into the GTP-U PDU Session Container extension header of outgoing packets. + +### 5.36.2 Enhanced Paging Policy Indicator Provisioning + +To reduce the number of PDRs/QERs to be provisioned (in order to support NG-RAN paging using Paging Policy Indicator (PPI)), the SMF and the UPF may support the Enhanced Provisioning Paging Policy Indicator (EPPPI) feature as specified below. + +During a PFCP session establishment/modification procedure, if both the SMF and the UPF support the EPPPI feature, the SMF may include a DSCP to PPI Control Information in the PFCP Session Establishment/Modification Request message to instruct the UPF to insert a PPI in the GTP-U PDU Session Container extension header of downlink GTP-U packets encapsulating payload packets (to be sent to the UE). When the DSCP to PPI Control Information IE is present, the SMF may: + +- include one or more DSCP to PPI Mapping Information to instruct the UPF to insert the corresponding PPI for downlink GTP-U packets, where the DSCP of its payload packet is matching one of DSCP codes in the DSCP to PPI Mapping Information; +- include one or more QFIs to instruct UPF to insert PPI only for the downlink packets received on the requested QFI(s); + +## 5.37 Traffic Parameters Measurement per QoS flow + +### 5.37.1 General + +The UP function may be requested by the SMF to perform Traffic Parameters Measurement per QoS flow, e.g. to enable NG-RAN to configure UE power saving management scheme for connected mode DRX as specified in clauses 5.37.8 and 5.8.5 of 3GPP TS 23.501 [28]. The following clauses specify Traffic Parameters Measurement procedure. + +### 5.37.2 Traffic Parameter Measurement Control + +When requesting the UPF to perform Traffic Parameter Measurement, the SMF shall provision one or more Traffic Parameter Measurement Control Information IEs in a Session Reporting Rule to instruct the UPF to measure relevant traffic parameters for one or more QoS Flows. + +The Traffic Parameter Measurement Control Information IEs shall include: + +- one or more QFI IEs indicating the QoS flow(s) for which traffic parameters are requested to be measured; +- either a Measurement Period for periodic reporting or a Traffic Parameter Threshold to trigger the report; +- the Traffic Parameter Measurement Indication to indicate the traffic parameters requested to be measured. + +The SMF may require the UPF to stop the on-going Traffic Parameter Measurement for a QoS flow by sending a PFCP Modification Request with the Remove SRR IE, or by sending a PFCP Modification Request with the Update SRR IE within which the previous Traffic Parameter Measurement Control Information IE is removed or updated by removing the corresponding QFI(s) (when there are still QFI(s) left). Upon receiving such a PFCP Modification Request message, the UPF shall stop the corresponding Traffic Parameter Measurement for the QoS flow. + +### 5.37.3 Traffic Parameter Measurement Report + +If the UPF is requested to perform Traffic Parameter Measurement for a QoS flow (i.e. it receives one or more Traffic Parameter Measurement Control Information IEs from the SMF), the UPF shall measure the relevant traffic parameters according to Traffic Parameter Measurement Indication and generate a Traffic Parameter Measurement Report towards the SMF as instructed, i.e., either periodically or when the measured traffic parameter is exceeding the provisioned threshold. + +## 5.38 Support for high data rate low latency services, (eXtended Reality) XR and interactive media services + +### 5.38.0 General + +Stage 2 requirements related to the support for high data rate low latency services, eXtended Reality (XR) and interactive media services are specified in clause 5.37 of 3GPP TS 23.501 [28], which includes the following features requiring protocol enhancement to signalling interactions between the SMF and UPF over N4: + +- Support of ECN marking for L4S as specified in clause 5.37.3 of 3GPP TS 23.501 [28]; +- Support of Network Exposure of 5GS information, including control of reporting the congestion information, Data rate and Round trip delay measurement for QoS flow(s) as specified in clause 5.37.4 of 3GPP TS 23.501 [28]; +- Support of PDU Set based QoS Handling as specified in clause 5.37.5 of 3GPP TS 23.501 [28]; +- Support of N6 Jitter Measurement and End of Data Burst Indication for UE power saving in clause 5.37.8 of 3GPP TS 23.501 [28]. + +It is optional for both the SMF and the UPF to support above features, hence the SMF may trigger the procedures specified in this clause only when the UPF has indicated its support of the corresponding feature via the UP Function Features IE. (see clause 8.2.25) + +### 5.38.1 Support of ECN marking for L4S + +Stage 2 requirements for the support of ECN marking for L4S are specified in clause 5.37.3 of 3GPP TS 23.501 [28]. This exposes congestion information by marking ECN bits in the IP header of the user IP packets between the UE and the application server to trigger application layer rate adaptation. + +Support of this feature is optional for the SMF and UPF. A UPF that supports ECN marking for L4S on behalf of and due to congestion in NG-RAN shall indicate so to the SMF by setting the EML4S flag in the UP Function Features IE (see clause 8.2.25). + +ECN marking for L4S may be enabled on a per QoS flow basis in the uplink and/or downlink direction and may be used for GBR and non-GBR QoS Flows. + +NOTE 1: A QoS flow eligible for ECN marking can be determined statically when a PDU session is established based on configuration in SMF or PCF, or dynamically based on the detection of the L4S traffic (e.g. matching packets with ECT(1) or CE (see IETF RFC 9331 [81]) together with IP 5 tuple in the IP header) whereby SMF or PCF triggers a setup of a QoS Flow enabled for L4S, or by requests by an AF. + +NOTE 2: ECN marking for L4S in the IP header due to congestion in NG-RAN can be supported by NG-RAN itself or can be delegated to the PSA UPF. If supported by both, it is enabled by the SMF either in the NG-RAN or in the PSA UPF, based on operator's policies. This clause describes requirements for ECN marking done in the PSA UPF. + +NOTE 3: In general, any network layer node that experiences congestion and is capable of performing ECN marking for L4S in the IP header can do so to contribute to the end to end L4S support. This clause describes only the marking due to congestion in NG-RAN with ECN marking delegated to the PSA UPF. It does not prevent though any other network layer node to perform ECN marking of the user IP packets due to other congestion point in the end-to-end path. + +If the UPF indicated support of ECN marking for L4S (i.e. the EML4S feature), the SMF may instruct the UPF to perform ECN marking for L4S for one QoS flow, in a PFCP Session Establishment Request or a PFCP Session Modification Request, by setting the ECN marking for L4S indicator in a QER associated with the UL and/or DL PDRs of this QoS flow. + +NOTE 4: The PDR can use SDF filter(s) (e.g. matching packets with ECT(1) or CE (see IETF RFC 9331 [81]) together with IP 5 tuple) to steer traffic to an L4S enabled QoS Flow. + +NOTE 5: The SMF also indicates to NG-RAN to report the congestion information (i.e. a percentage of packets to be used by the UPF for ECN marking for L4S) of the QoS Flow on UL and/or DL directions via GTP-U header extension to PSA UPF. If there is no UL packet when report for DL and/or UL needs to be provided, NG-RAN may generate an UL Dummy GTP-U Packet for such a reporting. + +Upon being instructed to perform ECN marking for L4S for a QoS flow, the UPF shall use the information sent by NG-RAN in GTP-U header extension (see 3GPP TS 38.415 [34] and 3GPP TS 38.300 [42]) of GTP-U packets of the corresponding QoS flow to perform ECN bits marking for L4S for the corresponding direction. + +During PDU session establishment procedure, if the SMF receives the ECN Marking or Congestion Monitoring Reporting Status (in the PDU Session Resource Setup Response Transfer IE) from the NG-RAN which indicates that congestion information reporting for the QoS flow is not active, then the SMF shall instruct the UPF to stop ECN marking for L4S, by setting the ECN marking for L4S indicator to "0" in the QER associated with the PDRs of the QoS flows for which ECN marking was enabled, in a PFCP Session Modification Request if the SMF has instructed the UPF to perform ECN marking for L4S for a QoS flow previously. + +During a NG-RAN Xn handover and N2 handover, if the congestion information reporting has been enabled on source NG-RAN while the target NG-RAN does not support congestion information reporting, then the SMF shall instruct the UPF to stop ECN marking for L4S, by setting the ECN marking for L4S indicator to "0" in the QER associated with the PDRs of the QoS flows for which ECN marking was enabled, in a PFCP Session Modification Request. + +Upon being instructed to stop performing ECN marking for a QoS flow, the UPF shall stop doing so. + +**Editor's Note:** Further details on how the UPF performs ECN marking for L4S based on the congestion information received from the NG-RAN need to be specified + +## 5.38.2 Support of Network Exposure of 5GS information + +**Editor's Note:** it is FFS for the detail, possibly needs to refer to QoS monitoring clause. + +## 5.38.3 Support of PDU Set based QoS Handling + +Stage 2 requirements for the support of PDU Set based QoS handling are specified in clause 5.37.5 of 3GPP TS 23.501 [28]. A PDU Set comprises one or more PDUs carrying the payload of one unit of information generated at the application level (e.g. frame(s) or video slice(s) etc. for eXtended Reality (XR) Services). All the PDUs of a PDU set are transmitted within the same QoS Flow. + +This clause specifies how the SMF instructs the UPF to identify PDUs that belong to PDU sets and to perform PDU Set marking for a QoS Flow enabled with PDU Set based QoS handling, and how the SMF instructs the UPF to stop PDU sets identification and marking. + +The support of this feature is optional for the SMF and UPF. A UPF that supports PDU Set based QoS handling shall indicate so to the SMF by setting the PDUSM flag in the UP Function Features IE (see clause 8.2.25). + +PDU Set marking may be enabled on a per QoS flow basis in the downlink direction and may be used for GBR and non-GBR QoS Flows. + +If the NG-RAN indicated support of PDU Set based handling in N2 SM Information and if the UPF indicated support of PDU Set marking (i.e. the PDUSM feature), the SMF may instruct the UPF to identify PDU sets and perform PDU sets marking for one QoS flow, in a PFCP Session Establishment Request or a PFCP Session Modification Request, by setting the PDU Set marking indicator to "1" in a QER associated with the DL PDRs of this QoS flow and by optionally providing the Protocol Description in these DL PDRs indicating the header, extension header (e.g. RTP/SRTP) and payload type (e.g. H.264) used by the service data flow. + +Upon the completion of a NG-RAN Xn handover and N2 handover from a NG-RAN supporting PDU set based QoS handling to a NG-RAN not supporting the same, the SMF may instruct the UPF to stop identifying PDU sets and performing PDU sets marking for each QoS flow of the UE's PDU session(s) for which PDU Set based QoS handling was enabled, by setting the PDU Set marking indicator to "0" in the QER associated with the DL PDRs of each QoS flow in a PFCP Session Modification Request. + +Upon the completion of a NG-RAN Xn handover and N2 handover from a NG-RAN not supporting PDU set based QoS handling to a NG-RAN supporting the same, the SMF may instruct the UPF to start identifying PDU sets and performing PDU sets marking for one or more QoS flow(s) of the UE's PDU session(s), by setting the PDU Set marking indicator to "1" in the QER associated with the DL PDRs of the corresponding QoS flow(s) and by optionally providing the Protocol Description used by the service data flow(s) in a PFCP Session Modification Request. + +NOTE 1: The Protocol Description included in DL PDRs is not used for packets matching against the PDRs but to assist the PDU Set identification by the UPF. + +NOTE 2: The SMF also provides the NG-RAN with PDU Set QoS parameters, as specified in clause 5.7.7 of 3GPP TS 23.501 [28]. + +Upon being instructed to identify PDU sets and to perform PDU Set marking for a QoS flow, the UPF shall: + +- identify the PDU sets using the Protocol Description (if available) and the received RTP/SRTP headers or using implementation specific means; details of the RTP/SRTP headers, header extensions and/or payloads used to identify PDU Set Information are defined in 3GPP TS 26.522 [79]; and +- for each DL PDU received for the corresponding QoS flow, the UPF shall provide PDU Set information which is available to the NG RAN in the GTP-U PDU Session Container extension header, including: + - the PDU Set Sequence Number; + - the Indication of End PDU of the PDU Set; + - the PDU Sequence Number within the PDU Set; + - the PDU Set Size in bytes; and + +- the PDU Set Importance, which identifies the relative importance of a PDU Set compared to other PDU Sets within a QoS Flow. + +**Editor's note:** Extensions to the GTP-U PDU Session Container extension header to include PDU Set information are pending RAN3 progress on XRM. + +Upon being instructed to stop identifying PDU sets and performing PDU Set marking for a QoS flow, the UPF shall stop doing so. + +## 5.38.4 N6 Jitter Measurement and End of Data Burst Indication + +### 5.38.4.1 General + +Stage 2 requirements related to N6 Jitter measurement and End of Data Burst Indication are specified in clauses 5.37.8 and 5.8.5 of 3GPP TS 23.501 [28]. The N6 Jitter Information associated with the DL Periodicity (that is used by the PSA UPF to measure the N6 jitter), the UL Periodicity and the Indication of End of Data Burst (included in the PDU Session Container extension header in the GTP-U header of the last PDU of each data burst) are provided to NG-RAN as traffic assistance information enabling to configure UE power saving management scheme for connected mode DRX. + +Support of N6 Jitter, DL Periodicity and UL Periodicity measurements and End of Data Burst Indication is optional for the SMF and UPF to support. The procedures specified in this clause may apply if the UPF indicates its support of the N6JEDB feature (see clause 8.2.25). + +When the UPF supports the N6JEDB feature, the SMF may request the UPF to perform N6 Jitter measurement and conditionally DL and/or UL Periodicity measurements and to set the End of Data Burst indication in the last PDU of each data burst, during a PFCP session establishment or a PFCP session modification procedure. + +### 5.38.4.2 N6 Jitter and UL/DL Periodicity Measurement Control + +When requesting the UPF to perform N6 Jitter and Periodicity Measurement, the SMF shall provision one or more Traffic Parameter Measurement Control Information IEs in a Session Reporting Rule as specified in clause 5.37.2 to instruct the UPF to measure and report N6 jitter information associated with a DL Periodicity for one or more QoS Flows in downlink direction and conditionally the DL and/or UL Periodicity. + +In the Traffic Parameter Measurement Control Information IE(s) the SMF shall: + +- include the DL Periodicity if this information is available; and +- set the Traffic Parameter Measurement Indication to request the UPF to measure and report N6 Jitter and conditionally the DL and/or UL Periodicity if the SMF does not receive the DL and/or UL Periodicity from the PCF. + +### 5.38.4.3 N6 Jitter and UL/DL Periodicity Measurement Report + +If the UPF is requested to perform N6 Jitter and UL/DL Periodicity measurement for a QoS flow (i.e. it receives one or more Traffic Parameter Measurement Control Information IEs from the SMF), the UPF shall measure the UL/DL Periodicity (if required), N6 Jitter using the received DL Periodicity if available otherwise using the measured DL Periodicity, and generate a Traffic Parameter Measurement Report towards the SMF as specified in clause 5.37.3. + +### 5.38.4.4 End of Data Burst Marking + +The SMF may request the UPF to detect the last PDU of each Data Burst in the application traffic and then mark the End of Data Burst Indication in the GTP-U PDU Session Container extension header of the GTP-U packet conveying that PDU, according to the PCC rule and/or the local operator policies. + +When doing so, the SMF shall set the EDBMI flag to "1" in the QER Indications IE in the QER which is for the QoS flow conveying the application traffic, to instruct the UPF to mark the End of Data Burst Indication in the GTP-U PDU Session Container extension header of the GTP-U packets conveying the last PDU. Additionally, the SMF may include the Protocol Description (see clause 5.38.3) used by the service data flow in the PDR providing information to the UPF on how to detect the last PDU of each Data Burst within the application traffic. + +Upon receiving such a request, the UPF shall identify the last PDU of each Data Burst in the DL application traffic based on the End indication according to the Protocol Description or UPF implementation, and it shall mark the End of Data Burst Indication in the GTP-U PDU Session Container extension header of the GTP-U packet conveying that PDU accordingly. + +**Editor's Note:** The name of the End of Data Burst Indication is to be aligned with RAN3 specification. + +## 5.39 QoS flow related QoS monitoring and reporting + +### 5.39.1 General + +Stage 2 requirements on QoS Monitoring are specified in clause 5.45 of 3GPP TS 23.501 [28]. + +QoS monitoring comprises of measurements of QoS parameters for a QoS Flow. + +### 5.39.2 QoS Monitoring Control + +The SMF shall instruct the UPF to perform Per QoS flow QoS monitoring, during a PFCP session establishment or a PFCP session modification procedure, by provisioning a SRR with one or more QoS Monitoring per QoS flow Control Information IEs for one or more QoS flows and for one or more QoS parameters described in clause 5.39.3, if the UPF has indicated support of the corresponding features. + +The SMF shall provision the following IEs in the QoS Monitoring per QoS flow Control Information IE: + +- one or more QFI IEs indicating the QoS flow(s) for which QoS monitoring is requested; +- the Requested QoS Monitoring IE indicating one or more QoS parameters to be measured; +- the Reporting Frequency IE indicating the type of the reporting as "Event Triggered" or "Periodic": + - If the Reporting Frequency indicates "Event Triggered", a Reporting threshold for each parameter in Requested QoS Monitoring IE and a Minimum Wait Time IE shall be provided as well. The UPF shall send a report when the measurement result matches or exceeds the indicated Reporting threshold. Subsequent reports shall not be sent by the UPF during the Minimum Wait Time. If measurement results are received during the Minimum Wait Time, the UPF shall report the minimum and the maximum measurement result when the Minimum Wait Time is over. + - "Periodic" indicates that the UPF shall send a report each time the measurement period is over. +- the Minimum Wait Time IE, to indicate the minimum waiting time between two consecutive reports, if the Event Triggered QoS monitoring reporting is required in the reporting frequency; +- the Measurement Period IE, indicating the period to generate periodic usage reports, periodic QoS monitoring reporting is required in the reporting frequency; and/or +- the Reporting Suggestion Information IE, i.e. Report urgency indicating whether the event report can be delayed (i.e. it is delay-tolerant) and if so, the Reporting time information defining the last valid reporting time for the UPF to report the detected event. The Reporting time information shall be present if the Report urgency indicates the event report is delay tolerant. Per Reporting suggestion information, the UPF may concatenate several QoS monitoring reports for the same PFCP session in one PFCP Session Report Request (for event reporting over N4) or in one UPF event notification towards the same notification endpoint identified by the notification URI and notification correlation id (for event reporting using the Nupf\_Event\_Exposure service). + +If the UPF supports Direct Reporting of QoS monitoring events (i.e. the DRQOS feature, see clause 8.2.25), the SMF shall include the Direct Reporting Information IE in the SRR, including the Event Notification URI towards which the events shall be sent, and if available, the Notification Correlation ID to be included in these events, if the UPF shall send the reports to a different NF than the SMF (i.e. to the Local NEF or the AF). If the events need to be sent both directly to the local NEF or AF and to the SMF, the Direct Reporting Information IE shall also include the Reporting Flags IE with the DUPL flag set to "1"; if so, the UPF shall send the reports to the SMF as well. If the the Direct Reporting Information IE is not provided, the UPF shall send the reports to the SMF. + +**NOTE:** The QoS measurements requested to be measured in a given SRR share the same Direct Reporting Information, including the same Event Notification URI. + +The SMF may instruct to measure different QoS parameters of a same QoS flow in a same QoS Monitoring per QoS flow Control Information IE, or in separate QoS Monitoring per QoS flow Control Information IEs if different instructions need to be set in the QoS Monitoring per QoS flow Control Information IE for the different QoS parameters (e.g. different Reporting Frequency or Measurement Period). + +The SMF may update the QoS parameters to be measured by an on-going Per QoS flow QoS monitoring by sending a PFCP Modification Request with the Update SRR IE with a modified QoS Monitoring per QoS flow Control Information IE adding or removing QoS parameters to be measured; the SMF shall provide the complete list of QoS Monitoring per QoS flow Control Information IEs, and the UPF shall replace any earlier list by the new received list of QoS Monitoring per QoS flow Control Information IEs. Upon receiving such a PFCP Modification Request message, the UPF shall measure the QoS parameters according to the newly received instructions from the SMF. + +The SMF may require the UPF to stop an on-going Per QoS flow QoS monitoring by sending a PFCP Modification Request with the Remove SRR IE, or by sending a PFCP Modification Request with the Update SRR IE within which the previous QoS Monitoring per QoS flow Control IE is removed. Upon receiving such a PFCP Modification Request message, the UPF shall stop the on-going Per QoS flow QoS monitoring. + +## 5.39.3 Measurable QoS parameters and specific requirements for their measurement + +### 5.39.3.1 General + +This clause describes the QoS parameters that may be measured (i.e. monitored) by the UPF and specific requirements for their measurement. + +### 5.39.3.2 Packet delay monitoring + +QoS monitoring for packet delay allows for the measurement of UL packet delay, DL packet delay or round trip packet delay between UE and PSA UPF. + +The SMF may instruct the UPF to perform packet delay monitoring, if the UPF indicated support of Per QoS flow per UE QoS monitoring for packet delay, i.e. support the QFQM feature (see clause 8.2.25). + +Specific requirements for the QoS Monitoring for packet delay are specified in clauses 5.24.4 and 5.24.5. + +### 5.39.3.3 Congestion information monitoring + +Stage 2 requirements for the support of per QoS flow congestion information monitoring are specified in clauses 5.45.3 and 5.37.4 of 3GPP TS 23.501 [28]. QoS monitoring for congestion information allows to monitor and report the congestion information of a QoS flow for the DL and/or UL directions received from the NG-RAN. + +The UPF shall set the QMCON feature flag in the UP Function Features IE if it supports per QoS flow QoS monitoring for congestion information (see clause 8.2.25). If so, the SMF may request the UPF to perform congestion information monitoring during a PFCP session establishment or a PFCP session modification procedure. + +The SMF shall instruct the UPF to perform per QoS flow QoS monitoring for congestion information as specified in clause 5.39.2, with the following additions: + +- the Requested QoS Monitoring IE in the QoS Monitoring per QoS flow Control Information IE shall indicate a request to monitor the congestion information for DL and/or UL directions; and +- the reporting frequency shall be set to "Event Triggered QoS monitoring reporting" if events are requested to be reported upon a change of the congestion information. + +A UPF that indicates support of both the DRQOS and QMCON feature flags shall support reporting the congestion information report directly to the target NF or to the SMF, as specified in clause 5.39.2. + +### 5.39.3.4 Data rate monitoring + +Stage 2 requirements for the support of per QoS flow data rate monitoring are specified in clauses 5.45.4 and 5.37.4 of 3GPP TS 23.501 [28]. Data rate monitoring allows to monitor and report the UL and/or DL data rate of a Non-GBR or GBR QoS flow at the UPF. + +The UPF shall set the QMDRM feature flag in the UP Function Features IE if it supports per QoS flow data rate monitoring (see clause 8.2.25). If so, the SMF may request the UPF to perform data rate monitoring per QoS flow during a PFCP session establishment or a PFCP session modification procedure. + +The SMF shall instruct the UPF to perform per QoS flow data rate monitoring as specified in clause 5.39.2, with the following additions: + +- the Requested QoS Monitoring IE in the QoS Monitoring per QoS flow Control Information IE shall indicate a request to monitor the UL and/or DL data rate; and +- the reporting frequency shall be set to "Periodic" QoS monitoring report; +- the Measurement Period IE, indicating the period to generate periodic usage reports. + +A UPF that indicates support of both the DRQOS and QMDRM feature flags shall support reporting the UL and/or DL data rate information report directly to the target NF or to the SMF, as specified in clause 5.39.2. + +The UPF shall measure the data rate over the last monitoring averaging window of the measurement period and report the average DL and/or UL throughput. The monitoring averaging window shall be set to the same value as the averaging window used for computing the GBR/MBR of the QoS flow (i.e. Averaging window provisioned in the QER or default averaging window configured at the UPF) for a GBR QoS flow. + +**Editor's note: the standardized averaging window to be used for data rate monitoring for non-GBR QoS flows is FFS.** + +## 5.39.4 QoS Monitoring Reporting + +The UPF shall report the QoS monitoring result of the QoS flows by sending: + +- QoS Monitoring Report IEs to the SMF in PFCP Session Report Request. Several QoS Monitoring Report IEs may be present to report QoS measurements for multiple QoS flows; and/or +- QoS monitoring events directly to the Local NEF or AF using the UPF Event Exposure service specified in 3GPP TS 29.564 [73]. See clause 5.33.5. + +An UPF that supports Direct Reporting of QoS monitoring events to the Local NEF or AF shall send the Per QoS Flow Per UE QoS Monitoring events to the SMF if the SRR does not contain the Direct Reporting Information IE, or directly to the Local NEF or AF using the notification URI received in the Direct Reporting Information IE, or both if the Direct Reporting Information IE is provided with the DUPL flag set to "1", as specified in clause 5.39.2. + +The UPF shall continue to apply all the provisioned SRR(s) and perform the related QoS monitoring measurement(s), until getting any further instruction from the CP function. + +--- + +# 6 Procedures + +## 6.1 Introduction + +The following clauses specify the procedures supported over the Sxa, Sxb and Sxc reference points. + +## 6.2 PFCP Node Related Procedures + +### 6.2.1 General + +The following clauses specify either node level or PFCP entity level procedures over the Sxa, Sxb, Sxc and N4 reference points. The behaviour of the CP function and UP function when sending and receiving a node related message is described. + +### 6.2.2 Heartbeat Procedure + +#### 6.2.2.1 General + +PFCP Heartbeat is a PFCP entity level procedure. + +Two messages are specified for PFCP heartbeat procedure: Heartbeat Request and Heartbeat Response. The use of these messages is further specified in clause 19A of 3GPP TS 23.007 [24] for EPC, and in clause 4 of 3GPP TS 23.527 [40] for 5GC. + +#### 6.2.2.2 Heartbeat Request + +An PFCP entity of a CP or UP function may send a Heartbeat Request to a PFCP entity of a peer node to find out if the peer PFCP entity is alive. If multiple PFCP entities pertain to the same CP or UP function, each PFCP entity may send Heartbeat Request messages towards each PFCP entity pertaining to the peer node with which a PFCP control association is established. + +NOTE 1: If the UP function supports the MPAS feature and connected to an SMF set, each PFCP entity of the UP function can send heartbeat Requests towards each PFCP entity of every SMF with which a PFCP control association is established. + +NOTE 2: If the UP function supports the SSET feature and connected to an SMF set, each PFCP entity of the UP function can send heartbeat Requests towards each PFCP entity pertaining to the same SMF or the SMFs in the SMF set with which a PFCP control association is established. + +A CP function or UP function shall be prepared to receive a Heartbeat Request at any time (even from unknown peers) and it shall reply with a Heartbeat Response. + +#### 6.2.2.3 Heartbeat Response + +The message shall be sent as a response to a received Heartbeat Request. + +### 6.2.3 Load Control Procedure + +#### 6.2.3.1 General + +Load Control is a node level procedure. + +Load Control is an optional feature defined over the Sxa, Sxb, Sxc and N4 reference points. + +Load control enables the UP function to send its load information to the CP function to adaptively balance the PFCP session load across the UP functions according to their effective load. The load information reflects the operating status of the resources of the UP function. + +Load control allows for better balancing of the PFCP session load, so as to attempt to prevent overload in the first place (preventive action). Load control does not trigger overload mitigation actions even if the UP function reports a high load. + +Load control and overload control may be supported and activated independently in the network, based on operator's policy. + +### 6.2.3.2 Principles + +The UP function may signal its Load Control Information to reflect the operating status of its resources, at the node level, allowing the receiving CP function to use this information to augment the UP function selection procedures. + +The Load Control Information is piggybacked in PFCP request or response messages such that the exchange of Load Control Information does not trigger extra signalling. + +NOTE: The inclusion of Load Control Information in existing messages means that the frequency of transmission of load control information increases as the session load increases, allowing for faster feedback and thus better regulation of the load. + +The calculation of the Load Control Information is implementation dependent and its calculation and transfer shall not add significant additional load to the node itself and to its corresponding peer nodes. + +### 6.2.3.3 Load Control Information + +#### 6.2.3.3.1 General Description + +A PFCP message may contain one instance of the Load Control Information (LCI) IE. + +When providing load control information in a message for the first time or subsequently, the UP function shall always include the full set of load control information, i.e. all the node level instance of the Load Control Information, even if only a subset of the load control information has changed. The Load Control Sequence Number shall be incremented whenever the load control information is changed (see clause 6.2.3.3.2.1). + +Load Control Information shall be linked to the Node ID (i.e. FQDN or the IP address used during the UP function selection) of the UP function providing the Information. + +The receiver shall overwrite any stored load control information of a peer with the newly received load control information from the same peer node if the new load control information is more recent than the old information as indicated by the Load Control Sequence Number, e.g. if the receiver has stored an instance of the load control information for a peer node, it overwrites this instance with the new instance received in a message from the same peer node. + +The receiver shall consider all the parameters received in the same instance of the LCI IE in conjunction while using this information for UP function selection. + +The parameters are further defined in clause 6.2.3.3.2. + +Load control information may be extended with new parameters in future versions of the specification. Any new parameter will have to be categorized as: + +- Non-critical optional parameters: the support of these parameters is *not critical* for the receiver. The receiver can successfully and correctly comprehend the load control information instance, containing one or more of these parameters, by using the other parameters and ignoring the non-critical optional parameter. +- Critical optional parameters: the support of these parameters is *critical* for the receiver to correctly comprehend the instance of the load control information containing one or more of these parameters. + +The sender may include one or more non-critical optional parameters within any instance of the LCI IE without having the knowledge of the receiver's capability to support the same. However, the sender shall only include one or more critical optional parameter in an instance of the LCI IE towards a receiver if the corresponding receiver is known to support those parameters. The sender may be aware of this either via signalling methods or by configuration (this will have to be defined when introducing any such new parameter in future). + +#### 6.2.3.3.2 Parameters + +##### 6.2.3.3.2.1 Load Control Sequence Number + +The Load Control Sequence number contains a value that indicates the sequence number associated with the LCI IE. This sequence number shall be used to differentiate any two LCI IEs generated at two different instances by the same + +UP function. The Load Control Sequence Number shall be supported (if load control is supported) and shall always be present in the LCI IE. + +The UP function generating this information shall increment the Load Control Sequence Number whenever modifying some information in the Load Control Information IE. The Load Control Sequence Number shall not be incremented otherwise. The UP function may use the time, represented in an unsigned integer format, of the generation of the Load Control Information to populate the Load Control Sequence Number. + +This parameter shall be used by the receiver of the Load Control Information IE to properly collate out-of-order load control information, e.g. due to PFCP retransmissions. This parameter shall also be used by the receiver of the LCI IE to determine whether the newly received load control information has changed compared to load control information previously received from the same node earlier. + +NOTE: The PFCP sequence number cannot be used for collating out-of-order load control information as e.g. load control information may be sent in both PFCP requests and responses, using independent PFCP sequence numbering. + +If the receiving entity has already received and stored load control information from the peer UP function, the receiving CP function shall update its load control information only if the Load Control Sequence Number received in the new load control information is higher than the stored value of the Load Control Sequence Number associated with the peer UP function. However due to roll-over of the Load Control Sequence Number or restart of the node, the Load Control Sequence Number may be reset to an appropriate base value by the peer UP function, hence the receiving entity shall be prepared to receive (and process) a Load Control Sequence Number parameter whose value is less than the previous value. + +#### 6.2.3.3.2.2 Load Metric + +The Load Metric parameter shall indicate the current load level of the originating node. The computation of the Load Metric is left to implementation. The node may consider various aspects, such as the used capacity of the UP function, the load in the node (e.g. memory/CPU usage in relationship to the total memory/CPU available, etc.). + +The Load Metric represents the current load level of the sending node as a percentage within the range of 0 to 100, where 0 means no or 0% load and 100 means maximum or 100% load reached (i.e. no further load is desirable). + +The Load Metric shall be supported (if load control is supported). The Load Metric shall always be included in the Load Control Information. + +Considering the processing requirement of the receiver of the Load Control Information (e.g. handling of the new information, tuning the node selection algorithm to take the new information into account), the sender should refrain from advertising every small variation (e.g. with the granularity of 1 or 2), in the Load Metric which does not result in useful improvement in node selection logic at the receiver. During the typical operating condition of the sender, a larger variation in the Load Metric, e.g. 5 or more units, should be considered as reasonable enough for advertising the new Load Control Information and thus justifying the processing requirement (to handle the new information) of the receiver. + +NOTE: The range of the Load Metric, i.e. 0 to 100, does not mandate the sender to collect its own load information at every increment/decrement and hence to advertise the change of Load Metric with a granularity of 1%. Based on various implementation specific criteria, such as: the architecture, session and signalling capacity, the current load and so on, the sender is free to define its own logic and periodicity with which its own load information is collected. + +#### 6.2.3.3.3 Frequency of Inclusion + +How often the sender includes the load control information is implementation specific. The sender shall ensure that new/updated load control information is propagated to the target CP functions within an acceptable delay, such that the purpose of the information (i.e. effective load balancing) is achieved. The sender may include the LCI IE e.g. as follows: + +- the sender may include Load Control Information towards a peer only when the new/changed value has not already been provided to that peer; +- the sender may include the Load Control Information in each and every message (extended with LCI IE) towards the peer; + +- the sender may include Load Control Information periodically, i.e. include the information during a first period then cease to do so during a second period. + +The sender may also implement a combination of one or more of the above approaches. Besides, the sender may also decide to include the Load Control Information only in a subset of the applicable PFCP messages. + +The receiver shall be prepared to receive the load control information in any of the PFCP messages extended with an LCI IE and upon such reception, shall be able act upon the received load control information. + +## 6.2.4 Overload Control Procedure + +### 6.2.4.1 General + +Overload Control is a node level procedure. + +Overload Control is an optional feature defined over the Sxa, Sxb, Sxc and N4 reference points. + +Overload control enables a UP function becoming or being overloaded to gracefully reduce its incoming signalling load by instructing its peer CP functions to reduce sending traffic according to its available signalling capacity to successfully process the traffic. A UP function is in overload when it operates over its signalling capacity which results in diminished performance (including impacts to handling of incoming and outgoing traffic). + +Overload control aims at shedding the incoming traffic as close to the traffic source as possible generally when an overload has occurred (reactive action), so to avoid spreading the problem inside the network and to avoid using resources of intermediate nodes in the network for signalling that would anyhow be discarded by the overloaded node. + +Load control and overload control may be supported and activated independently in the network, based on operator's policy. + +### 6.2.4.2 Principles + +When a UP function determines that the offered incoming signalling traffic is growing (or is about to grow) beyond its nominal capacity, the UP function may signal its overload, at node level granularity, to its peer CP functions by including Overload Control Information in PFCP signalling which provides guidance to the receiving CP functions to decide actions which lead to signalling traffic mitigation towards the sender of the information. This helps in preventing severe overload and hence potential breakdown of the UP function. + +The Overload Control Information is piggybacked in PFCP request or response messages such that the exchange of Overload Control Information does not trigger extra signalling. + +NOTE: The inclusion of Overload Control Information in existing messages means that the frequency of transmission of overload control information increases as the signalling load increases, thus allowing for faster feedback and better regulation. + +The calculation of the Overload Control Information is implementation dependent and its calculation and transfer shall not add significant additional load to the node itself and to its corresponding peer nodes. The calculation of Overload Control Information should not severely impact the resource utilization of the UP function, especially considering the overload situation. + +The overload control feature should continue to allow for preferential treatment of priority users (eMPS) and emergency services. + +The overload mitigation actions based on the reception of the overload related information received from the UP function will not be standardized. + +### 6.2.4.3 Overload Control Information + +#### 6.2.4.3.1 General Description + +A PFCP message may contain one instance of the Overload Control Information (OCI) IE. + +When providing overload control information in a message for the first time or subsequently, the UP function shall always include the full set of overload control information, i.e. all the node level instance of the Overload Control Information, even if only a subset of the overload control information has changed. The Overload Control Sequence Number shall be incremented whenever the Overload control information is changed (see clause 6.2.4.3.2.1). + +The receiver shall overwrite any stored overload control information of a peer with the newly received overload control information from the same peer node if the new overload control information is more recent than the old information as indicated by the Overload Control Sequence Number, e.g. if the receiver has stored an instance of the Overload control information for a peer node, it overwrites this instance with the new instance received in a message from the same peer node. + +The receiver shall consider all the parameters received in the same instance of the OCI IE in conjunction while applying the overload mitigation action. + +The parameters are further defined in clause 6.2.4.3.2. + +Overload control information may be extended with new parameters in future versions of the specification. Any new parameter will have to be categorized as: + +- Non-critical optional parameters: the support of these parameters is *not critical* for the receiver. The receiver can successfully and correctly comprehend the Overload control information instance, containing one or more of these parameters, by using the other parameters and ignoring the non-critical optional parameter. +- Critical optional parameters: the support of these parameters is *critical* for the receiver to correctly comprehend the instance of the Overload control information containing one or more of these parameters. + +The sender may include one or more non-critical optional parameters within any instance of the OCI IE without having the knowledge of the receiver's capability to support the same. However, the sender shall only include one or more critical optional parameter in an instance of the OCI IE towards a receiver if the corresponding receiver is known to support those parameters. The sender may be aware of this either via signalling methods or by configuration (this will have to be defined when introducing any such new parameter in future). + +The Overload Control Information shall be associated by default to the PFCP entity corresponding to the peer node's IP address of the PFCP session, over which the OCI IE is received, i.e. to the IP address received within the "UP F-SEID" IE. + +Alternatively, the UP function may send Overload Control Information which is associated with the Node ID of the UP function (i.e. FQDN or the IP address used during the UP function selection). In that case, the UP function shall provide an explicit indication that the OCI IE included in the message belongs to the Node ID. + +### 6.2.4.3.2 Parameters + +#### 6.2.4.3.2.1 Overload Control Sequence Number + +The PFCP protocol requires retransmitted messages to have the same contents as the original message. Due to PFCP retransmissions, the overload control information received by a CP function at a given time may be less recent than the overload control information already received from the same UP function. The Overload Control Sequence Number aids in sequencing the overload control information received from an overloaded UP function. The Overload Control Sequence Number contains a value that indicates the sequence number associated with the Overload Control Information IE. This sequence number shall be used to differentiate between two OCI IEs generated at two different instants, by the same UP function. + +The Overload Control Sequence Number parameter shall be supported (when supporting the overload control feature) and shall always be present in the Overload Control Information IE. + +The UP function generating this information shall increment the Overload Control Sequence Number whenever modifying some information in the OCI IE. The Overload Control Sequence Number shall not be incremented otherwise. The UP function may use the time, represented in an unsigned integer format, of the generation of the overload control information, to populate the Overload Control Sequence Number. + +This parameter shall be used by the receiver of the OCI IE to properly collate out-of-order OCI IEs, e.g. due to PFCP retransmissions. This parameter shall also be used by the receiver of the OCI IE to determine whether the newly received overload control information has changed compared to the overload control information previously received from the same UP function. If the newly received overload control information has the same Overload Control + +Sequence Number as the previously received overload control information from the same UP function, then the receiver may simply discard the newly received overload control information whilst continuing to apply the overload abatement procedures, as per the previous value. + +NOTE 1: The timer corresponding to the Period of Validity (see clause 6.2.4.3.2.2) is not restarted if the newly received overload control information has the same Overload Control Sequence Number as the previously received overload control information. If the overload condition persists and the overloaded UP function needs to extend the duration during which the overload information applies, the sender needs to provide a new overload control information with an incremented Overload Control Sequence Number (even if the parameters within the overload control information have not changed). + +NOTE 2: The PFCP Sequence Number cannot be used for collating out-of-order overload information as e.g. overload control information may be sent in both PFCP requests and responses, using independent PFCP sequence numbering. + +If the receiving CP function already received and stored overload control information, which is still valid, from the overloaded UP function, the receiving entity shall update its overload control information, only if the Overload-Sequence-Number received in the new overload control information is larger than the value of the Overload Control Sequence Number associated with the stored information. However due to roll-over of the Overload Control Sequence Number or restart of the UP function, the Overload Control Sequence Number may be reset to an appropriate base value by the peer UP function, hence the receiving entity shall be prepared to receive (and process) an Overload Control Sequence Number parameter whose value is less than the previous value. + +#### 6.2.4.3.2.2 Period of Validity + +The Period of Validity indicates the length of time during which the overload condition specified by the OCI IE is to be considered as valid (unless overridden by subsequent new overload control information). + +An overload condition shall be considered as valid from the time the OCI IE is received until the period of validity expires or until another OCI IE with a new set of information (identified using the Overload Control Sequence Number) is received from the same UP function (at which point the newly received overload control information shall prevail). The timer corresponding to the period of validity shall be restarted each time an OCI IE with a new set of information (identified using the Overload Control Sequence Number) is received. When this timer expires, the last received overload control information shall be considered outdated and obsolete, i.e. any associated overload condition shall be considered to have ceased. + +The Period of Validity parameter shall be supported (when supporting overload control). + +The Period of Validity parameter achieves the following: + +- it avoids the need for the overloaded UP function to include the Overload Control Information IE in every PFCP messages it signals to its peer CP functions when the overload state does not change; thus it minimizes the processing required at the overloaded UP function and its peer CP functions upon sending/receiving PFCP signalling; +- it allows to reset the overload condition after some time in the peer CP functions having received an overload indication from the overloaded UP function, e.g. if no signalling traffic takes place between these PFCP entities for some time due to overload mitigation actions. This also removes the need for the overloaded UP function to remember the list of CP functions to which it has sent a non-null overload reduction metric and to which it would subsequently need to signal when the overload condition ceases, if the Period of Validity parameter was not defined. + +#### 6.2.4.3.2.3 Overload Reduction Metric + +The Overload Reduction Metric shall have a value in the range of 0 to 100 (inclusive) which indicates the percentage of traffic reduction the sender of the overload control information requests the receiver to apply. An Overload Reduction Metric of "0" always indicates that the UP function is not in overload (that is, no overload abatement procedures need to be applied) for the indicated scope. + +Considering the processing requirement of the receiver of the Overload Control Information, e.g. to perform overload control based on the updated Overload Reduction Metric, the sender should refrain from advertising every small variation, e.g. with the granularity of 1 or 2, in the Overload Reduction Metric which does not result in useful improvement for mitigating the overload situation. During the typical operating condition of the sender, a larger + +variation in the Overload Reduction Metric, e.g. 5 or more units, should be considered as reasonable enough for advertising a new Overload Reduction Metric Information and thus justifying the processing requirement (to handle the new information) of the receiver. + +**NOTE:** The range of Overload Reduction Metric, i.e. 0 to 100, does not mandate the sender to collect its own overload information at every increment/decrement and hence to advertise the change of Overload Reduction Metric with a granularity of 1%. Based on various implementation specific criteria, such as the architecture, session and signalling capacity, the current load/overload situation and so on, the sender is free to define its own logic and periodicity with which its own overload control information is collected. + +The computation of the exact value for this parameter is left as an implementation choice at the sending UP function. + +The Overload Reduction Metric shall be supported (when supporting overload control) and shall always be present in the OCI IE. + +The inclusion of the OCI IE signals an overload situation is occurring, unless the Overload Reduction Metric is set to "0", which signals that the overload condition has ceased. Conversely, the absence of the OCI IE in a message does not mean that the overload has abated. + +#### 6.2.4.3.3 Frequency of Inclusion + +How often or when the sender includes the overload control information is implementation specific. The sender shall ensure that new/updated overload control information is propagated to the target receivers with an acceptable delay, such that the purpose of the information, (i.e. the effective overload control protection) is achieved. The following are some of the potential approaches the sender may implement for including the OCI IE: + +- the sender may include OCI IE towards a receiver only when the new/changed value has not already been provided to the given receiver; +- the sender may include the OCI IE in a subset of the messages towards the receiver; +- the sender may include the OCI IE periodically, i.e. include the information during a first period then cease to do so during a second period. + +The sender may also implement a combination of one or more of the above approaches. Besides, the sender may also include the OCI IE only in a subset of the applicable PFCP messages. + +The receiver shall be prepared to receive the overload control information received in any of the PFCP messages extended with an OCI IE and upon such reception, shall be able act upon the received information. + +#### 6.2.4.4 Message Throttling + +##### 6.2.4.4.1 General + +As part of the overload mitigation, a CP function shall reduce the total number of messages, which would have been sent otherwise, towards the overloaded peer based on the information received within the Overload Control Information. This shall be achieved by discarding a fraction of the messages in proportion to the overload level of the target peer. This is called "message throttling". + +Message throttling shall only apply to Request messages. Response messages should not be throttled since that would result in the retransmission of the corresponding request message by the sender. + +A CP function supporting PFCP overload control shall support and use the "Loss" algorithm as specified in this clause, for message throttling. + +##### 6.2.4.4.2 Throttling algorithm – "Loss" + +###### 6.2.4.4.2.1 Description + +An overloaded UP function shall ask its peers to reduce the number of requests they would ordinarily send by signalling Overload Control Information including the requested traffic reduction, as a percentage, within the "Overload-Reduction-Metric", as specified in clause 6.2.4.3.2. + +The recipients of the "Overload-Reduction-Metric" shall reduce the number of requests sent by that percentage, either by redirecting them to an alternate destination if possible (e.g. the PFCP Session Establishment Request message may be redirected to an alternate UP function), or by failing the request and treating it as if it was rejected by the destination UP function. + +For example, if a sender requests another peer to reduce the traffic it is sending by 10%, then that peer shall throttle 10% of the traffic that would have otherwise been sent to this UP function. + +The overloaded UP function should periodically adjust the requested traffic reduction based e.g. on the traffic reduction factor that is currently in use, the current system utilization (i.e. the overload level) and the desired system utilization (i.e. the target load level), and/or the rate of the current overall received traffic. + +Annex A.1 provides an (informative) example of a possible implementation of the "Loss" algorithm, amongst other possible methods. + +NOTE 1: This algorithm does not guarantee that the future traffic towards the overloaded UP function will be less than the past traffic but it ensures that the total traffic sent towards the overloaded UP function is less than what would have been sent without any throttling in place. If after requesting a certain reduction in traffic, the overloaded UP function receives more traffic than in the past, whilst still in overload, leading to the worsening rather than an improvement in the overload level, then the overloaded UP function can request for more reduction in traffic. Thus, by periodically adjusting the requested traffic reduction, the overloaded node can ensure that it receives, approximately, the amount of traffic which it can handle. + +NOTE 2: Since the reduction is requested as a percentage, and not as an absolute amount, this algorithm achieves a good useful throughput towards the overloaded node when the traffic conditions vary at the source nodes (depending upon the events generated towards these source nodes by other entities in the network), as a potential increase of traffic from some source nodes can possibly be compensated by a potential decrease of traffic from other source nodes. + +#### 6.2.4.5 Message Prioritization + +##### 6.2.4.5.1 Description + +When performing message throttling: + +- PFCP requests related to priority traffic (i.e. eMPS as described in 3GPP TS 22.153 [15]) and emergency have the highest priority. Depending on regional/national requirements and network operator policy, these PFCP requests shall be the last to be throttled, when applying traffic reduction, and the priority traffic shall be exempted from throttling due to PFCP overload control up to the point where the requested traffic reduction cannot be achieved without throttling the priority traffic; +- for other types of sessions, messages throttling should consider the relative priority of the messages so that the messages which are considered as low priority are considered for throttling before the other messages. The relative priority of the messages may be derived from the relative priority of the procedure for which the message is being sent or may be derived from the session parameters such as APN, QCI, ARP and/or Low Access Priority Indicator (LAPI). + +NOTE: A random throttling mechanism, i.e. discarding the messages without any special consideration, could result in an overall poor congestion mitigation mechanism and bad user experience. + +An overloaded node may also apply these message prioritization schemes when handling incoming initial messages during an overloaded condition, as part of a self-protection mechanism. + +##### 6.2.4.5.2 Based on the Message Priority Signalled in the PFCP Message + +Message prioritization may be performed by an overloaded node, when handling incoming messages during an overloaded condition, based on the relative PFCP message priority signalled in the PFCP header (see clause 7.2.2.3). + +A PFCP entity shall determine whether to set and use the message priority in PFCP signalling, based on operator policy. The requirements specified in this clause shall apply if message priority in PFCP signalling is used. + +A sending PFCP entity shall determine the relative message priority to signal in the message according to the principles specified in clause 6.2.4.5.1. If the message affects multiple bearers, the relative message priority should be determined considering the highest priority ARP among all the bearers. + +A PFCP entity should set the same message priority in a Response message as received in the corresponding Request message. + +For incoming PFCP messages that do not have a message priority in the PFCP header, the receiving PFCP entity: + +- shall apply a default priority, if the incoming message is a Request message; +- should apply the message priority sent in the Request message, if the incoming message is a Response message. + +This feature should be supported homogeneously across the CP functions and UP functions in the network, otherwise an overloaded node will process Request messages received from the non-supporting nodes according to the default priority while Request messages received from supporting nodes will be processed according to the message priority signalled in the PFCP message. + +## 6.2.5 PFCP PFD Management Procedure + +### 6.2.5.1 General + +PFCP PFD Management is a node level procedure. + +The PFCP PFD Management procedure may be used by the CP function and UP function to provision PFDs (e.g. received from the PFDF as specified in clauses 5.11.4 and 6.5.2 of 3GPP TS 23.214 [2]) to the UP function, for one or more Application Identifiers. + +Support of this procedure is optional for the CP function and the UP function. The UP function shall set the PFDM feature flag in the UP Function Features IE if it supports the PFD Management procedure (see clause 8.2.25). + +The UP function shall store the PFDs provisioned per Application Identifier. These PFDs shall apply to all the PFCP session established in the UP function, for all the controlling CP functions, i.e. the scope of a PFD is not limited to the PFCP sessions established by the CP function which provisioned the PFD. + +NOTE: Application identifiers preconfigured in the UP function, if any, need to be distinct from application identifiers provisioned via PFD management procedure. + +### 6.2.5.2 CP Function Behaviour + +The CP function initiates the PFCP PFD Management procedure to provision PFDs in the UP function, for one or more Application Identifier(s). + +The CP function: + +- shall send the PFCP PFD Management Request message, including the full set of PFD IDs and PFD contents to be provisioned in the UP function per Application Identifier. + +When the CP function receives a PFCP PFD Management Response with cause success, the CP function shall consider that the PFDs have been provisioned as requested. + +### 6.2.5.3 UP Function Behaviour + +When the UP function receives a PFCP PFD Management Request message, it shall: + +- if no Application ID's PFDs IE is present in the request (i.e. empty message): + - delete all the PFDs received and stored earlier for all Application Identifier(s) provisioned via the PFD Management Procedure; +- if at least one Application ID's PFDs IE is present in the request: + - delete all the PFDs received and stored earlier for the indicated Application Identifier(s); + - store all the PFDs received in the request for the indicated Application Identifier(s); + +- send a PFCP PFD Management Response with the cause "success", if the above operations were performed successfully; +- if a PFD is removed/modified and this PFD was used to detect application traffic related to an application identifier in a PDR created/activated for a PFCP session and the UP function has reported the application start to the CP function for the application or the application instance corresponding to this PFD as defined in clause 5.4.11 ((Un)solicited Application Reporting), the UP function shall report the application stop to the CP function for the corresponding application or the corresponding application instance identifier as defined in clause 5.4.11 if the removed/modified PFD in UP results in the stop of the application or the application instance is not being able to be detected. See clause 5.11.4 of 3GPP TS 23.214 [2]. + +NOTE: Multiple PFDs can be associated with the application identifier. When the removed/modified PFD is the last one which is used to detect traffic identified by application id, the UPF reports application stop. + +## 6.2.6 PFCP Association Setup Procedure + +### 6.2.6.1 General + +PFCP Association Setup is a node level procedure. + +The PFCP Association Setup procedure shall be used to setup a PFCP association between a CP function and a UP function, to enable the CP function to use the resources of the UP function subsequently, i.e. establish PFCP Sessions. + +The setup of a PFCP association may be initiated by the CP function (see clause 6.2.6.2) or the UP function (see clause 6.2.6.3). + +The CP function and the UP function shall support the PFCP Association Setup initiated by the CP function. The CP function and the UP function may additionally support the PFCP Association Setup initiated by the UP function. + +### 6.2.6.2 PFCP Association Setup Initiated by the CP Function + +#### 6.2.6.2.1 CP Function Behaviour + +The CP function shall initiate the PFCP Association Setup procedure to request to setup a PFCP association towards a UP function prior to establishing a first PFCP session on this UP function. + +The CP function shall retrieve an IP address of the UP function to send the PFCP Association Setup Request, as specified in clause 5.8.1, and shall send a PFCP Association Setup Request to the UP function with: + +- the Node ID of the CP function; +- the list of optional features the CP function supports which may affect the UP function behaviour, if any; +- optionally, the PFCP Session Retention Information IE (see figure 7.4.4.1-2) to request the UP function to retain all or part of the existing PFCP sessions if a PFCP association already exists in the UP function for the same Node ID. + +The CP function shall only initiate PFCP Session related signalling procedures toward a UP function after it receives the PFCP Association Setup Response with a successful cause from this UP function. + +The CP function shall determine whether the UP function supports Sxa, Sxb, Sxc and/or combined Sxa/Sxb by local configuration or optionally via DNS if deployed. + +#### 6.2.6.2.2 UP Function behaviour + +When receiving a PFCP Association Setup Request, the UP function: + +- if the request is accepted: + - shall store the Node ID of the CP function as the identifier of the PFCP association; + - shall send a PFCP Association Setup Response including: + - a successful cause; + +- its Node ID; +- information of all supported optional features in the UP function; +- optionally one or more UE IP address Pool Information IE which contains a list of UE IP Address Pool Identities per Network Instance, S-NSSAI and IP version; +- optionally the NF Instance ID of the UPF if available. + - shall send a PFCP Version Not Supported Response if the PFCP header of the request indicates a PFCP protocol version that is not supported by the UP function; +- otherwise, shall send a PFCP Association Setup Response with an appropriate error cause if the request is rejected. + +If the PFCP Association Setup Request contains a Node ID for which a PFCP association was already established, the UP function shall: + +- proceed with establishing the new PFCP association (regardless of the Recovery Timestamp received in the request), overwriting the existing association; +- retain the PFCP sessions that were established with the existing PFCP association and that are requested to be retained, if the PFCP Session Retention Information IE was received in the request; otherwise, delete the PFCP sessions that were established with the existing PFCP association; +- set the PSREI (PFCP Session Retained Indication) flag to "1" in the PFCP Association Setup Response, if the PFCP Session Retention Information IE was received in the Request and the requested PFCP sessions have been retained. + +If the UPF is configured to be used for IPUPS, the UPF shall set the UUPSI (UPF configured for IPUPS Indication) flag to "1" in the PFCP Association Setup Response message. + +### 6.2.6.3 PFCP Association Setup Initiated by the UP Function + +#### 6.2.6.3.1 UP Function Behaviour + +The UP function initiates the PFCP Association Setup procedure to request to setup a PFCP association towards a CP function. The UP function is configured with a set of CP functions to which it shall establish a PFCP association. + +The UP function: + +- shall retrieve an IP address of the CP function, e.g. based on local configuration in the UP function; +- shall send the PFCP Association Setup Request including: + - the Node ID of the UP function; + - information of all supported optional features in the UP function; + - optionally one or more UE IP address Pool Information IE which contains a list of UE IP Address Pool Identities per a given Network Instance, S-NSSAI and IP version; + - optionally the NF Instance ID of the UPF if available. + - the UUPSI (UPF configured for IPUPS Indication) flag set to "1" if the UPF is configured to be used for IPUPS. + +#### 6.2.6.3.2 CP Function Behaviour + +When receiving a PFCP Association Setup Request, the CP function: + +- if the request is accepted: + - shall store the Node ID of the UP function as the identifier of the PFCP association; + - shall send a PFCP Association Setup Response with a successful cause, its Node ID, and information of the list of optional features the CP function supports which may affect the UP function behaviour, if any; +- shall send a PFCP Version Not Supported Response if the PFCP header of the request indicates a PFCP protocol version that is not supported by the CP function; + +- otherwise, shall send a PFCP Association Setup Response with an appropriate error cause if the request is rejected. + +The CP function shall only initiate PFCP Session related signalling procedures toward a UP function after it has sent the PFCP Association Setup Response with a successful cause to the UP function. + +The CP function shall determine the UP function supports Sxa, Sxb, Sxc and/or combined Sxa/Sxb by local configuration or optionally via DNS if deployed. + +## 6.2.7 PFCP Association Update Procedure + +### 6.2.7.1 General + +PFCP Association Update is a node level procedure. + +The PFCP Association Update procedure shall be used to modify an existing PFCP association between the CP function and the UP function. It may be initiated by the UP function or by the CP function to update the supported features or available resources of the UP function. + +### 6.2.7.2 PFCP Association Update Procedure Initiated by the CP Function + +#### 6.2.7.2.1 CP Function Behaviour + +The CP function initiates the PFCP Association Update procedure to report changes to the PFCP association to the UP function, e.g. to update the supported features. + +When both the CP function and UP function support the EPFAR feature, the CP function may send a PFCP Association Update Request with the "PFCP Association Release Preparation Start" flag set to "1" when the CP function decides to release the PFCP association and request the UP function to report all non-zero usage reports for the PFCP session affected by the release of the PFCP association, as specified in clause 5.18. + +#### 6.2.7.2.2 UP Function Behaviour + +When receiving a PFCP Association Update Request, the UP function: + +- shall update the list of optional features of the CP function, when received; +- shall send a PFCP Association Update Response with an appropriate error cause if the Node ID is not known by the UP Function; +- shall return a PFCP Association Update Response with a successful cause value, if the PFCP Association Update Request is handled successfully. + +When both the CP function and UP function support the EPFAR feature, and the CP function has set the "PFCP Association Release Preparation" set to "1" in the PFCP Association Update Request message, the UP function shall send the PFCP Association Update Response to CP function with successful cause value and then send PFCP Session Report Request messages to report non-zero usage reports (at least one message per PFCP Session) for the PFCP Sessions affected by the release of the PFCP association, as specified in clause 5.18. + +### 6.2.7.3 PFCP Association Update Procedure Initiated by UP Function + +#### 6.2.7.3.1 UP Function Behaviour + +The UP function initiates the PFCP Association Update procedure to report changes to the PFCP association to the CP function, e.g. change of optional features, an indication to request to release the PFCP association, change of the UE IP Address Pool Identifies configured in the UP function. + +The UP function may send a PFCP Association Update Request to request the CP function to perform the release of the PFCP association, optionally providing a Graceful Release Period. + +When the Enhanced PFCP Association Release feature (EPFAR) (see clause 5.18) is supported by both the CP function and UP function, the UP function: + +- may send a PFCP Association Update Request with the flag "PFCP Association Release Preparation" set to "1" when the UP function decides to release the PFCP association and thus inform the CP function that all non-zero usage reports for those PFCP session affected by the release of the PFCP association will be reported; +- shall then send a PFCP Association Update Request, with the URSS flag set to "1" once all non-zero usage reports for all the PFCP Sessions affected by the release of PFCP Association have been sent to the CP function. + +After reception of the PFCP Association Update Response, the UP function shall consider that the PFCP association is still setup until receiving a PFCP Association Release Request. When the UP function requests to release the PFCP Association and sends a PFCP Association Update Request message with a Graceful Release Period or with the URSS flag set, if no PFCP Association Release Request is received before the Graceful Release Period or a configurable timer (when the URSS flag is set) expires, the UP function may locally release the association, behaving as if the PFCP Association Release Request had been received. + +### 6.2.7.3.2 CP Function Behaviour + +When receiving a PFCP Association Update Request, the CP function: + +- shall update the list of optional features of the UP function, when received; +- shall send a PFCP Association Update Response with an appropriate error cause if the Node ID is not known by the CP Function; +- shall return a PFCP Association Update Response with a successful cause value if the PFCP Association Update Request is handled successfully. + +If the UP function has requested to release the PFCP association in the PFCP Association Update Request, the CP function should initiate a PFCP Association Release Request to release the PFCP association, as soon as possible if no Graceful Release Period was included in the request or before the expiry of the Graceful Release Period. The CP function should stop creating new PFCP sessions in the UP function during the Graceful Release Period. When the final usage report(s) for a PFCP Session (upon being deleted) is required, e.g. based on operator policies, the CP function should initiate a PFCP Session Deletion Procedure to collect the usage reports per PFCP Session affected by the release of PFCP Association before the Graceful Release Period is expired. + +When both the CP function and UP function support the EPFAR feature, and if the UP function has set the URSS flag to "1" in the PFCP Association Update Request message, the CP function shall send the PFCP Association Update Response with successful cause value to indicate the PFCP Association Update Request is handled successfully and then immediately initiate the PFCP Association Release Procedure, as specified in clause 5.18. + +If the UP function has included UE IP address Pool Identity IE in the PFCP Association Update Request message, the CP function shall use it to overwrite the UE IP address Pool Identity previously received from the UP function. + +## 6.2.8 PFCP Association Release Procedure + +### 6.2.8.1 General + +PFCP Association Release is a node level procedure. + +The PFCP Association Release procedure shall be used to terminate the PFCP association between the CP Function and the UP Function due to e.g. OAM reasons. The PFCP Association Release Request may be initiated by the CP function. + +When the final usage report(s) for a PFCP Session is required, e.g. based on the operator policies, the CP function should retrieve the final usage reports for the PFCP Sessions affected by the release of PFCP Association, i.e. by initiating a PFCP Session Deletion Procedure towards the UP function for every PFCP session, before it initiates PFCP Association Release Request. + +### 6.2.8.2 CP Function Behaviour + +If the CP function initiates the PFCP Association Release procedure to release an existing PFCP association, the CP function: + +- shall delete locally all the PFCP sessions related to that PFCP association when receiving the PFCP Association Release Response with the cause value success. + +### 6.2.8.3 UP Function behaviour + +When the UP function receives a PFCP Association Release Request, the UP function: + +- shall delete all the PFCP sessions related to that PFCP association locally; +- shall delete the PFCP association and any related information (e.g. Node ID of the CP function); +- shall send a PFCP Association Release Response with a successful cause. + +NOTE: The UP function always accepts a PFCP Association Release Request. + +## 6.2.9 PFCP Node Report Procedure + +### 6.2.9.1 General + +PFCP Node Report Procedure is a node level procedure. + +The PFCP Node Report procedure shall be used by the UP function to report information to the CP function which is not related to a specific PFCP session, e.g. to report a user plane path failure affecting all the PFCP sessions towards a remote GTP-U peer. + +### 6.2.9.2 UP Function Behaviour + +The UP function shall initiate the PFCP Node Report procedure to report information to the CP function. The UP function: + +- shall send the PFCP Node Report Request message, including the information to be reported. + +When the UP function receives a PFCP Node Report Response with the cause success, the UP function shall consider the information successfully delivered to the CP function. + +### 6.2.9.3 CP Function behaviour + +When the CP function receives a PFCP Node Report Request message, it shall: + +- process the information being reported as appropriate and send a PFCP Node Report Response with the cause "success"; +- otherwise return an appropriate error cause value. + +## 6.3 PFCP Session Related Procedures + +### 6.3.1 General + +The following clauses describe the session related procedures over the Sxa, Sxb, Sxc and N4 reference points. The behaviour of the CP function and UP function when sending and receiving session related messages is described. + +## 6.3.2 PFCP Session Establishment Procedure + +### 6.3.2.1 General + +The PFCP Session Establishment procedure shall be used to setup a PFCP session between CP function and UP function and configure Rules in the UP function so that the UP function can handle incoming packets. + +### 6.3.2.2 CP Function Behaviour + +The CP function initiates the PFCP Session Establishment procedure to create a PFCP session for a PDN connection or a PDU session, or IP-CAN session or TDF session or for applying a certain IP packets treatment which is not associated with any PDN connection or TDF session. + +The CP function: + +- shall send the PFCP Session Establishment Request message with a new PFCP F-SEID together with Rules to be created; +- may include its current Recovery Time Stamp as specified in clause 19A of TS 3GPP TS 23.007 [24]. + +When the CP function receives a PFCP Session Establishment Response with the cause "Request accepted (success)", the CP function shall continue with the procedure which triggered the PFCP Session Establishment procedure. If the CP function indicated support of the PSUCC feature (see clause 8.2.58) during the PFCP association setup or update procedure, and if the cause in the response indicates "Request partially accepted", the CP function shall behave as specified in clause 5.2.9. + +### 6.3.2.3 UP Function Behaviour + +When the UP function receives a PFCP Session Establishment Request message: + +- the UP function shall store and apply the rules received in the request and send a PFCP Session Establishment Response with cause "success", if all rules in the PFCP Session Establishment Request are stored and applied; +- Otherwise, if at least one rule failed to be stored or applied: + - the UP function shall return an appropriate error cause value with the Rule ID of the Rule causing the first error, discard all the received rules and not create any PFCP session context, if the CP function or the UP function does not support the PSUCC feature (see clause 5.2.9); or + - alternatively, if the CP function indicated support of the PSUCC feature (see clause 8.2.58) during the PFCP association setup or update procedure, and if this feature is also supported by the UP function, the UP function should accept the request partially, if possible, and return a response indicating a partial acceptance of the request as specified in clause 5.2.9. + +## 6.3.3 PFCP Session Modification Procedure + +### 6.3.3.1 General + +The PFCP Session Modification procedure shall be used to modify an existing PFCP session, e.g. to configure a new rule, to modify an existing rule, to delete an existing rule. + +### 6.3.3.2 CP Function behaviour + +The CP function initiates the PFCP Session Modification procedure to modify an existing PFCP session, e.g. triggered by a modification of PDN connection, PDU session, IP CAN session or TDF session. + +The CP function shall: + +- include a complete PDI if the PDI in the existing PDR is to be updated; +- remove locally the reference to a rule in the PDRs when the related Rule is deleted; + +- provide all the new, updated or deleted Rules. The Updated Rules shall contain only the information which are changed, added and/or deleted. + +The CP function shall not include multiple updates in a PFCP Modification Request message, e.g. Create PDR, Update PDR and Remove PDR, for the same rule identified by the Rule ID. + +When the CP function receives a PFCP Session Modification Response with the cause "Request accepted (success)", it shall continue with the procedure which has initiated the PFCP Session Modification procedure. If the CP function indicated support of the PSUCC feature (see clause 8.2.58) during the PFCP association setup or update procedure, and if the cause in the response indicates "Request partially accepted", the CP function shall behave as specified in clause 5.2.9. + +### 6.3.3.3 UP Function Behaviour + +When the UP function receives a PFCP Session Modification Request it shall: + +- send the PFCP Session Modification Response message with a rejection cause value set to "Session context not found" if the F-SEID included in the PFCP Session Modification Request message is unknown; +- reject a modification request which would relate to a rule not existing in the UP function; +- discard any updates on the PFCP session context included in the PFCP Session Modification Request message if the request is rejected and send a PFCP Session Modification Response with an appropriate error cause together with additional information e.g. indicating the first Rule ID of the Rule causing the error. In this case, the UP function shall continue with the existing PFCP session context for the PFCP session as if the PFCP Session Modification Request had not been received; +- remove all rules identified by a Rule ID to be removed and remove the Rule ID from the PDR(s) from where they are referenced; +- send the PFCP Session Modification Response with the cause "Request accepted (success)", if all the requested modifications are accepted and performed successfully; +- send the PFCP Session Modification Response with the cause "Request partially accepted", if the CP function indicated support of the PSUCC feature (see clause 8.2.58) during the PFCP association setup or update procedure, if this feature is also supported by the UP function, and if the UP function could accept the request partially as specified in clause 5.2.9. + +## 6.3.4 PFCP Session Deletion Procedure + +### 6.3.4.1 General + +The PFCP Session Deletion procedure shall be used to delete an existing PFCP session between the CP function and the UP function. + +### 6.3.4.2 CP Function Behaviour + +The CP function initiates a PFCP Session Deletion procedure towards the UP function to delete an existing PFCP session e.g. when the corresponding PDN connection or PDU session is deleted. + +The CP shall: + +- send a PFCP Session Deletion Request with the F-SEID identifying the PFCP session. + +When the CP function receives PFCP Session Deletion Response with cause success, the CP function shall continue with the procedure which triggers the PFCP Session Deletion procedure. + +### 6.3.4.3 UP Function Behaviour + +When the UP function receives a PFCP Session Deletion Request it shall: + +- send the PFCP Session Deletion Response message with a rejection cause set to "Session context not found" if the F-SEID included in the PFCP Session Deletion Request message is unknown; +- send the PFCP Session Deletion Response message with an acceptance cause if the PFCP session and associated rules are deleted successfully, and include any pending Usage Report(s) in the message. + +## 6.3.5 PFCP Session Report Procedure + +### 6.3.5.1 General + +The PFCP Session Report procedure shall be used by the UP function to report information related to the PFCP session to the CP function. + +### 6.3.5.2 UP Function Behaviour + +The UP function shall initiate the PFCP Session Report procedure to report information related to a PFCP session to the CP function. The UP function: + +- shall send the PFCP Session Report Request message, identifying the PFCP session for which the report is sent and including the information to be reported. + +If the Enhanced PFCP Association Release feature (EPFAR) is supported by both the CP function and UP function, the UP function may send a PFCP Session Report Request message with the flag PSDBU being set to "1" to the CP function to report that the PFCP session is being deleted in the UP function, as specified in clause 5.18, e.g. to report remaining non-zero usage reports for all URRs in the PFCP Session before the PFCP Session is locally deleted in the UP function during an Enhanced PFCP Association Release procedure. + +When the UP function receives a PFCP Session Report Response with the cause success, the UP function shall consider the information to be successfully delivered to the CP function. + +### 6.3.5.3 CP Function Behaviour + +When the CP function receives a PFCP Session Report Request message, it shall: + +- send the PFCP Session Report Response message with a rejection cause set to "Session context not found" if the F-SEID included in the PFCP Session Report Request message is unknown; +- process the information being reported as appropriate and send a PFCP Session Report Response with the cause "success"; +- otherwise return an appropriate error cause value. + +If the Enhanced PFCP Association Release feature (EPFAR) is supported by both the CP function and UP function, the CP function shall consider that a PFCP Session is locally deleted in the UP function upon receiving a PFCP Session Report Request message from the UP function with the flag PSDBU being set to "1". + +## 6.4 Reliable Delivery of PFCP Messages + +Reliable delivery of PFCP messages is accomplished by retransmission of these messages as specified in this clause. + +A PFCP entity shall maintain, for each triplet of local IP address, local UDP port and remote peer's IP address, a sending queue with Request messages to be sent to that peer. Each message shall be sent with a Sequence Number and be held until a corresponding Response is received or until the PFCP entity ceases retransmission of that message. The Sequence Number shall be unique for each outstanding Request message sourced from the same IP/UDP endpoint. A PFCP entity may have several outstanding Requests waiting for replies. + +When sending a Request message, the sending PFCP entity shall start a timer T1. The sending entity shall consider that the Request message has been lost if a corresponding Response message has not been received before the T1 timer expires. If so, the sending entity shall retransmit the Request message, if the total number of retry attempts is less than N1 times. The setting of the T1 timer and N1 counter is implementation specific. + +A retransmitted PFCP message shall have the same message content, including the same PFCP header, UDP ports, source and destination IP addresses as the originally transmitted message. + +A Request and its Response message shall have the same Sequence Number value, i.e. the Sequence Number in the PFCP header of the Response message shall be copied from the respective Request message. A Request and its Response messages are matched based on the Sequence Number and the IP address and UDP port. + +Not counting retransmissions, a Request message shall be answered with a single Response message. Duplicated Response messages shall be discarded by the receiver. A received Response message not matching an outstanding Request message waiting for a reply should be discarded. + +The PFCP entity should inform the PFCP application layer when detecting an unsuccessful transfer of a Request message to enable the controlling upper entity to take any appropriate measure. + +## 6.5 PFCP messages bundling + +PFCP messages bundling is an optional procedure that may be supported by the CP function and the UP function. + +PFCP messages bundling may be used if both the CP function and the UP function have indicated support of the corresponding feature (see clauses 8.2.25 and 8.2.58) during the PFCP Association Setup or Update procedure. If so, the following requirements shall apply. + +Several PFCP session related requests and/or responses messages, related to the same PFCP session or to different PFCP sessions handled by the same peer PFCP entity (i.e. with the peer's F-SEID having the same IP address, or with the same peer's IP address for PFCP Session Establishment Requests), may be bundled together in a single UDP/IP packet as specified in clause 7.2.1A, when being sent to that peer PFCP entity. PFCP messages may be bundled towards a PFCP entity of a UP function or of a CP function, independently. + +NOTE 1: If the CP function bundles few PFCP session related requests in one UDP/IP packet it sends to a UP function, the UP function can return responses in separate UDP/IP packets or it can bundle some of the responses together with other PFCP session related messages. + +NOTE 2: Bundling PFCP messages in a single UDP/IP packet enable to enhance performance and scalability (reduced CPU and memory cost thanks to reducing the number of packets to be packetized, exchanged and processed over N4). + +PFCP session related messages handled by different peer PFCP entities (i.e. with the peer's F-SEID having different IP addresses) shall not be bundled together. PFCP node related messages shall not be bundled either. + +The procedures specified in the rest of this specification shall apply for each PFCP message that is bundled in a UDP/IP packet, as if the PFCP message was sent in its own individual UDP/IP packet, i.e. PFCP messages bundling shall not incur any change to the PFCP protocol other than what is described in this clause. + +NOTE 3: Each PFCP message bundled in a single UDP/IP packet has its own sequence number. Besides, if a UDP/IP packet carrying bundled PFCP messages is lost, retransmitted PFCP messages do not need to be bundled in the same manner as when sent originally. + +--- + +## 7 Messages and Message Formats + +### 7.1 Transmission Order and Bit Definitions + +PFCP messages shall be transmitted in network octet order starting with octet 1 with the most significant bit sent first. + +The most significant bit of an octet in a PFCP message is bit 8. If a field in a PFCP message spans over several octets, the most significant bit is bit 8 of the octet with the lowest number, unless specified otherwise. + +## 7.2 Message Format + +### 7.2.1 General + +The format of a PFCP message is depicted in Figure 7.2.1-1. + +![](15d5c901284409186049549eec95c4a4_img.jpg) + +| Octets | Bits | | | | | | | | +|----------|-------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to m | PFCP message header | | | | | | | | +| m+1 to n | Zero or more Information Element(s) | | | | | | | | + +**Figure 7.2.1-1: PFCP Message Format** + +A PFCP message shall contain the PFCP message header and may contain subsequent information element(s) dependent on the type of message. + +### 7.2.1A PFCP messages bundled in one UDP/IP packet + +When applying PFCP messages bundling (see clause 6.5), PFCP messages shall be bundled in one UDP/IP packet as depicted in Figure 7.2.1A-1. + +![](d21ff621d2cff0d2b4b5a97009b23eb3_img.jpg) + +| Octets | Bits | | | | | | | | +|----------|-------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to m | PFCP message 1 header | | | | | | | | +| m+1 to n | Zero or more Information Element(s) | | | | | | | | +| n+1 to p | PFCP message 2 header | | | | | | | | +| p+1 to q | Zero or more Information Element(s) | | | | | | | | +| ... | ... | | | | | | | | +| ... | ... | | | | | | | | +| r to s | PFCP message N header | | | | | | | | +| s+1 to u | Zero or more Information Element(s) | | | | | | | | + +**Figure 7.2.1A-1: PFCP messages bundled in one UDP/IP packet** + +Each bundled PFCP message shall contain its PFCP message header and may contain subsequent information element(s) dependent on the type of message. + +The FO" (Follow On) flag in the PFCP message header of each PFCP message bundled in the UDP/IP packet, except the last PFCP message, shall be set to "1" to indicate that another PFCP message follows in the UDP/IP packet. See clause 7.2.2. + +## 7.2.2 Message Header + +### 7.2.2.1 General Format + +PFCP messages use a variable length header. The message header length shall be a multiple of 4 octets. Figure 7.2.2.1-1 illustrates the format of the PFCP Header. + +| Octets | Bits | | | | | | | | +|----------------|-------------------------------------------------------------------------------------------------------------------|---|-------|-------|----|----|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Version | | Spare | Spare | FO | MP | S | | +| 2 | Message Type | | | | | | | | +| 3 | Message Length (1 st Octet) | | | | | | | | +| 4 | Message Length (2 nd Octet) | | | | | | | | +| m to
k(m+7) | If S flag is set to "1", then SEID shall be placed into octets 5-12. Otherwise, SEID field is not present at all. | | | | | | | | +| n to (n+2) | Sequence Number | | | | | | | | +| (n+3) | Spare | | | | | | | | + +Figure 7.2.2.1-1: General format of PFCP Header + +Where: + +- if S = 0, SEID field is not present, k = 0, m = 0 and n = 5; +- if S = 1, SEID field is present, k = 1, m = 5 and n = 13. + +The usage of the PFCP header is defined in clause 7.2.2.4. + +Octet 1 bits shall be encoded as follows: + +- Bit 1 represents the SEID flag (T). +- Bit 2 represents the "MP" flag (see clause 7.2.2.4.1). +- Bit 3 represents the "FO" flag (see clause 7.2.2.4.1). +- Bit 4 to 5 are spare, the sender shall set them to "0" and the receiving entity shall ignore them. +- Bits 6-8 represent the Version field. + +## 7.2.2.2 PFCP Header for Node Related Messages + +The PFCP message header for the node related messages shall not contain the SEID field, but shall contain the Sequence Number field, followed by one spare octet as depicted in figure 7.2.2.2-1. The spare bits shall be set to zero by the sender and ignored by the receiver. For the Version Not Supported Response message, the Sequence Number may be set to any number and shall be ignored by the receiver. + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------------|---|-------|-------|------|------|-----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Version | | Spare | Spare | FO=0 | MP=0 | S=0 | | +| 2 | Message Type | | | | | | | | +| 3 | Message Length (1 st Octet) | | | | | | | | +| 4 | Message Length (2 nd Octet) | | | | | | | | +| 5 | Sequence Number (1 st Octet) | | | | | | | | +| 6 | Sequence Number (2 nd Octet) | | | | | | | | +| 7 | Sequence Number (3 rd Octet) | | | | | | | | +| 8 | Spare | | | | | | | | + +Figure 7.2.2.2-1: PFCP Message Header for node related messages + +## 7.2.2.3 PFCP Header for Session Related Messages + +The PFCP message header, for session related messages, shall contain the SEID and Sequence Number fields followed by one spare octet. The PFCP header is depicted in figure 7.2.2.3-1. The spare bits shall be set to zero by the sender and ignored by the receiver. + +| Octets | Bits | | | | | | | | | | | | +|--------|-----------------------------------------------------|---|-------|---|-------|----|-----|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Version | | Spare | | FO | MP | S=1 | | | | | | +| 2 | Message Type | | | | | | | | | | | | +| 3 | Message Length (1 st Octet) | | | | | | | | | | | | +| 4 | Message Length (2 nd Octet) | | | | | | | | | | | | +| 5 | Session Endpoint Identifier (1 st Octet) | | | | | | | | | | | | +| 6 | Session Endpoint Identifier (2 nd Octet) | | | | | | | | | | | | +| 7 | Session Endpoint Identifier (3 rd Octet) | | | | | | | | | | | | +| 8 | Session Endpoint Identifier (4 th Octet) | | | | | | | | | | | | +| 9 | Session Endpoint Identifier (5 th Octet) | | | | | | | | | | | | +| 10 | Session Endpoint Identifier (6 th Octet) | | | | | | | | | | | | +| 11 | Session Endpoint Identifier (7 th Octet) | | | | | | | | | | | | +| 12 | Session Endpoint Identifier (8 th Octet) | | | | | | | | | | | | +| 13 | Sequence Number (1 st Octet) | | | | | | | | | | | | +| 14 | Sequence Number (2 nd Octet) | | | | | | | | | | | | +| 15 | Sequence Number (3 rd Octet) | | | | | | | | | | | | +| 16 | Message Priority | | | | Spare | | | | | | | | + +**Figure 7.2.2.3-1: PFCP message Header for session related messages** + +## 7.2.2.4 Usage of the PFCP Header + +### 7.2.2.4.1 General + +The format of the PFCP header is specified in clause 7.2.2. + +The usage of the PFCP header shall be as defined below. + +The first octet of the header shall be used is the following way: + +- Bit 1 represents the "S" flag, which indicates if SEID field is present in the PFCP header or not. If the "S" flag is set to "0", then the SEID field shall not be present in the PFCP header. If the "S" flag is set to "1", then the SEID field shall immediately follow the Length field, in octets 5 to 12. Apart from the node related messages, in all PFCP messages the value of the "S" flag shall be set to "1". +- Bit 2 represents the "MP" flag. If the "MP" flag is set to "1", then bits 8 to 5 of octet 16 shall indicate the relative priority of the PFCP message. It shall be encoded as the binary value of the Message Priority and it may take any value between 0 and 15, where 0 corresponds to the highest priority and 15 the lowest priority. +- Bit 3 represents the "FO" (Follow On) flag. If the "FO" flag is set to "1", then another PFCP message follows in the UDP/IP packet (see clauses 6.5 and 7.2.1A). +- Bit 4 is a spare bit. The sending entity shall set it to "0" and the receiving entity shall ignore it. +- Bit 5 is a spare bit. The sending entity shall set it to "0" and the receiving entity shall ignore it. +- Bits 6 to 8, which represent the PFCP version, shall be set to decimal 1 ("001"). + +The usage of the fields in octets 2 - n of the header shall be as specified below. + +- Octet 2 represents the Message type field, which shall be set to the unique value for each type of control plane message. Message type values are specified in Table 7.3-1 "Message types". +- Octets 3 to 4 represent the Message Length field. This field shall indicate the length of the message in octets excluding the mandatory part of the PFCP header (the first 4 octets). The SEID (if present) and the Sequence Number shall be included in the length count. The format of the Length field of information elements is specified in clause 8.2 "Information Element Format". +- When S=1, Octets 5 to 12 represent the Session Endpoint Identifier (SEID) field. This field shall unambiguously identify a session endpoint in the receiving Packet Forward Control entity. The Session Endpoint Identifier is set by the sending entity in the PFCP header of all control plane messages to the SEID value provided by the + +corresponding receiving entity (CP or UP function). If a peer's SEID is not available the SEID field shall be present in a PFCP header, but its value shall be set to "0", "Conditions for sending SEID=0 in PFCP header". + +NOTE: The SEID in the PFCP header of a message is set to the SEID value provided by the corresponding receiving entity regardless of whether the source IP address of the request message and the IP Destination Address provided by the receiving entity for subsequent request messages are the same or not. + +- Octets 13 to 15 represent PFCP Sequence Number field. + +#### 7.2.2.4.2 Conditions for Sending SEID=0 in PFCP Header + +If a peer's SEID is not available, the SEID field shall still be present in the header and its value shall be set to "0" in the following messages: + +- PFCP Session Establishment Request message on Sxa/Sxb/Sxc/N4; +- If a node receives a message for which it has no session, i.e. if SEID in the PFCP header is not known, it shall respond with "Session context not found" cause in the corresponding response message to the sender, the SEID used in the PFCP header in the response message shall be then set to "0"; +- If a node receives a request message containing protocol error, e.g. Mandatory IE missing, which requires the receiver to reject the message as specified in clause 7.6, it shall reject the request message. For the response message, the node should look up the remote peer's SEID and accordingly set SEID in the PFCP header and the message cause code. As an implementation option, the node may not look up the remote peer's SEID and set the PFCP header SEID to "0" in the response message. However in this case, the cause value shall not be set to "Session not found". +- When the UP function sends PFCP Session Report Request message over N4 towards another SMF or another PFCP entity in the SMF as specified in clause 5.22.2 and clause 5.22.3. + +### 7.2.3 Information Elements + +#### 7.2.3.1 General + +The format of PFCP Information Elements are defined in clause 8.2. + +#### 7.2.3.2 Presence Requirements of Information Elements + +IEs within PFCP messages shall be specified with one of the following presence requirement: + +- Mandatory: this means that: + - the IE shall be included by the sending entity; + - the receiver diagnoses a "Mandatory IE missing" error when detecting that the IE is not present. If a mandatory IE is missing, then the receiver shall abort the procedure. A response including a "Mandatory IE missing" cause, shall include the type of the missing IE. +- Conditional: this means that: + - the IE shall be included by sending entity if the conditions specified are met; + - the receiver shall check the conditions as specified in the corresponding message type description, based on the parameter combination in the message and/or on the state of the receiving node, to infer if a conditional IE shall be expected. Only if a receiver has sufficient information, if a conditional IE, which is necessary for the receiving entity to complete the procedure, is missing, then the receiver shall abort the procedure. A response including a "Conditional IE missing" cause shall include the type of the missing IE. +- Conditional-Optional: this means that: + - the IE shall be included by a sending entity complying with the version of the specification, if the conditions specified in the relevant protocol specification are met. An entity, which is at an earlier version of the protocol and therefore is not up-to-date, cannot send this IE; + +- the receiver need not check the presence of the IE in the message. If the receiver checks the presence of the Conditional-Optional IE, then the IE's absence shall not trigger any of the error handling procedures. The handling of an absence or erroneous such IEs shall be treated as Optional IEs as specified in clause 7.6. +- Optional: this means that: + - the IE shall be included as a service option. Therefore, the IE may be included or not in a message. The handling of an absent optional IE, or an erroneous optional IE is specified in clause 7.6. + +For conditional IEs, the clause describing the PFCP message explicitly defines the conditions under which the inclusion of each IE becomes mandatory or optional for that particular message. These conditions shall be defined so that the presence of a conditional IE only becomes mandatory if it is critical for the receiving entity. The definition might reference other protocol specifications for final terms used as part of the condition. + +For grouped IEs, the presence requirement of the embedded IE shall follow the rules: + +- If the grouped IE is Mandatory within a given message: the presence requirements of individual embedded IEs are as stated within the Mandatory grouped IE for the given message; +- if the grouped IE is Conditional within a given message: if the embedded IE in the grouped IE is Mandatory or Conditional, this embedded IE is viewed as Conditional IE by the receiver. If the embedded IE in the grouped IE is Conditional-Optional, this embedded IE is viewed as Optional IE by the receiver. If the embedded IE in the grouped IE is Optional, this embedded IE is viewed as Optional IE by the receiver; +- if the grouped IE is Conditional-Optional within a given message: if the embedded IE in the grouped IE is Mandatory or Conditional, this embedded IE is viewed as Conditional-Optional IE by the receiver. If the embedded IE in the grouped IE is Conditional-Optional, this embedded IE is viewed as Optional IE by the receiver. If the embedded IE in the grouped IE is Optional, this embedded IE is viewed as Optional IE by the receiver; +- if the grouped IE is Optional within a given message: all embedded IEs in the grouped IE are viewed as Optional IEs by the receiver. + +In all of the above cases, appropriate error handling as described in clause 7.6 shall be applied for protocol errors of the embedded IEs. + +Only the Cause IE at message level shall be included in the response if the Cause contains a value that indicates that the request is not accepted, regardless of whether there are other mandatory or conditional IEs defined for a given response message. The following are exceptions: + +- the Node ID and Offending IE shall be included as per the requirements specified for the corresponding response message; +- the Load Control Information, Overload Control Information and the Failed Rule ID IEs may be included in a PFCP session related message. + +If the Cause IE at Grouped IE level contains a value that indicates that the Grouped IE is not handled correctly, the other IEs in this Grouped IE, other than the Cause IE, may not be included. + +### 7.2.3.3 Grouped Information Elements + +A Grouped IE is an IE which may contain other IEs. + +Grouped IEs have a length value in the TLV encoding, which includes the added length of all the embedded IEs. Overall coding of a grouped IE with 4 octets long IE header is defined in clause 8.2. Each IE within a grouped IE also shall also contain 4 octets long IE header. + +Grouped IEs are not marked by any flag or limited to a specific range of IE type values. The clause describing an IE in this specification shall explicitly state if it is a Grouped IE. + +NOTE: Each entry into each Grouped IE creates a new scope level. Exit from the grouped IE closes the scope level. The PFCP message level is the top most scope. + +If more than one grouped IEs of the same type, but for a different purpose are sent within the same message level, these IEs shall have different IE types. + +If more than one grouped IEs of the same type and for the same purpose are sent within the same message level, these IEs shall have exactly the same IE type to represent a list. + +Assigning the same IE type to grouped IEs which don't have the same content is not recommended, even if these grouped IEs are in different message levels. + +### 7.2.3.4 Information Element Type + +An IE in a PFCP message or Grouped IE is identified by its IE Type and described by a specific row in the corresponding tables in clause 7. + +If several IEs with the same Type are included in a PFCP message or Grouped IE, they represent a list for the corresponding IE name. + +An IE Type value uniquely identifies a specific IE. + +One IE type value is specified for Vendor Specific IEs. + +## 7.3 Message Types + +The PFCP message types to be used over the Sxa, Sxb, Sxc, N4 and N4mb reference points are defined in Table 7.3-1. + +**Table 7.3-1: Message Types** + +| Message Type value (Decimal) | Message | Applicability | | | | | +|------------------------------|----------------------------------------|---------------|-----|-----|----|------| +| | | Sxa | Sxb | Sxc | N4 | N4mb | +| 0 | Reserved | | | | | | +| | PFCP Node related messages | | | | | | +| 1 | PFCP Heartbeat Request | X | X | X | X | X | +| 2 | PFCP Heartbeat Response | X | X | X | X | X | +| 3 | PFCP PFD Management Request | - | X | X | X | - | +| 4 | PFCP PFD Management Response | - | X | X | X | - | +| 5 | PFCP Association Setup Request | X | X | X | X | X | +| 6 | PFCP Association Setup Response | X | X | X | X | X | +| 7 | PFCP Association Update Request | X | X | X | X | X | +| 8 | PFCP Association Update Response | X | X | X | X | X | +| 9 | PFCP Association Release Request | X | X | X | X | X | +| 10 | PFCP Association Release Response | X | X | X | X | X | +| 11 | PFCP Version Not Supported Response | X | X | X | X | X | +| 12 | PFCP Node Report Request | X | X | X | X | X | +| 13 | PFCP Node Report Response | X | X | X | X | X | +| 14 | PFCP Session Set Deletion Request | X | X | - | X | - | +| 15 | PFCP Session Set Deletion Response | X | X | - | X | - | +| 16 | PFCP Session Set Modification Request | - | X | - | X | - | +| 17 | PFCP Session Set Modification Response | - | X | - | X | - | +| 18 to 49 | For future use | | | | | | +| | PFCP Session related messages | | | | | | +| 50 | PFCP Session Establishment Request | X | X | X | X | X | +| 51 | PFCP Session Establishment Response | X | X | X | X | X | +| 52 | PFCP Session Modification Request | X | X | X | X | X | +| 53 | PFCP Session Modification Response | X | X | X | X | X | +| 54 | PFCP Session Deletion Request | X | X | X | X | X | +| 55 | PFCP Session Deletion Response | X | X | X | X | X | +| 56 | PFCP Session Report Request | X | X | X | X | X | +| 57 | PFCP Session Report Response | X | X | X | X | X | +| 58 to 99 | For future use | | | | | | +| | Other messages | | | | | | +| 100 to 255 | For future use | | | | | | + +## 7.4 PFCP Node Related Messages + +### 7.4.1 General + +This clause specifies either node level or PFCP entity level messages used over the Sxa, Sxb, Sxc, N4 and N4mb reference points (see clause 6.2). + +### 7.4.2 Heartbeat Messages + +#### 7.4.2.1 Heartbeat Request + +**Table 7.4.2.1-1: Information Elements in Heartbeat Request** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|--------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|---------------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Recovery Time Stamp | M | This IE shall contain the time stamp when the PFCP entity was started see clause 19A of 3GPP TS 23.007 [24]. | X | X | X | X | X | Recovery Time Stamp | +| Source IP Address | O | This IE may be included when a Network Address Translation device is deployed in the network. See clause 19a in 3GPP TS 23.007 [24]. | X | X | X | X | X | Source IP Address | + +#### 7.4.2.2 Heartbeat Response + +**Table 7.4.2.2-1: Information Elements in Heartbeat Response** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|--------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|---------------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Recovery Time Stamp | M | This IE shall contain the time stamp when the PFCP entity was started see clause 19A of 3GPP TS 23.007 [24]. | X | X | X | X | X | Recovery Time Stamp | + +### 7.4.3 PFCP PFD Management + +#### 7.4.3.1 PFCP PFD Management Request + +**Table 7.4.3.1-1: Information Elements in PFCP PFD Management Request** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|-----------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|-----------------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Application ID's PFDs | C | This IE shall contain an Application Identifier and the associated PFDs to be provisioned in the UP function. Several IEs with the same IE type may be present to provision PFDs for multiple Application IDs. The UP function shall delete all the PFDs received and stored earlier for all the Application IDs if this IE is absent in the message. | - | X | X | X | - | Application ID's PFDs | +| Node ID | O | When present, this IE shall contain the unique identifier of the sending Node. | - | X | X | X | - | Node ID | + +**Table 7.4.3.1-2: Application ID's PFDs** + +| Octet 1 and 2 | | Application ID's PFDs IE Type = 58 (decimal) | | | | | | +|----------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|----------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Application ID | M | This IE shall identify the Application ID for which PFDs shall be provisioned in the UP function. | - | X | X | X | Application ID | +| PFD context | C | This IE shall be present if the PFD needs to be provisioned in the UP function.
When present, it shall describe the PFD to be provisioned in the UP function.
Several IEs with the same IE type may be present to provision multiple PFDs for this Application ID.

When this IE is absent, the UP function shall delete all the PFDs received and stored earlier in the UP function for this Application ID. | - | X | X | X | PFD context | + +**Table 7.4.3.1-3: PFD context** + +| Octet 1 and 2 | | PFD context IE Type = 59 (decimal) | | | | | | +|----------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|--------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| PFD Contents | M | This IE shall describe the PFD to be provisioned in the UP function. Several IEs with the same IE type may be present to provision multiple contents for this PFD.
(NOTE 1) | - | X | X | X | PFD Contents | + +NOTE 1 The CP function shall only provision a PFD Contents including a property with multiple values if the UP function supports PFDE feature. See clauses 8.2.25 and 8.2.39. + +### 7.4.3.2 PFCP PFD Management Response + +**Table 7.4.3.2-1: Information Elements in PFCP PFD Management Response** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|-------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|--------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Cause | M | This IE shall indicate the acceptance or the rejection of the corresponding request message. | - | X | X | X | - | Cause | +| Offending IE | C | This IE shall be included if the rejection is due to a conditional or mandatory IE missing or faulty. | - | X | X | X | - | Offending IE | +| Node ID | O | When present, this IE shall contain the unique identifier of the sending Node. | - | X | X | X | - | Node ID | + +## 7.4.4 PFCP Association messages + +### 7.4.4.1 PFCP Association Setup Request + +#### 7.4.4.1.1 General + +**Table 7.4.4.1-1: Information Elements in a PFCP Association Setup Request** + +| Information | P | Condition / Comment | Appl. | IE Type | +|-------------|---|---------------------|-------|---------| +|-------------|---|---------------------|-------|---------| + +| elements | | | Sx
a | Sx
b | Sx
c | N4 | N4
mb | | +|------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---------|---------|----|----------|------------------------------------| +| Node ID | M | This IE shall contain the unique identifier of the sending Node. | X | X | X | X | X | Node ID | +| Recovery Time Stamp | M | This IE shall contain the time stamp when the CP or UP function was started, see clause 19A of 3GPP TS 23.007 [24]. (NOTE) | X | X | X | X | X | Recovery Time Stamp | +| UP Function Features | C | This IE shall be present if the UP function sends this message and the UP function supports at least one UP feature defined in this IE. When present, this IE shall indicate the features the UP function supports. | X | X | X | X | X | UP Function Features | +| CP Function Features | C | This IE shall be present if the CP function sends this message and the CP function supports at least one CP feature defined in this IE. When present, this IE shall indicate the features the CP function supports. | X | X | X | X | X | CP Function Features | +| Alternative SMF IP Address | O | This IE may be present if the (MB-)SMF advertises the support of the SSET and/or MPAS feature in the CP Function Features IE (see clause 8.2.58).

When present, this IE shall contain an IPv4 and/or IPv6 address of an alternative (MB-)SMF or an alternative PFCP entity in the same (MB-)SMF when SSET feature is used, or an alternative PFCP entity in the same (MB-)SMF when MPAS feature is used.
Several IEs with the same IE type may be present to represent multiple alternative (MB-)SMF IP addresses. | - | - | - | X | X | Alternative SMF IP Address | +| SMF Set ID | C | This IE shall be present if the (MB-)SMF advertises the support of the MPAS feature in the CP Function Features IE (see clause 5.22.3).

When present, this IE shall contain an FQDN representing the (MB-)SMF set to which the (MB-)SMF belongs. | - | - | - | X | X | SMF Set ID | +| PFCP Session Retention Information | O | This IE may be present to request the UP function to keep all or part of the existing PFCP sessions upon receipt of a PFCP association setup request with a Node ID for which a PFCP association was already established. See clause 6.2.6.2.1. | X | X | X | X | X | PFCP Session Retention Information | +| UE IP address Pool Information | O | This IE may be present when the UP function sends this message, if UE IP Address Pools are configured in the UP function.

Several IE with the same IE type may be present to represent multiple UE IP address Pool Information. | - | X | - | X | - | UE IP address Pool Information | +| GTP-U Path QoS Control Information | C | This IE may be present, if the CP function sends this message, to request the UPF to monitor the QoS on GTP-U paths (see clause 5.24.5).
Several IEs with the same IE type may be present to represent multiple GTP-U paths (with different parameters) to monitor. | - | - | - | X | - | GTP-U Path QoS Control Information | +| Clock Drift Control Information | O | This IE may be present, if the CP function sends this message, to request the UPF to report clock drift between the external time and 5GS time for working domains (see clause 5.26.4).
Several IEs with the same IE type may be present for multiple Time domains (with different parameters). | - | - | - | X | - | Clock Drift Control Information | +| UPF Instance ID | O | This IE may be present if the UP function is a 5G UP function and if available, and if the message is sent by the UP function. | - | - | - | X | X | NF Instance ID | +| PFCPASReq-Flags | O | This IE shall be included if at least one of the | - | - | - | X | - | PFCPASReq- | + +| | | | | | | | | | +|-------------------------------------------------------------------------------------------------------------------|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|--|--|-------| +| | | flags is set to "1":
- UUPSI (UPF configured for IPUPS): when the message is sent by a UPF, the UP function shall set this flag to "1" if the UPF is configured to be used for IPUPS. See clause 5.27. | | | | | | Flags | +| NOTE: A PFCP function shall ignore the Recovery Timestamp received in the PFCP Association Setup Request message. | | | | | | | | | + +**Table 7.4.4.1-2: PFCP Session Retention Information IE within PFCP Association Setup Request** + +| Octet 1 and 2 | | PFCP Session Retention Information IE Type = 183 (decimal) | | | | | | | +|---------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|---------------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| CP PFCP Entity IP Address | O | This IE may be present to indicate the IP address of a CP PFCP entity for which the UP function shall retain the existing PFCP sessions, upon receipt of a PFCP association setup request with a Node ID for which a PFCP association was already established. See clause 6.2.6.2.1

Several IEs with the same IE type may be present to represent multiple CP PFCP entities for which PFCP sessions shall be retained.

If no CP PFCP Entity IP Address IE is present in the PFCP Session Retention Information IE, all existing PFCP sessions shall be kept upon receipt of a PFCP association setup request with a Node ID for which a PFCP association was already established. | X | X | X | X | X | CP PFCP Entity IP Address | + +**Table 7.4.4.1-3: UE IP address Pool Information IE within PFCP Association Setup Request** + +| Octet 1 and 2 | | UE IP address Pool Information IE Type = 233 (decimal) | | | | | | | +|-----------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|-----------------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| UE IP address Pool Identity | M | When present, this IE shall contain an UE IP address Pool Identity

Several IEs with the same IE type may be present to represent multiple UE IP address Pool Identities. | - | X | - | X | - | UE IP address Pool Identity | +| Network Instance | O | The IE may be present to indicate for which DNN/APN the UE IP Address Pool Identities are configured. | - | X | - | X | - | Network Instance | +| S-NSSAI | O | The IE may be present to indicate for which S-NSSAI the UE IP Address Pool Identities are configured.
Several IEs with the same IE type may be present to represent multiple S-NSSAIs. | - | - | - | X | - | S-NSSAI | +| IP version | O | The IE may be present to indicate for which IP version the UE IP Address Pool Identities are configured. | - | - | - | X | - | IP version | + +#### 7.4.4.1.2 Clock Drift Control Information IE within PFCP Association Setup Request + +The Clock Drift Control Information grouped IE shall be encoded as shown in Table 7.4.4.1.2-1. + +**Table 7.4.4.1.2-1: Clock Drift Control Information within PFCP Association Setup Request** + +| Octet 1 and 2 | | Clock Drift Control Information IE Type = 203 (decimal) | | | | | | +|-----------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|-----------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Requested Clock Drift Information | M | This IE shall indicate the requested clock drift information. | - | - | - | X | Requested Clock Drift Information | +| Time Domain Number | C | When present, this IE shall identify the external time domain(s) for which clock drift information is requested.

More than one IE with this type may be included to represent multiple Time Domain Numbers.

This IE may be included if the Configured Time Domain IE is not included. (NOTE) | - | - | - | X | Time Domain Number | +| Configured Time Domain | C | When present with the CTDI (Configured Time Domain Indicator) flag set to "1", this IE indicates that the request targets the external time domain that is configured to the NW-TT(s) in the UPF.

This IE may be included if the Time Domain Number IE is not included. (NOTE) | - | - | - | X | Configured Time Domain | +| Time Offset Threshold | C | This IE shall be present if Time Offset Reporting is requested.
When present, it shall indicate the threshold to report the time offset, i.e. the offset shall be reported only when it exceeds the threshold compared to the previous report. | - | - | - | X | Time Offset Threshold | +| Cumulative rateRatio Threshold | C | This IE shall be present if Cumulative RateRatio Reporting is requested.
When present, it shall indicate the threshold to report the cumulative rateRatio, i.e. the cumulative rateRatio shall be reported only when it exceeds the threshold compared to the previous report. | - | - | - | X | Cumulative rateRatio Threshold | + +NOTE: If neither the Time Domain Number IE nor the Configured Time Domain IE is included, this indicates that the request targets all the external time domains the UPF is connected to. + +#### 7.4.4.1.3 GTP-U Path QoS Control Information IE within PFCP Association Setup Request + +The GTP-U Path QoS Control Information grouped IE shall be encoded as shown in Table 7.4.4.1.3-1. + +**Table 7.4.4.1.3-1: GTP-U Path QoS Control Information within PFCP Association Setup Request** + +| Octet 1 and 2 | | GTP-U Path QoS Control Information IE Type = 239 (decimal) | | | | | | +|--------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|---------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Remote GTP-U Peer | C | When present, this IE shall include the IP address of the remote GTP-U peer for which QoS information is to be reported, and the network instance used towards the remote GTP-U peer if available.
Several IEs with the same IE type may be present to represent multiple remote GTP-U peers.
(NOTE) | - | - | - | X | Remote GTP-U Peer | +| GTP-U Path Interface Type | C | When present, this IE shall include the Interface Type of the GTP-U paths for which QoS information is to be reported.
(NOTE) | - | - | - | X | GTP-U Path Interface Type | +| QoS Report Trigger | M | This IE shall indicate the trigger for reporting QoS information to the SMF. | - | - | - | X | QoS Report Trigger | +| DSCP | C | This IE shall be present, if available. When present, it shall contain the value of the DSCP in the TOS/Traffic Class field to measure the packet delay.

Several IEs with the same IE type may be present to represent multiple DSCP values to use for QoS monitoring. | - | - | - | X | Transport Level Marking | +| Measurement Period | C | This IE shall be present if the QoS Report Trigger indicates periodic reporting. When present, it shall contain the time period for the QoS reports towards the SMF. | - | - | - | X | Measurement Period | +| Average Packet Delay Threshold | C | This IE may be present if the QoS Report Trigger indicates reporting based on thresholds. | - | - | - | X | Average Packet Delay | +| Minimum Packet Delay Threshold | C | This IE may be present if the QoS Report Trigger indicates reporting based on thresholds. | - | - | - | X | Minimum Packet Delay | +| Maximum Packet Delay Threshold | C | This IE may be present if the QoS Report Trigger indicates reporting based on thresholds. | - | - | - | X | Maximum Packet Delay | +| Minimum Waiting Time | C | This IE may be present if the QoS Report Trigger indicates reporting based on thresholds. When present, it shall contain the minimum waiting time between two consecutive reports for the same type of measurement and the same remote GTP-U peer. | - | - | - | X | Timer | + +NOTE: At least one Remote GTP-U Peer IE or GTP-U Path Interface Type IE shall be present. + +## 7.4.4.2 PFCP Association Setup Response + +**Table 7.4.4.2-1: Information Elements in a PFCP Association Setup Response** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|---------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|---------------------------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Node ID | M | This IE shall contain the unique identifier of the sending Node. | X | X | X | X | X | Node ID | +| Cause | M | This IE shall indicate the acceptance or the rejection of the corresponding request message. | X | X | X | X | X | Cause | +| Recovery Time Stamp | M | This IE shall contain the time stamp when the CP or UP function was started, see clause 19A of 3GPP TS 23.007 [24]. (NOTE) | X | X | X | X | X | Recovery Time Stamp | +| UP Function Features | C | This IE shall be present if the UP function sends this message and the UP function supports at least one UP feature defined in this IE. When present, this IE shall indicate the features the UP function supports. | X | X | X | X | X | UP Function Features | +| CP Function Features | C | This IE shall be present if the CP function sends this message and the CP function supports at least one CP feature defined in this IE. When present, this IE indicates the features the CP function supports. | X | X | X | X | X | CP Function Features | +| Alternative SMF IP Address | O | This IE may be present if the (MB-)SMF advertises the support of the SSET and/or MPAS feature in the CP Function Features IE (see clause 8.2.58).

When present, this IE shall contain an IPv4 and/or IPv6 address of an alternative (MB-)SMF or an alternative PFCP entity in the same (MB-)SMF when SSET feature is used, or an alternative PFCP entity in the same (MB-)SMF when MPAS feature is used.
Several IEs with the same IE type may be present to represent multiple alternative (MB-)SMF IP addresses. | - | - | - | X | X | Alternative SMF IP Address | +| SMF Set ID | C | This IE shall be present if the CP function sends this message and (MB-)SMF advertises the support of the MPAS feature in the CP Function Features IE (see clause 5.22.3).

When present, this IE shall contain an FQDN representing the (MB-)SMF set to which the (MB-)SMF belongs. | - | - | - | X | X | SMF Set ID | +| PFCPASRsp-Flags | O | This IE shall be included if at least one of the flags is set to "1":
| X | X | X | X | X | PFCPASRsp-Flags | +| Clock Drift Control Information | C | This IE may be present, if the CP function sends this message, to request the UPF to report clock drift between the external time and 5GS time for external working domains (see clause 5.26.4). Several IEs with the same IE type may be present to represent multiple external time domains (with different parameters). See Table 7.4.4.1.2-1. | - | - | - | X | - | Clock Drift Control Information | +| UE IP address Pool | O | This IE may be present when the UP function | - | X | - | X | - | UE IP address | + +| | | | | | | | | | +|----------------------------------------------------------------------------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|------------------------------------| +| Information | | sends this message, if UE IP Address Pools are configured in the UP function.

Several IE with the same IE type may be present to represent multiple UE IP address Pool Information.

The IE shall be encoded as in Table 7.4.4.1-3. | | | | | | Pool Information | +| GTP-U Path QoS Control Information | C | This IE may be present, if the CP function sends this message, to request the UPF to monitor the QoS on GTP-U paths (see clause 5.24.5).
Several IEs with the same IE type may be present to represent multiple GTP-U paths to monitor.
See Table 7.4.4.1.3-1. | - | - | - | X | - | GTP-U Path QoS Control Information | +| UPF Instance ID | O | This IE may be present if the UP function is a 5G UP function and if available, and if the message is sent by the UP function. | - | - | - | X | X | NF Instance ID | +| NOTE: A PFCP function shall ignore the Recovery Timestamp received in PFCP Association Setup Response message. | | | | | | | | | + +### 7.4.4.3 PFCP Association Update Request + +**Table 7.4.4.3-1: Information Elements in a PFCP Association Update Request** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|----------------------------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Node ID | M | This IE shall contain the unique identifier of the sending Node. | X | X | X | X | X | Node ID | +| UP Function Features | O | If present, this IE shall indicate the supported Features when the sending node is the UP function. | X | X | X | X | X | UP Function Features | +| CP Function Features | O | If present, this IE shall indicate the supported Features when the sending node is the CP function. | X | X | X | X | X | CP Function Features | +| PFCP Association Release Request | C | This IE shall be present if the UP function requests the CP function to release the PFCP association. | X | X | X | X | X | PFCP Association Release Request | +| Graceful Release Period | C | This IE shall be present if the UP function requests a graceful release of the PFCP association. | X | X | X | X | X | Graceful Release Period | +| PFCPAUReq-Flags | O | This IE shall be included if at least one of the flags is set to "1".
- PARPS (PFCP Association Release Preparation Start): if both the CP function and UP function support the EPFAR feature, the CP or UP function may set this flag to "1" to indicate that the PFCP association is to be released and all non-zero usage reports for those PFCP Sessions affected by the release of the PFCP association shall be reported. | X | X | X | X | - | PFCPAUReq-Flags | +| Alternative SMF IP Address | O | This IE may be present if the (MB-)SMF advertises the support of the SSET and/or MPAS feature in the CP Function Features IE (see clause 8.2.58).

When present, this IE shall contain an IPv4 and/or IPv6 address of an alternative (MB-)SMF or an alternative PFCP entity in the same (MB-)SMF when SSET feature is used, or an alternative PFCP entity in the same (MB-)SMF when MPAS feature is used.

Several IEs with the same IE type may be present to represent multiple alternative (MB-)SMF IP addresses. | - | - | - | X | X | Alternative SMF IP Address | +| SMF Set ID | O | This IE may be present if the CP function sends this message and (MB-)SMF advertises the support of the MPAS feature in the CP Function Features IE (see clause 5.22.3), and there is a change in FQDN representing the (MB-)SMF set to which the (MB-)SMF belongs. | - | - | - | X | X | SMF Set ID | +| Clock Drift Control Information | C | This IE shall be present if the Clock Drift Control Information needs to be modified (see clause 5.26.4).
Several IEs with the same IE type may be present to represent TSN domains.

When present, the UPF shall replace any Clock Drift control information received earlier with the new received information.

A Clock Drift Control Information with a null length indicates that clock drift reporting shall be stopped.

See Table 7.4.4.1.2-1. | - | - | - | X | - | Clock Drift Control Information | +| UE IP address Pool Information | O | This IE may be present when the UP function sends this message, if UE IP Address Pools are configured in the UP function. | - | X | - | X | - | UE IP address Pool Information | + +| | | | | | | | | | +|------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|------------------------------------| +| | | Several IE with the same IE type may be present to represent multiple UE IP address Pool Information.

The IE shall be encoded as in Table 7.4.4.1-3. | | | | | | | +| GTP-U Path QoS Control Information | C | This IE shall be present if the GTP-U Path QoS Control Information needs to be modified (see clause 5.24.5).
Several IEs with the same IE type may be present to represent multiple GTP-U paths to monitor.

When present, the UPF shall replace any GTP-U path control information received earlier with the new received information.

A GTP-U Path QoS Control Information with a null length indicates that QoS monitoring of GTP-U paths shall be stopped.

See Table 7.4.4.1.3-1. | - | - | - | X | - | GTP-U Path QoS Control Information | +| UE IP Address Usage Information | O | The UP function may include this IE if both UP and CP functions support the UE IP Address Usage Reporting feature.
See Table 7.4.4.3.1-1

Several IEs with the same type may be present to represent UE IP Address Usage Information for different UE IP Address Pools and/or Network Instances.

See clause 5.21.3. | - | X | - | X | - | UE IP Address Usage Information | + +#### 7.4.4.3.1 UE IP Address Usage Information IE within PFCP Association Update Request + +The UE IP Address Usage Information grouped IE shall be encoded as shown in Figure 7.4.4.3.1-1. + +**Table 7.4.4.3.1-1: UE IP Address Usage Information IE within PFCP Association Update Request** + +| Octet 1 and 2 | | UE IP Address Usage Information IE Type = 267 (decimal) | | | | | | +|-------------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|-----------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| UE IP Address Usage Sequence Number | M | This IE shall be used by the CP function to properly collate out-of-order UE IP Address Usage Information received for a given network instance and/or UE IP Address pool, e.g. due to PFCP retransmissions. This IE shall also be used by the receiver to determine whether the newly received UE IP Address Usage Information has changed compared to UE IP Address Usage Information previously received from the same node earlier. | - | X | - | X | Sequence Number | +| UE IP Address Usage Metric | M | This IE shall represent the current ratio of occupied UE IP addresses in the UP function for the Network Instance indicated in the Network Instance IE, or for the Network Instance indicated in the Network Instance IE and the UE IP address Pool indicated by the UE IP Address Pool Id IE when this IE is present. The value shall be expressed as a percentage within the range of 0 to 100, where 0 means no or 0% usage and 100 means maximum or 100% usage reached (i.e. it is not desirable to receive further PFCP Session Establishment Requests). | - | X | - | X | Metric | +| Validity Timer | M | This IE shall represent the period of time during which the UE IP Address Usage Information shall be considered as valid. | - | X | - | X | Validity Timer | +| Number of UE IP Addresses | M | This IE shall indicate the total number of UE IP addresses configured for the Network Instance or also for the IP address Pool, when this IE is present. (NOTE) | - | X | - | X | Number of UE IP Addresses | +| Network Instance | M | This IE shall identify the associated Network instance. | - | X | - | X | Network Instance | +| UE IP Address Pool Id | O | This IE may be present if UE IP Addresses Pools are configured in the UPF.

When present, this IE shall contain the identity of the associated UE IP address Pool. | - | X | - | X | UE IP address Pool Identity | +| S-NSSAI | O | This IE may be present if the feature "Per slice UP resource management" is supported by the UP Function. When present, it shall indicate the S-NSSAI for which the UE IP addresses usage information is reported. | - | X | - | X | S-NSSAI | + +NOTE: When reporting the number of IPv6 UE Addresses for a specific Network Instance and/or IP address pool, the number of default /64 prefixes is reported by default, unless configured otherwise. + +#### 7.4.4.4 PFCP Association Update Response + +**Table 7.4.4.4-1: Information Elements in a PFCP Association Update Response** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|---------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|---------------------------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Node ID | M | This IE shall contain the unique identifier of the sending Node. | X | X | X | X | X | Node ID | +| Cause | M | This IE shall indicate the acceptance or the rejection of the corresponding request message. | X | X | X | X | X | Cause | +| UP Function Features | O | If present, this IE shall indicate the supported Features when the sending node is the UP function. | X | X | X | X | X | UP Function Features | +| CP Function Features | O | If present, this IE shall indicate the supported Features when the sending node is the CP function. | X | X | X | X | X | CP Function Features | +| UE IP Address Usage Information | O | The UP function may include if both UP and CP functions support the UE IP Address Usage Reporting feature.
See Table 7.4.4.3.1-1.

Several IEs with the same type may be present to represent UE IP Address Usage Information for different UE IP Address Pools and/or Network Instances.

See clause 5.21.3. | - | X | - | X | - | UE IP Address Usage Information | + +#### 7.4.4.5 PFCP Association Release Request + +**Table 7.4.4.5-1: Information Elements in a PFCP Association Release Request** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|------------------------------------------------------------------|-------|------|------|----|-------|---------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Node ID | M | This IE shall contain the unique identifier of the sending Node. | X | X | X | X | X | Node ID | + +#### 7.4.4.6 PFCP Association Release Response + +**Table 7.4.4.6-1: Information Elements in a PFCP Association Release Response** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|----------------------------------------------------------------------------------------------|-------|------|------|----|-------|---------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Node ID | M | This IE shall contain the unique identifier of the sending Node. | X | X | X | X | X | Node ID | +| Cause | M | This IE shall indicate the acceptance or the rejection of the corresponding request message. | X | X | X | X | X | Cause | + +#### 7.4.4.7 PFCP Version Not Supported Response + +This message shall only contain the PFCP header. The PFCP protocol version in the PFCP header shall indicate the highest PFCP Version that the sending entity supports. + +NOTE: The PFCP Version Not Supported Response message can be received by a PFCP entity when sending the very first message to a PFCP peer only supporting earlier version(s) of the protocol. + +## 7.4.5 PFCP Node Report Procedure + +### 7.4.5.1 PFCP Node Report Request + +#### 7.4.5.1.1 General + +The PFCP Node Report Request shall be sent over the Sxa, Sxb, Sxc, N4 and N4mb interface by the UP function to report information to the CP function that is not specific to a PFCP session. + +**Table 7.4.5.1.1-1: Information Elements in PFCP Node Report Request** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|----------------------------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Node ID | M | This IE shall contain the unique identifier of the sending Node. | X | X | X | X | X | Node ID | +| Node Report Type | M | This IE shall indicate the type of the report. | X | X | X | X | X | Node Report Type | +| Vendor-Specific Node Report Type | C | This IE shall be present if the Node Report Type IE indicates a Vendor-Specific Report. When present, this IE shall indicate the type of the Vendor-Specific Report. | X | X | X | X | X | Vendor-Specific Node Report Type | +| User Plane Path Failure Report | C | This IE shall be present if the Node Report Type indicates a User Plane Path Failure Report. | X | X | - | X | X | User Plane Path Failure Report | +| User Plane Path Recovery Report | C | This IE shall be present if the Node Report Type indicates a User Plane Path Recovery Report. | X | X | - | X | X | User Plane Path Recovery Report | +| Clock Drift Report | C | This IE shall be present if the Node Report Type indicates a Clock Drift Report.
More than one IE with this type may be included to send Clock Drift Reports for different Time Domain Numbers. | - | - | - | X | - | Clock Drift Report | +| GTP-U Path QoS Report | C | This IE shall be present if the Node Report Type indicates a GTP-U Path QoS Report.
More than one IE with this type may be included to represent multiple remote GTP-U peers for which QoS information is reported. | - | - | - | X | - | GTP-U Path QoS Report | +| Peer UP Restart Report | C | This IE shall be present if the Node Report Type Indicates a Peer GTP-U entity has restarted as specified in clause 20.3.4a of 3GPP TS 23.007 [24] and in clause 5.5 of 3GPP TS 23.527 [40]. | X | X | - | X | - | Peer UP Restart Report | + +#### 7.4.5.1.2 User Plane Path Failure Report IE within PFCP Node Report Request + +**Table 7.4.5.1.2-1: User Plane Path Failure Report IE within PFCP Node Report Request** + +| Octet 1 and 2 | User Plane Path Failure Report IE Type = 102 (decimal) | | | | | | | +|----------------------|--------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------------------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | | +| Remote GTP-U Peer | M | This IE shall include the IP address of the remote GTP-U peer towards which a user plane path failure has been detected.
More than one IE with this type may be included to represent multiple remote GTP-U peers towards which a user plane path failure has been detected. | X | X | - | X | Remote GTP-U Peer | + +#### 7.4.5.1.3 User Plane Path Recovery Report IE within PFCP Node Report Request + +**Table 7.4.5.1.3-1: User Plane Path Recovery Report IE within PFCP Node Report Request** + +| Octet 1 and 2 | | User Plane Path Recovery Report IE Type = 187 (decimal) | | | | | | +|----------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|-------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Remote GTP-U Peer | M | This IE shall include the IP address of the remote GTP-U peer towards which user plane path failure was reported and then the path has recovered within an operator configurable maximum path failure duration (see clause 20.3.4 in 3GPP TS 23.007 [24] and clause 5.4 in 3GPP TS 23.527 [40]).
More than one IE with this type may be included to represent multiple remote GTP-U peers towards which a user plane path has recovered. | X | X | - | X | Remote GTP-U Peer | + +#### 7.4.5.1.4 Clock Drift Report IE within PFCP Node Report Request + +**Table 7.4.5.1.4-1: Clock Drift Report IE within PFCP Node Report Request** + +| Octet 1 and 2 | | Clock Drift Report IE Type = 205 (decimal) | | | | | | +|----------------------------------|---|------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|----------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Time Domain Number | M | This IE shall identify the Time Domain Number for which measurements are reported. | - | - | - | X | Time Domain Number | +| Time Offset Measurement | O | When present, this IE shall contain the time offset measurement. | - | - | - | X | Time Offset Measurement | +| Cumulative rateRatio Measurement | O | When present, this IE shall contain the cumulative rateRatio measurement. | - | - | - | X | Cumulative rateRatio Measurement | +| Time Stamp | O | When present, this IE shall provide the timestamp when the collection of the information in this report was generated. | - | - | - | X | Time Stamp | +| Network Instance | C | This IE shall be present, when available (NOTE). | - | - | - | X | Network Instance | +| APN/DNN | C | This IE shall be present, when available (NOTE). | - | - | - | X | APN/DNN | +| S-NSSAI | C | This IE shall be present, when available (NOTE). | - | - | - | X | S-NSSAI | + +NOTE: The UPF shall provide the Network Instance and DNN/S-NSSAI (if available) to the CP function, to enable SMF to associate the report with the corresponding PFCP sessions and NW-TT, when the UPF supports more than one NW-TT. + +#### 7.4.5.1.5 GTP-U Path QoS Report IE within PFCP Node Report Request + +**Table 7.4.5.1.5-1: GTP-U Path QoS Report IE within PFCP Node Report Request** + +| Octet 1 and 2 | | GTP-U Path QoS Report IE Type = 239 (decimal) | | | | | | +|----------------------|---|-----------------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|---------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------------| +| Remote GTP-U Peer | M | This IE shall include the IP address of the remote GTP-U peer for which QoS information is reported, and the network instance used towards the remote GTP-U peer if available. | - | - | - | X | - | Remote GTP-U Peer | +| GTP-U Path Interface Type | C | This IE shall be present, if available. When present, it shall indicate the interface type of the GTP-U path towards the remote GTP-U peer. | - | - | - | X | - | GTP-U Path Interface Type | +| QoS Report Trigger | M | This IE shall indicate the trigger for this report. | - | - | - | X | - | QoS Report Trigger | +| Time Stamp | M | This shall shall provide the timestamp when the collection of the information in this report was generated. | - | - | - | X | - | Time Stamp | +| Start Time | C | This shall shall provide the timestamp when the collection of the information in this report was started. | - | - | - | X | - | Start Time | +| QoS Information | M | This IE shall contain the measured QoS information. More than one IE with this type may be included to represent multiple QoS Information, e.g. for different DSCP values. | - | - | - | X | - | QoS Information | + +#### 7.4.5.1.6 QoS Information in GTP-U Path QoS Report IE + +**Table 7.4.5.1.6-1: QoS Information in GTP-U Path QoS Report IE** + +| Octet 1 and 2 | | QoS Information IE Type = 240 (decimal) | | | | | | +|----------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|-------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Average Packet Delay | M | This IE shall indicate the average packet delay of the related GTP-U path. | - | - | - | X | Average Packet Delay | +| Minimum Packet Delay | C | This IE shall indicate the minimum packet delay of the related GTP-U path, if available. | - | - | - | X | Minimum Packet Delay | +| Maximum Packet Delay | C | This IE shall indicate the maximum packet delay of the related GTP-U path, if available. | - | - | - | X | Maximum Packet Delay | +| DSCP | C | This IE shall be present, if available. When present, it shall contain the value of the DSCP in the TOS/Traffic Class field used in Echo messages to measure the packet delay. | - | - | - | X | Transport Level Marking | + +#### 7.4.5.1.7 Peer UP Restart Report IE within PFCP Node Report Request + +**Table 7.4.5.1.7-1: Peer UP Restart Report IE within PFCP Node Report Request** + +| Octet 1 and 2 | | Peer UP Restart Report Type = 315 (decimal) | | | | | | +|----------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|-------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Remote GTP-U Peer | M | This IE shall include the IP address of the remote GTP-U peer which has restarted.

More than one IE with this type may be included to represent that multiple peer GTP-U entities restart. | X | X | - | X | Remote GTP-U Peer | + +#### 7.4.5.2 PFCP Node Report Response + +##### 7.4.5.2.1 General + +The PFCP Node Report Response shall be sent over the Sxa, Sxb, Sxc, N4 and N4mb interface by the CP function to the UP function as a reply to the PFCP Node Report Request. + +**Table 7.4.5.2.1-1: Information Elements in PFCP Node Report Response** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|-------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|--------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Node ID | M | This IE shall contain the unique identifier of the sending Node. | X | X | X | X | X | Node ID | +| Cause | M | This IE shall indicate the acceptance or the rejection of the corresponding request message. | X | X | X | X | X | Cause | +| Offending IE | C | This IE shall be included if the rejection cause is due to a conditional or mandatory IE missing or faulty. | X | X | X | X | X | Offending IE | + +## 7.4.6 PFCP Session Set Deletion + +### 7.4.6.1 PFCP Session Set Deletion Request + +The PFCP Session Set Deletion Request shall be sent over the Sxa, Sxb or N4 interface by the CP function to request the UP function to delete the PFCP sessions affected by a partial failure. + +The PFCP Session Set Deletion Request shall be also sent over the Sxa, Sxb or N4 interface by the UP function to request the CP function to delete the PFCP sessions affected by a partial failure. + +**Table 7.4.6.1-1: Information Elements in a PFCP Session Set Deletion Request** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|-------------------------|---|------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|---------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Node ID | M | This IE shall contain the node identity of the originating node of the message. | X | X | - | X | - | Node ID | +| SGW-C FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24]. | X | X | - | - | - | FQ-CSID | +| PGW-C/SMF FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24] and clause 4.6 of 3GPP TS 23.527 [40]. | X | X | - | X | - | FQ-CSID | +| PGW-U/SGW-U/UPF FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24] and clause 4.6 of 3GPP TS 23.527 [40]. | X | X | - | X | - | FQ-CSID | +| TWAN FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24]. | - | X | - | - | - | FQ-CSID | +| ePDG FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24]. | - | X | - | - | - | FQ-CSID | +| MME FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24]. | X | X | - | - | - | FQ-CSID | + +### 7.4.6.2 PFCP Session Set Deletion Response + +The PFCP Session Set Deletion Response shall be sent over the Sxa, Sxb or N4 interface by the UP function or the CP function as a reply to the PFCP Session Set Deletion Request. + +**Table 7.4.6.2-1: Information Elements in a PFCP Session Set Deletion Response** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|--------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|--------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Node ID | M | This IE shall contain the unique identifier of the sending node. | X | X | - | X | - | Node ID | +| Cause | M | This IE shall indicate the acceptance or the rejection of the corresponding request message. | X | X | - | X | - | Cause | +| Offending IE | C | This IE shall be included if the rejection is due to an conditional or mandatory IE missing or faulty. | X | X | - | X | - | Offending IE | + +## 7.4.7 PFCP Session Set Modification + +### 7.4.7.1 PFCP Session Set Modification Request + +The PFCP Session Set Modification Request shall be sent over the Sxb or N4 interface by the CP function to request the UP function to send any subsequent PFCP Session Report Request messages for the PFCP sessions which are identified by either FQ-CSID(s) or Group Id(s), or the CP IP Address in their F-SEIDs, towards an (alternative) SMF/PGW-C, e.g. when those PFCP sessions are affected by a partial PGW-C/SMF failure or are controlled by a PGW-C/SMF that is shutting down. + +This procedure shall only be performed if the UP function indicated support of the RESPS feature (see clause 8.2.25). + +**Table 7.4.7.1-1: Information Elements in a PFCP Session Set Modification Request** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|--------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|--------------------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Node ID | M | This IE shall contain the node identity of the originating node of the message. | - | X | - | X | - | Node ID | +| PFCP Session Change Info | M | This IE shall identify the FQ-CSID(s), Group Id(s) or CP IP address(es) of the PFCP sessions for which the PGW-U/UPF shall send subsequent PFCP Session Report Request messages to an Alternative SMF/PGW-C IP Address.

Several IEs with the same IE type may be present to request the PGW-U/UPF to move PFCP sessions associated with different FQ-CSIDs, Group Ids or CP IP addresses to different PGW-C/SMFs. | - | X | - | X | - | PFCP Session Change Info | + +**Table 7.4.7.1-2: PFCP Session Change Info IE within PFCP Session Set Modification Request** + +| Octet 1 and 2 | PFCP Session Change Info IE Type = 290 (decimal) | | | | | | | +|----------------------|--------------------------------------------------|---------------------|-------|------|------|----|---------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | | + +| | | | | | | | | | +|----------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|----------------------------| +| PGW-C/SMF FQ-CSID | C | This IE shall identify the PGW-C/SMF FQ-CSID of the PFCP sessions for which the UPF shall send subsequent PFCP Session Report Request messages to the Alternative SMF/PGW-C IP Address.

See also clause 31.6 of 3GPP TS 23.007 [24] and clause 4.7 of 3GPP TS 23.527 [40].

Several IEs with the same IE type may be present to represent several FQ-CSIDs of PFCP sessions that need to be moved to the same Alternative SMF/PGW-C IP Address. | - | X | - | X | - | FQ-CSID | +| Group Id | C | This IE shall identify the Group Id of the PFCP sessions for which the UPF shall send subsequent PFCP Session Report Request messages to the Alternative SMF/PGW-C IP Address.

See also clause 31.6 of 3GPP TS 23.007 [24] and clause 4.7 of 3GPP TS 23.527 [40].

Several IEs with the same IE type may be present to represent several Group Ids of PFCP sessions that need to be moved to the same Alternative SMF/PGW-C IP Address. | - | X | - | X | - | Group-Id | +| CP IP Address | C | This IE shall identify the IP address in the CP F-SEID of the PFCP sessions for which the UPF shall send subsequent PFCP Session Report Request messages to the Alternative SMF/PGW-C IP Address.

Several IEs with the same IE type may be present to represent several CP IP addresses of PFCP sessions that need to be moved to the same Alternative SMF/PGW-C IP Address. | - | X | - | X | - | CP IP Address | +| Alternative SMF/PGW-C IP Address | M | This IE shall include the alternative SMF/PGW-C IP Address to be used by the UP function to send subsequent PFCP Session Report Request messages for the PFCP Sessions associated with the PGW-C/SMF FQ-CSID(s), Group Id(s) or CP IP address(es).

When present, this IE shall contain an IPv4 and/or IPv6 address of the same or an alternative SMF/PGW-C. | - | X | - | X | - | Alternative SMF IP Address | + +#### 7.4.7.2 PFCP Session Set Modification Response + +The PFCP Session Set Modification Response shall be sent over the Sxb or N4 interface by the UP function to the CP function as a reply to the PFCP Session Set Modification Request. + +**Table 7.4.2.2-1: Information Elements in a PFCP Session Set Modification Response** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|-------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|--------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Node ID | M | This IE shall contain the unique identifier of the sending node. | - | X | - | X | - | Node ID | +| Cause | M | This IE shall indicate the acceptance or the rejection of the corresponding request message. | - | X | - | X | - | Cause | +| Offending IE | C | This IE shall be included if the rejection is due to a conditional or mandatory IE missing or faulty. | - | X | - | X | - | Offending IE | + +## 7.5 PFCP Session Related Messages + +### 7.5.1 General + +This clause specifies the session related messages used over the Sxa, Sxb and Sxc reference points. + +### 7.5.2 PFCP Session Establishment Request + +#### 7.5.2.1 General + +The PFCP Session Establishment Request shall be sent over the Sxa, Sxb, Sxc, N4 and N4mb interface by the CP function to establish a new PFCP session context in the UP function. + +**Table 7.5.2.1-1: Information Elements in a PFCP Session Establishment Request** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|---------------------|-------|-----|-----|----|------|---------| +| | | | Sxa | Sxb | Sxc | N4 | N4mb | | +| | | | | | | | | | + +| | | | | | | | | | +|-----------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-----------------------------| +| Node ID | M | This IE shall contain the unique identifier of the sending Node. | X | X | X | X | X | Node ID | +| CP F-SEID | M | This IE shall contain the unique identifier allocated by the CP function identifying the session. | X | X | X | X | X | F-SEID | +| Create PDR | M | This IE shall be present for at least one PDR to be associated to the PFCP session.

Several IEs with the same IE type may be present to represent multiple PDRs.
See Table 7.5.2.2-1. | X | X | X | X | X | Create PDR | +| Create FAR | M | This IE shall be present for at least one FAR to be associated to the PFCP session.

Several IEs with the same IE type may be present to represent multiple FARs.
See Table 7.5.2.3-1. | X | X | X | X | X | Create FAR | +| Create URR | C | This IE shall be present if a measurement action shall be applied to packets matching one or more PDR(s) of this PFCP session.

Several IEs within the same IE type may be present to represent multiple URRs.
See Table 7.5.2.4-1. | X | X | X | X | - | Create URR | +| Create QER | C | This IE shall be present if a QoS enforcement or QoS marking action shall be applied to packets matching one or more PDR(s) of this PFCP session.

Several IEs within the same IE type may be present to represent multiple QERs.
See Table 7.5.2.5-1. | - | X | X | X | X | Create QER | +| Create BAR | O | When present, this IE shall contain the buffering instructions to be applied by the UP function to any FAR of this PFCP session set with the Apply Action requesting the packets to be buffered and with a BAR ID IE referring to this BAR. See table 7.5.2.6-1. | X | - | - | X | - | Create BAR | +| Create Traffic Endpoint | C | This IE may be present if the UP function has indicated support of PDI optimization.

Several IEs within the same IE type may be present to represent multiple Traffic Endpoints.
See Table 7.5.2.7-1. | X | X | X | X | X | Create Traffic Endpoint | +| PDN Type | C | This IE shall be present if the PFCP session is setup for an individual PDN connection or PDU session (see clause 5.2.1).

When present, this IE shall indicate whether this is an IP or non-IP PDN connection/PDU session or, for 5GC, an Ethernet PDU session. See NOTE 3. | X | X | - | X | - | PDN Type | +| SGW-C FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24]. | X | X | - | - | - | FQ-CSID | +| MME FQ-CSID | C | This IE shall be included when received on the S11 interface or on S5/S8 interface according to the requirements in clause 23 of 3GPP TS 23.007 [24]. | X | X | - | - | - | FQ-CSID | +| PGW-C/SMF FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24] and clause 4.6 of 3GPP TS 23.527 [40]. | X | X | - | X | - | FQ-CSID | +| ePDG FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24]. | - | X | - | - | - | FQ-CSID | +| TWAN FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24]. | - | X | - | - | - | FQ-CSID | +| User Plane Inactivity Timer | O | This IE may be present to request the UP function to send a User Plane Inactivity Report when no user plane packets are received for this PFCP session for a duration exceeding the User Plane Inactivity Timer. When present, it shall contain the duration of the inactivity period after which a User Plane Inactivity Report shall be generated. | - | X | X | X | X | User Plane Inactivity Timer | +| User ID | O | This IE may be present, based on operator policy. It shall only be sent if the UP function is in a trusted environment.
See NOTE 1. | X | X | X | X | - | User ID | +| Trace Information | O | When present, this IE shall contain the trace | X | X | X | X | - | Trace | + +| | | | | | | | | +|--|----------------------------------------------------------------------|--|--|--|--|--|-------------| +| | instructions to be applied by the UP function for this PFCP session. | | | | | | Information | +|--|----------------------------------------------------------------------|--|--|--|--|--|-------------| + +| | | | | | | | | | +|---------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------------------------| +| APN/DNN | O | This IE may be present, if related functionalities in the UP function require the APN/DNN information.
See NOTE 2.
This IE should be sent from the V-SMF to any V-UPF acting as (local) PSA for a HR-SBO PDU session and capable of enforcing NAT on N6 traffic. When present, it shall contain the full DNN of the PDU session (with the Operator ID part identifying the HPLMN ID). | X | X | - | X | X | APN/DNN | +| Create MAR | C | This IE shall be present for a N4 session established for a MA PDU session.

Several IEs with the same IE type may be present to represent multiple MARs.
See Table 7.5.2.8-1. | - | - | - | X | - | Create MAR | +| PFCPSEReq-Flags | C | This IE shall be included if at least one of the flags is set to "1".
| X | X | - | X | - | PFCPSEReq-Flags | +| Create Bridge/Router Info | C | This IE shall be present to request the UPF to provide Bridge/Router information for a PFCP session established for TSN, TSCTS or DetNet. | - | - | - | X | - | Create Bridge/router Info | +| Create SRR | O | This IE may be present to request the UPF to detect and report events not related to specific PDRs.
Several IEs within the same IE type may be present to represent multiple SRRs.
See Table 7.5.2.9-1. | - | - | - | X | - | Create SRR | +| Provide ATSSS Control Information | C | This IE shall be present for N4 session establishment for a MA PDU session.
When present, this IE shall contain the required ATSSS functionalities for this MA PDU session.
See Table 7.5.2.10-1. | - | - | - | X | - | Provide ATSSS Control Information | +| Recovery Time Stamp | O | This IE may be included to contain the time stamp when the CP function was started. (See clause 19A of 3GPP TS 23.007 [24].) | X | X | X | X | - | Recovery Time Stamp | +| S-NSSAI | O | This IE may be present, if related functionalities in the UP function require the S-NSSAI information.
(NOTE 2, NOTE 5)
When present, it shall indicate the S-NSSAI of the PDU session or MBS session. | - | - | - | X | X | S-NSSAI | +| HPLMN S-NSSAI | C | This IE should be sent from the V-SMF to any V-UPF acting as (local) PSA for a HR-SBO PDU session and capable of enforcing NAT on N6 traffic.
When present, it shall contain the HPLMN S-NSSAI. | - | - | - | X | - | HPLMN S-NSSAI | +| Provide RDS configuration information | O | When present, this IE shall contain the RDS configuration information to be applied by the UP function for this PFCP session. | - | X | - | X | - | Provide RDS configuration information | +| RAT Type | O | This IE may be present to provide the UP Function the current RAT Type for the PDN connection/PDU session to which this PFCP Session is corresponding for statistics purpose if the PFCP session is not established for a MA PDU session. | X | X | - | X | - | RAT Type | +| L2TP Tunnel Information | C | This IE shall be present if L2TP tunnel information is received from an AAA server, e.g. Radius/Diameter server or if it is configured in the CP function. | - | X | - | X | - | L2TP Tunnel Information | + +| | | | | | | | | | +|--------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|--------------------------------------| +| | | Several IE with the same IE type may be present to provide L2TP Tunnel Information for alternative LNS. | | | | | | | +| L2TP Session Information | C | This IE shall be present to include the information to establish a L2TP session, if an L2TP session needs to be established for this PFCP session. | - | X | - | X | - | L2TP Session Information | +| Group Id | O | This IE may be included by the CP function to indicate the group identifier to which the PFCP session pertains (see clause 5.22). | - | X | - | X | - | Group Id | +| MBS Session N4mb Control Information | M | This IE shall identify the MBS session, or the MBS session and Area Session ID for a location dependent MBS service, and it may contain further control information for the MB-UPF. | - | - | - | - | X | MBS Session N4mb Control Information | +| MBS Session N4 Control Information | C | This IE shall be included if the correspond PDU session shall be associated with an MBS session, or with an MBS session and Area Session ID for a location dependent MBS service.

Several IEs with the same IE type may be present to provide N4 control information for several MBS sessions, e.g., when the UE requests to join several MBS sessions. | - | - | - | X | - | MBS Session N4 Control Information | +| DSCP to PPI Control Information | O | This IE may be present if the UPF is required to insert the Paging Policy Indicator (PPI) in the GTP-U PDU Session Container extension header of outgoing GTP-U packets (encapsulating payload packets) based on the DSCP in the TOS/Traffic Class field in the IP header of payload packet and if the UPF supports the EPPPI feature as specified in clause 5.36.2.

Several IEs with the same IE type may be present to provide different DSCP to PPI Control Information for different set of QFI(s). | - | - | - | X | - | DSCP to PPI Control Information | +| TL-Container | C | This IE shall be present if the SMF/CUC needs to send a TL-Container to the UPF/CN-TL. | - | - | - | X | - | TL-Container | + +NOTE 1: This can be used for troubleshooting problems in the UP function affecting a subscriber. +NOTE 2: The CP function may provide additional information (e.g. APN/DNN, S-NSSAI) to the UP function, e.g. used by the forwarding rules pre-defined in UP function (some forwarding rules are APN specific), used by the UP function for performance measurement, used by the UP function for resource management, or used by the UPF to include a proper User plane node/Bridge ID in the response message during a PFCP session establishment for a PDU session for TSC. +NOTE 3: The SGW-C may set PDN type as Non-IP for an Ethernet PDN to allow interworking with a legacy SGW-U. +NOTE 4: The UP function shall accept the CP function allocated GTP-U F-TEID and/or UE IP address in the PFCP Session Establishment Request message with the RESTI flag set to "1", if the requested GTP-U F-TEID and/or UE IP address are available. If the GTP-U F-TEID or UE IP address provided by the CP function is not available at the UP function, the UP function shall reject the PFCP Session Establishment Request with the cause "PFCP session restoration failure due to requested resource not available" (see clause 8.2.1). +NOTE 5: A UPF shall support allocating resources using the Network Instance IE and the UPF may additionally support allocating resources using the Network Instance IE and S-NSSAI IE (see clause 5.35). + +**Table 7.5.2.1-2: L2TP Tunnel Information IE in the PFCP Session Establishment Request message** + +| Octet 1 and 2 | L2TP Tunnel Information IE Type = 276 (decimal) | | | | | | +|----------------------|-------------------------------------------------|---------------------|-------|------|------|-------| +| Octets 3 and 4 | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | +| | | | Sx a | Sx b | Sx c | N4 mb | + +| | | | | | | | | | +|-------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-------------------| +| LNS Address | M | This IE shall be present to include the Tunnel Server Endpoint, i.e. LNS IP address. | - | X | - | X | - | LNS Address | +| Tunnel Password | O | This IE may be present to include the password to be used to authenticate to a remote server. | - | X | - | X | - | Tunnel Password | +| Tunnel Preference | C | This IE shall be present if multiple L2TP Tunnel Information IEs are included in the message.

If present this IE indicates the order in which the L2TP Tunnel Information IEs shall be used when trying to establish the L2TP session. | - | X | - | X | - | Tunnel Preference | + +**Table 7.5.2.1-3: L2TP Session Information IE in the PFCP Session Establishment Request message** + +| Octet 1 and 2 | | L2TP Session Information IE Type = 277 (decimal) | | | | | | | +|--------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|--------------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Calling Number | O | This IE may be present, e.g. to include an MSISDN of the UE. | - | X | - | X | - | Calling Number | +| Called Number | O | This IE may be present, e.g. to include an APN/DNN. | - | X | - | X | - | Called Number | +| Maximum Receive Unit | O | This IE may be present to include Maximum Receive Unit for LCP/PPP which may be set to the value of the MTU received from the UE or may be configured in the CP function. | - | X | - | X | - | Maximum Receive Unit | +| L2TP Session Indications | C | This IE shall be present if the CP function requests the UP function to get a UE IP Address, and/or DNS server information, and/or NBNS server information from the LNS. | - | X | - | X | - | L2TP session Indications | +| L2TP User Authentication | O | This IE may be present to include the authentication information to be used during L2TP session establishment. | - | X | - | X | - | L2TP User Authentication | + +NOTE: The Tunnel Password and L2TP User Authentication IE are transferred with plain text, a Network Domain Security/IP based security mechanism may be deployed between the CP function and the UP function if required by the local policies. + +**Table 7.5.2.1-4: MBS Session N4mb Control Information IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | | MBS Session N4mb Control Information IE Type = 300 (decimal) | | | | | | | +|----------------------|---|--------------------------------------------------------------|-------|------|------|----|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | + +| | | | | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------------------| +| MBS Session Identifier | M | | - | - | - | - | X | MBS Session Identifier | +| Area Session ID | C | This IE shall be present for a location dependent MBS service. When present, it shall contain the Area Session ID, which together with the MBS Session Identifier, uniquely identify the service area part of the content data of the MBS service. | - | - | - | - | X | Area Session ID | +| MBSN4mbReq-Flags | C | This IE shall be included if at least one of the flags is set to "1". | - | - | - | - | X | MBSN4mbReq-Flags | +| Multicast Transport Information for N3mb and/or N19mb | C | This IE shall be present during the restoration of a PFCP session of an MBS session after an MB-UPF restart, as defined in clause 8.2.2 of 3GPP TS 23.527 [40].

When present, it shall include the low layer source specific multicast address information (i.e. multicast destination address and related source IP address) and the GTP-U Common Tunnel EndPoint Identifier (C-TEID) that the MB-SMF requests the MB-UPF to allocate for multicast transport over N3mb and/or N19mb, if possible. (NOTE) | - | - | - | - | X | Multicast Transport Information | +| NOTE: The MB-UPF shall accept the MB-SMF allocated N3mb/N19mb and/or the N6mb/Nmb9 address in the PFCP Session Establishment Request message with the MBS RESTI flag set to "1", if the requested addresses are available. If one requested address is not available at the MB-UPF, the MB-UPF shall reject the PFCP Session Establishment Request with the cause "PFCP session restoration failure due to requested resource not available" (see clause 8.2.1). | | | | | | | | | + +Table 7.5.2.1-5: MBS Session N4 Control Information IE within PFCP Session Establishment Request + +| Octet 1 and 2 | MBS Session N4 Control Information IE Type = 310 (decimal) | | | | | | +|----------------------|------------------------------------------------------------|---------------------|-------|------|------|-------| +| Octets 3 and 4 | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | +| | | | Sx a | Sx b | Sx c | N4 mb | + +| | | | | | | | | | +|---------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------------------| +| MBS Session Identifier | M | | - | - | - | X | - | MBS Session Identifier | +| Area Session ID | C | This IE shall be present for a location dependent MBS service. When present, it shall contain the Area Session ID, which together with the MBS Session Identifier, uniquely identify the service area part of the content data of the MBS service. | - | - | - | X | - | Area Session ID | +| Multicast Transport Information | C | This IE shall be present to include a low layer source specific multicast address information (i.e. multicast destination address and related source IP address) and a GTP-U Common Tunnel EndPoint Identifier (C-TEID) which was allocated by the MB-UPF, if IP multicast transport is used over N19mb. | - | - | - | X | - | Multicast Transport Information | + +**Table 7.5.2.1-6: DSCP to PPI Control Information IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | DSCP to PPI Control Information IE Type = 316 (decimal) | | | | | | | +|---------------------------------|---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|---------------------------------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| DSCP to PPI Mapping Information | M | This IE shall be present to instruct the UPF to insert the corresponding PPI for the downlink GTP-U packet, where the DSCP of its payload packet is matching one of DSCP codes in the DSCP to PPI Mapping Information.

Several IEs with the same IE type may be present to provide different DSCP to PPI mapping information. | - | - | - | X | DSCP to PPI Mapping Information | +| QFI | O | This IE may be present to request the UPF to only insert PPI for those packets pertain to the requested QoS flow(s).

Several IEs with the same IE type may be present to provide a list of QFIs.

(NOTE 1) | - | - | - | X | QFI | + +NOTE 1: The absence of QFI(s) indicates that insertion of the corresponding PPI shall be applied for all DL packets (matching the DSCP(s) of the DSCP to PPI Mapping Information IE) pertaining to all QoS flows of the PFCP session. + +## 7.5.2.2 Create PDR IE within PFCP Session Establishment Request + +The Create PDR grouped IE shall be encoded as shown in Figure 7.5.2.2-1. + +**Table 7.5.2.2-1: Create PDR IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | Create PDR IE Type = 1(decimal) | | | | | | | +|----------------------|---------------------------------|---------------------|-------|-----|-----|-------|---------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 mb | | + +| | | | | | | | | | +|-------------------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-------------------------------------------------------| +| PDR ID | M | This IE shall uniquely identify the PDR among all the PDRs configured for that PFCP session. | X | X | X | X | X | PDR ID | +| Precedence | M | This IE shall indicate the PDR's precedence to be applied by the UP function among all PDRs of the PFCP session, when looking for a PDR matching an incoming packet. | - | X | X | X | X | Precedence | +| PDI | M | This IE shall contain the PDI against which incoming packets will be matched.
See Table 7.5.2.2-2. | X | X | X | X | X | PDI | +| Outer Header Removal | C | This IE shall be present if the UP function is required to remove one or more outer header(s) from the packets matching this PDR. | X | X | - | X | X | Outer Header Removal | +| FAR ID | C | This IE shall be present if the Activate Predefined Rules IE is not included or if it is included but it does not result in activating a predefined FAR, and if the MAR ID is not included. This IE may be present if the CP function activated a predefined rule name with a predefined FAR but the CP function wishes to overwrite the predefined FAR by another FAR. (NOTE 2)
When present this IE shall contain the FAR ID to be associated to the PDR. | X | X | X | X | X | FAR ID | +| URR ID | C | This IE shall be present if a measurement action shall be applied to packets matching this PDR.
When present, this IE shall contain the URR IDs to be associated to the PDR.
Several IEs within the same IE type may be present to represent a list of URRs to be associated to the PDR. | X | X | X | X | - | URR ID | +| QER ID | C | This IE shall be present if a QoS enforcement or QoS marking action shall be applied to packets matching this PDR.
When present, this IE shall contain the QER IDs to be associated to the PDR. Several IEs within the same IE type may be present to represent a list of QERs to be associated to the PDR. | - | X | X | X | X | QER ID | +| Activate Predefined Rules | C | This IE shall be present if Predefined Rule(s) shall be activated for this PDR. When present this IE shall contain one Predefined Rules name.
Several IEs with the same IE type may be present to represent multiple "Activate Predefined Rules" names. | - | X | X | X | - | Activate Predefined Rules | +| Activation Time | O | This IE may be present if the PDR activation shall be deferred. (NOTE 1) | - | X | X | X | - | Activation Time | +| Deactivation Time | O | This IE may be present if the PDR deactivation shall be deferred. (NOTE 1) | - | X | X | X | - | Deactivation Time | +| MAR ID | C | This IE shall be present if the PDR is provisioned to match the downlink traffic of non-GBR QoS flows towards the UE for a PFCP session established for a MA PDU session. | - | - | - | X | - | MAR ID | +| Packet Replication and Detection Carry-On Information | C | This IE shall be present if the PDR is provisioned to match a broadcast packet. When present, it contains the information to instruct the UPF to replicate the packet and to carry-on the look-up of other PDRs of other PFCP sessions matching the packet (see clause 5.2.1). | - | - | - | X | - | Packet Replication and Detection Carry-On Information | +| IP Multicast Addressing Info | O | This IE may be present in an UL PDR controlling UL IGMP/MLD traffic (see 5.25).
When present, it shall contain a (range of) IP multicast address(es), and optionally source specific address(es), identifying a set of IP multicast flows. See Table 7.5.2.2-4.
Several IEs with the same IE type may be present to represent multiple IP multicast flows. | - | - | - | X | - | IP Multicast Addressing Info | +| UE IP address Pool Identity | O | This IE may be present if UE IP Addresses Pools are configured in the UPF.

When present, this IE shall contain the identity of a | - | X | - | X | - | UE IP address Pool Identity | + +| | | | | | | | | | +|---------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------------------| +| | | UE IP address Pool configured in the UPF.
Two IEs with the same IE type shall be present to represent UE IPv4 Address Pool Identity and UE IPv6 Address Pool Identity if different pool identities are used for UE IPv4 address and UE IPv6 address and both an UE IPv4 and an UE IPv6 address are requested to be assigned for the PFCP session. In this case, the UE IPv4 Address Pool Identity shall be encoded before the UE IPv6 Address Pool Identity. | | | | | | | +| Multipath Applicable Indication | C | This IE shall be present if the PDR is used to detect UL user plane traffic for which MPTCP or MPQUIC is applicable. | - | - | - | X | - | Multipath Applicable Indication | +| Transport Delay Reporting | C | This IE shall be present to request the UPF to add the delay of the GTP-U path with the preceding uplink GTP-U entity to the "N3/N9 Delay Result received in the GTP-U PDU Session Container extension header (see 3GPP TS 38.415 [34]) of the uplink packet, when monitoring the QoS of a PDU session based on GTP-U path monitoring (see clause 5.24.5.3). See Table 7.5.2.2-6. | - | - | - | X | - | Transport Delay Reporting | +| RAT Type | O | This IE may be present to provide the UP Function the current RAT Type for the UL PDR for statistics purpose if the PFCP session is established for a MA PDU session. | - | - | - | X | - | RAT Type | + +NOTE 1: When the Activation Time and Deactivation Time are not present, the PDR shall be activated immediately at receiving the message. + +NOTE 2: If a predefined FAR is or has been activated using a predefined rule name, it is UP function implementation specific whether this predefined FAR can be overwritten by a FAR ID pointing to another predefined FAR (i.e. with the most significant bit set to 1). If not, the UP function shall reject such a request if received from the CP function. + +**Table 7.5.2.2-2: PDI IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | PDI IE Type = 2 (decimal) | | | | | | +|----------------------|---------------------------|---------------------|-------|-----|-----|----------------| +| Octets 3 and 4 | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | +| | | | Sxa | Sxb | Sxc | N4
N4
mb | + +| | | | | | | | | | +|---------------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------------------------------| +| Source Interface | M | This IE shall identify the source interface of the incoming packet. | X | X | X | X | X | Source Interface | +| Local F-TEID | O | This IE shall not be present if Traffic Endpoint ID is present.
If present, this IE shall identify the local F-TEID to match for an incoming packet.
The CP function shall set the CHOOSE (CH) bit to 1 if the CP function requests the UP function to assign a local F-TEID to the PDR. | X | X | - | X | - | F-TEID | +| Local Ingress Tunnel | C | This IE shall not be present if Traffic Endpoint ID is present.
If present, this IE shall identify the IP address and the UDP port for a UDP/IP tunnel.

The CP function shall set the CHOOSE (CH) bit to 1 if the CP function requests the UP function to assign a local ingress tunnel to the PDR. | - | - | - | - | X | Local Ingress Tunnel | +| Network Instance | O | This IE shall not be present if Traffic Endpoint ID is present. It shall be present if the CP function requests the UP function to allocate a UE IP address/prefix and the Traffic Endpoint ID is not present.
If present, this IE shall identify the Network instance to match for the incoming packet. See NOTE 1, NOTE2. | X | X | X | X | X | Network Instance | +| Redundant Transmission Detection Parameters | O | If present, this IE shall contain the information used for the reception of redundant uplink packets on N3/N9 interfaces. | - | - | - | X | - | Redundant Transmission Detection Parameters | +| UE IP address | O | This IE shall not be present if Traffic Endpoint ID is present.
If present, this IE shall identify the UE IP address as the source or destination IP address to match for the incoming packet. (NOTE 5).

The CP function shall set the CHOOSE IPV4 (CHV4) and/or the CHOOSE IPV6 (CHV6) bits to 1 if the UP function supports the allocation of UE IP address/prefix and the CP function requests the UP function to assign a UE IP address/prefix to the PDR.

This IE may also present to identify the IP address of the CP function as the destination IP address to match for the incoming packet, e.g. Radius, Diameter or DHCP signalling packet. (NOTE 8).

In the 5GC, several IEs with the same IE type may be present to represent multiple UE IP addresses, if the UPF indicated support of the IP6PL feature (see clause 5.21). | - | X | X | X | - | UE IP address | +| Traffic Endpoint ID | C | This IE may be present if the UP function has indicated the support of PDI optimization.
If present, this IE shall uniquely identify the Traffic Endpoint for that PFCP session.

Several IEs with the same IE type may be present to provision several Traffic Endpoints with different Traffic Endpoint IDs, from which the UPF may receive packets pertaining to the same service data flow, which is subject for the same FAR, QER and URR, if the UPF has indicated it supports MTE feature as specified in clause 8.2.25. See NOTE 6. | X | X | X | X | X | Traffic Endpoint ID | +| SDF Filter | O | If present, this IE shall identify the SDF filter to match for the incoming packet. Several IEs with the same IE type may be present to provision a list of SDF Filters. The full set of applicable SDF filters, if any, shall be provided during the creation or the modification of the | - | X | X | X | X | SDF Filter | + +| | | | | | | | | +|--|---------------------|--|--|--|--|--|--| +| | PDI.
See NOTE 3. | | | | | | | +|--|---------------------|--|--|--|--|--|--| + +| | | | | | | | | | +|----------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|----------------------------------| +| Application ID | O | If present, this IE shall identify the Application ID to match for the incoming packet. | - | X | X | X | X | Application ID | +| Ethernet PDU Session Information | O | This IE may be present to identify all the (DL) Ethernet packets matching an Ethernet PDU session (see clause 5.13.1). | - | - | - | X | - | Ethernet PDU Session Information | +| Ethernet Packet Filter | O | If present, this IE shall identify the Ethernet PDU to match for the incoming packet.
Several IEs with the same IE type may be present to represent a list of Ethernet Packet Filters.
The full set of applicable Ethernet Packet filters, if any, shall be provided during the creation or the modification of the PDI. | - | - | - | X | - | Ethernet Packet Filter | +| QFI | O | This IE shall not be present if Traffic Endpoint ID is present and the QFI(s) are included in the Traffic Endpoint.
If present, this IE shall identify the QoS Flow Identifier to match for the incoming packet.
Several IEs with the same IE type may be present to provision a list of QFIs. When present, the full set of applicable QFIs shall be provided during the creation or the modification of the PDI. | - | - | - | X | - | QFI | +| Framed-Route | O | This IE may be present for a PDR if the UPF indicated support of Framed Routing (see clauses 8.2.25 and 5.16). If present, this IE shall describe a framed route.
Several IEs with the same IE type may be present to provision a list of framed routes. (NOTE 5) | - | X | - | X | - | Framed-Route | +| Framed-Routing | O | This IE may be present for a DL PDR if the UPF indicated support of Framed Routing (see clauses 8.2.25 and 5.16). If present, this IE shall describe the routing method for the UP function for the IP route related to Framed-Routes or Framed-IPv6-Routes. (NOTE 7) | - | X | - | X | - | Framed-Routing | +| Framed-IPv6-Route | O | This IE may be present for a PDR if the UPF indicated support of Framed Routing (see clauses 8.2.25 and 5.16). If present, this IE shall describe a framed IPv6 route.
Several IEs with the same IE type may be present to provision a list of framed IPv6 routes. (NOTE 5) | - | X | - | X | - | Framed-IPv6-Route | +| Source Interface Type | C | When present, this IE shall indicate the 3GPP interface type of the source interface.

This IE shall be present if this is a PDR for a DL data forwarding tunnel. Otherwise this IE may be present, if required by functionalities in the UP Function, e.g. for performance measurements. | X | X | - | X | X | 3GPP Interface Type | +| IP Multicast Addressing Info | O | This IE may be present in a DL PDR controlling DL IP multicast traffic (see clause 5.25).
When present, it shall contain a (range of) IP multicast address(es), and optionally source specific address(es), identifying a set of IP multicast flows.
See Table 7.5.2.2-4.
This IE shall be present over N4mb, if multicast transport is used over N6mb and if Traffic Endpoint ID is not present.
Several IEs with the same IE type may be present to represent multiple IP multicast flows. | - | - | - | X | X | IP Multicast Addressing Info | +| DNS Query Filter | O | This IE may be present for an UL PDR if the UPF indicated support of DNS traffic steering based on FQDN in the DNS Query message.
If present, this IE shall identify the DNS Query filter to match for the incoming DNS Query packets.
Several IEs with the same IE type may be present to provision a list of DNS Query Filters. The full set of applicable DNS Query filters, if any, shall be provided during the creation or the modification of the PDI. | - | - | - | X | - | DNS Query Filter | +| MBS Session | C | This IE shall be present when the PDR is created to | - | - | - | X | - | MBS Session | + +| | | | | | | | | | +|----------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|----------------------| +| Identifier | | receive MBS session data. (NOTE 9) | | | | | | Identifier | +| Area Session ID | C | This IE shall be present for a location dependent MBS service. When present, it shall contain the Area Session ID, which together with the MBS Session Identifier, uniquely identify the service area part of the content data of the MBS service. (NOTE 9) | - | - | - | X | - | Area Session ID | +| Protocol Description | O | This IE may be present to indicate the transport protocol (e.g. RTP/SRTP), transport protocol header extensions (e.g. RTP Header Extension for PDU Set Marking as defined in 3GPP TS 26.522 [79]), payload type and format (e.g. H.264, H.265) used by the packets matching this PDR when PDU Set marking and/or End of Data Burst marking applies to the QER (i.e. QoS flow) with which the PDR is associated. See Table 7.5.2.2-7. (NOTE 10) | - | - | - | X | - | Protocol Description | + +NOTE 1: The Network Instance parameter is needed e.g. in the following cases: +- PGW/TDF UP function supports multiple PDNs with overlapping IP addresses; +- SGW UP function is connected to PGWs in different IP domains (S5/S8); +- PGW UP function is connected to SGWs in different IP domains (S5/S8); +- SGW UP function is connected to eNodeBs in different IP domains; +- UPF is connected to 5G-ANs in different IP domains; +- Separation of multiple 5G VN groups communication in the UPF; +- Indirect data forwarding. + +NOTE 2: When a Local F-TEID is provisioned in the PDI, the Network Instance shall relate to the IP address of the F-TEID. Otherwise, the Network Instance shall relate to the UE IP address if provisioned or the destination IP address in the SDF filter if provisioned + +NOTE 3: SDF Filter IE(s) shall not be present if Ethernet Packet Filter IE(s) is present. + +NOTE 4: When several SDF filter IEs are provisioned, the UP function shall consider that the packets are matched if matching any SDF filter. The same principle shall apply for Ethernet Packet Filters and QFIs. + +NOTE 5: If both the UE IP Address and the Framed-Route (or Framed-IPv6-Route) are present, the packets which are considered being matching the PDR shall match at least one of them. + +NOTE 6: Maximum two Traffic Endpoint ID containing different Local TEIDs per PDI may be provisioned over the N4 interface for a PFCP session which is established for a PDU session subject for 5G to EPS mobility with N26 supported. Several Traffic Endpoint ID containing different UE IP Addresses may be provisioned over the N4 interface for a PFCP session if the UPF also indicated support of the IP6PL feature (see clause 5.21.1). + +NOTE 7: In this release of specification, the UP function shall announce the IP route(s) for Framed-Route(s) or Framed-IPv6-Route(s) to the PDN regardless of the value of the Framed-Routing. + +NOTE 8: The IP address of the CP function is needed e.g. perform Router Advertisements and match the destination IP address of the incoming packet if the Radius, Diameter or DHCP signaling packets between the SMF and the external DN is forwarded by the UPF. + +NOTE 9: The Inclusion of the MBS Session Identifier, or MBS Session Identifier and Area Session ID for a location dependent MBS session, enables the UPF to allocate the same N19mb tunnel for the same MBS Session, or for the same MBS session and Area Session ID for a location dependent MBS session, when receiving multiple PFCP Session Establishment or Modification Request messages for different PFCP sessions being associated with the same MBS session, or with the same MBS session and Area Session ID for a location dependent MBS session, and also helps the UPF to identify the PFCP sessions associated with a MBS Session, or with the same MBS session and Area Session ID for a location dependent MBS session. + +NOTE 10: The Protocol Description IE is not used for packets matching against the PDR but to assist PDU Set identification and/or End of Data Burst marking by the UPF. + +**Table 7.5.2.2-3: Ethernet Packet Filter IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | | Ethernet Packet Filter IE Type = 132 (decimal) | | | | | | +|----------------------|---|------------------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|----------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|----------------------------| +| Ethernet Filter ID | C | This shall be present if Bidirectional Ethernet filter is required. This IE shall uniquely identify an Ethernet Filter among all the Ethernet Filters provisioned for a given PFCP session. | - | - | - | X | - | Ethernet Filter ID | +| Ethernet Filter Properties | C | This IE shall be present when provisioning a bidirectional Ethernet Filter the first time (see clause 5.13.4). | - | - | - | X | - | Ethernet Filter Properties | +| MAC address | O | If present, this IE shall identify the MAC address. This IE may be present up to 16 times. | - | - | - | X | - | MAC address | +| Ethertype | O | If present, this IE shall identify the Ethertype. | - | - | - | X | - | Ethertype | +| C-TAG | O | If present, this IE shall identify the Customer-VLAN tag. | - | - | - | X | - | C-TAG | +| S-TAG | O | If present, this IE shall identify the Service-VLAN tag. | - | - | - | X | - | S-TAG | +| SDF Filter | O | If packet filtering is required, for Ethernet frames with Ethertype indicating IPv4 or IPv6 payload, this IE shall describe the IP Packet Filter Set. Several IEs with the same IE type may be present to represent a list of SDF filters. | - | - | - | X | - | SDF Filter | + +Table 7.5.2.2-4: IP Multicast Addressing Info IE within PFCP Session Establishment Request + +| Octet 1 and 2 | | IP Multicast Addressing Info IE Type = 188 (decimal) | | | | | | | +|----------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-----|-----|----|-------|----------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 | N4 mb | | +| IP Multicast Address | M | This IE shall contain the IP multicast address(es) of the DL multicast flow(s) or indicate "any" IP multicast address.

For N4mb, the IP Multicast Address shall be set to the value of IP Multicast Address in the SSM for the MBS Session. | - | - | - | X | X | IP Multicast Address | +| Source IP Address | O | When present, this IE shall contain the source specific IP address of the DL multicast flow. Several IEs with the same IE type may be present to represent multiple source specific addresses. If this IE is not present, this indicates "any" source IP address. | - | - | - | X | | Source IP Address | +| | M | This IE shall be set to the value of the IP Source Address in the SSM for the MBS Session. | - | - | - | - | X | | + +Table 7.5.2.2-5: Redundant Transmission Detection Parameters IE in PDI + +| Octet 1 and 2 | | Redundant Transmission Detection Parameters IE Type = 255 (decimal) | | | | | | | +|---------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-----|-----|----|-------|------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 | N4 mb | | +| Local F-TEID for Redundant Transmission | M | This IE shall identify the local F-TEID to match for an incoming packet for redundant transmission. The CP function shall set the CHOOSE (CH) bit to 1 if it requests the UP function to assign a local F-TEID to the PDR. | - | - | - | X | - | F-TEID | +| Network Instance for Redundant Transmission | C | This IE shall be included if the Local F-TEID for Redundant Transmission uses a different network Instance than the Network Instance used for the Local F-TEID for the primary GTP-U tunnel. | - | - | - | X | - | Network Instance | + +**Table 7.5.2.2-6: Transport Delay Reporting IE in Create PDR IE** + +| Octet 1 and 2 | | Transport Delay Reporting IE Type = 271 (decimal) | | | | | | +|-------------------------|---|---------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|-------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Preceding UL GTP-U Peer | M | This IE shall identify the preceding UL GTP-U peer. | - | - | - | X | Remote GTP-U Peer | +| DSCP | O | If present, this IE shall contain the DSCP to use to measure the GTP-U path delay with the preceding UL GTP-U peer. | - | - | - | X | Transport Level Marking | + +**Table 7.5.2.2-7: Protocol Description IE** + +| Octet 1 and 2 | | Protocol Description IE Type = 334 (decimal) | | | | | | +|----------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|----------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Transport Protocol | O | When present, it shall indicate the transport protocol used by the media flow. | - | - | - | X | Media Transport Protocol | +| RTP Header Extension Information | C | This IE shall be present if RTP or SRTP is used and the RTP payload packets contains a RTP Header Extension that can be used for PDU Set identification and/or End of Data Burst marking.

When present, this IE shall contain information on the RTP header extension that can be used for PDU Set identification and/or End of Data Burst marking. See Table 7.5.2.2-8.

(NOTE 1) | - | - | - | X | RTP Header Extension Information | +| RTP Payload Information | O | When present, it shall contain RTP Payload information for the RTP stream, which can be used to derive the PDU Set information and/or End of Data Burst marking. See Table 7.5.2.2-9.

Several IEs with the same IE type may be present to describe multiple RTP Payload Information.

(NOTE 1) (NOTE 2) | - | - | - | X | RTP Payload Information | + +NOTE 1: If the RTP Payload Information is present and contains one or more Payload Type values, the UPF may only parse the RTP packets with an RTP header containing any of these Payload Type value(s). Otherwise, if the RTP Payload Information is absent or does not contain any Payload Type value, the UPF should parse all the RTP packets of the media flow and use either the RTP Header Extension if included, or the Payload format to derive the PDU set information (see clause A.2 of 3GPP TS 26.522 [79]). + +NOTE 2: In this release of the specification, only one RTP Payload Information IE may be provisioned. + +NOTE 3: Vendor/operator specific attributes may be supported as defined in clauses 5.9 and 8.1.1. + +**Table 7.5.2.2-8: RTP Header Extension Information IE** + +| Octet 1 and 2 | | RTP Header Extension Information IE Type = 340 (decimal) | | | | | | +|----------------------|---|----------------------------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|-------------------------------------------------------------------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------------| +| RTP Header Extension Type | C | This IE shall be present if RTP or SRTP is used and the RTP payload packets contains a RTP Header Extension that can be used for PDU Set identification and/or End of Data Burst marking.

When present, it shall indicate the RTP header extension type. | - | - | - | X | - | RTP Header Extension Type | +| RTP Header Extension ID | C | This IE shall be present if the RTP Header Extension Type IE is present.

When present, the RTP Header Extension ID shall be set to the Id of the RTP header extension identified by the RTP Header Extension Type IE, as defined in RFC 8285 [86]. | - | - | - | X | - | RTP Header Extension ID | +| NOTE: Vendor/operator specific attributes may be supported as defined in clauses 5.9 and 8.1.1. | | | | | | | | | + +**Table 7.5.2.2-9: RTP Payload Information IE** + +| Octet 1 and 2 | | RTP Payload Information IE Type = 341 (decimal) | | | | | | | +|----------------------------------------------------------------------------------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|--------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| RTP Payload Type | C | This IE shall be present when the RTP Payload Format is present, otherwise it may be present.

When present, this IE shall contain the list of Payload Type (PT) values in the RTP header of RTP packets the UPF may parse to derive the PDU Set Information.

Several IEs with the same IE type may be present to describe multiple Payload Types.

(NOTE) | - | - | - | X | - | RTP Payload Type | +| RTP Payload Format | O | This IE may be present when the media flow does not use any RTP Header Extension for PDU Set identification.

When present, it shall indicate the RTP Payload format as defined in 3GPP TS 26.522 [79].
(NOTE) | - | - | - | X | - | RTP Payload Format | +| NOTE: The RTP Payload Type(s) shall correspond to the RTP Payload Format if the RTP Payload Format is present. | | | | | | | | | + +### 7.5.2.3 Create FAR IE within PFCP Session Establishment Request + +The Create FAR grouped IE shall be encoded as shown in Figure 7.5.2.3-1. + +**Table 7.5.2.3-1: Create FAR IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | | Create FAR IE Type = 3 (decimal) | | | | | | | +|----------------------|---|----------------------------------|-------|-----|-----|----|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 | N4 mb | | + +| | | | | | | | | | +|----------------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|----------------------------------------------| +| FAR ID | M | This IE shall uniquely identify the FAR among all the FARs configured for that PFCP session. | X | X | X | X | X | FAR ID | +| Apply Action | M | This IE shall indicate the action to apply to the packets. See clauses 5.2.1 and 5.2.3. | X | X | X | X | X | Apply Action | +| Forwarding Parameters | C | This IE shall be present when the Apply Action requests the packets to be forwarded. It may be present otherwise.

When present, this IE shall contain the forwarding instructions to be applied by the UP function when the Apply Action requests the packets to be forwarded.
See table 7.5.2.3-2. | X | X | X | X | - | Forwarding Parameters | +| Duplicating Parameters | C | This IE shall be present when the Apply Action requests the packets to be duplicated. It may be present otherwise.

When present, this IE shall contain the forwarding instructions to be applied by the UP function for the traffic to be duplicated, when the Apply Action requests the packets to be duplicated.

Several IEs with the same IE type may be present to represent to duplicate the packets to different destinations. See NOTE 1.

See table 7.5.2.3-3. | X | X | - | - | - | Duplicating Parameters | +| BAR ID | O | When present, this IE shall contain the BAR ID of the BAR defining the buffering instructions to be applied by the UP function when the Apply Action requests the packets to be buffered. | X | - | - | X | - | BAR ID | +| Redundant Transmission Forwarding Parameters | C | This IE shall be present when the Apply Action requests the packets to be duplicated for redundant transmission and the Forwarding Parameters IE is included. It may be present otherwise.

When present, this IE shall contain the forwarding instructions to be applied by the UP function for the traffic to be duplicated, when the Apply Action requests the packets to be duplicated for redundant transmission. Except for the parameters included in the Redundant Transmission Parameters IE, the duplicated packets shall apply the same parameters as those indicated in the Forwarding Parameters IE.

See table 7.5.2.3-4. | - | - | - | - | - | Redundant Transmission Forwarding Parameters | +| MBS Multicast Parameters | C | This IE shall be present when the Apply Action is set to "FSSM". This requests the MB-UPF to forward the MBS session data to a Low Layer SSM. | - | - | - | - | X | MBS Multicast Parameters | +| Add MBS Unicast Parameters | C | This IE shall be present when the Apply Action is set to "MBSU". This requests the MB-UPF to forward the MBS session data to a remote GTP-U peer for unicast transport.

Several IEs with the same IE type may be present to request the MB-UPF to forward the MBS session data to multiple remote GTP-U peers. | - | - | - | - | X | Add MBS Unicast Parameters | + +NOTE 1: The same user plane packets may be required, according to operator's policy and configuration, to be duplicated to different SX3LIFs. + +Table 7.5.2.3-2: Forwarding Parameters IE in FAR + +| Octet 1 and 2 | Forwarding Parameters IE Type = 4 (decimal) | | | | | | +|----------------------|---------------------------------------------|---------------------|-------|----|----|----| +| Octets 3 and 4 | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | +| | | | Sx | Sx | Sx | N4 | + +| | | | | | | | | | +|--|--|--|----------|----------|----------|--|-----------|--| +| | | | a | b | c | | mb | | +|--|--|--|----------|----------|----------|--|-----------|--| + +| | | | | | | | | | +|--------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|--------------------------------| +| Destination Interface | M | This IE shall identify the destination interface of the outgoing packet. | X | X | X | X | - | Destination Interface | +| Network Instance | O | When present, this IE shall identify the Network instance towards which to send the outgoing packet. See NOTE 1. | X | X | X | X | - | Network Instance | +| Redirect Information | C | This IE shall be present if the UP function is required to enforce traffic redirection towards a redirect destination provided by the CP function. | - | X | X | X | - | Redirect Information | +| Outer Header Creation | C | This IE shall be present if the UP function is required to add one or more outer header(s) to the outgoing packet. If present, it shall contain the F-TEID of the remote GTP-U peer when adding a GTP-U/UDP/IP header, or the Destination IP address and/or Port Number when adding a UDP/IP header or an IP header or the C-TAG/S-TAG (for 5GC). See NOTE 2. | X | X | - | X | - | Outer Header Creation | +| Transport Level Marking | C | This IE shall be present if the UP function is required to mark the IP header with the DSCP marking as defined by IETF RFC 2474 [22]. When present for EPC, it shall contain the value of the DSCP in the TOS/Traffic Class field set based on the QCI, and optionally the ARP priority level, of the associated EPS bearer, as described in clause 5.10 of 3GPP TS 23.214 [2]. When present for 5GC, it shall contain the value of the DSCP in the TOS/Traffic Class field set based on the 5QI, the Priority Level (if explicitly signalled), and optionally the ARP priority level, of the associated QoS flow, as described in clause 5.8.2.7 of 3GPP TS 23.501 [28]. | X | X | - | X | - | Transport Level Marking | +| Forwarding Policy | C | This IE shall be present if a specific forwarding policy is required to be applied to the packets. It shall be present if the Destination Interface IE is set to SGi-LAN / N6-LAN. It may be present if the Destination Interface is set to Core, Access, or CP-Function. See NOTE 2. When present, it shall contain an Identifier of the Forwarding Policy locally configured in the UP function. | - | X | X | X | - | Forwarding Policy | +| Metadata | O | This IE may be included to provide the metadata by the AF which the UPF needs to add to traffic sent over a Service Function Chain.

How the UPF transforms the metadata into actual information sent with the traffic (e.g., in the encapsulation header) is based on local policies related with the Forwarding Policy and not specified. | - | - | - | X | - | Metadata | +| Header Enrichment | O | This IE may be present if the UP function indicated support of Header Enrichment of UL traffic. When present, it shall contain information for header enrichment. | - | X | X | X | - | Header Enrichment | +| Linked Traffic Endpoint ID | C | This IE may be present, if it is available and the UP function indicated support of the PDI optimisation feature, (see clause 8.2.25). When present, it shall identify the Traffic Endpoint ID allocated for this PFCP session to receive the traffic in the reverse direction (see clause 5.2.3.1). | X | X | - | X | - | Traffic Endpoint ID | +| Proxying | C | This IE shall be present if proxying is to be performed by the UP function.

When present, this IE shall contain the information that the UPF shall respond to Address Resolution Protocol and / or IPv6 Neighbour Solicitation based on the local cache information for the Ethernet PDUs. | - | - | - | X | - | Proxying | +| Destination Interface Type | C | When present, this IE shall indicate the 3GPP interface type of the destination interface.

This IE shall be present if this is a FAR for a DL data forwarding tunnel. Otherwise this IE may be present, if required by functionalities in the UP Function, e.g. for performance measurements. | X | X | - | X | - | 3GPP Interface Type | +| Data Network Access Identifier | C | This IE shall be present over N16a to link the UL FAR in an UL CL or BP towards a specific local PSA, if more than one local PSA has been inserted by an I-SMF. It | - | - | - | - | - | Data Network Access Identifier | + +| | | | | | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|----------------------------------------| +| | | may be present over N16a otherwise. This IE shall not be sent over N4.
When present, it shall be set to the DNAI associated to the local PSA towards which the UL traffic shall be forwarded. | | | | | | | +| IP Address and Port Number Replacement | C | This IE shall be present if the UP function indicated support of replacing the source and destination IP address and Port Number of an (inner) IP packet, and if the source or destination IP address and/or port number of the (Inner) IP packet shall be modified, e.g. for Edge Relocation using EAS IP address and Port number Replacement (see clause 5.33.3).

This IE shall also be present if the destination IP address and/or port number of the (Inner) IP packet shall be modified, e.g. for EAS Discovery procedure with Local DNS Server/Resolver using Local DNS Server/Resolver IP address and Port number Replacement (see clause 5.33.4).
(NOTE 3) | - | - | - | X | - | IP Address and Port Number Replacement | +| NOTE 1: The Network Instance parameter is needed e.g. in the following cases:
- PGW/TDF UP function supports multiple PDNs with overlapping IP addresses;
- SGW UP function is connected to PGWs in different IP domains (S5/S8);
- PGW UP function is connected to SGWs in different IP domains (S5/S8);
- SGW UP function is connected to eNodeBs in different IP domains;
- UPF is connected to 5G-ANs in different IP domains;
- Separation of multiple 5G VN groups communication in the UPF;
- Indirect data forwarding. | | | | | | | | | +| NOTE 2: If the Outer Header Creation and Forwarding Policy are present, the UP function shall put the user plane packets in the user plane tunnel by applying Outer Header Creation, after enforcing the required Forwarding Policy. | | | | | | | | | +| NOTE 3: As opposed to the Outer Header Creation IE, this IE does not result in adding any outer header to the outgoing packet. | | | | | | | | | + +Table 7.5.2.3-3: Duplicating Parameters IE in FAR + +| Octet 1 and 2 | | Duplicating Parameters IE Type = 5 (decimal) | | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|-------------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Destination Interface | M | This IE shall identify the destination interface of the outgoing packet. | X | X | - | - | - | Destination Interface | +| Outer Header Creation | C | This IE shall be present if the UP function is required to add one or more outer header(s) to the outgoing packet. If present, it shall contain the F-TEID of the remote GTP-U peer. See NOTE 1. | X | X | - | - | - | Outer Header Creation | +| Transport Level marking | C | This IE shall be present if the UP function is required to mark the IP header with the DSCP marking as defined by IETF RFC 2474 [22]. When present, it shall contain the value of the DSCP in the TOS/Traffic Class field. | X | X | - | - | - | Transport Level Marking | +| Forwarding Policy | C | This IE shall be present if a specific forwarding policy is required to be applied to the packets. When present, it shall contain an Identifier of the Forwarding Policy locally configured in the UP function. | X | X | - | - | - | Forwarding Policy | +| NOTE 1: If the Outer Header Creation and Forwarding Policy are present, the UP function shall put the user plane packets in the user plane tunnel by applying Outer Header Creation, after enforcing the required Forwarding Policy. | | | | | | | | | + +Table 7.5.2.3-4: Redundant Transmission Forwarding Parameters IE in FAR + +| Octet 1 and 2 | | Redundant Transmission Forwarding Parameters IE Type = 270 (decimal) | | | | | | | +|----------------------|---|----------------------------------------------------------------------|-------|----|----|----|----|---------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx | Sx | Sx | N4 | N4 | | + +| | | | a | b | c | | mb | | +|---------------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|----|-----------------------| +| Outer Header Creation | M | This IE shall be present if the UP function is required to perform the redundant transmission of the outgoing packet.
If present, it shall contain the F-TEID of the remote GTP-U peer for redundant transmission. | - | - | - | X | - | Outer Header Creation | +| Network Instance for Redundant Transmission | C | This IE shall be included if the GTP-U tunnel used for redundant transmission uses a different network Instance than the Network Instance used for the primary GTP-U tunnel. | - | - | - | X | - | Network Instance | + +Table 7.5.2.3-5: MBS Multicast Parameters IE in the Create FAR IE + +| Octet 1 and 2 | | MBS Multicast Parameters IE Type = 301 (decimal) | | | | | | | +|----------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-----|-----|----|-------|-------------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 | N4 mb | | +| Destination Interface | M | This IE shall identify the destination interface of the outgoing packet. | - | - | - | - | X | Destination Interface | +| Network Instance | O | When present, this IE shall identify the Network instance towards which to send the outgoing packet. | - | - | - | - | X | Network Instance | +| Outer Header Creation | M | This IE shall instruct the MB-UPF to create a GTP-U header using the Low Layer SSM and the C-TEID allocated to the MBS session. | - | - | - | - | X | Outer Header Creation | +| Transport Level marking | C | This IE shall be present if the UP function is required to mark the IP header with the DSCP marking as defined by IETF RFC 2474 [22]. When present, it shall contain the value of the DSCP in the TOS/Traffic Class field. | - | - | - | - | X | Transport Level Marking | +| Destination Interface Type | O | This IE may be present to indicate the 3GPP interface type of the destination interface, if required by functionalities in the UP Function, e.g. for performance measurements.

Several IEs with the same IE type may be present to represent multiple destination interface types (e.g. N3mb and N19mb). | - | - | - | - | X | 3GPP Interface Type | + +Table 7.5.2.3-6: Add MBS Unicast Parameters IE in the Create FAR IE + +| Octet 1 and 2 | | Add MBS Unicast Parameters IE Type = 302 (decimal) | | | | | | | +|----------------------|---|----------------------------------------------------|-------|-----|-----|----|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 | N4 mb | | + +| | | | | | | | | | +|----------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------------| +| Destination Interface | M | This IE shall identify the destination interface of the outgoing packet. | - | - | - | - | X | Destination Interface | +| MBS Unicast Parameters ID | M | This IE shall identify the MBS Unicast Parameters IE. | - | - | - | - | X | MBS Unicast Parameters ID | +| Network Instance | O | When present, this IE shall identify the Network instance towards which to send the outgoing packet. | - | - | - | - | X | Network Instance | +| Outer Header Creation | M | This IE shall be present to request the MB-UPF to add one outer header to the outgoing packet. It shall contain the F-TEID of the remote GTP-U peer when adding a GTP-U/UDP/IP header. | - | - | - | - | X | Outer Header Creation | +| Transport Level marking | C | This IE shall be present if the UP function is required to mark the IP header with the DSCP marking as defined by IETF RFC 2474 [22]. When present, it shall contain the value of the DSCP in the TOS/Traffic Class field. | - | - | - | - | X | Transport Level Marking | +| Destination Interface Type | O | This IE may be present to indicate the 3GPP interface type of the destination interface, if required by functionalities in the UP Function, e.g. for performance measurements. | - | - | - | - | X | 3GPP Interface Type | + +### 7.5.2.4 Create URR IE within PFCP Session Establishment Request + +The Create URR grouped IE shall be encoded as shown in Figure 7.5.2.4-1. + +**Table 7.5.2.4-1: Create URR IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | Create URR IE Type = 6 (decimal) | | | | | | | +|----------------------|----------------------------------|---------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|------------------------------| +| URR ID | M | This IE shall uniquely identify the URR among all the URRs configured for this PFCP session. | X | X | X | X | - | URR ID | +| Measurement Method | M | This IE shall indicate the method for measuring the network resources usage, i.e. whether the data volume, duration (i.e. time), combined volume/duration, or event shall be measured. | X | X | X | X | - | Measurement Method | +| Reporting Triggers | M | This IE shall indicate the trigger(s) for reporting network resources usage to the CP function, e.g. periodic reporting or reporting upon reaching a threshold, or envelope closure, or when an SMF instructs an UPF to report the reception of the End Marker packet from the old I-UPF during a Service Request procedure (see clauses 4.2.3.2 and 4.23.4.3 in 3GPP TS 23.502 [29]). | X | X | X | X | - | Reporting Triggers | +| Measurement Period | C | This IE shall be present if periodic reporting is required. When present, it shall indicate the period for generating and reporting usage reports. | X | X | X | X | - | Measurement Period | +| Volume Threshold | C | This IE shall be present if volume-based measurement is used and reporting is required upon reaching a volume threshold. When present, it shall indicate the traffic volume value after which the UP function shall report network resources usage to the CP function for this URR. | X | X | X | X | - | Volume Threshold | +| Volume Quota | C | This IE shall be present if volume-based measurement is used and the CP function needs to provision a Volume Quota in the UP function (see clause 5.2.2.2). When present, it shall indicate the Volume Quota value. | - | X | X | X | - | Volume Quota | +| Event Threshold | C | This IE shall be present if event-based measurement is used and reporting is required upon reaching an event threshold. When present, it shall indicate the number of events after which the UP function shall report to the CP function for this URR. | - | X | X | X | - | Event Threshold | +| Event Quota | C | This IE shall be present if event-based measurement is used and the CP function needs to provision an Event Quota in the UP function (see clause 5.2.2.2). When present, it shall indicate the Event Quota value. | - | X | X | X | - | Event Quota | +| Time Threshold | C | This IE shall be present if time-based measurement is used and reporting is required upon reaching a time threshold. When present, it shall indicate the time usage after which the UP function shall report network resources usage to the CP function for this URR. | X | X | X | X | - | Time Threshold | +| Time Quota | C | This IE shall be present if time-based measurement is used and the CP function needs to provision a Time Quota in the UP function (see clause 5.2.2.2). When present, it shall indicate the Time Quota value. | - | X | X | X | - | Time Quota | +| Quota Holding Time | C | This IE shall be present, for a time, volume or event-based measurement, if reporting is required and packets are no longer permitted to pass on when no packets are received during a given inactivity period. When present, it shall contain the duration of the inactivity period. | - | X | X | X | - | Quota Holding Time | +| Dropped DL Traffic Threshold | C | This IE shall be present if reporting is required when the DL traffic being dropped exceeds a threshold. When present, it shall contain the threshold of the DL traffic being dropped. | X | - | - | X | - | Dropped DL Traffic Threshold | +| Quota Validity Time | C | This IE shall be present if reporting is required when the Quota Validity time for a given Quota is over. | - | X | - | X | - | Quota Validity Time | +| Monitoring Time | O | When present, this IE shall contain the time at which the UP function shall re-apply the volume or time threshold. | X | X | X | X | - | Monitoring Time | +| Subsequent Volume Threshold | O | This IE may be present if the Monitoring Time IE is present and volume-based measurement is used. When present, it shall indicate the traffic volume value after which the UP function shall report network resources usage to the CP function for this URR for the period after the Monitoring Time. | X | X | X | X | - | Subsequent Volume Threshold | +| Subsequent Time Threshold | O | This IE may be present if the Monitoring Time IE is present and time-based measurement is used. When present, it shall indicate the time usage after which the UP function shall report network resources usage to the CP function for this URR for the period after the | X | X | X | X | - | Subsequent Time Threshold | + +| | | | | | | | | +|--|------------------|--|--|--|--|--|--| +| | Monitoring Time. | | | | | | | +|--|------------------|--|--|--|--|--|--| + +| | | | | | | | | | +|----------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|----------------------------| +| Subsequent Volume Quota | O | This IE may be present if Monitoring Time IE is present and volume-based measurement is used (see clause 5.2.2.2).
When present, it shall indicate the Volume Quota value which the UP function shall use for this URR for the period after the Monitoring Time. | - | X | X | X | - | Subsequent Volume Quota | +| Subsequent Time Quota | O | This IE may be present if Monitoring Time IE is present and time-based measurement is used (see clause 5.2.2.2).
When present, it shall indicate the Time Quota value which the UP function shall use for this URR for the period after the Monitoring Time. | - | X | X | X | - | Subsequent Time Quota | +| Subsequent Event Threshold | O | This IE may be present if the Monitoring Time IE is present and event-based measurement is used.
When present, it shall indicate the number of events after which the UP function shall report to the CP function for this URR for the period after the Monitoring Time. | - | X | X | X | - | Subsequent Event Threshold | +| Subsequent Event Quota | O | This IE may be present if Monitoring Time IE is present and event-based measurement is used (see clause 5.2.2.2).
When present, it shall indicate the Event Quota value which the UP function shall use for this URR for the period after the Monitoring Time. | - | X | X | X | - | Subsequent Event Quota | +| Inactivity Detection Time | C | This IE shall be present if time-based measurement is used and the time measurement need to be suspended when no packets are received during a given inactivity period. When present, it shall contain the duration of the inactivity period. | - | X | X | X | - | Inactivity Detection Time | +| Linked URR ID | C | This IE shall be present if linked usage reporting is required. When present, this IE shall contain the linked URR ID which is related with this URR (see clause 5.2.2.4).
Several IEs with the same IE type may be present to represent multiple linked URRs which are related with this URR. | - | X | X | X | - | Linked URR ID | +| Measurement Information | C | This IE shall be included if any of the following flag is set to "1".
Applicable flags are:
| - | X | X | X | - | Measurement Information | + +| | | | | | | | | | +|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|--| +| | | be set to "1" by the CP function if the UP Function is requested to send a Start Pause of Charging indication to the upstream GTP-U entity(s) when the Dropped DL Traffic Threshold is reached. | X | - | - | X | - | | +| | | - Applicable for Start of Pause of Charging Flag: this flag may be set to "1" if the URR is applicable for Start of Pause of Charging, so that the UP function shall stop the usage measurement for the URR when receiving Start Pause of Charging indication from the peer downstream GTP-U entity. | - | X | - | X | - | | +| | | - Control of Inactive Measurement Flag: the flag shall be set to "1" if the CP function requests the UP function to stop or resume the usage measurement for the URR with the "ASPOC" flag set to "1" according to the value of Inactive Measurement Flag. | - | X | - | X | - | | + +| | | | | | | | | | +|------------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-----------------------------| +| Time Quota Mechanism | C | This IE shall be present if time-based measurement based on CTP or DTP is used. | - | X | - | - | - | Time Quota Mechanism | +| Aggregated URRs | C | This IE shall be included if the URR is used to support a Credit Pool.

Several IEs with the same IE type may be present to provide multiple aggregated URRs. | - | X | - | - | - | Aggregated URRs | +| FAR ID for Quota Action | C | This IE may be present if the Volume Quota IE and/or the Time Quota IE and/or Event Quota IE is provisioned in the URR and the UP Function indicated support of the Quota Action feature.
When present, it shall contain the identifier of the substitute FAR the UP function shall apply, for the traffic associated to this URR, when exhausting any of these quotas. See NOTE 1, NOTE 3. | - | X | X | X | - | FAR ID | +| Ethernet Inactivity Timer | C | This IE shall be present if Ethernet traffic reporting is used and the SMF requests the UP function to also report inactive UE MAC addresses.
When present, it shall contain the duration of the Ethernet inactivity period. | - | - | - | X | - | | +| Additional Monitoring Time | O | When present, this IE shall contain the time at which the UP function shall re-apply the volume or time or event threshold/quota provisioned in the IE.

Several IEs with the same IE type may be present to provide multiple Monitoring Times. | X | X | X | X | - | Additional Monitoring Time | +| Number of Reports | O | This IE may be present if the UP function supports the NORP feature. When present, it shall indicate the number of usage reports to be generated by the URR. See also clauses 5.2.2.2.1 and 5.2.2.3.1. See NOTE 2. | X | X | X | X | - | Number of Reports | +| Exempted Application ID for Quota Action | O | This IE may be present if the Volume Quota IE and/or the Time Quota IE and/or Event Quota IE is provisioned in the URR and the UP Function has indicated support of the QUASF feature as specified in clause 8.2.25.

When present, it shall contain an Application ID matching packets that shall be exempted from applying the FAR ID for Quota Action when the quota has been exhausted.

Several IEs with the same IE type may be present to provide multiple Application IDs.

See NOTE 4. | - | X | X | X | - | Application ID | +| Exempted SDF Filter for Quota Action | O | This IE may be present if the Volume Quota IE and/or the Time Quota IE and/or Event Quota IE is provisioned in the URR and the UP Function has indicated support of the QUASF feature as specified in clause 8.2.25.

When present, it shall contain an SDF Filter matching packets that shall be exempted from applying the FAR ID for Quota Action when the quota has been exhausted.

Several IEs with the same IE type may be present to provide multiple SDF Filters.

See NOTE 4. | - | X | X | X | - | SDF Filter | +| User Plane Inactivity Timer | C | This IE shall be present, for a time, volume or event-based measurement, if reporting is required when no packets are received for any PDR(s) associated with the URR during a given inactivity period. See clause 5.11.3.
When present, it shall contain the duration of the inactivity period. | - | - | - | X | - | User Plane Inactivity Timer | + +NOTE 1: The substitute FAR used when exhausting a Volume Quota or Time Quota may be set to drop the packets, buffer the packets or redirect the traffic towards a redirect destination as specified in clause 5.4.7. + +NOTE 2: This IE may be provisioned and set to "1" e.g. for a URR with the Dropped DL Traffic Threshold used for the Pause of Charging feature, if the UP function supports the NORP feature. + +| | | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 3: | If the FAR as indicated in the FAR ID for Quota Action is removed after being provisioned, the UP function shall behave as if the FAR ID for Quota Action is not provisioned and shall apply the default behaviour per local configuration when the quota is exhausted. | +| NOTE 4: | The Exempted Application ID for Quota Action IE or Exempted Filter ID for Quota Action IE may be provisioned as the Restricted-Filter-Rule AVP or Filter ID AVP which is included in Final-Unit-Indication AVP from the online charging system when the Final-Unit-Action AVP is set to "REDIRECT" or "RESTRICT_ACCESS". See also 3GPP TS 32.299 [18]. | + +**Table 7.5.2.4-2: Aggregated URRs** + +| Octet 1 and 2 | | Aggregated URRs = 118 (decimal) | | | | | | +|----------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|-------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Aggregated URR ID | M | This IE shall be present for the aggregated URR ID of the URR sharing the credit pool. | - | X | - | - | Aggregated URR ID | +| Multiplier | M | This IE shall be included to measure the abstract service units the traffic of the corresponding aggregated URR consumes from the credit pool. | - | X | - | - | Multiplier | + +**Table 7.5.2.4-3: Additional Monitoring Time** + +| Octet 1 and 2 | | Additional Monitoring Time = 147 (decimal) | | | | | | +|----------------------|---|--------------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|-----------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-----------------------------| +| Monitoring Time | M | This IE shall be present and contain the time at which the UP function shall re-apply the volume or time threshold/quota. | X | X | X | X | - | Monitoring Time | +| Subsequent Volume Threshold | O | This IE may be present if the Monitoring Time IE is present and volume-based measurement is used. When present, it shall indicate the traffic volume value after which the UP function shall report network resources usage to the CP function for this URR for the period after the Monitoring Time. | X | X | X | X | - | Subsequent Volume Threshold | +| Subsequent Time Threshold | O | This IE may be present if the Monitoring Time IE is present and time-based measurement is used. When present, it shall indicate the time usage after which the UP function shall report network resources usage to the CP function for this URR for the period after the Monitoring Time. | X | X | X | X | - | Subsequent Time Threshold | +| Subsequent Volume Quota | O | This IE may be present if Monitoring Time IE is present and volume-based measurement is used (see clause 5.2.2.2). When present, it shall indicate the Volume Quota value which the UP function shall use for this URR for the period after the Monitoring Time. | - | X | X | X | - | Subsequent Volume Quota | +| Subsequent Time Quota | O | This IE may be present if Monitoring Time IE is present and time-based measurement is used (see clause 5.2.2.2). When present, it shall indicate the Time Quota value which the UP function shall use for this URR for the period after the Monitoring Time. | - | X | X | X | - | Subsequent Time Quota | +| Subsequent Event Threshold | O | This IE may be present if the Monitoring Time IE is present and event-based measurement is used. When present, it shall indicate the number of events after which the UP function shall report to the CP function for this URR for the period after the Monitoring Time. | - | X | X | X | - | Event Threshold | +| Subsequent Event Quota | O | This IE may be present if Monitoring Time IE is present and event-based measurement is used (see clause 5.2.2.2). When present, it shall indicate the Event Quota value which the UP function shall use for this URR for the period after the Monitoring Time. | - | X | X | X | - | Event Quota | + +### 7.5.2.5 Create QER IE within PFCP Session Establishment Request + +The Create QER grouped IE shall be encoded as shown in Figure 7.5.2.5-1. + +**Table 7.5.2.5-1: Create QER IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | | Create QER IE Type = 7 (decimal) | | | | | | +|----------------------|---|----------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|--------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|--------------------| +| QER ID | M | This IE shall uniquely identify the QER among all the QER configured for that PFCP session | - | X | X | X | X | QER ID | +| QER Correlation ID | C | This IE shall be present if the UP function is required to correlate the QERs of several PFCP sessions, for APN-AMBR enforcement/APN rate control of multiple UE's PDN connections to the same APN. | - | X | - | X | - | QER Correlation ID | +| Gate Status | M | This IE shall indicate whether the packets are allowed to be forwarded (the gate is open) or shall be discarded (the gate is closed) in the uplink and/or downlink directions. | - | X | X | X | X | Gate Status | +| Maximum Bitrate | C | This IE shall be present if an MBR enforcement action shall be applied to packets matching this PDR. When present, this IE shall indicate the uplink and/or downlink maximum bit rate to be enforced for packets matching the PDR.

For EPC, this IE may be set to the value of:
- the APN-AMBR, for a QER that is referenced by all the PDRs of the non-GBR bearers of a PDN connection;
- the TDF session MBR, for a QER that is referenced by all the PDRs of a TDF session;
- the bearer MBR, for a QER that is referenced by all the PDRs of a bearer;
- the SDF MBR, for a QER that is referenced by all the PDRs of a SDF.

For 5GC, this IE may be set to the value of:
- the Session-AMBR, for a QER that is referenced by all the PDRs of the non-GBR QoS flows of a PDU session;
- the QoS Flow MBR, for a QER that is referenced by all the PDRs of a QoS Flow;
- the SDF MBR, for a QER that is referenced by all the PDRs of a SDF. | - | X | X | X | X | MBR | +| Guaranteed Bitrate | C | This IE shall be present if a GBR has been authorized to packets matching this PDR. When present, this IE shall indicate the authorized uplink and/or downlink guaranteed bit rate.

This IE may be set to the value of:
- the aggregate GBR, for a QER that is referenced by all the PDRs of a GBR bearer;
- the QoS Flow GBR, for a QER that is referenced by all the PDRs of a QoS Flow (for 5GC);
- the SDF GBR, for a QER that is referenced by all the PDRs of a SDF. | - | X | X | X | X | GBR | +| Packet Rate | C | This IE shall be present if a Packet Rate enforcement action (in terms of number of packets per time interval) shall be applied to packets matching this PDR. When present, this IE shall indicate the uplink and/or downlink maximum packet rate to be enforced for packets matching the PDR.

This IE may be set to the value of:
- downlink packet rate for Serving PLMN Rate Control, for a QER that is referenced by all PDRs of the UE belonging to the PDN connection, or belonging to the PDU session (5GC) using CIoT EPS Optimizations as described in 3GPP TS 23.401 [2] and 3GPP TS 23.501 [28], respectively;
- uplink and/or downlink packet rate for APN Rate Control, for a QER that is referenced by all the PDRs of the UE belonging to all PDN connections to the same APN, or for Small Data Rate Control (5GC) for a QER related to the PDU session using CIoT EPS Optimizations as described in 3GPP TS 23.401 [2] and 3GPP TS 23.501 [28], | - | X | - | X | - | Packet Rate | + +| | | | | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-------------------------| +| | | respectively. | | | | | | | +| Packet Rate Status | C | This IE may be present during the UE requested PDU session establishment, or UE requested PDN connection establishment.
When present, the UP function shall first enforce these rules. Only after that shall the UP function enforce the rules in the Packet Rate IE. | - | X | - | X | - | Packet Rate Status | +| DL Flow Level Marking | C | This IE shall be set if the UP function is required to mark the packets for QoS purposes:
| - | X | X | - | - | DL Flow Level Marking | +| QoS flow identifier | C | This IE shall be present if the QoS flow identifier shall be inserted or modified by the UPF or shall be inserted by the MB-UPF. (NOTE 2) | - | - | - | X | X | QFI | +| Reflective QoS | C | This IE shall be present if the UP function is required to insert a Reflective QoS Indicator to request reflective QoS for uplink traffic. | - | - | - | X | - | RQI | +| Paging Policy Indicator | C | This IE shall be present if the UPF is required to set the Paging Policy Indicator (PPI) in outgoing packets (see clause 5.4.3.2 of 3GPP TS 23.501 [28]).
When present, it shall be set to the PPI value to set. | - | - | - | X | - | Paging Policy Indicator | +| Averaging Window | O | This IE may be present if the UP function is required to use a different Averaging window than the default one. (NOTE 1) | - | - | - | X | - | Averaging Window | +| QER Control Indications | C | This IE shall be included if the CP function needs to provide the QoS enforcement control information:
| - | X | - | X | - | QER Control Indications | +| QER Indications | C | This IE shall be included if at least one of the flags is set to "1".
| - | - | - | - | X | QER Indications | +| NOTE 1: For a GBR QoS flow, as 5QI is not signalled over N4, one default averaging window shall be pre-configured in the UPF. For Non-GBR QoS Flows, e.g., for the measurement of the Session-AMBR, the averaging window to be used (if not received over N4) is implementation specific. | | | | | | | | | +| NOTE 2: The SMF may request the UPF to modify the QFI of downlink packets of a multicast QoS flow received from the MB-UPF to the QFI assigned by the SMF for the Associated QoS flow. See clause 5.34.3.2. | | | | | | | | | + +### 7.5.2.6 Create BAR IE within PFCP Session Establishment Request + +The Create BAR grouped IE shall be encoded as shown in Figure 7.5.2.6-1. + +**Table 7.5.2.6-1: Create BAR IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | Create BAR IE Type = 85 (decimal) | | | | | | | +|-----------------------------------|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|---------|-----------------------------------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | IE Type | | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| BAR ID | M | This IE shall uniquely identify the BAR provisioned for that PFCP session. | X | - | - | X | BAR ID | +| Downlink Data Notification Delay | C | This IE shall be present if the UP function indicated support of the Downlink Data Notification Delay parameter (see clause 8.2.28) and the UP function has to delay the notification to the CP function about the arrival of DL data packets.
When present, it shall contain the delay the UP function shall apply between receiving a downlink data packet and notifying the CP function about it, when the Apply Action parameter requests to buffer the packets and notify the CP function. | X | - | - | - | Downlink Data Notification Delay | +| Suggested Buffering Packets Count | C | This IE may be present if the UP Function indicated support of the feature UDBC.
When present, it shall contain the number of packets that are suggested to be buffered when the Apply Action parameter requests to buffer the packets. The packets that exceed the limit shall be discarded. | - | X | X | X | Suggested Buffering Packets Count | +| MT-EDT Control Information | O | This IE may be included to request the SGW-U to report the sum of DL Data Packets Size. | X | - | - | - | MT-EDT Control Information | + +### 7.5.2.7 Create Traffic Endpoint IE within PFCP Session Establishment Request + +The Create Traffic Endpoint grouped IE shall be encoded as shown in Figure 7.5.2.7-1. + +**Table 7.5.2.7-1: Create Traffic Endpoint IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | Create Traffic Endpoint IE Type = 127(decimal) | | | | | | +|----------------------|------------------------------------------------|---------------------|-------|-----|-----|---------| +| Octets 3 and 4 | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 mb | + +| | | | | | | | | | +|---------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------------------------------| +| Traffic Endpoint ID | M | This IE shall uniquely identify the Traffic Endpoint for that PFCP session. | X | X | X | X | X | Traffic Endpoint ID | +| Local F-TEID | O | If present, this IE shall identify the local F-TEID to match for an incoming packet.
The CP function shall set the CHOOSE (CH) bit to 1 if the CP function requests the UP function to assign a local F-TEID to the Traffic Endpoint. | X | X | - | X | - | F-TEID | +| Network Instance | O | This IE shall be present if the CP function requests the UP function to allocate a UE IP address/prefix. If present, this IE shall identify the Network instance to match for the incoming packet. See NOTE 1, NOTE 2. | X | X | X | X | X | Network Instance | +| Redundant Transmission Detection Parameters | O | If present, this IE shall contain the information used for the reception of redundant uplink packets on N3/N9 interfaces.
See Table 7.5.2.2-5. | - | - | - | X | - | Redundant Transmission Detection Parameters | +| UE IP address | O | If present, this IE shall identify the UE IP address as the source or destination IP address to match for the incoming packet. (NOTE 3).

The CP function shall set the CHOOSE IPV4 (CHV4) and/or CHOOSE IPV6 (CHV6) bits to 1 if the UP function supports the allocation of UE IP address/ prefix and the CP function requests the UP function to assign a UE IP address/prefix to the Traffic Endpoint.

This IE may also present to identify the IP address of the CP function as the destination IP address to match for the incoming packet, e.g. Radius, Diameter or DHCP signalling packet. (NOTE 6).

In the 5GC, several IEs with the same IE type may be present to represent multiple UE IP addresses, if the UPF indicated support of the IP6PL feature (see clause 5.21). | - | X | X | X | - | UE IP address | +| Ethernet PDU Session Information | O | This IE may be present to identify all the (DL) Ethernet packets matching an Ethernet PDU session (see clause 5.13.1). | - | - | - | X | - | Ethernet PDU Session Information | +| Framed-Route | O | This IE may be present for a PDR if the UPF indicated support of Framed Routing (see clauses 8.2.25 and 5.16). If present, this IE shall describe a framed route.

Several IEs with the same IE type may be present to provision a list of framed routes. (NOTE 3) | - | X | - | X | - | Framed-Route | +| Framed-Routing | O | This IE may be present for a DL PDR if the UPF indicated support of Framed Routing (see clauses 8.2.25 and 5.16). If present, this IE shall describe the routing method for the UP function for the IP route related to Framed-Routes or Framed-IPv6-Routes. (NOTE 5) | - | X | - | X | - | Framed-Routing | +| Framed-IPv6-Route | O | This IE may be present for a PDR if the UPF indicated support of Framed Routing (see clauses 8.2.25 and 5.16). If present, this IE shall describe a framed IPv6 route.
Several IEs with the same IE type may be present to provision a list of framed IPv6 routes. (NOTE 3) | - | X | - | X | - | Framed-IPv6-Route | +| QFI | O | This IE may be present if the UPF has indicated it supports MTE feature as specified in clause 8.2.25.

If present, this IE shall identify the QoS Flow Identifier to match for the incoming packet received from the traffic endpoint.

Several IEs with the same IE type may be present | - | - | - | X | - | QFI | + +| | | | | | | | | | +|------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|------------------------------| +| | | to provision a list of QFIs. When present, the full set of applicable QFIs shall be provided. | | | | | | | +| Source Interface Type | C | When present, this IE shall indicate the 3GPP interface type of the source interface.

This IE shall be present if this is a Traffic Endpoint for a DL data forwarding tunnel. Otherwise this IE may be present, if required by functionalities in the UP Function, e.g. for performance measurements. (NOTE 4) | X | X | - | X | X | 3GPP Interface Type | +| Local Ingress Tunnel | C | This IE shall be present over N4mb, for Nmb9, or for N6mb if unicast transport is used over N6mb, if Traffic Endpoint ID is present in the DL PDR.

If present, this IE shall identify the IP address and the UDP port for a UDP/IP tunnel.

The CP function shall set the CHOOSE (CH) bit to 1 if the CP function requests the UP function to assign a local ingress tunnel to the PDR. | - | - | - | - | X | Local Ingress Tunnel | +| IP Multicast Addressing Info | C | This IE shall be present over N4mb, if multicast transport is used over N6mb, if Traffic Endpoint ID is present in the DL PDR.
See Table 7.5.2.2-4. | - | - | - | - | X | IP Multicast Addressing Info | +| MBS Session Identifier | C | This IE shall be present when the PDR is created to receive MBS session data. (NOTE 7) | - | - | - | X | - | MBS Session Identifier | +| Area Session ID | C | This IE shall be present for a location dependent MBS service. When present, it shall contain the Area Session ID, which together with the MBS Session Identifier, uniquely identify the service area part of the content data of the MBS service. (NOTE 7) | - | - | - | X | - | Area Session ID | +| RAT Type | O | This IE may be present to provide the UP Function the current RAT Type for the UL PDR(s) for statistics purpose if the PFCP session is established for a MA PDU session. | - | - | - | X | - | RAT Type | + +NOTE 1: The Network Instance parameter is needed e.g. in the following cases: + +- PGW/TDF UP function supports multiple PDNs with overlapping IP addresses; +- SGW UP function is connected to PGWs in different IP domains (S5/S8); +- PGW UP function is connected to SGWs in different IP domains (S5/S8); +- SGW UP function is connected to eNodeBs in different IP domains; +- UPF is connected to 5G-ANs in different IP domains; +- Separation of multiple 5G VN groups communication in the UPF. + +NOTE 2: When a Local F-TEID is provisioned in the Traffic Endpoint, the Network Instance shall relate to the IP address of the F-TEID. Otherwise, the Network Instance shall relate to the UE IP address. + +NOTE 3: If both the UE IP Address and the Framed-Route (or Framed-IPv6-Route) are present, the packets which are considered being matching the PDR shall match at least one of them. + +NOTE 4: If the Source Interface Type is provisioned at the traffic endpoint, it shall not be provisioned in individual PDRs associated to the traffic endpoint. + +NOTE 5: In this release of specification, the UP function shall announce the IP route(s) for Framed-Route(s) or Framed-IPv6-Route(s) to the PDN regardless of the value of the Framed-Routing. + +NOTE 6: The CP IP Address parameter is needed e.g. perform Router Advertisements and match the destination IP address of the incoming packet if the Radius, Diameter or DHCP signaling packets between the SMF and the external DN is forwarded by the UPF. + +NOTE 7: The Inclusion of the MBS Session Identifier, or MBS Session Identifier and Area Session ID for a location dependent MBS session, enables the UPF to allocate the same N19mb tunnel for the same MBS Session, or for the same MBS Session Identifier and Area Session ID for a location dependent MBS session, when receiving multiple PFCP Session Establishment or Modification Request messages for different PFCP sessions being associated with the same MBS session, or with the same MBS session and Area Session ID for a location dependent MBS session, and also helps the UPF to identify the PFCP sessions associated with a MBS Session, or with the same MBS session and Area Session ID for a location dependent MBS session. + +### 7.5.2.8 Create MAR IE within PFCP Session Establishment Request + +The Create MAR grouped IE shall be encoded as shown in Figure 7.5.2.8-1. + +**Table 7.5.2.8-1: Create MAR IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | | Create MAR IE Type = 165 (decimal) | | | | | | +|-----------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|-----------------------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| MAR ID | M | This IE shall uniquely identify the MAR among all the MARs configured for that PFCP session. | - | - | - | X | MAR ID | +| Steering Functionality | M | This IE shall be present to indicate the applicable traffic steering functionality. | - | - | - | X | Steering Functionality | +| Steering Mode | M | This IE shall be present to indicate the steering mode. | - | - | - | X | Steering Mode | +| 3GPP Access Forwarding Action Information | C | This IE shall be present to provision 3GPP access specific forwarding action information if the UE is registered for 3GPP access, except when steering mode is set to "Active-Standby", Non-3GPP access is the active access and 3GPP access is not used as Standby access. In the latter case, this IE may be present.
(NOTE) | - | - | - | X | 3GPP Access Forwarding Action Information | +| Non-3GPP Access Forwarding Action Information | C | This IE shall be present to provision non-3GPP access specific forwarding action information if the UE is registered for non-3GPP access, except when steering mode is set to "Active-Standby", 3GPP access is the active access and Non-3GPP access is not used as Standby access. In the latter case, this IE may be present.
(NOTE 1) | - | - | - | X | Non-3GPP Access Forwarding Action Information | +| Threshold Values | C | This IE shall be present if the steering mode is "Load Balancing" with fixed split percentages or "Priority-based" and if available. This IE may also be present if the steering mode is "Redundant".

When present, this IE shall contain the RTT and/or a Packet Loss Rate. If the Steering Mode is Redundant, either a (maximum) RTT or a (maximum) Packet Loss Rate may be provided, but not both.
(NOTE 2) | - | - | - | X | Thresholds | +| Steering Mode Indicator | C | This IE shall be included if at least one of the flags is set to "1":

(NOTE 2) | - | - | - | X | Steering Mode Indicator | +| Transport Mode | C | This IE shall be present to indicate the transport mode of the MPQUIC functionality, if the Steering Functionality is set to the MPQUIC functionality. In all other cases, this IE shall be absent. | - | - | - | X | Transport Mode | + +NOTE 1: For the "Active-Standby" steering mode, if the network determines to not define a Standby access (as specified in clause 5.32.8 of 3GPP TS 23.501 [28]), the SMF shall either set the Priority IE within (Non-)3GPP Access Forwarding Action Information IE to the value "No Standby" or not include the (Non-)3GPP Access Forwarding Action Information IE for that access not defined as Standby access. + +NOTE 2: The Threshold Values IE and the Steering Mode Indicator IE shall not be present together. + +**Table 7.5.2.8-2: 3GPP Access Forwarding Action Information IE in the Create MAR IE** + +| Octet 1 and 2 | | 3GPP Access Forwarding Action Information 1 IE Type = 166 (decimal) | | | | | | +|----------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|----------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| FAR ID | M | This IE shall uniquely identify the FAR among all the FARs configured for this PFCP session. | - | - | - | X | FAR ID | +| Weight | C | This IE shall be present if steering mode is set to "Load Balancing" to identify the weight of the FAR. (NOTE 1) | - | - | - | X | Weight | +| Priority | C | This IE shall be present if the steering mode is set to "Active-Standby" or "Priority-based". This IE may be present if the steering mode is set to "Redundant". (NOTE 2) | - | - | - | X | Priority | +| URR ID | C | This IE shall uniquely identify the URR among all the URRs configured for the PFCP session. This enables the SMF to request separate usage reports for different FARs (i.e. different accesses) (NOTE 3)

Several IEs within the same IE type may be present to represent a list of URRs to be associated to the FAR. | - | - | - | X | URR ID | +| RAT Type | O | This IE may be present to provide the UP Function the current RAT Type for the DL FAR for statistics purpose. | - | - | - | X | RAT Type | + +NOTE 1: The weights for all FARs included in both 3GPP Access Forwarding Action Information and Non 3GPP Access Forwarding Action Information need to sum up to 100. If the autonomous load balance operation is allowed, the Weights shall be treated as the default percentages. + +NOTE 2: The Priority value shall be set to "Active", "Standby" or "No Standby" if the Steering Mode is set to "Active-Standby". The Priority value shall be set to "High" or "Low" if the Steering Mode is set to "Priority-based". The Priority value shall be set to "Primary" or "Secondary" if the Steering Mode is set to "Redundant" and if the Priority IE is present. The 3GPP Access Forwarding Action Information and Non 3GPP Access Forwarding Action Information shall set different values; for the Redundant Steering Mode, this requirement shall apply only if the Priority IE is present. + +NOTE 3: One or more URRs may still be provisioned in the Create PDR IE when an MAR ID is present, while the URR(s) provisioned in this IE shall present a different set of URR(s) to request separate usage reports. + +**Table 7.5.2.8-3: Non-3GPP Access Forwarding Action Information IE in the Create MAR IE** + +| Octet 1 and 2 | | Non-3GPP Access Forwarding Action Information IE Type = 167 (decimal) | | | | | | +|---------------------------------------------------------|---|-----------------------------------------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Same IEs and requirements as defined in Table 7.5.2.8-2 | | | | | | | | + +## 7.5.2.9 Create SRR IE within PFCP Session Establishment Request + +The Create SRR grouped IE shall be encoded as shown in Figure 7.5.2.9-1. + +**Table 7.5.2.9-1: Create SRR IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | | Create SRR IE Type = 212 (decimal) | | | | | | +|----------------------|---|------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------------------------------------| +| SRR ID | M | This IE shall uniquely identify the SRR among all the SRRs configured for this PFCP session. | - | - | - | X | - | SRR ID | +| Access Availability Control Information | C | This IE shall be present if the UPF needs to report when an access type becomes available or not available (see clause 5.20.4.2). | - | - | - | X | - | Access Availability Control Information | +| QoS Monitoring per QoS flow Control Information | C | This IE shall be present if per QoS Flow QoS monitoring reporting is triggered.
Several IEs within the same IE type may be present to represent a list of QoS Monitoring per QoS flow Control Information for different QoS flows, or for different QoS parameters of a same QoS flow (see clause 5.39.2). | - | - | - | X | - | QoS Monitoring per QoS flow Control Information | +| Direct Reporting Information | C | This IE shall be present if the UPF indicated support of the DRQOS feature and if the QoS monitoring events shall be reported by the UPF directly to a Local NEF or AF, or both to the SMF and Local NEF/AF (see clause 5.33.5).
(NOTE) | - | - | - | X | - | Direct Reporting Information | +| Traffic Parameter Measurement Control Information | C | This IE shall be present if the SMF requests the UPF to perform Traffic Parameter measurement for one or more QoS Flows. See clauses 5.37 and 5.38.4.

Several IEs within the same IE type may be present to represent a list of Traffic Parameter Measurement Control Information for different QoS flows or different traffic parameters. | - | - | - | X | - | Traffic Parameter Measurement Control Information | +| NOTE: In this release of the specification, the Direct Reporting Information shall only be used for direct reporting of QoS monitoring per QoS flow. | | | | | | | | | + +The Access Availability Control Information IE shall be encoded as shown in Table 7.5.2.9-2. + +**Table 7.5.2.9-2: Access Availability Control Information** + +| | | | | | | | | +|-------------------------------------------|---------------------------------------------------------|------------------------------------------------------------------|-------|------|------|---------|-------------------------------------------| +| Octet 1 and 2 | Access Availability Control Information = 216 (decimal) | | | | | | | +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | IE Type | | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | +| Requested Access Availability Information | M | This IE shall indicate the requested information to be reported. | - | - | - | X | Requested Access Availability Information | + +The QoS Monitoring per QoS flow Control Information IE shall be encoded as shown in Table 7.5.2.9-3. + +**Table 7.5.2.9-3: QoS Monitoring per QoS flow Control Information** + +| | | | | | | | | +|----------------------|-----------------------------------------------------------------|---------------------|-------|------|------|---------|-------| +| Octet 1 and 2 | QoS Monitoring per QoS flow Control Information = 242 (decimal) | | | | | | | +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | IE Type | | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | +| | | | | | | | | + +| | | | | | | | | | +|---------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------------| +| QFI | M | This IE shall identify the QoS Flow Identifier for which QoS monitoring is required.
Several IEs within the same IE type may be present to represent different QoS flows. | - | - | - | X | - | QFI | +| Requested QoS Monitoring | M | This IE shall indicate the QoS parameter(s) to be measured.
For packet delay monitoring, it shall indicate whether the uplink, downlink and/or round trip packet delay between the UE and the UPF (PSA) shall be monitored, and whether QoS monitoring is performed based on GTP-U path monitoring.
For data rate monitoring, it shall indicate whether the uplink and/or downlink data rate shall be monitored. | - | - | - | X | - | Requested QoS Monitoring | +| Reporting Frequency | M | This IE shall indicate the type of reporting, i.e. event triggered or periodic QoS monitoring reporting. | - | - | - | X | - | Reporting Frequency | +| Packet Delay Thresholds | C | This IE shall be present if the Requested QoS Monitoring indicates packet delay monitoring, event triggered QoS monitoring reporting is used and reporting is required upon reaching a delay threshold. When present, it shall indicate the packet delay after which the UP function shall report packet delay monitoring result to the CP function or Local NEF or AF for this SRR. | - | - | - | X | - | Packet Delay Thresholds | +| Minimum Wait Time | C | This IE shall be present if event triggered QoS monitoring reporting is required. When present, it shall indicate the minimum waiting time between two consecutive reports after which the UP function may report new QoS monitoring result to the CP function or Local NEF or AF for this SRR. | - | - | - | X | - | Minimum Wait Time | +| Measurement Period | C | This IE shall be present if Periodic QoS monitoring reporting or, for packet delay monitoring, if Event Triggered QoS monitoring reporting is required.
When present, it shall indicate the period for generating and reporting QoS monitoring reports (if periodic QoS monitoring reporting is required) and, for packet delay monitoring, the period used for detecting and reporting a QoS monitoring measurement failure (if Periodic QoS monitoring reporting or Event Triggered QoS monitoring reporting is required). (NOTE 1) (NOTE 2) | - | - | - | X | - | Measurement Period | +| Reporting Suggestion Info | C | This IE should be present if the event report can be delayed, i.e. it is delay tolerant. | - | - | - | X | - | Reporting Suggestion Info | +| Measurement Indication | C | This IE shall be included if at least one of the flags is set to "1".
- DQFI (Default QoS Flow Indication): this bit shall be set to "1" if the QoS flow to be monitored is associated with the default QoS rule and the UPF shall include the same indication in the corresponding QoS Monitoring Measurement report. See also clause 4.15.4.5.1 of 3GPP TS 23.502 [29]. | - | - | - | X | - | Measurement Indication | + +NOTE 1: For packet delay monitoring, if no time stamp is received in uplink packet for a delay exceeding the Measurement Period (i.e. no measurement result is available in the UPF within the reporting period), the UP function shall generate a QoS monitoring report indicating a packet delay measurement failure to the SMF or Local NEF or AF. + +NOTE 2: For packet delay monitoring, SMF implementations complying with an earlier version of the specification may not support providing the Measurement Period if the Reporting Frequency IE is set to Event Triggered QoS monitoring reporting. If so, it is implementation specific whether/how the UPF generates QoS monitoring measurement failure report. + +The Direct Reporting Information IE shall be encoded as shown in Table 7.5.2.9-4. + +**Table 7.5.2.9-4: Direct Reporting Information** + +| Octet 1 and 2 | | Direct Reporting Information = 295 (decimal) | | | | | | +|-----------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----------|-----------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 N4 mb | | +| Event Notification URI | M | This IE shall contain the notification URI to be used for sending the UPF event notifications. | - | - | - | X | Event Notification URI | +| Notification Correlation ID | C | This IE shall indicate the notification correlation id to be included in the UPF event notifications. It shall be present if it is available. | - | - | - | X | Notification Correlation ID | +| Reporting Flags | C | This IE shall be included if at least one of the flags is set to "1".
- DUPL (Duplicate notification): this IE shall be set to "1" if event notifications shall be sent over N4 and directly to the notification URI indicated in the Event Notification URI IE. When this flag is set to "0", this indicates that the UPF shall only send the event notifications directly to the notification URI indicated in the Event Notification URI IE. | - | - | - | X | Reporting Flags | + +The Traffic Parameter Measurement Control Information IE shall be encoded as shown in Table 7.5.2.9-5. + +**Table 7.5.2.9-5.: Traffic Parameter Measurement Control Information IE** + +| Octet 1 and 2 | | Traffic Parameter Measurement Control Information IE Type = 323 (decimal) | | | | | | +|------------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|------------------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| QFI | M | This IE shall identify the QoS Flow Identifier for which traffic parameter is requested to be measured.

Several IEs within the same IE type may be present to represent different QoS flows. | - | - | - | X | QFI | +| Traffic Parameter Measurement Indication | M | This IE shall be included to indicate the requested traffic parameter measurement(s), as follows:
| - | - | - | X | Traffic Parameter Measurement Indication | +| Measurement Period | C | This IE shall be present if Periodic traffic parameter measurement reporting is required.

When present, it shall indicate the period for generating and reporting traffic parameter measurement reports.
(NOTE) | - | - | - | X | Measurement Period | +| DL Periodicity | C | This IE shall be present, if N6 jitter measurement is requested and if the DL Periodicity is available. When available, it shall contain the DL Periodicity to perform Jitter measurement. | - | - | - | X | DL Periodicity | +| Traffic Parameter Threshold | C | This IE shall be present if Traffic Parameter measurement reporting is required only upon reaching a threshold.

When present, and if N6 jitter measurement is requested, it shall contain the Downlink N6 Jitter threshold after which the UP function shall report N6 Jitter measurement to the SMF.
(NOTE) | - | - | - | X | Traffic Parameter Threshold | + +NOTE: Either a Measurement Period or a Traffic Parameter Threshold shall be present. + +### 7.5.2.10 Provide ATSSS Control Information IE within PFCP Session Establishment Request + +The Provide ATSSS Control Information grouped IE shall be encoded as shown in Figure 7.5.2.10-1. + +**Table 7.5.2.10-1: Provide ATSSS Control Information IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | | Provide ATSSS Control Information IE Type = 220 (decimal) | | | | | | +|----------------------|---|-----------------------------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|------------------------------|---|--------------------------------------------------------------------------------------------------------------|---|---|---|---|---|------------------------------| +| MPTCP Control Information | C | This IE shall be present if the PDU session is an MA PDU session and the MPTCP functionality is required. | - | - | - | X | - | MPTCP Control Information | +| ATSSS-LL Control Information | C | This IE shall be present if the PDU session is an MA PDU session and the ATSSS-LL functionality is required. | - | - | - | X | - | ATSSS-LL Control Information | +| PMF Control Information | C | This IE shall be present if the PDU session is an MA PDU session and the PMF functionality is required. | - | - | - | X | - | PMF Control Information | +| MPQUIC Control Information | C | This IE shall be present if the PDU session is an MA PDU session and the MPQUIC functionality is required. | - | - | - | X | - | MPQUIC Control Information | + +### 7.5.2.11 Provide RDS Configuration Information IE within PFCP Session Establishment Request + +The Provide RDS Configuration Information IE shall be encoded as shown in Figure 7.5.2.11-1. + +**Table 7.5.2.11-1: Provide RDS Configuration Information IE within PFCP Session Establishment Request** + +| Octet 1 and 2 | | Provide RDS Configuration Information IE Type = 261 (decimal) | | | | | | | +|-------------------------------|---|--------------------------------------------------------------------|-------|------|------|----|-------|-------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| RDS Configuration Information | O | When present, this IE indicates if the RDS mechanism is supported. | - | X | - | X | - | RDS Configuration Information | + +## 7.5.3 PFCP Session Establishment Response + +### 7.5.3.1 General + +The PFCP Session Establishment Response shall be sent over the Sxa, Sxb, Sxc and N4 interface by the UP function to the CP function as a reply to the PFCP Session Establishment Request. + +**Table 7.5.3.1-1: Information Elements in a PFCP Session Establishment Response** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|---------------------|-------|-----|-----|----|-------|---------| +| | | | Sxa | Sxb | Sxc | N4 | N4 mb | | +| | | | | | | | | | + +| | | | | | | | | | +|-------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-------------------------------| +| Node ID | M | This IE shall contain the unique identifier of the sending Node. | X | X | X | X | X | Node ID | +| Cause | M | This IE shall indicate the acceptance, partial acceptance or rejection of the corresponding request message. | X | X | X | X | X | Cause | +| Offending IE | C | This IE shall be included if the rejection is due to a conditional or mandatory IE missing or faulty. | X | X | X | X | X | Offending IE | +| UP F-SEID | C | This IE shall be present if the cause is set to "Request accepted (success)". When present, it shall contain the unique identifier allocated by the UP function identifying the session. | X | X | X | X | X | F-SEID | +| Created PDR | C | This IE shall be present if the cause is set to "success" and the UP function was requested to allocate a local F-TEID or a UE IP address/prefix for the PDR. When present, this IE shall contain the PDR information associated to the PFCP session. There may be several instances of this IE. See table 7.5.3.2-1. | X | X | - | X | X | Created PDR | +| Load Control Information | O | The UP function may include this IE if it supports the load control feature and the feature is activated in the network. See Table 7.5.3.3-1. | X | X | X | X | X | Load Control Information | +| Overload Control Information | O | During an overload condition, the UP function may include this IE if it supports the overload control feature and the feature is activated in the network. See Table 7.5.3.4-1. | X | X | X | X | X | Overload Control Information | +| PGW-U/SGW-U /UPF FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24] and clause 4.6 of 3GPP TS 23.527 [40]. | X | X | - | X | - | FQ-CSID | +| Failed Rule ID | C | This IE shall be included if the Cause IE indicates a rejection due to a rule creation or modification failure. | X | X | X | X | X | Failed Rule ID | +| Created Traffic Endpoint | C | This IE shall be present if the cause is set to "success" and the UP function was requested to allocate a local F-TEID or a UE IP address/prefix in a Create Traffic Endpoint IE. When present, it shall contain the local F-TEID or UE IP address/prefix to be used for this Traffic Endpoint. There may be several instances of this IE. | X | X | - | X | X | Created Traffic Endpoint | +| Created Bridge/Router Info | C | This IE shall be present if the UPF was requested to provide Bridge/Router information for TSN, TSC or DetNet in the PFCP Session Establishment Request. When present, it shall contain the Bridge/Router information for TSN, TSCTS or DetNet for the PFCP session. See Table 7.5.3.6-1. | - | - | - | X | - | Created Bridge/Router Info | +| ATSSS Control Parameters | C | This IE shall be present if ATSSS functionality is required in the request message and the UPF allocates the resources and parameters corresponding to the required ATSSS functionality. See Table 7.5.3.7-1. | - | - | - | X | - | ATSSS Control Parameters | +| RDS configuration information | O | When present, this IE shall contain the RDS configuration information the UP function supported for this PFCP session. | - | X | - | X | - | RDS configuration information | +| Partial Failure Information | C | This IE shall be present if the Cause IE indicates partial acceptance of the request to provide failure information related to a failed rule. See Table 7.5.3.1-2. Several IEs within the same IE type may be present to report failures to apply multiple rules. | - | X | X | X | X | Partial Failure Information | +| Created L2TP Session | O | This IE may be present to include information for the Created L2TP session if the Cause IE indicates a success. | - | X | - | X | - | Created L2TP Session | +| MBS Session N4mb Information | C | This IE shall be present if any IE in this grouped IE needs to be included. | - | - | - | - | X | MBS Session N4mb Information | +| MBS Session N4 | C | This IE shall be included if any IE in this grouped IE | - | - | - | X | - | MBS Session | + +| | | | | | | | | | +|--------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|----------------| +| Information | | needs to be included as specified in clause 5.34.1.
Several IE with the same IE type may be present to contain N4 Information for several MBS Sessions respectively. | | | | | | N4 Information | +| TL-Container | C | This IE shall be present if the UPF/CN-TL needs to send a TL-Container to the SMF/CUC to respond to TL-Container information received in the corresponding request. | - | - | - | X | - | TL-Container | + +**Table 7.5.3.1-2: Information Elements in a Partial Failure Information** + +| Octet 1 and 2 | | Partial Failure Information IE Type = 272 (decimal) | | | | | | | +|--------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-----|-----|----|-------|--------------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 | N4 mb | | +| Failed Rule ID | M | This IE shall indicate the rule that failed to be applied. | - | X | X | X | X | Failed Rule ID | +| Failure Cause | M | This IE shall indicate the reason why the rule could not be applied. | - | X | X | X | X | Cause | +| Offending IE Information | M | This IE shall be included to report the offending IE which caused the rule activation failure, e.g. an unknown predefined rule name included in Activate Predefined Rules IE or an unknown Application ID in the PDI.
Several IEs within the same IE type may be present to report multiple offending IEs. | - | X | X | X | X | Offending IE Information | + +**Table 7.5.3.1-3: Created L2TP Session IE in the PFCP Session Establishment Response message** + +| Octet 1 and 2 | | Created L2TP Session IE Type = 279 (decimal) | | | | | | | +|----------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-----|-----|----|-------|---------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 | N4 mb | | +| DNS Server Address | O | This IE may be present to include a DNS server address.
Several IEs with the same IE type may be present to represent multiple DNS server addresses.
The order of the IEs in the message indicates the priority, i.e. the first IE shall contain the primary DNS server address and the second IE shall contain the secondary DNS server address. | - | X | - | X | - | DNS Server Address | +| NBNS Server Address | O | This IE may be present to include an NBNS server address.
Several IEs with the same IE type may be present to represent multiple NBNS server addresses.
The order of the IEs in the message indicates the priority, i.e. the first IE shall contain the primary NBNS server address and the second IE shall contain the secondary NBNS server address. | - | X | - | X | - | NBNS Server Address | +| LNS Address | O | This IE may be present to include the used Tunnel Server Endpoint, i.e., the LNS IP address, for the PFCP Session. | - | X | - | X | - | LNS Address | + +**Table 7.5.3.1-4: MBS Session N4mb Information IE within PFCP Session Establishment Response** + +| Octet 1 and 2 | | MBS Session N4 Information IE Type = 303 (decimal) | | | | | | +|---------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-----|-----|-------|---------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 mb | | +| Multicast Transport Information | C | This IE shall be present to include a low layer source specific multicast address information (i.e. multicast destination address and related source IP address) and a GTP-U Common Tunnel EndPoint Identifier (C-TEID) if the CP function has requested to allocate such information for multicast transport over N3mb and/or N19mb. | - | - | - | X | Multicast Transport Information | + +**Table 7.5.3.1-5: MBS Session N4 Information IE within PFCP Session Establishment Response** + +| Octet 1 and 2 | | MBS Session N4 Information IE Type = 311 (decimal) | | | | | | +|------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-----|-----|-------|------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 mb | | +| MBS Session Identifier | M | | - | - | - | X | MBS Session Identifier | +| Area Session ID | C | This IE shall be present for a location dependent MBS service. When present, it shall contain the Area Session ID, which together with the MBS Session Identifier, uniquely identify the service area part of the content data of the MBS service. | - | - | - | X | Area Session ID | +| N19mb DL Tunnel ID | C | This IE shall be present when the SMF has requested the UPF to allocate a Local F-TEID in the PDI or in the Create Traffic Endpoint IE. (NOTE 1) | - | - | - | X | F-TEID | +| MBSN4Resp-Flags | C | This IE shall be included if at least one of the flags is set to "1". NOTE 2. | - | - | - | X | MBSN4Resp-Flags | + +NOTE 1: The UPF need not include Created PDR or Created Traffic Endpoint to return the newly allocated N19mb DL TEID. + +NOTE 2: Clause 5.34.3.2 explains what is indicated by the absence of the MBSN4Resp-Flags. + +### 7.5.3.2 Created PDR IE within PFCP Session Establishment Response + +The Created PDR grouped IE shall be encoded as shown in Figure 7.5.3.2-1. + +**Table 7.5.3.2-1: Created PDR IE within PFCP Session Establishment Response** + +| Octet 1 and 2 | | Created PDR IE Type = 8 (decimal) | | | | | | +|----------------------|---|-----------------------------------|-------|-----|-----|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 mb | | + +| | | | | | | | | | +|-----------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|----------------------| +| PDR ID | M | | X | X | - | X | X | PDR ID | +| Local F-TEID | C | If the UP function allocates the F-TEID, this IE shall be present and shall contain the local F-TEID to be used for this PDR. | X | X | - | X | - | F-TEID | +| Local F-TEID for Redundant Transmission | C | This IE shall be present and shall contain the local F-TEID used for this PDR for the reception of redundant uplink packets on N3/N9 interfaces, if the CP function requested a Local F-TEID to be assigned for redundant transmission. | - | - | - | X | - | F-TEID | +| UE IP Address | C | If the UP function allocates the UE IP address/prefix, this IE shall be present and shall contain the UE IP address/ prefix assigned by the UP function.
In the 5GC, several IEs with the same IE type may be present to represent multiple UE IP addresses, if the UPF indicated support of the IP6PL feature (see clause 5.21). | - | X | - | X | - | UE IP Address | +| Local Ingress Tunnel | C | If the UP function allocates the Local Ingress Tunnel, this IE shall be present and shall contain the Local Ingress Tunnel to be used for this PDR. | - | - | - | - | X | Local Ingress Tunnel | + +### 7.5.3.3 Load Control Information IE within PFCP Session Establishment Response + +The Load Control Information grouped IE shall be encoded as shown in Figure 7.5.3.3-1. + +**Table 7.5.3.3-1: Load Control Information IE within PFCP Session Establishment Response** + +| Octet 1 and 2 | | Load Control Information IE Type = 51 (decimal) | | | | | | | +|------------------------------|---|---------------------------------------------------------------------|-------|------|------|----|-------|-----------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Load Control Sequence Number | M | See clause 6.2.3.3.2 for the description and use of this parameter. | X | X | X | X | X | Sequence Number | +| Load Metric | M | See clause 6.2.3.3.2 for the description and use of this parameter. | X | X | X | X | X | Metric | + +### 7.5.3.4 Overload Control Information IE within PFCP Session Establishment Response + +The Overload Control grouped IE shall be encoded as shown in Figure 7.5.3.4-1. + +**Table 7.5.3.4-1: Overload Control Information IE within PFCP Session Establishment Response** + +| Octet 1 and 2 | | Overload Control Information IE Type = 54 (decimal) | | | | | | | +|------------------------------------|---|---------------------------------------------------------------------|-------|------|------|----|-------|-----------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Overload Control Sequence Number | M | See 6.2.4.3.2 for the description and use of this parameter. | X | X | X | X | X | Sequence Number | +| Overload Reduction Metric | M | See clause 6.2.4.3.2 for the description and use of this parameter. | X | X | X | X | X | Metric | +| Period of Validity | M | See clause 6.2.4.3.2 for the description and use of this parameter. | X | X | X | X | X | Timer | +| Overload Control Information Flags | C | This IE shall be included if any of flag in this IE is set. | X | X | X | X | X | OCI Flags | + +### 7.5.3.5 Created Traffic Endpoint IE within PFCP Session Establishment Response + +The Created Traffic Endpoint grouped IE shall be encoded as shown in Figure 7.5.3.5-1. + +**Table 7.5.3.5-1: Created Traffic Endpoint IE within PFCP Session Establishment Response** + +| Octet 1 and 2 | | Created Traffic Endpoint IE Type = 128 (decimal) | | | | | | +|-----------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-----|-----|-------|----------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 mb | | +| Traffic Endpoint ID | M | This IE shall uniquely identify the Traffic Endpoint for that PFCP session. | X | X | - | X | Traffic Endpoint ID | +| Local F-TEID | C | If the UP function allocates the F-TEID, this IE shall be present and shall contain the local F-TEID to be used for this Traffic Endpoint. | X | X | - | X | F-TEID | +| Local F-TEID for Redundant Transmission | C | This IE shall be present and shall contain the local F-TEID to be used for this PDR for the reception of redundant uplink packets on N3/N9 interfaces, if the CP function requested a Local F-TEID to be assigned for redundant transmission. | - | - | - | X | F-TEID | +| UE IP Address | C | If the UP function allocates the UE IP address/prefix, this IE shall be present and shall contain the UE IP address/ prefix assigned by the UP function. In the 5GC, several IEs with the same IE type may be present to represent multiple UE IP addresses, if the UPF indicated support of the IP6PL feature (see clause 5.21). | - | X | - | X | UE IP Address | +| Local Ingress Tunnel | C | If the UP function allocates the Local Ingress Tunnel, this IE shall be present and shall contain the Local Ingress Tunnel to be used for this PDR. | - | - | - | X | Local Ingress Tunnel | + +### 7.5.3.6 Created Bridge/Router Info IE within PFCP Session Establishment Response + +The Created Bridge/Router Info grouped IE shall be encoded as shown in Figure 7.5.3.6-1. + +**Table 7.5.3.6-1: Created Bridge/Router Info IE within PFCP Session Establishment Response** + +| Octet 1 and 2 | | Created Bridge/Router Info IE Type = 195 (decimal) | | | | | | +|------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-----|-----|-------|------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 mb | | +| Port Number | C | If the BII bit or the RII bit was set to "1" in the Create Bridge/Router Info IE, this IE shall be present and shall contain the Port Number assigned by the UP function for the PDU Session. | - | - | - | X | Port Number | +| 5GS User Plane Node ID | C | If the BII bit or the RII bit was set to "1" in the Create Bridge/Router Info IE, this IE shall be present and shall contain the 5GS User Plane Node ID assigned by the UP function. | - | - | - | X | 5GS User Plane Node ID | + +### 7.5.3.7 ATSSS Control Parameters IE within PFCP Session Establishment Response + +The ATSSS Control Parameters grouped IE shall be encoded as shown in Figure 7.5.3.7-1. + +**Table 7.5.3.7-1: ATSSS Control Parameters IE within PFCP Session Establishment Response** + +| Octet 1 and 2 | | ATSSS Control Parameters IE Type = 221 (decimal) | | | | | | +|----------------------|---|--------------------------------------------------|-------|-----|-----|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 mb | | + +| | | | | | | | | | +|---------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------| +| MPTCP Parameters | C | This IE shall be present if the TCI flag in the MPTCP Control Information IE is set to "1" in the Request message and the UPF allocated resources for MPTCP. | - | - | - | X | - | MPTCP Parameters | +| ATSSS-LL Parameters | C | This IE shall be present if the LLI flag in ATSSS-LL Control Information IE is set to "1" in the Request message and the UPF allocated resources for ATSSS-LL. | - | - | - | X | - | ATSSS-LL Parameters | +| PMF Parameters | C | This IE shall be present if the PMFI flag in the PMF Control Information IE is set to "1" in the Request message and the UPF allocated resources for PMF. Several IEs with the same IE type may be present to provide multiple PMF Parameters. | - | - | - | X | - | PMF Parameters | +| MPQUIC Parameters | C | This IE shall be present if the CUDP flag in the MPQUIC Control Information IE is set to "1" in the Request message and the UPF allocated resources for MPQUIC. | - | - | - | X | - | MPQUIC Parameters | + +The MPTCP Parameters grouped IE shall be encoded as shown in Figure 7.5.3.7-2. + +**Table 7.5.3.7-2: MPTCP Parameters IE within PFCP Session Establishment Response** + +| Octet 1 and 2 | | MPTCP Parameters IE Type = 225 (decimal) | | | | | | | +|--------------------------------|---|--------------------------------------------------------------------------------------------|-------|------|------|----|-------|------------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| MPTCP Address Information | M | This IE shall carry the information of allocated MPTCP address. | - | - | - | X | - | MPTCP Address Information | +| MPTCP Link-Specific IP Address | M | This IE shall carry the information of allocated MPTCP link-specific multipath IP address. | - | - | - | X | - | Link-Specific Multipath IP Address | + +The ATSSS-LL Parameters grouped IE shall be encoded as shown in Figure 7.5.3.7-3. + +**Table 7.5.3.7-3: ATSSS-LL Parameters IE within PFCP Session Establishment Response** + +| Octet 1 and 2 | | ATSSS-LL Parameters IE Type = 226 (decimal) | | | | | | | +|----------------------|---|---------------------------------------------------------------------------------------|-------|------|------|----|-------|----------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| ATSSS-LL Information | M | This IE shall indicate that resources have been allocated to the ATSSS functionality. | - | - | - | X | - | ATSSS-LL Information | + +The PMF Parameters grouped IE shall be encoded as shown in Figure 7.5.3.7-4. + +**Table 7.5.3.7-4: PMF Parameters IE within PFCP Session Establishment Response** + +| Octet 1 and 2 | | PMF Parameters IE Type = 227 (decimal) | | | | | | | +|-------------------------|---|--------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|-------------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| PMF Address Information | M | This IE shall contain the PMF Address Information. | - | - | - | X | - | PMF Address Information | +| QoS flow identifier | O | If present, this IE shall identify the QoS Flow Identifier of the QoS flow related to the PMF address information. | - | - | - | X | - | QFI | + +The MPQUIC Parameters grouped IE shall be encoded as shown in Figure 7.5.3.7-5. + +**Table 7.5.3.7-5: MPQUIC Parameters IE within PFCP Session Establishment Response** + +| Octet 1 and 2 | | MPQUIC Parameters IE Type = 331 (decimal) | | | | | | | +|---------------------------------|---|---------------------------------------------------------------------------------------------|-------|------|------|----|-------|------------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| MPQUIC Address Information | M | This IE shall carry the information of allocated MPQUIC address | - | - | - | X | - | MPQUIC Address Information | +| MPQUIC Link-Specific IP Address | M | This IE shall carry the information of allocated MPQUIC link-specific multipath IP address. | - | - | - | X | - | Link-Specific Multipath IP Address | + +### 7.5.3.8 Void + +## 7.5.4 PFCP Session Modification Request + +### 7.5.4.1 General + +The PFCP Session Modification Request is used over the Sxa, Sxb, Sxc, N4 and N4mb interface by the CP function to request the UP function to modify the PFCP session. + +**Table 7.5.4.1-1: Information Elements in a PFCP Session Modification Request** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|---------------------|-------|------|------|----|-------|---------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| | | | | | | | | | + +| | | | | | | | | | +|-------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-------------------------| +| CP F-SEID | C | This IE shall be present if the CP function decides to change its F-SEID for the PFCP session. The UP function shall use the new CP F-SEID for subsequent PFCP Session related messages for this PFCP Session. See Note 2. | X | X | X | X | X | F-SEID | +| Remove PDR | C | When present, this IE shall contain the PDR Rule which is requested to be removed. See Table 7.5.4-6-1. Several IEs within the same IE type may be present to represent a list of PDRs to remove. | X | X | X | X | X | Remove PDR | +| Remove FAR | C | When present, this IE shall contain the FAR Rule which is requested to be removed. See Table 7.5.4-7-1. Several IEs within the same IE type may be present to represent a list of FARs to remove. | X | X | X | X | X | Remove FAR | +| Remove URR | C | When present, this shall contain the URR Rule which is requested to be removed. See Table 7.5.4-8-1. Several IEs within the same IE type may be present to represent a list of URRs to remove. | X | X | X | X | - | Remove URR | +| Remove QER | C | When present, this IE shall contain the QER Rule which is requested to be removed. See Table 7.5.4-9-1. Several IEs within the same IE type may be present to represent a list of QERs to remove. | - | X | X | X | X | Remove QER | +| Remove BAR | C | When present, this IE shall contain the BAR Rule which is requested to be removed. See Table 7.5.4-12-1. | X | - | - | X | - | Remove BAR | +| Remove Traffic Endpoint | C | When present, this IE shall contain the Traffic Endpoint ID identifying the traffic endpoint to be removed, if the UP function has indicated support of PDI optimization. All the PDRs that refer to the removed Traffic Endpoint shall be deleted. See Table 7.5.4.14-1. Several IEs within the same IE type may be present to represent a list of Traffic Endpoints to remove. | X | X | X | X | X | Remove Traffic Endpoint | +| Create PDR | C | This IE shall be present if the CP function requests the UP function to create a new PDR. See Table 7.5.2.2-1. Several IEs within the same IE type may be present to represent a list of PDRs to create. | X | X | X | X | X | Create PDR | +| Create FAR | C | This IE shall be present if the CP function requests the UP function to create a new FAR. See Table 7.5.2.3-1. Several IEs within the same IE type may be present to represent a list of FARs to create. | X | X | X | X | X | Create FAR | +| Create URR | C | This IE shall be present if the CP function requests the UP function to create a new URR. See Table 7.5.2.4-1. Several IEs within the same IE type may be present to represent a list of URRs to create. | X | X | X | X | - | Create URR | +| Create QER | C | This IE shall be present if the CP function requests the UP function to create a new QER. See Table 7.5.2.5-1. Several IEs within the same IE type may be present to represent a list of QERs to create. | - | X | X | X | X | Create QER | +| Create BAR | C | This IE shall be present if the CP function requests the UP function to create a new BAR. See Table 7.5.2.6-1. | X | - | - | X | - | Create BAR | +| Create Traffic Endpoint | C | When present this IE shall contain the information associated with the Traffic Endpoint to be created, if the UP function has indicated support of PDI optimization. See Table 7.5.2.7-1. Several IEs within the same IE type may be present to represent a list of Traffic Endpoints to create. | X | X | X | X | X | Create Traffic Endpoint | +| Update PDR | C | This IE shall be present if a PDR previously created for the PFCP session need to be modified. See Table 7.5.4.2-1. Several IEs within the same IE type may be present to represent a list of PDRs to update. | X | X | X | X | X | Update PDR | +| Update FAR | C | This IE shall be present if a FAR previously created for the PFCP session need to be modified. See Table 7.5.4.3-1. Several IEs within the same IE type may be present to represent a list of FARs to update. | X | X | X | X | X | Update FAR | +| Update URR | C | This IE shall be present if URR(s) previously created for the PFCP session need to be modified. | X | X | X | X | - | Update URR | + +| | | | | | | | | +|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|--|--|--| +| | Several IEs within the same IE type may be present to represent a list of modified URRs. Previously URRs that are not modified shall not be included.
See Table 7.5.4.4-1. | | | | | | | +|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|--|--|--| + +| | | | | | | | | | +|-------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-------------------------| +| Update QER | C | This IE shall be present if QER(s) previously created for the PFCP session need to be modified.
Several IEs within the same IE type may be present to represent a list of modified QERs.
Previously created QERs that are not modified shall not be included.
See Table 7.5.4.5-1. | - | X | X | X | X | Update QER | +| Update BAR | C | This IE shall be present if a BAR previously created for the PFCP session needs to be modified.
A previously created BAR that is not modified shall not be included.
See Table 7.5.4.11-1. | X | - | - | X | - | Update BAR | +| Update Traffic Endpoint | C | When present this IE shall contain the information associated with the traffic endpoint to be updated, if the UP function has indicated support of PDI optimization.

All the PDRs that refer to the Traffic Endpoint shall use the updated Traffic Endpoint information.
See Table 7.5.4.13-1.
Several IEs within the same IE type may be present to represent a list of Traffic Endpoints to update. | X | X | X | X | X | Update Traffic Endpoint | +| PFCPSMReq-Flags | C | This IE shall be included if at least one of the flags is set to "1".
| X | - | - | X | - | PFCPSMReq-Flags | +| Query URR | C | This IE shall be present if the CP function requests immediate usage report(s) to the UP function.
Several IEs within the same IE type may be present to represent a list of URRs for which an immediate report is requested.
See Table 7.5.4.10-1.
See NOTE 3. | X | X | X | X | - | Query URR | +| PGW-C/SMF FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24] and clause 4.6 of 3GPP TS 23.527 [40]. | X | X | - | X | - | FQ-CSID | +| SGW-C FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24]. | X | X | - | - | - | FQ-CSID | +| MME FQ-CSID | C | This IE shall be included according to the requirements in | X | X | - | - | - | FQ-CSID | + +| | | | | | | | +|--|-----------------------------------|--|--|--|--|--| +| | clause 23 of 3GPP TS 23.007 [24]. | | | | | | +|--|-----------------------------------|--|--|--|--|--| + +| | | | | | | | | | +|-----------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-----------------------------------| +| ePDG FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24]. | - | X | - | - | - | FQ-CSID | +| TWAN FQ-CSID | C | This IE shall be included according to the requirements in clause 23 of 3GPP TS 23.007 [24]. | - | X | - | - | - | FQ-CSID | +| User Plane Inactivity Timer | C | This IE shall be present if it needs to be changed. | - | X | X | X | X | User Plane Inactivity Timer | +| Query URR Reference | O | This IE may be present if the Query URR IE is present or the QAURR flag is set to "1". When present, it shall contain a reference identifying the query request, which the UP function shall return in any usage report sent in response to the query. | X | X | X | X | - | Query URR Reference | +| Trace Information | O | When present, this IE shall contain the trace instructions to be applied by the UP function for this PFCP session. A Trace Information with a null length indicates that the trace session shall be deactivated. | X | X | X | X | - | Trace Information | +| Remove MAR | C | When present, this IE shall contain the MAR Rule which is requested to be removed. See Table 7.5.4.15-1. Several IEs within the same IE type may be present to represent a list of MARs to remove. | - | - | - | X | - | Remove MAR | +| Update MAR | C | This IE shall be present if an MAR previously created for the PFCP session needs to be modified. See Table 7.5.4.16-1. Several IEs within the same IE type may be present to represent a list of MARs to update. | - | - | - | X | - | Update MAR | +| Create MAR | C | This IE shall be present if the CP function requests the UP function to create a new MAR for a new PDR. See Table 7.5.2.8-1. Several IEs within the same IE type may be present to represent a list of MARs to create. | - | - | - | X | - | Create MAR | +| Node ID | C | This IE shall be present if a new SMF in an SMF Set, with one PFCP association per SMF and UPF (see clause 5.22.3), takes over the control of the PFCP session. When present, it shall contain the unique identifier of the new SMF. | - | - | - | X | X | Node ID | +| TSC Management Information | C | This IE shall be present if the SMF needs to send TSC Management information to the UPF. Several IEs within the same IE type may be present to transfer PMICs for different NW-TT ports. (NOTE 6). | - | - | - | X | - | TSC Management Information | +| Remove SRR | C | When present, this shall indicate the SRR Rule which is requested to be removed. See Table 7.5.4.19-1. Several IEs within the same IE type may be present to represent a list of SRRs to remove. | - | - | - | X | - | Remove SRR | +| Create SRR | C | This IE shall be present if the CP function requests the UP function to create a new SRR. See Table 7.5.2.9-1. Several IEs within the same IE type may be present to represent a list of SRRs to create. | - | - | - | X | - | Create SRR | +| Update SRR | C | This IE shall be present if SRR(s) previously created for the PFCP session need to be modified. Several IEs within the same IE type may be present to represent a list of modified SRRs. Previously SRRs that are not modified shall not be included. See Table 7.5.4.20-1. | - | - | - | X | - | Update SRR | +| Provide ATSSS Control Information | C | This IE shall be present for PFCP session modification for an MA PDU session, if the ATSSS Control Information changes. When present, this IE shall contain the required ATSSS functionalities for this MA PDU session. The UPF shall replace any value received previously by the new information received in this IE. See Note 4. See Table 7.5.2.10-1. | - | - | - | X | - | Provide ATSSS Control Information | +| Ethernet Context Information | C | This IE shall be present to update the list of MAC addresses associated to the PDU session during an Ethernet PDU session anchor relocation. | - | - | - | X | - | Ethernet Context Information | +| Access Availability Information | O | This IE may be present for an MA PDU session to signal that an access type has become transiently unavailable | - | - | - | X | - | Access Availability | + +| | | | | | | | | +|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|--|--|-------------| +| | or has become available again (see clause 5.20.5).
Two IEs with the same IE type may be present to report changes of access availability for both 3GPP and non-3GPP accesses. | | | | | | Information | +|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|--|--|-------------| + +| | | | | | | | | | +|------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|------------------------------------| +| Query Packet Rate Status | C | This IE shall be present if the CP function requests immediate packet rate status report(s) to the UP function. Several IEs within the same IE type may be present to represent a list of QERs for which an immediate packet rate status report is requested.
See Table 7.5.4.22-1. | - | X | - | X | - | Query Packet Rate Status | +| S-NSSAI | O | This IE may be present to indicate the S-NSSAI of the PDU session or MBS session, if the S-NSSAI of the PDU Session or MBS session has been provided previously to the UP function and the S-NSSAI has changed. (NOTE 5) | - | - | - | X | X | S-NSSAI | +| HPLMN S-NSSAI | C | This IE should be sent from the V-SMF to any V-UPF acting as (local) PSA for a HR-SBO PDU session and capable of enforcing NAT on N6 traffic, if the information was not provided during the PFCP session establishment. When present, it shall contain the HPLMN S-NSSAI. | - | - | - | X | - | HPLMN S-NSSAI | +| DNN | C | This IE should be sent from the V-SMF to any V-UPF acting as (local) PSA for a HR-SBO PDU session and capable of enforcing NAT on N6 traffic, if the information was not provided during the PFCP session establishment. When present, it shall contain the full DNN of the PDU session (with the Operator ID part identifying the HPLMN ID). | - | - | - | X | - | DNN | +| RAT Type | | This IE shall be present if there is a RAT change and the CP function wants to inform the UP Function about the new RAT Type if the PFCP session is not established for a MA PDU session. | X | X | - | X | - | RAT Type | +| Group Id | C | This IE shall be included by the CP function to indicate the new group identifier to which the PFCP session pertains, if it has been changed (see clause 5.22.4).

When present, the UP function shall replace any earlier value associated to the PFCP session with the new value. | - | X | - | X | - | Group Id | +| MBS Session N4 Control Information | C | This IE shall be included if:
Several IEs with the same IE type may be present to provide N4 control information for several MBS sessions, e.g. when the UE requests to join several MBS sessions.
See Table 7.5.2.1-5 for encoding. | - | - | - | X | - | MBS Session N4 Control Information | +| DSCP to PPI Control Information | C | This IE shall be present if the DSCP to PPI Control Information needs to be changed. The UPF shall replace any value received previously by the new information received in this IE.

See Table 7.5.2.1-6 for encoding. | - | - | - | X | - | DSCP to PPI Control Information | +| TL-Container | C | This IE shall be present if the SMF/CUC needs to send a TL-Container to the UPF/CN-TL. Several IEs within the same IE type may be present to provide multiple TL-Containers. | - | - | - | X | - | TL-Container | + +NOTE 1: The CP function may request the UP function to drop the packets currently buffered for the PFCP session when using extended buffering of downlink data packets, buffering is performed in the UP function and the DL Data Buffer Expiration Time is handled by the CP function. In this case, when the DL Data Buffer Expiration Time expires, the CP function shall send a PFCP Session Modification Request including the DROBU flag (to drop the downlink data packets currently buffered in the UP function) and updating the Apply Action within the FARs + +| | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| of this PFCP session to request the UP function to start buffering the downlink data packets with notifying the arrival of subsequent downlink data packets. See clause 5.9.3 of 3GPP TS 23.214 [2]. | | +| NOTE 2: | When changing the CP F-SEID of an established PFCP Session, the CP function shall be able to handle any incoming PFCP Session related messages sent by the UP function with the previous CP F-SEID for a duration at least longer than twice the PFCP retransmission timer (N1xT1). | +| NOTE 3: | The QAURR (Query All URRs) flag in the PFCPSMReq-Flags IE and the Query URR IE are exclusive from each other in a PFCP Session Modification Request. | +| NOTE 4: | If the ATSSS resources have already been allocated to the PFCP session previously, e.g. during the PFCP session establishment, the UPF shall not allocate new values for such resources (e.g. UE Link-Specific IP Address). | +| NOTE 5: | S-NSSAI for the PDU session may be updated after PDU session establishment, i.e. during EPS to 5GS handover procedure, the initial AMF may use configured S-NSSAI for interworking to create the PDU session in 5GS. For home routed PDU session, if the S-NSSAI in serving PLMN (mapped from S-NSSAI in HPLMN) is different from the configured S-NSSAI for interworking and V-SMF reselection is not needed, the AMF will update V-SMF with S-NSSAI in serving PLMN for the PDU session, as specified in clause 4.11.1.3.3 of 3GPP TS 23.502 [29]. The S-NSSAI may also be updated by SMF+PGW-C during EPS to 5GS handover in non-roaming or roaming-with-LBO case. The S-NSSAI may be used by the UP function for performance measurement. The S-NSSAI may also be updated by the SMF with an alternative S-NSSAI over N4 interface for Network Slice Replacement (see clause 5.15.19 of 3GPP TS 23.501 [28]). | +| NOTE 6: | When transferring port and user plane node management information between the TSN AF or the TSCTSF and the NW-TT, since the NW-TT may support multiple ports, there may be several instances of the TSC Management Information IEs containing a Port Management Information Container together with a NW-TT Port Number, and only one instance of the TSC Management Information IE containing a User Plane Node Management Information Container that may also contain a Port Management Information Container together with a NW-TT Port Number. | + +#### 7.5.4.2 Update PDR IE within PFCP Session Modification Request + +The Update PDR grouped IE shall be encoded as shown in Figure 7.5.4.2-1. + +**Table 7.5.4.2-1: Update PDR IE within PFCP Session Modification Request** + +| Octet 1 and 2 | Update PDR IE Type = 9 (decimal) | | | | | | | | +|----------------------|----------------------------------|---------------------|-------|------|------|----|-------|---------| +| Octets 3 and 4 | Length = n | | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| | | | | | | | | | + +| | | | | | | | | | +|------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|------------------------------| +| PDR ID | M | This IE shall uniquely identify the PDR among all the PDRs configured for that PFCP session. | X | X | X | X | X | PDR ID | +| Outer Header Removal | C | This IE shall be present if it needs to be changed. | X | X | - | X | X | Outer Header Removal | +| Precedence | C | This IE shall be present if there is a change in the PDR's precedence to be applied by the UP function among all PDRs of the PFCP session, when looking for a PDR matching an incoming packet. | - | X | X | X | X | Precedence | +| PDI | C | This IE shall be present if there is a change within the PDI against which incoming packets will be matched. When present, this IE shall replace the PDI previously stored in the UP function for this PDR. See Table 7.5.2.2-2. | X | X | X | X | X | PDI | +| FAR ID | C | This IE shall be present if it needs to be changed | X | X | X | X | X | FAR ID | +| URR ID | C | This IE shall be present if a measurement action shall be applied or no longer applied to packets matching this PDR.
When present, this IE shall contain the list of all the URR IDs to be associated to the PDR. | X | X | X | X | - | URR ID | +| QER ID | C | This IE shall be present if a QoS enforcement action shall be applied or no longer applied to packets matching this PDR.
When present, this IE shall contain the list of all the QER IDs to be associated to the PDR. | - | X | X | X | X | QER ID | +| Activate Predefined Rules | C | This IE shall be present if new Predefined Rule(s) needs to be activated for the PDR. When present this IE shall contain one Predefined Rules name.
Several IEs with the same IE type may be present to represent multiple "Activate Predefined Rules" names. | - | X | X | X | - | Activate Predefined Rules | +| Deactivate Predefined Rules | C | This IE shall be present if Predefined Rule(s) needs to be deactivated for the PDR. When present this IE shall contain one Predefined Rules name.
Several IEs with the same IE type may be present to represent multiple "Activate Predefined Rules" names. | - | X | X | X | - | Deactivate Predefined Rules | +| Activation Time | O | This IE may be present if the PDR activation time shall be changed. (NOTE 2) | - | X | X | X | - | Activation Time | +| Deactivation Time | O | This IE may be present if the PDR deactivation time shall be changed. (NOTE 2) | - | X | X | X | - | Deactivation Time | +| IP Multicast Addressing Info | O | This IE may be present in an UL PDR controlling UL IGMP/MLD traffic (see clause 5.25), if it needs to be changed
When present, it shall contain a (range of) IP multicast address(es), and optionally source specific address(es), identifying a set of IP multicast flows. See Table 7.5.2.2-4.
Several IEs with the same IE type may be present to represent multiple IP multicast flows.
When present, the UPF shall replace any IP multicast address(es) previously stored for this PDR by the IP multicast address(es) received in this IE. | - | - | - | X | - | IP Multicast Addressing Info | +| Transport Delay Reporting | C | This IE shall be present if Transport Delay Reporting needs to be changed (e.g. transport delay reporting needs to be activated or deactivated). See Table 7.5.2.2-6. | - | - | - | X | - | Transport Delay Reporting | +| RAT Type | O | This IE may be present if there is a RAT change for the UL PDR if the PFCP session is established for a MA PDU session. | - | - | - | X | - | RAT Type | + +NOTE 1: The IEs which do not need to be modified shall not be included in the Update PDR IE. The UP function shall continue to behave according to the values previously received for IEs not present in the Update PDR IE. + +NOTE 2: When the Activation Time and Deactivation Time are not present, the PDR shall keep its current activation status, either active or inactive. + +### 7.5.4.3 Update FAR IE within PFCP Session Modification Request + +The Update FAR grouped IE shall be encoded as shown in Figure 7.5.4.3-1. + +**Table 7.5.4.3-1: Update FAR IE within PFCP Session Modification Request** + +| Octet 1 and 2 | | Update FAR IE Type = 10 (decimal) | | | | | | +|----------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-----|-----|----------|----------------------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4
mb | | +| FAR ID | M | This IE shall identify the FAR to be updated. | X | X | X | X | FAR ID | +| Apply Action | C | This IE shall be present if it is changed. | X | X | X | X | Apply Action | +| Update Forwarding parameters | C | This IE shall be present if it is changed. See table 7.5.4.3-2. | X | X | X | X | Update Forwarding Parameters | +| Update Duplicating Parameters | C | This IE shall be present if it is changed. See table 7.5.4.3-3.
Several IEs with the same IE type may be present to request to duplicate the packets to different destinations. | X | X | - | - | Update Duplicating Parameters | +| Redundant Transmission Forwarding Parameters | C | This IE shall be present if it is changed. See table 7.5.2.3-4. | - | - | - | X | Redundant Transmission Forwarding Parameters | +| BAR ID | C | This IE shall be present if the BAR ID associated to the FAR needs to be modified. | X | - | - | X | BAR ID | +| Add MBS Unicast Parameters | C | This IE shall be present when the Apply Action is set to "MBSU" to request the MB-UPF to forward the MBS session data to a remote GTP-U peer for unicast transport, if no remote GTP-U peers are provisioned yet in the MB-UPF, or if additional GTP-U peers need to be provisioned. (NOTE).

Several IEs with the same IE type may be present to represent multiple remote GTP-U peers.

See Table 7.5.2.3-6. | - | - | - | - | Add MBS Unicast Parameters | +| Remove MBS Unicast Parameters | C | This IE shall be present when the MB-SMF to request the MB-UPF to delete a remote GTP-U peer to stop forwarding the MBS session data to that remote GTP-U peer for unicast transport.

Several IEs with the same IE type may be present to represent to delete multiple remote GTP-U peers. | - | - | - | - | Remove MBS Unicast Parameters | + +NOTE: When the Apply Action is changed to "MBSU" during an MBS session reactivation, remote GTP-U peers may already be provisioned in the MB-UPF if the MB-SMF did not request the MB-UPF to delete the N3mb/N19mb DL F-TEIDs when the MBS session was deactivated (see clause 5.34.2.4). + +**Table 7.5.4.3-2: Update Forwarding Parameters IE in the Update FAR IE** + +| Octet 1 and 2 | | Update Forwarding Parameters IE Type = 11 (decimal) | | | | | | +|----------------------|---|-----------------------------------------------------|-------|-----|-----|----------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4
mb | | + +| | | | | | | | | | +|----------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|----------------------------------------| +| Destination Interface | C | This IE shall only be provided if it is changed. When present, it shall indicate the destination interface of the outgoing packet. | X | X | X | X | - | Destination Interface | +| Network instance | C | This IE shall only be provided if it is changed. | X | X | X | X | - | Network Instance | +| Redirect Information | C | This IE shall be present if the instructions regarding the redirection of traffic by the UP function need to be modified. | - | X | X | X | - | Redirect Information | +| Outer Header Creation | C | This IE shall only be provided if it is changed. See NOTE 1. | X | X | - | X | - | Outer Header Creation | +| Transport Level Marking | C | This IE shall only be provided if it is changed | X | X | - | X | - | Transport Level Marking | +| Forwarding Policy | C | This IE shall only be provided if it is changed. See NOTE 1. | - | X | X | X | - | Forwarding Policy | +| Metadata | C | This IE shall only be provided if it is changed. The UPF shall overwrite any metadata received earlier in this FAR. | - | - | - | X | - | Metadata | +| Header Enrichment | C | This IE shall only be provided if it is changed | - | X | X | X | - | Header Enrichment | +| PFCPSMReq-Flags | C | This IE shall be included if at least one of the flags is set to "1".
- SNDEM (Send End Marker Packets): this IE shall be present if the CP function modifies the F-TEID of the downstream node in the Outer Header Creation IE and the CP function requests the UP function to construct and send GTP-U End Marker messages towards the old F-TEID of the downstream node. | X | X | - | X | - | PFCPSMReq-Flags | +| Linked Traffic Endpoint ID | C | This IE may be present, if it is changed and the UP function indicated support of the PDI optimization feature, (see clause 8.2.25). When present, it shall identify the Traffic Endpoint ID allocated for this PFCP session to receive the traffic in the reverse direction (see clause 5.2.3.1). | X | X | - | X | - | Traffic Endpoint ID | +| Destination Interface Type | C | This IE shall be present to indicate the 3GPP interface type of the destination interface, if the value has changed. | X | X | - | X | - | 3GPP Interface Type | +| Data Network Access Identifier | C | This IE shall be provided over N16a if it is changed. This IE shall not be sent over N4. | - | - | - | - | - | Data Network Access Identifier | +| IP Address and Port Number Replacement | C | This IE shall only be provided if it is changed. | - | - | - | X | - | IP Address and Port Number Replacement | + +NOTE 1: If the Outer Header Creation and Forwarding Policy are present, the UP function shall put the user plane packets in the user plane tunnel by applying Outer Header Creation, after enforcing the required Forwarding Policy. + +**Table 7.5.4.3-3: Update Duplicating Parameters IE in the Update FAR IE** + +| Octet 1 and 2 | | Update Duplicating Parameters IE Type = 105 (decimal) | | | | | | +|----------------------|---|-------------------------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|-------------------------|---|------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-------------------------| +| Destination Interface | C | This IE shall only be provided if it is changed. When present, it shall indicate the destination interface of the outgoing packet. | X | X | - | - | - | Destination Interface | +| Outer Header Creation | C | This IE shall only be provided if it is changed. See NOTE 1. | X | X | - | - | - | Outer Header Creation | +| Transport Level Marking | C | This IE shall only be provided if it is changed. | X | X | - | - | - | Transport Level Marking | +| Forwarding Policy | C | This IE shall only be provided if it is changed. See NOTE 1. | - | X | - | - | - | Forwarding Policy | + +NOTE 1: If the Outer Header Creation and Forwarding Policy are present, the UP function shall put the user plane packets in the user plane tunnel by applying Outer Header Creation, after enforcing the required Forwarding Policy. + +**Table 7.5.4.3-4: Remove MBS Unicast Parameters IE in the Update FAR IE** + +| | | | | | | | | +|---------------------------|----------------------------------------------------|---------------------------------------------------------------------|-------|-----|-----|-------|---------------------------| +| Octet 1 and 2 | Remove MBS Unicast Parameters Type = 304 (decimal) | | | | | | | +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 mb | | +| MBS Unicast Parameters ID | M | This IE shall identify the MBS Unicast Parameters IE to be removed. | - | - | - | X | MBS Unicast Parameters ID | + +#### 7.5.4.4 Update URR IE within PFCP Session Modification Request + +The Update URR grouped IE shall be encoded as shown in Figure 7.5.4.4-1. + +**Table 7.5.4.4-1: Update URR IE within PFCP Session Modification Request** + +| | | | | | | | | +|----------------------|-----------------------------------|---------------------|-------|-----|-----|-------|---------| +| Octet 1 and 2 | Update URR IE Type = 13 (decimal) | | | | | | | +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sxa | Sxb | Sxc | N4 mb | | +| | | | | | | | | + +| | | | | | | | | | +|------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|------------------------------| +| URR ID | M | This IE shall uniquely identify the URR among all the URRs configured for that PFCP session | X | X | X | X | - | URR ID | +| Measurement Method | C | This IE shall be present if the measurement method needs to be modified.
When present, this IE shall indicate the method for measuring the network resources usage, i.e. whether the data volume, duration (i.e. time), combined volume/duration, or event shall be measured. | X | X | X | X | - | Measurement Method | +| Reporting Triggers | C | This IE shall be present if the reporting triggers needs to be modified.
When present, this IE shall indicate the trigger(s) for reporting network resources usage to the CP function, e.g. periodic reporting or reporting upon reaching a threshold, or envelope closure, or when an SMF instructs an UPF to report the reception of the End Marker packet from the old I-UPF during a Service Request procedure (see clauses 4.2.3.2 and 4.23.4.3 in 3GPP TS 23.502 [29]). | X | X | X | X | - | Reporting Triggers | +| Measurement Period | C | This IE shall be present if the Measurement Period needs to be modified.
When present, it shall indicate the period for generating and reporting usage reports. | X | X | X | X | - | Measurement Period | +| Volume Threshold | C | This IE shall be present if the Volume Threshold needs to be modified. When present, it shall indicate the traffic volume value after which the UP function shall report network resources usage to the CP function for this URR. | X | X | X | X | - | Volume Threshold | +| Volume Quota | C | This IE shall be present if the Volume Quota needs to be modified.
When present, it shall indicate the Volume Quota value. | - | X | X | X | - | Volume Quota | +| Time Threshold | C | This IE shall be present if the Time Threshold needs to be modified. When present, it shall indicate the time usage after which the UP function shall report network resources usage to the CP function for this URR. | X | X | X | X | - | Time Threshold | +| Time Quota | C | This IE shall be present if the Time Quota needs to be modified.
When present, it shall indicate the Time Quota value. | - | X | X | X | - | Time Quota | +| Event Threshold | C | This IE shall be present if Event Threshold needs to be modified.
When present, it shall indicate the number of events after which the UP function shall report to the CP function for this URR. | - | X | X | X | - | Event Threshold | +| Event Quota | C | This IE shall be present if Event Quota needs to be modified.
When present, it shall indicate the Event Quota value. | - | X | X | X | - | Event Quota | +| Quota Holding Time | C | This IE shall be present if the Quota Holding Time needs to be modified.
When present, it shall contain the duration of the Quota Holding Time. | - | X | X | X | - | Quota Holding Time | +| Dropped DL Traffic Threshold | C | This IE shall be present if the Dropped DL Threshold needs to be modified.
When present, it shall contain the threshold of the DL traffic being dropped. | X | - | - | X | - | Dropped DL Traffic Threshold | +| Quota Validity Time | C | This IE shall be present if Quota Validity time was not sent earlier or quota validity time value needs to be modified. | - | X | - | X | - | Quota Validity Time | +| Monitoring Time | C | This IE shall be present if the Monitoring Time needs to be modified. When present, this IE shall contain the time at which the UP function shall re-apply the volume or time threshold. | X | X | X | X | - | Monitoring Time | +| Subsequent Volume Threshold | C | This IE shall be present if the Subsequent Volume Threshold needs to be modified and volume-based measurement is used.
When present, it shall indicate the traffic volume value after which the UP function shall report network resources usage to the CP function for this URR for the period after the Monitoring Time. | X | X | X | X | - | Subsequent Volume Threshold | +| Subsequent Time Threshold | C | This IE shall be present if the Subsequent Time Threshold needs to be modified. When present, it shall | X | X | X | X | - | Subsequent Time Threshold | + +| | | | | | | | +|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|--|--| +| | indicate the time usage value after which the UP function shall report network resources usage to the CP function for this URR for the period after the Monitoring Time. | | | | | | +|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|--|--| + +| | | | | | | | | | +|----------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|----------------------------| +| Subsequent Volume Quota | C | This IE shall be present if the Subsequent Volume Quota needs to be modified.
When present, it shall indicate the Volume Quota value which the UP function shall use for this URR for the period after the Monitoring Time. | - | X | X | X | - | Subsequent Volume Quota | +| Subsequent Time Quota | C | This IE shall be present if the Subsequent Time Quota needs to be modified.
When present, it shall indicate the Time Quota value which the UP function shall use for this URR for the period after the Monitoring Time. | - | X | X | X | - | Subsequent Time Quota | +| Subsequent Event Threshold | O | This IE shall be present if the Subsequent Event Threshold needs to be modified.
When present, it shall indicate the number of events after which the UP function shall report to the CP function for this URR for the period after the Monitoring Time. | - | X | X | X | - | Subsequent Event Threshold | +| Subsequent Event Quota | O | This IE shall be present if the Subsequent Event Quota needs to be modified.
When present, it shall indicate the Event Quota value which the UP function shall use for this URR for the period after the Monitoring Time. | - | X | X | X | - | Subsequent Event Quota | +| Inactivity Detection Time | C | This IE shall be present if the Inactivity Detection Time needs to be modified.
When present, it shall indicate the duration of the inactivity period after which time measurement needs to be suspended when no packets are received during this inactivity period. | - | X | X | X | - | Inactivity Detection Time | +| Linked URR ID | C | This IE shall be present if linked usage reporting is required. When present, this IE shall contain the linked URR ID which is related with this URR (see clause 5.2.2.4).

Several IEs with the same IE type may be present to represent multiple linked URRs which are related with this URR. | - | X | X | X | - | Linked URR ID | +| Measurement Information | C | This IE shall be included if any of the following flag is set to "1" or if the change of flag(s) from "1" to "0" results in the IE becoming set to all zeros.
Applicable flags are:
| - | X | - | X | - | Measurement Information | +| | | - Inactive Measurement Flag: this flag shall be set to "1" if the measurement shall be paused (inactive). The measurement shall be performed (active) if the bit is set to "0" or if the Measurement Information IE is not present in the Update URR IE. | - | X | - | X | - | | +| | | - Reduced Application Detection Information Flag: this flag may be set to "1", if the Reporting Triggers request to report the start or stop of application, to request the UP function to only report the Application ID in the Application Detection Information, e.g. for envelope reporting. | - | X | - | X | - | | +| | | - Immediate Start Time Metering Flag: this flag may be set to "1" if time-based measurement is used and the UP function is requested to start the time metering immediately at receiving the flag. | - | X | X | X | - | | +| | | - Send Start Pause of Charging Flag: this flag may be set to "1" by the CP function if the UP Function is requested to send a Start Pause of Charging indication to the upstream GTP-U entity(ies) when the Dropped DL Traffic Threshold is reached. | X | - | - | X | X | | +| | | - Applicable for Start of Pause of Charging Flag: this flag may be set to "1" if the URR is applicable for Start of Pause of Charging, so that the UP function shall stop the usage measurement for the URR when receiving Start Pause of Charging indication from the peer downstream GTP-U | - | X | - | X | - | | + +| | | | | | | | | | | +|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|---|---|---|---|---|--| +| | | entity.

- Control of Inactive Measurement Flag: the flag shall be set to "1" if the CP function requests the UP function to stop or resume the usage measurement for the URR with the "ASPOC" flag set to "1" according to the value of Inactive Measurement Flag. | | - | X | - | X | - | | +|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|---|---|---|---|---|--| + +| | | | | | | | | | +|------------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-----------------------------| +| Time Quota Mechanism | C | This IE shall be present if time-based measurement based on CTP or DTP needs to be modified. | - | X | - | - | - | Time Quota Mechanism | +| Aggregated URRs | C | This IE shall be included if the Aggregated URRs IE needs to be modified. See Table 7.5.2.4-2.

Several IEs with the same IE type may be present to provision multiple aggregated URRs.

When present, this IE shall provide the complete list of the aggregated URRs. | - | X | - | - | - | Aggregated URRs | +| FAR ID for Quota Action | C | This IE shall be present if the FAR ID for Quota Action IE needs to be modified. This IE may be present if the Volume Quota IE or the Time Quota IE or Event Quota IE is newly provisioned in the URR and the UP Function indicated support of the Quota Action.
When present, it shall contain the identifier of the substitute FAR the UP function shall apply, for the traffic associated to this URR, when exhausting any of these quotas. See NOTE 1, NOTE 2. | - | X | X | X | - | FAR ID | +| Ethernet Inactivity Timer | C | This IE shall be present if the Ethernet Inactivity Timer needs to be modified. When present, it shall contain the duration of the Ethernet inactivity period. | - | - | - | X | - | Ethernet Inactivity Timer | +| Additional Monitoring Time | O | This IE shall be present if the additional Monitoring Time needs to be modified. When present, this IE shall contain the time at which the UP function shall re-apply the volume or time or event threshold/quota. See Table 7.5.2.4-3.
The CP function shall provide the full set of Additional Monitoring Times IE(s). The UP function shall replace any Additional Monitoring Times IE(s) provisioned earlier by the new set of received IE(s). | X | X | X | X | - | Additional Monitoring Time | +| Number of Reports | O | This IE may be present if the Number of Reports need to be changed. When present, it shall indicate the number of usage reports to be generated by the URR. See also clauses 5.2.2.2.1 and 5.2.2.3.1. | X | X | X | X | - | Number of Reports | +| Exempted Application ID for Quota Action | C | This IE shall be present if Application ID for Quota Action needs to be changed.

When present, it shall contain an Application ID matching packets that shall be exempted from applying the FAR ID for Quota Action when the quota has been exhausted.

Several IEs with the same IE type may be present to provide multiple Application IDs.

The CP function shall always provide a complete list of Application IDs.

See NOTE 3. | - | X | X | X | - | Application ID | +| Exempted SDF Filter for Quota Action | C | This IE shall be present if the SDF Filter for Quota Action needs to be changed.

When present, it shall contain a SDF Filter matching packets that shall be exempted from applying the FAR ID for Quota Action when the quota has been exhausted.

Several IEs with the same IE type may be present to provide multiple SDF Filters.

The CP function shall always provide a complete list of SDF Filters.

See NOTE 3. | - | X | X | X | - | SDF Filter | +| User Plane Inactivity Timer | C | This IE shall be present if the User Plane Inactivity Timer needs to be modified.
When present, it shall contain the duration of the User Plane Inactivity Timer. | - | - | - | X | - | User Plane Inactivity Timer | + +| | | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: | The substitute FAR used when exhausting a Volume Quota or Time Quota may be set to drop the packets, buffer the packets or redirect the traffic towards a redirect destination as specified in clause 5.4.7. | +| NOTE 2: | If the FAR as indicated in the FAR ID for Quota Action is removed after being provisioned, the UP function shall behave as if the FAR ID for Quota Action is not provisioned and shall apply the default behaviour per local configuration when the quota is exhausted. | +| NOTE 3: | The Exempted Application ID for Quota Action IE or Exempted Filter ID for Quota Action IE may be provisioned as the Restricted-Filter-Rule AVP or Filter ID AVP which is included in Final-Unit-Indication AVP from the online charging system when the Final-Unit-Action AVP is set to "REDIRECT" or "RESTRICT_ACCESS". See also 3GPP TS 32.299 [18]. | + +#### 7.5.4.5 Update QER IE within PFCP Session Modification Request + +The Update QER grouped IE shall be encoded as shown in Figure 7.5.4.5-1. + +**Table 7.5.4.5-1: Update QER IE within PFCP Session Modification Request** + +| Octet 1 and 2 | | Update QER IE Type = 14 (decimal) | | | | | | +|----------------------|---|-----------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|-------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-------------------------| +| QER ID | M | This IE shall uniquely identify the QER among all the QRs configured for that PFCP session | - | X | X | X | X | QER ID | +| QER Correlation ID | C | This IE shall be present if the QER correlation ID in this QER needs to be modified.
See NOTE 1. | - | X | - | X | - | QER Correlation ID | +| Gate Status | C | This IE shall be present if the Gate Status needs to be modified. When present, it shall indicate whether the packets are allowed to be forwarded (the gate is open) or shall be discarded (the gate is closed) in the uplink and/or downlink directions.
See NOTE 1. | - | X | X | X | X | Gate Status | +| Maximum Bitrate | C | This IE shall be present if an MBR enforcement action applied to packets matching this PDR need to be modified.
When present, this IE shall indicate the uplink and/or downlink maximum bit rate to be enforced for packets matching the PDR.

For EPC, this IE may be set to the value of:
- the APN-AMBR, for a QER that is referenced by all the PDRs of the non-GBR bearers of a PDN connection;
- the TDF session MBR, for a QER that is referenced by all the PDRs of a TDF session;
- the bearer MBR, for a QER that is referenced by all the PDRs of a bearer;
- the SDF MBR, for a QER that is referenced by all the PDRs of a SDF.

For 5GC, this IE may be set to the value of:
- the Session-AMBR, for a QER that is referenced by all the PDRs of the non-GBR QoS flows of a PDU session;
- the QoS Flow MBR, for a QER that is referenced by all the PDRs of a QoS Flow;
- the SDF MBR, for a QER that is referenced by all the PDRs of a SDF.

See NOTE 1. | - | X | X | X | X | MBR | +| Guaranteed Bitrate | C | This IE shall be present if a GBR authorization to packets matching this PDR needs to be modified. When present, this IE shall indicate the authorized uplink and/or downlink guaranteed bit rate.

This IE may be set to the value of:
- the aggregate GBR, for a QER that is referenced by all the PDRs of a GBR bearer;
- the QoS Flow GBR, for a QER that is referenced by all the PDRs of a QoS Flow (for 5GC);
- the SDF GBR, for a QER that is referenced by all the PDRs of a SDF.
See NOTE 1. | - | X | X | X | X | GBR | +| Packet Rate | C | This IE shall be present if a Packet Rate enforcement action (in terms of number of packets per time interval) need to be modified for packets matching this PDR. | - | X | - | X | - | Packet Rate | +| DL Flow Level Marking | C | This IE shall be set if the DL Flow Level Marking IE needs to be modified.
See NOTE 1. | - | X | X | - | - | DL Flow Level Marking | +| QoS flow identifier | C | This IE shall be present if it needs to be modified. | - | - | - | X | X | QFI | +| Reflective QoS | C | This IE shall be present if the state of the Reflective QoS needs to be modified (activate if inactive, or deactivate the active Reflective QoS). | - | - | - | X | - | RQI | +| Paging Policy Indicator | C | This IE shall be present if it needs to be modified. | - | - | - | X | - | Paging Policy Indicator | +| Averaging Window | O | This IE may be present if the UP function is required to modify the Averaging Window. (NOTE 2) | - | - | - | X | - | Averaging Window | + +| | | | | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-------------------------| +| QER Control Indications | C | This IE shall be included if the CP function need to provide the updated QoS enforcement control information:
- RCSR (Rate Control Status Reporting): the CP function shall set this bit "1" to request the UP function to report the rate control status when the PFCP session is released. | - | X | - | X | - | QER Control Indications | +| QER Indications | C | This IE shall be included if the CP function need to provide updated QER Indications". When present, it shall be set as follows:

- EML4S (ECN Marking for L4S): this IE shall be set to "1" to request the UPF to perform ECN marking for L4S for the traffic of the UL and/or DL PDRs associated with the QER (see clause 5.38.1). When this indication was earlier set to "1", this IE shall be set to "0" to request the UPF to stop performing ECN marking for L4S for the traffic of the DL PDRs associated with the QER.

- PDUSM (PDU Set Marking): this IE shall be set to "1" to request the UPF to perform PDU Set marking for the traffic of the DL PDRs associated with the QER (see clause 5.38.3). When this indication was earlier set to "1", this IE shall be set to "0" to request the UPF to stop performing PDU Set identification and marking for the traffic of the DL PDRs associated with the QER. | - | - | - | X | - | QER Indications | +| NOTE 1: The IEs which do not need to be modified shall not be included in the Update QER IE. The UP function shall continue to behave according to the values previously received for IEs not present in the Update QER IE. | | | | | | | | | +| NOTE 2: For a GBR QoS flow, as 5QI is not signalled over N4, one default averaging window shall be pre-configured in the UPF. For Non-GBR QoS Flows, e.g., for the measurement of the Session-AMBR, the averaging window to be used (if not received over N4) is implementation specific. | | | | | | | | | + +#### 7.5.4.6 Remove PDR IE within PFCP Session Modification Request + +The Remove PDR grouped IE shall be encoded as shown in Figure 7.5.4.6-1. + +R grouped IE shall be encoded as shown in Figure 7.5.4.6-1. + +**Table 7.5.4.6-1: Remove PDR IE within PFCP Session Modification Request** + +| Octet 1 and 2 | Remove PDR IE Type = 15 (decimal) | | | | | | +|----------------------|-----------------------------------|-----------------------------------------------|-------|------|------|-------| +| Octets 3 and 4 | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | +| | | | Sx a | Sx b | Sx c | N4 mb | +| PDR ID | M | This IE shall identify the PDR to be deleted. | X | X | X | X | + +#### 7.5.4.7 Remove FAR IE within PFCP Session Modification Request + +The Remove FAR grouped IE shall be encoded as shown in Figure 7.5.4.7-1. + +**Table 7.5.4.7-1: Remove FAR IE within PFCP Session Modification Request** + +| Octet 1 and 2 | Remove FAR IE Type = 16 (decimal) | | | | | | +|----------------------|-----------------------------------|---------------------|-------|------|------|-------| +| Octets 3 and 4 | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | +| | | | Sx a | Sx b | Sx c | N4 mb | +| | | | | | | | + +| | | | | | | | | | +|--------|---|-----------------------------------------------|---|---|---|---|---|--------| +| FAR ID | M | This IE shall identify the FAR to be deleted. | X | X | X | X | X | FAR ID | +|--------|---|-----------------------------------------------|---|---|---|---|---|--------| + +#### 7.5.4.8 Remove URR IE within PFCP Session Modification Request + +The Remove URR grouped IE shall be encoded as shown in Figure 7.5.4.7-1. + +**Table 7.5.4.8-1: Remove URR IE within PFCP Session Modification Request** + +| Octet 1 and 2 | | Remove URR IE Type = 17 (decimal) | | | | | | | +|----------------------|---|-----------------------------------------------|-------|------|------|----|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| URR ID | M | This IE shall identify the URR to be deleted. | X | X | X | X | - | URR ID | + +#### 7.5.4.9 Remove QER IE PFCP Session Modification Request + +The Remove QER grouped IE shall be encoded as shown in Figure 7.5.4.9-1. + +**T Table 7.5.4.9-1: Remove QER IE PFCP Session Modification Request** + +| Octet 1 and 2 | | Remove QER IE Type = 18 (decimal) | | | | | | | +|----------------------|---|-----------------------------------------------|-------|------|------|----|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| QER ID | M | This IE shall identify the QER to be deleted. | - | X | X | X | X | QER ID | + +#### 7.5.4.10 Query URR IE within PFCP Session Modification Request + +The Query URR grouped IE shall be encoded as shown in Figure 7.5.4.10-1. + +**Table 7.5.4.10-1: Query URR IE within PFCP Session Modification Request** + +| Octet 1 and 2 | | Query URR IE Type = 77 (decimal) | | | | | | +|----------------------|---|-----------------------------------------------|-------|------|------|----|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | | +| URR ID | M | This IE shall identify the URR being queried. | X | X | X | X | URR ID | + +#### 7.5.4.11 Update BAR IE within PFCP Session Modification Request + +The Update BAR grouped IE shall be encoded as shown in Figure 7.5.4.11-1. + +**Table 7.5.4.11-1: Update BAR IE within PFCP Session Modification Request** + +| Octet 1 and 2 | | Update BAR IE Type = 86 (decimal) | | | | | | | +|----------------------|---|-----------------------------------|-------|------|------|----|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| | | | | | | | | | + +| | | | | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-------------------------------------| +| BAR ID | M | This IE shall identify the BAR Rule to be modified. | X | - | - | X | - | BAR ID | +| Downlink Data Notification Delay | C | This IE shall be present if the UP function indicated support of the Downlink Data Notification Delay parameter (see clause 8.2.28) and the Downlink Data Notification Delay needs to be modified.
When present, it shall contain the delay the UP function shall apply between receiving a downlink data packet and notifying the CP function about it, when the Apply Action parameter requests to buffer the packets and notify the CP function. | X | - | - | X | - | Downlink Data Notification Delay | +| Suggested Buffering Packets Count | C | This IE may be present if the UP Function indicated support of the feature UDBC.
When present, it shall contain the number of packets that are suggested to be buffered when the Apply Action parameter requests to buffer the packets. The packets that exceed the limit shall be discarded. | - | X | X | X | - | Suggested Buffering Packets Count | +| DL Buffering Duration | C | This IE shall be present if the UP function indicated support of the DL Buffering Duration parameter in PFCP Session Modification Request feature (see DBDM feature in clause 8.2.25) and extended buffering of downlink data packet is required in the UP function.
When present, this IE shall indicate the duration during which the UP function shall buffer the downlink data packets without sending any further notification to the CP function about the arrival of DL data packets. | - | - | - | X | - | DL Buffering Duration | +| DL Buffering Suggested Packet Count | O | This IE may be present if the UP function indicated support of the DL Buffering Suggested Packet Count parameter in PFCP Session Modification Request feature (see DBDM feature in clause 8.2.25) and extended buffering of downlink data packet is required in the UP function.
When present, this IE shall indicate the maximum number of downlink data packets suggested to be buffered in the UP function. | - | - | - | X | - | DL Buffering Suggested Packet Count | +| MT-EDT Control Information | O | This IE may be included to request the SGW-U to report the sum of DL Data Packets Size. | X | - | - | - | - | MT-EDT Control Information | +| NOTE 1: If the Apply Action requests the UP function to buffer and notify the CP function and the DL Buffering Duration is set, the UP function shall not notify the CP function for the duration indicated by the DL Buffering Duration. | | | | | | | | | + +### 7.5.4.12 Remove BAR IE within PFCP Session Modification Request + +The Remove BAR grouped IE shall be encoded as shown in Figure 7.5.4.12-1. + +**Table 7.5.4.12-1: Remove BAR IE within PFCP Session Modification Request** + +| | | | | | | | +|----------------------|-----------------------------------|-----------------------------------------------|-------|------|------|---------| +| Octet 1 and 2 | Remove BAR IE Type = 87 (decimal) | | | | | | +| Octets 3 and 4 | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | IE Type | +| | | | Sx a | Sx b | Sx c | | +| BAR ID | M | This IE shall identify the BAR to be deleted. | X | - | - | BAR ID | + +### 7.5.4.13 Update Traffic Endpoint IE within PFCP Session Modification Request + +The Update Traffic Endpoint grouped IE shall be encoded as shown in Figure 7.5.4.13-1. + +**Table 7.5.4.13-1: Update Traffic Endpoint IE within PFCP Session Modification Request** + +| | | | | | | | +|----------------------|----------------------------------------------|---------------------|-------|------|------|---------| +| Octet 1 and 2 | Update Traffic Endpoint Type = 129 (decimal) | | | | | | +| Octets 3 and 4 | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | IE Type | +| | | | Sx a | Sx b | Sx c | | +| | | | | | | | + +| | | | | | | | | | +|---------------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---------------------------------------------| +| Traffic Endpoint ID | M | This IE shall uniquely identify the Traffic Endpoint to be modified for that PFCP session. | X | X | X | X | X | Traffic Endpoint ID | +| Local F-TEID | C | This IE shall be present if it needs to be changed.
The CP function shall set the CHOOSE (CH) bit to 1 if the CP function requests the UP function to assign a local F-TEID to the PDR.
See NOTE. | X | - | - | X | - | F-TEID | +| Network Instance | O | If present, this IE shall identify the Network instance to match for the incoming packet. See NOTE. | X | X | X | X | X | Network Instance | +| Redundant Transmission Detection Parameters | C | This IE shall be present if it needs to be changed See Table 7.5.2.2-5.
See NOTE. | - | - | - | X | - | Redundant Transmission Detection Parameters | +| UE IP address | C | This IE shall be present if it needs to be changed.
In the 5GC, several IEs with the same IE type may be present to represent multiple UE IP addresses, if the UPF indicated support of the IP6PL feature (see clause 5.21).
When present, the UE IP address(es) present in this IE shall replace the UE IP address(es) stored in the UP function for this traffic endpoint.
See NOTE. | - | X | X | X | - | UE IP address | +| Framed-Route | C | This IE shall be present for a PDR if the UPF indicated support of Framed Routing (see clauses 8.2.25 and 5.16) and it needs to be changed. If present, this IE shall describe a framed route.

Several IEs with the same IE type may be present to provision a list of framed routes. | - | X | - | X | - | Framed-Route | +| Framed-Routing | C | This IE shall be present for a DL PDR if the UPF indicated support of Framed Routing (see clauses 8.2.25 and 5.16) and it needs to be changed. If present, this IE shall describe the routing method for the UP function for the IP route related to Framed-Routes or Framed-IPv6-Routes. (NOTE 2) | - | X | - | X | - | Framed-Routing | +| Framed-IPv6-Route | C | This IE shall be present for a PDR if the UPF indicated support of Framed Routing (see clauses 8.2.25 and 5.16) and it needs to be changed. If present, this IE shall describe a framed IPv6 route.
Several IEs with the same IE type may be present to provision a list of framed IPv6 routes. | - | X | - | X | - | Framed-IPv6-Route | +| QFI | C | This IE shall be present if QFI(s) applicable for the traffic endpoints need to be changed and if the UPF has indicated it supports MTE feature as specified in clause 8.2.25.

If present, this IE shall identify the QoS Flow Identifier to match for the incoming packet.
Several IEs with the same IE type may be present to provision a list of QFIs. When present, the full set of applicable QFIs shall be provided. | - | - | - | X | - | QFI | +| Source Interface Type | C | This IE shall be present if the 3GPP interface type of the traffic endpoint needs to be changed. | X | X | - | X | X | 3GPP Interface Type | +| RAT Type | O | This IE may be present if there is a RAT change for the UL PDR(s) if the PFCP session is established for a MA PDU session. | - | - | - | X | - | RAT Type | + +NOTE 1: The IEs which do not need to be modified shall not be included in the Update Traffic Endpoint IE. The UP function shall continue to behave according to the values previously received for IEs not present in the Update Traffic Endpoint IE. F-TEID may be changed if the SGW-C has received the "Change F-TEID support Indication" over the S11/S4 interface (for an IDLE state UE initiated TAU/RAU procedure to allow the SGW changing the GTP-U F-TEID). + +NOTE 2: In this release of specification, the UP function shall announce the IP route(s) for Framed-Route(s) or Framed-IPv6-Route(s) to the PDN regardless of the value of the Framed-Routing. + +### 7.5.4.14 Remove Traffic Endpoint IE within PFCP Session Modification Request + +The Remove Traffic Endpoint grouped IE shall be encoded as shown in Figure 7.5.4.14-1. + +**Table 7.5.4.14-1: Remove Traffic Endpoint IE within PFCP Session Modification Request** + +| Octet 1 and 2 | | Remove Traffic Endpoint IE Type = 130 (decimal) | | | | | | +|----------------------|---|------------------------------------------------------------|-------|------|------|-------|---------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Traffic Endpoint ID | M | This IE shall identify the Traffic Endpoint to be deleted. | X | X | X | X | Traffic Endpoint ID | + +### 7.5.4.15 Remove MAR IE within PFCP Session Modification Request + +The Remove MAR grouped IE shall be encoded as shown in Figure 7.5.4.15-1. + +**Table 7.5.4.15-1: Remove MAR IE within PFCP Session Modification Request** + +| Octet 1 and 2 | | Remove MAR IE Type = 168 (decimal) | | | | | | +|----------------------|---|-----------------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| MAR ID | M | This IE shall identify the MAR to be deleted. | - | - | - | X | MAR ID | + +### 7.5.4.16 Update MAR IE within PFCP Session Modification Request + +The Update MAR grouped IE shall be encoded as shown in Figure 7.5.4.16-1. + +**Table 7.5.4.16-1: Update MAR IE within PFCP Session Modification Request** + +| Octet 1 and 2 | | Update MAR IE Type = 169 (decimal) | | | | | | +|----------------------|---|------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| | | | | | | | | + +| | | | | | | | | | +|------------------------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|------------------------------------------------------| +| MAR ID | M | This IE shall identify the MAR to be updated. | - | - | - | X | - | MAR ID | +| Steering Functionality | C | This IE shall be present if it is changed. | - | - | - | X | - | Steering Functionality | +| Steering Mode | C | This IE shall be present if it is changed. | - | - | - | X | - | Steering Mode | +| Update 3GPP Access Forwarding Action Information | C | This IE shall be present if the 3GPP Access Forwarding Action Information was provisioned previously and if any of IEs is to be changed.

This IE shall also be present to remove 3GPP Access Forwarding Action Information that was provisioned previously if the UE deregisters from the corresponding access. This shall be done by including this IE with a null length. | - | - | - | X | - | Update 3GPP Access Forwarding Action Information | +| Update Non-3GPP Access Forwarding Action Information | C | This IE shall be present if the Non-3GPP Access Forwarding Action Information was provisioned previously and if any of IEs is to be changed.

This IE shall also be present to remove the Non-3GPP Access Forwarding Action Information that was provisioned previously if the UE deregisters from the corresponding access. This shall be done by including this IE with a null length. | - | - | - | X | - | Update Non-3GPP Access Forwarding Action Information | +| 3GPP Access Forwarding Action Information | C | This IE shall be present to provision 3GPP access specific forwarding action information when this access is added, i.e. when the UE registers to 3GPP access.

See Table 7.5.2.8-2. | - | - | - | X | - | 3GPP Access Forwarding Action Information | +| Non-3GPP Access Forwarding Action Information | C | This IE shall be present to provision Non-3GPP access specific forwarding action information when this access is added, i.e. when the UE registers to non-3GPP access.
See Table 7.5.2.8-3. | - | - | - | X | - | Non-3GPP Access Forwarding Action Information | +| Threshold values | C | This IE shall be present if it is changed. | - | - | - | X | - | Thresholds | +| Steering Mode Indicator | C | This IE shall be included if any of the following flag is set to "1" or if the change of flag(s) from "1" to "0" results in the IE becoming set to all zeros.
Applicable flags are:
- ALBI (Autonomous Load Balancing Indicator): this flag shall be set to "1" if the SMF allows the UPF to apply autonomous load-balance when the Steering Mode is Load-Balancing;

- UEAI (UE Assistance Indicator): this flag shall be set to "1" if the SMF allows UE assistant load-balance when the Steering Mode is Load-Balancing. | - | - | - | X | - | Steering Mode Indicator | +| Transport Mode | C | This IE shall be present if it is changed. | - | - | - | X | - | Transport Mode | + +Table 7.5.4.16-2: Update 3GPP Access Forwarding Action Information IE in Update MAR IE + +| Octet 1 and 2 | Update 3GPP Access Forwarding Action Information IE Type = 175 (decimal) | | | | | | | +|----------------------|--------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|----------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| FAR ID | C | This IE shall be present if it is changed. | - | - | - | X | FAR ID | +| Weight | C | This IE shall be present if it is changed. | - | - | - | X | Weight | +| Priority | C | This IE shall be present if it is changed. | - | - | - | X | Priority | +| URR ID | C | This IE shall be present if a measurement action shall be applied or no longer applied to packets for this access.

When present, this IE shall contain the list of all the URR IDs to be associated to this access. | - | - | - | X | URR ID | +| RAT Type | O | This IE may be present if it is changed. | - | - | - | X | RAT Type | + +**Table 7.5.4.16-3: Update Non-3GPP Access Forwarding Action Information IE in Update MAR IE** + +| Octet 1 and 2 | Update Non-3GPP Access Forwarding Action Information IE Type = 176 (decimal) | | | | | | | +|----------------------------------------------------------|------------------------------------------------------------------------------|---------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Same IEs and requirements as defined in Table 7.5.4.16-2 | | | | | | | | + +### 7.5.4.17 Create PDR/FAR/URR/QER/BAR/MAR IEs within PFCP Session Modification Request + +PFCP Session Modification Request message may conditionally include Create PDR IE, Create FAR IE, Create URR IE, Create QER IE, Create BAR IE and Create MAR IE. The encoding of these IEs are specified within PFCP Session Establishment Request message (see clauses 7.5.2.2 – 7.5.2.8). + +### 7.5.4.18 TSC Management Information IE within PFCP Session Modification Request + +The TSC Management Information grouped IE shall be encoded as shown in Table 7.5.4.18-1. + +**Table 7.5.4.18-1: TSC Management Information IE within PFCP Session Modification Request** + +| Octet 1 and 2 | TSC Management Information IE Type = 199 (decimal) | | | | | | | +|--------------------------------------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|--------------------------------------------------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Port Management Information Container | O | When present, this IE shall contain a Port Management Information container. | - | - | - | X | Port Management Information Container | +| User Plane Node Management Information Container | O | When present, this IE shall contain an User Plane Node Management Information container. | - | - | - | X | User Plane Node Management Information Container | +| NW-TT Port Number | C | When PMIC IE is present, this IE shall contain the related NW-TT Port Number. | - | - | - | X | NW-TT Port Number | +| Direct Reporting Information | C | This IE shall be present if the UPF indicated support of the DRTSC feature and if the TSC management information events shall be reported by the UPF directly to a TSN AF or TSCTSF (see clause 5.26.3.2). | - | - | - | X | Direct Reporting Information | + +The Direct Reporting Information IE shall be encoded as shown in Table 7.5.4.18-2. + +**Table 7.5.4.18-2: Direct Reporting Information** + +| Octet 1 and 2 | Direct Reporting Information = 295 (decimal) | | | | | | | +|-----------------------------|----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|-----------------------------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Event Notification URI | M | This IE shall contain the notification URI to be used for sending the UPF event notifications. | - | - | - | X | Event Notification URI | +| Notification Correlation ID | C | This IE shall indicate the notification correlation id to be included in the UPF event notifications. It shall be present if it is available. | - | - | - | X | Notification Correlation ID | + +### 7.5.4.19 Remove SRR IE within PFCP Session Modification Request + +The Remove SRR grouped IE shall be encoded as shown in Table 7.5.4.19-1. + +**Table 7.5.4.19-1: Remove SRR IE within PFCP Session Modification Request** + +| Octet 1 and 2 | Remove SRR IE Type = 211 (decimal) | | | | | | +|----------------------|------------------------------------|-----------------------------------------------|-------|------|------|------------| +| Octets 3 and 4 | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | +| | | | Sx a | Sx b | Sx c | N4 mb | +| SRR ID | M | This IE shall identify the SRR to be deleted. | - | - | - | X - SRR ID | + +### 7.5.4.20 Update SRR IE within PFCP Session Modification Request + +The Update SRR grouped IE shall be encoded as shown in Table 7.5.4.20-1. + +**Table 7.5.4.20-1: Update SRR IE within PFCP Session Modification Request** + +| Octet 1 and 2 | Update SRR IE Type = 213 (decimal) | | | | | | +|---------------------------------------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------------------------------------------------------| +| Octets 3 and 4 | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | +| | | | Sx a | Sx b | Sx c | N4 mb | +| SRR ID | M | This IE shall uniquely identify the SRR among all the SRRs configured for that PFCP session | - | - | - | X - SRR ID | +| Access Availability Control Information | C | This IE shall be present if the Access Availability Control Information needs to be modified. See Table 7.5.2.9-2.

The CP function shall provide the full Access Availability Control Information IE. The UP function shall replace the Access Availability Control Information IE provisioned earlier, if any, by the new received IE. | - | - | - | X - Access Availability Control Information | +| QoS Monitoring per QoS flow Control Information | C | This IE shall be present if the QoS Monitoring per QoS flow Control Information needs to be modified. See Table 7.5.2.9-3.

The CP function shall provide the full set of QoS Monitoring per QoS flow Control Information IE(s). The UP function shall replace any QoS Monitoring per QoS flow Control Information IE(s) provisioned earlier by the new set of received IE(s).

Several IEs within the same IE type may be present to represent a list of QoS Monitoring per QoS flow Control Information for different QoS flows. | - | - | - | X - QoS Monitoring per QoS flow Control Information | +| Direct Reporting Information | C | This IE shall be present if the Direct Reporting Information IE needs to be modified. See Table 7.5.2.9-4. | - | - | - | X - Direct Reporting Information | +| Traffic Parameter Measurement Control Information | C | This IE shall be present if the Traffic Parameter Measurement Control Information needs to be modified. See Table 7.5.2.9-4.

The CP function shall provide the full set of Traffic Parameter Measurement Control Information(s). The UP function shall replace any Traffic Parameter Measurement Control Information IE(s) provisioned earlier by the new set of received IE(s).

Several IEs within the same IE type may be present to represent a list of Traffic Parameter Measurement Control Information for different QoS flows or different traffic parameters. | - | - | - | X - Traffic Parameter Measurement Control Information | + +### 7.5.4.21 Ethernet Context Information within PFCP Session Modification Request + +The Ethernet Context Information grouped IE shall be encoded as shown in Table 7.5.4.21-1. + +**Table 7.5.4.21-1: Ethernet Context Information IE within PFCP Session Modification Request** + +| Octet 1 and 2 | | Ethernet Context Information IE Type = 254 (decimal) | | | | | | +|------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| MAC Addresses Detected | M | This IE shall be present if one or more MAC addresses need to be associated to the PDU session. Several IEs with the same IE type may be present to provision multiple lists of MAC addresses (e.g. with different V-LAN tags). | - | - | - | X | MAC Addressed Detected | + +## 7.5.4.22 Query Packet Rate Status IE within PFCP Session Modification Request + +The Query Packet Rate Status grouped IE shall be encoded as shown in Table 7.5.4.22-1. + +**Table 7.5.4.22-1: Query Packet Rate Status IE within PFCP Session Modification Request** + +| Octet 1 and 2 | | Query Packet Rate Status IE Type = 263 (decimal) | | | | | | +|----------------------|---|-------------------------------------------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| QER ID | M | This IE shall identify the QER being queried for its Packet Rate Status | - | X | - | X | QER ID | + +## 7.5.5 PFCP Session Modification Response + +### 7.5.5.1 General + +The PFCP Session Modification Response shall be sent over the Sxa, Sxb, Sxc and N4 interface by the UP function to the CP function as a reply to the PFCP Session Modification Request. + +**Table 7.5.5.1-1: Information Elements in a PFCP Session Modification Response** + +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +|----------------------|---|---------------------|-------|------|------|-------|---------| +| | | | Sx a | Sx b | Sx c | N4 mb | | +| | | | | | | | | + +| | | | | | | | | | +|--------------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|--------------------------------------| +| Cause | M | This IE shall indicate the acceptance, partial acceptance or rejection of the corresponding request message. | X | X | X | X | X | Cause | +| Offending IE | C | This IE shall be included if the rejection is due to a conditional or mandatory IE missing or faulty. | X | X | X | X | X | Offending IE | +| Created PDR | C | This IE shall be present if the cause is set to "success", new PDR(s) were requested to be created and the UP function was requested to allocate the local F-TEID or a UE IP address/prefix for the PDR(s).
When present, this IE shall contain the PDR information associated to the PFCP session.
See Table 7.5.3.2-1.
Several IEs within the same IE type may be present to represent a list of created PDRs. | X | X | - | X | X | Created PDR | +| Load Control Information | O | The UP function may include this IE if it supports the load control feature and the feature is activated in the network.
See Table 7.5.3.3-1. | X | X | X | X | X | Load Control Information | +| Overload Control Information | O | During an overload condition, the UP function may include this IE if it supports the overload control feature and the feature is activated in the network. | X | X | X | X | X | Overload Control Information | +| Usage Report | C | This IE shall be present if:
This IE shall be also present if:
Several IEs within the same IE type may be present to represent a list of Usage Reports. | X | X | X | X | - | Usage Report | +| Failed Rule ID | C | This IE shall be included if the Cause IE indicates a rejection due to a rule creation or modification failure. | X | X | X | X | X | Failed Rule ID | +| Additional Usage Reports Information | C | This IE shall be included if the Query URR IE was present or the QAURR flag was set to "1" in the PFCP Session Modification Request, and usage reports need to be sent in additional PFCP Session Report Request messages (see clause 5.2.2.3.1).
When present, this IE shall either indicate that additional usage reports will follow, or indicate the total number of usage reports that need to be sent in PFCP Session Report Request messages. | X | X | X | X | - | Additional Usage Reports Information | +| Created/Updated Traffic Endpoint | C | This IE shall be present if the cause is set to "success", Traffic Endpoint(s) were requested to be created or updated, and the UP function was requested to allocate the local F-TEID or a UE IP address/prefix for the Traffic Endpoint(s).

If the UP function allocates additional UE IP address/prefix (upon receiving a Create Traffic Endpoint or Update Traffic Endpoint in the corresponding PFCP Session Modification Request message from the CP function), this IE shall be present and shall contain the complete list of UE IP address / prefix assigned by the UP function for this PFCP session.

In the 5GC, several IEs with the same IE type may be present to represent multiple UE IP addresses, if the UPF indicated support of the IP6PL feature (see clause 5.21). | X | X | - | X | X | Created Traffic Endpoint | + +| | | | | | | | | | +|-----------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-----------------------------| +| | | (NOTE 1)
When present, this IE shall contain the Traffic Endpoint information associated to the PFCP session.
See Table 7.5.3.5-1.

Several IEs within the same IE type may be present to represent a list of created/updated Traffic Endpoints. | | | | | | | +| TSC Management Information | C | This IE shall be present if the UPF needs to send TSC Management information to the SMF.
Several IEs within the same IE type may be present to transfer PMICs for different NW-TT ports. (NOTE 2). | - | - | - | X | - | TSC Management Information | +| ATSSS Control Parameters | C | This IE shall be present if ATSSS functionality is required in the request message, and the UPF allocates the resources and parameters corresponding to the required ATSSS functionality.
See Table 7.5.3.7-1. | - | - | - | X | - | ATSSS Control Parameters | +| Updated PDR | C | This IE shall be present if a Update PDR is present in the corresponding PFCP Session Modification Request and UP function is requested to allocate a new F-TEID, e.g. to support the redundant transmission on N3/N9 interfaces, or move the application traffic from a default bearer to a new dedicated bearer, or the UP function is requested to assign additional UE IP Address or Prefix, e.g. a shorter than /64 prefix delegation. See Table 7.5.5.5-1.
Several IEs within the same IE type may be present to represent a list of updated PDRs. | - | X | - | X | - | Updated PDR | +| Packet Rate Status Report | C | This IE shall be present if the CP function has requested to report an immediate packet rate status in the PFCP Session Modification Request and the UP function supports the CIOT feature (see clause 8.2.25).
Several IEs within the same IE type may be present to represent a list of Packet Rate Status Reports. | - | X | - | X | - | Packet Rate Status Report | +| Partial Failure Information | C | This IE shall be present if the Cause IE indicates partial acceptance of the request to provide failure information related to a failed rule.
Several IEs within the same IE type may be present to report failures to apply multiple rules.

See Table 7.5.3.1-2. | - | X | X | X | X | Partial Failure Information | +| MBS Session N4 Information | C | This IE shall be included if any IE in this grouped IE needs to be included as specified in clause 5.34.1.

Several IE with the same IE type may be present to contain N4 Information for several MBS Sessions.

See Table 7.5.3.1-5 for encoding. | - | - | - | X | - | MBS Session N4 Information | +| TL-Container | C | This IE shall be present if the UPF/CN-TL needs to send a TL-Container to the SMF/CUC to respond to TL-Container information received in the corresponding request.
Several IEs within the same IE type may be present to provide multiple TL-Containers. | - | - | - | X | - | TL-Container | + +NOTE 1: The UP function supporting the PDI optimization feature and the IP6PL feature (see clause 8.2.25) shall support providing the complete list of UE IP Address IEs in the Created/Updated Endpoint IE. + +NOTE 2: When transferring port and user plane node management information between the TSN AF or the TSCTSF and the NW-TT, since the NW-TT may support multiple ports, there may be several instances of the TSC Management Information IEs containing a Port Management Information Container together with a NW-TT Port Number, and only one instance of the TSC Management Information IE containing a User Plane Node Management Information Container that may also contain a Port Management Information Container together with a NW-TT Port Number. + +### 7.5.5.2 Usage Report IE within PFCP Session Modification Response + +The Usage Report grouped IE shall be encoded as shown in Table 7.5.5.2-1. + +**Table 7.5.5.2-1: Usage Report IE within PFCP Session Modification Response** + +| Octet 1 and 2 | | Usage Report IE Type = 78 (decimal) | | | | | | +|------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| URR ID | M | This IE shall identify the URR for which usage is reported. | X | X | X | X | URR ID | +| UR-SEQN | M | This IE shall uniquely identify the Usage Report for the URR (see clause 5.2.2.3). | X | X | X | X | UR-SEQN | +| Usage Report Trigger | M | This IE shall identify the trigger for this report. | X | X | X | X | Usage Report Trigger | +| Start Time | C | This IE shall be present, except if the Usage Report Trigger indicates 'Start of Traffic', 'Stop of Traffic' or 'MAC Addresses Reporting'.
When present, this IE shall provide the timestamp when the collection of the information in this report was started. | X | X | X | X | Start Time | +| End Time | C | This IE shall be present, except if the Usage Report Trigger indicates 'Start of Traffic', 'Stop of Traffic' or 'MAC Addresses Reporting'.
When present, this IE shall provide the timestamp when the collection of the information in this report was generated. | X | X | X | X | End Time | +| Volume Measurement | C | This IE shall be present if a volume measurement needs to be reported. | X | X | X | X | Volume Measurement | +| Duration Measurement | C | This IE shall be present if a duration measurement needs to be reported. | X | X | X | X | Duration Measurement | +| Time of First Packet | C | This IE shall be present if available for this URR. | - | X | X | X | Time of First Packet | +| Time of Last Packet | C | This IE shall be present if available for this URR. | - | X | X | X | Time of Last Packet | +| Usage Information | C | This IE shall be present if the UP function reports Usage Reports before and after a Monitoring Time or before and after QoS enforcement. When present, it shall indicate whether the usage is reported for the period before or after that time, or before or after QoS enforcement. | X | X | X | X | Usage Information | +| Query URR Reference | C | This IE shall be present if this usage report is sent as a result of a query URR received in a PFCP Session Modification Request and the Query URR Reference IE was present in the PFCP Session Modification Request. When present, it shall be set to the Query URR Reference value received in the PFCP Session Modification Request. | X | X | X | X | Query URR Reference | +| Ethernet Traffic Information | C | This IE shall be present if Ethernet Traffic Information needs to be reported. | - | - | - | X | Ethernet Traffic Information | + +### 7.5.5.3 TSC Management Information IE within PFCP Session Modification Response + +The TSC Management Information grouped IE shall be encoded as shown in Table 7.5.5.3-1. + +**Table 7.5.5.3-1: TSC Management Information IE within PFCP Session Modification Response** + +| Octet 1 and 2 | | TSC Management Information IE Type = 200 (decimal) | | | | | | +|----------------------|---|----------------------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|--------------------------------------------------|---|------------------------------------------------------------------------------------------|---|---|---|---|---|--------------------------------------------------| +| Port Management Information Container | O | When present, this IE shall contain a Port Management Information container. | - | - | - | X | - | Port Management Information Container | +| User Plane Node Management Information Container | O | When present, this IE shall contain an User Plane Node Management Information container. | - | - | - | X | - | User Plane Node Management Information Container | +| NW-TT Port Number | C | When PMIC IE is present, this IE shall contain the related NW-TT Port Number. | - | - | - | X | - | NW-TT Port Number | + +### 7.5.5.4 Packet Rate Status Report IE within PFCP Session Modification Response + +The Packet Rate Status Report grouped IE shall be encoded as shown in Table 7.5.5.4-1. + +**Table 7.5.5.4-1: Packet Rate Status Report IE within PFCP Session Modification Response message** + +| Octet 1 and 2 | Packet Rate Status Report IE Type = 264 (decimal) | | | | | | | +|----------------------|---------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|--------------------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| QER ID | M | This IE shall uniquely identify a QER in a PFCP session. | - | X | - | X | QER ID | +| Packet Rate Status | M | This IE shall indicate the remaining validity time and the remaining number of UL/DL packets that still can be sent. | - | X | - | X | Packet Rate Status | + +### 7.5.5.5 Updated PDR IE within PFCP Session Modification Response + +The Updated PDR grouped IE shall be encoded as shown in Table 7.5.5.5-1. + +**Table 7.5.5.5-1: Updated PDR IE in PFCP Session Modification Response** + +| Octet 1 and 2 | Updated PDR IE Type = 256 (decimal) | | | | | | | +|-----------------------------------------|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|---------------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| PDR ID | M | This IE shall uniquely identify the PDR among all the PDRs configured for that PFCP session. | - | - | - | X | PDR ID | +| Local F-TEID for Redundant Transmission | C | This IE shall be present and shall contain the local F-TEID to be used for this PDR for the reception of redundant uplink packets on the N3/N9 interfaces. | - | - | - | X | F-TEID | +| Local F-TEID | C | If the UP function allocates the F-TEID, this IE shall be present and shall contain the local F-TEID to be used for this PDR. | - | X | - | - | F-TEID | +| UE IP Address | C | If the UP function allocates additional UE IP address/prefix (upon receiving a Update PDR in the corresponding PFCP Session Modification Request message from the CP function), this IE shall be present and shall contain the complete list of UE IP address / prefix assigned by the UP function for this PFCP session.

In the 5GC, several IEs with the same IE type may be present to represent multiple UE IP addresses, if the UPF indicated support of the IP6PL feature (see clause 5.21). | - | X | - | X | UE IP Address | + +## 7.5.6 PFCP Session Deletion Request + +The PFCP Session Deletion Request shall be sent over the Sxa, Sxb, Sxc and N4 interface by the CP function to request the UP function to delete the PFCP session. The PFCP Header for Session Related Messages shall contain the F-SEID identifying the PFCP session (see clause 6.3.4.2). + +**Table 7.5.6-1: Information Elements in a PFCP Session Deletion Request** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|--------------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| TL-Container | C | This IE shall be present if the SMF/CUC needs to send a TL-Container to the UPF/CN-TL.
Several IEs within the same IE type may be present to provide multiple TL-Containers. | - | - | - | X | - | TL-Container | + +## 7.5.7 PFCP Session Deletion Response + +### 7.5.7.1 General + +The PFCP Session Deletion Response shall be sent over the Sxa, Sxb, Sxc and N4 interface by the UP function to the CP function as a reply to the PFCP Session Deletion Request. + +**Table 7.5.7.1-1: Information Elements in a PFCP Session Deletion Response** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|---------------------|-------|------|------|----|-------|---------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| | | | | | | | | | + +| | | | | | | | | | +|--------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|--------------------------------------| +| Cause | M | This IE shall indicate the acceptance or the rejection of the corresponding request message. | X | X | X | X | X | Cause | +| Offending IE | C | This IE shall be included if the rejection is due to a conditional or mandatory IE missing or faulty. | X | X | X | X | X | Offending IE | +| Load Control Information | O | The UP function may include this IE if it supports the load control feature and the feature is activated in the network. See Table 7.5.3.3-1. | X | X | X | X | X | Load Control Information | +| Overload Control Information | O | During an overload condition, the UP function may include this IE if it supports the overload control feature and the feature is activated in the network. See Table 7.5.3.4-1. | X | X | X | X | X | Overload Control Information | +| Usage Report | C | This IE shall be present if a URR had been provisioned in the UP function for the PFCP session being deleted and traffic usage measurements for that URR are available at the UP function.
Several IEs within the same IE type may be present to represent a list of Usage Reports. | X | X | X | X | - | Usage Report | +| Additional Usage Reports Information | C | This IE shall be included if the usage reports need to be sent in additional PFCP Session Report Request messages (see clause 5.2.2.3.1).
When present, this IE shall either indicate that additional usage reports will follow, or indicate the total number of usage reports that need to be sent in PFCP Session Report Request messages. | X | X | X | X | - | Additional Usage Reports Information | +| Packet Rate Status Report | C | This IE shall be present if the CP function has requested in a QER to report the packet rate status when the PFCP session is released and the UP function supports CIOT feature. (See clause 8.2.25) | - | X | - | X | - | Packet Rate Status Report | +| Session Report | C | This IE shall be present if a SRR for QoS monitoring had been provisioned in the UP function for the PFCP session being deleted and QoS monitoring measurements for that SRR are available at the UP function. See Table 7.5.8. 6-1.
Several IEs within the same IE type may be present to represent a list of Session Reports. | - | - | - | X | - | Session Report | +| MBS Session N4 Information | C | This IE shall be included if any IE in this grouped IE needs to be included as specified in clause 5.34.1.

Several IE with the same IE type may be present to contain N4 Information for several MBS Sessions.

See Table 7.5.3.1-5 for encoding. | - | - | - | X | - | MBS Session N4 Information | +| PFCPSDRsp-Flags | C | This IE shall be included if at least one of the flags is set to "1".

- PURU (Pending Usage Reports Unacknowledged): the UP function shall set this flag if the UP function has pending PFCP Session Report Request messages which have not been acknowledged yet when it sends the PFCP Session Deletion Response message. | X | X | X | X | - | PFCPSDRsp-Flags | +| TL-Container | C | This IE shall be present if the UPF/CN-TL needs to send a TL-Container to the SMF/CUC to respond to TL-Container information received in the corresponding request.
Several IEs within the same IE type may be present to provide multiple TL-Containers. | - | - | - | X | - | TL-Container | + +Table 7.5.7.1-2: Packet Rate Status Report IE within PFCP Session Deletion Response message + +| | | | | | | | +|----------------------|---------------------------------------------------|---------------------|-------|----|----------|---------| +| Octet 1 and 2 | Packet Rate Status Report IE Type = 252 (decimal) | | | | | | +| Octets 3 and 4 | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | IE Type | +| | | | Sx | Sx | Sx N4 N4 | | + +| | | | a | b | c | | mb | | +|--------------------|---|----------------------------------------------------------------------------------------------------------------------|---|---|---|---|----|--------------------| +| QER ID | M | This IE shall uniquely identify a QER in a PFCP session. | - | X | - | X | - | QER ID | +| Packet Rate Status | M | This IE shall indicate the remaining validity time and the remaining number of UL/DL packets that still can be sent. | - | X | - | X | - | Packet Rate Status | + +### 7.5.7.2 Usage Report IE within PFCP Session Deletion Response + +The Usage Report grouped IE shall be encoded as shown in Table 7.5.7.2-1. + +**Table 7.5.7.2-1: Usage Report IE within PFCP Session Deletion Response** + +| Octet 1 and 2 | | Usage Report IE Type = 79 (decimal) | | | | | | | +|------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| URR ID | M | This IE shall identify the URR for which usage is reported. | X | X | X | X | - | URR ID | +| UR-SEQN | M | This IE shall uniquely identify the Usage Report for the URR (see clause 5.2.2.3). | X | X | X | X | - | UR-SEQN | +| Usage Report Trigger | M | This IE shall identify the trigger for this report. | X | X | X | X | - | Usage Report Trigger | +| Start Time | C | This IE shall be present, except if the Usage Report Trigger indicates 'Start of Traffic', 'Stop of Traffic' or 'MAC Addresses Reporting'.
When present, this IE shall provide the timestamp when the collection of the information in this report was started. | X | X | X | X | - | Start Time | +| End Time | C | This IE shall be present, except if the Usage Report Trigger indicates 'Start of Traffic', 'Stop of Traffic' or 'MAC Addresses Reporting'.
When present, this IE shall provide the timestamp when the collection of the information in this report was generated. | X | X | X | X | - | End Time | +| Volume Measurement | C | This IE shall be present if a volume needs to be reported. | X | X | X | X | - | Volume Measurement | +| Duration Measurement | C | This IE shall be present if a duration measurement needs to be reported. | X | X | X | X | - | Duration Measurement | +| Time of First Packet | C | This IE shall be present if available for this URR. | - | X | X | X | - | Time of First Packet | +| Time of Last Packet | C | This IE shall be present if available for this URR. | - | X | X | X | - | Time of Last Packet | +| Usage Information | C | This IE shall be present if the UP function reports Usage Reports before and after a Monitoring Time, or before and after QoS enforcement. When present, it shall indicate whether the usage is reported for the period before or after that time, or before or after QoS enforcement. | X | X | X | X | - | Usage Information | +| Ethernet Traffic Information | C | This IE shall be present if Ethernet Traffic Information needs to be reported. See Table 7.5.8.3-3. | - | - | - | X | - | Ethernet Traffic Information | + +## 7.5.8 PFCP Session Report Request + +### 7.5.8.1 General + +The PFCP Session Report Request shall be sent over the Sxa, Sxb, Sxc, N4 and N4mb interface by the UP function to report information related to a PFCP session to the CP function. + +**Table 7.5.8.1-1: Information Elements in a PFCP Session Report Request** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|---------------------|-------|------|------|----|-------|---------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | + +| | | | | | | | | | +|--------------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|--------------------------------------| +| Report Type | M | This IE shall indicate the type of the report. | X | X | X | X | X | Report Type | +| Downlink Data Report | C | This IE shall be present if the Report Type indicates a Downlink Data Report. | X | - | - | X | X | Downlink Data Report | +| Usage Report | C | This IE shall be present if the Report Type indicates a Usage Report.
Several IEs within the same IE type may be present to represent a list of Usage Reports. | X | X | X | X | - | Usage Report | +| Error Indication Report | C | This IE shall be present if the Report Type indicates an Error Indication Report. | X | X | - | X | X | Error Indication Report | +| Load Control Information | O | The UP function may include this IE if it supports the load control feature and the feature is activated in the network.
See Table 7.5.3.3-1. | X | X | X | X | X | Load Control Information | +| Overload Control Information | O | During an overload condition, the UP function may include this IE if it supports the overload control feature and the feature is activated in the network.
See Table 7.5.3.4-1. | X | X | X | X | X | Overload Control Information | +| Additional Usage Reports Information | C | This IE shall be included in one of the additional PFCP Session Report Request messages, if the PFCP Session Modification Response or the PFCP Session Deletion Response indicated that more usage reports would follow (i.e. if the AURI flag was set to "1") (see clause 5.2.2.3.1).
When present, this IE shall indicate the total number of usage reports that need to be sent in all the additional PFCP Session Report Request messages.
This IE may also be included in every additional PFCP Session Report Request message but the last one, with the AURI flag set to 1, to indicate that more usage reports will follow in additional PFCP Session Report Request message. | X | X | X | X | - | Additional Usage Reports Information | +| PFCPSRReq-Flags | C | This IE shall be included if at least one of the flags is set to "1".
- PSDBU (PFCP Session Deleted By the UP function):
- if both the CP function and UP function support the EPFAR feature, the UP function may set this flag if the UP function needs to delete the PFCP session, e.g. to report all remaining non-zero usage reports for all URRs in the PFCP Session and the PFCP session is being deleted locally in the UP function.
- the UP function shall also set this flag when sending the last PFCP Session Report Request message after having received a PFCP Session Deletion Request (see clause 5.2.2.3.1). | X | X | X | X | - | PFCPSRReq-Flags | +| Old CP F-SEID | C | This IE shall be present if the UPF sends the PFCP Session Report Request to a different SMF in an SMF Set. See clauses 5.22.2 and 5.22.3.
When present, it shall indicate the CP F-SEID assigned by the previous SMF to the PFCP session. | - | - | - | X | X | F-SEID | +| Packet Rate Status Report | C | This IE shall be present if the EPFAR is used (see clause 5.18), UP function initiates a PFCP Session release and the CP function has requested in a QER to report the packet rate status when the PFCP session is released.
See Table 7.5.7.1-1. | - | X | - | X | - | Packet Rate Status Report | +| TSC Management Information | C | This IE shall be present if the Report Type indicates TSC Management Information Report.
Several IEs within the same IE type may be present to transfer PMICs for different NW-TT ports. (NOTE). | - | - | - | X | - | TSC Management Information | +| Session Report | C | This IE shall be present if the Report Type indicates a Session Report. See Table 7.5.8.6-1.
Several IEs within the same IE type may be present to represent a list of Session Reports. | - | - | - | X | - | Session Report | + +| | | | | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-------| +| Cause | O | This IE may be present to provide additional reason for sending the PFCP Session Report Request message, e.g. for a UP function initiated PFCP session deletion due to the corresponding L2TP session being terminated. | - | X | - | X | - | Cause | +| NOTE: When transferring port and user plane node management information between the TSN AF or the TSCTSF and NW-TT, since the NW-TT may support multiple ports, there may be several instances of the TSC Management Information IEs containing a Port Management Information Container together with a NW-TT Port Number, and only one instance of the TSC Management Information IE containing a User Plane Node Management Information Container that may also contain a Port Management Information Container together with a NW-TT Port Number. | | | | | | | | | + +### 7.5.8.2 Downlink Data Report IE within PFCP Session Report Request + +The Downlink Data Report grouped IE shall be encoded as shown in Table 7.5.8.2-1. + +**Table 7.5.8.2-1: Downlink Data Report IE within PFCP Session Report Request** + +| Octet 1 and 2 | | Downlink Data Report IE Type = 83 (decimal) | | | | | | | +|-----------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|-----------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| PDR ID | M | This IE shall identify the PDR for which downlink data packets have been received or discarded at the UP function.

More than one IE with this type may be included to represent multiple PDRs having received or discarded downlink data packets. | X | - | - | X | X | PDR ID | +| Downlink Data Service Information | C | This IE shall be included for a PFCP session with an IP PDN type, if the UP function supports the Paging Policy Differentiation feature (see clause 4.9 of 3GPP TS 23.401 [14]) and clause 5.4.3.2 of 3GPP TS 23.501 [28]).
When present, for each PDR and for each packet that triggers a Downlink Data Notification, the UP function shall copy, into the Paging Policy Indication value within this IE, the value of the DSCP in TOS (IPv4) or TC (IPv6) information received in the IP payload of the GTP-U packet from the PGW (see IETF RFC 2474 [13]).

For 5GC, this IE shall also be included over N4, for each PDR and for each packet that triggers a Downlink Data Notification, if the QFI of the downlink data packet is available.

One IE with this type shall be included per PDR ID reported in the message. When multiple PDR ID IEs are present in the message, the Downlink Data Service Information IEs shall be reported according to the order of the PDR ID IEs. | X | - | - | X | - | Downlink Data Service Information | +| DL Data Packets Size | O | This IE may be present if the SGW-U supports the MT-EDT feature and is requested to report the sum of the DL Data Packets Size. | X | - | - | - | - | DL Data Packets Size | +| DL Data Status | O | This IE may be present if the first downlink data packet has been buffered or discarded at the UP function for downlink data delivery status notification. | - | - | - | X | - | Data Status | + +### 7.5.8.3 Usage Report IE within PFCP Session Report Request + +The Usage Report grouped IE shall be encoded as shown in Table 7.5.8.3-1. + +**Table 7.5.8.3-1: Usage Report IE within PFCP Session Report Request** + +| Octet 1 and 2 | Usage Report IE Type = 80 (decimal) | | | | | | | +|----------------------|-------------------------------------|---------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | Length = n | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|-----------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|-----------------------------------| +| URR ID | M | This IE shall identify the URR for which usage is reported. | X | X | X | X | - | URR ID | +| UR-SEQN | M | This IE shall uniquely identify the Usage Report for the URR (see clause 5.2.2.3). | X | X | X | X | - | UR-SEQN | +| Usage Report Trigger | M | This IE shall identify the trigger for this report. | X | X | X | X | - | Usage Report Trigger | +| Start Time | C | This IE shall be present, except if the Usage Report Trigger indicates 'Start of Traffic', 'Stop of Traffic' or 'MAC Addresses Reporting'.
When present, this IE shall provide the timestamp when the collection of the information in this report was started. | X | X | X | X | - | Start Time | +| End Time | C | This IE shall be present, except if the Usage Report Trigger indicates 'Start of Traffic', 'Stop of Traffic' or 'MAC Addresses Reporting'.
When present, this IE shall provide the timestamp when the collection of the information in this report was generated. | X | X | X | X | - | End Time | +| Volume Measurement | C | This IE shall be present if a volume measurement needs to be reported. (NOTE 2) | X | X | X | X | - | Volume Measurement | +| Duration Measurement | C | This IE shall be present if a duration measurement needs to be reported. (NOTE 2) | X | X | X | X | - | Duration Measurement | +| Application Detection Information | C | This IE shall be present if application detection information needs to be reported. | - | X | X | X | - | Application Detection Information | +| UE IP address | C | This IE shall be present if the start or stop of an application has been detected and no UE IP address was provisioned in the PDI. See NOTE 1. | - | - | X | X | - | UE IP address | +| Network Instance | C | This IE shall be present if the start or stop of an application has been detected, no UE IP address was provisioned in the PDI and multiple PDNs with overlapping IP addresses are used in the UP function. See NOTE 1. | - | - | X | X | - | Network Instance | +| Time of First Packet | C | This IE shall be present if available for this URR. | - | X | X | X | - | Time of First Packet | +| Time of Last Packet | C | This IE shall be present if available for this URR. | - | X | X | X | - | Time of Last Packet | +| Usage Information | C | This IE shall be present if the UP function reports Usage Reports before and after a Monitoring Time, or before and after QoS enforcement. When present, it shall indicate whether the usage is reported for the period before or after that time, or before or after QoS enforcement. | X | X | X | X | - | Usage Information | +| Query URR Reference | C | This IE shall be present if this usage report is sent as a result of a query URR received in a PFCP Session Modification Request and the Query URR Reference IE was present in the PFCP Session Modification Request. When present, it shall be set to the Query URR Reference value received in the PFCP Session Modification Request. | X | X | X | X | - | Query URR Reference | +| Event Time Stamp | C | This IE shall be present, if the report is related to an event.
When present, it shall be set to the time when the event occurs.
Several IEs with the same IE type may be present to report multiple occurrences for an event for this URR ID. | - | X | X | X | - | Time Stamp | +| Ethernet Traffic Information | C | This IE shall be present if Ethernet Traffic Information needs to be reported. See Table 7.5.8.3-3. | - | - | - | X | - | Ethernet Traffic Information | +| Join IP Muticast Information | C | This IE shall be present if the UPF needs to report that it has added the PDU session to the DL replication tree of a new IP multicast flow.
Several IEs with the same IE type may be present to report multiple IP multicast flows added to the PDU session. | - | - | - | X | - | Join IP Multicast Information | +| Leave IP Muticast Information | C | This IE shall be present if the UPF needs to report that it has removed the PDU session from the DL replication tree of an IP multicast flow.
Several IEs with the same IE type may be present to report multiple IP multicast flows removed from the PDU session. | - | - | - | X | - | Leave IP Multicast Information | +| Predefined Rules | O | This IE may be present to identify a predefined rule if the | - | X | - | X | - | Predefined | + +| | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| Name | usage report is generated for a predefined URR which was activated via a Activate Predefined Rules IE in a Create PDR IE or an Update PDR IE.

Several IEs with the same IE type may be present to represent multiple Predefined Rules with which the URR is associated. | Rules Name | +| NOTE 1: This is the case for unsolicited application reporting by the TDF. The Network instance is required when the UE IP address cannot be used to determine the corresponding PDN connection. | | | +| NOTE 2: The UP function may send a Usage Report with the Volume/Duration Measurement set to zero. | | | + +**Table 7.5.8.3-2: Application Detection Information IE within Usage Report IE** + +| Octet 1 and 2 | | Application Detection Information IE Type = 68 (decimal) | | | | | | +|-------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|-------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Application ID | M | This IE shall identify the Application ID for which a start or stop of traffic is reported. | - | X | X | X | Application ID | +| Application Instance ID | C | When present, this IE shall identify the Application Instance Identifier for which a start or stop of traffic is reported. It shall be present, when reporting the start of an application, if the Reduced Application Detection Information flag was not set in the Measurement Information and if the flow information for the detected application is deducible. It shall be present, when reporting the stop of an application, if the Reduced Application Detection Information flag was not set in the Measurement Information and if it was provided when reporting the start of the application. | - | X | X | X | Application Instance ID | +| Flow Information | C | When present, this IE shall contain the flow information for the detected application. It shall be present, when reporting the start of an application, if the Reduced Application Detection Information flag was not set in the Measurement Information and if the flow information for the detected application is deducible. | - | X | X | X | Flow Information | +| PDR ID | O | When present, it shall contain the PDR ID which the application traffic matches. | - | X | X | X | PDR ID | + +**Table 7.5.8.3-3: Ethernet Traffic Information IE within Usage Report IE** + +| Octet 1 and 2 | | Ethernet Traffic Information IE Type = 143 (decimal) | | | | | | +|------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| MAC Addresses Detected | C | This IE shall be present if one or more new MAC addresses have been detected. When present, it shall identify the MAC (Ethernet) addresses newly detected as source address of frames sent UL by the UE. Several IEs with the same IE type may be present to provision multiple lists of MAC addresses (e.g. with different V-LAN tags). | - | - | - | X | MAC Addresses Detected | +| MAC Addresses Removed | C | This IE shall be present if one or more new MAC addresses have been removed. When present, it shall identify the MAC (Ethernet) addresses that have been inactive for a duration exceeding the Ethernet inactivity Timer. Several IEs with the same IE type may be present to provision multiple lists of MAC addresses (e.g. with different V-LAN tags). | - | - | - | X | MAC Addresses Removed | + +**Table 7.5.8.3-4: Join IP Multicast Information IE within Usage Report IE** + +| Octet 1 and 2 | | Join IP Multicast Information IE Type = 189 (decimal) | | | | | | +|----------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|----------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| IP Multicast Address | M | This IE shall contain the IP multicast address of the DL multicast flow added to the PDU session. | - | - | - | X | IP Multicast Address | +| Source IP Address | C | This IE shall contain the source specific IP address of the DL multicast flow added to the PDU session, if available. Several IEs with the same IE type may be present to represent multiple source specific addresses. | - | - | - | X | Source IP Address | + +**Table 7.5.8.3-5: Leave IP Multicast Information IE within Usage Report IE** + +| Octet 1 and 2 | | Leave IP Multicast Information IE Type = 190 (decimal) | | | | | | +|----------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|----------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| IP Multicast Address | M | This IE shall contain the IP multicast address of the DL multicast flow removed from the PDU session. | - | - | - | X | IP Multicast Address | +| Source IP Address | C | This IE shall contain the source specific IP address of the DL multicast flow removed from the PDU session, if available. Several IEs with the same IE type may be present to represent multiple source specific addresses. | - | - | - | X | Source IP Address | + +## 7.5.8.4 Error Indication Report IE within PFCP Session Report Request + +The Error Indication Report grouped IE shall be encoded as shown in Table 7.5.8.4-1. + +**Table 7.5.8.4-1: Error Indication Report IE within PFCP Session Report Request** + +| Octet 1 and 2 | | Error Indication Report IE Type = 99 (decimal) | | | | | | +|----------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| Remote F-TEID | M | This IE shall identify the remote F-TEID of the GTP-U bearer for which an Error Indication has been received at the UP function.

More than one IE with this type may be included to represent multiple remote F-TEID for which an Error Indication has been received. | X | X | - | X | F-TEID | + +## 7.5.8.5 TSC Management Information IE within PFCP Session Report Request + +The TSC Management Information grouped IE shall be encoded as shown in Table 7.5.8.5-1. + +**Table 7.5.8.5-1: TSC Management Information IE within PFCP Session Report Request** + +| Octet 1 and 2 | | TSC Management Information IE Type = 201 (decimal) | | | | | | +|----------------------|---|----------------------------------------------------|-------|------|------|-------|---------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | + +| | | | | | | | | | +|--------------------------------------------------|---|------------------------------------------------------------------------------------------|---|---|---|---|---|--------------------------------------------------| +| Port Management Information Container | O | When present, this IE shall contain a Port Management Information container. | - | - | - | X | - | Port Management Information Container | +| User Plane Node Management Information Container | O | When present, this IE shall contain an User Plane Node Management Information container. | - | - | - | X | - | User Plane Node Management Information Container | +| NW-TT Port Number | C | When PMIC IE is present, this IE shall contain the related NW-TT Port Number. | - | - | - | X | - | NW-TT Port Number | + +### 7.5.8.6 Session Report IE within PFCP Session Report Request + +The Session Report grouped IE shall be encoded as shown in Table 7.5.8.6-1. + +**Table 7.5.8.6-1: Session Report IE within PFCP Session Report Request** + +| Octet 1 and 2 | Session Report IE Type = 214 (decimal) | | | | | | | | +|--------------------------------------|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|--------------------------------------| +| Octets 3 and 4 | Length = n | | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| SRR ID | M | This IE shall identify the SRR for which usage is reported. | - | - | - | X | - | SRR ID | +| Access Availability Report | C | This IE shall be present if change of access availability needs to be reported. When present, this IE shall indicate an access type and whether the access type has become available or unavailable. | - | - | - | X | - | Access Availability Report | +| QoS Monitoring Report | C | This IE shall be present if there is at least a QoS Monitoring Report that needs to be reported. Several IEs within the same IE type may be present to represent a list of QoS Monitoring Reports, e.g. for different QoS flows. | - | - | - | X | - | QoS Monitoring Report | +| Traffic Parameter Measurement Report | C | This IE shall be present if there is at least a Traffic Parameter Measurement Report that needs to be reported. Several IEs within the same IE type may be present to represent a list of Traffic Parameter Measurement Reports, e.g., for different QoS flows. | - | - | - | X | - | Traffic Parameter Measurement Report | + +The Access Availability Report IE shall be encoded as shown in Table 7.5.8.2-2. + +**Table 7.5.8.6-2: Access Availability Report IE** + +| Octet 1 and 2 | Access Availability Report IE Type = 218 (decimal) | | | | | | | | +|---------------------------------|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----|-------|---------------------------------| +| Octets 3 and 4 | Length = n | | | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | +| Access Availability Information | M | This IE shall indicate an access type and whether the access type has become available or not available. Up to two IEs with the same IE type may be present to report access availability changes for 3GPP and non-3GPP accesses. | - | - | - | X | - | Access Availability Information | + +The QoS Monitoring Report IE shall be encoded as shown in Table 7.5.8.6-3. + +**Table 7.5.8.6-3: QoS Monitoring Report IE** + +| Octets 1 and 2 | | QoS Monitoring Report IE Type = 247 (decimal) | | | | | | +|----------------------------|---|----------------------------------------------------------------------------------------------------------------------|-------|------|------|----------|----------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 N4 mb | | +| QFI | M | This IE shall identify the QoS Flow Identifier for which QoS monitoring is reported. | - | - | - | X | QFI | +| QoS Monitoring Measurement | M | This IE shall contain the measured packet delay(s) or the indication of packet delay measurement failure. | - | - | - | X | QoS Monitoring Measurement | +| Time Stamp | M | This IE shall provide the timestamp when the collection of the information in this report was generated. | - | - | - | X | Time Stamp | +| Start Time | O | When present, this IE shall provide the timestamp when the collection of the information in this report was started. | - | - | - | X | Start Time | + +The Traffic Parameter Measurement Report IE shall be encoded as shown in Table 7.5.8.6-4. + +**Table 7.5.8.6-4: Traffic Parameter Measurement Report IE** + +| Octets 1 and 2 | | Traffic Parameter Measurement Report Type = 324 (decimal) | | | | | | +|-----------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|----------|-----------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 N4 mb | | +| QFI | M | This IE shall identify the QoS Flow Identifier for which traffic parameter measurement is reported. | - | - | - | X | QFI | +| N6 Jitter Measurement | C | This IE shall be present when N6 Jitter measurement available. The UPF shall include DL Periodicity field in the N6 Jitter Measurement IE. | - | - | - | X | N6 Jitter Measurement | +| UL Periodicity | C | The IE shall be included if the SMF requested to measure UL Periodicity and if this information is available. | - | - | - | X | UL Periodicity | +| Time Stamp | M | This IE shall provide the timestamp when the collection of the information in this report was generated. | - | - | - | X | Time Stamp | +| Start Time | O | When present, this IE shall provide the timestamp when the collection of the information in this report was started. | - | - | - | X | Start Time | + +## 7.5.9 PFCP Session Report Response + +### 7.5.9.1 General + +The PFCP Session Report Response shall be sent over the Sxa, Sxb, Sxc, N4 and N4mb interface by the CP function to the UP function as a reply to the PFCP Session Report Request. + +**Table 7.5.9.1-1: Information Elements in a PFCP Session Report Response** + +| Information elements | P | Condition / Comment | Appl. | | | | | IE Type | +|----------------------|---|---------------------|-------|------|------|----|-------|---------| +| | | | Sx a | Sx b | Sx c | N4 | N4 mb | | + +| | | | | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|----------------------------| +| Cause | M | This IE shall indicate the acceptance or the rejection of the corresponding request message. | X | X | X | X | X | Cause | +| Offending IE | C | This IE shall be included if the rejection is due to a conditional or mandatory IE missing or faulty. | X | X | X | X | X | Offending IE | +| Update BAR | C | This IE shall be present if a BAR previously created for the PFCP session needs to be modified.
A previously created BAR that is not modified shall not be included.
See Table 7.5.9.2-1. | X | - | - | X | - | Update BAR | +| PFCPSRRsp-Flags | C | This IE shall be included if at least one of the flags is set to "1".
- DROBU (Drop Buffered Packets): the CP function shall set this flag if the UP function needs to drop the packets currently buffered for this PFCP session (see NOTE 1). | X | - | - | X | - | PFCPSRRsp-Flags | +| CP F-SEID | O | This IE may be set by the SMF if the UPF indicated support of PFCP sessions successively controlled by different SMFs of a same SMF Set and the Cause IE indicates "Request accepted (success)"(see clause 5.22).

When present, it shall be set to the new F-SEID that the UPF shall use for sending subsequent PFCP session related messages. | - | - | - | X | X | F-SEID | +| N4-u F-TEID | O | This IE may be set by the SMF if the UPF indicated support of PFCP sessions successively controlled by different SMFs of a same SMF Set and the Cause IE indicates "Request accepted (success)".

When present, it shall be set to the new N4-u F-TEID that the UPF shall use for data forwarding towards the SMF. | - | - | - | X | - | F-TEID | +| Alternative SMF IP Address | O | This IE may be set by the SMF if the UPF indicated support of PFCP sessions successively controlled by different SMFs of a same SMF Set and the Cause IE indicates "Redirection Requested" (see clause 5.22).

When present, it shall be set to the IP address of the new SMF to contact. | - | - | - | X | X | Alternative SMF IP Address | +| PGW-C/SMF FQ-CSID | O | This IE may be included by the alternative SMF or PGW-C to allocate a new PGW-C/SMF FQ-CSID for the PFCP session, during the restoration of PFCP sessions associated with one or more PGW-C/SMF FQ-CSID(s) (see clause 5.22.4), if the Cause IE indicates "Request accepted (success)".

When present, the UP function shall replace any earlier value associated to the PFCP session with the new value. | - | X | - | X | - | FQ-CSID | +| Group Id | C | This IE may be included by the alternative SMF or PGW-C to allocate a new Group Id for the PFCP session, during the restoration of PFCP sessions associated with one or more Group Id(s) (see clause 5.22.4), if the Cause IE indicates "Request accepted (success)".

When present, the UP function shall replace any earlier value associated to the PFCP session with the new value. | - | X | - | X | - | Group Id | +| Node ID | C | This IE should be present if the CP F-SEID IE is present.

When present, it shall be set to the Node ID of the SMF that has taken over the control of the PFCP session, i.e. that SMF has assigned the CP F-SEID. | - | - | - | X | - | Node ID | +| NOTE 1: The CP function may request the UP function to drop the packets currently buffered for the PFCP session, when buffering is performed in the UP function, upon receipt of a PFCP Session Report Request notifying the CP function about the arrival of downlink data packets for which the CP function decides to throttle the corresponding Downlink Data Notification message over S11/S4 and. See clause 5.9.3 of 3GPP TS 23.214 [2]. | | | | | | | | | + +## 7.5.9.2 Update BAR IE within PFCP Session Report Response + +The Update BAR grouped IE shall be encoded as shown in Table 7.5.9.2-1. + +**Table 7.5.9.2-1: Update BAR IE in PFCP Session Report Response** + +| Octet 1 and 2 | | Update BAR IE Type = 12 (decimal) | | | | | | +|-------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|------|------|-------|-------------------------------------| +| Octets 3 and 4 | | Length = n | | | | | | +| Information elements | P | Condition / Comment | Appl. | | | | IE Type | +| | | | Sx a | Sx b | Sx c | N4 mb | | +| BAR ID | M | This IE shall identify the BAR Rule to be modified. | X | - | - | X | BAR ID | +| Downlink Data Notification Delay | C | This IE shall be present if the UP function indicated support of the Downlink Data Notification Delay parameter (see clause 8.2.25) and the Downlink Data Notification Delay needs to be modified.
When present, it shall contain the delay the UP function shall apply between receiving a downlink data packet and notifying the CP function about it, when the Apply Action parameter requests to buffer the packets and notify the CP function. | X | - | - | X | Downlink Data Notification Delay | +| DL Buffering Duration | C | This IE shall be present if the UP function indicated support of the DL Buffering Duration parameter in PFCP Session Report Response feature (see DLBD feature in clause 8.2.25) and extended buffering of downlink data packet is required in the UP function.
When present, this IE shall indicate the duration during which the UP function shall buffer the downlink data packets without sending any further notification to the CP function about the arrival of DL data packets. | X | - | - | X | DL Buffering Duration | +| DL Buffering Suggested Packet Count | O | This IE may be present if extended buffering of downlink data packet is required in the UP function.
When present, this IE shall indicate the maximum number of downlink data packets suggested to be buffered in the UP function. | X | - | - | X | DL Buffering Suggested Packet Count | +| Suggested Buffering Packets Count | C | This IE may be present if the UP Function indicated support of the feature UDBC.
When present, it shall contain the number of packets that are suggested to be buffered when the Apply Action parameter requests to buffer the packets. The packets that exceed the limit shall be discarded. | - | X | X | X | Suggested Buffering Packets Count | + +NOTE 1: If the Apply Action requests the UP function to buffer and notify the CP function and the DL Buffering Duration is set, the UP function shall not notify the CP function for the duration indicated by the DL Buffering Duration. + +## 7.6 Error Handling + +### 7.6.1 Protocol Errors + +A protocol error is defined as a message or an Information Element received from a peer entity with an unknown type, or if it is unexpected, or if it has an erroneous content. + +The term silently discarded is used in the following clauses to mean that the receiving PFCP entity's implementation shall discard such a message without further processing or that the receiving PFCP entity discards such an IE and continues processing the message. The conditions for the receiving PFCP entity to silently discard an IE are specified in the subsequent clauses. + +The handling of unknown, unexpected or erroneous PFCP messages and IEs shall provide for the forward compatibility of PFCP. Therefore, the sending PFCP entity shall be able to safely include in a message a new conditional-optional or an optional IE. Such an IE may also have a new type value. Any legacy receiving PFCP entity shall, however, silently discard such an IE and continue processing the message. + +If a protocol error is detected by the receiving PFCP entity, it should log the event including the erroneous message and may include the error in a statistical counter. + +For Response messages containing a rejection Cause value, see clause 7.2.3.2. + +The receiving PFCP entity shall apply the error handling specified in the subsequent clauses. + +If the received erroneous message is a reply to an outstanding PFCP message, the PFCP entity shall stop retransmissions and notify the PFCP application layer of the error even if the reply is silently discarded. + +## 7.6.2 Different PFCP Versions + +If a PFCP entity receives a message of an unsupported PFCP version, it shall return a PFCP Version Not Supported Response message and silently discard the received message. + +## 7.6.3 PFCP Message of Invalid Length + +If a PFCP entity receives a message, which is too short to contain the respective PFCP header, the PFCP-PDU shall be silently discarded. + +If a PFCP entity receives a Request message within an IP/UDP packet of a length that is inconsistent with the value specified in the Length field of the PFCP header, then the receiving PFCP entity should log the error and shall send the Response message with Cause IE value set to "Invalid Length". + +If a PFCP entity receives a Response message within an IP/UDP packet of a length that is inconsistent with the value specified in the Length field of the PFCP header, then the receiving PFCP entity should log the error and shall stop retransmissions of the corresponding Request message, notify the PFCP application layer of the error, and log the error. + +## 7.6.4 Unknown PFCP Message + +If a PFCP entity receives a message with an unknown Message Type value, it shall silently discard the message. + +## 7.6.5 Unexpected PFCP Message + +If a PFCP entity receives an unexpected request message, for example a known message that is sent over an interface for which the message is not defined, or a message that is sent over an interface for which the message is defined, but the direction is incorrect, then the PFCP entity shall silently discard the message and shall log an error. + +If a PFCP entity receives an unexpected response message, for example a message for which there is no corresponding outstanding request, it shall discard the message and may log an error. + +## 7.6.6 Missing Information Elements + +A PFCP entity shall check if all mandatory IEs are present in the received Request message. Apart from Heartbeat Request message, if one or more mandatory information elements are missing in the received Request message, the PFCP entity should log the error and shall send a Response message with Cause IE value set to "Mandatory IE missing" with the type of the missing mandatory IE. + +If a PFCP entity receives a Response message with Cause IE value set to "Mandatory IE missing", it shall notify its upper layer. + +A PFCP entity shall check if all mandatory IEs are present in the received Response message without a rejection Cause value. If one or more mandatory information elements are missing, the PFCP entity shall stop retransmissions of the corresponding Request message, notify the PFCP application layer of the error, and should log the error. + +A PFCP entity shall check if conditional information elements are present in the received Request message, if possible (i.e. if the receiving entity has sufficient information available to check if the respective conditions were met). If one or more conditional information elements are missing, a PFCP entity should log the error and shall send a Response message with Cause IE value set to "Conditional IE missing" together with the type of the missing conditional IE. + +A PFCP entity shall check if conditional information elements are present in the received Response message without a rejection Cause value, if possible (i.e. if the receiving entity has sufficient information available to check if the respective conditions were met). If one or more conditional information elements are missing, a PFCP entity shall stop retransmissions of the corresponding Request message, notify the PFCP application layer of the error, and should log the error. + +Additional information elements may be included in Response messages containing a rejection Cause value, see clause 7.2.3.2. + +Absence of an optional information element shall not trigger any error handling. + +## 7.6.7 Invalid Length Information Element + +An information element has an invalid length when the actual length of the IE is different from the value of the Length field in the IE header. Here, the actual length of the IE means the length of the content field of the received IE. + +If a PFCP message contains more than one information elements and one or more of them have invalid length, the receiving PFCP entity can detect which of the IEs have invalid length only in the following cases: + +- If the Length value in the IE header is greater than the overall length of the message; +- If the invalid length IE is the last one in the message. + +Apart from Heartbeat Request message, if a receiving PFCP entity detects information element with invalid length in a Request message, it shall send an appropriate error response with Cause IE value set to "Invalid length" together with the type of the offending IE. + +## 7.6.8 Semantically incorrect Information Element + +Apart from Echo Request message, the receiver of a PFCP signalling message Request including a mandatory or a verifiable conditional information element with a semantically invalid Value shall discard the request, should log the error, and shall send a response with Cause IE value set to "Mandatory IE incorrect" together with a type and instance of the offending IE. + +The receiver of a PFCP signalling message Response including a mandatory or a verifiable conditional information element with a semantically invalid Value shall notify the upper layer that a message with this sequence number has been received and should log the error. + +If a PFCP entity receives an information element with a value which is shown as reserved, it shall treat that information element as invalid and should log the error. If the invalid IE is received in a Request, and it is a mandatory IE or a verifiable conditional IE, the PFCP entity shall send a response with Cause set to "Mandatory IE incorrect" together with a type and instance of the offending IE. + +The principle is: the use of reserved values invokes error handling; the use of spare values can be silently discarded and for IEs with spare values used, processing shall be continued ignoring the spare values. + +The receiver of a PFCP signalling message including an optional information element with a Value that is not in the range defined for this information element value shall discard this IE, but shall treat the rest of the message as if this IE was absent and continue processing. The receiver shall not check the content of an information element field that is defined as "spare". + +All semantically incorrect optional information elements in a PFCP signalling message shall be treated as not present in the message. + +## 7.6.9 Unknown or unexpected Information Element + +The receiver of a PFCP message including an unexpected information element with a known Type value that is not defined for this message shall discard the IE and log an error. The receiver shall process the message. + +NOTE: An Information Element in an encoded PFCP message or grouped IE is identified by the IE Type. + +## 7.6.10 Repeated Information Elements + +An Information Element is repeated if there is more than one IE with the same IE Type in the scope of the PFCP message (or in the scope of the grouped IE). Such an IE is a member in a list. + +If an information element is repeated in a PFCP signalling message in which repetition of the information element is not specified, only the contents of the information element appearing first shall be handled and all subsequent repetitions of the information element shall be ignored. When the number of repetitions of information elements is specified, only the contents of specified repeated information elements shall be handled and all subsequent repetitions of the information element shall be ignored. + +# 8 Information Elements + +## 8.1 Information Elements Format + +### 8.1.1 Information Element Format + +Figure 8.1.1-1 depicts the format of an Information Element. + +| Octets | Bits | | | | | | | | +|------------|---------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = xxx (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| p to (p+1) | Enterprise ID | | | | | | | | +| k to (n+4) | IE specific data or content of a grouped IE | | | | | | | | + +Figure 8.1.1-1: Information Element Format + +NOTE 1: If the Bit 8 of Octet 1 is not set, this indicates that the IE is defined by 3GPP and the Enterprise ID is absent. If Bit 8 of Octet 1 is set, this indicates that the IE is defined by a vendor and the Enterprise ID is present identified by the Enterprise ID. + +An IE has the following mandatory fields: + +- Type: this field indicates the type of the Information Element. IE type values within the range of 0 to 32767 are reserved for IE defined by 3GPP and are listed in clause 8.1.2 IE type values within the range of 32768 to 65535 are used for vendor-specific IE and the value allocation is controlled by the vendor. +- Length: this field contains the length of the IE excluding the first four octets, which are common for all IEs (Type and Length) and is denoted "n" in Figure 8.1.1-1 and in Figure 8.1.1-2. Bit 8 of the lowest numbered octet is the most significant bit and bit 1 of the highest numbered octet is the least significant bit. + +An IE has the following optional fields: + +- Enterprise ID: if the IE type value is within the range of 32768 to 65535, this field shall contain the IANA-assigned "SMI Network Management Private Enterprise Codes" value of the vendor defining the IE. The Enterprise ID set to "10415" (IANA-assigned "SMI Network Management Private Enterprise Codes") shall not be used for the vendor specific IEs. + +For illustration, Figure 8.1.1-2 depicts the format of a Information Element (IE) defined by 3GPP and is specified in this specification. For IE's defined by 3GPP, the IE type shall be within the range of 0 to 32767. + +| Octets | Bits | | | | | | | | +|------------|---------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = xxx (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | IE specific data or content of a grouped IE | | | | | | | | + +**Figure 8.1.1-2: 3GPP defined Information Element Format** + +NOTE 2: Bit 8 of Octet 1 is not set. This indicates that the Information Element type value has been allocated by 3GPP. + +For illustration, Figure 8.1.1-3 depicts the format of a vendor-specific Information Element, which content is not specified and the IE type value shall be within the range of 32768 to 65535. + +| Octets | Bits | | | | | | | | +|------------|---------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = xxx (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Enterprise ID | | | | | | | | +| 7 to (n+4) | IE specific data or content of a grouped IE | | | | | | | | + +**Figure 8.1.1-3: Vendor-Specific Information Element Format** + +NOTE 3: Bit 8 of Octet 1 is set. This indicates that the IE type value has been allocated by the vendor identified by the Enterprise ID. The content of this IE is vendor specific and therefore out of scope of this specification. + +## 8.1.2 Information Element Types + +A PFCP message may contain several IEs. In order to have forward compatible type definitions for the PFCP IEs, all of them shall be TLV (Type, Length, Value) coded. PFCP IE type values are specified in the Table 8.1.2-1. + +The 3rd column of this table specifies if the IE is either Extendable or has a variable length or a fixed length and a reference to the clause where the IE is specified: + +- Fixed Length: the IE has a fixed set of fields, and a fixed number of octets; +- Variable Length: the IE has a fixed set of fields, and has a variable number of octets. +For example, the last octets may be numbered similar to "5 to (n+4)". In this example, if the value of the length field, n, is 0, then the last field is not present; +- Extendable: the IE has a variable number of fields, and has a variable number of octets. +The last fields are typically specified with the statement: "These octet(s) is/are present only if explicitly specified". The legacy receiving entity shall ignore the unknown octets. + +The 4th column of this table indicates the number of fixed Octets the IE contained when the IE was first defined in the specification, which shall be an integer value reflecting the minimum length of fixed octets defined for the IE. + +An IE of any of the above types may have a null length as specified in clause 5.6.3. This shall not be considered as an error by the receiving PFCP entity. + +In order to improve the efficiency of troubleshooting, it is recommended that the IEs should be arranged in the signalling messages as well as in the grouped IEs, according to the order the IEs are listed in the message definition table or grouped IE definition table in clause 7. However the receiving entity shall be prepared to handle the messages with IEs in any order. + +Within IEs, certain fields may be described as spare. These bits shall be transmitted with the value set to "0". To allow for future features, the receiver shall not evaluate these bits. + +**Table 8.1.2-1: Information Element Types** + +| IE Type value (Decimal) | Information elements | Comment / Reference | Number of Fixed Octets | +|-------------------------|-------------------------------------------|--------------------------------|------------------------| +| 0 | Reserved | | | +| 1 | Create PDR | Extendable / Table 7.5.2.2-1 | Not Applicable | +| 2 | PDI | Extendable / Table 7.5.2.2-2 | Not Applicable | +| 3 | Create FAR | Extendable / Table 7.5.2.3-1 | Not Applicable | +| 4 | Forwarding Parameters | Extendable / Table 7.5.2.3-2 | Not Applicable | +| 5 | Duplicating Parameters | Extendable / Table 7.5.2.3-3 | Not Applicable | +| 6 | Create URR | Extendable / Table 7.5.2.4-1 | Not Applicable | +| 7 | Create QER | Extendable / Table 7.5.2.5-1 | Not Applicable | +| 8 | Created PDR | Extendable / Table 7.5.3.2-1 | Not Applicable | +| 9 | Update PDR | Extendable / Table 7.5.4.2-1 | Not Applicable | +| 10 | Update FAR | Extendable / Table 7.5.4.3-1 | Not Applicable | +| 11 | Update Forwarding Parameters | Extendable / Table 7.5.4.3-2 | Not Applicable | +| 12 | Update BAR (PFCP Session Report Response) | Extendable / Table 7.5.9.2-1 | Not Applicable | +| 13 | Update URR | Extendable / Table 7.5.4.4 | Not Applicable | +| 14 | Update QER | Extendable / Table 7.5.4.5 | Not Applicable | +| 15 | Remove PDR | Extendable / Table 7.5.4.6 | Not Applicable | +| 16 | Remove FAR | Extendable / Table 7.5.4.7 | Not Applicable | +| 17 | Remove URR | Extendable / Table 7.5.4.8 | Not Applicable | +| 18 | Remove QER | Extendable / Table 7.5.4.9 | Not Applicable | +| 19 | Cause | Fixed / Clause 8.2.1 | 1 | +| 20 | Source Interface | Extendable / Clause 8.2.2 | 1 | +| 21 | F-TEID | Extendable / Clause 8.2.3 | 1 | +| 22 | Network Instance | Variable Length / Clause 8.2.4 | Not Applicable | +| 23 | SDF Filter | Extendable / Clause 8.2.5 | 2 | +| 24 | Application ID | Variable Length / Clause 8.2.6 | Not Applicable | +| 25 | Gate Status | Extendable / Clause 8.2.7 | 1 | +| 26 | MBR | Extendable / Clause 8.2.8 | 10 | +| 27 | GBR | Extendable / Clause 8.2.9 | 10 | +| 28 | QER Correlation ID | Extendable / Clause 8.2.10 | 4 | +| 29 | Precedence | Extendable / Clause 8.2.11 | 4 | +| 30 | Transport Level Marking | Extendable / Clause 8.2.12 | 2 | +| 31 | Volume Threshold | Extendable / Clause 8.2.13 | 1 | +| 32 | Time Threshold | Extendable / Clause 8.2.14 | 4 | +| 33 | Monitoring Time | Extendable / Clause 8.2.15 | 4 | +| 34 | Subsequent Volume Threshold | Extendable / Clause 8.2.16 | 1 | +| 35 | Subsequent Time Threshold | Extendable / Clause 8.2.17 | 4 | +| 36 | Inactivity Detection Time | Extendable / Clause 8.2.18 | 4 | +| 37 | Reporting Triggers | Extendable / Clause 8.2.19 | 2 | +| 38 | Redirect Information | Extendable / Clause 8.2.20 | 3 | +| 39 | Report Type | Extendable / Clause 8.2.21 | 1 | +| 40 | Offending IE | Fixed / Clause 8.2.22 | 2 | +| 41 | Forwarding Policy | Extendable / Clause 8.2.23 | 1 | +| 42 | Destination Interface | Extendable / Clause 8.2.24 | 1 | +| 43 | UP Function Features | Extendable / Clause 8.2.25 | 1 | +| 44 | Apply Action | Extendable / Clause 8.2.26 | 1 | +| 45 | Downlink Data Service Information | Extendable / Clause 8.2.27 | 1 | +| 46 | Downlink Data Notification Delay | Extendable / Clause 8.2.28 | 1 | +| 47 | DL Buffering Duration | Extendable / Clause 8.2.29 | 1 | +| 48 | DL Buffering Suggested Packet Count | Variable / Clause 8.2.30 | Not Applicable | +| 49 | PFCPSMReq-Flags | Extendable / Clause 8.2.31 | 1 | +| 50 | PFCPSRRsp-Flags | Extendable / Clause 8.2.32 | 1 | +| 51 | Load Control Information | Extendable / Table 7.5.3.3-1 | Not Applicable | +| 52 | Sequence Number | Fixed Length / Clause 8.2.33 | 4 | +| 53 | Metric | Fixed Length / Clause 8.2.34 | 1 | +| 54 | Overload Control Information | Extendable / Table 7.5.3.4-1 | Not Applicable | +| 55 | Timer | Extendable / Clause 8.2.35 | 1 | +| 56 | PDR ID | Extendable / Clause 8.2.36 | 2 | +| 57 | F-SEID | Extendable / Clause 8.2.37 | 9 | +| 58 | Application ID's PFDs | Extendable / Table 7.4.3.1-2 | Not Applicable | +| 59 | PFD context | Extendable / Table 7.4.3.1-3 | Not Applicable | +| 60 | Node ID | Extendable / Clause 8.2.38 | 1 | +| 61 | PFD contents | Extendable / Clause 8.2.39 | 2 | + +| | | | | +|-----|----------------------------------------------|---------------------------------|----------------| +| 62 | Measurement Method | Extendable / Clause 8.2.40 | 1 | +| 63 | Usage Report Trigger | Extendable / Clause 8.2.41 | 2 | +| 64 | Measurement Period | Extendable / Clause 8.2.42 | 4 | +| 65 | FQ-CSID | Extendable / Clause 8.2.43 | 1 | +| 66 | Volume Measurement | Extendable / Clause 8.2.44 | 1 | +| 67 | Duration Measurement | Extendable / Clause 8.2.45 | 4 | +| 68 | Application Detection Information | Extendable / Table 7.5.8.3-2 | Not Applicable | +| 69 | Time of First Packet | Extendable / Clause 8.2.46 | 4 | +| 70 | Time of Last Packet | Extendable / Clause 8.2.47 | 4 | +| 71 | Quota Holding Time | Extendable / Clause 8.2.48 | 4 | +| 72 | Dropped DL Traffic Threshold | Extendable / Clause 8.2.49 | 1 | +| 73 | Volume Quota | Extendable / Clause 8.2.50 | 1 | +| 74 | Time Quota | Extendable / Clause 8.2.51 | 4 | +| 75 | Start Time | Extendable / Clause 8.2.52 | 4 | +| 76 | End Time | Extendable / Clause 8.2.53 | 4 | +| 77 | Query URR | Extendable / Table 7.5.4.10-1 | Not Applicable | +| 78 | Usage Report (Session Modification Response) | Extendable / Table 7.5.5.2-1 | Not Applicable | +| 79 | Usage Report (Session Deletion Response) | Extendable / Table 7.5.7.2-1 | Not Applicable | +| 80 | Usage Report (Session Report Request) | Extendable / Table 7.5.8.3-1 | Not Applicable | +| 81 | URR ID | Extendable / Clause 8.2.54 | 4 | +| 82 | Linked URR ID | Extendable / Clause 8.2.55 | 4 | +| 83 | Downlink Data Report | Extendable / Table 7.5.8.2-1 | Not Applicable | +| 84 | Outer Header Creation | Extendable / Clause 8.2.56 | 2 | +| 85 | Create BAR | Extendable / Table 7.5.2.6-1 | Not Applicable | +| 86 | Update BAR (Session Modification Request) | Extendable / Table 7.5.4.11-1 | Not Applicable | +| 87 | Remove BAR | Extendable / Table 7.5.4.12-1 | Not Applicable | +| 88 | BAR ID | Extendable / Clause 8.2.57 | 1 | +| 89 | CP Function Features | Extendable / Clause 8.2.58 | 1 | +| 90 | Usage Information | Extendable / Clause 8.2.59 | 1 | +| 91 | Application Instance ID | Variable Length / Clause 8.2.60 | Not Applicable | +| 92 | Flow Information | Extendable / Clause 8.2.61 | 3 | +| 93 | UE IP Address | Extendable / Clause 8.2.62 | 1 | +| 94 | Packet Rate | Extendable / Clause 8.2.63 | 1 | +| 95 | Outer Header Removal | Extendable / Clause 8.2.64 | 1 | +| 96 | Recovery Time Stamp | Extendable / Clause 8.2.65 | 4 | +| 97 | DL Flow Level Marking | Extendable / Clause 8.2.66 | 1 | +| 98 | Header Enrichment | Extendable / Clause 8.2.67 | 1 | +| 99 | Error Indication Report | Extendable / Table 7.5.8.4-1 | Not Applicable | +| 100 | Measurement Information | Extendable / Clause 8.2.68 | 1 | +| 101 | Node Report Type | Extendable / Clause 8.2.69 | 1 | +| 102 | User Plane Path Failure Report | Extendable / Table 7.4.5.1.2-1 | Not Applicable | +| 103 | Remote GTP-U Peer | Extendable / Clause 8.2.70 | 1 | +| 104 | UR-SEQN | Fixed Length / Clause 8.2.71 | 4 | +| 105 | Update Duplicating Parameters | Extendable / Table 7.5.4.3-3 | Not Applicable | +| 106 | Activate Predefined Rules | Variable Length / Clause 8.2.72 | Not Applicable | +| 107 | Deactivate Predefined Rules | Variable Length / Clause 8.2.73 | Not Applicable | +| 108 | FAR ID | Extendable / Clause 8.2.74 | 4 | +| 109 | QER ID | Extendable / Clause 8.2.75 | 4 | +| 110 | OCI Flags | Extendable / Clause 8.2.76 | 1 | +| 111 | PFCP Association Release Request | Extendable / Clause 8.2.77 | 1 | +| 112 | Graceful Release Period | Extendable / Clause 8.2.78 | 1 | +| 113 | PDN Type | Extendable / Clause 8.2.79 | 1 | +| 114 | Failed Rule ID | Extendable / Clause 8.2.80 | 1 | +| 115 | Time Quota Mechanism | Extendable / Clause 8.2.81 | 1 | +| 116 | Reserved | | | +| 117 | User Plane Inactivity Timer | Extendable / Clause 8.2.83 | 4 | +| 118 | Aggregated URRs | Extendable / Table 7.5.2.4-2 | Not Applicable | +| 119 | Multiplier | Fixed / Clause 8.2.84 | 12 | +| 120 | Aggregated URR ID | Fixed / Clause 8.2.85 | 4 | +| 121 | Subsequent Volume Quota | Extendable / Clause 8.2.86 | 1 | +| 122 | Subsequent Time Quota | Extendable / Clause 8.2.87 | 4 | +| 123 | RQI | Extendable / Clause 8.2.88 | 1 | + +| | | | | +|-----|-------------------------------------------------------|----------------------------------|----------------| +| 124 | QFI | Extendable / Clause 8.2.89 | 1 | +| 125 | Query URR Reference | Extendable / Clause 8.2.90 | 4 | +| 126 | Additional Usage Reports Information | Extendable / Clause 8.2.91 | 2 | +| 127 | Create Traffic Endpoint | Extendable / Table 7.5.2.7 | Not Applicable | +| 128 | Created Traffic Endpoint | Extendable / Table 7.5.3.5 | Not Applicable | +| 129 | Update Traffic Endpoint | Extendable / Table 7.5.4.13 | Not Applicable | +| 130 | Remove Traffic Endpoint | Extendable / Table 7.5.4.14 | Not Applicable | +| 131 | Traffic Endpoint ID | Extendable / Clause 8.2.92 | 1 | +| 132 | Ethernet Packet Filter | Extendable / Table 7.5.2.2-3 | Not Applicable | +| 133 | MAC address | Extendable / Clause 8.2.93 | 1 | +| 134 | C-TAG | Extendable / Clause 8.2.94 | 3 | +| 135 | S-TAG | Extendable / Clause 8.2.95 | 3 | +| 136 | Ethertype | Extendable / Clause 8.2.96 | 2 | +| 137 | Proxying | Extendable / Clause 8.2.97 | 1 | +| 138 | Ethernet Filter ID | Extendable / Clause 8.2.98 | 4 | +| 139 | Ethernet Filter Properties | Extendable / Clause 8.2.99 | 1 | +| 140 | Suggested Buffering Packets Count | Extendable / Clause 8.2.100 | 1 | +| 141 | User ID | Extendable / Clause 8.2.101 | 1 | +| 142 | Ethernet PDU Session Information | Extendable / Clause 8.2.102 | 1 | +| 143 | Ethernet Traffic Information | Extendable / Table 7.5.8.3-3 | Not Applicable | +| 144 | MAC Addresses Detected | Extendable / Clause 8.2.103 | 7 | +| 145 | MAC Addresses Removed | Extendable / Clause 8.2.104 | 7 | +| 146 | Ethernet Inactivity Timer | Extendable / Clause 8.2.105 | 4 | +| 147 | Additional Monitoring Time | Extendable / Table 7.5.2.4-3 | Not Applicable | +| 148 | Event Quota | Extendable / Clause 8.2.112 | 4 | +| 149 | Event Threshold | Extendable / Clause 8.2.113 | 4 | +| 150 | Subsequent Event Quota | Extendable / Clause 8.2.106 | 4 | +| 151 | Subsequent Event Threshold | Extendable / Clause 8.2.107 | 4 | +| 152 | Trace Information | Extendable / Clause 8.2.108 | 7 | +| 153 | Framed-Route | Variable Length / Clause 8.2.109 | Not Applicable | +| 154 | Framed-Routing | Fixed Length / Clause 8.2.110 | 4 | +| 155 | Framed-IPv6-Route | Variable Length / Clause 8.2.111 | Not Applicable | +| 156 | Time Stamp | Extendable / Clause 8.2.114 | 4 | +| 157 | Averaging Window | Extendable / Clause 8.2.115 | 4 | +| 158 | Paging Policy Indicator | Extendable / Clause 8.2.116 | 1 | +| 159 | APN/DNN | Variable Length / Clause 8.2.117 | Not Applicable | +| 160 | 3GPP Interface Type | Extendable / Clause 8.2.118 | 1 | +| 161 | PFCPSRReq-Flags | Extendable / Clause 8.2.119 | 1 | +| 162 | PFCPAUReq-Flags | Extendable / Clause 8.2.120 | 1 | +| 163 | Activation Time | Extendable / Clause 8.2.121 | 4 | +| 164 | Deactivation Time | Extendable / Clause 8.2.122 | 4 | +| 165 | Create MAR | Extendable / Table 7.5.2.8-1 | Not Applicable | +| 166 | 3GPP Access Forwarding Action Information | Extendable / Table 7.5.2.8-2 | Not Applicable | +| 167 | Non-3GPP Access Forwarding Action Information | Extendable / Table 7.5.2.8-3 | Not Applicable | +| 168 | Remove MAR | Extendable / Table 7.5.4.15-1 | Not Applicable | +| 169 | Update MAR | Extendable / Table 7.5.4.16-1 | Not Applicable | +| 170 | MAR ID | Extendable / Clause 8.2.123 | 2 | +| 171 | Steering Functionality | Extendable / Clause 8.2.124 | 1 | +| 172 | Steering Mode | Extendable / Clause 8.2.125 | 1 | +| 173 | Weight | Fixed / Clause 8.2.126 | 1 | +| 174 | Priority | Extendable / Clause 8.2.127 | 1 | +| 175 | Update 3GPP Access Forwarding Action Information | Extendable / Table 7.5.4.16-2 | Not Applicable | +| 176 | Update Non 3GPP Access Forwarding Action Information | Extendable / Table 7.5.4.16-3 | Not Applicable | +| 177 | UE IP address Pool Identity | Extendable / Clause 8.2.128 | 2 | +| 178 | Alternative SMF IP Address | Extendable / Clause 8.2.129 | 1 | +| 179 | Packet Replication and Detection Carry-On Information | Extendable / Clause 8.2.130 | 1 | +| 180 | SMF Set ID | Extendable / Clause 8.2.131 | Not applicable | +| 181 | Quota Validity Time | Extendable / Clause 8.2.132 | 4 | + +| | | | | +|-----|----------------------------------------------------------------------------|----------------------------------|----------------| +| 182 | Number of Reports | Fixed / Clause 8.2.133 | 2 | +| 183 | PFCP Session Retention Information (within PFCP Association Setup Request) | Extendable / Table 7.4.4.1-2 | 1 | +| 184 | PFCPASRsp-Flags | Extendable / Clause 8.2.134 | 1 | +| 185 | CP PFCP Entity IP Address | Extendable / Clause 8.2.135 | 1 | +| 186 | PFCPSEReq-Flags | Extendable / Clause 8.2.136 | 1 | +| 187 | User Plane Path Recovery Report | Extendable / Table 7.4.5.1.3-1 | Not Applicable | +| 188 | IP Multicast Addressing Info within PFCP Session Establishment Request | Extendable / Clause 7.5.2.2-4 | Not Applicable | +| 189 | Join IP Multicast Information IE within Usage Report | Extendable / Table 7.5.8.3-4 | Not Applicable | +| 190 | Leave IP Multicast Information IE within Usage Report | Extendable / Table 7.5.8.3-5 | Not Applicable | +| 191 | IP Multicast Address | Extendable / Clause 8.2.137 | 1 | +| 192 | Source IP Address | Extendable / Clause 8.2.138 | 1 | +| 193 | Packet Rate Status | Extendable / Clause 8.2.139 | 1 | +| 194 | Create Bridge/Router Info | Extendable / Clause 8.2.140 | 1 | +| 195 | Created Bridge/Router Info | Extendable / Table 7.5.3.6-1 | Not Applicable | +| 196 | Port Number | Fixed Length / Clause 8.2.141 | 4 | +| 197 | NW-TT Port Number | Fixed Length / Clause 8.2.142 | 4 | +| 198 | 5GS User Plane Node ID | Extendable / Clause 8.2.143 | Not Applicable | +| 199 | TSC Management Information IE within PFCP Session Modification Request | Extendable / Table 7.5.4.18-1 | Not Applicable | +| 200 | TSC Management Information IE within PFCP Session Modification Response | Extendable / Table 7.5.5.3-1 | Not Applicable | +| 201 | TSC Management Information IE within PFCP Session Report Request | Extendable / Table 7.5.8.5-1 | Not Applicable | +| 202 | Port Management Information Container | Variable Length / Clause 8.2.144 | Not Applicable | +| 203 | Clock Drift Control Information | Extendable / Table 7.4.4.1.2-1 | Not Applicable | +| 204 | Requested Clock Drift Information | Extendable / Clause 8.2.145 | 1 | +| 205 | Clock Drift Report | Extendable / Table 7.4.5.1.4-1 | Not Applicable | +| 206 | Time Domain Number | Extendable / Clause 8.2.146 | 1 | +| 207 | Time Offset Threshold | Extendable / Clause 8.2.147 | 8 | +| 208 | Cumulative rateRatio Threshold | Extendable / Clause 8.2.148 | 4 | +| 209 | Time Offset Measurement | Extendable / Clause 8.2.149 | 8 | +| 210 | Cumulative rateRatio Measurement | Extendable / Clause 8.2.150 | 4 | +| 211 | Remove SRR | Extendable / Table 7.5.4.19-1 | Not applicable | +| 212 | Create SRR | Extendable / Table 7.5.2.9-1 | Not applicable | +| 213 | Update SRR | Extendable / Table 7.5.4.21-1 | Not applicable | +| 214 | Session Report | Extendable / Table 7.5.8.7-1 | Not Applicable | +| 215 | SRR ID | Extendable / Clause 8.2.151 | 1 | +| 216 | Access Availability Control Information | Extendable / Table 7.5.2.9-2 | Not applicable | +| 217 | Requested Access Availability Information | Extendable / Clause 8.2.152 | 1 | +| 218 | Access Availability Report | Extendable / Table 7.5.8.6-2 | Not applicable | +| 219 | Access Availability Information | Extendable / Clause 8.2.153 | 1 | +| 220 | Provide ATSSS Control Information | Extendable / Table 7.5.2.10-1 | Not Applicable | +| 221 | ATSSS Control Parameters | Extendable / Table 7.5.3.7-1 | Not Applicable | +| 222 | MPTCP Control Information | Extendable / Clause 8.2.154 | 1 | +| 223 | ATSSS-LL Control Information | Extendable / Clause 8.2.155 | 1 | +| 224 | PMF Control Information | Extendable / Clause 8.2.156 | 1 | +| 225 | MPTCP Parameters | Extendable / Table 7.5.3.7-2 | Not Applicable | +| 226 | ATSSS-LL Parameters | Extendable / Table 7.5.3.7-3 | Not Applicable | +| 227 | PMF Parameters | Extendable / Table 7.5.3.7-4 | Not Applicable | +| 228 | MPTCP Address Information | Extendable / Clause 8.2.157 | 4 | +| 229 | Link-Specific Multipath IP Address | Extendable / Clause 8.2.158 | 1 | +| 230 | PMF Address Information | Extendable / Clause 8.2.159 | 1 | +| 231 | ATSSS-LL Information | Extendable / Clause 8.2.160 | 1 | +| 232 | Data Network Access Identifier | Variable Length / Clause 8.2.161 | Not applicable | +| 233 | UE IP address Pool Information | Extendable / Table 7.4.4.1-3 | Not Applicable | +| 234 | Average Packet Delay | Extendable / Clause 8.2.162 | 4 | +| 235 | Minimum Packet Delay | Extendable / Clause 8.2.163 | 4 | +| 236 | Maximum Packet Delay | Extendable / Clause 8.2.164 | 4 | + +| | | | | +|-----|------------------------------------------------------------------------|-----------------------------------------------|----------------| +| 237 | QoS Report Trigger | Extendable / Clause 8.2.165 | 1 | +| 238 | GTP-U Path QoS Control Information | Extendable / Table 7.4.4.1.3-1 | Not Applicable | +| 239 | GTP-U Path QoS Report (PFCP Node Report Request) | Extendable / Table 7.4.5.1.5-1 | Not Applicable | +| 240 | QoS Information in GTP-U Path QoS Report | Extendable / Table 7.4.5.1.6-1 | Not Applicable | +| 241 | GTP-U Path Interface Type | Extendable / Clause 8.2.166 | 1 | +| 242 | QoS Monitoring per QoS flow Control Information | Extendable / Table 7.5.2.9-3 | Not applicable | +| 243 | Requested QoS Monitoring | Extendable / Clause 8.2.167 | 1 | +| 244 | Reporting Frequency | Extendable / Clause 8.2.168 | 1 | +| 245 | Packet Delay Thresholds | Extendable / Clause 8.2.169 | 1 | +| 246 | Minimum Wait Time | Extendable / Clause 8.2.170 | 4 | +| 247 | QoS Monitoring Report | Extendable / Table 7.5.8.6-3 | Not applicable | +| 248 | QoS Monitoring Measurement | Extendable / Clause 8.2.171 | 1 | +| 249 | MT-EDT Control Information | Extendable / Clause 8.2.172 | 1 | +| 250 | DL Data Packets Size | Extendable / Clause 8.2.173 | 2 | +| 251 | QER Control Indications | Extendable / Clause 8.2.174 | 1 | +| 252 | Packet Rate Status Report | Extendable / Table 7.5.7.1-2 | Not applicable | +| 253 | NF Instance ID | Fixed / Clause 8.2.175 | 16 | +| 254 | Ethernet Context Information | Extendable / Table 7.5.4.21-1 | Not Applicable | +| 255 | Redundant Transmission Parameters | Extendable / Table 7.5.2.2-5, Table 7.5.2.3-4 | Not Applicable | +| 256 | Updated PDR | Extendable / Table 7.5.5.5-1 | Not Applicable | +| 257 | S-NSSAI | Fixed Length / Clause 8.2.176 | 4 | +| 258 | IP version | Extendable / Clause 8.2.177 | 1 | +| 259 | PFCPASReq-Flags | Extendable / Clause 8.2.178 | 1 | +| 260 | Data Status | Extendable / Clause 8.2.179 | 1 | +| 261 | Provide RDS configuration information | Extendable / Table 7.5.2.11-1 | Not Applicable | +| 262 | RDS configuration information | Extendable / Clause 8.2.180 | 1 | +| 263 | Query Packet Rate Status IE within PFCP Session Modification Request | Extendable / Table 7.5.4.22-1 | Not Applicable | +| 264 | Packet Rate Status Report IE within PFCP Session Modification Response | Extendable / Table 7.5.5.4-1 | Not Applicable | +| 265 | Multipath Applicable Indication | Extendable / Clause 8.2.181 | 1 | +| 266 | Bridge Management Information Container | Variable Length / Clause 8.2.182 | Not Applicable | +| 267 | UE IP Address Usage Information | Extendable / Table 7.4.4.3.1-1 | Not Applicable | +| 268 | Number of UE IP Addresses | Extendable / Clause 8.2.183 | 1 | +| 269 | Validity Timer | Extendable / Clause 8.2.184 | 2 | +| 270 | Redundant Transmission Forwarding Parameters | Extendable / Table 7.5.2.3-4 | Not Applicable | +| 271 | Transport Delay Reporting | Extendable / Table 7.5.2.2-6 | Not Applicable | +| 272 | Partial Failure Information | Extendable / Table 7.5.3.1-2 | Not Applicable | +| 273 | Spare | | | +| 274 | Offending IE Information | Variable Length / Clause 8.2.152 | Not Applicable | +| 275 | RAT Type | Extendable / Table 8.2.186 | 1 | +| 276 | L2TP Tunnel Information | Extendable / Table 7.5.2.1-2 | Not Applicable | +| 277 | L2TP Session Information | Extendable / Table 7.5.2.1-3 | Not Applicable | +| 278 | L2TP User Authentication IE | Extendable / Clause 8.2.187 | 1 | +| 279 | Created L2TP Session | Extendable / Table 7.5.3.1-3 | Not Applicable | +| 280 | LNS Address | Extendable / Clause 8.2.188 | 1 | +| 281 | Tunnel Preference | Fixed Length / Clause 8.2.189 | 3 | +| 282 | Calling Number | Variable Length / Clause 8.2.190 | Not Applicable | +| 283 | Called Number | Variable Length / Clause 8.2.191 | Not Applicable | +| 284 | L2TP Session Indications | Extendable / Clause 8.2.192 | 1 | +| 285 | DNS Server Address | Extendable / Clause 8.2.193 | 1 | +| 286 | NBNS Server Address | Extendable / Clause 8.2.194 | 1 | +| 287 | Maximum Receive Unit | Fixed Length / Clause 8.2.195 | 2 | +| 288 | Thresholds | Extendable / Clause 8.2.196 | 1 | +| 289 | Steering Mode Indicator | Extendable / Clause 8.2.197 | 1 | +| 290 | PFCP Session Change Info | Extendable / Table 7.4.7.1-2 | Not Applicable | +| 291 | Group ID | Variable Length / | Not Applicable | + +| | | | | +|--|--|----------------|--| +| | | Clause 8.2.198 | | +|--|--|----------------|--| + +| | | | | +|----------------|---------------------------------------------------|------------------------------------|----------------| +| 292 | CP IP Address | Variable / Clause 8.2.199 | Not Applicable | +| 293 | IP Address and Port number Replacement | Extendable / Clause 8.2.200 | 1 | +| 294 | DNS Query Filter | Extendable / Clause 8.2.201 | 2 | +| 295 | Direct Reporting Information | Extendable / Table 7.5.2.9-4 | Not applicable | +| 296 | Event Notification URI | Variable Length / Clause 8.2.202 | Not Applicable | +| 297 | Notification Correlation ID | Variable Length / Clause 8.2.203 | Not Applicable | +| 298 | Reporting Flags | Extendable / Clause 8.2.204 | Not Applicable | +| 299 | Predefined Rules Name | Variable Length / Clause 8.2.205 | Not Applicable | +| 300 | MBS Session N4mb Control Information | Extendable / Table 7.5.2.1-4 | Not Applicable | +| 301 | MBS Multicast Parameters | Extendable / Table 7.5.2.3-5 | Not Applicable | +| 302 | Add MBS Unicast Parameters | Extendable / Table 7.5.2.3-6 | Not Applicable | +| 303 | MBS Session N4mb Information | Extendable / Table 7.5.3.1-4 | Not Applicable | +| 304 | Remove MBS Unicast Parameters | Extendable / Table 7.5.4.3-4 | Not Applicable | +| 305 | MBS Session Identifier | Extendable Length / Clause 8.2.206 | 1 | +| 306 | Multicast Transport Information | Extendable Length / Clause 8.2.207 | 5 | +| 307 | MBSN4mbReq-Flags | Extendable Length / Clause 8.2.208 | 1 | +| 308 | Local Ingress Tunnel | Extendable / Clause 8.2.209 | 1 | +| 309 | MBS Unicast Parameters ID | Extendable / Clause 8.2.210 | 2 | +| 310 | MBS Session N4 Control Information | Extendable / Table 7.5.2.1-5 | Not Applicable | +| 311 | MBS Session N4 Information | Extendable / Table 7.5.3.1-5 | Not Applicable | +| 312 | MBSN4Resp-Flags | Extendable / Clause 8.2.211 | 1 | +| 313 | Tunnel Password | Variable Length / Clause 8.2.212 | Not Applicable | +| 314 | Area Session ID | Fixed Length / Clause 8.2.213 | 2 | +| 315 | Peer UP Restart Report | Extendable / Clause 7.4.5.1.7 | Not Applicable | +| 316 | DSCP to PPI Control Information | Extendable / Table 7.5.2.1-6 | Not Applicable | +| 317 | DSCP to PPI Mapping Information | Extendable / Clause 8.2.214 | 2 | +| 318 | PFCPSDRsp-Flags | Extendable / Clause 8.2.215 | 1 | +| 319 | QER Indications | Extendable / Clause 8.2.216 | 1 | +| 320 | Vendor-Specific Node Report Type | Extendable / Clause 8.2.217 | 1 | +| 321 | Configured Time Domain | Extendable / Clause 8.2.218 | 1 | +| 322 | Metadata | Variable / Clause 8.2.219 | Not Applicable | +| 323 | Traffic Parameter Measurement Control Information | Extendable / Table 7.5.2.9-5 | Not Applicable | +| 324 | Traffic Parameter Measurement Report | Extendable / Table 7.5.8.6-4 | Not Applicable | +| 325 | Traffic Parameter Threshold | Extendable / Clause 8.2.220 | 1 | +| 326 | DL Periodicity | Extendable / Clause 8.2.221 | 1 | +| 327 | N6 Jitter Measurement | Extendable / Clause 8.2.222 | 1 | +| 328 | Traffic Parameter Measurement Indication | Extendable / Clause 8.2.223 | 1 | +| 329 | UL Periodicity | Extendable / Clause 8.2.224 | 1 | +| 330 | MPQUIC Control Information | Extendable / Clause 8.2.225 | 1 | +| 331 | MPQUIC Parameters | Extendable / Table 7.5.3.7-5 | Not Applicable | +| 332 | MPQUIC Address Information | Extendable / Clause 8.2.226 | 4 | +| 333 | Transport Mode | Extendable / Clause 8.2.227 | 1 | +| 334 | Protocol Description | Extendable / Table 7.5.2.2-7 | Not Applicable | +| 335 | Reporting Suggestion Info | Extendable / Clause 8.2.229 | 1 | +| 336 | TL-Container | Variable Length / Clause 8.2.330 | Not Applicable | +| 337 | Measurement Indication | Extendable / Clause 8.2.231 | 1 | +| 338 | HPLMN S-NSSAI | Fixed Length / Clause 8.2.232 | 4 | +| 339 | Media Transport Protocol | Extendable / Clause 8.2.233 | 1 | +| 340 | RTP Header Extension Information | Extendable / Table 7.5.2.2-8 | Not Applicable | +| 341 | RTP Payload Information | Extendable / Table 7.5.2.2-9 | Not Applicable | +| 342 | RTP Header Extension Type | Fixed Length / Clause 8.2.234 | 1 | +| 343 | RTP Header Extension ID | Fixed Length / Clause 8.2.235 | 1 | +| 344 | RTP Payload Type | Fixed Length / Clause 8.2.236 | 1 | +| 345 | RTP Payload Format | Fixed Length / Clause 8.2.237 | 1 | +| 346 to 32767 | Space. For future use. | | | +| 32768 to 65535 | Reserved for vendor specific IEs | | | + +## 8.2 Information Elements + +### 8.2.1 Cause + +Cause IE is coded as depicted in Figure 8.2.1-1. + +![](06faefab7f20d05bf410e9a250268f64_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 19 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Cause value | | | | | | | | + +**Figure 8.2.1-1: Cause** + +The Cause value shall be included in a response message. In a response message, the Cause value indicates the acceptance or the rejection of the corresponding request message. The Cause value indicates the explicit reason for the rejection. + +**Table 8.2.1-1: Cause values** + +| Message Type | Cause value (decimal) | Meaning | Description | +|--------------------------|-----------------------|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | 0 | Reserved. | Shall not be sent and if received the Cause shall be treated as an invalid IE | +| Acceptance in a response | 1 | Request accepted (success) | "Request accepted (success)" is returned when the PFCP entity has accepted a request. | +| | 2 | More Usage Report to send | This cause shall be returned by the UP function in the PFCP Session Deletion Response message when it has more usage reports to send. (See clause 5.2.2.3.1) | +| | 3 | Request partially accepted | This cause shall be returned if the PSUGC feature is supported by the CP function and the UP function, when a PFCP Session Establishment Request or PFCP Session Modification Request is partially accepted. See clause 5.2.9. | +| | 4-63 | Spare. | This value range shall be used by Cause values in an acceptance response message. See NOTE 1. | +| Rejection in a response | 64 | Request rejected (reason not specified) | This cause shall be returned to report an unspecified rejection cause | +| | 65 | Session context not found | This cause shall be returned, if the F-SEID included in a PFCP Session Modification/Deletion Request message is unknown. | +| | 66 | Mandatory IE missing | This cause shall be returned when the PFCP entity detects that a Mandatory IE is missing in a request message | +| | 67 | Conditional IE missing | This cause shall be returned when the PFCP entity detects that a Conditional IE is missing in a request message. | +| | 68 | Invalid length | This cause shall be returned when the PFCP entity detects that an IE with an invalid length in a request message | +| | 69 | Mandatory IE incorrect | This cause shall be returned when the PFCP entity detects that a Mandatory IE is incorrect in a request message, e.g. the Mandatory IE is malformed or it carries an invalid or unexpected value. | +| | 70 | Invalid Forwarding Policy | This cause shall be used by the UP function in the PFCP Session Establishment Response or PFCP Session Modification Response message if the CP function attempted to provision a FAR with a Forwarding Policy Identifier for which no Forwarding | + +| | | | +|----|--------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Policy is locally configured in the UP function. | +| 71 | Invalid F-TEID allocation option | This cause shall be used by the UP function in the PFCP Session Establishment Response or PFCP Session Modification Response message if the CP function attempted to provision a PDR with a F-TEID allocation option which is incompatible with the F-TEID allocation option used for already created PDRs (by the same or a different CP function) and the Restoration Indication bit was not set to "1" in the request. | +| 72 | No established PFCP Association | This cause shall be used by the CP function or the UP function if they receive a PFCP message other than the PFCP Association Setup Request and the Heartbeat Request message from a peer with which there is no established PFCP Association. | +| 73 | Rule creation/modification Failure | This cause shall be used by the UP function if a received Rule failed to be stored and be applied in the UP function. | +| 74 | PFCP entity in congestion | This cause shall be returned when a PFCP entity has detected node level congestion and performs overload control, which does not allow the request to be processed. | +| 75 | No resources available | This cause shall be returned to indicate a temporary unavailability of resources to process the received request. This cause may also be returned in Partial Failure Information to report that a rule cannot be applied due to a limitation of resources in the UP function. | +| 76 | Service not supported | This cause shall be returned when a PFCP entity receives a message requesting a feature or service that is not supported. | +| 77 | System failure | This cause shall be returned to indicate a system error condition. | +| 78 | Redirection Requested | This cause may be returned to indicate a request to the UPF to redirect its PFCP request to a different SMF. | +| 79 | All dynamic addresses are occupied | This cause may be returned if the UE IP address is to be assigned by the UP function but all UE IP addresses configured for a given Network Instance and/or IP address pool in the UP function are occupied. | +| 80 | Unknown Pre-defined Rule | This cause may be returned in Partial Failure Information to report that a pre-defined rule cannot be applied since being unknown to the UP function. | +| 81 | Unknown Application ID | This cause may be returned in Partial Failure Information to report that a rule cannot be applied due to the Application ID being unknown by the UP function. | +| 82 | L2TP tunnel Establishment failure | This cause shall be returned if the UP function detects an L2TP tunnel failure in the PFCP Session Establishment Response other than those defined for the cause values 87 and 89. | +| 83 | L2TP session Establishment failure | This cause shall be returned if the UP function detects an L2TP session failure in the PFCP Session Establishment Response other than the one defined for the cause value 88. | +| 84 | L2TP tunnel release | This cause may be returned by the UP function when the L2TP tunnel is released, e.g. in a PFCP Session Report Request message to delete the PFCP session if the corresponding L2TP session is terminated since to the LNS initiated the release of the L2TP tunnel or the LNS is failed. See clause 5.31.3. | +| 85 | L2TP session release | This cause may be returned by the UP function when the L2TP session is released, e.g. in a PFCP Session Report Request message to delete the PFCP session if the corresponding L2TP session is terminated since the LNS initiated the release of the L2TP session. See clause 5.31.3. | +| 86 | PFCP session restoration failure due to requested resource not available | This cause should be returned by:
- the UP function when the CP function requests the UP function to re-establish an existing | + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-----------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |

PFCP session (i.e. the Restoration Indication bit set to "1" in the request) but the GTP-U F-TEID or UE IP address provided by the CP function is not available. See clauses 4.3.2 and 4.3.4 of 3GPP TS 23.527 [40].

The resource is not available means that it cannot be assigned to any PFCP session, due to e.g. the address having been decommissioned by OAM from the (MB-) UPF or e.g. the address being no longer operational due to a partial hardware failure at the (MB-)UPF.

| +| | 87 | L2TP tunnel Establishment failure – Tunnel Auth Failure | This cause shall be returned if the UP function detects an L2TP tunnel failure due to tunnel authentication failure in the PFCP Session Establishment Response. | +| | 88 | L2TP Session Establishment failure – Session Auth Failure | This cause shall be returned if the UP function detects an L2TP session establishment failure due to authentication failure in the PFCP Session Establishment Response. | +| | 89 | L2TP tunnel Establishment failure – LNS not reachable | This cause shall be returned if the UP function detects an L2TP tunnel failure due to LNS not reachable in the PFCP Session Establishment Response. | +| | 90 to 255 | Spare for future use in a response message. See NOTE 2. | This value range shall be used by Cause values in a rejection response message. See NOTE 2. | +| NOTE 1: This value is or may be used in future version of the specification. If the receiver cannot comprehend the value, it shall be interpreted as an unspecified acceptance cause. Unspecified/unrecognized acceptance cause shall be treated in the same ways as the cause value 1 "Request accepted (success)". | | | | +| NOTE 2: This value is or may be used in a future version of the specification. If the receiver cannot comprehend the value, it shall be interpreted as an unspecified rejection cause. Unspecified/unrecognized rejection cause shall be treated in the same ways as the cause value 64 "Request rejected (reason not specified)". | | | | + +## 8.2.2 Source Interface + +The Source Interface IE type shall be encoded as shown in Figure 8.2.2-1. It indicates the type of the interface from which an incoming packet is received. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 20 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Interface value | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.2-1: Source Interface** + +The Interface value shall be encoded as a 4 bits binary integer as specified in in Table 8.2.2-1. + +**Table 8.2.2-1: Interface value** + +| Interface value | Values (Decimal) | +|-----------------|------------------| +| Access | 0 | +| Core | 1 | +| SGi-LAN/N6-LAN | 2 | +| CP-function | 3 | +| 5G VN Internal | 4 | +| Spare | 5 to 15 | + +NOTE 1: The "Access" and "Core" values denote an uplink and downlink traffic direction respectively. + +NOTE 2: For indirect data forwarding, the Source Interface in the PDR and the Destination Interface in the FAR shall both be set to "Access", in the forwarding SGW(s). The Interface value does not infer any traffic direction, in PDRs and FARs set up for indirect data forwarding, i.e. with both the Source and Destination Interfaces set to Access. + +## 8.2.3 F-TEID + +The F-TEID IE type shall be encoded as shown in Figure 8.2.3-1. It indicates an F-TEID. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|------|----|----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 21 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | CHID | CH | V6 | V4 | +| 6 to 9 | TEID | | | | | | | | +| m to (m+3) | IPv4 address | | | | | | | | +| p to (p+15) | IPv6 address | | | | | | | | +| q | CHOOSE ID | | | | | | | | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.3-1: F-TEID** + +The following flags are coded within Octet 5: + +- Bit 1 – V4: If this bit is set to "1" and the CH bit is not set, then the IPv4 address field shall be present, otherwise the IPv4 address field shall not be present. +- Bit 2 – V6: If this bit is set to "1" and the CH bit is not set, then the IPv6 address field shall be present, otherwise the IPv6 address field shall not be present. +- Bit 3 – CH (CHOOSE): If this bit is set to "1", then the TEID, IPv4 address and IPv6 address fields shall not be present and the UP function shall assign an F-TEID with an IP4 or an IPv6 address if the V4 or V6 bit is set respectively. This bit shall only be set by the CP function. +- Bit 4 – CHID (CHOOSE ID): If this bit is set to "1", then the UP function shall assign the same F-TEID to the PDRs requested to be created in a PFCP Session Establishment Request or PFCP Session Modification Request with the same CHOOSE ID value. This bit may only be set to "1" if the CH bit is set to "1". This bit shall only be set by the CP function. +- Bit 5 to 8: Spare, for future use and set to "0". + +At least one of the V4 and V6 flags shall be set to "1", and both may be set to "1" for both scenarios: + +- when the CP function is providing F-TEID, i.e. both IPv4 address field and IPv6 address field may be present; or +- when the UP function is requested to allocate the F-TEID, i.e. when CHOOSE bit is set to "1", and the IPv4 address and IPv6 address fields are not present. + +Octet 6 to 9 (TEID) shall be present and shall contain a GTP-U TEID, if the CH bit in octet 5 is not set. When the TEID is present, if both IPv4 and IPv6 addresses are present in the F-TEID IE, then the TEID value shall be shared by both addresses. + +Octets "m to (m+3)" and/or "p to (p+15)" (IPv4 address / IPv6 address fields), if present, it shall contain the respective IP address values. + +Octet q shall be present and shall contain a binary integer value if the CHID bit in octet 5 is set to "1". + +## 8.2.4 Network Instance + +The Network Instance IE type shall be encoded as shown in Figure 8.2.4-1. It indicates a Network instance. + +| Octets | Bits | | | | | | | | +|------------|---------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 22 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Network Instance | | | | | | | | + +**Figure 8.2.4-1: Network Instance** + +The Network instance field shall be encoded as an OctetString and shall contain an identifier which uniquely identifies a particular Network instance (e.g. PDN instance) in the UP function. It may be encoded as a Domain Name or an Access Point Name (APN) as per clause 9.1 of 3GPP TS 23.003 [2]. In the latter case, the PDN Instance field may contain the APN Network Identifier only or the full APN with both the APN Network Identifier and the APN Operator Identifier as specified in 3GPP TS 23.003 [2] clauses 9.1.1 and 9.1.2. + +NOTE: The APN field is not encoded as a dotted string as commonly used in documentation. + +## 8.2.5 SDF Filter + +The SDF Filter IE type shall be encoded as shown in Figure 8.2.5-1. It contains an SDF Filter, i.e. a single IP flow packet filter. + +| Octets | Bits | | | | | | | | | | +|------------|------------------------------------------------------------|---|-----|----|-----|-----|----|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 to 2 | Type = 23 (decimal) | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | +| 5 | Spare | | BID | FL | SPI | TTC | FD | | | | +| 6 | Spare | | | | | | | | | | +| m to (m+1) | Length of Flow Description | | | | | | | | | | +| (m+2) to p | Flow Description | | | | | | | | | | +| s to (s+1) | ToS Traffic Class | | | | | | | | | | +| t to (t+3) | Security Parameter Index | | | | | | | | | | +| v to (v+2) | Flow Label | | | | | | | | | | +| w to (w+3) | SDF Filter ID | | | | | | | | | | +| x to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | + +**Figure 8.2.5-1: SDF Filter** + +The following flags are coded within Octet 5: + +- Bit 1 – FD (Flow Description): If this bit is set to "1", then the Length of Flow Description and the Flow Description fields shall be present, otherwise they shall not be present. +- Bit 2 – TTC (ToS Traffic Class): If this bit is set to "1", then the ToS Traffic Class field shall be present, otherwise the ToS Traffic Class field shall not be present. +- Bit 3 – SPI (Security Parameter Index): If this bit is set to "1", then the Security Parameter Index field shall be present, otherwise the Security Parameter Index field shall not be present. + +- Bit 4 – FL (Flow Label): If this bit is set to "1", then the Flow Label field shall be present, otherwise the Flow Label field shall not be present. +- Bit 5 – BID (Bidirectional SDF Filter): If this bit is set to "1", then the SDF Filter ID shall be present, otherwise the SDF Filter ID shall not be present. +- Bit 6 to 8: Spare, for future use and set to "0". + +The Flow Description field, when present, shall be encoded as an OctetString as specified in clause 5.4.2 of 3GPP TS 29.212 [8]. + +The ToS Traffic Class field, when present, shall be encoded as an OctetString on two octets as specified in clause 5.3.15 of 3GPP TS 29.212 [8]. The ToS/Traffic Class mask field may be set to detect packets with a specific DSCP value (e.g. "0xFC"), or with specific ECN bits (e.g. "0x03") or both (e.g. "0xFF"). + +The Security Parameter Index field, when present, shall be encoded as an OctetString on four octets and shall contain the IPsec security parameter index (which is a 32-bit field), as specified in clause 5.3.51 of 3GPP TS 29.212 [8]. + +The Flow Label field, when present, shall be encoded as an OctetString on 3 octets as specified in clause 5.3.52 of 3GPP TS 29.212 [8] and shall contain an IPv6 flow label (which is a 20-bit field). The bits 8 to 5 of the octet "v" shall be spare and set to zero, and the remaining 20 bits shall contain the IPv6 flow label. + +An SDF Filter may: + +- be a pattern for matching the IP 5 tuple (source IP address or IPv6 network prefix, destination IP address or IPv6 network prefix, source port number, destination port number, protocol ID of the protocol above IP). In the pattern: + - a value left unspecified in a filter matches any value of the corresponding information in a packet; + - an IP address may be combined with a prefix mask; + - port numbers may be specified as port ranges; + - the pattern can be extended by the Type of Service (TOS) (IPv4) / Traffic class (IPv6) and Mask; +- consist of the destination IP address and optional mask, protocol ID of the protocol above IP, the Type of Service (TOS) (IPv4) / Traffic class (IPv6) and Mask and the IPsec Security Parameter Index (SPI); +- consist of the destination IP address and optional mask, the Type of Service (TOS) (IPv4) / Traffic class (IPv6) and Mask and the Flow Label (IPv6); + +NOTE 1: The details about the IPsec Security Parameter Index (SPI), the Type of Service (TOS) (IPv4) / Traffic class (IPv6) and Mask and the Flow Label (IPv6) are defined in 3GPP TS 23.060 [19] clause 15.3. + +- extend the packet inspection beyond the possibilities described above and look further into the packet. Such service data flow filters need to be predefined in the PGW-U, as specified in clause 5.11 of 3GPP TS 23.214 [2]. + +NOTE 2: Such filters may be used to support filtering with respect to a service data flow based on the transport and application protocols used above IP, e.g. for HTTP and WAP. Filtering for further application protocols and services can also be supported. + +The SDF Filter ID, when present, shall be encoded as an Unsigned32 binary integer value. It shall uniquely identify an SDF Filter among all the SDF Filters provisioned for a given PFCP Session. The source/destination IP address and port information, in a bidirectional SDF Filter, shall be set as for downlink IP flows. The SDF filter for the opposite direction has the same parameters, but having the source and destination address/port parameters swapped. When being provisioned with a bidirectional SDF filter in a PDR, the UP function shall apply the SDF filter as specified in clause 5.2.1A.2A. + +## 8.2.6 Application ID + +The Application ID IE type shall be encoded as shown in Figure 8.2.6-1. It contains an Application Identifier referencing an application detection filter in the UP function (e.g. its value may represent an application such as a list of URLs). + +| Octets | Bits | | | | | | | | +|------------|------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 24 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Application Identifier | | | | | | | | + +Figure 8.2.6-1: Application ID + +The Application Identifier shall be encoded as an OctetString (see 3GPP TS 29.212 [8]). + +## 8.2.7 Gate Status + +The Gate Status IE shall be encoded as shown in Figure 8.2.7-1. It indicates whether the service data flow or application's traffic is allowed to be forwarded (gate is open) or shall be discarded (gate is closed) in uplink and/or in downlink direction. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---------|---|---------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 25 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | UL Gate | | DL Gate | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.7-1: Gate Status + +Table 8.2.7-1: UL Gate + +| UL Gate | Value (Decimal) | +|----------------------------------------------------------------------------------------|-----------------| +| OPEN | 0 | +| CLOSED | 1 | +| For future use. Shall not be sent. If received, shall be interpreted as the value "1". | 2, 3 | + +Table 8.2.7-2: DL Gate + +| DL Gate | Value (Decimal) | +|----------------------------------------------------------------------------------------|-----------------| +| OPEN | 0 | +| CLOSED | 1 | +| For future use. Shall not be sent. If received, shall be interpreted as the value "1". | 2, 3 | + +## 8.2.8 MBR + +The MBR IE type shall be encoded as shown in Figure 8.2.8-1. It indicates the maximum bit rate allowed for the uplink and downlink directions. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 26 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 9 | UL MBR | | | | | | | | +| 10 to 14 | DL MBR | | | | | | | | +| 15 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.8-1: MBR + +The UL/DL MBR fields shall be encoded as kilobits per second (1 kbps = 1000 bps) in binary value. The UL/DL MBR fields may require converting values in bits per second to kilobits per second when the UL/DL MBR values are received + +from an interface other than GTPv2 interface. If such conversions result in fractions, then the value of UL/DL MBR fields shall be rounded upwards. The range of UL/DL MBR is specified in 3GPP TS 36.413 [10]. + +NOTE: The encoding is aligned on the encoding specified in 3GPP TS 29.274 [9]. + +## 8.2.9 GBR + +The GBR IE type shall be encoded as shown in Figure 8.2.9-1. It indicates the guaranteed bit rate authorized for the uplink and/or downlink directions. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 27 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 9 | UL GBR | | | | | | | | +| 10 to 14 | DL GBR | | | | | | | | +| 15 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.9-1: GBR** + +The UL/DL GBR fields shall be encoded as kilobits per second (1 kbps = 1000 bps) in binary value. The UL/DL GBR fields may require converting values in bits per second to kilobits per second when the UL/DL GBR values are received from an interface other than GTPv2 interface. If such conversions result in fractions, then the value of UL/DL GBR fields shall be rounded upwards. The range of UL/DL GBR is specified in 3GPP TS 36.413 [10]. + +NOTE: The encoding is aligned on the encoding specified in 3GPP TS 29.274 [9]. + +## 8.2.10 QER Correlation ID + +The QER Correlation ID IE type shall be encoded as shown in Figure 8.2.10-1. It contains a QoS Enforcement Rule Correlation ID to correlate QERs from different PFCP sessions. The QER Correlation ID shall be dynamically assigned by the CP function and provisioned by the CP function in different PFCP sessions to correlate QERs used in these PFCP sessions. + +NOTE: A QER Correlation ID is not a Rule ID. It is only a correlation number to correlate QERs from different PFCP sessions. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 28 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | QER Correlation ID value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.10-1: QER Correlation ID** + +The QER Correlation ID value shall be encoded as an Unsigned32 binary integer value. + +## 8.2.11 Precedence + +The Precedence IE type shall be encoded as shown in Figure 8.2.11-1. It defines the relative precedence of a PDR among all the PDRs provisioned within a PFCP session, when looking for a PDR matching an incoming packet. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 29 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Precedence value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.11-1: Precedence + +The Precedence value shall be encoded as an Unsigned32 binary integer value. The lower precedence values indicate higher precedence of the PDR, and the higher precedence values indicate lower precedence of the PDR when matching a packet. + +## 8.2.12 Transport Level Marking + +The Transport Level Marking IE type shall be encoded as shown in Figure 8.2.12-1. It indicates the DSCP to be used for UL/DL transport level marking. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 30 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | ToS/Traffic Class | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.12-1: Transport Level Marking + +The ToS/Traffic Class shall be encoded on two octets as an OctetString. The first octet shall contain the DSCP value in the IPv4 Type-of-Service or the IPv6 Traffic-Class field and the second octet shall contain the ToS/Traffic Class mask field, which shall be set to "0xFC". See clause 5.3.15 of 3GPP TS 29.212 [8]. + +NOTE: The original ECN bits in the IP header of user plane packets are not changed after applying transport level marking. + +## 8.2.13 Volume Threshold + +The Volume Threshold IE contains the traffic volume thresholds to be monitored by the UP function. It shall be encoded as shown in Figure 8.2.13-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----------|-----------|-----------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 31 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | DLVO
L | ULVO
L | TOVO
L | | +| m to (m+7) | Total Volume | | | | | | | | +| p to (p+7) | Uplink Volume | | | | | | | | +| q to (q+7) | Downlink Volume | | | | | | | | +| s to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.13-1: Volume Threshold + +The following flags are coded within Octet 5: + +- Bit 1 – TOVOL: If this bit is set to "1", then the Total Volume field shall be present, otherwise the Total Volume field shall not be present. +- Bit 2 – ULVOL: If this bit is set to "1", then the Uplink Volume field shall be present, otherwise the Uplink Volume field shall not be present. + +- Bit 3 – DLVOL: If this bit is set to "1", then the Downlink Volume field shall be present, otherwise the Downlink Volume field shall not be present. +- Bit 4 to 8: Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +The Total Volume, Uplink Volume and Downlink Volume fields shall be encoded as an Unsigned64 binary integer value. They shall contain the total, uplink or downlink number of octets respectively. + +## 8.2.14 Time Threshold + +The Time Threshold IE contains the traffic duration threshold to be monitored by the UP function. It shall be encoded as shown in Figure 8.2.14-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 32 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Time Threshold | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.14-1: Time Threshold** + +The Time Threshold field shall be encoded as an Unsigned32 binary integer value. It shall contain the duration in seconds. + +## 8.2.15 Monitoring Time + +The Monitoring Time IE indicates the time at which the UP function is expected to reapply the thresholds. It shall be encoded as shown in Figure 8.2.15-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 33 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Monitoring Time | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.15-1: Monitoring Time** + +The Monitoring Time field shall indicate the monitoring time in UTC time. Octets 5 to 8 shall be encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [12]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +## 8.2.16 Subsequent Volume Threshold + +The Subsequent Volume Threshold IE contains the subsequent traffic volume thresholds to be monitored by the UP function after the Monitoring Time. It shall be encoded as shown in Figure 8.2.16-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----------|-----------|-----------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 34 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | DLVO
L | ULVO
L | TOVO
L | | +| m to (m+7) | Total Volume | | | | | | | | +| p to (p+7) | Uplink Volume | | | | | | | | +| q to (q+7) | Downlink Volume | | | | | | | | +| s to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.16-1: Subsequent Volume Threshold + +The following flags are coded within Octet 5: + +- Bit 1 – TOVOL: If this bit is set to "1", then the Total Volume field shall be present, otherwise the Total Volume field shall not be present. +- Bit 2 – ULVOL: If this bit is set to "1", then the Uplink Volume field shall be present, otherwise the Uplink Volume field shall not be present. +- Bit 3 – DLVOL: If this bit is set to "1", then the Downlink Volume field shall be present, otherwise the Downlink Volume field shall not be present. +- Bit 4 to 8: Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +The Total Volume, Uplink Volume and Downlink Volume fields shall be encoded as an Unsigned64 binary integer value. They shall contain the total, uplink or downlink number of octets respectively. + +## 8.2.17 Subsequent Time Threshold + +The Subsequent Time Threshold IE contains the subsequent traffic duration threshold to be monitored by the UP function after the Monitoring Time. It shall be encoded as shown in Figure 8.2.17-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 35 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Subsequent Time Threshold | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.17-1: Subsequent Time Threshold + +The Subsequent Time Threshold field shall be encoded as an Unsigned32 binary integer value. It shall contain the duration in seconds. + +## 8.2.18 Inactivity Detection Time + +The Inactivity Detection Time IE contains the inactivity time period, in seconds, to be monitored by the UP function. It shall be encoded as shown in Figure 8.2.18-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 36 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Inactivity Detection Time | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.18-1: Inactivity Detection Time + +The Inactivity Detection Time field shall be encoded as an Unsigned32 binary integer value. + +## 8.2.19 Reporting Triggers + +The Reporting Triggers IE shall be encoded as shown in Figure 8.2.19-1. It indicates the reporting trigger(s) for the UP function to send a report to the CP function. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-----------|-----------|-----------|-----------|------------|-----------|-----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 37 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | LIUSA | DROT
H | STOP
T | STAR
T | QUHT
I | TIMT
H | VOLT
H | PERI
O | +| 6 | QVVT
I | IPMJL | EVEQ
U | EVET
H | MACA
R | ENVCL
L | TIMQ
U | VOLQ
U | +| 7 | Spare | Spare | Spare | Spare | Spare | Spare | UPIN
T | REEM
R | +| 8 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.19-1: Reporting Triggers** + +Octet 5 shall be encoded as follows: + +- Bit 1 – PERIO (Periodic Reporting): when set to "1", this indicates a request for periodic reporting. +- Bit 2 – VOLTH (Volume Threshold): when set to "1", this indicates a request for reporting when the data volume usage reaches a volume threshold +- Bit 3 – TIMTH (Time Threshold): when set to "1", this indicates a request for reporting when the time usage reaches a time threshold. +- Bit 4 – QUHTI (Quota Holding Time): when set to "1", this indicates a request for reporting when no packets have been received for a period exceeding the Quota Holding Time. +- Bit 5 – START (Start of Traffic): when set to "1", this indicates a request for reporting when detecting the start of an SDF or Application traffic. +- Bit 6 – STOPT (Stop of Traffic): when set to "1", this indicates a request for reporting when detecting the stop of an SDF or Application Traffic. +- Bit 7 - DROTH (Dropped DL Traffic Threshold): when set to "1", this indicates a request for reporting when the DL traffic being dropped reaches a threshold. +- Bit 8: - LIUSA (Linked Usage Reporting): when set to "1", this indicates a request for linked usage reporting, i.e. a request for reporting a usage report for a URR when a usage report is reported for a linked URR (see clause 5.2.2.4). + +Octet 6 shall be encoded as follows: + +- Bit 1 – VOLQU (Volume Quota): when set to "1", this indicates a request for reporting when a Volume Quota is exhausted. +- Bit 2 – TIMQU (Time Quota): when set to "1", this indicates a request for reporting when a Time Quota is exhausted. +- Bit 3 – ENVCL (Envelope Closure): when set to "1", this indicates a request for reporting when conditions for closure of envelope is met (see clause 5.2.2.3). +- Bit 4 – MACAR (MAC Addresses Reporting): when set to "1", this indicates a request for reporting the MAC (Ethernet) addresses used as source address of frames sent UL by the UE. +- Bit 5 – EVETH (Event Threshold): when set to "1", this indicates a request for reporting when an event threshold is reached. . + +- Bit 6 – EVEQU (Event Quota): when set to "1", this indicates a request for reporting when an Event Quota is reached. . +- Bit 7 – IPMJL (IP Multicast Join/Leave): when set to "1", this indicates a request for reporting when the UPF adds or removes the PDU session to/from the DL replication tree associated with an IP multicast flow. +- Bit 8: – QUVTI (Quota Validity Time): when set to "1", this indicates a usage report being reported for a URR due to the quota validity timer expiry. + +Octet 7 shall be encoded as follows: + +- Bit 1 – REEMR (REport the End Marker Reception): when set to "1", the SMF instructs the UPF to report the reception of the End Marker packet. See clause 5.2.2.2.1 and also clauses 4.2.3.2 and 4.23.4.3 in 3GPP TS 23.502 [29]. +- Bit 2 – UPINT (User Plane Inactivity Timer): when set to "1", this indicates a request for reporting when no packets have been received for a period exceeding the User Plane Inactivity Timer. +- Bit 3 to 8: Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +## 8.2.20 Redirect Information + +Redirect Information is coded as depicted in Figure 8.2.20-1. + +![](761efbc82a397a77e5e4a0afc95a3d44_img.jpg) + +| Octets | Bits | | | | | | | | +|-----------------|------------------------------------------------------------|---|---|---|-----------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-2 | Type = 38 (decimal) | | | | | | | | +| 3-4 | Length = n | | | | | | | | +| 5 | Spare | | | | Redirect Address Type | | | | +| 6-7 | Redirect Server Address Length=a | | | | | | | | +| 8-(8+a-1) | Redirect Server Address | | | | | | | | +| p-(p+1) | Other Redirect Server Address Length=b | | | | | | | | +| (p+2)-(p+2+b-1) | Other Redirect Server Address | | | | | | | | +| m to (m+1) | Redirect Port | | | | | | | | +| s to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.20-1: Redirect Information** + +Redirect Address Type indicates the type of the Redirect Address. It shall be encoded as defined in Table 8.2.20-1. + +**Table 8.2.20-1: Redirect Address Type** + +| Redirect Address Type | Value (Decimal) | +|----------------------------------|-----------------| +| IPv4 address | 0 | +| IPv6 address | 1 | +| URL | 2 | +| SIP URI | 3 | +| IPv4 and IPv6 addresses | 4 | +| Port | 5 | +| IPv4 address and Port | 6 | +| IPv6 address and Port | 7 | +| IPv4 and IPv6 addresses and Port | 8 | +| Spare, for future use. | 9 to 15 | + +The Redirect Server Address Length shall indicate the length of the Redirect Server Address. + +The Redirect Server Address shall be encoded in UTF8String format and shall contain the address of the redirect server (e.g. HTTP redirect server, SIP server) with which the end user is to be connected, as specified in clauses 8.38 and 8.39 of IETF RFC 4006 [16]. + +If the Redirect Address type is set to "IPv4 and IPv6 address", the Redirect Information IE shall include an IPv4 address and an IPv6 address in the Redirect Server Address IE and Other Redirect Server Address. + +The Redirection Address Type may be set to "Port", "IPv4 address and Port", "IPv6 address and Port", or "IPv4 and IPv6 addresses and Port" if the UP function has indicated its support of the RATP feature as specified in clause 8.2.25. + +If the Redirect Address Type is set to Port, the Redirect Address Server Address shall not be present, the UP function shall keep the destination of IP address and only change the destination port to the port as indicated in Redirect Port field. + +If the Redirect Address Type is set to "IPv4 address and Port", "IPv6 address and Port", or "IPv4 and IPv6 addresses and Port", the Redirect Address Server Address and Redirect Port shall be included. When Redirect Address Type is set to "IPv4 and IPv6 addresses and Port", the Other Redirect Server Address shall also be present. + +## 8.2.21 Report Type + +The Report Type IE shall be encoded as shown in Figure 8.2.21-1. It indicates the type of the report the UP function sends to the CP function. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|------|------|------|------|------|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 39 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | UISR | SESR | TMIR | UPIR | ERIR | USAR | DLDR | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.21-1: Report Type + +Octet 5 shall be encoded as follows: + +- Bit 1 – DLDR (Downlink Data Report): when set to "1", this indicates Downlink Data Report +- Bit 2 – USAR (Usage Report): when set to "1", this indicates a Usage Report +- Bit 3 – ERIR (Error Indication Report): when set to "1", this indicates an Error Indication Report. +- Bit 4 – UPIR (User Plane Inactivity Report): when set to "1", this indicates a User Plane Inactivity Report. +- Bit 5 – TMIR (TSC Management Information Report): when set to "1", this indicates a TSC Management Information Report, includes support of integration with TSN, TSCTS and DetNet. +- Bit 6 – SESR (Session Report): when set to "1", this indicates a Session Report. +- Bit 7 – UISR (UP Initiated Session Request): when set to "1", this indicates it is a UP function initiated request for a reason which is indicated by the PFCPSRReq-Flags, for the PFCP session. +- Bit 8 – Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +## 8.2.22 Offending IE + +Offending IE IE is coded as depicted in Figure 8.2.22-1. + +| Octets | Bits | | | | | | | | +|--------|--------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 40 (decimal) | | | | | | | | +| 3 to 4 | Length = 2 | | | | | | | | +| 5 to 6 | Type of the offending IE | | | | | | | | + +Figure 8.2.22-1: Offending IE + +The offending IE shall contain a mandatory IE type, if the rejection is due to a conditional or mandatory IE is faulty or missing. + +## 8.2.23 Forwarding Policy + +The Forwarding Policy IE type shall be encoded as shown in Figure 8.2.23-1. It indicates a specific forwarding policy to apply to packets. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 41 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Forwarding Policy Identifier Length | | | | | | | | +| j to k | Forwarding Policy Identifier | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.23-1: Forwarding Policy** + +The Forwarding Policy Identifier Length shall indicate the length of the Forwarding Policy Identifier. + +The Forwarding Policy Identifier shall be encoded as an Octet String containing a reference to a pre-configured Forwarding Policy in the UP function, with a maximum length of 255 octets. + +## 8.2.24 Destination Interface + +The Destination Interface IE type shall be encoded as shown in Figure 8.2.24-1. It indicates the type of the interface towards which an outgoing packet is sent. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 42 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Interface value | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.24-1: Destination Interface** + +The Interface value shall be encoded as a 4 bits binary integer as specified in Table 8.2.24-1. + +**Table 8.2.24-1: Interface value** + +| Interface value | Values (Decimal) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| Access (NOTE 1, NOTE 3, NOTE 4) | 0 | +| Core (see NOTE 1) | 1 | +| SGi-LAN/N6-LAN | 2 | +| CP- Function | 3 | +| LI Function (see NOTE 2) | 4 | +| 5G VN Internal | 5 | +| Spare | 6 to 15 | +| NOTE 1: The "Access" and "Core" values denote a downlink and uplink traffic direction respectively. | | +| NOTE 2: LI Function may denote an SX3LIF or an LMISF. See clause 5.7. | | +| NOTE 3: For indirect data forwarding, the Source Interface in the PDR and the Destination Interface in the FAR shall both be set to "Access", in the forwarding SGW(s). The Interface value does not infer any traffic direction, in PDRs and FARs set up for indirect data forwarding, i.e. with both the Source and Destination Interfaces set to Access. | | +| NOTE 4: For a HTTP redirection, the Source Interface in the PDR to match the uplink packets to be redirected and the Destination Interface in the FAR to enable the HTTP redirection shall both be set to "Access". | | + +## 8.2.25 UP Function Features + +The UP Function Features IE indicates the features supported by the UP function. It is coded as depicted in Figure 8.2.25-1. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 43 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Supported-Features | | | | | | | | +| 7 to 8 | Additional Supported-Features 1 | | | | | | | | +| 9 to 10 | Additional Supported-Features 2 | | | | | | | | +| 11 to 12 | Additional Supported-Features 3 | | | | | | | | +| 13 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.25-1: UP Function Features** + +The UP Function Features IE takes the form of a bitmask where each bit set indicates that the corresponding feature is supported. Spare bits shall be ignored by the receiver. The same bitmask is defined for all PFCP interfaces. + +The following table specifies the features defined on PFCP interfaces and the interfaces on which they apply. + +**Table 8.2.25-1: UP Function Features** + +| Feature Octet / Bit | Feature | Interface | M/O | Description | +|---------------------|---------|-------------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5/1 | BUCP | Sxa, N4 | O
(NOTE 2) | Downlink Data Buffering in CP function is supported by the UP function. | +| 5/2 | DDND | Sxa, N4 | O | The buffering parameter 'Downlink Data Notification Delay' is supported by the UP function. | +| 5/3 | DLBD | Sxa, N4 | O | The buffering parameter 'DL Buffering Duration' in PFCP Session Report Response is supported by the UP function. | +| 5/4 | TRST | Sxb, Sxc, N4 | O | Traffic Steering is supported by the UP function. | +| 5/5 | FTUP | Sxa, Sxb, N4 | M | F-TEID allocation / release in the UP function is supported by the UP function. | +| 5/6 | PFDM | Sxb, Sxc, N4 | O | The PFD Management procedure is supported by the UP function. | +| 5/7 | HEEU | Sxb, Sxc, N4 | O | Header Enrichment of Uplink traffic is supported by the UP function. | +| 5/8 | TREU | Sxb, Sxc, N4 | O
(NOTE 3) | Traffic Redirection Enforcement in the UP function is supported by the UP function. | +| 6/1 | EMPU | Sxa, Sxb, N4 | M | Sending of End Marker packets supported by the UP function. | +| 6/2 | PDIU | Sxa, Sxb, Sxc, N4, N4mb | O
(NOTE 4) | Support of PDI optimised signalling in UP function (see clause 5.2.1A.2). | +| 6/3 | UDBC | Sxb, Sxc, N4 | O | Support of UL/DL Buffering Control | +| 6/4 | QUOAC | Sxb, Sxc, N4 | O | The UP function supports being provisioned with the Quota Action to apply when reaching quotas. | +| 6/5 | TRACE | Sxa, Sxb, Sxc, N4 | O | The UP function supports Trace (see clause 5.15). | +| 6/6 | FRRT | Sxb, N4 | O | The UP function supports Framed Routing (see IETF RFC 2865 [37] and IETF RFC 3162 [38]). | +| 6/7 | PFDE | Sxb, N4 | O | The UP function supports a PFD Contents including a property with multiple values. | +| 6/8 | EPFAR | Sxa, Sxb, Sxc, N4 | O | The UP function supports the Enhanced PFCP Association Release feature (see clause 5.18). | +| 7/1 | DPDRA | Sxb, Sxc, N4 | O | The UP function supports Deferred PDR Activation or Deactivation. | +| 7/2 | ADPDP | Sxa, Sxb, Sxc, N4 | O | The UP function supports the Activation and Deactivation of Pre-defined PDRs (see clause 5.19). | +| 7/3 | UEIP | Sxb, N4 | O
(NOTE 5) | The UP function supports allocating UE IP addresses or prefixes (see clause 5.21). | +| 7/4 | SSET | N4, N4mb | O | (MB-)UPF support of PFCP sessions successively controlled by different (MB-)SMFs of a same (MB-)SMF Set (see clause 5.22). | +| 7/5 | MNOP | Sxa, Sxb, Sxc, N4 | O | The UP function supports measurement of number of packets which is instructed with the flag 'Measurement of Number of Packets' in a URR. See also clause 5.2.2.2.1. | +| 7/6 | MTE | N4 | O | UPF supports multiple instances of Traffic Endpoint IDs in a PDI. | +| 7/7 | BUNDL | Sxa, Sxb, Sxc, N4, N4mb | O | PFCP messages bundling (see clause 6.5) is supported by the UP function. | +| 7/8 | GCOM | N4 | O | UPF support of 5G VN Group Communication. (See clause 5.23) | +| 8/1 | MPAS | N4, N4mb | O | (MB-)UPF support for multiple PFCP associations to the (MB-)SMFs in an (MB-)SMF set (see clause 5.22.3). | +| 8/2 | RTTL | N4 | O | UPF supports redundant transmission at transport layer. | +| 8/3 | VTIME | Sxb, N4 | O | UP function support of quota validity time feature. | +| 8/4 | NORP | Sxa, Sxb, Sxc, N4 | O | UP function support of Number of Reports as specified in clause 5.2.2.2. | +| 8/5 | IPTV | N4 | O | UPF support of IPTV service (see clause 5.25) | + +| | | | | | +|------|----------|--------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 8/6 | IP6PL | N4 | O | UPF supports: | +| 8/7 | TSN | N4 | O | Integration of 5GS into a TSN data network is supported by the UPF (see clause 5.26.1). | +| 8/8 | MPTCP | N4 | O | UPF support of MPTCP Proxy functionality (see clause 5.20) | +| 9/1 | ATSSS-LL | N4 | O | UPF support of ATSSS-LL steering functionality (see clause 5.20) | +| 9/2 | QFQM | N4 | O | UPF support of per QoS flow per UE QoS monitoring for packet delay (see clause 5.24.4). | +| 9/3 | GPQM | N4 | O | UPF support of per GTP-U Path QoS monitoring (see clause 5.24.5). | +| 9/4 | MT-EDT | Sxa | O | SGW-U support of reporting the size of DL Data Packets. (see clause 5.2.4.1). | +| 9/5 | CIOT | Sxb, N4 | O | UP function support of C IoT feature, e.g. small data packet rate enforcement. (see 5.4.15) | +| 9/6 | ETHAR | N4 | O | UPF support of Ethernet PDU Session Anchor Relocation (see clause 5.13.6). | +| 9/7 | DDDS | N4 | O | UPF support of reporting the first buffered / first discarded downlink data after buffering / directly dropped downlink data for downlink data delivery status notification. | +| 9/8 | RDS | Sxb, N4 | O | UP function support of Reliable Data Service (see clause 5.29). | +| 10/1 | RTTWP | N4 | O | UPF support of RTT measurements towards the UE Without PMF. | +| 10/2 | QUASF | Sxb, Sxc, N4 | O | The UP function supports being provisioned in a URR with an Exempted Application ID for Quota Action or an Exempted SDF Filter for Quota Action which is to be used when the quota is exhausted. See also clauses 5.2.2.2.1 and 5.2.2.3.1. | +| 10/3 | NSPOC | Sxa, Sxb, N4 | O | UP function supports notifying start of Pause of Charging via user plane. | +| 10/4 | L2TP | Sxb, N4 | O | UP function supports the L2TP feature as described in clause 5.31. | +| 10/5 | UPBER | N4 | O | UP function supports the uplink packets buffering during EAS relocation. | +| 10/6 | RESPS | Sxb, N4 | O | UP function supports Restoration of PFCP Sessions associated with one or more PGW-C/SMF FQ-CSID(s), Group Id(s) or CP IP address(es) (see clause 5.22.4) | +| 10/7 | IPREP | N4 | O | UP function supports IP Address and Port number replacement (see clause 5.33.3). | +| 10/8 | DNSTS | N4 | O | UP function support DNS Traffic Steering based on FQDN in the DNS Query message (see clause 5.33.4) | +| 11/1 | DRQOS | N4 | O | UP function supports Direct Reporting of QoS monitoring events to Local NEF or AF (see clause 5.33.5). | +| 11/2 | MBSN4 | N4 | O | UPF supports sending MBS multicast session data to associated PDU sessions using 5GC individual delivery. | +| 11/3 | PSUPRM | N4, N4mb | O | UP function supports Per Slice UP Resource Management (see clause 5.35). | + +| | | | | | +|------|--------|---------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 11/4 | EPPPI | N4 | O | UP function supports Enhanced Provisioning of Paging Policy Indicator feature as specified in clause 5.36.2. | +| 11/5 | RATP | Sxb, N4 | O | UP function supports Redirection Address Types set to "Port", "IPv4 address and Port", "IPv6 address and Port", or "IPv4 and IPv6 addresses and Port". | +| 11/6 | UPIDP | N4 | O | UP function supports User Plane Inactivity Detection and reporting per PDR feature as specified in clause 5.11.3. | +| 11/7 | AFSFC | N4 | O | UP function supports inserting metadata when Application Function influence on Service Function Chaining is used as specified in clause 5.4.8. | +| 11/8 | MPQUIC | N4 | O | UPF support of MPQUIC Proxy functionality (see clause 5.20). | +| 12/1 | REDSM | N4 | O | UP function supports the Redundant Steering Mode (see clause 5.32.8 of 3GPP TS 23.501 [28] and clause 5.2.7.1) | +| 12/2 | DBDM | N4 | O | The buffering parameters 'DL Buffering Duration' and 'DL Buffering Suggested Packet Count' in PFCP Session Modification Request are supported by the UP function. | +| 12/3 | TSCTS | N4 | O | AF requested support of Time Synchronization and/or Time Sensitive Communication is supported by the UP function (see clause 5.26.1). | +| 12/4 | DRTSC | N4 | O | UP function supports Direct Reporting of TSC management information events to TSN AF or TSCTSF (see clause 5.26.3.2). | +| 12/5 | N6JEDB | N4 | O | UPF support of N6 Jitter, DL Periodicity and UL Periodicity Measurement and Reporting, and End of Data Burst marking as specified in clause 5.38.4. | +| 12/6 | QMCON | N4 | O | UPF support of QoS monitoring of Congestion information (see clause 5.39.3.3). | +| 12/7 | DETNET | N4 | O | Deterministic Networking is supported by the UP function (see clause 5.26.1). | +| 12/8 | EML4S | N4 | O | UP function supports ECN Marking for L4S (see clause 5.38.1). | +| 13/1 | PDUSM | N4 | O | UP function supports PDU Set Marking (see clause 5.38.3). | +| 13/2 | CN-TL | N4 | O | UPF support of the TSN Talker and Listener (TL) functionality, i.e. CN-TL. See clause 5.26a. | +| 13/3 | QMDRM | N4 | O | UPF support of QoS monitoring of Data Rate Measurement (see clause 5.39.3.4). | + +NOTE 1: Features are defined as follows: +- Feature Octet / Bit: The octet and bit number within the Supported-Features IE, e.g. "5 / 1". +- Feature: A short name that can be used to refer to the octet / bit and to the feature. +- Interface: A list of applicable interfaces to the feature. +- M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") for a UP function complying with this release of the specification. +A feature defined as mandatory in this release of the specification may not necessarily be defined or mandatory to support in earlier releases (see the respective specifications), therefore a CP function complying with this release of the specification shall be prepared to receive a UP Function Features IE with a mandatory feature bit set to "0". +- Description: A clear textual description of the feature. + +NOTE 2: Downlink data should be buffered preferably in the UP function. Downlink data may be buffered in the CP function when desired, e.g. for UEs using power saving methods. + +NOTE 3: If the traffic that the UP function can support may be subject to traffic redirection, traffic redirection enforcement in the UP function shall be supported by the UP function. + +NOTE 4: CP and UP functions complying with this release of the specification should support this feature. + +NOTE 5: A UPF that supports the SSET or MPAS feature shall support this feature. + +## 8.2.26 Apply Action + +The Apply Action IE indicates the action(s) the UP function is required to apply to packets. It is coded as shown in Figure 8.2.26-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|------|------|------|------|------|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 44 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | DFRT | IPMD | IPMA | DUPL | NOCP | BUFF | FORW | DROP | +| 6 | Spare | | | MBSU | FSSM | DDPN | BDPN | EDRT | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.26-1: Apply Action** + +The octet 5 shall be encoded as follows: + +- Bit 1 – DROP (Drop): when set to "1", this indicates a request to drop the packets. +- Bit 2 – FORW (Forward): when set to "1", this indicates a request to forward the packets. +- Bit 3 – BUFF (Buffer): when set to "1", this indicates a request to buffer the packets. +- Bit 4 – NOCP (Notify the CP function): when set to "1", this indicates a request to notify the CP function about the arrival of a first downlink packet being buffered. +- Bit 5 – DUPL (Duplicate): when set to "1", this indicates a request to duplicate the packets. +- Bit 6 – IPMA (IP Multicast Accept): used for IPTV; when set to "1", this indicates a request to accept UE requests to join an IP multicast group. +- Bit 7 – IPMD (IP Multicast Deny): used for IPTV; when set to "1", this indicates a request to deny UE requests to join an IP multicast group. +- Bit 8 – DFRT (Duplicate for Redundant Transmission): used for URLLC; when set to "1", this indicates a request to duplicate the packets for redundant transmission (see clause 5.24.2). + +The octet 6 shall be encoded as follows: + +- Bit 1 – EDRT (Eliminate Duplicate Packets for Redundant Transmission): used for URLLC; when set to "1", this indicates a request to eliminate duplicate packets used for redundant transmission (see clause 5.24.2). +- Bit 2 – BDPN (Buffered Downlink Packet Notification): used for DDDS; when set to "1", this indicates a request to notify the CP function about the first buffered DL packet for downlink data delivery status notification (see clause 5.28). +- Bit 3 – DDPN (Discarded Downlink Packet Notification): used for DDDS; when set to "1", this indicates a request to notify the CP function about the first discarded DL packet for downlink data delivery status notification if the DL Buffering Duration or DL Buffering Suggested Packet Count is exceeded or it is discarded directly. See clause 5.2.3.1 and 5.28. +- Bit 4 - FSSM (Forward packets to lower layer SSM): used for 5MBS; when set to "1", this indicates a request to the MB-UPF to forward MBS session data towards a low layer SSM address allocated by the MB-UPF using multicast transport (see clause 5.34.2). +- Bit 5 – MBSU (Forward and replicate MBS data using Unicast transport): used for 5MBS; when set to "1", this indicates a request to forward and replicate MBS session data towards multiple remote GTP-U peers using unicast transport(see clause 5.34.2). +- Bit 6 to 8 – Spare, for future use and set to "0". + +One and only one of the DROP, FORW, BUFF, IPMA, IPMD and (FSSM and/or MBSU) flags shall be set to "1". Both the MBSU flag and the FSSM flag may be set to "1" (to require the MB-UPF to forward MBS session data using both multicast and unicast transports). + +The NOCP flag and BDPN flag may only be set if the BUFF flag is set. + +The DUPL flag may be set with any of the DROP, FORW, BUFF and NOCP flags. + +The DFRN flag may only be set if the FORW flag is set. + +The EDRT flag may be set if the FORW flag is set. + +The DDPN flag may be set with any of the DROP and BUFF flags. + +## 8.2.27 Downlink Data Service Information + +The Downlink Data Service Information IE is used to carry downlink data service information. It is coded as shown in Figure 8.2.27-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|--------------------------------|---|------|---|-----|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 to 2 | Type = 45 (decimal) | | | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | | | +| 5 | Spare | | | | QFII | | PPI | | | | | | +| m | Spare | | Paging Policy Indication value | | | | | | | | | | +| p | Spare | | QFI | | | | | | | | | | +| q to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +**Figure 8.2.27-1: Downlink Data Service Information** + +The PPI flag in octet 5 indicates whether the Paging Policy Indication value in octet "m" shall be present. If PPI is set to "1", then the Paging Policy Indication value shall be present. If PPI is set to "0", then octet "m" shall not be present. + +The Paging Policy Indication value, in octet "m", shall be encoded as the DSCP in TOS (IPv4) or TC (IPv6) information received in the IP payload of the GTP-U packet from the PGW (see IETF RFC 2474 [13]). + +The QFII flag in octet 5 indicates whether the QFI value in octet "p" shall be present. If QFII is set to "1", then the QFI value shall be present. If QFII is set to "0", then octet "p" shall not be present. + +The QFI value, in octet "p", shall be encoded as the octet 5 of the QFI IE in clause 8.2.89. + +## 8.2.28 Downlink Data Notification Delay + +The Downlink Data Notification Delay IE indicates the delay the UP function shall apply between receiving a downlink data packet and notifying the CP function about the arrival of the packet. It is coded as depicted in Figure 8.2.28-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 46 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Delay Value in integer multiples of 50 millisecs, or zero | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.28-1: Downlink Data Notification Delay** + +Delay Value shall be set to zero in order to clear a previously set delay condition. + +## 8.2.29 DL Buffering Duration + +The DL Buffering Duration IE indicates the duration during which the UP function is requested to buffer the downlink data packets. It is coded as shown in figure 8.2.29-1 and table 8.2.29-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 47 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Timer unit | | | | Timer value | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.29-1: DL Buffering Duration + +Table 8.2.29.1: DL Buffering Duration + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

Timer value
Bits 5 to 1 represent the binary coded timer value.

Timer unit
Bits 6 to 8 defines the timer value unit as follows:
Bits
8 7 6
0 0 0 value is incremented in multiples of 2 seconds
0 0 1 value is incremented in multiples of 1 minute
0 1 0 value is incremented in multiples of 10 minutes
0 1 1 value is incremented in multiples of 1 hour
1 0 0 value is incremented in multiples of 10 hours
1 1 1 value indicates that the timer is infinite

Other values shall be interpreted as multiples of 1 minute in this version of the protocol.

Timer unit and Timer value both set to all "zeros" shall be interpreted as an indication that the timer is stopped.

| +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 8.2.30 DL Buffering Suggested Packet Count + +The DL Buffering Suggested Packet Count IE indicates the maximum number of downlink data packets suggested to be buffered in the UP function for this PFCP session. It is coded as depicted in Figure 8.2.30-1. + +| Octets | Bits | | | | | | | | +|----------|---------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 48 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to n+4 | Packet Count Value | | | | | | | | + +Figure 8.2.30-1: DL Buffering Suggested Packet Count + +The Packet Count value is encoded with the number of octets defined in the Length field, e.g. when n=2, the range of the Packet Count value is from 0 to 65535. + +The length shall be set to "1" or "2" octets. + +## 8.2.31 PFCPSMReq-Flags + +The PFCPSMReq-Flags IE indicates flags applicable to the PFCP Session Modification Request message. It is coded as depicted in Figure 8.2.31-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|------------|-----------|-----------|-----------|-----------|-----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 49 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | DETEI
D | RUM
UC | SUMP
C | QAUR
R | SNDE
M | DROB
U | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.31-1: PFCPSMReq-Flags + +The following bits within Octet 5 shall indicate: + +- Bit 1 – DROBU (Drop Buffered Packets): if this bit is set to "1", it indicates that the UP function shall drop all the packets currently buffered for the PFCP session, if any, prior to further applying the action specified in the Apply Action value of the FARs. +- Bit 2 – SNDEM (Send End Marker Packets): if this bit is set to "1", it indicates that the UP function shall construct and send End Marker packets towards the old F-TEID of the downstream node when switching to the new F-TEID. +- Bit 3 – QAURR (Query All URRs): if this bit is set to "1", it indicates that the UP function shall return immediate usage report(s) for all the URRs previously provisioned for this PFCP session. +- Bit 4 - SUMPC (Stop of Usage Measurement to Pause Charging): if this bit is set to "1", it indicates that the UP function shall stop the usage measurement for all URRs with the "ASPOC" flag set to "1". +- Bit 5 - RUMUC (Resume of Usage Measurement to Un-pause of Charging): if this bit is set to "1", it indicates that the UP function shall resume the usage measurement for all URRs with the "ASPOC" flag set to "1". +- Bit 6 - DETEID (Delete All DL N3mb and/or N19mb F-TEIDs): if this bit is set to "1", it indicates that the MB-UPF shall delete all NG-RAN N3mb DL F-TEIDs and all UPF N19mb DL F-TEIDs which were provisioned in Add MBS Unicast Parameters IEs for the MBS session (see clause 5.34.2.4). +- Bit 7 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +Bits 4 and 5 shall not be set both to "1". + +## 8.2.32 PFCPSRRsp-Flags + +The PFCPSRRsp-Flags IE indicates flags applicable to the PFCP Session Report Response message. It is coded as depicted in Figure 8.2.32-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|-------|-------|-------|-----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 50 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | Spare | Spare | Spare | Spare | Spare | DROB
U | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.32-1: PFCPSRRsp-Flags + +The following bits within Octet 5 shall indicate: + +- Bit 1 – DROBU (Drop Buffered Packets): if this bit is set to "1", it indicates that the UP function shall drop all the packets currently buffered for the PFCP session, if any, prior to further applying the action specified in the Apply Action value of the FARs. +- Bit 2 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +## 8.2.33 Sequence Number + +The Sequence Number IE shall be encoded as shown in Figure 8.2.33-1. It contains an Unsigned32 binary integer value. + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 52 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Sequence Number | | | | | | | | + +**Figure 8.2.33-1: Sequence Number** + +## 8.2.34 Metric + +The Metric IE shall be encoded as shown in Figure 8.2.34-1. It indicates a percentage and may take binary coded integer values from and including 0 up to and including 100. Other values shall be considered as 0. + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 53 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Metric | | | | | | | | + +**Figure 8.2.34-1: Metric** + +## 8.2.35 Timer + +The purpose of the Timer IE is to specify specific timer values. The Timer IE shall be encoded as shown in Figure 8.2.35-1 and table 8.2.35.1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 55 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Timer unit | | | | Timer value | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.35-1: Timer** + +**Table 8.2.35.1: Timer information element** + +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

Timer value
Bits 5 to 1 represent the binary coded timer value.

Timer unit
Bits 6 to 8 defines the timer value unit for the timer as follows:
Bits
8 7 6
0 0 0 value is incremented in multiples of 2 seconds
0 0 1 value is incremented in multiples of 1 minute
0 1 0 value is incremented in multiples of 10 minutes
0 1 1 value is incremented in multiples of 1 hour
1 0 0 value is incremented in multiples of 10 hours
1 1 1 value indicates that the timer is infinite

Other values shall be interpreted as multiples of 1 minute in this version of the protocol.

Timer unit and Timer value both set to all "zeros" shall be interpreted as an indication that the timer is stopped.

| +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 8.2.36 Packet Detection Rule ID (PDR ID) + +The PDR ID IE is coded as depicted in Figure 8.2.36-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 56 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Rule ID | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.36-1: PDR ID + +Octets 5 to 6 contain the Rule ID and shall be encoded as an integer. + +## 8.2.37 F-SEID + +F-SEID is coded as depicted in Figure 8.2.37-1. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|-------|-------|-------|-------|-------|----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 57 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | Spare | Spare | Spare | Spare | V4 | V6 | +| 6 to 13 | SEID | | | | | | | | +| m to (m+3) | IPv4 address | | | | | | | | +| p to (p+15) | IPv6 address | | | | | | | | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.37-1: F-SEID + +The following flags are coded within Octet 5: + +- Bit 1 – V6: If this bit is set to "1", then IPv6 address field shall be present in the F-SEID, otherwise the IPv6 address field is not present at all. +- Bit 2 – V4: If this bit is set to "1", then IPv4 address field shall be present in the F-SEID, otherwise the IPv4 address field is not present at all. +- Bit 3 to 8 are spare and reserved for future use. + +At least one of V4 and V6 shall be set to "1", and both may be set to "1". + +Octets "m to (m+3)" and/or "p to (p+15)" (IPv4 address / IPv6 address fields), if present, contain respective address values. + +## 8.2.38 Node ID + +The Node ID IE shall contain an FQDN or an IPv4/IPv6 address. It shall be encoded as shown in Figure 8.2.38-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|--------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 to 2 | Type = 60 (decimal) | | | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | | | +| 5 | Spare | | | | Node ID Type | | | | | | | | +| 6 to n | Node ID value | | | | | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.2.38-1: Node ID + +Node ID Type indicates the type of the Node ID value. It shall be encoded as a 4 bits binary integer as specified in Table 8.2.38-2. + +Table 8.2.38-2: Node ID Type + +| Node ID Type Value (Decimal) | Node ID Type | +|------------------------------|------------------------| +| 0 | IPv4 address | +| 1 | IPv6 address | +| 2 | FQDN | +| 3 to 15 | Spare, for future use. | + +If the Node ID Type is set to an IPv4 address, then the Node ID value length shall be 4 Octets. + +If the Node ID Type is set to an IPv6 address, then the Node ID value length shall be 16 Octets. + +If the Node ID Type is set to an FQDN, then the Node ID value encoding shall be identical to the encoding of a FQDN within a DNS message of clause 3.1 of IETF RFC 1035 [27] but excluding the trailing zero byte. + +NOTE 1: The FQDN field in the IE is not encoded as a dotted string as commonly used in DNS master zone files. + +## 8.2.39 PFD Contents + +The PFD Contents IE type shall be encoded as shown in Figure 8.2.39-1. It contains the description of a PFD. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|------|-----|-----|----|----|-----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 61 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | ADNP | AURL | AFD | DNP | CP | DN | URL | FD | +| 6 | Spare | | | | | | | | +| m to (m+1) | Length of Flow Description | | | | | | | | +| (m+2) to p | Flow Description | | | | | | | | +| q to (q+1) | Length of URL | | | | | | | | +| (q+2) to r | URL | | | | | | | | +| s to (s+1) | Length of Domain Name | | | | | | | | +| (s+2) to t | Domain Name | | | | | | | | +| u to (u+1) | Length of Custom PFD Content | | | | | | | | +| (u+2) to v | Custom PFD Content | | | | | | | | +| w to (w+1) | Length of Domain Name Protocol | | | | | | | | +| (w+2) to x | Domain Name Protocol | | | | | | | | +| y to (y+1) | Length of Additional Flow Description | | | | | | | | +| (y+2) to z | Additional Flow Description | | | | | | | | +| a to (a+1) | Length of Additional URL | | | | | | | | +| (a+2) to b | Additional URL | | | | | | | | +| c to (c+1) | Length of Additional Domain Name and Domain Name Protocol | | | | | | | | +| (c+2) to d | Additional Domain Name and Domain Name Protocol | | | | | | | | +| e to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.39-1: PFD Contents + +The following flags are coded within Octet 5 in the Figure 8.2.39-1: + +- Bit 1 – FD (Flow Description): If this bit is set to "1", then the Length of Flow Description and the Flow Description fields shall be present, otherwise they shall not be present. +- Bit 2 – URL (URL): If this bit is set to "1", then the Length of URL and the URL fields shall be present, otherwise they shall not be present. +- Bit 3 – DN (Domain Name): If this bit is set to "1", then the Length of Domain Name and the Domain Name fields shall be present, otherwise they shall not be present. +- Bit 4 – CP (Custom PFD Content): If this bit is set to "1", then the Length of Custom PFD Content and the Custom PFD Content fields shall be present, otherwise they shall not be present. +- Bit 5 – DNP (Domain Name Protocol): If this bit is set to "1", then the Length of Domain Name Protocol and the Domain Name Protocol shall be present, otherwise they shall not be present; and if this bit is set to "1", the Length of Domain Name and the Domain Name fields shall also be present. +- Bit 6 – AFD (Additional Flow Description): If this bit is set to "1", the Length of Additional Flow Description and the Additional Flow Description field shall be present, otherwise they shall not be present. +- Bit 7 – AURL (Additional URL): If this bit is set to "1", the Length of Additional URL and the Additional URL field shall be present, otherwise they shall not be present. +- Bit 8 – ADNP (Additional Domain Name and Domain Name Protocol): If this bit is set to "1", the Length of Additional Domain Name and Domain Name Protocol, and the Additional Domain Name and Domain Name Protocol field shall be present, otherwise they shall not be present. + +The Flow Description field, when present, shall be encoded as an OctetString as specified in clause 6.4.3.7 of 3GPP TS 29.251 [21]. + +The Domain Name field, when present, shall be encoded as an OctetString as specified in clause 6.4.3.9 of 3GPP TS 29.251 [21]. + +The URL field, when present, shall be encoded as an OctetString as specified in clause 6.4.3.8 of 3GPP TS 29.251 [21]. + +The Domain Name Protocol field, when present, shall be encoded as an OctetString as specified in clause 6.4.3.9 of 3GPP TS 29.251 [21]. + +Additional instance(s) of the Flow Description shall be encoded as shown in Figure 8.2.39-2. The encoding of Flow Description 2, 3 up to m field are the same as the Flow Description field specified in clause 8.2.39. + +| Octets | Bits | | | | | | | | +|----------------|------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| (y+2) to (y+3) | Length of Flow Description 2 | | | | | | | | +| (y+4) to i | Flow Description 2 | | | | | | | | +| j to (j+1) | Length of Flow Description 3 | | | | | | | | +| (j+2) to k | Flow Description 3 | | | | | | | | +| | ... | | | | | | | | +| l to (l+1) | Length of Flow Description m | | | | | | | | +| (l+2) to z | Flow Description m | | | | | | | | + +**Figure 8.2.39-2: Additional Flow Description field** + +Additional instance(s) of the URL shall be encoded as shown in Figure 8.2.39-3. The encoding of URL 2, 3 up to m fields are the same as the URL field. + +| Octets | Bits | | | | | | | | +|----------------|-----------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| (a+2) to (a+3) | Length of URL 2 | | | | | | | | +| (a+4) to o | URL 2 | | | | | | | | +| pa to (pa+1) | Length of URL 3 | | | | | | | | +| (pa+2) to pb | URL 3 | | | | | | | | +| | ... | | | | | | | | +| pc to (pc+1) | Length of URL m | | | | | | | | +| (pc+2) to b | URL m | | | | | | | | + +Figure 8.2.39-3: Additional URL field + +Additional instance(s) of the Domain Name and Domain Name Protocol shall be encoded as shown in Figure 8.2.39-4. The encoding of Domain Name 2, 3, up to m fields and Domain Name Protocol 2, 3 up to m fields are the same as the Domain Name field and Domain Name Protocol field respectively. + +| Octets | Bits | | | | | | | | +|----------------|----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| (c+2) to (c+3) | Length of Domain Name 2 | | | | | | | | +| (c+4) to pd | Domain Name 2 | | | | | | | | +| pe to (pe+1) | Length of Domain Name Protocol 2 | | | | | | | | +| (pe+2) to pf | Domain Name Protocol 2 | | | | | | | | +| pg to (pg+1) | Length of Domain Name 3 | | | | | | | | +| (pg+2) to ph | Domain Name 3 | | | | | | | | +| pi to (pi+1) | Length of Domain Name Protocol 3 | | | | | | | | +| (pi+2) + pj | Domain Name Protocol 3 | | | | | | | | +| | ... | | | | | | | | +| pk to (pk+1) | Length of Domain Name m | | | | | | | | +| (pk+2) to pl | Domain Name m | | | | | | | | +| pm to (pm+1) | Length of Domain Name Protocol m | | | | | | | | +| (pm+2) to d | Domain Name Protocol m | | | | | | | | + +Figure 8.2.39-4: Additional Domain Name and Domain Name Protocol field + +## 8.2.40 Measurement Method + +The Measurement Method IE shall be encoded as shown in Figure 8.2.40-1. It indicates the method for measuring the usage of network resources. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|-------|-----------|-----------|-----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 62 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | Spare | Spare | Spare | EVEN
T | VOLU
M | DURA
T | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.40-1: Measurement Method + +Octet 5 shall be encoded as follows: + +- Bit 1 – DURAT (Duration): when set to "1", this indicates a request for measuring the duration of the traffic. +- Bit 2 – VOLUM (Volume): when set to "1", this indicates a request for measuring the volume of the traffic. +- Bit 3 – EVENT (Event): when set to "1", this indicates a request for measuring the events. +- Bit 4 to 8: Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +## 8.2.41 Usage Report Trigger + +The Usage Report Trigger IE shall be encoded as shown in Figure 8.2.41-1. It indicates the trigger of the usage report. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-----------|-----------|-----------|-----------|-----------|-----------|-----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 63 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | IMME
R | DROT
H | STOP
T | STAR
T | QUHT
I | TIMT
H | VOLT
H | PERI
O | +| 6 | EVET
H | MACA
R | ENVC
L | MONI
T | TERM
R | LIUSA | TIMQ
U | VOLQ
U | +| 7 | Spare | Spare | UPIN
T | EMRR
E | QUVT
I | IPMJL | TEBU
R | EVEQ
U | +| 8 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.41-1: Usage Report Trigger** + +Octet 5 shall be encoded as follows: + +- Bit 1 – PERIO (Periodic Reporting): when set to "1", this indicates a periodic report. +- Bit 2 – VOLTH (Volume Threshold): when set to "1", this indicates that the data volume usage reaches a volume threshold. +- Bit 3 – TIMTH (Time Threshold): when set to "1", this indicates that the time usage reaches a time threshold. +- Bit 4 – QUHTI (Quota Holding Time): when set to "1", this indicates that no packets have been received for a period exceeding the Quota Holding Time. +- Bit 5 – START (Start of Traffic): when set to "1", this indicates that the start of traffic is detected. +- Bit 6 – STOPT (Stop of Traffic): when set to "1", this indicates that the stop of traffic is detected. +- Bit 7 - DROTH (Dropped DL Traffic Threshold): when set to "1", this indicates that the DL traffic being dropped reaches a threshold. +- Bit 8 – IMMER (Immediate Report): when set to "1", this indicates an immediate report reported on CP function demand. + +Octet 6 shall be encoded as follows: + +- Bit 1 – VOLQU (Volume Quota): when set to "1", this indicates that the Volume Quota has been exhausted. +- Bit 2 – TIMQU (Time Quota): when set to "1", this indicates that the Time Quota has been exhausted. +- Bit 3 - LIUSA (Linked Usage Reporting): when set to "1", this indicates a linked usage report, i.e. a usage report being reported for a URR due to a usage report being also reported for a linked URR (see clause 5.2.2.4). +- Bit 4 – TERMR (Termination Report): when set to "1", this indicates a usage report being reported (in a PFCP Session Deletion Response) for a URR due to the termination of the PFCP session, or a usage report being reported (in a PFCP Session Modification Response) for a URR due to the removal of the URR or dissociated from the last PDR. +- Bit 5 – MONIT (Monitoring Time): when set to "1", this indicates a usage report being reported for a URR due to the Monitoring Time being reached. +- Bit 6 – ENVCL (Envelope Closure): when set to "1", this indicates the usage report is generated for closure of an envelope (see clause 5.2.2.3). +- Bit 7 – MACAR (MAC Addresses Reporting): when set to "1", this indicates a usage report to report MAC (Ethernet) addresses used as source address of frames sent UL by the UE. + +- Bits 8: EVETH (Event Threshold): when set to "1", this indicates a usage report is generated when an event threshold is reached. + +Octet 7 shall be encoded as follows: + +- Bit 1 – EVEQU (Event Quota): when set to "1", this indicates that the Event Quota has been exhausted. +- Bit 2 – TEBUR (Termination By UP function Report): when set to "1", this indicates a usage report being reported for a URR due to the termination of the PFCP session which is initiated by the UP function. +- Bit 3 – IPMJL (IP Multicast Join/Leave): when set to "1", this indicates a usage report being reported for a URR due to the UPF adding or removing the PDU session to/from the DL replication tree associated with an IP multicast flow. +- Bit 4 – QUVTI (Quota Validity Time): when set to "1", this indicates a usage report being reported for a URR due to the quota validity timer expiry. +- Bit 5 – EMRRE (End Marker Reception REport): this indicates that the UP function has received End Marker from the old I-UPF. See clauses 4.2.3.2 and 4.23.4.3 in 3GPP TS 23.502 [29]. +- Bit 6 – UPINT (User Plane Inactivity Timer): when set to "1", this indicates that no packets have been received for a period exceeding the User Plane Inactivity Timer. +- Bit 7 to 8: Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +## 8.2.42 Measurement Period + +The Measurement Period IE contains the period, in seconds, for generating periodic usage reports or the periodic QoS monitoring reports, or the period used for detecting and reporting a QoS monitoring measurement failure. It shall be encoded as shown in Figure 8.2.42-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 64 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Measurement Period | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.42-1: Measurement Period** + +The Measurement Period field shall be encoded as an Unsigned32 binary integer value. + +## 8.2.43 Fully qualified PDN Connection Set Identifier (FQ-CSID) + +A fully qualified PDN Connection Set Identifier (FQ-CSID) identifies a set of PDN connections belonging to an arbitrary number of UEs on a SGW-C, PGW-C, SGW-U and PGW-U, or a set of PDU sessions belonging to an arbitrary number of UEs on a SMF or UPF. The FQ-CSID is supported on the Sxa, Sxb and N4 interfaces. + +The size of CSID is two octets. The FQ-CSID is coded as follows: + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|--------------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 to 2 | Type = 65 (decimal) | | | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | | | +| 5 | FQ-CSID Node-ID Type | | | | Number of CSIDs= m | | | | | | | | +| 6 to p | Node-Address | | | | | | | | | | | | +| (p+1) to (p+2) | First PDN Connection Set Identifier (CSID) | | | | | | | | | | | | +| (p+3) to (p+4) | Second PDN Connection Set Identifier (CSID) | | | | | | | | | | | | +| ... | ... | | | | | | | | | | | | +| q to q+1 | m-th PDN Connection Set Identifier (CSID) | | | | | | | | | | | | +| q+2 | Spare | | | | Node Type | | | | | | | | +| (q+3) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.2.43-1: FQ-CSID + +Where FQ-CSID Node-ID Type values are: + +- 0 indicates that Node-Address is a global unicast IPv4 address and p = 9. + - 1 indicates that Node-Address is a global unicast IPv6 address and p = 21. + - 2 indicates that Node-Address is a 4 octets long field with a 32 bit value stored in network order, and p= 9. The coding of the field is specified below: + - Most significant 20 bits are the binary encoded value of (MCC \* 1000 + MNC). + - Least significant 12 bits is a 12 bit integer assigned by an operator to an MME, SGW-C, SGW-U, PGW-C, PGW-U, ePDG, TWAN , SMF or UPF. +- Other values of Node-Address Type are reserved. + +Values of Number of CSID greater than 1 shall only be employed in the PFCP Session Deletion Request. The value 0 shall be used in a PFCP Session Modification Request, with the FQ-CSID Node-ID Type and Node-Address fields set to all zeros, and with the Node Type indicating one node type, to remove an FQ-CSID previously provisioned for the PFCP session for the related node type. + +NOTE: The CP function can remove all the FQ-CSIDs for all node types provisioned in the UP function for a given PFCP session by sending a PFCP Session Modification Request with one FQ-CSID IE with a null length. + +The node that creates the FQ-CSID (i.e. SGW-C for SGW-C FQ-CSID, PGW-C or SMF for PGW-C/SMF FQ-CSID and PGW-U or SGW-U or UPF for PGW-U/SGW-U/UPF FQ-CSID) needs to ensure that the Node-ID is globally unique and the CSID value is unique within that node. + +The Node Type field in bits 1 to 4 of octet (q+2) shall be encoded as defined in Table 8.2.43-2. Bits 5 to 8 of octet (q+2) shall be set to zero by the sender and ignored by the receiver. + +Table 8.2.43-2: Node Type + +| Node Type | Value (Decimal) | +|------------------------|-----------------| +| MME | 0 | +| SGW-C | 1 | +| PGW-C/SMF | 2 | +| ePDG | 3 | +| TWAN | 4 | +| PGW-U/SGW-U/UPF | 5 | +| Spare, for future use. | 6-15 | + +## 8.2.44 Volume Measurement + +The Volume Measurement IE contains the measured traffic volumes. It shall be encoded as shown in Figure 8.2.44-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-----------|-----------|-----------|-----------|-----------|-----------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 66 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | DLNO
P | ULNO
P | TONO
P | DLVO
L | ULVO
L | TOVO
L | | +| m to (m+7) | Total Volume | | | | | | | | +| p to (p+7) | Uplink Volume | | | | | | | | +| q to (q+7) | Downlink Volume | | | | | | | | +| r to (r+7) | Total Number of Packets | | | | | | | | +| s to (s+7) | Uplink Number of Packets | | | | | | | | +| t to (t+7) | Downlink Number of Packets | | | | | | | | +| z to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.44-1: Volume Measurement** + +The following flags are coded within Octet 5: + +- Bit 1 – TOVOL: If this bit is set to "1", then the Total Volume field shall be present, otherwise the Total Volume field shall not be present. +- Bit 2 – ULVOL: If this bit is set to "1", then the Uplink Volume field shall be present, otherwise the Uplink Volume field shall not be present. +- Bit 3 – DLVOL: If this bit is set to "1", then the Downlink Volume field shall be present, otherwise the Downlink Volume field shall not be present. +- Bit 4 – TONOP: If this bit is set to "1", then the Total Number of Packets field shall be present, otherwise the Total Number of Packets field shall not be present. +- Bit 5 – ULNOP: If this bit is set to "1", then the Uplink Number of Packets field shall be present, otherwise the Uplink Number of Packets field shall not be present. +- Bit 6 – DLNOP: If this bit is set to "1", then the Downlink Number of Packets field shall be present, otherwise the Downlink Number of Packets field shall not be present. +- Bit 7 to bit 8: Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +The Total Volume, Uplink Volume and Downlink Volume fields shall be encoded as an Unsigned64 binary integer value. They shall contain the total, uplink or downlink number of octets respectively. + +## 8.2.45 Duration Measurement + +The Duration Measurement IE type shall be encoded as shown in Figure 8.2.45-1. It contains the used time in seconds. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 67 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Duration value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.45-1: Duration Measurement** + +The Duration value shall be encoded as an Unsigned32 binary integer value. + +## 8.2.46 Time of First Packet + +The Time of First Packet IE indicates the time stamp for the first IP packet transmitted for a given usage report. It shall be encoded as shown in Figure 8.2.46-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 69 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Time of First Packet | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.46-1: Time of First Packet** + +The Time of First Packet field shall contain a UTC time. Octets 5 to 8 shall be encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [12]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +## 8.2.47 Time of Last Packet + +The Time of Last Packet IE indicates the time stamp for the last IP packet transmitted for a given usage report. It shall be encoded as shown in Figure 8.2.47-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 70 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Time of Last Packet | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.47-1: Time of Last Packet** + +The Time of Last Packet field shall contain a UTC time. Octets 5 to 8 shall be encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [12]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +## 8.2.48 Quota Holding Time + +The Quota Holding Time IE type shall be encoded as shown in Figure 8.2.48-1. It contains the quota holding time in seconds. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 71 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Quota Holding Time value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.48-1: Quota Holding Time** + +The Quota Holding Time value shall be encoded as an Unsigned32 binary integer value. + +## 8.2.49 Dropped DL Traffic Threshold + +The Dropped DL Traffic Threshold IE type shall be encoded as shown in Figure 8.2.49-1. It contains the dropped DL traffic volume thresholds to be monitored by the UP function. + +| Octets | Bits | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|------|------|---|---|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | +| 1 to 2 | Type = 72 (decimal) | | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | | +| 5 | Spare | | | | DLBY | DLPA | | | | | | +| m to (m+7) | Downlink Packets | | | | | | | | | | | +| o to (o+7) | Number of Bytes of Downlink Data | | | | | | | | | | | +| s to (s+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | + +Figure 8.2.49-1: Dropped DL Traffic Threshold + +The following flags are coded within Octet 5: + +- Bit 1 – DLPA: If this bit is set to "1", then the Downlink Packets field shall be present, otherwise the Downlink Packets field shall not be present. +- Bit 2 – DLBY: If this bit is set to "1", then the Number of Bytes of Downlink Data field shall be present, otherwise the Number of Bytes of Downlink Data field shall not be present. +- Bit 3 to 8: Spare, for future use and set to "0". + +The Downlink Packets fields shall be encoded as an Unsigned64 binary integer value. It shall contain a number of downlink packets. + +The Number of Bytes of Downlink Data fields shall be encoded as an Unsigned64 binary integer value. It shall contain the number of bytes of the downlink data. + +## 8.2.50 Volume Quota + +The Volume Quota IE type shall be encoded as shown in Figure 8.2.50-1. It contains the volume quota to be monitored by the UP function. + +| Octets | Bits | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----------|-----------|-----------|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 to 2 | Type = 73 (decimal) | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | +| 5 | Spare | | | | DLVO
L | ULVO
L | TOVO
L | | | | +| m to (m+7) | Total Volume | | | | | | | | | | +| p to (p+7) | Uplink Volume | | | | | | | | | | +| q to (q+7) | Downlink Volume | | | | | | | | | | +| S to (S+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | + +Figure 8.2.50-1: Volume Quota + +The following flags are coded within Octet 5: + +- Bit 1 – TOVOL: If this bit is set to "1", then the Total Volume field shall be present, otherwise the Total Volume field shall not be present. +- Bit 2 – ULVOL: If this bit is set to "1", then the Uplink Volume field shall be present, otherwise the Uplink Volume field shall not be present. +- Bit 3 – DLVOL: If this bit is set to "1", then the Downlink Volume field shall be present, otherwise the Downlink Volume field shall not be present. +- Bit 4 to bit 8: Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +The Total Volume, Uplink Volume and Downlink Volume fields shall be encoded as an Unsigned64 binary integer value. They shall contain the total, uplink or downlink number of octets respectively. + +## 8.2.51 Time Quota + +The Time Quota IE type shall be encoded as shown in Figure 8.2.51-1. It contains the time quota to be monitored by the UP function. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 74 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Time Quota value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.51-1: Time Quota** + +The Time Quota value shall be encoded as an Unsigned32 binary integer value. It contains a duration in seconds. + +## 8.2.52 Start Time + +The Start Time IE indicates the time at which the UP function started to collect the charging information. It shall be encoded as shown in Figure 8.2.52-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 75 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Start Time | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.52-1: Start Time** + +The Start Time field shall contain a UTC time. Octets 5 to 8 shall be encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [12]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +## 8.2.53 End Time + +The End Time IE indicates the time at which the UP function ended to collect the charging information. It shall be encoded as shown in Figure 8.2.53-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 76 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | End Time | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.53-1: End Time** + +The End Time field shall contain a UTC time. Octets 5 to 8 shall be encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [12]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +## 8.2.54 URR ID + +The URR ID IE type shall be encoded as shown in Figure 8.2.54-1. It contains a Usage Reporting Rule ID. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 81 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | URR ID value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.54-1: URR ID + +The URR ID value shall be encoded as an Unsigned32 binary integer value. + +The bit 8 of octet 5 is used to indicate if the Rule ID is dynamically allocated by the CP function or predefined in the UP function. If set to "0", it indicates that the Rule is dynamically provisioned by the CP Function. If set to "1", it indicates that the Rule is predefined in the UP Function. + +## 8.2.55 Linked URR ID IE + +The Linked URR ID IE type shall be encoded as shown in Figure 8.2.55-1. It contains the URR ID of a linked URR. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 82 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Linked URR ID value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.55-1: Linked URR ID + +The Linked URR ID value shall be encoded as an Unsigned32 binary integer value. + +## 8.2.56 Outer Header Creation + +The Outer Header Creation IE type shall be encoded as shown in Figure 8.2.56-1. It contains the instructions to create an Outer Header. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 84 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Outer Header Creation Description | | | | | | | | +| m to (m+3) | TEID | | | | | | | | +| p to (p+3) | IPv4 Address | | | | | | | | +| q to (q+15) | IPv6 Address | | | | | | | | +| r to (r+1) | Port Number | | | | | | | | +| t to (t+2) | C-TAG | | | | | | | | +| u to (u+2) | S-TAG | | | | | | | | +| s to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.56-1: Outer Header Creation + +The Outer Header Creation Description field, when present, shall be encoded as specified in Table 8.2.56-1. It takes the form of a bitmask where each bit indicates the outer header to be created in the outgoing packet. Spare bits shall be ignored by the receiver. + +**Table 8.2.56-1: Outer Header Creation Description** + +| Octet / Bit | Outer Header to be created in the outgoing packet | +|-------------|---------------------------------------------------| +| 5/1 | GTP-U/UDP/IPv4 (NOTE 1), (NOTE 3) | +| 5/2 | GTP-U/UDP/IPv6 (NOTE 1), (NOTE 3) | +| 5/3 | UDP/IPv4 (NOTE 2, NOTE 5) | +| 5/4 | UDP/IPv6 (NOTE 2, NOTE 5) | +| 5/5 | IPv4 (NOTE 5) | +| 5/6 | IPv6 (NOTE 5) | +| 5/7 | C-TAG (see NOTE 4) | +| 5/8 | S-TAG (see NOTE 4) | +| 6/1 | N19 Indication (NOTE 6) | +| 6/2 | N6 Indication (NOTE 6) | +| 6/3 | Low Layer SSM and C-TEID (NOTE 7) | + +NOTE 1: The SGW-U/I-UPF shall also create GTP-U extension header(s) if any has been stored for this packet, during a previous outer header removal (see clause 8.2.64). + +NOTE 2: This value may apply to UL packets sent by a PGW-U for non-IP PDN connections with SGi tunnelling based on UDP/IP encapsulation (see clause 4.3.17.8.3.3.2 of 3GPP TS 23.401 [14]). + +NOTE 3: The SGW-U/I-UPF shall set the GTP-U message type to the value stored during the previous outer header removal. + +NOTE 4: These values may apply to UL packets sent by a UPF for Ethernet PDU sessions over N6 (see clause 5.8.2.11.6 of 3GPP TS 23.501 [28]). Either C-TAG bit or S-TAG bit may be set to "1", or both C-TAG and S-TAG bits may be set to "1" to request the UPF to insert the C-TAG or S-TAG, or both C-TAG and S-TAG respectively for UL packets over N6. + +NOTE 5: This value may apply e.g. to UL packets sent by a UPF (PDU Session Anchor) over N6, when explicit N6 traffic routing information is provided to the SMF (see clause 5.6.7 of 3GPP TS 23.501 [28]). The IPv4 or IPv6 address shall correspond to the IP address of the tunnel endpoint in the data network. + +NOTE 6: When the "N19 Indication" or "N6 Indication" bit in the Outer Header Creation Description field is set to "1", the UPF shall associate an "N19 Indication" or "N6 Indication" internal flag with the packet to indicate that the packet has been received from a N19 or N6 interface respectively. This indication is further used to prevent the packet from being forwarded back over N19 or N6 respectively (see clause 8.2.130). + +NOTE 7: When the "Low Layer SSM and C-TEID" bit in the Outer Header Creation Description field is set to "1", the MB-UPF shall create a GTP-U header with the C-TEID and set the destination IP address and the source IP address as the IP Multicast Distribution Address and the IP Source Address in the Multicast Transport Information IE, which is the Low Layer SSM allocated to the MBS session. In this case, the TEID, IPv4/IPv6 address and Port Number fields shall not be present. + +At least one bit of the Outer Header Creation Description field shall be set to "1". Bits 5/1 and 5/2 may both be set to "1" if an F-TEID with both an IPv4 and IPv6 addresses has been assigned by the GTP-U peer. In this case, the UP function shall send the outgoing packet towards the IPv4 or IPv6 address. + +The TEID field shall be present if the Outer Header Creation Description requests the creation of a GTP-U header, i.e. if in Octet 5 any of the bits 5/1 and 5/2 are set. Otherwise it shall not be present. When present, it shall contain the destination GTP-U TEID to set in the GTP-U header of the outgoing packet. + +The IPv4 Address field shall be present if the Outer Header Creation Description requests the creation of an IPv4 header, i.e. if in Octet 5 any of the bits 5/1, 5/3 and 5/5 are set. Otherwise it shall not be present. When present, it shall contain the destination IPv4 address to set in the IPv4 header of the outgoing packet. + +The IPv6 Address field shall be present if the Outer Header Creation Description requests the creation of an IPv6 header, i.e. if in Octet 5 any of the bits 5/2, 5/4 and 5/6 are set. Otherwise it shall not be present. When present, it shall contain the destination IPv6 address to set in the IPv6 header of the outgoing packet. + +The Port Number field shall be present if the Outer Header Creation Description requests the creation of a UDP/IP header, i.e. if in Octet 5 any of the bits 5/3 and 5/4 are set. Otherwise it shall not be present. When present, it shall contain the destination Port Number to set in the UDP header of the outgoing packet. + +The C-TAG field shall be present if the Outer Header Creation Description requests the setting of the C-Tag in Ethernet packet. Otherwise it shall not be present. When present, it shall contain the destination Customer-VLAN tag to set in the Customer-VLAN tag header of the outgoing packet. + +The S-TAG field shall be present if the Outer Header Creation Description requests the setting of the S-Tag in Ethernet packet. Otherwise it shall not be present. When present, it shall contain the destination Service-VLAN tag to set in the Service-VLAN tag header of the outgoing packet. + +## 8.2.57 BAR ID + +The BAR ID IE type shall be encoded as shown in Figure 8.2.57-1. It contains a Buffering Action Rule ID. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 88 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | BAR ID value | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.57-1: BAR ID** + +The BAR ID value shall be encoded as a binary integer value. + +## 8.2.58 CP Function Features + +The CP Function Features IE indicates the features supported by the CP function. Only features having an impact on the (system-wide) UP function behaviour are signalled in this IE. It is coded as depicted in Figure 8.2.58-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 89 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Supported-Features | | | | | | | | +| 6 to 7 | Additional Supported-Features 1 | | | | | | | | +| 8 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.58-1: CP Function Features** + +The CP Function Features IE takes the form of a bitmask where each bit set indicates that the corresponding feature is supported. Spare bits shall be ignored by the receiver. The same bitmask is defined for all PFCP interfaces. + +The following table specifies the features defined on PFCP interfaces and the interfaces on which they apply. + +**Table 8.2.58-1: CP Function Features** + +| Feature Octet / Bit | Feature | Interface | M/O | Description | +|---------------------|---------|-------------------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5/1 | LOAD | Sxa, Sxb, Sxc, N4, N4mb | O | Load Control is supported by the CP function. | +| 5/2 | OVRL | Sxa, Sxb, Sxc, N4, N4mb | O | Overload Control is supported by the CP function. | +| 5/3 | EPFAR | Sxa, Sxb, Sxc, N4 | O | The CP function supports the Enhanced PFCP Association Release feature (see clause 5.18). | +| 5/4 | SSET | N4, N4mb | O | (MB-)SMF support of PFCP sessions successively controlled by different (MB-)SMFs of a same (MB-)SMF Set (see clause 5.22). | +| 5/5 | BUNDL | Sxa, Sxb, Sxc, N4, N4mb | O | PFCP messages bundling (see clause 6.5) is supported by the CP function. | +| 5/6 | MPAS | N4, N4mb | O | (MB-)SMF support for multiple PFCP associations from an (MB-)SMF set to a single (MB-)UPF (see clause 5.22.3). | +| 5/7 | ARDR | Sxb, N4 | O | CP function supports Additional Usage Reports in the PFCP Session Deletion Response (see clause 5.2.2.3.1). | +| 5/8 | UIAUR | Sxb, N4 | O | CP function supports the UE IP Address Usage Reporting feature, i.e. receiving and handling of UE IP Address Usage Information IE (see clause 5.21.3.2). | +| 6/1 | PSUCC | Sxb, Sxc, N4, N4mb | O | CP function supports PFCP session establishment or modification with Partial Success, i.e. with UP function reporting rules that cannot be activated. See clause 5.2.9. | +| 6/2 | RPGUR | Sxa, Sxb, N4, N4mb | O | CP function supports the Peer GTP-U Entity Restart Reporting as specified in clause 20.3.4a of 3GPP TS 23.007 [24] and in clause 5.5 of 3GPP TS 23.527 [40]. | + +NOTE: Features are defined as follows: + +- Feature Octet / Bit: The octet and bit number within the Supported-Features IE, e.g. "5 / 1". +- Feature: A short name that can be used to refer to the octet / bit and to the feature. +- Interface: A list of applicable interfaces to the feature. +- M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") for a CP function complying with this release of the specification. + +A feature defined as mandatory in this release of the specification may not necessarily be defined or mandatory to support in earlier releases (see the respective specifications), therefore a UP function complying with this release of the specification shall be prepared to receive a CP Function Features IE with a mandatory feature bit set to "0". + +- Description: A clear textual description of the feature. + +## 8.2.59 Usage Information + +The Usage Information IE shall be encoded as shown in Figure 8.2.59-1. It provides additional information on the Usage Report. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----|-----|-----|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 90 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | UBE | UAE | AFT | BEF | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.59-1: Usage Information** + +Octet 5 shall be encoded as follows: + +- Bit 1 – BEF (Before): when set to "1", this indicates usage before a monitoring time. + +- Bit 2 – AFT (After): when set to "1", this indicates a usage after a monitoring time. +- Bit 3 – UAE (Usage After Enforcement): when set to "1", this indicates a usage after QoS enforcement. +- Bit 4 – UBE (Usage Before Enforcement): when set to "1", this indicates a usage before QoS enforcement. +- Bits 5 to 8: Spare, for future use and set to "0". + +## 8.2.60 Application Instance ID + +The Application Instance ID IE type shall be encoded as shown in Figure 8.2.60-1. It contains an Application Instance Identifier referencing an application instance for which the start or stop of traffic is reported to the CP function. + +![](6d1910bc8db5fd0b035d17f7d15eed1a_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|---------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 91 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Application Instance Identifier | | | | | | | | + +**Figure 8.2.60-1: Application Instance ID** + +The Application Instance Identifier shall be encoded as an OctetString (see 3GPP TS 29.212 [8]). + +## 8.2.61 Flow Information + +The Flow Information IE type shall be encoded as shown in Figure 8.2.61-1. It contains the description of a flow information. + +![](d0c2ae6a2b305d2b68d836fac2cb5726_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 92 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Flow Direction | | | | +| 6 to 7 | Length of Flow Description | | | | | | | | +| 8 to m | Flow Description | | | | | | | | +| p to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.61-1: Flow Information** + +The Flow Direction field, when present, shall be encoded as defined in Table 8.2.61-1. + +**Table 8.2.61-1: Flow Direction** + +| Flow Direction | Value (Decimal) | +|----------------------------------------------------------------------------------------|-----------------| +| Unspecified | 0 | +| Downlink (traffic to the UE) | 1 | +| Uplink (traffic from the UE) | 2 | +| Bidirectional | 3 | +| For future use. Shall not be sent. If received, shall be interpreted as the value "0". | 4 to 7 | + +The Flow Description field, when present, shall be encoded as an OctetString as specified in clause 5.4.2 of 3GPP TS 29.212 [8]. + +## 8.2.62 UE IP Address + +The UE IP Address IE type shall be encoded as shown in Figure 8.2.62-1. It contains a source or destination IP address. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|-------|------|------|-------|-----|----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 93 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | IP6PL | CHV6 | CHV4 | IPv6D | S/D | V4 | V6 | +| m to (m+3) | IPv4 address | | | | | | | | +| p to (p+15) | IPv6 address | | | | | | | | +| r | IPv6 Prefix Delegation Bits | | | | | | | | +| s | IPv6 Prefix Length | | | | | | | | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.62-1: UE IP Address + +The following flags are coded within Octet 5: + +- Bit 1 – V6: If this bit is set to "1", then the CHV6 bit shall not be set and the IPv6 address field shall be present in the UE IP Address, otherwise the IPv6 address field shall not be present. +- Bit 2 – V4: If this bit is set to "1", then the CHV4 bit shall not be set and the IPv4 address field shall be present in the UE IP Address, otherwise the IPv4 address field shall not be present. +- Bit 3 – S/D: This bit is only applicable to the UE IP Address IE in the PDI IE, Create Traffic Endpoint IE and Update Traffic Endpoint IE. It shall be set to "0" and ignored by the receiver in IEs other than PDI IE. In the PDI IE, if this bit is set to "0", this indicates a Source IP address; if this bit is set to "1", this indicates a Destination IP address. +- Bit 4 – IPv6D: This bit is only applicable to the UE IP address IE in the PDI IE, Create Traffic Endpoint IE and Update Traffic Endpoint IE, when the V6 bit or CHV6 bit is set to "1". If this bit is set to "1", then the IPv6 Prefix Delegation Bits field shall be present, otherwise the UP function shall consider IPv6 prefix is default /64. +- Bit 5 – CHV4 (CHOOSE IPV4): If this bit is set to "1", then the V4 bit shall not be set, the IPv4 address shall not be present and the UP function shall assign an IPv4 address. This bit shall only be set by the CP function. +- Bit 6 – CHV6 (CHOOSE IPV6): If this bit is set to "1", then the V6 bit shall not be set, the IPv6 address shall not be present and the UP function shall assign an IPv6 address. This bit shall only be set by the CP function. +- Bit 7 – IP6PL (IPv6 Prefix Length): this bit is only applicable when the V6 bit or CHV6 bit is set to "1" and the "IPv6D" bit is set to "0", for an IPv6 prefix other than default /64, when the UP function supports the IP6PL feature as specified in clause 8.2.25. If this bit is set to "1", then the IPv6 Prefix Length field shall be present. +- Bit 8 Spare, for future use and set to "0". + +Octets "m to (m+3)" or "p to (p+15)" (IPv4 address / IPv6 address fields), if present, shall contain the address value. + +Octet r, if present, shall contain the number of bits allocated for IPv6 prefix delegation (relative to the default /64 IPv6 prefix), e.g. if /60 IPv6 prefix is used, the value shall be set to "4". When using UE IP address IE in a PDI to match packets, the UP function shall only use the IPv6 prefix part and ignore the interface identifier part. When the field is set to "0", the UP function shall determine a value based on the local configuration. + +The IPv6 Prefix Length in octet s, when present, shall be encoded as an 8 bits binary integer, e.g. if /72 prefix is used, the value shall be set to (decimal) 72, or if /56 prefix is used, the value shall be set to (decimal) 56. The prefix length value "128" indicates an individual /128 IPv6 address. When the field is set to "0", the UP function shall determine a value based on the local configuration. + +## 8.2.63 Packet Rate + +The Packet Rate IE contains the packet rate thresholds to be enforced by the UP function. It shall be encoded as shown in Figure 8.2.63-1. + +| Octets | Bits | | | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|-------------------------------|------|------|---|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | +| 1 to 2 | Type = 94 (decimal) | | | | | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | | | | | +| 5 | Spare | | | | APRC | DLPR | ULPR | | | | | | | | +| m | Spare | | | | Uplink Time Unit | | | | | | | | | | +| (m+1) to (m+2) | Maximum Uplink Packet Rate | | | | | | | | | | | | | | +| p | Spare | | | | Downlink Time Unit | | | | | | | | | | +| (p+1) to (p+2) | Maximum Downlink Packet Rate | | | | | | | | | | | | | | +| q | Spare | | | | Additional Uplink Time Unit | | | | | | | | | | +| (q+1) to (q+2) | Additional Maximum Uplink Packet Rate | | | | | | | | | | | | | | +| r | Spare | | | | Additional Downlink Time Unit | | | | | | | | | | +| (r+1) to (r+2) | Additional Maximum Downlink Packet Rate | | | | | | | | | | | | | | +| s to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | | | + +**Figure 8.2.63-1: Packet Rate** + +The following flags are coded within Octet 5: + +- Bit 1 – ULPR (Uplink Packet Rate): If this bit is set to "1", then octets m to (m+2) shall be present, otherwise these octets shall not be present. +- Bit 2 – DLPR (Downlink Packet Rate): If this bit is set to "1", then octets p to (p+2) shall be present, otherwise these octets shall not be present. +- Bit 3 – APRC (Additional Packet Rate Control): If this bit is set to "1", then the presence of octets q to (r+2) is determined as follows: + - If bit 1 (ULPR) is set to "1", then octets q to (q+2), the Additional Maximum Uplink Packet Rate shall be present. Otherwise, octets q to (q+2) shall not be present; + - If bit 2 (DLPR) is set to "1", then octets r to (r+2), the Additional Maximum Downlink Packet Rate shall be present. Otherwise, octets r to (r+2) shall not be present. +- Bits 4 to 8: Spare, for future use and set to "0". + +At least one bit in Octet 5 shall be set to "1". Several bits may be set to "1". + +When present, octets m to (m+2) indicate the maximum number of uplink packets allowed to be sent within the uplink time unit. + +When present, octets p to (p+2) indicate the maximum number of downlink packets allowed to be sent within the downlink time unit. + +When present, octets q to (q+2) indicate the additional maximum number of uplink packets allowed to be sent within the additional uplink time unit. + +When present, octets r to (r+2) indicate the additional maximum number of downlink packets allowed to be sent within the additional downlink time unit. + +The Additional Uplink/Downlink Time Unit shall be encoded as the Uplink/Downlink Time Unit, see Table 8.2.63.1. + +**Table 8.2.63.1: Uplink/Downlink Time Unit** + +| | +|---------------------------------------------------------------------------| +| Uplink/Downlink Time unit | +| Bits 1 to 3 define the time unit as follows: | +| Bits | +| 3 2 1 | +| 0 0 0 minute | +| 0 0 1 6 minutes | +| 0 1 0 hour | +| 0 1 1 day | +| 1 0 0 week | +| Other values shall be interpreted as 000 in this version of the protocol. | + +The Maximum Uplink/Downlink Packet Rate shall be encoded as an Unsigned16 binary integer value. They shall indicate the maximum number of uplink/downlink packets allowed to be sent in the indicated uplink/downlink time unit respectively. + +The Additional Maximum Uplink/Downlink Packet Rate shall be encoded as an Unsigned16 binary integer value. They shall indicate the additional maximum number of uplink/downlink packets allowed to be sent in the indicated Additional uplink/downlink time unit respectively. + +NOTE: The Serving PLMN rate control is only applicable to downlink packets with the value of Maximum Downlink Packet Rate set to equal to or higher than 10 and with the Downlink Time Unit set to 6 minutes. The Small Data Rate Control/APN rate control is applicable to both uplink/downlink packets with the Time Unit set to minute/hour/day/week. + +## 8.2.64 Outer Header Removal + +The Outer Header Removal IE type shall be encoded as shown in Figure 8.2.64-1. It contains the instructions to remove an Outer Header. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 95 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Outer Header Removal Description | | | | | | | | +| 6 | GTP-U Extension Header Deletion | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.64-1: Outer Header Removal** + +The Outer Header Removal Description field, when present, shall be encoded as specified in Table 8.2.64-1. + +**Table 8.2.64-1: Outer Header Removal Description** + +| Outer Header to be removed from the incoming packet | Value (Decimal) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| GTP-U/UDP/IPv4 (NOTE 1), (NOTE 2), (NOTE 8) | 0 | +| GTP-U/UDP/IPv6 (NOTE 1), (NOTE 2) | 1 | +| UDP/IPv4 (NOTE 3, NOTE 6) | 2 | +| UDP/IPv6 (NOTE 3, NOTE 6) | 3 | +| IPv4 (NOTE 6) | 4 | +| IPv6 (NOTE 6) | 5 | +| GTP-U/UDP/IP (NOTE 4) | 6 | +| VLAN TAG POP (i.e. removal of one VLAN tag, S-TAG or C-TAG) (See NOTE 5) | 7 | +| VLAN TAGs POP-POP (i.e. removal of 2 VLAN tags, S-TAG and C-TAG) (See NOTE 5) | 8 | +| Spare, for future use. (See NOTE 7) | 9 to 255 | +| NOTE 1: The SGW-U/I-UPF shall store GTP-U extension header(s) required to be forwarded for this packet (as required by the comprehension rules of Figure 5.2.1-2 of 3GPP TS 29.281 [3]) that are not requested to be deleted by the GTP-U Extension Header Deletion field. | | +| NOTE 2: The SGW-U/I-UPF shall store the GTP-U message type for a GTP-U signalling message which is required to be forwarded, e.g. for an End Marker message. | | +| NOTE 3: This value may apply to DL packets received by a PGW-U for non-IP PDN connections with SGi tunnelling based on UDP/IP encapsulation (see clause 4.3.17.8.3.3.2 of 3GPP TS 23.401 [14]). | | +| NOTE 4: The CP function shall use this value to instruct UP function to remove the GTP-U/UDP/IP header regardless it is IPv4 or IPv6. | | +| NOTE 5: These values may apply to DL packets received by a UPF over N6 for Ethernet PDU sessions (see clause 5.8.2.11.3 of 3GPP TS 23.501 [28]). When the Outer Header Removal Description is set to "VLAN TAG POP", it requires the UPF to remove the VLAN tag from the top of the VLAN stack (outer VLAN tag), i.e. it removes the S-TAG or C-TAG if the user plane packet contains only one VLAN tag, or it removes the S-TAG if the user plane packet contains both a C-TAG and an S-TAG. When the Outer Header Removal Description is set to "VLAN TAGs POP-POP", it requires the UPF to remove 2 VLAN tags, S-TAG and C-TAG. | | +| NOTE 6: This value may apply e.g. to DL packets received by a UPF (PDU Session Anchor) over N6, when explicit N6 traffic routing information is provided to the SMF (see clause 5.6.7 of 3GPP TS 23.501 [28]). | | +| NOTE 7: If the UP function receives an unknown value, it shall reject the request message with the cause set to "Mandatory IE incorrect" together with the Offending IE set to the IE type of Outer Header Removal IE. | | +| NOTE 8: The PSA UPF shall store GTP-U extension header(s) required to be forwarded and that are not requested to be deleted by the GTP-U Extension Header Deletion field, e.g. the PDU Session Container received from the MB-UPF (for MBS session data) over N19mb interface, and modify it as instructed by the SMF, e.g. the PSA UPF may be instructed to modify the QFI field in the PDU Session Container extension header for the packets received from the MB-UPF. | | + +The GTP-U Extension Header Deletion field (octet 6) shall be present if it is required to delete GTP-U extension header(s) from incoming GTP-PDUs. Octet 6 shall be absent if all GTP-U extension headers required to be forwarded shall be stored as indicated in NOTE 1 of Table 8.2.64-1. + +The GTP-U Extension Header Deletion field, when present, shall be encoded as specified in Table 8.2.64-2. It takes the form of a bitmask where each bit provides instructions on the information to be deleted from the incoming GTP-PDU packet. Spare bits shall be ignored by the receiver. + +**Table 8.2.64-2: GTP-U Extension Header Deletion** + +| Octet / Bit | GTP-U Extension Header to be deleted from incoming packet | +|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| 6/1 | PDU Session Container (NOTE) | +| NOTE: | This value shall be used for data forwarding during a 5GS to EPS handover for a UPF that supports EPS-5GS interworking (see clause 5.17.3). | + +## 8.2.65 Recovery Time Stamp + +The Recovery Time Stamp IE is coded as shown in Figure 8.2.65-1. It indicates the UTC time when the PFCP entity started. Octets 5 to 8 are encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [26]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 96 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Recovery Time Stamp value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.65-1: Recovery Time Stamp** + +## 8.2.66 DL Flow Level Marking + +The DL Flow Level Marking IE type shall be encoded as shown in Figure 8.2.66-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----|---|-----|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 to 2 | Type = 97 (decimal) | | | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | | | +| 5 | Spare | | | | SCI | | TTC | | | | | | +| m to (m+1) | ToS/Traffic Class | | | | | | | | | | | | +| p to (p+1) | Service Class Indicator | | | | | | | | | | | | +| q to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +**Figure 8.2.66-1: DL Flow Level Marking** + +The following flags are coded within Octet 5: + +- Bit 1 – TTC (ToS/Traffic Class): If this bit is set to "1", then the ToS/Traffic Class field shall be present, otherwise the ToS/Traffic Class field shall not be present. +- Bit 2 – SCI (Service Class Indicator): If this bit is set to "1", then the Service Class Indicator field shall be present, otherwise the Service Class Indicator field shall not be present. +- Bit 3 to 8: Spare, for future use and set to "0". + +The ToS/Traffic Class field, when present, shall be encoded on two octets as an OctetString. The first octet shall contain the IPv4 Type-of-Service or the IPv6 Traffic-Class field and the second octet shall contain the ToS/Traffic Class mask field. See clause 5.3.15 of 3GPP TS 29.212 [8]. + +Octets p and (p+1) of the Service Class Indicator field, when present, shall be encoded respectively as octets 2 and 3 of the Service Class Indicator Extension Header specified in Figure 5.2.2.3-1 of 3GPP TS 29.281 [3]. + +## 8.2.67 Header Enrichment + +The Header Enrichment IE type shall be encoded as shown in Figure 8.2.67-1. It contains information for header enrichment. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 to 2 | Type = 98 (decimal) | | | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | | | +| 5 | Spare | | | | Header Type | | | | | | | | +| 6 | Length of Header Field Name | | | | | | | | | | | | +| 7 to m | Header Field Name | | | | | | | | | | | | +| p | Length of Header Field Value | | | | | | | | | | | | +| (p+1) to q | Header Field Value | | | | | | | | | | | | +| s to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +**Figure 8.2.67-1: Header Enrichment** + +Header Type indicates the type of the Header. It shall be encoded as defined in Table 8.2.67-1. + +**Table 8.2.67-1: Header Type** + +| Header Type | Value (Decimal) | +|------------------------|-----------------| +| HTTP | 0 | +| Spare, for future use. | 1 to 31 | + +Length of Header Field Name indicates the length of the Header Field Name. + +Header Field Name shall be encoded as an OctetString. + +Length of Header Field Value indicates the length of the Header Field Value. + +Header Field Value shall be encoded as an OctetString. + +For a HTTP Header Type, the contents of the Header Field Name and Header Field Value shall comply with the HTTP header field format (see clause 3.2 of IETF RFC 7230 [23]). + +## 8.2.68 Measurement Information + +The Measurement Information IE shall be encoded as shown in Figure 8.2.68-1. It provides information on the requested measurement information. + +![](5952630aecd107d61c526cda06d3a723_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|------|------|------|------|------|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 100 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | CIAM | ASPO | SSPO | MNOP | ISTM | RADI | INAM | MBQE | +| | | C | C | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.68-1: Measurement Information** + +Octet 5 shall be encoded as follows: + +- Bit 1 – MBQE (Measurement Before QoS Enforcement): when set to "1", this indicates a request to measure the traffic usage before QoS enforcement. +- Bit 2 – INAM (Inactive Measurement): when set to "1", this indicates that the measurement shall be paused (inactive). +- Bit 3 – RADI (Reduced Application Detection Information): when set to "1", this indicates that the Application Detection Information reported to the CP function, upon detecting the start or stop of an application, shall only contain the Application ID. +- Bit 4 – ISTM (Immediate Start Time Metering): when set to "1", this indicates that time metering shall start immediately when the flag is received. +- Bit 5 – MNOP (Measurement of Number of Packets): when set to "1", this indicate a request to measure the number of packets transferred in UL/DL/Total in addition to the measurement in octets when Volume based measurement applies. +- Bit 6 – SSPOC (Send Start Pause of Charging): when set to "1", this indicate that the UP Function shall send a Start Pause of Charging indication to the upstream GTP-U entity(s) when the Dropped DL Traffic Threshold is reached. +- Bits 7 – ASPOC (Applicable for Start of Pause of Charging): when set to "1", this indicate that UP Function the the URR is applicable for Start of Pause of Charging, so that it shall stop the usage measurement for the URR when receiving Start Pause of Charging indication from the peer downstream GTP-U entity. +- Bits 8 – CIAM (Control of Inactive Measurement): when set to "1", this indicates that the UP function shall read the current value of the "INAM" flag and stop (if "INAM" is set to "1") or resume (if "INAM" is set to "0") the usage measurement accordingly for the given URR with the "ASPOC" flag set to "1". If the "CIAM" flag is set + +to 0 for a URR with the "ASPOC" flag set to "1", the UP function shall ignore the "INAM" flag received in the Measurement Information. The "CIAM" flag shall be ignored for a URR without the ASPOC" flag set to "1". + +At least one bit shall be set to "1". Several bits may be set to "1", e.g. both MBQE and MNOP bits are set to "1". + +## 8.2.69 Node Report Type + +The Node Report Type IE shall be encoded as shown in Figure 8.2.69-1. It indicates the type of the node report the UP function sends to the CP function. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-----|------|------|------|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 101 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | VSR | PURR | GPQR | CKDR | UPRR | UPFR | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.69-1: Node Report Type** + +Octet 5 shall be encoded as follows: + +- Bit 1 – UPFR (User Plane Path Failure Report): when set to "1", this indicates a User Plane Path Failure Report. +- Bit 2 – UPRR (User Plane Path Recovery Report): when set to "1", this indicates a User Plane Path Recovery Report. +- Bit 3 – CKDR (Clock Drift Report): when set to "1", this indicates a Clock Drift Report. +- Bit 4 – GPQR (GTP-U Path QoS Report): when set to "1", this indicates a GTP-U Path QoS Report. +- Bit 5 – PURR (peer GTP-U entity Restart Report): when set to "1", this indicates a Peer GTP-U Restart report. +- Bit 6 – VSR (Vendor-Specific Report): when set to "1", this indicates a Vendor-Specific Report. +- Bit 7 to 8 – Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +NOTE 1: If UPFR, UPRR and/or PURR bits are set to "1", the Remote GTP-U Peer IEs in the User Plane Path Failure Report IE, in the User Plane Path Recovery Report IE and/or Peer UP Restart Report IE are different. + +NOTE 2: A Vendor-Specific Report can be used in the PFCP Node Report Request message by non-3GPP Standards Development Organizations for interfaces relying on PFCP as the protocol for Control and User Plane Separation, for reports not defined by 3GPP. See clauses 5.9 and 8.1.1 for the definition and usage of Vendor Specific IEs. + +## 8.2.70 Remote GTP-U Peer + +The Remote GTP-U Peer IE shall be encoded as depicted in Figure 8.2.70-1. + +| Octets | Bits | | | | | | | | | | +|-------------|------------------------------------------------------------|---|-----|----|----|----|----|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 to 2 | Type = 103 (decimal) | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | +| 5 | Spare | | RTS | NI | DI | V4 | V6 | | | | +| m to (m+3) | IPv4 address | | | | | | | | | | +| p to (p+15) | IPv6 address | | | | | | | | | | +| q to (q+1) | Length of Destination Interface field | | | | | | | | | | +| (q+2) to r | Destination Interface field | | | | | | | | | | +| s to (s+1) | Length of Network Instance field | | | | | | | | | | +| (s+2) to t | Network Instance field | | | | | | | | | | +| u to (u+3) | Recovery Timestamp | | | | | | | | | | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | + +**Figure 8.2.70-1: Remote GTP-U Peer** + +The following flags are coded within Octet 5: + +- Bit 1 – V6: If this bit is set to "1", then the IPv6 address field shall be present, otherwise the IPv6 address field shall not be present. +- Bit 2 – V4: If this bit is set to "1", then the IPv4 address field shall be present, otherwise the IPv4 address field shall not be present. +- Bit 3 – DI: If this bit is set to "1", then the Length of Destination Interface field and the Destination Interface field shall be present, otherwise both the Length of Destination Interface field and the Destination Interface field shall not be present. +- Bit 4 – NI: If this bit is set to "1", then the Length of Network Instance field and the Network Instance field shall be present, otherwise both the Length of Network Instance field and the Network Instance field shall not be present. +- Bit 5 – RTS: If this bit is set to "1", then the Recovery Timestamp field shall be present. +- Bit 6 to 8 - Spare, for future use and set to "0". + +Either the V4 or the V6 bit shall be set to "1". + +Octets "m to (m+3)" and/or "p to (p+15)" (IPv4 address / IPv6 address fields), if present, shall contain the respective address values. + +The Destination Interface field, when present, shall be encoded as the same as Destination Interface IE (from octet 5, i.e. excluding Type and Length) specified in clause 8.2.24. + +The Network Instance field, when present, shall be encoded as the same as Network Instance IE (from octet 5, i.e. excluding Type and Length) specified in clause 8.2.4. + +The Recovery Timestamp field shall contain the Recovery Timestamp of the peer GTP-U entity, and when present, shall be encoded as the same as the Time Stamp IE (from octet 5, i.e. excluding Type and Length) specified in clause 8.2.114. + +## 8.2.71 UR-SEQN + +The UR-SEQN (Usage Report Sequence Number) IE identifies the order in which a usage report is generated for a given URR. It shall be encoded as shown in Figure 8.2.71-1. + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 104 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | UR-SEQN | | | | | | | | + +**Figure 8.2.71-1: UR-SEQN** + +The UR-SEQN value shall be encoded as an Unsigned32 binary integer value. + +## 8.2.72 Activate Predefined Rules + +The Activate Predefined Rules IE type shall be coded as shown in Figure 8.2.72-1. It shall indicate a Predefined Rules Name, referring to one or more predefined rules which need to be activated in the UP function. + +| Octets | Bits | | | | | | | | +|------------|-----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 106 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Predefined Rules Name | | | | | | | | + +**Figure 8.2.72-1: Activate Predefined Rules** + +The Predefined Rules Name field shall be encoded as an OctetString. + +## 8.2.73 Deactivate Predefined Rules + +The Deactivate Predefined Rules IE type shall be coded as shown in Figure 8.2.73-1. It shall indicate a Predefined Rules Name, referring to one or more predefined rules which need to be deactivated in the UP function. + +| Octets | Bits | | | | | | | | +|------------|-----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 107 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Predefined Rules Name | | | | | | | | + +**Figure 8.2.73-1: Deactivate Predefined Rules** + +The Predefined Rules Name field shall be encoded as an OctetString. + +## 8.2.74 FAR ID + +The FAR ID IE type shall be encoded as shown in Figure 8.2.74-1. It shall contain a Forwarding Action Rule ID. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 108 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | FAR ID value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.74-1: FAR ID** + +The FAR ID value shall be encoded as an Unsigned32 binary integer value. + +The bit 8 of octet 5 is used to indicate if the Rule ID is dynamically allocated by the CP function or predefined in the UP function. If set to "0", it indicates that the Rule is dynamically provisioned by the CP Function. If set to "1", it indicates that the Rule is predefined in the UP Function. + +## 8.2.75 QER ID + +The QER ID IE type shall be encoded as shown in Figure 8.2.75-1. It shall contain a QoS Enforcement Rule ID. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 109 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | QER ID value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.75-1: QER ID + +The QER ID value shall be encoded as an Unsigned32 binary integer value. + +The bit 8 of octet 5 is used to indicate if the Rule ID is dynamically allocated by the CP function or predefined in the UP function. If set to "0", it indicates that the Rule is dynamically provisioned by the CP Function. If set to "1", it indicates that the Rule is predefined in the UP Function. + +## 8.2.76 OCI Flags + +The OCI Flags IE shall contain the flags for overload control related information. It shall be encoded as shown in Figure 8.2.76-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 110 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | AOCI | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.76-1: OCI Flags + +The following flags are coded within Octet 5: + +- Bit 1 – AOCI: Associate OCI with Node ID: The UP function shall set this flag to "1" if it has included the "Overload Control Information" and if this information is to be associated with the Node ID (i.e. FQDN or the IP address used during the UP function selection) of the serving UP function. This flag shall be set to "1" by the UP function, if the "Overload Control Information" is included in the PFCP Session Establishment Response and the Cause IE is set to a rejection cause value. +- Bit 2 to 8: Spare, for future use and set to "0". + +## 8.2.77 PFCP Association Release Request + +The PFCP Association Release Request IE shall be encoded as shown in Figure 8.2.77-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 111 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | URSS | SARR | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.77-1: PFCP Association Release Request + +The following flags are coded within Octet 5: + +- Bit 1 – SARR (PFCP Association Release Request): If this bit is set to "1", then the UP function requests the release of the PFCP association. +- Bit 2 – URSS (non-zero Usage Reports for the affected PFCP Sessions Sent): If this bit is set to "1", it indicates that the UP function has sent all the non-zero usage reports to the CP function for all PFCP sessions affected by the PFCP Association Release. + +- Bit 3 to 8: Spare, for future use and set to "0". + +## 8.2.78 Graceful Release Period + +The purpose of the Graceful Release Period IE is to specify a specific time for a graceful release. The Graceful Release Period IE shall be encoded as shown in Figure 8.2.78-1 and table 8.2.78.1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 112 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Timer unit | | | | Timer value | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.78-1: Graceful Release Period + +Table 8.2.78.1: Graceful Release Period information element + +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

Timer value
Bits 5 to 1 represent the binary coded timer value.

Timer unit
Bits 6 to 8 defines the timer value unit for the timer as follows:
Bits
8 7 6
0 0 0 value is incremented in multiples of 2 seconds
0 0 1 value is incremented in multiples of 1 minute
0 1 0 value is incremented in multiples of 10 minutes
0 1 1 value is incremented in multiples of 1 hour
1 0 0 value is incremented in multiples of 10 hours
1 1 1 value indicates that the timer is infinite

Other values shall be interpreted as multiples of 1 minute in this version of the protocol.

Timer unit and Timer value both set to all "zeros" shall be interpreted as an indication that the timer is stopped.

| +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 8.2.79 PDN Type + +The PDN Type IE shall be encoded as shown in Figure 8.2.79-1. It indicates the type of a PDN connection (IP, Ethernet or Unstructured). + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 113 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | PDN Type | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.79-1: PDN Type + +The PDN Type shall be encoded as a 3 bits binary integer value as specified in Table 8.2.79-1. + +**Table 8.2.79-1: PDN Type** + +| PDN Type | Value (Decimal) | +|------------------------------------|-----------------| +| IPv4 | 1 | +| IPv6 | 2 | +| IPv4v6 | 3 | +| Non-IP | 4 | +| Ethernet | 5 | +| For future use. Shall not be sent. | 0, 6, 7 | + +## 8.2.80 Failed Rule ID + +The Failed Rule ID IE type shall be encoded as shown in Figure 8.2.80-1. It shall identify the Rule which failed to be created or modified. + +![](fda8b5cd85f7ff5e4a29dd0dbee1279d_img.jpg) + +| Octets | Bits | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|--------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 114 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Rule ID Type | | | | +| 6 to p | Rule ID value | | | | | | | | +| (p+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.80-1: Failed Rule ID** + +The Rule ID Type shall be encoded as a 5 bits binary integer value as specified in Table 8.2.80-1. + +**Table 8.2.80-1: Rule ID Type** + +| Rule ID Type | Value (Decimal) | +|----------------------------------------------------------------------------------------|-----------------| +| PDR | 0 | +| FAR | 1 | +| QER | 2 | +| URR | 3 | +| BAR | 4 | +| MAR | 5 | +| SRR | 6 | +| For future use. Shall not be sent. If received, shall be interpreted as the value "1". | 7 to 31 | + +The length and the value of the Rule ID value field shall be set as specified for the PDR ID, FAR ID, QER ID, URR ID, BAR ID, MAR ID and SRR ID IE types respectively. + +## 8.2.81 Time Quota Mechanism + +The Time Quota Mechanism type shall be encoded as shown in Figure 8.2.81-1. + +![](b64babfa113eff6e42e921574eea285e_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 115 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | BTIT | | +| m to (m+3) | Base Time Interval | | | | | | | | +| w to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.81-1: Time Quota Mechanism** + +BTIT (Base Time Interval Type) indicates the type of the interval to be provided in the Base Time Interval field. + +**Table 8.2.81-1: Base Time Interval Type** + +| Base Time Interval Type | Value (Decimal) | +|-------------------------|-----------------| +| CTP | 0 | +| DTP | 1 | +| Spare, for future use. | 2 to 3 | + +The Base Time Interval, shall be encoded as Unsigned32 as specified in clause 7.2.29 of 3GPP TS 32.299 [18]. + +## 8.2.82 Void + +## 8.2.83 User Plane Inactivity Timer + +The User Plane Inactivity Timer IE contains the inactivity time period, in seconds, to be monitored by the UP function. It shall be encoded as shown in Figure 8.2.83-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 117 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | User Plane Inactivity Timer | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.83-1: User Plane Inactivity Timer** + +The User Plane Inactivity Timer field shall be encoded as an Unsigned32 binary integer value. The timer value "0" shall be interpreted as an indication that user plane inactivity detection and reporting is stopped. + +## 8.2.84 Multiplier + +The Multiplier IE type shall be encoded as shown in Figure 8.2.84-1. It contains a Multiplier (see IETF RFC 4006 [16]) to measure the abstract service units the traffic of an aggregated URR consumes from the credit pool. + +| Octets | Bits | | | | | | | | +|----------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 119 (decimal) | | | | | | | | +| 3 to 4 | Length = 12 | | | | | | | | +| 5 to 12 | Value-Digits | | | | | | | | +| 13 to 16 | Exponent | | | | | | | | + +**Figure 8.2.84-1: Multiplier** + +The Value-Digit value and Exponent value shall be encoded as binary integer value, and set the value as in Value-Digit AVP and Exponent AVP as specified in 3GPP TS 32.299 [18]. + +## 8.2.85 Aggregated URR ID IE + +The Aggregated URR ID IE type shall be encoded as shown in Figure 8.2.85-1. It contains a URR ID. + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 120 (decimal) | | | | | | | | +| 3 to 4 | Length = 4 | | | | | | | | +| 5 to 8 | URR ID value | | | | | | | | + +Figure 8.2.85-1: Aggregated URR ID + +Each URR ID value shall be encoded as an Unsigned32 binary integer value. + +## 8.2.86 Subsequent Volume Quota + +The Subsequent Volume Quota IE type shall be encoded as shown in Figure 8.2.86-1. It contains the volume quota to be monitored by the UP function after the Monitoring Time. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----------|-----------|-----------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 121 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | DLVO
L | ULVO
L | TOVO
L | | +| m to (m+7) | Total Volume | | | | | | | | +| p to (p+7) | Uplink Volume | | | | | | | | +| q to (q+7) | Downlink Volume | | | | | | | | +| S to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.86-1: Subsequent Volume Quota + +The following flags are coded within Octet 5: + +- Bit 1 – TOVOL: If this bit is set to "1", then the Total Volume field shall be present, otherwise the Total Volume field shall not be present. +- Bit 2 – ULVOL: If this bit is set to "1", then the Uplink Volume field shall be present, otherwise the Uplink Volume field shall not be present. +- Bit 3 – DLVOL: If this bit is set to "1", then the Downlink Volume field shall be present, otherwise the Downlink Volume field shall not be present. +- Bit 4 to bit 8: Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +The Total Volume, Uplink Volume and Downlink Volume fields shall be encoded as an Unsigned64 binary integer value. They shall contain the total, uplink or downlink number of octets respectively. + +## 8.2.87 Subsequent Time Quota + +The Subsequent Time Quota IE type shall be encoded as shown in Figure 8.2.87-1. It contains the time quota to be monitored by the UP function after the Monitoring Time. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 122 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Time Quota value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.87-1: Subsequent Time Quota + +The Time Quota value shall be encoded as an Unsigned32 binary integer value. It contains a duration in seconds. + +## 8.2.88 RQI + +The Reflective QoS Indicator (RQI) IE shall be encoded as shown in Figure 8.2.88-1. It indicates if Reflective QoS applies for the UL. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 123 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | RQI | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.88-1: RQI + +The value of RQI flag shall be set as follows: + +- RQI set to 0: deactivate Reflective QoS; +- RQI set to 1: activate Reflective QoS. + +See also clause 5.5.3.4 of 3GPP TS 38.415 [34]. + +## 8.2.89 QFI + +The QFI IE type shall be encoded as shown in Figure 8.2.89-1. It contains an QoS flow identifier identifying a QoS flow in a 5G system filter. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|-----------|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 124 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | QFI value | | | | | +| p to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.89-1: QFI + +The QFI value shall be encoded as binary integer value, as specified in clause 5.5.3.3 of 3GPP TS 38.415 [34]. + +## 8.2.90 Query URR Reference + +The Query URR Reference IE type shall be encoded as shown in Figure 8.2.90-1. It shall contain the reference of a query request for URR(s). + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 125 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Query URR Reference value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.90-1: Query URR Reference + +The Query URR Reference value shall be encoded as an Unsigned32 binary integer value. + +## 8.2.91 Additional Usage Reports Information + +The Additional Usage Reports Information IE type shall be encoded as shown in Figure 8.2.91-1. It shall either indicate that additional usage reports will follow, or contain the total number of usage reports that need to be sent in all the additional PFCP Session Report Request messages after the PFCP Session Modification Response or PFCP Session Deletion Response (see clause 5.2.2.3.1). + +| Octets | Bits | | | | | | | | | | | | | | | +|------------|------------------------------------------------------------|------------------------------------------|---|---|---|---|---|---|--|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | +| 1 to 2 | Type = 126 (decimal) | | | | | | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | | | | | | +| 5 | AURI | Number of Additional Usage Reports value | | | | | | | | | | | | | | +| 6 | Number of Additional Usage Reports value | | | | | | | | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | | | | + +**Figure 8.2.91-1: Additional Usage Reports Information** + +The Number of Additional Usage Reports value shall be encoded as an unsigned binary integer value on 15 bits. Bit 7 of Octet 5 is the most significant bit and bit 1 of Octet 6 is the least significant bit. + +The bit 8 of octet 5 shall encode the AURI (Additional Usage Reports Indication) flag: + +- when set to "1", it indicates that additional usage reports will follow. In this case, the Number of Additional Usage Reports value shall be set to "0" by the sender and ignored by the receiver; +- when set to "0", the Number of Additional Usage Reports value shall be set to the total number of additional usage reports to be sent in PFCP Session Report Request messages. + +## 8.2.92 Traffic Endpoint ID + +The Traffic Endpoint ID IE type shall be encoded as shown in Figure 8.2.92-1. It shall contain a Traffic Endpoint ID. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 131 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Traffic Endpoint ID value | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.92-1: Traffic Endpoint ID** + +The Traffic Endpoint ID value shall be encoded as a binary integer value within the range of 0 to 255. + +## 8.2.93 MAC address + +The MAC address IE shall be encoded as shown in Figure 8.2.93-1. It shall contain a MAC address value. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|------|----------|------|----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 133 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | spare | | | | UDES | USO
U | DEST | SOU
R | +| m to (m+5) | Source MAC address value | | | | | | | | +| n to (n+5) | Destination MAC address value | | | | | | | | +| o to (o+5) | Upper Source MAC address value | | | | | | | | +| p to (p+5) | Upper Destination MAC address value | | | | | | | | +| s to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.93-1: MAC address** + +The following flags are coded within Octet 5: + +- Bit 1 – SOUR (Source): If this bit is set to "1", then the source MAC address value is provided. +- Bit 2 – DEST (Destination): If this bit is set to "1", then the destination MAC address value is provided. +- Bit 3 – USOU (Source): If this bit is set to "1", then the source MAC address value contains the lower value and Upper Source MAC address value contains the upper value of an MAC address range. +- Bit 4 – UDES (Destination): If this bit is set to "1", then the destination MAC address value contains the lower value and Upper Destination MAC address value contains the upper value of an MAC address range.- Bit 5 to 8: Spare, for future use and set to "0". + +Octets "m to (m+5)" or "n to (n+5)" and "o to (o+5)" or "p to (p+5)", if present, shall contain an MAC address value (12-digit hexadecimal numbers). + +## 8.2.94 C-TAG (Customer-VLAN tag) + +The C-TAG IE shall be encoded as shown in Figure 8.2.94-1. It shall contain the Customer-VLAN tag (C-TAG) as defined in IEEE 802.1Q [30]. + +![](40602f4e56e7323850ca7d63082cb4ad_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|-----------|-----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 134 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | VID | DEI | PCP | | +| 6 | C-VID value | | | | DEI Flag | PCP value | | | +| 7 | C-VID Value | | | | | | | | +| 8 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.94-1: C-TAG (Customer-VLAN tag)** + +The following flags are coded within Octet 5: + +- Bit 1 – PCP: If this bit is set to "1", then PCP Value field shall used by the receiver, otherwise the PCP Value field shall be ignored. +- Bit 2 – DEI: If this bit is set to "1", then DEI flag field shall used by the receiver, otherwise the DEI flag field shall be ignored. +- Bit 3 – VID: If this bit is set to "1", then C-VID value field shall used by the receiver, otherwise the VID Value field shall be ignored. +- Bit 4 to 8 – spare and reserved for future use. + +The PCP value, DEI flag and C-VID Value are specified in IEEE 802.1Q [30] tag format. + +Octet 6 / Bit 3 shall contain the most significant bit of the PCP value. + +Octet 6 / Bit 8 shall be the most significant bit of the C-VID value and Octet 7 / Bit 1 shall be the least significant bit (see clause 7.1). + +NOTE: The encoding of the C-Tag in PFCP differs from the encoding of the C-Tag defined in IEEE 802.1Q [30]. + +## 8.2.95 S-TAG (Service-VLAN tag) + +The S-TAG IE type shall be encoded as shown in Figure 8.2.95-1. It shall contain Service-VLAN tag (S-TAG) as defined in IEEE 802.1Q [30] + +![](e97277b95d25bb9cfe8581800948ddeb_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|----------|-----------|-----|-----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 135 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | VID | DEI | PCP | | +| 6 | S-VID value | | | DEI Flag | PCP value | | | | +| 7 | S-VID value | | | | | | | | +| 8 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.95-1: S-TAG (Service-VLAN tag)** + +The following flags are coded within Octet 5: + +- Bit 1 – PCP: If this bit is set to "1", then PCP Value field shall used by the receiver, otherwise the PCP Value field shall be ignored. +- Bit 2 – DEI: If this bit is set to "1", then DEI flag field shall used by the receiver, otherwise the DEI flag field shall be ignored. +- Bit 3 – VID: If this bit is set to "1", then VID value field shall used by the receiver, otherwise the VID Value field shall be ignored. +- Bit 4 to 8 – spare and reserved for future use. + +The PCP value, DEI flag and S-VID Value are specified in IEEE 802.1Q [30] tag format. + +Octet 6 / Bit 3 shall contain the most significant bit of the PCP value. + +Octet 6 / Bit 8 shall be the most significant bit of the S-VID value and Octet 7 / Bit 1 shall be the least significant bit (see clause 7.1). + +NOTE: The encoding of the S-Tag in PFCP differs from the encoding of the S-Tag defined in IEEE 802.1Q [30]. + +## 8.2.96 Ethertype + +The Ethertype IE type shall be encoded as shown in Figure 8.2.96-1. It contains an Ethertype as defined in IEEE 802.3 [31]. + +![](f482942742e47fc04606f7a4a4c2f1d9_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 136 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Ethertype | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.96-1: Ethertype** + +## 8.2.97 Proxying + +The Proxying IE shall be encoded as shown in Figure 8.2.97-1. It specifies if responding to Address Resolution Protocol (ARP) (see IETF RFC 826 [32]) and / or IPv6 Neighbour Solicitation (see IETF RFC 4861 [33]) as specified in clause 5.6.10.2 of 3GPP TS 23.501 [28], functionality for the Ethernet PDUs is performed in UPF. + +![](9fc763d186fb9af5895be87e5cf29c76_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----|-----|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 137 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | INS | ARP | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +### Figure 8.2.97-1: Proxying + +The following flags are coded within Octet 5: + +- Bit 1 – ARP: If this bit is set to "1", then responding ARP is performed in UPF based on local cache information. +- Bit 2 – INS: If this bit is set to "1", then responding to IPv6 Neighbour Solicitation is performed in UPF based on local cache information. +- Bit 3 to 8 – spare and reserved for future use. + +## 8.2.98 Ethernet Filter ID + +The Ethernet Filter ID IE type shall be encoded as shown in Figure 8.2.98-1. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 138 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Ethernet Filter ID value | | | | | | | | +| 10 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.98-1: Ethernet Filter ID + +The Ethernet Filter ID value shall be encoded as an Unsigned32 binary integer value. + +## 8.2.99 Ethernet Filter Properties + +The Ethernet Filter Properties IE type shall be encoded as shown in Figure 8.2.99-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 139 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | BIDE | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.99-1: Ethernet Filter Properties + +The following flags are coded within Octet 5: + +- Bit 1 – BIDE (Bidirectional Ethernet Filter): If this bit is set to "1", then the Ethernet Filter identified by the Ethernet Filter ID is bidirectional. +- Bit 2 to 8 – spare and reserved for future use. + +## 8.2.100 Suggested Buffering Packets Count + +The Suggested Buffering Packets Count IE indicates the number of packets (including both UL and DL packets) that are suggested to be buffered by the UP function while waiting for the new instruction from the CP function. It is coded as depicted in Figure 8.2.100-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 140 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Packet Count value | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.100-1: Suggested Buffering Packets Count + +The Packet Count value is encoded in octet 5 and the range of the Packet Count value is from 0 to 255. + +## 8.2.101 User ID + +The User ID IE type shall be encoded as shown in Figure 8.2.101-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|------|-----------|-------|------|-------------|-------|-------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 141 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | PEIF | GPSI
F | SUPIF | NAIF | MSIS
DNF | IMEIF | IMSIF | +| 6 | Length of IMSI | | | | | | | | +| 7 to a | IMSI | | | | | | | | +| b | Length of IMEI | | | | | | | | +| (b+1) to c | IMEI | | | | | | | | +| d | Length of MSISDN | | | | | | | | +| (d+1) to e | MSISDN | | | | | | | | +| f | Length of NAI | | | | | | | | +| (f+1) to g | NAI | | | | | | | | +| h | Length of SUPI | | | | | | | | +| (h+1) to i | SUPI | | | | | | | | +| j | Length of GPSI | | | | | | | | +| (j+1) to k | GPSI | | | | | | | | +| l | Length of PEI | | | | | | | | +| (l+1) to m | PEI | | | | | | | | +| p to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.101-1: User ID + +The following flags are coded within Octet 5: + +- Bit 1 – IMSIF: If this bit is set to "1", then the Length of IMSI and IMSI fields shall be present, otherwise these fields shall not be present. +- Bit 2 – IMEIF: If this bit is set to "1", then the Length of IMEI and IMEI fields shall be present, otherwise these fields shall not be present. +- Bit 3 – MSISDNF: If this bit is set to "1", then the Length of MSISDN and MSISDN fields shall be present, otherwise these fields shall not be present. +- Bit 4 – NAIF: If this bit is set to "1", then the Length of NAI and NAI fields shall be present, otherwise these fields shall not be present. +- Bit 5 – SUPIF: If this bit is set to "1", then the Length of SUPI and SUPI fields shall be present, otherwise these fields shall not be present. +- Bit 6 – GPSIF: If this bit is set to "1", then the Length of GPSI and GPSI fields shall be present, otherwise these fields shall not be present. +- Bit 7 – PEIF: If this bit is set to "1", then the Length of PEI and PEI fields shall be present, otherwise these fields shall not be present.- Bit 8: Spare, for future use and set to "0". + +One or more flags may be set to "1". + +For 5GS User Identities: + +- The SUPI field shall only be used for carrying a Global Cable Identifier (GCI) or a Global Line Identifier (GLI). The IMSI and NAI, if received by the SMF in the SUPI, shall be included in the IMSI and NAI field respectively. +- The GPSI field shall only be used for carrying an External Identifier. The MSISDN, if received by the SMF in the SUPI, shall be included in the MSISDN field. +- The PEI field shall only be used for carrying an MAC address or an Extended Unique Identifier. The IMEI, if received by the SMF in the PEI, shall be included in the IMEI field. + +The coding of IMSI field, from octets 7 to 'a' shall be encoded as the octets 5 to n+4 of the IMSI IE type specified in clause 8.3 of 3GPP TS 29.274 [9]. + +The coding of IMEI field, in octets 'b+1' to 'c' shall be encoded as the octets 5 to n+4 of the MEI IE type specified in clause 8.10 of 3GPP TS 29.274 [9]. + +The coding of MSISDN field, in octets 'd+1' to 'e' shall be encoded as the octets 5 to n+4 of the MSISDN IE type specified in clause 8.11 of 3GPP TS 29.274 [9]. + +The coding of the SUPI field, in octets 'h+1' to 'i' shall be encoded as the Supi data type specified in clause 5.3.2 of 3GPP TS 29.571 [61]. + +The coding of the GPSI field, in octets 'j+1' to 'k' shall be encoded as the Gpsi data type specified in clause 5.3.2 of 3GPP TS 29.571 [61]. + +The coding of the PEI field, in octets 'l+1' to 'm' shall be encoded as the Pei data type specified in clause 5.3.2 of 3GPP TS 29.571 [61]. + +The NAI field, in octets 'f+1' to 'g' shall be encoded as an Octet String (see IETF RFC 4282 [36]). + +## 8.2.102 Ethernet PDU Session Information + +Ethernet PDU Session Indication is coded as depicted in Figure 8.2.102-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 142 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | ETHI | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.102-1: Ethernet PDU Session Information** + +The following flags are coded within Octet 5: + +- Bit 1 – ETHI (Ethernet Indication): This bit shall be set to "1". This refers to all the DL traffic matching the Ethernet PDU session (see clause 5.13.1). +- Bit 2 to 8 are spare and reserved for future use. + +## 8.2.103 MAC Addresses Detected + +The MAC Addresses Detected IE shall be encoded as shown in Figure 8.2.103-1. It shall contain a list of MAC address values. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 144 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Number of MAC addresses (k) | | | | | | | | +| 6 to 11 | MAC address value 1 | | | | | | | | +| o to (o+5) | MAC address value 2 | | | | | | | | +| p to (p+5) | ... | | | | | | | | +| q to (q+5) | MAC address value k | | | | | | | | +| s | Length of C-TAG field | | | | | | | | +| (s+1) to t | C-TAG | | | | | | | | +| u | Length of S-TAG field | | | | | | | | +| (u+1) to v | S-TAG | | | | | | | | +| w to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.103-1: MAC addresses Detected + +Octet 5 shall encode the number of 48-bit MAC addresses. + +MAC address values shall be encoded as 12-digit hexadecimal numbers. + +The Length of C-TAG field shall indicate the length of the C-TAG field. It shall be set to 0 if the C-TAG field is absent. + +When present, the C-TAG field shall be encoded as the Customer-VLAN tag defined in clause 8.2.94, excluding octets 1 to 4. + +The Length of S-TAG field shall indicate the length of the S-TAG field. It shall be set to 0 if the S-TAG field is absent. + +When present, the S-TAG field shall be encoded as the Service-VLAN Tag defined in clause 8.2.95, excluding octets 1 to 4. + +## 8.2.104 MAC Addresses Removed + +The MAC Addresses Removed IE shall be encoded as shown in Figure 8.2.104-1. It shall contain a list of MAC address values. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 145 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Number of MAC addresses (k) | | | | | | | | +| 6 to 11 | MAC address value 1 | | | | | | | | +| o to (o+5) | MAC address value 2 | | | | | | | | +| p to (p+5) | ... | | | | | | | | +| q to (q+5) | MAC address value k | | | | | | | | +| s | Length of C-TAG field | | | | | | | | +| (s+1) to t | C-TAG | | | | | | | | +| u | Length of S-TAG field | | | | | | | | +| (u+1) to v | S-TAG | | | | | | | | +| w to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.104-1: MAC addresses Removed + +Octet 5 shall encode the number of 48-bit MAC addresses. + +MAC address values shall be encoded as 12-digit hexadecimal numbers. + +The Length of C-TAG field shall indicate the length of the C-TAG field. It shall be set to 0 if the C-TAG field is absent. + +When present, the C-TAG field shall be encoded as the Customer-VLAN tag defined in clause 8.2.94, excluding octets 1 to 4. + +The Length of S-TAG field shall indicate the length of the S-TAG field. It shall be set to 0 if the S-TAG field is absent. + +When present, the S-TAG field shall be encoded as the Service-VLAN Tag defined in clause 8.2.95, excluding octets 1 to 4. + +## 8.2.105 Ethernet Inactivity Timer + +The Ethernet Inactivity Timer IE contains the inactivity time period, in seconds, to be monitored by the UP function, to detect that a UE MAC address is inactive. It shall be encoded as shown in Figure 8.2.105-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 146 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Ethernet Inactivity Timer | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.105-1: Ethernet Inactivity Timer** + +The Ethernet Inactivity Timer field shall be encoded as an Unsigned32 binary integer value. + +## 8.2.106 Subsequent Event Quota + +The Subsequent Event Quota IE type shall be encoded as shown in Figure 8.2.106-1. It contains the event quota to be monitored by the UP function. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 150 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Subsequent Event Quota | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.106-1: Subsequent Event Quota** + +The Subsequent Event Quota field shall be encoded as an Unsigned32 binary integer value. + +## 8.2.107 Subsequent Event Threshold + +The Subsequent Event Threshold IE contains the Number of events after which the measurement report is to be generated by the UP function. It shall be encoded as shown in Figure 8.2.107-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 151 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Subsequent Event Threshold | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.107-1: Subsequent Event Threshold** + +The Subsequent Event Threshold field shall be encoded as an Unsigned32 binary integer value. + +## 8.2.108 Trace Information + +The Trace Information IE type shall be encoded as shown in Figure 8.2.108-1. It contains the trace control and configuration parameters to apply for the PFCP session. + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|-------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 to 2 | Type = 152 (decimal) | | | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | | | +| 5 | MCC digit 2 | | | | MCC digit 1 | | | | | | | | +| 6 | MNC digit 3 | | | | MNC digit 2 | | | | | | | | +| 7 | MNC digit 1 | | | | | | | | | | | | +| 8 to 10 | Trace ID | | | | | | | | | | | | +| 11 | Length of Triggering Events | | | | | | | | | | | | +| 12 to m | Triggering Events | | | | | | | | | | | | +| m+1 | Session Trace Depth | | | | | | | | | | | | +| m+2 | Length of List of Interfaces | | | | | | | | | | | | +| (m+3) to p | List of Interfaces | | | | | | | | | | | | +| p+1 | Length of IP Address of Trace Collection Entity | | | | | | | | | | | | +| (p+2) to q | IP Address of Trace Collection Entity | | | | | | | | | | | | +| (q+1) to (n-4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.2.108-1: Trace Information + +Octets 5 to 10 represent the Trace Reference parameter as defined in clause 5.6 of 3GPP TS 32.422 [35]. + +Triggering Events, Session Trace Depth, List of Interfaces and IP Address of Trace Collection Entity are specified in 3GPP TS 32.422 [35]. + +Octets "(p+2) to q" shall contain an IPv4 address value (4 octets) or IPv6 address value (16 octets). + +See 3GPP TS 24.008 [5], clause 10.5.1.4, Mobile Identity, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 6 are coded as "1111". + +## 8.2.109 Framed-Route + +The Framed-Route IE describes a framed route. It shall be encoded as shown in Figure 8.2.109-1. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 153 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Framed-Route | | | | | | | | + +Figure 8.2.109-1: Framed-Route + +The Framed-Route field shall be encoded as an Octet String as the value part of the Framed-Route AVP specified in IETF RFC 2865 [37]. + +## 8.2.110 Framed-Routing + +The Framed-Routing IE describes the frame routing of a framed route. It shall be encoded as shown in Figure 8.2.110-1. + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 154 (decimal) | | | | | | | | +| 3 to 4 | Length = 4 | | | | | | | | +| 5 to 8 | Framed-Routing | | | | | | | | + +Figure 8.2.110-1: Framed-Routing + +The Framed-Routing field shall be encoded as the value part of the Framed-Routing AVP specified in IETF RFC 2865 [37]. + +## 8.2.111 Framed-IPv6-Route + +The Framed-IPv6-Route IE describes a framed IPv6 route. It shall be encoded as shown in Figure 8.2.111-1. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 155 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Framed-IPv6-Route | | | | | | | | + +**Figure 8.2.111-1: Framed-IPv6-Route** + +The Framed-IPv6-Route field shall be encoded as an Octet String as the value part of the Framed-IPv6-Route AVP specified in IETF RFC 3162 [38]. + +## 8.2.112 Event Quota + +The Event Quota IE type shall be encoded as shown in Figure 8.2.112-1. It contains the event quota to be monitored by the UP function. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 148 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Subsequent Event Quota | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.112-1: Event Quota** + +The Event Quota field shall be encoded as an Unsigned32 binary integer value. + +## 8.2.113 Event Threshold + +The Event Threshold IE contains the Number of events after which the measurement report is to be generated by the UP function. It shall be encoded as shown in Figure 8.2.113-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 149 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Event Threshold | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.113-1: Event Threshold** + +The Event Threshold field shall be encoded as an Unsigned32 binary integer value. + +## 8.2.114 Time Stamp + +The Time Stamp IE indicates the time stamp when certain event occurs or certain operation occurs. It shall be encoded as shown in Figure 8.2.114-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 156 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Time Stamp | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.114-1: Time Stamp + +The Time Stamp field shall contain a UTC time. Octets 5 to 8 shall be encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [12]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +## 8.2.115 Averaging Window + +The Averaging Window IE shall contain the duration over which the GFBR and MFBR is calculated (see clause 5.7.3.6 of 3GPP TS 23.501 [28]), or the duration over which the Session-AMBR is measured (see clause 5.7.2.6 of 3GPP TS 23.501 [28]). It shall be encoded as shown in Figure 8.2.115-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 157 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Averaging Window | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.115-1: Averaging Window + +The Averaging Window field shall be encoded as an Unsigned32 binary integer value. It shall contain the duration in ms. + +## 8.2.116 Paging Policy Indicator (PPI) + +The Paging Policy Indicator (PPI) IE indicates a PPI value for paging policy differentiation. It shall be encoded as shown in Figure 8.2.116-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 158 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | PPI value | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.116-1: Paging Policy Indicator (PPI) + +The PPI value shall be encoded as a value between 0 and 7, as specified in clause 5.5.3.7 of 3GPP TS 38.415 [34]. + +## 8.2.117 APN/DNN + +Access Point Name (APN) / Data Network Name (DNN) is transferred from CP function to UP function. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 159 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | APN/DNN | | | | | | | | + +**Figure 8.2.117-1: APN/DNN** + +The encoding the APN/DNN field follows 3GPP TS 23.003 [2] clause 9.1. The content of the APN/DNN field shall be the full APN/DNN with both the APN/DNN Network Identifier and APN/DNN Operator Identifier being present as specified in 3GPP TS 23.003 [2] clauses 9.1.1 and 9.1.2, 3GPP TS 23.060 [19] Annex A and 3GPP TS 23.401 [14] clauses 4.3.8.1. + +NOTE: The APN/DNN field is not encoded as a dotted string as commonly used in documentation. + +## 8.2.118 3GPP Interface Type + +The 3GPP Interface Type IE shall be encoded as shown in Figure 8.2.118-1. It indicates the 3GPP interface type of the Source Interface within the PDR IE, or the 3GPP interface type of the Destination Interface within the FAR IE. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|----------------------|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 160 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | Interface Type value | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.118-1: 3GPP Interface Type** + +The 3GPP Interface Type value shall be encoded as a 6 bits binary integer as specified in in Table 8.2.118-1. + +**Table 8.2.118-1: Interface Type value** + +| Interface value | Values (Decimal) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| S1-U | 0 | +| S5 /S8-U (NOTE 1) | 1 | +| S4-U | 2 | +| S11-U | 3 | +| S12 | 4 | +| Gn/Gp-U (NOTE 2) | 5 | +| S2a-U | 6 | +| S2b-U | 7 | +| eNodeB GTP-U interface for DL data forwarding | 8 | +| eNodeB GTP-U interface for UL data forwarding | 9 | +| SGW/UPF GTP-U interface for DL data forwarding | 10 | +| N3 3GPP Access | 11 | +| N3 Trusted Non-3GPP Access | 12 | +| N3 Untrusted Non-3GPP Access | 13 | +| N3 for data forwarding | 14 | +| N9 (or N9 for non-roaming, see NOTE 3) | 15 | +| SGi | 16 | +| N6 | 17 | +| N19 | 18 | +| S8-U | 19 | +| Gp-U | 20 | +| N9 for roaming | 21 | +| Iu-U | 22 | +| N9 for data forwarding | 23 | +| Sxa-U | 24 | +| Sxb-U | 25 | +| Sxc-U | 26 | +| N4-U | 27 | +| SGW/UPF GTP-U interface for UL data forwarding | 28 | +| N6mb/Nmb9 | 29 | +| N3mb | 30 | +| N19mb | 31 | +| Spare | 32 to 63 | +| NOTE 1: If separation of roaming and non-roaming traffic is desired this value should only be used for the S5-U interface and "S8-U" (decimal 19) should be used for the S8-U interface. | | +| NOTE 2: If separation of roaming and non-roaming traffic is desired this value should only be used for the Gn-U interface and "Gp-U" (decimal 20) should be used for the Gp-U interface. | | +| NOTE 3: If separation of roaming and non-roaming traffic is desired, this value should only be used for N9 non-roaming interfaces and (decimal value "21") should be used for N9 roaming interfaces. | | + +## 8.2.119 PFCPSRReq-Flags + +The PFCPSRReq-Flags IE indicates flags applicable to the PFCP Session Report Request message. It is coded as depicted in Figure 8.2.119-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|-------|-------|-------|-----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 161 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | Spare | Spare | Spare | Spare | Spare | PSDB
U | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.119-1: PFCPSRReq-Flags** + +The following bits within Octet 5 shall indicate: + +- Bit 1 – PSDBU (PFCP Session Deleted By the UP function): if this bit is set to "1", it indicates that the UP function has reported all non-zero Usage Reports for all URRs in the PFCP Session and the PFCP Session is being deleted in the UP function locally. +- Bit 2 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +## 8.2.120 PFCPAUReq-Flags + +The PFCPAUReq-Flags IE indicates flags applicable to the PFCP Association Update Request message. It is coded as depicted in Figure 8.2.120-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|-------|-------|-------|-----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 162 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | Spare | Spare | Spare | Spare | Spare | PARP
S | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.120-1: PFCPAUReq-Flags** + +The following bits within Octet 5 shall indicate: + +- Bit 1 – PARPS (PFCP Association Release Preparation Start): if this bit is set to "1", it indicates that the PFCP association is to be released and all non-zero usage reports for the PFCP Sessions affected by the release of the PFCP association shall be reported. +- Bit 2 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +## 8.2.121 Activation Time + +The Activation Time IE indicates the time that the PDR shall be set to be active in the UP function. It shall be encoded as shown in Figure 8.2.121-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 163 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Activation Time | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.121-1: Activation Time** + +The Activation Time field shall indicate the activation time in UTC time. Octets 5 to 8 shall be encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [12]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +## 8.2.122 Deactivation Time + +The Deactivation Time IE indicates the time that the PDR shall be set to be inactive in the UP function. It shall be encoded as shown in Figure 8.2.122-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 164 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Deactivation Time | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.122-1: Deactivation Time + +The Deactivation Time field shall indicate the deactivation time in UTC time. Octets 5 to 8 shall be encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [12]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +## 8.2.123 MAR ID + +The MAR ID IE type shall be encoded as shown in Figure 8.2.123-1. It shall contain a Multi-Access Rule ID. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 170 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | MAR ID value | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.123-1: MAR ID + +The MAR ID value field shall be encoded as an Unsigned16 binary integer value. + +## 8.2.124 Steering Functionality + +The Steering Functionality IE type shall be encoded as shown in Figure 8.2.124-1. It indicates the steering functionality (ATSSS feature) to be used in a MAR. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|------------------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 171 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Steering Functionality Value | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.124-1: Steering Functionality + +The Steering Functionality value shall be encoded as a 4 bits binary integer as specified in Table 8.2.124-1. + +Table 8.2.124-1: Steering Functionality value + +| Steering Functionality Value | Values (Decimal) | +|------------------------------|------------------| +| ATSSS-LL | 0 | +| MPTCP | 1 | +| MPQUIC | 2 | +| Spare | 3 to 15 | + +## 8.2.125 Steering Mode + +The Steering Mode IE type shall be encoded as shown in Figure 8.2.125-1. It indicates the steering mode to be used in a MAR. + +![](1ba9045eb6dc22039a16b92b1427e696_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 172 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Steering Mode Value | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.125-1: Steering Mode + +The Steering Mode value shall be encoded as a 4 bits binary integer as specified in Table 8.2.125-1. + +Table 8.2.125-1: Steering Mode value + +| Steering Mode Value | Values (Decimal) | +|---------------------|------------------| +| Active-Standby | 0 | +| Smallest Delay | 1 | +| Load Balancing | 2 | +| Priority-based | 3 | +| Redundant | 4 | +| Spare | 5 to 15 | + +## 8.2.126 Weight + +The Weight IE shall be encoded as shown in Figure 8.2.126-1. It indicates the percentage of the traffic to be transferred over one access. + +The Weight Value field shall take binary coded integer values from 0 up to 100. Other values shall be considered as 0. + +![](c84f48e1ab022f08a2b2bfd914dbe9bb_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 173 (decimal) | | | | | | | | +| 3 to 4 | Length = 1 | | | | | | | | +| 5 | Weight Value | | | | | | | | + +Figure 8.2.126-1: Weight + +## 8.2.127 Priority + +The Priority IE type shall be encoded as shown in Figure 8.2.127-1. It indicates whether it is active or standby or no standby for a given access when the Steering Mode is set to Active-Standby, or whether it is high or low priority for a given access when the Steering Mode is set to Priority-based. + +![](82645d0210baf1751f9ed2a4d3a9e5d7_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 174 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Priority Value | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.127-1: Priority + +The Priority Value shall be encoded as a 4 bits binary integer as specified in Table 8.2.127-1. + +**Table 8.2.127-1: Priority value** + +| Priority Value | Values (Decimal) | +|----------------|------------------| +| Active | 0 | +| Standby | 1 | +| No Standby | 2 | +| High | 3 | +| Low | 4 | +| Primary | 5 | +| Secondary | 6 | +| Spare | 7 to 15 | + +The "No Standby" Priority value may be used when the network determines to not define a Standby access. + +## 8.2.128 UE IP address Pool Identity + +The User Plane UE IP Pool Identity IE type shall be encoded as shown in Figure 8.2.128-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 177 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | UE IP address Pool Id Length | | | | | | | | +| 7 to k | UE IP address Pool Identity | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.128-1: UE IP address Pool Identity** + +Octets 7 to "k": The UE IP address Pool Identity shall be encoded as an OctetString (see the Framed-Ipv6-Pool and Framed-Pool in clause 12.6.3 of 3GPP TS 29.561 [49]); the value part of Framed-Pool or Framed-Ipv6-Pool is copied into the UE IP address Pool Identity field of the UE IP address Pool Identity IE if the CP function receives the corresponding information from an external server. + +## 8.2.129 Alternative SMF IP Address + +The Alternative SMF IP Address IE shall contain an IPv4 and/or IPv6 address. It shall be encoded as shown in Figure 8.2.129-1. + +| Octets | Bits | | | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|-----|----|----|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 to 2 | Type = 178 (decimal) | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | +| 5 | Spare | | | | PPE | V4 | V6 | | | | +| p to (p+3) | IPv4 Address | | | | | | | | | | +| q to (q+15) | IPv6 Address | | | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | + +**Figure 8.2.129-1: Alternative SMF IP Address** + +The following flags are coded within Octet 5: + +- Bit 1 – V6: If this bit is set to "1", then the IPv6 address field shall be present in the Alternative SMF IP Address, otherwise the IPv6 address field shall not be present. +- Bit 2 – V4: If this bit is set to "1", then the IPv4 address field shall be present in the Alternative SMF IP Address, otherwise the IPv4 address field shall not be present. +- Bit 3 – PPE (Preferred PFCP Entity): If this bit is set to "1", then the alternative SMF IP address shall be used by the UPF as a preferred address when reselecting a PFCP entity as specified in clauses 5.22.2 and 5.22.3. +- Bit 4 to 8 Spare, for future use and set to "0". + +Octets "p to (p+3)" or "q to (q+15)" (IPv4 address / IPv6 address fields), if present, shall contain the address value. + +## 8.2.130 Packet Replication and Detection Carry-On Information + +The Packet Replication and Detection Carry-On Information IE shall be encoded as shown in Figure 8.2.130-1. + +![](e914e488b454719738e15f6273374f85_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|-------------|--------|-------------|-------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 179 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | DCA
RONI | PRIN6I | PRIN1
9I | PRIU
EAI | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.130-1: Packet Replication and Detection Carry-On Information** + +The following flags are coded within Octet 5: + +- Bit 1 – PRIUEAI (Packet Replication Information – UE/PDU Session Address Indication): This bit shall be set to "1" to indicate that if the packet has been received from the UE's PDU session (e.g. the source IP address is set to the UE's PDU IP session address, or the source MAC address is an Ethernet MAC address associated to the PDU session for an Ethernet PDU session), the UP function shall neither create a copy of the packet nor apply the corresponding processing (i.e. FAR, QER, URR). Otherwise the UPF shall perform a copy of the packet and apply the corresponding processing (i.e. FAR, QER, URR). +- Bit 2 – PRIN19I (Packet Replication Information - N19 Indication): This bit shall be set to "1" to indicate that if the packet has been received from a N19 interface (i.e. a "N19 Indication" internal flag is associated with the packet, see clause 8.2.56)), the UP function shall neither create a copy of the packet nor apply the corresponding processing (i.e. FAR, QER, URR). Otherwise the UPF shall perform a copy of the packet and apply the corresponding processing (i.e. FAR, QER, URR). +- Bit 3 – PRIN6I (Packet Replication Information - N6 Indication): This bit shall be set to "1" to indicate that if the packet has been received from a N6 interface (i.e. a "N6 Indication" internal flag is associated with the packet, see clause 8.2.56)), the UP function shall neither create a copy of the packet nor apply the corresponding processing (i.e. FAR, QER, URR). Otherwise the UPF shall perform a copy of the packet and apply the corresponding processing (i.e. FAR, QER, URR). +- Bit 4 – DCARONI (Detection Carry-On Indication): This bit shall be set to "1" to request the UP function to continue the packet detection process, i.e. look up of other PDRs of other PFCP sessions matching the packet (see clause 5.2.1). +- Bit 5 to 8 are spare and reserved for future use. + +## 8.2.131 SMF Set ID + +The SMF Set ID IE shall contain an FQDN representing the SMF Set. It shall be encoded as shown in Figure 8.2.131-1. + +![](e8fb82f1c4527079e81cd9c572eb1602_img.jpg) + +| Octets | Bits | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 180 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | | +| 6 to m | FQDN | | | | | | | | +| (m+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.131-1: SMF Set ID** + +FQDN encoding shall be identical to the encoding of a FQDN within a DNS message of clause 3.1 of IETF RFC 1035 [27] but excluding the trailing zero byte. + +NOTE: The FQDN field in the IE is not encoded as a dotted string as commonly used in DNS master zone files. + +## 8.2.132 Quota Validity Time + +The Quota Validity Time IE type shall be encoded as shown in Figure 8.2.132-1. It contains the quota validity time in seconds. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 181 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Validity Time value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.132-1: Quota Validity Time + +The Quota Validity Time value shall be encoded as an Unsigned32 binary integer value. + +## 8.2.133 Number of Reports + +The Number of Reports IE shall be encoded as shown in Figure 8.2.133-1. It contains an Unsigned16 binary integer value excluding the first value "0". + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 182 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Number of Reports | | | | | | | | + +Figure 8.2.133-1: Number of Reports + +## 8.2.134 PFCPASRsp-Flags + +The PFCPASRsp-Flags IE indicates flags applicable to the PFCP Association Setup Response message. It is coded as depicted in Figure 8.2.134-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|----------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 184 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | UUPS
| | PSRE
| | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.134-1: PFCPASRsp-Flags + +The following bits within Octet 5 shall indicate: + +- Bit 1 – PSREI (PFCP Session Retained Indication): if this bit is set to "1", it indicates that an existing PFCP association was already established for the same Node ID and the requested PFCP sessions have been retained. See clause 6.2.6.2.2. +- Bit 2 – UUPSI (UPF configured for IPUPS Indication): if this bit is set to "1", it indicates that the UPF is configured to be used for IPUPS. See clause 5.27. +- Bit 3 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +## 8.2.135 CP PFCP Entity IP Address + +The CP PFCP Entity IP Address IE shall contain an IPv4 and/or IPv6 address. It shall be encoded as shown in Figure 8.2.135-1. + +![](09dfc56e36400ce30e66f21f777a4ad6_img.jpg) + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 135 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | V4 | V6 | +| p to (p+3) | IPv4 Address | | | | | | | | +| q to (q+15) | IPv6 Address | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.135-1: CP PFCP Entity IP Address** + +The following flags are coded within Octet 5: + +- Bit 1 – V6: If this bit is set to "1", then the IPv6 address field shall be present in the CP PFCP Entity IP Address, otherwise the IPv6 address field shall not be present. +- Bit 2 – V4: If this bit is set to "1", then the IPv4 address field shall be present in the CP PFCP Entity IP Address, otherwise the IPv4 address field shall not be present. +- Bit 3 to 8 Spare, for future use and set to "0". + +Octets "p to (p+3)" or "q to (q+15)" (IPv4 address / IPv6 address fields), if present, shall contain the address value. + +## 8.2.136 PFCPSEReq-Flags + +The PFCPSEReq-Flags IE indicates flags applicable to the PFCP Session Establishment Request message. It is coded as depicted in Figure 8.2.136-1. + +![](402dbdc2f0620d095c93e21d5296ae99_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|-------|-------|-----------|-------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 186 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | Spare | Spare | Spare | Spare | SUMP
C | RESTI | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.136-1: PFCPSEReq-Flags** + +The following bits within Octet 5 shall indicate: + +- Bit 1 – RESTI (Restoration Indication): if this bit is set to "1", it indicates to the UP function that the PFCP session to be established is to restore an existing PFCP session. +- Bit 2 – SUMPC (Stop of Usage Measurement to Pause Charging): if this bit is set to "1", it indicates that the UP function shall stop the usage measurement for all URRs with the "ASPOC" flag set to "1". + +## 8.2.137 IP Multicast Address + +The IP Multicast Address IE type shall be encoded as shown in Figure 8.2.137-1. It contains an IP multicast address or a range of IP multicast addresses. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 191 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | A | R | V4 | V6 | +| m to (m+3) | (start) IPv4 address | | | | | | | | +| p to (p+15) | (start) IPv6 address | | | | | | | | +| q to (q+3) | (end) IPv4 address | | | | | | | | +| r to (r+15) | (end) IPv6 address | | | | | | | | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.137-1: IP Multicast Address + +The following flags are coded within Octet 5: + +- Bit 1 – V6: If this bit is set to "1", then the (start) IPv6 address field shall be present, otherwise the (start) IPv6 address field shall not be present. +- Bit 2 – V4: If this bit is set to "1", then the (start) IPv4 address field shall be present, otherwise the (start) IPv4 address field shall not be present. +- Bit 3 – R (Range): If this bit is set to "1", this indicates that a range of addresses is included, i.e. that + - the (start) IPv4 address and (end) IPv4 address fields shall be present if bit 2 (V4) is set to "1"; + - the (start) IPv6 address and (end) IPv6 address fields shall be present if bit 1 (V6) is set to "1", otherwise (end) address fields shall not be present. +- Bit 4 – Any: If this bit is set to "1", this indicates any IP multicast address; in this case, no IP address field shall be included. +- Bit 5 to 8 Spare, for future use and set to "0". + +One and only one of the V6, V4 and A flags shall be set to "1". The R flag may be set if the V6 or the V4 flag is set to "1". + +Octets "m to (m+3)", "p to (p+15)", "q to (q+3)", "r to (r+15)" (IPv4 address / IPv6 address fields), if present, shall contain the address value. + +## 8.2.138 Source IP Address + +The Source IP Address IE type shall be encoded as shown in Figure 8.2.138-1 + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|-----|---|----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 192 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | MPL | | V4 | V6 | +| m to (m+3) | IPv4 address | | | | | | | | +| p to (p+15) | IPv6 address | | | | | | | | +| q | mask/prefix length | | | | | | | | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.138-1: Source IP Address + +The following flags are coded within Octet 5: + +- Bit 1 – V6: If this bit is set to "1", then the IPv6 address field shall be present, otherwise the IPv6 address field shall not be present. +- Bit 2 – V4: If this bit is set to "1", then the IPv4 address field shall be present, otherwise the IPv4 address field shall not be present. + +- Bit 3 – Mask/Prefix Length: If this bit is set to "1", then the mask (for IPv4) / prefix (for IPv6) length field shall be present, otherwise this field shall not be present. +- Bit 4 to 8 Spare, for future use and set to "0". + +Octets "m to (m+3)", "p to (p+15)" (IPv4 address / IPv6 address fields), if present, shall contain the address value. + +The mask/prefix length field, if present, shall be encoded as a 8 bits binary integer. + +EXAMPLE 1: this field encodes the value 24 for the IPv4 subnet 192.0.2.10/24. + +EXAMPLE 2: this field encodes the value 64 for the /64 IPv6 prefix. + +## 8.2.139 Packet Rate Status + +Packet Rate Status shall be encoded as shown in Figure 8.2.139-1. + +| Octets | Bits | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----|----|----|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 to 2 | Type = 193 (decimal) | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | +| 5 | Spare | | | | APR | DL | UL | | | | +| a to (a+1) | Number of Remaining Uplink Packets Allowed | | | | | | | | | | +| b to (b+1) | Number of Remaining Additional Uplink Packets Allowed | | | | | | | | | | +| c to (c+1) | Number of Remaining Downlink Packets Allowed | | | | | | | | | | +| d to (d+1) | Number of Remaining Additional Downlink Packets Allowed | | | | | | | | | | +| e to (e+7) | Rate Control Status Validity Time | | | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | + +**Figure 8.2.139-1: Packet Rate Status** + +The following flags are coded within Octet 5: + +- Bit 1 – UL (remaining uplink packet limit): If this bit is set to "1", then octets 'a' to (a+1), the Number of Remaining Uplink Packets Allowed shall be present, otherwise these octets shall not present. +- Bit 2 – DL (remaining downlink packet limit): If this bit is set to "1", then octets 'c' to (c+1), the Number of Remaining Downlink Packets Allowed shall be present, otherwise these octets shall not present. +- Bit 3 – APR (Additional Packet Rates, i.e. remaining additional packet limit): If this bit is set to "1", then the presence of Number of Remaining Additional Uplink/Downlink Packets Allowed is determined as follows: + - If bit 1 (UL) is set to "1", then octets b to (b+1), the Number of Remaining Additional Uplink Packets Allowed shall be present. Otherwise, octets b to (b+1) shall not be present; + - If bit 2 (DL) is set to "1", then octets d to (d+1), the Number of Remaining Additional Downlink Packets Allowed shall be present. Otherwise, octets d to (d+1) shall not be present. +- Bits 4 to 8: Spare, for future use and set to "0". + +If either bit 1 or bit 2 is set to '1', then octets 'e' to (e+7), the Rate Control Status Validity Time shall be present. + +If present, the Number of Remaining Uplink Packets Allowed in octets 'a' to (a+1) shall indicate the number of uplink packets that are still allowed to be sent within the Rate Control Status Validity Time. + +If present, the Number of Remaining Additional Uplink Packets Allowed in octets 'b' to (b+1) shall indicate the number of additional uplink packets that are still allowed to be sent within the Rate Control Status Validity Time. + +If present, the Number of Remaining Downlink Packets Allowed in octets 'c' to (c+1) shall indicate the number of downlink packets that are still allowed to be sent within the Rate Control Status Validity Time. + +If present, the Number of Remaining Additional Downlink Packets Allowed in octets 'd' to (d+1) indicate the number of additional downlink packets that are still allowed to be sent within the Rate Control Status Validity Time. + +If present, the Rate Control Status Validity Time shall be coded as the time in seconds relative to 00:00:00 on 1 January 1900 (calculated as continuous time without leap seconds and traceable to a common time reference) where binary encoding of the integer part is in the 32 most significant bits and binary encoding of the fraction part in the 32 least significant bits. The fraction part is expressed with a granularity of $1/2^{32}$ second (see clause 8.135 in 3GPP TS 29.274 [9]). + +## 8.2.140 Create Bridge/Router Info IE + +The Create Bridge/Router Info IE shall be encoded as shown in Figure 8.2.140-1. + +![](49940b22f9b199244563fe83653b1bac_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|-----|-----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 194 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | RII | BII | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.140-1: Create Bridge/Router Info IE** + +The following flags are coded within Octet 5: + +- Bit 1 – BII (Bridge Information Indication): If this bit is set to "1", then the Bridge Information comprising a DS-TT port number and the related 5GS User Plane Node ID are requested to be provided. +- Bit 2 – RII (Router Information Indication): If this bit is set to "1", then the Router Information comprising a port number for the PDU Session and the related 5GS User Plane Node ID are requested to be provided. +- Bit 3 to 8 Spare, for future use and set to "0". + +## 8.2.141 Port Number + +The Port Number IE shall be encoded as shown in Figure 8.2.141-1. It shall contain one Port Number value. + +![](0cfa8dfcebbb1e09ba4e0353ad037192_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 196 (decimal) | | | | | | | | +| 3 to 4 | Length = 4 | | | | | | | | +| 5 to 8 | Port Number value | | | | | | | | + +**Figure 8.2.141-1: Port Number** + +For TSN and TSCTS (i.e. if the BII flag was set to 1 in the Create Bridge/Router Info IE), the Port Number value may refer either to an Ethernet port or an IEEE PTP port and it shall be encoded as an Unsigned16 binary integer value in octets 7 and 8. Octets 5 and 6 shall be set to all zeros. + +For DetNet (i.e. if the RII flag was set to 1 in the Create Bridge/Router Info IE), the port number value shall be encoded as an Unsigned32 binary integer. + +For Ethernet type PDU Sessions, it is assumed that the PTP port number is the same as the associated Ethernet port number. + +## 8.2.142 NW-TT Port Number + +The NW-TT Port Number IE shall be encoded as shown in Figure 8.2.142-1. It shall contain one Port Number value. + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 197 (decimal) | | | | | | | | +| 3 to 4 | Length = 4 | | | | | | | | +| 5 to 8 | Port Number value | | | | | | | | + +Figure 8.2.142-1: NW-TT Port Number + +For TSN and TSCTS (i.e. if the BII flag was set to 1 in the Create Bridge/Router Info IE), the Port Number value may refer either to an Ethernet port or an IEEE PTP port and it shall be encoded as an Unsigned16 binary integer in octets 7 and 8. Octets 5 and 6 shall be set to all zeros. + +For DetNet (i.e. if the RII flag was set to 1 in the Create Bridge/Router Info IE), the port number value shall be encoded as an Unsigned32 binary integer. + +For Ethernet type PDU Sessions, it is assumed that the PTP port number is the same as the associated Ethernet port number. + +## 8.2.143 5GS User Plane Node ID + +The 5GS User Plane Node ID IE shall be encoded as shown in Figure 8.2.143-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 198 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | BID | +| m to (m+7) | User Plane Node ID value | | | | | | | | +| s to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.143-1: 5GS User Plane Node ID + +The following flags are coded within Octet 5: + +- Bit 1 – BID: If this bit is set to "1", then the User Plane Node ID value field shall be present. +- Bit 2 to 8: Spare, for future use and set to "0". + +The User Plane Node ID value field shall be encoded as an Unsigned64 binary integer. To support IEEE TSN, the User Plane Node ID value field encodes the Bridge ID as defined in IEEE 802.1Q [30] clause 14.2.5. Without IEEE TSN, the User Plane Node ID may encode any value within the range, e.g. to support integration with IETF DetNet, the User Plane Node ID value field may be encoded as the Router ID. + +## 8.2.144 Port Management Information Container + +The Port Management Information Container IE shall be encoded as shown in Figure 8.2.144-1. It contains an opaque container of port management information. + +| Octets | Bits | | | | | | | | +|------------|-----------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 202 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Port Management Information | | | | | | | | + +Figure 8.2.144-1: Port Management Information Container + +The Port Management Information field shall be encoded as an Octet String. It shall encode a Port management message defined in clause 8 of 3GPP TS 24.539 [63]. + +## 8.2.145 Requested Clock Drift Information + +The Requested Clock Drift Information IE shall be encoded as shown in Figure 8.2.145-1. It indicates the clock drift information to report to the CP function. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|----------|----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 204 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | RRC
R | RRC
R | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.145-1: Requested Clock Drift Information** + +Octet 5 shall be encoded as follows: + +- Bit 1: (RRCR) Request to Report Time Offset: when set to "1", this indicates a request to report when the Time Offset Reporting Threshold is exceeded. +- Bit 2: (RRCR) Request to Report Cumulative RateRatio: when set to "1", this indicates a request to report when the cumulative RateRatio Reporting Thresholds is exceeded. +- Bits 3 to 8: Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +## 8.2.146 Time Domain Number + +The Time Domain Number IE type shall be encoded as shown in Figure 8.2.146-1. It shall contain a external timing related Domain Number. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 206 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Time Domain Number value | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.146-1: Time Domain Number** + +The Time Domain Number value field shall be encoded as a binary integer value. + +## 8.2.147 Time Offset Threshold + +The Time Offset Threshold IE type shall be encoded as shown in Figure 8.2.147-1. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 207 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 12 | Time Offset Threshold | | | | | | | | +| 13 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.147-1: Time Offset Threshold** + +The Time Offset Threshold field shall be encoded as a signed64 binary integer value. It shall contain the Time Offset Threshold in nanoseconds. + +## 8.2.148 Cumulative rateRatio Threshold + +The Cumulative rateRatio Threshold IE type shall be encoded as shown in Figure 8.2.148-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 208 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Cumulative rateRatio Threshold | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.148-1: Cumulative rateRatio Threshold** + +The Cumulative rateRatio Threshold field shall be encoded as the cumulativeRateRatio (Integer32) specified in clauses 14.4.2 and 15.6 of IEEE Std 802.1AS-2020 [58], i.e. the quantity $(\text{rateRatio} - 1.0)(2^{41})$ . + +## 8.2.149 Time Offset Measurement + +The Time Offset Measurement IE type shall be encoded as shown in Figure 8.2.149-1. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 209 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 12 | Time Offset Measurement | | | | | | | | +| 13 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.149-1: Time Offset Measurement** + +The Time Offset Measurement field shall be encoded as a signed64 binary integer value. It shall contain the Time Offset Measurement in nanoseconds. It shall contain the time offset between the 5GS clock and the clock of the external time domain. + +## 8.2.150 Cumulative rateRatio Measurement + +The Cumulative rateRatio Measurement IE type shall be encoded as shown in Figure 8.2.150-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 210 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Cumulative rateRatio Measurement | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.150-1: Cumulative rateRatio Measurement** + +The Cumulative rateRatio Measurement field shall be encoded as the cumulativeRateRatio (Integer32) specified in clauses 14.4.2 and 15.6 of IEEE Std 802.1AS-2020 [58], i.e. the quantity $(\text{rateRatio} - 1.0)(2^{41})$ . It shall be equal to the cumulative ratio of the frequency of the 5GS clock to the frequency of the clock of the external time domain. + +## 8.2.151 SRR ID + +The SRR ID IE type shall be encoded as shown in Figure 8.2.151-1. It contains a Session Reporting Rule ID. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 215 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | SRR ID value | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.151-1: SRR ID + +The SRR ID value shall be encoded as a binary integer value. + +## 8.2.152 Requested Access Availability Information + +The Requested Access Availability Information IE shall be encoded as shown in Figure 8.2.152-1. It indicates the access availability information requested to be reported to the CP function. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 217 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | RRCA | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.152-1: Requested Access Availability Information + +Octet 5 shall be encoded as follows: + +- Bit 1: (RRCA) Request to Report Change in Access availability: when set to "1", this indicates a request to the UPF to report when an access (3GPP or non-3GPP access) becomes available or unavailable. +- Bits 2 to 8: Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +## 8.2.153 Access Availability Information + +The Access Availability Information IE shall indicate an access type and whether the access type has become available or not available. It shall be encoded as shown in Figure 8.2.153-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---------------------|---|-------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 219 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Availability Status | | Access Type | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.153-1: Access Availability Information + +The Access Type shall be encoded as a 2 bits binary integer as specified in Table 8.2.153-1. + +Table 8.2.153-1: Access Type + +| Access Type | Values (Decimal) | +|----------------------|------------------| +| 3GPP access type | 0 | +| Non-3GPP access type | 1 | +| Spare | 2 to 3 | + +The Availability Status shall be encoded as a 2 bits binary integer as specified in Table 8.2.153-2. + +**Table 8.2.153-2: Availability Status** + +| Availability Status | Values (Decimal) | +|-------------------------------|------------------| +| Access has become unavailable | 0 | +| Access has become available | 1 | +| Spare | 2 to 3 | + +## 8.2.154 MPTCP Control Information + +The MPTCP Control Information IE shall provide details of the required MPTCP functionality. It shall be encoded as shown in Figure 8.2.154-1. + +![](15142e678003c56ade1fe2a4f3f5a7a2_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 222 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | TCI | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.154-1: MPTCP Control Information** + +The following flags are coded within Octet 5: + +- Bit 1 – TCI (Transport Converter Indication): If this bit is set to "1", it indicates that the required MPTCP steering functionality is of type Transport Converter (see IETF RFC 8803 [60]) and the UPF shall allocate relevant resource as specified in clause 5.20.2.1. +- Bit 2 to 8 Spare, for future use and set to "0". + +## 8.2.155 ATSSS-LL Control Information + +The ATSSS-LL Control Information IE shall provide details of the required ATSSS-LL functionality. It shall be encoded as shown in Figure 8.2.155-1. + +![](f62ba37363dd9dcfdaeea93164bc21b9_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 223 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | LLI | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.155-1: ATSSS-LL Control Information** + +The following flags are coded within Octet 5: + +- Bit 1 – LLI: If this bit is set to "1", it indicates that the ATSSS-LL steering functionality is required. +- Bit 2 to 8 Spare, for future use and set to "0". + +## 8.2.156 PMF Control Information + +The PMF Control Information IE shall provide details of the required PMF functionality. It shall be encoded as shown in Figure 8.2.156-1. + +| Octets | Bits | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|------|-------|------|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 to 2 | Type = 224 (decimal) | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | +| 5 | Spare | | | | PQPM | DRTTI | PMFI | | | | +| 6 | Number of QFI (=p) | | | | | | | | | | +| 7 | value of QFI 1 | | | | | | | | | | +| 8 | value of QFI 2 | | | | | | | | | | +| ... | ... | | | | | | | | | | +| 7-(7+p-1) | value of QFI p | | | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | + +Figure 8.2.156-1: PMF Control Information + +The following flags are coded within Octet 5: + +- Bit 1 – PMFI: If this bit is set to "1", it indicates that the PMF functionality is required and the UPF shall allocate relevant resource as specified in 5.20.3.1. +- Bit 2 – DRTTI (Disallow PMF RTT Indication): If this bit is set to "1", it indicates that PMF RTT measurements are not allowed. This bit shall be set to "1" if the UE does not support PMF RTT measurements (i.e. if the UE supports MPTCP with any steering mode and ATSSS-LL with only the Active-Standby steering mode, see clauses 5.32.2 and 5.32.5.1 of 3GPP TS 23.501 [28]). +- Bit 3 – PQPM (Per QoS flow Performance Measurement indication): If this bit is set to "1", it indicates that per QoS flow access performance measurement is applicable to this PDU session. A list of QFI values shall be present to indicate a list of QoS flows over which access performance measurement may be performed. +- Bit 4 to 8 Spare, for future use and set to "0". + +The Number of QFI shall indicate the total number of the QFI values. Each subsequent Octet after the Number of QFI shall carry one QFI value (i.e. the Octet 5 of the QFI IE, as specified in clause 8.2.89). + +## 8.2.157 MPTCP Address Information + +The MPTCP Address Information IE shall carry the address information of MPTCP proxy in the UPF. It shall be encoded as shown in Figure 8.2.157-1. + +| Octets | Bits | | | | | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|----|---|----|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 to 2 | Type = 228 (decimal) | | | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | | | +| 5 | Spare | | | | V6 | | V4 | | | | | | +| 6 | MPTCP Proxy Type | | | | | | | | | | | | +| 7 to 8 | MPTCP Proxy Port | | | | | | | | | | | | +| p to (p+3) | MPTCP Proxy IPv4 Address | | | | | | | | | | | | +| q to (q+15) | MPTCP Proxy IPv6 Address | | | | | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.2.157-1: MPTCP Address Information + +The following flags are coded within Octet 5: + +- Bit 1 – V4: If this bit is set to "1", then the MPTCP Proxy IPv4 Address field shall be present in the MPTCP Address Information IE. +- Bit 1 – V6: If this bit is set to "1", then the MPTCP IPv6 Address field shall be present in the MPTCP Address Information IE. +- Bit 3 to 8 Spare, for future use and set to "0". + +Octets 6 shall indicate the MPTCP Proxy Type, with the value specified in clause 6.1.4 of 3GPP TS 24.193 [59]. + +Octets 7 to 8 shall indicate the allocated TCP port number of the MPTCP Proxy. + +Octets "p to (p+3)" or "q to (q+15)" (IPv4 address / IPv6 address fields), if present, shall contain the address value. + +## 8.2.158 Link-Specific Multipath IP Address + +The Link-Specific Multipath IP Address IE shall carry link-specific IP address used for MPTCP or MPQUIC steering function. It shall be encoded as shown in Figure 8.2.158-1. + +![](8b6f7b51bc160aa80e286e818baa7998_img.jpg) + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|-----|-----|----|----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 229 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | NV6 | NV4 | V6 | V4 | | +| p to (p+3) | Link-Specific Multipath IPv4 Address for 3GPP Access | | | | | | | | +| q to (q+15) | Link-Specific Multipath IPv6 Address for 3GPP Access | | | | | | | | +| r to (r+3) | Link-Specific Multipath IPv4 Address for Non-3GPP Access | | | | | | | | +| s to (s+3) | Link-Specific Multipath IPv6 Address for Non-3GPP Access | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.158-1: Link-Specific Multipath IP Address** + +The following flags are coded within Octet 5: + +- Bit 1 – V4: If this bit is set to "1", then the Link-Specific Multipath IPv4 Address for 3GPP Access shall be present in the Link-Specific Multipath IP Address IE. +- Bit 2 – V6: If this bit is set to "1", then the Link-Specific Multipath IPv6 Address for 3GPP Access shall be present in the Link-Specific Multipath IP Address IE. +- Bit 3 – NV4: If this bit is set to "1", then the Link-Specific Multipath IPv4 Address for Non-3GPP Access shall be present in the Link-Specific Multipath IP Address IE. +- Bit 4 – NV6: If this bit is set to "1", then the Link-Specific Multipath IPv6 Address for Non-3GPP Access shall be present in the Link-Specific Multipath IP Address IE. +- Bit 5 to 8 Spare, for future use and set to "0". + +Octets "p to (p+3)" or "q to (q+15)" (IPv4 address / IPv6 address fields), if present, shall contain the value for Link-Specific Multipath IP Address for 3GPP access. + +Octets "r to (r+3)" or "s to (s+15)" (IPv4 address / IPv6 address fields), if present, shall contain the value for Link-Specific Multipath IP Address for Non-3GPP access. + +## 8.2.159 PMF Address Information + +The PMF Address Information IE shall contain the address information of Performance Measure Function (PMF). It shall be encoded as shown in Figure 8.2.159-1. + +| Octets | Bits | | | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|-----|----|----|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 to 2 | Type = 230 (decimal) | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | +| 5 | Spare | | | | MAC | V6 | V4 | | | | +| p to (p+3) | PMF IPv4 Address | | | | | | | | | | +| q to (q+15) | PMF IPv6 Address | | | | | | | | | | +| r to (r+1) | PMF Port for 3GPP Access | | | | | | | | | | +| s to (s+1) | PMF Port for Non-3GPP Access | | | | | | | | | | +| t to (t+5) | PMF MAC Address for 3GPP Access | | | | | | | | | | +| u to (u+5) | PMF MAC Address for Non-3GPP Access | | | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | + +**Figure 8.2.159-1: PMF Addresses Information** + +The following flags are coded within Octet 5: + +- Bit 1 – V4: If this bit is set to "1", it indicates the PMF IPv4 Address field shall be present in the PMF Address Information IE, together with: PMF Port for 3GPP Access, PMF Port for Non-3GPP Access. +- Bit 2 – V6: If this bit is set to "1", it indicates the PMF IPv6 Address field shall be present in the PMF Address Information IE, together with: PMF Port for 3GPP Access, PMF Port for Non-3GPP Access. +- Bit 3 – MAC: If this bit is set to "1", it indicates the PMF MAC Address for 3GPP Access, PMF MAC Address for Non-3GPP Access field shall be present in the PMF Address Information IE. +- Bit 4 to 8 Spare, for future use and set to "0". + +Octets "p to (p+3)" or "q to (q+15)" (IPv4 address / IPv6 address fields), if present, shall contain the value for PMF IP Address. + +Octets "r to (r+1)" shall carry the allocated UDP port number associated with the 3GPP access network, for IP PDU session. + +Octets "s to (s+1)" shall carry the allocated UDP port number associated with the Non-3GPP access network, for IP PDU session. + +Octets "t to (t+5)" shall carry the allocated PMF MAC address for 3GPP access, for Ethernet PDU session. + +Octets "u to (u+5)" shall carry the allocated PMF MAC address for Non-3GPP access, for Ethernet PDU session. + +## 8.2.160 ATSSS-LL Information + +The ATSSS-LL Information IE shall contain ATSSS-LL information. It shall be encoded as shown in Figure 8.2.160-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 231 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | LLI | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.160-1: ATSSS-LL Information** + +The following flags are coded within Octet 5: + +- Bit 1 – LLI: If this bit is set to "1", it indicates that resources for the ATSSS-LL steering functionality have been allocated. +- Bit 2 to 8 Spare, for future use and set to "0". + +## 8.2.161 Data Network Access Identifier + +The Data Network Access Identifier IE type shall be encoded as shown in Figure 8.2.161-1. It contains an identifier of a Data Network Access. + +| Octets | Bits | | | | | | | | +|------------|--------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 232 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Data Network Access Identifier | | | | | | | | + +**Figure 8.2.161-1: Data Network Access Identifier** + +The Data Network Access Identifier field shall be encoded as an OctetString. + +## 8.2.162 Average Packet Delay + +The Average Packet Delay IE indicates the average packet delay experienced by user plane packets on a GTP-U path. It shall be coded as depicted in Figure 8.2.162-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 234 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Delay Value in milliseconds | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.162-1: Average Packet Delay** + +The Delay Value shall be encoded as an Unsigned 32 binary integer value, in milliseconds. + +## 8.2.163 Minimum Packet Delay + +The Minimum Packet Delay IE indicates the minimum packet delay experienced by user plane packets on a GTP-U path. It shall be coded as depicted in Figure 8.2.163-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 235 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Delay Value in milliseconds | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.163-1: Minimum Packet Delay** + +The Delay Value shall be encoded as an Unsigned 32 binary integer value, in milliseconds. + +## 8.2.164 Maximum Packet Delay + +The Maximum Packet Delay IE indicates the maximum packet delay experienced by user plane packets on a GTP-U path. It shall be coded as depicted in Figure 8.2.164-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 236 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Delay Value in milliseconds | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.164-1: Maximum Packet Delay + +The Delay Value shall be encoded as an Unsigned 32 binary integer value, in milliseconds. + +## 8.2.165 QoS Report Trigger + +The QoS Report Trigger IE shall be encoded as shown in Figure 8.2.165-1. It indicates the trigger of the QoS report. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----|-----|-----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 237 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | IRE | THR | PER | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.165-1: QoS Report Trigger + +Octet 5 shall be encoded as follows: + +- Bit 1 – PER (Periodic Reporting): when set to "1", this indicates a periodic report. +- Bit 2 – THR (Event triggered based on Threshold): when set to "1", this indicates a report caused by QoS exceeding a threshold. +- Bit 3 – IRE (Immediate Report): when set to "1", this indicates an immediate report requested by CP function. +- Bit 4 to 8: Spare, for future use and set to "0". + +## 8.2.166 GTP-U Path Interface Type + +The GTP-U Path Interface Type IE shall be encoded as shown in Figure 8.2.166-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----|---|----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 241 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | N3 | | N9 | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.166-1: GTP-U Path Interface Type + +Octet 5 shall be encoded as follows: + +- Bit 1 – N9: when set to "1", this indicates the N9 interface type. +- Bit 2 – N3: when set to "1", this indicates the N3 interface type. +- Bit 3 to 8: Spare, for future use and set to "0". + +## 8.2.167 Requested QoS Monitoring + +The Requested QoS Monitoring IE shall be encoded as shown in Figure 8.2.167-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|------|------|------|------------|------|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 243 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | ULDR | DLDR | ULCI | DLCI | GTPU
PM | RPPD | ULPD | DLPD | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.167-1: Requested Qos Monitoring** + +Octet 5 shall be encoded as follows: + +- Bit 1 – DLPD (Downlink Packet Delay): when set to "1", this indicates a request for measuring the downlink packet delay from the UPF (PSA) to the UE. +- Bit 2 – ULPD (Uplink Packet Delay): when set to "1", this indicates a request for measuring the uplink packet delay from the UE to the UPF (PSA). +- Bit 3 – RPPD (Round Trip Packet Delay): when set to "1", this indicates a request for measuring the round trip packet delay between the UPF (PSA) and UE. +- Bit 4 – GTPUPM (GTP-U Path Monitoring): + - when set to "1", this indicates that the Downlink, Uplink or Round Trip delay shall be measured by using GTP-U path monitoring, i.e. by the I-UPF reporting the one-way end to end accumulated transport delay in UL GTP-U packets towards the PSA; see clause 5.33.3.3 of 3GPP TS 23.501 [28]; + - when set to "0", this indicates that the Downlink, Uplink or Round Trip delay shall be measured by using RAN and UPF time information in GTP-U packets; see clause 5.33.3.2 of 3GPP TS 23.501 [28]. +- Bit 5 – DLCI (Downlink Congestion Information): when set to "1", this indicates a request for monitoring the congestion information of the QoS flow for the downlink direction received from the NG-RAN. +- Bit 6 – ULCI (Uplink Congestion Information): when set to "1", this indicates a request for monitoring the congestion information of the QoS flow for the uplink direction received from the NG-RAN. +- Bit 7 – DLDR (Downlink Data Rate): when set to "1", this indicates a request for monitoring the data rate of the QoS flow for the downlink direction. +- Bit 8 – ULDR (Uplink Data Rate): when set to "1", this indicates a request for monitoring the data rate of the QoS flow for the uplink direction. + +At least one bit shall be set to "1". Several bits may be set to "1". + +## 8.2.168 Reporting Frequency + +The Reporting Frequency IE shall be encoded as shown in Figure 8.2.168-1. It indicates the type of requested QoS Monitoring reports. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|--------------|-----------|-------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 244 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Reser
ved | PERI
O | EVETT | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.169-1: Reporting Frequency** + +Octet 5 shall be encoded as follows: + +- Bit 1 – EVETT (Event Triggered QoS monitoring reporting): when set to "1", this indicates the delay for QoS monitoring is reported when the delay exceeds a threshold. + +- Bit 2 – PERIO (Periodic QoS monitoring reporting): when set to "1", this indicates the delay for QoS monitoring is reported periodically. +- Bit 3: Reserved. It shall be set to "0" by the sender and it shall be ignored by the receiver. + +NOTE: Bit 3 was allocated in earlier versions of the specification but its usage has been deprecated. + +- Bits 4 to 8: Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +## 8.2.169 Packet Delay Thresholds + +The Packet Delay Thresholds IE contains a packet delay thresholds in milliseconds to be monitored by the UP function. It shall be encoded as shown in Figure 8.2.169-1. + +| Octets | Bits | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----|----|----|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 to 2 | Type = 245 (decimal) | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | +| 5 | Spare | | | | RP | UL | DL | | | | +| m to (m+3) | Downlink packet delay threshold | | | | | | | | | | +| p to (p+3) | Uplink packet delay threshold | | | | | | | | | | +| q to (q+3) | Round trip packet delay threshold | | | | | | | | | | +| s to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | + +**Figure 8.2.169-1: Packet Delay Thresholds** + +The following flags are coded within Octet 5: + +- Bit 1 – DL: If this bit is set to "1", then the Downlink packet delay threshold field shall be present, otherwise the Downlink packet delay threshold field shall not be present. +- Bit 2 – UL: If this bit is set to "1", then the Uplink packet delay threshold field shall be present, otherwise the Uplink packet delay threshold field shall not be present. +- Bit 3 – RP: If this bit is set to "1", then the Round trip packet delay threshold field shall be present, otherwise the Round trip packet delay threshold field shall not be present. +- Bit 4 to 8: Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +The Downlink packet delay threshold, Uplink packet delay threshold and Round trip packet delay threshold fields shall be encoded as an Unsigned32 binary integer value. They shall contain the downlink, uplink or round trip packet delay in milliseconds respectively. + +## 8.2.170 Minimum Wait Time + +The Minimum Wait Time IE contains the minimum waiting time between two consecutive reports for event triggered QoS monitoring reporting. It shall be encoded as shown in Figure 8.2.170-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 246 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | Minimum Wait Time | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.170-1: Minimum Wait Time** + +The Minimum Wait Time field shall be encoded as an Unsigned32 binary integer value. It shall contain the duration in seconds. + +## 8.2.171 QoS Monitoring Measurement + +The QoS Monitoring Measurement IE contains the QoS measurements from the UP function. It shall be encoded as shown in Figure 8.2.171-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|------|------|------|------|------|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 248 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | ULDR | DLDR | ULCI | DLCI | PLMF | RPPD | ULPD | DLPD | +| m to (m+3) | Downlink packet delay | | | | | | | | +| p to (p+3) | Uplink packet delay | | | | | | | | +| q to (q+3) | Round trip packet delay | | | | | | | | +| r | Downlink Congestion information | | | | | | | | +| s | Uplink Congestion information | | | | | | | | +| t to (t+4) | Average downlink data rate | | | | | | | | +| u to (u+4) | Average uplink data rate | | | | | | | | +| v to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.171-1: QoS Monitoring Measurement** + +The following flags are coded within Octet 5: + +- Bit 1 – DLPD (Downlink Packet Delay): If this bit is set to "1", then the Downlink packet delay field shall be present, otherwise the Downlink packet delay field shall not be present. +- Bit 2 – ULPD (Uplink Packet Delay): If this bit is set to "1", then the Uplink packet delay field shall be present, otherwise the Uplink packet delay field shall not be present. +- Bit 3 – RPPD (Round Trip Packet Delay): If this bit is set to "1", then the Round trip packet delay field shall be present, otherwise the Round trip packet delay field shall not be present. +- Bit 4 – PLMF (Packet Delay Measurement Failure): If this bit is set to "1", this indicates no timestamp is received in uplink packet for a delay exceeding the Measurement Period. +- Bit 5 – DLCI (Downlink Congestion Info): If this bit is set to "1", then the Downlink Congestion information field shall be present, otherwise the Downlink Congestion information field shall not be present. +- Bit 6 – ULCI (Uplink Congestion Info): If this bit is set to "1", then the Uplink Congestion information field shall be present, otherwise the Uplink Congestion information field shall not be present. +- Bit 7 – DLDR (Downlink Data Rate): If this bit is set to "1", then the Average downlink data rate field shall be present, otherwise it shall not be present. +- Bit 8 – ULDR (Uplink Data Rate): If this bit is set to "1", then the Average uplink data rate field shall be present, otherwise it shall not be present. + +At least one bit shall be set to "1". Several bits may be set to "1". + +When the PLMF flag is set to "1", the RP, UL and DL bits shall not be set to "1", i.e. the DL/UL/Round Trip packet delay fields shall not be present when reporting a packet delay measurement failure. + +The Downlink packet delay, Uplink packet delay and Round trip packet delay fields shall be encoded as an Unsigned32 binary integer value. They shall contain the downlink, uplink or round trip packet delay in milliseconds respectively. + +The Average downlink data rate and the Average uplink data rate fields shall be encoded as kilobits per second (1 kbps = 1000 bps) in binary value (rounded upwards). + +**Editor's note: The encoding of the Downlink Congestion Information and Uplink Congestion Information fields is FFS.** + +## 8.2.172 MT-EDT Control Information + +MT-EDT Control Information is coded as depicted in Figure 8.2.172-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 249 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | RDSI | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.172-1: MT-EDT Control Information** + +The following flags are coded within Octet 5: + +- Bit 1 – RDSI (Reporting DL data packets Size Indication): This bit shall be set to "1" if the UP function is requested to report the sum of DL data packets size. +- Bit 2 to 8 are spare and reserved for future use. + +## 8.2.173 DL Data Packets Size + +The DL Data Packets Size IE type shall be encoded as shown in Figure 8.2.173-1. It contains the sum of DL data packets size in byte which triggers to send Downlink Data Report. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 250 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | DL Data Packets Size | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.173-1: DL Data Packets Size** + +The DL Data Packets Size shall be encoded as an Unsigned16 binary integer value. + +## 8.2.174 QER Control Indications + +The QER Control Indications IE indicates flags applicable to a QER. It is coded as depicted in Figure 8.2.174-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|-------|-------|-------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 251 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | Spare | Spare | Spare | Spare | Spare | RCSR | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.174-1: QER Control Indications** + +The following bits within Octet 5 shall indicate: + +- Bit 1 – RCSR (Rate Control Status Reporting): If this bit is set to "1", then the UP function shall report the rate control status when the PFCP session is released. If this bit is set to "0", then the UPF shall not report the rate control status (see clause 5.4.15). +- Bit 2 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +## 8.2.175 NF Instance ID + +The NF Instance ID IE type shall be encoded as shown in Figure 8.2.175-1. It contains the NF Instance ID of a UPF. + +| Octets | Bits | | | | | | | | +|---------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 253 (decimal) | | | | | | | | +| 3 to 4 | Length = 16 | | | | | | | | +| 5 to 20 | NF Instance ID | | | | | | | | + +**Figure 8.2.175-1: NF Instance ID** + +The format of the NF Instance ID field shall be a Universally Unique Identifier (UUID) version 4, as specified in IETF RFC 4122 [75]. + +## 8.2.176 S-NSSAI + +The S-NSSAI IE indicates the S-NSSAI of a PDU session. It shall be encoded as shown in Figure 8.2.176-1. + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 257 (decimal) | | | | | | | | +| 3 to 4 | Length = 4 | | | | | | | | +| 5 | SST | | | | | | | | +| 6 to 8 | SD | | | | | | | | + +**Figure 8.2.176-1: S-NSSAI** + +The SST (Slice/Service Type) and SD (Slice Differentiator) fields shall be encoded as defined in clause 28.4.2 of 3GPP TS 23.003 [2]. + +## 8.2.177 IP version + +IP version shall be encoded as shown in Figure 8.2.177-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----|---|----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 258 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | V6 | | V4 | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.177-1: IP version** + +The following flags are coded within Octet 5: + +- Bit 1 – V4: when set to "1", this indicate the IP version is V4; +- Bit 2 – V6: when set to "1", this indicate the IP version is V6; +- Bit 3 to 8: Spare, for future use and set to "0". + +At least one of V4 and V6 shall be set to "1", and both may be set to "1". + +## 8.2.178 PFCPASReq-Flags + +The PFCPASReq-Flags IE indicates flags applicable to the PFCP Association Setup Request message. It is coded as depicted in Figure 8.2.178-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|-----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 259 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | UUPS
I | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.178: PFCPASReq-Flags** + +The following bits within Octet 5 shall indicate: + +- Bit 1 – UUPSI (UPF configured for IPUPS Indication): if this bit is set to "1", it indicates that the UPF is configured to be used for IPUPS. See clause 5.27. +- Bit 2 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +## 8.2.179 Data Status + +The Data Status IE indicates the status of the data packets in the UP function. It is coded as shown in Figure 8.2.179-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 260 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | BUFF | DROP | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.179-1: Data Status** + +The following flags are coded within Octet 5: + +- Bit 1 – DROP: when set to "1", this indicates first DL packet is discarded by the UP function. +- Bit 2 – BUFF: when set to "1", this indicates first DL packet is received and buffered by the UP function. +- Bit 3 to 8 Spare, for future use and set to "0". + +## 8.2.180 RDS Configuration Information + +The RDS Configuration Information IE shall provide details of the RDS Configuration Information. It shall be encoded as shown in Figure 8.2.180-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 262 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | RDS | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.180-1: RDS Configuration Information** + +The following flags are coded within Octet 5: + +- Bit 1 – RDS (Reliable Data Service): If this bit is set to "1", it indicates that the RDS is requested to be applied (in request) / applied (in response). +- Bit 2 to 8 Spare, for future use and set to "0". + +## 8.2.181 Multipath Applicable Indication + +Multipath Applicable Indication shall be coded as depicted in Figure 8.2.181-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|------|---|------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 265 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | MQAI | | MTAI | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.181-1: Multipath Applicable Indication** + +The following flags are coded within Octet 5: + +- Bit 1 – MTAI (MPTCP Applicable Indication): When this bit is set to "1", it indicates that the PDR is used to detect user plane traffic for which MPTCP is applicable (see clause 5.20.2.4). +- Bit 2 – MQAI (MPQUIC Applicable Indication): When this bit is set to "1", it indicates that the PDR is used to detect user plane traffic for which MPQUIC is applicable (see clause 5.20.2A.4). +- Bit 3 to 8 are spare and reserved for future use. + +## 8.2.182 User Plane Node Management Information Container + +The User Plane Node Management Information Container IE shall be encoded as shown in Figure 8.2.182-1. It contains an opaque container of User Plane Nodemanagement information. + +| Octets | Bits | | | | | | | | +|------------|----------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 266 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | User Plane Node Management Information | | | | | | | | + +**Figure 8.2.182-1: User Plane NodeManagement Information Container** + +The User Plane Node Management Information field shall be encoded as an Octet String. It shall encode a User plane node management message defined in clause 9 of 3GPP TS 24.539 [63]. + +## 8.2.183 Number of UE IP Addresses + +Number of UE IP Addresses IE shall be coded as depicted in Figure 8.2.183-1. It contains an Unsigned32 binary integer value in octets "a to (a+3)" and "b to (b+3)". + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|-------|-------|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 268 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | Spare | Spare | Spare | Spare | IPv6 | IPv4 | +| a to (a+3) | Number of UE IPv4 Addresses | | | | | | | | +| b to (b+3) | Number of UE IPv6 Addresses | | | | | | | | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.183-1: Number of UE IP Addresses** + +The following flags are coded within Octet 5: + +- Bit 1 – IPv4: If this bit is set to "1", Number of UE IPv4 Addresses field shall be present. Otherwise the Number of UE IPv4 Addresses field shall not be present. + +- Bit 2 – IPv6: If this bit is set to "1", Number of UE IPv6 Addresses field shall be present. Otherwise the Number of UE IPv6 Addresses field shall not be present. + +Octets "a to (a+3)" and/or "b to (b+3)" shall be present if Bit 1 and/or Bit 2 in octet 5 is present. Otherwise, these octets shall not be present. + +## 8.2.184 Validity Timer + +Validity Timer IE shall be coded as depicted in Figure 8.2.184-1. It shall contain two octets long Unsigned16 binary integer value representing a time interval in seconds. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 269 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Validity Timer | | | | | | | | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.184-1: Validity Timer** + +## 8.2.185 Offending IE Information + +Offending IE Information shall be coded as depicted in Figure 8.2.185-1. + +| Octets | Bits | | | | | | | | +|------------|---------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 274 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Type of the offending IE | | | | | | | | +| 7 to (n+4) | Value of the offending IE | | | | | | | | + +**Figure 8.2.185-1: Offending IE Information** + +The Type of the offending IE field in octets 5 to 6 shall contain the IE type (as defined in clause 8.2.1) that caused the failure. + +The Value of the offending IE field in octets 7 to (n+4) shall contain the value of the offending IE that caused the failure. + +## 8.2.186 RAT Type + +The RAT Type IE indicates the RAT type for the PFCP Session. The RAT Type IE type shall be encoded as shown in Figure 8.2.186-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 275 | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | RAT Type | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.186-1: RAT Type IE** + +RAT Type indicates the type of RAT for the PFCP Session. It shall be encoded as defined in Table 8.2.186-1. + +**Table 8.2.186-1: RAT Type values** + +| RAT Type | Values (Decimal) | +|-----------------------|-------------------------| +| | 0 | +| UTRAN | 1 | +| GERAN | 2 | +| WLAN | 3 | +| GAN | 4 | +| HSPA Evolution | 5 | +| EUTRAN (WB-E-UTRAN) | 6 | +| Virtual | 7 | +| EUTRAN-NB-IoT | 8 | +| LTE-M | 9 | +| NR | 10 | +| NR-REDCAP | 11 | +| Spare, for future use | 12-255 | + +## 8.2.187 L2TP User Authentication + +The L2TP User Authentication IE shall be encoded as shown in Figure 8.2.187-1. + +![](d857a816663b2bb31fd8fe42b2016004_img.jpg) + +| Octets | Bits | | | | | | | | +|----------------|------------------------------------------------------------|----------|----------|----------|----------|----------|----------|----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 278 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 - 6 | Proxy Authen Type Value | | | | | | | | +| 7 | Spare | | PAI | PAR | PAC | PAN | | | +| 8 | Length of Proxy Authen Name | | | | | | | | +| 9 to a | Proxy Authen Name Value | | | | | | | | +| a+1 | Length of Proxy Authen Challenge | | | | | | | | +| (a+2) to b | Proxy Authen Challenge Value | | | | | | | | +| b+1 | Length of Proxy Authen Response | | | | | | | | +| (b+2) to c | Proxy Authen Response Value | | | | | | | | +| c+1 | Proxy Authen ID | | | | | | | | +| (c+2) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.187-1: L2TP User Authentication** + +The following flags are coded within Octet 7: + +- Bit 1 – PAN: If this bit is set to "1", then the Length of Proxy Authen Name and Proxy Authen Name Value shall be present; otherwise, the Length of Proxy Authen Name and Proxy Authen Name Value shall not be present. +- Bit 2 – PAC: If this bit is set to "1", then the Length of Proxy Authen Challenge and Proxy Authen Challenge Value shall be present; otherwise, the Length of Proxy Authen Challenge and Proxy Authen Challenge Value shall not be present. +- Bit 3 – PAR: If this bit is set to "1", then the Length of Proxy Authen Response and Proxy Authen Response Value shall be present; otherwise, the Length of Proxy Authen Response and Proxy Authen Response Value shall not be present. +- Bit 4 – PAI: If this bit is set to "1", then the Proxy Authen ID shall be present; otherwise, the Proxy Authen ID shall not be present. + +Proxy Authen Type Value, Proxy Authen Name Value, Proxy Authen Challenge Value, Proxy Authen Response Value and Proxy Authen ID shall be encoded as the Attribute Value field for the Proxy Authen Type AVP, Proxy Authen Name AVP, Proxy Authen Challenge AVP, Proxy Authen Response AVP and Proxy Authen ID respectively as specified in IETF RFC 2661 [67]. + +If Proxy Authen Type Value is 1, then the PAN and PAR flags shall be set. + +If Proxy Authen Type Value is 2, then the PAN, PAC, PAR, and PAI flags shall be set. + +If Proxy Authen Type Value is 3, then the PAN, PAR, and PAI flags shall be set. + +If Proxy Authen Type Value is 5, then the PAN, PAC, PAR, and PAI flags shall be set. + +## 8.2.188 LNS Address + +The LNS Address IE shall contain an IPv4/IPv6 address. It shall be encoded as shown in Figure 8.2.188-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 280 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to o | LNS Address value | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.188-1: LNS Address** + +If the LNS Address is an IPv4 address, the LNS Address value length shall be "4". + +If the LNS Address is an IPv6 address, the LNS Address value length shall be "16". + +## 8.2.189 Tunnel Preference + +The Tunnel Preference IE type shall be encoded as shown in Figure 8.2.189-1. It contains a Tunnel Preference value which indicates the preference to be given to the L2TP tunnel to which it refers; higher preference is given to lower values, with 0x000000 being most preferred and 0xFFFFFF least preferred (see 3GPP TS 29.061 [39]). + +| Octets | Bits | | | | | | | | +|--------|-------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 281 (decimal) | | | | | | | | +| 3 to 4 | Length = 3 | | | | | | | | +| 5 to 7 | Tunnel Preference value | | | | | | | | + +**Figure 8.2.189-1: Tunnel Preference** + +The Tunnel Preference value shall be encoded as three octets binary integer value. + +## 8.2.190 Calling Number + +The Calling Number IE type shall be encoded as shown in Figure 8.2.190-1. It contains a Calling Number value which may contain a MSISDN (see 3GPP TS 29.061 [39]). + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 282 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Calling Number value | | | | | | | | + +**Figure 8.2.190-1: Calling Number** + +The Calling Number value shall be encoded in UTF8String format. + +## 8.2.191 Called Number + +The Called Number IE type shall be encoded as shown in Figure 8.2.191-1. It contains a Called Number value which may contain a DNN/APN. (see 3GPP TS 29.061 [39]). + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 283 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Called Number value | | | | | | | | + +Figure 8.2.191-1: Called Number + +The Called Number value shall be encoded in UTF8String format. + +## 8.2.192 L2TP Session Indications + +The L2TP Session Indications IE shall be encoded as shown in Figure 8.2.192-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|-------|-----------|-----------|-----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 284 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | Spare | Spare | Spare | RENS
A | REDS
A | REUI
A | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.192-1: L2TP Session Indications + +The following bits within Octet 5 shall indicate: + +- Bit 1 – REUIA (Request UE IP Address): if this bit is set to "1", it indicates to the UP function that the UP function shall request the UE IP address from the LNS. +- Bit 2 – REDSA (Request DNS Server Address): if this bit is set to "1", it indicates to the UP function that the UP function shall request DNS Server Address from the LNS. +- Bit 3 – RENSA (Request NBNS Server Address): if this bit is set to "1", it indicates to the UP function that the UP function shall request NBNS Server Address from the LNS. +- Bit 4 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +NOTE: REDSA and RENSA are only applicable for PDN connections/PDU sessions with IPv4 address. + +## 8.2.193 DNS Server Address + +The DNS Server Address IE shall contain an IPv4 address. It shall be encoded as shown in Figure 8.2.193-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 285 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | DNS Server Address value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.193-1: DNS Server Address + +## 8.2.194 NBNS Server Address + +The NBNS Server Address IE shall contain an IPv4 address. It shall be encoded as shown in Figure 8.2.194-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 286 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 8 | NBNS Server Address value | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.194-1: NBNS Server Address + +## 8.2.195 Maximum Receive Unit + +The Maximum Receive Unit shall be encoded as shown in Figure 8.2.195-1. The Maximum Receive Unit value shall contain the link MTU size value received from the UE via the Protocol Configuration Options (see 3GPP TS 24.008 [5]). + +| Octets | Bits | | | | | | | | +|--------|----------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 287 (decimal) | | | | | | | | +| 3 to 4 | Length = 2 | | | | | | | | +| 5 to 6 | Maximum Receive Unit value | | | | | | | | + +Figure 8.2.195-1: Maximum Receive Unit + +The Maximum Receive Unit value shall be encoded as two octet's binary integer value. + +## 8.2.196 Thresholds + +The Thresholds IE shall be encoded as shown in Figure 8.2.196-1. It indicates the RTT and/or a Packet Loss Rate. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-----|---|-----|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 to 2 | Type = 288 (decimal) | | | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | | | +| 5 | Spare | | | | PLR | | RTT | | | | | | +| m to (m+1) | RTT value | | | | | | | | | | | | +| p | Packet Loss Rate value | | | | | | | | | | | | +| q to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.2.196.-1: Thresholds + +The following flags are coded within Octet 5: + +- Bit 1 – RTT: If this bit is set to "1", then the RTT value field shall be present, otherwise the RTT value shall not be present. +- Bit 2 – PLR: If this bit is set to "1", then the Packet Loss Rate value field shall be present, otherwise the Packet Loss Rate value shall not be present. +- Bit 3 to 8 Spare, for future use and set to "0". + +At least one bit shall be set to "1". Several bits may be set to "1". + +The RTT value field shall be encoded as an Unsigned16 binary integer value. It shall contain the RTT in milliseconds. + +The Packet Loss Rate value field shall indicate a percentage and may take binary coded integer values from and including 0 up to and including 100. Other values shall be considered as 0. + +## 8.2.197 Steering Mode Indicator + +The Steering Mode Indicator IE shall be encoded as shown in Figure 8.2.197-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 289 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | UEAI | ALBI | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.197.-1: Steering Mode Indicator + +The following flags are coded within Octet 5: + +- Bit 1 –ALBI (Autonomous Load Balancing Indicator): If this bit is set to "1", the autonomous load-balance is allowed. +- Bit 2 –UEAI (UE Assistance Indicator): If this bit is set to "1", the UE-assistance operation is allowed. +- Bit 3 to 8 Spare, for future use and set to "0". + +The ALBI and UEAI shall not be set to "1" at the same time. + +## 8.2.198 Group Id + +The Group Id IE type shall be encoded as shown in Figure 8.2.198-1. It shall contain an octet string as a global unique identifier for a group and it may be encoded using the same mechanism for the NfInstanceId as specified in 3GPP TS 29.571 [61]. + +| Octets | Bits | | | | | | | | +|----------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 291 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to n+4 | Group Id | | | | | | | | + +Figure 8.2.198-1: Group Id + +## 8.2.199 CP IP Address + +The CP IP Address IE shall contain an IPv4 and/or IPv6 address. It shall be encoded as shown in Figure 8.2.199-1. + +| Octets | Bits | | | | | | | | +|-------------|----------------------|---|---|---|---|---|----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 292 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | V4 | V6 | +| p to (p+3) | IPv4 Address | | | | | | | | +| q to (q+15) | IPv6 Address | | | | | | | | + +Figure 8.2.199-1: CP IP Address + +The following flags are coded within Octet 5: + +- Bit 1 – V6: If this bit is set to "1", then the IPv6 address field shall be present in the CP IP Address, otherwise the IPv6 address field shall not be present. +- Bit 2 – V4: If this bit is set to "1", then the IPv4 address field shall be present in the CP IP Address, otherwise the IPv4 address field shall not be present. +- Bit 3 to 8 Spare, for future use and set to "0". + +Octets "p to (p+3)" or "q to (q+15)" (IPv4 address / IPv6 address fields), if present, shall contain the address value. + +## 8.2.200 IP Address and Port Number Replacement + +The IP Address and Port Number Replacement IE type shall be encoded as shown in Figure 8.2.200-1. It contains instructions to modify the contents of the (inner) packet. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|-----|-------|-------|-----|-------|-------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 293 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Spare | SPN | SIPV6 | SIPV4 | DPN | DIPV6 | DIPV4 | | +| p to (p+3) | Destination IPv4 Address | | | | | | | | +| q to (q+15) | Destination IPv6 Address | | | | | | | | +| r to (r+1) | Destination Port Number | | | | | | | | +| s to (s+3) | Source IPv4 Address | | | | | | | | +| t to (t+15) | Source IPv6 Address | | | | | | | | +| u to (u+1) | Source Port Number | | | | | | | | +| v to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.200-1: IP Address and Port Number Replacement** + +The following flags are coded within Octet 5: + +- Bit 1 – DIPV4: If this bit is set to "1", then the Destination IPv4 field shall be present, otherwise the Destination IPv4 field shall not be present. +- Bit 2 – DIPV6: If this bit is set to "1", then the Destination IPv6 field shall be present, otherwise the Destination IPv6 field shall not be present. +- Bit 3 – DPN: If this bit is set to "1", then the Destination Port Number field shall be present, otherwise the Destination Port Number field shall not be present. +- Bit 4 – SIPV4: If this bit is set to "1", then the Source IPv4 field shall be present, otherwise the Source IPv4 field shall not be present. +- Bit 5 – SIPV6: If this bit is set to "1", then the Source IPv6 field shall be present, otherwise the Source IPv6 field shall not be present. +- Bit 6 – SPN: If this bit is set to "1", then the Source Port Number field shall be present, otherwise the Source Port Number field shall not be present. +- Bit 7 to 8: Spare, for future use and set to "0". + +When present, the Destination IPv4 Address field or the Source IPv4 Address field shall contain the destination or source IPv4 address respectively to set in the IPv4 header of the outgoing packet. + +When present, the Destination IPv6 Address field or the Source IPv6 Address field shall contain the destination or source IPv6 address respectively to set in the IPv6 header of the outgoing packet. + +When present, the Destination Port Number field or the Source Port Number field shall contain the destination or source Port Number respectively to set in the UDP header of the outgoing packet. + +At least one IP address shall be present. + +## 8.2.201 DNS Query Filter + +The DNS Query Filter IE type shall be encoded as shown in Figure 8.2.201-1. It contains a DNS Query Filter. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 294 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Length of Domain Name Pattern | | | | | | | | +| 7 to p | Domain Name Pattern | | | | | | | | +| x to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.201-1: DNS Query Filter** + +The Domain Name Pattern field, in octets 7 to p, shall be encoded as Octetstring representing a JSON object defined as FqdnPatternMatchingRule data type specified in clause 5.2.4.23 of 3GPP TS 29.571 [61]. + +## 8.2.202 Event Notification URI + +The Event Notification URI IE type shall be encoded as shown in Figure 8.2.202-1. + +| Octets | Bits | | | | | | | | +|----------|------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 296 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to n+4 | Event Notification URI | | | | | | | | + +**Figure 8.2.202-1: Event Notification URI** + +The Event Notification URI field in octets 5 to (n+4) shall contain an octet string representing the Event Notification URI (i.e. string providing an URI formatted according to IETF RFC 3986 [71]) to be used for sending the UPF event notifications. + +## 8.2.203 Notification Correlation ID + +The Notification Correlation ID IE type shall be encoded as shown in Figure 8.2.203-1. + +| Octets | Bits | | | | | | | | +|----------|-----------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 297 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to n+4 | Notification Correlation ID | | | | | | | | + +**Figure 8.2.203-1: Notification Correlation ID** + +The Notification Correlation ID field in octets 5 to (n+4) shall contain an octet string representing the value of the Notification Correlation ID to be sent in UPF event notifications. + +## 8.2.204 Reporting Flags + +The Reporting Flags IE indicates flags providing additional information for direct event notification reporting. It is coded as depicted in Figure 8.2.204-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|-------|-------|-------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 298 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | Spare | Spare | Spare | Spare | Spare | DUPL | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.204-1: Reporting Flags + +The following bits within Octet 5 shall indicate: + +- Bit 1 – DUPL (Duplicated notification): if this bit is set to "1", it indicates that the UP function shall also report the event notifications over N4 (in addition to reporting them directly to the Event Notification URI). +- Bit 2 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +## 8.2.205 Predefined Rules Name + +The Predefined Rules Name IE type shall be coded as shown in Figure 8.2.205-1. It shall contain a Predefined Rules Name, referring to one or more predefined rules which are activated in the UP function. + +| Octets | Bits | | | | | | | | +|------------|-----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 299 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Predefined Rules Name | | | | | | | | + +Figure 8.2.205-1: Predefined Rules Name + +The Predefined Rules Name field shall be encoded as an OctetString. + +## 8.2.206 MBS Session Identifier + +The MBS Session Identifier is used to identify a 5G MBS Session. It contains the Temporary Mobile Group Identity as defined in 3GPP TS 23.003 [2] or a Source Specific IP multicast address which consists of two IP addresses, one is an IP unicast address used as source address in IP packets for identifying the source of the multicast service (e.g. AF/AS), the other is an IP multicast address used as destination address in related IP packets for identifying a multicast service associated with the source. + +It is coded as specified in Figure 8.2.206-1. + +| Octets | Bits | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|------|------|------|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 to 2 | Type = 305 (decimal) | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | +| 5 | Spare | | | | NIDI | SSMI | TMGI | | | | +| 6-11 | TMGI | | | | | | | | | | +| 12-m | Source Specific IP Multicast Address | | | | | | | | | | +| o to (o+5) | NID | | | | | | | | | | +| q-(n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | + +Figure 8.2.206-1: MBS Session Identifier + +The following bits within Octet 5 shall indicate: + +- Bit 1 – TMGI: if this bit is set to "1", it indicates that the TMGI field shall be present, otherwise it shall not be present; + +- Bit 2 – SSMI: if this bit is set to "1", it indicates that the Source Specific IP Multicast Address field shall be present, otherwise it shall not be present; +- Bit 3 – NIDI: if this bit is set to "1", it indicates that the Network Identifier (NID) field shall be present, otherwise it shall not be present; +- Bit 4 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +The TMGI field shall be encoded as octets 3 to octet 8 in the figure 10.5.154 of 3GPP TS 24.008 [5]. + +The Source Specific IP Multicast Address field shall be encoded the octets 10 to m of IE Multicast Transport Information as specified in 8.2.207. + +The NID field shall be encoded with 11 hexadecimal digit, bit 8 to bit 5 of the octet "o" is the most significant digit and bit 8 to bit 5 of the octet "o+5" is the least significant digit, and bits 4 to 1 of octets (o+5) shall all be encoded as 0. + +## 8.2.207 Multicast Transport Information + +The Multicast Transport Information IE contains the Low Layer Source Specific IP Multicast Address allocated by the MB-UPF. It is coded as specified in Figure 8.2.207-1. + +The IP Multicast Distribution Address and the IP Source Address fields contain the IPv4 or IPv6 address. The Address Type and Address Length fields shall be included in each field: + +- The Address Type, which is a fixed length code (of 2 bits) identifying the type of address that is used in the Address field. +- The Address Length, which is a fixed length code (of 6 bits) identifying the length of the Address field. +- The Address, which is a variable length field shall contain either an IPv4 address or an IPv6 address. + +Address Type 0 and Address Length 4 shall be used when Address is an IPv4 address. + +Address Type 1 and Address Length 16 shall be used when Address is an IPv6 address. + +Other combinations of values are not valid. + +Common Tunnel Endpoint Identifier is allocated at the source Tunnel Endpoint and signalled to the destination Tunnel Endpoint. There is one Common Tunnel Endpoint Identifier allocated per MBS session. + +| Octets | Bits | | | | | | | | | | | | | | | +|------------|------------------------------------------------------------|----------------|---|---|---|---|---|---|--|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | +| 1 to 2 | Type = 306 (decimal) | | | | | | | | | | | | | | | +| 3 to 4 | Length=n | | | | | | | | | | | | | | | +| 5 | Spare | | | | | | | | | | | | | | | +| 6 to 9 | Common Tunnel Endpoint Identifier | | | | | | | | | | | | | | | +| 10 | Address Type | Address Length | | | | | | | | | | | | | | +| 11 to K | IP Multicast Distribution Address (IPv4 or IPv6) | | | | | | | | | | | | | | | +| K+1 | Address Type | Address Length | | | | | | | | | | | | | | +| (k+2) to m | IP Source Address (IPv4 or IPv6) | | | | | | | | | | | | | | | +| (m+1) to n | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | | | | + +**Figure 8.2.207-1: Multicast Transport Information** + +## 8.2.208 MBSN4mbReq-Flags + +The MBSN4mbReq-Flags IE indicates flags applicable to the PFCP Session Establishment Request. It is coded as depicted in Figure 8.2.208-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|--------------|------------|------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 307 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | MBS
RESTI | JMBS
SM | PLLS
SM | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.208-1: MBSN4mbReq-Flags** + +The following bits within Octet 5 shall indicate: + +- Bit 1 – PLLSSM (Provide Lower Layer SSM): if this bit is set to "1", it indicates that the MB-UPF shall allocate a lower layer SSM (i.e. multicast destination address and related source IP address) and a GTP-U Common Tunnel EndPoint Identifier (C-TEID) in the Multicast Transport Address IE. See clause 5.34.2.2. +- Bit 2 – JMBSSM (Join MBS Session SSM): if this bit is set to "1", it indicates that the MB-UPF shall join the multicast tree towards the Source Specific Multicast (SSM) address information provided by AF/AS or MBSTF for the MBS Session. +- Bit 3 – MBS RESTI (MBS Restoration Indication): if this bit is set to "1", it indicates to the MB-UPF that the PFCP session to be established is to restore an existing PFCP session of an MBS session. +- Bit 4 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +## 8.2.209 Local Ingress Tunnel + +The Local Ingress Tunnel IE type shall be encoded as shown in Figure 8.2.209-1. It indicates a UDP/IP tunnel. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|----|----|----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 308 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | CH | V6 | V4 | | +| 6-7 | UDP Port | | | | | | | | +| m to (m+3) | IPv4 address | | | | | | | | +| p to (p+15) | IPv6 address | | | | | | | | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.209-1: Local Ingress Tunnel** + +The following flags are coded within Octet 5: + +- Bit 1 – V4: If this bit is set to "1" and the CH bit is not set, then the IPv4 address field shall be present, otherwise the IPv4 address field shall not be present. +- Bit 2 – V6: If this bit is set to "1" and the CH bit is not set, then the IPv6 address field shall be present, otherwise the IPv6 address field shall not be present. +- Bit 3 – CH (CHOOSE): If this bit is set to "1", then the UDP Port, IPv4 address and IPv6 address fields shall not be present and the UP function shall assign a UDP Port with either an IP4 or an IPv6 address, depending on whether the CP function has set the V4 or the V6 bit, respectively. This bit shall only be set by the CP function. +- Bit 4 to 8: Spare, for future use and set to "0". + +Only one of the V4 and V6 flags shall be set to "1". + +Octets "m to (m+3)" and/or "p to (p+15)" (IPv4 address / IPv6 address fields), if present, it shall contain the respective IP address values. + +## 8.2.210 MBS Unicast Parameters ID + +The MBS Unicast Parameters ID IE type shall be encoded as shown in Figure 8.2.210-1. It shall contain a MBS Unicast Parameters ID. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 309 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | MBS Unicast Parameters ID value | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.210-1: MBS Unicast Parameters ID + +The MBS Unicast Parameters ID value field shall be encoded as an Unsigned16 binary integer value. + +## 8.2.211 MBSN4Resp-Flags + +The MBSN4Resp-Flags IE indicates flags applicable to the PFCP Session Establishment/Modification/Deletion Response message for a PFCP session that is associated with an MBS Session. It is coded as depicted in Figure 8.2.211-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|------------|------|------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 312 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | N19D
TR | JMTI | NN19
DT | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.211-1: MBSN4Resp-Flags + +The following bits within Octet 5 shall indicate: + +- Bit 1 – NN19DT (New N19mb Downlink Tunnel): if this bit is set to "1", it indicates that the UPF has allocated a new N19mb DL Tunnel ID for the MBS Session; +- Bit 2 – JMTI (Joined N19mb Multicast Tree Indication): if this bit is set to "1", it indicates that the UPF has joined the multicast tree from MB-UPF; +- Bit 3 – N19DTR (N19mb Downlink Tunnel Removal): if this bit is set to "1", it indicates that the UPF is going to remove the N19mb DL Tunnel for receiving the MBS session data, because the PFCP session removing the PDR is the last PFCP session which was associated with the N19mb DL Tunnel in the UPF; +- Bit 4 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +NOTE: See clause 5.34.3.2 for further description of the setting and use of the bits in the MBSN4Resp-Flags. + +## 8.2.212 Tunnel Password + +The Tunnel Password IE type shall be encoded as shown in Figure 8.2.212-1. It contains the value of Tunnel Password (in plain text) to be used for the L2TP tunnel. + +NOTE: The CP function obtains the plain text value of Tunnel Password after decoding and de-encrypting the Tunnel-Password AVP, which is received from AAA/Radius Server, as specified in clause 3.5 of IETF RFC 2868 [68]. + +| Octets | Bits | | | | | | | | +|------------|-----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 313 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | Tunnel Password value | | | | | | | | + +Figure 8.2.212-1: Tunnel Password + +The Tunnel Password value shall be encoded in UTF8String format. + +## 8.2.213 Area Session ID + +The Area Session ID together with the MBS Session Identifier uniquely identifies the service area part of the content data of a location dependent MBS service (see clause 30.3 of 3GPP TS 23.003 [2]). It shall be coded as specified in Figure 8.2.213-1. + +| Octets | Bits | | | | | | | | +|--------|-----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 314 (decimal) | | | | | | | | +| 3 to 4 | Length = 2 | | | | | | | | +| 5 to 6 | Area Session ID value | | | | | | | | + +Figure 8.2.213-1: Area Session ID + +The Area Session ID value shall be encoded as an Unsigned16 binary integer value. + +## 8.2.214 DSCP to PPI Mapping Information + +The DSCP to PPI Mapping Information IE shall be encoded as shown in Figure 8.2.214-1. It contains the mapping from DSCP(s) to a PPI. + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|--------------|---|-----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 to 2 | Type = 317 (decimal) | | | | | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | | | | | +| 5 | Spare | | | | PPI Value | | | | | | | | +| 6 | Spare | | DSCP Value 1 | | | | | | | | | | +| 7 | Spare | | DSCP Value 2 | | | | | | | | | | +| ... | Spare | | ... | | | | | | | | | | +| (5+x) | Spare | | DSCP Value x | | | | | | | | | | +| (6+x) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.2.214-1: DSCP to PPI Mapping Information + +The PPI Value in octet 5 shall be encoded as a value between 0 and 7, as specified in clause 5.5.3.7 of 3GPP TS 38.415 [34]. + +The DSCP Value 1 to x, in octet 6 to octet (5+x), where X shall not be larger than 63, shall be encoded as the DSCP in TOS (IPv4) or TC (IPv6) information (see IETF RFC 2474 [13]). + +## 8.2.215 PFCPSDRsp-Flags + +The PFCPSDRsp-Flags IE indicates flags applicable to the PFCP Session Report Response message. It is coded as depicted in Figure 8.2.215-1. + +![](e896e0bdda91f258fa9ce577d1264465_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|-------|-------|-------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 318 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | Spare | Spare | Spare | Spare | Spare | PURU | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.215-1: PFCPSDRsp-Flags + +The following bits within Octet 5 shall indicate: + +- Bit 1 – PURU (Pending Usage Reports Unacknowledged): if this bit is set to "1", it indicates that there are pending PFCP Session Report Request messages which have not been acknowledged yet. +- Bit 2 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +## 8.2.216 QER Indications + +The QER Indications IE indicates flags applicable to a QER. It shall be coded as depicted in Figure 8.2.216-1. + +![](91a2fec5de093d2a9bc345ff56794fa4_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|-----------|-----------|-----------|------------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 319 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | Spare | Spare | Spare | PDUS
M | EML4
S | EDBM
I | IQFIS
N | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.216-1: QER Indications + +The following bits within Octet 5 shall indicate: + +- Bit 1 – IQFISN (Insert DL MBS QFI SN): If this bit is set to "1", then the MB-UPF shall insert the DL MBS QFI Sequence Number in the PDU Session Container of MBS data packets (see 3GPP TS 38.415 [34]). +- Bit 2 – EDBMI (End Of Data Burst Marking Indication): If this bit is set to "1", then the UPF shall set End Of Data Burst Indication together with the QFI (identifying the QoS flow conveying the Data Burst) in the PDU Session Container of the GTP-U packet encapsulating the last PDU of each data burst (see 3GPP TS 38.415 [34]). +- Bit 3 – EML4S (ECN Marking for L4S): If this bit is set to "1", then the UPF shall perform ECN marking for L4S (see clause 5.38.1). +- Bit 4 – PDUSM (PDU Set Marking): If this bit is set to "1", then the UPF shall perform PDU Set marking (see clause 5.38.3). +- Bit 5 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +## 8.2.217 Vendor-Specific Node Report Type + +The Vendor-Specific Node Report Type IE shall be encoded as shown in Figure 8.2.217-1. It indicates the type of the Vendor-Specific node report the UP function sends to the CP function. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|-------|-------|-------|-------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 320 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to 6 | Enterprise ID | | | | | | | | +| 7 | Spare | Spare | Spare | Spare | Spare | Spare | Spare | Spare | +| 8 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.217-1: Vendor-Specific Node Report Type** + +Octet 7 (and following octets if needed) shall be encoded as a bitmask, where each bit in the bitmask shall indicate a Vendor-Specific Node Report Type. The definition and semantic of the bits in the bitmask are out of scope of 3GPP. + +Enterprise ID in octets 5 to 6 shall be encoded as defined in clause 8.1.1. The Enterprise ID may identify a Standards Development Organization. The report types indicated by octet 7 (and following octets if needed) are specific to the Standards Development Organization or enterprise identified by the Enterprise ID. + +Spare bits are for future use and shall be set to "0". + +At least one bit shall be set to "1". + +NOTE: The Vendor-Specific Node Report Type IE in the PFCP Node Report Request message can be used by non-3GPP Standards Development Organizations for interfaces relying on PFCP as the protocol for Control and User Plane Separation, for identifying the type of vendor-specific node reports not defined by 3GPP. The definition and semantic of the bits within the bitmask are to be specified by each non-3GPP Standards Development Organization (without liaising with 3GPP CT4). See clauses 5.9 and 8.1.1 for the definition and usage of Vendor Specific IEs. + +## 8.2.218 Configured Time Domain + +The Configured Time Domain IE type shall be encoded as shown in Figure 8.2.218-1. It shall contain + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 321 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | CTDI | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.218-1: Configured Time Domain** + +Octet 5 shall be encoded as follows: + +- Bit 1 (CTDI – Configured Time Domain Indicator): when set to "1", this indicates that the Time Domain Number configured to the NW-TT(s) is used. +- Bits 2 to 8: Spare, for future use and set to "0". + +## 8.2.219 Metadata + +The Metadata IE type shall be encoded as shown in Figure 8.2.219-1. It contains the Metadata which the UPF needs to apply to traffic sent over a Service Function Chain. + +| Octets | Bits | | | | | | | | +|----------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 322 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to n+4 | Metadata | | | | | | | | + +**Figure 8.2.219-1: Metadata** + +The Metadata field shall contain an octet string set to base64-encoded characters as specified in clause 5.5.2 of 3GPP TS 29.571 [61]. + +## 8.2.220 Traffic Parameter Threshold + +The N6 Jitter Threshold IE contains a N6 Jitter threshold in milliseconds. It shall be encoded as shown in Figure 8.2.220-1. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|---|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 325 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | DL | +| 6 to 9 | Downlink N6 Jitter threshold | | | | | | | | +| 10 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.220-1: Traffic Parameter Threshold** + +The following flags are coded within Octet 5: + +- Bit 1 – DL: If this bit is set to "1", then the Downlink packet N6 Jitter threshold field shall be present, otherwise the Downlink packet N6 Jitter threshold field shall not be present. +- Bit 2 to 8: Spare, for future use and set to "0". + +The Downlink N6 Jitter threshold field shall be encoded as an Unsigned32 binary integer value containing the downlink packet Jitter threshold in milliseconds. + +## 8.2.221 DL Periodicity + +The DL Periodicity IE contains a DL Periodicity in milliseconds to be used to measure N6 Jitter by the UP function. It shall be encoded as shown in Figure 8.2.221-1. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 326 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | | +| 6 to 9 | DL Periodicity | | | | | | | | +| 10 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.221-1: DL Periodicity** + +The DL Periodicity fields shall be encoded as an Unsigned32 binary integer value containing the DL Periodicity in milliseconds. + +## 8.2.222 N6 Jitter Measurement + +The N6 Jitter Measurement IE contains a N6 jitter measurement in milliseconds measured by the UP function. It shall be encoded as shown in Figure 8.2.222-1. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|---|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 327 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | DL | +| 6 to 9 | DL Periodicity | | | | | | | | +| 10 to 13 | Lower DL Jitter Measurement | | | | | | | | +| 14 to 17 | Higher DL Jitter Measurement | | | | | | | | +| 18 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.220-1: N6 Jitter Measurement** + +The following flags are coded within Octet 5: + +- Bit 1 – DL: If this bit is set to "1", then the DL Periodicity, Lower DL Jitter Measurement and Higher DL Jitter Measurement fields shall be present, otherwise the DL Periodicity, Lower DL Jitter Measurement and Higher DL Jitter Measurement fields shall not be present. +- Bit 2 to 8: Spare, for future use and set to "0". + +When present, the DL Periodicity field shall be encoded as an Unsigned32 binary integer value containing the DL Periodicity in milliseconds used for the N6 Jitter Measurement. + +When present, the Lower DL Jitter Measurement and the Higher DL Jitter Measurement fields shall indicate the downlink packet Jitter range over N6. The Lower DL Jitter Measurement and the Higher DL Jitter Measurement fields shall be encoded as a signed32 binary integer value containing the downlink packet Jitter (i.e. positive or negative deviation of the arrival time of first packet of a Data Burst compared to the ideal Data Burst start time which is determined based on the DL periodicity) measured in milliseconds. + +## 8.2.223 Traffic Parameter Measurement Indication + +The Traffic Parameter Measurement Indication IE indicates to the UPF to perform the relevant traffic parameter measurement for a QoS flow. It shall be coded as depicted in Figure 8.2.223-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-------|------|------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 328 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | N6JMI | DLPM | ULPM | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.223-1: Traffic Parameter Measurement Indication** + +The following bits within Octet 5 shall indicate: + +- Bit 1 – ULPMI (UL Periodicity Measurement Indication): If this bit is set to "1", then the UPF shall measure and report the UL Periodicity for the QoS flow as specified in clause 5.38.4. +- Bit 2 – DLPMI (DL Periodicity Measurement Indication): If this bit is set to "1", then the UPF shall measure the DL Periodicity for the QoS flow as specified in clause 5.38.4. +- Bit 3 – N6JMI (N6 Jitter Measurement Indication): If this bit is set to "1", then the UPF shall measure N6 Jitter as specified in clause 5.38.4. +- Bit 4 to 8 – Spare, for future use, shall be set to "0" by the sender and discarded by the receiver. + +## 8.2.224 UL Periodicity + +The UL Periodicity IE contains a UL Periodicity in milliseconds measured by the UP function when requested by the SMF. It shall be encoded as shown in Figure 8.2.224-1. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 329 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | | +| 6 to 9 | UL Periodicity | | | | | | | | +| 10 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.224-1: UL Periodicity + +The UL Periodicity fields shall be encoded as an Unsigned32 binary integer value containing the UL Periodicity in milliseconds. + +## 8.2.225 MPQUIC Control Information + +The MPTCP Control Information IE shall provide details of the required MPQUIC functionality. It shall be encoded as shown in Figure 8.2.a-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 330 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | CUDP | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.225-1: MPQUIC Control Information + +The following flags are coded within Octet 5: + +- Bit 1 – CUDP (CONNECT-UDP): If this bit is set to "1", it indicates that the proxy type of required MPQUIC is "connect-udp" (see clause 5.32.6.2.2 of 3GPP TS 23.501 [28]) and the UPF shall allocate relevant resource as specified in clause 5.20.2A.1 +- Bit 2 to 8 Spare, for future use and set to "0". + +## 8.2.226 MPQUIC Address Information + +The MPQUIC Address Information IE shall carry the address information of MPQUIC proxy in the UPF. It shall be encoded as shown in Figure 8.2.226-1. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|---|---|----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 332 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | V6 | V4 | +| 6 | MPQUIC Proxy Type | | | | | | | | +| 7 to 8 | MPQUIC Proxy Port | | | | | | | | +| p to (p+3) | MPQUIC Proxy IPv4 Address | | | | | | | | +| q to (q+15) | MPQUIC Proxy IPv6 Address | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.226-1: MPQUIC Address Information + +The following flags are coded within Octet 5: + +- Bit 1 – V4: If this bit is set to "1", then the MPQUIC Proxy IPv4 Address field shall be present in the MPQUIC Address Information IE. +- Bit 1 – V6: If this bit is set to "1", then the MPQUIC IPv6 Address field shall be present in the MPQUIC Address Information IE. + +- Bit 3 to 8 Spare, for future use and set to "0". + +Octets 6 shall indicate the MPQUIC Proxy Type, with the value specified in clause 6.1.4 of 3GPP TS 24.193 [59]. + +Octets 7 to 8 shall indicate the allocated UDP port number of the MPQUIC Proxy. + +Octets "p to (p+3)" or "q to (q+15)" (IPv4 address / IPv6 address fields), if present, shall contain the address value. + +## 8.2.227 Transport Mode + +The transport mode IE shall be encoded as shown in Figure 8.2.227-1. It indicates the transport mode for transmitting a UDP flow. + +![](1240ac770bfb4a7805029c473fdaadd6_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 333 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Transport Mode Value | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.227-1: Transport Mode** + +The Transport Mode value shall be encoded as a 4 bits binary integer as specified in Table 8.2.e-1. + +**Table 8.2.227-1: Transport Mode value** + +| Transport Mode Value | Values (Decimal) | +|----------------------|------------------| +| Datagram mode 1 | 0 | +| Datagram mode 2 | 1 | +| Stream mode | 2 | +| Spare | 3 to 15 | + +## 8.2.228 Void + +## 8.2.229 Reporting Suggestion Info + +The Reporting Suggestion Info IE shall be encoded as shown in Figure 8.2.229-1. + +![](fb085ecd97845ca0c4cdbdea1ed28196_img.jpg) + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|-------------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 335 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Reporting Urgency value | | | | +| 6 to 9 | Reporting Time Info | | | | | | | | +| 10 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.229-1: Reporting Suggestion Info** + +The Reporting Urgency value shall be encoded as a 4 bits binary integer as specified in Table 8.2.229-1. + +**Table 8.2.229-1: Reporting Urgency value** + +| Reporting Urgency Value | Values (Decimal) | +|-------------------------|------------------| +| Delay tolerant | 0 | +| Non delay tolerant | 1 | +| Spare | 2 to 15 | + +The Reporting Time Info field shall be present if the Reporting Urgency indicates the event report is delay tolerant. When present, it shall be encoded as an Unsigned32 binary integer value indicating the latest time for the UPF to report the detected event, expressed as a duration in seconds. + +## 8.2.230 TL-Container + +The TL-Container IE shall be encoded as shown in Figure 8.2.230-1. It contains an opaque container of TL-Container information. + +| Octets | Bits | | | | | | | | +|------------|--------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 336 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 to (n+4) | TL-Container Information | | | | | | | | + +Figure 8.2.230-1: TL-Container + +The TL-Container Information field shall be encoded as an Octet String. It shall encode a Get or Set Request or Response message defined in 3GPP TS 29.585 [80]. + +## 8.2.231 Measurement Indication IE + +The Measurement Indication IE shall be encoded as shown in Figure 8.2.231-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 337 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | DQFI | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.2.231-1: Measurement Indication IE + +The following flags are coded within Octet 5: + +- Bit 1 – DQFI (Default QoS Flow Indication): If this bit is set to "1", it indicates that the UPF is requested to perform QoS Monitoring measurements on the QoS flow associated with the default QoS rule and the UPF shall include the same indication in the corresponding QoS Monitoring Measurement report (see clause 4.15.4.5.1 of 3GPP TS 23.502 [29]). +- Bit 2 to 8 Spare, for future use and set to "0". + +## 8.2.232 HPLMN S-NSSAI + +The HPLMN S-NSSAI IE indicates the HPLMN S-NSSAI of a PDU session. It shall be encoded as shown in Figure 8.2.232-1. + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 338 (decimal) | | | | | | | | +| 3 to 4 | Length = 4 | | | | | | | | +| 5 | SST | | | | | | | | +| 6 to 8 | SD | | | | | | | | + +Figure 8.2.232-1: HPLMN S-NSSAI + +The SST (Slice/Service Type) and SD (Slice Differentiator) fields shall be encoded as defined in clause 28.4.2 of 3GPP TS 23.003 [2]. + +## 8.2.233 Media Transport Protocol + +The Media Transport Protocol IE indicates the transport protocol used by the packets of the media flow. It shall be coded as depicted in Figure 8.2.233-1. + +![](d74d903882c523e543dea290b1033e48_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|--------------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 339 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | Media Transport Protocol | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.2.233-1: Media Transport Protocol** + +The Media Transport Protocol field in octet 5 shall be encoded as defined in Table 8.2.233-1. + +**Table 8.2.233-1: Media Transport Protocol** + +| Value (Decimal) | Media Transport Protocol | +|-----------------|-------------------------------------------------------------| +| 0 | Unspecified | +| 1 | RTP (Real-time Transport Protocol) – see IETF RFC 3550 [82] | +| 2 | SRTP (Secure Real-Time Protocol) – see IETF RFC 3711 [83] | +| 3-15 | Spare, for future use. | + +## 8.2.234 RTP Header Extension Type + +The RTP Header Extension Type IE indicates the type of the RTP header extension. It shall be coded as depicted in Figure 8.2.234-1. + +![](5a6c0922072257806a1985a761f2abd6_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 342 (decimal) | | | | | | | | +| 3 to 4 | Length = 1 | | | | | | | | +| 5 | RTP Header Extension Type | | | | | | | | + +**Figure 8.2.234-1: RTP Header Extension Type** + +The RTP Header Extension Type field in octet 5 shall be encoded as defined in Table 8.2.234-1. + +**Table 8.2.234-1: RTP Header Extension Type** + +| Value (Decimal) | Header Extension | +|-----------------|--------------------------------------------------------------------------------------| +| 1 | RTP Header Extension for PDU Set Marking (see clause 4.4.2.2 of 3GPP TS 26.522 [79]) | +| 2-255 | Spare, for future use. | + +**Editor's note:** It is FFS whether to standardize additional enumeration value. + +## 8.2.235 RTP Header Extension ID + +The RTP Header Extension ID IE indicates the ID of the RTP header extension. It shall be coded as depicted in Figure 8.2.235-1. + +![](2686cc35669b140d74b134b0c673adf8_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 343 (decimal) | | | | | | | | +| 3 to 4 | Length = 1 | | | | | | | | +| 5 | RTP Header Extension ID | | | | | | | | + +Figure 8.2.235-1: RTP Header Extension ID + +The RTP Header Extension ID field shall be encoded as a decimal value in the range 1 to 255 (see IETF RFC 8285 [86]). + +## 8.2.236 RTP Payload Type + +The RTP Payload Type indicates the payload type of RTP packets. It shall be coded as depicted in Figure 8.2.236-1. + +![](9e2b890eb1af21240ec68d210241d0d5_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 344 (decimal) | | | | | | | | +| 3 to 4 | Length = 1 | | | | | | | | +| 5 | Payload Type | | | | | | | | + +Figure 8.2.236-1: RTP Payload Type + +The Payload Type field shall encode the (S)RTP payload type, as an integer between (and including) 1 and 127. + +## 8.2.237 RTP Payload Format + +The RTP Payload Format indicates the payload format of RTP packets. It shall be coded as depicted in Figure 8.2.237-1. + +![](9a76d0bd12a2f17f110914f18fa7ceac_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 345 (decimal) | | | | | | | | +| 3 to 4 | Length = 1 | | | | | | | | +| 5 | Payload Format | | | | | | | | + +Figure 8.2.237-1: RTP Payload Format + +The Payload Format field shall be encoded as defined in Table 8.2.237-1. + +Table 8.2.237-1: Payload Format + +| Value (Decimal) | Payload Format | +|-----------------|--------------------------------| +| 1 | H.264 – see IETF RFC 6184 [84] | +| 2 | H.265 – see IETF RFC 7798 [85] | +| 3-255 | Spare, for future use. | + +--- + +## Annex A (Informative): PFCP Load and Overload Control Mechanism + +### A.1 Throttling Algorithms + +#### A.1.1 "Loss" Throttling Algorithm + +##### A.1.1.1 Example of Possible Implementation + +This clause provides an example of a possible implementation of the "Loss" algorithm, amongst other possible methods. + +It is possible to make use of a statistical loss function (e.g., random selection of messages to throttle based on the indicated percentage) to decide if the given message can be sent or need to be throttled. For example, the source node generates a random number between (0, 100) for each message which is a potential candidate for throttling. To realize 10% throttling, messages with a random number 10 or less are throttled and hence this achieves approximately a 10% reduction in the overall traffic. The actual traffic reduction might vary slightly from the requested percentage, albeit by an insignificant amount. + +The algorithm can select certain messages to throttle in priority. For example, implementations can distinguish between higher-priority and lower-priority messages, and drop the lower-priority messages in favour of dropping the higher priority messages, as long as the total reduction in traffic conforms to the requested reduction in effect at the time. For example, in the 50-50 distribution of high priority and low priority messages, 20% reduction to low priority messages and 0% reduction to high priority messages need to be applied in order to achieve the effective reduction in traffic by 10% towards the overloaded node. + +--- + +## Annex B (Normative): CP and UP Selection Functions with Control and User Plane Separation + +### B.1 CP Selection Function + +#### B.1.1 General + +The SGW-C and PGW-C selection function shall follow the principles specified in 3GPP TS 29.303 [25] for the SGW and PGW selection functions without Control and User Plane Separation. + +The following additional considerations apply with Control and User Plane Separation: + +1. At most one SGW-C shall be selected per user at any time. +2. The service area of an SGW-C function shall be aligned with the service area of the corresponding SGW-U functions (see clause 4.3.4 of 3GPP TS 23.214 [2]). All the SGW-U functions in the service area shall have a full meshed connectivity with all the eNBs of TAs and/or all RNCs/BSCs of RAs served by that service area. +3. The SGW dynamic load reported to the MME/SGSN and the PGW dynamic load reported to the MME/SGSN or TWAN/ePDG should take into account the operating status of the CP and UP functions' resources that the SGW-C/PGW-C is controlling. See clause 6.2.3 for how the CP function obtains load control information from the UP function. +4. For Dedicated Core Networks (see clause 5.8 of 3GPP TS 29.303 [25]), an SGW-C or PGW-C function shall be declared in DNS as dedicated to certain mapped UE usage types if the CP function or if all the UP functions it controls are dedicated to certain mapped UE usage types. In this case, the CP function shall be provisioned in DNS with all the mapped UE usage types that both the CP function and its UP functions support. + +5. The MME/SGSN shall be able to select an SGW-C and a PGW-C optimized for NR, e.g. for UEs indicating support of dual connectivity with NR in NAS signalling to the MME or SGSN and without subscription restriction to use NR as secondary RAT, according to the requirements specified in clause 5.12.2 of 3GPP TS 29.303 [25]. The SGW-C and the PGW-C optimized for NR may be a combined SGW-C/PGW-C function optimized for the NR. + +--- + +## B.2 UP Selection Function + +### B.2.1 General + +The following requirements apply for the selection of the UP function: + +- the SGW-C, PGW-C and TDF-C shall be responsible for the selection of the SGW-U, PGW-U and TDF-U respectively; +- an SGW-C may select different SGW-U functions for different PDN connections of a same user. + +It is implementation specific how to support the UP selection function requirements specified in this clause. Clause B.2.6 specifies one possible implementation. + +### B.2.2 SGW-U Selection Function + +The SGW-C shall be able to select the SGW-U considering the following parameters: + +- the SGW-U location and the user 's location (i.e. ECGI, eNodeB ID or TAI for E-UTRAN, RAI or RNC-ID for UTRAN); +- the SGW-U's capabilities and the capabilities required for the particular UE session to establish; +- the mapped UE Usage Type (when dedicating SGW-U to specific Dedicated Core Networks); +- the SGW-U's dynamic load; +- the SGW-U's relative static capacity (versus other SGW-U's); +- the UP Function Selection Information Flags, indicating whether it is desired to select an SGW-U optimized for NR, as specified in 3GPP TS 29.274 [9]. + +Based on local policy, if the user's location information is required to be used for selecting the UP function, the SGW-C shall determine the list of candidate SGW-U's taking into account the user's location (ECGI, eNodeB ID or TAI for E-UTRAN, RAI or RNC-ID for UTRAN). + +The SGW-C shall select, among the candidate SGW-U functions, an SGW-U function which supports all the capabilities required for the particular UE session, considering the information received during the PFCP Association Setup. + +### B.2.3 PGW-U Selection Function + +The PGW-C shall be able to select the PGW-U considering the following parameters: + +- the requested APN for the PDN connection; +- the PGW-U location and the user 's location; +- the PGW-U's capabilities and the capabilities required for the particular UE session to establish; +- the mapped UE Usage Type (when dedicating PGW-U to specific Dedicated Core Networks); +- the PGW-U's dynamic load; +- the PGW-U's relative static capacity (versus other PGW-U's); + +- whether a PDN connection already exists for the same UE and APN, in which case the same PGW-U shall be selected (to enable APN-AMBR enforcement); +- the UP Function Selection Information Flags, indicating whether it is desired to select a PGW-U optimized for NR, as specified in 3GPP TS 29.274 [9]. + +NOTE: The SGW-U and PGW-U location can be configured in the SGW-C and PGW-C or derived from DNS procedures as specified in clause B.2.2. + +If the PGW-C already assigned a PGW-U to the UE for the requested APN (e.g. UE with multiple PDN connections to the same APN), the PGW-C shall select the same PGW-U for the new PDN connection. + +If a non-null IPv4 address and/or an IPv6 prefix is received in the PDN Address Allocation (PAA) IE in the Create Session Request, e.g. static address assignment in the user subscription, the PGW-C shall select a PGW-U which can support the requested UE's IP address and/or IPv6 prefix. + +Otherwise, the PGW-C shall determine the list of candidate PGW-U taking into account the requested APN. + +The PGW-C shall select, among the candidate PGW-U functions, a PGW-U function which supports all the capabilities required for the particular UE session, considering the information received during the PFCP Association Setup. + +## B.2.4 Combined SGW-U/PGW-U Selection Function + +A Combined SGW-C/PGW-C function shall be able to select a combined SGW-U/PGW-U function. This shall be possible for all the UE's PDN connections, as shown in Figure B.2.1-1. + +![Diagram illustrating SGW-U/PGW-U colocation with Control and User Plane Separation. The diagram shows a UE connected to an eNB, which is connected to an MME. The MME is connected to a combined SGW-C/PGW-C function. This function is connected to two separate PDN connections: PDN1 (Ex. Internet) and PDN2 (Ex. IMS). Each PDN connection consists of a PGW-U and an SGW-U. The PGW-U and SGW-U are connected to the combined SGW-C/PGW-C function. The diagram is labeled 'Multiple PDN connections' at the bottom.](c2c14da2db540fd84f355e71c9085b4a_img.jpg) + +``` + +graph TD + UE[UE] --- eNB[eNB] + eNB --- MME[MME] + MME --- SGW_C_PGW_C[SGW-C PGW-C] + SGW_C_PGW_C --- PDN1[PDN1 Ex. Internet] + SGW_C_PGW_C --- PDN2[PDN2 Ex. IMS] + PDN1 --- PGW_U1[PGW-U] + PDN1 --- SGW_U1[SGW-U] + PDN2 --- PGW_U2[PGW-U] + PDN2 --- SGW_U2[SGW-U] + PGW_U1 --- SGW_U1 + PGW_U2 --- SGW_U2 + +``` + +Diagram illustrating SGW-U/PGW-U colocation with Control and User Plane Separation. The diagram shows a UE connected to an eNB, which is connected to an MME. The MME is connected to a combined SGW-C/PGW-C function. This function is connected to two separate PDN connections: PDN1 (Ex. Internet) and PDN2 (Ex. IMS). Each PDN connection consists of a PGW-U and an SGW-U. The PGW-U and SGW-U are connected to the combined SGW-C/PGW-C function. The diagram is labeled 'Multiple PDN connections' at the bottom. + +**Figure B.2.4-1: SGW-U/PGW-U colocation with Control and User Plane Separation** + +A combined SGW-C/PGW-C function shall select the SGW-U and PGW-U as defined respectively in B.2.2 and B.2.3, with the following additions: + +- the combined SGW-C/PGW-C function shall select the best couple of SGW-U and PGW-U (e.g. the combined SGW-U/PGW-U function), for the requested APN, among all candidate couples of (SGW-U, PGW-U), instead of selecting independently the SGW-U and the PGW-U. + +## B.2.5 TDF-U selection function + +The TDF-C shall be able to select the TDF-U as specified in clause 5.12.5 of 3GPP TS 23.214 [2]. + +## B.2.6 UP Selection Function Based on DNS + +### B.2.6.1 General + +This clause specifies optional DNS procedures to select the SGW-U and PGW-U functions and the requirements which apply when these procedures are supported. + +The relative static capacity of an SGW-U and PGW-U may be configured in the DNS. + +The Node ID of an SGW-U and PGW-U may take the form of a canonical node name to allow the selection of a SGW-U and PGW-U with the best topological match. + +### B.2.6.2 SGW-U Selection Function Based on DNS + +The SGW-C shall retrieve the list of candidate SGW-U's using DNS procedures taking into account the user's location (ECGI, eNodeB ID or TAI for E-UTRAN, RAI or RNC-ID for UTRAN), as specified in 3GPP TS 29.303 [25]. + +In non-roaming or LBO scenarios where the PGW-U is already selected (e.g. TAU with SGW change) and when it is preferred to select a collocated node or a topologically closer node, the SGW-C shall try to select an SGW-U collocated with the PGW-U. + +### B.2.6.3 PGW-U Selection Function Based on DNS + +The PGW-C shall retrieve the list of candidate PGW-U's using DNS procedures taking into account the requested APN, as specified in 3GPP TS 29.303 [25]. + +In non-roaming or LBO scenarios, when it is preferred to select a collocated node or a topologically closer node, i.e. when such preference is indicated in the canonical node names of the PGW-U functions in the DNS (using "topon" as the first label of canonical node name), the PGW-C shall give precedence to collocation of SGW-U and PGW-U, then to topological closeness (i.e. pairs of SGW-U and PGW-U with canonical node names with the highest number of matching labels). This requires the SGW-C to provide the SGW-U Node ID to the PGW-C. + +### B.2.6.4 Combined SGW-U/PGW-U Selection Function Based on DNS + +A combined SGW-C/PGW-C function shall select the SGW-U and PGW-U as defined respectively in B.2.4, B.2.6.2 and B.2.6.3. + +--- + +## Annex C (Informative): Examples scenarios + +### C.1 General + +This clause provides example call flows illustrating how the CP function can provision the UP function to support certain functionalities. + +This Annex is informative and the normative descriptions in this specification and in 3GPP TS 23.214 [2] prevail over the descriptions in this Annex if there is any difference. + +## C.2 Charging Support + +### C.2.1 Online Charging + +#### C.2.1.1 Online Charging Call Flow – Normal Scenario + +Figure C.2.1.1-1 illustrates the exchanges taking place over the Sxb or Sxc reference points when applying online charging. In this example, the OCS grants quotas by chunks of 100 Mbytes and requests the CP function to request new credits when the remaining credit falls below 10 Mbytes. + +![Sequence diagram of Online Charging Call Flow – Normal Scenario. The diagram shows interactions between UP function (PGW-U/TDF-U), CP function (PGW-C/TDF-C), and OCS. The flow starts with the CP function sending a 'request credit' to the OCS. The OCS responds with 'Granted Quota 100, Quota Threshold 10'. The CP function then sends a 'PFCP Session Mod. Request' to the UP function with 'Volume Thresh=90, Volume Quota=100'. The UP function consumes traffic until it reaches the 90 Mbyte threshold, then sends a 'PFCP Session Report Request' to the CP function. The CP function requests another credit from the OCS, which grants another 100 Mbyte quota. This process repeats once more. Finally, the UP function reaches the 100 Mbyte quota, sends a report, and the CP function sends a 'Final Quota 50'. The UP function consumes the remaining 50 Mbytes and then terminates the service.](a2d2099bcb354ddc581de00483177038_img.jpg) + +``` + +sequenceDiagram + participant UP as UP function (PGW-U/TDF-U) + participant CP as CP function (PGW-C/TDF-C) + participant OCS as OCS + + Note left of UP: After consuming 90: +- UP sends a report +- UP forwards packets till 100 M + CP->>OCS: 1. request credit + OCS-->>CP: 1'. Granted Quota 100, Quota Threshold 10 + CP->>UP: 2. PFCP Session Mod. Request (Volume Thresh=90, Volume Quota=100) + UP->>CP: 3. PFCP Session Report Request (Volume Thresh reached, Vol.Meast= 90) + CP->>OCS: 4. request credit + OCS-->>CP: 4'. Granted Quota 100, Quota Threshold 10 + CP->>UP: 5. PFCP Session Mod. Request (Volume Thresh=90, Volume Quota=100) + Note left of UP: After consuming 90: +- UP sends a report +- UP forwards packets till 100 M + UP->>CP: 6. PFCP Session Report Request (Volume Thresh reached, Vol.Meast= 90) + CP->>OCS: 7. request credit + OCS-->>CP: 7'. Final Quota 50 + CP->>UP: 8. PFCP Session Mod. Request (Volume Quota=50) + Note left of UP: After consuming 50: +- UP sends a report +- UP stops forwarding packets + UP->>CP: 9. PFCP Session Report Request (Volume Quota reached, Vol.Meast= 50) + UP->>UP: 10. Terminate the service + +``` + +Sequence diagram of Online Charging Call Flow – Normal Scenario. The diagram shows interactions between UP function (PGW-U/TDF-U), CP function (PGW-C/TDF-C), and OCS. The flow starts with the CP function sending a 'request credit' to the OCS. The OCS responds with 'Granted Quota 100, Quota Threshold 10'. The CP function then sends a 'PFCP Session Mod. Request' to the UP function with 'Volume Thresh=90, Volume Quota=100'. The UP function consumes traffic until it reaches the 90 Mbyte threshold, then sends a 'PFCP Session Report Request' to the CP function. The CP function requests another credit from the OCS, which grants another 100 Mbyte quota. This process repeats once more. Finally, the UP function reaches the 100 Mbyte quota, sends a report, and the CP function sends a 'Final Quota 50'. The UP function consumes the remaining 50 Mbytes and then terminates the service. + +**Figure C.2.1.1-1: Online charging with intermediate and final quotas** + +1. Upon the request from the CP function, the OCS grants an intermediate quota of 100 Mbytes and requests the CP function to request a new credit when the remaining credit falls below 10 Mbytes. +2. The CP function sends a PFCP Session Modification Request to the UP function with an Update URR IE including the Volume Threshold IE set to 90 Mbytes and the Volume Quota IE set to 100 Mbytes. +3. Upon reaching the Volume Threshold (i.e. 90 Mbytes), the UP function sends a PFCP Session Report Request to the CP function with a Usage Report IE including the Usage Report Trigger set to "Volume Threshold" and the Volume Measurement set to 90 Mbytes. The UP function continues to pass on traffic until reaching the Volume Quota (i.e. an extra 10 Mbytes of traffic can be passed on). +4. Upon the request from the CP function, the OCS grants a new intermediate quota of 100 Mbytes and requests the CP function to request a new credit when the remaining credit falls below 10 Mbytes. +5. The CP function sends a PFCP Session Modification Request to the UP function with an Update URR IE including the Volume Threshold IE set to 90 Mbytes and the Volume Quota IE set to 100 Mbytes. If the UP function had forwarded e.g. 5 Mbytes of traffic since the last usage report, the UP function knows that it shall send the next usage report upon passing on an extra 85 Mbytes of traffic. +6. Upon reaching the Volume Threshold (i.e. 90 Mbytes), the UP function sends a PFCP Session Report Request to the CP function with a Usage Report IE including the Usage Report Trigger set to "Volume Threshold" and the + +Volume Measurement set to 90 Mbytes. The UP function continues to pass on traffic until reaching the Volume Quota (i.e. an extra 10 Mbytes of traffic can be passed on). + +7. Upon the request from the CP function, the OCS grants a new final quota of 50 Mbytes and requests the CP function to terminate the service or to redirect the traffic towards a redirect destination when the quota is consumed. +8. The CP function sends a PFCP Session Modification Request to the UP function with an Update URR IE including the Volume Quota IE set to 50 Mbytes. If the UP function had forwarded e.g. 5 Mbytes of traffic since the last usage report, the UP function knows that it shall send the next usage report upon passing on an extra 45 Mbytes of traffic. +9. Upon reaching the Volume Quota (i.e. 50 Mbytes), the UP function sends a PFCP Session Report Request to the CP function with a Usage Report IE including the Usage Report Trigger set to "Volume Quota" and the Volume Measurement set to 50 Mbytes. The UP function stops passing on traffic. +10. Upon being notified that the final quota has been reached, the CP function terminates the service (e.g. by preventing the traffic of the corresponding SDF to further pass on in the UP function) or redirects the traffic towards a redirect destination by provisioning a Redirect Information IE within the FAR associated to the traffic. + +Figure C.2.1.1-2 illustrates the exchanges taking place over the Sxb or Sxc reference points when applying online charging and the UP function supports being provisioned with the Quota Action to apply when reaching quotas. This example is similar to the previous one, but the CP function provisions the UP function with the action to apply when reaching the final quota. + +![Sequence diagram showing online charging with Quota Action provisioned in the UP function. The diagram involves three entities: UP function (PGW-U/TDF-U), CP function (PGW-C/TDF-C), and OCS. The sequence starts with the CP function sending a 'request credit' to the OCS. The OCS responds with 'Granted Quota 100, Quota Threshold 10'. The CP function then sends a 'PFCP Session Mod. Request' to the UP function with 'Volume Thresh=90, Volume Quota=100'. The UP function consumes 90 Mbytes, sends a report, and forwards packets until 100 Mbytes. The CP function sends another 'request credit' to the OCS, which responds with 'Granted Quota 100, Quota Threshold 10'. The CP function sends another 'PFCP Session Mod. Request' to the UP function with 'Volume Thresh=90, Volume Quota=100'. The UP function consumes 90 Mbytes, sends a report, and forwards packets until 100 Mbytes. The CP function sends a 'request credit' to the OCS, which responds with 'Final Quota 50'. The CP function sends a 'PFCP Session Mod. Request' to the UP function with 'Volume Quota=50, FAR for Quota Action'. The UP function consumes 50 Mbytes, sends a report, and stops forwarding packets or redirects the traffic.](642182b1c4431ad5fb0e911fcb892d08_img.jpg) + +``` + +sequenceDiagram + participant UP as UP function (PGW-U/TDF-U) + participant CP as CP function (PGW-C/TDF-C) + participant OCS as OCS + + Note left of UP: After consuming 90: +- UP sends a report +- UP forwards packets till 100 M + CP->>OCS: 1. request credit + OCS-->>CP: 1'. Granted Quota 100, Quota Threshold 10 + CP->>UP: 2. PFCP Session Mod. Request (Volume Thresh=90, Volume Quota=100) + UP-->>CP: 3. PFCP Session Report Request (Volume Thresh reached, Vol.Meast= 90) + Note left of UP: After consuming 90: +- UP sends a report +- UP forwards packets till 100 M + CP->>OCS: 4. request credit + OCS-->>CP: 4'. Granted Quota 100, Quota Threshold 10 + CP->>UP: 5. PFCP Session Mod. Request (Volume Thresh=90, Volume Quota=100) + UP-->>CP: 6. PFCP Session Report Request (Volume Thresh reached, Vol.Meast= 90) + CP->>OCS: 7. request credit + OCS-->>CP: 7'. Final Quota 50 + CP->>UP: 8. PFCP Session Mod. Request (Volume Quota=50, FAR for Quota Action) + Note left of UP: After consuming 50: +- UP sends a report +- UP stops forwarding packets or redirects the traffic + UP-->>CP: 9. PFCP Session Report Request (Volume Quota reached, Vol.Meast= 50) + +``` + +Sequence diagram showing online charging with Quota Action provisioned in the UP function. The diagram involves three entities: UP function (PGW-U/TDF-U), CP function (PGW-C/TDF-C), and OCS. The sequence starts with the CP function sending a 'request credit' to the OCS. The OCS responds with 'Granted Quota 100, Quota Threshold 10'. The CP function then sends a 'PFCP Session Mod. Request' to the UP function with 'Volume Thresh=90, Volume Quota=100'. The UP function consumes 90 Mbytes, sends a report, and forwards packets until 100 Mbytes. The CP function sends another 'request credit' to the OCS, which responds with 'Granted Quota 100, Quota Threshold 10'. The CP function sends another 'PFCP Session Mod. Request' to the UP function with 'Volume Thresh=90, Volume Quota=100'. The UP function consumes 90 Mbytes, sends a report, and forwards packets until 100 Mbytes. The CP function sends a 'request credit' to the OCS, which responds with 'Final Quota 50'. The CP function sends a 'PFCP Session Mod. Request' to the UP function with 'Volume Quota=50, FAR for Quota Action'. The UP function consumes 50 Mbytes, sends a report, and stops forwarding packets or redirects the traffic. + +**Figure C.2.1.1-2: Online charging with Quota Action provisioned in the UP function** + +1 to 7'. Same as for figure C.2.1.1-1. + +8. The CP function sends a PFCP Session Modification Request to the UP function with a Create FAR IE provisioning the action the UP function shall apply when reaching the quota, and with an Update URR IE including the Volume Quota IE set to 50 Mbytes and the FAR ID for Quota Action IE set to the new FAR ID). If the UP function had forwarded e.g. 5 Mbytes of traffic since the last usage report, the UP function knows that it shall send the next usage report upon passing on an extra 45 Mbytes of traffic. +9. Upon reaching the Volume Quota (i.e. 50 Mbytes), the UP function sends a PFCP Session Report Request to the CP function with a Usage Report IE including the Usage Report Trigger set to "Volume Quota" and the Volume Measurement set to 50 Mbytes. + +10. The UP function applies the quota action provisioned at step 8, i.e. it stops forwarding packets or it redirects the traffic towards a redirect destination, according to the FAR identified in the FAR ID for Quota Action. + +## C.2.1.2 Online Charging Call Flow with Credit Pooling + +### C.2.1.2.1 General + +Figure C.2.1.2-1 illustrates a signalling flow over the Sxb and Gy reference points when applying online charging, and when the CP function (i.e. PGW-C) is instructed by the OCS to handle a Credit Pool for a given Gy Session. + +### C.2.1.2.2 Example Call Flow 1 + +In this example, the PGW-C is instructed by the OCS to handle a credit pool for two Rating Groups, RG1 and RG2. The PGW-C provisions two URRs, URR1 and URR2, for the two RGs respectively, and a URR3 for the Credit Pool. The PGW-C provisions the URR1 and URR2 with the quota received from the OCS respectively for RG1 and RG2 (like if there was no credit pooling). + +This reflects one possible implementation option, whereby each quota remains managed independently from the others. This approach can result in extra usage reports being sent over Sxb for RG1 or RG2 before the credit pool is exhausted. + +![Sequence diagram showing online charging with credit pooling. Lifelines: UP function (PGW-U), CP function (PGW-C), and OCS. The diagram illustrates the interaction between these components for credit allocation and usage reporting across multiple sessions.](37a7503d01fdb9775036d415ccf102d1_img.jpg) + +The sequence diagram illustrates the interaction between the UP function (PGW-U), CP function (PGW-C), and OCS for online charging with credit pooling. The process involves multiple sessions where credit is requested, allocated, and then reported when quotas are reached. + +**Sequence of Messages:** + +- UP function (PGW-U) to CP function (PGW-C):** 2. Send Sx Session Mod. Request to create new URR1 for RG1, quota=100; new URR2 for RG2, quota=100; new URR3 for The Credit Pool, quota = $S = 100 \times 0.1 + 100 \times 0.5 = 60$ ; +- CP function (PGW-C) to OCS:** 1. request credit for RG1 and RG2 +- OCS to CP function (PGW-C):** 1'. RG1, GSU=100M, PID=1000, M=0.1; RG2, GSU=100M, PID=1000, M=0.5 +- CP function (PGW-C) to UP function (PGW-U):** 2' response +- UP function (PGW-U) internal calculation:** RG1 consumed 100 counted by URR1, RG2 consumed 10 counted by URR2; URR3 for Pool counts $U = 100 \times 0.1 + 10 \times 0.5 = 15 < S = 60$ +- UP function (PGW-U) to CP function (PGW-C):** 3. Sx Session Report Request URR 1, 100, due to Reaching quota +- CP function (PGW-C) to OCS:** 4. request credit for RG1 (USU 100) +- OCS to CP function (PGW-C):** 4'. Since the quota in the Credit Pool has not exhausted, no new GSU will be provided. +- CP function (PGW-C) to UP function (PGW-U):** 5. Send Sx Session Mod. Request, update URR1 for RG1, quota=100; +- UP function (PGW-U) to CP function (PGW-C):** 5' response +- UP function (PGW-U) internal calculation:** RG1 consumed 100 counted by URR1, RG2 consumed 10 counted by URR2; URR3 for Pool counts $U = (100 + 100) \times 0.1 + (10 + 10) \times 0.5 = 30 < S = 60$ +- UP function (PGW-U) to CP function (PGW-C):** 6. Sx Session Report Request URR 1, 100, due to Reaching quota +- CP function (PGW-C) to OCS:** 6' Response +- CP function (PGW-C) to UP function (PGW-U):** 7. Send Sx Session Mod. Request, update URR1 for RG1, quota=100; +- UP function (PGW-U) to CP function (PGW-C):** 7' response +- UP function (PGW-U) internal calculation:** RG1 consumed 100 counted by URR1, RG2 consumed 10 counted by URR2; URR3 for Pool counts $U = (100 + 100 + 100) \times 0.1 + (10 + 10 + 10) \times 0.5 = 45 < S = 60$ +- UP function (PGW-U) to CP function (PGW-C):** 8. Sx Session Report Request URR 1, 100, due to Reaching quota +- CP function (PGW-C) to OCS:** 8' Response +- CP function (PGW-C) to UP function (PGW-U):** 9. Send Sx Session Mod. Request, update URR1 for RG1, quota=100; +- UP function (PGW-U) to CP function (PGW-C):** 9' response +- UP function (PGW-U) internal calculation:** RG1 consumed 100 counted by URR1, RG2 consumed 10 counted by URR2; URR3 for Pool counts $U = (100 + 100 + 100 + 100) \times 0.1 + (10 + 10 + 10 + 10) \times 0.5 = 60 \geq S = 60$ +- UP function (PGW-U) to CP function (PGW-C):** 10. Sx Session Report Request URR 1, 100, due to Reaching quota and also linked URR3; URR 2, 40, due to linked URR3; URR 3, due to reaching Quota 60 +- CP function (PGW-C) to OCS:** 11. request credit for RG1 (USU 400) and RG2 (USU 40) +- OCS to CP function (PGW-C):** 11'. RG1, GSU=200M, PID=1000, M=0.1; RG2, GSU=200M, PID=1000, M=0.5 +- CP function (PGW-C) to UP function (PGW-U):** 12. Send Sx Session Mod. Request, update URR1 for RG1, quota=700; URR2 for RG2, quota=140; new URR3 for The Credit Pool, quota = 70 +- UP function (PGW-U) to CP function (PGW-C):** 12' response + +Sequence diagram showing online charging with credit pooling. Lifelines: UP function (PGW-U), CP function (PGW-C), and OCS. The diagram illustrates the interaction between these components for credit allocation and usage reporting across multiple sessions. + +Figure C.2.2.2-1: Online charging with Credit Pooling (alt 1) + +- Upon the request from the CP function for RG1 and RG2, the OCS grants: + +RG1: quota 100 Mbytes, together with a G-S-U-Pool-Reference AVP included within the Multiple Services Credit Control (for RG1), where the G-S-U-Pool-Identifier AVP indicating the identifier (e.g. 1000) of the Credit Pool to which the RG1 pertains, the CC-Unit-Type AVP specifies the type of units for which credit is (e.g. total octets), the Unit-Value AVP specifies the multiplier (e.g. 0.1); + +RG2: quotas 100 Mbytes, together with a G-S-U-Pool-Reference AVP included within the Multiple Services Credit Control (for RG2), where the G-S-U-Pool-Identifier AVP indicating the identifier (e.g. 1000) of the Credit Pool to which the RG2 pertains, the CC-Unit-Type AVP specifies the type of units for which credit is (e.g. total octets), the Unit-Value AVP specifies the multiplier (e.g. 0.5); + +- The CP function sends a PFCP Session Modification Request to the UP function, to create: + +A new URR1 for RG1, quota=100, Linked URR = URR3; + +A new URR2 for RG2, quota=100, Linked URR = URR3; + +A new URR3 for Pool, quota = $S = 100 \times 0.1 + 100 \times 0.5 = 60$ , Aggregated URRs: URR1 with Multiplier 0.1 and URR2 with Multiplier 0.5. + +The UP function accepts the request. + +- The RG1 has consumed 100 counted by URR1, RG2 consumed 10 counted by URR2; the URR3 for the Credit Pool counts $U = 100 \times 0.1 + 10 \times 0.5 = 15 < S$ . The URR1 triggers sending a usage report towards the CP function due to reaching the Quota 100. So the UP function sends a PFCP Session Report Request, including the Usage Reports for the URR1. The CP function sends the response message. +- Based on operator's policies, the CP function reports used quota for the RG1 to the OCS. The OCS does not grant any quota since the quota for the Credit Pool has not been consumed yet. + +NOTE: This step is skipped in the rest flow. + +- The CP function sends a PFCP Session Modification Request to the UP function with the modified URR1, with new quota 100. + +Step 6, 7, 8 and 9 repeats step 3 and 5. + +- The RG1 has consumed another 100 counted by URR1, RG2 consumed another 10 counted by URR2; the URR3 for the Credit Pool counts $U = (100 + 100 + 100 + 100) \times 0.1 + (10 + 10 + 10 + 10) \times 0.5 = 60 \geq S = 60$ . So the UP function sends a PFCP Session Report Request, including the Usage Reports for: + - the URR3, generated due to reaching quota (60), + - for the URR1, generated due to that it is linked to the URR3 and it has reached the quota 100, and + - for the URR2 generated due to that it is linked to the URR3. + The CP function sends the response message. + +- The CP function requests new Quota for RG1 and RG2 to the OCS. The OCS grants 200M for RG1 and 100M for RG2, with the same pool ID and Multipliers. + +- The CP function sends a PFCP Session Modification Request to the UP function with the modified URRs, for URR1, URR2 and URR3. + +### C.2.1.2.3 Example Call Flow 2 + +In this example, the PGW-C is instructed by the OCS to handle a credit pool for two Rating Groups, RG1 and RG2. The PGW-C provisions two URRs, URR1 and URR2, for the two RGs respectively, and a URR3 for the Credit Pool. The PGW-C provisions the quotas for URR1 and URR2 taking into account the credit pool quota and the multipliers of the RGs. + +This reflects another possible implementation option. This approach avoids extra usage reports being sent over Sxb for RG1 or RG2 before the credit pool is exhausted, and thus reduces Sxb signalling. + +![Sequence diagram for Online charging with Credit Pooling (alt 2) showing interactions between UP function (PGW-U), CP function (PGW-C), and OCS.](4753dd817f88f9e8bc58fcce3df36ea6_img.jpg) + +``` + +sequenceDiagram + participant UP as UP function (PGW-U) + participant CP as CP function (PGW-C) + participant OCS as OCS + + Note left of UP: RG1 consumed 400 counted by URR1, RG2 consumed 40 counted by URR2; URR3 for Pool counts U = 400 x 0.1 + 40 x 0.5 = 60 >= S + CP->>OCS: 1. request credit for RG1 and RG2 + OCS-->>CP: 1'. RG1, GSU=100M, PID=1000, M=0.1 +RG2, GSU=100M, PID=1000, M=0.5 + CP->>UP: 2. Send Sx Session Mod. Request to create new URR1 for RG1, quota=600; new URR2 for RG2, quota=120; new URR3 for The Credit Pool, Quota = S = 100 x 0.1 + 100 x 0.5 = 60; + UP-->>CP: 2' response + Note left of UP: RG1 consumed 400 counted by URR1, RG2 consumed 40 counted by URR2; URR3 for Pool counts U = 400 x 0.1 + 40 x 0.5 = 60 >= S + UP->>CP: 3. Sx Session Report Request URR 3, exceeding quota; URR 1, 400, due to Linked to the URR3 URR 2, 40, due to Linked to the URR3 + CP-->>OCS: 4. request credit for RG1 (USU 400) and RG2 (USU 40) + OCS-->>CP: 4'. RG1, GSU=200M, PID=1000, M=0.1 +RG2, GSU=100M, PID=1000, M=0.5 + CP->>UP: 5. Send Sx Session Mod. Request, update URR1 for RG1, quota=700; URR2 for RG2, quota=140; URR3 for The Credit Pool, quota = 200 x 0.1 + 100 x 0.5 = 70 + UP-->>CP: 5' response + +``` + +Sequence diagram for Online charging with Credit Pooling (alt 2) showing interactions between UP function (PGW-U), CP function (PGW-C), and OCS. + +**Figure C.2.2.3-2: Online charging with Credit Pooling (alt 2)** + +- Upon the request from the CP function for RG1 and RG2, the OCS grants: + +RG1: quota 100 Mbytes, together with a G-S-U-Pool-Reference AVP included within the Multiple Services Credit Control (for RG1), where the G-S-U-Pool-Identifier AVP indicating the identifier (e.g. 1000) of the Credit Pool to which the RG1 pertains, the CC-Unit-Type AVP specifies the type of units for which credit is (e.g. total octets), the Unit-Value AVP specifies the multiplier (e.g. 0.1); + +RG2: quotas 100 Mbytes, together with a G-S-U-Pool-Reference AVP included within the Multiple Services Credit Control (for RG2), where the G-S-U-Pool-Identifier AVP indicating the identifier (e.g. 1000) of the Credit Pool to which the RG2 pertains, the CC-Unit-Type AVP specifies the type of units for which credit is (e.g. total octets), the Unit-Value AVP specifies the multiplier (e.g. 0.5); + +- The CP function sends a PFCP Session Modification Request to the UP function, to create: + +A new URR1 for RG1, quota=600, Linked URR = URR3; + +A new URR2 for RG2, quota=120, Linked URR = URR3; + +And new URR3 for Pool, quota = $S = 100 \times 0.1 + 100 \times 0.5 = 60$ , Aggregated URRs: URR1 with Multiplier 0.1 and URR2 with Multiplier 0.5. + +The UP function accepts the request. + +NOTE 1: To avoid receiving usage report upon exceeding the original Quota for RG1 or RG2, the quota can be set to $60 / 0.1 = 600$ for RG1, assuming RG1 consumes the complete Quota for the pool; similarly, for RG2, the quota can be set to $60 / 0.5 = 120$ ; + +- The URR3 always first reaches the Quota, e.g. when the URR1 has counted 400, and URR2 has counted 40, this results the counted usage for the Credit Pool $U = 400 \times 0.1 + 40 \times 0.5 = 60$ . So the UP function sends a PFCP Session Report Request, including the Usage Reports: + +- for the URR3, generated due to that it has reached quota (60); + - for the URR1, generated due to that it is linked to the URR3; and + - for the URR2, generated due to that it is linked to the URR3. + +The CP function sends the response message. + +4. The CP function requests new Quota for RG1 and RG2 to the OCS. The OCS grants 200M for RG1 and 100M for RG2, with the same pool ID and Multipliers. +5. The CP function sends a PFCP Session Modification Request to the UP function with the modified URRs, for URR1, URR2 and URR3. + +URR1 for RG1, quota=70 / 0.1 = 700; + +URR2 for RG2, quota=70 / 0.5 = 140; + +URR3 for The Credit Pool, quota = 200 x 0.1 + 100 x 0.5 = 70. + +--- + +## Annex D (Normative): Use of PFCP over N16a for the support of traffic offload by UPF controlled by I-SMF + +### D.1 General + +This Annex applies to PDU sessions involving an Intermediate SMF (I-SMF), when the I-SMF has inserted an Uplink Classifier (UL CL) or Banching Point (BP) into the data path of the PDU session and a local PDU Session Anchor (PSA) further called PSA2 in this Annex, for local traffic offload. + +For such PDU sessions, PFCP session related messages shall be exchanged between the SMF and I-SMF for: + +- the SMF to provide N4 information to the I-SMF regarding how the traffic shall be detected, enforced and monitored in the UPF(s) controlled by the I-SMF; +- the I-SMF to forward N4 information with traffic usage reporting to the SMF. + +See clause 5.34.6 of 3GPP TS 23.501 [28]. + +Whether the UL CL or BP and PSA2 are supported by the same UPF or not shall be transparent to the SMF. + +When exchanging N4 information over N16a, the SMF and I-SMF shall assume the model in Figure D.1-1 where the UL CL or BP and PSA2 are supported by separate UPFs, i.e. separate PFCP session related messages shall be exchanged over N4 for the UL CL/BP and for the PSA2. + +NOTE 1: This allows the SMF and I-SMF to exchange unambiguous information on whether N4 information exchanged over N16a relates to the UL CL/BP or the PSA2, e.g. whether a QER is to be enforced in the UL CL/BP or PSA2. + +NOTE 2: The UL CL/BP and PSA2 inserted by the I-SMF can be co-located or located on different UPFs, regardless of the model assumed over N16a for the exchange of N4 information. + +NOTE 3: Only one local PSA (i.e. PSA2) is shown in this figure; in real deployment, more than one local PSAs can be inserted. + +![Figure D.1-1: UL CL/BP and PSA2 model for N4 information exchanged over N16a. The diagram shows a network architecture with the following components and interfaces: UE (User Equipment) connected to AN (Access Network) via N1; AN connected to AMF (Access and Management Function) via N2; AMF connected to I-SMF (Intermediate SMF) via N11; I-SMF connected to SMF (SMF) via N16a; SMF connected to PSA1 (PDN Gateway) via N4; PSA1 connected to DN (Data Network) via N6; UL CL/BP (UL CL/BP) connected to AN via N3; UL CL/BP connected to PSA1 via N9; UL CL/BP connected to PSA2 (PDN Gateway) via N9; PSA2 connected to DN via N6. Dashed lines represent N4 interfaces: UE to AMF (N1), AN to AMF (N2), I-SMF to UL CL/BP (N4), SMF to PSA1 (N4), and SMF to PSA2 (N4).](72b43e2f42ffc000f9f9b21bff9b6191_img.jpg) + +Figure D.1-1: UL CL/BP and PSA2 model for N4 information exchanged over N16a. The diagram shows a network architecture with the following components and interfaces: UE (User Equipment) connected to AN (Access Network) via N1; AN connected to AMF (Access and Management Function) via N2; AMF connected to I-SMF (Intermediate SMF) via N11; I-SMF connected to SMF (SMF) via N16a; SMF connected to PSA1 (PDN Gateway) via N4; PSA1 connected to DN (Data Network) via N6; UL CL/BP (UL CL/BP) connected to AN via N3; UL CL/BP connected to PSA1 via N9; UL CL/BP connected to PSA2 (PDN Gateway) via N9; PSA2 connected to DN via N6. Dashed lines represent N4 interfaces: UE to AMF (N1), AN to AMF (N2), I-SMF to UL CL/BP (N4), SMF to PSA1 (N4), and SMF to PSA2 (N4). + +**Figure D.1-1: UL CL/BP and PSA2 model for N4 information exchanged over N16a** + +The I-SMF shall translate the N4 information received from the SMF into appropriate N4 rules towards the UL CL/BP and the PSA2; the I-SMF shall merge the N4 information received for the UL CL/BP and the PSA2 if the UL CL/BP and PSA2 are located on the same UPF. + +The N4 information exchanged over N16a shall only include the rules related to the UL and DL traffic to offload via PSA2, and not include the rules to the non-offload UL and DL traffic via PSA1. The I-SMF shall generate on its own N4 rules towards the UL CL/BP for UL and DL traffic exchanged between the AN and PSA1. The PDR, FAR, URR, QER ID(s) allocated by the I-SMF and the SMF for the PFCP sessions between I-SMF and UL CL and between I-SMF and PSA2 shall be distinct; the Precedence of the PDRs set by the I-SMF and the SMF shall also be distinct (see clause D.2.1). + +All the PFCP session related messages specified in clause 7.5 shall be supported over N16a. Unless specified otherwise in this Annex, the requirements specified in the rest of this specification for PFCP session related procedures and messages are also applicable to N16a. + +None of the PFCP Node related messages specified in clause 7.4 shall be sent over N16a. PFCP Load and Overload control information shall not be exchanged over N16a. + +Data forwarding procedures (see clause 5.3) shall not be used over N16a. + +PFCP session related messages shall be sent over N16a in a binary body part of an HTTP multipart message using the Nsmf\_PDUSession as specified in 3GPP TS 29.502 [50]. The JSON body part of a HTTP multipart message shall indicate whether a given PFCP session related message relates to the UL CL/BP or to the PSA2. Presence of the DNAI IE indicates the PFCP session message relates to PSA2 and absence of the DNAI IE indicates the PFCP session message relates to UL CL/BP. + +## D.2 Procedures + +### D.2.1 Addition of PSA and UL CL/BP controlled by I-SMF + +The corresponding stage 2 call flow is specified in clause 4.23.9.1 of 3GPP TS 23.502 [29]. + +When the I-SMF decides to select a new PSA2 and/or a UL CL/BP (replacing the current I-UPF) for the PDU session, e.g. using the list of DNAI(s) of interest for this PDU Session received from the SMF, it shall establish PFCP sessions towards UL CL/BP and/or PSA2 respectively. + +The I-SMF shall allocate PDR/FAR/URR/QER ID not larger than 255 and shall set Precedence value not smaller than 65536. The SMF shall allocate PDR/FAR/URR/QER ID from 256 onwards and shall set Precedence value not larger than 65535. + +NOTE 1: Since PDRs provided by the SMF to control the traffic via PSA2 have higher precedence than PDRs generated by the I-SMF, the I-SMF need not modify the PDRs generated by its own. See the example further down. + +For the PFCP session established between I-SMF and UL CL/BP: + +- the I-SMF shall create at least a UL PDR to identify the UL traffic received from AN and a UL FAR to forward the traffic towards PSA1; +- the I-SMF shall create a DL PDR to identify the DL traffic from the PSA1 and a DL FAR to forward the traffic towards the AN; + +NOTE 2: The I-SMF needs to include DL N9 F-TEID in the SMF PDUSession Update Request sent to SMF as specified in 3GPP TS 29.502 [50]. + +For the PFCP session established between I-SMF and PSA2: + +- the I-SMF shall create at least an UL PDR to identify the UL traffic received from UL CL/BP and a UL FAR to forward the traffic towards the DN; +- the I-SMF shall create a DL PDR to identify the DL traffic from the DN and a DL FAR to forward the traffic towards the UL CL/BP; + +NOTE 3: If IPv6 multi-homing applies to the PDU session, a new IPv6 prefix can be allocated by the PSA2, which is sent in SMF PDUSession Update Request to SMF. + +Upon successful establishment of the PFCP sessions, the I-SMF indicates to the SMF that it has inserted an UL CL/BP and PSA by sending a SMF PDUSession Update Request to the SMF (see step 4 clause 4.23.9.1 of 3GPP TS 23.502 [29]). + +When the I-SMF indicates to the SMF that it has inserted an UL CL/BP and PSA, the SMF shall send two PFCP Session Establishment Requests towards the I-SMF, one targeting the UL CL/BP and another one targeting the PSA2, with the following information: + +1) PFCP Session Establishment Request for the UL CL/BP: + +- For the support of the UL traffic offloaded towards PSA2: + - one Create Traffic Endpoint IE, just including a Traffic EndPoint ID; the UL traffic endpoint corresponds to the N3 endpoint of UL CL/BP; the UL traffic endpoint shall not contain information about the N3 interface, i.e. the Network Instance IE and the Local F-TEID IE shall not be included; + - at least one Create PDR IE with: +- the Source Interface set to "Access"; +- the Traffic Endpoint IE referring to the UL traffic endpoint; +- any additional Packet Detection Information to define the UL traffic to match (e.g. SDF Filter, Application ID, Ethernet Packet Filter); +- any applicable PDR information, e.g. FAR ID, URR ID, QER ID. + +UL PDRs shall not contain the Outer Header Removal IE. + +- one UL FAR set to forward (or drop) the UL traffic, with the Destination Interface set to "Core". If more than one local PSA has been inserted by the I-SMF, the UL FAR shall indicate the Data Network Access Identifier associated to the local PSA towards which the UL traffic shall be forwarded; the UL FAR may do so otherwise. +- For the support of the DL traffic offloaded from PSA2: + - one Create Traffic Endpoint IE, including a Traffic EndPoint ID; the DL traffic endpoint shall not contain information about the N9 interface, i.e. the Network Instance IE and the Local F-TEID IE shall not be included; + - at least one Create PDR IE with: +- the Source Interface set to "Core"; +- the Traffic Endpoint IE referring to the DL traffic endpoint; + +- any applicable PDR information, e.g. FAR ID, URR ID, QER ID; + - one DL FAR set to forward (or drop) the DL traffic to the access network, with the Destination Interface set to "Access"; the DL FAR shall not contain the Outer Header Creation IE; +- NOTE 4: The I-SMF is responsible for all the N3 and N9 protocol aspects (e.g. Network Instance, Local F-TEID, outer header creation or removal). + +- any applicable QERs and/or URRs. + +## 2) PFCP Session Establishment Request for the PSA2: + +- For the support of the UL traffic offloaded at PSA2: + - one Create Traffic Endpoint IE, just including a Traffic EndPoint ID; the UL traffic endpoint shall not contain information about the N9 interface, i.e. the Network Instance IE and the Local F-TEID IE shall not be included; + - at least one Create PDR IE with: +- the Source Interface set to " Access "; +- the Traffic Endpoint IE referring to the UL traffic endpoint; +- any applicable PDR information, e.g. FAR ID, URR ID, QER ID; + +UL PDRs shall not contain the Outer Header Removal IE; + +- one UL FAR set to forward (or drop) the UL traffic, with the Destination Interface set to "Core". + - For the support of the DL traffic offloaded at PSA2: + - one Create Traffic Endpoint IE, including a Traffic EndPoint ID and any additional information to define the DL traffic endpoint (e.g. Network Instance IE, UE IP Address IE); the DL traffic endpoint corresponds to the N6 endpoint of PSA2; + - at least one Create PDR IE with: + - the Source Interface set to "Core"; + - the Traffic Endpoint IE referring to the DL traffic endpoint; + - any additional Packet Detection Information to define the DL traffic to match (e.g. SDF Filter, Application ID, Ethernet Packet Filter); + - any applicable PDR information, e.g. FAR ID, URR ID, QER ID; + - one DL FAR set to forward (or drop) the DL traffic, with the Destination Interface set to " Access "; the DL FAR shall not contain the Outer Header Creation IE. +- NOTE 5: The I-SMF is responsible for all the N3 and N9 protocol aspects (e.g. Network Instance, Local F-TEID, outer header creation or removal). +- Any applicable QERs and/or URRs. + +In the PFCP Session Establishment Request for the UL CL/BP, the SMF shall not include any N4 rules for the UL and DL traffic via PSA1 (i.e. non-offload traffic exchanged between AN and PSA1). + +The I-SMF shall translate the SMF instructions into N4 instructions to send to the UL CL/BP and PSA2, for the UL and DL traffic in one or more PFCP Session Modification Request message(s) (the I-SMF has already created a PFCP session in the UL CL/BP and PSA2 in steps 2 and 3 of Figure 4.23.9.1-1 of 3GPP TS 23.502 [29]). In particular: + +- the I-SMF shall map the UL and DL traffic endpoints requested to be created by the SMF in the UL CL/BP and PSA2 respectively to the UL and DL traffic endpoints created in the UL CL/BP and in PSA2 for UL and DL traffic; the I-SMF shall update the DL traffic endpoint in PSA2 if necessary, e.g. with any Framed-Route or Framed-IPv6-Route information received from the SMF; +- the I-SMF shall add the Outer Header Removal IE to the UL PDR of the UL CL/BP; +- the I-SMF shall add an Outer Header Creation IE to DL PDR(s) of the UL CL/BP to add a GTP-U header set to the 5G-AN F-TEID, and to add a Network Instance IE if needed; + +- the I-SMF shall update the UL FAR of the UL CL/BP and the DL FAR of the PSA2 with N9 protocol information, if the UL CL/BP and PSA2 are located on different UPFs; if more than one local PSA has been inserted by the I-SMF, the I-SMF shall derive the local PSA towards which the UL traffic shall be forwarded from the Data Network Access Identifier IE indicated in the UL FAR over N16a. +- the I-SMF shall overwrite the Apply Action IE of the DL FAR received from the SMF according to the User Plane connection state of the PDU session, e.g. to request the UPF to buffer packets if the PDU session is deactivated, or to forward the DL packets otherwise; +- the I-SMF shall merge the N4 information received for the UL CL/BP and the PSA2 if the UL CL/BP and PSA2 are located on the same UPF. + +The I-SMF shall return two PFCP Session Establishment Response messages to the SMF for UL CL/BP and PSA2 respectively. In the PFCP Session Establishment Response messages, the I-SMF may set the Node ID IE and UP F-SEID IE to the ones provided by the UL CL/BP and the PSA2. The Created PDR and Created Traffic Endpoint shall not be included. + +The I-SMF shall generate by itself the N4 rules to control the UL and DL traffic via PSA1 (i.e. non-offload traffic exchanged between AN and PSA1), and send such N4 rules to the UL CL/BP together with the N4 rules mapped from the N4 information sent by the SMF. + +EXAMPLE: Example of addition of PSA2 and UL CL controlled by I-SMF: + +- 1) in step 3 of clause 4.23.9.1 of 3GPP TS 23.502 [29], when establishing the PFCP session between I-SMF and UL CL/BP, the I-SMF can provide the following PDRs/FARs to the UL CL/BP: + +UL PDR1 (UL F-TEID 1 is allocated to receive UL traffic from NG-RAN ) and +UL FAR1 (forward all traffic towards PSA1); +DL PDR2 (N9 DL F-TEID is allocated to receive DL traffic from PSA1 which will be reported in SMF PDUSession Update Request towards SMF) and +DL FAR2 (forward all traffic towards NG-RAN N3 F-TEID). + +- 2) in step 2 of clause 4.23.9.1 of 3GPP TS 23.502 [29], when establishing the PFCP session between I-SMF and PSA2, the I-SMF can provide the following PDRs/FARs to PSA2: + +UL PDR1 (to receive traffic from UL CL, i.e. including the UL F-TEID of UL CL) and +UL FAR1 (forward all traffic towards DN); +DL PDR2 (to receive traffic from DN) and +DL FAR2 (forward all traffic towards UL CL's N9 DL F-TEID). + +- 3) in step 6 of clause 4.23.9.1 of 3GPP TS 23.502 [29], the SMF sends an SMF PDUSession Update Request to the I-SMF encapsulating binary encoded PFCP Session Establishment Request messages to request to offload service traffic towards PSA2, e.g. for a service which is identified by app-id 100; + +In the PFCP Session Establishment Request message for PSA2, the SMF includes: + +UL PDR 256 (where the PDI includes app-id =100) and +UL FAR 256 (forward all traffic towards DN); + +DL PDR 257 (sending traffic to UL CL, where the PDI includes app-id=100) and +DL FAR 257 (sending traffic to UL CL). + +In the PFCP Session Establishment Request message for UL CL, the SMF includes: + +UL PDR 256 (where the PDI includes app-id =100) and +UL FAR 256 (forward traffic towards PSA2); + +DL PDR 257 (identifying all traffic received from PSA2) and +DL FAR 257 (forward traffic toward access); + +- 4) in step 7 of clause 4.23.9.1 of 3GPP TS 23.502 [29], the I-SMF maps rules received in 3) in the PFCP Session Modification Request message to the PSA2, and the PDR1 and PDR2 provisioned earlier by I-SMF during the PFCP session establishment procedure will not be matched for the application traffic identified by app-id 100 due to a lower precedence. + +- 5) in step 8 of clause 4.23.9.1 of 3GPP TS 23.502 [29], the I-SMF can map rules received in 3) in the PFCP Session Modification Request message to the UL CL, the PDR1 (forwarding all traffic to PSA1) provisioned + +earlier by I-SMF during the PFCP session establishment procedure will not be matched for the application traffic identified by app-id 100 due to a lower precedence. + +## D.2.2 Removal of PSA and UL CL/BP + +The corresponding stage 2 call flow is specified in clause 4.23.9.2 of 3GPP TS 23.502 [29]. + +When the I-SMF indicates to the SMF that it is removing a UL CL/BP and PSA, the SMF shall send two PFCP Session Deletion Requests towards the I-SMF, one for the UL CL/BP and another one for the PSA2. The I-SMF shall return two PFCP Session Deletion Responses to the SMF (including usage reports if applicable, see clause 7.5.7.1). + +## D.2.3 Change of PSA + +The corresponding stage 2 call flow is specified in clause 4.23.9.3 of 3GPP TS 23.502 [29]. + +When the I-SMF indicates to the SMF a change of traffic offload, the SMF shall send a PFCP Session Establishment Request (for the new DNAI), a PFCP Session Deletion Request (for the old DNAI) towards the I-SMF, and a PFCP Session Modification Request for the UL CL/BP if needed. The I-SMF shall behave as described in clauses D.2.1 and D.2.2 and return a PFCP Session Establishment Response, a PFCP Session Deletion Response and a PFCP Session Modification Response if needed. + +## D.2.4 Traffic Usage Reporting + +The SMF may request the I-SMF to report traffic usage measurements as specified in the rest of this specification. + +The I-SMF shall report traffic usage measurements to the SMF as specified in the rest of this specification, i.e. in PFCP Session Report Request, PFCP Session Modification Response and PFCP Session Deletion Response messages. + +## D.2.5 Updating N4 information towards I-SMF + +The SMF may send PFCP Session Modification Requests with updated PFCP rules (e.g. updated PDR, QER URR), targeting the UL CL/BP or PSA2, as specified in the rest of this specification. The I-SMF shall return PFCP Session Modification Responses accordingly. + +## D.2.6 PDU session release + +Corresponding stage 2 requirements are specified in clauses 4.23.3a and 4.23.5.2 of 3GPP TS 23.502 [29]. + +If an UL/CL or BP was inserted in the data path by the I-SMF: + +- In scenarios where the I-SMF sends a Release Request to the SMF, e.g. UE deregistration procedure, the I-SMF shall first send a PFCP Session Deletion Request to the UL CL/BP and local PSA to retrieve non-zero traffic usage reports, before sending the Release Request over N16a to the SMF. If the I-SMF needs to report traffic usage measurements to the SMF for the UL CL/BP and/or for the local PSA, the I-SMF shall encapsulate one PFCP Session Report Request for the UL CL/BP and/or one PFCP Session Report Request for the local PSA in the Release Request sent over N16a to the SMF. The SMF shall encapsulate corresponding PFCP Session Report Response(s) in the Release Response. + +If more traffic usage measurements need to be reported to the SMF, the I-SMF shall send one or more Update Request(s) towards the SMF before sending a Release Request. + +Upon receiving the Release Request from the I-SMF, the SMF shall consider that the PFCP sessions between the I-SMF and UL CL/BP and local PSA have been deleted. + +- In scenarios where the I-SMF sends an Update Request to the SMF, e.g. UE initiated PDU session release, if the I-SMF needs to report traffic usage measurements to the SMF for the UL CL/BP and/or for the local PSA, the I-SMF may encapsulate one PFCP Session Report Request for the UL CL/BP and/or one PFCP Session Report Request for the local PSA in the Update Request sent over N16a to the SMF (i.e. in step 3a of Figure 4.3.4.3-1 of + +3GPP TS 23.502 [29])). If so, the SMF shall encapsulate corresponding PFCP Session Report Response(s) in the Update Response. + +The SMF shall then send two PFCP Session Deletion Requests towards the I-SMF, one for the UL CL/BP and another one for the local PSA, in the subsequent Update Request initiated by the SMF towards the I-SMF to trigger the release of the PDU session (i.e. in step 3a of Figure 4.3.4.3-1 of 3GPP TS 23.502 [29]). The I-SMF shall encapsulate corresponding PFCP Session Deletion Response(s) in the Update Response (i.e. in step 14 of Figure 4.3.4.3-1 of 3GPP TS 23.502 [29]), including usage reports if applicable, see clause 7.5.7.1. The PFCP Session Deletion Response may indicate that additional usage reports need to be signalled; if so, the I-SMF shall send additional Update Request(s) towards the SMF encapsulating PFCP Session Report Requests and the SMF shall return Update Response(s) encapsulating PFCP Session Report Responses. When the last usage report has been received, the SMF shall notify the I-SMF that the PDU session is released (in step 16a of Figure 4.3.4.3-1 of 3GPP TS 23.502 [29]). + +## D.2.7 Simultaneous change of UL CL/BP and PSA controlled by I-SMF + +The corresponding stage 2 call flow is specified in clause 4.23.9.4 of 3GPP TS 23.502 [29]. Figure D.2.7-1 specifies the details of the signalling interactions between the SMF and the I-SMF, and between the I-SMF and the UL CL/BPs and PSAs. + +![Sequence diagram showing signalling interactions for simultaneous change of UL CL/BP and PSA controlled by I-SMF. Lifelines: I-SMF, Old UL CL/BP, New UL CL/BP, Source UPF (PSA0), Target UPF (PSA2), SMF, Remote UPF (PSA1).](f06e043693c439659f060fba960881ea_img.jpg) + +``` + +sequenceDiagram + participant I-SMF + participant Old UL CL/BP + participant New UL CL/BP + participant Source UPF (PSA0) + participant Target UPF (PSA2) + participant SMF + participant Remote UPF (PSA1) + + Note left of I-SMF: Detection of no active traffic + + I-SMF->>Old UL CL/BP: 1. PFCP Session Establishment Request/Response + I-SMF->>Target UPF (PSA2): 2. PFCP Session Establishment Request/Response + I-SMF->>SMF: 3. I-SMF triggered: Nsmf_PDUSession_Update Request/Response + I-SMF->>Old UL CL/BP: 4. Nsmf_PDUSession_Update Request + I-SMF->>Target UPF (PSA2): 5. PFCP Session Modification Request/Response + I-SMF->>New UL CL/BP: 6. PFCP Session Modification Request/Response + I-SMF->>SMF: 7. Nsmf_PDUSession_Update Response + SMF->>Remote UPF (PSA1): 8. SMF update Remote UPF + I-SMF->>Old UL CL/BP: 9. PFCP Session Modification Request/Response + I-SMF->>SMF: 10. I-SMF triggered: Nsmf_PDUSession_Update Request/Response + I-SMF->>Old UL CL/BP: 11. Nsmf_PDUSession_Update Request + I-SMF->>New UL CL/BP: 12. PFCP Session Modification Request/Response + I-SMF->>Source UPF (PSA0): 13. PFCP Session Deletion Request/Response + I-SMF->>Old UL CL/BP: 14. PFCP Session Deletion Request/Response + I-SMF->>SMF: 15. Nsmf_PDUSession_Update Response + +``` + +Sequence diagram showing signalling interactions for simultaneous change of UL CL/BP and PSA controlled by I-SMF. Lifelines: I-SMF, Old UL CL/BP, New UL CL/BP, Source UPF (PSA0), Target UPF (PSA2), SMF, Remote UPF (PSA1). + +Figure D.2.7-1 – Simultaneous change of UL CL/BP and PSA controlled by I-SMF + +- 1-2. These steps are the same as described in clause D.2.1 and correspond to steps 2 and 3 of Figure 4.23.9.4-1 of 3GPP TS 23.502 [29]. +3. The I-SMF indicates to the SMF that it has inserted an UL CL/BP and PSA if both the I-SMF and the SMF support the "N9FSC" feature defined in clause 6.1.8 of 3GPP TS 29.502 [50], or the I-SMF indicates to the SMF a change of UL CL/BP and PSA if either the I-SMF or the SMF does not support the "N9FSC" feature. +4. When the I-SMF indicates to the SMF an insertion of UL CL/BP and PSA, and data forwarding between the new and old UL CL/BPs for EAS session continuity is required, the SMF shall send to the I-SMF a PFCP Session Establishment Request (for the new DNAI) and a PFCP Session Establishment Request for the new UL CL/BP. + +When the I-SMF indicates to the SMF a change of UL CL/BP and PSA, or when the I-SMF indicates to the SMF an insertion of UL CL/BP and PSA and data forwarding between the new and old UL CL/BPs for EAS session continuity is not required, the SMF shall send to the I-SMF a PFCP Session Establishment Request (for the new DNAI), a PFCP Session Deletion Request (for the old DNAI), a PFCP Session Deletion Request for the old UL CL/BP and a PFCP Session Establishment Request for the new UL CL/BP. The I-SMF shall behave as described in clauses D.2.1 and D.2.2 and return two PFCP Session Establishment Responses and two PFCP Session Deletion Responses. + +The following signalling applies if both the I-SMF and the SMF support the "N9FSC" feature and data forwarding between the new and old UL CL/BPs for EAS session continuity is required. + +Step 4 is same as described in clause D.2.1, in addition, the SMF shall send the following additional information to the I-SMF: + +- in the PFCP Session Establishment Request for the new UL CL/BP: + - Create PDR(s) IE for the UL traffic to forward to the old UL CL/BP with: + - the Source Interface set to "Access"; + - the Traffic Endpoint IE referring to the UL traffic endpoint; + - any additional Packet Detection Information to define the UL traffic to match for N9 forwarding (e.g. SDF Filter, Application ID, Ethernet Packet Filter); + - any applicable PDR information, e.g. FAR ID, QER ID; + - the UL PDR shall not contain the Outer Header Removal IE; + - the Precedence value of the above UL PDR for N9 forwarding to the old UL CL/BP shall be set to a higher precedence than the UL PDR for the new UL CL/BP to support the UL traffic offloaded towards the PSA2, if the same Packet Detection Information applies. + - one UL FAR, set to "forward" the UL traffic to the old UL CL/BP, with the Destination Interface set to "Core"; the UL FAR shall not contain the Outer Header Creation IE. +- the following additional information in the Update Request: + - the indication that a N9 forwarding tunnel between UL CLs/BPs is required; + - the list of Rule IDs pointing to the UL PDRs included in the PFCP Session Establishment Request for the new UL CL/BP to establish the UL N9 data forwarding in the new UL CL/BP; + - the value of the timer to detect the end of activity on the N9 forwarding tunnel. + +NOTE: The UL PDR(s) for UL traffic offloaded towards PSA2 will not be matched as long as the UL PDR(s) for UL traffic forwarding to the old UL CL/BP is installed in the target UL CL/BP if the same Packet Detection Information applies, since the latter PDR(s) has a higher precedence than the former. + +5. The step is same as described in clause D.2.1, i.e. the SMF updates the remote PSA (PSA1) via N4 with the DL Tunnel Info of the Target UL CL/BP for the downlink traffic. +6. The I-SMF shall map the above rules received in the PFCP Session Establishment Request message to the new UL CL/BP. In particular: + - the I-SMF shall add the Outer Header Removal IE to the UL PDR(s) of the UL CL/BP for the UL traffic to be forwarded to the old UL CL/BP; + - the I-SMF shall add an Outer Header Creation IE to the UL FAR of the UL CL/BP to add a GTP-U header set to the old N3 UL F-TEID in the old UL CL/BP if it can be reused; + - the I-SMF shall provision a DL PDR to receive DL traffic forwarded from the old UL CL/BP and a DL FAR to forward the received DL traffic towards the NG-RAN. The new UL CL/BP shall assign a new N9 DL F-TEID for the old UL CL/BP. +7. The I-SMF returns two PFCP Session Establishment Responses to the SMF. +8. The step is same as described in clause D.2.1. + +9. The I-SMF shall send the following information to the old UL CL/BP in the PFCP Session Modification Request based on the additional information received in the Update Request from the SMF and the PFCP Session Establishment Response from the new UL CL/BP: + - the I-SMF shall update the Outer Header Creation IE in the DL FAR of the old UL CL/BP to add a GTP-U header set to the F-TEID assigned by the new UL CL/BP for DL traffic forwarding; + - the I-SMF shall update the UL PDR(s) to receive UL traffic forwarded from the new UL CL/BP, if the old UL CL/BP needs to assign a new N9 DL F-TEID for the new UL CL/BP; + - instruct the old UL CL/BP to report user inactivity on the N9 forwarding tunnel by provisioning the received time in the User Plane Inactivity Timer IE (as specified in clause 5.11.2). +- If the old UL CL/BP assigns a new N9 DL F-TEID to receive the UL traffic from the new UL CL/BP, the I-SMF shall send a PFCP Session Modification Request message to the new UL CL/BP to add an Outer Header Creation IE to the UL FAR of the UL CL/BP to add a GTP-U header set to the new N9 UL F-TEID assigned by the old UL CL/BP for UL traffic forwarding, and to add a Network Instance IE if needed. +10. If the User Plane Inactivity Report is received from the old UL CL/BP due to the User Plane Inactivity Timer expires, the I-SMF indicates to the SMF that it is removing the old UL CL/BP and PSA0. + 11. The SMF shall send to the I-SMF a PFCP Session Deletion Request (for the old DNAI) and a PFCP Session Deletion Request for the old UL CL/BP. + - 12-14. The I-SMF shall remove the UL PDR(s) identified by the received Rule ID(s) in the target UL CL/BP and the PFCP sessions in old UL CL/BP/PSA0. + 15. The I-SMF returns two PFCP Session Deletion Responses to the SMF. + +## D.2.8 Simultaneous change of UL CL/BP and PSA controlled by different I-SMFs + +The corresponding stage 2 call flow is specified in clause 4.23.9.5 of 3GPP TS 23.502 [29]. Figure D.2.8-1 specifies the details of the signalling between the SMF and the I-SMF, and between the I-SMFs and the UL CL/BPs and PSAs. + +![Sequence diagram showing the simultaneous change of UL CL/BP and PSA controlled by different I-SMFs. The diagram involves eight lifelines: Source I-SMF, Old UL CL/BP, Source UPF (PSA0), Target I-SMF, New UL CL/BP, Target UPF (PSA2), SMF, and Remote UPF (PSA1). The sequence of messages is as follows: 1. PFCP Session Establishment Request/Response between Target I-SMF and New UL CL/BP; 2. PFCP Session Establishment Request/Response between Target I-SMF and Target UPF (PSA2); 3. I-SMF triggered: Nsmf_PDUSession_Update Request/Response between Target I-SMF and SMF; 4. Nsmf_PDUSession_Update Request from SMF to Target I-SMF; 5. PFCP Session Modification Request/Response between Target I-SMF and New UL CL/BP; 6. PFCP Session Modification Request/Response between Target I-SMF and Target UPF (PSA2); 7. Nsmf_PDUSession_Update Response from SMF to Target I-SMF; 8. SMF update Remote UPF (internal SMF message); 9. Nsmf_PDUSession_UpdateSMContext Request from Target I-SMF to Source I-SMF; 10. PFCP Session Modification Request/Response between Source I-SMF and Old UL CL/BP; 11. Nsmf_PDUSession_UpdateSMContext Response from Source I-SMF to Target I-SMF; 12. PFCP Session Modification Request/Response between Target I-SMF and New UL CL/BP; 13. PFCP Session Modification Request/Response between Target I-SMF and New UL CL/BP (after 'Detection of no active traffic' box); 14. I-SMF triggered: Nsmf_PDUSession_Update Request/Response between Source I-SMF and SMF; 15. Nsmf_PDUSession_Update Request from SMF to Source I-SMF; 16. PFCP Session Deletion Request/Response between Source I-SMF and Old UL CL/BP; 17. PFCP Session Deletion Request/Response between Source I-SMF and Old UL CL/BP; 18. Nsmf_PDUSession_Update Response from SMF to Source I-SMF. There are 'Detection of no active traffic' boxes between steps 11-12 and 13-14 for the Source I-SMF, and between steps 12-13 for the Target I-SMF.](ec16d4b5fcf05287a18d5a155bf7e8d7_img.jpg) + +Sequence diagram showing the simultaneous change of UL CL/BP and PSA controlled by different I-SMFs. The diagram involves eight lifelines: Source I-SMF, Old UL CL/BP, Source UPF (PSA0), Target I-SMF, New UL CL/BP, Target UPF (PSA2), SMF, and Remote UPF (PSA1). The sequence of messages is as follows: 1. PFCP Session Establishment Request/Response between Target I-SMF and New UL CL/BP; 2. PFCP Session Establishment Request/Response between Target I-SMF and Target UPF (PSA2); 3. I-SMF triggered: Nsmf\_PDUSession\_Update Request/Response between Target I-SMF and SMF; 4. Nsmf\_PDUSession\_Update Request from SMF to Target I-SMF; 5. PFCP Session Modification Request/Response between Target I-SMF and New UL CL/BP; 6. PFCP Session Modification Request/Response between Target I-SMF and Target UPF (PSA2); 7. Nsmf\_PDUSession\_Update Response from SMF to Target I-SMF; 8. SMF update Remote UPF (internal SMF message); 9. Nsmf\_PDUSession\_UpdateSMContext Request from Target I-SMF to Source I-SMF; 10. PFCP Session Modification Request/Response between Source I-SMF and Old UL CL/BP; 11. Nsmf\_PDUSession\_UpdateSMContext Response from Source I-SMF to Target I-SMF; 12. PFCP Session Modification Request/Response between Target I-SMF and New UL CL/BP; 13. PFCP Session Modification Request/Response between Target I-SMF and New UL CL/BP (after 'Detection of no active traffic' box); 14. I-SMF triggered: Nsmf\_PDUSession\_Update Request/Response between Source I-SMF and SMF; 15. Nsmf\_PDUSession\_Update Request from SMF to Source I-SMF; 16. PFCP Session Deletion Request/Response between Source I-SMF and Old UL CL/BP; 17. PFCP Session Deletion Request/Response between Source I-SMF and Old UL CL/BP; 18. Nsmf\_PDUSession\_Update Response from SMF to Source I-SMF. There are 'Detection of no active traffic' boxes between steps 11-12 and 13-14 for the Source I-SMF, and between steps 12-13 for the Target I-SMF. + +**Figure D.2.8-1 – Simultaneous change of UL CL/BP and PSA controlled by different I-SMFs** + +1-2. These steps are the same as described in clause D.2.7. + +3. The target I-SMF indicates to the SMF the insertion of UL CL/BP and PSA. + +4. The SMF shall send to the target I-SMF a PFCP Session Establishment Request (for the new DNAI) and a PFCP Session Establishment Request for the new UL CL/BP. + +In addition, to support the EAS session continuity, the SMF may send additional information to the target I-SMF as defined in step 4 of clause D.2.7. + +5-6. The target I-SMF shall behave as described in step 5 and 6 of clause D.2.7. In addition, the target I-SMF shall provision a URR with a User Plane Inactivity Timer IE in the new UL CL/BP, based on the user plane inactivity time received from the SMF, and associate it to the UL PDR(s) used detecting the UL traffic to forward towards the old UL CL/BP and the DL PDR(s) used for detecting the DL traffic from the old UL CL/BP (as specified in clause 5.11.3). + +7-8. These steps are the same as described in clause D.2.7. + +9. The target I-SMF shall send an Nsmf\_PDUSession\_UpdateSMContext Request (N9 forwarding tunnel required, target UL CL N9 forwarding tunnel info, value of the timer to detect the end of activity on the N9 forwarding tunnel to support the EAS session continuity) to the source I-SMF, as specified in clause 5.2.2.3.21 of 3GPP TS 29.502 [50]. + +10. The source I-SMF shall send the following information to the old UL CL/BP in the PFCP Session Modification Request based on the information received from the target I-SMF: + - the source I-SMF shall update the Outer Header Creation IE in the DL FAR of the old UL CL/BP to add a GTP-U header set to the F-TEID assigned by the new UL CL/BP for DL traffic forwarding; + - instruct the old UL CL/BP to report user inactivity on the N9 forwarding tunnel by provisioning the received time in the User Plane Inactivity Timer IE (as specified in clause 5.11.2). +11. The source I-SMF shall return information to the target I-SMF, e.g. F-TEID in old UL CL/BP on receiving the UL traffic from the new UL CL/BP, as specified in clause 5.2.2.3.21 of 3GPP TS 29.502 [50]. The source I-SMF may return the old N3 UL F-TEID if it can be reused or a new N9 UL F-TEID assigned by the old UL CL/BP for UL traffic forwarding. +12. The target I-SMF shall update the UL FAR of the UL PDR(s) for UL data forwarding (to the old UL CL/BP) in new UL CL/BP with the F-TEID received. +13. Upon being notified about user plane inactivity of the N9 forwarding tunnel by the new UL CL/BP, the target I-SMF shall release the UL PDR(s) for UL data forwarding (to the old UL CL/BP) and the DL PDR(s) for DL data received (from the old UL CL/BP) in the new UL CL/BP. +14. Upon being notified about user plane inactivity of the N9 forwarding tunnel by the old UL CL/BP, the source I-SMF indicates to the SMF that it is removing the old UL CL/BP and PSA0. +15. The SMF shall send to the source I-SMF a PFCP Session Deletion Request (for the old DNAI) and a PFCP Session Deletion Request for the old UL CL/BP. +- 16-17. The source I-SMF shall remove the PFCP sessions in old UL CL/BP/PSA0. +18. The source I-SMF returns two PFCP Session Deletion Responses to the SMF. + +--- + +## Annex E (Informative): Procedures Related to MPTCP Functionality + +### E.1 General + +This clause provides example MPTCP flows. + +This Annex is informative and the normative descriptions in this specification and in 3GPP TS 23.501 [28], 3GPP TS 23.502 [29] and in 3GPP TS 24.193 [59], prevail over the descriptions in this Annex if there is any difference. + +--- + +## E.2 Multipath TCP Connection Setup + +### E.2.1 General + +Multipath TCP Connection is setup between the MPTCP Client in the UE and the MPTCP Proxy in the UPF (PSA). The outgoing Multipath is initiated by the MPTCP Client in the UE towards the MPTCP Proxy in the UPF. + +NOTE: The incoming Multipath which is assumed to be initiated by the MPTCP Proxy in the UPF towards the MPTCP Client in the UE is not supported in this release of the specification. + +The RTT TCP Convert Protocol (specified in IETF RFC 8803 [60]) is used to setup Multipath TCP connection and used for data exchange. The MPTCP Proxy implements the Transport Converter functionality. + +### E.2.2 Outgoing Multipath TCP Connection Setup + +Figure E.2.2-1 describes the establishment of an outgoing multipath TCP connection through a Transport Converter. + +The MPTCP Client initiates a Multipath TCP connection towards the Transport Converter, by sending a SYN with the MP\_CAPABLE option (MPC in Figure E.2.2-1). The SYN includes the address and port number of the Server (i.e. remote host), that are extracted by the Transport Converter and used to initiate a Multipath TCP connection towards this Server. As the Server does not support Multipath TCP, it replies with a SYN+ACK that does not contain the MP\_CAPABLE option. The Transport Converter notes that the connection with the Server does not support Multipath TCP and returns the extended TCP header received from the Server to the Client. + +![Diagram illustrating the Outgoing Converter-Assisted Multipath TCP Connection Setup. It shows two light blue rectangular boxes representing the MPTCP Client and the Transport Converter. A blue arrow points from the client to the converter, representing the initial SYN packet with the MP_CAPABLE option. Vertical lines extend downwards from each box, representing the connection paths to the network.](d39bf9db880dcbdd181b1ef80491d21c_img.jpg) + +Diagram illustrating the Outgoing Converter-Assisted Multipath TCP Connection Setup. It shows two light blue rectangular boxes representing the MPTCP Client and the Transport Converter. A blue arrow points from the client to the converter, representing the initial SYN packet with the MP\_CAPABLE option. Vertical lines extend downwards from each box, representing the connection paths to the network. + +**Figure E.2.2-1 – Outgoing Converter-Assisted Multipath TCP Connection Setup** + +## E.2.3 Incoming Multipath TCP Connection Setup + +Incoming Multipath TCP Connection Setup as described in clause 5.2 of IETF RFC 8803 [60] is not supported in this release of the specification. + +## E.2.4 MPTCP Session Entry Stored in MPTCP Proxy + +Once Multipath TCP Connection is successfully setup between the MPTCP Client in the UE and the MPTCP Proxy in the UPF, the MPTCP Proxy stores the MPTCP session entry in its storage. + +The MPTCP session entry includes the following information: + +- MPTCP link-specific multipath IP address and the associated TCP ports; +- UE's MA-PDU session IP address and its TCP port, if the MA-PDU session IP address is used by MPTCP Proxy for IP translation; +- N6 routable IP address and its TCP port, if N6 routable IP address is used by the MPTCP Proxy for IP translation; +- the remote host IP address and its TCP port. + +The stored MPTCP session entry is used by the MPTCP Proxy for IP translation when receiving uplink or downlink MPTCP traffic. + +--- + +## E.3 IP Translation Procedure + +### E.3.1 General + +On receiving uplink or downlink MPTCP traffic, the UPF internally forwards the MPTCP traffic to the MPTCP Proxy. The MPTCP Proxy detects the MPTCP traffic is for data exchange, and performs IP translation before sending out the translated MPTCP traffic. + +Figure E.3.1-1 illustrates the IP translation model for uplink and downlink MPTCP traffics, both on the UE side and the UPF side. + +![Figure E.3.1-1 IP Translation Model diagram showing traffic flow between UE, RAN, and UPF with IP translation details.](39e4a7d7b06791117dcacd19cedb400b_img.jpg) + +The diagram illustrates the IP translation model for MPTCP traffic. It shows three main components: UE (User Equipment), RAN (Radio Access Network), and UPF (UPF). The UE contains an Application Layer, MPTCP Functionality in UE (MPTCP Client), Non-3GPP access, and 3GPP access. The UPF contains DL PDR + MAR, MPTCP Functionality in UPF (MPTCP Proxy), and UL PDR. The RAN is positioned between the UE and the UPF. + +**Legend:** + +- IP@1 = MPTCP link-specific IP@ over N3GPP +- IP@2 = MPTCP link-specific IP@ over 3GPP +- IP@3 = IP@ of MA-PDU (or N6 routable IP@) +- RH@ = Remote Host IP@ +- MPP@ = MPTCP Proxy IP@ +- Uplink Traffic (blue arrows) +- Downlink Traffic (red arrows) + +**Traffic Flow:** + +- Uplink (blue arrows):** + - From Application Layer to MPTCP Functionality in UE: src=IP@3, des=RH@ + - From MPTCP Functionality in UE to Non-3GPP access: src=IP@1, des=MPP@ + - From MPTCP Functionality in UE to 3GPP access: src=IP@2, des=MPP@ + - From Non-3GPP access to RAN: src=IP@1, des=MPP@ + - From 3GPP access to RAN: src=IP@2, des=MPP@ + - From RAN to UPF: src=IP@2, des=MPP@ + - From UPF to DL PDR + MAR: src=IP@3, des=RH@ +- Downlink (red arrows):** + - From DL PDR + MAR to MPTCP Functionality in UPF: src=RH@, des=IP@3 + - From MPTCP Functionality in UPF to UL PDR: src=MPP@, des=IP@2 + - From UL PDR to RAN: src=MPP@, des=IP@1 + - From RAN to Non-3GPP access: src=MPP@, des=IP@1 + - From RAN to 3GPP access: src=MPP@, des=IP@2 + - From 3GPP access to MPTCP Functionality in UE: src=MPP@, des=IP@2 + - From Non-3GPP access to MPTCP Functionality in UE: src=MPP@, des=IP@1 + - From MPTCP Functionality in UE to Application Layer: src=RH@, des=IP@3 + +Figure E.3.1-1 IP Translation Model diagram showing traffic flow between UE, RAN, and UPF with IP translation details. + +Figure E.3.1-1 IP Translation Model + +When UE's MA-PDU session IP address is used by MPTCP Proxy for IP translation, port collision and port exhaustion can potentially occur because the UE also uses the MA-PDU session IP address for non-MPTCP traffic. To avoid this, an N6 routable IP address can be used by the MPTCP Proxy for IP translation, based on the UPF implementation. + +## E.3.2 IP Translation on Uplink IP Packets + +Once uplink MPTCP traffic is detected by the UPF, the UPF internally forwards the uplink IP packets to the MPTCP Proxy. + +The MPTCP Proxy performs IP translation to the uplink IP packets, based on the stored MPTCP session entry: + +- replace the source IP address and port, from the UE's MPTCP link-specific multipath IP@ and its ports, to the UE's MA-PDU session IP@ and its port (or N6 routable IP@ and its port); +- replace the destination IP address and port, from the MPTCP Proxy IP@ and its port, to the remote host IP@ and its port. + +After performing IP translation, the MPTCP Proxy forwards the translated uplink IP packets to N6 interface. + +## E.3.3 IP Translation on Downlink IP Packets + +Once downlink MPTCP traffic is detected by the UPF, the UPF internally forwards the downlink IP packets to the MPTCP Proxy. + +The MPTCP Proxy performs IP translation to the downlink IP packets, based on the stored MPTCP session entry: + +- replace the source IP address and port, from the remote host IP@ and its port, to the MPTCP Proxy IP@ and its port; +- replace the destination IP address and port, from the UE's MA-PDU session IP@ and its port (or N6 routable IP@ and its port), to the UE's MPTCP link-specific multipath IP@ and its port. + +After performing IP translation, the MPTCP Proxy forwards the translated downlink IP packets to N3 or N9 interface. + +## Annex F (Informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|---------------|-----------|------|-----|-----|------------------------------------------------------------------------------------|--------| +| 2016-07 | CT4#74 | C4-164286 | | | | First version after CT4#74 | 0.1.0 | +| 2016-10 | CT4#74
bis | C4-165318 | | | | Version after CT4#74bis | 0.2.0 | +| 2016-11 | CT4#75 | C4-166347 | | | | Version after CT4#75 | 0.3.0 | +| 2017-01 | CT4#75
bis | C4-170124 | | | | Version after CT4#75bis | 0.4.0 | +| 2017-02 | CT4#76 | C4-171423 | | | | Version after CT4#76 | 0.5.0 | +| 2017-03 | CT#75 | CP-170016 | | | | This version was sent for information | 1.0.0 | +| 2017-04 | CT4#77 | C4-172285 | | | | Version after CT4#77 | 1.1.0 | +| 2017-05 | CT4#78 | C4-173360 | | | | Version after CT4#78 | 1.2.0 | +| 2017-06 | CT#76 | CP-171047 | | | | This version was sent for approval | 2.0.0 | +| 2017-06 | CT#76 | CP-171183 | | | | Editorial correction | 2.0.1 | +| 2017-06 | CT#76 | CP-171183 | | | | Approved in CT#76 | 14.0.0 | +| 2017-09 | CT#77 | CP-172020 | 0001 | - | | PDN Instance over Sx | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0002 | 1 | | Transport Level Marking & DL Flow Level Marking | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0003 | 2 | | Clarifications and corrections to Usage Reporting | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0004 | - | | PDN Type over Sx | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0005 | 1 | | Creating multiple PDRs in one Sx message with F-TEID allocation in UP function | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0006 | 1 | | Message with a rejection cause | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0007 | - | | Corrections to the number of Fixed Octets | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0008 | 1 | | QER correlation ID | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0009 | 3 | | Sx Protocol extension to support Envelope Reporting | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0010 | 1 | | OCI Flags | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0011 | 2 | | IP Address(es) and TEIDs of a UP function | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0012 | 1 | | Clarification on bearer of a PDN connection and description on UP function feature | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0013 | 2 | | Clarification on Rule IDs | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0014 | 1 | | Clarification on creating rules | 14.1.0 | +| 2017-09 | CT#77 | CP-172020 | 0018 | 2 | | URR and QER handling | 14.1.0 | +| 2017-12 | CT#78 | CP-173023 | 0026 | 4 | | Reporting User Plane Inactivity | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0027 | - | | Reporting of Usage Reports to the CP function | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0028 | - | | Suspend and Resume Notification procedures | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0029 | - | | Network Instance parameter | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0030 | 1 | | User Plane traffic handling upon reaching quotas based on operator policies | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0031 | - | | Reduced Application Detection Information for Envelope Reporting | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0034 | 3 | | Sx protocol extension to support Credit Pool | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0035 | - | | Clarification on the Setting of Precedence | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0036 | 1 | | Presence of UP F-SEID in Sx Session Establishment Response | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0042 | 1 | | Change the Title of the TS | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0043 | 1 | | Clarification on Create PDR and Create FAR IEs in Sx Session Establishment Request | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0047 | 1 | | Outer Header Creation | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0048 | 1 | | Clarification on presence of Activate Predefined Rule Name | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0056 | - | | Correction on Load Control Information IE Type value | 14.2.0 | +| 2017-12 | CT#78 | CP-173023 | 0058 | 2 | | Provisioning of Subsequent Time Quota and Subsequent Volume Quota | 14.2.0 | +| 2017-12 | CT#78 | CP-173027 | 0032 | | | Quota Action to apply upon reaching quotas | 15.0.0 | +| 2017-12 | CT#78 | CP-173036 | 0033 | 2 | | SGW/PGW selection for NR | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0037 | 2 | | Update of the TS to prepare it for 5GC/N4 | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0038 | 1 | | Update introduction clause to 5GC | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0039 | 2 | | Update on general procedures for N4 | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0040 | 1 | | Node related Messages supported on N4 interface | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0041 | 1 | | User plane reporting | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0049 | 2 | | Session establishment on N4 | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0050 | 2 | | Session Modification on N4 | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0051 | 1 | | Session deletion on N4 | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0052 | 2 | | Session Reporting on N4 | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0053 | 2 | | Load-overload control on N4 | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0054 | 2 | | QOS enhancements on N4 for 5G | 15.0.0 | +| 2018-03 | CT#79 | CP-180018 | 0062 | 1 | | PDR with multiple SDFs | 15.1.0 | +| 2018-03 | CT#79 | CP-180018 | 0064 | 1 | | Bidirectional SDF Filters | 15.1.0 | +| 2018-03 | CT#79 | CP-180018 | 0066 | - | | Source and Destination Interface setting for Indirect Data Forwarding | 15.1.0 | +| 2018-03 | CT#79 | CP-180018 | 0068 | 2 | | Correlating additional usage reports with the query URR request | 15.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|-----------------------------------------------------------------------------------|--------| +| 2018-03 | CT#79 | CP-180019 | 0071 | 5 | | PDI optimisation | 15.1.0 | +| 2018-03 | CT#79 | CP-180018 | 0078 | | | Corrections to the Association Setup, Update and Release Procedures | 15.1.0 | +| 2018-03 | CT#79 | CP-180018 | 0087 | 1 | | Error correction for Cause IE and Online-Charging Call Flow Alternative 2 example | 15.1.0 | +| 2018-03 | CT#79 | CP-180019 | 0075 | 1 | | Missing Feature Description on Transport Level Marking | 15.1.0 | +| 2018-03 | CT#79 | CP-180026 | 0055 | 6 | | Support of Ethernet frames on N4 | 15.1.0 | +| 2018-03 | CT#79 | CP-180026 | 0059 | 4 | | N4 alignment | 15.1.0 | +| 2018-03 | CT#79 | CP-180026 | 0060 | - | | Reporting User Plane Inactivity on N4 | 15.1.0 | +| 2018-03 | CT#79 | CP-180026 | 0079 | 1 | | Adding QFIs to the Packet Detection Information | 15.1.0 | +| 2018-03 | CT#79 | CP-180020 | 0069 | 1 | | Condition correction for SGW-U/PGW-U selection based on DCNR | 15.1.0 | +| 2018-03 | CT#79 | CP-180020 | 0076 | 2 | | Selection of SGW-C/PGW-C for Dual Connectivity with NR | 15.1.0 | +| 2018-06 | CT#80 | CP-181119 | 0093 | 2 | | Clarification of volume-based measurement report from UP to CP | 15.2.0 | +| 2018-06 | CT#80 | CP-181119 | 0095 | - | | Usage reports queried by the CP function | 15.2.0 | +| 2018-06 | CT#80 | CP-181119 | 0103 | 1 | | Linked URR | 15.2.0 | +| 2018-06 | CT#80 | CP-181119 | 0106 | 1 | | Duplicating the user plane packets to multiple destinations | 15.2.0 | +| 2018-06 | CT#80 | CP-181119 | 0108 | 2 | | The Source Interface in the User Plane IP Resource Information | 15.2.0 | +| 2018-06 | CT#80 | CP-181125 | 0097 | 2 | | Quota Action Buffering | 15.2.0 | +| 2018-06 | CT#80 | CP-181125 | 0100 | 1 | | Quota Action to apply upon reaching quotas | 15.2.0 | +| 2018-06 | CT#80 | CP-181125 | 0104 | 1 | | The report and update of a URR | 15.2.0 | +| 2018-06 | CT#80 | CP-181132 | 0089 | 1 | | User ID | 15.2.0 | +| 2018-06 | CT#80 | CP-181132 | 0090 | 1 | | PDN Type of ethernet | 15.2.0 | +| 2018-06 | CT#80 | CP-181132 | 0091 | 1 | | Update attributes in QER | 15.2.0 | +| 2018-06 | CT#80 | CP-181132 | 0101 | - | | Ethernet traffic | 15.2.0 | +| 2018-06 | CT#80 | CP-181132 | 0111 | 1 | | Resolve editor's notes | 15.2.0 | +| 2018-06 | CT#80 | CP-181132 | 0112 | 1 | | PDR for Ethernet PDU session | 15.2.0 | +| 2018-06 | CT#80 | CP-181132 | 0113 | 1 | | Reporting of UE MAC addresses to the SMF | 15.2.0 | +| 2018-09 | CT#81 | CP-182079 | 0118 | 2 | | Essential correction on UE IP address | 15.3.0 | +| 2018-09 | CT#81 | CP-182079 | 0120 | 1 | | Essential correction on Monitoring Time | 15.3.0 | +| 2018-09 | CT#81 | CP-182079 | 0122 | 1 | | Essential clarification on the CHOOSE bit in F-TEID IE | 15.3.0 | +| 2018-09 | CT#81 | CP-182079 | 0124 | 2 | | Essential correction on the Forward Policy | 15.3.0 | +| 2018-09 | CT#81 | CP-182079 | 0128 | 2 | | Usage Report Trigger IMMER | 15.3.0 | +| 2018-09 | CT#81 | CP-182079 | 0132 | 1 | | Essential clarification on the zero quota | 15.3.0 | +| 2018-09 | CT#81 | CP-182079 | 0134 | 1 | | Essential clarification on the provision of several SDF filters in a PDI | 15.3.0 | +| 2018-09 | CT#81 | CP-182079 | 0142 | 3 | | Event reporting | 15.3.0 | +| 2018-09 | CT#81 | CP-182079 | 0154 | 2 | | Application detection report when the PFDs are removed | 15.3.0 | +| 2018-09 | CT#81 | CP-182079 | 0158 | 1 | | Essential correction on reporting the usage | 15.3.0 | +| 2018-09 | CT#81 | CP-182079 | 0160 | 1 | | Essential clarification on the provision of SDF filter | 15.3.0 | +| 2018-09 | CT#81 | CP-182079 | 0162 | 2 | | Essential correction on the Dropped DL Traffic Threshold | 15.3.0 | +| 2018-09 | CT#81 | CP-182068 | 0136 | 1 | | Add support for 5G Trace | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0137 | - | | QFI in Downlink Data Report | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0138 | 1 | | User ID extensions | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0139 | 2 | | Framed Routing | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0143 | - | | 5GS restoration procedures | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0144 | 1 | | Uplink Classifier and Branching Point functionalities | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0145 | 1 | | Pause of charging. | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0146 | 2 | | Data forwarding | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0147 | 1 | | Sending of endmarker packets in 5GC | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0148 | 1 | | Predefined Rules PCC/ADC Rules | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0149 | 1 | | Downlink Data Notification Delay | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0150 | 1 | | Clarification on Editor's notes and cleanup of the specification. | 15.3.0 | +| 2018-09 | CT#81 | CP-182076 | 0152 | 3 | | Linked usage report | 15.3.0 | +| 2018-12 | CT#82 | CP-183103 | 0166 | 1 | | Clarification on UL/DL MBR | 15.4.0 | +| 2018-12 | CT#82 | CP-183103 | 0171 | 2 | | Forwarding End Marker | 15.4.0 | +| 2018-12 | CT#82 | CP-183103 | 0173 | 1 | | Reapplying Thresholds | 15.4.0 | +| 2018-12 | CT#82 | CP-183103 | 0175 | 1 | | Support of event based reporting for charging | 15.4.0 | +| 2018-12 | CT#82 | CP-183103 | 0177 | 1 | | Usage Report Sequence Number Starting Value | 15.4.0 | +| 2018-12 | CT#82 | CP-183103 | 0179 | 1 | | Transport Level Marking | 15.4.0 | +| 2018-12 | CT#82 | CP-183103 | 0181 | 2 | | Correction on the support of PGW Pause of Charging | 15.4.0 | +| 2018-12 | CT#82 | CP-183103 | 0183 | 1 | | Network Instance in relation to IP Address | 15.4.0 | +| 2018-12 | CT#82 | CP-183103 | 0185 | - | | Time of First (Last) Packet | 15.4.0 | +| 2018-12 | CT#82 | CP-183103 | 0187 | 1 | | Outer Header Removal for IPv4v6 GTP-U tunnel | 15.4.0 | +| 2018-12 | CT#82 | CP-183103 | 0203 | 1 | | Essential correction on the start point of time based measurement | 15.4.0 | +| 2018-12 | CT#82 | CP-183103 | 0205 | 2 | | FAR for HTTP Redirection | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0163 | 1 | | Cleanup and Alignment | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0169 | 6 | | VLAN Tag support in outer header creation | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0191 | 1 | | The VIDs handling in N4 aligned with 23.501 | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0193 | - | | QFI Correction | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0194 | 1 | | Clarification to ARP / IPv6 ND Proxying | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0195 | 6 | | Adding Averaging Window parameter on N4 | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0196 | 4 | | Adding 5G Session-AMBR | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0197 | 1 | | Paging Policy Differentiation in 5GC | 15.4.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|--------------------------------------------------------------------------------------------|--------| +| 2018-12 | CT#82 | CP-183092 | 0198 | 3 | | Clarification on forwarding user plane data via a shared Sx-u tunnel | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0199 | 1 | | 5G UPF Introduction | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0206 | 2 | | PFD Procedure | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0209 | 1 | | Traffic steering control with AF provided N6 traffic routing information | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0210 | 2 | | Data forwarding between 5GS and EPS | 15.4.0 | +| 2018-12 | CT#82 | CP-183099 | 0188 | - | | Corrections for wrong references | 15.4.0 | +| 2018-12 | CT#82 | CP-183099 | 0200 | 2 | | Interpretation of predefined Rules | 15.4.0 | +| 2019-03 | CT#83 | CP-190040 | 0215 | 1 | | Clarifications to CP/UP function, Node, PFCP entity and PFCP Association concepts | 15.5.0 | +| 2019-03 | CT#83 | CP-190032 | 0211 | 1 | | (Un)solicited Application Reporting | 15.5.0 | +| 2019-03 | CT#83 | CP-190032 | 0212 | 2 | | Policy and Charging Control | 15.5.0 | +| 2019-03 | CT#83 | CP-190032 | 0213 | 1 | | Legal Interception support for 5GC SMF/UPF | 15.5.0 | +| 2019-03 | CT#83 | CP-190032 | 0216 | 1 | | PFD Contents and Management | 15.5.0 | +| 2019-03 | CT#83 | CP-190032 | 222 | 1 | | Clarification on ARP Proxy | 15.5.0 | +| 2019-03 | CT#83 | CP-190032 | 0230 | 1 | | Inactivity timer for Always-on PDU session | 15.5.0 | +| 2019-03 | CT#83 | CP-190032 | 0231 | 1 | | SMF Derivation of DSCP on N4 | 15.5.0 | +| 2019-03 | CT#83 | CP-190039 | 0217 | 2 | | Clarification on the use of Graceful Release Period | 15.5.0 | +| 2019-03 | CT#83 | CP-190039 | 0219 | 2 | | PFCP Association Release Procedure | 15.5.0 | +| 2019-03 | CT#83 | CP-190039 | 0221 | 3 | | URR triggered packets dropping or redirection | 15.5.0 | +| 2019-03 | CT#83 | CP-190039 | 0232 | 1 | | IE Name Corrections | 15.5.0 | +| 2019-06 | CT#84 | CP-191021 | 0248 | 1 | | Correct the length of redirection server address | 15.6.0 | +| 2019-06 | CT#84 | CP-191021 | 0257 | - | | Correct the length of Multiplier | 15.6.0 | +| 2019-06 | CT#84 | CP-191024 | 0235 | 1 | | Release of F-TEID by the UP Function upon removal of PDR | 15.6.0 | +| 2019-06 | CT#84 | CP-191024 | 0242 | 1 | | Essential correction on report of user plane path failure | 15.6.0 | +| 2019-06 | CT#84 | CP-191024 | 0244 | 2 | | Parameters for Performance Measurement | 15.6.0 | +| 2019-06 | CT#84 | CP-191024 | 0243 | 3 | | Accurate Interface Type for Supporting Performance Measurement | 15.6.0 | +| 2019-06 | CT#84 | CP-191024 | 0245 | 3 | | Update the redirection server address to support dual stack UE | 15.6.0 | +| 2019-06 | CT#84 | CP-191024 | 0262 | 1 | | Framed-Route and Framed-IPv6-Route in a PDR | 15.6.0 | +| 2019-06 | CT#84 | CP-191024 | 0258 | 1 | | Corrections to the Recovery Time Stamp | 15.6.0 | +| 2019-06 | CT#84 | CP-191024 | 0251 | 1 | | Matching a PFD | 15.6.0 | +| 2019-06 | CT#84 | CP-191058 | 0233 | - | | Correction to Framed Routing | 15.6.0 | +| 2019-06 | CT#84 | CP-191058 | 0260 | - | | Reverting N4 requirements for Lawful Interception support in 5GC | 15.6.0 | +| 2019-06 | CT#84 | CP-191047 | 0240 | 1 | | Enhancement to the PFCP Association Release Procedure | 16.0.0 | +| 2019-06 | CT#84 | CP-191047 | 0241 | 2 | | Deferred PDR Activation and Deactivation | 16.0.0 | +| 2019-06 | CT#84 | CP-191047 | 0263 | 1 | | Activation and Deactivation of Pre-defined PDRs | 16.0.0 | +| 2019-06 | CT#84 | CP-191050 | 0247 | 1 | | User Plane Forwarding with Control Plane CIoT 5GS Optimisation | 16.0.0 | +| 2019-06 | CT#84 | CP-191051 | 0237 | 1 | | Support for ATSSS | 16.0.0 | +| 2019-06 | CT#84 | CP-191051 | 0236 | 1 | | Update on the Packet Forwarding Model | 16.0.0 | +| 2019-06 | CT#84 | CP-191051 | 0238 | 2 | | Multi-Access Action Rule | 16.0.0 | +| 2019-06 | CT#84 | CP-191054 | 0259 | 1 | | UE IP addresses/prefixes allocation by UPF | 16.0.0 | +| 2019-06 | CT#84 | CP-191054 | 0252 | 3 | | Update the PFCP association setup to support UE IP address Allocation by AAA/DHCP | 16.0.0 | +| 2019-06 | CT#84 | CP-191055 | 0261 | 1 | | PFCP sessions successively controlled by different SMFs of a same SMF set | 16.0.0 | +| 2019-06 | CT#84 | CP-191056 | 0253 | 2 | | Update description of 5G UPF with redundant transmission | 16.0.0 | +| 2019-09 | CT#85 | CP-192129 | 0293 | 1 | | Editorial and style corrections | 16.1.0 | +| 2019-09 | CT#85 | CP-192129 | 0267 | - | | Application report when the PFDs are removed or modified | 16.1.0 | +| 2019-09 | CT#85 | CP-192129 | 0273 | 1 | | Measurement Before QoS Enforcement Clarification | 16.1.0 | +| 2019-09 | CT#85 | CP-192129 | 0274 | 1 | | Number of packets | 16.1.0 | +| 2019-09 | CT#85 | CP-192129 | 0278 | 1 | | F-TEID in a PDR | 16.1.0 | +| 2019-09 | CT#85 | CP-192129 | 0282 | - | | Clarification to C-Tag and S-Tag encoding | 16.1.0 | +| 2019-09 | CT#85 | CP-192129 | 0285 | 1 | | PFCP messages bundling | 16.1.0 | +| 2019-09 | CT#85 | CP-192096 | 0280 | - | | Essential Correction on Heartbeat procedure | 16.1.0 | +| 2019-09 | CT#85 | CP-192133 | 0271 | 1 | | Support 5G VN Group Communication – unicast traffic | 16.1.0 | +| 2019-09 | CT#85 | CP-192133 | 0272 | 1 | | Support 5G VN Group Communication – broadcast traffic | 16.1.0 | +| 2019-09 | CT#85 | CP-192133 | 0283 | 1 | | 3GPP Interface Type values | 16.1.0 | +| 2019-09 | CT#85 | CP-192194 | 0270 | 3 | | PFCP sessions controlled by different SMFs in a set | 16.1.0 | +| 2019-09 | CT#85 | CP-192194 | 0294 | - | | Support of SMF set and association establishment between SMF and UPF initiated by the UPF. | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0265 | 3 | | Enhancing UE IP address Pool Identity IE type | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0266 | 2 | | PFCP usage over N16a for the support of traffic offload by UPF controlled by I-SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192126 | 0281 | 1 | | Protocol support for Ethernet PDN in EPS | 16.1.0 | +| 2019-09 | CT#85 | CP-192187 | 0287 | 2 | | Supporting redundant transmission at transport layer Negotiation | 16.1.0 | +| 2019-09 | CT#85 | CP-192187 | 0269 | 3 | | Validity time in Create URR IE | 16.1.0 | +| 2019-12 | CT#86 | CP-193023 | 0398 | 1 | | Correct Terminology of Sx Session to PFCP Session | 16.2.0 | +| 2019-12 | CT#86 | CP-193041 | 0318 | 3 | | Correction to number of fixed octets in table 8.1.2 | 16.2.0 | +| 2019-12 | CT#86 | CP-193045 | 0277 | 3 | | Controlling of number of reports | 16.2.0 | +| 2019-12 | CT#86 | CP-193045 | 0295 | 1 | | Clarification to Create PDR/FAR/URR/QER/BAR/MAR IEs in a modification message | 16.2.0 | +| 2019-12 | CT#86 | CP-193045 | 0302 | 1 | | PFCP Association Setup Request with same Node ID | 16.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|--|------------------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193045 | 0315 | 2 | | Null Usage Report | 16.2.0 | +| 2019-12 | CT#86 | CP-193045 | 0317 | 3 | | Clarifications to Vendor-specific IE handling | 16.2.0 | +| 2019-12 | CT#86 | CP-193045 | 0329 | 2 | | Reestablishment of PFCP sessions after a UP function restart | 16.2.0 | +| 2019-12 | CT#86 | CP-193045 | 0335 | 1 | | Cause No established PFCP Association | 16.2.0 | +| 2019-12 | CT#86 | CP-193045 | 0340 | 1 | | User Plane Path Recovery Report | 16.2.0 | +| 2019-12 | CT#86 | CP-193045 | 0341 | 1 | | UE IP address allocation | 16.2.0 | +| 2019-12 | CT#86 | CP-193045 | 0342 | 4 | | Additional PFCP Session Report Request | 16.2.0 | +| 2019-12 | CT#86 | CP-193045 | 0349 | 1 | | Reporting PDR ID in a Usage Report | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0310 | 2 | | Support of IPTV service | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0327 | 1 | | IPv6 address allocation and IPv6 prefix delegation for RG connecting to 5GC | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0288 | 7 | | Small Data Rate Control Parameters | 16.2.0 | +| 2019-12 | CT#86 | CP-193050 | 0309 | 2 | | 5GS Bridge information reporting for Time Sensitive Communication | 16.2.0 | +| 2019-12 | CT#86 | CP-193050 | 0314 | 1 | | Network Instance representing the 5G VN group | 16.2.0 | +| 2019-12 | CT#86 | CP-193050 | 0316 | 1 | | Transfer of TSN bridge port management information | 16.2.0 | +| 2019-12 | CT#86 | CP-193050 | 0347 | 2 | | Reporting the clock drift between TSN and 5GS times | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0298 | 1 | | General description of ATSSS and Multi-Access Rule | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0300 | 4 | | Handling of GBR traffic of a MA PDU session | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0322 | 2 | | Session Reporting Rule | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0301 | 1 | | Access type of a MA PDU session becoming (un)available | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0304 | 4 | | ATSSS Functionality Required and ATSSS Control Parameters Returned | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0325 | 3 | | Clarifications to ATSSS feature | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0297 | 1 | | UL FAR in UL CL or BP towards Local PSA | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0306 | 2 | | Clarification on N4 Rules Exchanged via N16a Interface | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0330 | 1 | | UE IP Address Pool ID in PFCP Association Procedure | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0331 | 1 | | UE IP address Pool Identity | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0296 | 2 | | PFCP sessions successively controlled by different SMFs of an SMF set | 16.2.0 | +| 2019-12 | CT#86 | CP-193060 | 0312 | 4 | | Function description for URLLC | 16.2.0 | +| 2019-12 | CT#86 | CP-193060 | 0326 | 1 | | GTP-U Path QoS Monitoring | 16.2.0 | +| 2019-12 | CT#86 | CP-193060 | 0346 | 2 | | Per QoS Flow per UE QoS Monitoring | 16.2.0 | +| 2020-03 | CT#87e | CP-200035 | 0350 | 2 | | IETF reference update for IPv6 multicast | 16.3.0 | +| 2020-03 | CT#87e | CP-200033 | 0352 | 1 | | Support of MT-EDT | 16.3.0 | +| 2020-03 | CT#87e | CP-200033 | 0385 | 2 | | MO Exception Data Indication | 16.3.0 | +| 2020-03 | CT#87e | CP-200033 | 0386 | 2 | | Packet Rate Status Reporting and Control | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0354 | 1 | | Provision alternative SMF IP addresses of PFCP entities pertaining to the same SMF | 16.3.0 | +| 2020-03 | CT#87e | CP-200017 | 0355 | 1 | | Transferring N4 messages over N16a | 16.3.0 | +| 2020-03 | CT#87e | CP-200017 | 0388 | - | | Clarification to N4 information | 16.3.0 | +| 2020-03 | CT#87e | CP-200038 | 0357 | 4 | | Removing a URR | 16.3.0 | +| 2020-03 | CT#87e | CP-200038 | 0358 | 2 | | UPF ID | 16.3.0 | +| 2020-03 | CT#87e | CP-200038 | 0359 | 1 | | 3GPP Interface Type | 16.3.0 | +| 2020-03 | CT#87e | CP-200038 | 0360 | 2 | | Miscellaneous small corrections | 16.3.0 | +| 2020-03 | CT#87e | CP-200038 | 0361 | 1 | | The Source IP Address in Heartbeat Request message | 16.3.0 | +| 2020-03 | CT#87e | CP-200038 | 0362 | 2 | | UP function Initiated PFCP Association Release at timeout | 16.3.0 | +| 2020-03 | CT#87e | CP-200038 | 0363 | 1 | | UP function initiated PFCP session release | 16.3.0 | +| 2020-03 | CT#87e | CP-200038 | 0366 | 1 | | The Recovery Time Stamp in PFCP Session Establishment Request message | 16.3.0 | +| 2020-03 | CT#87e | CP-200038 | 0374 | 2 | | F-TEID allocation | 16.3.0 | +| 2020-03 | CT#87e | CP-200038 | 0376 | 2 | | Reflective QoS | 16.3.0 | +| 2020-03 | CT#87e | CP-200038 | 0384 | 1 | | SDF Handling when waiting for credit | 16.3.0 | +| 2020-03 | CT#87e | CP-200023 | 0364 | - | | Ethernet PDU Session Anchor Relocation | 16.3.0 | +| 2020-03 | CT#87e | CP-200023 | 0375 | 2 | | Support of Redundant Transmission | 16.3.0 | +| 2020-03 | CT#87e | CP-200031 | 0367 | 2 | | Steering Mode Value | 16.3.0 | +| 2020-03 | CT#87e | CP-200031 | 0368 | - | | Port Type of MPTCP Proxy and PMF | 16.3.0 | +| 2020-03 | CT#87e | CP-200031 | 0369 | 1 | | Apply ATSSS-LL together with MPTCP | 16.3.0 | +| 2020-03 | CT#87e | CP-200031 | 0370 | 2 | | More Description for MPTCP Functionality | 16.3.0 | +| 2020-03 | CT#87e | CP-200031 | 0381 | 1 | | Signalling to the UPF that an access of a MA PDU session is unavailable | 16.3.0 | +| 2020-03 | CT#87e | CP-200032 | 0379 | 1 | | Update of 5G VN Group Communication | 16.3.0 | +| 2020-03 | CT#87e | CP-200032 | 0380 | 1 | | TSN Domain and Time Domain | 16.3.0 | +| 2020-03 | CT#87e | CP-200032 | 0382 | 1 | | 5GS Bridge information reporting cleanup for Time Sensitive Communication | 16.3.0 | +| 2020-04 | CT#87e | | | | | Clause 5.24.3 was deleted by mistake during implementation after CT#87e | 16.3.1 | +| 2020-06 | CT#88e | CP-201029 | 0415 | 1 | | Restoring deleted statement | 16.4.0 | +| 2020-06 | CT#88e | CP-201029 | 0441 | 1 | | DL Data Notification for the subsequent DL data pertaining to a different QoS flow | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0356 | 1 | | Activating a predefined FAR/URR/QER | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0390 | - | | Miscellaneous small correction on Figures | 16.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|--|-----------------------------------------------------------------------------|--------| +| 2020-06 | CT#88e | CP-201051 | 0395 | 1 | | New S-NSSAI IE | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0396 | - | | Inconsistent description for the use of Activation/Deactivation time | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0397 | - | | F-TEID allocation cleanup | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0398 | - | | Encoding of the Remote GTP-U Peer IE | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0403 | - | | UE IP address allocation | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0404 | 1 | | UE IP address pool based on S-NSSAI | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0406 | 1 | | Report Trigger for Quota Validity Time Expiry | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0411 | 1 | | Clarification on Partial Failure of UP Function | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0413 | 2 | | Node level vs PFCP entity level procedures | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0417 | 2 | | Heartbeat procedure clarification | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0418 | 2 | | Alternative IP Address in SSET | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0419 | 2 | | Clarification when Node ID is set to an IP address | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0420 | 2 | | Association Update Response for EPFAR | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0422 | 1 | | UP function features description update | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0427 | 3 | | Downlink data reordering - new feature definition | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0438 | 2 | | UE IP address pool based on IP version | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0444 | 1 | | Remaining Quota in the UP function | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0445 | 1 | | Adjust Threshold/Quota after a usage report in the UP function | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0446 | 2 | | Quota Reporting Trigger Clarification | 16.4.0 | +| 2020-06 | CT#88e | CP-201051 | 0449 | 1 | | Editorial corrections | 16.4.0 | +| 2020-06 | CT#88e | CP-201050 | 0389 | 1 | | Support of IPUPS Functionality | 16.4.0 | +| 2020-06 | CT#88e | CP-201046 | 0391 | 3 | | First discarded downlink packet notification | 16.4.0 | +| 2020-06 | CT#88e | CP-201046 | 0392 | 2 | | Add RDS configuration information | 16.4.0 | +| 2020-06 | CT#88e | CP-201046 | 0394 | 2 | | Data rate control during mobility between 5GS and EPS | 16.4.0 | +| 2020-06 | CT#88e | CP-201046 | 0414 | 1 | | Aligning "MO Exception data" handling with stage 2 - UPF | 16.4.0 | +| 2020-06 | CT#88e | CP-201044 | 0393 | 1 | | MPTCP Indication for a Uplink PDR for traffic applicable for MPTCP | 16.4.0 | +| 2020-06 | CT#88e | CP-201044 | 0408 | 1 | | Packet Forwarding Model for MPTCP | 16.4.0 | +| 2020-06 | CT#88e | CP-201044 | 0423 | 1 | | Update IETF References for MPTCP | 16.4.0 | +| 2020-06 | CT#88e | CP-201044 | 0425 | 1 | | PMFP Message Handling | 16.4.0 | +| 2020-06 | CT#88e | CP-201044 | 0426 | 1 | | N6 Routable IP address | 16.4.0 | +| 2020-06 | CT#88e | CP-201044 | 0434 | 1 | | DL PDRs of a MA PDU session | 16.4.0 | +| 2020-06 | CT#88e | CP-201044 | 0435 | 1 | | PMF control information to enable/disable PMF RTT measurements | 16.4.0 | +| 2020-06 | CT#88e | CP-201037 | 0400 | 1 | | Redundant Transmission on transport layer | 16.4.0 | +| 2020-06 | CT#88e | CP-201045 | 0401 | 1 | | Clarification for TSN NW-TT port number | 16.4.0 | +| 2020-06 | CT#88e | CP-201045 | 0402 | 2 | | Support of QoS differentiation for NPN | 16.4.0 | +| 2020-06 | CT#88e | CP-201045 | 0436 | 1 | | 5GS Bridge ID clarification | 16.4.0 | +| 2020-06 | CT#88e | CP-201045 | 0437 | 1 | | 5GS Bridge and port information separation for Time Sensitive Communication | 16.4.0 | +| 2020-06 | CT#88e | CP-201031 | 0433 | 1 | | N4 information exchanged over N16a during PDU session release | 16.4.0 | +| 2020-06 | CT#88e | CP-201068 | 0412 | 1 | | Inter-system handover with direct data forwarding | 16.4.0 | +| 2020-06 | CT#88e | CP-201070 | 0447 | 1 | | Data Forwarding Info | 16.4.0 | +| 2020-09 | CT#89e | CP-202114 | 0466 | 2 | | Interworking between ETSUN and URLLC/TSC | 16.5.0 | +| 2020-09 | CT#89e | CP-202114 | 0475 | 1 | | End marker handling in service request procedure | 16.5.0 | +| 2020-09 | CT#89e | CP-202114 | 0482 | - | | Correcting the example of addition of PSA2 and UL CL controlled by I-SMF | 16.5.0 | +| 2020-09 | CT#89e | CP-202102 | 0471 | 3 | | Reporting UE IP Address Usage | 16.5.0 | +| 2020-09 | CT#89e | CP-202102 | 0479 | - | | Interface Type of Traffic Endpoint | 16.5.0 | +| 2020-09 | CT#89e | CP-202102 | 0484 | 2 | | SMF-Set ID in PFCP Association Messages | 16.5.0 | +| 2020-09 | CT#89e | CP-202107 | 0472 | 2 | | Correct IE Type of Redundant Transmission Parameters | 16.5.0 | +| 2020-09 | CT#89e | CP-202107 | 0473 | 1 | | Time Stamp in QoS Monitoring Report IE | 16.5.0 | +| 2020-09 | CT#89e | CP-202105 | 0474 | 1 | | Small data rate control and Serving PLMN rate control | 16.5.0 | +| 2020-09 | CT#89e | CP-202106 | 0477 | 1 | | Editor's Note on TSN Bridge Name | 16.5.0 | +| 2020-09 | CT#89e | CP-202106 | 0478 | 1 | | Editor's Note on TSN NW-TT Port relation to PDU session | 16.5.0 | +| 2020-09 | CT#89e | CP-202103 | 0480 | 1 | | IPv6 Prefix Delegation via DHCPv6 | 16.5.0 | +| 2020-12 | CT#90e | CP-203038 | 0492 | - | | Message Priority encoding | 16.6.0 | +| 2020-12 | CT#90e | CP-203038 | 0494 | 1 | | Essential clarification on the Additional Usage Reports | 16.6.0 | +| 2020-12 | CT#90e | CP-203038 | 0496 | 2 | | Essential clarification on the Framed-Route | 16.6.0 | +| 2020-12 | CT#90e | CP-203038 | 0497 | 1 | | IPv6 Prefix delegation when the UP function allocating UE IP Address | 16.6.0 | +| 2020-12 | CT#90e | CP-203038 | 0499 | 1 | | Implicitly allowing packets be forwarded via provisioning a non-zero quota | 16.6.0 | +| 2020-12 | CT#90e | CP-203038 | 0500 | 1 | | Miscellaneous corrections | 16.6.0 | +| 2020-12 | CT#90e | CP-203041 | 0501 | 2 | | Notify the discarded downlink packet | 16.6.0 | +| 2020-12 | CT#90e | CP-203042 | 0490 | - | | PFCP session used to send PMIC and BMIC | 16.6.0 | +| 2020-12 | CT#90e | CP-203042 | 0491 | - | | Removing NW-TT Port Number from Created Bridge Info for TSC IE | 16.6.0 | +| 2020-12 | CT#90e | CP-203043 | 0485 | 1 | | Replace reference draft-ietf-tcpm-converters-19 by reference to RFC 8803 | 16.6.0 | +| 2020-12 | CT#90e | CP-203043 | 0489 | 1 | | Incorrect IE type values | 16.6.0 | +| 2020-12 | CT#90e | CP-203043 | 0498 | 1 | | Procedures Related to MPTCP Functionality | 16.6.0 | +| 2020-12 | CT#90e | CP-203046 | 0487 | - | | GTP-U path interface type IE in GTP-U Path QoS Report | 16.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------|--------| +| 2020-12 | CT#90e | CP-203046 | 0488 | 3 | | QoS monitoring of a PDU session based on GTP-U path monitoring | 16.6.0 | +| 2020-12 | CT#90e | CP-203051 | 0495 | 1 | | End Marker Reception Reporting Corrections | 16.6.0 | +| 2021-03 | CT#91e | CP-210045 | 0504 | 3 | | Stop of QoS Monitoring | 16.7.0 | +| 2021-03 | CT#91e | CP-210045 | 0508 | 2 | | Usage Reporting when using Redundant Transmission on N3/N9 interfaces | 16.7.0 | +| 2021-03 | CT#91e | CP-210051 | 0509 | 1 | | Distinguishing FQ-CSIDs in PFCP messages | 16.7.0 | +| 2021-03 | CT#91e | CP-210051 | 0511 | 2 | | Essential correction on the use of the Updated PDR | 16.7.0 | +| 2021-03 | CT#91e | CP-210051 | 0512 | 1 | | Clarification on the deletion of several IEs with the same IE Type | 16.7.0 | +| 2021-03 | CT#91e | CP-210051 | 0514 | 1 | | Clarification on the FAR ID for Quota Action | 16.7.0 | +| 2021-03 | CT#91e | CP-210051 | 0515 | 1 | | Adding MAR and SRR in Failed Rule ID | 16.7.0 | +| 2021-03 | CT#91e | CP-210051 | 0518 | 2 | | Clarification on the update for a bitmap style IE | 16.7.0 | +| 2021-03 | CT#91e | CP-210051 | 0525 | 1 | | N9 forwarding tunnel removal | 16.7.0 | +| 2021-03 | CT#91e | CP-210051 | 0526 | 1 | | UE IP address / prefix Allocation | 16.7.0 | +| 2021-03 | CT#91e | CP-210051 | 0527 | 2 | | Interface Type | 16.7.0 | +| 2021-03 | CT#91e | CP-210037 | 0517 | 1 | | Essential correction on the use of null SEID | 16.7.0 | +| 2021-03 | CT#91e | CP-210049 | 0520 | 1 | | SNSSAI Update in PFCP Session Modification | 16.7.0 | +| 2021-03 | CT#91e | CP-210022 | 0506 | 1 | | Implementation of conclusions agreed for KI#3 of TR 29.820 | 17.0.0 | +| 2021-03 | CT#91e | CP-210032 | 0507 | - | | Rule activation failure | 17.0.0 | +| 2021-03 | CT#91e | CP-210032 | 0513 | 1 | | Editorial Correction | 17.0.0 | +| 2021-03 | CT#91e | CP-210032 | 0516 | 1 | | Filter ID | 17.0.0 | +| 2021-03 | CT#91e | CP-210032 | 0519 | 2 | | Addition of RAT Type IE on PFCP Interface | 17.0.0 | +| 2021-03 | CT#91e | CP-210032 | 0528 | 1 | | Support of Radius, Diameter or DHCP communication via UPF | 17.0.0 | +| 2021-03 | CT#91e | CP-210033 | 0510 | 2 | | Enhancement on the support of Pause of Charging | 17.0.0 | +| 2021-03 | CT#91e | CP-210030 | 0521 | 1 | | Partial failure handling support over N4 | 17.0.0 | +| 2021-06 | CT#92e | CP-211070 | 0543 | 1 | | Essential Clarification on PDR Provisioning and 2-Steps Packet Matching | 17.1.0 | +| 2021-06 | CT#92e | CP-211025 | 0545 | 3 | | Control of Start and Stop Usage Measurement for a PFCP session | 17.1.0 | +| 2021-06 | CT#92e | CP-211029 | 0554 | 2 | | Support of L2TP | 17.1.0 | +| 2021-06 | CT#92e | CP-211031 | 0535 | 2 | | UL packet buffering during EAS relocation | 17.1.0 | +| 2021-06 | CT#92e | CP-211033 | 0536 | 4 | | Support of thresholds in ATSSS | 17.1.0 | +| 2021-06 | CT#92e | CP-211033 | 0537 | 4 | | Steering Mode Indicator | 17.1.0 | +| 2021-06 | CT#92e | CP-211033 | 0540 | 1 | | Support of MA PDU with 3GPP access connected to EPC and Non-3GPP access connected to 5GC | 17.1.0 | +| 2021-06 | CT#92e | CP-211033 | 0551 | 1 | | Per QoS Flow Performance Measurement | 17.1.0 | +| 2021-06 | CT#92e | CP-211035 | 0529 | - | | Generalization Time Sensitive Communication to other than IEEE TSN | 17.1.0 | +| 2021-06 | CT#92e | CP-211035 | 0530 | - | | External time and Time domain terms | 17.1.0 | +| 2021-06 | CT#92e | CP-211035 | 0548 | 1 | | Terminology of the Time Sensitive Communication MIC and Bridge ID | 17.1.0 | +| 2021-06 | CT#92e | CP-211035 | 0549 | 1 | | UE-UE communication for TSC | 17.1.0 | +| 2021-06 | CT#92e | CP-211042 | 0546 | - | | Editorial Corrections | 17.1.0 | +| 2021-06 | CT#92e | CP-211042 | 0547 | - | | Correction to interface type value | 17.1.0 | +| 2021-06 | CT#92e | CP-211043 | 0544 | 2 | | PFCP Session Set Modification to restore PFCP Sessions | 17.1.0 | +| 2021-06 | CT#92e | CP-211046 | 0539 | 1 | | Simultaneous change of Branching Point or UL CL and additional PSA | 17.1.0 | +| 2021-06 | CT#92e | CP-211059 | 0532 | 1 | | SMF and UPF behaviour in SSET / MAPS cases | 17.1.0 | +| 2021-09 | CT#93e | CP-212068 | 0575 | 1 | A | IEEE 802.1AS-2020 reference update | 17.2.0 | +| 2021-09 | CT#93e | CP-212027 | 0556 | 1 | F | Correction on references | 17.2.0 | +| 2021-09 | CT#93e | CP-212027 | 0561 | 1 | B | L2TP Corrections | 17.2.0 | +| 2021-09 | CT#93e | CP-212027 | 0562 | 1 | B | LNS Address | 17.2.0 | +| 2021-09 | CT#93e | CP-212038 | 0557 | 1 | B | PMF address information per QoS flow | 17.2.0 | +| 2021-09 | CT#93e | CP-212038 | 0563 | 2 | B | Handling of PMF Message with UE Assistance Data | 17.2.0 | +| 2021-09 | CT#93e | CP-212031 | 0564 | - | B | Edge Relocation using EAS IP address Replacement | 17.2.0 | +| 2021-09 | CT#93e | CP-212031 | 0565 | 1 | B | EAS Discovery procedure with Local DNS Server/Resolver | 17.2.0 | +| 2021-09 | CT#93e | CP-212031 | 0566 | - | B | Direct Reporting of QoS monitoring events to Local NEF or AF | 17.2.0 | +| 2021-09 | CT#93e | CP-212044 | 0558 | - | F | 5GS User Plane Node | 17.2.0 | +| 2021-09 | CT#93e | CP-212044 | 0569 | 1 | B | SNSSAI Update after EPS to 5GS Handover | 17.2.0 | +| 2021-09 | CT#93e | CP-212044 | 0570 | 1 | F | Partial Failure Information | 17.2.0 | +| 2021-09 | CT#93e | CP-212044 | 0571 | 1 | B | Add SUPI, GPSI, and PEI to User ID | 17.2.0 | +| 2021-09 | CT#93e | CP-212044 | 0572 | 1 | F | Predefined Rule Name | 17.2.0 | +| 2021-09 | CT#93e | CP-212035 | 0559 | 1 | B | Protocol impact on N4mb for 5G MBS | 17.2.0 | +| 2021-09 | CT#93e | CP-212040 | 0573 | 1 | B | Introduction of TSCTSF and other stage2 and 3 alignments | 17.2.0 | +| 2021-09 | CT#93e | | | | | Editorial corrections | 17.2.1 | +| 2021-12 | CT#94e | CP-213097 | 0560 | 2 | B | Protocol impact on N4 for 5G MBS | 17.3.0 | +| 2021-12 | CT#94e | CP-213097 | 0587 | 1 | F | 5MBS corrections | 17.3.0 | +| 2021-12 | CT#94e | CP-213093 | 0578 | 1 | F | Reference to UPF service specification | 17.3.0 | +| 2021-12 | CT#94e | CP-213099 | 0579 | 2 | B | Enabling and disabling the adjustment of DL traffic steering rules | 17.3.0 | +| 2021-12 | CT#94e | CP-213099 | 0580 | 1 | B | UPF behaviour of setting source and destination addresses of PMF message | 17.3.0 | +| 2021-12 | CT#94e | CP-213099 | 0581 | 1 | B | Condition of Inclusion of Threshold Values IE and Steering Mode Indicator IE | 17.3.0 | +| 2021-12 | CT#94e | CP-213090 | 0582 | 2 | B | Per Slice UP Resource Allocation and Usage Report | 17.3.0 | +| 2021-12 | CT#94e | CP-213090 | 0583 | 2 | B | Per Slice UE IP Address Usage Report | 17.3.0 | +| 2021-12 | CT#94e | CP-213090 | 0584 | 2 | B | Adding S-NSSAI as a factor in managing UPF resources | 17.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213101 | 0585 | - | F | Updates for Bridge/User plane Node ID configuration | 17.3.0 | +| 2021-12 | CT#94e | CP-213089 | 0589 | 1 | F | Outer Header Removal | 17.3.0 | +| 2021-12 | CT#94e | CP-213129 | 0590 | 1 | F | Usage Reporting for Monitoring Time | 17.3.0 | +| 2021-12 | CT#94e | CP-213125 | 0591 | - | F | Traffic usage reporting on Redundant Transmission at transport layer | 17.3.0 | +| 2022-03 | CT#95e | CP-220027 | 0599 | 1 | B | UE IP allocation in CP function with SSET and MPAS | 17.4.0 | +| 2022-03 | CT#95e | CP-220027 | 0602 | 2 | F | Missing Definition for Tunnel Password IE | 17.4.0 | +| 2022-03 | CT#95e | CP-220031 | 0610 | - | B | IP Address and Port number Replacement IE in EAS Discovery procedure with Local DNS Server/Resolver | 17.4.0 | +| 2022-03 | CT#95e | CP-220035 | 0592 | 1 | F | Clarification to the MBS Session N4 Information | 17.4.0 | +| 2022-03 | CT#95e | CP-220035 | 0595 | 1 | F | Associated QoS Flow | 17.4.0 | +| 2022-03 | CT#95e | CP-220035 | 0597 | - | B | Location dependent MBS service | 17.4.0 | +| 2022-03 | CT#95e | CP-220035 | 0603 | - | F | Incorrect IE Type Value - MBS Session N4 Information IE | 17.4.0 | +| 2022-03 | CT#95e | CP-220035 | 0606 | - | B | PFCP Node related messages supported over N4mb | 17.4.0 | +| 2022-03 | CT#95e | CP-220035 | 0607 | 1 | B | Mapping MBS QoS Flows to Associated QoS Flows | 17.4.0 | +| 2022-03 | CT#95e | CP-220035 | 0608 | 1 | B | User Plane (In)Activity Detection and Reporting over N4mb | 17.4.0 | +| 2022-03 | CT#95e | CP-220037 | 0600 | 1 | B | Reporting of the restart of a GTP-U entity | 17.4.0 | +| 2022-03 | CT#95e | CP-220046 | 0600 | - | B | Clarification on Allocation of Access Specific UDP Ports or MAC Addresses | 17.4.0 | +| 2022-03 | CT#95e | CP-220086 | 0593 | - | D | Editorial corrections | 17.4.0 | +| 2022-03 | CT#95e | CP-220086 | 0596 | 1 | F | Correcting PFCP Associations setup description | 17.4.0 | +| 2022-03 | CT#95e | CP-220086 | 0598 | - | F | CVLAN tag removal from DL traffic received on N6 | 17.4.0 | +| 2022-03 | CT#95e | CP-220086 | 0604 | - | F | Corrections to IE Definitions | 17.4.0 | +| 2022-03 | CT#95e | CP-220086 | 0605 | 1 | F | Return Node ID in PFCP Session Report Response | 17.4.0 | +| 2022-03 | CT#95e | CP-220086 | 0609 | 1 | F | PFCP session related procedures apply to 5GC | 17.4.0 | +| 2022-03 | CT#95e | CP-220086 | 0611 | 2 | B | Paging Policy Differentiation | 17.4.0 | +| 2022-03 | CT#95e | CP-220086 | 0612 | 1 | F | Additional Usage Reports Information | 17.4.0 | +| 2022-03 | CT#95e | CP-220086 | 0613 | 1 | B | Redirect Port Information | 17.4.0 | +| 2022-06 | CT#96 | CP-221023 | 0622 | 1 | B | Transport Level Marking information for PFCP sessions over N4mb | 17.5.0 | +| 2022-06 | CT#96 | CP-221023 | 0621 | 1 | B | MBS Session Identifier | 17.5.0 | +| 2022-06 | CT#96 | CP-221023 | 0617 | 1 | B | Restoration procedure for MB-UPF restart | 17.5.0 | +| 2022-06 | CT#96 | CP-221023 | 0616 | - | F | Incorrect references to N19mb and Nmb9 reference points | 17.5.0 | +| 2022-06 | CT#96 | CP-221023 | 0615 | - | B | DL MBS QFI Sequence Number in PDU Session Container | 17.5.0 | +| 2022-06 | CT#96 | CP-221024 | 0644 | 1 | B | Outer Header Removal for PSA UPF | 17.5.0 | +| 2022-06 | CT#96 | CP-221024 | 0637 | - | F | MB-UPF failure without restart | 17.5.0 | +| 2022-06 | CT#96 | CP-221024 | 0636 | - | F | 3GPP Interface Type extensions for MBS | 17.5.0 | +| 2022-06 | CT#96 | CP-221024 | 0635 | - | F | CP and UP function features supported over N4mb | 17.5.0 | +| 2022-06 | CT#96 | CP-221024 | 0634 | - | F | N4mb requirements for PFCP Node Related messages | 17.5.0 | +| 2022-06 | CT#96 | CP-221024 | 0633 | - | F | N4mb requirements for PFCP Session Related messages | 17.5.0 | +| 2022-06 | CT#96 | CP-221034 | 0642 | 1 | B | DNS Query Filter Encoding | 17.5.0 | +| 2022-06 | CT#96 | CP-221035 | 0630 | 1 | F | Two N3 UL CN tunnels information | 17.5.0 | +| 2022-06 | CT#96 | CP-221045 | 0619 | 1 | F | PFCP Node ID | 17.5.0 | +| 2022-06 | CT#96 | CP-221045 | 0618 | 1 | F | Failure to restore a PFCP session at UPF restart | 17.5.0 | +| 2022-06 | CT#96 | CP-221045 | 0614 | 3 | F | Node Report Type value for PFCP node reports not defined by 3GPP | 17.5.0 | +| 2022-06 | CT#96 | CP-221046 | 0646 | - | F | UE IP address | 17.5.0 | +| 2022-06 | CT#96 | CP-221046 | 0645 | 1 | F | Corrections on QoS Monitoring per QoS flow | 17.5.0 | +| 2022-06 | CT#96 | CP-221046 | 0643 | - | F | Corrections on PFCP Session Deletion Response with Additional Usage Report Info | 17.5.0 | +| 2022-06 | CT#96 | CP-221046 | 0641 | - | F | Incomplete CR implementation on Partial failure handling support over N4 | 17.5.0 | +| 2022-06 | CT#96 | CP-221046 | 0632 | 1 | F | Format of Tunnel Password | 17.5.0 | +| 2022-06 | CT#96 | CP-221046 | 0629 | 1 | F | Clarification on the Threshold and Quota | 17.5.0 | +| 2022-06 | CT#96 | CP-221046 | 0628 | - | F | Number of Reports and Monitoring Time/Measurement Before QoS Enforcement | 17.5.0 | +| 2022-06 | CT#96 | CP-221046 | 0627 | - | F | Resolving editor's note for IPUPS | 17.5.0 | +| 2022-06 | CT#96 | CP-221046 | 0626 | 1 | F | Clarification on reactivation of an inactive URR | 17.5.0 | +| 2022-06 | CT#96 | CP-221046 | 0625 | - | F | Usage Report at expiry of the Quota Validity Timer | 17.5.0 | +| 2022-06 | CT#96 | CP-221046 | 0624 | - | F | Packet Rate for N4 | 17.5.0 | +| 2022-06 | CT#96 | CP-221046 | 0623 | 1 | F | Essential Correction on the support of the SMF Set | 17.5.0 | +| 2022-06 | CT#96 | CP-221050 | 0631 | 1 | F | N9 forwarding tunnel between ULCLs controlled by I-SMF | 17.5.0 | +| 2022-06 | CT#96 | CP-221065 | 0620 | 2 | A | Time domain identification in the clock drift reporting | 17.5.0 | +| 2022-06 | CT#96 | CP-221067 | 0640 | - | A | PDRs and Traffic Endpoints in PFCP Session Modification Request and Response | 17.5.0 | +| 2022-09 | CT#97e | CP-222031 | 0649 | 2 | F | Outer header creation | 17.6.0 | +| 2022-09 | CT#97e | CP-222031 | 0650 | 2 | F | Clarifications to Add MBS Unicast Parameters | 17.6.0 | +| 2022-09 | CT#97e | CP-222031 | 0651 | 4 | F | PLLSSM and FSSM flags | 17.6.0 | +| 2022-09 | CT#97e | CP-222031 | 0653 | - | F | Ingress address over N6mb or Nmb9 | 17.6.0 | +| 2022-09 | CT#97e | CP-222031 | 0655 | 1 | F | No URR support over N4mb | 17.6.0 | +| 2022-09 | CT#97e | CP-222031 | 0656 | - | F | FSSM Flag | 17.6.0 | +| 2022-09 | CT#97e | CP-222031 | 0658 | - | F | Unicast transport is used over Nmb9 | 17.6.0 | +| 2022-09 | CT#97e | CP-222041 | 0652 | 1 | F | Corrections on applicability of Flags | 17.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2022-09 | CT#97e | CP-222041 | 0654 | 1 | F | Corrections to FQ-CSID node types | 17.6.0 | +| 2022-09 | CT#97e | CP-222041 | 0660 | - | D | Remove duplicate tables | 17.6.0 | +| 2022-09 | CT#97e | CP-222042 | 0647 | 1 | F | Uplink packets buffering during EAS relocation | 17.6.0 | +| 2022-12 | CT#98e | CP-223036 | 0665 | 1 | F | MBS Session Deactivation and (Re)activation | 17.7.0 | +| 2022-12 | CT#98e | CP-223036 | 0667 | - | F | Incorrect implementation of CR 29.244 #0650 | 17.7.0 | +| 2022-12 | CT#98e | CP-223036 | 0668 | - | F | Incomplete implementation of CR 29.244 #0658 | 17.7.0 | +| 2022-12 | CT#98e | CP-223036 | 0669 | - | F | N4 requirements for MBS session deactivation and reactivation | 17.7.0 | +| 2022-12 | CT#98e | CP-223059 | 0663 | 3 | F | Clarifications and corrections on Time Sensitive Communication | 17.7.0 | +| 2022-12 | CT#98e | CP-223059 | 0666 | 1 | F | Essential clarification on Gate Status | 17.7.0 | +| 2022-12 | CT#98e | CP-223043 | 0670 | 2 | F | L2TP tunnel failure cause | 18.0.0 | +| 2022-12 | CT#98e | | | | | Astyle of header 7.5.4.10 corrected to H4. | 18.0.1 | +| 2023-03 | CT#99 | CP-230092 | 0681 | 1 | A | QoS monitoring measurement failure | 18.1.0 | +| 2023-03 | CT#99 | CP-230040 | 0688 | 1 | B | Support IPv6 Prefix Delegation in 5GS | 18.1.0 | +| 2023-03 | CT#99 | CP-230043 | 0687 | 2 | B | Support of integration with IETF Deterministic Networking | 18.1.0 | +| 2023-03 | CT#99 | CP-230044 | 0682 | 1 | B | Metadata for Service Function Chain | 18.1.0 | +| 2023-03 | CT#99 | CP-230045 | 0674 | 1 | B | Introduction of MPQUIC Steering Functionality | 18.1.0 | +| 2023-03 | CT#99 | CP-230045 | 0678 | - | B | Introducing the Redundant steering mode | 18.1.0 | +| 2023-03 | CT#99 | CP-230049 | 0662 | 1 | F | Overhaul of 5MBS description in TS 29.244 | 18.1.0 | +| 2023-03 | CT#99 | CP-230049 | 0671 | 2 | F | Mutually exclusive flags in Apply Action IE | 18.1.0 | +| 2023-03 | CT#99 | CP-230061 | 0686 | 1 | F | Clarification of the Time Sensitive Communications and Time Synchronization | 18.1.0 | +| 2023-03 | CT#99 | CP-230069 | 0689 | - | F | Support of RAT Type with NR REDCAP | 18.1.0 | +| 2023-03 | CT#99 | CP-230097 | 0677 | 1 | F | IE Name Corrections to Framed Routing | 18.1.0 | +| 2023-06 | CT#100 | CP-231035 | 0725 | 2 | B | Direct reporting of TSC Management Information from UPF to TSN AF or TSCTSF | 18.2.0 | +| 2023-06 | CT#100 | CP-231036 | 0697 | 2 | B | N6 Jitter Measurement and Reporting and Marking End of Data Burst Indication | 18.2.0 | +| 2023-06 | CT#100 | CP-231044 | 0701 | 1 | B | UP Function Features for Time Sensitive Communication, Time Synchronization, Time Sensitive Networking and Deterministic Networking | 18.2.0 | +| 2023-06 | CT#100 | CP-231044 | 0702 | 1 | B | Support of integration with IETF Deterministic Networking | 18.2.0 | +| 2023-06 | CT#100 | CP-231045 | 0706 | 2 | F | Service Function Chaining Support | 18.2.0 | +| 2023-06 | CT#100 | CP-231046 | 0698 | 1 | B | MA-PDU with non-3GPP leg connected to ePDG/EPC while 3GPP leg connected to 5GC | 18.2.0 | +| 2023-06 | CT#100 | CP-231046 | 0713 | 1 | B | Support of MPQUIC Steering Functionality | 18.2.0 | +| 2023-06 | CT#100 | CP-231046 | 0715 | 1 | B | Support of Redundant of steering mode | 18.2.0 | +| 2023-06 | CT#100 | CP-231046 | 0719 | 1 | B | Correct IE Name in Annex E | 18.2.0 | +| 2023-06 | CT#100 | CP-231046 | 0720 | 1 | B | SMF decision of steering parameters | 18.2.0 | +| 2023-06 | CT#100 | CP-231057 | 0696 | 1 | B | Support of high data rate low latency services, XR and interactive media services | 18.2.0 | +| 2023-06 | CT#100 | CP-231057 | 0721 | 2 | B | ECN marking for L4S | 18.2.0 | +| 2023-06 | CT#100 | CP-231057 | 0722 | 1 | B | PDU Set based QoS handling | 18.2.0 | +| 2023-06 | CT#100 | CP-231057 | 0723 | - | B | Generalization of QoS monitoring control description | 18.2.0 | +| 2023-06 | CT#100 | CP-231057 | 0724 | 1 | B | Congestion information monitoring | 18.2.0 | +| 2023-06 | CT#100 | CP-231067 | 0703 | 1 | F | QoS Monitoring Reporting Type | 18.2.0 | +| 2023-06 | CT#100 | CP-231067 | 0704 | 1 | F | Clarification to the Local Ingress Tunnel IE | 18.2.0 | +| 2023-06 | CT#100 | CP-231067 | 0726 | 1 | F | Substitute FAR when exhausting a Volume Quota or a Time Quota | 18.2.0 | +| 2023-06 | CT#100 | CP-231083 | 0728 | 2 | A | Correction the format of NF Instance Id | 18.2.0 | +| 2023-06 | CT#100 | CP-231089 | 0718 | 1 | A | Extended Buffering Support in UPF | 18.2.0 | +| 2023-09 | CT#101 | CP-232038 | 0733 | 2 | B | Reporting suggestion information for QoS flow related QoS monitoring | 18.3.0 | +| 2023-09 | CT#101 | CP-232040 | 0734 | - | B | TL-Container for the support of TSN enabled Transport Network | 18.3.0 | +| 2023-09 | CT#101 | CP-232041 | 0742 | 1 | B | Remove the Editor's note on Redundant steering mode for GBR traffic | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0730 | 1 | B | Update N4 Session modification procedure to support network slice replacement feature | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0731 | 1 | B | User plane inactivity detection update | 18.3.0 | +| 2023-09 | CT#101 | CP-232051 | 0741 | 3 | B | Clarification on the 5G VN Group Communication used for PIN | 18.3.0 | +| 2023-09 | CT#101 | CP-232054 | 0735 | 1 | B | Data rate monitoring | 18.3.0 | +| 2023-09 | CT#101 | CP-232054 | 0736 | - | F | Correction to N6 Jitter measurement | 18.3.0 | +| 2023-09 | CT#101 | CP-232054 | 0737 | 1 | B | PDU Set QoS handling during Xn and N2 Handover | 18.3.0 | +| 2023-09 | CT#101 | CP-232054 | 0738 | - | F | Removal of UPF exposure of QoS Notification Control | 18.3.0 | +| 2023-09 | CT#101 | CP-232054 | 0739 | 2 | B | Exposure of congestion information | 18.3.0 | +| 2023-09 | CT#101 | CP-232054 | 0744 | 1 | B | Remove the Editor's Note of End of Data Burst Marking | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0740 | 1 | F | PFCP Error Handling Corrections | 18.3.0 | +| 2023-12 | CT#102 | CP-233032 | 0771 | 1 | B | Indication of QoS Flow associated with the default QoS Rule | 18.4.0 | +| 2023-12 | CT#102 | CP-233032 | 0776 | - | F | Correction on Reporting Urgency | 18.4.0 | +| 2023-12 | CT#102 | CP-233038 | 0750 | 1 | B | PFCP extensions for HR-SBO PDU sessions | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0767 | - | B | TL-Containers in PFCP Session Modification/Deletion Request/Response | 18.4.0 | +| 2023-12 | CT#102 | CP-233042 | 0777 | 1 | F | Correction on User Plane Node ID | 18.4.0 | +| 2023-12 | CT#102 | CP-233043 | 0752 | - | F | Incorrect implementation of CR 29.244 #0742 | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 0757 | - | D | Editorial corrections | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 0760 | 1 | F | Ethernet PDU Session Information | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------------|--------| +| 2023-12 | CT#102 | CP-233044 | 0761 | 1 | F | Averaging Window for Session AMBR on N4 | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 0762 | 1 | F | Clarification for C/S-TAG operation | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 0770 | - | F | Flow description within MBS Service Information if MBS data are transported in IP tunnel toward MB-UPF | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0781 | 1 | F | User plane inactivity timer update from SMF towards UPF | 18.4.0 | +| 2023-12 | CT#102 | CP-233047 | 0759 | 2 | B | Update to support the VN group communication without N6-based forwarding | 18.4.0 | +| 2023-12 | CT#102 | CP-233053 | 0749 | 1 | B | SMF Decision of PDU Set Handling Activation | 18.4.0 | +| 2023-12 | CT#102 | CP-233053 | 0753 | 2 | B | Traffic steering to an L4S enabled QoS flow | 18.4.0 | +| 2023-12 | CT#102 | CP-233053 | 0754 | - | B | PDU Set QoS handling during Xn and N2 Handover | 18.4.0 | +| 2023-12 | CT#102 | CP-233053 | 0755 | - | B | ECN marking during Xn and N2 Handover | 18.4.0 | +| 2023-12 | CT#102 | CP-233053 | 0756 | 1 | B | Protocol Description for End of Data Burst marking | 18.4.0 | +| 2023-12 | CT#102 | CP-233053 | 0768 | - | F | Per QoS flow data rate monitoring | 18.4.0 | +| 2023-12 | CT#102 | CP-233053 | 0769 | 3 | B | Protocol Description | 18.4.0 | +| 2023-12 | CT#102 | CP-233053 | 0772 | - | B | ECN marking during PDU session establishment procedure | 18.4.0 | +| 2023-12 | CT#102 | CP-233054 | 0751 | - | B | QoS differentiation for UEs behind RG | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 0774 | 1 | F | Populating the recovery timestamp of the remote GTP-U entity | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 0782 | - | F | Source/Destination Interface Type for Indirect DL Data Forwarding Tunnels | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29255/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29255/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8743ce0485a15459bee45903d866c3827f62ace4 --- /dev/null +++ b/raw/rel-18/29_series/29255/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:06efef3aabdb610557082f874220a21d32772c35b0ac152c543020cfa4798bd8 +size 7679 diff --git a/raw/rel-18/29_series/29255/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29255/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1440a1e3bc49cf6712ca51bf8caddf2b09c489a8 --- /dev/null +++ b/raw/rel-18/29_series/29255/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aefa2308b73bf6e79ae368a89fb87e7c2b3c38e3cd6a2844a961f14121ca67ab +size 5821 diff --git a/raw/rel-18/29_series/29255/853f59c89931a666c07903b31d098277_img.jpg b/raw/rel-18/29_series/29255/853f59c89931a666c07903b31d098277_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..16d4e08d0515fb460415a41b8e26543692a94aa2 --- /dev/null +++ b/raw/rel-18/29_series/29255/853f59c89931a666c07903b31d098277_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fa1dc375a7ca7e4261985fca091f9d17f02c4e4d499e82b8bd3a2fbe6785d605 +size 26697 diff --git a/raw/rel-18/29_series/29255/99bae07626f60f9ede10e2e387ef7051_img.jpg b/raw/rel-18/29_series/29255/99bae07626f60f9ede10e2e387ef7051_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cc3f174fb12948f6100ef56a2f4b1d6c9136eaf6 --- /dev/null +++ b/raw/rel-18/29_series/29255/99bae07626f60f9ede10e2e387ef7051_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8bd3d78e9d7e990c983730813e5b8b492f9dc4b4346495ff91473dac0b2071ab +size 7225 diff --git a/raw/rel-18/29_series/29255/a234352dfaccdc24745c88eef7724cc6_img.jpg b/raw/rel-18/29_series/29255/a234352dfaccdc24745c88eef7724cc6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3121315b12f52cb11b120acdb968aa066f11ada7 --- /dev/null +++ b/raw/rel-18/29_series/29255/a234352dfaccdc24745c88eef7724cc6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f0b3f972e9ecd33062bd37a711de46ba5e1807322f0f26ff0975735b2eb6872a +size 9836 diff --git a/raw/rel-18/29_series/29255/f6e8acf9f931452d01688d311b5c0364_img.jpg b/raw/rel-18/29_series/29255/f6e8acf9f931452d01688d311b5c0364_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..65b8d5ef3e901a4cfd9946b6b83122698efebfcc --- /dev/null +++ b/raw/rel-18/29_series/29255/f6e8acf9f931452d01688d311b5c0364_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8dd9b586e34268caa3182b94ff1ba57bf8c5dc4ad1e24966a8307b90d888d73c +size 9538 diff --git a/raw/rel-18/29_series/29255/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg b/raw/rel-18/29_series/29255/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8779fb6a070b434a26ad5267237ea7c838bd6a87 --- /dev/null +++ b/raw/rel-18/29_series/29255/fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:21f3bbef3920f23b37acd2324ec822cca183bd05eacf3b3fadcbcae3da7232e8 +size 28861 diff --git a/raw/rel-18/29_series/29256/raw.md b/raw/rel-18/29_series/29256/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..a8a7dc77695f71244219c346a5cb11f9af1f2be2 --- /dev/null +++ b/raw/rel-18/29_series/29256/raw.md @@ -0,0 +1,1155 @@ + + +# 3GPP TS 29.256 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Uncrewed Aerial Systems Network Function (UAS-NF); Aerial Management Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in small capital letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in small capital letters. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 4.1 Introduction ..... | 8 | +| 5 Services offered by the NEF (UAS-NF)..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Nnef_Authentication Service ..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 AuthenticateAuthorize Service Operation ..... | 10 | +| 5.2.2.2.1 General ..... | 10 | +| 5.2.2.3 AuthNotify Service Operation ..... | 11 | +| 5.2.2.3.1 General ..... | 11 | +| 6 API Definitions ..... | 12 | +| 6.1 Nnef_Authentication Service API..... | 12 | +| 6.1.1 Introduction ..... | 12 | +| 6.1.2 Usage of HTTP..... | 13 | +| 6.1.2.1 General..... | 13 | +| 6.1.2.2 HTTP standard headers..... | 13 | +| 6.1.2.2.1 General ..... | 13 | +| 6.1.2.2.2 Content type ..... | 13 | +| 6.1.2.3 HTTP custom headers..... | 13 | +| 6.1.3 Resources..... | 13 | +| 6.1.3.1 Overview..... | 13 | +| 6.1.3.2 Resource: uav-authentications ..... | 14 | +| 6.1.3.2.1 Description ..... | 14 | +| 6.1.3.2.2 Resource Definition..... | 14 | +| 6.1.3.2.3 Resource Standard Methods..... | 14 | +| 6.1.3.2.4 Resource Custom Operations..... | 15 | +| 6.1.5 Notifications ..... | 15 | +| 6.1.5.1 General..... | 15 | +| 6.1.5.2 Authentication Notification ..... | 16 | +| 6.1.5.2.1 Description ..... | 16 | +| 6.1.5.2.2 Target URI..... | 16 | +| 6.1.5.2.3 Standard Methods..... | 16 | +| 6.1.6 Data Model ..... | 17 | +| 6.1.6.1 General..... | 17 | +| 6.1.6.2 Structured data types..... | 17 | +| 6.1.6.2.1 Introduction ..... | 17 | +| 6.1.6.2.2 Type: UAVAuthInfo ..... | 18 | +| 6.1.6.2.3 Type: AuthNotification ..... | 19 | +| 6.1.6.2.4 Type: UAVAuthResponse..... | 20 | +| 6.1.6.2.5 Type: UAVAuthFailure..... | 21 | +| 6.1.6.2.6 Type: AuthContainer..... | 21 | +| 6.1.6.3 Simple data types and enumerations..... | 21 | +| 6.1.6.3.1 Introduction ..... | 21 | +| 6.1.6.3.2 Simple data types ..... | 22 | + +- 6.1.6.3.3 Enumeration: AuthResult..... 22 +- 6.1.6.3.4 Enumeration: NotifType ..... 22 +- 6.1.7 Error Handling..... 22 + - 6.1.7.1 General..... 22 + - 6.1.7.2 Protocol Errors ..... 22 + - 6.1.7.3 Application Errors..... 22 +- 6.1.8 Feature negotiation ..... 23 +- 6.1.9 Security ..... 23 +- 6.1.10 HTTP redirection..... 23 + +A.1 General..... 23 +A.2 Nnef\_Authentication API ..... 24 + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +**shall** indicates a mandatory requirement to do something + +**shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +**should** indicates a recommendation to do something + +**should not** indicates a recommendation not to do something + +**may** indicates permission to do something + +**need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +**can** indicates that something is possible + +**cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +**will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the UAS-NF functionality of the Nnef Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the NEF (UAS-NF). + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +The Uncrewed Aerial System Network Function (UAS-NF) provides the UAS-specific NEF services to NF service consumers (e.g. AMF, SMF). The UAS-NF is functionality within the NEF. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 23.256: "Support of Uncrewed Aerial Systems (UAS) connectivity, identification and tracking; Stage 2". +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] IETF RFC 9113: "HTTP/2". +- [9] OpenAPI Initiative, "OpenAPI 3.0.0 Specification", . +- [10] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [11] IETF RFC 9457: "Problem Details for HTTP APIs". +- [12] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [13] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [14] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [16] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +For the purposes of the present document, the terms and definitions given in 3GPP TS 23.256 [6] shall apply. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|-------------------------------------------| +| AA | Authorization/Authentication | +| BRID | Broadcast Remote Identification | +| BVLOS | Beyond Visual Line of Sight | +| C2 | Command and Control | +| NRID | Networked Remote Identification | +| PEI | Permanent Equipment Identifier | +| RID | Remote Identification | +| TPAE | Third Party Authorized Entity | +| UAS | Uncrewed Aerial System | +| UAV | Uncrewed Aerial Vehicle | +| USS | UAS Service Supplier | +| UTM | Uncrewed Aerial System Traffic Management | +| UUAA | USS UAV AA | +| UUID | Universal Unique Identifier | + +# --- 4 Overview + +## 4.1 Introduction + +Within the 5GC, the NEF (UAS-NF) offers services to the AMF, SMF, and PCF via the Nnef service based interface, and the NEF (UAS-NF) offers services to the SMF+PGW-C via the Nnef service based interface for UUAA-SM and C2 procedure supported in EPS (see 3GPP TS 23.256 [6]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the NEF (UAS-NF) and the scope of the present specification. + +![Figure 4.1-1: Reference model – NEF (UAS-NF). The diagram shows four network functions (AMF, SMF, PCF, and AF) on the left connected to a central NEF (UAS-NF) on the right. The connections are labeled N51 (AMF to NEF), N29 (SMF to NEF), N30 (PCF to NEF), and N33 (AF to NEF). The NEF (UAS-NF) is represented by a large green rectangle containing a smaller green rectangle labeled UAS-NF. The label 'Nnef' is placed between the central connection point and the NEF (UAS-NF) block.](e6df2733626a85205c1db682e6259c46_img.jpg) + +Figure 4.1-1: Reference model – NEF (UAS-NF). The diagram shows four network functions (AMF, SMF, PCF, and AF) on the left connected to a central NEF (UAS-NF) on the right. The connections are labeled N51 (AMF to NEF), N29 (SMF to NEF), N30 (PCF to NEF), and N33 (AF to NEF). The NEF (UAS-NF) is represented by a large green rectangle containing a smaller green rectangle labeled UAS-NF. The label 'Nnef' is placed between the central connection point and the NEF (UAS-NF) block. + +Figure 4.1-1: Reference model – NEF (UAS-NF) + +The functionalities supported by the NEF (UAS-NF) are listed in clause 4.3.2 of 3GPP TS 23.256 [6]. + +# 5 Services offered by the NEF (UAS-NF) + +## 5.1 Introduction + +The table 5.1-1 shows the NEF (UAS-NF) Services and Service Operations: + +Table 5.1-1 List of NEF (UAS-NF) Services + +| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | Mapped Service Operation | +|---------------------|-----------------------|---------------------|---------------------|-------------------------------------------| +| Nnef_Authentication | AuthenticateAuthorize | Request/Response | AMF, SMF, SMF+PGW-C | Nnef_Authentication_AuthenticateAuthorize | +| | Notification | Subscribe/Notify | AMF, SMF, SMF+PGW-C | Nnef_Authentication_Notification | + +## 5.2 Nnef\_Authentication Service + +### 5.2.1 Service Description + +The service allows communication of authentication and authorization messages between AMF/SMF and external AF (USS). An NF as service consumer (e.g. AMF, SMF, SMF+PGW-C) can authenticate or subscribe to receive notifications from NEF (UAS-NF) related to reauthentication, update authorization data or revoke authorization of the UAV. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The Nnef\_Authentication service supports following service operations: + +- AuthenticateAuthorize +- Notification + +#### 5.2.2.2 AuthenticateAuthorize Service Operation + +##### 5.2.2.2.1 General + +The AuthenticateAuthorize service operation is used during the following procedure: + +- UUAA-MM and UUAA-SM procedures (see 3GPP TS 23.256 [6], clause 5.2.2 and clause 5.2.3, respectively) +- C2 authorization (see 3GPP TS 23.256 [6], clause 5.2.5 and clause 5.4) + +The AuthenticateAuthorize service operation is invoked by an NF Service Consumer (e.g. an AMF, SMF, SMF+PGW-C) towards the NEF (UAS-NF), when UUAA-MM is done at 5GS registration, UUAA-SM is done at PDU session establishment, or for Authorization for C2 in 5GS or EPS. + +The NF Service Consumer (e.g. the AMF or the SMF or the SMF+PGW-C) shall send the authentication message to NEF (UAS-NF) by sending the HTTP POST request towards the UAV Authentications resource as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram showing the AuthenticateAuthorize Service Operation. An NF Service Consumer sends a POST request to the NEF (UAS-NF). The NEF responds with either a 200 OK (UAVAuthResponse) or a 4xx/5xx (ProblemDetails) or 3xx status.](7c6d9bfe9c31ce872722d60b73d20df1_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NEF (UAS-NF) + Note left of NF Service Consumer: 1. POST .../uav-authentications (UAVAuthInfo) + NF Service Consumer->>NEF (UAS-NF): Request + Note right of NEF (UAS-NF): 2a. 200 OK (UAVAuthResponse) + NEF (UAS-NF)-->>NF Service Consumer: Response + Note right of NEF (UAS-NF): 2b. 4xx/5xx (ProblemDetails) or 3xx + NEF (UAS-NF)-->>NF Service Consumer: Error/Redirect + +``` + +Sequence diagram showing the AuthenticateAuthorize Service Operation. An NF Service Consumer sends a POST request to the NEF (UAS-NF). The NEF responds with either a 200 OK (UAVAuthResponse) or a 4xx/5xx (ProblemDetails) or 3xx status. + +**Figure 5.2.2.2.1-1: AuthenticateAuthorize Service Operation** + +- The NF Service Consumer shall send a POST request to the resource representing the UAV Authentications resource of the NEF (UAS-NF) with a "UAVAuthInfo" object in the request body, including: + - gsi IE set to GPSI (in the format of External Identifier) of the UAV; + - serviceLevelId IE set to Service Level Device Identity; + - authMsg IE contains the service-level AA message + - . This IE is deprecated; the "authContainer" IE should be used instead. + - "authContainer" IE that contains one or more authentication message(s) in the AA container provided by the UE (see 3GPP TS 23.256 [6]). This IE deprecates the "authMsg" IE. + - authNotificationURI IE provides the notification URI to receive notifications related to authentication; + - authServerAddress IE provides the Authorization Server Address, e.g. Authorization Server FQDN. This IE is not included for intermediate round-trip authentication messages; + - nfType IE carries the NF type of the NF service consumer (e.g. AMF or SMF or SMF+PGW-C); and + - userLocInfo IE provides the user location information (e.g. cell Id). + +If the NF Service Consumer is SMF or SMF+PGW-C, the "UAVAuthInfo" also may include: + +- ipAddr IE carries the IP Address associated with the PDU session; +- pei IE carries the PEI; + +If the NF Service Consumer is SMF or SMF+PGW-C, for UUAA-MM and UUAA-SM procedures the "UAVAuthInfo" also may include: + +- dnn IE carries the DNN which can be used by NEF (UAS-NF) later on to create a subscription at SMF; and +- sNssai IE carries the S-NSSAI which can be used by NEF (UAS-NF) later on to create a subscription at SMF. + +2a. On success, the NEF (UAS-NF) shall store the result and return "200 OK". + +For intermediate round-trip messages, the content (i.e. UAVAuthResponse) shall contain the GPSI of the UAV and Service Level Device Identity. The content optionally includes "authContainer", see 3GPP TS 23.256 [6] for further details. + +For the final NEF (UAS-NF) to NF service consumer message, the content (i.e. UAVAuthResponse) shall contain the GPSI of the UAV, notifyCorrId attribute and "authResult" attribute. If the UAV is authenticated successfully, the NEF (UAS-NF) shall set the "authResult" attribute to "AUTH\_SUCCESS". "authMsg" and "authResult" attributes are deprecated; the attribute "authContainer" should be used instead. The content shall contain the authorized Service Level Device Identity and "authContainer" content delivering the AA result, configuration information to the UAV. The AMF forwards the message transparently to UE over NAS MM. + +2b. On failure or redirection, one of the HTTP status codes listed in Table 6.1.7.3-1 shall be returned. For a 4xx/5xx response, the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.7.3-1. + +If the NEF (UAS-NF) cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NEF (UAS-NF) shall send the HTTP error response as specified in clause 6.1.7. + +If the UAV authentication is failed, the NEF (UAS-NF) shall reject the request with an HTTP "403 Forbidden" response message including the "cause" attribute of the ProblemDetails data structure set to "AUTHENTICATION\_FAILURE". NEF (UAS-NF) shall also include an indication of uasResourceRelease received from the USS to indicate if the PDU sessions associated with the "DNN(s) subject to aerial services" can be released or not, during re-authentication failure, when the service operation is used during Re-authentication procedure. + +In above steps, while there is no expected response from the USS in the case of time out, the NEF(UAS-NF) shall return HTTP status code "504 Gateway Timeout", with the message body containing a ProblemDetails structure with the "cause" attribute set to "PEER\_NOT\_RESPONDING". + +#### 5.2.2.3 AuthNotify Service Operation + +##### 5.2.2.3.1 General + +The AuthNotify service operation is used during the following procedure: + +- USS Initiated reauthentication (see 3GPP TS 23.256 [6], clause 5.2.4) +- USS Initiated update authorization data or revoke authorization of the UAV + +The AuthNotify service operation is invoked by the NEF (UAS-NF) to inform a NF Service Consumer (e.g. AMF, SMF, SMF+PGW-C), when USS triggers reauthentication, update authorization data or revoke authorization of the UAV. NEF (UAS-NF) shall determine the NF service consumer based on the previously stored UUAA context during the successful UUAA procedure as defined in clause 5.2.2.2. + +The NEF (UAS-NF) shall send the AuthNotify request by sending the HTTP POST method towards the Notification URI as shown in Figure 5.2.2.3.1-1. + +![Sequence diagram for AuthNotify Service Operation. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'NEF(UAS-NF)' on the right. The sequence of messages is: 1. A solid arrow points from NEF(UAS-NF) to NF Service Consumer with the text '1. POST {notificationUri} (AuthNotification)'. 2a. A dashed arrow points from NF Service Consumer to NEF(UAS-NF) with the text '2a. 204 No content'. 2b. A dashed arrow points from NF Service Consumer to NEF(UAS-NF) with the text '2b. 4xx/5xx (ProblemDetails) or 3xx'.](e787e02d9214556476d95941bda1d350_img.jpg) + +``` + +sequenceDiagram + participant NEF as NEF(UAS-NF) + participant Consumer as NF Service Consumer + Note left of Consumer: + Note right of NEF: + NEF->>Consumer: 1. POST {notificationUri} (AuthNotification) + Consumer-->>NEF: 2a. 204 No content + Consumer-->>NEF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for AuthNotify Service Operation. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'NEF(UAS-NF)' on the right. The sequence of messages is: 1. A solid arrow points from NEF(UAS-NF) to NF Service Consumer with the text '1. POST {notificationUri} (AuthNotification)'. 2a. A dashed arrow points from NF Service Consumer to NEF(UAS-NF) with the text '2a. 204 No content'. 2b. A dashed arrow points from NF Service Consumer to NEF(UAS-NF) with the text '2b. 4xx/5xx (ProblemDetails) or 3xx'. + +Figure 5.2.2.3.1-1: AuthNotify Service Operation + +1. The NEF (UAS-NF) shall send a POST request towards the Notification URI received in the Authenticate service operation request (See clause 5.2.2.2.1). If the AMF for UUAA-MM has changed, the NEF (UAS-NF) + +should discover the Notification URI of the new AMF via NRF (in the default notification subscription with the "UUAA\_MM\_AUTH\_NOTIFICATION" notification type). The NEF (UAS-NF) shall be able to determine the NF type of the NF service consumer by nfType IE received in the Authenticate service operation request. The request body shall contain an "AuthNotification" object containing the reauthentication information or update authorization information or revoke authorization indication. + +When the procedure is used for reauthentication or reauthorization/update authorization information, the AuthNotification object includes: + +- the gpsi IE set to the GPSI (in the format of External Identifier) of the given UAV required to be reauthenticated; +- serviceLevelId IE set to the Service Level Device Identity of the UAV; +- authMsg IE contains the service-level AA message. This IE is deprecated; the "authContainer" IE should be used instead. +- "authContainer" IE that contains AA related data provided by the UE (see 3GPP TS 23.256 [6]). This IE deprecates the "authMsg" IE. +- notifyType IE set to REAUTH used for reauthentication and/or notifyType IE set to UPDATEAUTH used for update authorization data; and +- notifyCorrId IE set to the notification correlation ID; + +When the procedure is used for authorization revocation, the AuthNotification object includes: + +- the gpsi IE set to the GPSI (in the format of External Identifier) of the given UAV; +- serviceLevelId IE set to the Service Level Device Identity of the UAV; +- notifyType IE set to REVOKE; and +- notifyCorrId IE set to the notification correlation ID; + +2a. On success, "204 No content" shall be returned without response body. If the NF Service consumer remove the successful UUAA result during UUAA Revocation procedure, the NEF (UAS-NF) shall remove the UUAA context (see clause 5.2.7 of 3GPP TS 23.256 [6]). + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.2.3.1-3 shall be returned. For a 4xx/5xx response, the response body should contain a "ProblemDetails" object. + +If the NF service consumer cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 6.1.7. + +# --- 6 API Definitions + +## 6.1 Nnef\_Authentication Service API + +### 6.1.1 Introduction + +The Nnef\_Authentication shall use the Nnef\_Authentication API. + +The API URI of the Nnef\_Authentication API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnef-authentication". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [9] specification of HTTP messages and content bodies for the Nnef\_Authentication API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [10], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [11]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the Nnef\_Authentication API. + +![Diagram showing the resource URI structure for the Nnef_Authentication API. The root path is {apiRoot}/nnef-authentication/. A line branches from this root to a box containing the resource URI part /uav-authentications.](c52116487ab4b76a2415714183c9a14a_img.jpg) + +``` +graph TD; Root["{apiRoot}/nnef-authentication/"] --> Box["/uav-authentications"]; +``` + +Diagram showing the resource URI structure for the Nnef\_Authentication API. The root path is {apiRoot}/nnef-authentication/. A line branches from this root to a box containing the resource URI part /uav-authentications. + +**Figure 6.1.3.1-1: Resource URI structure of the Nnef\_Authentication API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------|----------------------|---------------------------------|----------------------| +| uav-authentications | /uav-authentications | POST | A UAV authentication | + +#### 6.1.3.2 Resource: uav-authentications + +The resource represents UAV Authentications to be done with the NEF (UAS-NF). + +##### 6.1.3.2.1 Description + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnef-authentication//uav-authentications + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method performs UAV authentication. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|-------------------------------------------------------| +| UAVAuthInfo | M | 1 | Represents the data to be used for UAV authentication | + +Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UAVAuthResponse | M | 1 | 200 OK | Successful request of UAV authentication and authorization. If C2 authorization request is sent during UUAA-SM, the final response indicates that at least UUAA has succeeded. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| UAVAuthFailure | O | 0..1 | 403
Forbidden | This represents that the UAV authentication is failed, the "cause" attribute of the ProblemDetails data structure set to one of the following application errors:
- AUTHENTICATION_FAILURE
- SERVICE_NOT_ALLOWED
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 504
Gateway Timeout | The "cause" attribute may be used to indicate the following application error:
- PEER_NOT_RESPONDING
See table 6.1.7.3-1 for the description of the error. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NEF (UAS-NF) or NEF (UAS-NF) (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NEF (UAS-NF) or UAS-NF/NEF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.2.4 Resource Custom Operations + +None + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +This clause specifies the notifications provided by the Nnef\_Authentication service. + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +#### 6.1.5.2 Authentication Notification + +##### 6.1.5.2.1 Description + +The NF Service Consumer (e.g. the AMF or SMF or SMF+PGW-C) provides the Notification URI for getting notified about reauthentication requested by the USS. The NEF (UAS-NF) shall notify the NF Service Consumer when reauthentication is requested by the USS. + +##### 6.1.5.2.2 Target URI + +The Notification URI "{notifUri}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables** + +| Name | Definition | +|-----------------|-----------------------------------------------| +| notificationUri | String formatted as URI with the Callback Uri | + +##### 6.1.5.2.3 Standard Methods + +###### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-2. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------| +| AuthNotification | M | 1 | Contains the reauthentication information. | + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------| +| n/a | | | 204 No Content | Successful notification of reauthentication | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected. | + +**Table 6.1.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected. | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nnef\_Authentication service based interface protocol. + +**Table 6.1.6.1-1: Nnef\_Authentication specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------|----------------|----------------------------------------------|---------------| +| UAVAuthInfo | 6.1.6.2.2 | Information within Authenticate Request | | +| AuthNotification | 6.1.6.2.3 | Information within notification | | +| UAVAuthResponse | 6.1.6.2.4 | Information within Authenticate Response | | +| UAVAuthFailure | 6.1.6.2.5 | Information within Authenticate Response | | +| AuthResult | 6.1.6.3.3 | Enumeration indicating authentication result | | +| NotifyType | 6.1.6.3.4 | Enumeration Notification type | | +| AuthContainer | 6.1.6.2.6 | Carries the AA related data | | + +Table 6.1.6.1-2 specifies data types re-used by the Nnef\_Authentication service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnef\_Authentication service based interface. + +**Table 6.1.6.1-2: Nnef\_Authentication re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|---------------------|--------------------------------------------------|---------------| +| IpAddr | 3GPP TS 29.571 [15] | IP address | | +| Pei | 3GPP TS 29.571 [15] | Permanent Equipment Identifier | | +| Uri | 3GPP TS 29.571 [15] | Uri | | +| Gpsi | 3GPP TS 29.571 [15] | GPSI | | +| ExtSnssai | 3GPP TS 29.571 [15] | Ext Snssai | | +| Dnn | 3GPP TS 29.571 [15] | DNN information | | +| UserLocation | 3GPP TS 29.571 [15] | User location | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information | | +| NFType | 3GPP TS 29.510 [14] | NF Type | | +| ReftoBinaryData | 3GPP TS 29.571 [15] | authMsg data, AA message payload data | | +| Bytes | 3GPP TS 29.571 [15] | Binary data encoded as a base64 character string | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: UAVAuthInfo + +Table 6.1.6.2.2-1: Definition of type UAVAuthInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | GPSI of the UAV | | +| serviceLevelId | string | M | 1 | Service Level Device Identity of the UAV | | +| ipAddr | IpAddr | O | 0..1 | This IE may be present if the NF Service Consumer is the SMF or SMF+PGW-C.

When present, this IE indicates the IP address associated with the PDU session. | | +| authMsg | RefToBinaryData | O | 0..1 | Contains the service-level AA message. This attribute is deprecated; the attribute "authContainer" should be used instead. | | +| authContainer | array(AuthContainer) | O | 1..N | Contains the AA related data without the "authResult" attribute. This attribute deprecates "authMsg" attribute. | | +| pei | Pei | O | 0..1 | This IE may be present if the NF Service Consumer is the SMF or SMF+PGW-C.

When present, PEI associated with the UAV. | | +| authServerAddress | string | O | 0..1 | Provides the Authorization Server Address, e.g. Authorization Server FQDN. | | +| authNotificationURI | Uri | C | 0..1 | This IE shall be present in the initial authentication message.

It carries the notification URI to receive authentication related notifications | | +| dnn | Dnn | C | 0..1 | This IE shall be present if the NF Service Consumer is the SMF or SMF+PGW-C.

When present, this IE indicates DNN associated with the PDU session. | | +| sNssai | ExtSnsai | C | 0..1 | This IE shall be present if the NF Service Consumer is the SMF.

When present, this IE indicates the S-NSSAI associated with the PDU session. | | +| ueLocInfo | UserLocation | O | 0..1 | This IE shall contain the UE location information if it is available. | | +| nfType | NFType | M | 1 | NFType of the NF service consumer.
Possible NFType values supported in this release of the specification are
  • - AMF
  • - SMF
| | + +##### 6.1.6.2.3 Type: AuthNotification + +Table 6.1.6.2.3-1: Definition of type AuthNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | GPSI of the UAV | | +| serviceLevelId | string | M | 1 | Service Level Device Identity of the UAV | | +| authMsg | RefToBinaryData | C | 0..1 | Contains the service-level AA message.
This IE may be present if the notifType is set to "UPDATEAUTH". This attribute is deprecated; the attribute "authContainer" should be used instead. | | +| authContainer | array(AuthContainer) | C | 1..N | Contains the AA related data, including optionally the "authResult" attribute. This IE shall be present if the notifType is set to "UPDATEAUTH". This attribute deprecates "authMsg" attribute. | | +| notifType | NotifType | M | 1 | This IE shall contain the notification type. | | +| notifyCorrId | string | M | 1 | This IE shall contain the Notification Correlation Id. | | + +##### 6.1.6.2.4 Type: UAVAuthResponse + +Table 6.1.6.2.4-1: Definition of type UAVAuthResponse + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | GPSI of the UAV | | +| authResult | AuthResult | C | 0..1 | This IE shall be present for the final NEF (UAS-NF) to NF service consumer message.

Conveys the UAV authentication result. This attribute is deprecated; the attribute "authContainer" should be used instead. | | +| authMsg | RefToBinaryData | O | 0..1 | Contains the service-level AA message. This attribute is deprecated; the attribute "authContainer" should be used instead. | | +| authContainer | array(AuthContainer) | C | 1..N | Contains the AA related data, including the "authResult" attribute in the final AA response. This attribute shall be present for the final AA response message. This attribute deprecates "authMsg" attribute. | | +| serviceLevelId | string | O | 0..1 | This IE contains the authorized Service Level Device Identity | | +| notifyCorrId | string | O | 0..1 | When present, this IE shall contain the Notification Correlation Id. | | + +##### 6.1.6.2.5 Type: UAVAuthFailure + +Table 6.1.6.2.5-1: Definition of type UAVAuthFailure + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| error | ProblemDetails | M | 1 | Represents the application error information. The application level error cause shall be encoded in the "cause" attribute. | | +| uasResourceRelease | boolean | C | 0..1 |

This IE shall be present and used to indicate if the PDU sessions associated with the "DNN(s) subject to aerial services" can be released or not, during re-authentication failure.

It shall be included if the "cause" attribute of the ProblemDetails data structure set to "AUTHENTICATION_FAILURE".

When present, it shall be set as follows:
- true: the PDU sessions associated with the "DNN(s) subject to aerial services" release is requested;
- false (default): the PDU sessions associated with the "DNN(s) subject to aerial services" release is not requested.

| | + +##### 6.1.6.2.6 Type: AuthContainer + +Table 6.1.6.2.6-1: Definition of type AuthContainer + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| authMsgType | Bytes | O | 0..1 | This IE, when present, carries the Service-level-AA payload type specified in clause 9.11.2.15 of 3GPP TS 24.501 [16]. | | +| authMsgPayload | RefToBinaryData | O | 0..1 | AA message payload data. | | +| authResult | AuthResult | C | 0..1 | Shall be present for the final AA response conveying the AA result. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +##### 6.1.6.3.3 Enumeration: AuthResult + +The enumeration AuthResult represents the result of authentication and/or authorization. It shall comply with the provisions defined in table 6.1.5.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration AuthResult** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------|---------------| +| "AUTH_SUCCESS" | The UAV authentication or C2 Authorization has succeeded. | | +| "AUTH_FAIL" | The UAV authentication or C2 Authorization has failed. | | + +##### 6.1.6.3.4 Enumeration: NotifType + +The enumeration NotifType represents the type of notification. It shall comply with the provisions defined in table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: Enumeration NotifType** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------|---------------| +| "REAUTH" | The UAV needs to be reauthenticated. | | +| "UPDATEAUTH" | Authorization data needs to be updated to UAV. | | +| "REVOKE" | Revoke UAV authentication and authorization | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nnef\_Authentication API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nnef\_Authentication API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nnef\_Authentication service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nnef\_Authentication service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|------------------------|---------------------|------------------------------------------------------------------------| +| AUTHENTICATION_FAILURE | 403 Forbidden | The UAV authentication is failed | +| SERVICE_NOT_ALLOWED | 403 Forbidden | UAS services not allowed | +| PEER_NOT_RESPONDING | 504 Gateway Timeout | No response is received from the remote peer (i.e. USS) when time out. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nnef\_Authentication API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [12] and 3GPP TS 29.500 [4], the access to the Nnef\_Authentication API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [13]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [14]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnef\_Authentication API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [14], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnef\_Authentication service. + +The Nnef\_Authentication API defines a single scope "nnef-authentication" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different Nnef\_Authentication service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different NEF (UAS-NF) producer instance will return the NF Instance ID of the new NEF (UAS-NF) producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an NEF (UAS-NF) redirects a service request to a different NEF (UAS-NF) using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new NEF (UAS-NF) towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format, following guidelines in 3GPP TS 29.501 [5]. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]). + +## --- A.2 Nnef\_Authentication API + +``` +openapi: 3.0.0 + +info: + title: Nnef_Authentication + version: '1.0.2' + description: | + NEF Auth Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.256 V17.3.0; 5G System;Uncrewed Aerial Systems Network Function (UAS-NF); + Aerial Management Services; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.256/ + +servers: + - url: '{apiRoot}/nnef-authentication/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnef-authentication + +paths: + /uav-authentications: + post: + summary: UAV authentication + tags: + - UAV authentication + requestBody: + description: UAV authentication + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UAVAuthInfo' + responses: + '200': + description: UAV Auth response or message exchange + content: + application/json: + schema: + $ref: '#/components/schemas/UAVAuthResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + description: UAV authentication failure + content: + application/json: + schema: + $ref: '#/components/schemas/UAVAuthFailure' +``` + +``` +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + authNotification: + '{request.body#/authNotification }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AuthNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnef-authentication: Access to the Nnef_authentication API + +schemas: +# +# STRUCTURED DATA TYPES +# + UAVAuthInfo: + description: UAV auth data + type: object + required: + - gps + - serviceLevelId + - nfType + properties: + gps: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gps' + serviceLevelId: + type: string + authNotificationURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ipAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + authServerAddress: + type: string + authMsg: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + deprecated: true + authContainer: + type: array + items: + $ref: '#/components/schemas/AuthContainer' + minItems: 1 + ueLocInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' +nfType: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + +UAVAuthResponse: + description: UAV auth response data + type: object + required: + - gpsi + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + serviceLevelId: + type: string + authMsg: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + deprecated: true + authContainer: + type: array + items: + $ref: '#/components/schemas/AuthContainer' + minItems: 1 + authResult: + allOf: + - $ref: '#/components/schemas/AuthResult' + deprecated: true + notifyCorrId: + type: string + +AuthNotification: + description: UAV related notification + type: object + required: + - gpsi + - serviceLevelId + - notifyType + - notifyCorrId + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + serviceLevelId: + type: string + notifyCorrId: + type: string + authMsg: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + deprecated: true + authContainer: + type: array + items: + $ref: '#/components/schemas/AuthContainer' + minItems: 1 + notifyType: + $ref: '#/components/schemas/NotifyType' + +UAVAuthFailure: + description: UAV auth failure + type: object + required: + - error + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + uasResourceRelease: + type: boolean + default: false + +AuthContainer: + description: Authentication/Authorization data + type: object + properties: + authMsgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + authMsgPayload: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + authResult: +``` + +``` +$ref: '#/components/schemas/AuthResult' +``` + +``` +# +``` + +``` +# SIMPLE DATA TYPES +``` + +``` +# +``` + +``` +# +``` + +``` +# ENUMERATIONS +``` + +``` +# +``` + +``` +AuthResult: + description: Enumeration representing the result of authentication and/or authorization. + anyOf: + - type: string + enum: + - AUTH_SUCCESS + - AUTH_FAIL + - type: string +NotifyType: + description: Enumeration representing the type of notification. + anyOf: + - type: string + enum: + - REAUTH + - UPDATEAUTH + - REVOKE + - type: string +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-04 | CT4#103-e | C4-212292 | | | | Initial TS skeleton. | 0.0.0 | +| 2021-04 | CT4#103-e | C4-212598 | | | | Added scope, introduction, references, and abbreviations. | 0.1.0 | +| 2021-05 | CT4#104-e | C4-213529 | | | | Aligned introduction terminology. Added, updated references. | 0.2.0 | +| 2021-08 | CT4#105-e | C4-214758 | | | | Aligned interfaces, added Nnef_Auth service. | 0.3.0 | +| 2021-10 | CT4#106-e | C4-215522 | | | | Several alignments with stage-2, clean-up, added OpenAPI for Nnef_Auth. | 0.4.0 | +| 2021-11 | CT4#107-e | C4-216474 | | | | Several further alignments with stage-2: aligned API and operation names, terminology. Further clean-up done. | 0.5.0 | +| 2021-12 | CT#94 | CP-213160 | | | | V1.0.0 presented for information | 1.0.0 | +| 2022-01 | CT4#107bis-e | C4-220456 | | | | Several consistency issues addressed. Implemented pCRs C4-220121, C4-220122, C4-220285, C4-220291, C4-220292, C4-220293, and C4-220387 | 1.1.0 | +| 2022-02 | CT4#108-e | C4-221594 | | | | Further consistency issues addressed. Implemented pCRs C4-221324, C4-221494, C4-221519, and C4-221340. | 1.2.0 | +| 2022-03 | CT#95e | CP-220109 | | | | TS presented for approval | 2.0.0 | +| 2022-03 | CT#95e | | | | | TS approved | 17.0.0 | +| 2022-06 | CT#96e | CP-221044 | 0001 | 1 | | Add Notification Correlation id | 17.1.0 | +| 2022-06 | CT#96e | CP-221044 | 0002 | 1 | | Indication of UAS service release | 17.1.0 | +| 2022-06 | CT#96e | CP-221044 | 0004 | | | Removal of revoke cause | 17.1.0 | +| 2022-06 | CT#96e | CP-221028 | 0005 | | | Remove the apiVersion placeholder from the resource URI variables table | 17.1.0 | +| 2022-06 | CT#96e | CP-221282 | 0007 | 1 | | 29.256 Rel-17 API version and External doc update | 17.1.0 | +| 2022-09 | CT#97e | CP-222036 | 0009 | | | Fix for formatting of OpenAPI description field | 17.2.0 | +| 2022-09 | CT#97e | CP-222058 | 0010 | | | 29.256 Rel-17 API version and External doc update | 17.2.0 | +| 2022-12 | CT#98e | CP-223056 | 0008 | 2 | | Corrections for Auth message type | 17.3.0 | +| 2022-12 | CT#98e | CP-223066 | 0011 | | | 29.256 Rel-17 API version and External doc update | 17.3.0 | +| 2023-03 | CT#99 | CP-230082 | 0012 | 1 | | Rejecting PDN connection for C2 communication when UAS service is not allowed | 17.4.0 | +| 2023-03 | CT#99 | CP-230068 | 0014 | | | Miscellaneous corrections | 18.0.0 | +| 2023-06 | CT#100 | CP-231027 | 0013 | 5 | F | Location header and missing Redirection clause | 18.1.0 | +| 2023-09 | CT#101 | CP-232047 | 0018 | 1 | A | Authorization Notification Callbackfor UUAA-MM after AMF Change | 18.2.0 | +| 2023-09 | CT#101 | CP-232046 | 0017 | - | B | Clarification on Direct C2 authorization procedure | 18.2.0 | +| 2023-12 | CT#102 | CP-233027 | 0020 | - | F | HTTP RFCs obsoleted by IETF RFC 9113 | 18.3.0 | +| 2023-12 | CT#102 | CP-233030 | 0021 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29257/raw.md b/raw/rel-18/29_series/29257/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..373d90211162075940771e4b18212a9f513b9d4f --- /dev/null +++ b/raw/rel-18/29_series/29257/raw.md @@ -0,0 +1,6150 @@ + + +# 3GPP TS 29.257 V18.2.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Application layer support for Uncrewed Aerial System (UAS); UAS Application Enabler (UAE) Server Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font. Below the 'P' is a red signal wave icon, and below the entire logo is the text 'A GLOBAL INITIATIVE'. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------------------------------|----| +| Foreword ..... | 9 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions, symbols and abbreviations ..... | 11 | +| 3.1 Definitions..... | 11 | +| 3.2 Symbols..... | 12 | +| 3.3 Abbreviations ..... | 12 | +| 4 Overview..... | 13 | +| 5 Services offered by the UAE Server ..... | 14 | +| 5.1 Introduction ..... | 14 | +| 5.2 UAE_C2OperationModeManagement Service..... | 14 | +| 5.2.1 Service Description ..... | 14 | +| 5.2.2 Service Operations..... | 14 | +| 5.2.2.1 Introduction..... | 14 | +| 5.2.2.2 UAE_C2OperationModeManagement_Initiate ..... | 15 | +| 5.2.2.2.1 General ..... | 15 | +| 5.2.2.2.2 C2 Operation Mode Initiation ..... | 15 | +| 5.2.2.3 UAE_C2OperationModeManagement_Notify ..... | 16 | +| 5.2.2.3.1 General ..... | 16 | +| 5.2.2.3.2 C2 Operation Mode Management Completion Notification..... | 16 | +| 5.2.2.3.3 Selected C2 Communication Mode Notification ..... | 17 | +| 5.2.2.3.4 C2 Communication Mode Switching Notification..... | 18 | +| 5.3 UAE_RealtimeUAVStatus Service..... | 20 | +| 5.3.1 Service Description ..... | 20 | +| 5.3.2 Service Operations..... | 20 | +| 5.3.2.1 Introduction..... | 20 | +| 5.3.2.2 UAE_RealtimeUAVStatus_Subscribe..... | 20 | +| 5.3.2.2.1 General ..... | 20 | +| 5.3.2.2.2 Subscribe to real-time UAV status information reporting ..... | 20 | +| 5.3.2.2.3 Update an existing real-time UAV status information reporting subscription ..... | 21 | +| 5.3.2.3 UAE_RealtimeUAVStatus_Unsubscribe ..... | 22 | +| 5.3.2.3.1 General ..... | 22 | +| 5.3.2.3.2 Unsubscribe from real-time UAV status information reporting ..... | 22 | +| 5.3.2.4 UAE_RealtimeUAVStatus_Notify ..... | 23 | +| 5.3.2.4.1 General ..... | 23 | +| 5.3.2.4.2 Real-time UAV Status Notification ..... | 23 | +| 5.4 UAE_ChangeUSSManagement Service ..... | 24 | +| 5.4.1 Service Description ..... | 24 | +| 5.4.2 Service Operations..... | 24 | +| 5.4.2.1 Introduction..... | 24 | +| 5.4.2.2 UAE_ChangeUSSManagement_ManageUSS..... | 24 | +| 5.4.2.2.1 General ..... | 24 | +| 5.4.2.2.2 USS Change Policy Creation ..... | 24 | +| 5.4.2.2.3 USS Change Policy Update..... | 25 | +| 5.4.2.2.3 USS Change Policy Deletion ..... | 26 | +| 5.4.2.3 UAE_ChangeUSSManagement_RequestUSSChange ..... | 26 | +| 5.4.2.3.1 General ..... | 26 | +| 5.4.2.3.2 USS Change Request ..... | 26 | +| 5.4.2.4 UAE_ChangeUSSManagement_Notify ..... | 27 | +| 5.4.2.4.1 General ..... | 27 | +| 5.4.2.4.2 USS Change Policy Configuration Status Notification..... | 27 | +| 5.4.2.4.3 USS Change Notification..... | 28 | +| 5.4.2.4.4 USS Change Trigger Notification..... | 29 | +| 5.5 UAE_DAASupport Service ..... | 30 | + +| | | | +|-------------|--------------------------------------------------------------|----| +| 5.5.1 | Service Description ..... | 30 | +| 5.5.2 | Service Operations..... | 30 | +| 5.5.2.1 | Introduction..... | 30 | +| 5.5.2.2 | UAE_DAASupport_Manage ..... | 30 | +| 5.5.2.2.1 | General ..... | 30 | +| 5.5.2.2.2 | DAA Policy Creation ..... | 30 | +| 5.5.2.2.3 | DAA Policy Update ..... | 31 | +| 5.5.2.2.3 | DAA Policy Deletion ..... | 32 | +| 5.5.2.3 | UAE_DAASupport_InformDAAEvent ..... | 32 | +| 5.5.2.3.1 | General ..... | 32 | +| 5.5.2.3.2 | DAA Events Information Request ..... | 32 | +| 5.5.2.4 | UAE_DAASupport_Notify ..... | 33 | +| 5.5.2.4.1 | General ..... | 33 | +| 5.5.2.4.2 | DAA Policy Configuration Completion Status Notification..... | 33 | +| 5.5.2.4.3 | DAA Event Notification..... | 34 | +| 6 | API Definitions ..... | 35 | +| 6.1 | UAE_C2OperationModeManagement Service API ..... | 35 | +| 6.1.1 | Introduction ..... | 35 | +| 6.1.2 | Usage of HTTP..... | 35 | +| 6.1.3 | Resources..... | 35 | +| 6.1.4 | Custom Operations without associated resources ..... | 35 | +| 6.1.4.1 | Overview..... | 35 | +| 6.1.4.2 | Operation: Initiate ..... | 36 | +| 6.1.4.2.1 | Description ..... | 36 | +| 6.1.4.2.2 | Operation Definition ..... | 36 | +| 6.1.5 | Notifications ..... | 37 | +| 6.1.5.1 | General..... | 37 | +| 6.1.5.2 | C2 Operation Mode Management Completion Notification ..... | 38 | +| 6.1.5.2.1 | Description ..... | 38 | +| 6.1.5.2.2 | Target URI..... | 38 | +| 6.1.5.2.3 | Standard Methods..... | 38 | +| 6.1.5.2.3.1 | POST ..... | 38 | +| 6.1.5.3 | Selected C2 Communication Mode Notification..... | 39 | +| 6.1.5.3.1 | Description ..... | 39 | +| 6.1.5.3.2 | Target URI..... | 39 | +| 6.1.5.3.3 | Standard Methods..... | 39 | +| 6.1.5.3.3.1 | POST ..... | 39 | +| 6.1.5.4 | C2 Communication Mode Switching Notification ..... | 40 | +| 6.1.5.4.1 | Description ..... | 40 | +| 6.1.5.4.2 | Target URI..... | 40 | +| 6.1.5.4.3 | Standard Methods..... | 41 | +| 6.1.5.4.3.1 | POST ..... | 41 | +| 6.1.6 | Data Model ..... | 42 | +| 6.1.6.1 | General..... | 42 | +| 6.1.6.2 | Structured data types..... | 43 | +| 6.1.6.2.1 | Introduction ..... | 43 | +| 6.1.6.2.2 | Type: ConfigureData..... | 44 | +| 6.1.6.2.3 | Type: SelectedC2CommModeNotif..... | 46 | +| 6.1.6.2.4 | Type: C2CommModeSwitchNotif..... | 46 | +| 6.1.6.2.5 | Type: C2Result..... | 47 | +| 6.1.6.2.6 | Type: UasId..... | 47 | +| 6.1.6.2.7 | Type: UavId..... | 47 | +| 6.1.6.2.8 | Type: C2ServiceArea..... | 48 | +| 6.1.6.2.9 | Type: C2OpModeMngtCompStatus ..... | 48 | +| 6.1.6.2.10 | Type: C2SwitchPolicies..... | 48 | +| 6.1.6.2.11 | Type: C2LinkQualityThrlds..... | 49 | +| 6.1.6.3 | Simple data types and enumerations..... | 49 | +| 6.1.6.3.1 | Introduction ..... | 49 | +| 6.1.6.3.2 | Simple data types ..... | 49 | +| 6.1.6.3.3 | Enumeration: C2CommMode ..... | 49 | +| 6.1.6.3.4 | Enumeration: C2CommModeSwitching ..... | 50 | + +| | | | +|-------------|----------------------------------------------------------------------------------|----| +| 6.1.6.3.5 | Enumeration: C2SwitchingCause ..... | 50 | +| 6.1.6.3.6 | Enumeration: C2OpModeStatus ..... | 51 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 51 | +| 6.1.6.5 | Binary data..... | 51 | +| 6.1.6.5.1 | Binary Data Types..... | 51 | +| 6.1.7 | Error Handling..... | 52 | +| 6.1.7.1 | General..... | 52 | +| 6.1.7.2 | Protocol Errors ..... | 52 | +| 6.1.7.3 | Application Errors..... | 52 | +| 6.1.8 | Feature negotiation ..... | 52 | +| 6.1.9 | Security..... | 52 | +| 6.2 | UAE_RealtimeUAVStatus Service API ..... | 53 | +| 6.2.1 | Introduction ..... | 53 | +| 6.2.2 | Usage of HTTP..... | 53 | +| 6.2.3 | Resources..... | 53 | +| 6.2.3.1 | Overview..... | 53 | +| 6.2.3.2 | Resource: Real-time UAV Status Subscriptions ..... | 54 | +| 6.2.3.2.1 | Description ..... | 54 | +| 6.2.3.2.2 | Resource Definition..... | 54 | +| 6.2.3.2.3 | Resource Standard Methods..... | 54 | +| 6.2.3.2.3.1 | GET ..... | 54 | +| 6.2.3.2.3.2 | POST ..... | 55 | +| 6.2.3.2.4 | Resource Custom Operations..... | 56 | +| 6.2.3.3 | Resource: Individual Real-time UAV Status Subscription..... | 56 | +| 6.2.3.3.1 | Description ..... | 56 | +| 6.2.3.3.2 | Resource Definition..... | 56 | +| 6.2.3.3.3 | Resource Standard Methods..... | 56 | +| 6.2.3.3.3.1 | GET ..... | 56 | +| 6.2.3.3.3.2 | PUT..... | 57 | +| 6.2.3.3.3.3 | DELETE ..... | 58 | +| 6.2.3.3.4 | Resource Custom Operations..... | 59 | +| 6.2.4 | Custom Operations without associated resources ..... | 59 | +| 6.2.5 | Notifications ..... | 59 | +| 6.2.5.1 | General..... | 59 | +| 6.2.5.2 | Real-time UAV Status Notification ..... | 60 | +| 6.2.5.2.1 | Description ..... | 60 | +| 6.2.5.2.2 | Target URI..... | 60 | +| 6.2.5.2.3 | Standard Methods..... | 60 | +| 6.2.5.2.3.1 | POST ..... | 60 | +| 6.2.6 | Data Model ..... | 61 | +| 6.2.6.1 | General..... | 61 | +| 6.2.6.2 | Structured data types..... | 61 | +| 6.2.6.2.1 | Introduction ..... | 61 | +| 6.2.6.2.2 | Type: RTUavStatusSubsc ..... | 62 | +| 6.2.6.2.3 | Type: RTUavStatusNotif..... | 62 | +| 6.2.6.2.4 | Type: RTUavStatus..... | 62 | +| 6.2.6.2.5 | Type: UavNetConnStatus..... | 63 | +| 6.2.6.3 | Simple data types and enumerations..... | 63 | +| 6.2.6.3.1 | Introduction ..... | 63 | +| 6.2.6.3.2 | Simple data types ..... | 63 | +| 6.2.6.4 | Data types describing alternative data types or combinations of data types ..... | 63 | +| 6.2.6.5 | Binary data..... | 63 | +| 6.2.6.5.1 | Binary Data Types..... | 63 | +| 6.2.7 | Error Handling..... | 63 | +| 6.2.7.1 | General..... | 63 | +| 6.2.7.2 | Protocol Errors ..... | 64 | +| 6.2.7.3 | Application Errors..... | 64 | +| 6.2.8 | Feature negotiation ..... | 64 | +| 6.2.9 | Security..... | 64 | +| 6.3 | UAE_ChangeUSSManagement Service API..... | 65 | +| 6.3.1 | Introduction ..... | 65 | +| 6.3.2 | Usage of HTTP..... | 65 | + +| | | | +|-------------|----------------------------------------------------------------------------------|----| +| 6.3.3 | Resources..... | 65 | +| 6.3.3.1 | Overview..... | 65 | +| 6.3.3.2 | Resource: USS Change Policies ..... | 66 | +| 6.3.3.2.1 | Description ..... | 66 | +| 6.3.3.2.2 | Resource Definition..... | 66 | +| 6.3.3.2.3 | Resource Standard Methods..... | 66 | +| 6.3.3.2.3.1 | GET ..... | 66 | +| 6.3.3.2.3.2 | POST ..... | 67 | +| 6.3.3.2.4 | Resource Custom Operations ..... | 68 | +| 6.3.3.3 | Resource: Individual USS Change Policy ..... | 68 | +| 6.3.3.3.1 | Description ..... | 68 | +| 6.3.3.3.2 | Resource Definition..... | 68 | +| 6.3.3.3.3 | Resource Standard Methods..... | 68 | +| 6.3.3.3.3.1 | GET ..... | 68 | +| 6.3.3.3.3.2 | PUT..... | 69 | +| 6.3.3.3.3.2 | PATCH..... | 70 | +| 6.3.3.3.3.4 | DELETE ..... | 71 | +| 6.3.3.3.4 | Resource Custom Operations ..... | 72 | +| 6.3.4 | Custom Operations without associated resources ..... | 72 | +| 6.3.4.1 | Overview..... | 72 | +| 6.3.4.2 | Operation: RequestUssChange ..... | 73 | +| 6.3.4.2.1 | Description ..... | 73 | +| 6.3.4.2.2 | Operation Definition ..... | 73 | +| 6.3.5 | Notifications ..... | 74 | +| 6.3.5.1 | General..... | 74 | +| 6.3.5.2 | USS Change Policy Configuration Status Notification ..... | 74 | +| 6.3.5.2.1 | Description ..... | 74 | +| 6.3.5.2.2 | Target URI..... | 74 | +| 6.3.5.2.3 | Standard Methods..... | 74 | +| 6.3.5.2.3.1 | POST ..... | 74 | +| 6.3.5.3 | USS Change Notification..... | 75 | +| 6.3.5.3.1 | Description ..... | 75 | +| 6.3.5.3.2 | Target URI..... | 75 | +| 6.3.5.3.3 | Standard Methods..... | 76 | +| 6.3.5.3.3.1 | POST ..... | 76 | +| 6.3.5.4 | USS Change Trigger Notification..... | 76 | +| 6.3.5.4.1 | Description ..... | 76 | +| 6.3.5.4.2 | Target URI..... | 76 | +| 6.3.5.4.3 | Standard Methods..... | 77 | +| 6.3.5.4.3.1 | POST ..... | 77 | +| 6.3.6 | Data Model ..... | 78 | +| 6.3.6.1 | General..... | 78 | +| 6.3.6.2 | Structured data types..... | 78 | +| 6.3.6.2.1 | Introduction ..... | 78 | +| 6.3.6.2.2 | Type: USSChangePolReq..... | 79 | +| 6.3.6.2.3 | Type: USSChangePolResp..... | 79 | +| 6.3.6.2.4 | Type: USSChangePolicy..... | 79 | +| 6.3.6.2.5 | Type: USSChangePolicyPatch..... | 80 | +| 6.3.6.2.6 | Type: MultiUssPol ..... | 80 | +| 6.3.6.2.7 | Type: UasServArea ..... | 80 | +| 6.3.6.2.8 | Type: UasRoute..... | 80 | +| 6.3.6.2.9 | Type: USSChangeReq..... | 81 | +| 6.3.6.2.10 | Type: USSChangePolConfigNotif..... | 81 | +| 6.3.6.2.11 | Type: USSChangeNotif..... | 81 | +| 6.3.6.2.12 | Type: USSChangeTriggerNotif..... | 81 | +| 6.3.6.3 | Simple data types and enumerations..... | 82 | +| 6.3.6.3.1 | Introduction ..... | 82 | +| 6.3.6.3.2 | Simple data types ..... | 82 | +| 6.3.6.4 | Data types describing alternative data types or combinations of data types ..... | 82 | +| 6.3.6.5 | Binary data..... | 82 | +| 6.3.6.5.1 | Binary Data Types..... | 82 | +| 6.3.7 | Error Handling..... | 82 | + +| | | | +|-------------|----------------------------------------------------------------------------------|-----| +| 6.3.7.1 | General ..... | 82 | +| 6.3.7.2 | Protocol Errors ..... | 82 | +| 6.3.7.3 | Application Errors ..... | 82 | +| 6.3.8 | Feature negotiation ..... | 83 | +| 6.3.9 | Security ..... | 83 | +| 6.4 | UAE_DAA Support Service API ..... | 84 | +| 6.4.1 | Introduction ..... | 84 | +| 6.4.2 | Usage of HTTP ..... | 84 | +| 6.4.3 | Resources ..... | 84 | +| 6.4.3.1 | Overview ..... | 84 | +| 6.4.3.2 | Resource: DAA Policies ..... | 85 | +| 6.4.3.2.1 | Description ..... | 85 | +| 6.4.3.2.2 | Resource Definition ..... | 85 | +| 6.4.3.2.3 | Resource Standard Methods ..... | 85 | +| 6.4.3.2.3.1 | GET ..... | 85 | +| 6.4.3.2.3.2 | POST ..... | 86 | +| 6.4.3.2.4 | Resource Custom Operations ..... | 87 | +| 6.4.3.3 | Resource: Individual DAA Policy ..... | 87 | +| 6.4.3.3.1 | Description ..... | 87 | +| 6.4.3.3.2 | Resource Definition ..... | 87 | +| 6.4.3.3.3 | Resource Standard Methods ..... | 87 | +| 6.4.3.3.3.1 | GET ..... | 87 | +| 6.4.3.3.3.2 | PUT ..... | 88 | +| 6.4.3.3.3.2 | PATCH ..... | 89 | +| 6.4.3.3.3.4 | DELETE ..... | 90 | +| 6.4.3.3.4 | Resource Custom Operations ..... | 91 | +| 6.4.4 | Custom Operations without associated resources ..... | 91 | +| 6.4.4.1 | Overview ..... | 91 | +| 6.4.4.2 | Operation: InformDAAEvents ..... | 92 | +| 6.4.4.2.1 | Description ..... | 92 | +| 6.4.4.2.2 | Operation Definition ..... | 92 | +| 6.4.5 | Notifications ..... | 93 | +| 6.4.5.1 | General ..... | 93 | +| 6.4.5.2 | DAA Policy Configuration Completion Status Notification ..... | 93 | +| 6.4.5.2.1 | Description ..... | 93 | +| 6.4.5.2.2 | Target URI ..... | 93 | +| 6.4.5.2.3 | Standard Methods ..... | 93 | +| 6.4.5.2.3.1 | POST ..... | 93 | +| 6.4.5.3 | DAA Event Notification ..... | 94 | +| 6.4.5.3.1 | Description ..... | 94 | +| 6.4.5.3.2 | Target URI ..... | 94 | +| 6.4.5.3.3 | Standard Methods ..... | 94 | +| 6.4.5.3.3.1 | POST ..... | 94 | +| 6.4.6 | Data Model ..... | 95 | +| 6.4.6.1 | General ..... | 95 | +| 6.4.6.2 | Structured data types ..... | 96 | +| 6.4.6.2.1 | Introduction ..... | 96 | +| 6.4.6.2.2 | Type: DAAPolReq ..... | 96 | +| 6.4.6.2.3 | Type: DAAPolResp ..... | 97 | +| 6.4.6.2.4 | Type: DAAPolicy ..... | 97 | +| 6.4.6.2.5 | Type: DAAPolicyPatch ..... | 97 | +| 6.4.6.2.6 | Type: DAAAppPolicy ..... | 97 | +| 6.4.6.2.7 | Type: InformDAAEventsReq ..... | 98 | +| 6.4.6.2.8 | Type: DAAPolConfigNotif ..... | 98 | +| 6.4.6.2.9 | Type: DAAEventsInfo ..... | 98 | +| 6.4.6.2.10 | Type: DAAEvent ..... | 99 | +| 6.4.6.3 | Simple data types and enumerations ..... | 99 | +| 6.4.6.3.1 | Introduction ..... | 99 | +| 6.4.6.3.2 | Simple data types ..... | 99 | +| 6.4.6.3.3 | Enumeration: DAAPolConfigStatus ..... | 99 | +| 6.4.6.4 | Data types describing alternative data types or combinations of data types ..... | 99 | +| 6.4.6.5 | Binary data ..... | 100 | + +| | | | +|-------------------------------|-----------------------------------------|------------| +| 6.4.6.5.1 | Binary Data Types..... | 100 | +| 6.4.7 | Error Handling..... | 100 | +| 6.4.7.1 | General..... | 100 | +| 6.4.7.2 | Protocol Errors ..... | 100 | +| 6.4.7.3 | Application Errors..... | 100 | +| 6.4.8 | Feature negotiation ..... | 100 | +| 6.4.9 | Security..... | 100 | +| 7 | Using Common API Framework ..... | 101 | +| 7.1 | General ..... | 101 | +| 7.2 | Security..... | 101 | +| Annex A (normative): | OpenAPI specification..... | 102 | +| A.1 | General..... | 102 | +| A.2 | UAE_C2OperationModeManagement API ..... | 103 | +| A.3 | UAE_RealtimeUAVStatus API ..... | 110 | +| A.4 | UAE_ChangeUSSManagement API..... | 115 | +| A.5 | UAE_DAASupport API..... | 121 | +| Annex B (informative): | Withdrawn API versions ..... | 129 | +| B.1 | General..... | 129 | +| B.2 | UAE_C2OperationModeManagement API ..... | 129 | +| B.3 | UAE_RealtimeUAVStatus API ..... | 129 | +| B.4 | UAE_ChangeUSSManagement API..... | 129 | +| B.5 | UAE_DAASupport API..... | 129 | +| Annex C (informative): | Change history..... | 130 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +# 1 Scope + +The present document specifies the stage 3 Protocol and data model for the UAS Application Enabler (UAE) Server services, for enabling the support of Uncrewed Aerial System (UAS) applications over 3GPP networks. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the UAE Server. + +The stage 2 application layer architecture for Uncrewed Aerial System (UAS), functional requirements, procedures and information flows necessary for enabling Uncrewed Aerial System (UAS) applications over 3GPP networks are specified in 3GPP TS 23.255 [6]. + +The common protocol and interface aspects for API definition are specified in clause 5.2 of 3GPP TS 29.122 [2]. + +--- + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 29.122: "T8 reference point for Northbound Application Programming Interfaces (APIs)". +- [3] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [4] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [5] 3GPP TR 21.900: "Technical Specification Group working methods". +- [6] 3GPP TS 23.255: "Application layer support for Uncrewed Aerial System (UAS); Functional architecture and information flows". +- [7] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [8] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". +- [9] 3GPP TS 23.222: "Common API Framework for 3GPP Northbound APIs; Stage 2". +- [10] 3GPP TS 29.222: "Common API Framework for 3GPP Northbound APIs; Stage 3". +- [11] 3GPP TS 33.122: "Security aspects of Common API Framework (CAPIF) for 3GPP northbound APIs". +- [12] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". + +## 3 Definitions, symbols and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +For the purpose of the present document, the terms and definitions given in clause 3 of 3GPP TS 23.255 [6] also apply, including the ones referencing other specifications. + +### 3.2 Symbols + +Void. + +### 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|--------------------------------------| +| BVLOS | Beyond Visual Line Of Sight | +| C2 | Command and Control | +| CAA | Civil Aviation Authorities | +| DAA | Detect And Avoid | +| RSRP | Reference Signal Received Power | +| UAE | UAS Application Enabler | +| UAS | Uncrewed Aerial System | +| UASS | UAS Application Specific Server | +| UAV | Uncrewed Aerial Vehicle | +| UAV-C | Uncrewed Aerial Vehicle – Controller | +| USS | UAS Service Supplier | +| UTM | UAS Traffic Management | + +## 4 Overview + +The UAS Application Enabler (UAE) Server forms part of the UAS application enabler layer that aims to ensure the efficient use and deployment of UAS over 3GPP systems. The UAE Server supports for this purpose, among other functionalities defined in 3GPP TS 23.255 [6], the following functionalities: + +- UAS application layer support functions to a UASS (e.g. USS/UTM) over the Us reference point, i.e.: + - C2 operation mode configuration management for a UAS (i.e. pair of UAV and UAV-C); + - C2 communication modes switching control and management for a UAS (i.e. pair of UAV and UAV-C); + - Real-Time UAV Connection Status Monitoring and Location reporting; + - USS change management; and + - DAA management; + +and + +- interaction with other UAE Servers over the UAE-E reference point, in order to support distributed UAE Server deployments. + +Figure 4-1 shows the reference model of the UAS Application Layer, with a focus on the UAE Server: + +![Figure 4-1: UAS Application Layer functional model. This diagram illustrates the functional architecture of the UAS Application Layer. It is divided into three main vertical components: UAS UE (UAV-C or UAV), UAS application server, and 3GPP network system. The UAS UE contains a 'UAS application specific client' and a 'UAE client'. The UAS application server contains a 'UAS application specific server', a 'UAE server' (highlighted in blue), and 'SEAL servers'. The 3GPP network system is shown in the center. Interfaces include U1-APP between the UAS application specific client and server; Uc between the UAE client and server; U1-AE between the UAE client and the UAE server; SEAL-UU between SEAL clients and SEAL servers; and SEAL-S between the UAE server and SEAL servers. The UAE server also connects to the 3GPP network system via Nnef, T8, MB2-U, and xMB-U interfaces. The SEAL servers connect to the 3GPP network system via MB2-C/xMB-C, Nnef, Rx, and T8 interfaces. Horizontal dashed lines define the 'UAS application specific layer', 'UAE layer', and 'SEAL' layer. A 'UAE-E' reference point is indicated between the UAE server and the SEAL servers.](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +Figure 4-1: UAS Application Layer functional model. This diagram illustrates the functional architecture of the UAS Application Layer. It is divided into three main vertical components: UAS UE (UAV-C or UAV), UAS application server, and 3GPP network system. The UAS UE contains a 'UAS application specific client' and a 'UAE client'. The UAS application server contains a 'UAS application specific server', a 'UAE server' (highlighted in blue), and 'SEAL servers'. The 3GPP network system is shown in the center. Interfaces include U1-APP between the UAS application specific client and server; Uc between the UAE client and server; U1-AE between the UAE client and the UAE server; SEAL-UU between SEAL clients and SEAL servers; and SEAL-S between the UAE server and SEAL servers. The UAE server also connects to the 3GPP network system via Nnef, T8, MB2-U, and xMB-U interfaces. The SEAL servers connect to the 3GPP network system via MB2-C/xMB-C, Nnef, Rx, and T8 interfaces. Horizontal dashed lines define the 'UAS application specific layer', 'UAE layer', and 'SEAL' layer. A 'UAE-E' reference point is indicated between the UAE server and the SEAL servers. + +Figure 4-1: UAS Application Layer functional model + +## 5 Services offered by the UAE Server + +### 5.1 Introduction + +The UAE Server provides the following services: + +- UAE\_C2OperationModeManagement +- UAE\_RealtimeUAVStatus +- UAE\_ChangeUSSManagement +- UAE\_DAASupport + +Table 5.1-1 summarizes the corresponding APIs defined in this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | API Name | Annex | +|-------------------------------|--------|-------------------------------------------------|--------------------------------------------|--------------------|-------| +| UAE_C2OperationModeManagement | 5.2 | UAE Server C2 Operation Mode Management Service | TS29257_UAE_C2OperationModeManagement.yaml | uae-c2opmode-mngt | A.2 | +| UAE_RealtimeUAVStatus | 5.3 | UAE Server Real-time UAV Status Service | TS29257_UAE_RealtimeUAVStatus.yaml | uae-uav-status | A.3 | +| UAE_ChangeUSSManagement | 5.4 | UAE USS Change Management Service | TS29257_UAE_ChangeUSSManagement.yaml | uae-usschange-mngt | A.4 | +| UAE_DAASupport | 5.5 | UAE DAA Support | TS29257_UAE_DAASupport.yaml | uae-daa | A.5 | + +NOTE: When 3GPP TS 29.122 [2] is referenced for the common protocol and interface aspects for API definition in the clauses under clause 5, the UAE Server takes the role of the SCEF and the UASS takes the role of the SCS/AS. + +### 5.2 UAE\_C2OperationModeManagement Service + +#### 5.2.1 Service Description + +The UAE\_C2OperationModeManagement service exposed by the UAE Server enables a UASS (e.g. USS/UTM) to: + +- communicate C2 operation mode configuration information to the UAE Server for a UAS (i.e. pair of UAV and UAV-C); +- receive notifications from the UAE Server on the C2 operation mode management completion; +- receive notifications from the UAE Server on the C2 communication mode selected by a UAS (i.e. pair of UAV and UAV-C); and +- receive notifications from the UAE Server when C2 communication mode switching is carried out and decide whether to authorize it or not. + +## 5.2.2 Service Operations + +### 5.2.2.1 Introduction + +The service operations defined for the UAE\_C2OperationModeManagement service are shown in table 5.2.2.1-1. + +**Table 5.2.2.1-1: UAE\_C2OperationModeManagement Service Operations** + +| Service Operation Name | Description | Initiated by | +|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| UAE_C2OperationModeManagement_Initiate | This service operation enables a UASS to initiate the configuration of C2 operation modes for a UAS (i.e. pair of UAV and UAV-C) by communicating the associated C2 operation mode configuration information to the UAE Server. | e.g. UASS | +| UAE_C2OperationModeManagement_Notify | This service operation enables a UAE Server to notify a previously subscribed UASS either:
  • - on C2 operation mode management completion;
  • - on the C2 communication mode selected by a UAS (i.e. pair of UAV and UAV-C); or
  • - when C2 communication mode switching is carried out. The UASS may then confirm the targeted C2 communication mode switching or not.
| UAE Server | + +### 5.2.2.2 UAE\_C2OperationModeManagement\_Initiate + +#### 5.2.2.2.1 General + +This service operation is used by a UASS to request the provisioning of C2 operation mode configuration information for a UAS (i.e. pair of UAV and UAV-C) to the UAE Server. + +The following procedures are supported by the "UAE\_C2OperationModeManagement\_Initiate" service operation: + +- C2 Operation Mode Initiation procedure. + +#### 5.2.2.2.2 C2 Operation Mode Initiation + +Figure 5.2.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to request the provisioning of C2 operation mode configuration information for a UAS (i.e. pair of UAV and UAV-C) (see also clause 7.4 of 3GPP TS 23.255[6]). + +![Sequence diagram showing the C2 Operation Mode Initiation procedure between a UASS and a UAE Server. The UASS sends a POST request (ConfigureData) to the UAE Server. The UAE Server responds with a 200 OK (C2Result) or a 4xx/5xx error.](220869911a1ecfa1dd4aa6d750319aad_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE Server + Note left of UASS: UASS + Note right of UAE Server: UAE Server + UASS->>UAE Server: 1. POST .../initiate (ConfigureData) + UAE Server-->>UASS: 2a. 200 OK (C2Result) + Note right of UAE Server: 2b. 4xx/5xx + +``` + +Sequence diagram showing the C2 Operation Mode Initiation procedure between a UASS and a UAE Server. The UASS sends a POST request (ConfigureData) to the UAE Server. The UAE Server responds with a 200 OK (C2Result) or a 4xx/5xx error. + +**Figure 5.2.2.2.2-1: C2 Operation Mode Initiation procedure** + +- The UASS shall send for this purpose an HTTP POST request (custom operation: "Initiate") to the UAE Server, with the request URI set to "{apiRoot}/uae-c2opmode-mngt//initiate" and the request body including the ConfigureData data structure that shall contain: + - the identifier of the UASS that is sending the request, within the "uassId" attribute; + +- the identifier of the target UAS (i.e. pair of UAV and UAV-C) to which the C2 Operation Mode configuration information is destined, within the "uasId" attribute; +- the allowed C2 communication modes for the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute, within the "allowedC2CommModes" attribute; +- the C2 Operation Mode switching types to be supported by the UAE Server, within the "c2CommModeSwitchTypes" attribute; +- the notification URI via which the UASS desires to receive notifications from the UAE Server, within the "notificationUri" attribute; +- the primary C2 communication mode (i.e. either Direct C2 Communication mode or Network-Assisted C2 Communication mode) to be used by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute, within the "primaryC2CommMode" attribute; and +- the C2 operation mode switching policies, within the "c2SwitchPolicies" attribute; + +and may also contain: + +- the secondary C2 communication mode (i.e. either Direct C2 Communication mode or Network-Assisted C2 Communication mode) to be used by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute, within the "secondaryC2CommMode" attribute; +- the service area within which the C2 operation mode management request applies (i.e. a geographical area or a topological area), within the "c2ServiceArea" attribute; and +- the list of features supported by the UASS among the ones defined in clause 6.1.8, within the "suppFeat" attribute. + +2a. Upon success, the UAE Server shall respond with an HTTP "200 OK" status code with the response body including the C2Result data structure which shall contain a feedback from the UAE Server on whether the request for C2 Operation Mode configuration information provisioning is confirmed (i.e. can be undertaken by the UAE Server) or not. The C2Result data structure may also contain the list of negotiated supported features. + +2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +## 5.2.2.3 UAE\_C2OperationModeManagement\_Notify + +### 5.2.2.3.1 General + +This service operation is used by a UAE Server to notify a previously subscribed UASS either on C2 operation mode management completion, on the C2 communication mode selected by a UAS (i.e. pair of UAV and UAV-C) or when C2 communication mode switching is carried out. For the latter, the UASS may then confirm the targeted C2 communication mode switching or not. See also clause 7.4 of 3GPP TS 23.255 [6]. + +The following procedures are supported by the "UAE\_C2OperationModeManagement\_Notify" service operation: + +- C2 Operation Mode Management Completion Notification. +- Selected C2 Communication Mode Notification. +- C2 Communication Mode Switching Notification. + +### 5.2.2.3.2 C2 Operation Mode Management Completion Notification + +Figure 5.2.2.3.2-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on the C2 operation mode management completion status for a UAS (i.e. pair of UAV and UAV-C). See also clause 7.4 of 3GPP TS 23.255 [6]. + +![Sequence diagram for C2 Operation Mode Management Completion Notification procedure. The diagram shows a UASS and a UAE Server. The UAE Server sends a POST request to the UASS with the URI {notificationUri}/c2mode-mngt-completion and a body containing C2OpModeMngtCompStatus. The UASS responds with either a 204 No Content (2a) or an error status code (2b, 4xx/5xx).](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note right of UAE_Server: 1. POST {notificationUri}/c2mode-mngt-completion +(C2OpModeMngtCompStatus) + UAE_Server->>UASS: 1. POST {notificationUri}/c2mode-mngt-completion +(C2OpModeMngtCompStatus) + Note right of UASS: 2a. 204 No Content + UASS->>UAE_Server: 2a. 204 No Content + Note right of UASS: 2b. 4xx/5xx + UASS->>UAE_Server: 2b. 4xx/5xx + +``` + +Sequence diagram for C2 Operation Mode Management Completion Notification procedure. The diagram shows a UASS and a UAE Server. The UAE Server sends a POST request to the UASS with the URI {notificationUri}/c2mode-mngt-completion and a body containing C2OpModeMngtCompStatus. The UASS responds with either a 204 No Content (2a) or an error status code (2b, 4xx/5xx). + +**Figure 5.2.2.3.2-1: C2 Operation Mode Management Completion Notification procedure** + +1. The UAE Server shall send for this purpose an HTTP POST request to the UASS with the request URI set to "{notificationUri}/c2mode-mngt-completion", where the "notificationUri" is set to the value received from the UASS during the C2 Operation Mode Initiation procedure defined in clause 5.2.2.2, and the request body including the C2OpModeMngtCompStatus data structure that shall contain: + +- the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the notification is related, within the "uasId" attribute; and +- the C2 operation mode management completion status (i.e. either successful or not successful) for the concerned UAS (i.e. pair of UAV and UAV-C), within the "status" attribute. + +- 2a. Upon success, the UASS shall respond to the UAE Server with an HTTP "204 No Content" status code to acknowledge the reception of the notification. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +### 5.2.2.3.3 Selected C2 Communication Mode Notification + +Figure 5.2.2.3.3-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on the C2 communication mode selected by a UAS (i.e. pair of UAV and UAV-C). See also clause 7.4 of 3GPP TS 23.255[6]. + +![Sequence diagram for Selected C2 Communication Mode Notification procedure. The diagram shows a UASS and a UAE Server. The UAE Server sends a POST request to the UASS with the URI {notificationUri}/inform-selec-c2mode and a body containing SelectedC2CommModeNotif. The UASS responds with either a 204 No Content (2a) or an error status code (2b, 4xx/5xx).](9b62a616c7a1097c5da57f001ab6dd64_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note right of UAE_Server: 1. POST {notificationUri}/inform-selec-c2mode +(SelectedC2CommModeNotif) + UAE_Server->>UASS: 1. POST {notificationUri}/inform-selec-c2mode +(SelectedC2CommModeNotif) + Note right of UASS: 2a. 204 No Content + UASS->>UAE_Server: 2a. 204 No Content + Note right of UASS: 2b. 4xx/5xx + UASS->>UAE_Server: 2b. 4xx/5xx + +``` + +Sequence diagram for Selected C2 Communication Mode Notification procedure. The diagram shows a UASS and a UAE Server. The UAE Server sends a POST request to the UASS with the URI {notificationUri}/inform-selec-c2mode and a body containing SelectedC2CommModeNotif. The UASS responds with either a 204 No Content (2a) or an error status code (2b, 4xx/5xx). + +**Figure 5.2.2.3.3-1: Selected C2 Communication Mode Notification procedure** + +1. The UAE Server shall send for this purpose an HTTP POST request to the UASS with the request URI set to "{notificationUri}/inform-selec-c2mode", where the "notificationUri" is set to the value received from the UASS during the C2 Operation Mode Initiation procedure defined in clause 5.2.2.2, and the request body including the SelectedC2CommModeNotif data structure that shall contain: + +- the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the notification is related, within the "uasId" attribute; and + +- the primary C2 communication mode selected by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute, within the "selPrimaryC2CommMode" attribute; + +and may also contain: + +- the secondary C2 communication mode selected by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute, within the "selSecondaryC2CommMode" attribute. + +- 2a. Upon success, the UASS shall respond to the UAE Server with an HTTP "200 No Content" status code to acknowledge the reception of the notification. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +#### 5.2.2.3.4 C2 Communication Mode Switching Notification + +Figure 5.2.2.3.4-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on the targeted C2 communication mode switching for a UAS (i.e. pair of UAV and UAV-C) and may request confirmation from the UASS. See also clause 7.4 of 3GPP TS 23.255[6]. + +![Sequence diagram showing the C2 Communication Mode Switching Notification procedure between a UAE Server and a UASS. The UAE Server sends a POST request to the UASS. The UASS responds with either a 200 OK (C2Result), a 204 No Content, or a 4xx/5xx error status code.](e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg) + +``` + +sequenceDiagram + participant UAE Server + participant UASS + Note left of UAE Server: 1. POST {notificationUri}/inform-c2mode-switch (C2CommModeSwitchNotif) + UAE Server->>UASS: 1. POST {notificationUri}/inform-c2mode-switch (C2CommModeSwitchNotif) + Note right of UASS: 2a. 200 OK (C2Result) + Note right of UASS: 2b. 204 No Content + Note right of UASS: 2c. 4xx/5xx + UASS-->>UAE Server: 2a. 200 OK (C2Result) + UASS-->>UAE Server: 2b. 204 No Content + UASS-->>UAE Server: 2c. 4xx/5xx + +``` + +Sequence diagram showing the C2 Communication Mode Switching Notification procedure between a UAE Server and a UASS. The UAE Server sends a POST request to the UASS. The UASS responds with either a 200 OK (C2Result), a 204 No Content, or a 4xx/5xx error status code. + +**Figure 5.2.2.3.4-1: C2 Communication Mode Switching Notification procedure** + +1. The UAE Server shall send for this purpose an HTTP POST request to the UASS with the request URI set to "{notificationUri}/inform-c2mode-switch", where the "notificationUri" is set to the value received from the UASS during the C2 Operation Mode Initiation procedure defined in clause 5.2.2.2, and the request body including the C2CommModeSwitchNotif data structure that shall contain: + - the identifier of the UAE Server that is sending the notification and possibly requesting C2 Communication Mode switching confirmation for a UAS (i.e. pair of UAV and UAV-C) from the UASS, within the "uaeServerId" attribute; + - the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the provided C2 Communication Mode switching information is related, within the "uasId" attribute; and + - the targeted C2 Communication Mode switching for the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute, within the "c2CommModeSwitchType" attribute; + +And may contain: + +- the C2 Communication Mode switching cause, within the "switchingCause" attribute. + +- 2a. Upon success, if the UASS has to confirm (i.e. approve) the C2 Communication Mode switching operation to the UAE Server, the UASS shall respond with an HTTP "200 OK" status code with the response body including the + +C2Result data structure which shall contain a feedback from the UASS on whether this C2 Communication Mode switching is confirmed (i.e. approved) or not. + +- 2b. Otherwise, upon success, if the UASS does not have to confirm (i.e. approve) the C2 Communication Mode switching operation to the UAE Server, the UASS shall respond to the UAE Server with an HTTP "204 No Content" status code to acknowledge the reception of the notification. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2c. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +## 5.3 UAE\_RealtimeUAVStatus Service + +### 5.3.1 Service Description + +The UAE\_RealtimeUAVStatus service exposed by the UAE Server enables a UASS (e.g. USS/UTM) to: + +- subscribe to real-time UAV status information reporting; +- update an existing real-time UAV status information reporting subscription; +- receive real-time UAV status notifications; and +- unsubscribe from real-time UAV status information reporting. + +The UAV status information includes the UAV network connection status information and the UAV location information. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operations defined for the UAE\_RealtimeUAVStatus service are shown in table 5.3.2.1-1. + +**Table 5.3.2.1-1: UAE\_RealtimeUAVStatus Service Operations** + +| Service Operation Name | Description | Initiated by | +|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| UAE_RealtimeUAVStatus_Subscribe | This service operation enables a UASS to subscribe to real-time UAV status information reporting or update an existing real-time UAV status information reporting subscription. | e.g. UASS | +| UAE_RealtimeUAVStatus_Unsubscribe | This service operation enables a UASS to unsubscribe from real-time UAV status information reporting. | e.g. UASS | +| UAE_RealtimeUAVStatus_Notify | This service operation enables a UAE Server to notify a previously subscribed UASS on real-time UAV status information. | UAE Server | + +#### 5.3.2.2 UAE\_RealtimeUAVStatus\_Subscribe + +##### 5.3.2.2.1 General + +This service operation is used by a UASS to subscribe to real-time UAV status information reporting or update an existing real-time UAV status information reporting subscription. + +The following procedures are supported by the "UAE\_RealtimeUAVStatus\_Subscribe" service operation: + +- Subscribe to real-time UAV status information reporting. +- Update an existing real-time UAV status information reporting subscription. + +##### 5.3.2.2.2 Subscribe to real-time UAV status information reporting + +Figure 5.3.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to request the creation of a subscription to real-time UAV status information reporting (see also clause 7.5 of 3GPP TS 23.255[6]). + +![Sequence diagram for subscribing to real-time UAV status information reporting](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +A sequence diagram showing the interaction between a UASS and a UAE Server. The UASS sends a POST request to the UAE Server. The UAE Server responds with either a 201 Created status (success) or a 4xx/5xx status (error). + +``` +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. POST .../subscriptions (RTUavStatusSubsc) + UASS->>UAE_Server: Request + Note right of UAE_Server: 2a. 201 Created (RTUavStatusSubsc) + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: Response +``` + +Sequence diagram for subscribing to real-time UAV status information reporting + +**Figure 5.3.2.2.2-1: Procedure for subscribing to real-time UAV status information reporting** + +1. In order to subscribe to real-time UAV status reporting, the UASS shall send an HTTP POST request to the UAE Server, with the request URI set to "{apiRoot}/uae-uav-status//subscriptions" and the request body including the RTUavStatusSubsc data structure that shall contain: + - the identifier of the UASS that is sending the request, within the "uassId" attribute; + - the identifier(s) of the target UAV(s) to which the subscription is related, within the "uavIds" attribute; + - the notification URI via which the UASS desires to receive real-time UAV status notifications from the UAE Server, within the "notificationUri" attribute; and + - the list of features supported by the UASS among the ones defined in clause 6.2.8, within the "suppFeat" attribute. +- 2a. Upon success, the UAE Server shall respond with an HTTP "201 Created" status code with the response body containing a representation of the created Individual Real-time UAV Status Subscription resource within the RTUavStatusSubsc data structure. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +#### 5.3.2.2.3 Update an existing real-time UAV status information reporting subscription + +Figure 5.3.2.2.3-1 depicts a scenario where a UASS sends a request to the UAE Server to request the update of an existing subscription to real-time UAV status information reporting. + +![Sequence diagram for updating a real-time UAV status information reporting subscription](75e4b78ee25f885d73120e3066a5253e_img.jpg) + +A sequence diagram showing the interaction between a UASS and a UAE Server. The UASS sends a PUT request to the UAE Server. The UAE Server responds with either a 200 OK or 204 No Content status (success) or a 4xx/5xx status (error). + +``` +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. PUT .../subscriptions/{subscriptionId} (RTUavStatusSubsc) + UASS->>UAE_Server: Request + Note right of UAE_Server: 2a. 200 OK (RTUavStatusSubsc) / 204 No Content + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: Response +``` + +Sequence diagram for updating a real-time UAV status information reporting subscription + +**Figure 5.3.2.2.3-1: Procedure for updating a real-time UAV status information reporting subscription** + +1. In order to update an existing real-time UAV status reporting subscription, the UASS shall send an HTTP PUT request to the UAE Server, with the request URI set to "{apiRoot}/uae-uav-status//subscriptions/{subscriptionId}", requesting to update the Individual Real-time UAV Status Subscription resource identified by the provided "subscriptionId" path segment. The request body shall include an updated representation of the resource within the RTUavStatusSubsc data structure that shall contain: + - the identifier of the UASS that is sending the request, within the "uassId" attribute; + +NOTE: An alternative UASS than the one that requested the creation of the subscription resource can send this subscription update request. + +- the same or an updated list of identifier(s) of the target UAV(s) to which the subscription is related, within the "uavIds" attribute; and + - the same or an updated notification URI via which the UASS desires to receive real-time UAV status notifications from the UAE Server, within the "notificationUri" attribute. +- 2a. Upon success, the UAE Server shall update the concerned Individual Real-time UAV Status Subscription resource accordingly and respond with either: +- an HTTP "200 OK" status code with the response body containing a representation of the updated Individual Real-time UAV Status Subscription resource within the RTUavStatusSubsc data structure; or + - an HTTP "204 No Content" status code. +- If the UAE Server is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI of the resource located in an alternative UAE Server, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP PUT response body. + +### 5.3.2.3 UAE\_RealtimeUAVStatus\_Unsubscribe + +#### 5.3.2.3.1 General + +This service operation is used by a UASS to unsubscribe from real-time UAV status information reporting. + +The following procedures are supported by the "UAE\_RealtimeUAVStatus\_Unsubscribe" service operation: + +- Unsubscribe from real-time UAV status information reporting. + +#### 5.3.2.3.2 Unsubscribe from real-time UAV status information reporting + +Figure 5.3.2.3.2-1 depicts a scenario where a UASS sends a request to the UAE Server to request the deletion of an existing Individual Real-time UAV Status Subscription resource (see also clause 7.5 of 3GPP TS 23.255 [6]). + +![Sequence diagram showing the procedure for unsubscribing from real-time UAV status information reporting. The UASS sends a DELETE request to the UAE Server. The UAE Server responds with either a 204 No Content (2a) or an error status code (2b).](2834bdd6eb8540277e609decbb924003_img.jpg) + +``` +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. DELETE .../subscriptions/{subscriptionId} () + UASS->>UAE_Server: 1. DELETE .../subscriptions/{subscriptionId} () + Note right of UAE_Server: 2a. 204 No Content + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: 2a. 204 No Content + UAE_Server-->>UASS: 2b. 4xx/5xx +``` + +Sequence diagram showing the procedure for unsubscribing from real-time UAV status information reporting. The UASS sends a DELETE request to the UAE Server. The UAE Server responds with either a 204 No Content (2a) or an error status code (2b). + +**Figure 5.3.2.3.2-1: Procedure for unsubscribing from real-time UAV status information reporting** + +1. In order to unsubscribe from real-time UAV status reporting, the UASS shall send an HTTP DELETE request to the UAE Server, with the request URI set to "{apiRoot}/uae-uav-status/{apiVersion}/subscriptions/{subscriptionId}", requesting to delete the Individual Real-time UAV Status Subscription resource identified by the provided "subscriptionId" path segment. +- 2a. Upon success, the UAE Server shall respond with an HTTP "204 No Content" status code. + +If the UAE Server is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI of the resource located in an alternative UAE Server, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP DELETE response body. + +### 5.3.2.4 UAE\_RealtimeUAVStatus\_Notify + +#### 5.3.2.4.1 General + +This service operation is used by a UAE Server to notify a previously subscribed UASS on real-time UAV status information. See also clause 7.5 of 3GPP TS 23.255 [6]. + +The following procedures are supported by the "UAE\_RealtimeUAVStatus\_Notify" service operation: + +- Real-time UAV Status Notification. + +#### 5.3.2.4.2 Real-time UAV Status Notification + +Figure 5.3.2.4.2-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on real-time UAV status information. See also clause 7.5 of 3GPP TS 23.255 [6]. + +![Sequence diagram showing the Real-time UAV Status Notification procedure between a UASS and a UAE Server. The UAE Server sends a POST request to the UASS. The UASS responds with either a 204 No Content (success) or a 4xx/5xx status code (failure).](86d30a7d5a9cd4ee5456b5962ae3420a_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note right of UAE_Server: 1. POST {notificationUri}/uav-status (RTUavStatusNotif) + UAE_Server->>UASS: 1. POST {notificationUri}/uav-status (RTUavStatusNotif) + Note left of UASS: 2a. 204 No Content +2b. 4xx/5xx + UASS-->>UAE_Server: 2a. 204 No Content +2b. 4xx/5xx + +``` + +Sequence diagram showing the Real-time UAV Status Notification procedure between a UASS and a UAE Server. The UAE Server sends a POST request to the UASS. The UASS responds with either a 204 No Content (success) or a 4xx/5xx status code (failure). + +**Figure 5.3.2.4.2-1: Real-time UAV Status Notification procedure** + +- The UAE Server shall send for this purpose an HTTP POST request to the UASS with the request URI set to "{notificationUri}/uav-status", where the "notificationUri" is set to the value received from the UASS during the real-time UAV status reporting subscription creation/update procedures defined in clause 5.3.2.2, and the request body including the RTUavStatusNotif data structure that shall contain: + - The identifier of the Individual Real-time UAV Status Subscription to which the notification is related, within the "subscriptionId" attribute; and + - The real-time UAV status information for the concerned UAV(s), within the "rTUavStatus" attribute. +- Upon success, the UASS shall respond with an HTTP "204 No Content" status code to acknowledge the reception of the notification to the UAE Server. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +## 5.4 UAE\_ChangeUSSManagement Service + +### 5.4.1 Service Description + +The UAE\_ChangeUSSManagement service exposed by the UAE Server enables a UASS (e.g. USS) to: + +- create/update/delete USS Change Policies; +- request USS change; +- receive notifications on USS Change Policy Configuration status; +- receive notifications on USS Change (i.e. that a USS change was performed); and +- receive notifications when USS change needs to be triggered. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +The service operations defined for the UAE\_ChangeUSSManagement service are shown in table 5.4.2.1-1. + +**Table 5.4.2.1-1: UAE\_ChangeUSSManagement Service Operations** + +| Service Operation Name | Description | Initiated by | +|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| UAE_ChangeUSSManagement_ManageUSS | This service operation enables a UASS to create/update/delete a USS Change Policy. | e.g. UASS | +| UAE_ChangeUSSManagement_RequestUSSChange | This service operation enables a UASS to trigger USS change. | e.g. UASS | +| UAE_ChangeUSSManagement_Notify | This service operation enables a UAE Server to notify a previously subscribed UASS either:
  • - on USS Change Policy Configuration completion status;
  • - on USS change (i.e. that a USS change was performed); or
  • - when USS change needs to be triggered.
| e.g. UASS | + +#### 5.4.2.2 UAE\_ChangeUSSManagement\_ManageUSS + +##### 5.4.2.2.1 General + +This service operation is used by a UASS to request the creation/update/deletion of a USS Change Policy at the UAE Server. + +The following procedures are supported by the "UAE\_ChangeUSSManagement\_ManageUSS" service operation: + +- USS Change Policy Creation. +- USS Change Policy Update. +- USS Change Policy Deletion. + +##### 5.4.2.2.2 USS Change Policy Creation + +Figure 5.4.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to create a USS Change Policy (see also clause 7.6 of 3GPP TS 23.255[6]). + +![Sequence diagram for USS Change Policy Creation. A UASS sends a POST .../policies (USSChangePolReq) to a UAE Server. The UAE Server responds with 2a. 201 Created (USSChangePolResp) or 2b. 4xx/5xx.](26d664119ad25250780f554633444e54_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. Request creation + UASS->>UAE_Server: POST .../policies (USSChangePolReq) + Note right of UAE_Server: 2a. Success / 2b. Error + UAE_Server-->>UASS: 2a. 201 Created (USSChangePolResp) + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: 2b. 4xx/5xx + +``` + +Sequence diagram for USS Change Policy Creation. A UASS sends a POST .../policies (USSChangePolReq) to a UAE Server. The UAE Server responds with 2a. 201 Created (USSChangePolResp) or 2b. 4xx/5xx. + +**Figure 5.4.2.2.2-1: Procedure for USS Change Policy Creation** + +1. In order to request the creation of a USS Change Policy, the UASS shall send an HTTP POST request to the UAE Server targeting the "USS Change Policies" resource, with the request body including the USSChangePolReq data structure. +- 2a. Upon success, the UAE Server shall respond with an HTTP "201 Created" status code with the response body containing a representation of the created "Individual USS Change Policy" resource and potentially additional information within the USSChangePolResp data structure. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.3.7. + +#### 5.4.2.2.3 USS Change Policy Update + +Figure 5.4.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to update an existing USS Change Policy (see also clause 7.6 of 3GPP TS 23.255°[6]). + +![Sequence diagram for USS Change Policy Update. A UASS sends a PUT or PATCH .../policies/{policyId} (USSChangePolicy or USSChangePolicyPatch) to a UAE Server. The UAE Server responds with 2a. 200 OK (USSChangePolicy) / 204 No Content or 2b. 4xx/5xx.](e7c6a6e4c3047dac05a3b92e396e9794_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. Request update + UASS->>UAE_Server: PUT or PATCH .../policies/{policyId} (USSChangePolicy or USSChangePolicyPatch) + Note right of UAE_Server: 2a. Success / 2b. Error + UAE_Server-->>UASS: 2a. 200 OK (USSChangePolicy) / 204 No Content + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: 2b. 4xx/5xx + +``` + +Sequence diagram for USS Change Policy Update. A UASS sends a PUT or PATCH .../policies/{policyId} (USSChangePolicy or USSChangePolicyPatch) to a UAE Server. The UAE Server responds with 2a. 200 OK (USSChangePolicy) / 204 No Content or 2b. 4xx/5xx. + +**Figure 5.4.2.2.3-1: Procedure for USS Change Policy Update** + +1. In order to request the update/modification of an existing USS Change Policy, the UASS shall send an HTTP PUT/PATCH request to the UAE Server targeting the corresponding "Individual USS Change Policy" resource, with the request body including the USSChangePolicy data structure (in case the HTTP PUT method is used) or the USSChangePolicyPatch data structure (in case the HTTP PATCH method is used). + +NOTE: An alternative UASS (i.e. other than the one that requested the creation of the targeted resource) can initiate this request. + +If the UAE Server is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI of the resource located in an alternative UAE Server, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UAE Server shall respond with either: + +- an HTTP "200 OK" status code with the response body containing a representation of the updated/modified "Individual USS Change Policy" resource and potentially additional information within the USSChangePolicy data structure; or +- an HTTP "204 No Content" status code. + +2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP PUT/PATCH response body, as specified in clause 6.3.7. + +#### 5.4.2.2.3 USS Change Policy Deletion + +Figure 5.4.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to delete an existing USS Change Policy (see also clause 7.6 of 3GPP°TS°23.255°[6]). + +![Sequence diagram for USS Change Policy Deletion. A UASS sends a DELETE .../policies/{policyId} () request to a UAE Server. The UAE Server responds with 2a. 204 No Content or 2b. 4xx/5xx.](20136850feb70fd71c7d41cdae203ebb_img.jpg) + +``` +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: + UASS->>UAE_Server: DELETE .../policies/{policyId} () + Note right of UAE_Server: + UAE_Server-->>UASS: 2a. 204 No Content + Note right of UAE_Server: + UAE_Server-->>UASS: 2b. 4xx/5xx +``` + +Sequence diagram for USS Change Policy Deletion. A UASS sends a DELETE .../policies/{policyId} () request to a UAE Server. The UAE Server responds with 2a. 204 No Content or 2b. 4xx/5xx. + +**Figure 5.4.2.2.3-1: Procedure for USS Change Policy Deletion** + +1. In order to request the deletion of an existing USS Change Policy, the UASS shall send an HTTP DELETE request to the UAE Server targeting the corresponding "Individual USS Change Policy" resource. + +NOTE: An alternative UASS (i.e. other than the one that requested the creation of the targeted resource) can initiate this request. + +- 2a. Upon success, the UAE Server shall respond with an HTTP "204 No Content" status code. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP DELETE response body, as specified in clause 6.3.7. + +#### 5.4.2.3 UAE\_ChangeUSSManagement\_RequestUSSChange + +##### 5.4.2.3.1 General + +This service operation is used by a UASS to request USS change. + +The following procedures are supported by the "UAE\_ChangeUSSManagement\_RequestUSSChange" service operation: + +- USS Change Request. + +##### 5.4.2.3.2 USS Change Request + +Figure 5.4.2.3.2-1 depicts a scenario where a UASS sends a request to the UAE Server to request USS change (see also clause 7.6 of 3GPP°TS°23.255°[6]). + +![Sequence diagram showing the procedure for USS Change Request. A UASS sends a POST .../request-usschange (USSChangeReq) to a UAE Server. The UAE Server responds with either 2a. 204 No Content or 2b. 4xx/5xx.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. Request USS change + UASS->>UAE_Server: POST .../request-usschange (USSChangeReq) + Note right of UAE_Server: 2a. 204 No Content / 2b. 4xx/5xx + UAE_Server-->>UASS: Response + +``` + +Sequence diagram showing the procedure for USS Change Request. A UASS sends a POST .../request-usschange (USSChangeReq) to a UAE Server. The UAE Server responds with either 2a. 204 No Content or 2b. 4xx/5xx. + +**Figure 5.4.2.3.2-1: Procedure for USS Change Request** + +1. In order to request USS change, the UASS shall send an HTTP POST request (custom operation: "RequestUssChange") to the UAE Server, with the request URI set to "{apiRoot}/uae-usschange-mngt//request-usschange", and the request body including the USSChangeReq data structure. + +If the UAE Server is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI of the resource located in an alternative UAE Server, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UAE Server shall respond with an HTTP "204 No Content" status code. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.3.7. + +#### 5.4.2.4 UAE\_ChangeUSSManagement\_Notify + +##### 5.4.2.4.1 General + +This service operation is used by a UAE Server to notify a previously subscribed UASS either: + +- on USS Change Policy Configuration completion status; +- on USS change (i.e. that a USS change was performed); or +- when USS change needs to be triggered. + +The following procedures are supported by the "UAE\_ChangeUSSManagement\_Notify" service operation: + +- USS Change Policy Configuration Status Notification. +- USS Change Notification. +- USS Change Trigger Notification. + +##### 5.4.2.4.2 USS Change Policy Configuration Status Notification + +Figure 5.4.2.4.2-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on the status of USS Change Policy Configuration (see also clause 7.6 of 3GPP TS 23.255 [6]). + +![Sequence diagram for USS Change Policy Configuration Status Notification procedure. A UAE Server sends a POST {notifUri}/usschange-policy (USSChangePolConfigNotif) request to a UASS. The UASS responds with either 2a. 204 No Content or 2b. 4xx/5xx.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` +sequenceDiagram + participant UAE Server + participant UASS + Note left of UAE Server: POST {notifUri}/usschange-policy (USSChangePolConfigNotif) + UAE Server->>UASS: Request + Note right of UASS: 2a. 204 No Content + Note right of UASS: 2b. 4xx/5xx + UASS-->>UAE Server: Response +``` + +Sequence diagram for USS Change Policy Configuration Status Notification procedure. A UAE Server sends a POST {notifUri}/usschange-policy (USSChangePolConfigNotif) request to a UASS. The UASS responds with either 2a. 204 No Content or 2b. 4xx/5xx. + +**Figure 5.4.2.4.2-1: USS Change Policy Configuration Status Notification procedure** + +1. In order to notify a UASS on the status of USS Change Policy Configuration, the UAE Server shall send an HTTP POST request to the UASS with the request URI set to "{notifUri}/usschange-policy", where the "notifUri" is set to the value received from the UASS during the USS Change Policy Creation/Update procedure defined in clause 5.4.2.2, and the request body including the USSChangePolConfigNotif data structure. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UASS shall respond to the UAE Server with an HTTP "204 No Content" status code to acknowledge the reception of the notification. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.3.7. + +#### 5.4.2.4.3 USS Change Notification + +Figure 5.4.2.4.3-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS that a USS change was performed (see also clause 7.6 of 3GPP TS 29.255°[6]). + +![Sequence diagram for USS Change Notification procedure. A UAE Server sends a POST {notifUri}/usschange (USSChangeNotif) request to a UASS. The UASS responds with either 2a. 204 No Content or 2b. 4xx/5xx.](7a02de7ed198501f7a4f6ca37c3f28c5_img.jpg) + +``` +sequenceDiagram + participant UAE Server + participant UASS + Note left of UAE Server: POST {notifUri}/usschange (USSChangeNotif) + UAE Server->>UASS: Request + Note right of UASS: 2a. 204 No Content + Note right of UASS: 2b. 4xx/5xx + UASS-->>UAE Server: Response +``` + +Sequence diagram for USS Change Notification procedure. A UAE Server sends a POST {notifUri}/usschange (USSChangeNotif) request to a UASS. The UASS responds with either 2a. 204 No Content or 2b. 4xx/5xx. + +**Figure 5.4.2.4.3-1: USS Change Notification procedure** + +1. In order to notify a UASS that a USS change was performed, the UAE Server shall send an HTTP POST request to the UASS with the request URI set to "{notifUri}/usschange", where the "notifUri" is set to the value received from the UASS during the USS Change Policy Creation/Update procedure defined in clause 5.4.2.2, and the request body including the USSChangeNotif data structure. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UASS shall respond to the UAE Server with an HTTP "204 No Content" status code to acknowledge the reception of the notification. + +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.3.7. + +#### 5.4.2.4.4 USS Change Trigger Notification + +Figure 5.4.2.4.4-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS that a USS change should be triggered (see also clause 7.6 of 3GPP TS 23.255[6]). + +![Sequence diagram showing the USS Change Trigger Notification procedure between a UAE Server and a UASS.](f0a97d0d3818a253c1d2a009966081b1_img.jpg) + +``` +sequenceDiagram + participant UAE Server + participant UASS + Note right of UAE Server: POST {notifUri}/usschange-trigger (USSChangeTriggerNotif) + UAE Server->>UASS: Request + Note left of UASS: 2a. 204 No Content + Note left of UASS: 2b. 4xx/5xx + UASS-->>UAE Server: Response +``` + +The diagram illustrates the interaction between a UAE Server and a UASS. The UAE Server sends a POST request to the UASS with the URI {notifUri}/usschange-trigger and the body USSChangeTriggerNotif. The UASS responds with either a 204 No Content status code (2a) or a 4xx/5xx status code (2b). + +Sequence diagram showing the USS Change Trigger Notification procedure between a UAE Server and a UASS. + +**Figure 5.4.2.4.4-1: USS Change Trigger Notification procedure** + +1. In order to notify a UASS that a USS change should be triggered, the UAE Server shall send an HTTP POST request to the UASS with the request URI set to "{notifUri}/usschange-trigger", where the "notifUri" is set to the value received from the UASS during the USS Change Policy Creation/Update procedure defined in clause 5.4.2.2, and the request body including the USSChangeTriggerNotif data structure. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UASS shall respond to the UAE Server with an HTTP "204 No Content" status code to acknowledge the reception of the notification. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.3.7. + +## 5.5 UAE\_DAASupport Service + +### 5.5.1 Service Description + +The UAE\_DAASupport service exposed by the UAE Server enables a UASS (e.g. USS/UTM) to: + +- create/update/delete DAA Policies; +- receive DAA Policy Configuration Completion Status notifications; +- receive DAA Event notifications; and +- inform about and request the management of the detected DAA related events. + +### 5.5.2 Service Operations + +#### 5.5.2.1 Introduction + +The service operations defined for the UAE\_DAASupport service are shown in table 5.5.2.1-1. + +**Table 5.5.2.1-1: UAE\_DAASupport Service Operations** + +| Service Operation Name | Description | Initiated by | +|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| UAE_DAASupport_Manage | This service operation enables a UASS to create/update/delete a DAA Application Policy. | e.g. UASS | +| UAE_DAASupport_InformDAAEvent | This service operation enables a UASS to send the detected DAA related events. | e.g. UASS | +| UAE_DAASupport_Notify | This service operation enables a UAE Server to notify a previously subscribed UASS either:
  • - on DAA Policy Configuration Completion Status; or
  • - on detected DAA related events.
| e.g. UASS | + +#### 5.5.2.2 UAE\_DAASupport\_Manage + +##### 5.5.2.2.1 General + +This service operation is used by a UASS to request the creation/update/deletion of a DAA Policy at the UAE Server. + +The following procedures are supported by the "UAE\_DAASupport\_Manage" service operation: + +- DAA Policy Creation. +- DAA Policy Update. +- DAA Policy Deletion. + +##### 5.5.2.2.2 DAA Policy Creation + +Figure 5.5.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to create a DAA Policy (see also clause 7.7 of 3GPP TS 23.255 [6]). + +![Sequence diagram for DAA Policy Creation. A UASS sends a POST .../policies (DAAPolReq) to a UAE Server. The UAE Server responds with 2a. 201 Created (DAAPolResp) on success or 2b. 4xx/5xx on failure.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. Request creation + UASS->>UAE_Server: POST .../policies (DAAPolReq) + Note right of UAE_Server: 2a. Success / 2b. Failure + UAE_Server-->>UASS: 2a. 201 Created (DAAPolResp) + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: 2b. 4xx/5xx + +``` + +Sequence diagram for DAA Policy Creation. A UASS sends a POST .../policies (DAAPolReq) to a UAE Server. The UAE Server responds with 2a. 201 Created (DAAPolResp) on success or 2b. 4xx/5xx on failure. + +**Figure 5.5.2.2.2-1: Procedure for DAA Policy Creation** + +1. In order to request the creation of a DAA Policy, the UASS shall send an HTTP POST request to the UAE Server targeting the "DAA Policies" resource, with the request body including the DAAPolReq data structure. +- 2a. Upon success, the UAE Server shall respond with an HTTP "201 Created" status code with the response body containing a representation of the created "Individual DAA Policy" resource and potentially additional information within the DAAPolResp data structure. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.4.7. + +### 5.5.2.2.3 DAA Policy Update + +Figure 5.5.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to update an existing DAA Policy (see also clause 7.7 of 3GPP TS 23.255 [6]). + +![Sequence diagram for DAA Policy Update. A UASS sends a PUT or PATCH .../policies/{policyId} (DAAPolicy or DAAPolicyPatch) to a UAE Server. The UAE Server responds with 2a. 200 OK (DAAPolicy) / 204 No Content on success or 2b. 4xx/5xx on failure.](dc1f232cfd39be5c20b21374ad4c04c0_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. Request update + UASS->>UAE_Server: PUT or PATCH .../policies/{policyId} (DAAPolicy or DAAPolicyPatch) + Note right of UAE_Server: 2a. Success / 2b. Failure + UAE_Server-->>UASS: 2a. 200 OK (DAAPolicy) / 204 No Content + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: 2b. 4xx/5xx + +``` + +Sequence diagram for DAA Policy Update. A UASS sends a PUT or PATCH .../policies/{policyId} (DAAPolicy or DAAPolicyPatch) to a UAE Server. The UAE Server responds with 2a. 200 OK (DAAPolicy) / 204 No Content on success or 2b. 4xx/5xx on failure. + +**Figure 5.5.2.2.3-1: Procedure for DAA Policy Update** + +1. In order to request the update/modification of an existing DAA Policy, the UASS shall send an HTTP PUT/PATCH request to the UAE Server targeting the corresponding "Individual DAA Policy" resource, with the request body including the DAAPolicy data structure (in case the HTTP PUT method is used) or the DAAPolicyPatch data structure (in case the HTTP PATCH method is used). + +NOTE: An alternative UASS (i.e. other than the one that requested the creation of the targeted resource) can initiate this request. + +If the UAE Server is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI of the resource located in an alternative UAE Server, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UAE Server shall respond with either: + - an HTTP "200 OK" status code with the response body containing a representation of the updated/modified "Individual DAA Policy" resource and potentially additional information within the DAAPolicy data structure; or + +- an HTTP "204 No Content" status code. + +2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP PUT/PATCH response body, as specified in clause 6.4.7. + +### 5.5.2.2.3 DAA Policy Deletion + +Figure 5.5.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to delete an existing DAA Policy (see also clause 7.7 of 3GPP°TS°23.255°[6]). + +![Sequence diagram for DAA Policy Deletion](94fd137860c16c8dfd75512f10161fe8_img.jpg) + +``` +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: - an HTTP "204 No Content" status code. + Note left of UASS: 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP PUT/PATCH response body, as specified in clause 6.4.7. + UASS->>UAE_Server: DELETE .../policies/{policyId} () + Note right of UAE_Server: 2a. 204 No Content + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: +``` + +The diagram illustrates the interaction between a UASS and a UAE Server for DAA Policy Deletion. The UASS sends a DELETE request to the UAE Server. The UAE Server responds with either a 204 No Content status code (2a) or an error status code (2b). The UASS also receives an HTTP "204 No Content" status code and error information as specified in clause 6.4.7. + +Sequence diagram for DAA Policy Deletion + +**Figure 5.5.2.2.3-1: Procedure for DAA Policy Deletion** + +1. In order to request the deletion of an existing DAA Policy, the UASS shall send an HTTP DELETE request to the UAE Server targeting the corresponding "Individual DAA Policy" resource. + +NOTE: An alternative UASS (i.e. other than the one that requested the creation of the targeted resource) can initiate this request. + +2a. Upon success, the UAE Server shall respond with an HTTP "204 No Content" status code. + +2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP DELETE response body, as specified in clause 6.4.7. + +### 5.5.2.3 UAE\_DAASupport\_InformDAAEvent + +#### 5.5.2.3.1 General + +This service operation is used by a UASS to inform about and request the management of the detected DAA related event(s). + +The following procedures are supported by the "UAE\_DAASupport\_InformDAAEvent" service operation: + +- DAA Events Information Request. + +#### 5.5.2.3.2 DAA Events Information Request + +Figure 5.5.2.3.2-1 depicts a scenario where a UASS sends a request to the UAE Server to inform about and request the management of the detected DAA related event(s) (see also clause 7.7 of 3GPP°TS°23.255°[6]). + +![Sequence diagram for Figure 5.5.2.3.2-1: Procedure for DAA Events Information Request. The diagram shows a UASS sending a POST request to a UAE Server. The request is POST .../policies (InformDAAEventsReq). The UAE Server responds with either 2a. 204 No Content or 2b. 4xx/5xx.](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note right of UASS: POST .../policies (InformDAAEventsReq) + UASS->>UAE_Server: Request + Note left of UAE_Server: 2a. 204 No Content +2b. 4xx/5xx + UAE_Server-->>UASS: Response + +``` + +Sequence diagram for Figure 5.5.2.3.2-1: Procedure for DAA Events Information Request. The diagram shows a UASS sending a POST request to a UAE Server. The request is POST .../policies (InformDAAEventsReq). The UAE Server responds with either 2a. 204 No Content or 2b. 4xx/5xx. + +**Figure 5.5.2.3.2-1: Procedure for DAA Events Information Request** + +1. In order to send DAA related event(s) information, the UASS shall send an HTTP POST request (custom operation: "InformDAAEvents") to the UAE Server, with the request URI set to "{apiRoot}/uaedaa//inform-events" and the request body including the InformDAAEventsReq data structure. + +If the UAE Server is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI of the resource located in an alternative UAE Server, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UAE Server shall respond with an HTTP "204 No Content" status code. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.4.7. + +#### 5.5.2.4 UAE\_DAASupport\_Notify + +##### 5.5.2.4.1 General + +This service operation is used by a UAE Server to notify a previously subscribed UASS either: + +- on DAA Policy Configuration Completion Status; or +- on DAA related event(s). + +The following procedures are supported by the "UAE\_DAASupport\_Notify" service operation: + +- DAA Policy Configuration Completion Status Notification. +- DAA Event Notification. + +##### 5.5.2.4.2 DAA Policy Configuration Completion Status Notification + +Figure 5.5.2.4.2-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on the status of DAA Policy Configuration (see also clause 7.7 of 3GPP TS 23.255 [6]). + +![Sequence diagram for Figure 5.5.2.4.2-1: DAA Policy Configuration Completion Status Notification procedure. The diagram shows a UAE Server sending a POST request to a UASS. The request is POST {notifUri}/daa-policy (DAAPolConfigNotif). The UASS responds with either 2a. 204 No Content or 2b. 4xx/5xx.](4b935d396d60146aaa66ac7372c758b7_img.jpg) + +``` + +sequenceDiagram + participant UAE_Server as UAE Server + participant UASS + Note left of UAE_Server: POST {notifUri}/daa-policy (DAAPolConfigNotif) + UAE_Server->>UASS: Request + Note right of UASS: 2a. 204 No Content +2b. 4xx/5xx + UASS-->>UAE_Server: Response + +``` + +Sequence diagram for Figure 5.5.2.4.2-1: DAA Policy Configuration Completion Status Notification procedure. The diagram shows a UAE Server sending a POST request to a UASS. The request is POST {notifUri}/daa-policy (DAAPolConfigNotif). The UASS responds with either 2a. 204 No Content or 2b. 4xx/5xx. + +**Figure 5.5.2.4.2-1: DAA Policy Configuration Completion Status Notification procedure** + +1. In order to notify a UASS on the status of DAA Policy Configuration, the UAE Server shall send an HTTP POST request to the UASS with the request URI set to "{notifUri}/daa-policy", where the "notifUri" is set to the value received from the UASS during the DAA Policy Creation/Update procedure defined in clause 5.5.2.2, and the request body including the DAAPolConfigNotif data structure. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UASS shall respond to the UAE Server with an HTTP "204 No Content" status code to acknowledge the reception of the notification. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.4.7. + +#### 5.5.2.4.3 DAA Event Notification + +Figure 5.5.2.4.3-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on DAA related event(s) (see also clause 7.7 of 3GPP TS 23.255[6]). + +![Sequence diagram of DAA Event Notification procedure between UAE Server and UASS.](836b0790cef5469a167fa8931df4e408_img.jpg) + +``` +sequenceDiagram + participant UAE Server + participant UASS + Note left of UAE Server: POST {notifUri}/daa-events (DAAEventsInfo) + UAE Server->>UASS: POST {notifUri}/daa-events (DAAEventsInfo) + Note right of UASS: 2a. 200 OK (DAAEventsInfo) / 204 No Content + Note right of UASS: 2b. 4xx/5xx + UASS-->>UAE Server: 2a. 200 OK (DAAEventsInfo) / 204 No Content + Note right of UASS: 2b. 4xx/5xx + UASS-->>UAE Server: 2b. 4xx/5xx +``` + +The diagram illustrates the interaction between a UAE Server and a UASS. The UAE Server sends a POST request to the UASS with the URI "{notifUri}/daa-events" and a body containing "DAAEventsInfo". The UASS responds with either a "200 OK" status code with a "DAAEventsInfo" body, or a "204 No Content" status code (case 2a), or an error status code in the 4xx or 5xx range (case 2b). The response is sent back to the UAE Server. + +Sequence diagram of DAA Event Notification procedure between UAE Server and UASS. + +Figure 5.5.2.4.3-1: DAA Event Notification procedure + +1. In order to notify a UASS on the detected DAA event(s), the UAE Server shall send an HTTP POST request to the UASS with the request URI set to "{notifUri}/daa-events", where the "notifUri" is set to the value received from the UASS during the DAA Policy Creation/Update procedure defined in clause 5.5.2.2, and the request body including the DAAEventsInfo data structure. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UASS shall respond to the UAE Server with either: + - an HTTP "200 OK" status code with the response body containing updated/additional DAA event(s) related information within the DAAEventsInfo data structure, if the UASS needs to provide information about additional DAA event(s) or updated DAA event(s) related information; or + - an HTTP "204 No Content" status code, if the UASS does not need to provide any updated/additional DAA event(s) related information. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.4.7. + +--- + +## 6 API Definitions + +### 6.1 UAE\_C2OperationModeManagement Service API + +#### 6.1.1 Introduction + +The UAE\_C2OperationModeManagement service shall use the UAE\_C2OperationModeManagement API. + +The API URI of the UAE\_C2OperationModeManagement API shall be: + +**{apiRoot}
/** + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [2], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. +- The shall be "uae-c2opmode-mngt". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. + +NOTE: When 3GPP TS 29.122 [2] is referenced for the common protocol and interface aspects for API definition in the clauses under clause 6.1, the UAE Server takes the role of the SCEF and the UASS takes the role of the SCS/AS. + +#### 6.1.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [2] shall apply for the UAE\_C2OperationModeManagement API. + +#### 6.1.3 Resources + +There are no resources defined for this API in this release of the specification. + +#### 6.1.4 Custom Operations without associated resources + +##### 6.1.4.1 Overview + +The structure of the custom operation URIs of the UAE\_C2OperationModeManagement API is shown in Figure 6.1.4.1-1. + +![Diagram showing the custom operation URI structure. A rounded rectangle contains the placeholder '{apiRoot}/uae-c2opmode-mngt/'. A line extends from the bottom of this rectangle to a dashed rectangle containing the path '/initiate'.](2837ffdadcdb1e5bababa56b564e56ed_img.jpg) + +``` + +graph TD + A["{apiRoot}/uae-c2opmode-mngt/"] --> B[/initiate] + style B stroke-dasharray: 5 5 + +``` + +Diagram showing the custom operation URI structure. A rounded rectangle contains the placeholder '{apiRoot}/uae-c2opmode-mngt/'. A line extends from the bottom of this rectangle to a dashed rectangle containing the path '/initiate'. + +**Figure 6.1.4.1-1: Custom operation URI structure of the UAE\_C2OperationModeManagement API** + +Table 6.1.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the UAE\_C2OperationModeManagement API. + +**Table 6.1.4.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| Initiate | /initiate | POST | Enables a UASS to request to provision C2 Operation Mode configuration information for a UAS (i.e. pair of UAV and UAV-C) to the UAE Server. | + +## 6.1.4.2 Operation: Initiate + +### 6.1.4.2.1 Description + +The custom operation enables a UASS to initiate the configuration of C2 operation modes for a UAS (i.e. pair of UAV and UAV-C) by communicating the associated C2 Operation Mode configuration information to the UAE Server. + +### 6.1.4.2.2 Operation Definition + +This operation shall support the request data structures and the response data structures and response codes specified in tables 6.1.4.2.2-1 and 6.1.4.2.2-2. + +**Table 6.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------| +| ConfigureData | M | 1 | Contains the parameters to request to provision C2 Operation Mode configuration information for a UAS (i.e. pair of UAV and UAV-C). | + +**Table 6.1.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| C2Result | M | 1 | 200 OK | The communicated C2 Operation Mode configuration information was successfully received.
The response body shall contain the feedback of the UAE Server on whether this C2 Operation Mode configuration request is confirmed (i.e. can be undertaken by the UAE Server) or not. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +**Table 6.1.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative UAE Server. | + +**Table 6.1.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative UAE Server. | + +## 6.1.5 Notifications + +### 6.1.5.1 General + +Notifications shall comply to clause 5.2.5 of 3GPP TS 29.122 [2]. + +Table 6.1.5.1-1: Notifications overview + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------------------------------------------|------------------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| C2 Operation Mode Management Completion Notification | {notificationUri}/c2mode-mngt-completion | c2mode-mngt-completion (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS on the C2 operation mode management completion status for the concerned UAS (i.e. pair of UAV and UAV-C). | +| Selected C2 Communication Mode Notification | {notificationUri}/inform-selec-c2mode | inform-selec-c2mode (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS on the C2 communication mode selected by the concerned UAS (i.e. pair of UAV and UAV-C). | +| C2 Communication Mode Switching Notification | {notificationUri}/inform-c2mode-switch | inform-c2mode-switch (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS when C2 communication mode switching is carried out for the concerned UAS (i.e. pair of UAV and UAV-C) and possibly request confirmation from the UASS. | + +## 6.1.5.2 C2 Operation Mode Management Completion Notification + +### 6.1.5.2.1 Description + +The C2 Operation Mode Management Completion Notification is used by a UAE Server to notify a previously subscribed UASS on the C2 operation mode management completion status for a UAS (i.e. pair of UAV and UAV-C). + +### 6.1.5.2.2 Target URI + +The Callback URI "{notificationUri}/c2mode-mngt-completion" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +Table 6.1.5.2.2-1: Callback URI variables + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------| +| notificationUri | Uri | String formatted as a URI containing the Callback URI. | + +### 6.1.5.2.3 Standard Methods + +#### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-2. + +Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------| +| C2OpModeMngtCompStatus | M | 1 | Contains the C2 operation mode management completion status for the concerned UAS (i.e. pair of UAV and UAV-C). | + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The C2 operation mode management completion status for the concerned UAS (i.e. pair of UAV and UAV-C) is successfully received and acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +**Table 6.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +**Table 6.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +## 6.1.5.3 Selected C2 Communication Mode Notification + +### 6.1.5.3.1 Description + +The Selected C2 Communication Mode Notification is used by a UAE Server to notify a previously subscribed UASS on the C2 communication mode selected by a UAS (i.e. pair of UAV and UAV-C). + +### 6.1.5.3.2 Target URI + +The Callback URI "{notificationUri}/inform-selec-c2mode" shall be used with the callback URI variables defined in table 6.1.5.3.2-1. + +**Table 6.1.5.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------| +| notificationUri | Uri | String formatted as a URI containing the Callback URI. | + +### 6.1.5.3.3 Standard Methods + +#### 6.1.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.3.3.1-1 and the response data structures and response codes specified in table 6.1.5.3.3.1-2. + +**Table 6.1.5.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------| +| SelectedC2CommModeNotif | M | 1 | Contains information on the C2 Communication Mode selected by the concerned UAS (i.e. pair of UAV and UAV-C). | + +**Table 6.1.5.3.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The C2 Communication Mode selected by the concerned UAS (i.e. pair of UAV and UAV-C) is successfully received and acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +**Table 6.1.5.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +**Table 6.1.5.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +## 6.1.5.4 C2 Communication Mode Switching Notification + +### 6.1.5.4.1 Description + +The C2 Communication Mode Switching Notification is used by a UAE Server to notify a previously subscribed UASS on the targeted C2 Communication Mode switching for a UAS (i.e. pair of UAV and UAV-C). + +### 6.1.5.4.2 Target URI + +The Callback URI "{notificationUri}/inform-c2mode-switch" shall be used with the callback URI variables defined in table 6.1.5.4.2-1. + +**Table 6.1.5.4.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------| +| notificationUri | Uri | String formatted as a URI containing the Callback URI. | + +### 6.1.5.4.3 Standard Methods + +#### 6.1.5.4.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.4.3.1-1 and the response data structures and response codes specified in table 6.1.5.4.3.1-2. + +**Table 6.1.5.4.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| C2CommModeSwitchNotif | M | 1 | Contains information on the targeted C2 Communication Mode switching for the concerned UAS (i.e. pair of UAV and UAV-C). | + +**Table 6.1.5.4.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| C2Result | M | 1 | 200 OK | The targeted C2 Communication Mode switching for the concerned UAS (i.e. pair of UAV and UAV-C) is successfully received.
The response body shall contain the feedback of the UASS on whether this C2 Communication Mode switching is confirmed (i.e. validated) or not. | +| n/a | | | 204 No Content | The targeted C2 Communication Mode switching for the concerned UAS (i.e. pair of UAV and UAV-C) is successfully received and acknowledged, and the UASS does not need to confirm (i.e. validate) it. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +**Table 6.1.5.4.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +**Table 6.1.5.4.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +## 6.1.6 Data Model + +### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the UAE\_C2OperationModeManagement API. + +**Table 6.1.6.1-1: UAE\_C2OperationModeManagement API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ConfigureData | 6.1.6.2.2 | Represents the parameters to request to provision C2 Operation Mode configuration information for a UAS (i.e. pair of UAV and UAV-C). | | +| SelectedC2CommModeNotif | 6.1.6.2.3 | Represents information on the C2 Communication Mode selected by a UAS (i.e. pair of UAV and UAV-C). | | +| C2CommModeSwitchNotif | 6.1.6.2.4 | Represents information on the targeted C2 Communication Mode switching for a UAS (i.e. pair of UAV and UAV-C). | | +| C2LinkQualityThrlds | 6.1.6.2.11 | Represents the C2 link quality thresholds. | | +| C2OpModeMngtCompStatus | 6.1.6.2.9 | Represents the C2 operation mode management completion status for a UAS (i.e. pair of UAV and UAV-C). | | +| C2OpModeStatus | 6.1.6.3.6 | Represents the C2 operation mode management completion status. | | +| C2Result | 6.1.6.2.5 | Represents the result of an action related to C2 of a UAS. | | +| C2ServiceArea | 6.1.6.2.8 | Represents a C2 service area. | | +| C2SwitchPolicies | 6.1.6.2.10 | Represents the C2 operation mode switching policies. | | +| UasId | 6.1.6.2.6 | Represents the identifier of a UAS (i.e. pair of UAV and UAV-C). | | +| UavId | 6.1.6.2.7 | Represents the identifier of a UAV (e.g. UAV, UAV-C). | | +| C2CommMode | 6.1.6.3.3 | Represents the C2 Communication Modes. | | +| C2CommModeSwitching | 6.1.6.3.4 | Represents the C2 Communication Mode Switching types. | | +| C2SwitchingCause | 6.1.6.3.5 | Represents the C2 Communication Mode switching cause. | | + +Table 6.1.6.1-2 specifies data types re-used by the UAE\_C2OperationModeManagement API from other specifications, including a reference to their respective specifications, and when needed, a short description of their use within the UAE\_C2OperationModeManagement API. + +**Table 6.1.6.1-2: UAE\_C2OperationModeManagement API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|--------------------|---------------------------------------------------------------|---------------| +| ExternalGroupId | 3GPP TS 29.122 [2] | Represents an external group identifier. | | +| GeographicArea | 3GPP TS 29.572 [8] | Represents a geographical area. | | +| Gpsi | 3GPP TS 29.571 [7] | Represents a GPSI. | | +| Ncgi | 3GPP TS 29.571 [7] | Represents an NCGI. | | +| PacketLossRate | 3GPP TS 29.571 [7] | Represents the packet loss rate. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features. | | +| Tai | 3GPP TS 29.571 [7] | Represents a tracking area identifier. | | +| Uri | 3GPP TS 29.122 [2] | Represents a URI. | | + +## 6.1.6.2 Structured data types + +### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +6.1.6.2.2 Type: ConfigureData + +**Table 6.1.6.2.2-1: Definition of type ConfigureData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uassId | Uri | M | 1 | Contains the identity of the UASS communicating the C2 Operation Mode configuration information for a UAS (i.e. pair of UAV and UAV-C). It takes the form of a URI. | | +| uasId | UasId | M | 1 | Contains the identity of the UAS (i.e. pair of UAV and UAV-C) to which the provided C2 Operation Mode configuration information is destined.

This shall be either in the form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| allowedC2CommModes | array(C2CommMode) | M | 1..N | Contains the allowed C2 communication modes for the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute. | | +| c2CommModeSwitchTypes | array(C2CommModeSwitching) | M | 1..N | Contains the C2 Communication Mode switching types to be supported by the UAE Server for the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute.
The possible switching types are:
  • - from "Direct C2 Communication" to "Network-Assisted C2 Communication";
  • - from "Network-Assisted C2 Communication" to "Direct C2 Communication";
  • - from "Direct C2 Communication" to "UTM-Navigated C2 Communication"; and/or
  • - from "Network-Assisted C2 Communication" to "UTM-Navigated C2 Communication".
| | +| notificationUri | Uri | M | 1 | Contains the notification URI via which the UASS desires to receive notifications from the UAE Server. | | +| primaryC2CommMode | C2CommMode | M | 1 | Contains the primary C2 communication mode to be used by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute. It shall be set to either "DIRECT_C2_COMMUNICATION" or "NETWORK_ASSISTED_C2_COMMUNICATION". | | +| secondaryC2CommMode | C2CommMode | O | 0..1 | Contains the secondary C2 communication mode to be used by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute. When provided, it shall be set to either "DIRECT_C2_COMMUNICATION" or "NETWORK_ASSISTED_C2_COMMUNICATION". | | +| c2SwitchPolicies | C2SwitchPolicies | M | 1 | Contains the C2 operation mode switching policies. | | +| c2ServiceArea | C2ServiceArea | O | 0..1 | Contains the service area within which the C2 operation mode management request applies. This shall be either a geographical area or a topological area. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.1.8.

This attribute shall be provided if at least one feature is supported by the UASS. | | + +## 6.1.6.2.3 Type: SelectedC2CommModeNotif + +Table 6.1.6.2.3-1: Definition of type SelectedC2CommModeNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identity of the UAS (i.e. pair of UAV and UAV-C) to which the notification is related.

This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| selPrimaryC2CommMode | C2CommMode | M | 1 | Contains the primary C2 communication mode selected by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute. It shall be set to either "DIRECT_C2_COMMUNICATION" or "NETWORK_ASSISTED_C2_COMMUNICATION". | | +| selSecondaryC2CommMode | C2CommMode | O | 0..1 | Contains the secondary C2 communication mode to be used by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute. When provided, it shall be set to either "DIRECT_C2_COMMUNICATION" or "NETWORK_ASSISTED_C2_COMMUNICATION". | | + +## 6.1.6.2.4 Type: C2CommModeSwitchNotif + +Table 6.1.6.2.4-1: Definition of type C2CommModeSwitchNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|---------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uaeServerId | Uri | M | 1 | Contains the identifier of the UAE Server that is sending the notification and requesting C2 Communication Mode switching confirmation for a UAS (i.e. pair of UAV and UAV-C) from the UASS. | | +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the provided C2 Communication Mode switching information is related.

This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| c2CommModeSwitchType | C2CommModeSwitching | M | 1 | Contains the targeted C2 Communication Mode switching for the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute. | | +| switchingCause | C2SwitchingCause | O | 0..1 | Contains the cause that triggers the C2 Communication Mode switching. | | + +## 6.1.6.2.5 Type: C2Result + +Table 6.1.6.2.5-1: Definition of type C2Result + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| c2OpConfirmed | Boolean | M | 1 | This attribute indicates whether the requested action (e.g. targeted C2 Communication Mode switching, C2 Operation Mode configuration information provisioning) is confirmed or not.
  • - "true" means that the requested action is confirmed or approved.
  • - "false" means that the requested action is not confirmed or not approved.
| | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.
This attribute shall be provided by the UAE Server in the response to a request in which the UASS provided the list of features that it supports. | | + +## 6.1.6.2.6 Type: UasId + +Table 6.1.6.2.6-1: Definition of type UasId + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| groupId | ExternalGroupId | C | 0..1 | Contains the identity of a UAS (i.e. a pair of UAV and UAV-C) in the form of a group identifier.
(NOTE) | | +| individualUasId | array(UavId) | C | 0..N | Contains the identity of a UAS (i.e. a pair of UAV and UAV-C) in the form of a collection of individual identifiers of the UAV and UAV-C composing the UAS.
(NOTE) | | + +NOTE: The "groupId" attribute and the "individualUasId" attribute are mutually exclusive. + +## 6.1.6.2.7 Type: UavId + +Table 6.1.6.2.7-1: Definition of type UavId + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | C | 0..1 | Contains the identity of a UAV or UAV-C in the form of a GPSI.
(NOTE) | | +| caald | string | C | 0..1 | Contains the identity of a UAV or UAV-C in the form of a CAA level UAV ID.
(NOTE) | | + +NOTE: At least one of the "groupId" attribute or the "caald" attribute shall be provided within the UavId data type. + +## 6.1.6.2.8 Type: C2ServiceArea + +Table 6.1.6.2.8-1: Definition of type C2ServiceArea + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------|---------------| +| ncgiList | array(Ncgi) | C | 0..N | Contains a list of NR cell identifier(s) that constitutes the C2 service area. | | +| tailList | array(Tai) | C | 0..N | Contains a list of tracking area identifier(s) that constitutes the C2 service area. | | +| geographicAreaList | array(GeographicArea) | C | 0..N | Contains a list of geographic area(s) that constitutes the C2 service area. | | +| NOTE: Either the "geographicAreaList" attribute or the "ncgiList" attribute and/or the "tailList" attribute shall be provided. | | | | | | + +## 6.1.6.2.9 Type: C2OpModeMngtCompStatus + +Table 6.1.6.2.9-1: Definition of type C2OpModeMngtCompStatus + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the provided C2 operation mode management completion status information is related. | | +| status | C2OpModeStatus | M | 1 | Contains the C2 operation mode management completion status. | | + +## 6.1.6.2.10 Type: C2SwitchPolicies + +Table 6.1.6.2.10-1: Definition of type C2SwitchPolicies + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------------|---------------------|---|-------------|---------------------------------------------------------------------------------------------------------|---------------| +| directC2LinkQualityThrlds | C2LinkQualityThrlds | O | 0..1 | Contains the threshold(s) used to evaluate the quality of the direct C2 link. | | +| uuC2LinkQualityThrlds | C2LinkQualityThrlds | O | 0..1 | Contains the threshold(s) used to evaluate the quality of the Network-Assisted (i.e. Uu based) C2 link. | | +| NOTE: Either the "directC2LinkQualityThrlds" attribute, the "uuC2LinkQualityThrlds" attribute or both shall be provided. | | | | | | + +## 6.1.6.2.11 Type: C2LinkQualityThrlds + +Table 6.1.6.2.11-1: Definition of type C2LinkQualityThrlds + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------|---------------| +| nrRsrpThrldLow | integer | O | 0..1 | Represents the lower RSRP value threshold for the direct C2 link.
Value range: 0-127.
(NOTE 1) | | +| nrRsrpThrldHigh | integer | O | 0..1 | Represents the upper RSRP value threshold for the direct C2 link.
Value range: 0-127.
(NOTE 2) | | +| nrRsrqThrldLow | integer | O | 0..1 | Represents the lower RSRQ value threshold for the direct C2 link.
Value range: 0-127.
(NOTE 1) | | +| nrRsrqThrldHigh | integer | O | 0..1 | Represents the upper RSRQ value threshold for the direct C2 link.
Value range: 0-127.
(NOTE 2) | | +| packetLossThrldLow | PacketLossRate | O | 0..1 | Represents the lower packet loss rate value threshold for the direct C2 link.
(NOTE 1) | | +| packetLossThrldHigh | PacketLossRate | O | 0..1 | Represents the upper packet loss rate value threshold for the direct C2 link.
(NOTE 2) | | + +NOTE 1: At least one of the "nrRsrpThrldLow", "nrRsrqThrldLow" or "packetLossThrldLow" attributes shall be provided. +NOTE 2: At least one of the "nrRsrpThrldHigh", "nrRsrqThrldHigh" or "packetLossThrldHigh" attributes shall be provided. + +## 6.1.6.3 Simple data types and enumerations + +## 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +Table 6.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 6.1.6.3.3 Enumeration: C2CommMode + +The enumeration C2CommMode represents C2 Communication Modes. It shall comply with the provisions of table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration C2CommMode** + +| Enumeration value | Description | Applicability | +|-----------------------------------|----------------------------------------------------|---------------| +| DIRECT_C2_COMMUNICATION | Represents Direct C2 Communication mode. | | +| NETWORK_ASSISTED_C2_COMMUNICATION | Represents Network-Assisted C2 Communication mode. | | +| UTM_NAVIGATED_C2_COMMUNICATION | Represents UTM-Navigated C2 communication mode. | | + +#### 6.1.6.3.4 Enumeration: C2CommModeSwitching + +The enumeration C2CommModeSwitching represents C2 Communication Mode Switching types. It shall comply with the provisions of table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: Enumeration C2CommModeSwitching** + +| Enumeration value | Description | Applicability | +|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|---------------| +| DIRECT_TO_NETWORK_ASSISTED_C2 | Represents the C2 Communication Mode switching from Direct C2 Communication mode to Network-Assisted C2 Communication mode. | | +| NETWORK_ASSISTED_TO_DIRECT_C2 | Represents the C2 Communication Mode switching from Network-Assisted C2 Communication mode to Direct C2 Communication mode. | | +| DIRECT_TO_UTM_NAVIGATED_C2 | Represents the C2 Communication Mode switching from Direct C2 Communication mode to UTM-Navigated C2 communication mode. | | +| NETWORK_ASSISTED_TO_UTM_NAVIGATED_C2 | Represents the C2 Communication Mode switching from Network-Assisted C2 Communication mode to UTM-Navigated C2 communication mode. | | + +#### 6.1.6.3.5 Enumeration: C2SwitchingCause + +The enumeration C2SwitchingCause represents the C2 Communication Mode switching cause. It shall comply with the provisions of table 6.1.6.3.5-1. + +**Table 6.1.6.3.5-1: Enumeration C2SwitchingCause** + +| Enumeration value | Description | Applicability | +|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| DIRECT_LINK_QUALITY_DEGRADATION | Indicates that the C2 Communication Mode switching was triggered due to a degradation in the direct radio link quality. | | +| DIRECT_LINK_AVAILABLE | Indicates that the C2 Communication Mode switching was triggered due to the availability of a direct link, i.e. direct radio link quality enables its usage. | | +| MOVING_BVLOS | Indicates that the C2 Communication Mode switching was triggered due to the UAV moving BVLOS. | | +| LOCATION_CHANGE | Indicates that the C2 Communication Mode switching was triggered due to an actual or expected location/mobility of the UAV (e.g. which impacts the UAV-to-UAV-C location). | | +| TRAFFIC_CONTROL_NEEDED | Indicates that the C2 Communication Mode switching was triggered due to the necessity to have air traffic control. | | +| SECURITY_REASONS | Indicates that the C2 Communication Mode switching was triggered due to security reasons. | | +| OTHER_REASONS | Indicates that the C2 Communication Mode switching was triggered due to other reasons (e.g. unpredictable event, unknown reason, weather conditions, topography, etc.). | | + +#### 6.1.6.3.6 Enumeration: C2OpModeStatus + +The enumeration C2OpModeStatus represents C2 Operation Mode Management Completion status. It shall comply with the provisions of table 6.1.6.3.6-1. + +**Table 6.1.6.3.6-1: Enumeration C2CommMode** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------------|---------------| +| SUCCESSFUL | Indicates that the C2 operation mode configuration was successful. | | +| NOT_SUCCESSFUL | Indicates that the C2 operation mode configuration was not successful. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +#### 6.1.6.5 Binary data + +##### 6.1.6.5.1 Binary Data Types + +**Table 6.1.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +## 6.1.7 Error Handling + +### 6.1.7.1 General + +For the UAE\_C2OperationModeManagement API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [2]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [2] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [2]. + +In addition, the requirements in the following clauses are applicable for the UAE\_C2OperationModeManagement API. + +### 6.1.7.2 Protocol Errors + +No specific protocol errors for the UAE\_C2OperationModeManagement API are specified. + +### 6.1.7.3 Application Errors + +The application errors defined for the UAE\_C2OperationModeManagement API are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 6.1.8 Feature negotiation + +The optional features listed in table 6.1.8-1 are defined for the UAE\_C2OperationModeManagement API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [2]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.1.9 Security + +The provisions of clause 6 of 3GPP TS 29.122 [2] shall apply for the UAE\_C2OperationModeManagement API. + +## 6.2 UAE\_RealtimeUAVStatus Service API + +### 6.2.1 Introduction + +The UAE\_RealtimeUAVStatus service shall use the UAE\_RealtimeUAVStatus API. + +The API URI of the UAE\_RealtimeUAVStatus API shall be: + +**{apiRoot}
/** + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [2], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. +- The shall be "uae-uav-status". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. + +NOTE: When 3GPP TS 29.122 [2] is referenced for the common protocol and interface aspects for API definition in the clauses under clause 6.2, the UAE Server takes the role of the SCEF and the UASS takes the role of the SCS/AS. + +### 6.2.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [2] shall apply for the UAE\_RealtimeUAVStatus API. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.2.3.1-1 depicts the resource URIs structure for the UAE\_RealtimeUAVStatus API. + +![Diagram showing the hierarchical structure of Resource URIs for the UAE_RealtimeUAVStatus API. The root URI is {apiRoot}/uae-uav-status/. It branches to /subscriptions, which in turn branches to /{subscriptionId}.](147f857b06606c016ce376b7a89934d2_img.jpg) + +``` +graph TD; A["{apiRoot}/uae-uav-status/"] --> B["/subscriptions"]; B --> C["/{subscriptionId}"]; +``` + +Diagram showing the hierarchical structure of Resource URIs for the UAE\_RealtimeUAVStatus API. The root URI is {apiRoot}/uae-uav-status/. It branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 6.2.3.1-1: Resource URIs structure of the UAE\_RealtimeUAVStatus API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods for the UAE\_RealtimeUAVStatus API. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------------------|---------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------| +| Real-time UAV Status Subscriptions | /subscriptions | GET | Retrieve all the active real-time UAV status subscriptions managed by the UAE Server. | +| | | POST | Request the creation of a subscription to real-time UAV status reporting. | +| Individual Real-time UAV Status Subscription | /subscriptions/{subscriptionId} | GET | Retrieve a real-time UAV status subscription resource identified by the provided subscription identifier. | +| | | PUT | Update an existing real-time UAV status subscription resource identified by the provided subscription identifier. | +| | | DELETE | Request the deletion of a real-time UAV status subscription resource identified by the provided subscription identifier. | + +## 6.2.3.2 Resource: Real-time UAV Status Subscriptions + +### 6.2.3.2.1 Description + +This resource represents the collection of real-time UAV status subscriptions managed by the UAE Server. + +### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/uae-uav-status//subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-----------------------------------------| +| apiRoot | string | See clause 5.2.4 of 3GPP TS 29.122 [2]. | + +### 6.2.3.2.3 Resource Standard Methods + +#### 6.2.3.2.3.1 GET + +The GET method allows a UASS to retrieve all the active real-time UAV status subscriptions managed by the UAE Server. This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +Table 6.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(RTUavStatusSubsc) | M | 1..N | 200 OK | Successful case. All the active real-time UAV status subscriptions managed by the UAE Server shall be returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +Table 6.2.3.2.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +Table 6.2.3.2.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +### 6.2.3.2.3.2 POST + +The POST method allows a UASS to request the creation of a subscription to real-time UAV status reporting at the UAE Server. This method shall support the URI query parameters specified in table 6.2.3.2.3.2-1. + +Table 6.2.3.2.3.2-1: URI query parameters supported by the POST method on this resource + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.2-2 and the response data structures and response codes specified in table 6.2.3.2.3.2-3. + +Table 6.2.3.2.3.2-2: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| RTUavStatusSubsc | M | 1 | Represents the parameters to request the creation of a subscription to real-time UAV status reporting. | + +**Table 6.2.3.2.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RTUavStatusSubsc | M | 1 | 201 Created | Successful case. The subscription is successfully created and a representation of the created Individual Real-time UAV Status Subscription resource shall be returned.
An HTTP "Location" header that contains the resource URI of the created Individual Real-time UAV Status Subscription resource shall also be included. | +| NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. | | | | | + +**Table 6.2.3.2.3.2-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/uae-uav-status//subscriptions/{subscriptionId} | + +#### 6.2.3.2.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +### 6.2.3.3 Resource: Individual Real-time UAV Status Subscription + +#### 6.2.3.3.1 Description + +This resource represents an individual real-time UAV status subscription managed by the UAE Server. + +#### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/uae-uav-status//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|-----------------------------------------| +| apiRoot | string | See clause 5.2.4 of 3GPP TS 29.122 [2]. | +| subscriptionId | string | Represents the subscription identifier. | + +#### 6.2.3.3.3 Resource Standard Methods + +##### 6.2.3.3.3.1 GET + +The GET method allows a UASS to retrieve a real-time UAV status subscription identified by the subscription identifier included in the request URI (i.e. within the "{subscriptionId}" path segment). This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +Table 6.2.3.3.3.1-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RTUavStatusSubsc | M | 1 | 200 OK | Successful case. The requested Individual Real-time UAV Status Subscription resource shall be returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +#### 6.2.3.3.3.2 PUT + +The PUT method allows a UASS to request the update of an existing real-time UAV status subscription identified by the subscription identifier included in the request URI (i.e. within the "{subscriptionId}" path segment). This method shall support the URI query parameters specified in table 6.2.3.3.3.2-1. + +Table 6.2.3.3.3.2-1: URI query parameters supported by the PUT method on this resource + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3. + +Table 6.2.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------| +| RTUavStatusSubsc | M | 1 | Represents the parameters to request the update of an existing subscription to real-time UAV status reporting. | + +**Table 6.2.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RTUavStatusSubsc | M | 1 | 200 OK | Successful case. The real-time UAV status subscription is successfully updated and a representation of the updated Individual Real-time UAV Status Subscription resource shall be returned. | +| n/a | | | 204 No Content | Successful case. The real-time UAV status subscription is successfully updated. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| NOTE: The mandatory HTTP error status code for the HTTP PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. | | | | | + +**Table 6.2.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +**Table 6.2.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +#### 6.2.3.3.3.3 DELETE + +The DELETE method allows a UASS to request the deletion of an existing real-time UAV status subscription identified by the subscription identifier included in the request URI (i.e. within the "{subscriptionId}" path segment). This method shall support the URI query parameters specified in table 6.2.3.3.3.3-1. + +**Table 6.2.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.3-2 and the response data structures and response codes specified in table 6.2.3.3.3.3-3. + +**Table 6.2.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.2.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The real-time UAV status subscription is successfully deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +Table 6.2.3.3.3.3-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +Table 6.2.3.3.3.3-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +#### 6.2.3.3.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +### 6.2.4 Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +Notifications shall comply to clause 5.2.5 of 3GPP TS 29.122 [2]. + +Table 6.2.5.1-1: Notifications overview + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------|------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| Real-time UAV Status Notification | {notificationUri}/uav-status | uav-status (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS on the real-time UAV status information. | + +## 6.2.5.2 Real-time UAV Status Notification + +### 6.2.5.2.1 Description + +The Real-time UAV Status Notification is used by a UAE Server to notify a previously subscribed UASS on the real-time UAV status information. + +### 6.2.5.2.2 Target URI + +The Callback URI "{notificationUri}/uav-status" shall be used with the callback URI variables defined in table 6.2.5.2.2-1. + +**Table 6.2.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------| +| notificationUri | Uri | String formatted as a URI containing the Callback URI. | + +### 6.2.5.2.3 Standard Methods + +#### 6.2.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.2.5.2.3.1-1 and the response data structures and response codes specified in table 6.2.5.2.3.1-2. + +**Table 6.2.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------------| +| RTUavStatusNotif | M | 1 | Represents a real-time UAV status notification. | + +**Table 6.2.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The real-time UAV status notification is successfully received and acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +**Table 6.2.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +**Table 6.2.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +## 6.2.6 Data Model + +### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the UAE\_RealtimeUAVStatus API. + +**Table 6.2.6.1-1: UAE\_RealtimeUAVStatus API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------|----------------|--------------------------------------------------------------------------------------------------------|---------------| +| RTUavStatusSubsc | 6.2.6.2.2 | Represents the parameters to request the creation of a subscription to real-time UAV status reporting. | | +| RTUavStatusNotif | 6.2.6.2.3 | Represents a real-time UAV status notification. | | +| RTUavStatus | 6.2.6.2.4 | Represents real-time UAV status information. | | +| UavNetConnStatus | 6.2.6.2.5 | Represents the UAV network connection status information. | | + +Table 6.2.6.1-2 specifies data types re-used by the UAE\_RealtimeUAVStatus API from other specifications, including a reference to their respective specifications, and when needed, a short description of their use within the UAE\_RealtimeUAVStatus API. + +**Table 6.2.6.1-2: UAE\_RealtimeUAVStatus API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|--------------------|---------------------------------------------------------------|---------------| +| DateTime | 3GPP TS 29.122 [2] | Represents a date and a time. | | +| MonitoringType | 3GPP TS 29.122 [2] | Represents a monitoring event type. | | +| LocationInfo | 3GPP TS 29.122 [2] | Represents user location information. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features. | | +| UavId | Clause 6.1.6.2.7 | Represents a UAV identifier. | | +| Uri | 3GPP TS 29.122 [2] | Represents a URI. | | + +### 6.2.6.2 Structured data types + +#### 6.2.6.2.1 Introduction + +This clause defines the data structures to be used in resource representations. + +## 6.2.6.2.2 Type: RTUavStatusSubsc + +Table 6.2.6.2.2-1: Definition of type RTUavStatusSubsc + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uassId | Uri | M | 1 | Contains the identity of the UASS that is sending the request. It takes the form of a URI. | | +| uavIds | array(UavId) | M | 1..N | Contains the identity of the UAV(s) to which the real-time UAV status subscription is related. | | +| notificationUri | Uri | M | 1 | Contains the notification URI via which the UASS desires to receive real-time UAV status notifications from the UAE Server. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.2.8.

This attribute shall be provided in the HTTP POST request for subscription resource creation and in the associated successful response. | | + +## 6.2.6.2.3 Type: RTUavStatusNotif + +Table 6.2.6.2.3-1: Definition of type RTUavStatusNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| subscriptionId | string | M | 1 | Contains the identifier of the Individual Real-time UAV Status Subscription to which the notification is related. | | +| rTUavStatus | array(RTUavStatus) | M | 1..N | Contains the real-time UAV status information for a UAV. | | + +## 6.2.6.2.4 Type: RTUavStatus + +Table 6.2.6.2.4-1: Definition of type RTUavStatus + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|--------------------------------------------------------------------------------------------|---------------| +| uavId | UavId | M | 1 | Contains the identity of the UAV to which the real-time UAV status information is related. | | +| uavNetConnStatus | UavNetConnStatus | C | 0..1 | Contains the network connection status information for the UAV.
(NOTE) | | +| uavLocInfo | LocationInfo | M | 0..1 | Contains the location information for the UAV.
(NOTE) | | + +NOTE: Either only the "uavLocInfo" attribute or both the "uavNetConnStatus" attribute and the "uavLocInfo" attribute shall be present. + +## 6.2.6.2.5 Type: UavNetConnStatus + +Table 6.2.6.2.5-1: Definition of type UavNetConnStatus + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| statusInfo | MonitoringType | M | 1 | Contains the network connection status monitoring event that occurred.

Only the "LOSS_OF_CONNECTIVITY", "UE_REACHABILITY", "COMMUNICATION_FAILURE" and "PDN_CONNECTIVITY_STATUS" values are applicable. | | +| timestamp | DateTime | M | 1 | Contains the timestamp of the provided network connection status information. | | + +## 6.2.6.3 Simple data types and enumerations + +## 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +Table 6.2.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 6.2.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +## 6.2.6.5 Binary data + +## 6.2.6.5.1 Binary Data Types + +Table 6.2.6.5.1-1: Binary Data Types + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +## 6.2.7 Error Handling + +## 6.2.7.1 General + +For the UAE\_RealtimeUAVStatus API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [2]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [2] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [2]. + +In addition, the requirements in the following clauses are applicable for the UAE\_RealtimeUAVStatus API. + +### 6.2.7.2 Protocol Errors + +No specific protocol errors for the UAE\_RealtimeUAVStatus API are specified. + +### 6.2.7.3 Application Errors + +The application errors defined for the UAE\_RealtimeUAVStatus API are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 6.2.8 Feature negotiation + +The optional features listed in table 6.2.8-1 are defined for the UAE\_RealtimeUAVStatus API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [2]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.2.9 Security + +The provisions of clause 6 of 3GPP TS 29.122 [2] shall apply for the UAE\_RealtimeUAVStatus API. + +## 6.3 UAE\_ChangeUSSManagement Service API + +### 6.3.1 Introduction + +The UAE\_ChangeUSSManagement service shall use the UAE\_ChangeUSSManagement API. + +The API URI of the UAE\_ChangeUSSManagement API shall be: + +**{apiRoot}
/** + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [2], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. +- The shall be "uae-usschange-mngt". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. + +NOTE: When 3GPP TS 29.122 [2] is referenced for the common protocol and interface aspects for API definition in the clauses under clause 6.3, the UAE Server takes the role of the SCEF and the UASS takes the role of the SCS/AS. + +### 6.3.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [2] shall apply for the UAE\_ChangeUSSManagement API. + +### 6.3.3 Resources + +#### 6.3.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.3.3.1-1 depicts the resource URIs structure for the UAE\_ChangeUSSManagement API. + +![Diagram showing the resource URI structure for the UAE_ChangeUSSManagement API. The root URI is {apiRoot}/uae-usschange-mngt/. A line descends from this root to a box containing /policies. From the /policies box, another line descends to a box containing /.](0a83cda688278bb05ef5134e66bdaf6e_img.jpg) + +``` +graph TD; Root["{apiRoot}/uae-usschange-mngt/"] --- Policies["/policies"]; Policies --- PolicyId["/"]; +``` + +Diagram showing the resource URI structure for the UAE\_ChangeUSSManagement API. The root URI is {apiRoot}/uae-usschange-mngt/. A line descends from this root to a box containing /policies. From the /policies box, another line descends to a box containing /. + +**Figure 6.3.3.1-1: Resource URIs structure of the UAE\_ChangeUSSManagement API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods for the UAE\_ChangeUSSManagement API. + +Table 6.3.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------|----------------------|---------------------------------|-------------------------------------------------------------------------| +| USS Change Policies | /policies | GET | Retrieve all the active USS Change Policies managed by the UAE Server. | +| | | POST | Request the creation of a USS Change Policy. | +| Individual USS Change Policy | /policies/{policyId} | GET | Retrieve an existing "Individual USS Change Policy". | +| | | PUT | Request the update of an existing "Individual USS Change Policy". | +| | | PATCH | Request the modification of an existing "Individual USS Change Policy". | +| | | DELETE | Request the deletion of an existing "Individual USS Change Policy". | + +### 6.3.3.2 Resource: USS Change Policies + +#### 6.3.3.2.1 Description + +This resource represents the collection of USS Change Policies managed by the UAE Server. + +#### 6.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/uae-usschange-mngt//policies + +This resource shall support the resource URI variables defined in table 6.3.3.2.2-1. + +Table 6.3.3.2.2-1: Resource URI variables for this resource + +| Name | Data type | Definition | +|---------|-----------|-----------------------------------------| +| apiRoot | string | See clause 5.2.4 of 3GPP TS 29.122 [2]. | + +#### 6.3.3.2.3 Resource Standard Methods + +##### 6.3.3.2.3.1 GET + +The HTTP GET method allows a UASS to retrieve all the active USS Change Policies managed by the UAE Server. + +This method shall support the URI query parameters specified in table 6.3.3.2.3.1-1. + +Table 6.3.3.2.3.1-1: URI query parameters supported by the GET method on this resource + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.3.3.2.3.1-2 and the response data structures and response codes specified in table 6.3.3.2.3.1-3. + +Table 6.3.3.2.3.1-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.3.3.2.3.1-3: Data structures supported by the GET Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(USSChangePolicy) | M | 1..N | 200 OK | Successful case. All the active USS Change Policies managed by the UAE Server shall be returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.3.3.2.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +Table 6.3.3.2.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +### 6.3.3.2.3.2 POST + +The HTTP POST method allows a UASS to request the creation of a USS Change Policy at the UAE Server. + +This method shall support the URI query parameters specified in table 6.3.3.2.3.2-1. + +Table 6.3.3.2.3.2-1: URI query parameters supported by the POST method on this resource + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.3.3.2.3.2-2 and the response data structures and response codes specified in table 6.3.3.2.3.2-3. + +Table 6.3.3.2.3.2-2: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|---------------------------------------------------------------------------| +| USSChangePolReq | M | 1 | Represents the parameters to request the creation of a USS Change Policy. | + +**Table 6.3.3.2.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USSChangePolResp | M | 1 | 201 Created | Successful case. The USS Change Policy is successfully created and a representation of the created "Individual USS Change Policy" resource shall be returned.
An HTTP "Location" header that contains the resource URI of the created resource shall also be included. | +| NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. | | | | | + +**Table 6.3.3.2.3.2-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/uae-usschange-mngt//policies/{policyId} | + +### 6.3.3.2.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +## 6.3.3.3 Resource: Individual USS Change Policy + +### 6.3.3.3.1 Description + +This resource represents a USS Change Policy managed by the UAE Server. + +### 6.3.3.3.2 Resource Definition + +Resource URI: {apiRoot}/uae-usschange-mngt//policies/{policyId} + +This resource shall support the resource URI variables defined in table 6.3.3.3.2-1. + +**Table 6.3.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4 of 3GPP TS 29.122 [2]. | +| policyId | string | Represents the identifier of the "Individual USS Change Policy". | + +### 6.3.3.3.3 Resource Standard Methods + +#### 6.3.3.3.3.1 GET + +The HTTP GET method allows a UASS to retrieve an existing "Individual USS Change Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.3.3.3.3.1-1. + +**Table 6.3.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.3.3.3.3.1-2 and the response data structures and response codes specified in table 6.3.3.3.3.1-3. + +Table 6.3.3.3.3.1-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.3.3.3.3.1-3: Data structures supported by the GET Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USSChangePolicy | M | 1 | 200 OK | Successful case. The requested "Individual USS Change Policy" resource shall be returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.3.3.3.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +Table 6.3.3.3.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +### 6.3.3.3.3.2 PUT + +The HTTP PUT method allows a UASS to request the update of an existing "Individual USS Change Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.3.3.3.3.2-1. + +Table 6.3.3.3.3.2-1: URI query parameters supported by the PUT method on this resource + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.3.3.3.3.2-2 and the response data structures and response codes specified in table 6.3.3.3.3.2-3. + +Table 6.3.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|---------------------------------------------------------------------------------------| +| USSChangePolicy | M | 1 | Represents the updated representation of the "Individual USS Change Policy" resource. | + +**Table 6.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USSChangePolicy | M | 1 | 200 OK | Successful case. The "Individual USS Change Policy" resource is successfully updated and a representation of the updated resource shall be returned in the response body. | +| n/a | | | 204 No Content | Successful case. The "Individual USS Change Policy" resource is successfully updated and no content is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +**Table 6.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +### 6.3.3.3.2 PATCH + +The HTTP PATCH method allows a UASS to request the modification of an existing "Individual USS Change Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.3.3.3.2-1. + +**Table 6.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.3.3.3.2-2 and the response data structures and response codes specified in table 6.3.3.3.2-3. + +**Table 6.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------| +| USSChangePolicyPatch | M | 1 | Represents the parameters to request the modification of the "Individual USS Change Policy" resource. | + +**Table 6.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USSChangePolicy | M | 1 | 200 OK | Successful case. The "Individual USS Change Policy" resource is successfully modified and a representation of the updated resource shall be returned in the response body. | +| n/a | | | 204 No Content | Successful case. The "Individual USS Change Policy" resource is successfully modified and no content is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +**Table 6.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +#### 6.3.3.3.3.4 DELETE + +The HTTP DELETE method allows a UASS to request the deletion of an existing "Individual USS Change Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.3.3.3.3.4-1. + +**Table 6.3.3.3.3.4-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.3.3.3.3.4-2 and the response data structures and response codes specified in table 6.3.3.3.3.4-3. + +**Table 6.3.3.3.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.3.3.3.3.4-3: Data structures supported by the DELETE Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The "Individual USS Change Policy" resource is successfully deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.3.3.3.3.4-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +Table 6.3.3.3.3.4-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +### 6.3.3.3.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +## 6.3.4 Custom Operations without associated resources + +### 6.3.4.1 Overview + +The structure of the custom operation URIs of the UAE\_ChangeUSSManagement API is shown in Figure 6.3.4.1-1. + +![Diagram showing the URI structure for the custom operation. A line from the base URI '{apiRoot}/uae-usschange-mngt/' points to a dashed box containing the path '/request-usschange'.](1f5279ac241813966be03158ad92142b_img.jpg) + +{apiRoot}/uae-usschange-mngt/ + +``` + +graph TD + A["{apiRoot}/uae-usschange-mngt/"] --> B["/request-usschange"] + +``` + +Diagram showing the URI structure for the custom operation. A line from the base URI '{apiRoot}/uae-usschange-mngt/' points to a dashed box containing the path '/request-usschange'. + +Figure 6.3.4.1-1: Custom operation URI structure of the UAE\_ChangeUSSManagement API + +Table 6.3.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the UAE\_ChangeUSSManagement API. + +**Table 6.3.4.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|------------------|----------------------|--------------------|---------------------------------------------------------| +| RequestUssChange | /request-usschange | POST | Enables a UASS to request USS change to the UAE Server. | + +### 6.3.4.2 Operation: RequestUssChange + +#### 6.3.4.2.1 Description + +The custom operation enables a UASS to request USS change to the UAE Server. + +#### 6.3.4.2.2 Operation Definition + +This operation shall support the request data structures and the response data structures and response codes specified in tables 6.3.4.2.2-1 and 6.3.4.2.2-2. + +**Table 6.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|------------------------------------------------| +| USSChangeReq | M | 1 | Contains the parameters to request USS change. | + +**Table 6.3.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The USS change request is successfully received. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative UAE Server. | + +**Table 6.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative UAE Server. | + +## 6.3.5 Notifications + +### 6.3.5.1 General + +Notifications shall comply to clause 5.2.5 of 3GPP TS 29.122 [2]. + +**Table 6.3.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------------------------|------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| USS Change Policy Configuration Status Notification | {notifUri}/usschange-policy | usschange-policy (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS on the status of USS Change Policy configuration. | +| USS Change Notification | {notifUri}/usschange | usschange (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS that a USS change was performed. | +| USS Change Trigger Notification | {notifUri}/usschange-trigger | usschange-trigger (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS that a USS change should be triggered. | + +### 6.3.5.2 USS Change Policy Configuration Status Notification + +#### 6.3.5.2.1 Description + +The USS Change Policy Configuration Status Notification is used by a UAE Server to notify a previously subscribed UASS on the status of USS Change Policy configuration status. + +#### 6.3.5.2.2 Target URI + +The Callback URI "{notifUri}/usschange-policy" shall be used with the callback URI variables defined in table 6.3.5.2.2-1. + +**Table 6.3.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | String formatted as a URI containing the Callback URI.
The notification URI is provided as part of the USS Change Policy creation/update/modification request as defined in clause 6.3.3. | + +#### 6.3.5.2.3 Standard Methods + +##### 6.3.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.3.5.2.3.1-1 and the response data structures and response codes specified in table 6.3.5.2.3.1-2. + +**Table 6.3.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|-------------------------------------------------------------------| +| USSChangePolConfigNotif | M | 1 | Represents a USS Change Policy Configuration Status notification. | + +Table 6.3.5.2.3.1-2: Data structures supported by the POST Response Body + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The USS Change Policy Configuration Status notification is successfully received and acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.3.5.2.3.1-3: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +Table 6.3.5.2.3.1-4: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +### 6.3.5.3 USS Change Notification + +#### 6.3.5.3.1 Description + +The USS Change Notification is used by a UAE Server to notify a previously subscribed UASS that a USS change was performed. + +#### 6.3.5.3.2 Target URI + +The Callback URI "{notifUri}/usschange" shall be used with the callback URI variables defined in table 6.3.5.3.2-1. + +Table 6.3.5.3.2-1: Callback URI variables + +| Name | Data type | Definition | +|----------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | String formatted as a URI containing the Callback URI.
The notification URI is provided as part of the USS Change Policy creation/update/modification request as defined in clause 6.3.3. | + +### 6.3.5.3.3 Standard Methods + +#### 6.3.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.3.5.3.3.1-1 and the response data structures and response codes specified in table 6.3.5.3.3.1-2. + +**Table 6.3.5.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|---------------------------------------| +| USSChangeNotif | M | 1 | Represents a USS Change notification. | + +**Table 6.3.5.3.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The USS Change notification is successfully received and acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.3.5.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +**Table 6.3.5.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +### 6.3.5.4 USS Change Trigger Notification + +#### 6.3.5.4.1 Description + +The USS Change Trigger Notification is used by a UAE Server to notify a previously subscribed UASS that a USS change should be triggered. + +#### 6.3.5.4.2 Target URI + +The Callback URI "{notifUri}/usschange-trigger" shall be used with the callback URI variables defined in table 6.3.5.4.2-1. + +**Table 6.3.5.4.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | String formatted as a URI containing the Callback URI.
The notification URI is provided as part of the USS Change Policy creation/update/modification request as defined in clause 6.3.3. | + +### 6.3.5.4.3 Standard Methods + +#### 6.3.5.4.3.1 POST + +This method shall support the request data structures specified in table 6.3.5.4.3.1-1 and the response data structures and response codes specified in table 6.3.5.4.3.1-2. + +**Table 6.3.5.4.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-----------------------------------------------| +| USSChangeTriggerNotif | M | 1 | Represents a USS Change Trigger notification. | + +**Table 6.3.5.4.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The USS Change Trigger notification is successfully received and acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.3.5.4.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +**Table 6.3.5.4.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +## 6.3.6 Data Model + +### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.1-1 specifies the data types defined for the UAE\_ChangeUSSManagement API. + +**Table 6.3.6.1-1: UAE\_ChangeUSSManagement API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|-------------------------------------------------------------------------------|---------------| +| MultiUssPol | 6.3.6.2.6 | Represents a Multi-USS policy. | | +| UasServArea | 6.3.6.2.7 | Represents a service area (e.g. registration service area) for a UAS. | | +| UasRoute | 6.3.6.2.8 | Represents the a UAS route. | | +| USSChangeNotif | 6.3.6.2.11 | Represents a USS Change notification. | | +| USSChangePolConfigNotif | 6.3.6.2.10 | Represents a USS Change Policy Configuration Status notification. | | +| USSChangePolReq | 6.3.6.2.2 | Represents the parameters to request the creation of a USS Change Policy. | | +| USSChangePolResp | 6.3.6.2.3 | Represents the response to a USS Change Policy create request. | | +| USSChangePolicy | 6.3.6.2.4 | Represents a USS Change Policy. | | +| USSChangePolicyPatch | 6.3.6.2.5 | Represents the parameters to request the modification of a USS Change Policy. | | +| USSChangeReq | 6.3.6.2.9 | Represents the parameters to request for USS change. | | +| USSChangeTriggerNotif | 6.3.6.2.12 | Represents a USS Change Trigger notification. | | + +Table 6.3.6.1-2 specifies data types re-used by the UAE\_ChangeUSSManagement API from other specifications, including a reference to their respective specifications, and when needed, a short description of their use within the UAE\_ChangeUSSManagement API. + +**Table 6.3.6.1-2: UAE\_ChangeUSSManagement API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|--------------------|---------------------------------------------------------------|---------------| +| GeographicArea | 3GPP TS 29.572 [8] | Represents a geographical area. | | +| Ncgi | 3GPP TS 29.571 [7] | Represents an NCGI. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features. | | +| Tai | 3GPP TS 29.571 [7] | Represents a tracking area identifier. | | +| UasId | Clause 6.1.6.2.6 | Represents a UAV identifier. | | +| Uri | 3GPP TS 29.122 [2] | Represents a URI. | | + +### 6.3.6.2 Structured data types + +#### 6.3.6.2.1 Introduction + +This clause defines the data structures to be used in resource representations. + +## 6.3.6.2.2 Type: USSChangePolReq + +Table 6.3.6.2.2-1: Definition of type USSChangePolReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uassId | Uri | M | 1 | Contains the identity of the UASS that is sending the request. | | +| ussChangePol | USSChangePolicy | M | 1 | Contains the USS Change Policy that shall be created. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.3.8.
This attribute shall be provided if feature negotiation shall take place. | | + +## 6.3.6.2.3 Type: USSChangePolResp + +Table 6.3.6.2.3-1: Definition of type USSChangePolResp + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ussChangePol | USSChangePolicy | M | 1 | Contains the created USS Change Policy. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.3.8.
This attribute shall be provided if feature negotiation shall take place and this attribute was present in the corresponding request. | | + +## 6.3.6.2.4 Type: USSChangePolicy + +Table 6.3.6.2.4-1: Definition of type USSChangePolicy + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the provided USS Change Policy is related.
This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| notifUri | Uri | M | 1 | Contains the notification URI via which the UASS desires to receive USS Change management related notifications from the UAE Server. | | +| uasRegArea | UasServArea | O | 0..1 | Contains the registration area within which the UAS is allowed to fly. | | +| uasAllowedRoute | UasRoute | O | 0..1 | Contains the allowed route for the UAS within the UAS registration area provided by the "uasRegArea" attribute.
This attribute shall be present only if the "uasRegArea" attribute is present. | | +| multiUssPol | MultiUssPol | O | 0..1 | Contains the multi-USS policy management container consisting of the requirements and policies for multi-USS management. | | + +Editor's Note: The full content of the USSChangePolicy data structure is FFS. + +## 6.3.6.2.5 Type: USSChangePolicyPatch + +Table 6.3.6.2.5-1: Definition of type USSChangePolicyPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifUri | Uri | O | 0..1 | Contains the updated notification URI via which the UASS desires to receive USS Change management related notifications from the UAE Server. | | +| uasRegArea | UasServArea | O | 0..1 | Contains the updated registration area within which the UAS is allowed to fly. | | +| uasAllowedRoute | UasRoute | O | 0..1 | Contains the updated allowed route for the UAS within the UAS registration area provided by the "uasRegArea" attribute.

This attribute shall be present only if the "uasRegArea" attribute is present. | | +| multiUssPol | MultiUssPol | O | 0..1 | Contains the updated multi-USS policy management container. | | + +Editor's Note: The full content of the USSChangePolicyPatch data structure is FFS. + +## 6.3.6.2.6 Type: MultiUssPol + +Table 6.3.6.2.6-1: Definition of type MultiUssPol + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| | | | 1 | | | + +Editor's Note: The definition of the MultiUssPol data structure is FFS. + +## 6.3.6.2.7 Type: UasServArea + +Table 6.3.6.2.7-1: Definition of type UasServArea + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| ncgiList | array(Ncgi) | C | 1..N | Contains a list of NR cell identifier(s) that constitutes the service area. | | +| tailList | array(Tai) | C | 1..N | Contains a list of tracking area identifier(s) that constitutes the service area. | | +| geographicAreaList | array(GeographicArea) | C | 1..N | Contains a list of geographic area(s) that constitutes the service area. | | +| NOTE: Either the "geographicAreaList" attribute, or the "ncgiList" attribute and/or the "tailList" attribute shall be provided. | | | | | | + +Editor's Note: The content of the UasServArea data structure is FFS. + +## 6.3.6.2.8 Type: UasRoute + +Table 6.3.6.2.8-1: Definition of type UasRoute + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| | | | 1 | | | + +Editor's Note: The definition of the UasRoute data structure is FFS. + +## 6.3.6.2.9 Type: USSChangeReq + +Table 6.3.6.2.9-1: Definition of type USSChangeReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uassId | Uri | M | 1 | Contains the identity of the UASS that is sending the request. | | +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the USS change request is related.
This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.3.8.
This attribute shall be provided if feature negotiation shall take place. | | + +Editor's Note: The full content of the USSChangeReq data structure is FFS. + +## 6.3.6.2.10 Type: USSChangePolConfigNotif + +Table 6.3.6.2.10-1: Definition of type USSChangePolConfigNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the USS Change Policy configuration notification is related.
This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| multiUssPol | MultiUssPol | O | 0..1 | Contains the multi-USS policy management container consisting of the requirements and policies for multi-USS management. | | + +Editor's Note: The full content of the USSChangePolConfigNotif data structure is FFS. + +## 6.3.6.2.11 Type: USSChangeNotif + +Table 6.3.6.2.11-1: Definition of type USSChangeNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| | | | | | | + +Editor's Note: The definition of the USSChangeNotif data structure is FFS. + +## 6.3.6.2.12 Type: USSChangeTriggerNotif + +Table 6.3.6.2.12-1: Definition of type USSChangeTriggerNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| | | | | | | + +Editor's Note: The definition of the USSChangeTriggerNotif data structure is FFS. + +### 6.3.6.3 Simple data types and enumerations + +#### 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +**Table 6.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +### 6.3.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +### 6.3.6.5 Binary data + +#### 6.3.6.5.1 Binary Data Types + +**Table 6.3.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +## 6.3.7 Error Handling + +### 6.3.7.1 General + +For the UAE\_ChangeUSSManagement API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [2]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [2] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [2]. + +In addition, the requirements in the following clauses are applicable for the UAE\_ChangeUSSManagement API. + +### 6.3.7.2 Protocol Errors + +No specific protocol errors for the UAE\_ChangeUSSManagement API are specified. + +### 6.3.7.3 Application Errors + +The application errors defined for the UAE\_ChangeUSSManagement API are listed in Table 6.3.7.3-1. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 6.3.8 Feature negotiation + +The optional features listed in table 6.3.8-1 are defined for the UAE\_ChangeUSSManagement API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [2]. + +**Table 6.3.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.3.9 Security + +The provisions of clause 6 of 3GPP TS 29.122 [2] shall apply for the UAE\_ChangeUSSManagement API. + +## 6.4 UAE\_DAASupport Service API + +### 6.4.1 Introduction + +The UAE\_DAASupport service shall use the UAE\_DAASupport API. + +The API URI of the UAE\_DAASupport Service API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [2], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. +- The shall be "uae-daa". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. + +NOTE: When 3GPP TS 29.122 [2] is referenced for the common protocol and interface aspects for API definition in the clauses under clause 6.4, the UAE Server takes the role of the SCEF and the UASS takes the role of the SCS/AS. + +### 6.4.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [2] shall apply for the UAE\_DAASupport API. + +### 6.4.3 Resources + +#### 6.4.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.4.3.1-1 depicts the resource URIs structure for the UAE\_DAASupport API. + +![Diagram showing the resource URI structure for the UAE_DAASupport API. The root URI is {apiRoot}/uae-daa/. It branches to /policies, which further branches to /{policyId}.](3d53d3bbe5b70dfc8d612c63b9587837_img.jpg) + +``` +graph TD; Root["{apiRoot}/uae-daa/"] --- Policies["/policies"]; Policies --- PolicyId["/{policyId}"]; +``` + +Diagram showing the resource URI structure for the UAE\_DAASupport API. The root URI is {apiRoot}/uae-daa/. It branches to /policies, which further branches to /{policyId}. + +**Figure 6.4.3.1-1: Resource URIs structure of the UAE\_DAASupport API** + +Table 6.4.3.1-1 provides an overview of the resources and applicable HTTP methods for the UAE\_DAASupport API. + +Table 6.4.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------|----------------------|---------------------------------|------------------------------------------------------------------| +| DAA Policies | /policies | GET | Retrieve all the active DAA Policies managed by the UAE Server. | +| | | POST | Request the creation of a DAA Policy. | +| Individual DAA Policy | /policies/{policyId} | GET | Retrieve an existing "Individual DAA Policy". | +| | | PUT | Request the update of an existing "Individual DAA Policy". | +| | | PATCH | Request the modification of an existing "Individual DAA Policy". | +| | | DELETE | Request the deletion of an existing "Individual DAA Policy". | + +## 6.4.3.2 Resource: DAA Policies + +### 6.4.3.2.1 Description + +This resource represents the collection of DAA Policies managed by the UAE Server. + +### 6.4.3.2.2 Resource Definition + +Resource URI: {apiRoot}/uae-daa//policies + +This resource shall support the resource URI variables defined in table 6.4.3.2.2-1. + +Table 6.4.3.2.2-1: Resource URI variables for this resource + +| Name | Data type | Definition | +|---------|-----------|-----------------------------------------| +| apiRoot | string | See clause 5.2.4 of 3GPP TS 29.122 [2]. | + +### 6.4.3.2.3 Resource Standard Methods + +#### 6.4.3.2.3.1 GET + +The HTTP GET method allows a UASS to retrieve all the active DAA Policies managed by the UAE Server. + +This method shall support the URI query parameters specified in table 6.4.3.2.3.1-1. + +Table 6.4.3.2.3.1-1: URI query parameters supported by the GET method on this resource + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.4.3.2.3.1-2 and the response data structures and response codes specified in table 6.4.3.2.3.1-3. + +Table 6.4.3.2.3.1-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.4.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(DAAPolicy) | M | 1..N | 200 OK | Successful case. All the active DAA Policies managed by the UAE Server shall be returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.4.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +**Table 6.4.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +#### 6.4.3.2.3.2 POST + +The HTTP POST method allows a UASS to request the creation of a DAA Policy at the UAE Server. + +This method shall support the URI query parameters specified in table 6.4.3.2.3.2-1. + +**Table 6.4.3.2.3.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.4.3.2.3.2-2 and the response data structures and response codes specified in table 6.4.3.2.3.2-3. + +**Table 6.4.3.2.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|--------------------------------------------------------------------| +| DAAPolReq | M | 1 | Represents the parameters to request the creation of a DAA Policy. | + +**Table 6.4.3.2.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DAAPolResp | M | 1 | 201 Created | Successful case. The DAA Policy is successfully created and a representation of the created "Individual DAA Policy" resource shall be returned.
An HTTP "Location" header that contains the resource URI of the created resource shall also be included. | +| NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. | | | | | + +**Table 6.4.3.2.3.2-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/uae-daa//policies/{policyId} | + +#### 6.4.3.2.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +### 6.4.3.3 Resource: Individual DAA Policy + +#### 6.4.3.3.1 Description + +This resource represents a DAA Policy managed by the UAE Server. + +#### 6.4.3.3.2 Resource Definition + +Resource URI: {apiRoot}/uae-daa//policies/{policyId} + +This resource shall support the resource URI variables defined in table 6.4.3.3.2-1. + +**Table 6.4.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|--------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4 of 3GPP TS 29.122 [2]. | +| policyId | string | Represents the identifier of the "Individual DAA Policy" resource. | + +#### 6.4.3.3.3 Resource Standard Methods + +##### 6.4.3.3.3.1 GET + +The HTTP GET method allows a UASS to retrieve an existing "Individual DAA Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.4.3.3.3.1-1. + +**Table 6.4.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.4.3.3.3.1-2 and the response data structures and response codes specified in table 6.4.3.3.3.1-3. + +Table 6.4.3.3.3.1-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.4.3.3.3.1-3: Data structures supported by the GET Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DAAPolicy | M | 1 | 200 OK | Successful case. The requested "Individual DAA Policy" resource shall be returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.4.3.3.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +Table 6.4.3.3.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +#### 6.4.3.3.3.2 PUT + +The HTTP PUT method allows a UASS to request the update of an existing "Individual DAA Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.4.3.3.3.2-1. + +Table 6.4.3.3.3.2-1: URI query parameters supported by the PUT method on this resource + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.4.3.3.3.2-2 and the response data structures and response codes specified in table 6.4.3.3.3.2-3. + +Table 6.4.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|--------------------------------------------------------------------------------| +| DAAPolicy | M | 1 | Represents the updated representation of the "Individual DAA Policy" resource. | + +**Table 6.4.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DAAPolicy | M | 1 | 200 OK | Successful case. The "Individual DAA Policy" resource is successfully updated and a representation of the updated resource shall be returned in the response body. | +| n/a | | | 204 No Content | Successful case. The "Individual DAA Policy" resource is successfully updated and no content is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.4.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +**Table 6.4.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +#### 6.4.3.3.3.2 PATCH + +The HTTP PATCH method allows a UASS to request the modification of an existing "Individual DAA Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.4.3.3.3.2-1. + +**Table 6.4.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.4.3.3.3.2-2 and the response data structures and response codes specified in table 6.4.3.3.3.2-3. + +**Table 6.4.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|------------------------------------------------------------------------------------------------| +| DAAPolicyPatch | M | 1 | Represents the parameters to request the modification of the "Individual DAA Policy" resource. | + +**Table 6.4.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DAAPolicy | M | 1 | 200 OK | Successful case. The "Individual DAA Policy" resource is successfully modified and a representation of the updated resource shall be returned in the response body. | +| n/a | | | 204 No Content | Successful case. The "Individual DAA Policy" resource is successfully modified and no content is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.4.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +**Table 6.4.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +#### 6.4.3.3.3.4 DELETE + +The HTTP DELETE method allows a UASS to request the deletion of an existing "Individual DAA Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.4.3.3.3.4-1. + +**Table 6.4.3.3.3.4-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.4.3.3.3.4-2 and the response data structures and response codes specified in table 6.4.3.3.3.4-3. + +**Table 6.4.3.3.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.4.3.3.3.4-3: Data structures supported by the DELETE Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The "Individual DAA Policy" resource is successfully deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.4.3.3.3.4-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +Table 6.4.3.3.3.4-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative UAE Server. | + +#### 6.4.3.3.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +### 6.4.4 Custom Operations without associated resources + +#### 6.4.4.1 Overview + +The structure of the custom operation URIs of the UAE\_DAASupport API is shown in Figure 6.4.4.1-1. + +![Diagram showing the custom operation URI structure of the UAE_DAASupport API. The base URI is {apiRoot}/uae-daa/. A line branches from the end of the base URI to a dashed box containing the custom operation path /inform-events.](96b5a08abda472c0c3838ecf1357f57f_img.jpg) + +``` + + {apiRoot}/uae-daa/ + | + +----- /inform-events + +``` + +Diagram showing the custom operation URI structure of the UAE\_DAASupport API. The base URI is {apiRoot}/uae-daa/. A line branches from the end of the base URI to a dashed box containing the custom operation path /inform-events. + +Figure 6.4.4.1-1: Custom operation URI structure of the UAE\_DAASupport API + +Table 6.4.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the UAE\_DAASupport API. + +**Table 6.4.4.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|-----------------|----------------------|--------------------|------------------------------------------------------------------------| +| InformDAAEvents | /inform-events | POST | Enables a UASS to inform about and manage possible DAA related events. | + +## 6.4.4.2 Operation: InformDAAEvents + +### 6.4.4.2.1 Description + +The custom operation enables a UASS to inform about and request the management of possible DAA related events to the UAE Server. + +### 6.4.4.2.2 Operation Definition + +This operation shall support the request data structures and the response data structures and response codes specified in tables 6.4.4.2.2-1 and 6.4.4.2.2-2. + +**Table 6.4.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|----------------------------------------------------------------------------------------------------| +| InformDAAEvents Req | M | 1 | Contains the parameters to inform about and request the management of possible DAA related events. | + +**Table 6.4.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The request is successfully received. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.4.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative UAE Server. | + +**Table 6.4.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative UAE Server. | + +## 6.4.5 Notifications + +### 6.4.5.1 General + +Notifications shall comply to clause 5.2.5 of 3GPP TS 29.122 [2]. + +**Table 6.4.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------------------------------|-----------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| DAA Policy Configuration Completion Status Notification | {notifUri}/daa-policy | daa-policy (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS on the status of DAA Policy configuration. | +| DAA Event Notification | {notifUri}/daa-events | daa-events (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS of DAA related event(s). | + +### 6.4.5.2 DAA Policy Configuration Completion Status Notification + +#### 6.4.5.2.1 Description + +The DAA Policy Configuration Completion Status Notification is used by a UAE Server to notify a previously subscribed UASS on the status of DAA Policy configuration. + +#### 6.4.5.2.2 Target URI + +The Callback URI "{notifUri}/daa-policy" shall be used with the callback URI variables defined in table 6.4.5.2.2-1. + +**Table 6.4.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | String formatted as a URI containing the Callback URI.
The notification URI is provided as part of the DAA Policy creation/update/modification request as defined in clause 6.4.3. | + +#### 6.4.5.2.3 Standard Methods + +##### 6.4.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.4.5.2.3.1-1 and the response data structures and response codes specified in table 6.4.5.2.3.1-2. + +**Table 6.4.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|------------------------------------------------------------| +| DAAPolConfigNotif | M | 1 | Represents a DAA Policy Configuration Status notification. | + +Table 6.4.5.2.3.1-2: Data structures supported by the POST Response Body + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The DAA Policy Configuration Status notification is successfully received and acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.4.5.2.3.1-3: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +Table 6.4.5.2.3.1-4: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +## 6.4.5.3 DAA Event Notification + +### 6.4.5.3.1 Description + +The DAA Event Notification is used by a UAE Server to notify a previously subscribed UASS of DAA related event(s). + +### 6.4.5.3.2 Target URI + +The Callback URI "{notifUri}/daa-events" shall be used with the callback URI variables defined in table 6.4.5.3.2-1. + +Table 6.4.5.3.2-1: Callback URI variables + +| Name | Data type | Definition | +|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | String formatted as a URI containing the Callback URI.
The notification URI is provided as part of the DAA Policy creation/update/modification request as defined in clause 6.4.3. | + +### 6.4.5.3.3 Standard Methods + +#### 6.4.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.4.5.3.3.1-1 and the response data structures and response codes specified in table 6.4.5.3.3.1-2. + +Table 6.4.5.3.3.1-1: Data structures supported by the POST Request Body + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|--------------------------------------| +| DAAEventsInfo | M | 1 | Represents a DAA Event notification. | + +Table 6.4.5.3.3.1-2: Data structures supported by the POST Response Body + +| Data type | P | Cardinality | Response codes | Description | +|---------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DAAEventsInfo | M | 1 | 200 OK | Successful case. The DAA event notification is successfully received and acknowledged, and the UASS returns updated/additional DAA related event information in the response body. | +| n/a | | | 204 No Content | Successful case. The DAA event notification is successfully received and acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.4.5.3.3.1-3: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +Table 6.4.5.3.3.1-4: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative UASS towards which the notification should be redirected. | + +## 6.4.6 Data Model + +### 6.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.6.1-1 specifies the data types defined for the UAE\_DAASupport API. + +**Table 6.4.6.1-1: UAE\_DAASupport API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------|----------------|------------------------------------------------------------------------|---------------| +| DAAAppPolicy | 6.4.6.2.6 | Represents a DAA Application policy. | | +| DAAEvent | 6.4.6.2.10 | Represents a DAA related event. | | +| DAAEventsInfo | 6.4.6.2.9 | Represents a DAA Event notification. | | +| DAAPolConfigNotif | 6.4.6.2.8 | Represents a DAA Policy Configuration Status notification. | | +| DAAPolReq | 6.4.6.2.2 | Represents the parameters to request the creation of a DAA Policy. | | +| DAAPolResp | 6.4.6.2.3 | Represents the response to a DAA Policy create request. | | +| DAAPolicy | 6.4.6.2.4 | Represents the content of a DAA Policy. | | +| DAAPolicyPatch | 6.4.6.2.5 | Represents the parameters to request the modification of a DAA Policy. | | +| InformDAAEventsReq | 6.4.6.2.7 | Represents the parameters to report DAA related event(s). | | + +Table 6.4.6.1-2 specifies data types re-used by the UAE\_DAASupport API from other specifications, including a reference to their respective specifications, and when needed, a short description of their use within the UAE\_DAASupport API. + +**Table 6.4.6.1-2: UAE\_DAASupport API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|--------------------|---------------------------------------------------------------|---------------| +| LocationInfo | 3GPP TS 29.122 [2] | Represents user location information. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features. | | +| UasId | Clause 6.1.6.2.6 | Represents a UAV identifier. | | +| Uri | 3GPP TS 29.122 [2] | Represents a URI. | | + +## 6.4.6.2 Structured data types + +### 6.4.6.2.1 Introduction + +This clause defines the data structures to be used in resource representations. + +### 6.4.6.2.2 Type: DAAPolReq + +**Table 6.4.6.2.2-1: Definition of type DAAPolReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uassId | Uri | M | 1 | Contains the identity of the UASS that is sending the request. | | +| daaPol | DAAPolicy | M | 1 | Contains the DAA Policy that shall be created. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.4.8.

This attribute shall be provided if feature negotiation shall take place. | | + +## 6.4.6.2.3 Type: DAAPolResp + +Table 6.4.6.2.3-1: Definition of type DAAPolResp + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| daaPol | DAAPolicy | M | 1 | Contains the created DAA Policy. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.4.8.

This attribute shall be provided if feature negotiation shall take place and this attribute was present in the corresponding request. | | + +## 6.4.6.2.4 Type: DAAPolicy + +Table 6.4.6.2.4-1: Definition of type DAAPolicy + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the provided DAA Policy is related.

This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| notifUri | Uri | M | 1 | Contains the notification URI via which the UASS desires to receive DAA related notifications from the UAE Server. | | +| daaAppPol | DAAppPolicy | C | 0..1 | Contains the DAA Application policy consisting of the requirements and policies for DAA management.

This attribute shall be provided when available. | | + +## 6.4.6.2.5 Type: DAAPolicyPatch + +Table 6.4.6.2.5-1: Definition of type DAAPolicyPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------|---------------| +| notifUri | Uri | O | 0..1 | Contains the updated notification URI via which the UASS desires to receive DAA related notifications from the UAE Server. | | +| daaAppPol | DAAppPolicy | O | 0..1 | Contains the updated DAA Application policy. | | + +## 6.4.6.2.6 Type: DAAppPolicy + +Table 6.4.6.2.6-1: Definition of type DAAppPolicy + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| | | | 1 | | | + +Editor's Note: The definition of the DAAppPolicy data structure is FFS. + +## 6.4.6.2.7 Type: InformDAAEventsReq + +Table 6.4.6.2.7-1: Definition of type InformDAAEventsReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uassId | Uri | M | 1 | Contains the identity of the UASS that is sending the request. | | +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the DAA event information management request is related.
This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| daaEventsInfo | array(DAAEvent) | M | 1..N | Contains the detected DAA event information. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.4.8.
This attribute shall be provided if feature negotiation shall take place. | | + +## 6.4.6.2.8 Type: DAAPolConfigNotif + +Table 6.4.6.2.8-1: Definition of type DAAPolConfigNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------|---------------| +| status | DAAPolConfigStatus | M | 1 | Contains the DAA Policy configuration completion status. | | + +## 6.4.6.2.9 Type: DAAEventsInfo + +Table 6.4.6.2.9-1: Definition of type DAAEventsInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the DAA event information management request is related.
This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| daaEventsInfo | array(DAAEvent) | M | 1..N | Contains the detected DAA event information. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.4.8.
This attribute shall be provided if feature negotiation shall take place. | | + +## 6.4.6.2.10 Type: DAAEvent + +Table 6.4.6.2.10-1: Definition of type DAAEvent + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) for which a potential flight path conflict is detected.
This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| uasLocInfo | LocationInfo | M | 1 | Contains the location information of the UAS with which a potential flight path conflict is detected. | | + +## 6.4.6.3 Simple data types and enumerations + +## 6.4.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.4.6.3.2 Simple data types + +The simple data types defined in table 6.4.6.3.2-1 shall be supported. + +Table 6.4.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 6.4.6.3.3 Enumeration: DAAPolConfigStatus + +The enumeration DAAPolConfigStatus represents DAA Policy configuration completion status. It shall comply with the provisions of table 6.4.6.3.3-1. + +Table 6.4.6.3.3-1: Enumeration DAAPolConfigStatus + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------|---------------| +| SUCCESSFUL | Indicates that the DAA Policy configuration was successful. | | +| NOT_SUCCESSFUL | Indicates that the DAA Policy configuration was not successful. | | + +## 6.4.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +## 6.4.6.5 Binary data + +### 6.4.6.5.1 Binary Data Types + +**Table 6.4.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +## 6.4.7 Error Handling + +### 6.4.7.1 General + +For the UAE\_DAASupport API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [2]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [2] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [2]. + +In addition, the requirements in the following clauses are applicable for the UAE\_DAASupport API. + +### 6.4.7.2 Protocol Errors + +No specific protocol errors for the UAE\_DAASupport API are specified. + +### 6.4.7.3 Application Errors + +The application errors defined for the UAE\_DAASupport API are listed in Table 6.4.7.3-1. + +**Table 6.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 6.4.8 Feature negotiation + +The optional features listed in table 6.4.8-1 are defined for the UAE\_DAASupport API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [2]. + +**Table 6.4.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.4.9 Security + +The provisions of clause 6 of 3GPP TS 29.122 [2] shall apply for the UAE\_DAASupport API. + +## 7 Using Common API Framework + +### 7.1 General + +When CAPIF is used with a UAE Server service, the UAE Server shall support the following functionalities as defined in 3GPP TS 29.222 [10]: + +- the API exposing function and the related APIs over CAPIF-2/2e and CAPIF-3/3e reference points; +- the API publishing function and the related APIs over CAPIF-4/4e reference point; +- the API management function and the related APIs over CAPIF-5/5e reference point; and +- at least one of the security methods for authentication and authorization, and the related security mechanisms. + +In a centralized deployment as defined in 3GPP TS 23.222 [9], where the CAPIF core function and the API provider domain functions are co-located, the interactions between the CAPIF core function and the API provider domain functions may be independent of the CAPIF-3/3e, CAPIF-4/4e and CAPIF-5/5e reference points. + +When CAPIF is used with a UAE Server service, the UAE Server shall register all the northbound APIs features in the CAPIF Core Function. + +### 7.2 Security + +When CAPIF is used for external exposure, before invoking an API exposed by the UAE Server, the service API consumer (e.g. UASS) acting as an API invoker shall negotiate the security method (PKI, TLS-PSK or OAuth 2.0) with the CAPIF core function and ensure that the UAE Server has enough credentials to authenticate the service API consumer (e.g. UASS), as defined in clauses 5.6.2.2 and 6.2.2.2 of 3GPP TS 29.222 [10]. + +If PKI or TLS-PSK is selected as the security method to be used between the service API consumer (e.g. UASS) and the UAE Server, upon API invocation, the UAE Server shall retrieve the authorization information from the CAPIF core function as described in clause 5.6.2.4 of 3GPP TS 29.222 [10]. + +As indicated in 3GPP TS 33.122 [11], the access to the UAE Server APIs may be authorized by means of the OAuth 2.0 protocol (see IETF RFC 6749 [12]), using the "Client Credentials" authorization grant, where the CAPIF core function (see 3GPP TS 29.222 [10]) plays the role of the authorization server. + +NOTE 1: In this release, only "Client Credentials" authorization grant is supported. + +If OAuth 2.0 is selected as the security method to be used between the service API consumer (e.g. UASS) and the UAE Server, the service API consumer (e.g. UASS) shall, prior to consuming the services offered by the UAE Server APIs, obtain a "token" from the authorization server, by invoking the Obtain\_Authorization service operation as described in clause 5.6.2.3.2 of 3GPP TS 29.222 [10]. + +The UAE Server APIs do not define any scopes for OAuth 2.0 authorization. It is the UAE Server responsibility to check whether the service API consumer (e.g. UASS) is authorized to use an API based on the provided "token". Once the UAE Server verifies the "token", it shall check whether the UAE Server identifier in the "token" matches its own published identifier, and whether the API name in the "token" matches its own published API name. If those checks are passed, the service API consumer (e.g. UASS) has full authority to access any resource or operation provided by the invoked API. + +NOTE 2: For the aforementioned security methods, the UAE Server needs to apply admission control according to access control policies after performing the authorization checks. + +--- + +## Annex A (normative): OpenAPI specification + +### A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [3] and clause 5B of 3GPP TR 21.900 [5]). + +## A.2 UAE\_C2OperationModeManagement API + +``` +openapi: 3.0.0 + +info: + title: UAE Server C2 Operation Mode Management Service + version: 1.1.0-alpha.1 + description: | + UAE Server C2 Operation Mode Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.257 V18.1.0; Application layer support for Uncrewed Aerial System (UAS); + UAS Application Enabler (UAE) Server Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.257/ + +servers: + - url: '{apiRoot}/uae-c2opmode-mngt/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /initiate: + post: + summary: Request the provisioning of C2 Operation Mode configuration information for a UAS + (i.e. pair of UAV and UAV-C). + operationId: InitiateC2OpModeConfig + tags: + - Initiate C2 Operation Mode configuration + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigureData' + responses: + '200': + description: > + The communicated C2 Operation Mode configuration information was successfully + received. The response body contains the feedback of the UAE Server on whether + this C2 Operation Mode configuration request is confirmed (i.e. can be undertaken + by the UAE Server) or not. + content: + application/json: + schema: + $ref: '#/components/schemas/C2Result' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': +``` + +``` +$ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +callbacks: + C2OpModeMngtCompletionNotification: + '{ $request.body#/notificationUri }/c2mode-mngt-completion': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/C2OpModeMngtCompStatus' + responses: + '204': + description: > + No Content. The notification was successful and the C2 Operation Mode + Management Completion status for the concerned UAS (i.e. pair of UAV + and UAV-C) was successfully received and acknowledged by the UASS. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + SelectedC2CommunicationModeNotification: + '{ $request.body#/notificationUri }/inform-selec-c2mode': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedC2CommModeNotif' + responses: + '204': + description: > + No Content. The notification was successful and the C2 Communication Mode + selected by the concerned UAS (i.e. pair of UAV and UAV-C) was successfully + received and acknowledged by the UASS. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +``` + +``` + + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +C2CommunicationModeSwitchingNotification: + '{$request.body#/notificationUri}/inform-c2mode-switch': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/C2CommModeSwitchNotif' + responses: + '200': + description: > + OK. The targeted C2 Communication Mode switching for the concerned UAS + (i.e. pair of UAV and UAV-C) is successfully received. The response body + contains the feedback of the UASS on whether this C2 Communication Mode + switching is confirmed (i.e. validated) or not. + content: + application/json: + schema: + $ref: '#/components/schemas/C2Result' + '204': + description: > + No Content. The targeted C2 Communication Mode switching for the concerned + UAS (i.e. pair of UAV and UAV-C) is successfully received and acknowledged, + and the UASS does not need to confirm (i.e. validate) it. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + ConfigureData: + description: > + Represents the parameters to request to provision C2 Operation Mode configuration + information for a UAS (i.e. pair of UAV and UAV-C). + type: object + properties: + +``` + +``` + uassId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + uasId: + $ref: '#/components/schemas/UasId' + allowedC2CommModes: + type: array + items: + $ref: '#/components/schemas/C2CommMode' + minItems: 1 + c2CommModeSwitchTypes: + type: array + items: + $ref: '#/components/schemas/C2CommModeSwitching' + minItems: 1 + notificationUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + primaryC2CommMode: + $ref: '#/components/schemas/C2CommMode' + secondaryC2CommMode: + $ref: '#/components/schemas/C2CommMode' + c2SwitchPolicies: + $ref: '#/components/schemas/C2SwitchPolicies' + c2ServiceArea: + $ref: '#/components/schemas/C2ServiceArea' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uassId + - uasId + - allowedC2CommModes + - c2CommModeSwitchTypes + - notificationUri + - primaryC2CommMode + - c2SwitchPolicies + +SelectedC2CommModeNotif: + description: > + Represents information on the C2 Communication Mode selected by a UAS (i.e. pair of + UAV and UAV-C). + type: object + properties: + uasId: + $ref: '#/components/schemas/UasId' + selPrimaryC2CommMode: + $ref: '#/components/schemas/C2CommMode' + selSecondaryC2CommMode: + $ref: '#/components/schemas/C2CommMode' + required: + - uasId + - selPrimaryC2CommMode + +C2CommModeSwitchNotif: + description: > + Represents information on the targeted C2 Communication Mode switching for a UAS + (i.e. pair of UAV and UAV-C). + type: object + properties: + uaeServerId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + uasId: + $ref: '#/components/schemas/UasId' + c2CommModeSwitchType: + $ref: '#/components/schemas/C2CommModeSwitching' + switchingCause: + $ref: '#/components/schemas/C2SwitchingCause' + required: + - uaeServerId + - uasId + - c2CommModeSwitchType + +C2Result: + description: Represents the result of an action related to C2 of a UAS. + type: object + properties: + c2OpConfirmed: + type: boolean + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` +required: + - c2OpConfirmed + +UasId: + description: Represents the identifier of a UAS (i.e. pair of UAV and UAV-C). + type: object + properties: + groupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + individualUasId: + type: array + items: + $ref: '#/components/schemas/UavId' + minItems: 2 + oneOf: + - required: [groupId] + - required: [individualUasId] + +UavId: + description: Represents the identifier of a UAV (e.g. UAV, UAV-C). + type: object + properties: + gpsI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + caaId: + type: string + anyOf: + - required: [gpsI] + - required: [caaId] + +C2ServiceArea: + description: Represents a C2 service area. + type: object + properties: + ncgiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + geographicAreaList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + oneOf: + - required: [geographicAreaList] + - anyOf: + - required: [ncgiList] + - required: [taiList] + +C2OpModeMngtCompStatus: + description: > + Represents the C2 Operation Mode Management Completion status for a UAV + (e.g. UAV, UAV-C). + type: object + properties: + uasId: + $ref: '#/components/schemas/UasId' + status: + $ref: '#/components/schemas/C2OpModeStatus' + required: + - uasId + - status + +C2SwitchPolicies: + description: Represents the C2 operation mode switching policies. + type: object + properties: + directC2LinkQualityThrlds: + $ref: '#/components/schemas/C2LinkQualityThrlds' + uuC2LinkQualityThrlds: + $ref: '#/components/schemas/C2LinkQualityThrlds' + +C2LinkQualityThrlds: + description: Represents the C2 link quality thresholds. + type: object +``` + +``` +properties: + nrRsrpThrldLow: + type: integer + minimum: 0 + maximum: 127 + nrRsrpThrldHigh: + type: integer + minimum: 0 + maximum: 127 + nrRsrqThrldLow: + type: integer + minimum: 0 + maximum: 127 + nrRsrqThrldHigh: + type: integer + minimum: 0 + maximum: 127 + packetLossThrldLow: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + packetLossThrldHigh: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' +``` + +## # ENUMS: + +``` +C2CommMode: + anyOf: + - type: string + enum: + - DIRECT_C2_COMMUNICATION + - NETWORK_ASSISTED_C2_COMMUNICATION + - UTM_NAVIGATED_C2_COMMUNICATION + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents the C2 Communication Mode. + Possible values are: + - DIRECT_C2_COMMUNICATION: Indicates Direct C2 Communication mode. + - NETWORK_ASSISTED_C2_COMMUNICATION: Indicates Network-Assisted C2 Communication mode. + - UTM_NAVIGATED_C2_COMMUNICATION: Indicates UTM-Navigated C2 communication mode. +``` + +``` +C2CommModeSwitching: + anyOf: + - type: string + enum: + - DIRECT_TO_NETWORK_ASSISTED_C2 + - NETWORK_ASSISTED_TO_DIRECT_C2 + - DIRECT_TO_UTM_NAVIGATED_C2 + - NETWORK_ASSISTED_TO_UTM_NAVIGATED_C2 + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents the C2 Communication Mode Switching type. + Possible values are: + - DIRECT_TO_NETWORK_ASSISTED_C2: Indicates the C2 Communication Mode switching from Direct + C2 Communication mode to Network-Assisted C2 Communication mode. + - NETWORK_ASSISTED_TO_DIRECT_C2: Indicates the C2 Communication Mode switching from + Network-Assisted C2 Communication mode to Direct C2 Communication mode. + - DIRECT_TO_UTM_NAVIGATED_C2: Indicates the C2 Communication Mode switching from + Direct C2 Communication mode to UTM-Navigated C2 communication mode. + - NETWORK_ASSISTED_TO_UTM_NAVIGATED_C2: Indicates the C2 Communication Mode switching + from Network-Assisted C2 Communication mode to UTM-Navigated C2 communication mode. +``` + +``` +C2SwitchingCause: + anyOf: + - type: string + enum: + - DIRECT_LINK_QUALITY_DEGRADATION + - DIRECT_LINK_AVAILABLE + - MOVING_BVLOS + - LOCATION_CHANGE + - TRAFFIC_CONTROL_NEEDED + - SECURITY_REASONS + - OTHER_REASONS + - type: string +``` + +``` +description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +description: | + Represents the C2 Communication Mode switching cause. + Possible values are: + - DIRECT_LINK_QUALITY_DEGRADATION: Indicates that the C2 Communication Mode switching + was triggered due to a degradation in the direct radio link quality. + - DIRECT_LINK_AVAILABLE: Indicates that the C2 Communication Mode switching was triggered + due to the availability of a direct link, i.e. direct radio link quality enables its + usage. + - MOVING_BVLOS: Indicates that the C2 Communication Mode switching was triggered due to + the UAV moving BVLOS. + - LOCATION_CHANGE: Indicates that the C2 Communication Mode switching was triggered due to + an actual or expected location/mobility of the UAV (e.g. which impacts the UAV-to-UAV-C + location). + - TRAFFIC_CONTROL_NEEDED: Indicates that the C2 Communication Mode switching was triggered + due to the necessity to have air traffic control. + - SECURITY_REASONS: Indicates that the C2 Communication Mode switching was triggered due to + security reasons. + - OTHER_REASONS: Indicates that the C2 Communication Mode switching was triggered due to + other reasons (e.g. unpredictable event, unknown reason, weather conditions, topography, + etc.). + +C2OpModeStatus: + anyOf: + - type: string + enum: + - SUCCESSFUL + - NOT_SUCCESSFUL + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents the C2 operation mode management completion status. + Possible values are: + - SUCCESSFUL: Indicates that the C2 operation mode configuration was successful. + - NOT_SUCCESSFUL: Indicates that the C2 operation mode configuration was not successful. +``` + +## A.3 UAE\_RealtimeUAVStatus API + +``` +openapi: 3.0.0 +info: + title: UAE Server Real-time UAV Status Service + version: 1.0.0 + description: | + UAE Server Real-time UAV Status Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.257 V17.1.0; Application layer support for Uncrewed Aerial System (UAS); + UAS Application Enabler (UAE) Server Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.257/ + +servers: + - url: '{apiRoot}/uae-uav-status/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /subscriptions: + get: + summary: Retrieve all the active real-time UAV status subscriptions managed by the UAE Server. + operationId: GetRTUavStatusSubscriptions + tags: + - Real-time UAV Status Subscriptions (Collection) + responses: + '200': + description: > + OK. All the active real-time UAV status subscriptions managed by the UAE Server + shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RTUavStatusSubsc' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + post: + summary: Request the creation of a subscription to real-time UAV status reporting. + operationId: CreateRTUavStatusSubsc + tags: + - Real-time UAV Status Subscriptions (Collection) + requestBody: +``` + +``` + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RTUavStatusSubsc' + responses: + '200': + description: > + OK. The subscription is successfully created and a representation of the created + Individual Real-time UAV Status Subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RTUavStatusSubsc' + headers: + Location: + description: > + Contains the URI of the created Individual Real-time UAV Status Subscription + resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + RTUavStatusNotification: + '{$request.body#/notificationUri}/uav-status': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RTUavStatusNotif' + responses: + '204': + description: > + No Content. The real-time UAV status notification is successfully + received and acknowledged. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + get: + summary: Retrieve a real-time UAV status subscription resource. + operationId: GetRTUavStatusSubscription + tags: + - Individual Real-time UAV Status Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Individual Real-time UAV Status Subscription identifier. + required: true + schema: + type: string + responses: + '200': + description: OK. The requested real-time UAV status subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RTUavStatusSubsc' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Request the update of an existing real-time UAV status subscription. + operationId: UpdateRTUavStatusSubscription + tags: + - Individual Real-time UAV Status Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Individual Real-time UAV Status Subscription identifier. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RTUavStatusSubsc' + responses: + '200': + description: > + OK. The real-time UAV status subscription is successfully updated and a + representation of the updated Individual Real-time UAV Status Subscription + resource shall be returned. + content: + application/json: +``` + +``` + schema: + $ref: '#/components/schemas/RTUavStatusSubsc' + '204': + description: No Content. The real-time UAV status subscription is successfully updated. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Request the deletion of an existing real-time UAV status subscription. + operationId: DeleteRTUavStatusSubscription + tags: + - Individual Real-time UAV Status Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Individual Real-time UAV Status Subscription identifier. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual Real-time UAV Status Subscription resource + is successfully deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: +``` + +``` +RTUavStatusSubsc: + description: > + Represents the parameters to request the creation or update of a subscription + to real-time UAV status reporting. + type: object + properties: + uassId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + uavIds: + type: array + items: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UavId' + minItems: 1 + notificationUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uassId + - uavIds + - notificationUri + +RTUavStatusNotif: + description: Represents a real-time UAV status notification. + type: object + properties: + subscriptionId: + type: string + rTUavStatus: + type: array + items: + $ref: '#/components/schemas/RTUavStatus' + minItems: 1 + required: + - subscriptionId + - rTUavStatus + +RTUavStatus: + description: Represents real-time UAV status information. + type: object + properties: + uavId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UavId' + uavNetConnStatus: + $ref: '#/components/schemas/UavNetConnStatus' + uavLocInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + allOf: + - required: [uavId] + - oneOf: + - required: [uavLocInfo] + - allOf: + - required: [uavLocInfo] + - required: [uavNetConnStatus] + +UavNetConnStatus: + description: Represents UAV network connection status information. + type: object + properties: + statusInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/MonitoringType' + timestamp: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + required: + - statusInfo + - timestamp +``` + +## A.4 UAE\_ChangeUSSManagement API + +``` +openapi: 3.0.0 + +info: + title: UAE Server USS Change Management Service + version: 1.0.0-alpha.1 + description: | + UAE Server USS Change Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.257 V18.1.0; Application layer support for Uncrewed Aerial System (UAS); + UAS Application Enabler (UAE) Server Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.257/ + +servers: + - url: '{apiRoot}/uae-usschange-mngt/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /policies: + get: + summary: Retrieve all the active USS Change Policies managed by the UAE Server. + operationId: GetUSSChangePolicies + tags: + - USS Change Policies (Collection) + responses: + '200': + description: > + OK. All the active USS Change Policies managed by the UAE Server shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/USSChangePolicy' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + post: + summary: Request the creation of a USS Change Policy. + operationId: CreateUSSChangePolicy + tags: + - USS Change Policies (Collection) + requestBody: +``` + +``` + + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/USSChangePolReq' + responses: + '200': + description: > + OK. The USS Change Policy is successfully created and a representation of the created + Individual USS Change Policy resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/USSChangePolResp' + headers: + Location: + description: > + Contains the URI of the created Individual USS Change Policy resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +#Editor's Note: The definition of the notifications is FFS. + +/policies/{policyId}: + parameters: + - name: policyId + in: path + description: Represents the identifier of the Individual USS Change Policy resource. + required: true + schema: + type: string + + get: + summary: Retrieve an existing Individual USS Change Policy resource. + operationId: GetUSSChangePolicy + tags: + - Individual USS Change Policy (Document) + responses: + '200': + description: OK. The requested Individual USS Change Policy resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/USSChangePolicy' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +put: + summary: Request the update of an existing Individual USS Change Policy resource. + operationId: UpdateUSSChangePolicy + tags: + - Individual USS Change Policy (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/USSChangePolicy' + responses: + '200': + description: > + OK. The Individual USS Change Policy resource is successfully updated and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/USSChangePolicy' + '204': + description: > + No Content. The Individual USS Change Policy resource is successfully updated and no + content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Request the modification of an existing Individual USS Change Policy resource. + operationId: ModifyUSSChangePolicy + tags: + - Individual USS Change Policy (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/USSChangePolicyPatch' + responses: + '200': + description: > + OK. The Individual USS Change Policy resource is successfully modified and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: +``` + +``` + $ref: '#/components/schemas/USSChangePolicy' + '204': + description: > + No Content. The Individual USS Change Policy resource is successfully modified and no + content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Request the deletion of an existing Individual USS Change Policy resource. + operationId: DeleteUSSChangePolicy + tags: + - Individual USS Change Policy (Document) + responses: + '204': + description: > + No Content. The Individual USS Change Policy resource is successfully deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/request-usschange: + post: + summary: Request USS change. + operationId: RequestUSSChange + tags: + - Request USS Change + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/USSChangeReq' + responses: + '204': + description: > + No Content. The USS change request is successfully received. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +``` + +``` +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + USSChangePolReq: + description: > + Represents the parameters to request the creation/Update of a USS Change Policy. + type: object + properties: + uassId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + ussChangePol: + $ref: '#/components/schemas/USSChangePolicy' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uassId + - ussChangePol + + USSChangePolResp: + description: Represents the response to a USS Change Policy create/update request. + type: object + properties: + ussChangePol: + $ref: '#/components/schemas/USSChangePolicy' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ussChangePol + + USSChangePolicy: + description: Represents a USS Change Policy. + type: object + properties: + uasId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + required: + - uasId + - notifUri + + USSChangePolicyPatch: + description: > + Represents the parameters to request the modification of a USS Change Policy. + type: object +``` + +``` +properties: + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + +USSChangeReq: + description: Represents the parameters to request for USS change. + type: object + properties: + uassId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + uasId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uassId + - uasId +``` + +## A.5 UAE\_DAASupport API + +``` +openapi: 3.0.0 + +info: + title: UAE Server DAA Support Service + version: 1.0.0-alpha.2 + description: | + UAE Server DAA Support Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.257 V18.2.0; Application layer support for Uncrewed Aerial System (UAS); + UAS Application Enabler (UAE) Server Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.257/ + +servers: + - url: '{apiRoot}/uae-daa/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /policies: + get: + summary: Retrieve all the active DAA Policies managed by the UAE Server. + operationId: GetDAAPolicies + tags: + - DAA Policies (Collection) + responses: + '200': + description: > + OK. All the active DAA Policies managed by the UAE Server shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DAAPolicy' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + post: + summary: Request the creation of a DAA Policy. + operationId: CreateDAAPolicy + tags: + - DAA Policies (Collection) + requestBody: +``` + +``` + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DAAPolReq' + responses: + '200': + description: > + OK. The DAA Policy is successfully created and a representation of the created + Individual DAA Policy resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/DAAPolResp' + headers: + Location: + description: > + Contains the URI of the created Individual DAA Policy resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + DAAPolCompStatusNotif: + '{$request.body#/daaPol/notifUri}/daa-policy': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DAAPolConfigNotif' + responses: + '204': + description: > + No Content. The DAA Policy Configuration Status notification is successfully + received and acknowledged. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +``` + +``` + + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +DAAEventsNotif: + '{$request.body#/daaPol/notifUri}/daa-events': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DAAEventsInfo' + responses: + '200': + description: > + OK. The DAA event notification is successfully received and acknowledged, and + the UASS returns updated/additional DAA related event information in the + response body. + content: + application/json: + schema: + $ref: '#/components/schemas/DAAEventsInfo' + '204': + description: > + No Content. The DAA event notification is successfully received and + acknowledged. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/policies/{policyId}: + parameters: + - name: policyId + in: path + description: Represents the identifier of the Individual DAA Policy resource. + required: true + schema: + type: string + + get: + summary: Retrieve an existing Individual DAA Policy resource. + operationId: GetIndDAAPolicy + tags: + - Individual DAA Policy (Document) + responses: + '200': + description: OK. The requested Individual DAA Policy resource shall be returned. + content: + application/json: + schema: + +``` + +``` + $ref: '#/components/schemas/DAAPolicy' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +put: + summary: Request the update of an existing Individual DAA Policy resource. + operationId: UpdateIndDAAPolicy + tags: + - Individual DAA Policy (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DAAPolicy' + responses: + '200': + description: > + OK. The Individual DAA Policy resource is successfully updated and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/DAAPolicy' + '204': + description: > + No Content. The Individual DAA Policy resource is successfully updated and no + content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Request the modification of an existing Individual DAA Policy resource. + operationId: ModifyIndDAAPolicy + tags: + - Individual DAA Policy (Document) + requestBody: + required: true +``` + +``` +content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/DAAPolicyPatch' +responses: + '200': + description: > + OK. The Individual DAA Policy resource is successfully modified and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/DAAPolicy' + '204': + description: > + No Content. The Individual DAA Policy resource is successfully modified and no + content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Request the deletion of an existing Individual DAA Policy resource. + operationId: DeleteIndDAAPolicy + tags: + - Individual DAA Policy (Document) + responses: + '204': + description: > + No Content. The Individual DAA Policy resource is successfully deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/inform-events: + post: + summary: Inform about and request the management of possible DAA related events. + operationId: InformDAAEvents + tags: + - InformDAAEvents +``` + +``` +requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/InformDAAEventsReq' +responses: + '204': + description: > + No Content. The request is successfully received. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + DAAPolReq: + description: > + Represents the parameters to request the creation of a DAA Policy. + type: object + properties: + uassId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + daaPol: + $ref: '#/components/schemas/DAAPolicy' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uassId + - daaPol + + DAAPolResp: + description: Represents the response to a DAA Policy creation request. + type: object + properties: + daaPol: + $ref: '#/components/schemas/DAAPolicy' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - daaPol + + DAAPolicy: + description: Represents the content of a DAA Policy. + type: object + properties: +``` + +``` + uasId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + required: + - uasId + - notifUri + +DAAPolicyPatch: + description: > + Represents the parameters to request the modification of a DAA Policy. + type: object + properties: + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + +InformDAAEventsReq: + description: Represents the parameters to report DAA related event(s). + type: object + properties: + uassId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + uasId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' + daaEventsInfo: + type: array + items: + $ref: '#/components/schemas/DAAEvent' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uassId + - uasId + - daaEventsInfo + +DAAPolConfigNotif: + description: Represents the parameters to request for DAA. + type: object + properties: + status: + $ref: '#/components/schemas/DAAPolConfigStatus' + required: + - status + +DAAEventsInfo: + description: Represents the parameters to request for DAA. + type: object + properties: + uasId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' + daaEventsInfo: + type: array + items: + $ref: '#/components/schemas/DAAEvent' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uasId + - daaEventsInfo + +DAAEvent: + description: Represents the parameters to request for DAA. + type: object + properties: + uasId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' + uasLocInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + required: + - uasId + - uasLocInfo + +DAAPolConfigStatus: + anyOf: + - type: string + enum: +``` + +- SUCCESSFUL +- NOT\_SUCCESSFUL +- type: string + - description: > + - This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | + +Represents DAA Policy configuration completion status. + +Possible values are: + +- SUCCESSFUL: Indicates that the DAA Policy configuration was successful. +- NOT\_SUCCESSFUL: Indicates that the DAA Policy configuration was not successful. + +--- + +## Annex B (informative): Withdrawn API versions + +### B.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. Clause 4.3.1.6 of 3GPP TS 29.501 [5] describes the withdrawal of API versions. + +--- + +### B.2 UAE\_C2OperationModeManagement API + +The API versions listed in table B.2-1 are withdrawn for the UAE\_C2OperationModeManagement API. + +**Table B.2-1: Withdrawn API versions of the UAE\_C2OperationModeManagement service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +--- + +### B.3 UAE\_RealtimeUAVStatus API + +The API versions listed in table B.3-1 are withdrawn for the UAE\_RealtimeUAVStatus API. + +**Table B.3-1: Withdrawn API versions of the UAE\_RealtimeUAVStatus service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +--- + +### B.4 UAE\_ChangeUSSManagement API + +The API versions listed in table B.3-1 are withdrawn for the UAE\_ChangeUSSManagement API. + +**Table B.3-1: Withdrawn API versions of the UAE\_ChangeUSSManagement service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +--- + +### B.5 UAE\_DAASupport API + +The API versions listed in table B.3-1 are withdrawn for the UAE\_DAASupport API. + +**Table B.3-1: Withdrawn API versions of the UAE\_DAASupport service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-05 | CT3#116-e | | - | - | - | Skeleton for the new UASAPP TS | 0.0.0 | +| 2021-05 | CT3#116-e | C3-213503 | | | | Inclusion of C3-213539 | 0.1.0 | +| 2021-09 | CT3#117-e | C3-214619 | - | - | - | Inclusion of: C3-214294, C3-214295, C3-214296, C3-214297, C3-214487, C3-214299, C3-214300, C3-214488, C3-214489 | 0.2.0 | +| 2021-10 | CT3#118-e | C3-215478 | | | | Inclusion of: C3-215442, C3-215443, C3-215444, C3-215445, C3-215446, C3-215447, C3-215448, C3-215449, C3-215450, C3-215451 | 0.3.0 | +| 2021-11 | CT3#119-e | C3-216551 | - | - | - | Inclusion of: C3-216211, C3-216212, C3-216213, C3-216214, C3-216215, C3-216216, C3-216217, C3-216218, C3-216219 | 0.4.0 | +| 2021-12 | CT#94-e | CP-213206 | - | - | - | Presented for information | 1.0.0 | +| 2022-01 | CT3#119-bis-e | C3-220456 | | | | Inclusion of: C3-220308, C3-220309, C3-220310, C3-220311, C3-220312, C3-220313, C3-220314, C3-220315 | 1.1.0 | +| 2022-02 | CT3#120-e | C3-221557 | | | | Inclusion of: C3-221342, C3-221343, C3-221344, C3-221345, C3-221346, C3-221347, C3-221348, C3-221349, C3-221352, C3-221353, C3-221638, C3-221639, C3-221640 | 1.2.0 | +| 2022-03 | CT#95e | CP-220162 | | | | Presentation to TSG CT for approval | 2.0.0 | +| 2022-03 | CT#95e | CP-220162 | | | | Approved by TSG CT | 17.0.0 | +| 2022-06 | CT#96 | CP-221160 | 0001 | 1 | F | Correcting the definition of a mandatory attribute in the OpenAPI file | 17.1.0 | +| 2022-06 | CT#96 | CP-221160 | 0002 | 1 | F | Updating the description fields for enumerations in the OpenAPI file | 17.1.0 | +| 2022-06 | CT#96 | CP-221160 | 0003 | 1 | F | Adding a missing reference number | 17.1.0 | +| 2022-06 | CT#96 | CP-221151 | 0004 | - | F | Update of info and externalDocs fields | 17.1.0 | +| 2023-03 | CT#99 | CP-230156 | 0006 | - | F | Correction of the description fields in enumerations | 18.0.0 | +| 2023-03 | CT#99 | CP-230161 | 0007 | - | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-06 | CT#100 | C3-232397 | 0008 | 2 | B | Definition of the service description clauses of the UAE_ChangeUSSManagement API | 18.1.0 | +| 2023-06 | CT#100 | C3-232398 | 0010 | 2 | B | Definition of the API resources and notifications of the UAE_ChangeUSSManagement API | 18.1.0 | +| 2023-06 | CT#100 | C3-232399 | 0011 | 1 | B | Definition of the API data model clause of the UAE_ChangeUSSManagement API | 18.1.0 | +| 2023-06 | CT#100 | C3-231252 | 0012 | | B | Definition of the OpenAPI description of the UAE_ChangeUSSManagement API | 18.1.0 | +| 2023-06 | CT#100 | C3-232400 | 0013 | 1 | B | Starting the Definition of the UAE_DAASupport API | 18.1.0 | +| 2023-06 | CT#100 | C3-232401 | 0014 | | B | Definition of the API clauses of the UAE_DAASupport API | 18.1.0 | +| 2023-06 | CT#100 | C3-232402 | 0015 | | B | Definition of the OpenAPI description of the UAE_DAASupport API | 18.1.0 | +| 2023-12 | CT#102 | CP-233288 | 0017 | 1 | F | Correct the attributes defined within DAAPolConfigNotif data type. | 18.2.0 | +| 2023-12 | CT#102 | CP-233237 | 0020 | | F | Update of info and externalDocs fields | 18.2.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29272/raw.md b/raw/rel-18/29_series/29272/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..98ca408fc0356962b05d9fbd88813cccdeca0720 --- /dev/null +++ b/raw/rel-18/29_series/29272/raw.md @@ -0,0 +1,6992 @@ + + +# 3GPP TS 29.272 V18.2.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Evolved Packet System (EPS); Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|-----------------------------------------------------------|----| +| Foreword..... | 10 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions and abbreviations..... | 14 | +| 3.1 Definitions..... | 14 | +| 3.2 Abbreviations..... | 14 | +| 4 General Description..... | 15 | +| 5 MME – HSS (S6a) and SGSN – HSS (S6d)..... | 15 | +| 5.1 Introduction..... | 15 | +| 5.2 Mobility Services..... | 15 | +| 5.2.1 Location Management Procedures..... | 15 | +| 5.2.1.1 Update Location..... | 15 | +| 5.2.1.1.1 General..... | 15 | +| 5.2.1.1.2 Detailed behaviour of the MME and the SGSN..... | 18 | +| 5.2.1.1.3 Detailed behaviour of the HSS..... | 23 | +| 5.2.1.2 Cancel Location..... | 27 | +| 5.2.1.2.1 General..... | 27 | +| 5.2.1.2.2 Detailed behaviour of the MME and the SGSN..... | 27 | +| 5.2.1.2.3 Detailed behaviour of the HSS..... | 28 | +| 5.2.1.3 Purge UE..... | 28 | +| 5.2.1.3.1 General..... | 28 | +| 5.2.1.3.2 Detailed behaviour of the MME and the SGSN..... | 29 | +| 5.2.1.3.3 Detailed behaviour of the HSS..... | 30 | +| 5.2.2 Subscriber Data Handling Procedures..... | 30 | +| 5.2.2.1 Insert Subscriber Data..... | 30 | +| 5.2.2.1.1 General..... | 30 | +| 5.2.2.1.2 Detailed behaviour of the MME and the SGSN..... | 33 | +| 5.2.2.1.3 Detailed behaviour of HSS..... | 36 | +| 5.2.2.2 Delete Subscriber Data..... | 38 | +| 5.2.2.2.1 General..... | 38 | +| 5.2.2.2.2 Detailed behaviour of the MME and the SGSN..... | 41 | +| 5.2.2.2.3 Detailed behaviour of the HSS..... | 42 | +| 5.2.3 Authentication Procedures..... | 42 | +| 5.2.3.1 Authentication Information Retrieval..... | 42 | +| 5.2.3.1.1 General..... | 42 | +| 5.2.3.1.2 Detailed behaviour of the MME and the SGSN..... | 44 | +| 5.2.3.1.3 Detailed behaviour of the HSS..... | 44 | +| 5.2.4 Fault Recovery Procedures..... | 46 | +| 5.2.4.1 Reset..... | 46 | +| 5.2.4.1.1 General..... | 46 | +| 5.2.4.1.2 Detailed behaviour of the MME and the SGSN..... | 47 | +| 5.2.4.1.3 Detailed behaviour of the HSS..... | 48 | +| 5.2.5 Notification Procedures..... | 49 | +| 5.2.5.1 Notification..... | 49 | +| 5.2.5.1.1 General..... | 49 | +| 5.2.5.1.2 Detailed behaviour of the MME and the SGSN..... | 52 | +| 5.2.5.1.3 Detailed behaviour of the HSS..... | 53 | +| 5A MME – CSS (S7a) and SGSN – CSS (S7d)..... | 54 | +| 5A.1 Introduction..... | 54 | +| 5A.2 Mobility Services..... | 54 | +| 5A.2.1 Location Management Procedures..... | 54 | +| 5A.2.1.1 Update VCSG Location..... | 54 | +| 5A.2.1.1.1 General..... | 54 | + +| | | | +|------------|-------------------------------------------------------|----| +| 5A.2.1.1.2 | Detailed behaviour of the MME and the SGSN..... | 55 | +| 5A.2.1.1.3 | Detailed behaviour of the CSS..... | 56 | +| 5A.2.1.2 | Cancel VCSG Location..... | 56 | +| 5A.2.1.2.1 | General..... | 56 | +| 5A.2.1.2.2 | Detailed behaviour of the MME and the SGSN..... | 57 | +| 5A.2.1.2.3 | Detailed behaviour of the CSS..... | 57 | +| 5A.2.2 | Subscriber Data Handling Procedures..... | 57 | +| 5A.2.2.1 | Insert VCSG Subscriber Data..... | 57 | +| 5A.2.2.1.1 | General..... | 57 | +| 5A.2.2.1.2 | Detailed behaviour of the MME and the SGSN..... | 58 | +| 5A.2.2.1.3 | Detailed behaviour of CSS..... | 59 | +| 5A.2.2.2 | Delete VCSG Subscriber Data..... | 59 | +| 5A.2.2.2.1 | General..... | 59 | +| 5A.2.2.2.2 | Detailed behaviour of the MME and the SGSN..... | 60 | +| 5A.2.2.2.3 | Detailed behaviour of the CSS..... | 60 | +| 5A.2.3 | Fault Recovery Procedures..... | 60 | +| 5A.2.3.1 | VCSG Reset..... | 60 | +| 5A.2.3.1.1 | General..... | 60 | +| 5A.2.3.1.2 | Detailed behaviour of the MME and the SGSN..... | 61 | +| 5A.2.3.1.3 | Detailed behaviour of the CSS..... | 61 | +| 6 | MME – EIR (S13) and SGSN – EIR (S13')..... | 62 | +| 6.1 | Introduction..... | 62 | +| 6.2 | ME Identity Check Procedures..... | 62 | +| 6.2.1 | ME Identity Check..... | 62 | +| 6.2.1.1 | General..... | 62 | +| 6.2.1.2 | Detailed behaviour of the MME and the SGSN..... | 63 | +| 6.2.1.3 | Detailed behaviour of the EIR..... | 63 | +| 7 | Protocol Specification and Implementation..... | 64 | +| 7.1 | Introduction..... | 64 | +| 7.1.1 | Use of Diameter base protocol..... | 64 | +| 7.1.2 | Securing Diameter Messages..... | 64 | +| 7.1.3 | Accounting functionality..... | 64 | +| 7.1.4 | Use of sessions..... | 64 | +| 7.1.5 | Transport protocol..... | 64 | +| 7.1.6 | Routing considerations..... | 65 | +| 7.1.7 | Advertising Application Support..... | 65 | +| 7.1.8 | Diameter Application Identifier..... | 65 | +| 7.1.9 | Use of the Supported-Features AVP..... | 66 | +| 7.2 | Commands..... | 67 | +| 7.2.1 | Introduction..... | 67 | +| 7.2.2 | Command-Code values..... | 67 | +| 7.2.3 | Update-Location-Request (ULR) Command..... | 68 | +| 7.2.4 | Update-Location-Answer (ULA) Command..... | 69 | +| 7.2.5 | Authentication-Information-Request (AIR) Command..... | 69 | +| 7.2.6 | Authentication-Information-Answer (AIA) Command..... | 70 | +| 7.2.7 | Cancel-Location-Request (CLR) Command..... | 70 | +| 7.2.8 | Cancel-Location-Answer (CLA) Command..... | 70 | +| 7.2.9 | Insert-Subscriber-Data-Request (IDR) Command..... | 71 | +| 7.2.10 | Insert-Subscriber-Data-Answer (IDA) Command..... | 71 | +| 7.2.11 | Delete-Subscriber-Data-Request (DSR) Command..... | 72 | +| 7.2.12 | Delete-Subscriber-Data-Answer (DSA) Command..... | 73 | +| 7.2.13 | Purge-UE-Request (PUR) Command..... | 74 | +| 7.2.14 | Purge-UE-Answer (PUA) Command..... | 74 | +| 7.2.15 | Reset-Request (RSR) Command..... | 75 | +| 7.2.16 | Reset-Answer (RSA) Command..... | 75 | +| 7.2.17 | Notify-Request (NOR) Command..... | 76 | +| 7.2.18 | Notify-Answer (NOA) Command..... | 76 | +| 7.2.19 | ME-Identity-Check-Request (ECR) Command..... | 77 | +| 7.2.20 | ME-Identity-Check-Answer (ECA) Command..... | 77 | +| 7.2.21 | Update-VCSG-Location-Request (UVR) Command..... | 78 | + +| | | | +|----------|---------------------------------------------------|-----| +| 7.2.22 | Update-VCSG-Location-Answer (UVA) Command..... | 78 | +| 7.2.23 | Cancel-VCSG-Location-Request (CVR) Command..... | 78 | +| 7.2.24 | Cancel-VCSG-Location-Answer (CVA) Command..... | 79 | +| 7.3 | Information Elements..... | 80 | +| 7.3.1 | General..... | 80 | +| 7.3.2 | Subscription-Data..... | 89 | +| 7.3.3 | Terminal-Information..... | 90 | +| 7.3.4 | IMEI..... | 91 | +| 7.3.5 | Software-Version..... | 91 | +| 7.3.6 | 3GPP2-MEID..... | 91 | +| 7.3.7 | ULR-Flags..... | 91 | +| 7.3.8 | ULA-Flags..... | 93 | +| 7.3.9 | Visited-PLMN-Id..... | 93 | +| 7.3.10 | Feature-List AVP..... | 93 | +| 7.3.10.1 | Feature-List AVP for the S6a/S6d application..... | 93 | +| 7.3.10.2 | Feature-List AVP for the S7a/S7d application..... | 106 | +| 7.3.11 | Requested-EUTRAN-Authentication-Info..... | 106 | +| 7.3.12 | Requested-UTRAN- GERAN-Authentication-Info..... | 106 | +| 7.3.13 | RAT-Type..... | 106 | +| 7.3.14 | Number-Of-Requested-Vectors..... | 106 | +| 7.3.15 | Re-Synchronization-Info..... | 107 | +| 7.3.16 | Immediate-Response-Preferred..... | 107 | +| 7.3.17 | Authentication-Info..... | 107 | +| 7.3.18 | E-UTRAN-Vector..... | 107 | +| 7.3.19 | UTRAN-Vector..... | 107 | +| 7.3.20 | GERAN-Vector..... | 108 | +| 7.3.21 | Network-Access-Mode..... | 108 | +| 7.3.22 | HPLMN-ODB..... | 108 | +| 7.3.23 | Item-Number..... | 108 | +| 7.3.24 | Cancellation-Type..... | 108 | +| 7.3.25 | DSR-Flags..... | 109 | +| 7.3.26 | DSA-Flags..... | 111 | +| 7.3.27 | Context-Identifier..... | 111 | +| 7.3.28 | Void..... | 112 | +| 7.3.29 | Subscriber-Status..... | 112 | +| 7.3.30 | Operator-Determined-Barring..... | 112 | +| 7.3.31 | Access-Restriction-Data..... | 112 | +| 7.3.32 | APN-OI-Replacement..... | 113 | +| 7.3.33 | All-APN-Configurations-Included-Indicator..... | 113 | +| 7.3.34 | APN-Configuration-Profile..... | 114 | +| 7.3.35 | APN-Configuration..... | 114 | +| 7.3.36 | Service-Selection..... | 116 | +| 7.3.37 | EPS-Subscribed-QoS-Profile..... | 116 | +| 7.3.38 | VPLMN-Dynamic-Address-Allowed..... | 116 | +| 7.3.39 | STN-SR..... | 116 | +| 7.3.40 | Allocation-Retention-Priority..... | 117 | +| 7.3.41 | AMBR..... | 117 | +| 7.3.42 | MIP-Home-Agent-Address..... | 117 | +| 7.3.43 | MIP-Home-Agent-Host..... | 118 | +| 7.3.44 | PDN-GW-Allocation-Type..... | 118 | +| 7.3.45 | MIP6-Agent-Info..... | 118 | +| 7.3.46 | RAT-Frequency-Selection-Priority-ID..... | 118 | +| 7.3.47 | IDA-Flags..... | 118 | +| 7.3.48 | PUA-Flags..... | 119 | +| 7.3.49 | NOR-Flags..... | 119 | +| 7.3.50 | User-Id..... | 120 | +| 7.3.51 | Equipment-Status..... | 120 | +| 7.3.52 | Regional-Subscription-Zone-Code..... | 121 | +| 7.3.53 | RAND..... | 121 | +| 7.3.54 | XRES..... | 121 | +| 7.3.55 | AUTN..... | 121 | + +| | | | +|---------|--------------------------------------------------------|-----| +| 7.3.56 | KASME..... | 121 | +| 7.3.57 | Confidentiality-Key AVP..... | 121 | +| 7.3.58 | Integrity-Key AVP..... | 121 | +| 7.3.59 | Kc AVP..... | 121 | +| 7.3.60 | SRES..... | 121 | +| 7.3.61 | Void..... | 121 | +| 7.3.62 | PDN-Type..... | 121 | +| 7.3.63 | Trace-Data AVP..... | 122 | +| 7.3.64 | Trace-Reference AVP..... | 122 | +| 7.3.65 | Void..... | 123 | +| 7.3.66 | Void..... | 123 | +| 7.3.67 | Trace-Depth AVP..... | 123 | +| 7.3.68 | Trace-NE-Type-List AVP..... | 123 | +| 7.3.69 | Trace-Interface-List AVP..... | 123 | +| 7.3.70 | Trace-Event-List AVP..... | 123 | +| 7.3.71 | OMC-Id AVP..... | 123 | +| 7.3.72 | GPRS-Subscription-Data..... | 123 | +| 7.3.73 | Complete-Data-List-Included-Indicator..... | 124 | +| 7.3.74 | PDP-Context..... | 124 | +| 7.3.75 | PDP-Type..... | 125 | +| 7.3.75A | Ext-PDP-Type..... | 125 | +| 7.3.76 | Void..... | 125 | +| 7.3.77 | QoS-Subscribed..... | 125 | +| 7.3.78 | CSG-Subscription-Data..... | 125 | +| 7.3.79 | CSG-Id..... | 125 | +| 7.3.80 | Expiration-Date..... | 125 | +| 7.3.81 | Roaming-Restricted-Due-To-Unsupported-Feature..... | 126 | +| 7.3.82 | Specific-APN-Info AVP..... | 126 | +| 7.3.83 | Alert-Reason AVP..... | 126 | +| 7.3.84 | LCS-Info..... | 126 | +| 7.3.85 | GMLC-Number..... | 126 | +| 7.3.86 | LCS-PrivacyException..... | 127 | +| 7.3.87 | SS-Code..... | 127 | +| 7.3.88 | SS-Status..... | 127 | +| 7.3.89 | Notification-To-UE-User..... | 127 | +| 7.3.90 | External-Client..... | 127 | +| 7.3.91 | Client-Identity..... | 128 | +| 7.3.92 | GMLC-Restriction..... | 128 | +| 7.3.93 | PLMN-Client..... | 128 | +| 7.3.94 | Service-Type..... | 128 | +| 7.3.95 | ServiceTypeIdentity..... | 128 | +| 7.3.96 | MO-LR..... | 128 | +| 7.3.97 | Void..... | 129 | +| 7.3.98 | Trace-Collection-Entity AVP..... | 129 | +| 7.3.99 | Teleservice-List..... | 129 | +| 7.3.100 | TS-Code..... | 129 | +| 7.3.101 | Call-Barring-Info..... | 129 | +| 7.3.102 | SGSN-Number..... | 129 | +| 7.3.103 | IDR-Flags..... | 129 | +| 7.3.104 | ICS-Indicator..... | 130 | +| 7.3.105 | Visited-Network-Identifier..... | 130 | +| 7.3.106 | IMS-Voice-Over-PS-Sessions-Supported..... | 131 | +| 7.3.107 | Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions..... | 131 | +| 7.3.108 | Last-UE-Activity-Time..... | 131 | +| 7.3.109 | GMLC-Address..... | 131 | +| 7.3.110 | EPS-User-State..... | 131 | +| 7.3.111 | EPS-Location-Information..... | 132 | +| 7.3.112 | MME-User-State..... | 132 | +| 7.3.113 | SGSN-User-State..... | 132 | +| 7.3.114 | User-State..... | 132 | +| 7.3.115 | MME-Location-Information..... | 133 | + +| | | | +|---------|----------------------------------------|-----| +| 7.3.116 | SGSN-Location-Information..... | 133 | +| 7.3.117 | E-UTRAN-Cell-Global-Identity..... | 134 | +| 7.3.118 | Tracking-Area-Identity..... | 134 | +| 7.3.119 | Cell-Global-Identity..... | 134 | +| 7.3.120 | Routing-Area-Identity..... | 134 | +| 7.3.121 | Location-Area-Identity..... | 134 | +| 7.3.122 | Service-Area-Identity..... | 134 | +| 7.3.123 | Geographical-Information..... | 134 | +| 7.3.124 | Geodetic-Information..... | 134 | +| 7.3.125 | Current-Location-Retrieved..... | 134 | +| 7.3.126 | Age-Of-Location-Information..... | 135 | +| 7.3.127 | Active-APN..... | 135 | +| 7.3.128 | Error-Diagnostic..... | 135 | +| 7.3.129 | Ext-PDP-Address AVP..... | 136 | +| 7.3.130 | UE-SRVCC-Capability..... | 136 | +| 7.3.131 | MPS-Priority..... | 136 | +| 7.3.132 | VPLMN-LIPA-Allowed..... | 136 | +| 7.3.133 | LIPA-Permission..... | 136 | +| 7.3.134 | Subscribed-Periodic-RAU-TAU-Timer..... | 137 | +| 7.3.135 | SIPTO-Permission..... | 137 | +| 7.3.136 | MDT-Configuration..... | 137 | +| 7.3.137 | Job-Type..... | 138 | +| 7.3.138 | Area-Scope..... | 138 | +| 7.3.139 | List-Of-Measurements..... | 138 | +| 7.3.140 | Reporting-Trigger..... | 138 | +| 7.3.141 | Report-Interval..... | 138 | +| 7.3.142 | Report-Amount..... | 138 | +| 7.3.143 | Event-Threshold-RSRP..... | 138 | +| 7.3.144 | Event-Threshold-RSRQ..... | 138 | +| 7.3.145 | Logging-Interval..... | 138 | +| 7.3.146 | Logging-Duration..... | 139 | +| 7.3.147 | Relay-Node-Indicator..... | 139 | +| 7.3.148 | MDT-User-Consent..... | 139 | +| 7.3.149 | PUR-Flags..... | 139 | +| 7.3.150 | Subscribed-VSRVCC..... | 139 | +| 7.3.151 | Equivalent-PLMN-List..... | 140 | +| 7.3.152 | CLR-Flags..... | 140 | +| 7.3.153 | UVR-Flags..... | 140 | +| 7.3.154 | UVA-Flags..... | 140 | +| 7.3.155 | VPLMN-CSG-Subscription-Data..... | 141 | +| 7.3.156 | Local-Time-Zone..... | 141 | +| 7.3.157 | A-MSISDN..... | 141 | +| 7.3.158 | Void..... | 141 | +| 7.3.159 | MME-Number-for-MT-SMS..... | 141 | +| 7.3.160 | Void..... | 142 | +| 7.3.161 | Void..... | 142 | +| 7.3.162 | SMS-Register-Request..... | 142 | +| 7.3.163 | Time-Zone..... | 142 | +| 7.3.164 | Daylight-Saving-Time..... | 142 | +| 7.3.165 | Subscription-Data-Flags..... | 142 | +| 7.3.166 | Measurement-Period-LTE..... | 143 | +| 7.3.167 | Measurement-Period-UMTS..... | 143 | +| 7.3.168 | Collection-Period-RRM-LTE..... | 143 | +| 7.3.169 | Collection-Period-RRM-UMTS..... | 143 | +| 7.3.170 | Positioning-Method..... | 143 | +| 7.3.171 | Measurement-Quantity..... | 143 | +| 7.3.172 | Event-Threshold-Event-I..... | 144 | +| 7.3.173 | Event-Threshold-Event-II..... | 144 | +| 7.3.174 | Restoration-Priority..... | 144 | +| 7.3.175 | SGs-MME-Identity..... | 144 | +| 7.3.176 | SIPTO-Local-Network-Permission..... | 144 | + +| | | | +|---------|-----------------------------------------------|-----| +| 7.3.177 | Coupled-Node-Diameter-ID..... | 144 | +| 7.3.178 | OC-Supported-Features..... | 144 | +| 7.3.179 | OC-OLR..... | 144 | +| 7.3.180 | ProSe-Subscription-Data..... | 144 | +| 7.3.181 | WLAN-offloadability..... | 145 | +| 7.3.182 | WLAN-offloadability-EUTRAN..... | 145 | +| 7.3.183 | WLAN-offloadability-UTRAN..... | 145 | +| 7.3.184 | Reset-ID..... | 145 | +| 7.3.185 | MDT-Allowed-PLMN-Id..... | 146 | +| 7.3.186 | Adjacent-PLMNs..... | 146 | +| 7.3.187 | Adjacent-Access-Restriction-Data..... | 146 | +| 7.3.188 | DL-Buffering-Suggested-Packet-Count..... | 146 | +| 7.3.189 | IMSI-Group-Id..... | 147 | +| 7.3.190 | Group-Service-Id..... | 147 | +| 7.3.191 | Group-PLMN-Id..... | 147 | +| 7.3.192 | Local-Group-Id..... | 148 | +| 7.3.193 | AESE-Communication-Pattern..... | 148 | +| 7.3.194 | Communication-Pattern-Set..... | 148 | +| 7.3.195 | Monitoring-Event-Configuration..... | 149 | +| 7.3.196 | Monitoring-Event-Report..... | 150 | +| 7.3.197 | UE-Reachability-Configuration..... | 150 | +| 7.3.198 | eNodeB-ID..... | 151 | +| 7.3.199 | Supported-Services..... | 151 | +| 7.3.200 | Supported-Monitoring-Events..... | 151 | +| 7.3.201 | AIR-Flags..... | 151 | +| 7.3.202 | UE-Usage-Type..... | 152 | +| 7.3.203 | DRMP..... | 152 | +| 7.3.204 | Non-IP-PDN-Type-Indicator..... | 152 | +| 7.3.205 | Non-IP-Data-Delivery-Mechanism..... | 152 | +| 7.3.206 | Additional-Context-Identifier..... | 153 | +| 7.3.207 | SCEF-Realm..... | 153 | +| 7.3.208 | Subscription-Data-Deletion..... | 153 | +| 7.3.209 | Preferred-Data-Mode..... | 153 | +| 7.3.210 | Emergency-Info..... | 153 | +| 7.3.211 | Load..... | 154 | +| 7.3.212 | V2X-Subscription-Data..... | 154 | +| 7.3.213 | V2X-Permission..... | 154 | +| 7.3.214 | PDN-Connection-Continuity..... | 154 | +| 7.3.215 | eDRX-Cycle-Length..... | 155 | +| 7.3.216 | eDRX-Cycle-Length-Value..... | 155 | +| 7.3.217 | UE-PC5-AMBR..... | 155 | +| 7.3.218 | Extended eNodeB-ID..... | 155 | +| 7.3.219 | MBSFN-Area..... | 155 | +| 7.3.220 | MBSFN-Area-ID..... | 155 | +| 7.3.221 | Carrier-Frequency..... | 156 | +| 7.3.222 | RDS-Indicator..... | 156 | +| 7.3.223 | Service-Gap-Time..... | 156 | +| 7.3.224 | Aerial-UE-Subscription-Information..... | 156 | +| 7.3.225 | Broadcast-Location-Assistance-Data-Types..... | 156 | +| 7.3.226 | Paging-Time-Window..... | 158 | +| 7.3.227 | Operation-Mode..... | 158 | +| 7.3.228 | Paging-Time-Window-Length..... | 158 | +| 7.3.229 | eDRX-Related-RAT..... | 158 | +| 7.3.230 | Core-Network-Restrictions..... | 159 | +| 7.3.231 | Interworking-5GS-Indicator..... | 159 | +| 7.3.232 | Ethernet-PDN-Type-Indicator..... | 159 | +| 7.3.233 | Subscribed-ARPI..... | 159 | +| 7.3.234 | IAB-Operation-Permission..... | 159 | +| 7.3.235 | V2X-Subscription-Data-Nr..... | 160 | +| 7.3.236 | UE-PC5-QoS..... | 160 | +| 7.3.237 | PC5-QoS-Flow..... | 160 | + +| | | | +|-------------------------------|------------------------------------------------------------------|------------| +| 7.3.238 | 5QI..... | 160 | +| 7.3.239 | PC5-Flow-Bitrates..... | 160 | +| 7.3.240 | Guaranteed-Flow-Bitrates..... | 161 | +| 7.3.241 | Maximum-Flow-Bitrates..... | 161 | +| 7.3.242 | PC5-Range..... | 161 | +| 7.3.243 | PC5-Link-AMBR..... | 161 | +| 7.3.244 | Third-Context-Identifier..... | 161 | +| 7.4 | Result-Code and Experimental-Result Values..... | 161 | +| 7.4.1 | General..... | 161 | +| 7.4.2 | Success..... | 161 | +| 7.4.3 | Permanent Failures..... | 161 | +| 7.4.3.1 | DIAMETER_ERROR_USER_UNKNOWN (5001)..... | 161 | +| 7.4.3.2 | DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION (5420)..... | 162 | +| 7.4.3.3 | DIAMETER_ERROR_RAT_NOT_ALLOWED (5421)..... | 162 | +| 7.4.3.4 | DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004)..... | 162 | +| 7.4.3.5 | DIAMETER_ERROR_EQUIPMENT_UNKNOWN (5422)..... | 162 | +| 7.4.3.6 | DIAMETER_ERROR_UNKNOWN_SERVING_NODE (5423)..... | 162 | +| 7.4.4 | Transient Failures..... | 162 | +| 7.4.4.1 | DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE (4181)..... | 162 | +| 7.4.4.2 | DIAMETER_ERROR_CAMEL_SUBSCRIPTION_PRESENT (4182)..... | 162 | +| 8 | User identity to HSS resolution..... | 162 | +| Annex A (normative): | MME mapping table for S6a and NAS Cause Code values..... | 163 | +| Annex B(normative): | SGSN mapping table for S6d and NAS Cause Code values..... | 166 | +| Annex C (normative): | Diameter overload control mechanism..... | 168 | +| C.1 | General..... | 168 | +| C.2 | S6a/S6d interfaces..... | 168 | +| C.2.1 | General..... | 168 | +| C.2.2 | HSS behaviour..... | 168 | +| C.2.3 | MME/SGSN behaviour..... | 168 | +| Annex D (Informative): | Diameter overload control node behaviour..... | 169 | +| D.1 | Message prioritisation over S6a/d..... | 169 | +| Annex E (normative): | Diameter message priority mechanism..... | 169 | +| E.1 | General..... | 169 | +| E.2 | S6a/S6d interfaces..... | 169 | +| E.2.1 | General..... | 169 | +| E.2.2 | HSS, CSS, EIR behaviour..... | 169 | +| E.2.3 | MME/SGSN behaviour..... | 170 | +| Annex F (normative): | Diameter load control mechanism..... | 171 | +| F.1 | General..... | 171 | +| F.2 | S6a/S6d interfaces..... | 171 | +| F.2.1 | General..... | 171 | +| F.2.2 | HSS behaviour..... | 171 | +| F.2.3 | MME/SGSN behaviour..... | 171 | +| Annex G (informative): | Change history..... | 172 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document describes the Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related diameter-based interfaces towards the Home Subscriber Server (HSS) or the CSG Subscriber Server (CSS), and the MME and the SGSN related diameter-based interface towards the Equipment Identity Register (EIR). + +This specification defines the Diameter application for the MME-HSS, S6a reference point, for the MME-CSS, S7a reference point, for the SGSN-HSS, S6d reference point, and for the SGSN-CSS, S7d reference point. The interactions between the HSS/CSS and the MME/SGSN are specified, including the signalling flows. + +This specification defines the Diameter application for the MME-EIR, S13 reference point, and for the SGSN-EIR, S13' reference point. The interactions between the MME/SGSN and the EIR are specified, including the signalling flows. + +In this specification, if there is no specific indication, the following principles apply: + +- "SGSN" refers to an SGSN which at least supports the S4 interface and may support Gn and Gp interfaces. +- "S4-SGSN" refers to an SGSN which supports the S4 interface and does not support Gn and Gp interfaces. +- Gn/Gp-SGSN refers to an SGSN which supports the Gn and Gp interfaces and does not support S4 interface. +- "GPRS subscription data" refers to the parameters in the HLR column in Table 5.2. in 3GPP TS 23.008 [30]. +- "EPS subscription data" refers to the parameters in the HSS column in Table 5.2A-1 in 3GPP TS 23.008 [30]. + +The Evolved Packet System stage 2 description (architecture and functional solutions) is specified in 3GPP TS 23.401 [2] and in 3GPP TS 23.060 [12]. + +SGSN CAMEL Subscription Data are not supported over S6d interface. + +--- + +## 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access ". +- [3] 3GPP TS 23.003: "Numbering, addressing and identification". +- [4] Void. + +- [5] 3GPP TS 33.401: "3GPP System Architecture Evolution: Security Architecture". +- [6] Void". +- [7] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [8] 3GPP TS 32.299: "Charging management; Diameter charging applications". +- [9] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol". +- [10] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [11] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [12] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [13] 3GPP TS 22.016: "International Mobile station Equipment Identities (IMEI)". +- [14] IETF RFC 4960: "Stream Control Transmission Protocol". +- [15] Void +- [16] 3GPP TS 33.210: "3G Security; Network Domain Security; IP Network Layer Security".. +- [17] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx and Dx Interfaces; Signalling flows and Message Elements". +- [18] 3GPP TS 33.102: "3G Security; Security Architecture". +- [19] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [20] IETF RFC 5778: "Diameter Mobile IPv6: Support for Home Agent to Diameter Server Interaction". +- [21] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [22] 3GPP TS 32.298: "Charging Management; CDR parameter description". +- [23] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [24] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [25] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol". +- [26] IETF RFC 5447: "Diameter Mobile IPv6: Support for Network Access Server to Diameter Server Interaction". +- [27] IETF RFC 4004: "Diameter Mobile IPv4 Application". +- [28] 3GPP2 A.S0022: "Interoperability Specification (IOS) for Evolved High Rate Packet Data (eHRPD) Radio Access Network Interfaces and Interworking with Enhanced Universal Terrestrial Radio Access Network (E-UTRAN)". +- [29] 3GPP TS 23.011: "Technical realization of Supplementary Services - General Aspects". +- [30] 3GPP TS 23.008: "Organization of subscriber data". +- [31] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [32] IETF RFC 5516: "Diameter Command Code Registration for Third Generation Partnership Project (3GPP) Evolved Packet System (EPS)". +- [33] 3GPP TS 32.251: "Telecommunication management; Charging management; Packet Switched (PS) domain charging". + +- [34] 3GPP TS 23.292: "IP Multimedia Subsystem (IMS) centralized services ". +- [35] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC)". +- [36] 3GPP TS 23.015:"Technical realization of Operator Determined Barring (ODB)". +- [37] 3GPP TS 29.173: "Diameter-based SLh interface for Control Plane LCS". +- [38] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [39] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp Interface". +- [40] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2". +- [41] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [42] 3GPP TS 22.042: "Network Identity and TimeZone (NITZ); Service description; Stage 1". +- [43] 3GPP TS 23.007: "Restoration procedures". +- [44] 3GPP TS 23.272: "Circuit Switched (CS) fallback in Evolved Packet System (EPS); Stage 2". +- [45] 3GPP TS 29.010: "Information element mapping between Mobile Station - Base Station System (MS - BSS) and Base Station System - Mobile-services Switching Centre (BSS - MSC)". +- [46] 3GPP TS 29.118: "Mobility Management Entity (MME) –Visitor Location Register (VLR)SGs interface specification ". +- [47] 3GPP TS 29.172: "Evolved Packet Core (EPC) LCS Protocol (ELP) between the Gateway Mobile Location Centre (GMLC) and the Mobile Management Entity (MME)". +- [48] 3GPP TS 29.338: "Diameter based protocols to support Short Message Service (SMS) capable Mobile Management Entities (MMEs)". +- [49] 3GPP TS 29.344: "Proximity-services (ProSe) Function to Home Subscriber Server (HSS) aspects; Stage 3". +- [50] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [51] 3GPP TS 23.380: "IMS Restoration Procedures". +- [52] 3GPP TS 22.153: "Multimedia Priority Service". +- [53] 3GPP TS 23.221: "Architectural requirements". +- [54] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [55] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications ". +- [56] 3GPP TS 29.217: "Congestion reporting over Np reference point". +- [57] IETF RFC 7944: "Diameter Routing Message Priority". +- [58] 3GPP TS 43.020: "Security related network functions". +- [59] 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces". +- [60] IETF RFC 8583: "Diameter Load Information Conveyance". +- [61] IETF RFC 6733: "Diameter Base Protocol". +- [62] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC); Protocol specification". + +- [63] 3GPP TS 29.128: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) interfaces for interworking with packet data networks and applications". +- [64] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [65] 3GPP TS 36.423: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); X2 Application Protocol (X2AP)". +- [66] 3GPP TS 29.503: "Unified Data Management Services". +- [67] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [68] 3GPP TS 23.287: "Architecture enhancements for 5G System (5GS) to support Vehicle-to-Everything (V2X) services". +- [69] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [70] 3GPP TS 29.563: "5G System; Home Subscriber Server (HSS) services for interworking with Unified Data Management (UDM); Stage 3". +- [71] GSMA PRD IR.73: "Steering of Roaming Implementation Guidelines". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**CSG subscription data from CSS:** It identifies the CSG subscription data that a MME or a SGSN has received from a CSS for a subscriber identified by its IMSI. + +**CSG subscription data from HSS:** It identifies the CSG subscription data that a MME or a SGSN has received from a HSS for a subscriber identified by its IMSI. + +### 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|------|----------------------------------------------------| +| AVP | Attribute Value Pair | +| C | Conditional | +| CSS | CSG Subscriber Server | +| DCN | Dedicated Core Network | +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| EIR | Equipment Identity Register | +| ESM | EPS Session Management | +| HSS | Home Subscriber Server | +| IAB | Integrated Access and Backhaul | +| IE | Information Element | +| LAA | Licensed Assisted Access | +| LWA | LTE/WLAN Aggregation | +| LWIP | LTE/WLAN Radio Level Integration with IPsec Tunnel | +| M | Mandatory | +| MME | Mobility Management Entity | +| NR | New Radio | + +| | | +|-----------|----------------------------------------------| +| O | Optional | +| ODB | Operator Determined Barring | +| SCEF | Service Capability Exposure Function | +| URRP-MME | User Reachability Request Parameter for MME | +| URPP-SGSN | User Reachability Request Parameter for SGSN | + +--- + +## 4 General Description + +This document describes the S6a/S6d and S13/S13' interfaces related procedures, message parameters and protocol specifications. + +The procedures, message parameters and protocol are similar between S6a and S6d. S6a is used for location changes of the MME, while S6d is for location changes of the SGSN. Refer to clause 5 for the differences, especially clause 5.2.1. + +The procedures, message parameters and protocol are identical as for the S13 and S13'. See clause 6 for details. + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the "Cat." column. For the correct handling of the Information Element according to the category type, see the description detailed in clause 6 of the 3GPP TS 29.228 [17]. + +--- + +## 5 MME – HSS (S6a) and SGSN – HSS (S6d) + +### 5.1 Introduction + +The S6a interface enables the transfer of subscriber related data between the MME and the HSS as described in the 3GPP TS 23.401 [2]. + +The S6d interface enables the transfer of subscriber related data between the SGSN and the HSS as described in 3GPP TS 23.060 [12]. + +### 5.2 Mobility Services + +#### 5.2.1 Location Management Procedures + +##### 5.2.1.1 Update Location + +###### 5.2.1.1.1 General + +The Update Location Procedure shall be used between the MME and the HSS and between the SGSN and the HSS to update location information in the HSS. The procedure shall be invoked by the MME or SGSN and is used: + +- to inform the HSS about the identity of the MME or SGSN currently serving the user, and optionally in addition; +- to update MME or SGSN with user subscription data; subscription data that are applicable to MMEs but not to SGSNs should not be sent to the SGSN unless the SGSN is known to be a combined MME/SGSN; similarly subscription data that are applicable to SGSNs but not to MMEs should not be sent to the MME unless the MME is known to be a combined MME/SGSN. +- to provide the HSS with other user data, such as Terminal Information or UE SRVCC Capability. + +This procedure is mapped to the commands Update-Location-Request/Answer (ULR/ULA) in the Diameter application specified in clause 7. + +Table 5.2.1.1.1/1 specifies the involved information elements for the request. + +Table 5.2.1.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.1.1.1/1: Update Location Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------|---------------------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Terminal Information (See 7.3.3) | Terminal-Information | O | This information element shall contain information about the user's mobile equipment. Within this Information Element, only the IMEI and the Software-Version AVPs shall be used on the S6a/S6d interface. | +| ULR Flags (See 7.3.7) | ULR-Flags | M | This Information Element contains a bit mask. See 7.3.7 for the meaning of the bits. | +| Visited PLMN Id (See 7.3.9) | Visited-PLMN-Id | M | This IE shall contain the MCC and the MNC, see 3GPP TS 23.003 [3]. It may be used to apply roaming based features. | +| Equivalent PLMN List (See 7.3.151) | Equivalent-PLMN-List | O | This Information Element shall contain the equivalent PLMN list of which the MME/SGSN requests the corresponding CSG Subscription data. | +| RAT Type (See 7.3.13) | RAT-Type | M | This Information Element contains the radio access type the UE is using. See clause 7.3.13 for details. | +| SGSN number (See 7.3.102) | SGSN-Number | C | This Information Element contains the ISDN number of the SGSN, see 3GPP TS 23.003 [3]. It shall be present when the message is sent on the S6d interface and the SGSN supports LCS (using MAP based Lg interface) or SMS functionalities or the Gs interface. It may be present when the message is sent on the S6a interface and the requesting node is a combined MME/SGSN. | +| Homogeneous Support of IMS Voice Over PS Sessions | Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions | O | This Information Element, if present, indicates whether or not "IMS Voice over PS Sessions" is supported homogeneously in all TAs or RAs in the serving node (MME or SGSN or combined MME/SGSN).

The value "SUPPORTED" indicates that there is support for "IMS Voice over PS Sessions" in all TAs or RAs.

The value "NOT_SUPPORTED" indicates that there is not support for "IMS Voice over PS Sessions" in any of the TAs or RAs. | +| V-GMLC address | GMLC-Address | C | This Information Element shall contain, if available, the IPv4 or IPv6 address of the V-GMLC associated with the serving node. | +| Active APN | Active-APN | O | This Information Element, if present, contains the list of active APNs stored by the MME or SGSN, including the identity of the PDN GW assigned to each APN. For the case of explicitly subscribed APNs, the following information shall be present:

- Context-Identifier: context id of subscribed APN in use
- Service-Selection: name of subscribed APN in use
- MIP6-Agent-Info: including PDN GW identity in use for subscribed APN
- Visited-Network-Identifier: identifies the PLMN where the PDN GW was allocated

For the case of the Wildcard APN, the following information shall be present:
- Context-Identifier: context id of the Wildcard APN
- Specific-APN-Info: list of APN-in use and related PDN GW identity when the subscribed APN is the wildcard APN

It may be present when MME or SGSN needs to restore PDN GW data in HSS due to a Reset procedure. | +| UE SRVCC Capability | UE-SRVCC-Capability | C | This information element shall indicate if the UE supports or does not support the SRVCC capability and shall be present if the MME or the SGSN supports SRVCC and this information is available to the MME or the SGSN. | +| MME Number for MT SMS | MME-Number-for-MT-SMS | C | This Information Element contains the ISDN number of the MME to route SMS to the UE through the MME, see 3GPP TS 23.003 [3]. It shall be present when the MME supports SMS in MME and wishes to provide SMS in MME. | + +| | | | | +|------------------------------------------|--------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SMS Register Request | SMS-Register-Request | C | This information element is used to inform the HSS if the MME or the SGSN needs to be registered for SMS, prefers not to be registered for SMS or has no preference. It shall be present when the MME supports SMS in MME and requests to be registered for SMS. It shall be present when the SGSN supports "SMS in SGSN" as defined in clause 5.3.18 in 23.060 [12], and requests to be registered for SMS. | +| SGs MME identity | SGs-MME-Identity | O | This information element is used to inform the HSS of the MME identity that the MME will use over the SGs interface. This information element shall be present, if the MME supports this information element and if the MME identity used over SGs is different from the MME Diameter identity used over S6a. | +| Coupled node's Diameter identity | Coupled-Node-Diameter-ID | O | This information element contains the Diameter identity of the coupled node (i.e. MME's Diameter identity for the SGSN and SGSN's Diameter identity for the MME) when the message is sent by the combined MME/SGSN.

This information element may be present when the message is sent on the S6a/S6d interface and the requesting node is a combined MME/SGSN. | +| Adjacent PLMNs | Adjacent-PLMNs | O | This information element, if present, shall contain the list of PLMNs where an UE served by the MME/SGSN is likely to make a handover from the PLMN where the MME/SGSN is located. This list is statically configured by the operator in the MME/SGSN, according to the geographical disposition of the different PLMNs in that area, the roaming agreements, etc... | +| Supported Services (3GPP TS 29.336 [54]) | Supported-Services | O | If present, this Information Element shall contain AVPs indicating details of the services supported by the MME/SGSN. | + +**Table 5.2.1.1/2: Update Location Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable:
- User Unknown
- Unknown EPS Subscription
- RAT Not Allowed
- Roaming Not Allowed | +| Error-Diagnostic | Error-Diagnostic | O | If the Experimental Result indicates "Unknown EPS Subscription", Error Diagnostic may be present to indicate whether or not GPRS subscription data are subscribed (i.e. whether or not Network Access Mode stored in the HSS indicates that only circuit service is allowed).

If the Experimental Result indicates "Roaming Not Allowed", and the Update Location is rejected due to ODB, Error Diagnostic may be present to indicate the specific type of ODB. | +| ULA-Flags (See 7.3.8) | ULA-Flags | C | This Information Element contains a bit mask. See 7.3.8 for the meaning of the bits. It shall be present only when the Result-Code AVP is DIAMETER_SUCCESS. | +| Subscription Data (See 7.3.2) | Subscription-Data | C | This Information Element shall contain the complete subscription profile of the user. It shall be present if success is reported, unless an explicit "skip subscriber data" indication was present in the request. | +| Reset-IDs (See 7.3.184) | Reset-ID | O | The Reset-ID uniquely identifies a fallible resource in the HSS on which the user (IMSI) depends. In the event of a restart of the fallible resource a Reset message containing the Reset-ID will exactly identify the impacted subscribers. | + +#### 5.2.1.1.2 Detailed behaviour of the MME and the SGSN + +The MME shall make use of this procedure to update the MME identity stored in the HSS (e.g. at initial attach, inter MME tracking area update or radio contact after HSS reset). + +The SGSN shall make use of this procedure to update the SGSN identity stored in the HSS (e.g. at initial attach, inter SGSN routing area update or radio contact after HSS reset). + +The MME shall make use of this procedure to request SMS data and to become registered for SMS. + +The SGSN shall make use of this procedure to request to become registered for SMS. + +A combined MME/SGSN which uses different Diameter Identities for the MME and SGSN parts shall not send a second ULR when in a first ULA the ULA-Flag "Separation Indication" was not set. + +For UEs receiving emergency services, in which the UE was not successfully authenticated, the MME or SGSN shall not make use of the Update Location procedure. + +If the Update Location request is to be sent due to an inter node (SGSN to MME) update and the previous SGSN is a Gn/Gp SGSN, the MME shall set the "Single-Registration-Indication" flag in the ULR-Flags information element in the request. + +If the Update Location request is to be sent due to an initial attach, the MME or SGSN shall set the "Initial-Attach-Indicator" flag in the ULR-Flags information element in the request. + +If the Update Location request is sent due to a Tracking Area Update following intra-PLMN inter-MME or AMF to MME handover, then the MME may set the Intra-PLMN-inter-MME handover flag in the ULR-Flags information element in the request. + +If the Update Location request is sent due to a Tracking Area Update following inter-PLMN inter-MME or AMF to MME handover, then the MME may set the Inter-PLMN-inter-MME handover flag in the ULR-Flags information element in the request. + +In order to avoid handovers failing (including the cases of emergency and non-emergency EPS fallback voice handovers), the Intra-PLMN-inter-MME handover flag and Inter-PLMN-inter-MME handover flags are required if the HPLMN deploys Steering of Roaming functionality that interferes with the Diameter signalling procedures e.g. as described in the section 6.1 of GSMA PRD IR.73 [71]. Otherwise, these flags are left to be configured based on operator policy. + +NOTE 0: It is useful if the HPLMN discloses how they do Steering of Roaming to the VPLMN. The VPLMN can be configured to comply if they support this feature in the MME. + +When receiving and supporting Reset-ID AVPs in the response, the MME or SGSN shall delete all the stored Reset-IDs, if there are any, and then store all the received Reset-IDs. + +A combined MME/SGSN shall set the "Skip Subscriber Data" flag in the ULR-Flags if subscriber data are already available due to a previous identical location update. Otherwise the MME/SGSN shall not set the "Skip Subscriber Data" flag in the ULR-Flags. + +A combined MME/SGSN that has advertised its support for the combined MME/SGSN capability, by either including the SGSN Number within ULR sent over S6a or including the Coupled-Node-Diameter-ID within ULR sent over S6a/S6d or by using same Diameter identity over S6a and S6d interfaces, shall be prepared to receive a single subscription data update message (IDR or DSR) from the HSS when the subscription data is modified. + +If the MME or SGSN knows about the homogeneity of the support of IMS Voice over PS Sessions in all TAs or RAs associated to that serving node (i.e., it is supported in all the TA/RAs or it is not supported in any of the TA/RAs) and for the serving subscriber taking into account roaming relationship for IMS Voice over PS Sessions, it shall include this indication to the HSS in the "Homogeneous Support of IMS Voice over PS Sessions" IE. + +The MME or SGSN may include dynamic APN and PGW ID data in the list of Active-APN AVPs, in order to restore this information in the HSS after a Reset procedure. + +The MME/SGSN may include an equivalent PLMN list to request the CSG Subscription data of the equivalent PLMNs. + +A standalone MME shall not indicate its support for any SGSN specific features, and it shall not request explicitly the download of GPRS data (via the GPRS-Subscription-Data-Indicator flag; see clause 7.3.7). A standalone MME that does not support the "SMS in MME" feature shall not provide its MME Number for MT SMS, "SMS only" indication or SMS Registration Request and therefore not indicate its support for any SMS related features (such as ODB or barring services). + +For an SGSN, if a DIAMETER\_ERROR\_CAMEL\_SUBSCRIPTION\_PRESENT is received, the SGSN shall initiate the update location procedure with MAP over Gr interface and use Gr for the subsequent mobility procedures. + +For a standalone MME or SGSN, if EPS or GPRS subscription data is received, the standalone MME or SGSN shall replace all of the EPS or GPRS subscription data of the user in the MME or SGSN. Any optional EPS or GPRS data not received, but stored in the standalone MME or SGSN, shall be deleted. + +For a combined MME/SGSN, if EPS subscription data of the user is received, it shall replace all of the EPS subscription data of the user. Any optional EPS data not received by the combined MME/SGSN, but stored in the MME/SGSN, shall be deleted. + +For a combined MME/SGSN, if GPRS subscription data of the user is received, it shall replace all of the GPRS subscription data of the user. Any optional GPRS data not received by the combined MME/SGSN, but stored in the MME/SGSN, shall be deleted. + +When receiving an Update Location response from the HSS, the MME or SGSN shall check the result code. If it indicates success the MME or SGSN shall store the received subscription profile (if any), and it shall store the HSS identity as received in the Origin-Host AVP. + +If an Additional MSISDN (A-MSISDN) is available in the subscription data and downloaded in the A-MSISDN AVP to the MME/SGSN in an Update Location and if the MME or SGSN supports the additional MSISDN feature, the MME or SGSN shall use the Additional MSISDN as C-MSISDN. + +For UEs receiving emergency services (i.e. emergency attached UEs or normal attached UEs with a UE Requested PDN Connection for emergency services), and if the MME or SGSN supports emergency services for users in limited service state, the MME or SGSN shall proceed even if the Update Location procedure fails (e.g. authenticated users with roaming restrictions or RAT-Type restrictions in HSS). + +When receiving GPRS-Subscription-Data AVP in the response, the SGSN or combined MME/SGSN shall delete all the stored PDP-Contexts, if there are any, and then store all the received PDP-Contexts. + +When receiving the APN-Configuration-Profile AVP in a ULA, the MME or SGSN shall delete all the stored APN-Configurations, if there are any, and then store all the received APN-Configurations. + +For each of the received APN-Configurations in the APN-Configuration-Profile, if both the MIP6-Agent-Info and the PDN-GW-Allocation-Type AVPs are absent in the APN-Configuration AVP and the MME or SGSN does not have any associated PGW information, the MME or SGSN shall perform the PGW selection (static or dynamic) according to the local configuration. If MIP6-Agent-Info is present, and PDN-GW-Allocation-Type is not present, this means that the PDN GW address included in MIP6-Agent-Info has been statically allocated. If the MIP6-Agent-Info contains an FQDN of the PDN GW, the MME shall retrieve the PGW PLMN ID from the MIP-Home-Agent-Host AVP within the MIP6-Agent-Info AVP. + +When receiving an Update Location response from the HSS in the TAU or RAU procedure, for each of the received APN-Configurations in the APN-Configuration-Profile, if both the MIP6-Agent-Info and the PDN-GW-Allocation-Type AVPs are absent in the APN-Configuration AVP and the MME or SGSN has associated PGW information and the UE-level access restriction "HO-To-Non-3GPP-Access Not Allowed" is not set, the MME or SGSN should send a Notify Request if HO to the WLAN is supported in the network, including the APN and PDN GW identity to the HSS in order to restore this information in the HSS e.g. after a Reset procedure. + +If the MME/SGSN supports interworking with Gn/Gp-SGSNs, it shall ensure that the Context-Identifier sent over GTPv1 for each of the received APN-Configurations is within the range of 1 and 255. + +NOTE 1: If the MME/SGSN receives from HSS a Context-Identifier value higher than 255, how this value is mapped to a value between 1 and 255 is implementation specific. + +If the subscriber is not roaming and the SIPTO-Permission information for an APN is present, the MME or SGSN shall allow SIPTO above RAN for that APN only if the SIPTO-Permission information indicates so. + +If the subscriber is not roaming and the SIPTO-Permission information for an APN is not present, the MME or SGSN may allow SIPTO above RAN for that APN. + +If the subscriber is roaming and the SIPTO-Permission information for an APN is present, the MME or SGSN shall allow SIPTO above RAN for that APN only if the SIPTO-Permission information indicates so and the VPLMN Dynamic Address is allowed and the MME or SGSN selects a PDN GW in the VPLMN. + +If the subscriber is roaming and the SIPTO-Permission information for an APN is not present, the MME or SGSN shall not allow SIPTO above RAN for that APN. + +NOTE 2: Based on local configuration, the MME or SGSN can determine not to allow SIPTO above RAN for an APN, regardless if the SIPTO-Permission information is present. + +If the subscriber is not roaming and the SIPTO-Local-Network-Permission information for an APN is present, the MME or SGSN shall allow SIPTO at the local network for that APN only if the SIPTO-Local-Network-Permission information indicates so. + +If the subscriber is not roaming and the SIPTO-Local-Network-Permission information for an APN is not present, the MME or SGSN may allow SIPTO at the local network for that APN. + +If the subscriber is roaming and the SIPTO-Local-Network-Permission information for an APN is present, the MME or SGSN shall allow SIPTO at the local network for that APN only if the SIPTO-Local-Network-Permission information indicates so and the VPLMN Dynamic Address is allowed and the MME or SGSN selects a L-GW in the VPLMN. + +If the subscriber is roaming and the SIPTO-Local-Network-Permission information for an APN is not present, the MME or SGSN shall not allow SIPTO at the local network for that APN. + +NOTE 3: Based on local configuration, the MME or SGSN can determine not to allow SIPTO at the local network for an APN, regardless if the SIPTO-Local-Network-Permission information is present. + +If MPS-Priority AVP is present and the UE is subscribed to the eMLPP or 1x RTT priority service in the CS domain as indicated by the MPS-CS-Priority bit of the AVP, the MME shall allow the UE to initiate the RRC connection with higher priority than other normal UEs during CS Fallback procedure. If the MPS-Priority AVP is present and the UE is subscribed to MPS in the EPS domain as indicated by the MPS-EPS-Priority bit of the AVP, the MME shall allow the UE to initiate the RRC connection with higher priority than other normal UEs. + +If the subscriber is not roaming, the MME or SGSN may allow or prohibit the UE to use LIPA as indicated by LIPA-Permission for a specific APN. + +If the subscriber is roaming and the VPLMN-LIPA-Allowed AVP indicates that the UE is not allowed to use LIPA in the VPLMN where the UE is attached, the MME or SGSN shall not provide LIPA for the UE and shall not consider the LIPA-Permission AVP. If the VPLMN-LIPA-Allowed AVP indicates that the UE is allowed to use LIPA in the VPLMN, the MME or SGSN may allow or prohibit the UE to use LIPA as indicated by LIPA-Permission for a specific APN. The VPLMN-Dynamic-Address-Allowed AVP shall not be considered if it is received when the MME or SGSN establishes a PDN connection with LIPA. + +If the LIPA-Permission information for an APN indicates LIPA only, the MME or SGSN shall only allow LIPA for that APN via the authorized CSGs according to the CSG Subscription Data. If the LIPA-Permission information for an APN indicates LIPA prohibited, the MME or SGSN shall not allow LIPA for that APN. If the LIPA-Permission information for an APN indicates LIPA conditional, the MME or SGSN shall allow non LIPA, and LIPA for that APN via the authorized CSGs according to the CSG Subscription Data. If the LIPA-Permission AVP is not present for a specific APN, the APN shall not be allowed to use LIPA. + +The LIPA-Permission information for the Wildcard APN shall apply to any APN that is not explicitly present in the subscription data. + +The SIPTO-Permission information for the Wildcard APN shall apply to any APN that is not explicitly present in the subscription data. + +The SIPTO-Local-Network-Permission information for the Wildcard APN shall apply to any APN that is not explicitly present in the subscription data. + +If the subscription data received for a certain APN indicates that the APN was authorized as a consequence of having the Wildcard APN in the user subscription in HSS, then the MME shall not store this APN data beyond the lifetime of the UE session and the MME shall delete them upon disconnection of the UE. + +If the MME supports the Relay Node functionality (see 3GPP TS 36.300 [40]) and the subscription data indicates that the subscriber is not a relay, the MME shall reject the attach request from a device attempting to attach to EPS as a Relay Node. If a device requests to be attached to EPS as an UE, the MME shall proceed with the attach procedure regardless of the content of the Relay Node Indicator. + +If trace data are received in the subscriber data, the MME or SGSN shall start a Trace Session. For details, see 3GPP TS 32.422 [23]. + +If the Ext-PDP-Type AVP is present in the PDP-Context AVP, the SGSN or combined MME/SGSN shall ignore the value of the PDP-Type AVP. + +If the subscriber is not roaming and the Subscribed-Periodic-RAU-TAU-Timer information is present, the MME or SGSN shall allocate the subscribed value to the UE as periodic RAU or TAU timer. If the subscriber is roaming and the Subscribed-Periodic-RAU-TAU-Timer information is present, the MME or SGSN may use the subscribed periodic RAU/TAU timer value as an indication to decide for allocating a locally configured periodic RAU/TAU timer value to the UE. + +For a combined MME/SGSN, the node may include the Coupled-Node-Diameter-ID AVP to allow the HSS to determine if the UE is served by the MME and SGSN parts of the same combined MME/SGSN. When the message is sent over S6a interface and if this AVP is included, the MME shall include the Diameter identity of the coupled SGSN which is used by the SGSN over S6d interface. When the message is sent over S6d interface and if this AVP is included, the SGSN shall include the Diameter identity of the coupled MME which is used by the MME over S6a interface. + +NOTE 4: The Coupled-Node-Diameter-ID AVP allows the HSS to determine if the UE is served by the MME and SGSN parts of the same combined MME/SGSN, when the SGSN number is not available and when Diameter identity of S6a and S6d interfaces of the combined MME/SGSN are not the same. + +If the MME supports the "SMS in MME" feature and the UE has requested a combined EPS/IMSI attach or Combined TA/LA Update (see 3GPP TS 23.272 [44]) and the MME is not currently registered for SMS, the MME requests to be registered for SMS by indicating its MME Number for MT SMS in the request, including the SMS-Register-Request AVP and the SMS-Only-Indication flag set in the ULR-Flags AVP if UE indicates "SMS only". + +If the MME supports the "SMS in MME" feature, when receiving an EPS attach or a TAU from a UE accessing NB-IoT which requests SMS by indicating "SMS transfer without Combined Attach" (see 3GPP TS 23.401 [2]), and if the MME is not currently registered for SMS, the MME requests to be registered for SMS by indicating its MME Number for MT SMS in the request, including the SMS-Register-Request AVP. + +If the HSS provides the MME with SMS data in the ULA and the ULA-Flags is received with "MME Registered for SMS" flag set, the MME shall store this data for providing SMS in MME service and consider itself registered for SMS. + +If the SGSN supports the "SMS in SGSN" feature as specified in 3GPP TS 23.060 [12], clause 5.3.18, and wishes to provide SMS via SGSN it shall set the "SMS in SGSN" flag in the Feature-List AVP, and include SMS-Register-Request AVP. If the SGSN supports the Diameter based Gdd interface for SMS in SGSN, it shall set the "Gdd-in-SGSN" flag in the Feature-List AVP. If the UE has indicated "SMS-Only" this shall be indicated to the HSS setting the SMS-Only-Indication flag in the ULR-Flags AVP. + +NOTE 5: the setting of the "SMS in SGSN" feature bit reflects the "SMS in SGSN Offered" as described in stage 2 above. + +If the SMS-In-SGSN-Allowed-Indication flag is set in the received Subscription-Data-Flags AVP, the SGSN shall store the subscription data for providing SMS in SGSN service. + +If the subscriber is not roaming and the Restoration-Priority information for a certain APN is present, the MME or SGSN shall consider the subscribed value as the relative priority of the user's PDN connection among PDN connections to the same APN when restoring PDN connections affected by an SGW or PGW failure/restart (see 3GPP TS 23.007 [43]). If the subscriber is roaming and the Restoration-Priority information for a certain APN is present, the MME or SGSN may use the subscribed value as an indication of the relative priority of the user's PDN connection among PDN connections to the same APN based on service level agreements. The MME/SGSN may use a locally configured value as default restoration priority if the Restoration-Priority AVP for a certain APN is not present, or if it is not permitted by service level agreements for an in-bound roamer. + +If the subscription data received for a certain APN includes WLAN-offloadability AVP, then the MME or SGSN shall determine the offloadability of the UE's PDN Connection(s) to that APN based on subscription data and locally configured policy (e.g. for roaming users or when the subscription data does not include any offloadability indication). + +NOTE 6: As indicated in clause 7.3.31, if the UE-level access restriction "HO-To-Non-3GPP-Access Not Allowed" is set, the offload of PDN Connections to WLAN is not allowed for any APN. + +If the subscription data received for the user includes the DL-Buffering-Suggested-Packet-Count AVP, then the MME or SGSN should take into account the subscription data, in addition to local policies, to determine whether to invoke extended buffering of downlink packets at the SGW for High Latency Communication. Otherwise, the MME or SGSN shall make this determination based on local policies only. + +When receiving IMSI-Group-Id AVP(s) within the Subscription-Data AVP, the MME or SGSN shall replace stored IMSI-Group Ids (if any) with the received information rather than add the received information to the stored information. + +When receiving one or more Monitoring-Event-Configuration AVP(s) in the ULA, the MME or SGSN shall start the detection of the Monitoring events indicated in those AVP(s), if not already started, and shall stop the detection and delete the previous monitoring events (if any) which are not indicated in those AVP(s). If there is a failure when starting the detection (e.g. maximum resources exceeded), the MME or SGSN shall not store the failed configuration(s) and shall send a notification of those events whose configuration have failed, as described in clause 5.2.5.1.2 (NOR/NOA commands). If the Subscription-Data AVP is received in the ULA but it does not contain any Monitoring-Event-Configuration AVP(s), the MME or SGSN shall stop the detection and delete all stored monitoring event configurations (if any). + +If the MME/SGSN supports Monitoring, the MME/SGSN shall include the Supported-Services AVP with Supported-Monitoring-Events included in the ULR command. + +If the MME and the UE support Attach without PDN connection (i.e. EMM-REGISTERED without PDN connection) and the PDN-Connection-Restricted flag is set in the received Subscription-Data-Flags AVP, the MME shall not establish any non-emergency PDN connection and shall tear down any existing non-emergency PDN connection for this user. + +If the subscription data received for the user includes the Preferred-Data-Mode AVP, for an IP APN configuration or for a non-IP APN configuration with SGi based delivery, then the MME should (if the subscriber is not roaming) or may (if the subscriber is roaming) take into account the subscription data, in addition to local policies and the UE's Preferred Network Behaviour, to determine whether to transmit the traffic associated with this APN over the User Plane and/or over the Control Plane. Otherwise, the MME shall make this determination based on local policies and the UE's Preferred Network Behaviour only. + +If the MME receives from the HSS an Update Location response containing the Emergency-Info AVP in the Subscription-Data, the MME shall use the PDN-GW identity included in Emergency-Info as the PDN-GW used to establish emergency PDN connections with the emergency APN, for non-roaming authenticated UEs requesting the handover of an emergency PDN connection if the MME is configured to use a dynamic PDN-GW for emergency services for such user. + +When receiving V2X-Subscription-Data in the ULA, the MME shall determine whether the UE is authorized to use V2X communication over PC5 according to V2X subscription data and UE provided network capability. If the UE is authorized to use V2X communication over PC5, the MME shall store the "V2X service authorized" indication together with the UE AMBR used for PC5 interface (i.e. UE-PC5-AMBR), and provide such information to the eNodeB when needed. + +If the MME/SGSN receives from the HSS an Update Location response without the bit set for "NR as Secondary RAT" in the Feature-List AVP, the MME/SGSN, based on local policy, may restrict access for NR as secondary RAT when all relevant entities except HSS supports it. + +If the MME receives from the HSS an Update Location response containing in the subscription data the Core-Network-Restrictions AVP with the bit "5GC not allowed" set, the MME shall restrict mobility towards 5GC. + +#### 5.2.1.1.3 Detailed behaviour of the HSS + +When receiving an Update Location request the HSS shall check whether subscription data exists for the IMSI. + +If the HSS determines that there is not any type of subscription for the IMSI (including EPS, GPRS and CS subscription data), a Result Code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the Update Location Request is received over the S6a interface, and the subscriber has not any APN configuration, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +If the Update Location Request is received over S6a, from an MME that does not support the "Non-IP PDN Type APNs" feature, and the user's subscription profile contains only APN configurations of type "Non-IP", the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +If the Update Location Request is received over the S6d interface, and the subscriber has neither an APN configuration profile nor GPRS subscription data, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +When sending DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION, an Error Diagnostic information may be added to indicate whether or not GPRS subscription data are subscribed (i.e. whether or not Network Access Mode stored in the HSS indicates that only CS service is allowed). + +The HSS shall check whether the RAT type the UE is using is allowed for the subscriber in the serving PLMN. If it is not, a Result Code of DIAMETER\_ERROR\_RAT\_NOT\_ALLOWED shall be returned. + +The HSS shall check whether access to EPC is allowed, based on the active Core Network Restrictions of the subscriber. If access to EPC is restricted, a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION shall be returned. + +The HSS shall check whether roaming is not allowed in the VPLMN due to ODB. If so a Result Code of DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED shall be returned. When this error is sent due to the MME or SGSN not supporting a certain ODB category, an Error Diagnostic information element may be added to indicate the type of ODB; if this error is sent due to the ODB indicating "Barring of Roaming", Error Diagnostic shall not be included. + +If the Update Location Request is received over the S6d interface and the HSS supports the "SGSN CAMEL Capability" feature, and the SGSN indicates support of SGSN CAMEL capability, the HSS shall check if the subscriber has SGSN CAMEL Subscription data. If the subscriber has SGSN CAMEL Subscription data, the HSS shall return a Result Code of DIAMETER\_ERROR\_CAMEL\_SUBSCRIPTION\_PRESENT. + +If the Update Location Request is received over the S6a interface, the HSS shall send a Cancel Location Request with a Cancellation-Type of MME\_UPDATE\_PROCEDURE (CLR; see clause 7.2.7) to the previous MME (if any) and replace the stored MME-Identity with the received value (the MME-Identity is received within the Origin-Host AVP). The HSS shall reset the "UE purged in MME" flag and delete any stored last known MME location information of the (no longer) purged UE. If the "Single-Registration-Indication" flag was set in the received request, the HSS shall send a Cancel Location Request with a Cancellation-Type of SGSN\_UPDATE\_PROCEDURE to the SGSN (MAP Cancel Location), and delete the stored SGSN address and SGSN number. If the "Initial-Attach-Indicator" flag was set in the received request, and the "Single-Registration-Indication" flag was not set, the HSS shall send a Cancel Location Request with a Cancellation-Type of INITIAL\_ATTACH\_PROCEDURE (CLR; see clause 7.2.7, or MAP Cancel Location) to the SGSN if there is an SGSN registration. + +If the Update Location Request is received over the S6d interface, the HSS shall send a Cancel Location Request with a Cancellation-Type of SGSN\_UPDATE\_PROCEDURE (CLR; see clause 7.2.7, or MAP Cancel Location) to the previous SGSN (if any) and replace the stored SGSN-Identity with the received value (the SGSN-Identity is received within the Origin-Host AVP). The HSS shall reset the "UE purged in SGSN" flag and delete any stored last known SGSN location information of the (no longer) purged UE. If the "Initial-Attach-Indicator" flag was set in the received request, the HSS shall send a Cancel Location Request with a Cancellation-Type of INITIAL\_ATTACH\_PROCEDURE (CLR; see clause 7.2.7) to the MME if there is an MME registration. + +When the HSS receives the Update Location Request, if a 15th digit of the IMEI AVP is received, the HSS may discard the digit. + +If the Update Location Request includes either the ULR-flag Inter-PLMN-inter-MME or the ULR-flag intra-PLMN-inter-MME, then the HSS may ignore this information. + +NOTE 1: These flags are intended for use by Steering of Roaming functions that are not standardised by 3GPP and which operate by interfering with the Diameter procedures. + +If the Update Location Request includes the list of active APNs, the HSS shall delete all the stored dynamic PDN GW information, if there are any, and then replace them by the PDN GW information received in the list of Active-APN AVPs. + +If the Update Location Request includes an equivalent PLMN list, the HSS shall return the CSG list (if any) for each equivalent PLMN to the MME with the subscription data, and Visited-PLMN-Id AVP shall be present in the CSG-Subscription-Data AVP to indicate the corresponding PLMN. If there is no equivalent PLMN list received, the HSS may not include Visited-PLMN-Id AVP in the CSG-Subscription-Data AVP, and the CSG-Subscription-Data AVP shall contain the CSG subscription data of the registered PLMN of the MME or the SGSN. + +If the Update Location Request is received over the S6a interface for a user for which the URRP-MME parameter is set in the HSS, the HSS shall clear the URRP-MME parameter and send an indication to the corresponding Service Related Entities. + +If the Update Location Request is received over the S6d interface for a user for which the URRP-SGSN parameter is set in the HSS, the HSS shall clear the URRP-SGSN parameter and send an indication to the corresponding Service Related Entities. + +If no result code has been sent to the MME or SGSN so far, the HSS shall include the subscription data in the ULA command according to the ULR-Flags and the supported/unsupported features of the MME or SGSN, unless an explicit "skip subscriber data" indication has been received in the request, and shall return a Result Code of DIAMETER\_SUCCESS. + +When the APN-Configuration-Profile AVP is present in the Subscription-Data AVP sent within a ULA, the AVP shall contain at least the default APN Configuration and a Context-Identifier AVP that identifies the per subscriber's default APN configuration. The default APN Configuration shall not contain the Wildcard APN (see 3GPP TS 23.003 [3], clause 9.2); the default APN shall always contain an explicit APN. + +The GPRS Subscription data (if available in the HSS) shall only be present in the ULA command if it was indicated by the serving node in the ULR-Flags AVP (see clause 7.3.7), or when the subscription data is returned by a Pre-Rel-8 HSS (via an IWF) or when the Update Location Request is received over the S6d interface and there is no APN configuration profile stored for the subscriber. + +The HSS shall use the indication received in the GPRS-Subscription-Data-Indicator for future use in the subscriber data update procedures. + +The HSS shall store the new terminal information and/or the new UE SRVCC capability, if they are present in the request. If the UE SRVCC capability is not present, the HSS shall store that it has no knowledge of the UE SRVCC capability. + +If the MME/SGSN indicates support of the Additional-MSISDN feature and an additional MSISDN (A-MSISDN) is available in the subscription data, the HSS shall send the provisioned additional MSISDN together with the MSISDN. + +If the MME/SGSN does not support the Additional-MSISDN feature, the HSS shall populate the MSISDN AVP either with the subscribed MSISDN or the subscribed additional MSISDN based on operator policy and availability. + +NOTE 2: When the MME/SGSN does not support the Additional-MSISDN feature, the MME/SGSN will use the MSISDN from the MSISDN AVP as C-MSISDN. + +LCS-Info, Teleservice-List and Call-Barring-Info data shall be included according to the list of supported features indicated by the serving node (see clause 7.3.10). + +If the HSS supports the "SMS in MME" feature and receives the indication that the MME supports the "SMS in MME" feature and requests to be registered for SMS by including the MME Number for MT SMS, SMS-Register-Request AVP and/or setting the SMS-Only-Indication flag in the ULR-Flags AVP if indicated from the UE, the HSS shall determine if SMS can be provided via the MME as described in 3GPP TS 23.272 [44]. If SMS in MME is accepted the HSS shall register the MME for SMS, store the "MME number for MT SMS" as the corresponding MSC number to be used for MT SMS and return an indication of MME registered for SMS in ULA-Flags AVP. + +If the MME is successfully registered for SMS the HSS shall download the available SMS related subscription data that may comprise SMS teleservice, MSISDN, ODB and barring services for SMS according to supported features. Also, if the user is considered as not reachable (i.e., MNRF flag is set in HSS for that user), and the UE is considered to have free available memory (i.e., MCEF flag is not set in HSS for that user), the HSS shall send a MAP-Alert-Service-Centre message or S6c-Alert-Service-Centre-Request to the SMS-IWMSC (see 3GPP TS 29.338 [48]). + +If the HSS supports the "SMS in SGSN" feature as described in 3GPP TS 23.060 [12], clause 5.3.18 and receives the indication from the SGSN that it supports "SMS in SGSN" feature, and SMS-Register-Request AVP and/or the SMS-Only-Indication flag in the ULR-Flags AVP if indicated from the UE, and the PS subscriber data allow for SMS services (e.g. the subscription information indicates "PS and SMS-Only"), the HSS shall determine if SMS can be provided via the SGSN as described in 3GPP TS 23.060 [12]. If "SMS in SGSN" is accepted the HSS shall indicate in the ULA that "SMS in SGSN" is allowed to the SGSN and shall handle MT SMS as described in 3GPP TS 23.060 [12], clause 5.3.18. If the HSS supports the "Gdd-in-SGSN" feature and receives the indication from the SGSN that it supports the "Gdd-in-SGSN" feature, the HSS shall store the information that the SGSN supports the Gdd interface. Also, if the user is considered as not reachable (i.e., MNRG flag is set in HSS for that user), and the UE is considered to have free available memory (i.e., MCEF flag is not set in HSS for that user), the HSS shall send a MAP-Alert-Service-Centre message or S6c-Alert-Service-Centre-Request to the SMS-IWMSC (see 3GPP TS 29.338 [48]). + +The HSS may use the indication received in the Node-Type-Indicator for future use in the subscriber data update procedures. + +Subscriber-Status AVP shall be present in the Subscription-Data AVP when sent within a ULA. If the value "OPERATOR\_DETERMINED\_BARRING" is sent, the Operator-Determined-Barring AVP or HPLMN-ODB AVP shall also be present in the Subscription-Data AVP, or vice versa. + +Access-Restriction-Data AVP shall be present within the Subscription-Data AVP sent within a ULA if at least one of the defined restrictions applies. + +The AMBR AVP shall be present in the Subscription-Data AVP when the APN-Configuration-Profile AVP is sent within a ULA (as part of the Subscription-Data AVP) and may be present in the Subscription-Data AVP when the GPRS-Subscription-Data AVP is present. + +The EPS-Subscribed-QoS-Profile AVP and the AMBR AVP shall be present in the APN-Configuration AVP when the APN-Configuration AVP is sent in the APN-Configuration-Profile AVP and when the APN-Configuration-Profile AVP is sent within a ULA (as part of the Subscription-Data AVP). + +For those APNs that have been authorized as a consequence of having the Wildcard APN in the user subscription, the HSS shall include the specific APN name and associated PDN-GW identity inside the APN context of the Wildcard APN. This indicates to the MME that the particular APN shall not be cached in the MME and it shall be deleted when the UE session is terminated. + +If a Result Code of DIAMETER\_SUCCESS is returned, the HSS shall set the Separation Indication in the response. + +If the HSS receives an indication in the ULR command about the homogeneous support of IMS Voice over PS Sessions in all TA/RAs associated to a serving node, it may use this information in the future in order to skip the T-ADS data retrieval, as described in clause 5.2.2.1 (IDR/IDA commands). + +Subscribed-VSRVCC AVP shall be present within the Subscription-Data AVP sent within a ULA only if the user is subscribed to the SRVCC and vSRVCC. + +If the UE is allowed to use Proximity-based Services in the visited PLMN, the HSS shall include ProSe-Subscription-Data AVP within the Subscription-Data AVP sent within a ULA. + +If the HSS receives the SGs MME identity and if the HSS supports this information element, the HSS shall store it for use with VLR restoration. + +If the HSS receives Update Location Request over both the S6a and S6d interfaces then based on the following conditions the HSS concludes if the UE is served by the MME and SGSN parts of the same combined MME/SGSN: + +- if both the messages contain the same SGSN number; or +- if the Diameter identity received over S6a matches with the Diameter identity received over S6d; or +- if the Coupled-Node-Diameter-ID AVP received over S6a interface matches with the Diameter identity received within Origin-Host AVP over S6d interface OR if the Coupled-Node-Diameter-ID AVP received over S6d interface matches with the Diameter identity received within Origin-Host AVP over S6a interface. + +If the HSS supports the handling of access restrictions for adjacent PLMNs, and it receives a list of adjacent PLMNs from the MME/SGSN, the HSS may send the associated Access Restriction Data, according to local operator policies, in the Adjacent-Access-Restriction-Data AVP, so the MME/SGSN can use this information to allow, or prevent, inter-RAT inter-PLMN handovers towards any of the PLMNs indicated by the HSS. The HSS shall not include in the list of + +Adjacent-Access-Restriction-Data the PLMN-ID, and its access restrictions, of the current PLMN where the MME/SGSN is located, since this information is already conveyed in the Access-Restriction-Data AVP inside the Subscription-Data AVP. + +If the HSS supports Monitoring events and receives a Supported-Services AVP it shall only trigger those services which are supported by the MME/SGSN. + +If the HSS has previously received over SWx (see 3GPP TS 29.273 [59]) the identity of the PDN-GW to be used for the establishment of emergency PDN connections, it shall include it as part of the Subscription-Data AVP (in the Emergency-Info AVP), in the Update Location response to the MME. + +If the UE is allowed to use V2X service in the visited PLMN and the MME supports V2X service, the HSS shall include V2X-Subscription-Data AVP into Subscription-Data AVP within the ULA command. + +If the MME/SGSN supports the "External-Identifier" feature, the HSS shall include the External-Identifier associated with Monitoring Event Configuration in the External-Identifier AVP if populated in the subscription. When multiple External Identifiers are defined for a same subscription, the HSS shall send a default External Identifier in the External-Identifier AVP of the Subscription-Data AVP, and shall include a specific External Identifier (if different from the default External Identifier) associated to each Monitoring Event Configuration in the External-Identifier AVP of each Monitoring-Event-Configuration AVP occurrence inside the Subscription-Data AVP. + +The Aerial-UE-Subscription-Information AVP shall be present within the Subscription-Data AVP sent within a ULA only if the user has Aerial UE subscription information. + +## 5.2.1.2 Cancel Location + +### 5.2.1.2.1 General + +The Cancel Location Procedure shall be used between the HSS and the MME and between the HSS and the SGSN to delete a subscriber record from the MME or SGSN. The procedure shall be invoked by the HSS and is used: + +- to inform the MME or SGSN about a subscription withdrawal, or a change in the subscriber profile that does not allow PS services anymore (e.g., the Network Access Mode does not allow PS services), or a change in the subscriber profile that does not allow access to EPC anymore, or +- to inform the MME or SGSN about an ongoing update procedure i.e. MME or SGSN change or +- to inform the MME or SGSN about an initial attach procedure. + +This procedure is mapped to the commands Cancel-Location-Request/Answer (CLR/CLA) in the Diameter application specified in clause 7. + +Table 5.2.1.2.1/1 specifies the involved information elements for the request. + +Table 5.2.1.2.1/2 specifies the involved information elements for the answer. + +**Table 5.2.1.2.1/1: Cancel Location Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Cancellation Type
(See 7.3.24) | Cancellation-Type | M | Defined values that can be used are:
- MME-Update Procedure,
- SGSN-Update Procedure,
- Subscription Withdrawal,
- Update Procedure_IWF,
- Initial Attach Procedure. | +| CLR Flags
(See 7.3.152) | CLR-Flags | O | This Information Element contains a bit mask. See 7.3.152 for the meaning of the bits and the condition for each bit to be set or not. | + +**Table 5.2.1.2.1/2: Cancel Location Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | The result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]). | + +### 5.2.1.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a Cancel Location request the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_SUCCESS is returned. + +If it is known, the MME or SGSN shall check the Cancellation Type and act accordingly. + +If the Cancellation Type is "Subscription Withdrawal", the MME or SGSN shall delete the subscription data and detach the UE; in addition, if the Reattach-Required flag is set, the MME or SGSN shall indicate to the UE to initiate an immediate re-attach procedure, as described in 3GPP TS 23.401 [2] and 3GPP TS 23.060 [12]. A result code of DIAMETER\_SUCCESS shall be returned. + +If a cancellation type of "Initial Attach Procedure" is received, the MME or SGSN shall not delete the subscription data. For details see 3GPP TS 23.401 [2] and 3GPP TS 23.060 [12]. If the MME receives this cancellation type, and it is registered for SMS, it shall consider itself as unregistered for SMS. Also in this case a result code of DIAMETER\_SUCCESS shall be returned. + +When a UE is served by a single combined MME/SGSN for both E-UTRAN and non-E-UTRAN access, the combined MME/SGSN shall check the Cancellation-Type. If it indicates Subscription Withdrawal or Update Procedure\_IWF, the CLR is processed both in the MME part and in the SGSN part of the combined node. If it indicates Initial Attach Procedure, and if the CLR-Flags AVP is received and supported by the combined MME/SGSN, the CLR is processed only in the affected part of the combined node as indicated by the "S6a/S6d-Indicator" flag in the CLR-Flags AVP. Otherwise, the CLR is processed only in the affected part of the combined node and subscription data are kept for the not affected part. + +### 5.2.1.2.3 Detailed behaviour of the HSS + +The HSS shall make use of this procedure when the subscription is withdrawn by the HSS operator, and when the HSS detects that the UE has moved to a new MME or SGSN area, and when EPC access is not allowed due to Core Network Restrictions. + +The HSS+UDM shall also make use of this procedure when the HSS+UDM detects that the UE has moved to a new AMF area, if the AMF indicates to the HSS+UDM to cancel MME and/or SGSN. The HSS+UDM shall include a cancellation type as specified in clause 5.4.2.2 of 3GPP TS 29.563 [70]. + +The HSS shall include a cancellation type of "Subscription Withdrawal" if the subscription is withdrawn by the operator, or if the subscriber profile does not allow PS services anymore, or if the Core Network Restrictions do not allow access to EPC anymore; the HSS may set the Reattach-Required flag in order to request the MME or the SGSN to trigger an immediate reattachment of the UE. + +The HSS shall include a cancellation type of "MME Update Procedure" if the UE moved to a new MME area. + +The HSS shall include a cancellation type of "SGSN Update Procedure" if the UE moved to a new SGSN area. + +The HSS shall include a cancellation type of "Initial Attach Procedure" if the cancel location is initiated due to an Initial Attach from the UE. + +The HSS shall include the CLR-Flags with the "S6a/S6d-Indicator" flag indicating the affected part of the combined node if the cancel location is to be sent to a combined MME/SGSN during initial attach procedure. + +### 5.2.1.3 Purge UE + +#### 5.2.1.3.1 General + +The Purge UE Procedure shall be used between the MME and the HSS and between the SGSN and the HSS to indicate that the subscriber's profile has been deleted from the MME or SGSN either by an MMI interaction or automatically, e.g. because the UE has been inactive for several days. + +This procedure is mapped to the commands Purge-UE-Request/Answer (PUR/PUA) in the Diameter application specified in clause 7. + +Table 5.2.1.3.1/1 specifies the involved information elements for the request. + +Table 5.2.1.3.1/2 specifies the involved information elements for the answer. + +**Table 5.2.1.3.1/1: Purge UE Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 673 3 [61]) | M | This information element shall contain user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| PUR-Flags (See 7.3.149) | PUR-Flags | O | If present, this Information Element shall contain a bitmask. See clause 7.3.149 for the meaning of the bits. | +| EPS-Location-Information (See 7.3.111) | EPS-Location-Information | C | This Information Element shall contain the last known EPS-Location Information of the purged UE. Shall be present if available. | + +**Table 5.2.1.3.1/2: Purge UE Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable:
- User Unknown | +| PUA-Flags
(See 7.3.48) | PUA-Flags | C | This Information Element shall contain a bit mask. See clause 7.3.48 for the meaning of the bits. It shall be present only when the Result-Code AVP is DIAMETER_SUCCESS. | + +### 5.2.1.3.2 Detailed behaviour of the MME and the SGSN + +The MME shall make use of this procedure to set the "UE Purged in the MME" flag in the HSS when the subscription profile is deleted from the MME database due to MMI interaction or after long UE inactivity. + +The SGSN shall make use of this procedure to set the "UE Purged in SGSN" flag in the HSS when the subscription profile is deleted from the SGSN database due to MMI interaction or after long UE inactivity. + +The combined MME/SGSN when using a single Origin-Host identity shall make use of this procedure to set the "UE Purged in MME" and "UE Purged in SGSN" flags in the HSS when the subscription profile is deleted from the common MME/SGSN database due to MMI interaction or after long UE inactivity on all registered accesses. If the HSS has indicated support for the Partial Purge feature (see clause 7.3.10), the combined MME/SGSN may also indicate to the HSS a Purge of the UE in only one of the serving nodes in the combined node (either in the MME or in the SGSN). + +The combined MME/SGSN when using different Origin-Host identities for MME and SGSN shall send two Purge UE Requests as if it was not combined. + +When receiving a Purge UE response from the HSS the MME shall check the Result Code. If it indicates success, the MME shall check the PUA flag "freeze M-TMSI", and if set freeze the M-TMSI i.e. block it for immediate re-use. + +When receiving a Purge UE response from the HSS the SGSN shall check the Result Code. If it indicates success, the SGSN shall check the PUA flag "freeze P-TMSI", and if set freeze the P-TMSI i.e. block it for immediate re-use. + +When receiving a Purge UE response from the HSS the combined MME/SGSN shall check the Result Code. If it indicates success, the combined MME/SGSN shall check the PUA flag "freeze M-TMSI" and "freeze P-TMSI", and if set freeze the M-TMSI and/or the P-TMSI i.e. block it for immediate re-use. + +### 5.2.1.3.3 Detailed behaviour of HSS + +When receiving a Purge UE request the HSS shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If it is known, the HSS shall set the result code to DIAMETER\_SUCCESS and compare the received identity in the Origin-Host with the stored MME-Identity and with the stored SGSN-Identity. + +If the received identity matches the stored MME-identity and the stored SGSN-Identity (no matter whether the node type indicator bit in ULR-Flags was set or clear), then: + +- if the HSS supports the Partial Purge feature (see clause 7.3.10), and the combined MME/SGSN indicated that the UE was purged in only one of the serving nodes, the HSS shall set the PUA flags according to the serving node where the purge was done (i.e., either "freeze M-TMSI" if the purge was done in the MME, or "freeze P-TMSI" if the purge was done in the SGSN); similarly, the HSS shall either set the "UE purged in MME" flag and + +store the received last known MME Location information of the purged UE, or set the "UE purged in SGSN" flag and store the received last known SGSN-Location Information of the purged UE, accordingly; + +- if the HSS does not support the Partial Purge feature, or the combined MME/SGSN did not indicate that the UE was purged in only one of the serving nodes, the HSS shall set the PUA flags "freeze M-TMSI" and "freeze P-TMSI" in the answer message and set the flag "UE purged in MME" and "UE purged in SGSN" and store the received last known EPS Location Information of the purged UE; + +If the received identity matches the stored MME-identity but not the stored SGSN-identity, the HSS shall set the PUA flag "freeze M-TMSI" and clear the PUA flag "freeze P-TMSI" in the answer message, set the flag "UE purged in MME" and store the received last known MME location information of the purged UE; + +If the received identity matches the stored SGSN-identity but not the stored MME-identity, the HSS shall set the PUA flag "freeze P-TMSI" and clear the PUA flag "freeze M-TMSI" in the answer message and set the flag "UE purged in SGSN" and store the received last known SGSN location information of the purged UE; + +If the received identity does not match the stored MME-identity and does not match the stored SGSN-identity, the HSS shall clear the PUA flags "freeze M-TMSI" and "freeze P-TMSI" in the answer message. + +## 5.2.2 Subscriber Data Handling Procedures + +### 5.2.2.1 Insert Subscriber Data + +#### 5.2.2.1.1 General + +The Insert Subscriber Data Procedure shall be used between the HSS and the MME and between the HSS and the SGSN for updating and/or requesting certain user data in the MME or SGSN in the following situations: + +- due to administrative changes of the user data in the HSS and the user is now located in an MME or SGSN, i.e. if the user was given a subscription and the subscription has changed; subscription data that are applicable to MMEs but not to SGSNs should not be sent to the SGSN unless the SGSN is known to be a combined MME/SGSN; similarly subscription data that are applicable to SGSNs but not to MMEs should not be sent to the MME unless the MME is known to be a combined MME/SGSN. +- the operator has applied, changed or removed Operator Determined Barring for this user; +- activate subscriber tracing in the MME or the SGSN; +- to indicate to the MME or SGSN that the HSS has requested to be notified when the UE has become reachable; +- to request from the MME or SGSN the necessary data to support the T-ADS functionality; +- to retrieve location information and/or state information from the MME or the SGSN; +- to retrieve from the MME or the SGSN the Local Time Zone of the location in the visited network where the UE is attached; +- to update the STN-SR (e.g., as a result of an Sh interaction with an SCC-AS). +- to update the MME/SGSN with the identity of a dynamically allocated PDN GW as a result of the first PDN connection establishment associated with an APN over non 3GPP access or 5GS.. +- to update the MME with the identity of a PDN GW for Emergency Services as a result of the PDN connection establishment for Emergency Services over non 3GPP access. +- to indicate to the MME that the HSS has deregistered the MME for SMS. +- to indicate to the MME/SGSN that the HSS-based P-CSCF restoration procedure, as described in 3GPP TS 23.380 [51] clause 5.4, shall be executed. +- to request the MME or the SGSN to configure and report the detection of Monitoring events, or delete stored Monitoring events configuration. + +- to update the MME with the O&M configured desired Active Time for power saving mode (PSM), or with the value received from the SCEF if Active Time is provided as part of the Suggested-Network-Configuration AVP. +- to update the MME with the O&M configured desired Core Network Restrictions to restrict/allow mobility to 5GC. + +If the HSS knows that the UE has attached to the MME and SGSN parts of the same combined MME/SGSN via both the E-UTRAN and UTRAN/GERAN (refer to clause 5.2.1.1.2, 5.2.1.1.3 for further details), the HSS should invoke this procedure for a single time to update and/or request certain user data in the combined MME/SGSN, i.e. the HSS should not invoke this procedure for each of the MME and the SGSN registered respectively. + +If the Node-Type-Indicator information has been previously received as cleared in the ULR-Flags and if the MME has not been registered for SMS during update location procedure for the MME, the HSS may skip any change of the SMS related subscription data and consequently does not have to make use of the Insert Subscriber Data procedure to update the SMS subscription data in the MME. + +This procedure is mapped to the commands Insert Subscriber Data-Request/Answer (IDR/IDA) in the Diameter application specified in clause 7. + +Table 5.2.2.1.1/1 specifies the involved information elements for the request. + +Table 5.2.2.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.2.1.1/1: Insert Subscriber Data Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Subscription Data
(See 7.3.2) | Subscription-Data | M | This Information Element shall contain the part of the subscription profile that either is to be added to the subscription profile stored in the MME or SGSN or is replacing a part of the subscription profile stored in the MME or SGSN. | +| IDR Flags
(See 7.3.103) | IDR-Flags | C | This Information Element shall contain a bit mask. See 7.3.103 for the meaning of the bits. | +| Reset-IDs
(See 7.3.184) | Reset-ID | O | The Reset-ID uniquely identifies a fallible resource in the HSS on which the user (IMSI) depends. In the event of a restart of the fallible resource a Reset message containing the Reset-ID will exactly identify the impacted subscribers. | + +**Table 5.2.2.1.1/2: Insert Subscriber Data Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host.
A combined MME/SGSN that makes use of separate origin host values in Update Location Request messages sent on S6a and Update Location Request messages sent on S6d can detect whether the IDR from HSS was sent to the MME or to the SGSN.
IDA sent from such combined MME/SGSN corresponds to the MME's or the SGSN's supported features respectively.
A combined MME/SGSN that makes use of a common origin host value in Update Location Request messages sent on S6a and Update Location Request messages sent on S6d cannot detect whether the IDR from HSS was sent to the MME or to the SGSN.
IDA sent from such combined MME/SGSN uses the union of the MME's and the SGSN's supported features. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
Result-Code AVP shall be used to indicate success / errors defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown | +| IMS Voice over PS Sessions Supported
(See 7.3.106) | IMS-Voice-Over-PS-Sessions-Supported | C | If available to the serving node, this information element shall indicate whether or not "IMS Voice over PS Sessions" is supported by the UE's most recently used TA or RA in the serving node (MME or SGSN or combined MME/SGSN). If the UE is in detached state, this information element shall not be included in the response. | +| Last UE Activity Time
(See 7.3.108) | Last-UE-Activity-Time | C | If available to the serving node, this information element shall contain the time of the last radio contact with the UE. If the UE is in detached state, this information element shall not be included in the response. | +| RAT Type
(See 7.3.13) | RAT-Type | C | If available to the serving node, this information element shall indicate the RAT Type of the access where the UE was present at the time of the last radio contact. If the UE is in detached state, this information element shall not be included in the response. | +| IDA-Flags
(See 7.3.47) | IDA-Flags | C | This Information Element shall contain a bit mask. See 7.3.47 for the meaning of the bits. | +| EPS-User-State
(See 7.3.110) | EPS-User-State | C | This Information Element shall contain the EPS-User State. It shall be present if EPS user state was requested within IDR. | +| EPS-Location-Information
(See 7.3.111) | EPS-Location-Information | C | This Information Element shall contain the EPS-Location Information. It shall be present if EPS location information was requested within IDR. | +| Local Time Zone
(See 7.3.156) | Local-Time-Zone | C | This Information Element shall contain information on the Local Time Zone of the location in the visited network where the UE is attached. It shall be present if the Local Time Zone was requested within IDR. | +| Monitoring Event Report | Monitoring-Event-Report | C | This Information Element shall contain the report of Monitoring event. It shall be present if Monitoring event configuration is included within IDR and any of the requested Monitoring events are available to be reported. (see NOTE 1) | +| Monitoring Event Config Status | Monitoring-Event-Config-Status | C | This Information Element shall be present if Monitoring event configuration is included in IDR. It shall contain all the configuration status for each Monitoring event that was requested. | +| Supported Services
(3GPP TS 29.336 [54]) | Supported-Services | O | If present, this Information Element shall contain AVPs indicating details of the services supported by the MME/SGSN. | +| NOTE 1: In IWK-SCEF scenarios, an event is available to be reported by the visited MME only if the event is considered as authorized by the visited MME after checking with the IWK-SCEF. Otherwise, the immediate report shall be not be sent in this command (S6a/IDA), and it shall be sent over T6a using RIR command (see 3GPP TS 29.128 [63]). | | | | + +#### 5.2.2.1.2 Detailed behaviour of the MME and the SGSN + +When receiving an Insert Subscriber Data request the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If it is known, the MME or SGSN shall replace the specific part of the stored subscription data with the received data, or shall add the received data to the stored data. + +When receiving the APN-Configuration-Profile AVP within the Subscription-Data AVP, the MME or SGSN shall check the All-APN-Configurations-Included-Indicator value. If it indicates "All\_APN\_CONFIGURATIONS\_INCLUDED", the MME or SGSN shall delete all stored APN-Configurations and then store all received APN-Configurations. Otherwise, the MME or SGSN shall check the Context-Identifier value of each received APN-Configuration. If the Context-Identifier of a received APN-Configuration matches a Context-Identifier of a stored APN-Configuration, the MME or SGSN shall replace the stored APN-Configuration with the received APN-Configuration. If the Context-Identifier of a received APN-Configuration does not match a Context-Identifier of a stored APN-Configuration, the MME or SGSN shall add the received APN-Configuration to the stored APN-Configurations. If the addition or update of the subscription data succeeds in the MME or SGSN, the Result-Code shall be set to DIAMETER\_SUCCESS. The MME or SGSN shall then acknowledge the Insert Subscriber Data message by returning an Insert Subscriber Data Answer. + +For each of the received APN-Configurations in the APN-Configuration-Profile, if both the MIP6-Agent-Info and the PDN-GW-Allocation-Type AVPs are absent in the APN-Configuration AVP, the MME or SGSN shall perform the PGW selection (static or dynamic) according to the local configuration. If MIP6-Agent-Info is present, and PDN-GW-Allocation-Type is not present, this means that the PDN GW address included in MIP6-Agent-Info has been statically allocated. + +If the MME/SGSN supports interworking with Gn/Gp-SGSNs, it shall ensure that the context identifier sent over GTPv1 for each of the received APN-Configurations is within the range of 1 and 255. + +NOTE 1: If the MME/SGSN receives from HSS a Context-Identifier value higher than 255, how this value is mapped to a value between 1 and 255 is implementation specific. + +If the MME is requested to notify the HSS when the UE becomes reachable, the MME shall set the URRP-MME parameter to indicate the need to inform the HSS about UE reachability, e.g. when the next NAS activity from the UE is detected. If the SGSN is requested to notify the HSS when the UE becomes reachable, the SGSN shall set the URRP-SGSN parameter to indicate the need to inform the HSS about UE reachability, e.g. when the next NAS activity from the UE is detected. + +When receiving GPRS-Subscription-Data AVP within the Subscription-Data AVP, the SGSN or combined MME/SGSN shall check the Complete-Data-List-Included-Indicator value. If it indicates "All\_PDP\_CONTEXTS\_INCLUDED", the SGSN or combined MME/SGSN shall delete all stored PDP-Contexts and then store all received PDP-Contexts. Otherwise, the SGSN or combined MME/SGSN shall check the Context-Identifier value of each received PDP-Context. If the Context-Identifier of a received PDP-Context matches a Context-Identifier of a stored PDP-Context, the SGSN or combined MME/SGSN shall replace the stored PDP-Context with the received PDP-Context. If the Context-Identifier of a received PDP-Context does not match a Context-Identifier of a stored PDP-Context, the SGSN or combined MME/SGSN shall add the received PDP-Context to the stored PDP-Contexts. + +If the MME or SGSN receives an empty Subscription-Data AVP, it shall take no action with regard to the stored subscription data. + +When receiving HPLMN-ODB AVP within the Subscription-Data AVP, the MME or SGSN shall replace stored HPLMN-ODB data (if any) with the received information rather than add the received information to the stored information. Unsupported Barring categories need not be stored. + +When receiving Operator-Determined-Barring AVP within the Subscription-Data AVP, the MME or SGSN shall replace stored ODB subscription information (if any) with the received information rather than add the received information to the stored information. Unsupported Barring categories need not be stored. + +When receiving Access-Restriction-Data or Adjacent-Access-Restriction-Data AVPs within the Subscription-Data AVP, the MME or SGSN shall replace the corresponding stored information (if any) with the new received information, rather than adding received information to stored information. The handling of access restrictions per-PLMN is defined in 3GPP TS 23.221 [53], clause 6.3.5a and in 3GPP TS 23.401 [2] clause 4.3.28. + +When receiving APN-OI-Replacement AVP within the Subscription-Data AVP, the MME or SGSN shall replace the stored information (if any) with the received information. + +When receiving Regional-Subscription-Zone-Code AVP within the Subscription-Data AVP, the MME or SGSN shall replace stored Zone Codes (if any) with the received information rather than add the received information to the stored information. MMEs and SGSNs that do not support regional subscription need not store zone codes. If due to regional subscription restrictions or access restrictions the entire SGSN area is restricted, SGSN shall report it to the HSS by returning the "SGSN Area Restricted" indication within the IDA flags. + +When receiving CSG-Subscription-Data AVPs within the Subscription-Data AVP the MME or SGSN shall replace all stored information from previously received CSG-Subscription-Data AVPs (if any) with the received information rather than add the received information to the stored information. + +When receiving Teleservice-List AVP, Call-Barring-Info, or LCS-Info AVP, the MME or SGSN shall replace stored information (if any) with the received information rather than add the received information to the stored information. + +When receiving ProSe-Subscription-Data AVP, the MME or combined MME/SGSN shall replace stored information (if any) with the received information rather than add the received information to the stored information. + +When receiving and supporting Reset-ID AVPs within the request, the MME or SGSN shall replace stored information (if any) with received information rather than add received information to stored information. + +When receiving the IDR-Flags with the "T-ADS Data Request" bit set, and the UE is in attached state, the MME or SGSN or combined MME/SGSN shall return in the IDA message the time stamp of the UE's most recent radio contact and the associated RAT Type, and an indication of whether or not IMS Voice over PS is supported in the current (and most recently used) TA or RA. If the UE is in detached state, the MME or SGSN or combined MME/SGSN shall answer successfully to the T-ADS request from HSS, but it shall not include any of the T-ADS IEs in the response (IMS Voice over PS Sessions Supported, RAT Type and Last UE Activity Time). + +When receiving the IDR-Flags with the "EPS User State Request" bit and/or "EPS Location Information Request" bits set the MME or SGSN shall return the corresponding user information to the HSS. If the serving node is a combined MME/SGSN, and the UE is attached via both E-UTRAN and UTRAN/GERAN on the same node, the combined MME/SGSN shall provide the corresponding user information relevant for both MME and SGSN. If the Current Location Request bit was also set and the UE is in idle mode and is expected to be reachable even when it uses a power saving feature (e.g. extended idle mode DRX or PSM as defined in 3GPP TS 23.685 [55]), then the MME or SGSN or combined MME/SGSN shall page the UE in order to return the most up-to-date corresponding user information. If the Current Location Request bit was also set and either paging is unsuccessful or the UE is not expected to be reachable, then the last known location of the UE shall be returned to the HSS. If the Current Location Request bit was also set and the UE (attached via E-UTRAN) is in connected mode, then the MME or combined MME/SGSN shall use SIAP Location Reporting Control procedure towards the eNB prior to reporting the E-UTRAN Cell Global Identification in order to return the UE's most up-to-date cell information. When the location is returned to the HSS, the MME or the combined MME/SGSN shall provide the age of location information if stored in the MME or the combined MME/SGSN or received from eNB. + +When receiving the IDR-Flags with only the "Current Location Request" bit set (i.e. the "EPS Location Information Request" bit is not set), the MME or SGSN or combined MME/SGSN shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the "Local Time Zone Request" bit was set the MME or SGSN if supported shall provide the Local Time Zone corresponding to the location (e.g. TAI or RAI) of the UE to the HSS. + +If the MME or SGSN cannot fulfil the received request, e.g. due to a database error or any of the required actions cannot be performed, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. If subscription data are received, the MME or SGSN shall mark the subscription record "Subscriber to be restored in HSS". + +If trace data are received in the subscriber data, the MME or SGSN shall start a Trace Session. For details, see 3GPP TS 32.422 [23]. + +If the Ext-PDP-Type AVP is present in the PDP-Context AVP, the SGSN or combined MME/SGSN shall ignore the value of the PDP-Type AVP. + +When receiving the IDR-Flags with the bit "Remove SMS Registration" set, the MME shall consider itself unregistered for SMS. + +If the subscription data received for a certain APN includes WLAN-offloadability AVP, then the MME or SGSN shall determine the offloadability of the UE's PDN Connection(s) to that APN based on subscription data and locally configured policy (e.g. for roaming users or when the subscription data does not include any offloadability indication). + +NOTE 2: As indicated in clause 7.3.31, if the UE-level access restriction "HO-To-Non-3GPP-Access Not Allowed" is set, the offload of PDN Connections to WLAN is not allowed for any APN. + +When receiving the IDR-Flags with the "P-CSCF Restoration Request" bit set, the MME or SGSN or combined MME/SGSN shall execute the procedures for HSS-based P-CSCF Restoration, as described in 3GPP TS 23.380 [51] clause 5.4. + +If the subscription data received for the user includes the DL-Buffering-Suggested-Packet-Count AVP, then the MME or SGSN should take into account the subscription data, in addition to local policies, to determine whether to invoke extended buffering of downlink packets at the SGW for High Latency Communication. Otherwise, the MME or SGSN shall make this determination based on local policies only. + +When receiving IMSI-Group-Id AVP(s) within the Subscription-Data AVP, the MME or SGSN shall replace stored IMSI-Group Ids (if any) with the received information rather than add the received information to the stored information. + +In the present clause, if the feature "Extended Reference IDs" (see clause 7.3.10) is supported by the HSS and the MME/SGSN, the term "SCEF Reference ID" shall refer to the content of the 64-bit long "SCEF-Reference-ID-Ext" AVP, and the term "SCEF Reference ID for Deletion" shall refer to the content of the 64-bit long "SCEF-Reference-ID-for-Deletion-Ext" AVP. + +When receiving a Monitoring-Event-Configuration in the IDR: + +- if the SCEF Reference ID for Deletion is present in the IDR, the MME or SGSN shall stop the detection of the Monitoring event related to the SCEF Reference ID for Deletion and SCEF-ID pair, and shall delete the corresponding Monitoring event configuration data; +- if the SCEF Reference ID is present in the IDR but not stored in the MME or SGSN, the MME or SGSN shall store the received Monitoring event configuration data related to the SCEF Reference ID and SCEF-ID pair, and shall start the detection for the specified Monitoring event(s). +- if the SCEF Reference ID is present in the IDR and stored in the MME or SGSN, the MME or SGSN shall replace the stored Monitoring event configuration data related to the SCEF Reference ID and SCEF-ID pair with the received information. + +NOTE 3: In roaming scenarios the MME/SGSN can reply immediately to the HSS without waiting for the outcome of the interaction with the IWK-SCEF. + +For the monitoring event configurations for which the configuration status have changed since the last status informed to the HSS, the MME/SGSN shall notify the HSS about the outcome of the interaction with the IWK-SCEF as specified in clause 5.2.5.1.2. + +If the HSS indicates the support of Monitoring event feature to the MME/SGSN and the MME/SGSN supports Monitoring, the MME/SGSN shall include the Supported-Services AVP with Supported-Monitoring-Event included in the IDA command. + +When receiving the Maximum-Response-Time in Monitoring-Event-Configuration in IDR, the MME shall use the Maximum-Response-Time as the Active Time for the usage of PSM in UE. If not, when the MME receives the Active-Time in subscription data, the MME shall use the Active-Time as the Active Time for the usage of PSM in UE. + +When receiving AESE-Communication-Pattern AVP(s) within the Subscription-Data AVP with an SCEF Reference ID for which the MME has already stored data, it shall delete the stored data (CP set(s)) and store the received ones. + +When receiving AESE-Communication-Pattern AVP(s) within the Subscription-Data AVP with one or more SCEF Reference ID for deletion the MME shall delete the data related to the indicated SCEF Reference ID. + +If the MME and the UE support an Attach without PDN connection (i.e. EMM-REGISTERED without PDN connection) and the PDN-Connection-Restricted flag is set in the received Subscription-Data-Flags AVP, the MME shall not establish any non-emergency PDN connection and shall tear down any existing non-emergency PDN connection for this user. + +If the subscription data received for the user includes the Preferred-Data-Mode AVP, for an IP APN configuration or for a non-IP APN configuration with SGi based delivery, then the MME should (if the subscriber is not roaming) or may (if the subscriber is roaming) take into account the subscription data, in addition to local policies and the UE's Preferred Network Behaviour, to determine whether to transmit the traffic associated with this APN over the User Plane and/or over the Control Plane. Otherwise, the MME shall make this determination based on local policies and the UE's Preferred Network Behaviour only. + +If the MME subscription data received for the user includes the Emergency-Info AVP, the MME shall use the PDN-GW identity contained in such AVP as the PDN-GW used to establish emergency PDN connections with the emergency APN, for non-roaming authenticated UEs requesting the handover of an emergency PDN connection if the MME is configured to use a dynamic PDN-GW for emergency services for such user. + +When receiving V2X-Subscription-Data in the IDR, the MME shall determine whether the UE is authorized to use V2X communication over PC5 according to V2X subscription data and UE provided network capability. If the UE is authorized to use V2X communication over PC5, the MME shall store the "V2X service authorized" indication together with the UE AMBR used for PC5 interface (i.e. UE-PC5-AMBR), and provide such information to the eNodeB when needed. + +If the MME/SGSN receives from the HSS an Insert Subscriber Data request without the bit set for "NR as Secondary RAT" in the Feature-List AVP, the MME/SGSN, based on local policy, may restrict access for NR as secondary RAT when all relevant entities except HSS supports it. + +If the MME receives from the HSS Insert Subscriber Data request containing in the subscription data the Core-Network-Restrictions AVP with the bit "5GC not allowed" set, the MME shall restrict mobility towards 5GC. + +When receiving Paging-Time-Window AVPs within the Subscription-Data AVP, the MME or SGSN shall replace stored information (if any) with the received information rather than add the received information to the stored information. + +#### 5.2.2.1.3 Detailed behaviour of HSS + +The HSS shall make use of this procedure to replace a specific part of the user data stored in the MME or SGSN with the data sent, or to add a specific part of user data to the data stored in the MME or SGSN. The HSS shall also make use of this procedure to indicate to the MME that it is no longer registered for SMS. + +NOTE: When a Cancel Location message is required for other reasons, the use of IDR to indicate that the MME is no longer registered for SMS is not needed (see clause 5.2.1.2). + +Subscriber-Status AVP shall be present in the Subscription-Data AVP, sent within IDR, if the current value in the MME or SGSN needs to be changed. To remove all Operator Determined Barring Categories the Subscriber-Status shall be set to "SERVICE\_GRANTED". If Subscriber-Status AVP is present and set to OPERATOR\_DETERMINED\_BARRING, the Operator-Determined-Barring AVP or HPLMN-ODB AVP shall also be present in the Subscription-Data AVP. + +Access-Restriction-Data AVP shall be present within the Subscription-Data AVP sent within an IDR if the information stored in the MME or SGSN needs to be modified. + +APN-OI-Replacement AVP shall be present in the Subscription-Data AVP sent within an IDR, if the UE level APN-OI-Replacement has been added or modified in the HSS. + +The APN-Configuration-Profile AVP shall be present in the Subscription-Data AVP sent within an IDR if the Context-Identifier associated with the default APN configuration is changed or at least one APN-Configuration is added or modified by the HSS. If the default APN is changed in the HSS, the APN-Configuration-Profile AVP shall contain the Context-Identifier associated with the default APN and the APN-Configuration AVP for the default APN. The default APN Configuration shall not contain the Wildcard APN (see 3GPP TS 23.003 [3], clause 9.2); the default APN shall always contain an explicit APN. + +The EPS-Subscribed-QoS-Profile AVP and the AMBR AVP shall be present in the APN-Configuration AVP when the APN-Configuration AVP is sent in the APN-Configuration-Profile AVP and when the APN-Configuration-Profile AVP is sent within an IDR (as part of the Subscription-Data AVP). + +If the GPRS-Subscription-Data-Indicator information has been previously received as set in the ULR-Flags during update location procedure for the SGSN or combined MME/SGSN, the HSS shall make use of this procedure to replace + +the GPRS Subscription Data stored in the SGSN or combined MME/SGSN with the data sent or to add a PDP-Context to the data stored in the SGSN or combined MME/SGSN. + +ProSe-Subscription-Data AVP shall be present in the Subscription-Data AVP sent within an IDR, if the ProSe Subscription data has been added or modified in the HSS. + +If the HSS receives a message (e.g. via MAP ATM or Sh Sh-Subs-Notif) from a Service Related Entity (e.g. IP-SM-GW) indicating that the UE is unreachable, + +- the HSS shall associate the subscription to UE reachability of the service-related entity to the URRP-MME and the URRP-SGSN parameters (if not already done) +- and if the URRP-MME and/or the URRP-SGSN parameters were not already set (i.e. at least one service-related entity already listed as subscribed), the HSS shall + - set the URRP-MME and/or URRP-SGSN parameters and + - send an IDR command to the registered MME and/or to the registered SGSN including the "UE Reachability Request flag" in the IDR Request Flags in order to request the MME and/or SGSN to notify the HSS when the UE becomes reachable again, unless the HSS knows from the previous ULR command that the registered MME and/or the registered SGSN do not support UE reachability notifications. + +If the IDR is sent for the only purpose to request the MME and/or SGSN about the UE reachability status notification, the Subscription-Data AVP shall be included empty. + +If the HSS has received a message from a service related entity requesting EPS User State and/or EPS Location Information without the Serving Node Indication IE, the HSS shall set the "EPS User State Request" bit and/or "EPS Location Information Request" bit respectively in the IDR-Flags. The HSS may optionally also set the "Current Location Request" bit along with the "EPS Location Information Request" bit in the IDR-Flags, if the most up-to-date set of information is needed, unless the HSS knows from the previous ULR command that the registered MME and/or the registered SGSN do not support State/Location Information retrieval. If the IDR is sent only for the purpose of requesting the MME or the SGSN User State or Location Information, the Subscription-Data AVP included shall be empty. + +If the HSS cannot request EPS Location Information from the MME/SGSN e.g. because the UE is purged from the MME/SGSN, the HSS may make use of stored EPS Location information received in a previous IDA or PUR message. + +If the HSS has received a message from an AS requesting the current access network's support status of "IMS Voice over PS Sessions", and there is no indication about homogeneous support of IMS Voice over PS Sessions in all the serving nodes currently registered in HSS for the UE, the HSS shall set the "T-ADS Data Request flag" in the IDR Request Flags, unless the HSS knows from the previous ULR command that the registered MME and/or the registered SGSN do not support T-ADS data retrieval. If the IDR is sent for the only purpose to retrieve the "IMS Voice over PS Sessions Supported" indication from the MME or SGSN, the Subscription-Data AVP included shall be empty. + +If the HSS has received a message from an AS requesting the Local Time Zone, the HSS shall set the " Local Time Zone Request" bit in the IDR-Flags, unless the HSS knows from the previous ULR command that the registered MME and/or the registered SGSN do not support Local Time Zone retrieval. If the IDR is sent only for the purpose of requesting the Local Time Zone, the Subscription-Data AVP included shall be empty. + +If the HSS received an indication in a former ULR command from the MME or SGSN about homogeneous support of IMS Voice over PS Sessions in all TA/RAs associated to that serving node, it may use this information to skip the retrieval of T-ADS data. This can only be done if all the registered serving nodes in HSS for the UE indicated in ULR the same type of homogeneous support (i.e. both serving nodes indicated "SUPPORTED", or both serving nodes indicated "NOT\_SUPPORTED"); otherwise, the retrieval of T-ADS data shall be done, to receive the time of the last radio contact with the UE. + +All APN and PGW-ID pairs stored in the HSS not associated with an explicit APN subscription, (i.e. the access to that APN has been authorized as a consequence of having the Wildcard APN in the user subscription), shall be included by the HSS inside the APN context of the Wildcard APN, as multiple instances of the Specific-APN-Info AVP. + +When receiving an Insert Subscriber Data answer with "SGSN Area Restricted" the HSS shall set the SGSN area restricted flag as "SGSN area restricted". + +Subscribed-VSRVCC AVP may be present within the Subscription-Data AVP sent within an ISR only if the user is subscribed to the SRVCC and vSRVCC. + +If the HSS determines that the MME shall be unregistered for SMS it shall set the "Remove SMS Registration" bit in the IDR-Flags. If the IDR is sent for the only purpose to indicate that the MME is no longer registered for SMS, the Subscription-Data AVP shall be included empty. + +If the HSS needs to request to the MME/SGSN the execution of the HSS-based P-CSCF restoration procedure, as described in 3GPP TS 23.380 [51] clause 5.4, the HSS shall set the "P-CSCF Restoration Request" bit in the IDR-Flags, if supported by the MME/SGSN. If the IDR is sent only for the purpose of requesting the execution of the HSS-based P-CSCF restoration procedures, the Subscription-Data AVP included shall be empty. + +If the HSS receives a SCEF request to configure Monitoring events for the UE to be handled by the MME/SGSN or receives a SCEF request for deleting Monitoring events for the UE in the MME/SGSN, the HSS shall include Monitoring-Event-Configuration AVP(s) in the Subscription-Data AVP sent within the IDR. If the HSS has registered both an MME and an SGSN as serving nodes for a given user, and both nodes are not part of a same combined MME/SGSN node, the HSS shall send the Monitoring-Event-Configuration AVP(s) to each one of the serving nodes that supports the Monitoring event service. If the HSS receives the IDA with Monitoring-Event-Report AVP(s), the HSS shall forward the Monitoring-Event-Report AVP(s) to the SCEF associated to those Monitoring events. + +If the HSS does not receive a SCEF request to configure Monitoring events for the UE to be handled by the MME/SGSN and does not receive an Active Time with the Suggested-Network-Configuration AVP, the HSS may send an O&M configured desired Active Time value within the Active-Time AVP. + +If the HSS receives a Supported-Services AVP it shall only trigger those services which are supported by the MME/SGSN. + +If the HSS has previously received over SWx (see 3GPP TS 29.273 [59]) the identity of the PDN-GW to be used for the establishment of emergency PDN connections, it shall send it to the registered MME (if any) in the IDR command as part of the Subscription-Data AVP (in the Emergency-Info AVP). + +If V2X subscription data has been added or modified in the HSS, the HSS shall include the V2X-Subscription-Data AVP in the Subscription-Data AVP sent within an IDR. + +If the External-Identifier associated with Monitoring Event Configuration for the UE has been added or modified in the HSS and the MME/SGSN supports the "External-Identifier" feature, the HSS shall include the External-Identifier AVP in the Subscription-Data AVP. When multiple External Identifiers are defined for a same subscription, the HSS shall send a default External Identifier in the External-Identifier AVP of the Subscription-Data AVP, and shall include a specific External Identifier (if different from the default External Identifier) associated to each Monitoring Event Configuration in the External-Identifier AVP of each Monitoring-Event-Configuration AVP occurrence inside the Subscription-Data AVP. + +The Aerial-UE-Subscription-Information AVP may be present within the Subscription-Data AVP sent within an IDR only if the user has Aerial UE subscription information. + +If Core Network Restrictions in subscription data (5GC allowed/not allowed) has been added or modified in the HSS, the HSS shall include the Core-Network-Restrictions AVP in the Subscription-Data AVP sent within an IDR. + +## 5.2.2.2 Delete Subscriber Data + +### 5.2.2.2.1 General + +This procedure shall be used between the MME and the HSS and between the SGSN and the HSS, to remove some data of the HSS user profile stored in the MME or SGSN. The procedure shall be invoked by the HSS and it corresponds to the functional level operation Delete Subscriber Data (see 3GPP TS 23.401 [2]). + +It shall be used to remove: + +- a subset (which may or may not be the complete set of APN configurations) of the APN Configuration Profile for the subscriber from the SGSN or combined MME/SGSN; +- a proper subset (i.e. a subset that is not equal to the complete set of APN configurations and does not contain the default APN configuration) of the APN Configuration Profile for the subscriber from the MME; +- the regional subscription; +- the subscribed charging characteristics; + +- Session Transfer Number for SRVCC; +- trace data; +- ProSe subscription data; +- Reset-IDs; +- MSISDN; +- UE Usage Type; +- V2X subscription data. +- External Identifier(s). + +If the HSS knows that the UE has attached to the MME and SGSN parts of the same combined MME/SGSN via both E-UTRAN and UTRAN/GERAN(refer to clause 5.2.1.1.2, 5.2.1.1.3 for further details), the HSS should invoke this procedure for a single time to remove some or all data of the HSS user profile stored in the combined MME/SGSN, i.e. not invoke this procedure for each of the MME and the SGSN registered respectively. + +If the Node-Type-Indicator information has been previously received as cleared in the ULR-Flags and if the MME has not been registered for SMS during update location procedure for the MME, the HSS may skip any removal of the SMS related subscription data and consequently does not have to make use of the Delete Subscriber Data procedure to update the SMS subscription data in the MME. + +This procedure is mapped to the commands Delete-Subscriber-Data-Request/Answer (DSR/DSA) in the Diameter application specified in clause 7. + +Table 5.2.2.2.1/1 specifies the involved information elements for the request. + +Table 5.2.2.2.1/2 specifies the involved information elements for the answer. + +**Table 5.2.2.2.1/1: Delete Subscriber Data Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| DSR Flags
(See 7.3.25) | DSR-Flags | M | This Information Element shall contain a bit mask. See 7.3.25 for the meaning of the bits. | +| Trace Reference
(See 7.3.64) | Trace-Reference | C | This parameter shall contain the same value as used for the activation of the Trace Session.
This element shall be present only if the "Trace Data Withdrawal" bit is set in the DSR-Flags. | +| Context Identifier
(See 7.3.27) | Context-Identifier | C | This parameter shall identify the PDN subscription context or GPRS-PDP context that shall be deleted.
This element shall be present only if the "PDN subscription contexts Withdrawal" bit or the "PDP context withdrawal" bit is set in the DSR-Flags. In the "PDN subscription contexts Withdrawal" case, the Context-Identifier shall not be associated with the default APN configuration. For the compatibility with the MAP protocol as defined in the 3GPP TS 29.002 [24], this parameter shall not have a value of zero. | +| TS Code List
(See 7.3.100) | TS-Code | C | This parameter shall contain the teleservice codes that are to be deleted from the subscription.
This element shall be present only if the "SMS Withdrawal" bit is set in the DSR-Flags and the SMS related teleservice codes are to be deleted. | +| SS Code List
(See 7.3.87) | SS-Code | C | This parameter shall contain the supplementary service codes that are to be deleted from the subscription.
This element shall be present only if the "SMS Withdrawal" bit is set or the "LCS Withdrawal" bit is set in the DSR-Flags. | +| SCEF-Id
(See 3GPP TS 29.336 [54]) | SCEF-ID | C | This parameter shall contain the identity of the SCEF to which monitoring events that are to be deleted are associated.
This element shall be present if the "Delete monitoring events" bit is set in the DSR-Flags. | +| eDRX Related RAT List | eDRX-Related-RAT | C | This parameter shall contain the RAT types for which the eDRX Cycle Lengths is to be deleted from the subscription.
This element shall be present only if the "eDRX-Cycle-Length-Withdrawal" bit is set in the DSR-Flags and the corresponding eDRX Cycle Lengths are to be deleted.
If the "eDRX-Cycle-Length-Withdrawal" bit is set in DSR-Flags, but the eDRX-Related-RAT AVP is absent in this command, the MME/SGSN shall delete the stored eDRX cycle lengths for all RATs. | +| External Identifiers | External-Identifiers | O | If present, this parameter shall contain the External Identifier(s) to be deleted from the subscriber data; the MME/SGSN shall also delete those monitoring events that include an External-Identifier AVP in their event configuration matching any of the External-Identifiers in this IE.

This IE shall be absent if the "External-Identifier-Withdrawal" bit is not set in the DSR-Flags.

If this IE is absent, and "External-Identifier-Withdrawal" bit is set in DSR-Flags, the MME/SGSN shall delete the default External-Identifier in the Subscription-Data AVP and it shall also delete all monitoring events that include an External-Identifier AVP in their event configuration. | + +**Table 5.2.2.2.1/2: Delete Subscriber Data Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown | +| DSA Flags
(See 7.3.26) | DSA-Flags | C | This Information Element shall contain a bit mask. See 7.3.26 for the meaning of the bits. | + +## 5.2.2.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a Delete Subscriber Data request, the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If it is known, but the Context-Identifier is associated with the default APN configuration, the MME shall not delete the PDN subscription context, and return an error with a Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY. + +Otherwise, the MME or SGSN shall delete the corresponding data according to the indication as sent in the request, and acknowledge the Delete Subscriber Data message by returning a Delete Subscriber Data Answer. + +If an MME receives a Delete Subscriber Data Request with the "Complete APN Configuration Profile Withdrawal" bit set in the DSR-Flags AVP, it shall return an error with a Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the deletion of the subscription data succeeds in the MME or SGSN, the Result-Code shall be set to DIAMETER\_SUCCESS. + +If the Regional Subscription is deleted from the subscription data, the SGSN shall check for its routing areas whether they are allowed or not. If the entire SGSN area is restricted, SGSN shall report it to the HSS by returning the "SGSN Area Restricted" indication within the DSA flags. + +If the EPS Subscription Data is deleted from the subscription data, the MME or SGSN shall check whether all EPS Subscription Data for the subscriber is deleted or if only a subset of the stored EPS Subscription Data for the subscriber is deleted, the MME or SGSN may then deactivate the associated affected active EPS bearers. + +If the Subscribed Charging Characteristics are deleted from the subscription data, the Gn/Gp-SGSN shall maintain the existing Subscribed Charging Characteristics throughout the lifetime of the existing MM and PDP contexts, see 3GPP TS 32.251 [33]. + +If the Subscribed Charging Characteristics are deleted from the subscription data, the MME or S4-SGSN shall maintain the existing Subscribed Charging Characteristics throughout the lifetime of the existing IP CAN bearer, see 3GPP TS 32.251 [33]. + +If the MSISDN is deleted from the subscription data, the MME or SGSN shall maintain the existing MSISDN throughout the lifetime of the existing PDN connections that were established prior to the deletion of the MSISDN (i.e., other network nodes, such as PDN-GW, are not informed of such deletion for the existing PDN connections). The MME/SGSN shall also delete those monitoring events related to the deleted MSISDN. + +If the MME or SGSN cannot fulfil the received request for other reasons, e.g. due to a database error, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. In this case, the MME or SGSN shall mark the subscription record "Subscriber to be restored in HSS". + +If trace data are deleted from the subscription data, the MME or SGSN shall deactivate the Trace Session identified by the trace reference. For details, see 3GPP TS 32.422 [23]. + +If External Identifiers are requested to be deleted from the subscription data, the MME/SGSN shall check whether any of the identifiers to be deleted match the default External-Identifier provided by HSS in the Subscription-Data AVP (unless all External Identifiers are requested to be deleted from the subscription); in such case, the MME/SGSN shall reject the request and return an error with a Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY (if default External Identifier is wanted to be deleted, no External Identifier must be provided in the request). The MME/SGSN shall also delete those monitoring events related to the deleted External Identifiers, or all monitoring events associated to any External Identifier if default External Identifier is deleted. + +### 5.2.2.2.3 Detailed behaviour of the HSS + +The HSS shall make use of this procedure to remove deleted subscription data from the MME or SGSN. + +The HSS shall make use of this procedure to remove deleted GPRS Subscription Data from the SGSN or combined MME/SGSN if the GPRS-Subscription-Data-Indicator information has been previously received as set in the ULR-Flags during update location procedure for the MME. + +The HSS shall not set the "Complete APN Configuration Profile Withdrawal" bit in the DSR-Flags AVP when sending a Delete Subscriber Data Request to an MME, since the default APN shall always be present in an MME. + +When receiving a Delete Subscriber Data Answer with "SGSN Area Restricted" the HSS shall set the SGSN area restricted flag as "SGSN area restricted". + +## 5.2.3 Authentication Procedures + +### 5.2.3.1 Authentication Information Retrieval + +#### 5.2.3.1.1 General + +The Authentication Information Retrieval Procedure shall be used by the MME and by the SGSN to request Authentication Information from the HSS. + +This procedure is mapped to the commands Authentication-Information-Request/Answer (AIR/AIA) in the Diameter application specified in clause 7. + +Table 5.2.3.1.1/1 specifies the involved information elements for the request. + +Table 5.2.3.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.3.1.1/1: Authentication Information Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------------------------------------|-------------------------------------------|------|---------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Requested E-UTRAN Authentication Info
(See 7.3.11) | Requested-EUTRAN-Authentication-Info | C | This information element shall contain the information related to authentication requests for E-UTRAN. | +| Requested UTRAN/GERAN Authentication Info
(See 7.3.12) | Requested-UTRAN-GERAN Authentication-Info | C | This information element shall contain the information related to authentication requests for UTRAN or GERAN. | +| Visited PLMN ID
(See 7.3.9) | Visited-PLMN-ID | M | This IE shall contain the MCC and the MNC of the visited PLMN, see 3GPP TS 23.003 [3]. | +| AIR Flags
(See 7.3.201) | AIR-Flags | O | This IE, if present, contains a bit mask. See clause 7.3.201 for the meaning of the different bits. | + +**Table 5.2.3.1.1/2: Authentication Information Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
This IE shall contain the Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown
- Unknown EPS Subscription
- Authentication Data Unavailable | +| Error-Diagnostic | Error-Diagnostic | O | If the Experimental Result indicated "Unknown EPS Subscription", Error Diagnostic may be present to indicate whether or not GPRS subscription data are subscribed (i.e. whether or not Network Access Mode stored in the HSS indicates that only CS service is allowed). | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Authentication Info
(See 7.3.17) | Authentication-Info | C | This IE shall contain the Authentication Vectors. | +| UE Usage Type
(See 7.3.202) | UE-Usage-Type | C | This IE shall be present if the HSS supports the Dedicated Core Networks feature, and the "Send UE Usage Type" flag was set in the AIR-Flags AVP in the AIR command, and this information is available in the user subscription.
If present, this IE shall contain the UE Usage Type of the subscriber (see clause 7.3.202). | + +### 5.2.3.1.2 Detailed behaviour of the MME and the SGSN + +The MME or SGSN shall make use of this procedure in order to retrieve the Authentication Vectors from the HSS. + +If the MME or SGSN supports Emergency services for users in limited service state, and the user's IMSI is not available from the UE, or the user's IMSI is marked as unauthenticated, the MME or SGSN shall not make use of the Authentication Information Retrieval procedure. + +If the request is triggered by a synchronization failure during E-UTRAN authentication, the MME or combined MME/SGSN shall include the Re-Synchronization Information in the Requested-EUTRAN-Authentication-Info AVP in the request. + +If the request is triggered by a synchronization failure during UTRAN or GERAN authentication, the SGSN or combined MME/SGSN shall include the Re-Synchronization Information in the Requested-UTRAN-GERAN-Authentication-Info AVP in the request. + +Re-Synchronization Information shall not be present in both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP. + +A stand alone MME shall include the Requested-EUTRAN-Authentication-Info AVP and shall not include the Requested-UTRAN-GERAN-Authentication-Info AVP in the request. The Immediate-Response-Preferred AVP should be present if a EUTRAN-Vector is needed for immediate use. + +A stand alone SGSN shall not include the Requested-EUTRAN-Authentication-Info AVP and shall include the Requested-UTRAN-GERAN-Authentication-Info AVP in the request. The Immediate-Response-Preferred AVP should be present if a UTRAN/GERAN-Vector is needed for immediate use. + +A combined MME/SGSN may include both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP in the request. If both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP are present in the request, the Immediate-Response-Preferred AVP shall be present if the requested authentication vectors are needed for immediate use. The content of the Immediate-Response-Preferred AVP shall correspond to the access type which the UE is currently to be authenticated. The Immediate-Response-Preferred AVP shall not be present in both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP. The presence of an Immediate-Response-Preferred AVP shall indicate that a vector is needed for immediate use. + +When EUTRAN-AVs and UTRAN-AVs or GERAN-AVs are requested, presence of Immediate-Response-Preferred AVP within the Requested-EUTRAN-Authentication-Info AVP shall indicate that EUTRAN-AVs are requested for immediate use in the MME/SGSN; presence of Immediate-Response-Preferred AVP within the Requested-UTRAN-GERAN-Authentication-Info AVP shall indicate that UTRAN-AVs or GERAN-AVs are requested for immediate use in the MME/SGSN. It may be used by the HSS to determine the number of vectors to be obtained from the AuC and the number of vectors downloaded to the MME or SGSN. + +If the MME or SGSN supports the Dedicated Core Networks functionality, and the MME or SGSN needs to retrieve the UE Usage Type from the HSS, it shall set the "Send UE Usage Type" flag in the AIR-Flags AVP in the AIR command. + +When receiving an Authentication Information response from the HSS, the MME or SGSN shall check the Result Code. If it indicates success and Authentication Information is present in the result, the MME or SGSN shall use the received vectors. For details see 3GPP TS 33.401 [5]. + +If the MME or SGSN supports Emergency services for users in limited service state, the MME or SGSN shall proceed even if the Authentication Information Retrieval procedure has failed. In this case, the MME or SGSN shall mark the user's IMSI as unauthenticated. + +Vectors with lower Item Number should be used before Vectors with higher Item Number are used in the MME or SGSN. For Vectors received within different requests those received by the earlier request should be used before those received by the later request. + +### 5.2.3.1.3 Detailed behaviour of the HSS + +When receiving an Authentication Information request the HSS shall check whether subscription data exists for the IMSI. + +If the HSS determines that there is not any type of subscription for the IMSI (including EPS, GPRS and CS subscription data), a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the Authentication Information Request contains a Requested-EUTRAN-Authentication-Info AVP but no Requested-UTRAN-GERAN-Authentication-Info AVP, and the subscriber has not any APN configuration, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +If the Authentication Information Request contains a Requested-UTRAN-GERAN-Authentication-Info AVP but no Requested-EUTRAN-Authentication-Info AVP, and the subscriber has neither an APN configuration profile nor GPRS subscription data, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +If the Authentication Information Request contains both Requested-EUTRAN-Authentication-Info AVP and Requested-UTRAN-GERAN-Authentication-Info AVP, and the Requested-EUTRAN-Authentication-Info AVP does not contain an Immediate-Response-Preferred AVP, and the subscriber has not any APN configuration, the HSS shall not return E-UTRAN vectors. + +If the Authentication Information Request contains both Requested-EUTRAN-Authentication-Info AVP and Requested-UTRAN-GERAN-Authentication-Info AVP, and the Requested-EUTRAN-Authentication-Info AVP contains an Immediate-Response-Preferred AVP, and the subscriber does not have any APN configuration, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +When sending DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION, an Error Diagnostic information may be added to indicate whether or not GPRS subscription data are subscribed (i.e. whether or not Network Access Mode stored in the HSS indicates that only circuit service is allowed). + +If EUTRAN-Authentication-Info is requested, the HSS shall check if serving nodes within the realm identified by the received Origin-Realm AVP are allowed to request authentication information for use in the serving network identified by the received Visited-PLMN-Id AVP. + +The HSS shall then request the AuC to generate the corresponding requested Authentication Vectors (AVs). Subject to load considerations and/or other implementation specific considerations which may be based on the presence of an Immediate-Response-Preferred AVP, less AVs than the requested number of AVs may be generated. + +If EUTRAN-Authentication-Info is requested, when receiving AVs from the AuC, the HSS shall generate the KASME before sending the response to the MME or combined MME-SGSN. + +If the AuC is unable to calculate any corresponding AVs due to unallowed attachment for the UE, e.g. the UE is attaching via E-UTRAN with a SIM card equipped, the HSS shall return an error DIAMETER\_AUTHORIZATION\_REJECTED, the HSS shall not return any AV to the requesting node in the response. Otherwise, if no corresponding pre-computed AV is available, and the AuC is unable to calculate any corresponding AVs due to unknown failures, such as the internal database error, the result code shall be set to DIAMETER\_AUTHENTICATION\_DATA\_UNAVAILABLE. The MME or the SGSN may request authentication vectors again. + +For details see 3GPP TS 33.401 [5]. KASME generation is not performed before sending the response to the SGSN. + +If the Requested-EUTRAN-Authentication-Info AVP is present in the request, the HSS shall download E-UTRAN authentication vectors to the MME. If the Requested-UTRAN-GERAN-Authentication-Info AVP is present in the request, the HSS shall download UTRAN or GERAN authentication vectors to the SGSN. + +If the Immediate Response Preferred parameter has been received, the HSS may use it together with the number of requested vectors and the number of vectors stored in the HSS that are pre-computed to determine the number of vectors to be obtained from the AuC. The HSS may return less number of vectors than requested to the MME or SGSN. If both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP are in the request, and one of them includes the Immediate Response Preferred parameter, the HSS may omit the vectors request that are not for immediate use. If both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP are in the request, and both of them includes the Immediate Response Preferred parameter, the HSS may return E-UTRAN authentication vectors and UTRAN or GERAN authentication vectors. KASME is always computed for each E-UTRAN vector due to the PLMN-binding before sending the response to the MME independent of the presence of the Immediate Response Preferred parameter. + +If the Re-Synchronization-Info AVP has been received, the HSS shall check the AUTS parameter before sending new authentication vectors to the MME or the SGSN. For details see 3GPP TS 33.102 [18]. If both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP are in the request, + +and both of them include the Re-Synchronization-Info AVP, the HSS shall not check the AUTS parameter and return the result code of DIAMETER\_UNABLE\_TO\_COMPLY. Any authentication vectors shall not be sent by the HSS to the requesting node in the response. + +If more than one EPS or UTRAN or GERAN Vector is to be included within one Authentication-Info AVP, the Item-Number AVP shall be present within each Vector. + +If the HSS supports the Dedicated Core Networks functionality, and the MME or SGSN has set the "Send UE Usage Type" flag in the AIR-Flags AVP in the AIR command: + +- if the UE Usage Type value is available in the subscription data of the user: + - if the Immediate Response Preferred parameter is not present in the Requested-EUTRAN-Authentication-Info nor in the Requested-UTRAN-GERAN-Authentication-Info, the HSS may return no authentication vectors in the response; the HSS shall then return the result code DIAMETER\_SUCCESS and may return the generated AVs (if any) to the MME or SGSN; +- the HSS shall include the UE-Usage-Type AVP in the AIA response command if the result code is DIAMETER\_SUCCESS or DIAMETER\_AUTHENTICATION\_DATA\_UNAVAILABLE. +- if the UE Usage Type value is not available in the subscription data of the user, the HSS shall answer as if the MME/SGSN had not requested the UE Usage Type parameter. + +## 5.2.4 Fault Recovery Procedures + +### 5.2.4.1 Reset + +#### 5.2.4.1.1 General + +The Reset Procedure shall be used by the HSS, after a restart, to indicate to the MME and to the SGSN that a failure has occurred. + +The Reset Procedure may also be used by the HSS as part of operation and maintenance actions e.g. to allow planned HSS outage without service interruption, or to update subscription data shared by multiple subscribers. + +This procedure is mapped to the commands Reset-Request/Answer (RSR/RSA) in the Diameter application specified in clause 7. + +Table 5.2.4.1.1/1 specifies the involved information elements for the request. + +Table 5.2.4.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.4.1.1/1: Reset Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|----------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Id List
(See 7.3.50) | User-Id | O | This IE shall contain a list of User-Ids where a User-Id comprises the leading digits of an IMSI (i.e. MCC, MNC, leading digits of MSIN) and it shall identify the set of subscribers whose IMSIs begin with the User-Id. The HSS may include this information element if the occurred failure is limited to subscribers identified by one or more User-Ids. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Reset-IDs
(See 7.3.184) | Reset-ID | O | If present, this information element identifies the set of impacted subscribers. | +| Subscription Data
(See 7.3.2) | Subscription-Data | O | If the Reset Procedure is used to add/ modify subscription data shared by multiple subscribers, this Information Element shall contain the part of the subscription profile that either is to be added to the subscription profile stored in the MME or SGSN or combined MME/SGSN or is replacing a part of the subscription profiles of the impacted subscribers stored in the MME or SGSN.
Shall be absent if Subscription-Data-Deletion AVP is present.
Shall be absent if Reset-ID AVP is absent | +| Subscription Data Deletion
(See 7.3.208) | Subscription-Data-Deletion | O | If the Reset Procedure is used to delete subscription data shared by multiple subscribers, this Information Element shall contain identifications of the part of the subscription profile that is to be deleted from the subscription profiles of the impacted subscribers stored in the MME or SGSN or combined MME/SGSN.
Shall be absent if Subscription-Data AVP is present.
Shall be absent if Reset-ID AVP is absent | + +**Table 5.2.4.1.1/2: Reset Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
There are no Experimental-Result codes applicable for this command. | + +#### 5.2.4.1.2 Detailed behaviour of the MME and the SGSN + +When receiving a Reset message neither containing Subscription-Data nor Subscription-Data-Deletion the MME or SGSN or combined MME/SGSN shall mark all impacted subscriber records "Location Information Confirmed in HSS " as "Not Confirmed". + +When receiving a Reset message containing Subscription-Data or Subscription-Data-Deletion the MME or SGSN or combined MME/SGSN shall update all impacted subscriber records accordingly, i.e. each impacted subscriber record is updated as if an individual IDR or DSR for that subscriber was received; for details see clauses 5.2.2.1.2 and 5.2.2.2.2. The MME or SGSN or combined MME/SGSN shall not mark successfully updated subscriber records "Location Information Confirmed in HSS " as "Not Confirmed". If an impacted subscriber record cannot be updated for any reason (e.g. the updated data is considered not shareable by the MME or SGSN or combined MME/SGSN, or the update requires an individual acknowledgement to be sent to the HSS), the MME or SGSN or combined MME/SGSN shall mark that record "Location Information Confirmed in HSS " as "Not Confirmed". + +NOTE: Which subscription data are considered by the MME or SGSN or combined MME/SGSN not shareable by multiple subscribers is implementation specific. + +If the update of shared subscription data requires only local updates in the MME or SGSN or combined MME/SGSN (i.e., the update of the profile does not imply to initiate any signalling interaction towards other network nodes), the updates should be performed immediately (e.g. deleting an Operator Determined Barring). + +If the update of shared subscription data implies initiating a signalling interaction towards other nodes (e.g. towards the PGW/PCRF for the change of an APN configuration parameter, such as APN-AMBR), depending on the UE's state the following shall apply: + +- If the UE is in CONNECTED state, the updates shall be performed immediately including signalling towards other nodes. +- If the UE is in IDLE state, the signalling towards other nodes should be deferred to the next authenticated radio contact with that UE. + +NOTE: The rational for the recommendation to defer signalling towards other nodes until the next authenticated radio contact is to consider impacts to the network only when the updates are required, and to spread the signalling towards other nodes over some time, based on user's activity. + +In both cases, to avoid high processing/signalling load resulting from shared subscription data update, processing/signalling actions resulting from data updates in the MME or SGSN or combined MME/SGSN may take a maximum operator configuration-depending time. + +If the Reset-IDs IE is supported and received, the MME or SGSN or combined MME/SGSN shall make use of the Reset-IDs (together with the HSS's realm) in order to determine which subscriber records are impacted (i.e. check whether at least one received Reset-ID is associated with the subscriber); otherwise the MME or SGSN or combined MME/SGSN shall make use of the HSS Identity received in the Origin-Host AVP (by comparing it with the value stored after successful ULA) and may make use of the received User-Id-List (if any) in order to determine which subscriber records are impacted. + +At the next authenticated radio contact with the UE concerned, if the subscriber record "Location Information Confirmed in HSS" is marked as "Not Confirmed", the restoration procedure shall be triggered. + +See also 3GPP TS 29.118 [46] clause 5.9.2. + +#### 5.2.4.1.3 Detailed behaviour of the HSS + +The HSS shall make use of this procedure in order to indicate to all relevant MMEs, SGSN, and combined MME/SGSNs that the HSS has restarted and may have lost the current MME-Identity and SGSN-Identity of some of its subscribers who may be currently roaming in the MME area and/or SGSN area, and that the HSS, therefore, cannot send a Cancel Location messages or Insert Subscriber Data messages when needed. + +The HSS may make use of this procedure in order to indicate to all relevant MMEs, SGSN, and combined MME/SGSNs that the HSS has updated subscription data shared by some of its subscribers who may be currently roaming in the MME area and/or SGSN area. + +If the Reset-ID feature is not supported by the MME/SGSN and HSS, the HSS optionally may include a list of Ids identifying a subset of subscribers served by the HSS, if the occurred failure is limited to those subscribers. + +If the Reset-ID feature is supported by the MME or SGSN, the HSS optionally may include one (or several) Reset-ID AVPs identifying e.g. failed hardware components if the occurred failure is limited to those subscribers associated with e.g. the identified failed hardware components. + +The HSS should invoke this procedure towards a combined MME/SGSN only for a single time even if some of the impacted subscribers are attached to the combined MME/SGSN via UTRAN/GERAN and some of the impacted subscribers are attached to the combined MME/SGSN via E-UTRAN. + +## 5.2.5 Notification Procedures + +### 5.2.5.1 Notification + +#### 5.2.5.1.1 General + +The Notification Procedure shall be used between the MME and the HSS and between the SGSN and the HSS when an inter MME or SGSN location update does not occur but the HSS needs to be notified about + +- an update of terminal information; +- an update of the UE SRVCC capability (only if the MME/SGSN supports SRVCC). + +The Notification Procedure shall also be used between the MME and the HSS and between the SGSN and the HSS if the HSS needs to be notified about: + +- an assignment/change of a dynamically allocated PDN GW for an APN, if such a notification is needed taking into account the access restrictions and the type of PDN; + +NOTE: If the PDN is of type "non-IP", the APN is not accessible via non-3GPP access and therefore the PDN-GW ID does not need to be conveyed across accesses. + +- an assignment/change of a dynamically allocated PDN GW for the establishment of emergency PDN connections, if such notification is needed for a non roaming authenticated user, based on operator policy (e.g. on whether the operator uses static PDN GW or not for emergency services) taking into account the access restrictions and feature support; +- the failed monitoring event configurations at the MME or SGSN (if received in ULA) or the status of the monitoring event configurations at the IWK-SCEF; +- the deletion of a monitoring event configuration in SCEF for a UE (i.e. due to an SCEF restart, see 3GPP TS 23.007 [43]). + +The Notification Procedure shall be used between the MME and the HSS when an inter MME location update does not occur but the HSS needs to be notified about + +- the need to send a Cancel Location to the current SGSN. + +The Notification Procedure shall be used between the MME and the HSS when the "SMS in MME" feature is applied and between the SGSN and the HSS when an earlier short message delivery failed and the HSS needs to be notified about: + +- the UE is reachable or the UE has memory capacity available to receive one or more short messages. + +The Notification Procedure shall be used between the MME and the HSS and between the SGSN and the HSS when the HSS has requested to be notified about: + +- the UE is reachable. + +The Notification Procedure shall be used between the MME and the HSS and between the SGSN and the HSS to notify the HSS about: + +- an update of the Homogeneous Support of IMS Voice Over PS Sessions. + +The Notification Procedure shall be used between the MME and the HSS to notify the HSS about: + +- removal of MME registration for SMS. + +This procedure is mapped to the commands Notify-Request/Answer (NOR/NOA) in the Diameter application specified in clause 7. + +Table 5.2.5.1.1/1 specifies the involved information elements for the request. + +Table 5.2.5.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.5.1.1/1: Notify Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Terminal Information
(See 7.3.3) | Terminal-Information | C | This information element shall contain information about the user's mobile equipment.
When notifying the HSS about any change of Terminal Information, the MME or SGSN shall include the new Terminal Information in the request. Within this Information Element, only the IMEI and the Software-Version AVPs shall be used on the S6a/S6d interface. | +| PDN GW Identity
(See 7.3.45) | MIP6-Agent-Info | C | This IE shall contain the identity of the selected and dynamically allocated PDN GW for an APN. It shall be present if a new PDN-GW has been selected and the subscriber is allowed handover to non 3GPP access or 5GS interworking without N26 interface enabled.
When notifying the HSS about a newly selected PDN GW, the MME or SGSN shall include the PDN-GW-Identity in the request.
For establishment of emergency PDN connections, this IE shall contain the identity of the PDN-GW used to establish those PDN connections. | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE identifies the PLMN in which the PDN GW is located. It shall be present when the PDN GW Identity is present and does not contain an FQDN. | +| Context Identifier
(See 7.3.27) | Context-Identifier | O | This parameter shall identify the APN Configuration with which the selected PDN GW shall be correlated.
It may be present if it is available and the PDN-GW is present and is particular for one specific APN and not common to all the APNs.
For the compatibility with the MAP protocol as defined in the 3GPP TS 29.002 [24], this parameter shall not have a value of zero. | +| APN
(See TS 23.008 [30]) | Service-Selection
(See IETF RFC 5778 [20]) | C | This IE shall contain the APN for the selected and dynamically allocated PDN GW.

For establishment of non-emergency PDN connections, it shall be present if the selected PDN-GW is present and is particular for one specific APN and not common to all the APNs.

For establishment of emergency PDN connections (i.e., the Emergency-Services AVP is present, with the Emergency-Indication flag set), this AVP shall be left absent. | +| Alert Reason
(See 7.3.83) | Alert-Reason | C | This parameter shall indicate if the mobile subscriber is present or the MS has memory available.
It shall be present when notifying the HSS about the presence of the UE or the UE has memory capacity available to receive one or more short messages. | +| UE SRVCC Capability | UE-SRVCC-Capability | C | This information element shall indicate if the UE supports or does not support the SRVCC capability.
If the MME/SGSN supports SRVCC and the UE SRVCC Capability has changed, the MME or SGSN shall include the new UE SRVCC Capability in the request. | +| NOR Flags
(See 7.3.49) | NOR-Flags | C | This Information Element shall contain a bit mask. See 7.3.49 for the meaning of the bits. Absence of this information element shall be interpreted as all bits set to 0.
When notifying the HSS about the need to send cancel location to the current SGSN, the MME shall set the "Single-Registration-Indication" flag in the NOR-Flags.
When notifying the HSS about the "restricted" status of the current SGSN area, the SGSN shall set the "SGSN area restricted" flag in the NOR-Flags.
When notifying the HSS about the reachability of the UE or the UE has memory capacity available to receive one or more short messages, the MME, if the "SMS in MME" feature is applied, or SGSN shall set the "Ready for SM" flag correspondingly in the NOR-Flags. | + +| | | | | +|-----------------------------------------------------------------|----------------------------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | When notifying the HSS that the UE is reachable, the MME or SGSN shall set the "UE Reachable" flag correspondingly in the NOR-Flags.
When notifying the HSS about update of the Homogeneous Support of IMS Voice Over PS Sessions, the MME or the SGSN shall set the "Homogeneous Support of IMS Voice Over PS Sessions" flag and S6a/S6d-Indicator flag for a combined MME/SGSN correspondingly in the NOR-Flags.
When notifying the HSS about removal of MME registration for SMS, the MME shall set the "Removal of MME Registration for SMS" flag correspondingly in the NOR-Flags. | +| Homogeneous Support of IMS Voice Over PS Sessions (See 7.3.107) | Homogeneous -Support-of-IMS-Voice-Over-PS-Sessions | C | This Information Element shall be present if Homogeneous Support of IMS Voice Over PS Sessions is modified to one of the values "SUPPORTED" or "NOT_SUPPORTED".

The value "SUPPORTED" indicates that there is support for "IMS Voice over PS Sessions" in all TAs or RAs.

The value "NOT_SUPPORTED" indicates that there is not support for "IMS Voice over PS Sessions" in any of the TAs or RAs. | +| Maximum UE Availability Time | Maximum-UE-Availability-Time | O | This information element may be included when notifying the HSS that the UE is reachable. When present, it shall indicate the timestamp (in UTC) until which a UE using a power saving mechanism (such as extended idle mode DRX) is expected to be reachable for SM Delivery.
This information may be used by the SMS Center to prioritize the retransmission of Short Message to UEs using a power saving mechanism. | +| Monitoring Event Config Status | Monitoring-Event-Config-Status | C | This information element shall be present if the MME/SGSN sends the Notify Request after receiving the Configuration-Information-Answer from the IWK-SCEF. This information element shall only contain the monitoring event configuration status of those events whose configuration status has changed since the last status informed to the HSS.

This information element shall also be present if any of the monitoring events configurations received in ULA failed and shall only contain the monitoring event configuration status of those events whose detection could not be started at the MME/SGSN.

This information element shall also be present if the MME or SGSN determines that a Monitoring Event Configuration for a UE is to be deleted in the HSS (i.e. SCEF responds to a Monitoring Event Report with DIAMETER_ERROR_SCEF_REFERENCE_ID_UNKNOWN). | +| Emergency Services (See 3GPP TS 29.273 [59]) | Emergency-Services | C | The MME shall include this information element, and set the Emergency-Indication flag, to notify the HSS that a new PDN-GW has been selected for the establishment of an emergency PDN connection, whose identity is conveyed in the "PDN GW Identity" IE. | + +Table 5.2.5.1.1/2: Notify Answer + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 5.2.5.1.2 Detailed behaviour of the MME and the SGSN + +If the MME or SGSN supports Emergency services, the MME or SGSN shall not make use of the Notification procedure for emergency attached unauthenticated UEs; for authenticated UEs, the MME shall make use of the Notification procedure to inform the HSS about the PDN-GW selected to establish emergency PDN connections, if the MME is configured to use a dynamic PGW for emergency services for such UEs. + +The MME or SGSN shall not make use of the Notification procedure to inform the HSS about the identity of the dynamically selected PDN-GW, if the access restrictions indicate that the user is not allowed to get service via non-3GPP access, or the PDN type of the APN is of type "non-IP". + +The MME or SGSN shall include conditional AVPs in NOR according to the description given in table 5.2.5.1.1/1. + +If the MME sends a Notify Request to inform the HSS that the UE has become reachable again, the MME shall clear the corresponding URRP-MME for the UE. + +If the SGSN sends a Notify Request to inform the HSS that the UE has become reachable again, the SGSN shall clear the corresponding URRP-SGSN for the UE. + +If the MME sends a Notify Request to inform the HSS about the presence of the UE to receive one or more short messages, the MME shall clear the corresponding MNRF for the UE. + +If the SGSN sends a Notify Request to inform the HSS about the presence of the UE to receive one or more short messages, the SGSN shall clear the corresponding MNRG for the UE. + +If the MME or SGSN determines that it needs to update the Homogeneous Support of IMS Voice Over PS Sessions in the HSS, the MME or SGSN shall send a Notify Request with the "Homogeneous Support of IMS Voice Over PS Sessions" bit set in the NOR-Flags AVP; if there is homogeneous support, or homogeneous non-support, of IMS Voice Over PS Sessions, the MME or SGSN shall report it by including the updated Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions AVP; if the support is not homogeneous, the MME or SGSN shall report it by leaving such AVP absent in the Notify Request to the HSS. MME or SGSN shall ensure the status of Homogeneous Support of IMS Voice Sessions in HSS does not contradict with the value of "IMS voice over PS session indicator" provided to UE over NAS as specified in 3GPP TS 24.008 [31] and 3GPP TS 24.301 [64]; + +if "IMS voice over PS session indicator" sent to UE has changed from "not supported" to "supported" when status Homogenous Support of IMS Voice in HSS is "not supported", MME or SGSN shall immediately send Notify Request indicating as either homogenous support or not homogeneous; + +if "IMS voice over PS session indicator" sent to UE has changed from "supported" to "not supported" when status Homogenous Support of IMS Voice in HSS is "supported", MME or SGSN shall immediately send Notify Request indicating as either homogenous non-support or not homogeneous. + +If the MME needs to indicate to the HSS that it is no longer registered for SMS in the HSS, the MME shall send a Notify Request with "Removal of MME Registration for SMS" flag set in the NOR-Flags AVP. + +When receiving a Notify response from the HSS, if the result code indicates + +DIAMETER\_ERROR\_UNKNOWN\_SERVING\_NODE, the MME or SGSN shall consider the Notification procedure as failed, and it shall mark the subscriber record as "Subscriber to be restored in HSS". + +When receiving a Notify response from the HSS, if the result code indicates + +DIAMETER\_ERROR\_USER\_UNKNOWN, the MME or SGSN shall detach the subscriber and remove the subscriber from its database. + +If the MME/SGSN has received the monitoring event configurations in an ULA command and one, several or all event detections fail to be started (e.g due to maximum resources exceeded), the MME/SGSN shall send the Notify Request command with the Monitoring-Event-Config-Status AVP for the failed monitoring event configurations. + +If the MME or SGSN receives a failure response, e.g. DIAMETER\_UNABLE\_TO\_COMPLY, corresponding to a Notify Request to notify the HSS about the selected PDN-GW, the MME or SGSN shall not trigger a detach for the subscriber based only on this failure. + +NOTE 1: A failure to indicate the selected PDN-GW to the HSS does not impact connectivity provided via 3GPP access. + +When the MME/SGSN has received the Configuration-Information-Answer from the IWK-SCEF during the monitoring event configuration procedure, the MME/SGSN shall send the Notify Request command with the Monitoring-Event-Config-Status AVP as received from the IWK-SCEF in the Configuration-Information-Answer, for the monitoring + +event configurations whose status have changed (due to authorization performed by the IWK-SCEF) since last informed to the HSS. + +NOTE 2: If the Monitoring-Event-Configuration was received at the MME/SGSN in the ULA command, then the HSS is not yet informed of any status of the monitoring event configuration. In this case, the entire Monitoring-Event-Config-Status as received from IWK-SCEF has to be transferred to the HSS through a Notify Request Command. + +If the MME or SGSN determines that a Monitoring Event Configuration for a UE is to be deleted in the HSS (i.e. SCEF responds to a Monitoring Event Report with DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN), the MME or SGSN shall send a Notify Request with the Monitoring-Event-Config-Status AVP. The Monitoring-Event-Config-Status AVP shall include the error as received from SCEF. + +#### 5.2.5.1.3 Detailed behaviour of the HSS + +When receiving a Notify request the HSS shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the IMSI is known, and the source MME or SGSN originating the Notify message is not currently registered in HSS for that UE, a result code of DIAMETER\_ERROR\_UNKNOWN\_SERVING\_NODE shall be returned. + +If the IMSI is known, and the source MME or SGSN is currently registered in HSS, the HSS shall set the result code to DIAMETER\_SUCCESS, unless otherwise stated, and + +- store the new terminal information if present in the request; +- store the new UE SRVCC capability if present in the request; +- store the new PDN GW and PLMN ID for an APN if present in the request and the APN is present in the subscription and if PDN GW is dynamically allocated; otherwise the HSS shall not store the new PDN GW data and shall set the result code to DIAMETER\_UNABLE\_TO\_COMPLY; +- store the new PDN GW and PLMN ID, and the APN itself, if both are present in the request, and the APN is not present in the subscription but a wild card APN is present in the subscription; +- if the Emergency Services IE is present, with the Emergency-Indication flag set, store the new PDN GW, as the PDN GW used to establish emergency PDN connections; the HSS shall store this information not bound to any specific APN; +- mark the location area as "restricted" if so indicated in the request; +- send Cancel Location to the current SGSN if so indicated in the request; +- if the UE has become reachable again, and NOR is received on S6a from an MME or on S6d from an SGSN, the HSS shall respectively clear the URRP-MME or the URPP-SGSN parameter for the UE and send an indication to the Service Related Entities if there is any; +- when NOR is received on S6d from an SGSN (with the Alert Reason present), the HSS shall reset the MNRG flag and send a MAP-Alert-Service-Centre message or S6c-Alert-Service-Centre-Request (see 3GPP TS 29.338 [48], i.e. the behaviour in the HSS should be the same as when a MAP-Ready for SM is received from an SGSN; +- when NOR is received on S6a from an MME (with the Alert Reason present), the HSS shall reset the MNRF flag and send a MAP-Alert-Service-Centre message or S6c-Alert-Service-Centre-Request (see 3GPP TS 29.338 [48], i.e. the behaviour in the HSS should be the same as when a MAP-Ready for SM is received from a VLR/MSC; +- when NOR is received on S6a from an MME or on S6d from an SGSN to update the Homogeneous Support of IMS Voice Over PS Sessions, the HSS shall store the updated Homogeneous Support of IMS Voice Over PS Sessions and may use this information in the future in order to skip the T-ADS data retrieval, as described in clause 5.2.2.1 (IDR/IDA commands). If the "Homogeneous Support of IMS Voice Over PS Sessions" bit is set in the NOR-Flags AVP received but without Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions AVP present in the NOR message, the HSS shall take the Homogeneous Support of IMS Voice Over PS Sessions as unknown to the serving node. If the "Homogeneous Support of IMS Voice Over PS Sessions" bit is not set in the NOR-Flags AVP, the HSS shall ignore (if present) the Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions AVP; + +- when NOR is received on S6a from an MME for removal of MME registration for SMS, the HSS shall remove the MME registration for SMS and the "MME number for SMS" as the corresponding MSC number to be used for MT SMS. +- when NOR is received on S6a from an MME or on S6d from an SGSN with the Monitoring-Event-Config-Status AVP, the HSS shall either trigger a Monitoring event cancelation procedure for the monitoring events that were not successfully authorized at the MME/SGSN by the IWK-SCEF or a Monitoring event suspension procedure for the monitoring events that were not successfully configured at the MME/SGSN, as specified in clause 7.2.2.2 of 3GPP TS 29.336 [54]. The HSS shall trigger a Monitoring event cancelation or suspension procedure based on the result code as indicated by MME/SGSN (e.g. DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) returned by IWK-SCEF triggers a Monitoring event cancelation procedure in HSS). +- when NOR is received on S6a from an MME or on S6d from an SGSN with an indication of the deletion of a monitoring event configuration in SCEF (DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN in the Monitoring-Event-Config-Status AVP), the HSS shall locally delete the corresponding Monitoring Event Configuration and shall not trigger a Monitoring event cancelation procedure. + +and then send the response to the MME or SGSN. + +--- + +## 5A MME – CSS (S7a) and SGSN – CSS (S7d) + +### 5A.1 Introduction + +The S7a interface enables the transfer of subscriber related CSG data in the VPLMN between the MME and the CSS as described in 3GPP TS 23.401 [2]. + +The S7d interface enables the transfer of subscriber related CSG data in the VPLMN between the SGSN and the CSS as described in 3GPP TS 23.060 [12]. + +### 5A.2 Mobility Services + +#### 5A.2.1 Location Management Procedures + +##### 5A.2.1.1 Update VCSG Location + +###### 5A.2.1.1.1 General + +The Update VCSG Location Procedure shall be used between the MME and the CSS or between the SGSN and the CSS to update location information in the CSS or retrieve the CSG subscription data of the UE from the CSS. The procedure allows: + +- to inform the CSS about the identity of the MME or SGSN currently serving the user, +- to update MME or SGSN with user CSG subscription data received from the CSS. + +This procedure is mapped to the commands Update-VCSG-Location-Request/Answer (UVR/UVA) in the Diameter application specified in clause 7. + +Table 5A.2.1.1.1/1 specifies the involved information elements for the request. + +Table 5A.2.1.1.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.1.1.1/1: Update VCSG Location Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| MSISDN | MSISDN | C | This information element shall contain the user MSISDN, formatted according to 3GPP TS 29.329 [25]. It shall be present if available. | +| UVR Flags
(See 7.3.153) | UVR-Flags | M | This Information Element contains a bit mask. See 7.3.153 for the meaning of the bits. | +| SGSN number
(See 7.3.102) | SGSN-Number | C | This Information Element contains the ISDN number of the SGSN, see 3GPP TS 23.003 [3].
It shall be present when the message is sent on the S7d interface.
It may be present when the message is sent on the S7a interface and the requesting node is a combined MME/SGSN. | + +**Table 5A.2.1.1.1/2: Update VCSG Location Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S7a/S7d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable:
- User Unknown | +| VPLMN CSG Subscription Data
(See 7.3.155) | VPLMN-CSG-Subscription-Data | C | This Information Element shall contain the list of CSG Ids and the associated expiry dates stored in the CSS. It shall be present if success is reported, unless an explicit "skip subscriber data" indication was present in the request or the Temporary Empty VPLMN CSG Subscription Data flag is set. | +| UVA Flags
(See 7.3.154) | UVA-Flags | C | This Information Element contains a bit mask. See 7.3.154 for the meaning of the bits. | + +#### 5A.2.1.1.2 Detailed behaviour of the MME and the SGSN + +The MME or SGSN shall make use of this procedure to register the UE in the CSS and to retrieve the "CSG subscription data from CSS" when: + +- the VPLMN supports Autonomous CSG Roaming +- and the HPLMN has enabled Autonomous CSG Roaming in the VPLMN +- and the UE has requested an initial attach or a tracking area procedure or a routing area procedure to a CSG cell +- and the MME or SGSN have not yet registered the UE in the CSS. + +If the Autonomous CSG Roaming in the VPLMN is not supported or is not allowed by the HPLMN of the subscriber, the MME or SGSN shall not make use of the Update CSG Location procedure. + +For UEs receiving emergency services, in which the UE was not successfully authenticated, the MME or SGSN shall not make use of the Update VCSG Location procedure. + +A combined MME/SGSN shall set the "Skip Subscriber Data" flag in the UVR-Flags if the "CSG subscription data from CSS" are already available due to a previously VCSG Location updating. + +A combined MME/SGSN that has chosen the option to include the SGSN Number within an Update VCSG Request sent over S7a shall be prepared to receive a single CSG subscription data update message from the CSS when the CSG subscription data is modified in the CSS. + +When receiving an Update VCSG Location Answer from the CSS, the MME or SGSN shall check the result code. If it indicates success the MME or SGSN shall delete all the stored "CSG subscription data from CSS" (if any) and then store the received "CSG subscription data from the CSS" (if any), and it shall store the CSS identity as received in the Origin-Host AVP. + +If the same CSG Id exists in both "CSG subscription data from CSS" and "CSG subscription data from HSS", the "CSG subscription data from HSS" shall take precedence over the "CSG subscription data from CSS" in further use. + +If an error response is received from the CSS, the MME or SGSN shall not reject the UE and shall end the procedure when the UE is attaching to a normal cell. If the UE is attaching to a CSG cell, in this case the MME or SGSN shall check if there is such CSG Id from the HSS. If there is no such CSG Id, the MME or SGSN shall reject the UE. + +#### 5A.2.1.1.3 Detailed behaviour of the CSS + +When receiving an Update VCSG Location request the CSS shall check whether the user is known. + +If the user is not known, and if the Update VCSG Location Request is received over the S7a/S7d interface, the CSS may: + +- store the MME or SGSN identity received within the Origin-Host AVP, and include the UVA-Flags AVP with "Temporary Empty VPLMN CSG Subscription Data" flag set, and return a Result Code of DIAMETER\_SUCCESS, or +- return a Result Code of DIAMETER\_ERROR\_USER\_UNKNOWN. + +NOTE: A mechanism is needed in the CSS to associate the CSG subscription data of the user with the received IMSI. + +If the Update VCSG Location Request is received over the S7a/S7d interface, the CSS shall replace the stored MME or SGSN identity with the received value (the identity is received within the Origin-Host AVP). + +If no result code indicating an error is sent to the MME or SGSN, the CSS shall include the VPLMN CSG subscription data in the Update VCSG Location Answer unless an explicit "skip subscriber data" indication has been received in the request, and shall return a Result Code of DIAMETER\_SUCCESS. + +#### 5A.2.1.2 Cancel VCSG Location + +##### 5A.2.1.2.1 General + +The Cancel VCSG Location Procedure shall be used between the CSS and the MME and between the CSS and the SGSN. The procedure shall be invoked by the CSS and is used: + +- to inform the MME or SGSN about the subscriber's VCSG subscription withdrawal by the CSS operator and the removal of their registration in the CSS. + +This procedure is mapped to the commands Cancel-VCSG-Location-Request/Answer (CVR/CVA) in the Diameter application specified in clause 7. + +Table 5A.2.1.2.1/1 specifies the involved information elements for the request. + +Table 5A.2.1.2.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.1.2.1/1: Cancel VCSG Location Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|--------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Cancellation Type
(See 7.3.24) | Cancellation-Type | M | Defined values that can be used are:
- Subscription Withdrawal, applied to the VPLMN CSG subscription. | + +**Table 5A.2.1.2.1/2: Cancel VCSG Location Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | The result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]). | + +#### 5A.2.1.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a Cancel VCSG Location request the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_SUCCESS is returned. + +If it is known, the MME or SGSN shall check if the Cancellation Type is Subscription Withdrawal. In this case, the MME or SGSN shall remove the information of their registration in the CSS and the stored VPLMN CSG subscription if any. Also in this case a result code of DIAMETER\_SUCCESS is returned. + +When a UE is served by a single combined MME/SGSN for both E-UTRAN and non-E-UTRAN access, the combined MME/SGSN shall check if the Cancellation Type is Subscription Withdrawal. In this case, the Cancel VCSG Location request is processed both in the MME part and in the SGSN part of the combined node. + +#### 5A.2.1.2.3 Detailed behaviour of the CSS + +The CSS shall make use of this procedure when the user's VPLMN CSG subscription is withdrawn by the CSS operator and shall include a cancellation type of "Subscription Withdrawal". + +### 5A.2.2 Subscriber Data Handling Procedures + +#### 5A.2.2.1 Insert VCSG Subscriber Data + +##### 5A.2.2.1.1 General + +The Insert VCSG Subscriber Data Procedure shall be used between the CSS and the MME and between the CSS and the SGSN for updating CSG subscription data in the MME or SGSN in the following situations: + +- due to administrative changes of the user data in the CSS and the user is now located in an MME or SGSN, i.e. if the user was given a CSG subscription and the CSG subscription has changed; + +If the CSS knows that the UE has attached to the same combined MME/SGSN via both the E-UTRAN and UTRAN/GERAN, i.e. the CSS has received the Update VCSG Location Request over both the S7a interface and S7d interface respectively with the same SGSN number, the CSS should invoke this procedure for a single time to update CSG subscription data in the combined MME/SGSN, i.e. the CSS should not invoke this procedure for each of the MME and the SGSN registered respectively. + +This procedure is mapped to the commands Insert-Subscriber Data-Request/Answer (IDR/IDA) in the Diameter application specified in clause 7. + +Table 5A.2.2.1.1/1 specifies the involved information elements for the request. + +Table 5A.2.2.1.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.2.1.1/1: Insert VCSG Subscriber Data Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|------------------------------------|------|---------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| VPLMN CSG Subscription Data (See 7.3.2) | VPLMN-CSG-Subscription-Data | M | This Information Element shall contain the list of CSG Ids and the associated expiry dates stored in the VPLMN CSS. | + +**Table 5A.2.2.1.1/2: Insert VCSG Subscriber Data Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. Result-Code AVP shall be used to indicate success / errors defined in the Diameter base protocol (see IETF RFC 6733 [61]). The Experimental-Result AVP shall be used for S7a/S7d errors. This is a grouped AVP which shall contain the 3GPP Vendor Id in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. The following errors are applicable in this case:
- User Unknown. | + +#### 5A.2.2.1.2 Detailed behaviour of the MME and the SGSN + +When receiving an Insert VCSG Subscriber Data request, the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the request does not contain any CSG-Subscription-Data AVP, Experimental-Result shall be set to DIAMETER\_ERROR\_SUBS\_DATA\_ABSENT. + +If the request contains at least one CSG-Subscription-Data AVPs, the MME or SGSN shall delete all the stored "CSG subscription data from CSS" (if any), and then store the received "CSG subscription data from CSS". + +If the MME or SGSN cannot fulfil the received request, e.g. due to a database error, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the same CSG Id exists in both "CSG subscription data from CSS" and "CSG subscription data from HSS", the "CSG subscription data from HSS" shall take precedence over the "CSG subscription data from CSS" in further use. + +#### 5A.2.2.1.3 Detailed behaviour of CSS + +The CSS shall make use of this procedure to delete the "CSG subscription data from CSS" stored in the MME or SGSN and replace them with the CSG subscription data sent. + +If the CSS receives a Insert VCSG Subscriber Data answer with the Result Code DIAMETER\_ERROR\_USER\_UNKNOWN, the CSS shall clear the stored MME or SGSN identity. + +#### 5A.2.2.2 Delete VCSG Subscriber Data + +##### 5A.2.2.2.1 General + +This procedure shall be used between the CSS and the MME or between the CSS and the SGSN, to remove all the "CSG subscription data from CSS" stored in the MME or SGSN. The procedure shall be invoked by the CSS. + +If the CSS knows that the UE has attached to the same combined MME/SGSN via both E-UTRAN and UTRAN/GERAN, i.e. the CSS has received the Update VCSG Location Request over both the S7a interface and S7d interface respectively with the same SGSN number, the CSS should invoke this procedure for a single time to remove all the "CSG subscription data from CSS" stored in the combined MME/SGSN, i.e. not invoke this procedure for each of the MME and the SGSN registered respectively. + +This procedure is mapped to the commands Delete-Subscriber-Data-Request/Answer (DSR/DSA) in the S7a/S7d Diameter application specified in clause 7. + +Table 5A.2.2.2.1/1 specifies the involved information elements for the request. + +Table 5A.2.2.2.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.2.2.1/1: Delete VCSG Subscriber Data Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|--------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| DSR Flags
(See 7.3.25) | DSR-Flags | M | This Information Element shall contain a bit mask. See 7.3.25 for the meaning of the bits. | + +**Table 5A.2.2.2.1/2: Delete VCSG Subscriber Data Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S7a/S7d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown | + +#### 5A.2.2.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a Delete VCSG Subscriber Data request, the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If it is known, the MME or SGSN shall delete all the stored "CSG subscription data from CSS". + +If the deletion of the subscription data succeeds in the MME or SGSN, the Result-Code shall be set to DIAMETER\_SUCCESS. + +If the MME or SGSN cannot fulfil the received request for other reasons, e.g. due to a database error, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +#### 5A.2.2.2.3 Detailed behaviour of the CSS + +The CSS shall make use of this procedure to remove all the CSG subscription data associated to CSS from the MME or SGSN. + +NOTE: When a Delete VCSG Subscriber Data procedure occurs, the MME or SGSN remains registered in the CSS + +If the CSS receives a Delete VCSG Subscriber Data answer with the Result Code DIAMETER\_ERROR\_USER\_UNKNOWN from the MME or SGSN, the CSS shall clear the stored MME or SGSN identity. + +### 5A.2.3 Fault Recovery Procedures + +#### 5A.2.3.1 VCSG Reset + +##### 5A.2.3.1.1 General + +The VCSG Reset Procedure shall be used by the CSS, after a restart, to indicate to the MME and to the SGSN that a failure has occurred. + +This procedure is mapped to the commands Reset-Request/Answer (RSR/RSA) in the S7a/S7d Diameter application specified in clause 7. + +Table 5A.2.3.1.1/1 specifies the involved information elements for the request. + +Table 5A.2.3.1.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.3.1.1/1: VCSG Reset Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 5A.2.3.1.1/2: VCSG Reset Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S7a/S7d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
There are no Experimental-Result codes applicable for this command. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 5A.2.3.1.2 Detailed behaviour of the MME and the SGSN + +When receiving a VCSG Reset message, the MME or SGSN or combined MME/SGSN, for all roaming users for which they have a registration in CSS, shall mark "Location Information Confirmed in CSS" record as "Not Confirmed". The MME or SGSN or combined MME/SGSN shall make use of the CSS Identity received in the Origin-Host AVP (by comparing it with the value stored after successful ULA) in order to determine which user records are impacted. + +When, as described in 3GPP TS 23.007 [43], an event requiring the MME or SGSN to check the "CSG subscription data from CSS" occurs, and if the user record "Location Information Confirmed in CSS" is marked as "Not Confirmed", the restoration procedure shall be triggered. + +#### 5A.2.3.1.3 Detailed behaviour of the CSS + +The CSS shall make use of this procedure in order to indicate to all relevant MMEs, SGSNs, and combined MME/SGSNs that the CSS has restarted and may have lost the current MME-Identity and SGSN-Identity of some of its users who may be currently roaming in the MME area and/or SGSN area, and to which the CSS, therefore, cannot send e.g. Insert VCSG Subscriber Data messages when needed. + +The CSS should invoke this procedure towards a combined MME/SGSN only for a single time even if some of the impacted subscribers are attached to the combined MME/SGSN via UTRAN/GERAN and some of the impacted subscribers are attached to the combined MME/SGSN via E-UTRAN. + +## 6 MME – EIR (S13) and SGSN – EIR (S13') + +### 6.1 Introduction + +The S13 interface shall enable the ME Identity check procedure between the MME and the EIR as described in the 3GPP TS 23.401 [2]. + +The S13' interface shall enable the ME Identity check procedure between the SGSN and the EIR as described in the 3GPP TS 23.060 [12]. + +### 6.2 ME Identity Check Procedures + +#### 6.2.1 ME Identity Check + +##### 6.2.1.1 General + +This Mobile Equipment Identity Check Procedure shall be used between the MME and the EIR and between the SGSN and the EIR to check the Mobile Equipment's identity status (e.g. to check that it has not been stolen, or, to verify that it does not have faults). + +This procedure is mapped to the commands ME-Identity-Check-Request/Answer (ECR/ECA) in the Diameter application specified in clause 6. + +Table 6.2.1.1/1 specifies the involved information elements for the request. + +Table 6.2.1.1/2 specifies the involved information elements for the answer. + +**Table 6.2.1.1/1: ME Identity Check Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------|------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Terminal Information (See 7.3.3) | Terminal-Information | M | This information element shall contain the information about the used mobile equipment i.e. the IMEI. Within this Information Element, only the IMEI and the Software-Version AVPs shall be used on the S13/S13' interface. | +| IMSI | User-Name (See IETF RFC 6733 [61]) | O | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | + +**Table 6.2.1.1/2: ME Identity Check Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S13/S13' errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- Unknown equipment | +| Equipment Status (See 7.3.51) | Equipment-Status | C | This information element shall contain the status of the requested mobile equipment as defined in 3GPP TS 22.016 [13].
It shall be present if the result of the ME Identity Check is DIAMETER_SUCCESS. | + +### 6.2.1.2 Detailed behaviour of the MME and the SGSN + +The MME or the SGSN shall make use of this procedure to check the ME identity, if the MME or the SGSN is configured to check the IMEI with the EIR. + +Terminal-Information, when sent by the MME/SGSN to the EIR, shall contain the IMEI AVP, and it may contain also the Software-Version AVP. + +IMSI may be sent together with Terminal Information to the EIR for operator-determined purposes. + +When receiving the ME Identity Check answer from the EIR, the MME or the SGSN shall check the result code and the equipment status. Dependent upon the result, the MME or the SGSN will decide its subsequent actions (e.g. sending an Attach Reject if the EIR indicates that the Mobile Equipment is unknown or prohibited listed). + +### 6.2.1.3 Detailed behaviour of the EIR + +When receiving an ME Identity Check request, the EIR shall check whether the mobile equipment is known. + +The EIR shall identify the mobile equipment based on the first 14 digits of the IMEI AVP; if a 15th digit is received in the IMEI AVP, this digit shall be ignored by the EIR. + +Based on operator policies, the EIR may also use the Software-Version AVP, in addition to the first 14 digits of the IMEI AVP, to check the equipment identity against prohibited and tracking lists (see 3GPP TS 22.016 [13]). + +If the mobile equipment identity is not known, a result code of DIAMETER\_ERROR\_EQUIPMENT\_UNKNOWN is returned. + +If it is known, the EIR shall return DIAMETER\_SUCCESS with the equipment status. + +## 7 Protocol Specification and Implementation + +### 7.1 Introduction + +#### 7.1.1 Use of Diameter base protocol + +The Diameter base protocol as specified in IETF RFC 6733 [61] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +#### 7.1.2 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [16]. + +If there are no intermediate Diameter Agent networks located between the visited PLMN and the home PLMN, the HSS or the first Diameter Agent located in the home PLMN which has direct connection with the serving network is required to check that the realm contained in the Origin-Realm AVP in the request from the serving network corresponds to the right serving network. + +If there are intermediate Diameter Agent networks located between the visited PLMN and home PLMN, the first Diameter Agent which has direct connection with the serving network is required to check that the realm contained in the Origin-Realm AVP in the request from the serving network corresponds to the right serving network. + +NOTE 1: How to do the above check is implementation specific, e.g. it may be done by checking if the IP addresses of the serving network nodes match with the realm received in the Origin-Realm AVP in the request. + +NOTE 2: Network configurations where a (potential) visited PLMN acts as intermediate Diameter Agent network are not allowed. + +NOTE 3: In the case there are intermediate Diameter Agent networks, the home network has to trust these intermediate Diameter agent networks to do the check and other hop by hop security check. This trust is usually substantiated by contracts since there are no remote technical means to verify if the checks were actually performed. + +#### 7.1.3 Accounting functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the S6a, S6d, S13 and S13' interfaces. + +#### 7.1.4 Use of sessions + +Between the MME and the HSS and between the SGSN and the HSS and between the MME and the EIR, Diameter sessions shall be implicitly terminated. An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol specified in IETF RFC 6733 [61] includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [61]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +#### 7.1.5 Transport protocol + +Diameter messages over the S6a, S6d, S13, S13', S7a and S7d interfaces shall make use of SCTP IETF RFC 4960 [14]. + +## 7.1.6 Routing considerations + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host. + +If an MME or SGSN knows the address/name of the HSS for a certain user, and the associated home network domain name, both the Destination-Realm and Destination-Host AVPs shall be present in the request. + +NOTE: When sending a ULR command for a certain user due to HSS restoration procedure (i.e, after the MME/SGSN have received a Reset command from the HSS), the MME or the SGSN might consider the stored address/name of the HSS for the user to be invalid and hence not known. + +If an MME or SGSN knows only the home network domain name for a certain user, the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node. + +If an MME or SGSN knows only the identity of the user, the home network domain name shall be derived from the user's IMSI (MNC and MCC values) to construct the EPC Home Network Realm/Domain, as indicated in 3GPP TS 23.003 [3], clause 19.2, and use it as Destination-Realm. + +Consequently, the Destination-Host AVP is declared as optional in the ABNF for all requests initiated by an MME or SGSN. + +The address/name of the EIR shall be locally configured in the MME. + +Requests initiated by the HSS towards an MME or SGSN shall include both Destination-Host and Destination-Realm AVPs. + +The HSS obtains the Destination-Host AVP to use in requests towards an MME or SGSN, from the Origin-Host AVP received in previous requests from the MME or SGSN. Consequently, the Destination-Host AVP is declared as mandatory in the ABNF for all requests initiated by the HSS. The Origin-Host AVP received in requests from the MME may contain a Diameter identity of the MME encoded as specified in clause 19.4.2.4 of 3GPP TS 23.003 [3]. The Origin-Host AVP received in requests from the SGSN may contain a Diameter identity of the SGSN encoded as specified in clause 19.4.2.6 of 3GPP TS 23.003 [3]. + +The HSS obtains the Destination-Realm AVP to use in requests towards an MME or SGSN, from the Origin-Realm AVP received in previous requests from the MME or SGSN. The Origin-Realm AVP in the requests received by the HSS in roaming cases, should contain the domain name of the network to which the MME or the SGSN belongs, encoded as specified in clause 19.2 of 3GPP TS 23.003 [3]. + +The Destination-Realm AVP is declared as mandatory in the ABNF for all requests. + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +## 7.1.7 Advertising Application Support + +The HSS, MME, SGSN and EIR shall advertise support of the Diameter S6a/S6d and/or S13/S13' Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [61]. + +## 7.1.8 Diameter Application Identifier + +This clause specifies three Diameter applications: The S6a/S6d interface application, the S13/S13' interface application, and the S7a/S7d interface application. + +The S6a/S6d interface application allows a Diameter server and a Diameter client: + +- to exchange location information; +- to authorize a user to access the EPS; +- to exchange authentication information; +- to download and handle changes in the subscriber data stored in the server. + +The S6a/S6d interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the S6a/S6d interface application is 16777251 (allocated by IANA). + +The S13/S13' interface application allows a Diameter server and a Diameter client: + +- to check the validity of the ME Identity. + +The S13/S13' interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the S13/S13' interface application is 16777252 (allocated by IANA). + +The S7a/S7d interface application allows a Diameter server and a Diameter client: + +- to authorize a user to access CSGs identified in the CSS while roaming; +- to download and handle changes in CSG subscriber data stored in the CSS. + +The S7a/S7d interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the S7a/S7d interface application is 16777308 (allocated by IANA). + +### 7.1.9 Use of the Supported-Features AVP + +When new functionality is introduced on the S6a/S6d interfaces, it should be defined as optional. If backwards incompatible changes can not be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. The usage of the Supported-Features AVP on the S6a/S6d interfaces is consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [9]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [9], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Table 7.3.10/1 defines the features applicable to the S6a/S6d interfaces for the feature list with a Feature-List-ID of 1. The Table 7.3.10/2 defines the features applicable to the S6a/S6d interfaces for the feature list with a Feature-List-ID of 2. + +NOTE 1: If the support of a feature by the receiver is required in order for the receiver to be able to correctly process the request command, then the feature is included in the Supported-Features AVP and the M-bit of the Supported-Features AVP has to be set in the request command, according to 3GPP TS 29.229 [9] clause 7.2.1. + +NOTE 2: Currently none of the features that can be included in the Supported-Features AVP of the ULR command requires that the HSS supports them to successfully process the ULR command. For this reason the MME or SGSN does not need to set the M-bit of the Supported-Features AVP in the ULR command. This corresponds to the exception to the general rule requiring the setting of the M-bit of the Supported-Features AVP in a request described in 3GPP TS 29.229 [9] clause 7.2.1. Setting the M-bit of the Supported-Features AVP in the ULR command will mean that, if any of the features is not supported, the HSS will reject the ULR command as according to 3GPP TS 29.229 [9] clause 7.2.1. + +## 7.2 Commands + +### 7.2.1 Introduction + +This clause defines the Command code values and related ABNF for each command described in this specification. + +### 7.2.2 Command-Code values + +This clause defines Command-Code values for the S6a/S6d interface application and S13/S13' interface application as allocated by IANA in the IETF RFC 5516 [32]. + +Every command is defined by means of the ABNF syntax IETF RFC 2234 [7], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [61]. In the case, the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [61] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with the IETF RFC 6733 [61]. + +The following Command Codes are defined in this specification: + +**Table 7.2.2/1: Command-Code values for S6a/S6d** + +| Command-Name | Abbreviation | Code | Clause | +|------------------------------------|--------------|------|--------| +| Update-Location-Request | ULR | 316 | 7.2.3 | +| Update-Location-Answer | ULA | 316 | 7.2.4 | +| Cancel-Location-Request | CLR | 317 | 7.2.7 | +| Cancel-Location-Answer | CLA | 317 | 7.2.8 | +| Authentication-Information-Request | AIR | 318 | 7.2.5 | +| Authentication-Information-Answer | AIA | 318 | 7.2.6 | +| Insert-Subscriber-Data-Request | IDR | 319 | 7.2.9 | +| Insert-Subscriber-Data-Answer | IDA | 319 | 7.2.10 | +| Delete-Subscriber-Data-Request | DSR | 320 | 7.2.11 | +| Delete-Subscriber-Data-Answer | DSA | 320 | 7.2.12 | +| Purge-UE-Request | PUR | 321 | 7.2.13 | +| Purge-UE-Answer | PUA | 321 | 7.2.14 | +| Reset-Request | RSR | 322 | 7.2.15 | +| Reset-Answer | RSA | 322 | 7.2.16 | +| Notify-Request | NOR | 323 | 7.2.17 | +| Notify-Answer | NOA | 323 | 7.2.18 | + +For these commands, the Application-ID field shall be set to 16777251 (application identifier of the S6a/S6d interface application, allocated by IANA). + +**Table 7.2.2/2: Command-Code values for S13/S13'** + +| Command-Name | Abbreviation | Code | Clause | +|---------------------------|--------------|------|--------| +| ME-Identity-Check-Request | ECR | 324 | 7.2.19 | +| ME-Identity-Check-Answer | ECA | 324 | 7.2.20 | + +For these commands, the Application-ID field shall be set to 16777252 (application identifier of the S13/S13' interface application, allocated by IANA). + +**Table 7.2.2/3: Command-Code values for S7a/S7d** + +| Command-Name | Abbreviation | Code | Clause | +|----------------------------------|--------------|---------|--------| +| Update-VCSG-Location-Request | UVR | 8388638 | 7.2.21 | +| Update-VCSG-Location-Answer | UVA | 8388638 | 7.2.22 | +| Insert-Subscription-Data-Request | IDR | 319 | 7.2.9 | +| Insert-Subscription-Data-Answer | IDA | 319 | 7.2.10 | +| Delete-Subscriber-Data-Request | DSR | 320 | 7.2.11 | +| Delete-Subscriber-Data-Answer | DSA | 320 | 7.2.12 | +| Reset-Request | RSR | 322 | 7.2.15 | +| Reset-Answer | RSA | 322 | 7.2.16 | +| Cancel-VCSG-Location-Request | CVR | 8388642 | 7.2.23 | +| Cancel-VCSG-Location-Answer | CVA | 8388642 | 7.2.24 | + +For these commands, the Application-ID field shall be set to 16777308 (application identifier of the S7a/S7d interface application, allocated by IANA). + +## 7.2.3 Update-Location-Request (ULR) Command + +The Update-Location-Request (ULR) command, indicated by the Command-Code field set to 316 and the "R" bit set in the Command Flags field, is sent from MME or SGSN to HSS. + +Message Format + +``` +< Update-Location-Request > ::= < Diameter Header: 316, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Terminal-Information ] + { RAT-Type } + { ULR-Flags } + [ UE-SRVCC-Capability ] + { Visited-PLMN-Id } + [ SGSN-Number ] + [ Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions ] + [ GMLC-Address ] + *[ Active-APN ] + [ Equivalent-PLMN-List ] + [ MME-Number-for-MT-SMS ] + [ SMS-Register-Request ] + [ SGs-MME-Identity ] + [ Coupled-Node-Diameter-ID ] + [ Adjacent-PLMNs ] +``` + +``` + +[ Supported-Services ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 7.2.4 Update-Location-Answer (ULA) Command + +The Update-Location-Answer (ULA) command, indicated by the Command-Code field set to 316 and the 'R' bit cleared in the Command Flags field, is sent from HSS to MME or SGSN. + +Message Format + +``` + +< Update-Location-Answer > ::= < Diameter Header: 316, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + [ Error-Diagnostic ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + [ ULA-Flags ] + [ Subscription-Data ] + *[ Reset-ID ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.5 Authentication-Information-Request (AIR) Command + +The Authentication-Information-Request (AIR) command, indicated by the Command-Code field set to 318 and the 'R' bit set in the Command Flags field, is sent from MME or SGSN to HSS. + +Message Format + +``` + +< Authentication-Information-Request > ::= < Diameter Header: 318, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + *[Supported-Features] + [ Requested-EUTRAN-Authentication-Info ] + [ Requested-UTRAN-GERAN-Authentication-Info ] + { Visited-PLMN-Id } + [ AIR-Flags ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.6 Authentication-Information-Answer (AIA) Command + +The Authentication-Information-Answer (AIA) command, indicated by the Command-Code field set to 318 and the 'R' bit cleared in the Command Flags field, is sent from HSS to MME or SGSN. + +### Message Format + +``` +< Authentication-Information-Answer > ::= < Diameter Header: 318, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + [ Error-Diagnostic ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[Supported-Features] + [ Authentication-Info ] + [ UE-Usage-Type ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.7 Cancel-Location-Request (CLR) Command + +The Cancel-Location-Request (CLR) command, indicated by the Command-Code field set to 317 and the 'R' bit set in the Command Flags field, is sent from HSS to MME or SGSN. + +### Message Format + +``` +< Cancel-Location-Request > ::= < Diameter Header: 317, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + *[Supported-Features ] + { Cancellation-Type } + [ CLR-Flags ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.8 Cancel-Location-Answer (CLA) Command + +The Cancel-Location-Answer (CLA) command, indicated by the Command-Code field set to 317 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to HSS. + +### Message Format + +``` +< Cancel-Location-Answer > ::= < Diameter Header: 317, PXY, 16777251 > + < Session-Id > +``` + +``` + +[ DRMP ] +[ Vendor-Specific-Application-Id ] +*[ Supported-Features ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 7.2.9 Insert-Subscriber-Data-Request (IDR) Command + +The Insert-Subscriber-Data-Request (IDR) command, indicated by the Command-Code field set to 319 and the 'R' bit set in the Command Flags field, is sent from HSS or CSS to MME or SGSN. + +Message Format when used over the S6a or S6d application: + +``` + +< Insert-Subscriber-Data-Request > ::= < Diameter Header: 319, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + *[ Supported-Features ] + { Subscription-Data } + [ IDR- Flags ] + *[ Reset-ID ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +Message Format when used over the S7a or S7d application: + +``` + +< Insert-Subscriber-Data-Request > ::= < Diameter Header: 319, REQ, PXY, 16777308 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + *[ Supported-Features ] + *[ VPLMN-CSG-Subscription-Data ] + *[ Reset-ID ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.10 Insert-Subscriber-Data-Answer (IDA) Command + +The Insert-Subscriber-Data-Answer (IDA) command, indicated by the Command-Code field set to 319 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to HSS or CSS. + +Message Format when used over the S6a or S6d application: + +``` +< Insert-Subscriber-Data-Answer > ::= < Diameter Header: 319, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ IMS-Voice-Over-PS-Sessions-Supported ] + [ Last-UE-Activity-Time ] + [ RAT-Type ] + [ IDA-Flags ] + [ EPS-User-State ] + [ EPS-Location-Information ] + [Local-Time-Zone ] + [ Supported-Services ] + *[ Monitoring-Event-Report ] + *[ Monitoring-Event-Config-Status ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +Message Format when used over the S7a or S7d application: + +``` +< Insert-Subscriber-Data-Answer > ::= < Diameter Header: 319, PXY, 16777308 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.11 Delete-Subscriber-Data-Request (DSR) Command + +The Delete-Subscriber Data-Request (DSR) command, indicated by the Command-Code field set to 320 and the 'R' bit set in the Command Flags field, is sent from HSS or CSS to MME or SGSN. + +Message Format when used over the S6a/S6d application: + +``` +< Delete-Subscriber-Data-Request > ::= < Diameter Header: 320, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + *[ Supported-Features ] + { DSR-Flags } +``` + +``` + +[ SCEF-ID ] +*[ Context-Identifier ] +[ Trace-Reference ] +*[ TS-Code ] +*[ SS-Code ] +[ eDRX-Related-RAT ] +*[ External-Identifier ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +The SCEF-ID shall be present when the flag "Delete monitoring events" in DSR-Flags AVP is set. + +Message Format when used over the S7a/S7d application: + +``` + +< Delete-Subscriber-Data-Request > ::= < Diameter Header: 320, REQ, PXY, 16777308 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +{ Destination-Host } +{ Destination-Realm } +{ User-Name } +*[ Supported-Features ] +{ DSR-Flags } +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 7.2.12 Delete-Subscriber-Data-Answer (DSA) Command + +The Delete-Subscriber Data-Answer (DSA) command, indicated by the Command-Code field set to 320 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to HSS or CSS. + +Message Format when used over the S6a/S6d application: + +``` + +< Delete-Subscriber-Data-Answer > ::= < Diameter Header: 320, PXY, 16777251 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +*[ Supported-Features ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ DSA-Flags ] +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +Message Format when used over the S7a /S7d application: + +``` + +< Delete-Subscriber-Data-Answer > ::= < Diameter Header: 320, PXY, 16777308 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +*[ Supported-Features ] + +``` + +``` + +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 7.2.13 Purge-UE-Request (PUR) Command + +The Purge-UE-Request (PUR) command, indicated by the Command-Code field set to 321 and the 'R' bit set in the Command Flags field, is sent from MME or SGSN to HSS. + +Message Format + +``` + +< Purge-UE-Request > ::= < Diameter Header: 321, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + [ PUR-Flags ] + *[ Supported-Features ] + [ EPS-Location-Information ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.14 Purge-UE-Answer (PUA) Command + +The Purge-UE-Answer (PUA) command, indicated by the Command-Code field set to 321 and the 'R' bit cleared in the Command Flags field, is sent from HSS to MME or SGSN. + +Message Format + +``` + +< Purge-UE-Answer > ::= < Diameter Header: 321, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + [ PUA-Flags ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.15 Reset-Request (RSR) Command + +The Reset-Request (RSR) command, indicated by the Command-Code field set to 322 and the 'R' bit set in the Command Flags field, is sent from HSS or CSS to MME or SGSN. + +Message Format when used over the S6a/S6d application: + +``` +< Reset-Request > ::= < Diameter Header: 322, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + *[ Supported-Features ] + *[ User-Id ] + *[ Reset-ID ] + [ Subscription-Data ] + [ Subscription-Data-Deletion ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +Message Format when used over the S7a /S7d application: + +``` +< Reset-Request > ::= < Diameter Header: 322, REQ, PXY, 16777308 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + *[ Supported-Features ] + *[ Reset-ID ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.16 Reset-Answer (RSA) Command + +The Reset-Answer (RSA) command, indicated by the Command-Code field set to 322 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to HSS or CSS. + +Message Format when used over the S6a/S6d application: + +``` +< Reset-Answer > ::= < Diameter Header: 322, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] +``` + +\*[ Route-Record ] + +Message Format when used over the S7a /S7d application: + +``` +< Reset-Answer > ::= < Diameter Header: 322, PXY, 16777308 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.17 Notify-Request (NOR) Command + +The Notify-Request (NOR) command, indicated by the Command-Code field set to 323 and the 'R' bit set in the Command Flags field, is sent from MME or SGSN to HSS. + +Message Format + +``` +< Notify-Request > ::= < Diameter Header: 323, REQ, PXY, 16777251 > + < Session-Id > + [ Vendor-Specific-Application-Id ] + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Terminal-Information ] + [ MIP6-Agent-Info ] + [ Visited-Network-Identifier ] + [ Context-Identifier ] + [Service-Selection] + [ Alert-Reason ] + [ UE-SRVCC-Capability ] + [ NOR-Flags ] + [ Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions ] + [ Maximum-UE-Availability-Time ] + *[ Monitoring-Event-Config-Status ] + [ Emergency-Services ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.18 Notify-Answer (NOA) Command + +The Notify-Answer (NOA) command, indicated by the Command-Code field set to 323 and the 'R' bit cleared in the Command Flags field, is sent from HSS to MME or SGSN. + +Message Format + +``` + +< Notify-Answer> ::= < Diameter Header: 323, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.19 ME-Identity-Check-Request (ECR) Command + +The ME-Identity-Check-Request (ECR) command, indicated by the Command-Code field set to 324 and the 'R' bit set in the Command Flags field, is sent from MME or SGSN to EIR. + +### Message Format + +``` + +< ME-Identity-Check-Request > ::= < Diameter Header: 324, REQ, PXY, 16777252 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { Terminal-Information } + [ User-Name ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.20 ME-Identity-Check-Answer (ECA) Command + +The ME-Identity-Check-Answer (ECA) command, indicated by the Command-Code field set to 324 and the 'R' bit cleared in the Command Flags field, is sent from EIR to MME or SGSN. + +### Message Format + +``` + +< ME-Identity-Check-Answer> ::= < Diameter Header: 324, PXY, 16777252 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Equipment-Status ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.21 Update-VCSG-Location-Request (UVR) Command + +The Update-VCSG-Location-Request (UVR) command, indicated by the Command-Code field set to 8388638 and the "R" bit set in the Command Flags field, is sent from MME or SGSN to CSS. + +### Message Format + +``` +< Update-VCSG-Location-Request > ::= < Diameter Header: 8388638, REQ, PXY, > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ MSISDN ] + [ SGSN-Number ] + *[ Supported-Features ] + { UVR-Flags } + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.22 Update-VCSG-Location-Answer (UVA) Command + +The Update-VCSG-Location-Answer (UVA) command, indicated by the Command-Code field set to 8388638 and the 'R' bit cleared in the Command Flags field, is sent from CSS to MME or SGSN. + +### Message Format + +``` +< Update-VCSG-Location-Answer > ::= < Diameter Header: 8388638, PXY, > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + [ Error-Diagnostic ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ Supported-Features ] + *[ VPLMN-CSG-Subscription-Data ] + [ UVA-Flags ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.23 Cancel-VCSG-Location-Request (CVR) Command + +The Cancel-VCSG-Location-Request (CVR) command, indicated by the Command-Code field set to 8388642 and the 'R' bit set in the Command Flags field, is sent from CSS to MME or SGSN. + +### Message Format + +``` +< Cancel-VCSG-Location-Request > ::= < Diameter Header: 8388642, REQ, PXY, > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } +``` + +``` +{ Origin-Realm } +{ Destination-Host } +{ Destination-Realm } +{ User-Name } +*[Supported-Features ] +{ Cancellation-Type } +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +``` + +## 7.2.24 Cancel-VCSG-Location-Answer (CVA) Command + +The Cancel-VCSG-Location-Answer (CVA) command, indicated by the Command-Code field set to 8388642 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to CSS. + +### Message Format + +``` +< Cancel-VCSG-Location-Answer > ::= < Diameter Header: 8388642, PXY, > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.3 Information Elements + +### 7.3.1 General + +The following table specifies the Diameter AVPs defined for the S6a/S6d interface protocol, the S7a/S7d interface protocol and the S13/S13' interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +For all AVPs which contain bit masks and are of the type Unsigned32, e.g., ULR-Flags, DSR-Flags, PUA-Flags, etc., bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. + +**Table 7.3.1/1: S6a/S6d, S7a/S7d and S13/S13' specific DiameterAVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | | +|-------------------------------------------|----------|----------------|-------------|----------------|-----|------------|----------|-----------| +| | | | | Must | May | Should not | Must not | May Encr. | +| Subscription-Data | 1400 | 7.3.2 | Grouped | M, V | | | | No | +| Terminal-Information | 1401 | 7.3.3 | Grouped | M, V | | | | No | +| IMEI | 1402 | 7.3.4 | UTF8String | M, V | | | | No | +| Software-Version | 1403 | 7.3.5 | UTF8String | M, V | | | | No | +| QoS-Subscribed | 1404 | 7.3.77 | OctetString | M, V | | | | No | +| ULR-Flags | 1405 | 7.3.7 | Unsigned32 | M, V | | | | No | +| ULA-Flags | 1406 | 7.3.8 | Unsigned32 | M, V | | | | No | +| Visited-PLMN-Id | 1407 | 7.3.9 | OctetString | M, V | | | | No | +| Requested-EUTRAN-Authentication-Info | 1408 | 7.3.11 | Grouped | M, V | | | | No | +| Requested-UTRAN-GERAN-Authentication-Info | 1409 | 7.3.12 | Grouped | M, V | | | | No | +| Number-Of-Requested-Vectors | 1410 | 7.3.14 | Unsigned32 | M, V | | | | No | +| Re-Synchronization-Info | 1411 | 7.3.15 | OctetString | M, V | | | | No | +| Immediate-Response-Preferred | 1412 | 7.3.16 | Unsigned32 | M, V | | | | No | +| Authentication-Info | 1413 | 7.3.17 | Grouped | M, V | | | | No | +| E-UTRAN-Vector | 1414 | 7.3.18 | Grouped | M, V | | | | No | +| UTRAN-Vector | 1415 | 7.3.19 | Grouped | M, V | | | | No | +| GERAN-Vector | 1416 | 7.3.20 | Grouped | M, V | | | | No | +| Network-Access-Mode | 1417 | 7.3.21 | Enumerated | M, V | | | | No | +| HPLMN-ODB | 1418 | 7.3.22 | Unsigned32 | M, V | | | | No | +| Item-Number | 1419 | 7.3.23 | Unsigned32 | M, V | | | | No | +| Cancellation-Type | 1420 | 7.3.24 | Enumerated | M, V | | | | No | +| DSR-Flags | 1421 | 7.3.25 | Unsigned32 | M, V | | | | No | +| DSA-Flags | 1422 | 7.3.26 | Unsigned32 | M, V | | | | No | +| Context-Identifier | 1423 | 7.3.27 | Unsigned32 | M, V | | | | No | +| Subscriber-Status | 1424 | 7.3.29 | Enumerated | M, V | | | | No | +| Operator-Determined-Barring | 1425 | 7.3.30 | Unsigned32 | M, V | | | | No | +| Access-Restriction-Data | 1426 | 7.3.31 | Unsigned32 | M, V | | | | No | +| APN-OI-Replacement | 1427 | 7.3.32 | UTF8String | M, V | | | | No | +| All-APN-Configurations-Included-Indicator | 1428 | 7.3.33 | Enumerated | M, V | | | | No | +| APN-Configuration-Profile | 1429 | 7.3.34 | Grouped | M, V | | | | No | +| APN-Configuration | 1430 | 7.3.35 | Grouped | M, V | | | | No | +| EPS-Subscribed-QoS-Profile | 1431 | 7.3.37 | Grouped | M, V | | | | No | +| VPLMN-Dynamic-Address-Allowed | 1432 | 7.3.38 | Enumerated | M, V | | | | No | +| STN-SR | 1433 | 7.3.39 | OctetString | M, V | | | | No | +| Alert-Reason | 1434 | 7.3.83 | Enumerate | M, V | | | | No | +| AMBR | 1435 | 7.3.41 | Grouped | M, V | | | | No | +| CSG-Subscription-Data | 1436 | 7.3.78 | Grouped | M, V | | | | No | +| CSG-Id | 1437 | 7.3.79 | Unsigned32 | M, V | | | | No | +| PDN-GW-Allocation-Type | 1438 | 7.3.44 | Enumerated | M, V | | | | No | +| Expiration-Date | 1439 | 7.3.80 | Time | M, V | | | | No | +| RAT-Frequency-Selection-Priority-ID | 1440 | 7.3.46 | Unsigned32 | M, V | | | | No | +| IDA-Flags | 1441 | 7.3.47 | Unsigned32 | M, V | | | | No | +| PUA-Flags | 1442 | 7.3.48 | Unsigned32 | M, V | | | | No | +| NOR-Flags | 1443 | 7.3.49 | Unsigned32 | M, V | | | | No | +| User-Id | 1444 | 7.3.50 | UTF8String | V | | | M | No | +| Equipment-Status | 1445 | 7.3.51 | Enumerated | M, V | | | | No | +| Regional-Subscription-Zone-Code | 1446 | 7.3.52 | OctetString | M, V | | | | No | +| RAND | 1447 | 7.3.53 | OctetString | M, V | | | | No | +| XRES | 1448 | 7.3.54 | OctetString | M, V | | | | No | +| AUTN | 1449 | 7.3.55 | OctetString | M, V | | | | No | +| KASME | 1450 | 7.3.56 | OctetString | M, V | | | | No | +| Trace-Collection-Entity | 1452 | 7.3.98 | Address | M, V | | | | No | +| Kc | 1453 | 7.3.59 | OctetString | M, V | | | | No | +| SRES | 1454 | 7.3.60 | OctetString | M, V | | | | No | +| PDN-Type | 1456 | 7.3.62 | Enumerated | M, V | | | | No | + +| | | | | | | | | | +|---------------------------------------------------|------|---------|-------------|------|--|--|---|----| +| Roaming-Restricted-Due-To-Unsupported-Feature | 1457 | 7.3.81 | Enumerated | M, V | | | | No | +| Trace-Data | 1458 | 7.3.63 | Grouped | M, V | | | | No | +| Trace-Reference | 1459 | 7.3.64 | OctetString | M, V | | | | No | +| Trace-Depth | 1462 | 7.3.67 | Enumerated | M, V | | | | No | +| Trace-NE-Type-List | 1463 | 7.3.68 | OctetString | M, V | | | | No | +| Trace-Interface-List | 1464 | 7.3.69 | OctetString | M, V | | | | No | +| Trace-Event-List | 1465 | 7.3.70 | OctetString | M, V | | | | No | +| OMC-Id | 1466 | 7.3.71 | OctetString | M, V | | | | No | +| GPRS-Subscription-Data | 1467 | 7.3.72 | Grouped | M, V | | | | No | +| Complete-Data-List-Included-Indicator | 1468 | 7.3.73 | Enumerated | M, V | | | | No | +| PDP-Context | 1469 | 7.3.74 | Grouped | M, V | | | | No | +| PDP-Type | 1470 | 7.3.75 | OctetString | M, V | | | | No | +| 3GPP2-MEID | 1471 | 7.3.6 | OctetString | M, V | | | | No | +| Specific-APN-Info | 1472 | 7.3.82 | Grouped | M, V | | | | No | +| LCS-Info | 1473 | 7.3.84 | Grouped | M, V | | | | No | +| GMLC-Number | 1474 | 7.3.85 | OctetString | M, V | | | | No | +| LCS-PrivacyException | 1475 | 7.3.86 | Grouped | M, V | | | | No | +| SS-Code | 1476 | 7.3.87 | OctetString | M, V | | | | No | +| SS-Status | 1477 | 7.3.88 | OctetString | M, V | | | | No | +| Notification-To-UE-User | 1478 | 7.3.89 | Enumerated | M, V | | | | No | +| External-Client | 1479 | 7.3.90 | Grouped | M, V | | | | No | +| Client-Identity | 1480 | 7.3.91 | OctetString | M, V | | | | No | +| GMLC-Restriction | 1481 | 7.3.92 | Enumerated | M, V | | | | No | +| PLMN-Client | 1482 | 7.3.93 | Enumerated | M, V | | | | No | +| Service-Type | 1483 | 7.3.94 | Grouped | M, V | | | | No | +| ServiceTypeIdentity | 1484 | 7.3.95 | Unsigned32 | M, V | | | | No | +| MO-LR | 1485 | 7.3.96 | Grouped | M, V | | | | No | +| Teleservice-List | 1486 | 7.3.99 | Grouped | M, V | | | | No | +| TS-Code | 1487 | 7.3.100 | OctetString | M, V | | | | No | +| Call-Barring-Info | 1488 | 7.3.101 | Grouped | M, V | | | | No | +| SGSN-Number | 1489 | 7.3.102 | OctetString | M, V | | | | No | +| IDR-Flags | 1490 | 7.3.103 | Unsigned32 | M, V | | | | No | +| ICS-Indicator | 1491 | 7.3.104 | Enumerated | V | | | M | No | +| IMS-Voice-Over-PS-Sessions-Supported | 1492 | 7.3.106 | Enumerated | V | | | M | No | +| Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions | 1493 | 7.3.107 | Enumerated | V | | | M | No | +| Last-UE-Activity-Time | 1494 | 7.3.108 | Time | V | | | M | No | +| EPS-User-State | 149 | 7.3.110 | Grouped | V | | | M | No | +| EPS-Location-Information | 149 | 7.3.111 | Grouped | V | | | M | No | +| MME-User-State | 149 | 7.3.112 | Grouped | V | | | M | No | +| SGSN-User-State | 149 | 7.3.113 | Grouped | V | | | M | No | +| User-State | 149 | 7.3.114 | Enumerated | V | | | M | No | +| MME-Location Information | 160 | 7.3.115 | Grouped | V | | | M | No | +| SGSN-Location-Information | 160 | 7.3.116 | Grouped | V | | | M | No | + +| | | | | | | | | | +|-----------------------------------|------|---------|-------------|---|--|--|---|----| +| E-UTRAN-Cell-Global-Identity | 160 | 7.3.117 | OctetString | V | | | M | No | +| Tracking-Area-Identity | 160 | 7.3.118 | OctetString | V | | | M | No | +| Cell-Global-Identity | 160 | 7.3.119 | OctetString | V | | | M | No | +| Routing-Area-Identity | 160 | 7.3.120 | OctetString | V | | | M | No | +| Location-Area-Identity | 160 | 7.3.121 | OctetString | V | | | M | No | +| Service-Area-Identity | 160 | 7.3.122 | OctetString | V | | | M | No | +| Geographical-Information | 160 | 7.3.123 | OctetString | V | | | M | No | +| Geodetic-Information | 160 | 7.3.124 | OctetString | V | | | M | No | +| Current-Location-Retrieved | 161 | 7.3.125 | Enumerated | V | | | M | No | +| Age-Of-Location-Information | 161 | 7.3.126 | Unsigned32 | V | | | M | No | +| Active-APN | 161 | 7.3.127 | Grouped | V | | | M | No | +| Error-Diagnostic | 161 | 7.3.128 | Enumerated | V | | | M | No | +| Ext-PDP-Address | 1621 | 7.3.129 | Address | V | | | M | No | +| UE-SRVCC-Capability | 1615 | 7.3.130 | Enumerated | V | | | M | No | +| MPS-Priority | 1616 | 7.3.131 | Unsigned32 | V | | | M | No | +| VPLMN-LIPA-Allowed | 1617 | 7.3.132 | Enumerated | V | | | M | No | +| LIPA-Permission | 1618 | 7.3.133 | Enumerated | V | | | M | No | +| Subscribed-Periodic-RAU-TAU-Timer | 1619 | 7.3.134 | Unsigned32 | V | | | M | No | +| Ext-PDP-Type | 1620 | 7.3.75A | OctetString | V | | | M | No | +| SIPTO-Permission | 1613 | 7.3.135 | Enumerated | V | | | M | No | +| MDT-Configuration | 1622 | 7.3.136 | Grouped | V | | | M | No | +| Job-Type | 1623 | 7.3.137 | Enumerated | V | | | M | No | +| Area-Scope | 1624 | 7.3.138 | Grouped | V | | | M | No | +| List-Of-Measurements | 1625 | 7.3.139 | Unsigned32 | V | | | M | No | +| Reporting-Trigger | 1626 | 7.3.140 | Unsigned32 | V | | | M | No | +| Report-Interval | 1627 | 7.3.141 | Enumerated | V | | | M | No | +| Report-Amount | 1628 | 7.3.142 | Enumerated | V | | | M | No | +| Event-Threshold-RSRP | 1629 | 7.3.143 | Unsigned32 | V | | | M | No | +| Event-Threshold-RSRQ | 1630 | 7.3.144 | Unsigned32 | v | | | M | No | + +| | | | | | | | | | +|-------------------------------------|------|---------|------------------|------|--|--|---|----| +| Logging-Interval | 1631 | 7.3.145 | Enumerated | V | | | M | No | +| Logging-Duration | 1632 | 7.3.146 | Enumerated | V | | | M | No | +| Relay-Node-Indicator | 1633 | 7.3.147 | Enumerated | V | | | M | No | +| MDT-User-Consent | 1634 | 7.3.148 | Enumerated | V | | | M | No | +| PUR-Flags | 1635 | 7.3.149 | Unsigned32 | V | | | M | No | +| Subscribed-VSRVCC | 1636 | 7.3.150 | Enumerated | V | | | M | No | +| Equivalent-PLMN-List | 1637 | 7.3.151 | Grouped | V | | | M | No | +| CLR-Flags | 1638 | 7.3.152 | Unsigned32 | V | | | M | No | +| UVR-Flags | 1639 | 7.3.153 | Unsigned32 | M, V | | | | No | +| UVA-Flags | 1640 | 7.3.154 | Unsigned32 | M, V | | | | No | +| VPLMN-CSG-Subscription-Data | 1641 | 7.3.155 | Grouped | M, V | | | | No | +| Time-Zone | 1642 | 7.3.163 | UTF8String | V | | | M | No | +| A-MSISDN | 1643 | 7.3.157 | OctetString | V | | | M | No | +| MME-Number-for-MT-SMS | 1645 | 7.3.159 | OctetString | V | | | M | No | +| SMS-Register-Request | 1648 | 7.3.162 | Enumerated | V | | | M | No | +| Local-Time-Zone | 1649 | 7.3.156 | Grouped | V | | | M | No | +| Daylight-Saving-Time | 1650 | 7.3.164 | Enumerated | V | | | M | No | +| Subscription-Data-Flags | 1654 | 7.3.165 | Unsigned32 | V | | | M | No | +| Measurement-Period-LTE | 1655 | 7.3.166 | Enumerated | V | | | M | No | +| Measurement-Period-UMTS | 1656 | 7.3.167 | Enumerated | V | | | M | No | +| Collection-Period-RRM-LTE | 1657 | 7.3.168 | Enumerated | V | | | M | No | +| Collection-Period-RRM-UMTS | 1658 | 7.3.169 | Enumerated | V | | | M | No | +| Positioning-Method | 1659 | 7.3.170 | OctetString | V | | | M | No | +| Measurement-Quantity | 1660 | 7.3.171 | OctetString | V | | | M | No | +| Event-Threshold-Event-1F | 1661 | 7.3.172 | Integer32 | V | | | M | No | +| Event-Threshold-Event-1I | 1662 | 7.3.173 | Integer32 | V | | | M | No | +| Restoration-Priority | 1663 | 7.3.174 | Unsigned32 | V | | | M | No | +| SGs-MME-Identity | 1664 | 7.3.175 | UTF8String | V | | | M | No | +| SIPTO-Local-Network-Permission | 1665 | 7.3.176 | Unsigned32 | V | | | M | No | +| Coupled-Node-Diameter-ID | 1666 | 7.3.177 | DiameterIdentity | V | | | M | No | +| WLAN-offloadability | 1667 | 7.3.181 | Grouped | V | | | M | No | +| WLAN-offloadability-EUTRAN | 1668 | 7.3.182 | Unsigned32 | V | | | M | No | +| WLAN-offloadability-UTRAN | 1669 | 7.3.183 | Unsigned32 | V | | | M | No | +| Reset-ID | 1670 | 7.3.184 | OctetString | V | | | M | No | +| MDT-Allowed-PLMN-Id | 1671 | 7.3.185 | OctetString | V | | | M | No | +| Adjacent-PLMNs | 1672 | 7.3.186 | Grouped | V | | | M | No | +| Adjacent-Access-Restriction-Data | 1673 | 7.3.187 | Grouped | V | | | M | No | +| DL-Buffering-Suggested-Packet-Count | 1674 | 7.3.188 | Integer32 | V | | | M | No | +| IMSI-Group-Id | 1675 | 7.3.189 | Grouped | V | | | M | No | +| Group-Service-Id | 1676 | 7.3.190 | Unsigned32 | V | | | M | No | +| Group-PLMN-Id | 1677 | 7.3.191 | OctetString | V | | | M | No | +| Local-Group-Id | 1678 | 7.3.192 | OctetString | V | | | M | No | +| AIR-Flags | 1679 | 7.3.201 | Unsigned32 | V | | | M | No | +| UE-Usage-Type | 1680 | 7.3.202 | Unsigned32 | V | | | M | No | +| Non-IP-PDN-Type-Indicator | 1681 | 7.3.204 | Enumerated | V | | | M | No | +| Non-IP-Data-Delivery-Mechanism | 1682 | 7.3.205 | Unsigned32 | V | | | M | No | +| Additional-Context-ID | 1683 | 7.3.206 | Unsigned32 | V | | | M | No | +| SCEF-Realm | 1684 | 7.3.207 | DiameterIdentity | V | | | M | No | +| Subscription-Data-Deletion | 1685 | 7.3.208 | Grouped | V | | | M | No | +| Preferred-Data-Mode | 1686 | 7.3.209 | Unsigned32 | V | | | M | No | +| Emergency-Info | 1687 | 7.3.210 | Grouped | V | | | M | No | +| V2X-Subscription-Data | 1688 | 7.3.212 | Grouped | V | | | M | No | +| V2X-Permission | 1689 | 7.3.213 | Unsigned32 | V | | | M | No | +| PDN-Connection-Continuity | 1690 | 7.3.214 | Unsigned32 | V | | | M | No | +| eDRX-Cycle-Length | 1691 | 7.3.215 | Grouped | V | | | M | No | +| eDRX-Cycle-Length-Value | 1692 | 7.3.216 | OctetString | V | | | M | No | +| UE-PC5-AMBR | 1693 | 7.3.217 | Unsigned32 | V | | | M | No | +| MBSFN-Area | 1694 | 7.3.219 | Grouped | V | | | M | No | +| MBSFN-Area-ID | 1695 | 7.3.220 | Unsigned32 | V | | | M | No | +| Carrier-Frequency | 1696 | 7.3.221 | Unsigned32 | V | | | M | No | + +| | | | | | | | | | +|------------------------------------------|------|---------|-------------|---|--|--|---|----| +| RDS-Indicator | 1697 | 7.3.222 | Enumerated | V | | | M | No | +| Service-Gap-Time | 1698 | 7.3.223 | Unsigned32 | V | | | M | No | +| Aerial-UE-Subscription-Information | 1699 | 7.3.224 | Unsigned32 | V | | | M | No | +| Broadcast-Location-Assistance-Data-Types | 1700 | 7.3.225 | Unsigned64 | V | | | M | No | +| Paging-Time-Window | 1701 | 7.3.226 | Grouped | V | | | M | No | +| Operation-Mode | 1702 | 7.3.227 | Unsigned32 | V | | | M | No | +| Paging-Time-Window-Length | 1703 | 7.3.228 | OctetString | V | | | M | No | +| Core-Network-Restrictions | 1704 | 7.3.230 | Unsigned32 | V | | | M | No | +| eDRX-Related-RAT | 1705 | 7.3.229 | Grouped | V | | | M | No | +| Interworking-5GS-Indicator | 1706 | 7.3.231 | Enumerated | V | | | M | No | +| Ethernet-PDN-Type-Indicator | 1707 | 7.3.232 | Enumerated | V | | | M | No | +| Subscribed-ARPI | 1708 | 7.3.233 | Unsigned32 | V | | | M | No | +| IAB-Operation-Permission | 1709 | 7.3.234 | Enumerated | V | | | M | No | +| V2X-Subscription-Data-Nr | 1710 | 7.3.235 | Grouped | V | | | M | No | +| UE-PC5-QoS | 1711 | 7.3.236 | Grouped | V | | | M | No | +| PC5-QoS-Flow | 1712 | 7.3.237 | Grouped | V | | | M | No | +| 5QI | 1713 | 7.3.238 | Integer32 | V | | | M | No | +| PC5-Flow-Bitrates | 1714 | 7.3.239 | Grouped | V | | | M | No | +| Guaranteed-Flow-Bitrates | 1715 | 7.3.240 | Integer32 | V | | | M | No | +| Maximum-Flow-Bitrates | 1716 | 7.3.241 | Integer32 | V | | | M | No | +| PC5-Range | 1717 | 7.3.242 | Integer32 | V | | | M | No | +| PC5-Link-AMBR | 1718 | 7.3.243 | Integer32 | V | | | M | No | +| Third-Context-Identifier | 1719 | 7.3.244 | Unsigned32 | V | | | M | No | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [61]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table specifies the Diameter AVPs re-used by the S6a/S6d interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within S6a and S6d. + +Any other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol specified in IETF RFC 6733 [61], do not need to be supported. The AVPs from the Diameter base protocol specified in IETF RFC 6733 [61] are not included in table 7.3.1/2, but they may be re-used for the S6a/S6d protocol, the S7a/S7 protocol and the S13/S13' protocol. + +**Table 7.3.1/2: S6a/S6d, S7a/S7d and S13/S13' re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | M-bit | +|-------------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Service-Selection | IETF RFC 5778 [20] | See clause 7.3.36 | | +| 3GPP-Charging-Characteristics | 3GPP TS 29.061 [21] | See 3GPP TS 32.251 [33] Annex A and 3GPP TS 32.298 [22] clause 5.1.2.2.7
This attribute holds the EPS PDN Connection Charging Characteristics data for an EPS APN Configuration, or the PDP context Charging Characteristics for GPRS PDP context, or the Subscribed Charging Characteristics data for the subscriber level 3GPP Charging Characteristics; refer to 3GPP TS 23.008 [30]. | | +| Supported-Features | 3GPP TS 29.229 [9] | | | +| Feature-List-ID | 3GPP TS 29.229 [9] | | | +| Feature-List | 3GPP TS 29.229 [9] | See clause 7.3.10 | | +| Served-Party-IP-Address | 3GPP TS 32.299 [8] | holds the PDN IP Address of the user | | +| QoS-Class-Identifier | 3GPP TS 29.212 [10] | | | +| Allocation-Retention-Priority | 3GPP TS 29.212 [10] | See clause 7.3.40 | | +| Priority-Level | 3GPP TS 29.212 [10] | | | +| Pre-emption-Capability | 3GPP TS 29.212 [10] | | | +| Pre-emption-Vulnerability | 3GPP TS 29.212 [10] | | | +| Max-Requested-Bandwidth-DL | 3GPP TS 29.214 [11] | | | +| Max-Requested-Bandwidth-UL | 3GPP TS 29.214 [11] | | | +| Extended-Max-Requested-BW-DL | 3GPP TS 29.214 [11] | | | +| Extended-Max-Requested-BW-UL | 3GPP TS 29.214 [11] | | | +| RAT-Type | 3GPP TS 29.212 [10] | See clause 7.3.13 | Must set | +| MSISDN | 3GPP TS 29.329 [25] | | | +| MIP6-Agent-Info | IETF RFC 5447 [26] | | | +| MIP-Home-Agent-Address | IETF RFC 4004 [27] | | | +| MIP-Home-Agent-Host | IETF RFC 4004 [27] | | | +| PDP-Address | 3GPP TS 32.299 [8] | | | +| Confidentiality-Key | 3GPP TS 29.229 [9] | See clause 7.3.57 | | +| Integrity-Key | 3GPP TS 29.229 [9] | See clause 7.3.58 | | +| Visited-Network-Identifier | 3GPP TS 29.229 [9] | See clause 7.3.105 | Must not set | +| GMLC-Address | 3GPP TS 29.173 [37] | See clause 7.3.109 | Must not set | +| User-CSG-Information | 3GPP TS 32.299 [8] | | Must not set | +| ProSe-Subscription-Data | 3GPP TS 29.344 [49] | See clause 7.3.180 | Must not set | +| OC-Supported-Features | IETF RFC 7683 [50] | See clause 7.3.178 | Must not set | +| OC-OLR | IETF RFC 7683 [50] | See clause 7.3.179 | Must not set | +| SCEF-Reference-ID | 3GPP TS 29.336 [54] | | Must not set | + +| Attribute Name | Reference | Comments | M-bit | +|------------------------------------|---------------------|---------------------|--------------| +| SCEF-ID | 3GPP TS 29.336 [54] | | Must not set | +| AESE-Communication-Pattern | 3GPP TS 29.336 [54] | see clause 7.3.193 | Must not set | +| Communication-Pattern-set | 3GPP TS 29.336 [54] | see clause 7.3.194 | Must not set | +| Monitoring-Event-Configuration | 3GPP TS 29.336 [54] | See clause 7.3.195 | Must not set | +| Monitoring-Event-Report | 3GPP TS 29.336 [54] | See clause 7.3.196 | Must not set | +| UE-Reachability-Configuration | 3GPP TS 29.336 [54] | See clause 7.3.197 | Must not set | +| eNodeB-ID | 3GPP TS 29.217 [56] | See clause 7.3.198 | Must not set | +| SCEF-Reference-ID-for-Deletion | 3GPP TS 29.336 [54] | | Must not set | +| Monitoring-Type | 3GPP TS 29.336 [54] | | Must not set | +| Maximum-Number-of-Reports | 3GPP TS 29.336 [54] | | Must not set | +| Monitoring-Duration | 3GPP TS 29.336 [54] | | Must not set | +| Charged-Party | 3GPP TS 29.336 [54] | | Must not set | +| Location-Information-Configuration | 3GPP TS 29.336 [54] | | Must not set | +| Reachability-Type | 3GPP TS 29.336 [54] | | Must not set | +| Maximum-Response-Time | 3GPP TS 29.336 [54] | | Must not set | +| Reachability-Information | 3GPP TS 29.336 [54] | | Must not set | +| Reachability-Cause | 3GPP TS 29.128 [63] | | Must not set | +| Monitoring-Event-Config-Status | 3GPP TS 29.336 [54] | | Must not set | +| Supported-Services | 3GPP TS 29.336 [54] | See clause 7.3.199 | Must not set | +| Supported-Monitoring-Events | 3GPP TS 29.336 [54] | See clause 7.3.200 | Must not set | +| DRMP | IETF RFC 7944 [57] | See clause 7.3.203 | Must not set | +| Reference-ID-Validity-Time | 3GPP TS 29.336 [54] | | Must not set | +| Maximum-UE-Availability-Time | 3GPP TS 29.338 [48] | See clause 5.3.3.22 | Must not set | +| Emergency-Services | 3GPP TS 29.273 [59] | | | +| Load | IETF RFC 8583 [60] | See clause 7.3.211 | Must not set | +| Extended-eNodeB-ID | 3GPP TS 29.217 [56] | See clause 7.3.218 | Must not set | +| External-Identifier | 3GPP TS 29.336 [54] | | Must not set | + +| Attribute Name | Reference | Comments | M-bit | +|---------------------------------------|---------------------|--------------------|-------------------| +| Loss-Of-Connectivity-Reason | 3GPP TS 29.336 [54] | | Must not set | +| Active-Time | 3GPP TS 29.128 [63] | | Must not set | +| Idle-Status-Indication | 3GPP TS 29.128 [63] | | Must not set | +| MTC-Provider-Info | 3GPP TS 29.336 [54] | | Must not set | +| Traffic-Profile | 3GPP TS 29.336 [54] | | Must not set | +| PDN-Connectivity-Status-Configuration | 3GPP TS 29.336 [54] | See clause 7.3.195 | Must not set | +| PDN-Connectivity-Status-Report | 3GPP TS 29.336 [54] | See clause 7.3.196 | Must not set | +| Battery-Indicator | 3GPP TS 29.336 [54] | | Battery-Indicator | +| SCEF-Reference-ID-Ext | 3GPP TS 29.336 [54] | | Must not set | +| SCEF-Reference-ID-for-Deletion-Ext | 3GPP TS 29.336 [54] | | Must not set | + +NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +### 7.3.2 Subscription-Data + +The Subscription-Data AVP is of type Grouped. It shall contain the information related to the user profile relevant for EPS and GERAN/UTRAN. + +AVP format: + +Subscription-Data ::= + +[ Subscriber-Status ] + +[ MSISDN ] + +[ A-MSISDN ] + +[ STN-SR ] + +[ ICS-Indicator ] + +[ Network-Access-Mode ] + +[ Operator-Determined-Barring ] + +[ HPLMN-ODB ] + +\*10[ Regional-Subscription-Zone-Code ] + +[ Access-Restriction-Data ] + +[ APN-OI-Replacement ] + +[ LCS-Info ] + +[ Teleservice-List ] + +\*[ Call-Barring-Info ] + +[ 3GPP-Charging-Characteristics ] + +[ AMBR ] + +[ APN-Configuration-Profile ] + +[ RAT-Frequency-Selection-Priority-ID ] + +[ Trace-Data ] + +[ GPRS-Subscription-Data ] + +\*[ CSG-Subscription-Data ] + +[ Roaming-Restricted-Due-To-Unsupported-Feature ] + +[ Subscribed-Periodic-RAU-TAU-Timer ] + +[ MPS-Priority ] + +[ VPLMN-LIPA-Allowed ] + +[ Relay-Node-Indicator ] + +[ MDT-User-Consent ] + +[ Subscribed-VSRVCC ] + +[ ProSe-Subscription-Data ] + +[ Subscription-Data-Flags ] + +\*[ Adjacent-Access-Restriction-Data ] +[ DL-Buffering-Suggested-Packet-Count ] +\*[ IMSI-Group-Id ] +[ UE-Usage-Type ] +\*[ AESE-Communication-Pattern ] +\*[ Monitoring-Event-Configuration ] +[ Emergency-Info ] +[ V2X-Subscription-Data ] +[ V2X-Subscription-Data-Nr ] +\*[ eDRX-Cycle-Length ] +[ External-Identifier ] +[ Active-Time ] +[ Service-Gap-Time ] +[ Broadcast-Location-Assistance-Data-Types ] +[ Aerial-UE-Subscription-Information ] +[ Core-Network-Restrictions ] +\*[ Paging-Time-Window ] +[ Subscribed-ARPI ] +[ IAB-Operation-Permission ] +\*[ AVP ] + +The AMBR included in this grouped AVP shall include the AMBR associated to the user's subscription (UE-AMBR); Max-Requested-Bandwidth-UL and Max-Requested-Bandwidth-DL within this AVP shall not both be set to "0". + +The APN-OI-Replacement included in this grouped AVP shall include the UE level APN-OI-Replacement associated to the user's subscription. + +When multiple External Identifiers are defined for the same subscription, the External-Identifier in this grouped AVP shall contain a default External Identifier determined by the HSS. + +### 7.3.3 Terminal-Information + +The Terminal-Information AVP is of type Grouped. This AVP shall contain the information about the user's terminal. + +AVP format + +Terminal-Information ::= + +[ IMEI ] +[ 3GPP2-MEID ] +[ Software-Version ] +\*[ AVP ] + +### 7.3.4 IMEI + +The IMEI AVP is of type UTF8String. This AVP shall contain the International Mobile Equipment Identity, as specified in 3GPP TS 23.003 [3]. It should consist of 14 digits, including the 8-digit Type Allocation Code (TAC) and the 6-digit Serial Number (SNR). It may also include a 15th digit. + +### 7.3.5 Software-Version + +The Software-Version AVP is of type UTF8String. This AVP shall contain the 2-digit Software Version Number (SVN) of the International Mobile Equipment Identity, as specified in 3GPP TS 23.003 [3]. + +### 7.3.6 3GPP2-MEID + +This AVP is of type OctetString. This AVP contains the Mobile Equipment Identifier of the user's terminal. For further details on the encoding of the AVP data, refer to the encoding of the Mobile Identity (MEID) octets 3 to 10 in 3GPP2 A.S0022 [28] Annex A. + +### 7.3.7 ULR-Flags + +The ULR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.7/1: + +**Table 7.3.7/1: ULR-Flags** + +| Bit | Name | Description | +|-----------------------------------------------------------------------------------------------------------------------|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Single-Registration-Indication | This bit, when set, indicates that the HSS shall send Cancel Location to the SGSN. An SGSN shall not set this bit when sending ULR. | +| 1 | S6a/S6d-Indicator | This bit, when set, indicates that the ULR message is sent on the S6a interface, i.e. the source node is an MME (or a combined MME/SGSN to which the UE is attached via E-UTRAN).
This bit, when cleared, indicates that the ULR message is sent on the S6d interface, i.e. the source node is an SGSN (or a combined MME/SGSN to which the UE is attached via UTRAN or GERAN). | +| 2 | Skip Subscriber Data | This bit, when set, indicates that the HSS may skip subscription data in ULA. If the subscription data has changed in the HSS after the last successful update of the MME/SGSN, the HSS shall ignore this bit and send the updated subscription data. If the HSS effectively skips the sending of subscription data, the GPRS-Subscription-Data-Indicator flag can be ignored. | +| 3 | GPRS-Subscription-Data-Indicator | This bit, when set, indicates that the HSS shall include in the ULA command the GPRS subscription data, if available in the HSS; it shall be included in the GPRS-Subscription-Data AVP inside the Subscription-Data AVP (see 7.3.2).
Otherwise, the HSS shall not include the GPRS-Subscription-Data AVP in the response, unless the Update Location Request is received over the S6d interface and there is no APN configuration profile stored for the subscriber, or when the subscription data is returned by a Pre-Rel-8 HSS (via an IWF).
A standalone MME shall not set this bit when sending a ULR. | +| 4 | Node-Type-Indicator | This bit, when set, indicates that the requesting node is a combined MME/SGSN.
This bit, when cleared, indicates that the requesting node is a single MME or SGSN; in this case, if the S6a/S6d-Indicator is set, the HSS may skip the check of those supported features only applicable to the SGSN, and if, in addition the MME does not request to be registered for SMS, the HSS may consequently skip the download of the SMS related subscription data to a standalone MME. NOTE2 | +| 5 | Initial-Attach-Indicator | This bit, when set, indicates that the HSS shall send Cancel Location to the MME or SGSN if there is the MME or SGSN registration. | +| 6 | PS-LCS-Not-Supported-By-UE | This bit, when set, indicates to the HSS that the UE does not support neither UE Based nor UE Assisted positioning methods for Packet Switched Location Services. The MME shall set this bit on the basis of the UE capability information. The SGSN shall set this bit on the basis of the UE capability information and the access technology supported by the SGSN. | +| 7 | SMS-Only-Indication | This bit, when set, indicates that the UE indicated "SMS only" when requesting a combined IMSI attach or combined RA/LU. | +| 8 | Dual-Registration-5G-Indicator | This bit, when set by an MME over S6a interface, indicates that the HSS+UDM shall not send Nudm_UECM_DeregistrationNotification to the registered AMF (if any); when not set by an MME over S6a interface, it indicates that the HSS+UDM shall send Nudm_UECM_DeregistrationNotification to the registered AMF (if any). See 3GPP TS 29.503 [66].

An SGSN shall not set this bit when sending ULR over S6d interface. | +| 9 | Inter-PLMN-inter-MME handover | This bit, when set by an MME over S6a interface, indicates that an inter PLMN inter MME (or AMF to MME) handover is ongoing. | +| 10 | Intra-PLMN-inter-MME handover | This bit, when set by an MME over S6a interface, indicates that an intra PLMN inter MME (or AMF to MME) handover is ongoing. | +| NOTE1: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving HSS. | | | +| NOTE2: If the MME is registered for SMS then the HSS will download the SMS related data also for the standalone MME. | | | + +## 7.3.8 ULA-Flags + +The ULA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.8/1: + +**Table 7.3.8/1: ULA-Flags** + +| Bit | Name | Description | +|-------|----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Separation Indication | This bit, when set, indicates that the HSS stores SGSN number and MME number in separate memory. A Rel-8 HSS shall set the bit. An IWF interworking with a pre Rel-8 HSS/HLR shall clear the bit. | +| 1 | MME Registered for SMS | This bit, when set, indicates that the HSS has registered the MME for SMS. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | + +## 7.3.9 Visited-PLMN-Id + +The Visited-PLMN-Id AVP is of type OctetString. This AVP shall contain the concatenation of MCC and MNC. See 3GPP TS 23.003 [3]. The content of this AVP shall be encoded as an octet string according to table 7.3.9-1. + +See 3GPP TS 24.008 [31], clause 10.5.1.13, PLMN list, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 2 are coded as "1111". + +**Table 7.3.9/1: Encoding format for Visited-PLMN-Id AVP** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---|---|---|---|---|---|---|---|--| +| | | | | | | | | | +| | | | | | | | | | +| | | | | | | | | | + +## 7.3.10 Feature-List AVP + +### 7.3.10.1 Feature-List AVP for the S6a/S6d application + +The syntax of this AVP is defined in 3GPP TS 29.229 [9]. + +For the S6a/S6d application, the meaning of the bits shall be as defined in table 7.3.10/1 for the Feature-List-ID 1 and in table 7.3.10/2 for the Feature-List-ID 2. + +**Table 7.3.10/1: Features of Feature-List-ID 1 used in S6a/S6d** + +| Feature bit | Feature | M/O | Description | +|-------------|--------------------------------------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | ODB-all-APN | O | Operator Determined Barring of all Packet Oriented Services

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update by sending DIAMETER_ERROR_ROAMING_NOT_ALLOWED and, optionally, including the type of ODB in the Error-Diagnostic AVP. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 1 | ODB-HPLMN-APN | O | Operator Determined Barring of Packet Oriented Services from access points that are within the HPLMN whilst the subscriber is roaming in a VPLMN

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update by sending DIAMETER_ERROR_ROAMING_NOT_ALLOWED and, optionally, including the type of ODB in the Error-Diagnostic AVP. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 2 | ODB-VPLMN-APN | O | Operator Determined Barring of Packet Oriented Services from access points that are within the roamed to VPLMN

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update by sending DIAMETER_ERROR_ROAMING_NOT_ALLOWED and, optionally, including the type of ODB in the Error-Diagnostic AVP. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 3 | ODB-all-OG | O | Operator Determined Barring of all outgoing calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 4 | ODB-all-InternationalOG | O | Operator Determined Barring of all outgoing international calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 5 | ODB-all-InternationalOGNot ToHPLMN-Country | O | Operator Determined Barring of all outgoing international calls except those directed to the home PLMN country

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | + +| | | | | +|----|-------------------------------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 6 | ODB-all-Interzonal OG | O | Operator Determined Barring of all outgoing inter-zonal calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update.
If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 7 | ODB-all-Interzonal OGNotTo HPLMN-Country | O | Operator Determined Barring of all outgoing inter-zonal calls except those directed to the home PLMN country

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update.
If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 8 | ODB-all-Interzonal OGAndInternational OGNotTo HPLMN-Country | O | Operator Determined Barring of all outgoing international calls except those directed to the home PLMN country and Barring of all outgoing inter-zonal calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update.
If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 9 | RegSub | O | Regional Subscription

This feature is applicable for the ULR/ULA, IDR/IDA and DSR/DSA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send Regional Subscription Zone Codes to the MME or SGSN within ULA. Instead the HSS may reject location update.
If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent Regional Subscription Zone Codes within IDR, the HSS may apply barring of roaming and send CLR. | +| 10 | Trace | O | Trace Function

This feature is applicable for the ULR/ULA, IDR/IDA and DSR/DSA command pairs.
If the MME or SGSN does not indicate support of this feature in ULR, the HSS shall not send Trace Data to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent Trace Data within IDR, the HSS may store this indication, and not send any further Trace Data to that MME or SGSN.

If the MME or SGSN does not indicate support of this feature in DSA, and the HSS has sent Trace Data within DSR, the HSS may store this indication, and not send any further Trace Data to that MME or SGSN | +| 11 | LCS-all-PrivExcep (NOTE 1) | O | All LCS Privacy Exception Classes

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN. | + +| | | | | +|----|--------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 12 | LCS-Universal
(NOTE 1) | O |

Allow location by any LCS client

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 13 | LCS-CallSessionRelated
(NOTE 1) | O |

Allow location by any value added LCS client to which a call/session is established from the target UE

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 14 | LCS-CallSessionUnrelated
(NOTE 1) | O |

Allow location by designated external value added LCS clients

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 15 | LCS-PLMNOperator
(NOTE 1) | O |

Allow location by designated PLMN operator LCS clients

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 16 | LCS-ServiceType
(NOTE 1) | O |

Allow location by LCS clients of a designated LCS service type

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 17 | LCS-all-MOLR-SS
(NOTE 1) | O |

All Mobile Originating Location Request Classes

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. Over S6d interface, this feature is applicable when the SGSN supports MAP based Lg interface.
If the MME or SGSN does not support this feature, the HSS shall not send the related LCS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that MME or SGSN.

| + +| | | | | +|----|-------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 18 | LCS-BasicSelf Location (NOTE 1) | O |

Allow an MS to request its own location

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. Over S6d interface, this feature is applicable when the SGSN supports MAP based Lg interface. If the MME or SGSN does not support this feature, the HSS shall not send the related LCS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that MME or SGSN.

| +| 19 | LCS-AutonomousSelfLocation (NOTE 1) | O |

Allow an MS to perform self location without interaction with the PLMN

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. Over S6d interface, this feature is applicable when the SGSN supports MAP based Lg interface. If the MME or SGSN does not support this feature, the HSS shall not send the related LCS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that MME or SGSN.

| +| 20 | LCS-TransferToThirdParty | O |

Allow an MS to request transfer of its location to another LCS client

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. Over S6d interface, this feature is applicable when the SGSN supports MAP based Lg interface. If the MME or SGSN does not support this feature, the HSS shall not send the related LCS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that MME or SGSN.

| +| 21 | SM-MO-PP (NOTE 1) | O |

Short Message MO-PP

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| +| 22 | Barring-Outgoing Calls | O |

Barring of Outgoing Calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| +| 23 | BAOC | O |

Barring of all outgoing calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| + +| | | | | +|----|--------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 24 | BOIC | O |

Barring of outgoing international calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| +| 25 | BOICExHC | O |

Barring of outgoing international calls except those directed to the home PLMN Country

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| +| 26 | UE-Reachability-Notification | O |

UE Reachability Notification

This feature is applicable for the ULR/ULA and IDR/IDA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support the UE-Reachability-Notifications, the HSS shall not set the "UE-Reachability-Request" bit in IDR-Flags in subsequent IDR commands towards that MME or SGSN.

| +| 27 | T-ADS Data Retrieval | O |

Terminating Access Domain Selection Data Retrieval

This feature is applicable for the ULR/ULA and IDR/IDA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support the retrieval of T-ADS data via IDR/IDA commands, the HSS shall not set the "T-ADS Data Request" bit in IDR-Flags in subsequent IDR commands towards that MME or SGSN.

| +| 28 | State/Location-Information-Retrieval | O |

State/Location Information Retrieval

This feature is applicable for the ULR/ULA and IDR/IDA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support State/Location Information Retrieval, the HSS shall not set the "EPS User State Request", "EPS Location Information Request" or "Current Location Request" bits in IDR-Flags in subsequent IDR commands towards that MME or SGSN.

| +| 29 | Partial Purge | O |

Partial Purge from a Combined MME/SGSN

This feature is applicable for the ULR/ULA and PUR/PUA command pairs, over S6a and S6d.

If the HSS indicates in the ULA command that it does not support Partial Purge, the combined MME/SGSN shall not include in the PUR command the indication of the specific serving node where the Purge has been done.

| +| 30 | Local Time Zone Retrieval | O |

UE Time Zone Retrieval

This feature is applicable for the ULR/ULA and IDR/IDA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support the retrieval of Local Time Zone via IDR/IDA commands, the HSS shall not set the "Local Time Zone Request" bit in IDR-Flags in subsequent IDR commands towards that MME or SGSN.

| + +| | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 31 | Additional MSISDN | O |

Additional MSISDN

This feature is applicable for the ULR/ULA, IDR/IDA and DSR/DSA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support A-MSISDN, the HSS shall populate the MSISDN AVP either with the subscribed MSISDN or the subscribed additional MSISDN based on operator policy and availability and the HSS shall not send IDR with the A-MSISDN AVP or DSR with the "A-MSISDN Withdrawal" bit to the serving nodes when the subscription data is changed.

If the MME or SGSN indicates in the IDA command that it does not support this feature and the HSS has already sent an A-MSISDN value within IDR, the HSS may store this indication and not send any further A-MSISDN updates to that MME or SGSN.

| +| Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "ODB-HPLMN-APN".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.
NOTE 1: If both bits, corresponding to the feature defined for Lg interface and Lgd interface respectively, are not set, and the HSS supports the feature, the HSS shall not send the related LCS information to the SGSN within ULA and IDR. | | | | + +**Table 7.3.10/2: Features of Feature-List-ID 2 used in S6a/S6d** + +| Feature bit | Feature | M/O | Description | +|-------------|---------------------------------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | SMS in MME | O |

SMS in MME

This feature is applicable for the ULR/ULA, IDR/IDA, DSR/DSA, NOR/NOA command pairs, over S6a.

It is used by the MME to notify the HSS it is capable of SMS transfer without the need of establishing an SGs association with an MSC.

If the MME does not support this feature, the HSS shall not send the related SMS information to the MME within ULA.

If the MME does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME.

If the HSS does not support this feature, the HSS shall ignore any request for a registration for SMS; the MME may store this feature indication, and not send any further request for a registration for SMS to the HSS.

| +| 1 | SMS in SGSN | O |

SMS in SGSN

This feature is applicable for the ULR/ULA command pair, over S6d.

If the SGSN indicates in the ULR command that it does not support this feature, the HSS shall not indicate "SMS in SGSN Allowed" to the SGSN.

| +| 2 | Dia-LCS-all-PrivExcep (NOTE 1) | O |

All LCS Privacy Exception Classes

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 3 | Dia-LCS-Universal (NOTE 1) | O |

Allow location by any LCS client

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 4 | Dia-LCS-CallSessionRelated (NOTE 1) | O |

Allow location by any value added LCS client to which a call/session is established from the target UE

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 5 | Dia-LCS-CallSessionUnrelated (NOTE 1) | O |

Allow location by designated external value added LCS clients

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| + +| | | | | +|----|--------------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 6 | Dia-LCS-PLMNOperator
(NOTE 1) | O |

Allow location by designated PLMN operator LCS clients

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 7 | Dia-LCS-ServiceType
(NOTE 1) | O |

Allow location by LCS clients of a designated LCS service type

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 8 | Dia-LCS-all-MOLR-SS
(NOTE 1) | O |

All Mobile Originating Location Request Classes

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 9 | Dia-LCS-BasicSelfLocation
(NOTE 1) | O |

Allow an MS to request its own location

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 10 | Dia-LCS-AutonomousSelfLocation
(NOTE 1) | O |

Allow an MS to perform self location without interaction with the PLMN

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 11 | Dia-LCS-TransferToThirdParty
(NOTE 1) | O |

Allow an MS to request transfer of its location to another LCS client

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 12 | Gdd-in-SGSN | O |

Support of Diameter based Gdd interface for SMS in SGSN

This feature is applicable for the ULR/ULA command pair over S6d, when the SGSN supports the Diameter based Gdd interface for SMS in SGSN.

| + +| | | | | +|----|----------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 13 | Optimized-LCS-Proc-Support | O |

Support for the optimized LCS procedure

This feature is applicable for the ULR/ULA command pair over S6a/S6d, when the network supports ISR and when the node is combined MME/SGSN and supports optimized LCS procedure as described in 3GPP TS 29.172 [47] clause 6.2.2.

| +| 14 | SGSN CAMEL Capability | O |

Support of SGSN CAMEL Capability

This feature is applicable for the ULR/ULA command pair over S6d, when the SGSN supports the CAMEL capability.

| +| 15 | ProSe Capability | O |

Support of ProSe Capability

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over S6a (and S6d), when the MME (or combined MME/SGSN) supports the ProSe capability.
If the MME or combined MME/SGSN does not support this feature, the HSS shall not send the related ProSe subscription data to the MME or combined MME/SGSN within ULA.

If the MME or combined MME/SGSN does not indicate support of this feature in IDA, and the HSS has sent the related ProSe subscription data within IDR, the HSS may store this indication, and not send any further ProSe subscription data to that MME.

| +| 16 | P-CSCF Restoration | O |

Support of P-CSCF Restoration

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a or S6d interfaces, when the MME or SGSN supports the execution of the P-CSCF restoration procedures.

If the MME or the SGSN does not indicate support of this feature in ULR, the HSS shall not send subsequent IDR commands requesting the execution of HSS-based P-CSCF restoration procedures, as described in 3GPP TS 23.380 [51] clause 5.4.

| +| 17 | Reset-IDs | O |

Support of Reset-IDs

This feature is applicable to the ULR/ULA and IDR/IDA and DSR/DSA and RSR/RSA command pairs over the S6a and S6d interfaces.

If the MME or SGSN indicates in the ULR command that it does not support Reset-IDs, the HSS shall not include Reset-ID AVPs in RSR commands sent to that MME or SGSN.

If the MME or SGSN indicates that it does not support this feature in IDA, and the HSS has already sent a Reset-ID value within IDR, the HSS may store this indication and not send any further Reset-ID updates to that MME or SGSN.

| +| 18 | Communication-Pattern | O |

Support of AESE communication patterns

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over S6a (and S6d), when the MME (or combined MME/SGSN) supports the AESE communication patterns.

If the MME or combined MME/SGSN does not indicate the support for this feature, the HSS shall not send CP parameter sets to the MME or combined MME/SGSN within IDR/ULA command.

If the MME or combined MME/SGSN indicates that it does not support this feature in IDA, and the HSS has already sent CP parameter sets within IDR, the HSS may store this indication and not send any further updates related to CP parameter sets to that MME or combined MME/SGSN.

| + +| | | | | +|----|-------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 19 | Monitoring-Event | O |

Support of Monitoring Event

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a or S6d interfaces, when the MME or SGSN supports the Monitoring event feature.

If the MME or SGSN does not indicate support of this feature in ULR, the HSS shall not send Monitoring event configuration data to the MME or SGSN within ULA and shall not send subsequent IDR commands requesting the configuration of Monitoring events in the MME or SGSN.

If the MME or SGSN indicates that it does not support this feature in IDA, and the HSS has already sent Monitoring event configuration data within IDR, the HSS may store this indication and not send any further updates related to Monitoring events to that MME or SGSN.

| +| 20 | Dedicated Core Networks | O |

Support of Dedicated Core Networks

This feature is applicable to the ULR/ULA, IDR/IDA and DSR/DSA command pairs over the S6a and S6d interfaces.

If the MME/SGSN does not indicate support of this feature in the ULR command, the HSS shall not send DCN-related subscription data (e.g., UE Usage Type) in ULA, and shall not send subsequent IDR or DSR commands when such subscription data are updated.

If the MME/SGSN does not indicate support of this feature in the IDA command and the HSS has already sent DCN-related subscription data in IDR, the HSS may store this indication and not send further updates related to DCN subscription data.

| +| 21 | Non-IP PDN Type APNs | O |

Support of Non-IP PDN Type APNs

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a and S6d interfaces.

If the MME/SGSN does not indicate support of this feature in the ULR command, the HSS shall not send APN configurations with a Non-IP PDN type in the subscription data sent in ULA or in IDR, and shall not send IDR commands with the only purpose to update such subscription data.

If the MME or SGSN indicates in the IDA command that it does not support this feature, and the HSS has already sent Non-IP PDN Type APNs within IDR, the HSS may store this indication, and not send any further updates related to Non-IP PDN Type APNs to that MME or SGSN.

| +| 22 | Non-IP PDP Type APNs | O |

Support of Non-IP PDP Type APNs

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a/S6d interface.

If the MME/SGSN does not indicate support of this feature in the ULR command, the HSS shall not send PDP contexts (as part of the GPRS-Subscription-Data) with a Non-IP PDP type in the subscription data sent in ULA or in IDR, and shall not send IDR commands with the only purpose to update such subscription data.

If the MME or SGSN indicates in the IDA command that it does not support this feature, and the HSS has already sent Non-IP PDP Type APNs within IDR, the HSS may store this indication, and not send any further updates related to Non-IP PDP Type APNs to that MME or SGSN.

| +| 23 | Removal of MSISDN | O |

Support of Removal of MSISDN

This feature is applicable to the ULR/ULA and DSR/DSA command pairs over the S6a/S6d interface.

If the MME/SGSN does not indicate support of this feature in the ULR command, the HSS shall not send DSR with the "MSISDN Withdrawal" bit set, to remove an existing MSISDN value from the subscription profile stored in the MME/SGSN.

| + +| | | | | +|----|------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 24 | Emergency Service Continuity | O |

Support of Emergency Services Continuity

This feature is applicable to the ULR/ULA, NOR/NOA and IDR/IDA command pairs over the S6a interface, when the HSS and the MME support the continuity of emergency services upon mobility between 3GPP and WLAN accesses, as specified in 3GPP TS 23.401 [2], or continuity of emergency services upon mobility between EPS and 5GS without N26 interface, as specified in 3GPP TS 23.502 [67].

If the MME does not indicate support of this feature in a former ULR command, the HSS shall not include the Emergency Info in an ULA command and shall not send an IDR command to update the PGW in use for emergency services.

If the HSS does not indicate support of this feature in a former ULA command, the MME shall not send a NOR command to update the PGW in use for emergency services.

If the HSS supports this feature on S6a, it shall also support the Emergency Service Continuity feature on SWx, see 3GPP TS 29.273 [59].

| +| 25 | V2X Capability | O |

Support of V2X Service

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over S6a (and S6d), when the MME (or combined MME/SGSN) supports the V2X service.

If the MME or combined MME/SGSN does not support this feature, the HSS shall not send the related V2X subscription data to the MME or combined MME/SGSN within ULA.

If the MME or combined MME/SGSN does not indicate support of this feature in IDA, and the HSS has sent the related V2X subscription data within IDR, the HSS may store this indication, and not send any further V2X subscription data to that MME or that combined MME/SGSN.

| +| 26 | External-Identifier | O |

Support of External-Identifier

This feature is applicable for the ULR/ULA, DSR/DSA and IDR/IDA command pairs over S6a (and S6d), when the MME (or combined MME/SGSN) supports the External-Identifier.

If the MME or combined MME/SGSN does not support this feature:

  • -The HSS shall not send the External-Identifier subscription data to the MME or combined MME/SGSN within ULA.
  • -The HSS shall not send Monitoring Event configuration for UEs that are part of a group and have no MSISDN as part of its subscription data to the MME/SGSN.
  • -The HSS shall not indicate External-Identifier-Withdrawal in the DSR-Flags AVP of the DSR.
| +| 27 | NR as Secondary RAT | O |

Support of NR as Secondary RAT

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over S6a (and S6d) when the MME (or combined MME/SGSN) supports NR as Secondary RAT, and over S6d when the SGSN supports the indication related to NR as Secondary RAT (such as, e.g., the related Access Restriction Data, or extended QoS parameters).

If the MME, SGSN, or combined MME/SGSN does not support this feature, the HSS shall not send (in ULA) or update (in IDR) subscription data related to NR as Secondary RAT.

If the HSS does not support this feature, the MME shall ignore the bit "NR as Secondary RAT Not Allowed" in Access-Restriction-Data.

| + +| | | | | +|----|--------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 28 | Unlicensed Spectrum as Secondary RAT | O |

Support of Unlicensed Spectrum as Secondary RAT

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over S6a (and S6d) when the MME (or combined MME/SGSN) supports the use of unlicensed spectrum in the form of LAA or LWA/LWIP as Secondary RAT.

If the MME (or combined MME/SGSN) does not support this feature, the HSS shall not send (in ULA) or update (in IDR) subscription data related to the use of unlicensed spectrum in the form of LAA, LWA/LWIP or NR in unlicensed bands as Secondary RAT (such as, e.g., the related Access Restriction Data).

If the HSS does not support this feature, the MME shall ignore the bit "Unlicensed Spectrum as Secondary RAT Not Allowed" in Access-Restriction-Data.

| +| 29 | Ethernet PDN Type APNs | O |

Support of Ethernet PDN Type APNs

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a and S6d interfaces.

If the MME (or combined MME/SGSN) does not indicate support of this feature in the ULR command, the HSS shall not send APN configurations with an Ethernet PDN type in the subscription data sent in ULA or in IDR, and shall not send IDR commands with the only purpose to update such subscription data.

If the MME (or combined MME/SGSN) indicates in the IDA command that it does not support this feature, and the HSS has already sent Ethernet PDN Type APNs within IDR, the HSS may store this indication, and not send any further updates related to Ethernet PDN Type APNs to that MME (or combined MME/SGSN).

| +| 30 | Extended Reference IDs | O |

Extended Reference IDs

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a or S6d interfaces, when the HSS and MME/SGSN support handling 64-bit long Reference IDs.

If the MME or SGSN does not indicate support of this feature in ULR, the HSS shall not send ULA or IDR commands containing 64-bit long SCEF Reference IDs or SCEF Reference IDs for Deletion.

| + +Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1". +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "SMS in MME". +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. +NOTE 1: If both bits, corresponding to the same feature defined for Lg interface and Lgd interface, are not set, and the HSS supports the feature, the HSS shall not send the related LCS information to the SGSN within ULA and IDR. + +Features that are not indicated in the Supported-Features AVPs within a given application message shall not be used to construct that message. + +### 7.3.10.2 Feature-List AVP for the S7a/S7d application + +For the S7a/S7d application, the feature list does not contain any feature in this release. + +## 7.3.11 Requested-EUTRAN-Authentication-Info + +The Requested-EUTRAN-Authentication-Info is of type Grouped. It shall contain the information related to the authentication requests for E-UTRAN. + +AVP format + +Requested-EUTRAN-Authentication-Info ::= + +[ Number-Of-Requested-Vectors ] + +[ Immediate-Response-Preferred ] + +[ Re-synchronization-Info ] +\*[AVP] + +### 7.3.12 Requested-UTRAN- GERAN-Authentication-Info + +The Requested-UTRAN-GERAN-Authentication-Info is of type Grouped. It shall contain the information related to the authentication requests for UTRAN or GERAN. + +AVP format + +Requested-UTRAN-GERAN-Authentication-Info ::= +[ Number-Of-Requested-Vectors ] +[ Immediate-Response-Preferred ] +[ Re-synchronization-Info ] +\*[AVP] + +### 7.3.13 RAT-Type + +The RAT-Type AVP is of type Enumerated and is used to identify the radio access technology that is serving the UE. See 3GPP TS 29.212 [10] for the defined values. + +3GPP TS 29.212 [10] defines distinct RAT-Type values for EUTRAN (WB-EUTRAN), EUTRAN-NB-IoT, LTE-M, WB-EUTRAN over satellite access, EUTRAN-NB-IoT over satellite access, LTE-M over satellite access; these values shall be used in the signaling between the serving nodes (MME/SGSN) and the HSS, e.g. to determine the corresponding access restrictions for the UE. + +### 7.3.14 Number-Of-Requested-Vectors + +The Number-Of-Requested-Vectors AVP is of type Unsigned32. This AVP shall contain the number of AVs the MME or SGSN is prepared to receive. + +### 7.3.15 Re-Synchronization-Info + +The Re-Synchronization-Info AVP is of type OctetString. It shall contain the concatenation of RAND and AUTS. + +### 7.3.16 Immediate-Response-Preferred + +The Immediate-Response-Preferred AVP is of type Unsigned32. This optional AVP indicates by its presence that immediate response is preferred, and by its absence that immediate response is not preferred. If present, the value of this AVP is not significant. + +When EUTRAN-AVs and UTRAN-AVs or GERAN-AVs are requested, presence of this AVP within the Requested-EUTRAN-Authentication-Info AVP shall indicate that EUTRAN-AVs are requested for immediate use in the MME/SGSN; presence of this AVP within the Requested-UTRAN-GERAN-Authentication-Info AVP shall indicate that UTRAN-AVs or GERAN-AVs are requested for immediate use in the MME/SGSN. It may be used by the HSS to determine the number of vectors to be obtained from the AuC and the number of vectors downloaded to the MME or SGSN. + +### 7.3.17 Authentication-Info + +The Authentication-Info AVP is of type Grouped. This AVP contains Authentication Vectors. + +AVP format: + +Authentication-Info ::= + +\*[ E-UTRAN-Vector ] +\*[UTRAN-Vector] +\*[GERAN-Vector] +\*[AVP] + +### 7.3.18 E-UTRAN-Vector + +The E-UTRAN-Vector AVP is of type Grouped. This AVP shall contain an E-UTRAN Vector. + +AVP format: + +E-UTRAN-Vector ::= +[ Item-Number ] +{ RAND } +{ XRES } +{ AUTN } +{ KASME } +\*[AVP] + +### 7.3.19 UTRAN-Vector + +The UTRAN-Vector AVP is of type Grouped. This AVP shall contain an UTRAN Vector. + +AVP format: + +UTRAN-Vector ::= +[ Item-Number ] +{ RAND } +{ XRES } +{ AUTN } +{ Confidentiality-Key } +{ Integrity-Key } +\*[AVP] + +### 7.3.20 GERAN-Vector + +The GERAN-Vector AVP is of type Grouped. This AVP shall contain a GERAN Vector. + +AVP format: + +GERAN-Vector ::= +[ Item-Number ] +{ RAND } +{ SRES } +{ Kc } + +\*[AVP] + +### 7.3.21 Network-Access-Mode + +The Network-Access-Mode AVP is of type Enumerated. The following values are defined: + +PACKET\_AND\_CIRCUIT (0) + +Reserved (1) + +ONLY\_PACKET (2) + +### 7.3.22 HPLMN-ODB + +The HPLMN-ODB AVP is of type Unsigned32 and it shall contain a bit mask indicating the HPLMN specific services of a subscriber that are barred by the operator. The meaning of the bits is HPLMN specific: + +**Table 7.3.22/1: HPLMN-ODB** + +| Bit | Description | +|-----|-------------------------------| +| 0 | HPLMN specific barring type 1 | +| 1 | HPLMN specific barring type 2 | +| 2 | HPLMN specific barring type 3 | +| 3 | HPLMN specific barring type 4 | + +HPLMN-ODB may apply to mobile originated short messages; See 3GPP TS 23.015 [36]. + +### 7.3.23 Item-Number + +The Item-Number AVP is of type Unsigned32. The Item Number is used to order Vectors received within one request. + +### 7.3.24 Cancellation-Type + +The Cancellation-Type AVP is of type Enumerated and indicates the type of cancellation. The following values are defined: + +MME\_UPDATE\_PROCEDURE (0) + +This value is used when the Cancel Location is sent to the previous MME due to a received Update Location message from a new MME or due to the HSS+UDM receiving an Nudm\_UEContextManagement service request from the AMF or due to the HSS receiving Nhss\_UECM\_SNDeregistration service operation from UDM (see clause 5.4.2.2 of 3GPP TS 29.563 [70]). + +SGSN\_UPDATE\_PROCEDURE (1) + +This value is used when the Cancel Location is sent to the previous SGSN due to a received Update Location message from a new SGSN or due to the HSS+UDM receiving an Nudm\_UEContextManagement service request from the AMF or due to the HSS receiving Nhss\_UECM\_SNDeregistration service operation from UDM (see clause 5.4.2.2 of 3GPP TS 29.563 [70]). + +SUBSCRIPTION\_WITHDRAWAL (2) + +This value is used: + +- when the Cancel Location is sent by the HSS to the current MME or SGSN due to withdrawal of the user's subscription by the HSS operator; +- when the Cancel VCSG Location is sent by the CSS to the current MME or SGSN due to withdrawal of the user's VPLMN CSG subscription by the CSS operator. + +UPDATE\_PROCEDURE\_IWF (3) + +This value is used by an IWF when interworking with a pre-Rel-8 HSS. + +INITIAL\_ATTACH\_PROCEDURE (4) + +This value is used when the Cancel Location is sent to the MME or SGSN due to a received Update Location message during initial attach procedure from an SGSN or MME respectively. + +## 7.3.25 DSR-Flags + +The DSR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in table 7.3.25/1: + +**Table 7.3.25/1: DSR-Flags** + +| Bit | Name | Description | +|-----|------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Regional Subscription Withdrawal | This bit, when set, indicates that Regional Subscription shall be deleted from the subscriber data. | +| 1 | Complete APN Configuration Profile Withdrawal | This bit, when set, indicates that all EPS APN configuration data for the subscriber shall be deleted from the subscriber data. This flag only applies to the S6d interface. | +| 2 | Subscribed Charging Characteristics Withdrawal | This bit, when set, indicates that the Subscribed Charging Characteristics have been deleted from the subscription data. | +| 3 | PDN subscription contexts Withdrawal | This bit, when set, indicates that the PDN subscription contexts whose identifier is included in the Context-Identifier AVP shall be deleted.
(Note 1) | +| 4 | STN-SR | This bit, when set, indicates that the Session Transfer Number for SRVCC shall be deleted from the subscriber data. | +| 5 | Complete PDP context list Withdrawal | This bit, when set, indicates that all PDP contexts for the subscriber shall be deleted from the subscriber data. | +| 6 | PDP contexts Withdrawal | This bit, when set, indicates that the PDP contexts whose identifier is included in the Context-Identifier AVP shall be deleted.
(Note 2) | +| 7 | Roaming Restricted due to unsupported feature | This bit, when set, indicates that the roaming restriction shall be deleted from the subscriber data in the MME or SGSN. | +| 8 | Trace Data Withdrawal | This bit, when set, indicates that the Trace Data shall be deleted from the subscriber data. | +| 9 | CSG Deleted | This bit, when set, indicates that
  • the "CSG-Subscription-Data from HSS" shall be deleted in the MME or SGSN when received over the S6a or S6d interface
  • the "CSG-Subscription-Data from CSS" shall be deleted in the MME or SGSN when received over the S7a or S7d interface.
| +| 10 | APN-OI-Replacement | This bit, when set, indicates that the UE level APN-OI-Replacement shall be deleted from the subscriber data. | +| 11 | GMLC List Withdrawal | This bit, when set, indicates that the subscriber's LCS GMLC List shall be deleted from the MME or SGSN. | +| 12 | LCS Withdrawal | This bit, when set, indicates that the LCS service whose code is included in the SS-Code AVP shall be deleted from the MME or SGSN. | +| 13 | SMS Withdrawal | This bit, when set, indicates that the SMS service whose code is included in the SS-Code AVP or TS-Code AVP shall be deleted from the MME or SGSN. | +| 14 | Subscribed periodic RAU-TAU Timer Withdrawal | This bit, when set, indicates that the subscribed periodic RAU TAU Timer value shall be deleted from the subscriber data. | +| 15 | Subscribed VSRVCC Withdrawal | This bit, when set, indicates that the Subscribed VSRVCC shall be deleted from the subscriber data. | +| 16 | A-MSISDN Withdrawal | This bit, when set, indicates that the additional MSISDN, if present, shall be deleted from the subscriber data. | +| 17 | ProSe Withdrawal | This bit, when set, indicates that the ProSe subscription data shall be deleted from the MME or combined MME/SGSN. | +| 18 | Reset-IDs | This bit, when set, indicates that the set of Reset-IDs shall be deleted from the MME or SGSN. | +| 19 | DL-Buffering-Suggested-Packet-Count Withdrawal | This bit, when set, indicates that the DL-Buffering-Suggested-Packet-Count shall be deleted in the MME or SGSN. | +| 20 | Subscribed IMSI-Group-Id Withdrawal | This bit, when set, indicates that all subscribed IMSI-Group-Id(s) shall be deleted in the MME or SGSN. | +| 21 | Delete monitoring events | This bit when set indicates to the MME or SGSN to delete all the Monitoring events for the subscriber which are associated with the provided SCEF-ID. | +| 22 | User Plane Integrity Protection | This bit, when set, indicates to the SGSN that User Plane Integrity Protection may no longer be required when GERAN is | + +| | | | +|---------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Withdrawal | used. The MME shall ignore it. | +| 23 | MSISDN Withdrawal | This bit, when set, indicates that the MSISDN shall be deleted from the subscriber data.
It is also used by the MME/SGSN to delete those monitoring events created using the MSISDN. | +| 24 | UE Usage Type Withdrawal | This bit, when set, indicates to the MME or SGSN that the UE Usage Type shall be deleted from the subscription data. | +| 25 | V2X Withdrawal | This bit, when set, indicates that the V2X subscription data shall be deleted from the MME or combined MME/SGSN. | +| 26 | External-Identifier-Withdrawal | This bit, when set, indicates that the External-Identifier shall be deleted from the subscriber data.
It is also used by the MME/SGSN to delete those monitoring events created using the removed External Identifier or all monitoring events created for any External Identifier in case of removing the default External Identifier. | +| 27 | Aerial-UE-Subscription Withdrawal | This bit, when set, indicates that the Aerial UE subscription shall be deleted from the subscriber data. | +| 28 | Paging Time Window Subscription Withdrawal | This bit, when set, indicates that the Paging Time Window subscription shall be deleted from the subscriber data. | +| 29 | Active-Time-Withdrawal | This bit, when set, indicates that the Active Time used for PSM shall be deleted from the subscriber data. | +| 30 | eDRX-Cycle-Length -Withdrawal | This bit, when set, indicates that the eDRX-Cycle-Length shall be deleted from the subscriber data. .
If the eDRX-Related-RAT is present in the DSR command, only the eDRX Cycle Length for indicated RAT types shall be deleted. Otherwise, the entire eDRX Cycle Length subscription for all RAT types shall be deleted. | +| 31 | Service-Gap-Time-Withdrawal | This bit, when set, indicates that the Service Gap Time shall be deleted from the subscriber data. | +| Note 1: | If the Complete APN Configuration Profile Withdrawal bit is set, this bit should not be set. | | +| Note 2: | If the Complete PDP context list Withdrawal bit is set, this bit should not be set. | | +| Note 3: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | +| Note 4: | Bits 3 and 6 are excluding alternatives and shall not both be set. | | +| Note 5: | When this AVP is transferred over the S7a/S7d interface, only the bit 9 (CSG Deleted) is meaningful, other bits shall be cleared. | | + +## 7.3.26 DSA-Flags + +The DSA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in table 7.3.26/1: + +**Table 7.3.26/1: DSA-Flags** + +| Bit | Name | Description | +|---------------------------------------------------------------------------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| 0 | Network Node area restricted | This bit, when set, shall indicate that the complete Network Node area (SGSN area) is restricted due to regional subscription. | +| Note: Bits not defined in this table shall be cleared by the sending SGSN and discarded by the receiving HSS. | | | + +## 7.3.27 Context-Identifier + +The Context-Identifier AVP is of type Unsigned32. + +### 7.3.28 Void + +### 7.3.29 Subscriber-Status + +The 3GPP Subscriber Status AVP is of type Enumerated. It shall indicate if the service is barred or granted. The following values are defined: + +SERVICE\_GRANTED (0) + +OPERATOR\_DETERMINED\_BARRING (1) + +### 7.3.30 Operator-Determined-Barring + +The Operator-Determined-Barring AVP is of type Unsigned32 and it shall contain a bit mask indicating the services of a subscriber that are barred by the operator. The meaning of the bits is the following: + +**Table 7.3.30/1: Operator-Determined-Barring** + +| Bit | Description | +|-----|------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | All Packet Oriented Services Barred | +| 1 | Roamer Access HPLMN-AP Barred | +| 2 | Roamer Access to VPLMN-AP Barred | +| 3 | Barring of all outgoing calls | +| 4 | Barring of all outgoing international calls | +| 5 | Barring of all outgoing international calls except those directed to the home PLMN country | +| 6 | Barring of all outgoing inter-zonal calls | +| 7 | Barring of all outgoing inter-zonal calls except those directed to the home PLMN country | +| 8 | Barring of all outgoing international calls except those directed to the home PLMN country and Barring of all outgoing inter-zonal calls | + +### 7.3.31 Access-Restriction-Data + +The Access-Restriction-Data AVP is of type Unsigned32 and it shall contain a bit mask where each bit when set to 1 indicates a restriction. The meaning of the bits is the following: + +**Table 7.3.31/1: Access-Restriction-Data** + +| Bit | Description | +|-------------------------------------------------------------------------------------------------------------|--------------------------------------------------| +| 0 | UTRAN Not Allowed | +| 1 | GERAN Not Allowed | +| 2 | GAN Not Allowed | +| 3 | I-HSPA-Evolution Not Allowed | +| 4 | WB-E-UTRAN Not Allowed | +| 5 | HO-To-Non-3GPP-Access Not Allowed | +| 6 | NB-IoT Not Allowed | +| 7 | Enhanced Coverage Not Allowed | +| 8 | NR as Secondary RAT in E-UTRAN Not Allowed | +| 9 | Unlicensed Spectrum as Secondary RAT Not Allowed | +| 10 | NR in 5GS Not Allowed | +| 11 | LTE-M Not Allowed | +| 12 | WB-E-UTRAN Except LTE-M Not Allowed | +| 13 | WB-E-UTRAN(LEO) Not Allowed | +| 14 | WB-E-UTRAN(MEO) Not Allowed | +| 15 | WB-E-UTRAN(GEO) Not Allowed | +| 16 | WB-E-UTRAN(OTHERSAT) Not Allowed | +| 17 | NB-IoT(LEO) Not Allowed | +| 18 | NB-IoT(MEO) Not Allowed | +| 19 | NB-IoT(GEO) Not Allowed | +| 20 | NB-IoT(OTHERSAT) Not Allowed | +| 21 | LTE-M(LEO) Not Allowed | +| 22 | LTE-M(MEO) Not Allowed | +| 23 | LTE-M(GEO) Not Allowed | +| 24 | LTE-M(OTHERSAT) Not Allowed | +| 25 | NR (LEO) Not Allowed | +| 26 | NR (MEO) Not Allowed | +| 27 | NR (GEO) Not Allowed | +| 28 | NR (OTHERSAT) Not Allowed | +| NOTE 1: Bits not defined in this table shall be cleared by the HSS and discarded by the receiving MME/SGSN. | | +| NOTE 2: Bits 11 and 12 are only used when bit 4 is not set. | | + +The restriction "HO-To-Non-3GPP-Access Not Allowed" shall take a higher precedence than the APN-level parameter "WLAN-Offloadability" (see clause 7.3.181). + +### 7.3.32 APN-OI-Replacement + +The APN-OI-Replacement AVP is of type UTF8String. This AVP shall indicate the domain name to replace the APN OI for the non-roaming case and the home routed roaming case when constructing the APN, and the APN-FQDN upon which to perform a DNS resolution. See 3GPP TS 23.003 [3] and 3GPP TS 29.303 [38]. + +The contents of the APN-OI-Replacement AVP shall be formatted as a character string composed of one or more labels separated by dots ("."). + +### 7.3.33 All-APN-Configurations-Included-Indicator + +The All-APN-Configurations-Included-Indicator AVP is of type Enumerated. The following values are defined: + +ALL\_APN\_CONFIGURATIONS\_INCLUDED (0) + +MODIFIED\_ADDED\_APN\_CONFIGURATIONS\_INCLUDED (1) + +### 7.3.34 APN-Configuration-Profile + +The APN-Configuration-Profile AVP is of type Grouped. It shall contain the information related to the user's subscribed APN configurations for EPS. + +The AVP format shall conform to: + +``` +APN-Configuration-Profile ::= + { Context-Identifier } + [ Additional-Context-Identifier ] + [ Third-Context-Identifier ] + { All-APN-Configurations-Included-Indicator } + 1*{APN-Configuration} + *[AVP] +``` + +The Subscription-Data AVP associated with an IMSI contains one APN-Configuration-Profile AVP. + +Each APN-Configuration-Profile AVP contains one or more APN-Configuration AVPs. + +Each APN-Configuration AVP describes the configuration for a single APN. + +Therefore, the cardinality of the relationship between IMSI and APN is one-to-many. + +The Context-Identifier AVP shall identify the per subscriber's default APN configuration. + +If present, the Additional-Context-Identifier AVP shall identify another default APN configuration, only for those subscriptions containing more than one types of APNs i.e. among APNs with an IP-based PDN type, APNs with a Non-IP PDN type, and APNs with an Ethernet PDN type; in this case, each of those two default APN configurations shall have a different PDN type category (e.g. one default APN with an IP-based PDN type, and another default APN with a Non-IP PDN type). + +If present, the Third-Context-Identifier AVP shall identify another default APN configuration, only for those subscriptions containing more than two types of APNs i.e. among APNs with an IP-based PDN type, APNs with a Non-IP PDN type, and APNs with an Ethernet PDN type; in this case, each of those three default APN configurations shall have a different PDN type category (i.e. one default APN with an IP-based PDN type, and another default APN with a Non-IP PDN type and one default APN with an Ethernet PDN type). + +### 7.3.35 APN-Configuration + +The APN-Configuration AVP is of type Grouped. It shall contain the information related to the user's subscribed APN configurations. The Context-Identifier in the APN-Configuration AVP shall identify that APN configuration, and it shall not have a value of zero. Furthermore, the Context-Identifier in the APN-Configuration AVP shall uniquely identify the EPS APN configuration per subscription. For a particular EPS user having multiple APN configurations, the Service-Selection AVP values shall be unique across APN-Configuration AVPs. + +The AVP format shall conform to: + +``` +APN-Configuration ::= + { Context-Identifier } + * 2 [ Served-Party-IP-Address ] + { PDN-Type } + { Service-Selection } + [ EPS-Subscribed-QoS-Profile ] + [ VPLMN-Dynamic-Address-Allowed ] +``` + +[MIP6-Agent-Info ] +[ Visited-Network-Identifier ] +[ PDN-GW-Allocation-Type ] +[ 3GPP-Charging-Characteristics ] +[ AMBR ] +\*[ Specific-APN-Info ] +[ APN-OI-Replacement ] +[ SIPTO-Permission ] +[ LIPA-Permission ] +[ Restoration-Priority ] +[ SIPTO-Local-Network-Permission ] +[ WLAN-offloadability ] +[ Non-IP-PDN-Type-Indicator ] +[ Non-IP-Data-Delivery-Mechanism ] +[ SCEF-ID ] +[ SCEF-Realm ] +[ Preferred-Data-Mode ] +[ PDN-Connection-Continuity ] +[ RDS-Indicator ] +[ Interworking-5GS-Indicator ] +[ Ethernet-PDN-Type-Indicator ] +\*[ AVP ] + +The AMBR included in this grouped AVP shall include the AMBR associated to this specific APN configuration (APN-AMBR). + +The Served-Party-IP-Address AVP may be present 0, 1 or 2 times. These AVPs shall be present if static IP address allocation is used for the UE, and they shall contain either of: + +- an IPv4 address, or +- an IPv6 address/prefix, or +- both, an IPv4 address and an IPv6 address/prefix. + +For the IPv6 prefix, the lower 64 bits of the address shall be set to zero. + +The PDN-GW-Allocation-Type AVP applies to the MIP6-Agent-Info AVP. Therefore, it shall not be present if MIP6-Agent-Info is not present. + +The APN-OI-Replacement included in this grouped AVP shall include the APN-OI-Replacement associated with this APN configuration. This APN-OI-Replacement has higher priority than UE level APN-OI-Replacement. + +The Visited-Network-Identifier AVP indicates the PLMN where the PGW was allocated, in case of dynamic PGW assignment. + +NOTE: If interworking with MAP is needed, the Context-Identifier will be in the range of 1 and 50. + +The Non-IP-Data-Delivery-Mechanism shall only be present when Non-IP-PDN-Type-Indicator is set to TRUE (1). + +The SCEF-ID AVP and the SCEF-Realm AVP shall only be present when Non-IP-PDN-Type-Indicator is set to TRUE (1), and Non-IP-Data-Delivery-Mechanism is set to SCEF-BASED-DATA-DELIVERY (1). + +The RDS-Indicator may be present when Non-IP-PDN-Type-Indicator is set to TRUE (1), and Non-IP-Data-Delivery-Mechanism is set to SCEF-BASED-DATA-DELIVERY (1). + +Absence of PDN-Connection-Continuity AVP indicates that the handling is left to local VPLMN policy. + +### 7.3.36 Service-Selection + +The Service-Selection AVP is of type of UTF8String. This AVP shall contain either the APN Network Identifier (i.e. an APN without the Operator Identifier) per 3GPP TS 23.003 [3], clauses 9.1 & 9.1.1, or this AVP shall contain the wild card value per 3GPP TS 23.003 [3], clause 9.2.1, and 3GPP TS 23.008 [30], clause 2.13.6). + +The contents of the Service-Selection AVP shall be formatted as a character string composed of one or more labels separated by dots (".") or as the wild card APN, i.e., consisting of only one ASCII label, "\*". + +This AVP is defined in IETF RFC 5778[20]. + +### 7.3.37 EPS-Subscribed-QoS-Profile + +The EPS-Subscribed-QoS-Profile AVP is of type Grouped. It shall contain the bearer-level QoS parameters (QoS Class Identifier and Allocation Retention Priority) associated to the default bearer for an APN (see 3GPP TS 23.401 [2], clause 4.7.3). + +AVP format + +``` + +EPS-Subscribed-QoS-Profile ::= + + { QoS-Class-Identifier } + + { Allocation-Retention-Priority } + + *[AVP] + +``` + +NOTE: QoS-Class-Identifier is defined in 3GPP TS 29.212 [10] as an Enumerated AVP. The values allowed for this AVP over the S6a/S6d interface are only those associated to non-GBR bearers, as indicated in 3GPP TS 23.008 [30]; e.g., values QCI\_1, QCI\_2, QCI\_3 and QCI\_4, which are associated to GBR bearers, cannot be sent over S6a/S6d. + +### 7.3.38 VPLMN-Dynamic-Address-Allowed + +The VPLMN-Dynamic-Address-Allowed AVP is of type Enumerated. It shall indicate whether for this APN, the UE is allowed to use the PDN GW in the domain of the HPLMN only, or additionally, the PDN GW in the domain of the VPLMN.. If this AVP is not present, this means that the UE is not allowed to use PDN GWs in the domain of the VPLMN. The following values are defined: + +NOTALLOWED (0) + +ALLOWED (1) + +### 7.3.39 STN-SR + +The STN-SR AVP is of type OctetString and shall contain the Session Transfer Number for SRVCC. See 3GPP TS 23.003 [3] for the definition of STN-SR. This AVP contains an STN-SR, in international number format as described in ITU-T Rec E.164 [41], encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.40 Allocation-Retention-Priority + +The Allocation-Retention-Priority AVP is of type Grouped and is defined in 3GPP TS 29.212 [10]. It shall indicate the Priority of Allocation and Retention for the corresponding APN configuration. + +AVP format + +``` +Allocation-Retention-Priority ::= + { Priority-Level } + [ Pre-emption-Capability ] + [ Pre-emption-Vulnerability ] +``` + +If the Pre-emption-Capability AVP is not present in the Allocation-Retention-Priority AVP, the default value shall be PRE-EMPTION\_CAPABILITY\_DISABLED (1). + +If the Pre-emption-Vulnerability AVP is not present in the Allocation-Retention-Priority AVP, the default value shall be PRE-EMPTION\_VULNERABILITY\_ENABLED (0). + +### 7.3.41 AMBR + +The AMBR AVP is of type Grouped. + +It shall contain the maximum requested bandwidth for Uplink and Downlink traffic. The Max-Requested-Bandwidth-(UL/DL) AVPs shall encode the bandwidth value in bits per second, having an upper limit of 4294967295 bits per second. The Extended-Max-Requested-BW-(UL/DL) AVPs shall encode the bandwidth value in kilobits (1000 bits) per second, having an upper limit of 4294967295 kilobits per second. + +When the maximum bandwidth value to be set for UL (or DL, respectively) traffic is lower than 4294967296 bits per second, the Max-Requested-Bandwidth-UL (or -DL, respectively) AVP shall be present, and set to the requested bandwidth value in bits per second, and the Extended-Max-Requested-BW-UL (or -DL, respectively) AVP shall be absent. + +When the maximum bandwidth value to be set for UL (or DL, respectively) traffic is higher than 4294967295 bits per second, the Max-Requested-Bandwidth-UL (or DL, respectively) AVP shall be present, and set to its upper limit 4294967295, and the Extended-Max-Requested-BW-UL (or -DL, respectively) shall be present, and set to the requested bandwidth value in kilobits (1000 bits) per second. + +NOTE: The value applicable for Max-Requested-Bandwidth-UL (or DL, respectively) is between 1 and 4294967295 bits per second, and the value applicable for Extended-Max-Requested-BW-UL (or -DL, respectively) is between 4294968 and 4294967295 kilobits per second. The AMBR AVP cannot indicate the requested bandwidth between 4294967296 and 4294967999 bits per second, and any larger value that cannot be represented in the granularity of kilobits per second. + +AVP format + +``` +AMBR ::= + { Max-Requested-Bandwidth-UL } + { Max-Requested-Bandwidth-DL } + [ Extended-Max-Requested-BW-UL ] + [ Extended-Max-Requested-BW-DL ] + *[AVP] +``` + +### 7.3.42 MIP-Home-Agent-Address + +The MIP-Home-Agent-Address AVP is of type Address and is defined in IETF RFC 4004 [27]. This AVP shall contain either IPv4 or IPv6 address of the PDN-GW and this IP address shall be used as the PDN-GW IP address. + +### 7.3.43 MIP-Home-Agent-Host + +The MIP-Home-Agent-Host is of type Grouped and is defined in IETF RFC 4004 [27]. This AVP shall contain a FQDN of the PDN-GW which shall be used to resolve the PDN-GW IP address using the Domain Name Service function. + +MIP-Home-Agent-Host grouped AVP is composed by Destination-Host and Destination-Realm AVPs. + +Destination-Host shall contain the hostname of the PDN-GW, formatted as described in 3GPP TS 29.303 [38], clause 4.3.2. + +Destination-Realm shall be formatted as: + +epc.mnc.mcc.3gppnetwork.org + +where MNC and MCC values indicate the PLMN where the PDN-GW is located. + +### 7.3.44 PDN-GW-Allocation-Type + +The PDN-GW-Allocation-Type AVP is of type Enumerated. It shall indicate whether the PDN GW address included in MIP6-Agent-Info has been statically allocated (i.e. provisioned in the HSS by the operator), or dynamically selected by other nodes. The following values are defined: + +STATIC (0) + +DYNAMIC (1) + +### 7.3.45 MIP6-Agent-Info + +The MIP6-Agent-Info AVP is of type Grouped and is defined in IETF RFC 5447 [26]. This AVP shall contain the identity of the PDN-GW. This AVP is used to convey the identity of the PDN-GW between the MME/SGSN and the HSS regardless of the specific mobility protocol used (GTP or PMIPv6). The identity of PDN-GW is either an IP address transported in MIP-Home-Agent-Address or an FQDN transported in MIP-Home-Agent-Host. FQDN shall be used if known to the MME/SGSN/HSS. + +AVP format + +``` +MIP6-Agent-Info ::= < AVP Header: 486 > + *2[ MIP-Home-Agent-Address ] + [ MIP-Home-Agent-Host ] + [ MIP6-Home-Link-Prefix ] + *[ AVP ] +``` + +Within the MIP6-Agent-Info AVP, if static address allocation is used, there may be either: + +- an IPv4 address or an IPv6 address of the PGW contained in one MIP-Home-Agent-Address AVP; +- both IPv4 address and IPv6 address of the PGW contained in two MIP-Home-Agent-Address AVPs. + +The AVP MIP6-Home-Link-Prefix is not used in S6a/S6d, but it is included here to reflect the complete IETF definition of the grouped AVP. + +### 7.3.46 RAT-Frequency-Selection-Priority-ID + +The RAT-Frequency-Selection-Priority-ID AVP is of type Unsigned32 and shall contain the subscribed value of Subscriber Profile ID for RAT/Frequency Priority. For details, see 3GPP TS 23.401 [2] and 3GPP TS 23.060 [12]. The coding is defined in 3GPP TS 36.413 [19]. Values shall be in the range of 1 to 256. + +### 7.3.47 IDA-Flags + +The IDA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meanings of the bits are defined in table 7.3.47/1: + +**Table 7.3.47/1: IDA-Flags** + +| Bit | Name | Description | +|---------------------------------------------------------------------------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| 0 | Network Node area restricted | This bit, when set, shall indicate that the complete Network Node area (SGSN area) is restricted due to regional subscription. | +| Note: Bits not defined in this table shall be cleared by the sending SGSN and discarded by the receiving HSS. | | | + +### 7.3.48 PUA-Flags + +The PUA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meanings of the bits are defined in table 7.3.48/1: + +**Table 7.3.48/1: PUA-Flags** + +| bit | name | Description | +|----------------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------------------------------------------------------| +| 0 | Freeze M-TMSI | This bit, when set, shall indicate to the MME that the M-TMSI needs to be frozen, i.e. shall not be immediately re-used. | +| 1 | Freeze P-TMSI | This bit, when set, shall indicate to the SGSN that the P-TMSI needs to be frozen, i.e. shall not be immediately re-used. | +| Note: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | | + +### 7.3.49 NOR-Flags + +The NOR-Flags AVP is of type Unsigned32 and it contains a bit mask. The meaning of the bits is defined in table 7.3.49/1: + +**Table 7.3.49/1: NOR-Flags** + +| bit | name | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Single-Registration-Indication | This bit, when set, indicates that the HSS shall send Cancel Location to the SGSN. An SGSN shall not set this bit when sending NOR. | +| 1 | SGSN area restricted | This bit, when set, shall indicate that the complete SGSN area is restricted due to regional subscription. | +| 2 | Ready for SM from SGSN | This bit, when set, shall indicate that the UE is present or the UE has memory capacity available to receive one or more short messages via SGSN. | +| 3 | UE Reachable from MME | This bit, when set, shall indicate that the UE has become reachable again from MME. | +| 4 | Reserved | The use of this bit is deprecated. This bit shall be discarded by the receiving HSS. | +| 5 | UE Reachable from SGSN | This bit, when set, shall indicate that the UE has become reachable again from SGSN. | +| 6 | Ready for SM from MME | This bit, when set, shall indicate that the UE is present or the UE has memory capacity available to receive one or more short messages via MME. | +| 7 | Homogeneous Support of IMS Voice Over PS Sessions | This bit, when set, shall indicate that the Homogeneous Support of IMS Voice Over PS Sessions is updated. | +| 8 | S6a/S6d-Indicator | This bit, when set, shall indicate that the NOR message is sent on the S6a interface, i.e. the message is from the MME or the MME part on the combined MME/SGSN.
This bit, when cleared, indicates that the NOR message is sent on the S6d interface, i.e. the message is from the SGSN or the SGSN part on the combined MME/SGSN. | +| 9 | Removal of MME Registration for SMS | This bit, when set, shall indicate that the MME requests to remove its registration for SMS. | +| NOTE 1: The S6a/S6d-Indicator flag shall be used together with Homogeneous Support of IMS Voice Over PS Sessions flag, i.e. if the Homogeneous Support of IMS Voice Over PS Sessions bit is set, the S6a/S6d-Indicator bit shall be set if the message is sent from the MME or the MME part on the combined MME/SGSN, and shall be cleared if the message is sent from the SGSN or the SGSN part on the combined MME/SGSN. This S6a/S6d-Indicator bit shall be discarded by the receiving HSS if the Homogeneous Support of IMS Voice Over PS Sessions bit is not set. | | | +| NOTE 2: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving HSS. | | | +| | | | + +### 7.3.50 User-Id + +The User-Id AVP shall be of type UTF8String. It shall contain the leading digits of an IMSI (i.e. MCC, MNC, leading digits of MSIN, see 3GPP TS 23.003 [3], clause 2.2) formatted as a character string. Within a HSS, a User-Id identifies a set of subscribers, each with identical leading IMSI digits. + +### 7.3.51 Equipment-Status + +The Equipment-Status AVP is of type Enumerated, and shall contain the status of the mobile equipment. The following values are defined: + +PERMITTEDLISTED (0) + +PROHIBITEDLISTED (1) + +## TRACKINGLISTED (2) + +### 7.3.52 Regional-Subscription-Zone-Code + +The Regional-Subscription-Zone-Code AVP is of type OctetString. It shall contain a Zone Code (ZC) as defined in 3GPP TS 23.003 [3], clause 4.4. Up to 10 Zone Codes per VPLMN can be defined as part of the user's subscription data. + +NOTE 1: Each zone code represents a collection of tracking area or routing areas (defined by the operator of the VPLMN) where the user is allowed, or disallowed, to roam. The determination of which areas are actually allowed, and which ones are not allowed, is done by the serving node (MME/SGSN) in an implementation-dependent manner. + +NOTE 2: The description of RSZI in 3GPP TS 23.003 [3] is applicable, in the context of this specification, not only to location areas, but also to routing and tracking areas. + +### 7.3.53 RAND + +The RAND AVP is of type OctetString. This AVP shall contain the RAND. See 3GPP TS 33.401 [5]. + +### 7.3.54 XRES + +The XRES AVP is of type OctetString. This AVP shall contain the XRES. See 3GPP TS 33.401 [5]. + +### 7.3.55 AUTN + +The AUTN AVP is of type OctetString. This AVP shall contain the AUTN. See 3GPP TS 33.401 [5]. + +### 7.3.56 KASME + +The KASME AVP is of type OctetString. This AVP shall contain the K\_ASME. See 3GPP TS 33.401 [5]. + +### 7.3.57 Confidentiality-Key AVP + +The Confidentiality-Key is of type OctetString, and shall contain the Confidentiality Key (CK). + +### 7.3.58 Integrity-Key AVP + +The Integrity-Key is of type OctetString, and shall contain the Integrity Key (IK). + +### 7.3.59 Kc AVP + +The Kc AVP is of type OctetString, and shall contain the Ciphering Key (Kc). + +### 7.3.60 SRES + +The SRES AVP is of type OctetString. This AVP shall contain the SRES. See 3GPP TS 33.102 [18]. + +### 7.3.61 Void + +### 7.3.62 PDN-Type + +The PDN-Type AVP is of type Enumerated and indicates the address type of the PDN, when it is IP-based. + +NOTE: There are certain PDNs that can be accessed without using IP. These are identified by a specific PDN type indicator in their APN configuration settings (e.g. see clauses 7.3.204 and 7.3.232). + +The following values are defined: + +IPv4 (0) + +This value shall be used to indicate that the PDN can be accessed only in IPv4 mode. + +IPv6 (1) + +This value shall be used to indicate that the PDN can be accessed only in IPv6 mode. + +IPv4v6 (2) + +This value shall be used to indicate that the PDN can be accessed both in IPv4 mode, in IPv6 mode, and also from UEs supporting dualstack IPv4v6. + +IPv4\_OR\_IPv6 (3) + +This value shall be used to indicate that the PDN can be accessed either in IPv4 mode, or in IPv6 mode, but not from UEs supporting dualstack IPv4v6. It should be noted that this value will never be used as a requested PDN Type from the UE, since UEs will only use one of their supported PDN Types, i.e., IPv4 only, IPv6 only or IPv4v6 (dualstack). This value is only used as part of the APN subscription context, as an authorization mechanism between HSS and MME. + +### 7.3.63 Trace-Data AVP + +The Trace-Data AVP is of type Grouped. This AVP shall contain the information related to trace function. + +AVP format + +Trace-Data ::= + +{Trace-Reference} +{Trace-Depth} +{Trace-NE-Type-List} +[Trace-Interface-List] +{Trace-Event-List} +[OMC-Id] +{Trace-Collection-Entity} +[MDT-Configuration] +\*[AVP] + +### 7.3.64 Trace-Reference AVP + +The Trace-Reference AVP is of type OctetString. This AVP shall contain the concatenation of MCC, MNC and Trace ID, where the Trace ID is a 3 byte Octet String. See 3GPP TS 32.422 [23]. + +The content of this AVP shall be encoded as octet strings according to table 7.3.64/1. + +See 3GPP TS 24.008 [31], clause 10.5.1.13, PLMN list, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 2 are coded as "1111". + +**Table 7.3.64/1: Encoding format for Trace-Reference AVP** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|----------|---|---|---|---|---|---|---|--| +| | | | | | | | | | +| | | | | | | | | | +| | | | | | | | | | +| Trace ID | | | | | | | | | +| | | | | | | | | | +| | | | | | | | | | + +### 7.3.65 Void + +### 7.3.66 Void + +### 7.3.67 Trace-Depth AVP + +The Trace-Depth AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Trace Depth. + +### 7.3.68 Trace-NE-Type-List AVP + +The Trace-NE-Type-List AVP is of type OctetString. Octets are coded according to 3GPP TS 32.422 [23]. + +### 7.3.69 Trace-Interface-List AVP + +The Trace-Interface-List AVP is of type OctetString. Octets are coded according to 3GPP TS 32.422 [23]. + +### 7.3.70 Trace-Event-List AVP + +The Trace-Event-List AVP is of type OctetString. Octets are coded according to 3GPP TS 32.422 [23]. + +### 7.3.71 OMC-Id AVP + +The OMC-Id AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. + +### 7.3.72 GPRS-Subscription-Data + +The GPRS-Subscription-Data AVP is of type Grouped. It shall contain the information related to the user profile relevant for GPRS. + +AVP format: + +``` +GPRS-Subscription-Data ::= + { Complete-Data-List-Included-Indicator } + 1*50{PDP-Context} + *[AVP] +``` + +NOTE: The max number of PDP-Context AVP aligns with the value of maxNumOfPDP-Contexts as defined in 3GPP TS 29.002 [24]. + +### 7.3.73 Complete-Data-List-Included-Indicator + +The Complete-Data-List-Included-Indicator AVP is of type Enumerated. The following values are defined: + +ALL\_PDP\_CONTEXTS\_INCLUDED (0) + +MODIFIED\_ADDED\_PDP\_CONTEXTS\_INCLUDED (1) + +### 7.3.74 PDP-Context + +The PDP-Context AVP is of type Grouped. For a particular GPRS user having multiple PDP Context configurations, the Service-Selection AVP values may be the same for different PDP-Context AVPs. + +AVP format + +``` +PDP-Context ::= + { Context-Identifier } + { PDP-Type } + [ PDP-Address ] + { QoS-Subscribed } + [ VPLMN-Dynamic-Address-Allowed ] + { Service-Selection } + [3GPP-Charging-Characteristics] + [ Ext-PDP-Type ] + [ Ext-PDP-Address ] + [ AMBR ] + [ APN-OI-Replacement ] + [ SIPTO-Permission ] + [ LIPA-Permission ] + [ Restoration-Priority ] + [ SIPTO-Local-Network-Permission ] + [ Non-IP-Data-Delivery-Mechanism ] + [ SCEF-ID ] + *[AVP] +``` + +The Ext-PDP-Address AVP may be present only if the PDP-Address AVP is present. If the Ext-PDP-Address AVP is present, then it shall not contain the same address type (IPv4 or IPv6) as the PDP-Address AVP. + +When PDP-Type takes the value Non-IP (HEX 02), the Ext-PDP-Type AVP shall be absent. + +The AMBR included in this grouped AVP shall include the AMBR associated to the APN included in the PDP-Context AVP (APN-AMBR). + +The APN-OI-Replacement included in this grouped AVP shall include the APN-OI-Replacement associated to the APN included in the PDP-Context. This APN-OI-Replacement has higher priority than UE level APN-OI-Replacement. + +The Non-IP-Data-Delivery-Mechanism shall only be present when PDP-Type takes the value Non-IP (HEX 02). + +The SCEF-ID shall only be present when Non-IP-Data-Delivery-Mechanism takes the value SCEF-BASED-DATA-DELIVERY (1). + +### 7.3.75 PDP-Type + +The PDP-Type AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. The allowed values are one of IPv4 encoded as HEX (21) or IPv6 encoded as HEX (57) or Non-IP encoded as HEX (02). + +### 7.3.75A Ext-PDP-Type + +The Ext-PDP-Type AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24] and 3GPP TS 29.060 [39] and shall contain the value of IPv4v6. + +### 7.3.76 Void + +### 7.3.77 QoS-Subscribed + +The QoS-Subscribed AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24] (octets of QoS-Subscribed, Ext-QoS-Subscribed, Ext2-QoS-Subscribed, Ext3-QoS-Subscribed and Ext4-QoS-Subscribed values are concatenated). + +### 7.3.78 CSG-Subscription-Data + +The CSG-Subscription-Data AVP is of type Grouped. This AVP shall contain the CSG-Id, and may contain the associated Visited-PLMN-Id, an associated expiration date and the APNs which are allowed to be accessed via Local IP Access from the CSG. + +If the Visited-PLMN-Id is not present, the CSG-Subscription-Data corresponds to the registered PLMN (i.e. the visited PLMN) of the MME or the SGSN. + +AVP format + +``` + +CSG-Subscription-Data ::= + { CSG-Id } + [ Expiration-Date ] + *[ Service-Selection ] + [ Visited-PLMN-Id ] + *[AVP] + +``` + +### 7.3.79 CSG-Id + +The CSG-Id AVP is of type Unsigned32. Values are coded according to 3GPP TS 23.003 [3]. Unused bits (least significant) shall be padded with zeros. + +### 7.3.80 Expiration-Date + +The Expiration-Date AVP is of type Time (see IETF RFC 6733 [61]) and contains the point in time when subscription to the CSG-Id expires. + +### 7.3.81 Roaming-Restricted-Due-To-Unsupported-Feature + +The Roaming-Restricted-Due-To-Unsupported-Feature AVP is of type Enumerated and indicates that roaming is restricted due to unsupported feature. The following value is defined: + +Roaming-Restricted-Due-To-Unsupported-Feature (0) + +### 7.3.82 Specific-APN-Info AVP + +The Specific-APN-Info AVP is of type Grouped. It shall only be present in the APN configuration when the APN is a wild card APN. It shall contain the APN which is not present in the subscription context but the UE is authorized to connect to and the identity of the registered PDN-GW. + +The AVP format shall conform to: + +``` +Specific-APN-Info ::= + { Service-Selection } + { MIP6-Agent-Info } + [ Visited-Network-Identifier ] + *[ AVP ] +``` + +### 7.3.83 Alert-Reason AVP + +The Alert-Reason AVP is of type Enumerated. The following values are defined: + +UE\_PRESENT (0) + +UE\_MEMORY\_AVAILABLE (1) + +### 7.3.84 LCS-Info + +The LCS-Info AVP is of type Grouped. This AVP shall contain the following LCS related information for a subscriber: + +- list of GMLCs in the HPLMN that are permitted to issue a call/session unrelated or call/session related MT-LR location request for this UE; +- privacy exception list that is applicable only over the S6d interface; +- MO-LR list. + +AVP format + +``` +LCS-Info ::= + *[ GMLC-Number ] + *[ LCS-PrivacyException ] + *[ MO-LR ] + *[AVP] +``` + +### 7.3.85 GMLC-Number + +The GMLC-Number AVP is of type OctetString. This AVP shall contain the ISDN number of the GMLC in international number format as described in ITU-T Rec E.164 [41] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.86 LCS-PrivacyException + +The LCS-PrivacyException AVP is of type Grouped. This AVP shall contain the classes of LCS Client that are allowed to locate any target UE. + +AVP format + +``` +LCS-PrivacyException ::= + { SS-Code } + { SS-Status } + [ Notification-To-UE-User ] + *[ External-Client ] + *[ PLMN-Client ] + *[ Service-Type ] + *[AVP] +``` + +### 7.3.87 SS-Code + +The SS-Code AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. + +### 7.3.88 SS-Status + +The SS-Status AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. For details, see 3GPP TS 23.011 [29]. + +### 7.3.89 Notification-To-UE-User + +The Notification- To-UE-User AVP is of type Enumerated. The following values are defined: + +``` +NOTIFY_LOCATION_ALLOWED (0) +NOTIFYANDVERIFY_LOCATION_ALLOWED_IF_NO_RESPONSE (1) +NOTIFYANDVERIFY_LOCATION_NOT_ALLOWED_IF_NO_RESPONSE (2) +LOCATION_NOT_ALLOWED (3) +``` + +### 7.3.90 External-Client + +The External-Client AVP is of type Grouped. This AVP shall contain the identities of the external clients that are allowed to locate a target UE for a MT-LR. + +AVP format + +``` +External-Client ::= + { Client-Identity } + [ GMLC-Restriction ] + [ Notification-To-UE-User ] + *[AVP] +``` + +### 7.3.91 Client-Identity + +The Client-Identity AVP is of type OctetString and it shall contain the ISDN number of the external client in international number format as described in ITU-T Rec E.164 [41] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.92 GMLC-Restriction + +The GMLC-Restriction AVP is of type Enumerated. The following values are defined: + +GMLC\_LIST (0) + +HOME\_COUNTRY (1) + +### 7.3.93 PLMN-Client + +The PLMN-Client AVP is of type Enumerated. The following values are defined: + +BROADCAST\_SERVICE (0) + +O\_AND\_M\_HPLMN (1) + +O\_AND\_M\_VPLMN (2) + +ANONYMOUS\_LOCATION (3) + +TARGET\_UE\_SUBSCRIBED\_SERVICE (4) + +### 7.3.94 Service-Type + +The Service-Type AVP is of type Grouped. This AVP shall contain the identities of the service type of the clients that are allowed to locate a target UE for an MT-LR. + +AVP format + +Service-Type ::= + +{ ServiceTypeIdentity } + +[ GMLC-Restriction ] + +[ Notification-To-UE-User ] + +\*[AVP] + +### 7.3.95 ServiceTypeIdentity + +The ServiceTypeIdentity AVP is of type Unsigned32. For details on the values of this AVP, see 3GPP TS 29.002 [24]. + +### 7.3.96 MO-LR + +The MO-LR AVP is of type Grouped. This AVP shall contain the classes of MO-LR for which a subscription exists for a particular UE. + +AVP format + +MO-LR ::= + +{ SS-Code } + +{ SS-Status } + +\*[AVP] + +### 7.3.97 Void + +### 7.3.98 Trace-Collection-Entity AVP + +The Trace-Collection-Entity AVP is of type Address and contains the IPv4 or IPv6 address of the Trace Collection Entity, as defined in 3GPP TS 32.422 [23], clause 5.9. + +### 7.3.99 Teleservice-List + +The Teleservice-List AVP is of type Grouped. This AVP shall contain the service codes for the short message related teleservice for a subscriber: + +AVP format + +Teleservice-List ::= + +1 \* { TS-Code }\*[ AVP ] + +### 7.3.100 TS-Code + +The TS-Code AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. + +### 7.3.101 Call-Barring-Info + +The Call-Barring-Info AVP is of type Grouped. This AVP shall contain the service codes for the short message related call barring services for a subscriber: + +AVP format + +Call-Barring-Info ::= + +{ SS-Code } + +{ SS-Status } + +\*[ AVP ] + +### 7.3.102 SGSN-Number + +The SGSN-Number AVP is of type OctetString and it shall contain the ISDN number of the SGSN. For further details on the definition of this AVP, see 3GPP TS 23.003 [3]. This AVP contains an SGSN-Number in international number format as described in ITU-T Rec E.164 [41] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.103 IDR-Flags + +The IDR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.103/1: + +**Table 7.3.103/1: IDR-Flags** + +| bit | name | Description | +|----------------------------------------------------------------------------------------------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | UE Reachability Request | This bit when set shall indicate to the MME or the SGSN that the HSS is awaiting a Notification of UE Reachability. | +| 1 | T-ADS Data Request | This bit, when set, shall indicate to the MME or SGSN that the HSS requests the support status of "IMS Voice over PS Sessions", and the RAT Type and timestamp of the last radio contact with the UE. | +| 2 | EPS User State Request | This bit, when set, shall indicate to the MME or the SGSN that the HSS requests the MME or the SGSN for the current user state. | +| 3 | EPS Location Information Request | This bit, when set, shall indicate to the MME or the SGSN that the HSS requests the MME or SGSN for location information | +| 4 | Current Location Request | This bit when set shall indicate to the MME or the SGSN that the HSS requests the MME or SGSN to provide the most current location information by paging the UE if the UE is in idle mode. This bit is used only in combination with the "EPS Location Information Request" bit. | +| 5 | Local Time Zone Request | This bit when set shall indicate to the MME or the SGSN that the HSS requests the MME or SGSN to provide information on the time zone of the location in the visited network where the UE is attached. | +| 6 | Remove SMS Registration | This bit when set shall indicate to the MME that it shall consider itself unregistered for SMS. | +| 7 | RAT-Type Requested | This bit when set shall indicate to the MME or the SGSN that the HSS requests the MME or SGSN to provide the RAT Type that corresponds to the requested EPS Location Information. This bit is used only in combination with the "EPS Location Information Request" bit. | +| 8 | P-CSCF Restoration Request | This bit, when set, shall indicate to the MME or SGSN that the HSS requests the execution of the HSS-based P-CSCF restoration procedures, as described in 3GPP TS 23.380 [51] clause 5.4. | +| NOTE: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | | + +### 7.3.104 ICS-Indicator + +The ICS-Indicator AVP is of type Enumerated. The meaning of the values is defined in 3GPP TS 23.292 [34] and 3GPP TS 23.216 [35]. The following values are defined: + +FALSE (0) + +TRUE (1) + +### 7.3.105 Visited-Network-Identifier + +The Visited-Network-Identifier AVP contains the identity of the network where the PDN-GW was allocated, in the case of dynamic PDN-GW assignment. + +The AVP shall be encoded as: + +mnc.mcc.3gppnetwork.org + +### 7.3.106 IMS-Voice-Over-PS-Sessions-Supported + +The IMS-Voice-Over-PS-Sessions-Supported AVP is of type Enumerated. The following values are defined: + +#### NOT\_SUPPORTED (0) + +This value indicates that "IMS Voice over PS Sessions" is not supported by the UE's most recently used TA or RA in the serving node. + +#### SUPPORTED (1) + +This value indicates that "IMS Voice over PS Sessions" is supported by the UE's most recently used TA or RA in the serving node. + +### 7.3.107 Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions + +The Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions AVP is of type Enumerated. The following values are defined: + +#### NOT\_SUPPORTED (0) + +This value indicates that "IMS Voice over PS Sessions" is not supported, homogeneously, in any of the TAs or RAs associated to the serving node for the served subscribers including consideration on roaming relationship for IMS Voice over PS. + +#### SUPPORTED (1) + +This value indicates that "IMS Voice over PS Sessions" is supported, homogeneously, in all of the TAs or RAs associated to the serving node for the served subscriber including consideration on roaming relationship for IMS Voice over PS. + +If this AVP is not present in the command, it indicates that there is no homogeneous support of IMS Voice Over PS Sessions on all the TA/RAs of the serving node, or that the homogeneity of this support is unknown to the serving node. + +NOTE: In order to ensure the T-ADS by HPLMN, MME or SGSN is expected to either set "Homogenous Support of IMS Voice over PS Sessions" AVP to "NOT\_SUPPORTED (0)", or not to set this AVP for inbound roaming subscribers if there is no IMS Voice over PS roaming relationship with the HPLMN. + +### 7.3.108 Last-UE-Activity-Time + +The Last-UE-Activity-Time AVP is of type Time (see IETF RFC 6733 [61]), and contains the point of time of the last radio contact of the serving node (MME or SGSN) with the UE. + +### 7.3.109 GMLC-Address + +The GMLC-Address AVP is of type Address and shall contain the IPv4 or IPv6 address of the V-GMLC associated with the serving node. + +### 7.3.110 EPS-User-State + +The EPS-User-State AVP is of type Grouped. It shall contain the information related to the user state in the MME and/or the SGSN. + +AVP format + +EPS-User-State ::= + +[MME-User-State] + +[SGSN-User-State] + +\*[AVP] + +### 7.3.111 EPS-Location-Information + +The EPS-Location Information AVP is of type Grouped. It shall contain the information related to the user location relevant for EPS. + +AVP format + +``` +EPS-Location-Information ::= + [MME-Location-Information] + [SGSN-Location-Information] + *[AVP] +``` + +### 7.3.112 MME-User-State + +The MME-User-State AVP is of type Grouped. It shall contain the information related to the user state in the MME. + +AVP format + +``` +MME-User-State ::= + [User-State] + *[AVP] +``` + +### 7.3.113 SGSN-User-State + +The SGSN-User-State AVP is of type Grouped. It shall contain the information related to the user state in the SGSN. + +AVP format + +``` +SGSN-User-State ::= + [User-State] + *[AVP] +``` + +### 7.3.114 User-State + +The User-State AVP is of type Enumerated and indicates the user state in EPS. The following values are defined: + +DETACHED (0) + +The UE is in EMM\_DEREGISTERED state. + +ATTACHED\_NOT\_REACHABLE\_FOR\_PAGING (1) + +The SGSN has determined from its internal data that the UE is attached to the network, but there is no EPS bearer active, and the UE is not reachable for paging. This value is only applicable to S4-SGSN. + +ATTACHED\_REACHABLE\_FOR\_PAGING (2) + +The SGSN has determined from its internal data that the UE is attached to the network, but there is no EPS bearer active; the SGSN has not determined from its internal data that the UE is not reachable for paging. This value is only applicable to S4-SGSN. + +CONNECTED\_NOT\_REACHABLE\_FOR\_PAGING (3) + +The SGSN or MME has determined from its internal data that the UE is attached to the network, there is at least one EPS bearer active, and the UE is not reachable for paging. + +CONNECTED\_REACHABLE\_FOR\_PAGING (4) + +The SGSN or MME has determined from its internal data that the UE is attached to the network, there is at least one EPS bearer active, and the SGSN or MME has not determined from its internal data that the UE is not reachable for paging. + +#### RESERVED (5) + +This value should not be used by MME or SGSN over S6a/S6d. If this value is received by the HSS from pre-rel-12 MME/SGSNs, the HSS shall consider that the UE is not reachable and use the "Network determined not reachable" state when reporting the User State to other network entities, e.g. over Sh. + +NOTE: The state associated to a "Network determined not reachable" condition should also be used by HSS when reporting to the requesting entity, e.g. over Sh, that the user was found to be not reachable (for instance, if the HSS receives no answer from the MME/SGSN to the user state query). + +### 7.3.115 MME-Location-Information + +The MME-Location-Information AVP is of type Grouped. It shall contain the information related to the user location relevant for the MME. + +AVP format + +MME-Location-Information ::= + +[E-UTRAN-Cell-Global-Identity] +[Tracking-Area-Identity] +[Geographical-Information] +[Geodetic-Information] +[Current-Location-Retrieved] +[Age-Of-Location-Information] +[User-CSG-Information] +[ eNodeB-ID ] +[ Extended-eNodeB-ID ] +\*[AVP] + +An eNodeB-ID AVP may be present for Monitoring event reporting. + +### 7.3.116 SGSN-Location-Information + +The SGSN-Location-Information AVP is of type Grouped. It shall contain the information related to the user location relevant for the SGSN. + +AVP format + +SGSN-Location-Information ::= + +[Cell-Global-Identity] +[Location-Area-Identity] +[Service-Area-Identity] +[Routing-Area-Identity] +[Geographical-Information] +[Geodetic-Information] + +[Current-Location-Retrieved] +[Age-Of-Location-Information] +[ User-CSG-Information] +\*[AVP] + +### 7.3.117 E-UTRAN-Cell-Global-Identity + +The E-UTRAN-Cell-Global-Identity AVP is of type OctetString and shall contain the E-UTRAN Cell Global Identification of the user which identifies the cell the user equipment is registered, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.118 Tracking-Area-Identity + +The Tracking-Area-Identity AVP is of type OctetString and shall contain the Tracking Area Identity of the user which identifies the tracking area where the user is located, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.119 Cell-Global-Identity + +The Cell-Global-Identity AVP is of type OctetString and shall contain the Cell Global Identification of the user which identifies the cell the user equipment is registered, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.120 Routing-Area-Identity + +The Routing-Area-Identity AVP is of type OctetString and shall contain the Routing Area Identity of the user which identifies the routing area where the user is located, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.121 Location-Area-Identity + +The Location-Area-Identity AVP is of type OctetString and shall contain the Location Area Identification of the user which identifies the Location area where the user is located, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.122 Service-Area-Identity + +The Service-Area-Identity AVP is of type OctetString and shall contain the Service Area Identifier of the user where the user is located, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.123 Geographical-Information + +The Geographical-Information AVP is of type OctetString and shall contain the geographical Information of the user. For details and octet encoding, see 3GPP TS 29.002 [24]. + +### 7.3.124 Geodetic-Information + +The Geodetic-Information AVP is of type OctetString and shall contain the Geodetic Location of the user. For details and octet encoding, see 3GPP TS 29.002 [24]. + +### 7.3.125 Current-Location-Retrieved + +The Current-Location-Retrieved AVP is of type Enumerated. The following values are defined: + +ACTIVE-LOCATION-RETRIEVAL (0) + +This value is used when location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after retrieving the most up-to-date location information from the eNB when the UE is in connected mode. + +### 7.3.126 Age-Of-Location-Information + +The Age-Of-Location-Information AVP is of type Unsigned32 and shall contain the the elapsed time in minutes since the last network contact of the user equipment. For details, see 3GPP TS 29.002 [24]. + +### 7.3.127 Active-APN + +The Active-APNs AVP is of type Grouped. It shall contain information about a dynamically established APN on a serving node, so the HSS can restore it, if it is eventually lost after a node restart. + +The AVP format shall conform to: + +``` +Active-APN ::= + { Context-Identifier } + [ Service-Selection ] + [ MIP6-Agent-Info ] + [ Visited-Network-Identifier ] + *[ Specific-APN-Info ] + *[ AVP ] +``` + +### 7.3.128 Error-Diagnostic + +The Error-Diagnostic AVP is of type Enumerated. The following values are defined: + +- GPRS\_DATA\_SUBSCRIBED (0) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION and there is GPRS Subscription Data for the user. + +- NO\_GPRS\_DATA\_SUBSCRIBED (1) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION and there is not GPRS Subscription Data for the user. + +- ODB\_ALL\_APN (2) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the Operator Determined Barring indicates "All Packet Oriented Services Barred" (see clause 7.3.30). + +- ODB\_HPLMN\_APN (3) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the Operator Determined Barring indicates "Roamer Access HPLMN-AP Barred" (see clause 7.3.30). + +- ODB\_VPLMN\_APN (4) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the Operator Determined Barring indicates "Roamer Access to VPLMN-AP Barred" (see clause 7.3.30). + +### 7.3.129 Ext-PDP-Address AVP + +The Ext-PDP-Address AVP is of type Address and indicates an additional address of the data protocol, and it may be included when the PDP supports dual-stack (IPv4v6). + +### 7.3.130 UE-SRVCC-Capability + +The UE-SRVCC-Capability AVP is of type Enumerated. It shall indicate if the UE supports or does not support the SRVCC capability. The following values are defined: + +UE-SRVCC-NOT-SUPPORTED (0) + +UE-SRVCC-SUPPORTED (1) + +### 7.3.131 MPS-Priority + +The MPS-Priority AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.131/1: + +**Table 7.3.131/1: MPS-Priority** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------| +| 0 | MPS-CS-Priority | This bit, when set, indicates that the UE is subscribed to the eMLPP or 1x RTT priority service in the CS domain. | +| 1 | MPS-EPS-Priority | This bit, when set, indicates that the UE is subscribed to the MPS in the EPS domain. | +| Note: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | | + +NOTE: The HSS derives the information for MPS-CS-Priority from the eMLPP Subscription Data as defined in the 3GPP TS 29.002 [24] or 1x RTT priority service which is out of the scope of 3GPP. + +### 7.3.132 VPLMN-LIPA-Allowed + +The VPLMN-LIPA-Allowed AVP is of type Enumerated. It shall indicate whether the UE is allowed to use LIPA in the VPLMN where the UE is roaming. The following values are defined: + +LIPA\_NOTALLOWED (0) + +This value indicates that the UE is not allowed to use LIPA in the VPLMN where the UE is roaming. + +LIPA\_ALLOWED (1) + +This value indicates that the UE is allowed to use LIPA in the VPLMN where the UE is roaming. + +### 7.3.133 LIPA-Permission + +The LIPA-Permission AVP is of type Enumerated. It shall indicate whether the APN can be accessed via Local IP Access. The following values are defined: + +LIPA\_PROHIBITED (0) + +This value indicates that this APN is prohibited to be accessed via LIPA. + +LIPA\_ONLY (1) + +This value indicates that this APN can be accessed only via LIPA. + +LIPA\_CONDITIONAL (2) + +This value indicates that this APN can be accessed via both non LIPA and LIPA. + +### 7.3.134 Subscribed-Periodic-RAU-TAU-Timer + +The Subscribed-Periodic-RAU-TAU-Timer AVP is of type Unsigned32 and it shall contain the subscribed periodic RAU/TAU timer value in seconds as specified in 3GPP TS 24.008 [31]. + +### 7.3.135 SIPTO-Permission + +The SIPTO-Permission AVP is of type Enumerated. It shall indicate whether the traffic associated with this particular APN is allowed or not for SIPTO above RAN. + +The following values are defined: + +SIPTO\_above\_RAN\_ALLOWED (0) + +SIPTO\_above\_RAN\_NOTALLOWED (1) + +### 7.3.136 MDT-Configuration + +The MDT-Configuration AVP is of type Grouped. It shall contain MDT related information as specified in 3GPP TS 32.422 [23]. + +The AVP format shall conform to: + +MDT-Configuration ::= + +``` + + { Job-Type } + [ Area-Scope ] + [ List-Of-Measurements ] + [ Reporting-Trigger ] + [ Report-Interval ] + [ Report-Amount ] + [ Event-Threshold-RSRP ] + [ Event-Threshold-RSRQ ] + [ Logging-Interval ] + [ Logging-Duration ] + [ Measurement-Period-LTE ] + [ Measurement-Period-UMTS ] + [ Collection-Period- RRM-LTE ] + [ Collection-Period-RRM-UMTS ] + [ Positioning-Method ] + [ Measurement-Quantity ] + [ Event-Threshold-Event-1F ] + [ Event-Threshold-Event-1I ] + *[ MDT-Allowed-PLMN-Id ] + *[ MBSFN-Area ] + *[ AVP ] + +``` + +### 7.3.137 Job-Type + +The Job-Type AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Job-Type. + +### 7.3.138 Area-Scope + +The Area-Scope AVP is of type Grouped. See 3GPP TS 32.422 [23]. + +The AVP format shall conform to: + +``` +Area-Scope ::= + *[ Cell-Global-Identity ] + *[ E-UTRAN-Cell-Global-Identity ] + *[ Routing-Area-Identity ] + *[ Location-Area-Identity ] + *[ Tracking-Area-Identity ] + *[ AVP ] +``` + +### 7.3.139 List-Of-Measurements + +The List-Of-Measurements AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in 3GPP TS 32.422 [23]. The most significant bit is bit 8 of the first octet. + +### 7.3.140 Reporting-Trigger + +The Reporting-Trigger AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in 3GPP TS 32.422 [23]. The most significant bit is bit 8 of the first octet. + +### 7.3.141 Report-Interval + +The Report-Interval AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Report Interval + +### 7.3.142 Report-Amount + +The Report-Amount AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Report Amount. + +### 7.3.143 Event-Threshold-RSRP + +The Event-Threshold-RSRP AVP is of type Unsigned32. See 3GPP TS 32.422 [23] for allowed values + +### 7.3.144 Event-Threshold-RSRQ + +The Event-Threshold-RSRQ AVP is of type Unsigned32. See 3GPP TS 32.422 [23] for allowed values + +### 7.3.145 Logging-Interval + +The Logging-Interval AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Logging Interval + +### 7.3.146 Logging-Duration + +The Logging-Duration AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Logging Duration + +### 7.3.147 Relay-Node-Indicator + +The Relay-Node-Indicator AVP is of type Enumerated. It shall indicate whether the subscription data belongs to a Relay Node or not (see 3GPP TS 36.300 [40]). The following values are defined: + +NOT\_RELAY\_NODE (0) + +This value indicates that the subscription data does not belong to a Relay Node. + +RELAY\_NODE (1) + +This value indicates that the subscription data belongs to a Relay Node. + +The default value when this AVP is not present is NOT\_RELAY\_NODE (0). + +### 7.3.148 MDT-User-Consent + +The MDT-User-Consent AVP is of type Enumerated. It shall indicate whether the user has given his consent for MDT activation or not (see 3GPP TS 32.422 [23]). The following values are defined: + +CONSENT\_NOT\_GIVEN (0) + +CONSENT\_GIVEN (1) + +The default value when this AVP is not present in ULA is CONSENT\_NOT\_GIVEN (0). Absence of this AVP in IDR shall be interpreted as the MDT-User-Consent has not been modified. + +The presence of this subscription parameter in ULA or IDR shall be independent of the support of the Trace Function by the MME/SGSN (see clause 7.3.10). + +### 7.3.149 PUR-Flags + +The PUR-Flags AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.149/1: + +**Table 7.3.149/1: PUR-Flags** + +| bit | name | Description | +|-------|----------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | UE Purged in MME | This bit, when set, indicates that the combined MME/SGSN has purged the UE in the MME part of the node. This bit shall not be set by a standalone SGSN. | +| 1 | UE Purged in SGSN | This bit, when set, shall indicate that the combined MME/SGSN has purged the UE in the SGSN part of the node. This bit shall not be set by a standalone MME. | +| NOTE: | Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving HSS. | | + +### 7.3.150 Subscribed-VSRVCC + +The Subscribed-VSRVCC AVP is of type Enumerated. It shall indicate that the user is subscribed to the vSRVCC. The following value is defined: + +VSRVCC\_SUBSCRIBED (0) + +Absence of this AVP in IDR shall be interpreted as the Subscribed-VSRVCC has not been modified. + +Absence of this AVP in ULA shall be interpreted as the user is not subscribed to the vSRVCC. + +### 7.3.151 Equivalent-PLMN-List + +The Equivalent-PLMN-List AVP is of type Grouped. This AVP shall contain the equivalent PLMN IDs of the registered PLMN (i.e. the visited PLMN) of the MME or the SGSN. + +AVP format + +Equivalent-PLMN-List ::= + +1\*{ Visited-PLMN-Id } + +\*[AVP] + +### 7.3.152 CLR-Flags + +The CLR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.152/1: + +**Table 7.3.152/1: CLR-Flags** + +| Bit | Name | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | S6a/S6d-Indicator (Note 1) | This bit, when set, indicates that the CLR message is sent on the S6a interface, i.e. the message is to the MME or the MME part on the combined MME/SGSN.
This bit, when cleared, indicates that the CLR message is sent on the S6d interface, i.e. the message is to the SGSN or the SGSN part on the combined MME/SGSN. | +| 1 | Reattach-Required | This bit, when set, indicates that the MME or SGSN shall request the UE to initiate an immediate re-attach procedure as described in 3GPP TS 23.401 [2] and in 3GPP TS 23.060 [12]. | +| NOTE 1: The S6a/S6d-Indicator flag shall be used during initial attach procedure for a combined MME/SGSN. The S6a/S6d-Indicator flag may also be sent to a standalone node.
NOTE 2: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN.
NOTE 3: For the purpose of withdrawing "Aerial UE Subscription", HSS may send CLR with CLR-Flag set to Reattach-Required. | | | + +### 7.3.153 UVR-Flags + +The UVR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.154/1: + +**Table 7.3.154/1: UVR-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Skip Subscriber Data | This bit, when set, indicates that the CSS may skip subscription data in UVA. If the CSG subscription data has changed in the CSS after the last successful update of the MME/SGSN, the CSS shall ignore this bit and send the updated CSG subscription data. | +| Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving CSS. | | | + +### 7.3.154 UVA-Flags + +The UVA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.156/1: + +**Table 7.3.156/1: UVA-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------|---------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Temporary Empty VPLMN CSG Subscription Data | This bit, when set, indicates that the CSS has currently no VPLMN CSG subscription data for this user but has registered the MME or SGSN, so to inform them if later changes in VPLMN CSG subscription data occur. | +| Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving CSS. | | | + +### 7.3.155 VPLMN-CSG-Subscription-Data + +The VPLMN-CSG-Subscription-Data AVP is of type Grouped. This AVP shall contain the CSG-Id, and optionally an associated expiration date. + +AVP format + +``` +VPLMN-CSG-Subscription-Data ::= + { CSG-Id } + [ Expiration-Date ] + *[AVP] +``` + +### 7.3.156 Local-Time-Zone + +The Local-Time-Zone AVP is of type Grouped and shall contain the Time Zone and the Daylight Saving Time (DST) adjustment of the location in the visited network where the UE is attached. + +The AVP format shall conform to: + +``` +Local-Time-Zone ::= + { Time-Zone } + { Daylight-Saving-Time } + * [ AVP ] +``` + +### 7.3.157 A-MSISDN + +The A-MSISDN AVP is of type OctetString. See 3GPP TS 23.003 [3] for the definition of the Additional MSISDN. This AVP contains an A-MSISDN, in international number format as described in ITU-T Rec E.164 [41], encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +This AVP may be present in the Subscription-Data AVP when sent within ULA. + +It may also be present in the Subscription-Data AVP, sent within an IDR, if the current value in the MME or SGSN needs to be changed. + +### 7.3.158 Void + +### 7.3.159 MME-Number-for-MT-SMS + +The MME-Number-for-MT-SMS AVP is of type OctetString and it shall contain the ISDN number corresponding to the MME for MT SMS. For further details on the definition of this AVP, see 3GPP TS 23.003 [3]. This AVP contains an international number with the format as described in ITU-T Rec E.164 [41] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.160 Void + +### 7.3.161 Void + +### 7.3.162 SMS-Register-Request + +The SMS-Register-Request AVP is of type Enumerated and it shall indicate whether the MME or the SGSN requires to be registered for SMS (e.g. SGs interface not supported) or if the MME or the SGSN prefers not to be registered for SMS or if the MME or the SGSN has no preference. + +The following values are defined: + +SMS\_REGISTRATION\_REQUIRED (0) + +SMS\_REGISTRATION\_NOT\_PREFERRED (1) + +NO\_PREFERENCE (2) + +The criteria for setting these values are defined in 3GPP TS 23.272 [44] and 3GPP TS 23.060 [12]. + +When the MME/SGSN includes the SMS-Register-Request AVP in ULR in order to modify its registration status for SMS, the MME/SGSN shall not set the "Skip Subscriber Data" flag within the ULR-Flags AVP. + +### 7.3.163 Time-Zone + +The Time-Zone AVP is of type UTF8String and shall contain the time zone of the location in the visited network where the UE is attached. + +It contains the offset from UTC (Coordinated Universal Time) in units of 15 minutes, as defined in 3GPP TS 22.042 [42]. It shall be expressed as positive (i.e. with the leading plus sign [+]) if the local time is ahead of or equal to UTC of day and as negative (i.e. with the leading minus sign [-]) if it is behind UTC of day. + +The value contained in the Time-Zone AVP shall take into account daylight saving time, such that when the sending entity changes from regular (winter) time to daylight saving (summer) time, there is a change to the value in the Time-Zone AVP. + +The contents of the Time-Zone AVP shall be formatted as a character string with the following format: + +Basic format: $\pm n$ , with "n" being the number of units of 15 minutes from UTC. + +For example, if the offset is +2h=+8x15mn, the value of the Time-Zone AVP will be: "+8". + +### 7.3.164 Daylight-Saving-Time + +The Daylight-Saving-Time AVP is of type Enumerated and shall contain the Daylight Saving Time (in steps of 1 hour) used to adjust for summertime the time zone of the location where the UE is attached in the visited network. + +The following values are defined: + +NO\_ADJUSTMENT (0) + +PLUS\_ONE\_HOUR\_ADJUSTMENT (1) + +PLUS\_TWO\_HOURS\_ADJUSTMENT (2) + +### 7.3.165 Subscription-Data-Flags + +The Subscription-Data-Flags is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.165/1: + +**Table 7.3.165/1: Subscription-Data-Flags** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | PS-And-SMS-Only-Service-Provision-Indication | This bit, when set, indicates that the subscription is for PS Only and permits CS service access only for SMS. | +| 1 | SMS-In-SGSN-Allowed-Indication | This bit, when set, indicates that SMS in SGSN for the user is allowed. | +| 2 | User Plane Integrity Protection | This bit, when set, indicates that the SGSN may decide to activate integrity protection of the user plane when GERAN is used (see 3GPP TS 43.020 [58]). The MME shall ignore it. | +| 3 | PDN-Connection-Restricted | This bit, when set, indicates to the MME that it shall not establish any non-emergency PDN connection for this user if the MME and the UE supports Attach without PDN connection. The SGSN shall ignore it. | +| 4 | Acknowledgement-Of-Downlink-NAS-Data PDUs disabled | This bit, when set, indicates to the MME that acknowledgement of downlink NAS data PDUs for Control Plane CIoT Optimization is disabled for this UE (even for APN configurations with RDS Indicator set to ENABLED (1)). When not set it indicated to the MME that acknowledgement of downlink NAS data PDUs for Control Plane CIoT Optimization is enabled (for APN configurations with RDS Indicator set to ENABLED (1)) for this UE, which is the default (see 3GPP TS 23.401 [2]). The SGSN shall ignore it. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 7.3.166 Measurement-Period-LTE + +The Measurement-Period-LTE AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Measurement period LTE. + +### 7.3.167 Measurement-Period-UMTS + +The Measurement-Period-UMTS AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Measurement period UMTS. + +### 7.3.168 Collection-Period-RRM-LTE + +The Collection-Period-RRM-LTE AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Collection period for RRM measurements LTE. + +### 7.3.169 Collection-Period-RRM-UMTS + +The Collection-Period-RRM-UMTS AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Collection period for RRM measurements UMTS. + +### 7.3.170 Positioning-Method + +The Positioning-Method AVP is of type OctetString. It contains one octet carrying a bit map of 8 bits. The possible values are those defined in 3GPP TS 32.422 [23] for Positioning Method. + +### 7.3.171 Measurement-Quantity + +The Measurement-Quantity AVP is of type OctetString. It contains one octet carrying a bit map of 8 bits. The possible values are those defined in 3GPP TS 32.422 [23] for Measurement quantity. + +### 7.3.172 Event-Threshold-Event-1F + +The Event-Threshold-Event-1F AVP is of type Integer32. See 3GPP TS 32.422 [23] for allowed values. + +### 7.3.173 Event-Threshold-Event-1I + +The Event-Threshold-Event-1I AVP is of type Integer32. See 3GPP TS 32.422 [23] for allowed values + +### 7.3.174 Restoration-Priority + +The Restoration-Priority AVP is of type Unsigned32. It shall indicate the relative priority of a user's PDN connection among PDN connections to the same APN when restoring PDN connections affected by an SGW or PGW failure/restart (see 3GPP TS 23.007 [43]). + +Values 1 to 16 are defined, with value 1 as the highest level of priority. + +### 7.3.175 SGs-MME-Identity + +The SGs-MME-Identity AVP is of type UTF8String. This AVP shall contain the MME identity used over the SGs interface and specified in 3GPP TS 23.003 [3] clause 19.4.2.4. + +### 7.3.176 SIPTO-Local-Network-Permission + +The SIPTO-Local-Network-Permission AVP is of type Unsigned32. It shall indicate whether the traffic associated with this particular APN is allowed or not for SIPTO at the local network. + +The following values are defined: + +| | | +|-------------------------------------|---| +| "SIPTO at Local Network ALLOWED" | 0 | +| "SIPTO at Local Network NOTALLOWED" | 1 | + +### 7.3.177 Coupled-Node-Diameter-ID + +The Coupled-Node-Diameter-ID AVP is of type DiameterIdentity. This AVP shall contain the S6a or S6d Diameter identity of the coupled node as specified in 3GPP TS 23.003 [3] clause 19.4.2.4 and clause 19.4.2.6. + +### 7.3.178 OC-Supported-Features + +The OC-Supported-Features AVP is of type Grouped and it is defined in IETF RFC 7683 [50]. This AVP is used to support Diameter overload control mechanism, see Annex C for more information. + +### 7.3.179 OC-OLR + +The OC-OLR AVP is of type Grouped and it is defined in IETF RFC 7683 [50]. This AVP is used to support Diameter overload control mechanism, see Annex C for more information. + +### 7.3.180 ProSe-Subscription-Data + +The ProSe-Subscription-Data AVP is of type Grouped. It shall contain the ProSe related subscription data. It was originally defined in 3GPP TS 29.344 [49]. + +AVP format + +``` +ProSe-Subscription-Data ::= + { ProSe-Permission } + *[AVP] +``` + +### 7.3.181 WLAN-offloadability + +The WLAN-offloadability AVP is of type Grouped. This AVP contains WLAN offloadability for E-UTRAN or UTRAN. + +AVP format: + +``` +WLAN-offloadability ::= + [ WLAN-offloadability-EUTRAN ] + [ WLAN-offloadability-UTRAN ] + *[ AVP ] +``` + +### 7.3.182 WLAN-offloadability-EUTRAN + +The WLAN-offloadability-EUTRAN AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.182/1: + +**Table 7.3.182/1: WLAN-offloadability-EUTRAN** + +| bit | name | Description | +|-------|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | WLAN offloadability for E-UTRAN | This bit, when set, shall indicate that the traffic associated with the APN is allowed to be offloaded to WLAN from E-UTRAN using the WLAN/3GPP Radio Interworking feature. If not set, it means the traffic associated with the APN is not allowed to be offloaded to WLAN from E-UTRAN. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | + +### 7.3.183 WLAN-offloadability-UTRAN + +The WLAN-offloadability-UTRAN AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.183/1: + +**Table 7.3.183/1: WLAN-offloadability-UTRAN** + +| bit | name | Description | +|-------|-----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | WLAN offloadability for UTRAN | This bit, when set, shall indicate that the traffic associated with the APN is allowed to be offloaded to WLAN from UTRAN using the WLAN/3GPP Radio Interworking feature. If not set, it means the traffic associated with the APN is not allowed to be offloaded to WLAN from UTRAN. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN.. | | + +### 7.3.184 Reset-ID + +The Reset-ID is of type OctetString. The value shall uniquely (within the HSS's realm) identify a resource in the HSS that may fail or has restarted. + +In the Reset procedure, when used to add/modify/delete subscription data shared by multiple subscribers, the Reset-ID is used to identify the set of affected subscribers. + +### 7.3.185 MDT-Allowed-PLMN-Id + +The MDT-Allowed-PLMN-Id AVP is of type OctetString. This AVP shall contain the concatenation of MCC and MNC. See 3GPP TS 23.003 [3]. The content of this AVP shall be encoded as an octet string according to table 7.3.185/1. + +This AVP identifies the PLMN in which the MDT data collection shall take place. + +See 3GPP TS 24.008 [31], clause 10.5.1.13, PLMN list, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 2 are coded as "1111". + +**Table 7.3.185/1: Encoding format for MDT-Allowed-PLMN-Id AVP** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---|---|---|---|---|---|---|---|--| +| | | | | | | | | | +| | | | | | | | | | +| | | | | | | | | | + +### 7.3.186 Adjacent-PLMNs + +The Adjacent-PLMNs AVP is of type Grouped. This AVP shall contain a list of PLMN IDs where an UE served by the MME/SGSN is likely to make a handover from the PLMN where the MME/SGSN is located. + +AVP format: + +Adjacent-PLMNs ::= + +1\*{ Visited-PLMN-Id } + +\*[AVP] + +### 7.3.187 Adjacent-Access-Restriction-Data + +The Adjacent-Access-Restriction-Data AVP is of type Grouped. This AVP shall contain a pair of PLMN ID and the associated Access Restriction Data for that PLMN. + +AVP format: + +Adjacent-Access-Restriction-Data ::= + +{ Visited-PLMN-Id } + +{ Access-Restriction-Data } + +\*[AVP] + +### 7.3.188 DL-Buffering-Suggested-Packet-Count + +The DL-Buffering-Suggested-Packet-Count AVP is of type Integer32. It shall indicate whether extended buffering of downlink packets at the SGW, for High Latency Communication, is requested or not. When requested, it may also suggest the number of downlink packets to buffer at the SGW for this user. + +The following values are defined: + +"Extended DL Data Buffering NOT REQUESTED" 0 + +"Extended DL Data Buffering REQUESTED, without a suggested number of packets" -1 + +"Extended DL Data Buffering REQUESTED, with a suggested number of packets" > 0 + +"Extended DL Data Buffering REQUESTED", with or without a suggested number of packets to be buffered for this user, indicates that extended buffering of downlink packets at the SGW is applicable to this user. + +"Extended DL Data Buffering NOT REQUESTED" indicates that extended buffering of downlink packets at the SGW is not applicable to this user. + +### 7.3.189 IMSI-Group-Id + +The IMSI-Group-Id AVP shall be of type Grouped. This AVP shall contain the information about the IMSI-Group-Id. + +AVP format + +IMSI-Group-Id ::= + +{ Group-Service-Id } +{ Group-PLMN-Id } +{ Local-Group-Id } +\*[AVP] + +For details see 3GPP TS 23.003 [3], clause 19.9). + +### 7.3.190 Group-Service-Id + +The Group-Service-Id AVP is of type Unsigned32 and it shall identify the specific service for which the IMSI-Group-Id is used. The following values are defined: + +**Table 7.3.190-1: Group-Service-Id** + +| Value | Description | +|-------|---------------------------------------------------------------------------| +| 1 | Group specific NAS level congestion control | +| 2 | Group specific Monitoring of Number of UEs present in a geographical area | + +Values greater than 1000 are reserved for home operator specific use. IMSI-Group-IDs with a Group-Service-Id in this range shall not be sent outside the HPLMN unless roaming agreements allow so. + +### 7.3.191 Group-PLMN-Id + +The Group-PLMN-Id AVP is of type OctetString. This AVP shall contain the concatenation of MCC and MNC. See 3GPP TS 23.003 [3]. The content of this AVP shall be encoded as an octet string according to table 7.3.191-1. + +See 3GPP TS 24.008 [31], clause 10.5.1.13, PLMN list, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 2 are coded as "1111". + +**Table 7.3.191-1: Encoding format for Group-PLMN-Id AVP** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|-------------|---|---|---|-------------|---|---|---|---------| +| MCC digit 2 | | | | MCC digit 1 | | | | octet 1 | +| MNC digit 3 | | | | MCC digit 3 | | | | octet 2 | +| MNC digit 2 | | | | MNC digit 1 | | | | octet 3 | + +### 7.3.192 Local-Group-Id + +The Local-Group-Id AVP is of type OctetString. It shall contain an operator defined value, representing a group. + +### 7.3.193 AESE-Communication-Pattern + +AESE-Communication-Pattern AVP is of type Grouped and is defined in 3GPP TS 29.336 [54]. + +AVP format + +AESE-Communication-Pattern ::= + +[ SCEF-Reference-ID ] +[ SCEF-Reference-ID-Ext ] +{ SCEF-ID } +\*[ SCEF-Reference-ID-for-Deletion ] +\*[ SCEF-Reference-ID-for-Deletion-Ext ] +\*[ Communication-Pattern-Set ] +[ MTC-Provider-Info ] +\*[AVP] + +At least one reference ID (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext) or a reference ID for deletion (either in SCEF-Reference-ID-for-Deletion or in SCEF-Reference-ID-for-Deletion-Ext) shall be present. + +When the "Extended Reference IDs" feature is supported by the HSS and MME/SGSN, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used insted of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. + +### 7.3.194 Communication-Pattern-Set + +Communication-Pattern-Set AVP is of type Grouped and is defined in 3GPP TS 29.336 [54]. + +AVP format + +Communication-Pattern-Set ::= + +[ Periodic-Communication-Indicator ] +[ Communication-Duration-Time ] +[ Periodic-Time ] +\*[ Scheduled-Communication-Time ] +[ Stationary-Indication ] +[ Reference-ID-Validity-Time ] +[ Traffic-Profile ] +[ Battery-Indicator ] +\*[AVP] + +If the Reference-ID-Validity-Time AVP is absent, it indicates that there is no expiration time defined for the Communication-Pattern-Set. + +### 7.3.195 Monitoring-Event-Configuration + +The Monitoring-Event-Configuration AVP is of type Grouped. It shall contain the Monitoring event configuration related subscription data. It is originally defined in 3GPP TS 29.336 [54]. + +For S6a/S6d interface, the Monitoring-Event-Configuration AVP format is specified as following: + +AVP format: + +Monitoring-Event-Configuration ::= + +``` + +[ SCEF-Reference-ID ] +[ SCEF-Reference-ID-Ext ] +{ SCEF-ID } +{ Monitoring-Type } +*[ SCEF-Reference-ID-for-Deletion ] +*[ SCEF-Reference-ID-for-Deletion-Ext ] +[ Maximum-Number-of-Reports ] +[ Monitoring-Duration ] +[ Charged-Party ] +[ UE-Reachability-Configuration ] +[ Location-Information-Configuration ] +[ SCEF-Realm ] +[ External-Identifier ] +[ MTC-Provider-Info ] +[ PDN-Connectivity-Status-Configuration ] +*[ AVP ] + +``` + +When the Monitoring-Event-Configuration AVP is used over the S6a/S6d interfaces, the SCEF-Realm AVP shall be present and its value shall be obtained by the HSS from the Origin-Realm AVP of the Configuration-Information-Request command conveying the corresponding monitoring event configuration over the S6t interface from the SCEF to the HSS. + +The Monitoring-Type AVP shall only be taken into account in combination with SCEF-Reference-ID/SCEF-Reference-ID-Ext AVP; Monitoring-Type AVP shall be ignored for deletion of an event (i.e. when SCEF-Reference-ID-for-Deletion/SCEF-Reference-ID-for-Deletion-Ext AVP is present). + +Maximum-Number-of-Reports shall not be present over S6a/S6d interfaces if Monitoring-Type is AVAILABILITY\_AFTER\_DDN\_FAILURE (6). + +Maximum-Number-of-Reports shall not be greater than one over S6a/S6d interfaces if Monitoring-Type is LOCATION\_REPORTING (2) and MONTE-Location-Type is LAST\_KNOWN\_LOCATION (1). + +When multiple External Identifiers are defined for the same subscription, the External-Identifier in this grouped AVP, if present, shall contain the specific External Identifier to be associated with this monitoring event; if it is not present, the External Identifier associated with this monitoring event shall be the default External Identifier defined in the subscription (see clause 7.3.2). + +When the "Extended Reference IDs" feature is supported by the HSS and MME/SGSN, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used insted of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. + +### 7.3.196 Monitoring-Event-Report + +The Monitoring-Event-Report AVP is of type Grouped. It shall contain the Monitoring event report data. It is originally defined in 3GPP TS 29.336 [54]. + +For S6a/S6d interface, the Monitoring-Event-Report AVP format is specified as following: + +AVP format: + +``` +Monitoring Event Report ::= + { SCEF-Reference-ID } + [ SCEF-Reference-ID-Ext ] + [ SCEF-ID ] + [ Reachability-Information ] + [ Reachability-Cause ] + [ EPS-Location-Information ] + [ Monitoring-Type ] + [ Loss-Of-Connectivity-Reason ] + [ Idle-Status-Indication ] + [ Maximum-UE-Availability-Time ] + *[ PDN-Connectivity-Status-Report ] + *[ AVP ] +``` + +For S6a/S6d interface, when the Monitoring-Type AVP takes the value UE\_REACHABILITY (1), the Reachability-Information AVP shall take the value REACHABLE\_FOR\_DATA (1), and the Reachability-Cause AVP may be present. + +For S6a/S6d interface, when the Monitoring-Type AVP takes the value PDN\_CONNECTIVITY\_STATUS (10), the PDN-Connectivity-Status-Report AVP(s) shall contain the list of active PDNs, for the given APN provided in the monitoring event configuration, or for all APNs if no APN was provided; each PDN-Connectivity-Status-Report shall have the PDN-Connectivity-Status-Type set to value "CREATED (0)". + +When the "Extended Reference IDs" feature is supported by the HSS and MME/SGSN, the SCEF-Reference-ID-Ext AVP shall be used insted of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. + +### 7.3.197 UE-Reachability-Configuration + +The UE-Reachability-Configuration AVP is of type Grouped, and it shall contain the details for configuration for UE reachability. It is originally defined in 3GPP TS 29.336 [54]. + +For S6a/S6d interface, the UE-Reachability-Configuration AVP format is specified as following: + +AVP format: + +``` +UE-Reachability-Configuration ::= + [ Reachability-Type ] + [ Maximum-Response-Time ] + *[ AVP ] +``` + +NOTE: When a Maximum-Response-Time value is not received from the SCEF, the HSS can send an O&M configured desired active time value within the Maximum-Response-Time AVP. + +For S6a/S6d interface, the Reachability-Type AVP shall have bit 0 ("Reachability for SMS") cleared, and it shall have bit 1 ("Reachability for Data") set. + +### 7.3.198 eNodeB-ID + +The eNodeB-ID AVP is of type OctetString, and indicates the eNodeB in which the UE is currently located. It is originally defined in 3GPP TS 29.217 [56]. + +### 7.3.199 Supported-Services + +The Supported-Services AVP is of type Grouped and it shall contain the different bit masks representing the services supported by the MME/SGSN: + +AVP format + +``` +Supported-Services ::= + [ Supported-Monitoring-Events ] + *[AVP] +``` + +### 7.3.200 Supported-Monitoring-Events + +The Supported-Monitoring-Events AVP is of type Unsigned64 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.200-1: + +**Table 7.3.200 -1: Supported-Monitoring-Events** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 0 | UE and UICC and/or new IMSI-IMEI-SV association | only used on S6t interface | +| 1 | UE-reachability | This bit shall be set if UE reachability Monitoring event is supported in the MME/SGSN | +| 2 | Location-of-the-UE | This bit shall be set if Location of the UE and change in location of the UE Monitoring event is supported in the MME/SGSN | +| 3 | Loss-of-connectivity | This bit shall be set if Loss of connectivity Monitoring event is supported in the MME/SGSN | +| 4 | Communication-failure | This bit shall be set if Communication failure Monitoring event is supported in the MME/SGSN | +| 5 | Roaming-status | only used on S6t interface | +| 6 | Availability after DDN failure | This bit shall be set if Availability after DDN failure Monitoring event is supported in the MME/SGSN | +| 7 | Idle Status Indication | This bit shall be set if Idle Status Indication reporting is supported in the MME/SGSN | +| 8 | PDN Connectivity Status | This bit shall be set if PDN Connectivity Status monitoring event is supported in the MME/SGSN | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 7.3.201 AIR-Flags + +The AIR-Flags AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.201/1: + +**Table 7.3.201/1: AIR-Flags** + +| bit | name | Description | +|----------------------------------------------------------------------------------------------------------------------|--------------------|-------------------------------------------------------------------------------------------------------------------------| +| 0 | Send UE Usage Type | This bit, when set, indicates that the MME or SGSN requests the HSS to send the subscription parameter "UE Usage Type". | +| NOTE: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving HSS. | | | + +### 7.3.202 UE-Usage-Type + +The UE-Usage-Type AVP is of type Unsigned32. This value shall indicate the usage characteristics of the UE that enables the selection of a specific Dedicated Core Network (DCN). See clause 4.3.25 of 3GPP TS 23.401 [2]. + +The allowed values of UE-Usage-Type shall be in the range of 0 to 255. + +Values in the range of 0 to 127 are standardized and defined as follows: + +0: Spare, for future use + +... + +127: Spare, for future use + +Values in the range of 128 to 255 are operator-specific. + +### 7.3.203 DRMP + +The DRMP AVP is of type Enumerated and it is defined in IETF RFC 7944 [57]. This AVP allows the HSS, the CSS, the EIR and the MME/SGSN to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +### 7.3.204 Non-IP-PDN-Type-Indicator + +The Non-IP-PDN-Type-Indicator AVP is of type Enumerated and indicates whether the APN has a Non-IP PDN type. + +The following values are defined: + +FALSE (0) + +This value indicates that the APN does not have a Non-IP PDN type. + +TRUE (1) + +This value indicates that the APN has a Non-IP PDN type and, in this case, the value indicated by the PDN-Type AVP inside APN-Configuration AVP shall be ignored. + +The default value when this AVP is not present is FALSE (0). + +### 7.3.205 Non-IP-Data-Delivery-Mechanism + +The Non-IP-Data-Delivery-Mechanism AVP is of type Unsigned32 and indicates the mechanism to be used for Non-IP data delivery for a given APN. The following values are defined: + +SGI-BASED-DATA-DELIVERY (0) + +This value indicates that the Non-IP data is delivered via Point-To-Point tunnelling over the SGI interface. + +SCEF-BASED-DATA-DELIVERY (1) + +This value indicates that the Non-IP data is delivered via the SCEF. + +The default value when this AVP is not present is SGI-BASED-DATA-DELIVERY (0). + +### 7.3.206 Additional-Context-Identifier + +The Additional-Context-Identifier AVP is of type Unsigned32 and indicates the identity of another default APN to be used when the subscription profile of the user contains APNs with more than one PDN type among IP-based PDN types, non-IP PDN types and Ethernet PDN types. + +### 7.3.207 SCEF-Realm + +The SCEF-Realm AVP is of type DiameterIdentity and it shall contain the Diameter realm of the SCEF. For further details on the encoding of this AVP, see IETF RFC 6733 [61]. + +### 7.3.208 Subscription-Data-Deletion + +The Subscription-Data-Deletion AVP is of type Grouped and indicates the shared subscription data that need to be deleted from the subscription profiles of the impacted subscribers. + +AVP format + +Subscription-Data-Deletion ::= + +``` +{ DSR-Flags } +[ SCEF-ID ] +*[ Context-Identifier ] +[ Trace-Reference ] +*[ TS-Code ] +*[ SS-Code ] +*[ AVP ] +``` + +### 7.3.209 Preferred-Data-Mode + +The Preferred-Data-Mode AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.209/1: + +**Table 7.3.209/1: Preferred-Data-Mode** + +| bit | name | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Data over User Plane Preferred | This bit, when set, shall indicate that the User Plane is preferred for transmitting the traffic associated with the APN. If not set, it means that the User Plane is not preferred for transmitting the traffic associated with the APN. | +| 1 | Data over Control Plane Preferred | This bit, when set, shall indicate that the Control Plane is preferred for transmitting the traffic associated with the APN. If not set, it means that the Control Plane is not preferred for transmitting the traffic associated with the APN. | +| NOTE 1: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME.
NOTE 2: At least one of the bits 0 and 1 shall be set to 1. Both bits 0 and 1 may be set to 1 to indicate that both User Plane and Control Plane are preferred for transmitting the traffic associated with the APN.
NOTE 3: This parameter only applies to E-UTRAN and SGi PDN connections. Data over User Plane refers to PDN data transported over S1-U and Data Radio Bearer. Data over Control Plane refers to PDN data transported over NAS and Signalling Radio Bearer. | | | + +### 7.3.210 Emergency-Info + +The Emergency-Info AVP is of type Grouped. It shall contain the identity of the PDN-GW used for the establishment of emergency PDN connections. + +The AVP format shall conform to: + +Emergency-Info ::= + +[ MIP6-Agent-Info ] + \*[ AVP ] + +### 7.3.211 Load + +The Load AVP is of type Grouped and it is defined in IETF RFC 8583 [60]. This AVP is used to support Diameter load control mechanism, see Annex F for more information. + +### 7.3.212 V2X-Subscription-Data + +The V2X-Subscription-Data AVP is of type Grouped. It shall contain the V2X related subscription data for the network scheduled LTE sidelink communication.. + +AVP format: + +V2X-Subscription-Data ::= + [ V2X-Permission ] + [ UE-PC5-AMBR ] + \*[AVP] + +The UE-PC5-AMBR AVP within the V2X-Subscription-Data AVP indicates the UE AMBR used for LTE PC5 interface. + +### 7.3.213 V2X-Permission + +The V2X-Permission AVP is of type Unsigned32 and it shall contain a bit mask that indicates the permissions for V2X service subscribed by the user. The meaning of the bits shall be as defined in table 7.3.x2-1: + +**Table 7.3.x2-1: V2X-Permission** + +| Bit | Name | Description | +|--------------------------------------------------------------------------------------------|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| 0 | Allow V2X communication over PC5 as Vehicle UE | This bit, when set, indicates that the user is allowed to use V2X communication over PC5 as Vehicle UE in the serving PLMN. | +| 1 | Allow V2X communication over PC5 as Pedestrian UE | This bit, when set, indicates that the user is allowed to use V2X communication over PC5 as Pedestrian UE in the serving PLMN. | +| NOTE: Bits not defined in this table shall be cleared by the HSS and discarded by the MME. | | | + +### 7.3.214 PDN-Connection-Continuity + +The PDN-Connection-Continuity AVP is of type Unsigned32 and indicates how to handle the PDN connection when the UE moves between "broadband" (WB-E-UTRAN, UTRAN) and "narrowband" (NB-IoT, GPRS, EC-GSM-IoT). The following values are defined: + +MAINTAIN-PDN-CONNECTION (0) + +DISCONNECT-PDN-CONNECTION-WITH-REACTIVATION-REQUEST (1) + +DISCONNECT-PDN-CONNECTION-WITHOUT-REACTIVATION-REQUEST (2) + +This AVP corresponds to the "PDN continuity at inter RAT mobility" field as defined in 3GPP TS 23.401 [2] table 5.7.1-1. + +### 7.3.215 eDRX-Cycle-Length + +The eDRX-Cycle-Length AVP is of type Grouped. This AVP shall contain an eDRX cycle length, along with the RAT type for which this cycle length is applicable to (e.g. E-UTRAN and NB-IOT). + +AVP format: + +``` +eDRX-Cycle-Length ::= + { RAT-Type } + { eDRX-Cycle-Length-Value } + *[ AVP ] +``` + +### 7.3.216 eDRX-Cycle-Length-Value + +The eDRX-Cycle-Length-Value AVP is of type OctetString. This AVP shall contain the extended DRX cycle value subscribed for this user for a given RAT type. The contents of eDRX-Cycle-Length-Value shall consist of 1 octet. + +The encoding shall be as defined in 3GPP TS 24.008 [31], clause 10.5.5.32, and it shall only contain the value of the field "eDRX value" for a given RAT type, i.e., the 4 least significant bits of the octet in this AVP shall contain bits 1-4 of octet 3 in the "Extended DRX parameter" IE (see Figure 10.5.5.32 of 3GPP TS 24.008 [31]), and the 4 most significant bits of the octet in this AVP shall be set to 0. + +### 7.3.217 UE-PC5-AMBR + +The UE-PC5-AMBR AVP is of type Unsigned32. It indicates the maximum bits delivered by UE over the PC5 interface within a period of time. The unit of UE-PC5-AMBR is bits/s. + +### 7.3.218 Extended eNodeB-ID + +The Extended eNodeB-ID AVP is of type OctetString, and indicates the eNodeB in which the UE is currently located. It is originally defined in 3GPP TS 29.217 [56]. + +### 7.3.219 MBSFN-Area + +The MBSFN-Area AVP is of type Grouped. It contains a MBSFN Area ID and a Carrier Frequency (see 3GPP TS 32.422 [23]). + +The AVP format shall conform to: + +``` +MBSFN-Area ::= + [ MBSFN-Area-ID ] + [ Carrier-Frequency ] + *[ AVP ] +``` + +If both MBSFN-Area-ID and Carrier-Frequency values are present, a specific MBSFN area is indicated. If Carrier-Frequency value is present, but MBSFN-Area-ID is absent, all MBSFN areas on that carrier frequency are indicated. If both MBSFN-Area-ID and Carrier-Frequency are absent, any MBSFN area is indicated. + +### 7.3.220 MBSFN-Area-ID + +The MBSFN-Area-ID AVP is of type Unsigned32 and it shall contain the MBSFN Area ID value, in the range of 0..255 (see 3GPP TS 36.331 [62]). + +### 7.3.221 Carrier-Frequency + +The Carrier-Frequency AVP is of type Unsigned32 and it shall contain the Carrier Frequency value, in the range of 0..262143 (see 3GPP TS 36.331 [62]). + +### 7.3.222 RDS-Indicator + +The RDS-Indicator AVP is of type Enumerated and indicates whether the Reliable Data Service (RDS) is enabled or disabled for the APN. See 3GPP TS 23.682 [55]. + +The following values are defined: + +DISABLED (0) + +ENABLED (1) + +The default value when this AVP is not present is DISABLED (0). + +### 7.3.223 Service-Gap-Time + +The Service-Gap-Time AVP is of type Unsigned32 and indicates the minimum number of seconds during which the UE shall stay in ECM-IDLE mode, after leaving the ECM-CONNECTED mode, before being allowed to send a subsequent connection request to enter ECM-CONNECTED mode again. See description of the Service Gap Control feature in 3GPP TS 23.401 [2]. + +### 7.3.224 Aerial-UE-Subscription-Information + +The Aerial-UE-Subscription-Information AVP is of type Unsigned32 and indicates the subscription of Aerial UE function. The following values are defined: + +AERIAL\_UE\_ALLOWED (0) + +AERIAL\_UE\_NOT\_ALLOWED (1) + +This AVP corresponds to the "Aerial UE subscription information" information element as defined in 3GPP TS 36.413[19] and TS 36.423 [65]. + +### 7.3.225 Broadcast-Location-Assistance-Data-Types + +The Broadcast-Location-Assistance-Data-Types AVP is of type Unsigned64. The content of this AVP is a bit mask which indicates the broadcast location assistance data types for which the UE is subscribed to receive ciphering keys used to decipher broadcast assistance data. + +The meaning of the bits is defined in table 7.3.225-1: + +**Table 7.3.225-1: Broadcast-Location-Assistance-Data-Types** + +| bit | name | Description | +|-----|---------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 0 | Positioning SIB Type 1-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-1. | +| 1 | Positioning SIB Type 1-2 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-2. | +| 2 | Positioning SIB Type 1-3 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-3. | +| 3 | Positioning SIB Type 1-4 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-4. | +| 4 | Positioning SIB Type 1-5 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-5. | +| 5 | Positioning SIB Type 1-6 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-6. | +| 6 | Positioning SIB Type 1-7 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-7. | +| 7 | Positioning SIB Type 2-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-1. | +| 8 | Positioning SIB Type 2-2 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-2. | +| 9 | Positioning SIB Type 2-3 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-3. | +| 10 | Positioning SIB Type 2-4 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-4. | +| 11 | Positioning SIB Type 2-5 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-5. | +| 12 | Positioning SIB Type 2-6 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-6. | +| 13 | Positioning SIB Type 2-7 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-7. | +| 14 | Positioning SIB Type 2-8 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-8. | +| 15 | Positioning SIB Type 2-9 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-9. | +| 16 | Positioning SIB Type 2-10 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-10. | +| 17 | Positioning SIB Type 2-11 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-11. | +| 18 | Positioning SIB Type 2-12 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-12. | +| 19 | Positioning SIB Type 2-13 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-13. | +| 20 | Positioning SIB Type 2-14 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-14. | +| 21 | Positioning SIB Type 2-15 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-15. | +| 22 | Positioning SIB Type 2-16 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-16. | +| 23 | Positioning SIB Type 2-17 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-17. | +| 24 | Positioning SIB Type 2-18 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-18. | +| 25 | Positioning SIB Type 2-19 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-19. | +| 26 | Positioning SIB Type 3-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 3-1. | +| 27 | Positioning SIB Type 1-8 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-8. | +| 28 | Positioning SIB Type 2-20 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-20. | +| 29 | Positioning SIB Type 2-21 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-21. | +| 30 | Positioning SIB Type 2-22 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-22. | +| 31 | Positioning SIB Type 2-23 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-23. | +| 32 | Positioning SIB Type 2-24 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-24. | + +| | | | +|-------|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 33 | Positioning SIB Type 2-25 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-25. | +| 34 | Positioning SIB Type 4-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 4-1. | +| 35 | Positioning SIB Type 5-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 5-1. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | + +### 7.3.226 Paging-Time-Window + +The Paging-Time-Window AVP is of type Grouped. This AVP shall contain the Paging Time Window length, along with the Operation Mode (see clause 7.3.227) for which this time window length is applicable to. + +AVP format: + +``` +Paging-Time-Window ::= + { Operation-Mode } + { Paging-Time-Window-Length } + *[ AVP ] +``` + +### 7.3.227 Operation-Mode + +The Operation-Mode AVP is of type Unsigned32. This value shall indicate the operation mode for which the Paging-Time-Window-Length applies. See clause 3GPP TS 24.008 [31], clause 10.5.5.32. + +The allowed values of Operation-Mode shall be in the range of 0 to 255. + +Values are defined as follows: + +- 0: Spare, for future use +- 1: Iu mode +- 2: WB-S1 mode +- 3: NB-S1 mode +- 4 to 255: Spare, for future use + +### 7.3.228 Paging-Time-Window-Length + +The Paging-Time-Window-Length AVP is of type OctetString. This AVP shall contain the Paging time window length subscribed for this user for a given operation mode. The contents of Paging-Time-Window-Length shall consist of 1 octet. + +The encoding shall be as defined in 3GPP TS 24.008 [31], clause 10.5.5.32, and it shall only contain the value of the field "Paging Time Window length" for a given RAT type, i.e., the 4 most significant bits of the octet in this AVP shall contain bits 5-8 of octet 3 in the "Extended DRX parameter" IE (see Figure 10.5.5.32 of 3GPP TS 24.008 [31]), and the 4 least significant bits of the octet in this AVP shall be set to 0. + +### 7.3.229 eDRX-Related-RAT + +The eDRX-Related-RAT AVP is of type Grouped. This AVP shall contain the RAT type to which the eDRX Cycle Length is related: + +AVP format + +``` +eDRX-Related-RAT ::= +``` + +1 \* { RAT-Type } + \*[AVP] + +### 7.3.230 Core-Network-Restrictions + +The Core-Network-Restrictions AVP is of type Unsigned32 and shall contain a bitmask indicating the types of Core Network that are disallowed for a given user. The meaning of the bits shall be as defined in table 7.3.230-1: + +**Table 7.3.230-1: Core-Network-Restrictions** + +| Bit | Name | Description | +|-------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| +| 0 | Reserved | The use of this bit is deprecated. This bit shall be discarded by the receiving MME. | +| 1 | 5GC not allowed | Access to 5GC not allowed. | +| NOTE: | Bits not defined in this table shall be cleared by the HSS and discarded by the MME. | | + +### 7.3.231 Interworking-5GS-Indicator + +The Interworking-5GS-Indicator AVP is of type Enumerated and indicates whether the interworking between 5GS and EPS is subscribed or not subscribed for the APN. See 3GPP TS 23.502 [67]. + +The following values are defined: + +NOT-SUBSCRIBED (0) + +SUBSCRIBED (1) + +The default value when this AVP is not present is NOT-SUBSCRIBED (0). + +### 7.3.232 Ethernet-PDN-Type-Indicator + +The Ethernet-PDN-Type-Indicator AVP is of type Enumerated and indicates whether the APN has an Ethernet PDN type. + +The following values are defined: + +FALSE (0) + +This value indicates that the APN does not have an Ethernet PDN type. + +TRUE (1) + +This value indicates that the APN has an Ethernet PDN type and in this case the value indicated by the PDN-Type AVP inside APN-Configuration AVP shall be ignored. + +The default value when this AVP is not present is FALSE (0). + +### 7.3.233 Subscribed-ARPI + +The Subscribed-ARPI AVP is of type Unsigned32 and shall contain the subscribed value of the Additional RRM Policy Index. For details, see 3GPP TS 23.401 [2]. + +### 7.3.234 IAB-Operation-Permission + +The IAB-Operation-Permission AVP is of type Enumerated. It shall indicate to the MME or SGSN whether the UE is allowed for IAB operation. See 3GPP TS 23.401 [2]. + +The following values are defined: + +IAB\_OPERATION\_ALLOWED (0) + +IAB\_OPERATION\_NOTALLOWED (1) + +### 7.3.235 V2X-Subscription-Data-Nr + +The V2X-Subscription-Data-Nr AVP is of type Grouped. It shall contain the V2X related subscription data for the network scheduled NR sidelink communication. + +AVP format: + +``` +V2X-Subscription-Data-Nr ::= + [ V2X-Permission ] + [ UE-PC5-AMBR ] + [ UE-PC5-QoS ] + *[AVP] +``` + +The UE-PC5-AMBR AVP within the V2X-Subscription-Data AVP indicates the UE AMBR used for NR PC5 interface. + +### 7.3.236 UE-PC5-QoS + +The UE-PC5-QoS AVP is of type Grouped. It shall contain the PC5 QoS parameters for V2X communication over NR PC5 reference point. + +AVP format: + +``` +UE-PC5-QoS ::= + 1*{ PC5-QoS-Flow } + [ PC5-Link-AMBR ] + *[AVP] +``` + +### 7.3.237 PC5-QoS-Flow + +The PC5-QoS-Flow AVP is of type Grouped. It shall contain the QoS parameters for a PC5 flow. + +AVP format: + +``` +PC5-QoS-Flow ::= + { 5QI } + [ PC5-Flow-Bitrates ] + [ PC5-Range ] + *[AVP] +``` + +### 7.3.238 5QI + +The 5QI AVP is of type Integer32. It shall contain the 5QI. See 3GPP TS 23.501 [69] for allowed values. If the 5QI is used in PC5 QoS parameter, it shall contain PQI, PQI is a special 5QI (see clause 5.4.2.1 of 3GPP TS 23.287 [68]). + +### 7.3.239 PC5-Flow-Bitrates + +The PC5-Flow-Bitrates AVP is of type Grouped. It shall contain the PC5 Flow Bit Rates, it's for GBR QoS Flows only. + +AVP format: + +PC5-Flow-Bitrates ::= + +[ Guaranteed-Flow-Bitrates ] + +[ Maximum-Flow-Bitrates ] + +### 7.3.240 Guaranteed-Flow-Bitrates + +The Guaranteed-Flow-Bitrates AVP is of type Integer32. It indicates the guaranteed bits delivered for the PC5 QoS flow by UE over the PC5 interface within a period of time. The unit of Guaranteed-Flow-Bitrates is bits/s. + +### 7.3.241 Maximum-Flow-Bitrates + +The Maximum-Flow-Bitrates AVP is of type Integer32. It indicates the maximum bits delivered for the PC5 QoS flow by UE over the PC5 interface within a period of time. The unit of Maximum-Flow-Bitrates is bits/s. + +### 7.3.242 PC5-Range + +The PC5-Range AVP is of type Integer32. It indicates the Range in the unit of meters. See clause 5.4.2.4 of 3GPP TS 23.287 [68]. + +### 7.3.243 PC5-Link-AMBR + +The PC5-Link-AMBR AVP is of type Integer32. It indicates the PC5 Link Aggregated Bit Rates for all the Non-GBR QoS Flows. The unit of PC5-Link-AMBR is bits/s. + +### 7.3.244 Third-Context-Identifier + +The Third-Context-Identifier AVP is of type Unsigned32 and indicates the identity of another default APN to be used when the subscription profile of the user contains APNs with three PDN types, i.e. IP-based PDN types, non-IP PDN types and Ethernet PDN types. + +## 7.4 Result-Code and Experimental-Result Values + +### 7.4.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 7.4.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol IETF RFC 6733 [61] shall be applied. + +### 7.4.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in the Diameter base protocol IETF RFC 6733 [61] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 7.4.3.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the HSS to indicate that the user identified by the IMSI is unknown + +#### 7.4.3.2 DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION (5420) + +This result code shall be sent by the HSS to indicate that no EPS subscription is associated with the IMSI. + +#### 7.4.3.3 DIAMETER\_ERROR\_RAT\_NOT\_ALLOWED (5421) + +This result code shall be sent by the HSS to indicate the RAT type the UE is using is not allowed for the IMSI. + +#### 7.4.3.4 DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED (5004) + +This result code shall be sent by the HSS to indicate that the subscriber is not allowed to roam within the MME or SGSN area. + +#### 7.4.3.5 DIAMETER\_ERROR\_EQUIPMENT\_UNKNOWN (5422) + +This result code shall be sent by the EIR to indicate that the mobile equipment is not known in the EIR. + +#### 7.4.3.6 DIAMETER\_ERROR\_UNKNOWN\_SERVING\_NODE (5423) + +This result code shall be sent by the HSS to indicate that a Notify command has been received from a serving node which is not registered in HSS as the node currently serving the user. + +### 7.4.4 Transient Failures + +Result codes that fall within the transient failures category shall be used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. The Result-Code AVP values defined in the Diameter base protocol IETF RFC 6733 [61] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 7.4.4.1 DIAMETER\_AUTHENTICATION\_DATA\_UNAVAILABLE (4181) + +This result code shall be sent by the HSS to indicate that an unexpectedly transient failure occurs. The requesting node can try the request again in the future. + +#### 7.4.4.2 DIAMETER\_ERROR\_CAMEL\_SUBSCRIPTION\_PRESENT (4182) + +This result code shall be sent by the HSS to indicate that the subscriber to be registered has SGSN CAMEL Subscription data. + +--- + +## 8 User identity to HSS resolution + +The User identity to HSS resolution mechanism enables the MME, SGSN (for non-roaming case) or Diameter Relay/proxy agents in the home network (for roaming case) to find the identity of the HSS that holds the subscriber data for a given user identity when multiple and separately addressable HSSs have been deployed in the home network. The resolution mechanism is not required in networks that utilise a single HSS. + +This User identity to HSS resolution mechanism may rely on routing capabilities provided by Diameter and be implemented in the home operator network within dedicated Diameter Agents (Redirect Agents or Proxy Agents) responsible for determining the HSS identity based on the provided user identity. If this Diameter based implementation is selected by the Home network operator, the principles described below shall apply. + +In non-roaming case, in networks where more than one independently addressable HSS are deployed in the home network, each MME and SGSN shall be configured with the address/identity of a Diameter Agent (Redirect Agent or Proxy Agent) implementing this resolution mechanism. + +For support of roaming case, Diameter Relay agents and/or Diameter Proxy agents in the home network receiving the Diameter signalling from visited networks shall be configured with the address/identity of a Diameter Agent (Redirect Agent or Proxy Agent) implementing this resolution mechanism. + +To get the HSS identity that holds the subscriber data for a given user identity in the home network, the Diameter request normally destined to the HSS shall be sent to a pre-configured address/identity of a Diameter agent supporting the User identity to HSS resolution mechanism. + +- If this Diameter request is received by a Diameter Redirect Agent, the Diameter Redirect Agent shall determine the HSS identity based on the provided user identity and shall return a notification of redirection towards the HSS identity, in response to the Diameter request. Multiple HSS identities may be included in the response, as specified in IETF RFC 6733 [61]. In such a case, the requesting Diameter entity shall send the Diameter request to the first HSS identity in the ordered list received in the Diameter response from the Diameter Redirect Agent. If no successful response to the Diameter request is received, the requesting Diameter entity shall send a Diameter request to the next HSS identity in the ordered list. This procedure shall be repeated until a successful response from an HSS is received. After the user identity to HSS resolution, the MME or the SGSN shall store the determined HSS identity/name/Realm and shall use it in further Diameter requests to the same user identity. +- If this Diameter request is received by a Diameter Proxy Agent, the Diameter Proxy Agent shall determine the HSS identity based on the provided user identity and - if the Diameter load control mechanism is supported (see IETF RFC 8583 [60]) - optionally also based on previously received load values from Load AVPs of type HOST. The Diameter Proxy Agent shall then forward the Diameter request directly to the determined HSS. In this case, the user identity to HSS resolution decision is communicated to the MME/SGSN in the Origin-Host/Origin-Realm AVPs of the response. The MME or the SGSN may store the determined HSS identity/name/Realm and may use it in further Diameter requests to the same user identity. + +In roaming case, whereas a Diameter Relay Agent is stateless, a stateful Diameter Proxy Agent in the home network may store the determined HSS identity/name/Realm and use it in further Diameter requests associated to the same user identity. + +NOTE: Alternatives to the user identity to HSS resolution Diameter based implementation are outside the scope of this specification. + +--- + +## Annex A (normative): MME mapping table for S6a and NAS Cause Code values + +When the UE initiates Attach, Tracking Area Update or Service Request, there may be the need for the MME to communicate with the HSS via S6a to retrieve authentication data and/or subscription data. If this retrieval is rejected by the HSS, the received Diameter-Result-Code values or Experimental-Result values need to be mapped to appropriate cause codes over NAS to the UE. + +This mapping shall be as shown in Table A.1. + +If the retrieval is successful, not needed (e.g. because data are already available) or not possible (e.g. because HSS is unavailable or overloaded), detected error conditions need to be mapped to appropriate cause codes over NAS to the UE. + +This mapping shall be as shown in Table A.2. + +**Table A.1: Mapping from S6a error code to NAS Cause Code values** + +| Reject indication received at MME over S6a | NAS Cause Code sent to UE | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| DIAMETER_ERROR_USER_UNKNOWN (5001) | #8 "EPS services and non-EPS services not allowed" | +| DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION (5420) without Error Diagnostic, or with Error Diagnostic of GPRS_DATA_SUBSCRIBED | #15 "No suitable cells in tracking area" | +| DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION (5420) with Error Diagnostic of NO_GPRS_DATA_SUBSCRIBED | #7 "EPS services not allowed" | +| DIAMETER_ERROR_RAT_NOT_ALLOWED (5421) | #15 "No suitable cells in tracking area", or
#13 "Roaming not allowed in this tracking area", or
#12 "Tracking area not allowed"
(NOTE 1) | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), without Error Diagnostic | #11 "PLMN not allowed" | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), with Error Diagnostic of ODB_HPLMN_APN or ODB_VPLMN_APN | #14 "EPS services not allowed in this PLMN" | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), with Error Diagnostic of ODB_ALL_APN | #15 "No suitable cells in tracking area" | +| DIAMETER_AUTHORIZATION_REJECTED (5003)
DIAMETER_UNABLE_TO_DELIVER (3002)
DIAMETER_REALM_NOT_SERVED (3003) | #15 "No suitable cells in tracking area", or
#17 "Network failure", or
#42 "Severe network failure"
(NOTE 1) | +| DIAMETER_UNABLE_TO_COMPLY (5012),
DIAMETER_INVALID_AVP_VALUE (5004)
DIAMETER_AVP_UNSUPPORTED (5001)
DIAMETER_MISSING_AVP (5005)
DIAMETER_RESOURCES_EXCEEDED (5006)
DIAMETER_AVP_OCCURS_TOO_MANY_TIMES (5009)
DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE (4181)
(NOTE 2) | #17 "Network failure" or #42 "Severe network failure"
(NOTE 1) | +| NOTE 1: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice.
NOTE 2: Any other permanent errors from the Diameter base protocol as defined in IETF RFC 6733 [61], not listed here, should be mapped to NAS Cause Code #17 "Network failure". | | + +**Table A.2: Mapping from detected error condition to NAS Cause Code values** + +| Condition | NAS cause code sent to UE | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| The MME receives a SGsAP-LOCATION-UPDATE-REJECT message from the VLR indicating in the reject cause "IMSI unknown in HLR" or if the UE has packet only subscription. Only used in the Combined Tracking and Location Area Update procedure. | #2 "IMSI Unknown in HSS" | +| The MME receives in Update-Location-Answer message an indication of Roaming restricted in MME due to unsupported feature | #14 "EPS services not allowed in this PLMN" | +| The MME cannot service an UE generated request because CS domain is not available and SMS in MME is not supported. | #18 "CS domain not available" | +| The value OPERATOR_DETERMINED_BARRING is received in the Subscriber-Status AVP | #15 "No suitable cells in tracking area" | +| The HSS indicates that due to subscription to a "regionally restricted service" the UE is not allowed to operate in the tracking area. | #12 "Tracking area not allowed" | +| The CSG ID of the cell from where the UE has sent the TRACKING AREA UPDATE REQUEST message is not contained in the Allowed CSG list. | #25 "Not authorized for this CSG" | +| The MME detects that it cannot communicate with the HSS in the HPLMN of the subscriber. How the MME detect this is implementation specific. | #15 "No suitable cells in tracking area"
#14 "EPS services not allowed in this PLMN"
#111 "Protocol error, unspecified"

NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice / configuration, e.g. NAS Cause Code #14 is to be sent to the UE if the network is an LTE only network. | +| The MME detects by internal configuration that roaming is not allowed. | #11 "PLMN not allowed" | +| The MME detects that it cannot send a request to the HSS due to HSS overload (see Annex C). | #22 "Congestion"
#42 "Severe network failure"

NOTE 1: Cause #22 should be used. In addition, the MME may ask the UE not to retry before a backoff timer expires, based on an operator policy. The eventual timer value may take into account the value received in the corresponding active overload report and operator policy.

NOTE 2: Cause #42 may be used, for attach requests, in case of severe overload, according to operator policy. | + +## Annex B(normative): SGSN mapping table for S6d and NAS Cause Code values + +When the UE initiates Attach, Routing Area Update or Service Request, there may be the need for the SGSN to communicate with the HSS via S6d to retrieve authentication data and/or subscription data. If this retrieval is rejected by the HSS, the received Diameter-Result-Code values or Experimental-Result values need to be mapped to appropriate cause codes over NAS to the UE. + +NOTE: Mapping from MAP Gr error codes to NAS Cause Code values is described in the 3GPP TS 29.010 [45]. + +This mapping shall be as shown in Table B.1. + +If the retrieval is successful, not needed (e.g. because data are already available) or not possible (e.g. because HSS is unavailable or overloaded), detected error conditions need to be mapped to appropriate cause codes over NAS to the UE. + +This mapping shall be as shown in Table and B.2. + +**Table B.1: Mapping from S6d error code to NAS Cause Code values** + +| Reject indication received at SGSN over S6d | NAS Cause Code sent to UE | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| DIAMETER_ERROR_USER_UNKNOWN (5001) | #8 "GPRS services and non-GPRS services not allowed" | +| DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION (5420) | #7 "GPRS services not allowed" | +| DIAMETER_ERROR_RAT_NOT_ALLOWED (5421) | #15 "No suitable cells in location area", or
#13 "Roaming not allowed in this location area", or
#12 "Location area not allowed"
(NOTE 1) | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004)
, without Error Diagnostic | #11 "PLMN not allowed" | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), with Error Diagnostic of ODB_HPLMN_APN or ODB_VPLMN_APN | #14 "GPRS services not allowed in this PLMN" | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), with Error Diagnostic of ODB_ALL_APN | #15 "No suitable cells in location area" | +| DIAMETER_AUTHORIZATION_REJECTED (5003)
DIAMETER_UNABLE_TO_DELIVER (3002) | #15 "No suitable cells in location area" | +| DIAMETER_UNABLE_TO_COMPLY (5012),
DIAMETER_INVALID_AVP_VALUE (5004)
DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE (4181) and no retry takes place
(NOTE 2) | #17 "Network failure" | + +NOTE 1: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice. +NOTE 2: Any other permanent errors from the Diameter base protocol as defined in IETF RFC 6733 [61], not listed here, should be also mapped to NAS Cause Code #17 "Network failure". + +**Table B.2: Mapping from detected error condition to NAS Cause Code values** + +| Condition | NAS cause code to UE | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| The SGSN receives a BSSAP+-LOCATION-UPDATE-REJECT message from the VLR indicating in the reject cause "IMSI unknown in HLR" or if the UE has packet only subscription. Only used in the Combined Routing and Location Area Update procedure. | #2 "IMSI Unknown in HLR" | +| The SGSN receives in Update-Location-Answer message an indication of Roaming restricted in SGSN due to unsupported feature | #14 "GPRS services not allowed in this PLMN" | +| The value OPERATOR_DETERMINED_BARRING is received in the Subscriber-Status AVP | #15 "No suitable cells in routing area" | +| The HLR indicates that due to subscription to a "regionally restricted service" the MS is not allowed to operate in the location area. | #12 "Location area not allowed" | +| The CSG ID of the cell from where the UE has sent the ROUTING AREA UPDATE REQUEST message is not contained in the Allowed CSG list. | #25 "Not authorized for this CSG" | +| The SGSN indicates that the MS has requested "SMS-only services" and the SMS services are provided by the SGSN in the PS domain. | #28 "SMS provided via GPRS in this routing area" | +| The SGSN detects that it cannot communicate with the HLR in the HPLMN of the subscriber. How the SGSN detect this is implementation specific. | #15 "No suitable cells in routing area"
#14 "GPRS services not allowed in this PLMN"

NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice / configuration, e.g. NAS Cause Code #14 is to be sent to the UE if the network is an LTE only network. | +| The SGSN detects by internal configuration that roaming is not allowed. | #11 "PLMN not allowed" | +| The SGSN detects that it cannot send a request to the HSS due to HSS overload (see Annex C). | #22 "Congestion".

In addition, the MME may ask the UE not to retry before a backoff timer expires, based on an operator policy. The eventual timer value may take into account the value received in the corresponding active overload report and operator policy. | + +--- + +## Annex C (normative): Diameter overload control mechanism + +### C.1 General + +IETF RFC 7683 [50] specifies a Diameter overload control mechanism which includes the definition and the transfer of related AVPs between Diameter nodes. + +Depending on regional/national requirements and network operator policy, priority traffic (e.g. MPS as described in 3GPP TS 22.153 [52]) shall be exempted from throttling due to Diameter overload control up to the point where requested traffic reduction cannot be achieved without throttling the priority traffic. + +--- + +### C.2 S6a/S6d interfaces + +#### C.2.1 General + +Diameter overload control mechanism is an optional feature. + +It is recommended to make use of IETF RFC 7683 [50] on the S6a/S6d interfaces where, when applied, the MME or the SGSN shall behave as reacting nodes and the HSS as a reporting node. + +#### C.2.2 HSS behaviour + +The HSS requests traffic reduction from its clients when the HSS is in an overload situation, including OC-OLR AVP in answer commands as described in IETF RFC 7683 [50]. + +The HSS identifies that it is in an overload situation by implementation specific means. For example, the HSS may take into account the traffic over the S6a/d interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources, etc. + +The HSS determines the specific contents of OC-OLR AVP in overload reports and the HSS decides when to send OC-OLR AVPs by implementation specific means. + +#### C.2.3 MME/SGSN behaviour + +The MME/SGSN applies required traffic reduction received in answer commands to subsequent applicable requests, as per RFC 7683 [50]. + +Requested traffic reduction is achieved by the MME/SGSN by implementation specific means. For example, it may implement message throttling with prioritization or a message retaining mechanism for operations that can be postponed. + +Diameter requests related to priority traffic (e.g. MPS as identified by the MME/SGSN through access procedures) and emergency have the highest priority. Depending on regional/national regulatory and operator policies, these Diameter requests shall be the last to be throttled, when the MME/SGSN has to apply traffic reduction. Relative priority amongst various priority traffic (e.g. MPS) and emergency traffic is subject to regional/national regulatory and operator policies. + +As a result of the need to throttle traffic, the MME or SGSN may reject Attach, Tracking Area Update or Service Requests initiated by UEs. The possible NAS causes are described in the Annex A and B. + +--- + +## Annex D (Informative): Diameter overload control node behaviour + +### D.1 Message prioritisation over S6a/d + +This clause describes possible behaviours of the MME/SGSN regarding message prioritisation as guidance and for an informative purpose when Diameter overload control is applied over S6a/d. + +When the HSS is overloaded, the MME/SGSN will receive overload reports from the HSS requesting a reduction of the requests sent by the MME/SGSN. The following and not exhaustive considerations may be taken into account for the MME/SGSN throttling decisions: + +- Prioritisation of requests related to priority traffic (e.g. MPS as identified by the MME/SGSN through access procedures, emergency) +- Identification of the procedures that can be deferred (e.g. UE reachable notification, purge after a long inactivity time), so to avoid to drop non deferrable procedures; +- Prioritisation of certain types of requests (i.e. between AIR, ULR, PUR, NOR) according to the context of their use, in particular: + - Higher prioritisation of ULR commands when used in relation with mobility management (e.g. handover) for an attached user, so to avoid the interruption of the service for the user; + - Lower prioritisation of AIR and ULR commands when related to an initial attach, so to avoid the attachment of new users; +- Skipping of optional authentication (e.g. in TAU procedures). + +--- + +## Annex E (normative): Diameter message priority mechanism + +### E.1 General + +IETF RFC 7944 [57] specifies a Diameter routing message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may leverage the relative priority of Diameter messages into routing, resource allocation, set the DSCP marking for transport of the associated Diameter message, and also abatement decisions when overload control is applied. + +--- + +### E.2 S6a/S6d interfaces + +#### E.2.1 General + +The Diameter message priority mechanism is an optional feature. + +It is recommended to make use of IETF RFC 7944 [57] over the S6a/S6d interfaces of an operator network when the overload control defined in Annex C is applied on these S6a/d interfaces. + +#### E.2.2 HSS, CSS, EIR behaviour + +When the HSS, the CSS or the EIR supports the Diameter message priority mechanism, the HSS, the CSS, or the EIR shall comply with IETF RFC 7944 [57]. + +The HSS or the CSS sending a request shall determine the required priority according to its policies. When priority is required, the HSS or the CSS shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the request according to the required priority level. + +When the HSS or the CSS receives the corresponding response, the HSS or the CSS shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When the HSS, the CSS, or the EIR receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, the HSS, the CSS, or the EIR may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, the HSS, the CSS, or the EIR shall include the DRMP AVP in the response. If: + +- the HSS, the CSS or the EIR supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the HSS, the CSS or the EIR shall set the DSCP marking for transport of the request or response according to the required priority level. + +When not-explicitly requested, the inclusion and priority value of the DRMP AVP in Diameter messages are implementation specific. + +## E.2.3 MME/SGSN behaviour + +When the MME/SGSN supports the Diameter message priority mechanism, the MME/SGSN shall comply with IETF RFC 7944 [57]. + +The MME/SGSN sending a request shall determine the required priority according to its policies. When priority is required, the MME/SGSN shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the requests according to the required priority level. + +When the MME/SGSN receives the corresponding response, it shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When the MME/SGSN receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, it may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, it shall include the DRMP AVP in the response. + +If: + +- the MME/SGSN supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the MME/SGSN shall set the DSCP marking for transport of the request or response according to the required priority level. + +Diameter requests related to high priority traffic (e.g. MPS as identified by the MME/SGSN via the RRC Establishment Cause IE set to the highPriorityAccess value as per 3GPP TS 36.413 [19] or through subscription information in the MPS-Priority AVP, emergency) shall contain a DRMP AVP with a high priority of which the level value is operator dependent. + +When not-explicitly requested, the inclusion and priority value of the DRMP AVP in Diameter messages are implementation specific. + +--- + +## Annex F (normative): Diameter load control mechanism + +### F.1 General + +IETF RFC 8583 [60] specifies a mechanism for sharing of Diameter load information. It includes the definition and the transfer of related AVPs between Diameter nodes. + +--- + +### F.2 S6a/S6d interfaces + +#### F.2.1 General + +Diameter load control mechanism is an optional feature. + +It is recommended to make use of IETF RFC 8583 [60] on the S6a/S6d interfaces where, when applied, the MME or the SGSN shall behave as receiving nodes and the HSS as a reporting node. + +#### F.2.2 HSS behaviour + +The HSS may report its current load by including a Load AVP of type HOST in answer commands as described in IETF RFC 8583 [60]. + +The HSS calculates its current load by implementation specific means. For example, the HSS may take into account the traffic over the S6a/d interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources, etc. + +The HSS determines when to send Load AVPs of type HOST by implementation specific means. + +#### F.2.3 MME/SGSN behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the MME/SGSN may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [60]. + +## Annex G (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|--------------------------------------------------------------------------|-------| +| 2008-09 | CT#41 | CP-080475 | | | | V2.0.0 approved in CT#41 | 8.0.0 | +| 2008-12 | CT#42 | CP-080691 | 0001 | 1 | | S6a Vendor-Specific-Application-Id AVP | 8.1.0 | +| | | CP-080691 | 0002 | 1 | | RegSub feature | | +| | | CP-080691 | 0005 | - | | Clarification on Immediate-Response-Preferred | | +| | | CP-080691 | 0006 | 1 | | Correction of the Reference of Supported Features | | +| | | CP-080691 | 0007 | - | | Definition of RAT-Frequency-Selection-Priority | | +| | | CP-080691 | 0008 | 2 | | ME Identity Check | | +| | | CP-080703 | 0009 | 2 | | Gr alignment | | +| | | CP-080971 | 0010 | 3 | | Closed Subscriber Group | | +| | | CP-080691 | 0011 | - | | AVP codes | | +| | | CP-080691 | 0012 | 1 | | MSISDN AVP | | +| | | CP-080691 | 0013 | - | | Result codes | | +| | | CP-080691 | 0014 | - | | Removal of Editor's note in ULA Flag | | +| | | CP-080691 | 0015 | 2 | | Duplicated AMBR AVP and Use of Called-Station-Id | | +| | | CP-080691 | 0017 | - | | Change of AVP to carry the APN information | | +| | | CP-080691 | 0018 | 1 | | Reference to 3GPP-Charging-Characteristics | | +| | | CP-080691 | 0019 | - | | Access Restriction Data Definition | | +| | | CP-080691 | 0020 | - | | AMBR Definition | | +| | | CP-080691 | 0021 | 1 | | AVPs Encoding | | +| | | CP-080691 | 0022 | 1 | | PDN-GW Delete | | +| | | CP-080691 | 0023 | 1 | | Requesting Node Type Clarification | | +| | | CP-080691 | 0024 | - | | Authn Session State AVP | | +| | | CP-080691 | 0026 | 2 | | Trace Session Activation and Deactivation | | +| | | CP-080691 | 0027 | 1 | | Context-Identifier in APN-Configuration-Profile | | +| | | CP-080691 | 0029 | - | | APN-OIReplacement | | +| | | CP-080703 | 0032 | - | | Access Restriction | | +| | | CP-080691 | 0033 | 1 | | Context Identifier clarification | | +| | | CP-080691 | 0034 | 1 | | APN-Configuration correction | | +| | | CP-080691 | 0037 | - | | Removal of Supported RAT Types | | +| | | CP-080691 | 0039 | 1 | | Extension of the Terminal-Information AVP for non-3GPP accesses | | +| | | CP-080691 | 0040 | - | | Conditionality of ULA-Flags and PUA-Flags AVPs | | +| | | CP-080691 | 0042 | - | | Wrong Description for Complete APN Configuration Profile Withdrawal | | +| | | CP-080691 | 0043 | - | | Purge UE Detailed Behaviour | | +| | | CP-080691 | 0044 | 1 | | MME/SGSN area restricted flag cleanup | | +| | | | | | | TS number in cover page corrected | 8.1.1 | +| 2009-03 | CT#43 | CP-090056 | 0048 | 2 | | Context Identifier for Update or Removal of PDN GW | 8.2.0 | +| | | CP-090046 | 0049 | - | | Clarification of the relationship between Subscriber-Status and ODB | | +| | | CP-090046 | 0051 | 2 | | Context-Identifier in APN-Configuration-Profile | | +| | | CP-090024 | 0052 | - | | Update of the AVP Codes | | +| | | CP-090236 | 0053 | 2 | | PDN GW update for Wildcard APN | | +| | | CP-090044 | 0054 | 1 | | Ready for SM | | +| | | CP-090046 | 0055 | - | | ODB for SM | | +| | | CP-090044 | 0056 | 2 | | Handling LCS Subscription Data | | +| | | CP-090046 | 0057 | 2 | | Charging Characteristics | | +| | | CP-090046 | 0058 | 2 | | Regional-Subscription-Zone-Code AVP Correction | | +| | | CP-090046 | 0059 | 2 | | Trace Depth corrections | | +| | | CP-090046 | 0060 | 2 | | Delete Subscriber Data Request procedure | | +| | | CP-090046 | 0063 | 1 | | Coding definition for STN-SR | | +| | | CP-090046 | 0064 | - | | Trace Reference in DSR | | +| | | CP-090046 | 0065 | 1 | | DSR-Flags | | +| | | CP-090046 | 0066 | 2 | | Clarification on All-APN-Configurations-Included-Indicator | | +| | | CP-090046 | 0069 | - | | User-Name AVP contains only the IMSI | | +| | | CP-090046 | 0070 | 1 | | MIP6-Agent-Info Definition and Usage | | +| | | CP-090046 | 0075 | 1 | | Allocation Retention Priority | | +| | | CP-090046 | 0076 | 1 | | APN includes only the Network Identifier | | +| | | CP-090046 | 0077 | - | | Error Codes and ABNF Corrections | | +| | | CP-090039 | 0078 | 4 | | User to HSS resolution | | +| | | CP-090046 | 0079 | 1 | | Introducing the Trace-Collection-Entity AVP | | +| | | CP-090046 | 0081 | 4 | | Usage of Immediate-Response-Preferred AVP | | +| | | CP-090044 | 0082 | 3 | | Handling SMS Subscription Data | | +| | | CP-090046 | 0083 | - | | SCTP version | | +| | | CP-090046 | 0084 | - | | RFC 5447 References | | +| 2009-06 | CT#44 | CP-090287 | 0086 | 1 | | Notification of SMS over IP Non-Delivery for E-UTRAN and UE Reachability | 8.3.0 | +| | | CP-090287 | 0087 | 1 | | Coding of Immediate Response Preferred AVP | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|-------------------------------------------------------------------------------|-------| +| | | CP-090287 | 0088 | - | | Trace Event List | | +| | | CP-090287 | 0089 | - | | Removal of Requesting Node Type from AIR | | +| | | CP-090287 | 0091 | - | | Regional-Subscription-Zone-Code clarification | | +| | | CP-090287 | 0092 | - | | Clarification of PLMN encoding | | +| | | CP-090287 | 0093 | - | | Diameter Command Codes for S6a/S6d/S13/S13' | | +| | | CP-090287 | 0094 | - | | Update of Diameter Codes | | +| | | CP-090287 | 0095 | 1 | | Formatting of APN in Service-Selection AVP | | +| | | CP-090378 | 0096 | 3 | | User Data Download Indication | | +| | | CP-090315 | 0097 | - | | Usage of Single-Registration-Indication | | +| | | CP-090495 | 0098 | 3 | | ULR processing enhancement | | +| 2009-09 | CT#45 | CP-090531 | 0100 | 2 | | Correction on APN-OI-Replacement | 8.4.0 | +| | | CP-090726 | 0101 | 3 | | GPRS subscription data over S6d | | +| | | CP-090531 | 0102 | 1 | | Usage of DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION | | +| | | CP-090531 | 0103 | 6 | | Cancel Location for Initial Attach | | +| | | CP-090531 | 0104 | 4 | | Subscriber Data Update | | +| | | CP-090531 | 0105 | 1 | | Usage of Single Registration Indication | | +| | | CP-090531 | 0106 | 2 | | Charging Characteristics Reference | | +| | | CP-090531 | 0107 | 1 | | Alerting Reason Behaviour | | +| | | CP-090531 | 0108 | 1 | | Wildcard APN | | +| | | CP-090531 | 0109 | - | | Subscriber's NAM | | +| | | CP-090531 | 0111 | - | | Trace ID length correction | | +| | | CP-090531 | 0112 | 1 | | Subscription-Data AVP in Update Location Answer | | +| | | CP-090531 | 0113 | 1 | | Default values for Allocation Retention Priority AVP | | +| | | CP-090531 | 0114 | - | | Default APN and Wildcard APN | | +| | | CP-090531 | 0115 | 2 | | Correction in behavior of DSR-Flags | | +| | | CP-090531 | 0116 | 1 | | PDN Type | | +| | | CP-090531 | 0118 | 1 | | Clarification on the process of skip subscriber data flag in the HSS | | +| | | CP-090532 | 0119 | 1 | | Corrections on IDR ABNF and Service Type AVP | | +| | | CP-090532 | 0120 | 1 | | TS-Code AVP is missing in DSR command | | +| | | CP-090532 | 0123 | 1 | | Cleanup of the TS | | +| | | CP-090532 | 0124 | 1 | | Format of User-Id | | +| | | CP-090532 | 0125 | 1 | | GPRS Subscription Data Update | | +| | | CP-090532 | 0126 | 2 | | APN-Configuration-Profile | | +| | | CP-090532 | 0128 | 1 | | 3GPP2-MEID AVP | | +| | | CP-090532 | 0129 | 1 | | MIP6-Agent-Info AVP | | +| | | CP-090532 | 0130 | - | | Alignment of Supported Feature concept with 29.229 | | +| | | CP-090532 | 0133 | 1 | | EPS Subscribed QoS | | +| | | CP-090532 | 0137 | 1 | | Restruction of the TS 29.272 | | +| | | CP-090532 | 0138 | 1 | | Trace Depth per session | | +| | | CP-090532 | 0140 | - | | Clarification of Unsigned32 bit flag AVPs | | +| | | CP-090532 | 0141 | 1 | | Extra Regional-Subscription-Zone-Codes | | +| | | CP-090532 | 0142 | 1 | | Clarification of Service-Selection AVP encoding | | +| | | CP-090532 | 0143 | 1 | | User to HSS identity resolution for Diameter Proxy Agents | | +| | | CP-090532 | 0144 | - | | RFSP coding | | +| 2009-09 | CT#45 | CP-090556 | 0122 | 3 | | Optimization of Subscriber Data Update | 9.0.0 | +| | | CP-090562 | 0131 | | | Emergency Support in S6a | | +| 2009-12 | CT#46 | CP-091030 | 0148 | 4 | | Clarification on Some Subscription Data List Handling in MME/SGSN | 9.1.0 | +| | | CP-090793 | 0149 | 1 | | APN level APN-OI-Replacement | | +| | | CP-090800 | 0150 | 2 | | ICS-Flag | | +| | | CP-090767 | 0152 | 2 | | RFSP alignment in 29.272 | | +| | | CP-090801 | 0153 | 1 | | Notify Request for Emergency Attached UEs | | +| | | CP-090767 | 0155 | 2 | | Wildcard APN | | +| | | CP-090767 | 0157 | 1 | | Lifetime of Charging Characteristics after Change | | +| | | CP-091030 | 0159 | 2 | | Correction on the UE initiated detach procedure | | +| | | CP-090767 | 0163 | 2 | | FQDN for S6a NOR | | +| | | CP-090767 | 0165 | - | | HPLMN-ODB AVP correction | | +| | | CP-091032 | 0167 | | | From GMLC-Address to GMLC-Number | | +| | | CP-091030 | 0171 | 1 | | Static PDN GW | | +| | | CP-091030 | 0177 | 1 | | Clarification on Usage of Re-Synchronization-Info AVP | | +| | | CP-091030 | 0179 | 1 | | Clarification on the Number of PDP-Contexts in the GPRS-Subscription-Data AVP | | +| | | CP-090767 | 0185 | - | | APN-Configuration-Profile usage in IDR | | +| | | CP-091030 | 0187 | 2 | | IMEI encoding | | +| | | CP-091030 | 0189 | 1 | | APN-Configuration Service-Selection values | | +| | | CP-091030 | 0191 | 1 | | QoS attributes | | +| | | CP-090789 | 0196 | 1 | | Subscription-Data clarification for UE Reachability | | +| | | CP-091030 | 0198 | 2 | | Vendor Specific Application ID | | +| | | CP-090776 | 0200 | 1 | | Destination Realm | | +| | | CP-090767 | 0202 | - | | Correction to fault recovery procedure and ME identity check procedure | | +| | | CP-090767 | 0204 | - | | Reference of 3GPP-Charging-Characteristics | | +| | | CP-090767 | 0206 | - | | Reset procedure MME/SGSN behavior | | + +| | | | | | | | +|---------------|-----------|------|---|--|----------------------------------------------------------------------------------------------|--------| +| 2010-03 CT#47 | CP-100020 | 0181 | 2 | | Correction to Purge UE Detailed Behaviour | 9.2.0 | +| | CP-100020 | 0210 | | | HPLMN ODB | | +| | CP-100048 | 0211 | 2 | | TADS support in S6a/S6d | | +| | CP-100020 | 0217 | | | Cancellation-Type clarifications | | +| | CP-100020 | 0219 | 1 | | IETF References update | | +| | CP-100020 | 0221 | | | Static PDN GW | | +| | CP-100046 | 0222 | 1 | | Addition of V-GMLC address for S6a | | +| | CP-100020 | 0223 | 1 | | Handling of UE Reachability MME Parameter | | +| | CP-100020 | 0227 | | | Indication of PLMN ID of the selected PGW | | +| | CP-100040 | 0228 | | | Context-Identifier in NOR | | +| | CP-100235 | 0230 | 5 | | EPS Subscriber State and Location Information Request | | +| | CP-100040 | 0233 | 1 | | Reset to Combined MME/SGSN | | +| | CP-100040 | 0234 | 1 | | NOR-Flags correction | | +| 2010-06 CT#48 | CP-100040 | 0236 | 2 | | Indication of LCS Capabilities support over S6a/S6d | 9.3.0 | +| | CP-100040 | 0238 | 1 | | Fix ambiguity on context id AVP | | +| | CP-100264 | 0241 | 1 | | Service-Selection values | | +| | | 0243 | 1 | | MIP6-Agent-Info | | +| | | 0245 | 2 | | Fix ambiguity on usage of the Supported-Features AVP | | +| | | 0260 | 1 | | Correction of Context-Identifier | | +| | CP-100277 | 0247 | 1 | | Dynamic information update after a Reset procedure | | +| | | 0248 | 1 | | Notify command from unknown MME | | +| | CP-100416 | 0249 | 4 | | S6a Error Codes | | +| 2010-09 CT#49 | CP-100279 | 0258 | 3 | | URRP for SGSN | 9.4.0 | +| | CP-100265 | 0262 | 3 | | MME mapping between Diameter error codes and NAS Cause Code values | | +| | CP-100456 | 0268 | 1 | | Restoration of the SGSN Number in the VLR | | +| | CP-100457 | 0272 | | | QoS-Subscribed | | +| | CP-100457 | 0273 | | | Trace-Reference AVP encoding | | +| | CP-100457 | 0284 | | | Usage of MIP-Home-Agent-Host AVP | | +| | CP-100457 | 0285 | | | Correction on HSS behaviour about IMEI | | +| | CP-100577 | 0275 | 2 | | NAS Cause Code values | | +| | CP-100463 | 0276 | | | LCS Privacy Features for MME | | +| | CP-100443 | 0281 | 2 | | Correction to Delete Subscriber Data for SGSN | | +| 2010-09 CT#49 | CP-100443 | 0283 | 1 | | Unclear Cancel-Type Setting for Single Registration and Initial Attach | 10.0.0 | +| | CP-100465 | 0267 | 1 | | Addition of SIPTO permissions in PS subscription data | | +| 2010-10 CT#50 | CP-100689 | 0324 | 1 | | HSS Error Returned due to ODB | 10.1.0 | +| | CP-100689 | 0316 | 1 | | Clarification on Access Restriction Data | | +| | CP-100698 | 0297 | 1 | | Removal of Notify Messages during detach or last PDN connection deactivation via 3GPP access | | +| | CP-100679 | 0303 | 1 | | Usage of Served Party IP Address AVP inside the APN Configuration | | +| | CP-100679 | 0305 | 1 | | Usage of APN-OI-Replacement AVP | | +| | CP-100679 | 0307 | | | AMBR clarification | | +| | CP-100679 | 0308 | | | Store HSS Identity in MME/SGSN after successful ULA | | +| | CP-100679 | 0315 | 3 | | Fix ambiguity in the LCS related indication | | +| | CP-100679 | 0327 | 2 | | Unknown EPS Subscription | | +| | CP-100688 | 0325 | 1 | | Periodic TAU/RAU timer in HSS subscription | | +| | CP-100707 | 0313 | 1 | | Correction of Restoration flag | | +| | CP-100707 | 0319 | | | Default APN and Wildcard APN | | +| | CP-100707 | 0322 | 1 | | Usage of PGW Allocation Type AVP | | +| | CP-100699 | 0323 | | | Usage of STN-SR AVP | | +| | CP-100699 | 0291 | 3 | | Enhanced SRVCC | | +| 2011-03 CT#51 | CP-100687 | 0290 | 4 | | Addition of MPS Priority in Subscription Data | 10.2.0 | +| | CP-100683 | 0289 | 1 | | Addition of LIPA permission in Subscription Data | | +| | CP-100684 | 0288 | 1 | | SIPTO Permission for Wildcard APN | | +| | CP-110087 | 0329 | 2 | | Minimization of Drive Tests (MDT) | | +| | CP-110042 | 0330 | 2 | | Feature Flags for UE Reachability Notification and State/Location Info Retrieval | | +| | CP-110042 | 0337 | 3 | | Correction of error cause handling | | +| | CP-110042 | 0339 | 2 | | Setting of M bit AVP flag | | +| | CP-110042 | 0343 | 1 | | AMBR Correction | | +| | CP-110073 | 0332 | 2 | | Correction on PGW PLMN ID | | +| 2011-06 CT#52 | CP-110088 | 0334 | 2 | | Relay Node Indicator | 10.3.0 | +| | CP-110051 | 0346 | 1 | | PDP Address correction | | +| | CP-110051 | 0351 | 2 | | Ambiguity in IDR flags | | +| 2011-09 CT#53 | CP-110051 | 0353 | | | Homogeneous Support for IMS Voice over PS AVP missing | 10.4.0 | +| | CP-110351 | 0362 | | | SGSN-Number AVP correction | | +| | CP-110380 | 0357 | 2 | | MDT user consent | | +| | CP-110375 | 0363 | 1 | | Purge from Combined MME/SGSN | | +| | CP-110562 | 0372 | 1 | | Active-APN AVP definition | | +| | CP-110562 | 0374 | | | Context-Identifier when interworking with GTPv1 | | +| | CP-110562 | 0380 | 1 | | APN-AMBR for GPRS | | + +| | | | | | | | +|---------------|-----------|------|----|--|----------------------------------------------------------------------------|--------| +| 2011-09 CT#53 | CP-110565 | 0377 | | | Correction on DIAMETER_AUTHORIZATION_REJECTED | 11.0.0 | +| | CP-110699 | 0381 | | | Correction of implementation error in TS 29.272, CR 324 | | +| | CP-110581 | 0369 | 2 | | Behaviour of HSS in abnormal case of Immediate-Response-Preferred AVP | | +| | CP-110584 | 0370 | 3 | | Add vSRVCC updates to the S6a interface | | +| 2011-12 CT#54 | CP-110787 | 0390 | 1 | | Unknown EPS Subscription over S6d/S6a | 11.1.0 | +| | CP-110811 | 0387 | 2 | | Equivalent PLMN CSG Subscription Request | | +| | CP-110787 | 0397 | 1 | | M-bit Handling | | +| 2012-03 CT#55 | CP-120023 | 0409 | 1 | | GMLC-Number format | 11.2.0 | +| | CP-120025 | 0399 | 3 | | Initial Attach Indication in CLR | | +| | CP-120029 | 0406 | | | T-ADS data request for detached UE | | +| | CP-120029 | 0410 | 1 | | Removal of Subscribed Periodic TAU/RAU timer in HSS subscription | | +| | CP-120037 | 0400 | | | Clarification on UE-SRVCC-Capability AVP in ULR | | +| | CP-120037 | 0402 | | | ODB clarification | | +| | CP-120037 | 0403 | 2 | | S6a location reporting | | +| 2012-06 CT#56 | CP-120240 | 0401 | 3 | | CSG ID and Local Time for NPLI | 11.3.0 | +| | CP-120413 | 0415 | 4 | | Ready for SM in MME | | +| | CP-120249 | 0418 | 1 | | ULR handling for combined MME/SGSN | | +| | CP-120249 | 0419 | | | Clarification on Update of PGW ID | | +| 2012-09 CT#57 | CP-120476 | 0382 | 10 | | VCSG procedures over S7a/S7d | 11.4.0 | +| | CP-120476 | 0394 | 5 | | Delete CSG subscription Data over S7a /S7d | | +| | CP-120476 | 0416 | 4 | | VCSG Reset procedure over S7a/S7d | | +| | CP-120481 | 0404 | 5 | | PS additional number over S6a/S6d | | +| | CP-120462 | 0421 | - | | Single Registration Indication | | +| | CP-120462 | 0422 | - | | Zone Codes | | +| | CP-120462 | 0423 | - | | Clarification on Notification of UE Reachability | | +| | CP-120462 | 0428 | - | | CSG-Subscription-Data replacement | | +| | CP-120462 | 0430 | 1 | | Update of Homogeneous Support of IMS Over PS Sessions | | +| | CP-120462 | 0434 | 2 | | Mapping S6a and NAS cause code | | +| | CP-120473 | 0429 | 4 | | SMS in MME | | +| | CP-120473 | 0432 | 1 | | SMS in SGSN | | +| | CP-120480 | 0433 | 2 | | Local Time Zone | | +| | CP-120722 | 0441 | 1 | | User-CSG-Information | | +| | CP-120713 | 0457 | 1 | | SGSN-Number AVP | | +| 2012-12 CT#58 | CP-120740 | 0436 | 1 | | Application ID for S7a/S7d | 11.5.0 | +| | CP-120740 | 0443 | 2 | | Empty VCSG Subscription Data | | +| | CP-120742 | 0438 | 1 | | Notification Procedure clarification for UE with Emergency Bearer Services | | +| | CP-120742 | 0445 | - | | Inclusion of APN-OI Replacement in PDP Context | | +| | CP-120742 | 0450 | - | | Correction in the chapter of Reset-Answer (RSA) command | | +| | CP-120742 | 0452 | 1 | | UE Time Zone | | +| | CP-120742 | 0453 | 1 | | Corrections to Local Time Zone | | +| | CP-120742 | 0454 | 2 | | Clarification on IDR-Flags | | +| | CP-120742 | 0455 | - | | Correction of General Description of Delete Subscriber Data | | +| | CP-120742 | 0458 | - | | DSR-Flags | | +| | CP-120742 | 0461 | 1 | | Wrong implementation of the Daylight-Saving-Time AVP | | +| | CP-120736 | 0446 | 1 | | A-MSISDN Correction | | +| | CP-120732 | 0447 | 1 | | MME network condition to NAS cause code mapping | | +| | CP-120732 | 0448 | 2 | | SGSN network condition to NAS cause code mapping | | +| | CP-120732 | 0449 | 3 | | MME de-registration for "SMS in MME" | | +| | CP-120732 | 0451 | 1 | | Correction on Update Location Request | | +| | CP-120732 | 0459 | 1 | | Alignment of stage 3 SMS in MME with stage 2 | | +| | CP-120741 | 0460 | 1 | | Use of Flag instead of Enumerated AVPs | | +| 2013-03 CT#59 | CP-130022 | 0466 | - | | Corrections to wrong references and command/AVP name | 11.6.0 | +| | CP-130022 | 0467 | 1 | | Update to Subscription-Data-Flags | | +| | CP-130022 | 0471 | 1 | | Values not allowed for QCI over S6a/S6d | | +| | CP-130022 | 0472 | 1 | | Cause Code Mapping | | +| | CP-130022 | 0470 | 1 | | Registration for SMS Request for SMS in SGSN | | +| | CP-130025 | 0474 | - | | MDT parameters | | +| 2013-03 CT#59 | CP-130031 | 0442 | 3 | | Check of Serving Node for S6a Security | 12.0.0 | +| | CP-130031 | 0468 | 1 | | MME name encoding over S6a | | +| | CP-130156 | 0475 | 1 | | SGSN indicating support of Lgd interface to HSS | | +| 2013-06 CT#60 | CP-130380 | 0490 | 1 | | Removal of SMS-Only AVP and Typo Corrections on Some AVP Definitions | 12.1.0 | +| | CP-130380 | 0501 | 2 | | MME identity for restoration procedures | | +| | CP-130380 | 0492 | 1 | | Definition of A New Feature-List | | +| | CP-130380 | 0488 | 1 | | UE-SRVCC-Capability Update Clarification | | +| | CP-130380 | 0483 | - | | Reset clarification | | +| | CP-130380 | 0481 | 2 | | AIR rejection | | +| | CP-130380 | 0479 | 1 | | Storing Last known Location Information of purged UE in HSS | | +| | CP-130380 | 0512 | 1 | | Maximum value for the subscribed periodic RAU TAU timer | | +| | CP-130279 | 0497 | 1 | | Definition of SS Status for Call Barring | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|------------------------------------------------------------------------------------------------------------------------------|--------| +| | | CP-130378 | 0489 | 2 | | SIPTO permission for Local Network enhancements | | +| | | CP-130288 | 0487 | - | | PS Location Info request with RAT-type | | +| | | CP-130309 | 0482 | - | | CSS clarification | | +| | | CP-130295 | 0478 | - | | Restoration Priority during SGW and PGW restoration procedures | | +| | | CP-130410 | 0508 | 1 | | HSS handling of T-ADS for detached subscriber | | +| 2013-09 | CT#61 | CP-130444 | 0515 | - | | Correction to the restoration priority levels during SGW and PGW restoration procedures | 12.2.0 | +| | | CP-130450 | 0517 | - | | HPLMN-ODB Correction | | +| | | CP-130463 | 0518 | 2 | | CancelLocation requesting reattach | | +| | | CP-130456 | 0519 | 1 | | Indication of Gdd support over S6d | | +| | | CP-130461 | 0520 | 2 | | Homogeneous Support Of Voice over IP | | +| | | CP-130461 | 0521 | 1 | | Definition of User-State values | | +| | | CP-130461 | 0522 | 1 | | Context Identifier Range Inconsistency | | +| 2013-12 | CT#62 | CP-130611 | 0528 | 1 | | Addition of S6aS6d-Indicator in NOR | 12.3.0 | +| | | CP-130617 | 0533 | 1 | | MME Initiated Removal of MME Registration for SMS | | +| | | CP-130624 | 0523 | 1 | | Combined MME/SGSN indicating the support for optimized LCS procedure | | +| | | CP-130624 | 0526 | 1 | | Clarification on Description of Features for LCS | | +| | | CP-130644 | 0525 | 1 | | SMS in MME | | +| | | CP-130623 | 0529 | 1 | | Alert Service Center sent over S6c | | +| | | CP-130632 | 0530 | 1 | | Purge Clarification | | +| | | CP-130639 | 0531 | 1 | | SGSN CAMEL Subscription Indication | | +| 2014-03 | CT#63 | CP-140035 | 0534 | 2 | | Clarification on Current-Location-Retrieved and Age-of-Location-Information | 12.4.0 | +| | | CP-140035 | 0536 | 3 | | Mechanism to determine if the UE is served by the MME and SGSN parts of the same combined MME/SGSN | | +| | | CP-140035 | 0537 | - | | Call-Barring-Info AVP | | +| | | CP-140035 | 0538 | - | | Missing SGs-MME-Identity AVP in the ULR | | +| 2014-06 | CT#64 | CP-140257 | 0544 | 1 | | SS-Status AVP Definition | 12.5.0 | +| | | CP-140264 | 0555 | 3 | | Cause Mapping for ODB | | +| | | CP-140264 | 0556 | 2 | | NOR Error User Unknown | | +| | | CP-140254 | 0557 | 1 | | Enhancement for ProSe | | +| | | CP-140413 | 0558 | - | | Correction on SGSN CAMEL Capability in Supported-Features | | +| | | CP-140243 | 0540 | 5 | | Diameter overload control mechanism | | +| | | CP-140243 | 0559 | 1 | | Diameter overload over S6a/d | | +| 2014-09 | CT#65 | CP-140523 | 0564 | 2 | | Clarification on ProSe Subscription Data | 12.6.0 | +| | | CP-140514 | 0565 | 2 | | WLAN offloadability defined in HSS | | +| | | CP-140506 | 0567 | 2 | | P-CSCF Restoration Indication | | +| 2014-12 | CT#66 | CP-140772 | 0569 | 2 | | Reset-ID | 12.7.0 | +| | | CP-140772 | 0581 | 3 | | M-bit setting of Supported-Features AVP | | +| | | CP-140764 | 0571 | - | | MDT PLMN List | | +| | | CP-140764 | 0580 | 1 | | S6a/S6d-Indicator in NOR | | +| | | CP-140790 | 0575 | 1 | | Priority Consideration for Diameter Overload Control | | +| 2014-12 | CT#66 | CP-140765 | 0574 | 2 | | Roaming Subscription Corresponding to Specific RAT | 13.0.0 | +| | | CP-140759 | 0578 | 2 | | Stored HSS Identity for HSS Restoration Procedure | | +| 2015-03 | CT#67 | CP-150035 | 0582 | 1 | | Clarification on the usage of SV in IMEI check procedure | 13.1.0 | +| 2015-06 | CT#68 | CP-150265 | 0583 | 1 | | Cleanup and small error corrections | 13.2.0 | +| | | CP-150263 | 0584 | 2 | | Access Restriction Data per PLMN | | +| | | CP-150279 | 0585 | 1 | | Alignment of using ProSe and ProSe services | | +| 2015-09 | CT#69 | CP-150427 | 0597 | - | | Wrong Application-ID for S7a Diameter Application | 13.3.0 | +| | | CP-150454 | 0586 | 3 | | Subscription data for extended buffering at the SGW | | +| | | CP-150453 | 0587 | 2 | | Introducing IMSI-Group ID Lists to the subscription Info | | +| | | CP-150449 | 0588 | 3 | | Addition of CP parameters to subscription data | | +| 2015-12 | CT#70 | CP-150778 | 0590 | 9 | | Add MTC Monitoring support | 13.4.0 | +| | | CP-150778 | 0606 | 1 | | Roaming and interaction with the IWK-SCEF | | +| | | CP-150778 | 0607 | 4 | | Introducing a Bitmask to inform the HSS of the Monitoring capabilities of the MME/SGSN | | +| | | CP-150778 | 0609 | 2 | | Deletion of all Monitoring events assigned to a subscriber (UE) | | +| | | CP-150785 | 0598 | 1 | | DL-Buffering-Suggested-Packet-Count AVP | | +| | | CP-150781 | 0600 | 1 | | Retrieval of "UE Usage Type" over S6a/S6d | | +| | | CP-150762 | 0601 | 1 | | Clarification of precedence between UE-level "HO to non-3GPP access" access restriction, and APN-level "WLAN-Offloadability" | | +| | | CP-150768 | 0602 | 4 | | Diameter message priority over S6a/d | | +| | | CP-150771 | 0604 | 2 | | Introduction of validity time delete and replace procedure for CP sets | | +| | | CP-150755 | 0611 | 1 | | ProSe in combined MME/SGSN | | +| | | CP-150744 | 0614 | - | | Erroneous AVP code for some MDT parameters | | +| | | CP-150759 | 0614 | 1 | | Update reference to DOIC new IETF RFC | | +| | | CP-150776 | 0615 | 1 | | Mobile Terminating SMS handling for extended Idle mode DRX | | +| 2016-03 | CT#71 | CP-160029 | 0618 | 2 | | Notifying the status of MONTE event configuration at the IWK-SCEF to the HSS | 13.5.0 | +| | | CP-160043 | 0619 | 1 | | Fix the issue on HSS restart procedure | | +| | | CP-160039 | 0620 | 1 | | User Plane Integrity Protection Indicator | | +| | | CP-160029 | 0621 | 3 | | Configure Monitoring Event to Multiple Serving Nodes | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|---------------------------------------------------------------------------------|--------| +| | | CP-160033 | 0623 | 1 | | Allow SMS for NB-IoT UE without Combined Attach | | +| | | CP-160045 | 0625 | - | | Adjacent PLMNs | | +| | | CP-160045 | 0626 | 1 | | Invocation of Alert procedure by HSS after ULR | | +| | | CP-160023 | 0629 | 1 | | Diameter message priority over S7a/d, S13, S13' | | +| | | CP-160033 | 0630 | 2 | | Addition of NB-IoT radio access type to the Access-Restriction-Data feature | | +| | | CP-160033 | 0631 | 3 | | New PDN-Type for Cellular IoT | | +| 2016-03 | | | | | | Table 7.3.1/1 formatted | 13.5.1 | +| 2016-06 | CT#72 | CP-160215 | 0643 | 1 | | Diameter requests for priority traffic during overload control mechanism | 13.6.0 | +| 2016-06 | CT#72 | CP-160238 | 0628 | 3 | | Subscription Data for combined MME/SGSN | 13.6.0 | +| 2016-06 | CT#72 | CP-160238 | 0632 | 1 | | Cause Mapping | 13.6.0 | +| 2016-06 | CT#72 | CP-160238 | 0633 | - | | Correction on Service-Selection | 13.6.0 | +| 2016-06 | CT#72 | CP-160238 | 0639 | 2 | | Group-Service-Id | 13.6.0 | +| 2016-06 | CT#72 | CP-160233 | 0635 | - | | Renaming of Validity-Time AVP | 13.6.0 | +| 2016-06 | CT#72 | CP-160228 | 0636 | - | | Update SMS Support for NB-IoT | 13.6.0 | +| 2016-06 | CT#72 | CP-160225 | 0637 | 2 | | SCEF realm | 13.6.0 | +| 2016-06 | CT#72 | CP-160222 | 0638 | 2 | | Shared Subscription data update | 14.0.0 | +| 2016-06 | CT#72 | CP-160217 | 0640 | 1 | | Support for Non-IP PDP types | 14.0.0 | +| 2016-06 | CT#72 | CP-160221 | 0641 | 1 | | MSISDN Removal from Subscription Profile | 14.0.0 | +| 2016-09 | CT#73 | CP-160423 | 0645 | - | | PDN-Connection-Restricted flag | 14.1.0 | +| 2016-09 | CT#73 | CP-160423 | 0647 | 1 | | Preferred Data Mode for an SGi PDN connection | 14.1.0 | +| 2016-09 | CT#73 | CP-160428 | 0652 | - | | CR implementation error on ECR and ECA commands | 14.1.0 | +| 2016-09 | CT#73 | CP-160426 | 0658 | 2 | | Current Location Retrieval | 14.1.0 | +| 2016-09 | CT#73 | CP-160437 | 0649 | 1 | | Removal of Editor's Note on non shareable subscription data | 14.1.0 | +| 2016-09 | CT#73 | CP-160437 | 0650 | - | | Removal of Editor's Note on detailed checks for shared subscription data update | 14.1.0 | +| 2016-09 | CT#73 | CP-160437 | 0656 | 2 | | Solution to avoid high load resulting from shared subscription data update | 14.1.0 | +| 2016-09 | CT#73 | CP-160433 | 0653 | - | | Change of Network Access Mode | 14.1.0 | +| 2016-09 | CT#73 | CP-160432 | 0654 | - | | Usage of Supported Features | 14.1.0 | +| 2016-09 | CT#73 | CP-160432 | 0655 | - | | Handling of MSISDN removal from subscription profile | 14.1.0 | +| 2016-12 | CT#74 | CP-160679 | 0659 | 4 | | Handover of Emergency PDN Connections | 14.2.0 | +| 2016-12 | CT#74 | CP-160673 | 0660 | 1 | | Reset-ID AVP description for shared subscription data update | 14.2.0 | +| 2016-12 | CT#74 | CP-160673 | 0671 | 1 | | Update of "Homogeneous Support" Status | 14.2.0 | +| 2016-12 | CT#74 | CP-160673 | 0684 | 1 | | Missing S7a/S7d application identifier | 14.2.0 | +| 2016-12 | CT#74 | CP-160654 | 0662 | 1 | | Communication-Pattern Feature | 14.2.0 | +| 2016-12 | CT#74 | CP-160681 | 0666 | 1 | | Load Control | 14.2.0 | +| 2016-12 | CT#74 | CP-160681 | 0677 | 1 | | Host Load | 14.2.0 | +| 2016-12 | CT#74 | CP-160665 | 0668 | 1 | | Dynamic Removal of UE Usage Type | 14.2.0 | +| 2016-12 | CT#74 | CP-160665 | 0674 | 1 | | Presence of UE Usage Type in Error Responses | 14.2.0 | +| 2016-12 | CT#74 | CP-160657 | 0670 | 1 | | Undefined Bits in Access Restriction Data | 14.2.0 | +| 2016-12 | CT#74 | CP-160678 | 0672 | 1 | | Add V2X Subscription Data to S6a Interface | 14.2.0 | +| 2016-12 | CT#74 | CP-160664 | 0682 | - | | Correction to change IETF drmp draft version to official RFC 7944 | 14.2.0 | +| 2016-12 | CT#74 | CP-160660 | 0683 | 1 | | Deletion of all monitoring events | 14.2.0 | +| 2017-03 | CT#75 | CP-170028 | 0692 | 1 | | Maximum Response Time | 14.3.0 | +| 2017-03 | CT#75 | CP-170039 | 0687 | 1 | | Enhanced Coverage | 14.3.0 | +| 2017-03 | CT#75 | CP-170039 | 0688 | 1 | | Inter-RAT PDN-Continuity | 14.3.0 | +| 2017-03 | CT#75 | CP-170044 | 0693 | 1 | | Emergency-Info AVP in ULA | 14.3.0 | +| 2017-03 | CT#75 | CP-170043 | 0696 | 1 | | Correct UE-PC5-AMBR Format | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0697 | 2 | | Removal of complete APN Configuration Profile | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0698 | 1 | | Clarification of MDT User Consent | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0699 | 1 | | Missing M/O values in several feature flags | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0700 | 2 | | Subscription parameters for eDRX | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0701 | 2 | | Support of long and short Macro eNodeB IDs | 14.3.0 | +| 2017-03 | CT#75 | CP-170048 | 0704 | - | | Update of reference for the Diameter base protocol | 14.3.0 | +| 2017-03 | CT#75 | CP-170048 | 0705 | - | | Handling of the Vendor-Specific-Application-Id AVP | 14.3.0 | +| 2017-03 | CT#75 | CP-170048 | 0706 | - | | Cardinality of the Failed-AVP AVP in answer | 14.3.0 | +| 2017-06 | CT#76 | CP-171029 | 0707 | 1 | | External Identifier in Subscription-Data | 14.4.0 | +| 2017-06 | CT#76 | CP-171021 | 0709 | - | | Alignment of PDN-Connection-Restricted Flag handling on NAS specification | 14.4.0 | +| 2017-06 | CT#76 | CP-171017 | 0713 | 1 | | Add MBSFN Area List to MDT Configuration parameters | 14.4.0 | +| 2017-06 | CT#76 | CP-171184 | 0715 | 2 | | Communication Patterns without Expiry Time | 14.4.0 | +| 2017-06 | CT#76 | CP-171029 | 0717 | 1 | | Loss Of Connectivity Reason in S6a/d IDA | 14.4.0 | +| 2017-06 | CT#76 | CP-171018 | 0720 | 1 | | Support for signaling transport level packet marking | 14.4.0 | +| 2017-06 | CT#76 | CP-171043 | 0718 | 1 | | Clarification of S6a/Notification-Request command for non-IP APNs | 15.0.0 | +| 2017-06 | CT#76 | CP-171041 | 0721 | - | | Removal of UE-Usage-Type | 15.0.0 | +| 2017-09 | CT#77 | CP-172027 | 0727 | 1 | | Access Restriction to NR as Secondary RAT | 15.1.0 | +| 2017-09 | CT#77 | CP-172027 | 0728 | 1 | | Extended QoS for 5G NR | 15.1.0 | +| 2017-09 | CT#77 | CP-172018 | 0729 | 1 | | Acknowledgements of downlink NAS data PDUs | 15.1.0 | +| 2017-09 | CT#77 | CP-172018 | 0730 | 1 | | Reliable Data Service | 15.1.0 | +| 2017-09 | CT#77 | CP-172026 | 0731 | 1 | | Enhancements for NAPS on Idle Status Indication | 15.1.0 | +| 2017-09 | CT#77 | CP-172013 | 0736 | - | | Correction of DRMP Procedures | 15.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------|--------| +| 2017-12 | CT#78 | CP-173016 | 0743 | 1 | | Correction on subscribed eDRX parameter value | 15.2.0 | +| 2017-12 | CT#78 | CP-173028 | 0740 | 1 | | Clarification of UE Reachability monitoring event over S6a/S6d | 15.2.0 | +| 2017-12 | CT#78 | CP-173025 | 0741 | - | | Error in the DIAMETER_ERROR_EQUIPMENT_UNKNOWN name | 15.2.0 | +| 2017-12 | CT#78 | CP-173025 | 0744 | 3 | | Active Time in Insert Subscriber Data | 15.2.0 | +| 2017-12 | CT#78 | CP-173035 | 0746 | 1 | | Access restriction to unlicensed spectrum as secondary RAT | 15.2.0 | +| 2017-12 | CT#78 | CP-173036 | 0747 | 1 | | Access Restrictions to NR as Secondary RAT on MM Context | 15.2.0 | +| 2018-03 | CT#79 | CP-180013 | 0755 | 2 | | Handling of Homogenous-Support-of-IMS-Voice-Over-PS-Sessions AVP | 15.3.0 | +| 2018-03 | CT#79 | CP-180021 | 0756 | - | | Service Gap Time | 15.3.0 | +| 2018-03 | CT#79 | CP-180025 | 0757 | 1 | | Filtering the Report for Number of UEs in a Geographic Area | 15.3.0 | +| 2018-06 | CT#80 | CP-181122 | 0758 | - | | Bandwidth Clarification | 15.4.0 | +| 2018-06 | CT#80 | CP-181122 | 0759 | 1 | | Supported-Services AVP code | 15.4.0 | +| 2018-06 | CT#80 | CP-181122 | 0762 | 1 | | Subscription for Aerial UE in 3GPP system | 15.4.0 | +| 2018-06 | CT#80 | CP-181124 | 0765 | 1 | | Subscription data for ciphering keys | 15.4.0 | +| 2018-06 | CT#80 | CP-181133 | 0763 | 1 | | Access Restrictions | 15.4.0 | +| 2018-09 | CT#81 | CP-182077 | 0766 | - | | Update of Broadcast-Location-Assistance-Data-Types AVP | 15.5.0 | +| 2018-09 | CT#81 | CP-182067 | 0767 | 2 | | Access Restriction Data for NR as Secondary RAT not supported by HSS | 15.5.0 | +| 2018-09 | CT#81 | CP-182067 | 0774 | - | | Applicable values for AMBR | 15.5.0 | +| 2018-09 | CT#81 | CP-182075 | 0768 | 1 | | Handling of monitoring events in ULA | 15.5.0 | +| 2018-09 | CT#81 | CP-182072 | 0769 | 1 | | Subscribed PTW length | 15.5.0 | +| 2018-09 | CT#81 | CP-182072 | 0770 | 1 | | DSR-Flag for Active-Time | 15.5.0 | +| 2018-09 | CT#81 | CP-182071 | 0771 | 2 | | DSR-Flag for eDRX-Cycle-Length | 15.5.0 | +| 2018-09 | CT#81 | CP-182084 | 0773 | - | | Access Restrictions | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 0775 | 4 | | Single Registration | 15.6.0 | +| 2018-12 | CT#82 | CP-183092 | 0776 | 1 | | Interworking with 5GS indicator in APN Subscription | 15.6.0 | +| 2018-12 | CT#82 | CP-183092 | 0789 | 2 | | MME_UPDATE_PROCEDURE | 15.6.0 | +| 2018-12 | CT#82 | CP-183098 | 0785 | 1 | | Deletion of monitoring events when unknown in SCEF | 15.6.0 | +| 2018-12 | CT#82 | CP-183098 | 0786 | - | | Event configuration failure in ULA | 15.6.0 | +| 2018-12 | CT#82 | CP-183098 | 0787 | 1 | | Idle-Status-Indication is missing in monitoring event report | 15.6.0 | +| 2018-12 | CT#82 | CP-183098 | 0788 | 1 | | Applicability of Maximum Number of Reports | 15.6.0 | +| 2018-12 | CT#82 | CP-183100 | 0784 | 3 | | Behavior of MME/SGSN upon reception of DIAMETER_UNABLE_TO_COMPLY for NOR | 15.6.0 | +| 2018-12 | CT#82 | CP-183100 | 0790 | 1 | | Paging Time Window | 15.6.0 | +| 2019-03 | CT#83 | CP-190034 | 0791 | 1 | | eDRX AVPs | 15.7.0 | +| 2019-03 | CT#83 | CP-190038 | 0792 | - | | Missing Maximum-UE-Availability-Time AVP | 15.7.0 | +| 2019-03 | CT#83 | CP-190034 | 0794 | 1 | | Access Restriction to NR as Secondary RAT for SGSN | 15.7.0 | +| 2019-03 | CT#83 | CP-190034 | 0795 | - | | Paging-Time-Window AVP name | 15.7.0 | +| 2019-03 | CT#83 | CP-190037 | 0796 | 1 | | Handling of multiple external IDs for the same UE | 15.7.0 | +| 2019-06 | CT#84 | CP-191023 | 0797 | - | | Service Gap Time Deletion | 15.8.0 | +| 2019-09 | CT#85 | CP-192094 | 0804 | 2 | | draft-ietf-dime-load published as RFC 8583 | 15.9.0 | +| 2019-09 | CT#85 | CP-192121 | 0801 | 1 | | Communication pattern enhancement | 16.0.0 | +| 2019-09 | CT#85 | CP-192122 | 0800 | 1 | | Event type PDN Connectivity Status | 16.0.0 | +| 2019-09 | CT#85 | CP-192122 | 0802 | - | | Ethernet PDN Type | 16.0.0 | +| 2019-12 | CT#86 | CP-193024 | 0808 | - | | Applicability of Core Network Restrictions | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0809 | 1 | | Subscribed ARPI | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0810 | - | | LTE-M Access Restriction | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0812 | - | | Missing protocol code-point values | 16.1.0 | +| 2019-12 | CT#86 | CP-193052 | 0807 | 1 | | Battery Indication for Communication pattern enhancement | 16.1.0 | +| 2020-03 | CT#87e | CP-200027 | 0813 | 1 | | Addition of IAB-Operation-Permission to subscriber data | 16.2.0 | +| 2020-03 | CT#87e | CP-200036 | 0814 | 1 | | Subscription data for NR V2X | 16.2.0 | +| 2020-06 | CT#88e | CP-201053 | 0815 | - | | Alignments on definitions | 16.3.0 | +| 2020-06 | CT#88e | CP-201053 | 0816 | - | | Supported Monitoring Events | 16.3.0 | +| 2020-06 | CT#88e | CP-201053 | 0818 | - | | Error cause handling | 16.3.0 | +| 2020-06 | CT#88e | CP-201053 | 0819 | 1 | | Update of RAT restrictions | 16.3.0 | +| 2020-06 | CT#88e | CP-201053 | 0821 | 1 | | Supported Features for combined MME/SGSN | 16.3.0 | +| 2020-06 | CT#88e | CP-201049 | 0817 | 1 | | Subscribed PC5 QoS Parameters for NR V2X | 16.3.0 | +| 2020-06 | CT#88e | CP-201033 | 0820 | 1 | | SGSN Interworking with 5G | 16.3.0 | +| 2020-09 | CT#89e | CP-202109 | 0822 | 2 | | Monitoring Configurations in ULA | 16.4.0 | +| 2020-09 | CT#89e | CP-202094 | 0823 | - | | Immediate Event Report in IDA | 16.4.0 | +| 2020-09 | CT#89e | CP-202094 | 0824 | 1 | | Corrections on Broadcast-Location-Assistance-Data-Types | 16.4.0 | +| 2020-12 | CT#90e | CP-203032 | 0826 | - | | Extended Reference ID | 16.5.0 | +| 2020-12 | CT#90e | CP-203032 | 0825 | 1 | | Correction for implementation error | 16.5.0 | +| 2021-03 | CT#91e | CP-210057 | 0828 | - | | Default APN for Ethernet PDN types | 16.6.0 | +| 2021-03 | CT#91e | CP-210053 | 0829 | 2 | | Cancellation Type for UDICOM | 16.6.0 | +| 2021-03 | CT#91e | CP-210027 | 0827 | 1 | | Use of inclusive terminology | 17.0.0 | +| 2021-09 | CT#93e | CP-212053 | 0830 | - | F | Superfluous AVPs in re-used Diameter AVPs table | 17.1.0 | +| 2022-03 | CT#93e | CP-220063 | 0832 | - | F | Removal of Monitoring Events when External ID or MSISDN is deleted | 17.1.0 | +| 2022-03 | CT#93e | CP-220093 | 0831 | 1 | B | Access Restriction for IoT Satellite Access | 17.2.0 | +| 2022-06 | CT#96 | CP-221060 | 0834 | - | F | Clarification on Withdrawal of eDRX Cycle Length | 17.3.0 | +| 2022-06 | CT#96 | CP-221060 | 0836 | 1 | F | Withdrawal of Paging Time Window Subscription | 17.3.0 | +| 2022-06 | CT#96 | CP-221060 | 0837 | 1 | F | Emergency service session continuity | 17.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------|--------| +| 2022-06 | CT#96 | CP-221066 | 0840 | - | A | CR 0828 has not been correctly implemented | 17.3.0 | +| 2022-09 | CT#97e | CP-222073 | 0842 | 2 | F | Update ULR flags in support of handover | 17.4.0 | +| 2023-03 | CT#99 | CP-230054 | 0843 | - | F | Skip Subscriber Data in ULR-Flags | 18.0.0 | +| 2023-06 | CT#100 | CP-231063 | 0844 | - | F | Reachability Cause in immediate reports | 18.1.0 | +| 2023-12 | CT#102 | | 0847 | 1 | A | Preventing LTE to NR NTN handover for users without NR NTN subscription | 18.2.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29273/raw.md b/raw/rel-18/29_series/29273/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..9ec9a833c3d2007342064e4bd5cbed7d558e22c9 --- /dev/null +++ b/raw/rel-18/29_series/29273/raw.md @@ -0,0 +1,7445 @@ + + +# 3GPP TS 29.273 V18.3.0 (2023-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Evolved Packet System (EPS); 3GPP EPS AAA interfaces (Release 18)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro. It features the letters "lte" in a bold, black, lowercase font. Above the "e" is the text "Advanced Pro" in a smaller, red font. To the right of the "e" is a green signal icon consisting of three curved lines. + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The logo for 3GPP. It features the letters "3GPP" in a bold, black, stylized font. Below the "P" is a red signal icon consisting of three curved lines. Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, black, uppercase font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +# **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|-------------------------------------------------------------------------------------------|----| +| Foreword..... | 11 | +| Introduction..... | 12 | +| 1 Scope..... | 13 | +| 2 References..... | 13 | +| 3 Definitions, symbols and abbreviations..... | 15 | +| 3.1 Definitions..... | 15 | +| 3.1.1 General..... | 15 | +| 3.1.2 Handling of Information Elements..... | 16 | +| 3.2 Abbreviations..... | 16 | +| 4 SWa and SWa' Description..... | 17 | +| 4.1 Functionality..... | 17 | +| 4.1.1 General..... | 17 | +| 4.1.2 Procedure Descriptions..... | 17 | +| 4.1.2.1 SWa Authentication and Authorization procedure..... | 17 | +| 4.1.2.1.1 General..... | 17 | +| 4.1.2.1.2 3GPP AAA Server Detailed Behaviour..... | 19 | +| 4.1.2.1.3 3GPP AAA Proxy Detailed Behaviour..... | 20 | +| 4.1.2.2 SWa HSS/AAA Initiated Detach..... | 20 | +| 4.1.2.3 SWa Non-3GPP Access Network Initiated Detach..... | 20 | +| 4.1.2.4 SWa Re-Authentication and Re-Authorization Procedure..... | 21 | +| 4.1.2.4.1 General..... | 21 | +| 4.1.2.4.2 3GPP AAA Server Detailed Behaviour..... | 22 | +| 4.1.2.4.3 3GPP AAA Proxy Detailed Behaviour..... | 22 | +| 4.1.2.5 SWa procedures for NSWO in 5GS..... | 22 | +| 4.2 Protocol Specification..... | 23 | +| 4.2.1 General..... | 23 | +| 4.2.2 Commands..... | 23 | +| 4.2.2.1 Commands for SWa authentication and authorization procedures..... | 23 | +| 4.2.2.1.1 Diameter-EAP-Request (DER) Command..... | 23 | +| 4.2.2.1.2 Diameter-EAP-Answer (DEA) Command..... | 24 | +| 4.2.2.2 Commands for SWa HSS/AAA Initiated Detach..... | 24 | +| 4.2.2.3 Commands for Untrusted non-3GPP Access network Initiated Session Termination..... | 24 | +| 4.2.2.4 Commands for SWa Re-Authentication and Re-Authorization Procedures..... | 24 | +| 4.2.2.4.1 Re-Auth-Request (RAR) Command..... | 24 | +| 4.2.2.4.2 Re-Auth-Answer (RAA) Command..... | 25 | +| 4.2.2.4.3 Diameter-EAP-Request (DER) Command..... | 25 | +| 4.2.2.4.4 Diameter-EAP-Answer (DEA) Command..... | 25 | +| 4.2.3 Information Elements..... | 25 | +| 4.2.4 Session Handling..... | 25 | +| 5 STa Description..... | 25 | +| 5.1 Functionality..... | 25 | +| 5.1.1 General..... | 25 | +| 5.1.2 Procedures Description..... | 26 | +| 5.1.2.1 STa Access Authentication and Authorization..... | 26 | +| 5.1.2.1.1 General..... | 26 | +| 5.1.2.1.2 3GPP AAA Server Detailed Behaviour..... | 36 | +| 5.1.2.1.3 3GPP AAA Proxy Detailed Behaviour..... | 42 | +| 5.1.2.1.4 Trusted non-3GPP access network Detailed Behaviour..... | 44 | +| 5.1.2.2 HSS/AAA Initiated Detach on STa..... | 46 | +| 5.1.2.2.1 General..... | 46 | +| 5.1.2.2.2 3GPP AAA Server Detailed Behaviour..... | 47 | +| 5.1.2.2.3 3GPP AAA Proxy Detailed Behaviour..... | 47 | +| 5.1.2.3 STa Re-Authorization and Re-Authentication Procedures..... | 48 | + +| | | | +|-----------|-----------------------------------------------------------------------------------------------|----| +| 5.1.2.3.1 | General..... | 48 | +| 5.1.2.3.2 | 3GPP AAA Server Detailed Behaviour..... | 55 | +| 5.1.2.3.3 | 3GPP AAA Proxy Detailed Behaviour..... | 56 | +| 5.1.2.3.4 | Trusted Non-3GPP Access Network Detailed Behaviour..... | 56 | +| 5.1.2.4 | Non-3GPP Access Network Initiated Session Termination..... | 57 | +| 5.1.2.4.1 | General..... | 57 | +| 5.1.2.4.2 | 3GPP AAA Server Detailed Behaviour..... | 57 | +| 5.1.2.4.3 | 3GPP AAA Proxy Detailed Behaviour..... | 57 | +| 5.1.2.5 | ERP Re-Authentication in Non-3GPP Access..... | 58 | +| 5.1.2.5.1 | General..... | 58 | +| 5.1.2.5.2 | ER server located in 3GPP AAA Proxy or 3GPP AAA Server Detailed Behaviour..... | 58 | +| 5.1.2.5.3 | 3GPP AAA Proxy Detailed Behaviour..... | 59 | +| 5.2 | Protocol Specification..... | 59 | +| 5.2.1 | General..... | 59 | +| 5.2.2 | Commands..... | 60 | +| 5.2.2.1 | Commands for STa PMIPv6 or GTPv2 or ERP (re-)authentication and authorization procedures..... | 60 | +| 5.2.2.1.1 | Diameter-EAP-Request (DER) Command..... | 60 | +| 5.2.2.1.2 | Diameter-EAP-Answer (DEA) Command..... | 60 | +| 5.2.2.2 | Commands for STa HSS/AAA Initiated Detach for Trusted non-3GPP Access..... | 61 | +| 5.2.2.2.1 | Abort-Session-Request (ASR) Command..... | 61 | +| 5.2.2.2.2 | Abort-Session-Answer (ASA) Command..... | 62 | +| 5.2.2.2.3 | Session-Termination-Request (STR) Command..... | 62 | +| 5.2.2.2.4 | Session-Termination-Answer (STA) Command..... | 62 | +| 5.2.2.3 | Commands for Re-Authentication and Re-Authorization Procedure..... | 62 | +| 5.2.2.3.1 | Re-Auth-Request (RAR) Command..... | 62 | +| 5.2.2.3.2 | Re-Auth-Answer (RAA) Command..... | 63 | +| 5.2.2.3.3 | AA-Request (AAR) Command..... | 63 | +| 5.2.2.3.4 | AA-Answer (AAA) Command..... | 63 | +| 5.2.2.3.5 | Diameter-EAP-Request (DER) Command..... | 64 | +| 5.2.2.3.6 | Diameter-EAP-Answer (DEA) Command..... | 64 | +| 5.2.2.4 | Commands for Trusted non-3GPP Access network Initiated Session Termination..... | 64 | +| 5.2.2.4.1 | Session-Termination-Request (STR) Command..... | 64 | +| 5.2.2.4.2 | Session-Termination-Answer (STA) Command..... | 64 | +| 5.2.3 | Information Elements..... | 65 | +| 5.2.3.1 | General..... | 65 | +| 5.2.3.2 | Mobile-Node-Identifier..... | 67 | +| 5.2.3.3 | MIP6-Feature-Vector..... | 68 | +| 5.2.3.4 | QoS Capability..... | 68 | +| 5.2.3.5 | Service-Selection..... | 68 | +| 5.2.3.6 | RAT-Type..... | 68 | +| 5.2.3.7 | ANID..... | 69 | +| 5.2.3.8 | AMBR..... | 69 | +| 5.2.3.9 | AN-Trusted..... | 69 | +| 5.2.3.10 | Feature-List-ID AVP..... | 69 | +| 5.2.3.11 | Feature-List AVP..... | 69 | +| 5.2.3.12 | MIP-FA-RK..... | 69 | +| 5.2.3.13 | MIP-FA-RK-SPI..... | 69 | +| 5.2.3.14 | Full-Network-Name..... | 69 | +| 5.2.3.15 | Short-Network-Name..... | 69 | +| 5.2.3.16 | Void..... | 70 | +| 5.2.3.17 | Void..... | 70 | +| 5.2.3.18 | WLAN-Identifier..... | 70 | +| 5.2.3.19 | Transport-Access-Type..... | 70 | +| 5.2.3.20 | DER-Flags..... | 70 | +| 5.2.3.21 | DEA-Flags..... | 71 | +| 5.2.3.22 | SSID..... | 72 | +| 5.2.3.23 | HESSID..... | 72 | +| 5.2.3.24 | Access-Network-Info..... | 72 | +| 5.2.3.25 | TWAN-Connection-Mode..... | 73 | +| 5.2.3.26 | TWAN-Connectivity-Parameters..... | 73 | +| 5.2.3.27 | Connectivity-Flags..... | 74 | + +| | | | +|-----------|-----------------------------------------------------------------------------------|-----| +| 5.2.3.28 | TWAN-PCO..... | 74 | +| 5.2.3.29 | TWAG-CP-Address..... | 74 | +| 5.2.3.30 | TWAG-UP-Address..... | 74 | +| 5.2.3.31 | TWAN-S2a-Failure-Cause..... | 74 | +| 5.2.3.32 | SM-Back-Off-Timer..... | 75 | +| 5.2.3.33 | WLCP-Key..... | 75 | +| 5.2.3.34 | Void..... | 75 | +| 5.2.3.35 | IMEI-Check-In-VPLMN-Result..... | 75 | +| 5.2.3.36 | High-Priority-Access-Info..... | 76 | +| 5.2.4 | Session Handling..... | 76 | +| 6 | SWd and SWd' Description..... | 76 | +| 6.1 | Functionality..... | 76 | +| 6.1.1 | General..... | 76 | +| 6.1.2 | Procedures Description..... | 77 | +| 6.1.2.1 | Trusted non-3GPP Access / Access Gateway related procedures..... | 77 | +| 6.1.2.1.1 | Trusted Non-3GPP Access Authentication and Authorization..... | 77 | +| 6.1.2.1.2 | HSS/AAA Initiated Detach for Trusted non-3GPP Access..... | 79 | +| 6.1.2.1.3 | Access and Service Authorization information update..... | 79 | +| 6.1.2.1.4 | Trusted non-3GPP Access Network Initiated Session Termination..... | 80 | +| 6.1.2.2 | Untrusted non-3GPP Access / ePDG related procedures..... | 80 | +| 6.1.2.3 | PDN GW related procedures..... | 81 | +| 6.1.2.4 | SWd' procedures for NSWO in 5GS..... | 81 | +| 6.2 | Protocol Specification..... | 82 | +| 6.2.1 | General..... | 82 | +| 6.2.2 | Commands..... | 82 | +| 6.2.2.1 | Commands used in connection with the STa interface..... | 82 | +| 6.2.2.1.1 | Commands for STa PMIPv6 or GTPv2 authentication and authorization procedures..... | 82 | +| 6.2.2.1.2 | Commands for STa HSS/AAA Initiated Detach for Trusted non-3GPP Access..... | 84 | +| 6.2.2.1.3 | Commands for STa Access and Service Authorization Update Procedure..... | 84 | +| 6.2.2.1.4 | Commands for Trusted non-3GPP Access network Initiated Session Termination..... | 84 | +| 6.2.2.2 | Commands used in connection with the SWm interface..... | 84 | +| 6.2.2.3 | Commands used in connection with the S6b interface..... | 84 | +| 6.2.3 | Information Elements..... | 84 | +| 6.2.3.1 | General..... | 84 | +| 7 | SWm Description..... | 86 | +| 7.1 | Functionality..... | 86 | +| 7.1.1 | General..... | 86 | +| 7.1.2 | Procedures Description..... | 87 | +| 7.1.2.1 | Authentication and Authorization Procedures..... | 87 | +| 7.1.2.1.1 | General..... | 87 | +| 7.1.2.1.2 | 3GPP AAA Server Detailed Behaviour..... | 92 | +| 7.1.2.1.3 | 3GPP AAA Proxy Detailed Behaviour..... | 95 | +| 7.1.2.1.4 | ePDG Detailed Behaviour..... | 96 | +| 7.1.2.2 | Authorization Procedures..... | 98 | +| 7.1.2.2.1 | General..... | 98 | +| 7.1.2.2.2 | 3GPP AAA Server Detailed Behaviour..... | 100 | +| 7.1.2.2.3 | 3GPP AAA Proxy Detailed Behaviour..... | 100 | +| 7.1.2.2.4 | ePDG Detailed Behaviour..... | 101 | +| 7.1.2.3 | ePDG Initiated Session Termination Procedures..... | 102 | +| 7.1.2.3.1 | General..... | 102 | +| 7.1.2.3.2 | 3GPP AAA Server Detailed Behavior..... | 102 | +| 7.1.2.3.3 | 3GPP AAA Proxy Detailed Behavior..... | 102 | +| 7.1.2.4 | 3GPP AAA Server Initiated Session Termination Procedures..... | 103 | +| 7.1.2.4.1 | General..... | 103 | +| 7.1.2.4.2 | 3GPP AAA Server Detailed Behaviour..... | 103 | +| 7.1.2.4.3 | 3GPP AAA Proxy Detailed Behaviour..... | 104 | +| 7.1.2.5 | Authorization Information Update Procedures..... | 104 | +| 7.1.2.5.1 | General..... | 104 | +| 7.1.2.5.2 | 3GPP AAA Server Detailed Behaviour..... | 105 | +| 7.1.2.5.3 | ePDG Detailed Behaviour..... | 105 | + +| | | | +|-----------|-------------------------------------------------------------------|-----| +| 7.2 | Protocol Specification..... | 106 | +| 7.2.1 | General..... | 106 | +| 7.2.2 | Commands..... | 106 | +| 7.2.2.1 | Commands for SWm Authentication and Authorization Procedures..... | 106 | +| 7.2.2.1.1 | Diameter-EAP-Request (DER) Command..... | 106 | +| 7.2.2.1.2 | Diameter-EAP-Answer (DEA) Command..... | 107 | +| 7.2.2.1.3 | Diameter-AA-Request (AAR) Command..... | 107 | +| 7.2.2.1.4 | Diameter-AA-Answer (AAA) Command..... | 108 | +| 7.2.2.2 | Commands for ePDG Initiated Session Termination..... | 108 | +| 7.2.2.2.1 | Session-Termination-Request (STR) Command..... | 108 | +| 7.2.2.2.2 | Session-Termination-Answer (STA) Command..... | 108 | +| 7.2.2.3 | Commands for 3GPP AAA Server Initiated Session Termination..... | 109 | +| 7.2.2.3.1 | Abort-Session-Request (ASR) Command..... | 109 | +| 7.2.2.3.2 | Abort-Session-Answer (ASA) Command..... | 109 | +| 7.2.2.3.3 | Session-Termination-Request (STR) Command..... | 109 | +| 7.2.2.3.4 | Session-Termination-Answer (STA) Command..... | 110 | +| 7.2.2.4 | Commands for Authorization Information Update..... | 110 | +| 7.2.2.4.1 | Re-Auth-Request (RAR) Command..... | 110 | +| 7.2.2.4.2 | Re-Auth-Answer (RAA) Command..... | 110 | +| 7.2.3 | Information Elements..... | 111 | +| 7.2.3.1 | General..... | 111 | +| 7.2.3.2 | Feature-List-ID AVP..... | 112 | +| 7.2.3.3 | Feature-List AVP..... | 112 | +| 7.2.3.4 | Emergency-Services..... | 112 | +| 7.2.3.5 | AAR-Flags..... | 113 | +| 7.2.4 | Session Handling..... | 113 | +| 8 | SWx Description..... | 113 | +| 8.1 | Functionality..... | 113 | +| 8.1.1 | General..... | 113 | +| 8.1.2 | Procedures Description..... | 113 | +| 8.1.2.1 | Authentication Procedure..... | 113 | +| 8.1.2.1.1 | General..... | 113 | +| 8.1.2.1.2 | Detailed behaviour..... | 116 | +| 8.1.2.2 | Location Management Procedures..... | 117 | +| 8.1.2.2.1 | General..... | 117 | +| 8.1.2.2.2 | UE/PDN Registration/DeRegistration Notification..... | 117 | +| 8.1.2.2.3 | Network Initiated De-Registration by HSS, Administrative..... | 121 | +| 8.1.2.3 | HSS Initiated Update of User Profile..... | 122 | +| 8.1.2.3.1 | General..... | 122 | +| 8.1.2.3.2 | HSS Detailed behaviour..... | 124 | +| 8.1.2.3.3 | 3GPP AAA Server Detailed behaviour..... | 124 | +| 8.1.2.4 | Fault Recovery Procedures..... | 125 | +| 8.1.2.4.1 | HSS Reset Indication..... | 125 | +| 8.1.2.4.2 | HSS Restoration..... | 126 | +| 8.2 | Protocol Specification..... | 128 | +| 8.2.1 | General..... | 128 | +| 8.2.2 | Commands..... | 128 | +| 8.2.2.1 | Authentication Procedure..... | 128 | +| 8.2.2.2 | HSS Initiated Update of User Profile Procedure..... | 129 | +| 8.2.2.3 | Non-3GPP IP Access Registration Procedure..... | 130 | +| 8.2.2.4 | Network Initiated De-Registration by HSS Procedure..... | 131 | +| 8.2.3 | Information Elements..... | 132 | +| 8.2.3.0 | General..... | 132 | +| 8.2.3.1 | Non-3GPP-User-Data..... | 134 | +| 8.2.3.2 | Subscription-ID..... | 135 | +| 8.2.3.3 | Non-3GPP-IP-Access..... | 135 | +| 8.2.3.4 | Non-3GPP-IP-Access-APN..... | 135 | +| 8.2.3.5 | RAT-Type..... | 135 | +| 8.2.3.6 | Session-Timeout..... | 135 | +| 8.2.3.7 | APN-Configuration..... | 136 | +| 8.2.3.8 | ANID..... | 136 | + +| | | | +|-----------|-------------------------------------------------------------------------|-----| +| 8.2.3.9 | SIP-Auth-Data-Item..... | 136 | +| 8.2.3.10 | Confidentiality-Key..... | 136 | +| 8.2.3.11 | Integrity-Key..... | 136 | +| 8.2.3.12 | Server-Assignment-Type AVP..... | 136 | +| 8.2.3.13 | Trace-Info..... | 137 | +| 8.2.3.14 | Trace-Data..... | 137 | +| 8.2.3.15 | Feature-List-ID AVP..... | 137 | +| 8.2.3.16 | Feature-List AVP..... | 137 | +| 8.2.3.17 | PPR-Flags..... | 139 | +| 8.2.3.18 | TWAN-Default-APN-Context-Id..... | 139 | +| 8.2.3.19 | TWAN-Access-Info..... | 140 | +| 8.2.3.20 | Access-Authorization-Flags..... | 140 | +| 8.2.3.21 | AAA-Failure-Indication..... | 140 | +| 8.2.3.22 | OC-Supported-Features..... | 141 | +| 8.2.3.23 | OC-OLR..... | 141 | +| 8.2.3.24 | 3GPP-AAA-Server-Name..... | 141 | +| 8.2.3.25 | DRMP..... | 141 | +| 8.2.3.26 | Load..... | 141 | +| 8.2.3.27 | ERP-Authorization..... | 141 | +| 8.2.3.28 | MIP6-Feature-Vector..... | 141 | +| 8.2.4 | Session Handling..... | 142 | +| 8.3 | User identity to HSS resolution..... | 142 | +| 9 | S6b Description..... | 143 | +| 9.1 | Functionality..... | 143 | +| 9.1.1 | General..... | 143 | +| 9.1.2 | Procedures Description..... | 143 | +| 9.1.2.1 | Authentication and Authorization Procedures when using DSMIPv6..... | 143 | +| 9.1.2.1.1 | General..... | 143 | +| 9.1.2.1.2 | PDN GW Detailed Behaviour..... | 146 | +| 9.1.2.1.3 | 3GPP AAA Server Detailed Behaviour..... | 147 | +| 9.1.2.1.4 | 3GPP AAA Proxy Detailed Behaviour..... | 148 | +| 9.1.2.2 | Authorization Procedures when using PMIPv6 or GTPv2..... | 148 | +| 9.1.2.2.1 | General..... | 148 | +| 9.1.2.2.2 | PDN GW Detailed Behaviour..... | 151 | +| 9.1.2.2.3 | 3GPP AAA Server Detailed Behaviour..... | 151 | +| 9.1.2.2.4 | 3GPP AAA Proxy Detailed Behaviour..... | 153 | +| 9.1.2.3 | PDN GW Initiated Session Termination Procedures..... | 153 | +| 9.1.2.3.1 | General..... | 153 | +| 9.1.2.3.2 | PDN GW Detailed Behaviour..... | 154 | +| 9.1.2.3.3 | 3GPP AAA Server Detailed Behaviour..... | 154 | +| 9.1.2.3.4 | 3GPP AAA Proxy Detailed Behaviour..... | 154 | +| 9.1.2.4 | 3GPP AAA Initiated Session Termination Procedures..... | 154 | +| 9.1.2.4.1 | General..... | 154 | +| 9.1.2.4.2 | PDN GW Detailed Behaviour..... | 155 | +| 9.1.2.4.3 | 3GPP AAA Server Detailed Behaviour..... | 155 | +| 9.1.2.4.4 | 3GPP AAA Proxy Detailed Behaviour..... | 156 | +| 9.1.2.5 | Service Authorization Information Update Procedures..... | 156 | +| 9.1.2.5.1 | General..... | 156 | +| 9.1.2.5.2 | Detailed Behaviour..... | 159 | +| 9.1.2.6 | Authorization Procedures when using MIPv4 FACoA..... | 160 | +| 9.1.2.6.1 | General..... | 160 | +| 9.1.2.6.2 | PDN GW Detailed Behaviour..... | 161 | +| 9.1.2.6.3 | 3GPP AAA Server Detailed Behaviour..... | 162 | +| 9.1.2.6.4 | 3GPP AAA Proxy Detailed Behaviour..... | 163 | +| 9.2 | Protocol Specification..... | 163 | +| 9.2.1 | General..... | 163 | +| 9.2.2 | Commands..... | 163 | +| 9.2.2.1 | Commands for S6b DSMIPv6 Authorization Procedures..... | 163 | +| 9.2.2.1.1 | Diameter-EAP-Request (DER) Command..... | 163 | +| 9.2.2.1.2 | Diameter-EAP-Answer (DEA) Command..... | 164 | +| 9.2.2.2 | Commands for S6b PMIPv6, GTPv2 or DSMIPv6 Authorization Procedures..... | 164 | + +| | | | +|-----------|---------------------------------------------------------------------------|-----| +| 9.2.2.2.1 | AA-Request (AAR) Command..... | 164 | +| 9.2.2.2.2 | AA-Answer (AAA) Command..... | 165 | +| 9.2.2.3 | Commands for PDN GW Initiated Session Termination..... | 166 | +| 9.2.2.3.1 | Session-Termination-Request (STR) Command..... | 166 | +| 9.2.2.3.2 | Session-Termination-Answer (STA) Command..... | 166 | +| 9.2.2.4 | Commands for 3GPP AAA Server Initiated Session Termination..... | 166 | +| 9.2.2.4.1 | Abort-Session-Request (ASR) Command..... | 166 | +| 9.2.2.4.2 | Abort-Session-Answer (ASA) Command..... | 167 | +| 9.2.2.4.3 | Session-Termination-Request (STR) Command..... | 167 | +| 9.2.2.4.4 | Session-Termination-Answer (STA) Command..... | 167 | +| 9.2.2.5 | Commands for S6b MIPv4 FACoA Authorization Procedures..... | 167 | +| 9.2.2.5.1 | AA-Request (AAR) Command..... | 167 | +| 9.2.2.5.2 | AA-Answer (AAA) Command..... | 168 | +| 9.2.2.6 | Commands for S6b Service Authorization Information Update Procedures..... | 168 | +| 9.2.2.6.1 | Re-Auth-Request (RAR) Command..... | 168 | +| 9.2.2.6.2 | Re-Auth-Answer (RAA) Command..... | 169 | +| 9.2.3 | Information Elements..... | 169 | +| 9.2.3.0 | General..... | 169 | +| 9.2.3.1 | S6b DSMIPv6 procedures..... | 169 | +| 9.2.3.1.1 | General..... | 169 | +| 9.2.3.1.2 | Visited-Network-Identifier..... | 170 | +| 9.2.3.1.3 | Void..... | 170 | +| 9.2.3.1.4 | Void..... | 170 | +| 9.2.3.1.5 | RAR-Flags..... | 170 | +| 9.2.3.2 | S6b PMIPv6 or GTPv2 procedures..... | 171 | +| 9.2.3.2.1 | General..... | 171 | +| 9.2.3.2.2 | MIP6-Agent-Info..... | 171 | +| 9.2.3.2.3 | MIP6-Feature-Vector..... | 171 | +| 9.2.3.2.4 | QoS-Capability..... | 172 | +| 9.2.3.2.5 | QoS-Resources..... | 172 | +| 9.2.3.2.6 | Origination-Time-Stamp..... | 172 | +| 9.2.3.2.7 | Maximum-Wait-Time..... | 172 | +| 9.2.3.3 | S6b Re-used Diameter AVPs..... | 172 | +| 9.2.3.4 | Feature-List-ID AVP..... | 172 | +| 9.2.3.5 | Feature-List AVP..... | 172 | +| 9.2.3.6 | S6b MIPv4 FACoA procedures..... | 173 | +| 9.2.3.6.1 | General..... | 173 | +| 9.2.3.6.2 | MIP6-Agent-Info..... | 173 | +| 9.2.3.6.3 | MIP6-Feature-Vector..... | 174 | +| 9.2.3.6.4 | QoS-Capability..... | 174 | +| 9.2.3.6.5 | QoS-Resources..... | 174 | +| 9.2.3.6.6 | MIP-MN-HA-SPI..... | 174 | +| 9.2.3.6.7 | MIP-Session-Key..... | 174 | +| 9.2.3.7 | DER-S6b-Flags..... | 174 | +| 9.2.4 | Session Handling..... | 174 | +| 10 | Result-Code and Experimental-Result Values..... | 175 | +| 10.1 | General..... | 175 | +| 10.2 | Success..... | 175 | +| 10.3 | Permanent Failures..... | 175 | +| 10.3.1 | General..... | 175 | +| 10.3.2 | DIAMETER_ERROR_USER_UNKNOWN (5001)..... | 175 | +| 10.3.3 | DIAMETER_ERROR_IDENTITY_NOT_REGISTERED (5003)..... | 175 | +| 10.3.4 | DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004)..... | 175 | +| 10.3.5 | DIAMETER_ERROR_IDENTITY_ALREADY_REGISTERED (5005)..... | 175 | +| 10.3.6 | DIAMETER_ERROR_USER_NO_NON_3GPP_SUBSCRIPTION (5450)..... | 175 | +| 10.3.7 | DIAMETER_ERROR_USER_NO_APN_SUBSCRIPTION (5451)..... | 175 | +| 10.3.8 | DIAMETER_ERROR_RAT_TYPE_NOT_ALLOWED (5452)..... | 176 | +| 10.3.9 | DIAMETER_ERROR_LATE_OVERLAPPING_REQUEST (5453)..... | 176 | +| 10.3.10 | DIAMETER_ERROR_TIMED_OUT_REQUEST (5454)..... | 176 | +| 10.3.11 | DIAMETER_ERROR_ILLEGAL_EQUIPMENT (5554)..... | 176 | +| 10.3.12 | DIAMETER_ERROR_TRUSTED_NON_3GPP_ACCESS_NOT_ALLOWED (5455)..... | 176 | + +| | | | +|--------------------------------------------------------------------------------------------|------------------------------------------------------------------|------------| +| 10.3.13 | DIAMETER_ERROR_UNTRUSTED_NON_3GPP_ACCESS_NOT_ALLOWED (5456)..... | 176 | +| 10.4 | Transient Failures..... | 176 | +| 10.4.1 | General..... | 176 | +| 11 | 3GPP AAA Server/Proxy – EIR..... | 176 | +| 11.1 | Functionality..... | 176 | +| 11.1.1 | General..... | 176 | +| 11.1.2 | Procedures Description..... | 177 | +| 11.1.2.1 | ME Identity Check..... | 177 | +| 11.1.2.1.1 | General..... | 177 | +| 11.1.2.1.2 | 3GPP AAA Server Detailed Behaviour..... | 177 | +| 11.1.2.1.3 | 3GPP AAA Proxy Detailed Behaviour..... | 178 | +| 11.1.2.1.4 | EIR Detailed Behaviour..... | 178 | +| 11.2 | Protocol Specification..... | 178 | +| 11.2.1 | General..... | 178 | +| 11.2.2 | Commands..... | 178 | +| 11.2.2.1 | ME Identity Check..... | 178 | +| 11.2.2.1.1 | ME-Identity-Check-Request (ECR) Command..... | 178 | +| 11.2.2.1.2 | ME-Identity-Check-Answer (ECA) Command..... | 178 | +| 11.2.3 | Information Elements..... | 178 | +| 11.2.3.1 | General..... | 178 | +| 11.2.4 | Session Handling..... | 179 | +| Annex A (informative): Trusted WLAN authentication and authorization procedure..... | | 179 | +| A.1 | General..... | 179 | +| A.2 | Call Flow for SCM and EPC-routed access..... | 179 | +| A.2.1 | Successful call flow..... | 179 | +| A.2.2 | Unsuccessful call flow..... | 181 | +| A.2.3 | Call flow with IMEI check in VPLMN..... | 183 | +| A.3 | Call Flow for MCM for EPC-routed access and/or NSWO..... | 184 | +| A.3.1 | Successful call flow..... | 184 | +| A.3.2 | Call flow with IMEI check in VPLMN..... | 185 | +| A.4 | Call Flow for TSCM and EPC-routed access..... | 187 | +| Annex B (normative): Diameter overload control mechanism..... | | 188 | +| B.1 | General..... | 188 | +| B.2 | SWx interface..... | 188 | +| B.2.1 | General..... | 188 | +| B.2.2 | HSS behaviour..... | 188 | +| B.2.3 | 3GPP AAA server behaviour..... | 189 | +| B.3 | STa interface..... | 189 | +| B.3.1 | General..... | 189 | +| B.3.2 | 3GPP AAA server behaviour..... | 189 | +| B.3.3 | Trusted non 3GPP access network behaviour..... | 189 | +| B.4 | S6b interface..... | 189 | +| B.4.1 | General..... | 189 | +| B.4.2 | 3GPP AAA server behaviour..... | 190 | +| B.4.3 | PDN-GW behaviour..... | 190 | +| B.5 | SWa Interface..... | 190 | +| B.5.1 | General..... | 190 | +| B.5.2 | 3GPP AAA server behaviour..... | 190 | +| B.5.3 | untrusted non-3GPP access network behaviour..... | 190 | +| B.6 | SWm Interface..... | 190 | +| B.6.1 | General..... | 190 | + +| | | | +|----------------------------------------------------------------------------------------------|---------------------------------------------------|------------| +| B.6.2 | 3GPP AAA server behaviour..... | 191 | +| B.6.3 | ePDG behaviour..... | 191 | +| Annex C (Informative): Diameter overload control node behaviour..... | | 191 | +| C.1 | Introduction..... | 191 | +| C.2 | Message prioritization over SWx..... | 191 | +| C.3 | Message prioritisation over STa, SWm and SWa..... | 192 | +| C.4 | Message prioritization over S6b..... | 193 | +| Annex D (normative): Diameter message priority mechanism..... | | 194 | +| D.1 | General..... | 194 | +| D.2 | SWa, STa, SWd, SWm, SWx, S6b interfaces..... | 194 | +| Annex E (informative): Untrusted WLAN authentication and authorization procedure..... | | 195 | +| E.1 | General..... | 195 | +| E.2 | Successful call flow..... | 195 | +| E.3 | Call flow with IMEI check in VPLMN..... | 196 | +| Annex F (normative): Diameter load control mechanism..... | | 198 | +| F.1 | General..... | 198 | +| F.2 | SWx interface..... | 198 | +| F.2.1 | General..... | 198 | +| F.2.2 | HSS behaviour..... | 198 | +| F.2.3 | 3GPP AAA server behaviour..... | 198 | +| F.3 | STa interface..... | 198 | +| F.3.1 | General..... | 198 | +| F.3.2 | 3GPP AAA server behaviour..... | 198 | +| F.3.3 | Trusted non 3GPP access network behaviour..... | 199 | +| F.4 | S6b interface..... | 199 | +| F.4.1 | General..... | 199 | +| F.4.2 | 3GPP AAA server behaviour..... | 199 | +| F.4.3 | PDN-GW behaviour..... | 199 | +| F.5 | SWa Interface..... | 199 | +| F.5.1 | General..... | 199 | +| F.5.2 | 3GPP AAA server behaviour..... | 199 | +| F.5.3 | untrusted non-3GPP access network behaviour..... | 200 | +| F.6 | SWm Interface..... | 200 | +| F.6.1 | General..... | 200 | +| F.6.2 | 3GPP AAA server behaviour..... | 200 | +| F.6.3 | ePDG behaviour..... | 200 | +| Annex G (informative): Change history..... | | 200 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## Introduction + +The present specification details the stage 3 work related to all 3GPP AAA reference points used by the different non-3GPP accesses included in EPS. It also details the stage 3 work related to the SWa reference point used for Non-seamless WLAN offload (NSWO) in 5GS. + +# 1 Scope + +The present document defines the stage-3 protocol description for several reference points for the non-3GPP access in EPS: + +- The SWa reference point between an un-trusted non-3GPP IP access and the 3GPP AAA Server/Proxy. +- The STa reference point between a trusted non-3GPP IP access and the 3GPP AAA Server/Proxy. +- The SWd reference point between the 3GPP AAA Proxy and 3GPP AAA Server. +- The SWx reference point between the 3GPP AAA Server and the HSS. +- The S6b reference point between the 3GPP AAA Server/Proxy and the PDN GW. +- The SWm reference point between the 3GPP AAA Server/Proxy and the ePDG. +- The reference point between the 3GPP AAA Server/Proxy and the EIR. + +The present document also defines the stage 3 protocol description for the following reference points defined for Non-seamless WLAN offload in 5GS: + +- the SWa' reference point between a non-3GPP WLAN access, possibly via a 3GPP AAA Proxy, and the NSWO NF; and +- the SWd' reference point between the 3GPP AAA Proxy, possibly via an intermediate 3GPP AAA Proxy, and the NSWO NF. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] IETF RFC 5779: "Diameter Proxy Mobile IPv6: Mobility Access Gateway and Local Mobility Anchor Interaction with Diameter Server ". +- [3] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [4] IETF RFC 4005: "Diameter Network Access Server Application" +- [5] IETF RFC 4072: "Diameter Extensible Authentication Protocol (EAP) Application" +- [6] IETF RFC 5447 "Diameter Mobile IPv6: Support for Network Access Server to Diameter Server Interaction". +- [7] Void. +- [8] IETF RFC 3748: "Extensible Authentication Protocol (EAP)". +- [9] IETF RFC 5777: "Traffic Classification and Quality of Service (QoS) Attributes for Diameter". +- [10] Void + +- [11] IETF RFC 5778: "Diameter Mobile IPv6: Support for Home Agent to Diameter Server Interaction". +- [12] Void +- [13] 3GPP TS 24.303: "Mobility management based on Dual-Stack Mobile IPv6; Stage 3". +- [14] 3GPP TS 23.003: "Numbering, addressing and identification". +- [15] IETF RFC 4282: "The Network Access Identifier". +- [16] 3GPP TS 33.203: "3G security; Access security for IP-based services". +- [17] 3GPP TS 29.230: "Diameter applications; 3GPP specific codes and identifiers". +- [18] IETF RFC 4004: "Diameter Mobile IPv4 Application". +- [19] 3GPP TS 33.402: "3GPP System Architecture Evolution (SAE); Security aspects of non-3GPP accesses". +- [20] IETF RFC 4006: "Diameter Credit-Control Application". +- [21] Void. +- [22] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx and Dx Interfaces; Signalling flows and Message Elements". +- [23] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [24] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol; Protocol details". +- [25] 3GPP2 X. S0057-B: "EUTRAN – eHRPD Connectivity and Interworking: Core Network Aspects". +- [26] 3GPP TS 24.302: "Access to the 3GPP Evolved Packet Core (EPC) via non-3GPP access networks". +- [27] IETF RFC 5448: "Improved Extensible Authentication Protocol Method for 3rd Generation Authentication and Key Agreement (EAP-AKA)". +- [28] IETF RFC 6611: "Mobile IPv6 (MIPv6) Bootstrapping for the Integrated Scenario". +- [29] 3GPP TS 29.272: "Evolved Packet System; MME and SGSN Related Interfaces Based on Diameter Protocol". +- [30] 3GPP TS 32.299: "Charging management; Diameter charging applications". +- [31] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [32] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [33] Void. +- [34] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [35] IETF RFC 1035: "Domain Names - Implementation and Specification". +- [36] Void. +- [37] IETF RFC 5729: "Clarifications on the Routing of Diameter Requests Based on the Username and the Realm". +- [38] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [39] 3GPP TS 23.139: "3GPP System-Fixed Broadband Access Network Interworking; Stage 2". + +- [40] IEEE Std 802.11-2012: "IEEE Standard for Information technology - Telecommunications and information exchange between systems - Local and metropolitan area networks - Specific requirements - Part 11: Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications". +- [41] Void. +- [42] Void. +- [43] 3GPP TS 24.139: "3GPP system - fixed broadband access network interworking". +- [44] IETF RFC 4187: "Extensible Authentication Protocol Method for 3rd Generation Authentication and Key Agreement (EAP-AKA)". +- [45] 3GPP TS 23.203: "Policy and Charging Control Architecture". +- [46] IETF RFC 5580: "Carrying Location Objects in RADIUS and Diameter". +- [47] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [48] ETSI TS 283 034: "Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN); Network Attachment Sub-System (NASS); e4 interface based on the DIAMETER protocol". +- [49] 3GPP TS 23.008: "Organization of subscriber data". +- [50] Void +- [51] Void +- [52] 3GPP TS 23.380: "IMS Restoration Procedures". +- [53] IETF RFC 7944: "Diameter Routing Message Priority". +- [54] IETF RFC 8583: "Diameter Load Information Conveyance". +- [55] IETF RFC 6696: "EAP Extensions for the EAP Re-authentication Protocol (ERP)". +- [56] IETF RFC 6734: "Diameter Attribute-Value Pairs for Cryptographic Key Transport". +- [57] IETF RFC 6942: "Diameter Support for the EAP Re-authentication Protocol (ERP)". +- [58] IETF RFC 6733: "Diameter Base Protocol". +- [59] 3GPP TS 23.501: "System Architecture for the 5G System". +- [60] 3GPP TS 33.501: "Security architecture and procedures for 5G system". + +--- + +## 3 Definitions, symbols and abbreviations + +### 3.1 Definitions + +#### 3.1.1 General + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Multi-connection mode (MCM):** see definition in clause 3.1 of 3GPP TS 23.402 [3]. + +**Non-Seamless WLAN offload (NSWO):** Non-Seamless Non-3GPP offload when the access network is WLAN. + +**Single-connection mode (SCM):** see definition in clause 3.1 of 3GPP TS 23.402 [3]. + +**Transparent single-connection mode (TSCM):** see definition in clause 3.1 of 3GPP TS 23.402 [3]. + +**Trusted WLAN Identifier (TWID):** Identifier of a given Trusted WLAN, a combination of, e.g., an SSID and/or an HESSID as defined in IEEE Std 802.11-2012 [40]. + +### 3.1.2 Handling of Information Elements + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the Category "Cat." column. For the correct handling of the Information Elements and their precedence to any included ABNF definition of the command as defined according to their category types, see the description detailed in clause 6 of the 3GPP TS 29.228 [22]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------------|--------------------------------------------| +| AE | Authentication Extension | +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| EIR | Equipment Identity Register | +| EPC | Evolved Packet Core | +| ER | EAP Re-authentication | +| ERP | EAP Re-Authentication Protocol | +| ePDG | Evolved Packet Data Gateway | +| eHRPD | evolved High Rate Packet Data | +| FA | Foreign Agent | +| FACoA | FA Care-of-Address | +| HA | Home Agent | +| HBM | Host Based Mobility | +| HESSID | Homogenous Extended Service Set Identifier | +| HSGW | eHRPD Serving Gateway | +| LMA | Local Mobility Anchor | +| MAG | Mobile Access Gateway | +| MIPv4 | Mobile IP version 4 | +| MN | Mobile Node | +| NBM | Network Based Mobility | +| NAS | Network Access Server | +| NSWO | Non-Seamless WLAN offload | +| NSWOF | Non-Seamless WLAN offload Function | +| PBU | Proxy Binding Update | +| PDN GW | PDN Gateway | +| PGW | PDN Gateway, the abbreviation of PDN GW | +| PMIP/PMIPv6 | Proxy Mobile IP version 6 | +| RRP | MIPv4 Registration Reply | +| RRQ | MIPv4 Registration Request | +| SA | Security Association | +| SGW | Serving Gateway | +| SIPTO | Selected IP Traffic Offload | +| SSID | Service Set Identifier | +| TWAN | Trusted WLAN Access Network | +| WLCP | Wireless LAN Control Plane Protocol | + +--- + +## 4 SWa and SWa' Description + +### 4.1 Functionality + +#### 4.1.1 General + +The SWa reference point is defined between the untrusted non-3GPP IP access and the 3GPP AAA Server or Proxy in EPS. The definition of the reference point and its functionality is given in 3GPP TS 23.402 [3]. + +The SWa reference point is optionally used to authenticate and authorize the UE for the access to the EPS. It is up to the non-3GPP operator's policy whether this interface and the procedures defined in this clause are used. + +NOTE: From the EPS operator's view, the tunnel authentication and authorization procedures described in clause 7 (SWm description) and clause 9 are required to ensure the user's authentication and authorization when the UE is attached to an untrusted non-3GPP IP access. + +The same procedures as defined for STa reference points are used also in the SWa, but with reduced message content. As an exception, the service authorization information update procedure is not applicable for the SWa reference point. + +The SWa' reference point is defined between the non-3GPP WLAN access, possibly via a 3GPP AAA Proxy, and the NSWOF in 5GS. The definition of the reference point and its functionality is given in clause 4.2.15 of 3GPP TS 23.501 [59] and Annex S of 3GPP TS 33.501 [60]. It reuses the same stage 3 protocol definition as defined for SWa in EPC, with specific requirements for NSWO in 5GS specified in clause 4.1.2.5. + +#### 4.1.2 Procedure Descriptions + +##### 4.1.2.1 SWa Authentication and Authorization procedure + +###### 4.1.2.1.1 General + +This procedure follows the STa Authentication and Authorization procedure, with the following differences: + +- Information elements that would reflect information about the user's service request and about the access network are not included or are optional in the authentication and authorization request. +- The information elements that describe the user's subscription profile are not downloaded to the non-3GPP access network. + +NOTE: The information elements related to the IP Mobility Mode Selection function are not supported over this interface. + +**Table 4.1.2.1/1: SWa Authentication and Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|---------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in the IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP payload | EAP-payload | M | This IE shall contain the Encapsulated EAP payload used for the UE – 3GPP AAA Server mutual authentication | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the user is to be authenticated only, authorized only or both. AUTHORIZE_AUTHENTICATE shall be used in this case. | +| UE Layer-2 address | Calling-Station-ID | M | This IE shall carry the Layer-2 address of the UE. | +| Access Type | RAT-Type | C | If present, this IE shall contain the untrusted non-3GPP access network technology type that is serving the UE. | +| Access Network Identity | ANID | O | If present, this IE shall contain the access network identifier used for key derivation at the HSS. (See 3GPP TS 24.302 [26] for all possible values)
It shall be included if the non-3GPP access network selects the EAP-AKA' authentication method. | +| Full Name for Network | Full-Network-Name | O | If present, this IE shall contain the full name for network as specified in 3GPP TS 24.302 [26]. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network | +| Short Name for Network | Short-Network-Name | O | If present, this IE shall contain the short name for network as specified in 3GPP TS 24.302 [26]. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network | +| Transport Access Type | Transport-Access-Type | C | For interworking with Fixed Broadband access networks (see 3GPP TS 23.139 [39]), if the access network needs to receive the IMSI of the UE in the authentication response, then this information element shall be present, and it shall contain the value "BBF" (see clause 5.2.3.19). | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| AAA Failure Indication | AAA-Failure-Indication | O | If present, this information element shall indicate that the request is sent after the non-3GPP access network has determined that a previously assigned 3GPP AAA Server is unavailable. | +| WLAN Location Information | Access-Network-Info | O | If present, this IE shall contain the location information of the WLAN Access Network where the UE is attached. | +| WLAN Location Timestamp | User-Location-Info-Time | O | This IE may be present if the WLAN Location Information IE is present.
When present, this IE shall contain the NTP time at which the UE was last known to be in the location reported in the WLAN Location Information. | +| High Priority Access Info | High-Priority-Access-Info | C | This information element shall be sent to the 3GPP AAA Server if the UE has access priority as described in 3GPP TS 24.302 [26]. | + +**Table 4.1.2.1/2: SWa Authentication and Authorization Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP payload | EAP payload | M | This IE shall contain the Encapsulated EAP payload used for UE-3GPP AAA Server mutual authentication. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result code | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. Result codes are as in Diameter base protocol (see IETF RFC 6733 [58]). Experimental-Result AVP shall be used for SWa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Session Alive Time | Session-Timeout | O | This AVP may be present if the Result-Code AVP is set to DIAMETER_SUCCESS. If present, it shall contain the maximum number of seconds the user session is allowed to remain active. | +| Accounting Interim Interval | Accounting Interim-Interval | O | If present, this IE shall contain the Charging duration | +| Pairwise Master Key | EAP-Master-Session-Key | C | This IE shall be present if the Result-Code AVP is set to DIAMETER_SUCCESS. | +| 3GPP AAA Server URI | Redirect-Host | C | This information element shall be present if the Result-Code value is set to DIAMETER_REDIRECT_INDICATION. When the user has previously been authenticated by another 3GPP AAA Server, it shall contain the Diameter URI of the 3GPP AAA Server currently serving the user. The node receiving this IE shall behave as defined in the Diameter base protocol (see IETF RFC 6733 [58]). The command shall contain zero or more occurrences of this information element. When choosing a destination for the redirected message from multiple Redirect-Host AVPs, the receiver shall send the Diameter request to the first 3GPP AAA Server in the ordered list received in the Diameter response. If no successful response to the Diameter request is received, the receiver shall send the Diameter request to the next 3GPP AAA Server in the ordered list. This procedure shall be repeated until a successful response is received from a 3GPP AAA Server. | +| Trust Relationship Indicator | AN-Trusted | M | This AVP shall contain the 3GPP AAA Server's decision on handling the non-3GPP access network, i.e. trusted or untrusted. For the SWa case, the value "UNTRUSTED" shall be used. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| Permanent User Identity | Mobile-Node-Identifier | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS and if the Transport Access Type in the request command indicated that the UE is accessing the EPC from a Fixed Broadband access network (i.e., the Transport-Access-Type AVP takes the value "BBF"); it shall contain an AAA/HSS assigned permanent user identity (i.e. an IMSI in root NAI format as defined in clause 19 of 3GPP TS 23.003 [14]) to be used by the non-3GPP access network in subsequent PCC procedure for identifying the user in the EPS network. This IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| MPS Priority | MPS-Priority | C | This information element shall be sent to the non-3GPP WLAN access if the UE has an MPS subscription in the HSS. | + +#### 4.1.2.1.2 3GPP AAA Server Detailed Behaviour + +The detailed behaviour of the 3GPP AAA Server follows the behaviour defined for the STa Authentication and Authorization procedure (refer to clause 5.1.2.1.2), with the following deviations: + +- The 3GPP AAA Server shall handle the non-3GPP access network as untrusted. +- The 3GPP AAA Server marks the trust relationship as "untrusted" with the User Identity. +- The authentication method shall be selected based on the presence of the Access Network Identity as specified in 3GPP TS 33.402 [19]: if this information element is present, the EAP-AKA' method as specified in IETF RFC 5448 [27] is used; otherwise, the EAP-AKA method as specified in IETF RFC 4187 [44] is used. + +When a WLAN Access Network provides WLAN Location Information to the 3GPP AAA Server that it considers as network provided location, the 3GPP AAA Server should store this information for the duration of the WLAN session of the UE, along with the WLAN Location Timestamp if received from the WLAN Access Network, or with the timestamp at which the WLAN Location Information is received from the WLAN Access Network, and provide it to the ePDG during a subsequent Authentication and Authorization procedure or Authorization procedure over the SWm reference point (see clauses 7.1.2.1.2 and 7.1.2.2.2). + +The 3GPP AAA Server shall delete any stored WLAN Location Information and WLAN Location Timestamp associated with the UE when a WLAN Access Network provides WLAN Location Information to the 3GPP AAA Server that it does not consider as network provided location. + +NOTE: It is up to local 3GPP AAA Server policies to decide whether the location information received from the WLAN access network can be considered as network provided location. + +Based on operator policy, the 3GPP AAA Server shall include the MPS-Priority AVP with the MPS-EPS-Priority bit set in the SWa Authentication and Authorization Answer message if the 3GPP AAA Server has received an MPS-Priority AVP with the MPS-EPS-Priority bit set from the HSS. The 3GPP AAA Server shall treat the message and all subsequent messages (if authentication is successful) for the UE with priority as specified in Annex C and Annex D. The 3GPP AAA Server shall discontinue priority treatment for the UE if the 3GPP AAA Server receives a Non-3GPP-User-Data AVP without an MPS-Priority AVP with the MPS-EPS-Priority bit set and the DER request received from the ePDG did not contain a High-Priority-Access-Info AVP with the HPA\_Configured bit set. + +#### 4.1.2.1.3 3GPP AAA Proxy Detailed Behaviour + +The detailed behaviour of the 3GPP AAA Proxy follows the behaviour defined for the STa Authentication and Authorization procedure (refer to clause 5.1.2.1.3), with the following exception: + +- The 3GPP AAA Proxy shall insert or overwrite Visited-Network-Identifier AVP before forwarding the request to the 3GPP AAA Server. + +NOTE: If the untrusted WLAN is operated by the VPLMN's equivalent PLMN, the 3GPP AAA proxy can receive the Visited-Network-Identifier AVP from the Authentication and Authorization Request message. + +- The 3GPP AAA Proxy shall handle the non-3GPP access network as untrusted and marks the trust relationship as "untrusted". + +On receipt of the authentication and authorization answer that completes a successful authentication, the 3GPP AAA Proxy shall record the authentication state of the user. + +#### 4.1.2.2 SWa HSS/AAA Initiated Detach + +This procedure equals with the STa HSS/AAA Initiated Detach procedure, refer to clause 5.1.2.2. + +The 3GPP AAA Server shall delete any stored WLAN Location Information and WLAN Location Timestamp associated with the UE when it becomes aware that the WLAN session of the UE is terminated. + +#### 4.1.2.3 SWa Non-3GPP Access Network Initiated Detach + +This procedure equals with the STa Non-3GPP Access Network Initiated Detach procedure, refer to clause 5.1.2.4. + +The 3GPP AAA Server shall delete any stored WLAN Location Information and WLAN Location Timestamp associated with the UE when it becomes aware that the WLAN session of the UE is terminated. + +#### 4.1.2.4 SWa Re-Authentication and Re-Authorization Procedure + +##### 4.1.2.4.1 General + +This procedure is optional and it may be invoked by the 3GPP AAA Server, if the operator policies require that the re-authentication of the user for the SWa is to be renewed and the untrusted non-3GPP access network supports the re-authentication. + +This procedure shall be performed in two steps: + +- The 3GPP AAA server shall issue an unsolicited re-auth request towards the untrusted non-3GPP access, indicating that both re-authentication and re-authorization of the user is needed. Upon receipt of such a request, the untrusted non-3GPP access shall respond to the request and shall indicate the disposition of the request. This procedure is mapped to the Diameter command codes Re-Auth-Request and Re-Auth-Answer specified in IETF RFC 6733 [58]. Information element contents for these messages shall be as shown in tables 4.1.2.4.1/1 and 4.1.2.4.1/2. +- Upon receiving the re-auth request, the untrusted non-3GPP access shall immediately invoke the SWa authentication and authorization procedure requesting the identity of the user via EAP and using DER/DEA commands, with the same session-ID but the content adapted to the needs of a re-authentication. Information element contents for these messages shall be as shown in tables 4.1.2.4.1/3 and 4.1.2.4.1/4. + +If the re-authentication of the user is not successful, the untrusted non-3GPP access shall detach the user. + +**Table 4.1.2.4.1/1: SWa Re-auth request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15], and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Re-Auth Request Type | Re-Auth-Request-Type | M | This information element shall define whether the user is to be authorized only or authenticated and authorized. AUTHORIZE_AUTHENTICATE shall be used in this case. | +| Routing Information | Destination-Host | M | This information element shall be obtained from the Origin-Host AVP, which was included in a previous command received from the untrusted non-3GPP access. | + +**Table 4.1.2.4.1/2: SWa Re-auth response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter Base Protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for SWa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP and the error code in the Experimental-Result-Code AVP. | + +**Table 4.1.2.4.1/3: SWa Authentication and Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|-------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP payload | EAP-payload | M | This IE shall contain the Encapsulated EAP payload used for the UE – 3GPP AAA Server mutual authentication. | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the user is to be authenticated only, authorized only or both. AUTHORIZE_AUTHENTICATE shall be used in this case. | + +**Table 4.1.2.4.1/4: SWa Authentication and Authorization Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|-----------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP payload | EAP payload | O | If present, this IE shall contain the Encapsulated EAP payload used for UE- 3GPP AAA Server mutual authentication. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result code | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. Result codes are defined in the Diameter base protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for SWa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Session Alive Time | Session-Timeout | O | If present, this IE shall contain the maximum number of seconds the user session should remain active. | +| Accounting Interim Interval | Accounting Interim-Interval | O | If present, this IE shall contain the Charging duration. | +| Pairwise Master Key | EAP-Master-Session-Key | C | This IE shall be sent if Result-Code AVP is set to DIAMETER_SUCCESS. | + +#### 4.1.2.4.2 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA Server shall trigger this procedure according to the local policies configured by the operator. + +The 3GPP AAA Server shall use the same authentication method that was used during the full authentication executed at the UE's attach. If EAP-AKA' is used, the 3GPP AAA Server shall use the ANID parameter received during the authentication and authorization executed at the UE attach (refer to clause 4.1.2.1.1). + +#### 4.1.2.4.3 3GPP AAA Proxy Detailed Behaviour + +The detailed behaviour of the 3GPP AAA Proxy follows the behaviour defined for the STA Re-Authorization and Re-Authentication Procedures (refer to clause 5.1.2.3.3), with the following addition: + +- When forwarding the authorization answer or the authentication and authorization answer, the 3GPP AAA Proxy shall record the authentication state of the user. + +#### 4.1.2.5 SWa procedures for NSWO in 5GS + +The SWa' interface between the non-3GPP WLAN access, possibly via a 3GPP AAA Proxy, and the NSWOF shall use the same stage 3 protocol definition as for the SWa interface in EPS, with the following modifications: + +- SWa' Authentication and Authorization procedure: + +- The User Identity IE in the SWa' Authentication and Authorization Request and in the SWa' Authentication and Authorization Response shall contain the SUCI in NAI form as defined in clause 28.7.3 of 3GPP TS 23.003 [14]. In NSWO roaming scenario with a 3GPP AAA Proxy in the VPLMN (see clause 4.2.15 of 3GPP TS 23.501 [59]), the SUCI in NAI form shall be decorated as defined in clause 28.7.9 of 3GPP TS 23.003 [14] to enable the routing of SWa' signalling towards the 3GPP AAA Proxy in the VPLMN selected by the UE. + +NOTE 1: This IE does not contain any leading digit to differentiate between authentication schemes. + +NOTE 2: The realm in the SUCI in NAI form (starting by the first label "5gc-nswo") enables to route the signaling towards an NSWOF, as opposed to sending it to a 3GPP AAA Server, if the non-3GPP WLAN access also supports SWa signaling with a 3GPP AAA Server e.g. for a 4G subscriber. + +- EAP-AKA' as specified in RFC 5448 [27] shall be used as the authentication method. +- The NSWOF shall behave as specified in Annex S of 3GPP TS 33.501 [60]. The NSWOF shall send the MSK received from the AUSF in the Pairwise Master Key IE in the SWa' Authentication and Authorization Answer. +- The SWa HSS/AAA Initiated Detach, SWa Non-3GPP Access Network Initiated Detach and SWa Re-authentication and Re-Authorization are not supported. + +## 4.2 Protocol Specification + +### 4.2.1 General + +The SWa reference point shall use the same Diameter application as the STa reference point. The first authentication command exchange (DER/DEA) is common between the SWa and STa reference points. During this initial exchange, the 3GPP AAA Server determines the HPLMN's trust relationship with the non-3GPP access network and communicates it to the non-3GPP access network and the UE as described in clause 5.1.2.1.2. The contents of the subsequent commands are dependent on this trust relationship determination and are specific to the SWa or STa reference points. + +### 4.2.2 Commands + +#### 4.2.2.1 Commands for SWa authentication and authorization procedures + +##### 4.2.2.1.1 Diameter-EAP-Request (DER) Command + +The Diameter-EAP-Request (DER) command, indicated by the Command-Code field set to 268 and the 'R' bit set in the Command Flags field, is sent from a trusted non-3GPP access network to a 3GPP AAA Server. + +``` +< Diameter-EAP-Request > ::= < Diameter Header: 268, REQ, PXY > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + { EAP-Payload } + [ User-Name ] + [ Calling-Station-Id ] + [ RAT-Type ] + ... + [ ANID ] + [ Full-Network-Name ] + [ Short-Network-Name ] + *[ Supported-Features ] + [ AAA-Failure-Indication ] +``` + +``` + +[ Transport-Access-Type ] +[ OC-Supported-Features ] +[ Access-Network-Info ] +[ User-Location-Info-Time ] +[ High-Priority-Access-Info ] +... +*[ AVP ] + +``` + +#### 4.2.2.1.2 Diameter-EAP-Answer (DEA) Command + +The Diameter-EAP-Answer (DEA) command, indicated by the Command-Code field set to 268 and the 'R' bit cleared in the Command Flags field, is sent from a 3GPP AAA Server to a trusted non-3GPP access network NAS. + +``` + +< Diameter-EAP-Answer > ::= < Diameter Header: 268, PXY > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Result-Code } + [ Experimental-Result ] + { Origin-Host } + { Origin-Realm } + { Auth-Request-Type } + [ EAP-Payload ] + [ User-Name ] + [ Session-Timeout ] + [ Accounting-Interim-Interval ] + [ EAP-Master-Session-Key ] + *[ Redirect-Host ] + [ AN-Trusted ] + *[ Supported-Features ] + [Mobile-Node-Identifier] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + [ MPS-Priority ] + ... + *[ AVP ] + +``` + +#### 4.2.2.2 Commands for SWa HSS/AAA Initiated Detach + +Refer to clause 5.2.2.2. + +#### 4.2.2.3 Commands for Untrusted non-3GPP Access network Initiated Session Termination + +Refer to clause 5.2.2.4. + +#### 4.2.2.4 Commands for SWa Re-Authentication and Re-Authorization Procedures + +##### 4.2.2.4.1 Re-Auth-Request (RAR) Command + +The Diameter Re-Auth-Request (RAR) command, indicated by the Command-Code field set to 258 and the "R" bit set in the Command Flags field, shall be sent from a 3GPP AAA server to an untrusted non-3GPP access network NAS. ABNF for the RAR command shall be as follows: + +``` + +< Re-Auth-Request > ::= < Diameter Header: 258, REQ, PXY, 16777250 > + < Session-Id > + +``` + +``` + +[ DRMP ] +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +{ Destination-Host } +{ Auth-Application-Id } +{ Re-Auth-Request-Type } +[ User-Name ] +... +*[ AVP ] + +``` + +#### 4.2.2.4.2 Re-Auth-Answer (RAA) Command + +The Diameter Re-Auth-Answer (RAA) command, indicated by the Command-Code field set to 258 and the "R" bit cleared in the Command Flags field, shall be sent from an untrusted non-3GPP access network NAS to a 3GPP AAA server. ABNF for the RAA command shall be as follows: + +``` + +< Re-Auth-Answer > ::= < Diameter Header: 258, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + ... + *[ AVP ] + +``` + +#### 4.2.2.4.3 Diameter-EAP-Request (DER) Command + +Refer to clause 4.2.2.1.1. + +#### 4.2.2.4.4 Diameter-EAP-Answer (DEA) Command + +Refer to clause 4.2.2.1.2 + +### 4.2.3 Information Elements + +The information elements of SWa are the same as the IEs defined for the STa interface described in the clause 5.2.3. + +### 4.2.4 Session Handling + +The session handling for the SWa interface is the same as the STa session handling described in the clause 5.2.4. + +## 5 STa Description + +### 5.1 Functionality + +#### 5.1.1 General + +The STa reference point is defined between a non-3GPP access network and the 3GPP AAA Server or between a non-3GPP access network and the 3GPP AAA Proxy. The definition of the reference point and its functionality is given in 3GPP TS 23.402 [3]. + +Whether a Non-3GPP access network is Trusted or Untrusted is not a characteristic of the access network; this decision shall be made during the access authentication and authorization procedure executed between the non-3GPP access network and the 3GPP AAA Server. This is implemented by the STa and SWa reference points sharing the same Diameter application and partly sharing the same authentication and authorization procedure. The STa and SWa reference points are clearly distinguished after the exchange of the first authentication and authorization messages, + +during which trusted/untrusted decision is made by the 3GPP AAA server and this decision is communicated to the non-3GPP access network. The other procedures are specific to the STa and SWa reference points. + +The STa reference point shall be used to authenticate and authorize the UE. + +The STa reference point may also be used to transport PMIPv6, GTPv2, or MIPv4 FA-CoA mode related mobility parameters in a case the UE attaches to the EPC using the S2a reference point. The procedures specified for EPC access via GTP based S2a are only applicable to trusted WLAN access networks (see clause 16 of 3GPP TS 23.402 [3]). + +Additionally the STa reference point may also be used to transport DSMIPv6 related mobility parameters in case the UE attaches to the EPC using the S2c reference point. In particular, in this case the STa reference point may be used for conveying the Home Agent IP address or FQDN from the AAA server to the gateway of the trusted non-3GPP access for Home Agent discovery based on DHCPv6 (see TS 24.303 [13]). + +This reference point shall be also used to transport charging-related information and optionally information about IP Mobility Mode Selection. + +## 5.1.2 Procedures Description + +### 5.1.2.1 STa Access Authentication and Authorization + +#### 5.1.2.1.1 General + +These procedures are transported over Diameter, the Access (Re-)Authentication and Authorization between the trusted non-3GPP access network and the 3GPP AAA Proxy or Server. The STa interface and Diameter application shall be used for authenticating and authorizing the UE for EPC access in PMIPv6, GTPv2, MIPv4 FA-CoA mode or for TWAN access without EPC S2a access (i.e. non-seamless WLAN offload) via trusted non-3GPP accesses and non-3GPP accesses that are decided to be untrusted during the authentication and authorization procedure. + +When EAP-AKA' is used in the STa access authentication and either EPC access in NBM (PMIPv6 or GTPv2) or TWAN access without EPC S2a access (i.e. non-seamless WLAN offload) is used, the trusted non-3GPP access network shall support also the role of the NAS. Specifically, in the case where PMIPv6 is used, the network element of the non-3GPP access network acting as a MAG shall have also the role of the NAS. During the STa access authentication the NAS shall serve as pass-through EAP authenticator. + +Diameter usage over the STa interface: + +- When EAP is used, the trusted non-3GPP access authentication and authorization procedure shall be mapped to the Diameter-EAP-Request and Diameter-EAP-Answer command codes specified in IETF RFC 4072 [5]. +- For (re)authentication procedures, the messaging described below shall be reused. + +During the STa Access Authentication and Authorization procedure the non-3GPP access network may provide information on its PMIPv6 or GTPv2 capabilities to the 3GPP AAA Server. + +During the STa Access Authentication and Authorization procedure the trusted non-3GPP access network shall provide information on the Access Network Identity (ANID) to the 3GPP AAA Server. Specifically, the TWAN shall set the Access Network Identity as specified in clause 8.1.1.2 of 3GPP TS 24.302 [26] for a WLAN access network. + +For a trusted non-3GPP access, the 3GPP AAA Server may perform IP mobility mode selection between NBM and HBM. The 3GPP AAA Server may provide to the trusted non-3GPP access network an indication if either NBM or local IP address assignment (for HBM) shall be used. + +For a trusted WLAN access, + +- the TWAN should send information on whether it supports TSCM, SCM or MCM or any combination of them to the 3GPP AAA Server as specified in 3GPP TS 23.402 [63]. If it indicates support of the MCM, the TWAN shall also provide the 3GPP AAA Server with the TWAG's control plane IPv4 address, or IPv6 address or both (if it supports both IPv4 and IPv6), to be sent to the UE and used for WLCP if the MCM is selected. +- if the user is successfully authenticated and authorized for this access, the 3GPP AAA Server: + +- shall select either TSCM, SCM or MCM and indicate to the TWAN the selected mode of operation. If the 3GPP AAA Server does not provide such an indication, the TSCM shall be used; +- may either only authorize the user to access to EPC via S2a (i.e. EPC-routed service only), or only authorize the user to access the TWAN without granting access to EPC via S2a (i.e. non-seamless WLAN offload service only), or authorize both EPC-routed and non-seamless WLAN offload services. If the SCM is selected, the 3GPP AAA Server shall indicate to the TWAN its decision to either authorize access to EPC via S2a or only authorize the user to access the TWAN without granting access to EPC via S2a, i.e. not both; +- when authorizing the SCM to be used for EPC access, the 3GPP AAA server shall forward the PDN connectivity parameters received from the UE to the TWAN, i.e. the UE requested PDN type (IPv4, IPv6 or IPv4v6), the attach type (initial attach or handover), optionally the requested APN (if received from the UE) and optionally the Protocol Configuration Options (if received from the UE); +- when authorizing the MCM for EPC access, the 3GPP AAA server shall derive the WLCP key as defined in 3GPP TS 33.402 [19] and shall provide the WLCP key to the TWAN to protect the WLCP signalling. + +if the user is successfully authenticated and authorized for this access, the TWAN: + +- shall decide the S2a protocol variant to use if access to EPC is authorized and the TWAN decides to establish S2a. +- if the SCM has been authorized to be used for EPC access, the TWAN shall return an indication to the 3GPP AAA Server on whether the requested connectivity has been granted and, if so, also pass on to the 3GPP AAA Server the connectivity parameters to be provided to the UE, i.e. the selected APN, the selected PDN type (IPv4, IPv6 or IPv4v6), the IPv4 address (for PDN type IPv4 or IPv4v6), the IPv6 interface identifier (for PDN type IPv6 or IPv4v6), optionally the Protocol Configuration Options received from the PDN GW once S2a has been established, and the TWAG user plane MAC address. If the requested connectivity has not been granted, the TWAN should provide the 3GPP AAA Server with a cause indicating why the requested connectivity could not be granted; the TWAN may also provide a Session Management back-off timer to be sent to the UE to instruct the UE to not request new PDN connectivity to the same APN for the indicated time. + +When authorizing NBM to be used, the 3GPP AAA server shall return NBM related information back to the trusted non-3GPP access network. + +During the STa Access Authentication and Authorization procedure, when DSMIPv6 is used, the 3GPP AAA Server may provide a Home Agent IPv6 address (and optionally IPv4 address) or FQDN to the trusted non-3GPP access network. This is needed if the DHCPv6 option for Home Agent address discovery is chosen (see TS 24.303 [13] and IETF RFC 6611 [28]). If the Home Agent IPv6 address or FQDN is not included in the final Authentication and Authorization Answer by the 3GPP AAA server, the trusted non-3GPP access network shall not assign the Home Agent via DHCPv6. + +During the STa Access Authentication and Authorization procedure for MIPv4 FA-CoA mode using trusted non-3GPP access, the 3GPP AAA Server may provide the mobility security parameters FA-RK and FA-RK-SPI to the trusted non-3GPP access network. + +The User-Name AVP may contain a decorated NAI (as defined in clause 19.3.3 of 3GPP TS 23.003 [14]). In this case the 3GPP AAA Proxy shall process the decorated NAI and support routing of the Diameter request messages based on the decorated NAI as described in IETF RFC 5729 [37]. + +Based on local policies, EPC access for emergency services over a trusted non-3GPP access is supported as specified in clause 4.5.7.2.1 of 3GPP TS 23.402 [3] for: + +- UEs with a valid EPC subscription that are authenticated and authorized for EPC services; +- UEs that are authenticated only; +- UEs with an unauthenticated IMSI; and/or +- UICC-less UEs. + +For PMIPv6, GTPv2 and MIPv4 FA-CoA mode trusted non-3GPP accesses, upon mobility between 3GPP and non-3GPP accesses, for the PDNs the UE is already connected, the PDN GW identity for each of the already allocated PDN GW(s) with the corresponding PDN information is provided to the trusted non-3GPP system. The PDN GW + +identity is a FQDN and/or IP address of the PDN GW. The non-3GPP access network shall use the received PDN GW identity for mobility with IP address preservation or in case of static PDN GW assignment. If a FQDN is provided, the trusted non-3GPP system shall then derive it to IP address according to the selected mobility management protocol. + +NOTE: Mobility with IP address preservation is not supported between TWAN and 3GPP access in TSCM. + +During the STa Access Authentication and Authorization procedure, the bootstrapping of an ER server in the TWAN with a given root key may be performed, as described in IETF RFC 6696 [55] and 3GPP TS 33.402 [19]. This procedure is used to provide an ER server with the keying material that will be used for further EAP re-authentication procedures using ERP. + +**Table 5.1.2.1/1: STa Access Authentication and Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|----------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes, if it contains a NAI other than an Emergency NAI for Limited Service State. | +| EAP payload | EAP-payload | M | This IE shall contain the Encapsulated EAP payload used for the UE – 3GPP AAA Server mutual authentication | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the user is to be authenticated only, authorized only or both. AUTHORIZE_AUTHENTICATE shall be used in this case. | +| UE Layer-2 address | Calling-Station-ID | M | This IE shall contain the Layer-2 address of the UE. | +| Supported 3GPP QoS profile | QoS-Capability | O | If the non-3GPP access network supports QoS mechanisms, this information element may be included to contain the access network's QoS capabilities as defined in IETF RFC 5777 [9]. | +| Mobility Capabilities | MIP6-Feature-Vector | C |

This information element shall contain the mobility capabilities of the non-3GPP access network. This information shall be utilized if dynamic mobility mode selection is executed. This information may also be used to decide whether to authorize access to EPC to a user accessing a TWAN.

The PMIP6_SUPPORTED flag and/or the GTPv2 SUPPORTED flag shall be set if the non-3GPP access supports PMIPv6 and/or GTPv2. PMIP6_SUPPORTED flag is defined in IETF RFC 5779 [2].

The flag MIP6_INTEGRATED shall be set if DHCPv6 based Home Agent address discovery is supported as defined in IETF RFC 5447 [6].

The MIP4_SUPPORTED flag shall be set if the non-3GPP access supports MIPv4 FA-CoA mode.

| +| Access Type | RAT-Type | M |

This IE shall contain the non-3GPP access network technology type that is serving the UE.

The TWAN shall set the Access Type value to "WLAN".

| +| Access Network Identity | ANID | M | This IE shall contain the access network identifier used for key derivation at the HSS. (See 3GPP TS 24.302 [26] for all possible values) | +| Full Name for Network | Full-Network-Name | O | If present, this IE shall contain the full name for network as specified in 3GPP TS 24.302 [26]. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network. If the Visited Network Identifier is present, this AVP shall be set. | +| Short Name for Network | Short-Network-Name | O | If present, this IE shall contain the short name for network as specified in 3GPP TS 24.302 [26]. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network. If the Visited Network Identifier is present, this AVP shall be set. | +| Visited Network Identifier | Visited-Network-Identifier | O | If present, this IE shall contain the Identifier that allows the home network to identify the Visited Network. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network. | +| APN Id | Service-Selection | O | If present, this information element shall contain the Network Identifier part of the APN the user wants to connect to (if available). | +| Terminal Information | Terminal-Information | O | If present, this information element shall contain information about the user's mobile equipment. The type of identity carried depends on the access technology type. For an HRPD access network, the 3GPP2-MEID AVP shall be included in this grouped AVP. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | + +| | | | | +|-----------------------------------------------|------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Selected Trusted WLAN Identifier | WLAN-Identifier | O | If present, this IE shall contain the WLAN Identifier selected by the UE to access the Trusted WLAN Access Network (see clause 16 of 3GPP TS 23.402 [3]). | +| AAA Failure Indication | AAA-Failure-Indication | O | If present, this information element shall indicate that the request is sent after the non-3GPP access network has determined that a previously assigned 3GPP AAA Server is unavailable. | +| DER Flags | DER-Flags | O | This Information Element contains a bit mask. See 5.2.3.20 for the meaning of the bits. | +| Transport Access Type | Transport-Access-Type | C | For interworking with Fixed Broadband access networks (see 3GPP TS 23.139 [39]), if the access network needs to receive the IMSI of the UE in the authentication response, then this information element shall be present, and it shall contain the value "BBF" (see clause 5.2.3.19). | +| Supported TWAN Connection Modes | TWAN-Connection-Mode | O | The TWAN should include this IE.
If present, this information element shall contain the TWAN connection modes supported by the TWAN, i.e. TSCM, SCM and/or MCM. | +| Provided Connectivity Parameters | TWAN-Connectivity-Parameters | C | This information element shall be present if the 3GPP AAA Server has previously authorized the SCM to be used for EPC access.

TWAN-Connectivity-Parameters is a grouped AVP.

If the requested connectivity has been granted, the following information elements shall be included:
- selected APN
- selected PDN type
- UE IPv4 Address (for PDN type IPv4 or IPv4v6)
- UE IPv6 Interface Identifier (for PDN type IPv6 or IPv4v6)
- Protocol Configuration Options (if received from the PGW)
- TWAG user plane MAC address

The absence of both an IPv4 address and an IPv6 Interface Identifier indicates that the requested connectivity could not be granted. If the requested connectivity has not been granted, the following information elements may be included:
- a cause indicating why the requested connectivity has not been granted
- a Session Management back-off timer to be sent to the UE | +| TWAG Control Plane IP Address | TWAG-CP-Address | C | The TWAN shall include this IE if it indicates support of the MCM in the Supported TWAN Connection Modes IE. When present, this IE shall contain the TWAG Control Plane IPv4 Address, or the TWAG Control Plane IPv6 link local address, or both (if the TWAG supports IPv4 and IPv6), to be used for WLCP by the UE if the MCM is used. | +| IMEI Check in VPLMN Result | IMEI-Check-In-VPLMN-Result | C | The 3GPP AAA Proxy shall include this IE if it has performed an IMEI check in the VPLMN. When present, this IE shall contain the result of the IMEI check. | +| Domain-Specific Re-authentication Key Request | ERP-RK-Request | O | If present, this IE indicates the willingness of an ER server located in the non-3GPP access network to act as the ER server for this session.

When present, this IE shall contain the name of the realm in which the ER server is located. | +| High Priority Access Info | High-Priority-Access-Info | C | Based on operator policy, this information element shall be sent to the 3GPP AAA Server if the UE has access priority conveyed in an EAP response/identity message as described in 3GPP TS 24.302 [26]. | + +**Table 5.1.2.1/2: Trusted non-3GPP Access Authentication and Authorization Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|----------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes, if it contains a NAI other than an Emergency NAI for Limited Service State. | +| EAP payload | EAP payload | O | If present, this IE shall contain the Encapsulated EAP payload used for UE- 3GPP AAA Server mutual authentication. This IE shall not be included if the UE has been authenticated and the 3GPP AAA Server authorizes the SCM for EPC access for the UE and the Result-Code AVP is set to DIAMETER_MULTI_ROUND_AUTH. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result code | Result-Code / Experimental Result Code | M | This IE shall contain the result of the operation. Result codes are as in Diameter base protocol (see IETF RFC 6733 [58]). Experimental-Result AVP shall be used for STa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Session Alive Time | Session-Timeout | O | This AVP may be present if the Result-Code AVP is set to DIAMETER_SUCCESS; if present, it contains the maximum number of seconds the session is allowed to remain active. | +| Accounting Interim Interval | Accounting Interim-Interval | O | If present, this IE shall contain the Charging duration. | +| Pairwise Master Key | EAP-Master-Session-Key | C | This IE shall be present if Result-Code AVP is set to DIAMETER_SUCCESS. | +| Default APN | Context-Identifier | C | This AVP shall indicate the default APN for the user. If the Access Network Identity received in the Authentication and Authorization Request indicates WLAN (see clause 8.1.1.2 of 3GPP TS 24.302 [26]) and if the TSCM is selected, this AVP shall be set to the Default APN for Trusted WLAN if received from the HSS; otherwise this AVP shall be set to the subscriber's Default APN for 3GPP and other non-3GPP accesses. It shall only be included if NBM is authorized for use, the non-3GPP access network was decided to be trusted, the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Answer and the Result-Code AVP is set to either:
- DIAMETER_SUCCESS or
- DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.
(see NOTE 1) | +| APN-OI replacement | APN-OI-Replacement | C | This AVP shall indicate the domain name to replace the APN-OI in the non-roaming case or in the home routed roaming case when constructing the PDN GW FQDN upon which a DNS resolution needs to be performed. See 3GPP TS 23.003 [3]. It shall only be included if NBM is authorized for use, the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Answer and the Result-Code AVP is set to either:
- DIAMETER_SUCCESS or
- DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.
(see NOTE 1) | + +| | | | | +|--------------------|-------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| APN and PGW Data | APN-Configuration | C |

This information element shall only be sent if EPC Access is authorized, the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Answer and the Result-Code AVP is set to either:

  • - DIAMETER_SUCCESS or
  • - DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.

(see NOTE 1)

When NBM is authorized for use, this AVP shall contain the default APN, the list of authorized APNs, including the wildcard APN if configured in the user's subscription, user profile information and PDN GW information.

When local IP address assignment is used (for HBM), this AVP shall only be present if DHCP based Home Agent discovery is used and contain the Home Agent Information for discovery purposes.

The trusted non-3gpp access network knows if NBM is authorized for use or if a local IP address (for HBM) is assigned based on the flags in the MIP6-Feature-Vector.

APN-Configuration is a grouped AVP, defined in 3GPP TS 29.272 [29]. When NBM is authorized for use, the following information elements per APN may be included:

  • - APN
  • - Authorized 3GPP QoS profile
  • - Statically allocated User IP Address (IPv4 and/or IPv6)
  • - Allowed PDN types
  • - PDN GW identity
  • - PDN GW allocation type
  • - VPLMN Dynamic Address Allowed
  • - APN-AMBR
  • - Visited Network Identifier (see clause 5.1.2.1.4)
  • - SIPTO permission

When DSMIPv6 is used, the following information elements per Home Agent may be included:

  • - HA-APN (Home Agent APN as defined in 3GPP TS 23.003 [14])
  • - Authorized 3GPP QoS profile
  • - PDN GW identity

When MIPv4 FACoA is used, the following information elements per APN may be included:

  • - APN
  • - Allowed PDN types
| +| Serving GW Address | MIP6-Agent-Info | O | This AVP shall be used only in chained S2a-S8 cases and it shall be sent only if the Result-Code AVP is set to DIAMETER_SUCCESS. | + +| | | | | +|-----------------------|---------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Mobility Capabilities | MIP6-Feature-Vector | C |

This information element shall only be sent if EPC Access is authorized and if the Result-Code AVP is set to either:

  • - DIAMETER_SUCCESS or
  • - DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.

(see NOTE 1)

It shall contain a AAA/HSS authorized set of mobility capabilities to the trusted non-3GPP access network, if dynamic mobility mode selection between NBM and HBM is done. It shall also be sent when authorizing access to EPC to a user accessing a TWAN.

The PMIP6_SUPPORTED and/or the GTPv2_SUPPORTED shall be set to indicate that NBM (PMIPv6 or GTPv2) is authorized for use.

Otherwise, ASSIGN_LOCAL_IP or MIP4_SUPPORTED flag shall be set by the 3GPP AAA Server to mandate which HBM mobility protocol is used.

The MIP6_INTEGRATED flag shall be set if a Home Agent address is provided for DHCPv6 based Home Agent address discovery. In the latter case HA information for DHCPv6 discovery is provided via the APN-Configuration AVP.

| +|-----------------------|---------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | +|-------------------------|-------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | Mobile-Node-Identifier | C |

This information element shall only be sent if the Result-Code AVP is set to either:

  • - DIAMETER_SUCCESS or
  • - DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.

(see NOTE 1)

This information element shall only be sent if NBM or MIPv4 is authorized for use, or when authorizing the user to access the TWAN without granting access to EPC S2a (i.e. non-seamless WLAN offload).

If the user is authenticated, it shall contain an AAA/HSS assigned permanent user identity (i.e. an IMSI in root NAI format as defined in clause 19 of 3GPP TS 23.003 [14]) to be used:

  • - by the MAG in subsequent PBUs as the MN-ID identifying the user in the EPS network, or
  • - by the trusted non-3GPP access network in subsequent MIPv4 RRQs as the MN-NAI identifying the user in the EPS network, or
  • - by the trusted non-3GPP access network to derive the IMSI to be sent in subsequent Create Session Request on GTP S2a.

For an Emergency Attach, if the UE is UICC-less (i.e. the User Identity IE in the request contains an IMEI) or if the IMSI is not authenticated, the Permanent User Identity shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14].

This information element shall also be sent if HBM is authorized for use, or to access a Fixed Broadband access network without granting access to EPC S2a (i.e. non-seamless WLAN offload), and the Result-Code AVP is set to DIAMETER_SUCCESS and if the Transport Access Type in the request command indicated that the UE is accessing the EPC from a Fixed Broadband access network (i.e., the Transport-Access-Type AVP takes the value "BBF"); it shall contain an AAA/HSS assigned permanent user identity (i.e. an IMSI in root NAI format as defined in clause 19 of 3GPP TS 23.003 [14]) to be used:

  • - by the trusted non-3GPP access network in subsequent PCC procedure for identifying the user in the EPS network.

If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes.

| +| 3GPP AAA Server URI | Redirect-Host | C |

This information element shall be sent if the Result-Code value is set to DIAMETER_REDIRECT_INDICATION. When the user has previously been authenticated by another 3GPP AAA Server, it shall contain the Diameter URI of the 3GPP AAA Server currently serving the user. The node receiving this IE shall behave as defined in the Diameter base protocol (see IETF RFC 6733 [58]). The command shall contain zero or more occurrences of this information element. When choosing a destination for the redirected message from multiple Redirect-Host AVPs, the receiver shall send the Diameter request to the first 3GPP AAA Server in the ordered list received in the Diameter response. If no successful response to the Diameter request is received, the receiver shall send the Diameter request to the next 3GPP AAA Server in the ordered list. This procedure shall be repeated until a successful response is received from a 3GPP AAA Server.

| +| UE Charging Data | 3GPP-Charging-Characteristics | O |

If present, this information element shall contain the type of charging method to be applied to the user (see 3GPP TS 29.061 [31]).

| +| UE AMBR | AMBR | C |

This information Element shall contain the UE AMBR of the user. It shall be present only if the non-3GPP access network was decided to be trusted, the Result-Code AVP is set to DIAMETER_SUCCESS and ANID is "HRPD".

| + +| | | | | +|----------------------------------------------|------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Trust Relationship Indicator | AN-Trusted | C | This AVP shall be included only in the first authentication and authorization response. If present, it shall contain the 3GPP AAA Server's decision on handling the non-3GPP access network trusted or untrusted.
For the STa case, the value "TRUSTED" shall be used. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| FA-RK | MIP-FA-RK | C | This AVP shall be present if MIPv4 FACoA mode is used, the MN-FA authentication extension is supported and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| FA-RK-SPI | MIP-FA-RK-SPI | C | This AVP shall be present if MIP-FA-RK is present | +| Trace information | Trace-Info | C | This information element shall only be sent if the Result-Code AVP is set to either:
- DIAMETER_SUCCESS or
- DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.
(see NOTE 1)

This AVP shall be included if the subscriber and equipment trace has been activated for the user in the HSS and signalling based activation is used to download the trace activation from the HSS to the non-3GPP access network.
Only the Trace-Data AVP shall be included to the Trace-Info AVP and shall contain the following AVPs:
- Trace-Reference
- Trace-Depth-List
- Trace-Event-List, for PGW
- Trace-Collection-Entity
The following AVPs may also be included in the Trace-Data AVP:
- Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
- Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required. | +| MSISDN | Subscription-ID | C | This AVP shall contain the MSISDN of the UE and shall be sent if it is available and the non-3GPP access network is trusted and the Result-Code AVP is set to either:
- DIAMETER_SUCCESS or
- DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.
(see NOTE 1) | +| DEA Flags | DEA-Flags | O | This Information Element contains a bit mask. See 5.2.3.21 for the meaning of the bits. | +| Selected TWAN Connection Mode | TWAN-Connection-Mode | C | The 3GPP AAA Server shall include this IE if it selects either the SCM or MCM and the Result-Code AVP is set to either:
- DIAMETER_SUCCESS or
- DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.
(see NOTE 1)
When present, this IE shall indicate the selected mode of operation (either SCM or MCM).
If this IE is not present, the TWAN shall use TSCM. | +| Requested Connectivity Parameters | TWAN-Connectivity-Parameters | C | This IE shall contain the requested connectivity parameters received from the UE if the 3GPP AAA Server authorizes the SCM for TWAN and the Result-Code AVP is set to DIAMETER_MULTI_ROUND_AUTH, and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags.

When present, the following information elements shall be included:
- attach type (initial attach or handover)
- requested APN (if received from the UE, see NOTE 3) if the UE did not request an Emergency Attach.
- requested PDN type
- Protocol Configuration Options (if received from the UE) | + +| | | | | +|----------------------|----------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| WLCP Key | WLCP-Key | C | This IE shall be present if the Result-Code AVP is set to DIAMETER_SUCCESS and the selected TWAN Connection Mode is MCM. If present, it shall contain the key for protecting WLCP signalling (see 3GPP TS 33.402 [19]). | +| Terminal Information | Terminal-Information | C | This information element enables to convey the user's Mobile Equipment Identity to the non-3GPP access network in scenarios where the UE signals its Mobile Equipment Identity directly to the 3GPP AAA Server, i.e. when the Terminal-Information AVP is not received in the Authentication and Authorization Request.

For a trusted WLAN access, the 3GPP AAA Server shall include this IE if the user's Mobile Equipment Identity is available. When present, this grouped AVP shall contain the IMEI AVP and, if available, the Software Version AVP. (see NOTE 2) | +| Emergency Services | Emergency-Services | C | If the 3GPP AAA Server supports IMS emergency sessions over TWAN (see clause 4.5.7 of 3GPP TS 23.402 [3]), it shall include this IE and set the Emergency-Indication bit when the UE indicates an Emergency Attach in EAP-AKA' signalling. | +| Emergency Info | Emergency-Info | C | When present, this IE shall contain the identity of the PDN GW dynamically allocated for emergency services. It shall be present for a non-roaming authenticated user, if this information was received from the HSS, the TWAN indicated support of IMS Emergency sessions and the Result-Code AVP is set to either:
- DIAMETER_SUCCESS or
- DIAMETER_MULTI_ROUND_AUTH and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags. (see NOTE 1) | +| ERP Keying Material | Key | C | If the 3GPP AAA Server supports ERP, this IE shall be present if the Result-Code AVP is set to DIAMETER_SUCCESS, the domain-specific re-authentication key was requested and the use of ERP is authorized for this user (see clause 8.2.3.27). In that case, this IE shall contain the Domain-Specific Root Key (DSRK) and the Extended Master Session Key name (EMSKname), and it may contain the DSRK lifetime. | +| ERP Realm | ERP-Realm | C | This IE shall be present if the ERP Keying Material is present. This IE indicates the realm where the ER server is located; it also indicates the domain name to use as the realm part of the KeyName-NAI used during ERP-based re-authentication. | +| UE Usage Type | UE-Usage-Type | C | This IE shall be present if this information is available in the user subscription. When present, this IE shall contain the UE Usage Type of the subscriber. | +| MPS Priority | MPS-Priority | C | Based on operator policy, this information element shall be sent to the non-3GPP WLAN access if the UE has an MPS subscription in the HSS. | + +NOTE 1: The 3GPP AAA Server may decide to not include the AVP if the Result-Code AVP is set to DIAMETER\_SUCCESS and the AVP has already been sent in a previous message with the Result-Code AVP set to DIAMETER\_MULTI\_ROUND\_AUTH and the TWAN-S2a-Connectivity-Indicator set in DEA-Flags. In that case, the TWAN shall consider the information received in the previous message as still applicable. + +NOTE 2: For a trusted WLAN access, the UE signals its Mobile Equipment Identity to the 3GPP AAA Server via EAP-AKA' and the 3GPP AAA Server forwards this information to the TWAN in the Terminal-Information AVP in the Authentication and Authorization Answer. + +NOTE 3: The Service-Selection AVP in the Requested Connectivity Parameters IE shall contain the APN requested by the UE, regardless of whether this APN is authorized by a matching APN or by the wildcard APN in the user's subscription. + +#### 5.1.2.1.2 3GPP AAA Server Detailed Behaviour + +On receipt of the first DER message, the 3GPP AAA Server shall check the validity of the ANID AVP and whether the non-3GPP access network is entitled to use the included value. The correct syntax of the ANID is checked as follows: + +- In a non-roaming case, i.e. when the 3GPP AAA Server receives the request directly and not via the 3GPP AAA Proxy, checking ANID is mandatory; + +- In a roaming case when the request is received via an 3GPP AAA proxy, checking ANID is optional. The 3GPP AAA Server may decide to check ANID based on local configuration, e.g. depending on the received visited network identifier. +- If the checking result shows that the included ANID value is not valid (not defined by 3GPP) or that the requesting entity is not entitled to use the received ANID value, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. + +The 3GPP AAA Server shall check if user data exists in the 3GPP AAA Server (containing valid authentication information for the current access network identity). If not, the 3GPP AAA Server shall use the procedures defined in SWx interface to obtain access authentication and authorization data. + +If IMEI check is required by operator policy and the TWAN is in the HPLMN, the 3GPP AAA Server shall: + +- retrieve the IMEI(SV) from the UE as specified in 3GPP TS 23.402 [26]; +- if the IMEI(SV) is available, check the Mobile Equipment's identity status towards the EIR, using the ME Identity Check procedure (see clause 11); + - upon getting the IMEI check result from the EIR, determine whether to continue or stop the authentication and authorization procedure; +- if the IMEI(SV) is not available, determine whether to continue or stop the authentication and authorization procedure based on operator policy; +- if the 3GPP AAA Server determines that the authentication and authorization procedure shall be stopped, it shall: + - notify the UE that the Mobile Equipment used is not acceptable to the network (e.g. the Mobile Equipment is on the prohibited list of the EIR), as specified in 3GPP TS 24.302 [26]; + - respond to the TWAN with the Experimental-Result-Code DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT. + +Specific operator policies may be configured for emergency services, regarding whether to check the IMEI and, if the IMEI needs to be checked, whether to continue or stop the authentication and authorization procedure upon getting the IMEI check result or when the IMEI(SV) is not available. + +If the IMEI-Check-Required-In-VPLMN bit is set in the DER-Flags AVP of the first Authentication and Authorization Request message and the TWAN is in the VPLMN, the 3GPP AAA Server shall: + +- retrieve the IMEI(SV) from the UE as specified in 3GPP TS 23.402 [26]; +- request the VPLMN to check the IMEI, by setting the IMEI-Check-Request-In-VPLMN bit in the DEA-Flags AVP and including the IMEI(SV) if available in the DEA message; +- upon getting the IMEI-Check-In-VPLMN-Result AVP in the subsequent DER message, if the IMEI check failed in the VPLMN: + - notify the UE that the Mobile Equipment used is not acceptable to the network (e.g. the Mobile Equipment is on the prohibited list of the EIR), as specified in 3GPP TS 24.302 [26]; + - respond to the TWAN with the Experimental-Result-Code DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT. + +See Annex A.2.3 and A.3.2. + +If the 3GPP AAA Server receives a request message not related to any existing session and is able to recognize that the non-3GPP access network included the AAA-Failure-Indication AVP in the request, the 3GPP AAA Server shall also include the AAA-Failure-Indication AVP over the SWx interface, while retrieving the access authentication and authorization data from the HSS. + +If SWx authentication response indicates that: + +- The user does not exist, then the 3GPP AAA Server shall respond the non-3GPP access network with Experimental-Result-Code DIAMETER\_ERROR\_USER\_UNKNOWN. + +- The user does not have non-3GPP access subscription, then 3GPP AAA Server shall respond the non-3GPP access network with Experimental-Result-Code DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION. +- The user is not allowed to roam in the visited network, then 3GPP AAA Server shall respond the non-3GPP access network with Experimental-Result-Code DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED. +- The user is currently being served by a different 3GPP AAA Server, then the 3GPP AAA Server shall respond to the non-3GPP access network with the Result-Code set to DIAMETER\_REDIRECT\_INDICATION and the Redirect-Host set to the Diameter URI of the 3GPP AAA Server currently serving the user (this Diameter URI shall be constructed based on the Diameter Identity included in the 3GPP-AAA-Server-Name AVP returned in the SWx authentication response from the HSS). +- The user is not allowed to use the current access type, then the 3GPP AAA Server shall respond to the non-3GPP access network with Experimental-Result-Code DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED. +- Any other error occurred, then the error code DIAMETER\_UNABLE\_TO\_COMPLY shall be returned to the non-3GPP access network. + +When SWx authentication response includes the requested authentication information, the 3GPP AAA Server shall proceed with the authentication and authorization procedure. The 3GPP AAA Server shall use the procedures defined in SWx interface to obtain the user's subscription profile from HSS. + +Before sending out the authentication challenge, the 3GPP AAA Server shall decide, whether the access network is handled as Trusted or Untrusted. The 3GPP AAA Server shall make the decision based on the Access Network Identifier and Visited Network Identity information elements, according to its local policies. The local policies of the 3GPP AAA Server shall be based on the security criteria described in 3GPP TS 33.402 [19]. + +NOTE 1: The network operator can configure this e.g. according to the roaming agreements with the non-3GPP AN operator or with VPLMN operator. + +In a roaming case, if the 3GPP AAA Server has received the trust relationship indicator from the VPLMN (AN-Trusted AVP), the 3GPP AAA Server may use this information as input parameter to the trusted/untrusted evaluation. + +The VPLMN trust relationship indicator may be utilized only if the appropriate trust relationship exists between the HPLMN and VPLMN operators. + +Based on the trusted/untrusted decision, the 3GPP AAA Server may send a trust relationship indication to the UE, as described in 3GPP TS 24.302 [26]. + +The 3GPP AAA Server shall indicate the trust relationship assessment of the non-3GPP access network to the UE in the AT\_TRUST\_IND attribute (in the EAP-Request/AKA'-Challenge) as defined in 3GPP TS 24.302 [26]. The 3GPP AAA Server shall also indicate the trust relationship assessment to the non-3GPP access network using AN-Trusted AVP in the DEA command. + +If the decision is "Trusted", the STa authentication and authorization procedure is executed as described here, in clause 5.1.2.1 and its clauses. Otherwise, the SWa authentication and authorization procedure is executed as described in clause 4.1.2.1. + +The 3GPP AAA Server marks the trust relationship as "trusted" with the User Identity. If the 3GPP AAA Server detects that an S6b session already exists for the corresponding UE and the S6b session was established as a result of an authentication request for DSMIPv6, the 3GPP AAA Server shall send the trust relationship to the PDN GW as specified in clause 9.1.2.5. + +The 3GPP AAA Server shall run EAP-AKA' authentication as specified in 3GPP TS 33.402 [19]. Exceptions shall be treated as error situations and the result code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. + +Once authentication is successfully completed, the 3GPP AAA Server shall perform the following authorization checking (if there is an error in any of the steps, the 3GPP AAA Server shall stop processing and return the corresponding error): + +- 1) Check if the user is barred to use the non 3GPP Access. If it is so, then the Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED +- 2) Check the access type. If the received access type is listed in the user's disallowed RAT-Types, + +this shall be treated as error and the Experimental-Result-Code DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED shall be returned. + +The following steps are only executed if the non-3GPP access network was decided to be Trusted. + +- 3) If the APN Id IE is present in the request, check if the user has a subscription for the requested APN or for the wildcard APN. If not, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_NO\_APN\_SUBSCRIPTION +- 4) for a trusted WLAN access (i.e. ANID in the request indicates WLAN, see clause 8.1.1.2 of 3GPP TS 24.302 [26]), check if the user is authorized to access to EPC via S2a and/or non-seamless WLAN offload via the selected WLAN: + +- if no TWAN-Access-Info AVP was received from the HSS in the user's subscription, the 3GPP AAA Server shall consider that access to EPC and non-seamless WLAN Offload is authorized; +- if one or more TWAN-Access-Info AVP(s) was received from the HSS in the user's subscription: + - if the TWAN has signalled the selected Trusted WLAN in the request and the selected Trusted WLAN identifier contains only the SSID of the selected WLAN, the 3GPP AAA Server shall authorize the access methods allowed by the TWAN-Access-Info AVP explicitly matching the selected trusted WLAN (i.e. including a WLAN-Identifier AVP with the same SSID and without HESSID information) if any; + +NOTE 2: When the TWAN does not include the HESSID in the request, the authorization information in the 3GPP AAA Server containing both SSID and HESSID is not applicable; therefore, in order to get specific authorization of the UE in this case, the operator needs to define authorization information for the SSID in question (without HESSID), or to rely on the "wildcard" authorization (i.e., a TWAN-Access-Info AVP not including a WLAN-Identifier AVP). + +- if the TWAN has signalled the selected Trusted WLAN in the request and the selected Trusted WLAN identifier contains both the SSID and the HESSID of the selected WLAN, the 3GPP AAA Server shall authorize the access methods allowed by the TWAN-Access-Info AVP explicitly matching the selected trusted WLAN (i.e. including a WLAN-Identifier AVP with the same SSID and same HESSID); + +Else, if no match is found, the 3GPP AAA Server shall authorize the access methods allowed by the TWAN-Access-Info AVP explicitly matching the HESSID of the selected Trusted WLAN identifier (i.e. TWAN-Access-Info including a WLAN-Identifier AVP with the same HESSID and without SSID information); + +Else, if no match is found, the 3GPP AAA Server shall authorize the access methods allowed by the TWAN-Access-Info AVP explicitly matching the SSID of the selected Trusted WLAN identifier (i.e. TWAN-Access-Info including a WLAN-Identifier AVP with the same SSID and without HESSID information) ; + +- otherwise, if the selected Trusted WLAN does not match explicitly any of the TWAN-Access-Info or if TWAN has not signalled the selected Trusted WLAN Identifier, the 3GPP AAA Server shall apply the access methods allowed by the "wildcard" TWAN-Access-Info AVP (i.e. TWAN-Access-Info AVP not including a WLAN-Identifier AVP) if any; + - otherwise, if the "wildcard" TWAN-Access-Info is not present, the 3GPP AAA Server shall consider that access to EPC and non-seamless WLAN Offload is not authorized. +- 5) Check if the user is not authorized to perform non-seamless WLAN Offload and, if the user is also barred from using the subscribed APNs, then the Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED. + - 6) If present, check the flags of the received MIP6-Feature-Vector AVP: + - If the MIP6\_INTEGRATED flag is set and the 3GPP AAA Server has authorized DHCP Home Agent assignment, the 3GPP AAA Server shall include the Home Agent addresses in the APN-Configuration AVP in the response and the MIP6-Feature-Vector AVP with the MIP6\_INTEGRATED flag set. If the HA assignment via DHCPv6 is not used, the MIP6-Feature-Vector AVP with the MIP6\_INTEGRATED flag not set shall be sent. + - The PMIP6\_SUPPORTED and/or GTPv2 SUPPORTED flag indicates to the 3GPP AAA Server whether the trusted non-3GPP access network supports NBM or not. + +As specified in 3GPP TS 23.402 [3], based on the information it has regarding the UE (see 3GPP TS 24.302 [26]), local/home network capabilities and local/home network policies, the 3GPP AAA Server may perform mobility mode selection between NBM and HBM. + +For a trusted WLAN access, if the user is successfully authenticated and authorized for this access, the 3GPP AAA Server may either only authorize the user to access to EPC via S2a (i.e. EPC-routed service only), or only authorize the user to access the TWAN without granting access to EPC via S2a (i.e. non-seamless WLAN offload service only), or authorize both EPC-routed and non-seamless WLAN offload services, taking also into account the subscriber profile, access network, the selected WLAN identifier if present, and the TWAN's non-seamless WLAN offload capability if present, and the authorized mode of operation (TSCM, SCM or MCM). The 3GPP AAA Server may authorize both EPC-routed and non-seamless WLAN offload services only if the MCM is selected, or in non-roaming scenarios if the TSCM is selected; the 3GPP AAA Server shall not authorize both EPC-routed and non-seamless WLAN offload services if the SCM is selected or in roaming scenarios if the TSCM is selected. + +If the 3GPP AAA Server decides that access to EPC is authorized and NBM should be used for such access, the PMIP6\_SUPPORTED and GTPv2\_SUPPORTED flags shall be set in the response to indicate that NBM is authorized for use for the UE by the trusted non 3GPP access network. If only the PMIPv6\_SUPPORTED or the GTPv2\_SUPPORTED flag is present in the response, the trusted non-3GPP access network shall assume that this also indicates that NBM is authorized for use. In addition, for a trusted WLAN access, the Non-seamless WLAN offload Authorization flag shall be set in the DEA-Flags AVP in the response if the non-seamless WLAN offload is authorized. + +If the 3GPP AAA Server decides to only authorize the user to access the TWAN without granting access to EPC S2a (i.e. non-seamless WLAN offload service only), none of the flags (PMIP6\_SUPPORTED, GTPv2\_SUPPORTED, MIP4\_SUPPORTED, MIP6\_INTEGRATED, ASSIGN\_LOCAL\_IP) shall be set in the response, i.e. the Mobility Capabilities IE is not sent in the response, and the Non-seamless WLAN offload Authorization flag shall be set in the DEA-Flags AVP in the response. + +If the 3GPP AAA Server decides that a local IP address should be assigned for HBM, the ASSIGN\_LOCAL\_IP flag shall be set in the response to indicate to the trusted non 3GPP access network that a local IP address (for HBM) should be assigned. + +The 3GPP AAA Server shall not set the PMIP6\_SUPPORTED/GTPv2\_SUPPORTED and ASSIGN\_LOCAL\_IP flags both at the same time in the response. + +- The MIP4\_SUPPORTED flag indicates to the 3GPP AAA Server whether the trusted non-3GPP access network supports MIPv4 FA-CoA mode or not. As specified in 3GPP TS 23.402 [3], based on the information it has regarding the UE (see 3GPP TS 24.302 [26]), local/home network capabilities and local/home network policies, the 3GPP AAA Server may perform mobility mode selection. If the 3GPP AAA Server decides that MIPv4 FA-CoA mode should be used, the MIP4\_SUPPORTED flag shall be set in the response. + +NOTE 3: When selecting DSMIPv6 the AAA server assumes that the trusted non 3GPP access gateway has the capability to assign a local IP address to the UE. + +For Trusted WLAN access, the 3GPP AAA Server shall select the TWAN connection mode, i.e. either TSCM, SCM or MCM, taking into account the modes supported by the TWAN (as reported in the first DER message), those supported by the UE (as reported in the EAP payload, see 3GPP TS 24.302 [26]) and operator policy. The 3GPP AAA Server shall then indicate to the TWAN the TWAN connection mode it has selected, either explicitly using the Selected TWAN Connection Mode IE if it has selected SCM or MCM, or implicitly by not including the Selected TWAN Connection Mode IE if it has selected TSCM. + +For Trusted WLAN access, if the 3GPP AAA Server has determined that the EAP-AKA' authentication is correct (i.e., the UE has sent a valid EAP-AKA' challenge response) and if the 3GPP AAA Server authorizes the SCM to be used for EPC access, the 3GPP AAA Server shall reply to the first DER message it receives with a result code set to DIAMETER\_MULTI\_ROUND\_AUTH, leave the EAP-Payload AVP absent in the reply, and set the TWAN-S2a-Connectivity-Indicator bit to 1 in the DEA-Flags AVP; it shall also include in the response command all subscription-related parameters for the user, so the TWAN is able to proceed with the setup of the required S2a network connectivity (e.g., establishment of the GTP tunnel). After receiving a subsequent DER command from the TWAN, the 3GPP AAA Server shall check if the TWAN-S2a-Connectivity-Indicator is set, and if so, it may disregard the received EAP- + +Payload, since the EAP-AKA' challenge response has been already successfully checked. If the TWAN could not provide the requested S2a network connectivity and included a Session Management back-off timer in the DER command, the 3GPP AAA Server shall instruct the UE to not request new PDN connectivity to the same APN for the indicated time as specified in 3GPP TS 24.302 [26]. See Annex A. + +Once the Authentication and Authorization procedure successfully finishes, the 3GPP AAA Server shall download, the authentication data, the list of authorized APN's if the UE did not indicate an Emergency Attach in EAP-AKA' signalling (see 3GPP TS 24.302 [26]), and the authorized mobility protocols in the authentication and authorization response from the HSS (see SWx procedure in Clause 8.1.2.1). If the Access Network Identity received in the Authentication and Authorization Request indicates WLAN (see clause 8.1.1.2 of 3GPP TS 24.302 [26]) and if the TSCM is selected, the 3GPP AAA Server shall set the Default APN in the Authentication and Authorization Answer to the Default APN for Trusted WLAN if received from the HSS, otherwise to the subscriber's Default APN for 3GPP and other non-3GPP accesses. + +For a trusted WLAN access, if the user is authorized to access to EPC via S2a, and/or non-seamless WLAN offload via the selected WLAN, the 3GPP AAA Server shall send the user's Mobile Equipment Identity to the TWAN, if this information is available. + +Once the Authentication and Authorization procedures successfully finish and if MIPv4 FACoA mode is used the 3GPP AAA Server shall calculate the MIPv4 FACoA mobility security parameters as defined in 3GPP TS 33.402 [19] and include these in the authentication and authorization response to the trusted non 3GPP access network. + +Exceptions to the cases specified here shall be treated by 3GPP AAA Server as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and, therefore, no authorization information shall be returned. + +For Fixed Broadband access network, the 3GPP AAA Server shall determine if the UE is connected via a BBF-defined WLAN access according to the Transport-Access-type AVP. If the UE is connected via a BBF-defined WLAN access, the 3GPP AAA Server shall perform the enabling of the UE reflective QoS function as specified in 3GPP TS 24.139 [43]. + +NOTE 4: This behaviour is applicable for both fixed broadband access interworking and the fixed broadband access convergence. The architecture of fixed broadband access interworking is specified in 3GPP TS 23.139 [39]. The architecture of the fixed broadband access convergence is specified in 3GPP TS 23.203 [45]. + +If the 3GPP AAA Server supports IMS Emergency sessions over WLAN (see clause 4.5.7.2 of 3GPP TS 23.402 [3]), the 3GPP AAA Server shall proceed as specified above, but with the following modifications, for an Emergency Attach: + +- 1) The 3GPP AAA Server shall reject the Authentication and Authorization Request and set the result code to DIAMETER\_UNABLE\_TO\_COMPLY if the TWAN does not indicate support of IMS Emergency sessions in the DER-Flags AVP in the request. +- 2) If the UE does not have an IMSI: + - if local policies allow emergency sessions for all UEs, the 3GPP AAA Server shall skip the procedures defined for the SWx interface to obtain access authentication and authorization data, shall skip the authorization checkings and shall authorize the UE to access to EPC for emergency services. The Permanent User Identity IE in the answer shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14]; + - otherwise the 3GPP AAA Server shall reject the request with the Experimental-Result-Code set to DIAMETER\_ERROR\_USER\_UNKNOWN. +- 3) If the UE has an IMSI but the IMSI is not authenticated: + - if local policies allow emergency sessions for unauthenticated UEs with an IMSI, the 3GPP AAA Server shall skip the procedures defined for the SWx interface to obtain access authorization data, shall skip the authorization checkings, shall request the UE to provide its IMEI as specified in clause 13.4 of 3GPP TS 33.402 [19] and shall authorize the UE to access to EPC for emergency services. The Permanent User Identity IE in the answer shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14]; + +- otherwise the 3GPP AAA Server shall reject the request with the Experimental-Result-Code set as specified for authentication failures in this clause. +- 4) If the UE has an authenticated IMSI but the UE is not authorized to access the EPC: +- if local policies allow emergency sessions for any authenticated UE, the 3GPP AAA Server shall authorize the UE to access to EPC for emergency services; + - otherwise the 3GPP AAA Server shall reject the request with the Experimental-Result-Code set as specified for authorization failures in this clause. +- 5) When authorizing a UE to access to EPC for emergency services, the 3GPP AAA Server: +- shall set the Emergency-Indication bit of the Emergency-Services IE in the answer; + - shall not allow the use of non-seamless WLAN offload services. + +In addition, if the 3GPP AAA Server supports IMS Emergency sessions over WLAN (see clause 4.5.7.2 of 3GPP TS 23.402 [3]), the 3GPP AAA Server shall also include the Emergency Info IE in the Authentication and Authorization Answer, for emergency and non-emergency Attach, if this information was received from the HSS, the user is not roaming, the TWAN indicated support of IMS Emergency sessions and the Result-Code AVP is set to either: + +- DIAMETER\_SUCCESS or +- DIAMETER\_MULTI\_ROUND\_AUTH and TWAN-S2a-Connectivity-Indicator is set in DEA-Flags. + +Once the Authentication and Authorization procedures successfully finish, if a domain-specific re-authentication key was requested and the use of ERP is authorized for this user based on subscription parameter, the 3GPP AAA Server which support ERP shall derive the DSRK from the EMSK and the domain name received in the request as specified in IETF RFC 6696[55] and shall include the DSRK, the EMSKname, and optionally the DSRK lifetime in the authentication and authorization response to the non-3GPP access network. + +Otherwise, when the 3GPP AAA Server does not support ERP, the domain-specific re-authentication key request is ignored if present in the authentication and authorization request. + +Based on operator policy, if the 3GPP AAA Server receives a DER command with a High-Priority-Access-Info AVP with the HPA\_Configured bit set from the TWAN, the 3GPP AAA server shall treat the message with priority as specified in Annex C and Annex D. + +NOTE 5: Alternatively, the 3GPP AAA Server can give priority to this UE after the network has successfully authenticated the UE as described in clause 8.1.2.3.3, at which time the 3GPP AAA Server handles all subsequent messages with priority. + +Based on operator policy, the 3GPP AAA Server may include within the DEA command the MPS-Priority AVP with the MPS-EPS-Priority bit set to the TWAN if the 3GPP AAA Server has received an MPS-Priority AVP with the MPS-EPS-Priority bit set from the HSS. The 3GPP AAA Server shall treat the message and all subsequent messages (if authentication is successful) for the UE with priority as specified in Annex C and Annex D. The 3GPP AAA Server shall discontinue priority treatment for the UE if the 3GPP AAA Server receives a Non-3GPP-User-Data AVP from the HSS without the MPS-Priority AVP with the MPS-EPS-Priority bit set and the last DER command received by the 3GPP AAA Server from the TWAN did not contain a High-Priority-Access-Info AVP with the HPA\_Configured bit set. + +NOTE 6: The 3GPP AAA Server treats the UE with priority if either the DER command from the TWAN indicates high priority access or the HSS has indicated an MPS subscription for the UE. + +### 5.1.2.1.3 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the non-3GPP access network is connected to a VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy, with the following additions. + +If IMEI check is required by operator policy and the TWAN is in the VPLMN, the 3GPP AAA Proxy shall: + +- set the IMEI-Check-Required-In-VPLMN bit in the first Authentication and Authorization Request message sent to the 3GPP AAA Server; + +- upon receipt of a subsequent DER message with the IMEI-Check-Request-in-VPLMN bit set to 1 in the DER-Flags AVP, +- if the IMEI(SV) is available, check the Mobile Equipment's identity status towards the EIR, using the ME Identity Check procedure (see clause 11); + - upon getting the IMEI check result from the EIR, determine whether to continue or stop the authentication and authorization procedure; +- if the IMEI(SV) is not available, determine whether to continue or stop the authentication and authorization procedure based on operator policy; +- send the result of the IMEI check to the 3GPP Server in the IMEI-Check-In- VPLMN-Result AVP. + +Specific operator policies may be configured for emergency services, regarding whether to check the IMEI and, if the IMEI needs to be checked, whether to continue or stop the authentication and authorization procedure upon getting the IMEI check result or when the IMEI(SV) is not available. + +See Annex A.2.3 and A.3.2. + +On receipt of an authentication and authorization request, the 3GPP AAA Proxy + +- shall check the Visited-Network-Identifier AVP, + - If the AVP is not present, the 3GPP AAA Proxy shall insert it before forwarding the request to the 3GPP AAA Server. + - If the AVP is present, the 3GPP AAA Proxy may check and overwrite its value, depending on its local policy, e.g. the trusted non-3GPP access network is being operated by the VPLMN operator or by a third party. +- shall check the ANID AVP. If the result of the checking shows that the included ANID value is not valid (not defined by 3GPP) or that the requesting entity is not entitled to use the received value, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and the authentication response shall be sent to the trusted non-3GPP access network. +- may take a decision about the trustworthiness of the non-3GPP access from VPLMN's point of view. If such decision is taken, it shall be based on the Access Network Identifier and optionally, on further information about the non-3GPP access network, according to the 3GPP AAA Proxy's local policies. These local policies shall reflect the security criteria described in 3GPP TS 33.402 [19], with the assumption that the PDN GW will be allocated in the VPLMN. + +NOTE 1: For example, if hop-by-hop security relationship exists between the NAS and the 3GPP AAA Proxy, the 3GPP AAA Proxy may use the Origin-Host AVP to uniquely identify the NAS and the access network. + +The decision about the trustworthiness of the non-3GPP access network is encoded to the VPLMN trust relationship indicator that is inserted to the authentication and authorization request. + +On receipt of the first authentication and authorization request, the 3GPP AAA Proxy shall check locally configured information whether users from the HPLMN are allowed to activate a PDN connection from the non-3GPP access network via this (V)PLMN. If not, the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the authentication and authorization response shall be sent to the non-3GPP access network. + +NOTE 2: It is assumed that there is a roaming agreement between the non-3GPP access network and the VPLMN. + +On receipt of the first authentication and authorization request, a 3GPP AAA Proxy which supports ERP may check whether ERP is supported by the non-3GPP access network. If the non-3GPP access network supports ERP and there is an ER server requesting a domain-specific re-authentication key in the authentication and authorization request, the 3GPP AAA Proxy may not authorize it based on locally configured information, remove the domain-specific key request before forwarding the request. If the non-3GPP access network supports ERP and there is no ER server in the non-3GPP access network or if the ER server in the non-3GPP access network was not authorized based on locally configured information, the 3GPP AAA Proxy may act as ER server and include the domain-specific re-authentication key request into the first authentication and authorization request forwarded to the 3GPP AAA server. + +On receipt of the authentication and authorization answer that completes a successful authentication, the 3GPP AAA Proxy + +- may check locally configured information about using the chained S8-S2a option towards the given HPLMN. If chaining is required, the 3GPP AAA Proxy shall select a Serving GW from its network configuration database and shall include the Serving GW address in the answer. +- shall check locally configured information for the maximum allowed static QoS parameters valid for visitors from the given HPLMN and modify the QoS parameters received from the 3GPP AAA Server, to enforce the policy limitations. +- shall record the state of the connection (i.e. Authentication and Authorization Successful). +- may check if ERP keying material is provided in the answer in response to the domain-specific re-authentication key requested by the 3GPP AAA Proxy acting as an ER server. If it is, the 3GPP AAA Proxy shall remove the ERP keying material from the answer forwarded to the non-3GPP access network and store the DSRK, the EMSKName and the DSRK lifetime. If there is no ERP keying material and the DEA-Flag does not indicate that ERP is supported by the 3GPP AAA Server, the 3GPP AAA Proxy shall not forward any ERP related messages to the 3GPP AAA Server. +- shall forward the ERP keying material to the TWAN if received from the 3GPP AAA Server and the ER server is located in the TWAN. + +#### 5.1.2.1.4 Trusted non-3GPP access network Detailed Behaviour + +The trusted non-3GPP access network shall initiate the Trusted non-3GPP Access Authentication and Authorization procedure when the user attaches to the access network. During the authentication, it shall act as a pass-through EAP authenticator. + +If the IMEI-Check-Request-In-VPLMN bit is set in the DEA-Flags AVP of the DEA message, the TWAN shall request the 3GPP AAA Proxy to check the IMEI, by setting the IMEI-Check-Request-In-VPLMN bit in the DER-Flags AVP and including the IMEI(SV) in the DER message. See Annex A.2.3 and A.3.2. + +If PMIPv6, GTPv2 or MIPv4 FACoA is used, at successful completion of the procedure, the trusted non-3GPP access network shall store the non-3GPP user data received from the 3GPP AAA Server. The trusted non-3GPP access network shall utilize these data + +- To authorize the APNs received in PDN connection creation request from the UE; +- To authorize the requested home address types: IPv4 home address and/or IPv6 home network prefix; +- To check if the UE requested APN is authorized as such or based on the wildcard APN. + +NOTE 1: The user will be allowed to create PDN connections only to the subscribed APNs and use the address types that are allowed by the subscribed PDN types. + +If DSMIPv6 is used and if the trusted non-3GPP access network has received the PGW identity in form of the FQDN from the 3GPP AAA Server, then the trusted non-3GPP access network may obtain the IP address of the Home Agent functionality of that PGW as described in 3GPP TS 29.303 [34]. + +If MIPv4 FACoA is used and if the non-3GPP access network has received FA-RK-SPI and FA-RK from the 3GPP AAA Server, the trusted non-3GPP access network will use FA-RK key and FA-RK-SPI to further derive MN-FA shared key and MN-FA-SPI, as defined in 3GPP TS 33.402 [19]. These are used to process the MN-FA Authentication Extension in the RRQ/RRP messages if the extension is present. + +If the subscriber is not roaming and the SIPTO-Permission information for an APN is present, the HSGW shall allow SIPTO for that APN only if the SIPTO-Permission information indicates so. If the subscriber is not roaming and the SIPTO-Permission information for an APN is not present, the HSGW may allow SIPTO for that APN. If the subscriber is roaming and the SIPTO-Permission information for an APN is present, the HSGW shall allow SIPTO for that APN only if the SIPTO-Permission information indicates so and the VPLMN Dynamic Address is allowed and the HSGW selects a PDN GW in the VPLMN. For the requested APN allowed for SIPTO, the trusted non-3GPP access network may use the 3GPP DNS mechanism to select a PGW which is close to the HSGW. Detailed behaviour is specified in 3GPP2 X.S0057 [25], 3GPP TS 23.402 [3] and 3GPP TS 29.303 [34]. + +For optimized handover of an emergency session from E-UTRAN to an S2a based cdma2000® HRPD access network, if the trusted non-3GPP access network supports Emergency services for users in limited service state, then the trusted non-3GPP access network shall skip the authentication procedure (for users without an IMSI or with an IMSI marked as unauthenticated); or if the trusted non-3GPP access network accepts that the authentication may fail (for users with an IMSI), it shall continue with the procedure. For these cases, the trusted non-3GPP access network shall release any non-emergency PDN connections. + +The TWAN decides the S2a protocol variant to use if access to EPC is authorized and the TWAN decides to establish S2a. The TWAN may be configured with the S2a protocol variant(s) on a per PLMN granularity, or may retrieve information regarding the S2a protocol variants supported by the PDN GW (PMIPv6 or/and GTPv2) from the Domain Name Service Function as described in 3GPP TS 29.303[34]. For static PDN GW assignment, in order to determine the PLMN of the PDN GW, the TWAN may use the Visited Network Identifier, if received from the 3GPP AAA Server, or the FQDN of the PDN GW, if included in the MIP6-Agent-Info AVP of the APN in use; if none of them are available, it may use the PLMN where the 3GPP AAA Server is located. If the TWAN supports Dedicated Core Networks and receives the UE-Usage-Type from the 3GPP AAA Server, the TWAN shall select the PGW as specified in clause 5.8 of 3GPP TS 29.303 [34]. + +For Trusted WLAN access, the TWAN should attempt the establishment of the S2a connectivity if the 3GPP AAA Server authorizes the SCM to be used for EPC access and the 3GPP AAA Server answers the authentication request with a result code of DIAMETER\_MULTI\_ROUND\_AUTH and with the TWAN-S2a-Connectivity-Indicator bit set to 1 in the DEA-Flags AVP. After completing the S2a network connectivity actions, the TWAN shall re-issue a new DER command including the last EAP-Payload sent in a former request, and setting the TWAN-S2a-Connectivity-Indicator bit to 1 in the DER-Flags AVP. If the requested connectivity has been granted, the TWAN shall also provide the 3GPP AAA Server with the connectivity parameters provided to the UE; otherwise, the TWAN should also provide a cause indicating why the requested connectivity could not be granted and may provide a Session Management back-off timer to be sent to the UE to instruct the UE to not request new PDN connectivity to the same APN for the indicated time. + +If GTPv2 is used on S2a and if the Trace-Info AVP including Trace-Data has been received in the authorization response, the trusted non-3GPP access network shall send a GTPv2 Trace Session Activation message (see 3GPP TS 29.274 [38]) to the PGW to start a trace session for the user. + +If the trusted non-3GPP access network determines that a previously assigned 3GPP AAA Server is unavailable, it may attempt to send a new authentication and authorization request to an alternate 3GPP AAA Server. If the trusted non-3GPP access network receives from this new server a redirect indication towards the former server (due to the HSS having stored the former 3GPP AAA Server identity), it shall terminate all previously existing sessions and PDN connections for that user, and it shall re-send again the request towards the new server, but it shall include the AAA-Failure-Indication AVP in the new request. + +If the TWAN supports IMS Emergency sessions over WLAN (see clause 4.5.7.2 of 3GPP TS 23.402 [3]), the TWAN shall: + +- set the Emergency-Capability-Indication bit in the DER-Flags AVP to indicate support of IMS emergency sessions to the 3GPP AAA Server (to be forwarded to the UE via EAP-AKA' signalling). +- interpret the receipt of an Emergency NAI for Limited Service State or an IMSI-based Emergency NAI from the UE, or the Emergency-Services AVP from the 3GPP AAA Server, with the Emergency-Indication bit set, as an indication that the UE requests to access the EPC for emergency services; +- give preferential treatment to UEs which access the EPC for emergency services, e.g. in scenarios including network overload; +- use its Emergency Configuration Data to determine the APN to be associated with the emergency PDN connection and possibly the PGW to use; +- use the PGW identified in the Emergency PGW Identity IE, during a handover of an emergency PDN connection to a trusted WLAN access, if this information is received from the 3GPP AAA Server, the user is a non-roaming authenticated user and the TWAN is configured to use a dynamic PGW for emergency services for such users; +- proceed during an Emergency Attach for a UE without a UICC or with an authenticated IMSI as specified above with the following modifications, if local policies (related with local regulations) in the TWAN allows unauthenticated emergency sessions: + - if the UE is UICC-less, the User Identity IE in the Authentication and Authorization Request shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14]; + +- if the Permanent User Identity IE in the answer contains an IMEI based NAI but the User Identity IE in the request did not contain an IMEI based NAI, the TWAN shall determine that the IMSI was not authenticated and proceed accordingly with the setup of the Emergency PDN connection over S2b (see 3GPP TS 29.274 [38]). + +Based on operator policy, when sending a DER command, the TWAN shall add a High-Priority-Access-Info AVP with the HPA\_Configured bit set if the TWAN had received an indication from the UE that the UE has access priority in an EAP Response/ Identity message as described in 3GPP TS 24.302 [26]. The TWAN shall treat the message and all subsequent messages (if authentication is successful) for the UE with priority as specified in Annex C and Annex D. + +NOTE 2: Alternatively, the TWAN can give priority to this UE after the network has successfully authenticated the UE as described in clause 8.1.2.3.3, at which time the TWAN handles all subsequent messages with priority. + +Based on operator policy, upon receiving a DEA command marked with a success code and with the MPS-Priority AVP with the MPS-EPS-Priority bit set, the TWAN shall treat the UE with priority, e.g., as defined in Annex B, Annex C and Annex D. The TWAN shall discontinue priority treatment for the UE if the TWAN receives a Non-3GPP-User-Data AVP without an MPS-Priority AVP with the MPS-EPS-Priority bit set and the last DER command received by the TWAN did not contain an indication from the UE that the UE has access priority in an EAP Response/Identity message as described in 3GPP TS 24.302 [26]. + +NOTE 3: The TWAN treats the UE with priority if either the indication that the UE has access priority in an EAP Response/Identity message or the HSS has indicated an MPS subscription for the UE. + +## 5.1.2.2 HSS/AAA Initiated Detach on STa + +### 5.1.2.2.1 General + +This procedure is used between the 3GPP AAA/HSS and the trusted non-3GPP access network to instruct the non-3GPP access network to detach a specific user from the access network. The procedure is based on Diameter session abort messages. + +Diameter usage over the STa interface: + +- This procedure is mapped to the Diameter command codes Diameter-Abort-Session-Request (ASR), Diameter-Abort-Session-Answer (ASA), Diameter-Session-Termination-Request (STR) and Diameter-Session-Termination-Answer (STA) specified in IETF RFC 6733 [58]. Information element contents for these messages are shown in tables 5.1.2.2.1/1 and 5.1.2.2.1/2. +- The STa application id value of 16777250 shall be used as the Application Id in ASR/ASA/STR/STA commands. + +**Table 5.1.2.2.1/1: Information Elements passed in ASR message** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15], and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Auth-Session-State | Auth-Session-State | O | If present this information element shall indicate to the Non-3GPP access network whether the 3GPP AAA Server requires an STR message. | + +**Table 5.1.2.2.1/2: Information Elements passed in ASA message** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|-----------------------------------------------------| +| Result-Code | Result-Code | M | This IE shall indicate the result of the operation. | + +**Table 5.1.2.2.1/3: Information Elements passed in STR message** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Termination-Cause | Termination-Cause | M | This information element shall contain the reason why the session was terminated. It shall be set to "DIAMETER_ADMINISTRATIVE" to indicate that the session was terminated in response to an ASR message. | + +**Table 5.1.2.2.1/4: Information Elements passed in STA message** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|----------------------------------------------------| +| Result-Code | Result-Code | M | This IE shall contain the result of the operation. | + +### 5.1.2.2.2 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA Server shall make use of this procedure to instruct the Non-3GPP access network to detach a specific user from the access network. + +In the DSMIPv6 case, the 3GPP AAA Server shall initiate first the detach procedure over the S6b reference point towards the PDN GW. When this process has finalized, the 3GPP AAA Server can initiate the detach procedure of the UE from the non-3GPP access network. + +The 3GPP AAA Server shall include the Auth-Session-State AVP in the ASR command with a value of NO\_STATE\_MAINTAINED if it does not require a STR from the Non-3GPP access network. If it does require a STR from the Non-3GPP access network, the 3GPP AAA Server shall either omit the Auth-Session-State AVP from the ASR command or include the Auth-Session-State AVP in the ASR command with a value of STATE\_MAINTAINED. + +On receipt of the ASR command, the Non-3GPP access network shall check if the user is known in the Non-3GPP access network. If not, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. + +If the user is known, the Non-3GPP access network shall perform the disconnection of all the PDN connections active for this user and remove any stored user information, except for emergency PDN connections which shall remain active, if the trusted Non-3GPP access supports Emergency services for users in limited service state. + +The Non-3GPP access network shall set the Result-Code to DIAMETER\_SUCCESS and send back the ASA command to the 3GPP AAA Server, which shall update the status of the subscriber on the detached access network. + +If required by the 3GPP AAA Server, the Non-3GPP access network shall send an STR with the Termination-Cause set to DIAMETER\_ADMINISTRATIVE. The 3GPP AAA Server shall set the Result-Code to DIAMETER\_SUCCESS and return the STA command to the Non-3GPP access network. + +### 5.1.2.2.3 3GPP AAA Proxy Detailed Behaviour + +When the 3GPP AAA Proxy receives the ASR from the 3GPP AAA Server it shall route the request to the non-3GPP access network. + +If the 3GPP AAA Proxy requires an STR but the 3GPP AAA Server does not, the 3GPP AAA Proxy may override the value of the Auth-Session-State AVP in the ASR and set it to STATE\_MAINTAINED. In this case, the 3GPP AAA Proxy shall not forward the STR received from the non-3GPP access network onto the 3GPP AAA Server and shall return an STA command to the non-3GPP access network with the Result-Code set to DIAMETER\_SUCCESS. The 3GPP AAA Proxy shall not override the value of the Auth-Session-State AVP under any other circumstances. + +On receipt of the ASA message with Diameter Result Code set to DIAMETER\_SUCCESS, the 3GPP AAA Proxy shall route the successful response to the 3GPP AAA Server and shall release the resources associated with the session. + +When the 3GPP AAA Proxy receives the STR from the Non-3GPP access network, it shall route the request to the 3GPP AAA Server. On receipt of the STA message, the 3GPP AAA Proxy shall route the response to the Non-3GPP access network. + +### 5.1.2.3 STa Re-Authorization and Re-Authentication Procedures + +#### 5.1.2.3.1 General + +The STa Re-Authorization procedure shall be used between the 3GPP AAA Server and the trusted non-3GPP access network for enabling: + +- the 3GPP AAA Server to modify the previously provided authorization parameters. This may happen due to a modification of the subscriber profile in the HSS (for example, removal of a specific APN associated with the subscriber, or change of the identity of a dynamically allocated PDN GW, or change of the identity of a dynamically allocated PDN GW for emergency services, see clause 8.1.2.3). In this case, this procedure is performed in two steps: +- The 3GPP AAA server shall issue an STa Re-Auth request towards the trusted non-3GPP access network. Upon receipt of such a request, the trusted non-3GPP access network shall respond to the request and shall indicate the disposition of the request. This procedure is mapped to the Diameter command Re-Auth-Request and Re-Auth-Answer specified in IETF RFC 6733 [58]. Information element contents for these messages are shown in tables 5.1.2.3.1/1 and 5.1.2.3.1/2. +- Upon receiving the STa Re-Auth request, the non-3GPP access network shall immediately invoke the STa access authorization procedure, based on the reuse of the Diameter command codes AA-Request and AA-Answer commands specified in IETF RFC 4005 [4]. Information element contents for these messages are shown in tables 5.1.2.3.1/3 and 5.1.2.3.1/4. +- the trusted non-3GPP access network to retrieve the subscriber profile from the HSS. This procedure may be initiated at any time by the Trusted non-3GPP access network for check if there is any modification in the user authorization parameters previously provided by the 3GPP AAA Server. In this one-step procedure, the trusted non-3GPP access network shall invoke the STa access authorization procedure, based on the reuse of the Diameter commands AA-Request and AA-Answer commands IETF RFC 4005 [4]. Information element contents for these messages are shown in tables 5.1.2.3.1/3 and 5.1.2.3.1/4. + +After receiving the authorization answer, the trusted non-3GPP access network will release the active PDN connections, for which the authorization has been revoked. If the authorization was rejected by the 3GPP AAA server (e.g. because the user's subscription for non-3GPP accesses has been terminated), the non-3GPP access network shall detach the user from the non-3GPP access network and release all resources. If an emergency PDN connection is active and the trusted non-3GPP access supports emergency services for users in limited service state, the non-3GPP access network shall keep the user attached in the non-3GPP access and the emergency PDN connection active. The non-emergency resources shall be released. + +The STa Re-Authentication procedure shall be used between the 3GPP AAA Server and the trusted non-3GPP access network for re-authenticating the user. This procedure may be initiated at any time by the 3GPP AAA Server based on HPLMN operator policies configured in the 3GPP AAA server. This procedure is performed in two steps: + +- The 3GPP AAA server issues an STa Re-Auth request towards the trusted non-3GPP access. Upon receipt of such a request, the trusted non-3GPP access network shall respond to the request and indicate the disposition of the request. This procedure is mapped to the Diameter command Re-Auth-Request and Re-Auth-Answer specified in IETF RFC 6733 [58]. Information element contents for these messages are shown in tables 5.1.2.3.1/1 and 5.1.2.3.1/2. +- Upon receiving the STa Re-Auth request, the trusted non-3GPP access network shall immediately invoke the STa Access Authentication and Authorization procedure, based on the Re-Auth Request Type provided by the 3GPP AAA server. This procedure is mapped to the Diameter command codes based on the reuse of the Diameter commands Diameter-EAP-Request and Diameter-EAP-Answer specified in IETF RFC 4072 [5]. Information element contents for these messages are shown in tables 5.1.2.3.1/5 and 5.1.2.3.1/6. + +If the re-authentication of the user is not successful, the trusted non-3GPP access network will release all the active PDN connections of the user, except for emergency PDN connections which shall remain active if the trusted non-3GPP access network supports Emergency services for users in limited service state. After a successful authentication and authorization procedure, the trusted non-3GPP access network shall release the active PDN connections for which the authorization has been revoked. + +**Table 5.1.2.3.1/1: STa Re-Auth request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Re-Auth Request Type | Re-Auth-Request-Type | M | This IE shall define whether the user is to be authorized only or authenticated and authorized. In this case, the following values shall be used:
AUTHORIZE_AUTHENTICATE if the re-authentication of the user is requested;
AUTHORIZE_ONLY if the update of the previously provided user authorization parameters is requested. | +| Routing Information | Destination-Host | M | This information element shall be obtained from the Origin-Host AVP, which was included in a previous command received from the trusted non-3GPP access. | + +**Table 5.1.2.3.1/2: STa Re-Auth response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for STa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | + +**Table 5.1.2.3.1/3: STa Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Request-Type | Auth-Request-Type | M | This IE shall define whether the user is to be authenticated only, authorized only or both. In this case, it shall have the value:
AUTHORIZE_ONLY | +| Mobility Capabilities | MIP6-Feature-Vector | C | This information element shall contain the mobility capabilities of the non-3GPP access network.
This AVP shall be included only if optimized idle mode mobility from E-UTRAN to HRPD access is executed. When included, the PMIP_SUPPORTED and the OPTIMIZED_IDLE_MODE_MOBILITY flags shall be set. | +| Routing Information | Destination-Host | M | The 3GPP AAA Server name shall be obtained from the Origin-Host AVP of a previously received message. | +| Access Network Information | Access-Network-Info | O | If present, this IE shall contain the identity and location information of the access network where the UE is attached. | +| Local Time Zone | Local-Time-Zone | O | If present, this IE shall contain the time zone of the location in the access network where the UE is attached. | + + + +**Table 5.1.2.3.1/4: STa Authorization response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|---------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Registration Result | Result Code/ Experimental Result Code | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for STa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP | +| Request-Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_ONLY. See IETF RFC 4072 [5]. | +| Session Alive Time | Session-Timeout | O | This AVP may be present if the Result-Code AVP is set to DIAMETER_SUCCESS; if present, it shall contain the maximum number of seconds the user session is allowed to remain active. This AVP is defined in IETF RFC 6733 [58]. | +| Accounting Interim Interval | Acct-Interim-Interval | O | If present, this IE shall contain the Charging duration. | +| Default APN | Context-Identifier | C | This AVP shall indicate the default APN for the user. It shall only be included if NBM is authorized for use, the Emergency-Indication AVP was not present in the initial Authentication and Authorization Answer and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| APN-OI replacement | APN-OI-Replacement | C | This AVP shall indicate the domain name to replace the APN-OI in the non-roaming case or in the home routed roaming case when constructing the PDN GW FQDN upon which it needs to perform a DNS resolution. See 3GPP TS 23.003 [3]. It shall only be included if NBM is authorized for use, the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Answer and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| APN and PGW Data | APN-Configuration | C | This information element shall only be sent if the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Answer and the Result-Code AVP is set to DIAMETER_SUCCESS.
When NBM is authorized for use, this AVP shall contain the default APN, the list of authorized APNs, user profile information and PDN GW information. When local IP address assignment is used (for HBM), this AVP shall only be present if DHCP based Home Agent discovery is used and contain the Home Agent Information for discovery purposes.
The Trusted Non-3GPP access network knows if NBM is authorized for use or if a local IP address (for HBM) is assigned based on the flags in the MIP6-Feature-Vector received during the STa access authentication and authorization procedure.
APN-Configuration is a grouped AVP, defined in 3GPP TS 29.272 [29]. When NBM is authorized for use, the following information elements per APN may be included:
- APN
- APN-AMBR
- Authorized 3GPP QoS profile
- Statically allocated User IP Address (IPv4 and/or IPv6)
- Allowed PDN types (IPv4, IPv6, IPv4v6, IPv4_OR_IPv6)
- PDN GW identity
- PDN GW allocation type
- VPLMN Dynamic Address Allowed
- Visited Network Identifier (see clause 5.1.2.1.4)

When DSMIPv6 with HA discovery based on DHCPv6 is used, the following information elements per Home Agent may be included:
- HA-APN (Home Agent APN as defined in 3GPP TS 23.003 [14])
- Authorized 3GPP QoS profile
- PDN GW identity | +| UE Charging Data | 3GPP-Charging-Characteristics | O | If present, this information element shall contain the type of charging method to be applied to the user (see 3GPP TS 29.061 [31]). | +| UE AMBR | AMBR | C | This Information Element shall contain the modified UE AMBR of the user. It shall be present if the Result-Code AVP is set to DIAMETER_SUCCESS and ANID is "HRPD". | +| Mobility Capabilities | MIP6-Feature-Vector | C | This information element shall only be sent if it has been received in the corresponding authorization request and the Result-Code AVP is set to DIAMETER_SUCCESS.
When included, the PMIP_SUPPORTED and the | + +| | | | | +|-------------------|-----------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | OPTIMIZED_IDLE_MODE_MOBILITY flags shall be set. | +| Trace information | Trace-Info | C | This AVP shall be included if the subscriber and equipment trace has been activated for the user in the HSS and signalling based activation is used to download the trace activation from the HSS to the trusted non-3GPP access network.
Only the Trace-Data AVP shall be included to the Trace-Info AVP and shall contain the following AVPs:
- Trace-Reference
- Trace-Depth-List
- Trace-Event-List, for PGW
- Trace-Collection-Entity
The following AVPs may also be included in the Trace-Data AVP:
- Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
- Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required. | +| MSISDN | Subscription-ID | C | This AVP shall contain the MSISDN of the UE and shall be sent if it is available and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| Emergency Info | Emergency-Info | C | This IE shall contain the identity of the PDN GW dynamically allocated for emergency services. It shall be present for a non-roaming authenticated user, if this information was received from the HSS, the TWAN indicated support of IMS Emergency Sessions and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| UE Usage Type | UE-Usage-Type | C | This IE shall be present if this information is available in the user subscription. When present, this IE shall contain the UE Usage Type of the subscriber. | +| MPS Priority | MPS-Priority | C | Based on operator policy, this information element shall be sent to the non-3GPP WLAN access if the UE has an MPS subscription in the HSS. | + +**Table 5.1.2.3.1/5: STa Access Authentication and Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and it shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP payload | EAP-payload | M | This IE shall contain the Encapsulated EAP payload used for the UE – 3GPP AAA Server mutual authentication | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the user is to be authenticated only, authorized only or both. In this case, it shall have the value AUTHORIZE_AUTHENTICATE. | + +**Table 5.1.2.3.1/6: Trusted non-3GPP Access Authentication and Authorization Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|----------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and it shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes, if it contains a NAI other than an Emergency NAI for Limited Service State. | +| EAP payload | EAP payload | M | This IE shall contain the Encapsulated EAP payload used for UE-3GPP AAA Server mutual authentication. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result code | Result-Code / Experimental Result Code | M | This IE shall contain the result of the operation. Result codes are as in Diameter base protocol (see IETF RFC 6733 [58]). Experimental-Result AVP shall be used for STa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Session Alive Time | Session-Timeout | O | This AVP may be present if the Result-Code AVP is set to DIAMETER_SUCCESS; if present, it contains the maximum number of seconds the user session is allowed to remain active. This AVP is defined in IETF RFC 6733 [58]. | +| Accounting Interim Interval | Accounting Interim-Interval | O | If present, this IE shall contain the Charging duration. | +| Pairwise Master Key | EAP-Master-Session-Key | C | This IE shall be sent if Result-Code AVP is set to DIAMETER_SUCCESS. | +| Default APN | Context-Identifier | C | This AVP shall indicate the default APN for the user. It shall only be included if NBM is authorized for use, the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Answer and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| APN-OI replacement | APN-OI-Replacement | C | This AVP shall indicate the domain name to replace the APN-OI in the non-roaming case or in the home routed roaming case when constructing the PDN GW FQDN upon which it needs to perform a DNS resolution. See 3GPP TS 23.003 [3]. It shall only be included if NBM is authorized for use, the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Answer and the Result-Code AVP is set to DIAMETER_SUCCESS. | + +| | | | | +|-------------------|-------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| APN and PGW Data | APN-Configuration | C |

This information element shall only be sent if the non-3GPP access network was decided to be trusted, the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Answer and the Result-Code AVP is set to DIAMETER_SUCCESS.

When NBM is authorized for use this AVP shall contain the default APN, the list of authorized APNs, user profile information and PDN GW information.

When local IP address assignment is used (for HBM), this AVP shall only be present if DHCP based Home Agent discovery is used and contain the Home Agent Information for discovery purposes.

The trusted non-3GPP access network knows if NBM is authorized for use or if a local IP address (for HBM) is assigned based on the flags in the MIP6-Feature-Vector.

APN-Configuration is a grouped AVP, defined in 3GPP TS 29.272 [29]. When NBM is authorized for use, the following information elements per APN may be included:

  • - APN
  • - APN-AMBR
  • - Authorized 3GPP QoS profile
  • - User IP Address (IPv4 and/or IPv6)
  • - Allowed PDN types (IPv4, IPv6, IPv4v6, IPv4_OR_IPv6)
  • - PDN GW identity
  • - PDN GW allocation type
  • - VPLMN Dynamic Address Allowed
  • - APN-AMBR
  • - Visited Network Identifier (see clause 5.1.2.1.4)

When DSMIPv6 with HA discovery based on DHCPv6 is used, the following information elements per Home Agent may be included:

  • - HA-APN (Home Agent APN as defined in 3GPP TS 23.003 [14])
  • - Authorized 3GPP QoS profile
  • - PDN GW identity
| +| UE Charging Data | 3GPP-Charging-Characteristics | O | If present, this information element shall contain the type of charging method to be applied to the user (see 3GPP TS 29.061 [31]). | +| UE AMBR | AMBR | C | This Information Element shall contain the UE AMBR of the user. It shall be present only if the non-3GPP access network was decided to be trusted, the Result-Code AVP is set to DIAMETER_SUCCESS and ANID is "HRPD". | +| FA-RK | MIP-FA-RK | C | This AVP shall be present if MIPv4 is used, MN-FA authentication extension is supported and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| FA-RK-SPI | MIP-FA-RK-SPI | C | This AVP shall be present if MIP-FA-RK is present | +| Trace information | Trace-Info | C |

This AVP shall be included if the subscriber and equipment trace has been activated for the user in the HSS and signalling based activation is used to download the trace activation from the HSS to the trusted non-3GPP access network.

Only the Trace-Data AVP shall be included to the Trace-Info AVP and shall contain the following AVPs:

  • - Trace-Reference
  • - Trace-Depth-List
  • - Trace-Event-List, for PGW
  • - Trace-Collection-Entity

The following AVPs may also be included in the Trace-Data AVP:

  • - Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
  • - Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required.
| +| MSISDN | Subscription-ID | C | This AVP shall contain the MSISDN of the UE and shall be sent if it is available and the Result-Code AVP is set to DIAMETER_SUCCESS. | + +| | | | | +|----------------|----------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| WLCP Key | WLCP-Key | C | This IE shall be present if the Result-Code AVP is set to DIAMETER_SUCCESS and the TWAN Connection Mode previously selected is MCM. If present, it shall contain the key for protecting WLCP signalling (see 3GPP TS 33.402 [19]). | +| Emergency Info | Emergency-Info | C | This IE shall contain the identity of the PDN GW dynamically allocated for emergency services. It shall be present for a non-roaming authenticated user, if this information was received from the HSS, the TWAN indicated support of IMS Emergency Sessions and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| UE Usage Type | UE-Usage-Type | C | This IE shall be present if this information is available in the user subscription. When present, this IE shall contain the UE Usage Type of the subscriber. | + +### 5.1.2.3.2 3GPP AAA Server Detailed Behaviour + +Handling of Re-Auth Request: + +The 3GPP AAA Server shall make use of this procedure to indicate the following: + +- If the relevant service authorization information shall be updated in the Trusted non-3GPP access network, the Re-Auth-Request-Type shall be set to AUTHORIZE\_ONLY. This procedure may be triggered by the HSS sending a subscription data update (refer to clause 8.1.2.3) or by local policies, e.g. periodic re-authorization configured by the operator. As for the STa reference point, only a single Diameter authorization session is used for a user, this procedure is initiated for all the PDN connections of this user, i.e. a single instance of Re-authorization Request shall be used per user. +- If the re-authentication and re-authorization of the user shall be executed, the Re-Auth-Request-Type shall be set to AUTHORIZE\_AUTHENTICATE. This procedure may be triggered e.g. by the expiration of a timer started at the successful completion of the last (re-)authentication of the user, depending on the local policies configured in the 3GPP AAA Server. + +Handling of Authorization Request: + +The 3GPP AAA Server shall check that the user exists in the 3GPP AAA Server. The check shall be based on Diameter Session-Id. If not, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. If the user exists, the 3GPP AAA Server shall perform the authorization checking described in clause 5.1.2.1.2. + +If the Authorization request contained the MIP6-Feature-Vector with the OPTIMIZED\_IDLE\_MODE\_MOBILITY flag set, the 3GPP AAA server shall request the user data from the HSS, in order to retrieve up-to-date PDN GW information. + +Handling of Authentication and Authorization Requests: + +The 3GPP AAA Server shall execute the re-authentication of the user, using a full authentication or fast re-authentication, as described in 3GPP TS 33.402 [19], clause 6.2 and 6.3. If full authentication is executed and there are no valid authentication vectors for the given non-3GPP access network available in the 3GPP AAA Server, it shall fetch authentication vectors from the HSS. A combined authentication and authorization shall be executed, with reduced message content described in Tables 5.1.2.3.1/5 and 5.1.2.3.1/6. The QoS-Capability, Access Network Identity, Access Type, Visited Network Identifier, Terminal Information elements received during the initial authentication and authorization procedure as well as the trustworthiness of the non-3GPP AN and the IP mobility mode selected during that procedure shall be considered as valid. If re-authentication of the user is successful and MIPv4 FACoA mode is used the 3GPP AAA Server shall create the MIPv4 FACoA security parameters as defined in 3GPP TS 33.402 [19]. + +If the re-authentication of the user is unsuccessful, the 3GPP AAA Server shall: + +- Terminate all S6b authorization sessions connected to the user, as described in clause 9.1.2.4 +- Remove all APN-PDN GW bindings from the HSS, as described in clauses 8.1.2.2.2.1 and 8.1.2.2.2.2. +- De-register the user from the HSS, as described in clauses 8.1.2.2.2.1 and 8.1.2.2.2.2. Depending on the cause of the re-authentication being unsuccessful, the Server Assignment Type shall be set to AUTHENTICATION\_FAILURE or AUTHENTICATION\_TIMEOUT. + +- Release all resources connected to the user. + +#### 5.1.2.3.3 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the Non-3GPP access network is in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy, with the following additions. + +When forwarding the authorization answer or the authentication and authorization answer, the 3GPP AAA Proxy + +- shall check locally configured information for the maximum allowed static QoS parameters valid for visitors from the given HPLMN and modify the QoS parameters received from the 3GPP AAA Server, to enforce the policy limitations. +- shall record the state of the connection (i.e. Authentication and Authorization Successful). + +#### 5.1.2.3.4 Trusted Non-3GPP Access Network Detailed Behaviour + +Upon receiving the re-auth request, the Trusted non-3GPP access network shall perform the following checks and if an error is detected, the non-3GPP access network shall stop processing the request and return the corresponding error code. + +Check the Re-Auth-Request-Type AVP: + +- 1) If it indicates AUTHENTICATE\_ONLY, Result-Code shall be set to DIAMETER\_INVALID\_AVP\_VALUE. +- 2) If it indicates AUTHORIZE\_AUTHENTICATE, the authentication and authorization of the user is initiated, as defined in 3GPP TS 33.402, with the Diameter message contents described by Tables 5.1.2.3.1/5 and 5.1.2.3.1/6. +- 3) If it indicates AUTHORIZE\_ONLY, the non-3GPP access network shall just perform an authorization procedure as described by Tables 5.1.2.3.1/3 and 5.1.2.3.1/4. + +After successful authorization or authentication and authorization procedure, the trusted non-3GPP access network shall overwrite, for the subscriber identity indicated in the request and the received session, the current authorization information with the information received from the 3GPP AAA Server. + +For the TWAN access, if the TWAN receives the PDN GW Identity from 3GPP AAA Server which is different from the currently selected PDN GW for the same APN, the TWAN shall not tear down the existing PDN connection. + +If the TWAN supports Dedicated Core Networks and receives the UE-Usage-Type from the 3GPP AAA Server, the TWAN shall select the PGW as specified in clause 5.8 of 3GPP TS 29.303 [34] for new PDN connections. + +The release of a PDN connection shall be initiated if the user's subscription for the APN belonging to an active PDN connection has been terminated. + +If the authorization or authentication and authorization procedure was unsuccessful, the non-3GPP access network shall detach the user from the non-3GPP access and release all resources. If the trusted non-3GPP access supports emergency services for users in limited service state, and there is an emergency PDN connection active for such user, the non-3GPP access network shall keep the user attached in the non-3GPP access and the emergency PDN connection active. The non-emergency resources shall be released. + +The Trusted Non-3GPP access network shall initiate the re-authorization of the user in a one-step procedure (i.e. without receiving a re-authorization request from the AAA Server) if the PDN GW information needs to be updated for optimized idle mode mobility from E-UTRAN to HRPD access. + +If GTPv2 is used on S2a and if the Trace-Info AVP including Trace-Data has been received in the authorization response, the trusted non-3GPP access network shall send a GTPv2 Trace Session Activation message (see 3GPP TS 29.274 [38]) to the PGW to start a trace session for the user. If the Trace-Info AVP including Trace-Reference (directly under the Trace-Info) has been received in the authorization response, the trusted non-3GPP access network shall send a GTPv2 Trace Session Deactivation message to the PGW to stop the ongoing trace session, identified by the Trace-Reference. For details, see 3GPP TS 32.422 [32]. + +For the TWAN access, the TWAN shall send the identification, location information of the Access Point where the UE is attached, and the local time zone of the UE, in the authorization request towards the 3GPP AAA Server that follows a re-authorization request issued by the 3GPP AAA Server to the TWAN. + +## 5.1.2.4 Non-3GPP Access Network Initiated Session Termination + +### 5.1.2.4.1 General + +The STa reference point allows the non-3GPP access network to inform the 3GPP AAA server that the session resources of the non-3GPP access network assigned to a given user are being released. + +The procedure shall be initiated by the non-3GPP access network and removes non-3GPP access information from the 3GPP AAA Server. These procedures are based on the reuse of Diameter STR and STA commands as specified in IETF RFC 6733 [58]. + +**Table 5.1.2.4.1/1: STa Session Termination Request** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user in NAI format as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Termination Cause | Termination-Cause | M | This IE shall contain the reason for the disconnection. | + +**Table 5.1.2.4.1/2: STa Session Termination Answer** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors as defined in the Diameter base protocol (see IETF RFC 6733 [58]). Experimental-Result AVP shall be used for STa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | + +### 5.1.2.4.2 3GPP AAA Server Detailed Behaviour + +Upon reception of the Session Termination Request message from the non-3GPP access network, the 3GPP AAA Server shall check that there is an ongoing session associated to the two parameters received (Session-Id and User-Name). + +If an active session is found and it belongs to the user identified by the User-Name parameter, the 3GPP AAA Server shall deregister itself as the managing 3GPP AAA Server for the subscriber following the procedures listed in 8.1.2.2.2. In case of a deregistration success, the 3GPP AAA Server shall release the session resources associated to the specified session and a Session Termination Response shall be sent to the non-3GPP access network, indicating DIAMETER\_SUCCESS. If deregistration from the HSS fails, the 3GPP AAA Server shall return a Session-Termination Response with the Diameter Error DIAMETER\_UNABLE\_TO\_COMPLY. + +Otherwise, the 3GPP AAA Server returns a Session Termination Response with the Diameter Error DIAMETER\_UNKNOWN\_SESSION\_ID + +### 5.1.2.4.3 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the non-3GPP access network is located in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the Session Termination Request message from the non-3GPP access network, the 3GPP AAA Proxy shall route the message to the 3GPP AAA Server. + +On receipt of the Session Termination Answer message from the 3GPP AAA Server, the 3GPP AAA Proxy shall route the message to the non-3GPP access network and it shall release any local resources associated to the specified session only if the result code is set to DIAMETER\_SUCCESS. + +## 5.1.2.5 ERP Re-Authentication in Non-3GPP Access + +### 5.1.2.5.1 General + +The STa reference point allows the non-3GPP access network to perform re-authentication using ERP. + +ERP allows the UE and the ER server to mutually verify proof of possession of key material derived from a previous successful EAP authentication and to establish a security association between the UE and the non-3GPP access network. + +When this procedure is used, the ER server is collocated either with a TWAP or the 3GPP AAA Proxy or the 3GPP AAA Server. When the ER is located in the TWAP, ERP re-authentication procedures are out of the scope of this specification. + +When ERP is used, the ERP re-authentication procedure shall be mapped to the Diameter-EAP-Request and Diameter-EAP-Answer command codes specified in IETF RFC 4072 [5]. + +**Table 5.1.2.5.1/1: STa ERP Re-authentication Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| KeyName-NAI | User-Name | M | This information element shall contain the KeyName-NAI (as defined in clause 19.3.8 of 3GPP TS 23.003 [14]) in the context of EAP re-authentication using ERP as described in IETF RFC 6696 [55] and 3GPP TS 33.402 [19]. | +| EAP-Initiate | EAP-payload | M | This IE shall contain the EAP-Initiate/Re-auth message used for the UE – ER Server mutual authentication. | +| Authentication Request Type | Auth-Request-Type | M | This IE defines whether the user is to be authenticated only, authorized only or both. AUTHORIZE_AUTHENTICATE shall be used in this case. | +| DER-Flags | DER-Flags | M | This Information Element contains a bit mask. See clause 5.2.3.20. | + +**Table 5.1.2.5.1/2: STa ERP Re-authentication Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|----------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| KeyName-NAI | User-Name | M | This information element shall contain the KeyName-NAI (as defined in clause 19.3.8 of 3GPP TS 23.003 [14]) in the context of EAP re-authentication using ERP as described in IETF RFC 6696 [55] and 3GPP TS 33.402 [19]. | +| EAP-Finish | EAP payload | O | If present, this IE shall contain the EAP-Finish as described in IETF RFC 6942 [57]. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result code | Result-Code / Experimental Result Code | M | This IE shall contain the result of the operation. Result codes are as in Diameter Base Protocol (IETF RFC 3588 [7]). Experimental-Result AVP shall be used for STa errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| ERP Keying Material | Key | C | This IE shall be present if the ERP re-authentication is successful. In that case, this IE shall contain the Re-authentication MSK (rMSK) derived by ERP and may contain the rMSK lifetime. | + +### 5.1.2.5.2 ER server located in 3GPP AAA Proxy or 3GPP AAA Server Detailed Behaviour + +Upon reception of the ERP re-authentication request from the non-3GPP access network, the 3GPP AAA Proxy or the 3GPP AAA Server acting as ER server shall search in its local database for a valid, unexpired root key matching the keyName part of the KeyName-NAI. + +If the root key is not found, the 3GPP AAA Proxy or 3GPP AAA Server shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY and the answer shall include an EAP-Payload AVP encapsulating an EAP Failure indicating that the ERP re-authentication has failed. + +If such root key is found, the 3GPP AAA Server shall generate the ERP keying material as described in IETF RFC 6696 [55], shall include the requested ERP keying material in the answer and the result code shall be set to DIAMETER\_SUCCESS. + +NOTE: Only the ERP Implicit Bootstrapping mode defined in IETF RFC 6696 [55] is supported in this release. + +#### 5.1.2.5.3 3GPP AAA Proxy Detailed Behaviour + +Upon reception of the ERP authentication request from the non-3GPP access network, the 3GPP AAA Proxy shall check if the realm part of the KeyName-NAI is its own domain name. If not, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the keyName part of the KeyName-NAI is its own domain name, the 3GPP AAA Proxy shall behave as described in clause 5.1.2.5.2. + +NOTE: In roaming case, the location of the ER server in the home 3GPP AAA Server is not supported in this release. + +## 5.2 Protocol Specification + +### 5.2.1 General + +The STa reference point shall be based on Diameter, as defined in IETF RFC 6733 [58], and contain the following additions and extensions: + +- IETF RFC 4005 [4], which defines a Diameter protocol application used for Authentication, Authorization and Accounting (AAA) services in the Network Access Server (NAS) environment. +- IETF RFC 4072 [5], which provides a Diameter application to support the transport of EAP (IETF RFC 3748 [8]) frames over Diameter. +- IETF RFC 5779 [2], which defines a Diameter extensions and application for PMIPv6 MAG to AAA and LMA to AAA interfaces. +- IETF RFC 5447 [6], which defines Diameter extensions for Mobile IPv6 NAS to AAA interface. + +In the case of a trusted non-3GPP IP access where PMIPv6 is used as mobility protocol, the MAG to 3GPP AAA server or the MAG to 3GPP AAA proxy communication shall use the MAG to AAA interface functionality defined in IETF RFC 5779 [2] and the NAS to AAA interface functionality defined in IETF RFC 5447 [6]. + +The trusted non-3GPP access network to AAA interface functionality over the STa reference defines a new Application Id: + +- "STa" with value 16777250. + +The STa application reuses existing EAP (IETF RFC 4072 [5]) application commands, command ABNFs, and application logic and procedures. + +## 5.2.2 Commands + +### 5.2.2.1 Commands for STa PMIPv6 or GTPv2 or ERP (re-)authentication and authorization procedures + +#### 5.2.2.1.1 Diameter-EAP-Request (DER) Command + +The Diameter-EAP-Request (DER) command, indicated by the Command-Code field set to 268 and the "R" bit set in the Command Flags field, is sent from a non-3GPP access network NAS to a 3GPP AAA server. The ABNF is re-used from the IETF RFC 5779 [2]. + +``` +< Diameter-EAP-Request > ::= < Diameter Header: 268, REQ, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Request-Type } + { EAP-Payload } + [ User-Name ] + [ Calling-Station-Id ] + ... + [ RAT-Type ] + [ ANID ] + [ Full-Network-Name ] + [ Short-Network-Name ] + [ QoS-Capability ] + [ MIP6-Feature-Vector ] + [ Visited-Network-Identifier ] + [ Service-Selection ] + [ Terminal-Information ] + [ OC-Supported-Features ] + *[ Supported-Features ] + [ AAA-Failure-Indication ] + [ WLAN-Identifier ] + [ DER-Flags ] + [ TWAN-Connection-Mode ] + [ TWAN-Connectivity-Parameters ] + * 2 [ TWAG-CP-Address ] + [ ERP-RK-Request ] + [ High-Priority-Access-Info ] + ... + *[ AVP ] +``` + +#### 5.2.2.1.2 Diameter-EAP-Answer (DEA) Command + +The Diameter-EAP-Answer (DEA) command, indicated by the Command-Code field set to 268 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server to a non-3GPP access network NAS. The ABNF is re-used from the IETF RFC 5779 [2]. The ABNF also contains AVPs that are reused from IETF RFC 4072 [5]. + +``` +< Diameter-EAP-Answer > ::= < Diameter Header: 268, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Result-Code } + [ Experimental-Result ] + { Origin-Host } +``` + +``` + +{ Origin-Realm } +{ Auth-Request-Type } +[ EAP-Payload ] +[ User-Name ] +[ Session-Timeout ] +[ Accounting-Interim-Interval ] +[ EAP-Master-Session-Key ] +[ Context-Identifier ] +[ APN-OI-Replacement ] +*[ APN-Configuration ] +[ MIP6-Agent-Info ] +[ MIP6-Feature-Vector ] +[ Mobile-Node-Identifier ] +[ 3GPP-Charging-Characteristics ] +[ AMBR ] +*[ Redirect-Host ] +[ AN-Trusted ] +[ Trace-Info ] +[ Subscription-ID ] +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ Supported-Features ] +[ MIP-FA-RK ] +[ MIP-FA-RK-SPI ] +[ NSWO-Authorization ] +[ DEA-Flags ] +[ TWAN-Connection-Mode ] +[ TWAN-Connectivity-Parameters ] +[ WLCP-Key ] +[ Terminal-Information ] +[ UE-Usage-Type ] +[ Emergency-Services ] +[ Emergency-Info ] +[ Key ] +[ ERP-Realm ] +[ MPS-Priority ] +... +*[ AVP ] + +``` + +## 5.2.2.2 Commands for STa HSS/AAA Initiated Detach for Trusted non-3GPP Access + +### 5.2.2.2.1 Abort-Session-Request (ASR) Command + +The Abort-Session-Request (ASR) command, indicated by the Command-Code field set to 274 and the "R" bit set in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to a non-3GPP access network NAS. ABNF for the ASR commands is as follows: + +``` + +< Abort-Session-Request > ::= < Diameter Header: 274, REQ, PXY, 16777250 > +< Session-Id > +[ DRMP ] +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +{ Destination-Host } +{ Auth-Application-Id } +[ User-Name ] +[ Auth-Session-State ] +... +*[ AVP ] + +``` + +#### 5.2.2.2.2 Abort-Session-Answer (ASA) Command + +The Abort-Session-Answer (ASA) command, indicated by the Command-Code field set to 274 and the "R" bit cleared in the Command Flags field, is sent from a non-3GPP access network NAS to a 3GPP AAA Server/Proxy. ABNF for the ASA commands is as follows: + +``` +< Abort-Session-Answer > ::= < Diameter Header: 274, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + ... + *[ AVP ] +``` + +#### 5.2.2.2.3 Session-Termination-Request (STR) Command + +The Session-Termination-Request (STR) command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is sent from a trusted non-3GPP access network to a 3GPP AAA Server/Proxy. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58], Session-Termination-Request command. + +``` + ::= < Diameter Header: 275, REQ, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Application-Id } + { Termination-Cause } + [ User-Name ] + [ OC-Supported-Features ] + ... + *[ AVP ] +``` + +#### 5.2.2.2.4 Session-Termination-Answer (STA) Command + +The Session-Termination-Answer (STA) command, indicated by the Command-Code field set to 275 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to a trusted non-3GPP access network. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58], Session-Termination-Answer command. + +``` + ::= < Diameter Header: 275, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ AVP ] +``` + +### 5.2.2.3 Commands for Re-Authentication and Re-Authorization Procedure + +#### 5.2.2.3.1 Re-Auth-Request (RAR) Command + +The Diameter Re-Auth-Request (RAR) command, indicated by the Command-Code field set to 258 and the "R" bit set in the Command Flags field, is sent from a 3GPP AAA Server to a Trusted Non-3GPP access network. ABNF for the RAR command is as follows: + +``` + +< Re-Auth-Request > ::= < Diameter Header: 258, REQ, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + { Re-Auth-Request-Type } + [ User-Name ] + ... + *[ AVP ] + +``` + +### 5.2.2.3.2 Re-Auth-Answer (RAA) Command + +The Diameter Re-Auth-Answer (ASA) command, indicated by the Command-Code field set to 258 and the "R" bit cleared in the Command Flags field, is sent from a Trusted Non-3GPP access network to a 3GPP AAA Server/Proxy. ABNF for the RAA commands is as follows: + +``` + +< Re-Auth-Answer > ::= < Diameter Header: 258, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + ... + *[ AVP ] + +``` + +### 5.2.2.3.3 AA-Request (AAR) Command + +The AA-Request (AAR) command, indicated by the Command-Code field set to 265 and the "R" bit set in the Command Flags field, is sent from a Trusted Non-3GPP access network to a 3GPP AAA Server/Proxy. The ABNF is re-used from IETF RFC 4005 [4], adding AVPs from IETF RFC 5779 [2]. + +``` + +< AA-Request > ::= < Diameter Header: 265, REQ, PXY, 16777250 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + [ Destination-Host ] + [ User-Name ] + [ MIP6-Feature-Vector ] + [ Access-Network-Info ] + [ Local-Time-Zone ] + + [ OC-Supported-Features ] + ... + *[ AVP ] + +``` + +### 5.2.2.3.4 AA-Answer (AAA) Command + +The AA-Answer (AAA) command, indicated by the Command-Code field set to 265 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to a Trusted Non-3GPP access network. The ABNF is re-used from IETF RFC 4005 [4], adding AVPs from IETF RFC 5779 [2]. + +``` + +< AA-Answer > ::= < Diameter Header: 265, PXY, 16777250 > + < Session-Id > + +``` + +``` + +[ DRMP ] +{ Auth-Application-Id } +{ Auth-Request-Type } +{ Result-Code } +[ Experimental-Result ] +{ Origin-Host } +{ Origin-Realm } +[ Session-Timeout ] +[ Accounting-Interim-Interval ] +[ Context-Identifier ] +[ APN-OI-Replacement ] +*[ APN-Configuration ] +[ 3GPP-Charging-Characteristics ] +[ Trace-Info ] +[ Subscription-ID ] +[ OC-Supported-Features ] +[ OC-OLR ] +[ UE-Usage-Type ] +[ Emergency-Info ] +*[ Load ] +... +*[ AVP ] + +``` + +#### 5.2.2.3.5 Diameter-EAP-Request (DER) Command + +Refer to clause 5.2.2.1.1 + +#### 5.2.2.3.6 Diameter-EAP-Answer (DEA) Command + +Refer to clause 5.2.2.1.2 + +### 5.2.2.4 Commands for Trusted non-3GPP Access network Initiated Session Termination + +#### 5.2.2.4.1 Session-Termination-Request (STR) Command + +The Session-Termination-Request (STR) command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is sent from a non-3GPP access network to a 3GPP AAA server. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58], Session-Termination-Request command. + +``` + + ::= < Diameter Header: 275, REQ, PXY, 16777250 > +< Session-Id > +[ DRMP ] +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +[ Destination-Host ] +{ Auth-Application-Id } +{ Termination-Cause } +[ User-Name ] +[ OC-Supported-Features ] +... +*[ AVP ] + +``` + +#### 5.2.2.4.2 Session-Termination-Answer (STA) Command + +The Session-Termination-Answer (STA) command, indicated by the Command-Code field set to 275 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA server to a non-3GPP access network. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58], Session-Termination-Answer command. + +``` + + ::= < Diameter Header: 275, PXY, 16777250 > +< Session-Id > + +``` + +``` +[ DRMP ] +{ Result-Code } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ AVP ] +``` + +## 5.2.3 Information Elements + +### 5.2.3.1 General + +The following table describes the Diameter AVPs defined for the STa interface protocol in NBM mode, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +**Table 5.2.3.1/1: Diameter STa AVPs** + +| | AVP Flag rules | +|--|----------------| +|--|----------------| + +| Attribute Name | AVP Code | Clause defined | Value Type | Must | May | Should not | Must not | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------|-------------|------|-----|------------|----------| +| MIP6-Feature-Vector | 124 | 5.2.3.3 | Unsigned64 | M | | | V,P | +| QoS-Capability | 578 | 5.2.3.4 | Grouped | M | | | V,P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | +| RAT-Type | 1032 | 5.2.3.6 | Enumerated | M,V | | | P | +| ANID | 1504 | 5.2.3.7 | UTF8String | M,V | | | P | +| AN-Trusted | 1503 | 5.2.3.9 | Enumerated | M,V | | | P | +| MIP-FA-RK | 1506 | 5.2.3.12 | OctetString | M,V | | | P | +| MIP-FA-RK-SPI | 1507 | 5.2.3.13 | Unsigned32 | M,V | | | P | +| Full-Network-Name | 1516 | 5.2.3.14 | OctetString | V | | | M,P | +| Short-Network-Name | 1517 | 5.2.3.15 | OctetString | V | | | M,P | +| WLAN-Identifier | 1509 | 5.2.3.18 | Grouped | V | | | M,P | +| Mobile-Node-Identifier | 506 | 5.2.3.2 | UTF8String | M | | | V,P | +| AAA-Failure-Indication | 1518 | 8.2.3.21 | Unsigned32 | V | | | M,P | +| Transport-Access-Type | 1519 | 5.2.3.19 | Enumerated | V | | | M,P | +| APN-Configuration | 1430 | 8.2.3.7 | Grouped | M,V | | | P | +| Visited-Network-Identifier | 600 | 9.2.3.1.2 | OctetString | M,V | | | P | +| DER-Flags | 1520 | 5.2.3.20 | Unsigned32 | V | | | M,P | +| DEA-Flags | 1521 | 5.2.3.21 | Unsigned32 | V | | | M,P | +| SSID | 1524 | 5.2.3.22 | UTF8String | V | | | M,P | +| HESSID | 1525 | 5.2.3.23 | UTF8String | V | | | M,P | +| Access-Network-Info | 1526 | 5.2.3.24 | Grouped | V | | | M,P | +| TWAN-Connection-Mode | 1527 | 5.2.3.25 | Unsigned32 | V | | | M,P | +| TWAN-Connectivity-Parameters | 1528 | 5.2.3.26 | Grouped | V | | | M,P | +| Connectivity-Flags | 1529 | 5.2.3.27 | Unsigned32 | V | | | M,P | +| TWAN-PCO | 1530 | 5.2.3.28 | OctetString | V | | | M,P | +| TWAG-CP-Address | 1531 | 5.2.3.29 | Address | V | | | M,P | +| TWAG-UP-Address | 1532 | 5.2.3.30 | UTF8String | V | | | M,P | +| TWAN-S2a-Failure-Cause | 1533 | 5.2.3.31 | Unsigned32 | V | | | M,P | +| SM-Back-Off-Timer | 1534 | 5.2.3.32 | Unsigned32 | V | | | M,P | +| WLCP-Key | 1535 | 5.2.3.33 | OctetString | V | | | M,P | +| Emergency-Services | 1538 | 7.2.3.4 | Unsigned32 | V | | | M,P | +| IMEI-Check-In-VPLMN-Result | 1540 | 5.2.3.35 | Unsigned32 | V | | | M,P | +| High-Priority-Access-Info | 1541 | 5.2.3.36 | Unsigned32 | V | | | M,P | +| NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. | | | | | | | | +| NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. | | | | | | | | + +The following table describes the Diameter AVPs re-used by the STa interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within STa. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol defined in IETF RFC 6733 [58], do not need to be supported. + +**Table 5.2.3.1/2: STa re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | M-bit | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|-------------------------------------------------------------------------------------------|--------------| +| Accounting-Interim-Interval | IETF RFC 6733 [58] | | | +| Auth-Request-Type | IETF RFC 6733 [58] | | | +| Calling-Station-Id | IETF RFC 4005 [4] | | | +| Subscription-ID | IETF RFC 4006 [20] | | Must not set | +| EAP-Master-Session-Key | IETF RFC 4072 [5] | | | +| EAP-Payload | IETF RFC 4072 [5] | | | +| RAT-Type | 3GPP TS 29.212 [23] | | | +| Re-Auth-Request-Type | IETF RFC 6733 [58] | | | +| Session-Timeout | IETF RFC 6733 [58] | | | +| User-Name | IETF RFC 6733 [58] | | | +| Terminal-Information | 3GPP TS 29.272 [29] | | | +| MIP6-Agent-Info | IETF RFC 5447 [6] | | | +| APN-OI-Replacement | 3GPP TS 29.272 [29] | | | +| Supported-Features | 3GPP TS 29.229 [24] | | | +| Feature-List-ID | 3GPP TS 29.229 [24] | See clause 5.2.3.10 | | +| Feature-List | 3GPP TS 29.229 [24] | See clause 5.2.3.11 | | +| BSSID | 3GPP TS 32.299 [30] | | | +| Location-Information | IETF RFC 5580 [46] | | | +| Location-Data | IETF RFC 5580 [46] | | | +| Operator-Name | IETF RFC 5580 [46] | | | +| Logical-Access-ID | ETSI TS 283 034 [48] | | | +| Local-Time-Zone | 3GPP TS 29.272 [29] | | | +| PDN-Type | 3GPP TS 29.272 [29] | | | +| Served-Party-IP-Address | 3GPP TS 32.299 [30] | | | +| OC-Supported-Features | IETF RFC 7683 [47] | See clause 8.2.3.22 | | +| OC-OLR | IETF RFC 7683 [47] | See clause 8.2.3.23 | | +| DRMP | IETF RFC 7944 [53] | See clause 8.2.3.25 | Must not set | +| Emergency-Info | 3GPP TS 29.272 [29] | | | +| Load | IETF RFC 8583 [54] | See clause 8.2.3.26 | Must not set | +| ERP-RK-Request | IETF RFC 6942 [57] | | Must not set | +| Key | IETF RFC 6734 [56] | This is a grouped AVP containing Key-Type, Keying-Material and, optionally, Key-Lifetime. | Must not set | +| ERP-Realm | IETF RFC 6942 [57] | | Must not set | +| UE-Usage-Type | 3GPP TS 29.272 [29] | | | +| MPS-Priority | 3GPP TS 29.272 [29] | | Must not set | +| NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. | | | | +| NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. | | | | + +Only those AVP initially defined in this reference point or AVP with values initially defined in this reference point and for this procedure are described in the following clause. + +### 5.2.3.2 Mobile-Node-Identifier + +The Mobile-Node-Identifier AVP (AVP Code 506) is of type UTF8String. + +The Mobile-Node-Identifier AVP is returned in an answer message that ends a successful authentication (and possibly an authorization) exchange between the AAA client and the AAA server. The returned Mobile Node Identifier may be used as the PMIPv6 MN-ID or as the MIPv4 MN-NAI or to derive the IMSI to be sent in GTPv2 signalling. + +The Mobile-Node-Identifier is defined on IETF RFC 5779 [2]. + +### 5.2.3.3 MIP6-Feature-Vector + +The MIP6-Feature-Vector AVP (AVP Code 124) is of type Unsigned64 and contains a 64 bit flags field of supported mobile IP capabilities of the non-3GPP access network (when this AVP is used in the request commands) and the mobile IP capabilities the 3GPP AAA Server has authorized (when this AVP is used in the response commands). + +The following capabilities are defined for STa interface: + +- MIP6\_INTEGRATED (0x0000000000000001) +This flag is set by the non-3GPP access network and the 3GPP AAA Server. It means that the Mobile IPv6 integrated scenario bootstrapping functionality is supported. +- PMIP6\_SUPPORTED (0x0000010000000000) +When this flag is set by the non-3GPP access network it indicates to the 3GPP AAA Server that it supports PMIPv6. +When this flag is set by the 3GPP AAA Server it indicates to the non-3GPP access network that NBM shall be used. +- ASSIGN\_LOCAL\_IP (0x0000080000000000) +This flag is set by the 3GPP AAA Server. +When this flag is set by the 3GPP AAA Server it indicates to the non-3GPP access network that the non-3GPP access network shall assign to the user a local IP address (for HBM). +- MIP4\_SUPPORTED (0x0000100000000000) +This flag is set by the non-3GPP access network, the PDN GW and the 3GPP AAA Server. When this flag is set by the non-3GPP access network it indicates to the 3GPP AAA Server that it supports MIPv4 FA-CoA mode. When this flag is set by the 3GPP AAA Server it indicates to the non-3GPP access network that MIPv4 FA-CoA mode shall be used. When this flag is set by the PDN GW and 3GPP AAA Server over the S6b interface, it shows that MIPv4 mobility protocol is used on the S2a interface. +- OPTIMIZED\_IDLE\_MODE\_MOBILITY (0x0000200000000000) +This flag is set by the Trusted Non-3GPP access network if the PDN GW information needs to be updated for the case of idle mode mobility from E-UTRAN to HRPD access. +- GTPv2\_SUPPORTED (0x0000400000000000) +When this flag is set by the non-3GPP access network it indicates to the 3GPP AAA Server that it supports GTPv2. +When this flag is set by the 3GPP AAA Server it indicates to the non-3GPP access network that NBM shall be used. + +### 5.2.3.4 QoS Capability + +This AVP is FFS + +### 5.2.3.5 Service-Selection + +The Service-Selection AVP is of type of UTF8String. This AVP contains an APN Network Identifier (i.e., an APN without the Operator Identifier), and it shall consist of one or more labels according to DNS naming conventions (IETF RFC 1035 [35]) describing the access point to the packet data network. + +The contents of the Service-Selection AVP shall be formatted as a character string composed of one or more labels separated by dots ("."). + +The Service-Selection AVP is defined in IETF RFC 5778 [11]. + +### 5.2.3.6 RAT-Type + +The RAT-Type AVP (AVP code 1032) is of type Enumerated and is used to identify the radio access technology that is serving the UE. It follows the specification described in TS 29.212 [23]. + +### 5.2.3.7 ANID + +The ANID AVP is of type UTF8String; this AVP contains the Access Network Identity; see 3GPP TS 24.302 [26] for defined values. + +### 5.2.3.8 AMBR + +Please refer to 3GPP TS 29.272 [29] for the encoding of this AVP. + +### 5.2.3.9 AN-Trusted + +The AN-Trusted AVP (AVP Code 1503) is of type Enumerated. + +The AN-Trusted AVP sent from the 3GPP AAA Server to the Non-3GPP access network conveys the decision about the access network being trusted or untrusted by the HPLMN. + +The following values are defined: + +TRUSTED (0) + +This value is used when the non-3GPP access network is to be handled as trusted. + +UNTRUSTED (1) + +This value is used when the non-3GPP access network is to be handled as untrusted. + +### 5.2.3.10 Feature-List-ID AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. For this release, the Feature-List-ID AVP value shall be set to 1 for the STa/SWa application. + +### 5.2.3.11 Feature-List AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. A null value indicates that there is no feature used by the STa/SWa application. + +NOTE: There are no STa/SWa features defined for this release. + +### 5.2.3.12 MIP-FA-RK + +The MIP-FA-RK AVP is of type OctetString; this AVP contains the FA-RK used to calculate the security parameters needed for the MN-FA authentication extension as defined by 3GPP TS 33.402 [19]. + +### 5.2.3.13 MIP-FA-RK-SPI + +The MIP-FA-RK-SPI AVP is of type Unsigned32; this AVP contains the security index used in identifying the security context for the FA-RK as defined by 3GPP TS 33.402 [19]. + +### 5.2.3.14 Full-Network-Name + +The Full-Network-Name AVP is of type OctetString; this AVP shall contain the Full Network Name and be encoded as the Full name value field of the AT\_FULL\_NAME\_FOR\_NETWORK attribute specified in clause 8.2.5.1 of 3GPP TS 24.302 [26]. + +### 5.2.3.15 Short-Network-Name + +The Short-Network-Name AVP is of type OctetString; this AVP shall contain the Short Network Name and be encoded as the Short name value field of the AT\_SHORT\_NAME\_FOR\_NETWORK attribute specified in clause 8.2.5.2 of 3GPP TS 24.302 [26]. + +#### 5.2.3.16 Void + +#### 5.2.3.17 Void + +#### 5.2.3.18 WLAN-Identifier + +The WLAN-Identifier AVP is of type Grouped. It contains the type and value of an IEEE 802.11 identifier of a Trusted WLAN. + +AVP Format: + +WLAN-Identifier ::= < AVP Header: 1509 10415 > +[ SSID ] +[ HESSID ] +\*[ AVP ] + +#### 5.2.3.19 Transport-Access-Type + +The Transport-Access-Type AVP (AVP code 1519) is of type Enumerated and is used to identify the transport access technology that is serving the UE. + +The following values are defined: + +BBF (0) + +This value shall be used to indicate a BBF transport access network. + +#### 5.2.3.20 DER-Flags + +The DER-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 5.2.3.20/1: + +**Table 5.2.3.20/1: DER-Flags** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | NSWO-Capability-Indication | This bit, when set, indicates to the 3GPP AAA proxy/server that the TWAN supports non-seamless WLAN offload service (see clause 16 of 3GPP TS 23.402 [3]). | +| 1 | TWAN-S2a-Connectivity-Indicator | This bit is only applicable to the TWAN authentication and authorization procedure, when authorizing the SCM for EPC access.
When set, it indicates to the 3GPP AAA Server that the TWAN has completed the necessary S2a network connectivity actions, and the 3GPP AAA Server can finalize the EAP conversation by sending a final EAP 'Success' or 'Failure' response to the TWAN. | +| 2 | IMEI-Check-Required-In-VPLMN | This bit is only applicable to the TWAN authentication and authorization procedure, when the UE and the network support Mobile Equipment Identity signalling over trusted WLAN.
When set, it indicates to the 3GPP AAA Server that the 3GPP AAA Server shall retrieve the IMEI(SV) from the UE and return it to the VPLMN with the IMEI-Check-Request-In-VPLMN bit set in the DEA-Flags. | +| 3 | IMEI-Check-Request-In-VPLMN | This bit is only applicable to the TWAN authentication and authorization procedure, when the UE and the network support Mobile Equipment Identity signalling over trusted WLAN.
When set, it indicates that the 3GPP AAA Proxy shall perform the IMEI(SV) check in the VPLMN and send the IMEI check result to the 3GPP AAA Server. | +| 4 | Emergency-Capability-Indication | This bit, when set, indicates to the 3GPP AAA Server that the TWAN supports IMS emergency sessions (see clause 4.5.7 of 3GPP TS 23.402 [3]). | +| 5 | ERP-Support-Indication | This bit, when set, indicates to the 3GPP AAA proxy/server that the non-3GPP access network supports EAP extensions for the EAP Re-authentication Protocol (ERP). | +| 6 | ERP-Re-Authentication | This bit, when set, indicates to the 3GPP AAA proxy/server that the authentication request is sent for EAP re-authentication based on ERP. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 5.2.3.21 DEA-Flags + +The DEA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 5.2.3.21/1: + +**Table 5.2.3.21/1: DEA-Flags** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | NSWO-Authorization | This bit, when set, indicates to the TWAN that the non-seamless WLAN offload service is authorized (see clause 16 of 3GPP TS 23.402 [3]). | +| 1 | TWAN-S2a-Connectivity-Indicator | This bit is only applicable to the TWAN authentication and authorization procedure, when authorizing the SCM for EPC access; when set, it indicates to the TWAN that the EAP-AKA' authentication has been successful (i.e., the 3GPP AAA Server has checked the validity of the challenge response sent by the UE), and the network connectivity set up may proceed at the TWAN. | +| 2 | IMEI-Check-Request-In-VPLMN | This bit is only applicable to the TWAN authentication and authorization procedure, when the UE and the network support Mobile Equipment Identity signalling over trusted WLAN.
When set, it indicates that the VPLMN shall perform the IMEI check and return the outcomes to the 3GPP AAA Server. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 5.2.3.22 SSID + +The SSID AVP is of type UTF8String and it shall contain the Service Set Identifier which identifies a specific 802.11 extended service set (see IEEE Std 802.11-2012 [40]). It shall contain a string of 1 to 32 octets. + +### 5.2.3.23 HESSID + +The HESSID AVP is of type UTF8String and it shall contain a 6-octet MAC address that identifies the Homogenous Extended Service Set (see IEEE Std 802.11-2012 [40]). It shall be encoded in upper-case ASCII characters with the octet values separated by dash characters. It shall contain a string of 17 octets. Example: "00-10-A4-23-19-C0". + +### 5.2.3.24 Access-Network-Info + +The Access-Network-Info AVP is of type Grouped. + +For a Trusted WLAN, it shall contain the SSID of the WLAN and, unless otherwise determined by the TWAN operator's policies, it shall contain at least one of the following elements: + +- the BSSID, +- the civic address of the access point to which the UE is attached, +- the Logical Access ID (see ETSI ES 283 034 [48]) associated to the access point to which the UE is attached. + +It may also contain the name of the TWAN operator (either a PLMN-ID or an operator name in realm format). + +For an untrusted WLAN, it shall contain the same information as specified above for a trusted WLAN, where the operator name indicates the WLAN operator name. + +AVP Format: + +``` +Access-Network-Info ::= < AVP Header: 1526 10415 > + [ SSID ] + [ BSSID ] + [ Location-Information ] + [ Location-Data ] + [ Operator-Name ] + [ Logical-Access-ID ] + *[ AVP ] +``` + +The Location-Data and Location-Information AVPs are defined in IETF RFC 5580 [46]; the content of Location-Information shall indicate that the encoding follows a civic location profile, by setting the "Code" field to 0. + +The Operator-Name AVP is defined in IETF RFC 5580 [46]; the first 8 bits contain the Namespace ID field, whose values are managed by IANA, and are encoded as a single ASCII character. Only values "1" (Realm) and "2" (E212, containing MCC and MNC values) shall be used in this specification. + +### 5.2.3.25 TWAN-Connection-Mode + +The TWAN-Connection-Mode AVP (AVP Code 1527) is of type Unsigned32 and it shall contain a 32 bit flags field which is used to indicate the connection modes supported by the TWAN (when this AVP is used in the request commands) and the selected TWAN connection mode the 3GPP AAA Server has authorized (when this AVP is used in the response commands). + +**Table 5.2.3.25/1: TWAN-Connection-Mode** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | TSC-MODE | This bit, when set by the TWAN, indicates to the 3GPP AAA Server that the TWAN supports the TSCM. | +| 1 | SC-MODE | This bit, when set by the TWAN, indicates to the 3GPP AAA Server that the TWAN supports the SCM.
This bit, when set by the 3GPP AAA Server, indicates to the TWAN that the SCM shall be used. | +| 2 | MC-MODE | This bit, when set by the TWAN, indicates to the 3GPP AAA Server that the TWAN supports the MCM.
This bit, when set by the 3GPP AAA Server, indicates to the TWAN that the MCM shall be used. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 5.2.3.26 TWAN-Connectivity-Parameters + +The TWAN-Connectivity-Parameters AVP is of type Grouped. + +AVP Format: + +``` + +TWAN-Connectivity-Parameters ::= < AVP Header: 1528 10415 > + [ Connectivity-Flags ] + [ Service-Selection ] + [ PDN-Type ] + * 2 [ Served-Party-IP-Address ] + [ TWAN-PCO ] + [ TWAG-UP-Address ] + [ TWAN-S2a-Failure-Cause ] + [ SM-Back-Off-Timer ] + *[ AVP ] + +``` + +The Service-Selection AVP indicates the APN requested by the UE (requested connectivity parameters) or the APN selected by the TWAN (provided connectivity parameters). It shall contain both the network identifier part and the operator identifier part of the Access Point Name. + +The PDN-Type AVP indicates the PDN type requested by the UE (requested connectivity parameters) or the PDN type allocated by the network (provided connectivity parameter). It may be set to IPv4, IPv6 or IPv4v6. + +The UE's Served-Party-IP-Address AVP may be present 0, 1 or 2 times. These AVPs shall be present if the S2a connection was successfully established, and they shall contain either of: + +- an IPv4 address, or +- an IPv6 interface identifier, or +- both, an IPv4 address and an IPv6 interface identifier. + +For the IPv6 interface identifier, the higher 64 bits of the address shall be set to zero. + +The TWAN-S2a-Failure-Cause AVP may be present to indicate the cause of S2a connectivity establishment failure. + +The SM-Back-Off-Timer AVP may be present to provide a Session Management back-off timer to be sent to the UE. The exact value of the SM-Back-Off-Timer is operator dependant. + +### 5.2.3.27 Connectivity-Flags + +The Connectivity-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 5.2.3.26/1: + +**Table 5.2.3.26/1: Connectivity-Flags** + +| Bit | Name | Description | +|-------|-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Initial-Attach-Indicator | This bit may be set by the 3GPP AAA Server.
This bit, when set, indicates that a UE performs the Initial Attach procedure from non-3GPP access network. When not set, it indicates that a UE performs the Handover procedure. | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | + +### 5.2.3.28 TWAN-PCO + +The TWAN-PCO AVP is of type OctetString and shall contain the Protocol Configuration Options for the UE. + +### 5.2.3.29 TWAG-CP-Address + +The TWAG-CP-Address AVP is of type Address and shall contain the TWAG control-plane IPv4 and/or IPv6 address that the TWAG supports, to be used for WLCP by the UE if MCM is selected. + +### 5.2.3.30 TWAG-UP-Address + +The TWAG-UP-Address AVP is of type UTF8String and shall contain a 6-octet MAC address that identifies the TWAG user-plane MAC address to be used for encapsulating user plane packets between the UE and the TWAN, when SCM is used. + +It shall be encoded in upper-case ASCII characters with the octet values separated by dash characters. It shall contain a string of 17 octets. Example: "00-10-A4-23-19-C0". + +### 5.2.3.31 TWAN-S2a-Failure-Cause + +The TWAN-S2a-Failure-Cause AVP (AVP Code 1533) is of type Unsigned32 and it shall contain a 32 bit cause value field which is used to indicate the cause of S2a connectivity establishment failure to the 3GPP AAA Server by the TWAN. The description of the TWAN-S2a-Failure-Cause value is specified as in Table 5.2.3.30/1: + +**Table 5.2.3.30/1: TWAN-S2a-Failure-Cause value description** + +| Cause value (decimal) | Cause Value | Meaning | +|-----------------------|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 26 | Insufficient resources | This cause is used to indicate that the requested service cannot be provided due to insufficient resources. | +| 27 | Unknown APN | This cause is used to indicate that the requested service was rejected because the access point name could not be resolved. | +| 29 | User authentication failed | This cause is used to indicate that the requested service was rejected by the external packet data network due to a failed user authentication | +| 30 | Request rejected by TWAN or PDN GW | This cause is used to indicate that the requested service or operation was rejected by the TWAN or PDN GW. | +| 31 | Request rejected, unspecified | This cause is used to indicate that the requested service or operation was rejected due to unspecified reasons. | +| 32 | Service option not supported | This cause is used to indicate that the UE requests a service which is not supported by the PLMN. | +| 33 | Requested service option not subscribed | This cause is used to indicate that the UE requests a service option which it has no subscription. | +| 34 | Service option temporarily out of order | This cause is used to indicate that the network cannot serve the request because of temporary outage of one or more functions required for supporting the service. | +| 38 | Network failure | This cause is used to indicate that the requested service was rejected due to an error situation in the network. | +| 50 | PDN type IPv4 only allowed | This value is used to indicate that only PDN type IPv4 is allowed for the requested PDN connectivity. | +| 51 | PDN type IPv6 only allowed | This value is used to indicate that only PDN type IPv6 is allowed for the requested PDN connectivity. | +| 54 | PDN connection does not exist | This value is used at handover from a 3GPP access network to indicate that the network does not have any information about the requested PDN connection. | +| 113 | Multiple accesses to a PDN connection not allowed | This value is used to indicate that the request for the additional access to a PDN connection was rejected by the PDN GW. | + +### 5.2.3.32 SM-Back-Off-Timer + +The SM-Back-Off-Timer AVP is of type Unsigned32 and it shall contain the session management back-off timer value in seconds. The session management back-off timer is provided to the UE as specified in clause 8.1.4.16 of 3GPP TS 24.302 [26]. + +### 5.2.3.33 WLCP-Key + +The WLCP-Key AVP (AVP Code 1535) is of type OctetString and it shall contain the WLCP Key used for protecting the WLCP signalling between the UE and the TWAN, as specified in 3GPP TS 33.402 [19]. + +### 5.2.3.34 Void + +### 5.2.3.35 IMEI-Check-In-VPLMN-Result + +The IMEI-Check-In-VPLMN-Result AVP (AVP Code 1540) is of type Unsigned32 and it shall contain a 32 bit cause value field which is used to indicate the result of the IMEI check performed in the VPLMN. The description of the IMEI-Check-In-VPLMN-Result value is specified as in Table 5.2.3.35/1: + +**Table 5.2.3.35/1: IMEI-Check-In-VPLMN-Result value description** + +| Cause value (decimal) | Cause Value | Meaning | +|-----------------------|-------------|----------------------------------------------------------------------------------------------------------------| +| 0 | Successful | This cause is used to indicate that the IMEI check has been performed successfully in the VPLMN. | +| 1 | Illegal_ME | This cause is used to indicate that the IMEI check has failed in the VPLMN due to an illegal Mobile Equipment. | + +### 5.2.3.36 High-Priority-Access-Info + +The High-Priority-Access-Info AVP (AVP code 1541) is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 5.2.3.36/1: + +**Table 5.2.3.36/1: High-Priority-Access-Info** + +| Bit | Name | Description | +|-------|----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------| +| 0 | HPA_Configured | This bit, when set, indicates that the UE is configured for high priority access. | +| NOTE: | Bits not defined in this table shall be cleared by the sending TWAN and discarded by the receiving AAA Server. | | + +NOTE: The TWAN sets the HPA\_Configured bit if the TWAN had received an indication from the UE that the UE has access priority in an EAP Response/Identity message as described in 3GPP TS 24.302 [26]. + +## 5.2.4 Session Handling + +The Diameter protocol between the non-3GPP access network and the 3GPP AAA Server or 3GPP AAA Proxy, shall always keep the session state, and use the same Session-Id parameter for the lifetime of each Diameter session. + +A Diameter session shall identify a given user. In order to indicate that the session state is to be maintained, the Diameter client and server shall not include the Auth-Session-State AVP, either in the request or in the response messages (see IETF RFC 6733 [58]). + +# 6 SWd and SWd' Description + +## 6.1 Functionality + +### 6.1.1 General + +The SWd reference point connects the 3GPP AAA Proxy and the 3GPP AAA Server in EPS. The functionality of the SWd reference point is to transport authentication, authorization and related information in AAA messages including: + +- Carrying data for authentication signalling between 3GPP AAA Proxy and 3GPP AAA Server; +- Carrying data for authorization signalling between 3GPP AAA Proxy and 3GPP AAA Server +- Carrying charging signalling per user; +- Carrying keying data for the purpose of radio interface integrity protection and encryption; +- Carrying authentication data for the purpose of tunnel establishment, tunnel data authentication and encryption, for the case in which the ePDG is in the VPLMN; +- Carrying mapping of a user identifier and a tunnel identifier sent from the ePDG to the 3GPP AAA Proxy through the 3GPP AAA Server; + +- Used for purging a user from the access network for immediate service termination; +- Enabling the identification of the operator networks amongst which the roaming occurs; +- If QoS mechanisms are applied: carrying data for AN QoS capabilities/policies (e.g. the supported 3GPP QoS profiles) within authentication request from 3GPP AAA Proxy to 3GPP AAA Server. +- Carrying the IP Mobility Capabilities between 3GPP AAA Proxy and 3GPP AAA Server. + +The SWd reference point is defined between the 3GPP AAA Proxy, possibly via an intermediate 3GPP AAA Proxy, and the NSWOF in 5GS. The definition of the reference point and its functionality is given in clause 4.2.15 of 3GPP TS 23.501 [59] and Annex S of 3GPP TS 33.501 [60]. It reuses the same stage 3 protocol definition as defined for SWd in EPC, with specific requirements for NSWO in 5GS specified in clause 6.1.2.4. + +## 6.1.2 Procedures Description + +### 6.1.2.1 Trusted non-3GPP Access / Access Gateway related procedures + +#### 6.1.2.1.1 Trusted Non-3GPP Access Authentication and Authorization + +When used in connection with the STa interface, the SWd interface shall support the trusted non-3GPP access authentication and authorization procedure defined in clause 5.1.2.1. For this procedure, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the trusted non-3GPP access network as a stateful Diameter proxy, with the following exceptions: + +- The 3GPP AAA Proxy may reject an authentication and authorization request, if roaming is not allowed for the users of the given HPLMN. +- When forwarding an authentication and authorization request, the 3GPP AAA Proxy shall check the presence and value of the visited network identifier. If the AVP was missing, it shall insert it, if the AVP was present, it may overwrite the AVP value before forwarding the request. +- The 3GPP AAA Proxy may modify the service authorization information in the authentication and authorization answer that it forwards to the trusted non-3GPP access network, in order to enforce the QoS limitations according to the local policies and the roaming agreement with the home operator. +- The 3GPP AAA Proxy may decide about the trustworthiness of the non-3GPP access from the VPLMN point of view and insert a trust relationship indicator to the authentication and authorization request. +- If it supports the ER server functionality, the 3GPP AAA Proxy may decide about the use of ERP for re-authentication and indicate its willingness to act as the ER server for this session into the first authentication and authorization request forwarded to the 3GPP AAA server. + +The 3GPP AAA Proxy shall decide about using the S2a-PMIP based S8 chaining and in case it has selected that option, it shall select the Serving GW to be invoked and it shall add the Serving GW address to the authentication and authorization answer that is sent upon successful completion of the authentication. + +Table 6.1.2.1.1/1 describes the trusted non-3GPP access authentication and authorization request forwarded on the SWd interface. + +**Table 6.1.2.1.1-1: Trusted non-3GPP Access Authentication and Authorization Request on SWd** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------|----------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP payload | EAP-payload | M | This IE shall contain the Encapsulated EAP payload used for the UE – 3GPP AAA Server mutual authentication | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the user is to be authenticated only, authorized only or both. AUTHORIZE_AUTHENTICATE shall be used in this case. | +| UE Layer-2 address | Calling-Station-ID | M | This IE shall contain the Layer-2 address of the UE. | +| Supported 3GPP QoS profile | QoS-Capability | O | If the trusted non-3GPP Access supports QoS mechanisms, this information element may be included to contain the access network's QoS capabilities as defined in IETF RFC 5777 [9]. | +| Mobility Capabilities | MIP6-Feature-Vector | C |

This information element shall contain the mobility capabilities of the trusted non-3GPP access network, if dynamic mobility mode selection is done. This information may also be used to decide whether to authorize access to EPC to a user accessing a TWAN.

The PMIP6_SUPPORTED flag and/or the GTPv2_SUPPORTED flag shall be set if the trusted non-3GPP access network supports PMIPv6 and/or GTPv2. PMIP6_SUPPORTED flag is defined in IETF RFC 5779 [2].

The flag MIP6_INTEGRATED shall be set if DHCPv6 based Home Agent address discovery is supported as defined in IETF RFC 5447 [6].

The MIP4_SUPPORTED flag shall be set if the trusted non-3GPP access supports MIPv4 FA-CoA mode.

| +| Access Type | RAT-Type | M | This IE shall contain the trusted non-3GPP access network technology type that is serving the UE. | +| Access Network Identity | ANID | M | This IE shall contain the access network identifier used for key derivation at the HSS. (See 3GPP TS 24.302 [26] for all possible values) | +| Visited Network Identifier | Visited-Network-Identifier | M | This IE shall contain the Identifier that allows the home network to identify the Visited Network. | +| Full Name for Network | Full-Network-Name | O | This IE shall contain the full name for network as specified in 3GPP TS 24.302 [26]. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network. If the Visited Network Identifier is present, this AVP shall be set. | +| Short Name for Network | Short-Network-Name | O | This IE shall contain the short name for network as specified in 3GPP TS 24.302 [26]. This AVP may be inserted by the non-3GPP access network depending on its local policy and only when it is not connected to the UE's Home Network. If the Visited Network Identifier is present, this AVP shall be set. | +| APN Id | Service-Selection | O | If present, this information element shall contain the Network Identifier part of the APN the user wants to connect to (if available). | +| Terminal Information | Terminal-Information | O | If present, this information element shall contain information about the user's mobile equipment. The type of identity carried depends on the access technology type. For HRPD access network, the 3GPP2-MEID AVP shall be included in this grouped AVP. | +| Trust Relationship Indicator | AN-Trusted | O | If present, This AVP shall express the trusted/untrusted decision about the non-3GPP IP access, from the VPLMN's point of view. The value "TRUSTED" shall be used in this case. | +| Selected Trusted WLAN Identifier | WLAN-Identifier | O | If present, this IE shall contain the Trusted WLAN Identifier selected by the UE to access the Trusted WLAN Access Network (see clause 16 of 3GPP TS 23.402 [3]). | +| DER Flags | DER-Flags | O | This Information Element contains a bit mask. See 5.2.3.20 for the meaning of the bits. | + +| | | | | +|-----------------------------------------------|------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Transport Access Type | Transport-Access-Type | C | For interworking with Fixed Broadband access networks (see 3GPP TS 23.139 [39]), if the access network needs to receive the IMSI of the UE in the authentication response, then this information element shall be present, and it shall contain the value "BBF" (see clause 5.2.3.19). | +| Supported TWAN Connection Modes | TWAN-Connection-Mode | O | The TWAN should include this IE.
If present, this information element shall contain the TWAN connection modes supported by the TWAN, i.e. TSCM, SCM and/or MCM. | +| Provided Connectivity Parameters | TWAN-Connectivity-Parameters | C | This information element shall be present if the 3GPP AAA Server has previously authorized the SCM to be used for EPC access.

TWAN-Connectivity-Parameters is a grouped AVP.

If the requested connectivity has been granted, the following information elements shall be included:
- selected APN
- selected PDN type
- UE IPv4 Address (for PDN type IPv4 or IPv4v6)
- UE IPv6 Interface Identifier (for PDN type IPv6 or IPv4v6)
- Protocol Configuration Options (if received from the PGW)
- TWAG user plane MAC address

The absence of both an IPv4 address and an IPv6 Interface Identifier indicates that the requested connectivity could not be granted. If the requested connectivity has not been granted, the following information elements may be included:
- a cause indicating why the requested connectivity has not been granted | +| TWAG Control Plane IP Address | TWAG-CP-Address | C | The TWAN shall include this IE if it indicates support of the MCM in the Supported TWAN Connection Modes IE. When present, this IE shall contain the TWAG Control Plane IPv4 Address, or the TWAG Control Plane IPv6 link local address, or both (if the TWAG supports IPv4 and IPv6), to be used for WLCP by the UE if the MCM is used. | +| Domain-Specific Re-authentication Key Request | ERP-RK-Request | O | If present, this IE indicates the willingness of an ER server in the non-3GPP access network or the 3GPP AAA proxy to act as the ER server for this session.

When present, this IE shall contain the name of the realm in which the ER server is located. | + +NOTE: For more details on the 3GPP AAA Proxy behaviour, refer to clause 5.1.2.1.3. + +#### 6.1.2.1.2 HSS/AAA Initiated Detach for Trusted non-3GPP Access + +When used in connection with the STa interface, the SWd interface shall support the HSS initiated detach procedure defined in clause 5.1.2.2. + +For this procedure, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the access network GW as a stateful Diameter proxy. + +#### 6.1.2.1.3 Access and Service Authorization information update + +When used in connection with the STa interface, the SWd interface shall support the trusted non-3GPP access and service authorization information update procedure defined in clause 5.1.2.3. For this procedure, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the trusted non-3GPP access network as a stateful Diameter proxy, with the following exceptions: + +- When forwarding an authentication and authorization request, the 3GPP AAA Proxy shall check the presence and value of the visited network identifier. If the AVP was missing, it shall insert it, if the AVP was present, it may overwrite the AVP value before forwarding the request. + +- The 3GPP AAA Proxy may modify the service authorization information in the authentication and authorization answer that it forwards to the trusted non-3GPP access network, in order to enforce the QoS limitations according to the local policies and the roaming agreement with the home operator. + +Table 6.1.2.1.3/1 describes the trusted non-3GPP access authorization request forwarded on the SWd interface. As the content is very similar to that of the request received on the STa interface, only those AVPs are listed that are handled differently on the two interfaces. + +**Table 6.1.2.1.3/1: Trusted Non-3GPP Access Authorization Request on SWd interface** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------|----------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Request-Type | Auth-Req-Type | M | This IE shall contain the Authorization Request Type. The following values only shall be used:
AUTHORIZE_ONLY
This value shall indicate the initial request for authorization of the user to the APN. | +| Visited Network Identifier | Visited-Network-Identifier | M | This IE shall contain an identifier that allows the home network to identify the Visited Network. | +| Routing Information | Destination-Host | M | This IE shall contain the 3GPP AAA Server name that is obtained from the Origin-Host AVP of a previously received message. | +| Supported 3GPP QoS profile | QoS-Capability | O | If the trusted non-3GPP Access supports QoS mechanisms, this information element may be included to contain the access network's QoS capabilities as defined in IETF RFC 5777 [9]. | +| Access Type | RAT-Type | O | If present, this IE contain the trusted non-3GPP access network access technology type that is serving the UE. | + +NOTE: For more details on the 3GPP AAA Proxy behaviour, refer to clause 5.1.2.3.3. + +#### 6.1.2.1.4 Trusted non-3GPP Access Network Initiated Session Termination + +When used in connection with the STa reference point, the SWd reference point shall support the access network initiated session termination procedures as defined in clause 5.1.2.4 + +For this procedure, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the access network gateway as a stateful Diameter proxy. + +#### 6.1.2.2 Untrusted non-3GPP Access / ePDG related procedures + +When used in connection with the SWm reference point, the SWd reference point shall support the following procedures: + +- Authentication procedures as defined in clause 7.1.2.1 +- Authorization procedures as defined in clause 7.1.2.2 +- Access network/ePDG initiated session termination procedures as defined in clause 7.1.2.3 +- HSS/AAA initiated detach procedures as defined in clause 7.1.2.4 +- Service authorization information update procedures as defined in clause 7.1.2.5 + +For all these procedures, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the ePDG as a stateful Diameter proxy, with the following exceptions: + +- The 3GPP AAA Proxy may reject an authentication or an authorization request, if roaming is not allowed for the users of the given HPLMN. + +- The 3GPP AAA Proxy may modify the service authorization information in the authorization answer that it forwards to the ePDG, in order to enforce the QoS limitations according to the local policies and the roaming agreement with the home operator. +- The 3GPP AAA Proxy shall decide about using the S8-S2b chaining and in case it has selected that option, it shall select the Serving GW to be invoked and it shall add the Serving GW address to the authentication answer that is sent upon successful completion of the authentication. + +NOTE: For more detailed behavior of the 3GPP AAA Proxy, refer to clauses 7.1.2.1.3 and 7.1.2.2.3 respectively. + +When used in connection with the SWa interface point, the SWd reference point shall support the following procedures: + +- Authentication and authorization procedure as defined in clause 4.1.2.1 +- HSS/AAA initiated detach procedures as defined in clause 4.1.2.2 +- Untrusted non-3GPP access network initiated detach procedures as defined in clause 4.1.2.3 +- Re-Authentication and Re-Authorization Procedure as defined in clause 4.1.2.4 + +For all these procedures, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the untrusted non-3GPP access network as a stateful Diameter proxy, with the following exceptions: + +- The 3GPP AAA Proxy may reject an authentication and authorization request, if roaming is not allowed for the users of the given HPLMN. +- When forwarding an authentication and authorization request, the 3GPP AAA Proxy shall insert the visited network identifier. + +### 6.1.2.3 PDN GW related procedures + +When used in connection with the S6b reference point, the SWd reference point shall support the following procedures: + +- Authentication and authorization procedures when using DSMIP as defined in clause 9.1.2.1 +- Authorization procedures when using NBM as defined in clause 9.1.2.2 +- PDN GW initiated session termination procedures as defined in clause 9.1.2.3 +- HSS/AAA initiated detach procedures as defined in clause 9.1.2.4 +- Service authorization information update procedures as defined in clause 9.1.2.5 + +For all these procedures, the 3GPP AAA Proxy shall forward the Diameter commands received from the 3GPP AAA Server and the PDN GW as a stateful Diameter proxy, with the following exceptions: + +- The 3GPP AAA Proxy may reject an authentication or authorization request, if roaming is not allowed for the users of the given HPLMN +- The 3GPP AAA Proxy may modify the service authorization information in the authorization answers that it forwards to the PDN GW, in order to enforce the QoS limitations according to the local policies and the roaming agreement with the home operator. + +NOTE: For more detailed behavior of the 3GPP AAA Proxy, refer to clauses 9.1.2.1.4, 9.1.2.2.4, 9.1.2.3.4, and 9.1.2.4.4, respectively. + +### 6.1.2.4 SWd' procedures for NSWO in 5GS + +The SWd' interface between the 3GPP AAA Proxy, possibly via an intermediate 3GPP AAA Proxy, and the NSWOF shall support the same procedures as defined for SWa' in clause 4.1.2.5. + +For these procedures, the 3GPP AAA Proxy shall forward the Diameter commands received from the NSWOF and the untrusted non-3GPP access network as a stateful Diameter proxy, with the following exceptions: + +- The 3GPP AAA Proxy may reject an authentication and authorization request, if roaming is not allowed for the users of the given HPLMN. +- When forwarding an authentication and authorization request, the 3GPP AAA Proxy shall insert the visited network identifier. + +## 6.2 Protocol Specification + +### 6.2.1 General + +The SWd reference point shall be based on Diameter, as defined in IETF RFC 6733 [58] and contain the following additions and extensions: + +- IETF RFC 4005 [4], which defines a Diameter protocol application used for Authentication, Authorization and Accounting (AAA) services in the Network Access Server (NAS) environment. +- IETF RFC 4072 [5], which provides a Diameter application to support the transport of EAP (IETF RFC 3748 [8]) frames over Diameter. +- IETF RFC 5779 [2], which defines Diameter extensions and application for PMIPv6 MAG to AAA and LMA to AAA interfaces. +- IETF RFC 5447 [6], which defines Diameter extensions for Mobile IPv6 NAS to AAA interface. + +There is no separate application ID defined for the SWd interface. The application ID used by the 3GPP AAA Proxy depends on the command sent over SWd. + +NOTE: Even though the 3GPP AAA Proxy may add new AVPs to the Diameter commands forwarded to/from the 3GPP AAA Server, there is no AVP present in the SWd reference point that would not be present in the interface that is used in connection with it. Therefore, the same Application ID can be used. + +### 6.2.2 Commands + +#### 6.2.2.1 Commands used in connection with the STa interface + +##### 6.2.2.1.1 Commands for STa PMIPv6 or GTPv2 authentication and authorization procedures + +###### 6.2.2.1.1.1 Diameter-EAP-Request (DER) Command + +The Diameter-EAP-Request (DER) command, indicated by the Command-Code field set to 268 and the "R" bit set in the Command Flags field, is sent from a trusted non-3GPP access network NAS to a 3GPP AAA server. The ABNF is re-used from the IETF RFC 5779 [2]. + +``` +< Diameter-EAP-Request > ::= < Diameter Header: 268, REQ, PXY, 16777250 > +< Session-Id > +[ DRMP ] +{ Auth-Application-Id } +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +[ Destination-Host ] +{ Auth-Request-Type } +{ EAP-Payload } +[ User-Name ] +[ Calling-Station-Id ] +... +[ RAT-Type ] +``` + +``` + +[ ANID ] +[ QoS-Capability ] +[ MIP6-Feature-Vector ] +[ Visited-Network-Identifier ] +[ Service-Selection ] +[ Terminal-Information ] +[ AN-Trusted ] +[ Full-Network-Name ] +[ Short-Network-Name ] +*[ Supported-Features ] +[ WLAN-Identifier ] +[ DER-Flags ] +[ TWAN-Connection-Mode ] +[ TWAN-Connectivity-Parameters ] +* 2 [ TWAG-CP-Address ] +[ TWAN-S2a-Failure-Cause ] +[ ERP-RK-Request ] +[ High-Priority-Access-Info ] +... +*[ AVP ] + +``` + +#### 6.2.2.1.1.2 Diameter-EAP-Answer (DEA) Command + +The Diameter-EAP-Answer (DEA) command, indicated by the Command-Code field set to 268 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA server to a 3GPP AAA Proxy. The ABNF is re-used from the IETF RFC 5779 [2]. The ABNF also contains AVPs that are reused from IETF RFC 4072 [5]. + +``` + +< Diameter-EAP-Answer > ::= < Diameter Header: 268, PXY, 16777250 > +< Session-Id > +[ DRMP ] +{ Auth-Application-Id } +{ Result-Code } +[ Experimental-Result ] +{ Origin-Host } +{ Origin-Realm } +{ Auth-Request-Type } +[ EAP-Payload ] +[ User-Name ] +[ Session-Timeout ] +[ Accounting-Interim-Interval ] +[ EAP-Master-Session-Key ] +[ Context-Identifier ] +[ APN-OI-Replacement ] +*[ APN-Configuration ] +[ MIP6-Feature-Vector ] +[ Mobile-Node-Identifier ] +*[ Redirect-Host ] +[ Trace-Info ] +[ Subscription-ID ] +*[ Supported-Features ] +[ DEA-Flags ] +[ TWAN-Connection-Mode ] +[ TWAN-Connectivity-Parameters ] +[ Terminal-Information ] +[ Key ] +[ ERP-Realm ] +[ MPS-Priority ] +... +*[ AVP ] + +``` + +**6.2.2.1.2 Commands for STa HSS/AAA Initiated Detach for Trusted non-3GPP Access** + +The ABNFs defined for the STa interface in clause 5.2.2.2 and in its clauses apply. + +**6.2.2.1.3 Commands for STa Access and Service Authorization Update Procedure** + +The ABNFs defined for the STa interface in clause 5.2.2.3 and in its clauses apply. + +**6.2.2.1.4 Commands for Trusted non-3GPP Access network Initiated Session Termination** + +The ABNFs defined for the STa interface in clause 5.2.2.4 and in its clauses apply. + +**6.2.2.2 Commands used in connection with the SWm interface** + +The ABNFs defined for the SWm interface in clause 7.2.2 and in its clauses apply. + +**6.2.2.3 Commands used in connection with the S6b interface** + +The ABNFs defined for the S6b interface in clause 9.2.2 and in its clauses apply. + +**6.2.3 Information Elements** + +**6.2.3.1 General** + +The following table describes the Diameter AVPs defined for the SWd interface protocol in NBM mode, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +**Table 6.2.3.1/1: Diameter SWd AVPs** + +| | AVP Flag rules | +|--|----------------| +|--|----------------| + +| Attribute Name | AVP Code | Clause defined | Value Type | Must | May | Should not | Must not | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------|-------------|------|-----|------------|----------| +| MIP6-Feature-Vector | 124 | 5.2.3.3 | Unsigned64 | M | | | V,P | +| QoS-Capability | 578 | 5.2.3.4 | Grouped | M | | | V,P | +| RAT-Type | 1032 | 5.2.3.6 | Enumerated | M,V | | | P | +| ANID | 1504 | 5.2.3.7 | UTF8String | M,V | | | P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | +| Mobile-Node-Identifier | 506 | 5.2.3.2 | UTF8String | M | | | V,P | +| AN-Trusted | 1503 | 5.2.3.9 | Enumerated | M,V | | | P | +| Full-Network-Name | 1516 | 5.2.3.14 | OctetString | V | | | M,P | +| Short-Network-Name | 1517 | 5.2.3.15 | OctetString | V | | | M,P | +| WLAN-Identifier | 1509 | 5.2.3.18 | Grouped | V | | | M,P | +| APN-Configuration | 1430 | 8.2.3.7 | Grouped | M,V | | | P | +| Visited-Network-Identifier | 600 | 9.2.3.1.2 | OctetString | M,V | | | P | +| DER-Flags | 1520 | 5.2.3.20 | Unsigned32 | V | | | M,P | +| DEA-Flags | 1521 | 5.2.3.21 | Unsigned32 | V | | | M,P | +| SSID | 1524 | 5.2.3.22 | UTF8String | V | | | M,P | +| HESSID | 1525 | 5.2.3.23 | UTF8String | V | | | M,P | +| TWAN-Connection-Mode | 1527 | 5.2.3.25 | Unsigned32 | V | | | M,P | +| TWAN-Connectivity-Parameters | 1528 | 5.2.3.26 | Grouped | V | | | M,P | +| Connectivity-Flags | 1529 | 5.2.3.27 | Unsigned32 | V | | | M,P | +| TWAN-PCO | 1530 | 5.2.3.28 | OctetString | V | | | M,P | +| TWAG-CP-Address | 1531 | 5.2.3.29 | Address | V | | | M,P | +| TWAG-UP-Address | 1532 | 5.2.3.30 | UTF8String | V | | | M,P | +| TWAN-S2a-Failure-Cause | 1533 | 5.2.3.31 | Unsigned32 | V | | | M,P | +| High-Priority-Access-Info | 1541 | 5.2.3.36 | Unsigned32 | V | | | M,P | +| NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. | | | | | | | | +| NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. | | | | | | | | + +The following table describes the Diameter AVPs re-used by the SWd interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within SWd. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol defined in IETF RFC 6733 [58], do not need to be supported. + +**Table 6.2.3.1/2: SWd re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | M-bit | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|-------------------------------------------------------------------------------------------|--------------| +| Accounting-Interim-Interval | IETF RFC 6733 [58] | | | +| Auth-Request-Type | IETF RFC 6733 [58] | | | +| Calling-Station-Id | IETF RFC 4005 [6] | | | +| Subscription-ID | IETF RFC 4006 [20] | | Must not set | +| EAP-Master-Session-Key | IETF RFC 4072 [5] | | | +| EAP-Payload | IETF RFC 4072 [5] | | | +| RAT-Type | 3GPP TS 29.212 [23] | | | +| Re-Auth-Request-Type | IETF RFC 6733 [58] | | | +| Session-Timeout | IETF RFC 6733 [58] | | | +| User-Name | IETF RFC 6733 [58] | | | +| Terminal-Information | 3GPP TS 29.272 [29] | | | +| APN-OI-Replacement | 3GPP TS 29.272 [29] | | | +| Supported-Features | 3GPP TS 29.229 [24] | See NOTE 1. | | +| Feature-List-ID | 3GPP TS 29.229 [24] | See NOTE 1. | | +| Feature-List | 3GPP TS 29.229 [24] | See NOTE 1. | | +| PDN-Type | 3GPP TS 29.272 [29] | | | +| Served-Party-IP-Address | 3GPP TS 32.299 [30] | | | +| DRMP | IETF RFC 7944 [53] | See clause 8.2.3.25 | Must not set | +| ERP-RK-Request | IETF RFC 6942 [57] | | Must not set | +| ERP-Realm | IETF RFC 6942 [57] | | Must not set | +| Key | IETF RFC 6734 [56] | This is a grouped AVP containing Key-Type, Keying-Material and, optionally, Key-Lifetime. | Must not set | +| MPS-Priority | 3GPP TS 29.272 [29] | | Must not set | +| NOTE 1: There is no separate Diameter application ID defined for the SWd interface so a separate supported feature list is not required. The supported features depend on the command being proxied over SWd. | | | | +| NOTE 2: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. | | | | +| NOTE 3: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. | | | | + +Only those AVP initially defined in this reference point and for this procedure are described in the following clauses. + +## 7 SWm Description + +### 7.1 Functionality + +#### 7.1.1 General + +The SWm reference point is defined between the ePDG and the 3GPP AAA Server or between the ePDG and the 3GPP AAA Proxy. The definition of the reference point and its functionality is given in 3GPP TS 23.402 [3]. + +The SWm reference point shall be used to authenticate and authorize the UE. + +The SWm reference point is also used to transport NBM related mobility parameters in a case the UE attaches to the EPC via the S2b (based on PMIPv6 or GTPv2) and SWn reference points (i.e. IP Mobility Mode Selection information). + +Additionally the SWm reference point may also be used to transport DSMIPv6 related mobility parameters in case the UE attaches to the EPC using the S2c reference point. In particular, in this case the SWm reference point may be used for conveying the Home Agent IP address or FQDN from the AAA server to the ePDG for Home Agent discovery based on IKEv2 (see TS 24.303 [13]). + +## 7.1.2 Procedures Description + +### 7.1.2.1 Authentication and Authorization Procedures + +#### 7.1.2.1.1 General + +The authentication and authorization procedure shall be used between the ePDG and 3GPP AAA Server/Proxy. When a PDN connection is activated by the UE an IKEv2 exchange shall be initiated. It shall be invoked by the ePDG, on receipt from the UE of a "tunnel establishment request" message. This shall take the form of forwarding an IKEv2 exchange with the purpose of authenticating in order to set up an IKE Security Association (SA) between the UE and the ePDG. + +During the Access Authentication and Authorization procedure the ePDG may provide information on its PMIPv6 or GTPv2 capabilities to the 3GPP AAA Server. The 3GPP AAA Server may perform IP mobility mode selection between NBM or HBM as specified in clause 4.1.3.2 of 3GPP TS 23.402 [3]. The 3GPP AAA Server may provide to the ePDG an indication if either NBM or local IP address assignment shall be used. If NBM shall be used, the ePDG then decides the S2b protocol variant to use. + +The User-Name AVP may contain a decorated NAI (as defined in clause 19.3.3 of 3GPP TS 23.003 [14]). In this case the 3GPP AAA Proxy shall process the decorated NAI and support routing of the Diameter request messages based on the decorated NAI as described in IETF RFC 5729 [37]. + +Upon a successful authorization, when NBM is used, the 3GPP AAA server shall return NBM related information back to the ePDG. This information may include the assigned PDN GW, UE IPv6 HNP and/or UE IPv4-HoA. + +Upon a successful authorization, when DSMIPv6 is used, to enable HA address discovery based on IKEv2 (see TS 24.303 [13]), the 3GPP AAA server may also download PDN GW identity to the ePDG. + +The PDN GW identity is a FQDN and/or IP address of the PDN GW. If a FQDN is provided, the ePDG shall derive it to IP address according to the selected mobility management protocol. + +If DSMIPv6 is used, a single IKE SA is used for all PDN connections of the user. If PMIPv6 or GTPv2 is used, a separate IKE SA is created for each PDN connection of the user (refer to 3GPP TS 24.302 [26]). + +Each new additional IKE SA shall be handled in a different Diameter session. In such cases, the IP mobility mode selected during the first authentication and authorization procedure is valid for all PDN connections of the user, therefore, dynamic IP mobility mode selection is not executed during the further procedures. The ePDG may select the same or different S2b protocol variant(s) towards different PDN GWs when NBM has been selected. + +Based on local policies, EPC access for emergency services over an untrusted WLAN access is supported as specified in clause 4.5.7.2.1 of 3GPP TS 23.402 [3] for: + +- UEs with a valid EPC subscription that are authenticated and authorized for EPC services; +- UEs that are authenticated only; +- UEs with an unauthenticated IMSI; and/or +- UICC-less UEs. + +The SWm reference point shall perform authentication and authorization based on the reuse of the DER/DEA command set defined in Diameter EAP application, IETF RFC 4072 [5]. + +**Table 7.1.2.1.1/1: Authentication and Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|----------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes, if it contains a NAI other than an Emergency NAI for Limited Service State. | +| EAP payload | EAP-Payload | M | This information element shall contain the encapsulated EAP payload used for the UE - 3GPP AAA Server mutual authentication | +| Authentication Request Type | Auth-Request-Type | M | This information element shall indicate whether the user is to be authenticated only, authorized only or both. It shall have the value of AUTHORIZE_AUTHENTICATE. | +| APN | Service-Selection | C | This information element shall contain the Network Identifier part of the APN for which the UE is requesting authorization. This AVP shall be present if the ePDG has received an APN from the UE and the UE did not indicate the establishment of an emergency session in the IKEv2 signalling. This AVP shall be absent if the UE indicated the establishment of an emergency session during the IKEv2 tunnel establishment (see clause 7.2.5 of 3GPP TS 24.302 [26]). | +| Visited Network Identifier (See 9.2.3.1.2) | Visited-Network-Identifier | C | This information element shall contain the identifier that allows the home network to identify the Visited Network.
This AVP shall be present if the ePDG is not in the UE's home network i.e. the UE is roaming. | +| Access Type | RAT-Type | C | This information element shall be present if the access type is known by the ePDG. If present, it shall contain the non-3GPP access network access technology type that is serving the UE. When not known by the ePDG, this information element should be present and, in that case, it shall take the value VIRTUAL (1). | +| Mobility features | MIP6-Feature-Vector | O | This AVP shall be present, if the handling of any of the flags listed here requires dynamic (i.e. per user) handling for the VPLMN-HPLMN relation of the ePDG and 3GPP AAA Server. If present, the AVP shall contain the mobility features supported by the ePDG. Flags that are not relevant in the actual relation shall be set to zero.
If dynamic IP mobility mode selection is used, the PMIP6_SUPPORTED flag and/or the GTPv2_SUPPORTED flag shall be set by the ePDG if PMIPv6 and/or GTPv2 are supported. PMIP6_SUPPORTED flag is defined in IETF RFC 5779 [2].
The MIP6_INTEGRATED flag shall be used to indicate to the 3GPP AAA server that the ePDG supports IKEv2 based Home Agent address discovery. | +| AAA Failure Indication | AAA-Failure-Indication | O | If present, this information element shall indicate that the request is sent after the ePDG has determined that a previously assigned 3GPP AAA Server is unavailable. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| UE local IP address | UE-Local-IP-Address | O | The ePDG shall include this IE based on local policy for Fixed Broadband access network interworking as specified in 3GPP TS 23.139 [39].
The ePDG may also include this IE, regardless of Fixed Broadband access network interworking.
If present, it shall contain the source IPv4 or IPv6 address of the IKE_SA_AUTH message from the UE. | +| Terminal Information | Terminal-Information | C | The ePDG shall include this IE and set it to the user's Mobile Equipment Identity, if this information is available.
For an untrusted WLAN access, this grouped AVP shall contain the IMEI AVP and, if available, the Software-Version AVP.
When the RAT type is not known by the ePDG, but the UE has provided the IMEI(SV), this grouped AVP shall contain the IMEI AVP and, if available, the Software-Version AVP. | +| Emergency Services | Emergency-Services | C | An ePDG which supports emergency services shall include this information element, with the Emergency-Indication bit set, if the UE indicated the establishment of an emergency session during the IKEv2 tunnel establishment (see clause 7.2.5 of 3GPP TS 24.302 [26]). | +| High Priority Access Info | High-Priority-Access-Info | C | Based on operator policy, this information element shall be sent to the 3GPP AAA Server if the UE has access priority as described in 3GPP TS 24.302 [26]. | + +| | | | | +|--|--|--|--| +| | | | | +|--|--|--|--| + +**Table 7.1.2.1.1/2: Authentication and Authorization Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|----------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | O | This information element, if present, shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes, if it contains a NAI other than an Emergency NAI for Limited Service State. | +| EAP payload | EAP-Payload | O | If present, this information element shall contain the encapsulated EAP payload used for UE - 3GPP AAA Server mutual authentication | +| Master-Session-Key | EAP-Master-Session-Key | C | This IE shall contain keying material for protecting the communication between the user and the ePDG. It shall be present when Result Code is set to DIAMETER_SUCCESS. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result code | Result-Code / Experimental-Result-Code | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]) or as per in NASREQ (see IETF RFC 4005 [4]). | +| 3GPP AAA Server URI | Redirect-Host | C | This information element shall be sent if the Result-Code value is set to DIAMETER_REDIRECT_INDICATION. When the user has previously been authenticated by another 3GPP AAA Server, it shall contain the Diameter URI of the 3GPP AAA Server currently serving the user. The node receiving this IE shall behave as defined in the Diameter base protocol (see IETF RFC 6733 [58]). The command shall contain zero or more occurrences of this information element. When choosing a destination for the redirected message from multiple Redirect-Host AVPs, the receiver shall send the Diameter request to the first 3GPP AAA Server in the ordered list received in the Diameter response. If no successful response to the Diameter request is received, the receiver shall send the Diameter request to the next 3GPP AAA Server in the ordered list. This procedure shall be repeated until a successful response is received from a 3GPP AAA Server. | +| Mobility Capabilities | MIP6-Feature-Vector | O | This AVP shall be present if it was received in the authentication and authorization request and the authentication and authorization succeeded. It shall contain the authorized mobility features. Flags that are not relevant in the actual relation shall be set to zero.
The PMIP6_SUPPORTED flag and/or the GTPv2_SUPPORTED flag shall be set to indicate that NBM (PMIPv6 or GTPv2) is to be used. The ASSIGN_LOCAL_IP flag shall be set to indicate that a local IP address is to be assigned.
The MIP6_INTEGRATED flag shall be set if a Home Agent address is provided for IKEv2 based Home Agent address discovery. In the latter case HA information for IKEv2 discovery is provided via the APN-Configuration AVP. | +| APN-OI replacement | APN-OI-Replacement | C | This AVP shall indicate the domain name to replace the APN-OI in the non-roaming case or in the home routed roaming case when constructing the PDN GW FQDN upon which it needs to perform a DNS resolution. See 3GPP TS 23.003 [3]. It shall only be included if NBM is used, the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Request and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| APN and PGW Data | APN-Configuration | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS and the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Request.
The APN-Configuration is a grouped AVP, defined in 3GPP TS 29.272 [29]. When NBM is used, the following information elements per APN may be included:
  • - APN
  • - APN-AMBR
  • - Authorized 3GPP QoS Profile
  • - User home IP Address (if static IPv4 and/or IPv6 is allocated to the UE's subscribed APN)
  • - Allowed PDN types
  • - PDN GW identity (if the PDN connection was active in case of HO, or if there is a static PDN GW allocated to the UE's subscribed APN)
  • - PDN GW allocation type
  • - VPLMN Dynamic Address Allowed
| + +| | | | | +|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
  • - Visited Network Identifier
  • - Interworking-5GS-Indicator

When local IP address assignment is used, this AVP shall only be present if IKEv2 based Home Agent discovery is used and

  • - if the PDN connection was active in case of HO, or
  • - if there is static PDN GW allocated to the UE's subscribed APN, or
  • - if the 3GPP AAA Server/Proxy selects the PDN GW based on the identity of the ePDG

In these cases, the following information elements shall be included:

  • - HA-APN (Home Agent APN as defined in 3GPP TS 23.003 [14])
  • - PDN GW identity

NOTE 1.

| +|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | +|----------------------------------------------|-------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Trace information | Trace-Info | C | This AVP shall be included if the subscriber and equipment trace has been activated for the user in the HSS and signalling based activation is used to download the trace activation from the HSS to the ePDG.
Only the Trace-Data AVP shall be included to the Trace-Info AVP and shall contain the following AVPs:
- Trace-Reference
- Trace-Depth
- Trace-Event-List, for PGW
- Trace-Collection-Entity
The following AVPs may also be included in the Trace-Data AVP:
- Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
- Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required. | +| MSISDN | Subscription-ID | C | This AVP shall contain the MSISDN of the UE and shall be sent only if it is available. | +| Session time | Session-Timeout | C | If the authorization succeeded, then this IE shall contain the time this authorization is valid for. | +| Permanent User Identity | Mobile-Node-Identifier | C | This information element shall be present if NBM is used.

If the user is authenticated, it shall contain an AAA/HSS assigned permanent user identity (i.e. IMSI in root NAI format as defined in clause 19 of 3GPP TS 23.003 [14]) to be used by:
- the MAG in subsequent PBUs as the MN-ID identifying the user in the EPS network for PMIP based S2b,
- by the ePDG to derive the IMSI to send in subsequent Create Session Request for GTP based S2b.

For an emergency PDN connection, if the UE is UICC-less (i.e. the User Identity IE in the request contains an IMEI) or if the IMSI is not authenticated, the Permanent User Identity shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14].

If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Serving GW Address | MIP6-Agent-Info | O | This AVP shall be used only in chained S2b-S8 cases and it shall be sent only if the Result-Code AVP is set to DIAMETER_SUCCESS. | +| UE Charging Data | 3GPP-Charging-Characteristics | O | This information element contains the type of charging method to be applied to the user (see 3GPP TS 29.061 [31]). | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| WLAN Location Information | Access-Network-Info | O | If present, this IE shall contain the location information of the WLAN Access Network where the UE is attached. | +| WLAN Location Timestamp | User-Location-Info-Time | C | This IE should be present if the WLAN Location Information IE is present. When present, this IE shall contain the NTP time at which the UE was last known to be in the location reported in the WLAN Location Information. | +| Emergency Info | Emergency-Info | C | This IE shall only be present if the Result-Code AVP is set to DIAMETER_SUCCESS. When present, it shall contain the identity of the dynamically allocated PDN-GW used for the establishment of emergency PDN connections. It shall be present for a non-roaming authenticated user, if this information was received from the HSS and if the Emergency-Services AVP is present, with the Emergency-Indication bit set, in the Authentication and Authorization Request. | +| UE Usage Type | UE-Usage-Type | C | This IE shall be present if this information is available in the user subscription. When present, this IE shall contain the UE Usage Type of the subscriber. | +| Core Network Restrictions | Core-Network-Restrictions | C | This IE shall be present if this information is available in the user subscription. When present, this IE shall contain the Core Network Restrictions of the subscriber. | +| MPS Priority | MPS-Priority | C | Based on operator policy, this information element shall be sent to the ePDG if the UE has an MPS subscription in the HSS. | + +NOTE 1: If a static PDN GW allocated to the UE's subscribed APN has been received from the HSS, the 3GPP AAA Server/Proxy shall only provide the static PDN GW identity in the Authentication and Authorization Answer. + +#### 7.1.2.1.2 3GPP AAA Server Detailed Behaviour + +On receipt of the DER message, the 3GPP AAA Server shall check that the user data exists in the 3GPP AAA Server. If not, the 3GPP AAA Server shall use the procedures defined for the SWx interface to obtain access authentication and authorization data. + +If the HSS returns DIAMETER\_ERROR\_USER\_UNKNOWN, the 3GPP AAA Server shall return the same error to the ePDG. + +If the HSS indicates that the user is currently being served by a different 3GPP AAA Server, the 3GPP AAA Server shall respond to the ePDG with the Result-Code set to DIAMETER\_REDIRECT\_INDICATION and Redirect-Host set to the Diameter URI of the 3GPP AAA Server currently serving the user (this Diameter URI shall be constructed based on the Diameter Identity included in the 3GPP-AAA-Server-Name AVP returned in the SWx authentication response from the HSS). + +Otherwise, the 3GPP AAA Server shall proceed with the authentication and authorization procedure. The 3GPP AAA Server shall use the procedures defined in SWx interface to obtain authorization data from HSS. + +If IMEI check is required by operator policy and the ePDG is in the HPLMN, the 3GPP AAA Server shall: + +- if the IMEI(SV) is available, check the Mobile Equipment's identity status with the EIR, using the ME Identity Check procedure (see clause 11); +- upon getting the IMEI check result from the EIR, determine whether to continue or stop the authentication and authorization procedure; +- if the IMEI(SV) is not available, determine whether to continue or stop the authentication and authorization procedure based on operator policy; +- if the 3GPP AAA Server determines that the authentication and authorization procedure shall be stopped, it shall respond to the ePDG with the Experimental-Result-Code DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT. + +Specific operator policies may be configured for emergency services, regarding whether to check the IMEI and, if the IMEI needs to be checked, whether to continue or stop the authentication and authorization procedure upon getting the IMEI check result or when the IMEI(SV) is not available. + +If the 3GPP AAA Server receives a request message not related to any existing session and is able to recognize that the ePDG included the AAA-Failure-Indication AVP in the request, the 3GPP AAA Server shall also include the AAA-Failure-Indication AVP over the SWx interface, while retrieving the access authentication and authorization data from the HSS. + +If the user does not have non-3GPP access subscription, then 3GPP AAA Server shall respond to the ePDG with Experimental-Result-Code DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION. + +If a Visited- Network-Identifier is present in the request and if the user is not allowed to roam in the visited network, then the 3GPP AAA Server shall return Experimental-Result-Code set to DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED. + +If the user is not allowed to use the current access type, then the 3GPP AAA Server shall return Experimental-Result-Code set to DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED. + +Otherwise the 3GPP AAA Server shall run EAP-AKA as specified in 3GPP TS 33.402 [19]. Exceptions to the cases specified here shall be treated by 3GPP AAA Server as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and, therefore, no authentication information shall be returned. + +Upon receiving the authentication and authorization request from the ePDG, the 3GPP AAA Server marks the trust relationship as "untrusted" with the User Identity. If the 3GPP AAA Server detects that an S6b session already exists for this UE and the S6b session was established as a result of an authentication request for DSMIPv6, the 3GPP AAA Server shall send the trust relationship to the PDN GW as specified in clause 9.1.2.5. + +Once authentication is successfully completed, the 3GPP AAA Server shall perform the following authorization checking (if there is an error in any of the steps, the 3GPP AAA Server shall stop processing and return the corresponding error code): + +- 1) Check if the user is barred to use the non 3GPP Access. If it is so, then the Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED +- 2) Check whether the user is barred to use the subscribed APNs. If it is so, Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED. +- 3) if the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Request, check if there was request for an APN received. If not, the default APN of the user is selected to be used during the actual authentication and authorization procedure. +- 4) if the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authentication and Authorization Request, check if user has a subscription for the requested APN or for the wildcard APN. If not, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_NO\_APN\_SUBSCRIPTION +- 5) If present, check the flags of the received MIP6-Feature-Vector AVP: The evaluation of the flags is executed only in the first authentication and authorization procedure for the user after an initial attach or handover, in all the subsequent procedures, the AAA Server shall insert the same values. + - If the MIP6\_INTEGRATED flag is set and the 3GPP AAA server has authorized IKEv2 Home Agent assignment, the 3GPP AAA server shall include the Home Agent addresses in the APN-Configuration AVP in the response and the MIP6-Feature-Vector AVP with the MIP6\_INTEGRATED flag set. In this case, the 3GPP AAA Server may select the Home Agent based on the identity of the ePDG as included in the Origin-Host AVP in the authentication and authorization request if no static PDN GW identity is received from the HSS. If the HA assignment via IKEv2 is not used, the MIP6-Feature-Vector AVP with the MIP6\_INTEGRATED flag not set shall be sent. + - The PMIP6\_SUPPORTED and/or GTPv2\_SUPPORTED flag indicates to the 3GPP AAA server whether the ePDG supports NBM or not. As specified in 3GPP TS 23.402 [3], based on the information it has regarding the UE (see 3GPP TS 24.302 [26]), local/home network capabilities and local/home network policies, the 3GPP AAA server may perform mobility mode selection. If the 3GPP AAA server decides that NBM should be used, the PMIP6\_SUPPORTED and GTPv2\_SUPPORTED flags shall be set in the response to indicate the NBM support of the UE to the ePDG. If only the PMIP6\_SUPPORTED or the GTPv2\_SUPPORTED flag is present in the response, the ePDG shall assume that this also indicates the NBM support of the UE to the ePDG and the ePDG may select any S2b protocol variant (PMIPv6 or GTPv2). If the 3GPP AAA server decides that a local IP address should be assigned, the ASSIGN\_LOCAL\_IP flag shall be set in the response to indicate to the ePDG that a local IP address should be assigned. + +NOTE 1: When selecting DSMIPv6, the AAA server assumes that the ePDG has the capability to assign a local IP address to the UE. + +- The 3GPP AAA server shall not set the PMIP6\_SUPPORTED/GTPv2\_SUPPORTED and ASSIGN\_LOCAL\_IP flags both at the same time in the response. + +Upon successful authentication and authorization, the Result-Code shall be set to DIAMETER\_SUCCESS and: + +- if the Emergency-Indication bit of the Emergency-Services AVP was not set in the Authentication and Authorization Request, the 3GPP AAA Server shall return user data relevant to the APN as received from the HSS. If the requested APN received from UE is authorized by the wildcard APN, the 3GPP AAA Server shall include the wildcard APN in the Service-Selection AVP of the APN-Configuration AVP; +- if the Emergency-Services AVP was present, with the Emergency-Indication bit set, in the Authentication and Authorization Request, the 3GPP AAA Server shall include the Emergency Info IE if this information was received from the HSS and the user is not roaming. + +Exceptions to the cases specified here shall be treated by 3GPP AAA Server as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and, therefore, no authorization information shall be returned. + +For Fixed Broadband access network interworking as specified in 3GPP TS 23.139 [39], the 3GPP AAA server shall determine if the UE is connected via a BBF-defined WLAN access according to the UE local IP address in UE-Local- + +IP-Address AVP from the ePDG. If the UE is connected via a BBF-defined WLAN access, the 3GPP AAA server shall perform the enabling UE reflective QoS function as specified in 3GPP TS 24.139 [43]. + +The 3GPP AAA Server shall interpret the receipt of the Emergency-Services AVP, with the Emergency-Indication bit set, as an indication that the UE requests to access the EPC for emergency services. + +The 3GPP AAA Server shall give preferential treatment to UEs which access the EPC for emergency services, e.g. in scenarios including network overload. + +If the 3GPP AAA Server has WLAN Location Information about the UE, the 3GPP AAA Server shall provide it to the ePDG, along with the WLAN Location Timestamp if available (see clause 4.1.2.1.2). + +If the 3GPP AAA Server supports IMS Emergency sessions over WLAN (see clause 4.5.7.2 of 3GPP TS 23.402 [3]), the 3GPP AAA Server shall proceed as specified above, but with the following modifications, for an Emergency Attach: + +1) if the UE does not have an IMSI: + +- if local policies allow emergency sessions for all UEs, the 3GPP AAA Server shall skip the procedures defined for the SWx interface to obtain access authentication and authorization data, skip the authorization checkings and authorize the UE to access to EPC for emergency services. The Permanent User Identity IE in the answer shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14]; +- otherwise the 3GPP AAA Server shall reject the request with the Experimental-Result-Code set to DIAMETER\_ERROR\_USER\_UNKNOWN. + +2) if the UE has an IMSI but the IMSI is not authenticated: + +- if local policies allow emergency sessions for unauthenticated UEs with an IMSI, the 3GPP AAA Server shall skip the procedures defined for the SWx interface to obtain access authorization data, shall skip the authorization checkings and shall return an answer with the DIAMETER\_ERROR\_USER\_UNKNOWN Result-Code to the ePDG to request the UE to provide its IMEI as specified in clause 13.3 of 3GPP TS 23.402 [19]. + +NOTE 2: According to the procedure specified in clause 7.4.4 of 3GPP TS 24.302 [26], this results in an ePDG, that is configured to support unauthenticated emergency session over WLAN and Mobile Equipment Identity signalling over untrusted WLAN, to query the UE's IMSI and to initiate a new Authentication and Authorization procedure with the same parameters as provided in the first Authentication and Authorization Request but with the addition of the UE's IMEI in the Terminal-Information AVP. + +If the Authentication and Authorization Request also included the UE's IMEI (i.e. new authentication and authorization procedure after the ePDG queried the UE), the 3GPP AAA Server shall authorize the UE to access to EPC for emergency services. The Permanent User Identity IE in the answer shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14]; + +- otherwise the 3GPP AAA Server shall reject the request with the Experimental-Result-Code set as specified for authentication failures in this clause. + +3) if the UE has an authenticated IMSI but the UE is not authorized to access the EPC: + +- if local policies allow emergency sessions for any authenticated UE, the 3GPP AAA Server shall authorize the UE to access to EPC for emergency services; +- otherwise the 3GPP AAA Server shall reject the request with the Experimental-Result-Code set as specified for authorization failures in this clause. + +If 3GPP AAA Server receives a DER command from the ePDG containing a High-Priority-Access-Info AVP with the HPA\_Configured bit set, if allowed by operator policy, the 3GPP AAA Server shall treat the message and all subsequent messages (if authentication is successful) for the UE with priority as specified in Annex C and Annex D. + +NOTE 3: Alternatively, the 3GPP AAA Server can give priority to this UE after the 3GPP AAA Server has successfully authenticated the UE as described in clause 8.1.2.3.3, at which time the 3GPP AAA Server handles all subsequent messages with priority. + +NOTE 4: The 3GPP AAA Server treats the UE with priority if either the DER command from the ePDG indicates high priority access or the HSS has indicated an MPS subscription for the UE. + +Based on operator policy, the 3GPP AAA Server shall include the MPS-Priority AVP with the MPS-EPS-Priority bit set with the DEA command if the HSS has indicated an MPS subscription for the UE. + +#### 7.1.2.1.3 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy shall be required to handle roaming cases in which the ePDG is in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy with the following additions. + +If IMEI check is required by operator policy and the ePDG is in the VPLMN, the 3GPP AAA Proxy shall: + +- if the IMEI(SV) is available, check the Mobile Equipment's identity status with the EIR, using the ME Identity Check procedure (see clause 11); + - upon getting the IMEI check result from the EIR, determine whether to continue or stop the authentication and authorization procedure; +- if the IMEI(SV) is not available, determine whether to continue or stop the authentication and authorization procedure based on operator policy; +- if the 3GPP AAA Proxy determines that the authentication and authorization procedure shall be stopped, it shall: + - respond to the ePDG with the Experimental-Result-Code DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT, and + - send a SWm Session Termination Request towards the 3GPP AAA Server (see clause 7.1.2.3). + +Specific operator policies may be configured for emergency services, regarding whether to check the IMEI and, if the IMEI needs to be checked, whether to continue or stop the authentication and authorization procedure upon getting the IMEI check result or when the IMEI(SV) is not available. + +On receipt of the first authentication and authorization request, the 3GPP AAA Proxy shall check locally configured information whether users from the HPLMN are allowed to activate a PDN connection from the non-3GPP access network via this (V)PLMN. If not, the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the authentication response shall be sent to the ePDG. + +On receipt of the authentication and authorization answer that completes a successful authentication, the 3GPP AAA Proxy + +- may check locally configured information about using the chained S8-S2b option towards the given HPLMN. If chaining is required, the 3GPP AAA Proxy shall select a Serving GW from its network configuration database and shall include the Serving GW address in the response. +- shall check locally configured information for the maximum allowed static QoS parameters valid for visitors from the given HPLMN and modify the QoS parameters received from the 3GPP AAA Server, to enforce the policy limitations. +- shall record the state of the connection (i.e. Authorization Successful). +- may select the Home Agent based on the identity of the ePDG as included in the Origin-Host AVP in the authentication and authorization request if IKEv2 based Home Agent discovery is used and VPLMN Dynamic Address Allowed AVP is received. In this case, the 3GPP AAA proxy shall include the Home Agent addresses in the APN-Configuration AVP in the response and the MIP6-Feature-Vector AVP with the MIP6-INTEGRATED flag set if no static PDN GW identity is received from the 3GPP AAA Server. + +#### 7.1.2.1.4 ePDG Detailed Behaviour + +The ePDG shall initiate a new authentication and authorization procedure for each new IKE\_SA. Each IKE\_SA shall be handled in a different session. + +The ePDG shall set flags signalling its capabilities to the same value in all authentication and authorization procedure for the same user (include the same MIP6-Feature-Vector). During the second and further authentication and + +authorization procedures, the ePDG shall discard the flag values received from the AAA Server and reuse the values received during the first procedure executed for the user. + +An ePDG which supports emergency services shall include the Emergency-Services AVP, with the Emergency-Indication bit set, if the UE indicated the establishment of an emergency session during the IKEv2 tunnel establishment (see clause 7.2.5 of 3GPP TS 24.302 [26]). + +For PMIPv6/GTPv2 based S2b, when receiving a Serving GW address in an authentication response, the ePDG shall check, whether it has already a Serving GW address stored for the user. + +- If it has no Serving GW address available, it shall store the received value and use it as LMA address when creating PMIP bindings. +- If it has already a stored Serving GW address value, it shall ignore the received SGW-Address AVP. + +NOTE 1: In case of untrusted access, there is an authentication session started for all PDN connection setup requests of a user. These sessions may invoke different 3GPP AAA Proxies, which in turn may assign different Serving GWs to the user. The ePDG behaviour ensures that in spite of this possibility, the same Serving GW is used for all PDN connections of the user. + +NOTE 2: The ePDG knows if NBM is used or if a local IP address is assigned based on the flags in the MIP6-Feature-Vector or based on preconfigured information. If the PMIP6\_SUPPORTED and/or the GTPv2\_SUPPORTED flag is set in the MIP6-Feature-Vector received from the 3GPP AAA Server, the ePDG knows that NBM is used. + +For PMIPv6/GTPv2 based S2b and a PDN connection other than for emergency services, the ePDG shall utilize the downloaded APN configuration data to authorize the UE requested home address types: IPv4 home address and/or IPv6 home network prefix. + +For GTPv2 based S2b and a PDN connection for emergency services, the ePDG shall ignore APN configuration data received from the 3GPP AAA Server and shall use its Emergency Configuration Data to determine the APN to be associated with the emergency PDN connection and possibly the PGW to use (see clause 4.5.7.2 of 3GPP TS 23.402 [3]). During a handover of an emergency PDN connection to an untrusted WLAN access, the ePDG shall use the PGW identified in the Emergency Info IE if this information is received from the 3GPP AAA Server, the user is a non-roaming authenticated user and the ePDG is configured to use a dynamic PGW for emergency services for such users. + +The ePDG may use the Visited\_Network\_Identifier to determine the S2b protocol type (PMIPv6 or GTPv2). The ePDG may be configured with the S2b protocol variant(s) on a per HPLMN granularity, or may retrieve information regarding the S2b protocol variants supported by the PDN GW (PMIPv6 or/and GTPv2) from the Domain Name Service Function as described in 3GPP TS 29.303[34]. If the ePDG supports Dedicated Core Networks and received the UE-Usage-Type from the 3GPP AAA Server, the ePDG shall select the PGW as specified in clause 5.8 of 3GPP TS 29.303 [34]. + +The ePDG shall select a SMF+PGW-C for PDN connections that may be subject to mobility to 5GS, e.g. for UEs supporting N1 mode (see 3GPP TS 24.302 [26]) and not restricted to interworking with 5GS by user subscription (see "5GC" bit within Core-Network-Restrictions AVP and Interworking-5GS-Indicator AVP specified) as specified in clause 5.12.3 of 3GPP TS 29.303 [34]. + +If GTPv2 is used on S2b and if the Trace-Info AVP including Trace-Data has been received in the authorization response, the ePDG shall send a GTPv2 Trace Session Activation message (see 3GPP TS 29.274 [38]) to the PGW to start a trace session for the user. + +If DSMIPv6 is used and if ePDG has received the PGW identity in form of the FQDN from the 3GPP AAA server, then the ePDG may obtain the IP address of the Home Agent functionality of that PGW as described in 3GPP TS 29.303 [34]. + +If the ePDG determines that a previously assigned 3GPP AAA Server is unavailable, it may attempt to send a new authentication and authorization request to an alternate 3GPP AAA Server. If the ePDG receives from this new server a redirect indication towards the former server (due to the HSS having stored the former 3GPP AAA Server identity), it shall terminate all previously existing sessions and PDN connections for that user, and it shall re-send again the request towards the new server, but it shall include the AAA-Failure-Indication AVP in the new request. + +The ePDG shall give preferential treatment to UEs which access the EPC for emergency services, e.g. in scenarios including network overload. + +The ePDG shall store the WLAN Location Information associated with the UE when it receives such information from the 3GPP AAA Server. + +If IMEI check is required by operator policy, the ePDG shall be configured to retrieve the IMEI(SV) from the UE (as specified in 3GPP TS 23.402 [26]) during the authentication and authorization procedure. + +If the ePDG supports IMS Emergency sessions over WLAN (see clause 4.5.7.2 of 3GPP TS 23.402 [3]) and if local policies in the ePDG allows unauthenticated emergency sessions, the ePDG shall proceed during an Emergency Attach for a UE without a UICC or with an unauthenticated IMSI as specified above with the following modifications: + +- 1) If the UE is UICC-less, the User Identity IE in the Authentication and Authorization Request shall contain the IMEI in Emergency NAI for Limited Service State format as defined in clause 19 of 3GPP TS 23.003 [14]. +- 2) If the User Identity IE does not contain an IMEI (i.e. the UE has an IMSI), the ePDG shall request the IMEI from the UE as specified in clause 13.3 of 3GPP TS 33.402 [19] and clause 7.4.4 of 3GPP TS 24.302 [26] and include the IMEI in the Terminal-Information AVP in the next Authentication and Authorization Request message. + +The Authentication and Authorization Request in step 8 of clause 13.3 of 3GPP TS 33.402 [19] (i.e. after querying the UE's IMSI) shall contain the same parameters as provided in the first Authentication and Authorization Request (step 3) but with the addition of the IMEI in the Terminal-Information AVP. + +NOTE 3: The IMEI cannot be signalled to the 3GPP AAA Server in the first Authentication and Authorization Request sent to the 3GPP AAA Server, since the ePDG requests the IMEI to the UE in the first IKE\_AUTH\_Response message after getting the first Authentication and Authorization Answer from the 3GPP AAA Server. + +NOTE 4: The Authentication and Authorization Requests in steps 3 and 8 of clause 13.3 of 3GPP TS 33.402 [19] are handled independently from each other by the 3GPP AAA Server. + +- 3) If the Permanent User Identity IE in the answer contains an IMEI based NAI but the User Identity IE in the request did not contain an IMEI based NAI, the ePDG shall derive that the IMSI was not authenticated and proceed accordingly with the setup of the Emergency PDN connection over S2b (see 3GPP TS 29.274 [38]). + +When sending a DER command to the 3GPP AAA Server, if the ePDG had received an indication that the UE has access priority in an IKE\_AUTH request message as described in 3GPP TS 24.302 [26] and if allowed by operator policy, the ePDG shall add a High-Priority-Access-Info AVP with the HPA\_Configured bit set, to the DER command. + +If the ePDG receives a DEA command with the MPS-Priority AVP with the MPS-EPS-Priority bit set, the ePDG shall treat the message and all subsequent messages (if authentication is successful) for the UE with priority as specified in Annex C and Annex D. The ePDG shall discontinue priority treatment for the UE if the ePDG receives a Non-3GPP-User-Data AVP without an MPS-Priority AVP with the MPS-EPS-Priority bit set and ePDG has not received an indication that the UE has access priority from the UE in an IKE\_AUTH message as described in 3GPP TS 24.302 [26]. + +NOTE 5: The ePDG treats the UE with priority if either the indication that the UE has access priority in an IKE\_AUTH request message or the HSS has indicated an MPS subscription for the UE. + +## 7.1.2.2 Authorization Procedures + +### 7.1.2.2.1 General + +This procedure shall be used between the ePDG and 3GPP AAA Server and Proxy. It shall be invoked by the ePDG, upon receipt of a valid Re-Authorization Request message from the 3GPP AAA Server (see clause 7.1.2.5). It may also be initiated by the ePDG, when the ePDG detects a change of the outer IP address of the UE, to: + +- update the 3GPP AAA Server with the new UE local IP address; and +- retrieve the most up to date WLAN Location Information stored at the 3GPP AAA Server, when the 3GPP AAA server has sent WLAN Location Information during the initial Authentication and Authorization procedure (see clause 4.5.7.2.8 of 3GPP TS 23.402 [3]). + +This procedure shall be used by the ePDG to update the previously provided authorization parameters. This may happen due to a modification of the subscriber profile in the HSS (for example, removal of a specific APN associated with the subscriber, or change of the identity of a dynamically allocated PDN GW, see clause 8.1.2.3). + +This procedure is mapped to the Diameter command codes AA-Request (AAR) and AA-Answer (AAA) specified in RFC 4005 [4]. Information element contents for these messages are shown in tables 7.1.2.2.1/1 and 7.1.2.2.1/2. + +**Table 7.1.2.2.1/1: SWm Authorization Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Request Type | Auth-Request-Type | M | This information element shall contain the type of request. It shall have the value AUTHORIZE_ONLY. | +| AAR Flags | AAR-Flags | O | This IE contains a bit mask. See 7.2.3.5 for the meaning of the bits.

This IE may be present and indicate that the ePDG requests to retrieve the most up to date WLAN Location Information of the UE, if the ePDG received the WLAN Location Information during the initial Authentication and Authorization procedure. | +| UE local IP address | UE-Local-IP-Address | C | This IE shall be present if the ePDG provided the UE Local IP address in the initial Authentication and Authorization Request and the UE Local IP address has changed. | + +**Table 7.1.2.2.1/2: SWm Authorization Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|--------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15], and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_ONLY. See IETF RFC 4072 [5]. | +| Registration Result | Result-Code/Experimental Result Code | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]) or as per in NASREQ (see IETF RFC 4005 [4]). | +| UE IPv4 Home Address | PMIP6-IPv4-Home-Address | O | If the authorization succeeded, and the user has an IPv4-HoA statically defined as part of his profile data, then this IE may be present. It shall contain the IPv4-HoA allocated and assigned to the UE. | +| APN-OI replacement | APN-OI-Replacement | C | This AVP shall indicate the domain name to replace the APN-OI in the non-roaming case or in the home routed roaming case when constructing the PDN GW FQDN upon which it needs to perform a DNS resolution. See 3GPP TS 23.003 [3]. It shall only be included if NBM is used, the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Request, and the Result-Code AVP is set to DIAMETER_SUCCESS. | +| APN and PGW Data | APN-Configuration | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS and the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Request.
APN-Configuration is a grouped AVP, defined in 3GPP TS 29.272 [29]. When NBM is used, the following information elements per APN may be included:
- APN
- APN-AMBR
- Authorized 3GPP QoS profile
- Statically allocated User IP Address (IPv4 and/or IPv6)
- Allowed PDN types
- PDN GW identity
- PDN GW allocation type
- VPLMN Dynamic Address Allowed
- Visited Network Identifier
- Interworking-5GS-Indicator
When local IP address assignment is used, this AVP shall only be present if IKEv2 based Home Agent discovery is used and
- if the PDN connection was active in case of HO, or
- if there is static PDN GW allocated to the UE's subscribed APN.
In these cases, the following information elements shall be included:
- HA-APN (Home Agent APN as defined in 3GPP TS 23.003 [14])
- PDN GW identity | +| Trace information | Trace-Info | C | This AVP shall be included if the subscriber and equipment trace has been activated for the user in the HSS and signalling based activation is used to download the trace activation from the HSS to the ePDG.

Only the Trace-Data AVP shall be included if trace activation is requested. Only the Trace-Reference AVP shall be included if trace deactivation is requested.

If the Trace-Data AVP is included, it shall contain the following AVPs:
- Trace-Reference
- Trace-Depth
- Trace-Event-List, for PGW
- Trace-Collection-Entity
The following AVPs may also be included in the Trace-Data AVP:
- Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
- Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required. | + +| | | | | +|---------------------------|-------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MSISDN | Subscription-ID | C | This AVP shall contain the MSISDN of the UE and shall be sent only if it is available. | +| UE Charging Data | 3GPP-Charging-Characteristics | O | If present, this information element shall contain the type of charging method to be applied to the user (see 3GPP TS 29.061 [31]). | +| Session time | Session-Timeout | C | If the authorization succeeded, then this IE shall contain the time this authorization is valid for. | +| WLAN Location Information | Access-Network-Info | O | If present, this IE shall contain the location information of the WLAN Access Network where the UE is attached. | +| WLAN Location Timestamp | User-Location-Info-Time | C | This IE should be present if the WLAN Location Information IE is present. When present, this IE shall contain the NTP time at which the UE was last known to be in the location reported in the WLAN Location Information. | +| Core Network Restrictions | Core-Network-Restrictions | C | This IE shall be present if this information is available in the user subscription. When present, this IE shall contain the Core Network Restrictions of the subscriber. | +| MPS Priority | MPS-Priority | C | Based on operator policy, this information element shall be sent to the ePDG if the UE has an MPS subscription in the HSS. | + +#### 7.1.2.2.2 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA Server shall process the steps in the following order (if there is an error in any of the steps, the 3GPP AAA Server shall stop processing and return the corresponding error code): + +- 1) Check that the user exists in the 3GPP AAA Server. The check shall be based on Diameter Session-id and User Name. If the Session-Id included in the request does not correspond with any active session, or if an active session is found but it does not belong to the user identified by the User Name parameter, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +- 2) If the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Request, check whether the user is allowed to access the APN. If not, Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED. +- 3) The Result-Code shall be set to DIAMETER\_SUCCESS and, if the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Request, the 3GPP AAA Server shall return user data relevant to the APN as received from the HSS. +- 4) If the WLAN-Location-Info-Request bit is set to 1 in the AAR-Flags AVP and if the 3GPP AAA Server knows the WLAN Location Information of the UE, the 3GPP AAA Server shall provide it to the ePDG, along with the WLAN Location Timestamp if available (see clause 4.1.2.1.2). + +If the Emergency-Indication bit of the Emergency-Services AVP was not set in the initial Authentication and Authorization Request, once the Authentication and Authorization procedure successfully finishes, the 3GPP AAA Server shall download, together with authentication data, the list of authorized APNs and the authorized mobility protocols in the authentication and authorization response from the HSS (see SWx procedure in Clause 8.1.2.1). + +Exceptions to the cases specified here shall be treated by 3GPP AAA Server as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and, therefore, no authorization information shall be returned. + +If the 3GPP AAA Server answers with DIAMETER\_AUTHORIZATION\_REJECTED, it shall terminate locally the associated SWm Diameter session. + +#### 7.1.2.2.3 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy shall be required to handle roaming cases in which the ePDG is in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy, with the following extensions. + +On receipt of the authorization answer, the 3GPP AAA Proxy: + +- Shall check locally configured information for the maximum allowed static QoS parameters valid for visitors from the given HPLMN and modify the QoS parameters received from the 3GPP AAA Server, to enforce the policy limitations. +- Shall record the state of the connection (i.e. Authorization Successful). + +If the 3GPP AAA Proxy receives a DIAMETER\_AUTHORIZATION\_REJECTED response from the 3GPP AAA Server, it shall forward it to the ePDG, and terminate locally the associated SWm Diameter session. + +#### 7.1.2.2.4 ePDG Detailed Behaviour + +Upon receipt of a valid Re-Authorization Request message from the 3GPP AAA Server, the ePDG shall initiate the authorization procedure after successfully completing the authentication of the user. The ePDG shall initiate a separate authorization session for each IKE\_SA of the user. When initiated by the ePDG to retrieve the most up to date WLAN Location Information stored at the 3GPP AAA Server, the ePDG shall initiate the authorization procedure for one IKE\_SA of the user. + +If NBM is used, at successful completion of the procedure, the ePDG shall store the APN configuration data received from the 3GPP AAA Server. The ePDG shall utilize these data to authorize the requested home address types: IPv4 home address and/or IPv6 home network prefix. + +NOTE: The user will be allowed to create PDN connections only to the subscribed APNs and use the address types that are allowed by the subscribed PDN types. + +Upon receiving the authorization response: + +- If NBM is used and if any other Result-Code than DIAMETER\_SUCCESS was received in the response, the ePDG shall release the corresponding PDN connection (PMIPv6 binding or GTPv2 tunnel) and IKE\_SA of the user, and terminate locally the associated SWm Diameter session. +- If DSMIPv6 is used, + - If any other Result-Code than DIAMETER\_SUCCESS was received, the ePDG shall release the corresponding IKE\_SA of the user, and terminate locally the associated SWm Diameter session. + - If the Result-Code DIAMETER\_SUCCESS was received in the response, the ePDG shall update the previously provided authorization parameters. + +NOTE: The ePDG knows if NBM is used or if a local IP address is assigned based on the flags in the MIP6-Feature-Vector received during the initial authentication and authorization procedure or based on preconfigured information. If the PMIP6\_SUPPORTED and/or the GTPv2\_SUPPORTED flag are set in the MIP6-Feature-Vector received from the 3GPP AAA Server, the ePDG knows that NBM is used. + +If GTPv2 is used on S2b and if the Trace-Info AVP including Trace-Data has been received in the authorization response, the ePDG shall send a GTPv2 Trace Session Activation message (see 3GPP TS 29.274 [38]) to the PGW to start a trace session for the user. If the Trace-Info AVP including Trace-Reference (directly under the Trace-Info) has been received in the authorization response, the ePDG shall send a GTPv2 Trace Session Deactivation message to the PGW to stop the ongoing trace session, identified by the Trace-Reference. For details, see 3GPP TS 32.422 [32]. + +If DSMIPv6 is used and if ePDG has received the PGW identity in form of the FQDN from the 3GPP AAA server, then the ePDG may obtain the IP address of the Home Agent functionality of that PGW as described in 3GPP TS 29.303 [34]. + +The ePDG shall store the WLAN Location Information associated with the UE when it receives such information from the 3GPP AAA Server. The ePDG shall delete any stored WLAN Location Information associated with the UE when it receives from the 3GPP AAA Server an Authorization Answer not including any WLAN Location Information and the WLAN-Location-Info-Request bit was set to 1 in the AAR-Flags AVP. + +The ePDG shall select a SMF+PGW-C for PDN connections that may be subject to mobility to 5GS, e.g. for UEs supporting N1 mode (see 3GPP TS 24.302 [26]) and not restricted to interworking with 5GS by user subscription (see "5GC" bit within Core-Network-Restrictions AVP and Interworking-5GS-Indicator AVP specified) as specified in clause 5.12.3 of 3GPP TS 29.303 [34]. + +The ePDG may trigger the Detach Procedure (see 3GPP TS 23.402 [3]), if the Core-Network-Restrictions AVP is changed to restrict to connect to current network due to the non-3GPP subscriber profile is changed. + +### 7.1.2.3 ePDG Initiated Session Termination Procedures + +#### 7.1.2.3.1 General + +The SWm reference point allows the ePDG to inform the 3GPP AAA Server/Proxy about the termination of an IKE\_SA between UE and ePDG, and that therefore the mobility session established on the ePDG for all associated PDN connections are to be removed. + +The SWm Session Termination Request procedure shall be initiated by the ePDG to the 3GPP AAA Server which shall remove associated non-3GPP Access information. The AAA Server shall then return the SWm Session Termination Answer containing the result of the operation. These procedures are based on the reuse of Diameter STR and STA commands as specified in IETF RFC 6733 [58]. + +**Table 7.1.2.3.1/1: SWm Session Termination Request** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Termination Cause | Termination-Cause | M | This information element shall contain the reason for the disconnection. | + +**Table 7.1.2.3.1/2: SWm Session Termination Answer** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|----------------------------------------------------| +| Result | Result-Code | M | This IE shall contain the result of the operation. | + +#### 7.1.2.3.2 3GPP AAA Server Detailed Behavior + +Upon reception of the Session Termination Request message from the ePDG, the 3GPP AAA Server shall check that there is an ongoing session associated to the two parameters received (Session-Id and User-Name). + +If an active session is found and it belongs to the user identified by the User-Name parameter, the 3GPP AAA Server shall release the session resources associated to the specified session and a Session Termination Response shall be sent to the ePDG, indicating DIAMETER\_SUCCESS. + +Otherwise, the 3GPP AAA Server returns a Session Termination Response with the Diameter Error DIAMETER\_UNKNOWN\_SESSION\_ID. + +#### 7.1.2.3.3 3GPP AAA Proxy Detailed Behavior + +The 3GPP AAA Proxy is required to handle roaming cases in which the ePDG is located in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the Session Termination Request message from the ePDG, the 3GPP AAA Proxy shall route the message to the 3GPP AAA Server. + +On receipt of the Session Termination Answer message from the 3GPP AAA Server, the 3GPP AAA Proxy shall route the message to the ePDG, and it shall release any local resources associated to the specified session only if the result code is set to DIAMETER\_SUCCESS. + +## 7.1.2.4 3GPP AAA Server Initiated Session Termination Procedures + +### 7.1.2.4.1 General + +The SWm reference point shall allow the 3GPP AAA Server to request the termination of an IKE\_SA between UE and ePDG, and therefore the termination of all mobility session established for all associated PDN connections. + +If the user has several accesses (IKE\_SA) active at an ePDG, a separate Session Termination procedure shall be initiated for each of them. + +The procedure shall be initiated by the 3GPP AAA Server. This procedure is based on the reuse of NASREQ IETF RFC 4005 [4] ASR, ASA, STR and STA commands. + +**Table 7.1.2.4.1/1: SWm Abort Session Request** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Auth-Session-State | Auth-Session-State | O | If present, this information element indicates to the ePDG whether the 3GPP AAA Server requires an STR message. | + +**Table 7.1.2.4.1/2: SWm Abort Session Answer** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|----------------------------------------------------| +| Result | Result-Code | M | This IE shall contain the result of the operation. | + +**Table 7.1.2.4.1/3: SWm Session Termination Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Termination-Cause | Termination-Cause | M | This information element shall contain the reason why the session was terminated. It shall be set to "DIAMETER_ADMINISTRATIVE" to indicate that the session was terminated in response to an ASR message. | + +**Table 7.1.2.4.1/4: SWm Session Termination Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|----------------------------------------------------| +| Result-Code | Result-Code | M | This IE shall contain the result of the operation. | + +### 7.1.2.4.2 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA Server shall make use of this procedure to instruct the ePDG to terminate the IKE\_SA between UE and ePDG. + +In the DSMIPv6 case, the 3GPP AAA Server shall initiate first the detach procedure over the S6b reference point towards the PDN GW. When this process has finalized, the 3GPP AAA Server can initiate the termination of the IKE\_SA towards the ePDG. + +The 3GPP AAA Server shall include the Auth-Session-State AVP in the ASR command with a value of NO\_STATE\_MAINTAINED if it does not require a STR from the ePDG. If it does require a STR from the ePDG, the + +3GPP AAA Server shall either omit the Auth-Session-State AVP from the ASR command or include the Auth-Session-State AVP in the ASR command with a value of STATE\_MAINTAINED. + +On receipt of the ASR command, the ePDG shall check if there is an ongoing session associated with the received Session-Id. If an active session is found and it belongs to the user identified by the User-Name parameter, the ePDG shall terminate the associated IKE\_SA between UE and ePDG and return an ASA to the 3GPP AAA Server with the Result-Code to DIAMETER\_SUCCESS. Otherwise, the ePDG shall return an ASA to the 3GPP AAA Server with the Result-Code set to DIAMETER\_UNKNOWN\_SESSION\_ID. + +On receipt of the ASA with a Result-Code of DIAMETER\_SUCCESS, the 3GPP AAA Server shall release any local resources associated with the specified session. + +If required by the 3GPP AAA Server, the ePDG shall send an STR with the Termination-Cause set to DIAMETER\_ADMINISTRATIVE. The 3GPP AAA Server shall set the Result-Code to DIAMETER\_SUCCESS and return the STA command to the ePDG. + +#### 7.1.2.4.3 3GPP AAA Proxy Detailed Behaviour + +When the 3GPP AAA Proxy receives the ASR from the 3GPP AAA Server it shall route the request to the ePDG. + +If the 3GPP AAA Proxy requires an STR but the 3GPP AAA Server does not, the 3GPP AAA Proxy may override the value of the Auth-Session-State in the ASR and set it to STATE\_MAINTAINED. In this case, the 3GPP AAA Proxy shall not forward the STR received from the ePDG onto the 3GPP AAA Server and shall return an STA command to the ePDG with the Result-Code set to DIAMETER\_SUCCESS. The 3GPP AAA Proxy shall not override the value of the Auth-Session-State AVP under any other circumstances. + +On receipt of the ASA message with Diameter Result Code set to DIAMETER\_SUCCESS, the 3GPP AAA Proxy shall route the successful response to the 3GPP AAA Server and shall release any local resources associated with the session. + +When the 3GPP AAA Proxy receives the STR from ePDG, it shall route the request to the 3GPP AAA Server. On receipt of the STA message, the 3GPP AAA Proxy shall route the response to the ePDG. + +#### 7.1.2.5 Authorization Information Update Procedures + +##### 7.1.2.5.1 General + +This procedure shall be used between the 3GPP AAA Server and the ePDG for the purpose of modifying the previously provided authorization parameters. This may happen due to a modification of the subscriber profile in the HSS (for example change of the identity of a dynamically allocated PDN GW, see clause 8.1.2.3). + +This procedure shall be performed in two steps: + +- The 3GPP AAA Server shall issue an unsolicited re-authorization request towards the ePDG. Upon receipt of such a request, the ePDG shall respond to the request and indicate the disposition of the request. This procedure is based on the Diameter commands Re-Auth-Request and Re-Auth-Answer specified in IETF RFC 6733 [58]. Information element contents for these messages shall be as shown in tables 7.1.2.5.1/1 and 7.1.2.5.1/2. +- Upon receiving the re-authorization request, the ePDG shall immediately invoke the authorization procedure specified in 7.1.2.2 for the session indicated in the request. This procedure is based on the Diameter commands AA-Request (AAR) and AA-Answer (AAA) specified in IETF RFC 4005 [4]. Information element contents for these messages are shown in tables 7.1.2.2.1/1 and 7.1.2.2.1/2. + +**Table 7.1.2.5.1/1: SWm Authorization Information Update Request** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Re-Auth Request Type | Re-Auth-Request-Type | M | This IE shall define whether the user is to be authorized only or authenticated and authorized. AUTHORIZE_ONLY shall be set in this case. | +| Routing Information | Destination-Host | M | This information element shall be obtained from the Origin-Host AVP, which was included in a previous command received from the trusted non-3GPP access. | + +**Table 7.1.2.5.1/2: SWm Authorization Information Update Answer** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. If this IE contains an identity based on IMSI, this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Result | Result-Code | M | This IE shall contain the result of the operation. | + +#### 7.1.2.5.2 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA server shall make use of the re-authorization procedure defined in the Diameter base protocol, IETF RFC 6733 [58] to indicate that relevant service authorization information shall be updated in the ePDG. + +#### 7.1.2.5.3 ePDG Detailed Behaviour + +Upon receipt of the Re-authorization Request message from the 3GPP AAA Server or the 3GPP AAA Proxy, the ePDG shall check that there is an ongoing session associated to any of the parameters received in the message (identified by the Session-Id AVP and the User-Name AVP). + +If an active session is found, the ePDG shall initiate an authorization procedure for the session identified by the Session-Id AVP and the User-Name AVP and a Re-authorization Answer message shall be sent to the 3GPP AAA Server or the 3GPP AAA Proxy with the Result-Code indicating DIAMETER\_SUCCESS. This new authorization procedure shall be performed as described in clause 7.1.2.2. + +If the Session-Id included in the request does not correspond with any active session, or if an active session is found but it does not belong to the user identified by the User Name parameter, then an Re-authorization Answer message shall be sent to the 3GPP AAA Server or the 3GPP AAA Proxy with the Result-Code indicating DIAMETER\_UNKNOWN\_SESSION\_ID. + +Exceptions to the cases specified here shall be treated by ePDG as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY and, therefore, no authorization procedure shall be initiated. + +Table 7.1.2.5.3/1 details the valid result codes that the ePDG can return in the response. + +**Table 7.1.2.5.3/1: Re-authorization Answer valid result codes** + +| Result-Code AVP value | Condition | +|-----------------------------|-----------------------------------------------------------| +| DIAMETER_SUCCESS | The request succeeded. | +| DIAMETER_UNKNOWN_SESSION_ID | The request failed because the user is not found in ePDG. | +| DIAMETER_UNABLE_TO_COMPLY | The request failed. | + +## 7.2 Protocol Specification + +### 7.2.1 General + +The SWm reference point shall be based on Diameter, as defined in IETF RFC 6733 [58] and contain the following additions and extensions: + +- IETF RFC 4005 [4], which defines a Diameter protocol application used for Authentication, Authorization and Accounting (AAA) services in the Network Access Server (NAS) environment. +- IETF RFC 4072 [5], which provides a Diameter application to support the transport of EAP (IETF RFC 3748 [8]) frames over Diameter. +- IETF RFC 5779 [2], which defines a Diameter extensions and application for PMIPv6 MAG to AAA and LMA to AAA interfaces. +- IETF RFC 5447 [6], which defines Diameter extensions for Mobile IPv6 NAS to AAA interface. + +In the case of an untrusted non-3GPP IP access, the MAG to 3GPP AAA server or the MAG to 3GPP AAA proxy communication shall use the MAG to AAA interface functionality defined in IETF RFC 5779 [2] and the NAS to AAA interface functionality defined in IETF RFC 5447 [6]. + +The Diameter application for the SWm reference point shall use the Diameter Application Id with value 16777264. + +### 7.2.2 Commands + +#### 7.2.2.1 Commands for SWm Authentication and Authorization Procedures + +##### 7.2.2.1.1 Diameter-EAP-Request (DER) Command + +The Diameter-EAP-Request (DER) command, indicated by the Command-Code field set to 268 and the "R" bit set in the Command Flags field, is sent from a ePDG to a 3GPP AAA Server/Proxy. The ABNF is based on the one in IETF RFC 5779 [2]. + +``` +< Diameter-EAP-Request > ::= < Diameter Header: 268, REQ, PXY, 16777264 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Request-Type } + { EAP-Payload } + [ User-Name ] + [ RAT-Type ] + [ Service-Selection ] + [ MIP6-Feature-Vector ] + [ QoS-Capability ] + [ Visited-Network-Identifier ] + [ AAA-Failure-Indication ] + *[ Supported-Features ] + [ UE-Local-IP-Address ] + [ OC-Supported-Features ] + [ Terminal-Information ] + [ Emergency- Services ] + [ High-Priority-Access-Info ] + ... + *[ AVP ] +``` + +### 7.2.2.1.2 Diameter-EAP-Answer (DEA) Command + +The Diameter-EAP-Answer (DEA) command, indicated by the Command-Code field set to 268 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to the ePDG. The ABNF is based on the one in IETF RFC 5779 [2]. + +``` +< Diameter-EAP-Answer > ::= < Diameter Header: 268, PXY, 16777264> + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ EAP-Payload ] + [ User-Name ] + [ EAP-Master-Session-Key ] + [ APN-OI-Replacement ] + [ APN-Configuration ] + [ MIP6-Feature-Vector ] + [ Mobile-Node-Identifier ] + [ Trace-Info ] + [ Subscription-ID ] + [ Session-Timeout ] + [ MIP6-Agent-Info ] + [ 3GPP-Charging-Characteristics ] + *[ Redirect-Host ] + *[ Supported-Features ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + [ Access-Network-Info ] + [ User-Location-Info-Time ] + [ UE-Usage-Type ] [ Emergency-Info ] + [ Core-Network-Restrictions ] + [ MPS-Priority ] + ... + *[ AVP ] +``` + +### 7.2.2.1.3 Diameter-AA-Request (AAR) Command + +The AA-Request (AAR) command, indicated by the Command-Code field set to 265 and the "R" bit set in the Command Flags field, is sent from a ePDG to a 3GPP AAA Server/Proxy. + +``` + ::= < Diameter Header: 265, REQ, PXY, 16777264> + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Request-Type } + [ User-Name ] + [ OC-Supported-Features ] + [ AAR-Flags ] + [ UE-Local-IP-Address ] +``` + +... +\*[ AVP ] + +#### 7.2.2.1.4 Diameter-AA-Answer (AAA) Command + +The AA-Answer (AAA) command, indicated by the Command-Code field set to 265 and the "R" bit cleared in the Command Flags field, is sent from 3GPP AAA Server/Proxy to a ePDG. + +``` + ::= < Diameter Header: 265, REQ, PXY, 16777264 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + [ APN-OI-Replacement ] + [ APN-Configuration ] + [ Trace-Info ] + [ Subscription-ID ] + [ 3GPP-Charging-Characteristics ] + [ Session-Timeout ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + [ Access-Network-Info ] + [ User-Location-Info-Time ] + [ Core-Network-Restrictions ] + ... + *[ AVP ] +``` + +#### 7.2.2.2 Commands for ePDG Initiated Session Termination + +##### 7.2.2.2.1 Session-Termination-Request (STR) Command + +The Session-Termination-Request (STR) command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is sent from a ePDG to a 3GPP AAA Server/Proxy. The ABNF is based on the one in IETF RFC 6733 [58], and is defined as follows: + +``` +< Session-Termination-Request > ::= < Diameter Header: 275, REQ, PXY, 16777264 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Application-Id } + { Termination-Cause } + [ User-Name ] + [ OC-Supported-Features ] + ... + *[ AVP ] +``` + +##### 7.2.2.2.2 Session-Termination-Answer (STA) Command + +The Session-Termination-Answer (STA) command, indicated by the Command-Code field set to 275 and the "R" bit clear in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to a ePDG. The ABNF is based on the one in IETF RFC 6733 [58], and is defined as follows: + +``` +< Session-Termination-Answer > ::= < Diameter Header: 275, PXY, 16777264 > + < Session-Id > +``` + +``` + +[ DRMP ] +{ Result-Code } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +... +*[ AVP ] + +``` + +### 7.2.2.3 Commands for 3GPP AAA Server Initiated Session Termination + +#### 7.2.2.3.1 Abort-Session-Request (ASR) Command + +The Abort-Session-Request (ASR) command shall be indicated by the Command-Code field set to 274 and the "R" bit set in the Command Flags field, and shall be sent from a 3GPP AAA Server/Proxy to an ePDG. The ABNF is based on that in IETF RFC 4005 [4]. + +``` + +< Abort-Session-Request > ::= < Diameter Header: 274, REQ, PXY, 16777264 > +< Session-Id > +[ DRMP ] +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +{ Destination-Host } +{ Auth-Application-Id } +[ User-Name ] +[ Auth-Session-State ] +... +*[ AVP ] + +``` + +#### 7.2.2.3.2 Abort-Session-Answer (ASA) Command + +The Abort-Session-Answer (ASA) command shall be indicated by the Command-Code field set to 274 and the "R" bit cleared in the Command Flags field, and shall be sent from a ePDG to a 3GPP AAA Server/Proxy. The ABNF is based on that in IETF RFC 4005 [4]. + +``` + +< Abort-Session-Answer > ::= < Diameter Header: 274, PXY, 16777264 > +< Session-Id > +[ DRMP ] +{ Result-Code } +{ Origin-Host } +{ Origin-Realm } +... +*[ AVP ] + +``` + +#### 7.2.2.3.3 Session-Termination-Request (STR) Command + +The Session-Termination-Request (STR) command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is sent from an ePDG to a 3GPP AAA Server/Proxy. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58] Session-Termination-Request command. + +``` + + ::= < Diameter Header: 275, REQ, PXY, 16777264 > +< Session-Id > +[ DRMP ] +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +[ Destination-Host ] + +``` + +``` + +{ Auth-Application-Id } +{ Termination-Cause } +[ User-Name ] +[ OC-Supported-Features ] +... +*[ AVP ] + +``` + +#### 7.2.2.3.4 Session-Termination-Answer (STA) Command + +The Session-Termination-Answer (STA) command, indicated by the Command-Code field set to 275 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to an ePDG. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58] Session-Termination-Answer command. + +``` + + ::= < Diameter Header: 275, PXY, 16777264 > +< Session-Id > +[ DRMP ] +{ Result-Code } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ AVP ] + +``` + +#### 7.2.2.4 Commands for Authorization Information Update + +##### 7.2.2.4.1 Re-Auth-Request (RAR) Command + +The Re-Auth-Request (RAR) command shall be indicated by the Command-Code field set to 258 and the "R" bit set in the Command Flags field, and shall be sent from a 3GPP AAA Server/Proxy to a ePDG. The ABNF is based on the one in IETF RFC 4005 [4] and is defined as follows. + +``` + +< Re-Auth-Request > ::= < Diameter Header: 258, REQ, PXY, 16777264 > +< Session-Id > +[ DRMP ] +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +{ Destination-Host } +{ Auth-Application-Id } +{ Re-Auth-Request-Type } +[ User-Name ] +... +*[ AVP ] + +``` + +##### 7.2.2.4.2 Re-Auth-Answer (RAA) Command + +The Re-Auth-Answer (RAA) command shall be indicated by the Command-Code field set to 258 and the "R" bit cleared in the Command Flags field, and shall be sent from a ePDG to a 3GPP AAA Server/Proxy. The ABNF is based on the one in IETF RFC 4005 [4] and is defined as follows. + +``` + +< Re-Auth-Answer > ::= < Diameter Header: 258, PXY, 16777264 > +< Session-Id > +[ DRMP ] +{ Result-Code } +{ Origin-Host } +{ Origin-Realm } +[ User-Name ] +... +*[ AVP ] + +``` + +## 7.2.3 Information Elements + +### 7.2.3.1 General + +The following table describes the Diameter AVPs defined for the SWm interface protocol for untrusted non-3GPP access, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +**Table 7.2.3.1/1: Diameter SWm AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | +|----------------------------|----------|----------------|-------------|----------------|-----|------------|----------| +| | | | | Must | May | Should not | Must not | +| APN-Configuration | 1430 | 8.2.3.7 | Grouped | M,V | | | P | +| Mobile-Node-Identifier | 506 | 5.2.3.2 | OctetString | M | | | V,P | +| MIP6-Feature-Vector | 124 | 5.2.3.3 | Unsigned64 | M | | | V,P | +| QoS-Capability | 578 | 9.2.3.2.4 | Grouped | M | | | V,P | +| RAT-Type | 1032 | 5.2.3.6 | Enumerated | M,V | | | P | +| Visited-Network-Identifier | 600 | 9.2.3.1.2 | OctetString | M,V | | | P | +| Trace-Info | 1505 | 8.2.3.1.3 | Grouped | V | | | M,P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | +| AAA-Failure-Indication | 1518 | 8.2.3.21 | Unsigned32 | V | | | M,P | +| Emergency- Services | 1538 | 7.2.3.4 | Unsigned32 | V | | | M,P | +| Access-Network-Info | 1526 | 5.2.3.24 | Grouped | V | | | M,P | +| AAR-Flags | 1539 | 7.2.3.5 | Unsigned32 | V | | | M,P | +| High-Priority-Access-Info | 1541 | 5.2.3.36 | Unsigned32 | V | | | M,P | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table describes the Diameter AVPs re-used by the SWm interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within SWm. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol defined in IETF RFC 6733 [58], do not need to be supported. + +**Table 7.2.3.1/2: SWm re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | M-bit | +|-------------------------------|---------------------|---------------------|--------------| +| Auth-Request-Type | IETF RFC 6733 [58] | | | +| Subscription-ID | IETF RFC 4006 [20] | | | +| EAP-Master-Session-Key | IETF RFC 4072 [5] | | | +| EAP-Payload | IETF RFC 4072 [5] | | | +| Re-Auth-Request-Type | IETF RFC 6733 [58] | | | +| Session-Timeout | IETF RFC 6733 [58] | | | +| User-Name | IETF RFC 6733 [58] | | | +| MIP6-Agent-Info | IETF RFC 5447 [6] | | | +| APN-OI-Replacement | 3GPP TS 29.272 [29] | | | +| Terminal-Information | 3GPP TS 29.272 [29] | | | +| Supported-Features | 3GPP TS 29.229 [24] | | | +| Feature-List-ID | 3GPP TS 29.229 [24] | See clause 7.2.3.2 | | +| Feature-List | 3GPP TS 29.229 [24] | See clause 7.2.3.3 | | +| 3GPP-Charging-Characteristics | 3GPP TS 29.061 [31] | | | +| UE-Local-IP-Address | 3GPP TS 29.212 [23] | | | +| OC-Supported-Features | IETF RFC 7683 [47] | See clause 8.2.3.22 | | +| OC-OLR | IETF RFC 7683 [47] | See clause 8.2.3.23 | | +| User-Location-Info-Time | 3GPP TS 29.212 [23] | See clause 5.3.101 | | +| DRMP | IETF RFC 7944 [53] | See clause 8.2.3.25 | Must not set | +| Emergency-Info | 3GPP TS 29.272 [29] | | | +| Load | IETF RFC 8583 [54] | See clause 8.2.3.26 | Must not set | +| UE-Usage-Type | 3GPP TS 29.272 [29] | | | +| Core-Network-Restrictions | 3GPP TS 29.272 [29] | | | +| MPS-Priority | 3GPP TS 29.272 [29] | | Must not set | + +NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +Only those AVP initially defined in this reference point and for this procedure are described in the following clauses. + +### 7.2.3.2 Feature-List-ID AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. For this release, the Feature-List-ID AVP value shall be set to 1 for the SWm application. + +### 7.2.3.3 Feature-List AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. A null value indicates that there is no feature used by the SWm application. + +NOTE: There are no SWm features defined for this release. + +### 7.2.3.4 Emergency-Services + +The Emergency-Services AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.2.3.4/1: + +**Table 7.2.3.4/1: Emergency-Services** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------|----------------------|-----------------------------------------------------------------------------------------------| +| 0 | Emergency-Indication | This bit, when set, indicates a request to establish a PDN connection for emergency services. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver. | | | + +### 7.2.3.5 AAR-Flags + +The AAR-Flags AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.2.3.5/1: + +**Table 7.2.3.5/1: AAR-Flags** + +| Bit | Name | Description | +|-------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | WLAN-Location-Info-Request | This bit, when set, indicates an ePDG request to retrieve the most up to date WLAN Location Information of the UE stored at the 3GPP AAA Server. | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver. | | + +## 7.2.4 Session Handling + +The Diameter protocol between the ePDG and the 3GPP AAA Server or the 3GPP AAA Proxy shall always keep the session state, and use the same Session-Id parameter for the lifetime of each Diameter session. + +A Diameter session shall identify + +- a PDN Connection of a given user, if NBM is used +- a user, if DSMIPv6 is used. + +In order to indicate that the session state is to be maintained, the Diameter client and server shall not include the Auth-Session-State AVP, either in the request or in the response messages (see IETF RFC 6733 [58]). + +# 8 SWx Description + +## 8.1 Functionality + +### 8.1.1 General + +The SWx reference point is defined between the 3GPP AAA Server and the HSS. The description of the reference point and its functionality is given in 3GPP TS 23.402 [3]. + +The SWx reference point is used to authorize the UE and to transport NBM related mobility parameters when NBM is used to establish connectivity to the EPC. + +The SWx is used to authenticate and authorize the UE when the S2a, S2b or S2c reference points are used to connect to EPC. This reference point is also used to update the HSS with the PDN-GW address information. Additionally, this reference point may be used to retrieve and update other mobility related parameters including static QoS profiles for non-3GPP accesses. + +Additional requirements for the SWx interface can be found in clause 12 of 3GPP TS 23.402 [3]. + +### 8.1.2 Procedures Description + +#### 8.1.2.1 Authentication Procedure + +##### 8.1.2.1.1 General + +This procedure is used between the 3GPP AAA Server and the HSS. The procedure is invoked by the 3GPP AAA Server when a new set of authentication information for a given subscriber is to be retrieved from an HSS. This can happen for example, when a new trusted or untrusted non 3GPP/IP access subscriber has accessed the 3GPP AAA Server for authentication or when a new set of authentication information is required for one of the subscribers already + +registered in the 3GPP AAA server. The procedure shall be invoked by 3GPP AAA Server when it detects that the VPLMN or access network has changed. + +**Table 8.1.2.1.1/1: Authentication request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Visited Network Identifier | Visited-Network-Identifier | C | This IE shall contain the identifier that allows the home network to identify the Visited Network. The 3GPP AAA Server shall include this information element when received from signalling across the SWd. | +| Number Authentication Items | SIP-Number-Auth-Items | M | This information element shall indicate the number of authentication vectors requested | +| Authentication Data | SIP-Auth-Data-Item | M | See tables 8.1.2.1.1/2 and 8.1.2.1.1/3 for the contents of this information element. The content shown in table 8.1.2.1.1/2 shall be used for a normal authentication request; the content shown in table 8.1.2.1.1/3 shall be used for an authentication request after synchronization failure. | +| Routing Information | Destination-Host | C | If the 3GPP AAA Server knows the HSS name, this AVP shall be present.
This information is available if the 3GPP AAA Server already has the HSS name stored. The HSS name shall be obtained from the Origin-Host AVP, which is received from a previous command from the HSS or from the SLF; otherwise only the Destination-Realm is included so that it is resolved to an HSS address in an SLF-like function. Once resolved the Destination-Host AVP is included with the suitable HSS address and it is stored in the 3GPP AAA Server for further usage. | +| Access Network Identity | ANID | C | This IE shall contain the access network identifier used for key derivation at the HSS. (See 3GPP TS 24. 302 [26] for all possible values).
This IE shall be present if the Authentication Method is EAP-AKA'. | +| Access Type | RAT-Type | M | This IE shall contain the radio access technology that is serving the UE. (See 3GPP TS 29.212 [23] for all possible values).
When this IE is not received by the 3GPP AAA Server, neither from the ePDG nor from the non-3GPP access network, it shall take the value VIRTUAL (1). | +| Trust Relationship Indicator | AN-Trusted | O | When present, this AVP shall contain the 3GPP AAA Server's decision on handling the non-3GPP access network, i.e. trusted or untrusted. | +| Terminal Information | Terminal-Information | O | This information element shall contain information about the user's mobile equipment. The AVP shall be present only if received from the non-3GPP access network, in authentication and authorization request. The AVP shall be transparently forwarded by the 3GPP AAA server.
(see NOTE 1) | +| AAA Failure Indication | AAA-Failure-Indication | O | If present, this information element shall indicate that the 3GPP AAA Server currently registered in the HSS, is unavailable. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +NOTE 1: The Terminal-Information AVP is not present in this message for a WLAN access. + +**Table 8.1.2.1.1/2: Authentication Data content - request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|---------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authentication Method | SIP-Authentication-Scheme | M | This information element shall indicate the authentication method. It shall contain one of the values EAP-AKA or EAP-AKA'. EAP-AKA is specified in IETF RFC 4187 [44] and EAP-AKA' is specified in IETF RFC 5448 [27]. | + +**Table 8.1.2.1.1/3: Authentication Data content - request, synchronization failure** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------|---------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authentication Method | SIP-Authentication-Scheme | M | This information element shall indicate the authentication method. It shall contain one of the values EAP-AKA or EAP-AKA'. | +| Authorization Information | SIP-Authorization | M | This IE shall contain the concatenation of Rand, as sent to the terminal, and auts, as received from the terminal. Rand and auts shall both be binary encoded. | + +**Table 8.1.2.1.1/4: Authentication answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|--------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See I IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Number Authentication Items | SIP-Number-Auth-Items | C | This AVP shall indicate the number of authentication vectors delivered in the Authentication Data information element. It shall be present when the result is DIAMETER_SUCCESS. | +| Authentication Data | SIP-Auth-Data-Item | C | If the SIP-Number-Auth-Items AVP is equal to zero or it is not present, then this AVP shall not be present. See table 8.1.2.1.1/5 for the contents of this information element. | +| 3GPP AAA Server Name | 3GPP-AAA-Server-Name | C | This AVP shall contain the Diameter address of the 3GPP AAA Server. This AVP shall be sent when the user has been previously authenticated by another 3GPP AAA Server and therefore there is another 3GPP AAA Server serving the user. | +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for SWx errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 8.1.2.1.1/5: Authentication Data content - response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------------|---------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Item Number | SIP-Item-Number | C | This information element shall be present in a SIP-Auth-Data-Item grouped AVP in circumstances where there are multiple occurrences of SIP-Auth-Data-Item AVPs, and the order in which they should be processed is significant.
In this scenario, SIP-Auth-Data-Item AVPs with a low SIP-Item-Number value should be processed before SIP-Auth-Data-Item AVPs with a high SIP-Item-Number value. | +| Authentication Method | SIP-Authentication Scheme | M | This IE shall contain one of the values EAP-AKA or EAP-AKA'. | +| Authentication Information AKA | SIP-Authenticate | M | This IE shall contain, binary encoded, the concatenation of the authentication challenge RAND and the token AUTN. See 3GPP TS 33.203 [16] for further details about RAND and AUTN. | +| Authorization Information AKA | SIP-Authorization | M | This IE shall contain binary encoded, the expected response XRES. See 3GPP TS 33.203 [16] for further details about XRES. | +| Confidentiality Key AKA | Confidentiality-Key | M | This information element shall contain the confidentiality key CK or CK'. It shall be binary encoded. | +| Integrity Key AKA | Integrity-Key | M | This information element shall contain the integrity key IK or IK'. It shall be binary encoded. | + +#### 8.1.2.1.2 Detailed behaviour + +The HSS shall, in the following order (if there is an error in any of the steps, the HSS shall stop processing and return the corresponding error code): + +1. Check that the user exists in the HSS. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +2. Check that the user has non-3GPP subscription and that the user is allowed in the EPC. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION. +3. If a Visited-Network-Identifier is present, check that the user is allowed to roam in the visited network. If the user is not allowed to roam in the visited network, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED. +4. Check the access type. If the access type indicates any value that is restricted for the user, then the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED. +5. Based on operator's policy, if the Trust Relationship Indicator is present and indicates any value that is restricted for the user, then the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_TRUSTED\_NON\_3GPP\_ACCESS\_NOT\_ALLOWED or DIAMETER\_ERROR\_UNTRUSTED\_NON\_3GPP\_ACCESS\_NOT\_ALLOWED. +6. The HSS shall check if there is an existing 3GPP AAA Server already assisting the user + - If there is a 3GPP AAA Server already serving the user, the HSS shall compare the 3GPP AAA server name received in the request to the 3GPP AAA Server name stored in the HSS. + - If they are not identical and the received message contains the AAA-Failure-Indication AVP, the HSS shall remove the old 3GPP AAA Server name previously assigned for this subscriber, and store the name of the new 3GPP AAA Server that sent the request containing the AAA-Failure-Indication AVP, and continue from step 6. The HSS should attempt to notify the old 3GPP AAA Server about the new server assignment, by means of the network initiated de-registration procedure (see clause 8.1.2.2.3) indicating as reason code "NEW\_SERVER\_ASSIGNED". + +- If they are not identical the HSS shall return the old 3GPP AAA Server to the requester 3GPP AAA Server and return an error by setting the Experimental-Result-Code to DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED. + - The requester 3GPP AAA Server, upon detection of a 3GPP AAA Server name in the response assumes that the user already has a 3GPP AAA Server assigned, so makes use of Diameter redirect function to indicate the 3GPP AAA Server name where to address the authentication request. +7. The HSS shall check the request type. +- If the request indicates there is a synchronization failure, the HSS shall process AUTS as described in 3GPP TS 33.203 [16] and return the requested authentication information. The Result-Code shall be set to DIAMETER\_SUCCESS. + - If the request indicates authentication, the HSS shall generate the authentication vectors for the requested authentication method, EAP-AKA or EAP-AKA', as described in 3GPP TS 33.402 [19]. The HSS shall download Authentication-Data-Item up to a maximum specified in SIP-Number-Auth-Items received in the command Multimedia-Auth-Request. The result code shall be set to DIAMETER\_SUCCESS. + - If there is no 3GPP AAA Server already serving the user, the HSS shall store the received 3GPP AAA Server name. + +Exceptions to the cases specified here shall be treated by HSS as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. No authentication information shall be returned. + +Origin-Host AVP shall contain the 3GPP AAA Server identity. + +## 8.1.2.2 Location Management Procedures + +### 8.1.2.2.1 General + +According to the requirements described in 3GPP TS 23.402 [3], SWx reference point shall enable: + +- Registration of the 3GPP AAA Server serving an authorized trusted or untrusted non-3GPP access user in the HSS. +- Retrieval of charging-related information from HSS. +- Deregistration procedure between the 3GPP AAA Server and the HSS. +- Retrieval of subscriber profile from HSS. + +### 8.1.2.2.2 UE/PDN Registration/DeRegistration Notification + +#### 8.1.2.2.2.1 General + +This procedure is used between the 3GPP AAA Server and the HSS. + +- To register the current 3GPP AAA Server address in the HSS for a given non-3GPP user. This procedure is invoked by the 3GPP AAA Server after a new subscriber has been authenticated by the 3GPP AAA Server. +- To de-register the current 3GPP AAA Server address in the HSS for a given non-3GPP user. This procedure is invoked when the 3GPP AAA Server removes the access information for a non-3GPP user after all sessions for the user (i.e. the STa, SWm, S6b sessions) have been terminated. +- To download the subscriber profile to the 3GPP AAA Server on demand. This procedure is invoked when for some reason the subscription profile of a subscriber is lost. +- To update the HSS with the identity and the PLMN ID of a dynamically allocated PDN GW as a result of the first PDN connection establishment associated to an APN. +- To update the HSS with the identity of the dynamically allocated PDN GW selected for the establishment of an emergency PDN connection. + +**Table 8.1.2.2.2.1/1: Non-3GPP IP Access Registration request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI and shall be formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Server Assignment Type | Server-Assignment-Type | M | This IE shall contain the type of procedure the 3GPP AAA Server requests in the HSS.
When this IE contains REGISTRATION value, the 3GPP AAA Server requests the HSS to perform a registration of the non-3GPP user.
When this IE contains USER_DEREGISTRATION / ADMINISTRATIVE_DEREGISTRATION / AUTHENTICATION_FAILURE / AUTHENTICATION_TIMEOUT, the 3GPP AAA Server requests the HSS to de-register the non-3GPP user.
When this IE contains AAA_USER_DATA_REQUEST value, the 3GPP AAA Server requests the HSS to download the subscriber user profile towards the 3GPP AAA Server as part of 3GPP AAA Server initiated profile download request, but no registration is requested.
When this IE contains PGW_UPDATE value, the 3GPP AAA Server requests the HSS to update the PGW identity for the non-3GPP user for an APN in the user subscription or for emergency services.
Any other value shall be considered as an error case. | +| Routing Information | Destination-Host | C | If the 3GPP AAA Server knows the HSS name this AVP shall be present. This information is available if the 3GPP AAA Server already has the HSS name stored. The HSS name shall be obtained from the Origin-Host AVP, which is received from the HSS as part of authentication response; otherwise only the Destination-Realm is included so that it is resolved to an HSS address in an SLF-like function. Once resolved the Destination-Host AVP shall be included with the suitable HSS address and it shall be stored in the 3GPP AAA Server for further usage. | +| PGW identity | MIP6-Agent-Info | C | This IE shall contain, either the identity of the dynamically allocated PDN GW, or the identity of a dynamically allocated PDN GW selected for the establishment of emergency PDN connections, and is included if the Server-Assignment-Type is set to PGW_UPDATE. | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE shall contain the identity of the PLMN where the PDN-GW was allocated, in cases of dynamic PDN-GW assignment. It shall be present when the PGW Identity is present and does not contain an FQDN. | +| Context Identifier | Context-Identifier | O | For non-emergency PDN connection establishment, this parameter shall identify the APN Configuration with which the reallocated PDN GW shall be correlated, and it may be included if it is available and the Server-Assignment-Type is set to PGW_UPDATE.

For emergency PDN connection establishment, this information element shall be left absent. | +| APN Id | Service-Selection | C | For non-emergency PDN connection establishment, this information element shall contain the Network Identifier part of the APN, and it shall be included if the Server-Assignment-Type is set to PGW_UPDATE.

For emergency PDN connection establishment, this information element shall be left absent. | +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Terminal Information | Terminal-Information | C | The 3GPP AAA Server shall include this IE and set it to the user's Mobile Equipment Identity, if this information is available, and if the Server-Assignment-Type is set to REGISTRATION.

This IE shall also be present, independently of the value of the Server-Assignment-Type, if the Terminal-Information has changed from the last value previously reported to the HSS.

This grouped AVP shall contain the IMEI AVP and, if available, the Software-Version AVP, for a trusted or untrusted WLAN access. When the RAT type is not known by the 3GPP AAA Server, but the UE has provided the IMEI(SV), this grouped AVP shall contain the IMEI AVP and, if available, the Software-Version AVP. | + +| | | | | +|--------------------|--------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Emergency Services | Emergency-Services | C | The 3GPP AAA Server shall include this information element, and set the Emergency-Indication bit, to notify the HSS that a new PDN-GW has been selected for the establishment of an emergency PDN connection, whose identity is conveyed in the "PGW identity" IE. This IE shall only be included when the Server-Assignment-Type is set to PGW_UPDATE. | +|--------------------|--------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +**Table 8.1.2.2.2.1/2: Non-3GPP IP Access Registration response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI and shall be formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Registration result | Result-Code / Experimental-Result | M | This IE contains the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for SWx errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| User Profile | Non-3GPP-User-Data | C | This IE shall contain the relevant user profile. Clause 8.2.3.1 details the contents of the AVP. It shall be present when Server-Assignment-Type in the request is equal to AAA_USER_DATA_REQUEST or REGISTRATION and the Result-Code is equal to DIAMETER_SUCCESS. | +| 3GPP AAA Server Name | 3GPP-AAA-Server-Name | C | This AVP shall contain the Diameter address of the 3GPP AAA Server. This AVP shall be present when the user has been previously authenticated by another 3GPP AAA Server and therefore there is another 3GPP AAA Server serving the user. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 8.1.2.2.2.2 Detailed behaviour + +When a new trusted or untrusted non-3GPP IP access subscriber has been authenticated by the 3GPP AAA Server, the 3GPP AAA Server initiates the registration towards the HSS. The HSS shall, in the event of an error in any of the steps, stop processing and return the corresponding error code. + +At reception of the Non-3GPP IP Access Registration, the HSS shall perform (in the following order): + +1. Check that the user is known. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +2. The HSS shall check if there is an existing 3GPP AAA Server already assisting the user + - If there is a 3GPP AAA Server already serving the user, the HSS shall compare the 3GPP AAA Server name received in the request to the 3GPP AAA Server name stored in the HSS. + - If they are not identical the HSS shall return the old 3GPP AAA Server to the requester 3GPP AAA Server and return an error by setting the Experimental-Result-Code to DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED. + +The requester 3GPP AAA Server, upon detection of a 3GPP AAA Server name in the response assumes that the user already has a 3GPP AAA Server assigned, so makes use of Diameter redirect function to indicate the 3GPP AAA Server name where to address the Non-3GPP IP Access Registration request. + +- If they are identical but there is no APN configuration information in HSS for the user, the HSS shall return the Experimental Result Code DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION and it shall remove the 3GPP AAA Server name previously assigned for this subscriber. +- If there is not a 3GPP AAA Server already serving the user, the HSS shall return an error, setting the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY in the Response command. + +3. After the HSS has determined that the requesting 3GPP AAA server is identical to the registered 3GPP AAA server, the HSS shall check the Server Assignment Type value received in the request: + - If it indicates REGISTRATION, the HSS shall set the subscribers User Status to REGISTERED for the authenticated and authorized trusted or untrusted non-3GPP IP access subscriber, download the relevant user profile information and set the Result-Code AVP to DIAMETER\_SUCCESS in the Server-Assignment-Response command. For those APNs that have been authorized as a consequence of having the Wildcard APN in the user subscription, the HSS shall include the specific APN name and associated PDN-GW identity inside the Specific-APN-Info AVP of the Wildcard APN. + - If it indicates USER\_DEREGISTRATION / ADMINISTRATIVE\_DEREGISTRATION / AUTHENTICATION\_FAILURE / AUTHENTICATION\_TIMEOUT, the HSS shall remove the 3GPP AAA Server name previously assigned for the subscriber, set the User Status for the subscriber to NOT\_REGISTERED and set the Result-Code AVP to DIAMETER\_SUCCESS in the Server-Assignment-Response command. The HSS shall not remove the stored dynamic PGW-ID and APN information for the subscriber. + - If it indicates AAA\_USER\_DATA\_REQUEST, the HSS shall download the relevant user profile information to the requester 3GPP AAA Server and set the Result-Code AVP to DIAMETER\_SUCCESS in the Response command. + - If it indicates PGW\_UPDATE, the HSS shall check if the subscriber is registered. + + +If the subscriber is registered and the Emergency-Services AVP is present in the request, with the Emergency-Indication bit set, the HSS shall store the PDN GW Identity as the PDN GW used to establish emergency PDN connections by the non-3GPP access network, and update the MME with this information as specified in 3GPP TS 29.272 [29]. + +If the subscriber is registered and the Emergency-Indication bit of the Emergency-Services AVP is not set in the request, and there is not a static PDN GW subscribed, the HSS shall store the PGW identity and PLMN (if it is received in the command) for the non-3GPP user and the APN identified by the APN Id or by the Context Identifier if present in the request; otherwise, the HSS shall not update or delete the stored PDN GW and, for this case, shall set the result code to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the APN corresponding to the PGW identity is not present in the subscription but the wild card APN is present in the subscription, the HSS shall store the new PDN GW identity and PLMN for an APN if present in the request. The HSS shall set the Result-Code AVP to DIAMETER\_SUCCESS in the Server-Assignment-Response command. If the Context Identifier is included in the request, the HSS may use it to locate the APN Configuration. + +If the APN corresponding to the PGW identity is not present in the subscription and the wild card APN is not present in the subscription, the HSS shall reject the request and set the Result-Code AVP to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the subscriber is not registered, the HSS shall reject the request and set the Experimental-Result-Code AVP to DIAMETER\_ERROR\_IDENTITY\_NOT\_REGISTERED. + - If it indicates any other value, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY, and no registration/de-registration or profile download procedure shall be performed. + +Origin-Host AVP shall contain the 3GPP AAA Server identity. + +If the subscription data received for a certain APN indicates that the APN was authorized as a consequence of having the Wildcard APN in the user subscription in HSS, then the 3GPP AAA Server shall not store this APN data beyond the lifetime of the UE sessions related to the specific APN and the 3GPP AAA Server shall delete them upon disconnection of the UE. If the PGW Identity contains an FQDN of the PDN GW, the 3GPP AAA Server shall retrieve the PGW PLMN ID from the MIP-Home-Agent-Host AVP within the MIP6-Agent-Info AVP which contains the PGW Identity. + +For trusted WLAN access, if the transparent single-connection mode is used as specified in 3GPP TS 24.302 [26], the 3GPP AAA Server may be configured by local policy to not update the HSS with the PGW Identity used over TWAN for the default APN of the user (i.e. to skip the Non-3GPP IP Access Registration request with Server-Assignment-Type set to "PGW\_UPDATE"). + +NOTE: This 3GPP AAA Server option can be used when the same APN is configured for TWAN and other access technologies in which case the network can select different PDN GWs for PDN connections to this APN. Updating the HSS with the selected PDN GW identity for Trusted WLAN access could affect PDN connections over other access technologies. + +### 8.1.2.2.3 Network Initiated De-Registration by HSS, Administrative + +#### 8.1.2.2.3.1 General + +This procedure is used between the 3GPP AAA Server and the HSS to remove a previous registration and all associated state. When the de-registration procedure is initiated by HSS, indicating that a subscription has to be removed, the 3GPP AAA Server subsequently triggers the detach procedure via the appropriate interface. + +**Table 8.3.2.3: Network Initiated Deregistration by HSS request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI and shall be formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Reason for de-registration | Deregistration-Reason | M | This IE shall contain the reason for the de-registration as the HSS shall send to the 3GPP AAA server a reason for the de-registration. The de-registration reason shall be composed of two parts: one textual message (if available) that is intended to be forwarded to the user that is de-registered, and one reason code (see 3GPP TS 29.229 [24]) that determines the behaviour of the 3GPP AAA Server. | +| Routing Information | Destination-Host | M | This IE shall contain the 3GPP AAA server name that is obtained from the Origin-Host AVP, which is received from the 3GPP AAA Server, | +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 8.3.2.4: Network Initiated Deregistration by HSS response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the Result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for SWx errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 8.1.2.2.3.2 Detailed behaviour + +The HSS shall de-register the affected identity and invoke this procedure to inform the 3GPP AAA server to remove the subscribed user from the 3GPP AAA Server. + +The HSS shall send in the Deregistration-Reason AVP the reason for the de-registration, composed by a textual message (if available) aimed for the user and a reason code that determines the action the 3GPP AAA server has to perform. The possible reason codes are: + +- PERMANENT\_TERMINATION: The non-3gpp subscription or service profile(s) has been permanently terminated or the Core Network Restrictions do not allow access to EPC anymore. The HSS shall clear the user's 3GPP AAA Server name and set the User Status to NOT\_REGISTERED. The 3GPP AAA Server should start the network initiated de-registration towards the user. +- NEW\_SERVER\_ASSIGNED: The HSS indicates to the 3GPP AAA Server that a new 3GPP AAA Server has been allocated to the user (e.g. because the previous assigned 3GPP AAA Server was found unavailable at a certain point). The 3GPP AAA Server shall remove all user data and session information for the user indicated in the de-registration request. The 3GPP AAA Server shall not start the network initiated de-registration towards the user. + +#### 8.1.2.3 HSS Initiated Update of User Profile + +##### 8.1.2.3.1 General + +According to the requirements described in 3GPP TS 23.402 [3], 3GPP TS 32.422 [32] and 3GPP TS 23.380 [52], SWx reference point shall enable: + +- Indication to 3GPP AAA Server of change of non-3GPP subscriber profile within HSS; +- Activation and deactivation of the subscriber and equipment trace in the PDN GW. +- Request of identity and location information of the access network and/or UE local time zone. +- Indication to the 3GPP AAA Server that the HSS-based P-CSCF restoration procedure for WLAN, shall be executed as described in 3GPP TS 23.380 [52] clause 5.6. + +This procedure is used between the 3GPP AAA Server and the HSS. The procedure is invoked by the HSS when the subscriber profile has been modified and needs to be sent to the 3GPP AAA Server. This may happen due to a modification in the HSS. + +The procedure is also invoked by the HSS to update the 3GPP AAA Server with + +- the identity of a dynamically allocated PDN GW which is included in the APN-Configuration AVP in the User Profile as a result of the first PDN connection establishment associated with an APN over 3GPP access; or +- the identity of a dynamically allocated PDN GW for emergency services as a result of the establishment of an emergency PDN connection in E-UTRAN. + +This procedure is mapped to the Diameter command codes Push-Profile-Request (PPR) and Push-Profile-Answer (PPA) specified in the 3GPP TS 29.229 [24]. Information element contents for these messages are shown in tables 8.1.2.3.1/1 and 8.1.2.3.1/2. + +**Table 8.1.2.3.1/1: User Profile Update request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI and shall be formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| User profile | Non-3GPP-User-Data | M | This IE shall contain the updated user profile. Clause 8.2.3.1 details the contents of the AVP.
In case of trace activation or deactivation, the Trace-Info AVP shall be included, and this may be the only AVP that is present under this grouped AVP. | +| Routing Information | Destination-Host | M | This IE shall contain the 3GPP AAA Server name that is obtained from the Origin-Host AVP, which is received from the 3GPP AAA Server | +| PPR Flags | PPR-Flags | O | This Information Element contains a bit mask. See 8.2.3.17 for the meaning of the bits. | +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 8.1.2.3.1/2: User Profile Update response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for SWx errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Access Network Information | Access-Network-Info | O | If present, this IE shall contain the identity and location information of the access network where the UE is attached. | +| Local Time Zone | Local-Time-Zone | O | If present, this IE shall contain the time zone of the location in the access network where the UE is attached. | +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 8.1.2.3.2 HSS Detailed behaviour + +The HSS shall make use of this procedure to update the relevant user profile in the 3GPP AAA server (e.g. change of subscription data or change of the identity of a dynamically allocated PDN GW associated with an APN), or activate / deactivate subscriber and equipment trace in the PDN GW. + +The HSS shall make use of this procedure to request the identity, location information and UE local time zone of the access network where the UE is currently attached. In this case, the HSS shall set the Access-Network-Info-Request and/or the UE-Local-Time-Zone-Request bits in the PPR-Flags AVP; if the HSS sends this command for the only purpose of requesting access network information or the local time zone of the UE (i.e., the user profile is not actually modified), the Non-3GPP-User-Data shall be included in the command as an empty AVP. The HSS shall only invoke this procedure if the 3GPP AAA Server has indicated support for the corresponding feature (see clause 8.2.3.16). + +The HSS shall make use of this procedure to request to the 3GPP AAA Server the execution of the HSS-based P-CSCF restoration procedure, as described in 3GPP TS 23.380 [52] clause 5.4 if the 3GPP AAA Server indicated the support of this procedure in an earlier command to the HSS. In this case, the HSS shall set the "P-CSCF Restoration Request" bit in the PPR Flags and the procedure shall only be used for the purpose of the P-CSCF restoration for WLAN; then, the Non-3GPP-User-Data AVP shall be included as an empty AVP. + +The HSS shall make use of this procedure to update the identity of a dynamically allocated PDN GW for emergency services in the 3GPP AAA server, if the 3GPP AAA Server indicated the support of the Emergency Services Continuity feature in an earlier command to the HSS. + +#### 8.1.2.3.3 3GPP AAA Server Detailed behaviour + +When the HSS-initiated user profile update procedure is successful, the 3GPP AAA Server shall overwrite entirely, for the subscriber identity indicated in the request, the currently stored user profile data with the information received from the HSS, if at least one APN-Configuration AVP is included in the Non-3GPP-User-Data AVP received from HSS. If no APN-Configurations are included in the Non-3GPP-User-Data AVP, the 3GPP AAA Server shall only update the currently stored user profile data with the new received data from the HSS. + +If the HSS-initiated user profile update procedure is not successful, the 3GPP AAA Server shall not modify the stored user profile. + +After a successful user profile download, the 3GPP AAA Server shall initiate re-authentication procedure as described in clause 7.2.2.4 if the subscriber has previously been authenticated and authorized to untrusted non-3GPP access. If the subscriber has previously been authenticated and authorized to trusted non-3GPP IP Access then the 3GPP AAA Server shall initiate a re-authorization procedure as described in clause 5.1.2.3. + +As multiple authorization sessions may exist for the user (see clause 7.1.2.1), the 3GPP AAA Server shall examine the need to execute re-authorization for each of these sessions, and may execute the multiple re-authorization procedures in parallel. In case the user's non-3GPP subscription has been deleted or the user's APN has been barred, the re-authorization shall be executed in all ongoing user related authorization sessions. Otherwise, the re-authorization procedure shall be invoked for the authorization sessions for which at least one of the following conditions is fulfilled: + +- The user's subscribed APN has been deleted from the HSS. +- The APN configuration data has been previously downloaded to the ePDG and the new version of APN configuration received from HSS reflects a modification in these data. + +Following a successful download of subscription and equipment trace data, the 3GPP AAA Server shall forward the trace data by initiating reauthorization towards all PDN GWs that have an active authorization session. + +When the UE is attached to a Trusted WLAN, if the HSS has invoked the User Profile Update procedure by setting the Access-Network-Info-Request and/or UE-Local-Time-Zone-Request bits in the PPR-Flags, the 3GPP AAA Server shall initiate a re-authorization procedure towards the TWAN by setting the Re-Auth-Request-Type to AUTHORIZE\_ONLY; the TWAN shall send the identification, location information of the Access Point where the UE is attached and the local time zone of the UE, in the subsequent authorization request (AAR command) that follows the re-authorization request/answer exchange (RAR/RAA). If the 3GPP AAA Server determines that the UE is not currently attached to a Trusted WLAN, it shall not initiate any re-authorization procedure towards the access network, and it shall not include any network access information or UE local time zone in the response to the HSS. + +NOTE: The 3GPP AAA Server cannot answer the Push Profile Request received from the HSS until the AAR command has been received from the TWAN, since it needs to receive the information from the access network, before sending back the Push Profile Answer to the HSS. + +If the 3GPP AAA Server receives the Push-Profile-Request command with an empty Non-3GPP-User-Data AVP, but some other action is indicated by setting any of the bits in the PPR-Flags AVP, the 3GPP AAA Server shall ignore the Non-3GPP-User-Data AVP, i.e., it shall not apply any changes to the stored user profile. + +When the PPR Flags are received with the "P-CSCF Restoration Request" bit set, if an IMS PDN connection is established via a trusted or untrusted WLAN access for which the PGW has indicated the support of the P-CSCF restoration feature in an earlier command, the 3GPP AAA Server shall execute the HSS-based P-CSCF restoration for WLAN procedure, as described in 3GPP TS 23.380 [52] clause 5.6. Otherwise, the 3GPP AAA Server does not execute the HSS-based P-CSCF restoration for WLAN procedure. + +Table 8.1.2.3.3/1 details the valid result codes that the 3GPP AAA Server can return in the response. + +**Table 8.1.2.3.3/1: User profile response valid result codes** + +| Result-Code AVP value | Condition | +|-----------------------------|----------------------------------------------------------------------| +| DIAMETER_SUCCESS | The request succeeded. | +| DIAMETER_ERROR_USER_UNKNOWN | The request failed because the user is not found in 3GPP AAA Server. | +| DIAMETER_UNABLE_TO_COMPLY | The request failed. | + +Based on operator policy, if the 3GPP AAA Server receives from the HSS a non-3GPP-User-Data AVP with an MPS-Priority AVP with the MPS-EPS-Priority bit set, the 3GPP AAA Server shall treat commands for the UE with priority as specified in Annex C and Annex D. If the 3GPP AAA Server receives a Non-3GPP-User-Data AVP without an MPS-Priority AVP with the MPS-EPS-Priority bit set and if the last DER command received by the 3GPP AAA Server from the ePDG or the TWAN did not contain a High-Priority-Access-Info AVP with the HPA\_Configured bit set, the 3GPP AAA Server shall discontinue priority treatment of commands for the UE. + +NOTE 2: The 3GPP AAA Server treats the UE with priority if either the DER command from the ePDG indicates high priority access or the HSS has indicated an MPS subscription for the UE. + +## 8.1.2.4 Fault Recovery Procedures + +### 8.1.2.4.1 HSS Reset Indication + +#### 8.1.2.4.1.1 General + +This procedure is used by the HSS to indicate to the 3GPP AAA Server that it has restarted, and the registration data and the dynamic data stored for a set of users may have been lost. + +This procedure is mapped to the Diameter command codes Push-Profile-Request (PPR) and Push-Profile-Answer (PPA) specified in the 3GPP TS 29.229 [24]. Information Element contents for these messages are shown in tables 8.1.2.4.1.1/1 and 8.1.2.4.1.1/2. + +**Table 8.1.2.4.1.1/1: HSS Reset Indication Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User List | User-Name
(See IETF RFC 6733 [58]) | M | This information element shall indicate the users affected by the HSS restart. It shall contain either:
- The string "*", if all users are affected by the restart
- The leading digits of the IMSI series of the set of users affected by the restart. | +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| PPR Flags | PPR-Flags | M | This Information Element contains a bit mask. See 8.2.3.17 for the meaning of the bits. The HSS shall set the Reset-Indication bit when sending PPR to the 3GPP AAA Server. | + +**Table 8.1.2.4.1.1/2: HSS Reset Indication Response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for SWx errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 8.1.2.4.1.2 HSS Detailed behaviour + +The HSS shall use this procedure to indicate to the 3GPP AAA Server about a restart event, affecting a set of users, for whom their registration data and dynamic data may have been lost. The HSS shall only send this command if the 3GPP AAA Server has indicated support for the "HSS Restoration" feature. In this case, the HSS shall set the Reset-Indication bit in the PPR-Flags AVP in the PPR command. + +NOTE: If there are multiple 3GPP AAA Servers deployed in the HPLMN, and the HSS is configured (in an implementation-specific manner) in such a way that it can determine that a certain 3GPP AAA Server does not contain any of the users affected by the restart, it can skip sending the PPR command to that specific 3GPP AAA Server. + +#### 8.1.2.4.1.3 3GPP AAA Server Detailed behaviour + +If the 3GPP AAA Server supports the "HSS Restoration" feature, it shall answer with a successful result to the PPR command, and it shall mark those users affected by the HSS restart as "pending to be restored in HSS". + +The 3GPP AAA Server shall use the HSS Identity received in the Origin-Host AVP (by comparing it with the value stored after a successful MAA command) and may make use of the received "User List" Information Element in order to determine which subscriber records are impacted, if any. If the 3GPP AAA Server determines that there are no subscribers affected by the HSS restart, it shall answer with a successful result to the HSS. + +#### 8.1.2.4.2 HSS Restoration + +##### 8.1.2.4.2.1 General + +This procedure is used by the 3GPP AAA Server to restore in the HSS the registration data and the dynamic data for a certain user. The 3GPP AAA Server shall use this procedure only after having received a previous indication from HSS of a restart event affecting that user. + +This procedure is mapped to the Diameter command codes Server-Assignment-Request (SAR) and Server-Assignment-Answer (SAA) specified in the 3GPP TS 29.229 [24]. Information element contents for these messages are shown in tables 8.1.2.4.2.1/1 and 8.1.2.4.2.1/2. + +**Table 8.1.2.4.2.1/1: HSS Restoration Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [58]) | M | This information element shall contain the IMSI of the user, for whom the registration data and dynamic data is being restored in HSS, and it shall be formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Server Assignment Type | Server-Assignment-Type | M | This IE shall contain the value "RESTORATION". | +| Active APN | Active-APN | C |

This Information Element, if present, contains the list of active APNs stored by the 3GPP AAA Server for this user, including the identity of the PDN GW assigned to each APN. For the explicitly subscribed APNs, the following information shall be present:

  • - Context-Identifier: context id of subscribed APN in use
  • - Service-Selection: name of subscribed APN in use
  • - MIP6-Agent-Info: including PDN GW identity in use for subscribed APN
  • - Visited-Network-Identifier: identifies the PLMN where the PDN GW was allocated

For the Wildcard APN, the following information shall be present:

  • - Context-Identifier: context id of the Wildcard APN
  • - Specific-APN-Info: list of APN-in use and related PDN GW identity when the subscribed APN is the wildcard APN
| +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 8.1.2.4.2.1/2: HSS Restoration Response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [58]) | M | This information element shall contain the user IMSI and shall be formatted according to 3GPP TS 23.003 [14], clause 2.2. | +| Registration result | Result-Code / Experimental-Result | M |

This IE contains the result of the operation.

The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).

The Experimental-Result AVP shall be used for SWx errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.

| +| Supported Features
(See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 8.1.2.4.2.2 HSS Detailed behaviour + +Upon receipt of the SAR command, if the HSS supports the "HSS Restoration" feature, and the user's IMSI is known, the HSS shall update the registration data (from the Origin-Host AVP received in the 3GPP AAA Server command) and dynamic data of the user (included in the "Active APN" Information Element), and answer with a successful result. + +#### 8.1.2.4.2.3 3GPP AAA Server Detailed behaviour + +The 3GPP AAA Server shall use this command to update the HSS with the registration data and dynamic data it has for a user affected by the HSS restart, identified by the "User List" IE received previously in the PPR command, and marked in the 3GPP AAA Server as "pending to be restored in HSS". The 3GPP AAA Server shall only make use of this procedure in the HSS has indicated support for the "HSS Restoration" feature. + +The 3GPP AAA Server shall invoke the SAR command towards the HSS, after having received further interactions over other reference points (S6b, STa, SWm ...) for a user marked as "pending to be restored in HSS". + +Once the 3GPP AAA Server receives confirmation from HSS, in the SAA command, that the user has been successfully restored in the HSS, via the "HSS Restoration Response" command, it shall clear the "pending to be restored in HSS" flag for that user. + +## 8.2 Protocol Specification + +### 8.2.1 General + +The SWx reference point shall be Diameter based. This is defined as an IETF vendor specific Diameter application, where the Vendor ID is 3GPP. The Application Id used shall be 16777265. + +### 8.2.2 Commands + +#### 8.2.2.1 Authentication Procedure + +The Multimedia-Authentication-Request (MAR) command, indicated by the Command-Code field set to 303 and the 'R' bit set in the Command Flags field, is sent by the 3GPP AAA Server to the HSS in order to request security information. This corresponds to clause 8.1.2.1. + +##### Message Format + +``` +< Multimedia-Auth-Request > ::= < Diameter Header: 303, REQ, PXY, 16777265 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { User-Name } + [ RAT-Type ] + [ AN-Trusted ] + [ ANID ] + [ Visited-Network-Identifier ] + [ Terminal-Information ] + { SIP-Auth-Data-Item } + { SIP-Number-Auth-Items } + [ AAA-Failure-Indication ] + [ OC-Supported-Features ] + *[ Supported-Features ] + ... + *[ AVP ] +``` + +The Multimedia-Authentication-Answer (MAA) command, indicated by the Command-Code field set to 303 and the 'R' bit cleared in the Command Flags field, is sent by a server in response to the Multimedia-Authentication-Request command. The Result-Code or Experimental-Result AVP may contain one of the values defined in clause 6.2 of 3GPP TS 29.229 [24] in addition to the values defined in IETF RFC 6733 [58]. + +#### Message Format + +``` +< Multimedia-Auth-Answer > ::= < Diameter Header: 303, PXY, 16777265 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { User-Name } + [ SIP-Number-Auth-Items ] + *[ SIP-Auth-Data-Item ] + [ 3GPP-AAA-Server-Name ] + [ OC-Supported-Features ] + [ OC-OLR ] ] + *[ Load ] + *[ Supported-Features ] + ... + *[ AVP ] +``` + +NOTE: As the Diameter commands described in this specification have been defined based on the former specification of the Diameter base protocol, the Vendor-Specific-Application-Id AVP is still listed as a required AVP (an AVP indicated as {AVP}) in the command code format specifications defined in this specification to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter base protocol (IETF RFC 6733 [58]). + +### 8.2.2.2 HSS Initiated Update of User Profile Procedure + +The Push-Profile-Request (PPR) command, indicated by the Command-Code field set to 305 and the 'R' bit set in the Command Flags field, is sent by the HSS to the 3GPP AAA Server in order to update the subscription data whenever a modification has occurred in the subscription data; this corresponds to clause 8.1.2.3. This command is also sent by HSS to indicate a restart event to the 3GPP AAA Server, so the registration data and the dynamic data previously stored in HSS can be restored; this corresponds to clause 8.1.2.4.1. + +#### Message Format + +``` +< Push-Profile-Request > ::= < Diameter Header: 305, REQ, 16777265 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + [ Non-3GPP-User-Data ] + [ PPR-Flags ] + *[ Supported-Features ] + ... + *[ AVP ] +``` + +The Push-Profile-Answer (PPA) command, indicated by the Command-Code field set to 305 and the 'R' bit cleared in the Command Flags field, is sent by the HSS in response to the Push-Profile-Request command. The Result-Code or + +Experimental-Result AVP may contain one of the values defined in clause 6.2 of 3GPP TS 29.229 [24] in addition to the values defined in IETF RFC 6733 [58]. + +#### Message Format + +``` +< Push-Profile-Answer > ::= < Diameter Header: 305, PXY, 16777265 > +< Session-Id > +[ DRMP ] +{ Vendor-Specific-Application-Id } +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Access-Network-Info ] +[ Local-Time-Zone ] +*[ Supported-Features ] +... +*[ AVP ] +``` + +NOTE: As the Diameter commands described in this specification have been defined based on the former specification of the Diameter base protocol, the Vendor-Specific-Application-Id AVP is still listed as a required AVP (an AVP indicated as {AVP}) in the command code format specifications defined in this specification to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter base protocol (IETF RFC 6733 [58]). + +### 8.2.2.3 Non-3GPP IP Access Registration Procedure + +The Server-Assignment-Request (SAR) command, indicated by the Command-Code field set to 301 and the 'R' bit set in the Command Flags field, is sent by the 3GPP AAA Server to the HSS; this corresponds to clause 8.1.2.2.2. This command is also sent by the 3GPP AAA Server to restore the registration data and the dynamic data previously stored in HSS, which may have been lost after a restart; this corresponds to clause 8.1.2.4.2. + +#### Message Format + +``` +< Server-Assignment-Request > ::= < Diameter Header: 301, REQ, PXY, 16777265 > +< Session-Id > +[ DRMP ] +{ Vendor-Specific-Application-Id } +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Destination-Host ] +{ Destination-Realm } +[ Service-Selection ] +[ Context-Identifier ] +[ MIP6-Agent-Info ] +[ Visited-Network-Identifier ] +{ User-Name } +{ Server-Assignment-Type } +*[ Active-APN ] +[ OC-Supported-Features ] +*[ Supported-Features ] +[ Terminal-Information ] +[ Emergency-Services ] +... +*[ AVP ] +``` + +The Server-Assignment-Answer (SAA) command, indicated by the Command-Code field set to 301 and the 'R' bit cleared in the Command Flags field, is sent by the HSS to the 3GPP AAA Server to confirm the registration, + +de-registration, user profile download or restoration procedure. The Result-Code or Experimental-Result AVP may contain one of the values defined in clause 6.2 of 3GPP TS 29.229 [24] in addition to the values defined in IETF RFC 6733 [58]. + +#### Message Format + +``` +< Server-Assignment-Answer > ::= < Diameter Header: 301, PXY, 16777265 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { User-Name } + [ Non-3GPP-User-Data ] + [ 3GPP-AAA-Server-Name ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + ... + *[ AVP ] +``` + +NOTE: As the Diameter commands described in this specification have been defined based on the former specification of the Diameter base protocol, the Vendor-Specific-Application-Id AVP is still listed as a required AVP (an AVP indicated as {AVP}) in the command code format specifications defined in this specification to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter base protocol (IETF RFC 6733 [58]). + +#### 8.2.2.4 Network Initiated De-Registration by HSS Procedure + +The Registration-Termination-Request (RTR) command, indicated by the Command-Code field set to 304 and the "R" bit set in the Command Flags field, is sent by a Diameter Multimedia server to a Diameter Multimedia client in order to request the de-registration of a user. This corresponds to clause 8.1.2.2.3. + +#### Message Format + +``` + ::= < Diameter Header: 304, REQ, PXY, 16777265 > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + { Deregistration-Reason } + *[ Supported-Features ] + ... + *[ AVP ] +``` + +The Registration-Termination-Answer (RTA) command, indicated by the Command-Code field set to 304 and the "R" bit cleared in the Command Flags field, is sent by a client in response to the Registration-Termination-Request command. The Result-Code or Experimental-Result AVP may contain one of the values defined in clause 6.2 of 3GPP TS 29.229 [24] in addition to the values defined in IETF RFC 6733 [58]. + +#### Message Format + +``` + ::= < Diameter Header: 304, PXY, 16777265 > + < Session-Id > +``` + +``` + +[ DRMP ] +{ Vendor-Specific-Application-Id } +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +*[ Supported-Features ] +... +*[ AVP ] + +``` + +NOTE: As the Diameter commands described in this specification have been defined based on the former specification of the Diameter base protocol, the Vendor-Specific-Application-Id AVP is still listed as a required AVP (an AVP indicated as {AVP}) in the command code format specifications defined in this specification to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter base protocol (IETF RFC 6733 [58]). + +## 8.2.3 Information Elements + +### 8.2.3.0 General + +The following table describes the Diameter AVPs defined for the SWx interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +**Table 8.2.3.0/1: Diameter SWx AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | +|-----------------------------|----------|----------------|------------------|----------------|-----|------------|----------| +| | | | | Must | May | Should not | Must not | +| Non-3GPP-User-Data | 1500 | 8.2.3.1 | Grouped | M,V | | | P | +| Non-3GPP-IP-Access | 1501 | 8.2.3.3 | Enumerated | M,V | | | P | +| Non-3GPP-IP-Access-APN | 1502 | 8.2.3.4 | Enumerated | M,V | | | P | +| ANID | 1504 | 5.2.3.7 | UTF8String | M,V | | | P | +| Trace-Info | 1505 | 8.2.3.13 | Grouped | V | | | M,P | +| PPR-Flags | 1508 | 8.2.3.17 | Unsigned32 | V | | | M,P | +| TWAN-Default-APN-Context-Id | 1512 | 8.2.3.18 | Unsigned32 | V | | | M,P | +| TWAN-Access-Info | 1510 | 8.2.3.19 | Grouped | V | | | M,P | +| Access-Authorization-Flags | 1511 | 8.2.3.20 | Unsigned32 | V | | | M,P | +| WLAN-Identifier | 1509 | 5.2.3.18 | Grouped | V | | | M,P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | +| AAA-Failure-Indication | 1518 | 8.2.3.21 | Unsigned32 | V | | | M,P | +| Access-Network-Info | 1524 | 5.2.3.24 | Grouped | V | | | M,P | +| 3GPP-AAA-Server-Name | 318 | 8.2.3.24 | DiameterIdentity | M, V | | | P | +| ERP-Authorization | 1541 | 8.2.3.27 | Unsigned32 | V | | | M,P | +| AN-Trusted | 1503 | 5.2.3.9 | Enumerated | V | | | M,P | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table describes the Diameter AVPs re-used by the SWx interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within SWx. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol (see IETF RFC 6733 [58]), do not need to be supported. + +**Table 8.2.3.0/2: SWx re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | M-bit | +|-------------------------------|---------------------|---------------------|--------------| +| User-Name | ETF RFC 6733 [58] | | | +| Session-Timeout | ETF RFC 6733 [58] | | | +| Subscription-ID | IETF RFC 4006 [20] | | | +| MIP6-Agent-Info | IETF RFC 5447 [6] | | | +| MIP6-Feature-Vector | IETF RFC 5447 [6] | | | +| Service-Selection | IETF RFC 5778 [11] | | | +| 3GPP-Charging-Characteristics | 3GPP TS 29.061 [31] | | | +| RAT-Type | 3GPP TS 29.212 [23] | | | +| Visited-Network-Identifier | 3GPP TS 29.229 [24] | | | +| SIP-Number-Auth-Items | 3GPP TS 29.229 [24] | | | +| SIP-Item-Number | 3GPP TS 29.229 [24] | | | +| SIP-Auth-Data-Item | 3GPP TS 29.229 [24] | | | +| SIP-Authentication-Scheme | 3GPP TS 29.229 [24] | | | +| SIP-Authenticate | 3GPP TS 29.229 [24] | | | +| SIP-Authorization | 3GPP TS 29.229 [24] | | | +| Confidentiality-Key | 3GPP TS 29.229 [24] | | | +| Integrity-Key | 3GPP TS 29.229 [24] | | | +| Server-Assignment-Type | 3GPP TS 29.229 [24] | | | +| Deregistration-Reason | 3GPP TS 29.229 [24] | | | +| Supported-Features | 3GPP TS 29.229 [24] | | | +| Feature-List-ID | 3GPP TS 29.229 [24] | | | +| Feature-List | 3GPP TS 29.229 [24] | | | +| APN-Configuration | 3GPP TS 29.272 [29] | | | +| Context-Identifier | 3GPP TS 29.272 [29] | | | +| Terminal-Information | 3GPP TS 29.272 [29] | | | +| AMBR | 3GPP TS 29.272 [29] | | | +| APN-OI-Replacement | 3GPP TS 29.272 [29] | | | +| Trace-Reference | 3GPP TS 29.272 [29] | | | +| Trace-Data | 3GPP TS 29.272 [29] | | | +| Active-APN | 3GPP TS 29.272 [29] | | | +| BSSID | 3GPP TS 32.299 [30] | | | +| Location-Information | IETF RFC 5580 [46] | | | +| Location-Data | IETF RFC 5580 [46] | | | +| Operator-Name | IETF RFC 5580 [46] | | | +| Local-Time-Zone | 3GPP TS 29.272 [29] | | | +| OC-Supported-Features | IETF RFC 7683 [47] | See clause 8.2.3.22 | Must not set | +| OC-OLR | IETF RFC 7683 [47] | See clause 8.2.3.23 | Must not set | +| DRMP | IETF RFC 7944 [53] | See clause 8.2.3.25 | Must not set | +| Emergency-Info | 3GPP TS 29.272 [29] | | | +| Load | IETF RFC 8583 [54] | See clause 8.2.3.26 | Must not set | +| UE-Usage-Type | 3GPP TS 29.272 [29] | | | +| Core-Network-Restrictions | 3GPP TS 29.272 [29] | | | +| MPS-Priority | 3GPP TS 29.272 [29] | | Must not set | + +NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +Only those AVP initially defined in this reference point or AVP with values initially defined in this reference point and for this procedure are described in the following clauses. + +### 8.2.3.1 Non-3GPP-User-Data + +The Non-3GPP-User-Data AVP is of type Grouped. It contains the information related to the user profile relevant for EPS. + +AVP format: + +``` +Non-3GPP-User-Data ::= < AVP Header: 1500 10415 > + [ Subscription-ID ] + [ Non-3GPP-IP-Access ] + [ Non-3GPP-IP-Access-APN ] + *[ RAT-Type ] + [ Session-Timeout ] + [ MIP6-Feature-Vector ] + [ AMBR ] + [ 3GPP-Charging-Characteristics ] + [ Context-Identifier ] + [ APN-OI-Replacement ] + *[ APN-Configuration ] + [ Trace-Info ] + [ TWAN-Default-APN-Context-Id ] + *[ TWAN-Access-Info ] + [ UE-Usage-Type ] + [ Emergency-Info ] + [ ERP-Authorization ] + [ Core-Network-Restrictions ] + [ MPS-Priority ] + *[ AVP ] +``` + +The Subscription-ID, if present in this grouped AVP, shall contain either an MSISDN (if this identity is present in the subscription), or an External Identifier (if the subscriber does not have an MSISDN identity but has an External Identifier in the subscription). + +The AMBR included in this grouped AVP shall include the AMBR associated to the user's subscription (UE-AMBR). + +The APN-OI-Replacement included in this grouped AVP shall include the UE level APN-OI-Replacement associated to the user's subscription. This APN-OI-Replacement has lower priority than APN level APN-OI-Replacement that is included in the APN-Configuration AVP. + +The Non-3GPP-User-Data AVP shall only contain APN-Configuration AVP(s) configured in the user subscription with an IP PDN type. + +The Context-Identifier in this grouped AVP shall identify the user's default APN configuration. The TWAN-Default-APN-Context-Id AVP identifies the default APN configuration for EPC access over Trusted WLAN. This AVP shall be present if the default APN configuration for EPC access over Trusted WLAN differs from the default APN configuration for 3GPP access and other non-3GPP accesses. This AVP may be present otherwise. + +The RAT-Type AVP(s) shall include the access technology type(s) not allowed for the user as specified in clause 2.13.126 of 3GPP TS 23.008 [49]. + +The Emergency-Info AVP shall contain the identity of the PDN-GW used for the establishment of emergency PDN connections. + +The MIP6-Feature-Vector may provide HSM and/or NBM authorization information (see clause 8.2.3.28). + +For the conditions specified in clause 8.1.2.3.2, the Non-3GPP-User-Data AVP shall be empty, i.e. not include any AVP. + +If the Non-3GPP-User-Data AVP is not empty, the Non-3GPP-IP-Access AVP, the Non-3GPP-IP-Access-APN AVP, the Context-Identifier AVP and at least one item of the APN-Configuration AVP shall always be included, except when the Non-3GPP-User-Data AVP is used for downloading trace activation or deactivation information on the SWx + +interface, for an already registered user, or when the Non-3GPP-User-Data is used for downloading the Emergency-Info. In those specific cases, the Trace-Info AVP, or respectively the Emergency-Info AVP, shall be included and the presence of any further AVPs is optional. + +The MPS-Priority AVP shall be present if an MPS subscription exists in the HSS for the UE. + +### 8.2.3.2 Subscription-ID + +The Subscription-ID AVP is of type Grouped and indicates the user identity to be used for charging purposes. It is defined in the IETF RFC 4006 [20]. EPC shall make use only of the MSISDN and External Identifier values. + +When the identity to be conveyed is an MSISDN, the AVP Subscription-Id-Type shall be set to value "END\_USER\_E164". + +When the identity to be conveyed is an External Identifier, the AVP Subscription-Id-Type shall be set to value "END\_USER\_NAI". + +Then AVP Subscription-Id-Data, with type UTF8String, shall contain the identity of the user. + +AVP format: + +``` +Subscription-Id ::= < AVP Header: 443 > + [ Subscription-Id-Type ] + [ Subscription-Id-Data ] +``` + +### 8.2.3.3 Non-3GPP-IP-Access + +The Non-3GPP-IP-Access AVP (AVP code 1501) is of type Enumerated, and allows operators to determine if the subscriber is barred from using the non-3GPP access network. The following values are defined: + +NON\_3GPP\_SUBSCRIPTION\_ALLOWED (0) + +The subscriber has non-3GPP subscription and is authorized to use the non-3GPP access network. + +NON\_3GPP\_SUBSCRIPTION\_BARRED (1) + +The subscriber is barred from using the non-3GPP access network. + +### 8.2.3.4 Non-3GPP-IP-Access-APN + +The Non-3GPP-IP-Access-APN AVP (AVP code 1502) is of type Enumerated, and allows operator to disable all APNs for a subscriber at one time. The following values are defined: + +Non\_3GPP\_APNS\_ENABLE (0) + +Enable all APNs for a subscriber. + +Non\_3GPP\_APNS\_DISABLE (1) + +Disable all APNs for a subscriber + +### 8.2.3.5 RAT-Type + +The RAT-Type AVP (AVP code 1032) is of type Enumerated. The encoding of the AVP is specified in 3GPP TS 29.212 [23]. + +### 8.2.3.6 Session-Timeout + +The Session-Timeout AVP is of type Unsigned32. It is defined in IETF RFC 6733 [58] and indicates the maximum period for a session measured in seconds. This AVP is used for re-authentication purposes. If this field is not used, the non-3GPP Access Node will apply default time intervals. + +### 8.2.3.7 APN-Configuration + +The APN-Configuration AVP is of type Grouped AVP and is defined in 3GPP TS 29.272 [29]. + +The following AVPs defined in the APN-Configuration AVP in 3GPP TS 29.272 [29] are not applicable to Non-3GPP accesses and therefore need not be included in the APN-Configuration AVP over the SWx, SWd, SWm, STa and S6b reference points: + +- LIPA-Permission AVP +- Restoration-Priority AVP +- SIPTO-Local-Network-Permission AVP +- WLAN-offloadability AVP +- Non-IP-PDN-Type-Indicator AVP +- Non-IP-Data-Delivery-Mechanism AVP +- SCEF-ID AVP +- SCEF-Realm AVP +- Preferred-Data-Mode AVP + +### 8.2.3.8 ANID + +The ANID AVP is defined in clause 5.2.3.7. + +### 8.2.3.9 SIP-Auth-Data-Item + +The SIP-Auth-Data-Item AVP is defined in 3GPP TS 29.229 [24]. The optional AVPs that are needed in SWx reference point are included in the ABNF representation below. + +AVP format: + +``` +SIP-Auth-Data-Item ::= < AVP Header: 612 10415 > + [ SIP-Item-Number ] + [ SIP-Authentication-Scheme ] + [ SIP-Authenticate ] + [ SIP-Authorization ] + [ Confidentiality-Key ] + [ Integrity-Key ] + *[ AVP ] +``` + +### 8.2.3.10 Confidentiality-Key + +The Confidentiality-Key AVP is defined in 3GPP TS 29.229 [24]. It is of type OctetString, and contains the Confidentiality Key (CK') or, after key derivation using the Access Network Identifier, the Confidentiality Key (CK'). For the 3GPP AAA server it is transparent whether the value received corresponds to CK or CK'. + +### 8.2.3.11 Integrity-Key + +The Integrity-Key AVP is defined in 3GPP TS 29.229 [24]. It is of type OctetString, and contains the Integrity Key (IK) or, after key derivation using the Access Network Identifier, the Integrity Key (IK'). For the 3GPP AAA server it is transparent whether the value received corresponds to IK or IK'. + +### 8.2.3.12 Server-Assignment-Type AVP + +The Server-Assignment-Type AVP is defined in 3GPP TS 29.229 [24] and it is of type Enumerated, and indicates the type of server update being performed in a Server-Assignment-Request operation. As part of the SWx protocol specification, the following values are additionally defined: + +**AAA\_USER\_DATA\_REQUEST (12)** + +This value is used to request the non-3GPP user profile data from the 3GPP AAA Server to the HSS. + +**PGW\_UPDATE (13)** + +This value is used to store, update or delete the PDN-GW Identity in the HSS, as requested from the 3GPP AAA Server. + +**RESTORATION (14)** + +This value is used to store in the HSS registration data and dynamic data that may have been potentially lost after a restart event. + +### 8.2.3.13 Trace-Info + +The Trace-Info AVP is of type Grouped. This AVP shall contain the information related to subscriber and equipment trace function and the required action, i.e. activation or deactivation + +AVP format + +Trace-Info ::= < AVP header: 1505 10415> + +[Trace-Data] + +[Trace-Reference] + +\*[AVP] + +Either the Trace-Data or the Trace-Reference AVP shall be included. When trace activation is needed, Trace-Data AVP shall be included, while the trace deactivation request shall be signalled by including the Trace-Reference directly under the Trace-Info. The Trace-Reference AVP is of type OctetString. The Diameter AVP is defined in 3GPP TS 29.272 [29]. + +### 8.2.3.14 Trace-Data + +The Trace-Data AVP is of type Grouped. The Diameter AVP is defined in 3GPP TS 29.272 [29]. + +### 8.2.3.15 Feature-List-ID AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. For this release, the Feature-List-ID AVP value shall be set to 1 for the SWx application. + +### 8.2.3.16 Feature-List AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. A null value indicates that there is no feature used by the SWx application. The meaning of the bits shall be as defined in table 8.2.3.16/1. + +**Table 8.2.3.16/1: Features of Feature-List-ID 1 used in SWx** + +| Feature bit | Feature | M/O | Description | +|-------------|--------------------------------------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | HSS Restoration | O |

HSS Restoration

This feature is applicable for the MAR/MAA, PPR/PPA and SAR/SAA command pairs.
If the 3GPP AAA Server does not indicate support for this feature in a former MAR or SAR command, the HSS shall not send a PPR command to indicate a restart event to the 3GPP AAA Server.

| +| 1 | Access-Network-Information-Retrieval | O |

Access Network Information Retrieval

This feature is applicable for the MAR/MAA and PPR/PPA and SAR/SAA command pairs.
If the 3GPP AAA Server does not indicate support for this feature in a former MAR or SAR command, the HSS shall not send a PPR command to request access network information from the 3GPP AAA Server.

| +| 2 | UE Local Time Zone Retrieval | O |

UE Local Time Zone Retrieval

This feature is applicable for the MAR/MAA and PPR/PPA and SAR/SAA command pairs.
If the 3GPP AAA Server does not indicate support for this feature in a former MAR or SAR command, the HSS shall not send a PPR command to request the local time zone of the UE from the 3GPP AAA Server.

| +| 3 | P-CSCF Restoration for WLAN | O |

Support of P-CSCF Restoration for WLAN

This feature is applicable to the MAR/MAA and PPR/PPA and SAR/SAA command pairs over the SWx interface, when the 3GPP AAA Server supports the execution of the P-CSCF restoration procedures for WLAN as described in 3GPP TS 23.380 [52] clause 5.6.
If the 3GPP AAA Server does not indicate support of this feature in a former MAR or SAR command, the HSS shall not send a PPR command requesting the execution of HSS-based P-CSCF restoration procedures for WLAN,

| +| 4 | Emergency Services Continuity | O |

Support of Emergency Services Continuity

This feature is applicable to the PPR/PPA and SAR/SAA command pairs over the SWx interface, when the HSS and the 3GPP AAA Server support the continuity of emergency services upon mobility between 3GPP and WLAN accesses, as specified in clause 4.5.7.2 of 3GPP TS 23.402 [3].
If the 3GPP AAA Server does not indicate support of this feature in a former SAR command, the HSS shall not include the Emergency Info in a SAA command and shall not send a PPR command to update the Emergency Info.
If the HSS does not indicate support of this feature in a former SAA command (e.g. during the registration of the non-3GPP user), the 3GPP AAA Server shall not send a SAR command to update the Emergency Info.
If the HSS supports this feature on SWx, it shall also support the Emergency Service Continuity feature on S6a, see 3GPP TS 29.272 [29].

| +| 5 | ERP | O |

Support of EAP Reauthentication Protocol

This feature is applicable to the MAR/MAA and PPR/PPA command pairs over the SWx interface.
If the 3GPP AAA Server does not indicate support of this feature in a former MAR command, the HSS shall not include ERP authorization data in the subscription profile, and it shall not send subsequent PPR commands to update the ERP authorization status of this user.
If the HSS does not indicate support of this feature in the MAA command, the 3GPP AAA Server shall not expect the reception of explicit authorization of ERP in the subscription profile, and may allow/disallow ERP for all subscribers, according to local policy.

| + +| | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 6 | Dedicated Core Networks | O |

Support of Dedicated Core Networks

This feature is applicable to the SAR/SAA and PPR/PPA command pairs over the SWx interface.

If the 3GPP AAA Server does not indicate support of this feature in the SAR command, the HSS shall not send DCN-related subscription data (e.g., UE Usage Type) in SAA, and shall not send subsequent PPR commands when such subscription data are updated.

If the 3GPP AAA Server does not indicate support of this feature in the PPA command and the HSS has already sent DCN-related subscription data in PPR, the HSS may store this indication and not send further updates related to DCN subscription data.

| +| Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1".
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature. | | | | + +Features that are not indicated in the Supported-Features AVPs within a given application message shall not be used to construct that message. + +### 8.2.3.17 PPR-Flags + +The PPR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 8.2.3.17/1: + +**Table 8.2.3.17/1: PPR-Flags** + +| Bit | Name | Description | +|-------|--------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Reset-Indication | This bit, when set, indicates that the HSS has undergone a restart event and the registration data and dynamic data needs to be restored, if available at the 3GPP AAA Server. | +| 1 | Access-Network-Info-Request | This bit, when set, indicates that the HSS requests the 3GPP AAA Server the identity and location information of the access network where the UE is currently attached. | +| 2 | UE-Local-Time-Zone-Request | This bit, when set, indicates that the HSS requests the 3GPP AAA Server the time zone of the location in the access network where the UE is attached. | +| 3 | P-CSCF Restoration Request | This bit, when set, indicates to the 3GPP AAA Server that the HSS requests the execution of the HSS-based P-CSCF restoration procedures for WLAN, as described in 3GPP TS 23.380 [52] clause 5.6. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving 3GPP AAA Server. | | + +### 8.2.3.18 TWAN-Default-APN-Context-Id + +The TWAN-Default-APN-Context-Id AVP is of the type Unsigned32 and shall identify the context identifier of the subscriber's default APN to be used for Trusted WLAN access to EPC over S2a. + +Note: The default APN for Trusted WLAN access to EPC over S2a can differ from the default APN for 3GPP and other non-3GPP accesses. + +### 8.2.3.19 TWAN-Access-Info + +The TWAN-Access-Info AVP is of type Grouped. + +If no WLAN-Identifier AVP is included in the TWAN-Access-Info AVP, the allowed access methods shall apply to any arbitrary Trusted WLAN. See clause 5.1.2.1.2. + +If the Access-Authorization-Flags AVP is not present in the TWAN-Access-Info AVP, EPC access and Non-Seamless WLAN Offload shall be considered to be not allowed. + +A specific Trusted-WLAN shall appear in at most one TWAN-Access-Info AVP. + +There shall be at most one TWAN-Access-Info AVP not including any WLAN-Identifier. + +AVP Format: + +``` +TWAN-Access-Info:= < AVP Header: 1510 10415 > + [ Access-Authorization-Flags ] + [ WLAN-Identifier ] + *[ AVP ] +``` + +### 8.2.3.20 Access-Authorization-Flags + +The Access-Authorization-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 8.2.3.20/1: + +**Table 8.2.3.20/1: Access-Authorization-Flags** + +| Bit | Name | Description | +|-------|--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | EPC-Access-Authorization | This bit, when set, indicates that the UE is allowed to access the EPC when connected via Trusted WLAN access. This flag, when not set, indicates that the UE is not allowed to access EPC when connected via Trusted WLAN access. | +| 1 | NSWO-Access-Authorization | This bit, when set, indicates that the UE is allowed Non-Seamless WLAN Offload access via Trusted WLAN access. This flag, when not set, indicates that the UE is not allowed to Non-Seamless WLAN Offload via Trusted WLAN access. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving 3GPP AAA Server. | | + +NOTE: UE is allowed to access the EPC when connected via Trusted WLAN access only if the Non-3GPP-IP-Access-APN AVP does not disable all APNs and the EPC-Access-Authorization bit is set. + +### 8.2.3.21 AAA-Failure-Indication + +The AAA-Failure-Indication AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 8.2.3.21/1: + +**Table 8.2.3.21/1: AAA-Failure-Indication** + +| Bit | Name | Description | +|-------|----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------| +| 0 | AAA Failure | This bit, when set, indicates that a previously assigned 3GPP AAA Server is unavailable. | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver. | | + +### 8.2.3.22 OC-Supported-Features + +The OC-Supported-Features AVP is of type Grouped and it is defined in IETF RFC 7683 [47]. This AVP is used to support Diameter overload control mechanism, see Annex B for more information. + +### 8.2.3.23 OC-OLR + +The OC-OLR AVP is of type Grouped and it is defined in IETF RFC 7683 [47]. This AVP is used to support Diameter overload control mechanism, see Annex B for more information. + +### 8.2.3.24 3GPP-AAA-Server-Name + +The 3GPP-AAA-Server-Name AVP is of type DiameterIdentity, and defines the Diameter address of the 3GPP AAA Server node. + +### 8.2.3.25 DRMP + +The DRMP AVP is of type Enumerated and is defined in IETF RFC 7944 [53]. This AVP allows the 3GPP functional entities to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +### 8.2.3.26 Load + +The Load AVP is of type Grouped and it is defined in IETF RFC 8583 [54]. This AVP is used to support Diameter load control mechanism, see Annex E for more information. + +### 8.2.3.27 ERP-Authorization + +The ERP-Authorization AVP is of type Unsigned32 and it indicates whether the subscriber is authorized, or not, to make use of the EAP Reauthentication Protocol. The following values are defined: + +ERP\_NOT\_AUTHORIZED (0) + +ERP\_AUTHORIZED (1) + +### 8.2.3.28 MIP6-Feature-Vector + +The MIP6-Feature-Vector AVP (AVP Code 124) is of type Unsigned64 and contains a 64 bit flags field of the mobile IP capabilities authorized by the HSS. + +The following capabilities are defined for the SWx interface: + +- MIP6\_INTEGRATED (0x0000000000000001) +This flag means that DSMIPv6 is authorized. +- PMIP6\_SUPPORTED (0x0000010000000000) +This flag means that NBM is authorized. +- MIP4\_SUPPORTED (0x0000100000000000) +This flag means that MIPv4 is authorized. +- GTPv2\_SUPPORTED (0x0000400000000000) +This flag means that NBM is authorized. + +NBM shall be considered as authorized if at least one of the PMIP6\_SUPPORTED and GTPv2\_SUPPORTED flag is set. + +NOTE: The selection of the protocol variant (GTPv2 or PMIPv6) on S2a/S2b is determined solely by the TWAN/ePDG. It does not matter whether the HSS sets the PMIP6\_SUPPORTED and/or GTPv2\_SUPPORTED flags to authorize NBM. + +Based on operator policy, the 3GPP AAA Server may also authorize the use of NBM, irrespective of the presence or content of the MIP6-Feature-Vector AVP in the Non-3GPP User Data. + +## 8.2.4 Session Handling + +The Diameter protocol between the 3GPP AAA Server and the HSS shall not keep the session state and each Diameter request/response interaction shall be transported over a different diameter session which is implicitly terminated. + +In order to indicate that session state shall not be maintained, the diameter client and server shall include the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [58]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any + +session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +## 8.3 User identity to HSS resolution + +The User identity to HSS resolution mechanism enables the 3GPP AAA server to find the identity of the HSS that holds the subscriber data for a given user identity when multiple and separately addressable HSSs have been deployed by the network operator. The resolution mechanism is not required in networks that utilise a single HSS or when a 3GPP AAA server is configured to use pre-defined HSS address/identity. + +This User identity to HSS resolution mechanism may rely on routing capabilities provided by Diameter and be implemented in the home operator network within dedicated Diameter Agents (Redirect Agents or Proxy Agents) responsible for determining the HSS identity based on the provided user identity. If this Diameter based implementation is selected by the Home network operator, the principles described below shall apply. + +In networks where more than one independently addressable HSS are utilized by a network operator, and the 3GPP AAA server is not configured to use pre-defined HSS address/identity, each 3GPP AAA server shall be configured with the address/identity of the Diameter Agent (Redirect Agent or Proxy Agent) implementing this resolution mechanism. + +To get the HSS identity that holds the subscriber data for a given user identity, the 3GPP AAA server shall send the Diameter request normally destined to the HSS to a pre-configured address/identity of a Diameter agent supporting the User identity to HSS resolution mechanism. + +- If this Diameter request is received by a Diameter Redirect Agent, the Diameter Redirect Agent shall determine the HSS identity based on the provided user identity and sends to the 3GPP AAA server a notification of redirection towards the HSS identity, in response to the Diameter request. Multiple HSS identities may be included in the response from the Diameter Redirect Agent, as specified in IETF RFC 6733 [58]. In such a case, the 3GPP AAA server shall send the Diameter request to the first HSS identity in the ordered list received in the Diameter response from the Diameter Redirect Agent. If no successful response to the Diameter request is received, the 3GPP AAA server shall send a Diameter request to the next HSS identity in the ordered list. This procedure shall be repeated until a successful response from an HSS is received. +- If this Diameter request is received by a Diameter Proxy Agent, the Diameter Proxy Agent shall determine the HSS identity based on the provided user identity and - if the Diameter load control mechanism is supported (see IETF RFC 8583 [54]) - optionally also based on previously received load values from Load AVPs of type HOST. The Diameter Proxy Agent shall then forward the Diameter request directly to the determined HSS. The 3GPP AAA server shall determine the HSS identity from the response to the Diameter request received from the HSS. + +After the User identity to HSS resolution, the 3GPP AAA server shall store the HSS identity/name/Realm and shall use it in further Diameter requests associated to the same user identity. + +NOTE: Alternatives to the user identity to HSS resolution Diameter based implementation are outside the scope of this specification. + +--- + +## 9 S6b Description + +### 9.1 Functionality + +#### 9.1.1 General + +The S6b reference point is defined between the 3GPP AAA Server and the PDN-GW. The definition of the reference point and its functionality is given in 3GPP TS 23.402 [3]. + +When the UE attaches to the EPC using the S2c reference point, the S6b reference point is used to authenticate and authorize the UE, and update the PDN-GW address to the 3GPP AAA server and HSS. + +When the UE attaches to the EPC using the S2a/S2b reference point in the PMIPv6 or GTPv2 mode, the S6b reference point is used to update the 3GPP AAA server or the 3GPP AAA proxy with the PDN-GW address information and with + +the selected S2a/S2b protocol variant. Furthermore, this reference point may be used to retrieve and update other mobility related parameters including static QoS profiles for non-3GPP accesses. + +The S6b reference point is also used to authenticate and authorize the incoming MIPv4 Registration Request in the case the UE attaches to the EPC over the S2a reference point using MIPv4 FACoA procedures. + +The S6b reference point is used by the 3GPP AAA Server in the case the UE attaches to the EPC using the S2c reference point to indicate to the PDN GW that a PDN GW reallocation shall be performed. This indication triggers the actual Home Agent reallocation procedure as specified in 3GPP TS 24.303 [13]. + +The S6b reference point is also used to download subscriber and equipment trace information to the PDN GW. + +The S6b reference point is also used by the 3GPP AAA Server to indicate to the PDN GW that the HSS-based P-CSCF restoration procedure for WLAN shall be executed as described in 3GPP TS 23.380 [52] clause 5.6. + +## 9.1.2 Procedures Description + +### 9.1.2.1 Authentication and Authorization Procedures when using DSMIPv6 + +#### 9.1.2.1.1 General + +The S6b interface shall enable the authentication and authorization between the UE and the 3GPP AAA Server/Proxy for DSMIPv6. + +When an UE performs the DSMIPv6 initial attach, it runs an IKEv2 exchange with the PDN GW as specified in 3GPP TS 24.303 [13]. In this exchange EAP AKA is used for UE authentication over IKEv2. The PDN GW acts as an IKEv2 responder and an EAP pass-through authenticator for this authentication. + +The S6b authentication and authorization procedure is invoked by the PDN GW after receiving an IKE\_SA\_AUTH message from the UE. The S6b reference point performs authentication based on reuse of the DER/DEA command set defined in Diameter EAP. The exact procedure follows the steps specified in IETF RFC 5778 [11]. + +NOTE: This procedure is only used with DSMIPv6-capable UEs; therefore, only PDNs with PDN Types IPv6 or IPv4v6 are accessible in this case. + +**Table 9.1.2.1/1: Authentication and Authorization Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|----------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User identity | User-Name | M | This information element shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the UE is to be authenticated only, authorized only or both. AUTHORIZE_AUTHENTICATE shall be used in this case. | +| EAP Payload | EAP-Payload | M | This IE shall contain the Encapsulated payload for UE – 3GPP AAA Server mutual authentication | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE shall contain the identifier that allows the home network to identify the PLMN where the PGW is located. It shall be present when the PGW Identity does not contain an FQDN. | +| Access Type | RAT-Type | C | This Information Element shall contain the non-3GPP access network technology type that is serving the UE.
This IE shall be present if it is available when the PDN GW sends the request. | +| PDN GW Identity | MIP6 -Agent-Info | M | This IE shall contain the FQDN and/or IPv6 address(es) of the PDN GW that the user shall be connected to.
If the PDN GW includes the IP address in the PDN GW Identity, it shall include the HA IPv6 address and, if used, the IPv4 address, as DSMIPv6 is used. | +| MIP Subscriber Profile | MIP6-Feature-Vector | M | This AVP shall be included to inform the 3GPP AAA Server about the used mobility protocol. None of the PMIP6_SUPPORTED or MIP4_SUPPORTED flags shall be set, since DSMIPv6 is used in this case. | +| APN | Service-Selection | O | If present, this IE shall contain the Network Identifier part of the APN extracted from the IKE_AUTH message.
It shall include the APN that the user shall be connected to. It shall be only included if received from UE. In case it is not received, the 3GPP AAA Server shall assign the received PDN-GW identity to the default APN. | +| QoS capabilities | QoS-Capability | O | This IE shall be included if present in the request message. It shall indicate to the 3GPP AAA Server that the PGW requests downloading a static QoS profile for the UE. The PGW may include this IE only at the initial attach of the UE. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| Care of Address | MIP-Careof-Address | O | If present, this IE shall contain the IPv4 or the IPv6 Care of Address of the UE as defined in IETF RFC 5778 [11] | +| AAA Failure Indication | AAA-Failure-Indication | O | If present, this information element shall indicate that the request is sent after the PDN-GW has determined that a previously assigned 3GPP AAA Server is unavailable. | +| DER S6b Flags | DER-S6b-Flags | O | This Information Element contains a bit mask. See 9.2.3.7 for the meaning of the bits. | +| UE local IP address | UE-Local-IP-Address | O | The PDN GW shall include this IE based on local policy for Fixed Broadband access network interworking as specified in 3GPP TS 23.139 [39]. If present, it shall contain the source IPv4 or IPv6 address of the IKE_SA_AUTH message from the UE. | + +**Table 9.1.2.1/2: Authentication and Authorization Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|----------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | User-Name | O | This information element, if present, shall contain the identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]. This IE shall include the leading digit used to differentiate between authentication schemes. | +| EAP Payload | EAP-Payload | O | If present, this IE shall contain the Encapsulated payload for UE – 3GPP AAA Server mutual authentication | +| Master Session Key | EAP-Master-Session-Key | C | This IE shall contain the Keying material for protecting the communication between the UE and PDN GW. It shall be present only if the result code is set to success. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_AUTHENTICATE. See IETF RFC 4072 [5]. | +| Result Code | Result-Code / Experimental-Result-Code | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]) or as per in NASREQ IETF RFC 4005 [58]). The Result-Code DIAMETER_MULTI_ROUND_AUTH shall be used in the responses that trigger further requests from the PDN GW and DIAMETER_SUCCESS shall be included at the successful completion of the authentication and authorization procedure.

The Experimental-Result AVP shall be used for S6b errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.

If the Result-Code is set to DIAMETER_SUCCESS_RELOCATE_HA as defined in IETF RFC 5778 [11], then the 3GPP AAA server is indicating to the PGW that it shall initiate a HA switch procedure towards the UE. | +| MIP Subscriber Profile | MIP6-Feature-Vector | C | This AVP shall be present if the authorization was successful. None of the PMIP6_SUPPORTED or MIP4_SUPPORTED flags shall be set, since DSMIPv6 is used in this case. | +| Permanent User Identity | Mobile-Node-Identifier | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS.
This IE shall contain an AAA/HSS assigned permanent user identity (i.e. an IMSI in root NAI format as defined in clause 19 of 3GPP TS 23.003 [14]). This IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| APN and PGW Data | APN-Configuration | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS.
This AVP shall contain the default APN, the list of authorized APNs, user profile information.
APN-Configuration is a grouped AVP including the following information elements per APN:
- APN
- Authorized 3GPP QoS profile
- Statically allocated User IP Address (IPv4 and/or IPv6)
- Allowed PDN type (IPv4, IPv6, IPv4v6, IPv4_OR_IPv6)
- APN-AMBR | +| Reallocated PGW Address | MIP6-Agent-Info | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS_RELOCATE_HA indicating to the PDN GW that it shall initiate a HA switch procedure towards the UE.
This information element shall contain the PDN GW identity of the target PDN GW. | +| Session Time | Session-Timeout | C | If the authentication and authorization succeeded, then this IE shall contain the time this authorization is valid for. | +| QoS resources | QoS-Resources | C | This AVP shall be included only if the QoS-Capability AVP was received in the authorization request and the authorization succeeded. Then the 3GPP AAA server shall include a static QoS profile in this IE during the UE initial attach if the PDN GW included QoS-Capabilities AVP in the request message and the UE has been provisioned with a static QoS profile. The QoS profile template value in this IE shall be set to 0. | + +| | | | | +|----------------------------------------------|-------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UE Charging Data | 3GPP-Charging-Characteristics | O | If present, this information element shall contain the type of charging method to be applied to the user (see 3GPP TS 29.061 [31]). | +| 3GPP AAA Server URI | Redirect-Host | C | This information element shall be sent if the Result-Code value is set to DIAMETER_REDIRECT_INDICATION. When the user has previously been authenticated by another 3GPP AAA Server, it shall contain the Diameter URI of the 3GPP AAA Server currently serving the user. The node receiving this IE shall behave as defined in the Diameter base protocol (see IETF RFC 6733 [58]). The command shall contain zero or more occurrences of this information element. When choosing a destination for the redirected message from multiple Redirect-Host AVPs, the receiver shall send the Diameter request to the first 3GPP AAA Server in the ordered list received in the Diameter response. If no successful response to the Diameter request is received, the receiver shall send the Diameter request to the next 3GPP AAA Server in the ordered list. This procedure shall be repeated until a successful response is received from a 3GPP AAA Server. | +| Trust Relationship Indicator | AN-Trusted | C | This AVP shall contain the 3GPP AAA Server's decision on handling the non-3GPP access network, i.e. trusted, or untrusted. This AVP shall be present if the 3GPP AAA Server is able to make decision on whether the access network is Trusted or Untrusted. | +| Trace information | Trace-Info | C | This AVP shall be included if the subscriber and equipment trace has been activated for the user in the HSS and signalling based activation is to be used to download the trace activation from the HSS to the PDN GW.
Only the Trace-Data AVP shall be included to the Trace-Info AVP and shall contain the following AVPs:
- Trace-Reference
- Trace-Depth
- Trace-Event-List, for PGW
- Trace-Collection-Entity
The following AVPs may also be included in the Trace-Data AVP:
- Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
- Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | + +#### 9.1.2.1.2 PDN GW Detailed Behaviour + +After completing the IKE\_SA\_INIT exchange, upon receipt of an IKE\_AUTH message, including the IDi payload but not the AUTH payload, the PDN GW shall send an Diameter-EAP-Request (DER) message towards the 3GPP AAA Server / Proxy. The EAP Payload AVP shall contain an EAP-Response/Identity with the identity extracted from the IDi field. + +Upon receipt of an IKE\_AUTH message with an EAP payload from the UE, the PDN GW shall send an Diameter-EAP-Request (DER) with the EAP Payload AVP containing the according EAP-Response to the 3GPP AAA Server / Proxy. + +Upon receipt of a Diameter-EAP-Answer (DEA) message from the 3GPP AAA Server / Proxy, the PDN GW shall then send an IKE\_AUTH message containing the according EAP Payload to the UE. + +Upon receipt of an IKE\_AUTH message with the AUTH payload after the EAP authentication was successful, the PDN\_GW shall proceed as specified in 3GPP TS 24.303 [13]. + +If the handover indication to the PGW is missing, i.e. IPv6 Home Network Prefix assigned to the UE is not included in IKE\_AUTH request message as specified in 3GPP TS 24.303 [13], the PGW shall notify 3GPP AAA Server that the UE performs initial attach by setting Initial-Attach-Indicator in the DER-S6b-flags AVP. + +The PDN GW shall utilize the downloaded APN configuration data, among others, to decide whether the user's request for an IPv4 home address and/or IPv6 home address prefix shall be accepted or rejected. + +If the Result-Code AVP is set to DIAMETER\_SUCCESS\_RELOCATE\_HA and if the PGW has received a PGW identity in form of the FQDN from the 3GPP AAA server, then the PGW may obtain the IP address of the Home Agent functionality of that PGW as described in 3GPP TS 29.303 [34]. + +If Trace-Info AVP has been received in the authentication and authorization response, the PDN GW shall start a trace session for the user. For details, see 3GPP TS 32.422 [32]. + +If the PDN-GW determines that a previously assigned 3GPP AAA Server is unavailable, it may attempt to send a new authentication and authorization request to an alternate 3GPP AAA Server. If the PDN-GW receives from this new server a redirect indication towards the former server (due to the HSS having stored the former 3GPP AAA Server identity), it shall terminate all previously existing sessions and PDN connections for that user, and it shall re-send again the request towards the new server, but it shall include the AAA-Failure-Indication AVP in the new request. + +#### 9.1.2.1.3 3GPP AAA Server Detailed Behaviour + +For S6b, on receipt of the DER message, the 3GPP AAA Server shall process the DER message according to 3GPP TS 33.402 [19]. + +Upon successful completion, a DIAMETER\_SUCCESS shall be returned to indicate successful authentication procedure and authentication information shall be returned. If the APN requested by the PDN GW is authorized by the wildcard APN, the 3GPP AAA Server shall include the wildcard APN in the Service-Selection AVP of the APN-Configuration AVP. The AAA server shall also include, among others, the MIP6-Feature-Vector AVP, including the subscriber profile of the UE in terms of DSMIPv6 feature the UE is authorized to use. + +If the HSS indicates that the user is currently being served by a different PDN GW, the 3GPP AAA Server shall respond to the PDN GW with the Result-Code set to DIAMETER\_SUCCESS\_RELOCATE\_HA and include the new assigned PDN GW identity in the MIP6-Agent-Info AVP. + +If receiving the UE Care of Address from the PDN GW and Initial-Attach-Indicator set by the PGW in DER-S6b-flags, the 3GPP AAA Server may select a different PDN GW which is closer to the UE than the currently serving PDN GW as specified in 3GPP TS 23.402 [3] based on the received UE Care of Address. In this case, the 3GPP AAA Server shall respond to the PDN GW with the Result-Code set to DIAMETER\_SUCCESS\_RELOCATE\_HA and include the selected PDN GW identity in the MIP6-Agent-Info AVP. + +If the HSS indicates that the user is currently being served by a different 3GPP AAA Server, the 3GPP AAA Server shall respond to the PDN-GW with the Result-Code set to DIAMETER\_REDIRECT\_INDICATION and Redirect-Host set to the Diameter URI of the 3GPP AAA Server currently serving the user (this Diameter URI shall be constructed based on the Diameter Identity included in the 3GPP-AAA-Server-Name AVP returned in the SWx authentication response from the HSS). + +If the 3GPP AAA Server receives a request message not related to any existing session and is able to recognize that the PDN-GW included the AAA-Failure-Indication AVP in the request, the 3GPP AAA Server shall also include the AAA-Failure-Indication AVP over the SWx interface, while retrieving the access authentication and authorization data from the HSS. + +The 3GPP AAA Server shall run EAP-AKA as specified in 3GPP TS 33.402 [19]. Exceptions shall be treated as error situations and the result code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. + +Before sending out the AKA challenge, the 3GPP AAA Server shall decide whether the access network is handled as Trusted or Untrusted and set the value of the AN-Trusted AVP correspondingly in the answer message to indicate the trust relationship of the access network to the PDN GW. The 3GPP AAA Server shall make the decision based on the UE Identity and the trust relationship information marked during the authentication and authorization procedure over STa, SWa or SWm. If the 3GPP AAA server is unable to determine the trust relationship of the access network, it shall not include the AN-Trusted AVP in the answer message to the PDN GW. + +For Fixed Broadband access network interworking as specified in 3GPP TS 23.139 [39], + +- For trusted access, the 3GPP AAA server shall determine if the UE is connected via a BBF-defined WLAN access according to the UE local IP address in UE-Local-IP-Address AVP from the PDN GW. If the UE is connected via a BBF-defined WLAN access, the 3GPP AAA server shall perform the enabling UE reflective QoS function as specified in 3GPP TS 24.139 [43]. + +- For untrusted access, the UE local IP address is assigned by the ePDG and not by the non-3GPP access network. Hence, in this case the 3GPP AAA Server shall ignore the UE local IP address in UE-Local-IP-Address AVP from the PDN GW. + +#### 9.1.2.1.4 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the PDN GW is in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the authentication answer that completes a successful authentication, the 3GPP AAA Proxy shall record the state of the connection (i.e. Authentication Successful). + +If receiving the UE Care of Address from the PDN GW which is in the VPLMN, the 3GPP AAA Proxy may select a different PDN GW which is closer to the UE than the currently serving PDN GW as specified in 3GPP TS 23.402 [3] based on the received UE Care of Address. In this case, the 3GPP AAA Proxy shall respond to the PDN GW with the Result-Code set to DIAMETER\_SUCCESS\_RELOCATE\_HA and include the selected PDN GW identity in the MIP6-Agent-Info AVP. + +#### 9.1.2.2 Authorization Procedures when using PMIPv6 or GTPv2 + +##### 9.1.2.2.1 General + +The following authorization procedures take place upon a reception of a PBU at the PDN GW from the MAG or upon a reception of a Create Session Request at the PDN GW from the trusted non-3GPP access network or from the ePDG. + +The PDN GW shall update its identity to the 3GPP AAA Server and HSS. Static QoS profile information may also be downloaded at the same time. If the PDN GW reports to the 3GPP AAA server that GTPv2 is used over the S2a or S2b interface, the 3GPP AAA Server may decide not to download parameters to the PDN GW on the S6b interface which are already provided to the PGW via the trusted non-3GPP access network through the STa and GTPv2 based S2a interfaces or via the ePDG through the SWm and the GTPv2 based S2b interfaces (e.g. static QoS profile, Trace Information, APN-AMBR). + +The procedures are based on the reuse of NASREQ IETF RFC 4005 [4] AAR and AAA commands and the Diameter extensions defined for PMIP in IETF RFC 5779 [2]. + +**Table 9.1.2.2.1/1: Authorization request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|----------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Authentication Request Type | Auth-Request-Type | M | This IE shall defines whether the UE is to be authenticated only, authorized only or both. AUTHORIZE_ONLY shall be used in this case. | +| PDN GW Identity | MIP6-Agent-Info | C | If present, this IE shall contain the identity of the selected PDN GW for the UE and the corresponding PDN connection. It shall be present on the first authorization request sent by the PGW to the 3GPP AAA Server for a given APN. Also, it shall be present to communicate to the 3GPP AAA Server the identity of the PDN GW used for the establishment of emergency PDN connections. | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE shall contain the identifier that allows the home network to identify the PLMN where the PGW is located. It shall be present when the PGW Identity is present and does not contain an FQDN. | +| Mobility features | MIP6-Feature-Vector | M | This IE shall contain the mobility features used by the PDN GW. The PDN GW shall set the PMIP6_SUPPORTED flag or the GTPv2_SUPPORTED flag according to the protocol variant used over the S2a or the S2b interface. | +| APN | Service-Selection | M | This IE shall contain the Network Identifier part of the APN extracted from the PBU or the Create Session Request message. For emergency PDN connection establishment (i.e., when Emergency-Services AVP is present, with the Emergency-Indication bit set), this IE may be ignored by the 3GPP AAA Server. | +| QoS capabilities | QoS-Capability | O | If included in the request message, this IE shall indicate to the 3GPP AAA server that the PDN GW requests downloading a static QoS profile for the UE. The PDN GW may include this IE only at the initial attach of the UE. The PDN GW should not include this IE if GTPv2 is used over the S2a or the S2b interface. The PDN GW shall not include this IE if the Emergency-Indication bit of the Emergency-Services AVP is set in the message. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| Origination Time Stamp | Origination-Time-Stamp | C |

The PGW shall include this IE if it received the Origination Time Stamp from the MME/SGSN or TWAN/ePDG and if the PGW supports the procedure specified in clause 13.2 of 3GPP TS 29.274 [38].

If included in the request message, this IE shall contain the Origination Time Stamp value provided to the PGW in the Create Session Request or PBU message. This indicates the time at which the originating entity initiated the request.

| +| Maximum Wait Time | Maximum-Wait-Time | C |

The PGW shall include this IE if it received the Maximum Wait Time from the MME/SGSN or TWAN/ePDG, and the PGW supports the procedure specified in clause 13.3 of 3GPP TS 29.274 [38], and the 3GPP AAA Server pertains to the same PLMN as the PGW or if the 3GPP AAA Server pertains to a different PLMN and operator policy in the PGW allows to use this procedure towards this PLMN.

If included in the request message, this IE shall contain the Maximum Wait Time provided to the PGW in the Create Session Request or PBU message. This indicates the duration during which the originator of the request waits for a response.

| +| Emergency Services | Emergency-Services | C | The PGW shall include this information element, with the Emergency-Indication bit set, during the establishment of an emergency PDN connection. | + +**Table 9.1.2.2.1/2: Authorization answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result code | Result-Code | M | This IE shall contain the result of the operation. The possible values of the Result-Code AVP are defined in IETF RFC 6733 [58]. This IE shall be set to DIAMETER_SUCCESS if the update of the PDN GW identity succeeded. It shall be set to DIAMETER_AUTHORIZATION_REJECTED if the update of the PDN GW identity failed. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_ONLY. See IETF RFC 4072 [5]. | +| Authorized mobility features | MIP6-Feature-Vector | C | The 3GPP AAA Server shall insert this AVP if the authorization was successful. The PMIP6_SUPPORTED or the GTPv2_SUPPORTED flag shall be set according to the value received in the Authorization request. | +| Session time | Session-Timeout | C | If the authorization succeeded, then this IE shall contain the time this authorization is valid for. | +| APN and PGW Data | APN-Configuration | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS.
This AVP shall contain the user profile information.
APN-Configuration is a grouped AVP and shall include the following information elements:
- APN
- Authorized 3GPP QoS profile
- APN-AMBR
This information element need not be included in the Authorization answer, if the MIP6-Feature-Vector in the Authorization request indicates that GTPv2 is used over S2a or S2b.
This information element shall not be included in the Authorization Answer if the Emergency-Indication bit of the Emergency-Services AVP is set in the Authorization Request. | +| QoS resources | QoS-Resources | C | This AVP shall be included only if the QoS-Capability AVP was received in the authorization request and the authorization succeeded. Then the 3GPP AAA server shall include a static QoS profile in this IE during the UE initial attach if the PDN GW included a QoS-Capabilities AVP in the request message and the UE has been provisioned with a static QoS profile. The QoS profile template value in this IE shall be set to 0. | +| 3GPP AAA Server URI | Redirect-Host | C | This information element shall be sent if the Result-Code value is set to DIAMETER_REDIRECT_INDICATION. When the user has previously been authenticated by another 3GPP AAA Server, it shall contain the Diameter URI of the 3GPP AAA Server currently serving the user. The node receiving this IE shall behave as defined in the Diameter base protocol (see IETF RFC 6733 [58]). The command shall contain zero or more occurrences of this information element. When choosing a destination for the redirected message from multiple Redirect-Host AVPs, the receiver shall send the Diameter request to the first 3GPP AAA Server in the ordered list received in the Diameter response. If no successful response to the Diameter request is received, the receiver shall send the Diameter request to the next 3GPP AAA Server in the ordered list. This procedure shall be repeated until a successful response is received from a 3GPP AAA Server. | +| Trace information | Trace-Info | C | This AVP shall be included if the MIP6-Feature-Vector in the Authorization request indicates that PMIPv6 is used over S2a or S2b and if the subscriber and equipment trace has been activated or deactivated for the user in the HSS GW and signalling based activation is used to download the trace (de)activation from the HSS to the PDN GW.

In an authorization response sent during the authorization procedure at PDN connection setup, the Trace-Data AVP shall be included.
In an authorization response sent during the service authorization information update procedure,
- the Trace-data AVP shall be included if trace activation is requested
- the Trace-Reference AVP shall be included, if trace deactivation is requested.

If the Trace-Data AVP is included, it shall contain the following AVPs:
- Trace-Reference | + +| | | | | +|----------------------------------------------|--------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | |
  • - Trace-Depth
  • - Trace-Event-List, for PGW
  • - Trace-Collection-Entity

The following AVPs may also be included in the Trace-Data AVP:

  • - Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
  • - Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required.
| +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | + +#### 9.1.2.2.2 PDN GW Detailed Behaviour + +Upon receipt of a PBU message from the MAG or upon receipt of a Create Session Request from the trusted non-3GPP access network or the ePDG which requires the establishment of a new PDN connection via the non-3GPP access, the PDN GW shall initiate an authorization procedure, by sending an Authorization Request message to the 3GPP AAA server or to the 3GPP AAA Proxy, with the Auth-Request-Type set to AUTHORIZE\_ONLY, in order to update the PGW Address for the APN and the selected S2a or S2b protocol variant, as well as to optionally download any UE specific APN profile information such as IP address allocation information, QoS Information, Session timeouts, Session Idle timeouts etc. + +The Create Session Request received from the trusted non-3GPP access network or the ePDG may include the identities of the 3GPP AAA server assigned to the UE i.e. the Origin-Host and Origin-Realm of the 3GPP AAA server included in the DEA message received by the ePDG/TWAN over SWm or STa interface. If supported, the PDN GW shall use these identities to address the Authorization Request message to the selected 3GPP AAA server. + +The PDN GW shall include in the request the APN where the user shall be connected to. The PGW shall additionally include the Emergency-Services AVP, with the Emergency-Indication bit set, during the establishment of an emergency PDN connection. + +The PDN GW Identity and PLMN shall only be included in the initial request to the 3GPP AAA server; subsequent authorization messages (due to a handover to a different MAG, for instance) shall not include it again. + +After reception of the Authorization Response message, the PDN GW shall check that the Result-Code is set to DIAMETER\_SUCCESS and, if so, it shall proceed to connect the user to the specified APN. + +For PMIPv6 based S2a or S2b, if Trace-Info AVP including Trace-Data has been received in the authorization response, the PDN GW shall start a trace session for the user. If Trace-Info including Trace-Reference (directly under the Trace-Info) has been received in the authorization response, the PDN GW shall stop the ongoing trace session, identified by the Trace-Reference. For details, see 3GPP TS 32.422 [32]. + +For GTPv2 based S2a or S2b, the PDN GW shall ignore the Trace-Info AVP if received in the authorization response. + +NOTE: For GTPv2 based S2a or S2b, trace is activated and deactivated via the STa and S2a interfaces or via the SWm and S2b interfaces. + +#### 9.1.2.2.3 3GPP AAA Server Detailed Behaviour + +Upon receipt of the Authorization Request message from the PDN GW, the 3GPP AAA Server shall check whether the user's profile is available. + +If the user's data exist in the 3GPP AAA Server, it shall check, whether it also has an active access authorization session for the user. + +- If not, the 3GPP AAA Server shall reject the authorization request, including the Result-Code DIAMETER\_AUTHORIZATION\_REJECTED. +- If the 3GPP AAA Server has an existing authorization session, + +- If the APN requested by the PDN GW is included in the list of authorized APNs of the user or if the Emergency-Indication bit of the Emergency-Services AVP is set in the Authorization Request, then the 3GPP AAA Server shall: + - set the Result-Code to DIAMETER\_SUCCESS; + - include the APN-Configuration AVP in the authorization answer if PMIP is used over S2a or S2b; the APN-Configuration AVP may also be included if GTPv2 is used over S2a or S2b. When the APN-Configuration AVP is included in the authorization answer, the Service-Selection AVP within the APN-Configuration AVP shall contain the wildcard APN if the APN requested by the PDN GW is authorized by the wildcard APN; + - update the PDN GW information for the APN for the UE on the HSS as specified in clause 8.1.2.2.2, if the Emergency-Indication bit of the Emergency-Services AVP is not set in the Authorization Request; and + - update on the HSS the PDN GW Identity used for the establishment of emergency PDN connections for the UE, as specified in clause 8.1.2.2.2, based on operator policy (e.g. on whether the operator uses a static PDN GW or not for emergency services), if the Emergency-Services AVP is present, with the Emergency-Indication bit set, in the Authorization Request and the user is non-roaming and authenticated. +- If the APN requested by the PDN GW is not included in the list of authorized APNs and the Emergency-Indication AVP is not present in the Authorization Request, then the status code DIAMETER\_AUTHORIZATION\_REJECTED shall be returned to the PDN GW to indicate an unsuccessful authorization. + +If the user's profile does not exist in the 3GPP AAA Server, it shall retrieve the Diameter identity of the 3GPP AAA Server currently serving the user from the HSS following the procedures for subscriber profile download as specified in clause 8.1.2.2.2. Depending on the HSS response, + +- If the HSS indicates that the user is currently being served by a different 3GPP AAA Server, the 3GPP AAA Server shall respond to the PDN-GW with the Result-Code set to DIAMETER\_REDIRECT\_INDICATION and Redirect-Host set to the Diameter URI of the 3GPP AAA Server currently serving the user (this Diameter URI shall be constructed based on the Diameter Identity included in the 3GPP-AAA-Server-Name AVP returned in the SWx authentication response from the HSS). +- If the HSS returns DIAMETER\_ERROR\_USER\_UNKNOWN, the 3GPP AAA Server shall return the same error to the PDN GW. +- If the HSS sends the user's profile to the 3GPP AAA Server, the authorization shall be rejected by setting the Result-Code to DIAMETER\_AUTHORIZATION\_REJECTED. The 3GPP AAA Server shall delete the downloaded user profile. + +NOTE 1: The last outcome corresponds to the case that the user has no active access authorization procedure. This is considered as an error situation, e.g. the Trusted Non-3GPP access network may have sent PBU without authorizing the user. + +NOTE 2: After the 3GPP AAA Server has accepted a new S6b session from a particular PGW, the 3GPP AAA server can consider that any existing S6b session(s) for the same UE – APN combination supported via a different PGW (i.e. with a different Origin-Host AVP) is obsolete and can send ASR command(s) to initiate the termination of the hanging session(s) in that PGW. + +If the 3GPP AAA Server supports the detection and handling of late arriving requests as specified in clause 13.2 of 3GPP TS 29.274 [38], upon receipt of an Authorization Request which collides with an existing session context, for the same UE and APN but a different PGW (i.e. different Origin-Host AVP), the 3GPP AAA Server shall accept the new Authorization Request only if it contains a more recent Origination Time Stamp than the Origination Time Stamp stored for the existing S6b session. An incoming Authorization Request shall be considered as more recent than an existing session and be accepted if no Origination Time Stamp information was provided for at least one of the two sessions. The 3GPP AAA Server shall reject an incoming Authorization Request whose Origination Time Stamp is less recent than the Origination Time Stamp of the existing session by setting the Experimental-Result-Code to DIAMETER\_ERROR\_LATE\_OVERLAPPING\_REQUEST. + +If the 3GPP AAA Server supports the detection and handling of late arriving requests as specified in clause 13.3 of 3GPP TS 29.274 [38], upon receipt of an Authorization Request which contains the Origination Time Stamp and the Maximum Wait Time parameters, the 3GPP AAA Server should check that the request has not already timed out at the originating entity. The 3GPP AAA Server may perform additional similar checks before sending the answer, e.g. upon receipt of a response from the HSS. The 3GPP-AAA Server should reject an Authorization Request that is known to have timed out by setting the Experimental-Result-Code to DIAMETER\_ERROR\_TIMED\_OUT\_REQUEST. + +#### 9.1.2.2.4 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the PDN GW is located in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the authorization answer, the 3GPP AAA Proxy + +- shall check locally configured information for the maximum allowed static QoS parameters valid for visitors from the given HPLMN and modify the QoS parameters received from the 3GPP AAA Server, to enforce the policy limitations. +- shall record the state of the connection (i.e. Authorization Successful). + +#### 9.1.2.3 PDN GW Initiated Session Termination Procedures + +##### 9.1.2.3.1 General + +The S6b reference point allows the PDN GW to inform the 3GPP AAA server that the UE disconnected a PDN connection associated to an APN, or that the PDN connection was handed over to the 3GPP access, and therefore the mobility session established for this PDN connection is to be removed. + +The procedure shall be initiated by the PDN GW. These procedures are based on the reuse of Diameter STR and STA commands as specified in IETF RFC 6733 [58]. + +Each PDN connection shall be identified by the Diameter Session-Id parameter. + +**Table 9.1.2.3.1/1: S6b Session Termination Request** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Termination Cause | Termination-Cause | M | This IE shall contain the reason for the disconnection, according to the values and reasons described in IETF RFC 6733 [58]. In particular:
  • - If the session is terminated as a result of a PDN disconnection initiated by the UE, the Termination-Cause shall be set to the value DIAMETER_LOGOUT (1)
  • - If the session is terminated as a result of a PDN handover towards 3GPP access, the Termination-Cause shall be set to the value DIAMETER_USER_MOVED (7)
| + +**Table 9.1.2.3.1/2: S6b Session Termination Answer** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]). The Experimental-Result AVP shall be used for S6b errors. | + +### 9.1.2.3.2 PDN GW Detailed Behaviour + +The PDN GW shall make use of this procedure when the PDN Connection associated to the diameter session is, either disconnected, or handed over to the 3GPP access. + +Upon receipt of the Session Termination Answer message from the 3GPP AAA Server or from the 3GPP AAA Proxy, the PDN GW shall check the Result Code AVP, and in case of a DIAMETER\_SUCCESS code, it shall release the context associated to the active session identified by the Session-Id parameter used in the initial authorization exchange. + +### 9.1.2.3.3 3GPP AAA Server Detailed Behaviour + +Upon receipt of the Session Termination Request message from the PDN GW or from the 3GPP AAA Proxy, the 3GPP AAA Server shall check that there is an ongoing session associated to any of the parameters received in the message (Session-Id and User Name). + +If an active session is found, the 3GPP AAA Server shall release the session context associated to the specified session, and a Session Termination Answer message shall be sent to the PDN GW or 3GPP AAA Proxy, indicating DIAMETER\_SUCCESS. + +If the Session-Id included in the request does not correspond with any active session, or if an active session is found but it does not belong to the user identified by the User Name parameter, then a Session Termination Answer message shall be sent to the PDN GW or 3GPP AAA Proxy, indicating DIAMETER\_UNKNOWN\_SESSION\_ID. + +### 9.1.2.3.4 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the PDN GW is located in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the Session Termination Request message from the PDN GW, the 3GPP AAA Proxy shall route the message to the 3GPP AAA Server. + +On receipt of the Session Termination Answer message from the 3GPP AAA Server, the 3GPP AAA Proxy shall route the message to the PDN GW, and it shall release any local resources associated to the specified sessions only if the result code is set to DIAMETER\_SUCCESS. + +## 9.1.2.4 3GPP AAA Initiated Session Termination Procedures + +### 9.1.2.4.1 General + +The S6b reference point allows the 3GPP AAA server to order a PDN GW to remove a PDN connection previously activated by the UE. + +This procedure shall be initiated by the 3GPP AAA server. This indicates to the PDN GW to remove the corresponding PDN connection (identified by Session-ID AVP and User-Name AVP). This procedure is based on the reuse of NASREQ IETF RFC 4005 [4] ASR, ASA, STR and STA commands. + +The 3GPP AAA Server shall include the Auth-Session-State AVP in the ASR command with a value of NO\_STATE\_MAINTAINED if it does not require a STR from the PDN GW. If it does require a STR from the PDN GW, the 3GPP AAA Server shall either omit the Auth-Session-State AVP from the ASR command or include the Auth-Session-State AVP in the ASR command with a value of STATE\_MAINTAINED. + +**Table 9.1.2.4.1/1: S6b Abort Session Request** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Auth-Session-State | Auth-Session-State | O | If present, this information element shall indicate to the PDN GW whether the 3GPP AAA Server requires an STR message. | + +**Table 9.1.2.4.1/2: S6b Abort Session Answer** + +| Information Element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for S6b errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | + +**Table 9.1.2.4.1/3: S6b Session Termination Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Termination-Cause | Termination-Cause | M | This information element shall contain the reason why the session was terminated. It shall be set to "DIAMETER_ADMINISTRATIVE" to indicate that the session was terminated in response to an ASR message. | + +**Table 9.1.2.4.1/4: S6b Session Termination Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|-----------------------------------------------------| +| Result-Code | Result-Code | M | This IE shall indicate the result of the operation. | + +#### 9.1.2.4.2 PDN GW Detailed Behaviour + +Upon receipt of the Abort Session Request message from the 3GPP AAA Server or from the 3GPP AAA Proxy, the PDN GW shall check that there is an ongoing session with the received session-ID. + +If an active session is found: + +- In the PMIPv6 or GTPv2 or MIPv4 cases, the PDN GW shall release any resources associated with the identified diameter session, but it shall not terminate any associated PDN connection. +- In the DSMIPv6 case, the PDN GW shall initiate a termination procedure for the associated PDN connection, and shall release any resources associated with the identified diameter session. + +If the termination procedure is successful for the identified session, an Abort Session Answer message shall be sent to the 3GPP AAA Server or 3GPP AAA Proxy, indicating DIAMETER\_SUCCESS. + +If the Session-Id included in the request does not correspond with any active session, or if an active session is found but it does not belong to the user identified by the User Name parameter, then an Abort Session Answer message shall be sent to the 3GPP AAA Server or 3GPP AAA Proxy, indicating DIAMETER\_UNKNOWN\_SESSION\_ID. + +If the termination procedure for the identified session cannot be completed successfully, an Abort Session Answer message shall be sent to the 3GPP AAA Server or 3GPP AAA Proxy, indicating DIAMETER\_UNABLE\_TO\_COMPLY. + +If the termination procedure was successful for the identified session and the STR is required by the 3GPP AAA Server, the PDN GW shall send an STR to the 3GPP AAA Server with the Termination-Cause set to DIAMETER\_ADMINISTRATIVE. + +#### 9.1.2.4.3 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA Server shall initiate a separate procedure for each active PDN connection of the user, even if the user has several PDN connections via the same PDN GW. + +Upon receipt of the Abort Session Answer message from the PDN GW or from the 3GPP AAA Proxy, the 3GPP AAA Server shall check the Result Code AVP, and in case of a DIAMETER\_SUCCESS code, it shall release the context associated to the active session identified by the Session-Id parameter. + +If the error code DIAMETER\_UNABLE\_TO\_COMPLY is received in the Result Code AVP, the 3GPP AAA Server shall not release the context for the identified session. + +If the error code DIAMETER\_UNKNOWN\_SESSION\_ID is received in the Result Code AVP, the 3GPP AAA Server shall release the context for the identified session. + +On receipt of the STR from PDN GW, the 3GPP AAA Server shall return an STA command with the Result-Code set to DIAMETER\_SUCCESS. + +#### 9.1.2.4.4 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the PDN GW is located in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the Abort Session Request message from the 3GPP AAA Server, the 3GPP AAA Proxy shall route the message to the PDN GW. + +If the 3GPP AAA Proxy requires an STR but the 3GPP AAA Server does not, the 3GPP AAA Proxy may override the value of the Auth-Session-State in the ASR and set it to STATE\_MAINTAINED. In this case, the 3GPP AAA Proxy shall not forward the STR received from the PDN GW onto the 3GPP AAA Server and shall return an STA command to the PDN GW with the Result-Code set to DIAMETER\_SUCCESS. The 3GPP AAA Proxy shall not override the value of the Auth-Session-State AVP under any other circumstances. + +On receipt of the Abort Session Answer message from the PDN GW, the 3GPP AAA Proxy shall route the message to the 3GPP AAA Server, and it shall release any local resources associated to the specified session only if the result code is set to DIAMETER\_SUCCESS. + +When the 3GPP AAA Proxy receives the STR from PDN GW, it shall route the request to the 3GPP AAA Server. On receipt of the STA message, the 3GPP AAA Proxy shall route the response to the PDN GW. + +#### 9.1.2.5 Service Authorization Information Update Procedures + +##### 9.1.2.5.1 General + +The S6b reference point allows the 3GPP AAA server to modify the authorization information previously provided to the PDN GW, i.e. during Service Authentication and Authorization when using DSMIPv6, or Service Authorization using PMIPv6 or GTPv2 or MIPv4, or the service authorization information provided during a previous Service Authorization update. This procedure is triggered by the modification of the non-3GPP profile of the UE or by activating or deactivating subscriber and equipment trace in the HSS or by the request of a P-CSCF restoration for WLAN. This procedure is also triggered by the authentication and authorization via STa or SWm, when the 3GPP AAA Server detects that an S6b session already exists for the UE, as specified in clause 5.1.2.1.2 and 7.1.2.1.2. In this case, the 3GPP AAA Server shall use this procedure to send the trust relationship to the PDN GW. + +The Service Authorization Information Update procedure is performed in two steps: + +1. The 3GPP AAA server issues an unsolicited re-authentication and/or re-authorization request towards the PDN GW. Upon receipt of this request, the PDN GW responds to the request and indicates the disposition of the request. If the re-authorization request is used for the purpose of the P-CSCF restoration for WLAN, only the P-CSCF Restoration Request bit shall be set in the RAR Flags. This procedure is based on the reuse of Diameter RAR and RAA commands as specified in IETF RFC 6733 [58]. The information element content for these messages is shown in tables 9.1.2.5.1/1 and 9.1.2.5.1/2. +2. After receiving the re-authorization request, the PDN GW invokes the authorization procedure for the APN identified by the session ID included in the former re-authorization request message. The authorization procedure for PMIPv6 or GTPv2 is described in the clause 9.1.2.2. Tables 9.1.2.5.1/3 and 9.1.2.5.1/4 describe the message contents in case of DSMIPv6. + +**Table 9.1.2.5.1/1: S6b Re-authorization request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Request Type | Re-Auth-Request-Type | M | This shall define whether re-authentication or re-authorization is required. AUTHORIZE_ONLY shall be used in this case. | +| RAR Flags | RAR-Flags | C | This Information Element contains a bit mask. See 9.2.3.1.5 for the meaning of the bits. | + +**Table 9.1.2.5.1/2: S6b Re-authorization response** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for S6b errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | + +**Table 9.1.2.5.1/3: Authorization Request when using DSMIPv6** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|----------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User identity | User-Name | M | This information element shall contain the permanent identity of the user. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Authentication Request Type | Auth-Request-Type | M | This IE defines whether the UE is to be authenticated only, authorized only or both. AUTHORIZE_ONLY shall be used in this case. | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE shall contain the identifier that allows the home network to identify the PLMN where the PGW is located. It shall be present when the PGW Identity does not contain an FQDN. | +| Access Type | RAT-Type | M | This IE shall contain the non-3GPP access network technology type that is serving the UE. | +| PDN GW Identity | MIP6 -Agent-Info | M | This IE shall contain the FQDN and/or IP address(es) of the PDN GW that the user is connected to. | +| APN | Service-Selection | O | This IE shall contain the Network Identifier part of the APN extracted from the IKE_AUTH message.
It shall include the APN that the user shall be connected to. It shall be only included if received from UE. In case it is not received, the 3GPP AAA server shall assign the received PDN-GW identity to the default APN. | +| QoS capabilities | QoS-Capability | C | If included in the request message, this IE shall indicate to the 3GPP AAA server that the PGW is capable of downloading a static QoS profile for the UE. The PGW shall include this IE only during UE the initial attach. | + +**Table 9.1.2.5.1/4: Authorization Answer when using DSMIPv6** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------|----------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result Code | Result-Code / Experimental-Result-Code | M |

This IE shall contain the result of the operation.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [58]) or as per in NASREQ IETF RFC 4005 [4]). 1xxx should be used for multi-round, 2xxx for success.

The Experimental-Result AVP shall be used for S6b errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.

| +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_ONLY. See IETF RFC 4072 [5]. | +| APN and PGW Data | APN-Configuration | C |

This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS.
This AVP shall contain the default APN, the list of authorized APNs, and user profile information.
The APN-Configuration is a grouped AVP and shall include the following information elements per APN:

  • - APN
  • - Authorized 3GPP QoS profile
  • - Statically allocated User IP Address (IPv4 and/or IPv6)
  • - VPLMN Dynamic Address Allowed.

This information element might not be present if the authorization procedure is triggered by the 3GPP AAA Server to send the trust relationship to the PDN GW.

| +| Session Time | Session-Timeout | C |

If the authentication and authorization succeeded, then this IE shall contain the time this authorization is valid for.
This information element might not be present if the authorization procedure is triggered by the 3GPP AAA Server to send the trust relationship to the PDN GW.

| +| QoS resources | QoS-Resources | C |

If the authentication and authorization succeeded, then the 3GPP AAA server shall include a static QoS profile in this IE during the UE initial attach if the PGW included QoS-Capabilities AVP in the request message and the UE has been provisioned with a static QoS profile. The QoS profile template value in this IE shall be set to 0.
This IE shall contain the QoS Profile authorized by the 3GPP AAA server for the requested APN based on the subscribed QoS parameters.
This information element might not be present if the authorization procedure is triggered by the 3GPP AAA Server to send the trust relationship to the PDN GW.

| +| Trace information | Trace-Info | C |

This AVP shall be included if the subscriber and equipment trace has been activated or deactivated for the user in the HSS and signaling based activation is used to download the trace (de)activation from the HSS to the PDN GW.
Trace-data AVP shall be included (directly under the Trace-Info) if trace activation is requested
Trace-Reference AVP shall be included, if trace deactivation is requested.
If the Trace-Data AVP is included, it shall contain the following AVPs:

  • - Trace-Reference
  • - Trace-Depth
  • - Trace-Event-List, for PGW
  • - Trace-Collection-Entity

The following AVPs may also be included in the Trace-Data AVP:

  • - Trace-Interface-List, for PGW, if this AVP is not present, trace report generation is requested for all interfaces for PGW listed in 3GPP TS 32.422 [32]
  • - Trace-NE-Type-List, with the only allowed value being "PDN GW". If this AVP is not included, trace activation in PDN GW is required.
| +| Trust Relationship Indicator | AN-Trusted | C |

This AVP shall contain the 3GPP AAA Server's decision on handling the non-3GPP access network, i.e. trusted, or untrusted.
This AVP shall be sent if this re-authorization procedure is triggered by the authentication and authorization via STa or SWm, when the 3GPP AAA Server detects that an S6b session already exists for the UE and

| + +| | | | | +|--|--|--|---------------------------------------------------------------------------------------| +| | | | the S6b session was established as a result of an authentication request for DSMIPv6. | +|--|--|--|---------------------------------------------------------------------------------------| + +#### 9.1.2.5.2 Detailed Behaviour + +The 3GPP AAA server shall make use of this procedure in two steps to indicate and update relevant service authorization information in the PDN GW. + +The 3GPP AAA server shall send a re-authorization request for all authorization sessions that are active for the user except for the request of a P-CSCF restoration for WLAN which only applies to the session related to the IMS APN. + +Each PDN GW, upon reception of an unsolicited re-authentication and/or re-authorization request shall perform the following check and if there is an error detected, the PDN GW shall stop processing and return the corresponding error code. + +Check the Re-Auth-Request-Type AVP: + +1. If it indicates AUTHENTICATE\_ONLY, Result-Code shall be set to DIAMETER\_INVALID\_AVP\_VALUE. +2. If it indicates AUTHORIZE\_ONLY, then, depending on the used IP mobility protocol: + - In case of PMIPv6 or GTPv2, the PDN GW shall perform an authorization procedure as described in clause 9.1.2.2. If the P-CSCF Restoration Request bit in the RAR Flags is set: + - for the case where the PDN GW triggers the extended P-CSCF restoration mechanism, the PDN GW may send the authorisation request with only mandatory AVPs. + - for the case where the PDN GW triggers the basic P-CSCF restoration mechanism, the PDN GW shall send a Session Termination Request to the 3GPP AAA Server. + - In case of DSMIPv6, the PDN GW shall perform an authorization procedure, sending an authorization request described in Tables 9.1.5.1/3 and 9.1.5.1/4. If the Trust-Relationship-Update flag is set in the RAR Flags present in the request, the PDN GW may send an authorization request with only mandatory AVPs. +3. If it indicates AUTHORIZE\_AUTHENTICATE, Result-Code shall be set to DIAMETER\_INVALID\_AVP\_VALUE. + +When receiving the authorization request, if the authorization procedure is triggered by the 3GPP AAA Server to send the trust relationship to the PDN GW, the 3GPP AAA Server shall send the trust relationship of the access network for the subscriber to the PDN GW with Result-Code DIAMETER\_SUCCESS. If the received AA-Request is triggered by the P-CSCF Restoration Request bit set in the RAR Flags sent to the PDN GW, the 3GPP AAA Server may send an authorization answer to the PDN GW with Result-Code DIAMETER\_SUCCESS with only the mandatory AVPs described in Table 9.1.2.2.1/2. Otherwise, the 3GPP AAA Server shall check, whether + +- the subscriber still has non-3GPP subscription to access EPC network +- the non-3GPP APNs are enabled for the user, and +- the updated user profile contains the APN, for which the given authorization session was created. + +If any of the checked conditions are not met, the 3GPP AAA Server shall set the Result-Code to DIAMETER\_AUTHORIZATION\_REJECTED. Otherwise, it shall respond with Result-Code DIAMETER\_SUCCESS. + +After successful service authorization information update procedure, the PDN GW shall overwrite the stored user and APN data, for the subscriber identity indicated in the request, with the information received from the 3GPP AAA server. A session termination shall be initiated if the subscriber is no longer authorized to use the activated APN. If only trust relationship of the access network is received, the PDN GW shall keep all stored user and APN data for the subscriber identity as indicated in the request. + +If the P-CSCF-Restoration-Request bit in the RAR Flags is set, the PDN GW shall keep all stored user data and APN data for the subscriber identity indicated in the request unless this data is present in the authorisation answer and proceed with the P-CSCF restoration for WLAN as specified in 3GPP TS 23.380 [52]. + +For PMIPv6 based S2a or S2b, if Trace-Info AVP including Trace-Data has been received in the authorization response, the PDN GW shall start a trace session for the user. If Trace-Info including Trace-Reference (directly under the Trace-Info) has been received in the authorization response, the PDN GW shall stop the ongoing trace session, identified by the Trace-Reference. For details, see 3GPP TS 32.422 [32]. + +For GTPv2 based S2a or S2b, the PDN GW shall ignore the Trace-Info AVP if received in the authorization response. + +NOTE: For GTPv2 based S2a or S2b, trace is activated and deactivated via the STa and S2a interfaces or via the SWm and S2b interfaces. + +## 9.1.2.6 Authorization Procedures when using MIPv4 FACoA + +### 9.1.2.6.1 General + +The following authorization procedures take place upon a reception of a RRQ at the PDN GW from the FA. + +The PDN GW shall update its identity to the 3GPP AAA Server and HSS. Static QoS profile information may also be downloaded at the same time. + +MIPv4 security parameters shall be exchanged between the PDN GW and the 3GPP AAA Server. + +The procedures are based on the reuse of NASREQ IETF RFC 4005 [4] AAR and AAA commands. + +**Table 9.1.2.6.1/1: Authorization request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|----------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Permanent User Identity | User-Name | M | This IE shall contain the permanent user identity. The identity shall be represented in NAI form as specified in IETF RFC 4282 [15] and shall be formatted as defined in clause 19 of 3GPP TS 23.003 [14]; this IE shall not include the leading digit prepended in front of the IMSI used to differentiate between authentication schemes. | +| Authentication Request Type | Auth-Request-Type | M | This IE shall define whether the UE is to be authenticated only, authorized only or both. AUTHORIZE_ONLY shall be used in this case. | +| PDN GW Identity | MIP6-Agent-Info | O | This IE shall contain the address and possibly the FQDN of the selected PDN GW for the UE and the corresponding PDN connection | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE shall contain the identifier that allows the home network to identify the PLMN where the PGW is located. It shall be present when the PGW Identity is present and does not contain an FQDN. | +| Mobility features | MIP6-Feature-Vector | M | This IE shall contain the mobility features used by the PDN GW. The MIP4_SUPPORTED flag shall be set | +| APN | Service-Selection | C | If present this IE shall contain the Network Identifier part of the APN extracted from the RRQ message. In case it is not received, the 3GPP AAA Server shall assign the received PDN-GW identity to the default APN. | +| QoS capabilities | QoS-Capability | O | If included in the request message, this IE shall indicate to the 3GPP AAA Server that the PDN GW requests downloading of a static QoS profile for the UE. The PDN GW may include this IE only at the initial attach of the UE. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| MN-HA security parameter index | MIP-MN-HA-SPI | C | This IE shall contain the MN-HA security parameter index which is used in identifying MN-HA shared key as defined by 3GPP TS 33.402 [19]. It shall be included when the PDN-GW does not have the MN-HA shared key required to verify the MIPv4 RRQ message. | + +**Table 9.1.2.6.1/2: Authorization answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result code | Result-Code | M | This IE shall contain the result of the operation. The possible values of the Result-Code AVP are defined in IETF RFC 6733 [58]. This IE shall be set to DIAMETER_SUCCESS if the authorization of a MAG or the update of the PDN GW identity succeeded. It shall be set to DIAMETER_AUTHORIZATION_REJECTED if the authorization of a new MAG or the update of the PDN GW identity failed. | +| Authentication Request Type | Auth-Request-Type | M | It shall contain the value AUTHORIZE_ONLY. See IETF RFC 4072 [5]. | +| Authorized mobility features | MIP6-Feature-Vector | C | The 3GPP AAA Server shall insert this AVP if the authorization was successful. The MIP4_SUPPORTED flag shall be set. | +| Session time | Session-Timeout | C | If the authorization succeeded, then this IE shall contain the time this authorization is valid for. | +| QoS resources | QoS-Resources | C | This AVP shall be included only if the QoS-Capability AVP was received in the authorization request and the authorization succeeded. Then the 3GPP AAA Server shall include a static QoS profile in this IE during the UE initial attach if the PDN GW included QoS-Capabilities AVP in the request message and the UE has been provisioned with a static QoS profile. The QoS profile template value in this IE shall be set to 0. | +| 3GPP AAA Server URI | Redirect-Host | C | This information element shall be sent if the Result-Code value is set to DIAMETER_REDIRECT_INDICATION. When the user has previously been authenticated by another 3GPP AAA Server, it shall contain the Diameter URI of the 3GPP AAA Server currently serving the user. The node receiving this IE shall behave as defined in the Diameter base protocol (see IETF RFC 6733 [58]). The command shall contain zero or more occurrences of this information element. When choosing a destination for the redirected message from multiple Redirect-Host AVPs, the receiver shall send the Diameter request to the first 3GPP AAA Server in the ordered list received in the Diameter response. If no successful response to the Diameter request is received, the receiver shall send the Diameter request to the next 3GPP AAA Server in the ordered list. This procedure shall be repeated until a successful response is received from a 3GPP AAA Server. | +| Supported Features (See 3GPP TS 29.229 [24]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host for the lifetime of the Diameter session. | +| MN-HA shared key | MIP-Session-Key | C | This information element contains the MN-HA shared key as defined by 3GPP TS 33.402 [19], it shall be included if the Result-Code value is set to DIAMETER_SUCCESS and the MIP-MN-HA-SPI was sent in the authorization request.. | +| APN Data | APN-Configuration | C | This information element shall only be sent if the Result-Code AVP is set to DIAMETER_SUCCESS.
This AVP shall contain the user profile information.
APN-Configuration is a grouped AVP and shall include the following information elements:
- APN
- Authorized 3GPP QoS profile
- APN-AMBR | + +#### 9.1.2.6.2 PDN GW Detailed Behaviour + +Upon receipt of a RRQ message from the FA, the PDN GW shall initiate an authorization procedure, by sending an Authorization Request message to the 3GPP AAA Server or to the 3GPP AAA Proxy, with the Auth-Request-Type set to AUTHORIZE\_ONLY, in order to update the PGW Address for the APN, as well as to download any UE specific APN profile information such as IP address allocation information, QoS Information, Session timeouts, Session Idle timeouts, MIPv4 security parameters etc. + +If the APN was included in the RRQ message, the PDN GW shall include in the request the APN where the user shall be connected. + +The PDN GW Identity shall only be included in the initial request to the 3GPP AAA Server; subsequent authorization messages (due to a handover to a different FA, for instance) shall not include it again. + +If the PDN GW does not have a MN-HA shared key associated with the SPI received in the RRQ MN-HA-AE, the PDN GW shall include the SPI in the Authorization Request to the 3GPP AAA Server. + +After successful reception of the Authorization Request message, the PDN GW shall check that the Result-Code is set to DIAMETER\_SUCCESS and, if so, it shall use the MN-HA key to verify the MN-HA AE of the RRQ received from the FA. + +If the PDN-GW successfully verifies the MN-HA-AE it shall proceed to connect the user to the specified APN, and will send the RRP message to the FA. + +#### 9.1.2.6.3 3GPP AAA Server Detailed Behaviour + +Upon receipt of the Authorization Request message from the PDN GW, the 3GPP AAA Server shall update the PDN GW information for the APN for the UE on the HSS. If the APN was not received from the PDN GW the 3GPP AAA Server shall assign the received PDN-GW identity to the default APN . + +The 3GPP AAA Server must check that the user exists. If the user's data exists in the 3GPP AAA Server, it shall check, whether it also has an active access authorization session for the user. + +- If not, the 3GPP AAA Server shall reject the authorization request, including the Result-Code DIAMETER\_AUTHORIZATION\_REJECTED. +- If the 3GPP AAA Server has an existing authorization session, + - If the APN requested by the PDN GW is included in the list of authorized APNs of the user, then the 3GPP AAA Server shall include the Service-Selection AVP in the authorization answer. If no APN was requested the Service-Selection AVP shall contain the default APN. + - If the MN-HA-SPI was included in the request and it matches the SPI belonging to a SA of the user then the 3GPP AAA Server shall include the MIP-Session-Key of the SA in the authorization answer and set the Result-Code to DIAMETER\_SUCCESS. + - If the MN-HA-SPI was included in the request and there is no match with a SPI belonging to a SA of the user then the status code DIAMETER\_AUTHORIZATION\_REJECTED shall be returned to the PDN GW to indicate an unsuccessful authorization. +- If the APN requested by the PDN GW is not included in the list of authorized APNs, then the status code DIAMETER\_AUTHORIZATION\_REJECTED shall be returned to the PDN GW to indicate an unsuccessful authorization. + +If the user's profile does not exist in the 3GPP AAA Server, it shall retrieve the Diameter identity of the 3GPP AAA Server currently serving the user from the HSS following the procedures for subscriber profile download as specified in clause 8.1.2.2.2. Depending on the HSS response, + +- If the HSS indicates that the user is currently being served by a different 3GPP AAA Server, the 3GPP AAA Server shall respond to the PDN-GW with the Result-Code set to DIAMETER\_REDIRECT\_INDICATION and Redirect-Host set to the Diameter URI of the 3GPP AAA Server currently serving the user (this Diameter URI shall be constructed based on the Diameter Identity included in the 3GPP-AAA-Server-Name AVP returned in the SWx authentication response from the HSS). +- If the HSS returns DIAMETER\_ERROR\_USER\_UNKNOWN, the 3GPP AAA Server shall return the same error to the PDN GW. +- If the HSS sends the user's profile to the 3GPP AAA Server, the authorization shall be rejected by setting the Result-Code to DIAMETER\_AUTHORIZATION\_REJECTED. The 3GPP AAA Server shall delete the downloaded user profile. + +NOTE: The last outcome corresponds to the case that the user has no active access authorization procedure. This is considered as an error situation, e.g. the Trusted Non-3GPP access network may have sent RRQ without authorizing the user. + +#### 9.1.2.6.4 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy is required to handle roaming cases in which the PDN GW is located in the VPLMN. The 3GPP AAA Proxy shall act as a stateful proxy. + +On receipt of the authorization answer, the 3GPP AAA Proxy + +- shall check locally configured information for the maximum allowed static QoS parameters valid for visitors from the given HPLMN and modify the QoS parameters received from the 3GPP AAA Server, to enforce the policy limitations. +- shall record the state of the connection (i.e. Authorization Successful). + +## 9.2 Protocol Specification + +### 9.2.1 General + +The S6b reference point shall be based on Diameter, as defined in IETF RFC 6733 [58], and contain the following additions and extensions: + +- IETF RFC 4005 [4], which defines a Diameter protocol application used for Authentication, Authorization and Accounting (AAA) services in the Network Access Server (NAS) environment. +- IETF RFC 5779 [2], which defines a Diameter extensions and application for PMIPv6 MAG to AAA and LMA to AAA interfaces. +- IETF RFC 5777 [9], which defines attribute value pairs to convey QoS information between Diameter peers. + +The PDN GW to 3GPP AAA server or the PDN GW to 3GPP AAA proxy communication shall use the LMA to AAA interface functionality defined in IETF RFC 5779 [2] to update the 3GPP AAA server with PDN GW identity, indicate the protocol selected on S2a or S2b and optionally retrieve mobility related parameters and static QoS profiles, when PMIPv6 or GTPv2 based S2a or S2b is used. + +The PDN-GW acts as a LMA when the UE attaches to the EPC using the S2a or S2b reference points and PMIPv6 is used. The PDN GW also follows the LMA to AAA interface functionality defined in IETF RFC 5779 [2] when UE attaches to the EPC using S2a or S2b reference point and GTPv2 is used. The PDN GW acts as HA when the UE attaches to the EPC using the S2a reference point and MIPv4 is used. + +In the case the UE attached to the EPC using the S2c reference point, then the communication between the PDN GW and HA, IETF RFC 5778 [11] shall be used. The Application Id to be advertised over the S6b reference point corresponds to the DSMIPv6 "Diameter Mobile IPv6 IKE (MIP6I)" Application Id as defined in IETF RFC 5778 [11]. + +IKEv2 EAP-based initiator authentication is used for authenticating and authorizing the UE and updating the PDN-GW identity. In this case, the PDN GW shall behave as described in 3GPP TS 33.402 [19]. + +### 9.2.2 Commands + +#### 9.2.2.1 Commands for S6b DSMIPv6 Authorization Procedures + +##### 9.2.2.1.1 Diameter-EAP-Request (DER) Command + +The Diameter-EAP-Request (DER) command, indicated by the Command-Code field set to 268 and the "R" bit set in the Command Flags field, is sent from a PGW to a 3GPP AAA server. The Command Code value and the ABNF are re-used from the IETF RFC 5778 [11]. + +``` + +< Diameter-EAP-Request > ::= < Diameter Header: 268, REQ, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + [ RAT-Type ] + [ User-Name ] + [ Service-Selection ] + { EAP-Payload } + [ MIP6-Feature-Vector ] + [ MIP6-Agent-Info ] + [ QoS-Capability ] + [ Visited-Network-Identifier ] + [ MIP-Careof-Address ] + [ AAA-Failure-Indication ] + *[ Supported-Features ] + [DER-S6b-Flags] + [ UE-Local-IP-Address ] + ... + *[ AVP ] + +``` + +#### 9.2.2.1.2 Diameter-EAP-Answer (DEA) Command + +The Diameter-EAP-Answer (DEA) command, indicated by the Command-Code field set to 268 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA server to a PGW. The Command Code value and the ABNF are re-used from the IETF RFC 5778 [11]. + +``` + + ::= < Diameter Header: 268, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + [ EAP-Payload ] + [ EAP-Master-Session-Key ] + [ Mobile-Node-Identifier ] + [ APN-Configuration ] + [ MIP6-Agent-Info ] + [ MIP6-Feature-Vector ] + [ 3GPP-Charging-Characteristics ] + *[ QoS-Resources ] + *[ Redirect-Host ] + [ Trace-Info ] + *[ Supported-Features ] + ... + *[ AVP ] + +``` + +#### 9.2.2.2 Commands for S6b PMIPv6, GTPv2 or DSMIPv6 Authorization Procedures + +##### 9.2.2.2.1 AA-Request (AAR) Command + +The AA-Request (AAR) command, indicated by the Command-Code field set to 265 and the "R" bit set in the Command Flags field, is sent from the PDN GW to the 3GPP AAA Server. The Command Code value and ABNF are + +re-used from the IETF RFC 4005 [4] AA-Request command. New AVPs are added using the \*[AVP] extension mechanism in the original ABNF. + +NOTE: This command is used for the S6b Authorization Procedure for PMIPv6 or GTPv2, and also for the S6b Service Authorization Information Update procedure for PMIPv6, GTPv2 or DSMIPv6 following a previous RAR/RAA command exchange initiated by the 3GPP AAA Server. + +``` + ::= < Diameter Header: 265, REQ, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + [ User-Name ] + [ MIP6-Agent-Info ] + [ MIP6-Feature-Vector ] + [ Visited-Network-Identifier ] + [ QoS-Capability ] + [ Service-Selection ] + [ OC-Supported-Features ] + [ Origination-Time-Stamp ] + [ Maximum-Wait-Time ] + *[ Supported-Features ] + [ Emergency- Services ] + ... + *[ AVP ] +``` + +#### 9.2.2.2.2 AA-Answer (AAA) Command + +The AA-Answer (AAA) command, indicated by the Command-Code field set to 265 and the "R" bit cleared in the Command Flags field, is sent from the 3GPP AAA Server to the PDN GW. The Command Code value and ABNF are re-used from the IETF RFC 4005 [4] AA-Answer command. New AVPs are added using the \*[AVP] extension mechanism in the original ABNF. + +NOTE: This command is used for the S6b Authorization Procedure for PMIPv6 or GTPv2, and also for the S6b Service Authorization Information Update procedure for PMIPv6, GTPv2 or DSMIPv6 following a previous RAR/RAA command exchange initiated by the 3GPP AAA Server. + +``` + ::= < Diameter Header: 265, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + { Origin-Host } + { Origin-Realm } + ... + [ MIP6-Feature-Vector ] + [ Session-Timeout ] + [ APN-Configuration ] + [ QoS-Resources ] + [ AN-Trusted ] + *[ Redirect-Host ] + [ Trace-Info ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] +``` + +``` + +*[ Supported-Features ] +... +*[ AVP ] + +``` + +### 9.2.2.3 Commands for PDN GW Initiated Session Termination + +#### 9.2.2.3.1 Session-Termination-Request (STR) Command + +The Session-Termination-Request (STR) command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is sent from a PDN GW to a 3GPP AAA server. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58] Session-Termination-Request command. New AVPs are added using the \*[AVP] extension mechanism in the original ABNF. + +``` + + ::= < Diameter Header: 275, REQ, PXY, 16777272 > +< Session-Id > +[ DRMP ] +{ Auth-Application-Id } +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +{ Termination-Cause } +[ User-Name ] +[ OC-Supported-Features ] +... +*[ AVP ] + +``` + +#### 9.2.2.3.2 Session-Termination-Answer (STA) Command + +The Session-Termination-Answer (STA) command, indicated by the Command-Code field set to 275 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA server to a PDN GW. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58] Session-Termination-Answer command. + +``` + + ::= < Diameter Header: 275, PXY, 16777272 > + +< Session-Id > +[ DRMP ] +{ Result-Code } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ AVP ] + +``` + +### 9.2.2.4 Commands for 3GPP AAA Server Initiated Session Termination + +#### 9.2.2.4.1 Abort-Session-Request (ASR) Command + +The Abort-Session-Request (ASR) command, indicated by the Command-Code field set to 274 and the "R" bit set in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to a PDN GW. The ABNF is based on the one in IETF RFC 4005 [4]. + +``` + +< Abort-Session-Request > ::= < Diameter Header: 274, REQ, PXY, 16777272 > +< Session-Id > +[ DRMP ] +{ Origin-Host } +{ Origin-Realm } +{ Destination-Realm } +{ Destination-Host } +{ Auth-Application-Id } +[ User-Name ] +[ Auth-Session-State ] +... + +``` + +\*[ AVP ] + +#### 9.2.2.4.2 Abort-Session-Answer (ASA) Command + +The Abort-Session-Answer (ASA) command, indicated by the Command-Code field set to 274 and the "R" bit cleared in the Command Flags field, is sent from a PDN GW to a 3GPP AAA Server/Proxy. The ABNF is based on the one in IETF RFC 4005 [4]. + +``` +< Abort-Session-Answer > ::= < Diameter Header: 274, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + ... + *[ AVP ] +``` + +#### 9.2.2.4.3 Session-Termination-Request (STR) Command + +The Session-Termination-Request (STR) command, indicated by the Command-Code field set to 275 and the "R" bit set in the Command Flags field, is sent from an PDN GW to a 3GPP AAA Server/Proxy. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58] Session-Termination-Request command. + +``` + ::= < Diameter Header: 275, REQ, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Application-Id } + { Termination-Cause } + [ User-Name ] + [ OC-Supported-Features ] + ... + *[ AVP ] +``` + +#### 9.2.2.4.4 Session-Termination-Answer (STA) Command + +The Session-Termination-Answer (STA) command, indicated by the Command-Code field set to 275 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server/Proxy to an PDN GW. The Command Code value and ABNF are re-used from the IETF RFC 6733 [58] Session-Termination-Answer command. + +``` + ::= < Diameter Header: 275, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ AVP ] +``` + +### 9.2.2.5 Commands for S6b MIPv4 FACoA Authorization Procedures + +#### 9.2.2.5.1 AA-Request (AAR) Command + +The AA-Request (AAR) command, indicated by the Command-Code field set to 265 and the "R" bit set in the Command Flags field, is sent from a PDN GW to a 3GPP AAA Server. The Command Code value and ABNF are re-used from the IETF RFC 4005 [4] AA-Request command. New AVPs are added using the \*[AVP] extension mechanism in the original ABNF. + +``` + + ::= < Diameter Header: 265, REQ, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + [ User-Name ] + [ MIP6-Agent-Info ] + [ MIP6-Feature-Vector ] + [ Visited-Network-Identifier ] + [ QoS-Capability ] + [ Service-Selection ] + *[ Supported-Features ] + [MIP-MN-HA-SPI] + [ OC-Supported-Features ] + ... + *[ AVP ] + +``` + +#### 9.2.2.5.2 AA-Answer (AAA) Command + +The AA-Answer (AAA) command, indicated by the Command-Code field set to 265 and the "R" bit cleared in the Command Flags field, is sent from a 3GPP AAA Server to a PDN GW. The Command Code value and ABNF are re-used from the IETF RFC 4005 [4] AA-Answer command. New AVPs are added using the \*[AVP] extension mechanism in the original ABNF. + +``` + + ::= < Diameter Header: 265, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + ... + [ MIP6-Feature-Vector ] + [ Session-Timeout ] + [ APN-Configuration ] + [ QoS-Resources ] + *[ Redirect-Host ] + *[ Supported-Features ] + [MIP-Session-Key] + ... + *[ AVP ] + +``` + +#### 9.2.2.6 Commands for S6b Service Authorization Information Update Procedures + +##### 9.2.2.6.1 Re-Auth-Request (RAR) Command + +The Diameter Re-Auth-Request (RAR) command shall be indicated by the Command-Code field set to 258 and the "R" bit set in the Command Flags field and is sent from a 3GPP AAA Server or 3GPP AAA Proxy to a PDN-GW. The ABNF for the RAR command shall be as follows: + +``` + +< Re-Auth-Request > ::= < Diameter Header: 258, REQ, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + { Re-Auth-Request-Type } + [ User-Name ] + [ RAR-Flags ] + ... + *[ AVP ] + +``` + +#### 9.2.2.6.2 Re-Auth-Answer (RAA) Command + +The Diameter Re-Auth-Answer (ASA) command shall be indicated by the Command-Code field set to 258 and the "R" bit cleared in the Command Flags field and is sent from a PDN-GW to a 3GPP AAA Server or 3GPP AAA Proxy. The ABNF for the RAA commands shall be as follows: + +``` + +< Re-Auth-Answer > ::= < Diameter Header: 258, PXY, 16777272 > + < Session-Id > + [ DRMP ] + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + ... + *[ AVP ] + +``` + +### 9.2.3 Information Elements + +#### 9.2.3.0 General + +The following clauses describes the Diameter AVPs defined for the S6b interface protocol in the different modes of operation (DSMIPv6, PMIPv6/GTPv2, MIPv4...). + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +#### 9.2.3.1 S6b DSMIPv6 procedures + +##### 9.2.3.1.1 General + +The following table describes the Diameter AVPs defined for the S6b interface protocol in DSMIPv6 mode, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +**Table 9.2.3.1.1/1: Diameter S6b AVPs for DSMIPv6** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | +|----------------------------|----------|----------------|-------------|----------------|-----|------------|----------| +| | | | | Must | May | Should not | Must not | +| MIP6-Agent-Info | 486 | 9.2.3.2.2 | Grouped | M | | | V,P | +| MIP6-Feature-Vector | 124 | 9.2.3.2.3 | Unsigned64 | M | | | V,P | +| Visited-Network-Identifier | 600 | 9.2.3.1.2 | OctetString | M,V | | | P | +| RAR-Flags | 1522 | 9.2.3.1.5 | Unsigned32 | V | | | M,P | +| QoS-Capability | 578 | 9.2.3.2.4 | Grouped | M | | | V,P | +| QoS-Resources | 508 | 9.2.3.2.5 | Grouped | M | | | V,P | +| Trace-Info | 1505 | 8.2.3.13 | Grouped | V | | | M,P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | +| Trust-Relationship-Update | 1515 | 9.2.3.1.4 | Enumerated | V | | | M,P | +| AAA-Failure-Indication | 1518 | 8.2.3.21 | Unsigned32 | V | | | M,P | +| DER-S6b-Flags | 1523 | 9.2.3.7 | Unsigned32 | V | | | M,P | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +### 9.2.3.1.2 Visited-Network-Identifier + +The Visited-Network-Identifier AVP contains an identifier that helps the home network to identify the visited network (e.g. the visited network domain name). The Vendor-Id shall be set to 10415 (3GPP). + +The AVP shall be encoded as: + +mnc.mcc.3gppnetwork.org + +If MNC consists of only 2 digits, a leading digit "0" shall be added to the MNC value (e.g., if MNC=15 and MCC=234, the value of Visited-Network-Identifier shall be "mnc015.mcc234.3gppnetwork.org"). + +### 9.2.3.1.3 Void + +### 9.2.3.1.4 Void + +### 9.2.3.1.5 RAR-Flags + +The RAR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 9.2.3.1.5/1: + +**Table 9.2.3.1.5/1: RAR-Flags** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Trust-Relationship-Update-indication | This bit, when set, indicates to the PDN GW that the 3GPP AAA server only initiates the re-authorization procedure send the trust relationship to the PDN GW, and the PDN GW shall not perform any authorization procedure towards the UE. | +| 1 | P-CSCF Restoration Request | This bit, when set, shall indicate to the PDN GW that the 3GPP AAA Server requests the execution of the HSS-based P-CSCF restoration procedures for WLAN, as described in 3GPP TS 23.380 [52] clause 5.6. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 9.2.3.2 S6b PMIPv6 or GTPv2 procedures + +#### 9.2.3.2.1 General + +The following table describes the Diameter AVPs defined for the S6b interface protocol in PMIPv6 or GTPv2 mode, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +**Table 9.2.3.2.1/1: Diameter S6b AVPs for PMIPv6 or GTPv2** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | +|----------------------------|----------|----------------|-------------|----------------|-----|------------|----------| +| | | | | Must | May | Should not | Must not | +| MIP6-Agent-Info | 486 | 9.2.3.2.2 | Grouped | M | | | V,P | +| MIP6-Feature-Vector | 124 | 9.2.3.2.3 | Unsigned64 | M | | | V,P | +| QoS-Capability | 578 | 9.2.3.2.4 | Grouped | M | | | V,P | +| QoS-Resources | 508 | 9.2.3.2.5 | Grouped | M | | | V,P | +| Trace-Info | 1505 | 8.2.3.13 | Grouped | V | | | M,P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | +| Visited-Network-Identifier | 600 | 9.2.3.1.2 | OctetString | M,V | | | P | +| Origination-Time-Stamp | 1536 | 9.2.3.2.6 | Unsigned64 | V | | | M,P | +| Maximum-Wait-Time | 1537 | 9.2.3.2.7 | Unsigned32 | V | | | M,P | +| Emergency- Services | 1538 | 7.2.3.5 | Unsigned32 | V | | | M,P | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +#### 9.2.3.2.2 MIP6-Agent-Info + +The MIP6-Agent-Info AVP contains the PDN GW identity or (for the chained S2 - PMIP based S8 case) the Serving GW address information. This AVP is defined in IETF RFC 5447 [6]. The identity of PDN GW is either an IP address transported in MIP-Home-Agent-Address or an FQDN transported in MIP-Home-Agent-Host. The PDN GW may use its IP address if a single IP address can be used for all Access Networks and protocols towards the PDN GW. In all other cases the PDN GW shall use its FQDN. MAG/AAA/HSS shall use FQDN if known. The grouped AVP has the following grammar: + +``` +MIP6-Agent-Info ::= < AVP Header: 486 > + *2[ MIP-Home-Agent-Address ] + [ MIP-Home-Agent-Host ] + [ MIP6-Home-Link-Prefix ] + *[ AVP ] +``` + +NOTE: The AVP MIP6-Home-Link-Prefix is not used in S6b, but it is included here to reflect the complete IETF definition of the grouped AVP. + +#### 9.2.3.2.3 MIP6-Feature-Vector + +The MIP6-Feature-Vector AVP contains a 64 bit flags field of supported mobility capabilities of the NAS. This AVP is defined in IETF RFC 5447 [6]. The NAS may include this AVP in a request message to indicate the mobility capabilities of the NAS to the 3GPP AAA server. Similarly, the Diameter server may include this AVP in an answer message to inform the NAS about which of the NAS indicated capabilities are supported or authorized by the 3GPP AAA Server. + +Following capabilities are supported on S6b reference point in PMIPv6 or GTPv2 mode: + +- PMIP6\_SUPPORTED +- IP4\_HOA\_SUPPORTED +- GTPv2\_SUPPORTED + +#### 9.2.3.2.4 QoS-Capability + +The QoS-Capability AVP contains a list of supported Quality of Service profile templates (and therefore the support of the respective parameter AVPs). This AVP is defined in IETF RFC 5777 [9]. + +#### 9.2.3.2.5 QoS-Resources + +The QoS-Resources AVP includes a description of the Quality of Service resources for policing traffic flows. This AVP is defined in IETF RFC 5777 [9]. + +#### 9.2.3.2.6 Origination-Time-Stamp + +The Origination-Time-Stamp is of type Unsigned64. It indicates the UTC time when the originating entity initiated the request. It shall contain the number of milliseconds since 00:00:00 on 1 January 1900 UTC. + +NOTE: This AVP contains the same numeric value, in milliseconds, as received over the GTPv2 protocol from the originating entity (see 3GPP TS 29.274 [38], clause 8.119). + +#### 9.2.3.2.7 Maximum-Wait-Time + +The Maximum-Wait-Time is of type Unsigned32. It indicates the number of milliseconds since the Origination-Time-Stamp during which the originator of a request waits for a response. See 3GPP TS 29.274 [38]. + +#### 9.2.3.3 S6b Re-used Diameter AVPs + +**Table 9.2.3.3/1: S6b re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---------------------| +| Supported-Features | 3GPP TS 29.229 [24] | | +| Feature-List-ID | 3GPP TS 29.229 [24] | See clause 9.2.3.4 | +| Feature-List | 3GPP TS 29.229 [24] | See clause 9.2.3.5 | +| MIP-Careof-Address | IETF RFC 5778 [11] | | +| UE-Local-IP-Address | 3GPP TS 29.212 [23] | | +| OC-Supported-Features | IETF RFC 7683 [47] | See clause 8.2.3.22 | +| OC-OLR | IETF RFC 7683 [47] | See clause 8.2.3.23 | +| DRMP | IETF RFC 7944 [53] | See clause 8.2.3.25 | +| Load | IETF RFC 8583 [54] | See clause 8.2.3.26 | +| NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. | | | +| NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. | | | + +#### 9.2.3.4 Feature-List-ID AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. For this release, the Feature-List-ID AVP value shall be set to 1 for the S6b application. + +#### 9.2.3.5 Feature-List AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [24]. A null value indicates that there is no feature used by the S6b application. The meaning of the bits shall be as defined in table 9.2.3.5/1. + +**Table 9.2.3.5/1: Features of Feature-List-ID 1 used in S6b** + +| Feature bit | Feature | M/O | Description | +|-------------|-----------------------------|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | P-CSCF Restoration for WLAN | O |

Support of P-CSCF Restoration for WLAN

This feature is applicable to the AAR/AAA and RAR/RAA command pairs over the S6b interface, when the PDN GW supports the execution of the P-CSCF restoration procedures for WLAN for the related IMS PDN connection as described in 3GPP TS 23.380 [52] clause 5.6.

If the PDN-GW does not indicate support of this feature in a former AAR command, the 3GPP AAA Server shall not send a RAR command requesting the execution of the HSS-based P-CSCF restoration procedures for WLAN,

| + +Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1". +Feature: A short name that can be used to refer to the bit and to the feature. +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. + +Features that are not indicated in the Supported-Features AVPs within a given application message shall not be used to construct that message. + +### 9.2.3.6 S6b MIPv4 FACoA procedures + +#### 9.2.3.6.1 General + +The following table describes the Diameter AVPs defined for the S6b interface protocol in MIPv4 mode, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. + +**Table 9.2.3.6.1/1: Diameter S6b AVPs for MIPv4 FACoA** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | +|---------------------|----------|----------------|-------------|----------------|-----|------------|----------| +| | | | | Must | May | Should not | Must not | +| MIP6-Agent-Info | 486 | 9.2.3.6.2 | Grouped | M | | | V,P | +| MIP6-Feature-Vector | 124 | 9.2.3.6.3 | Unsigned64 | M | | | V,P | +| QoS-Capability | 578 | 9.2.3.6.4 | Grouped | M | | | V,P | +| QoS-Resources | 508 | 9.2.3.6.5 | Grouped | M | | | V,P | +| MIP-MN-HA-SPI | 491 | 9.2.3.6.6 | Unsigned32 | M | | | V,P | +| MIP-Session-Key | 343 | 9.2.3.6.7 | OctetString | M | | | V,P | +| Service-Selection | 493 | 5.2.3.5 | UTF8String | M | | | V,P | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V", indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [58]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +#### 9.2.3.6.2 MIP6-Agent-Info + +The MIP6-Agent-Info AVP contains the PDN GW identity. This AVP is defined in IETF RFC 5447 [6]. The identity of PDN GW is either an IP address transported in MIP-Home-Agent-Address or an FQDN transported in MIP-Home-Agent-Host. The PDN GW may use its IP address if a single IP address can be used for all Access Networks and protocols towards the PDN GW. In all other cases the PDN GW shall use its FQDN. The FA/3GPP AAA Server/HSS shall use FQDN if known. The grouped AVP has the following grammar: + +``` +MIP6-Agent-Info ::= < AVP Header: 486 > + *2[ MIP-Home-Agent-Address ] + [ MIP-Home-Agent-Host ] + [ MIP6-Home-Link-Prefix ] + *[ AVP ] +``` + +NOTE: The AVP MIP6-Home-Link-Prefix is not used in S6b, but it is included here to reflect the complete IETF definition of the grouped AVP. + +#### 9.2.3.6.3 MIP6-Feature-Vector + +The MIP6-Feature-Vector AVP contains a 64 bit flags field of supported mobility capabilities of the NAS. This AVP is defined in IETF RFC 5447 [6]. The NAS may include this AVP in a request message to indicate the mobility capabilities of the NAS to the 3GPP AAA Server. Similarly, the Diameter server may include this AVP in an answer message to inform the NAS about which of the NAS indicated capabilities are supported or authorized by the 3GPP AAA Server. + +Following capabilities are supported on S6b reference point in MIPv4 FACoA mode: + +- MIP4\_SUPPORTED + +#### 9.2.3.6.4 QoS-Capability + +The QoS-Capability AVP contains a list of supported Quality of Service profile templates (and therefore the support of the respective parameter AVPs). This AVP is defined in IETF RFC 5777 [9]. + +#### 9.2.3.6.5 QoS-Resources + +The QoS-Resources AVP includes a description of the Quality of Service resources for policing traffic flows. This AVP is defined in IETF RFC 5777 [9]. + +#### 9.2.3.6.6 MIP-MN-HA-SPI + +The MIP-MN-HA-SPI AVP contains the index of the security association between the Mobile Node and the HA. This AVP is defined in IETF RFC 5778 [11]. + +#### 9.2.3.6.7 MIP-Session-Key + +The MIP-Session-Key AVP contains the MN-HA shared key. This AVP is defined in IETF RFC 4004 [18]. + +#### 9.2.3.7 DER-S6b-Flags + +The DER-S6b-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 9.2.3.7/1: + +**Table 9.2.3.7/1: DER-S6b-Flags** + +| Bit | Name | Description | +|-------|-------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Initial-Attach-Indicator | This bit, when set, indicates that a UE performs the Initial Attach procedure from non-3GPP access network. When not set, it indicates that a UE performs the Handover procedure. | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | + +### 9.2.4 Session Handling + +The Diameter protocol between the PDN-GW and the 3GPP AAA Server or the 3GPP AAA Proxy shall always keep session state, and use the same Session-Id parameter for the lifetime of each Diameter session. + +A Diameter session shall identify a PDN Connection for a given user and an APN, while the PDN Connection is kept alive in the non-3GPP access. When the PDN Connection is either disconnected on the non-3GPP access, or handed over to the 3GPP access, the diameter session shall be terminated. In order to indicate that the session state is to be maintained, the Diameter client and server shall not include the Auth-Session-State AVP, either in the request or in the response messages (see IETF RFC 6733 [58]). + +--- + +## 10 Result-Code and Experimental-Result Values + +### 10.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 10.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in Diameter base protocol (IETF RFC 6733 [58]) shall be applied. + +### 10.3 Permanent Failures + +#### 10.3.1 General + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in Diameter base protocol (IETF RFC 6733 [58]) shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 10.3.2 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the HSS to indicate that the user identified by the IMSI is unknown (see 3GPP TS 29.229 [24]). + +#### 10.3.3 DIAMETER\_ERROR\_IDENTITY\_NOT\_REGISTERED (5003) + +This result code shall be sent by the HSS to indicate that there is currently no 3GPP AAA Server registered for the user (see 3GPP TS 29.229 [24]). + +#### 10.3.4 DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED (5004) + +This result code shall be sent by the HSS to indicate that the subscriber is not allowed to roam in a certain non-3GPP V-PLMN (see 3GPP TS 29.229 [24]). + +#### 10.3.5 DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED (5005) + +This result code shall be sent by the HSS to indicate that the node identity trying to be registered by a 3GPP AAA Server is already registered for a specific user (see 3GPP TS 29.229 [24]). + +#### 10.3.6 DIAMETER\_ERROR\_USER\_NO\_NON\_3GPP\_SUBSCRIPTION (5450) + +This result code shall be sent by the HSS to indicate that no non-3GPP subscription is associated with the IMSI. + +#### 10.3.7 DIAMETER\_ERROR\_USER\_NO\_APN\_SUBSCRIPTION (5451) + +This result code shall be sent by the 3GPP AAA Server to indicate that the requested APN is not included in the user's profile, and therefore is not authorized for that user. + +### 10.3.8 DIAMETER\_ERROR\_RAT\_TYPE\_NOT\_ALLOWED (5452) + +This result code shall be sent by the HSS to indicate the RAT type the UE is using is not allowed for the IMSI. + +### 10.3.9 DIAMETER\_ERROR\_LATE\_OVERLAPPING\_REQUEST (5453) + +This result code shall be sent by the 3GPP AAA Server to indicate that the incoming request collides with an existing session which has a more recent time stamp than the time stamp of the new request. + +### 10.3.10 DIAMETER\_ERROR\_TIMED\_OUT\_REQUEST (5454) + +This result code shall be sent by the 3GPP AAA Server to indicate that the incoming request is known to have already timed out at the originating entity. + +### 10.3.11 DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT (5554) + +This result code shall be sent by the 3GPP AAA Server or 3GPP AAA Proxy to indicate that the Mobile Equipment used is not acceptable to the network (e.g. the Mobile Equipment is on the prohibited list of the EIR). + +### 10.3.12 + +#### DIAMETER\_ERROR\_TRUSTED\_NON\_3GPP\_ACCESS\_NOT\_ALLOWED (5455) + +This result code shall be sent by the HSS to indicate that trusted non-3GPP access is not authorized for the user. + +### 10.3.13 + +#### DIAMETER\_ERROR\_UNTRUSTED\_NON\_3GPP\_ACCESS\_NOT\_ALLOWED (5456) + +This result code shall be sent by the HSS to indicate that untrusted non-3GPP access is not authorized for the user. + +## 10.4 Transient Failures + +### 10.4.1 General + +Result codes that fall within the transient failures category shall be used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. The Result-Code AVP values defined in Diameter base protocol ( IETF RFC 6733 [58]) shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +There are no Transient Error codes defined in this specification. + +## 11 3GPP AAA Server/Proxy – EIR + +### 11.1 Functionality + +#### 11.1.1 General + +The definition of the reference point between the 3GPP AAA Server or 3GPP AAA Proxy and the EIR and its functionality is specified in clauses 7.2 and 16.2 in 3GPP TS 23.402 [3]. + +The 3GPP AAA Server/Proxy – EIR reference point is used to check the Mobile Equipment's identity status (e.g. to check that it has not been stolen, or, to verify that it does not have faults). + +#### 11.1.2 Procedures Description + +##### 11.1.2.1 ME Identity Check + +###### 11.1.2.1.1 General + +The Mobile Equipment Identity Check Procedure shall be used between the 3GPP AAA Server and the EIR if the TWAN or ePDG is in the HPLMN, or between the 3GPP AAA Proxy and the EIR if the TWAN or ePDG is in the VPLMN, to check the Mobile Equipment's identity status (e.g. to check that it has not been stolen, or, to verify that it does not have faults). + +The Diameter Identity of the EIR is locally configured in the 3GPP AAA Server and 3GPP AAA Proxy. + +This procedure is mapped to the commands ME-Identity-Check-Request/Answer (ECR/ECA) in the Diameter application specified in clause 7 of 3GPP TS 29.272 [29]. + +Table 11.1.2.1.1/1 specifies the involved information elements for the request. + +Table 11.1.2.1.1/2 specifies the involved information elements for the answer. + +**Table 11.1.2.1.1/1: ME Identity Check Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Terminal Information | Terminal-Information | M | This information element shall contain the information about the used mobile equipment i.e. the IMEI. Within this Information Element, only the IMEI and the Software-Version AVPs shall be used on the 3GPP AAA Server/Proxy – EIR interface. | +| IMSI | User-Name (See IETF RFC 6733 [58]) | O | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | + +**Table 11.1.2.1.1/2: ME Identity Check Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [58]).
The Experimental-Result AVP shall be used for errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- Unknown equipment | +| Equipment Status | Equipment-Status | C | This information element shall contain the status of the requested mobile equipment as defined in 3GPP TS 22.016 [13].
It shall be present if the result of the ME Identity Check is DIAMETER_SUCCESS. | + +#### 11.1.2.1.2 3GPP AAA Server Detailed Behaviour + +The 3GPP AAA Server shall make use of this procedure to check the ME identity, if the 3GPP AAA Server is configured to check the IMEI with the EIR and if the ePDG or TWAN is in the HPLMN. + +Terminal-Information, when sent by the 3GPP AAA Server to the EIR, shall contain the IMEI AVP, and it may contain also the Software-Version AVP. + +IMSI may be sent together with Terminal Information to the EIR for operator-determined purposes. + +When receiving the ME Identity Check answer from the EIR, the 3GPP AAA Server shall check the result code and the equipment status. Dependent upon the result, the 3GPP AAA Server shall determine whether to continue or stop the authentication and authorization procedure, see clause 5.1.2.1 and 7.1.2.1. + +#### 11.1.2.1.3 3GPP AAA Proxy Detailed Behaviour + +The 3GPP AAA Proxy shall make use of this procedure to check the ME identity, if the 3GPP AAA Proxy is configured to check the IMEI with the EIR and if the ePDG or TWAN is in the VPLMN. + +Terminal-Information, when sent by the 3GPP AAA Proxy to the EIR, shall contain the IMEI AVP, and it may contain also the Software-Version AVP. + +IMSI may be sent together with Terminal Information to the EIR for operator-determined purposes. + +When receiving the ME Identity Check answer from the EIR, the 3GPP AAA Proxy shall check the result code and the equipment status. Dependent upon the result, the 3GPP AAA Server shall determine whether to continue or stop the authentication and authorization procedure, see clause 5.1.2.1 and 7.1.2.1. + +#### 11.1.2.1.4 EIR Detailed Behaviour + +See clause 6.2.1.3 of 3GPP TS 29.272 [29]. + +## 11.2 Protocol Specification + +### 11.2.1 General + +The 3GPP AAA Server/Proxy – EIR reference point shall be based on Diameter, as defined in IETF RFC 6733 [58]. It shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application used over the 3GPP AAA Server/Proxy – EIR reference point is the S13/S13' Diameter application, and the application identifier is 16777252 (allocated by IANA). + +## 11.2.2 Commands + +### 11.2.2.1 ME Identity Check + +#### 11.2.2.1.1 ME-Identity-Check-Request (ECR) Command + +See clause 7.2.19 of 3GPP TS 29.272 [29]. + +#### 11.2.2.1.2 ME-Identity-Check-Answer (ECA) Command + +See clause 7.2.20 of 3GPP TS 29.272 [29]. + +## 11.2.3 Information Elements + +### 11.2.3.1 General + +The following table specifies the Diameter AVPs re-used by the 3GPP AAA Server/Proxy - EIR interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use for the 3GPP AAA Server/Proxy – EIR interface. + +Any other AVPs from existing Diameter Applications, except for the AVPs from Diameter Base Protocol, do not need to be supported. The AVPs from Diameter base protocol specified in IETF RFC 6733 [58] are not included in table 11.2.3.1/1, but they may be re-used for the 3GPP AAA Server/Proxy - EIR protocol. + +**Table 11.2.3.1/1: Diameter AVPs re-used for the 3GPP AAA Server/Proxy – EIR interface** + +| Attribute Name | Reference | Comments | M-bit | +|----------------------|---------------------|----------|-------| +| Terminal-Information | 3GPP TS 29.272 [29] | | | +| User-Name | IETF RFC 6733 [58] | | | +| Equipment-Status | 3GPP TS 29.272 [29] | | | + +## 11.2.4 Session Handling + +The Diameter sessions between the 3GPP AAA Server and the EIR, and between the 3GPP AAA Proxy and the EIR, shall be handled as specified for the Diameter sessions between the MME and the EIR in clause 7.1.4 of 3GPP TS 29.272 [29]. + +# Annex A (informative): Trusted WLAN authentication and authorization procedure + +## A.1 General + +This clause provides example call flows for the Trusted WLAN authentication and authorization procedure. + +Call flows for TSCM or SCM for Non-seamless WLAN Offload are not represented as they can be easily derived from the normative part of this specification. + +This Annex is informative and the normative descriptions in this specification and in 3GPP TS 33.402 [19] prevail over the descriptions in this Annex if there is any difference. + +## A.2 Call Flow for SCM and EPC-routed access + +### A.2.1 Successful call flow + +Figure Annex A.2-1 describes a successful call flow for SCM and EPC-routed access, i.e. with S2a connectivity being granted to the UE. + +![Sequence diagram showing the successful call flow for TWAN Authentication and Authorization Procedure for SCM and EPC routed access. The diagram involves six main entities: UE, TWAN, PGW, 3GPP AAA Proxy (within a Roaming domain), 3GPP AAA, and HSS. The process starts with an 802.11 connection establishment between UE and TWAN, followed by EAP-REQ/Identity and EAP-RSP/Identity messages. The TWAN then sends a DER (EAP-RSP / Identity) to the 3GPP AAA Proxy, which forwards it to the 3GPP AAA. The 3GPP AAA sends an Authentication Vector Retrieval to the HSS. The HSS returns an Authentication Vector to the 3GPP AAA, which sends a DEA (EAP-REQ / AKA'-Challenge) to the 3GPP AAA Proxy, which in turn sends an EAP-REQ / AKA'-Challenge to the UE. The UE responds with an EAP-RSP / AKA'-Challenge (mode=SCM, EPC/NSWO, APN, PDN Type, IMEISV...). The 3GPP AAA Proxy sends a DER (EAP-RSP / AKA'-Challenge) to the 3GPP AAA, which sends a Subscriber Profile Retrieval and Registration to the HSS. The HSS returns a DEA (mode=SCM, TWAN-S2a-Connectivity flag, subscription info, EPC/NSWO, APN, PDN Type, IMEISV...) to the 3GPP AAA, which sends a Create Session Request / PBU to the PGW. The PGW sends an Update PGW Address to the 3GPP AAA, which sends a Create Session Response / PBA to the PGW. The PGW sends a DER (TWAN-S2a-Connectivity flag, APN, PDN Type ...) to the 3GPP AAA Proxy, which sends an EAP-REQ / AKA'-Notification to the UE. The UE responds with an EAP-RSP / AKA'-Notification. The 3GPP AAA Proxy sends a DER (EAP-RSP / AKA'-Notification) to the 3GPP AAA, which sends a DEA (EAP-Success) to the PGW, which in turn sends an EAP-Success to the UE.](8650b869a9e7291ac2caad3d008e1770_img.jpg) + +Sequence diagram showing the successful call flow for TWAN Authentication and Authorization Procedure for SCM and EPC routed access. The diagram involves six main entities: UE, TWAN, PGW, 3GPP AAA Proxy (within a Roaming domain), 3GPP AAA, and HSS. The process starts with an 802.11 connection establishment between UE and TWAN, followed by EAP-REQ/Identity and EAP-RSP/Identity messages. The TWAN then sends a DER (EAP-RSP / Identity) to the 3GPP AAA Proxy, which forwards it to the 3GPP AAA. The 3GPP AAA sends an Authentication Vector Retrieval to the HSS. The HSS returns an Authentication Vector to the 3GPP AAA, which sends a DEA (EAP-REQ / AKA'-Challenge) to the 3GPP AAA Proxy, which in turn sends an EAP-REQ / AKA'-Challenge to the UE. The UE responds with an EAP-RSP / AKA'-Challenge (mode=SCM, EPC/NSWO, APN, PDN Type, IMEISV...). The 3GPP AAA Proxy sends a DER (EAP-RSP / AKA'-Challenge) to the 3GPP AAA, which sends a Subscriber Profile Retrieval and Registration to the HSS. The HSS returns a DEA (mode=SCM, TWAN-S2a-Connectivity flag, subscription info, EPC/NSWO, APN, PDN Type, IMEISV...) to the 3GPP AAA, which sends a Create Session Request / PBU to the PGW. The PGW sends an Update PGW Address to the 3GPP AAA, which sends a Create Session Response / PBA to the PGW. The PGW sends a DER (TWAN-S2a-Connectivity flag, APN, PDN Type ...) to the 3GPP AAA Proxy, which sends an EAP-REQ / AKA'-Notification to the UE. The UE responds with an EAP-RSP / AKA'-Notification. The 3GPP AAA Proxy sends a DER (EAP-RSP / AKA'-Notification) to the 3GPP AAA, which sends a DEA (EAP-Success) to the PGW, which in turn sends an EAP-Success to the UE. + +**Figure Annex A.2-1: TWAN Authentication and Authorization Procedure for SCM and EPC routed access – successful case** + +1. A connection is established between the UE and the TWAN, using a specific procedure based on IEEE 802.11 [40]. +2. The TWAN sends an EAP Request/Identity to the UE. +3. The UE sends an EAP Response/Identity message to the TWAN. +4. The TWAN forwards the EAP payload received from the UE to the 3GPP AAA Server and also indicates the supported TWAN connection modes in the DER message. The routing path may include one or several 3GPP AAA proxies for roaming case. +5. The 3GPP AAA Server retrieves authentication vectors for the UE from the HSS. + +6. The 3GPP AAA Server sends an EAP Request/AKA'-Challenge in which it also indicates to the UE the TWAN connection modes supported by the network (e.g. TSCM, SCM and MCM) and in which it also requests the UE to provide its Mobile Equipment Identity. The Result-Code AVP in the DEA message is set to DIAMETER\_MULTI\_ROUND\_AUTH. The TWAN-S2a-Connectivity Indicator is not set in the DEA-Flags AVP. +7. The TWAN forwards the EAP payload to the UE. +8. The UE sends the EAP Response/AKA'-Challenge in which it also indicates the requested connection mode. If the UE requests SCM and an EPC-routed access, the UE also indicates the requested APN, PDN type, Initial Attach/Handover indication and/or PCO. The user's Mobile Equipment Identity is also included, if available and if requested by the 3GPP AAA Server. +9. The TWAN forwards the EAP payload to 3GPP AAA Server. +10. If the 3GPP AAA Server successfully authenticates the UE, the 3GPP AAA Server downloads the user's subscription information from the HSS. +11. If the 3GPP AAA Server authorizes the SCM for EPC access for the UE, the 3GPP AAA Server includes the UE requested APN, PDN type, Initial Attach/Handover indication and/or PCO in the DEA message with the Result-Code AVP set to DIAMETER\_MULTI\_ROUND\_AUTH. The 3GPP AAA Server also sets the TWAN-S2a-Connectivity Indicator in the DEA-Flags AVP to request the TWAN to proceed with the establishment of the S2a connectivity. The 3GPP AAA Server also includes the user's Mobile Equipment Identity, if available. +12. The TWAN sends a Create Session Request/PBU message to the PDN GW to initiate the S2a tunnel establishment. +13. The PDN GW informs the 3GPP AAA Server/HSS of its PDN GW identity and the APN corresponding to the UE's PDN Connection. +14. The PDN GW returns a Create Session Response/PBA message to the TWAN, including the IP address(es) allocated for the UE. +15. The TWAN includes the provided Connectivity Parameters received from the PDN GW and sets the TWAN-S2a-Connectivity Indicator in the DER-Flags AVP in the DER message to the 3GPP AAA Server. The 3GPP AAA Server ignores the EAP payload included in the DER message. +16. The 3GPP AAA Server includes the PDN connectivity parameters in the AKA'-Notification and sends the DEA message to the TWAN. The Result-Code AVP in the DEA message is set to DIAMETER\_MULTI\_ROUND\_AUTH. The TWAN-S2a-Connectivity Indicator is not set in the DEA-Flags AVP. +17. The TWAN forwards the EAP payload to the UE. +- 18-19. The UE responds with an EAP-RSP/AKA'-Notification message that the TWAN forwards to the 3GPP AAA Server. +- 20-21. The 3GPP AAA Server sends an EAP Success message that the TWAN forwards to the UE. The Result-Code AVP in the DEA message is set to DIAMETER\_SUCCESS. The subscription information need not to be included in the DEA message (if not changed). + +## A.2.2 Unsuccessful call flow + +Figure Annex A.2-2 describes an unsuccessful call flow for SCM and EPC-routed access, where S2a connectivity can not been granted to the UE due to an overload condition in the network for the APN requested by the UE. + +![Sequence diagram for TWAN Authentication and Authorization Procedure for SCM and EPC routed access – UE request rejected with a Session Management back-off timer. The diagram shows interactions between UE, TWAN, PGW, 3GPP AAA Proxy (Roaming), 3GPP AAA, and HSS. The process starts with 802.11 Connection Established, followed by EAP-REQ/Identity and EAP-RSP/Identity exchanges. The TWAN sends a DER (EAP-RSP / Identity) to the 3GPP AAA. The 3GPP AAA performs Authentication Vector Retrieval from the HSS and returns a DEA (EAP-REQ / AKA'-Challenge) to the TWAN. The TWAN sends an EAP-REQ / AKA'-Challenge to the UE. The UE responds with an EAP-RSP / AKA'-Challenge. The TWAN sends a DER (EAP-RSP / AKA'-Challenge) to the 3GPP AAA. The 3GPP AAA performs Subscriber Profile Retrieval and Registration from the HSS and returns a DEA (mode=SCM, TWAN-S2a-Connectivity flag, subscription info, EPC/NSWO, APN, PDN Type, IMEISV...) to the TWAN. The TWAN sends a Create Session Request / PBU to the PGW. The PGW responds with a Create Session Response / PBA. The TWAN sends a DER (TWAN-S2a-Connectivity flag, TWAN-S2a-Failure-Cause, SM-Back-Off-Timer) to the 3GPP AAA. The 3GPP AAA sends a DEA (AKA'-Notification) to the TWAN. The TWAN sends an EAP-REQ / AKA'-Notification to the UE. The UE responds with an EAP-RSP / AKA'-Notification. The TWAN sends a DER (EAP-RSP / AKA'-Notification) to the 3GPP AAA. The 3GPP AAA sends a DEA (EAP-Failure) to the TWAN. The TWAN sends an EAP-Failure to the UE.](476b627f69146cf2c394a1f1f697b24e_img.jpg) + +Sequence diagram for TWAN Authentication and Authorization Procedure for SCM and EPC routed access – UE request rejected with a Session Management back-off timer. The diagram shows interactions between UE, TWAN, PGW, 3GPP AAA Proxy (Roaming), 3GPP AAA, and HSS. The process starts with 802.11 Connection Established, followed by EAP-REQ/Identity and EAP-RSP/Identity exchanges. The TWAN sends a DER (EAP-RSP / Identity) to the 3GPP AAA. The 3GPP AAA performs Authentication Vector Retrieval from the HSS and returns a DEA (EAP-REQ / AKA'-Challenge) to the TWAN. The TWAN sends an EAP-REQ / AKA'-Challenge to the UE. The UE responds with an EAP-RSP / AKA'-Challenge. The TWAN sends a DER (EAP-RSP / AKA'-Challenge) to the 3GPP AAA. The 3GPP AAA performs Subscriber Profile Retrieval and Registration from the HSS and returns a DEA (mode=SCM, TWAN-S2a-Connectivity flag, subscription info, EPC/NSWO, APN, PDN Type, IMEISV...) to the TWAN. The TWAN sends a Create Session Request / PBU to the PGW. The PGW responds with a Create Session Response / PBA. The TWAN sends a DER (TWAN-S2a-Connectivity flag, TWAN-S2a-Failure-Cause, SM-Back-Off-Timer) to the 3GPP AAA. The 3GPP AAA sends a DEA (AKA'-Notification) to the TWAN. The TWAN sends an EAP-REQ / AKA'-Notification to the UE. The UE responds with an EAP-RSP / AKA'-Notification. The TWAN sends a DER (EAP-RSP / AKA'-Notification) to the 3GPP AAA. The 3GPP AAA sends a DEA (EAP-Failure) to the TWAN. The TWAN sends an EAP-Failure to the UE. + +**Figure Annex A.2-2: TWAN Authentication and Authorization Procedure for SCM and EPC routed access – UE request rejected with a Session Management back-off timer.** + +1. to 11. Same as Figure Annex A.2-1. + +12. The TWAN sends a Create Session Request/PBU message to the PDN GW to initiate the S2a tunnel establishment, or skips this step and goes directly to step 14 if it is already aware of an overload condition for the requested APN and the UE request cannot be served by another PGW and if it decides to reject this UE request. + +13. The PDN GW rejects the UE request, possibly including overload control information. + +14. The TWAN rejects the request due to an overload condition for the APN requested by the UE. The TWAN returns the cause "insufficient resources" and provides a Session Management back-off timer to be sent to the UE. The TWAN also sets the TWAN-S2a-Connectivity Indicator in the DER-Flags AVP in the DER message to the 3GPP AAA Server. The 3GPP AAA Server ignores the EAP payload included in the DER message. + +15. The 3GPP AAA Server forwards the Session Management back-off timer received from the TWAN encapsulated in the AKA'-Notification and sends the DEA message to the TWAN. The Result-Code AVP in the DEA message is set to DIAMETER\_MULTI\_ROUND\_AUTH. The TWAN-S2a-Connectivity Indicator is not set in the DEA-Flags AVP. + +16. The TWAN forwards the EAP payload to the UE. + +17-18. The UE responds with an EAP-RSP/AKA'-Notification message that the TWAN forwards to the 3GPP AAA Server. + +19-20. The 3GPP AAA Server sends an EAP Failure message that the TWAN forwards to the UE. The Result-Code AVP in the DEA message is set to DIAMETER\_UNABLE\_TO\_COMPLY. + +## A.2.3 Call flow with IMEI check in VPLMN + +Figure Annex A.2-3 describes a roaming call flow for SCM and EPC-routed access, with IMEI check performed in the VPLMN. + +![Sequence diagram showing the TWAN Authentication and Authorization Procedure for SCM and EPC routed access, with IMEI check performed in the VPLMN. The diagram involves UE, TWAN, PGW, 3GPP AAA Proxy (in Roaming), 3GPP AAA, and HSS. The process includes 802.11 connection, EAP authentication, DER/DEA messages, IMEI check via EIR, and session creation.](7474a6dfb4787da442d12dcaec98fd04_img.jpg) + +``` + +sequenceDiagram + participant UE + participant TWAN + participant PGW + participant Roaming + participant 3GPP_AAA as 3GPP AAA + participant HSS + + Note right of Roaming: Roaming + UE->>TWAN: 1. 802.11 Connection Established + TWAN->>UE: 2. EAP-REQ / Identity + UE->>TWAN: 3. EAP-RSP / Identity + TWAN->>3GPP_AAA: 4. DER (EAP-RSP / Identity) + Note right of Roaming: 4. DER (EAP-RSP / Identity, IMEI-Check-Required-In-VPLMN) + 3GPP_AAA->>HSS: 5. Authentication Vector Retrieval + 3GPP_AAA->>TWAN: 6. DEA (EAP-REQ / AKA'-Challenge (modes=TSCM+SCM+MCM)) + TWAN->>UE: 7. EAP-REQ / AKA'-Challenge + UE->>TWAN: 8. EAP-RSP / AKA'-Challenge (mode=SCM, EPC/NSWO, APN, PDN Type, IMEISV...) + TWAN->>3GPP_AAA: 9. DER (EAP-RSP / AKA'-Challenge) + Note right of Roaming: 9A. DEA (IMEI-Check-Request-In-VPLMN, Terminal-Information) + Note right of Roaming: EIR check + Note right of Roaming: 9B. DER (IMEI-Check-Request-In-VPLMN, Terminal-Information) + Note right of Roaming: 9C. DER (IMEI-Check-In-VPLMN-Result) + 3GPP_AAA->>HSS: 10. Subscriber Profile Retrieval and Registration + 3GPP_AAA->>TWAN: 11. DEA (mode=SCM, TWAN-S2a-Connectivity flag, subscription info, EPC/NSWO, APN, PDN Type, IMEISV...) + TWAN->>PGW: 12. Create Session Request / PBU + PGW->>3GPP_AAA: 13. Update PGW Address + 3GPP_AAA->>PGW: 14. Create Session Response / PBA + PGW->>TWAN: 15. DER (TWAN-S2a-Connectivity flag, APN, PDN Type ...) + TWAN->>UE: 16. DEA (AKA'-Notification) + UE->>TWAN: 17. EAP-REQ / AKA'-Notification + TWAN->>UE: 18. EAP-RSP / AKA'-Notification + TWAN->>3GPP_AAA: 19. DER (EAP-RSP / AKA'-Notification) + Note right of Roaming: 20. DEA (EAP-Success) + TWAN->>UE: 21. EAP-Success + +``` + +Sequence diagram showing the TWAN Authentication and Authorization Procedure for SCM and EPC routed access, with IMEI check performed in the VPLMN. The diagram involves UE, TWAN, PGW, 3GPP AAA Proxy (in Roaming), 3GPP AAA, and HSS. The process includes 802.11 connection, EAP authentication, DER/DEA messages, IMEI check via EIR, and session creation. + +**Figure Annex A.2-3: TWAN Authentication and Authorization Procedure for SCM and EPC routed access, with IMEI check performed in the VPLMN** + +1. to 3. Same as Figure A.2-1. + +4. If IMEI check is required by operator policy, the 3GPP AAA Proxy sets the IMEI-Check-Required-In-VPLMN bit in the DER-Flags AVP. + +5. to 9. Same as Figure A.2-1. + +9A. The 3GPP AAA Server requests the VPLMN to perform the IMEI check by setting the IMEI-Check-Request-In-VPLMN bit in the DEA-Flags AVP and including the Terminal-Information AVP in the DEA message. + +9B. The TWAN returns the IMEI-Check-Request-In-VPLMN flag in the DER-Flags AVP and the Terminal-Information AVP to the 3GPP AAA Proxy. + +9C. The 3GPP AAA Proxy performs the IMEI check in the VPLMN and forwards the DER to the 3GPP AAA Server, replacing the IMEI-Check-Request-In-VPLMN bit in the DER-Flags AVP by the IMEI-Check-In-VPLMN-Result AVP. + +10. to 21. Same as Figure A.2-1 if the IMEI check in VPLMN was successful. + +Otherwise the 3GPP AAA Server sends an EAP Failure message that the TWAN forwards to the UE. The Result-Code AVP in the DEA message is set to DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT. + +## A.3 Call Flow for MCM for EPC-routed access and/or NSWO + +### A.3.1 Successful call flow + +Figure Annex A.3-1 describes a successful call flow for MCM, for EPC-routed access and/or Non-seamless WLAN offload. + +![Sequence diagram showing the successful call flow for MCM authentication and authorization. The diagram involves UE, TWAN, PGW, 3GPP AAA Proxy (in Roaming), 3GPP AAA, and HSS. The flow starts with 802.11 Connection Established between UE and TWAN, followed by EAP-REQ/Identity and EAP-RSP/Identity exchanges. The TWAN sends a DER (EAP-RSP / Identity) to the 3GPP AAA Proxy, which then sends an Authentication Vector Retrieval request to the HSS. The HSS returns a DEA (EAP-REQ / AKA'-Challenge) to the 3GPP AAA Proxy, which forwards it to the TWAN. The TWAN sends an EAP-REQ / AKA'-Challenge to the UE, which responds with an EAP-RSP / AKA'-Challenge (mode=MCM, IMEISV). The TWAN sends a DER (EAP-RSP / AKA'-Challenge) to the 3GPP AAA Proxy, which then sends a Subscriber Profile Retrieval and Registration request to the HSS. The HSS returns a DEA (AKA'-Notification) to the 3GPP AAA Proxy, which forwards it to the TWAN. The TWAN sends an EAP-REQ / AKA'-Notification to the UE, which responds with an EAP-RSP / AKA'-Notification. The TWAN sends a DER (EAP-RSP / AKA'-Notification) to the 3GPP AAA Proxy, which then sends a DEA (EAP-Success, mode=MCM, subscription info, EPC/NSWO, IMEISV ...) to the TWAN. Finally, the TWAN sends an EAP-Success message to the UE.](535f1ef9b1085c01063ee20d0f1942b7_img.jpg) + +``` + +sequenceDiagram + participant UE + participant TWAN + participant PGW + participant Roaming + participant 3GPP_AAA_Proxy as 3GPP AAA Proxy + participant 3GPP_AAA as 3GPP AAA + participant HSS + + Note right of Roaming: Roaming + UE->>TWAN: 1. 802.11 Connection Established + TWAN->>UE: 2. EAP-REQ / Identity + UE->>TWAN: 3. EAP-RSP / Identity + TWAN->>3GPP_AAA_Proxy: 4. DER (EAP-RSP / Identity) + 3GPP_AAA_Proxy->>HSS: 5. Authentication Vector Retrieval + HSS->>3GPP_AAA_Proxy: 6. DEA (EAP-REQ / AKA'-Challenge (mode=TSCM+SCM+MCM)) + 3GPP_AAA_Proxy->>TWAN: 7. EAP-REQ / AKA'-Challenge + TWAN->>UE: 7. EAP-REQ / AKA'-Challenge + UE->>TWAN: 8. EAP-RSP / AKA'-Challenge (mode=MCM, IMEISV) + TWAN->>3GPP_AAA_Proxy: 9. DER (EAP-RSP / AKA'-Challenge) + 3GPP_AAA_Proxy->>HSS: 10. Subscriber Profile Retrieval and Registration + HSS->>3GPP_AAA_Proxy: 11. DEA (AKA'-Notification) + 3GPP_AAA_Proxy->>TWAN: 11. DEA (AKA'-Notification) + TWAN->>UE: 12. EAP-REQ / AKA'-Notification + UE->>TWAN: 13. EAP-RSP / AKA'-Notification + TWAN->>3GPP_AAA_Proxy: 14. DER (EAP-RSP / AKA'-Notification) + 3GPP_AAA_Proxy->>TWAN: 15. DEA (EAP-Success, mode=MCM, subscription info, EPC/NSWO, IMEISV ...) + TWAN->>UE: 16. EAP-Success + +``` + +Sequence diagram showing the successful call flow for MCM authentication and authorization. The diagram involves UE, TWAN, PGW, 3GPP AAA Proxy (in Roaming), 3GPP AAA, and HSS. The flow starts with 802.11 Connection Established between UE and TWAN, followed by EAP-REQ/Identity and EAP-RSP/Identity exchanges. The TWAN sends a DER (EAP-RSP / Identity) to the 3GPP AAA Proxy, which then sends an Authentication Vector Retrieval request to the HSS. The HSS returns a DEA (EAP-REQ / AKA'-Challenge) to the 3GPP AAA Proxy, which forwards it to the TWAN. The TWAN sends an EAP-REQ / AKA'-Challenge to the UE, which responds with an EAP-RSP / AKA'-Challenge (mode=MCM, IMEISV). The TWAN sends a DER (EAP-RSP / AKA'-Challenge) to the 3GPP AAA Proxy, which then sends a Subscriber Profile Retrieval and Registration request to the HSS. The HSS returns a DEA (AKA'-Notification) to the 3GPP AAA Proxy, which forwards it to the TWAN. The TWAN sends an EAP-REQ / AKA'-Notification to the UE, which responds with an EAP-RSP / AKA'-Notification. The TWAN sends a DER (EAP-RSP / AKA'-Notification) to the 3GPP AAA Proxy, which then sends a DEA (EAP-Success, mode=MCM, subscription info, EPC/NSWO, IMEISV ...) to the TWAN. Finally, the TWAN sends an EAP-Success message to the UE. + +Figure Annex A.3-1: TWAN Authentication and Authorization Procedure for MCM – successful case + +1. A connection is established between the UE and the TWAN, using a specific procedure based on IEEE 802.11 [40]. +2. The TWAN sends an EAP Request/Identity to the UE. +3. The UE sends an EAP Response/Identity message to the TWAN. +4. The TWAN forwards the EAP payload received from the UE to the 3GPP AAA Server and also indicates the supported TWAN connection modes in the DER message. For MCM, the TWAN also provides the TWAG's control plane IPv4 and/or IPv6 addresses to be used by the UE for WLCP if the MCM is selected. The routing path may include one or several 3GPP AAA proxies for roaming case. +5. The 3GPP AAA Server retrieves authentication vectors for the UE from the HSS. +6. The 3GPP AAA Server sends an EAP Request/AKA'-Challenge in which it also indicates to the UE the TWAN connection modes supported by the network (e.g. TSCM, SCM and MCM) and, for MCM, the WLCP transport(s) supported by the TWAN (i.e. IPv4 and/or IPv6), and in which it also requests the UE to provide its Mobile Equipment Identity. The Result-Code AVP in the DEA message is set to DIAMETER\_MULTI\_ROUND\_AUTH. The TWAN-S2a-Connectivity Indicator is not set in the DEA-Flags AVP. +7. The TWAN forwards the EAP payload to the UE. +8. The UE sends the EAP Response/AKA'-Challenge in which it also indicates the requested connection mode. In this example, the UE requests the MCM. The user's Mobile Equipment Identity is also included, if available and if requested by the 3GPP AAA Server. +9. The TWAN forwards the EAP payload to the 3GPP AAA Server. +10. If the 3GPP AAA Server successfully authenticates the UE, the 3GPP AAA Server downloads the user's subscription information from the HSS. +11. The 3GPP AAA Server includes the information required for the MCM in the AKA'-Notification as specified in 3GPP TS 24.302[26] (e.g. NSWO authorization, TWAG control plane address) and sends the DEA message to the TWAN. The Result-Code AVP in the DEA message is set to DIAMETER\_MULTI\_ROUND\_AUTH. The TWAN-S2a-Connectivity Indicator is not set in the DEA-Flags AVP. +12. The TWAN forwards the EAP payload to the UE. +- 13-14. The UE responds with an EAP-RSP/AKA'-Notification message that the TWAN forwards to the 3GPP AAA Server. +- 15-16. The 3GPP AAA Server sends an EAP Success message that the TWAN forwards to the UE. The Result-Code AVP in the DEA message is set to DIAMETER\_SUCCESS. The DEA message also indicates to the TWAN the selected connected mode (MCM), the user's subscription information, whether the user is authorized for EPC and/or non-seamless WLAN offload, the WLCP key for WLCP signalling protection, and the user's Mobile Equipment Identity if it is available. + +Dependent on the authorizations received from the 3GPP AAA server, the UE may subsequently initiate the establishment of PDN connections to access the EPC and/or proceed with non-seamless WLAN offload. + +### A.3.2 Call flow with IMEI check in VPLMN + +Figure Annex A.3-x describes a roaming call flow for MCM, for EPC-routed access and/or Non-seamless WLAN offload, with IMEI check performed in the VPLMN. + +![Sequence diagram for TWAN Authentication and Authorization Procedure for MCM, with an IMEI check in the VPLMN. The diagram shows interactions between UE, TWAN, PGW, 3GPP AAA Proxy, 3GPP AAA, and HSS. The 3GPP AAA Proxy and 3GPP AAA are grouped under a 'Roaming' label. The sequence includes steps for 802.11 connection, EAP identity exchange, AKA' challenge, IMEI check request and response, and final authentication success.](83fd0d406cba6f9c189e77e05859a600_img.jpg) + +``` + +sequenceDiagram + participant UE + participant TWAN + participant PGW + participant 3GPP_AAA_Proxy as 3GPP AAA Proxy + participant 3GPP_AAA as 3GPP AAA + participant HSS + + Note right of 3GPP_AAA_Proxy: Roaming + Note left of 3GPP_AAA_Proxy: EIR check + + UE->>TWAN: 1. 802.11 Connection Established + TWAN->>UE: 2. EAP-REQ / Identity + UE->>TWAN: 3. EAP-RSP / Identity + TWAN->>3GPP_AAA_Proxy: 4. DER (EAP-RSP / Identity) + 3GPP_AAA_Proxy->>3GPP_AAA: 5. Authentication Vector Retrieval + 3GPP_AAA->>3GPP_AAA_Proxy: 6. DEA (EAP-REQ / AKA'-Challenge (mode=TSCM+SCM+MCM)) + 3GPP_AAA_Proxy->>TWAN: 7. EAP-REQ / AKA'-Challenge + TWAN->>UE: 8. EAP-RSP / AKA'-Challenge (mode=MCM, IMEISV) + TWAN->>3GPP_AAA_Proxy: 9. DER (EAP-RSP / AKA'-Challenge) + 3GPP_AAA_Proxy->>3GPP_AAA: 9A. DEA (IMEI-Check-Request-In-VPLMN, Terminal-Information) + 3GPP_AAA->>3GPP_AAA_Proxy: 9B. DER (IMEI-Check-Request-In-VPLMN, Terminal-Information) + Note right of 3GPP_AAA_Proxy: EIR check + 3GPP_AAA_Proxy->>3GPP_AAA: 9C. DER (IMEI-Check-In-VPLMN-Result) + 3GPP_AAA->>HSS: 10. Subscriber Profile Retrieval and Registration + 3GPP_AAA->>3GPP_AAA_Proxy: 11. DEA (AKA'-Notification) + 3GPP_AAA_Proxy->>TWAN: 12. EAP-REQ / AKA'-Notification + TWAN->>UE: 13. EAP-RSP / AKA'-Notification + TWAN->>3GPP_AAA_Proxy: 14. DER (EAP-RSP / AKA'-Notification) + 3GPP_AAA_Proxy->>3GPP_AAA: 15. DEA (EAP-Success, mode=MCM, subscription info, EPC/NSWO, IMEISV ...) + 3GPP_AAA->>TWAN: 16. EAP-Success + TWAN->>UE: 17. EAP-Success + +``` + +Sequence diagram for TWAN Authentication and Authorization Procedure for MCM, with an IMEI check in the VPLMN. The diagram shows interactions between UE, TWAN, PGW, 3GPP AAA Proxy, 3GPP AAA, and HSS. The 3GPP AAA Proxy and 3GPP AAA are grouped under a 'Roaming' label. The sequence includes steps for 802.11 connection, EAP identity exchange, AKA' challenge, IMEI check request and response, and final authentication success. + +**Figure Annex A.3-x: TWAN Authentication and Authorization Procedure for MCM, with an IMEI check in the VPLMN** + +1. to 3. Same as Figure A.3-1. + +4. If IMEI check is required by operator policy, the 3GPP AAA Proxy sets the IMEI-Check-Required-In-VPLMN bit in the DER-Flags AVP. + +5. to 9. Same as Figure A.3-1. + +9A. The 3GPP AAA Server requests the VPLMN to perform the IMEI check by setting the IMEI-Check-Request-In-VPLMN bit in the DEA-Flags AVP and including the Terminal-Information AVP in the DEA message. + +9B. The TWAN returns the IMEI-Check-Request-In-VPLMN flag in the DER-Flags AVP and the Terminal-Information AVP to the 3GPP AAA Proxy. + +9C. The 3GPP AAA Proxy performs the IMEI check in the VPLMN and forwards the DER to the 3GPP AAA Server, replacing the IMEI-Check-Request-In-VPLMN bit in the DER-Flags AVP by the IMEI-Check-In-VPLMN-Result AVP. + +10. to 16. Same as Figure A.3-1 if the IMEI check in VPLMN was successful. + +Otherwise the 3GPP AAA Server sends an EAP Failure message that the TWAN forwards to the UE. The Result-Code AVP in the DEA message is set to DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT. + +## A.4 Call Flow for TSCM and EPC-routed access + +Figure Annex A.4-1 describes a successful call flow for TSCM for EPC-routed access, i.e with S2a connectivity being granted to the UE. + +![Sequence diagram showing the TWAN Authentication and Authorization Procedure for TSCM – successful case. The diagram involves six lifelines: UE, TWAN, PGW, 3GPP AAA Proxy (within a Roaming domain), 3GPP AAA, and HSS. The process starts with an 802.11 connection establishment between UE and TWAN, followed by EAP-REQ/Identity and EAP-RSP/Identity messages. The TWAN then sends a DER (EAP-RSP / Identity) to the 3GPP AAA Proxy. The 3GPP AAA Proxy sends an Authentication Vector Retrieval to the HSS. The 3GPP AAA Proxy then sends a DEA (EAP-REQ / AKA'-Challenge) to the TWAN, which forwards it to the UE. The UE responds with an EAP-RSP / AKA'-Challenge, which the TWAN forwards to the 3GPP AAA Proxy. The 3GPP AAA Proxy sends a Subscriber Profile Retrieval and Registration to the HSS. The 3GPP AAA Proxy then sends a DEA (EAP-Success, subscription info, EPC/NSWO ...) to the TWAN, which forwards it to the UE. The TWAN sends a Create Session Request / PBU to the PGW. The PGW sends an Update PGW Address to the 3GPP AAA Proxy. The 3GPP AAA Proxy sends a Create Session Response / PBA to the TWAN, which forwards it to the UE. Finally, the UE sends an EAP-Success message to the TWAN.](54d030ecf3f147af8773b8a23549856e_img.jpg) + +``` + +sequenceDiagram + participant UE + participant TWAN + participant PGW + subgraph Roaming + participant 3GPP_AAA_Proxy as 3GPP AAA Proxy + end + participant 3GPP_AAA as 3GPP AAA + participant HSS + + Note left of UE: 1. 802.11 Connection Established + TWAN->>UE: 2. EAP-REQ / Identity + UE-->>TWAN: 3. EAP-RSP / Identity + TWAN->>3GPP_AAA_Proxy: 4. DER (EAP-RSP / Identity) + 3GPP_AAA_Proxy->>HSS: 5. Authentication Vector Retrieval + 3GPP_AAA_Proxy->>TWAN: 6. DEA (EAP-REQ / AKA'-Challenge (modes=TSCM+SCM+MCM)) + TWAN->>UE: 7. EAP-REQ / AKA'-Challenge + UE-->>TWAN: 8. EAP-RSP / AKA'-Challenge + TWAN->>3GPP_AAA_Proxy: 9. DER (EAP-RSP / AKA'-Challenge) + 3GPP_AAA_Proxy->>HSS: 10. Subscriber Profile Retrieval and Registration + 3GPP_AAA_Proxy->>TWAN: 11. DEA (EAP-Success, subscription info, EPC/NSWO ...) + TWAN->>UE: 12. EAP-Success + TWAN->>PGW: 13. Create Session Request / PBU + PGW->>3GPP_AAA_Proxy: 14. Update PGW Address + 3GPP_AAA_Proxy->>TWAN: 15. Create Session Response / PBA + TWAN->>UE: 16. EAP-Success + +``` + +Sequence diagram showing the TWAN Authentication and Authorization Procedure for TSCM – successful case. The diagram involves six lifelines: UE, TWAN, PGW, 3GPP AAA Proxy (within a Roaming domain), 3GPP AAA, and HSS. The process starts with an 802.11 connection establishment between UE and TWAN, followed by EAP-REQ/Identity and EAP-RSP/Identity messages. The TWAN then sends a DER (EAP-RSP / Identity) to the 3GPP AAA Proxy. The 3GPP AAA Proxy sends an Authentication Vector Retrieval to the HSS. The 3GPP AAA Proxy then sends a DEA (EAP-REQ / AKA'-Challenge) to the TWAN, which forwards it to the UE. The UE responds with an EAP-RSP / AKA'-Challenge, which the TWAN forwards to the 3GPP AAA Proxy. The 3GPP AAA Proxy sends a Subscriber Profile Retrieval and Registration to the HSS. The 3GPP AAA Proxy then sends a DEA (EAP-Success, subscription info, EPC/NSWO ...) to the TWAN, which forwards it to the UE. The TWAN sends a Create Session Request / PBU to the PGW. The PGW sends an Update PGW Address to the 3GPP AAA Proxy. The 3GPP AAA Proxy sends a Create Session Response / PBA to the TWAN, which forwards it to the UE. Finally, the UE sends an EAP-Success message to the TWAN. + +**Figure Annex A.4-1: TWAN Authentication and Authorization Procedure for TSCM – successful case** + +1. A connection is established between the UE and the TWAN, using a specific procedure based on IEEE 802.11 [40]. +2. The TWAN sends an EAP Request/Identity to the UE. +3. The UE sends an EAP Response/Identity message to the TWAN. +4. The TWAN forwards the EAP payload received from the UE to the 3GPP AAA Server and also indicates the supported TWAN connection modes in the DER message. The routing path may include one or several 3GPP AAA proxies for roaming case. +5. The 3GPP AAA Server retrieves authentication vectors for the UE from the HSS. +6. The 3GPP AAA Server sends an EAP Request/AKA'-Challenge in which it also indicates to the UE the TWAN connection modes supported by the network (e.g. TSCM, SCM and MCM). The Result-Code AVP in the DEA message is set to DIAMETER\_MULTI\_ROUND\_AUTH. The TWAN-S2a-Connectivity Indicator is not set in the DEA-Flags AVP. +7. The TWAN forwards the EAP payload to the UE. +8. The UE sends the EAP Response/AKA'-Challenge. In this example, the UE does not signal any requested connection mode in that message, which indicates a request for TSCM. +9. The TWAN forwards the EAP payload to the 3GPP AAA Server. + +10. If the 3GPP AAA Server successfully authenticates the UE, the 3GPP AAA Server downloads the user's subscription information from the HSS. +11. The 3GPP AAA Server sends an EAP Success message that the TWAN forwards to the UE in step 12 or 16. The Result-Code AVP in the DEA message is set to DIAMETER\_SUCCESS. The DEA message also contains the user's subscription information, whether the user is authorized for EPC and/or non-seamless WLAN offload. The 3GPP AAA Server does not signal any selected TWAN connection mode in the DEA message, which indicates to the TWAN that TSCM is selected. +12. The TWAN forwards the EAP Success message to the UE, when using layer 3 attach trigger. +13. The TWAN sends a Create Session Request/PBU message to the PDN GW to initiate the S2a tunnel establishment (assuming EPC access has been authorized). +14. The PDN GW informs the 3GPP AAA Server/HSS of its PDN GW identity and the APN corresponding to the UE's PDN Connection. +15. The PDN GW returns a Create Session Response/PBA message to the TWAN, including the IP address(es) allocated for the UE. +16. The TWAN forwards the EAP Success message to the UE, when using layer 2 attach trigger. + +--- + +## Annex B (normative): Diameter overload control mechanism + +### B.1 General + +IETF RFC 7683 [47] specifies a Diameter overload control mechanism which includes the definition and the transfer of related AVPs between Diameter nodes. + +Depending on regional/national requirements and network operator policy, priority traffic (e.g., MPS) shall be the last to be throttled and shall be exempted from throttling due to Diameter overload control up to the point where requested traffic reduction cannot be achieved without throttling the priority traffic. + +--- + +### B.2 SWx interface + +#### B.2.1 General + +The Diameter overload control mechanism is an optional feature over the SWx interface. + +It is recommended to make use of IETF RFC 7683 [47] on the SWx interface where, when applied, the 3GPP AAA server shall behave as a reacting node and the HSS as a reporting node. + +#### B.2.2 HSS behaviour + +The HSS requests traffic reduction from the 3GPP AAA server when it is in an overload situation, by including OC-OLR AVP in answer commands as described in IETF RFC 7683 [47]. + +The HSS identifies that it is in an overload situation by implementation specific means. For example, the HSS may take into account the traffic over the SWx interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources etc. + +The HSS determines the specific contents of the OC-OLR AVP in overload reports and the HSS decides when to send OC-OLR AVPs by implementation specific means. + +## B.2.3 3GPP AAA server behaviour + +The 3GPP AAA server applies required traffic reduction received in answer commands to subsequent applicable requests, as per IETF RFC 7683 [47]. + +Requested traffic reduction is achieved by the 3GPP AAA server by implementation specific means. For example, it may implement message throttling with prioritization. + +The 3GPP AAA server, when requested to apply traffic reduction over the SWx interface, may request traffic reduction over the interfaces (e.g STa, SWm, S6b) towards the access nodes if the Diameter overload control mechanism is supported on these interfaces. + +Annex C gives guidance on message prioritisation over the SWx interface. + +--- + +## B.3 STa interface + +### B.3.1 General + +The Diameter overload control mechanism is an optional feature over the STa interface. + +It is recommended to make use of the IETF RFC 7683 [47] over the STa interface where, when applied, the trusted non 3GPP access network shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### B.3.2 3GPP AAA server behaviour + +The 3GPP AAA server requests traffic reduction from the trusted non 3GPP access network when it is in an overload situation, by including OC-OLR AVP in answer commands as described in IETF RFC 7683 [47]. + +The 3GPP AAA server identifies that it is in an overload situation by implementation specific means. For example, the 3GPP AAA server may take into account the traffic over the STa interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources etc. + +The 3GPP AAA server determines the specific contents of the OC-OLR AVP in overload reports and the 3GPP AAA server decides when to send OC-OLR AVPs by implementation specific means. + +The 3GPP AAA server, when requested to apply traffic reduction over the SWx interface, may also request traffic reduction over the STa interfaces towards the trusted access networks nodes. + +### B.3.3 Trusted non 3GPP access network behaviour + +The trusted non 3GPP access network applies required traffic reduction received in answer commands to subsequent applicable requests, as per IETF RFC 7683 [47]. + +Requested traffic reduction is achieved by the trusted non 3GPP access network by implementation specific means. For example, it may implement message throttling with prioritization. + +Annex C gives guidance on message prioritisation over the STa interface. + +--- + +## B.4 S6b interface + +### B.4.1 General + +The Diameter overload control mechanism is an optional feature over the S6b interface. + +It is recommended to make use of the IETF RFC 7683 [47] over the S6b interface where, when applied, the PDN-GW shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +## B.4.2 3GPP AAA server behaviour + +The 3GPP AAA server requests traffic reduction from the PDN-GW when it is in an overload situation, by including OC-OLR AVP in answer commands, as described in IETF RFC 7683 [47]. + +The 3GPP AAA server identifies that it is in an overload situation by implementation specific means. For example, the 3GPP AAA server may take into account the traffic over the S6b interfaces and other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources etc. + +The 3GPP AAA server determines the specific contents of the OC-OLR AVP in overload reports and when the 3GPP AAA server decides when to send OC-OLR AVPs by implementation specific means. + +The 3GPP AAA server, when requested to apply traffic reduction over the SWx interface, may also request traffic reduction over the S6b interfaces towards the PDN-GWs. + +## B.4.3 PDN-GW behaviour + +The PDN-GW applies required traffic reduction received in answer commands to subsequent applicable requests, as per IETF RFC 7683 [47]. Requested traffic reduction is achieved by the PDN-GW by implementation specific means. For example, it may implement message throttling with prioritization. + +Annex C gives guidance on message prioritisation over the S6b interface. + +--- + +## B.5 SWa Interface + +### B.5.1 General + +The Diameter overload control mechanism is an optional feature over the SWa interface. + +It is recommended to make use of the IETF RFC 7683 [47] over the SWa interface where, when applied, the untrusted non-3GPP access network shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### B.5.2 3GPP AAA server behaviour + +The 3GPP AAA server behaviour is the same as described in clause B.3.2 for STa by replacing: + +- trusted non 3GPP access network by untrusted non 3GPP access network; +- STa by SWa. + +### B.5.3 untrusted non-3GPP access network behaviour + +The untrusted non-3GPP access network behaviour is the same as described in clause B.3.3 for STa by replacing: + +- trusted non 3GPP access network by untrusted non 3GPP access network; +- STa by SWa. + +Annex C gives guidance on message prioritisation over the SWa interface. + +--- + +## B.6 SWm Interface + +### B.6.1 General + +The Diameter overload control mechanism is an optional feature over the SWm interface. + +It is recommended to make use of the IETF RFC 7683 [47] over the SWm interface where, when applied, the ePDG shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### B.6.2 3GPP AAA server behaviour + +The 3GPP AAA server behaviour is the same as described in clause B.3.2 for STa by replacing + +- trusted non 3GPP access network by ePDG; +- STa by SWm. + +### B.6.3 ePDG behaviour + +The ePDG behaviour is the same as described in clause B.3.3 for STa by replacing: + +- trusted non 3GPP access network by ePDG; +- STa by SWm. + +Annex C gives guidance on message prioritisation over the SWm interface. + +--- + +## Annex C (Informative): Diameter overload control node behaviour + +### C.1 Introduction + +Annex C gives guidance on the Diameter overload control node behaviours regarding message prioritisation over non 3GPP access interfaces. + +--- + +## C.2 Message prioritization over SWx + +This clause gives an analysis of possible behaviours of the 3GPP AAA server regarding message prioritisation as guidance and for an informative purpose. + +When the HSS is overloaded, the 3GPP AAA server will receive overload reports from the HSS requesting a reduction of the requests sent by the 3GPP AAA server. This will apply to MAR and SAR requests. + +The 3GPP AAA server can consider some messages with a lower or a higher priority; lower priority messages will be candidates for throttling before higher priority messages. + +The 3GPP AAA server can take into account if it has already registered the user: + +- Diameter requests related to PDN connections for emergency services have the highest priority. Depending on regional/national requirements and network operator policy, these Diameter requests are the last to be throttled, when the 3GPP AAA Server has to apply traffic reduction; + +- if the user is not already registered in the 3GPP AAA server and the user is not establishing a PDN connection for emergency services, the 3GPP AAA server gives a lower priority to the MAR command to be sent to the HSS. This will correspond to the following cases: + - the user is not registered for non 3GPP access in the HSS and is doing an attach on a non 3GPP access; + - the user is not registered for non 3GPP access in the HSS and is doing an handover from a 3GPP access; if the MAR command is throttled, the PDN connection will be then maintained in the 3GPP access; + - the user is registered in the HSS but with another 3GPP AAA server, apart a restoration case (see further), this relates to a new session. There is nevertheless a limitation for an inter RAT mobility between non 3GPP accesses when such a MAR is throttled, this is considered as acceptable; + - after a not throttled and successful MAR, the subsequent requests (SARs) have a higher priority, otherwise it would mean that the initial MAR command processed by the (overloaded) HSS has been useless. An example is the call flow described in Annex C; + - if the user is registered in the 3GPP AAA server, the 3GPP AAA server gives a higher priority to the MAR or SAR commands to be sent to the HSS as to maintain the service to the user; nevertheless, if a SAR indicates a PGW\_UPDATE and is related to an additional Diameter session over S6b for the user, so to establish an additional PDN connection, a lower priority may be given to this SAR; +- in a restoration procedure due to the failure of the old 3GPP AAA server, the new 3GPP AAA server is informed of such a restoration procedure by the presence of the AAA-Failure-Indication AVP in the request received from the access. As restoration procedures may be a source of a high signalling traffic and contribute to a HSS overload, the new 3GPP AAA server may give a lower priority to such MAR messages; +- the deregistration of the user by the 3GPP AAA server has a higher priority as releasing resources in the HSS. + +--- + +## C.3 Message prioritisation over STa, SWm and SWa + +This clause gives an analysis of possible behaviours of the trusted non 3GPP access network over STa, of the untrusted non 3GPP access network over SWa and of the ePDG over SWm regarding message prioritisation as guidance and for an informative purpose. + +In the rest of the clause, a reacting node identifies: + +- a trusted non 3GPP access network over STa; +- an untrusted non 3GPP access network over SWa; +- an ePDG over SWm. + +As applying Diameter overload control over SWm and SWa may overlap, this is an operator policy to apply Diameter overload control either on SWm or on SWa or on both. + +When the 3GPP AAA server is overloaded, the reacting node will receive overload reports from the 3GPP AAA server requesting a reduction of requests sent by the reacting node. This will apply to DER, STR (and also AAR for STa and SWm) commands. + +The reacting node can consider some messages with a lower or a higher priority; lower priority messages will be candidates for throttling before higher priority messages. The reacting node can take into account the following considerations: + +- Diameter requests related to PDN connections for emergency services have the highest priority. Depending on regional/national requirements and network operator policy, these Diameter requests are the last to be throttled, when the reacting node has to apply traffic reduction; +- if the user has no existing context in the reacting node and the user is not establishing a PDN connection for emergency services, the reacting node gives a lower priority to authentication and authorisation procedures, so to DER commands. This avoids adding new users on the 3GPP AAA server. There is nevertheless a consequence in limiting an inter RAT mobility between non 3GPP accesses when such a DER is throttled, this is considered as acceptable; + +- if the initial request was not throttled, the subsequent requests have a higher priority, otherwise it would mean that the initial request processed by the (overloaded) 3GPP AAA server has been useless. An example is the call flow described in Annex A.2 for STa; +- If the user has an existing context in the reacting node, new requests have a higher priority so to maintain the service to the user; +- DER Requests (and also AAR for STa) resulting from the reception of a re-authentication re-authorisation procedure (or also re-authorisation procedure over STa) from the 3GPP AAA server have a higher priority, so to maintain the service to the user; +- The trusted non 3GPP access network has the possibility (see 5.1.2.3.1 clause), at any time, to send a AAR command for check if there is any modification in the user authorization parameters previously provided by the 3GPP AAA Server. The trusted non 3GPP access network may defer such AAR requests to diminish the traffic without impacting the service to the user; +- Session termination procedures initiated by the reacting node may have a higher priority as releasing resources in the 3GPP AAA server. + +--- + +## C.4 Message prioritization over S6b + +This clause gives an analysis of possible behaviours of the PDN-GW regarding message prioritisation as guidance and for an informative purpose. + +When the 3GPP AAA server is overloaded, the PDN-GW will receive overload reports from the 3GPP AAA server requesting a reduction of requests sent by the PDN-GW. This will apply to AAR and STR commands. + +The PDN-GW can consider some messages with a lower or a higher priority; lower priority messages will be candidates for throttling before higher priority messages. + +Following considerations can be taken into account: + +- An important point to consider is that UEs accessing the PDN-GW via S2a or S2b have already been previously authorized to use the non 3GPP access (i.e. via STa or SWm or SWa). The AAR command over S6b following this initial authorisation has a higher priority, otherwise, if the AAR is throttled, it would mean that the initial authorisation procedure (and its process by the 3GPP AAA server) has been useless; +- An exception is in the Multi Connection Mode (MCM) (described in 3GPP TS 23.402 [3]), where after a first PDN connection being established, the UE requests the establishment of additional PDN connections. As the priority, when overload in the 3GPP AAA server, is to maintain the existing service in preference to setting up new services for the user, such AAR commands over S6b may have a lower priority; +- Traffic reduction over the STa or SWm or SWa interfaces with the throttling of new authentication authorisation procedures, results in diminishing requests for new PDN connections to the PDN-GW and diminishing the traffic over S6b; +- regarding the 3GPP AAA Server behaviour, it is better to request traffic reduction over the STa or SWm or SWa interfaces than over the S6b interface, so following the principle to request the traffic reduction as early and as close as possible to the traffic source (i.e. the UE); +- AAR Requests resulting from the reception of a re-authorisation procedure from the 3GPP AAA server have a higher priority, so to maintain the service to the user; +- the session termination procedures over S6b initiated by the PDN-GW resulting from a UE request may have a higher priority as releasing resources in the 3GPP AAA server. + +--- + +## Annex D (normative): Diameter message priority mechanism + +### D.1 General + +IETF RFC 7944 [53] specifies a Diameter routing message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may leverage the relative priority of Diameter messages into routing, resource allocation, set the DSCP marking for transport of the associated Diameter message, and also abatement decisions when overload control is applied. + +--- + +### D.2 SWa, STa, SWd, SWm, SWx, S6b interfaces + +The Diameter message priority mechanism is an optional feature which may apply on one or several of the SWa, STa, SWd, SWm, SWx, S6b interfaces. + +It is recommended to make use of IETF RFC 7944 [53] over the SWa, STa, SWd, SWm, SWx, S6b interfaces of an operator network when the overload control defined in Annex C is applied on these interfaces. + +A 3GPP functional entity supporting the Diameter message priority mechanism over an interface listed above shall comply with IETF RFC 7944 [53]. + +A 3GPP functional entity sending a request shall determine the required priority according to its policies. When priority is required, it shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the request according to the required priority level. + +When the 3GPP functional element receives the corresponding response, it shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When a 3GPP functional entity receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, it may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, it shall include the DRMP AVP in the response. + +If: + +- a 3GPP functional entity supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the 3GPP functional entity shall set the DSCP marking for transport of the request or response according to the required priority level. + +Diameter requests related to high priority traffic (e.g. MPS, emergency) shall contain a DRMP AVP with a high priority of which the level value is operator dependent. + +When not-explicitly requested, the inclusion and priority value of the DRMP AVP in Diameter messages are implementation specific. + +# Annex E (informative): Untrusted WLAN authentication and authorization procedure + +## E.1 General + +This clause provides example call flows for the Untrusted WLAN authentication and authorization procedure. + +This Annex is informative and the normative descriptions in this specification and in 3GPP TS 33.402 [19] prevail over the descriptions in this Annex if there is any difference. + +See clause 8.2.2 of 3GPP TS 33.402 [19] for details on the IKEv2 and EAP-AKA procedures. This clause focuses on the SWm, S6b and SWx signalling interactions. + +## E.2 Successful call flow + +Figure Annex E.2-1 describes a successful Untrusted WLAN authentication and authorization call flow. + +![Sequence diagram showing the successful Untrusted WLAN authentication and authorization procedure. Lifelines: UE, ePDG, PGW, Roaming (3GPP AAA Proxy), 3GPP AAA, HSS. The process involves IKEv2 negotiation, EAP-AKA authentication, and session creation.](05c032edd038c8ac33e4cec9d7e9f1be_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ePDG + participant PGW + participant Roaming + participant 3GPP_AAA as 3GPP AAA + participant HSS + + Note right of Roaming: Roaming + UE->>ePDG: 1. IKE SA_INIT + ePDG->>UE: 2. IKE_AUTH_Request (User ID, APN, Configuration Payload) + ePDG->>3GPP_AAA: 3. DER (EAP-RSP / Identity, User Identity, APN) + 3GPP_AAA->>HSS: 4. Authentication Vector Retrieval + HSS->>3GPP_AAA: 5. DEA (EAP-REQ / AKA-Challenge) + 3GPP_AAA->>ePDG: 6. IKE_AUTH_Response (EAP-REQ / AKA-Challenge) + ePDG->>UE: 7. IKE_AUTH_Request (EAP-RSP / AKA-Challenge, IMEISV) + ePDG->>3GPP_AAA: 8. DER (EAP-RSP / AKA-Challenge, Terminal-Information) + 3GPP_AAA->>HSS: 9. DEA (EAP-REQ/AKA-Notification) + HSS-->>3GPP_AAA: 9. IKE_AUTH_Response (EAP-REQ / AKA-Notification) + 3GPP_AAA->>ePDG: 9. IKE_AUTH_Request (EAP-RSP / AKA-Notification) + ePDG->>UE: 9. IKE_AUTH_Response (EAP-RSP / AKA-Notification) + ePDG->>3GPP_AAA: 9. DER (EAP-RSP/AKA-Notification) + 3GPP_AAA->>HSS: 10. Subscriber Profile Retrieval and Registration + HSS->>3GPP_AAA: 11. DEA (EAP-Success, subscription info, MSK, Permanent User Identity) + 3GPP_AAA->>ePDG: 12. IKE_AUTH_Response (EAP-Success) + ePDG->>UE: 13. IKE_AUTH_Request (AUTH) + UE->>ePDG: 14. Create Session Request / PBU + ePDG->>PGW: 15. Update PGW Address + PGW->>HSS: 16. Create Session Response / PBA + HSS->>PGW: 17. IKE_AUTH_Response (AUTH) + PGW->>ePDG: 17. IKE_AUTH_Response (AUTH) + +``` + +Sequence diagram showing the successful Untrusted WLAN authentication and authorization procedure. Lifelines: UE, ePDG, PGW, Roaming (3GPP AAA Proxy), 3GPP AAA, HSS. The process involves IKEv2 negotiation, EAP-AKA authentication, and session creation. + +Figure Annex E.2-1: Untrusted WLAN Authentication and Authorization Procedure – successful case + +3. The ePDG sends the EAP-RSP/Identity payload to the 3GPP AAA Server and also indicates the user identity and requested APN, if received from the UE. +4. The 3GPP AAA Server retrieves authentication vectors for the UE from the HSS. +5. The 3GPP AAA Server sends an EAP Request/AKA-Challenge. +6. The ePDG forwards the EAP payload to the UE and also requests the UE to provide its Mobile Equipment Identity if required. +8. The ePDG forwards the EAP payload to the 3GPP AAA Server. The user's Mobile Equipment Identity is also included, if available. +9. If dynamic IP mobility selection is executed, the selected mobility mode is sent to the UE in an AKA-Notification request. +10. If the 3GPP AAA Server successfully authenticates the UE, the 3GPP AAA Server downloads the user's subscription information from the HSS. +11. If the 3GPP AAA Server authorizes the access for the UE, the 3GPP AAA Server sends an EAP Success message that the ePDG forwards to the UE. The Result-Code AVP in the DEA message is set to DIAMETER\_SUCCESS. The subscription information, keying material and permanent user identity are also provided to the ePDG. +14. The ePDG sends a Create Session Request/PBU message to the PDN GW to initiate the S2b tunnel establishment. +15. The PDN GW informs the 3GPP AAA Server/HSS of its PDN GW identity and the APN corresponding to the UE's PDN Connection. +16. The PDN GW returns a Create Session Response/PBA message to the ePDG, including the IP address(es) allocated for the UE. +17. The IKEv2 negotiation completes. The ePDG provides the UE IP address to the UE. + +--- + +## E.3 Call flow with IMEI check in VPLMN + +Figure Annex E.3-1 describes a roaming call flow, with IMEI check performed in the VPLMN. + +![Sequence diagram for Untrusted WLAN Authentication and Authorization Procedure, with IMEI check performed in the VPLMN. The diagram shows interactions between UE, ePDG, PGW, 3GPP AAA Proxy (in Roaming), 3GPP AAA, and HSS. The process involves IKE SA_INIT, IKE_AUTH_Request/Response, DER (EAP-RSP), DEA (EAP-REQ), EIR check, and Create Session Request/Response. The 3GPP AAA Proxy performs an IMEI check (EIR check) before forwarding the DER to the 3GPP AAA.](74340c36eadb11d858e925d7b77260bf_img.jpg) + +``` + +sequenceDiagram + participant UE + participant ePDG + participant PGW + participant 3GPP_AAA_Proxy as 3GPP AAA Proxy (Roaming) + participant 3GPP_AAA as 3GPP AAA + participant HSS + + Note right of 3GPP_AAA_Proxy: Roaming + + UE->>ePDG: 1. IKE SA_INIT + ePDG-->>UE: 2. IKE_AUTH_Request (User ID, APN, Configuration Payload) + ePDG->>3GPP_AAA_Proxy: 3. DER (EAP-RSP / Identity, User Identity, APN) + 3GPP_AAA_Proxy->>3GPP_AAA: 4. Authentication Vector Retrieval + 3GPP_AAA-->>3GPP_AAA_Proxy: 5. DEA (EAP-REQ / AKA-Challenge) + 3GPP_AAA_Proxy-->>ePDG: 6. IKE_AUTH_Response (EAP-REQ / AKA-Challenge) + UE->>ePDG: 7. IKE_AUTH_Request (EAP-RSP / AKA-Challenge, IMEISV) + ePDG->>3GPP_AAA_Proxy: 8. DER (EAP-RSP / AKA-Challenge, Terminal-Information) + Note right of 3GPP_AAA_Proxy: EIR check + 3GPP_AAA_Proxy->>3GPP_AAA: 8'. DER (EAP-RSP / AKA-Challenge, Terminal-Information) + 3GPP_AAA-->>3GPP_AAA_Proxy: 9. DEA (EAP-REQ/AKA-Notification) + 3GPP_AAA_Proxy-->>UE: 9. IKE_AUTH_Response (EAP-REQ / AKA-Notification) + UE-->>ePDG: 9. IKE_AUTH_Request (EAP-RSP / AKA-Notification) + ePDG-->>3GPP_AAA_Proxy: 9. DER (EAP-RSP/AKA-Notification) + 3GPP_AAA_Proxy->>3GPP_AAA: 10. Subscriber Profile Retrieval and Registration + 3GPP_AAA-->>HSS: 11. DEA (EAP-Success, subscription info, MSK, Permanent User Identity) + 3GPP_AAA_Proxy-->>ePDG: 12. IKE_AUTH_Response (EAP-Success) + UE->>ePDG: 13. IKE_AUTH_Request (AUTH) + ePDG->>PGW: 14. Create Session Request / PBU + PGW->>3GPP_AAA: 15. Update PGW Address + 3GPP_AAA-->>PGW: 16. Create Session Response / PBA + PGW-->>UE: 17. IKE_AUTH_Response (AUTH) + +``` + +Sequence diagram for Untrusted WLAN Authentication and Authorization Procedure, with IMEI check performed in the VPLMN. The diagram shows interactions between UE, ePDG, PGW, 3GPP AAA Proxy (in Roaming), 3GPP AAA, and HSS. The process involves IKE SA\_INIT, IKE\_AUTH\_Request/Response, DER (EAP-RSP), DEA (EAP-REQ), EIR check, and Create Session Request/Response. The 3GPP AAA Proxy performs an IMEI check (EIR check) before forwarding the DER to the 3GPP AAA. + +**Figure Annex E.3-1: Untrusted WLAN Authentication and Authorization Procedure, with IMEI check performed in the VPLMN** + +1. to 5. Same as Figure E.2-1. + +6. If IMEI check is required by operator policy, the ePDG requests the UE to provide its Mobile Equipment Identity. + +7. Same as Figure E.2-1. + +8. The ePDG includes the Terminal-Information AVP in the DER command. If IMEI check is required by operator policy, the 3GPP AAA Proxy performs the IMEI check in the VPLMN. If the IMEI check allows to continue the authentication and authorization procedure, the 3GPP AAA Proxy forwards the DER to the 3GPP AAA Server (as shown in this figure). Otherwise the 3GPP AAA Proxy responds to the ePDG with the Experimental-Result-Code DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT and sends a SWm Session Termination Request towards the 3GPP AAA Server. + +9 to 17. Same as Figure E.2-1 if the IMEI check in VPLMN was successful. + +--- + +## Annex F (normative): Diameter load control mechanism + +### F.1 General + +IETF RFC 8583 [54] specifies a Diameter overload control mechanism which includes the definition and the transfer of related AVPs between Diameter nodes. + +--- + +### F.2 SWx interface + +#### F.2.1 General + +The Diameter load control mechanism is an optional feature over the SWx interface. + +It is recommended to make use of IETF RFC 8583 [54] on the SWx interface where, when applied, the 3GPP AAA server shall behave as a reacting node and the HSS as a reporting node. + +#### F.2.2 HSS behaviour + +The HSS may report its current load by including a Load AVP of type HOST in answer commands as described in IETF RFC 8583 [54]. + +The HSS calculates its current load by implementation specific means. For example, the HSS may take into account the traffic over the SWx interface or other interfaces, the level of usage of internal resources (e.g. CPU, memory), the access to external resources, etc. + +The HSS determines when to send Load AVPs of type HOST by implementation specific means. + +#### F.2.3 3GPP AAA server behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the 3GPP AAA server may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [54]. + +--- + +### F.3 STa interface + +#### F.3.1 General + +The Diameter load control mechanism is an optional feature over the STa interface. + +It is recommended to make use of the IETF RFC 8583 [54] over the STa interface where, when applied, the trusted non 3GPP access network shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +#### F.3.2 3GPP AAA server behaviour + +The 3GPP AAA server may report its current load by including a Load AVP of type HOST in answer commands as described in IETF RFC 8583 [54]. + +The 3GPP AAA server calculates its current load by implementation specific means. For example, the 3GPP AAA server may take into account the traffic over the STa interface or other interfaces, the level of usage of internal resources (e.g. CPU, memory), the access to external resources, etc. + +The 3GPP AAA server determines when to send Load AVPs of type HOST by implementation specific means. + +### F.3.3 Trusted non 3GPP access network behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the Trusted non 3GPP access network may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [54]. + +--- + +## F.4 S6b interface + +### F.4.1 General + +The Diameter load control mechanism is an optional feature over the S6b interface. + +It is recommended to make use of the IETF RFC 8583 [54] over the S6b interface where, when applied, the PDN-GW shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### F.4.2 3GPP AAA server behaviour + +The 3GPP AAA server may report its current load by including a Load AVP of type HOST in answer commands as described in IETF RFC 8583 [54]. + +The 3GPP AAA server calculates its current load by implementation specific means. For example, the 3GPP AAA server may take into account the traffic over the S6b interface or other interfaces, the level of usage of internal resources (e.g. CPU, memory), the access to external resources, etc. + +The 3GPP AAA server determines when to send Load AVPs of type HOST by implementation specific means. + +### F.4.3 PDN-GW behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the PDN-GW may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [54]. + +--- + +## F.5 SWa Interface + +### F.5.1 General + +The Diameter load control mechanism is an optional feature over the SWa interface. + +It is recommended to make use of the IETF RFC 8583 [54] over the SWa interface where, when applied, the untrusted non-3GPP access network shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### F.5.2 3GPP AAA server behaviour + +The 3GPP AAA server behaviour is the same as described in clause F.3.2 for STa by replacing: + +- trusted non 3GPP access network by untrusted non 3GPP access network; + +- STa by SWa. + +## F.5.3 untrusted non-3GPP access network behaviour + +The untrusted non-3GPP access network behaviour is the same as described in clause F.3.3 for STa by replacing: + +- trusted non 3GPP access network by untrusted non 3GPP access network; +- STa by SWa. + +## F.6 SWm Interface + +### F.6.1 General + +The Diameter load control mechanism is an optional feature over the SWm interface. + +It is recommended to make use of the IETF RFC 8583 [54] over the SWm interface where, when applied, the ePDG shall behave as a reacting node and the 3GPP AAA server as a reporting node. + +### F.6.2 3GPP AAA server behaviour + +The 3GPP AAA server behaviour is the same as described in clause F.3.2 for STa by replacing + +- trusted non 3GPP access network by ePDG; +- STa by SWm. + +### F.6.3 ePDG behaviour + +The ePDG behaviour is the same as described in clause F.3.3 for STa by replacing: + +- trusted non 3GPP access network by ePDG; +- STa by SWm. + +## Annex G (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Re
v | Ca
t | Subject/Comment | New | +|---------|-------|-----------|------|---------|---------|--------------------------------------------------------------|-------| +| 2008-12 | CT#42 | CP-080717 | | | | V2.0.0 approved in CT#42 | 8.0.0 | +| 2009-03 | CT#43 | CP-090051 | 0002 | 2 | | Clarification on QoS Resource on S6b | 8.1.0 | +| | | CP-090051 | 0003 | 1 | | Context Identifier for Update or Removal of PDN GW | | +| | | CP-090051 | 0007 | - | | Clarification on the S6b Authorization Procedure for DSMIPv6 | | +| | | CP-090051 | 0009 | - | | Clarification on DHCPv6/IKEv2 based HA discovery | | +| | | CP-090051 | 0010 | 1 | | Clarification on AAA server authentication/authorization | | +| | | CP-090051 | 0011 | 1 | | Difference of S6b and H2 | | +| | | CP-090051 | 0013 | 1 | | STR on HSS/AAA initiated detach over STa | | +| | | CP-090051 | 0014 | 1 | | STR on 3GPP AAA Server initiated detach over SWm | | +| | | CP-090051 | 0015 | 1 | | STR on 3GPP AAA Server initiated detach over S6b | | +| | | CP-090051 | 0016 | 1 | | Multiple 3GPP AAA identities | | +| | | CP-090051 | 0019 | 1 | | User-Name AVP contains only the IMSI | | +| | | CP-090051 | 0020 | - | | Removal of APN-Barring-Type Reference | | +| | | CP-090051 | 0021 | 1 | | Charging AVPs | | +| | | CP-090051 | 0022 | 1 | | MIP6-Agent-Info Definition and Usage | | +| | | CP-090051 | 0023 | 1 | | REAUTHENTICATION_FAILURE Correction | | +| | | CP-090051 | 0025 | 1 | | Definition of Server-Assignment-Type values | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|----------------------------------------------------------------------------|-------| +| | | CP-090051 | 0026 | - | | Multiple Occurrences of SIP-Auth-Data-Item AVP | | +| | | CP-090051 | 0028 | 1 | | Using MIP6-Agent-Info for SGW address | | +| | | CP-090051 | 0029 | 1 | | MIP6-Agent-Info corrections | | +| | | CP-090051 | 0030 | 1 | | Trace activation in PDN GW over the SWx and S6b interfaces | | +| | | CP-090051 | 0031 | 1 | | Signalling VPLMN Trust of non-3GPP AN | | +| | | CP-090051 | 0033 | - | | Corrections in Visited Network Identifier definitions | | +| | | CP-090051 | 0034 | 2 | | Service Authorization Information update on S6b when using DSMIP | | +| | | CP-090051 | 0035 | 4 | | STa/SWa clarifications | | +| | | CP-090051 | 0036 | 1 | | IP address authorization corrections | | +| | | CP-090051 | 0037 | 2 | | SWm Authentication Correction | | +| | | CP-090051 | 0039 | 1 | | SWm corrections - others | | +| | | CP-090051 | 0040 | 3 | | SWm Service Authorization Information Update corrections | | +| | | CP-090051 | 0041 | 5 | | Combined Authentication and authorization procedure on SWm | | +| | | CP-090051 | 0042 | 2 | | S6b related corrections | | +| | | CP-090051 | 0044 | 2 | | Corrections to S6b/HA clause 9 | | +| | | CP-090039 | 0045 | 3 | | User to HSS resolution | | +| | | CP-090051 | 0080 | 1 | | Corrections to STR procedures for AAA_UNKNOWN_SESSION_ID | | +| | | CP-090051 | 0081 | 1 | | Corrections to S6b STR procedures | | +| | | CP-090236 | 0082 | 1 | | PDN GW update for Wildcard APN | | +| | | CP-090051 | 0083 | - | | RFC 5447 References | | +| 2009-06 | CT#44 | CP-090289 | 0084 | 1 | | Use of Access-Restriction-Data AVP | 8.2.0 | +| | | CP-090289 | 0085 | - | | Difference between S6b and H2 | | +| | | CP-090289 | 0086 | 1 | | Corrections to 29.273 | | +| | | CP-090289 | 0087 | 1 | | Inclusion of static IP address | | +| | | CP-090289 | 0088 | 1 | | Home Agent discovery | | +| | | CP-090289 | 0090 | - | | Incorrect command for user profile updates | | +| | | CP-090289 | 0092 | 1 | | Home Agent discovery | | +| | | CP-090289 | 0093 | 1 | | Formatting of APN in Service-Selection AVP | | +| | | CP-090289 | 0094 | - | | Update of AVP Codes | | +| | | CP-090289 | 0096 | 1 | | STa/SWa separation correction | | +| | | CP-090289 | 0097 | - | | SWa corrections | | +| | | CP-090289 | 0098 | 1 | | STa re-authorization and re-authentication | | +| | | CP-090289 | 0101 | 2 | | SWa re-authentication | | +| | | CP-090289 | 0102 | 1 | | Adding APN-OI-Replacement | | +| | | CP-090289 | 0103 | 2 | | HA reallocation clarification | | +| 2009-09 | CT#45 | CP-090537 | 0105 | 2 | | Correction on APN-OI-Replacement | 8.3.0 | +| | | CP-090537 | 0106 | - | | Correction on the Description of Mobility Features over S6b | | +| | | CP-090537 | 0111 | - | | EAP-AKA' IETF RFC Reference | | +| | | CP-090537 | 0112 | - | | Removal of Remaining Editor Notes | | +| | | CP-090537 | 0113 | 1 | | MIP6_SPLIT flag removal | | +| | | CP-090537 | 0108 | 3 | | Support of optimized idle mode mobility | | +| | | CP-090537 | 0115 | - | | E-UTRAN - eHRPD Connectivity and Interworking Reference | | +| | | CP-090537 | 0116 | 2 | | Detailed behaviour in error cases | | +| | | CP-090537 | 0118 | 1 | | Application IDs | | +| | | CP-090537 | 0119 | - | | Service-Selection AVP Code | | +| | | CP-090537 | 0120 | - | | PDN-Type AVP | | +| | | CP-090537 | 0121 | 1 | | Clarifications on PGW Handling on S6b/H2 | | +| 2009-09 | CT#45 | CP-090562 | 0117 | 1 | | Emergency Support in AAA interfaces | 9.0.0 | +| 2009-12 | CT#46 | CP-090793 | 0122 | 2 | | APN level APN-OI-Replacement | | +| | | CP-090774 | 0126 | 3 | | Correction of Allowed PDN Types | 9.1.0 | +| | | CP-090774 | 0128 | 2 | | Incorrect HSS behaviour on deregistration | | +| | | CP-090774 | 0130 | 2 | | MIP6 Agent Info | | +| | | CP-090774 | 0132 | - | | Nonce | | +| | | CP-090774 | 0136 | - | | 3GPP AAA Server detailed behaviour at HSS Initiated Update of User Profile | | +| | | CP-090774 | 0140 | 2 | | Static PDN GW | | +| | | CP-090787 | 0141 | - | | Removal of Definition of APN-Configuration | | +| | | CP-090774 | 0143 | 1 | | PGW deregistration via S6b | | +| | | CP-090774 | 0145 | 1 | | Add Supported-Features AVP to STa/SWa | | +| | | CP-090774 | 0147 | - | | Add Supported-Features AVP to SWm | | +| | | CP-090774 | 0149 | - | | Add Supported-Features AVP to SWx | | +| | | CP-090774 | 0151 | - | | Add Supported-Features AVP to S6b | | +| | | CP-090774 | 0153 | 1 | | Correction of Application ID | | +| | | CP-090774 | 0155 | 1 | | Error Handling | | +| | | CP-090774 | 0157 | - | | HSS/AAA-Initiated Disconnection | | +| 2010-03 | CT#47 | CP-10024 | 0163 | 1 | | Correction in Subscription-ID | 9.2.0 | +| | | CP-10024 | 0165 | - | | NAI decoration and realm-based routing clarifications | | +| | | CP-10024 | 0167 | - | | IETF References update | | +| | | CP-10024 | 0169 | - | | Permanent User Identity | | +| | | CP-10024 | 0171 | 1 | | Static PDN GW | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|---------------------------------------------------------------------------|--------| +| | | CP-10024 | 0173 | - | | QoS AVP Codes | | +| | | CP-10024 | 0175 | - | | Indication of PLMN ID of the selected PGW | | +| | | CP-10044 | 0176 | - | | Context-Identifier in Registration Request | | +| 2010-06 | CT#48 | CP-100290 | 0179 | 1 | | Corrections on Session Termination between the PGW and the AAA | 9.3.0 | +| | | CP-100277 | 0180 | - | | Corrections to implementation of CR 128 and CR 175 | | +| | | CP-100277 | 0181 | - | | PGW Identity upon successful authorization on SWm | | +| 2010-06 | CT#48 | CP-100443 | 0184 | - | | Ambiguity of Presence Conditions of IEs and AVP ABNF | 9.4.0 | +| | | CP-100457 | 0188 | - | | IETF References | | +| | | CP-100457 | 0189 | 1 | | SWm missing AVPs | | +| 2010-09 | CT#49 | CP-100603 | 0187 | 1 | | Removal of Invalid Reference | 10.0.0 | +| 2010-12 | CT#50 | CP-100679 | 0197 | 1 | | Correcting PDN GW behaviour for S6b | 10.1.0 | +| | | CP-100698 | 0194 | 1 | | Update APN and PDN GW in the 3GPP AAA Server on SWx | | +| | | CP-100698 | 0195 | 1 | | Update APN and PDN GW in Non-3GPP IP Access over the STa & SWm interfaces | | +| | | CP-100686 | 0196 | 3 | | SWm and S6b procedures for GTP based S2b | | +| | | CP-100707 | 0200 | - | | MIP6 Feature Vector flags assignment | | +| | | CP-100707 | 0203 | - | | SWx AVP Bits Definition | | +| | | CP-100707 | 0206 | - | | Visited-Network-Identifier Data Type | | +| 2011-03 | CT#51 | CP-110051 | 0210 | 1 | | Usage of Auth-Request-Type in response messages | 10.2.0 | +| | | CP-110073 | 0208 | 2 | | Correction on PGW PLMN ID | | +| 2011-06 | CT#52 | CP-110359 | 0214 | 1 | | Trace-Depth-List correction | 10.3.0 | +| | | CP-110359 | 0217 | 1 | | MIPv4 security parameters on the STa and S6b interfaces | | +| | | CP-110359 | 0221 | 1 | | PGW Update | | +| | | CP-110359 | 0223 | 1 | | APN Configuration for SWx | | +| | | CP-110360 | 0219 | - | | Authentication Timeout | | +| 2011-12 | CT#54 | CP-110778 | 0227 | 1 | | S6b session handling after handover to 3GPP access | 10.4.0 | +| | | CP-110778 | 0235 | 1 | | Incorrect access name on SWa | | +| | | CP-110793 | 0228 | 5 | | Correction on Trust Relationship Indication | | +| | | CP-110793 | 0238 | - | | Implementation Error of CR 196 R3 | | +| 2011-12 | CT#54 | CP-110812 | 0225 | 4 | | SWx Restoration | 11.0.0 | +| 2012-03 | CT#55 | CP-120016 | 0257 | 1 | | Wrong Command Code in STa AA-Answer | 11.1.0 | +| | | CP-120020 | 0251 | 2 | | Authorize the requested home address types | | +| | | CP-120020 | 0260 | - | | Content of Service-Selection AVP | | +| | | CP-120040 | 0245 | 1 | | Wildcard APN in the user subscription | | +| | | CP-120040 | 0253 | - | | Permanent User Identity in SWm Authentication and Authorization Answer | | +| | | CP-120040 | 0255 | - | | Encoding of Visited-Network-Identifier AVP | | +| | | CP-120040 | 0256 | - | | Re-Authorization Errors | | +| | | CP-120042 | 0254 | 1 | | Permanent User Identity at SWa | | +| | | CP-120044 | 0240 | 1 | | PDN GW reallocation based on UE's location | | +| 2012-06 | CT#56 | CP-120225 | 0243 | 3 | | Trust Relationship Indication | 11.2.0 | +| | | CP-120238 | 0264 | - | | S6b procedures for GTP based S2a | | +| | | CP-120247 | 0265 | 2 | | Missing IE in TS 29.273 | | +| | | CP-120247 | 0266 | - | | Emergency scenario for STa interface | | +| | | CP-120247 | 0267 | 2 | | Visited Network Identifier | | +| | | CP-120247 | 0278 | 1 | | Network Name | | +| | | CP-120238 | 0268 | 6 | | STa & SWd procedures for GTP S2a & Trusted WLAN access | | +| | | CP-120238 | 0269 | 1 | | Default APN for 'Trusted WLAN access' | | +| | | CP-120238 | 0270 | 3 | | Informing Serving SSID to the AAA Server | | +| | | CP-120238 | 0271 | 1 | | Avoiding registration of PDN-GW identity for TWAN | | +| | | CP-120238 | 0275 | 1 | | Clarifications on TWAN behaviour | | +| | | CP-120237 | 0273 | 2 | | PDN GW selection for S2c during tunnel establishment | | +| 2012-09 | CT#57 | CP-120441 | 0285 | - | | Update of IETF draft status to RFC | 11.3.0 | +| | | CP-120447 | 0287 | 2 | | PGW selection in eHRPD for SIPTO | | +| | | CP-120461 | 0272 | 3 | | Recovering from AAA Server failure | | +| | | CP-120474 | 0279 | 1 | | Transport Access Type AVP for BBAI | | +| | | CP-120477 | 0280 | 1 | | NSWO-Capability & NSWO-Authorization AVPs | | +| | | CP-120477 | 0281 | - | | Access Type for TWAN access | | +| | | CP-120656 | 0292 | 1 | | Reference list correction to align with the corrected TS 29.212 title | | +| 2012-12 | CT#58 | CP-120711 | 0307 | 1 | | Removal of AVP Encryption | 11.4.0 | +| | | CP-120733 | 0293 | - | | Repeat information for Trusted non-3GPP access network | | +| | | CP-120733 | 0300 | 5 | | Matching WLAN-ID between Selected WLAN ID and TWAN Access Info | | +| | | CP-120733 | 0301 | 1 | | Update of draft-ietf-radext-ieee802ext reference | | +| | | CP-120747 | 0294 | - | | Correction on Auth-Request-Type | | +| | | CP-120747 | 0295 | - | | Description of Result IE | | +| | | CP-120728 | 0297 | 2 | | Information Elements for SWa interface | | +| | | CP-120728 | 0299 | 1 | | Session ID in the SWm Authorization procedure | | +| | | CP-120750 | 0302 | 1 | | Trace Info for PGW | | +| | | CP-120750 | 0303 | 1 | | Add the definition of trace-reference | | +| | | CP-120741 | 0309 | 2 | | Use of Flag instead of Enumerated AVPs | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|-------------------------------------------------------------------------------------------------------------|--------| +| 2013-03 | CT#59 | CP-130022 | 0314 | 2 | | About EAP-AKA' challenge message | 11.5.0 | +| | | CP-130022 | 0315 | 1 | | TWAN Authorization when HE-SSID is not provided | | +| | | CP-130022 | 0317 | - | | Missing P-Bit settings in Information Element tables | | +| | | CP-130022 | 0316 | - | | Presence condition of PGW-ID AVP in S6b AAR command | | +| 2013-06 | CT#60 | CP-130288 | 0313 | 3 | | New DER-S6b-flags on S6b interface | 11.6.0 | +| | | CP-130288 | 0325 | 1 | | MIP4 supported flag | | +| | | CP-130288 | 0323 | 1 | | 3GPP AAA Proxy behavior | | +| | | CP-130288 | 0321 | 1 | | Definition of HA-APN | | +| | | CP-130288 | 0320 | 2 | | Trust relationship for PGW | | +| | | CP-130293 | 0318 | 2 | | UE local IP address for SWm or S6b | | +| 2013-06 | CT#60 | CP-130381 | 0326 | 1 | | EAP-AKA clarification | 12.0.0 | +| | | CP-130381 | 0319 | 2 | | Clarification for Routing Policies | | +| 2013-09 | CT#61 | CP-130459 | 0333 | 1 | | Category of Authentication Data Information Element in SWx/MAR command | 12.1.0 | +| | | CP-130472 | 0329 | 2 | | Add 3GPP AAA Proxy detailed Behaviour on SWa | | +| | | CP-130472 | 0331 | 1 | | Correction on IP Mobility Mode Selection function | | +| | | CP-130461 | 0327 | 2 | | Clarification on provision of HA information for DHCP-based HA discovery on STa | | +| | | CP-130461 | 0332 | - | | Applicability of IP Filters and Routing Policies functionality on EPC | | +| 2013-12 | CT#62 | CP-130602 | 0351 | - | | EAP Payload | 12.2.0 | +| | | CP-130640 | 0338 | - | | Clarification on Trust Relationship Indicator | | +| | | CP-130640 | 0339 | 1 | | MIP6-Agent-Info over the S6b interface | | +| | | CP-130640 | 0346 | - | | Clarification of M-bit handling | | +| | | CP-130640 | 0354 | 1 | | Reflective QoS for BBF convergence | | +| | | CP-130606 | 0341 | - | | IMSI for BBF in trusted S2c case | | +| | | CP-130616 | 0343 | 4 | | NSWO via the trusted WLAN | | +| | | CP-130616 | 0345 | 1 | | VPLMN trust relationship indicator | | +| | | CP-130616 | 0356 | 1 | | EPC Access Authorization | | +| | | CP-130633 | 0353 | 1 | | PGW update on SWx | | +| 2014-03 | CT#63 | CP-140023 | 0366 | 1 | | Replacement of IETF WLAN AVPs | 12.3.0 | +| | | CP-140033 | 0361 | - | | Incorrect Diameter commands | | +| | | CP-140033 | 0363 | 1 | | Condition for sending APN Information | | +| | | CP-140030 | 0364 | 1 | | Retrieval of Network Provided Location Information via HSS | | +| | | CP-140033 | 0367 | - | | RAT Type correction | | +| 2014-06 | CT#64 | CP-140247 | 0368 | - | | STa Authentication for Trusted WLAN access | 12.4.0 | +| | | CP-140253 | 0369 | 4 | | IMSI for BBF convergence | | +| | | CP-140253 | 0370 | 1 | | Reflective QoS in BBF architecture | | +| | | CP-140252 | 0373 | 2 | | Civic Address Encoding | | +| | | CP-140252 | 0377 | - | | TWAN-BSSID AVP re-naming | | +| | | CP-140243 | 0374 | 3 | | Diameter overload over SWx | | +| | | CP-140243 | 0375 | 3 | | Diameter overload over STa and S6b | | +| 2014-09 | CT#65 | CP-140510 | 0379 | 2 | | Session Management back-off timer for UE in Single-Connection mode | 12.5.0 | +| | | CP-140516 | 0381 | 2 | | Remove TS 23.234 from TS 29.273 | | +| | | CP-140516 | 0382 | 1 | | Remove TS 29.234 from TS 29.273 | | +| | | CP-140519 | 0383 | 1 | | Circuit ID in NetLoc-TWLAN | | +| 2014-12 | CT#66 | CP-140771 | 0385 | - | | Correct wrong references to 3GPP specifications that define Diameter experimental result codes 5001 to 5005 | 12.6.0 | +| | | CP-140771 | 0397 | 3 | | Restricted RAT Types | | +| | | CP-140784 | 0386 | 1 | | WLCP key for WLCP signalling protection | | +| | | CP-140784 | 0387 | 1 | | TWAN authentication and authorization call flows for MCM and TSCM | | +| | | CP-140784 | 0398 | 1 | | Back-off timer refers to Tw1 | | +| | | CP-140790 | 0389 | 3 | | Diameter Overload over SWm and SWa | | +| | | CP-140754 | 0394 | 2 | | Leading Digit of User-Name AVP | | +| | | CP-140757 | 0396 | - | | Incorrect implementation of CR on EAP-Payload | | +| 2015-03 | CT#67 | CP-150021 | 0401 | 1 | | Usage of decorated NAI | 12.7.0 | +| | | CP-150021 | 0404 | 1 | | Clarification of user de-registration | | +| 2015-06 | CT#68 | CP-150276 | 0416 | 1 | | Correction of the type of the Redirect-Host AVP | 12.8.0 | +| | | CP-150250 | 0407 | - | | Repeated SWm session for default APN | | +| 2015-06 | | | | | | Implemented Rel-13 CRs removed (0410r1, 0417r1, 0418r1, 0405r1) | 12.8.1 | +| 2015-06 | CT#68 | CP-150268 | 0410 | 1 | | The value of SM-Back-Off-Timer | 13.0.0 | +| | | CP-150268 | 0417 | 1 | | Clarification on the S6b Service Authorization Information Update procedure for DSMIPv6 | | +| | | CP-150268 | 0418 | 1 | | Removing EPC before Root NAI | | +| | | CP-150268 | 0405 | 1 | | PDN GW Identity | | +| 2015-09 | CT#68 | CP-150455 | 0422 | 1 | | IMEI(SV) signalling for untrusted WLAN access | 13.1.0 | +| | | CP-150455 | 0423 | 2 | | IMEI(SV) signalling for trusted WLAN access | | +| | | CP-150455 | 0424 | 1 | | IMEI(SV) signalling during Non-3GPP IP Access Registration | | +| | | CP-150442 | 0425 | 1 | | 3GPP AAA Server sends an ASR command to clean up possible hanging resources | | +| | | CP-150442 | 0426 | 3 | | Overlapping transaction over S6b | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|----------------------------------------------------------------------------------------|--------| +| | | CP-150451 | 0427 | 1 | | Default access type for SCM | | +| | | CP-150447 | 0428 | - | | Reference to a wrong clause in TS 23.008 | | +| 2015-12 | CT#70 | CP-150770 | 0429 | 5 | | Emergency PDN connection over untrusted WLAN access | 13.2.0 | +| | | CP-150770 | 0430 | 3 | | Network provided WLAN Location Information for PDN connection establishment over S2b | | +| | | CP-150764 | 0431 | 1 | | UE local IP address in Authentication and Authorization Request over SWm | | +| | | CP-150780 | 0433 | 3 | | P-CSCF Restoration for WLAN over SWx | | +| | | CP-150780 | 0434 | 5 | | Authorisation procedure with the extended P-CSCF restoration mechanism for WLAN | | +| | | CP-150787 | 0435 | - | | Transfer of IMEI from 3GPP AAA Server to HSS over SWx | | +| | | CP-150773 | 0436 | 3 | | Multiple accesses to a PDN connection not allowed for SCM | | +| | | CP-150748 | 0438 | - | | Visited-Network-Identifier for untrusted WLAN | | +| | | CP-150748 | 0443 | 2 | | Blocking TWAN access to EPC | | +| | | CP-150782 | 0439 | 1 | | Handling of S6b Authorization Request without Origination Timestamp | | +| | | CP-150846 | 0440 | 4 | | Diameter message priority over non 3GPP access | | +| | | CP-150759 | 0444 | 1 | | Reference to DOIC updated with IETF RFC 7683 | | +| 2016-03 | CT#71 | CP-160035 | 0446 | - | | Remove the default access AVP | 13.3.0 | +| | | CP-160042 | 0447 | - | | Extension on TWAN-S2a-Failure-Cause | | +| | | CP-160042 | 0448 | 1 | | Authorize the UE requested APN | | +| | | CP-160037 | 0449 | - | | Correction of CR implementation on Emergency PDN connection over untrusted WLAN access | | +| | | CP-160037 | 0450 | 1 | | ePDG retrieval of WLAN Location Information | | +| | | CP-160153 | 0452 | 2 | | Result-Codes for P-CSCF Restoration | | +| 2016-06 | CT#72 | CP-160220 | 0453 | 1 | | RAT type not allowed | 13.4.0 | +| 2016-06 | CT#72 | CP-160220 | 0454 | 1 | | Wildcard APN for SWx and S6b | 13.4.0 | +| 2016-06 | CT#72 | CP-160220 | 0455 | 2 | | Clarification on the use of SAR message when AAA has no profile | 13.4.0 | +| 2016-06 | CT#72 | CP-160220 | 0456 | 1 | | Wildcard authorized APN in TWAN | 13.4.0 | +| 2016-06 | CT#72 | CP-160220 | 0457 | 2 | | APN information over S6b | 13.4.0 | +| 2016-06 | CT#72 | CP-160231 | 0458 | - | | Removal of NBIFOM reference | 13.4.0 | +| 2016-06 | CT#72 | CP-160223 | 0459 | 2 | | Incorrect usage of term "Untrusted WLAN" when RAT type is not known | 13.4.0 | +| 2016-09 | CT#73 | CP-160418 | 0463 | - | | APN subscription check in the STa authentication and authorization procedure | 13.5.0 | +| 2016-09 | CT#73 | CP-160418 | 0465 | 1 | | Transferring AAA identifier from the ePDG/TWAN to the PGW | 13.5.0 | +| 2016-09 | CT#73 | CP-160436 | 0461 | 1 | | 3GPP AAA Server/Proxy – EIR reference point | 14.0.0 | +| 2016-09 | CT#73 | CP-160436 | 0462 | 2 | | STa and SWm extensions for IMEI check | 14.0.0 | +| 2016-12 | CT#74 | CP-160674 | 0466 | 2 | | Destination-Host correction on STa & SWm | 14.1.0 | +| 2016-12 | CT#74 | CP-160674 | | | | 3GPP AAA Server behaviour in the user profile updated procedure | 14.1.0 | +| 2016-12 | CT#74 | CP-160674 | 0489 | 1 | | Handling of Undefined bit in DER-Flags | 14.1.0 | +| 2016-12 | CT#74 | CP-160679 | 0468 | 4 | | Handover of Emergency PDN Connections | 14.1.0 | +| 2016-12 | CT#74 | CP-160679 | 0471 | 1 | | IMEI check for Emergency Attach over WLAN | 14.1.0 | +| 2016-12 | CT#74 | CP-160679 | 0473 | 1 | | Emergency services over untrusted WLAN for unauthenticated or unauthorized UEs | 14.1.0 | +| 2016-12 | CT#74 | CP-160679 | 0474 | 2 | | Support of Emergency sessions over Trusted WLAN | 14.1.0 | +| 2016-12 | CT#74 | CP-160682 | 0469 | 1 | | Missing IMEI-Check-In-VPLMN-Result AVP | 14.1.0 | +| 2016-12 | CT#74 | CP-160682 | 0477 | 1 | | IMEI check call flow for untrusted WLAN | 14.1.0 | +| 2016-12 | CT#74 | CP-160657 | 0476 | 1 | | APN-Configuration AVP format for Non-3GPP accesses | 14.1.0 | +| 2016-12 | CT#74 | CP-160681 | 0484 | 2 | | Load Control | 14.1.0 | +| 2016-12 | CT#74 | CP-160653 | 0486 | - | | Renaming of Emergency-Indication AVP | 14.1.0 | +| 2016-12 | CT#74 | CP-160664 | 0491 | - | | Correction to change IETF drmp draft version to official RFC 7944 | 14.1.0 | +| 2016-12 | CT#74 | CP-160651 | 0492 | - | | Discontinuation of the I-WLAN feature | 14.1.0 | +| 2017-03 | CT#75 | CP-170050 | 0493 | 1 | | DIAMETER_ERROR_ILLEGAL_EQUIPMENT code | 14.2.0 | +| 2017-03 | CT#75 | CP-170044 | 0494 | 1 | | Emergency-Info AVP in Non-3GPP IP Access Registration response | 14.2.0 | +| 2017-03 | CT#75 | CP-170049 | 0495 | 1 | | Addition of ERP support for TWAN Interworking | 14.2.0 | +| 2017-03 | CT#75 | CP-170037 | 0496 | 1 | | Bit ordering in Diameter AVPs used as bit-masks | 14.2.0 | +| 2017-03 | CT#75 | CP-170037 | 0497 | 1 | | Handling of AAA Failure Indication over SWa | 14.2.0 | +| 2017-03 | CT#75 | CP-170037 | 0498 | 1 | | SWm Behaviour after Failed Re-Authorization | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0499 | 1 | | Update of reference for the Diameter base protocol | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0500 | 1 | | Handling of the Vendor-Specific-Application-Id | 14.2.0 | +| 2017-06 | CT#76 | CP-171033 | 0466 | 1 | | NAI for emergency services over WLAN access to EPC | 14.3.0 | +| 2017-06 | CT#76 | CP-171018 | 0503 | 1 | | Support for signaling transport level packet marking | 14.3.0 | +| 2017-06 | CT#76 | CP-171035 | 0505 | 1 | | Only ERP Implicit Bootstrapping mode is supported in Rel-14 | 14.3.0 | +| 2017-06 | CT#76 | CP-171042 | 0507 | - | | Definition of Origination-Time-Stamp AVP | 14.3.0 | +| 2017-09 | CT#77 | CP-172019 | 0509 | 1 | | Emergency sessions over untrusted WLAN with an unauthenticated IMSI | 14.4.0 | +| 2017-09 | CT#77 | CP-172015 | 0511 | - | | PGW selection for WLAN with deployed DCNs | 14.4.0 | +| 2017-09 | CT#77 | CP-172013 | 0514 | - | | Correction of DRMP Procedures | 14.4.0 | +| 2017-09 | CT#77 | CP-172023 | 0508 | - | | MIP6-Feature-Vector over SWx | 15.0.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------|--------| +| 2017-09 | CT#77 | CP-172023 | 0512 | 3 | | External-ID in non-3GPP subscription profile | 15.0.0 | +| 2017-12 | CT#78 | CP-173026 | 0515 | - | | Authorization procedure initiated by ePDG | 15.1.0 | +| 2018-06 | CT#80 | CP-181123 | 0518 | - | | Full-Network-Name and Short-Network-Name AVPs | 15.2.0 | +| 2019-03 | CT#83 | CP-190032 | 0519 | 1 | | Mobility between EPC/ePDG and 5GS | 15.3.0 | +| 2019-09 | CT#85 | CP-192094 | 0521 | 2 | | draft-ietf-dime-load published as RFC 8583 | 15.4.0 | +| 2020-03 | CT#87e | CP-200047 | 0522 | - | | APN-OI-Replacement not applicable for Emergency services | 16.0.0 | +| 2020-06 | CT#88e | CP-201053 | 0523 | - | | APN-OI-Replacement | 16.1.0 | +| 2020-09 | CT#89e | CP-202043 | 0525 | 1 | | AAA Deregistration | 16.2.0 | +| 2021-03 | CT#91e | CP-210027 | 0526 | 1 | | Use of Inclusive Language | 17.0.0 | +| 2021-09 | CT#93e | CP-212053 | 0528 | 1 | D | Editorial correction on WLAN Location Information AVP name | 17.1.0 | +| 2022-03 | CT#95e | CP-220040 | 0529 | 1 | F | 29.273 Addition of MPS statement to Annex B | 17.2.0 | +| 2022-03 | CT#95e | CP-220053 | 0530 | - | B | Non-Seamless WLAN offload in 5GS | 17.2.0 | +| 2022-06 | CT#96 | CP-221030 | 0531 | 1 | F | NSWO in 5GS | 17.3.0 | +| 2022-09 | CT#97e | CP-222034 | 0533 | - | F | Corrections for NSWO in 5GS | 17.4.0 | +| 2022-09 | CT#97e | CP-222022 | 0532 | - | F | Trust Relationship Indicator over SWx | 18.0.0 | +| 2022-12 | CT#98e | CP-223048 | 0536 | - | A | Correcting a label in SUCI in NAI format | 18.1.0 | +| 2022-12 | CT#98e | CP-223038 | 0534 | - | F | Experimental Result Codes for trusted / untrusted non-3GPP access not allowed | 18.1.0 | +| 2023-03 | CT#99 | CP-230079 | 0539 | 1 | A | Stage 2 alignments for Non-seamless WLAN offload in 5GS | 18.2.0 | +| 2023-09 | CT#101 | CP-232033 | 0545 | - | F | Update on AAA Command for Core-Network Restriction | 18.3.0 | +| 2023-09 | CT#101 | CP-232055 | 0540 | 1 | B | MPS for WLAN EPC trusted attach | 18.3.0 | +| 2023-09 | CT#101 | CP-232055 | 0541 | 1 | B | MPS for WLAN EPC untrusted attach | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29274/raw.md b/raw/rel-18/29_series/29274/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d3fef183d4455aba5238df07413bc3fd31c90a7d --- /dev/null +++ b/raw/rel-18/29_series/29274/raw.md @@ -0,0 +1,13870 @@ + + +# 3GPP TS 29.274 V18.5.0 (2023-12) + +*Technical Specification* + +**3rd Generation Partnership Project; +Technical Specification Group Core Network and Terminals; +3GPP Evolved Packet System (EPS); +Evolved General Packet Radio Service (GPRS) +Tunnelling Protocol for Control plane (GTPv2-C); +Stage 3; +(Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +# **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|--------------------------------------------------------------------------------------------------|----| +| Foreword..... | 11 | +| 1 Scope..... | 12 | +| 2 References..... | 12 | +| 3 Definitions, symbols and abbreviations..... | 16 | +| 3.1 Definitions..... | 16 | +| 3.2 Symbols..... | 16 | +| 3.3 Abbreviations..... | 17 | +| 4 General..... | 19 | +| 4.1 GTP Tunnel..... | 19 | +| 4.2 Protocol stack..... | 19 | +| 4.2.0 General..... | 19 | +| 4.2.1 UDP header and port numbers..... | 20 | +| 4.2.1.0 General..... | 20 | +| 4.2.1.1 Initial Messages..... | 21 | +| 4.2.1.2 Triggered Messages..... | 21 | +| 4.2.1.3 Piggybacked Messages..... | 21 | +| 4.2.2 IP header and IP addresses..... | 21 | +| 4.2.2.1 Initial Messages..... | 21 | +| 4.2.2.2 Triggered Messages..... | 22 | +| 4.2.2.3 Piggybacked Messages..... | 23 | +| 4.2.3 Layer 2..... | 23 | +| 4.2.4 Layer 1..... | 23 | +| 4.2.5 Messages with GTPv2 defined replies: Classification of Initial and Triggered Messages..... | 23 | +| 4.3 Transmission Order and Bit Definitions..... | 24 | +| 5 GTP Header for Control Plane..... | 24 | +| 5.1 General format..... | 24 | +| 5.2 Control Plane GTP Extension Header..... | 24 | +| 5.3 GTP-C header for Echo and Version Not Supported Indication messages..... | 24 | +| 5.4 EPC specific GTP-C header..... | 25 | +| 5.5 Usage of the GTPv2-C Header..... | 25 | +| 5.5.1 General..... | 25 | +| 5.5.2 Conditions for sending TEID=0 in GTPv2-C header..... | 26 | +| 5.6 Format of the GTPv2-C Message..... | 28 | +| 6 GTP-C Message Types and Message Formats..... | 29 | +| 6.0 General..... | 29 | +| 6.1 Message Format and Type values..... | 29 | +| 6.1.0 Message Type..... | 29 | +| 6.1.1 Presence requirements of Information Elements..... | 32 | +| 6.1.2 Grouped Information Elements..... | 33 | +| 6.1.3 Information Element instance..... | 34 | +| 6.2 Message Granularity..... | 34 | +| 7 GTP-C messages..... | 35 | +| 7.1 Path Management Messages..... | 35 | +| 7.1.0 General..... | 35 | +| 7.1.1 Echo Request..... | 35 | +| 7.1.2 Echo Response..... | 36 | +| 7.1.3 Version Not Supported Indication..... | 36 | +| 7.2 Tunnel Management Messages..... | 36 | +| 7.2.0 General..... | 36 | +| 7.2.1 Create Session Request..... | 36 | +| 7.2.2 Create Session Response..... | 59 | +| 7.2.3 Create Bearer Request..... | 72 | + +| | | | +|----------|---------------------------------------------------------|-----| +| 7.2.4 | Create Bearer Response..... | 80 | +| 7.2.5 | Bearer Resource Command..... | 85 | +| 7.2.6 | Bearer Resource Failure Indication..... | 88 | +| 7.2.7 | Modify Bearer Request..... | 91 | +| 7.2.8 | Modify Bearer Response..... | 110 | +| 7.2.9 | Delete Session Request and Delete Bearer Request..... | 117 | +| 7.2.9.1 | Delete Session Request..... | 117 | +| 7.2.9.2 | Delete Bearer Request..... | 123 | +| 7.2.10 | Delete Session Response and Delete Bearer Response..... | 131 | +| 7.2.10.1 | Delete Session Response..... | 131 | +| 7.2.10.2 | Delete Bearer Response..... | 135 | +| 7.2.11 | Downlink Data Notification messages..... | 139 | +| 7.2.11.1 | Downlink Data Notification..... | 139 | +| 7.2.11.2 | Downlink Data Notification Acknowledge..... | 143 | +| 7.2.11.3 | Downlink Data Notification Failure Indication..... | 145 | +| 7.2.12 | Delete Indirect Data Forwarding Tunnel Request..... | 145 | +| 7.2.13 | Delete Indirect Data Forwarding Tunnel Response..... | 146 | +| 7.2.14 | Modify Bearer Command and Failure Indication..... | 147 | +| 7.2.14.1 | Modify Bearer Command..... | 147 | +| 7.2.14.2 | Modify Bearer Failure Indication..... | 149 | +| 7.2.15 | Update Bearer Request..... | 151 | +| 7.2.16 | Update Bearer Response..... | 159 | +| 7.2.17 | Delete Bearer Command and Failure Indication..... | 163 | +| 7.2.17.1 | Delete Bearer Command..... | 163 | +| 7.2.17.2 | Delete Bearer Failure Indication..... | 165 | +| 7.2.18 | Create Indirect Data Forwarding Tunnel Request..... | 168 | +| 7.2.19 | Create Indirect Data Forwarding Tunnel Response..... | 171 | +| 7.2.20 | Void..... | 173 | +| 7.2.21 | Release Access Bearers Request..... | 173 | +| 7.2.22 | Release Access Bearers Response..... | 174 | +| 7.2.23 | Stop Paging Indication..... | 176 | +| 7.2.24 | Modify Access Bearers Request..... | 176 | +| 7.2.25 | Modify Access Bearers Response..... | 180 | +| 7.2.26 | Remote UE Report Notification..... | 183 | +| 7.2.27 | Remote UE Report Acknowledge..... | 184 | +| 7.3 | Mobility Management Messages..... | 184 | +| 7.3.1 | Forward Relocation Request..... | 184 | +| 7.3.2 | Forward Relocation Response..... | 198 | +| 7.3.3 | Forward Relocation Complete Notification..... | 202 | +| 7.3.4 | Forward Relocation Complete Acknowledge..... | 203 | +| 7.3.5 | Context Request..... | 204 | +| 7.3.6 | Context Response..... | 207 | +| 7.3.7 | Context Acknowledge..... | 219 | +| 7.3.8 | Identification Request..... | 221 | +| 7.3.9 | Identification Response..... | 222 | +| 7.3.10 | Forward Access Context Notification..... | 223 | +| 7.3.11 | Forward Access Context Acknowledge..... | 224 | +| 7.3.12 | Detach Notification..... | 224 | +| 7.3.13 | Detach Acknowledge..... | 225 | +| 7.3.14 | Change Notification Request..... | 226 | +| 7.3.15 | Change Notification Response..... | 229 | +| 7.3.16 | Relocation Cancel Request..... | 230 | +| 7.3.17 | Relocation Cancel Response..... | 231 | +| 7.3.18 | Configuration Transfer Tunnel..... | 231 | +| 7.3.19 | RAN Information Relay..... | 233 | +| 7.3.20 | ISR Status Indication..... | 233 | +| 7.3.21 | UE Registration Query Request..... | 234 | +| 7.3.22 | UE Registration Query Response..... | 234 | +| 7.4 | CS Fallback and SRVCC related messages..... | 235 | +| 7.4.1 | Suspend Notification..... | 235 | +| 7.4.2 | Suspend Acknowledge..... | 236 | + +| | | | +|--------|----------------------------------------------------------|-----| +| 7.4.3 | Resume Notification..... | 237 | +| 7.4.4 | Resume Acknowledge..... | 238 | +| 7.4.5 | CS Paging Indication..... | 238 | +| 7.4.6 | Alert MME Notification..... | 239 | +| 7.4.7 | Alert MME Acknowledge..... | 239 | +| 7.4.8 | UE Activity Notification..... | 239 | +| 7.4.9 | UE Activity Acknowledge..... | 240 | +| 7.5 | Non-3GPP access related messages..... | 240 | +| 7.5.1 | Create Forwarding Tunnel Request..... | 240 | +| 7.5.2 | Create Forwarding Tunnel Response..... | 240 | +| 7.6 | Reliable Delivery of Signalling Messages..... | 241 | +| 7.7 | Error Handling..... | 242 | +| 7.7.0 | Handling Piggybacked Messages..... | 242 | +| 7.7.1 | Protocol Errors..... | 242 | +| 7.7.2 | Different GTP Versions..... | 243 | +| 7.7.3 | GTP Message of Invalid Length..... | 243 | +| 7.7.4 | Unknown GTP Message..... | 243 | +| 7.7.5 | Unexpected GTP Message..... | 243 | +| 7.7.6 | Missing Information Elements..... | 244 | +| 7.7.7 | Invalid Length Information Element..... | 244 | +| 7.7.8 | Semantically incorrect Information Element..... | 245 | +| 7.7.9 | Unknown or unexpected Information Element..... | 245 | +| 7.7.10 | Repeated Information Elements..... | 245 | +| 7.7.11 | TFT Error Handling..... | 246 | +| 7.8 | Path Failure..... | 246 | +| 7.9 | Restoration and Recovery..... | 246 | +| 7.9.0 | General..... | 246 | +| 7.9.1 | Delete PDN Connection Set Request..... | 246 | +| 7.9.2 | Delete PDN Connection Set Response..... | 247 | +| 7.9.3 | Update PDN Connection Set Request..... | 247 | +| 7.9.4 | Update PDN Connection Set Response..... | 247 | +| 7.9.5 | PGW Restart Notification..... | 248 | +| 7.9.6 | PGW Restart Notification Acknowledge..... | 248 | +| 7.9.7 | PGW Downlink Triggering Notification..... | 249 | +| 7.9.8 | PGW Downlink Triggering Acknowledge..... | 249 | +| 7.10 | Fallback to GTPv1 mechanism..... | 250 | +| 7.11 | Fallback to GTPv0..... | 250 | +| 7.12 | Trace Management Messages..... | 251 | +| 7.12.1 | Trace Session Activation..... | 251 | +| 7.12.2 | Trace Session Deactivation..... | 252 | +| 7.13 | MBMS Messages..... | 253 | +| 7.13.1 | MBMS Session Start Request..... | 253 | +| 7.13.2 | MBMS Session Start Response..... | 254 | +| 7.13.3 | MBMS Session Update Request..... | 255 | +| 7.13.4 | MBMS Session Update Response..... | 256 | +| 7.13.5 | MBMS Session Stop Request..... | 256 | +| 7.13.6 | MBMS Session Stop Response..... | 256 | +| 8 | GTP-C Information Elements..... | 257 | +| 8.1 | Information Element Types..... | 257 | +| 8.2 | Information Element Format..... | 260 | +| 8.2.1 | General..... | 260 | +| 8.2.1A | Information Element with an IE Type Extension field..... | 261 | +| 8.2.2 | Handling ASN.1/PER encoded parameters..... | 261 | +| 8.3 | International Mobile Subscriber Identity (IMSI)..... | 261 | +| 8.4 | Cause..... | 262 | +| 8.5 | Recovery (Restart Counter)..... | 268 | +| 8.6 | Access Point Name (APN)..... | 269 | +| 8.7 | Aggregate Maximum Bit Rate (AMBR)..... | 269 | +| 8.8 | EPS Bearer ID (EBI)..... | 269 | +| 8.9 | IP Address..... | 270 | +| 8.10 | Mobile Equipment Identity (MEI)..... | 270 | + +| | | | +|---------|----------------------------------------------------------|-----| +| 8.11 | MSISDN..... | 270 | +| 8.12 | Indication..... | 271 | +| 8.13 | Protocol Configuration Options (PCO)..... | 276 | +| 8.14 | PDN Address Allocation (PAA)..... | 277 | +| 8.15 | Bearer Quality of Service (Bearer QoS)..... | 278 | +| 8.16 | Flow Quality of Service (Flow QoS)..... | 278 | +| 8.17 | RAT Type..... | 279 | +| 8.18 | Serving Network..... | 280 | +| 8.19 | EPS Bearer Level Traffic Flow Template (Bearer TFT)..... | 280 | +| 8.20 | Traffic Aggregate Description (TAD)..... | 281 | +| 8.21 | User Location Information (ULI)..... | 281 | +| 8.21.1 | CGI field..... | 281 | +| 8.21.2 | SAI field..... | 282 | +| 8.21.3 | RAI field..... | 282 | +| 8.21.4 | TAI field..... | 283 | +| 8.21.5 | ECGI field..... | 283 | +| 8.21.6 | LAI field..... | 283 | +| 8.21.7 | Macro eNodeB ID field..... | 283 | +| 8.21.8 | Extended Macro eNodeB ID field..... | 284 | +| 8.22 | Fully Qualified TEID (F-TEID)..... | 284 | +| 8.23 | TMSI..... | 286 | +| 8.24 | Global CN-Id..... | 286 | +| 8.25 | S103 PDN Data Forwarding Info (S103PDF)..... | 287 | +| 8.26 | S1-U Data Forwarding (S1UDF)..... | 287 | +| 8.27 | Delay Value..... | 288 | +| 8.28 | Bearer Context..... | 288 | +| 8.29 | Charging ID..... | 288 | +| 8.30 | Charging Characteristics..... | 288 | +| 8.31 | Trace Information..... | 289 | +| 8.32 | Bearer Flags..... | 289 | +| 8.33 | Void..... | 290 | +| 8.34 | PDN Type..... | 290 | +| 8.35 | Procedure Transaction ID (PTI)..... | 290 | +| 8.36 | Void..... | 291 | +| 8.37 | Void..... | 291 | +| 8.38 | MM Context..... | 291 | +| 8.39 | PDN Connection..... | 301 | +| 8.40 | PDU Numbers..... | 302 | +| 8.41 | Packet TMSI (P-TMSI)..... | 302 | +| 8.42 | P-TMSI Signature..... | 303 | +| 8.43 | Hop Counter..... | 303 | +| 8.44 | UE Time Zone..... | 303 | +| 8.45 | Trace Reference..... | 304 | +| 8.46 | Complete Request Message..... | 304 | +| 8.47 | GUTI..... | 304 | +| 8.48 | Fully Qualified Container (F-Container)..... | 305 | +| 8.49 | Fully Qualified Cause (F-Cause)..... | 306 | +| 8.50 | PLMN ID..... | 307 | +| 8.51 | Target Identification..... | 308 | +| 8.51.1 | General..... | 308 | +| 8.51.2 | RNC ID..... | 308 | +| 8.51.3 | Macro eNodeB ID..... | 309 | +| 8.51.4 | Home eNodeB ID..... | 310 | +| 8.51.5 | Extended Macro eNodeB ID..... | 310 | +| 8.51.6 | Cell Identifier..... | 311 | +| 8.51.7 | gNodeB ID..... | 311 | +| 8.51.8 | Macro ng-eNodeB ID..... | 311 | +| 8.51.9 | Extended Macro ng-eNodeB ID..... | 312 | +| 8.51.10 | en-gNB ID..... | 312 | +| 8.52 | Void..... | 313 | +| 8.53 | Packet Flow ID..... | 313 | + +| | | | +|-------|--------------------------------------------------------------|-----| +| 8.54 | RAB Context..... | 313 | +| 8.55 | Source RNC PDCP context info..... | 314 | +| 8.56 | Port Number..... | 314 | +| 8.57 | APN Restriction..... | 314 | +| 8.58 | Selection Mode..... | 315 | +| 8.59 | Source Identification..... | 315 | +| 8.60 | Void..... | 316 | +| 8.61 | Change Reporting Action..... | 316 | +| 8.62 | Fully qualified PDN Connection Set Identifier (FQ-CSID)..... | 316 | +| 8.63 | Channel needed..... | 317 | +| 8.64 | eMLPP Priority..... | 317 | +| 8.65 | Node Type..... | 318 | +| 8.66 | Fully Qualified Domain Name (FQDN)..... | 318 | +| 8.67 | Private Extension..... | 319 | +| 8.68 | Transaction Identifier (TI)..... | 319 | +| 8.69 | MBMS Session Duration..... | 319 | +| 8.70 | MBMS Service Area..... | 320 | +| 8.71 | MBMS Session Identifier..... | 320 | +| 8.72 | MBMS Flow Identifier..... | 320 | +| 8.73 | MBMS IP Multicast Distribution..... | 320 | +| 8.74 | MBMS Distribution Acknowledge..... | 321 | +| 8.75 | User CSG Information (UCI)..... | 321 | +| 8.76 | CSG Information Reporting Action..... | 322 | +| 8.77 | RFSP Index..... | 323 | +| 8.78 | CSG ID..... | 323 | +| 8.79 | CSG Membership Indication (CMI)..... | 323 | +| 8.80 | Service indicator..... | 324 | +| 8.81 | Detach Type..... | 324 | +| 8.82 | Local Distinguished Name (LDN)..... | 325 | +| 8.83 | Node Features..... | 325 | +| 8.84 | MBMS Time to Data Transfer..... | 327 | +| 8.85 | Throttling..... | 327 | +| 8.86 | Allocation/Retention Priority (ARP)..... | 327 | +| 8.87 | EPC Timer..... | 328 | +| 8.88 | Signalling Priority Indication..... | 329 | +| 8.89 | Temporary Mobile Group Identity (TMGI)..... | 329 | +| 8.90 | Additional MM context for SRVCC..... | 329 | +| 8.91 | Additional flags for SRVCC..... | 330 | +| 8.92 | Void..... | 330 | +| 8.93 | MDT Configuration..... | 330 | +| 8.94 | Additional Protocol Configuration Options (APCO)..... | 331 | +| 8.95 | Absolute Time of MBMS Data Transfer..... | 332 | +| 8.96 | H(e)NB Information Reporting..... | 332 | +| 8.97 | IPv4 Configuration Parameters (IP4CP)..... | 332 | +| 8.98 | Change to Report Flags..... | 333 | +| 8.99 | Action Indication..... | 333 | +| 8.100 | TWAN Identifier..... | 334 | +| 8.101 | ULI Timestamp..... | 335 | +| 8.102 | MBMS Flags..... | 335 | +| 8.103 | RAN/NAS Cause..... | 336 | +| 8.104 | CN Operator Selection Entity..... | 337 | +| 8.105 | Trusted WLAN Mode Indication..... | 337 | +| 8.106 | Node Number..... | 338 | +| 8.107 | Node Identifier..... | 338 | +| 8.108 | Presence Reporting Area Action..... | 339 | +| 8.109 | Presence Reporting Area Information..... | 341 | +| 8.110 | TWAN Identifier Timestamp..... | 341 | +| 8.111 | Overload Control Information..... | 342 | +| 8.112 | Load Control Information..... | 342 | +| 8.113 | Metric..... | 342 | +| 8.114 | Sequence Number..... | 343 | + +| | | | +|--------|---------------------------------------------------------------------|-----| +| 8.115 | APN and Relative Capacity..... | 343 | +| 8.116 | WLAN Offloadability Indication..... | 343 | +| 8.117 | Paging and Service Information..... | 344 | +| 8.118 | Integer Number..... | 344 | +| 8.119 | Millisecond Time Stamp..... | 345 | +| 8.120 | Monitoring Event Information..... | 345 | +| 8.121 | ECGI List..... | 346 | +| 8.122 | Remote UE Context..... | 346 | +| 8.123 | Remote User ID..... | 347 | +| 8.124 | Remote UE IP Information..... | 347 | +| 8.125 | CIoT Optimizations Support Indication..... | 348 | +| 8.126 | SCEF PDN Connection..... | 348 | +| 8.127 | Header Compression Configuration..... | 348 | +| 8.128 | Extended Protocol Configuration Options (ePCO)..... | 349 | +| 8.129 | Serving PLMN Rate Control..... | 350 | +| 8.130 | Counter..... | 350 | +| 8.131 | Mapped UE Usage Type..... | 350 | +| 8.132 | Secondary RAT Usage Data Report..... | 351 | +| 8.133 | UP Function Selection Indication Flags..... | 352 | +| 8.134 | Maximum Packet Loss Rate..... | 352 | +| 8.135 | APN Rate Control Status..... | 353 | +| 8.136 | Extended Trace Information..... | 353 | +| 8.137 | Monitoring Event Extension Information..... | 354 | +| 8.138 | Additional RRM Policy Index..... | 355 | +| 8.139 | V2X Context..... | 355 | +| 8.140 | PC5 QoS Parameters..... | 355 | +| 8.141 | Services Authorized..... | 356 | +| 8.142 | Bit Rate..... | 356 | +| 8.143 | PC5 QoS Flow..... | 357 | +| 8.144 | SGi PtP Tunnel Address..... | 357 | +| 8.145 | PGW Change Info..... | 358 | +| 8.146 | PGW FQDN..... | 358 | +| 8.147 | Group Id..... | 358 | +| 8.148 | PSCell ID..... | 359 | +| 8.149 | UP Security Policy..... | 359 | +| 8.150 | Alternative IMSI..... | 360 | +| 8.151 | NF Instance ID..... | 360 | +| 8.152 | Timer in Seconds..... | 360 | +| 9 | Security..... | 360 | +| 10 | IP - The Networking Technology used by GTP..... | 361 | +| 10.1 | IP Version..... | 361 | +| 10.2 | IP Fragmentation..... | 361 | +| 10.3 | DSCP..... | 361 | +| 11 | Notification of supported features between peer GTP-C entities..... | 361 | +| 11.1 | General..... | 361 | +| 11.1.1 | Introduction..... | 361 | +| 11.1.2 | Defining a feature..... | 362 | +| 11.2 | Dynamic discovery of supported features..... | 362 | +| 11.2.1 | General..... | 362 | +| 11.2.2 | Features supported by direct peer GTP-C entities..... | 362 | +| 12 | GTP-C load & overload control mechanism..... | 362 | +| 12.1 | General..... | 362 | +| 12.1.1 | GTP-C overload problem..... | 362 | +| 12.1.2 | Scenarios leading to overload..... | 363 | +| 12.1.3 | Load & overload control concepts..... | 363 | +| 12.2 | Load control solution..... | 364 | +| 12.2.1 | Principles of load control..... | 364 | +| 12.2.2 | Applicability to 3GPP and non-3GPP access based interfaces..... | 365 | +| 12.2.3 | Node level load control..... | 365 | + +| | | | +|-------------|----------------------------------------------------------------------------------------|-----| +| 12.2.4 | APN level load control..... | 365 | +| 12.2.4.1 | General..... | 365 | +| 12.2.4.2 | Justifications for APN load control support..... | 365 | +| 12.2.4.3 | Elements of APN load control..... | 366 | +| 12.2.5 | Load Control Information..... | 367 | +| 12.2.5.1 | Definition..... | 367 | +| 12.2.5.1.1 | General description..... | 367 | +| 12.2.5.1.2 | Parameters..... | 367 | +| 12.2.5.1.3 | Handling of parameters..... | 369 | +| 12.2.5.2 | Frequency of inclusion..... | 370 | +| 12.2.5.3 | Limit on maximum number of instances..... | 370 | +| 12.2.6 | Discovery of the support of the feature by the peer node..... | 370 | +| 12.2.7 | Issues in the network with partial support of the feature..... | 370 | +| 12.3 | Overload control solution..... | 371 | +| 12.3.1 | Principles of overload control..... | 371 | +| 12.3.2 | Applicability to 3GPP and non-3GPP access based interfaces..... | 371 | +| 12.3.3 | Node level overload control..... | 372 | +| 12.3.4 | APN level overload control..... | 372 | +| 12.3.4.1 | General..... | 372 | +| 12.3.4.2 | Elements of APN overload control..... | 373 | +| 12.3.5 | Overload Control Information..... | 373 | +| 12.3.5.1 | Definition..... | 373 | +| 12.3.5.1.1 | General description..... | 373 | +| 12.3.5.1.2 | Parameters..... | 374 | +| 12.3.5.1.3 | Handling of parameters..... | 376 | +| 12.3.5.2 | Frequency of inclusion..... | 376 | +| 12.3.5.3 | Limit on maximum number of instances..... | 377 | +| 12.3.6 | Propagating the MME/S4-SGSN identity to the PGW..... | 377 | +| 12.3.7 | Updating the PGW with overload control information of the target MME/S4-SGSN..... | 377 | +| 12.3.8 | The interaction with APN congestion control using the PGW Back-Off Time..... | 378 | +| 12.3.9 | Message throttling..... | 378 | +| 12.3.9.1 | General..... | 378 | +| 12.3.9.2 | Throttling algorithm – "Loss"..... | 379 | +| 12.3.9.2.1 | Description..... | 379 | +| 12.3.9.3 | Message prioritization..... | 379 | +| 12.3.9.3.1 | Description..... | 379 | +| 12.3.9.3.2 | Based on procedures..... | 380 | +| 12.3.9.3.3 | Based on session parameters..... | 381 | +| 12.3.9.3.4 | Based on the Message Priority signalled in the GTP-C message..... | 381 | +| 12.3.10 | Enforcement of overload control..... | 382 | +| 12.3.10.1 | General..... | 382 | +| 12.3.10.2 | Aspects related to enforcement of the overload control..... | 382 | +| 12.3.10.2.1 | Good throughput of the network..... | 382 | +| 12.3.10.2.2 | Message processing efficiency at the source GTP-C entity..... | 382 | +| 12.3.10.2.3 | Self-protection by the overloaded GTP-C entity..... | 382 | +| 12.3.10.3 | Enforcement of overload control between GTP-C entities in direct contact..... | 383 | +| 12.3.10.4 | Enforcement of overload control between remote GTP-C entities..... | 383 | +| 12.3.10.4.1 | Description..... | 383 | +| 12.3.11 | Discovery of the support of the feature by the peer node..... | 383 | +| 12.3.12 | Issues in the network with partial support of the feature..... | 383 | +| 12.3.13 | Implicit overload control mechanisms..... | 383 | +| 13 | Detection and handling of late arriving requests..... | 384 | +| 13.1 | General..... | 384 | +| 13.2 | Detection and handling of requests which collide with an existing session context..... | 384 | +| 13.2.1 | General..... | 384 | +| 13.2.2 | Principles..... | 384 | +| 13.3 | Detection and handling of requests which have timed out at the originating entity..... | 385 | +| 13.3.1 | General..... | 385 | +| 13.3.2 | Principles..... | 385 | + +| | | | +|-------------------------------|-------------------------------------------------------------------------------------------|------------| +| 14 | Handling of Bearer Contexts Mismatch..... | 386 | +| 14.1 | General..... | 386 | +| 14.2 | Detection of Bearer Context Mismatch..... | 386 | +| 14.3 | Handling of Bearer Context Mismatch..... | 386 | +| 14.3.1 | General..... | 386 | +| 14.3.2 | Exceptional scenarios..... | 387 | +| Annex A (Informative): | Backward Compatibility Guidelines for Information Elements..... | 388 | +| Annex B (Informative): | Transparent copying of RANAP/S1AP/NGAP IEs into GTP IEs..... | 389 | +| B.1 | General..... | 389 | +| B.2 | Handover/Relocation related generic transparent Containers over RANAP, S1-AP and GTP..... | 389 | +| B.3 | Other RANAP and S1-AP and NGAP IEs..... | 391 | +| Annex C (Normative): | MME/S4-SGSN mapping table between S11/S4 and NAS Cause values..... | 392 | +| Annex D (Informative): | GTP-C load and overload control mechanism..... | 397 | +| D.1 | GTP-C interfaces not supporting Load Control..... | 397 | +| D.2 | GTP-C interfaces not supporting Overload Control..... | 397 | +| D.3 | "Loss" throttling algorithm..... | 398 | +| D.3.1 | Example of possible implementation..... | 398 | +| D.4 | Enforcement of overload control between remote GTP-C entities..... | 398 | +| D.4.1 | Example of possible implementation..... | 398 | +| Annex E (Normative): | TWAN mapping table between GTPv2 S2a Cause and non-3GPP access Cause values..... | 400 | +| Annex F (Informative): | Change History..... | 404 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +**shall** indicates a mandatory requirement to do something + +**shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +**should** indicates a recommendation to do something + +**should not** indicates a recommendation not to do something + +**may** indicates permission to do something + +**need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +**can** indicates that something is possible + +**cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +**will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the stage 3 of the control plane of the GPRS Tunnelling Protocol, Version 2 (GTPv2-C). + +GTPv2-C shall be used over: + +- the S2a, S2b, S3, S4, S5, S8, S10, S11, S16, Sm and Sn signalling interfaces in EPC, specified in 3GPP TS 23.401 [3] and 3GPP TS 23.402 [45]. +- the N26 signalling interface between EPC and 5GC, specified in 3GPP TS 23.501 [82] and 3GPP TS 23.502 [83]. + +GTPv2-C based protocols shall also be used over the Sv (see 3GPP TS 29.280 [15]) and S101/S121 (see 3GPP TS 29.276 [14]) interfaces. + +In this document, unless otherwise specified, the S2a, S2b, S5 and S8 interfaces refer to the GTP-based S2a, S2b, S5 and S8 interfaces respectively. + +The present document specifies functions, procedures and information which apply to GERAN Iu mode. However, functionality related to GERAN Iu mode is neither maintained nor enhanced. + +--- + +## 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.003: "Numbering, addressing and identification". +- [3] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [4] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface". +- [5] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [6] IETF RFC 791 (STD 0005): "Internet Protocol", J. Postel. +- [7] IETF RFC 768 (STD 0006): "User Datagram Protocol", J. Postel. +- [8] 3GPP TS 32.251: "Telecommunication Management; Charging Management; Packet Switched (PS) domain charging". +- [9] 3GPP TS 32.298: "Telecommunication Management; Charging Management; Charging Data Record (CDR) parameter classification". +- [10] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". + +- [11] 3GPP TS 33.102: "3G security; Security architecture". +- [12] 3GPP TS 33.401: "3GPP System Architecture Evolution (SAE); Security architecture". +- [13] 3GPP TS 29.281: "General Packet Radio System (GPRS) Tunnelling Protocol User Plane (GTPv1-U)". +- [14] 3GPP TS 29.276: "3GPP Evolved Packet System (EPS); Optimized handover procedures and protocols between E-UTRAN Access and cdma2000 HRPD Access; Stage 3". +- [15] 3GPP TS 29.280: "Evolved Packet System (EPS); 3GPP Sv interface (MME to MSC, and SGSN to MSC) for SRVCC". +- [16] IETF RFC 2460: "Internet Protocol, Version 6 (IPv6) Specification". +- [17] 3GPP TS 23.007: "Restoration procedures". +- [18] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [19] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2". +- [20] 3GPP TS 36.414: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 data transport". +- [21] 3GPP TS 23.272: "Circuit Switched (CS) fallback in Evolved Packet System (EPS); Stage 2". +- [22] 3GPP TS 29.118: "Mobility Management Entity (MME) - Visitor Location Register (VLR) SGs interface specification". +- [23] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [24] void +- [25] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [26] 3GPP TS 29.275: "Proxy Mobile IPv6 (PMIPv6) based Mobility and Tunnelling protocols; Stage 3". +- [27] 3GPP TS 44.018: "Mobile radio interface layer 3 specification; Radio Resource Control Protocol". +- [28] 3GPP TS 48.008: "Mobile Switching Centre - Base Station System (MSC-BSS) interface; Layer 3 specification". +- [29] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [30] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General Aspects". +- [31] IETF RFC 1035: "Domain Names - Implementation and Specification". +- [32] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [33] 3GPP TS 25.413: "UTRAN Iu interface Radio Access Network Application Part (RANAP) signalling". +- [34] 3GPP TS 48.018: "General Packet Radio Service (GPRS); Base Station System (BSS) - Serving GPRS Support Node (SGSN); BSS GPRS protocol (BSSGP)". +- [35] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". + +- [36] 3GPP TS 32.295: "Telecommunication management; Charging management; Charging Data Record (CDR) transfer". +- [37] 3GPP TS 23.246: "Multimedia Broadcast/Multicast Service (MBMS); Architecture and functional description". +- [38] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN) ". +- [39] IETF RFC 3588: "Diameter Base Protocol ". +- [40] IETF RFC 4607: "Source-Specific Multicast for IP". +- [41] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [42] 3GPP TS 29.010: "Information element mapping between Mobile Station - Base Station System (MS - BSS) and Base Station System - Mobile-services Switching Centre (BSS - MSC); Signalling procedures and the Mobile Application Part (MAP)". +- [43] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC); Stage 2". +- [44] 3GPP TS 32.423: "Telecommunication management; Subscriber and equipment trace: Trace data definition and management". +- [45] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses. +- [46] 3GPP TR 25.999: "HSPA Evolution (FDD)". +- [47] 3GPP TS 23.292: "IP Multimedia Subsystem (IMS) centralized services". +- [48] 3GPP TS 23.203: "Policy and charging control architecture; Stage 2". +- [49] ITU-T Recommendation X.691 (07/2002): "Information technology – ASN.1 encoding rules: Specification of Packed Encoding Rules (PER)". +- [50] 3GPP TS 33.402: "3GPP System Architecture Evolution (SAE); Security aspects of non-3GPP accesses". +- [51] 3GPP TS 23.139: "3GPP system - fixed broadband access network interworking; Stage 2". +- [52] IEEE Std 802.11-2012: "IEEE Standard for Information technology - Telecommunications and information exchange between systems - Local and metropolitan area networks - Specific requirements - Part 11: Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications". +- [53] IETF RFC 5905: "Network Time Protocol Version 4: Protocol and Algorithms Specification". +- [54] 3GPP TS 32.299: "Telecommunication Management; Charging Management; Diameter charging applications. +- [55] 3GPP TS 23.251: " Network Sharing; Architecture and Functional Description". +- [56] 3GPP TS 23.271: "Location Services". +- [57] 3GPP TS 29.173: "Diameter-based SLh interface for Control Plane LCS". +- [58] IETF RFC 5453: "Reserved IPv6 Interface Identifiers". +- [59] IETF RFC 4776: "Dynamic Host Configuration Protocol (DHCPv4 and DHCPv6) Option for Civic Addresses Configuration Information". +- [60] IETF RFC 3046: "DHCP Relay Agent Information Option". +- [61] 3GPP TS 23.380: "IMS Restoration Procedures". +- [62] 3GPP TS 22.153: "Multimedia Priority Service". + +- [63] 3GPP TS 24.302: "Access to the 3GPP Evolved Packet Core (EPC) via non-3GPP access networks; stage 3". +- [64] ITU-T Recommendation E.212: "The international identification plan for mobile terminals and mobile users". +- [65] IETF RFC 2474: "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [66] 3GPP TS 24.244: "Wireless LAN control plane protocol for trusted WLAN access to EPC". +- [67] IETF RFC 7296: "Internet Key Exchange Protocol Version 2 (IKEv2)". +- [68] 3GPP TS 29.273: "3GPP EPS AAA Interfaces". +- [69] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [70] 3GPP TS 29.272: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [71] 3GPP TS 23.161: "Network-Based IP Flow Mobility (NBIFOM); Stage 2". +- [72] 3GPP TS 23.303: "Proximity-based services (ProSe); Stage 2". +- [73] 3GPP TS 24.161: "Network-Based IP Flow Mobility (NBIFOM); Stage 3". +- [74] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [75] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)". +- [76] 3GPP TS 36.323: "Evolved Universal Terrestrial Radio Access (E-UTRA); Packet Data Convergence Protocol (PDCP) specification". +- [77] IETF RFC 4995: "The ROBust Header Compression (ROHC) Framework". +- [78] 3GPP TS 43.020: "Security related network functions". +- [79] 3GPP TS 36.444: "EUTRAN M3 Application Protocol (M3AP)". +- [80] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane of EPC Nodes; stage 3". +- [81] IETF RFC 2474: "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [82] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [83] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [84] 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP)". +- [85] 3GPP TS 33.250: "Security assurance specification for the PGW network product class". +- [86] 3GPP TS 33.501: "Security Architecture and Procedures for 5G System". +- [87] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [88] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [89] 3GPP TS 23.287: "Architecture enhancements for 5G System (5GS) to support Vehicle-to-Everything (V2X) services". +- [90] 3GPP TS 23.256: "Support of Uncrewed Aerial Systems (UAS) connectivity, identification and tracking; Stage 2". +- [91] 3GPP TS 23.273: "5G System (5GS) Location Services (LCS); Stage 2". + +[92] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +## 3 Definitions, symbols and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**GTP-PDU:** GTP Protocol Data Unit is either a GTP-C Message or a GTP-U Message. GTP-U Message may be either a signalling message across the user plane tunnel, or a G-PDU (see clause 6). + +- **Signalling Message:** any GTP-PDU (GTP-C or GTP-U) except the G-PDU. +- **G-PDU:** GTP user plane message, which carries the original packet (payload). G-PDU consists of GTP-U header and a T-PDU. +- **T-PDU:** original packet, for example an IP datagram, from an UE or a network node in an external packet data network. A T-PDU is the payload that is tunnelled in the GTP-U tunnel. +- **GTP-C Message:** GTP control plane message type of a GTP-PDU. GTP-C message consists of GTP-C header, which is followed by zero or more information elements. +- **GTP-U Message:** GTP user plane message. The user plane messages are used to carry user data packets, and also signalling messages e.g. for path management and error indication. Therefore, GTP-U message consists of GTP-U header, which is followed by either a T-PDU, or zero or more information elements. + +**GTP Tunnel:** A GTP tunnel is a communication tunnel between two GTP nodes (see clause 4.1 "GTP Tunnel"). + +**PDN Connection:** "PDN Connection" in this specification only refers to the PDN connection through the SGW and PGW. + +**RLOS attached UE:** A UE is attached only for accessing Restricted Local Operator Services. + +**SCEF PDN Connection:** The PDN connection to the SCEF. Unless otherwise indicated in a clause or clause, "PDN Connections" do not refer to any SCEF PDN Connection. + +**Tunnel Endpoint:** A tunnel endpoint is identified with a TEID, an IP address and a UDP port number (see clause 4.1 "GTP Tunnel"). + +**Tunnel Endpoint Identifier (TEID):** unambiguously identifies a tunnel endpoint in scope of a path (see clause 4.1 "GTP Tunnel"). + +### 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|------|----------------------------------| +| S1-U | Interface between SGW and eNodeB | +| X2 | Interface between eNodeBs | + +### 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|----------|---------------------------------------| +| 5GC | 5G Core Network | +| AMBR | Aggregate Maximum Bit Rate | +| APN | Access Point Name | +| APN-NI | Access Point Name Network Identifier | +| APN-OI | Access Point Name Operator Identifier | +| C-MSISDN | Correlation MSISDN | + +| | | +|---------|--------------------------------------------------| +| EBI | EPS Bearer ID | +| eNodeB | Evolved Node B | +| EPC | Evolved Packet Core | +| ePDG | Evolved Packet Data Gateway | +| EPS | Evolved Packet System | +| F-TEID | Fully Qualified Tunnel Endpoint Identifier | +| G-PDU | GTP-U non-signalling PDU | +| GPRS | General Packet Radio Service | +| GTP | GPRS Tunnelling Protocol | +| GTP-PDU | GTP-C PDU or GTP-U PDU | +| GTPv2-C | GTP version 2, control plane | +| GTPv2-U | GTP version 2, user plane | +| IMSI | International Mobile Subscriber Identity | +| IP | Internet Protocol | +| LBI | Linked EPS Bearer ID | +| L1 | Layer 1 | +| L2 | Layer 2 | +| LGW | Local Gateway | +| LIPA | Local IP Access | +| MBMS | Multimedia Broadcast/Multicast Service | +| MEI | Mobile Equipment Identity | +| MSISDN | Mobile Subscriber ISDN Number | +| MT-EDT | Mobile Terminated Early Data Transmission | +| NBIFOM | Network-based IP Flow Mobility | +| NTP | Network Time Protocol | +| PAA | PDN Address Allocation | +| PCO | Protocol Configuration Options | +| PDU | Protocol Data Unit | +| PDN | Packet Data Network or Public Data Network | +| PGW | PDN Gateway | +| PTI | Procedure Transaction Id | +| PSCell | Primary SCG (Secondary Cell Group) Cell | +| QoS | Quality of Service | +| RAT | Radio Access Technology | +| RIM | RAN Information Management | +| RLOS | Restricted Local Operator Services | +| SGW | Serving Gateway | +| SPID | Subscriber Profile ID for RAT/Frequency Priority | +| STN-SR | Session Transfer Number for SRVCC | +| TEID | Tunnel Endpoint Identifier | +| TEID-C | Tunnel Endpoint Identifier, control plane | +| TEID-U | Tunnel Endpoint Identifier, user plane | +| TFT | Traffic Flow Template | +| TLIV | Type Length Instance Value | +| TWAN | Trusted WLAN Access Network | +| UAS | Uncrewed Aerial System | +| UAV | Uncrewed Aerial Vehicle | +| UDP | User Datagram Protocol | +| ULI | User Location Information | +| USS | UAS Service Supplier | + +## 4 General + +### 4.1 GTP Tunnel + +GTP tunnels are used between two nodes communicating over a GTP based interface, to separate traffic into different communication flows. + +A GTP tunnel is identified in each node with a TEID, an IP address and a UDP port number. The receiving end side of a GTP tunnel locally assigns the TEID value the transmitting side has to use. The TEID value shall be assigned in a non-predictable manner for PGW S5/S8/S2a/S2b interfaces (see 3GPP TS 33.250 [85]). The TEID values are exchanged between tunnel endpoints using GTP-C or S1-MME or Iu-PS messages. The GTPv2 entity communicates to the peer GTPv2 entity the TEID value at which it expects to receive all subsequent control plane messages related to that GTP tunnel via the: + +- "Sender F-TEID for Control Plane" IE, +- "PGW S5/S8/S2a/S2b F-TEID for PMIP based interface or for GTP based Control Plane interface" IE, +- "MSC Server Sv TEID for Control Plane" IE, +- "S3/S16/S10 Address and TEID for Control Plane" IE, or +- "MME/SGSN Sv TEID for Control Plane" IE. + +The criteria defining when the same or different GTP tunnels shall be used between the two nodes differs between the control and the user plane, and also between interfaces. + +For the control plane, for each end-point of a GTP-C tunnel: + +- The TEID-C shall be unique per PDN-Connection on GTP based S2a, S2b, S5 and S8 interfaces. The same tunnel shall be shared for the control messages related to all bearers associated to the PDN-Connection. A TEID-C on the S2a/S2b/S5/S8 interface shall be released after all its associated EPS bearers are deleted. +- There shall be only one pair of TEID-Cs per UE on each of the S3, S10, S16 and N26 interfaces. The same tunnel shall be shared for the control messages related to the same UE operation. A TEID-C on the S3/S10/S16/N26 interface shall be released after its associated UE context is removed or the UE is detached. For the S3 interface, when ISR is active for the UE, during I-RAT handover between the ISR associated nodes, the existing S3 TEID-C may be re-used or new S3 TEID-C may be allocated. During this scenario, if the node decides to allocate new S3 TEID-C, it shall release its own old S3 TEID-C. +- There shall be only one pair of TEID-C per UE over the S11 and the S4 interfaces. The same tunnel shall be shared for the control messages related to the same UE operation. A TEID-C on the S11/S4 interface shall be released after all its associated EPS bearers are deleted. +- There shall be only one pair of TEID-C per MBMS Bearer Service (i.e. per TMGI and MBMS Flow Identifier, if the MBMS Flow Identifier is provided; or per TMGI, if the MBMS Flow Identifier is not provided) over the Sm and Sn interfaces respectively. The same tunnel shall be shared for the control messages related to the same MBMS Bearer Service. A TEID-C on the Sm/Sn interface shall be released after the MBMS Bearer Session is stopped. + +For GTP-U, a TEID-U is used according to 3GPP TS 29.281 [13]. + +NOTE: GTP-U is based on GTP version 1 (GTPv1). + +## 4.2 Protocol stack + +### 4.2.0 General + +The protocol stack for GTPv2 shall be as depicted in Figure 4.2.0-1. + +![Figure 4.2.0-1: GTPv2 stack diagram showing two GTPv2 entities connected via a GTPv2 based interface. Each entity has a protocol stack with layers GTP, UDP, IP, L2, and L1.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +The diagram illustrates the GTPv2 protocol stack for two entities. Each entity is represented by a vertical stack of five protocol layers: GTP (top), UDP, IP, L2, and L1 (bottom). The two stacks are separated by a vertical dashed line labeled "GTPv2 based interface". The entire diagram is enclosed in a rectangular box. + +Figure 4.2.0-1: GTPv2 stack diagram showing two GTPv2 entities connected via a GTPv2 based interface. Each entity has a protocol stack with layers GTP, UDP, IP, L2, and L1. + +**Figure 4.2.0-1: GTPv2 stack** + +The GTPv2 headers are specified in the respective clauses of this specification. + +The source and destination IP addresses and UDP ports used for each GTP-C message depend on the role that the message plays in a message exchange. A message can be an Initial message, or a Triggered message, or a Triggered Reply message to Triggered message. An Initial message is sent to a peer GTP entity with a sequence number chosen by the sending entity (see clause 7.6). A Triggered message is sent in response to an Initial message. Triggered Reply message may be sent in response to a Triggered message. See clause 7.6 for the sequence number usage. + +Typically, a Request message is an Initial message, but a Request message may be a Triggered messages in certain procedures where they are triggered by an Initial Command message. See clause 4.2.5 for classification of the Initial messages and their possible Triggered messages, as well as cases where there are Triggered Reply messages to the Triggered messages. + +Piggybacking is an optional feature, which is described in Annex F of 3GPP TS 23.401 [3]. If the feature is supported, then the piggybacking of the initial messages on triggered response messages for EUTRAN Initial Attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN (see clauses 8.6 and 16.11 of 3GPP TS 23.402 [45]) and UE-requested PDN Connectivity procedures shall be implemented as per requirements in clauses 4.2.0 and 5.5.1 of this specification. When piggybacking is used, a common IP header and a common UDP header shall be used for the triggered response message and the piggybacked initial message as depicted in Figure 4.2.0-2. Immediately following the triggered response message is the piggybacked initial message, following which no additional information shall be present. The clause 5.5 specifies the usage of piggybacking-specific fields in the GTP-C header. + +| IP header | UDP header | Triggered response message (P=1) | Piggybacked initial message (P=0) | +|-----------|------------|----------------------------------|-----------------------------------| +| | | | | + +**Figure 4.2.0-2: Packet Format for the Piggybacking of messages** + +## 4.2.1 UDP header and port numbers + +### 4.2.1.0 General + +A User Datagram Protocol (UDP) compliant with IETF RFC 768 [7] shall be used. + +#### 4.2.1.1 Initial Messages + +The UDP Destination Port number for GTPv2 Initial messages shall be 2123. It is the registered port number for GTP-C. + +The UDP Source Port for a GTPv2 Initial message is a locally allocated port number at the sending GTP entity. + +If GTPv2 and GTP' v2 modules are using the same IP address for sending messages, the implementation shall ensure that while some source port number is used by GTPv2 messages, the same source port number shall not be used by GTP' v2 messages. Otherwise, the IP interface may have difficulty to delivering a response message to the right protocol entity. + +#### 4.2.1.2 Triggered Messages + +The UDP Destination Port value of a GTPv2 Triggered message and for a Triggered Reply message shall be the value of the UDP Source Port of the corresponding message to which this GTPv2 entity is replying, except in the case of the SGSN pool scenario. + +The UDP Source Port of a GTPv2 Triggered message and for a Triggered Reply message shall be the value from the UDP Destination Port of the corresponding message to which this GTPv2 entity is replying, except in the case of the SGSN pool scenario. + +In the SGSN pool scenario, if the Identification Request, the Context Request or the Suspend Notification messages have been forwarded by another SGSN in the pool, the UDP Destination Port for the Identification Response, the Context Response or the Suspend Acknowledge message shall be determined in the following way. The value from the information element "UDP Source Port Number", which was sent in the corresponding forwarded request, shall be copied into the UDP Destination Port field. The UDP Source Port for the Identification Response, the Context Response or the Suspend Acknowledge message may be a locally allocated port number at the sending GTP entity. + +In the handover scenario when the CIoT feature is deployed, if the Forward Relocation Request message has been forwarded by the target MME, the UDP Destination Port for the Forward Relocation Response shall be set to the value of Source UDP Port Number IE included in the Forward Relocation Request message; the UDP Source Port for the Forward Relocation Response message may be a locally allocated port number at the sending GTP entity. + +#### 4.2.1.3 Piggybacked Messages + +A piggybacked initial message is carried as a concatenation after a triggered response message and they share a common UDP header (see Figure 4.2.0-2). + +The UDP Destination port for the IP packet containing both the triggered response message and the piggybacked initial message shall be the same as the port number used for the triggered response message. + +The UDP Source port for the IP packet containing both the triggered response message and the piggybacked initial message shall be the same as the port number used for the triggered response message. + +### 4.2.2 IP header and IP addresses + +#### 4.2.2.1 Initial Messages + +The IP Destination Address of a GTPv2 Initial message shall be an IP address of the destination GTPv2 entity. + +During the establishment of the GTP tunnel, the GTPv2 entity selects and communicates to the peer GTPv2 entity the IP Destination Address at which it expects to receive subsequent control plane Initial messages related to that GTP tunnel via the: + +- "Sender F-TEID for Control Plane" IE, +- "PGW S5/S8/S2a/S2b F-TEID for PMIP based interface or for GTP based Control Plane interface" IE, +- "MSC Server Sv Address for Control Plane" IE, +- "S3/S16/S10 Address and TEID for Control Plane" IE, or +- "MME/SGSN Sv Address for Control Plane" IE. + +A Create Session Request shall only include in the Sender F-TEID the same IP address type as the destination address used in the IP header. An IPv4/IPv6 capable SGW and PGW may advertize an IPv4 address and/or an IPv6 address in the F-TEID of the above IEs. + +Upon a change of MME, SGSN or SGW, the new MME, SGSN or SGW may switch to a different IP address type (e.g. IPv6 address) in the IP header if a different IP address type was advertized by the SGW or PGW earlier. A Modify Bearer Request shall only include in the Sender F-TEID the same IP address type as the destination address used in the IP header. + +NOTE 1: Advertizing a single IP address type in a Create Session Request or a Modify Bearer Request ensures that both GTP-C peers know without ambiguity the IP address type to be used in subsequent control plane Initial messages in the reverse direction related to that GTP-C tunnel, and it avoids intempestive IP address switching during the establishment of the GTP-C tunnel or during an established communication between two GTP-C peers. + +NOTE 2: IP switching between IPv4 and IPv6 can occur upon a change of MME/SGSN or SGW in deployments with MME/SGSNs or SGWs with different IPv6 capabilities. + +EXAMPLE 1: If an MME gets IPv4 addresses from the DNS for the SGW, the MME only includes an IPv4 address in the Sender F-TEID IE of the Create Session Request. In the response, the SGW advertises an IPv4 address and optionally an IPv6 address, and the SGW uses IPv4 addressing in subsequent control plane Initial messages it sends to the MME related to that GTP-C tunnel. + +EXAMPLE 2: As a continuation of EXAMPLE 1, upon a subsequent change of MMEs, assuming the source MME only supports IPv4 and the target MME supports IPv4 and IPv6, the target MME can switch to IPv6 addressing by sending a Modify Bearer Request to the SGW using the SGW S11 IPv6 address in the IP header and including a Sender F-TEID with an MME S11 IPv6 address only. + +During the network triggered service restoration procedure (see 3GPP TS 23.007 [17]), if an MME/S4-SGSN sends a Downlink Data Notification Failure Indication message to the SGW, then the destination address for this message shall be the SGW IP address signalled via the Sender F-TEID for Control Plane IE in the Downlink Data Notification message (if present in the message), otherwise the source IP address of the Downlink Data Notification message received earlier. + +The IP Source Address of a GTPv2 Initial message shall be an IP address of the source GTPv2 entity from which the Initial message is originating. + +#### 4.2.2.2 Triggered Messages + +The IP Destination Address of a GTPv2 Triggered message and for a Triggered Reply message shall be copied from the IP Source Address of the message to which this GTPv2 entity is replying, except in the case of the SGSN pool scenario. + +The IP Source Address of a GTPv2 Triggered message and for a Triggered Reply message shall be copied from the IP destination address of the message to which this GTPv2 entity is replying, except in the case of SGSN pool scenario and handover scenario when the CIoT feature is deployed. + +In the SGSN pool scenario, if the Identification Request, the Context Request or the Suspend Notification messages have been forwarded by another SGSN in the pool, the IP Source address for the Identification Response, the Context Response or the Suspend Acknowledge messages shall be locally allocated by the sending GTP entity. The IP Destination Address for the Identification Response, the Context Response or the Suspend Acknowledge messages shall be determined in the following way. The value from the information element "Address for Control Plane", which was sent in the corresponding Identification Request or the Suspend Notification message; or the value from the information element "S3/S16/S10 Address and TEID for Control Plane", which was sent in the corresponding Context Request message, shall be copied into the IP Destination Address field. + +In the handover scenario when the CIoT feature is deployed, if the Forward Relocation Request message has been forwarded by the target MME, the IP Source address of the Forward Relocation Response shall be locally allocated by the sending GTP entity. The IP Destination Address field of the Forward Relocation Response shall be set to the value of the "Sender's F-TEID for Control Plane" IE received in the Forward Relocation Request message. + +#### 4.2.2.3 Piggybacked Messages + +A piggybacked initial message is carried as a concatenation after a triggered response message and they share a common IP header (see Figure 4.2.0-2). + +The IP Source Address for the IP packet containing both the triggered response message and the piggybacked initial message shall be the same as the IP Address used for the triggered response message. + +The IP Destination Address for the IP packet containing both the triggered response message and the piggybacked initial message shall be the same as the IP Address used for the triggered response message. + +### 4.2.3 Layer 2 + +Typically Ethernet should be used as a Layer 2 protocol, but operators may use any other technology. + +### 4.2.4 Layer 1 + +Operators may use any appropriate Layer 1 technology. + +#### 4.2.5 Messages with GTPv2 defined replies: Classification of Initial and Triggered Messages + +An Initial message is a GTPv2 message that is not triggered as a response to another GTPv2 message across the given interface. + +The expected reply to a Request message is a Triggered message and the reply has the same message name as the Request but with "Response" replacing "Request". + +NOTE 1: If the SGW receives a "Create Session Request" on S11/S4, this can trigger either of the following GTPv2 messages across S5/S8: "Create Session Request" or "Modify Bearer Request". However, neither of these messages across S5/S8 is considered to be a Triggered message. + +If a Request message is a reply to a Command message, then the Request message is a Triggered message; otherwise the Request message is an Initial message. Responses do not have replies except when a "Context Acknowledge" is required as a reply to "Context Response" message as specified in relevant Stage 2 procedures. Context Acknowledge is always triggered message and does not have a reply. + +NOTE 2: The "Context Acknowledge" message is sent only if the "Context Response" message is received with the acceptance cause. + +A message whose name ends in "Command" is always an initial message. If a "Command" message fails, the name of the reply message is constructed by replacing "Command" with "Failure Indication". Apart from "Downlink Data Notification Failure Indication" message, a "Failure Indication" is a Triggered message. The "Failure Indication" message does not have a reply. If a "Command" message is successful, its reply will be a Request as specified in relevant Stage 2 procedures. + +A message whose name ends in "Notification" is always an Initial message. The expected Triggered message in reply has the same message name but with "Acknowledge" replacing "Notification", except for the case of the message "Downlink Data Notification" which has the reply "Downlink Data Notification Acknowledge" and "PGW Restart Notification" which has the reply "PGW Restart Notification Acknowledge". An "Acknowledge" message does not have a reply. + +CS Paging Indication, Stop Paging Indication, RAN Information Relay, Configuration Transfer Tunnel, Trace Session Activation, Trace Session Deactivation, ISR Status Indication and Downlink Data Notification Failure Indication messages are Initial messages that do not have a reply. + +A Version Not Supported Indication message is a Triggered message. + +## 4.3 Transmission Order and Bit Definitions + +The messages in this document shall be transmitted in network octet order starting with octet 1 with the Most Significant Bit sent first. + +The most significant bit of an octet in a GTP message is bit 8. If a value in a GTP message spans several octets and nothing else is stated, the most significant bit is bit 8 of the octet with the lowest number. + +# 5 GTP Header for Control Plane + +## 5.1 General format + +Control Plane GTP uses a variable length header. Control Plane GTP header length shall be a multiple of 4 octets. Figure 5.1-1 illustrates the format of the GTPv2-C Header. + +![](19a59d6b53059ebd27b13c98793f88e0_img.jpg) + +| Octets | Bits | | | | | | | | +|----------------|----------------------------------------------------------------------------------------------------------------|---|---|---|-------|-------|-------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Version | | P | T | Spare | Spare | Spare | | +| 2 | Message Type | | | | | | | | +| 3 | Message Length (1 st Octet) | | | | | | | | +| 4 | Message Length (2 nd Octet) | | | | | | | | +| m to
k(m+3) | If T flag is set to 1, then TEID shall be placed into octets 5-8. Otherwise, TEID field is not present at all. | | | | | | | | +| n to (n+2) | Sequence Number | | | | | | | | +| (n+3) | Spare | | | | | | | | + +**Figure 5.1-1: General format of GTPv2 Header for Control Plane** + +Where: + +- if T = 0, TEID field is not present, k = 0, m = 0 and n = 5; +- if T = 1, TEID field is present, k = 1, m = 5 and n = 9. + +The usage of GTPv2-C header across the EPC specific interfaces is defined in the clause 5.5 "Usage of the GTPv2-C Header". Octet 1 bits shall be coded as follows: + +- Bits 6-8 represent the Version field. +- Bit 5 represents the Piggybacking flag (P). +- Bit 4 represents the TEID flag (T). +- Bits 3-1 are spare, the sender shall set them to "0" and the receiving entity shall ignore them. + +## 5.2 Control Plane GTP Extension Header + +The legacy Extension Header mechanism is not used for the GTP version 2 control plane (GTPv2-C). Future extensions will be implemented by adding Information Elements in the message body if new parameters are needed. + +## 5.3 GTP-C header for Echo and Version Not Supported Indication messages + +The GTPv2-C message header for the Echo Request, Echo Response and Version Not Supported Indication messages shall not contain the TEID field, but shall contain the Sequence Number fields, followed by one spare octet as depicted in figure 5.3-1. The spare bits shall be set to zero by the sender and ignored by the receiver. For the Version Not Supported Indication message header, the Sequence Number may be set to any number and shall be ignored by the receiver. + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------------|---|---|---|-----|-------|-------|-------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Version | | | P | T=0 | Spare | Spare | Spare | +| 2 | Message Type | | | | | | | | +| 3 | Message Length (1 st Octet) | | | | | | | | +| 4 | Message Length (2 nd Octet) | | | | | | | | +| 5 | Sequence Number (1 st Octet) | | | | | | | | +| 6 | Sequence Number (2 nd Octet) | | | | | | | | +| 7 | Sequence Number (3 rd Octet) | | | | | | | | +| 8 | Spare | | | | | | | | + +Figure 5.3-1: The format of Echo and Version Not Supported Indication messages Header + +## 5.4 EPC specific GTP-C header + +Apart from the Echo Request, Echo Response and Version Not Supported Indication messages, the GTP-C message header shall contain the TEID and Sequence Number fields followed by one spare octet. A typical GTP-C header is depicted in figure 5.4-1. The spare bits shall be set to zero by the sender and ignored by the receiver. + +| Octets | Bits | | | | | | | | +|--------|----------------------------------------------------|---|---|---|-------|----|-------|-------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Version | | | P | T=1 | MP | Spare | Spare | +| 2 | Message Type | | | | | | | | +| 3 | Message Length (1 st Octet) | | | | | | | | +| 4 | Message Length (2 nd Octet) | | | | | | | | +| 5 | Tunnel Endpoint Identifier (1 st Octet) | | | | | | | | +| 6 | Tunnel Endpoint Identifier (2 nd Octet) | | | | | | | | +| 7 | Tunnel Endpoint Identifier (3 rd Octet) | | | | | | | | +| 8 | Tunnel Endpoint Identifier (4 th Octet) | | | | | | | | +| 9 | Sequence Number (1 st Octet) | | | | | | | | +| 10 | Sequence Number (2 nd Octet) | | | | | | | | +| 11 | Sequence Number (3 rd Octet) | | | | | | | | +| 12 | Message Priority | | | | Spare | | | | + +Figure 5.4-1: The format of EPC specific GTPv2 Control Plane message Header + +## 5.5 Usage of the GTPv2-C Header + +### 5.5.1 General + +The format of the GTPv2-C header is specified in clause 5.1 "General format". The usage of the GTP-C header across e.g. S101/S121 (3GPP TS 29.276 [14]) and Sv (3GPP TS 29.280 [15]) interfaces are defined in their respective specifications. + +The usage of the GTPv2-C header for EPC specific interfaces shall be as defined below. + +The first octet of the header shall be used is the following way: + +- Bits 8 to 6, which represent the GTP-C version, shall be set to decimal 2 ("010"). +- Bit 5 represents a "P" flag. If the "P" flag is set to "0", no piggybacked message shall be present. If the "P" flag is set to "1", then another GTPv2-C message with its own header and body shall be present at the end of the current message. + +When present, a piggybacked message shall have its "P" flag set to "0" in its own header. If a Create Session Response message (as part of EUTRAN initial attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN (see clauses 8.6 and 16.11 of 3GPP TS 23.402 [45]) or UE-requested PDN connectivity procedure) has the "P" flag set to "1", then a single Create Bearer Request message shall be present as the + +piggybacked message. As a response to the Create Bearer Request message, if the Create Bearer Response has the "P" flag set to "1", then a single Modify Bearer Request (as part of EUTRAN initial attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN (see clauses 8.6 and 16.11 of 3GPP TS 23.402 [45]) or UE-requested PDN connectivity procedure) shall be present as the piggybacked message. A Create Bearer Response with "P" flag set to "1" shall not be sent unless a Create Session Response with "P" flag set to "1" has been received for the same procedure. Apart from Create Session Response and Create Bearer Response messages, all the EPC specific messages shall have the "P" flag set to "0". + +- Bit 4 represents a "T" flag, which indicates if TEID field is present in the GTP-C header or not. If the "T" flag is set to 0, then the TEID field shall not be present in the GTP-C header. If the "T" flag is set to 1, then the TEID field shall immediately follow the Length field, in octets 5 to 8. Apart from the Echo Request, Echo Response and Version Not Supported Indication messages, in all EPC specific messages the value of the "T" flag shall be set to "1". +- Bit 3 represents a "MP" flag. If the "MP" flag is set to "1", then bits 8 to 5 of octet 12 shall indicate the message priority. +- Bit 2 is a spare bit. The sending entity shall set it to "0" and the receiving entity shall ignore it. +- Bit 1 is a spare bit. The sending entity shall set it to "0" and the receiving entity shall ignore it. + +The usage of the fields in octets 2 - n of the header shall be as specified below. + +- Octet 2 represents the Message type field, which shall be set to the unique value for each type of control plane message. Message type values are specified in Table 6.1-1 "Message types for GTPv2". +- Octets 3 to 4 represent the Message Length field. This field shall indicate the length of the message in octets excluding the mandatory part of the GTP-C header (the first 4 octets). The TEID (if present) and the Sequence Number shall be included in the length count. The format of the Length field of information elements is specified in clause 8.2 "Information Element Format". +- A piggybacked initial message and the preceding triggered response message present in the common IP/UDP packet shall have their own length and sequence number in their respective GTP-C headers. The overall length of the IP/UDP packet shall indicate the total length of the two GTP-C messages. +- For EPC specific interfaces, T=1, and therefore octets 5 to 8 represent the Tunnel Endpoint Identifier (TEID) field. This field shall unambiguously identify a tunnel endpoint in the receiving GTP-C entity. The Tunnel Endpoint Identifier is set by the sending entity in the GTP header of all control plane messages to the TEID value provided by the corresponding receiving entity (see clause 4.1). If a peer's TEID is not available the TEID field shall be present in a GTPv2-C header, but its value shall be set to "0", as specified in clause 5.5.2 "Conditions for sending TEID=0 in GTPv2-C header". + +NOTE: The TEID in the GTP header of a Triggered (or Triggered Reply) message is set to the TEID value provided by the corresponding receiving entity regardless of whether the source IP address of the Initial (or Triggered) message and the IP Destination Address provided by the receiving entity for subsequent control plane Initial messages (see clause 4.2.2.1) are the same or not. + +- Octets 9 to 11 represent GTP Sequence Number field. +- Bits 8 to 5 of octet 12 shall indicate the relative priority of the GTP-C message, if the "MP" flag is set to 1 in Octet 1. It shall be encoded as the binary value of the Message Priority and it may take any value between 0 and 15, where 0 corresponds to the highest priority and 15 the lowest priority. + +If the "MP" flag is set to "0" in Octet 1, bits 8 to 5 of octet 12 shall be set to "0" by the sending entity and ignored by the receiving entity. + +- Bits 4 to 1 of octet 12 are spare bits. The sending entity shall set them to "0" and the receiving entity shall ignore them. + +## 5.5.2 Conditions for sending TEID=0 in GTPv2-C header + +If a peer's TEID is not available, the TEID field still shall be present in the header and its value shall be set to "0" in the following messages: + +- Create Session Request message on S2a/S2b/S5/S8 +- Create Session Request message on S4/S11, if for a given UE, the SGSN/MME has not yet obtained the Control TEID of the SGW. + +- Create Indirect Data Forwarding Tunnel Request message on S4/S11, if the SGW selected by the MME/S4-SGSN for indirect data forwarding is different from the SGW used as anchor. +- Identification Request/Response messages. +- Forward Relocation Request message over the S10, S16 and N26 interfaces, and over the S3 interface during I-RAT handover when ISR is not active. +- Forward Relocation Request message over the S3 interface during I-RAT handover between ISR associated nodes, when ISR is active for the UE, and if the node decides to allocate new S3 TEID-C. +- Context Request message over the S10, S16, S3 and N26 interfaces. +- Relocation Cancel Request message over the S10, S16, S3 and N26 interfaces, except for the case where the old SGSN/MME or AMF has already been assigned the Tunnel Endpoint Identifier Control Plane of the new SGSN/MME or AMF. +- Relocation Cancel Response message over the S10, S16, S3 and N26 interfaces if the new SGSN/MME or AMF does not have the Tunnel Endpoint Identifier Control Plane of the old SGSN/MME or AMF. +- Delete PDN Connection Set Request/Response messages. +- Configuration Transfer Tunnel message. +- RAN Information Relay message. +- If a node receives a message and the TEID-C in the GTPv2 header of the received message is not known, it shall respond with "Context not found" Cause in the corresponding response message to the sender, the TEID used in the GTPv2-C header in the response message shall be then set to zero. +- If a node receives a request message containing protocol error, e.g. Mandatory IE missing, which requires the receiver to reject the message as specified in clause 7.7, it shall reject the request message. For the response message, the node should look up the remote peer's TEID and accordingly set the GTPv2-C header TEID and the message cause code. As an implementation option, the node may not look up the remote peer's TEID and set the GTPv2-C header TEID to zero in the response message. However in this case, the cause code shall not be set to "Context not found". +- MBMS Session Start Request message. +- PGW Restart Notification / PGW Restart Notification Acknowledge messages. +- Downlink Data Notification message sent on S11/S4 as part of the Network Triggered Service Restoration procedure (see 3GPP TS 23.007 [17]), and corresponding Downlink Data Notification Acknowledge and Downlink Data Notification Failure Indication if the SGW did not include the Sender F-TEID for Control Plane IE in the Downlink Data Notification message. +- Stop Paging Indication message is sent to the the restarted CN node (or another node in the same pool) as part of the Network Triggered Service Restoration procedure with ISR (see 3GPP TS 23.007 [17]). +- Suspend Notification and Suspend Acknowledge messages: over S16 interface; over S3 interface when ISR is not active. +- PGW Downlink Triggering Notification message on S5 and S11/S4, PGW Downlink Triggering Acknowledge message on S11/S4, and PGW Downlink Triggering Acknowledge message on S5 if the PGW did not include the Sender F-TEID for Control Plane IE in the PGW Downlink Triggering Notification message. +- UE Registration Query Request and UE Registration Query Response messages over S3 interface. + +NOTE: Legacy implementation conforming to earlier versions of this specification can send the Change Notification Request/Response messages on the TEID zero in spite of the peer's node TEID being available. + +## 5.6 Format of the GTPv2-C Message + +The GTP-C header may be followed by subsequent information elements dependent on the type of control plane message. + +![](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +| Octets | Bits | | | | | | | | +|----------|-------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to m | GTP-C header | | | | | | | | +| m+1 to n | Zero or more Information Element(s) | | | | | | | | + +Figure 5.6-1: GTP-C Header followed by subsequent Information Elements + +--- + +## 6 GTP-C Message Types and Message Formats + +### 6.0 General + +A GTP-C message is sent across a GTP control plane tunnel. In a message, the GTP-C header is followed by zero or more information elements. The GTP-C messages are used for the control plane path management, for the control plane tunnel management and for mobility management. + +A T-PDU is an original packet, for example an IP datagram, from an UE, or from a network node in an external packet data network. + +### 6.1 Message Format and Type values + +#### 6.1.0 Message Type + +GTP defines a set of messages between two associated EPC network elements. The messages to be used shall be as defined in Table 6.1-1. + +**Table 6.1-1: Message types for GTPv2** + +| Message Type value (Decimal) | Message | Reference | Initial | Triggered | +|------------------------------|------------------------------------------------------------------------------------------------------------------|----------------|---------|-----------| +| 0 | Reserved | | | | +| 1 | Echo Request | | X | | +| 2 | Echo Response | | | X | +| 3 | Version Not Supported Indication | | | X | +| 4 to 16 | Reserved for S101 interface | TS 29.276 [14] | | | +| 17 to 24 | Reserved for S121 interface | TS 29.276 [14] | | | +| 25 to 31 | Reserved for Sv interface | TS 29.280 [15] | | | +| | SGSN/MME/ TWAN/ePDG to PGW (S4/S11, S5/S8, S2a, S2b) | | | | +| 32 | Create Session Request | | X | | +| 33 | Create Session Response | | | X | +| 36 | Delete Session Request | | X | | +| 37 | Delete Session Response | | | X | +| | SGSN/MME/ePDG to PGW (S4/S11, S5/S8, S2b) | | | | +| 34 | Modify Bearer Request | | X | | +| 35 | Modify Bearer Response | | | X | +| | MME to PGW (S11, S5/S8) | | | | +| 40 | Remote UE Report Notification | | X | | +| 41 | Remote UE Report Acknowledge | | | X | +| | SGSN/MME to PGW (S4/S11, S5/S8) | | | | +| 38 | Change Notification Request | | X | | +| 39 | Change Notification Response | | | X | +| 42 to 63 | For future use | | | | +| 164 | Resume Notification | | X | | +| 165 | Resume Acknowledge | | | X | +| | Messages without explicit response | | | | +| 64 | Modify Bearer Command
(MME/SGSN/ TWAN/ePDG to PGW – S11/S4, S5/S8, S2a, S2b) | | X | | +| 65 | Modify Bearer Failure Indication
(PGW to MME/SGSN/ TWAN/ePDG – S5/S8, S11/S4, S2a, S2b) | | | X | +| 66 | Delete Bearer Command
(MME/SGSN to PGW – S11/S4, S5/S8) | | X | | +| 67 | Delete Bearer Failure Indication
(PGW to MME/SGSN – S5/S8, S11/S4)) | | | X | +| 68 | Bearer Resource Command
(MME/SGSN/TWAN/ePDG to PGW – S11/S4, S5/S8, S2a, S2b) | | X | | +| 69 | Bearer Resource Failure Indication
(PGW to MME/SGSN/TWAN/ePDG – S5/S8, S11/S4, S2a, S2b) | | | X | +| 70 | Downlink Data Notification Failure Indication
(SGSN/MME to SGW – S4/S11) | | X | | +| 71 | Trace Session Activation
(MME/SGSN/ TWAN/ePDG to PGW – S11/S4, S5/S8, S2a, S2b) | | X | | +| 72 | Trace Session Deactivation
(MME/SGSN/ TWAN/ePDG to PGW – S11/S4, S5/S8, S2a, S2b) | | X | | +| 73 | Stop Paging Indication
(SGW to MME/SGSN – S11/S4) | | X | | +| 74 to 94 | For future use | | | | +| | PGW to SGSN/MME/ TWAN/ePDG (S5/S8, S4/S11, S2a, S2b) | | | | +| 95 | Create Bearer Request | | X | X | +| 96 | Create Bearer Response | | | X | +| 97 | Update Bearer Request | | X | X | +| 98 | Update Bearer Response | | | X | +| 99 | Delete Bearer Request | | X | X | +| 100 | Delete Bearer Response | | | X | +| | PGW to MME, MME to PGW, SGW to PGW, SGW to MME, PGW to TWAN/ePDG, TWAN/ePDG to PGW (S5/S8, S11, S2a, S2b) | | | | +| 101 | Delete PDN Connection Set Request | | X | | +| 102 | Delete PDN Connection Set Response | | | X | +| | PGW to SGSN/MME (S5, S4/S11) | | | | +| 103 | PGW Downlink Triggering Notification | | X | | +| 104 | PGW Downlink Triggering Acknowledge | | | X | + +| Message Type value (Decimal) | Message | Reference | | | | Initial | Triggered | +|------------------------------|----------------------------------------------------------------------------------------------------|-----------|-----|-----|-----|---------|-----------| +| | | S3 | S10 | S16 | N26 | | | +| 105 to 127 | For future use | | | | | | | +| | MME to MME, SGSN to MME, MME to SGSN, SGSN to SGSN, MME to AMF, AMF to MME (S3/S10/S16/N26) | | | | | | | +| 128 | Identification Request | X | X | X | X | X | | +| 129 | Identification Response | X | X | X | X | | X | +| 130 | Context Request | X | X | X | X | X | | +| 131 | Context Response | X | X | X | X | | X | +| 132 | Context Acknowledge | X | X | X | X | | X | +| 133 | Forward Relocation Request | X | X | X | X | X | | +| 134 | Forward Relocation Response | X | X | X | X | | X | +| 135 | Forward Relocation Complete Notification | X | X | X | X | X | | +| 136 | Forward Relocation Complete Acknowledge | X | X | X | X | | X | +| 137 | Forward Access Context Notification | - | X | X | - | X | | +| 138 | Forward Access Context Acknowledge | - | X | X | - | | X | +| 139 | Relocation Cancel Request | X | X | X | X | X | | +| 140 | Relocation Cancel Response | X | X | X | X | | X | +| 141 | Configuration Transfer Tunnel | - | X | - | X | X | | +| 142 to 148 | For future use | | | | | | | +| 152 | RAN Information Relay | X | - | X | - | X | | +| | SGSN to MME, MME to SGSN (S3) | | | | | | | +| 149 | Detach Notification | | | | | X | | +| 150 | Detach Acknowledge | | | | | | X | +| 151 | CS Paging Indication | | | | | X | | +| 153 | Alert MME Notification | | | | | X | | +| 154 | Alert MME Acknowledge | | | | | | X | +| 155 | UE Activity Notification | | | | | X | | +| 156 | UE Activity Acknowledge | | | | | | X | +| 157 | ISR Status Indication | | | | | X | | +| 158 | UE Registration Query Request | | | | | X | | +| 159 | UE Registration Query Response | | | | | | X | +| | SGSN/MME to SGW, SGSN to MME (S4/S11/S3) | | | | | | | +| | SGSN to SGSN (S16), SGW to PGW (S5/S8) | | | | | | | +| 162 | Suspend Notification | | | | | X | | +| 163 | Suspend Acknowledge | | | | | | X | +| | SGSN/MME to SGW (S4/S11) | | | | | | | +| 160 | Create Forwarding Tunnel Request | | | | | X | | +| 161 | Create Forwarding Tunnel Response | | | | | | X | +| 166 | Create Indirect Data Forwarding Tunnel Request | | | | | X | | +| 167 | Create Indirect Data Forwarding Tunnel Response | | | | | | X | +| 168 | Delete Indirect Data Forwarding Tunnel Request | | | | | X | | +| 169 | Delete Indirect Data Forwarding Tunnel Response | | | | | | X | +| 170 | Release Access Bearers Request | | | | | X | | +| 171 | Release Access Bearers Response | | | | | | X | +| 172 to 175 | For future use | | | | | | | +| | SGW to SGSN/MME (S4/S11) | | | | | | | +| 176 | Downlink Data Notification | | | | | X | | +| 177 | Downlink Data Notification Acknowledge | | | | | | X | +| 179 | PGW Restart Notification | | | | | X | | +| 180 | PGW Restart Notification Acknowledge | | | | | | X | +| | SGW to SGSN (S4) | | | | | | | +| 178 | Reserved. Allocated in earlier version of the specification. | | | | | | | +| 181 to 199 | For future use | | | | | | | +| | SGW to PGW, PGW to SGW (S5/S8) | | | | | | | +| 200 | Update PDN Connection Set Request | | | | | X | | +| 201 | Update PDN Connection Set Response | | | | | | X | +| 202 to 210 | For future use | | | | | | | +| | MME to SGW (S11) | | | | | | | +| 211 | Modify Access Bearers Request | | | | | X | | +| 212 | Modify Access Bearers Response | | | | | | X | +| 213 to 230 | For future use | | | | | | | +| | MBMS GW to MME/SGSN (Sm/Sn) | | | | | | | + +| Message Type value (Decimal) | Message | Reference | Initial | Triggered | +|------------------------------|-----------------------------------------------------|----------------|---------|-----------| +| 231 | MBMS Session Start Request | | X | | +| 232 | MBMS Session Start Response | | | X | +| 233 | MBMS Session Update Request | | X | | +| 234 | MBMS Session Update Response | | | X | +| 235 | MBMS Session Stop Request | | X | | +| 236 | MBMS Session Stop Response | | | X | +| 237 to 239 | For future use | | | | +| | Other | | | | +| 240 to 247 | Reserved for Sv interface (see also types 25 to 31) | TS 29.280 [15] | | | +| 248 to 255 | For future use | | | | + +### 6.1.1 Presence requirements of Information Elements + +There are four different presence requirements (Mandatory, Conditional, Optional, or Conditional-Optional) for an IE within a given GTP-PDU: + +- Mandatory means that the IE shall be included by the sending side, and that the receiver diagnoses a "Mandatory IE missing" error, when detecting that the IE is not present. A response including a "Mandatory IE missing" cause, shall include the type of the missing IE. +- Conditional means: + - that the IE shall be included by sending entity if the conditions specified in the relevant protocol specification are met; + - the receiver shall check the conditions as specified in the corresponding message type description, based on the parameter combination in the message and/or on the state of the receiving node, to infer if a conditional IE shall be expected. Only if a receiver has sufficient information the following applies. A conditional IE, which is absolutely necessary for the receiving entity to complete the procedure, is missing, then the receiver shall abort the procedure. +- Conditional-Optional means: + - that the IE shall be included by the up-to-date sending entity, if the conditions specified in the relevant protocol specification are met. An entity, which is at an earlier version of the protocol and therefore is not up-to-date, obviously cannot send such new IE. + - the receiver need not check the presence of the IE in the message. If the receiver checks the presence of the Conditional-Optional IE, then the IE's absence shall not trigger any of the error handling procedures. The handling of an absence or erroneous such IEs shall be treated as Optional IEs as specified in clause 7.7 "Error Handling". +- Optional means: + - that the IE shall be included as a service option. Therefore, the IE may be included or not in a message. The handling of an absent optional IE, or an erroneous optional IE is specified in clause 7.7 "Error Handling". + +For conditional IEs, the clause describing the GTP-PDU explicitly defines the conditions under which the inclusion of each IE becomes mandatory or optional for that particular GTP-PDU. These conditions shall be defined so that the presence of a conditional IE only becomes mandatory if it is critical for the receiving entity. The definition might reference other protocol specifications for final terms used as part of the condition. + +For grouped IEs, the presence requirement of the embedded IE shall follow the rules: + +- The grouped IE is Mandatory within a given message: the presence requirements of individual embedded IEs are as stated within the Mandatory grouped IE for the given message. +- The grouped IE is Conditional within a given message: if the embedded IE in the grouped IE is Mandatory or Conditional, this embedded IE is viewed as Conditional IE by the receiver. If the embedded IE in the grouped IE is Conditional-Optional, this embedded IE is viewed as Optional IE by the receiver. If the embedded IE in the grouped IE is Optional, this embedded IE is viewed as Optional IE by the receiver. +- The grouped IE is Conditional-Optional within a given message: if the embedded IE in the grouped IE is Mandatory or Conditional, this embedded IE is viewed as Conditional-Optional IE by the receiver. If the embedded IE in the grouped IE is Conditional-Optional, this embedded IE is viewed as Optional IE by the receiver. + +receiver. If the embedded IE in the grouped IE is Optional, this embedded IE is viewed as Optional IE by the receiver. + +- The grouped IE is Optional within a given message: all embedded IEs in the grouped IE are viewed as Optional IEs by the receiver. + +In all of the above cases, appropriate error handling as described in clause 7.7 shall be applied for protocol errors of the embedded IEs. + +Only the Cause information element at message level shall be included in the response if the Cause contains a value that indicates that the request is not accepted regardless of whether there are other mandatory or conditional information elements defined for a given response message. + +The following are exceptions: + +- Optionally, the Protocol Configuration Options, Recovery, User Location Information (ULI), Load Control Information, Overload Control Information, Bearer Context and Local Distinguished Name (LDN) information elements may be included. +- For the rejection response of a Forward Relocation Request, the Forward Relocation Response message may also include an F-Cause IE as specified in clause 7.3.2. +- For the rejection response of a SRVCC PS to CS Request, the SRVCC PS to CS Response message may also include an SRVCC Cause IE as specified in clause 5.2.3 in 3GPP TS 29.280 [15]. +- A Downlink Data Notification Acknowledge (with or) without an indication of success may also include a DL low priority traffic Throttling IE and the IMSI IE. +- The PGW Back-Off Time IE may also be returned when rejecting a Create Session Request with the cause "APN Congestion". +- Change Notification Response message may also include the IMSI and MEI information elements. +- Failure Indication type messages do not have "Accept" types of Cause values, i.e. all used values indicate the rejection, therefore for Failure Indication type of triggered messages, other information elements, other than the Cause IE, shall also be included according to the conditions of presence specified in the respective message, if they are available. +- The Context Response message (sent by an SGSN or MME) should also include the IMSI IE if the Cause IE contains the value "P-TMSI Signature mismatch", except if the UE is emergency or RLOS attached and the UE is UICCCless. +- The Create Bearer Response message, the Update Bearer Response message and the Delete Bearer Response message shall include the RAN/NAS Cause IE according to the conditions specified in clauses 7.2.4, 7.2.16 and 7.2.10.2. +- The UE Registration Query Response message shall include IMSI to allow the SGSN to correlate the response message with the corresponding request. + +If the Cause information element at Grouped IE level contains a value that indicates that the Grouped IE is not handled correctly, e.g. "Context Not Found" at Bearer Context IE level, the other information elements in this Grouped IE, other than the Cause IE, may not be included. + +## 6.1.2 Grouped Information Elements + +Information elements can contain other IEs. This type of IE is called "Grouped IEs". + +Grouped IEs have a length value in the TLIV encoding, which includes the added length of all the embedded IEs. Overall coding of a grouped information element with 4 octets long IE header is defined in clause 8.2 "Information Element Format". Each information element within a grouped IE also shall also contain 4 octets long IE header. + +Grouped IEs are not marked by any flag or limited to a specific range of IE type values. The clause describing an IE in this specification shall explicitly state if it is grouped. + +NOTE 1: Each entry into each Grouped IE creates a new scope level. Exit from the grouped IE closes the scope level. The GTPv2 message level is the top most scope. This is analogous to the local scope of a subroutine/function. + +If more than one grouped information elements of the same type, but for a different purpose are sent with a message, these IEs shall have different Instance values. + +If more than one grouped information elements of the same type and for the same purpose are sent with a message, these IEs shall have exactly the same Instance value to represent a list. + +NOTE 2: For instance, all "Bearer Contexts Modified" IEs of the type "Bearer Context" in a "Modify Bearer Response" message shall have the Instance value of 0, while all "Bearer Contexts Marked for Removal" IEs of the type "Bearer Context" in the same message shall have the Instance value of 1. + +### 6.1.3 Information Element instance + +Every GTPv2 message and grouped IE within a message in this specification has a column documenting the instance value of each IE. + +When a GTPv2 message is encoded for use the instance value of each included IE is encoded in the Instance field of the IE for the message scope. See clause 7 and clause 8.2 for details of that encoding. + +An Information Element in an encoded GTPv2 message or encoded grouped IE is identified by the pair of IE Type and Instance values and described by a specific row in the corresponding tables in clauses of 7 in the present document. + +If several Information Elements with the same Type and Instance values are included in an encoded GTPv2 message, they represent a list for the corresponding IE name and row identified in the message grammar in clauses of clause 7. + +If several Information Elements with the same Type and Instance values are included in an encoded grouped IE, they represent a list for the corresponding IE name and row identified in the grouped IE grammar in clauses of clause 7. + +In tables in this document the instance value for "Private Extension" is marked as VS (Vendor Specific). While an instance value must be encoded by the sender the value can be Vendor and even Private Extension specific. + +The same IE name might be used in different messages (on the top level or within grouped IEs) in this specification. The instance value and name of an IE is only meaningful within the scope of the message definition. The combination of Type value and Instance value uniquely identifies a specific row in a message description table. + +## 6.2 Message Granularity + +The GTPv2-C messages shall be sent per UE on the S3, S10, S16 and N26 interfaces. + +The GTPv2-C messages shall be sent per PDN-Connection on the S2a, S2b, S4, S11, S5 and S8 interfaces apart from the following exclusion. + +The following GTPv2-C messages are sent per UE on the S4 and S11 interfaces: + +- Downlink Data Notification / Acknowledge / Failure Indication; +- Stop Paging Indication; +- Delete Indirect Data Forwarding Tunnel Request/Response; +- Delete Session Request/Response with Scope Indication set to 1 during following procedures with SGW change: + - Tracking Area Update procedure; + - Routing Area Update procedure; + - Handover procedure; + - SRNS Relocation Cancel Using S4; + - Inter RAT handover Cancel procedure; + - S1 based handover cancel procedure; +- Delete Bearer Request/Response during a TAU/RAU/Handover procedure if the Cause value "ISR deactivation" is included in the Delete Session Request message, or when it is sent to delete the bearer resources on the other ISR associated CN node if the ISRAI flag is not set in the Modify Bearer Request/Modify Access Bearers Request message. +- Release Access Bearers Request/Response; +- Create Indirect Data Forwarding Tunnel Request/Response; + +- Trace Session Activation; +- Trace Session Deactivation; +- Create Forwarding Tunnel Request/Response. + +The following GTPv2-C messages are sent per UE on the S11 interface: + +- Modify Access Bearers Request/Response. + +The following GTPv2-C messages are sent per GTP-C entity on the S2a, S2b, S5, S8, and S11 interfaces: + +- Delete PDN Connection Set Request/Response. + +The following GTPv2-C messages are sent per GTP-C entity on the S5 and S8 interfaces: + +- Update PDN Connection Set Request/Response. + +The following GTPv2-C messages are sent per GTP-C entity on the S4 and S11 interfaces: + +- PGW Restart Notification/Acknowledge. + +The following GTPv2-C path management messages are sent per GTP-C entity on all GTPv2-C interfaces: + +- Echo Request/Response; +- Version Not Supported Indication. + +## 7 GTP-C messages + +### 7.1 Path Management Messages + +#### 7.1.0 General + +Three path management messages are specified for GTP-C: Echo Request, Echo Response and Version Not Supported Indication. + +The usage of Echo Request / Response procedure is specified in 3GPP TS 23.007 [17]. + +#### 7.1.1 Echo Request + +Table 7.1.1-1 specifies the information elements included in the Echo Request message. + +The Recovery information element contains the local Restart Counter, which is specified in 3GPP TS 23.007 [17]) + +The optional Private Extension contains vendor or operator specific information. + +**Table 7.1.1-1: Information Elements in Echo Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-----------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Recovery | M | | Recovery | 0 | +| Sending Node Features | CO | This IE shall be sent towards a peer node on any GTPv2 interface if the sending node supports at least one feature on this interface or if the sending node supports at least one feature and does not know the interface type towards the peer node. This IE may be present otherwise. | Node Features | 0 | +| Private Extension | O | | Private Extension | VS | + +#### 7.1.2 Echo Response + +Table 7.1.2-1 specifies the information elements included in the Echo Response message. + +The Recovery information element contains the local Restart Counter, which is specified in 3GPP TS 23.007 [17]) + +The optional Private Extension contains vendor or operator specific information. + +**Table 7.1.2-1: Information Elements in Echo Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-----------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Recovery | M | | Recovery | 0 | +| Sending Node Features | CO | This IE shall be sent towards a peer node on any GTPv2 interface if the sending node supports at least one feature on this interface or if the sending node supports at least one feature and does not know the interface type towards the peer node. This IE may be present otherwise. | Node Features | 0 | +| Private Extension | O | | Private Extension | VS | + +NOTE: Having no Cause IE in the Echo Response message is an exceptional case for a triggered message. Hence, a GTP entity that detects a GTP protocol error, e.g Mandatory IE missing, in the Echo Request message, ignores the IE(s) that are in error and sends Echo Response. In addition it can log the error. + +### 7.1.3 Version Not Supported Indication + +This message contains only the GTPv2 header and indicates the latest GTP version that the sending entity supports. + +## 7.2 Tunnel Management Messages + +### 7.2.0 General + +A node shall include the Recovery information element if it is in contact with the node's peer for the first time, or if the node or the node's peer has restarted recently and the new Restart Counter value has not yet been indicated to the peer. The peer receiving the Recovery information element shall handle it as when an Echo Response message is received but shall consider the rest of the message in accordance with the message semantics and parameters. + +### 7.2.1 Create Session Request + +The direction of this message shall be from MME/S4-SGSN to SGW and from SGW to PGW, and from ePDG/TWAN to the PGW (see Table 6.1-1). + +The Create Session Request message shall be sent on the S11 interface by the MME to the SGW, and on the S5/S8 interface by the SGW to the PGW as part of the procedures: + +- E-UTRAN Initial Attach when a PDN connection needs to be established through the SGW and PGW +- Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN with GTP on S5/S8 interface (see clauses 8.2, 8.6 and 16.11 of 3GPP TS 23.402 [45]) +- UE requested PDN connectivity when a PDN connection needs to be established through the SGW and PGW +- Addition of a 3GPP access of NBIFOM procedure as specified by 3GPP TS 23.161 [71] +- Restoration of PDN connections after an PGW-C/SMF change as specified in 3GPP TS 23.007 [17] + +The message shall also be sent on S4 interface by the SGSN to the SGW, and on the S5/S8 interface by the SGW to the PGW as part of the procedures: + +- PDP Context Activation +- Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN with GTP on S5/S8 interface (see clauses 8.2, 8.6 and 16.11 of 3GPP TS 23.402 [45]) +- Addition of a 3GPP access of the NBIFOM procedure as specified by 3GPP TS 23.161 [71] + +The message shall also be sent on the S11 interface by the MME to the SGW as part of the procedures: + +- Tracking Area Update procedure with Serving GW change +- S1/X2-based handover with SGW change +- UTRAN Iu mode to E-UTRAN Inter RAT handover with SGW change +- GERAN A/Gb mode to E-UTRAN Inter RAT handover with SGW change +- 3G Gn/Gp SGSN to MME combined hard handover and SRNS relocation procedure +- Gn/Gp SGSN to MME Tracking Area Update procedure +- Restoration of PDN connections after an SGW failure if the MME and PGW support these procedures as specified in 3GPP TS 23.007 [17] +- MME triggered Serving GW relocation +- Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN with PMIP on S5/S8 interface (see clauses 8.2 and 16.11 of 3GPP TS 23.402 [45]) + +and on the S4 interface by the SGSN to the SGW as part of the procedures: + +- Routing Area Update with MME interaction and with SGW change +- Gn/Gp SGSN to S4 SGSN Routing Area Update +- Inter SGSN Routeing Area Update Procedure and Combined Inter SGSN RA / LA Update using S4 with SGW change +- Iu mode RA Update Procedure using S4 with SGW change +- E-UTRAN to UTRAN Iu mode Inter RAT handover with SGW change +- E-UTRAN to GERAN A/Gb mode Inter RAT handover with SGW change +- Serving RNS relocation using S4 with SGW change +- Combined hard handover and SRNS relocation using S4 with SGW change +- Combined Cell / URA update and SRNS relocation using S4 with SGW change +- Enhanced serving RNS relocation with SGW relocation +- Restoration of PDN connections after an SGW failure if the SGSN and PGW support these procedures as specified in 3GPP TS 23.007 [17] +- S4-SGSN triggered Serving GW relocation +- Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN with PMIP on S5/S8 interface (see clauses 8.2 and 16.11 of 3GPP TS 23.402 [45]) + +and on the S2b interface by the ePDG to the PGW as part of the procedures: + +- Initial Attach with GTP on S2b +- UE initiated Connectivity to Additional PDN with GTP on S2b +- Handover to Untrusted Non-3GPP IP Access with GTP on S2b (See clause 8.6 of 3GPP TS 23.402 [45]) +- Initial Attach for emergency session (GTP on S2b) +- Addition of an access using S2b of NBIFOM procedure as specified by 3GPP TS 23.161 [71] + +and on the S2a interface by the TWAN to the PGW as part of the procedure: + +- Initial Attach in WLAN on GTP S2a +- Initial Attach in WLAN for Emergency Service on GTP S2a +- UE initiated Connectivity to Additional PDN with GTP on S2a +- Handover to TWAN with GTP on S2a (See clause 16.10 of 3GPP TS 23.402 [45]) +- Addition of an access using S2a of NBIFOM procedure as specified by 3GPP TS 23.161 [71]. + +If the new Create Session Request received by the SGW collides with an existing active PDN connection context (the existing PDN connection context is identified with the tuple [IMSI, EPS Bearer ID], where IMSI shall be replaced by + +TAC and SNR part of ME Identity for emergency or RLOS attached UE without UICC or authenticated IMSI), this Create Session Request shall be treated as a request for a new session. Before creating the new session, the SGW should delete: + +- the existing PDN connection context locally, if the Create Session Request is received with the TEID set to zero in the header, or if it is received with a TEID not set to zero in the header and it collides with the default bearer of an existing PDN connection context; +- the existing dedicated bearer context locally, if the Create Session Request collides with an existing dedicated bearer context and the message is received with a TEID not set to zero in the header. + +In the former case, if the PGW S5/S8 IP address for control plane received in the new Create Session Request is different from the PGW S5/S8 IP address for control plane of the existing PDN connection, the SGW should also delete the existing PDN connection in the corresponding PGW by sending a Delete Session Request message. + +NOTE 1: The SGW can send the Create Session Request and Delete Session Request over S5/S8 asynchronously, e.g. the SGW can send the Delete Session Request and then the Create Session Request without having to wait for the Delete Session Response. It does not matter if the PGW happens to receive the Delete Session Request after the Create Session Request since the PGW assigns a different S5/S8 F-TEID for control plane to the new PDN connection. + +In some network deployment, e.g. when 5G Network Slice is deployed and the combined PGW-C/SMFs are connected to the UDM, the PGW may select another PGW supporting the network slice for which the UE has subscription and then forward the Create Session Request to that PGW. When forwarding the Create Session Request message, the PGW shall forward the Create Session Request message as received from the SGW but with the following modifications: + +- the destination IP address of the message shall be set to the selected PGW IP address; +- the CSRMT flag shall be set to "1"; +- the source IP address and UDP port of the message shall be set to the IP address and port of the forwarding PGW. + +NOTE 2: The Create Session Response message is sent back to the forwarding PGW that forwards it to the SGW. It is assumed that GTPv2/UDP/IP connectivity between the source PGW/SMF and the target PGW/SMF which are in different slices is allowed in such network deployment; otherwise, if there is no GTPv2/UDP/IP connectivity between the source PGW/SMF and the target PGW/SMF, or if the source PGW/SMF does not support forwarding the request to the target PGW/SMF, the source PGW/SMF can proceed as specified in clause 7.2.2. + +If the new Create Session Request received by the PGW collides with an existing PDN connection context (the existing PDN connection context is identified with the triplet [IMSI, EPS Bearer ID, Interface type], where applicable Interface type here is S2a TWAN GTP-C interface or S2b ePDG GTP-C interface or S5/S8 SGW GTP-C interface, and where IMSI shall be replaced by TAC and SNR part of ME Identity for emergency or RLOS attached UE without UICC or authenticated IMSI), this Create Session Request shall be treated as a request for a new session. Before creating the new session, the PGW should delete: + +- the existing PDN connection context, if the Create Session Request collides with the default bearer of an existing PDN connection context; +- the existing dedicated bearer context, if the Create Session Request collides with a dedicated bearer of an existing PDN connection context. + +The PGW shall allocate a new PGW S5/S8 F-TEID for control plane to the new PDN connection, i.e. not the same F-TEID value as the one which was assigned to the existing PDN connection. + +NOTE 3: With GTP based S2a and S2b, the EPS Bearer IDs assigned for specific UE over S2a between the TWAN and PGW and over S2b between an ePDG and PGW are independent of the EPS Bearer IDs assigned for the same UE over S5/S8 and may overlap in value (see 3GPP TS 23.402 [45] clause 4.6.2). + +NOTE 4: Only the TAC and SNR part of the ME Identity is used to identify an emergency or RLOS attached UE without UICC or authenticated IMSI. + +**Table 7.2.1-1: Information Elements in a Create Session Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|------| +| IMSI | C |

The IMSI shall be included in the message on the S4/S11 interface, and on S5/S8 interface if provided by the MME/SGSN, except for the case:

  • - If the UE is emergency or RLOS attached and the UE is UICClassless.

The IMSI shall be included in the message on the S4/S11 interface, and on S5/S8 interface if provided by the MME/SGSN, but not used as an identifier

  • - if UE is emergency or RLOS attached but IMSI is not authenticated.

The IMSI shall be included in the message on the S2a/S2b interface, except for the case:

  • - if the UE is emergency attached and the UE is UICClassless.

The IMSI shall be included in the message on the S2a/S2b interface, but not used as an identifier:

  • - if UE is emergency attached but IMSI is not authenticated.
| IMSI | 0 | +| MSISDN | C |

For an E-UTRAN Initial Attach and a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN the IE shall be included when used on the S11 interface, if provided in the subscription data from the HSS.

For a PDP Context Activation procedure and a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN the IE shall be included when used on the S4 interface, if provided in the subscription data from the HSS.

The IE shall be included for the case of a UE Requested PDN Connectivity, if the MME has it stored for that UE. It shall be included when used on the S5/S8 interfaces if provided by the MME/SGSN.

The ePDG shall include this IE on the S2b interface during an Attach with GTP on S2b, UE initiated Connectivity to Additional PDN with GTP on S2b and a Handover to Untrusted Non-3GPP IP Access with GTP on S2b, Initial Attach for emergency session (GTP on S2b), if provided by the HSS/AAA.

The TWAN shall include this IE on the S2a interface during an Initial Attach in WLAN on GTP S2a, Initial Attach in WLAN for Emergency Service on GTP S2a, UE initiated Connectivity to Additional PDN with GTP on S2a and a Handover to TWAN with GTP on S2a, if provided by the HSS/AAA.

| MSISDN | 0 | +| | CO | This IE shall be present on the S11 interface during an S1/X2-based handover, 5GS to EPS handover or a TAU procedure with SGW relocation or insertion (for 5GS to EPS mobility), if the MSISDN is available at the MME. | | | +| ME Identity (MEI) | C |

The MME/SGSN shall include the ME Identity (MEI) IE on the S11/S4 interface:

  • - If the UE is emergency attached and the UE is UICClassless; or
  • - If the UE is emergency attached and the IMSI is not authenticated

For all other cases the MME/SGSN shall include the ME Identity (MEI) IE on the S11/S4 interface if it is available.

| MEI | 0 | +| | CO |

The MME shall include the ME Identity (MEI) IE on the S11 interface:

  • - If the UE is RLOS attached and the UE is
| | | + +| | | | | | +|---------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|---| +| | | UICClass; or | | | +| | | - If the UE is RLOS attached and the IMSI is not authenticated. | | | +| | CO | If the SGW receives this IE, it shall forward it to the PGW on the S5/S8 interface. | | | +| | CO | The TWAN/ePDG shall include the ME Identity (MEI) IE on the S2a/S2b interface:
- If the UE is emergency attached and the UE is UICClass; or
- If the UE is emergency attached and the IMSI is not authenticated.

For all other cases, the TWAN/ePDG shall include the ME Identity (MEI) IE on the S2a/S2b interface, if it is available. | | | +| User Location Information (ULI) | C | This IE shall be included on the S11 interface for E-UTRAN Initial Attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN and UE-requested PDN Connectivity procedures. It shall include ECGI and TAI. The MME/SGSN shall also include it on the S11/S4 interface for TAU/RAU/X2-Handover/Enhanced SRNS Relocation procedure if the PGW/PCRF has requested location information change reporting and MME/SGSN support location information change reporting. | ULI
(NOTE 10) | 0 | +| | CO | This IE shall also be included on the S4 interface for PDP Context Activation procedure. It shall include CGI/SAI, together with RAI. | | | +| | CO | This IE shall also be included on the S4/S11 interface for a TAU/RAU procedure if
- the level of support (User Location Change Reporting and/or CSG Information Change Reporting) changes; or
- the target MME/S4-SGSN cannot derive the level of support (User Location Change Reporting and/or CSG Information Change Reporting) for the source Gn/Gp SGSN. See NOTE 9.

The MME shall include the ECGI and /or TAI in the ULI, the S4-SGSN shall include either the CGI or SAI or RAI, or CGI/SAI together with RAI in the ULI. | | | +| | CO | This IE shall also be included on the S4/S11 interface for:
- a TAU procedure with an S4-SGSN interaction, if the MME supports location information change reporting;
- a RAU procedure with an MME interaction, if the S4-SGSN supports location information change reporting.

The MME shall include the ECGI and TAI in the ULI, the S4-SGSN shall include the CGI/SAI together with RAI in the ULI. | | | +| | CO | The SGW shall include this IE on S5/S8 if it receives the ULI from MME/SGSN. | | | +| Serving Network | C | This IE shall be included on the S4/S11, S5/S8 and S2b interfaces for an E-UTRAN initial attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, a PDP Context Activation, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN, a UE requested PDN connectivity, an Attach with GTP on S2b, a UE initiated Connectivity to Additional PDN with GTP on S2b, a Handover to Untrusted Non-3GPP IP Access with GTP on S2b and an Initial Attach for emergency session (GTP on S2b). See NOTE 10. | Serving Network | 0 | + +| | | | | | +|----------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---| +| | CO | This IE shall be included on S4/S11 for RAU/TAU/Handover with SGW relocation procedures. See NOTE 10. | | | +| | CO | This IE shall be included on the S2a interface for an Initial Attach in WLAN on GTP S2a, an Initial Attach in WLAN for Emergency Service on GTP S2a, a UE initiated Connectivity to Additional PDN with GTP on S2a and a Handover to TWAN with GTP on S2a.
The TWAN shall set this IE to the PLMN identity of the selected PLMN used for 3GPP-based access authentication. The selected PLMN is the PLMN of the 3GPP AAA Proxy in roaming case and the PLMN of the 3GPP AAA Server in non-roaming case. | | | +| RAT Type | M | This IE shall be set to the 3GPP access type or to the value matching the characteristics of the non-3GPP access the UE is using to attach to the EPS.

The MME shall set the RAT Type to LTE-M if it has received the LTE-M indication from the eNodeB, otherwise it shall set it to the RAT type the UE is using.

The ePDG may use the access technology type of the untrusted non-3GPP access network if it is able to acquire it; otherwise it shall indicate Virtual as the RAT Type. The TWAN shall set the RAT Type value to "WLAN" on the S2a interface.

If the LTE-M RAT type is received from the MME, the SGW shall signal the following RAT type to the PGW:
- LTE-M RAT type, if the 'LTE-M RAT type reporting to PGW' flag is received from the MME; or
- WB-E-UTRAN RAT type, otherwise.

If the Satellite related RAT type is received from the MME, the SGW shall signal the following RAT type to the PGW:
- The received Satellite related RAT type, if the 'Satellite RAT Type reporting to PGW Indication' flag is received from the MME; or
- The RAT type without Satellite, i.e. LTE-M / EUTRAN-NB-IoT / WB-E-UTRAN, otherwise.

See NOTE 3, NOTE 4, NOTE 22, NOTE 28. | RAT Type | 0 | + +| | | | | | +|------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---| +| Indication Flags | C |

This IE shall be included if any one of the applicable flags is set to 1.

Applicable flags are:

  • - S5/S8 Protocol Type: This flag shall be set to 1 on the S11/S4 interfaces if the chosen protocol type for the S5/S8 interface is PMIP.
  • - Dual Address Bearer Flag: This flag shall be set to 1 on the S2b, S11/S4 and S5/S8 interfaces when the PDN Type, determined based on UE request and subscription record, is set to IPv4v6 and all SGSNs which the UE may be handed over to support dual addressing. This shall be determined based on node pre-configuration by the operator. (see also NOTE 5).
    The TWAN shall set this flag to 1 on the S2a interface if it supports IPv4 and IPv6 and the PDN Type determined from the UE request if single-connection mode or multi-connection mode is used (see 3GPP TS 23.402 [45]) and the user subscription data is set to IPv4v6.
  • - Handover Indication: This flag shall be set to 1 on the S11/S4 and S5/S8 interface during a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, or a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN procedures, or an Addition of a 3GPP access of NBIFOM procedure, or during a 5GS to EPS handover without the N26 interface. This flag shall be set to 1 on the S2b interface during a Handover from 3GPP access to Untrusted Non-3GPP IP Access with GTP on S2b and IP address preservation is requested by the UE, or an Addition of an access using S2b of NBIFOM procedure.
    This flag shall be set to 1 on the S2a interface during a Handover from 3GPP access to TWAN with GTP on S2a and IP address preservation is requested by the UE, or an Addition of an access using S2a of NBIFOM procedure.
  • - Operation Indication: This flag shall be set to 1 on the S4/S11 interface for a TAU/RAU procedure with SGW relocation, Enhanced SRNS Relocation with SGW relocation, X2-based handovers with SGW relocation and MME triggered Serving GW relocation.
  • - Direct Tunnel Flag: This flag shall be set to 1 on the S4 interface if Direct Tunnel is used.
  • - Piggybacking Supported: This flag shall be set to 1 on the S11 interface only if the MME supports the piggybacking feature as described in Annex F of 3GPP TS 23.401 [3]. This flag shall be set to 1 on S5/S8 only if both the MME and the SGW support piggybacking.
  • - Change Reporting support Indication: This flag shall be set to 1 on S4/S11 and S5/S8 interfaces if the SGSN/MME supports location Info Change Reporting and if the SGSN/MME's operator policy permits reporting of location change to the operator of the PGW with which the session is being established. See NOTE2.
  • - CSG Change Reporting Support Indication: This flag shall be set to 1 on S4/S11 and S5/S8 interfaces if the SGSN/MME supports CSG Information Change Reporting and if the
| Indication | 0 | +|------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---| + +| | | | | | +|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--| +| | |

SGSN/MME's operator policy permits reporting of CSG Information change to the operator of the PGW with which the session is being established. See NOTE 2.

  • - Unauthenticated IMSI: This flag shall be set to 1 on the S4/S11, S5/S8 and S2a/S2b interfaces if the IMSI present in the message is not authenticated and is for an emergency attached UE. It shall also be set to 1 on the S11 and S5/S8 interfaces if the IMSI is present in the message is not authenticated and is for an RLOS attached UE.
  • - PDN Pause Support Indication: this flag shall be set to 1 on the S5/S8 interface if the SGW supports the PGW Pause of Charging procedure.
  • - NBIFOM Support Indication: This flag shall be set to 1 on S11/S4 if the MME/SGSN supports NBIFOM.
    This flag shall be set to 1 on S5/S8 if both the SGW and the MME/SGSN support NBIFOM.
    This flag shall be set to 1 on S2a/S2b if the TWAN/ePDG supports NBIFOM.
  • - WLCP PDN Connection Modification Support Indication: This flag shall be set to 1 on the S2a interface if the TWAN supports the WLCP PDN Connection Modification procedure.
  • - UE Not Authorised Cause Code Support Indication: This flag shall be set to 1 on S4/S11 and S5/S8 interface if the SGSN/MME supports the "UE not authorised by OCS or external AAA Server" Cause Code.
  • - UE Available for Signalling Indication: this flag shall be set to 1 on S11/S4 during a TAU/RAU with SGW relocation procedure if there is pending network initiated PDN connection signalling for this PDN connection. The SGW shall include this IE on S5/S8 if it receives the flag from the MME/SGSN.
  • - S11-U Tunnel Flag: this flag shall be set to 1 on the S11 interface if user data is transported in NAS signalling.
  • - Extended PCO Support Indication: this flag shall be set to 1 on S11 interface by the MME if the UE and the MME support ePCO; and this flag shall be set to 1 on S5/S8 interface by the SGW if the SGW supports ePCO and MME has set the flag to 1.
  • - Control Plane Only PDN Connection Indication: this flag shall be set to 1 over S11 and S5/S8 if the PDN Connection is set to Control Plane Only.
  • - eNB Change Reporting Support Indication: This flag shall be set to 1 on S11 and S5/S8 interfaces if the MME supports location Info Change Reporting and if the MME's operator policy permits reporting of location change to the operator of the PGW with which the session is being established. See NOTE 19.
  • - LTE-M RAT Type reporting to PGW Indication: this flag shall be set to 1 on S11, based on operator policy or roaming agreements (for Home Routed PDN connections), if the SGW needs to forward the LTE-M RAT type to the PGW.
  • - 5GS Interworking Indication(5GSIWKI): this flag
| | | +|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--| + +| | | | +|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | |

shall be set to 1 on S11, S5/S8 and S2b interfaces if the UE supports N1 mode and the PDN connection is not restricted from interworking with 5GS by user subscription (see "5GC" bit within Core-Network-Restrictions AVP and Interworking-5GS-Indicator AVP specified in 3GPP TS 29.272 [70] and 3GPP TS 29.273 [68]). (NOTE 27)

  • - 5GS Interworking without N26 Indication: this flag shall be set to 1 on S11 and S5/S8 interfaces if the 5GS Interworking Indication (5GSIWKI) is set to 1 and the N26 interface is not supported. See clause 4.11.1.1 in 3GPP TS 23.502 [83]. (NOTE 23)
  • - 5GCNRI (5GC Not Restricted Indication): this flag shall be set to 1 on S11, S5/S8 and S2b interfaces if access to the 5GC is not restricted for the PDN connection by user subscription (see "5GC" bit within Core-Network-Restrictions AVP and Interworking-5GS-Indicator AVP specified in 3GPP TS 29.272 [70] and 3GPP TS 29.273 [68]). (NOTE 27)
  • - 5GCNRS (5GC Not Restricted Support): this flag shall be set to 1 on S11, S5/S8 and S2b interfaces if the sending node (i.e. MME or ePDG) supports setting the 5GCNRI flag. An MME or an ePDG compliant with this version of the specification shall support setting the 5GCNRI flag.
  • - MTEDTA (MT-EDT Applicable): this flag shall be set to 1 on the S11 interface if MT-EDT is applicable for the PDN connection, i.e. if the UE has indicated its support of MT-EDT as part of the UE network capability and if the local policy requires so. (NOTE 26)
  • - CSRMFI (Create Session Request Message Forwarded Indication): this shall be set to 1 on S5/S8 interfaces by a PGW if the Create Session Request message has been forwarded by that PGW.
  • - Restoration of PDN connections after an PGW-C/SMF Change Support Indication: this flag shall be set to 1 on the S11/S2b interface if the MME/ePDG supports the Restoration of PDN connections after an PGW-C/SMF Change procedure as specified in clause 31 of 3GPP TS 23.007 [17]. This flag shall be set to 1 on the S5/S8 interface if the SGW and the MME support the Restoration of PDN connections after an PGW-C/SMF Change procedure as specified in clause 31 of 3GPP TS 23.007 [17].
  • - PGW Change Indication: this flag shall be set to 1 by the MME/ePDG over the S11/S2b interface if the Create Session Request is to move an existing PDN connection to the new PGW-C/SMF as specified in clauses 31.3 and 31.3A of 3GPP TS 23.007 [17]. The SGW shall forward the flag on the S5/S8 interface.
  • - PGWRNSI (PGW Redirection due to mismatch with Network Slice subscribed by UE Support Indication): this flag shall be set to 1 on the S11 and S5/S8 interfaces, if the MME supports receiving a Create Session rejection response with the cause "PGW redirection due to mismatch with
| +|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|---------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|---| +| | | network slice subscribed by the UE".
- UPIPSI (User Plane Integrity Protection Support Indication): this flag shall be set to 1 by the MME on the S11 interface, if the UE, MME and E-UTRAN supports User Plane Integrity Protection with EPS. This flag shall be set to 1 by the SGW on S5/S8 interface if the MME has set the flag to 1 over the S11 interface. | | | +| Sender F-TEID for Control Plane | M | | F-TEID | 0 | +| PGW S5/S8 Address for Control Plane or PMIP | C | This IE shall be sent on the S11 / S4 interfaces. The TEID or GRE Key is set to "0" in the E-UTRAN initial attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, the PDP Context Activation, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN and the UE requested PDN connectivity procedures. | F-TEID | 1 | +| Access Point Name (APN) | M | | APN | 0 | +| Selection Mode | C | This IE shall be included on the S4/S11 and S5/S8 interfaces for an E-UTRAN initial attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, a PDP Context Activation, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN and a UE requested PDN connectivity.

This IE shall be included on the S2b interface for an Initial Attach with GTP on S2b, a Handover to Untrusted Non-3GPP IP Access with GTP on S2b, a UE initiated Connectivity to Additional PDN with GTP on S2b and an Initial Attach for emergency session (GTP on S2b).

It shall indicate whether a subscribed APN or a non-subscribed APN chosen by the UE/MME/SGSN/ePDG/TWAN was selected, see NOTE 17.

This IE shall be included on the S2a interface for an Initial Attach in WLAN on GTP S2a, an Initial Attach in WLAN for Emergency Service on GTP S2a, a Handover to TWAN with GTP on S2a and a UE initiated Connectivity to Additional PDN with GTP on S2a. The value shall be set to "MS or network provided APN, subscription verified". | Selection Mode | 0 | + +| | | | | | +|----------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---| +| | CO | When available, this IE shall be sent by the MME/SGSN on the S11/S4 interface during TAU/RAU/HO with SGW relocation. | | | +| PDN Type | C | This IE shall be included on the S4/S11 and S5/S8 interfaces for an E-UTRAN initial attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, a PDP Context Activation, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN and a UE requested PDN connectivity.
This IE shall be set to IPv4, IPv6, IPv4v6, Non-IP or Ethernet. This is based on the UE request and the subscription record retrieved from the HSS (for MME see 3GPP TS 23.401 [3], clause 5.3.1.1, and for SGSN see 3GPP TS 23.060 [35], clause 9.2.1). See NOTE 1. See NOTE 14. See NOTE 24 and 25. | PDN Type | 0 | + +| | | | | +|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|---| +| PDN Address Allocation (PAA) |

C This IE shall be included the S4/S11, S5/S8 and S2a/S2b interfaces for an E-UTRAN initial attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, a PDP Context Activation, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN, a UE requested PDN connectivity, an Attach with GTP on S2b, a UE initiated Connectivity to Additional PDN with GTP on S2b, a Handover to Untrusted Non-3GPP IP Access with GTP on S2b, an Initial Attach for emergency session (GTP on S2b, an Initial Attach in WLAN on GTP S2a, an Initial Attach in WLAN for Emergency Service on GTP S2a, a UE initiated Connectivity to Additional PDN with GTP on S2a and a Handover to TWAN with GTP on S2a. For PMIP-based S5/S8, this IE shall also be included on the S4/S11 interfaces for TAU/RAU/Handover cases involving SGW relocation.

The PDN type field in the PAA shall be set to IPv4, or IPv6 or IPv4v6, Non-IP or Ethernet by MME/SGSN, based on the UE request and the subscription record retrieved from the HSS (see clause 8.12 and also NOTE 5. See also NOTE 24).

The TWAN shall set the PDN type field in the PAA to IPv4, or IPv6 or IPv4v6 based on the UE request if single-connection mode or multi-connection mode is used (see 3GPP TS 23.402 [45]), the IP versions the TWAN supports and the PDN type received in the user subscription data from the HSS/3GPP AAA Server, or based on the UE request and the TWAN Emergency Configuration Data for an Initial Attach in WLAN for Emergency Service on GTP S2a.

The ePDG shall set the PDN type field in the PAA to IPv4, or IPv6 or IPv4v6 based on the UE request and the subscription record retrieved from the HSS/3GPP AAA Server, or based on the UE request and the ePDG Emergency Configuration Data for an Initial Attach for emergency session (GTP on S2b).

For static IP address assignment (for MME see 3GPP TS 23.401 [3], clause 5.3.1.1, for SGSN see 3GPP TS 23.060 [35], clause 9.2.1, for ePDG see 3GPP TS 23.402 [45] clause 4.7.3, and for TWAN see 3GPP TS 23.402 [45] clause 16.1.5), the MME/SGSN/ePDG/TWAN shall set the IPv4 address and/or IPv6 prefix length and IPv6 prefix and Interface Identifier based on the subscribed values received from HSS, if available. For PDN Type IPv4v6, either one of the IP versions (i.e. IPv4 address or IPv6 prefix and Interface Identifier) or both the IP versions may be statically provisioned in the HSS. If only one of the IP versions is statically provisioned in the HSS, the MME/SGSN/ePDG/TWAN shall set the other IP version as all zeros. The value of PDN Type field shall be consistent with the value of the PDN Type IE, if present in this message.

For a Handover to Untrusted Non-3GPP IP Access with GTP on S2b, the ePDG shall set the IPv4 address and/or IPv6 prefix length and IPv6 prefix and Interface Identifier based on the IP address(es) received from the UE.

For IP PDN connections, if static IP address assignment is not used (e.g. static address is not received from the HSS), and for scenarios other than a Handover to Untrusted Non-3GPP IP Access with GTP on S2b, the IPv4 address shall be set to 0.0.0.0, and/or the IPv6 Prefix Length and

| PAA | 0 | +|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|---| + +| | | | | | +|---------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---| +| | | IPv6 prefix and Interface Identifier shall all be set to zero.

For Non-IP or Ethernet PDN connections, the PDN Address and Prefix field shall not be present. See NOTE 14 and 25. | | | +| | CO | This IE shall be sent by the MME/SGSN on S11/S4 interface during TAU/RAU/HO with SGW relocation. | | | +| Maximum APN Restriction | C | This IE shall be included on the S4/S11 and S5/S8 interfaces in the E-UTRAN initial attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, PDP Context Activation, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN and UE Requested PDN connectivity procedures.
This IE denotes the most stringent restriction as required by any already active bearer context. If there are no already active bearer contexts, this value is set to the least restrictive type. | APN Restriction | 0 | +| Aggregate Maximum Bit Rate (APN-AMBR) | C | This IE represents the APN-AMBR. It shall be included on the S4/S11, S5/S8 and S2a/S2b interfaces for an E-UTRAN initial attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, UE requested PDN connectivity, PDP Context Activation procedure using S4, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN, TAU/RAU/Handover from the Gn/Gp SGSN to the S4 SGSN/MME procedures, Attach with GTP on S2b, a Handover to Untrusted Non-3GPP IP Access with GTP on S2b, UE initiated Connectivity to Additional PDN with GTP on S2b, an Initial Attach for emergency session (GTP on S2b), Initial Attach in WLAN on GTP S2a, an Initial Attach in WLAN for Emergency Service on GTP S2a, a Handover to TWAN with GTP on S2a and UE initiated Connectivity to Additional PDN with GTP on S2a. | AMBR | 0 | +| Linked EPS Bearer ID | C | This IE shall be included on S4/S11 in RAU/TAU/HO except in the Gn/Gp SGSN to MME/S4-SGSN RAU/TAU/HO procedures with SGW change to identify the default bearer of the PDN Connection | EBI | 0 | +| Trusted WLAN Mode Indication | CO | The TWAN shall include this IE on S2a interface (during initial attach, handover to TWAN with GTP on S2a procedure, UE-initiated additional PDN connectivity procedures), if the single-connection mode or multiple-connection mode is used.
The TWAN shall not include this IE if transparent single-connection mode is used. The PGW shall assume that transparent single-connection mode is used if it receives this message without this IE from the TWAN. | TWMI | 0 | +| Protocol Configuration Options (PCO) | C | If MME/SGSN receives PCO from the UE during the Attach, PDN connectivity or Handover to 3GPP access procedures, the MME/SGSN shall forward the PCO IE to SGW. The SGW shall also forward it to PGW. | PCO | 0 | + +| | | | | | +|-------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---| +| | CO | If the TWAN receives a PCO from the UE during: an initial attach, handover to TWAN or UE-initiated additional PDN connectivity with GTP on S2a procedures (in multi-connection mode or single connection mode), the TWAN shall forward the PCO IE to the PGW, see 3GPP TS 23.402 [45]. | | | +| Bearer Contexts to be created | M | Several IEs with the same type and instance value shall be included on the S4/S11 and S5/S8 interfaces as necessary to represent a list of Bearers. One single IE shall be included on the S2a/S2b interface.
One bearer shall be included for E-UTRAN Initial Attach, PDP Context Activation, UE requested PDN Connectivity, Attach with GTP on S2b, UE initiated Connectivity to Additional PDN with GTP on S2b, Handovers between Untrusted Non-3GPP IP Access with GTP on S2b and 3GPP Access, Initial Attach for emergency session (GTP on S2b), Initial Attach in WLAN on GTP S2a, an Initial Attach in WLAN for Emergency Service on GTP S2a, Handovers between TWAN with GTP on S2a and 3GPP Access and UE initiated Connectivity to Additional PDN with GTP on S2a.
One or more bearers shall be included for a Handover/TAU/RAU with an SGW change.
See NOTE 6 and NOTE 7. | Bearer Context | 0 | +| Bearer Contexts to be removed | C | This IE shall be included on the S4/S11 interfaces for the TAU/RAU/Handover cases where any of the bearers existing before the TAU/RAU/Handover procedure will be deactivated as consequence of the TAU/RAU/Handover procedure.
For each of those bearers, an IE with the same type and instance value shall be included.
See NOTE 6 and NOTE 7. | Bearer Context | 1 | +| Trace Information | C | This IE shall be included on the S4/S11 interface if an SGW trace is activated, and/or on the S5/S8 and S2a/2b interfaces if a PGW trace is activated. See 3GPP TS 32.422 [18]. | Trace Information | 0 | +| Recovery | C | This IE shall be included on the S4/S11, S5/S8 and S2a/2b interfaces if contacting the peer node for the first time. | Recovery | 0 | +| MME-FQ-CSID | C | This IE shall be included by the MME on the S11 interface and shall be forwarded by an SGW on the S5/S8 interfaces according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| SGW-FQ-CSID | C | This IE shall be included by the SGW on the S5/S8 interfaces according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 1 | +| ePDG-FQ-CSID | C | This IE shall be included by the ePDG on the S2b interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 2 | +| TWAN-FQ-CSID | C | This IE shall be included by the TWAN on the S2a interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 3 | +| UE Time Zone | CO | This IE shall be included by the MME over S11 during Initial Attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN and UE Requested PDN Connectivity procedure.
This IE shall be included by the SGSN over S4 during PDP Context Activation procedure and a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN.
This IE shall be included by the MME/SGSN over S11/S4 TAU/RAU/Handover with SGW relocation. | UE Time Zone | 0 | + +| | | | | | +|--------------------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|---| +| | C | If SGW receives this IE, SGW shall forward it to PGW across S5/S8 interface. | | | +| | O | This IE shall be included by the TWAN on the S2a interface for Initial Attach in WLAN procedure, UE-initiated Connectivity to Additional PDN with GTP on S2a and handover to TWAN with GTP on S2a procedure as specified in 3GPP TS 23.402 [45]. | | | +| User CSG Information (UCI) | CO | This IE shall be included on the S4/S11 interface for E-UTRAN Initial Attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, UE-requested PDN Connectivity, PDP Context Activation and a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN using S4 procedures, if the UE is accessed via CSG cell or hybrid cell.
The MME/SGSN shall also include it for TAU/RAU/Handover procedures with SGW relocation if the UE is accessed via a CSG cell or hybrid cell or leaves a CSG or hybrid cell and the PGW/PCRF has requested CSG info reporting and MME/SGSN support CSG info reporting. NOTE 11.
The SGW shall include this IE on S5/S8 if it receives the User CSG information from MME/SGSN.
See NOTE 10. | UCI | 0 | +| Charging Characteristics | C | This IE shall be included on the S4/S11, S5/S8 and S2a/S2b interfaces according to 3GPP TS 32.251 [8] | Charging Characteristics | 0 | +| MME/S4-SGSN LDN | O | This IE is optionally sent by the MME to the SGW on the S11 interface and by the S4-SGSN to the SGW on the S4 interface (see 3GPP TS 32.423 [44]), when communicating the LDN to the peer node for the first time. | Local Distinguished Name (LDN) | 0 | +| SGW LDN | O | This IE is optionally sent by the SGW to the PGW on the S5/S8 interfaces (see 3GPP TS 32.423 [44]), when communicating the LDN to the peer node for the first time. | Local Distinguished Name (LDN) | 1 | +| ePDG LDN | O | This IE is optionally sent by the ePDG to the PGW on the S2b interfaces (see 3GPP TS 32.423 [44]), when contacting the peer node for the first time. | Local Distinguished Name (LDN) | 2 | +| TWAN LDN | O | This IE may be sent by the TWAN to the PGW on the S2a interfaces (see 3GPP TS 32.423 [44]), when contacting the peer node for the first time. | Local Distinguished Name (LDN) | 3 | +| Signalling Priority Indication | CO | The SGSN/MME shall include this IE on the S4/S11 interface if the UE indicates low access priority when requesting to establish the PDN connection.
The SGW shall forward this IE in the Create Session Request message on the S5/S8 interfaces if received from the MME/SGSN. | Signalling Priority Indication | 0 | +| UE Local IP Address | CO | The ePDG shall include this IE on the S2b interface during an Initial Attach for emergency session (GTP on S2b). Otherwise the ePDG shall include this IE on the S2b interface based on local policy. | IP Address | 0 | +| UE UDP Port | CO | The ePDG shall include this IE on the S2b interface if NAT is detected, the UDP encapsulation is used and the UE Local IP Address is present. | Port Number | 0 | +| Additional Protocol Configuration Options (APCO) | CO | If multiple authentications are supported by the ePDG, the ePDG shall include this IE on the S2b interface and perform the corresponding procedures as specified for PAP and CHAP authentication of the UE with external networks in 3GPP TS 33.402 [50]. | Additional Protocol Configuration Options (APCO) | 0 | + +| | | | | | +|-------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---| +| | O | If the UE requests the DNS IPv4/IPv6 address in the Configuration Payload (CFG_REQ) during the IPsec tunnel establishment procedure (as specified in 3GPP TS 33.402 [50]), and if the ePDG supports the Additional Protocol Configuration Options IE, the ePDG may include this IE over S2b interface and correspondingly set the "DNS Server IPv4/v6 Address Request" parameter as defined in 3GPP TS 24.008 [5]. | | | +| | CO | If the UE includes the P-CSCF_IP6_ADDRESS attribute, or the P-CSCF_IP4_ADDRESS attribute or both in the CFG_REQUEST configuration payload during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [63]), and if the ePDG supports these IKEv2 attributes and the Additional Protocol Configuration Options IE, the ePDG shall include this IE over the S2b interface and correspondingly set the P-CSCF IPv6 Address Request, or P-CSCF IPv4 Address Request, or both parameters as defined in 3GPP TS 24.008 [5]. | | | +| | CO | If the UE includes the P-CSCF_RESELECTION_SUPPORT Private Status Type in a Notify payload within the IKE_AUTH request message during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [63], and if the ePDG supports the P-CSCF restoration extension procedure for the untrusted WLAN access (see 3GPP TS 23.380 [61]), the ePDG shall include this IE over the S2b interface and correspondingly set the P-CSCF_RESELECTION_SUPPORT, as defined in 3GPP TS 24.008 [5]. | | | +| | O | The TWAN may include this IE on the S2a interface to retrieve additional IP configuration parameters from the PGW (e.g. DNS server) if the transparent single-connection mode is used as specified in 3GPP TS 23.402 [45]. | | | +| | CO | The ePDG shall include this IE over the S2b interface and correspondingly set the PDU session ID, as defined in 3GPP TS 24.008 [5] if:
  • - the UE includes the N1_MODE_CAPABILITY Notify payload within the IKE_AUTH request message during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [63];
  • - the ePDG supports this IKEv2 attribute and the Additional Protocol Configuration Options IE; and
  • - the PDN connection is not restricted from interworking with 5GS by user subscription (see "5GC" bit within Core-Network-Restrictions AVP and Interworking-5GS-Indicator AVP specified in 3GPP TS 29.273 [68]).
| | | +| H(e)NB Local IP Address | CO | The MME/SGSN shall include this IE on S11/S4 interface if the MME/SGSN receives this information from H(e)NB in UE associated S1/Iu signalling according (see 3GPP TS 23.139 [51]) during:
  • - E-UTRAN Initial Attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, UE-requested PDN Connectivity, PDP Context Activation and a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN using S4;
  • - TAU/RAU/X2-based handover/Enhanced Serving RNS Relocation Procedure with SGW change, if the PGW/PCRF has requested H(e)NB information reporting for the PDN connection.

The SGW shall forward this IE on S5/S8 interface if the SGW receives it from the MME/SGSN.

| IP Address | 1 | + +| | | | | | +|------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---| +| H(e)NB UDP Port | CO |

The MME/SGSN shall include this IE on S11/S4 interface if the MME/SGSN receives this information from H(e)NB in UE associated S1/Iu signalling according (see 3GPP TS 23.139 [51]) during:

  • - E-UTRAN Initial Attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, UE-requested PDN Connectivity, PDP Context Activation and a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN using S4;
  • - TAU/RAU/X2-based handover/Enhanced Serving RNS Relocation Procedure with SGW relocation, if the PGW/PCRF has requested H(e)NB information reporting for the PDN connection.

The SGW shall forward this IE on S5/S8 interface if the SGW receives it from the MME/SGSN.

| Port Number | 1 | +| MME/S4-SGSN Identifier | CO |

If the PGW triggered SGW restoration procedure is supported, the MME/S4-SGSN shall include this IE on S11/S4 interface and the SGW shall forward this IE on S5 interface in the existing signalling as specified in 3GPP TS 23.007 [17].

If the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11), the MME/S4-SGSN shall include this IE on the S11/S4 interface. In that case, the SGW shall forward this IE on the S5/S8 interface.

| IP Address | 2 | +| TWAN Identifier | CO | This IE shall be included on the S2a interface for Initial Attach in WLAN procedure, UE-initiated Connectivity to Additional PDN with GTP on S2a and handover to TWAN with GTP on S2a procedure as specified in 3GPP TS 23.402 [45]. | TWAN Identifier | 0 | +| ePDG IP Address | O | This IE may be included on the S2b interface based on local policy for Fixed Broadband access network interworking, see 3GPP TS 23.139 [51]. If present, it shall contain the ePDG IP address which is used as IKEv2 tunnel endpoint with the UE. | IP Address | 3 | +| CN Operator Selection Entity | CO | In shared networks, the SGSN shall include this IE on the S4 interface for a PDP Context Activation, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN and RAU with SGW relocation procedures, if the information is available, to indicate whether the Serving Network has been selected by the UE or by the network. | CN Operator Selection Entity | 0 | + +| | | | | | +|--------------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|---| +| | CO | The SGW shall include this IE on S5/S8 if it receives it from the SGSN. | | | +| Presence Reporting Area Information | CO |

The MME/SGSN shall include this IE in the following procedures, if the PGW/PCRF/OCS requested reporting changes of UE presence in the Presence Reporting Area(s) and the MME/SGSN supports such reporting:

  • - TAU/RAU/X2 Handover/Enhanced SRNS Relocation procedures with SGW relocation and MME/SGSN change. The new MME/SGSN shall then indicate whether the UE is inside or outside the PRA for each of the active Presence Reporting Area(s), or indicate that the Presence Reporting Area(s) is inactive;
  • - TAU/RAU/X2 Handover/Enhanced SRNS Relocation procedures with SGW relocation and without MME/SGSN change, if the UE enters or leaves the Presence Reporting Area(s). In this case, this IE shall only include the active PRA(s) that the UE has newly entered or left.

Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Actions. See NOTE 20.

| Presence Reporting Area Information | 0 | +| MME/S4-SGSN's Overload Control Information | O |

During an overload condition, the MME/S4-SGSN may include this IE on the S11/S4 interface if the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the MME/S4-SGSN shall provide only one instance of this IE, representing its overload information.

| Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the PGW on the S5/S8 interface. | | | +| SGW's Overload Control Information | O |

During an overload condition, the SGW may include this IE over the S5/S8 interface if the overload control feature is supported by the SGW and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information.

| Overload Control Information | 1 | +| TWAN/ePDG's Overload Control Information | O |

During an overload condition, the TWAN/ePDG may include this IE over the S2a/S2b interface if the overload control feature is supported by the TWAN/ePDG and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the TWAN/ePDG shall provide only one instance of this IE, representing its overload information.

| Overload Control Information | 2 | +| Origination Time Stamp | CO |

The MME/SGSN and the TWAN/ePDG shall include this IE on the S11/S4 and S2a/S2b interface respectively, in the conditions specified in clause 13.2.

When present, the Origination Time Stamp shall contain the UTC time when the originating entity initiated the request.

| Millisecond Time Stamp | 0 | +| | CO | The SGW shall include this IE on the S5/S8 interface if it receives the Origination Time Stamp from the MME/SGSN and if it supports the procedure specified in clause 13.2. | | | +| Maximum Wait Time | CO |

The MME/SGSN and the TWAN/ePDG shall include this IE on the S11/S4 and S2a/S2b interface respectively, in the conditions specified in clause 13.3.

When present, the Maximum Wait Time shall contain the duration (number of milliseconds since the Origination Time Stamp) during which the originator of the request waits for a response.

| Integer Number | 0 | + +| | | | | | +|------------------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---| +| | CO | The SGW shall include this IE on the S5/S8 interface if it receives the Maximum Wait Time from the MME/SGSN and if it supports the procedure specified in clause 13.3. | | | +| WLAN Location Information | CO | This IE shall be included on the S2b interface if the WLAN Location Information is available. | TWAN Identifier | 1 | +| WLAN Location Timestamp | CO | This IE shall be included on the S2b interface, if the WLAN Location Timestamp is available. | TWAN Identifier Timestamp | 0 | +| NBIFOM Container | CO | This IE shall be included on the S11/S4 or S2a/S2b interfaces if the MME/S4-SGSN or the TWAN/ePDG receives an NBIFOM Container from the UE as specified in TS 24.161 [73]. The Container Type shall be set to 4. | F-Container | 0 | +| | CO | If the SGW receives an NBIFOM Container from the MME/S4-SGSN, the SGW shall forward this IE to the PGW on the S5/S8 interface. | | | +| Remote UE Context Connected | CO | The MME shall include this IE on the S11 interface during a SGW relocation procedure if such information is available.
Several IEs with the same type and instance value may be included as necessary to represent a list of remote UEs connected. | Remote UE Context | 0 | +| 3GPP AAA Server Identifier | O | The ePDG/TWAN may include this IE on the S2a/S2b interface to provide the selected 3GPP AAA server identifier to the PGW. See NOTE 13. | Node Identifier | 0 | +| Extended Protocol Configuration Options (ePCO) | CO | If the MME receives ePCO from the UE during the Initial Attach, UE requested PDN Connectivity procedures, the MME shall forward the ePCO IE to the SGW if the MME supports ePCO.

The SGW shall also forward it to the PGW if the SGW supports ePCO. See NOTE 15. | ePCO | 0 | +| Serving PLMN Rate Control | CO | The MME shall include this IE on the S11 interface if Serving PLMN Rate control is configured by the MME operator and the PDN Connection is set to Control Plane Only:
  • - during an Initial Attach, or a UE Requested PDN Connectivity procedure.
  • - during an inter MME TAU with SGW relocation procedure
See NOTE 18.

The SGW shall include this IE on S5/S8 if it receives this IE from MME. | Serving PLMN Rate Control | 0 | +| MO Exception Data Counter | CO | The MME shall include the counter if it has received the counter for RRC cause "MO Exception data" in the Context Response message during a TAU with an MME and SGW change. | Counter | 0 | +| UE TCP Port | CO | The ePDG shall include this IE on the S2b interface if NAT is detected, the TCP encapsulation is used and the UE Local IP Address is present. | Port Number | 2 | +| Mapped UE Usage Type | CO | The MME/SGSN shall include this IE on the S11/S4 interface, if available. When present, this IE shall contain the mapped UE usage type applicable to the PDN connection. See NOTE 21. | Mapped UE Usage Type | 0 | + +| | | | | | +|----------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|---| +| | CO | The SGW shall include this IE on S5 if it receives it from the MME/SGSN. | | | +| User Location Information for SGW | CO | The MME/SGSN shall include this IE on the S11/S4 interface, based on operator policy for the User Location Information to be sent to the SGW, if the user location information to be passed to the SGW is not already reported in the ULI IE in this message.

When present, this IE shall include the ECGI, TAI, eNodeB ID, RAI and/or RNC-ID, based on local policy. See NOTE 21. | ULI | 1 | +| SGW-U node name | CO | The SGW-C shall include this IE on the S5 interface, if available. See NOTE 21. | FQDN | 0 | +| Secondary RAT Usage Data Report | CO | If the PLMN has configured secondary RAT usage reporting and PDN GW Secondary RAT reporting is active, the MME shall include this IE on the S11 interface if it has received Secondary RAT usage data from eNodeB in an X2-based handover with Serving GW relocation. The MME shall also set the IRSGW flag to "0", to indicate that the Secondary RAT usage data is reported for the Source SGW, and sent via the Target SGW to the PGW. Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | Secondary RAT Usage Data Report | 0 | +| UP Function Selection Indication Flags | CO | Based on operator policy, the MME/S4-SGSN shall include this IE on the S4/S11 interface, if any of the applicable flags is set to 1.

Applicable flags are:
- DCNR: This flag shall be set to 1 if it is desired to select a specific SGW-U and PGW-U for UEs supporting Dual Connectivity with NR and not restricted from using NR by user subscription, e.g. due to requirements of higher bitrates.

See NOTE 21. | UP Function Selection Indication Flags | 0 | + +| | | | | | +|-------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|----| +| | CO | The SGW shall include this IE on S5/S8 if it receives it from the MME/S4-SGSN. | | | +| APN RATE Control Status | CO | If APN RATE Control Status is available in MME/S4-SGSN, APN RATE Control Status shall be transfered on the S4/S11 interface.
The SGW shall include the APN RATE Control Status IE on the S5/S8 interface, if received from the MME/S4-SGSN. | APN RATE Control Status | 0 | +| PSCell ID | CO | The MME shall include this IE on the S11 interface, if it has received this information from the eNodeB. | PSCell ID | 0 | +| Private Extension | O | This IE may be sent on the S5/S8, S4/S11 and S2a/S2b interfaces. | Private Extension | VS | + +- NOTE 1: The conditional PDN Type IE is redundant on the S4/S11 and S5/S8 interfaces (as the PAA IE contains exactly the same field). The receiver may ignore it. This IE is never sent on the S2a/S2b interface. +- NOTE 2: 3GPP TS 23.401 [3] (e.g. clause 5.3.2.1) and 3GPP TS 23.060 [35] (e.g. clause 9.2.2.1) defines the MME/SGSN shall send the MS Info Change Reporting Support Indication to the PGW. In such case MME/SGSN shall use the Change Reporting Support Indication and/or CSG Change Reporting Support Indication (whichever is applicable), even if stage 2 refers to MS Info Change Reporting Support Indication. +- NOTE 3: The methods that the ePDG may use to acquire the RAT type of the untrusted non-3GPP IP access network are not specified in this release. +- NOTE 4: The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the different access network types. +- NOTE 5: 3GPP TS 23.401 [3] (see clause 5.3.1.1) and 3GPP TS 23.060 [35] (see clause 9.2.1) specify the handling of the cases when UE has requested IPv4v6 PDN Type, but MME does not set the Dual Address Bearer Flag due to the MME operator using single addressing per bearer to support interworking with nodes of earlier releases. +- NOTE 6: The Bearer Context to be created IE and Bearer Context to be removed IE, together, shall contain all the bearers belonging to the given PDN connection with each bearer appearing in only one of these IEs. +- NOTE 7: During S1 based handover/ Inter RAT handover/TAU/RAU with S4-SGSN/MME and SGW change, and handover/RAU/TAU from Gn/Gp SGSN to S4-SGSN/MME, if the target MME/S4-SGSN cannot accept one or more PDN connection(s) but can accept at least one or more remaining PDN Connection(s) of the UE, the target MME/SGSN shall indicate all the non GBR bearers of the unaccepted PDN Connection in the Bearer Contexts to be created IE. The (target) MME/SGSN shall indicate all the GBR bearers of the unaccepted PDN connection in the Bearer Contexts to be removed IE. +- NOTE 8: The conditions of presence of the IEs in the Create Session Request for the MME and S4-SGSN triggered Serving GW relocation (see clause 5.10.4 of 3GPP TS 23.401 [3] and clause 9.2.2.4 of 3GPP TS 23.060 [35]) are identical to those specified respectively for X2 handover with SGW relocation and for Enhanced Serving RNS Relocation with SGW relocation. +- NOTE 9: During the TAU/RAU/Handover from Gn/Gp SGSN, the target MME/S4-SGSN cannot derive the level of support for User Location Change Reporting and/or CSG Information Change Reporting at the source Gn/Gp SGSN. +- NOTE 10: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator for supporting UEs, or that of the allocated Core Network Operator for non-supporting UEs. As an exception, based on inter-operator roaming/sharing agreement, if the information on whether the UE is a supporting or non-supporting UE is available, the PLMN ID that is communicated to the HPLMN for non-supporting UEs shall be the Common PLMN ID. +In shared networks, when the MME/S4-SGSN and PGW pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI to the PGW, and the Common PLMN ID shall be communicated in SAI/CGI to the PGW, for both supporting and non-supporting UEs. The Core Network Operator PLMN ID (selected by the UE for supporting UEs or allocated by the network for non-supporting UEs) shall be communicated in the TAI, RAI, UCI and the Serving Network. See clause 4.4 of 3GPP TS 23.251 [55]. +- NOTE 11: If the UE initiates a TAU or RAU procedure back to the old MME/old S4 SGSN before completing the ongoing TAU or RAU procedure and the UE is not accessed via a CSG cell or hybrid cell, the old MME/old S4-SGSN shall treat this case as the UE leaves a CSG or hybrid cell. . +- NOTE 12: Void +- NOTE 13: If supported, the PGW shall contact the 3GPP AAA server (identified by this IE which carries the Origin-Host and Origin-Realm included in the DEA message received by the ePDG/TWAN over SWm or STa interface) for establishing the S6b session. +- NOTE 14: Before contacting an EPC entity, e.g. to send a Create Session Request message, the MME/SGSN shall ensure, during the selection procedure, that the receiving entities support Non-IP PDN type, as specified in clause 5.9 of 3GPP TS 29.303 [32], e.g. using the Notification of Supported features procedure to learn if the candidate SGW supports the CIOT feature. See also the clause 8.83. +- NOTE 15: An MME, SGW and PGW which supports NB-IoT and/or Non-IP or Ethernet PDN type and/or inter-system change with 5GS and/or UAS services shall support ePCO. A UE supporting NB-IoT access and/or Non-IP or Ethernet PDN type and/or N1 mode and/or UAS services also support ePCO. +- NOTE 16: All the UE's SGi PDN Connections shall either have the Control Plane Only PDN Connection Indication set or not set. +- NOTE 17: If the APN was authorized based on the wildcard APN, the Selection Mode Value shall be set to indicate that the subscription is not verified, see Annex A of 3GPP TS 23.060 [35]. +- NOTE 18: The MME can set the Control Plane Only Indication only during a PDN connection creation procedure, and the Serving PLMN Rate Control is only applicable to the PDN connection with Control Plane Only Indication set. +During an inter MME with SGW relocation procedure, when the source MME has not set the Control + +Plane Only Indication, and the target MME supports only the Control Plane CIoT Optimizations, then the target MME shall not include the Serving PLMN Rate Control IE as the PDN connection cannot be changed to Control Plane Only. + +During an inter MME with SGW relocation procedure, when the source MME has set the Control Plane Only Indication and included Serving PLMN rate control IE in the Context Response message, and the target MME supports both the Control Plane CIoT Optimisation and the establishment of the User Plane, the target MME cannot stop the Serving PLMN Rate Control, i.e. the PGW will continue to enforce Serving PLMN Rate Control as the Control Plane Only Indication for this PDN connection cannot be changed during this mobility procedure. + +NOTE 19: An MME which supports eNB Change Reporting shall also support Change reporting and therefore shall set both the Change Report Supporting indication and the eNB Changing Reporting Support Indication. + +NOTE 20: Upon inter MME/SGSN mobility, the target MME/SGSN shall report Presence Reporting Area Information for all the active and inactive PRAs requested by the PGW. Upon intra MME/SGSN mobility with SGW relocation, the MME/SGSN shall only report active PRAs whose Presence Reporting Area Information is changed, e.g. from inside to outside, or vice versa. + +NOTE 21: This information is used for the SGW-U, PGW-U or combined SGW-U/PGW-U selection (see Annex B.2 of 3GPP TS 29.244 [80]). + +NOTE 22: An MME shall send the LTE-M RAT type to the SGW only if the latter is known to support it. The forwarding of the LTE-M RAT type to the PGW is controlled by the LTE-M RAT Type reporting to PGW Indication. + +NOTE 23: It is assumed that the N26 interface is supported homogeneously across a PLMN. + +NOTE 24: PDN connections of PDN Type "Ethernet" are not supported in GERAN/UTRAN. For PDN connections of PDN type "Ethernet", mobility to GERAN/UTRAN or Non 3GPP access from E-UTRAN is not supported. See clause 4.3.17.8a of TS 23.401 [3]. + +NOTE 25: Before contacting an EPC entity, e.g. to send a Create Session Request message, the MME shall ensure, during the selection procedure, that the receiving entities support Ethernet PDN type, as specified in clause 5.13 of 3GPP TS 29.303 [32], e.g. using the Notification of Supported features procedure to learn if the candidate SGW supports the ETH feature. See also the clause 8.83. + +NOTE 26: The MME should select an SGW supporting MT-EDT if MT-EDT is applicable for the PDN connection. + +NOTE 27: If the PGW-C/SMF receives the PDU session ID from the UE in the PCO, ePCO or APCO IE, the 5GCNRI flag is set to 1, and the PGW-C/SMF allows to transfer the PDN connection from EPC to 5GC, the PGW-C/SMF shall return the 5GS parameters as specified in 3GPP TS 23.501 [82] and 3GPP TS 23.502 [83] (e.g. mapped QoS parameters and S-NSSAI for interworking with N26 in the PCO or ePCO, S-NSSAI for interworking without N26 in the PCO or ePCO, or S-NSSAI for interworking between ePDG connected to EPC and 5GS in the APCO) in the Create Session Response message, regardless of the 5GSIWKI flag. The S-NSSAI included in either PCO, ePCO or APCO contains the PLMN ID (of the PGW-C/SMF) that the S-NSSAI relates to as specified in clause 10.5.6.3 of 3GPP TS 24.008 [5]. + +NOTE 28: If the LTE-M Satellite related RAT type is received from the MME, the SGW shall send the LTE-M RAT type to the PGW if the 'Satellite RAT Type reporting to PGW Indication' is not received and the 'LTE-M RAT Type reporting to PGW Indication' is received, or the SGW shall send the WB-E-UTRAN RAT type to the PGW if both of the indications are absent. + +**Table 7.2.1-2: Bearer Context to be created within Create Session Request** + +| Octet 1 | | Bearer Context IE Type = 93 (decimal) | | | +|----------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octet 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| TFT | O | This IE may be included on the S4/S11 interfaces. | Bearer TFT | 0 | +| S1-U eNodeB F-TEID | C | This IE shall be included on the S11 interface for X2-based handover with SGW relocation. | F-TEID | 0 | +| S4-U SGSN F-TEID | C | This IE shall be included on the S4 interface if the S4-U interface is used. | F-TEID | 1 | +| S5/S8-U SGW F-TEID | C | This IE shall be included on the S5/S8 interface for an "E-UTRAN Initial Attach", a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, a "PDP Context Activation", a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN or a "UE Requested PDN Connectivity". | F-TEID | 2 | +| S5/S8-U PGW F-TEID | C | This IE shall be included on the S4 and S11 interfaces for the TAU/RAU/Handover cases when the GTP-based S5/S8 is used. | F-TEID | 3 | +| | CO | For PMIP-based S5/S8, this IE shall be included on the S11/S4 interface for the TAU/RAU/Handover cases if the PGW provided an alternate address for user plane, i.e. an IP address for user plane which is different from the IP address for control plane.
When present, this IE shall contain the alternate IP address for user plane and the uplink GRE key.
See NOTE 1. | | | +| S12 RNC F-TEID | CO | This IE shall be included on the S4 interface if the S12 interface is used in the Enhanced serving RNS relocation with SGW relocation procedure. | F-TEID | 4 | +| S2b-U ePDG F-TEID | C | This IE shall be included on the S2b interface for an Attach with GTP on S2b, a UE initiated Connectivity to Additional PDN with GTP on S2b, a Handover to Untrusted Non-3GPP IP Access with GTP on S2b and an Initial Attach for emergency session (GTP on S2b). | F-TEID | 5 | +| S2a-U TWAN F-TEID | C | This IE shall be included on the S2a interface for an Initial Attach in WLAN on GTP S2a, an Initial Attach in WLAN for Emergency Service on GTP S2a, a UE initiated Connectivity to Additional PDN with GTP on S2a and a Handover to TWAN with GTP on S2a. | F-TEID | 6 | +| Bearer Level QoS | M | | Bearer QoS | 0 | +| S11-U MME F-TEID | CO | This IE shall be sent on the S11 interface, if S11-U is being used, during the E-UTRAN Initial Attach and UE requested PDN connectivity procedures.
This IE may also be sent on the S11 interface, if S11-U is being used, during a Tracking Area Update procedure with Serving GW change, if the MME needs to establish the S11-U tunnel.
See NOTE 2. | F-TEID | 7 | + +NOTE 1: The capability to receive from the LMA an alternate LMA address for user plane shall be supported homogeneously across all the SGWs, when supported over PMIP-based S5/S8. + +NOTE 2: Establishing the S11-U tunnel at once during the Create Session Request/Response procedure avoids the need for a subsequent Modify Bearer Request/Response exchange to transfer DL or UL user data. + +**Table 7.2.1-3: Bearer Context to be removed within Create Session Request** + +| | | | | | +|-----------------------------------------------------------|---------------------------------------|--------------------------------------------------------------------------------------|----------------|-------------| +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| S4-U SGSN F-TEID | C | This IE shall be sent on the S4 interface if the S4-U interface is used. See NOTE 1. | F-TEID | 0 | +| NOTE 1: The conditional S4-U SGSN F-TEID IE is redundant. | | | | | + +**Table 7.2.1-4: Overload Control Information within Create Session Request** + +| | | | | | +|----------------------------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | + +**Table 7.2.1-5: Remote UE Context Connected within Create Session Request** + +| | | | | | +|-----------------------------|-------------------------------------------|----------------------------------------------------------------|--------------------------|-------------| +| Octets 1 | Remote UE Context IE Type = 191 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octets 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Remote User ID | M | See clause 8.123 for the description and use of this parameter | Remote User ID | 0 | +| Remote UE IP Information | M | See clause 8.124 for the description and use of this parameter | Remote UE IP Information | 0 | + +## 7.2.2 Create Session Response + +The Create Session Response message shall be sent on the S11/S4 interfaces by the SGW to the MME/S4-SGSN, on the S5/S8 interfaces by the PGW to the SGW, on the S2b interface by the PGW to the ePDG, and on the S2a interface by the PGW to the TWAN as part of the procedures listed for the Create Session Request (see clause 7.2.1). + +A PGW may receive the Create Session Response message sent from another PGW (see clause 7.2.1), the PGW shall forward the Create Session response message to the SGW as received from another PGW but with the following modifications: + +- the destination IP address and UDP port of the message shall be set to the source IP address and UDP port of the Create Session Request message received from the SGW; +- the source IP address and UDP port of the message shall be set to the IP address and port of the forwarding PGW. + +In some network deployment, e.g. when 5G Network Slice is deployed and the combined PGW-C/SMFs are connected to the UDM, if the MME indicated in the Create Session Request that it supports PGW redirection due to mismatch with network slice subscribed by UE, the source PGW/SMF may select another PGW supporting the network slice for which the UE has a subscription and then reject the Create Session Request with the cause set to "PGW mismatch with + +network slice subscribed by the UE" and with the FQDN or IP address of the other PGW that the MME should use for establishing the PDN connection. + +NOTE: This can be used e.g. if there is no GTPv2/UDP/IP connectivity between PGW/SMFs pertaining to different network slices, or if the source PGW/SMF does not support forwarding the request to the target PGW/SMF as specified in clause 7.2.1. + +If handling of default bearer fails, then cause at the message level shall be a failure cause. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Request accepted". +- "Request accepted partially". +- "New PDN type due to network preference". +- "New PDN type due to single address bearer only". +- "Missing or unknown APN". +- "GRE key not found". +- "Preferred PDN type not supported". +- "All dynamic addresses are occupied". +- "Remote peer not responding". +- "Semantic error in the TFT operation". +- "Syntactic error in the TFT operation". +- "Semantic errors in packet filter(s)". +- "Syntactic errors in packet filter(s)". +- "User authentication failed". +- "APN access denied – no subscription". +- "APN Restriction type incompatibility with currently active PDN Connection". +- "Version not supported by next peer". +- "Denied in RAT". +- "Protocol type not supported". +- "APN congestion". +- "Multiple PDN connections for a given APN not allowed". +- "Multiple accesses to a PDN connection not allowed". +- "Context not found". +- "UE not authorised by OCS or external AAA Server". +- "PGW mismatch with network slice subscribed by the UE". + +**Table 7.2.2-1: Information Elements in a Create Session Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|------| +| Cause | M | See NOTE 2 and NOTE 4. | Cause | 0 | +| Change Reporting Action | C | This IE shall be included on the S5/S8 and S4/S11 interfaces with the appropriate Action field if the location Change Reporting mechanism is to be started or stopped for this subscriber in the SGSN/MME. | Change Reporting Action | 0 | +| CSG Information Reporting Action | CO | This IE shall be included on the S5/S8 and S4/S11 interfaces with the appropriate Action field if the CSG Info reporting mechanism is to be started or stopped for this subscriber in the SGSN/MME. | CSG Information Reporting Action | 0 | +| H(e)NB Information | CO | This IE shall be included on the S5/S8 and S4/S11 | H(e)NB | 0 | + +| | | | | | +|---------------------------------------------------------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---| +| Reporting | | interfaces with the appropriate Action field if H(e)NB information reporting is to be started or stopped (during a TAU/RAU with SGW change if started earlier) for the PDN connection in the SGSN/MME. | Information Reporting | | +| Sender F-TEID for Control Plane | C | This IE shall be sent on the S11/S4 interfaces. For the S5/S8/ S2a/S2b interfaces it is not needed because its content would be identical to the IE PGW S5/S8/ S2a/S2b F-TEID for PMIP based interface or for GTP based Control Plane interface. | F-TEID | 0 | +| PGW S5/S8/ S2a/S2b F-TEID for PMIP based interface or for GTP based Control Plane interface | C |

The PGW shall include this IE on the S5/S8 interfaces during the Initial Attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, UE requested PDN connectivity, PDP Context Activation and a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN procedures.

If the SGW receives this IE it shall forward the IE to MME/S4-SGSN on the S11/S4 interface.

This IE shall include the TEID for GTP based S5/S8 case and the uplink GRE key in the PMIP based S5/S8 case.

For PMIP based S5/S8, this IE shall be included on the S11/S4 interface and shall contain the PGW S5/S8 IP address for control plane; the same IP address shall be used for both control plane and the user plane communication if the Bearer Context IE does not contain a S5/S8-U PGW F-TEID IE. See NOTE 7.

The PGW shall include this IE on the S2b interface during the Attach with GTP on S2b, UE initiated Connectivity to Additional PDN with GTP on S2b, Handover to Untrusted Non-3GPP IP Access with GTP on S2b procedures and Initial Attach for emergency session (GTP on S2b).

The PGW shall include this IE on the S2a interface during the Initial Attach in WLAN on GTP S2a, an Initial Attach in WLAN for Emergency Service on GTP S2a, UE initiated Connectivity to Additional PDN with GTP on S2a and Handover to TWAN with GTP on S2a procedures See NOTE 6.

| F-TEID | 1 | +| PDN Address Allocation (PAA) | C |

This IE shall be included on the S5/S8, S4/S11 and S2a/S2b interfaces for the E-UTRAN initial attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, PDP Context Activation, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN, UE requested PDN connectivity, Attach with GTP on S2b, UE initiated Connectivity to Additional PDN with GTP on S2b, Handover to Untrusted Non-3GPP IP Access with GTP on S2b, Initial Attach for emergency session (GTP on S2b), Initial Attach in WLAN on GTP S2a, Initial Attach in WLAN for Emergency Service on GTP S2a, UE initiated Connectivity to Additional PDN with GTP on S2a and Handover to TWAN with GTP on S2a.

The PDN type field in the PAA shall be set to IPv4, or IPv6 or IPv4v6, Non-IP or Ethernet by the PGW. See NOTE4.

For the S4/S11 and S5/S8 interfaces, if the PGW uses DHCPv4 for IPv4 address allocation, the IPv4 address field shall be set to 0.0.0.0; otherwise, the IPv4 address field shall be set to non-zero value as specified in 3GPP TS 23.401 [3] and 3GPP TS 23.402 [45].

When assigning an IPv6 address the PGW shall send a non-zero Interface Identifier. See NOTE 8.

For Non-IP or Ethernet PDN connections, the PDN Address and Prefix field shall not be present.

| PAA | 0 | +| APN Restriction | C | This IE shall be included on the S5/S8 and S4/S11 interfaces in the E-UTRAN initial attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, PDP Context Activation, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN and | APN Restriction | 0 | + +| | | | | | +|---------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---| +| | | UE Requested PDN connectivity procedures.
This IE shall also be included on S4/S11 during the Gn/Gp SGSN to S4 SGSN/MME RAU/TAU procedures.
This IE denotes the restriction on the combination of types of APN for the APN associated with this EPS bearer Context. | | | +| Aggregate Maximum Bit Rate (APN-AMBR) | C | This IE represents the APN-AMBR. It shall be included on the S5/S8, S4/S11 and S2a/S2b interfaces if the received APN-AMBR has been modified by the PCRF. | AMBR | 0 | +| Linked EPS Bearer ID | C | This IE shall be sent on the S4/S11 interfaces during Gn/Gp SGSN to S4-SGSN/MME RAU/TAU procedure to identify the default bearer the PGW selects for the PDN Connection. | EBI | 0 | +| Protocol Configuration Options (PCO) | C | If ePCO is not supported by the UE or the network, and if the PGW decides to return PCO to the UE during the Attach, PDN connectivity or Handover to 3GPP access procedures, PGW shall send PCO to SGW. If SGW receives the PCO IE, SGW shall forward it to MME/SGSN. | PCO | 0 | +| | CO | For trusted WLAN access, if single-connection mode or multiple-connection mode is used, the PGW may include this IE over the S2a interface to send PCO to the UE. | | | +| Bearer Contexts created | M | EPS bearers corresponding to Bearer Contexts sent in request message. Several IEs with the same type and instance value may be included on the S5/S8 and S4/S11 as necessary to represent a list of Bearers. One single IE shall be included on the S2a/S2b interface.
One bearer shall be included for E-UTRAN Initial Attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, PDP Context Activation, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN, UE Requested PDN Connectivity , Attach with GTP on S2b, UE initiated Connectivity to Additional PDN with GTP on S2b, Handover to Untrusted Non-3GPP IP Access with GTP on S2b, Initial Attach for emergency session (GTP on S2b), Initial Attach in WLAN on GTP S2a, an Initial Attach in WLAN for Emergency Service on GTP S2a, UE initiated Connectivity to Additional PDN with GTP on S2a and Handover to TWAN with GTP on S2a.
One or more created bearers shall be included for a Handover/TAU/RAU with an SGW change. See NOTE 2. | Bearer Context | 0 | +| Bearer Contexts marked for removal | C | EPS bearers corresponding to Bearer Contexts to be removed that were sent in the Create Session Request message.
For each of those bearers an IE with the same type and instance value shall be included on the S4/S11 interfaces. | Bearer Context | 1 | +| Recovery | C | This IE shall be included on the S4/S11, S5/S8 and S2a/S2b interfaces if contacting the peer for the first time | Recovery | 0 | +| Charging Gateway Name | C | When Charging Gateway Function (CGF) Address is configured, the PGW shall include this IE on the S5 interface. See NOTE 1. | FQDN | 0 | +| Charging Gateway Address | C | When Charging Gateway Function (CGF) Address is configured, the PGW shall include this IE on the S5 interface. See NOTE 1. | IP Address | 0 | +| PGW-FQ-CSID | C | This IE shall be included by the PGW on the S5/S8 and S2a/S2b interfaces and, when received from S5/S8 be forwarded by the SGW on the S11 interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| SGW-FQ-CSID | C | This IE shall be included by the SGW on the S11 interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 1 | +| SGW LDN | O | This IE is optionally sent by the SGW to the MME/SGSN on the S11/S4 interfaces (see 3GPP TS 32.423 [44]), when communicating the LDN to the peer node for the first time. | Local Distinguished Name (LDN) | 0 | +| PGW LDN | O | This IE is optionally included by the PGW on the S5/S8 and S2a/S2b interfaces (see 3GPP TS 32.423 [44]), when communicating the LDN to the peer node for the first time. | Local Distinguished Name (LDN) | 1 | +| PGW Back-Off Time | O | This IE may be included on the S5/S8 and S4/S11 interfaces when the PDN GW rejects the Create Session | EPC Timer | 0 | + +| | | | | | +|--------------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|---| +| | | Request with the cause "APN congestion". It indicates the time during which the MME or S4-SGSN should refrain from sending subsequent PDN connection establishment requests to the PGW for the congested APN for services other than Service Users/emergency services.
See NOTE 3. | | | +| Additional Protocol Configuration Options (APCO) | CO | If multiple authentications are supported by the PGW and if PGW received the Additional Protocol Configuration Options IE in the Create Session Request, the PGW shall include this IE on the S2b interface and perform the corresponding procedures as specified for PAP and CHAP authentication of the UE with external networks in 3GPP TS 33.402 [50]. | Additional Protocol Configuration Options (APCO) | 0 | + +| | | | | | +|------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|---| +| | O |

If the PGW supports the Additional Protocol Configuration Options IE and if the PGW has received the Additional Protocol Configuration Options IE with the "DNS IPv4/IPv6 Server Address Request" parameter in the Create Session Request over S2b interface, the PGW may include this IE over the S2b interface with the "DNS IPv4/IPv6 Server Address" parameter as specified in 3GPP TS 24.008 [5].

If the PGW supports the Additional Protocol Configuration Options IE and if the PGW has received the Additional Protocol Configuration Options IE with the P-CSCF IPv4 Address Request, or P-CSCF IPv6 Address Request or both parameters in the Create Session Request over the S2b interface, the PGW may include this IE over the S2b interface with the P-CSCF IPv4 Address, or P-CSCF IPv6 Address, or both parameters respectively as specified in 3GPP TS 24.008 [5].

If the PGW supports the Additional Protocol Configuration Options IE and if the PGW has received the Additional Protocol Configuration Options IE with a PDU session ID in the Create Session Request over the S2b interface, the PGW may include this IE over the S2b interface with the S-NSSAI and the PLMN ID that the S-NSSAI relates to as specified in 3GPP TS 24.302 [63] and 3GPP TS 24.008 [5].

| | | +| | O | The PGW may include this IE on the S2a interface to provide the TWAN with additional IP configuration parameters (e.g. DNS server), if a corresponding request was received in the Create Session Request message. | | | +| Trusted WLAN IPv4 Parameters | CO |

The PGW shall include this IE on the S2a interface to a Trusted WLAN Access if PDN Type in the PAA is set to IPv4 or IPv4v6 and the transparent single-connection mode is used as specified in 3GPP TS 23.402 [45].

This IE shall include:

  • - The Subnet Prefix Length of the subnet from which the PGW allocates the UE's IPv4 address.
  • - The IPv4 Default Router Address which belongs to the same subnet as the IPv4 address allocated to the UE.
| IPv4 Configuration Parameters (IP4CP) | 0 | + +| | | | | | +|--------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---| +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - PDN Pause Support Indication: this flag shall be set to 1 on the S5/S8 interface if the PGW supports the PGW Pause of Charging procedure.
  • - PDN Pause Enable Indication: this flag shall be set to 1 on the S5/S8 interface if the PGW enables the SGW to use the PGW Pause of Charging procedure for this PDN connection.
  • - Associate OCI with PGW node's identity: The PGW shall set this flag to 1 on the S5/S8 interface or S2a/S2b interface if it has included the "PGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the HSS or DNS during the PGW selection) of the serving PGW. This flag shall be set to 1 by the PGW if the "PGW's Overload Control Information" is included and the Cause IE is set to a rejection cause code. The SGW shall set this flag on the S11/S4 interface if it supports the overload control feature and if the flag is set on the S5/S8 interface.
  • - Associate OCI with SGW node's identity: The SGW shall set this flag to 1 on the S11/S4 interface if it has included the "SGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW. This flag shall be set to 1 by the SGW if the "SGW's Overload Control Information" is included and the Cause IE is set to a rejection cause code.
  • - Delay Tolerant Connection Indication: the flag shall be set to 1 on the S5/S8 and S11/S4 interface if the PDN connection is "Delay Tolerant" (see clause 8.12).
  • - Triggering SGSN initiated PDP Context Creation/Modification Indication: this flag shall be set to 1 on the S5/S8 interfaces if the network-initiated NBIFOM mode is used for this PDN connection. The SGW shall set this flag on the S4 interface if it supports the NBIFOM feature and the flag is set on the S5/S8 interface.
  • - Notify Start Pause of charging via User plane Support Indication: this flag shall be set to 1 on the S5/S8 interface if PDN Pause Enable Indication is set to "1" and if the PGW-C and PGW-U support the Notify Start Pause of Charging via user plane feature as specified in clause 5.30 of 3GPP TS 29.244 [80].
| Indication | 0 | +| Presence Reporting Area Action | CO | This IE shall be included on the S5/S8 and S11/S4 interfaces with the appropriate Action field if reporting changes of UE presence in a Presence Routing Area is to be started, stopped or modified for this subscriber in the MME/SGSN.

Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Actions. One IE shall be included per PRA to be started, stopped or modified. | Presence Reporting Area Action | 0 | +| PGW's node level Load Control | O | The PGW may include this IE on the S5/S8 or S2a/S2b interface, providing its node level load information, if the | Load Control Information | 0 | + +| | | | | | +|-------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---| +| Information | | load control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access network, ePDG/TWAN for non-3GPP access network, belongs (see clause 12.2.6). | | | +| | CO | If the SGW receives this IE and if it supports the load control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| PGW's APN level Load Control Information | O | The PGW may include this IE on the S5/S8 or S2a/S2b interface, providing APN level load information, if the APN level load control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access network, ePDG/TWAN for non-3GPP access based network, belongs (see clause 12.2.6).

When present, the PGW shall provide one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the load information for a list of APN(s).
See NOTE 9, NOTE 11. | Load Control Information | 1 | +| | CO | If the SGW receives this IE and if it supports APN level load control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's node level Load Control Information | O | The SGW may include this IE, over the S11/S4 interface if the load control feature is supported by the SGW and is activated in the network (see clause 12.2.6).

When present, the SGW shall provide only one instance of this IE, representing its node level load information. | Load Control Information | 2 | +| PGW's Overload Control Information | O | During an overload condition, the PGW may include this IE on the S5/S8 or S2a/S2b interface, if the overload control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access based network, ePDG/TWAN for non-3GPP access based network, belongs (see clause 12.3.11).

When present, the PGW shall provide:
  • - node level overload control, in one instance of this IE; and/or
  • - APN level overload control , in one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the overload information for a list of APN(s).
See NOTE 10, NOTE 12. | Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S11/S4 interface if the overload control feature is supported by the SGW and is activated in the network (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| NBIFOM Container | CO | This IE shall be included on the S5/S8 or S2a/S2b interfaces if the PGW needs to send NBIFOM information as specified in 3GPP TS 23.161 [71].
The Container Type shall be set to 4. | F-Container | 0 | + +| | | | | | +|------------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---| +| | CO | If the SGW receives an NBIFOM Container from the PGW, the SGW shall forward this IE to the MME/S4-SGSN on the S11/S4 interface. | | | +| PDN Connection Charging ID | CO | The PGW shall include this IE on the S5/S8 or S2a/S2b interfaces, during an Initial Attach, Initial PDN connection establishment, or Addition of an access procedures, when using NBIFOM, as specified in 3GPP TS 23.161 [71]. | Charging ID | 0 | +| Extended Protocol Configuration Options (ePCO) | CO | If the PGW decides to return ePCO to the UE during an Initial Attach, UE requested PDN Connectivity procedure, and if the PGW supports the ePCO and the EPCOSI flag is set to 1 in the Create Session Request message, the PGW shall send ePCO to the SGW.

If the SGW receives the ePCO IE, the SGW shall forward it to the MME.
See NOTE 13. | ePCO | 0 | +| PGW node name | CO | This IE shall be included over S5/S8 interfaces by the PGW when it receives the corresponding Create Session Request message with the CSRMTI flag set to "1", and the creation of the PDN connection has been accepted.

If the SGW receives this IE, the SGW shall forward it to the MME over S11 interface. (See NOTE 14) | FQDN | 1 | +| SGi PtP Tunnel Address | CO | This IE shall be included on the S5/S8 and S4/S11 interfaces, if the PDN Type is "Non-IP" and SGi PtP tunnelling based on UDP/IP is used (see clause 4.3.17.8.3.3.2 of 3GPP TS 23.401 [3]).

When present, the IE shall contain the IPv4 or IPv6 address, and optionally the UDP port, that is allocated for the SGi PtP tunnel based on UDP/IP. | SGi PtP Tunnel Address | 0 | +| PGW Change Info | CO | This IE shall be included on the S5/S8/S2b interface by the PGW if it supports the Restoration of PDN connections after an PGW-C/SMF Change procedure as specified in clause 31 of 3GPP TS 23.007 [17] and if the "Restoration of PDN connections after an PGW-C/SMF Change Support Indication" was set to 1 in the request.

An SGW that supports the Restoration of PDN connections after an PGW-C/SMF Change procedure as specified in clause 31 of 3GPP TS 23.007 [17], shall transparently forward this IE over the S11 interface if it is received in a Create Session Response or a Modify Bearer Response message from the PGW over S5/S8. | PGW Change Info | 0 | +| Alternative PGW-C/SMF FQDN | O | This IE may be included by the PGW on the S5/S8 interfaces, when the PGW rejects the Create Session Request with the cause "PGW mismatch with network slice subscribed by the UE".

If the SGW receives this IE, the SGW shall forward it to the MME over the S11 interface.

When present, the IE shall contain the FQDN of the other PGW that the MME should use for establishing the PDN connection.
Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF FQDNs. (See NOTE 15) | FQDN | 3 | + +| | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|----| +| Alternative PGW-C/SMF IP Address | O | This IE may be included by the PGW on the S5/S8 interfaces, when the PGW rejects the Create Session Request with the cause "PGW mismatch with network slice subscribed by the UE".

If the SGW receives this IE, the SGW shall forward it to the MME over the S11 interface.

When present, the IE shall contain the IP Address of the other PGW that the MME should use for establishing the PDN connection.
Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF FQDNs. (See NOTE 15) | IP Address | 1 | +| UP Security Policy | CO | This IE shall be included on the S5/S8 and S11 interfaces in the E-UTRAN initial attach and UE Requested PDN connectivity procedures, if UP Integrity Protection is supported by the UE, MME and E-UTRAN (i.e. if the UPIPSI flag was set to 1) and if User Plane Integrity Protection policy is available for the PDN connection. When present, it shall indicate whether User Plane integrity protection is required, preferred or not needed for the traffic of the PDN connection. | UP Security Policy | 0 | +| Private Extension | O | This IE may be sent on the S5/S8, S4/S11 and S2a/S2b interfaces. | Private Extension | VS | +| NOTE1: Both Charging Gateway Name and Charging Gateway Address shall not be included at the same time. When both are available, the operator configures a preferred value.
NOTE2: If the SGW cannot accept any of the "Bearer Context Created" IEs within Create Session Request message, the SGW shall send the Create Session Response with appropriate reject Cause value.
NOTE 3: The last received value of the PGW Back-Off Time IE shall supersede any previous values received from that PGW and for this APN in the MME/SGSN.
NOTE4: 3GPP TS 23.401 [3] (see clause 5.3.1.1) and 3GPP TS 23.060 [35] (see clause 9.2.1) specify the handling of the cases when UE has requested IPv4v6 PDN Type, but PGW restricts the usage of IPv4v6 PDN Type.
NOTE 5: The conditions of presence of the IEs in the Create Session Response for the MME and S4-SGSN triggered Serving GW relocation (see clause 5.10.4 of 3GPP TS 23.401 [3] and clause 9.2.2.4 of 3GPP TS 23.060 [35]) are identical to those specified respectively for X2 handover with SGW relocation and for Enhanced Serving RNS Relocation with SGW relocation.
NOTE 6: The IP address and TEID/GRE key in "PGW S5/S8/ S2a/S2b F-TEID for PMIP based interface or for GTP based Control Plane interface" IE are only provided for the subsequent GTP-C initial messages related to this PDN connection and shall NOT be used for other PDN connections.
NOTE 7: For PMIP based S5/S8, the 'S5/S8-U PGW F-TEID' IE and the 'PGW S5/S8/ S2a/S2b F-TEID for PMIP based interface or for GTP based Control Plane interface' IE shall contain the same uplink GRE key; the Interface Type in these IEs shall be set to the value 9 (S5/S8 PGW PMIPv6 interface).
NOTE 8: The Interface Identifier value of zero is a reserved value (see IETF RFC 5453 [58]). Clause 5.3.1.2.2 of 3GPP TS 23.401 [3] specifies the mechanism for preventing UE's link-local address collision with the PGW's link-local address.
NOTE 9: The receiver, not supporting the APN level load control feature, shall ignore all the occurrence(s) of this IE, i.e. "Load Control Information" IE with instance number "1". The receiver, supporting the APN level load control feature and supporting the APN level load information for the maximum of 10 APNs, shall handle the APN level load information for the first 10 APNs and ignore any more APN level load information.
NOTE 10: The receiver, supporting the APN level overload information for the maximum of 10 APNs, shall handle the APN level overload information for the first 10 APNs and ignore any more APN level overload information.
NOTE 11: The APN level load information, provided within and across different instances of the "PGW's APN level Load Control Information" IE(s) shall be limited to 10 different APNs.
NOTE 12: The APN level overload information, provided within and across different instances of the "PGW's Overload Control Information" IE(s) shall be limited to 10 different APNs.
NOTE 13: The MME shall consider the presence of the ePCO IE in the Create Session Response message as an indication that the PGW and the SGW support the ePCO. The UE considers that the PGW supports ePCO when it receives an ePCO from the PGW.
NOTE 14: The MME shall update the PGW FQDN associated with this PDN connection using this IE.
NOTE 15: For a given alternative PGW, either the Alternative PGW-C/SMF FQDN IE or the Alternative PGW-C/SMF IP Address IE may be present, not both. | | | | | + +**Table 7.2.2-2: Bearer Context Created within Create Session Response** + +| Octets 1 | | Bearer Context IE Type = 93 (decimal) | | | +|----------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octets 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Cause | M | This IE shall indicate if the bearer handling was successful, and if not, it gives information on the reason. (NOTE 1, NOTE 2, NOTE 3) | Cause | 0 | +| S1-U SGW F-TEID | C | This IE shall be included on the S11 interface if the S1-U interface is used, i.e. if the S11-U Tunnel flag was not set in the Create Session Request. . See NOTE 6. | F-TEID | 0 | +| S4-U SGW F-TEID | C | This IE shall be included on the S4 interface if the S4-U interface is used. | F-TEID | 1 | +| S5/S8-U PGW F-TEID | C | For GTP-based S5/S8, this User Plane IE shall be included on S4/S11 and S5/S8 interfaces during the "E-UTRAN Initial Attach", a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, a "PDP Context Activation", a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN or a "UE Requested PDN Connectivity".

For PMIP-based S5/S8, this IE shall be included on the S4/S11 interface during the "E-UTRAN Initial Attach", a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, a "PDP Context Activation", a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN or a "UE Requested PDN Connectivity" if the PGW provided an alternate address for user plane, i.e. an IP address for user plane which is different from the IP address for control plane.
When present, this IE shall contain the alternate IP address for user plane and the uplink GRE key.
See NOTE 4 and NOTE 5. | F-TEID | 2 | +| S12 SGW F-TEID | C | This IE shall be included on the S4 interface if the S12 interface is used. | F-TEID | 3 | +| S2b-U PGW F-TEID | C | This IE (for user plane) shall be included on the S2b interface during the Attach with GTP on S2b, UE initiated Connectivity to Additional PDN with GTP on S2b, Handover to Untrusted Non-3GPP IP Access with GTP on S2b, and Initial Attach for emergency session (GTP on S2b). | F-TEID | 4 | +| S2a-U PGW F-TEID | C | This IE (for user plane) shall be included on the S2a interface during the Initial Attach in WLAN on GTP S2a, an Initial Attach in WLAN for Emergency Service on GTP S2a, UE initiated Connectivity to Additional PDN with GTP on S2a, and Handover to TWAN with GTP on S2a. | F-TEID | 5 | +| Bearer Level QoS | C | This IE shall be included on the S5/S8, S4/S11 and S2a/S2b interfaces if the received QoS parameters have been modified. | Bearer QoS | 0 | +| Charging Id | C | This IE shall be included on the S5/S8 interface for an E-UTRAN initial attach, a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, a PDP Context Activation, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN and a UE requested PDN connectivity. | Charging Id | 0 | +| | O | If the S5/S8 interface is GTP, this IE may be included on the S4 interface, in order to support CAMEL charging at the SGSN, for a PDP Context Activation, a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN, inter S4-SGSN RAU with SGW change and Gn/Gp to S4-SGSN RAU. | | | +| | CO | This IE shall be included on the S2a/S2b interface for an Initial Attach in WLAN on GTP S2a, an Initial Attach in WLAN for Emergency Service on GTP S2a, Attach with GTP on S2b, UE initiated Connectivity to Additional PDN with GTP on S2b, Handover to Untrusted Non-3GPP IP | | | + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|---| +| | | Access with GTP on S2b, Initial Attach for emergency session (GTP on S2b, UE initiated Connectivity to Additional PDN with GTP on S2a, and Handover to TWAN with GTP on S2a. | | | +| Bearer Flags | O | Applicable flags are:
- PPC (Prohibit Payload Compression) : this flag may be set on the S5/S8 and S4 interfaces. | Bearer Flags | 0 | +| S11-U SGW F-TEID | C | This IE shall be included on the S11 interface if the S11-U interface is used, i.e. if the S11-U Tunnel flag was set in the Create Session Request.
If the SGW supports both IP address types, the SGW shall send both IP addresses within the F-TEID IE. If only one IP address is included, then the MME shall assume that the SGW does not support the other IP address type. | F-TEID | 6 | +| NOTE 1: According to 3GPP TS 23.401 [3] e.g. clause 5.5.1.2.2 "S1-based handover, normal" and 3GPP TS 23.060 [35], during the handover procedure with an SGW change, except in the case of X2-handover (NOTE2 addresses X2 based HO with SGW change case), the target MME/S4-SGSN initiates the Create Session Request/Response and Modify Bearer Request/Response procedures one after the other. After receiving the "Bearer Context to be Created" IEs within Create Session Request message, the SGW may not accept some of these bearers. The SGW however shall return all bearers with the "Bearer Context Created" IEs within Create Session Response message (this table), but with different Cause values. Bearers that were not accepted by the SGW shall have an appropriate rejection value in the Cause IE. The target MME/S4-SGSN shall send these non-accepted bearers to the target SGW within the "Bearer Context to be removed" IE in a subsequent Modify Bearer Request message. Therefore, the SGW shall allocate the DL S5/S8 SGW F-TEIDs also for the non-accepted bearers. MME/S4-SGSN should remove all of the non-accepted bearers by separate procedures (e.g. an MME/S4-SGSN initiated Dedicated Bearer Deactivation procedure). | | | | | +| NOTE 2: According to 3GPP TS 23.401 [3] clause 5.5.1.1.3, "X2-based handover with Serving GW relocation", and 3GPP TS 23.060 [35] clause 6.9.2.2.5.A "Enhanced Serving RNS Relocation Procedure using S4", during the X2-handover procedure with an SGW change and Enhanced Serving RNS Relocation Procedure with an SGW change, the target MME/S4-SGSN shall initiate only the Create Session Request/Response procedure. The SGW shall return all bearers (including those not accepted by the SGW) with a "Bearer Context Created" IE within Create Session Response message (this table), but with different Cause values. Bearers that were not accepted by the SGW shall have an appropriate rejection value in the Cause IE. The MME/S4-SGSN should remove these non-accepted bearers by separate procedures as well. | | | | | +| NOTE 3: According to 3GPP TS 23.401 [3] e.g. clause 5.3.3.1 "Tracking Area Update procedure with Serving GW change" and 3GPP TS 23.060 [35], during the RAU/TAU procedure with an SGW change, the target MME/S4-SGSN shall initiate only the Create Session Request/Response procedure. The SGW shall return all bearers (including those not accepted by the SGW) with a "Bearer Context Created" IE within Create Session Response message (this table), but with different Cause values. Bearers that were not accepted by the SGW shall have an appropriate rejection value in the Cause IE. When Active Flag or Follow-on request is set during TAU/RAU procedure, MME/S4-SGSN should not establish user plane tunnel over S1 or Iu for those bearer contexts which were not accepted by the target SGW, while in the corresponding Modify Bearer Request message, the MME/S4-SGSN shall include all accepted bearer contexts in the "Bearer Context to be modified" IE and include all non-accepted bearer contexts in the "Bearer Context to be removed" IE. The MME/S4-SGSN should remove the bearers non-accepted by either SGW or eNB/RNC by separate procedures as well. | | | | | +| NOTE 4: The capability to receive from the LMA an alternate LMA address for user plane shall be supported homogeneously across all the SGWs, when supported over PMIP-based S5/S8. | | | | | +| NOTE 5: For PMIP based S5/S8, the 'S5/S8-U PGW F-TEID' IE and the 'PGW S5/S8/ S2a/S2b F-TEID for PMIP based interface or for GTP based Control Plane interface' IE shall contain the same uplink GRE key; the Interface Type in these IEs shall be set to the value 9 (S5/S8 PGW PMIPv6 interface). | | | | | +| NOTE 6: When Control Plane CLoT EPS Optimization is supported, the IP address spaces for S1-U and S11-U may be different, based on operator's deployment. If so, the following requirements shall apply:
1) if the CPOPCI (Control Plane Only PDN Connection Indication) flag is not set in the Create Session Request message, the SGW shall include both the S11-U SGW F-TEID and S1-U SGW F-TEID in the Create Session Response message, regardless of whether the S11-U Tunnel flag is set in the Create Session Request.
2) all the MMEs in the PLMN shall support receiving both the S11-U SGW F-TEID and S1-U SGW F-TEID in the Create Session Response message; the MME shall use them according to whether the CLoT Control Plane Optimization is used. | | | | | + +**Table 7.2.2-3: Bearer Context marked for removal within a Create Session Response** + +| | | | | | +|-----------------------------|---------------------------------------|----------------------------------------------------------------------------------------------------------------|----------------|-------------| +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Cause | M | This IE shall indicate if the bearer handling was successful, and if not, gives the information on the reason. | Cause | 0 | + +**Table 7.2.2-4: Load Control Information within Create Session Response** + +| | | | | | +|-----------------------------------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-------------| +| Octet 1 | Load Control Information IE Type = 181 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Load Control Sequence Number | M | See clause 12.2.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Load Metric | M | See clauses 12.2.5.1.2.2 and 12.2.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| List of APN and Relative Capacity | CO | The IE shall (only) be present in the "PGW's APN level Load Control Information" IE.
For indicating the APN level load, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) & its respective "Relative Capacity" (sharing the same "Load Metric").
See clause 12.2.5.1.2.3 for the description and use of this parameter.
See NOTE 1. | APN and Relative Capacity | 0 | + +NOTE 1: If more than 10 occurrences of "APN and Relative Capacity" IE are received within one instance of the Load Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Load Control Information IE instance. + +**Table 7.2.2-5: Overload Control Information within Create Session Response** + +| | | | | | +|----------------------------------|------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clauses 12.3.5.1.2.3 and 12.3.5.1.2.4 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | +| List of Access Point Name (APN) | CO | The IE may (only) be present in the "PGW's Overload Control Information" IE.
For indicating the APN level overload, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) (sharing the same "Overload Reduction Metric" and "Period of Validity"). See NOTE 1. | APN | 0 | + +NOTE 1: If more than 10 occurrences of APNs are received within one instance of the Overload Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Overload Control Information IE instance. + +**Table 7.2.2-6: PGW Change Info within Create Session Response** + +| | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------| +| Octet 1 | PGW Change Info IE Type = 214 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| PGW Set FQDN | C | When present, this IE shall contain the PGW Set FQDN of the PGW-C/SMF set to which the PGW-C/SMF belongs.
(NOTE) | PGW FQDN | 0 | +| Alternative PGW-C/SMF IP Address | C | When present, this IE shall contain alternative PGW-C/SMF IP addresses within the PGW-C/SMF set to which the PGW-C/SMF belongs.

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF IP Addresses.
(NOTE) | IP Address | 0 | +| Alternative PGW-C/SMF FQDN | C | When present, this IE shall contain alternative PGW-C/SMF FQDN within the PGW-C/SMF set to which the PGW-C/SMF belongs.

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF FQDNs.
(NOTE) | PGW FQDN | 1 | +| Group Id | O | When present, this IE shall identify the group to which the PDN connection pertains (see clause 31.6 of 3GPP TS 23.007 [17]). | Group Id | 0 | +| NOTE: Either the PGW Set FQDN IE, the Alternative PGW-C/SMF IP Address IE, or the Alternative PGW-C/SMF FQDN IE shall be present. | | | | | + +## 7.2.3 Create Bearer Request + +The direction of this message shall be from PGW to SGW and from SGW to MME/S4-SGSN, and from PGW to TWAN/ePDG (see Table 6.1-1). + +The Create Bearer Request message shall be sent on the S5/S8 interface by the PGW to the SGW and on the S11 interface by the SGW to the MME as part of the Dedicated Bearer Activation procedure. + +The message shall also be sent on the S5/S8 interface by the PGW to the SGW and on the S4 interface by the SGW to the SGSN as part of the Secondary PDP Context Activation procedure or the Network Requested Secondary PDP Context Activation procedure. + +The message shall also be sent on the S2a interface by the PGW to the TWAN as part of the Dedicated bearer activation in WLAN on GTP S2a, and on the S2b interface by the PGW to the ePDG as part of the Dedicated S2b bearer activation with GTP on S2b. + +The message shall also be sent on the S5/S8 or S2a/S2b interface by the PGW to the SGW or to the TWAN/ePDG and on the S11/S4 interface by the SGW to the MME/S4-SGSN as part of the Network-initiated IP flow mobility procedure or the UE-initiated IP flow mobility procedure, as specified by 3GPP TS 23.161 [71]. + +**Table 7.2.3-1: Information Elements in a Create Bearer Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------| +| Procedure Transaction Id (PTI) | C | This IE shall be sent on the S5/S8 and S4/S11 interfaces when the procedure was initiated by a UE Requested Bearer Resource Modification Procedure or UE Requested Bearer Resource Allocation Procedure (see NOTE 1) or Secondary PDP Context Activation Procedure. The PTI shall be the same as the one used in the corresponding Bearer Resource Command. | PTI | 0 | +| Linked EPS Bearer ID (LBI) | M | This IE shall be included to indicate the default bearer associated with the PDN connection. | EBI | 0 | +| Protocol | O | This IE may be sent on the S5/S8 and S4/S11 interfaces if | PCO | 0 | + +| | | | | | +|-------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|---| +| Configuration Options (PCO) | | ePCO is not supported by the UE or the network. | | | +| Bearer Contexts | M | Several IEs with this type and instance values shall be included as necessary to represent a list of Bearers. | Bearer Context | 0 | +| PGW-FQ-CSID | C | This IE shall be included by the PGW on the S5/S8 and S2a/S2b interfaces and, when received from S5/S8 be forwarded by the SGW on the S11 interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| SGW-FQ-CSID | C | This IE shall be included by the SGW on the S11 interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 1 | +| Change Reporting Action | C | This IE shall be included on the S5/S8 and S4/S11 interfaces with the appropriate Action field If the location Change Reporting mechanism is to be started or stopped for this subscriber in the SGSN/MME. | Change Reporting Action | 0 | +| CSG Information Reporting Action | CO | This IE shall be included on the S5/S8 and S4/S11 interfaces with the appropriate Action field if the CSG Info reporting mechanism is to be started or stopped for this subscriber in the SGSN/MME. | CSG Information Reporting Action | 0 | +| H(e)NB Information Reporting | CO | This IE shall be included on the S5/S8 and S4/S11 interfaces with the appropriate Action field if H(e)NB information reporting is to be started or stopped for the PDN connection in the SGSN/MME. | H(e)NB Information Reporting | 0 | +| Presence Reporting Area Action | CO | This IE shall be included on the S5/S8 and S11/S4 interfaces with the appropriate Action field if reporting changes of UE presence in a Presence Routing Area is to be started, stopped or modified for this subscriber in the MME/SGSN.

Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Actions. One IE shall be included per PRA to be started, stopped or modified. | Presence Reporting Area Action | 0 | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:

  • - Associate OCI with PGW node's identity: The PGW shall set this flag to 1 on the S5/S8 interface or S2a/S2b interface if it has included the "PGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the HSS or DNS during the PGW selection) of the serving PGW. The SGW shall set this flag on the S11/S4 interface if it supports the overload control feature and if the flag is set on the S5/S8 interface.
  • - Associate OCI with SGW node's identity: The SGW shall set this flag to 1 on the S11/S4 interface if it has included the "SGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW.
  • - Extended EBI Value Range Support Indication: The PGW shall set this flag to "1" if it supports the 15 EPS Bearers.
| Indication | 0 | +| PGW's node level Load Control Information | O | The PGW may include this IE on the S5/S8 or S2a/S2b interface, providing its node level load information, if the load control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access network, ePDG/TWAN for non-3GPP access network, belongs (see clause 12.2.6). | Load Control Information | 0 | + +| | | | | | +|-------------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---| +| | CO | If the SGW receives this IE and if it supports the load control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| PGW's APN level Load Control Information | O | The PGW may include this IE on the S5/S8 or S2a/S2b interface, providing APN level load information, if the APN level load control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access network, ePDG/TWAN for non-3GPP access based network, belongs (see clause 12.2.6).

When present, the PGW shall provide one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the load information for a list of APN(s).
See NOTE 2, NOTE 4. | Load Control Information | 1 | +| | CO | If the SGW receives this IE and if it supports APN level load control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's node level Load Control Information | O | The SGW may include this IE, over the S11/S4 interface if the load control feature is supported by the SGW and is activated in the network (see clause 12.2.6).

When present, the SGW shall provide only one instance of this IE, representing its node level load information. | Load Control Information | 2 | +| PGW's Overload Control Information | O | During an overload condition, the PGW may include this IE on the S5/S8 or S2a/S2b interface, if the overload control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access based network, ePDG/TWAN for non-3GPP access based network, belongs (see clause 12.3.11).

When present, the PGW shall provide
  • - node level overload control, in one instance of this IE; and/or
  • - APN level overload control, in one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the overload information for a list of APN(s).
See NOTE 3, NOTE 5. | Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S11/S4 interface if the overload control feature is supported by the SGW and is activated in the network (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| NBIFOM Container | CO | This IE shall be included on the S5/S8 and S2a/S2b interfaces if the PGW needs to send NBIFOM information as specified in 3GPP TS 23.161 [71]. The Container Type shall be set to 4. | F-Container | 0 | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|----| +| | CO | If the SGW receives a NBIFOM Container IE from the PGW, the SGW shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| PGW Change Info | CO | This IE may be included on S5/S8/S2b if the PGW needs to change the PGW Change Info signaled earlier for the PDN connection. It shall be included by the PGW if the PGW S5/S8/S2b IP Address for the control plane for the PDN connection is required to be changed (see PGW triggered PDN connection restoration in clauses 31.4 and 31.4B of 3GPP TS 23.007 [17]).
The SGW shall transparently forward this IE over the S11 interface.

Several IEs with the same IE type and Instance may be present to request the MME/ePDG to re-establish PDN connections associated with either different FQ-CSIDs, or Group Ids or PGW-C/SMF IP addresses to different PGW-C/SMFs. | PGW Change Info | 0 | +| Sender F-TEID for Control Plane | CO | This IE may be included over S5/S8/S2b if the PGW Change Info is present, during a PGW triggered PDN connection restoration (see clauses 31.4 and 31.4B of 3GPP TS 23.007 [17]). When present, it shall contain the F-TEID including the TEID that the SGW or ePDG shall use when sending the Create Bearer Response message.

This IE may be included over S11 if the PGW Change Info is present, during a Combined SGW-C/PGW-C/SMF triggered PDN connection restoration (see clause 31.4A of 3GPP TS 23.007 [17]). When present, it shall contain the F-TEID including the TEID that the MME shall use when sending the Create Bearer Response message. | F-TEID | 0 | +| Private Extension | O | This IE may be sent on the S5/S8, S4/S11 and S2a/S2b interfaces. | Private Extension | VS | +| NOTE 1: This message refers to the UE requested bearer resource allocation procedure and UE requested bearer resource modification procedures defined in 3GPP TS 24.301 [23], both are specified in 3GPP TS 23.401 [3] in the clause "UE requested bearer resource modification". | | | | | +| NOTE 2: The receiver, not supporting the APN level load control feature, shall ignore all the occurrence(s) of this IE, i.e. "Load Control Information" IE with instance number "1". The receiver, supporting the APN level load control feature and supporting the APN level load information for the maximum of 10 APNs, shall handle the APN level load information for the first 10 APNs and ignore any more APN level load information. | | | | | +| NOTE 3: The receiver, supporting the APN level overload information for the maximum of 10 APNs, shall handle the APN level overload information for the first 10 APNs and ignore any more APN level overload information. | | | | | +| NOTE 4: The APN level load information, provided within and across different instances of the "PGW's APN level Load Control Information" IE(s) shall be limited to 10 different APNs. | | | | | +| NOTE 5: The APN level overload information, provided within and across different instances of the "PGW's Overload Control Information" IE(s) shall be limited to 10 different APNs. | | | | | + +NOTE: In the case that the procedure was initiated by a UE Requested Bearer Resource Modification Procedure or a UE Requested Bearer Resource Allocation Procedure or Secondary PDP Context Activation Procedure, then there will be only one instance of the Bearer Contexts IE in the Create Bearer Request. + +**Table 7.2.3-2: Bearer Context within Create Bearer Request** + +| Octets 1 | Bearer Context IE Type = 93 (decimal) | | | | +|------------------------------------------------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octets 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | This IE shall be set to 0. | EBI | 0 | +| TFT | M | This IE can contain both uplink and downlink packet filters to be sent to the UE or the TWAN/ePDG. | Bearer TFT | 0 | +| S1-U SGW F-TEID | C | This IE shall be sent on the S11 interface if the S1-U interface is used.
If SGW supports both IPv4 and IPv6, it shall send both an IPv4 address and an IPv6 address within the S1-U SGW F-TEID IE.

See NOTE 1. | F-TEID | 0 | +| S5/8-U PGW F-TEID | C | This IE shall be sent on the S4, S5/S8 and S11 interfaces for GTP-based S5/S8 interface. The MME/SGSN shall ignore the IE on S11/S4 for PMIP-based S5/S8 interface. | F-TEID | 1 | +| S12 SGW F-TEID | C | This IE shall be sent on the S4 interface if the S12 interface is used. See NOTE 1. | F-TEID | 2 | +| S4-U SGW F-TEID | C | This IE shall be sent on the S4 interface if the S4-U interface is used. See NOTE 1. | F-TEID | 3 | +| S2b-U PGW F-TEID | C | This IE (for user plane) shall be sent on the S2b interface. | F-TEID | 4 | +| S2a-U PGW F-TEID | C | This IE (for user plane) shall be sent on the S2a interface. | F-TEID | 5 | +| Bearer Level QoS | M | | Bearer QoS | 0 | +| Charging Id | C | This IE shall be sent on the S5/S8 interface. | Charging Id | 0 | +| | O | If the S5/S8 interface is GTP, this IE may be sent on the S4 interface, in order to support CAMEL charging at the SGSN. | | | +| | CO | This IE shall be sent on the S2a/S2b interface. | | | +| Bearer Flags | O | Applicable flags are:
  • - PPC (Prohibit Payload Compression) : this flag may be set on the S5/S8 and S4 interfaces.
  • - vSRVCC indicator: This IE may be included by the PGW on the S5/S8 interface according to 3GPP TS 23.216 [43]. When received from S5/S8, SGW shall forward on the S11 interface.
| Bearer Flags | 0 | +| Protocol Configuration Options (PCO) | O | This IE may be sent on the S5/S8 and S4/S11 interfaces if ePCO is not supported by the UE or the network. This bearer level IE takes precedence over the PCO IE in the message body if they both exist. | PCO | 0 | +| Extended Protocol Configuration Options (ePCO) | O | This IE may be sent on the S5/S8 and S11 interfaces if the UE and the network support ePCO. | ePCO | 0 | +| Maximum Packet Loss Rate | O | This IE may be included on the S5/S8 interfaces if the PGW needs to send Maximum Packet Loss Rate as specified in clause 5.4.1 of 3GPP TS 23.401 [3]. This IE is only applicable for QCI 1. | Maximum Packet Loss Rate | 0 | +| | CO | If the SGW receives this IE, it shall forward it to the MME on the S11 interface | | | + +NOTE 1: The SGW shall use the same F-TEID IP address and TEID values for S1-U, S4-U and S12 interfaces. + +**Table 7.2.3-3: Load Control Information within Create Bearer Request** + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-------------| +| Octet 1 | Load Control Information IE Type = 181 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Load Control Sequence Number | M | See clause 12.2.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Load Metric | M | See clauses 12.2.5.1.2.2 and 12.2.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| List of APN and Relative Capacity | CO | The IE shall (only) be present in the "PGW's APN level Load Control Information" IE.
For indicating the APN level load, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) & its respective "Relative Capacity" (sharing the same "Load Metric").
See clause 12.2.5.1.2.3 for the description and use of this parameter.
See NOTE 1. | APN and Relative Capacity | 0 | +| NOTE 1: If more than 10 occurrences of "APN and Relative Capacity" IE are received within one instance of the Load Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Load Control Information IE instance. | | | | | + +**Table 7.2.3-4: Overload Control Information within Create Bearer Request** + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 181 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clauses 12.3.5.1.2.3 and 12.3.5.1.2.4 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | +| List of Access Point Name (APN) | CO | The IE may (only) be present in the "PGW's Overload Control Information" IE.
For indicating the APN level overload, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) (sharing the same "Overload Reduction Metric" and "Period of Validity").
See NOTE 1. | APN | 0 | +| NOTE 1: If more than 10 occurrences of APNs are received within one instance of the Overload Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Overload Control Information IE instance. | | | | | + +**Table 7.2.3-5: PGW Change Info within Create Bearer Request** + +| Octet 1 | PGW Change Info IE Type = 214 (decimal) | | | | +|----------------------------------|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| PGW Set FQDN | O | This IE may be included by a PGW if the PGW set FQDN is changed. | PGW FQDN | 0 | +| Alternative PGW-C/SMF IP Address | O | This IE may be included by a PGW if the list of alternative PGW-C/SMF IP addresses is changed.

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF IP Addresses. | IP Address | 0 | +| Alternative PGW-C/SMF FQDN | O | This IE may be included by a PGW if the list of alternative PGW-C/SMF FQDNs is changed.

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF FQDNs. | PGW FQDN | 1 | +| New PGW-C/SMF IP Address | C | This IE shall be included by a PGW if the PGW S5/S8/S2b IP Address for the control plane for the PDN connection is required to be changed (see PGW triggered PDN connection restoration in clauses 31.4 and 31.4B and 31.6.3 of 3GPP TS 23.007 [17]). | IP Address | 1 | +| New SGW-C IP Address | O | This IE may be included by a combined SGW/PGW to contain the SGW-C S11 IP address (pertaining to the combined SGW/PGW sending the PGW Change Info IE). The MME should use this information when deciding to which SGW-C S11 IP address should the Create Session Request message be sent, during a combined SGW-C/PGW-C/SMF triggered restoration procedure as specified in clauses 31.4a and 31.6.3A of 3GPP TS 23.007 [17]. | IP Address | 3 | +| PGW-C/SMF FQ-CSID | C | This IE shall be included if the New PGW-C/SMF IP Address IE is present and if the PGW-C/SMF requests the MME/ePDG to re-establish all the PDN connections associated with a PGW-C/SMF FQ-CSID towards the PGW-C indicated in New PGW-C/SMF IP Address IE.

When present, it shall contain the PGW-C/SMF FQ-CSID for which the PDN connections are requested to be re-established.

Several IEs with the same IE type may be present to represent several FQ-CSIDs of PDN connections that need to be moved to the New PGW-C/SMF IP Address.

See also clause 31.6 of 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| Group Id | C | This IE shall be included if the New PGW-C/SMF IP Address IE is present and if the PGW-C/SMF requests the MME/ePDG to re-establish all the PDN connections associated with a Group Id towards the PGW-C indicated in New PGW-C/SMF IP Address IE.

When present, it shall contain the Group Id for which the PDN connections are requested to be re-established.

Several IEs with the same IE type may be present to represent several Group Ids of PDN connections that need to be moved to the New PGW-C/SMF IP Address.

See also clause 31.6 of 3GPP TS 23.007 [17]. | Group Id | 0 | +| PGW Control Plane IP Address | C | This IE shall be included if the New PGW-C/SMF IP Address IE is present and if the PGW-C/SMF requests the MME/ePDG to re-establish all the PDN connections of which PGW S5/S8/ S2a/S2b F-TEID contains the PGW | IP Address | 2 | + +| | | | | | +|--------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---| +| | | Control Plane IP Address towards the PGW-C indicated in New PGW-C/SMF IP Address IE.

Several IEs with the same IE type may be present to represent several PGW-C/SMF IP addresses of PDN connections that need to be moved to the New PGW-C/SMF IP Address.
See also clause 31.6 of 3GPP TS 23.007 [17]. | | | +| New Group Id | O | The IE may be present if the PGW-C/SMF wants to allocate a new Group Id for the PDN connection. When present, this IE shall identify the new Group Id to which the PDN connection pertains, and the MME/ePDG shall replace any earlier Group ID received for the PDN connection with the new Group ID. If absent, the Group ID associated earlier to the PDN connection, if any, shall remain unchanged.

See also clause 31.6 of 3GPP TS 23.007 [17]. | Group Id | 1 | + +## 7.2.4 Create Bearer Response + +The Create Bearer Response message shall be sent on the S5/S8 interface by the SGW to the PGW, and on the S11 interface by the MME to the SGW as part of the Dedicated Bearer Activation procedure. + +The message shall also be sent on the S5/S8 interface by the SGW to the PGW and on the S4 interface by the SGSN to the SGW as part of Secondary PDP Context Activation procedure or the Network Requested Secondary PDP Context Activation procedure. + +The message shall also be sent on the S2a interface by the TWAN to the PGW as part of the Dedicated bearer activation in WLAN on GTP S2a and on the S2b interface by the ePDG to the PGW as part of the Dedicated S2b bearer activation with GTP on S2b. + +The message shall also be sent on the S5/S8 or S2a/S2b interface by the SGW or the TWAN/ePDG to the PGW and on the S11/S4 interface by the MME/S4-SGSN to the SGW as part of the Network-initiated IP flow mobility procedure or UE-initiated IP flow mobility procedure, as specified by 3GPP TS 23.161 [71]. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Request accepted". +- "Request accepted partially". +- "Context not found". +- "Semantic error in the TFT operation". +- "Syntactic error in the TFT operation". +- "Semantic errors in packet filter(s)". +- "Syntactic errors in packet filter(s)". +- "Unable to page UE". +- "UE not responding". +- "Unable to page UE due to Suspension". +- "UE refuses". +- "Denied in RAT". +- "Temporarily rejected due to handover/TAU/RAU procedure in progress". +- "MME/SGSN refuses due to VPLMN Policy". +- "UE is temporarily not reachable due to power saving". + +- "Request rejected due to UE capability". + +**Table 7.2.4-1: Information Elements in a Create Bearer Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------| +| Cause | M | | Cause | 0 | +| Bearer Contexts | M | All the bearer contexts included in the corresponding Create Bearer Request shall be included. Several IEs with this type and instance value shall be included on the S4/S11, S5/S8 and S2a/S2b interfaces as necessary to represent a list of Bearers. | Bearer Context | 0 | +| Recovery | C | This IE shall be included on the S4/S11, S5/S8 and S2a/S2b interfaces if contacting the peer for the first time | Recovery | 0 | +| MME-FQ-CSID | C | This IE shall be included by the MME on the S11 interface and shall be forwarded by the SGW on the S5/S8 interfaces according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| SGW-FQ-CSID | C | This IE shall be included by the SGW on the S5/S8 interfaces according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 1 | +| ePDG-FQ-CSID | C | This IE shall be included by the ePDG on the S2b interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 2 | +| TWAN-FQ-CSID | C | This IE shall be included by the TWAN on the S2a interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 3 | +| Protocol Configuration Options (PCO) | C | If the UE includes the PCO IE, then the MME/SGSN shall copy the content of this IE transparently from the PCO IE included by the UE. If the SGW receives PCO from MME/SGSN, SGW shall forward it to the PGW. | PCO | 0 | +| UE Time Zone | O | This IE is optionally included by the MME on the S11 interface or by the SGSN on the S4 interface. | UE Time Zone | 0 | +| | CO | The SGW shall forward this IE on the S5/S8 interface if the SGW receives it from the MME/SGSN. | | | +| | CO | This IE shall be included by the TWAN on the S2a interface. | | | +| User Location Information (ULI) | CO | This IE shall be included by the MME on the S11 interface or by the SGSN on the S4 interface. The CGI/SAI shall be included by SGSN and the ECGI shall be included by MME.
See NOTE 1. | ULI | 0 | +| | CO | The SGW shall forward this IE on the S5/S8 interface if it receives it from the MME/SGSN. | | | +| TWAN Identifier | CO | This IE shall be included by the TWAN on the S2a interface as specified in 3GPP TS 23.402 [45]. | TWAN Identifier | 0 | +| MME/S4-SGSN's Overload Control Information | O | During an overload condition, the MME/S4-SGSN may include this IE on the S11/S4 interface if the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the MME/S4-SGSN shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the PGW on the S5/S8 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S5/S8 interface if the overload control feature is supported by the SGW and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | + +| | | | | | +|------------------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|---| +| Presence Reporting Area Information | CO |

The MME/SGSN shall include this IE on S11/S4 if the PGW/PCRF/OCS has requested to start or modify reporting changes of UE presence in Presence Reporting Area(s) in the corresponding Create Bearer Request message and the MME/SGSN supports such reporting. The MME/SGSN shall then indicate whether the UE is inside or outside the newly started or modified Presence Reporting Area(s), or indicate that the Presence Reporting Area(s) is inactive.

The SGW shall include this IE on S5/S8 if it receives the Presence Reporting Area Information from the MME/SGSN.

Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Information. One IE shall be included for each PRA newly started or modified.

| Presence Reporting Area Information | 0 | +| MME/S4-SGSN Identifier | CO | If the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11), the MME/S4-SGSN shall include this IE on the S11/S4 interface if the PGW has not been updated with the identity of the currently serving MME/S4-SGSN, i.e. if no other message carrying MME/S4-SGSN identity has been sent to the PGW during/after an inter-MME/S4-SGSN intra-SGW mobility procedure. | IP Address (See NOTE 2) | 0 | +| TWAN/ePDG's Overload Control Information | O |

During an overload condition, the TWAN/ePDG may include this IE over the S2a/S2b interface if the overload control feature is supported by the TWAN/ePDG and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the TWAN/ePDG shall provide only one instance of this IE, representing its overload information.

| Overload Control Information | 2 | +| WLAN Location Information | CO | The ePDG shall include this IE on the S2b interface if the WLAN Location Information is available. | TWAN Identifier | 1 | +| WLAN Location Timestamp | CO | The ePDG shall include this IE on the S2b interface, if the WLAN Location Timestamp is available. | TWAN Identifier Timestamp | 1 | +| UE Local IP Address | CO | The ePDG shall include this IE on the S2b interface. | IP Address (See NOTE 2) | 0 | +| UE UDP Port | CO | The ePDG shall include this IE on the S2b interface if NAT is detected and the UDP encapsulation is used. | Port Number | 0 | +| NBIFOM Container | CO | This IE shall be included on the S11/S4 or S2a/S2b interfaces if the MME/S4-SGSN or the TWAN/ePDG receives a NBIFOM Container from the UE as specified in 3GPP TS 24.161 [73]. The Container Type shall be set to 4. | F-Container | 0 | + +| | | | | | +|-------------------|----|-----------------------------------------------------------------------------------------------------------------------------|-------------------|----| +| | CO | If the SGW receives a NBIFOM Container IE from the MME/S4-SGSN, the SGW shall forward it to the PGW on the S5/S8 interface. | | | +| UE TCP Port | CO | The ePDG shall include this IE on the S2b interface if NAT is detected and the TCP encapsulation is used. | Port Number | 1 | +| PSCell ID | CO | The MME shall include this IE on the S11 interface, if it has received this information from the eNodeB. | PSCell ID | 0 | +| Private Extension | O | This IE may be sent on the S5/S8, S4/S11 and S2a/S2b interfaces. | Private Extension | VS | + +NOTE 1: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator for supporting UEs, or that of the allocated Core Network Operator for non-supporting UEs. As an exception, based on inter-operator roaming/sharing agreement, if the information on whether the UE is a supporting or non-supporting UE is available, the PLMN ID that is communicated to the HPLMN for non-supporting UEs shall be the Common PLMN ID. +In shared networks, when the MME/S4-SGSN and PGW pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI to the PGW, and the Common PLMN ID shall be communicated in SAI/CGI to the PGW, for both supporting and non-supporting UEs. The Core Network Operator PLMN ID (selected by the UE for supporting UEs or allocated by the network for non-supporting UEs) shall be communicated in the TAI, RAI, UCI and the Serving Network. See clause 4.4 of 3GPP TS 23.251 [55]. + +NOTE 2: It is not correct that the IP Address IE type with the same instance 0 appears twice in the message table, however, there is no problem because the MME/SGSN Identifier (received over S11/S4/S5/S8) and UE Local IP Address (received over S2b) can never appear in the same message. It was not possible to change the instance of IP Address IE type since it would have been a backward incompatible change. + +**Table 7.2.4-2: Bearer Context within Create Bearer Response** + +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +|--------------------------------|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|---------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Cause | M | This IE shall indicate if the bearer handling was successful, and if not, it gives information on the reason. | Cause | 0 | +| S1-U eNodeB F-TEID | C | This IE shall be sent on the S11 interface if the S1-U interface is used. | F-TEID | 0 | +| S1-U SGW F-TEID | C | This IE shall be sent on the S11 interface. It shall be used to correlate the bearers with those in the Create Bearer Request. | F-TEID | 1 | +| S5/8-U SGW F-TEID | C | This IE shall be sent on the S5/S8 interfaces. | F-TEID | 2 | +| S5/8-U PGW F-TEID | C | This IE shall be sent on the S5/S8 interfaces. It shall be used to correlate the bearers with those in the Create Bearer Request. | F-TEID | 3 | +| S12 RNC F-TEID | C | This IE shall be sent on the S4 interface if the S12 interface is used. See NOTE1. | F-TEID | 4 | +| S12 SGW F-TEID | C | This IE shall be sent on the S4 interface. It shall be used to correlate the bearers with those in the Create Bearer Request. See NOTE1. | F-TEID | 5 | +| S4-U SGSN F-TEID | C | This IE shall be sent on the S4 interface if the S4-U interface is used. See NOTE1. | F-TEID | 6 | +| S4-U SGW F-TEID | C | This IE shall be sent on the S4 interface. It shall be used to correlate the bearers with those in the Create Bearer Request. See NOTE1. | F-TEID | 7 | +| S2b-U ePDG F-TEID | C | This IE shall be sent on the S2b interface. | F-TEID | 8 | +| S2b-U PGW F-TEID | C | This IE shall be sent on the S2b interface. It shall be used to correlate the bearers with those in the Create Bearer Request. | F-TEID | 9 | +| S2a-U TWAN F-TEID | C | This IE shall be sent on the S2a interface. | F-TEID | 10 | +| S2a-U PGW F-TEID | C | This IE shall be sent on the S2a interface. It shall be used to correlate the bearers with those in the Create Bearer Request. | F-TEID | 11 | +| Protocol Configuration Options | CO | If the UE includes the PCO IE in the corresponding message, then the MME/SGSN shall copy the content of | PCO | 0 | + +| | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---| +| (PCO) | | this IE transparently from the PCO IE included by the UE. If the SGW receives PCO from MME/SGSN, SGW shall forward it to the PGW. This bearer level IE takes precedence over the PCO IE in the message body if they both exist. | | | +| RAN/NAS Cause | CO | If the bearer creation failed, the MME shall include this IE on the S11 interface to indicate the RAN cause and/or the NAS cause of the bearer creation failure, if available and if this information is permitted to be sent to the PGW operator according to MME operator's policy. If both a RAN cause and a NAS cause are generated, then several IEs with the same type and instance value shall be included to represent a list of causes. The SGW shall include this IE on the S5/S8 interface if it receives it from the MME. | RAN/NAS Cause | 0 | +| | CO | If the bearer creation failed, the TWAN shall include this IE on the S2a interface to indicate the cause of the bearer creation failure, if available and if this information is permitted to be sent to the PGW operator according to the TWAN operator's policy. When present, the IE shall be encoded as a Diameter or an ESM cause. See NOTE 2. | | | +| | CO | If the bearer creation failed, the ePDG shall include this IE on the S2b interface to indicate the cause of the bearer creation failure, if available and if this information is permitted to be sent to the PGW operator according to the ePDG operator's policy. When present, the IE shall be encoded as a Diameter or an IKEv2 cause. See NOTE 3. | | | +| Extended Protocol Configuration Options (ePCO) | CO | If the UE includes the ePCO IE, then the MME shall copy the content of this IE transparently from the ePCO IE included by the UE. If the SGW receives ePCO from the MME, the SGW shall forward it to the PGW. | ePCO | 0 | +| NOTE 1: The SGW shall use the same F-TEID IP address and TEID values for S1-U, S4-U and S12 interfaces. However, when sending a Create Bearer Request message to an S4-SGSN for a UE in idle mode, the SGW can not know whether the S4-SGSN will establish a direct user plane tunnel between the RNC and the SGW. The SGW may include either the S4-U SGW F-TEID IE or the S12 SGW F-TEID IE in the Create Bearer Request message. The S4-SGSN will decide whether to establish a direct user plane tunnel or not and will provide accordingly either a S12 RNC F-TEID or a S4-U SGSN F-TEID in the Create Bearer Response message, where the interface type of the provided F-TEID may differ from the interface type of the SGW F-TEID used for bearer correlation, e.g. if the SGW includes the S4-U SGW F-TEID in the Create Bearer Request message, and if the SGSN decides to use Direct Tunnelling, the S4-SGSN shall provide the S12 RNC F-TEID in the Create Bearer Response message, together with S4-U SGW F-TEID. The SGW should not treat this as an error. | | | | | +| NOTE 2: The TWAN does not exchange signalling with the 3GPP AAA Server nor with the UE in this procedure. The TWAN may include an internal failure cause for the bearer creation failure. The protocol type used to encode the internal failure cause is implementation specific. | | | | | +| NOTE 3: The ePDG does not exchange signalling with the 3GPP AAA Server in this procedure. The ePDG may include an internal failure cause for the bearer creation failure. The protocol type used to encode the internal failure cause is implementation specific. | | | | | + +**Table 7.2.4-3: Overload Control Information within Create Bearer Response** + +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +|----------------------------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | + +## 7.2.5 Bearer Resource Command + +A Bearer Resource Command message shall be sent from a MME to a SGW and forwarded to PGW as a part of the UE requested bearer resource allocation procedure or UE requested bearer resource modification procedure (which is used also for a dedicated bearer deactivation or dedicated bearer activation), as specified by 3GPP TS 24.301 [23]. + +The message shall also be sent on the S4 interface by a SGSN to a SGW and on the S5/S8 interface by a SGW to a PGW as part of the MS initiated PDP Context modification procedure, or secondary PDP context activation procedure. + +The message shall also be sent on the S11/S4 interface by an MME/S4-SGSN to a SGW and on the S5/S8 or S2a/S2b interface by a SGW or a TWAN/ePDG to a PGW as part of the UE-initiated IP flow mobility procedure and the UE requested IP flow mapping procedure, as specified by 3GPP TS 23.161 [71]. + +Table 7.2.5-1 specifies the presence of the IEs in the message. + +**Table 7.2.5-1: Information Elements in a Bearer Resource Command** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Linked EPS Bearer ID (LBI) | M | | EBI | 0 | +| Procedure Transaction Id (PTI) | M | | PTI | 0 | +| Flow Quality of Service (Flow QoS) | C | This IE shall be included on the S4/S11 interface if the "Requested New QoS"/"Required QoS" is included in the corresponding NAS message (see clause 9.5.10 and clause 9.5.4 in 3GPP TS 24.008 [5]) or the "Required traffic flow QoS" is included in the corresponding NAS message (see clause 8.3.8 and clause 8.3.10 in 3GPP TS 24.301 [23]).
If SGW receives this IE, SGW shall forward it to PGW across S5/S8 interface. | Flow QoS | 0 | +| Traffic Aggregate Description (TAD) | M | The TAD consists of the description of the packet filter(s) for a traffic flow aggregate.
MME shall include this IE over S11 interface. | TAD | 0 | +| | CO | If S4-SGSN receives this IE from the UE, it shall include it over S4 interface. | | | +| | CO | If SGW receives this IE, the SGW shall forward it to PGW over S5/S8 interface. See NOTE 2. | | | +| RAT Type | C | This IE shall be included for MS initiated PDP Context modification procedure and Secondary PDP context activation procedure. | RAT Type | 0 | +| Serving Network | O | This IE may be included in the MS initiated PDP Context modification procedure.
See NOTE 3. | Serving Network | 0 | +| User Location Information (ULI) | O | This IE may be included in the MS initiated PDP Context modification procedure.
See NOTE 3. | ULI | 0 | + +| | | | | | +|--------------------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---| +| EPS Bearer ID | C | This IE indicates the EPS Bearer that needs to be modified. It shall be included for MS initiated PDP Context modification procedure. For EUTRAN this IE shall be present if it is triggered by the NAS Bearer Resource Modification Request message and its value shall be set to the value of the "EPS bearer identity for packet filter" IE received in that NAS message. | EBI | 1 | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags:
- Change Reporting Support Indication: this flag may be set to 1 in the MS initiated PDP Context modification procedure if the SGSN/MME supports location Info Change Reporting and if the SGSN/MME's operator policy permits reporting of location change to the operator of the PGW with which the session is established.
- Direct Tunnel Flag: this flag shall be set to 1 on the S4 interface, if Direct Tunnel is used in the MS initiated PDP Context Modification procedure. | Indication | 0 | +| S4-U SGSN F-TEID | C | This IE shall be included on the S4 interface when direct tunnel is not established in the MS initiated PDP Context modification procedure See NOTE 1 | F-TEID | 0 | +| S12 RNC F-TEID | C | This IE shall be included on the S4 interface when direct tunnel flag is set to 1 in the MS initiated PDP Context modification procedure. See NOTE 1 | F-TEID | 1 | +| Protocol Configuration Options (PCO) | O | If the UE includes the PCO IE, then the MME/SGSN shall copy the content of this IE transparently from the PCO IE included by the UE.
If the SGW receives PCO from the MME/SGSN, the SGW shall forward it to the PGW. | PCO | 0 | +| Signalling Priority Indication | CO | The SGSN/MME shall include this IE on the S4/S11 interface if the UE indicates low access priority during the procedure.
The SGW shall forward this IE on the S5/S8 interfaces if received from the MME/SGSN. | Signalling Priority Indication | 0 | +| MME/S4-SGSN's Overload Control Information | O | During an overload condition, the MME/S4-SGSN may include this IE on the S11/S4 interface if the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the MME/S4-SGSN shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the PGW on the S5/S8 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S5/S8 interface if the overload control feature is supported by the SGW and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| NBIFOM Container | CO | This IE shall be included on the S11/S4 or S2a/S2b interfaces if the MME/S4-SGSN or the TWAN/ePDG receives an NBIFOM Container from the UE as specified in 3GPP TS 24.161 73]. The Container Type shall be set to 4. | F-Container | 0 | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|----| +| | CO | If the SGW receives an NBIFOM Container IE from the MME/S4-SGSN, the SGW shall forward it to the PGW on the S5/S8 interface. | | | +| Extended Protocol Configuration Options (ePCO) | O | If the UE includes the ePCO IE, then the MME shall copy the content of this IE transparently from the ePCO IE included by the UE.
If the SGW receives ePCO from the MME, the SGW shall forward it to the PGW. | ePCO | 0 | +| Sender F-TEID for Control Plane | CO | The SGW shall include this IE on the S5/S8 interfaces and set it to the last value sent to the PGW.

If the Sender F-TEID for Control Plane is received, the PGW shall only handle the Bearer Resource Command message if the Sender F-TEID for Control Plane in this message is the same as the last Sender F-TEID for Control Plane received on the given interface. | F-TEID | 2 | +| PSCell ID | CO | The MME shall include this IE on the S11 interface, if it has received this information from the eNodeB. | PSCell ID | 0 | +| Private Extension | O | | Private Extension | VS | +| NOTE 1: The conditional S4-U SGSN F-TEID and S12 RNC F-TEID IE are redundant (as the IEs will be included in Update Bearer Response message in the MS initiated PDP Context modification procedure). The receiver may ignore it. | | | | | +| NOTE 2: In the secondary PDP context activation procedure, if the Bearer Resource Command message without TAD IE is received, the PGW shall reject the message with cause "UE context without TFT already activated". | | | | | +| NOTE 3: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator for supporting UEs, or that of the allocated Core Network Operator for non-supporting UEs. As an exception, based on inter-operator roaming/sharing agreement, if the information on whether the UE is a supporting or non-supporting UE is available, the PLMN ID that is communicated to the HPLMN for non-supporting UEs shall be the Common PLMN ID.
In shared networks, when the MME/S4-SGSN and PGW pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI to the PGW, and the Common PLMN ID shall be communicated in SAI/CGI to the PGW, for both supporting and non-supporting UEs. The Core Network Operator PLMN ID (selected by the UE for supporting UEs or allocated by the network for non-supporting UEs) shall be communicated in the TAI, RAI, UCI and the Serving Network. See clause 4.4 of 3GPP TS 23.251 [55]. | | | | | + +NOTE: Depending on the protocol type on the S5/S8 interface, the SGW or the PGW will determine if the UE is requesting an Allocation/Modification operation of bearer resources for a traffic flow aggregate based on the TFT operation code and the packet filter ID value in the Traffic Aggregate (TAD) IE and/or the presence of the EPS Bearer ID IE. + +**Table 7.2.5-2: Overload Control Information within Bearer Resource Command** + +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +|----------------------------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | + +## 7.2.6 Bearer Resource Failure Indication + +A Bearer Resource Failure Indication shall be sent by the PGW to an SGW and forwarded to the MME to indicate failure of the UE requested bearer resource allocation procedure or UE requested bearer resource modification procedure, as specified by 3GPP TS 24.301 [23]. + +The message shall also be sent by a PGW to an SGW and forwarded to an SGSN as part of the failure of an MS initiated PDP Context modification procedure or secondary PDP context activation procedure. + +The message shall also be sent on the S5/S8 or S2a/S2b interface by a PGW to a SGW or to a TWAN/ePDG and the S11/S4 interface by a SGW to an MME/S4-SGSN as part of the UE-initiated IP flow mobility procedure and the UE requested IP flow mapping procedure, as specified by 3GPP TS 23.161 [71]. + +Table 7.2.6-1 specifies the presence of the IEs in the message. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Semantic error in the TAD operation". +- "Syntactic error in the TAD operation". +- "Semantic errors in packet filter(s)". +- "Syntactic errors in packet filter(s)". +- "Collision with network initiated request". +- "Service denied". +- "Bearer handling not supported". +- "UE context without TFT already activated". + +**Table 7.2.6-1: Information Elements in a Bearer Resource Failure Indication** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|---------|------| +| Cause | M | | Cause | 0 | + +| | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|----| +| Linked EPS Bearer ID | M | See clause 6.1.1 "Presence requirements of Information Elements". | EBI | 0 | +| Procedure Transaction ID (PTI) | M | See clause 6.1.1 "Presence requirements of Information Elements". | PTI | 0 | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - Associate OCI with PGW node's identity: The PGW shall set this flag to 1 on the S5/S8 interface or S2a/S2b interface if it has included the "PGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the HSS or DNS during the PGW selection) of the serving PGW. The SGW shall set this flag on the S11/S4 interface if it supports the overload control feature and if the flag is set on the S5/S8 interface.
  • - Associate OCI with SGW node's identity: The SGW shall set this flag to 1 on the S11/S4 interface if it has included the "SGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW.
| Indication | 0 | +| PGW's Overload Control Information | O | During an overload condition, the PGW may include this IE on the S5/S8, if the overload control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access based network, belongs (see clause 12.3.11).

When present, the PGW shall provide
  • - node level overload control, in one instance of this IE; and/or
  • - APN level overload control, in one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the overload information for a list of APN(s).
See NOTE 1, NOTE 2. | Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S11/S4 interface if the overload control feature is supported by the SGW and is activated in the network (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| Recovery | O | | Recovery | 0 | +| NBIFOM Container | CO | This IE shall be included on the S5/S8 or S2a/S2b interfaces if the PGW needs to send NBIFOM information as specified in 3GPP TS 23.161 [71]. The Container Type shall be set to 4. | F-Container | 0 | +| | CO | If the SGW receives an NBIFOM Container IE from the PGW, the SGW shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| Private Extension | O | | Private Extension | VS | +| NOTE 1: The receiver, supporting the APN level overload information for the maximum of 10 APNs, shall handle the APN level overload information for the first 10 APNs and ignore any more APN level overload information. | | | | | +| NOTE 2: The APN level overload information, provided within and across different instances of the "PGW's Overload Control Information" IE(s) shall be limited to 10 different APNs. | | | | | + +**Table 7.2.6-2: Overload Control Information within Bearer Resource Failure Indication** + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clauses 12.3.5.1.2.3 and 12.3.5.1.2.4 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | +| List of Access Point Name (APN) | CO | The IE may (only) be present in the "PGW's Overload Control Information" IE.
For indicating the APN level overload, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) (sharing the same "Overload Reduction Metric" and "Period of Validity").
See NOTE 1. | APN | 0 | +| NOTE 1: If more than 10 occurrences of APNs are received within one instance of the Overload Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Overload Control Information IE instance. | | | | | + +## 7.2.7 Modify Bearer Request + +The direction of this message shall be from MME/S4-SGSN to SGW and/or from SGW to PGW (see Table 6.1-1). + +The Modify Bearer Request message shall only be sent on the S11 interface by the MME to the SGW and on the S5/S8 interfaces by the SGW to the PGW as part of the procedures: + +- E-UTRAN Tracking Area Update without SGW Change +- UE triggered Service Request +- S1-based Handover +- UTRAN Iu mode to E-UTRAN Inter RAT handover +- GERAN A/Gb mode to E-UTRAN Inter RAT handover +- Tracking Area Update procedure with a RAT type change +- E-UTRAN Initial Attach +- Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN with GTP on S5/S8 interface (see clauses 8.2, 8.6 and 16.11 of 3GPP TS 23.402 [45]) +- UE requested PDN connectivity +- 3G SGSN to MME combined hard handover and SRNS relocation procedure +- X2-based handover without SGW relocation +- UTRAN/GERAN to E-UTRAN SRVCC +- HSS-based P-CSCF restoration for 3GPP access (see 3GPP TS 23.380 [61]) +- Connection Resume procedure (see clause 5.3.5A of 3GPP TS 23.401 [3]) +- reception of the RRC establishment cause "MO Exception data" in the NB-IoT RAT + +It shall also only be sent on the S11 interface by the MME to the SGW as part of the procedure: + +- E-UTRAN Initiated E-RAB modification procedure + +- Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN with PMIP on S5/S8 interface (see clauses 8.2 and 16.11 of 3GPP TS 23.402 [45]) +- Tracking Area Update procedure with Serving GW change and data forwarding +- Mobile Originated Data transport in Control Plane CIoT EPS optimisation with P-GW connectivity +- Mobile Terminated Data Transport in Control Plane CIoT EPS optimisation with P-GW connectivity +- Establishment of S1-U bearer during Data Transport in Control Plane CIoT EPS optimisation procedure (see clause 5.3.4B.4 of 3GPP TS 23.401 [3]). + +It shall also only be sent on the S4 interface by the SGSN to the SGW and on the S5/S8 interfaces by the SGW to the PGW as part of the procedures: + +- Routeing Area Update with MME interaction and without SGW change +- E-UTRAN to UTRAN Iu mode Inter RAT handover +- E-UTRAN to GERAN A/Gb mode Inter RAT handover +- Inter SGSN Routeing Area Update Procedure and Combined Inter SGSN RA / LA Update to S4 SGSNs without SGW change +- Iu mode RA Update Procedure without SGW change +- Serving RNS Relocation Procedure +- Combined Hard Handover and SRNS Relocation Procedure +- Combined Cell / URA Update and SRNS Relocation Procedure +- Enhanced Serving RNS Relocation without SGW relocation +- UE Initiated Service Request Procedure +- Iu mode to A/Gb mode Intra SGSN Change +- A/Gb mode to Iu mode Intra SGSN Change +- Iu mode to A/Gb mode Inter-SGSN Change +- A/Gb mode to Iu mode Inter-SGSN Change +- Paging Response with no established user plane on S4 +- PDP Context Activation Procedure +- Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN with GTP on S5/S8 interface (see clauses 8.2, 8.6 and 16.11 of 3GPP TS 23.402 [45]) +- UTRAN/GERAN to UTRAN (HSPA) SRVCC +- HSS-based P-CSCF restoration for 3GPP access (see 3GPP TS 23.380 [61]) + +It shall also only be sent on the S4 interface by the SGSN to the SGW as part of the procedures: + +- RAB Assignment Procedure +- SRVCC from E-UTRAN to UTRAN or GERAN with DTM HO support procedures and SRVCC from UTRAN (HSPA) to UTRAN or GERAN with DTM HO support. +- Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN with PMIP on S5/S8 interface (see clauses 8.2 and 16.11 of 3GPP TS 23.402 [45]) +- Routeing Area Update procedure with Serving GW change and data forwarding + +and only on the S5/S8 interfaces by the SGW to the PGW as part of the procedures: + +- Tracking Area Update procedure with SGW change +- Gn/Gp SGSN to S4 SGSN Routing Area Update +- X2 based handover with SGW relocation +- Gn/Gp SGSN to MME Tracking Area Update +- Enhanced Serving RNS Relocation with SGW relocation + +- Routeing Area Update with MME interaction and with SGW change +- Inter SGSN Routeing Area Update Procedure and Combined Inter SGSN RA / LA Update using S4 with SGW change +- Iu mode RA Update Procedure using S4 with SGW change +- Restoration of PDN connections after an SGW failure if the MME/SGSN and PGW support these procedures as specified in 3GPP TS 23.007 [17] +- MME triggered Serving GW relocation +- S4-SGSN triggered Serving GW relocation +- PGW Pause of Charging procedure + +and on the S2b interface by the ePDG to the PGW as part of the procedures: + +- UE initiated IPsec tunnel update procedure + +If the optional network triggered service restoration feature is supported by the MME, SGSN and SGW, then the Modify Bearer Request message shall also be sent as part of the network triggered service restoration procedure with ISR during an intra MME TAU and an intra S4-SGSN RAU procedure for UEs that had ISR active before either the MME or the S4-SGSN has restarted, as specified in 3GPP TS 23.007 [17]: + +- on the S11 interface by the MME to the SGW, if the MME detected that the ISR associated S4-SGSN has restarted and UE performs a TAU procedure; +- on the S4 interface by the S4-SGSN to the SGW, if the S4-SGSN detected that the ISR associated MME has restarted and UE performs a RAU procedure. + +This message can be used as an implicit resume of the suspended bearers in the SGW and in the PGW (see 3GPP TS 23.216 [43] clauses 6.2.2.1 and 6.3.2.1, 3GPP TS 23.272 [21] clauses 6.3, 6.5 and 7.4). A Modify Bearer Request used as an implicit resume can contain zero or more IE(s), depending on the conditions of presence of the IEs specified in table 7.2.7-1. The PGW should not consider a Modify Bearer Request with zero IE as an error. + +The Modify Bearer Request message may also be sent in the following cases from the S4-SGSN to the SGW/PGW to report a change of Serving Network, User CSG Information or/and UE Time Zone which occurred during a previous RAU procedure without SGSN change but which has not been reported yet to the SGW/PGW, or to indicate to the PGW that the UE is available for signalling if the PDN connection is delay tolerant and if there is pending network initiated PDN connection signalling: + +- during a Service Request procedure to establish data radio bearers for the corresponding PDP context for a UE in UTRAN with an existing S4-U tunnel; +- when the SGSN receives an uplink LLC PDU for user data or any valid LLC frame serving as a paging response from a UE in GERAN with an existing S4-U tunnel. + +The Modify Bearer Request message may also be sent in the following cases from the S4-SGSN to the SGW/PGW to report a change of User Location Information which occurred during a previous RAU procedure without SGSN change but which has not been reported yet to the SGW/PGW, if the S4-SGSN is configured to defer the reporting of ULI change until a RAB/user plane is established: + +- during a Service Request procedure to establish data radio bearers for the corresponding PDP context for a UE in UTRAN with an existing S4-U tunnel; +- when the SGSN receives an uplink LLC PDU for user data or any valid LLC frame serving as a paging response for a UE in GERAN with an existing S4-U tunnel. + +NOTE 1: the S4-SGSN can alternatively send a Change Notification Request message in the above cases, if no other information which requires the sending of a Modify Bearer Request, needs to be reported to the PGW. + +The Modify Bearer Request message may also be sent by the MME to the SGW/PGW to report a change of Serving Network, User Location Information, User CSG Information, UE Time Zone or/and RAT Type, when user data is transported in NAS signalling, for a UE with an existing S11-U tunnel. + +When requesting the PGW to pause or unpause charging for a PDN connection, the SGW shall wait for the PGW acknowledgement (i.e. Modify Bearer Response) before sending a new pause or unpause request. + +NOTE 2: this ensures that the PGW always act per the most recent SGW request in particular in scenarios where the SGW would need to request the PGW to pause and unpause charging in a row (or vice-versa) and the Modify Bearer Request messages would arrive out of order at the PGW. + +Upon receipt of a request from the PGW/PCRF/OCS in a message other than Create Bearer Request and Update Bearer Request to report changes of UE presence in new or modified Presence Reporting Area(s), the MME/S4-SGSN shall immediately send a Modify Bearer Request message or a Change Notification Request message to report to the PGW whether the UE is inside or outside the new or modified Presence Reporting Area(s) or whether the Presence Reporting Area(s) is inactive. + +The MME/S4-SGSN shall also send a Modify Bearer Request message or a Change Notification Request message to report any subsequent change of UE presence in the Presence Reporting Area, as specified in 3GPP TS 23.401 [3] and 3GPP TS 23.060 [35]. + +If the Modify Bearer Request message is sent from the old MME/SGSN as part of Tracking/Routeing Area Update procedure with SGW change and data forwarding as specified in clause 5.3.3.1A of 3GPP TS 23.401 [3], the old MME/SGSN shall only include the Bearer Contexts to be modified IE. + +NOTE 3: Since the UE has left the old MME/SGSN, some information related to the UE, e.g. ULI, UE Time Zone, CSG, RAT Type in the old MME/SGSN are not valid any more. + +Upon receipt of a Modify Bearer Request message that includes the Presence Reporting Area Information from the MME/S4-SGSN, the SGW shall send a Modify Bearer Request message on the S5/S8 interface if any of the following condition is met: + +- ISR is not active; +- ISR is active, and the RAT Type has changed since last reported or the CPRAI flag has been set to 1. + +The MME shall increment the "MO Exception data counter" by one each time the MME has received the RRC cause "MO Exception data". The MME may defer sending a Modify Bearer Request message to report a non-zero value for the MO Exception Data Counter based on local configuration. + +Upon receipt of a Modify Bearer Request message that includes the Secondary RAT Usage Data Report from the MME, the SGW shall send a Modify Bearer Request message on the S5/S8 interface if the IRPGW flag is set to 1 in the Secondary RAT Usage Data Report IE. + +**Table 7.2.7-1: Information Elements in a Modify Bearer Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|---------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|------| +| ME Identity (MEI) | C | If an SGW receives this IE from an MME/SGSN during a TAU/RAU/Handover procedure, the SGW shall forward it across the S5/S8 interface to the PGW. | MEI | 0 | +| | O | The MME/SGSN should include this IE on the S11/S4 interface if the IMSI is not available. The SGW shall forward it across the S5/S8 interface to the PGW if received. See NOTE 23. | | | +| User Location Information (ULI) | C |

The MME/SGSN shall include this IE for the TAU/RAU/Handover procedures if the PGW/PCRF has requested location information change reporting and MME/SGSN support location information change reporting. An MME/SGSN which supports location information change shall include this IE for UE-initiated Service Request and UE initiated Connection Resume procedures if the PGW/PCRF has requested location information change reporting and the UE's location info has changed. See NOTE 5, NOTE 17.

The MME shall include the ECGI and/or TAI, or TAI and Macro eNB ID, or Macro eNB ID depending on the Change Reporting Action provided to the MME. The SGSN shall include either the CGI or SAI or RAI, or CGI/SAI together with RAI in the ULI depending on the Change Reporting Action provided to the SGSN.

When ISR is active, the MME/SGSN which supports

| ULI
(NOTE 15) | 0 | + +| | | | | | +|-----------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---| +| | | location information change shall include this IE for UE-initiated Service Request procedure, if the PGW/PCRF has requested location information change reporting. | | | +| | CO | This IE shall also be included on the S4/S11 interface for a TAU/RAU/Handover with MME/SGSN change without SGW change procedure, if the level of support (User Location Change Reporting and/or CSG Information Change Reporting) changes.
The MME shall include the ECGI and /or TAI in the ULI, the S4-SGSN shall include either the CGI or SAI or RAI, or CGI/SAI together with RAI in the ULI. See NOTE 10. | | | +| | CO | This IE shall also be included on the S4/S11 interface for a handover procedure with SGW change procedure if
  • - the level of support (User Location Change Reporting and/or CSG Information Change Reporting) changes; or
  • - the target MME/S4-SGSN can not derive the level of support (User Location Change Reporting and/or CSG Information Change Reporting) for the source Gn/Gp SGSN. See NOTE 14.
The MME shall include the ECGI and /or TAI in the ULI, the S4-SGSN shall include either the CGI or SAI or RAI, or CGI/SAI together with RAI in the ULI. See NOTE 10. | | | +| | CO | This IE shall also be included on the S11/S4 interface during the following procedures if the MME/SGSN is configured to defer the reporting of ULI change until an E-RAB/RAB/ user plane is established, the ULI has changed during previous mobility procedures i.e. intra MME/S4-SGSN TAU/RAU, and the change has not been reported to the PGW yet:
  • - UE initiated Service Request, TAU or RAU with a request to establish data radio bearers;
  • - when the SGSN receives an uplink LLC PDU for user data or any valid LLC frame serving as a paging response for a UE in GERAN with an existing S4-U tunnel.
| | | +| | CO | This IE shall also be included on the S4/S11 interface for:
  • - a TAU/Handover procedure with an S4-SGSN interaction, if the MME supports location information change reporting;
  • - a RAU/Handover procedure with an MME interaction, if the SGSN supports location information change reporting.
The MME shall include the ECGI and TAI in the ULI. The S4-SGSN shall include the RAI and, if available, the CGI/SAI information, in the ULI. | | | +| | CO | When ISR is not active, the SGW shall include this IE on S5/S8 if it receives the ULI from MME/SGSN.

When ISR is active, the SGW shall include this IE on S5/S8 if
  • - it receives the ULI from MME/S4-SGSN and the RAT Type has changed since last reported; or
  • - it receives the ULI from MME/S4-SGSN and the CLII flag has been set to 1.
| | | +| | CO | This IE shall also be included by the MME on the S11 interface if the MME supports User Plane Integrity Protection, User Plane integrity protection has been required for the traffic of the PDN connection and the UE is moving to an E-UTRAN that does not support User Plane integrity protection with EPS. | | | +| Serving Network | CO | This IE shall be included on S11/S4 interface during the following procedures: | Serving Network (NOTE 15) | 0 | + +| | | | | | +|----------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---| +| | |
  • - TAU/RAU/handover if Serving Network is changed.
  • - TAU/RAU when the UE was ISR activated which is indicated by ISRAU flag.
  • - UE triggered Service Request when UE is ISR activated.
  • - UE initiated Service Request if ISR is not active, but the Serving Network has changed during previous mobility procedures, i.e. intra MME/S4-SGSN TAU/RAU and the change has not been reported to the PGW yet.
  • - TAU/RAU procedure as part of the optional network triggered service restoration procedure with ISR, as specified by 3GPP TS 23.007 [17].
| | | +| | CO | This IE shall also be included on the S4/S11 interface during a TAU/RAU/Handover with MME/SGSN change if the source MME/SGSN has set the SNCR bit in the Change to Report Flags IE in the Forward Relocation Request or Context Response message. | | | +| | CO | This IE shall be included on S5/S8 if the SGW receives this IE from MME/SGSN and if ISR is not active.
This IE shall be included on S5/S8 if the SGW receives this IE from MME/SGSN and ISR is active and the Modify Bearer Request message needs to be sent to the PGW as specified in the 3GPP TS 23.401 [3]. | | | +| RAT Type | C | This IE shall be sent on the S11 interface for a TAU with a RAT type change, UE triggered Service Request or an I-RAT Handover.
This IE shall be sent on the S4 interface for a RAU with MME interaction, a RAU with an SGSN change, a UE Initiated Service Request or an I-RAT Handover.
This IE shall be sent on the S5/S8 interface if the RAT type changes. | RAT Type | 0 | +| | CO | If SGW receives this IE from MME/SGSN during a TAU/RAU/Handover with SGW change procedure, the SGW shall forward it across the S5/S8 interface to PGW. See NOTE 10.

If any condition for including the RAT Type over S5/S8 is met (e.g. the RAT type changes), and if the LTE-M RAT type or Satellite related RAT type is received from the MME, the SGW shall signal the following RAT type to the PGW:
  • - LTE-M RAT type, if LTE-M RAT type is received and the 'LTE-M RAT type reporting to PGW' flag is received from the MME; or the WB-E-UTRAN RAT type, otherwise.
  • - Satellite related RAT type, if Satellite related RAT type is received and the 'Satellite RAT Type reporting to PGW Indication' flag is received from the MME; or the RAT type without Satellite, i.e. LTE-M / EUTRAN-NB-IoT / WB-E-UTRAN, otherwise.

See NOTE 26. | | | + +| | | | | | +|------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---| +| | CO | The IE shall be sent on the S11/S4 interface during the following procedures:
  • - an inter MME TAU or inter SGSN RAU when UE was ISR activated which is indicated by ISRAU flag.
  • - TAU/RAU procedure as part of optional network triggered service restoration procedure with ISR, as specified by 3GPP TS 23.007 [17].
If ISR is active, this IE shall also be included on the S11 interface in the S1-U GTP-U tunnel setup procedure during an intra-MME intra-SGW TAU procedure. | | | +| | CO | The MME shall set the RAT type to LTE-M, if the eNodeB indicated this is an LTE-M UE and the LTE-M RAT Type has not been reported yet to the SGW. | | | +| | CO | The MME shall set the RAT type to LTE-M Satellite related RAT type, if the eNodeB indicated this is an LTE-M UE accessing satellite E-UTRAN and the LTE-M Satellite related RAT Type has not been reported yet to the SGW. | | | +| Indication Flags | C | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - Idle mode Signalling Reduction Activation Indication: This flag shall be set to 1 on S4/S11 interface, if the ISR is established between the MME and the S4 SGSN.
  • - Handover Indication: This flag shall be set to 1 on the S4/S11 and S5/S8 interfaces during a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN or a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN procedures.
  • - Direct Tunnel Flag: This flag shall be set to 1 on the S4 interface, if Direct Tunnel is used.
  • - Change Reporting Support Indication: shall be set to 1 on S4/S11, S5/S8 interfaces, if the SGSN/MME supports location Info Change Reporting and if the SGSN/MME's operator policy permits reporting of location change to the operator of the PGW with which the session is established. This flag should be ignored by SGW if no message is sent on S5/S8. See NOTE 4.
  • - CSG Change Reporting Support Indication: shall be set to 1 on S4/S11, S5/S8, if the SGSN/MME supports CSG Information Change Reporting and if the SGSN/MME's operator policy permits reporting of the CSG Information change to the operator of the PGW with which the session is established. This flag shall be ignored by SGW if no message is sent on S5/S8. See NOTE 4.
  • - Change F-TEID support Indication: This flag shall be set to 1 on S4/S11 for an IDLE state UE initiated TAU/RAU procedure to allow the SGW changing the GTP-U F-TEID.
  • - Propagate BBAI Information Change:
    The MME/SGSN shall set this flag to 1 on S11/S4 in procedures without MME/SGSN change if the PGW has requested H(e)NB information reporting and the H(e)NB local IP address or UDP port number information from H(e)NB in UE associated S1/Iu signalling has changed.
    (NOTE 8)
    The MME/SGSN shall set this flag to 1 on S11/S4 during TAU/RAU/Handover with MME/SGSN change procedures if the PGW has requested
| Indication | 0 | + +| | | | | +|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--| +| |

H(e)NB information reporting.
See 3GPP TS 23.139 [51].

  • - CS to PS SRVCC indication: This flag shall be set to 1 on S4/S11 and on S5/S8 during UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure as specified in 3GPP TS 23.216 [43].
  • - Change of Location Information Indication (CLII): This flag shall be set to 1 on S4/S11 interface only when the ISR is active for the UE. This flag shall be set to 1 by the MME/S4-SGSN if the ULI IE is included in the Modify Bearer Request message and the location information has changed since last reported by the MME/S4-SGSN. See NOTE 9.
  • - PDN Pause Support Indication: this flag shall be set to 1 on the S5/S8 interface during the TAU/RAU/handover with SGW relocation procedures if the new SGW supports the PGW Pause of Charging procedure.
  • - PDN Pause On Indication: this flag shall be set to 1 on the S5/S8 interface if the SGW requests the PGW to pause the charging for the PDN connection as specified in 3GPP TS 23.401 [3]. (NOTE 13).
  • - PDN Pause Off Indication: this flag shall be set to 1 on the S5/S8 interface if the SGW requests the PGW to unpause the charging for the PDN connection as specified in 3GPP TS 23.401 [3]. (NOTE 13).
  • - Change of Presence Reporting Area information Indication (CPRAI): this flag shall be set to 1 on the S4/S11 interface if ISR is active for the UE and if the Presence Reporting Area Information IE is included in the Modify Bearer Request message and the Presence Reporting Area information has changed since last reported by the MME/S4-SGSN. See NOTE 9.
  • - P-CSCF Restoration Indication: this flag shall be set to 1 on the S11/S4 and S5/S8 interfaces, for the IMS PDN connection, if the MME/S4-SGSN has received the indication from the HSS that a P-CSCF restoration is required for this user.
  • - UE Available for Signalling Indication: this flag shall be set to 1 on S11/S4 by the MME/SGSN during a TAU/RAU or a Service Request procedure for E-UTRAN/UTRAN, or UE initiated Connection Resume procedure for E-UTRAN, or at receipt of an uplink LLC PDU for user data or any valid LLC frame serving as a paging response for GERAN, if the PDN connection is delay tolerant and if there is pending network initiated PDN connection signalling. The SGW shall include this IE on S5/S8 if it receives the flag from the MME/SGSN.
  • - S11-U Tunnel Flag: this flag shall be set to 1 on the S11 interface if user data is transported in NAS signalling.
  • - Extended PCO Support Indication: this flag shall be set to 1 on S11 interface by the MME if the UE and the MME support ePCO. This flag shall be set
| | | +|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--| + +| | | | | | +|---------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|---| +| | |

to 1 on S5/S8 interface by the SGW if the SGW support ePCO and the MME has set the flag to 1 over the S11 interface. See NOTE 18.

  • - NBIFOM Support Indication: this flag shall be set to 1 on S11/S4 during an inter-PLMN mobility procedure for E-UTRAN/UTRAN if the MME/SGSN supports NBIFOM.
    This flag shall be set to 1 on S5/S8 during an inter-PLMN mobility procedure for E-UTRAN/UTRAN if both the SGW and the MME/SGSN support NBIFOM.
    See NOTE 19.
  • - eNB Change Reporting Support Indication: shall be set to 1 on S11, S5/S8 interfaces, if the MME supports location Info Change Reporting and if the MME's operator policy permits reporting of location change to the operator of the PGW with which the session is being established. See NOTE 21.
  • - LTE-M RAT Type reporting to PGW Indication: this flag shall be set to 1 on S11, based on operator policy or roaming agreements (for Home Routed PDN connections), if the SGW needs to forward the LTE-M RAT type to the PGW.
  • - MTEDTA (MT-EDT Applicable): this flag shall be set to "1" on the S11 interface if MT-EDT is applicable to the PDN connection;
  • - MTEDTN (MT-EDT NOT Applicable): this flag shall be set to "1" on the S11 interface if MT-EDT is not applicable to the PDN connection;
  • - Restoration of PDN connections after an PGW-C/SMF Change Support Indication: This flag shall be set to 1 by the MME on the S11 interface, during an 5GS to EPS handover using N26 interface, if the MME supports the Restoration of PDN connections after an PGW-C/SMF Change procedure as specified in clause 31 of 3GPP TS 23.007 [17]. This flag shall be set to 1 by the SGW on the S5/S8 interface if the SGW supports the supports the Restoration of PDN connections after an PGW-C/SMF Change procedure as specified in clause 31 of 3GPP TS 23.007 [17] and if the SGW received the same flag in the Create Session Request message or Modify Bearer Request, during an 5GS to EPS Idle mode mobility using N26 interface or during an 5GS to EPS handover using N26 interface.
  • - UPIPSI (User Plane Integrity Protection Support Indication): this flag shall be set to 1 by the MME on the S11 interface, if the UE, MME and E-UTRAN supports User Plane Integrity Protection with EPS. This flag shall be set to 1 by the SGW on S5/S8 interface if the MME has set the flag to 1 over the S11 interface. See NOTE 18.
  • - Satellite RAT Type reporting to PGW Indication: this flag shall be set to 1 on S11, based on operator policy or roaming agreements (for Home Routed PDN connections), if the SGW needs to forward the Satellite related RAT type to the PGW.
| | | +| Sender F-TEID for Control Plane | C |

The new MME/SGSN shall include this IE on the S11 and S4 interfaces for a TAU/RAU/ Handover with an MME/SGSN change and without any SGW change. See NOTE 10.

If the SGW receives this IE and if it finds that its value is

| F-TEID | 0 | + +| | | | | | +|--------------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---| +| | |

the same as the earlier received value of this IE for this UE, it should interpret this to mean that the MME/SGSN has not changed.

The new SGW shall include this IE on the S5 and S8 interfaces for a TAU/RAU/Handover with a SGW change. See NOTE 10.

If the PGW receives this IE and if it finds that its value is the same as the earlier received value of this IE for this PDN connection, it should interpret this to mean that the SGW has not changed.

| | | +| Aggregate Maximum Bit Rate (APN-AMBR) | C | The APN-AMBR shall be sent for TAU/RAU/Handover from the Gn/Gp SGSN to the S4 SGSN/MME procedures. | AMBR | 0 | +| Delay Downlink Packet Notification Request | C | This IE shall be sent on the S11 interface for a UE triggered Service Request and UE initiated Connection Resume procedures. It shall contain the delay the SGW shall apply between receiving downlink data and sending Downlink Data Notification for all UEs served by that MME (see clause 5.3.4.2 of 3GPP TS 23.401 [3]). | Delay Value | 0 | +| | CO | This IE shall be sent on the S4 interface for a UE triggered Service Request. It shall contain the delay the SGW shall apply between receiving downlink data and sending Downlink Data Notification for all UEs served by that SGSN (see clause 5.3.4.2 of 3GPP TS 23.401 [3]). | | | + +| | | | | | +|--------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|---| +| Bearer Contexts to be modified | C |

This IE shall be sent on the S4/S11 interface and S5/S8 interface, except

  • - on the S5/S8 interface for a UE triggered Service Request and UE initiated Connection Resume procedures.
  • - on the S5/S8 interface for a TAU/RAU/HO without SGW change procedure. See NOTE 10.
  • - on the S5/S8 interface when requesting the PGW to pause or unpause charging for the PDN connection.
  • - on the S5/S8 interface for any other procedure without SGW change which requires to send a Modify Bearer Request to the PGW, e.g. HSS-based P-CSCF restoration for 3GPP access, reporting of UE presence in a Presence Reporting Area, implicit resume of suspended bearers.

(see NOTE 6).

When Handover Indication flag is set to 1 (i.e., for a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN or a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN procedures), the PGW shall ignore this IE. See NOTE 1.

Several IEs with the same type and instance value may be included as necessary to represent a list of Bearers to be modified.

During a TAU/RAU/Handover procedure with an SGW change, the SGW includes all bearers it received from the MME/SGSN (Bearer Contexts to be created, or Bearer Contexts to be modified and also Bearer Contexts to be removed) into the list of 'Bearer Contexts to be modified' IEs, which are then sent on the S5/S8 interface to the PGW (see NOTE 2, see NOTE 10).

During an E-UTRAN Initiated E-RAB modification procedure the MME shall send a Modify Bearer Request, including all the bearers (those modified and those not modified), per PDN connection for which at least one bearer has changed. See NOTE 11.

| Bearer Context | 0 | +| Bearer Contexts to be removed | C |

This IE shall be included on the S4 and S11 interfaces for the TAU/RAU/Handover, UE initiated Connection Resume and Service Request procedures where any of the bearers existing before the TAU/RAU/Handover procedure, UE initiated Connection Resume and Service Request procedures will be deactivated as consequence of the TAU/RAU/Handover procedure, UE initiated Connection Resume and Service Request procedures. See NOTE 3 and NOTE 6.

For each of those bearers, an IE with the same type and instance value, shall be included.

See NOTE 11.

| Bearer Context | 1 | +| Recovery | C | This IE shall be included if contacting the peer for the first time | Recovery | 0 | +| UE Time Zone | CO | This IE shall be included by the MME/SGSN on the S11/S4 interfaces if the UE Time Zone has changed in the case of TAU/RAU/Handover or UE initiated Service Request procedure. See NOTE 5. | UE Time Zone | 0 | + +| | | | | | +|----------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---| +| | CO | This IE shall also be included on the S4/S11 interface during a TAU/RAU/Handover with MME/SGSN change if the source MME/SGSN has set the TZCR bit in the Change to Report Flags IE in the Forward Relocation Request or Context Response message. | | | +| | C | If SGW receives this IE, SGW shall forward it to PGW across S5/S8 interface. | | | +| MME-FQ-CSID | C | This IE shall be included by MME on S11 and shall be forwarded by SGW on S5/S8 according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| SGW-FQ-CSID | C | This IE shall be included by SGW on S5/S8 according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 1 | +| User CSG Information (UCI) | CO | The MME/SGSN shall include this IE for Handover procedures, UE initiated Connection Resume and UE-initiated Service Request procedure if the PGW/PCRF has requested CSG Info reporting and the MME/SGSN support the CSG information reporting and the User CSG information has changed (i.e. the UE is accessed via a new CSG cell or hybrid cell or leaves a CSG or hybrid cell). In TAU/RAU procedure without SGW change, this IE shall also be sent if the PGW/PCRF has requested CSG info reporting and MME/SGSN supports CSG info reporting and the User CSG information has changed (i.e. the UE is accessed via a new CSG cell or hybrid cell or leaves a CSG or hybrid cell) when UE requested to activate E-RAB for all the active EPS bearers in TAU procedure or to keep the lu connection after the completion of the RAU procedure. See NOTE 5. See NOTE 10. See NOTE 16. The SGW shall include this IE on S5/S8 if it receives the User CSG Information from MME/SGSN. See NOTE 15. | UCI | 0 | +| UE Local IP Address | CO | If the UE local IP Address has changed, the ePDG shall include this IE on S2b interface based on local policy for Fixed Broadband access network interworking (see 3GPP TS 23.139 [51]). | IP Address | 1 | +| UE UDP Port | CO | The ePDG shall include this IE on S2b interface if NAT is detected and UE Local IP Address is present for Fixed Broadband access network interworking (see 3GPP TS 23.139 [51]). | Port Number | 1 | +| MME/S4-SGSN LDN | O | This IE is optionally sent by the MME to the SGW on the S11 interface and by the SGSN to the SGW on the S4 interface (see 3GPP TS 32.423 [44]), when communicating the LDN to the peer node for the first time. | Local Distinguished Name (LDN) | 0 | +| SGW LDN | O | This IE is optionally sent by the SGW to the PGW on the S5/S8 interfaces (see 3GPP TS 32.423 [44]), for inter-SGW mobility, when communicating the LDN to the peer node for the first time. | Local Distinguished Name (LDN) | 1 | +| H(e)NB Local IP Address | CO |

The MME/SGSN shall include this IE on S11/S4 interface if the PGW/PCRF has requested H(e)NB information reporting and the MME/SGSN has received this information from H(e)NB in UE associated S1/lu signalling (see 3GPP TS 23.139 [51]).

The SGW shall forward this IE on S5/S8 interface if it is received from the MME/SGSN and

  • - the Modify Bearer Request message needs to be sent to the PGW as specified in the 3GPP TS 23.401 [3]; or
  • - the Propagate BBAI information change flag is received from the MME/SGSN.

(NOTE 7)

| IP Address | 0 | + +| | | | | | +|-------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|---| +| H(e)NB UDP Port | CO |

The MME/SGSN shall include this IE on S11/S4 interface if the PGW/PCRF has requested H(e)NB information reporting and the MME/SGSN has received this information from H(e)NB in UE associated S1/Iu signalling (see 3GPP TS 23.139 [51]).

The SGW shall forward this IE on S5/S8 interface if it is received from the MME/SGSN and

  • - the Modify Bearer Request message needs to be sent to the PGW as specified in the 3GPP TS 23.401 [3]; or
  • - the Propagate BBAI information change flag is received from the MME/SGSN.

(NOTE 7)

| Port Number | 0 | +| MME/S4-SGSN Identifier | CO |

If the PGW triggered SGW restoration procedure is supported, the MME/S4-SGSN shall include this IE on S11/S4 interface and the SGW shall forward this IE on S5 interface in the existing signalling as specified in 3GPP TS 23.007 [17].

If the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs(see clause 12.3.11), the MME/S4-SGSN shall include this IE on the S11/S4 interface during mobility procedures with MME/S4-SGSN change.

| IP Address | 2 | +| | CO |

If the overload control feature is supported by the SGW and if the currently serving MME/S4-SGSN has provided this IE (in this message or in earlier message), the SGW shall include this IE on the S5/S8 interface and shall set it to the last received value of the serving MME/S4-SGSN identity.

| | | +| CN Operator Selection Entity | CO |

In shared networks, the SGSN shall include this IE on the S4 interface for the RAU procedure, if the information is available, and if the Serving Network IE is present in the message or if the CN Operator Selection Entity has changed, to indicate whether the Serving Network has been selected by the UE or by the network.

| CN Operator Selection Entity | 0 | +| | CO |

The SGW shall include this IE on S5/S8 if it receives it from the SGSN.

| | | +| Presence Reporting Area Information | CO |

The MME/SGSN shall include this IE:

  • - if the PGW/PCRF/OCS has just requested to start or modify reporting changes of UE presence in a Presence Reporting Area and the MME/SGSN supports such reporting. The MME/SGSN shall then indicate whether the UE is inside or outside the newly started or modified Presence Reporting Area(s), or indicate the Presence Reporting Area(s) is inactive. Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Information. One IE shall be included for each Presence Reporting Area newly started or modified.

The MME/SGSN shall also include this IE in the following procedures, if the PGW/PCRF requested to report changes of UE presence in a Presence Reporting Area and the MME/SGSN supports such reporting:

  • - TAU/RAU/Handover procedures without SGW change and with MME/SGSN change and S1-based handover procedure with SGW change. The MME/SGSN shall then indicate whether the UE is inside or outside the Presence Reporting Area(s) for each of the active Presence Reporting Area(s), or indicate that the Presence Reporting Area(s) is inactive. Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area
| Presence Reporting Area Information | 0 | + +| | | | | | +|--------------------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---| +| | |

Information.

  • - TAU/RAU/Handover/Cell Update procedures without MME/SGSN change, UE initiated Connection Resume and UE-initiated Service Request procedure if the UE enters or leaves the Presence Reporting Area(s). Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Information. One IE shall be included for each active Presence Reporting Area that the UE has newly entered or left. See NOTE 5, NOTE 10.
  • - UE initiated Service Request, if ISR is active; See NOTE 22.
| | | +| | CO |

When ISR is not active, the SGW shall include this IE(s) on S5/S8 if it receives the Presence Reporting Area Information from MME/SGSN.

When ISR is active, the SGW shall include this IE(s) on S5/S8 if it receives the Presence Reporting Area Information from MME/S4-SGSN and

  • - the RAT Type has changed since last reported; or
  • - the CPRAI flag has been set to 1.
| | | +| MME/S4-SGSN's Overload Control Information | O |

During an overload condition, the MME/S4-SGSN may include this IE on the S11/S4 interface if the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the MME/S4-SGSN shall provide only one instance of this IE, representing its overload information.

| Overload Control Information | 0 | + +| | | | | | +|-------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---| +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the PGW on the S5/S8 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S5/S8 interface if the overload control feature is supported by the SGW and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| ePDG's Overload Control Information | O | During an overload condition, the ePDG may include this IE over the S2b interface if the overload control feature is supported by the ePDG and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the ePDG shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 2 | +| Serving PLMN Rate Control | CO | The MME shall include this IE on the S11 interface if the Serving PLMN Rate is changed.

The target MME shall also include this IE on the S11 interface during an Inter-MME mobility procedure if the Serving PLMN Rate control is configured, and if the configured value is different from the one received from the old MME.

See NOTE 20.

The SGW shall include this IE on S5/S8 if it receives this IE from MME via the Create Session Request or the Modify Bearer Request message. | Serving PLMN Rate Control | 0 | +| MO Exception Data Counter | CO | The MME shall include this IE on the S11 interface when it needs to send a non-zero counter value for the MO Exception Data Counter. The timestamp in the counter shall be set with the time at which the counter value increased from 0 to 1. | Counter | 0 | + +| | | | | | +|-----------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----| +| | CO | The SGW shall include this IE on S5/S8 if it has received the counter from the MME. | | | +| IMSI | O | The MME/SGSN should include the IMSI if available. See NOTE 23. | IMSI | 0 | +| User Location Information for SGW | CO | The MME/SGSN shall include this IE on the S11/S4 interface, based on operator policy for the User Location Information to be sent to the SGW, if the user location information to be passed to the SGW is not already reported in the ULI IE in this message.

When present, this IE shall include the ECGI, TAI, eNodeB ID, RAI and/or RNC-ID, based on local policy. See NOTE 25. | ULI | 1 | +| WLAN Location Information | CO | This IE shall be included on the S2b interface, during a UE initiated IPsec tunnel update procedure, if the WLAN Location Information is available. | TWAN Identifier | 0 | +| WLAN Location Timestamp | CO | This IE shall be included on the S2b interface, during a UE initiated IPsec tunnel update procedure, if the WLAN Location Timestamp is available. | TWAN Identifier Timestamp | 0 | +| Secondary RAT Usage Data Report | CO | If the PLMN has configured secondary RAT usage reporting, the MME shall include this IE on the S11 interface if it has received Secondary RAT usage data from eNodeB in an X2-based handover without Serving GW relocation, S1-based handover without MME or SGW relocation, or E-UTRAN initiated E-RAB modification procedure.
The MME shall also include this IE on the S11 interface if it has received a Secondary RAT Usage Data Report from the source MME in an S1-based handover with MME relocation procedure.
For S1-based handover with SGW relocation, the MME shall also set the IRSGW flag to "0", to indicate that the Secondary RAT usage data is reported for the Source SGW, and sent via the Target SGW to the PGW.
Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | Secondary RAT Usage Data Report | 0 | +| PSCell ID | CO | The MME shall include this IE on the S11 interface, if it has received this information from the eNodeB. | PSCell ID | 0 | +| Private Extension | O | | Private Extension | VS | + +- NOTE1: This requirement is introduced for backwards compatibility reasons. If Bearer Contexts to be modified IE(s) is received in the Modify Bearer Request message, the PGW shall include corresponding Bearer Contexts modified IE(s) in the Modify Bearer Response message. +- NOTE2: According to the description in 3GPP TS 23.401 [3] e.g. clause 5.3.3.1 "Tracking Area Update procedure with Serving GW change" and 3GPP TS 23.060 [35], during a TAU/RAU/Handover procedure with an SGW change, if the SGW receives 'Bearer Context to be removed' IEs, the SGW shall allocate the S5/8-U SGW F-TEID for those bearers and include also these bearers in the 'Bearer contexts to be modified' IE, which is then sent within this message on the S5/S8 interface to the PGW. +- NOTE3: The 'Bearer Contexts to be removed' IE signals to the SGW that these bearers will be removed by the MME/SGSN later on by separate procedures (e.g. MME/S4-SGSN initiated Dedicated Bearer Deactivation procedure). Therefore, the SGW will not delete these bearers during the ongoing TAU/RAU/Handover procedure (without an SGW change), a Handover procedure (with an SGW change except for an X2-Handover), an UE initiated Connection Resume and a Service Request procedure. +- NOTE 4: 3GPP TS 23.401 [3] (e.g. clause 5.3.2.1) and 3GPP TS 23.060 [35] (e.g. clause 9.2.2.1) defines the MME/SGSN shall send the MS Info Change Reporting Support Indication to the PGW. In such case MME/SGSN shall use the Change Reporting Support Indication and/or CSG Change Reporting Support Indication (whichever is applicable), even if stage 2 refers to MS Info Change Reporting Support Indication. +- NOTE 5: In TAU/RAU procedure, if the UE requested to activate E-RAB for all the active EPS bearers in TAU procedure or to keep the Iu connection after the completion of the RAU procedure, the User Location Info/User CSG Information/UE Time Zone/Presence Reporting Area Information shall not be sent in S1-U GTP-U tunnel setup procedure during the TAU procedure when the "active flag" is set (see 3GPP TS 24.301 [23] and 3GPP TS 23.401 [3]) or in the Service Request procedure after the completion of the RAU procedure. +- NOTE 6: 3GPP TS 23.401 [3] specifies that the target MME/SGSN (for a handover with MME/SGSN change and with or without SGW change) and the MME/SGSN (for a handover without MME/SGSN change and with SGW change) shall send the Modify Bearer Request message to the SGW in the S1 based handover/ Inter RAT handover for an unaccepted PDN Connection when at least one PDN Connection of the UE was accepted by the RAN. In this case, the (target) MME shall indicate the reserved IP address to the SGW in the S1 eNodeB F-TEID and the (target) SGSN shall indicate the reserved IP address to the SGW in the S12 RNC F-TEID for all the non GBR bearers of the unaccepted PDN Connection in the Bearer Contexts to be modified IE. An implementation may provide the mentioned reserved IP address e.g. from one of the reserved IP address ranges (see RFC5735 or ), or the IP address may be provisioned by a configuration. The (target) MME/SGSN shall indicate all the GBR bearers of the unaccepted PDN connection in the Bearer Contexts to be removed IE. +- NOTE 7: This IE is sent on S11/S4 in the specified conditions regardless of whether the H(e)NB local IP address and UDP port number information has changed or not to enable the SGW to propagate this IE in Modify Bearer Request over S5/S8 when required for reasons other than reporting a change in the H(e)NB local IP address and UDP port number information. +- NOTE 8: H(e)NB local IP address and UDP port number information changes when the UE moves from an (e)NB to an H(e)NB, or from one H(e)NB to another H(e)NB with a change in the fixed network backhaul, or from one H(e)NB to a (e)NB. +The SGW shall send a Modify Bearer Request on S5/S8 if any of the following condition is met: +a) the Propagate BBAI Information Change flag is received from the MME/SGSN; +b) ISR is active and the RAT type has changed. +- NOTE 9: When ISR is active, the CLII and CPRAI flags allow the SGW to avoid sending Modify Bearer Request message over S5/S8 interface during UE-initiated Service Request procedure, when the ULI IE and/or the Presence Reporting Area Information IE is included over S11/S4 Modify Bearer Request message but the location information and/or the Presence Reporting Area information and the RAT Type has not changed since last reported by the SGW. +- NOTE 10: The RAU/TAU/Handover procedure which requires an SGW selection for the first time, e.g. a Gn/Gp SGSN to an S4 SGSN/MME RAU/TAU/Handover procedure, shall be handled in a similar manner to the RAU/TAU/Handover with an SGW change procedure. +- NOTE 11: The Bearer Context to be modified IE and Bearer Context to be removed IE, together, shall contain all the bearers belonging to the given PDN connection with each bearer appearing in only one of these IEs. See clause 14 for the cases when a Bearer Context mismatch is detected. +- NOTE 12: The conditions of presence of the IEs in the Modify Bearer Request for the MME and S4-SGSN triggered Serving GW relocation (see clause 5.10.4 of 3GPP TS 23.401 [3] and clause 9.2.2.4 of 3GPP TS 23.060 [35]) are identical to those specified respectively for X2 handover with SGW relocation and for Enhanced Serving RNS Relocation with SGW relocation. +- NOTE 13: If this flag is set in the message, the PGW shall not interpret the absence of other IEs (e.g. MME-FQ-CSID, H(e)NB Local IP Address) as bearing any significance. The message may contain either the PDN Pause On Indication or the PDN Pause Off Indication, not both. +- NOTE 14: During the TAU/RAU/Handover from Gn/Gp SGSN, the target MME/S4-SGSN can not derive the level of support for User Location Change Reporting and/or CSG Information Change Reporting at + +the source Gn/Gp SGSN. + +- NOTE 15: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator for supporting UEs, or that of the allocated Core Network Operator for non-supporting UEs. As an exception, based on inter-operator roaming/sharing agreement, if the information on whether the UE is a supporting or non-supporting UE is available, the PLMN ID that is communicated to the HPLMN for non-supporting UEs shall be the Common PLMN ID. +In shared networks, when the MME/S4-SGSN and PGW pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI to the PGW, and the Common PLMN ID shall be communicated in SAI/CGI to the PGW, for both supporting and non-supporting UEs. The Core Network Operator PLMN ID (selected by the UE for supporting UEs or allocated by the network for non-supporting UEs) shall be communicated in the TAI, RAI, UCI and the Serving Network. +See clause 4.4 of 3GPP TS 23.251 [55]. +- NOTE 16: If the UE initiates a TAU or RAU procedure back to the old MME/old S4 SGSN before completing the ongoing TAU or RAU procedure and the UE is not accessed via a CSG cell or hybrid cell, the old MME/old S4-SGSN shall treat this case as the UE leaves a CSG or hybrid cell. +- NOTE 17: The MME/S4-SGSN may be configured to defer the reporting of ULI change until an E-RAB, RAB or user plane is established. In that case, the MME/S4-SGSN shall not send a Modify Bearer Request, unless this is required for other reasons, during TAU/RAU without MME/SGSN change or Service Request (for UTRAN) procedures not requesting to activate data radio bearer(s). For GERAN, the SGSN shall defer the reporting of ULI changes, if so configured in the SGSN, until receipt of an uplink LLC PDU for user data or any valid LLC frame serving as a paging response. +The MME/S4-SGSN shall report ULI changes as soon as detected if it is not configured to defer the reporting of ULI changes until an E-RAB, RAB or user plane is established, or if an E-RAB, RAB or user plane is established. +- NOTE 18: During an Inter-MME/SGSN and Intra-SGW mobility procedure, if the SGW detects that the support of ePCO or User Plane Integrity Protection (i.e. UPIPSI flag) has changed, e.g. when the source MME supports ePCO or User Plane Integrity Protection while the target MME does not support it, the SGW shall trigger a Modify Bearer Request without setting the EPCOSI flag or the UPIPSI flag respectively if the Modify Bearer Request message is not sent due to other reasons. The PGW shall interpret that ePCO or User Plane Integrity Protection is not supported for this PDN Connection. +- NOTE 19: The MME/SGSN or SGW reporting this indication to the PGW during an inter-PLMN procedure does not trigger any extra signalling. +- NOTE 20: The MME can set the Control Plane Only Indication only during a PDN connection creation procedure, and the Serving PLMN Rate Control is only applicable to the PDN connection with Control Plane Only Indication set. +During an inter MME without SGW relocation procedure, when the source MME has not set the Control Plane Only Indication, and the target MME supports only the Control Plane CIoT Optimizations, then the target MME shall not include the Serving PLMN Rate Control IE as the PDN connection cannot be changed to Control Plane Only. +During an inter MME without SGW relocation procedure, when the source MME has set the Control Plane Only Indication and included Serving PLMN rate control IE in the Context Response message, and the target MME supports both the Control Plane CIoT Optimisation and the establishment of the User Plane, the target MME cannot stop the Serving PLMN Rate Control, i.e. the PGW will continue to enforce Serving PLMN Rate Control as the Control Plane Only Indication for this PDN connection cannot be changed during this mobility procedure. +- NOTE 21: An MME which supports eNB Change Reporting shall also support Change reporting and therefore shall set both the Change Report Supporting indication and the eNB Changing Reporting Support Indication. +- NOTE 22: Upon inter MME/SGSN mobility, the target MME/SGSN shall report Presence Reporting Area Information for all the active and inactive PRAs requested by the PGW. Upon intra MME/SGSN mobility, the MME/SGSN shall only report active PRAs whose Presence Reporting Area Information is changed, e.g. from inside to outside, or vice versa. +- NOTE 23: The PGW should use the IMSI or the MEI to verify if the Modify Bearer Request message is received for the right UE context. In some error scenarios, e.g. when a delete bearer request (to delete a PDN connection) is lost over S5/S8, the PGW can receive the Modify Bearer Request message for the hanging PDN connection from the MME/SGSN and SGW, if the PGW has reassigned the F-TEID of the hanging PDN connection for another UE. +- NOTE 24: The eNB Change Reporting feature should be supported homogeneously across all MMEs in the network. Otherwise the PGW would not be notified about the change of support of eNB Change Reporting when the UE moves from an MME supporting eNB Change Reporting to an MME that does not support eNB Change Reporting. +- NOTE 25: This information is used for the SGW-U selection (see Annex B.2 of 3GPP TS 29.244 [80]). +- NOTE 26: If the LTE-M Satellite related RAT type is received from the MME, the SGW shall send the LTE-M RAT type to the PGW if the 'Satellite RAT Type reporting to PGW Indication' is not received and the 'LTE-M RAT Type reporting to PGW Indication' is received, or the SGW shall send the WB-E-UTRAN RAT type to the PGW if both of the indications are absent. + + + +**Table 7.2.7-2: Bearer Context to be modified within Modify Bearer Request** + +| Octets 1 | Bearer Context IE Type = 93 (decimal) | | | | +|----------------------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|------| +| Octets 2 and 3 | Length = n | | | | +| Octets 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | See NOTE 1, NOTE 2. | EBI | 0 | +| S1 eNodeB F-TEID | C | This IE shall be sent on the S11 interface if the S1-U is being used:
  • - for an E-UTRAN initial attach;
  • - for a Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN;
  • - for an UE triggered Service Request;
  • - for an UE initiated Connection Resume procedure;
  • - in all S1-U GTP-U tunnel setup procedure during a TAU procedure (see 3GPP TS 24.301 [23]) /handover cases;
  • - in all procedures where the UE is already in ECM-CONNECTED state, e.g. E-UTRAN Initiated E-RAB modification procedure, possibly HSS-based P-CSCF restoration for 3GPP access. See NOTE 4;
  • - in the Establishment of S1-U bearer during Data Transport in Control Plane CIoT EPS optimisation procedure. See NOTE 7.
If an MME is aware that the eNodeB supports both IP address types, the MME shall send both IP addresses within an F-TEID IE. If only one IP address is included, then the SGW shall assume that the eNodeB does not support the other IP address type.
See NOTE 2, NOTE 5, NOTE 6. | F-TEID | 0 | +| S5/8-U SGW F-TEID | C | This IE shall be sent on the S5/S8 interfaces for a Handover or a TAU/RAU with a SGW change. | F-TEID | 1 | +| S12 RNC F-TEID | C | If available, this IE shall be included if the message is sent on the S4 interface if S12 interface is being used. If an S4-SGSN is aware that the RNC supports both IP address types, the S4-SGSN shall send both IP addresses within an F-TEID IE. If only one IP address is included, then the SGW shall assume that the RNC does not support the other IP address type.
See NOTE 2, NOTE 6. | F-TEID | 2 | +| S4-U SGSN F-TEID | C | If available, this IE shall be included if the message is sent on the S4 interface, if S4-U is being used. If an S4-SGSN supports both IP address types, the S4-SGSN shall send both IP addresses within an F-TEID IE. If only one IP address is included, then the SGW shall assume that the S4-SGSN does not support the other IP address type.
See , NOTE 6. | F-TEID | 3 | +| S11-U MME F-TEID | CO | This IE shall be sent on the S11 interface if S11-U is being used, i.e. for the following procedures:
  • - Mobile Originated Data transport in Control Plane CIoT EPS optimisation with P-GW connectivity
  • - Mobile Terminated Data Transport in Control Plane CIoT EPS optimisation with P-GW connectivity
  • - in all procedures where the S11-U tunnel is already established, e.g. when reporting a change of User Location Information.
  • - TAU/RAU with SGW change procedure and data forwarding of DL data buffered in the old SGW (see clause 5.3.3.1A of 3GPP TS 23.401 [3]) for a Control Plane Only PDN connection. See NOTE 6.
This IE may also be sent on the S11 interface, if S11-U is | F-TEID | 4 | + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--------------------------------------------------------------------------------------------------------------------------------------|--|--| +| | | being used, during a E-UTRAN Tracking Area Update without SGW Change, if the MME needs to establish the S11-U tunnel.
See NOTE 8. | | | +|

NOTE 1: If only EPS Bearer ID IE is included in the Bearer Context to be modified IE during the TAU/RAU without SGW change procedure, the SGW shall remove the stored SGSN/RNC/eNodeB/MME userplane F-TEID locally.

NOTE 2: When Direct Tunnel is used in 3G, e.g. during a Service Request procedure if the UE requests to establish a partial set of radio access bearers and if the SGSN accepts it, or during an SRNS relocation procedure with some bearer contexts being preserved, the SGSN shall provide EBI(s) without S12 RNC F-TEID(s) for these bearer context(s) without corresponding radio access bearer(s) being established. The SGW shall be able to handle these bearer context(s). However, in earlier releases this behaviour may not be supported by the SGW and hence for such SGW, the SGSN shall provide EBI together with S12 RNC F-TEID for each of the bearer context(s) in the Bearer Context to be modified IE.

NOTE 3: It is not possible to establish or release a partial set of radio access bearers in E-UTRAN. The MME shall provide in the Bearer Contexts to be modified IE, for a UE entering or being in CONNECTED state, the EBI together with the S1 eNodeB F-TEID for all the bearers of the PDN connection affected by the Modify Bearer Request other than those possibly indicated in the Bearer Context to be removed IE.

NOTE 4: When the PCO-based extension of the HSS based P-CSCF restoration for 3GPP access is supported as specified in clause 5.4.3 of 3GPP TS 23.380 [61], the MME shall store the S1 eNodeB F-TEID(s) of the IMS PDN connection for UEs with an IMS PDN connection in ECM-CONNECTED state, so that the MME can include all the S1 eNodeB F-TEID(s) of the IMS PDN connection for such a UE in ECM-CONNECTED state in the Modify Bearer Request message.

NOTE 5: When the PCO-based extension of the HSS based P-CSCF restoration for 3GPP access is supported as specified in clause 5.4.3 of 3GPP TS 23.380 [61], the S4-SGSN shall store the S12 RNC F-TEID(s) (if Direct Tunneling is used) for all the bearers of the IMS PDN connection with corresponding radio access bearers established, for UEs with an IMS PDN connection in PMM-CONNECTED state, so that the S4-SGSN can include all the S4-U SGSN F-TEID(s) (if Direct Tunneling is not used) or S12 RNC F-TEID(s) (if Direct Tunneling is used) for all the bearers of the IMS PDN connection with corresponding radio access bearers established, for such a UE in PMM-CONNECTED state in the Modify Bearer Request message.

NOTE 6: During a TAU/RAU with SGW change procedure and data forwarding of DL data buffered in the old SGW (see clause 5.3.3.1A of 3GPP TS 23.401 [3]), the old MME/SGSN shall provide the old SGW with the Forwarding F-TEID received in the Context Acknowledge message (or in the SGSN Context Acknowledge message when a Gn/Gp SGSN is involved) and encode it as either an:
- eNB F-TEID for a PDN connection not established with the CPOPCI flag set to 1 (for an old MME),
- S11-U MME F-TEID for a PDN connection established with the CPOPCI flag set to 1 (for an old MME), or
- S12 RNC F-TEID or S4-U SGSN F-TEID (for an old SGSN),
regardless of the interface type set in the F-TEID received from the new MME/SGSN. This is to make the downlink data forwarding appear as a regular downlink data transmission for the old SGW, i.e. like a Service Request procedure.

NOTE 7: In the Establishment of S1-U bearer during Data Transport in Control Plane CIoT EPS optimisation procedure (see clause 5.3.4B.4 of 3GPP TS 23.401 [3]), the MME may send a Modify Bearer Request to the SGW, to request the establishment of the S1-U bearers, without sending a prior Release Access Bearers Request to tear down the S11-U bearers. In this case, the MME shall encode the bearers being switched from S11-U to S1-U in the Bearer Contexts to be modified IE and the SGW shall release the S11-U bearers upon receipt of the Modify Bearer Request requesting the establishment of the S1-U bearers.

NOTE 8: All the SGi PDN connections of a UE in E-UTRAN shall either use S11-U or S1-U bearers at any point in time. If S11-U is used, the MME shall establish the S11-U bearer of all the UE's SGi PDN connections.

| | | | | + +**Table 7.2.7-3: Bearer Context to be removed within Modify Bearer Request** + +| | | | | | +|-----------------------------|---------------------------------------|----------------------------|----------------|-------------| +| Octets 1 | Bearer Context IE Type = 93 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octets 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | + +**Table 7.2.7-4: Overload Control Information within Modify Bearer Request** + +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +|----------------------------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | + +## 7.2.8 Modify Bearer Response + +The Modify Bearer Response message shall be sent on the S11/S4 interfaces by the SGW to the MME/S4-SGSN, on the S5/S8 interfaces by the PGW to the SGW and on the S2b interface by the PGW to the ePDG as part of the procedures listed for the Modify Bearer Request (see clause 7.2.7). + +If the MME has sent the counter for the RRC Cause "MO Exception data" in the Modify Bearer Request, the MME shall reset the counter value when receiving the Modify Bearer Response message. + +If handling of default bearer fails, then Cause at the message level shall be a failure cause. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Request accepted". +- "Request accepted partially". +- "Context not found". +- "Service not supported". + +**Table 7.2.8-1: Information Elements in a Modify Bearer Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Cause | M | | Cause | 0 | +| MSISDN | C | This IE shall be included on S5/S8 interfaces by the PGW if it is stored in its UE context and if this message is triggered due to TAU/RAU/HO with SGW relocation. | MSISDN | 0 | +| Linked EPS Bearer ID | C | This IE shall be sent on S5/S8 when the UE moves from a Gn/Gp SGSN to the S4 SGSN or MME to identify the default bearer the PGW selects for the PDN Connection. This IE shall also be sent by SGW on S11, S4 during Gn/Gp SGSN to S4-SGSN/MME HO procedures to identify the default bearer the PGW selects for the PDN Connection. | EBI | 0 | +| APN Restriction | C | This IE denotes the restriction on the combination of types of APN for the APN associated with this EPS bearer Context. This IE shall be included over S5/S8 interfaces, and shall be forwarded over S11/S4 interfaces during:
  • - Gn/Gp SGSN to MME/S4-SGSN handover procedures;
  • - Gn/Gp SGSN to S4 SGSN/MME RAU/TAU procedures;
  • - 5GS to EPS Idle mode mobility or handover procedures.
The target MME or SGSN determines the Maximum APN Restriction using the APN Restriction. | APN Restriction | 0 | + +| | | | | | +|--------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|---| +| Protocol Configuration Options (PCO) | C | If SGW receives this IE from PGW on GTP or PMIP based S5/S8, the SGW shall forward PCO to MME/S4-SGSN during Inter RAT handover from the UTRAN or from the GERAN to the E-UTRAN. See NOTE 2. | PCO | 0 | +| Bearer Contexts modified | C | EPS bearers corresponding to Bearer Contexts to be modified that were sent in Modify Bearer Request message. Several IEs with the same type and instance value may be included as necessary to represent a list of the Bearers which are modified. | Bearer Context | 0 | +| Bearer Contexts marked for removal | C | EPS bearers corresponding to Bearer Contexts to be removed sent in the Modify Bearer Request message. Shall be included if request message contained Bearer Contexts to be removed.
For each of those bearers an IE with the same type and instance value shall be included. | Bearer Context | 1 | +| Change Reporting Action | C | This IE shall be included with the appropriate Action field If the location Change Reporting mechanism is to be started or stopped for this subscriber in the SGSN/MME. | Change Reporting Action | 0 | +| CSG Information Reporting Action | CO | This IE shall be included with the appropriate Action field if the location CSG Info change reporting mechanism is to be started or stopped for this subscriber in the SGSN/MME. | CSG Information Reporting Action | 0 | +| H(e)NB Information Reporting | CO | This IE shall be included on the S5/S8 and S4/S11 interfaces with the appropriate Action field if H(e)NB information reporting is to be started or stopped for the PDN connection in the SGSN/MME. | H(e)NB Information Reporting | 0 | +| Charging Gateway Name | C | When Charging Gateway Function (CGF) Address is configured, the PGW shall include this IE on the S5 interface during SGW relocation and when the UE moves from Gn/Gp SGSN to S4-SGSN/MME. See NOTE 1. | FQDN | 0 | +| Charging Gateway Address | C | When Charging Gateway Function (CGF) Address is configured, the PGW shall include this IE on the S5 interface during SGW relocation and when the UE moves from Gn/Gp SGSN to S4-SGSN/MME. See NOTE 1. | IP Address | 0 | +| PGW-FQ-CSID | C | This IE shall be included by PGW on S5/S8 and shall be forwarded by SGW on S11 according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| SGW-FQ-CSID | C | This IE shall be included by SGW on S11 according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 1 | +| Recovery | C | This IE shall be included if contacting the peer for the first time. | Recovery | 0 | +| SGW LDN | O | This IE is optionally sent by the SGW to the MME/SGSN on the S11/S4 interfaces (see 3GPP TS 32.423 [44]), when communicating the LDN to the peer node for the first time. | Local Distinguished Name (LDN) | 0 | +| PGW LDN | O | This IE is optionally sent by the PGW to the SGW on the S5/S8 interfaces (see 3GPP TS 32.423 [44]), when communicating the LDN to the peer node for the first time. | Local Distinguished Name (LDN)Name | 1 | + +| | | | | | +|--------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---| +| Indication Flags | CO |

This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:

  • - Static IPv4 Address Flag: This flag shall be set to 1 on the S5/S8 interface in the TAU/RAU/Handover with SGW change procedure if the PDP/PDN IPv4 address is static as specified in 3GPP TS 32.251 [8]. See NOTE 3.
  • - Static IPv6 Address Flag: This flag shall be set to 1 on the S5/S8 interface in the TAU/RAU/Handover with SGW change procedure if the PDP/PDN IPv6 address is static as specified in 3GPP TS 32.251 [8]. See NOTE 3.
  • - PDN Pause Support Indication: this flag shall be set to 1 on the S5/S8 interface during the TAU/RAU/handover with SGW relocation procedures if the PGW supports the PGW Pause of Charging procedure.
  • - PDN Pause Enable Indication: this flag shall be set to 1 on the S5/S8 interface during the TAU/RAU/handover with SGW relocation procedures if the PGW enables the new SGW to use the PGW Pause of Charging procedure for this PDN connection.
  • - Associate OCI with PGW node's identity: The PGW shall set this flag to 1 on the S5/S8 interface or S2a/S2b interface if it has included the "PGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the HSS or DNS during the PGW selection) of the serving PGW. The SGW shall set this flag on the S11/S4 interface if it supports the overload control feature and if the flag is set on the S5/S8 interface.
  • - Associate OCI with SGW node's identity: The SGW shall set this flag to 1 on the S11/S4 interface if it has included the "SGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW.
  • - Delay Tolerant Connection Indication: the flag shall be set to 1 on the S5/S8 interface during a SGW relocation procedure and when the UE moves from Gn/Gp SGSN to S4-SGSN/MME if the PDN connection is "Delay Tolerant" (see clause 8.12). See NOTE 9.
  • - Notify Start Pause of charging via User plane Support Indication: this flag shall be set to 1 on the S5/S8 interface during a SGW relocation procedure if PDN Pause Enable Indication is set to "1" and if the PGW-C and PGW-U support the Notify Start Pause of Charging via user plane feature as specified in clause 5.30 of 3GPP TS 29.244 [80].
| Indication | 0 | +| Presence Reporting Area Action | CO |

This IE shall be included on the S5/S8 and S11/S4 interfaces with the appropriate Action field if reporting changes of UE presence in a Presence Routing Area is to be started, stopped or modified for this subscriber in the MME/SGSN.

Several IEs with the same type and instance value may be included as necessary to represent a list of Presence

| Presence Reporting Area Action | 0 | + +| | | | | | +|-------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---| +| | | Reporting Area Actions One IE shall be included for each Presence Reporting Area to be started, stopped or modified. | | | +| PGW's node level Load Control Information | O | The PGW may include this IE on the S5/S8 or S2a/S2b interface, providing its node level load information, if the load control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access network, ePDG/TWAN for non-3GPP access network, belongs (see clause 12.2.6). | Load Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the load control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| PGW's APN level Load Control Information | O | The PGW may include this IE on the S5/S8 or S2a/S2b interface, providing APN level load information, if the APN level load control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access network, ePDG/TWAN for non-3GPP access based network, belongs (see clause 12.2.6).

When present, the PGW shall provide one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the load information for a list of APN(s).
See NOTE 5, NOTE 7. | Load Control Information | 1 | +| | CO | If the SGW receives this IE and if it supports APN level load control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's node level Load Control Information | O | The SGW may include this IE, over the S11/S4 interface if the load control feature is supported by the SGW and is activated in the network (see clause 12.2.6).

When present, the SGW shall provide only one instance of this IE, representing its node level load information. | Load Control Information | 2 | +| PGW's Overload Control Information | O | During an overload condition, the PGW may include this IE on the S5/S8 or S2b interface, if the overload control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access based network, ePDG for non-3GPP access based network, belongs (see clause 12.3.11).

When present, the PGW shall provide
  • - node level overload control, in one instance of this IE; and/or
  • - APN level overload control, in one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the overload information for a list of APN(s).
See NOTE 6, NOTE 8. | Overload Control Information | 0 | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|----| +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S11/S4 interface if the overload control feature is supported by the SGW and is activated in the network (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| PDN Connection Charging ID | CO | The PGW shall include this IE on the S5/S8 interface during a TAU/RAU/HO with SGW relocation procedure, if a PDN connection Charging ID has been allocated during the initial Attach or Initial PDN connection establishment procedure. | Charging ID | 0 | +| PGW Change Info | CO | This IE shall be included by the PGW on the S5/S8 interface if it supports the Restoration of PDN connections after an PGW-C/SMF Change procedure as specified in clause 31 of 3GPP TS 23.007 [17] and if the "Restoration of PDN connections after an PGW-C/SMF Change Support Indication" was set to 1 in the Modify Bearer Request message.

This IE may be included otherwise on the S5/S8 interface or the S2b interface to change the PGW Change Info signaled earlier for the PDN connection, if the "Restoration of PDN connections after an PGW-C/SMF Change Support Indication" was set to 1 in the Create Session Request message or in an earlier Modify Bearer Request message (during an 5GS to EPS handover using N26 interface).

The SGW shall transparently forward this IE over the S11 interface. | PGW Change Info | 0 | +| Private Extension | O | | Private Extension | VS | +| NOTE 1: Both Charging Gateway Name and Charging Gateway Address shall not be included at the same time. When both are available, the operator configures a preferred value. | | | | | +| NOTE 2: If MME receives the IE, but no NAS message is sent, MME discards the IE. | | | | | +| NOTE 3: Static IPv4/IPv6 Address Flag is used by SGW to provide dynamic IPv4/v6 address flag information as specified in 3GPP TS 32.251 [8]. | | | | | +| NOTE 4: The conditions of presence of the IEs in the Modify Bearer Response for the MME and S4-SGSN triggered Serving GW relocation (see clause 5.10.4 of 3GPP TS 23.401 [3] and clause 9.2.2.4 of 3GPP TS 23.060 [35]) are identical to those specified respectively for X2 handover with SGW relocation and for Enhanced Serving RNS Relocation with SGW relocation. | | | | | +| NOTE 5: The receiver, not supporting the APN level load control feature, shall ignore all the occurrence(s) of this IE, i.e. "Load Control Information" IE with instance number "1". The receiver, supporting the APN level load control feature and supporting the APN level load information for the maximum of 10 APNs, shall handle the APN level load information for the first 10 APNs and ignore any more APN level load information. | | | | | +| NOTE 6: The receiver, supporting the APN level overload information for the maximum of 10 APNs, shall handle the APN level overload information for the first 10 APNs and ignore any more APN level overload information. | | | | | +| NOTE 7: The APN level load information, provided within and across different instances of the "PGW's APN level Load Control Information" IE(s) shall be limited to 10 different APNs. | | | | | +| NOTE 8: The APN level overload information, provided within and across different instances of the "PGW's Overload Control Information" IE(s) shall be limited to 10 different APNs. | | | | | +| NOTE 9: The SGW may use the DTCI during a Network Triggered Service Restoration procedure as specified in the clause 25.2.1 of 3GPP TS 23.007 [17]. | | | | | + +**Table 7.2.8-2: Bearer Context modified within Modify Bearer Response** + +| | | | | | +|-----------------------------|---------------------------------------|---------------------------------------------------------------|----------------|-------------| +| Octets 1 | Bearer Context IE Type = 93 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octets 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Cause | M | This IE shall indicate if the bearer handling was successful, | Cause | 0 | + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|---| +| | | and if not, gives information on the reason. | | | +| S1-U SGW F-TEID | C | This IE shall be used on the S11 interface, if the S1 interface is used, i.e. if the S11-U Tunnel flag was not set in the Modify Bearer Request. If the 'Change F-TEID support Indication' flag was set to 1 in the Modify Bearer Request and the SGW needs to change the F-TEID, the SGW shall include the new GTP-U F-TEID value. Otherwise, the SGW shall return the currently allocated GTP-U F-TEID value. See NOTE 1 | F-TEID | 0 | +| S12 SGW F-TEID | C | This IE shall be included on the S4 interface if the S12 interface is being used. If the 'Change F-TEID support Indication' flag was set to 1 in the Modify Bearer Request and the SGW needs to change the F-TEID, the SGW shall include the new GTP-U F-TEID value. Otherwise, the SGW shall return the currently allocated GTP-U F-TEID value. See NOTE 1 | F-TEID | 1 | +| S4-U SGW F-TEID | C | This IE shall be present if used on the S4 interface if the S4-U interface is being used. If the 'Change F-TEID support Indication' flag was set to 1 in the Modify Bearer Request and the SGW needs to change the F-TEID, the SGW shall include the new GTP-U F-TEID value. Otherwise, the SGW shall return the currently allocated GTP-U F-TEID value. See NOTE 1 | F-TEID | 2 | +| Charging ID | C | This IE shall be present on the S5/S8 interface if this message is triggered due to one of the following procedures:
  • - TAU/RAU/HO with SGW relocation
  • - TAU/RAU/HO from Gn/Gp SGSN to MME/S4-SGSN
| Charging ID | 0 | +| | O | If S5/S8 interface is GTP, this IE may be sent on the S4 interface, in order to support CAMEL charging at the SGSN, for the following procedures:
  • - inter-SGSN RAU/Handover/SRNS Relocation without SGW change.
  • - inter-SGSN Handover/SRNS Relocation with SGW change.
| | | +| Bearer Flags | CO | Applicable flags are:
  • - PPC (Prohibit Payload Compression): This flag shall be sent on the S5/S8 and the S4 interfaces at S4-SGSN relocation.
| Bearer Flags | 0 | +| S11-U SGW F-TEID | C | This IE shall be present on the S11 interface if S11-U is being used, i.e. if the S11-U Tunnel flag was set in the Modify Bearer Request. If the 'Change F-TEID support Indication' flag was set to 1 in the Modify Bearer Request and the SGW needs to change the F-TEID, the SGW shall include the new GTP-U F-TEID value. Otherwise, the SGW shall return the currently allocated GTP-U F-TEID value. | F-TEID | 3 | +| NOTE 1: The SGW shall use the same F-TEID IP address and TEID values for S1-U, S11-U, S4-U and S12 interfaces; as an exception, when separate IP address spaces are used for S11-U and S1-U, for Control Plane CIoT EPS Optimization, a different IP address and TEID may be used for the S11-U F-TEID. The SGW shall not change its F-TEID for a given interface during the Handover, Service Request, E-UTRAN Initial Attach, Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN, UE Requested PDN connectivity, PDP Context Activation, Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN and E-UTRAN Initiated E-RAB modification procedures.
During Handover and Service Request the target eNodeB/RNC/SGSN may use a different IP type than the one used by the source eNodeB/RNC/SGSN. In order to support such a scenario, the SGW F-TEID should contain both an IPv4 address and an IPv6 address (see also clause 8.22 "F-TEID"). | | | | | + +**Table 7.2.8-3: Bearer Context marked for removal within Modify Bearer Response** + +| | | | | | +|-----------------------------|---------------------------------------|------------------------------------------------------------------------------------------------------------|----------------|-------------| +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Cause | M | This IE shall indicate if the bearer handling was successful, and if not, gives information on the reason. | Cause | 0 | + +**Table 7.2.8-4: Load Control Information within Modify Bearer Response** + +| | | | | | +|-----------------------------------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-------------| +| Octet 1 | Load Control Information IE Type = 181 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Load Control Sequence Number | M | See clause 12.2.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Load Metric | M | See clauses 12.2.5.1.2.2 and 12.2.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| List of APN and Relative Capacity | CO | The IE shall (only) be present in the "PGW's APN level Load Control Information" IE.
For indicating the APN level load, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) & its respective "Relative Capacity" (sharing the same "Load Metric").
See clause 12.2.5.1.2.3 for the description and use of this parameter.
See NOTE 1. | APN and Relative Capacity | 0 | + +NOTE 1: If more than 10 occurrences of "APN and Relative Capacity" IE are received within one instance of the Load Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Load Control Information IE instance. + +**Table 7.2.8-5: Overload Control Information within Modify Bearer Response** + +| | | | | | +|----------------------------------|------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clauses 12.3.5.1.2.3 and 12.3.5.1.2.4 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | +| List of Access Point Name (APN) | CO | The IE may (only) be present in the "PGW's Overload Control Information" IE.
For indicating the APN level overload, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) (sharing the same "Overload Reduction Metric" and "Period of Validity"). See NOTE 1. | APN | 0 | + +NOTE 1: If more than 10 occurrences of APNs are received within one instance of the Overload Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Overload Control Information IE instance. + +**Table 7.2.8-6: PGW Change Info within Modify Bearer Response** + +| | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------| +| Octet 1 | PGW Change Info IE Type = 214 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| PGW Set FQDN | C | When present, this IE shall contain the PGW Set FQDN of the PGW-C/SMF set to which the PGW-C/SMF belongs.
(NOTE) | PGW FQDN | 0 | +| Alternative PGW-C/SMF IP Address | C | When present, this IE shall contain alternative PGW-C/SMF IP addresses within the PGW-C/SMF set to which the PGW-C/SMF belongs.
Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF IP Addresses.
(NOTE) | IP Address | 0 | +| Alternative PGW-C/SMF FQDN | C | When present, this IE shall contain alternative PGW-C/SMF FQDN within the PGW-C/SMF set to which the PGW-C/SMF belongs.

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF FQDNs.
(NOTE) | PGW FQDN | 1 | +| Group Id | O | When present, this IE shall identify the group to which the PDN connection pertains (see clause 31.6 of 3GPP TS 23.007 [17]).

The MME/ePDG shall replace any earlier value associated to the PDN connection with the new value. | Group Id | 0 | +| NOTE: Either the PGW Set FQDN IE, the Alternative PGW-C/SMF IP Address IE, or the Alternative PGW-C/SMF FQDN IE shall be present. | | | | | + +## 7.2.9 Delete Session Request and Delete Bearer Request + +### 7.2.9.1 Delete Session Request + +The direction of this message shall be from MME/S4-SGSN to SGW, from SGW to PGW and from TWAN/ePDG to PGW (see Table 6.1-1). + +A Delete Session Request message shall be sent on the S11 interface by the MME to the SGW and on the S5/S8 interface by the SGW to the PGW for a UE having at least one PDN connection through the SGW and PGW, as part of the procedures: + +- EUTRAN Initial Attach +- UE, HSS or MME Initiated Detach +- UE or MME Requested PDN Disconnection + +It shall also be sent on the S4 interface by the SGSN to the SGW, and on the S5/S8 interface by the SGW to the PGW as part of + +- MS, HLR or SGSN initiated detach procedure +- Combined GPRS/IMSI Attach +- MS and SGSN Initiated PDN connection Deactivation Procedure using S4 + +On the S11 interface by the MME to the SGW as part of the procedures: + +- Tracking Area Update with SGW Change +- S1 Based Handover with SGW Change +- X2 Based Handover with SGW Relocation +- E-UTRAN to UTRAN Iu mode Inter RAT handover with SGW change + +- E-UTRAN to GERAN A/Gb mode Inter RAT handover with SGW change +- Inter RAT handover cancel with SGW change +- MME to 3G Gn/Gp SGSN combined hard handover and SRNS relocation procedure +- MME to SGSN Routing Area Update +- E-UTRAN to Gn/Gp SGSN Inter RAT handover +- S1 Based handover cancel with SGW change +- Optimised Active Handover: E-UTRAN Access to CDMA2000 HRPD Access +- MME triggered Serving GW relocation + +And on the S4 interface by the SGSN to the SGW as part of + +- Enhanced Serving RNS Relocation with SGW relocation using S4 +- Routing Area Update with SGW change +- SGSN to MME Tracking Area Update with SGW change +- SRNS Relocation Cancel Procedure Using S4 +- Inter RAT with SGW change handover cancel +- Serving RNS relocation with SGW change +- UTRAN Iu mode to E-UTRAN Inter RAT handover with SGW change +- GERAN A/Gb mode to E-UTRAN Inter RAT handover with SGW change +- S4 SGSN to Gn/Gp SGSN Routeing Area Update +- S4 SGSN to Gn/Gp SGSN Serving RNS Relocation Procedures +- S4 SGSN to Gn/Gp SGSN PS handover Procedures +- S4-SGSN triggered Serving GW relocation + +The message shall also be sent on the S2b interface by the ePDG to the PGW as part of procedures: + +- UE/ePDG Initiated Detach with GTP on S2b +- UE Requested PDN Disconnection with GTP on S2b +- HSS/AAA Initiated Detach with GTP on S2b + +The message shall also be sent on the S2a interface by the TWAN to the PGW as part of procedures: + +- UE/TWAN Initiated Detach and UE/TWAN Requested PDN Disconnection in WLAN on GTP S2a +- HSS/AAA Initiated Detach in WLAN on GTP S2a + +This message may also be sent on S5/S8 interface by the SGW to the PGW: + +- If Downlink Data Notification Acknowledge message with Context not found cause value is received. + +During the detach procedure, if ISR is active and SGW receives a Delete Session Request, the SGW shall deactivate the ISR. + +NOTE: The SGW can determine if it is a detach procedure based on e.g. it receives a Delete Session Request message for the last PDN Connection. + +When ISR is active, during the Detach procedure the SGW shall forward the Delete Session Request message to the PGW on the S5/S8 interface after receiving both of the messages sent from the MME and the SGSN for the same PDN Connection. + +If there are any procedure collisions, the Delete Session Request shall have precedence over any other Tunnel Management message. + +During the handover procedure the Delete Session Request message shall not release the indirect data forwarding tunnels. + +Possible Cause values are: + +- "ISR deactivation ". +- "Network Failure". +- "QoS parameter mismatch". + +Table 7.2.9.1-1 specifies the presence of the IEs in the message. + +**Table 7.2.9.1-1: Information Elements in a Delete Session Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|---------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Cause | C | If ISR is being de-activated, the Cause IE shall be included on the S4/S11 interface with the value "ISR deactivation", which indicates that the SGW shall delete the bearer resources by sending Delete Bearer Request to the MME/SGSN on which ISR was activated with the same Cause value "ISR deactivation". See NOTE 3 | Cause | 0 | +| | CO | The MME/SGSN shall include this IE if the message is sent due to a network failure as specified in clause 15.7 of 3GPP TS 23.060 [35] and clause 5.18 of 3GPP TS 23.401 [3]. It indicates to the PGW the reason of the failure.

The SGW shall include this IE on S5/S8 if it receives the Cause from the MME/SGSN. | | | +| Linked EPS Bearer ID (LBI) | C | This IE shall be included on the S4/S11, S5/S8 and S2a/S2b interfaces to indicate the default bearer associated with the PDN being disconnected unless in the handover/TAU/RAU with SGW relocation procedures. | EBI | 0 | +| User Location Information (ULI) | C | The MME/SGSN shall include this IE on the S4/S11 interface for the Detach procedure. The MME shall include ECGI, SGSN shall include CGI/SAI. The SGW shall include this IE on S5/S8 if it receives the ULI from MME/SGSN. See NOTE 4. | ULI
(NOTE 7) | 0 | + +| | | | | | +|--------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---| +| | CO | The MME/SGSN shall include this IE on the S4/S11 interface for the UE or MME Requested PDN Disconnection procedure/MS and SGSN Initiated PDN connection Deactivation Procedure using S4.
The MME shall include ECGI, SGSN shall include CGI/SAI.
The SGW shall include this IE on S5/S8 if it receives the ULI from the MME/SGSN. | | | +| Indication Flags | C | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags:
  • - Operation Indication: This flag shall be set to 1 over S4/S11 interface, if the SGW needs to forward the Delete Session Request message to the PGW. This flag shall not be set if the ISR associated GTP entity sends this message to the SGW in the Detach procedure. This flag shall also not be set to 1 in the SRNS Relocation Cancel Using S4 (6.9.2.2.4a in 3GPP TS 23.060 [4]), Inter RAT handover Cancel procedure with SGW change TAU with Serving GW change, Gn/Gb based RAU (see 5.5.2.5, 5.3.3.1, D.3.5 in 3GPP TS 23.401 [3], respectively), S1 Based handover Cancel procedure with SGW change.

This flag shall also not be set to 1 for, e.g., X2 based handover procedure with SGW change(see clause 5.5.1.1.3 in 3GPP TS 23.401 [3]), or S1 based handover procedure with SGW change (see clause 5.5.1.2.2 in 3GPP TS 23.401 [3]). See NOTE 1.

  • - Scope Indication: This flag shall be set to 1 on the S4/S11 interface, if the request corresponds to TAU/RAU/Handover with SGW change/SRNS Relocation Cancel Using S4 with SGW change, Inter RAT handover Cancel procedure with SGW change, S1 Based handover Cancel procedure with SGW change. See NOTE 1.
  • - Release Over Any Access Indication (ROAAI): This flag shall be set to 1 over the S4/S11 interface when an NB-IFOM capable MME/SGSN wishes to request release of the PDN connection over any applicable access, e.g.:
    • - during a basic P-CSCF restoration procedure; or
    • - when the MME/SGSN wishes that the PDN connection be reestablished via another PGW for SIPTO.
    See NOTE 9.
| Indication | 0 | +| Protocol Configuration Options (PCO) | C | If the UE includes the PCO IE, then the MME/SGSN shall copy the content of this IE transparently from the PCO IE included by the UE.
If SGW receives the PCO IE, SGW shall forward it to PGW. | PCO | 0 | +| | CO | For the multi-connection mode, if the TWAN receives the PCO from the UE, the TWAN shall forward the PCO IE to the PGW. | | | +| Originating Node | C | This IE shall be included on the S4/S11 interface if the ISR is active in MME/SGSN to denote the type of the node originating the message.
The SGW shall release the corresponding Originating Node related EPS Bearer contexts information in the PDN Connection identified by the LBI. | Node Type | 0 | + +| | | | | | +|---------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---| +| Sender F-TEID for Control Plane | O | This IE may be included on the S4/S11 interfaces except when the source MME/SGSN initiates the deletion of PDN connections not supported by the target MME/SGSN during a successful handover/TAU/RAU procedure with MME/SGSN change and without SGW change (see clauses 5.3.3.2 and 5.5.1.2.1 of 3GPP TS 23.401 [3]), in which case this IE shall not be included. See NOTE 10.
If the Sender F-TEID for Control Plane is received by the SGW, the SGW shall only accept the Delete Session Request message when the Sender F-TEID for Control Plane in this message is the same as the Sender F-TEID for Control Plane that was last received in either the Create Session Request message or the Modify Bearer Request message on the given interface.
If the ISR is activated, two F-TEIDs exist: one for the MME and the other for the SGSN. See NOTE 2. | F-TEID | 0 | +| | O | This IE may be included on the S5/S8 and S2a/S2b interfaces.
If the Sender F-TEID for Control Plane is received by the PGW, the PGW shall only accept the Delete Session Request message when the Sender F-TEID for Control Plane in this message is the same as the Sender F-TEID for Control Plane that was last received in either the Create Session Request message or the Modify Bearer Request message on the given interface. See NOTE 6. | | | +| | CO | The SGW shall include this IE on the S5/S8 interface if the Delete Session Request is sent to clean up a hanging PDN connection context in the PGW, i.e. as a result of receiving a Create Session Request at the SGW colliding with an existing PDN connection context (see clause 7.2.1). | | | +| UE Time Zone | CO | This IE shall be included by the MME on the S11 interface or by the SGSN on the S4 interface, for Detach and PDN Disconnection procedures, if the UE Time Zone has changed. | UE Time Zone | 0 | +| | CO | The SGW shall forward this IE on the S5/S8 interface if the SGW receives it from the MME/SGSN, and if the Operation Indication bit received from the MME/SGSN is set to 1. | | | +| | CO | This IE shall be included by the TWAN on the S2a interface. | | | +| ULI Timestamp | CO | This IE shall be included on the S4/S11 interface if the ULI IE is present. It indicates the time when the User Location Information was acquired.
The SGW shall include this IE on S5/S8 if the SGW receives it from the MME/SGSN. See NOTE 4. | ULI Timestamp | 0 | +| RAN/NAS Release Cause | CO | The MME shall include this IE on the S11 interface to indicate the NAS release cause to release the PDN connection, if available and this information is permitted to be sent to the PGW operator according to MME operator's policy.

The SGW shall include this IE on the S5/S8 interface if it receives it from the MME and if the Operation Indication bit received from the MME is set to 1. | RAN/NAS Cause | 0 | +| | | | | | + +| | | | | | +|--------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---| +| | CO | The TWAN shall include this IE on the S2a interface to indicate the TWAN release cause to release the PDN connection, if this information is available and is permitted to be sent to the PGW operator according to the TWAN operator's policy. When present, the IE shall be encoded as a Diameter or an ESM cause. See NOTE 8. | | | +| | CO | The ePDG shall include this IE on the S2b interface to indicate the release cause to release the PDN connection, if this information is available and is permitted to be sent to the PGW operator according to the ePDG operator's policy. When present, the IE shall be encoded as a Diameter or an IKEv2 cause. | | | +| TWAN Identifier | CO | This IE shall be included by the TWAN on the S2a interface as specified in 3GPP TS 23.402 [45]. | TWAN Identifier | 0 | +| TWAN Identifier Timestamp | CO | This IE shall be included by the TWAN on the S2a if the TWAN Identifier IE is present. It shall indicate the time when the TWAN acquired the TWAN Identifier information. | TWAN Identifier Timestamp | 0 | +| MME/S4-SGSN's Overload Control Information | O | During an overload condition, the MME/S4-SGSN may include this IE on the S11/S4 interface if the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the MME/S4-SGSN shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 0 | + +| | | | | | +|------------------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|---| +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the PGW on the S5/S8 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S5/S8 interface if the overload control feature is supported by the SGW and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| TWAN/ePDG's Overload Control Information | O | During an overload condition, the TWAN/ePDG may include this IE over the S2a/S2b interface if the overload control feature is supported by the TWAN/ePDG and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the TWAN/ePDG shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 2 | +| WLAN Location Information | CO | The ePDG shall include this IE on the S2b interface if the WLAN Location Information is available. | TWAN Identifier | 1 | +| WLAN Location Timestamp | CO | The ePDG shall include this IE on the S2b interface, if the WLAN Location Timestamp is available. | TWAN Identifier Timestamp | 1 | +| UE Local IP Address | CO | The ePDG shall include this IE on the S2b interface. | IP Address | 0 | +| UE UDP Port | CO | The ePDG shall include this IE on the S2b interface if NAT is detected and UDP encapsulation is used. | Port Number | 0 | +| Extended Protocol Configuration Options (ePCO) | CO | If the UE includes the ePCO IE, then the MME shall copy the content of this IE transparently from the ePCO IE included by the UE.
If the SGW receives the ePCO IE, the SGW shall forward it to the PGW. | ePCO | 0 | +| UE TCP Port | CO | The ePDG shall include this IE on the S2b interface if NAT is detected and the TCP encapsulation is used. | Port Number | 1 | +| Secondary RAT Usage Data Report | CO | If the PLMN has configured secondary RAT usage reporting, the MME shall include this IE on the S11 interface if it has received Secondary RAT usage data from eNodeB in a UE-initiated Detach procedure for E-UTRAN, MME-initiated Detach, HSS-initiated Detach, or UE or MME requested PDN disconnection.
The MME shall also include this IE on the S11 interface to the Source SGW if it has received a Secondary RAT Usage Data Report from the eNB in an S1/X2-based handover with Serving GW relocation, or MME triggered Serving GW relocation procedure, or an E-UTRAN to GERAN A/Gb mode Inter RAT handover, E-UTRAN to UTRAN Iu mode Inter RAT handover, MME to 3G SGSN combined hard handover and SRNS relocation, or Routing Area Update procedures. In this case, the IRPGW flag shall be set to "0".
Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | Secondary RAT Usage Data Report | 0 | + +| | | | | | +|-------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|----| +| | O | The SGW shall forward this IE on the S5/S8 interface if it receives the Secondary RAT Usage Data Report with the IRPGW flag set to "1" from MME.
Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | | | +| PSCell ID | CO | The MME shall include this IE on the S11 interface, if it has received this information from the eNodeB. | PSCell ID | 0 | +| Private Extension | O | This IE may be sent on the S5/S8, S4/S11 and S2a/S2b interfaces. | Private Extension | VS | + +NOTE 1: For the Indication Flags, the combination (Operation Indication, Scope Indication) = 1,1 shall be considered an error if received. + +NOTE 2: Following an inter RAT TAU/RAU failure, the target MME/SGSN may mistakenly initiate the implicit detach procedure while the UE is managed by the other MME/SGSN. In this case, the SGW will reject the Delete Session Request message with the cause "Invalid peer". + +NOTE 3: If the UE has multiple PDN connections and only one of these is being deactivated, the MME/S4-SGSN shall not send the Cause IE with the value "ISR deactivation". + +NOTE 4: If ISR is active, after receiving both the Delete Session Request messages from the MME and the SGSN, the SGW shall include the most recent ULI timestamp and the related User Location Information in the Delete Session Request message on S5/S8 interface. + +NOTE 5: The conditions of presence of the IEs in the Delete Session Request for the MME and S4-SGSN triggered Serving GW relocation (see clause 5.10.4 of 3GPP TS 23.401 [3] and clause 9.2.2.4 of 3GPP TS 23.060 [35]) are identical to those specified respectively for X2 handover with SGW relocation and for Enhanced Serving RNS Relocation with SGW relocation. + +NOTE 6: In some scenarios, e.g. during an S11/S4 path failure, the old SGW may send a Delete Session Request towards the PGW for a PDN connection which has already been relocated to a new SGW. In this case, the PGW shall reject the Delete Session Request message with the cause "Invalid peer". + +NOTE 7: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator for supporting UEs, or that of the allocated Core Network Operator for non-supporting UEs. As an exception, based on inter-operator roaming/sharing agreement, if the information on whether the UE is a supporting or non-supporting UE is available, the PLMN ID that is communicated to the HPLMN for non-supporting UEs shall be the Common PLMN ID. +In shared networks, when the MME/S4-SGSN and PGW pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI to the PGW, and the Common PLMN ID shall be communicated in SAI/CGI to the PGW, for both supporting and non-supporting UEs. The Core Network Operator PLMN ID (selected by the UE for supporting UEs or allocated by the network for non-supporting UEs) shall be communicated in the TAI, RAI, UCI and the Serving Network. See clause 4.4 of 3GPP TS 23.251 [55]. + +NOTE 8: This IE corresponds to the TWAN Release Cause IE specified in 3GPP TS 23.402 [45]. + +NOTE 9: An NB-IFOM capable MME/SGSN remains unaware of whether the PDN connection to be released is associated with multiple accesses or not (i.e. whether this is a NB-IFOM PDN connection). + +NOTE 10: During an inter-MME/SGSN and intra SGW mobility procedure, if the Modify Bearer Request message from the target MME/SGSN arrives at the SGW before the Delete Session Request message from the source MME/SGSN, and if the Sender F-TEID for the Control Plane was included in the Delete Session Request, this would lead the SGW to reject the Delete Session Request message. + +**Table 7.2.9.1-2: Overload Control Information within Delete Session Request** + +| | | | | | +|----------------------------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | + +### 7.2.9.2 Delete Bearer Request + +The direction of this message shall be from PGW to SGW, from SGW to MME/S4-SGSN and from PGW to TWAN/ePDG (see Table 6.1-1). + +A Delete Bearer Request message shall be sent on the S5/S8 and S4/S11 interfaces as part of the following procedures: + +- PGW or MME initiated bearer deactivation procedures, +- UE requested Bearer Resource Modification, +- MS and SGSN Initiated Bearer Deactivation procedure using S4 or +- PGW initiated bearer deactivation procedure using S4. + +In the above cases, this Request is sent by the PGW to the SGW and shall be forwarded to the MME or S4-SGSN. + +The message shall also be sent on the S4/S11 interface by the SGW to the SGSN/MME to delete the bearer resources on the other ISR associated CN node if the ISRAI flag is not set in the Modify Bearer Request/Modify Access Bearers Request message. + +The message shall also be sent on the S4/S11 interface by the SGW to the SGSN/MME to delete the bearer resources on the other ISR associated CN node in the TAU/RAU/Handover procedures if the ISR related Cause IE is included in the Delete Session Request message. + +The message shall also be sent on the S2b interface by the PGW to the ePDG as part of PGW Initiated Bearer Resource Allocation Deactivation procedure with GTP on S2b. + +The message shall also be sent on the S2a interface by the PGW to the TWAN as part of the PGW Initiated Bearer Resource Allocation Deactivation in WLAN on GTP on S2a procedure. + +The message may also be sent on the S11/S4 interface by the SGW to the MME/S4 SGSN when the SGW receives the Error Indication from PGW for the default bearer or the ICMP message from a PGW that indicates the UE specific error indication as specified in 3GPP TS 23.007 [17]. + +The message shall also be sent on the S5/S8 or S2a/S2b interface by the PGW to the SGW or to the TWAN/ePDG and on the S11/S4 interface by the SGW to the MME/S4-SGSN as part of the Network-initiated IP flow mobility procedure, as specified by 3GPP TS 23.161 [71]. + +The message shall also be sent on the S5/S8 interface by the PGW to the SGW, as part of EPS to 5GS mobility without N26 interface, ePDG/EPC to 5GS handover, EPS to 5GC/N3IWF handover, as specified in 3GPP TS 23.502 [83]. + +If the UE uses NB-IoT, WB-EUTRAN or GERAN Extended Coverage with increased NAS transmission delay (see 3GPP TS 24.301 [23] and 3GPP TS 24.008 [5]), the MME/SGSN should proceed as specified for a UE in ECM-IDLE state with extended idle mode DRX enabled in clause 5.4.4.1 of 3GPP TS 23.401 [3]. + +Possible Cause values are: + +- "RAT changed from 3GPP to Non-3GPP", +- "ISR deactivation", +- "Access changed from Non-3GPP to 3GPP", +- "Reactivation requested", +- "PDN reconnection to this APN disallowed", +- "PDN connection inactivity timer expires", +- "Local release", +- "Multiple accesses to a PDN connection not allowed", +- "EPS to 5GS Mobility". + +Table 7.2.9.2-1 specifies the presence of IEs in this message. + +**Table 7.2.9.2-1: Information Elements in a Delete Bearer Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|------| +| Linked EPS Bearer ID (LBI) | C | If the request corresponds to the bearer deactivation procedure in case all bearers belonging to a PDN connection shall be released, then this IE shall be included on the S5/S8, S4/S11 and S2a/S2b interfaces to indicate the default bearer associated with the PDN being disconnected.
This IE shall be included only when the EPS Bearer ID is not present in the message. | EBI | 0 | +| | CO | During a TAU/RAU/HO if the Cause value is set to "ISR deactivation" in the Delete Session Request message, or when this message is used to delete the bearer resources on the other ISR associated CN node if the ISRAI flag is not set in the Modify Bearer Request/Modify Access Bearers Request message, an SGW shall send all LBIs for a given UE with the message on S4/S11 interface. All LBI IEs shall have the same type and instance value to represent a list of IEs (see NOTE 1 and NOTE 2). | | | +| EPS Bearer IDs | C | This IE shall be included on S5/S8, S4/S11 and S2a/S2b interfaces for deleting bearers different from the default one, i.e. for dedicated bearers. In this case at least one dedicated bearer shall be included.
This IE shall be included only when the Linked EPS Bearer ID is not present in the message.
Several IEs with this type and instance values shall be included as necessary to represent a list of Bearers. | EBI | 1 | +| Failed Bearer Contexts | O | This IE may be included on the S5/S8 and S11 interfaces if the request corresponds to MME initiated bearer deactivation procedure. This IE shall contain the list of failed bearers if partial Bearer Contexts included in the Delete Bearer Command message could not be deleted. | Bearer Context | 0 | +| Procedure Transaction Id (PTI) | C | If the request corresponds to UE requested bearer resource modification procedure for an E-UTRAN, this IE shall be included on the S5/S8 and S11 interfaces. | PTI | 0 | +| Protocol Configuration Options (PCO) | C | The PGW shall include Protocol Configuration Options (PCO) IE on the S5/S8 interface, if available and if ePCO is not supported by the UE or the network.
If SGW receives this IE, SGW shall forward it to SGSN/MME on the S4/S11 interface. | PCO | 0 | +| | CO | For trusted WLAN access, if the default bearer of the PDN connection is being deleted and if the multi-connection mode is used, the PGW may include this IE over the S2a interface to send PCO to the UE. | | | +| PGW-FQ-CSID | C | This IE shall be included by the PGW on the S5/S8 and S2a/S2b interfaces, and when received from S5/S8 be forwarded by the SGW on the S11 interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| SGW-FQ-CSID | C | This IE shall be included by the SGW on the S11 interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 1 | +| Cause | C | This IE shall be sent on S5/S8 and S11/S4 interfaces if the message is caused by a handover with or without optimization from 3GPP to non-3GPP (see clause 9.3.2 in 3GPP TS 23.402 [45] and clause 5.4.4.1 in 3GPP TS 23.401 [3], respectively). In this case the Cause value shall be set to "RAT changed from 3GPP to Non-3GPP".
This IE shall also be sent on S11/S4 interfaces when the SGW requests to delete all bearer contexts for the given UE in an MME or S4-SGSN due to ISR deactivation, and the Cause value shall be set to "ISR deactivation".
This IE shall be sent on the S2a/S2b interface if the message is caused by handover from non-3GPP to 3GPP. In this case the Cause value shall be set to "Access changed from Non-3GPP to 3GPP". | Cause | 0 | +| | CO | This IE shall be sent on the S5/S8 interface if the message | | | + +| | | | | | +|-------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|---| +| | | is caused by EPS to 5GS mobility. In this case the Cause value shall be set to "EPS to 5GS Mobility". | | | +| | O | This IE may be sent by a PGW on S5/S8 during PGW initiated bearer deactivation procedures for the default bearer with values of "Reactivation requested" or " PDN reconnection to this APN disallowed" or "Multiple accesses to a PDN connection not allowed" (see clause 8.4 for details). | | | +| | O | This IE may be sent by a PGW on S5 during PGW initiated bearer deactivation procedures for the default bearer with values of "PDN connection inactivity timer expires" (see clause 8.4 for details). | | | +| | CO | The IE shall be relayed by the SGW to the MME/S4-SGSN if received from the PGW. | | | +| | CO | This IE shall be sent by the PGW on S5/S8 or S2a/S2b with the value "Reactivation requested", when the PGW initiates the bearer deactivation procedure for the default bearer as part of the P-CSCF restoration procedure over 3GPP access or WLAN access, as specified in 3GPP TS 23.380 [61]. | | | +| | CO | This IE shall be sent by the PGW on S5/S8 or S2a/S2b with the value "Local release", when the PGW initiates the bearer deactivation procedure, for the default bearer of the PDN connection, with local bearer release over one of the accesses associated with the NB-IFOM connection. This can be triggered, for example, as part of the P-CSCF restoration procedure specified in 3GPP TS 23.380 [61], or upon receipt by the PGW of a Delete Session Request from an MME/SGSN with the ROAA Indication set to 1. See NOTE 3. | | | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - Associate OCI with PGW node's identity: The PGW shall set this flag to 1 on the S5/S8 interface or S2a/S2b interface if it has included the "PGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the HSS or DNS during the PGW selection) of the serving PGW. The SGW shall set this flag on the S11/S4 interface if it supports the overload control feature and if the flag is set on the S5/S8 interface.
  • - Associate OCI with SGW node's identity: The SGW shall set this flag to 1 on the S11/S4 interface if it has included the "SGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW.
| Indication | 0 | +| PGW's node level Load Control Information | O | The PGW may include this IE on the S5/S8 or S2a/S2b interface, providing its node level load information, if the load control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access network, ePDG/TWAN for non-3GPP access network, belongs (see clause 12.2.6). | Load Control Information | 0 | + +| | | | | | +|-------------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---| +| | CO | If the SGW receives this IE and if it supports the load control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| PGW's APN level Load Control Information | O | The PGW may include this IE on the S5/S8 or S2a/S2b interface, providing APN level load information, if the APN level load control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access network, ePDG/TWAN for non-3GPP access based network, belongs (see clause 12.2.6).

When present, the PGW shall provide one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the load information for a list of APN(s).
See NOTE 3, NOTE 5. | Load Control Information | 1 | +| | CO | If the SGW receives this IE and if it supports APN level load control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's node level Load Control Information | O | The SGW may include this IE, over the S11/S4 interface if the load control feature is supported by the SGW and is activated in the network (see clause 12.2.6).

When present, the SGW shall provide only one instance of this IE, representing its node level load information. | Load Control Information | 2 | +| PGW's Overload Control Information | O | During an overload condition, the PGW may include this IE on the S5/S8 or S2a/S2b interface, if the overload control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access based network, ePDG/TWAN for non-3GPP access based network, belongs (see clause 12.3.11).

When present, the PGW shall provide
  • - node level overload control, in one instance of this IE; and/or
  • - APN level overload control, in one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the overload information for a list of APN(s).
See NOTE 4, NOTE 6. | Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S11/S4 interface if the overload control feature is supported by the SGW and is activated in the network (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| NBIFOM Container | CO | This IE shall be included on the S5/S8 and S2a/S2b interfaces if the PGW needs to send NBIFOM information as specified in 3GPP TS 23.161 [71]. The Container Type shall be set to 4. | F-Container | 0 | + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|----| +| | CO | If the SGW receives a NBIFOM Container IE from the PGW, the SGW shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| APN RATE Control Status | CO | If APN RATE Control Status is available in PGW and the delete bearer request is for the default Bearer, APN RATE Control Status shall be transferred on the S5/S8 interface. The SGW shall include the APN RATE Control Status IE on the S11/S4 interface, if received from the PGW. | APN RATE Control Status | 0 | +| Extended Protocol Configuration Options (ePCO) | CO | The PGW shall include Extended Protocol Configuration Options (ePCO) IE on the S5/S8 interface, if available and if the UE and the network support ePCO.

If the SGW receives this IE, the SGW shall forward it to the MME on the S11 interface. | ePCO | 0 | +| PGW Change Info | CO | This IE may be included on S5/S8/S2b if the PGW needs to change the PGW Change Info signaled earlier for the PDN connection. It shall be included by the PGW if the PGW S5/S8/S2b IP Address for the control plane for the PDN connection is required to be changed (see PGW triggered PDN connection restoration in clauses 31.4 and 31.4B of 3GPP TS 23.007 [17]).
The SGW shall transparently forward this IE over the S11 interface.

Several IEs with the same IE type and Instance may be present to request the MME/ePDG to re-establish PDN connections associated with either different FQ-CSIDs, or Group Ids or PGW-C/SMF IP addresses to different PGW-C/SMFs. | PGW Change Info | 0 | +| Sender F-TEID for Control Plane | CO | This IE may be included over S5/S8/S2b if the PGW Change Info is present, during a PGW triggered PDN connection restoration (see clauses 31.4 and 31.4B of 3GPP TS 23.007 [17]). When present, it shall contain the F-TEID including the TEID that the SGW or ePDG shall use when sending the Delete Bearer Response message.

This IE may be included over S11 if the PGW Change Info is present, during a Combined SGW-C/PGW-C/SMF triggered PDN connection restoration (see clause 31.4A of 3GPP TS 23.007 [17]). When present, it shall contain the F-TEID including the TEID that the MME shall use when sending the Delete Bearer Response message. | F-TEID | 0 | +| Private Extension | O | This IE may be sent on the S5/S8, S4/S11 and S2a/S2b interfaces. | Private Extension | VS | +| NOTE 1: If the SGW has sent multiple LBIs to MME/SGSN, but have received only one LBI within the Delete Bearer Response message, this indicates that the MME/SGSN is pre Rel-10. In such case, the SGW shall send separate individual Delete Bearer Request message(s) for each of remaining LBIs. | | | | | +| NOTE 2: If the SGW has received Delete Session Request with Cause value set to "ISR deactivation" and has subsequently sent a Delete Bearer Request to the MME/SGSN with Cause value set to "ISR deactivation", then the MME/SGSN shall delete all PDN connections corresponding to all of the LBIs received in the Delete Bearer Request message for this UE. The MME/SGSN shall ignore any LBIs for which there are no matching PDN connections corresponding to these LBIs. | | | | | +| NOTE 3: Upon receiving a Delete Bearer Request message for the default bearer of the PDN connection with cause "Local release", the MME/SGSN or TWAN/ePDG shall behave as specified in clause 5.7.3 of the 3GPP TS 23.380 [61]. | | | | | + +NOTE: In the case that the procedure was initiated by a UE Requested Bearer Resource Modification Procedure for an E-UTRAN as specified by 3GPP TS 24.301 [23], then there will be only one instance of the EPS Bearer IDs IE in the Delete Bearer Request. + +**Table 7.2.9.2-2: Bearer Context within Delete Bearer Request** + +| | | | | | +|-----------------------------|---------------------------------------|-------------------------------------------------------------------------------|----------------|-------------| +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Cause | M | This IE shall indicate the reason of the unsuccessful handling of the bearer. | Cause | 0 | + +**Table 7.2.9.2-3: Load Control Information within Delete Bearer Request** + +| | | | | | +|-----------------------------------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-------------| +| Octet 1 | Load Control Information IE Type = 181 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Load Control Sequence Number | M | See clause 12.2.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Load Metric | M | See clauses 12.2.5.1.2.2 and 12.2.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| List of APN and Relative Capacity | CO | The IE shall (only) be present in the "PGW's APN level Load Control Information" IE.
For indicating the APN level load, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) & its respective "Relative Capacity" (sharing the same "Load Metric").
See clause 12.2.5.1.2.3 for the description and use of this parameter.
See NOTE 1. | APN and Relative Capacity | 0 | + +NOTE 1: If more than 10 occurrences of "APN and Relative Capacity" IE are received within one instance of the Load Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Load Control Information IE instance. + +**Table 7.2.9.2-4: Overload Control Information within Delete Bearer Request** + +| | | | | | +|----------------------------------|------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clauses 12.3.5.1.2.3 and 12.3.5.1.2.4 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | +| List of Access Point Name (APN) | CO | The IE may (only) be present in the "PGW's Overload Control Information" IE.
For indicating the APN level overload, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) (sharing the same "Overload Reduction Metric" and "Period of Validity"). See NOTE 1. | APN | 0 | + +NOTE 1: If more than 10 occurrences of APNs are received within one instance of the Overload Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Overload Control Information IE instance. + +**Table 7.2.9.2-5: PGW Change Info within Delete Bearer Request** + +| Octet 1 | | PGW Change Info IE Type = 214 (decimal) | | | +|----------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octet 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| PGW Set FQDN | O | This IE may be included by a PGW if the PGW Set FQDN is changed. | PGW FQDN | 0 | +| Alternative PGW-C/SMF IP Address | O | This IE may be included by a PGW if the list of alternative PGW-C/SMF IP addresses is changed.

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF IP Addresses. | IP Address | 0 | +| Alternative PGW-C/SMF FQDN | O | This IE may be included by a PGW if the list of alternative PGW-C/SMF FQDNs is changed.

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF FQDNs. | PGW FQDN | 1 | +| New PGW-C/SMF IP Address | C | This IE shall be included by a PGW if the PGW S5/S8/S2b IP Address for the control plane for the PDN connection is required to be changed (see PGW triggered PDN connection restoration in clauses 31.4 and 31.4B and 31.6.3 of 3GPP TS 23.007 [17]). | IP Address | 1 | +| New SGW-C IP Address | O | This IE may be included by a combined SGW/PGW to contain the SGW-C S11 IP address (pertaining to the combined SGW/PGW sending the PGW Change Info IE). The MME should use this information when deciding to which SGW-C S11 IP address should the Create Session Request message be sent, during a combined SGW-C/PGW-C/SMF triggered restoration procedure as specified in clauses 31.4a and 31.6.3A of 3GPP TS 23.007 [17]. | IP Address | 3 | +| PGW-C/SMF FQ-CSI | C | This IE shall be included if the New PGW-C/SMF IP Address IE is present and if the PGW-C/SMF requests the MME/ePDG to re-establish all the PDN connections associated with a PGW-C/SMF FQ-CSI towards the PGW-C indicated in New PGW-C/SMF IP Address IE.

When present, it shall contain the PGW-C/SMF FQ-CSI for which the PDN connections are requested to be re-established.

Several IEs with the same IE type may be present to represent several FQ-CSI of PDN connections that need to be moved to the New PGW-C/SMF IP Address.

See also clause 31.6 of 3GPP TS 23.007 [17]. | FQ-CSI | 0 | +| Group Id | C | This IE shall be included if the New PGW-C/SMF IP Address IE is present and if the PGW-C/SMF requests the MME/ePDG to re-establish all the PDN connections associated with a Group Id towards the PGW-C indicated in New PGW-C/SMF IP Address IE.

When present, it shall contain the Group Id for which the PDN connections are requested to be re-established.

Several IEs with the same IE type may be present to represent several Group Ids of PDN connections that need to be moved to the New PGW-C/SMF IP Address.

See also clause 31.6 of 3GPP TS 23.007 [17]. | Group Id | 0 | +| PGW Control Plane IP Address | C | This IE shall be included if the New PGW-C/SMF IP Address IE is present and if the PGW-C/SMF requests the MME/ePDG to re-establish all the PDN connections of | IP Address | 2 | + +| | | | | | +|--------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---| +| | |

which PGW S5/S8/ S2a/S2b F-TEID contains the PGW Control Plane IP Address towards the PGW-C indicated in New PGW-C/SMF IP Address IE.

Several IEs with the same IE type may be present to represent several PGW-C/SMF IP addresses of PDN connections that need to be moved to the New PGW-C/SMF IP Address.

See also clause 31.6 of 3GPP TS 23.007 [17].

| | | +| New Group Id | O |

The IE may be present if the PGW-C/SMF wants to allocate a new Group Id for the PDN connection. When present, this IE shall identify the new Group Id to which the PDN connection pertains, and the MME/ePDG shall replace any earlier Group ID received for the PDN connection with the new Group ID. If absent, the Group ID associated earlier to the PDN connection, if any, shall remain unchanged.

See also clause 31.6 of 3GPP TS 23.007 [17].

| Group Id | 1 | + +## 7.2.10 Delete Session Response and Delete Bearer Response + +### 7.2.10.1 Delete Session Response + +A Delete Session Response message shall be sent on the S11 interface by the SGW to the MME and on the S5/S8 interface by the PGW to the SGW as part of the following procedures: + +- EUTRAN Initial Attach +- UE, HSS or MME Initiated Detach +- UE or MME Requested PDN Disconnection + +It shall also be sent on the S4 interface by the SGW to the SGSN and on the S5/S8 interface by the PGW to the SGW as part of the procedures: + +- MS, HLR or SGSN initiated detach procedure +- Combined GPRS/IMSI Attach +- MS and SGSN Initiated Default Bearer Deactivation Procedure using S4 + +On the S11 interface by the SGW to the MME as part of the procedures: + +- Tracking Area Update with SGW Change +- S1 Based Handover with SGW Change +- X2 Based Handover with SGW Relocation +- E-UTRAN to UTRAN Iu mode Inter RAT handover with SGW change +- E-UTRAN to GERAN A/Gb mode Inter RAT handover with SGW change +- Inter RAT handover cancel with SGW change +- MME to 3G Gn/Gp SGSN combined hard handover and SRNS relocation procedure +- MME to SGSN Routing Area Update +- E-UTRAN to Gn/Gp SGSN Inter RAT handover +- S1 Based handover cancel with SGW change +- Optimised Active Handover: E-UTRAN Access to CDMA2000 HRPD Access +- MME triggered Serving GW relocation + +And on the S4 interface by the SGW to the SGSN as part of the procedures: + +- Enhanced Serving RNS Relocation with SGW relocation using S4 +- Routing Area Update with SGW change +- SGSN to MME Tracking Area Update with SGW change +- Serving RNS relocation with SGW change +- UTRAN Iu mode to E-UTRAN Inter RAT handover with SGW change +- GERAN A/Gb mode to E-UTRAN Inter RAT handover with SGW change +- S4 SGSN to Gn/Gp SGSN Routeing Area Update +- S4 SGSN to Gn/Gp SGSN Serving RNS Relocation Procedures +- S4 SGSN to Gn/Gp SGSN PS handover Procedures +- S4-SGSN triggered Serving GW relocation + +The message shall also be sent on the S2b interface by the PGW to the ePDG as part of procedures: + +- UE/ePDG Initiated Detach with GTP on S2b +- UE Requested PDN Disconnection with GTP on S2b +- HSS/AAA Initiated Detach with GTP on S2b + +The message shall also be sent on the S2a interface by the PGW to the TWAN as part of procedures: + +- UE/TWAN Initiated Detach and UE/TWAN Requested PDN Disconnection in WLAN on GTP S2a +- HSS/AAA Initiated Detach in WLAN on GTP S2a + +This message may also be sent on S5/S8 interface by the PGW to the SGW: + +- If Downlink Data Notification Acknowledge message with Context not found cause value is received. + +The sending entity shall include Cause IE in the Delete Session Response message. The IE indicates if the peer has deleted the bearer, or not. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Context not found". +- "Invalid peer". + +Table 7.2.10.1-1 specifies the presence of the IEs in the message. + +**Table 7.2.10.1-1: Information Elements in a Delete Session Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------| +| Cause | M | | Cause | 0 | +| Recovery | C | This IE shall be included on the S5/S8, S4/S11 and S2a/S2b interfaces if contacting the peer for the first time | Recovery | 0 | +| Protocol Configuration Options (PCO) | C | The PGW shall include Protocol Configuration Options (PCO) IE on the S5/S8 interface, if available and if the UE or the network does not support ePCO.
If SGW receives this IE, SGW shall forward it to SGSN/MME on the S4/S11 interface. | PCO | 0 | +| | CO | For trusted WLAN access, if the multi-connection mode is used, the PGW may include this IE over the S2a interface to send PCO to the UE. | | | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - Associate OCI with PGW node's identity: The PGW shall set this flag to 1 on the S5/S8 interface or S2a/S2b interface if it has included the "PGW's Overload Control Information" and if this information is to be associated with the node
| Indication | 0 | + +| | | | | | +|-------------------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---| +| | |

identity (i.e. FQDN or the IP address received from the HSS or DNS during the PGW selection) of the serving PGW. The SGW shall set this flag on the S11/S4 interface if it supports the overload control feature and if the flag is set on the S5/S8 interface.

  • - Associate OCI with SGW node's identity: The SGW shall set this flag to 1 on the S11/S4 interface if it has included the "SGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW.
| | | +| PGW's node level Load Control Information | O | The PGW may include this IE on the S5/S8 or S2a/S2b interface, providing its node level load information, if the load control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access network, ePDG/TWAN for non-3GPP access network, belongs (see clause 12.2.6). | Load Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the load control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| PGW's APN level Load Control Information | O |

The PGW may include this IE on the S5/S8 or S2a/S2b interface, providing APN level load information, if the APN level load control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access network, ePDG/TWAN for non-3GPP access based network, belongs (see clause 12.2.6).

When present, the PGW shall provide one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the load information for a list of APN(s).
See NOTE 1, NOTE 3.

| Load Control Information | 1 | +| | CO | If the SGW receives this IE and if it supports APN level load control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's node level Load Control Information | O |

The SGW may include this IE, over the S11/S4 interface if the load control feature is supported by the SGW and is activated in the network (see clause 12.2.6).

When present, the SGW shall provide only one instance of this IE, representing its node level load information.

| Load Control Information | 2 | +| PGW's Overload Control Information | O |

During an overload condition, the PGW may include this IE on the S5/S8 or S2a/S2b interface, if the overload control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access based network, ePDG/TWAN for non-3GPP access based network, belongs (see clause 12.3.11).

When present, the PGW shall provide

  • - node level overload control, in one instance of this IE; and/or
  • - APN level overload control, in one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the overload information for a list of APN(s).

See NOTE 2, NOTE 4.

| Overload Control Information | 0 | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|----| +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S11/S4 interface if the overload control feature is supported by the SGW and is activated in the network (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| Extended Protocol Configuration Options (ePCO) | CO | The PGW shall include Extended Protocol Configuration Options (ePCO) IE on the S5/S8 interface, if available and if the UE and the network support ePCO.

If the SGW receives this IE, the SGW shall forward it to the MME on the S11 interface. | ePCO | 0 | +| APN RATE Control Status | CO | If APN RATE Control Status is available in PGW, APN RATE Control Status shall be transferred on the S5/S8 interface.

The SGW shall include the APN RATE Control Status IE on the S11/S4 interface, if received from the PGW. | APN RATE Control Status | 0 | +| Private Extension | O | This IE may be sent on the S5/S8, S4/S11 and S2a/S2b interfaces. | Private Extension | VS | +| NOTE 1: The receiver, not supporting the APN level load control feature, shall ignore all the occurrence(s) of this IE, i.e. "Load Control Information" IE with instance number "1". The receiver, supporting the APN level load control feature and supporting the APN level load information for the maximum of 10 APNs, shall handle the APN level load information for the first 10 APNs and ignore any more APN level load information. | | | | | +| NOTE 2: The receiver, supporting the APN level overload information for the maximum of 10 APNs, shall handle the APN level overload information for the first 10 APNs and ignore any more APN level overload information. | | | | | +| NOTE 3: The APN level load information, provided within and across different instances of the "PGW's APN level Load Control Information" IE(s) shall be limited to 10 different APNs. | | | | | +| NOTE 4: The APN level overload information, provided within and across different instances of the "PGW's Overload Control Information" IE(s) shall be limited to 10 different APNs. | | | | | + +Table 7.2.10.1-2: Load Control Information within Delete Session Response + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-------------| +| Octet 1 | Load Control Information IE Type = 181 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Load Control Sequence Number | M | See clause 12.2.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Load Metric | M | See clause 12.2.5.1.2.2 for the description and use of this parameter. | Metric | 0 | +| List of APN and Relative Capacity | CO | The IE shall (only) be present in the "PGW's APN level Load Control Information" IE.

For indicating the APN level load, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) & its respective "Relative Capacity" (sharing the same "Load Metric").

See clause 12.2.5.1.2.3 for the description and use of this parameter.

See NOTE 1. | APN and Relative Capacity | 0 | +| NOTE 1: If more than 10 occurrences of "APN and Relative Capacity" IE are received within one instance of the Load Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Load Control Information IE instance. | | | | | + +**Table 7.2.10.1-3: Overload Control Information within Delete Session Response** + +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clauses 12.3.5.1.2.3 and 12.3.5.1.2.4 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | +| List of Access Point Name (APN) | CO | The IE may (only) be present in the "PGW's Overload Control Information" IE.
For indicating the APN level overload, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) (sharing the same "Overload Reduction Metric" and "Period of Validity").
See NOTE 1. | APN | 0 | +| NOTE 1: If more than 10 occurrences of APNs are received within one instance of the Overload Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Overload Control Information IE instance. | | | | | + +## 7.2.10.2 Delete Bearer Response + +The Delete Bearer Response shall be sent as a response of Delete Bearer Request. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Request accepted". +- "Request accepted partially". +- "Context not found". +- "Temporarily rejected due to handover/TAU/RAU procedure in progress". + +**Table 7.2.10.2-1: Information Elements in Delete Bearer Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|------| +| Cause | M | | Cause | 0 | +| Linked EPS Bearer ID (LBI) | C | If the response corresponds to the bearer deactivation procedure in case all the bearers associated with the default bearer of a PDN connection shall be released, this IE shall be included on the S4/S11, S5/S8 and S2a/S2b interfaces to indicate the default bearer associated with the PDN being disconnected. | EBI | 0 | +| | CO | During a TAU/RAU/HO, if an MME/SGSN has received a Delete Bearer Request message with Cause value "ISR deactivation" and multiple LBIs, the MME/SGSN shall include all these LBIs in the response message on S4/S11 interface. All LBI IEs shall have the same type and instance value to represent a list of IEs. | | | +| Bearer Contexts | C | It shall be used on the S4/S11, S5/S8 and S2a/S2b interfaces for bearers different from default one. In this case at least one bearer shall be included.
Several IEs with this type and instance values shall be included as necessary to represent a list of Bearers.
Used for dedicated bearers. When used, at least one dedicated bearer shall be present. All the bearer contexts included in the EPS Bearer IDs IE of the corresponding | Bearer Context | 0 | + +| | | | | | +|--------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---| +| | | Delete Bearer Request shall be included. | | | +| Recovery | C | This IE shall be included on the S4/S11, S5/S8 and S2a/S2b interfaces if contacting the peer for the first time | Recovery | 0 | +| MME-FQ-CSID | C | This IE shall be included by MME on the S11 interface and shall be forwarded by the SGW on S5/S8 interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| SGW-FQ-CSID | C | This IE shall be included by the SGW on the S5/S8 interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 1 | +| ePDG-FQ-CSID | C | This IE shall be included by the ePDG on the S2b interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 2 | +| TWAN-FQ-CSID | C | This IE shall be included by the TWAN on the S2a interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 3 | +| Protocol Configuration Options (PCO) | CO | An MME/SGSN shall include the PCO IE if such information was received from the UE.
If the SGW receives this IE, the SGW shall forward it to PGW on the S5/S8 interface. | PCO | 0 | +| | CO | For the multi-connection mode, if the default bearer of the PDN connection is being deleted and if the TWAN receives the PCO from the UE, the TWAN shall forward the PCO IE to the PGW. | | | +| UE Time Zone | CO | This IE shall be included, if available, by the MME on the S11 interface or by the SGSN on the S4 interface. | UE Time Zone | 0 | +| | CO | The SGW shall forward this IE on the S5/S8 interface if the SGW receives it from the MME/SGSN. | | | +| | CO | This IE shall be included by the TWAN on the S2a interface. | | | +| User Location Information (ULI) | CO | This IE shall be included by the MME on the S11 interface or by the SGSN on the S4 interface. The CGI/SAI shall be included by SGSN and the ECGI shall be included by MME.
See NOTE 2. | ULI | 0 | +| | CO | The SGW shall forward this IE on the S5/S8 interface if it receives it from the MME/SGSN. See NOTE 1. | | | +| ULI Timestamp | CO | This IE shall be included on the S4/S11 interface if the ULI IE is present. It indicates the time when the User Location Information was acquired.
The SGW shall include this IE on S5/S8 if the SGW receives it from the MME/SGSN. See NOTE 1. | ULI Timestamp | 0 | +| TWAN Identifier | CO | This IE shall be included by the TWAN on the S2a interface as specified in 3GPP TS 23.402 [45]. | TWAN Identifier | 0 | +| TWAN Identifier Timestamp | CO | This IE shall be included by the TWAN on the S2a interface if the TWAN Identifier IE is present. It shall indicate the time when the TWAN acquired the TWAN Identifier information. | TWAN Identifier Timestamp | 0 | +| MME/S4-SGSN's Overload Control Information | O | During an overload condition, the MME/S4-SGSN may include this IE on the S11/S4 interface if the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the MME/S4-SGSN shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the PGW on the S5/S8 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S5/S8 interface if the overload control feature is supported by the SGW and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| MME/S4-SGSN Identifier | CO | If the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11), the MME/S4-SGSN shall include this IE on the S11/S4 interface when there is at | IP Address | 0 | + +| | | | | | +|------------------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----| +| | | least one bearer remaining for the given PDN connection after the bearer deletion, and the PGW has not been updated with the identity of the currently serving MME/S4-SGSN, i.e. if no other message carrying MME/S4-SGSN identity has been sent to the PGW during/after an inter-MME/S4-SGSN intra-SGW mobility procedure. | | | +| TWAN/ePDG's Overload Control Information | O | During an overload condition, the TWAN/ePDG may include this IE over the S2a/S2b interface if the overload control feature is supported by the TWAN/ePDG and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the TWAN/ePDG shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 2 | +| WLAN Location Information | CO | The ePDG shall include this IE on the S2b interface if the WLAN Location Information is available. | TWAN Identifier | 1 | +| WLAN Location Timestamp | CO | The ePDG shall include this IE on the S2b interface, if the WLAN Location Timestamp is available. | TWAN Identifier Timestamp | 1 | +| UE Local IP Address | CO | The ePDG shall include this IE on the S2b interface. | IP Address | 0 | +| UE UDP Port | CO | The ePDG shall include this IE on the S2b interface if NAT is detected and UDP encapsulation is used. | Port Number | 0 | +| NBIFOM Container | CO | This IE shall be included on the S11/S4 or S2a/S2b interfaces if the MME/S4-SGSN or the TWAN/ePDG receives a NBIFOM Container from the UE as specified in 3GPP TS 24.161 [3]. The Container Type shall be set to 4. | F-Container | 0 | +| | CO | If the SGW receives a NBIFOM Container IE from the MME/S4-SGSN, the SGW shall forward it to the PGW on the S5/S8 interface. | | | +| UE TCP Port | CO | The ePDG shall include this IE on the S2b interface if NAT is detected and TCP encapsulation is used. | Port Number | 1 | +| Secondary RAT Usage Data Report | CO | If the PLMN has configured secondary RAT usage reporting, the MME shall include this IE on the S11 interface if it has received Secondary RAT usage data from eNodeB in a PDN GW initiated bearer deactivation procedure.
Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | Secondary RAT Usage Data Report | 0 | +| | O | The SGW shall forward this IE on the S5/S8 interface if it receives the Secondary RAT Usage Data Report with the IRPGW flag set to "1" from MME.
Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | | | +| PSCell ID | CO | The MME shall include this IE on the S11 interface, if it has received this information from the eNodeB. | PSCell ID | 0 | +| Private Extension | O | This IE may be sent on the S5/S8, S4/S11 and S2a/S2b interfaces. | Private Extension | VS | + +NOTE 1: If ISR is active, after receiving both the Delete Bearer Response messages from the MME and the SGSN, the SGW shall include the most recent time and the related User Location Information in the Delete Bearer Response message on S5/S8 interface. + +NOTE 2: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator for supporting UEs, or that of the allocated Core Network Operator for non-supporting UEs. As an exception, based on inter-operator roaming/sharing agreement, if the information on whether the UE is a supporting or non-supporting UE is available, the PLMN ID that is communicated to the HPLMN for non-supporting UEs shall be the Common PLMN ID. +In shared networks, when the MME/S4-SGSN and PGW pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI to the PGW, and the Common PLMN ID shall be communicated in SAI/CGI to the PGW, for both supporting and non-supporting UEs. The Core Network Operator PLMN ID (selected by the UE for supporting UEs or allocated by the network for non-supporting UEs) shall be communicated in the TAI, RAI, UCI and the Serving Network. See clause 4.4 of 3GPP TS 23.251 [55]. + +**Table 7.2.10.2-2: Bearer Context within Delete Bearer Response** + +| Octet 1 | | Bearer Context IE Type = 93 (decimal) | | | +|------------------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octet 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Cause | M | This IE shall indicate if the bearer handling was successful, and if not, gives information on the reason. | Cause | 0 | +| Protocol Configuration Options (PCO) | CO | An MME/SGSN shall include the PCO IE if such information was received from the UE.
If the SGW receives this IE, the SGW shall forward it to PGW on the S5/S8 interface.
This bearer level IE takes precedence over the PCO IE in the message body if they both exist. | PCO | 0 | +| RAN/NAS Cause | CO | The MME shall include this IE on the S11 interface to indicate the RAN release cause and/or NAS release cause to release the bearer, if this information is available and is permitted to be sent to the PGW operator according to the MME operator's policy.

If both a RAN release cause and a NAS release cause are generated, then several IEs with the same type and instance value shall be included to represent a list of causes.
The SGW shall include this IE on the S5/S8 interface if it receives it from the MME.
See NOTE 1. | RAN/NAS Cause | 0 | +| Extended Protocol Configuration Options (ePCO) | CO | An MME shall include the ePCO IE if such information is received from the UE.

If the SGW receives this IE, the SGW shall forward it to the PGW on the S5/S8 interface. | ePCO | 0 | + +NOTE 1: The MME may defer the deactivation of GBR bearers for a short period (in the order of seconds) upon receipt of an S1AP UE Context Release Request due to radio reasons, so as to allow the UE to re-establish the corresponding radio and S1 bearers and thus avoid the deactivation of the GBR bearers. If the MME receives then a Delete Bearer Request while it is still deferring the sending of a Delete Bearer Command, the MME shall include in the Delete Bearer Response the RAN/NAS Cause IE it would have included in the Delete Bearer Command. See clauses 5.3.5 and 5.4.4.1 of 3GPP TS 23.401 [3]. + +**Table 7.2.10.2-3: Overload Control Information within Delete Bearer Response** + +| Octet 1 | | Overload Control Information IE Type = 180 (decimal) | | | +|----------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octet 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | + +## 7.2.11 Downlink Data Notification messages + +### 7.2.11.1 Downlink Data Notification + +A Downlink Data Notification message shall be sent: + +- on the S11 interface by the SGW to the MME as a part of the network triggered service request procedure; +- on the S4 interface by the SGW to the S4-SGSN as part of Paging with no established user plane on S4, SGW triggered paging with S4; +- on the S4 interface by the SGW to the S4-SGSN to re-establish all the previous released bearer(s) for a UE, upon receipt of downlink data for a UE in connected mode but without corresponding downlink bearer available; + +NOTE: This may occur e.g. if the S4-SGSN releases some but not all the bearers of the UE as specified in clause 12.7.2.2 of 3GPP TS 23.060 [35]. + +- on S11/S4 interface by SGW to MME/S4-SGSN if the SGW has received an Error Indication (see 3GPP TS 29.281 [13]) from eNodeB/RNC/MME across S1-U/S12/S11-U interface. Respective SGW and MME/S4-SGSN functionality is specified in 3GPP TS 23.007 [17]. +- on the S11/S4 interface by SGW to the MME/S4-SGSN as part of the network triggered service restoration procedure if both the SGW and the MME/S4-SGSN support this optional feature (see 3GPP TS 23.007 [17]). +- on the S11 interface by the SGW to the MME as a part of the Mobile Terminated Data Transport in Control Plane CIoT EPS optimisation with P-GW connectivity. + +A Downlink Data Notification message may be sent: + +- on the S4 by the SGW to the S4-SGSN if the SGW has received an Error Indication from S4-SGSN across S4-U interface. + +Table 7.2.11.1-1 specifies the presence of the IEs in the message. + +**Table 7.2.11.1-1: Information Elements in a Downlink Data Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|------| +| Cause | CO | If SGW receives an Error Indication from eNodeB/RNC/S4-SGSN/MME, the SGW shall send the Cause IE with value "Error Indication received from RNC/eNodeB/S4-SGSN/MME" to MME/S4-SGSN as specified in 3GPP TS 23.007 [17]. | Cause | 0 | +| EPS Bearer ID | CO | This IE shall be included on the S11 and S4 interfaces and shall be set as follows:
  • - If the Downlink Data Notification is triggered by the arrival of downlink data packets at the SGW, the SGW shall include the EPS Bearer ID stored in the EPS bearer context of the bearer on which the downlink data packet was received;
  • - If the Downlink Data Notification is triggered by the receipt of an Error Indication from the eNodeB, RNC or S4-SGSN, the SGW shall include the EPS Bearer ID stored in the EPS bearer context of the bearer for which the Error Indication was received;
  • - If the ISR is active and the Downlink Data Notification is triggered by the arrival of control plane signalling, the SGW shall include the EPS Bearer ID present in the control plane signalling or derived from the control plane signaling (for PMIP based S5/S8), See NOTE 3). For a Downlink Data Notification triggered by a Create Bearer Request message, the SGW shall include the EPS Bearer ID of the corresponding PDN connection's default bearer.
  • - If both the SGW and the MME/S4-SGSN support the network triggered service restoration
| EBI | 0 | + +| | | | | | +|-------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|---| +| | |

procedure (see 3GPP TS 23.007 [17]), and if the Downlink Data Notification is triggered by the arrival of control plane signalling, the SGW shall include the EPS Bearer ID present in the control plane signalling or derived from the control plane signaling (for PMIP based S5/S8). (See 3GPP TS 23.401[3], clause 5.3.4.3).

More than one IE with this type and instance values may be included to represent multiple bearers having received downlink data packets or being signalled in the received control plane message.
See NOTE 1.

| | | +| Allocation/Retention Priority | CO |

This IE shall be included on the S11 and S4 interfaces and shall be set as follows:

  • - If the Downlink Data Notification is triggered by the arrival of downlink data packets at the SGW, the SGW shall include the ARP stored in the EPS bearer context of the bearer on which the downlink data packet was received;
  • - If the Downlink Data Notification is triggered by the receipt of an Error Indication from the eNodeB, RNC or S4-SGSN, the SGW shall include the ARP stored in the EPS bearer context of the bearer for which the Error Indication was received.
  • - If the ISR is active and the Downlink Data Notification is triggered by the arrival of control plane signalling, the SGW shall include the ARP if present in the control plane signalling. If the ARP is not present in the control plane signalling, the SGW shall include the ARP in the stored EPS bearer context. See NOTE 3.
  • - If both the SGW and the MME/S4-SGSN support the network triggered service restoration procedure (see 3GPP TS 23.007 [17]), and if the Downlink Data Notification is triggered by the arrival of control plane signalling, the SGW shall include the ARP if present in the control plane signalling. If the ARP is not present in the control plane signalling, the SGW shall include the ARP from the stored EPS bearer context.

(See 3GPP TS 23.401[3], clause 5.3.4.3).
If multiple EPS Bearers IDs are reported in the message, the SGW shall include the ARP associated with the bearer with the highest priority (i.e. the lowest ARP Priority Level value).
See NOTE 1.

| ARP | 0 | + +| | | | | | +|-------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|----| +| IMSI | CO | This IE shall be included on the S11/S4 interface as part of the network triggered service restoration procedure if both the SGW and the MME/S4-SGSN support this optional feature (see 3GPP TS 23.007 [17]). | IMSI | 0 | +| Sender F-TEID for Control Plane | O | This IE may be included on the S11/S4 interface towards the restarted CN node or an alternative CN node (same type of mobility node as the failed one) as part of the network triggered service restoration procedure with or without ISR if both the SGW and the MME/S4-SGSN support this optional feature (see 3GPP TS 23.007 [17]). This IE shall not be included otherwise.
(NOTE 2) | F-TEID | 0 | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - Associate OCI with SGW node's identity: The SGW shall set this flag to 1 on the S11/S4 interface if it has included the "SGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW.
| Indication | 0 | +| SGW's node level Load Control Information | O | The SGW may include this IE, over the S11/S4 interface if the load control feature is supported by the SGW and is activated in the network (see clause 12.2.6).

When present, the SGW shall provide only one instance of this IE, representing its node level load information. | Load Control Information | 0 | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S5/S8 interface if the overload control feature is supported by the SGW and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 0 | +| Paging and Service Information | CO | This IE shall be included on the S11 and S4 interfaces, for an IP PDN connection, if the SGW supports the Paging Policy Differentiation feature (see clause 4.9 of 3GPP TS 23.401 [3]) and if the Downlink Data Notification is triggered by the arrival of downlink data packets at the SGW. If the preceding conditions are fulfilled, then for each bearer and for each packet that triggers a Downlink Data Notification, the SGW shall copy, into the Paging Policy Indication value within this IE, the value of the DSCP in TOS (IPv4) or TC (IPv6) information received in the IP payload of the GTP-U packet from the PGW (see IETF RFC 2474 [65]).
See NOTE 4.
One IE with this type and instance value shall be included per EPS Bearers ID reported in the message,
See NOTE 1. | Paging and Service Information | 0 | +| DL Data Packets Size | CO | This IE shall be included on the S11 interfaces for a PDN connection if the MT-EDT is applicable and if the SGW supports MT-EDT feature as specified in clause 8.83.

When present, it shall contain the sum of DL Data Packets Size. | Integer Number | 0 | +| Private Extension | O | | Private Extension | VS | + +NOTE 1: The usage of this parameter at the S4-SGSN is not specified in this release. + +NOTE 2: In this version of the specification, the MME/S4-SGSN shall set the header TEID value in subsequent Downlink Data Notification Acknowledge or/and Downlink Data Notification Failure Indication to that of the SGW's Control Plane TEID if the Sender F-TEID for Control Plane IE is present in the Downlink Data Notification message. However the SGW shall be prepared to receive messages in which the header TEID value is set to zero from implementation conforming to earlier versions of this specification. When that is the case, the receiver identifies the subscriber context based on the included IMSI IE. + +| | | +|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 3: | For PMIP based S5/S8, if the SGW cannot derive the EPS bearer ID/ARP from the control plane signalling (received over Gxx interface) the SGW should use the corresponding PDN connection's (for which the control plane signalling is received) default EPS bearer's EPS bearer ID/ARP. | +| NOTE 4: | Upon receiving a downlink data packet for a Non-IP or Ethernet PDN connection (see clause 5.3.1 of 3GPP TS 23.401 [3]), the Paging and Service Information shall not be included in the Downlink Data Notification message. | + +**Table 7.2.11.1-2: Load Control Information within Downlink Data Notification** + +| | | | | | +|------------------------------|--------------------------------------------------|------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Load Control Information IE Type = 181 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Load Control Sequence Number | M | See clause 12.2.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Load Metric | M | See clause 12.2.5.1.2.2 for the description and use of this parameter. | Metric | 0 | + +**Table 7.2.11.1-3: Overload Control Information within Downlink Data Notification** + +| | | | | | +|----------------------------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | + +## 7.2.11.2 Downlink Data Notification Acknowledge + +A Downlink Data Notification Acknowledge shall be sent from a MME/SGSN to a SGW in response to Downlink Data Notification with an indication of success, or failure when MME/SGSN has reachability or abnormal conditions. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Unable to page UE". +- "Context not found". +- "Unable to page UE due to Suspension". +- "UE already re-attached". +- "Temporarily rejected due to handover/TAU/RAU procedure in progress". +- "Rejection due to paging restriction". + +Table 7.2.11.2-1 specifies the presence of the IEs in the message. + +**Table 7.2.11.2-1: Information Elements in a Downlink Data Notification Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Data Notification Delay | C | he MME/SGSN shall include the delay the SGW shall apply between receiving downlink data and sending Downlink Data Notification for all UEs served by that MME/SGSN (see clause 5.3.4.2 of 3GPP TS 23.401 [3]), if the rate of Downlink Data Notification event occurrence in the MME/SGSN becomes significant (as configured by the operator) and the MME/SGSN's load exceeds an operator configured value.
See NOTE 4. | Delay Value | 0 | +| Recovery | C | This IE shall be included if contacting the peer for the first time | Recovery | 0 | +| DL low priority traffic Throttling | O | The MME/SGSN may send this IE to the SGW to request the SGW to reduce the number of Downlink Data Notification requests it sends for downlink low priority traffic received for UEs in idle mode served by that MME/SGSN in proportion to the Throttling Factor and during the Throttling Delay.

See NOTE 1, NOTE 2, NOTE 3. | Throttling | 0 | +| IMSI | CO | 3GPP TS 23.007 [17] specifies conditions for sending this IE on the S11/S4 interface as part of the network triggered service restoration procedure, if both the SGW and the MME/S4-SGSN support this optional feature. | IMSI | 0 | +| DL Buffering Duration | CO | The MME/SGSN shall include this IE on the S11/S4 interface to indicate the duration during which the SGW shall buffer DL data for this UE without sending any further Downlink Data Notification message, if extended buffering in the SGW is required:
  • - for a UE in a power saving state (e.g. Power Saving Mode or extended idle mode DRX) that cannot be reached by paging at the moment, as specified in clause 5.3.4.3 of 3GPP TS 23.401 [3], or.
  • - for a UE using NB-IoT, WB-EUTRAN or GERAN Extended Coverage with increased NAS transmission delay (see 3GPP TS 24.301 [23] and 3GPP TS 24.008 [5]).
If this IE is included in the message, the Cause IE shall be set to "Request Accepted". | EPC Timer | 0 | +| DL Buffering Suggested Packet Count | O | The MME/SGSN may include this IE on the S11/S4 interface, if the DL Buffering Duration IE is included, to suggest the maximum number of downlink data packets to be buffered in the SGW for this UE. | Integer Number | 0 | +| Private Extension | O | | Private Extension | VS | + +NOTE 1: The last received value of the Throttling Factor and Throttling Delay shall supersede any previous values received from that MME/SGSN. The reception of a Throttling Delay shall restart the SGW timer associated with that MME/SGSN. The SGW shall determine whether a bearer is for low priority traffic or not on the basis of the bearer's ARP priority level and operator policy (i.e. operator's configuration in the SGW of the ARP priority levels to be considered as priority or non-priority traffic). + +NOTE 2: For instance, if the DL low priority traffic Throttling IE indicates a Throttling Factor of 40% and a Throttling Delay of 180 seconds, the SGW drops by 40% the number of Downlink Data Notification requests it sends for downlink low priority traffic received for UEs in idle mode served by that MME/SGSN, during a period of 180 seconds. + +NOTE 3: The DL low priority traffic Throttling IE may be present whatever the value of the Cause IE. + +NOTE 4: The Data Notification Delay IE in the Data Notification Acknowledge has the same semantic and usage as the Delay Downlink Packet Notification Request IE in the Modify Bearer Request and Modify Access Bearers Request. + +### 7.2.11.3 Downlink Data Notification Failure Indication + +A Downlink Data Notification Failure indication shall be sent from an MME/SGSN to a SGW indicating that the UE did not respond to paging. It shall also be sent in the case that the UE responded to the page with a Service Request but that the MME has rejected the request by sending a Service Reject to the UE. It may happen, for example, because the requested service is not supported or there is a bearer context mismatch. Additionally, a Downlink Data Notification Failure indication shall be sent in case the UE has rejected the page as specified in clause 4.3.33 in 3GPP TS 23.401 [3]. + +This message should not be used after an MME/SGSN successfully receives the Service Request message from the UE in the Network Triggered Service Request procedure as defined in the 3GPP TS 23.401 [3]. + +NOTE: Either the Modify Bearer Request message or the Delete Bearer Command message is used by the MME/SGSN to indicate a possible failure case after an MME/SGSN successfully receives the Service Request message from the UE. + +Possible Cause values are: + +- "UE not responding". +- "Service denied". +- "UE already re-attached". +- "Rejection due to paging restriction". + +Table 7.2.11.3-1 specifies the presence of the IEs in the message. + +**Table 7.2.11.3-1: Information Elements in a Downlink Data Notification Failure Indication** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Originating Node | CO | This IE shall be included on the S4/S11 interface if the ISR associated GTP entities i.e. MME, S4-SGSN, send this message to the SGW during the Network Triggered Service Request procedure to denote the type of the node originating the message. | Node Type | 0 | +| IMSI | CO | 3GPP TS 23.007 [17] specifies conditions for sending this IE on the S11/S4 interface as part of the network triggered service restoration procedure, if both the SGW and the MME/S4-SGSN support this optional feature. | IMSI | 0 | +| Private Extension | O | | Private Extension | VS | + +### 7.2.12 Delete Indirect Data Forwarding Tunnel Request + +The Delete Indirect Data Forwarding Tunnel Request message is sent on the S4/S11 interface by the SGSN/MME to the SGW to delete the Indirect Forwarding Tunnels in the Source SGW/Target SGW as part of the following procedures: + +- S1-based handover +- UTRAN Iu mode to E-UTRAN Inter RAT handover +- GERAN A/Gb mode to E-UTRAN Inter RAT handover +- E-UTRAN to UTRAN Iu mode Inter RAT handover +- E-UTRAN to GERAN A/Gb mode Inter RAT handover +- MME to 3G SGSN combined hard handover and SRNS relocation procedure +- 3G SGSN to MME combined hard handover and SRNS relocation procedure +- Inter RAT handover Cancel +- S1-based handover Cancel +- Optimised Active Handover: E-UTRAN Access to CDMA2000 HRPD Access +- EPS to 5GS handover using N26 interface + +- 5GS to EPS handover using N26 interface +- N26 based Handover cancel + +**Table 7.2.12-1: Information Element in Delete Indirect Data Forwarding Tunnel Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|-----------------------------------------|-------------------|------| +| Private Extension | O | Vendor or operator specific information | Private Extension | VS | + +## 7.2.13 Delete Indirect Data Forwarding Tunnel Response + +The Delete Indirect Data Forwarding Tunnel Response message is sent on the S4/S11 interface by the SGW to the SGSN/MME as part of the following procedures: + +- S1-based handover +- UTRAN Iu mode to E-UTRAN Inter RAT handover +- GERAN A/Gb mode to E-UTRAN Inter RAT handover +- E-UTRAN to UTRAN Iu mode Inter RAT handover +- E-UTRAN to GERAN A/Gb mode Inter RAT handover +- MME to 3G SGSN combined hard handover and SRNS relocation procedure +- 3G SGSN to MME combined hard handover and SRNS relocation procedure +- Inter RAT handover Cancel +- S1-based handover Cancel +- Optimised Active Handover: E-UTRAN Access to CDMA2000 HRPD Access +- EPS to 5GS handover using N26 interface +- 5GS to EPS handover using N26 interface +- N26 based Handover cancel + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Request accepted". +- "Request accepted partially" +- "Context not found". + +**Table 7.2.13-1: Information Element in Delete Indirect Data Forwarding Tunnel Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|-----------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Cause | M | This IE shall indicate if the deletion of indirect tunnel is successful, and if not, gives information on the reason. | Cause | 0 | +| Recovery | C | This IE shall be included if contacting the peer for the first time. | Recovery | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.2.14 Modify Bearer Command and Failure Indication + +### 7.2.14.1 Modify Bearer Command + +The Modify Bearer Command shall be sent on the S11 interface by the MME to the SGW and on the S5/S8 interface by the SGW to the PGW as part of the HSS Initiated Subscribed QoS Modification procedure, or when the SQCI flag or the PSCI flag is set to 1 in the Context Response message. + +It shall also be sent on the S4 interface by the SGSN to the SGW and on the S5/S8 interface by the SGW to the PGW as part of the HSS Initiated subscribed QoS modification procedure, or when the SQCI flag or the PSCI flag is set to 1 in the Context Response message. + +When deferred reporting of subscription change procedure is homogeneously supported by MMEs and SGSNs in the serving network, the MME shall defer sending Modify Bearer Command if the related UE is not reachable by the MME, e.g. when the UE is suspended, when the UE has entered into power saving mode or when the PPF is cleared in the MME, until the UE becomes reachable again as specified in 3GPP TS 23.401 [3]. + +NOTE: SGSNs do not defer the reporting of subscription change but need to support reporting the subscription change when receiving the PSCI flag in the Context Response message. + +It shall also be sent on the S2a/S2b interface by the TWAN/ePDG to the PGW as part of the HSS Initiated Subscribed QoS Modification procedure. + +**Table 7.2.14.1-1: Information Elements in a Modify Bearer Command** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------| +| APN-Aggregate Maximum Bit Rate (APN-AMBR) | M | This IE shall contain the APN-AMBR value received by the MME/SGSN/ TWAN/ePDG from the HSS. | AMBR | 0 | +| Bearer Context | M | Only one IE with this type and instance value shall be included and this shall represent the Default Bearer. | Bearer Context | 0 | +| MME/S4-SGSN's Overload Control Information | O | During an overload condition, the MME/S4-SGSN may include this IE on the S11/S4 interface if the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).
When present, the MME/S4-SGSN shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the PGW on the S5/S8 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S5/S8 interface if the overload control feature is supported by the SGW and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).
When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| TWAN/ePDG's Overload Control Information | O | During an overload condition, the TWAN/ePDG may include this IE over the S2a/S2b interface if the overload control feature is supported by the TWAN/ePDG and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).
When present, the TWAN/ePDG shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 2 | +| Sender F-TEID for Control Plane | CO | The SGW shall include this IE on the S5/S8 interfaces and set it to the last value sent to the PGW.

If the Sender F-TEID for Control Plane is received, the PGW shall only handle the Modify Bearer Command message if the Sender F-TEID for Control Plane in this message is the same as the last Sender F-TEID for Control Plane received on the given interface. | F-TEID | 0 | +| Private Extension | O | This IE may be sent on the S5/S8, S4/S11 and S2a/S2b interfaces. | Private Extension | VS | + +**Table 7.2.14.1-2: Bearer Context within Modify Bearer Command** + +| Octet 1 | | Bearer Context IE Type = 93 (decimal) | | | +|----------------------|----|-----------------------------------------------------------------------------------------------------------|------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octet 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | This IE shall contain the default bearer ID. | EBI | 0 | +| Bearer Level QoS | C | Mandatory if other parameters than the APN-AMBR have been changed | Bearer QoS | 0 | +| | CO | This IE shall also be included if the SQCI flag or PSCI flag is set to 1 in the Context Response message. | | | + +**Table 7.2.14-3: Overload Control Information within Modify Bearer Command** + +| Octet 1 | | Overload Control Information IE Type = 181 (decimal) | | | +|----------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octet 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | + +## 7.2.14.2 Modify Bearer Failure Indication + +The Modify Bearer Failure Indication shall be sent on the S5/S8 interface by the PGW to the SGW and on the S11 interface by the SGW to the MME as part of failure of HSS Initiated Subscribed QoS Modification procedure, or when the SQCI flag or the PSCI flag is set to 1 in the Context Response message. + +It shall also be sent on the S5/S8 interface by the PGW to the SGW and on the S4 interface by the SGW to the SGSN as part of failure of HSS Initiated subscribed QoS modification, or when the SQCI flag or the PSCI flag is set to 1 in the Context Response message. + +It shall also be sent on the S2a/S2b interface by the PGW to the TWAN/ePDG as part of failure of HSS Initiated Subscribed QoS Modification procedure. + +Cause IE indicates that an EPS bearer has not been updated in the PGW. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Context not found" +- "Service denied". + +**Table 7.2.14.2-1: Information Elements in a Modify Bearer Failure Indication** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------| +| Cause | M | | Cause | 0 | +| Recovery | C | This IE shall be included on the S5/S8, S4/S11 and S2a/S2b interfaces if contacting the peer for the first time | Recovery | 0 | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - Associate OCI with PGW node's identity: The PGW shall set this flag to 1 on the S5/S8 interface or S2a/S2b interface if it has included the "PGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the HSS or DNS during the PGW selection) of the serving PGW. The SGW shall set this flag on the S11/S4 interface if it supports the overload control feature and if the flag is set on the S5/S8 interface.
  • - Associate OCI with SGW node's identity: The SGW shall set this flag to 1 on the S11/S4 interface if it has included the "SGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW.
| Indication | 0 | +| PGW's Overload Control Information | O | During an overload condition, the PGW may include this IE on the S5/S8 or S2a/S2b interface, if the overload control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access based network, ePDG/TWAN for non-3GPP access based network, belongs (see clause 12.3.11).

When present, the PGW shall provide
  • - node level overload control, in one instance of this IE; and/or
  • - APN level overload control , in one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the overload information for a list of APN(s).
See NOTE 1, NOTE 2. | Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S11/S4 interface if the overload control feature is supported by the SGW and and is activated in the network (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| Private Extension | O | This IE may be sent on the S5/S8, S4/S11 and S2a/S2b interfaces. | Private Extension | VS | + +NOTE 1: The receiver, supporting the APN level overload information for the maximum of 10 APNs, shall handle the APN level overload information for the first 10 APNs and ignore any more APN level overload information. + +NOTE 2: The APN level overload information, provided within and across different instances of the "PGW's Overload Control Information" IE(s) shall be limited to 10 different APNs. + +**Table 7.2.14-2: Overload Control Information within Modify Bearer Failure Indication** + +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | +| List of Access Point Name (APN) | CO | The IE may (only) be present in the "PGW's Overload Control Information" IE.
For indicating the APN level overload, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) (sharing the same "Overload Reduction Metric").
See NOTE 1. | APN | 0 | +| NOTE 1: If more than 10 occurrences of APNs are received within one instance of the Overload Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Overload Control Information IE instance. | | | | | + +## 7.2.15 Update Bearer Request + +The direction of this message shall be from PGW to SGW and/or from SGW to MME/S4-SGSN, and/or from PGW to TWAN/ePDG (see Table 6.1-1). + +For GTP based S5/S8, the Update Bearer Request shall be sent by the PGW to the SGW and forwarded to the MME as part of the following procedures: + +- PGW Initiated Bearer Modification with Bearer QoS Update +- HSS Initiated Subscribed QoS Modification +- PGW Initiated Bearer Modification without Bearer QoS Update +- UE Request Bearer Resource Modification procedure (see 3GPP TS 24.301 [23]) +- UE requested bearer resource allocation procedure (see 3GPP TS 24.301 [23]) +- P-CSCF restoration for 3GPP access (see 3GPP TS 23.380 [61]) +- USS UAV Authorization/Authentication (UUAA) procedure during Attach or UE-requested PDN connectivity procedures (see 3GPP TS 23.256 [90]) +- USS initiated UAV Re-authorization procedure in EPS (see 3GPP TS 23.256 [90]) +- Secondary DN authentication and authorization in EPS Interworking case (see clause 5.17.2.5 of 3GPP TS 23.501 [82] and Annex H of 3GPP TS 23.502 [83]) + +The message shall also be sent on the S5/S8 interface by the PGW to the SGW and on the S4 interface by the SGW to the SGSN as part of the following procedures: + +- PGW Initiated EPS Bearer Modification +- Execution part of MS-Initiated EPS Bearer Modification +- SGSN-Initiated EPS Bearer Modification Procedure using S4 +- P-CSCF restoration for 3GPP access (see 3GPP TS 23.380 [61]) + +The message shall also be sent on the S2a/S2b interface by the PGW to the TWAN/ePDG as part of the following procedures: + +- PGW Initiated Bearer Modification +- HSS Initiated Subscribed QoS Modification +- P-CSCF restoration for WLAN access (see 3GPP TS 23.380 [61]) + +For PMIP based S5/S8, the Update Bearer Request shall be sent on the S11 interface by the SGW to the MME and on the S4 interface by the SGW to the SGSN. + +The message shall also be sent on the S5/S8 or S2a/S2b interface by the PGW to the SGW or to the TWAN/ePDG and on the S11/S4 interface by the SGW to the MME/S4-SGSN as part of the Network-initiated IP flow mobility procedure or the UE-initiated IP flow mobility procedure, as specified by 3GPP TS 23.161 [71]. + +Table 7.2.15-1 specifies the presence requirements and the conditions of the IEs in the message. + +**Table 7.2.15-1: Information Elements in an Update Bearer Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|---------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|------| +| Bearer Contexts | M | This IE shall contain contexts related to bearers that need QoS/TFT modification. Several IEs with this type and instance values shall be included as necessary to represent a list of Bearers.
If there is no QoS/TFT modification, only one IE with this type and instance value shall be included. | Bearer Context | 0 | +| Procedure Transaction Id (PTI) | C | If the request corresponds to UE requested bearer resource modification procedure or the UE requested bearer resource allocation procedure for an E-UTRAN (see NOTE 1) or MS initiated EPS bearer modification procedure, this IE shall be included.
PTI shall be the same as the one used in the corresponding Bearer Resource Command | PTI | 0 | +| Protocol Configuration Options (PCO) | C | The PGW shall include the Protocol Configuration Options (PCO) IE on the S5/S8 interface, if available and if ePCO is not supported by the UE or the network. The PCO IE shall carry a P-CSCF address list only when the UE is required to perform an IMS registration, e.g during the P-CSCF restoration procedure as defined in clause 5 of 3GPP TS 23.380 [61].
If SGW receives this IE, SGW shall forward it to SGSN/MME on the S4/S11 interface. | PCO | 0 | +| | CO | The PGW shall include the Protocol Configuration Options (PCO) IE on the S2a interface, including the list of available P-CSCF addresses, as part of the P-CSCF restoration extension procedure for the TWAN access, as specified in 3GPP TS 23.380 [61]. | | | +| Aggregate Maximum Bit Rate (APN-AMBR) | M | APN-AMBR | AMBR | 0 | +| Change Reporting Action | C | This IE shall be included on the S5/S8 and S4/S11 interfaces with the appropriate Action field If the location Change Reporting mechanism is to be started or stopped for this subscriber in the SGSN/MME. | Change Reporting Action | 0 | +| CSG Information Reporting Action | CO | This IE shall be included on the S5/S8 and S4/S11 interfaces with the appropriate Action field if the CSG Info reporting mechanism is to be started or stopped for this subscriber in the SGSN/MME. | CSG Information Reporting Action | 0 | +| H(e)NB Information Reporting | CO | This IE shall be included on the S5/S8 and S4/S11 interfaces with the appropriate Action field if H(e)NB information reporting is to be started or stopped for the PDN connection in the SGSN/MME. | H(e)NB Information Reporting | 0 | + +| | | | | | +|-------------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---| +| Indication flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - Retrieve Location Indication: This flag shall be set to 1 on the S5/S8, S4/S11, S2a and S2b interfaces in the PGW Initiated Bearer Modification procedure if the location information is requested.
  • - Associate OCI with PGW node's identity: The PGW shall set this flag to 1 on the S5/S8 interface or S2a/S2b interface if it has included the "PGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the HSS or DNS during the PGW selection) of the serving PGW. The SGW shall set this flag on the S11/S4 interface if it supports the overload control feature and if the flag is set on the S5/S8 interface.
  • - Associate OCI with SGW node's identity: The SGW shall set this flag to 1 on the S11/S4 interface if it has included the "SGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW.
| Indication | 0 | +| PGW-FQ-CSID | C | This IE shall be included by PGW on the S5/S8 and S2a/S2b interfaces, and when received from S5/S8 be forwarded by SGW on S11 according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| SGW-FQ-CSID | C | This IE shall be included by SGW on S11 according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 1 | +| Presence Reporting Area Action | CO | This IE shall be included on the S5/S8 and S11/S4 interfaces with the appropriate Action field if reporting changes of UE presence in Presence Routing Area(s) is to be started, stopped or modified for this subscriber in the MME/SGSN.

Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Actions. One IE shall be included for each Presence Reporting Area to be started, stopped or modified. | Presence Reporting Area Action | 0 | +| PGW's node level Load Control Information | O | The PGW may include this IE on the S5/S8 or S2a/S2b interface, providing its node level load information, if the load control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access network, ePDG/TWAN for non-3GPP access network, belongs (see clause 12.2.6). | Load Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the load control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| PGW's APN level Load Control Information | O | The PGW may include this IE on the S5/S8 or S2a/S2b interface, providing APN level load information, if the APN level load control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access network, ePDG/TWAN for non-3GPP access based network, belongs (see clause 12.2.6).

When present, the PGW shall provide one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the load information for a list of APN(s).
See NOTE 2, NOTE 4. | Load Control Information | 1 | +| | CO | If the SGW receives this IE and if it supports APN level load control feature, it shall forward it to the MME/S4- | | | +| | CO | | | | + +| | | | | | +|-------------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---| +| | | SGSN on the S11/S4 interface. | | | +| SGW's node level Load Control Information | O | The SGW may include this IE, over the S11/S4 interface if the load control feature is supported by the SGW and is activated in the network (see clause 12.2.6).

When present, the SGW shall provide only one instance of this IE, representing its node level load information. | Load Control Information | 2 | +| PGW's Overload Control Information | O | During an overload condition, the PGW may include this IE on the S5/S8 or S2a/S2b interface, if the overload control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access based network, ePDG/TWAN for non-3GPP access based network, belongs (see clause 12.3.11).

When present, the PGW shall provide
  • - node level overload control, in one instance of this IE; and/or
  • - APN level overload control, in one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the overload information for a list of APN(s).
See NOTE 3, NOTE 5. | Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S11/S4 interface if the overload control feature is supported by the SGW and is activated in the network (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| NBIFOM Container | CO | This IE shall be included on the S5/S8 or S2a/S2b interfaces if the PGW needs to send NBIFOM information as specified in 3GPP TS 23.161 [71]. The Container Type shall be set to 4. | F-Container | 0 | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|----| +| | CO | If the SGW receives a NBIFOM Container IE from the PGW, the SGW shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| PGW Change Info | CO | This IE may be included on S5/S8/S2b if the PGW needs to change the PGW Change Info signaled earlier for the PDN connection. It shall be included by the PGW if the PGW S5/S8/S2b IP Address for the control plane for the PDN connection is required to be changed (see PGW triggered PDN connection restoration in clauses 31.4 and 31.4B of 3GPP TS 23.007 [17]).
The SGW shall transparently forward the IE over S11 interface.

Several IEs with the same IE type and Instance may be present to request the MME/ePDG to re-establish PDN connections associated with different either FQ-CSIDs, or Group Ids or PGW-C/SMF IP addresses to different PGW-C/SMFs. | PGW Change Info | 0 | +| Sender F-TEID for Control Plane | CO | This IE may be included over S5/S8/S2b if the PGW Change Info is present, during a PGW triggered PDN connection restoration (see clauses 31.4 and 31.4B of 3GPP TS 23.007 [17]). When present, it shall contain the F-TEID including the TEID that the SGW or ePDG shall use when sending the Update Bearer Response message.

This IE may be included over S11 if the PGW Change Info is present, during a Combined SGW-C/PGW-C/SMF triggered PDN connection restoration (see clause 31.4A of 3GPP TS 23.007 [17]). When present, it shall contain the F-TEID including the TEID that the MME shall use when sending the Update Bearer Response message. | F-TEID | 0 | +| Private Extension | O | This IE may be sent on the S5/S8, S4/S11 and S2a/S2b interfaces. | Private Extension | VS | +| NOTE 1: This message refers to the UE requested bearer resource allocation procedure and UE requested bearer resource modification procedures defined in 3GPP TS 24.301 [23], both are specified in 3GPP TS 23.401 [3] in the clause "UE requested bearer resource modification". | | | | | +| NOTE 2: The receiver, not supporting the APN level load control feature, shall ignore all the occurrence(s) of this IE, i.e. "Load Control Information" IE with instance number "1". The receiver, supporting the APN level load control feature and supporting the APN level load information for the maximum of 10 APNs, shall handle the APN level load information for the first 10 APNs and ignore any more APN level load information. | | | | | +| NOTE 3: The receiver, supporting the APN level overload information for the maximum of 10 APNs, shall handle the APN level overload information for the first 10 APNs and ignore any more APN level overload information. | | | | | +| NOTE 4: The APN level load information, provided within and across different instances of the "PGW's APN level Load Control Information" IE(s) shall be limited to 10 different APNs. | | | | | +| NOTE 5: The APN level overload information, provided within and across different instances of the "PGW's Overload Control Information" IE(s) shall be limited to 10 different APNs. | | | | | + +NOTE: In the case that the procedure was initiated by a UE Requested Bearer Resource Modification Procedure or UE Requested Bearer Resource Allocation Procedure for an E-UTRAN or MS initiated EPS bearer modification procedure, then there will be only one instance of the Bearer Contexts IE in the Update Bearer Request. + +**Table 7.2.15-2: Bearer Context within Update Bearer Request** + +| Octet 1 | | Bearer Context IE Type = 93 (decimal) | | | +|--------------------------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octet 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| TFT | C | This IE shall be included on the S5/S8, S4/S11 and S2a/S2b interfaces if message relates to Bearer Modification and TFT change. | Bearer TFT | 0 | +| Bearer Level QoS | C | This IE shall be included on the S5/S8, S4/S11 and S2a/S2b interfaces if QoS modification is requested | Bearer QoS | 0 | +| Bearer Flags | O | Applicable flags:
  • - PPC (Prohibit Payload Compression): this flag may be set on the S5/S8 and S4 interfaces.
  • - vSRVCC indicator: This IE may be included by the PGW on the S5/S8 interface according to 3GPP TS 23.216 [43]. When received from S5/S8, SGW shall forward on the S11 interface.
| Bearer Flags | 0 | +| Protocol Configuration Options (PCO) | CO | PGW shall include Protocol Configuration Options (PCO) IE on the S5/S8 interface, if available and if ePCO is not supported by the UE or the network. The PCO IE shall carry a P-CSCF address list only when the UE is required to perform an IMS registration, e.g during the P-CSCF restoration procedure as defined in clause 5.1 of 3GPP TS 23.380 [61].
This bearer level IE takes precedence over the PCO IE in the message body if they both exist.
If the SGW receives this IE, the SGW shall forward it to the SGSN/MME on the S4/S11 interface. | PCO | 0 | +| | CO | The PGW shall include the Protocol Configuration Options (PCO) IE on the S2a interface, including the list of available P-CSCF addresses, as part of the P-CSCF restoration extension procedure for the TWAN access, as specified in 3GPP TS 23.380 [61].
This bearer level IE takes precedence over the PCO IE in the message body if they both exist. | | | +| Additional Protocol Configuration Options (APCO) | CO | The PGW shall include the Additional Protocol Configuration Options (APCO) IE on the S2b interface, including the list of available P-CSCF addresses, as part of the P-CSCF restoration extension procedure for the untrusted WLAN access, as specified in 3GPP TS 23.380 [61]. | Additional Protocol Configuration Options (APCO) | 0 | +| Extended Protocol Configuration Options (ePCO) | CO | The PGW shall include Extended Protocol Configuration Options (ePCO) IE on the S5/S8 interface, if available and if the UE and the network support ePCO. The ePCO IE shall carry a P-CSCF address list only when the UE is required to perform an IMS registration, e.g during the P-CSCF restoration procedure as defined in clause 5.1 of 3GPP TS 23.380 [61].

If the SGW receives this IE, the SGW shall forward it to the MME on the S11 interface. | ePCO | 0 | +| Maximum Packet Loss Rate | O | This IE may be included on the S5/S8 interfaces if the PGW needs to send Maximum Packet Loss Rate as specified in clause 5.4.2.1 of 3GPP TS 23.401 [3]. This IE is only applicable for QCI 1. | Maximum Packet Loss Rate | 0 | +| | CO | If the SGW receives this IE, it shall forward it to the MME on the S11 interface | | | + +**Table 7.2.15-3: Load Control Information within Update Bearer Request** + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-------------| +| Octet 1 | Load Control Information IE Type = 181 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Load Control Sequence Number | M | See clause 12.2.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Load Metric | M | See clauses 12.2.5.1.2.2 and 12.2.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| List of APN and Relative Capacity | CO | The IE shall (only) be present in the "PGW's APN level Load Control Information" IE.
For indicating the APN level load, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) & its respective "Relative Capacity" (sharing the same "Load Metric").
See clause 12.2.5.1.2.3 for the description and use of this parameter.
See NOTE 1. | APN and Relative Capacity | 0 | +| NOTE 1: If more than 10 occurrences of "APN and Relative Capacity" IE are received within one instance of the Load Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Load Control Information IE instance. | | | | | + +**Table 7.2.15-4: Overload Control Information within Update Bearer Request** + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clauses 12.3.5.1.2.3 and 12.3.5.1.2.4 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | +| List of Access Point Name (APN) | CO | The IE may (only) be present in the "PGW's Overload Control Information" IE.
For indicating the APN level overload, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) (sharing the same "Overload Reduction Metric" and "Period of Validity").
See NOTE 1. | APN | 0 | +| NOTE 1: If more than 10 occurrences of APNs are received within one instance of the Overload Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Overload Control Information IE instance. | | | | | + +**Table 7.2.15-5: PGW Change Info within Update Bearer Request** + +| Octet 1 | PGW Change Info IE Type = 214 (decimal) | | | | +|----------------------------------|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| PGW Set FQDN | O | This IE may be included by a PGW if the PGW Set FQDN is changed. | PGW FQDN | 0 | +| Alternative PGW-C/SMF IP Address | O | This IE may be included by a PGW if the list of alternative PGW-C/SMF IP addresses is changed

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF IP Addresses. | IP Address | 0 | +| Alternative PGW-C/SMF FQDN | O | This IE may be included by a PGW if the list of alternative PGW-C/SMF FQDNs is changed.

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF FQDNs. | PGW FQDN | 1 | +| New PGW-C/SMF IP Address | C | This IE shall be included by a PGW if the PGW S5/S8/S2b IP Address for the control plane for the PDN connection is required to be changed (see PGW triggered PDN connection restoration in clauses 31.4 and 31.4B and 31.6.3 of 3GPP TS 23.007 [17]). | IP Address | 1 | +| New SGW-C IP Address | O | This IE may be included by a combined SGW/PGW to contain the SGW-C S11 IP address (pertaining to the combined SGW/PGW sending the PGW Change Info IE). The MME should use this information when deciding to which SGW-C S11 IP address should the Create Session Request message be sent, during a combined SGW-C/PGW-C/SMF triggered restoration procedure as specified in clauses 31.4a and 31.6.3A of 3GPP TS 23.007 [17]. | IP Address | 3 | +| PGW-C/SMF FQ-CSID | C | This IE shall be included if the New PGW-C/SMF IP Address IE is present and if the PGW-C/SMF requests the MME/ePDG to re-establish all the PDN connections associated with a PGW-C/SMF FQ-CSID towards the PGW-C indicated in New PGW-C/SMF IP Address IE.

When present, it shall contain the PGW-C/SMF FQ-CSID for which the PDN connections are requested to be re-established.

Several IEs with the same IE type may be present to represent several FQ-CSIDs of PDN connections that need to be moved to the New PGW-C/SMF IP Address.

See also clause 31.6 of 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| Group Id | C | This IE shall be included if the New PGW-C/SMF IP Address IE is present and if the PGW-C/SMF requests the MME/ePDG to re-establish all the PDN connections associated with a Group Id towards the PGW-C indicated in New PGW-C/SMF IP Address IE.

When present, it shall contain the Group Id for which the PDN connections are requested to be re-established.

Several IEs with the same IE type may be present to represent several Group Ids of PDN connections that need to be moved to the New PGW-C/SMF IP Address.

See also clause 31.6 of 3GPP TS 23.007 [17]. | Group Id | 0 | +| PGW Control Plane IP Address | C | This IE shall be included if the New PGW-C/SMF IP Address IE is present and if the PGW-C/SMF requests the MME/ePDG to re-establish all the PDN connections of | IP Address | 2 | + +| | | | | | +|--------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---| +| | |

which PGW S5/S8/ S2a/S2b F-TEID contains the PGW Control Plane IP Address towards the PGW-C indicated in New PGW-C/SMF IP Address IE.

Several IEs with the same IE type may be present to represent several PGW-C/SMF IP addresses of PDN connections that need to be moved to the New PGW-C/SMF IP Address.

See also clause 31.6 of 3GPP TS 23.007 [17].

| | | +| New Group Id | O |

The IE may be present if the PGW-C/SMF wants to allocate a new Group Id for the PDN connection. When present, this IE shall identify the new Group Id to which the PDN connection pertains, and the MME/ePDG shall replace any earlier Group ID received for the PDN connection with the new Group ID. If absent, the Group ID associated earlier to the PDN connection, if any, shall remain unchanged.

See also clause 31.6 of 3GPP TS 23.007 [17].

| Group Id | 1 | + +## 7.2.16 Update Bearer Response + +An Update Bearer Response shall be sent from a MME/SGSN to a SGW and forwarded to the PGW, and from TWAN/ePDG to the PGW as a response to an Update Bearer Request message. + +Table 7.2.16-1 specifies the presence requirements and the conditions of the IEs in the message. + +Cause IE indicates if an EPS bearer has been modified in the MME/SGSN/TWAN/ePDG or not. The EPS Bearer has not been modified in the MME/SGSN/TWAN/ePDG if the Cause IE value differs from "Request accepted" or "Request accepted partially". Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Request accepted". +- "Request accepted partially" +- "Context not found" +- "Semantic error in the TFT operation". +- "Syntactic error in the TFT operation". +- "Semantic errors in packet filter(s)". +- "Syntactic errors in packet filter(s)". +- "Denied in RAT". +- "UE refuses". +- "Unable to page UE". +- "UE not responding". +- "Unable to page UE due to Suspension". +- "Temporarily rejected due to handover/TAU/RAU procedure in progress". +- "MME/SGSN refuses due to VPLMN Policy". +- "UE is temporarily not reachable due to power saving" + +**Table 7.2.16-1: Information Elements in an Update Bearer Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------------------------------------------------------------------------------------------------------|----------------|------| +| Cause | M | | Cause | 0 | +| Bearer Contexts | M | This IE shall contain all the bearer contexts included in the corresponding Update Bearer Request. Several IEs with | Bearer Context | 0 | + +| | | | | | +|--------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|---| +| | | this type and instance values shall be included as necessary to represent a list of Bearers. | | | +| Protocol Configuration Options (PCO) | CO | An MME/SGSN shall include the PCO IE if such information was received from the UE.
If the SGW receives this IE, the SGW shall forward it to PGW on the S5/S8 interface. | PCO | 0 | +| Recovery | C | This IE shall be included on the S5/S8, S4/S11 and S2a/S2b interfaces if contacting the peer for the first time | Recovery | 0 | +| MME-FQ-CSID | C | This IE shall be included by MME on S11 and shall be forwarded by SGW on S5/S8 according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| SGW-FQ-CSID | C | This IE shall be included by SGW on S5/S8 according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 1 | +| ePDG-FQ-CSID | C | This IE shall be included by the ePDG on the S2b interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 2 | +| TWAN-FQ-CSID | C | This IE shall be included by the TWAN on the S2a interface according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 3 | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags:
- Direct Tunnel Flag: This flag shall be set to 1 on the S4 interface, if Direct Tunnel is used. | Indication | 0 | +| UE Time Zone | O | This IE is optionally included by the MME on the S11 interface or by the SGSN on the S4 interface. | UE Time Zone | 0 | +| | CO | The SGW shall forward this IE on the S5/S8 interface if the SGW receives it from the MME/SGSN. | | | +| | CO | This IE shall be included by the TWAN on the S2a interface. | | | +| User Location Information (ULI) | CO | This IE shall be included by the MME on the S11 interface or by the SGSN on the S4 interface. The CGI/SAI shall be included by SGSN and the ECGI shall be included by MME.
See NOTE 1. | ULI | 0 | +| | CO | The SGW shall forward this IE on the S5/S8 interface if it receives it from the MME/SGSN. | | | +| TWAN Identifier | CO | This IE shall be included by the TWAN on the S2a interface as specified in 3GPP TS 23.402 [45]. | TWAN Identifier | 0 | +| MME/S4-SGSN's Overload Control Information | O | During an overload condition, the MME/S4-SGSN may include this IE on the S11/S4 interface if the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the MME/S4-SGSN shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the PGW on the S5/S8 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S5/S8 interface if the overload control feature is supported by the SGW and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| Presence Reporting Area Information | CO | The MME/SGSN shall include this IE on S11/S4 if the PGW/PCRF/OCS has requested to start or modify reporting changes of UE presence in a Presence Reporting Area in the corresponding Update Bearer Request message and the MME/SGSN supports such reporting.
The MME/SGSN shall then indicate whether the UE is inside or outside the newly started or modified Presence Reporting Area(s), or indicate that the Presence Reporting Area(s) is inactive.

The SGW shall include this IE on S5/S8 if it receives the | Presence Reporting Area Information | 0 | + +| | | | | | +|------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|----| +| | |

Presence Reporting Area Information from the MME/SGSN.

Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Information. One IE shall be included for each Presence Reporting Area newly started or modified.

| | | +| MME/S4-SGSN Identifier | CO | If the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11), the MME/S4-SGSN shall include this IE on the S11/S4 interface if the PGW has not been updated with the identity of the currently serving MME/S4-SGSN, i.e. if no other message carrying MME/S4-SGSN identity has been sent to the PGW during/after an inter-MME/S4-SGSN intra-SGW mobility procedure. | IP Address | 0 | +| | CO | If the overload control feature is supported by the SGW, the SGW shall forward this IE on the S5/S8 interface. | | | +| TWAN/ePDG's Overload Control Information | O | During an overload condition, the TWAN/ePDG may include this IE over the S2a/S2b interface if the overload control feature is supported by the TWAN/ePDG and is activated for the PLMN to which the PGW belongs (see clause 12.3.11). | Overload Control Information | 2 | +| | | When present, the TWAN/ePDG shall provide only one instance of this IE, representing its overload information. | | | +| WLAN Location Information | CO | The ePDG shall include this IE on the S2b interface if the WLAN Location Information is available. | TWAN Identifier | 1 | +| WLAN Location Timestamp | CO | The ePDG shall include this IE on the S2b interface, if the WLAN Location Timestamp is available. | TWAN Identifier Timestamp | 1 | +| UE Local IP Address | CO | The ePDG shall include this IE on the S2b interface. | IP Address | 0 | +| UE UDP Port | CO | The ePDG shall include this IE on the S2b interface if NAT is detected and UDP encapsulation is used. | Port Number | 0 | +| NBIFOM Container | CO | This IE shall be included on the S11/S4 or S2a/S2b interfaces if the MME/S4-SGSN or the TWAN/ePDG receives a NBIFOM Container from the UE as specified in 3GPP TS 24.161 [73]. The Container Type shall be set to 4. | F-Container | 0 | +| | CO | If the SGW receives a NBIFOM Container IE from the MME/S4-SGSN, the SGW shall forward it to the PGW on the S5/S8 interface. | | | +| UE TCP Port | CO | The ePDG shall include this IE on the S2b interface if NAT is detected and TCP encapsulation is used. | Port Number | 1 | +| PSCell ID | CO | The MME shall include this IE on the S11 interface, if it has received this information from the eNodeB. | PSCell ID | 0 | +| Private Extension | O | This IE may be sent on the S5/S8, S4/S11 and S2a/S2b interfaces. | Private Extension | VS | + +NOTE 1: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator for supporting UEs, or that of the allocated Core Network Operator for non-supporting UEs. As an exception, based on inter-operator roaming/sharing agreement, if the information on whether the UE is a supporting or non-supporting UE is available, the PLMN ID that is communicated to the HPLMN for non-supporting UEs shall be the Common PLMN ID. +In shared networks, when the MME/S4-SGSN and PGW pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI to the PGW, and the Common PLMN ID shall be communicated in SAI/CGI to the PGW, for both supporting and non-supporting UEs. The Core Network Operator PLMN ID (selected by the UE for supporting UEs or allocated by the network for non-supporting UEs) shall be communicated in the TAI, RAI, UCI and the Serving Network. See clause 4.4 of 3GPP TS 23.251 [55]. + +**Table 7.2.16-2: Bearer Context within Update Bearer Response** + +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +|------------------------------------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Cause | M | This IE Indicates if the bearer handling was successful, and if not, gives information on the reason. | Cause | 0 | +| S4-U SGSN F-TEID | C | This IE shall be included on the S4 interface when direct tunnel is not established. See NOTE 1. | F-TEID | 0 | +| S12 RNC F-TEID | C | This IE shall be included on the S4 interface when direct tunnel flag is set to 1. See NOTE 1. | F-TEID | 1 | +| Protocol Configuration Options (PCO) | CO | An MME/SGSN shall include the PCO IE if such information was received from the UE.
If the SGW receives this IE, the SGW shall forward it to PGW on the S5/S8 interface.
This bearer level IE takes precedence over the PCO IE in the message body if they both exist. | PCO | 0 | +| RAN/NAS Cause | CO | If the bearer modification failed, the MME shall include this IE on the S11 interface to indicate the RAN cause and/or the NAS cause of the bearer modification failure, if available and if this information is permitted to be sent to the PGW operator according to MME operator's policy.
If both a RAN cause and a NAS cause are generated, then several IEs with the same type and instance value shall be included to represent a list of causes.
The SGW shall include this IE on the S5/S8 interface if it receives it from the MME. | RAN/NAS Cause | 0 | +| | CO | If the bearer modification failed, the TWAN shall include this IE on the S2a interface to indicate the cause of the bearer modification failure, if available and if this information is permitted to be sent to the PGW operator according to the TWAN operator's policy. When present, the IE shall be encoded as a Diameter or an ESM cause. See NOTE 2. | | | +| | CO | If the bearer modification failed, the ePDG shall include this IE on the S2b interface to indicate the cause of the bearer modification failure, if available and if this information is permitted to be sent to the PGW operator according to the ePDG operator's policy. When present, the IE shall be encoded as a Diameter or an IKEv2 cause. See NOTE 3. | | | +| Extended Protocol Configuration Options (ePCO) | CO | The MME shall include the ePCO IE if such information is received from the UE.

If the SGW receives this IE, the SGW shall forward it to PGW on the S5/S8 interface. | ePCO | 0 | + +NOTE 1: In some scenarios, the SGSN is unable to provide neither the S12 RNC F-TEID nor the S4-U SGSN F-TEID in the Update Bearer Response message, e.g. when Direct Tunnel is used in 3G and the UE is in IDLE mode, for a network requested user location retrieval procedure, the SGSN is unable to provide S12 RNC F-TEID. In those scenarios, the SGSN shall provide EBI(s) without S12 RNC F-TEID(s) and S4-U SGSN F-TEID. The SGW shall be able to handle these bearer context(s). However, in earlier releases this behaviour may not be supported by the SGW and hence for such an SGW, in order to be backward compatible, the SGSN shall provide EBI(s) together with either the S4-U SGSN F-TEID or the S12 RNC F-TEID. + +NOTE 2: The TWAN does not exchange signalling with the 3GPP AAA Server nor with the UE in this procedure. The TWAN may include an internal failure cause for the bearer modification failure. The protocol type used to encode the internal failure cause is implementation specific. + +NOTE 3: The ePDG does not exchange signalling with the 3GPP AAA Server in this procedure. The ePDG may include an internal failure cause for the bearer modification failure. The protocol type used to encode the internal failure cause is implementation specific. + +**Table 7.2.16-3: Overload Control Information within Update Bearer Response** + +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +|----------------------------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | + +## 7.2.17 Delete Bearer Command and Failure Indication + +### 7.2.17.1 Delete Bearer Command + +A Delete Bearer Command message shall be sent on the S11 interface by the MME to the SGW and on the S5/S8 interface by the SGW to the PGW as a part of the eNodeB requested bearer release or MME-Initiated Dedicated Bearer Deactivation procedure. + +The message shall also be sent on the S4 interface by the SGSN to the SGW and on the S5/S8 interface by the SGW to the PGW as part of the MS and SGSN Initiated Bearer Deactivation procedure using S4. + +**Table 7.2.17.1-1: Information Elements in Delete Bearer Command** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------| +| Bearer Contexts | M | This IE shall be used to indicate dedicated bearers. When used, at least one dedicated bearer shall be present. Several IEs with this type and instance values shall be included as necessary to represent a list of Bearers | Bearer Context | 0 | +| User Location Information (ULI) | CO | This IE shall be included by the MME on the S11 interface or by the SGSN on the S4 interface. The CGI/SAI shall be included by SGSN and the ECGI shall be included by MME.
The SGW shall forward this IE on the S5/S8 interface if it receives it from the MME/SGSN.
See NOTE 1. | ULI | 0 | +| ULI Timestamp | CO | This IE shall be included on the S4/S11 interface if the ULI IE is present. It indicates the time when the User Location Information was acquired.
The SGW shall include this IE on S5/S8 if the SGW receives it from the MME/SGSN. | ULI Timestamp | 0 | +| UE Time Zone | CO | This IE shall be included, if available, by the MME on the S11 interface or by the SGSN on the S4 interface. | UE Time Zone | 0 | +| | CO | The SGW shall forward this IE on the S5/S8 interface if the SGW receives it from the MME/SGSN. | | | +| MME/S4-SGSN's Overload Control Information | O | During an overload condition, the MME/S4-SGSN may include this IE on the S11/S4 interface if the overload control feature is supported by the MME/S4-SGSN and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the MME/S4-SGSN shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 0 | + +| | | | | | +|------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----| +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the PGW on the S5/S8 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S5/S8 interface if the overload control feature is supported by the SGW and is activated for the PLMN to which the PGW belongs (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| Sender F-TEID for Control Plane | CO | The SGW shall include this IE on the S5/S8 interfaces and set it to the last value sent to the PGW.

If the Sender F-TEID for Control Plane is received, the PGW shall only handle the Delete Bearer Command message if the Sender F-TEID for Control Plane in this message is the same as the last Sender F-TEID for Control Plane received on the given interface. | F-TEID | 0 | +| Secondary RAT Usage Data Report | CO | If the PLMN has configured secondary RAT usage reporting, the MME shall include this IE on the S11 interface if it has received Secondary RAT usage data in an MME Initiated Dedicated Bearer Deactivation procedure.
Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | Secondary RAT Usage Data Report | 0 | +| | O | The SGW shall forward this IE on the S5/S8 interface if it receives the Secondary RAT Usage Data Report with the IRPGW flag set to "1" from MME.
Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | | | +| PSCell ID | CO | The MME shall include this IE on the S11 interface, if it has received this information from the eNodeB. | PSCell ID | 0 | +| Private Extension | O | | Private Extension | VS | + +NOTE 1: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator for supporting UEs, or that of the allocated Core Network Operator for non-supporting UEs. As an exception, based on inter-operator roaming/sharing agreement, if the information on whether the UE is a supporting or non-supporting UE is available, the PLMN ID that is communicated to the HPLMN for non-supporting UEs shall be the Common PLMN ID. +In shared networks, when the MME/S4-SGSN and PGW pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI to the PGW, and the Common PLMN ID shall be communicated in SAI/CGI to the PGW, for both supporting and non-supporting UEs. The Core Network Operator PLMN ID (selected by the UE for supporting UEs or allocated by the network for non-supporting UEs) shall be communicated in the TAI, RAI, UCI and the Serving Network. +See clause 4.4 of 3GPP TS 23.251 [55]. + +**Table 7.2.17.1-2: Bearer Context within Delete Bearer Command** + +| Octet 1 | | Bearer Context IE Type = 93 (decimal) | | | +|-----------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octet 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Bearer Flags | CO | Applicable flags are:
- VB (Voice Bearer) indicator shall be set to indicate a voice bearer for PS-to-CS (v)SRVCC handover.
- Vind (vSRVCC indicator) indicator shall be set to indicate a video bearer for PS-to-CS vSRVCC handover. | Bearer Flags | 0 | +| RAN/NAS Release Cause | CO | The MME shall include this IE on the S11 interface to indicate the RAN release cause and/or NAS release cause to release the bearer, if available and this information is permitted to be sent to the PGW operator according to MME operator's policy.
If both a RAN release cause and a NAS release cause are generated, then several IEs with the same type and instance value shall be included to represent a list of causes.
The SGW shall include this IE on the S5/S8 interface if it receives it from the MME. | RAN/NAS Cause | 0 | + +**Table 7.2.17.1-3: Overload Control Information within Delete Bearer Command** + +| Octet 1 | | Overload Control Information IE Type = 180 (decimal) | | | +|----------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octet 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | + +## 7.2.17.2 Delete Bearer Failure Indication + +A Delete Bearer Failure Indication shall be sent on the S5/S8 interface by the PGW to the SGW and on the S11 interface by the SGW to the MME as part of failure of eNodeB requested bearer release or MME Initiated Dedicated Bearer Deactivation procedure. + +The message shall also be sent on the S5/S8 interface by the PGW to the SGW and on the S4 interface by the SGW to the SGSN as part of failure of MS and SGSN Initiated Bearer Deactivation procedure using S4. + +This message shall be sent back if none of the bearers (not even a single one) included in the Delete Bearer Command message could be deleted. + +The Cause IE indicates that the EPS bearer has not been deleted in the PGW. + +When the SGW receives a Delete Bearer Failure Indication message from the PGW with the TEID set to zero in the GTPv2 header and the Cause IE is set to "Context Not Found", which implies that the PDN connection does not exist in the PGW, the SGW may send a Delete Bearer Request message to delete the PDN connection towards the MME/SGSN after sending the Delete Bearer Failure Indication message. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Context not found" + +**Table 7.2.17.2-1: Information Elements in a Delete Bearer Failure Indication** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------| +| Cause | M | | Cause | 0 | +| Bearer Context | M | This IE shall contain the list of failed bearers. See clause 6.1.1 "Presence requirements of Information Elements".
Several IEs with the same type and instance value may be included as necessary to represent a list of failed bearers. | Bearer Context | 0 | +| Recovery | C | This IE shall be included If contacting the peer for the first time. | Recovery | 0 | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - Associate OCI with PGW node's identity: The PGW shall set this flag to 1 on the S5/S8 interface or S2a/S2b interface if it has included the "PGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the HSS or DNS during the PGW selection) of the serving PGW. The SGW shall set this flag on the S11/S4 interface if it supports the overload control feature and if the flag is set on the S5/S8 interface.
  • - Associate OCI with SGW node's identity: The SGW shall set this flag to 1 on the S11/S4 interface if it has included the "SGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW.
| Indication | 0 | +| PGW's Overload Control Information | O | During an overload condition, the PGW may include this IE on the S5/S8, if the overload control feature is supported by the PGW and is activated for the PLMN to which the access network node, i.e. MME/S4-SGSN for 3GPP access based network belongs (see clause 12.3.11).

When present, the PGW shall provide
  • - node level overload control, in one instance of this IE; and/or
  • - APN level overload control, in one or more instances of this IE, up to maximum of 10, with the same type and instance value, each representing the overload information for a list of APN(s).
See NOTE 1, NOTE 2. | Overload Control Information | 0 | +| | CO | If the SGW receives this IE and if it supports the overload control feature, it shall forward it to the MME/S4-SGSN on the S11/S4 interface. | | | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S11/S4 interface if the overload control feature is supported by the SGW and is activated in the network (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 1 | +| Private Extension | O | | Private Extension | VS | + +NOTE 1: The receiver, supporting the APN level overload information for the maximum of 10 APNs, shall handle the APN level overload information for the first 10 APNs and ignore any more APN level overload information. + +NOTE 2: The APN level overload information, provided within and across different instances of the "PGW's Overload Control Information" IE(s) shall be limited to 10 different APNs. + +**Table 7.2.17.2-2: Bearer Context within Delete Bearer Failure Indication** + +| | | | | | +|-----------------------------|---------------------------------------|-------------------------------------------------------------------------------|----------------|-------------| +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | See clause 6.1.1 "Presence requirements of Information Elements". | EBI | 0 | +| Cause | M | This IE shall indicate the reason of the unsuccessful handling of the bearer. | Cause | 0 | + +**Table 7.2.17-3: Overload Control Information within Delete Bearer Failure Indication** + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clauses 12.3.5.1.2.3 and 12.3.5.1.2.4 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | +| List of Access Point Name (APN) | CO | The IE may (only) be present in the "PGW's Overload Control Information" IE.
For indicating the APN level overload, the PGW shall include one or more instances of this IE, up to maximum of 10, with the same type and instance value, representing a list of APN(s) (sharing the same "Overload Reduction Metric" and "Period of Validity").
See NOTE 1. | APN | 0 | +| NOTE 1: If more than 10 occurrences of APNs are received within one instance of the Overload Control Information IE, the receiver shall treat it as a protocol error and ignore the entire Overload Control Information IE instance. | | | | | + +## 7.2.18 Create Indirect Data Forwarding Tunnel Request + +The Create Indirect Data Forwarding Tunnel Request message shall be sent on the S11/S4 interface by the MME/SGSN to the SGW as part of the Handover procedures or TAU/RAU procedure with Serving GW change and data forwarding as specified in clause 5.3.3.1A of 3GPP TS 23.401 [3]. + +Table 7.2.18-1 specifies the presence requirements and the conditions of the IEs in the message. + +**Table 7.2.18-1: Information Elements in a Create Indirect Data Forwarding Tunnel Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|---------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| IMSI | C | This IE shall be included by the MME/SGSN if the SGW that the MME/SGSN selects for indirect data forwarding is different from the SGW already in use for the UE as the anchor point except for the case:
- If the UE is emergency or RLOS attached and the UE is UICCCless

When the IMSI is included in the message, it is not used as an identifier
- if UE is emergency or RLOS attached but IMSI is not authenticated.

See NOTE1. | IMSI | 0 | +| ME Identity (MEI) | C | This IE shall be included by the MME/SGSN if the SGW that the MME/SGSN selects for indirect data forwarding is different from the SGW already in use for the UE as the anchor point and if one of the following condition is satisfied:
- If the UE is emergency or RLOS attached and the UE is UICCCless; or

- If the UE is emergency or RLOS attached and the IMSI is not authenticated | MEI | 0 | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
- Unauthenticated IMSI: This flag shall be set to 1 if the IMSI present in the message is not authenticated and is for an emergency or RLOS attached UE.

- Indirect Data Forwarding with UPF Indication: This flag shall be set to 1 if indirect data forwarding is required for user plane routes from UPF in the 5GS to EPS handover procedure or to UPF in the EPS to 5GS handover procedure. This flag shall not be set to 1 if indirect data forwarding is used for other mobility procedures. See NOTE 2. | Indication | 0 | +| Sender F-TEID for Control Plane | C | This IE shall be included by the MME/SGSN if the SGW that the MME/SGSN selects for indirect data forwarding is different from the SGW already in use for the UE as the anchor point.
See NOTE1. | F-TEID | 0 | +| Bearer Contexts | M | Several IEs with this type and instance value may be included as necessary to represent a list of Bearers | Bearer Context | 0 | +| Recovery | CO | This IE shall be included if contacting the peer for the first time. | Recovery | 0 | +| Private Extension | O | | Private Extension | VS | + +NOTE 1: The SGW which is hosting the UE's bearer(s) is considered as the (local) anchor point. Unlike the PGW, the SGW may change due to mobility between eNodeBs, or E-UTRAN and GERAN/UTRAN supported with S4 based architecture. In these cases the new SGW where the UE's bearer(s) are moved, becomes the new local anchor point. A source MME/SGSN may select an SGW for indirect data forwarding which is different than the source (anchor) SGW. Similarly, a target MME/SGSN may select an SGW for indirect data forwarding which is different than the target (anchor) SGW. + +NOTE 2: When indirect data forwarding for user plane routes from/to UPF is indicated, the SGW may select subnet(s) other than S1-u to create indirect data forwarding tunnel, e.g. based on local configuration. + +**Table 7.2.18-2: Bearer Context within Create Indirect Data Forwarding Tunnel Request** + +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +|----------------|---------------------------------------|---------------------|---------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information | P | Condition / Comment | IE Type | Ins. | + +| elements | | | | | +|---------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|---| +| EPS Bearer ID | M | | EBI | 0 | +| eNodeB F-TEID for DL data forwarding | C | Target eNodeB F-TEID.
This IE shall be present in the message sent from the target MME to the SGW selected by the target MME for indirect data forwarding, or shall be included in the message sent from the source SGSN/MME to the SGW selected by the source MME for indirect data forwarding if the eNodeB F-TEID for DL data forwarding is included in the Forward Relocation Response message. | F-TEID | 0 | +| | CO | Target eNodeB F-TEID.
This IE shall be present in the message sent from the target MME to the SGW selected by the target MME for indirect data forwarding of the DL data buffered in the old SGW during a TAU with SGW change procedure and data forwarding, without Control Plane CIOt EPS optimisation, as specified in clause 5.3.3.1A of 3GPP TS 23.401 [3]. | | | +| SGW/UPF F-TEID for DL data forwarding | C | Target SGW F-TEID
This IE shall be present in the message sent from the source MME/SGSN to the SGW selected by the source MME for indirect data forwarding if SGW F-TEID for DL data forwarding is included in the Forward Relocation Response message. This F-TEID is assigned by the SGW that the target MME/SGSN selects for indirect data forwarding. | F-TEID | 1 | +| | CO | Target UPF F-TEID
This IE shall be present in the message sent from the source MME to the SGW selected by the source MME for indirect data forwarding if SGW/UPF F-TEID for DL data forwarding is included in the Forward Relocation Response message. This IE contains the target V-UPF F-TEID in home routed roaming scenario, or contains the PGW-U+UPF F-TEID in non-roaming or local breakout scenario. | | | +| SGSN F-TEID for DL data forwarding | C | Target SGSN F-TEID
This IE shall be present in the message sent from the target SGSN to the SGW selected by the target SGSN for indirect data forwarding in E-UTRAN to GERAN/UTRAN inter RAT handover with SGW relocation procedure, or shall be included in the message sent from the source MME to the SGW selected by the source MME for indirect data forwarding if the SGSN F-TEID for DL data forwarding is included in the Forwarding Relocation Response message. | F-TEID | 2 | +| | CO | This IE shall also be present in the message sent from the source MME to the SGW selected by the source MME for indirect data forwarding if the SGSN Address for User Traffic and the Tunnel Endpoint Identifier Data II are included in the GTPv1 Forward Relocation Response message as specified in D.3.7 of 3GPP TS 23.401 [3].

This IE shall also be present, when Direct Tunnel is not used, in the message sent from the target SGSN to the SGW selected by the target SGSN for indirect data forwarding of the DL data buffered in the old SGW during a RAU with SGW change procedure and data forwarding, as specified in clause 5.3.3.1A of 3GPP TS 23.401 [3]. | | | +| RNC F-TEID for DL data forwarding | C | Target RNC F-TEID
This IE shall be present in the message sent from the target SGSN to the SGW selected by the target SGSN for indirect data forwarding in E-UTRAN to UTRAN inter RAT handover with SGW relocation procedure, or shall be included in the message sent from the source MME to the SGW selected by the source MME for indirect data forwarding if the RNC F-TEID for DL data forwarding is included in the Forwarding Relocation Response message. | F-TEID | 3 | +| | CO | This IE shall also be present in the message sent from the source MME to the SGW selected by the source MME for indirect data forwarding if the RNC IP address and TEID | | | + +| | | | | | +|--------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|---| +| | | are included in the RAB Setup Information and/or the Additional RAB Setup Information in the GTPv1 Forwarding Relocation Response message as specified in D.3.3 of 3GPP TS 23.401 [3].

This IE shall be present, when Direct Tunnel is used, in the message sent from the target SGSN to the SGW selected by the target SGSN for indirect data forwarding of the DL data buffered in the old SGW during a RAU with SGW change procedure and data forwarding as specified in clause 5.3.3.1A of 3GPP TS 23.401 [3]. | | | +| eNodeB F-TEID for UL data forwarding | O | Target eNodeB F-TEID.
If available this IE may be present in the message, which is sent during the intra-EUTRAN HO from the target MME to the SGW selected by the target MME for indirect data forwarding, or may be included in the message sent from the source MME to the SGW selected by the source MME for indirect data forwarding if the eNodeB F-TEID for data UL forwarding is included in the Forward Relocation Response message. | F-TEID | 4 | +| SGW F-TEID for UL data forwarding | O | Target SGW F-TEID
If available this IE may be present in the message, which is sent during the intra-EUTRAN HO from the source MME to the SGW selected by the source MME for indirect data forwarding if SGW F-TEID for UL data forwarding is included in the Forward Relocation Response message.
This F-TEID is assigned by the SGW that the target MME selects for indirect data forwarding. | F-TEID | 5 | +| MME F-TEID for DL data forwarding | CO | Target MME S11-U F-TEID
This IE shall be present in the message sent from the target MME to the SGW selected by the target MME for indirect data forwarding, during a TAU procedure with SGW change and data forwarding, with Control Plane CIoT EPS optimisation, as specified in clause 5.3.3.1A of 3GPP TS 23.401 [3]. | F-TEID | 6 | + +## 7.2.19 Create Indirect Data Forwarding Tunnel Response + +A Create Indirect Data Forwarding Tunnel Response message shall be sent by the SGW to the MME/SGSN as a response to a Create Indirect Data Forwarding Tunnel Request message. + +Table 7.2.19-1 specifies the presence requirements and the conditions of the IEs in the message. + +The Cause value indicates if the Indirect Data Forwarding Tunnels has been created in the SGW or not. No Indirect Data Forwarding Tunnels have been created in the SGW if the Cause differs from "Request accepted" or "Request accepted partially". Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Request accepted". +- "Request accepted partially". +- "Data forwarding not supported". +- "Context not found". + +**Table 7.2.19-1: Information Elements in a Create Indirect Data Forwarding Tunnel Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|---------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Sender F-TEID for Control Plane | C | This IE shall be included by an SGW if the SGW receives a Sender F-TEID for Control Plane IE from an MME/SGSN in a Create Indirect Data Forwarding Tunnel Request message.
See also NOTE 1 in Table 7.2.18-1. | F-TEID | 0 | +| Bearer Contexts | M | Several IEs with this type and instance value may be included as necessary to represent a list of Bearers | Bearer Context | 0 | +| Recovery | CO | This IE shall be included if contacting the peer for the first time | Recovery | 0 | +| Private Extension | O | | Private Extension | VS | + +**Table 7.2.19-2: Bearer Context within Create Indirect Data Forwarding Tunnel Response** + +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Cause | M | This IE shall indicate if the tunnel setup was successful, and if not, gives information on the reason. | Cause | 0 | +| S1-U SGW F-TEID for DL data forwarding | C | This IE shall be included in the response sent from the SGW selected by the source MME for indirect data forwarding to the source MME. See NOTE 3. | F-TEID | 0 | +| S12 SGW F-TEID for DL data forwarding | C | S12 usage only.
This IE shall be included in the response sent from the SGW selected by the source SGSN for indirect data forwarding to the source SGSN. See NOTE 3. | F-TEID | 1 | +| S4-U SGW F-TEID for DL data forwarding | C | S4-U usage only.
This IE shall be included in the response sent from the SGW selected by the source SGSN for indirect data forwarding to the source SGSN. See NOTE 3. | F-TEID | 2 | +| SGW F-TEID for DL data forwarding | C | This IE shall be included in the response message sent from the SGW selected by the target MME/SGSN for indirect data forwarding to the target MME/SGSN. See NOTE 3. | F-TEID | 3 | +| S1-U SGW F-TEID for UL data forwarding | O | If available this IE may be included in the response sent during the intra-EUTRAN HO from the SGW selected by the source MME for indirect data forwarding to the source MME. See NOTE 4. | F-TEID | 4 | +| SGW F-TEID for UL data forwarding | O | If available this IE may be included in the response message sent during the intra-EUTRAN HO from the SGW selected by the target MME for indirect data forwarding to the target MME. See NOTE 4. | F-TEID | 5 | +| NOTE 1: For DL data forwarding if the SGW does not have enough information to decide which of the F-TEID instance from S1-U, S12, S4-U and SGW to include in the message, it may include all of them. | | | | | +| NOTE 2: For UL data forwarding if the SGW does not have enough information to decide which of the F-TEID instance from S1-U and SGW to include in the message, it may include both of them. | | | | | +| NOTE 3: For DL data forwarding the SGW shall set the interface type in the F-TEID to 23, i.e "SGW GTP-U interface for DL data forwarding" for S1-U/S4-U/S12/SGW. | | | | | +| NOTE 4: For UL data forwarding the SGW shall set the interface type in the F-TEID to 28, i.e "SGW GTP-U interface for UL data forwarding" for S1-U/SGW. | | | | | + +## 7.2.20 Void + +## 7.2.21 Release Access Bearers Request + +The Release Access Bearers Request message shall be sent on the S11 interface by the MME to the SGW as part of the S1 release procedure and eNodeB initiated Connection Suspend procedure. + +It may also be sent on the S11 interface by the MME to the SGW as part of the Establishment of S1-U bearer during Data Transport in Control Plane CIoT EPS optimisation procedure (see clause 5.3.4B.4 of 3GPP TS 23.401 [3]). + +NOTE: The S1 release procedure is also used to release the S11-U bearers for the Control Plane CIoT EPS optimisation, except in the case of data buffering in the MME. + +The message shall also be sent on the S4 interface by the SGSN to the SGW as part of the procedures: + +- RAB release using S4 +- Iu Release using S4 +- READY to STANDBY transition within the network + +**Table 7.2.21-1: Information Element in Release Access Bearers Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|------| +| List of RABs | C | Shall be present on S4 interface when this message is used to release a subset of all active RABs according to the RAB release procedure.
Several IEs with this type and instance values shall be included as necessary to represent a list of RABs to be released. | EBI | 0 | +| Originating Node | CO | This IE shall be sent on S11 interface, if ISR is active in the MME.
This IE shall be sent on S4 interface, if ISR is active in the SGSN
See NOTE 1. | Node Type | 0 | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
- Abnormal Release of Radio Link: This flag shall be set to 1 on the S11 interface
- if the S1 release is due to an abnormal release of the radio link, e.g. when the MME receives UE CONTEXT RELEASE REQUEST with the cause value set to Radio Connection With UE Lost, or
- if the MME performs DL data buffering and the operator specified policy/configuration conditions for triggering the PGW pause of charging are met (e.g. number/fraction of packets/bytes dropped at MME in downlink) as specified in clause 5.3.6A of 3GPP TS23.401 [3]. | Indication | 0 | +| Secondary RAT Usage Data Report | CO | If the PLMN has configured secondary RAT usage reporting, the MME shall include this IE on the S11 interface if it has received Secondary RAT usage data from eNodeB in a Connection Suspend, or S1 release procedure.
The MME shall set the IRPGW flag to "0", to indicate that the IE shall not be forwarded to the PGW.
Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | Secondary RAT Usage Data Report | 0 | +| PSCell ID | CO | The MME shall include this IE on the S11 interface, if it has received this information from the eNodeB. | PSCell ID | 0 | +| Private Extension | O | | Private Extension | VS | +| NOTE 1: If SGW has the S1-U F-TEIDs for the UE, but the Originating Node IE contains value "SGSN", then the SGW shall not release the user plane and shall send a positive response to the SGSN.

If SGW has the S12 RNC TEIDs or S4-U SGSN TEIDs for the UE, but the Originating Node IE contains value "MME", then the SGW shall not release the user plane and shall send a positive response to the MME. | | | | | + +## 7.2.22 Release Access Bearers Response + +The Release Access Bearers Response message is sent on the S11 interface by the SGW to the MME as part of the S1 release procedure and eNodeB initiated Connection Suspend procedure. + +It may also be sent on the S11 interface by the SGW to the MME as part of the Establishment of S1-U bearer during Data Transport in Control Plane CIoT EPS optimisation procedure (see clause 5.3.4B.4 of 3GPP TS 23.401 [3]). + +NOTE: The S1 release procedure is also used to release S11-U bearers for the Control Plane CIoT EPS optimisation, except in the case of data buffering in the MME. + +The message shall also be sent on the S4 interface by the SGW to the SGSN as part of the procedures: + +- RAB release using S4 + +- Iu Release using S4 +- READY to STANDBY transition within the network + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Request accepted". +- "Request accepted partially". +- "Context not found". + +**Table 7.2.22-1: Information Element in Release Access Bearers Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-------------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------| +| Cause | M | | Cause | 0 | +| Recovery | O | This IE shall be included if contacting the peer for the first time | Recovery | 0 | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - Associate OCI with SGW node's identity: The SGW shall set this flag to 1 on the S11/S4 interface if it has included the "SGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW.
| Indication | 0 | +| SGW's node level Load Control Information | O | The SGW may include this IE, over the S11/S4 interface if the load control feature is supported by the SGW and is activated in the network (see clause 12.2.6).

When present, the SGW shall provide only one instance of this IE, representing its node level load information. | Load Control Information | 0 | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S11/S4 interface if the overload control feature is supported by the SGW and is activated in the network (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 0 | +| Private Extension | O | | Private Extension | VS | + +**Table 7.2.22-2: Load Control Information within Release Access Bearers Response** + +| Octet 1 | Load Control Information IE Type = 181 (decimal) | | | | +|------------------------------|--------------------------------------------------|------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Load Control Sequence Number | M | See clause 12.2.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Load Metric | M | See clause 12.2.5.1.2.2 for the description and use of this parameter. | Metric | 0 | + +**Table 7.2.22-3: Overload Control Information within Release Access Bearers Response** + +| | | | | | +|----------------------------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | + +## 7.2.23 Stop Paging Indication + +A Stop Paging Indication message shall be sent on the S11/S4 interface by the SGW to the MME/SGSN as a part of the network triggered service request procedure. + +Table 7.2.23-1 specifies the presence of the IEs in the message. + +**Table 7.2.23-1: Information Elements in a Stop Paging Indication** + +| | | | | | +|-----------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------| +| Information elements | P | Condition / Comment | IE Type | Ins. | +| IMSI | CO | This IE shall be included on the S11/S4 interface when the Stop Paging Indication message is sent to the restarted CN node (or another node in the same pool) as part of the network triggered service restoration procedure with ISR (see 3GPP TS 23.007 [17]). | IMSI | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.2.24 Modify Access Bearers Request + +The direction of this message shall be from MME to SGW (see Table 6.1-1). + +If both the SGW and the MME support the MABR feature (see clause 8.83), an MME may send a Modify Access Bearer Request message on the S11 interface to an SGW as part of the following procedures: + +- UE triggered Service Request if there is no suspended bearer for that UE, +- S1-based Handover without SGW relocation, +- X2-based handover without SGW relocation, +- Inter-MME E-UTRAN Tracking Area Update without SGW Change, +- Intra-MME E-UTRAN Tracking Area Update without SGW Change with Active Flag; +- E-UTRAN Initiated E-RAB modification procedure +- Mobile Originated Data transport in Control Plane CIoT EPS optimisation with P-GW connectivity +- Mobile Terminated Data Transport in Control Plane CIoT EPS optimisation with P-GW connectivity +- Connection Resume procedure (see clause 5.3.5A of 3GPP TS 23.401 [3]) +- Establishment of S1-U bearer during Data Transport in Control Plane CIoT EPS optimisation procedure (see clause 5.3.4B.4 of 3GPP TS 23.401 [3]). + +if all the following conditions are fulfilled: + +- the RAT type has not changed; + +- the Serving Network has not changed; +- the MME does not need to report a H(e)NB local IP address and UDP port number information change; +- the MME does not need to send UE's location and/or User CSG information or/and UE Time Zone and/or Presence Reporting Area information to the PDN GW; +- the MME does not need to send an MME-FQ-CSID as per the requirements specified in 3GPP TS 23.007 [17]; +- ISR is not activated, if the Modify Access Bearers Request is sent as part of a UE triggered Service Request; +- ISR was not activated in the old MME which is indicated by the ISRAU flag in the Context Response, if the Modify Access Bearers Request is sent as part of an Inter-MME E-UTRAN Tracking Area Update without SGW change. +- the support of ePCO has not be changed during inter MME mobility. +- Secondary RAT Usage Data Report(s) is not required to be forwarded to the PGW(s) for any active PDN Connections. + +The Modify Access Bearers Request message shall include all the bearer contexts of all the PDN connections of the UE. + +Support of this message is optional for the MME and SGW. + +**Table 7.2.24-1: Information Elements in a Modify Access Bearers Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|------| +| Indication Flags | C | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - ISRAI: This flag shall be set to 1 if ISR is established between the MME and the S4 SGSN for an S1-based Handover without SGW relocation and for an X2-based Handover without SGW relocation.
  • - Change F-TEID support Indication: This flag shall be set to 1 for an IDLE state UE initiated TAU procedure to allow the SGW changing the GTP-U F-TEID.
  • - S11-U Tunnel Flag: this flag shall be set to 1 on the S11 interface if user data is transported in NAS signalling.
| Indication | 0 | +| Sender F-TEID for Control Plane | C | The new MME shall include this IE on the S11 interface for a TAU/Handover with MME change and without any SGW change.
If the SGW receives this IE and if it finds that its value is the same as the earlier received value of this IE for this UE, it should interpret this to mean that the MME has not changed. | F-TEID | 0 | +| Delay Downlink Packet Notification Request | C | This IE shall be sent for a UE triggered Service Request and UE initiated Connection Resume procedures. It shall contain the delay the SGW shall apply between receiving downlink data and sending Downlink Data Notification for all UEs served by that MME (see clause 5.3.4.2 of 3GPP TS 23.401 [3]). | Delay Value | 0 | + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----| +| Bearer Contexts to be modified | C | Several IEs with the same type and instance value may be included as necessary to represent a list of Bearers to be modified.
See NOTE 1. | Bearer Context | 0 | +| Bearer Contexts to be removed | C | This IE shall be included for the TAU/Handover, UE initiated Connection Resume and Service Request procedures where any of the bearers existing before the TAU/Handover procedure, UE initiated Connection Resume and Service Request procedures will be deactivated as consequence of the TAU/Handover procedure, UE initiated Connection Resume and Service Request procedures.
For the Service Request and UE initiated Connection Resume procedures, all unaccepted bearers for this UE shall be included.
For each of those bearers, an IE with the same type and instance value, shall be included.
See NOTE 1. | Bearer Context | 1 | +| Recovery | C | This IE shall be included if contacting the peer for the first time. | Recovery | 0 | +| Secondary RAT Usage Data Report | CO | If the PLMN has configured secondary RAT usage reporting, and if the Secondary RAT usage data is not intended for the PGW(s) for any of active PDN Connections, the MME shall include this IE on the S11 interface if it has received Secondary RAT usage data from eNodeB in an X2-based handover without Serving GW relocation, S1-based handover without MME or SGW relocation, or E-UTRAN initiated E-RAB modification procedure.
The MME shall also include this IE on the S11 interface if it has received a Secondary RAT Usage Data Report from the source MME in an S1-based handover with MME relocation but without SGW relocation.
The MME shall set the IRPGW flag to "0", to indicate that the IE shall not be forwarded to the PGW.
Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | Secondary RAT Usage Data Report | 0 | +| PSCell ID | CO | The MME shall include this IE on the S11 interface, if it has received this information from the eNodeB. | PSCell ID | 0 | +| Private Extension | O | | Private Extension | VS | +| NOTE 1: The Bearer Context to be modified IE and Bearer Context to be removed IE, together, shall contain all the bearers of all the existing PDN connections of the UE, with each bearer appearing in only one of these IEs. See clause 14 for the cases when a Bearer Context mismatch is detected. | | | | | + +**Table 7.2.24-2: Bearer Context to be modified within Modify Access Bearers Request** + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------| +| Octets 1 | Bearer Context IE Type = 93 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octets 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | See NOTE 1. | EBI | 0 | +| S1-U eNodeB F-TEID | C | This IE shall be sent if S1-U is being used for:
  • - an UE triggered Service Request;
  • - S1-based Handover without SGW relocation;
  • - X2-based handover without SGW relocation;
  • - in S1-U GTP-U tunnel setup procedure during an Inter-MME E-UTRAN Tracking Area Update without SGW Change procedure or Intra-MME E-UTRAN Tracking Area Update without SGW Change procedure with Active Flag (see 3GPP TS 24.301 [23]);
  • - an E-UTRAN Initiated E-RAB modification procedure;
  • - an UE initiated Connection Resume;
  • - the Establishment of S1-U bearer during Data Transport in Control Plane CLoT EPS optimisation procedure. See NOTE 2.
If an MME is aware that the eNodeB supports both IP address types, the MME shall send both IP addresses within an F-TEID IE. If only one IP address is included, then the SGW shall assume that the eNodeB does not support the other IP address type. | F-TEID | 0 | +| S11-U MME F-TEID | CO | This IE shall be sent on the S11 interface if S11-U is being used, i.e. for the following procedures:
  • - Mobile Originated Data transport in Control Plane CLoT EPS optimisation with P-GW connectivity
  • - Mobile Terminated Data Transport in Control Plane CLoT EPS optimisation with P-GW connectivity
| F-TEID | 1 | +| NOTE 1: If only EPS Bearer ID IE is included in the Bearer Context to be modified IE during the TAU without SGW change procedure, the SGW shall remove the stored eNodeB/MME userplane F-TEID locally. | | | | | +| NOTE 2: In the Establishment of S1-U bearer during Data Transport in Control Plane CLoT EPS optimisation procedure (see clause 5.3.4B.4 of 3GPP TS 23.401 [3]), the MME may send a Modify Access Bearers Request to the SGW, to request the establishment of the S1-U bearers, without sending a prior Release Access Bearers Request to tear down the S11-U bearers. In this case, the MME shall encode the bearers being switched from S11-U to S1-U in the Bearer Contexts to be modified IE and the SGW shall release the S11-U bearers upon receipt of the Modify Access Bearers Request requesting the establishment of the S1-U bearers. | | | | | + +**Table 7.2.24-3: Bearer Context to be removed within Modify Access Bearers Request** + +| | | | | | +|-----------------------------|---------------------------------------|----------------------------|----------------|-------------| +| Octets 1 | Bearer Context IE Type = 93 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octets 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | + +## 7.2.25 Modify Access Bearers Response + +If an SGW supports the MABR feature (see clause 8.83), the SGW shall send a Modify Access Bearers Response message on the S11 interface to an MME as a response to a Modify Access Bearers Request message. + +If handling of all default bearers to be modified fails, then Cause at the message level shall be a failure cause. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Request accepted". +- "Request accepted partially". +- "Context not found". +- "Service not supported". +- "Modifications not limited to S1-U bearers" + +The SGW shall send the cause value "Modifications not limited to S1-U bearers" if + +- it can not serve the MME Request without corresponding S5/S8 signalling other than to unpause charging in the PGW, or without corresponding Gxc signalling when PMIP is used over the S5/S8 interface, or +- if there are suspended non-GBR bearers for that UE in the SGW (NOTE 3). + +Upon receipt of that cause value, the MME shall repeat its request using Modify Bearer Request message per PDN connection. + +NOTE 1: This cause value is introduced for forward compatibility between an MME implementing this version of the specification and an SGW implementing a more recent version requiring the SGW to send S5/S8 signalling. + +NOTE 2: During an Inter-MME Intra-SGW handover/TAU, if the SGW, PGW and the old MME support the partial failure handling feature but the new MME doesn't, the SGW needs to inform the PGW about the change of FQ-CSID (see clause 16.2.5 of 3GPP TS 23.007 [17]). If the SGW receives a Modify Access Bearers Request from the new MME, it can force the MME to send individual Modify Bearer Request message per PDN connection by returning the cause value "Modifications not limited to S1-U bearers". + +NOTE 3: There may be some suspended non-GBR bearers in the SGW during an Inter-MME Intra-SGW Tracking Area Update without SGW Change when the UE is coming back to E-UTRAN via a different MME than the MME serving the UE before the CSFB or SRVCC call. + +**Table 7.2.25-1: Information Elements in a Modify Access Bearers Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-------------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------| +| Cause | M | | Cause | 0 | +| Bearer Contexts modified | C | EPS bearers corresponding to Bearer Contexts to be modified that were sent in Modify Access Bearers Request message. Several IEs with the same type and instance value may be included as necessary to represent a list of the Bearers which are modified. | Bearer Context | 0 | +| Bearer Contexts marked for removal | C | EPS bearers corresponding to Bearer Contexts to be removed that were sent in the Modify Access Bearers Request message. Shall be included if request message contained Bearer Contexts to be removed.
For each of those bearers an IE with the same type and instance value shall be included. | Bearer Context | 1 | +| Recovery | C | This IE shall be included if contacting the peer for the first time. | Recovery | 0 | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - Associate OCI with SGW node's identity: The SGW shall set this flag to 1 on the S11/S4 interface if it has included the "SGW's Overload Control Information" and if this information is to be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW.
| Indication | 0 | +| SGW's node level Load Control Information | O | The SGW may include this IE, over the S11/S4 interface if the load control feature is supported by the SGW and is activated in the network (see clause 12.2.6).

When present, the SGW shall provide only one instance of this IE, representing its node level load information. | Load Control Information | 0 | +| SGW's Overload Control Information | O | During an overload condition, the SGW may include this IE over the S11/S4 interface if the overload control feature is supported by the SGW and is activated in the network (see clause 12.3.11).

When present, the SGW shall provide only one instance of this IE, representing its overload information. | Overload Control Information | 0 | +| Private Extension | O | | Private Extension | VS | + +**Table 7.2.25-2: Bearer Context modified within Modify Access Bearers Response** + +| Octets 1 | | Bearer Context IE Type = 93 (decimal) | | | +|----------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|------| +| Octets 2 and 3 | | Length = n | | | +| Octets 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Cause | M | This IE shall indicate if the bearer handling was successful, and if not, gives information on the reason. | Cause | 0 | +| S1-U SGW F-TEID | C | This IE shall be present on the S11 interface if S1-U is being used, i.e. if the S11-U Tunnel flag was not set in the Modify Access Bearers Request. The SGW may change the GTP-U F-TEID value if the 'Change F-TEID support Indication' flag was set to 1 in the Modify Access Bearers Request. Otherwise, the SGW shall return the currently allocated GTP-U F-TEID value.
See NOTE 1. | F-TEID | 0 | +| S11-U SGW F-TEID | C | This IE shall be present on the S11 interface if S11-U is being used, i.e. if the S11-U Tunnel flag was set in the Modify Access Bearers Request. If the 'Change F-TEID support Indication' flag was set to 1 in the Modify Bearer Request and the SGW needs to change the F-TEID, the SGW shall include the new GTP-U F-TEID value. Otherwise, the SGW shall return the currently allocated GTP-U F-TEID value. | F-TEID | 1 | + +NOTE 1: The SGW shall not change its F-TEID for a given interface during the Handover, Service Request and E-UTRAN Initiated E-RAB modification procedures. +During Handover and Service Request the target eNodeB may use a different IP type than the one used by the source eNodeB. In order to support such a scenario, the SGW F-TEID should contain both an IPv4 address and an IPv6 address (see also clause 8.22 "F-TEID"). + +**Table 7.2.25-3: Bearer Context marked for removal within Modify Access Bearers Response** + +| Octet 1 | | Bearer Context IE Type = 93 (decimal) | | | +|----------------------|---|------------------------------------------------------------------------------------------------------------|---------|------| +| Octets 2 and 3 | | Length = n | | | +| Octet 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Cause | M | This IE shall indicate if the bearer handling was successful, and if not, gives information on the reason. | Cause | 0 | + +**Table 7.2.25-4: Load Control Information within Modify Access Bearers Response** + +| Octet 1 | | Load Control Information IE Type = 181 (decimal) | | | +|------------------------------|---|------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octet 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Load Control Sequence Number | M | See clause 12.2.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Load Metric | M | See clause 12.2.5.1.2.2 for the description and use of this parameter. | Metric | 0 | + +**Table 7.2.25-5: Overload Control Information within Modify Access Bearers Response** + +| | | | | | +|----------------------------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Overload Control Sequence Number | M | See clause 12.3.5.1.2.1 for the description and use of this parameter. | Sequence Number | 0 | +| Overload Reduction Metric | M | See clause 12.3.5.1.2.3 for the description and use of this parameter. | Metric | 0 | +| Period of Validity | M | See clause 12.3.5.1.2.2 for the description and use of this parameter.
This IE should be set to "0" if the "Overload Reduction Metric" is null. This IE shall be ignored by the receiver if the "Overload Reduction Metric" is null. | EPC Timer | 0 | + +## 7.2.26 Remote UE Report Notification + +The direction of this message shall be from MME to SGW and from SGW to the PGW (see Table 6.1-1). + +This message is used by an MME to notify that at least one remote UE is newly connected to or disconnected from a ProSe UE-to-Network Relay when the MME receives such notification from the ProSe UE-to-Network Relay via the PDN connection established by the ProSe UE-to-Network Relay as specified in 3GPP TS 23.303 [72]. + +Table 7.2.26-1 specifies the presence of IEs in this message. + +**Table 7.2.26-1: Information Elements in Remote UE Report Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------| +| Remote UE Context Connected | C | This IE shall be sent on the S11 interface and S5/S8 interface when the MME receives a report from the ProSe UE-to-Network Relay that a remote UE is newly connected.

The SGW shall forward this IE to the PGW.

Several IEs with the same type and instance value may be included as necessary to represent a list of remote UEs newly connected. | Remote UE Context | 0 | +| Remote UE Context Disconnected | C | This IE shall be sent on the S11 interface and S5/S8 interface when the MME receives a report from the ProSe UE-to-Network Relay that a remote UE is newly disconnected.

The SGW shall forward this IE to the PGW.

Several IEs with the same type and instance value may be included as necessary to represent a list of remote UEs newly disconnected. | Remote UE Context | 1 | +| Private Extension | O | | Private Extension | VS | + +**Table 7.2.26-2: Remote UE Context Connected within Remote UE Report Notification** + +| | | | | | +|-----------------------------|-------------------------------------------|----------------------------------------------------------------|--------------------------|-------------| +| Octets 1 | Remote UE Context IE Type = 191 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octets 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Remote User ID | M | See clause 8.123 for the description and use of this parameter | Remote User ID | 0 | +| Remote UE IP Information | M | See clause 8.124 for the description and use of this parameter | Remote UE IP Information | 0 | + +**Table 7.2.26-3: Remote UE Context Disconnected with Remote UE Report Notification** + +| | | | | | +|-----------------------------|-------------------------------------------|----------------------------------------------------------------|----------------|-------------| +| Octets 1 | Remote UE Context IE Type = 191 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octets 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Remote User ID | M | See clause 8.123 for the description and use of this parameter | Remote User ID | 0 | + +## 7.2.27 Remote UE Report Acknowledge + +The Remote UE Report Acknowledge message shall be sent as the response to a Remote UE Report Notification, to acknowledge the information related to the remote UE(s) is received. + +Possible Cause values are specified in Table 8.4-1. + +Table 7.2.27-1 specifies the presence of IEs in this message. + +**Table 7.2.27-1: Information Elements in Remote UE Report Acknowledge** + +| | | | | | +|-----------------------------|----------|----------------------------|-------------------|-------------| +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Cause | M | | Cause | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.3 Mobility Management Messages + +### 7.3.1 Forward Relocation Request + +A Forward Relocation Request message shall be sent from: + +- the source MME to the target MME over the S10 interface as part of an S1-based handover relocation procedure; +- the source MME to the target SGSN, or from the source SGSN to the target MME over the S3 interface as part of an Inter RAT handover and combined hard handover and SRNS relocation procedures; +- the source SGSN to the target SGSN over the S16 interface as part of an SRNS Relocation and PS handover procedures; +- the source MME to the target SGSN over the S3 interface as part of an SRVCC from E-UTRAN to UTRAN or GERAN with DTM HO support procedures and from the source SGSN to the target SGSN over the S16 interface as part of SRVCC from UTRAN (HSPA) to UTRAN or GERAN with DTM HO support; +- the source MME to the target AMF, or from the source AMF to the target MME over the N26 interface as part of the EPS to 5GS handover and 5GS to EPS handover procedures. +- the source AMF to the target MME\_SRVCC over the N26 interface as part of the 5G-SRVCC from NG-RAN to UTRAN procedure. + +A source MME/SGSN which supports CIoT knows whether the target MME/SGSN pool or target AMF (5GS) supports some CIoT optimisations either by using DNS procedures enhanced for DCNs or by local configuration, as specified in clause 5.9 of 3GPP TS 29.303 [32]. A source AMF knows whether the target MME pool supports SGi Non-IP or Ethernet PDN connections either by using DNS procedures enhanced for DCNs or by local configuration, as specified in clause 5.9 and 5.13 of 3GPP TS 29.303 [32]. The target MME/SGSN may forward the Forward Relocation Request to another MME/SGSN in the target MME/SGSN pool which is more suitable to serve the UE, based on the information received in the Forward Relocation Request message, e.g. required CIoT EPS optimisation(s) applicable to the given UE's attachment. + +NOTE 1: The source MME/SGSN/AMF does not need to know each individual CIoT feature the target MME/SGSN pool or target AMF (5GS) supports. The source MME/SGSN/AMF can behave as if the target MME/SGSN/AMF pool supports all CIoT features when the target MME/SGSN pool is known to support CIoT; the source MME/SGSN/AMF determines then which bearer contexts were successfully transferred as specified in subclause 7.3.2. + +NOTE 2: Among the CIoT optimization features, only the support of SCEF Non-IP PDN connection and the support of SGi Non-IP PDN connection are applicable to a SGSN. + +NOTE 3: 5GS supports Attach without PDU session. 5GS can also support Unstructured and Ethernet PDU session types, which are assimilated to "SGi Non-IP PDN connections" over N26. + +Forward Relocation procedure across S10 interface (when $K_{ASME}$ is taken into use) shall be performed according to the Rules on Concurrent Running of Security Procedures, which are specified in 3GPP TS 33.401 [12]. + +When the source MME/SGSN supports one or more of the CIoT optimization features as specified in clause 8.125, the source MME/SGSN shall transfer EPS bearer context(s) for SGi Non-IP PDN connections or for PDN connections to a SCEF only if the target serving node is known to support SGi Non-IP PDN connections or SCEF Non-IP PDN connections respectively, as specified in clause 5.5.1.2.1 and 5.5.2 of 3GPP TS 23.401 [3]. Likewise, a source AMF shall transfer EPS bearer context(s) for SGi Non-IP PDN connections only if the target MME is known to support SGi Non-IP PDN connections. The source MME/SGSN/AMF shall not proceed with the Forward Relocation Request procedure if the UE does not have any EPS bearer context(s) for SGi IP or Non-IP PDN connections that can be transferred to the target serving node, i.e. under the following conditions: + +- If the UE is attached to the source MME/SGSN with only the PDN connection(s) of PDN type "non-IP" through the SGW and the PGW, with or without SCEF PDN connections, and the target serving node is known to not support SGi Non-IP PDN Connection (as specified in clause 4.3.17.8.3.3 of 3GPP TS 23.401 [3] and in clause 5.3.13.8 of 3GPP TS 23.060 [35]); or +- If the UE is attached to the source AMF (5GS) with only PDU session(s) of type "Ethernet" or "Unstructured", and the target MME is known to not support SGi Non-IP and Ethernet PDN Connection. + +The source MME shall transfer the EPS bearer context(s) for the Ethernet PDN connection only if the target serving node is known to support the Ethernet PDN connection, as specified in clause 5.3.3.1 of 3GPP TS 23.401 [3]. The source MME shall not proceed with the Forward Relocation Request procedure if the UE does not have any EPS bearer context(s) that can be transferred to the target serving node, i.e. under the following conditions: + +- If the UE is attached to the source MME with only the PDN connection(s) of PDN type "Ethernet" through the SGW and the PGW, and the target serving node is known to not support the Ethernet PDN connection. + +Table 7.3.1-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.3.1-1: Information Elements in a Forward Relocation Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|------| +| IMSI | C | The IMSI shall be included in the message, except if the UE is emergency or RLOS attached and the UE is UICCCless.
The IMSI shall be included in the message but not used as an identifier if UE is emergency or RLOS attached but IMSI is not authenticated. | IMSI | 0 | +| Sender's F-TEID for Control Plane | M | | F-TEID | 0 | +| MME/SGSN/AMF UE EPS PDN Connections | C | This IE shall be present, except:
- over the S16 interface if there is no active PDP context and the source and target SGSNs supports SRNS relocation w/o PDN connection over GTPv2 (see NOTE 2); or
- over the N26 interface, during 5G SRVCC handover procedure from 5GS to UTRAN, as specified in clause 6.5 of 3GPP TS 23.216 [43].

If the target MME/SGSN is known to not support SGi Non-IP PDN Connection (as specified in clause 4.3.17.8.3.3 of 3GPP TS 23.401 [3] and in clause 5.3.13.8 of 3GPP TS 23 | PDN Connection | 0 | + +| | | | | | +|--------------------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|---| +| | |

060 [35]), then the source MME/SGSN/AMF shall only include PDN Connections of IP PDN type.

If the target MME is known to not support Ethernet PDN connections, or the target is an SGSN, then the source MME shall not include any Ethernet PDN connection. (See NOTE 10)

Several IEs with this type and instance values shall be included as necessary to represent a list of PDN Connections

| | | +| SGW S11/S4 IP Address and TEID for Control Plane | C |

This IE shall be present, except over the S16 interface if there is no active PDP context and the source and target SGSNs supports SRNS relocation w/o PDN connection over GTPv2 (see NOTE 2).

Over the N26 interface, the source AMF shall set the IP address and TEID to the following values:

  • - any reserved TEID (e.g. all 0's, or all 1's);
  • - IPv4 address set to 0.0.0.0, or IPv6 Prefix Length and IPv6 prefix and Interface Identifier all set to zero.
| F-TEID | 1 | + +| | | | | | +|----------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---| +| SGW node name | C | This IE identifies the SGW that was used by the old MME/S4-SGSN. It shall be included by the source MME/S4-SGSN, except over the S16 interface if there is no active PDP context and the source and target SGSNs supports SRNS relocation w/o PDN connection over GTPv2 (see NOTE 2). | FQDN | 0 | +| MME/SGSN/AMF UE MM Context | M | | MM Context | 0 | +| Indication Flags | C |

This IE shall be included if any of the flags are set to 1.

  • - Direct Forwarding Indication: This flag shall be set to 1 if direct forwarding is supported in the S1 based handover procedure or during an inter-system handover between 5GS and EPS. This flag shall not be set to 1 if the message is used for other handover procedures.
  • - Idle mode Signalling Reduction Supported Indication flag: This flag shall be set to 1 if the source MME/SGSN and associated SGW are capable to establish ISR for the UE.
  • - Unauthenticated IMSI: This flag shall be set to 1 if the IMSI present in the message is not authenticated and is for an emergency or RLOS attached UE.
  • - Change Reporting support indication flag: This flag shall be set to 1 if the Source S4-SGSN/MME supports Location Change Reporting mechanism. See NOTE 1. See NOTE 3.
  • - CSG Change Reporting Support Indication flag: This flag shall be set to 1 if the Source S4-SGSN/MME supports CSG Information Change Reporting mechanism. See NOTE 1. See NOTE 3.
  • - Management Based MDT allowed flag: This flag shall be set to 1 for the S1 based inter-MME handover procedure over the S10 interface, if Management Based Minimization of Drive Tests (MDT) is allowed. See 3GPP TS 36.413 [10] and 3GPP TS 32.422 [18].
  • - CSFB Indication: when configured to support the return to the last used PLMN after CSFB, the MME shall set this flag to 1 on the S3 interface if the PS handover procedure is due to CSFB (see clause 4.3.2 of 3GPP TS 23.272 [21]). See NOTE 5.
  • - Pending MT Short Message Indication: This flag shall be set to 1 on the S10/S16/S3 interface if the source S4-SGSN/MME knows that there is one (or more) pending MT Short Message(s) in the SMS-GMSC for the UE as specified in clause 10.1 of 3GPP TS 23.040 [75], Figure 17c). See NOTE 8.
  • - LTE-M UE Indication (LTE-MUI): This flag shall be set to 1 if the MME/AMF knows that the UE is an LTE-M UE.
  • - Return Preferred Indication (REPREFI): the MME or the AMF may set this flag to 1 on the N26 interface to indicate a preferred return of the UE to the last used EPS or 5GS PLMN (respectively) at a later access change to an EPS or 5GS shared network. See NOTE 5.
  • - 5G-SRVCC HO Indication (5SRHOI): the AMF may set this flag to 1 on the N26 interface to indicate the HO is used for 5G-SRVCC as
| Indication | 0 | + +| | | | | | +|-------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---| +| | |

specified in 3GPP TS 23.216 [43].

  • - Emergency PDU Session Indication (EMCI): the AMF may set this flag to 1 on the N26 interface to indicate that the UE has emergency PDU session, as specified in 3GPP TS 23.126 [43]. The EMCI bit shall be set together with the 5SRHOI bit.
  • - LTE-M Satellite Access Indication (LTEMSAI): This flag shall be set to 1 if the MME/AMF knows that the LTE-M UE is accessing Satellite E-UTRAN.
| | | +| E-UTRAN Transparent Container | C | This IE shall be included to contain the "Source to Target Transparent Container", if the message is used for UTRAN/GERAN to E-UTRAN inter RAT handover procedure, E-UTRAN intra RAT handover procedure, 3G SGSN to MME combined hard handover and SRNS relocation procedure, 5GS to EPS handover and EPS to 5GS handover. The Container Type shall be set to 3. | F-Container | 0 | +| UTRAN Transparent Container | C | This IE shall be included to contain the "Source to Target Transparent Container", if the message is used for PS handover to UTRAN lu mode procedures, SRNS relocation procedure and E-UTRAN to UTRAN inter RAT handover procedure. The Container Type shall be set to 1. | F-Container | 1 | +| BSS Container | C | This IE shall be included to contain the "Source BSS to Target BSS Transparent Container" if the message is used for PS handover to GERAN A/Gb mode and E-UTRAN to GERAN A/Gb mode inter RAT handover procedure. The Container Type shall be set to 2. | F-Container | 2 | +| Target Identification | C | This IE shall be included if the message is used for SRNS relocation procedure, handover to UTRAN/E-UTRAN, 5GS to EPS handover, EPS to 5GS handover procedures and 5G-SRVCC from NG-RAN to UTRAN procedure. | Target Identification | 0 | + +| | | | | | +|----------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---| +| | CO | This IE shall be included on the S3 interface if the message is used for PS handover from E-UTRAN to GERAN A/Gb mode. | | | +| HRPD access node S101 IP address | C | This IE shall be included only if the HRPD pre-registration was performed at the source MME. | IP-Address | 0 | +| 1xIWS S102 IP address | C | This IE shall be included only if the 1xRTT CS fallback pre-registration was performed at the source MME. | IP-Address | 1 | +| S1-AP Cause | C | This IE is the information received from the source eNodeB or derived from the information received from the source NG-RAN. The source MME or AMF shall include this IE in the message. Refer to 3GPP TS 29.010 [42] for the mapping of cause values between S1AP, RANAP, BSSGP and NGAP. | F-Cause | 0 | +| RANAP Cause | C | This IE is the information from the source RNC. The source SGSN shall include this IE in the message. Refer to the 3GPP TS 29.010 [42] for the mapping of cause values between S1AP, RANAP and BSSGP. | F-Cause | 1 | +| BSSGP Cause | C | This IE is the information received from source BSS. The source SGSN shall include this IE in the message. Refer to 3GPP TS 29.010 [42] for the mapping of cause values between S1AP, RANAP and BSSGP. | F-Cause | 2 | +| Source Identification | C | This IE shall be included on the S16 interface if the message is used for PS handover from GERAN/UTRAN to GERAN A/Gb mode. | Source Identification | 0 | +| Selected PLMN ID | C | The old MME/SGSN/AMF shall include this IE if the selected PLMN identity is available. The Selected PLMN ID IE indicates the target core network operator selected for the UE in a shared network. | PLMN ID | 0 | +| Recovery | C | This IE shall be present when contacting the peer for the first time. | Recovery | 0 | +| Trace Information | C | This IE shall be included over S10/S16/S3 when session trace is active for this IMSI/IMEI. | Trace Information | 0 | +| Subscribed RFSP Index | CO | This IE shall be included by the source MME/SGSN/AMF, if received from the HSS or UDM. | RFSP Index | 0 | +| RFSP Index in Use | CO | This IE shall be included by the source MME/SGSN/AMF, if it supports the feature. | RFSP Index | 1 | +| RFSP in Use Validity Time | O | This IE may be included by the source MME/AMF during 5GS to EPS mobility and subsequent inter-MME mobility procedures if the validity time has not expired yet. It indicates the validity time of RFSP Index in Use to be used in the target MME as specified in clause 4.11.1.5.8 of 3GPP TS 23.502 [83]. When present, this IE shall be set to the remaining validity time of the RFSP Index in Use. The AMF shall ignore this IE if it is received from the MME. | Timer in Seconds | 0 | +| CSG ID | CO | This IE shall be included on the S3/S10/S16 interfaces if the source MME/SGSN receives it from the source eNodeB/RNC. It indicates the target CSG ID in case of a handover to a CSG cell or hybrid cell. | CSG ID | 0 | +| CSG Membership Indication | CO | This IE shall be included on the S3/S10/S16 interfaces by the source MME/SGSN if the CSG access mode is received from the source eNodeB/RNC and indicates the target cell is a hybrid cell, or if the UE has emergency bearer(s) and the target cell is a CSG cell. | CMI | 0 | +| UE Time Zone | CO | When available, this IE shall be included by the source MME/S4-SGSN/AMF. | UE Time Zone | 0 | +| Serving Network | CO | This IE shall be included to indicate the current Serving Network. | Serving Network | 0 | +| MME/S4-SGSN LDN | O | This IE may be sent by the MME/S4-SGSN to the peer MME/S4-SGSN on the S3/S10/S16 interfaces (see 3GPP TS 32.423 [44]), when communicating the LDN to the peer node for the first time. | Local Distinguished Name (LDN) | 0 | + +| | | | | | +|----------------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|---| +| Additional MM context for SRVCC | CO | This IE shall be sent by the source MME/S4-SGSN to the target MME/S4-SGSN on the S3/S10/S16 interfaces if MS Classmark2, MS Classmark3 and the Supported Codec are available in the source MME/S4-SGSN, or by the source AMF to the target MME_SRVCC (during a 5G-SRVCC procedure as specified in clause 6.5.4 of 3GPP TS 23.216 [43]) or to the target MME (during a 5G to 4G handover) on the N26 interface if MS Classmark2 and the Supported Codec are available in the source AMF. | Additional MM context for SRVCC | 0 | +| Additional flags for SRVCC | CO | This IE shall be included if any one of the applicable flags needs to be forwarded.
Applicable flags:
- ICS Indicator: This IE shall be sent by the source MME/S4-SGSN to the target MME/S4-SGSN on the S3/S10/S16 interfaces if ICS Indicator is available in the source MME/S4-SGSN.
- vSRVCC flag: This IE shall be sent by the source MME to the target MME on the S10 interface if vSRVCC flag is available in the source MME. | Additional flags for SRVCC | 0 | +| STN-SR | CO | This IE shall be sent by the source MME/S4-SGSN to the target MME/S4-SGSN on the S3/S10/S16 interfaces if STN-SR is available in the source MME/S4-SGSN, or by the source AMF to the target MME_SRVCC during a 5G-SRVCC procedure as specified in clause 6.5.4 of 3GPP TS 23.216 [43]) or to the target MME (during a 5G to 4G handover) on the N26 interface if STN-SR is available in the source AMF. | STN-SR | 0 | +| C-MSISDN | CO | This IE shall be sent by the source MME/S4-SGSN to the target MME/S4-SGSN on the S3/S10/S16 interfaces if C-MSISDN is available in the source MME/S4-SGSN, or by the source AMF to the target MME_SRVCC during a 5G-SRVCC procedure as specified in clause 6.5.4 of 3GPP TS 23.216 [43]) or to the target MME (during a 5G to 4G handover) on the N26 interface if C-MSISDN is available in the source AMF. The C-MSISDN is defined in 3GPP TS 23.003 [2]. | MSISDN | 0 | +| MDT Configuration | CO | This IE shall be sent by the source MME to the target MME on the S10 interface for the S1-based handover relocation procedure, if the Job Type indicates Immediate MDT. See 3GPP TS 32.422 [18] clause 4.4. | MDT Configuration | 0 | +| SGSN node name | CO | This IE shall be sent by the source SGSN on the S3 interface if both source SGSN and associated SGW support ISR. See NOTE 4. | FQDN | 1 | +| MME node name | CO | This IE shall be sent by the source MME on the S3 interface if both source MME and associated SGW support ISR. See NOTE 4. | FQDN | 2 | +| User CSG Information (UCI) | CO | This IE shall be sent by the source MME/S4-SGSN on the S3/S10/S16 interfaces if the source MME/SGSN has reported to the PGW that the UE is in a CSG or hybrid cell. It shall then contain the last User CSG information that the source MME/S4-SGSN has reported to the PGW. The absence of this IE indicates that the UE has not been reported to the PGW as being in a CSG or hybrid cell. See NOTE 6. | UCI | 0 | +| Monitoring Event Information | CO | This IE shall be sent by the source MME/S4-SGSN on the S3/S10/S16 interfaces if monitoring events are to be continued in the target MME/S4-SGSN. More than one IE with this type and instance values may be included to represent multiple monitoring events. | Monitoring Event Information | 0 | +| Monitoring Event Extension Information | CO | This IE shall be sent by the source MME/S4-SGSN on the S3/S10/S16 interfaces if monitoring event extensions are to be sent to the target MME/S4-SGSN. More than one IE with this type and instance values may be included to represent multiple monitoring event extensions. | Monitoring Event Extension Information | 0 | +| UE Usage Type | CO | This IE shall be set to the subscribed UE Usage Type, if received from the HSS, and sent by the old MME/SGSN if | Integer Number | 0 | + +| | | | | | +|----------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---| +| | | the old MME/SGSN supports the Dedicated Core Networks specified in TS 23.401 [3].
This IE shall also be set to the subscribed UE Usage Type, if received from the UDM, and sent by the old AMF on N26 interface.
If the UE Usage Type is not available in the old MME/SGSN/AMF, the length field of this IE shall be set to 0.
See NOTE 7. | | | +| MME/SGSN UE SCEF PDN Connections | CO | This IE shall be present over the S10/S3/S16 interface if there is at least one SCEF PDN connection for this UE at the source MME/SGSN and if the target MME/SGSN is known to support SCEF Non-IP PDN Connections (as specified in clause 5.13.1 of 3GPP TS 23.682 [74]).

Several IEs with this type and instance values shall be included as necessary to represent a list of SCEF PDN Connections. | SCEF PDN Connection | 0 | +| MSISDN | CO | This IE shall be present over the S3/S16 interface if the UE's MSISDN is available and if there is at least one instance of the MME/SGSN UE SCEF PDN Connection IE included in the message. | MSISDN | 1 | + +| | | | | | +|----------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|----| +| | CO | This IE shall be present over the S10/N26 interface if the UE's MSISDN is available. | | | +| Source UDP Port Number | CO | If the target MME/SGSN/AMF, selected by the source MME/SGSN/AMF, decides to forward the Forward Relocation Request message to another more suitable MME/SGSN/AMF in the same MME/SGSN pool or AMF set, the MME/SGSN/AMF shall include this IE, set to the Source UDP Port number of the received message from the source MME/SGSN/AMF. The new target MME/SGSN/AMF shall use this UDP port as the UDP destination port in the Forward Relocation Response message. | Port Number | 0 | +| Serving PLMN Rate Control | CO | This IE shall be included by the old MME on S10 interface if the Serving PLMN Rate control was enabled when there is at least one SCEF PDN connection. See NOTE 9. | Serving PLMN Rate Control | 0 | +| Extended Trace Information | C | This IE shall be included over N26 when session trace is active for this user. | Extended Trace Information | 0 | +| Subscribed Additional RRM Policy Index | CO | This IE shall be included by the MME over the S10 interface if received from the HSS. | Additional RRM Policy Index | 0 | +| Additional RRM Policy Index in Use | CO | This IE shall be included by the MME over the S10 interface if the feature is supported by the MME. | Additional RRM Policy Index | 1 | +| Subscribed V2X Information | CO | This IE shall be present over the N26 interface if available, and sent by the old MME/AMF if the old MME/AMF supports the V2X services specified in 3GPP TS 23.287 [89]. | V2X Context | 0 | +| IWK SCEF ID for Monitoring Event | CO | This IE shall be included on the S3/S10 interface if the source MME/SGSN has selected the IWK-SCEF to relay Monitoring Events. | Node Identifier | 0 | +| Alternative IMSI | CO | This IE shall be included by the old MME over the S10 interface if it has stored an Alternative IMSI as specified in TS 23.401 [3] clause 5.7.2. | Alternative IMSI | 0 | +| Private Extension | O | | Private Extension | VS | + +- NOTE 1: 3GPP TS 23.401 [3] (e.g. clause 5.3.2.1) and 3GPP TS 23.060 [35] (e.g. clause 9.2.2.1) defines the MME/SGSN shall send the MS Info Change Reporting Support Indication to the PGW. In such case MME/SGSN shall use the Change Reporting Support Indication and/or CSG Change Reporting Support Indication (whichever is applicable), even if stage 2 refers to MS Info Change Reporting Support Indication. +- NOTE 2: GTPv2 shall be used for SRNS relocation w/o PDN connection if all the S4-SGSNs (between which SRNS relocation can take place) support this optional GTPv2 procedure. Otherwise GTPv1 shall be used for that procedure (see clause 7.10). The S4-SGSN can know by local configuration whether all peer S4-SGSNs support this procedure. +- NOTE 3: The receiver shall ignore the per UE Change Reporting Support Indication and CSG Change Reporting Support Indication flags, as included within the Indication Flags IE above, if these flags are included per PDN connection i.e. within the Indication Flags IE of the MME/SGSN UE EPS PDN Connections IE. +- NOTE 4: According to the 3GPP TS 23.401 [3], during an inter-RAT handover procedure for a UE with ISR activated, the source MME/SGSN should select the ISR associated CN node for this UE as the target CN node for the inter RAT HO when the ISR associated CN node can serve the target access. This parameter is exchanged when ISR is being activated and used in the source MME/SGSN for this decision upon subsequent inter-RAT handover. +- NOTE 5: If the SGSN needs to include the last used LTE PLMN ID in the Equivalent PLMN list it sends to the UE (see 3GPP TS 23.272 [21]), the SGSN shall derive the last used LTE PLMN ID from the Serving Network IE. If an MME or AMF needs to store the last used 5GS or EPS PLMN ID (respectively), the MME or AMF shall derive the last used 5GS or EPS PLMN ID (respectively) from the Serving Network IE. +- NOTE 6: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator for supporting UEs, or that of the allocated Core Network Operator for non-supporting UEs. As an exception, based on inter-operator roaming/sharing agreement, if the information on whether the UE is a supporting or non-supporting UE is available, the PLMN ID that is communicated to the HPLMN for non-supporting UEs shall be the Common PLMN ID. +In shared networks, when the MME/S4-SGSN and PGW pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI to the PGW, and the Common PLMN ID shall be communicated in SAI/CGI to the PGW, for both supporting and non-supporting UEs. The Core Network Operator PLMN ID (selected by the UE for supporting UEs or allocated by the network for non-supporting UEs) shall be communicated in the TAI, RAI, UCI and the Serving Network. See clause 4.4 of 3GPP TS 23.251 [55]. +- NOTE 7: A UE Usage Type IE with the length field equal to 0 is used for the receiver to differentiate the case where the sender does not support the Dedicated Core Network feature from the case where the sender supports the Dedicated Core Network feature but no UE Usage type was received in UE's subscription. +- NOTE 8: There may be a pending MT Short Message at the SMS-GMSC during a handover scenario, when the UE performs a Service Request towards the source MME/SGSN and a handover procedure occurs shortly afterward, before the SMS-GMSC is alerted to retransmit the pending MT Short Message. +- NOTE 9: The target MME may compare the value of the Serving PLMN Rate Control received in the Forward Relocation Request message with the one configured locally, to determine if this parameter needs to be updated towards the SCEF. The Serving PLMN Rate Control does not apply to any SGi PDN Connection in this message. +- NOTE 10: PDN connections with PDN Type "Ethernet" are not supported in GERAN/UTRAN. For PDN connections with PDN type "Ethernet", mobility to GERAN/UTRAN is not supported. See clause 4.3.17.8a of TS 23.401 [3]. + +The PDN Connection grouped IE shall be coded as depicted in Table 7.3.1-2. + +**Table 7.3.1-2: MME/SGSN/AMF UE EPS PDN Connections within Forward Relocation Request** + +| Octet 1 | PDN Connection IE Type = 109 (decimal) | | | | +|----------------------|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| APN | M | | APN | 0 | +| APN Restriction | C | This IE denotes the restriction on the combination of types of APN for the APN associated with this EPS bearer Context. The target MME or SGSN determines the Maximum APN Restriction using the APN Restriction. If available, the source MME/S4SGSN shall include this IE. | APN Restriction | 0 | +| Selection Mode | CO | When available, this IE shall be included by the source MME/S4-SGSN/AMF. | Selection Mode | 0 | +| IPv4 Address | C | This IE shall not be included if no IPv4 Address is | IP Address | 0 | + +| | | | | | +|------------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|---| +| | | assigned. See NOTE 1. | | | +| IPv6 Address | C | This IE shall not be included if no IPv6 Address is assigned. | IP Address | 1 | +| Linked EPS Bearer ID | M | This IE identifies the default bearer of the PDN Connection. | EBI | 0 | +| PGW S5/S8 IP Address for Control Plane or PMIP | M | This IE shall include the TEID in the GTP based S5/S8 case and the uplink GRE key in the PMIP based S5/S8 case.
See NOTE 4. | F-TEID | 0 | +| PGW node name | C | This IE shall be included if the source MME, SGSN or AMF has the PGW FQDN. | FQDN | 0 | +| | CO | This IE shall be included by the source MME over the N26 interface. See NOTE 6. | | | +| Bearer Contexts | C | Several IEs with this type and instance values may be included as necessary to represent a list of Bearers. | Bearer Context | 0 | +| Aggregate Maximum Bit Rate (APN-AMBR) | M | | AMBR | 0 | +| Charging characteristics | C | This IE shall be present if charging characteristics was supplied by the HSS to the MME/SGSN, or by the UDM to the SMF, as a part of subscription information. | Charging characteristics | 0 | +| Change Reporting Action | C | This IE shall be included whenever available at the source MME/SGSN. See NOTE 5. | Change Reporting Action | 0 | +| CSG Information Reporting Action | CO | This IE shall be included whenever available at the source MME/SGSN. | CSG Information Reporting Action | 0 | +| H(e)NB Information Reporting | CO | This IE shall be included whenever available at the source MME/SGSN. | H(e)NB Information Reporting | 0 | +| Indication Flags | CO | This IE shall be included if any of the flags are set to 1.
  • - Change Reporting support indication flag: This flag shall be set to 1 if the Source S4-SGSN/MME supports Location Change Reporting mechanism and if the S4-SGSN/MME has indicated the support for the Location Change Reporting mechanism to the PGW, during the session establishment and/or modification procedures. See NOTE 2.
  • - CSG Change Reporting Support Indication flag: This flag shall be set to 1 if the Source S4-SGSN/MME supports CSG Information Change Reporting mechanism and if the S4-SGSN/MME has indicated the support for the CSG Information Change Reporting to the PGW, during the session establishment and/or modification procedures. See NOTE 2.
  • - Delay Tolerant Connection Indication flag: This flag shall be set to 1 on the S3/S10/S16 interface by the source MME/SGSN if the PGW indicated that this PDN Connection is delay tolerant.
  • - Extended PCO Support Indication flag: This flag shall be set to 1 on S10/N26 interface by the source MME if the UE and the source MME support Extended PCO. It shall be set to 1 on the N26 interface during a 5GS to EPS handover.
  • - NO 5GS N26 mobility Indication flag: This flag shall be set to 1 on S10 interface if the PDN connection cannot be moved to 5GS via N26.
| Indication | 0 | +| Signalling Priority Indication | CO | The source SGSN/MME shall include this IE if the UE indicated low access priority when establishing the PDN connection. | Signalling Priority Indication | 0 | +| Change to Report Flags | CO | This IE shall be included by the SGSN if any one of the applicable flags is set to 1. See NOTE 3.
Applicable flags:
  • - Serving Network Change to Report: This flag shall be set to 1 if the source SGSN has detected a Serving Network change during a RAU procedure
| Change to Report Flags | 0 | + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|---| +| | |

without SGSN change but has not yet reported this change to the PGW.

  • - Time Zone Change to Report: This flag shall be set to 1 if the source SGSN has detected a UE Time Zone change during a RAU procedure without SGSN change but has not yet reported this change to the PGW.
| | | +| Local Home Network ID | CO | This IE shall be sent over the S3/S10/S16 interface if SIPTO at the Local Network is active for the PDN connection in the SIPTO at the Local Network architecture with stand-alone GW. | FQDN | 1 | +| Presence Reporting Area Action | CO |

This IE shall be included if the PGW requested the source MME/SGSN to report changes of UE presence in a Presence Reporting Area. The source MME/SGSN shall include the Presence Reporting Area Identifier and, if received from the PGW, the list of the Presence Reporting Area elements.

Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Actions. One IE shall be included for each Presence Reporting Area.

| Presence Reporting Area Action | 0 | +| WLAN Offloadability Indication | CO | If the MME/SGSN supports WLAN/3GPP Radio Interworking with RAN rules then this IE shall be included on S3/S10/S16 if the UE has been authorized to perform WLAN offload for at least one RAT. | WLAN Offloadability Indication | 0 | +| Remote UE Context Connected | CO |

The source MME shall include this IE on the S10 interface during an inter MME mobility procedure if such information is available.

Several IEs with the same type and instance value may be included as necessary to represent a list of remote UEs connected.

| Remote UE Context | 0 | +| PDN Type | CO | The source MME/SGSN/AMF shall include this IE on the S10/S3/S16/N26 interface, for a Non-IP PDN Connection, during an inter MME/SGSN/AMF mobility procedure, if the target MME/SGSN/AMF supports SGi Non-IP or Ethernet PDN connections. | PDN Type | 0 | +| Header Compression Configuration | CO | This IE shall be sent over the S10 interface if the use of IP Header Compression for Control Plane CIoT EPS optimisations has been negotiated with the UE and the target MME is known to support CIoT EPS optimisations. | Header Compression Configuration | 0 | +| PGW Change Info | CO | This IE shall be sent over the S10/N26 interface if available from a source AMF/MME to a target MME. See clause 31.5 of 3GPP TS 23.007 [17]. | PGW Change Info | 0 | +| UP Security Policy | CO | This IE shall be sent by the old MME on the S10 interface or by the old AMF on the N26 interface if this information is available. When present, it shall indicate whether User Plane integrity protection is required, preferred or not needed for the traffic of the PDN connection. | UP Security Policy | 0 | +| NOTE 1: For deferred IPv4 address allocation, if the MME/S4-SGSN receives the PDN address "0.0.0.0" from PGW during "eUTRAN Initial Attach", "PDP Context Activation", "UE requested PDN Connectivity", then the MME/S4-SGSN shall include this IPv4 address "0.0.0.0". | | | | | +| NOTE 2: 3GPP TS 23.401 [3] (e.g. clause 5.3.2.1) and 3GPP TS 23.060 [35] (e.g. clause 9.2.2.1) defines the MME/SGSN shall send the MS Info Change Reporting Support Indication to the PGW. In such case MME/SGSN shall use the Change Reporting Support Indication and/or CSG Change Reporting Support Indication (whichever is applicable), even if stage 2 refers to MS Info Change Reporting Support Indication. | | | | | +| NOTE 3: When UE is camping on the 3G and performs a Service Request procedure, as specified in the clause 6.12.1 of 3GPP TS 23.060 [35], if Service Type indicates Signalling, the signalling connection is established between the MS and the SGSN for sending upper-layer signalling messages, e.g. Activate PDP Context Request, but the resources for active PDP context(s) are not allocated, therefore the change of Serving Network or UE Time zone may not be reported to SGW/PGW for the existing PDP Contexts. | | | | | +| NOTE 4: For PMIP based S5/S8, the 'PGW S5/S8 IP Address and TEID for user plane' IE and the 'PGW S5/S8 IP Address for Control Plane or PMIP' IE shall contain the same uplink GRE key; the Interface Type in these IEs shall be set to the value 9 (S5/S8 PGW PMIPv6 interface). | | | | | +| NOTE 5: The target MME (respectively S4-SGSN) shall ignore this IE if it is received from an S4-SGSN | | | | | + +(respectively an MME), i.e. over the S3 interface. In this case, the target serving node shall consider that no ULI change reporting is requested by the PGW for the target RAT, and the PGW shall request the target serving node to start ULI change reporting for the target RAT if so desired. + +NOTE 6: The PGW Node Name is used by the target AMF in the NF Service Discovery procedure to find the combined PGW-C/SMF for the PDU Session during an MME to AMF mobility procedure. + +The Bearer Context grouped IE shall be coded as depicted in Table 7.3.1-3. + +**Table 7.3.1-3: Bearer Context within MME/SGSN/AMF UE EPS PDN Connections within Forward Relocation Request** + +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +|--------------------------------------------------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | See NOTE 3. | EBI | 0 | +| TFT | C | This IE shall be present if a TFT is defined for this bearer. | Bearer TFT | 0 | +| SGW S1/S4/S12 IP Address and TEID for user plane | M | This IE shall contain the SGW S1/S4/S12 IP Address and TEID for user plane.

Over the N26 interface, the SMF (on behalf of the source AMF) shall set the IP address and TEID to the following values:
  • - any reserved TEID (e.g. all 0's, or all 1's);
  • - IPv4 address set to 0.0.0.0, or IPv6 Prefix Length and IPv6 prefix and Interface Identifier all set to zero.
See NOTE2, NOTE 4. | F-TEID | 0 | +| PGW S5/S8 IP Address and TEID for user plane | C | This IE shall be present for GTP based S5/S8. | F-TEID | 1 | +| | CO | For PMIP-based S5/S8, this IE shall be included if the PGW provided an alternate address for user plane, i.e. an IP address for user plane which is different from the IP address for control plane.
When present, this IE shall contain the alternate IP address for user plane and the uplink GRE key.
See NOTE 1. | | | +| Bearer Level QoS | M | | Bearer QoS | 0 | +| BSS Container | CO | The MME/S4 SGSN shall include the Packet Flow ID, Radio Priority, SAPI, PS Handover XID parameters in the TAU/RAU/Handover procedure, if available. See Figure 8.48-2. The Container Type shall be set to 2. | F-Container | 0 | +| Transaction Identifier | C | This IE shall be sent over S3/S10/S16 if the UE supports A/Gb and/or Iu mode. This IE should be sent over N26 if the MME has a TI stored that is linked with this EPS Bearer ID, or, the SMF provides the TI to the AMF (as part of a procedure to deliver SM context to AMF). | TI | 0 | +| Bearer Flags | CO | Applicable flags:
  • - vSRVCC indicator: This IE shall be sent by the source MME to the target MME on the S10 interface if vSRVCC indicator is available in the source MME.
  • - ASI (Activity Status Indicator): the source S4-SGSN shall set this indicator to 1 on the S16 interface if the bearer context is preserved in the CN without an associated RAB.
| Bearer Flags | 0 | +| SGW S11 IP Address and TEID for user plane | CO | This IE shall be present if available. See NOTE 2. | F-TEID | 2 | + +NOTE 1: For PMIP based S5/S8, the 'PGW S5/S8 IP Address and TEID for user plane' IE and the 'PGW S5/S8 IP Address for Control Plane or PMIP' IE shall contain the same uplink GRE key; the Interface Type in these IEs shall be set to the value 9 (S5/S8 PGW PMIPv6 interface). + +NOTE 2: When separate IP address spaces are used for S1-U and S11-U, the MMEs shall include both S1-U SGW F-TEID in the SGW S1/S4/S12/S11 IP Address and TEID for user plane IE and S11-U SGW F-TEID in SGW S11 IP Address and TEID for user plane, when they are available; otherwise, the source MME shall include the SGW S1/S4/S12/S11 IP Address and TEID for user plane IE, since S1-U and S11-U SGW F-TEID are the same. + +NOTE 3: The support of the 15 EPS Bearers shall be homogeneously supported within an MME Pool / SGW serving area. A source MME which supports the 15 EPS Bearers, shall know whether the target MME pool also supports that by local configuration. When the target MME is known to not support the 15 EPS Bearers, the source MME shall only transfer up to 8 EPS bearer contexts with the EBI value set between '5' and '15' to the target MME and shall delete EPS bearer(s) which are not transferred, and if the default bearer is to be deleted, the corresponding PDN connection(s) shall be deleted by the source MME. + +NOTE 4: During 5GS to EPS mobility procedures with N26 interface, the source AMF shall transparently transfer the MME/SGSN/AMF UE EPS PDN Connections IE received from the SMF as specified in + +| | +|------------------------------------------| +| clause 6.1.6.2.27 of 3GPP TS 29.502[88]. | +|------------------------------------------| + +**Table 7.3.1-4: Remote UE Context Connected within MME/SGSN UE EPS PDN Connections within Forward Relocation Request** + +| Octets 1 | | Remote UE Context IE Type = 191 (decimal) | | | +|--------------------------|---|----------------------------------------------------------------|--------------------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octets 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Remote User ID | M | See clause 8.123 for the description and use of this parameter | Remote User ID | 0 | +| Remote UE IP Information | M | See clause 8.124 for the description and use of this parameter | Remote UE IP Information | 0 | + +**Table 7.3.1-5: MME UE SCEF PDN Connections within Forward Relocation Request** + +| Octets 1 | | SCEF PDN Connection IE Type = 195 (decimal) | | | +|-----------------------|---|---------------------------------------------------------------------------|-----------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octets 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| APN | M | | APN | 0 | +| Default EPS Bearer ID | M | This IE shall identify the default bearer of the SCEF PDN Connection. | EBI | 0 | +| SCEF ID | M | This IE shall include the SCEF Identifier and the SCEF Realm for the APN. | Node Identifier | 0 | + +**Table 7.3.1-6: Subscribed V2X Information within Forward Relocation Request** + +| Octets 1 | | V2X Context IE Type = 208 (decimal) | | | +|--------------------------------------------|---|--------------------------------------------------------------------------------------------------------------------|---------------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octets 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| LTE V2X Services Authorized | C | This IE shall be included to indicate the authorization status of the UE to use the LTE sidelink for V2X services. | Services Authorized | 0 | +| NR V2X Services Authorized | C | This IE shall be included to indicate the authorization status of the UE to use the NR sidelink for V2X services. | Services Authorized | 1 | +| LTE UE Sidelink Aggregate Maximum Bit Rate | C | This IE shall be included if the UE is authorized for LTE V2X services. | Bit Rate | 0 | +| NR UE Sidelink Aggregate Maximum Bit Rate | C | This IE shall be included if the UE is authorized for NR V2X services. | Bit Rate | 1 | +| PC5 QoS Parameters | C | This IE shall be included if the UE is authorized for NR V2X services. | PC5 QoS Parameters | 0 | + +**Table 7.3.1-7: PC5 QoS Parameters within Forward Relocation Request** + +| Octets 1 | | PC5 QoS Parameters IE Type = 209 (decimal) | | | +|-------------------------------|---|-----------------------------------------------------------------------------------------------------------------------|--------------|------| +| Octets 2 and 3 | | Length = n | | | +| Octets 4 | | Spare and Instance fields | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| PC5 QoS Flows | M | Several IEs with this type and same instance value may be included as necessary to represent a list of PC5 QoS Flows. | PC5 QoS Flow | 0 | +| PC5 Link Aggregated Bit Rates | O | This IE may be included for the non-GBR PC5 QoS Flows. | Bit Rate | 0 | + +**Table 7.3.1-8: PGW Change Info with Forward Relocation Request** + +| | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------| +| Octet 1 | PGW Change Info IE Type = 214 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| PGW Set FQDN | CO | This IE shall be included by the source MME if available.

When present, this IE shall contain the PGW Set FQDN of the PGW-C/SMF set to which the PGW-C/SMF belongs. (NOTE) | PGW FQDN | 0 | +| Alternative PGW-C/SMF IP Address | CO | This IE shall be included by the source MME if available.

When present, this IE shall contain alternative PGW-C/SMF IP addresses within the PGW-C/SMF set to which the PGW-C/SMF belongs.

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF IP Addresses. (NOTE) | IP Address | 0 | +| Alternative PGW-C/SMF FQDN | CO | This IE shall be included by the source MME if available.

When present, this IE shall contain alternative PGW-C/SMF FQDN within the PGW-C/SMF set to which the PGW-C/SMF belongs.

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF FQDNs. (NOTE) | PGW FQDN | 1 | +| Group Id | CO | This IE shall be included by the source MME if available.

When present, this IE shall identify the group to which the PDN connection pertains (see clause 31.6 of 3GPP TS 23.007 [17]). | Group Id | 0 | +| NOTE: Either the PGW Set FQDN IE, the Alternative PGW-C/SMF IP Address IE, or the Alternative PGW-C/SMF FQDN IE shall be present. | | | | | + +## 7.3.2 Forward Relocation Response + +A Forward Relocation Response message shall be sent as a response to Forward Relocation Request during S1-based handover procedure, Inter RAT handover procedures, SRNS Relocation procedure and PS handover procedures, EPS to 5GS handover and 5GS to EPS handover procedures, 5G-SRVCC from NG-RAN to UTRAN procedure. + +Based on the List of Set-up Bearers IE in the Forward Relocation Response, the source MME/AMF shall determine whether the bearer contexts for SGi (IP, Non-IP or Ethernet) PDN connections were successfully transferred to the target MME/AMF. + +Based on the List of Set-up Bearers for SCEF PDN Connections IE in the Forward Relocation Response, the source MME shall determine whether the bearer contexts for SCEF PDN connections were successfully transferred to the target MME, and initiate procedures to release the SCEF PDN connections which were not successfully handed over. + +Table 7.3.2-1 specifies the presence requirements and conditions of the IEs in the message. + +Cause IE indicates if the relocation has been accepted, or not. The relocation has not been accepted by the target MME/SGSN/AMF if the Cause IE value differs from "Request accepted". Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Relocation failure". + +**Table 7.3.2-1: Information Elements in a Forward Relocation Response** + +| | | | | | +|-----------------------------|----------|----------------------------|----------------|-------------| +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-----------------------------|----------|----------------------------|----------------|-------------| + +| | | | | | +|-----------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|---| +| Cause | M | | Cause | 0 | +| Sender's F-TEID for Control Plane | C | If the Cause IE contains the value "Request accepted", the target MME/SGSN/AMF shall include this IE in the Forward Relocation Response message. | F-TEID | 0 | +| Indication Flags | C | This IE shall be included if any of the flags are set to 1.
:
- SGW Change Indication: this flag shall be set to 1 if the target MME/SGSN has selected a new SGW.
This flag shall be set to 1 by the target AMF during the EPS to 5GS handover using N26 interface. | Indication | 0 | +| List of Set-up Bearers | C | The list of Set-up Bearers IE shall contain the EPS bearer Identifiers of the bearers that were successfully allocated in the target system during a handover procedure. This IE shall be included if the source and target access type is EUTRAN or NG-RAN and the Cause IE contains the value "Request accepted".
See NOTE 1.
Several IEs with this type and instance values shall be included as necessary to represent a list of Bearers. | Bearer Context | 0 | +| List of Set-up RABs | C | The list of Set-up RABs IE shall contain the RAB Identifiers of the RABs that were successfully allocated in the target system. This IE shall be included if the Cause IE contains the value "Request accepted" and
- If the source access type is UTRAN and the target access type is E-UTRAN/UTRAN,
- If the source access type is E-UTRAN and the target access type is UTRAN,
except over the S16 interface if the Forward Relocation Request did not include the MME/SGSN UE EPS PDN Connections IE.
See NOTE 1.
Several IEs with this type and instance values shall be included as necessary to represent a list of Bearers. | Bearer Context | 1 | +| List of Set-up PFCs | O | The list of Set-up PFCs IE shall contain the Packet Flow Identifiers of the PFCs that were successfully allocated in the target system during a PS handover to/from GERAN or inter RAT handover to/from GERAN. If the Cause IE contains the value "Request accepted", this IE may be included.
See NOTE 1.
Several IEs with this type and instance values shall be included as necessary to represent a list of Bearers. | Bearer Context | 2 | +| S1-AP Cause | C | This IE shall be included if the cause value is received in an S1-AP message or derived from the cause value received in a NGAP message. Refer to the 3GPP TS 29.010 [42] for the mapping of cause values between S1AP, RANAP, BSSGP and NGAP. | F-Cause | 0 | +| RANAP Cause | C | This IE shall be included if the cause value is received in RANAP message. Refer to the 3GPP TS 29.010 [42] for the mapping of cause values between S1AP, RANAP and BSSGP. | F-Cause | 1 | +| BSSGP Cause | C | For handover to GERAN, if a cause value is received from the Target BSC, the BSSGP Cause IE shall be included and shall be set to the cause value received from the target BSC. Refer to the 3GPP TS 29.010 [42] for the mapping of cause values between S1AP, RANAP and BSSGP. | F-Cause | 2 | +| E-UTRAN Transparent Container | C | This IE shall be included to contain the "Target to Source Transparent Container" during a handover to E-UTRAN, 5GS to EPS handover and EPS to 5GS handover. If the Cause IE contains the value "Request accepted". The Container Type shall be set to 3. | F-Container | 0 | +| UTRAN Transparent Container | C | This IE shall be included to contain the "Target to Source Transparent Container" during a handover to UTRAN. If the Cause IE contains the value "Request accepted". The | F-Container | 1 | + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|----| +| | | Container Type shall be set to 1. | | | +| BSS Container | C | This IE shall be included to contain the Target BSS to Source BSS Transparent Container during a handover to GERAN. If the Cause IE contains the value "Request accepted". The Container Type shall be set to 2 | F-Container | 2 | +| MME/S4-SGSN LDN | O | This IE may be sent by the MME/S4-SGSN to the peer MME/S4-SGSN on the S3/S10/S16 interfaces (see 3GPP TS 32.423 [44]), when communicating the LDN to the peer node for the first time. | Local Distinguished Name (LDN) | 0 | +| SGSN node name | CO | This IE shall be sent by the target SGSN on the S3 interface if both target SGSN and associated SGW support ISR. See NOTE 2. | FQDN | 0 | +| MME node name | CO | This IE shall be sent by the target MME on the S3 interface if both target MME and associated SGW support ISR. See NOTE 2. | FQDN | 1 | +| SGSN Number | O | This IE may be sent by the target S4-SGSN to the source MME/S4-SGSN as specified in 3GPP TS 23.271 [56]. | Node Number | 0 | +| | CO | This IE shall be included if the PMTSMI flag in the Forward Relocation Request message is set to 1. | | | +| SGSN Identifier | O | This IE may be sent by the target S4-SGSN to the source MME/S4-SGSN as specified in 3GPP TS 23.271 [56]. | Node Identifier | 0 | +| MME Identifier | O | This IE may be sent by the target MME to the source MME/S4-SGSN/AMF as specified in 3GPP TS 23.271 [56] and 3GPP TS 23.273 [91]. | Node Identifier | 1 | +| MME number for MT SMS | CO | This IE shall be included on the S10/S3 interface if the PMTSMI flag in the Forward Relocation Request message is set to 1. | Node Number | 1 | +| SGSN Identifier for MT-SMS | CO | This IE shall be included on the S16/S3 interface if the target S4-SGSN supports the Gdd reference point and if the PMTSMI flag in the Forward Relocation Request message is set to 1. | Node Identifier | 2 | +| MME Identifier for MT SMS | CO | This IE shall be included on the S10/S3 interface if the target MME supports the SGd reference point and if the PMTSMI flag in the Forward Relocation Request message is set to 1. | Node Identifier | 3 | +| List of Set-up Bearers for SCEF PDN Connections | CO | This IE shall contain the EPS bearer Identifiers of the Bearers of SCEF PDN connections that were successfully allocated in the target system during a handover procedure, if any.
Several IEs with this type and instance values shall be included as necessary to represent a list of Bearers. | Bearer Context | 3 | +| (v)SRVCC rejected Cause | CO | This IE shall be sent by the MME_SRVCC on the N26 interface during a 5G-SRVCC from NG-RAN to UTRAN handover, if the (v)SRVCC rejected Cause IE is received in the SRVCC PS to CS Response from the MSC Server. When present, it shall contain the same value as received from the MSC Server. | SRVCC Cause | 0 | +| MSC Number | O | This IE may be sent by the MME_SRVCC to the AMF over the N26 interface during a 5G-SRVCC from NG-RAN to UTRAN procedure.
When present, it shall contain the E.164 number of the MSC Server selected by the MME_SRVCC. | Node Number | 2 | +| AMF Identifier | O | This IE may be sent by the target AMF to the source MME as specified in 3GPP TS 23.273 [91]. | NF Instance ID | 0 | +| Private Extension | O | | Private Extension | VS | +| NOTE 1: In the Forward Relocation Request message, the inclusion of "RAN Cause" indicates that the source access type is E-UTRAN. In the Forward Relocation Request message, the inclusion of "RANAP Cause" indicates that the source access type is UTRAN. In the Forward Relocation Request message, the inclusion of "BSSGP Cause" indicates that the source access type is GERAN. | | | | | +| NOTE 2: According to the 3GPP TS 23.401 [3], during an inter-RAT handover procedure for a UE with ISR activated, the source MME/SGSN should select the ISR associated CN node for this UE as the target CN node for the inter RAT HO when the ISR associated CN node can serve the target access. This parameter is exchanged when ISR is being activated and used in the source MME/SGSN for this decision upon subsequent inter-RAT handover. | | | | | + +Bearer Context IE in this message is specified in Table 7.3.2-2, the source system shall use this IE for data forwarding in handover. + +**Table 7.3.2-2: Bearer Context** + +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +|---------------------------------------------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | C | This IE shall be included if the message is used for S1-Based handover procedure, 5GS to EPS handover or EPS to 5GS handover.
This IE shall be included if the message is used for SRNS relocation procedure and Inter RAT handover to/from lu mode procedures. | EBI | 0 | +| Packet Flow ID | C | This IE shall be included if the message is used for PS handover and Inter RAT handover to/from A/Gb mode procedures. | Packet Flow ID | 0 | +| eNodeB/gNodeB F-TEID for DL data forwarding | C | This IE shall be included for the message sent from the target MME, if the DL Transport Layer Address and DL GTP TEID are included in the "SAE Bearers Admitted List" of the S1AP: HANDOVER REQUEST ACKNOWLEDGE and direct forwarding or indirect forwarding without SGW change is applied.
This IE shall be included during a 4G to 5G handover in the message sent from the target AMF, if the Data Forwarding Response E-RAB List IE is received in the NGAP HANDOVER REQUEST ACKNOWLEDGE and direct data forwarding applies. | F-TEID | 0 | +| eNodeB F-TEID for UL data forwarding | O | This IE may be included for the message sent from the target MME during the intra-EUTRAN HO, if the UL Transport Layer Address and UL GTP TEID are included in the "SAE Bearers Admitted List" of the S1AP: HANDOVER REQUEST ACKNOWLEDGE and direct forwarding or indirect forwarding without SGW change is applied. | F-TEID | 1 | +| SGW/UPF F-TEID for DL data forwarding | C | This IE shall be included when indirect data forwarding with SGW change is applied. | F-TEID | 2 | +| | CO | This IE shall be included when using indirect data forwarding during an EPS to 5GS handover or a 5GS to EPS handover. | | | +| RNC F-TEID for DL data forwarding | C | This RNC F-TEID shall be included in the message sent from SGSN, if the target system decides using RNC F-TEID for data forwarding. | F-TEID | 3 | +| SGSN F-TEID for DL data forwarding | C | This SGSN F-TEID shall be included in the message sent from SGSN, if the target system decides using SGSN F-TEID for data forwarding. | F-TEID | 4 | +| SGW F-TEID for UL data forwarding | O | If available this SGW F-TEID may be included when indirect data forwarding with SGW change is applied, during the intra-EUTRAN HO. | F-TEID | 5 | + +NOTE: The Bearer Context IE for an SCEF PDN connection shall only contain the EPS Bearer ID IE. + +### 7.3.3 Forward Relocation Complete Notification + +A Forward Relocation Complete Notification message shall be sent to the source MME/SGSN/AMF to indicate the handover has been successfully finished. + +Table 7.3.3-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.3.3-1: Information Elements in a Forward Relocation Complete Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Indication Flags | C | This IE shall be included if any of the flags are set to 1.
  • - Idle mode Signalling Reduction Activation Indication: This flag shall be set to 1 if the message is used for inter-RAT handover and the UE has ISR capability. This flag is set to indicate to the source MME/SGSN whether it shall maintain the UE's context and whether it shall activate ISR.
  • - Notify Source eNB Indication: This flag shall be set to 1 if the target MME receives this indication in the Handover Notify from the target eNodeB (see clause 5.5.1.2.2a of 3GPP TS 23.401 [3]).
  • - Same IWK-SCEF Selected for Monitoring Event Indication: This flag shall be set to 1 to indicate that the same IWK-SCEF is selected for Monitoring Event by the target MME/SGSN. See NOTE.
| Indication | 0 | +| Private Extension | O | | Private Extension | VS | +| NOTE: If the same IWK-SCEF is selected by the target MME/SGSN, the source MME/SGSN shall not delete the Monitoring Event Configuration(s) on the IWK-SCEF. | | | | | + +### 7.3.4 Forward Relocation Complete Acknowledge + +A Forward Relocation Complete Acknowledge message shall be sent as a response to Forward Relocation Complete Notification. + +Table 7.3.4-1 specifies the presence requirements and conditions of the IEs in the message. + +Possible Cause values are specified in Table 8.4-1. + +**Table 7.3.4-1: Information Elements in a Forward Relocation Complete Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-------------------------------------------------------------------------------------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|------| +| Cause | M | | Cause | 0 | +| Recovery | O | | Recovery | 0 | +| Secondary RAT Usage Data Report | CO | If the PLMN has configured secondary RAT usage reporting, the MME shall include this IE on the S10 interface if it has received Secondary RAT usage data from the eNodeB in an S1-based handover with MME relocation.
Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | Secondary RAT Usage Data Report | 0 | +| Secondary RAT Usage Data Report from NG-RAN | CO | This IE shall be included by a source AMF if it has received Secondary RAT Usage Report Data message from the source NG-RAN after sending a Handover Command message.

The AMF shall set the EBI field in the Secondary RAT Usage Data Report to any EBI pertaining to the same PDU session.

Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | Secondary RAT Usage Data Report | 1 | +| Private Extension | O | | Private Extension | VS | +| NOTE: The MME should be configured to know if the Secondary RAT Usage Data Report from NG-RAN should be sent to H-PLMN. | | | | | + +### 7.3.5 Context Request + +The new MME/SGSN shall send the Context Request message to the old MME/SGSN on S3/S16/S10 interface as a part of TAU/RAU procedure and UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure to get the MM and EPS bearer Contexts for the UE. + +NOTE 1: During UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure as specified in 3GPP TS 23.216 [43], the GUTI, RAI IE, P-TMSI IE and P-TMSI Signature IE, are not received directly from the UE but from the MSC Server over Sv interface. + +The new MME shall send the Context Request message to the old AMF on N26 interface as a part of an 5GS to EPS Idle mode Mobility using N26 interface procedure, to get the MM and EPS bearer Contexts for the UE. + +The new AMF shall send the Context Request message to the old MME on N26 interface as a part of an EPS to 5GS Idle mode registration using N26 interface procedure, to get the MM and EPS bearer Contexts for the UE. + +If the sending/new node is a MME, it shall include in the Context Request message: + +- the GUTI IE and Complete TAU Request Message IE, if the GUTI or the indication of mapped or native GUTI received from UE indicates the old node is a MME, as specified in clause 2.8.2.2.2 and 2.10.2.1.2 of 3GPP TS 23.003 [2]. +- the RAI IE and the P-TMSI IE, which are derived from the GUTI received from UE, and the P-TMSI Signature that was received intact from the UE, if the GUTI or the indication of mapped or native GUTI indicates the old node is an SGSN as specified in clause 2.8.2.2.2 of 3GPP TS 23.003 [2]. + +If the sending/new node is an SGSN, it shall include RAI IE, P-TMSI IE and P-TMSI Signature IE in the Context Request message. If the receiving/old node is an MME, it shall construct GUTI according to the RAI IE, P-TMSI IE and P-TMSI Signature IE (see the mapping relationship between RAI, P-TMSI, P-TMSI signature and GUTI defined in 3GPP TS 23.003 [2]), and find UE context via this GUTI. + +If the sending/new node is an AMF, it shall include the GUTI IE, which is derived from the 5G-GUTI received from UE, and the Complete TAU Request Message IE in the Context Request message, if the AMF receives a mapped GUTI from the UE, that is indication that the old node is an MME, as specified in clause 2.10.2.2.2 of 3GPP TS 23.003 [2]. + +If the receiving/old node is an AMF, it shall construct 5G-GUTI from the GUTI IE (see the mapping relationship between GUTI and 5G-GUTI defined in 3GPP TS 23.003 [2]), and find UE context via this 5G-GUTI. + +The new MME differentiates the type of the old node as specified in clause 2.8.2.2.2 of 3GPP TS 23.003 [2]. If the old node is an SGSN, the GUTI shall be mapped to RAI and P-TMSI by the new MME; if the old node is a MME, the new MME include GUTI IE and Complete TAU Request Message IE in the Context Request message. The Mapping between temporary and area identities is defined in 3GPP TS 23.003 [2]. + +The Target PLMN ID IE shall be used in old SGSN/MME in order to decide whether un-used authentication vectors to be distributed to new SGSN/MME/AMF or not. Distribution and use of authentication vectors between different serving network domains are specified in 3GPP TS 33.401 [12]. The AMF shall not transmit un-used authentication vectors to an MME and shall discard any un-used authentication vectors received from an MME, regardless of whether the MME and AMF pertain to the same or different serving network domains. + +Table 7.3.5-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.3.5-1: Information Elements in a Context Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-----------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|------| +| IMSI | C | IMSI shall be included if the UE has been successfully authenticated. | IMSI | 0 | +| GUTI | C | The new MME/AMF shall include this IE over S10/N26 interface if the IMSI is not present. | GUTI | 0 | +| | CO | This IE shall be included over S10 interface if available during UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure as specified in 3GPP TS 23.216 [43]. | | | +| Routeing Area Identity(RAI) | C | This IE shall be included over S3/S16 interface, if the GUTI or the indication of mapped or native GUTI indicates the old node is an SGSN, the new MME maps this IE from GUTI. | ULI (NOTE 4) | 0 | + +| | | | | | +|---------------------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|---| +| | CO | This IE shall be included over S3/S16 interface if available during UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure as specified in 3GPP TS 23.216 [43]. | | | +| Packet TMSI(P-TMSI) | C | This IE shall be included over S3/S16 interface if the IMSI is not present. For the S3 interface, if sent by the MME, this IE is derived by the MME from the GUTI received from the UE. | P-TMSI | 0 | +| | CO | This IE shall be included over S3/S16 interface if available during UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure as specified in 3GPP TS 23.216 [43]. | | | +| P-TMSI Signature | C | This IE shall be included over S3/S16 interface if it is received from the UE and if the IMSI is not present. | P-TMSI Signature | 0 | +| | CO | This IE shall be included over S3/S16 interface if available during UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure as specified in 3GPP TS 23.216 [43]. | | | +| Complete TAU request message | C | The new MME/AMF shall include this IE if available, and the old MME/AMF may use this IE for integrity check. See NOTE 3. | Complete Request Message | 0 | +| S3/S16/S10/N26 Address and TEID for Control Plane | C | This IE specifies the address and the TEID for control plane message which is chosen by the new MME/SGSN/AMF.
In case of SGSN pool, the IPv4 or the IPv6 address field shall be set to the same value of the Source IP address of the IP packet carrying this message, and the relaying SGSN shall not change the content of this IE when sending it to the old SGSN. See NOTE 1. | F-TEID | 0 | + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|----| +| UDP Source Port Number | C | If an SGSN within the same SGSN pool as the old SGSN receives this message, the SGSN shall include the UDP Source Port number of the received message in this parameter if this IE is not present and relay the message to the old SGSN. The old SGSN shall use this UDP port as the UDP destination port of the Context Response message. | Port Number | 0 | +| RAT Type | C | The RAT Type indicates the Radio Access Technology which is used in the new system. | RAT Type | 0 | +| Indication | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable Flags are:
  • - The MS Validated (MSV) flag, when set to 1, indicates that the new system has successfully authenticated the UE, or the new system has validated the integrity protection of the TAU request message. See NOTE 3.
  • - The ETHPDN flag, when set to 1, indicates that the target MME supports Ethernet PDN connection.
| Indication | 0 | +| Hop Counter | O | If an SGSN within the same SGSN pool with the old SGSN receives this message, the SGSN shall decrement the Hop Counter if this IE is present in the received message; otherwise, the SGSN may include a Hop Counter with a value of max-1, and may relay the message to the old SGSN. | Hop Counter | 0 | +| Target PLMN ID | CO | If available, this IE shall be included in order to allow old MME/SGSN to make a judgment whether un-used authentication vectors to be distributed or not. | Serving Network | 0 | +| MME/S4-SGSN LDN | O | This IE is optionally sent by the MME/S4-SGSN to the peer MME/S4-SGSN on the S3/S10/S16 interfaces (see 3GPP TS 32.423 [44]), when communicating the LDN to the peer node for the first time. | Local Distinguished Name (LDN) | 0 | +| SGSN node name | CO | This IE shall be sent by the new SGSN on the S3 interface if both new SGSN and associated SGW support ISR. See NOTE 2. | FQDN | 0 | +| MME node name | CO | This IE shall be sent by the new MME on the S3 interface if both new MME and associated SGW support ISR. See NOTE 2. | FQDN | 1 | +| SGSN Number | O | This IE may be sent by the target S4-SGSN to the source MME/S4-SGSN as specified in 3GPP TS 23.271 [56]. | Node Number | 0 | +| SGSN Identifier | O | This IE may be sent by the target S4-SGSN to the source MME/S4-SGSN as specified in 3GPP TS 23.271 [56]. | Node Identifier | 0 | +| MME Identifier | O | This IE may be sent by the target MME to the source MME/S4-SGSN as specified in 3GPP TS 23.271 [56]. | Node Identifier | 1 | +| CloT Optimizations Support Indication | CO | This IE shall be sent by the new MME/SGSN on the S10/S3/S16/N26 interface if it supports at least one CloT optimization.
This IE shall be sent by the new AMF on the N26 interface, with the AWOPDN bit set to 1 and, if Unstructured or Ethernet PDU session types are supported, with the SGNIPDN bit set to 1. | CloT Optimizations Support Indication | 0 | +| Private Extension | O | | Private Extension | VS | +| NOTE 1: The relaying SGSN shall forward the Context Request message to the interface of the old SGSN, where the interface type is matching what is indicated in the IE S3/S16/S10 Address and TEID for Control Plane. | | | | | +| NOTE 2: According to the 3GPP TS 23.401 [3], during an inter-RAT handover procedure for a UE with ISR activated, the source MME/SGSN should select the ISR associated CN node for this UE as the target CN node for the inter RAT HO when the ISR associated CN node can serve the target access. This parameter is exchanged when ISR is being activated and used in the source MME/SGSN for this decision upon subsequent inter-RAT handover. | | | | | +| NOTE 3: The Complete TAU request message IE is available except during UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure as specified in 3GPP TS 23.216 [43]. In these procedures, the new MME shall set the Indication IE MSV (MS Validated) flag to 1. | | | | | +| NOTE 4: Only RAI field in the ULI IE type shall be present in the Routing Area Identity (RAI) IE. | | | | | + +### 7.3.6 Context Response + +A Context Response message shall be sent as a response to a previous Context Request message, in the scenarios identified in clause 7.3.5. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "IMSI/IMEI not known" +- "P-TMSI Signature mismatch" +- "User authentication failed" +- "Target access restricted for the subscriber" + +Based on the subscription profile, when the access to the target RAT is prohibited for the subscriber, the old MME/SGSN/AMF may reject the Context Request message with the cause "Target access restricted for the subscriber". + +When the source MME/SGSN/AMF supports one or more of the CIoT optimization features as indicated through the CIoT Optimizations Support Indication IE specified in clause 8.125, and if the target node is a MME and the target MME has not set the AWOPDN bit of the CIoT Optimizations Support Indication IE set to 1 in the Context Request message as specified in clause 8.125, the source MME/SGSN/AMF shall reject the Context Request with a cause value of "Request Rejected" under the following conditions (conditions are mutually exclusive): + +- If the UE is attached to the source MME/SGSN without any PDN connection through the SGW and PGW and without any SCEF PDN connection; +- if the UE is attached to the source MME/SGSN with only the PDN connection(s) of PDN type "non-IP", through the SGW and the PGW but the UE has not activated any SCEF PDN connection and the target MME/AMF has not set the SGNIPDN bit of the CIoT Optimizations Support Indication IE set to 1 in the Context Request message as specified in clause 8.125; +- if the UE is attached to the the source MME/SGSN with only the SCEF PDN connection(s) but the UE has not activated any PDN connection through the SGW and PGW and the target MME has not set the SCNIPDN bit of the CIoT Optimizations Support Indication IE set to 1 in the Context Request message as specified in clause 8.125; +- if the UE is attached to the source MME/SGSN with only PDN connection(s) of PDN type "non-IP", through the SGW and the PGW and at least one SCEF PDN connection and the target MME has neither set the SGNIPDN bit nor the SCNIPDN bit of the CIoT Optimizations Support Indication IE set to 1 in the Context Request message as specified in clause 8.125; +- if the UE is registered to the source AMF without any PDU session; +- if the UE is registered to the source AMF with only PDU session(s) of type "Unstructured" or "Ethernet", and the target MME has not set the SGNIPDN bit of the CIoT Optimizations Support Indication IE set to 1 in the Context Request message as specified in clause 8.125. + +NOTE 2: Among the CIoT optimization features, only the support of SCEF Non-IP PDN connection and the support of SGi Non-IP PDN connection are applicable to a SGSN. + +NOTE 3: 5GS supports Attach without PDU session. 5GS can also support Unstructured and Ethernet PDU session types, which are assimilated to "SGi Non-IP PDN connections" over N26 if Ethernet PDN connection type in EPC is not supported; otherwise, the Ethernet PDU session in 5GS can move to EPC seamlessly. + +If the target node is a MME and the target MME has not set the ETHPDN bit in the Indication IE to 1 in the Context Request message as specified in clause 8.12, or the target node is a SGSN, the source MME shall reject the Context Request with a cause value of "Request Rejected" if the UE is attached to the source MME with only PDN connection(s) of PDN type "Ethernet". + +Table 7.3.6-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.3.6-1: Information Elements in a Context Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|----------------------------------------------------------|---------|------| +| Cause | M | | Cause | 0 | +| IMSI | C | The IMSI shall be included in the message except for the | IMSI | 0 | + +| | | | | | +|--------------------------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|---| +| | |

case:

  • - If the UE is emergency or RLOS attached and the UE is UICClassless.

The IMSI shall be included in the message but not used as an identifier

  • - if UE is emergency or RLOS attached but IMSI is not authenticated.
| | | +| MME/SGSN/AMF UE MM Context | C | This IE shall be included if the Cause IE has the value "Request Accepted". | MM Context | 0 | +| MME/SGSN/AMF UE EPS PDN Connections | C |

This IE shall be included if there is at least a PDN connection for this UE through the SGW and PGW on the sending MME/SGSN, or if there is at least a PDU session for this UE on the sending AMF.

If the target MME/SGSN/AMF has not set the SGNIPDN bit of the C IoT Optimizations Support Indication IE to 1 in the Context Request, then the source MME/SGSN/AMF shall only include PDN Connections of IP PDN type (if any). Several IEs with this type and instance values shall be included as necessary to represent a list of PDN Connections.

| PDN Connection | 0 | +| Sender F-TEID for Control Plane | C | This IE shall be included if the Cause IE has the value "Request Accepted". | F-TEID | 0 | +| SGW S11/S4 IP Address and TEID for Control Plane | C |

This IE shall be included if a SGW is being used by the old MME/SGSN, except if:

  • - the source and target MME/S4-SGSN support the MME/S4-SGSN triggered SGW restoration procedure, and the source MME/S4-SGSN has not performed the SGW relocation procedure after the source SGW has failed as specified in 3GPP TS 23.007 [17].
  • - across the S16 interface if there is no active PDP context
  • - across the S10/N26 interface if the UE does not have any PDN connection through the SGW and PGW.

This IE shall not be included by an old AMF.

| F-TEID | 1 | +| SGW node name | C |

This IE identifies the SGW that was used by the old MME/SGSN and it shall be included by the source MME/S4-SGSN with the following exceptions:

  • - the source and target MME/S4-SGSN support the MME/S4-SGSN triggered SGW restoration procedure, and the source MME/S4-SGSN has not performed the SGW relocation procedure after the source SGW has failed as specified in 3GPP TS 23.007 [17].
  • - across the S16 interface if there is no active PDP context
  • - across the S10/N26 interface if the UE does not have any PDN connection through the SGW and PGW.

This IE shall not be included by an old AMF.

| FQDN | 0 | + +| | | | | | +|------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---| +| Indication Flags | C |

This IE shall be included if any of the flags are set to 1.

Idle mode Signalling Reduction Supported Indication:

  • - This flag shall be set to 1 if the Cause IE value indicates "Request accepted" and the old system (including old MME/SGSN and the associated SGW) has the ISR capability.

Unauthenticated IMSI:

  • - This flag shall be set to 1 if the IMSI present in the message is not authenticated and is for an emergency or RLOS attached UE.

Change Reporting support indication flag:

  • - This flag shall be set to 1 if the Source S4-SGSN/MME supports Location Change Reporting mechanism. See NOTE 1. See NOTE 2.

CSG Change Reporting support indication flag:

  • - This flag shall be set to 1 if the Source S4-SGSN/MME supports CSG Information Change Reporting mechanism. See NOTE 1. See NOTE 2.

ISRAU:

  • - This flag shall be set to 1 on S10/S16 interface if the ISR is activated for the UE before the UE moving to the new SGSN/MME.

Management Based MDT allowed flag:

  • - This flag shall be set to 1 for the inter-MME TAU procedure over the S10 interface, if Management Based Minimization of Drive Tests (MDT) is allowed. See 3GPP TS 36.413 [10] and 3GPP TS 32.422 [18].

SGW Restoration Needed Indication (SRNI):

  • - This flag shall be set to 1 if both source and target MME/S4-SGSN support the MME/S4-SGSN triggered SGW restoration procedure and the source MME/S4-SGSN has not performed the SGW relocation procedure after the source SGW has failed as specified in 3GPP TS 23.007 [17].

CSFB Indication (CSFBI):

  • - when configured to support the return to the last used PLMN after CSFB, the MME shall set this flag to 1 on the S3 interface if the UE has been subject to CSFB recently (see clause 4.3.2 of 3GPP TS 23.272 [21]). See NOTE 4.

Buffered DL Data Waiting Indication (BDWI):

  • - This flag shall be set to 1 on the S3/S10/S16/N26 interface, during TAU/RAU with or without SGW change procedures or during Idle mode mobility between 5GS and EPS with data forwarding, when it is required to forward to the UE DL data buffered in the (old) SGW or (V-)SMF/UPF, i.e. when the DL Data Buffer Expiration Time has not expired yet in the old MME/SGSN/(V-)SMF, as specified in clause 4.3.17.7 of 3GPP TS 23.401 [3] and in clauses 4.11.1.3.2A, 4.11.1.3.3A, 4.23.12.2a and 4.23.12.3a of 3GPP TS 23.502 [83].

Pending MT Short Message Indication (PMTSMI):

  • - This flag shall be set to 1 on the S10/S16/S3 interface if the source S4-SGSN/MME knows that there is one (or more) pending MT Short Message(s) in the SMS-GMSC for the UE as specified in clause 10.1 of 3GPP TS 23.040 [75], Figure 17c).

LTE-M UE Indication (LTEMUI):

  • - This flag shall be set to 1 if the MME/AMF knows
| Indication | 0 | +|------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---| + +| | | | | | +|----------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|---| +| | | that the UE is an LTE-M UE.

Return Preferred Indication (REPREFI):
- the MME or the AMF may set this flag to 1 on the N26 interface to indicate a preferred return of the UE to the last used EPS or 5GS PLMN (respectively) at a later access change to an EPS or 5GS shared network. See NOTE 4. | | | +| Trace Information | C | This IE shall be included over S10/S16/S3 when session trace is active for this IMSI/IMEI. | Trace Information | 0 | +| HRPD access node S101 IP address | C | This IE shall be included only if the HRPD pre registration was performed at the old MME | IP-Address | 0 | +| 1xIWS S102 IP address | C | This IE shall be included only if the 1xRTT CS fallback pre registration was performed at the old MME | IP-Address | 1 | +| Subscribed RFSP Index | CO | This IE shall be included by the MME/SGSN/AMF, if received from the HSS or UDM. | RFSP Index | 0 | +| RFSP Index in Use | CO | This IE shall be included by the MME/SGSN/AMF, if it supports the feature. | RFSP Index | 1 | +| RFSP in Use Validity Time | O | This IE may be included by the source MME/AMF during 5GS to EPS mobility and subsequent inter-MME mobility procedures if the validity time has not expired yet. It indicates the validity time of RFSP Index in Use to be used in the target MME as specified in clause 4.11.1.5.8 of 3GPP TS 23.502 [83]. When present, this IE shall be set to the remaining validity time of the RFSP Index in Use. The AMF shall ignore this IE if it is received from the MME. | Timer in seconds | 0 | +| UE Time Zone | CO | When available, this IE shall be included by the source MME/S4-SGSN/AMF. | UE Time Zone | 0 | +| MME/S4-SGSN LDN | O | This IE is optionally sent by the MME/S4-SGSN to the peer MME/S4-SGSN on the S3/S10/S16 interfaces (see 3GPP TS 32.423 [44]), when communicating the LDN to the peer node for the first time. | Local Distinguished Name (LDN) | 0 | +| MDT Configuration | CO | This IE shall be sent by the source MME to the target MME on the S10 interface for inter-MME TAU procedure, if the Job Type indicates Immediate MDT. See 3GPP TS 32.422 [18] clause 4.4. | MDT Configuration | 0 | +| SGSN node name | CO | This IE shall be sent by the old SGSN on the S3 interface if both old SGSN and associated SGW support ISR. See NOTE 3. | FQDN | 1 | +| MME node name | CO | This IE shall be sent by the old MME on the S3 interface if both old MME and associated SGW support ISR. See NOTE 3. | FQDN | 2 | +| User CSG Information (UCI) | CO | This IE shall be sent by the source MME/S4-SGSN on the S3/S10/S16 interfaces if the source MME/SGSN has reported to the PGW that the UE is in a CSG or hybrid cell. It shall then contain the last User CSG information that the source MME/S4-SGSN has reported to the PGW. The absence of this IE indicates that the UE has not been reported to the PGW as being in a CSG or hybrid cell. See NOTE 5. | UCI | 0 | +| Monitoring Event Information | CO | This IE shall be sent by the source MME/S4-SGSN on the S3/S10/S16 interfaces if monitoring events are to be continued in the target MME/S4-SGSN. More than one IE with this type and instance values may be included to represent multiple monitoring events. | Monitoring Event Information | 0 | +| Monitoring Event Extension Information | CO | This IE shall be sent by the source MME/S4-SGSN on the S3/S10/S16 interfaces if monitoring event extensions are to be sent to the target MME/S4-SGSN. More than one IE with this type and instance values may be included to represent multiple monitoring event extensions. | Monitoring Event Extension Information | 0 | +| UE Usage Type | CO | This IE shall be set to the subscribed UE Usage Type, if received from the HSS, and sent by the old MME/SGSN on the S3/S10/S16 interfaces if the old MME/SGSN supports the Dedicated Core Networks feature specified in TS 23.401 [3].

This IE shall be set to the subscribed UE Usage Type, if received from the UDM, and sent by the old AMF on the | Integer Number | 0 | + +| | | | | | +|----------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---| +| | | N26 interface.
If the UE Usage Type is not available in the old MME/SGSN/AMF, the length field of this IE shall be set to 0.
See NOTE 6. | | | +| MME/SGSN UE
SCEF PDN
Connections | C | This IE shall be included if there is at least one SCEF PDN connection for this UE at the source MME/SGSN and if the target MME/SGSN has set the SCNIPDN bit of the CIOt Optimizations Support Indication IE to 1 in the Context Request as specified in clause 8.125.
Several IEs with this type and instance values shall be included as necessary to represent a list of SCEF PDN Connections. | SCEF PDN
Connection | 0 | +| RAT Type | CO | This IE shall be included by the source MME, SGSN or AMF on the S10, S16, S3 and N26 interface to indicate the old RAT type where the UE was camping. See NOTE 7. | RAT Type | 0 | + +| | | | | | +|----------------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|----| +| Serving PLMN Rate Control | CO | This IE shall be included by the old MME on the S10 interface if such Serving PLMN Rate control was enabled when there is at least one SGi or SCEF PDN connection with the Control Plane Only Indication set. See NOTE 8. | Serving PLMN Rate Control | 0 | +| MO Exception Data Counter | CO | This IE shall be included on the S10 interfaces if the source MME has not yet reported a non-zero MO Exception Data Counter to the PGW. The timestamp in the counter shall be set with the time at which the counter value increased from 0 to 1. | Counter | 0 | +| Remaining Running Service Gap Timer | CO | This IE shall be included on the S10 interface if the source MME has started a Service Gap Timer which has not expired yet, as specified in clauses 5.3.3.1 and 5.3.3.2 in 3GPP TS 23.401 [3].
The value of the IE indicates the remaining time before the Service Gap Timer expires in number of seconds. See NOTE 9. | Integer Number | 1 | +| Extended Trace Information | C | This IE shall be included over N26 when session trace is active for this user. | Extended Trace Information | 0 | +| Subscribed Additional RRM Policy Index | CO | This IE shall be included by the MME over the S10 interface if received from the HSS. | Additional RRM Policy Index | 0 | +| Additional RRM Policy Index in Use | CO | This IE shall be included by the MME over the S10 interface if the feature is supported by the MME. | Additional RRM Policy Index | 1 | +| IWK SCEF ID for Monitoring Event | CO | This IE shall be included on the S3/S10 interface if the source MME/SGSN has selected the IWK-SCEF to relay Monitoring Events. | Node Identifier | 0 | +| Alternative IMSI | CO | This IE shall be included by the old MME over the S10 interface if it has stored an Alternative IMSI as specified in TS 23.401 [3] clause 5.7.2. | Alternative IMSI | 0 | +| MSISDN | CO | This IE shall be present over the S10/N26 interface if the UE's MSISDN is available. | MSISDN | 0 | +| Private Extension | O | | Private Extension | VS | + +NOTE 1: 3GPP TS 23.401 [3] (e.g. clause 5.3.2.1) and 3GPP TS 23.060 [35] (e.g. clause 9.2.2.1) defines the MME/SGSN shall send the MS Info Change Reporting Support Indication to the PGW. In such case MME/SGSN shall use the Change Reporting Support Indication and/or CSG Change Reporting Support Indication (whichever is applicable), even if stage 2 refers to MS Info Change Reporting Support Indication. + +NOTE 2: The receiver shall ignore the per UE Change Reporting Support Indication and CSG Change Reporting Support Indication flags, as included within the Indication Flags IE above, if these flags are included per PDN connection i.e. within the Indication Flags IE of the MME/SGSN UE EPS PDN Connections IE. + +NOTE 3: According to the 3GPP TS 23.401 [3], during an inter-RAT handover procedure for a UE with ISR activated, the source MME/SGSN should select the ISR associated CN node for this UE as the target CN node for the inter RAT HO when the ISR associated CN node can serve the target access. This parameter is exchanged when ISR is being activated and used in the source MME/SGSN for this decision upon subsequent inter-RAT handover. + +NOTE 4: If the SGSN needs to include the last used LTE PLMN ID in the Equivalent PLMN list it sends to the UE (see 3GPP TS 23.272 [21]), the SGSN shall derive the last used LTE PLMN ID from the Old RAI IE received in the RAU request message. If an MME or AMF needs to store the last used 5GS or EPS PLMN ID (respectively), the MME shall derive the last used 5GS PLMN ID from the Old GUTI received in the TAU request message, the AMF shall derive the last used EPS PLMN ID from the 5GS mobile identity received in Registration request message. + +NOTE 5: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator for supporting UEs, or that of the allocated Core Network Operator for non-supporting UEs. As an exception, based on inter-operator roaming/sharing agreement, if the information on whether the UE is a supporting or non-supporting UE is available, the PLMN ID that is communicated to the HPLMN for non-supporting UEs shall be the Common PLMN ID. +In shared networks, when the MME/S4-SGSN and PGW pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI to the PGW, and the Common PLMN ID shall be communicated in SAI/CGI to the PGW, for both supporting and non-supporting UEs. The Core Network Operator PLMN ID (selected by the UE for supporting UEs or allocated by the network for non-supporting UEs) shall be communicated in the TAI, RAI, UCI and the Serving Network. See clause 4.4 of 3GPP TS 23.251 [55]. + +NOTE 6: A UE Usage Type IE with the length field equal to 0 is used for the receiver to differentiate the case where the sender does not support the Dedicated Core Network feature from the case where the sender supports the Dedicated Core Network feature but no UE Usage type was received in UE's subscription. + +| | | +|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 7: | The old RAT shall be used by the target MME/SGSN to determine if the RAT type has changed and, if so, to decide whether to maintain or deactivate the PDN connections of the UE based on the PDN-Connection-Continuity subscription parameter and operator policy, as specified in 3GPP TS 23.401 [3] and 3GPP TS 23.060 [35]. A target MME shall consider that the RAT type has changed if the target RAT is NB-IoT and a source MME (complying with an earlier version of the specification) does not include the RAT Type IE in the Context Response. | +| NOTE 8: | The target MME may compare the value of the Serving PLMN Rate Control received in the Context Response message with the one configured locally, to determine if such parameter needs to be updated towards the SCEF and/or PGW. | +| NOTE 9: | If the serving MME has changed after the TAU procedure, the target MME shall start Service Gap timer and should use a value that is slightly shorter than the value received in this IE. | + +**Table 7.3.6-2: MME/SGSN/AMF UE EPS PDN Connections within Context Response** + +| Octet 1 | PDN Connection IE Type = 109 (decimal) | | | | +|------------------------------------------------|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|------| +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| APN | M | | APN | 0 | +| APN Restriction | C | This IE denotes the restriction on the combination of types of APN for the APN associated with this EPS bearer Context. The target MME or SGSN determines the Maximum APN Restriction using the APN Restriction. If available, the source MME/S4 SGSN shall include this IE. | APN Restriction | 0 | +| Selection Mode | CO | When available, this IE shall be included by the source MME/S4-SGSN/AMF. | Selection Mode | 0 | +| IPv4 Address | C | This IE shall not be included if no IPv4 Address is assigned. See NOTE 1. See NOTE 5. | IP Address | 0 | +| IPv6 Address | C | This IE shall not be included if no IPv6 Address is assigned. See NOTE 5. | IP Address | 1 | +| Linked EPS Bearer ID | M | This IE identifies the default bearer of the PDN Connection. | EBI | 0 | +| PGW S5/S8 IP Address for Control Plane or PMIP | M | This IE shall include the TEID in the GTP based S5/S8 case and the uplink GRE key in the PMIP based S5/S8 case. See NOTE 3. | F-TEID | 0 | +| PGW node name | C | This IE shall be included if the source MME, SGSN or AMF has the PGW FQDN. | FQDN | 0 | +| | CO | This IE shall be included by the source MME over the N26 interface. See NOTE 6. | | | +| Bearer Contexts | M | Several IEs with this type and instance values may be included as necessary to represent a list of Bearers. | Bearer Context | 0 | +| Aggregate Maximum Bit Rate (APN-AMBR) | M | | AMBR | 0 | +| Charging characteristics | C | This IE shall be present if charging characteristics was supplied by the HSS to the MME/SGSN, or by the UDM to the SMF, as a part of subscription information. | Charging characteristics | 0 | +| Change Reporting Action | C | This IE shall be included whenever available at the source MME/SGSN. See NOTE 4. | Change Reporting Action | 0 | +| CSG Information Reporting Action | CO | This IE shall be included whenever available at the source MME/SGSN. | CSG Information Reporting Action | 0 | +| H(e)NB Information Reporting | CO | This IE shall be included whenever available at the source MME/SGSN. | H(e)NB Information Reporting | 0 | + +| | | | | | +|--------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---| +| Indication flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags:
  • - Subscribed QoS Change Indication: This flag shall be set to 1 if the subscribed QoS profile of the related PDN connection has changed in the old MME/SGSN when the UE is in ECM-IDLE state and ISR is activated.
  • - Change Reporting support indication flag: This flag shall be set to 1 if the source S4-SGSN/MME supports Location Change Reporting mechanism and if the S4-SGSN/MME has indicated the support for the Location Change Reporting mechanism to the PGW, during the session establishment and/or modification procedures. See NOTE 2.
  • - CSG Change Reporting Support Indication flag: This flag shall be set to 1 if the Source S4-SGSN/MME supports CSG Information Change Reporting mechanism and if the S4-SGSN/MME has indicated the support for the CSG Information Change Reporting to the PGW, during the session establishment and/or modification procedures. See NOTE 2.
  • - Pending Subscription Change Indication flag: This flag shall be set to 1 if the source MME has received Subscribed QoS profile updates for QCI/ARP/APN-AMBR from the HSS but has deferred the reporting of these updates to the PGW/PCRF because the UE was not reachable.
  • - Pending Network Initiated PDN Connection Signalling Indication flag: This flag shall be set to 1 by the source MME/SGSN if there is pending network initiated signalling for the PDN connection.
  • - Delay Tolerant Connection Indication flag: This flag shall be set to 1 interface by the source MME/SGSN if the PGW indicated that this PDN Connection is delay tolerant.
  • - Extended PCO Support Indication flag: This flag shall be set to 1 on S10/N26 interface by the source MME if the UE and the source MME support Extended PCO. It shall be set to 1 on the N26 interface during a 5GS to EPS Idle mode mobility.
  • - Control Plane Only PDN Connection Indication: This flag shall be set to 1 if the PDN Connection is set to Control Plane Only.
  • - NO 5GS N26 mobility Indication flag: This flag shall be set to 1 on S10 interface if the PDN connection cannot be moved to 5GS via N26.
| Indication | 0 | +| Signalling Priority Indication | CO | The source SGSN/MME shall include this IE if the UE indicated low access priority when establishing the PDN connection. | Signalling Priority Indication | 0 | +| Change to Report Flags | CO | This IE shall be included by the MME/SGSN if any one of the applicable flags is set to 1.
Applicable flags:
  • - Serving Network Change to Report: This flag shall be set to 1 if the source MME/SGSN has detected a Serving Network change during a TAU/RAU procedure without MME/SGSN change but has not yet reported this change to the PGW.
| Change To Report Flags | 0 | + +| | | | | | +|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--| +| | |
  • - Time Zone Change to Report: This flag shall be set to 1 if the source MME/SGSN has detected a UE Time Zone change during a TAU/RAU procedure without MME/SGSN change but has not yet reported this change to the PGW.
| | | +|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--| + +| | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|---| +| Local Home Network ID | CO | This IE shall be sent over the S3/S10/S16 interface if SIPTO at the Local Network is active for the PDN connection in the SIPTO at the Local Network architecture with stand-alone GW. | FQDN | 1 | +| Presence Reporting Area Action | CO | This IE shall be included if the PGW requested the source MME/SGSN to report changes of UE presence in a Presence Reporting Area. The source MME/SGSN shall include the Presence Reporting Area Identifier and, if received from the PGW, the list of the Presence Reporting Area elements.

Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Actions. One IE shall be included for each Presence Reporting Area. | Presence Reporting Area Action | 0 | +| WLAN Offloadability Indication | CO | If the MME/SGSN supports WLAN/3GPP Radio Interworking with RAN rules then this IE shall be included on S3/S10/S16 if the UE has been authorized to perform WLAN offload for at least one RAT. | WLAN Offloadability Indication | 0 | +| Remote UE Context Connected | CO | The source MME shall include this IE on the S10 interface during an inter MME mobility procedure if such information is available.

Several IEs with the same type and instance value may be included as necessary to represent a list of remote UEs connected. | Remote UE Context | 0 | +| PDN Type | CO | The source MME/SGSN/AMF shall include this IE on the S10/S3/S16/N26 interface, for a Non-IP or Ethernet PDN Connection, during an inter MME/SGSN/AMF mobility procedure if the new MME/SGSN/AMF supports non-IP or Ethernet PDN connection using SGi as indicated in the Context Request message. | PDN Type | 0 | +| Header Compression Configuration | CO | This IE shall be sent over the S10 interface if the use of IP Header Compression for Control Plane CLoT EPS optimisations has been negotiated with the UE and the target MME has set the IHCSI bit of the CLoT Optimizations Support Indication IE to 1 in the Context Request as specified in clause 8.125. | Header Compression Configuration | 0 | +| PGW Change Info | CO | This IE shall be sent over the S10/N26 interface if available from a source AMF/MME to a target MME. See clause 31.5 of 3GPP TS 23.007 [17]. | PGW Change Info | 0 | +| UP Security Policy | CO | This IE shall be sent by the old MME on the S10 interface or by the old AMF on the N26 interface if this information is available. When present, it shall indicate whether User Plane integrity protection is required, preferred or not needed for the traffic of the PDN connection. | UP Security Policy | 0 | +| NOTE 1: For deferred IPv4 address allocation, if the MME/S4-SGSN receives the PDN address "0.0.0.0" from PGW during "eUTRAN Initial Attach", "PDP Context Activation", "UE requested PDN Connectivity", then the MME/S4-SGSN shall include this IPv4 address "0.0.0.0". | | | | | +| NOTE 2: 3GPP TS 23.401 [3] (e.g. clause 5.3.2.1) and 3GPP TS 23.060 [35] (e.g. clause 9.2.2.1) defines the MME/SGSN shall send the MS Info Change Reporting Support Indication to the PGW. In such case MME/SGSN shall use the Change Reporting Support Indication and/or CSG Change Reporting Support Indication (whichever is applicable), even if stage 2 refers to MS Info Change Reporting Support Indication. | | | | | +| NOTE 3: For PMIP based S5/S8, the 'PGW S5/S8 IP Address and TEID for user plane' IE and the 'PGW S5/S8 IP Address for Control Plane or PMIP' IE shall contain the same uplink GRE key; the Interface Type in these IEs shall be set to the value 9 (S5/S8 PGW PMIPv6 interface). | | | | | +| NOTE 4: The target MME (respectively S4-SGSN) shall ignore this IE if it is received from an S4-SGSN (respectively an MME), i.e. over the S3 interface. In this case, the target serving node shall consider that no ULI change reporting is requested by the PGW for the target RAT, and the PGW shall request the target serving node to start ULI change reporting for the target RAT if so desired. | | | | | +| NOTE 5: For Non-IP or Ethernet PDN connections, neither an IPv4 address nor an IPv6 address shall be present. | | | | | +| NOTE 6: The PGW Node Name is used by the target AMF in the NF Service Discovery procedure to find the combined PGW-C/SMF for the PDU Session during an MME to AMF mobility procedure. | | | | | + +The Bearer Context shall be coded as depicted in Table 7.3.6-3. + +**Table 7.3.6-3: Bearer Context within MME/SGSN/AMF UE EPS PDN Connections within Context Response** + +| | | | | | +|------------------------------------------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------| +| Octet 1 | Bearer Context IE Type = 93 | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Sparse and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | See NOTE 4. | EBI | 0 | +| TFT | C | This IE shall be present if a TFT is defined for this bearer. | Bearer TFT | 0 | +| SGW S1/S4/S12/S11 IP Address and TEID for user plane | C |

The IE shall be present except if:

  • - the source and target MME/S4-SGSN support the MME/S4-SGSN triggered SGW restoration procedure, and the source MME/S4-SGSN has not performed the SGW relocation procedure after the SGW has failed as specified in 3GPP TS 23.007 [17].

Over the N26 interface, the SMF (on behalf of the source AMF) shall set the IP address and TEID to the following values:

  • - any reserved TEID (e.g. all 0's, or all 1's);
  • - IPv4 address set to 0.0.0.0, or IPv6 Prefix Length and IPv6 prefix and Interface Identifier all set to zero.

See NOTE 2, NOTE3 and NOTE 5.

| F-TEID | 0 | +| PGW S5/S8 IP | C | This IE shall be included for GTP based S5/S8. | F-TEID | 1 | + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---| +| Address and TEID for user plane | CO | For PMIP-based S5/S8, this IE shall be included if the PGW provided an alternate address for user plane, i.e. an IP address for user plane which is different from the IP address for control plane.
When present, this IE shall contain the alternate IP address for user plane and the uplink GRE key.
See NOTE 1. | | | +| Bearer Level QoS | M | | Bearer QoS | 0 | +| BSS Container | CO | The MME/S4 SGSN shall include the Packet Flow ID, Radio Priority, SAPI, PS Handover XID parameters in the TAU/RAU/Handover procedure, if available. The Container Type shall be set to 2. | F-Container | 0 | +| Transaction Identifier | C | This IE shall be sent over S3/S10/S16 if the UE supports A/Gb and/or Iu mode. | TI | 0 | +| SGW S11 IP Address and TEID for user plane | CO | This IE shall be sent over S3/S10/S16 if the UE supports A/Gb and/or Iu mode. This IE should be sent over N26 if the MME has a TI stored that is linked with this EPS Bearer ID, or, the SMF provides the TI to the AMF (as part of a procedure to deliver SM context to AMF). | F-TEID | 2 | +| NOTE 1: For PMIP based S5/S8, the 'PGW S5/S8 IP Address and TEID for user plane' IE and the 'PGW S5/S8 IP Address for Control Plane or PMIP' IE shall contain the same uplink GRE key; the Interface Type in these IEs shall be set to the value 9 (S5/S8 PGW PMIPv6 interface). | | | | | +| NOTE 2: The MME shall set the interface type in this IE to 1, i.e "S1-U SGW GTP-U interface", for S1-U and S11-U bearers. This is done for backwards compatibility reasons, when the target serving node does not support CIoT optimizations. | | | | | +| NOTE 3: When separate IP address spaces are used for S1-U and S11-U, the MME shall include both S1-U SGW F-TEID in the SGW S1/S4/S12/S11 IP Address and TEID for user plane IE and S11-U SGW F-TEID in SGW S11 IP Address and TEID for user plane, when they are available; otherwise, the source MME shall include the SGW S1/S4/S12/S11 IP Address and TEID for user plane IE, since S1-U and S11-U SGW F-TEID are the same. | | | | | +| NOTE 4: The support of the 15 EPS Bearers shall be homogeneously supported within an MME Pool / SGW serving area. A source MME which supports the 15 EPS Bearers, shall know whether the target MME pool also supports that by local configuration. When the target MME is known to not support the 15 EPS Bearers, the source MME shall only transfer up to 8 EPS bearer contexts with the EBI value set between '5' and '15' to the target MME and shall delete EPS bearer(s) which are not transferred, and if the default bearer is to be deleted, the corresponding PDN connection(s) shall be deleted by the source MME. | | | | | +| NOTE 5: During 5GS to EPS mobility procedures with N26 interface, the source AMF shall transparently transfer the MME/SGSN/AMF UE EPS PDN Connections IE received from the SMF as specified in clause 6.1.6.2.27 of 3GPP TS 29.502[88]. | | | | | + +**Table 7.3.6-4: Remote UE Context Connected within MME/SGSN UE EPS PDN Connections within Context Response** + +| | | | | | +|-----------------------------|-------------------------------------------|----------------------------------------------------------------|--------------------------|-------------| +| Octets 1 | Remote UE Context IE Type = 191 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octets 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| Remote User ID | M | See clause 8.123 for the description and use of this parameter | Remote User ID | 0 | +| Remote UE IP Information | M | See clause 8.124 for the description and use of this parameter | Remote UE IP Information | 0 | + +**Table 7.3.6-5: MME/SGSN UE SCEF PDN Connections within Context Response** + +| | | | | | +|-----------------------------|-------------------------------------------|---------------------------------------------------------------------------|-----------------|-------------| +| Octets 1 | SCEF PDN Connection IE Type = x (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octets 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| APN | M | | APN | 0 | +| Default EPS Bearer ID | M | This IE identifies the default bearer of the SCEF PDN Connection. | EBI | 0 | +| SCEF ID | M | This IE shall include the SCEF Identifier and the SCEF Realm for the APN. | Node Identifier | 0 | + +**Table 7.3.6-6: PGW Change Info with Context Response** + +| | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------| +| Octet 1 | PGW Change Info IE Type = 214 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| PGW Set FQDN | CO | This IE shall be included by the source MME if available.

When present, this IE shall contain the PGW Set FQDN of the PGW-C/SMF set to which the PGW-C/SMF belongs.
(NOTE) | PGW FQDN | 0 | +| Alternative PGW-C/SMF IP Address | CO | This IE shall be included by the source MME if available.

When present, this IE shall contain alternative PGW-C/SMF IP addresses within the PGW-C/SMF set to which the PGW-C/SMF belongs.

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF IP Addresses.
(NOTE) | IP Address | 0 | +| Alternative PGW-C/SMF FQDN | CO | This IE shall be included by the source MME if available.

When present, this IE shall contain alternative PGW-C/SMF FQDN within the PGW-C/SMF set to which the PGW-C/SMF belongs.

Several IEs with the same type and instance value may be included to represent a list of Alternative PGW-C/SMF FQDNs.
(NOTE) | PGW FQDN | 1 | +| Group Id | CO | This IE shall be included by the source MME if available.

When present, this IE shall identify the group to which the PDN connection pertains (see clause 31.6 of 3GPP TS 23.007 [17]). | Group Id | 0 | +| NOTE: Either the PGW Set FQDN IE, the Alternative PGW-C/SMF IP Address IE, or the Alternative PGW-C/SMF FQDN IE shall be present. | | | | | + +### 7.3.7 Context Acknowledge + +A Context Acknowledge message shall be sent as a response to a previous Context Response message, only if the previous Context Response message is received with the acceptance cause. + +Possible cause values are specified in Table 8.4-1. Message specific cause values are: + +- "User authentication failed". +- "Relocation failure due to NAS message redirection". + +- "Denied in RAT". + +Upon receiving cause value other than the request was accepted, the old MME/S4-SGSN shall continue as if the Context Request was never received. + +Table 7.3.7-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.3.7-1: Information Elements in a Context Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|------| +| Cause | M | | Cause | 0 | +| Indication flags | C | This IE shall be included if any one of the applicable flags is set to 1.
Applicable Flags are:
  • - SGW Change Indication: This flag shall be set to 1 on the S3/S10/S16 interfaces if a new SGW has been selected. The old MME/old SGSN marks in its context that the information in the GWs and the HSS are invalid.
    This flag shall also be set to 1 by the new AMF/new MME during the Idle mode Mobility between 5GS and EPS using N26 interface.
  • - Idle mode Signalling Reduction Activation Indication: If set to 1, this flag indicates to the old system that it shall maintain the UE's contexts. This flag shall be set to 1 on the S3 interface if the Cause IE value indicates "Request accepted" and ISR is activated as specified in 3GPP TS 23.401 [3].
  • - Same IWK-SCEF Selected for Monitoring Event Indication: This flag shall be set to 1 to indicate that the same IWK-SCEF is selected for Monitoring Event by the target MME/SGSN.
See NOTE 1, NOTE 2. | Indication | 0 | +| Forwarding F-TEID | CO | This IE shall be included if only one bearer context was transferred in the Context Response message and data forwarding of DL data buffered in the old SGW or (V-)SMF/UPF is required, i.e. when the BDWI flag is set in the Context Response message and
  • - the SGW is changed, during TAU/RAU procedure with SGW change and data forwarding as specified in clause 5.3.3.1A of 3GPP TS 23.401 [3]; or
  • - upon idle mode mobility between EPS and 5GS with data forwarding, as specified in clauses 4.11.1.3.2A, 4.11.1.3.3A, 4.23.12.2a and 4.23.12.3a of 3GPP TS 23.502 [83].
The interface type of the Forwarding F-TEID should be set to either:
  • - 23 ("SGW/UPF GTP-U interface for DL data forwarding") for indirect forwarding,
  • - 0 (" S1-U eNodeB GTP-U interface") or 3 ("S12 RNC GTP-U interface"), if the eNB or RNC supports such forwarding, or
  • - 15 ("S4 SGSN GTP-U interface").
| F-TEID | 0 | +| Bearer Contexts | CO | This IE shall be included if multiple bearer contexts were transferred in the Context Response message and data forwarding of DL data buffered in the old SGW or (V-)SMF/UPF is required, i.e. when the BDWI flag is set in the Context Response message and
  • - the SGW is changed, during TAU/RAU procedure with SGW change and data forwarding as specified in the clause 5.3.3.1A of 3GPP TS 23.401 [3]; or
  • - upon idle mode mobility between EPS and 5GS, as specified in clauses 4.11.1.3.2A, 4.11.1.3.3A, 4.23.12.2a and 4.23.12.3a of 3GPP TS 23.502 [83].
Several IEs with this type and instance value may be included as necessary to represent a list of Bearers. | Bearer Context | 0 | +| SGSN Number | CO | This IE shall be included on the S16/S3 interface if the PMTSMI flag in the Context Response message is set to 1. | Node Number | 0 | +| MME number for MT | CO | This IE shall be included on the S10/S3 interface if the | Node Number | 1 | + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|----| +| SMS | | PMTSMI flag in the Context Response message is set to 1. | | | +| SGSN Identifier for MT SMS | CO | This IE shall be included on the S16/S3 interface if the target S4-SGSN supports the Gdd reference point and if the PMTSMI flag in the Context Response message is set to 1. | Node Identifier | 0 | +| MME Identifier for MT SMS | CO | This IE shall be included on the S10/S3 interface if the target MME supports the SGd reference point and if the PMTSMI flag in the Context Response message is set to 1. | Node Identifier | 1 | +| Private Extension | O | | Private Extension | VS | +| NOTE 1: For the Indication Flags, the combination (SGW Change Indication, Idle mode signalling Activation Indication) = 1,1 shall be considered as an error if received. | | | | | +| NOTE 2: If the same IWK-SCEF is selected by the target MME/SGSN, the source MME/SGSN shall not delete the Monitoring Event Configuration(s) on the IWK-SCEF. | | | | | + +**Table 7.3.7-2: Bearer Context within Context Acknowledge** + +| | | | | | +|-----------------------------|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------| +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| EPS Bearer ID | M | | EBI | 0 | +| Forwarding F-TEID | M | The interface type of the Forwarding F-TEID should be set to either:
  • - 23 ("SGW/UPF GTP-U interface for DL data forwarding") for indirect forwarding,
  • - 0 ("S1-U eNodeB GTP-U interface") or 3 ("S12 RNC GTP-U interface"), if the eNB or RNC supports such forwarding, or
  • - 15 ("S4 SGSN GTP-U interface").
| F-TEID | 0 | + +### 7.3.8 Identification Request + +If the UE identifies itself with temporary identity and it has changed SGSN/MME since detach in Attach procedure, the new MME/SGSN shall send an Identification Request message to the old SGSN/MME/AMF over S3, S16, S10 or N26 interface to request IMSI. A new AMF may also send an Identification Request message to the old MME over the N26 interface, during a registration procedure (see clause 4.11.5.2 of 3GPP TS 23.502 [83]). + +Table 7.3.8-1 specifies the presence requirements and conditions of the IEs in the message. + +If the sending/new node is an MME, it shall include in the Identification Request message: + +- the GUTI IE and Complete Attach Request Message IE, if the GUTI or the indication of mapped or native GUTI received from UE indicates the old node is a MME, as specified in clause 2.8.2.2.2 of 3GPP TS 23.003 [2]. +- the RAI P-TMSI, which was derived from the GUTI received from UE, and the P-TMSI Signature that was received intact from the UE, if the GUTI or the indication of mapped or native GUTI indicates the old node is an SGSN as specified in clause 2.8.2.2.2 of 3GPP TS 23.003 [2]. + +If the sending/new node is an SGSN, it shall include RAI IE, P-TMSI IE and P-TMSI Signature IE in the Identification Request message. If the receiving/old node is an MME, it shall construct GUTI according to the RAI IE, P-TMSI IE and P-TMSI Signature IE (see the mapping relationship between RAI, P-TMSI, P-TMSI signature and GUTI defined in 3GPP TS23.003[2]), and find UE context via this GUTI. + +If the sending/new node is an AMF, it shall include the GUTI IE and Complete Attach Request Message IE in the Identification Request message. The AMF shall construct the GUTI IE from the old 5G-GUTI received from the UE (mapped from the EPS GUTI by the UE), as specified in clause 2.10.2.2.3 of 3GPP TS 23.003 [2]. + +The new MME differentiates the type of the old node as specified in clause 2.8.2.2.2 of 3GPP TS 23.003 [2]. If the old node is an SGSN, the GUTI shall be mapped to RAI and P-TMSI by the new MME; if the old node is a MME, the new MME include GUTI IE and Complete Attach Request Message IE in the Identification Request message. The Mapping between temporary and area identities is defined in 3GPP TS 23.003 [2]. + +The GUTI IE shall not coexist with any of the RAI IE, P-TMSI IE and P-TMSI Signature IE in an Identification Request message. If this occurs, the receiving node shall return a corresponding cause value in the response message. + +The Target PLMN ID IE shall be used in old SGSN/MME in order to decide whether un-used authentication vectors to be distributed to new SGSN/MME or not. Distribution and use of authentication vectors between different serving network domains are specified in 3GPP TS 33.401 [12]. + +If the receiving/old node is an AMF, it shall construct the 5G-GUTI from the GUTI IE (see the mapping relationship between GUTI and 5G-GUTI defined in clause 2.10 of 3GPP TS 23.003 [2]), and find UE context via this 5G-GUTI. + +**Table 7.3.8-1: Information Elements in an Identification Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|---------------------------------|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|------| +| GUTI | C | The new MME/AMF shall include this IE over the S10 and N26 interfaces. | GUTI | 0 | +| Routeing Area Identity(RAI) | C | This IE shall be included over S3/S16 interface, if the GUTI or the indication of mapped or native GUTI received from the UE indicates the old node is an SGSN, the new MME maps this IE from GUTI. | ULI (NOTE 1) | 0 | +| Packet TMSI(P-TMSI) | C | This IE shall be included over S3/S16 interface. For the S3 interface, if sent by the MME, this IE is derived by the MME from the GUTI received from the UE. | P-TMSI | 0 | +| P-TMSI Signature | C | This IE shall be included over S3/S16 interface, if it is received from the UE. | P-TMSI Signature | 0 | +| Complete Attach Request Message | C | The new MME/AMF shall include this IE over the S10 and N26 interfaces, and the old MME/AMF may use this IE for integrity check. | Complete Request Message | 0 | +| Address for Control Plane | O | If an SGSN within the same SGSN pool with the old SGSN receives this message, the SGSN shall include the old IP address of the received message in this optional parameter if this IE is not present and relay the message to the old SGSN. | IP Address | 0 | +| UDP Source Port Number | C | If an SGSN within the same SGSN pool as the old SGSN receives this message, the SGSN shall include the UDP Source Port number of the received message in this parameter if this IE is not present and relay the message to the old SGSN. The old SGSN shall use this UDP port as the UDP destination port of the Identification Response message. | Port Number | 0 | +| Hop Counter | O | If an SGSN within the same SGSN pool with the old SGSN receives this message, the SGSN shall decrement the Hop Counter if this IE is present in the received message; otherwise, the SGSN may include a Hop Counter with a value of max-1, and may relay the message to the old SGSN. | Hop Counter | 0 | +| Target PLMN ID | CO | If available, this IE shall be included in order to allow old MME/SGSN/AMF to make a judgment whether un-used authentication vectors to be distributed or not. | Serving Network | 0 | +| Private Extension | O | None | Private Extension | VS | + +NOTE 1: Only RAI field in the ULI IE type shall be present in the Routeing Area Identity (RAI) IE. + +## 7.3.9 Identification Response + +The old SGSN/MME/AMF shall send an Identification Response message to the new MME/SGSN/AMF as a response to a previous Identification Request message over S3/S10/S16/N26 interface. + +Table 7.3.9-1 specifies the presence requirements and conditions of the IEs in the message. + +For Intra Domain Connection of RAN Nodes to Multiple CN Nodes, if an old SGSN within an SGSN pool receives an Identification Request message that contains the optional parameter Address for Control Plane, the old SGSN shall use this address as destination IP address of the Identification Response message. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "P-TMSI Signature mismatch" +- "User authentication failed" + +Only the Cause information element shall be included in the response if the Cause contains another value than "Request accepted". + +**Table 7.3.9-1: Information Elements in an Identification Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|------| +| Cause | M | | Cause | 0 | +| IMSI | C | This IE shall be included if the Cause contains the value "Request accepted". | IMSI | 0 | +| MME/SGSN UE MM Context | C | This IE shall be included if the integrity check or the P-TMSI signature check for the Attach Request succeeds. | MM Context | 0 | +| Trace Information | CO | This IE shall be included over S10/S16/S3 when session trace is active for this IMSI/IMEI. | Trace Information | 0 | +| UE Usage Type | CO | This IE shall be set to the subscribed UE Usage Type, if received from the HSS, and sent by the old MME/SGSN on the S3/S10/S16 interfaces if the old MME/SGSN supports the Dedicated Core Networks specified in TS 23.401 [3]. It shall also be sent by the AMF on the N26 interface, if received from the UDM.
If the UE Usage Type is not available in the old MME/SGSN/AMF, the length field of this IE shall be set to 0.
See NOTE 1. | Integer Number | 0 | +| Monitoring Event Information | CO | This IE shall be sent by the source MME/S4-SGSN on the S3/S10/S16 interfaces if monitoring events are to be continued in the target MME/S4-SGSN.
More than one IE with this type and instance values may be included to represent multiple monitoring events. | Monitoring Event Information | 0 | +| Monitoring Event Extension Information | CO | This IE shall be sent by the source MME/S4-SGSN on the S3/S10/S16 interfaces if monitoring event extensions are to be sent to the target MME/S4-SGSN.
More than one IE with this type and instance values may be included to represent multiple monitoring event extensions. | Monitoring Event Extension Information | 0 | +| Extended Trace Information | C | This IE shall be included over N26 when session trace is active for this user. | Extended Trace Information | 0 | +| Private Extension | O | | Private Extension | VS | + +NOTE 1: A UE Usage Type IE with the length field equal to 0 is used for the receiver to differentiate the case where the sender does not support the Dedicated Core Network feature from the case where the sender supports the Dedicated Core Network feature but no UE Usage type was received in UE's subscription. + +## 7.3.10 Forward Access Context Notification + +A Forward Access Context Notification message shall be sent from the Old SGSN to the New SGSN over the S16 interface to forward the RNC contexts to the target system, or sent from the Old MME to the New MME over the S10 interface to forward the RNC/eNodeB contexts to the target system. + +When the old SGSN receives the RANAP message Forward SRNS Context, the old SGSN shall send a Forward Access Context Notification message to the new SGSN. The new SGSN shall forward the message to the target RNC using the corresponding RANAP message. + +When the old SGSN receives a BSSGP message PS handover Required and the acknowledged peer-to-peer LLC operation is used for the Bearer Context or when "delivery order" is set in the Bearer Context QoS profile, the old SGSN shall send a Forward Access Context Notification message with the PDU Number IE to the new SGSN. The new SGSN shall forward the message to the target RNC/ target BSS using the corresponding RANAP message only for PS handover to Iu mode. + +When the old SGSN receives a BSSGP message PS handover Required from source BSS/RNC for PS handover to A/Gb mode, the value part of RAB Context IE shall be empty according to its defined minimum length. + +Table 7.3.10-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.3.10-1: Information Elements in a Forward Access Context Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------| +| RAB Contexts | C | This IE shall be included for S16 only. Several IEs with this type and instance values shall be included as necessary to represent a list of Bearers.
For each RAB context in the received RANAP message, the old SGSN shall include this IE in the message. | RAB Context | 0 | +| Source RNC PDCP context Info | C | If available, the old SGSN shall include an Source RNC PDCP context info in the message. | Source RNC PDCP context Info | 0 | +| PDU Numbers | C | This IE only applies to S16. The old SGSN shall include this IE in the message if the acknowledged peer-to-peer LLC operation is used for the Bearer Context or when "delivery order" is set in the Bearer Context QoS profile in A/Gb mode to Iu/A/Gb mode PS handover. | PDU Numbers | 0 | +| E-UTRAN Transparent Container | C | This IE shall be included over S10 to contain the "eNB Status Transfer Transparent Container" as specified in 3GPP TS 36.413 [10].
Container Type shall be set to 3. | F-Container | 0 | +| E-UTRAN Transparent Container | C | This IE shall be included over S10 to contain the "eNB Early Status Transfer Transparent Container" as specified in 3GPP TS 36.413 [10].
Container Type shall be set to 3. | F-Container | 1 | +| Private Extension | O | | Private Extension | VS | + +## 7.3.11 Forward Access Context Acknowledge + +A Forward Access Context Acknowledge message shall be sent to the old MME/SGSN as a response to Forward Access Context Notification. + +Possible Cause values are specified in Table 8.4-1. + +Table 7.3.11-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.3.11-1: Information Elements in a Forward Access Context Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.3.12 Detach Notification + +A Detach Notification message shall be sent from an MME to the associated SGSN, or from an SGSN to the associated MME as a part of Detach procedure if the ISR is activated between the MME and SGSN for the UE. + +Possible Cause values are: + +- "Local Detach". +- "Complete Detach". + +A Detach Notification message shall also be sent from an SGSN to the associated MME as a part of Detach procedure if the ISR is activated between the MME and SGSN for the UE. + +Possible Cause values are: + +- "IMSI Detach only". + +"Local Detach" indicates that this detach is local to the MME/SGSN and so the associated SGSN/MME registration where the ISR is activated shall not be detached. The MME/SGSN that receives this message including this Cause value of "Local Detach" only deactivates the ISR. This Cause value shall be included in the procedures: + +- MME/SGSN-initiated Detach Procedure in case of implicit detach. + +"Complete Detach" indicates both the MME registration and the SGSN registration that the ISR is activated for, shall be detached. This "Complete Detach" Cause value shall be included in the procedures: + +- UE-initiated Detach Procedure. +- MME/SGSN-initiated Detach Procedure in case of explicit detach. + +For the purpose of SGs handling, the SGSN shall include Detach Type in the Detach Notification message for "Complete Detach" when the UE is combined IMSI/EPS attached and the ISR is activated. + +Possible Detach Type values are: + +- "PS Detach". +- "Combined PS/CS Detach". + +"PS Detach" indicates that the MME shall perform explicit IMSI detach from EPS service as specified in clause 5.4, 3GPP TS 29.118 [22]. "Combined PS/CS detach" indicates that the MME shall perform explicit IMSI detach from non-EPS service as specified in clause 5.5, 3GPP TS 29.118 [22]. + +"IMSI Detach only" indicates that combined IMSI/EPS attached UE initiates IMSI only GPRS detach from non-GPRS service as specified in clause 4.7.4.1, 3GPP TS 24.008 [5], and both the SGSN/MME registration shall be remained. The MME shall perform explicit IMSI detach from non-EPS service for the SGs handling purpose, which is specified in clause 5.5, 3GPP TS 29.118 [22]. This "IMSI Detach only" Cause value shall be included in the procedures: + +- UE-initiated Detach Procedure for GERAN/UTRAN for "IMSI Detach only". + +Table 7.3.12-1 specifies the presence of the IEs in the message. + +**Table 7.3.12-1: Information Elements in a Detach Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|----|---------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Detach Type | CO | This IE shall be included by SGSN when the Cause indicates "Complete Detach" for the combined IMSI/EPS attached UE. | Detach Type | 0 | +| Private Extension | O | | Private Extension | VS | + +### 7.3.13 Detach Acknowledge + +A Detach Acknowledge message shall be sent as a response to a Detach Notification message during Detach procedure. + +Possible Cause values are specified in Table 8.4-1. + +Table 7.3.13-1 specifies the presence of the IEs in the message. + +**Table 7.3.13-1: Information Elements in a Detach Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Recovery | O | | Recovery | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.3.14 Change Notification Request + +3GPP TS 23.401 [3] and 3GPP TS 23.060 [4] specify that if PGW has requested ECGI/eNodeB ID/TAI/CGI/SAI/RAI Change Reporting or reporting of change of UE presence in Presence Reporting Area(s) or User CSG information Change Reporting and if MME/S4-SGSN supports the feature, then MME/S4-SGSN shall send the Change Notification Request message on the S11/S4 interface to the SGW. If SGW supports the feature, the SGW forwards the message on the GTP based S5/S8 interface to the PGW as part of location dependent charging related procedures. + +In this version of the specification, the sender shall set the header TEID value to that of the peer node's Control Plane TEID on S11/S4 interface or to the peer node's Control Plane TEID on S5/S8 interface. However a receiver shall be prepared to receive messages in which the header TEID value is set to zero from implementation conforming to earlier versions of this specification. When that is the case, the receiver identifies the subscriber context based on the included LBI, IMSI, and/or MEI IEs. + +The MME shall increment the "MO Exception Data Counter" by one each time the MME has received the RRC cause "MO Exception data". The MME may defer sending a Change Notification Request message to report a non-zero value for the "MO Exception Data Counter" based on local configuration. + +If the PLMN has configured secondary RAT usage reporting and if PDN GW Secondary RAT reporting is active, the MME shall send the Change Notification Request message and include "Secondary RAT Usage Data Report" on the S11 interface to the SGW when it has received Secondary RAT usage data from the eNodeB in the following procedures, regardless of whether ULI shall be reported or not: + +- Connection Suspend +- eNodeB initiated S1 release +- E-UTRAN to UTRAN Iu mode Inter RAT handover +- E-UTRAN to GERAN A/Gb mode Inter RAT handover +- MME triggered Serving GW relocation +- MME to 3G SGSN combined hard handover and SRNS relocation +- The MME may also send the send the Change Notification Request message and include "Secondary RAT Usage Data Report" on the S11 interface to the SGW when it has received periodic reporting of Secondary RAT usage data from eNodeB or as part of an MME initiated S1 release from the eNodeB, as described in 3GPP TS 23.401 [3] clause 5.7A. The SGW shall forward the "Secondary RAT Usage Data Report" to the PGW if the IRPGW flag is set to "1". + +**Table 7.3.14-1: Information Element in Change Notification Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|------| +| IMSI | C |

The MME/SGSN shall include IMSI in the message except for the case:

  • - If the UE is emergency attached and the UE is UICCCless.

The IMSI shall be included in the message but not used as an identifier

  • - if UE is emergency attached but IMSI is not authenticated.

If the SGW receives this IE, it shall forward it to the PGW on S5/S8.

| IMSI | 0 | +| ME Identity (MEI) | C |

The MME/SGSN shall include the ME Identity (MEI) IE:

  • - If the UE is emergency attached and the UE is UICCCless
  • - If the UE is emergency attached and the IMSI is not authenticated

If the SGW receives this IE, it shall forward it to the PGW on S5/S8.

| MEI | 0 | +| Indication Flags | CO |

This IE shall be included if any one of the applicable flags is set to 1.

Applicable flags are:

| Indication | 0 | + +| | | | | | +|-------------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|---| +| | | - Unauthenticated IMSI: This flag shall be set to 1 if the IMSI present in the message is not authenticated and is for an emergency attached UE. | | | +| RAT Type | M | See NOTE 2. | RAT Type | 0 | +| User Location Information (ULI) | C | The SGSN shall include the User Location Information IE if the MS is located in a RAT Type of GERAN, UTRAN or GAN and shall include the CGI, SAI and/or RAI. | ULI
(NOTE 1) | 0 | +| | CO | The MME shall include the User Location Information IE if the UE is located in a RAT Type of E-UTRAN and shall include the ECGI and/or TAI, or TAI and Macro eNB ID, or Macro eNB ID depending on the Change Reporting Action provided to the MME. | | | +| | CO | If the SGW receives this IE it shall forward it to the PGW, if it supports this feature. | | | +| User CSG Information (UCI) | CO | The SGSN/MME shall include the User CSG Information IE if the MS is located in the CSG cell or the hybrid cell and the P-GW/PCRF decides to receive the CSG Information. If the SGW receives this IE it shall forward it to the PGW, if it supports this feature. | UCI | 0 | +| PGW S5/S8 GTP-C IP Address | C | This IE shall be sent on S4. | IP Address | 0 | +| | CO | This IE shall be sent on S11. | | | +| LBI | CO | This IE, identifying the PDN connection, shall be sent by the MME/SGSN on S11/S4. If the SGW receives this IE, it shall forward it to the PGW on S5/S8. | EBI | 0 | +| Presence Reporting Area Information | CO | The MME/SGSN shall include this IE on the S11/S4 interface if:
  • the PGW/PCRF/OCS has just requested to start or modify reporting of change of UE presence in a Presence Reporting Area and the MME/SGSN supports such reporting. The MME/SGSN shall then indicate whether the UE is inside or outside the newly started or modified Presence Reporting Area(s), or indicate the Presence Reporting Area(s) is inactive. Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Actions. One IE shall be included for each Presence Reporting Area newly started or modified.
  • if the PGW/PCRF/OCS requested to report changes of UE presence in a Presence Reporting Area, the MME/SGSN supports such reporting and the UE enters or leaves the Presence Reporting Area(s). Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Information. One IE shall be included for each active Presence Reporting Area that the UE has newly entered or left.
| Presence Reporting Area Information | 0 | +| | CO | The SGW shall include this IE on S5/S8 if it receives the Presence Reporting Area Information from MME/SGSN. | | | +| MO Exception Data Counter | CO | The MME shall include this IE on the S11 interface when it needs to send a non-zero counter value for the MO Exception Data Counter. The timestamp in the counter shall be set with the time at which the counter value increased from 0 to 1. | Counter | 0 | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----| +| | CO | The SGW shall include this IE on S5/S8 if it receives the MO Exception Data Counter from MME. | | | +| Secondary RAT Usage Data Report | CO | If PDN GW Secondary RAT reporting is active, the MME shall include this IE on the S11 interface if it has received Secondary RAT usage data from eNodeB in a Connection Suspend, or eNodeB initiated S1 release procedure, or an MME triggered Serving GW relocation, or an E-UTRAN to GERAN A/Gb mode Inter RAT handover, E-UTRAN to UTRAN Iu mode Inter RAT handover, MME to 3G SGSN combined hard handover and SRNS relocation, or Routing Area Update procedures. In these cases, the MME shall also set the IRSGW flag to "0" and the IRPGW flag to "1".

The MME shall also include this IE on the S11 interface when it has received Secondary RAT usage data from eNodeB, e.g. as periodic reporting or in an MME initiated S1 release procedure. In these cases, the MME shall set the IRSGW flag to "1", and if PDN GW Secondary RAT reporting is active, the IRPGW flag shall be set to "1".

Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | Secondary RAT Usage Data Report | 0 | +| | O | The SGW shall forward this IE on the S5/S8 interface if it receives the Secondary RAT Usage Data Report with the IRPGW flag set to "1" from MME.

Several IEs with the same type and instance value may be included, to represent multiple usage data reports. | | | +| PSCell ID | CO | The MME shall include this IE on the S11 interface, if it has received this information from the eNodeB. | PSCell ID | 0 | +| Private Extension | O | Vendor or operator specific information | Private Extension | VS | +| NOTE 1: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator for supporting UEs, or that of the allocated Core Network Operator for non-supporting UEs. As an exception, based on inter-operator roaming/sharing agreement, if the information on whether the UE is a supporting or non-supporting UE is available, the PLMN ID that is communicated to the HPLMN for non-supporting UEs shall be the Common PLMN ID.
In shared networks, when the MME/S4-SGSN and PGW pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI to the PGW, and the Common PLMN ID shall be communicated in SAI/CGI to the PGW, for both supporting and non-supporting UEs. The Core Network Operator PLMN ID (selected by the UE for supporting UEs or allocated by the network for non-supporting UEs) shall be communicated in the TAI, RAI, UCI and the Serving Network. See clause 4.4 of 3GPP TS 23.251 [55]. | | | | | +| NOTE 2: The PGW may ignore RAT Type as the MME/SGSN always informs the PGW about RAT Type change with the Modify Bearer Request message. | | | | | + +### 7.3.15 Change Notification Response + +The Change Notification Response message may be sent on the S11/S4 interface by the SGW to the MME/SGSN and is sent on the S5/S8 interface by the PGW to the SGW as part of location dependent charging related procedures to acknowledge the receipt of a Change Notification Request. + +If SGW does not support the feature (see clause 7.3.14 "Change Notification Request"), SGW may silently discard Change Notification Request message from MME/SGSN. If the MME/SGSN does not receive Change Notification Response, the MME/SGSN may either send Change Notification Request to the same SGW next time UE location changes, or not (marking SGW as not supporting the feature). + +The Cause value indicates whether or not the Change Notification Request was received correctly. Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Request accepted". +- "Request accepted partially". +- "IMSI/IMEI not known". + +In this version of the specification, the sender shall set the header TEID value to that of the peer node's Control Plane TEID on S11/S4 interface or to the peer node's Control Plane TEID on S5/S8 interface. However a receiver shall be prepared to receive messages in which the header TEID value is set to zero from implementation conforming to earlier versions of this specification. When that is the case, the receiver identifies the subscriber context based on the included LBI, IMSI, and/or MEI IEs. + +If the IMSI is unknown, or the IMEI is unknown when the UE is emergency attached and UICCLess or the UE is emergency attached but the IMSI is not authenticated for the receiving GTP-C entity, then the message shall be silently discarded and no further processing of the IEs shall continue. + +If the MME/SGSN receives Change Notification Response containing a Cause value of "IMSI/IMEI not known" and CS bit set to 1, this indicates that the associated PDN connection does not exist within the PGW. The Change Reporting mechanism shall be stopped in the receiving SGSN/MME for all Bearers of the associated PDN connection. The SGSN/MME shall then initiate PDN disconnection for all of these PDN Connections. + +If the PDN Connection associated of the Change Notification Request message received by the SGW does not exist within the SGW, the SGW shall return Change Notification Response with the CS bit set to 0 to the MME/SGSN. The Change Reporting mechanism shall be stopped in the receiving SGSN/MME for all Bearers of the associated PDN connection, and the MME/SGSN shall then locally delete the PDN connection and release all associated resources. + +If the location Change Reporting mechanism is to be stopped or modified for this subscriber in the SGSN/MME, then the PGW shall include the Change Reporting Action IE in the message and shall set the value of the Action field appropriately. + +If the MME has sent the "MO Exception Data Counter" for the RRC Cause "MO Exception data" in the Change Notification Resquest, the MME shall reset the counter value when receiving the Change Notification Response message. + +**Table 7.3.15-1: Information Element in Change Notification Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|------| +| IMSI | C | The IMSI shall be included in the message if it is received in the Change Notification Request message. | IMSI | 0 | +| ME Identity (MEI) | C | The ME Identity (MEI) shall be included in the message if it is received in the Change Notification Request message. | MEI | 0 | +| Cause | M | | Cause | 0 | +| Change Reporting Action | C | This IE shall be included with the appropriate Action field If the location Change Reporting mechanism is to be started or stopped for this subscriber in the SGSN/MME. | Change Reporting Action | 0 | +| CSG Information Reporting Action | CO | This IE shall be included with the appropriate Action field if the location CSG Info reporting mechanism is to be started or stopped for this subscriber in the SGSN/MME. | CSG Information Reporting Action | 0 | +| Presence Reporting Area Action | CO | This IE shall be included on the S5/S8 and S11/S4 interfaces with the appropriate Action field if reporting changes of UE presence in a Presence Routing Area is to be started, stopped or modified for this subscriber in the MME/SGSN.
Several IEs with the same type and instance value may be included as necessary to represent a list of Presence Reporting Area Actions. One IE shall be included per Presence Reporting Area to be started, stopped or modified. | Presence Reporting Area Action | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.3.16 Relocation Cancel Request + +A Relocation Cancel Request message shall be sent from the source MME/SGSN/AMF to the target MME/SGSN/AMF/MME\_SRVCC on S3/S10/S16/N26 interface as part of the Inter-RAT handover Cancel procedure, S1 Based handover Cancel procedure, SRNS Relocation Cancel Procedure, EPS to 5GS handover cancel procedure, 5GS to EPS handover cancel procedure and 5G-SRVCC from NG-RAN to UTRAN handover cancel procedure. See Table 7.3.16-1 specifies the presence of the IEs in the message. + +**Table 7.3.16-1: Information Elements in Relocation Cancel Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| IMSI | C | The IMSI shall be included in the message except for the case:
  • - If the UE is emergency or RLOS attached and the UE is UICCCless.
The IMSI shall be included in the message but not used as an identifier
  • - if UE is emergency or RLOS attached but IMSI is not authenticated.
| IMSI | 0 | +| ME Identity (MEI) | C | The MME/SGSN/AMF shall include the ME Identity (MEI) IE:
  • - If the UE is emergency or RLOS attached and the UE is UICCCless
  • - If the UE is emergency or RLOS attached and the IMSI is not authenticated
| MEI | 0 | +| Indication Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags are:
  • - Unauthenticated IMSI: This flag shall be set to 1 if the IMSI present in the message is not authenticated and is for an emergency or RLOS attached UE.
| Indication | 0 | +| RANAP Cause | C | This IE shall be present in the case of SRNS relocation cancel procedure. It shall contain the cause value received from the source RNC in the Relocation Cancel message received over the lu interface. | F-Cause | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.3.17 Relocation Cancel Response + +A Relocation Cancel Response message shall be sent as a response to a previous Relocation Cancel Request message (see clause 7.3.16). + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "IMSI/IMEI not known". + +Table 7.3.17-1 specifies the presence of the IEs in the message. + +**Table 7.3.17-1: Information Elements in Relocation Cancel Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.3.18 Configuration Transfer Tunnel + +A Configuration Transfer Tunnel message shall be used to: + +- tunnel eNodeB Configuration Transfer messages from a source MME to a target MME over the S10 interface. The purpose of the eNodeB Configuration Transfer is to transfer information from an eNodeB to a target eNodeB or an en-gNB connected to a target eNB in unacknowledged mode (see 3GPP TS 36.413 [10]). +- tunnel eNodeB Configuration Transfer messages from a source MME to a target AMF, or to tunnel Uplink RAN Configuration Transfer messages from a source AMF to a target MME, over the N26 interface. This is to transfer RAN configuration information or inter-system SON configuration information between an eNodeB and a gNB in unacknowledged mode (see 3GPP TS 36.413 [10] and 3GPP TS 38.413 [84]). + +Table 7.3.18-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.3.18-1: Information Elements in a Configuration Transfer Tunnel Message** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|------| +| E-UTRAN
Transparent
Container / EN-DC
Container / Inter-
system SON
Container | M | This IE shall contain:
  • - the "SON Configuration Transfer" as specified in 3GPP TS 36.413 [10]. In this case, the Container Type shall be set to 3.
or
  • - the "EN-DC SON Configuration Transfer" as specified in 3GPP TS 36.413 [10]. In this case the Container Type shall be set to 5. (NOTE 1)
or
  • - the "Inter-system SON Configuration Transfer" as specified in 3GPP TS 36.413 [10] and 3GPP TS 38.413 [84]. In this case the Container Type shall be set to 6. (NOTE 2)
| F-Container | 0 | +| Target eNodeB ID /
en-gNB ID / gNB ID | M | This IE shall contain the ID of the target eNodeB, en-gNB or gNB.

This IE shall encode a target en-gNB ID over the S10 or N26 interface during:
  • - a TNL address discovery request of a candidate en-gNB via the S1 interface or via inter-system signalling.
This IE shall encode a target eNodeB ID:
  • - over the S10 interface, when no EN-DC SON Configuration Transfer IE is received from the source eNB;
  • - over the S10 or N26 interface, during a TNL address discovery response of a candidate en-gNB via the S1 interface or via inter-system signalling.
This IE shall encode a target eNodeB ID or a target gNB ID over the N26 interface when transferring Inter-system SON configuration Transfer information from a gNB to an eNodeB or from an eNodeB to a gNB respectively.

See clauses 22.3.6.2 and 22.3.6.3 of 3GPP TS 36.300 [19]. | Target Identification | 0 | +| Connected Target
eNodeB ID | CO | This IE shall be present during an TNL address discovery request of a candidate en-gNB via the S1 interface (see clauses 22.3.6.2 of 3GPP TS 36.300 [19]) if the source eNB provided the ID of a target eNB connected to the target en-gNB ID. | Target Identification | 1 | +| NOTE 1: An EN-DC Container shall only be sent towards MMEs known to support TNL address discovery of a candidate en-gNB via the S1 interface or via inter-system signalling (see clauses 22.3.6.2 and 22.3.6.3 of 3GPP TS 36.300 [19]). | | | | | +| NOTE 2: An Inter-system SON Container shall only be sent towards MMEs and AMFs known to support transfer of Inter-system SON configuration transfer (see clause 15.5.2 of 3GPP TS 38.300 [84]). | | | | | + +### 7.3.19 RAN Information Relay + +The RAN Information Relay message shall be sent on S3 interface between SGSN and MME to transfer the RAN information received by an SGSN from BSS or RNS (or GERAN Iu mode) or by an MME from eNodeB. The procedures are specified in 3GPP TS 23.401 [3]. + +This message shall also be sent on S16 interface to transfer the RAN information between GERAN or GERAN Iu mode or UTRAN. + +For handling of protocol errors the RAN Information Relay message is treated as a Response message. + +Table 7.3.19-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.3.19-1: Information Elements in a RAN Information Relay** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|------| +| BSS Container | M | All information elements from the BSSGP RIM PDU, starting from and including the BSSGP "PDU type", shall be contained within the BSS Container and forwarded to the destination MME/SGSN in the RAN Information Relay message. The Container Type shall be set to 2. | F-Container | 0 | +| RIM Routing Address | C | This IE shall be included if the RIM Routing Address information is included in the message sent from the source RAN node.
This IE identifies the destination RAN node where the RAN Information needs to be relayed to. It contains:
  • - the destination RNC Identity when the target is GERAN Iu mode or UTRAN; or
  • - the destination Cell Identity when the target is GERAN; or
  • - the Target eNodeB ID when the target is E-UTRAN.
| Target Identification | 0 | +| Private Extension | O | None | Private Extension | VS | + +### 7.3.20 ISR Status Indication + +A ISR Status Indication message shall be sent on the S3 interface by the MME/SGSN to the ISR associated SGSN/MME as part of the following procedures: + +- the Restoration of PDN connections after an SGW failure for UEs with ISR as specified in 3GPP TS 23.007 [17]; +- the HSS Based P-CSCF restoration procedure for 3GPP access (for both basic and PCO extension) as specified in 3GPP TS 23.380 [61]. + +Table 7.3.20-1 specifies the presence of the IEs in the message. + +**Table 7.3.20-1: Information Elements in an ISR Status Indication** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Action Indication | M | This IE shall include one of the applicable Values:
  • - Deactivation Indication: If the value is set to 1, this indicates a request to the ISR associated MME/SGSN to deactivate ISR and remove the UE resource locally. See 3GPP TS 23.007 [17].
  • - Paging Indication: If the value is set to 2, this indicates a request to the ISR associated MME/SGSN to page the UE in IDLE state. See 3GPP TS 23.007 [17].
  • - Paging Stop Indication: If the value is set to 3, this indicates to the ISR associated MME/SGSN to stop paging the UE. See 3GPP TS 23.380 [61].
| Action Indication | 0 | +| Private Extension | O | | Private Extension | VS | + +### 7.3.21 UE Registration Query Request + +The direction of this message shall be from S4-SGSN to MME (see Table 6.1-1). + +This message shall be used to support CS/PS coordination for shared UTRAN and GERAN access. When an S4-SGSN receives a UE Registration Query from a RAN node, including an indication to also query MMEs, and if the UE (identified by IMSI) is not registered in the S4-SGSN, the S4-SGSN shall send a UE Registration Query Request message to all MMEs that may hold the UE's context, as specified in the clause 7.1.6 of 3GPP TS 23.251 [55]. + +NOTE: How the S4-SGSN determines which MMEs it will query, is based on local configuration. + +Table 7.3.21-1 specifies the presence of IEs in this message. + +**Table 7.3.21-1: Information Elements in UE Registration Query Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| IMSI | M | | IMSI | 0 | +| Private Extension | O | | Private Extension | VS | + +### 7.3.22 UE Registration Query Response + +The UE Registration Query Response message shall be sent as a response to a UE Registration Query Request, to report whether the inquired UE is registered in the MME and if so, with which Core Network Operator, as specified in the clause 7.1.6 of 3GPP TS 23.251 [55]. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Request accepted", to be used when the UE is registered in the MME +- "IMSI/IMEI not known", to be used when the UE is not registered in the MME. + +The IMSI received in the UE Registration Query Request message shall be included in the response, to allow correlation in the SGSN. + +The Selected Core Network Operator Identifier identifies the core network operator currently serving the UE, and shall be included if the inquired UE is registered in the MME. + +Table 7.3.22-1 specifies the presence of IEs in this message. + +**Table 7.3.22-1: Information Elements in UE Registration Query Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-------------------------------------------|---|---------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| IMSI | M | | IMSI | 0 | +| Selected Core Network Operator Identifier | M | | PLMN ID | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.4 CS Fallback and SRVCC related messages + +### 7.4.1 Suspend Notification + +The Suspend Notification message shall be sent on the S11 interface by the MME to the SGW and on the S5/S8 interface by the SGW to the PGW as part of the 1xRTT CS fallback procedures in 3GPP TS 23.272 [21]. + +The Suspend Notification message shall be sent on the S3 interface by the SGSN to the MME, on the S11 interface by the MME to the SGW, and on the S5/S8 interface by the SGW to the PGW as part of the SRVCC procedures in 3GPP TS 23.216 [43] or the CS fallback from E-UTRAN access to UTRAN/GERAN CS domain access related procedures in 3GPP TS 23.272 [21]. + +The Suspend Notification message shall be sent on the S16 interface as per the inter-SGSN suspend procedures in 3GPP TS 23.060 [35]. + +The Suspend Notification message shall be sent on the S16, the S4 and the S5/S8 interfaces as part of the SRVCC from UTRAN (HSPA) to GERAN without DTM support procedure in 3GPP TS 23.216 [43]. + +The Suspend Notification message shall be sent on the S4 and the S5/S8 interfaces as part of the CS fallback from E-UTRAN to GERAN CS domain related procedures in 3GPP TS 23.272 [21]. + +After receiving a Suspend Notification message, the SGW/PGW marks all the non-GBR bearers as suspended status. The PGW should discard packets it receives for the suspended UE. + +Table 7.4.1-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.4.1-1: Information Element in Suspend Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| IMSI | C | This IE shall be included only on the S11 interface.
See NOTE 2. | IMSI | 0 | +| Routeing Area Identity(RAI) | C | This IE shall be included only on the S3 interface.
See NOTE 1. | ULI (NOTE 3) | 0 | +| | CO | This IE shall be included on the S16 interface. | | | +| Linked EPS Bearer ID (LBI) | CO | This IE shall be included on the S11/S4 interface to indicate the default bearer associated with the PDN connection. | EBI | 0 | +| Packet TMSI(P-TMSI) | C | This IE shall be included only on the S3 interface.
See NOTE 1. | P-TMSI | 0 | +| | CO | This IE shall be included on the S16 interface. | | | +| Originating Node | CO | This IE shall be sent on S11 interface, if before MME initiates a Detach procedure (a) ISR was active in the MME and (b) the MME was in EMM-Connected state (see also 8.65).
This IE shall be sent on S4 interface, if before S4-SGSN initiates a Detach procedure (a) ISR was active in the SGSN and (b) the SGSN was in PMM-Connected state (see also 8.65). | Node Type | 0 | +| Address for Control Plane | CO | If an SGSN within the same SGSN pool with the old SGSN receives this message, the SGSN shall include the source IP address of the received message in this optional parameter if this IE is not present and relay the message to the old SGSN. | IP Address | 0 | +| UDP Source Port Number | CO | If an SGSN within the same SGSN pool as the old SGSN receives this message, the SGSN shall include the UDP Source Port number of the received message in this parameter if this IE is not present and relay the message to the old SGSN. The old SGSN shall use this UDP port as the UDP destination port of the Suspend Acknowledge message. | Port Number | 0 | +| Hop Counter | O | If an SGSN within the same SGSN pool with the old SGSN receives this message, the SGSN shall decrement the Hop Counter if this IE is present in the received message; otherwise, the SGSN may include a Hop Counter with a value of max-1, and may relay the message to the old SGSN. | Hop Counter | 0 | +| Sender F-TEID for Control Plane | CO | The MME/SGSN and SGW shall include this IE on the S11/S4 and S5/S8 interfaces respectively and set it to the last value sent to the peer.

If the Sender F-TEID for Control Plane is received, the receiver shall only handle the message if the Sender F-TEID for Control Plane in this message is the same as the last Sender F-TEID for Control Plane received on the given interface. | F-TEID | 0 | +| Private Extension | O | | Private Extension | VS | +| NOTE 1: If the ISR is not active, the MME can not suspend the bearers after receiving the Suspend Notification message from the SGSN, the GUTI can not be derived from the P-TMSI and RAI pair as the P-TMSI Signature is not included in the message. The MME shall still reply the Suspend Acknowledge to the SGSN. Suspend procedure on MME, SGW and PGW are triggered by the S1 UE Context Release message sent from the eNodeB to the MME. Refer to clause 6.3 and clause 7.4 in 3GPP TS 23.272 [21] for detail. | | | | | +| NOTE 2: The IMSI is present only for backward compatibility reasons since the SGW can derive the context from the TEID in the header. In scenarios where IMSI is not present (e.g. UICCCless UE during an Emergency call) a dummy IMSI shall be provided. | | | | | +| NOTE 3: Only RAI field in the ULI IE type shall be present in the Routeing Area Identity (RAI) IE. | | | | | + +## 7.4.2 Suspend Acknowledge + +The Suspend Acknowledge message shall be sent on the S11 interface by the SGW to the MME and on the S5/S8 interface by the PGW to the SGW as part of the 1xRTT CS fallback procedures in 3GPP TS 23.272 [21]. + +The Suspend Acknowledge message shall be sent on the S3 interface by the MME to the SGSN, on the S11 interface by the SGW to the MME and on the S5/S8 interface by the PGW to SGW as part of the SRVCC procedures in 3GPP TS 23.216 [43] or the CS fallback from E-UTRAN access to UTRAN/GERAN CS domain access related procedures in 3GPP TS 23.272 [21]. + +The Suspend Acknowledge message shall be sent on the S16 interface as per the inter-SGSN suspend procedures in 3GPP TS 23.060 [35]. + +The Suspend Acknowledge message shall be sent on the S16, the S4 and the S5/S8 interfaces as part of the SRVCC from UTRAN (HSPA) to GERAN without DTM support procedure in 3GPP TS 23.216 [43]. + +The Suspend Acknowledge message shall be sent on the S4 and the S5/S8 interfaces as part of the CS fallback from E-UTRAN to GERAN CS domain related procedures in 3GPP TS 23.272 [21]. + +Possible Cause values are specified in Table 8.4-1. + +For backward compatibility, if the IMSI IE is missing in the Suspend Notification message that is received on the S11 interface, the cause value "Mandatory IE missing" shall be used. + +Table 7.4.2-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.4.2-1: Information Element in Suspend Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Private Extension | O | | Private Extension | VS | + +### 7.4.3 Resume Notification + +The Resume Notification message should be sent on the S11 interface by the MME to the SGW and forwarded on the S5/S8 interface by the SGW to the PGW as part of the resume procedure returning back to E-UTRAN in the case of CS fallback or SRVCC. + +The Resume Notification message should also be sent on the S4 interface by the SGSN to the SGW and forwarded on the S5/S8 interface by the SGW to the PGW as part of the resume procedure returning from SRVCC to HSPA if there is no Modify Bearer Request message sent to the SGW and PGW as specified in 3GPP TS 23.216 [43]. + +The SGW may also send a Resume Notification message to the PGW on the S5/S8 interface upon receipt from the MME/S4-SGSN of a (non-empty) Modify Bearer Request used as an implicit resume of the suspended bearers in the SGW and in the PGW (see 3GPP TS 23.216 [43] clauses 6.2.2.1 and 6.3.2.1, 3GPP TS 23.272 [21] clauses 6.3, 6.5 and 7.4) if the conditions of presence of the IEs in the Modify Bearer Request specified in table 7.2.7-1 do not require any IE to be sent over S5/S8 to the PGW. + +NOTE: This is an alternative to sending over S5/S8 a Modify Bearer Request used as an implicit resume with zero IE(s), see clause 7.2.7. + +After receiving a Resume Notification message or a Modify Bearer Request used as an implicit resume of the suspended bearers, the SGW/PGW clears suspended status for all the non-GBR bearers. The PGW shall forward packets it receives for the UE. If the suspended bearers are of the type S4-U GTP-U, the SGW shall forward over the S4-U interface, packets it receives for the UE, upon receipt of Resume Notification. + +Table 7.4.3-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.4.3-1: Information Element in Resume Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|---------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| IMSI | M | See NOTE 1. | IMSI | 0 | +| Linked EPS Bearer ID (LBI) | CO | This IE shall be included on the S11/S4 interface to indicate the default bearer associated with the PDN connection. | EBI | 0 | +| Originating Node | CO | This IE shall be sent on S11 interface, if before MME initiates a Detach procedure (a) ISR was active in the MME and (b) the MME was in EMM-Connected state (see also 8.65).
This IE shall be sent on S4 interface, if before S4-SGSN initiates a Detach procedure (a) ISR was active in the SGSN and (b) the SGSN was in PMM-Connected state (see also 8.65). | Node Type | 0 | +| Sender F-TEID for Control Plane | CO | The MME/SGSN and SGW shall include this IE on the S11/S4 and S5/S8 interfaces respectively and set it to the last value sent to the peer

If the Sender F-TEID for Control Plane is received, the receiver shall only handle the message if the Sender F-TEID for Control Plane in this message is the same as the last Sender F-TEID for Control Plane received on the given interface. | F-TEID | 0 | +| Private Extension | O | | Private Extension | VS | + +NOTE 1: The IMSI is present only for backward compatibility reasons since the receiver can derive the context from the TEID in the header. In scenarios where IMSI is not present (e.g. UICClless UE during an Emergency call) a dummy IMSI shall be provided. + +## 7.4.4 Resume Acknowledge + +The Resume Acknowledge message should be sent on the S11 interface by the SGW to the MME and on the S5/S8 by the PGW to the SGW as part of the resume procedure returning back to E-UTRAN in the case of CS fallback or SRVCC. + +The Resume Acknowledge message should also be sent on the S4 interface by the SGW to the SGSN and on the S5/S8 interface by the PGW to the SGW as part of the resume procedure returning from SRVCC to HSPA if there is no Modify Bearer Request message sent to the SGW and PGW as specified in 3GPP TS 23.216 [43]. + +The PGW shall also send a Resume Acknowledge message to the SGW on the S5/S8 interface as a response to a Resume Notification message sent by the SGW upon receipt from the MME/S4-SGSN of a (non-empty) Modify Bearer Request used as an implicit resume of the suspended bearers in the SGW and in the PGW (see 3GPP TS 23.216 [43] clauses 6.2.2.1 and 6.3.2.1, 3GPP TS 23.272 [21] clauses 6.3, 6.5 and 7.4) if the conditions of presence of the IEs in the Modify Bearer Request specified in table 7.2.7-1 do not require any IE to be sent to the PGW. + +Possible Cause values are specified in Table 8.4-1. + +Table 7.4.4-1 specifies the presence requirements and conditions of the IEs in the message. + +**Table 7.4.4-1: Information Element in Resume Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.4.5 CS Paging Indication + +The CS Paging Indication shall be sent on the S3 interface by the MME to the associated SGSN when ISR is activated as part of mobile terminated CS services. The MME gets the related information from SGsAP-PAGING-REQUEST + +message as specified in 3GPP TS29.118 [21]. Table 7.4.5-1 specifies the presence requirements and the conditions of the IEs in the message. + +NOTE: The SS code received on the SGs interface is not transferred to the SGSN because it is not used by the SGSN. + +**Table 7.4.5-1: Information Element in CS Paging Indication** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------|----|------------------------------------------------------------------------|-------------------|------| +| IMSI | M | | IMSI | 0 | +| VLR Name | M | | FQDN | 0 | +| TMSI | O | | TMSI | 0 | +| Location area identifier | O | | ULI | 0 | +| Global CN-Id | O | | Global CN-Id | 0 | +| Channel needed | O | | Channel needed | 0 | +| eMLPP Priority | O | | eMLPP Priority | 0 | +| Service Indicator | CO | This IE shall be sent if the service type for the paging is available. | Service Indicator | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.4.6 Alert MME Notification + +An Alert MME Notification message shall be sent on the S3 interface by the MME to the associated SGSN as part of an SGs Non-EPS alert procedure (see 3GPP TS 29.118 [22]) when ISR is activated, except under the conditions specified in 3GPP TS 23.272 [21], to request to receive a notification when any activity from the UE is detected. + +Table 7.4.6-1 specifies the presence requirements and the conditions of the IEs in the message. + +**Table 7.4.6-1: Information Element in Alert MME Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Private Extension | O | | Private Extension | VS | + +## 7.4.7 Alert MME Acknowledge + +An Alert MME Acknowledge message shall be sent as a response to an Alert MME Notification message. + +Possible Cause values are specified in Table 8.4-1. + +NOTE: An SGSN implemented according to an earlier version of the specification will silently discard the Alert MME Notification message. An MME which does not receive an Alert MME Acknowledge message may not send further Alert MME Notification message to this SGSN. + +Table 7.4.7-1 specifies the presence requirements and the conditions of the IEs in the message. + +**Table 7.4.7-1: Information Elements in Alert MME Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.4.8 UE Activity Notification + +A UE Activity Notification message shall be sent on the S3 interface by the SGSN to the associated MME as part of an SGs Non-EPS alert procedure (see 3GPP TS 29.118 [22]) when ISR is activated, except under the conditions specified + +in 3GPP TS 23.272 [21], to indicate that activity from a UE has been detected. Table 7.4.8-1 specifies the presence requirements and the conditions of the IEs in the message. + +**Table 7.4.8-1: Information Element in UE Activity Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Private Extension | O | | Private Extension | VS | + +## 7.4.9 UE Activity Acknowledge + +A UE Activity Acknowledge message shall be sent as a response to a UE Activity Notification message. + +Possible Cause values are specified in Table 8.4-1. + +Table 7.4.9-1 specifies the presence requirements and the conditions of the IEs in the message. + +**Table 7.4.z-1: Information Elements in UE Activity Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.5 Non-3GPP access related messages + +### 7.5.1 Create Forwarding Tunnel Request + +A Create Forwarding Tunnel Request message shall be sent by a MME to a Serving GW as a part of the MME configures resources for indirect data forwarding during active handover procedure from E-UTRAN to CDMA 2000 HRPD access. + +Table 7.5.1-1 specifies the presence requirements and the conditions of the IEs in the message. + +**Table 7.5.1-1: Information Elements in a Create Forwarding Tunnel Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-------------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| S103 PDN Data Forwarding Info | M | The MME shall include the forwarding Information for all PDN connections of the UE requesting data forwarding towards the HSGW in the message as S103 PDN Data Forwarding Info information elements. For each of those PDN Connections, an IE with the same type and instance value shall be included.
The Serving GW shall forward downlink data to the HSGW via the GRE tunnel identified by the HSGW Address and HSGW GRE Key included in this information element when it receives downlink data forwarded from the eNodeB belonging to the corresponding EPS bearers of the PDN connection. | S103PDF | 0 | +| Private Extension | O | | Private Extension | VS | + +### 7.5.2 Create Forwarding Tunnel Response + +A Create Forwarding Tunnel Response message shall be sent by a Serving GW to a MME as a response to a Create Forwarding Tunnel Request message. + +Table 7.5.2-1 specifies the presence requirements and the conditions of the IEs in the message. + +The Cause value indicates if Data Forwarding Resources has been created in the Serving GW or not. Data Forwarding Resources have not been created in the Serving GW if the Cause differs from "Request accepted". Possible Cause values are specified in Table 8.4-1. + +Only the Cause IE shall be included in the response if the Cause IE contains another value than "Request accepted". + +**Table 7.5.2-1: Information Elements in a Create Forwarding Tunnel Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|---------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| S1-U Data Forwarding Info | C | S1-U Data Forwarding Info shall be included in the message if the Cause contains the value "Request accepted". For each EPS bearer requesting data forwarding which is included in the S103 PDN Data Forwarding Info fields of corresponding Create Forwarding Tunnel Request message, the Serving GW shall assign a Serving GW S1-U Address and Serving GW S1-U TEID pair and included it in the response message as S1-U Data Forwarding Info information element. For each of those EPS bearers, an IE with the same type and instance value shall be included.
The eNodeB shall forward downlink data of the EPS bearer to the Serving GW via the GTP-U tunnel identified by the Serving GW S1-U Address and Serving GW S1-U TEID. | S1UDF | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.6 Reliable Delivery of Signalling Messages + +Retransmission requirements in the current clause do not apply to the Initial messages that do not have Triggered messages. + +Reliable delivery in GTPv2 messages is accomplished by retransmission of these messages. A message shall be retransmitted if and only if a reply is expected for that message and the reply has not yet been received. There may be limits placed on the total number of retransmissions to avoid network overload. + +Initial messages and their Triggered messages, as well as Triggered messages and their Triggered Reply messages are matched based on the Sequence Number and the IP address and port rules in clause 4.2 "Protocol stack". Therefore, an Initial message and its Triggered message, as well as a Triggered message and its Triggered Reply message shall have exactly the same Sequence Number value. A retransmitted GTPv2 message (an Initial or a Triggered) has the exact same GTPv2 message content, including the GTP header, UDP ports, source and destination IP addresses as the originally transmitted GTPv2 message. + +For each triplet of local IP address, local UDP port and remote peer's IP address a GTP entity maintains a sending queue with signalling messages to be sent to that peer. The message at the front of the queue shall be sent with a Sequence Number, and if the message has an expected reply, it shall be held in a list until a reply is received or until the GTP entity has ceased retransmission of that message. The Sequence Number shall be unique for each outstanding Initial message sourced from the same IP/UDP endpoint. A node running GTP may have several outstanding messages waiting for replies. Not counting retransmissions, a single GTP message with an expected reply shall be answered with a single GTP reply, regardless whether it is per UE, per APN, or per bearer + +A piggybacked initial message (such as a Create Bearer Request message or Modify Bearer Request message) shall contain a Sequence Number that is assigned by sending GTP entity and the message shall be held in a list until a response is received. The response message to a piggybacked initial message may arrive without piggybacking (e.g., Create Bearer Response at PGW). + +The Sequence Number in the GTP header of the triggered response message shall be copied from the respective request message. + +If a request message (e.g., Create Session Request) triggers piggybacking (i.e., Create Bearer Request piggybacked on Create Session Response), re-transmission of the request message shall also trigger piggybacking. A Sequence Number used for a Command message shall have the most significant bit set to 1. A Sequence Number in a message, which was triggered by a Command message, as well as respective Triggered Reply message shall have the same Sequence + +Number as the Command message (i.e. shall also have the most significant bit set to 1). This setting of the most significant bit of the Sequence Number is done to avoid potential clashes between the Sequence Number selected for a Command message, and the Sequence Number selected by a GTPv2 peer for a Request message, which was not triggered by a Command message. + +A Sequence Number used for a Request message, which was not triggered by a Command message shall have the most significant bit set to 0. + +A timer, denoted T3-RESPONSE, shall be started when a signalling message (for which a reply is expected) is sent. A signalling message or the triggered message has probably been lost if a reply has not been received before the T3-RESPONSE timer expires. + +Once the T3-RESPONSE timer expires, the message corresponding to the T3-RESPONSE timer is then retransmitted if the total number of retry attempts is less than N3-REQUESTS times. The expiry of the timer for piggybacked request messages shall result in re-transmission of the original IP/UDP packet containing both the triggered response message and the piggybacked initial message. T3-RESPONSE timer and N3-REQUESTS counter setting is implementation dependent. That is, the timers and counters may be configurable per procedure. Multileg communications (e.g. Create Session Requests and Responses) however require longer timer values and possibly a higher number of retransmission attempts compared to single leg communication. + +All received GTPv2 messages with an expected reply shall be replied to and all reply messages associated with a certain message shall always include the same information. Duplicated reply messages shall be discarded by the receiver unless the reply needs a reply. A received reply message without a matching outstanding message that is waiting for a reply should be discarded. + +If a GTPv2 node is not successful with the transfer of a non-Echo signalling message, e.g. a Create Bearer Request message, it shall inform the upper layer of the unsuccessful transfer so that the controlling upper entity may take the necessary measures. + +NOTE: At failure of sending a GTPv2 message after retransmissions, some information included in the message may be lost, e.g. Secondary RAT data usage report. + +## 7.7 Error Handling + +### 7.7.0 Handling Piggybacked Messages + +For piggybacked initial messages, the following general rule shall apply: the triggered response message carrying the piggybacked message shall be processed first, according to the following clauses. Subsequently, the piggybacked initial message shall be processed independently. If the processing of dedicated bearer activation message results in an error, this shall not affect the default bearer establishment. If the default bearer establishment fails, the dedicated bearer activation related message shall be discarded. + +#### 7.7.1 Protocol Errors + +A protocol error is defined as a message or an Information Element received from a peer entity with unknown type, or if it is unexpected, or if it has an erroneous content. + +The term silently discarded is used in the following clauses to mean that the receiving GTP entity's implementation shall discard such a message without further processing, or that the receiving GTP entity discards such an IE and continues processing the message. The conditions for the receiving GTP entity to silently discard an IE are specified in the subsequent clauses. + +The handling of unknown, unexpected or erroneous GTP messages and IEs shall provide for the forward compatibility of GTP. Therefore, the sending GTP entity shall be able to safely include in a message a new conditional-optional or an optional IE. Such an IE may also have a new type value. Any legacy receiving GTP entity shall, however, silently discard such an IE and continue processing the message. + +If a protocol error is detected by the receiving GTP entity, it should log the event including the erroneous message and may include the error in a statistical counter. + +For Request messages and Response messages without a rejection Cause value, the following applies: + +- An information element with "Mandatory" in the "Presence requirement" column of a message definition shall always be present in that message. +- An information element with "Conditional" in the "Presence requirement" column of a message definition shall be sent when the conditions detailed in the "Condition / Comment" column are met. + +For Response messages containing a rejection Cause value, see clause 6.1.1. + +The Version Not Supported Indication message shall be considered as a Triggered message as specified in clause 4.2.5 "Messages with GTPv2 defined replies: Classification of Initial and Triggered Messages". + +The receiving GTP entity shall apply the error handling specified in the subsequent clauses in decreasing priority. + +If the received erroneous message is a reply to an outstanding GTP message, the GTP transaction layer shall stop retransmissions and notify the GTP application layer of the error even if the reply is silently discarded. + +## 7.7.2 Different GTP Versions + +If a GTPv2 entity receives a message of an unsupported GTP version, higher than GTPv2, it shall return a Version Not Supported Indication message and silently discard the received message. + +If a GTPv2 entity listens to the GTPv0 port, the entity shall silently discard any received GTPv0 message. + +If a GTPv2 entity does not support GTPv1 and receives a GTPv1 message, it shall silently discard the received message. + +## 7.7.3 GTP Message of Invalid Length + +If a GTP entity receives a message, which is too short to contain the respective GTPv2 header, the GTP-PDU shall be silently discarded. + +Apart from a piggybacked GTP message or an Echo Request message, if a GTP entity receives a Request message within an IP/UDP packet of a length that is inconsistent with the value specified in the Length field of the GTP header, then the receiving GTP entity should log the error and shall send the Response message with Cause IE value set to "Invalid Length". + +Apart from a piggybacked GTP message, if a GTP entity receives a Response message within an IP/UDP packet of a length that is inconsistent with the value specified in the Length field of the GTP header, then the receiving GTP entity should log the error and shall silently discard the message. + +If a GTP entity receives two GTP messages (triggered response message and a piggybacked initial message) within an IP/UDP packet of a length that is inconsistent with the total length of the two concatenated messages as indicated by Length fields of the GTP headers, then the receiving GTP entity should log the error and return an appropriate Response message with Cause IE value set to "Invalid overall length of the triggered response message and a piggybacked initial message". That is: + +- for a Create Session Response message together with a piggybacked Create Bearer Request message, a Create Bearer Response message should be returned with the above Cause value. +- for a Create Bearer Response message together with a piggybacked Modify Bearer Request message, a Modify Bearer Response message should be returned with the above Cause value. + +## 7.7.4 Unknown GTP Message + +If a GTP entity receives a message with an unknown Message Type value, it shall silently discard the message. + +## 7.7.5 Unexpected GTP Message + +If a GTP entity receives an unexpected initial message (see clause 4.2 "Protocol stack"), for example a known message that is sent over an interface for which the message is not defined, or a message that is sent over an interface for which the message is defined, but the direction is incorrect, then the GTP entity shall silently discard the message and shall log an error. + +If a GTP entity receives an unexpected triggered message which is not a request message (see clause 4.2 "Protocol stack"), for example a message for which there is no corresponding outstanding request, it shall discard the message and may log an error. + +When a GTP entity receives an unexpected triggered message, which is a request message, triggered by a command message, i.e. the MSB of the sequence number is set "1", e.g. in Create/Update/Delete Bearer Request messages, the GTP entity may continue to handle the request, e.g. to accept the Delete Bearer Request message. + +NOTE: Whether to accept or reject such a message is implementation specific. + +## 7.7.6 Missing Information Elements + +A GTP entity shall check if all mandatory IEs are present in the received Request message. Apart from Echo Request message, if one or more mandatory information elements are missing in the received Request message, the GTP entity should log the error and shall send a Response message with Cause IE value set to "Mandatory IE missing" together with the type and instance of the missing mandatory IE. + +If a GTP entity receives a Response message with Cause IE value set to "Mandatory IE missing", it shall notify its upper layer. + +A GTP entity shall check if all mandatory IEs are present in the received Response message without a rejection Cause value. If one or more mandatory information elements are missing, the GTP entity shall notify the upper layer and should log the error. If a mandatory IE is missing in a Response message, which the SGW shall forward over another interface (e.g. when SGW forwards a message from PGW to MME), the SGW shall include the rejection Cause "Invalid Reply from remote peer" (see clause 8.4) in the forwarded Response message. + +A GTP entity shall check if conditional information elements are present in the received Request message, if possible (i.e. if the receiving entity has sufficient information available to check if the respective conditions were met). If one or more conditional information elements are missing, a GTP entity should log the error and shall send a Response message with Cause IE value set to "Conditional IE missing" together with the type and instance of the missing conditional IE. + +A GTP entity shall check if conditional information elements are present in the received Response message without a rejection Cause value, if possible (i.e. if the receiving entity has sufficient information available to check if the respective conditions were met). If one or more conditional information elements are missing, a GTP entity shall notify the upper layer and should log the error. + +For Response messages containing a rejection Cause value, see clause 6.1.1. + +If the Indication IE is applicable for the message as a conditional IE and if it is not present, the GTP entity shall not reject the message unless there are other reasons to reject the message. + +If the Indication IE is applicable for the message as conditional IE and if it is present with the value of all the applicable flags set to "0", the GTP entity shall not reject the message unless there are other reasons to reject the message. + +Absence of an optional information element shall not trigger any of the error handling processes. + +## 7.7.7 Invalid Length Information Element + +An information element has invalid length when the actual length of the IE is different from the value of the Length field in the IE header. Here, the actual length of the IE means the length of the content field of the received IE. + +If a GTP message contains more than one information elements and one or more of them have invalid length, the receiving GTP entity can detect which of the IEs have invalid length only in the following cases: + +- If the Length value in the IE header is greater than the overall length of the message; +- If the invalid length IE is the last one in the message. + +Apart from Echo Request message, if a receiving GTP entity detects information element with invalid length in a Request message, it shall send an appropriate error response with Cause IE value set to "Invalid length" together with the type and instance of the offending IE. + +Other Length field handling cases are specified below: + +- If the received value of the Length field and the actual length of the fixed length IE are consistent, but the length is greater than that expected by the fixed number of octets, then the extra octets shall be discarded. +- If the received value of the Length field and the actual length of the fixed length IE are consistent, but the length is less than that expected by the fixed number of octets, this shall be considered an error, IE shall be discarded and if the IE was received as a Mandatory IE or a verifiable Conditional IE in a Request message, an appropriate error response with Cause IE value set to "Invalid length" together with the type and instance of the offending IE shall be returned to the sender. +- If the received value of the Length field and the actual length of the extendable length IE are consistent, but the length is greater than that expected by the fixed number of octets preceding the extended field(s), then the extra unknown octets shall be discarded. +- If the received value of the Length field and the actual length of the extendable length IE are consistent, but the length is less than the number of fixed octets defined for that IE, preceding the extended field(s), this shall be considered an error, IE shall be discarded and if the IE was received as a Mandatory IE or a verifiable Conditional IE in a Request message, an appropriate error response with Cause IE value set to "Invalid length" together with the type and instance of the offending IE shall be returned to the sender. Please refer to Table 8.1-1 for determining the number of fixed octets of an IE. + +### 7.7.8 Semantically incorrect Information Element + +Apart from Echo Request message, the receiver of a GTP signalling message Request including a mandatory or a verifiable conditional information element with a semantically invalid Value shall discard the request, should log the error, and shall send a response with Cause set to "Mandatory IE incorrect" together with a type and instance of the offending IE. + +The receiver of a GTP signalling message Response including a mandatory or a verifiable conditional information element with a semantically invalid Value shall notify the upper layer that a message with this sequence number has been received and should log the error. + +If a GTP entity receives an information element with a value which is shown as reserved, it shall treat that information element as invalid and should log the error. If the invalid IE is received in a Request, and it is a mandatory IE or a verifiable conditional IE, the GTP entity shall send a response with Cause set to "Mandatory IE incorrect" together with a type and instance of the offending IE. + +The principle is: the use of reserved values invokes error handling; the use of spare values can be silently discarded and so in the case of IEs with spare values used, processing shall be continued ignoring the spare values. + +The receiver of a GTP signalling message including an optional information element with a Value that is not in the range defined for this information element value shall discard this IE, but shall treat the rest of the message as if this IE was absent and continue processing. The receiver shall not check the content of an information element field that is defined as 'spare'. + +All semantically incorrect optional information elements in a GTP signalling message shall be treated as not present in the message. + +### 7.7.9 Unknown or unexpected Information Element + +The receiver of a GTP message including an unexpected information element with known Type value, but with the instance value that is not defined for this message shall discard the IE and log an error. The receiver shall process the message. + +An information element with a Type value which is defined in clause 8.1 of the present specification but whose Instance Value is not expected in the received GTP signalling message according to the grammar defined in clause 7 of the present specification shall be silently discarded (skipped) and the rest of the message processed as if this information element was not present. + +NOTE: An Information Element in an encoded GTPv2 message or grouped IE is identified by the pair of IE Type and Instance value. + +## 7.7.10 Repeated Information Elements + +An Information Element is repeated if there is more than one IE with the same IE Type and Instance in the scope of the GTP message (scope of the grouped IE). Such an IE is a member in a list. + +If an information element is repeated in a GTP signalling message in which repetition of the information element is not specified, only the contents of the information element appearing first shall be handled and all subsequent repetitions of the information element shall be ignored. When repetition of information elements is specified, only the contents of specified repeated information elements shall be handled and all subsequent repetitions of the information element shall be ignored. + +## 7.7.11 TFT Error Handling + +TFT related error handling for EUTRAN is specified in 3GPP TS 24.301 [23] and for UTRAN/GERAN in 3GPP TS 24.008 [5]. + +## 7.8 Path Failure + +Path failure handling procedures are specified in 3GPP TS 23.007 [17]. + +## 7.9 Restoration and Recovery + +### 7.9.0 General + +Restoration and Recovery procedures are specified in 3GPP TS 23.007 [17]. + +### 7.9.1 Delete PDN Connection Set Request + +This message may be sent on the S2a, S2b, S5, S8, or S11 interfaces as specified in 3GPP TS 23.007 [17]. + +**Table 7.9.1-1: Information Elements in a Delete PDN Connection Set Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| MME-FQ-CSID | C | This IE shall be included when a MME reports a partial fault according to the requirements in 3GPP TS 23.007 [17]. More than one FQ-CSID may appear. | FQ-CSID | 0 | +| SGW-FQ-CSID | C | This IE shall be included when a SGW reports a partial fault according to the requirements in 3GPP TS 23.007 [17]. More than one FQ-CSID may appear. | FQ-CSID | 1 | +| PGW-FQ-CSID | C | Shall be included when a PGW reports a partial fault. More than one FQ-CSID may appear | FQ-CSID | 2 | +| ePDG-FQ-CSID | C | This IE shall be included when an ePDG reports a partial fault according to the requirements in 3GPP TS 23.007 [17]. More than one FQ-CSID may appear. | FQ-CSID | 3 | +| TWAN-FQ-CSID | C | This IE shall be included when a TWAN reports a partial fault according to the requirements in 3GPP TS 23.007 [17]. More than one FQ-CSID may appear. | FQ-CSID | 4 | +| Private Extension | O | This IE may be sent on the S2a, S2b, S5, S8 and S11 interfaces. | Private Extension | VS | + +TEID of 0 shall be used for the Delete PDN Connection Set Request. + +Only one type of FQ-CSID shall be included in each Delete PDN Connection Set Request, A mix of different types, such as SGW-FQ-CSID and PGW-FQ-CSID shall not be used. A combined node, such as a collocated PGW/SGW, + +shall send separate Delete PDN Connection Set Request for the PGW role and one for the SGW role if a partial fault impacts more than one role. + +## 7.9.2 Delete PDN Connection Set Response + +This message is sent as a response to the Delete PDN Connection Set Request. + +**Table 7.9.2: Information Elements in a Delete PDN Connection Set Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|----|---------------------------------------------------------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Recovery | CO | This IE shall be included if contacting the peer for the first time | Recovery | 0 | +| Private Extension | O | This IE may be sent on the S2a, S2b, S5, S8 and S11 interfaces. | Private Extension | VS | + +TEID of 0 shall be used for the Delete PDN Connection Set Response. + +The following Cause values are defined: + +- "Request Accepted" +- "Request rejected" +- "System failure". +- "Mandatory IE incorrect". +- "Conditional IE missing". +- "Invalid message format". + +"Request Accepted" indicates the receiving node was capable of storing a CSID value for each PDN connection for the type of node (MME, SGW, PGW, TWAN or ePDG) in the Delete PDN Connection Set Request and has marked, or will mark immediately, the PDN connections for deletion as specified in 3GPP TS 23.007 [17]. "Request Accepted" shall be returned even if there are no PDN connections that match. + +"Request rejected" shall be used when the receiver of the Delete PDN Connection Set Request is not capable of storing at least one CSID value per PDN connection for the type of node (MME, SGW, PGW, TWAN or ePDG) received in the Delete PDN Connection Set Request. + +The SGW shall respond to the Delete PDN Connection Set Request independently, i.e. without waiting for replies. + +## 7.9.3 Update PDN Connection Set Request + +The SGW shall send this message to the PGW on S5/S8 according to the requirements in TS 23.007 [17]. + +**Table 7.9.3-1: Information Elements in a Update PDN Connection Set Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| MME-FQ-CSID | C | This IE shall be included for MME relocation without SGW relocation according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| SGW-FQ-CSID | C | This IE shall be included for MME relocation without SGW relocation according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 1 | +| Private Extension | O | | Private Extension | VS | + +## 7.9.4 Update PDN Connection Set Response + +This message is sent by the PGW to the SGW on S5/S8 in response to the Update PDN Connection Set Request message. + +**Table 7.9.4-1: Information Elements in a Update PDN Connection Set Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|----|---------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| PGW-FQ-CSID | C | This IE shall be included for MME relocation without SGW relocation according to the requirements in 3GPP TS 23.007 [17]. | FQ-CSID | 0 | +| Recovery | CO | This IE shall be included if contacting the peer for the first time | Recovery | 0 | +| Private Extension | O | | Private Extension | VS | + +The following Cause values are defined: + +- "Request accepted" +- "Request rejected" +- "System failure". +- "Mandatory IE incorrect". +- "Conditional IE missing". +- "Invalid message format". + +## 7.9.5 PGW Restart Notification + +The direction of this message shall be from SGW to MME/S4-SGSN (see Table 6.1-1). + +If both the SGW and the MME/S4-SGSN support the PRN feature (see clause 8.83), a PGW Restart Notification shall be sent when the SGW detects that the peer PGW has restarted, and a PGW Restart Notification may be sent when the SGW detects that the peer PGW has failed and not restarted, as specified in 3GPP TS 23.007 [17]. + +Table 7.9.5-1 specifies the presence of IEs in this message. + +**Table 7.9.5-1: Information Elements in PGW Restart Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|------------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| PGW S5/S8 IP Address for Control Plane or PMIP | M | | IP Address | 0 | +| SGW S11/S4 IP Address for Control Plane | M | | IP Address | 1 | +| Cause | CO | The SGW shall send the Cause IE with the value "PGW not responding" if it sends the PGW Restart Notification to notify that the peer PGW has failed and not restarted. | Cause | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.9.6 PGW Restart Notification Acknowledge + +The PGW Restart Notification Acknowledge shall be sent as a response of PGW Restart Notification to indicate that the MME/S4-SGSN deletes all the relevant PDN connections as specified in 3GPP TS 23.007 [17] if the Cause IE includes an acceptance cause. + +Possible Cause values are specified in Table 8.4-1. + +**Table 7.9.6-1: Information Elements in PGW Restart Notification Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.9.7 PGW Downlink Triggering Notification + +The direction of this message shall be from PGW to SGW and from SGW to MME(s)/S4-SGSN(s). + +The PGW Downlink Triggering Notification shall be sent as part of the PGW triggered SGW restoration procedure if the MME/S4-SGSN, SGW and PGW support this optional feature as specified in 3GPP TS 23.007 [17]. + +**Table 7.9.7-1: Information Elements in PGW Downlink Triggering Notification** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|------------------------------------------------------|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| IMSI | M | | IMSI | 0 | +| MME/S4-SGSN identifier | C | This IE shall be included over S5 /S11/S4 interface as specified in 3GPP TS 23.007 [17]. | IP Address | 0 | +| PGW S5 F-TEID for GTP or PMIP Control Plane (NOTE 2) | O | This IE may be included over the S5 interface. If present, it shall contain the PGW S5 F-TEID value assigned during the PDN connection establishment. (NOTE 1) | F-TEID | 0 | +| | CO | The PGW shall include this IE over the S5 interface according to the conditions specified in clauses 20.2.7.1 of 3GPP TS 23.007 [17]. | | | +| | CO | If the SGW receives this IE it shall forward the IE to the MME/S4-SGSN over the S11/S4 interface. This IE shall include the PGW S5 IP address for control plane and TEID for GTP based S5 case or the uplink GRE key for control plane in the PMIP based S5 case. | | | +| Private Extension | O | | Private Extension | VS | + +NOTE 1: The SGW shall set the header TEID value in the PGW Downlink Triggering Acknowledge to the PGW's Control Plane TEID if the 'PGW S5 F-TEID for GTP or PMIP Control Plane' IE is present in the PGW Downlink Triggering Notification message. + +NOTE 2: In earlier versions of this specification, the name of this IE was 'Sender F-TEID for Control Plane'. The name was changed when extending the applicability of the IE to S4/S11. + +## 7.9.8 PGW Downlink Triggering Acknowledge + +The PGW Downlink Triggering Acknowledge message shall be sent as a response to a PGW Downlink Triggering Notification message if the MME/S4-SGSN, SGW and PGW support the PGW triggered SGW restoration feature as specified in 3GPP TS 23.007 [17]. + +Possible Cause values are specified in Table 8.4-1. Message specific cause values are: + +- "Request accepted". +- "Context not found". + +**Table 7.9.8-1: Information Elements in PGW Downlink Triggering Acknowledge** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|------------------------|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| IMSI | C | This IE shall be included on S11/S4 interface if the Cause is indicating the rejection value "Context Not Found" and if the MME/S4-SGSN identifier is included in the corresponding PGW Downlink Triggering Notification message. | IMSI | 0 | +| MME/S4-SGSN identifier | C | This IE shall be included on S11/S4 interface if the Cause is indicating the rejection value "Context Not Found" and if the MME/S4-SGSN identifier is included in the corresponding PGW Downlink Triggering Notification message. | IP Address | 0 | +| Private Extension | O | | Private Extension | VS | + +## 7.10 Fallback to GTPv1 mechanism + +An EPC entity shall assume that each GTP processing node that it is about to communicate with is GTPv2 capable. Before the first GTP tunnel is setup for a given UE/node, the EPC node shall always send a version 2 (GTPv2) message to a peer node. As an exception, during an inter-SGSN handover, even if the target SGSN is GTPv2 capable, the source SGSN shall send a GTPv1 message "Forward Relocation Request" to the target SGSN if the PDP Context(s) for this UE were established to GGSN(s), or if there is no active PDP context and the source or target SGSN does not support SRNS relocation w/o PDN connection over GTPv2 (see clause 7.3.1). + +A GTPv2 entity shall fallback to GTPv1 only if either a "Version Not Supported" message in GTPv1 format as specified in 3GPP TS 29.060 [4] is received from the peer node (this indicates that the peer GTP entity does not support GTPv2), or if a GTPv2 message is received with Cause value "Fallback to GTPv1". + +If a GTPv1 "Version Not Supported" message is received, a GTPv2 entity may fallback to GTPv1. 3GPP TS 23.401 [3] (see annex D) and 3GPP TS 23.060 [35] specify GTP version usage during the mobility between a UTRAN/GERAN and an E-UTRAN. + +A GTPv2 entity may receive a GTPv2 message with a Cause value "Fallback to GTPv1" in the following cases: + +- an S4 SGSN receives the Cause code "Fallback to GTPv1" in a GTPv2 Context Response message over S16 interface. When an UE has activated a PDP context via S4 SGSN to GGSN and inter-SGSN RAU is underway, the old S4 SGSN shall include the Cause value "Fallback to GTPv1" in a GTPv2 Context Response message over S16 interface. In this case, the new S4 SGSN shall abort the ongoing GTPv2 procedure and send a GTPv1 "SGSN Context Request" message to the old S4 SGSN. The fallback to GTPv1 is performed only for this UE in the current procedure. +- an MME receives the Cause code "Fallback to GTPv1" in a GTPv2 Context Response message over the S3 interface. When an UE has active PDP context(s) via an S4 SGSN and a TAU is underway, the old S4 SGSN may include the Cause value "Fallback to GTPv1" in a GTPv2 Context Response message over the S3 interface. In this case, the MME shall abort the ongoing GTPv2 procedure and should send a GTPv1 "SGSN Context Request" message to the old S4 SGSN. The fallback to GTPv1 is performed only for this UE. + +Fallback to GTPv1 shall not occur on already established GTP tunnels without change of the peer nodes of the communication bearer. + +## 7.11 Fallback to GTPv0 + +Fallback from GTPv2 to GTPv0 shall not be supported. Therefore, GTPv2 entity should not listen to the well-known GTPv0 port 3386. + +## 7.12 Trace Management Messages + +### 7.12.1 Trace Session Activation + +The Trace Session Activation message shall be sent on S11/S4 by the MME/SGSN to the SGW, on S2a/S2b by the TWAN/ePDG to the PGW, and on S5/S8 by the SGW to the PGW when session trace is activated for a particular IMSI or IMEI for a UE that is attached and active or attached and idle. + +Table 7.12.1-1 specifies the presence of the IEs in the message. + +**Table 7.12.1-1: Information Elements in a Trace Session Activation** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|------| +| IMSI | C |

The MME/SGSN shall include the IMSI in the message on the S11/S4 interface except for the case:

  • - If the UE is emergency or RLOS attached and the UE is UICClless.

The IMSI shall be included in the message on the S11/S4 interface but not used as an identifier

  • - if UE is emergency or RLOS attached but IMSI is not authenticated.

The SGW shall forward this IE to the PGW on S5/S8 if received on S11/S4.

The TWAN/ePDG shall include this IE on the S2a/S2b interface except for the case:

  • - If the UE is emergency attached and the UE is UICClless.

The IMSI shall be included in the message on the S2a/S2b interface if available, but not used as an identifier

  • - if UE is emergency attached but IMSI is not authenticated.
| IMSI | 0 | +| Trace Information | M | | Trace Information | 0 | +| ME Identity (MEI) | C |

The MME/SGSN shall include the ME Identity (MEI) IE on the S11/S4 interface:

  • - If the UE is emergency attached and the UE is UICClless; or
  • - If the UE is emergency attached and the IMSI is not authenticated.

In other cases, the MME shall include the ME Identity (MEI) IE on the S11 interface, if available.

The SGW shall forward this IE to the PGW on S5/S8 if received on S11/S4.

| MEI | 0 | +| | CO |

The MME/SGSN shall include the ME Identity (MEI) IE on the S11 interface:

  • - If the UE is RLOS attached and the UE is UICClless; or
  • - If the UE is RLOS attached and the IMSI is not authenticated.
| | | +| | CO |

The TWAN/ePDG shall include the ME Identity (MEI) IE on the S2a/S2b interface:

  • - If the UE is emergency attached and the UE is UICClless
  • - If the UE is emergency attached and the IMSI is not authenticated

In other cases, the TWAN/ePDG shall include the ME Identity (MEI) IE on the S2a/S2b interface, if available.

| | | + +## 7.12.2 Trace Session Deactivation + +The Trace Session Deactivation message shall be sent on S11/S4 by the MME/SGSN to the SGW, on S2a/S2b by the TWAN/ePDG to the PGW, and on S5/S8 by the SGW to the PGW when session trace is deactivated for a particular IMSI or IMEI for a UE that is attached and active or attached and idle. + +Table 7.12.2-1 specifies the presence of the IEs in the message. + +**Table 7.12.2-1: Information Elements in a Trace Session Deactivation** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|---|---------------------|-----------------|------| +| Trace Reference | M | | Trace Reference | 0 | + +## 7.13 MBMS Messages + +### 7.13.1 MBMS Session Start Request + +The MBMS Session Start Request message shall be sent on the Sm/Sn interface by the MBMS GW to the MME/SGSN as specified in 3GPP TS 23.246 [37] and 3GPP TS 23.007 [13]. + +Table 7.13.1-1 specifies the presence of the IEs in the message. + +**Table 7.13.1-1: Information Elements in a MBMS Session Start Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------------------------|----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|------| +| Sender F-TEID for Control Plane | M | | F-TEID | 0 | +| Temporary Mobile Group Identity (TMGI) | M | See NOTE 4. | TMGI | 0 | +| MBMS Session Duration | M | | MBMS Session Duration | 0 | +| MBMS Service Area | M | | MBMS Service Area | 0 | +| MBMS Session Identifier | C | This IE shall be forwarded to MME/SGSN if it is provided by the BM-SC. | MBMS Session Identifier | 0 | +| MBMS Flow Identifier | C | This IE shall be forwarded to MME/SGSN if it is provided by the BM-SC. | MBMS Flow Identifier | 0 | +| QoS profile | M | See NOTE 1. | Bearer QoS | 0 | +| MBMS IP Multicast Distribution | M | See NOTE 2. | MBMS IP Multicast Distribution | 0 | +| Recovery | C | This IE shall be included if contacting the peer for the first time. | Recovery | 0 | +| MBMS Time to Data Transfer | CO | This IE shall be forwarded to MME/SGSN if it is received from the BM-SC. | MBMS Time to Data Transfer | 0 | +| MBMS Data Transfer Start | CO | This IE shall be forwarded to the MME if it is received from the BM-SC. | Absolute Time of MBMS Data Transfer | 0 | +| MBMS Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags:
- MBMS Session Re-establishment Indication: this flag shall be set to 1 on the Sm/Sn interfaces if the MBMS Session Start Request message is used to re-establish an MBMS session (see 3GPP TS 23.007 [13]). | MBMS Flags | 0 | +| MBMS Alternative IP Multicast Distribution | CO | If the MBMS GW supports both IPv4 and IPv6 M1 multicast address types, the MBMS GW may include this IE on the Sm interface to provide an alternative MBMS IP Multicast Distribution Address with a different address type (i.e. IPv4 or IPv6) than the one provided in the MBMS IP Multicast Distribution IE.
See NOTE 2. | MBMS IP Multicast Distribution | 1 | +| MBMS Cell List | CO | The MBMS GW shall include this IE on the Sm interface if a MBMS Cell List was received from the BM-SC.
See NOTE 3. | ECGI-List | 0 | +| Private Extension | O | | Private Extension | VS | + +NOTE 1: The uplink GBR and uplink MBR shall be ignored by MME/SGSN as specified in Clause 20.5 of 3GPP TS 29.061 [38]. + +NOTE 2: If the MBMS GW supports both IPv4 and IPv6 M1 multicast address types, the MBMS GW may provide both IPv4 and IPv6 MBMS IP Multicast Distribution addresses on the Sm interface by including the MBMS IP Multicast Distribution IE and the MBMS Alternative IP Multicast Distribution IE in the MBMS Session Start Request. In this case, one of these IEs shall carry an IP Multicast Distribution Address and an IP Multicast Source Address for IPv6 and the other IE shall carry IPv4 addresses. Both IEs shall contain the same C-TEID value. + +NOTE 3: The MBMS Cell List can contain from 1 up to 4096 cells (see 3GPP TS 29.061 [38]). + +NOTE 4: The PLMN ID in the TMGI IE received in the MBMS Session Start Request message may be different from the PLMN ID(s) either reported by the MCE(s) previously at the M3 Setup procedure or configured as supported PLMN(s), e.g. when shared MBMS network is deployed; the MME need not check it. + +## 7.13.2 MBMS Session Start Response + +The MBMS Session Start Response message shall be sent as a response to the MBMS Session Start Request message on the Sm/Sn interface by the MME/SGSN to the MBMS GW. + +Table 7.13.2-1 specifies the presence of the IEs in the message. + +Possible Cause values are specified in Table 8.4-1. + +**Table 7.13.2-1: Information Elements in a MBMS Session Start Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|---------------------------------|---|---------------------------------------------------------------------------------------------------------|-------------------------------|------| +| Cause | M | | Cause | 0 | +| Sender F-TEID for Control Plane | M | | F-TEID | 0 | +| MBMS Distribution Acknowledge | C | This IE shall be included on the Sn interface. | MBMS Distribution Acknowledge | 0 | +| Sn-U SGSN F-TEID | C | This IE shall be included on the Sn interface if some RNCs have not accepted IP multicast distribution. | F-TEID | 1 | +| Recovery | C | This IE shall be included if contacting the peer for the first time. | Recovery | 0 | +| Private Extension | O | | Private Extension | VS | + +### 7.13.3 MBMS Session Update Request + +The MBMS Session Update Request message shall be sent on the Sm/Sn interface by the MBMS GW to the MME/SGSN as specified in 3GPP TS 23.246 [37] and 3GPP TS 23.007 [13]. + +Table 7.13.3-1 specifies the presence of the IEs in the message. + +**Table 7.13.3-1: Information Elements in a MBMS Session Update Request** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|------------------------------------------|----|-----------------------------------------------------------------------------------------------------------------------|-------------------------------------|------| +| MBMS Service Area | C | This IE shall be forwarded to MME/SGSN if it is provided by the BM-SC. | MBMS Service Area | 0 | +| Temporary Mobile Group Identity (TMGI) | M | | TMGI | 0 | +| Sender F-TEID for Control Plane | O | | F-TEID | 0 | +| MBMS Session Duration | M | | MBMS Session Duration | 0 | +| QoS profile | M | See NOTE 1. | Bearer QoS | 0 | +| MBMS Session Identifier | C | This IE shall be forwarded to MME/SGSN if it is provided by the BM-SC. | MBMS Session Identifier | 0 | +| MBMS Flow Identifier | C | This IE shall be forwarded to MME/SGSN if it is provided by the BM-SC. | MBMS Flow Identifier | 0 | +| MBMS Time to Data Transfer | CO | This IE shall be forwarded to MME/SGSN if it is provided by the BM-SC. | MBMS Time to Data Transfer | 0 | +| MBMS Data Transfer Start / Update / Stop | CO | This IE shall be forwarded to the MME if it is received from the BM-SC.
See NOTE 3. | Absolute Time of MBMS Data Transfer | 0 | +| MBMS Cell List | CO | The MBMS GW shall include this IE on the Sm interface if a MBMS Cell List was received from the BM-SC.
See NOTE 2. | ECGI List | 0 | +| Private Extension | O | | Private Extension | VS | + +NOTE 1: The uplink GBR and uplink MBR shall be ignored by MME/SGSN as specified in Clause 20.5 of 3GPP TS 29.061 [38]. + +NOTE 2: The MBMS Cell List can contain from 1 up to 4096 cells (see 3GPP TS 29.061 [38]). + +NOTE 3: The MME copies the absolute time received in this IE into the Time of MBMS Data Transfer IE in the M3AP MBMS SESSION START REQUEST or MBMS SESSION UPDATE REQUEST, or into the Time of MBMS Data Stop IE in the M3AP MBMS SESSION STOP REQUEST, as appropriate. See 3GPP TS 23.246 [37] and 3GPP TS 36.444 [79]. + +### 7.13.4 MBMS Session Update Response + +The MBMS Session Update Response message shall be sent as a response to the MBMS Session Update Request message on the Sm/Sn interface by the MME/SGSN to the MBMS GW. + +Table 7.13.4-1 specifies the presence of the IEs in the message. + +Possible Cause values are specified in Table 8.4-1. + +**Table 7.13.4-1: Information Elements in a MBMS Session Update Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|-------------------------------|---|---------------------------------------------------------------------------------------------------------------------------|-------------------------------|------| +| Cause | M | | Cause | 0 | +| MBMS Distribution Acknowledge | C | This IE shall be included on the Sn interface if service area is changed. | MBMS Distribution Acknowledge | 0 | +| Sn-U SGSN F-TEID | C | This IE shall be included on the Sn interface if any of the newly added RNCs have not accepted IP multicast distribution. | F-TEID | 0 | +| Recovery | C | This IE shall be included if contacting the peer for the first time. | Recovery | 0 | +| Private Extension | O | | Private Extension | VS | + +### 7.13.5 MBMS Session Stop Request + +The MBMS Session Stop Request message shall be sent on the Sm/Sn interface by the MBMS GW to the MME/SGSN as specified in 3GPP TS 23.246 [37] and 3GPP TS 23.007 [13]. + +Table 7.13.5-1 specifies the presence of the IEs in the message. + +**Table 7.13.5-1: Information Elements in a MBMS Session Stop Request** + +| Info specified in Table 8.4-1.formation elements | P | Condition / Comment | IE Type | Ins. | +|--------------------------------------------------|----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|------| +| MBMS Flow Identifier | C | This IE shall be forwarded to MME/SGSN if it is provided by the BM-SC. See NOTE 1. | MBMS Flow Identifier | 0 | +| MBMS Data Transfer Stop | CO | This IE shall be forwarded to the MME if it is received from the BM-SC. | Absolute Time of MBMS Data Transfer | 0 | +| MBMS Flags | CO | This IE shall be included if any one of the applicable flags is set to 1.
Applicable flags:
- Local MBMS Bearer Context Release Indication: this flag shall be set to 1 on the Sm/Sn interfaces if the MBMS Session Stop Request message is used to release the MBMS bearer context locally in the MME/SGSN (see 3GPP TS 23.007 [13]). | MBMS Flags | 0 | +| Private Extension | O | | Private Extension | VS | + +NOTE 1: The conditional MBMS Flow Identifier IE is redundant as MBMS Session Stop Request message is sent over non-zero TEID header. The receiver may ignore the MBMS Flow Identifier IE. + +### 7.13.6 MBMS Session Stop Response + +The MBMS Session Stop Response message shall be sent as a response to the MBMS Session Stop Request message on the Sm/Sn interface by the MME/SGSN to the MBMS GW. + +Table 7.13.6-1 specifies the presence of the IEs in the message. + +Possible Cause values are specified in Table 8.4-1. + +**Table 7.13.6-1: Information Elements in a MBMS Session Stop Response** + +| Information elements | P | Condition / Comment | IE Type | Ins. | +|----------------------|----|----------------------------------------------------------------------|-------------------|------| +| Cause | M | | Cause | 0 | +| Recovery | CO | This IE shall be included if contacting the peer for the first time. | Recovery | 0 | +| Private Extension | O | | Private Extension | VS | + +## 8 GTP-C Information Elements + +### 8.1 Information Element Types + +A GTP control plane (signalling) message may contain several information elements. In order to have forward compatible type definitions for the GTPv2 information elements, all of them shall be TLIV (Type, Length, Instance, Value) coded. GTPv2 information element type values are specified in the Table 8.1-1. The last column of this table indicates whether the information element is: + +- Fixed Length: the IE has a fixed set of fields, and a fixed number of octets. +- Variable Length: the IE has a fixed set of fields, and has a variable number of octets. +For example, the last octets may be numbered similar to "5 to (n+4)". In this example, if the value of the length field, n, is 0, then the last field is not present. +- Extendable: the IE has a variable number of fields, and has a variable number of octets. +The last fields are typically specified with the statement: "These octet(s) is/are present only if explicitly specified". The legacy receiving entity shall ignore the unknown octets. + +In order to improve the efficiency of troubleshooting, it is recommended that the information elements should be arranged in the signalling messages as well as in the grouped IEs, according to the order the information elements are listed in the message definition table or grouped IE definition table in clause 7. However the receiving entity shall be prepared to handle the messages with information elements in any order. + +Within information elements, certain fields may be described as spare. These bits shall be transmitted with the value set to 0. To allow for future features, the receiver shall not evaluate these bits. GTPv2-C information elements that have similar semantics in GTPv1-C shall be converted into GTPv1-C format, as specified in TS 29.060 [4], before sending them to a pre-R8 GSN. + +**Table 8.1-1: Information Element types for GTPv2** + +| IE Type value (Decimal) | Information elements | Comment / Reference | Number of Fixed Octets | +|-------------------------|----------------------------------------------------------------|-------------------------|------------------------------| +| 0 | Reserved | | | +| 1 | International Mobile Subscriber Identity (IMSI) | Variable Length / 8.3 | Not Applicable | +| 2 | Cause | Variable Length / 8.4 | Not Applicable | +| 3 | Recovery (Restart Counter) | Variable Length / 8.5 | Not Applicable | +| 4 to 34 | Reserved for S101 interface | See 3GPP TS 29.276 [14] | See 3GPP TS 29.276 [14] | +| 35 to 50 | Reserved for S121 interface | See 3GPP TS 29.276 [14] | See 3GPP TS 29.276 [14] | +| 51 | STN-SR | See 3GPP TS 29.280 [15] | See 3GPP TS 29.280 [15] | +| 56 | SRVCC Cause | See 3GPP TS 29.280 [15] | See 3GPP TS 29.280 [15] | +| 52 to 70 | Reserved for Sv interface | See 3GPP TS 29.280 [15] | See 3GPP TS 29.280 [15] | +| 71 | Access Point Name (APN) | Variable Length / 8.6 | Not Applicable | +| 72 | Aggregate Maximum Bit Rate (AMBR) | Fixed Length / 8.7 | 8 | +| 73 | EPS Bearer ID (EBI) | Extendable / 8.8 | 1 | +| 74 | IP Address | Variable Length / 8.9 | Not Applicable | +| 75 | Mobile Equipment Identity (MEI) | Variable Length / 8.10 | Not Applicable | +| 76 | MSISDN | Variable Length / 8.11 | Not Applicable | +| 77 | Indication | Extendable / 8.12 | 2 | +| 78 | Protocol Configuration Options (PCO) | Variable Length / 8.13 | Not Applicable | +| 79 | PDN Address Allocation (PAA) | Variable Length / 8.14 | Not Applicable | +| 80 | Bearer Level Quality of Service (Bearer QoS) | Extendable / 8.15 | 22 | +| 81 | Flow Quality of Service (Flow QoS) | Extendable / 8.16 | 21 | +| 82 | RAT Type | Extendable / 8.17 | 1 | +| 83 | Serving Network | Extendable / 8.18 | 3 | +| 84 | EPS Bearer Level Traffic Flow Template (Bearer TFT) | Variable Length / 8.19 | Not Applicable | +| 85 | Traffic Aggregation Description (TAD) | Variable Length / 8.20 | Not Applicable | +| 86 | User Location Information (ULI) | Extendable / 8.21 | "f+4-4" (See Figure 8.21-1) | +| 87 | Fully Qualified Tunnel Endpoint Identifier (F-TEID) | Extendable / 8.22 | 9/21/25 | +| 88 | TMSI | Variable Length / 8.23 | Not Applicable | +| 89 | Global CN-Id | Variable Length / 8.24 | Not Applicable | +| 90 | S103 PDN Data Forwarding Info (S103PDF) | Variable Length / 8.25 | Not Applicable | +| 91 | S1-U Data Forwarding Info (S1UDF) | Variable Length / 8.26 | Not Applicable | +| 92 | Delay Value | Extendable / 8.27 | 1 | +| 93 | Bearer Context | Extendable / 8.28 | Not Applicable | +| 94 | Charging ID | Extendable / 8.29 | 4 | +| 95 | Charging Characteristics | Extendable / 8.30 | 2 | +| 96 | Trace Information | Variable Length / 8.31 | Not Applicable | +| 97 | Bearer Flags | Extendable / 8.32 | 1 | +| 98 | Reserved | | | +| 99 | PDN Type | Extendable / 8.34 | 1 | +| 100 | Procedure Transaction ID | Extendable / 8.35 | 1 | +| 101 | Reserved | | | +| 102 | Reserved | | | +| 103 | MM Context (GSM Key and Triplets) | Extendable / 8.38 | "r+1-4" (See Figure 8.38-1) | +| 104 | MM Context (UMTS Key, Used Cipher and Quintuplets) | Extendable / 8.38 | "r+1-4" (See Figure 8.38-2) | +| 105 | MM Context (GSM Key, Used Cipher and Quintuplets) | Extendable / 8.38 | "r+1-4" (See Figure 8.38-3) | +| 106 | MM Context (UMTS Key and Quintuplets) | Extendable / 8.38 | "r+1-4" (See Figure 8.38-4) | +| 107 | MM Context (EPS Security Context, Quadruplets and Quintuplets) | Extendable / 8.38 | "s+64-4" (See Figure 8.38-5) | +| 108 | MM Context (UMTS Key, Quadruplets and Quintuplets) | Extendable / 8.38 | "r+1-4" (See Figure 8.38-6) | +| 109 | PDN Connection | Extendable / 8.39 | Not Applicable | +| 110 | PDU Numbers | Extendable / 8.40 | 9 | +| 111 | P-TMSI | Variable Length / 8.41 | Not Applicable | +| 112 | P-TMSI Signature | Variable Length / 8.42 | Not Applicable | +| 113 | Hop Counter | Extendable / 8.43 | 1 | +| 114 | UE Time Zone | Extendable / 8.44 | 2 | +| 115 | Trace Reference | Fixed Length / 8.45 | 6 | +| 116 | Complete Request Message | Variable Length / 8.46 | Not Applicable | +| 117 | GUTI | Variable Length / 8.47 | Not Applicable | +| 118 | F-Container | Variable Length / 8.48 | Not Applicable | +| 119 | F-Cause | Variable Length / 8.49 | Not Applicable | +| 120 | PLMN ID | Variable Length / 8.50 | Not Applicable | +| 121 | Target Identification | Variable Length / 8.51 | Not Applicable | +| 122 | Reserved | | | +| 123 | Packet Flow ID | Variable Length / 8.53 | Not Applicable | +| 124 | RAB Context | Fixed Length / 8.54 | 9 | +| 125 | Source RNC PDCP Context Info | Variable Length / 8.55 | Not Applicable | +| 126 | Port Number | Extendable / 8.56 | 2 | +| 127 | APN Restriction | Extendable / 8.57 | 1 | +| 128 | Selection Mode | Extendable / 8.58 | 1 | + +| IE Type value (Decimal) | Information elements | Comment / Reference | Number of Fixed Octets | +|-------------------------|---------------------------------------------------------|-------------------------|------------------------------| +| 129 | Source Identification | Variable Length / 8.59 | Not Applicable | +| 130 | Reserved | | | +| 131 | Change Reporting Action | Variable Length / 8.61 | Not Applicable | +| 132 | Fully Qualified PDN Connection Set Identifier (FQ-CSID) | Extendable / 8.62 | "q+1-4" (See Figure 8.62-1) | +| 133 | Channel needed | Variable Length / 8.63 | Not Applicable | +| 134 | eMLPP Priority | Variable Length / 8.64 | Not Applicable | +| 135 | Node Type | Extendable / 8.65 | 1 | +| 136 | Fully Qualified Domain Name (FQDN) | Variable Length / 8.66 | Not Applicable | +| 137 | Transaction Identifier (TI) | Variable Length / 8.68 | Not Applicable | +| 138 | MBMS Session Duration | Extendable / 8.69 | 3 | +| 139 | MBMS Service Area | Variable Length / 8.70 | Not Applicable | +| 140 | MBMS Session Identifier | Extendable / 8.71 | 1 | +| 141 | MBMS Flow Identifier | Extendable / 8.72 | 2 | +| 142 | MBMS IP Multicast Distribution | Extendable / 8.73 | "m+1-4" (See Figure 8.73-1) | +| 143 | MBMS Distribution Acknowledge | Extendable / 8.74 | 1 | +| 144 | RFSP Index | Fixed Length / 8.77 | 2 | +| 145 | User CSG Information (UCI) | Extendable / 8.75 | 8 | +| 146 | CSG Information Reporting Action | Extendable / 8.76 | 1 | +| 147 | CSG ID | Extendable / 8.78 | 4 | +| 148 | CSG Membership Indication (CMI) | Extendable / 8.79 | 1 | +| 149 | Service indicator | Fixed Length / 8.80 | 1 | +| 150 | Detach Type | Fixed Length / 8.81 | 1 | +| 151 | Local Distinguished Name (LDN) | Variable Length / 8.82 | Not Applicable | +| 152 | Node Features | Extendable / 8.83 | 1 | +| 153 | MBMS Time to Data Transfer | Extendable / 8.84 | 1 | +| 154 | Throttling | Extendable / 8.85 | 2 | +| 155 | Allocation/Retention Priority (ARP) | Extendable / 8.86 | 1 | +| 156 | EPC Timer | Extendable / 8.87 | 1 | +| 157 | Signalling Priority Indication | Extendable / 8.88 | 1 | +| 158 | Temporary Mobile Group Identity (TMGI) | Extendable / 8.89 | 6 | +| 159 | Additional MM context for SRVCC | Extendable / 8.90 | "e-4" (See Figure 8.90-1) | +| 160 | Additional flags for SRVCC | Extendable / 8.91 | 1 | +| 161 | Reserved | | | +| 162 | MDT Configuration | Extendable / 8.93 | "q-4" (See Figure 8.93-1) | +| 163 | Additional Protocol Configuration Options (APCO) | Extendable / 8.94 | "m-4" (See Figure 8.94-1) | +| 164 | Absolute Time of MBMS Data Transfer | Extendable / 8.95 | 8 | +| 165 | H(e)NB Information Reporting | Extendable / 8.96 | 1 | +| 166 | IPv4 Configuration Parameters (IP4CP) | Extendable / 8.97 | 5 | +| 167 | Change to Report Flags | Extendable / 8.98 | 1 | +| 168 | Action Indication | Extendable / 8.99 | 1 | +| 169 | TWAN Identifier | Extendable / 8.100 | "k+6-4" (See Figure 8.100-1) | +| 170 | ULI Timestamp | Extendable / 8.101 | 4 | +| 171 | MBMS Flags | Extendable / 8.102 | 1 | +| 172 | RAN/NAS Cause | Extendable / 8.103 | "m-4" (See Figure 8.103-1) | +| 173 | CN Operator Selection Entity | Extendable / 8.104 | 1 | +| 174 | Trusted WLAN Mode Indication | Extendable / 8.105 | 1 | +| 175 | Node Number | Extendable / 8.106 | "p-4" (See Figure 8.106-1) | +| 176 | Node Identifier | Extendable / 8.107 | "q-4" (See Figure 8.107-1) | +| 177 | Presence Reporting Area Action | Extendable / 8.108 | "t-4" (See Figure 8.108-1) | +| 178 | Presence Reporting Area Information | Extendable / 8.109 | 4 | +| 179 | TWAN Identifier Timestamp | Extendable / 8.110 | 4 | +| 180 | Overload Control Information | Extendable / 8.111 | Not Applicable | +| 181 | Load Control Information | Extendable / 8.112 | Not Applicable | +| 182 | Metric | Fixed Length / 8.113 | 1 | +| 183 | Sequence Number | Fixed Length / 8.114 | 4 | +| 184 | APN and Relative Capacity | Extendable / 8.115 | "m-4" (See Figure 8.115) | +| 185 | WLAN Offloadability Indication | Extendable / 8.116 | 1 | +| 186 | Paging and Service Information | Extendable / 8.117 | m-4 (See Figure 8.117-1) | +| 187 | Integer Number | Variable / 8.118 | Not Applicable | +| 188 | Millisecond Time Stamp | Extendable / 8.119 | 6 | +| 189 | Monitoring Event Information | Extendable / 8.120 | "k+2-4" (See Figure 8.120-1) | +| 190 | ECGI List | Extendable / 8.121 | "m*7+2" (See Figure 8.121-1) | +| 191 | Remote UE Context | Extendable / 8.122 | Not Applicable | +| 192 | Remote User ID | Extendable / 8.123 | "c-4" (see Figure 8.123-1) | +| 193 | Remote UE IP information | Variable Length / 8.124 | Not Applicable | +| 194 | CIoT Optimizations Support Indication | Extendable / 8.125 | 1 | +| 195 | SCEF PDN Connection | Extendable / 8.126 | Not Applicable | +| 196 | Header Compression Configuration | Extendable / 8.127 | 4 | +| 197 | Extended Protocol Configuration Options (ePCO) | Variable Length / 8.128 | Not Applicable | + +| IE Type value (Decimal) | Information elements | Comment / Reference | Number of Fixed Octets | +|-------------------------|----------------------------------------|-------------------------|----------------------------| +| 198 | Serving PLMN Rate Control | Extendable / 8.129 | 4 | +| 199 | Counter | Extendable / 8.130 | 5 | +| 200 | Mapped UE Usage Type | Extendable / 8.131 | 2 | +| 201 | Secondary RAT Usage Data Report | Extendable / 8.132 | 27 | +| 202 | UP Function Selection Indication Flags | Extendable / 8.133 | 1 | +| 203 | Maximum Packet Loss Rate | Extendable / 8.134 | 1 | +| 204 | APN Rate Control Status | Extendable / 8.135 | 20 | +| 205 | Extended Trace Information | Extendable / 8.136 | "r-4" (see figure 8.136-1) | +| 206 | Monitoring Event Extension Information | Extendable / 8.137 | "k-4" (See Figure 8.137-1) | +| 207 | Additional RRM Policy Index | Fixed Length / 8.138 | 4 | +| 208 | V2X Context | Extendable / 8.139 | Not Applicable | +| 209 | PC5 QoS Parameters | Extendable / 8.140 | Not Applicable | +| 210 | Services Authorized | Extendable / 8.141 | 2 | +| 211 | Bit Rate | Extendable / 8.142 | 4 | +| 212 | PC5 QoS Flow | Extendable / 8.143 | 11 | +| 213 | SGi PtP Tunnel Address | Extendable / 8.144 | 1 | +| 214 | PGW Change Info | Extendable / 8.145 | Not Applicable | +| 215 | PGW FQDN | Extendable / 8.146 | m-4 | +| 216 | Group Id | Variable Length / 8.147 | Not Applicable | +| 217 | PSCell ID | Fixed Length / 8.148 | 8 | +| 218 | UP Security Policy | Extendable / 8.149 | 1 | +| 219 | Alternative IMSI | Variable Length / 8.150 | Not Applicable | +| 220 | NF Instance ID | Fixed Length / 8.151 | 36 | +| 221 | Timer in Seconds | Extendable / 8.152 | 3 | +| 222 to 253 | Spare. For future use. | | | +| 254 | Special IE type for IE Type Extension | See NOTE 2 | Not Applicable | +| 255 | Private Extension | Variable Length / 8.67 | Not Applicable | +| 256 to 65535 | Spare. For future use. | | | + +NOTE 1: The size of the TLI (Type, Length and Instance) fields, i.e "4" octets, has been subtracted from the number of the fixed octets of the "Fixed Length" and "Extendable" IEs. Hence for some of the "Extendable" IEs, for which the length is defined in terms of variable number of octets, "4" is explicitly subtracted while defining the fixed number of octets. E.g. Length of User Location Information is defined as "f+4" and fixed number of octets for the same is defined as "f+4-4". + +NOTE 2: The IE Type value 254 indicates that the IE Type shall be further identified by an IE Type Extension field; see clause 8.2.1A. A GTP-C entity which does not support any IE Type encoded with an IE Type Extension field shall ignore an IE received with the IE Type value 254. + +## 8.2 Information Element Format + +### 8.2.1 General + +Figure 8.2-1 depicts the format of an information element. + +![](c49149f8f81706aab83bea5771ffb867_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|---------------------------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = xxx (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | IE specific data or content of a grouped IE | | | | | | | | + +Figure 8.2-1: Information Element Format + +An IE has the following mandatory fields: + +- Type field: This field indicates the type of Information Element. The valid values of the IE type are defined in clause 8.1. +- Length: This field contains the length of the information element excluding the first four octets, which are common for all information elements (Type, Length and the contents of octet 4) and is denoted "n" in Figure 8.2-1. For all the length fields, bit 8 of the lowest numbered octet is the most significant bit and bit 1 of the highest numbered octet is the least significant bit. + +- Instance: This field shall be used to differentiate amongst different parameters in one specific message which use the same information element type (see also clause 6.1.3 "Information Element Instance"). + +An IE is said to be TLIV (Type, Length, Instance, Value) encoded. + +## 8.2.1A Information Element with an IE Type Extension field + +Figure 8.2.1A-1 depicts the format of an information element with an IE Type Extension field. + +![](c7bb86c1e9320a155c0e66a3f26f9643_img.jpg) + +| Octets | Bits | | | | | | | | +|----------|-------------------------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 254 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to 6 | IE Type Extension | | | | | | | | +| 7 to n+4 | IE specific data or content of a group IE | | | | | | | | + +**Figure 8.2.1A-1: Information Element with an IE Type Extension field** + +The IE Type in octet 1 of an information element with an IE Type Extension field shall be set to 254. Such IE shall be further identified by the value encoded in the IE Type Extension field in octets 5 and 6. + +The value of the IE Type Extension shall be encoded in full hexadecimal representation (binary, not ASCII encoding) from 256 up to 65535. This field indicates the type of the Information Element and the valid values of the IE type Extension field are defined in clause 8.1. + +The semantics of the Length and Instance field remain the same as specified in clause 8.2.1. + +## 8.2.2 Handling ASN.1/PER encoded parameters + +During the TAU/RAU/HO procedures MME/S4-SGSN GTPv2 entities send some of the RANAP/S1AP/BSSGP parameters to a GTPv2 peer. Copying of the BSSGP parameters into GTPv2 IEs is straightforward. RANAP and S1AP, however, use ASN.1/PER encoding, which is different from GTPv2 specific TLV encoding. + +Transparent copying of RANAP/S1AP parameters across GTPv2 interfaces: + +- a GTPv2 entity shall transparently copy the respective information into one or more octets of the GTPv2 IE as specified in Annex B and clause 8.48. With this approach, GTPv2 will not be impacted if the contents of such RANAP/S1AP parameter changes over the time. + +Non-transparent copying of RANAP/S1AP parameters across GTPv2 interfaces: + +- GTPv2 entity decodes ASN.1/PER parameter and shall encode the value(s) into one or more octets of the GTPv2 IE according to what is specified in the present document. + +## 8.3 International Mobile Subscriber Identity (IMSI) + +International Mobile Subscriber Identity (IMSI) is transferred via GTP tunnels. The sending entity copies the value part of the IMSI into the Value field of the IMSI IE. IMSI is defined in 3GPP TS 23.003 [2]. + +![](bc70ba57738f609407ddaf4f2acbf51e_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|--------------------|---|---|---|------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 1 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Number digit 2 | | | | Number digit 1 | | | | +| 6 | Number digit 4 | | | | Number digit 3 | | | | +| ... | ... | | | | ... | | | | +| n+4 | Number digit m | | | | Number digit m-1 | | | | + +**Figure 8.3-1: IMSI** + +Octets 5 to (n+4) represent the IMSI value in international number format as described in ITU-T Rec E.212 [64], encoded as TBCD digits, i.e. digits from 0 through 9 are encoded "0000" to "1001". When there is an odd number of digits, bits 8 to 5 of the last octet are encoded with the filler "1111". The maximum number of digits is 15. + +## 8.4 Cause + +Cause IE is coded as depicted in Figure 8.4-1. + +| Octets | Bits | | | | | | | | +|---------------------|--------------------------------|---|---|---|----------|-----|----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 2 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Cause value | | | | | | | | +| 6 | Spare | | | | PCE | BCE | CS | | +| a(n+1) | Type of the offending IE | | | | | | | | +| a(n+2) to
a(n+3) | Length of the offending IE = 0 | | | | | | | | +| a(n+4) | Spare | | | | Instance | | | | + +**Figure 8.4-1: Cause** + +Cause is a variable length IE, which may have either of the following two lengths values: + +- If $n = 2$ , $a = 0$ and the Cause IE shall be 6 octets long. Therefore, octets "a(n+1) to a(n+4)" will not be present. +- If $n = 6$ , $a = 1$ and the Cause IE will be 10 octets long. + +For PMIP based S5/S8, the SGW/MAG shall do the mapping between GTPv2 Cause IE and respective PMIPv6 IE as specified in 3GPP TS 29.275 [26]. + +The following bits within Octet 6 indicate: + +- Bits 8 to 4: Spare, for future use and set to zero +- Bit 1 – CS (Cause Source): If this bit is set to 1, it indicates that the corresponding error cause is originated by the remote node (i.e., the MME/SGSN to a PGW, or the PGW to an MME/SGSN). This bit is set to 0 to denote that the corresponding error cause is originated by the node sending the message. + +The CS should be set to 1 by the SGW when the SGW relay a response message with cause value from the MME/SGSN to the PGW or from the PGW to the MME/SGSN. For PMIP based S5/S8, the SGW shall set the CS bit to 1 when the SGW/MAG relay a response message with the cause value from the PGW/LMA to the MME/SGSN. + +- Bit 2 – BCE (Bearer Context IE Error): If this bit is set to 1, it indicates that the corresponding rejection cause is due to the error in the Bearer Context IE. This bit shall be discarded if the cause value is one of Acceptance cause value as given in table 8.4-1. +- Bit 3 – PCE (PDN Connection IE Error): If this bit is set to 1, it indicates that the corresponding rejection cause is due to the error in the PDN Connection IE. This bit shall be discarded if the cause value is one of Acceptance cause value as given in table 8.4-1. + +The Cause value shall be included in a response message. In a response message, the Cause value indicates the acceptance or the rejection of the corresponding request message. The Cause value indicates the explicit reason for the rejection. + +If the rejection is due to a mandatory IE or a verifiable conditional IE is faulty or missing, the offending IE shall be included within an additional field "a(n+1) to a(n+4)". Only Type and Instance fields of the offending IE that caused the rejection have a meaning. The length in the Octet 8-9 and spare bits in the Octet 10 shall be set to "0". In this case, the value of "n" shall be "6". Otherwise, the value of "n" is equal to "2". + +The Cause may also be included in the request message. In a request message, the Cause value indicates the reason for the request. + +"Request accepted" is returned when the GTPv2 entity has accepted a control plane request. + +"Context Not Found" is used in the response message by a GTP entity when it receives a message for which it does not have context, e.g. TEID-C or EBI is not known. When "Context Not Found" is received at Bearer Context IE level, it means the bearer context is unknown in the peer. When "Context Not Found" is received at message level together with a known TEID-C in the GTPv2-C header in the response message, this indicates some bearer contexts are not known in the peer; the sender of the request message should further determine, based on the bearer context(s) included in the request message, that: + +- if the default bearer is unknown, this means the PDN connection is not known in the peer; +- if one or more dedicated bearers are unknown, this means only those dedicated bearer contexts are not known in the peer. + +"Context Not Found" may be used by the PGW in the Create Session Response message during the non-3GPP to 3GPP access handover procedures, if the request corresponds to the handover of a PDN connection which does not exist in the PGW. + +"Context Not Found" may be used by the PGW in the Create Session Response message during the 3GPP to non-3GPP access handover procedures, if the request corresponds to the handover of a PDN connection which does not exist in the PGW. + +"Service not supported" is used by the GTP entity when it receives a message, which corresponds to a feature or a service which is not supported by the node. + +"Service denied" is used when the requested service cannot be granted. + +"System failure" is used by the GTP entity to indicate a generic error condition. + +"No resources available" is used by the GTP entity to indicate the temporary unavailability of the resource(s) to process the received request. + +"Semantic error in the TFT operation", "Syntactic error in the TFT operation", "Semantic errors in packet filter(s)", "Syntactic errors in packet filters(s)", "UE context without TFT already activated", "Semantic error in the TAD operation" and "Syntactic error in the TAD operation" are indications of error cases involving TFT(s)/TAD(s) as specified in clause 7.7.11 in this specification. + +"Missing or unknown APN" is used by the PGW when it does not support the Access Point Name, received in Create Session Request message. + +"Relocation failure" is used by the target MME/S4-SGSN to indicate the source MME/S4-SGSN that the relocation has failed. + +"Relocation failure due to NAS message redirection" is used by the new MME/S4-SGSN to indicate to the old MME/S4-SGSN that the TAU/RAU procedure is not successful due to NAS message redirection as described in 3GPP TS 23.401 [3], or used by the initial AMF to indicate to the old MME that the context transfer procedure is not successful due to NAS message redirection as described in clause 4.11.1.3.4 of 3GPP TS 23.502 [83]. + +"Denied in RAT" is used by the GTP entity to indicate that the requested service is not accepted in the RAT. + +"Preferred PDN type not supported" is used by the PGW to indicate that the PDN type received in the Create Session Request message is not supported by the PGW for the PDN corresponding to the received Access Point Name. + +"Protocol type not supported" is used by the SGW to indicate that the S5/S8 protocol type requested by the MME/S4-SGSN is not supported by it. + +"UE not responding" is used by the MME/S4-SGSN to indicate that the UE is not responding to the request initiated by the network, e.g. Paging. + +"UE refuses" is used by the GTP entity to indicate that the UE, without specifying further detail, rejected the request from the network. + +"Unable to page UE" is used by the MME/S4-SGSN to indicate its inability to page the UE, temporarily. + +"User authentication failed" is used by the GTP entity to indicate that the request is rejected due to a failure in the authentication/security procedure, or because the required user authentication cannot be performed (when the UE does not support secondary DN authentication and authorization over EPC but such a procedure is mandatory due to local policies in a combined PGW-C/SMF), or is used by a combined PGW-C/SMF for an UUAA-SM during PDN + +connection establishment procedure as described in clause 5.2.3.3 of 3GPP TS 23.256 [90] or in authorization for C2 procedure as described in clause 5.2.5.3 of 3GPP TS 23.256 [90]. + +"APN access denied – no subscription" is used to indicate that the PGW has denied the user access to an APN because a subscription is required, but the subscriber does not have the necessary subscription. + +"Remote peer not responding" is used by the SGW for the messages spanning through two interfaces. This cause value is returned by the SGW to the MME/S4-SGSN or PGW in a response message where no response message is received from the PGW or MME/S4-SGSN. + +"Collision with network initiated request" is used by the PGW to indicate that the UE-initiated bearer resource allocation/modification request is rejected since the PGW has requested a bearer resource allocation/modification for the same service using a network-initiated procedure. + +"Unable to page UE due to Suspension" is used by the MME/S4-SGSN to indicate that the UE has not been paged because the bearers of the UE are in a suspended state. + +"APN Restriction type Incompatible with currently active PDN connection" is used by the PGW to indicate that the newly requested PDN connection has APN restriction value that is not compatible with the currently active PDN connection(s)'s APN restriction value(s). + +"Invalid peer" is used by the SGW to indicate that currently the UE is being managed by the different node (e.g. MME/S4-SGSN) than the node (e.g. S4-SGSN/MME) which has sent the Delete Session Request message. + +"Invalid Reply from remote peer" is used by the SGW for the messages spanning through two interfaces. This cause value is returned by the SGW to the MME/SGSN or PGW in a reply message where the corresponding reply message on S5/S8 or S11/S4 from the PGW or MME/SGSN is not decoded as valid. + +"Temporarily rejected due to handover/TAU/RAU procedure in progress" is used by the MME/S4-SGSN for the bearer related procedure initiated by the PGW. When the handover/TAU/RAU with/without SGW change and/or MME/S4-SGSN change is in progress, the MME/S4-SGSN may receive Create / Update / Delete Bearer request message for the bearer creation, modification or deletion initiated by the PGW. If the handover/TAU/RAU procedure results in the SGW and/or MME/S4-SGSN change, then the bearer related procedure cannot be handled temporarily by the MME/S4-SGSN till the handover/TAU/RAU procedure is completed. In that case the MME/S4-SGSN shall reject the bearer related procedure with this rejection cause. This cause is also used to indicate that the Downlink Data Notification message is rejected temporarily due to the mobility procedures with MME or SGSN change in progress as specified in clause 5.3.4.3 in 3GPP TS 23.401 [3]. + +The usage of "Fallback to GTPv1" is specified in clause 7.10 "Fallback to GTPv1 mechanism". + +In the PGW initiated bearer deactivation procedure for the default bearer, the PGW may include the Cause IE in the Delete Bearer Request with values "RAT changed from 3GPP to Non-3GPP", "Reactivation requested" or "Reactivation disallowed to APN". + +"APN Congestion" is used by the PGW and it indicates that the PGW has detected congestion for the requested APN and performs overload control for that APN which does not allow the PDN connection to be established. + +"GTP-C Entity Congestion" is used to indicate that the GTP-C entity has detected node level congestion and performs overload control at the node level, which does not allow the request to be processed. + +"UE already re-attached" is used by MME/S4-SGSN for the network triggered service restoration procedure as specified in 3GPP TS 23.007 [17]. The MME/S4-SGSN may send the Downlink Data Notification Acknowledge or Downlink Data Notification Failure Indication with this cause as part of the network triggered service restoration procedure. + +"PDP connection inactivity timer expires" is used by the PGW in Delete Bearer Request(s) to indicate that all the bearer(s) for the emergency PDN connection are deleted upon the inactivity timer expiry as specified in 3GPP TS 23.203 [48]. + +"Network failure" is used by the SGSN or MME in the Delete Session Request to indicate that the message is sent due to a network problem. + +"QoS parameter mismatch" is used by the SGSN or MME in the Delete Session Request to indicate that the PDN connection can not be established due to a QoS parameter mismatch. + +"MME/SGSN refuses due to VPLMN policy" is used by the MME/SGSN in the VPLMN to indicate to the PGW in the Create Bearer Response or Update Bearer Response that it does not allow the establishment or modification of the bearer due to VPLMN operator's policy. + +The listed cause values for rejection response message descriptions in clause 7 are not meant to be exhaustive lists. Therefore a GTPv2 node shall use the most appropriate matching rejection response cause value that is listed in Table 8.4-1. + +If a Bearer Resource Command message is related to an established PDN connection for LIPA or for SIPTO at the local network, the LGW shall reject the Bearer Resource Command with the cause value of "Bearer handling not supported". + +"Multiple PDN connections for a given APN not allowed" is used by SGW for reply message to the MME/S4-SGSN when PMIP-based S5/S8 is used. If either SGW or PGW does not support the multiple PDN connections to the same APN function, the SGW shall reject the PDN connectivity request procedure with this rejection cause when receiving Create Session Request for additional PDN connectivity to the given APN from the same UE. + +As specified in clause 5.3.1.1 in 3GPP TS 23.401 [3] and clause 9.2.1 in 3GPP TS 23.060 [35], the cause value "New PDN type due to network preference" indicates that the UE has requested PDN type IPv4v6 and only IPv4 or IPv6 address is allowed for the PDN based on PGW operator policy. + +As specified in clause 5.3.1.1 in 3GPP TS 23.401 [3] and clause 9.2.1 in 3GPP TS 23.060 [35], the cause value "New PDN type due to single address bearer only" indicates that the MS has requested PDN type IPv4v6 and both IPv4 and IPv6 addressing is possible in the PDN but the Dual Address Bearer Flag of the Indication IE is set to 0 or the Indication IE is absent, or only single IP version addressing is possible in the PDN. + +"PGW not responding" is used by the SGW in PGW Restart Notification to indicate that the peer PGW has failed and not restarted as specified in clause 7.9.5. + +"UE context without TFT already activated" is used by the PGW in the Bearer Resource Failure Indication message to indicate that the PGW has received the Bearer Resource Command message without TAD IE in the secondary PDP Context Activation procedure. + +"Target access restricted for the subscriber" is used by the MME/SGSN in the Context Response message to indicate that the target access is prohibited for the subscriber, based on the subscription profile. + +"P-TMSI Signature mismatch" is used by the SGSN or MME in the Identification Response and Context Response message if the P-TMSI Signature stored in the old SGSN or MME does not match the value sent by the UE via the new SGSN or MME. + +"Late Overlapping Request" is used by the PGW in the Create Session Response to indicate that the incoming request collides with an existing session which has a more recent time stamp than the time stamp of the new request, as specified in clause 13.2. + +"Timed Out Request" is used by the SGW and PGW in the Create Session Response to indicate that the incoming request is known to have already timed out at the originating entity, as specified in clause 13.3. + +"UE is temporarily not reachable due to power saving" is used by the MME/SGSN in the Create/Update Bearer Response message to reject the corresponding network initiated procedures for a Delay Tolerant PDN connection and also request the PGW to hold the network initiated procedure until it receives the subsequent Modify Bearer Request message with the UASI flag indicating that the UE is available for end to end signalling. + +"UE not authorised by OCS or external AAA Server" is used by the PGW in the Create Session Response to reject the corresponding UE initiated procedures when the OCS or an external AAA Server on SGi did not authorise it and the support of the Cause Code was indicated by the SGSN/MME within the Create Session Request. + +If a Create Session Request message requests the addition of an access to a PDN connection, and NBIFOM is not supported by the MME/SGSN, SGW or TWAN, the PGW should reject the request with the cause value of "Multiple accesses to a PDN connection not allowed". This cause is also used by the PGW in the Delete Bearer Request message to initiate the removal of 3GPP access from the PDN connection due to detection of the MME/SGSN or SGW not supporting NBIFOM at the inter-PLMN mobility procedure. + +"Request rejected due to UE capability" is used by the MME in the Create Bearer Response to reject the request to add an EPS bearer that would exceed the UE capability (e.g. a NB-IoT UE can only support up to 2 EPS bearers). This cause value does not prevent the PGW from sending Create Bearer Request later. + +"S1-U Path Failure" is used by the SGW in the Create Session Response, or in the Modify Bearer Response message, or in the Modify Access Bearer Response message to report an S1-U path failure. The SGW may include this cause code in a Downlink Data Notification message and/or a Delete Bearer Request message to report the S1-U path failure. See clause 20.3 in 3GPP TS 23.007 [17]. + +"EPS to 5GS Mobility" is used by the PGW, and it indicates that PGW initiated bearer deactivation procedure is due to EPS to 5GS mobility procedures. + +"5GC not allowed" is used by the source MME in the Context Response message sent to the target AMF during an EPS to 5GS idle mode mobility procedure, to indicate that the UE is not allowed for 5GC, based on the subscription profile. + +"PGW mismatch with network slice subscribed by the UE" is used by the PGW in the Create Session Response message during an EPS to 5GS mobility procedure, to indicate that the PGW is not serving the network slice subscribed by the UE for the APN/DNN. + +"Rejection due to paging restriction" is used by the MME to indicate that the UE has not been paged because the MME holds stored Paging Restriction information for the UE that restricts the Downlink Data from causing paging as specified in clause 4.3.33.6 in 3GPP TS 23.401 [3] or the UE has rejected the page as specified in clause 4.3.33.4 in 3GPP TS 23.401 [3]. + +**Table 8.4-1: Cause values** + +| Message Type | Cause value (decimal) | Meaning | +|-----------------------------------------------------------|-----------------------|---------------------------------------------------------------------------------------------------| +| | 0 | Reserved. Shall not be sent and if received the Cause shall be treated as an invalid IE | +| Request / Initial message | 1 | Reserved | +| | 2 | Local Detach | +| | 3 | Complete Detach | +| | 4 | RAT changed from 3GPP to Non-3GPP | +| | 5 | ISR deactivation | +| | 6 | Error Indication received from RNC/eNodeB/S4-SGSN/MME | +| | 7 | IMSI Detach Only | +| | 8 | Reactivation Requested | +| | 9 | PDN reconnection to this APN disallowed | +| | 10 | Access changed from Non-3GPP to 3GPP | +| | 11 | PDN connection inactivity timer expires | +| | 12 | PGW not responding | +| | 13 | Network Failure | +| | 14 | QoS parameter mismatch | +| | 15 | EPS to 5GS Mobility | +| Acceptance in a Response / triggered message. See NOTE 1. | 16 | Request accepted | +| | 17 | Request accepted partially | +| | 18 | New PDN type due to network preference. | +| | 19 | New PDN type due to single address bearer only. | +| | 20 to 63 | Spare. This value range shall be used by Cause values in an acceptance response/triggered message | +| Rejection in a | 64 | Context Not Found | + +| | | | +|----------------------------------------------------|-----|--------------------------------------------------------------------------------------------| +| Response /
triggered
message. See
NOTE 1. | 65 | Invalid Message Format | +| | 66 | Version not supported by next peer | +| | 67 | Invalid length | +| | 68 | Service not supported | +| | 69 | Mandatory IE incorrect | +| | 70 | Mandatory IE missing | +| | 71 | Shall not be used. See NOTE 2 and NOTE 3. | +| | 72 | System failure | +| | 73 | No resources available | +| | 74 | Semantic error in the TFT operation | +| | 75 | Syntactic error in the TFT operation | +| | 76 | Semantic errors in packet filter(s) | +| | 77 | Syntactic errors in packet filter(s) | +| | 78 | Missing or unknown APN | +| | 79 | Shall not be used. See NOTE 2 and NOTE 3. | +| | 80 | GRE key not found | +| | 81 | Relocation failure | +| | 82 | Denied in RAT | +| | 83 | Preferred PDN type not supported | +| | 84 | All dynamic addresses are occupied | +| | 85 | UE context without TFT already activated. See NOTE 6. | +| | 86 | Protocol type not supported | +| | 87 | UE not responding. See NOTE 7. | +| | 88 | UE refuses | +| | 89 | Service denied. See NOTE 7. | +| | 90 | Unable to page UE | +| | 91 | No memory available | +| | 92 | User authentication failed | +| | 93 | APN access denied – no subscription | +| | 94 | Request rejected (reason not specified) | +| | 95 | P-TMSI Signature mismatch | +| | 96 | IMSI/IMEI not known | +| | 97 | Semantic error in the TAD operation | +| | 98 | Syntactic error in the TAD operation | +| | 99 | Shall not be used. See NOTE 2 and NOTE 3. | +| | 100 | Remote peer not responding | +| | 101 | Collision with network initiated request | +| | 102 | Unable to page UE due to Suspension | +| | 103 | Conditional IE missing | +| | 104 | APN Restriction type Incompatible with currently active PDN connection | +| | 105 | Invalid overall length of the triggered response message and a piggybacked initial message | +| | 106 | Data forwarding not supported | +| | 107 | Invalid reply from remote peer | +| | 108 | Fallback to GTPv1 | +| | 109 | Invalid peer | +| | 110 | Temporarily rejected due to handover/TAU/RAU procedure in progress | +| | 111 | Modifications not limited to S1-U bearers | +| | 112 | Request rejected for a PMIPv6 reason (see 3GPP TS 29.275 [26]). | +| | 113 | APN Congestion | +| | 114 | Bearer handling not supported | +| | 115 | UE already re-attached. See NOTE 7. | +| | 116 | Multiple PDN connections for a given APN not allowed | +| | 117 | Target access restricted for the subscriber | +| | 118 | Shall not be used. See NOTE 2 and NOTE 3. | +| | 119 | MME/SGSN refuses due to VPLMN Policy | +| | 120 | GTP-C Entity Congestion | +| | 121 | Late Overlapping Request | +| | 122 | Timed out Request | +| | 123 | UE is temporarily not reachable due to power saving | +| | 124 | Relocation failure due to NAS message redirection | +| | 125 | UE not authorised by OCS or external AAA Server | +| | 126 | Multiple accesses to a PDN connection not allowed | +| | 127 | Request rejected due to UE capability | +| | 128 | S1-U Path Failure. See NOTE 8. | + +| | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|-------------------------------------------------------------------| +| | 129 | 5GC not allowed | +| | 130 | PGW mismatch with network slice subscribed by the UE | +| | 131 | Rejection due to paging restriction (NOTE 7) | +| | 132 to 239 | Spare. For future use in a triggered/response message See NOTE 4. | +| Request / Initial message | 240 to 255 | Spare. For future use in an initial/request message. See NOTE 5. | +| NOTE 1: The listed cause values for rejection in a response/triggered message can be also used for request messages if the request message is triggered by a command message. | | | +| NOTE 2: Clause 7.7.8 "Semantically incorrect Information Element" specifies quite strict handling of the reserved values and therefore this table shall not contain any reserved values. | | | +| NOTE 3: This value was used in earlier versions of the spec. If received, it shall be interpreted as unspecified rejection cause. Unspecified/unrecognized rejection cause shall be treated in the same ways as the cause value 94 "Request rejected (reason not specified)". | | | +| NOTE 4: This value is or may be used in the newer versions of the spec. If the receiver cannot comprehend the value, it shall be interpreted as unspecified rejection cause. Unspecified/unrecognized rejection cause shall be treated in the same ways as the cause value 94 "Request rejected (reason not specified)". | | | +| NOTE 5: This value is or may be used in the newer versions of the spec. If the receiver cannot comprehend the value, it shall be interpreted as an unspecified request/initial message cause. Unspecified/unrecognized cause handling in a request/initial message shall be implementation dependent (e.g. may be ignored). | | | +| NOTE 6: This Cause value is only used over the S4, S5 and S8 interface in the secondary PDP Context Activation procedure (see 9.2.2.1.1A in 3GPP TS 23.060 [4]). | | | +| NOTE 7: This cause value may also be used by a Downlink Data Notification Failure Indication, which is an initial message. | | | +| NOTE 8: This cause code may also be used in a Downlink Data Notification and a Delete Bearer Request message, which are initial messages. | | | + +The mapping at the MME/S4-SGSN between GTP cause values received over the S11/S4 interface and the NAS cause values sent to the UE is specified in Annex C. + +## 8.5 Recovery (Restart Counter) + +Recovery IE is coded as depicted in Figure 8.5-1. + +The Recovery (Restart Counter) is encoded as 1 octet. + +| Octets | Bits | | | | | | | | +|------------|----------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 3 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | Recovery (Restart Counter) | | | | | | | | + +Figure 8.5-1: Recovery (Restart Counter) + +## 8.6 Access Point Name (APN) + +Access Point Name (APN) is transferred via GTP tunnels. The sending entity copies the value part of the APN into the Value field of the APN IE. + +| Octets | Bits | | | | | | | | +|------------|-------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 71 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | Access Point Name (APN) | | | | | | | | + +Figure 8.6-1: Access Point Name (APN) + +The encoding the APN field follows 3GPP TS 23.003 [2] clause 9.1. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [2] clauses 9.1.1 and 9.1.2, 3GPP TS 23.060 [35] Annex A and 3GPP TS 23.401 [3] clauses 4.3.8.1. + +NOTE: The APN field is not encoded as a dotted string as commonly used in documentation. + +## 8.7 Aggregate Maximum Bit Rate (AMBR) + +Aggregate Maximum Bit Rate (AMBR) is transferred via GTP tunnels. The sending entity copies the value part of the AMBR into the Value field of the AMBR (APN-AMBR) IE. + +AMBR is defined in clause 9.9.4.2 of 3GPP TS 24.301 [23], but it shall be encoded as shown in Figure 8.7-1 as Unsigned32 binary integer values in kbps (1000 bits per second). + +| Octets | Bits | | | | | | | | | | | | +|---------|-----------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 72 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = 8 | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 8 | APN-AMBR for uplink | | | | | | | | | | | | +| 9 to 12 | APN-AMBR for downlink | | | | | | | | | | | | + +Figure 8.7-1: Aggregate Maximum Bit Rate (AMBR) + +The APN-AMBR for uplink and the APN-AMBR for downlink may require converting values in bits per second to kilo bits per second when the APN-AMBR for uplink and the APN-AMBR for downlink are received from an interface other than GTPv2 interface. If such conversions result in fractions, then the value of APN-AMBR for uplink and the APN-AMBR for downlink shall be rounded upwards. + +NOTE: The encoding in 3GPP TS 24.301 [23] is different from the encoding within this specification. + +## 8.8 EPS Bearer ID (EBI) + +EPS Bearer ID (EBI) is coded as depicted in Figure 8.8-1. + +The overall length of the IE is 5 octets. In future releases of the spec additional octets may be specified and new semantic for the spare bits may be defined. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 73 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare (all bits set to 0) | | | | EPS Bearer ID (EBI) | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.8-1: EPS Bearer ID (EBI) + +The following bits within Octet 5 shall indicate: + +- Bit 8 to 5 – Spare, for future use and set to zero. +- Bit 4 to 1 – EPS Bearer ID (EBI) field, the coding of EBI field and its value range is specified in 3GPP TS 24.007 [30], clause 11.2.3.1.5, bits 5 to 8. The sending GTPv2 entity shall include a EBI with a value between '1' and '4' only when the target GTPv2 entity is known to support 15 EPS Bearers, based on per PLMN local configuration. + +## 8.9 IP Address + +IP Address is coded as depicted in Figure 8.9-1. The Length field may have only two values (4 or 16) that determine if the Value field contains IPv4 or IPv6 address. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 74 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | IPv4 or IPv6 Address | | | | | | | | + +Figure 8.9-1: IP address + +## 8.10 Mobile Equipment Identity (MEI) + +Mobile Equipment Identity (MEI) is coded as depicted in Figure 8.10-1. MEI is defined in clause 6.2 of 3GPP TS 23.003 [2]. + +![](dda72b6afeac47479e0746d4eaf6745a_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|--------------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 75 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | Mobile Equipment (ME) Identity | | | | | | | | + +**Figure 8.10-1: Mobile Equipment (ME) Identity (MEI)** + +The ME Identity field contains either the IMEI or the IMEISV as defined in clause 6.2 of 3GPP TS 23.003 [2]. It is encoded as specified in clause 7.7.53 of 3GPP TS 29.060 [4], beginning with octet 4 of Figure 7.7.53.1. + +The IMEI(SV) digits are encoded using BCD coding where IMEI is 15 BCD digits and IMEISV is 16 BCD digits. For IMEI, bits 5 to 8 of the last octet shall be filled with an end mark coded as '1111'. + +## 8.11 MSISDN + +MSISDN is transferred via GTP tunnels. The sending entity copies the value part of the MSISDN into the Value field of the MSISDN IE. MSISDN is defined in 3GPP TS 23.003 [2]. + +![](ec27906099ab5da32f29b89d2764cf0c_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 76 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Number digit 2 | | | | Number digit 1 | | | | +| 6 | Number digit 4 | | | | Number digit 3 | | | | +| ... | ... | | | | ... | | | | +| n+4 | Number digit m | | | | Number digit m-1 | | | | + +**Figure 8.11-1: MSISDN** + +Octets 5 to (n+4) represent the MSISDN value is in international number format as described in ITU-T Rec E.164 [25] and 3GPP TS 29.002 [41]. MSISDN value contains only the actual MSISDN number (does not contain the "nature of address indicator" octet, which indicates "international number" as in 3GPP TS 29.002 [41]) and is encoded as TBCD digits, i.e. digits from 0 through 9 are encoded "0000" to "1001". When there is an odd number of digits, bits 8 to 5 of the last octet are encoded with the filler "1111". + +## 8.12 Indication + +Indication is coded as depicted in Figure 8.12-1. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|-------------|------------|---------------|------------|-------------|-------------|------------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 77 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | DAF | DTF | HI | DFI | OI | ISRSI | ISRAI | SGW
CI | +| 6 | SQCI | UIMSI | CFSI | CRSI | P | PT | SI | MSV | +| 7 | RetLo
c | PBIC | SRNI | S6AF | S4AF | MBM
DT | ISRA
U | CCRS
I | +| 8 | CPRA
I | ARRL | PPOF | PPON
/PPEI | PPSI | CSFBI | CLII | CPSR | +| 9 | NSI | UASI | DTCI | BDWI | PSCI | PCRI | AOSI | AOPI | +| 10 | ROAA
I | EPCO
SI | CPOP
CI | PMTS
MI | S11T
F | PNSI | UNAC
CSI | WPM
SI | +| 11 | 5GSN
N26 | REPR
EFI | 5GSI
WK | EEVR
SI | LTEM
UI | LTEM
PI | ENBC
RSI | TSPC
MI | +| 12 | CSRM
FI | MTED
TN | MTED
TA | N5GN
MI | 5GCN
RS | 5GCN
RI | 5SRH
OI | ETHP
DN | +| 13 | NSPU
SI | PGW
RNSI | RPPC
SI | PGW
CHI | SISS
ME | NSEN
BI | IDFU
PF | EMCI | +| 14 | Spare | Spare | Spare | Spare | Spare | LTEM
SAI | SRTPI | UPIP
SI | +| 15 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.12-1: Indication + +For each message the applicable flags of the Indication IE shall be clearly specified in the individual message clause. The remaining flags of the Indication IE not so indicated shall be discarded by the receiver. + +The receiver shall consider the value of the applicable flags as "0", if the Indication IE is applicable for the message but not included in the message by the sender. + +The following bits within Octet 5 shall indicate: + +- Bit 8 – DAF (Dual Address Bearer Flag): This bit shall be set when the PDN Type, determined based on UE request and subscription record, is set to IPv4v6 and all SGSNs which the UE may be handed over to are Release 8 or above supporting dual addressing, which is determined based on node pre-configuration by the operator.. +- Bit 7 – DTF (Direct Tunnel Flag): This bit shall be set when the UE is in UTRAN and Direct Tunnel is selected +- Bit 6 – HI (Handover Indication): If this bit is set to 1 over S11/S4 and S5/S8 interfaces, it shall indicate a UE handover attach. This bit is applicable during the Handover from Trusted or Untrusted Non-3GPP IP Access to E-UTRAN or a Handover from Trusted or Untrusted Non-3GPP IP Access to UTRAN/GERAN procedures (see clauses 8.2, 8.6 and 16.11 of 3GPP TS 23.402 [45]), or a 5GS to EPS handover without the N26 interface (see clause 4.11.2.2 of 3GPP TS 23.502 [83]). If this bit is set to 1 over GTP based S2a interface, it shall indicate a UE handover from 3GPP access to Trusted Non-3GPP access and UE requested IP address preservation. If this bit is set to 1 over GTP based S2b interface, it shall indicate a UE handover from 3GPP access to Untrusted Non-3GPP Access and UE requested IP address preservation. +- Bit 5 – DFI (Direct Forwarding Indication): If this bit is set to 1, it shall indicate that direct data forwarding applies between the source RAN and the target RAN during an S1 based handover procedure or during an inter-system handover between 5GS and EPS. +- Bit 4 – OI (Operation Indication): + - If this bit is set to 1, it shall denote that the receiving SGW of a "Create Session Request" shall send a Modify Bearer Request immediately to the PGW. This allows the SGW to differentiate if the "Create Session Request" received on S4/S11 interface belongs to a TAU/RAU with an SGW relocation (OI = 1), or X2-based handover with SGW relocation (OI = 1) or Enhanced SRNS Relocation with SGW relocation (OI=1) or MME triggered Serving GW relocation (OI = 1) or S1-based handover with SGW relocation (OI = 0). + - It shall be set to 1 on S4/S11 interface if the SGW needs to forward the Delete Session Request message to PGW. +- Bit 3 – ISRSI (Idle mode Signalling Reduction Supported Indication): If this is set to 1, it shall indicate that the old/source SGSN/MME and the associated SGW are capable to activate ISR. + +- Bit 2 – ISRAI (Idle mode Signalling Reduction Activation Indication): If this bit is set to 1, it shall indicate that the ISR is established between the MME and the S4 SGSN during a TAU/RAU without an SGW change procedure or during an Inter RAT handover without an SGW change procedure. The SGW shall retain the resources for the other CN node that has its bearer resources on the SGW reserved. The old/source SGSN/MME shall maintain the UE's contexts and activate ISR. +- Bit 1 – SGWCI (SGW Change Indication): + - If this bit is set to 1, it shall indicate that the target MME/SGSN has selected a new SGW during a TAU/RAU or handover with an SGW change procedure. + - It shall be set to 1 by the target AMF during the EPS to 5GS handover/Idle mode Mobility using N26 interface. + +The following bits within Octet 6 shall indicate: + +- Bit 8 – SQCI (Subscribed QoS Change Indication): If this bit is set to 1, it indicates that the subscribed QoS profile of the related PDN connection has changed in the old MME/SGSN when the UE is in ECM-IDLE state and ISR is activated. The new MME/SGSN shall trigger the Subscribed QoS Modification procedure. See 3GPP TS 23.401 [3], clause 5.3.9.2. +- Bit 7 – UIMSI (Unauthenticated IMSI): If this bit is set to 1, it indicates that the IMSI present in the message is not authenticated and is for emergency or RLOS attached UE. +- Bit 6 – CFSI (Change F-TEID support indication): if this bit is set to 1, it indicates that the SGW can change the assigned GTP-U F-TEID in the current procedure. If the SGW needs to modify the GTP-U F-TEID and the CFSI flag is set to 1 in the corresponding request message, the SGW shall include the new F-TEID in the Modify Bearer Response/Modify Access Bearers Response message. +- Bit 5 – CRSI (Change Reporting support indication): if this bit is set to 1, it indicates that the MME/S4 SGSN supports Location Change Reporting mechanism for the corresponding session. +- Bit 4 – PS (Piggybacking Supported). This bit denotes whether the MME/SGW support piggybacking feature as described in Annex F of 3GPP TS 23.401 [3]. If set to 1, it indicates that the node is capable of processing two different GTP-C messages appearing back to back in a single UDP payload. +- Bit 3 – PT (S5/S8 Protocol Type) If this bit set to 1, it shall indicate that the protocol type for the S5/S8 interface is PMIP; this bit is set to 0 to indicate that the protocol type for the S5/S8 interface is GTP. +- Bit 2 – SI (Scope Indication): If this bit is set to 1, it indicates that all bearer resources of the UE shall be released by the SGW. This flag is set in messages during TAU/RAU/Handover with SGW change /SRNS Relocation Cancel Using S4 with SGW change/Inter RAT handover Cancel procedure with SGW change/S1 Based handover Cancel procedure with SGW change. +- Bit 1 – MSV (MS Validated): If this bit is set to 1, it shall indicate that the new MME/SGSN has successfully authenticated the UE. + +The following bits within Octet 7 shall indicate: + +- Bit 8 – RetLoc (Retrieve Location Indication Flag): if this bit is set to 1, it indicates that the PGW requests the MME/SGSN or TWAN/ePDG to provide the User Location Information. +- Bit 7 – PBIC (Propagate BBAI Information Change): if this bit is set to 1, it indicates a change in the H(e)NB local IP address and/or UDP port number, i.e. the UE moves from an (e)NB to a H(e)NB, or from one H(e)NB to another H(e)NB with the fixed network backhaul changed, or the UE moves from a H(e)NB to a (e)NB. +- Bit 6 – SRNI (SGW Restoration Needed Indication): if this bit is set to 1, it indicates that the source MME/S4-SGSN has not performed the SGW relocation procedure after the source SGW has failed with or without restart, when the source and target MME/S4-SGSN support the MME/S4-SGSN triggered SGW restoration procedure as specified in 3GPP TS 23.007 [17]. +- Bit 5 – S6AF (Static IPv6 Address Flag): if this bit is set to 1, it indicates that PDP/PDN IPv6 address is static. +- Bit 4 – S4AF (Static IPv4 Address Flag): if this bit is set to 1, it indicates that PDP/PDN IPv4 address is static. +- Bit 3 – MBMDT (Management Based MDT allowed flag): if this bit is set to 1, it indicates that management based MDT is allowed. +- Bit 2 – ISRAU (ISR is activated for the UE): if this bit is set to 1, it indicates that ISR is activated for the UE before the UE moving to the new SGSN/MME. + +- Bit 1 – CCRSI (CSG Change Reporting support indication): if this bit is set to 1, it indicates that the MME/S4 SGSN supports CSG Information Change Reporting mechanism for the corresponding session. + +The following bits within Octet 8 shall indicate: + +- Bit 8 – CPRAI (Change of Presence Reporting Area information Indication): when ISR is active if this bit is set to 1, it indicates that the Presence Reporting Area information, which is provided as a part of the Presence Reporting Area Information IE, has changed since last reported by the MME/S4-SGSN. The SGW shall ignore this flag when ISR is not active. +- Bit 7 – ARRL (Abnormal Release of Radio Link): if this bit is set to 1 by the MME, it indicates to the SGW that the access bearers are released due to an abnormal release of the radio link. Based on operator policy, this indication may be used by the SGW in subsequent decisions to trigger PDN charging pause if the PGW Pause of Charging feature has been enabled on that PDN connection. +- Bit 6 – PPOFF (PDN Pause Off Indication): if this bit is set to 1 by the SGW, it indicates to the PGW that the charging for the PDN connection shall be unpaused. +- Bit 5 – PPON (PDN Pause On Indication) / PPEI (PDN Pause Enabled Indication): if this bit is set to 1 by the SGW, it indicates to the PGW that the charging for the PDN connection shall be paused; if it is set to 1 by the PGW, it indicates that PGW enables the SGW to use the PGW Pause of Charging procedure for the PDN connection. +- Bit 4 – PPSI (PDN Pause Support Indication): if this bit is set to 1 by the SGW, it indicates that the SGW supports the PGW Pause of Charging procedure; if it is set to 1 by the PGW, it indicates that the PGW supports the PGW Pause of Charging procedure. +- Bit 3 – CSFBI (CSFB Indication): if this bit is set to 1, it indicates that the UE has been subject to CSFB. +- Bit 2 – CLII (Change of Location Information Indication): when ISR is active if this bit is set to 1, it indicates that the location information, which is provided as a part of ULI IE, has changed since last reported by the MME/S4-SGSN. The SGW shall ignore this flag when ISR is not active. +- Bit 1 – CPSR (CS to PS SRVCC indication): if this bit is set to 1, it indicates that a UTRAN/GERAN to E-UTRAN/UTRAN (HSPA) SRVCC procedure is underway and the associated message, i.e. Modify Bearer Request shall be forwarded to the PGW from the SGW as specified in 3GPP TS 23.216 [43]. + +The following bits within Octet 9 shall indicate: + +- Bit 8 – NSI (NBIFOM Support Indication): if this bit is set to 1, it indicates to the PGW that the NBIFOM is supported (see clause 5.10 of 3GPP TS 23.161 [71]). +- Bit 7 – UASI (UE Available for Signaling Indication): if this bit is set to 1, it indicates that the UE is available for end to end signalling and that the PGW should re-attempt the pending network initiated procedure. +- Bit 6 – DTCI (Delay Tolerant Connection Indication): if this bit is set to 1, it indicates that the PDN connection is delay tolerant according to the local policies in the PGW, e.g. per APN. For this PDN connection the PGW supports receiving the rejection cause "UE is temporarily not reachable due to power saving" from the MME/SGSN via the SGW during a network initiated procedure and holding the network initiated procedure, until the PGW receives the subsequent Modify Bearer Request message with the UASI flag indicating that the UE is available for end to end signalling. +- Bit 5 – BDWI (Buffered DL Data Waiting Indication): if this bit is set to 1, it indicates that there is DL data buffered in the (old) SGW or (V-)SMF/UPF, i.e. that the new MME/SGSN shall invoke data forwarding if there is an SGW change as specified in clause 5.3.3.1A of 3GPP TS 23.401 [3] or upon idle mode mobility between 5GS and EPS with data forwarding as specified in clauses 4.11.1.3.2A, 4.11.1.3.3A, 4.23.12.2a and 4.23.12.3a of 3GPP TS 23.502 [83], and that it shall setup the user plane in conjunction with the TAU/RAU procedure for delivery of the buffered DL data to the UE. +- Bit 4 – PSCI (Pending Subscription Change Indication): If this bit is set to 1, it indicates that there is a pending report of the changed subscribed QoS profile of the related PDN connection in the old MME, so that the new MME/SGSN shall trigger the HSS Initiated Subscribed QoS Modification procedure towards the PGW. See clause 5.3.9.2 of 3GPP TS 23.401 [3]. +- Bit 3 – PCRI (P-CSCF Restoration Indication): if this bit is set to 1, it indicates a request to trigger a P-CSCF restoration for the corresponding user (see 3GPP TS 23.380 [61]). + +- Bit 2 – AOSI (Associate OCI with SGW node's Identity): if this bit is set to 1, it indicates that the SGW provided "SGW's Overload Control Information" which shall be associated with the node identity (i.e. FQDN or the IP address received from the DNS during the SGW selection) of the serving SGW. +- Bit 1 – AOPI (Associate OCI with PGW node's Identity): if this bit is set to 1, it indicates that the PGW provided "PGW's Overload Control Information" which shall be associated with the node identity (i.e. FQDN or the IP address received from the HSS or DNS during the PGW selection) of the serving PGW. + +The following bits within Octet 10 shall indicate: + +- Bit 8 – ROAAI (Release Over Any Access Indication): If this bit is set to 1, it indicates to the PGW that, if this is an NB-IFOM PDN connection, the PGW shall initiate the release of the corresponding PDN connection over the non-3GPP access over the S2a/S2b interface with the cause "Local release". +- Bit 7 – EPCOSI (Extended PCO Support Indication): If this bit is set to 1, it indicates to the receiver that the Extended PCO is supported, e.g. when the PGW is the receiver, it indicates that the UE, the MME and the SGW support Extended PCO; when the target MME is the receiver, during an inter-MME mobility, it indicates that UE and the source MME support Extended PCO. +- Bit 6 – CPOPCI (Control Plane Only PDN Connection Indication): If this bit is set to 1, it indicates that the PDN Connection is set to Control Plane Only, i.e. the user data pertaining to this PDN connection can only be transferred in NAS PDUs via the control plane. +- Bit 5 – PMTSMI (Pending MT Short Message Indication): If this bit is set to 1, it indicates to the target MME/S4-SGSN that there is one (or more) pending MT Short Message(s) in the SMS-GMSC, i.e. that the target MME/S4-SGSN shall provide its E.164 address and Diameter Identity if available to receive the MT Short message and maintain the signalling connection with the UE for a longer time to enable the retransmission of the Short Message. +- Bit 4 – S11-U Tunnel Flag (S11TF): This flag shall be set to 1 on the S11 interface if user data is transported in NAS signalling. +- Bit 3 – PNSI (Pending Network Initiated PDN Connection Signalling Indication): if this bit is set to 1, it indicates to the target MME/SGSN that there is pending network initiated PDN connection signalling for the PDN connection, i.e. the target MME/SGSN shall set UASI flag in the Create Session Request or Modify Bearer Request message to indicate to the PGW that the UE is available for end to end signalling. +- Bit 2 – UNACCSI (UE Not Authorised Cause Code Support Indication): If this bit is set to 1, it indicates that the Cause Code for "UE not authorized by OCS or external AAA Server" is supported by the S4-SGSN/MME. +- Bit 1 – WLCP PDN Connection Modification Support Indication (WPMSI): if this bit is set to 1, it indicates that the TWAN supports the WLCP PDN Connection Modification procedure. This indication is used by the P-CSCF restoration extension procedure for TWAN access (see 3GPP TS 23.380 [61]). + +The following bits within Octet 11 shall indicate: + +- Bit 8 – 5GSNN26 (5GS Interworking without N26 Indication): if this bit is set to 1 and the 5GS Interworking Indication (5GSIWKI) is set to 1, it indicates to the PGW-C+SMF that 5GS Interworking is supported without the N26 interface. If this bit is set to 0 and the 5GSIWKI (5GS Interworking Indication) is set to 1, it indicates to the PGW-C+SMF that 5GS Interworking is supported with the N26 interface. +- Bit 7 – REPREFI (Return Preferred Indication): This flag shall be set to 1 to indicate a preferred return of the UE to the last used EPS or 5GS PLMN at a later access change to an EPS or 5GS shared network. +- Bit 6 – 5GSIWKI (5GS Interworking Indication): This flag shall be set to 1 for UEs supporting N1 mode and not restricted from interworking with 5GS by user subscription (see "5GC" bit within Core-Network-Restrictions AVP and Interworking-5GS-Indicator AVP specified in 3GPP TS 29.272 [70] and 3GPP TS 29.273 [68]). +- Bit 5 – EEVRSI (Extended EBI Value Range Support Indication): if this bit is set to 1, it indicates that the sending GTPv2 entity supports the 15 EPS Bearers, i.e. it supports to use EPS Bearer ID with a value between '1' and '15'. +- Bit 4 – LTEMUI (LTE-M UE Indication): if this bit is set to 1, it indicates that the UE is a LTE-M UE (see 3GPP TS 23.401 [3]); +- Bit 3 – LTEMPI (LTE-M RAT Type reporting to PGW Indication): if this bit is set to 1, it indicates to the SGW to forward the LTE-M RAT type to the PGW; + +- Bit 2 – ENBCRSI (eNB Change Reporting Support Indication): if this bit is set to 1, it indicates that the MME supports Macro eNodeB Change Reporting mechanism for the corresponding session. +- Bit 1 –TSPCM (Triggering SGSN initiated PDP Context Creation/Modification Indication): if this bit is set to 1, it indicates to the S4-SGSN that in the UE\_initiated PDP Context Modification procedure, when the NBIFOM container is included, the S4-SGSN accepts the UE initiated PDP Context Modification procedure and initiates SGSN initiated PDP Context Creation/modification procedures respectively towards UE to transfer the NBIFOM container received from the PGW either in Create Bearer Request or Update Bearer Request message as specified in 3GPP TS 23.161 [71]. + +The following bits within Octet 12 shall indicate: + +- Bit 8 – CSRMT (Create Session Request Message Forwarded Indication): if this bit is set to 1, it indicates that the Create Session Request message has been forwarded by a PGW, and the receiving PGW shall include its PGW FQDN in the Create Session Response message if the creation of the PDN connection is accepted. +- Bit 7 – MTEDTN (MT-EDT Not Applicable): if this bit is set to 1, it indicates that MT-EDT is not applicable for the PDN connection. +- Bit 6 – MTEDTA (MT-EDT Applicable): if this bit is set to 1, it indicates that MT-EDT is applicable for the PDN connection. +- Bit 5 – N5GNMI (No 5GS N26 Mobility Indication): if this bit is set to 1, it indicates that the PDN connection cannot be moved to 5GS via N26. +- Bit 4 –5GCNRS (5GC Not Restricted Support): if this bit is set to 1, this indicates to the PGW-C+SMF that the sending node (i.e. MME or ePDG) supports setting the 5GCNRI flag. An MME or an ePDG compliant with this version of the specification shall support setting the 5GCNRI flag. +- Bit 3 –5GCNRI (5GC Not Restricted Indication): if this bit is set to 1, this indicates to the PGW-C+SMF that access to the 5GC is not restricted for the PDN connection. If the 5GCNRS bit is set to 1 and the 5GCNRI bit is set to 0, this indicates that access to the 5GC is restricted for the PDN connection. The 5GCNRI flag shall be ignored by the PGW-C+SMF if the 5GSIWKI flag is set to 1 (i.e. 5GS Interworking is supported), except for the case noted in Note 27 in Table 7.2.1-1. +- Bit 2 – 5SRHOI (5G-SRVCC HO Indication): if this bit is set to 1, it indicates the HO is used for 5G-SRVCC as specified in 3GPP TS 23.216 [43]. +- Bit 1 – ETHPDN (Ethernet PDN Support Indication): if this bit is set to 1, it indicates the support of Ethernet PDN Connection. + +The following bits within Octet 13 shall indicate: + +- Bit 8 – NSPUSI (Notify Start Pause of charging via User plane Support Indication): if this bit is set to 1, it indicates that the PGW-C and PGW-U support Notify Start Pause of Charging via user plane feature as specified in clause 5.30 of 3GPP TS 29.244 [80]. +- Bit 7 – PGWRNSI (PGW Redirection due to mismatch with Network Slice subscribed by UE Support Indication): if this bit is set to 1, it indicates that the MME supports receiving a Create Session rejection response with the cause "PGW redirection due to mismatch with network slice subscribed by the UE" and to establish the PDN connection towards the Alternative PGW-C/SMF indicated in the Create Session rejection response. +- Bit 6 – RPPCSI (Restoration of PDN connections after an PGW-C/SMF Change Support Indication): if this bit is set to 1, it indicates that the sending GTPv2 entity, i.e. the MME/ePDG and/or the SGW, supports the Restoration of PDN connections after an PGW-C/SMF Change procedure as specified in clause 31 of 3GPP TS 23.007 [17]. +- Bit 5 – PGWCHI (PGW CHange Indication): if this bit is set to 1, it indicates that the Create Session Request is triggered to move an existing PDN connection to the new PGW-C/SMF as specified in clauses 31.3 and 31.3A of 3GPP TS 23.007 [17]. +- Bit 4 – SISSME (Same IWK-SCEF Selected for Monitoring Event Indication): if this bit is set to 1, it indicates that same IWK-SCEF is selected by target MME/SGSN for Monitoring Event. +- Bit 3 – NSENB (Notify Source eNodeB Indication): if this bit is set to 1, it indicates that the source MME shall send a Handover Success to the source eNodeB (see clause 5.5.1.2.2a of 3GPP TS 23.401 [3]). +- Bit 2 – IDFUPF (Indirect Data Forwarding with UPF Indication): if this bit is set to 1, it indicates that indirect data forwarding is required for user plane routes from/to a UPF. + +- Bit 1 – EMCI (Emergency PDU Session Indication): if this bit is set to 1, it indicates the UE has emergency PDU session, as specified in 3GPP TS 23.216 [43]. + +The following bits within Octet 14 shall indicate: + +- Bits 4 to 8: Spare, for future use and set to 0. +- Bit 3 –LTEMSAI (LTE-M Satellite Access Indication): if this bit is set to 1, it indicates that the LTE-M UE is accessing Satellite E-UTRAN (see 3GPP TS 23.401 [3]); +- Bit 2 –SRTPI (Satellite RAT Type reporting to PGW Indication): if this bit is set to 1, it indicates to the SGW to forward the Satellite related RAT type to the PGW; +- Bit 1 –UPIPSI (User Plane Integrity Protection Support Indication): if this bit is set to 1, it indicates that the UE, MME and E-UTRAN supports User Plane Integrity Protection with EPS as specified in clause 4.11.0a.5 of 3GPP TS 23.502 [83]. + +## 8.13 Protocol Configuration Options (PCO) + +Protocol Configuration Options (PCO) is transferred via GTP tunnels. The sending entity copies the value part of the PCO into the Value field of the PCO IE. The detailed coding and maximum length of the PCO field from octets 5 to (n+4) shall be specified as per clause 10.5.6.3 of 3GPP TS 24.008 [5], starting with octet 3. + +| Octets | Bits | | | | | | | | +|------------|--------------------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 78 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | Protocol Configuration Options (PCO) | | | | | | | | + +Figure 8.13-1: Protocol Configuration Options (PCO) + +## 8.14 PDN Address Allocation (PAA) + +The PDN Address Allocation is coded as depicted in Figure 8.14-1. + +NOTE: The Prefix Length within PAA IE has a fixed value of /64. + +| Octets | Bits | | | | | | | | +|------------|------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 79 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | PDN Type | | | | +| 6 to (n+4) | PDN Address and Prefix | | | | | | | | + +Figure 8.14-1: PDN Address Allocation (PAA) + +**Table 8.14-1: PDN Address Allocation** + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------|----------| +| PDN type value (octet 5) | | | | +| Bits | | | | +| 3 | 2 | 1 | | +| 0 | 0 | 1 | IPv4 | +| 0 | 1 | 0 | IPv6 | +| 0 | 1 | 1 | IPv4v6 | +| 1 | 0 | 0 | Non-IP | +| 1 | 0 | 1 | Ethernet | +| All other values are reserved. | | | | +| Bits 8-4 of octet 5 are spare and shall be coded as zero. | | | | +| PDN Address and Prefix (octet 6 to n+4) | | | | +| If PDN type value indicates IPv4, an IPv4 address is present in the PDN Address and Prefix from octet 6 to octet 9. Bit 8 of octet 6 represents the most significant bit of the IPv4 address and bit 1 of octet 9 the least significant bit. | | | | +| If PDN type value indicates IPv6, octet 6 contains the IPv6 Prefix Length. Octets 7 through 22 contain an IPv6 Prefix and Interface Identifier. Bit 8 of octet 7 represents the most significant bit of the IPv6 Prefix and Interface Identifier and bit 1 of octet 22 the least significant bit. | | | | +| If PDN type value indicates IPv4v6, octet 6 contains the IPv6 Prefix Length. Octets 7 through 22 contain an IPv6 Prefix and Interface Identifier. Bit 8 of octet 7 represents the most significant bit of the IPv6 Prefix and Interface Identifier and bit 1 of octet 22 the least significant bit. Octets 23 through 26 contain an IPv4 address. Bit 8 of octet 23 represents the most significant bit of the IPv4 address and bit 1 of octet 26 the least significant bit. | | | | +| If PDN type value indicates Non-IP or Ethernet, octets from 6 to 'n+4' shall not be present. | | | | + +## 8.15 Bearer Quality of Service (Bearer QoS) + +Bearer Quality of Service (Bearer QoS) is transferred via GTP tunnels. The sending entity copies the value part of the Bearer I QoS into the Value field of the Bearer QoS IE. + +| Octets | Bits | | | | | | | | | | | | | +|-------------|------------------------------------------------------------|-----|----|---|----------|-------|-----|---|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | +| 1 | Type = 80 (decimal) | | | | | | | | | | | | | +| 2-3 | Length = n | | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | | +| 5 | Spare | PCI | PL | | | Spare | PVI | | | | | | | +| 6 | Label (QCI) | | | | | | | | | | | | | +| 7 to 11 | Maximum bit rate for uplink | | | | | | | | | | | | | +| 12 to 16 | Maximum bit rate for downlink | | | | | | | | | | | | | +| 17 to 21 | Guaranteed bit rate for uplink | | | | | | | | | | | | | +| 22 to 26 | Guaranteed bit rate for downlink | | | | | | | | | | | | | +| 27 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | | + +**Figure 8.15-1: Bearer Quality of Service (Bearer QoS)** + +Octet 5 represents the Allocation/Retention Priority (ARP) parameter. The meaning and value range of the parameters within the ARP are defined in 3GPP TS 29.212 [29]. The bits within the ARP octet are: + +- Bit 1 – PVI (Pre-emption Vulnerability): See 3GPP TS 29.212[29], clause 5.3.47 Pre-emption-Vulnerability AVP. +- Bit 2 – spare + +- Bits 3 to 6 – PL (Priority Level): See 3GPP TS 29.212[29], clause 5.3.45 Priority-Level AVP. PL encodes each priority level defined for the Priority-Level AVP as the binary value of the priority level. +- Bit 7 – PCI (Pre-emption Capability): See 3GPP TS 29.212[29], clause 5.3.46 Pre-emption-Capability AVP. +- Bit 8 – spare. + +Octet 6 contains the "QCI" value, as specified in 3GPP TS 23.203 [48]. + +The UL/DL MBR and GBR fields are encoded as kilobits per second (1 kbps = 1000 bps) in binary value. The UL/DL MBR and GBR fields may require converting values in bits per second to kilobits per second when the UL/DL MBR and GBR values are received from an interface other than GTPv2 interface. If such conversions result in fractions, then the value of UL/DL MBR and GBR fields shall be rounded upwards. For non-GBR bearers, both the UL/DL MBR and GBR should be set to zero. The range of QCI, Maximum bit rate for uplink, Maximum bit rate for downlink, Guaranteed bit rate for uplink and Guaranteed bit rate for downlink are specified in 3GPP TS 36.413 [10]. + +NOTE: The encoding in 3GPP TS 24.301 [23] and 3GPP TS 36.413 [10] is different from the encoding within this specification. + +## 8.16 Flow Quality of Service (Flow QoS) + +Flow Quality of Service (Flow QoS) is transferred via GTP tunnels. The sending entity copies the value part of the Flow QoS into the Value field of the Flow QoS IE. + +| Octets | Bits | | | | | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 81 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Label (QCI) | | | | | | | | | | | | +| 6 to 10 | Maximum bit rate for uplink | | | | | | | | | | | | +| 11 to 15 | Maximum bit rate for downlink | | | | | | | | | | | | +| 16 to 20 | Guaranteed bit rate for uplink | | | | | | | | | | | | +| 21 to 25 | Guaranteed bit rate for downlink | | | | | | | | | | | | +| 26 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.16-1: Flow Quality of Service (Flow QoS) + +Octet 5 contains the "QCI" value, as specified in 3GPP TS 23.203 [48]. + +The UL/DL MBR and GBR fields are encoded as kilobits per second (1 kbps = 1000 bps) in binary value. For non-GBR bearers, both the UL/DL MBR and GBR should be set to zero. The range of QCI, Maximum bit rate for uplink, Maximum bit rate for downlink, Guaranteed bit rate for uplink and Guaranteed bit rate for downlink are specified in 3GPP TS 36.413 [10]. + +NOTE: The encoding in 3GPP TS 24.301 [23] and 3GPP TS 36.413 [10] is different from the encoding within this specification. + +## 8.17 RAT Type + +RAT Type is coded as depicted in Figure 8.17-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 82 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | RAT Type | | | | | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.17-1: RAT Type + +**Table 8.17-1: RAT Type values** + +| RAT Types | Values (Decimal) | +|-------------------------|-------------------------| +| | 0 | +| UTRAN | 1 | +| GERAN | 2 | +| WLAN | 3 | +| GAN | 4 | +| HSPA Evolution | 5 | +| EUTRAN (WB-E-UTRAN) | 6 | +| Virtual | 7 | +| EUTRAN-NB-IoT | 8 | +| LTE-M | 9 | +| NR | 10 | +| WB-E-UTRAN(LEO) | 11 | +| WB-E-UTRAN(MEO) | 12 | +| WB-E-UTRAN(GEO) | 13 | +| WB-E-UTRAN(OTHERSAT) | 14 | +| EUTRAN-NB-IoT(LEO) | 15 | +| EUTRAN-NB-IoT(MEO) | 16 | +| EUTRAN-NB-IoT(GEO) | 17 | +| EUTRAN-NB-IoT(OTHERSAT) | 18 | +| LTE-M(LEO) | 19 | +| LTE-M(MEO) | 20 | +| LTE-M(GEO) | 21 | +| LTE-M(OTHERSAT) | 22 | +| | 23-255 | + +NOTE 1: For S4-SGSN, currently it is only possible to detect the difference between GERAN and UTRAN when GERAN Gb mode is used. If GERAN Iu mode is used, then an S4-SGSN may not be able to detect the difference between GERAN and UTRAN. Across the Gb interface, the SGSN may also not be able to detect the difference between GERAN and GAN. If S4-SGSN cannot detect that the HSPA Evolution 3GPP TR 25.999 [46] network is behind the Iu interface, the S4-SGSN will send the "UTRAN" RAT Type. + +NOTE 2: For the Iu interface case, if the SGSN detects UTRAN or HSPA, it sets the RAT-Type to "UTRAN". If the SGSN detects HSPA+, it sets the RAT-Type to "HSPA Evolution", otherwise the SGSN will send the "UTRAN" RAT Type. + +NOTE 3: The MME sets the LTE-M RAT-Type for a UE accessing E-UTRAN and indicating Category M from the eNB or sets the LTE-M Satellite RAT types for a UE accessing satellite E-UTRAN and indicating Category M from the eNB, as specified in 3GPP TS 23.401 [3]. + +NOTE 4: The MME sets the RAT-Type to WB-E-UTRAN(LEO) / WB-E-UTRAN(MEO) / WB-E-UTRAN(GEO) / WB-E-UTRAN(OTHERSAT) for a UE accessing E-UTRAN with satellite access (EUTRAN-LEO, EUTRAN-MEO, EUTRAN-GEO or EUTRAN-OTHERSAT), and without indicating Category M satellite from the eNB. + +NOTE 5: The MME sets the RAT-Type to EUTRAN-NB-IoT(LEO) / EUTRAN-NB-IoT(MEO) / EUTRAN-NB-IoT(GEO) / EUTRAN-NB-IoT(OTHERSAT) for a UE accessing EUTRAN-NB-IoT with satellite access (NB-IoT-LEO, NB-IoT-MEO, NB-IoT-GEO or NB-IoT-OTHERSAT). + +NOTE 6: The MME sets the RAT-Type to LTE-M(LEO) / LTE-M(MEO) / LTE-M(GEO) / LTE-M(OTHERSAT) for a UE accessing E-UTRAN with satellite access (EUTRAN-LEO, EUTRAN-MEO, EUTRAN-GEO or EUTRAN-OTHERSAT) and indicating Category M satellite from the eNB. + +## 8.18 Serving Network + +Serving Network is coded as depicted in Figure 8.18-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 83 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | MCC digit 2 | | | | MCC digit 1 | | | | +| 6 | MNC digit 3 | | | | MNC digit 3 | | | | +| 7 | MNC digit 2 | | | | MNC digit 1 | | | | +| 8 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.18-1: Serving Network + +If an Administration decides to include only two digits in the MNC, then bits 5 to 8 of octet 6 are coded as "1111". + +Unless specified otherwise in the specification, this IE contains the serving core network operator ID provided by the MME, S4-SGSN or ePDG, or the PLMN identity of the selected PLMN used for 3GPP-based access authentication provided by the TWAN. + +NOTE: The serving core network operator ID is the PLMN ID of the MME, S4-SGSN or ePDG which is currently serving the UE. An S4-SGSN/MME which supports multiple PLMN IDs is considered as logically different S4-SGSNs/MMEs. + +## 8.19 EPS Bearer Level Traffic Flow Template (Bearer TFT) + +EPS Bearer Level Traffic Flow Template (Bearer TFT) is transferred via GTP tunnels. The sending entity copies the value part of the EPS Bearer Level TFT into the Value field of the EPS Bearer Level TFT IE. The detailed coding and maximum length of the EPS Bearer Level TFT IE is specified in 3GPP TS 24.008 [5], clause 10.5.6.12, beginning with octet 3. + +| Octets | Bits | | | | | | | | +|------------|----------------------------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 84 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | EPS Bearer Level Traffic Flow Template (TFT) | | | | | | | | + +Figure 8.19-1: EPS Bearer Level Traffic Flow Template (Bearer TFT) + +## 8.20 Traffic Aggregate Description (TAD) + +The Traffic Aggregate Description IE is coded as depicted in Figure 8.20-1. The detailed coding and maximum length of Traffic Aggregate Description is specified in 3GPP TS 24.008 [5], clause 10.5.6.12, beginning with octet 3.. + +| Octets | Bits | | | | | | | | +|------------|-------------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 85 (Decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | Traffic Aggregate Description | | | | | | | | + +Figure 8.20-1 Traffic Aggregate Description + +## 8.21 User Location Information (ULI) + +User Location Information (ULI) is a extendable IE that is coded as depicted in Figure 8.21-1. The CGI, SAI, RAI, TAI, ECGI and LAI identity types are defined in 3GPP TS 23.003 [2]. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-----------------------|-----|------|----------|-----|-----|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 86 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Extended
Macro
eNodeB
ID | Macro
eNodeB
ID | LAI | ECGI | TAI | RAI | SAI | CGI | +| a to a+6 | CGI | | | | | | | | +| b to b+6 | SAI | | | | | | | | +| c to c+6 | RAI | | | | | | | | +| d to d+4 | TAI | | | | | | | | +| e to e+6 | ECGI | | | | | | | | +| f to f+4 | LAI | | | | | | | | +| g to g+5 | Macro eNodeB ID | | | | | | | | +| g to g+5 | Extended Macro eNodeB ID | | | | | | | | +| h to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.21-1: User Location Information + +The ULI IE shall contain only one identity of the same type (e.g. more than one CGI cannot be included), but ULI IE may contain more than one identity of a different type (e.g. ECGI and TAI). The flags LAI, ECGI, TAI, RAI, SAI, CGI, Macro eNodeB ID, and Extended Macro eNodeB ID in octet 5 indicate if the corresponding type shall be present in a respective field or not. If one of these flags is set to "0", the corresponding field shall not be present at all. If more than one identity of different type is present, then they shall be sorted in the following order: CGI, SAI, RAI, TAI, ECGI, LAI, Macro eNodeB ID, Extended Macro eNodeB ID. Only one of the Macro eNodeB ID or Extended Macro eNodeB ID shall be present in the ULI IE. + +The following clauses specify the coding of the fields representing different identities. + +For each identity, if an Administration decides to include only two digits in the MNC, then "MNC digit 3" field of corresponding location shall be coded as "1111". + +### 8.21.1 CGI field + +The coding of CGI (Cell Global Identifier) is depicted in Figure 8.21.1-1. Only zero or one CGI field shall be present in ULI IE. + +| Octets | Bits | | | | | | | | | | | | +|------------|--------------------------|---|---|---|-------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| a | MCC digit 2 | | | | MCC digit 1 | | | | | | | | +| a+1 | MNC digit 3 | | | | MNC digit 3 | | | | | | | | +| a+2 | MNC digit 2 | | | | MNC digit 1 | | | | | | | | +| a+3 to a+4 | Location Area Code (LAC) | | | | | | | | | | | | +| a+5 to a+6 | Cell Identity (CI) | | | | | | | | | | | | + +Figure 8.21.1-1: CGI field + +The Location Area Code (LAC) consists of 2 octets. Bit 8 of Octet a+3 is the most significant bit and bit 1 of Octet a+4 the least significant bit. The coding of the location area code is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +The Cell Identity (CI) consists of 2 octets. Bit 8 of Octet a+5 is the most significant bit and bit 1 of Octet a+6 the least significant bit. The coding of the cell identity is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +### 8.21.2 SAI field + +The coding of SAI (Service Area Identifier) is depicted in Figure 8.21.2-1. Only zero or one SAI field shall be present in ULI IE. + +| Octets | Bits | | | | | | | | | | | | +|------------|--------------------------|---|---|---|-------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| b | MCC digit 2 | | | | MCC digit 1 | | | | | | | | +| b+1 | MNC digit 3 | | | | MCC digit 3 | | | | | | | | +| b+2 | MNC digit 2 | | | | MNC digit 1 | | | | | | | | +| b+3 to b+4 | Location Area Code (LAC) | | | | | | | | | | | | +| b+5 to b+6 | Service Area Code (SAC) | | | | | | | | | | | | + +Figure 8.21.2-1: SAI field + +The Location Area Code (LAC) consists of 2 octets. Bit 8 of Octet b+3 is the most significant bit and bit 1 of Octet b+4 the least significant bit. The coding of the location area code is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +The Service Area Code (SAC) consists of 2 octets. Bit 8 of Octet b+5 is the most significant bit and bit 1 of Octet b+6 the least significant bit. The SAC is defined by the operator. See 3GPP TS 23.003 [2] clause 12.5 for more information. + +### 8.21.3 RAI field + +The coding of RAI (Routing Area Identity) is depicted in Figure 8.21.3-1. Only zero or one RAI field shall be present in ULI IE. + +| Octets | Bits | | | | | | | | | | | | +|------------|--------------------------|---|---|---|-------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| c | MCC digit 2 | | | | MCC digit 1 | | | | | | | | +| c+1 | MNC digit 3 | | | | MCC digit 3 | | | | | | | | +| c+2 | MNC digit 2 | | | | MNC digit 1 | | | | | | | | +| c+3 to c+4 | Location Area Code (LAC) | | | | | | | | | | | | +| c+5 to c+6 | Routing Area Code (RAC) | | | | | | | | | | | | + +Figure 8.21.3-1: RAI field + +The Location Area Code (LAC) consists of 2 octets. Bit 8 of Octet c+3 is the most significant bit and bit 1 of Octet c+4 the least significant bit. The coding of the location area code is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used (see 3GPP TS 23.003 [2]). + +The Routing Area Code (RAC) consists of 2 octets. Only Octet c+5 contains the RAC. Octet c+6 is coded as all 1's (11111111). The RAC is defined by the operator. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used (see 3GPP TS 23.003 [2]). + +### 8.21.4 TAI field + +The coding of TAI (Tracking Area Identity) is depicted in Figure 8.21.4-1. Only zero or one TAI field shall be present in ULI IE. + +| Octets | Bits | | | | | | | | +|------------|--------------------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| d | MCC digit 2 | | | | MCC digit 1 | | | | +| d+1 | MNC digit 3 | | | | MCC digit 3 | | | | +| d+2 | MNC digit 2 | | | | MNC digit 1 | | | | +| d+3 to d+4 | Tracking Area Code (TAC) | | | | | | | | + +Figure 8.21.4-1: TAI + +The Tracking Area Code (TAC) consists of 2 octets. Bit 8 of Octet d+3 is the most significant bit and bit 1 of Octet d+4 the least significant bit. The coding of the tracking area code is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +### 8.21.5 ECGI field + +The coding of ECGI (E-UTRAN Cell Global Identifier) is depicted in Figure 8.21.5-1. Only zero or one ECGI field shall be present in ULI IE. + +| Octets | Bits | | | | | | | | +|------------|-------------------------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| e | MCC digit 2 | | | | MCC digit 1 | | | | +| e+1 | MNC digit 3 | | | | MNC digit 3 | | | | +| e+2 | MNC digit 2 | | | | MNC digit 1 | | | | +| e+3 | Spare | | | | ECI | | | | +| e+4 to e+6 | ECI (E-UTRAN Cell Identifier) | | | | | | | | + +Figure 8.21.5-1: ECGI field + +The E-UTRAN Cell Identifier (ECI) consists of 28 bits. The ECI field shall start with Bit 4 of octet e+3, which is the most significant bit. Bit 1 of Octet e+6 is the least significant bit. The coding of the E-UTRAN cell identifier is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +## 8.21.6 LAI field + +The coding of LAI (Location Area Identifier) is depicted in Figure 8.21.6-1. + +| Octets | Bits | | | | | | | | +|------------|--------------------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| f | MCC digit 2 | | | | MCC digit 1 | | | | +| f+1 | MNC digit 3 | | | | MNC digit 3 | | | | +| f+2 | MNC digit 2 | | | | MNC digit 1 | | | | +| f+3 to f+4 | Location Area Code (LAC) | | | | | | | | + +Figure 8.21.6-1: LAI field + +The Location Area Code (LAC) consists of 2 octets. Bit 8 of Octet f+3 is the most significant bit and bit 1 of Octet f+4 the least significant bit. The coding of the location area code is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +## 8.21.7 Macro eNodeB ID field + +The coding of Macro eNodeB ID is depicted in Figure 8.21.7-1. Only zero or one Macro eNodeB ID or Extended Macro eNodeB ID field shall be present in ULI IE. + +| Octets | Bits | | | | | | | | +|------------|-----------------|---|---|---|-----------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| g | MCC digit 2 | | | | MCC digit 1 | | | | +| g+1 | MNC digit 3 | | | | MNC digit 3 | | | | +| g+2 | MNC digit 2 | | | | MNC digit 1 | | | | +| g+3 | Spare | | | | Macro eNodeB ID | | | | +| g+4 to g+5 | Macro eNodeB ID | | | | | | | | + +Figure 8.21.7-1: Macro eNodeB ID field + +The Macro eNodeB ID consists of 20 bits. Bit 4 of Octet g+3 is the most significant bit and bit 1 of g+5 is the least significant bit. The coding of the Macro eNodeB ID is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +## 8.21.8 Extended Macro eNodeB ID field + +The coding of Extended Macro eNodeB ID is depicted in Figure 8.21.8-1. Only zero or one Extended Macro eNodeB ID or Macro eNodeB ID field shall be present in ULI IE. + +| Octets | Bits | | | | | | | | +|------------|--------------------------|-------|---|---|--------------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| g | MCC digit 2 | | | | MCC digit 1 | | | | +| g+1 | MNC digit 3 | | | | MNC digit 3 | | | | +| g+2 | MNC digit 2 | | | | MNC digit 1 | | | | +| g+3 | SMeNB | Spare | | | Extended Macro eNodeB ID | | | | +| g+4 to g+5 | Extended Macro eNodeB ID | | | | | | | | + +**Figure 8.21.8-1: Extended Macro eNodeB ID field** + +The Extended Macro eNodeB ID consists of 21 bits. The coding of the Extended Macro eNodeB ID is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +If the SMeNB flag is not set the Extended Macro eNodeB ID field contains a Long Macro eNodeB ID with a length of 21 Bits. Bit 5 of Octet g+3 is the most significant bit and bit 1 of g+5 is the least significant bit. + +If the SMeNB flag is set the Extended Macro eNodeB ID field contains a Short Macro eNodeB ID with a length of 18 Bits. Bits 3 to 5 of Octet g+3 shall be set to 0 by the sender and shall be ignored by the receiver. Bit 2 of Octet g+3 is the most significant bit and bit 1 of Octet g+5 is the least significant bit. + +NOTE: Homogenous support of the Extended Macro eNodeB ID IE is expected in a PLMN. + +## 8.22 Fully Qualified TEID (F-TEID) + +Fully Qualified Tunnel Endpoint Identifier (F-TEID) is coded as depicted in Figure 8.22-1. + +| Octets | Bits | | | | | | | | | | | | | | | | | | +|-------------|------------------------------------------------------------|----|----------------|---|----------|---|---|---|--|--|--|--|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | | | | +| 1 | Type = 87 (decimal) | | | | | | | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | | | | | | | +| 5 | V4 | V6 | Interface Type | | | | | | | | | | | | | | | | +| 6 to 9 | TEID / GRE Key | | | | | | | | | | | | | | | | | | +| m to (m+3) | IPv4 address | | | | | | | | | | | | | | | | | | +| p to (p+15) | IPv6 address | | | | | | | | | | | | | | | | | | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | | | | | | | + +**Figure 8.22-1: Fully Qualified Tunnel Endpoint Identifier (F-TEID)** + +The following flags are coded within Octet 5: + +- Bit 8 – V4: If this bit is set to "1", then IPv4 address field exists in the F-TEID, otherwise the IPv4 address field is not present at all. +- Bit 7 – V6: If this bit is set to "1", then IPv6 address field exists in the F-TEID, otherwise the IPv6 address field is not present at all. + +At least one of V4 and V6 shall be set to "1", and both may be set to "1". + +- Bit 6 to Bit 1 – Interface Type: This 6 bit wide integer can take the following values representing interface type and endpoint: + - 0: S1-U eNodeB GTP-U interface + - 1: S1-U SGW GTP-U interface + - 2: S12 RNC GTP-U interface + - 3: S12 SGW GTP-U interface + - 4: S5/S8 SGW GTP-U interface + - 5: S5/S8 PGW GTP-U interface + - 6: S5/S8 SGW GTP-C interface + - 7: S5/S8 PGW GTP-C interface + - 8: S5/S8 SGW PMIPv6 interface (the 32 bit GRE key is encoded in 32 bit TEID field) + - 9: S5/S8 PGW PMIPv6 interface (the 32 bit GRE key is encoded in the 32 bit TEID field, see clause 6.3 in 3GPP TS 29.275 [26]) + - 10: S11 MME GTP-C interface + - 11: S11/S4 SGW GTP-C interface + - 12: S10/N26 MME GTP-C interface + - 13: S3 MME GTP-C interface + - 14: S3 SGSN GTP-C interface + +- 15: S4 SGSN GTP-U interface +- 16: S4 SGW GTP-U interface +- 17: S4 SGSN GTP-C interface +- 18: S16 SGSN GTP-C interface +- 19: eNodeB/gNodeB GTP-U interface for DL data forwarding +- 20: eNodeB GTP-U interface for UL data forwarding +- 21: RNC GTP-U interface for data forwarding +- 22: SGSN GTP-U interface for data forwarding +- 23: SGW/UPF GTP-U interface for DL data forwarding +- 24: Sm MBMS GW GTP-C interface +- 25: Sn MBMS GW GTP-C interface +- 26: Sm MME GTP-C interface +- 27: Sn SGSN GTP-C interface +- 28: SGW GTP-U interface for UL data forwarding +- 29: Sn SGSN GTP-U interface +- 30: S2b ePDG GTP-C interface +- 31: S2b-U ePDG GTP-U interface +- 32: S2b PGW GTP-C interface +- 33: S2b-U PGW GTP-U interface +- 34: S2a TWAN GTP-U interface +- 35: S2a TWAN GTP-C interface +- 36: S2a PGW GTP-C interface +- 37: S2a PGW GTP-U interface +- 38: S11 MME GTP-U interface +- 39: S11 SGW GTP-U interface +- 40: N26 AMF GTP-C interface +- 41: N19mb UPF GTP-U interface + +Other values of "Interface Type" are spare and reserved for future use. + +"Interface type" values with bit "6" set to 1 shall only be used between Rel-10 onwards GTPv2-C nodes. + +NOTE 1: "Interface type" IE is defined with 5 bits only in the earlier releases of this specification, thus pre-Rel-10 GTPv2-C nodes can ignore bit "6" which is marked as "Spare" in earlier releases, allowing backward compatibility. + +NOTE 2: Interface Type 8 is not used in this Release and in earlier Releases. + +Octet 6 to 9 (TEID/GRE field) represent either a TEID or a GRE key. If both IPv4 and IPv6 addresses are present in F-TEID IE, then the TEID value shall be shared by both addresses. + +Octets "m to (m+3)" and/or "p to (p+15)" (IPv4 address / IPv6 address fields), if present, contain respective address values. + +## 8.23 TMSI + +The TMSI, unambiguously associated with a given UE and Location area, is given by: + +| Octets | Bits | | | | | | | | +|------------|----------------------------------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 88 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | TMSI
The TMSI is defined in 3GPP TS 23.003 [2]. | | | | | | | | + +Figure 8.23-1: TMSI + +## 8.24 Global CN-Id + +The Global CN-Id is coded as depicted in Figure 8.24-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 89 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | MCC digit 2 | | | | MCC digit 1 | | | | +| 6 | MNC digit 3 | | | | MNC digit 3 | | | | +| 7 | MNC digit 2 | | | | MNC digit 1 | | | | +| 8 to (n+4) | CN-Id
The CN-Id is defined in 3GPP TS 23.003 [2]. | | | | | | | | + +Figure 8.24-1: Global CN-Id + +If an Administration decides to include only two digits in the MNC, then bits 5 to 8 of octet 6 are coded as "1111". + +## 8.25 S103 PDN Data Forwarding Info (S103PDF) + +The HSGW Address and GRE Key identify a GRE Tunnel towards a HSGW over S103 interface for a specific PDN connection of the UE. The EPS Bearer IDs specify the EPS Bearers which require data forwarding that belonging to this PDN connection. The number of EPS bearer IDs included is specified by the value of EPS Bearer ID Number. + +The spare bits indicate unused bits, which shall be set to 0 by the sending side and which shall not be evaluated by the receiving side. + +| Octets | Bits | | | | | | | | | | | | +|--------------------|----------------------------------------|---|---|---|---------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 90 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | HSGW Address for forwarding Length = m | | | | | | | | | | | | +| 6 to (m+5) | HSGW Address for forwarding [4..16] | | | | | | | | | | | | +| (m+6)- to (m+9) | GRE Key | | | | | | | | | | | | +| (m+10) | EPS Bearer ID Number = k | | | | | | | | | | | | +| (m+11) to (m+10+k) | Spare | | | | EPS Bearer ID | | | | | | | | + +Figure 8.25-1: S103 PDN Data Forwarding Info + +## 8.26 S1-U Data Forwarding (S1UDF) + +The Serving GW Address and Serving GW S1-U TEID consists of the S1-U Tunnel information allocated by the Serving GW for an EPS Bearer identified by the EPS Bearer ID which requires data forwarding during active handover from E-UTRAN Access to cdma2000 HRPD Access. + +The spare bits indicate unused bits, which shall be set to 0 by the sending side and which shall not be evaluated by the receiving side. + +| Octets | Bits | | | | | | | | | | | | +|-----------------|-------------------------------|---|---|---|---------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 91 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Spare | | | | EPS Bearer ID | | | | | | | | +| 6 | Serving GW Address Length = m | | | | | | | | | | | | +| 7 to (m+6) | Serving GW Address [4..16] | | | | | | | | | | | | +| (m+7) to (m+10) | Serving GW S1-U TEID | | | | | | | | | | | | + +Figure 8.26-1: S1-U Data Forwarding Info + +## 8.27 Delay Value + +Delay Value is coded as depicted in Figure 8.27-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 92 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Delay Value in integer multiples of 50 millisecs, or zero | | | | | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.27-1: Delay Value + +Delay Value is set to zero in order to clear a previously set delay condition. + +## 8.28 Bearer Context + +Bearer Context is a grouped IE containing a number of other IEs. Which of those IEs are mandatory, optional or conditional and the conditions that apply are GTP message specific, and described in the corresponding clause under clause 7. + +Bearer Context may be repeated within a message with exactly the same Type and Instance values to represent a list of Bearer Contexts. + +Bearer Context is coded as depicted in Table 8.28-1. + +Table 8.28-1: Bearer Context Grouped Type + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|----------------------------|----------------|-------------| +| Octet 1 | Bearer Context IE Type = 93 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| NOTE: This table uses a 5-column format in order to match the format used in clauses of clause 7, where the usage of this IE is further detailed for each specific GTP message including it. | | | | | + +## 8.29 Charging ID + +The Charging ID is coded as depicted in Figure 8.29-1. It is defined in 3GPP TS 32.251[8]. + +| Octets | Bits | | | | | | | | | | | | +|---------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 94 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5-8 | Charging ID value | | | | | | | | | | | | +| 9-(n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.29-1: Charging ID + +## 8.30 Charging Characteristics + +The charging characteristics information element is defined in 3GPP TS 32.251 [8] and is a way of informing both the SGW and PGW of the rules for producing charging information or informing the PGW to inhibit the establishment of the Gx session based on operator configured triggers. For the encoding of this information element see 3GPP TS 32.298 [9]. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 95 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 6 | Charging Characteristics value | | | | | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.30-1: Charging Characteristics + +## 8.31 Trace Information + +Trace Information is coded as depicted in Figure 8.31-1. See 3GPP TS 32.422 [18] for details on trace related information. + +| Octets | Bits | | | | | | | | | | | | +|-------------|---------------------------------------|---|---|---|-------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 96(decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | MCC digit 2 | | | | MCC digit 1 | | | | | | | | +| 6 | MNC digit 3 | | | | MNC digit 3 | | | | | | | | +| 7 | MNC digit 2 | | | | MNC digit 1 | | | | | | | | +| 8 to 10 | Trace ID | | | | | | | | | | | | +| 11 to 19 | Triggering Events | | | | | | | | | | | | +| 20 to 21 | List of NE Types | | | | | | | | | | | | +| 22 | Session Trace Depth | | | | | | | | | | | | +| 23 to 34 | List of Interfaces | | | | | | | | | | | | +| 35 to (n+4) | IP Address of Trace Collection Entity | | | | | | | | | | | | + +Figure 8.31-1: Trace Information + +Octets 5 to 10 represent the Trace Reference parameter as defined in clause 5.6 of 3GPP TS 32.422 [18]. + +Triggering Events shall be encoded as the first 9 octets in clause 5.1 of 3GPP TS 32.422 [18]. + +List of NE Types, Session Trace Depth and IP Address of Trace Collection Entity are specified in 3GPP TS 32.422 [18]. + +List of Interfaces shall be encoded as the first 12 octets in clause 5.5 of 3GPP TS 32.422 [18]. + +See 3GPP TS 24.008 [5], clause 10.5.1.4, Mobile Identity, for the coding of MCC and MNC, whose values are obtained from the serving PLMN that the EM/NM is managing. If MNC is 2 digits long, bits 5 to 8 of octet 6 are coded as "1111". + +NOTE: During a 5GS to EPS mobility, the MME derives the information to be sent in the Trace Information IE over S11 from the Extended Trace Information IE received from the AMF, if an SGW trace is activated; the PGW(+SMF) derives relevant trace information from the Trace Data that it received earlier (at the SMF), if a PGW trace is to be activated. + +## 8.32 Bearer Flags + +Bearer Flags is coded as depicted in Figure 8.32-1. + +| Octets | Bits | | | | | | | | +|---------|------------------------------------------------------------|---|---|---|----------|------|----|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 97 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | ASI | Vind | VB | PPC | +| 6-(n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.32-1: Bearer Flags + +The following bits within Octet 5 indicate: + +- Bit 1 – PPC (Prohibit Payload Compression): This flag is used to determine whether an SGSN should attempt to compress the payload of user data when the user asks for it to be compressed (PPC = 0), or not (PPC = 1). +- Bit 2 – VB (Voice Bearer): This flag is used to indicate a voice bearer when doing PS-to-CS (v)SRVCC handover. +- Bit 3 – Vind (vSRVCC indicator): This flag is used to indicate that this bearer is an IMS video bearer and is candidate for PS-to-CS vSRVCC handover. +- Bit 4 – ASI (Activity Status Indicator): When set to 1, this flag indicates that the bearer context is preserved in the CN without corresponding Radio Access Bearer established. The target S4-SGSN shall keep the bearer context associated with this indicator preserved. When the target S4-SGSN sends Relocation Request message towards the target RNC, the target S4-SGSN may not request to setup the RABs for those bearer contexts associated with this indicator. + +## 8.33 Void + +## 8.34 PDN Type + +The PDN Type is coded as depicted in Figure 8.34-1. + +| Octets | Bits | | | | | | | | +|-----------|------------------------------------------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 99 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | PDN Type | | | | +| 6 to n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.34-1: PDN Type + +Table 8.34-1: PDN Type + +| PDN type value (octet 5) | | | | +|--------------------------|---|---|----------| +| Bits | | | | +| 3 | 2 | 1 | | +| 0 | 0 | 1 | IPv4 | +| 0 | 1 | 0 | IPv6 | +| 0 | 1 | 1 | IPv4v6 | +| 1 | 0 | 0 | Non-IP | +| 1 | 0 | 1 | Ethernet | + +All other values are reserved. + +Bits 8-4 of octet 5 are spare and shall be coded as zero. + +## 8.35 Procedure Transaction ID (PTI) + +Procedure Transaction Id is coded as depicted in Figure 8.35-1. It is defined in 3GPP TS 24.301 [23], clause 9.4 and is coded as specified in 3GPP TS 24.007 [30], clause 11.2.3.1a Procedure transaction identity. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 100 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Procedure Transaction ID | | | | | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.35-1: Procedure Transaction ID + +## 8.36 Void + +## 8.37 Void + +## 8.38 MM Context + +The MM Context information element contains the Mobility Management, UE security parameters that are necessary to transfer over S3/S16/S10/N26 interface. + +All Spare bits are set to zeros by the sender and ignored by the receiver. Spare bits in MM Context IE shall be set to 1's before sending MM Context IE to Gn/Gp SGSN. + +NOTE 1: The encoding of Spare bits in MM Context IE is different between GTPv1 and GTPv2. Spare bits in GTPv1 in MM Context IE there are set to 1s. + +Security Mode indicates the type of security keys (GSM/UMTS/EPS) and Authentication Vectors (quadruplets /quintuplets/triplets) that are passed to the new MME/SGSN/AMF. + +The DRX parameter coding is specified in clause 10.5.5.6 of 3GPP TS 24.008 [5]. If DRXI (DRX Indicator), bit 4 of octet 5, is set to "1", then the DRX parameter field is present, otherwise its octets are not present. During 5GS to EPS mobility procedure, the source AMF shall not send 5G DRX parameter to the target MME; and during EPS to 5GS mobility procedure, the target AMF shall discard the DRX parameter if received. The encoding of 5G DRX as specified in clause 9.11.3.2A of 3GPP TS 24.501 [87] is different from the one as specified in clause 10.5.5.6 of 3GPP TS 24.008 [5]. + +Uplink/downlink Subscribed UE AMBR (Aggregate Maximum Bit Rate) is coded as Unsigned32 integer values in kbps (1000 bps) for all non-GBR bearers according to the subscription of the user. The uplink/downlink Subscribed UE AMBR requires converting values in bits per second to kilobits per second when it is received from the HSS. If such conversions result in fractions, then the uplink/downlink Subscribed UE AMBR values shall be rounded upwards. If SAMBRI (Subscribed UE AMBR Indicator), bit 1 of octet 6, is set to "1", then the Uplink/downlink Subscribed UE AMBR parameter field is present, otherwise these parameters are not present. If no Subscribed UE AMBR is received from the HSS, the SAMBRI shall be set to "0". Uplink/downlink Used UE AMBR (Aggregate Maximum Bit Rate) is coded as Unsigned32 integer values in kbps (1000 bps) for all non-GBR bearers currently being used by the UE. If UAMBRI (Used UE AMBR Indicator), bit 2 of octet 6, is set to "1", then the Uplink/downlink Used UE AMBR parameter field is present, otherwise these parameters are not present. + +The encoding of Mobile Equipment Identity (MEI) field shall be same as specified in clause 8.10 of this specification. If Length of Mobile Equipment Identity is zero, then the Mobile Equipment Identity parameter shall not be present. If the UE is emergency or RLOS attached and the UE is UICless or the IMSI is unauthenticated, Mobile Equipment Identity (MEI) shall be used as the UE identity. + +The UE Network Capability coding is specified in clause 9.9.3.34 of 3GPP TS 24.301 [23]. If Length of UE Network Capability is zero, then the UE Network Capability parameter shall not be present. + +The MS Network Capability coding is specified in clause 10.5.5.12 of 3GPP TS 24.008 [5]. If Length of MS Network Capability is zero, then the MS Network Capability parameter shall not be present. + +The Voice Domain Preference and UE's Usage Setting coding is specified in clause 10.5.5.28 of 3GPP TS 24.008 [5]. If Length of Voice Domain Preference and UE's Usage Setting is zero, then the Voice Domain Preference and UE's Usage Setting parameter shall not be present. + +Used Cipher indicates the GSM ciphering algorithm that is in use. + +Used NAS Cipher indicates the EPS ciphering algorithm that is in use. + +The Access restriction data is composed of UNA(UTRAN Not Allowed), GENA(GERAN Not Allowed), GANA(GAN Not Allowed), INA(I-HSPA-Evolution Not Allowed), ENA(WB-E-UTRAN Not Allowed), NBNA(NB-IoT Not Allowed), ECNA (Enhanced Coverage Not Allowed) and HNNA(HO-To-Non-3GPP-Access Not Allowed). + +If the SGSN support the Higher bitrates than 16 Mbps flag, the Higher bitrates than 16 Mbps flag shall be included in the MM Context if: + +- the source S4-SGSN has received "Higher bitrates than 16 Mbps flag" in the RANAP Initial UE Message or in RANAP Relocation Complete as defined in TS 25.413 [33] from the RNC, or +- the source S4-SGSN has stored the "Higher bitrates than 16 Mbps flag" (received from an SGSN via the Identification Response, Context Response or Forward Relocation Request during earlier procedures). + +The S4-SGSN shall set the "Higher bitrates than 16 Mbps flag" to "1" if "Higher bitrates than 16 Mbps flag" is "allowed" and to "0" if it is "not allowed". The Length of Higher bitrates than 16 Mbps flag shall be set to zero if the S4-SGSN has not received the "Higher bitrates than 16 Mbps flag". + +As depicted in Figure 8.38-1, the GSM Key, Used Cipher and Authentication Triplets that are unused in the old SGSN shall be transmitted to the new SGSN for the GSM subscribers. An array of at most 5 Authentication Triplets may be included. The field 'Number of Triplet' shall be set to the value '0' if no Authentication Triplet is included (i.e. octets '16 to h' are absent). + +The Authentication Triplet coding is specified in Figure 8.38-7. + +| Octets | Bits | | | | | | | | | | | | | | +|----------------|------------------------------------------------------------|------|-------|-----|-------------|------------|------------|-----|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | +| 1 | Type = 103 (decimal) | | | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | | | +| 5 | Security Mode | | Spare | | DRXI | CKSN | | | | | | | | | +| 6 | Number of Triplet | | Spare | | | UAMB
RI | SAMB
RI | | | | | | | | +| 7 | Spare | | | | Used Cipher | | | | | | | | | | +| 8 to 15 | Kc | | | | | | | | | | | | | | +| 16 to h | Authentication Triplet [1..5] | | | | | | | | | | | | | | +| (h+1) to (h+2) | DRX parameter | | | | | | | | | | | | | | +| j to (j+3) | Uplink Subscribed UE AMBR | | | | | | | | | | | | | | +| (j+4) to (j+7) | Downlink Subscribed UE AMBR | | | | | | | | | | | | | | +| i to (i+3) | Uplink Used UE AMBR | | | | | | | | | | | | | | +| (i+4) to (i+7) | Downlink Used UE AMBR | | | | | | | | | | | | | | +| q | Length of UE Network Capability | | | | | | | | | | | | | | +| (q+1) to k | UE Network Capability | | | | | | | | | | | | | | +| k+1 | Length of MS Network Capability | | | | | | | | | | | | | | +| (k+2) to m | MS Network Capability | | | | | | | | | | | | | | +| m+1 | Length of Mobile Equipment Identity (MEI) | | | | | | | | | | | | | | +| (m+2) to r | Mobile Equipment Identity (MEI) | | | | | | | | | | | | | | +| r+1 | ECNA | NBNA | HNNA | ENA | INA | GANA | GENA | UNA | | | | | | | +| r+2 | Length of Voice Domain Preference and UE's Usage Setting | | | | | | | | | | | | | | +| (r+3) to s | Voice Domain Preference and UE's Usage Setting | | | | | | | | | | | | | | +| (s+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | | | + +Figure 8.38-1: GSM Key and Triplets + +As depicted in Figure 8.38-2, the UMTS Key, Used Cipher and Authentication Quintuplets that are unused in the old SGSN shall be transmitted to the new SGSN when the UMTS subscriber is attached to a GSM BSS in the old system, in case the user has a ME capable of UMTS AKA. An array of at most 5 Authentication Quintuplets may be included. The field 'Number of Quintuplets' shall be set to the value '0' if no Authentication Quintuplet is included (i.e. octets '40 to h' are absent). + +If the UGIPAI (Used GPRS integrity protection algorithm Indicator), bit 3 of octet 6, is set to 1, then bits 4 to 6 of octet 7 shall contain the Used GPRS integrity protection algorithm field, otherwise these bits shall be set to 0 and ignored by the receiver. + +The GUPII (GPRS User Plane Integrity Indicator), bit 4 of octet 6, shall be set to 1 if the subscriber profile indicated that user plane integrity protection is required and set to 0 otherwise. + +NOTE 2: The encoding of the bits is not identical with GTPv1 as the spare bits are encoded differently. + +The source S4-SGSN shall include the IOV\_updates counter if it is supported and available. The IOV\_updates counter is encoded as an integer with a length of 1 octet. The use of the IOV\_updates counter is specified in + +3GPP TS 43.020 [78]. If IOVI (IOV\_updates Indicator), bit 5 of octet 6, is set to "1", then the IOV\_updates counter parameter field shall be present, otherwise it shall not be present. + +The Authentication Quintuplet coding is specified in Figure 8.38-8. + +| Octets | Bits | | | | | | | | | | | | | | | | | +|----------------|------------------------------------------------------------|------------------------------------------|-------|-------|-------------|------------|------------|-----|--|--|--|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | | | +| 1 | Type = 104 (decimal) | | | | | | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | | | | | | +| 5 | Security Mode | | Spare | DRXI | CKSN/KSI | | | | | | | | | | | | | +| 6 | Number of Quintuplets | | IOVI | GUPII | UGIP
AI | UAMB
RI | SAMB
RI | | | | | | | | | | | +| 7 | Spare | Used GPRS integrity protection algorithm | | | Used Cipher | | | | | | | | | | | | | +| 8 to 23 | CK | | | | | | | | | | | | | | | | | +| 24 to 39 | IK | | | | | | | | | | | | | | | | | +| 40 to h | Authentication Quintuplet [1..5] | | | | | | | | | | | | | | | | | +| (h+1) to (h+2) | DRX parameter | | | | | | | | | | | | | | | | | +| j to (j+3) | Uplink Subscribed UE AMBR | | | | | | | | | | | | | | | | | +| (j+4) to (j+7) | Downlink Subscribed UE AMBR | | | | | | | | | | | | | | | | | +| i to (i+3) | Uplink Used UE AMBR | | | | | | | | | | | | | | | | | +| (i+4) to (i+7) | Downlink Used UE AMBR | | | | | | | | | | | | | | | | | +| q | Length of UE Network Capability | | | | | | | | | | | | | | | | | +| (q+1) to k | UE Network Capability | | | | | | | | | | | | | | | | | +| k+1 | Length of MS Network Capability | | | | | | | | | | | | | | | | | +| (k+2) to m | MS Network Capability | | | | | | | | | | | | | | | | | +| m+1 | Length of Mobile Equipment Identity (MEI) | | | | | | | | | | | | | | | | | +| (m+2) to r | Mobile Equipment Identity (MEI) | | | | | | | | | | | | | | | | | +| r+1 | ECNA | NBNA | HNNA | ENA | INA | GANA | GENA | UNA | | | | | | | | | | +| r+2 | Length of Voice Domain Preference and UE's Usage Setting | | | | | | | | | | | | | | | | | +| (r+3) to s | Voice Domain Preference and UE's Usage Setting | | | | | | | | | | | | | | | | | +| s+1 | Length of Higher bitrates than 16 Mbps flag | | | | | | | | | | | | | | | | | +| s+2 | Higher bitrates than 16 Mbps flag | | | | | | | | | | | | | | | | | +| s+3 | IOV_updates counter | | | | | | | | | | | | | | | | | +| (s+4) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | | | | | | + +**Figure 8.38-2: UMTS Key, Used Cipher and Quintuplets** + +As depicted in Figure 8.38-3, the GSM Key, Used Cipher and Authentication Quintuplets that are unused in the old SGSN shall be transmitted to the new SGSN when the UMTS subscriber is attached to a GSM BSS in the old system, in case the user has a ME no capable of UMTS AKA. An array of at most 5 Authentication Quintuplets may be included. The field 'Number of Quintuplets' shall be set to the value '0' if no Authentication Quintuplet is included (i.e. octets '16 to h' are absent). + +The Authentication Quintuplet coding is specified in Figure 8.38-8. + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|------|-------|------|-------------|------|------------|------------|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 105 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Security Mode | | Spare | DRXI | CKSN/KSI | | | | | | | | +| 6 | Number of Quintuplets | | Spare | | | | UAMB
RI | SAMB
RI | | | | | +| 7 | Spare | | | | Used Cipher | | | | | | | | +| 8 to 15 | Kc | | | | | | | | | | | | +| 16 to h | Authentication Quintuplets [1..5] | | | | | | | | | | | | +| (h+1) to (h+2) | DRX parameter | | | | | | | | | | | | +| j to (j+3) | Uplink Subscribed UE AMBR | | | | | | | | | | | | +| (j+4) to (j+7) | Downlink Subscribed UE AMBR | | | | | | | | | | | | +| i to (i+3) | Uplink Used UE AMBR | | | | | | | | | | | | +| (i+4) to (i+7) | Downlink Used UE AMBR | | | | | | | | | | | | +| q | Length of UE Network Capability | | | | | | | | | | | | +| (q+1) to k | UE Network Capability | | | | | | | | | | | | +| k+1 | Length of MS Network Capability | | | | | | | | | | | | +| (k+2) to m | MS Network Capability | | | | | | | | | | | | +| m+1 | Length of Mobile Equipment Identity (MEI) | | | | | | | | | | | | +| (m+2) to r | Mobile Equipment Identity (MEI) | | | | | | | | | | | | +| r+1 | ECNA | NBNA | HNNA | ENA | INA | GANA | GENA | UNA | | | | | +| r+2 | Length of Voice Domain Preference and UE's Usage Setting | | | | | | | | | | | | +| (r+3) to s | Voice Domain Preference and UE's Usage Setting | | | | | | | | | | | | +| s+1 | Length of Higher bitrates than 16 Mbps flag | | | | | | | | | | | | +| s+2 | Higher bitrates than 16 Mbps flag | | | | | | | | | | | | +| (s+3) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +**Figure 8.38-3: GSM Key, Used Cipher and Quintuplets** + +As depicted in Figure 8.38-4, the UMTS Key, KSI and unused Authentication Quintuplets in the old SGSN may be transmitted to the new SGSN/MME when the UMTS subscriber is attached to UTRAN/GERAN in the old system, but it is not allowed to send quintuplets to an MME in a different serving network domain (see 3GPP TS 33.401 [12] clause 6.1.6). The MME may forward the UMTS Key, KSI and unused Authentication Quintuplets which were previously stored back to the same SGSN, for further details, refer to 3GPP TS 33.401 [12]. An array of at most 5 Authentication Quintuplets may be included. The field 'Number of Quintuplets' shall be set to the value '0' if no Authentication Quintuplet is included (i.e. octets '40 to h' are absent). + +If the UGIPAI (Used GPRS integrity protection algorithm Indicator), bit 3 of octet 6, is set to 1, then bits 1 to 3 of octet 7 shall contain the Used GPRS integrity protection algorithm field, otherwise these bits shall be set to 0 and ignored by the receiver. + +The GUPII (GPRS User Plane Integrity Indicator), bit 4 of octet 6, shall be set to 1 if the subscriber profile indicated that user plane integrity protection is required and set to 0 otherwise. + +NOTE 3: The encoding of the bits is not identical with GTPv1 as the spare bits are encoded differently. + +The source S4-SGSN shall include the IOV\_updates counter if it is supported and available. The IOV\_updates counter is encoded as an integer with a length of 1 octet. The use of the IOV\_updates counter is specified in 3GPP TS 43.020 [78]. If IOVI (IOV\_updates Indicator), bit 5 of octet 6, is set to "1", then the IOV\_updates counter parameter field shall be present, otherwise it shall not be present. + +The Extended Access Restriction Data is to store the extra access restriction data received from the HSS (other than ECNA, NBNA, HNNA, ENA, INA, GANA, GENA and UNA). If Length of Extended Access Restriction Data is zero, then the field of Extended Access Restriction Data shall not be present. The Extended Access Restriction Data is composed of NRSRNA (NR as Secondary RAT Not Allowed). The presence of the Extended Access Restriction Data for the case in UMTS Key as depicted in Figure 8.38-4 is optional. + +NOTE 4: In Figure 8.38-4, including the Extended Access Restriction Data allows optimized selection of SGW in case of handover from GSM/UTRAN to E-UTRAN. + +The Authentication Quintuplet coding is specified in Figure 8.38-8. + +![](b1ec498620251169dcfc839e18443154_img.jpg) + +| Octets | Bits | | | | | | | | +|----------------|------------------------------------------------------------|------|-------|-------|------------------------------------------|---------|---------|------------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 106 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Security Mode | | Spare | DRXI | KSI | | | | +| 6 | Number of Quintuplets | | IOVI | GUPII | UGIP AI | UAMB RI | SAMB RI | | +| 7 | Spare | | | | Used GPRS integrity protection algorithm | | | | +| 8 to 23 | CK | | | | | | | | +| 24 to 39 | IK | | | | | | | | +| 40 to h | Authentication Quintuplet [1..5] | | | | | | | | +| (h+1) to (h+2) | DRX parameter | | | | | | | | +| j to (j+3) | Uplink Subscribed UE AMBR | | | | | | | | +| (j+4) to (j+7) | Downlink Subscribed UE AMBR | | | | | | | | +| i to (i+3) | Uplink Used UE AMBR | | | | | | | | +| (i+4) to (i+7) | Downlink Used UE AMBR | | | | | | | | +| q | Length of UE Network Capability | | | | | | | | +| (q+1) to k | UE Network Capability | | | | | | | | +| k+1 | Length of MS Network Capability | | | | | | | | +| (k+2) to m | MS Network Capability | | | | | | | | +| m+1 | Length of Mobile Equipment Identity (MEI) | | | | | | | | +| (m+2) to r | Mobile Equipment Identity (MEI) | | | | | | | | +| r+1 | ECNA | NBNA | HNNA | ENA | INA | GANA | GENA | UNA | +| r+2 | Length of Voice Domain Preference and UE's Usage Setting | | | | | | | | +| (r+3) to s | Voice Domain Preference and UE's Usage Setting | | | | | | | | +| s+1 | Length of Higher bitrates than 16 Mbps flag | | | | | | | | +| s+2 | Higher bitrates than 16 Mbps flag | | | | | | | | +| s+3 | IOV_updates counter | | | | | | | | +| s+4 | Length of Extended Access Restriction Data | | | | | | | | +| (s+5) to t | Spare | | | | | | | NRS
RNA | +| (t+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.38-4: UMTS Key and Quintuplets + +As depicted in Figure 8.38-5, the current EPS Security Context, a non-current EPS Security Context (if available), and unused Authentication Quadruplets in the old MME may be transmitted to the new MME/AMF. If the new MME/AMF is not in the same serving network domain, then only the current EPS Security Context may be transmitted. The mapping of an EPS security context to a 5G security context in the new AMF is specified in 3GPP TS 33.501 [86]. An array of at most 5 Authentication Quadruplets may be included. The field 'Number of Quadruplets' shall be set to the value '0' if no Authentication Quadruplet is included (i.e. octets '46 to g' are absent). Authentication Quintuplets shall not be transmitted to the new MME/AMF (i.e. octets 'g+1 to h' shall be absent) even if the old MME has the Authentication Quintuplets for this UE. The field 'Number of Quintuplets' shall be set to the value '0'. The reasons for not sending Quintuplets are specified in 3GPP TS 33.401 [12] clause 6.1.6. + +The current EPS Security Context may be transmitted by the old AMF to the new MME, where the mapping of a 5G security context to an EPS security context is specified in 3GPP TS 33.501 [86]. The field 'Number of Quadruplets' and 'Number of Quintuplets' shall be set to the value '0'. The AMF shall not transmit un-used authentication vectors to an MME and shall discard any un-used authentication vectors received from an MME, regardless of whether the MME and AMF pertain to the same or different serving network domains. + +The Authentication Quintuplet and Authentication Quadruplet codings are specified in Figure 8.38-8 and Figure 8.38-9 respectively. + +The value of the NAS Downlink Count shall be set to the value that shall be used to send the next NAS message. + +The value of the NAS Uplink Count shall be set to the largest NAS Uplink Count that was in a successfully integrity verified NAS message. + +In Figure 8.38-5, the fields for the Old EPS Security Context (i.e. octets from s to s+64) may be present only in S10 Forward Relocation Request message according to the Rules on Concurrent Running of Security Procedures, which are specified in 3GPP TS 33.401 [12]. The octets for Old EPS Security Context shall be present if the OSCI (Old Security Context Indicator), bit 1 of octet 6) is set to "1"; otherwise they shall not be present. + +If NHI\_old (Next Hop Indicator for old EPS Security Context), bit 8 of octet s, is set to "1", then the parameters old NH (Next Hop) and old NCC (Next Hop Chaining Count) shall be present; otherwise the octets for old NH parameter shall not be present and the value of old NCC parameter shall be ignored by the receiver. . + +Multiple APN Rate Control Statuses (including the number of packets still allowed in the given time unit, the number of additional exception reports still allowed in the given time unit and the termination time of the current APN Rate Control validity period) may be included by the MME. + +The MM context shall contain the APN Rate Control Status(s) for PDN connection which are released and currently not re-established. Once a PDN connection is re-established, the related APN Rate Control Status shall be deleted. + +The UAMBRI shall be set to "0" by the old AMF, and then the Uplink/downlink Used UE AMBR parameter field are not present. The SAMBRI shall be set to "1" by the old AMF, if the AMF has the Uplink/downlink Subscribed UE AMBR received from the MME, or the Uplink/downlink Subscribed UE AMBR in 5G. + +The RLOS indication flag (bit 7 of octet s) shall be set to 1 if the UE is RLOS attached. + +| Octets | Bits | | | | | | | | | | | | | | | | | +|------------------|----------------------------------------------------------|-----------------------------------------|-------------------------|-----------------|---------------------|---------|------|-----|--|--|--|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | | | +| 1 | Type = 107 (decimal) | | | | | | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | | | | | | +| 5 | Security Mode | | NHI | DRXI | KSI ASME | | | | | | | | | | | | | +| 6 | Number of Quintuplets | | Number of Quadruplet | | UAMB | RI | OSCI | | | | | | | | | | | +| 7 | SAMB | Used NAS integrity protection algorithm | | Used NAS Cipher | | | | | | | | | | | | | | +| 8 to 10 | NAS Downlink Count | | | | | | | | | | | | | | | | | +| 11 to 13 | NAS Uplink Count | | | | | | | | | | | | | | | | | +| 14 to 45 | K ASME | | | | | | | | | | | | | | | | | +| 46 to g | Authentication Quadruplet [1..5] | | | | | | | | | | | | | | | | | +| (g+1) to h | Authentication Quintuplet [1..5] | | | | | | | | | | | | | | | | | +| (h+1) to (h+2) | DRX parameter | | | | | | | | | | | | | | | | | +| p to (p+31) | NH | | | | | | | | | | | | | | | | | +| (p+32) | Spare | | | | NCC | | | | | | | | | | | | | +| j to (j+3) | Uplink Subscribed UE AMBR | | | | | | | | | | | | | | | | | +| (j+4) to (j+7) | Downlink Subscribed UE AMBR | | | | | | | | | | | | | | | | | +| i to (i+3) | Uplink Used UE AMBR | | | | | | | | | | | | | | | | | +| (i+4) to (i+7) | Downlink Used UE AMBR | | | | | | | | | | | | | | | | | +| q | Length of UE Network Capability | | | | | | | | | | | | | | | | | +| (q+1) to k | UE Network Capability | | | | | | | | | | | | | | | | | +| (k+1) | Length of MS Network Capability | | | | | | | | | | | | | | | | | +| (k+2) to m | MS Network Capability | | | | | | | | | | | | | | | | | +| (m+1) | Length of Mobile Equipment Identity (MEI) | | | | | | | | | | | | | | | | | +| (m+2) to r | Mobile Equipment Identity (MEI) | | | | | | | | | | | | | | | | | +| (r+1) | ECNA | NBNA | HNNA | ENA | INA | GANA | GENA | UNA | | | | | | | | | | +| s | NHI_o | RLOS | old KSI ASME | | | old NCC | | | | | | | | | | | | +| (s+1) to (s+32) | old K ASME | | | | | | | | | | | | | | | | | +| (s+33) to (s+64) | old NH | | | | | | | | | | | | | | | | | +| w | Length of Voice Domain Preference and UE's Usage Setting | | | | | | | | | | | | | | | | | +| (w+1) to t | Voice Domain Preference and UE's Usage Setting | | | | | | | | | | | | | | | | | + +| | | | | | | | | | +|----------------|------------------------------------------------------------|-------|-------|-----------|-------------|-------|------------|------------| +| (t+1) to (t+2) | Length of UE Radio Capability for Paging information | | | | | | | | +| (t+3) to u | UE Radio Capability for Paging information | | | | | | | | +| (u+1) | Length of Extended Access Restriction Data | | | | | | | | +| (u+2) to v | Spare | Spare | Spare | NRU
NA | NRUS
RNA | NRNA | USSR
NA | NRSR
NA | +| (v+1) | Length of UE additional security capability | | | | | | | | +| (v+2) to x | UE additional security capability | | | | | | | | +| (x+1) | Length of UE NR security capability | | | | | | | | +| (x+2) to y | UE NR security capability | | | | | | | | +| (y+1) to (y+2) | Length of APN Rate Control Statuses | | | | | | | | +| (y+3) to l | APN Rate Control Status [1..z] | | | | | | | | +| (l+1) | Length of Core Network Restrictions | | | | | | | | +| (l+2) to (l+5) | Core Network Restrictions | | | | | | | | +| (l+6) | Length of UE Radio Capability ID | | | | | | | | +| (l+7) to z | UE Radio Capability ID | | | | | | | | +| a | Spare | Spare | Spare | Spare | Spare | Spare | Spare | ENSCT | +| (a+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.38-5: EPS Security Context and Quadruplets** + +If NHI (Next Hop Indicator), bit 5 of octet 5, is set to "1", then the optional parameters NH (Next Hop) and NCC (Next Hop Chaining Count) are both present, otherwise their octets are not present. + +The UE Radio Capability for Paging information is specified in the clause 9.2.1.98 of 3GPP TS 36.413 [10]. If Length of UE Radio Capability for Paging information is zero, then the UE Radio Capability for Paging information shall not be present. The old MME shall, when available, include UE Radio Capability for Paging information to the new MME in the Context Response or Forward Relocation Request message as specified in the clause 5.11.4 of 3GPP TS 23.401 [4]. If the RAT type is indicated by the new MME in the Context Request message, then the old MME shall include the UE Radio Capability for Paging for the corresponding RAT type, if available. + +The Extended Access Restriction Data is composed of NRSRNA (NR as Secondary RAT Not Allowed), USSRNA (Unlicensed Spectrum in the form of LAA or LWA/LWIP as Secondary RAT Not Allowed), NRNA (NR in 5GS Not Allowed), NRUSRNA (New Radio Unlicensed as Secondary RAT Not Allowed), and of NRUNA (NR-U in 5GS Not Allowed). + +NOTE 5: As specified in clause 4.11.1.2.1 of 3GPP TS 23.502 [83], NRSRNA can be provided via N26 during handover from 5GC to EPC in order to allow the MME to make appropriate handling, e.g. SGW selection based on access restriction, or whether or not to allocate resources for secondary RAT during inter RAT handover. + +The UE additional security capability coding is specified in clause 9.9.3.53 of 3GPP TS 24.301 [23]. If Length of UE additional security capability is zero, then the field UE additional security capability in octets "(v+2) to x" shall not be present. + +The UE NR security capability coding is specified in clause 9.11.3.54 of 3GPP TS 24.501 [87]. If Length of UE NR security capability is zero, then the field UE NR security capability in octets "(x+2) to y" shall not be present. + +The Core Network Restrictions coding is specified in clause 7.2.230 of 3GPP TS 29.272 [70]. If Length of Core Network Restrictions is zero, then the field of Core Network Restrictions in octets "(l+2) to (l+5)" shall not be present. + +The UE Radio Capability ID is specified in the clause 9.9.3.60 of 3GPP TS 24.301 [23]. If Length of UE Radio Capability ID is zero, then the UE Radio Capability ID shall not be present. When supporting the RACS feature, the old MME shall include the PLMN-assigned UE Radio Capability ID if available, otherwise it shall include the Manufacturer-assigned UE Radio Capability ID, to the new MME as specified in the clause 5.11.3a of 3GPP TS 23.401 [4]. + +NOTE 6: If the MME supports RACS and the MME detects that the selected PLMN during a service request procedure is different from the currently registered PLMN for the UE, the MME stores the UE Radio Capability ID of the newly selected PLMN in the MM context as described in clause 5.11.3a of 3GPP TS 23.401 [4], and provides this UE Radio Capability ID to the target MME during any subsequent inter-MME mobility. + +The EPS NAS Security Context Type (ENSCT) shall be encoded in bits 1 and 2 of octet 'a'. ENSCT indicates the type of the Key Set Identifier, see Table 8.38-6. For EPS NAS Security Context usage see e.g. clause 6.4 in 3GPP TS 33.401 [12]. Bits 3 to 8 of octet 'a' are spare and shall be set to '0' by the sender and ignored by the receiver. + +As depicted in Figure 8.38-6, the old MME will derive CK' and IK' from $K_{ASME}$ and transmit the CK' and IK' to the new SGSN. Authentication Quintuplets, if available, shall be transmitted to the SGSN if, and only if the MME received them from this SGSN earlier, according to 3GPP TS 33.401 [12] clause 6.1.5. An array of at most 5 Authentication Quintuplets may be included. The field 'Number of Quintuplets' shall be set to the value '0' if no Authentication Quintuplet is included (i.e. octets 'g+1 to h' are absent). An array of at most 5 Authentication Quadruplets may be included. The field 'Number of Quadruplets' shall be set to the value '0' if no Authentication Quadruplet is included (i.e. octets '40 to g' are absent). A key $K_{ASME}$ shall never be transmitted to an SGSN according to 3GPP TS 33.401 [12] clause 6.4. + +The Authentication Quintuplet and Authentication Quadruplet codings are specified in Figure 8.38-8 and Figure 8.38-9 respectively. + +The old SGSN/MME may deliver both Authentication Quadruplets and Authentication Quintuplets it holds to the peer combo node to optimize the procedure. + +NOTE 7: 3GPP TS 33.401 [12] states that "EPS authentication data shall not be forwarded from an MME towards an SGSN". The statement above assumes that the old MME can determine by local configuration that the peer node is a combo SGSN/MME (as opposed to a single SGSN). + +| Octets | Bits | | | | | | | | | | | | | +|----------------|------------------------------------------------------------|------|----------------------|-----|----------|---------------------|------------|-----|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | +| 1 | Type = 108 (decimal) | | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | | +| 5 | Security Mode | | Spare | | DRXI | KSI ASME | | | | | | | | +| 6 | Number of Quintuplets | | Number of Quadruplet | | | UAMB
RI | SAMB
RI | | | | | | | +| 7 | Spare | | | | | | | | | | | | | +| 8 to 23 | CK | | | | | | | | | | | | | +| 24 to 39 | IK | | | | | | | | | | | | | +| 40 to g | Authentication Quadruplet [1..5] | | | | | | | | | | | | | +| (g+1) to h | Authentication Quintuplet [1..5] | | | | | | | | | | | | | +| (h+1) to (h+2) | DRX parameter | | | | | | | | | | | | | +| j to (j+3) | Uplink Subscribed UE AMBR | | | | | | | | | | | | | +| (j+4) to (j+7) | Downlink Subscribed UE AMBR | | | | | | | | | | | | | +| i to (i+3) | Uplink Used UE AMBR | | | | | | | | | | | | | +| (i+4) to (i+7) | Downlink Used UE AMBR | | | | | | | | | | | | | +| q | Length of UE Network Capability | | | | | | | | | | | | | +| (q+1) to k | UE Network Capability | | | | | | | | | | | | | +| k+1 | Length of MS Network Capability | | | | | | | | | | | | | +| (k+2) to m | MS Network Capability | | | | | | | | | | | | | +| m+1 | Length of Mobile Equipment Identity (MEI) | | | | | | | | | | | | | +| (m+2) to r | Mobile Equipment Identity (MEI) | | | | | | | | | | | | | +| r+1 | ECNA | NBNA | HNNA | ENA | INA | GANA | GENA | UNA | | | | | | +| r+2 | Length of Voice Domain Preference and UE's Usage Setting | | | | | | | | | | | | | +| (r+3) to s | Voice Domain Preference and UE's Usage Setting | | | | | | | | | | | | | +| (s+1) to (s+2) | Length of APN Rate Control Statuses | | | | | | | | | | | | | +| (s+3) to l | APN Rate Control Status [0..z] | | | | | | | | | | | | | +| (l+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | | + +Figure 8.38-6: UMTS Key, Quadruplets and Quintuplets + +| Octets | Bits | | | | | | | | +|----------|------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 16 | RAND | | | | | | | | +| 17 to 20 | SRES | | | | | | | | +| 21 to 28 | Kc | | | | | | | | + +Figure 8.38-7: Authentication Triplet + +| Octets | Bits | | | | | | | | +|------------------|-------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 16 | RAND | | | | | | | | +| 17 | XRES Length | | | | | | | | +| 18 to m | XRES | | | | | | | | +| (m+1) to (m+16) | CK | | | | | | | | +| (m+17) to (m+32) | IK | | | | | | | | +| m+33 | AUTN Length | | | | | | | | +| (m+34) to n | AUTN | | | | | | | | + +Figure 8.38-8: Authentication Quintuplet + +| Octets | Bits | | | | | | | | +|-----------------|-------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 16 | RAND | | | | | | | | +| 17 | XRES Length | | | | | | | | +| 18 to k | XRES | | | | | | | | +| k+1 | AUTN Length | | | | | | | | +| (k+2) to m | AUTN | | | | | | | | +| (m+1) to (m+32) | K ASME | | | | | | | | + +Figure 8.38-9: Authentication Quadruplet + +| Octets | Bits | | | | | | | | +|------------------|----------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Length of APN Rate control status | | | | | | | | +| 3 to 4 | Length of APN | | | | | | | | +| 5 to k | APN | | | | | | | | +| (k+1) to (k+4) | Uplink number of packets allowed | | | | | | | | +| (k+5) to (k+8) | Number of additional exception reports | | | | | | | | +| (k+9) to (k+12) | Downlink number of packets allowed | | | | | | | | +| (k+13) to (k+20) | APN Rate Control Status validity Time | | | | | | | | + +Figure 8.38-10: APN Rate Control Status + +For the encoding of APN field see clause 8.6. + +Octets (k+13) to (k+20) (APN Rate Control Status validity Time) are coded as the time in seconds relative to 00:00:00 on 1 January 1900 (calculated as continuous time without leap seconds and traceable to a common time reference) where binary encoding of the integer part is in the 32 most significant bits and binary encoding of the fraction part in the 32 least significant bits. The fraction part is expressed with a granularity of $1/2^{32}$ second. + +**Table 8.38-1: Security Mode Values** + +| Security Type | Value (Decimal) | +|---------------------------------------|------------------------| +| GSM Key and Triplets | 0 | +| UMTS Key, Used Cipher and Quintuplets | 1 | +| GSM Key, Used Cipher and Quintuplets | 2 | +| UMTS Key and Quintuplets | 3 | +| EPS Security Context and Quadruplets | 4 | +| UMTS Key, Quadruplets and Quintuplets | 5 | +| | 6-7 | + +**Table 8.38-2: Used NAS Cipher Values** + +| Cipher Algorithm | Value (Decimal) | +|-------------------------|------------------------| +| No ciphering | 0 | +| 128-EEA1 | 1 | +| 128-EEA2 | 2 | +| 128-EEA3 | 3 | +| EEA4 | 4 | +| EEA5 | 5 | +| EEA6 | 6 | +| EEA7 | 7 | +| | 8-15 | + +**Table 8.38-3: Used Cipher Values** + +| Cipher Algorithm | Value (Decimal) | +|-------------------------|------------------------| +| No ciphering | 0 | +| GEA/1 | 1 | +| GEA/2 | 2 | +| GEA/3 | 3 | +| GEA/4 | 4 | +| GEA/5 | 5 | +| GEA/6 | 6 | +| GEA/7 | 7 | + +**Table 8.38-4: Used NAS integrity protection algorithm Values** + +| Integrity protection Algorithm | Value (Decimal) | +|---------------------------------------|------------------------| +| No integrity protection | 0 | +| 128-EIA1 | 1 | +| 128-EIA2 | 2 | +| 128-EIA3 | 3 | +| EIA4 | 4 | +| EIA5 | 5 | +| EIA6 | 6 | +| EIA7 | 7 | + +**Table 8.38-5: Used GPRS integrity protection algorithm Values** + +| Integrity protection Algorithm | Value (Decimal) | +|---------------------------------------|------------------------| +| No integrity protection | 0 | +| spare | 1 | +| spare | 2 | +| spare | 3 | +| GIA4 | 4 | +| GIA5 | 5 | +| spare | 6 | +| spare | 7 | + +**Table 8.38-6: EPS NAS Security Context Type (ENSCT) in bits 1 and 2 of octet 'a'** + +| EPS NAS Security Context Type | Value (binary) | +|----------------------------------------------------------|----------------| +| Reporting EPS NAS Security Context Type is not supported | '00' | +| Native EPS NAS Security Context | '01' | +| Mapped EPS NAS Security Context | '10' | +| Spare, for future use | '11' | + +## 8.39 PDN Connection + +The PDN connection is a grouped IE containing a number of other IEs and shall be coded as depicted in Table 8.39-1. + +The PDN Connection IE may be repeated within a message when more than one PDN Connection is required to be sent. If so, the repeated IEs shall have exactly the same Instance values to represent a list of grouped IEs. + +**Table 8.39-1: PDN Connection Grouped Type** + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|----------------------------|----------------|-------------| +| Octet 1 | PDN Connection IE Type = 109 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| NOTE: This table uses a 5-column format in order to match the format used in clauses of clause 7, where the usage of this IE is further detailed for each specific GTP message including it. | | | | | + +## 8.40 PDU Numbers + +The PDU Numbers information element contains the sequence number status corresponding to a Bearer context in the old SGSN. This information element shall be sent only when acknowledged peer-to-peer LLC operation is used for the Bearer context or when the "delivery order" QoS attribute is set in the Bearer context QoS profile. + +NSAPI identifies the Bearer context for which the PDU Number IE is intended. + +DL GTP-U Sequence Number is the number for the next downlink GTP-U T-PDU to be sent to the UE when "delivery order" is set. + +UL GTP-U Sequence Number is the number for the next uplink GTP-U T-PDU to be tunnelled to the S-GW when "delivery order" is set. + +The Send N-PDU Number is used only when acknowledged peer-to-peer LLC operation is used for the Bearer context. Send N-PDU Number is the N-PDU number to be assigned by SNDPCP to the next down link N-PDU received from the S-GW. + +The Receive N-PDU Number is used only when acknowledged peer-to-peer LLC operation is used for the Bearer context. The Receive N-PDU Number is the N-PDU number expected by SNDPCP from the next up link N-PDU to be received from the UE. + +The PDU Number IE will be repeated for each Bearer Context for which this IE is required. + +PDU Numbers IE is coded as depicted in Figure 8.40-1. + +| Octets | Bits | | | | | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 110 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Spare(0 0 0 0) | | | | NSAPI | | | | | | | | +| 6-7 | DL GTP-U Sequence Number | | | | | | | | | | | | +| 8-9 | UL GTP-U Sequence Number | | | | | | | | | | | | +| 10-11 | Send N-PDU Number | | | | | | | | | | | | +| 12-13 | Receive N-PDU Number | | | | | | | | | | | | +| 14 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.40-1: PDU Numbers + +## 8.41 Packet TMSI (P-TMSI) + +The P-TMSI, unambiguously associated with a given UE and routing area, is given by: + +| Octets | Bits | | | | | | | | | | | | +|------------|----------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 111 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to (n+4) | Packet TMSI (P-TMSI) | | | | | | | | | | | | +| | The P-TMSI is defined in 3GPP TS 23.003 [2]. | | | | | | | | | | | | + +Figure 8.41-1: Packet TMSI (P-TMSI) + +## 8.42 P-TMSI Signature + +The content and the coding of the P-TMSI Signature information element are defined in 3GPP TS 24.008 [5]. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 112 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | P-TMSI Signature | | | | | | | | + +Figure 8.42-1: P-TMSI Signature + +## 8.43 Hop Counter + +Where Intra Domain Connection of RAN Nodes to Multiple CN Node is applied, the Hop Counter may be used to prevent endless loops when relaying Identification Request messages and Context Request messages. The maximum value is operator specific and shall not be lower than 1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 113 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Hop Counter | | | | | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.43-1: Hop Counter + +## 8.44 UE Time Zone + +UE Time Zone is used to indicate the offset between universal time and local time in steps of 15 minutes of where the UE currently resides. The "Time Zone" field uses the same format as the "Time Zone" IE in 3GPP TS 24.008 [5]. + +UE Time Zone is coded as this is depicted in Figure 8.44-1. The value of the Time Zone field represents the time zone adjusted for daylight saving time. The value of the Daylight Saving Time field specifies the adjustment that has been made. + +The spare bits indicate unused bits, which shall be set to 0 by the sending side and which shall not be evaluated by the receiving side. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|----------------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 114 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Time Zone | | | | | | | | +| 6 | Spare | | | | | | Daylight Saving Time | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.44-1: UE Time Zone + +Table 8.44-2 Possible values for the "Daylight Saving Time" field and their meanings. + +| Daylight Saving Time | Value (binary) | | +|----------------------------------------------|----------------|-------| +| | Bit 2 | Bit 1 | +| No adjustment for Daylight Saving Time | 0 | 0 | +| +1 hour adjustment for Daylight Saving Time | 0 | 1 | +| +2 hours adjustment for Daylight Saving Time | 1 | 0 | +| Spare | 1 | 1 | + +## 8.45 Trace Reference + +Trace Reference shall be coded as depicted in Figure 8.45-1. See 3GPP TS 32.422 [18], clause 5.6, for the definition of Trace Reference. + +See 3GPP TS 24.008 [5], clause 10.5.1.4, Mobile Identity, for the coding of MCC and MNC, whose values are obtained from the serving PLMN that the EM/NM is managing. If MNC is 2 digits long, bits 5 to 8 of octet 6 are coded as "1111". + +| Octets | Bits | | | | | | | | +|---------|----------------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 115 (decimal) | | | | | | | | +| 2 to 3 | Length = 6 | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | MCC digit 2 | | | | MCC digit 1 | | | | +| 6 | MNC digit 3 | | | | MNC digit 2 | | | | +| 7 | MNC digit 2 | | | | MNC digit 1 | | | | +| 8 to 10 | Trace ID | | | | | | | | + +Figure 8.45-1: Trace Reference + +## 8.46 Complete Request Message + +The Complete Request Message is coded as depicted in Figure 8.46-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|-------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 116 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Complete Request Message Type | | | | | | | | | | | | +| 6 to (n+4) | Complete Request Message | | | | | | | | | | | | + +Figure 8.46-1: Complete Request Message + +Complete Request Message type values are specified in Table 8.46-1. + +**Table 8.46-1: Complete Request Message type values and their meanings** + +| Location Types | Values (Decimal) | +|---------------------------------|------------------| +| Complete Attach Request Message | 0 | +| Complete TAU Request Message | 1 | +| | 2-255 | + +## 8.47 GUTI + +The GUTI is coded as depicted in Figure 8.47-1. + +| Octets | Bits | | | | | | | | | | | | +|-------------|----------------------|---|---|---|-------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 117 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | MCC digit 2 | | | | MCC digit 1 | | | | | | | | +| 6 | MNC digit 3 | | | | MNC digit 2 | | | | | | | | +| 7 | MNC digit 1 | | | | | | | | | | | | +| 8 to 9 | MME Group ID | | | | | | | | | | | | +| 10 | MME Code | | | | | | | | | | | | +| 11 to (n+4) | M-TMSI | | | | | | | | | | | | + +**Figure 8.47-1: GUTI** + +If an Administration decides to include only two digits in the MNC, then bits 5 to 8 of octet 6 are coded as "1111". + +The "MME Group ID", "MME Code" and "M-TMSI" are specified in 3GPP TS 23.003 [2]. + +## 8.48 Fully Qualified Container (F-Container) + +Fully Qualified Container (F-Container) is coded as depicted in Figure 8.48-1. + +All Spare bits are set to zeros by the sender and ignored by the receiver. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 118 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | Container Type | | | | +| 6 to (n+4) | F-Container field | | | | | | | | + +**Figure 8.48-1: Full Qualified Container (F-Container)** + +The F-Container field shall contain one of the following information, depending of the contents of the container transported by the specific GTP Information Element: + +- *transparent copy* of the corresponding IEs (see clause 8.2.2): + - the "Source to Target Transparent Container" or the "Target to Source Transparent Container" as specified in 3GPP TS 25.413 [33]; or + - the "SON Configuration Transfer" as specified in 3GPP TS 36.413 [10] or "EN-DC SON Configuration Transfer" as specified in 3GPP TS 36.413 [10]; or + - the "Inter-system SON Configuration Transfer" as specified in 3GPP TS 36.413 [10] and 3GPP TS 38.413 [84]; or + - the "eNB Status Transfer Transparent Container" or eNB Early Status Transfer Transparent Container as specified in 3GPP TS 36.413 [10]; or + - "Source BSS to Target BSS Transparent Container" or "Target BSS to Source BSS Transparent Container" as specified in 3GPP TS 48.018 [34] or 3GPP TS 25.413 [33], which contains the value part of the "Source BSS + +to Target BSS Transparent Container" IE or the value part of the "Target BSS to Source BSS Transparent Container" IE defined in 3GPP TS 48.018 [34], i.e. octets 3 to n, excluding octet 1 (Element ID) and octet 2, 2a (Length); or + +- *transparent copy* of the value part of the "NBIFOM Container" as specified in 3GPP TS 24.161 [73]. +- *transparent copy* of the octets of the encoded OCTET STRING of the "Source to Target Transparent Container" or the "Target to Source Transparent Container" specified in 3GPP TS 36.413 [10] and 3GPP TS 38.413 [84]; or +- *transparent copy* of the BSSGP RIM PDU as specified in 3GPP TS 48.018 [34]; or +- the Packet Flow ID, Radio Priority, SAPI, PS Handover XID parameters as specified in figure 8.42-2. + +NOTE 1: Annex B.2 provides further details on the encoding of Generic Transparent Containers over RANAP, S1-AP and GTP. See also Annex C of 3GPP TS 36.413 [10] for further details on how the MME constructs the F-Container field from the Source to Target Transparent Container or Target to Source Transparent Container IEs received from S1-AP. + +Container Type values are specified in Table 8.48-2. + +**Table 8.48-2: Container Type values** + +| Container Types | Values (Decimal) | +|-------------------------------|------------------| +| Reserved | 0 | +| UTRAN Transparent Container | 1 | +| BSS Container | 2 | +| E-UTRAN Transparent Container | 3 | +| NBIFOM Container | 4 | +| EN-DC Container | 5 | +| Inter-System SON Container | 6 | +| | 7-255 | + +NOTE 2: For any other new future F-Container content types, new Container Type values may be needed, although use of RAT agnostic containers should be used whenever possible. + +The BSS Container IE in the Bearer Context IE in Forward Relocation Request and Context Response messages is coded as depicted in Figure 8.48-3. + +| Octets | Bits | | | | | | | | | | | | | +|--------|-----------------------|---|---|-------|-----|----------------|----|-----|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | +| 6 | Spare | | | | PHX | SAPI | RP | PFI | | | | | | +| a | Packet Flow ID | | | | | | | | | | | | | +| b | SAPI | | | Spare | | Radio Priority | | | | | | | | +| c | XiD parameters length | | | | | | | | | | | | | +| d to n | XiD parameters | | | | | | | | | | | | | + +**Figure 8.48-3: BSS Container** + +The flags PFI, RP, SAPI and PHX in octet 6 indicate the corresponding type of parameter (Packet FlowID, Radio Priority, SAPI and PS handover XID parameters) shall be present in a respective field or not. If one of these flags is set to "0", the corresponding field shall not be present at all. The Spare bit shall be set to zero by the sender and ignored by the receiver. + +If PFI flag is set, Packet Flow ID shall be present in Octet a. + +If RP flag is set, Radio Priority shall be present in Octet b. + +If SAPI flag is set, SAPI shall be present in Octet b. + +If PHX flag is set: + +- XiD parameters length is present in Octet c. +- XiD parameters are present in Octet d to n. + +## 8.49 Fully Qualified Cause (F-Cause) + +Fully Qualified Cause (F- Cause) is coded as depicted in Figure 8.49-1. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 119 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | Cause Type | | | | +| 6 to (n+4) | F-Cause field | | | | | | | | + +**Figure 8.49-1: Full Qualified Cause (F-Cause)** + +The value of Instance field of the F-Cause IE in a GTPv2 message shall indicate whether the F-Cause field contains RANAP Cause, BSSGP Cause or S1-AP Cause. + +All spare bits shall be set to zeros by the sender and ignored by the receiver. + +F-Cause field is coded as follows: + +- For RANAP Cause, the F-Cause field shall contain a non-transparent copy of the cause value of the corresponding IE (see clause 8.2.2), "Cause", as defined in clause 9.2.1.4 in 3GPP TS 25.413 [33]. Cause Type field shall be ignored by the receiver. The value of F-Cause field (which has a range of 1..512) is transferred over the Iu interface and encoded into two octet as binary integer. +- For BSSGP Cause, the F-Cause field shall contain a non-transparent copy of the cause value of the corresponding IE (see clause 8.2.2), "Cause", as defined in clause 11.3.8 in 3GPP TS 48.018 [34]. Cause Type field shall be ignored by the receiver. The value of F-Cause field (which has a range of 0..255) is transferred over the Gb interface and encoded into one octet as binary integer. +- For S1-AP Cause, the F-Cause field shall contain a non-transparent copy of the cause value of the corresponding IE (see clause 8.2.2), "Cause", as defined in clause 9.2.1.3 in 3GPP TS 36.413 [10]. Cause Type field shall contain the RAN Cause subcategory as specified in 3GPP TS 36.413 [10] and it shall be encoded as in Table 8.49-1. The value of F-Cause field (and the associated RAN cause subcategory) is transferred over the S1-AP interface and encoded into one octet as binary integer. + +**Table 8.49-1: Cause Type values and their meanings** + +| Cause Type | Values (Decimal) | +|---------------------|------------------| +| Radio Network Layer | 0 | +| Transport Layer | 1 | +| NAS | 2 | +| Protocol | 3 | +| Miscellaneous | 4 | +| | 5 to 15 | + +## 8.50 PLMN ID + +Octets 5-7 shall contain a non-transparent copy of the " PLMN Identity" parameter in 3GPP TS 36.413 [10]. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 120 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | PLMN ID | | | | | | | | + +**Figure 8.50-1: PLMN ID** + +The encoding of the PLMN ID field is shown in Figures 8.50-2 and 8.50-3. + +If three digits are included in the MNC, octets 5 to 7 shall be encoded as shown in Figure 8.50-2. + +| Octets | Bits | | | | | | | | +|--------|-------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 5 | MCC digit 2 | | | | MCC digit 1 | | | | +| 6 | MNC digit 1 | | | | MCC digit 3 | | | | +| 7 | MNC digit 3 | | | | MNC digit 2 | | | | + +Figure 8.50-2: PLMN ID Parameter with 3-digit MNC + +If only two digits are included in the MNC, octets 5 to 7 shall be encoded as shown in Figure 8.50-3 with bits 5 to 8 of octet 6 (MNC digit 3) coded as "1111". + +| Octets | Bits | | | | | | | | +|--------|-------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 5 | MCC digit 2 | | | | MCC digit 1 | | | | +| 6 | 1111 | | | | MCC digit 3 | | | | +| 7 | MNC digit 2 | | | | MNC digit 1 | | | | + +Figure 8.50-3: PLMN ID Parameter with 2-digit MNC + +NOTE: The encoding is different from elsewhere in this document and is specified according to 3GPP TS 36.413 [10]. + +## 8.51 Target Identification + +### 8.51.1 General + +The Target Identification information element is coded as depicted in Figure 8.51-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 121 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Target Type | | | | | | | | | | | | +| 6 to (n+4) | Target ID | | | | | | | | | | | | + +Figure 8.51-1: Target Identification + +Target Type values are specified in Table 8.51-1. + +Table 8.51-1: Target Type values and their meanings + +| Target Types | Values (Decimal) | +|--------------------------|------------------| +| RNC ID | 0 | +| Macro eNodeB ID | 1 | +| Cell Identifier | 2 | +| Home eNodeB ID | 3 | +| Extended Macro eNodeB ID | 4 | +| gNodeB ID | 5 | +| Macro ng-eNodeB ID | 6 | +| Extended ng-eNodeB ID | 7 | +| en-gNB ID | 8 | +| | 9 to 255 | + +### 8.51.2 RNC ID + +The Target Type is RNC ID for SRNS relocation procedure, handover to UTRAN and RAN Information Relay towards UTRAN or GERAN operating in GERAN Iu mode, and 5G-SRVCC from NG-RAN to UTRAN procedure. In this case the "Target ID" field shall contain a non-transparent copy of the corresponding IEs (see clause 8.2.2) and be encoded as + +specified in Figure 8.51-1a below. The "Target RNC-ID" part of the "Target ID" parameter is specified in 3GPP TS 25.413 [33] and 3GPP TS 38.413 [84]. + +NOTE 1: The ASN.1 parameter "Target ID" is forwarded non-transparently in order to maintain backward compatibility. + +NOTE 2: The preamble of the "Target RNC-ID" (numerical value of e.g. 0x20) shall not be included into octets 6 to (n+4). Also, the optional "iE-Extensions" parameter shall not be included into the GTP IE. + +| Octets | Bits | | | | | | | | | | | | +|------------|----------------------------|---|---|---|-------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 6 | MCC digit 2 | | | | MCC digit 1 | | | | | | | | +| 7 | MNC digit 3 | | | | MNC digit 2 | | | | | | | | +| 8 | MNC digit 2 | | | | MNC digit 1 | | | | | | | | +| 9 to 10 | LAC | | | | | | | | | | | | +| 11 | RAC (see NOTE 3) | | | | | | | | | | | | +| 12 to 13 | RNC-ID | | | | | | | | | | | | +| a to (a+1) | Extended RNC-ID (optional) | | | | | | | | | | | | + +**Figure 8.51-1a: Target ID for Type RNC ID** + +If only two digits are included in the MNC, then bits 5 to 8 of octet 7 (MNC digit 3) shall be coded as "1111". + +The location area code (LAC) consists of 2 octets. Bit 8 of octet 9 is the most significant bit and bit 1 of octet 10 is the least significant bit. The coding of the location area code is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +During a 5G-SRVCC Handover, the AMF does not receive the target RAC in the "Target RNC-ID" part of the "Target ID" IE of the Handover Required message (see clause 9.3.1.25 of 3GPP TS 38.413 [84]). The AMF should set the RAC to a default value, e.g. hexadecimal value 'FF'. The MME\_SRVCC shall ignore the received RAC value. + +The RNC-ID consists of 2 octets and contains 12 bits long value (see 3GPP TS 25.413 [7]). Bit 4 of octet 12 is the most significant bit and bit 1 of octet 13 is the least significant bit (bits 8 to 5 of octet 12 are set to 0). The coding of the RNC-ID is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +The Extended RNC-ID consists of 2 octets and contains 16 bits long value within the range 4096 to 65535. Bit 8 of octet a is the most significant bit and bit 1 of octet (a+1) is the least significant bit. The coding of the Extended RNC-ID is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. If the optional Extended RNC-ID is included, then the receiver shall ignore the RNC-ID. + +If the optional Extended RNC-ID is not included, then the length variable 'n' = 8 and the overall length of the IE is 13 octets. Otherwise, 'n' = 10 and the overall length of the IE is 15 octets. + +NOTE 3: In the "TargetRNC-ID" ASN.1 type definition in 3GPP TS 25.413 [7] the "RAC" parameter is marked as optional. RAC is however always available at an SGSN/MME when it sends the RAC in e.g. a GTPv2 Forward Relocation Request message. + +### 8.51.3 Macro eNodeB ID + +The Target Type is Macro eNodeB ID for: + +- handover to E-UTRAN Macro eNodeB; +- RAN Information Relay towards E-UTRAN; and +- a TNL address discovery response of a candidate en-gNB via the S1 interface or via inter-system signalling (see clauses 22.3.6.2 and 22.3.6.3 of 3GPP TS 36.300 [19]). + +In this case the Target ID field shall be coded as depicted in Figure 8.51-2. + +| Octets | Bits | | | | | | | | | | | | +|----------|--------------------------|---|---|---|-----------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 6 | MCC digit 2 | | | | MCC digit 1 | | | | | | | | +| 7 | MNC digit 3 | | | | MCC digit 3 | | | | | | | | +| 8 | MNC digit 2 | | | | MNC digit 1 | | | | | | | | +| 9 | Spare | | | | Macro eNodeB ID | | | | | | | | +| 10 to 11 | Macro eNodeB ID | | | | | | | | | | | | +| 12 to 13 | Tracking Area Code (TAC) | | | | | | | | | | | | + +**Figure 8.51-2: Target ID for Type Macro eNodeB** + +The Macro eNodeB ID consists of 20 bits. Bit 4 of Octet 9 is the most significant bit and bit 1 of Octet 11 is the least significant bit. The coding of the Macro eNodeB ID is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +### 8.51.4 Home eNodeB ID + +The Target Type is Home eNodeB ID for handover to E-UTRAN Home eNodeB. In this case the coding of the Target ID field shall be coded as depicted in Figure 8.51-3. + +| Octets | Bits | | | | | | | | | | | | +|----------|--------------------------|---|---|---|----------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 6 | MCC digit 2 | | | | MCC digit 1 | | | | | | | | +| 7 | MNC digit 3 | | | | MCC digit 3 | | | | | | | | +| 8 | MNC digit 2 | | | | MNC digit 1 | | | | | | | | +| 9 | Spare | | | | Home eNodeB ID | | | | | | | | +| 10 to 12 | Home eNodeB ID | | | | | | | | | | | | +| 13 to 14 | Tracking Area Code (TAC) | | | | | | | | | | | | + +**Figure 8.51-3: Target ID for Type Home eNodeB** + +The Home eNodeB ID consists of 28 bits. See 3GPP TS 36.413 [10]. Bit 4 of Octet 9 is the most significant bit and bit 1 of Octet 12 is the least significant bit. The coding of the Home eNodeB ID is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +### 8.51.5 Extended Macro eNodeB ID + +The Target Type is Extended Macro eNodeB ID for: + +- handover to E-UTRAN Macro eNodeB; +- RAN Information Relay towards E-UTRAN; and +- a TNL address discovery response of a candidate en-gNB via the S1 interface or via inter-system signalling (see clauses 22.3.6.2 and 22.3.6.3 of 3GPP TS 36.300 [19]). + +In this case the Target ID field shall be coded as depicted in Figure 8.51-4. + +| Octets | Bits | | | | | | | | | | | | | | | +|----------|--------------------------|-------|---|---|--------------------------|---|---|---|--|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | +| 6 | MCC digit 2 | | | | MCC digit 1 | | | | | | | | | | | +| 7 | MNC digit 3 | | | | MCC digit 3 | | | | | | | | | | | +| 8 | MNC digit 2 | | | | MNC digit 1 | | | | | | | | | | | +| 9 | SMeNB | Spare | | | Extended Macro eNodeB ID | | | | | | | | | | | +| 10 to 11 | Extended Macro eNodeB ID | | | | | | | | | | | | | | | +| 12 to 13 | Tracking Area Code (TAC) | | | | | | | | | | | | | | | + +**Figure 8.51-4: Target ID for Type Extended Macro eNodeB** + +The Extended Macro eNodeB ID consists of 21 bits. The coding of the Macro eNodeB ID is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +If the SMeNB flag is not set the Extended Macro eNodeB ID contains a Long Macro eNodeB ID with a length of 21 Bits. Bit 5 of Octet 9 is the most significant bit and bit 1 of Octet 11 is the least significant bit. + +If the SMeNB flag is set the Extended Macro eNodeB ID contains a Short Macro eNodeB ID with a length of 18 Bits. Bits 5 to 3 of Octet 9 shall be set to 0 by the sender and shall be ignored by the receiver. Bit 2 of Octet 9 is the most significant bit and bit 1 of Octet 11 is the least significant bit. + +## 8.51.6 Cell Identifier + +The Target Type is Cell Identifier for E-UTRAN handover to GERAN and RAN Information Relay towards GERAN. In this case the coding of the Target ID field shall be same as the Octets 3 to 10 of the Cell Identifier IEI in 3GPP TS 48.018 [34]. + +## 8.51.7 gNodeB ID + +The Target Type is gNodeB ID for an EPS to 5GS handover to a target gNodeB. In this case the coding of the Target ID field shall be coded as depicted in Figure 8.51.7-1. + +| Octets | Bits | | | | | | | | | | | | | | | | | | +|----------|------------------------------|---|------------------|---|-------------|---|---|---|--|--|--|--|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | | | | +| 6 | MCC digit 2 | | | | MCC digit 1 | | | | | | | | | | | | | | +| 7 | MNC digit 3 | | | | MNC digit 3 | | | | | | | | | | | | | | +| 8 | MNC digit 2 | | | | MNC digit 1 | | | | | | | | | | | | | | +| 9 | Spare | | gNodeB ID Length | | | | | | | | | | | | | | | | +| 10 to 13 | gNodeB ID | | | | | | | | | | | | | | | | | | +| 14 to 16 | 5GS Tracking Area Code (TAC) | | | | | | | | | | | | | | | | | | + +**Figure 8.51.7-1: Target ID for Type gNodeB ID** + +The gNodeB ID Length field, in bits 1 to 6 of octet 9, indicates the length of the gNodeB ID in number of bits. + +The gNodeB ID consists of 22 to 32 bits. The coding of the gNodeB ID is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. Bit 1 of Octet 13 is the least significant bit. The most significant bit is determined as follows: + +- if the gNodeB ID Length is 32, bit 8 of octet 10 is the most significant bit; +- if the gNodeB ID Length is 24, bit 8 of octet 11 is the most significant bit; all the bits of octet 10 shall be set to 0 by the sender and ignored by the receiver; +- if the gNodeB ID Length is between 22 and 31, other than 24, the most significant bit is the bit determined by the operation "gNodeB ID Length modulo 8", of octet 10 if the length is greater than 24, or of octet 11 if the length is smaller than 24. All the bits from bit 8 of octet 10 down to the most significant bit (excluded) shall be set to 0 by the sender and ignored by the receiver. + +The 5GS TAC consists of 3 octets. Bit 8 of Octet 14 is the most significant bit and bit 1 of octet 16 the least significant bit. The coding of the tracking area code is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +## 8.51.8 Macro ng-eNodeB ID + +The Target Type is Macro ng-eNodeB ID for an EPS to 5GS handover to a target Macro ng-eNodeB. In this case the coding of the Target ID field shall be coded as depicted in Figure 8.51.8-1. + +| Octets | Bits | | | | | | | | | | | | | | | | | | +|----------|------------------------------|---|-----------------|---|-------------|---|---|---|--|--|--|--|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | | | | +| 6 | MCC digit 2 | | | | MCC digit 1 | | | | | | | | | | | | | | +| 7 | MNC digit 3 | | | | MNC digit 3 | | | | | | | | | | | | | | +| 8 | MNC digit 2 | | | | MNC digit 1 | | | | | | | | | | | | | | +| 9 | Spare | | Macro eNodeB ID | | | | | | | | | | | | | | | | +| 10 to 11 | Macro ng-eNodeB ID | | | | | | | | | | | | | | | | | | +| 12 to 14 | 5GS Tracking Area Code (TAC) | | | | | | | | | | | | | | | | | | + +**Figure 8.51.8-1: Target ID for Type Macro ng-eNodeB** + +Octets 6 to 11 shall be encoded as specified for the Macro eNodeB (see Figure 8.51-2). + +The 5GS TAC consists of 3 octets. Bit 8 of Octet 12 is the most significant bit and bit 1 of octet 14 the least significant bit. The coding of the tracking area code is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +### 8.51.9 Extended Macro ng-eNodeB ID + +The Target Type is Extended Macro ng-eNodeB ID for an EPS to 5GS handover to a target Extended Macro ng-eNodeB. In this case the coding of the Target ID field shall be coded as depicted in Figure 8.51.9-1. + +| Octets | Bits | | | | | | | | | | | | | | | +|----------|------------------------------|-------|---|--------------------------|---|---|---|---|--|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | +| 6 | MCC digit 2 | | | MCC digit 1 | | | | | | | | | | | | +| 7 | MNC digit 3 | | | MCC digit 3 | | | | | | | | | | | | +| 8 | MNC digit 2 | | | MNC digit 1 | | | | | | | | | | | | +| 9 | SMeNB | Spare | | Extended Macro eNodeB ID | | | | | | | | | | | | +| 10 to 11 | Extended Macro ng-eNodeB ID | | | | | | | | | | | | | | | +| 12 to 14 | 5GS Tracking Area Code (TAC) | | | | | | | | | | | | | | | + +**Figure 8.51.9-1: Target ID for Type Extended Macro ng-eNodeB** + +Octets 6 to 11 shall be encoded as specified for the Extended Macro eNodeB (see Figure 8.51.4). + +The 5GS TAC consists of 3 octets. Bit 8 of Octet 12 is the most significant bit and bit 1 of octet 14 the least significant bit. The coding of the tracking area code is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +### 8.51.10 en-gNB ID + +The Target Type is an en-gNB ID for: + +- a TNL address discovery request of a candidate en-gNB via the S1 interface or via inter-system signalling (see clauses 22.3.6.2 and 22.3.6.3 of 3GPP TS 36.300 [19]). + +In this case, the Target ID field shall be coded as depicted in Figure 8.51.10-1. + +| Octets | Bits | | | | | | | | | | | | | | | | | | | +|------------|------------------------------|------|------------------|-------------|---|---|---|---|--|--|--|--|--|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | | | | | +| 6 | MCC digit 2 | | | MCC digit 1 | | | | | | | | | | | | | | | | +| 7 | MNC digit 3 | | | MCC digit 3 | | | | | | | | | | | | | | | | +| 8 | MNC digit 2 | | | MNC digit 1 | | | | | | | | | | | | | | | | +| 9 | 5TAC | ETAC | en-gNB ID Length | | | | | | | | | | | | | | | | | +| 10 to 13 | en-gNB ID | | | | | | | | | | | | | | | | | | | +| p to (p+1) | Tracking Area Code (TAC) | | | | | | | | | | | | | | | | | | | +| q to (q+2) | 5GS Tracking Area Code (TAC) | | | | | | | | | | | | | | | | | | | + +**Figure 8.51.10-1: Target ID for Type en-gNB ID** + +The en-gNB ID Length field, in bits 1 to 6 of octet 9, indicates the length of the en-gNB ID in number of bits. + +Bits 7 and 8 of octet 9 shall be encoded as follows: + +- Bit 7 - ETAC: when set to "1", octets p to (p+1) shall be present and encode a TAC (EPS); otherwise, octets p to (p+1) shall be absent. +- Bit 8 - 5TAC: when set to "1", octets q to (q+2) shall be present and encode a 5GS TAC; otherwise, octets q to (q+2) shall be absent. + +The en-gNB ID consists of 22 to 32 bits. The en-gNB ID shall be coded as the gNodeB ID field of the gNodeB ID in clause 8.51.7. + +When present, the TAC shall consist of 2 octets and shall be coded as the TAC field of the Macro eNodeB ID in clause 8.51.3. + +When present, the 5GS TAC shall consist of 3 octets and shall be coded as the 5GS TAC field of the gNodeB ID in ubclause 8.51.7. + +## 8.52 Void + +## 8.53 Packet Flow ID + +The Packet Flow Id information element contains the packet flow identifier assigned to an EPS Bearer context as identified by EPS Bearer ID. + +The spare bits 8 to 5 in octet 5 indicate unused bits, which shall be set to 0 by the sending side and which shall not be evaluated by the receiving side. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 123 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | EBI | | | | +| 6 to (n+4) | Packet Flow ID | | | | | | | | + +Figure 8.53-1: Packet Flow ID + +## 8.54 RAB Context + +The RAB Context shall be coded as is depicted in Figure 8.54-1. + +| Octets | Bits | | | | | | | | | | | | +|----------|--------------------------|-------|-------|-------|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 124 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = 9 | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | ULPSI | DLPSI | ULGSI | DLGSI | NSAPI | | | | | | | | +| 6 to 7 | DL GTP-U Sequence Number | | | | | | | | | | | | +| 8 to 9 | UL GTP-U Sequence Number | | | | | | | | | | | | +| 10 to 11 | DL PDCP Sequence Number | | | | | | | | | | | | +| 12 to 13 | UL PDCP Sequence Number | | | | | | | | | | | | + +Figure 8.54-1: RAB Context + +The RAB Context IE may be repeated within a message with exactly the same Type and Instance to represent a list. + +The RAB context information element contains sequence number status for one RAB in RNC, which corresponds to one PDP context. The RAB contexts are transferred between the RNCs via the SGSNs at inter SGSN hard handover. + +NSAPI identifies the PDP context and the associated RAB for which the RAB context IE is intended. + +The following bits within Octet 5 shall indicate: + +- Bit 8 – ULPSI (UL PDCP Sequence Number Indication): This bit shall be set to "1" if the UL PDCP Sequence Number is not received from the source RNC and the UL PDCP Sequence Number field shall be set to "0"; +- Bit 7 – DLPSI (DL PDCP Sequence Number Indication): This bit shall be set to "1" if the DL PDCP Sequence Number is not received from the source RNC and the DL PDCP Sequence Number field shall be set to "0"; +- Bit 6 – ULGSI (UL GTP-U Sequence Number Indication): This bit shall be set to "1" if the UL GTP-U Sequence Number is not received from the source RNC and the UL GTP-U Sequence Number field shall be set to "0"; +- Bit 5 – DLGSI (DL GTP-U Sequence Number Indication): This bit shall be set to "1" if the DL GTP-U Sequence Number is not received from the source RNC and the DL GTP-U Sequence Number field shall be set to "0". DL GTP-U Sequence Number is the number for the next downlink GTP-U T-PDU to be sent to the UE. + +UL GTP-U Sequence Number is the number for the next uplink GTP-U T-PDU to be tunnelled to the SGW. + +DL PDCP Sequence Number is the number for the next downlink PDCP-PDU to be sent to the UE. + +UL PDCP Sequence Number is the number for the next uplink PDCP-PDU to be received from the UE. + +## 8.55 Source RNC PDCP context info + +The purpose of the Source RNC PDCP context info IE is to transfer RNC PDCP context information from a source RNC to a target RNC during an SRNS relocation. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 125 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | RRC Container | | | | | | | | + +Figure 8.55-1: Source RNC PDCP context info + +## 8.56 Port Number + +Port Number is coded as depicted in Figure 8.56-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 126 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = 2 | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 6 | Port Number | | | | | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.56-1: Port Number + +## 8.57 APN Restriction + +The APN Restriction information element contains an unsigned integer value indicating the level of restriction imposed on EPS Bearer Contexts created to the associated APN. + +The APN Restriction IE is coded as depicted in Figure 8.57-1: + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 127 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Restriction Type value | | | | | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.57-1: APN Restriction Type Information Element + +An APN Restriction value may be configured for each APN in the PGW. It is used to determine, on a per UE basis, whether it is allowed to establish EPS bearers to other APNs. + +Table 8.57-1: Valid Combinations of APN Restriction + +| Maximum APN Restriction Value | Type of APN | Application Example | APN Restriction Value allowed to be established | +|-------------------------------|-------------------------------------|-------------------------------------|-------------------------------------------------| +| 0 | No Existing Contexts or Restriction | | All | +| 1 | Public-1 | MMS | 1, 2, 3 | +| 2 | Public-2 | Internet | 1, 2 | +| 3 | Private-1 | Corporate (e.g. who use MMS) | 1 | +| 4 | Private-2 | Corporate (e.g. who do not use MMS) | None | + +## 8.58 Selection Mode + +The Selection mode information element indicates the origin of the APN in the message. + +![](adeeb4d1a6c2e47321b8166cab396dea_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 128 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | Sele. Mode | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.58-1: Selection Mode Information Element + +Table 8.58-1: Selection Mode Values + +| Selection mode value | Value (Decimal) | +|----------------------------------------------------------------------------------------|-----------------| +| MS or network provided APN, subscription verified | 0 | +| MS provided APN, subscription not verified | 1 | +| Network provided APN, subscription not verified | 2 | +| For future use. Shall not be sent. If received, shall be interpreted as the value "2". | 3 | + +## 8.59 Source Identification + +The Source Identification information element is coded as depicted in Figure 8.59-1. + +![](8977040947701adcb87cbb816b50e8a6_img.jpg) + +| Octets | Bits | | | | | | | | +|-------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 129 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to 12 | Target Cell ID | | | | | | | | +| 13 | Source Type | | | | | | | | +| 14 to (n+4) | Source ID | | | | | | | | + +Figure 8.59-1: Source Identification + +The Target Cell ID shall be same as the Octets 3 to 10 of the Cell Identifier IEI in 3GPP TS 48.018 [34]. + +Source Type values are specified in Table 8.59-1. + +If the Source Type is Cell ID, this indicates PS handover from GERAN A/Gb mode. In this case the coding of the Source ID field shall be same as the Octets 3 to 10 of the Cell Identifier IEI in 3GPP TS 48.018 [34]. + +If the Source Type is RNC ID, this indicates PS handover from GERAN Iu mode or for inter-RAT handover from UTRAN. In this case the Source ID field shall include a transparent copy of the corresponding parameter (see clause 8.2.2), the Source RNC-ID as specified within the "Source ID" parameter in 3GPP TS 25.413 [33]. + +NOTE: In fact, the ASN.1/PER encoded binary value of the "Source RNC ID" shall be copied into octets 14 to (n+4). + +**Table 8.59-1: Source Type values and their meanings** + +| Source Types | Values (Decimal) | +|-----------------|------------------| +| Cell ID | 0 | +| RNC ID | 1 | +| reserved (NOTE) | 2 | +| | 3-255 | + +NOTE: This value was allocated in an earlier version of the protocol and shall not be used. + +## 8.60 Void + +## 8.61 Change Reporting Action + +Change Reporting Action IE is coded as depicted in Figure 8.61-1. + +![](6d7989325053731fda7ae4de0e946b24_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 131 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | Action | | | | | | | | + +**Figure 8.61-1: Change Reporting Action****Table 8.61-1: Action values** + +| Action | Value (Decimal) | +|-------------------------------------------------------------------|-----------------| +| Stop Reporting | 0 | +| Start Reporting CGI/SAI | 1 | +| Start Reporting RAI | 2 | +| Start Reporting TAI | 3 | +| Start Reporting ECGI | 4 | +| Start Reporting CGI/SAI and RAI | 5 | +| Start Reporting TAI and ECGI | 6 | +| Start Reporting Macro eNodeB ID and Extended Macro eNodeB ID | 7 | +| Start Reporting TAI, Macro eNodeB ID and Extended Macro eNodeB ID | 8 | +| | 9-255 | + +Stop Reporting stops all reporting action types. + +## 8.62 Fully qualified PDN Connection Set Identifier (FQ-CSID) + +A fully qualified PDN Connection Set Identifier (FQ-CSID) identifies a set of PDN connections belonging to an arbitrary number of UEs on a MME, SGW, TWAN, ePDG or PGW. The FQ-CSID is used on S5, S8, S2a, S2b and S11 interfaces. + +The size of CSID is two octets. The FQ-CSID is coded as follows: + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|--------------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 132 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Node-ID Type | | | | Number of CSIDs= m | | | | | | | | +| 6 to p | Node-ID | | | | | | | | | | | | +| (p+1) to (p+2) | First PDN Connection Set Identifier (CSID) | | | | | | | | | | | | +| (p+3) to (p+4) | Second PDN Connection Set Identifier (CSID) | | | | | | | | | | | | +| ... | ... | | | | | | | | | | | | +| q to q+1 | m-th PDN Connection Set Identifier (CSID) | | | | | | | | | | | | +| (q+2) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.62-1: FQ-CSID + +Where Node-ID Type values are: + +- 0 indicates that Node-ID is a global unicast IPv4 address and p = 9. +- 1 indicates that Node-ID is a global unicast IPv6 address and p = 21. +- 2 indicates that Node-ID is a 4 octets long field with a 32 bit value stored in network order, and p= 9. The coding of the field is specified below: + - Most significant 20 bits are the binary encoded value of (MCC \* 1000 + MNC). + - Least significant 12 bits is a 12 bit integer assigned by an operator to an MME, SGW, TWAN, ePDG or PGW. Other values of Node-ID Type are reserved. + +Values of Number of CSID other than 1 are only employed in the Delete PDN Connection Set Request. + +The node that creates the FQ-CSID, (i.e. MME for MME FQ-CSID, SGW for SGW FQ-CSID, TWAN for TWAN FQ-CSID, ePDG for ePDG FQ-CSID and PGW for PGW FQ-CSID), is responsible for making sure the Node-ID is globally unique and the CSID value is unique within that node. + +When a FQ-CSID is stored by a receiving node, it is stored on a PDN basis even for messages impacting only one bearer (i.e. Create Bearer Request). See 3GPP TS 23.007 [17] for further details on the CSID and what specific requirements are placed on the PGW, TWAN, ePDG, SGW and MME. + +## 8.63 Channel needed + +The Channel needed shall be coded as depicted in Figure 8.63-1. Channel needed is coded as the IEI part and the value part of the Channel Needed IE defined in 3GPP TS 44.018[28] + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 133 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | Channel Needed | | | | | | | | + +Figure 8.63-1: Channel needed + +## 8.64 eMLPP Priority + +The eMLPP-Priority shall be coded as depicted in Figure 8.64-1. The eMLPP Priority is coded as the value part of the eMLPP-Priority IE defined in 3GPP TS 48.008 [29] (not including 3GPP TS 48.008 IEI and 3GPP TS 48.008 [29] length indicator). + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 134 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | eMLPP-Priority | | | | | | | | + +Figure 8.64-1: eMLPP Priority + +The eMLPP Priority may be used to determine the required GTPv2 message priority of the GTPv2 message carrying this IE. + +## 8.65 Node Type + +Node Type is coded as this is depicted in Figure 8.65-1. + +| Octets | Bits | | | | | | | | | | | | +|---------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 135 (decimal) | | | | | | | | | | | | +| 2-3 | Length = n (decimal) | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Node Type | | | | | | | | | | | | +| 6-(n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.65-1: Node Type + +Node type values are specified in Table 8.65-1. + +Table 8.65-1: Node Type values + +| Node Types | Values (Decimal) | +|------------|------------------| +| MME | 0 | +| SGSN | 1 | +| | 2-255 | + +If with a Release Access Bearers Request, or Suspend Notification, or Resume an SGW receives a semantically erroneous/unexpected Originating Node, then the following applies: + +- If SGW has an active connection to an MME, but the Originating Node IE contains value "SGSN", then the SGW shall not release the user plane and shall send a response to the SGSN with some appropriate cause value. +- If SGW has an active connection to an S4-SGSN, but the Originating Node IE contains value "MME", then the SGW shall not release the user plane and shall send a response to the MME with some appropriate cause value. + +## 8.66 Fully Qualified Domain Name (FQDN) + +Fully Qualified Domain Name (FQDN) is coded as depicted in Figure 8.66-1. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 136 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | FQDN | | | | | | | | + +Figure 8.66-1: Fully Qualified Domain Name (FQDN) + +The FQDN field encoding shall be identical to the encoding of a FQDN within a DNS message of clause 3.1 of IETF RFC 1035 [31] but excluding the trailing zero byte. + +NOTE 1: The FQDN field in the IE is not encoded as a dotted string as commonly used in DNS master zone files. + +A "PGW node name" IE in S3/S10/S16/S5/S8 GTP messages shall be a PGW host name as per clause 4.3.2 of 3GPP TS 29.303 [32] when the PGW FQDN IE is populated from 3GPP TS 29.303 [32] procedures. Specifically, the + +first DNS label is either "topon" or "topoff", and the canonical node name of the PGW starts at the third label. The same rules apply to "SGW node name" IE on S3/S10/S16 and "SGW-U node name" IE on S5. + +NOTE 2: The constraint of clause 4.3.2 of 3GPP TS 29.303 format is on populating the IE by 3GPP nodes for 3GPP nodes, the receiver shall not reject an IE that is otherwise correctly formatted since the IE might be populated for a non-3GPP node. + +An "MME node name" IE and an "SGSN node name" IE in S3 GTP messages indicate the associated ISR node when the ISR becomes active. + +## 8.67 Private Extension + +Private Extension is coded as depicted in Figure 8.67-1. + +Enterprise ID can be found at IANA web site (). + +| Octets | Bits | | | | | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 255 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 6 | Enterprise ID | | | | | | | | | | | | +| 7 to (n+4) | Proprietary value | | | | | | | | | | | | + +Figure 8.67-1. Private Extension + +## 8.68 Transaction Identifier (TI) + +Transaction Identifier is coded as depicted in Figure 8.68-1. It is defined in 3GPP TS 24.301 [23], clause 9.9.4.17 and is coded as specified in 3GPP TS 24.007 [30], clause 11.2.3.1.3 Transaction identifier. + +| Octets | Bits | | | | | | | | +|------------|------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 137 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | Transaction Identifier | | | | | | | | + +Figure 8.68-1: Transaction Identifier + +## 8.69 MBMS Session Duration + +The MBMS Session Duration is defined in 3GPP TS 23.246 [37]. The MBMS Session Duration information element indicates the estimated session duration of the MBMS service data transmission if available. The payload shall be encoded as per the MBMS-Session-Duration AVP defined in 3GPP TS 29.061 [38], excluding the AVP Header fields (as defined in IETF RFC 3588 [39], clause 4.1). + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 138 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 7 | MBMS Session Duration | | | | | | | | | | | | +| 8 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.69-1: MBMS Session Duration + +## 8.70 MBMS Service Area + +The MBMS Service Area is defined in 3GPP TS 23.246 [37]. The MBMS Service Area information element indicates the area over which the Multimedia Broadcast Multicast Service is to be distributed. The payload shall be encoded as per the MBMS-Service-Area AVP defined in 3GPP TS 29.061 [38], excluding the AVP Header fields (as defined in IETF RFC 3588 [39], clause 4.1). + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 139 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | MBMS Service Area | | | | | | | | + +Figure 8.70-1: MBMS Service Area + +## 8.71 MBMS Session Identifier + +The MBMS Session Identifier information element contains a Session Identifier allocated by the BM-SC. The MBMS Session Identifier value part consists of 1 octet. The content and the coding are defined in 3GPP TS 29.061 [38]. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 140 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | MBMS Session Identifier | | | | | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.71-1: MBMS Session Identifier + +## 8.72 MBMS Flow Identifier + +The MBMS Flow Identifier is defined in 3GPP TS 23.246 [37]. In broadcast mode, the MBMS Flow Identifier information element is included in MBMS Session Management messages to differentiate the different sub-sessions of an MBMS user service (identified by the TMGI) providing location-dependent content. The payload shall be encoded as per the MBMS-Flow-Identifier AVP defined in 3GPP TS 29.061 [38], excluding the AVP Header fields (as defined in IETF RFC 3588 [39], clause 4.1). + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 141 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 6 | MBMS Flow Identifier | | | | | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.72-1: MBMS Flow Identifier + +## 8.73 MBMS IP Multicast Distribution + +The MBMS IP Multicast Distribution IE is sent by the MBMS GW to the MME/SGSN in the MBMS Session Start Request. Source Specific Multicasting is used according to IETF RFC 4607 [40]. + +The IP Multicast Distribution Address and the IP Multicast Source Address fields contain the IPv4 or IPv6 address. The Address Type and Address Length fields shall be included in each field: + +- The Address Type, which is a fixed length code (of 2 bits) identifying the type of address that is used in the Address field. +- The Address Length, which is a fixed length code (of 6 bits) identifying the length of the Address field. +- The Address, which is a variable length field shall contain either an IPv4 address or an IPv6 address. + +Address Type 0 and Address Length 4 shall be used when Address is an IPv4 address. + +Address Type 1 and Address Length 16 shall be used when Address is an IPv6 address. + +Other combinations of values are not valid. + +MBMS HC Indicator represents an indication if header compression should be used for MBMS user plane data, as specified in 3GPP TS 25.413 [33]. MBMS HC Indicator field is encoded as a one octet long enumeration. + +NOTE: Currently, 3GPP TS 25.413 [33] specifies two enumeration values: 0 (indicates "uncompressed-header") and 1 (indicates "compressed-header"). + +Common Tunnel Endpoint Identifier is allocated at the source Tunnel Endpoint and signalled to the destination Tunnel Endpoint. There is one Common Tunnel Endpoint Identifier allocated per MBMS bearer service. The recommendations on how to set the value of C-TEID are provided in 3GPP TS 23.246 [37]. + +| Octets | Bits | | | | | | | | | | | | | | | | | | | +|------------|------------------------------------------------------------|----------------|---|---|----------|---|---|---|--|--|--|--|--|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | | | | | | +| 1 | Type = 142 (decimal) | | | | | | | | | | | | | | | | | | | +| 2 to 3 | Length=n | | | | | | | | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | | | | | | | | +| 5 to 8 | Common Tunnel Endpoint Identifier | | | | | | | | | | | | | | | | | | | +| 9 | Address Type | Address Length | | | | | | | | | | | | | | | | | | +| 10 to K | IP Multicast Distribution Address (IPv4 or IPv6) | | | | | | | | | | | | | | | | | | | +| K+1 | Address Type | Address Length | | | | | | | | | | | | | | | | | | +| (k+2) to m | IP Multicast Source Address (IPv4 or IPv6) | | | | | | | | | | | | | | | | | | | +| m+1 | MBMS HC Indicator | | | | | | | | | | | | | | | | | | | +| (m+2) to n | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | | | | | | | | + +Figure 8.73-1: MBMS IP Multicast Distribution + +## 8.74 MBMS Distribution Acknowledge + +The MBMS Distribution Acknowledge IE is sent by the SGSN to the MBMS GW in the MBMS Session Start Response and MBMS Session Update Response. It is used by the MBMS GW to decide if an IP Multicast Distribution user plane shall be established, or a normal point-to-point user plane, or both. + +| Octets | Bits | | | | | | | | +|----------|------------------------------------------------------------|---|---|---|----------|---|-----------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 143 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | Distr Ind | | +| 6 to n+4 | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.74-1: MBMS Distribution Acknowledge + +Table 8.74-1: Distribution Indication values + +| Distribution Indication | Value (Decimal) | +|---------------------------------------------------|-----------------| +| No RNCs have accepted IP multicast distribution | 0 | +| All RNCs have accepted IP multicast distribution | 1 | +| Some RNCs have accepted IP multicast distribution | 2 | +| Spare. For future use. | 3 | + +## 8.75 User CSG Information (UCI) + +User CSG Information (UCI) is coded as depicted in Figure 8.75-1. The CSG ID is defined in 3GPP TS 23.003 [2]. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|-------|---|---|-------------|------|-----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 145 | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | MCC digit 2 | | | | MCC digit 1 | | | | +| 6 | MNC digit 3 | | | | MNC digit 3 | | | | +| 7 | MNC digit 2 | | | | MNC digit 1 | | | | +| 8 | spare | | | | CSG ID | | | | +| 9 to 11 | CSG ID | | | | | | | | +| 12 | Access mode | spare | | | | LCSG | CMI | | +| 13 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.75-1: User CSG Information + +For two digits in the MNC, bits 5 to 8 of octet 6 are coded as "1111". + +The CSG ID consists of 4 octets. Bit 3 of Octet 8 is the most significant bit and bit 1 of Octet 11 is the least significant bit. The coding of the CSG ID is the responsibility of the operator that allocates the CSG ID by administrative means. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +Access mode values are specified in Table 8.75-1. + +Table 8.75-1: Access mode values and their meanings + +| Access Mode | Values (Decimal) | +|-------------|------------------| +| Closed Mode | 0 | +| Hybrid Mode | 1 | +| Reserved | 2-3 | + +Leave CSG flag (LCSG) shall be set to "1" if UE leaves CSG cell/Hybrid cell, and in this case, the receiving node shall ignore the rest information in the IE. + +CSG Membership Indication (CMI) values are specified in Table 8.75-2. CMI shall be included in the User CSG Information if the Access mode is Hybrid Mode. For the other values of Access Mode, the CMI shall be set to 0 by the sender and ignored by the receiver. + +Table 8.75-2: CSG Membership indication (CMI) + +| CMI | Values (Decimal) | +|--------------------|------------------| +| Non CSG membership | 0 | +| CSG membership | 1 | + +NOTE: Due to a specification oversight, the CMI values in the above table are reversed from the values of the CMI IE (see clause 8.79). Furthermore, the encoding is different between GTPv1 and GTPv2. + +## 8.76 CSG Information Reporting Action + +CSG Information Reporting Action is coded as depicted in Figure 8.76-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|------------|------------|------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 146 | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | UCIU
HC | UCIS
HC | UCIC
SG | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.76-1: CSG Reporting Action + +The following bits within Octet 5 shall indicate: + +- Bit 1 – UCICSG: When set to "1", shall indicate to start reporting User CSG Info when the UE enters/leaves/access through the CSG Cell. +- Bit 2 – UCISHC: When set to "1", shall indicate to start reporting User CSG Info when the UE enters/leaves/access through Subscribed Hybrid Cell. +- Bit 3 – UCIUHC: When set to "1", shall indicate to start Reporting User CSG Info when the UE enters/leaves/access through Unsubscribed Hybrid Cell. + +All the bits 1 to 3 shall be set to 0 to stop reporting User CSG Info. + +## 8.77 RFSP Index + +Index to RAT/Frequency Selection Priority (RFSP Index) is coded as depicted in Figure 8.77-1, and contains a non-transparent copy of the corresponding IE (see clause 8.2.2), "Subscriber Profile ID for RAT/Frequency Priority (SPID)" as specified in 3GPP TS 36.413 [10]. The SPID is an integer between 1 and 256 and is encoded as an unsigned integer, which requires the two octets specified for the RFSP Index parameter. + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 144 (decimal) | | | | | | | | +| 2 to 3 | Length = 2 | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to 6 | RFSP Index | | | | | | | | + +Figure 8.77-1. RFSP Index + +## 8.78 CSG ID + +CSG ID is coded as depicted in Figure 8.78-1. The CSG ID is defined in 3GPP TS 23.003 [2]. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 147 | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Spare | | | | CSG ID | | | | | | | | +| 6 to 8 | CSG ID | | | | | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.78-1: CSG ID + +The CSG ID consists of 4 octets. Bit 3 of Octet 5 is the most significant bit and bit 1 of Octet 8 is the least significant bit. The coding of the CSG ID is the responsibility of the operator that allocates the CSG ID by administrative means. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +## 8.79 CSG Membership Indication (CMI) + +CSG Membership Indication is coded as depicted in Figure 8.79-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 148 | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | | CMI | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.79-1: CSG Membership Indication + +Table 8.79-1: void + +CSG Membership Indication (CMI) values are specified in Table 8.79-2. + +**Table 8.79-2: CSG Membership indication (CMI)** + +| CMI | Values (Decimal) | +|--------------------|------------------| +| CSG membership | 0 | +| Non CSG membership | 1 | + +NOTE: Due to a specification oversight, the CMI values in the above table are reversed from the values of the CSG-Membership-Indication AVP in 3GPP TS 32.299 [54], as well as from the values of the CMI in the UCI IE (see clause 8.75). Therefore, when the above CMI values are sent over the charging interface, the values are encoded as specified in 3GPP TS 32.299 [54]. + +## 8.80 Service indicator + +Service indicator is coded as depicted in Figure 8.80-1. + +![](8de50ab594c6c0e62405239e3d0c4a1c_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 149 (decimal) | | | | | | | | +| 2 to 3 | Length = 1 | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Service indicator | | | | | | | | + +**Figure 8.80-1. Service indicator** + +Service indicator values are specified in Table 8.80-1. + +**Table 8.80-1: Service indicator values** + +| Service indicator | Values (Decimal) | +|-------------------|------------------| +| | 0 | +| CS call indicator | 1 | +| SMS indicator | 2 | +| | 3-255 | + +## 8.81 Detach Type + +Detach Type is coded as depicted in Figure 8.81-1. + +![](172ff468eac72a2e1ec81d06fa3b96b1_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 150 (decimal) | | | | | | | | +| 2 to 3 | Length = 1 | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Detach Type | | | | | | | | + +**Figure 8.81-1: Detach Type****Table 8.81-1: Detach Type values** + +| Detach Types | Values (Decimal) | +|-----------------------|------------------| +| | 0 | +| PS Detach | 1 | +| Combined PS/CS Detach | 2 | +| | 3-255 | + +## 8.82 Local Distinguished Name (LDN) + +Represents the Local Distinguished Name (LDN) of the network element (see 3GPP TS 32.423 [44]). + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 151 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | LDN | | | | | | | | + +**Figure 8.82-1: Local Distinguished Name (LDN)** + +The LDN field consists of 1 up to a maximum of 400 ASCII characters, i.e., from 1 up to a maximum of 400 octets. + +### 8.83 Node Features + +Node Features IE is coded as depicted in Figure 8. 83-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 152 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Supported-Features | | | | | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +**Figure 8.83-1: Node Features IE** + +The Node Features IE takes the form of a bitmask where each bit set indicates that the corresponding feature is supported. Spare bits shall be ignored by the receiver. The same bitmask is defined for all GTPv2 interfaces. + +The following table specifies the features defined on GTPv2 interfaces and the interfaces on which they apply. + +**Table 8.83-1: Node Features on GTPv2 interfaces** + +| Feature Octet / Bit | Feature | Interface | Description | +|---------------------|---------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5/1 | PRN | S11, S4 | PGW Restart Notification.
If both the SGW and the MME/S4-SGSN support this feature, the SGW shall send PGW Restart Notification message to the MME/S4-SGSN when the SGW detects that the peer PGW has restarted, and the SGW may send PGW Restart Notification message when the SGW detects that the peer PGW has failed and not restarted, as specified in clause 7.9.5. | +| 5/2 | MABR | S11 | Modify Access Bearers Request.
If both the SGW and the MME support this feature, the MME may modify the S1-U bearers of all the PDN connections of the UE by sending a Modify Access Bearers Request message as specified in clause 7.2.24. | +| 5/3 | NTSR | S11/S4 | Network Triggered Service Restoration procedure.
If both the SGW and the MME/S4-SGSN support this feature (see 3GPP TS 23.007 [17]), the SGW shall send a Downlink Data Notification message including the IMSI to the MME/S4-SGSN on the TEID 0 as part of a network triggered service restoration procedure. | +| 5/4 | CIOT | S11/S4 | Cellular Internet Of Things.
Support of this feature may be indicated over the S11/S4 interface, from the SGW to the MME/SGSN. See NOTE 1.
If the SGW notifies the support of this feature over S11, it indicates to the MME that the SGW supports all the following CIoT features:
  • - EUTRAN-NB-IoT RAT type,
  • - Non-IP PDN type,
  • - S11-U tunneling,
  • - Serving PLMN Rate Control,
  • - MO Exception Data indication,
  • - Extended PCO
If the SGW notifies the support of this feature over S4, it indicates to the SGSN that the SGW supports the Non-IP PDN type. | +| 5/5 | S1UN | S11 | S1-U path failure notification feature.
The support of this feature may be indicated over the S11 interface, from the MME to the SGW. See clause 20.3 of 3GPP TS 23.007 [17]. | +| 5/6 | ETH | S11 | Ethernet PDN type
Support of this feature may be indicated over the S11 interface, from the SGW to the MME. | +| 5/7 | MTEDT | S11 | Support of MT-EDT
Support of this feature may be indicated over the S11 interface, from the SGW to the MME. | +| 5/8 | PSSET | S11 | Support of PGW-C/SMF Set

Support of this feature may be indicated over the S11 interface, from the SGW to the MME.

See clause 31 of 3GPP TS 23.007 [17]. | + +NOTE 1: An SGW does not need to know whether the MME/SGSN support the CIoT feature. + +Feature Octet / Bit: The octet and bit number within the Supported-Features IE, e.g. "5 / 1". + +Feature: A short name that can be used to refer to the octet / bit and to the feature. + +Interface: A list of applicable interfaces to the feature. + +Description: A clear textual description of the feature. + +No features have been defined on the following GTPv2 interfaces in this version of the specification: S2a, S2b, S5, S8, S10, S3, S16, Sv, S101, S121, Sm, Sn. + +## 8.84 MBMS Time to Data Transfer + +The MBMS Time to Data Transfer indicates the minimum time occurring between the transmission of the MBMS SESSION START REQUEST message and the actual start of the data transfer. It is coded as shown in figure 8.84-1. Octet 5 is coded as the value part of the Time to MBMS Data Transfer IE defined in 3GPP TS 48.018 [34] (not including the IEI and length indicator octets specified in 3GPP TS 48.018 [34]). + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 153 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | MBMS Time to Data Transfer value part | | | | | | | | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.84-1: MBMS Time to Data Transfer + +## 8.85 Throttling + +Throttling is coded as depicted in Figure 8.85-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|------------------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 154 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Throttling Delay Unit | | | | Throttling Delay Value | | | | | | | | +| 6 | Throttling Factor | | | | | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.85-1: Throttling + +Table 8.85.1: Throttling information element + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Throttling Delay (octet 5) | +| Bits 5 to 1 represent the binary coded timer value. | +| Bits 6 to 8 defines the timer unit for the timer as follows: | +| Bits | +| 8 7 6 | +| 0 0 0 value is incremented in multiples of 2 seconds | +| 0 0 1 value is incremented in multiples of 1 minute | +| 0 1 0 value is incremented in multiples of 10 minutes | +| 0 1 1 value is incremented in multiples of 1 hour | +| 1 0 0 value is incremented in multiples of 10 hours | +| 1 1 1 value indicates that the timer is deactivated. | +| Other values shall be interpreted as multiples of 1 minute. | +| Throttling Factor (octet 6) | +| The Throttling Factor indicates a percentage and may take binary coded integer values from and including 0 up to and including 100. Other values shall be considered as 0. | + +## 8.86 Allocation/Retention Priority (ARP) + +Allocation/Retention Priority (ARP) is coded as depicted in Figure 8.86-1. + +![](9d3809e32331234c2e4d0a77622834e1_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-----|----|---|----------|-------|-----|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 155 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | PCI | PL | | | Spare | PVI | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.86-1: Allocation/Retention Priority (ARP)** + +The meaning and value range of the parameters within the ARP are defined in 3GPP TS 29.212 [29]. The bits within the octet 5 are: + +- Bit 1 – PVI (Pre-emption Vulnerability): See 3GPP TS 29.212[29], clause 5.3.47 Pre-emption-Vulnerability AVP. +- Bit 2 – spare +- Bits 3 to 6 – PL (Priority Level): See 3GPP TS 29.212[29], clause 5.3.45 Priority-Level AVP. PL encodes each priority level defined for the Priority-Level AVP as the binary value of the priority level. +- Bit 7 – PCI (Pre-emption Capability): See 3GPP TS 29.212[29], clause 5.3.46 Pre-emption-Capability AVP. +- Bit 8 – spare. + +## 8.87 EPC Timer + +The purpose of the EPC Timer information element is to specify EPC specific timer values. + +The EPC Timer information element is coded as shown in figure 8.87-1 and table 8.87.1 + +![](abd25ff60b59fa64f0bc0e5c6ba6e67e_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|-------------|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 156 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Timer unit | | | Timer value | | | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.87-1: EPC Timer** + +**Table 8.87.1: EPC Timer information element** + +| | +|---------------------------------------------------------------------------------------------------------------------| +| Timer value | +| Bits 5 to 1 represent the binary coded timer value. | +| Timer unit | +| Bits 6 to 8 defines the timer value unit for the EPC timer as follows: | +| Bits | +| 8 7 6 | +| 0 0 0 value is incremented in multiples of 2 seconds | +| 0 0 1 value is incremented in multiples of 1 minute | +| 0 1 0 value is incremented in multiples of 10 minutes | +| 0 1 1 value is incremented in multiples of 1 hour | +| 1 0 0 value is incremented in multiples of 10 hours | +| 1 1 1 value indicates that the timer is infinite | +| Other values shall be interpreted as multiples of 1 minute in this version of the protocol. | +| Timer unit and Timer value both set to all "zeros" shall be interpreted as an indication that the timer is stopped. | + +## 8.88 Signalling Priority Indication + +The Signalling Priority Indication information element contains signalling priority indications received from the UE for a specific PDN connection. + +The Signalling Priority Indication information element is coded as shown in figure 8.88-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 157 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | | LAPI | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.88-1: Signalling Priority Indication** + +The following bits within Octet 5 shall indicate: + +- Bit 8 to 2 – Spare, for future use and set to zero. +- Bit 1 – LAPI (Low Access Priority Indication): This bit defines if the UE indicated low access priority when establishing the PDN connection. It shall be encoded as the Low Priority parameter of the Device Properties IE in 3GPP TS 24.008 [5]. The receiver shall assume the value "0" if the Signalling Priority Indication IE is applicable for a message but not included in that message by the sender. The low access priority indication may be included in charging records. + +## 8.89 Temporary Mobile Group Identity (TMGI) + +The TMGI contains the Temporary Mobile Group Identity allocated to the MBMS Bearer Service. The BM-SC always includes the MCC and MNC when allocating the TMGI, see 3GPP TS 29.061 [38]. + +It is coded as specified in Figure 8.89-1. + +| Octets | Bits | | | | | | | | | | | | +|----------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 158 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5-10 | TMGI | | | | | | | | | | | | +| 11-(n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +**Figure 8.89-1: TMGI** + +Octets 5 to 10 shall be encoded as octets 3 to octet 8 in the figure 10.5.154 of 3GPP TS 24.008 [5]. + +## 8.90 Additional MM context for SRVCC + +The additional MM Context for SRVCC information element contains mobile station classmarks, supported codec list that are necessary for the AMF/MME/S4-SGSN to perform SRVCC as defined in 3GPP TS 23.216 [43]. The coding of Mobile Station Classmarks and Supported Codec List fields include the IE value part as it is specified in 3GPP TS 24.008 [5]. + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 159 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Length of the Mobile Station Classmark 2 | | | | | | | | | | | | +| 6 to a | Mobile Station Classmark 2 | | | | | | | | | | | | +| b | Length of the Mobile Station Classmark 3 | | | | | | | | | | | | +| (b+1) to c | Mobile Station Classmark 3 | | | | | | | | | | | | +| d | Length of the Supported Codec List | | | | | | | | | | | | +| (d+1) to e | Supported Codec List | | | | | | | | | | | | +| (e+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.90-1: Additional MM context for SRVCC + +For each of the Mobile Station Classmark 2, Mobile Station Classmark 3 and Supported Codec List parameters, if they are not available, then the associated length field shall be set to zero, and the particular parameter field shall not be present. + +## 8.91 Additional flags for SRVCC + +Additional flags for SRVCC is coded as depicted in Figure 8.91-1. + +| Octets | Bits | | | | | | | | +|---------|------------------------------------------------------------|---|---|---|----------|---|----|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 160 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | VF | ICS | +| 6-(n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.91-1: Additional flags for SRVCC + +The following bits within Octet 5 indicate: + +- Bit 1 – ICS (IMS Centralized Service): This flag indicates that UE supports ICS specific service as specified in 3GPP TS 23.292 [47]. +- Bit 2 – VF (vSRVCC Flag): This flag indicates that the user is subscribed to the vSRVCC. + +## 8.92 Void + +## 8.93 MDT Configuration + +MDT Configuration is coded as depicted in Figure 8.93-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|-----|-----|-----------|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 162 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Job Type | | | | | | | | | | | | +| 6 to 9 | List of Measurements | | | | | | | | | | | | +| 10 | Reporting Trigger | | | | | | | | | | | | +| 11 | Report Interval | | | | | | | | | | | | +| 12 | Report Amount | | | | | | | | | | | | +| 13 | Event Threshold for RSRP | | | | | | | | | | | | +| 14 | Event Threshold for RSRQ | | | | | | | | | | | | +| 15 | Length of Area Scope | | | | | | | | | | | | +| p to q | Area Scope | | | | | | | | | | | | +| s | Spare | | | | PLI | PMI | MPI | CRR
MI | | | | | +| u | Collection period for RRM measurements LTE | | | | | | | | | | | | +| v | Measurement Period LTE | | | | | | | | | | | | +| w | Positioning Method | | | | | | | | | | | | +| x | Number of MDT PLMNs | | | | | | | | | | | | +| y to z | MDT PLMN List | | | | | | | | | | | | +| r to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.93-1: MDT Configuration + +Parameters in octets 5 to 14, p to q, u, v, w and y to z shall be encoded as specified in 3GPP TS 32.422 [18]. If Length of Area Scope equals zero, then Area Scope octets p to q shall not be present. + +If CRRMI (Collection period for RRM measurements LTE Indicator), bit 1 of octet 's', is set to "1", then the Collection period for RRM measurements LTE parameter field shall be present, otherwise octet 'u' shall not be present. + +If MPI (Measurement period LTE Indicator), bit 2 of octet 's', is set to "1", then the Measurement period LTE parameter field shall be present, otherwise octet 'v' shall not be present. + +If PMI (Positioning Method Indicator), bit 3 of octet 's', is set to "1", then the Positioning Method parameter field shall be present, otherwise octet 'w' shall not be present. + +If PLI (PLMN List Indicator), bit 4 of octet 's', is set to "1", then the Number of MDT PLMNs and MDT PLMN List parameters shall be present, otherwise octet 'x' and octets 'y to z' shall not be present. + +The value of the Number of MDT PLMNs represents the number of 3-octet PLMNs contained within the MDT PLMN List parameter and shall be a number from 1 to 16. Each PLMN ID in the list shall be encoded as defined for octets 5 to 7 in clause 8.18. + +## 8.94 Additional Protocol Configuration Options (APCO) + +The Additional Protocol Configuration Options (APCO) information element is used to exchange additional protocol configuration options between the TWAN/ePDG and the PGW. + +The Additional Protocol Configuration Options information element is specified in 3GPP TS 29.275 [26] and its GTPv2 coding is shown in figure 8.94-1. + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 163 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to m | Additional Protocol Configuration Options (APCO) | | | | | | | | | | | | +| (m+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.94-1: Additional Protocol Configuration Options + +Octets (5 to m) of the Additional Protocol Configuration Options IE are encoded as specified in 3GPP TS 29.275 [26]. + +## 8.95 Absolute Time of MBMS Data Transfer + +The Absolute Time of MBMS Data Transfer indicates the absolute time of the actual start, update or stop of the MBMS data transfer to ensure a synchronized session control and facilitate a graceful reallocation of resources for the MBSFN (MBMS Single Frequency Network) when needed for E-UTRAN access. + +It is coded as shown in figure 8.95-1. + +| Octets | Bits | | | | | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 164 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 12 | Absolute Time of MBMS Data Transfer value part | | | | | | | | | | | | +| 13 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.95-1: Absolute Time of MBMS Data Transfer + +Octets 5 to 12 are coded as the time in seconds relative to 00:00:00 on 1 January 1900 (calculated as continuous time without leap seconds and traceable to a common time reference) where binary encoding of the integer part is in the 32 most significant bits and binary encoding of the fraction part in the 32 least significant bits. The fraction part is expressed with a granularity of $1/2^{32}$ second. + +## 8.96 H(e)NB Information Reporting + +H(e)NB number Information Reporting is coded as depicted in Figure 8.96-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 165 | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | | FTI | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.96-1: H(e)NB Information Reporting + +The following bits within Octet 5 shall indicate: + +- Bit 1 – FTI: When set to "1", shall indicate to start reporting H(e)NB local IP address and UDP port number information change when the UE moves from (e)NB to H(e)NB, from H(e)NB to another H(e)NB with a fixed network backhaul change, or from H(e)NB to (e)NB. + +The bit 1 shall be set to 0 to stop reporting H(e)NB local IP address and UDP port number information change. + +## 8.97 IPv4 Configuration Parameters (IP4CP) + +The IPv4 Configuration Parameters (IP4CP) is coded as depicted in Figure 8.97-1. + +| Octets | Bits | | | | | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 166 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Subnet Prefix Length | | | | | | | | | | | | +| 6 to 9 | IPv4 Default Router Address | | | | | | | | | | | | +| 10 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.97-1: IPv4 Configuration Parameters (IP4CP) + +## 8.98 Change to Report Flags + +Change to Report Flags IE is coded as depicted in Figure 8.98-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 167 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | TZCR | SNCR | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.98-1: Change to Report Flags + +For each message the applicable flags of the Change to Report Flags IE shall be clearly specified in the individual message clause. The remaining flags of the Change to Report Flags IE not so indicated shall be discarded by the receiver. + +The receiver shall consider the value of the applicable flags as "0", if the Change to Report Flags IE is applicable for the message but not included in the message by the sender. + +The following bits within Octet 5 shall indicate: + +- Bit 8 to 3 – Spare, for future use and set to zero. +- Bit 2 – TZCR (Time Zone Change to Report): When set to 1, this bit indicates that a UE Time Zone change still needs to be reported to the SGW/PGW. +- Bit 1 – SNCR (Serving Network Change to Report): When set to 1, this bit indicates that a Serving Network change still need to be reported to the SGW/PGW. + +## 8.99 Action Indication + +Action Indication is coded as depicted in Figure 8.99-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|------------|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 168 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | Indication | | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.99-1: Action Indication + +Table 8.99-1: Indication + +| Indication | Values (Decimal) | +|-------------------------|------------------| +| No Action | 0 | +| Deactivation Indication | 1 | +| Paging Indication | 2 | +| Paging Stop Indication | 3 | +| | 4 to 7 | + +If "deactivation indication" is set, it indicates that the receiving entity shall deactivate ISR and remove the UE resource locally as specified in 3GPP TS 23.007 [17] clause 27.3.1.2. + +If "paging indication" is set, it indicates that the receiving entity shall page the IDLE state UE as specified in 3GPP TS 23.007 [17] clause 27.3.2.2. + +If "paging stop indication" is set, it indicates that the receiving entity shall stop paging the UE as specified in 3GPP TS 23.380 [61] clause 5.4.2.1 and clause 5.4.3.2. + +## 8.100 TWAN Identifier + +The TWAN Identifier is used for reporting UE location in a Trusted WLAN Access Network (TWAN). See 3GPP TS 23.402 [45]. + +TWAN Identifier shall be coded as depicted in Figure 8.100-1. + +![](a01025ddfe10b3070f348bbedf8244db_img.jpg) + +| Octets | Bits | | | | | | | | +|-------------------|------------------------------------------------------------|---|------|-----------|-----------|-------|-------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 169 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | LAII | OPN
AI | PLM
NI | CIVAI | BSSID | | +| 6 | SSID Length | | | | | | | | +| 7 to k | SSID | | | | | | | | +| (k+1) to
(k+6) | BSSID | | | | | | | | +| q | Civic Address Length | | | | | | | | +| (q+1) to
(q+r) | Civic Address Information | | | | | | | | +| s to (s+2) | TWAN PLMN-ID | | | | | | | | +| t | TWAN Operator Name Length | | | | | | | | +| (t+1) to (t+u) | TWAN Operator Name | | | | | | | | +| v | Relay Identity Type | | | | | | | | +| (v+1) | Relay Identity Length | | | | | | | | +| (v+2) to
(v+w) | Relay Identity | | | | | | | | +| X | Circuit-ID Length | | | | | | | | +| (x+1) to
(x+y) | Circuit-ID | | | | | | | | +| p to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.100-1: TWAN Identifier** + +The BSSID and SSID shall be encoded as described in IEEE Std 802.11-2012 [52]. + +The TWAN identifier shall contain the SSID and, unless otherwise determined by the TWAN operator's policies, it shall contain at least the BSSID, the civic address of the access point to which the UE is attached or the Circuit-ID with the identity of the Relay (e.g. TWAG) which has allocated it (see clause 16.1.7 of 3GPP TS 23.402 [45]). It may also contain the identifier of the TWAN operator, i.e. either the TWAN PLMN-ID if the TWAN is operated by a mobile operator or the TWAN Operator Name otherwise. + +The SSID Length in octet '6' indicates the length of the SSID field. The SSID is an Octet String which shall have a maximum length of 32 octets (see IEEE Std 802.11-2012 [52]). + +The BSSID flag in octet 5 indicates whether the BSSID in octets 'k+1' to 'k+6' shall be present. If BSSID is set to '1', then the BSSID shall be present. If BSSID is set to '0', then the BSSID shall not be present. The BSSID is an Octet String which shall be 6 octets long (see IEEE Std 802.11-2012 [52]). + +The CIVAI flag in octet 5 indicates whether the Civic Address Length and Civic Address Information in octets 'q' and 'q+1' to 'q+r' shall be present. The Civic Address Length and Information shall be present if and only if the CIVAI flag is set to 1. When present, the Civic Address Information shall contain the civic address of the Access Point to which the UE is attached and it shall be encoded as defined in clause 3.1 of IETF RFC 4776 [59] excluding the first 3 octets. + +The PLMNI flag in octet 5 indicates whether the TWAN PLMN-ID in octets 's' to 's+2' shall be present. The TWAN PLMN-ID shall be present if and only if the PLMNI flag is set to 1. The TWAN PLMN-ID shall be encoded as octets 5 to 7 of the Serving Network IE in clause 8.18. When present, the TWAN PLMN-ID shall indicate the PLMN-ID of the TWAN operator. + +NOTE: the PLMN ID contained in the TWAN PLMN-ID can differ from the PLMN ID in the Serving Network IE. + +The OPNAI flag in octet 5 indicates whether the TWAN Operator Name Length and TWAN Operator Name in octets 't' and 't+1' to 't+u' shall be present. The TWAN Operator Name Length and TWAN Operator Name shall be present if and + +only if the OPNAI flag is set to 1. The TWAN Operator Name shall be encoded as specified in clause 19. 8 of 3GPP TS 23.003 [2]. When present, the TWAN Operator Name shall indicate the identifier of the TWAN operator. + +The LAII flag in octet 5 indicates whether the Logical Access ID information is present in the TWAN Identifier IE. The Logical Access ID is encoded by the Relay Identity information in octets 'v' to 'v+w' and the Circuit-ID information in octets 'x' to 'x+y'. The Relay Identity information and the Circuit-ID information shall be present if the LAII flag is set to '1'. The Relay indicates a DHCP relay agent as defined in IETF RFC 3046 [60]. The Relay Identity Type indicates the type of the Relay Identity as described in Table 8.100-1. The Relay Identity Length indicates the length of the Relay Identity. In case the Relay Identity Type indicates an IP address, the length indicates if it is IPv4 or IPv6 address of the Relay. The length is 4 octets for IPv4 and 16 octets for IPv6. If the Relay Identity type is set to 1 (i.e. an FQDN), it is encoded as described in clause 3.1 of IETF RFC 1035 [31] but excluding the trailing zero byte. The Circuit-ID length indicates the length of the Circuit-ID. The Circuit-ID is as defined in IETF RFC 3046 [60], it is encoded as an Octetstring and provided by the Relay. + +**Table 8.100-1: Relay Identity Type** + +| Relay Identity Type | Values (Decimal) | +|----------------------|------------------| +| IPv4 or IPv6 Address | 0 | +| FQDN | 1 | + +## 8.101 ULI Timestamp + +The ULI Timestamp IE is coded as shown in Figure 8.101-1. It indicates the UTC time when the user location information was acquired. Octets 5 to 8 are encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [53]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 170 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5-8 | ULI Timestamp value | | | | | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +**Figure 8.101-1: ULI Timestamp** + +## 8.102 MBMS Flags + +MBMS Flags is coded as depicted in Figure 8.102-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 171 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | LMRI | MSRI | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.102-1: MBMS Flags** + +The following bits within Octet 5 indicate: + +- Bit 1 – MSRI (MBMS Session Re-establishment Indication): if set to 1, this flag indicates that the MBMS Session Start Request message is used to re-establish an MBMS session (see 3GPP TS 23.007 [13]) +- Bit 2 – LMRI (Local MBMS Bearer Context Release Indication): if set to 1, this flag indicates that the MBMS Session Stop Request message is used to release the MBMS Bearer Context locally in the MME/SGSN (see 3GPP TS 23.007 [13]); + +- Bit 3 to 8 – Spare, for future use and set to zero. + +## 8.103 RAN/NAS Cause + +RAN/NAS Cause is coded as depicted in Figure 8.103-1. + +![](1665662b273f8ed3917945aee28d40ce_img.jpg) + +| Octets | Bits | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 172 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Protocol Type | | | | Cause Type | | | | +| 6 to m | Cause Value | | | | | | | | +| (m+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.103-1: RAN/NAS Cause** + +The Protocol Type field shall be encoded as per Table 8.103 -0: + +**Table 8.103-0: Protocol Type values** + +| Protocol Type | Values (Decimal) | +|----------------|------------------| +| S1AP Cause | 1 | +| EMM Cause | 2 | +| ESM Cause | 3 | +| Diameter Cause | 4 | +| IKEv2 Cause | 5 | +| | 6-15 | + +All spare bits shall be set to zeros by the sender and ignored by the receiver. + +The Cause Value field shall be coded as follows: + +- For S1-AP Cause, the Cause Value field shall contain a non-transparent copy of the cause value of the corresponding IE (see clause 8.2.2), "Cause", as defined in clause 9.2.1.3 in 3GPP TS 36.413 [10]. The Cause Type field shall contain the RAN Cause subcategory as specified in 3GPP TS 36.413 [10] and it shall be encoded as in Table 8.103-1. The value of the Cause Value field (and the associated RAN cause subcategory) is transferred over the S1-AP interface and encoded into one octet as binary integer. + +**Table 8.103-1: Cause Type values and their meanings** + +| Cause Type | Values (Decimal) | +|---------------------|------------------| +| Radio Network Layer | 0 | +| Transport Layer | 1 | +| NAS | 2 | +| Protocol | 3 | +| Miscellaneous | 4 | +| | 5 to 15 | + +- For EMM and ESM Causes, the Cause Value field shall contain the cause value as specified respectively for the "EMM Cause" IE and "ESM Cause" IE in clauses 9.9.3.9 and 9.9.4.4 of 3GPP TS 24.301 [23], or for the "Cause" IE in clause 8.11 of 3GPP TS 24.244 [66]. The value of the Cause Value field (which has a range of 0..255) shall be transferred encoded into one octet as binary integer. The Cause Type field shall be ignored by the receiver. +- For Diameter Cause, the Cause Value field shall contain the cause value as specified for the Diameter Termination-Cause AVP in IETF RFC 3588 [39]. The Cause Value field shall be encoded into 2 octets as binary integer of the Termination-Cause AVP value. The currently assigned values for the Termination-Cause AVP can be found in the IANA registry for Termination-Cause AVP Values, IANA, "Termination-Cause AVP Values (code 295)", + +. + +The Cause Type field shall be ignored by the receiver. + +- For IKEv2 Cause, the Cause Value field shall contain the cause value as specified for the Internet Key Exchange Version 2 (IKEv2) Parameters, Notify message error type, in IETF RFC 7296 [67]. The Cause Value field shall be encoded into 2 octets as binary integer of the IKEv2 notify message error type value. + +The currently assigned values for the IKEv2 notify message error type can be found in the IANA registry for "Internet Key Exchange Version 2 (IKEv2) Parameters", + + + +The Cause Type field shall be ignored by the receiver. + +## 8.104 CN Operator Selection Entity + +CN Operator Selection Entity is coded as depicted in Figure 8.104-1. + +![](553cc3a9fcac62aaa93bb0f2693909c3_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|------------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 173 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | Selection Entity | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.104-1: CN Operator Selection Entity + +Table 8.104-1: Selection Entity values + +| Selection mode value | Value (Decimal) | +|----------------------------------------------------------------------------------------|-----------------| +| The Serving Network has been selected by the UE | 0 | +| The Serving Network has been selected by the network | 1 | +| For future use. Shall not be sent. If received, shall be interpreted as the value "1". | 2, 3 | + +## 8.105 Trusted WLAN Mode Indication + +The purpose of the Trusted WLAN Mode Indication information element is to convey the selected trusted WLAN Mode. + +The content and encoding of the Trusted WLAN Mode Indication is depicted on Figure 8.105-1. + +![](93f97cde167486965f0c9f9466fdb92a_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|-----|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 174 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | MCM | SCM | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.105-1: Trusted WLAN Mode Indication + +The following bits within Octet 5 shall indicate: + +- Bit 8 to 3 – Spare, for future use and set to zero. +- Bit 2 – MCM (Multiple-connection mode Indication): if this bit is set to 1, it indicates that the Multiple-connection mode is used. +- Bit 1 – SCM (Single-connection mode Indication): if this bit is set to 1, it indicates that the Single-connection mode is used. + +## 8.106 Node Number + +Node Number shall be coded as depicted in Figure 8.106-1. + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 175 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Length of Node Number | | | | | | | | | | | | +| 6 to p | Node Number | | | | | | | | | | | | +| (p+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.106-1: Node Number + +The Node number shall carry an ISDN number. + +If the Node Number carries the SGSN Number, then the SGSN number shall be coded according to the contents of ISDN-AddressString data type defined in 3GPP TS 29.002 [41]. The SGSN Number shall be in international format and the "nature of address indicator" shall indicate "international number". The SGSN Number is defined in 3GPP TS 23.003 [2]. The Length of Node Number shall not be zero. + +If the Node Number carries the MME number for MT SMS, then it shall be coded according to the contents of ISDN-AddressString data type defined in 3GPP TS 29.002 [41]. The MME number for MT SMS shall be in international format and the "nature of address indicator" shall indicate "international number". The MME number for MT SMS is defined in 3GPP TS 23.003 [2]. The Length of Node Number shall not be zero. + +If the Node Number carries the MSC Number, then the MSC number shall be coded according to the contents of ISDN-AddressString data type defined in 3GPP TS 29.002 [41]. The MSC Number shall be in international format and the "nature of address indicator" shall indicate "international number". The MSC Number is defined in 3GPP TS 23.003 [2]. The Length of Node Number shall not be zero. + +## 8.107 Node Identifier + +Node Identifier shall be coded as depicted in Figure 8.107-1. + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 176 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Length of Node Name | | | | | | | | | | | | +| 6 to p | Node Name | | | | | | | | | | | | +| (p+1) | Length of Node Realm | | | | | | | | | | | | +| (p+2) to q | Node Realm | | | | | | | | | | | | +| (q+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.107-1: Node Identifier + +The Node Identifier shall contain the Diameter Identity of the node. + +If the Node Identifier contains a SGSN Identifier then: + +- the Node Name shall be coded as the Diameter identity of the SGSN as defined in clause 6.4.13 of 3GPP TS 29.173 [57] and; +- the Node Realm shall be coded as the Diameter realm identity of the SGSN and as defined in clause 6.4.14 of 3GPP TS 29.173 [57] and; +- Both the Node Name and the Node Realm shall be present and neither the Length of Node Name nor the Length of Node Realm shall be zero. + +If the Node Identifier contains a MME Identifier then: + +- the Node Name shall be coded as the Diameter identity of the MME as defined in clause 6.4.4 of 3GPP TS 29.173 [57] and; +- the Node Realm shall be coded as the Diameter realm identity of the MME as defined in clause 6.4.12 of 3GPP TS 29.173 [57] and; +- Both the Node Name and the Node Realm shall be present and neither the Length of Node Name nor the Length of Node Realm shall be zero. + +If the Node Identifier contains a 3GPP AAA Server Identifier then: + +- the Node Name shall be coded as the 3GPP-AAA-Server-Name as defined in clause 8.2.3.24 of 3GPP TS 29.273 [68] and; +- the Node Realm shall be coded as the Diameter realm of the 3GPP AAA server in the format of a Diameter identity as defined in IETF RFC 3588 [39]. + +If the Node Identifier contains an SCEF/IWK-SCEF information, then: + +- the Node Name shall be coded as the SCEF-ID as defined in clause 8.4.5 of 3GPP TS 29.336 [69] and; +- the Node Realm shall be coded as the Diameter realm of the SCEF as defined in clause 7.3.207 of 3GPP TS 29.272 [70]. + +## 8.108 Presence Reporting Area Action + +Presence Reporting Area Action is coded as depicted in Figure 8.108-1. + +![](bcc8fecc8798383960e1a5990fd88889_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---------------------------------|---|------------|---------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 177 | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | Instance | | | | | +| 5 | Spare | | | INAP
RA | Action | | | | +| 6 to 8 | Presence Reporting Area Identifier | | | | | | | | +| 9 | Number of TAI | | | | Number of RAI | | | | +| 10 | Spare | Number of Macro eNodeB | | | | | | | +| 11 | Spare | Number of Home eNodeB | | | | | | | +| 12 | Spare | Number of ECGI | | | | | | | +| 13 | Spare | Number of SAI | | | | | | | +| 14 | Spare | Number of CGI | | | | | | | +| 15 to k | TAIs [1..15] | | | | | | | | +| (k+1) to m | Macro eNB IDs [1..63] | | | | | | | | +| (m+1) to p | Home eNB IDs [1..63] | | | | | | | | +| (p+1) to q | ECGIs [1..63] | | | | | | | | +| (q+1) to r | RAIs [1..15] | | | | | | | | +| (r+1) to s | SAIs [1..63] | | | | | | | | +| (s+1) to t | CGIs [1..63] | | | | | | | | +| t+1 | Spare | Number of Extended Macro eNodeB | | | | | | | +| (t+2) to v | Extended Macro eNB IDs [1..63] | | | | | | | | +| u to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.108-1: Presence Reporting Area Action + +Table 8.108-1: Action values + +| Action | Value (Decimal) | +|-----------------------------------------------------------|-----------------| +| Start Reporting changes of UE presence in the PRA | 1 | +| Stop Reporting changes of UE presence in the PRA | 2 | +| Modify Presence Reporting Area elements composing the PRA | 3 | +| | 0, 4-7 | + +The Action value 1 (Start Reporting change) shall be used to request to start reporting changes of UE presence in the Presence Reporting Area identified by the Presence Reporting Area Identifier and, if present, the Presence Reporting Area elements composing the Presence Reporting Area. + +The Action value 2 (Stop Reporting change) shall be used to request to stop reporting changes of UE presence in a Presence Reporting Area. + +The Action value 3 (Modify Presence Reporting Area elements composing the PRA) shall be used to request to modify the Presence Reporting Area elements composing the PRA and to continue reporting changes of UE presence in that Presence Report Area. + +The Inactive PRA (INAPRA) flag in the Octet 5 shall be set to 1 on the S10/S16/S3 interface if the PRA is inactive in the source MME/SGSN during an inter MME/SGSN mobility procedure, i.e. the reporting change of UE presence in this Presence Reporting Area was requested by the PGW/PCRF/OCS but it was deactivated by the source MME/SGSN, e.g. due to an overload situation. + +The Presence Reporting Area Identifier shall be present if the Action value requests to start, stop or modify reporting changes of UE presence in a Presence Reporting Area. If so, the Presence Reporting Area Identifier shall contain an identifier of the Presence Reporting Area and be encoded using full hexadecimal representation(binary, not ASCII encoding). The Presence Reporting Area Identifier is defined in clause 19.10 of 3GPP TS 23.003 [2]. + +Octets 9 to 14 shall be present if the Action value requests to start reporting change of UE presence in a Presence Reporting Area and the Presence Reporting Area is not pre-configured in the MME/SGSN, or the Action value requests to modify the Presence Reporting Area elements composing a Presence Reporting Area not pre-configured in the MME/SGSN. If so, these octets shall indicate the number of TAI (15 at most), Macro eNodeB ID (63 at most), Home eNodeB ID (63 at most), ECGI (63 at most), RAI (15 at most), SAI (63 at most) and CGI (63 at most) which compose the PRA. + +TAIs in octets 15 to 'k', if any, shall be encoded as per the TAI field in clause 8.21.4. Octets 15 to 'k' shall be absent if the field 'Number of TAI' is set to the value '0'. + +Macro eNB IDs in octets 'k+1' to 'm', if any, shall be encoded as per octets 6 to 11 of the Target ID for type Macro eNodeB in figure 8.51-2. Octets 'k+1' to 'm' shall be absent if the field 'Number of Macro eNodeB' is set to the value '0'. + +Home eNB IDs in octets 'm+1' to 'p', if any, shall be encoded as per octets 6 to 12 of the Target ID for type Home eNodeB in figure 8.51-3. Octets 'm+1' to 'p' shall be absent if the field 'Number of Home eNodeB' is set to the value '0'. + +ECGIs in octets 'p+1' to 'q', if any, shall be encoded as per the ECGI field in clause 8.21.5. Octets 'p+1' to 'q' shall be absent if the field 'Number of ECGI' is set to the value '0'. + +RAIs in octets 'q+1' to 'r', if any, shall be encoded as per the RAI field in clause 8.21.3. Octets 'q+1' to 'r' shall be absent if the field 'Number of RAI' is set to the value '0'. + +SAIs in octets 'r+1' to 's', if any, shall be encoded as per the SAI field in clause 8.21.2. Octets 'r+1' to 's' shall be absent if the field 'Number of SAI' is set to the value '0'. + +CGIs in octets 's+1' to 't', if any, shall be encoded as per the CGI field in clause 8.21.1. Octets 's+1' to 't' shall be absent if the field 'Number of CGI' is set to the value '0'. + +Extended Macro eNB IDs in octets 't+2' to 'v', if any, shall be encoded as per octets 6 to 11 of the Target ID for type Extended Macro eNodeB in figure 8.51-x. Octets 't+2' to 'v' shall be absent if the field 'Number of Extended Macro eNodeB' is set to the value '0'. + +## 8.109 Presence Reporting Area Information + +Presence Reporting Area Information is coded as depicted in Figure 8.109-1. + +![](1f94fa97697122830275fb74bbe6f718_img.jpg) + +| Octets | Bits | | | | | | | | +|----------------|------------------------------------------------------------|---|---|--------|----------|------|------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 178 | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to 7 | PRA Identifier | | | | | | | | +| 8 | Spare | | | INAPRA | APRA | OPRA | IPRA | | +| a to (a+2) | Additional PRA Identifier | | | | | | | | +| a+3 | Spare | | | | APRA | OPRA | IPRA | | +| | ... | | | | | | | | +| b to (b+2) | Additional PRA Identifier | | | | | | | | +| b+3 | | | | | APRA | OPRA | IPRA | | +| (b+4) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.109-1: Presence Reporting Area Information** + +The PRA Identifier in octets 5 to 7 shall be present and shall contain the identifier of the PRA the UE is entering or leaving. It shall be encoded using full hexadecimal representation (binary, not ASCII encoding). The PRA Identifier is defined in clause 19.10 of 3GPP TS 23.003 [2]. + +The PRA Identifier in the Octets 5 to 7 shall be set to the PRA Set ID if the MME/SGSN is requested to report the change of UE presence in a PRA Set. In this case: + +- the Additional PRA (APRA) flag in octet 8 shall be set to 1 if the reporting of change of UE presence for the PRA Set is active and the UE presence has changed for at least one PRA within the PRA Set (i.e. if the UE enters or leaves the PRA Set, or the UE moves between the PRAs within the PRA Set). The subsequent 4 octets shall then be present and shall contain the identifier of the individual PRA within the PRA Set which the UE has newly entered or left, with the information of whether the UE is inside or outside this PRA. +- the Additional PRA (APRA) flag in octet a+3 shall be set to 1 if the UE presence status has changed for more than one individual PRA within the PRA Set. In that case, the subsequent 4 Octets shall be included and encoded as specified above for the octets a to a+3. The MME/SGSN shall report each individual PRA(s) within the PRA Set that the UE has newly entered or left. +- if the reporting of change of UE presence for the PRA Set is inactive, i.e. the INAPRA flag in octet 8 is set to 1, then the Additional PRA (APRA) flag in octet 8 shall not be set to 1 and no Additional PRA Identifier shall be included. + +The Inside PRA flag (IPRA) shall be set to 1 if the UE is inside or enters the Presence Reporting Area identified by the PRA Identifier. + +The Outside PRA flag (OPRA) shall be set to 1 if the UE is outside or leaves the Presence Reporting Area identified by the PRA Identifier. + +The Inactive PRA (INAPRA) flag in octet 8 shall be set to 1 if the PRA is inactive in the MME/SGSN, i.e. the reporting of change of UE presence in this PRA is currently deactivated in the MME/SGSN, e.g. due to an overload situation. + +Either the IPRA or the OPRA flag or the INAPRA shall be set to 1, not several ones, for a given Presence Reporting Area Identifier. + +## 8.110 TWAN Identifier Timestamp + +The TWAN Identifier Timestamp IE is coded as shown in Figure 8.110-1. It indicates the UTC time when the TWAN Identifier information was acquired. Octets 5 to 8 shall be encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [53]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 179 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5-8 | TWAN Identifier Timestamp value | | | | | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.110-1: TWAN Identifier Timestamp + +## 8.111 Overload Control Information + +Overload Control Information is a grouped IE containing a number of other IEs. Which of those IEs are mandatory, optional or conditional and the conditions that apply are GTP message specific, and described in the corresponding clause under clause 7. + +Overload Control Information may be repeated within a message with exactly the same Type and Instance values to represent a list of Overload Control Information. + +Overload Control Information is coded as depicted in Table 8.111-1. + +Table 8.111-1: Overload Control Information Grouped Type + +| | | | | | +|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|----------------|-------------| +| Octet 1 | Overload Control Information IE Type = 180 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| NOTE: | This table uses a 5-column format in order to match the format used in clauses of clause 7, where the usage of this IE is further detailed for each specific GTP message including it. | | | | + +## 8.112 Load Control Information + +Load Control Information is a grouped IE containing a number of other IEs. Which of those IEs are mandatory, optional or conditional and the conditions that apply are GTP message specific, and described in the corresponding clause under clause 7. + +Load Control Information may be repeated within a message with exactly the same Type and Instance values to represent a list of Load Control Information. + +Load Control Information is coded as depicted in Table 8.112-1. + +Table 8.112-1: Load Control Information Grouped Type + +| | | | | | +|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|----------------|-------------| +| Octet 1 | Load Control Information IE Type = 181 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| NOTE: | This table uses a 5-column format in order to match the format used in clauses of clause 7, where the usage of this IE is further detailed for each specific GTP message including it. | | | | + +## 8.113 Metric + +The Metric IE is coded as shown in Figure 8.113-1. It indicates a percentage and may take binary coded integer values from and including 0 up to and including 100. Other values shall be considered as 0. + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 182 (decimal) | | | | | | | | +| 2 to 3 | Length = 1 | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Metric | | | | | | | | + +Figure 8.113-1: Metric + +## 8.114 Sequence Number + +The Sequence Number IE is coded as shown in Figure 8.114-1 and it contains Unsigned32 binary integer value. + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 183 (decimal) | | | | | | | | +| 2 to 3 | Length = 4 | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to 8 | Sequence Number | | | | | | | | + +Figure 8.114-1: Sequence Number + +## 8.115 APN and Relative Capacity + +The APN and Relative Capacity IE is coded as shown in Figure 8.115-1. + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 184 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Relative Capacity | | | | | | | | | | | | +| 6 | APN Length | | | | | | | | | | | | +| 7 to m | Access Point Name (APN) | | | | | | | | | | | | +| (m+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.115-1: APN and Relative Capacity + +The Relative Capacity represents the resources configured for the given APN as compared to the total resources of the target PGW, in percentage. It shall take binary coded integer values from 1 up to 100. Other values shall be considered as 0. + +The APN Length in octet '6' indicates the length of the APN field. + +The APN field, from octet 7 to 'm' shall be encoded as octet 5 to '(n+4)' defined in clause 8.6. + +## 8.116 WLAN Offloadability Indication + +WLAN Offloadability Indication IE is coded as depicted in Figure 8.116-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|-------------------|------------------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = yyy (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | EUTRAN indication | UTRAN indication | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.116-1: WLAN Offloadability Indication + +Octet 5 indicates if WLAN Offload has been authorized for the UE: + +- Bit 8 to 3 Spare, for future use and set to zero. +- Bit 2 – reflects the information available at the UE regarding E-UTRAN Offloadability. When set to '1', this indicates that the UE has been authorized to perform WLAN offload from E-UTRAN. When set to '0', this indicates that the UE has not been authorized to perform WLAN offload from E-UTRAN. +- Bit 1 – reflects the information available at the UE regarding UTRAN Offloadability. When set to '1', this indicates that the UE has been authorized to perform WLAN offload from UTRAN. When set to '0', this indicates that the UE has not been authorized to perform WLAN offload from UTRAN. + +## 8.117 Paging and Service Information + +The Paging and Service Information IE is used to carry per bearer paging and service information. It is coded as shown in Figure 8.117-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|--------------------------------|---|---------------------|---|---|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type 186 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare (all bits set to 0) | | | | EPS Bearer ID (EBI) | | | | +| 6 | Spare | | | | | | | PPI | +| m | Spare | | Paging Policy Indication value | | | | | | +| p to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.117-1: Paging and Service Information + +The EBI field in octet 5 shall contain the value indicating the EPS Bearer ID for which the Paging and Service Information is provided. The EBI field shall be encoded as the EBI field in the EPS Bearer ID (EBI) IE type (see clause 8.8). + +The PPI flag in octet 6 indicates whether the Paging Policy Indication value in octet 'm' shall be present. If PPI is set to '1', then the Paging Policy Indication value shall be present. If PPI is set to '0', then octet 'm' shall not be present. + +The Paging Policy Indication value, in octet 'm', shall be encoded as the DSCP in TOS (IPv4) or TC (IPv6) information received in the IP payload of the GTP-U packet from the PGW (see IETF RFC 2474 [65]). + +## 8.118 Integer Number + +Integer Number is coded as depicted in Figure 8.118-1. + +| Octets | Bits | | | | | | | | +|----------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 187 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to n+4 | Integer Number Value | | | | | | | | + +Figure 8.118-1: Integer Number + +The Integer Number value is encoded with the number of octets defined in the Length field, e.g. when n=2, the range of the integer number value is from 0 to 65535. + +The Integer Number value shall be encoded as further described below for the following information elements: + +- Maximum Wait Time IE: the length shall be set to 2, i.e. the integer number value shall be encoded as a 16 bit unsigned integer. +- DL Buffering Suggested Packet Count IE: the length shall be set to 1 or 2; +- UE Usage Type IE: the length shall be set to 1, i.e. the integer number value shall be encoded as a 8 bit unsigned integer as specified in clause 7.3.202 of 3GPP TS 29.272 [70]. +- Remaining Running Service Gap Timer IE: the length shall be set to 4, i.e. the integer number value shall be encoded as a 32 bit unsigned integer. +- DL Data Packet Size IE: the length shall be set to 2, i.e. the integer number value shall be encoded as a 16 bit unsigned integer. + +## 8.119 Millisecond Time Stamp + +The Millisecond Time Stamp IE is coded as shown in Figure 8.119-1. Octets 5 to 10 represent a 48 bit unsigned integer in network order format and are encoded as the number of milliseconds since 00:00:00 January 1, 1900 00:00 UTC, i.e. as the rounded value of $1000 \times$ the value of the 64-bit timestamp (Seconds + (Fraction / $(1 \ll 32)$ ))) defined in clause 6 of IETF RFC 5905 [53]. + +| Octets | Bits | | | | | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 188 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5-10 | Millisecond Time Stamp value | | | | | | | | | | | | +| 11 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.119-1: Millisecond Time Stamp + +## 8.120 Monitoring Event Information + +The Monitoring Event Information contains the monitoring event parameters that are necessary to transfer over the S3/S16/S10 interface. + +The Monitoring Event Information is coded as depicted in Figure 8.120-1. + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|------|------|------|---|---|----------|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 189 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | SRIE | NSCF | NSUI | NSUR | | | Instance | | | | | | +| 5 to 8 | SCEF Reference ID | | | | | | | | | | | | +| 9 | SCEF ID Length | | | | | | | | | | | | +| 10 to k | SCEF ID | | | | | | | | | | | | +| (k+1) to (k+2) | Remaining Number of Reports | | | | | | | | | | | | +| l to (l+7) | SCEF Reference ID Ext | | | | | | | | | | | | +| m to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.120-1: Monitoring Event Information + +The SCEF Reference ID, the SCEF ID, SCEF Reference ID Ext shall be encoded as specified in clause 8.4.4, 8.4.5 and 8.4.82 of 3GPP TS 29.336 [69]. + +The SCEF ID Length indicates the length of the SCEF ID in octets. + +When the SRIE (SCEF Reference Id Extension) is set to "1", the 64-bit SCEF Reference ID Ext field shall be present to contain the 64-bit SCEF Reference ID Ext for the event. In this case, the receiver shall ignore the SCEF Reference ID received in octets 5 to 8. + +NOTE 1: The sender can set any value for SCEF Reference ID if the SCEF Reference ID Ext field is included. + +The source MME/SGSN shall set the NSUR (Notify SCEF when UE becomes Reachable) flag to "1" to indicate that the target MME/SGSN shall send a notification to SCEF when the UE becomes reachable, if a monitoring event, with the Monitoring-Type is set to "AVAILABILITY\_AFTER\_DDN\_FAILURE", or \_ +"UE\_REACHABILITY\_AND\_IDLE\_STATUS\_INDICATION" or +"AVAILABILITY\_AFTER\_DDN\_FAILURE\_AND\_IDLE\_STATUS\_INDICATION" or "UE\_REACHABILITY". + +The source MME/SGSN shall set the NSUI (Notify SCEF when UE becomes Idle) flag to "1" to indicate that the target MME/SGSN shall send a notification to SCEF when the UE gets into idle mode, if a monitoring event, with the Monitoring-Type is set to "UE\_REACHABILITY\_AND\_IDLE\_STATUS\_INDICATION" or +"AVAILABILITY\_AFTER\_DDN\_FAILURE\_AND\_IDLE\_STATUS\_INDICATION". + +The source MME/SGSN shall set the NSCF (Notify SCEF about Communication Failure events) flag to "1" to indicate that the target MME/SGSN shall send a notification to the SCEF if it detects a communication failure event. + +NOTE 2: This enables the target MME/SGSN to notify the SCEF about communication failure events that can happen with the target RAN (e.g. radio link failure during the handover execution) before the target MME/SGSN interacts with the HSS. + +The Remaining Number of Reports indicates the number of reports which are outstanding to be sent to the SCEF. It shall be encoded as specified in clause 8.4.8 of 3GPP TS 29.336 [69]. + +## 8.121 ECGI List + +MBMS Cell List is an extendable IE that is coded as depicted in Figure 8.120-1. The ECGI identity types are defined in 3GPP TS 23.003 [2]. + +| Octets | Bits | | | | | | | | | | | | +|------------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 190 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 6 | Number of ECGI Fields = m | | | | | | | | | | | | +| 7 to (m*7+6) | ECGI List of m ECGI Fields | | | | | | | | | | | | +| (m*7+7) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.121-1: ECGI List + +The Number of ECGI Fields shall indicate the number of ECGI fields in the ECGI List. + +In the present version of this specification, the Length n shall be set to m times 7 plus 2. + +The ECGI List shall consist of m ECGI fields. Each ECGI field shall be encoded as specified in clause 8.21.5 and thus is 7 octets long. + +## 8.122 Remote UE Context + +Remote UE Context is a grouped IE containing a number of other IEs. Which of those IEs are mandatory, optional or conditional and the conditions that apply are GTP message specific, and described in the corresponding clause under clause 7. + +Remote UE Context may be repeated within a message with exactly the same Type and Instance values to represent a list of Remote UE Context. + +Remote UE Context is coded as depicted in Table 8.122-1. + +**Table 8.122-1: Remote UE Context Grouped Type** + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|----------------------------|----------------|-------------| +| Octet 1 | Bearer Context IE Type = 191 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| NOTE: This table uses a 5-column format in order to match the format used in clauses of clause 7, where the usage of this IE is further detailed for each specific GTP message including it. | | | | | + +## 8.123 Remote User ID + +Remote User ID is transferred via GTP tunnels and is coded as depicted in Figure 8.123-1. The Remote User ID IE shall contain one IMSI identity and, if available, one IMEI identity and/or one MSISDN identity. The flag MSISDNF in octet 5 indicates if the MSISDN shall be present in the respective field. The flag IMEIF in octet 5 indicates if the IMEI shall be present in the respective field. The IMSI field including the Length of IMSI shall be always present. + +| Octets | Bits | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|----------|---|-------|---------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 192 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | IMEIF | MSISDNF | +| 6 | Length of IMSI | | | | | | | | +| 7 to a | IMSI | | | | | | | | +| b | Length of MSISDN | | | | | | | | +| b+1 to c | MSISDN | | | | | | | | +| d | Length of IMEI | | | | | | | | +| d+1 to e | IMEI | | | | | | | | +| (e+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.123-1: Remote User ID** + +The coding of IMSI field, from octets 7 to 'a' shall be encoded as the octets 5 to n+4 of the IMSI IE type specified in clause 8.3. + +The coding of MSISDN field, octets 'b+1' to 'c' shall be encoded as the octets 5 to n+4 of the MSISDN IE type specified in clause 8.11. + +The coding of IMEI field, octets 'd+1' to 'e' shall be encoded as the octets 5 to n+4 of the MEI IE type specified in clause 8.10. + +## 8.124 Remote UE IP Information + +Remote UE IP Information is transferred via GTP tunnels and is coded as depicted in Figure 8.124-1. Remote UE IP information field, octets 5 to n+4 shall be encoded as the octets from 'j' to 'j+k' of the Remote UE Context IE specified in clause 9.9.4.20 of 3GPP TS 24.301 [23]. + +| Octets | Bits | | | | | | | | +|----------|--------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 193 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to n+4 | Remote UE IP Information | | | | | | | | + +**Figure 8.124-1: Remote UE IP Information** + +## 8.125 CIoT Optimizations Support Indication + +CIoT Optimizations Support Indication is coded as depicted in Figure 8.125-1 below. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|-------|-------|-------|----------|------------|-------------|-------------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 194 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | Spare | Spare | Spare | IHCSI | AWO
PDN | SCNI
PDN | SGNI
PDN | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.125-1: CIoT Optimizations Support Indication** + +Octet 5 carries the feature support bits for each of the CIoT optimization as follows: + +- Bit 8 to Bit 5: Spare, for future use and set to 0. +- Bit 4 – IHCSI (IP Header Compression Support Indication): Indicates the support of IP header compression based on ROHC framework (see IETF RFC 4995 [77]) for Control Plane CIoT EPS optimisations, when set to '1'. +- Bit 3 – AWOPDN (Attach without PDN Support Indication): Indicates the support of Attach without PDN connection as specified in clause 4.3.5.10 of 3GPP TS 23.401 [3], when set to '1'. Here the word "PDN connection" implies both the PDN connection through SGW and PGW and the PDN connection through SCEF. +- Bit 2 – SCNIPDN (SCEF Non IP PDN Support Indication): Indicates the support of SCEF Non IP PDN Connection as specified in clause 5.13.1 of 3GPP TS 23.682 [74], when set to '1'. +- Bit 1 – SGNIPDN (SGi Non IP PDN Support Indication): Indicates the support of SGi Non IP PDN Connection as specified in clause 4.3.17.8.3.3 of 3GPP TS 23.401 [3] and 3GPP TS 23.060 [35], when set to '1'. + +## 8.126 SCEF PDN Connection + +The SCEF PDN connection is a grouped IE containing a number of other IEs and shall be coded as depicted in Table 8.126-1. + +The SCEF PDN Connection IE may be repeated within a message when more than one SCEF PDN Connection is required to be sent. If so, the repeated IEs shall have exactly the same Instance values to represent a list of grouped IEs. + +**Table 8.126-1: PDN Connection Grouped Type** + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|----------------------------|----------------|-------------| +| Octet 1 | PDN Connection IE Type = 195 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| | | | | | +| NOTE: This table uses a 5-column format in order to match the format used in clauses of clause 7, where the usage of this IE is further detailed for each specific GTP message including it. | | | | | + +## 8.127 Header Compression Configuration + +The Header Compression Configuration includes the information necessary for the ROHC channel setup. + +The Header Compression Configuration shall be encoded as specified in Figure 8.127-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 196 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 6 | ROHC Profiles | | | | | | | | | | | | +| 7 to 8 | MAX_CID | | | | | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.127-1: Header Compression Configuration + +Table 8.127-1: Header Compression Configuration + +| ROHC Profiles (octets 5 and 6) | | | | | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---|--------------------|--------| +| Bits | | | | | | | | | | +|

The ROHC Profiles shall indicate which of the ROHC profiles specified in 3GPP TS 36.323 [76] are allowed to be used (i.e. have been negotiated) with the UE. When a particular bit is set to 1, this indicates that the corresponding profile is allowed to be used. The No Compression profile 0x000 shall also be considered as allowed if at least one bit is set to 1. When all the bits are set to 0, this indicates that only the No Compression profile 0x000 is allowed to be used.

| | | | | | | | | | +| Octet 5 | | | | | | | | | | +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | Profile Identifier | Usage | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0x0002 | UDP/IP | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0x0003 | ESP/IP | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0x0004 | IP | +| 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0x0006 | TCP/IP | +| 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0x0102 | UDP/IP | +| 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0x0103 | ESP/IP | +| 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0x0104 | IP | +| 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | | Spare | +| Octet 6 | | | | | | | | | | +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | Profile Identifier | Usage | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | | Spare | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | | Spare | +| 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | | Spare | +| 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | | Spare | +| 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | | Spare | +| 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | | Spare | +| 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | | Spare | +| 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | | Spare | +| MAX_CID (octet 7 to 8) | | | | | | | | | | +|

This is the maximum CID value specified in 3GPP TS 36.323 [76] allowed to be used (i.e. which has been negotiated) with the UE. This shall be encoded as a 2 byte integer with a value in the range from 1 to 16383.

| | | | | | | | | | + +## 8.128 Extended Protocol Configuration Options (ePCO) + +The detailed coding and maximum length of the Extended Protocol Configuration Options field from octets 5 to (n+4) shall be specified as per clause 9.9.4.26 of 3GPP TS 24.301 [23], starting with octet 4. + +| Octets | Bits | | | | | | | | +|------------|-----------------------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 197 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | Extended Protocol Configuration Options | | | | | | | | + +**Figure 8.128-1: Extended Protocol Configuration Options (ePCO)** + +## 8.129 Serving PLMN Rate Control + +Serving PLMN Rate Control may be configured in the Serving PLMN network, to protect serving network, e.g. the MME and the Signalling Radio Bearers in the E-UTRAN, from the load generated by NAS Data PDUs. It defines the maximum number of the NAS Data PDUs which can be transferred by the Serving Network per 6 minute interval. + +The maximum number of the NAS Data PDUs which can be transferred for both downlink and uplink shall be configured to a value greater than 10. When the value is set to 0, it shall indicate Serving PLMN Rate Control is not applicable to the PDN Connection for the given direction. + +The Serving PLMN Rate Control shall only apply to the PDN Connection(s) which is set to Control Plane Only. + +Serving PLMN Rate Control Information is coded as depicted in Figure 8.129-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 198 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 6 | Uplink Rate Limit | | | | | | | | | | | | +| 7 to 8 | Downlink Rate Limit | | | | | | | | | | | | +| 9 to (n-4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +**Figure 8.129-1: Serving PLMN Rate Control** + +## 8.130 Counter + +Counter IE is coded as depicted in Figure 8.130-1. + +| Octets | Bits | | | | | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 199 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 8 | Timestamp value | | | | | | | | | | | | +| 9 | Counter value | | | | | | | | | | | | +| 10 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +**Figure 8.130-1: Counter** + +Octets 5 to 8 shall be encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [53]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +Octet 9 represents an integer with a length of 1 octet. + +## 8.131 Mapped UE Usage Type + +Mapped UE Usage Type shall be coded as depicted in Figure 8.131-1. Mapped UE Usage Type is defined in clause 5.8.1 of 3GPP TS 29.003 [32]. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 200 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 6 | Mapped UE Usage Type | | | | | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.131-1: Mapped UE Usage Type + +The Mapped UE Usage Type shall be encoded as a two octets binary integer. + +## 8.132 Secondary RAT Usage Data Report + +Secondary RAT Usage Data Report IE is coded as depicted in Figure 8.132-1. + +| Octets | Bits | | | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|---------------------|-----------|-----------|---|--|--|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | | | +| 1 | Type = 201 (decimal) | | | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | | | +| 5 | Spare | | | | SRUD
N | IRSG
W | IRPG
W | | | | | | | | +| 6 | Secondary RAT Type | | | | | | | | | | | | | | +| 7 | Spare (all bits set to 0) | | | | EPS Bearer ID (EBI) | | | | | | | | | | +| 8-11 | Start timestamp | | | | | | | | | | | | | | +| 12-15 | End timestamp | | | | | | | | | | | | | | +| 16-23 | Usage Data DL | | | | | | | | | | | | | | +| 24-31 | Usage Data UL | | | | | | | | | | | | | | +| k | Length of Secondary RAT Data Usage Report Transfer | | | | | | | | | | | | | | +| (k+1) - a | Secondary RAT Data Usage Report Transfer | | | | | | | | | | | | | | +| (a+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | | | + +Figure 8.132-1: Secondary RAT Usage Data Report + +The following bits within Octet 5 shall indicate: + +- Bit 8 to 4 – Spare, for future use and set to zero. +- Bit 3 – SRUDN (Secondary RAT Usage Data Report From NG-RAN): This bit indicates the presence of Length of Secondary RAT Data Usage Report Transfer and Secondary RAT Data Usage Report Transfer fields. If it is set to "1", the Length of Secondary RAT Data Usage Report Transfer and Secondary RAT Data Usage Report Transfer field shall be present, and the IRPGW bit shall be set to "1", octet 8 to 31 shall be set to "0"; otherwise, if it is set to "0", the Length of Secondary RAT Data Usage Report Transfer and Secondary RAT Data Usage Report Transfer field shall not be present. +- Bit 2 – IRSGW (Intended Receiver SGW): This bit defines if the Usage Data Report shall be used by the SGW or not. If set to 1 the SGW shall store it. If set to zero the SGW shall not store it. +- Bit 1 – IRPGW (Intended Receiver PGW): This bit defines if the Usage Data Report shall be sent to the PGW or not. If set to 1 the SGW shall forward it to PGW and PGW shall store it. If set to zero SGW shall not forward it to PGW. + +Octet 6 represents Secondary RAT Type + +Secondary RAT Type is coded as depicted in Table 8.132-1. + +Table 8.132-1: Secondary RAT Type values + +| RAT Types | Values (Decimal) | +|---------------------|------------------| +| NR | 0 | +| Unlicensed Spectrum | 1 | +| | 2-255 | + +The EBI field in octet 7 shall contain the value indicating the EPS Bearer ID. The EBI field shall be encoded as the EBI field in the EPS Bearer ID (EBI) IE type (see clause 8.8). + +Octets 8 to 11 and 12 to 15 shall be encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [53]. It indicates the UTC time when the recording of the Secondary RAT Usage Data was started and ended. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +Octets 16 to 23 and 24 to 31: The Usage Data UL/DL fields are encoded as octets in binary value. The range of Usage Data UL and Usage Data DL are specified in 3GPP TS 36.413 [10]. + +**Editors Note:** The format and range is subject to be aligned with RAN specification. The timestamp and Usage Data UL and DL are received from relevant S1 messages. + +The Secondary RAT Data Usage Report Transfer field shall be encoded with the transparent copy of NGAP IE Secondary RAT Data Usage Report Transfer as specified in 3GPP TS 38.413 [84]. (See also Annex B.3) + +## 8.133 UP Function Selection Indication Flags + +The UP Function Selection Indication Flags information element shall be coded as depicted in Figure 8.133-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 202 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | | DCNR | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.133-1: UP Function Selection Indication Flags** + +For each message, the applicable flags of the UP Function Selection Indication Flags IE shall be clearly specified in the individual message clause. The remaining flags of the UP Function Selection Indication Flags IE not so indicated shall be discarded by the receiver. + +The receiver shall consider the value of the applicable flags as "0", if the UP Function Selection Indication Flags IE is applicable for the message but not included in the message by the sender. + +The following bits within Octet 5 shall indicate: + +- Bit 8 to 2 – Spare, for future use and set to zero. +- Bit 1 – DCNR (Dual connectivity with NR): If this bit is set to 1, it indicates to the SGW-C and PGW-C that it is desired to select a specific SGW-U and PGW-U for UEs supporting dual connectivity with NR and not restricted from using NR by user subscription. UE signals its support for dual connectivity with NR to the MME and S4-SGSN with the DCNR of the UE network capability IE in 3GPP TS 24.301 [23]. Subscription restriction to use NR as secondary RAT is specified in "NR as Secondary RAT Not Allowed" bit within Access Restriction Data in 3GPP TS 29.272 [70]. + +## 8.134 Maximum Packet Loss Rate + +The Maximum Packet Loss Rate IE is used to carry bearer loss rate for uplink and downlink traffic. It is coded as shown in Figure 8.134-1. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 203 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | DL | UL | +| m to m+1 | Maximum Packet Loss Rate UL | | | | | | | | +| o to o+1 | Maximum Packet Loss Rate DL | | | | | | | | +| p to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.134-1: Maximum Packet Loss Rate** + +The UL flag in octet 5 indicates whether the Maximum Packet Loss Rate UL value in octets 'm to m+1' shall be present. If UL is set to '1', then the Maximum Packet Loss Rate UL value shall be present. If UL is set to '0', then octets 'm to m+1' shall not be present. + +The DL flag in octet 5 indicates whether the Maximum Packet Loss Rate DL value in octets 'o to o+1' shall be present. If DL is set to '1', then the Maximum Packet Loss Rate DL value shall be present. If DL is set to '0', then octets 'o to o+1' shall not be present. + +The Maximum Packet Loss Rate for UL and DL shall be coded as an unsigned integer in the range of 0 to 1000. It shall be interpreted as Ratio of lost packets per number of packets sent, expressed in tenth of percent. + +## 8.135 APN Rate Control Status + +| Octets | Bits | | | | | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 204 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 8 | Number of Uplink packets allowed | | | | | | | | | | | | +| 9 to 12 | Number of additional exception reports | | | | | | | | | | | | +| 13 to 16 | Number of Downlink packets allowed | | | | | | | | | | | | +| 17 to 24 | APN Rate Control Status validity Time | | | | | | | | | | | | +| 25 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +**Figure 8.135-1: APN Rate Control Status** + +Octets 17 to 24 are coded as the time in seconds relative to 00:00:00 on 1 January 1900 (calculated as continuous time without leap seconds and traceable to a common time reference) where binary encoding of the integer part is in the 32 most significant bits and binary encoding of the fraction part in the 32 least significant bits. The fraction part is expressed with a granularity of $1/2^{32}$ second. + +## 8.136 Extended Trace Information + +Extended Trace Information is coded as depicted in Figure 8.136-1. See 3GPP TS 32.422 [18] for details on trace related information. + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|-------------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 205 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | MCC digit 2 | | | | MCC digit 1 | | | | | | | | +| 6 | MNC digit 3 | | | | MNC digit 3 | | | | | | | | +| 7 | MNC digit 2 | | | | MNC digit 1 | | | | | | | | +| 8 to 10 | Trace ID | | | | | | | | | | | | +| 11 | Length of Triggering Events | | | | | | | | | | | | +| 12 to m | Triggering Events | | | | | | | | | | | | +| m+1 | Length of List of NE Types | | | | | | | | | | | | +| (m+2) to p | List of NE Types | | | | | | | | | | | | +| p+1 | Session Trace Depth | | | | | | | | | | | | +| p+2 | Length of List of Interfaces | | | | | | | | | | | | +| (p+3) to q | List of Interfaces | | | | | | | | | | | | +| q+1 | Length of IP Address of Trace Collection Entity | | | | | | | | | | | | +| (q+2) to r | IP Address of Trace Collection Entity | | | | | | | | | | | | +| (r+1) to (n-4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +**Figure 8.136-1: Extended Trace Information** + +Octets 5 to 10 represent the Trace Reference parameter as defined in clause 5.6 of 3GPP TS 32.422 [18]. + +Triggering Events, List of NE Types, Session Trace Depth, List of Interfaces and IP Address of Trace Collection Entity are specified in 3GPP TS 32.422 [18]. + +NOTE: The List of Triggering Events, List of NE Types and List of Interfaces include the events, NE types and List of interfaces to be traced in the target system during an EPS to 5GS or 5GS to EPS mobility, see clause 4.1.2.15.2 of 3GPP TS 32.422 [18]. + +See 3GPP TS 24.008 [5], clause 10.5.1.4, Mobile Identity, for the coding of MCC and MNC, whose values are obtained from the serving PLMN that the EM/NM is managing. If MNC is 2 digits long, bits 5 to 8 of octet 6 are coded as "1111". + +## 8.137 Monitoring Event Extension Information + +The Monitoring Event Information contains the monitoring event parameters that are necessary to transfer over the S3/S16/S10 interface. + +The Monitoring Event Extension Information is coded as depicted in Figure 8.137-1. + +| Octets | Bits | | | | | | | | +|-----------------|------------------------------------------------------------|---|---|---|----------|---|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 206 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | SRIE | LRTP | +| 6 to 9 | SCEF Reference ID | | | | | | | | +| 10 | SCEF ID Length | | | | | | | | +| 11 to k | SCEF ID | | | | | | | | +| (h) to
(h+3) | Remaining Minimum Periodic Location Reporting Time | | | | | | | | +| i to
(i+7) | SCEF Reference ID Ext | | | | | | | | +| (g) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +**Figure 8.137-1: Monitoring Event Extension Information** + +The SCEF Reference ID, the SCEF ID and the SCEF Reference ID Ext shall be encoded as specified in clause 8.4.4, 8.4.5 and 8.4.82 of 3GPP TS 29.336 [69]. + +The SCEF ID Length indicates the length of the SCEF ID in octets. + +The following bits within Octet 5 indicate: + +- Bit 1 – LRTP (Remaining Minimum Periodic Location Reporting Time Present): This flag is used to indicate that Remaining Minimum Periodic Location Reporting Time shall be present. +- Bit 2 – SRIE (SCEF Reference Id Extension): if this flag is set to "1", the SCEF Reference ID Ext field shall be present to contain the 64-bit SCEF Reference ID Ext for the event. In this case, the receiver shall ignore the SCEF Reference ID received in octets 5 to 8. + +NOTE: The sender can set any value for SCEF Reference ID if the SCEF Reference ID Ext is included. + +- Bit 3-8 Spare. + +Remaining Minimum Periodic Location Reporting Time indicates the current value of the timer for minimum periodic location reporting. It shall be encoded as specified in clause 8.4.29 of 3GPP TS 29.336 [69]. The target MME/SGSN shall start the timer with the Remaining Minimum Periodic Location Reporting Time to continue detecting the location change. If the timer expires, the target MME/SGSN shall restart the timer with the value of the Periodic-Time AVP within the Monitoring-Event-Configuration AVP provided by the HSS. + +## 8.138 Additional RRM Policy Index + +Additional RRM Policy Index (ARPI) is coded as depicted in Figure 8.138-1 and contains a non-transparent copy of the corresponding IE (see clause 8.2.2), "Additional RRM Policy Index" as specified in 3GPP TS 36.413 [10]. The ARPI is encoded as Unsigned32 binary integer values. + +| Octets | Bits | | | | | | | | +|--------|-----------------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 207 (decimal) | | | | | | | | +| 2 to 3 | Length = 4 | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to 8 | Additional RRM Policy Index | | | | | | | | + +Figure 8.138-1. Additional RRM Policy Index + +Editor' Note: The IE name for "Additional RRM Policy Index" in SIAP is to be confirmed. + +## 8.139 V2X Context + +The V2X Context is a grouped IE containing a number of other IEs and shall be coded as depicted in Table 8.139-1. + +Table 8.138-1: V2X Context Grouped Type + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|----------------------------|----------------|-------------| +| Octet 1 | V2X Context IE Type = 208 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| NOTE: This table uses a 5-column format in order to match the format used in clauses of clause 7, where the usage of this IE is further detailed for each specific GTP message including it. | | | | | + +## 8.140 PC5 QoS Parameters + +The PC5 QoS Parameters is a grouped IE containing a number of other IEs and shall be coded as depicted in Table 8.140-1. + +Table 8.140-1: PC5 QoS Parameters Grouped Type + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|----------------------------|----------------|-------------| +| Octet 1 | PC5 QoS Parameters IE Type = 209 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| NOTE: This table uses a 5-column format in order to match the format used in clauses of clause 7, where the usage of this IE is further detailed for each specific GTP message including it. | | | | | + +## 8.141 Services Authorized + +Services Authorized shall be coded as depicted in Figure 8.141-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 210 | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 | Vehicle UE Authorized | | | | | | | | | | | | +| 6 | Pedestrian UE Authorized | | | | | | | | | | | | +| 7 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.141-1: Services Authorized + +Vehicle UE Authorized represents an indication if the UE is authorized to use the V2X services as Vehicle UE, as specified in 3GPP TS 29.272 [70]. Vehicle UE Authorized field is encoded as a one octet long enumeration. Currently, Vehicle UE Authorized field specifies two enumeration values: 0 (indicates "authorized") and 1 (indicates "not authorized"). + +Pedestrian UE Authorized represents an indication if the UE is authorized to use the V2X services as Pedestrian UE, as specified in 3GPP TS 29.272 [70]. Pedestrian UE Authorized field is encoded as a one octet long enumeration. Currently, Pedestrian UE Authorized field specifies two enumeration values: 0 (indicates "authorized") and 1 (indicates "not authorized"). + +## 8.142 Bit Rate + +Bit Rate shall be coded as depicted in Figure 8.142-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 211 | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 8 | bit rate | | | | | | | | | | | | +| 9 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.142-1: Bit Rate + +The bit rate field is encoded as kilobits per second (1 kbps = 1000 bps) in binary value. + +## 8.143 PC5 QoS Flow + +PC5 QoS Flow shall be coded as depicted in Figure 8.143-1. + +| Octets | Bits | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|----------|---|---|-------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 212 | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | | Range | +| 6 | Label (PQI) | | | | | | | | +| 7 to 10 | Guaranteed Flow Bit Rate | | | | | | | | +| 11 to 14 | Maximum Flow Bit Rate | | | | | | | | +| 15 | Range | | | | | | | | +| 16 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.143-1: PC5 QoS Flow + +If the Range flag, in bit 1 of octet 5, is set to "1", then the Range field shall be present in octet 15, otherwise the octet 15 shall not be present. + +Octet 6 contains the "5QI" value, as specified in 3GPP TS 23.501 [82]. + +The Guaranteed Flow Bit Rate and Maximum Flow Bit Rate fields are encoded as kilobits per second (1 kbps = 1000 bps) in binary value. The Guaranteed Flow Bit Rate and Maximum Flow Bit Rate fields may require converting values in bits per second to kilobits per second when the Guaranteed Flow Bit Rate and Maximum Flow Bit Rate values are received from an interface other than GTPv2 interface. If such conversions result in fractions, then the value of Guaranteed Flow Bit Rate and Maximum Flow Bit Rate fields shall be rounded upwards. For non-GBR PC5 QoS flows, both the Guaranteed Flow Bit Rate and Maximum Flow Bit Rate should be set to zero. + +The Range field is in the unit of meters, and only used for groupcast communication, as specified in 3GPP TS 36.413 [10]. Range field is encoded as a one octet long enumeration. + +NOTE: 3GPP TS 36.413 [10] specifies several enumeration values, i.e. 0 (indicates "m50"), 1 (indicates "m80") and etc. + +## 8.144 SGi PtP Tunnel Address + +SGi PtP Tunnel Address is coded as depicted in Figure 8.144-1. + +| Octets | Bits | | | | | | | | | | +|-------------|------------------------------------------------------------|---|---|---|----------|----|----|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 | Type = 213 (decimal) | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | +| 5 | Spare | | | | Port | V6 | V4 | | | | +| m to (m+3) | IPv4 address | | | | | | | | | | +| p to (p+15) | IPv6 address | | | | | | | | | | +| q to (q+1) | Port Number | | | | | | | | | | +| k to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | + +Figure 8.144-1: SGi PtP Tunnel Address + +The following flags are coded within Octet 5: + +- Bit 1 – V4: If this bit is set to "1", then the IPv4 address field shall be present, otherwise it shall be absent. Bit 2 shall be set to "0" when Bit 1 is set to "1". +- Bit 2 – V6: If this bit is set to "1", then the IPv6 address field shall be present, otherwise it shall be absent. Bit 1 shall be set to "0" when Bit 2 is set to "1". +- Bit 3 – Port: If this bit is set to "1", then the Port Number field shall be present, otherwise it shall be absent. + +When the IPv4 address field is present, octets m to (m+3) shall contain an IPv4 address. Bit 8 of Octet m represents the most significant bit of the IPv4 address and bit 1 of octet (m+3) the least significant bit. + +When the IPv6 address field is present, octets p to (p+15) shall contain the IPv6 Prefix and Interface Identifier. Bit 8 of octet p represents the most significant bit of the IPv6 Prefix and Interface Identifier and bit 1 of octet (p+15) the least significant bit. + +When the UDP port field is present, octets q to (q+1) shall contain a UDP port number. Bit 8 of Octet q represents the most significant bit of the port number and bit 1 of octet (q+1) the least significant bit. + +## 8.145 PGW Change Info + +PGW Change Info is a grouped IE containing several other IEs. Which of those IEs are mandatory, optional or conditional and the conditions that apply are GTP message specific and described in the corresponding clause under clause 7. + +PGW Change Info is coded as depicted in Table 8.145-1. + +Table 8.145-1: PGW Change Info Grouped Type + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|----------------------------|----------------|-------------| +| Octet 1 | PGW Change Info IE Type = 214 (decimal) | | | | +| Octets 2 and 3 | Length = n | | | | +| Octet 4 | Spare and Instance fields | | | | +| Information elements | P | Condition / Comment | IE Type | Ins. | +| NOTE: This table uses a 5-column format in order to match the format used in clauses of clause 7, where the usage of this IE is further detailed for each specific GTP message including it. | | | | | + +## 8.146 PGW FQDN + +The PGW FQDN IE shall contain an FQDN representing the PGW Set or PGW. It shall be encoded as shown in Figure 8.146-1. + +| Octets | Bits | | | | | | | | | | | | +|----------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 215 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to m | FQDN | | | | | | | | | | | | +| (m+1) to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.146-1: PGW FQDN + +FQDN encoding shall be identical to the encoding of a FQDN within a DNS message of clause 3.1 of IETF RFC 1035 [27] but excluding the trailing zero byte. + +NOTE: The FQDN field in the IE is not encoded as a dotted string as commonly used in DNS master zone files. + +## 8.147 Group Id + +Group Id IE shall be encoded as depicted in Figure 8.147-1. The Group Id field shall be encoded as specified in clause 8.2.198 of 3GPP TS 29.244 [80]. + +| Octets | Bits | | | | | | | | +|------------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 216 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to (n+4) | Group Id | | | | | | | | + +Figure 8.147-1: Group Id + +## 8.148 PSCell ID + +PSCell ID shall be encoded as depicted in Figure 8.148-1. PSCell ID contains an NR Cell Identity. + +| Octets | Bits | | | | | | | | +|---------|---------------------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 217 (decimal) | | | | | | | | +| 2 to 3 | Length = 8 | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | MCC digit 2 | | | | MCC digit 1 | | | | +| 6 | MNC digit 3 | | | | MCC digit 3 | | | | +| 7 | MNC digit 2 | | | | MNC digit 1 | | | | +| 8 | Spare | | | | NR CGI | | | | +| 9 to 12 | NR CGI (NR Cell Identity) | | | | | | | | + +Figure 8.148-1: PSCell ID + +The "MNC digit 3" field shall be coded as "1111" if the MNC contains only two digits. + +The NR CGI field shall consist of 36 bits. The NR CGI field shall start with Bit 4 of octet 8, which is the most significant bit. Bit 1 of Octet 12 is the least significant bit. The coding of the NR CGI is the responsibility of each administration. Coding using full hexadecimal representation (binary, not ASCII encoding) shall be used. + +## 8.149 UP Security Policy + +UP Security Policy shall be coded as depicted in Figure 8.149-1. + +![](b38817d867550ae783546d5910d4db22_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|--------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 218 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Spare | | | | | | UP IP Policy | | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.149-1: UP Security Policy + +The UP IP Policy field in bits 1 and 2 of octet 5 shall be encoded as follows: + +Table 8.149-1: UP IP Policy + +| Indication | Value (Decimal) | +|--------------------------------------------------------|-----------------| +| User Plane Integrity protection with EPS is not needed | 0 | +| User Plane Integrity protection with EPS is preferred | 1 | +| User Plane Integrity protection with EPS is required | 2 | +| Spare | 3 | + +Bits 3 to 8 in octet 5 are spare, for future use and set to 0. + +## 8.150 Alternative IMSI + +Alternative IMSI is transferred via GTP tunnels. The sending entity copies the value part of the Alternative IMSI into the Value field of the Alternative IMSI IE. Alternative IMSI is in the form of an IMSI as defined in 3GPP TS 23.003 [2]. + +![](2cd72d2716bc151a96eb4e6dd0f17f00_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 219 (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 | Number digit 2 | | | | Number digit 1 | | | | +| 6 | Number digit 4 | | | | Number digit 3 | | | | +| ... | ... | | | | ... | | | | +| n+4 | Number digit m | | | | Number digit m-1 | | | | + +Figure 8.150-1: Alternative IMSI + +Octets 5 to (n+4) represent the Alternative IMSI value in international number format as described in ITU-T Rec E.212 [64], encoded as TBCD digits, i.e. digits from 0 through 9 are encoded "0000" to "1001". When there is an odd number of digits, bits 8 to 5 of the last octet are encoded with the filler "1111". The maximum number of digits is 15. + +## 8.151 NF Instance ID + +The NF Instance ID IE shall be encoded as shown in Figure 8.151-1. It contains the NF Instance ID of an AMF. + +| Octets | Bits | | | | | | | | +|---------|----------------------|---|---|---|----------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 220 (decimal) | | | | | | | | +| 2 to 3 | Length = 36 | | | | | | | | +| 4 | Spare | | | | Instance | | | | +| 5 to 40 | NF Instance ID | | | | | | | | + +Figure 8.151-1: NF Instance ID + +The NF Instance ID field shall be encoded as 36 ASCII characters, as specified in 3GPP TS 29.571 [92]. + +## 8.152 Timer in Seconds + +The Timer in Seconds information element indicates a timer in seconds. + +The Timer in Seconds information element is coded as shown in figure 8.152-1. + +| Octets | Bits | | | | | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|----------|---|---|---|--|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | | +| 1 | Type = 221 (decimal) | | | | | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | | | | | +| 4 | Spare | | | | Instance | | | | | | | | +| 5 to 7 | Timer Value | | | | | | | | | | | | +| 8 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | | | | | + +Figure 8.152-1: Timer in Seconds + +Octets 5 to 7 shall contain the Timer Value, encoded as an unsigned integer in units of seconds. + +--- + +## 9 Security + +GTPv2-C communications shall be protected according to security mechanisms defined in 3GPP TS 33.401 [12]. + +--- + +## 10 IP - The Networking Technology used by GTP + +### 10.1 IP Version + +GTPv2 entities shall support both versions of the Internet Protocol, version 4 (IPv4) as defined by IETF RFC 791 [6], and version 6 (IPv6) as defined by IETF RFC 2460 [16]. + +### 10.2 IP Fragmentation + +It is specified here how the fragmentation mechanism shall work with GTP-C. + +Fragmentation should be avoided if possible. Examples of fragmentation drawbacks are: + +- Fragmentation is inefficient, since the complete IP header is duplicated in each fragment. +- If one fragment is lost, the complete packet has to be discarded. The reason is that no selective retransmission of fragments is possible. + +Path MTU discovery should be used, especially if GTPv2-C message is encapsulated with IPv6 header. The application should find out the path MTU, and thereby utilise more efficient fragmentation mechanisms. + +### 10.3 DSCP + +Based on operator policy, if: + +- GTPv2 entities support using the GTPv2 message priority mechanism as specified in clause 5.4 and clause 12.3.9.3.4 for DSCP marking, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack for transporting GTPv2 messages, + +then the DSCP marking as defined by IETF RFC 2474 [81] shall be set for IP packet carrying this GTPv2 messages based on the priority set in the GTPv2 message header. + +--- + +## 11 Notification of supported features between peer GTP-C entities + +### 11.1 General + +#### 11.1.1 Introduction + +New functionality, i.e. functionality beyond the Rel-9 standard, which can not be specified without backward incompatible changes (e.g. requiring support of a new message or a specific receiver node's behaviour) should be introduced as a feature, see clause 11.1.2. + +A GTP-C entity should verify that a backward incompatible feature is supported by its peer GTP entities before starting to use it. + +NOTE: GTPv2 does not support a Comprehension Required mechanism allowing a sender to force the receiver to support comprehension of some specific IEs as a precondition to process a backward incompatible message. + +Features may be generic node capabilities supported homogeneously for all GTP tunnels, UEs and PDN connections. Such features are referred in this specification as "Node Features". They are signalled with the granularity of a node on all GTPv2 interfaces (i.e. S11, S4, S5, S8, S10, S3, S16, Sv, S101, S121, Sm, Sn, S2a, S2b). A GTP-C entity may discover the features supported by a peer GTP-C entity with which it is in direct contact as specified in clause 11.2.1. + +#### 11.1.2 Defining a feature + +A feature is a function extending the base GTPv2 functionality that has a significant meaning to the operation of GTPv2, i.e. a single new parameter without a substantial meaning to the functionality of the GTPv2 endpoints should not be defined to be a new feature. + +A functionality requiring the definition of a new GTPv2 message or extending the use of an existing message over a new interface should be defined as a feature. + +NOTE: Features are ultimately defined on a case-by-case basis on the merits of defining an extension as a feature. + +Features should be defined so that they are independent from each other. A GTP-C entity may support the same feature over different interfaces, e.g. an SGW may support a feature over both S11 and S4 interface, however support of a feature on a given interface shall not depend on the support of the same or another feature on another interface. + +## 11.2 Dynamic discovery of supported features + +### 11.2.1 General + +A node supporting at least one feature defined in the Node Features IE shall support dynamic discovery of supported features as specified in the following clauses. + +## 11.2.2 Features supported by direct peer GTP-C entities + +A node shall signal to a direct peer node the list of features it supports by sending the Sending Node Features IE in every Echo Request and Echo Response messages to that node. + +An exception to this is where the sending node does not support or use any features towards the peer node and is not prepared to accept a message which is constructed by making use of any features. + +The peer receiving the Sending Node Features IE shall store the list of features supported by the sending node per IP address and only update this list based on the Sending Node Features IE in the Echo Request and Echo Response messages, and it shall only use common supported features to initiate subsequent GTPv2 messages towards this IP address. Receipt of an Echo Request or an Echo Response message without the Sending Node Features IE shall indicate that the sending node does not support any feature specified in Table 8.83-1 on the corresponding interface. + +--- + +# 12 GTP-C load & overload control mechanism + +## 12.1 General + +### 12.1.1 GTP-C overload problem + +GTP-C entities can communicate with other GTP-C peers in direct contact (e.g. MME and SGW) or remote GTP-C peers through intermediate GTP-C entities (e.g. MME and PGW via the SGW). In normal conditions, requests sent by a GTP-C entity can be processed by the receiving GTP-C entity which can send back a message indicating the result of the request (success/failure). + +Overload situations in a GTP-C entity occur when the number of incoming requests exceeds the maximum request throughput supported by the receiving GTP-C entity, e.g. when the internal available resources of the GTP-C entity, such as processing power or memory, are not sufficient to serve the number of incoming requests. As a consequence of the overload situation, the receiving GTP-C entity cannot successfully process the exceeding proportion of requests. These requests can be either simply dropped or extremely delayed in the processing. At best, the GTP-C entity may have enough internal resources to send back to the request initiator a message indicating that the requests cannot be successfully processed. Whatever the behaviour of the overloaded GTP-C entities, the rate of successfully processed requests and consequently the overall performances of the network decrease. + +NOTE: GTP-C overload control does not target to address transport network congestion. It assumes a transport network that is still capable to exchange signalling traffic. + +Given the nature of GTP-C protocol in how it relies on retransmissions of unacknowledged requests (GTP-C is carried over UDP transport), when a GTP-C entity experiences overload (or severe overload) the number of unacknowledged GTP-C messages compounds exponentially and can lead to a node congestion or even collapse. An overload or failure of a node can lead to an increase of the load on the other nodes in the network and, in the worst case, turn into a complete network issue via a snowball effect. + +The impact of GTP-C overload to services can be such as: + +- loss of PDN connectivity (IMS, Internet ...) and associated services; +- loss of ability to setup and release radio and core network bearers necessary to support services e.g. GBR bearers for VoLTE or dedicated bearers for Voice over WLAN; +- loss of ability to report to the PGW/PCRF user's information changes, e.g. location information for emergency services and lawful intercept, changes in RAT or QoS; +- and billing errors and a loss of revenue. + +### 12.1.2 Scenarios leading to overload + +Reasons for these temporary overload cases can be many and various in an operational network, such as insufficient internal resource capacity of a GTP-C entity faced with a sudden burst of requests, e.g. after network failure/restart + +procedures affecting a large number of users, deficiency of a GTP-C entity component leading to a drastic reduction of the overall performances of the GTP-C entity. + +Examples of GTP-C signalling based scenarios which can cause GTP-C overload are: + +- a traffic flood resulting from the failure of a network element, inducing a signalling spike, e.g. when the network needs to re-establish the PDN connections affected by the failure of an EPC node; +- a traffic flood resulting from a large number of users performing TAU/RAU or from frequent transitions between idle and connected mode; +- an exceptional event locally generating a traffic spike, e.g. a large amount of calls (and dedicated bearers) being setup almost simultaneously upon a catastrophic event or an exceptional but predictable event (e.g. Christmas, New year) via a 3GPP access or a WLAN access; +- Frequent RAT-reselection due to scattered non-3GPP (e.g. WiFi) coverage or massive mobility between 3GPP and non-3GPP coverage may potentially cause frequent or massive intersystem change activities, i.e. UEs trying to either create PDN connections over the new access or moving PDN connections between 3GPP and non-3GPP coverage. + +Besides, GTP-C load balancing based only on semi-static DNS weights can lead to a load imbalance and thus GTP-C signalling scenarios, such as those mentioned above, may result in an overload of the SGWs or PGWs with the highest load while there is still remaining capacity on other SGWs or PGWs. + +### 12.1.3 Load & overload control concepts + +Load control refers to "GTP-C signalling based Load Control" as defined in clause 4.3.7.1a.1 of 3GPP TS 23.401 [3] and clause 5.3.6.1a of 3GPP TS 23.060 [35]. + +Overload control refers to "GTP-C signaling based Overload Control" as defined in clause 4.3.7.1a.2 of 3GPP TS 23.401 [3] and clause 5.3.6.1a of 3GPP TS 23.060 [35]. + +Load control and overload control are two distinct but complementary concepts: + +- load control enables a GTP-C entity (e.g. an SGW/PGW) to send its load information to a GTP-C peer (e.g. an MME/SGSN, ePDG, TWAN) to adaptively balance the session load across entities supporting the same function (e.g. an SGW cluster) according to their effective load. The load information reflects the operating status of the resources of the GTP-C entity. +- overload control enables a GTP-C entity becoming or being overloaded to gracefully reduce its incoming signalling load by instructing its GTP-C peers to reduce sending traffic according to its available signalling capacity to successfully process the traffic. A GTP-C entity is in overload when it operates over its signalling capacity which results in diminished performance (including impacts to handling of incoming and outgoing traffic). + +Load control allows for better balancing of the session load, so as to attempt to prevent overload in the first place (preventive action). Overload control aims at shedding the incoming traffic as close to the traffic source as possible generally when an overload has occurred (reactive action), so to avoid spreading the problem inside the network and to avoid using resources of intermediate nodes in the network for signalling that would anyhow be discarded by the overloaded node. + +Load control does not trigger overload mitigation actions even if the GTP-C entity reports a high load. + +Load control and overload control may be supported and activated independently in the network. + +## 12.2 Load control solution + +### 12.2.1 Principles of load control + +The stage 2 requirements on GTP-C load control solution are defined in clause 4.3.7.1a.1 of 3GPP TS 23.401 [3] and clause 5.3.6.1a of 3GPP TS 23.060 [35]. The high level principles are summarized below: + +- a) Load Control is an optional feature; + +- b) a GTP-C node may signal its Load Control Information to reflect the operating status of its resources, allowing the receiving GTP-C peer node to use this information to augment the existing GW selection procedures; +- c) the calculation of the Load Control Information is implementation dependent and its calculation and transfer shall not add significant additional load to the node itself and to its corresponding peer nodes; +- d) the Load Control Information may provide load information of a GTP-C node (e.g. a PGW) or, if the APN level load control feature is supported, may provide the load information about specific APN(s); +- e) the SGW may send its Load Control Information to the MME/S4-SGSN. The PGW may send its Load Control Information to the MME/S4-SGSN via the SGW. For non-3GPP access based interfaces, the PGW may send its Load Control Information to the ePDG and TWAN; +- f) the Load Control Information shall be piggybacked in GTP-C request or response messages such that the exchange of Load Control Information does not trigger extra signalling; + +NOTE: The inclusion of Load Control Information in existing messages means that the frequency of transmission of load control information increases as the session load increases, allowing for faster feedback and thus better regulation of the load. + +- g) a node supporting Load Control sends Load Control Information to a peer GTP-C node based on local configuration (see clause 12.2.6); +- h) the format of the Load Control Information shall be specified with enough precision to guarantee a common interpretation of this information allowing interoperability between nodes of different vendors; +- i) for the inter-PLMN case, local configuration may restrict the exchange and use of Load Control Information across PLMNs; +- j) the GTP-C node may decide to send different values of Load Control Information on inter-network (roaming) and on intra-network (non-roaming) interfaces based on local configuration, i.e. the values sent on intra-network interfaces may differ from the values sent on inter-network interfaces. However, on intra-network interfaces, the node should send the same values between the 3GPP and non-3GPP access based interfaces. +- k) the Load Control Information received via GTP-C signalling shall be used in conjunction with the information received from the DNS, during the node selection procedure. Refer to 3GPP TS 29.303 [32] for further details. + +## 12.2.2 Applicability to 3GPP and non-3GPP access based interfaces + +Load Control may be supported on the 3GPP & non-3GPP access based interfaces and nodes as summarized by the Table 12.2.2-1. + +**Table 12.2.2-1: Applicability of Load Control to GTP-C interfaces and nodes** + +| Originator | Consumer | Applicable Interfaces | +|------------|----------|--------------------------------------------------------------------------------| +| PGW | MME | S5/S8, S11
SGW relays Load Control Information from S5/S8 to S11 interface. | +| PGW | S4-SGSN | S5/S8, S4
SGW relays Load Control Information from S5/S8 to S4 interface. | +| SGW | MME | S11 | +| SGW | S4-SGSN | S4 | +| PGW | ePDG | S2b | +| PGW | TWAN | S2a | + +NOTE: Refer to Annex D.1 for information on the GTP-C interfaces for which Load Control is not supported. + +## 12.2.3 Node level load control + +Node level load control refers to advertising of the load information at node level – i.e. load information at node level granularity – and selection of the target node based on this information. It helps to achieve an evenly load balanced network by the use of the dynamic load information provided within the Load Control Information. + +## 12.2.4 APN level load control + +### 12.2.4.1 General + +APN level load control refers to advertising of the load information at APN level granularity and selection of the target node based on this information. It helps to achieve an evenly load balanced network at APN granularity by the use of the dynamic load information provided within the Load Control Information with the APN scope. Only a PGW may advertise APN level load information. + +APN level load control is an optional feature that may be supported when the following pre-condition is applicable. + +#### Pre-Condition: + +In the given network, when the ratio of the configured APN resource to the overall capacity of the PGW is not the same across all the PGWs in the network. + +NOTE: In other cases, e.g. when all the resources of the PGW are available for all the APNs served by that PGW, the node level load information is exactly the same as APN level load information, for each of its APNs, and hence performing node load control is sufficient. + +If APN load control is supported and activated at the PGW, the PGW should advertise the APN load information. If the APN level load control feature is supported at the node performing the PGW selection, i.e. an MME, S4-SGSN, ePDG, TWAN, the node shall utilize this information when selecting the PGW. + +### 12.2.4.2 Justifications for APN load control support + +Following are the justifications to support the APN level load control in the network when the pre-condition specified in 12.2.3.1 is applicable: + +- 1) **To achieve load balancing at the APN level granularity:** The PGW may be configured to handle more than one APN in the network. In such a case, the PGW may be additionally configured to allocate different resources for each of the configured APNs, e.g. the PGW may be configured to handle "X" number of sessions for the "consumer" APN and to handle "Y" number of session for the "corporate" APN. The ratio of this limit, i.e. "X" and "Y", to the PGW's capacity may not be the same across all the PGWs in the network. In this case, the load information with node level granularity is not sufficient and could result in a network where one PGW has more sessions for the "consumer" APN while another PGW has more sessions for the "corporate" APN. Thus, an evenly load balanced network at APN level load granularity cannot be realized. +- 2) **To ensure effective overload control in the network:** If the distribution of sessions at APN level is uneven, then there is a higher risk of overload of some PGWs, as compared to other PGWs, e.g. the PGW handling more sessions for "consumer" APN may have to handle more messages, (e.g. generated due to mobility events resulting from a change of ULI, RAT type, Serving GW, etc.) as compared to the PGW handling more sessions for the "stationary-machine" APN. Hence, the PGW handling "consumer" APN sessions may be at higher risk of overload, as compared to the other PGWs in the network, and hence, this situation may result in poor overload control of the network. +- 3) **To ensure an efficient node selection algorithm:** Based on the node level load information, the source node, (e.g. the MME) may end-up selecting the PGW for a new session for the given APN. However, the selected PGW may reject the new session request, if it is running at 100% load capacity for the given APN, or the new session request may be throttled by the source node based on the overload information of the APN for the given PGW. Thus the new session request may be denied, (i.e. rejected by the selected PGW or throttled by the source node based on PGW's APN level overload information) while the other PGW may have the capacity to handle the same. Thus, the lack of APN level load information may result in inefficient node selection algorithm by the source node. + +### 12.2.4.3 Elements of APN load control + +To allow for an effective APN load control, at least the following information (in addition to the other applicable information for load control as defined in clause 12.2.5.1.2) is required to be advertised by the PGW, as part of the APN level load information: + +**APN:** The APN for which the PGW wants to advertise the load information. + +**APN-Load-Metric:** It indicates the current resource utilization for a particular APN, as a percentage, compared to the total resources reserved for that APN at the target PGW. Its computation is implementation dependent and it has same characteristics as "Load-Metric", as described in clause 12.2.5.1.2.2, when applied at the APN level. + +**APN-relative-capacity:** It indicates the total resources configured for a given APN, compared to the total resources of the target PGW, as a percentage. It is a static parameter and does not change unless the resources configured for the APN change. Using APN-relative-capacity and the DNS weight-factor of the given PGW, the source node can judge the PGW's APN related resources as compared other PGWs in the network, i.e. the PGW's APN-weight-factor can be calculated by multiplying the APN-relative-capacity and DNS-weight-factor of the PGW (PGW's-APN-weight-factor = PGW's-APN-relative-capacity X DNS-weight-factor). + +For the following example configuration: + +PGW1-APN1-relative-capacity = 50%; PGW2-APN1- relative-capacity = 20%; PGW3-APN1- relative-capacity = 10% + +PGW1-weight-factor = 20; PGW2-weight-factor = 20; PGW3-weight-factor = 60; + +The APN level weight-factor for each of the PGWs can be calculated as below: + +PGW1-APN1-weight-factor = 50% X 20 = 10. + +PGW2-APN1-weight-factor = 20% X 20 = 4. + +PGW3-APN1-weight-factor = 10% X 60 = 6. + +Thus, based on the APN-weight-factor it can be concluded that the PGW1 has highest APN1 related resources reserved, as compared to the other PGWs in the network. Hence the source node should use this information to favour PGW1 over other PGWs for APN1 related new session requests. + +## 12.2.5 Load Control Information + +### 12.2.5.1 Definition + +#### 12.2.5.1.1 General description + +Within a message, one or multiple instances of the Load Control Information (LCI) IE may be included by the same GTP-C entity. + +When providing load control information in a message for the first time or subsequently, the GTP-C entity shall always include the full set of load control information, i.e. all the node level and APN Level applicable instances of the Load Control Information, even if only a subset of the load control information has changed. All the instances of the LCI IE provided by a given GTP-C entity in a message shall contain the same Load-Control-Sequence-Number. The Load Control Sequence Number shall be incremented whenever the load control information is changed (see clause 12.2.5.1.2.1). + +The receiver shall overwrite any stored load control information of a peer with the newly received load control information (via one or multiple instances) from the same peer node if the new load control information is more recent than the old information as indicated by the Load Control Sequence Number, e.g. if the receiver has stored 'X' instances of the load control information for a peer node, it overwrites those 'X' instances with the new set of 'Y' instances received in a message from the same peer node, where X, Y are any integer number. + +The receiver shall consider all the parameters received in the same instance of the LCI IE in conjunction while using this information for node selection. When more than one instance of the LCI IE is received, the receiver shall consider the parameters included in each instance independently, when using this information for node selection. + +The parameters are further defined in clauses 12.2.5.1.2 and 12.2.5.1.3. + +Load control information may be extended with new parameters in future versions of the specification. Any new parameter will have to be categorized as: + +- Non-critical optional parameters: the support of these parameters is *not critical* for the receiver. The receiver can successfully and correctly comprehend the load control information instance, containing one or more of these parameters, by using the other parameters and ignoring the non-critical optional parameter. + +- Critical optional parameters: the support of these parameters is *critical* for the receiver to correctly comprehend the instance of the load control information containing one or more of these parameters. + +The sender may include one or more non-critical optional parameters within any instance of the LCI IE without having the knowledge of the receiver's capability to support the same. However, the sender shall only include one or more critical optional parameter in any instance of the LCI IE towards a receiver if the corresponding receiver is known to support those parameters. The sender may be aware of this either via signalling methods or by configuration; (this will have to be defined when introducing any such new parameter in future). + +Each instance of the LCI IE shall be associated to the node identity (FQDN or IP address of the GW node received from the HSS or the DNS) of the serving SGW or PGW, i.e. the identity determined during the SGW or PGW selection. + +NOTE: The Node type is derived based on the instance number of the LCI IE. + +### 12.2.5.1.2 Parameters + +#### 12.2.5.1.2.1 Load Control Sequence Number + +The Load Control Sequence number contains a value that indicates the sequence number associated with the LCI IE. This sequence number shall be used to differentiate any two LCI IEs generated at two different instances by the same GTP-C entity. The Load Control Sequence Number shall be supported (if load control is supported) and shall always be present in the LCI IE. + +The GTP-C entity generating this information shall increment the Load Control Sequence Number whenever modifying some information in the Load Control Information IE. The Load Control Sequence Number shall not be incremented otherwise. The node may use the time, represented in an unsigned integer format, of the generation of the Load Control Information to populate the Load Control Sequence Number. + +When multiple instances of the LCI IE are provided in a message by a given GTP-C node, each of them shall contain the same Load Control Sequence Number value. + +This parameter shall be used by the receiver of the Load Control Information IE to properly collate out-of-order load control information, e.g. due to GTP-C retransmissions. This parameter shall also be used by the receiver of the LCI IE to determine whether the newly received load control information has changed compared to load control information previously received from the same node earlier. + +NOTE: The GTP-C sequence number cannot be used for collating out-of-order load control information as e.g. load control information may be sent in both GTP-C requests and responses, using independent GTP-C sequence numbering. + +If the receiving entity has already received and stored load control information from the peer GTP-C entity, the receiving entity shall update its load control information only if the Load Control Sequence Number received in the new load control information is higher than the stored value of the Load Control Sequence Number associated with the peer GTP-C entity. However due to roll-over of the Load Control Sequence Number or restart of the node, the Load Control Sequence Number may be reset to an appropriate base value by the peer GTP-C entity, hence the receiving entity shall be prepared to receive (and process) a Load Control Sequence Number parameter whose value is less than the previous value. + +#### 12.2.5.1.2.2 Load Metric + +The Load Metric parameter shall indicate the current load level of the originating node. The computation of the Load Metric is left to implementation. The node may consider various aspects, such as: the used capacity of the node based on activated bearers in relationship to maximum number of bearers the node can handle, the load that these active bearers produce in the node (e.g. memory/CPU usage in relationship to the total memory/CPU available, etc.). + +The Load Metric represents the current load level of the sending node as a percentage within the range of 0 to 100, where 0 means no or 0% load and 100 means maximum or 100% load reached (i.e. no further load is desirable). + +The Load Metric shall be supported (if load control is supported). The Load Metric shall always be included in the Load Control Information. + +Considering the processing requirement of the receiver of the Load Control Information (e.g. handling of the new information, tuning the node selection algorithm to take the new information into account), the sender should refrain from advertising every small variation (e.g. with the granularity of 1 or 2), in the Load Metric which does not result in + +useful improvement in node selection logic at the receiver. During the typical operating condition of the sender, a larger variation in the Load Metric, e.g. 5 or more units, should be considered as reasonable enough for advertising the new Load Control Information and thus justifying the processing requirement (to handle the new information) of the receiver. + +NOTE: The range of the Load Metric, i.e. 0 to 100, does not mandate the sender to collect its own load information at every increment/decrement and hence to advertise the change of Load Metric with a granularity of 1%. Based on various implementation specific criteria, such as: the architecture, session and signalling capacity, the current load and so on, the sender is free to define its own logic and periodicity with which its own load information is collected. + +#### 12.2.5.1.2.3 List-of-APN\_and\_Relative Capacity + +The List-of-APN\_and\_Relative Capacity parameter contains a list of the tuple (APN, Relative Capacity) and this indicates one or more APNs for which the Load Control Information is applicable. The "APN" contains the name of the APN and the Relative Capacity indicates the resources configured for a given APN, compared to the total resources configured at the target PGW, as a percentage. + +When present in the LCI IE, the scope of the load information shall be the list of indicated APNs for the PGW that sends the load control information. In that case, the "Load Metric" shall be interpreted as an "APN-Load-Metric" and shall indicate the current resource utilization for the indicated APNs, as a percentage, as compared to the total resources configured for the indicated APNs at the target PGW. + +Its computation is implementation dependent and it has the same characteristics as "Load Metric". Only one instance of the List-Of-APN\_and\_Relative Capacity IE may be included within one Load Control Information instance. + +NOTE 1: The maximum number of tuples (APN, Relative Capacity) in the List-of-APN\_and\_Relative Capacity IE is set to 10. More than 10 occurrences of (APN, Relative Capacity), within one single instance of the List-of-APN\_and\_Relative Capacity IE is treated as protocol error by the receiver. + +If the List-of-APN\_and\_Relative Capacity IE has not been included, the scope of the Load Control Information shall be the entire PGW node (unless restricted by other parameters in the LCI IE). + +This parameter may be supported (if load control is supported) and shall be supported when APN level load control is supported. + +The receiver shall handle this parameter, when it is received, if it supports APN level load control. The receiver shall ignore a Load Control Information instance applicable for an APN, if it does not support APN level load control. + +NOTE 2: The PGW encodes the APN level load information and node level load information using different instance numbers in the message, so that the receiver will ignore the APN level load information, if it does not support the APN level load control feature. + +The maximum number of APNs, for which the PGW may advertise the Load Control Information, shall be limited to 10, i.e. the maximum number of occurrences of the tuple (APN, Relative Capacity) within and across various instances of the LCI IE shall be limited to 10, for a given PGW. Hence, if the PGW supports more than 10 APNs, it shall advertise the load control information for at most 10 of the most important APNs. In future, if needed, this limit may be increased to allow the PGW to advertise the load information for more APNs. In that case, the receiver not supporting the higher limit shall handle the first 10 APNs and shall ignore the load information for the remaining APNs. + +NOTE 3: The limit of the number of APN's takes into account various aspects such as: the processing and storage requirements at the overloaded node and the receiver, the number of important APNs for which load control advertisement will be necessary and interoperability between the nodes. + +When including load control information for some APN(s), the PGW shall also provide node level load control information by providing one instance of the Load Control Information without the List-of-APN\_and\_Relative Capacity parameter. + +A node selecting a PGW for a given APN shall apply the APN level load information, if available for that APN. If this parameter is not received for a given APN but it has been received for other APN(s) from the same PGW, then for this given APN, the node performing PGW selection shall calculate the load metric, as described in 3GPP TS 29.303 [32], for the target PGW. + +### 12.2.5.1.3 Handling of parameters + +If the PLMN supports the Load Control feature (see clause 12.2.6), the support, inclusion and handling of the parameters, within Load Control Information, is summarized in table 12.2.5.1.3-1. + +**Table 12.2.5.1.3-1: Parameters of the Load Control Information** + +| Parameter | Support by the sender | Support by the receiver | Inclusion by the sender | Handling by the receiver | +|-----------------------------------------------------------------------|-----------------------|-------------------------|-------------------------|--------------------------| +| Load Control sequence number (as defined in clause 12.2.5.1.2.1) | Mandatory | Mandatory | Mandatory | Mandatory | +| Load Metric (as defined in clause 12.2.5.1.2.2) | Mandatory | Mandatory | Mandatory | Mandatory | +| List-of-APN_and_Relative Capacity (as defined in clause 12.2.5.1.2.3) | Optional (NOTE 1) | Optional (NOTE 1) | Optional (NOTE 2) | Conditional (NOTE 3) | + +NOTE 1: This is an optional parameter that shall be supported, if APN level load control is supported. +NOTE 2: The PGW shall send this parameter whilst providing APN level load control information, if the APN level load control feature is supported and enabled. +NOTE 3: If this parameter is received, the receiver supporting the APN load control feature shall handle and process APN load control information. + +### 12.2.5.2 Frequency of inclusion + +How often the sender includes the load control information is implementation specific. The sender shall ensure that new/updated load control information is propagated to the target receivers within an acceptable delay, such that the purpose of the information (i.e. effective load balancing) is achieved. The sender may include the LCI IE e.g. as follows: + +- the sender may include Load Control Information towards a peer only when the new/changed value has not already been provided to that peer; +- the sender may include the Load Control Information in each and every message (extended with LCI IE) towards the peer; +- the sender may include Load Control Information periodically, i.e. include the information during a first period then cease to do so during a second period. + +The sender may also implement a combination of one or more of the above approaches. Besides, the sender may also decide to include the Load Control Information only in a subset of the applicable GTP-C messages. + +The receiver shall be prepared to receive the load control information in any of the GTP-C messages extended with an LCI IE and upon such reception, shall be able act upon the received load control information. + +### 12.2.5.3 Limit on maximum number of instances + +A GTP-C entity may signal one or multiple instances of the LCI IE, with each providing load control information for a different scope. In order to limit the processing of the message on the receiver side and the size of the message on transport level, the number of load control information instances shall be limited: + +- at message level: there shall be at most one instance of node level LCI IE per node (i.e. per SGW or PGW) and at most 10 APN level instances. +- at node level: the maximum number of instances of LCI IE which may be provided across multiple messages by a given node shall be the same as the maximum number of instances of LCI IE at message level. + +## 12.2.6 Discovery of the support of the feature by the peer node + +A GTP-C entity shall determine whether to use the load control feature (i.e. provide or handle load control information) + +- within the PLMN, based on the operator's policy (local PLMN-wide configuration); +- across the PLMN boundaries, based on the operator's policy (local configuration per PLMN). + +NOTE: The feature may be activated when all or some of the nodes in the PLMN support the feature. The GTP-C entity assumes that all of the peer nodes support this feature when the feature is activated, i.e. it does not need to determine which peers support the feature. + +The above operator policy/local configuration may allow the use of load control at node level, load control at node level and APN level, or none. + +## 12.2.7 Issues in the network with partial support of the feature + +The Load Control feature should be supported homogeneously across all the SGWs and PGWs in the network. Not supporting this feature homogeneously across the SGWs and PGWs may result in poor load balancing in the network such that the SGWs or PGWs not supporting the feature may operate near their maximum capacity (thus being more vulnerable to overload conditions) while SGWs or PGWs supporting the feature have free capacity. + +The Load Control feature should be supported homogeneously across all the MMEs, S4-SGSNs, ePDGs and TWANs. However, use of the feature when not all of these nodes support the feature may not necessarily create a problem since the load may remain fairly balanced across the SGWs and PGWs assuming that the network imbalance caused by the non-supporting node may get rectified by the supporting nodes making use of dynamic load information while selecting the SGWs and PGWs. + +## 12.3 Overload control solution + +### 12.3.1 Principles of overload control + +The stage 2 requirements on GTP-C overload control are defined in clause 4.3.7.1a.2 of 3GPP TS 23.401 [3] and clause 5.3.6.1a of 3GPP TS 23.060 [35]. The high level principles are summarized below: + +- a) Overload control is an optional feature; +- b) a GTP-C entity may signal its overload to its GTP-C peers by including Overload Control Information in GTP-C signalling which provides guidance to the receiving GTP-C entity to decide actions which lead to signalling traffic mitigation towards the sender of the information; +- c) the Overload Control Information may provide the overload information of a GTP-C entity, e.g. a PGW, or a specific APN(s) associated with the GTP-C entity; +- d) an MME/S4-SGSN may signal an overload to the PGW, via the SGW. An SGW may signal an overload to the MME/S4-SGSN and to the PGW. A PGW may signal an overload to the MME/S4-SGSN, via the SGW. For non-3GPP access based interfaces, a PGW may signal an overload to the ePDG and the TWAN; the ePDG and the TWAN may signal an overload to the PGW. + +NOTE 1: An MME/S4-SGSN will not signal an overload to the SGW (i.e. the SGW will not perform overload control towards the MME/S4-SGSN), as this is redundant with DDN throttling (see clause 12.3.3). + +- e) the overload control feature should continue to allow for preferential treatment of priority users (eMPS) and emergency services; +- f) the Overload Control Information is piggybacked in GTP control plane request or response messages such that the exchange of the Overload Control Information does not trigger extra signalling; + +NOTE 2: The inclusion of Overload Control Information in existing messages means that the frequency increases as the signalling load increases, thus allowing faster feedback and better regulation. + +- g) the computation and transfer of the Overload Control Information shall not add significant additional load to the GTP-C entity itself and to its corresponding peer GTP-C entities. The calculation of Overload Control Information should not severely impact the resource utilization of the GTP-C entity, especially considering the overload situation; +- h) clause 4.3.7.1a.2 of 3GPP TS 23.401 [3] and clause 4.5 of 3GPP TS 23.402 [45] provides examples of various potential overload mitigation actions based on the reception of the overload related information exchanged between GTP-C entities, for 3GPP access based interfaces and non-3GPP access based interfaces, respectively. However, the exact internal processing logics of a GTP-C entity will not be standardized; + +- i) for the inter-PLMN case, local configuration may restrict the exchange and use of Overload Control Information across PLMNs; +- j) the GTP-C entity may decide to send different values of Overload Control Information on inter-network (roaming) and on intra-network (non-roaming) interfaces based on local configuration, i.e. the values sent on intra-network interfaces may differ from the values sent on inter-network interfaces. However, on intra-network interfaces, the GTP-C entity should send the same values between the 3GPP and non-3GPP access based interfaces; + +### 12.3.2 Applicability to 3GPP and non-3GPP access based interfaces + +The Overload Control feature may be supported on the 3GPP & non-3GPP access based interfaces and nodes as summarized by the Table 12.3.2-1. + +**Table 12.3.2-1: Applicability of overload control to 3GPP & non-3GPP access based GTP-C interfaces and nodes** + +| Originator | Consumer | Applicable Interfaces | +|------------|----------|------------------------------------------------------------------------------------| +| MME | PGW | S11, S5/S8
SGW relays Overload Control Information from S11 to S5/S8 interface. | +| S4-SGSN | PGW | S4, S5/S8
SGW relays Overload Control Information from S4 to S5/S8 interface. | +| SGW | MME | S11 | +| SGW | S4-SGSN | S4 | +| SGW | PGW | S5/S8
(in MME/S4-SGSN originated signalling towards the PGW) | +| PGW | MME | S5/S8, S11
SGW relays Overload Control Information from S5/S8 to S11 interface. | +| PGW | S4-SGSN | S5/S8, S4
SGW relays Overload Control Information from S5/S8 to S4 interface. | +| PGW | TWAN | S2a (Trusted WLAN access) | +| PGW | ePDG | S2b (Untrusted WLAN access) | +| TWAN | PGW | S2a (Trusted WLAN access) | +| ePDG | PGW | S2b (Untrusted WLAN access) | + +NOTE: Refer to Annex D.2 for information on the GTP-C interfaces for which Overload Control is not supported. + +### 12.3.3 Node level overload control + +Node level overload control refers to advertising of the overload information at node level, i.e. overload information at node level granularity, and applying the mitigation policies towards the target node based on this information. This helps in preventing severe overload and hence potential breakdown of the GTP-C node. + +When a GTP-C entity determines that the offered incoming signalling traffic is growing (or is about to grow) beyond its nominal capacity, it may signal an Overload Control Information IE to instruct its GTP-C peers to reduce the offered load accordingly. + +Overload Control is performed independently for each direction between two GTP-C entities. Overload Control may run concurrently, but independently, for each direction between the two GTP-C entities. + +Overload control of SGW originated traffic towards the MME/S4-SGSN shall rely on Downlink Data Notification throttling, as specified in clause 4.3.7.4.1a of 3GPP TS 23.401 [3] and 5.3.6.5 of 3GPP TS 23.060 [35], with the addition that the SGWs should be allowed, by configuration, to throttle DDN requests for low priority, as well as normal priority traffic (the SGW shall then throttle by priority DDN requests for low priority traffic). + +### 12.3.4 APN level overload control + +#### 12.3.4.1 General + +APN level overload control refers to advertising of the overload information at APN level granularity and hence applying the mitigation policies based on this information to the signalling traffic related to this APN only. Only a PGW may advertise APN level overload information when it detects overload for certain APNs, e.g. based on shortage of internal or external resources for an APN (e.g. IP address pool). + +NOTE: When all the internal and external resources, applicable to the APNs, are available for all the APNs served by a PGW, the node level overload information is exactly the same as APN level overload information of that PGW, for each of its APNs, and hence, performing node overload control can be sufficient. + +#### 12.3.4.2 Elements of APN overload control + +For allowing the effective APN overload control, at least the following information (in addition to the other applicable information for overload control as defined in clause 12.3.5.1.2) are required to be advertised by the source node, as part of the APN level overload information: + +**APN:** The APN for which the source node wants to advertise the overload information; + +**APN-Overload-Reduction-Metric:** It indicates the requested overload reduction for the signalling traffic corresponding to a particular APN, as a percentage. Its computation is implementation dependent and it has the same characteristics as the "Overload-Reduction-Metric", described in clause 12.3.5.1.2.1, when applied at APN level. + +### 12.3.5 Overload Control Information + +#### 12.3.5.1 Definition + +##### 12.3.5.1.1 General description + +Within a message, one or multiple instances of the Overload Control Information (OCI) IE may be included by the same GTP-C entity. Each instance shall provide information about the overload condition to allow the receiver to apply mitigation actions which will result in an efficient alleviation of the overload condition at the sender. + +The GTP-C entity shall always include the full set of overload control information, i.e. all the node level and/or APN level applicable instances of the OCI IE, when signalling overload control information in a message for the first time or subsequently towards the receiver, even when only a subset of the overload control information has changed. All the instances of the OCI IE provided by a given GTP-C entity in a message shall contain the same Overload Control Sequence Number. The Overload Control Sequence Number shall be incremented whenever the overload control information is modified (see clause 12.3.5.1.2.1). + +When including overload control information for some APN(s), the PGW should not provide any node level Overload Control Information unless the node level information is also applicable. + +The receiver shall overwrite any stored overload control information of a peer with the newly received overload control information (received via one or multiple instances of OCI IE) from the same GTP-C peer entity, if the new information is more recent than the old information as indicated by the Overload Control Sequence Number, e.g. if the receiver has stored 'X' instances of the OCI IE for a peer GTP-C entity, it shall overwrite those 'X' instances with the new set of 'Y' instances received in a message from the same GTP-C peer entity, where X, Y are any integer numbers. + +The receiver shall consider all the parameters received in the same instance of the OCI IE in conjunction while applying the overload mitigation action. When more than one instance of the OCI IE is included, the receiver shall consider the parameters included in each instance independently, while applying the overload mitigation action. + +The parameters are further described in clauses 12.3.5.1.2 and 12.3.5.1.3. + +Overload control information may be extended with new parameters in future versions of the specification. Any new parameter will have to be categorized as: + +- Non-critical optional parameters: the support of these parameters is not critical for the receiver. The receiver can successfully and correctly comprehend the Overload Control Information instance, containing one or more of these parameters, by using the other parameters and ignoring the non-critical optional parameters. +- Critical optional parameters: the support of these parameters is critical for the receiver to correctly comprehend the instance of the Overload Control Information containing one or more of these parameters. + +The sender may include one or more non-critical optional parameter(s) within any instance of Overload Control Information, without having the knowledge of the receiver's capability to support the same. However, the sender shall only include one or more critical optional parameter(s) in any instance of Overload Control Information towards a receiver, if the corresponding receiver is known to support these parameter(s). The sender may be aware of this either via signalling methods or by configuration; this will have to be defined when introducing any such new parameter in the future. + +Each instance of the OCI shall be associated by default to the GTP-C entity corresponding to the peer node's IP address of the PDN connection, over which the OCI IE is received, i.e. to the IP address received within the "Sender F-TEID for control plane" IE, the "PGW S5/S8/ S2a/S2b F-TEID for PMIP based interface or for GTP based Control Plane interface" IE or within the "MME/S4-SGSN Identifier" IE. + +Alternatively, the GW (i.e. SGW and PGW) nodes may send Overload Control Information which is associated with the GW node's identity, i.e. the FQDN or IP address of the GW node received from the HSS (for a PGW) or the DNS (for an SGW or PGW), the identity determined during the GW selection. In that case, the GW node shall provide an explicit indication that the OCI IE included in the message belongs to the GW node's identity. + +### 12.3.5.1.2 Parameters + +#### 12.3.5.1.2.1 Overload Control Sequence Number + +The GTP-C protocol requires retransmitted messages to have the same contents as the original message (see clause 7.6). Due to GTP-C retransmissions, the overload control information received by a GTP-C entity at a given time may be less recent than the overload control information already received from the same GTP-C entity. The Overload Control Sequence Number aids in sequencing the overload control information received from an overloaded GTP-C entity. The Overload Control Sequence Number contains a value that indicates the sequence number associated with the Overload Control Information IE. This sequence number shall be used to differentiate between two OCI IEs generated at two different instants, by the same GTP-C entity. + +The Overload Control Sequence Number parameter shall be supported (when supporting the overload control feature) and shall always be present in the Overload Control Information IE. + +The GTP-C entity generating this information shall increment the Overload Control Sequence Number whenever modifying some information in the OCI IE. The Overload Control Sequence Number shall not be incremented otherwise. The GTP-C entity may use the time, represented in an unsigned integer format, of the generation of the overload control information, to populate the Overload Control Sequence Number. + +When multiple instances of the OCI IE are provided in the same message by a given GTP-C entity, each of the Overload Control Sequence Numbers shall have the same value. + +This parameter shall be used by the receiver of the OCI IE to properly collate out-of-order OCI IEs, e.g. due to GTP-C retransmissions. This parameter shall also be used by the receiver of the OCI IE to determine whether the newly received overload control information has changed compared to the overload control information previously received from the same GTP-C entity. If the newly received overload control information has the same Overload Control Sequence Number as the previously received overload control information from the same GTP-C peer, then the receiver may simply discard the newly received overload control information whilst continuing to apply the overload abatement procedures, as per the previous value. + +NOTE 1: The timer corresponding to the Period of Validity (see 12.3.5.1.2.2) is not restarted if the newly received overload control information has the same Overload Control Sequence Number as the previously received overload control information. If the overload condition persists and the overloaded GTP-C entity needs to extend the duration during which the overload information applies, the sender needs to provide a new overload control information with an incremented Overload Control Sequence Number (even if the parameters within the overload control information have not changed). + +NOTE 2: The GTP-C Sequence Number cannot be used for collating out-of-order overload information as e.g. overload control information may be sent in both GTP-C requests and responses, using independent GTP-C sequence numbering. + +If the receiving GTP-C entity already received and stored overload control information, which is still valid, from the overloaded GTP-C entity, the receiving entity shall update its overload control information, only if the Overload-Sequence-Number received in the new overload control information is larger than the value of the Overload Control Sequence Number associated with the stored information. However due to roll-over of the Overload Control Sequence Number or restart of the GTP-C entity, the Overload Control Sequence Number may be reset to an appropriate base value by the peer GTP-C entity, hence the receiving entity shall be prepared to receive (and process) an Overload Control Sequence Number parameter whose value is less than the previous value. + +#### 12.3.5.1.2.2 Period of Validity + +The Period of Validity indicates the length of time during which the overload condition specified by the OCI IE is to be considered as valid (unless overridden by subsequent new overload control information). + +An overload condition shall be considered as valid from the time the OCI IE is received until the period of validity expires or until another OCI IE with a new set of information (identified using the Overload Control Sequence Number) is received from the same GTP-C entity (at which point the newly received overload control information shall prevail). The timer corresponding to the period of validity shall be restarted each time an OCI IE with a new set of information (identified using the Overload Control Sequence Number) is received. When this timer expires, the last received overload control information shall be considered outdated and obsolete, i.e. any associated overload condition shall be considered to have ceased. + +The Period of Validity parameter shall be supported (when supporting overload control). + +The Period of Validity parameter achieves the following: + +- it avoids the need for the overloaded GTP-C entity to include the Overload Control Information IE in every GTP-C messages it signals to its GTP-C peers when the overload state does not change; thus it minimizes the processing required at the overloaded GTP-C entity and its GTP-C peers upon sending/receiving GTP-C signalling; +- it allows to reset the overload condition after some time in the GTP-C peers having received an overload indication from the overloaded GTP-C entity, e.g. if no signalling traffic takes place between these GTP-C entities for some time due to overload mitigation actions. This also removes the need for the overloaded GTP-C entity to remember the list of GTP-C entities to which it has sent a non-null overload reduction metric and to which it would subsequently need to signal when the overload condition ceases, if the Period of Validity parameter was not defined. + +#### 12.3.5.1.2.3 Overload Reduction Metric + +The Overload Reduction Metric shall have a value in the range of 0 to 100 (inclusive) which indicates the percentage of traffic reduction the sender of the overload control information requests the receiver to apply. An Overload Reduction Metric of "0" always indicates that the GTP-C entity is not in overload (that is, no overload abatement procedures need to be applied) for the indicated scope. + +Considering the processing requirement of the receiver of the Overload Control Information, e.g. to perform overload control based on the updated Overload Reduction Metric, the sender should refrain from advertising every small variation, e.g. with the granularity of 1 or 2, in the Overload Reduction Metric which does not result in useful improvement for mitigating the overload situation. During the typical operating condition of the sender, a larger variation in the Overload Reduction Metric, e.g. 5 or more units, should be considered as reasonable enough for advertising a new Overload Reduction Metric Information and thus justifying the processing requirement (to handle the new information) of the receiver. + +NOTE: The range of Overload Reduction Metric, i.e. 0 to 100, does not mandate the sender to collect its own overload information at every increment/decrement and hence to advertise the change of Overload Reduction Metric with a granularity of 1%. Based on various implementation specific criteria, such as the architecture, session and signalling capacity, the current load/overload situation and so on, the sender is free to define its own logic and periodicity with which its own overload control information is collected. + +The computation of the exact value for this parameter is left as an implementation choice at the sending GTP-C entity. + +The Overload Reduction Metric shall be supported (when supporting overload control) and shall always be present in the OCI IE. + +The inclusion of the OCI IE signals an overload situation is occurring, unless the Overload Reduction Metric is set to 0, which signals that the overload condition has ceased. Conversely, the absence of the OCI IE in a message does not mean that the overload has abated. + +#### 12.3.5.1.2.4 List of APNs + +The List of APNs IE indicates one or more APNs for which the Overload Control Information is applicable. When present in the OCI IE, the scope of the overload control information shall be the list of the indicated APNs for the PGW that sends the overload control information. At most one instance of the List of APNs IE shall be included within one Overload Control Information instance. + +NOTE 1: The maximum number of APNs in the List of APNs is set to 10. More than 10 occurrences of APN within one single instance of the List of APNs IE is treated as a protocol error by the receiver. + +If the List of APNs IE has not been included, the scope of the Overload Control Information shall be the entire GTP-C entity (unless restricted by other parameters in the Overload Control Information IE). + +The List of APNs parameter shall be supported (when supporting overload control). The List of APNs may be present or absent in the Overload Control Information IE (depending on the scope of the reported overload control information). + +NOTE 2: The instance number of both the node-level and APN-level overload control information is "0" and the instance number is therefore not used to indicate if the scope of the overload control information is on PGW node level or APN level. + +This parameter may be provided by the PGW only and it shall be used by the MME/S4-SGSN and the TWAN/ePDG only. + +The maximum number of APNs, for which the PGW may advertise the Overload Control Information, shall be limited to 10, i.e. the maximum number of occurrences of APNs within and across various instances of the Overload Control Information IE shall be limited to 10 for a given PGW. Hence, if the PGW supports more than 10 APNs, it shall advertise the overload control for at most 10 of the most important APNs. In future, if needed, this limit may be increased to allow the PGW to advertise the overload information for more APNs. In that case, the receiver that does not support the higher limit shall only handle the first 10 APNs and ignore the overload information for the remaining APNs to enable future compatibility. + +NOTE 3: Considering various aspects such as: the processing and storage requirements at the overloaded GTP-C entity and the receiver, the number of important APNs for which overload control advertisement could be necessary, interoperability between the nodes of various vendors, etc. it was decided to define a limit on maximum number of APNs for advertising the overload control information. It was decided to fix this limit to 10 whilst also ensuring that the mechanism exists to extend this limit in future releases, if required. + +#### 12.3.5.1.3 Handling of parameters + +If the PLMN supports the Overload Control feature (see clause 12.3.11), the support, inclusion and handling of the parameters, within overload control information, is summarized in table 12.3.5.1.3-1. + +**Table 12.3.5.1.3-1: Parameters of the Overload Control Information** + +| Parameter | Support by the sender | Support by the receiver | Inclusion by the sender | Handling by the receiver | +|----------------------------------------------------------------------|------------------------------|--------------------------------|--------------------------------|---------------------------------| +| Overload Control Sequence Number (as defined in clause 12.3.5.1.2.1) | Mandatory | Mandatory | Mandatory | Mandatory | +| Period of Validity (as defined in clause 12.3.5.1.2.2) | Mandatory | Mandatory | Mandatory | Mandatory | +| Overload Reduction Metric (as defined in clause 12.3.5.1.2.3) | Mandatory | Mandatory | Mandatory | Mandatory | +| List of APNs (as defined in clause 12.3.5.1.2.4) | Mandatory | Mandatory | Optional (NOTE 1) | Conditional (NOTE 2) | + +NOTE 1: The PGW shall send this parameter whilst providing APN level overload control information. + +NOTE 2: If this parameter is received, the receiver shall handle and process APN level overload control information. + +### 12.3.5.2 Frequency of inclusion + +How often or when the sender includes the overload control information is implementation specific. The sender shall ensure that new/updated overload control information is propagated to the target receivers with an acceptable delay, such that the purpose of the information, (i.e. the effective overload control protection) is achieved. The following are some of the potential approaches the sender may implement for including the OCI IE: + +- the sender may include OCI IE towards a receiver only when the new/changed value has not already been provided to the given receiver; +- the sender may include the OCI IE in a subset of the messages towards the receiver; +- the sender may include the OCI IE periodically, i.e. include the information during a first period then cease to do so during a second period. + +The sender may also implement a combination of one or more of the above approaches. Besides, the sender may also include the OCI IE only in a subset of the applicable GTP-C messages. + +The receiver shall be prepared to receive the overload control information received in any of the GTP-C messages extended with an OCI IE and upon such reception, shall be able act upon the received information. + +### 12.3.5.3 Limit on maximum number of instances + +A GTP-C entity may signal one or multiple instances of the OCI IE, each instance providing overload control information for a different scope. The receiver shall handle all these instances, from each of the peer GTP-C entities, by processing, storing and acting upon the same for overload control. In order to limit the processing of the message on the receiver side and the size of the message, the number of overload control information instances shall be limited: + +- at message level: there shall be at most one instance of node-level Overload Control Information IE per node and at most 10 APN-level instances. +- at node level: the maximum number of instances of the OCI IE which may be provided across multiple messages by a given node shall be the same as the maximum number of instances of the OCI IE at message level. + +## 12.3.6 Propagating the MME/S4-SGSN identity to the PGW + +When the Overload Control feature is supported by the MME/S4-SGSN and the SGW, and it is also activated for the PLMN to which the PGW belongs (see clause 12.3.11), the following shall apply: + +- The MME/S4-SGSN shall include the MME/S4-SGSN identity towards the SGW during: + - the PDN connection establishment, any mobility with an MME/S4-SGSN change or any SGW change procedures; + - the dedicated bearer activation procedure, PGW initiated bearer modification procedure and PGW initiated bearer deactivation procedure as per the conditions specified in the corresponding messages. + +- The SGW shall forward the MME/S4-SGSN identifier to the PGW if it is received in the Create/Update/Delete Bearer Response messages. When it is received in other GTP-C messages, the SGW shall store the received MME/S4-SGSN identity and shall include the currently serving MME/S4-SGSN's identity in subsequent Modify Bearer Request messages which are sent over the S5/S8 interface, whenever there is signalling over the S5/S8 interface. + +NOTE: This allows updating of the PGW with the identity of the new MME/S4-SGSN during inter-MME/SGSN mobility scenarios as early as possible and without generating extra signalling over the S5/S8 interface. Inter-MME/inter-SGSN intra SGW mobility scenarios not requiring to send any S5/S8 signalling could result in the PGW not being updated with the currently serving MME/S4-SGSN's identity, for a given subscriber, until subsequent S5/S8 signalling takes place for the same PDN connection. However, considering these scenarios are not so frequent and considering that several features anyway require S5/S8 signalling during these scenarios (e.g. for user location reporting), the PGW will most often get the identity of the currently serving MME/S4-SGSN. Hence the risk that the PGW wrongly throttles PGW initiated signalling for that PDN connection, if the old MME/S4-SGSN is in overload, is low. + +- The PGW shall store the currently serving MME/S4-SGSN identity, received from the SGW, to be able to reduce the PGW initiated signalling messages for the PDN connections during an overload situation at the serving MME/S4-SGSN. + +### 12.3.7 Updating the PGW with overload control information of the target MME/S4-SGSN + +During inter-MME/S4-SGSN mobility without SGW change scenarios, the SGW shall forward the MME/S4-SGSN's overload control information over the S5/S8 interface only if the Modify Bearer Request message needs to be sent over the S5/S8 for another reason, e.g. if the ULI, CGI, Serving Network, needs to be reported to the PGW, i.e. the SGW shall not generate a Modify Bearer Request message over the S5/S8 interface for the sole purpose of reporting the MME/S4-SGSN's overload control information. This avoids generating extra signalling over the S5/S8 interface. + +NOTE: If the MME/S4-SGSN provides overload control information during the scenarios which do not result in S5/S8 signaling, e.g. during an inter MME/S4-SGSN and intra SGW mobility, when no other information such as: the ULI, CGI or Serving Network, needs to be reported to the PGW, the overload information will not be relayed on to the PGW. Hence, the MME/S4-SGSN needs consider this when including overload control information. + +### 12.3.8 The interaction with APN congestion control using the PGW Back-Off Time + +When detecting that a given APN is congested, the PGW shall either use the PGW Back-Off Time mechanism (see clause 4.3.7.5 of 3GPP TS 23.401 [3]) or the APN level overload control mechanism (i.e. providing an Overload Control Information IE with an APN-List included) for that APN, but not both together for the same APN, e.g. if the PGW provides an Overload Control Information IE with an APN-List set to "APN1", it shall not reject Create Session Request messages for "APN1" with a PGW Back-Off Time until the Period-Of-Validity of the overload information previously sent has expired. + +The PGW may however use both mechanisms concurrently for different APNs, e.g. the PGW may reject Create Session Request messages for the "APN2" with a PGW Back-Off Time IE, if the APN2 is also congested and if there is no on-going APN-level overload control mechanism for that APN. + +When rejecting a Create Session Request due to APN congestion, the PGW shall set the "APN Congestion" cause, regardless of the aforementioned mechanisms. + +If the MME/S4-SGSN or ePDG/TWAN has one mechanism active for a given APN and PGW, (e.g. an MME has received a PGW Back-Off Time) and if subsequently it receives information for the same APN and PGW for another mechanism, (e.g. the MME receives an Overload Control Info IE with APN-List included for the same APN), then it shall deactivate/stop the earlier mechanism and consider only the information received for the latter mechanism. + +Different PGWs may use concurrently different mechanisms for the same APN. + +## 12.3.9 Message throttling + +### 12.3.9.1 General + +As part of the overload mitigation, a GTP-C entity shall reduce the total number of messages, which would have been sent otherwise, towards the overloaded peer based on the information received within the Overload Control Information. This shall be achieved by discarding a fraction of the messages in proportion to the overload level of the target peer. This is called message throttling. + +Message throttling shall only apply to initial messages. Triggered request or response messages should not be throttled since that would result in the retransmission of the corresponding request message by the sender. + +Before piggybacking the initial message over a response message, the initial message should be subject to the message throttling in the similar manner as any other non-piggybacked initial message. If the node decides to throttle this initial message then the response message should be sent without any piggyback message. + +A GTP-C entity supporting GTP-C overload control shall support and use the "Loss" algorithm as specified in this clause, for message throttling. + +### 12.3.9.2 Throttling algorithm – "Loss" + +#### 12.3.9.2.1 Description + +An overloaded GTP-C entity shall ask its peers to reduce the number of requests they would ordinarily send by signalling Overload Control Information including the requested traffic reduction, as a percentage, within the "Overload-Reduction-Metric", as specified in clause 12.3.5.1.2.1. + +The recipients of the "Overload-Reduction-Metric" shall reduce the number of requests sent by that percentage, either by redirecting them to an alternate destination if possible (e.g. the Create Session Request message may be redirected to an alternate SGW/PGW), or by failing the request and treating it as if it was rejected by the destination GTP-C entity. + +For example, if a sender requests another peer to reduce the traffic it is sending by 10%, then that peer shall throttle 10% of the traffic that would have otherwise been sent to this GTP-C entity. + +The overloaded GTP-C entity should periodically adjust the requested traffic reduction based e.g. on the traffic reduction factor that is currently in use, the current system utilization (i.e. the overload level) and the desired system utilization (i.e. the target load level), and/or the rate of the current overall received traffic. + +Annex D.3.1 provides an (informative) example of a possible implementation of the "Loss" algorithm, amongst other possible methods. + +NOTE 1: This algorithm does not guarantee that the future traffic towards the overloaded GTP-C entity will be less than the past traffic but it ensures that the total traffic sent towards the overloaded GTP-C entity is less than what would have been sent without any throttling in place. If after requesting a certain reduction in traffic, the overloaded GTP-C entity receives more traffic than in the past, whilst still in overload, leading to the worsening rather than an improvement in the overload level, then the overloaded GTP-C entity can request for more reduction in traffic. Thus, by periodically adjusting the requested traffic reduction, the overloaded node can ensure that it receives, approximately, the amount of traffic which it can handle. + +NOTE 2: Since the reduction is requested as a percentage, and not as an absolute amount, this algorithm achieves a good useful throughput towards the overloaded node when the traffic conditions vary at the source nodes (depending upon the events generated towards these source nodes by other entities in the network), as a potential increase of traffic from some source nodes can possibly be compensated by a potential decrease of traffic from other source nodes. + +### 12.3.9.3 Message prioritization + +#### 12.3.9.3.1 Description + +When performing message throttling: + +- GTP requests related to priority traffic (i.e. eMPS as described in 3GPP TS 22.153 [62]) and emergency have the highest priority. Depending on regional/national requirements and network operator policy, these GTP requests shall be the last to be throttled, when applying traffic reduction, and the priority traffic shall be exempted from throttling due to GTP overload control up to the point where the requested traffic reduction cannot be achieved without throttling the priority traffic; + +NOTE 1: For non-3GPP access, eMPS traffic is determined based on the MPS subscription from the UE USIM as specified in 3GPP TS 24.302 [63] clause 7.2.2.1 and clause 7.4.1.1 or the MPS subscription for the UE from the HSS as specified in 3GPP TS 29.273 [68] clause 5.1.2.1.2 and clause 7.1.2.1.2. + +- for other types of sessions, messages throttling should consider the relative priority of the messages so that the messages which are considered as low priority are considered for throttling before the other messages. The relative priority of the messages may be derived from the relative priority of the procedure for which the message is being sent (as specified in clause 12.3.9.3.2) or may be derived from the session parameters (as specified in clause 12.3.9.3.3). + +NOTE 2: A random throttling mechanism, i.e. discarding the messages without any special consideration, could result in an overall poor congestion mitigation mechanism and bad user experience. + +An overloaded node may also apply these message prioritization schemes when handling incoming initial messages during an overloaded condition, as part of the self-protection mechanism (see clause 12.3.10.2.3). + +### 12.3.9.3.2 Based on procedures + +Message prioritization may be performed based on the relative priority of the procedure for which the message is being sent. Procedures are grouped into various categories and each of these categories is assigned a priority. Additionally, within a given category of procedures, messages may be further prioritized based on session parameters such as: APN, QCI, ARP and/or LAPI (as described in clause 12.3.9.3.3). + +Subsequently, messages with a high priority shall be given lower preference to throttle and messages with low priority shall be given higher preference to throttle. + +The grouping of the procedures is not performed based on an individual GTP-C entity but whilst considering all the procedures in general. A GTP-C entity should consider the procedures applicable to it and apply prioritized message throttling based on the category of the procedure, as described below. The categories are listed in decreasing order of priority with category 1 having the highest priority. For each category a non-exhaustive list of messages is provided. Any existing or newly defined message in future should be considered based on the category (as specified below) of the procedure for which the message is sent. + +1. **UE session mobility within and across 3GPP or non-3GPP access:** Procedures involving active or idle mode UE mobility, such that GTP-C signalling is involved, shall be classified under this category. Some examples are X2/S1 based handover with/without an SGW change, TAU/RAU with a change of MME/SGSN with/without an SGW change, 3GPP access to trusted non-3GPP access handover, etc. Throttling of these messages, during the procedures related to UE session mobility, would result in the failure of the corresponding procedures. This could result potentially in the loss of the PDN connection and/or the interruption of the services. Hence, the messages, as identified below, when sent during the procedures belonging to this category, shall be considered with the highest priority and hence, shall be given the lowest preference to throttle. + - Create Session Request, + - Create Session Request with "handover" indication bit set, + - Modify Bearer Request, + - Modify Bearer Request with "handover" indication bit set, + - Modify Access Bearer Request. +2. **Release of PDN connection or bearer resources:** Procedures resulting in the deactivation of an existing PDN connection, the deactivation of bearer(s) or of data forwarding tunnel of an UE leads to freeing up of the resources at the overloaded node and hence, can potentially ease the overload situation, since the freed up resources can be used for serving the remaining of the UEs. Thus, the messages belonging to this category resulting in the deactivation of PDN connection or bearer(s) or data forwarding tunnel(s), as identified below, shall be treated with the next lower level of priority and hence shall be given the corresponding preference whilst throttling: + - Delete Session Request, + - Delete Bearer Request, + - Delete Bearer Command, + +- Delete Indirect Data Forwarding Tunnel Request. +3. **Miscellaneous session management procedures:** This category shall consist of the session management procedures, except PDN connection creation and bearer creation/modification procedures. Some examples are location reporting, when it is not combined with other mobility procedures, Service request and S1 release procedure. These procedures do not severely impact the on-going service of the UE. Hence, the messages, as identified below, when sent during the procedures identified under this category, shall be treated with the next lower level of priority and hence, shall be given the corresponding preference whilst throttling: +- Release Access Bearer Request, + - Modify Bearer Request, + - Change Notification, + - Suspend Notification, + - Resume Notification. +4. **Request for new PDN Connection or bearer resources:** Procedures requesting the creation of PDN connection, creation or modification of bearer(s) or creation of data forwarding tunnel shall be classified in this category. Throttling of the messages belonging to this category would result in denial of new services while continuing with the existing services. However, this is the natural outcome of an overload condition, i.e. the overloaded node, due to lack of resources, is not able to provision new services while the trying to maintain the existing services and hence, the messages, as identified below, when sent during the procedures belonging to this category, shall be considered with the lowest level of priority and hence shall be given highest preference to throttle: +- Create Session Request during PDN connection request, + - Create Bearer Request, + - Update Bearer Request, + - Bearer Resource Command, + - Modify Bearer Command, + - Create Indirect Data Forwarding Tunnel Request. + +### 12.3.9.3.3 Based on session parameters + +Message prioritization may be performed based on the session parameters, such as: APN, QCI, ARP and/or Low Access Priority Indicator (LAPI). The procedures and messages associated with the higher priority sessions shall be given lesser preference whilst throttling, as compared to the procedures and messages associated with the lower priority sessions. Within each group of sessions, the messages may be further prioritized based on the category of the procedure for which the message is being sent (as described in clause 12.3.9.3.2). + +NOTE: This type of prioritization scheme ensures a good handling of all the messages and procedures related to higher priority sessions but can lead to throttle messages related to a critical procedure, e.g. UE mobility, for lower priority sessions over messages related to less critical procedures, e.g. location reporting, for a higher priority session. + +### 12.3.9.3.4 Based on the Message Priority signalled in the GTP-C message + +Message prioritization may be performed by an overloaded node, when handling incoming messages during an overloaded condition, based on the relative GTP-C message priority signalled in the GTP-C header (see clauses 5.4 and 5.5). + +A GTP-C entity shall determine whether to set and use the message priority in GTP-C signalling within the PLMN and/or across the PLMN boundaries, based on operator policy and roaming agreements. The following requirements shall apply if being used. + +A sending GTP-C entity shall determine the relative message priority to signal in the message according to the principles specified in clause 12.3.9.3.1. If the message affects multiple bearers (e.g. Modify Bearer Request), the relative message priority should be determined considering the highest priority ARP among all the bearers. + +A GTP-C entity should set the same message priority in a Triggered message or Triggered Reply message as received in the corresponding Initial message or Triggered message respectively. + +The message priority values sent on intra-network interfaces may differ from the values sent on inter-network interfaces. When messages cross PLMN boundaries, the Message Priority in the GTP-C header may be stripped or modified in these messages. + +NOTE : This is to take into account that the priority definitions can vary between PLMNs and avoid messages from a foreign PLMN to gain unwarranted preferential treatment. + +For incoming GTP-C messages that do not have a message priority in the GTP-C header, the receiving GTP-C entity: + +- shall apply a default priority, if the incoming message is an Initial message; +- should apply the message priority sent in the Initial message or Triggered message, if the incoming message is a Triggered or Triggered Reply message (respectively). + +This feature should be supported homogeneously across the nodes in the network, otherwise an overloaded node will process initial messages received from the non-supporting nodes according to the default priority while initial messages received from supporting nodes will be processed according to the message priority signalled in the GTP-C message. + +## 12.3.10 Enforcement of overload control + +### 12.3.10.1 General + +When a GTP-C entity receives Overload Control Information from its peer, it shall apply the overload abatement algorithm, based on the received information, for the messages sent towards the peer GTP-C entity. This is called "enforcement of overload control" and it involves throttling of the messages targeted for the overloaded peer. + +### 12.3.10.2 Aspects related to enforcement of the overload control + +#### 12.3.10.2.1 Good throughout of the network + +A source GTP-C entity should avoid any mechanism resulting in over throttling of the messages. Enforcement of the overload control whilst ensuring that good throughout (i.e. measured in terms of the rate of total number of messages the overloaded GTP-C entity can successfully process) of the network remains consistent to that when no overload control is applied, should be one of the prime objective of the source GTP-C entity. + +NOTE: Over throttling of messages would negatively affect end user services and cause potential additional signalling in the network e.g. if the corresponding procedure is retried at a later time. + +#### 12.3.10.2.2 Message processing efficiency at the source GTP-C entity + +Enforcement of overload control requires extra logic and extra processing at the source GTP-C entity. This is an overhead since the source GTP-C entity has to spend its resources in an activity other than processing of the messages. Hence, the implementation as well as the processing complexity of the enforcement of the overload control, should not result in a significantly poorer efficiency of the source GTP-C entity. + +#### 12.3.10.2.3 Self-protection by the overloaded GTP-C entity + +A source GTP-C entity enforcing the overload control cannot ensure that the overloaded peer will not receive more messages than what it can handle during the overload condition, e.g. the "loss" algorithm does not guarantee that the future traffic reaches perfectly that requested by the overloaded GTP-C entity. Hence, the overloaded target GTP-C entity shall protect itself from the risk of meltdown even in a network where all the sending GTP-C entities support the overload control mechanism. As a part of this self-protection, the overloaded target GTP-C entity may reject the messages which it cannot handle during an overloaded state. A GTP-C entity which decides to not process an incoming request message due to overload should still send a reject response message, if possible, indicating the temporary unavailability of the resources; otherwise the request message may be dropped. + +NOTE: Without a response message, the source GTP-C entity cannot determine whether the request did not reach the target GTP-C entity due to a network error or whether the target GTP-C entity was in overload and not able to process the request and send a response message. This will cause the source GTP-C entity to retransmit the request message and hence will increase further the overload at the target node. + +The GTP-C entity may apply message prioritization as described in clause 12.3.9.3 when selecting the incoming request messages to be throttled. + +While rejecting the message due to overload, the GTP-C entity shall set the cause to "GTP-C Entity Congestion" or "APN congestion" (for node level or APN level overload respectively) and may include the Overload Control Information in the rejection response as specified in clauses 12.3.5.1.1 and 12.3.11. + +### 12.3.10.3 Enforcement of overload control between GTP-C entities in direct contact + +A source GTP-C entity shall enforce overload control for traffic destined to a GTP-C entity in direct contact based on the overload reduction metric received from that peer, e.g. the MME applies the overload control for the messages targeted for the SGW based on the overload information of the SGW. + +### 12.3.10.4 Enforcement of overload control between remote GTP-C entities + +#### 12.3.10.4.1 Description + +For messages destined to a remote GTP-C entity (i.e. a GTP-C entity not in direct contact but reached via an intermediate GTP-C entity), the source GTP-C entity shall enforce the overload control based on the overload information of the target of the message, as well as the overload information of the intermediate GTP-C entity, e.g. the MME applies the overload control for messages targeted for the PGW based on the overload information of the SGW and PGW. + +For the received messages, the intermediate GTP-C entity shall not further enforce any overload control and hence, shall not reject any message towards the source GTP-C entity. + +Annex D.4.1 provides an (informative) example of a possible implementation. + +NOTE 1: This approach ensures the overload protection of the Target as well as Intermediate GTP-C entities. + +NOTE 2: The source GTP-C entity may be connected to the same Target GTP-C entity via multiple different Intermediate GTP-C entities. The exact algorithm used at the source GTP-C entity to enforce the overload control, as per the aforementioned requirements, is implementation specific. + +### 12.3.11 Discovery of the support of the feature by the peer node + +A GTP-C entity shall determine whether to use the overload control feature: + +- within the PLMN, based on operator's policy (local PLMN-wide configuration); +- across the PLMN boundaries, based on operator's policy (local configuration per PLMN). + +NOTE: The feature can be activated when all or some of the nodes in the PLMN support the feature. The GTP-C entity assumes that all the peer nodes support this feature when the feature is activated, i.e. it does not need to determine which peers support the feature. + +The above operator policy/local configuration may allow the use of overload control at node level and APN level, or none. + +### 12.3.12 Issues in the network with partial support of the feature + +The Overload Control feature should be supported homogeneously across the nodes in the network, otherwise: + +- an overloaded node will get messages beyond its acceptable processing capacity, even after announcing its overload status. This may result in severe overload and possibly a breakdown of the node; +- a non-supporting node will get an unfair advantage in sending all the messages to an overloaded node, whereas a supporting node, would be requested to throttle more messages. + +### 12.3.13 Implicit overload control mechanisms + +Implicit overload control mechanisms are mechanisms used between GTP-C entities when GTP-C overload control is not supported or not enabled between them, e.g. across PLMN boundary based on operator's policy, to help reducing the overload at the overloaded node: + +- a GTP-C entity which decides to not process an incoming request message due to overload should still send a reject response message, if possible, indicating the temporary unavailability of the resources, e.g. No resources available; otherwise the GTP-C entity may drop the incoming request message. + +NOTE: Without a response message, the source GTP-C entity cannot determine whether the request did not reach the target GTP-C entity due to a network error or whether the target GTP-C entity was in overload and not able to process the request and send a response message. This will cause the source GTP-C entity to retransmit the request message and hence will increase further the overload at the target node. + +- a GTP-C entity in overload may support messages throttling as a self protection mechanism and may apply message prioritization as described in clause 12.3.9.3 when selecting the incoming request messages to be throttled; +- based on the number and rate of reject responses indicating temporary unavailability of resources, e.g. No resources available, a source GTP-C entity should try to assess the overload level of the target GTP-C entity and apply correspondingly message throttling as described in clause 12.3.9 to reduce the amount of traffic sent towards the overloaded GTP-C entity. + +--- + +## 13 Detection and handling of late arriving requests + +### 13.1 General + +The procedures specified in this clause aim at handling more efficiently requests which may arrive late at upstreams entities, e.g. in networks experiencing processing or transport delays. + +These procedures are optional to support. When supported, the use of these procedures is dependent on operator policy. + +The procedure specified in clause 13.2 may be used with or without the procedure specified in clause 13.3. The procedure specified in clause 13.3 shall only be used in conjunction with the procedure specified in clause 13.2. + +### 13.2 Detection and handling of requests which collide with an existing session context + +#### 13.2.1 General + +This procedure enables an entity, which receives a request colliding with an existing session context, to know the time at which the new request and the existing session were originated, and to accept the new request only if it is more recent than the existing session. + +The originating entities within the PLMN (i.e. MME, SGSN, TWAN and ePDG) shall be NTP synchronized. + +#### 13.2.2 Principles + +The following principles shall apply if this procedure is supported and enabled by operator policy. + +A GTP-C entity originating a Create Session Request (i.e. MME, SGSN, TWAN or ePDG) shall include in the message the Origination Time Stamp indicating the absolute time at which the request is initiated. + +The SGW shall forward this parameter over the S5/S8 interface, if it is received from the MME/SGSN. + +Upon receipt of a session establishment request which collides with an existing session context, the PGW shall accept the new session establishment request only if it contains a more recent time stamp than the time stamp stored for the existing session. An incoming session request shall be considered as more recent than an existing session and be accepted if no Origination Time Stamp information was provided for at least one of the two sessions. The PGW shall reject an incoming request whose time stamp is less recent than the time stamp of the existing session with the cause 'Late Overlapping Request'. + +3GPP TS 29.212 [29] and 3GPP TS 29.273 [68] further specify: + +- the PGW requirements regarding the forwarding of the Origination Time Stamp parameter over the Gx and/or S6b interfaces, when received from the SGW or TWAN/ePDG; +- the handling of the Origination Time Stamp parameter by the PCRF and 3GPP AAA Server for an incoming request colliding with an existing session context. + +An originating entity which detects a NTP failure shall not include the Origination Time Stamp towards other entities. + +## 13.3 Detection and handling of requests which have timed out at the originating entity + +### 13.3.1 General + +This procedure enables an entity which receives a request to know when the request times out at the originating entity, and to stop further processing, at the receiver and further upstream entities, a request which has timed out at the originating entity. + +The originating entities (i.e. MME, SGSN, TWAN and ePDG) and the receiving entities (i.e. SGW, PGW, PCRF, 3GPP AAA Server) shall be NTP synchronized. This procedure may be used between entities pertaining to the same PLMN, and if allowed by operator policy, between entities pertaining to different PLMNs. + +This procedure shall not affect the setting of the retransmission timers by intermediate entities. E.g. the SGW shall set its T3 and N3 retransmission parameters as specified in this specification, irrespective of the time at which the request times out at the originating entity. + +### 13.3.2 Principles + +The following principles shall apply if this procedure is supported, enabled by operator policy and if the PGW pertains to the same PLMN as the originating entity or if the PGW pertains to a different PLMN and operator policy in the originating entity allows to use this procedure towards this PLMN. + +A GTP-C entity originating a Create Session Request (i.e. MME, SGSN, TWAN or ePDG) shall include in the message the Origination Time Stamp indicating the absolute time at which the request is initiated, as specified in clause 13.2.2, and the Maximum Wait Time indicating the maximum time period to complete the processing of the request. The Maximum Wait Time, together with the Origination Time Stamp, indicates the absolute time at which the request times out at the originating entity. + +The MME/SGSN shall set the Maximum Wait Time to a value smaller or equal to $(N3+1) \times T3$ set in the SGW, to avoid upstream entities continuing to process requests which would have ceased to be processed by the SGW, which could result in hanging contexts in upstream entities. + +NOTE 1: If the Maximum Wait Time is set to a value smaller than $N3 \times T3$ set in the SGW, the SGW actually stops retransmitting a given GTP-C Create Session Request as soon as it receives a rejection response from the PGW due to the expiry of the Maximum Wait Time. I.e. the Maximum Wait Time actually leads to shorten the duration during which the SGW retransmits the GTP-C request. + +The SGW shall forward the Origination Time Stamp over the S5/S8 interface as specified in clause 13.2.2. The SGW shall also forward the Maximum Wait Time over the S5/S8 interface, if received from the MME/SGSN. + +Upon receipt of a request which contains the Origination Time Stamp and the Maximum Wait Time parameters, the receiving entity should check that the request has not already timed out at the originating entity. The receiving entity may perform additional similar checks during the processing of the request, e.g. upon receipt of a response from the next upstream entity. + +The receiving entity should reject a request that is known to have timed out with the cause 'Timed Out Request'; it may alternatively drop the request. Besides, the receiving entity should initiate the release of any session it may have successfully created towards an upstream entity, to avoid hanging sessions in the network. + +NOTE 2: Sending a rejection response over the last hop towards the originating node, i.e. over S11/S4 or S2a/S2b, is not useful as the request has timed out at the originated entity. + +In the context of this specification, the receiving entity refers to an SGW or PGW. + +3GPP TS 29.212 [29] and 3GPP TS 29.273 [68] further specify: + +- the PGW requirements regarding the forwarding of the Maximum Wait Time parameter over the Gx and/or S6b interfaces, when received from the SGW or TWAN/ePDG; +- the handling of the Maximum Wait Time parameter by the PCRF and 3GPP AAA Server. + +An originating entity which detects a NTP failure shall not insert the Origination Time Stamp and the Maximum Wait Time parameters towards other entities. A receiving entity which detects a NTP failure shall ignore the the Maximum Wait Time parameter. + +--- + +## 14 Handling of Bearer Contexts Mismatch + +### 14.1 General + +Bearer Contexts mismatch among different EPC entities, e.g. MME/SGW/PGW, can happen due to various reasons, e.g. transport network delay, signalling overload. + +### 14.2 Detection of Bearer Context Mismatch + +Bearer Context mismatch can be detected by a receiving GTP-C entity in the following cases: + +- when at least one dedicated bearer context in the request message is unknown; or +- when at least one dedicated bearer context is missing in the request message in comparison to the bearer contexts stored; or +- when receiving a response message indicating that one of the dedicated bearer context(s) was unknown, by using the cause code "Context not found" at the Bearer Context level. See also clause 8.4. + +The Modify Bearer Request/Response and the Modify Access Bearer Request/Response in particular enables an easy detection of bearer contexts mismatch since all the bearer contexts, either of the PDN connection for a Modify Bearer Request/Response or of all the UE's PDN connections for a Modify Access Bearer Request/Response, need to be included in the messages. + +### 14.3 Handling of Bearer Context Mismatch + +#### 14.3.1 General + +The following requirements should apply: + +- 1) When an EPC entity receives a response message, where one or more dedicated bearer context(s) is associated with the Cause code "Context Not Found" while the PDN connection is known by the peer, the EPC entity shall delete the corresponding bearer context(s); +- 2) When an SGW receives a Modify Bearer Request, where one or more dedicated bearer context(s) is missing in the request message in comparison to the Bearer Context(s) stored for the UE's PDN connection, the SGW shall accept the Modify Bearer Request message and delete the corresponding bearer context(s) locally. The PGW shall apply the same behavior if the Modify Bearer Request received at the PGW includes the Bearer Contexts to be modified IE; +- 3) When a SGW receives a Modify Bearer Request, where only one or more dedicated bearer context(s) is unknown, the SGW shall accept the Modify Bearer Request message partially and set the cause code "Context Not Found" for those unknown bearer context(s) at Bearer Context level. The PGW shall apply the same behavior if the Modify Bearer Request received at the PGW includes the Bearer Contexts to be modified IE; +- 4) When a SGW receives a Modify Access Bearer Request, where one or more dedicated bearer context(s) is missing in the request message in comparison to the Bearer Context(s) stored for all the UE's PDN connections, the SGW shall delete the corresponding bearer context(s) locally; + +- 5) When a SGW receives a Modify Access Bearer Request, where only one or more dedicated bearer context(s) is unknown, the SGW shall accept the Modify Access Bearer Request message partially and set the cause code "Context Not Found" for those unknown bearer context(s) at Bearer Context level. + +NOTE: It is assumed the PGW can at least use a subsequent Modify Bearer Request to resolve Bearer Context mismatch, so that the SGW need not send explicit message to delete unknown Bearer Context. + +### 14.3.2 Exceptional scenarios + +During a dedicated bearer creation procedure, temporary Bearer Context mismatch may occur at the SGW, e.g. due to the collision between Create Bearer Request and Modify (Access) Bearer Request messages. Applying the general requirements of clause 14.3.1 may in such case lead to unnecessary signalling and cause extra latency. The SGW should handle such Bearer Context mismatch in an implementation specific way, but in such a way to accept the Modify (Access) Bearer Request message and to not locally delete the missing Bearer Context. + +During a Network Triggered Service Request procedure, which is triggered by a dedicated bearer creation procedure towards a UE in Idle mode, the MME shall include only the existing Bearer Contexts (not the new Bearer Contexts just created) in the corresponding Modify (Access) Bearer Request message. The same principle shall apply when piggybacking is used, i.e. when the Modify Bearer Request is piggybacked in the Create Bearer Response message, the MME shall include only the existing Bearer Contexts (not the new Bearer Contexts just created) in the corresponding Modify (Access) Bearer Request message. + +NOTE: During a Network Triggered Service Request procedure, which is triggered by a dedicated bearer creation procedure towards a UE in Idle mode, bearer mismatches can be avoided by the MME sending the Create Bearer Response only after it receives the Modify Bearer Response message, however in some rare cases, the signalling can be delayed for the UE, e.g. if the Modify Bearer Response is lost. + +--- + +## Annex A (Informative): Backward Compatibility Guidelines for Information Elements + +In order to preserve backward compatibility, the following rules should apply when adding or modifying information elements for existing messages. + +- No new mandatory (M) information elements should be added. +- No new conditional (C) information elements should be added. +- Any new IEs should be either: + - optional (O), having no conditions on their presence, or + - conditional-optional (CO), having conditions that should apply only to the sender and not to the receiver. +Such conditions should be worded generally as follows: "This IE shall be sent over the xxx interface . The receiving entity need not check the IE's presence." +- If any new conditions are added to a previously specified conditional (C) information element, these new conditions should apply only to the sender and not to the receiver. + +Such additional conditions should be worded generally as follows: "This IE shall be sent over the xxx interface . For this optional condition, the receiving entity need not check the IE's presence." + +Existing conditions for such conditional (C) IEs should be treated as before, and the presence of the IEs should remain conditional (C). + +--- + +## Annex B (Informative): Transparent copying of RANAP/S1AP/NGAP IEs into GTP IEs + +### B.1 General + +This annex provides details on how a GTPv2 entity transparently copies information received from RANAP or S1AP or NGAP into GTPv2 IE or IE field. + +RANAP and S1AP ASN.1 encoding details in this annex are informative. The reference specifications are 3GPP TS 25.413 [33], 3GPP TS 36.413 [10] and 3GPP TS 38.413 [84] respectively. + +The respective RANAP/S1AP/NGAP Information Elements are transported on the Iu/S1 interface within a "protocol-IE container" which is composed of: + +- an Information Element Identity (referred to below as "IE-ID"), +- an indication how the receiver shall react if the Information Element is not comprehended (referred to below as "criticality"), +- and an "open type field" which consists of a length indication ("OT-LI") and the Information Element itself (referred to below as "IE"). + +RANAP/S1AP/NGAP PDUs and the contained IEs are defined by means of ASN.1, the specified encoding is PER (packed encoding rule), Octet aligned variant: + +- PER minimises the information sent on the respective interface to the absolute minimum; +- Hence, type definitions of fixed length are encoded without any type or length indication, only type definitions of variable length contain a length indication, e.g. + - an OCTET STRING with indefinite length would need to contain a length indication (referred to below as "OCT-LI") followed by the actual octets (referred to below as "octets"); + - a SEQUENCE neither contains a type, nor a length-indication. Only in case of optional elements it contains a kind of bit string with each position of this bitstring indicating the presence of an OPTIONAL element (an encoded SEQUENCE type is referred to below as "sequence"). + +--- + +### B.2 Handover/Relocation related generic transparent Containers over RANAP, S1-AP and GTP + +Handover/Relocation related generic transparent containers are defined in 3GPP TS 25.413 [33] and 3GPP TS 36.413 [10] ("Source to Target Transparent Container" IE and "Target to Source Transparent Container" IE) to carry UTRAN, E-UTRAN or GERAN specific information via CN interfaces in a RAT-agnostic way. + +The encoding of these handover/relocation related generic transparent containers is different in RANAP and S1-AP. See 3GPP TS 36.413 [10] Annex C. The difference is that the "Source to Target Transparent Container" IE and "Target to Source Transparent Container" IE are ASN.1 encoded over RANAP as "IE-ID||criticality||OT-LI||octets" (i.e. one length field only for the open type field) and over S1AP as "IE-ID||criticality||OT-LI||OCT-LI||octets" (i.e. with 2 length fields, one for the open type field ("OT-LI"), one for the octet string encoding ("OCT-LI")), while "octets" contain the actual RAT specific handover/relocation information. + +This gives the following chain of encodings (represented in the notation introduced in the Notes above) end-to-end. + +#### LTE to LTE + +![Sequence diagram for LTE to LTE handover showing the encoding of generic transparent containers between eNB, S-MME, and T-MME.](9c575767fe4409cdd2898df6f70139f5_img.jpg) + +``` + +sequenceDiagram + participant eNB as eNB + participant S-MME as S-MME + participant T-MME as T-MME + participant eNB as eNB + + Note left of eNB: "SourceToTargetTransparent Container" transported via an IE container == (IE-ID|criticality||OT-LI||IE) +IE == OCT-LI|octets +octets == sequence == "Source eNB to Target eNB Transparent Container" + eNB->>S-MME: Handover Required + Note right of S-MME: "F-Container field" contains "sequence" only + S-MME->>T-MME: "F-Container field" contains "sequence" only + Note right of T-MME: "SourceToTargetTransparent Container" transported via an IE container == (IE-ID|criticality||OT-LI||IE) +IE == OCT-LI|octets +octets == sequence == "Source eNB to Target eNB Transparent Container" + T-MME->>eNB: Handover Request + +``` + +Sequence diagram for LTE to LTE handover showing the encoding of generic transparent containers between eNB, S-MME, and T-MME. + +Figure B.2-1: LTE to LTE - Encoding of Generic Transparent Containers + +In the case of LTE-LTE handover, the "octets" contain the "Source eNB to Target eNB Transparent Container" (defined as an ASN.1 SEQUENCE in 3GPP TS 36.413[10]). + +The source MME, after decoding the HO REQUIRED message of SIAP, passes transparently the "sequence" to the target MME. + +The target MME encodes similarly at target side with the same definitions: it feeds the received "sequence" into the SIAP ASN.1 encoder in order to encode the HO REQUEST message towards the target eNB. The "sequence" is then extracted from the SIAP ASN.1 of eNB and given to application part of eNB. + +### LTE to 3G + +![Sequence diagram for LTE to 3G handover showing the encoding of generic transparent containers between eNB, S-MME, SGSN, and RNC.](0f758e9df33317ae55b3bd118241475a_img.jpg) + +``` + +sequenceDiagram + participant eNB as eNB + participant S-MME as S-MME + participant SGSN as SGSN + participant RNC as RNC + + Note left of eNB: "SourceToTargetTransparent Container" transported via an IE container == (IE-ID|criticality||OT-LI||IE) +IE == OCT-LI|octets +octets == sequence == "Source RNC to Target RNC Transparent Container" + eNB->>S-MME: Handover Required + Note right of S-MME: "F-Container field" contains "sequence" only + S-MME->>SGSN: "F-Container field" contains "sequence" only + Note right of SGSN: "SourceToTargetTransparent Container" transported via an IE container == (IE-ID|criticality||OT-LI||IE) +IE == sequence == "Source RNC to Target RNC Transparent Container" + SGSN->>RNC: Relocation Request + +``` + +Sequence diagram for LTE to 3G handover showing the encoding of generic transparent containers between eNB, S-MME, SGSN, and RNC. + +Figure B.2-2: LTE to 3G - Encoding of Generic Transparent Containers + +At source side, the same encoding is done but for LTE to 3G handover, this time the "octets" on the line is the "Source RNC to Target RNC Transparent Container" (encoded according to the target system RANAP i.e. as an ASN.1 SEQUENCE in 3GPP TS 25.413 [33]). + +Again the source MME passes transparently the "sequence" to the target MME i.e. the "Source RNC to Target RNC Transparent Container". + +At the target side, the RANAP RELOCATION REQUEST message was not upgraded: the "sequence" received from the Gn or S3 interface ("Source RNC to Target RNC Transparent Container") is not encoded as an OCTET STRING as on S1, but directly represent the "Source To Target Transparent Container" within the RANAP:RELOCATION REQUEST message, which in case of inter-RAT handover to 3G represent the "Source RNC to Target RNC Transparent Container", transported on the Iu interface as the "IE" part of the "IE container". There is no additional length field added as on the S1 interface ("OCT-LI"). + +The target side remains therefore fully backwards compatible with UMTS release 7. + +### 3G to LTE + +![Sequence diagram showing the encoding of Generic Transparent Containers for 3G to LTE relocation. The diagram involves four entities: RNC R8, SGSN (R7), T-MME, and eNB. The process starts with a 'Relocation Required' message from RNC R8 to SGSN (R7). This message contains a 'SourceToTargetTransparent Container' transported via an IE container with IE-ID criticality OT-LI IE, and a 'sequence' field set to 'Source eNB to Target eNB Transparent Container'. The SGSN (R7) then sends a message to T-MME with an 'F-Container field' containing only the 'sequence'. Finally, the T-MME sends a 'Handover Request' to the eNB. This message contains the 'SourceToTargetTransparent Container' transported via an IE container with IE-ID criticality OT-LI IE, an IE set to OCT-LI octets, and octets set to 'sequence' which is 'Source eNB to Target eNB Transparent Container'.](e3734a615e069a3923c72f1ef4608fa9_img.jpg) + +Sequence diagram showing the encoding of Generic Transparent Containers for 3G to LTE relocation. The diagram involves four entities: RNC R8, SGSN (R7), T-MME, and eNB. The process starts with a 'Relocation Required' message from RNC R8 to SGSN (R7). This message contains a 'SourceToTargetTransparent Container' transported via an IE container with IE-ID criticality OT-LI IE, and a 'sequence' field set to 'Source eNB to Target eNB Transparent Container'. The SGSN (R7) then sends a message to T-MME with an 'F-Container field' containing only the 'sequence'. Finally, the T-MME sends a 'Handover Request' to the eNB. This message contains the 'SourceToTargetTransparent Container' transported via an IE container with IE-ID criticality OT-LI IE, an IE set to OCT-LI octets, and octets set to 'sequence' which is 'Source eNB to Target eNB Transparent Container'. + +Figure B.2-3: 3G to LTE - Encoding of Generic Transparent Containers + +The RELOCATION REQUIRED message was upgraded from release 8 onwards renaming the previously contained "Source RNC to Target RNC Transparent Container" to "Source to Target Transparent Container", being able to transport also a "Source eNB to Target eNB Transparent Container". + +Despite being defined as an octet string, in order to not impact the R7 SGSN, the octet string was specified as "to be replaced" by either the UTRAN or E-UTRAN specific container. This fact is explained e.g. within the NOTE in the ASN.1 of 3GPP TS 25.413 [33], as shown in this excerpt: + +``` +Source-ToTarget-TransparentContainer ::= OCTET STRING +-- This IE is a transparent container, the IE shall be encoded not as an OCTET STRING but according +-- to the type specifications of the target system. +-- Note: In the current version of this specification, this IE may either carry the Source RNC to +-- Target RNC Transparent Container or the Source eNB to Target eNB Transparent Container IE as +-- defined in [49] +``` + +By so doing, the Release 7 source SGSN receives only one length field (the "OT-LI") instead of two (the "OT-LI" and the "OCT-LI") as if it would receive an "Source RNC to Target RNC Transparent Container" from a Release 7 RNC, ensuring fully Release 7 backwards compatibility as requested by 3GPP TS 23.401 [3] Annex D. This is illustrated in Figure B.1-3 above. + +As explained above, this Release 7 backwards compatibility constraint only applies to RANAP to cope with Release 7 SGSN nodes and does NOT apply to LTE. This is why the note is NOT present in the ASN.1 of 3GPP TS 36.413 [10] for LTE i.e. the SIAP octet string does not need "to be replaced". + +Then "sequence" is passed transparently to the target MME. The target MME encodes the "sequence" within an OCTET STRING resulting in two length fields as expected by target eNB ASN.1 SIAP decoder. + +## B.3 Other RANAP and S1-AP and NGAP IEs + +When transparently copying a RANAP/S1AP/NGAP IE, other than the handover/relocation related generic transparent containers (see Annex B.1) into GTP IE, or GTP IE field the following applies: + +- a transparent copy of a RANAP/S1AP/NGAP IE, which is transported on the Iu/S1/NG-C interface within a "protocol-IE container", neither includes the Information Element Identity ("IE-ID") nor the "criticality" nor the open type field related length indication ("OT-LI"), but only the Information Element itself ("IE"). +- "IE" refers to all parts of the encoded type of the Information Element, i.e. including also any related length indication (in case of types with variable length) and preamble (see ITU-T X.691 [49] for the definition of the term "preamble"). + +## Annex C (Normative): MME/S4-SGSN mapping table between S11/S4 and NAS Cause values + +The MME/S4-SGSN initiates session management requests towards the SGW and PGW or mobility management requests towards the source/target MME/S4-SGSN. If this operation is not successful, there are several possible cause codes, which need to be mapped to the appropriate cause codes over NAS to the UE. + +Additionally, the MME/S4-SGSN initiates session management requests towards the UE. If this operation is not successful, there are several possible NAS cause codes which need to be mapped to the appropriate GTP cause codes over S11/S4 interface towards the SGW. + +The MME/S4-SGSN should map these cause codes as defined in tables C.1 to C.5 unless specified otherwise in the tables. + +**Table C.1: Mapping from S11/S4 to NAS Cause values – Rejection indication from SGW** + +| Reject indication from SGW to MME/S4-SGSN over S11/S4 | NAS ESM Cause to UE
(NOTE 1, NOTE 2, NOTE 3)
| SM Cause to UE
(NOTE 1, NOTE 2, NOTE 3)
| +|----------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| #64 "Context not found" (during UE initiated PDN connectivity request for non-3GPP to 3GPP handover procedure) | #54 "PDN connection does not exist" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#31 "Activation rejected, unspecified" | +| #64 "Context not found" (during all other procedures) | #30 "Request rejected by Serving GW or PDN GW"
#38 "Network failure"
#43 "Invalid EPS bearer identity" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#38 "Network failure"
#43 "Unknown PDP Context" | +| #65 Invalid Message Format | #30 "Request rejected by Serving GW or PDN GW"
#38 "Network failure" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#38 "Network failure" | +| #66 "Version not supported by next peer" | #30 "Request rejected by Serving GW or PDN GW"
#38 "Network failure" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#38 "Network failure" | +| #67 "Invalid length" | #30 "Request rejected by Serving GW or PDN GW"
#38 "Network failure" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#38 "Network failure" | +| #68 "Service not supported" | #32 "Service option not supported" | #32 "Service option not supported" | +| #69 "Mandatory IE incorrect" | #30 "Request rejected by Serving GW or PDN GW"
#38 "Network failure" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#38 "Network failure" | +| #70 "Mandatory IE missing" | #30 "Request rejected by Serving GW or PDN GW"
#38 "Network failure" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#38 "Network failure" | +| #72 "System Failure" | #34 "Service option temporarily out of order"
#38 "Network Failure"
#30 "Request rejected by Serving GW or PDN GW" | #34 "Service option temporarily out of order"
#38 "Network failure"
#30 "Activation rejected by GGSN, Serving GW or PDN GW" | +| #73 "No Resources available" | #34 "Service option temporarily out of order"
#26 "Insufficient resources" | #34 "Service option temporarily out of order"
#26 "Insufficient resources" | +| #76 "Semantic errors in packet filter(s)" | #44 "Semantic errors in packet filter(s)" | #44 "Semantic errors in packet filter(s)" | +| #77 "Syntactic errors in packet filter(s)" | #45 "Syntactical error in packet filter(s)" | #45 "Syntactical error in packet filter(s)" | +| #78 "Missing or unknown APN" | # 27 "Missing or unknown APN" | # 27 "Missing or unknown APN" | +| #80 "GRE key not found" | #30 "Request rejected by Serving GW or PDN GW"
#38 "Network Failure" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#38 "Network failure" | +| #83 "Preferred PDN type not supported" | #32 "Service option not supported"
#50 "PDN type IPv4 only allowed"
#51 "PDN type IPv6 only allowed" | #32 "Service option not supported"
#50 "PDP type IPv4 only allowed"
#51 "PDP type IPv6 only allowed" | +| #84 "All dynamic addresses are occupied" | #26 "Insufficient resources" | #26 "Insufficient resources" | +| #85 "UE context without TFT already activated" | NA | #46 "PDP context without TFT already activated" | +| #86 "Protocol type not supported" | #30 "Request rejected by Serving GW or PDN GW"
#38 "Network Failure" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#38 "Network failure" | +| #89 "Service denied" | #30 "Request rejected by Serving GW or PDN GW"
#31 "Request rejected, unspecified"
#38 "Network failure" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#31 "Activation rejected, unspecified"
#38 "Network failure" | +| #91 "No memory available" | #34 "Service option temporarily out of order"
#26 "Insufficient resources" | #34 "Service option temporarily out of order"
#26 "Insufficient resources" | +| #92 "User authentication failed" | #29 "User authentication failed"
(NOTE 4) | #29 "User authentication failed" | +| #93 "APN access denied – no subscription" | #33 "Requested service option not subscribed"
# 27 "Missing or unknown APN" | #33 "Requested service option not subscribed"
# 27 "Missing or unknown APN" | +| #94 "Request rejected (reason not | #30 "Request rejected by Serving GW | #30 "Activation rejected by GGSN, | + +| | | | +|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| +| specified)" | or PDN GW"
#38 "Network Failure" | Serving GW or PDN GW"
#38 "Network failure" | +| #97 "Semantic error in the TAD operation" | #41 "Semantic error in the TFT operation" | #41 "Semantic error in the TFT operation" | +| #98 "Syntactic error in the TAD operation" | #42 "Syntactical error in the TFT operation" | #42 "Syntactical error in the TFT operation" | +| #100 "Remote peer not responding" | #34 "Service option temporarily out of order"
#38 "Network Failure" | #34 "Service option temporarily out of order"
#38 "Network failure" | +| #101 "Collision with network initiated request" | #56 "Collision with network initiated request" | #56 "Collision with network initiated request" | +| #103 "Conditional IE missing" | #30 "Request rejected by Serving GW or PDN GW"
#38 "Network Failure" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#38 "Network failure" | +| #104 "APN Restriction type Incompatible with currently active PDN connection" | #112 "APN restriction value incompatible with active EPS bearer context" | #112 "APN restriction value incompatible with active PDP context" | +| #107 "Invalid reply from remote peer" | #30 "Request rejected by Serving GW or PDN GW"
#31 "Request rejected, unspecified" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#31 "Activation rejected, unspecified" | +| #112 "Request rejected for a PMIPv6 reason (see 3GPP TS 29.275 [26])." | #30 "Request rejected by Serving GW or PDN GW"
#38 "Network Failure" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#38 "Network failure" | +| #113 "APN Congestion"
#120 "GTP-C Entity Congestion" | #26 "Insufficient resources" | #26 "Insufficient resources" | +| #114 "Bearer handling not supported" | #60 "Bearer handling not supported" | #60 "Bearer handling not supported" | +| #116 "Multiple PDN connections for a given APN not allowed" | #55 "Multiple PDN connections for a given APN not allowed" | #30 "Activation rejected by GGSN, Serving GW or PDN GW"
#31 "Activation rejected, unspecified" | +| #126 "Multiple accesses to a PDN connection not allowed" | #113 "Multiple accesses to a PDN connection not allowed" | #113 "Multiple accesses to a PDN connection not allowed" | + +NOTE 1: See 3GPP TS 24.301 [23] and 3GPP TS 24.008 [5] for NAS ESM and SM causes respectively. + +NOTE 2: The MME/S4-SGSN may for certain GTP cause codes trigger a new GTP procedure instead of rejecting the NAS request. + +NOTE 3: When multiple NAS Cause values are defined for a given GTP cause value, any of those NAS Cause values may be sent to the UE based on implementation choice. + +NOTE 4: The MME may send in addition the EMM cause code set to #15 "No suitable cells in tracking area" to the UE, if the PDN connectivity request is rejected due to the ESM cause #29, which is mapped from the GTPv2 cause code #92 based on operator policies. See 3GPP TS 24.301 [23]. This enables a roamer to get service in a VPLMN even when being rejected via LTE access due to e.g. no credit authorisation from the OCS. + +**Table C.2: Mapping from S11/S4 to NAS Cause values – Acceptance indication from SGW** + +| Acceptance indication from SGW to MME/S4-SGN over S11/S4 | NAS ESM Cause to UE | SM Cause to UE | +|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|----------------------------------------------------------------------------------| +| #18 "New PDN type due to network preference" | #50 "PDN type IPv4 only allowed"
#51 "PDN type IPv6 only allowed"
(NOTE 1) | #50 "PDP type IPv4 only allowed"
#51 "PDP type IPv6 only allowed"
(NOTE 1) | +| #19 "New PDN type due to single address bearer only" | #52 "single address bearers only allowed" | #52 "single address bearers only allowed" | +| NOTE 1: The actual NAS cause sent to the UE depends on the allocated IP address type. | | | + +**Table C.3: Mapping from S11/S4 to NAS Cause values – Indication in request from SGW** + +| Indication in a request / initial message from SGW to MME/S4-SGSN over S11/S4 | NAS ESM Cause to UE | SM Cause to UE | +|-------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| +| #8 "Reactivation Requested" (NOTE 1) | Shall be mapped to:
#39 "Reactivation requested" in the NAS bearer context deactivation procedure.
For the last PDN connection in E-UTRAN, "Reactivation requested" shall be mapped to "re-attach required" in the NAS detach type IE. | Shall be mapped to:
#39 "Reactivation requested" in the NAS bearer context deactivation procedure. | +| #9 "PDN reconnection to this APN disallowed" (NOTE 1) | Implementation specific NAS cause value indicating to the UE that the APN is not currently available.
For the last PDN connection, NAS detach type IE should be set to "re-attach not required". | Implementation specific NAS cause value indicating to the UE that the APN is not currently available. | + +NOTE 1: In Delete Bearer Request during the PGW initiated bearer deactivation procedure for the default bearer. + +**Table C.4: Mapping from NAS to S11/S4 Cause values – Rejection indication from MME/S4-SGSN** + +| NAS ESM Cause from UE (NOTE 1) | SM Cause from UE (NOTE 1) | Reject indication from MME/S4-SGSN to SGW over S11/S4 (NOTE 2) | +|----------------------------------------------|-------------------------------------------------------|----------------------------------------------------------------| +| #26 "Insufficient Resources" | #26 "Insufficient Resources" | #73 "No Resources available"
#88 "UE refuses" | +| #31 "Request rejected, unspecified" | #31 "Activation rejected, unspecified" | #94 "Request rejected"
#88 "UE refuses" | +| #41 "Semantic error in the TFT operation" | #41 "Semantic error in the TFT operation" | #74 "Semantic error in the TFT operation" | +| #42 "Syntactical error in the TFT operation" | #42 "Syntactical error in the TFT operation" | #75 "Syntactical error in the TFT operation" | +| #43 "Invalid EPS bearer identity" | #43 "Unknown PDP Context" | #64 "Context not found"
#88 "UE refuses" | +| #44 "Semantic errors in packet filter(s)" | #44 "Semantic errors in packet filter(s)" | #76 "Semantic errors in packet filter(s)" | +| #45 "Syntactical error in packet filter(s)" | #45 "Syntactical error in packet filter(s)" | #77 "Syntactical error in packet filter(s)" | +| #47 "PTI mismatch" | NA | #94 "Request rejected"
#88 "UE refuses" | +| NA | #48 "Request rejected, Bearer Control Mode violation" | #94 "Request rejected"
#88 "UE refuses" | +| #81 "Invalid PTI value" | NA | #94 "Request rejected"
#88 "UE refuses" | + +NOTE 1: See 3GPP TS 24.301 [23] and 3GPP TS 24.008 [5] for NAS ESM and SM causes respectively. + +NOTE 2: When multiple GTPv2 Cause values are defined for a given NAS Cause value, any of those GTPv2 Cause values may be sent to the SGW based on implementation choice. + +**Table C.5: Mapping from S3/S16 to NAS Cause values – Rejection indication from MME/S4-SGSN** + +| Reject indication from MME/S4-SGSN to MME/S4-SGSN over S3/S16 | NAS ESM Cause to UE
(NOTE 1, NOTE 2)
| SM Cause to UE
(NOTE 1, NOTE 2)
| +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| #117 "Target access restricted for the subscriber" | #15 "No suitable cells in tracking area",
or
#13 "Roaming not allowed in this tracking area", or
#12 "Tracking area not allowed" | #15 "No suitable cells in tracking area",
or
#13 "Roaming not allowed in this tracking area", or
#12 "Tracking area not allowed" | +| NOTE 1: See 3GPP TS 24.301 [23] and 3GPP TS 24.008 [5] for NAS ESM and SM causes respectively. | | | +| NOTE 2: When multiple NAS Cause values are defined for a given GTP cause value, any of those NAS Cause values may be sent to the UE based on implementation choice. | | | + +--- + +## Annex D (Informative): GTP-C load and overload control mechanism + +### D.1 GTP-C interfaces not supporting Load Control + +Load Control has been designed as a generic mechanism possibly applicable to any GTP-C node. However, for the reasons clarified below, in the current release, Load Control is not supported for the following GTP-C based interfaces: + +- S3, S10, S16 (limited GTP-C signalling traffic, to minimize impact to the MME/S4-SGSN); +- Sm, Sn (limited GTP-C signalling traffic, to avoid impact to the MBMS GW); +- Sv (limited GTP-C signalling traffic, to avoid impact to the legacy CS products); +- S101, S121 (to avoid impacts to the legacy HRPD products); +- Gn/Gp (to avoid impact to the legacy Gn-SGSN/GGSN products and GTPv1-C protocol). + +--- + +### D.2 GTP-C interfaces not supporting Overload Control + +Overload Control has been designed as a generic mechanism possibly applicable to any GTP-C based interface and any direction. However for the reasons clarified below, in the current release, Overload Control is not supported for the following GTP-C based interfaces: + +- S3, S10, S16 (see considerations below, to minimize impact to MME and S4-SGSN); + - most of the S3 traffic would remain internal to the combo-node with the deployment of combo-MME/S4-SGSN nodes. The traffic over S10/S16 is also reduced with the deployment of MME and SGSN pools. It is therefore not essential to throttle the traffic on these interfaces when an MME or S4-SGSN experiences overload; + - throttling signalling on these interfaces resulting from a user's mobility (inter-MME/S4-SGSN TAU, RAU and Handover) would result in bad end user's perception (handover failure, loss of PDN connections) and so needs to be avoided as far as possible; + - an MME or S4-SGSN in overload may drop locally incoming RIM messages without causing GTP-C retransmissions (although this may cause the RAN to retransmit the message). +- S11/S4 (from an MME/S4-SGSN to an SGW, with SGW as consumer; see consideration below); + - by allowing the SGW to throttle DDN requests for normal priority traffic, the overload control of the messages originated by the SGW towards the MME/S4-SGSN is covered and hence, an SGW performing overload control towards the MME/S4-SGSN using Overload Control Information would be redundant. +- S5/S8 (from a PGW to an SGW, with the SGW as a consumer; no signalling message, originated by the SGW towards the PGW, that is identified as requiring overload control); +- Sm, Sn (no overload scenario identified, limited GTP-C traffic, to avoid impact to the MBMS GW); +- Sv (no overload scenario identified, to avoid impact to the legacy CS products); +- S101, S121 (no overload scenario identified, to avoid impact to the legacy HRPD products); +- Gn/Gp (to avoid impact to the legacy Gn-SGSN/GGSN products and GTPv1-C protocol); + +--- + +### D.3 "Loss" throttling algorithm + +#### D.3.1 Example of possible implementation + +This clause provides an example of a possible implementation of the "Loss" algorithm, amongst other possible methods. + +It is possible to make use of a statistical loss function (e.g., random selection of messages to throttle based on the indicated percentage) to decide if the given message can be sent or need to be throttled. For example, the source node generates a random number between (0, 100) for each message which is a potential candidate for throttling. To realize 10% throttling, messages with a random number 10 or less are throttled and hence this achieves approximately a 10% reduction in the overall traffic. The actual traffic reduction might vary slightly from the requested percentage, albeit by an insignificant amount. + +The algorithm can select certain messages to throttle in priority. For example, implementations can distinguish between higher-priority and lower-priority messages, and drop the lower-priority messages in favour of dropping the higher priority messages, as long as the total reduction in traffic conforms to the requested reduction in effect at the time. For example, in the 50-50 distribution of high priority and low priority messages, 20% reduction to low priority messages and 0% reduction to high priority messages need to be applied in order to achieve the effective reduction in traffic by 10% towards the overloaded node. + +## D.4 Enforcement of overload control between remote GTP-C entities + +### D.4.1 Example of possible implementation + +This clause provides an example of a possible implementation of the enforcement of overload control between remote GTP-C entities, amongst other possible methods, considering the example network topology described in Figure D.4.1-1. + +![Figure D.4.1-1: Example network topology. A diagram showing a Source node connected to three Intermediate nodes (A, B, and C), which are all connected to a Target node. The Source node has a yellow circle, indicating it is the source of overload control. The Intermediate nodes and the Target node have red circles, indicating they are targets of overload control. Arrows show the flow of traffic from Source to each Intermediate node, and from each Intermediate node to the Target node.](80e77ddd48fe0d85dfa940d745a36dd1_img.jpg) + +``` + +graph LR + Source[Source] --> IntermediateA[IntermediateA] + Source --> IntermediateB[IntermediateB] + Source --> IntermediateC[IntermediateC] + IntermediateA --> Target[Target] + IntermediateB --> Target + IntermediateC --> Target + style Source fill:#00549F,color:white,stroke:none + style IntermediateA fill:#00549F,color:white,stroke:none + style IntermediateB fill:#00549F,color:white,stroke:none + style IntermediateC fill:#00549F,color:white,stroke:none + style Target fill:#00549F,color:white,stroke:none + Source <--> Source + IntermediateA <--> IntermediateA + IntermediateB <--> IntermediateB + IntermediateC <--> IntermediateC + Target <--> Target + +``` + +Legend: + +- Yellow circle: Source of overload control +- Red circle: Target of overload control + +Figure D.4.1-1: Example network topology. A diagram showing a Source node connected to three Intermediate nodes (A, B, and C), which are all connected to a Target node. The Source node has a yellow circle, indicating it is the source of overload control. The Intermediate nodes and the Target node have red circles, indicating they are targets of overload control. Arrows show the flow of traffic from Source to each Intermediate node, and from each Intermediate node to the Target node. + +Figure D.4.1-1: Example network topology + +The source GTP-C entity can apply message throttling according to the maximum of the overload reduction metric reported by the intermediate and target GTP-C entities, i.e. $\max(\text{Intermediate\_Overload-Metric}, \text{Target\_Overload-Metric})$ , for each of the path between the source and the target GTP-C entities. Each path is considered independently whilst performing the message throttling. + +Considering the following example overload condition for the topology above: + +$\text{Target\_Overload-Metric} = 30\%$ + $\text{IntermediateA\_Overload-Metric} = 10\%$ + $\text{IntermediateB\_Overload-Metric} = 20\%$ + $\text{IntermediateC\_Overload-Metric} = 40\%$ + $\text{Target\_Terminated-Messages} = 100$ + $\text{IntermediateA-Target\_Messages} = 20$ + $\text{IntermediateB-Target\_Messages} = 50$ + +IntermediateC-Target\_Messages = 30 + +the source GTP-C entity applies message throttling as follows: + +Source-IntermediateA\_Messages = 14 (message throttling of 30% applied) + +Source-IntermediateB\_Messages = 35 (message throttling of 30% applied) + +Source-IntermediateC\_Messages = 18 (message throttling of 40% applied) + +Source-Target\_Messages = 67 (the Target GTP-C entity receives 67 messages although it could have handled 70 messages in the overloaded condition). + +--- + +## Annex E (Normative): TWAN mapping table between GTPv2 S2a Cause and non-3GPP access Cause values + +The TWAN initiates session establishment requests or mobility management requests towards the PGW. If this operation is not successful, there are several possible cause codes, which need to be mapped to the appropriate cause codes over non-3GPP access to the UE. + +The TWAN should map these cause codes as defined in Table E.1, Table E.2, Table E.3 and Table E.4. + +**Table E.1: Mapping from GTPv2 S2a to non-3GPP access Cause values – Rejection indication from PGW** + +| Reject indication from PGW to TWAN over S2a | WLCP Cause to UE for MCM | Diameter Cause to 3GPP AAA Server for SCM | +|----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| +| #64 "Context not found" (during UE initiated PDN connectivity request for 3GPP to non-3GPP handover procedure) | #54 "PDN connection does not exist" | #54 "PDN connection does not exist" | +| #65 Invalid Message Format | #30 "Request rejected by PDN GW"
#38 "Network failure" | #30 "Request rejected by PDN GW"
#38 "Network failure" | +| #67 "Invalid length" | #30 "Request rejected by PDN GW"
#38 "Network failure" | #30 "Request rejected by PDN GW"
#38 "Network failure" | +| #68 "Service not supported" | #32 "Service option not supported" | #32 "Service option not supported" | +| #69 "Mandatory IE incorrect" | #30 "Request rejected by PDN GW"
#38 "Network failure" | #30 "Request rejected by PDN GW"
#38 "Network failure" | +| #70 "Mandatory IE missing" | #30 "Request rejected by PDN GW"
#38 "Network failure" | #30 "Request rejected by PDN GW"
#38 "Network failure" | +| #72 "System Failure" | #34 "Service option temporarily out of order"
#38 "Network Failure"
#30 "Request rejected by PDN GW" | #34 "Service option temporarily out of order"
#38 "Network Failure"
#30 "Request rejected by PDN GW" | +| #73 "No Resources available" | #34 "Service option temporarily out of order"
#26 "Insufficient resources" | #34 "Service option temporarily out of order"
#26 "Insufficient resources" | +| #78 "Missing or unknown APN" | # 27 "Missing or unknown APN" | # 27 "unknown APN" | +| #83 "Preferred PDN type not supported" | #32 "Service option not supported"
#50 "PDN type IPv4 only allowed"
#51 "PDN type IPv6 only allowed" | #32 "Service option not supported"
#50 "PDN type IPv4 only allowed"
#51 "PDN type IPv6 only allowed" | +| #84 "All dynamic addresses are occupied" | #26 "Insufficient resources" | #26 "Insufficient resources" | +| #89 "Service denied" | #30 "Request rejected by PDN GW"
#31 "Request rejected, unspecified"
#38 "Network failure" | #30 "Request rejected by PDN GW"
#31 "Request rejected, unspecified"
#38 "Network failure" | +| #91 "No memory available" | #34 "Service option temporarily out of order"
#26 "Insufficient resources" | #34 "Service option temporarily out of order"
#26 "Insufficient resources" | +| #92 "User authentication failed" | #92 "User authentication failed" | #92 "User authentication failed" | +| #93 "APN access denied – no subscription" | #33 "Requested service option not subscribed"
# 27 "Missing or unknown APN" | #33 "Requested service option not subscribed"
# 27 "unknown APN" | +| #94 "Request rejected (reason not specified)" | #30 "Request rejected by PDN GW"
#38 "Network Failure" | #30 "Request rejected by PDN GW"
#38 "Network Failure" | +| #100 "Remote peer not responding" | #34 "Service option temporarily out of order"
#38 "Network Failure" | #34 "Service option temporarily out of order"
#38 "Network Failure" | +| #101 "Collision with network initiated request" | #31 "Request rejected, unspecified" | NA | +| #103 "Conditional IE missing" | #30 "Request rejected by PDN GW"
#38 "Network Failure" | #30 "Request rejected by PDN GW"
#38 "Network Failure" | +| #113 "APN Congestion"
#120 "GTP-C Entity" | #26 "Insufficient resources" | #26 "Insufficient resources" | + +| | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|----------------------------------------------------------| +| Congestion" | | | +| #116 "Multiple PDN connections for a given APN not allowed" | #55 "Multiple PDN connections for a given APN not allowed" | NA | +| #126 "Multiple accesses to a PDN connection not allowed" | #113 "Multiple accesses to a PDN connection not allowed" | #113 "Multiple accesses to a PDN connection not allowed" | +| NOTE 1: See 3GPP TS 24.244 [66] for WLCP causes. | | | +| NOTE 2: When multiple non-3GPP access cause values are defined for a given GTP cause value, any of those cause values may be sent to the UE based on implementation choice. | | | + +**Table E.2: Mapping from GTPv2 S2a to non-3GPP access Cause values – Acceptance indication from PGW** + +| Acceptance indication from PGW to TWAN over S2a | WLCP Cause to UE for MCM | Diameter Cause to 3GPP AAA Server for SCM | +|----------------------------------------------------------------------------------------|----------------------------------------------------------------------|-------------------------------------------| +| #18 "New PDN type due to network preference" | #50 "PDN type IPv4 only allowed"
#51 "PDN type IPv6 only allowed" | NA | +| #19 "New PDN type due to single address bearer only" | #52 "single address bearers only allowed" | NA | +| NOTE 1: The actual WLCP cause sent to the UE depends on the allocated IP address type. | | | + +**Table E.3: Mapping from GTPv2 S2a to WLCP Cause values – Indication in request from PGW** + +| Indication in disconnection message from PGW to TWAN over S2a | WLCP Cause to UE for MCM | +|----------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------| +| #8 "Reactivation Requested" | #39 "Reactivation requested" | +| #9 "PDN reconnection to this APN disallowed" (NOTE 1) | Implementation specific WLCP cause value indicating to the UE that the APN is not currently available. | +| NOTE 1: In Delete Bearer Request during the PGW initiated bearer deactivation procedure for the default bearer | | + +**Table E.4: Mapping from WLCP to GTP Cause values – Rejection indication from TWAN** + +| WLCP Cause from UE | Reject indication from TWAN to PGW | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| #31 "request rejected, unspecified" | #94 "Request rejected"
#88 "UE refuses" | +| NOTE 1: See 3GPP TS 24.244 [66] for WLCP causes. | | +| NOTE 2: When multiple GTPv2 Cause values are defined for a given WLCP Cause value, any of those GTPv2 Cause values may be sent to the PGW based on implementation choice. | | + + + +--- + +## Annex F (Informative): Change History + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------|-------| +| 2008-12 | CT#42 | CP-080717 | | | | V2.0.0 approved in CT#42 | 8.0.0 | +| 2009-03 | CT#43 | CP-090050 | 0001 | 2 | | Delete Indirect Data Forwarding Tunnel Request/Response | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0003 | 1 | | Relocation Cancel Req/Res | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0004 | 2 | | Path Failure | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0005 | 4 | | Clauses 1 through 6 Editorial Clean-up | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0006 | 2 | | Delete Session and Delete Bearer messages | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0008 | 2 | | Update User Plane messages | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0017 | 2 | | Cleanup in path management and bearer command messages | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0018 | 1 | | Create Session/Bearer Messages | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0019 | 2 | | Modify Bearer messages | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0020 | 2 | | IEs in CSFB related messages | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0021 | 1 | | Command Messages | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0022 | 3 | | Data Forwarding Info | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0023 | 3 | | Delete Bearer messages | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0024 | 2 | | Delete Session messages | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0025 | 1 | | Downlink Data Notification | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0026 | 2 | | Update Bearer messages | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0027 | 2 | | Secondary PDP Activation | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0028 | 2 | | Stop Paging | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0030 | 1 | | EPS Bearer Contexts Prioritization | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0032 | 2 | | Linked EPS Bearer ID | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0034 | 1 | | AMBR IE encoding | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0035 | - | | Authentication Failure Cause Code | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0040 | 1 | | Forward SRNS Context Notification | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0041 | 1 | | F-TEID IE clarification | 8.1.0 | +| 2009-03 | CT#43 | CP-090214 | 0043 | 4 | | SGW Selection during TAU and corrections to Grouped IEs | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0043 | 1 | | Identification Response algorithm information | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0044 | 2 | | IE Type ordering | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0045 | 2 | | Indication IE corrections | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0048 | 1 | | MM Context enhancements | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0050 | 1 | | Removal of Bearer ID List IE | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0051 | 1 | | Remove unused IP Address IEs | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0052 | 1 | | Selection Mode bits | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0053 | 1 | | Corrections to Trace Information IE | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0054 | 2 | | Trace Information IE to be included in S11 and S5/S8 messages | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0055 | 3 | | Trace Session Activation/Deactivation when UE is attached | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0059 | 1 | | New UE Time Zone IE Type | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0060 | 1 | | Release Access Bearers Request/Response | 8.1.0 | +| 2009-03 | CT#43 | CP-090256 | 0061 | 3 | | Piggybacking of Dedicated Bearer Messages | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0063 | 4 | | Finalizing GTPv2 Error Handling clause | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0064 | 1 | | GTPv2 clause 9 and 10 cleanup | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0066 | 4 | | RAN Information Relay message | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0067 | 2 | | Bearer QoS encoding | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0068 | 1 | | Modify Bearer Response | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0075 | 3 | | Location Change Reporting | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0077 | 2 | | Cleanup on Cause Values | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0080 | 1 | | Non-3GPP Requests in GTPv2 | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0082 | 3 | | Support of IP address retrieval for ANRF | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0083 | 1 | | Support for error response for conflicting resource request | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0085 | 1 | | Clarification of Target ID vs Cell ID | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0089 | 2 | | TEID Value of the GTP header | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0093 | 3 | | Header for the Format of the GTPv2-C message | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0094 | 3 | | Finalization of Partial fault handling in GTPv2 | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0095 | 1 | | MSISDN encoding | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0096 | 1 | | IMSI encoding | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0097 | 1 | | PMIP error code reservation | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0098 | - | | Removal of Comprehension Required from messages 7.3.1 to 7.3.13 | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0099 | - | | Cause value for PGW not responding | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0100 | - | | Traffic Aggregate Description IE encoding | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0101 | 3 | | Protocol Stack | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0102 | 1 | | Reliable delivery for EPC | 8.1.0 | +| 2009-03 | CT#43 | CP-090050 | 0104 | - | | Removal of reservation for message types of GTP-U | 8.1.0 | +| 2009-03 | CT#43 | CP-090239 | 0105 | 1 | | Essential correction to grouped IE type coding | 8.1.0 | +| 2009-03 | - | - | - | - | | Some of the table formats corrected | 8.1.1 | +| 2009-06 | CT#44 | CP-090288 | 0107 | - | | Suspend and Resume are also used for 1xRTT CS Fallback | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0108 | 1 | | Support for new cause code of "Unable to page UE due to CSFB" in Downlink Data Notification Acknowledgement. | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0109 | 1 | | Corrections on GTPv2 for 1x IWS IP address | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0110 | 1 | | Clarification of Operation Indication (OI) | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0111 | 1 | | Usage of User Location Information (ULI) IE | 8.2.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------|-------| +| 2009-06 | CT#44 | CP-090288 | 0112 | 1 | | PGW S5/S8 IP Address in Context Response message | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0114 | 1 | | Delete Indirect Data Forwarding Tunnel Response | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0115 | 2 | | Error Handling. Withdrawn | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0117 | 1 | | PCO Extensions added to messages | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0118 | 1 | | Clarifications to message directions | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0119 | - | | Removal of specification drafting hints | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0120 | 1 | | ISR related alignments | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0122 | 1 | | Clarifications to grouped IE usage | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0125 | 2 | | Clarification to Recovery IE type | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0127 | 1 | | Missing conditions | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0128 | 1 | | Clarification of ARP encoding | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0129 | - | | Units for APN-AMBR | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0131 | 2 | | Clarification of Mobile Equipment Identity IE encoding | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0134 | - | | EPS Bearer Level TFT encoding | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0136 | 2 | | UE-initiated procedures with one bearer only | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0137 | 2 | | Combine UL and DL TFT IEs | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0142 | 1 | | PGW S5/S8 IP Address and TEID for user plane | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0143 | 1 | | Transaction Identifier information element | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0147 | 1 | | Delete Bearer Request | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0149 | 2 | | Modify Bearer Request for TAU without MME or SGW change | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0150 | | | Use of APN, PAA in Create Session Request, and S5/S8-U PGW F-TEID in Create Session Response | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0151 | 1 | | Message table corrections | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0153 | - | | Presence requirement for IEs in response | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0154 | 2 | | Offending IE in the Cause IE | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0156 | 1 | | Minor corrections | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0157 | 1 | | FQ-CSID corrections | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0158 | - | | APN and FQDN encoding clarifications | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0159 | - | | Removal of Trace Information IE from Update Bearer Request | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0160 | 1 | | Corrections in PDN Connection group IE | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0161 | 1 | | Missing IEs in "Update Bearer Response" | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0164 | 2 | | PDN Type | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0168 | 1 | | IE corrections in Modify Bearer signalling | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0169 | 2 | | Create Session Request Clarification | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0175 | - | | TEID in Detach Notification/ACK | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0176 | - | | Condition of bearer context in Modify Bearer messages | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0177 | 1 | | Delete Session Request granularity | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0178 | - | | Deletion of IMSI in the Update Bearer Request | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0180 | 1 | | Delete Session Request/Response and Delete Bearer Request | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0181 | 1 | | Detach Notification | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0183 | - | | SGSN Info for Data Forwarding | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0184 | 1 | | Delete Session Request | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0185 | 1 | | APN AMBR clarification | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0186 | 1 | | Delete Bearer Request when ISR activated | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0187 | 1 | | Clarify the usage of the MS validated IE | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0189 | 1 | | UDP Source port and IP Source Address | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0190 | - | | Recovery IE | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0192 | 1 | | APN Information | 8.2.0 | +| 2009-06 | CT#44 | CP-090500 | 0193 | 3 | | Cause value | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0195 | 1 | | Cleanup indication | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0196 | 1 | | Cleanup the usage of some messages | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0198 | 1 | | Linked EPS Bearer ID | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0199 | 1 | | PCO parameter | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0200 | 1 | | PDP Context Activation | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0201 | 1 | | User Location Info | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0202 | 2 | | F-Cause IE correction | 8.2.0 | +| 2009-06 | CT#44 | CP-090288 | 0206 | 1 | | Message granularity | 8.2.0 | +| 2009-06 | CT#44 | CP-090321 | 0209 | - | | Bearer Context in the Modify Bearer Command | 8.2.0 | +| 2009-06 | CT#44 | CP-090493 | 0210 | 1 | | Sequence Number Extension | 8.2.0 | +| 2009-06 | CT#44 | CP-090355 | 0212 | - | | Bearer Resource Command clarification | 8.2.0 | +| 2009-06 | CT#44 | CP-090485 | 0213 | 1 | | Piggybacked message clarifications | 8.2.0 | +| 2009-06 | CT#44 | CP-090472 | 0214 | 1 | | Corrections on handling Charging ID IE and Charging Characteristics IE | 8.2.0 | +| 2009-09 | CT#45 | CP-090533 | 0215 | - | | Usage of GTPv2-C Header | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0216 | 1 | | Create Session Request and Response | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0217 | 1 | | Cleanup Editors Note | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0218 | 1 | | Message format and Type values | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0220 | - | | S16 Influence | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0222 | 1 | | MM Context | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0223 | - | | F-Container | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0225 | - | | Change Reporting Action | 8.3.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|--------------------------------------------------------------------------------|-------| +| 2009-09 | CT#45 | CP-090533 | 0226 | 1 | | Procedure names | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0228 | 3 | | Changes to Create-Session-Request and Create-Session-Response messages | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0229 | 1 | | Changes to Modify-Bearer-Response | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0232 | 2 | | Piggybacking Clarifications | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0236 | 1 | | Delete Bearer Request Cause value for ISR deactivation | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0237 | 2 | | Modify Bearer Request Bearer Level QoS | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0239 | 1 | | Possible reject response Cause values in GTPv2 message descriptions | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0241 | 1 | | SGW F-TEID for S1-U, S12 and S4 for User Plane | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0243 | 2 | | Clarification on the usage of Version Not Supported Indication | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0244 | 1 | | Clarifications on Sender-F-TEID for CP and S3/S10/S16 CP IP Addr and TEID IEs | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0245 | 1 | | Cause Value in Echo Response | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0246 | - | | Corrections in ULI IE and PDN Connection IE definitions | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0247 | 3 | | GTPv2 Initial and Triggered Message definition and Sequence Number handling | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0249 | 1 | | Missing Cause values in some message descriptions | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0250 | 4 | | Add TAC to Target Identification IE | 8.3.0 | +| 2009-09 | CT#45 | CP-090533 | 0256 | 1 | | IMSI and Sender F-TEID in Create Indirect Data Forwarding Tunnel Messages | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0258 | 1 | | Indication in Forward Relocation messages | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0259 | 1 | | Paging cause | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0260 | - | | Correlate the bearers in the Create Bearer Response | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0261 | 3 | | Cleanup cause values | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0262 | 2 | | Delete Bearer Failure Indication | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0263 | 1 | | Cleanup Modify Bearer Request | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0264 | 2 | | IEs in Response | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0266 | - | | CS Paging Indication | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0267 | 2 | | Serving Network | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0268 | 3 | | Service Handover support | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0269 | 3 | | Fix incorrect interface name, incorrect reference and other misreading texts | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0270 | 1 | | Clarification on cause value for Downlink Data Notification Failure Indication | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0271 | 2 | | Clarification on the Authentication Vector handling | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0276 | 1 | | Clarification on Authentication Vector encoding | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0278 | 5 | | Clarification on Error indication for EPC and DT | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0279 | 3 | | Aligning MBR units to kbps | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0281 | 1 | | Clarification to the PGW's UP address in Create Session Response | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0282 | 4 | | Modify Bearer procedure for X2 and S1 based handovers | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0290 | 1 | | Add necessary cause value to the Update Bearer Response | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0292 | - | | Update on Concurrent Running of Security Procedures | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0295 | 2 | | APN Restriction IE | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0296 | 1 | | Change Reporting IE | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0297 | 1 | | ULI Clarification | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0301 | - | | Charging ID | 8.3.0 | +| 2009-09 | CT#45 | CP-090534 | 0302 | 1 | | Delete Indirect Data Forwarding Tunnel Request/Response | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0303 | 1 | | SGW F-TEID | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0304 | 1 | | BCM | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0307 | 3 | | Charging Gateway Address | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0308 | 1 | | LBI Clarifications for Gn/Gp Handovers | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0309 | 1 | | Trace management messages and IE related clarifications | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0310 | 1 | | Indirect Data Forwarding Tunnel clarifications | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0311 | 2 | | Concurrent Running of Security Procedures | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0315 | 1 | | Cause value corrections | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0316 | 1 | | Identification Response | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0317 | 1 | | NSAPI and EBI in Forward Relocation Response | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0318 | 1 | | Cause in the CSFB related messages | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0320 | 1 | | Update Bearer Complete | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0321 | 1 | | PCO IE | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0322 | - | | Cleanup Trace Management messages | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0323 | - | | Cleanup clause 5.3 and 8.12 | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0324 | 1 | | APN AMBR in the Create Bearer Request | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0325 | 1 | | UDP Source Port Number | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0326 | - | | Presence Requirements for grouped IE | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0330 | 1 | | Making PCO conditional for the Attach procedure | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0332 | - | | Echo usage alignment with stage 2 | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0334 | - | | Trace Depth per session | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0335 | 4 | | Backward compatibility requirements for presence | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0338 | 1 | | ECGI encoding correction | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0339 | 1 | | Consistent PDN type setting | 8.3.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------|-------| +| 2009-09 | CT#45 | CP-090535 | 0340 | 1 | | GTP Cause value usage | 8.3.0 | +| 2009-09 | CT#45 | CP-090729 | 0341 | 1 | | Partial failure handling alignment with stage 2 | 8.3.0 | +| 2009-09 | CT#45 | CP-090729 | 0342 | 2 | | Partial failure handling for MME relocation w/o SGW relocation | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0346 | 1 | | Security Specification for GTPV2-C | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0349 | 1 | | Avoiding Source Port Overlap between GTPv2-C and GTPv2-C' | 8.3.0 | +| 2009-09 | CT#45 | CP-090535 | 0350 | - | | Delete Bearer Command PCO removal | 8.3.0 | +| 2009-09 | CT#45 | CP-090559 | 0253 | 2 | | Scope of GTP-C protocol | 9.0.0 | +| 2009-09 | CT#45 | CP-090559 | 0254 | 4 | | MBMS session management messages | 9.0.0 | +| 2009-09 | CT#45 | CP-090562 | 0285 | 1 | | IMEI based GTP Changes | 9.0.0 | +| 2009-09 | CT#45 | CP-090745 | 0286 | 4 | | Unauthenticated IMSI for emergency in GTP | 9.0.0 | +| 2009-09 | CT#45 | CP-090562 | 0343 | 1 | | IMEI based Id in GTP messages | 9.0.0 | +| 2009-09 | CT#45 | CP-090562 | 0344 | 1 | | Unauthenticated IMSI in GTP messages | 9.0.0 | +| 2009-10 | CT#46 | | | | | Editorial correction. Wrong style was used in Paragraph character 7.1.3. | 9.0.1 | +| 2009-12 | CT#46 | CP-090769 | 0356 | 1 | | Selection Mode IE | 9.1.0 | +| 2009-12 | CT#46 | CP-090798 | 0357 | 2 | | PTP bearer fallback | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0359 | - | | Bearer QoS in Modify Bearer Request | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0361 | 1 | | Release Access Bearer Request | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0363 | - | | Bearer context in Create Session messages | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0365 | - | | ISRAI flag in the Forward Relocation Complete Notification | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0369 | - | | Mapping between RAI, P-TMSI, P-TMSI signature and GUTI | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0371 | 1 | | APN IE encoding | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0373 | 1 | | Correction on the condition for resource release of other CN node | 9.1.0 | +| 2009-12 | CT#46 | CP-090970 | 0375 | 2 | | APN Restriction | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0377 | 1 | | Cause value "Invalid reply from remote peer" | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0380 | 1 | | Indication Flags in Delete Session Request | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0382 | 1 | | Suspend | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0386 | - | | Removal of forwarding Charging Gateway Address/Name to S4-SGSN | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0388 | 2 | | Charging ID in S4-SGSN | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0390 | - | | Correction of Message Direction for Create Session Response | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0392 | 1 | | PPC (Prohibit Payload Compression) alignment with Stage-2 | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0393 | 3 | | UE TimeZone and ULI included in Bearer Response messages | 9.1.0 | +| 2009-12 | CT#46 | CP-090804 | 0395 | 4 | | Support for CSG based charging | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0397 | 3 | | User Location Information | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0399 | 2 | | PDN type | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0403 | - | | Removal of ULI from Release Access Bearer Req | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0405 | - | | Removal of NSAPI IE | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0407 | 2 | | Indication IE clarification | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0409 | 3 | | Addition of uplink, downlink F-TEIDs in Create Indirect Data Forwarding Tunnel Request and Response messages | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0411 | 2 | | Clarifications on use of the Sender-F-TEID for CP in HO procedure | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0417 | - | | Clarifications to MSISDN coding | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0419 | 2 | | Enhanced handling of RFSP index at the SGSN/MME | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0423 | 2 | | TFT related error handling | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0425 | 4 | | Essential correction to the Indirect Data Forwarding procedure | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0434 | - | | Correcting misaligned IE presence type statements | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0438 | 1 | | Correcting PCO conditions in Modify Bearer Response | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0442 | 2 | | Delete Indirect Data Forwarding Tunnel messages | 9.1.0 | +| 2009-12 | CT#46 | CP-090777 | 0448 | 1 | | SRVCC - voice bearer handling in PS HO / DTM scenarios | 9.1.0 | +| 2009-12 | CT#46 | CP-090975 | 0450 | 2 | | NAS Count value | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0452 | 1 | | Charging Characteristics value for active PDN connections | 9.1.0 | +| 2009-12 | CT#46 | CP-090786 | 0453 | 1 | | eNodeB Cause and RANAP Cause corrections | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0455 | - | | Change the NSAPI to EBI in the PFI IE | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0457 | - | | Enhanced SRNS Relocation Procedure | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0459 | - | | Forward Access Context Acknowledge | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0461 | - | | Correct the message Modify Bearer Request | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0471 | 1 | | Cleanup Suspend Notification message | 9.1.0 | +| 2009-12 | CT#46 | CP-090769 | 0475 | 1 | | Forward Relocation Request: Selected PLMN ID | 9.1.0 | +| 2009-12 | CT#46 | | | | | | 9.1.0 | +| 2009-12 | CT#46 | CP-090770 | 0484 | 1 | | Change Reporting Action | 9.1.0 | +| 2010-03 | CT#47 | CP-100021 | 0493 | 1 | | Essential clarification to MME executed TAU procedure | 9.2.0 | +| 2010-03 | CT#47 | CP-100022 | 0495 | 5 | | Essential correction to the MM context IE type | 9.2.0 | +| 2010-03 | CT#47 | CP-100021 | 0497 | 1 | | Resolving ambiguity for Target Identification IE coding | 9.2.0 | +| 2010-03 | CT#47 | CP-100021 | 0504 | - | | PCO | 9.2.0 | +| 2010-03 | CT#47 | CP-100021 | 0506 | 1 | | RFSP Index | 9.2.0 | +| 2010-03 | CT#47 | CP-100049 | 0508 | 1 | | Include CSG ID and CSG Membership Indication in S3 and S10 | 9.2.0 | +| 2010-03 | CT#47 | CP-100035 | 0510 | 2 | | Location change reporting in EPS | 9.2.0 | +| 2010-03 | CT#47 | CP-100019 | 0512 | - | | The encoding of APN IE | 9.2.0 | +| 2010-03 | CT#47 | CP-100021 | 0514 | 1 | | Indirect Data Forwarding | 9.2.0 | +| 2010-03 | CT#47 | CP-100021 | 0516 | 2 | | HSS/PGW initiated Bearer QoS Modification procedure | 9.2.0 | +| 2010-03 | CT#47 | CP-100022 | 0518 | 1 | | APN IE description correction | 9.2.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------|-------| +| 2010-03 | CT#47 | CP-100022 | 0520 | 2 | | P-TMSI Signature | 9.2.0 | +| 2010-03 | CT#47 | CP-100035 | 0521 | 1 | | Corrections to the RAN Information Management procedures | 9.2.0 | +| 2010-03 | CT#47 | CP-100021 | 0523 | | | Source Identification for E-UTRAN to GERAN handover | 9.2.0 | +| 2010-03 | CT#47 | CP-100049 | 0524 | 1 | | Handovers to HeNB cells | 9.2.0 | +| 2010-03 | CT#47 | CP-100022 | 0530 | 1 | | Granularity | 9.2.0 | +| 2010-03 | CT#47 | CP-100021 | 0533 | 2 | | Change Reporting Support Indicator | 9.2.0 | +| 2010 | CT#47 | CP-100021 | 0535 | | | MM Context IE type correction | 9.2.0 | +| 2010-03 | CT#47 | CP-100027 | 0537 | 2 | | Removal of TEIDs for PS voice bearer UP in Bearer Context for SRVCC | 9.2.0 | +| 2010-03 | CT#47 | CP-100021 | 0539 | | | Correction on the presence condition of Charging ID IE on S4 | 9.2.0 | +| 2010-03 | CT#47 | CP-100035 | 0541 | 3 | | Suspend | 9.2.0 | +| 2010-03 | CT#47 | CP-100022 | 0548 | 1 | | Modify Octets Sequence Number of RAB Context IE | 9.2.0 | +| 2010-03 | CT#47 | | | | | Revive the cause value "User Authentication Failed" in the Create Session Response | 9.2.0 | +| | | CP-100022 | 0550 | 1 | | | | +| 2010-03 | CT#47 | CP-100035 | 0554 | 1 | | Fix PCO handling by defining it per bearer | 9.2.0 | +| 2010 | CT#47 | CP-100022 | 0556 | 2 | | Fix PDN Connection Grouped Type | 9.2.0 | +| 2010-03 | CT#47 | CP-100022 | 0558 | 2 | | Correction on the down link notification failure procedure | 9.2.0 | +| 2010-03 | CT#47 | CP-100022 | 0565 | 2 | | Correction of the presence condition of IEs | 9.2.0 | +| 2010-03 | CT#47 | CP-100021 | 0567 | 1 | | Figure number, Information element and message usage | 9.2.0 | +| 2010-03 | CT#47 | | | | | 2G related parameters in the Forward Relocation Request and Context Response | 9.2.0 | +| | | CP-100022 | 0569 | 2 | | | | +| 2010-03 | CT#47 | CP-100022 | 0577 | 2 | | Essential correction to the Create Bearer Request message | 9.2.0 | +| 2010-03 | CT#47 | CP-100022 | 0581 | 1 | | Essential correction to FTEID IE | 9.2.0 | +| 2010-03 | CT#47 | | | | | Essential correction to Modify Bearer Request for non-3GPP to 3GPP handover | 9.2.0 | +| | | CP-100022 | 0583 | 2 | | | | +| 2010-03 | CT#47 | CP-100021 | 0585 | | | Removal of unnecessary cause "Unexpected repeated IE" | 9.2.0 | +| 2010-03 | CT#47 | CP-100022 | 0587 | 1 | | Removal of indirect uplink data forwarding from Inter RAT handovers | 9.2.0 | +| 2010-03 | CT#47 | CP-100021 | 0591 | 1 | | Trace alignment with TS 32.422 | 9.2.0 | +| 2010-06 | CT#48 | CP-100266 | 0599 | 1 | | Essential corrections to M-TMSI mapping | 9.3.0 | +| 2010-06 | CT#48 | CP-100266 | 0603 | 3 | | Change Notification | 9.3.0 | +| 2010-06 | CT#48 | | | | | Fix missing conditional description for IEs in the context response message | 9.3.0 | +| | | CP-100266 | 0605 | 1 | | | | +| 2010-06 | CT#48 | CP-100266 | 0614 | 1 | | Change Reporting Support Indication | 9.3.0 | +| 2010-06 | CT#48 | CP-100266 | 0618 | 1 | | Handover/Relocation cancel procedure | 9.3.0 | +| 2010-06 | CT#48 | CP-100266 | 0624 | 1 | | ULI in the Modify Bearer Request message | 9.3.0 | +| 2010-06 | CT#48 | CP-100266 | 0626 | 1 | | MM context IE encoding | 9.3.0 | +| 2010-06 | CT#48 | CP-100266 | 0635 | 2 | | MBR in handover from non-3GPP to 3GPP | 9.3.0 | +| 2010-06 | CT#48 | CP-100266 | 0637 | 1 | | Suspend over S16 | 9.3.0 | +| 2010-06 | CT#48 | CP-100266 | 0642 | 1 | | Adding Service indicator to CS Paging Indication | 9.3.0 | +| 2010-06 | CT#48 | CP-100266 | 0647 | 3 | | Fallback to GTPv1 | 9.3.0 | +| 2010-06 | CT#48 | | | | | Essential correction to ULI IE condition in Modify Bearer Request message | 9.3.0 | +| | | CP-100266 | 0650 | 2 | | | | +| 2010-06 | CT#48 | CP-100266 | 0657 | 1 | | TEID in Change Notification | 9.3.0 | +| 2010-06 | CT#48 | CP-100266 | 0659 | 1 | | Charging ID | 9.3.0 | +| 2010-06 | CT#48 | | | | | Alert MME Notification / UE Activity Notification procedure on S3 interface | 9.3.0 | +| | | CP-100266 | 0664 | | | | | +| 2010-06 | CT#48 | CP-100281 | 0540 | 4 | | Leave CSG Cell indication | 9.3.0 | +| 2010-06 | CT#48 | CP-100281 | 0609 | 1 | | Use of Rejection Cause values | 9.3.0 | +| 2010-06 | CT#48 | CP-100281 | 0616 | 2 | | Flow QoS in the Bearer Resource Command message | 9.3.0 | +| 2010-06 | CT#48 | CP-100281 | 0633 | 1 | | Correction to the reference in Create indirect DF Tunnel Request | 9.3.0 | +| 2010-06 | CT#48 | CP-100281 | 0638 | 1 | | Removal of FFS | 9.3.0 | +| 2010-06 | CT#48 | CP-100281 | 0673 | 1 | | Message type table | 9.3.0 | +| 2010-06 | CT#48 | CP-100281 | 0639 | 3 | | Implicit resume | 9.3.0 | +| 2010-06 | CT#48 | CP-100281 | 0670 | 1 | | Cause IE type | 9.3.0 | +| 2010-06 | CT#48 | CP-100281 | 0667 | 2 | | Clarifications to redundant IEs | 9.3.0 | +| 2010-06 | CT#48 | CP-100281 | 0669 | 1 | | EBI value range and coding | 9.3.0 | +| 2010-06 | CT#48 | | | | | Cause IE enhancements to distinguish errors in the message level IE versus errors in the grouped IE within the message | 9.3.0 | +| | | CP-100281 | 0651 | 1 | | | | +| 2010-06 | CT#48 | CP-100281 | 0672 | 1 | | Bearer Resource Command usage | 9.3.0 | +| 2010-06 | CT#48 | CP-100287 | 0654 | | | Sn-U SGSN F-TEID | 9.3.0 | +| 2010-06 | CT#48 | CP-100287 | 0640 | 2 | | Allocation and Retention Priority for MBMS E-RAB | 9.3.0 | +| 2010-06 | CT#48 | | | | | Handling of Create Session Request message on TEID 0 for existing PDN connection | 9.3.0 | +| | | CP-100266 | 0678 | 1 | | | | +| 2010-06 | CT#48 | CP-100298 | 0680 | | | Essential correction for the Initial Attach procedure | 9.3.0 | +| 2010-06 | CT#48 | | | | | Transferring of UE's usage setting and voice capability between CN nodes | 9.3.0 | +| | | CP-100276 | 0612 | | | | | +| 2010-06 | CT#48 | CP-100408 | 0544 | 6 | | Clarifying the bearers to be deactivated on the S5/S8 interface | 9.3.0 | +| 2010-09 | CT#49 | CP-100452 | 0607 | 5 | | Fix Sudden disconnection after the inter RAT MM attempt | 9.4.0 | +| 2010-09 | CT#49 | CP-100445 | 0630 | 4 | | IP Address IE clarification | 9.4.0 | +| 2010-09 | CT#49 | CP-100451 | 0681 | 2 | | Serving Network semantics | 9.4.0 | +| 2010-09 | CT#49 | CP-100444 | 0685 | | | Originating Node | 9.4.0 | +| 2010-09 | CT#49 | CP-100444 | 0687 | 1 | | Condition of ISRAI Flag | 9.4.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|--------------------------------------------------------------------------------------|--------| +| 2010-09 | CT#49 | CP-100444 | 0689 | 1 | | PDN Connection for Subscription Data Change | 9.4.0 | +| 2010-09 | CT#49 | CP-100580 | 0690 | 4 | | Clarification for Create Session Response | 9.4.0 | +| 2010-09 | CT#49 | CP-100452 | 0693 | 2 | | An exception to use GTPv2 | 9.4.0 | +| 2010-09 | CT#49 | CP-100452 | 0694 | | | IEs to be included in rejection response messages | 9.4.0 | +| 2010-09 | CT#49 | CP-100452 | 0695 | 2 | | Ambiguity for encoding MBR/GBR | 9.4.0 | +| 2010-09 | CT#49 | CP-100452 | 0696 | | | Wrong reference to DRX parameter | 9.4.0 | +| 2010-09 | CT#49 | CP-100452 | 0697 | | | Selection Mode | 9.4.0 | +| 2010-09 | CT#49 | CP-100452 | 0701 | 2 | | Stop CSG Information Reporting | 9.4.0 | +| 2010-09 | CT#49 | | | | | Create Session Request/Response and Modify Bearer Request/Response for RAU procedure | 9.4.0 | +| 2010-09 | CT#49 | CP-100452 | 0702 | | | | | +| 2010-09 | CT#49 | CP-100452 | 0703 | | | Suspend message on S3 interface | 9.4.0 | +| 2010-09 | CT#49 | CP-100445 | 0705 | 1 | | Cause value in Detach Notification | 9.4.0 | +| 2010-09 | CT#49 | CP-100445 | 0707 | 1 | | S1 based handover cancel | 9.4.0 | +| 2010-09 | CT#49 | CP-100445 | 0709 | 1 | | Used NAS integrity protection algorithm values | 9.4.0 | +| 2010-09 | CT#49 | CP-100452 | 0711 | 2 | | TAU with Active Flag | 9.4.0 | +| 2010-09 | CT#49 | CP-100452 | 0716 | 1 | | Trace Report File LDNs | 9.4.0 | +| 2010-09 | CT#49 | CP-100445 | 0718 | 1 | | Change Notification Response | 9.4.0 | +| 2010-09 | CT#49 | CP-100451 | 0723 | 1 | | Presence rules and error handling for embedded IEs | 9.4.0 | +| 2010-09 | CT#49 | CP-100451 | 0724 | 1 | | Dual Address Bearer Flag | 9.4.0 | +| 2010-09 | CT#49 | | | | | Rejecting the dedicated bearer related procedure from MME to SGW and PGW | 9.4.0 | +| 2010-09 | CT#49 | CP-100451 | 0726 | 1 | | | | +| 2010-09 | CT#49 | CP-100636 | 0727 | 2 | | Correction to condition of sending Context Acknowledge message | 9.4.0 | +| 2010-09 | CT#49 | CP-100451 | 0729 | 2 | | Clarification to the OI flag usage in Delete Session Request | 9.4.0 | +| 2010-09 | CT#49 | CP-100451 | 0732 | 1 | | Correcting non-existent Cause value | 9.4.0 | +| 2010-09 | CT#49 | CP-100444 | 0736 | 1 | | Resume messages | 9.4.0 | +| 2010-09 | CT#49 | CP-100444 | 0738 | 1 | | LAI field | 9.4.0 | +| 2010-09 | CT#49 | CP-100444 | 0740 | 1 | | P-TMSI Signature | 9.4.0 | +| 2010-09 | CT#49 | CP-100453 | 0744 | 2 | | Change Reporting Support Indication | 9.4.0 | +| 2010-09 | CT#49 | CP-100451 | 0745 | 1 | | Error handling | 9.4.0 | +| 2010-09 | CT#49 | CP-100451 | 0746 | 1 | | Flow QoS IE | 9.4.0 | +| 2010-09 | CT#49 | CP-100444 | 0748 | 1 | | PDN Connection for Subscription Data Change | 9.4.0 | +| 2010-09 | CT#49 | CP-100444 | 0750 | 1 | | E-UTRAN to HRPD handover | 9.4.0 | +| 2010-09 | CT#49 | CP-100451 | 0751 | | | Correcting type value of the MBMS Session Start Response message | 9.4.0 | +| 2010-09 | CT#49 | CP-100451 | 0754 | | | GTP protocol errors | 9.4.0 | +| 2010-09 | CT#49 | CP-100451 | 0755 | 1 | | Essential Clarification in Forward Relocation Response message | 9.4.0 | +| 2010-09 | CT#49 | CP-100469 | 0662 | 4 | | New Modify Access Bearers procedure | 10.0.0 | +| 2010-09 | CT#49 | CP-100469 | 0698 | 6 | | Notification of supported features between peer GTP-C entities | 10.0.0 | +| 2010-09 | CT#49 | CP-100469 | 0734 | 1 | | Length of IPv6 Prefix | 10.0.0 | +| 2010-12 | CT#50 | CP-100695 | 0758 | 1 | | OI flag in Delete Session Request alignment with stage | 10.1.0 | +| 2010-12 | CT#50 | CP-100695 | 0762 | 3 | | ISR in Delete Bearer Request | 10.1.0 | +| 2010-12 | CT#50 | CP-100695 | 0787 | 4 | | PGW Restart Notification | 10.1.0 | +| 2010-12 | CT#50 | CP-100695 | 0798 | 2 | | Feature definition for the Modify Access Bearers procedure | 10.1.0 | +| 2010-12 | CT#50 | CP-100695 | 0799 | 1 | | Modify Access Bearers procedure during Inter-MME Intra-SGW TAU | 10.1.0 | +| 2010-12 | CT#50 | CP-100695 | 0812 | 1 | | Clarifications to Failure Indication type of messages | 10.1.0 | +| 2010-12 | CT#50 | CP-100695 | 0817 | 2 | | EPS Bearer ID in Downlink Data Notification message | 10.1.0 | +| 2010-12 | CT#50 | CP-100695 | 0818 | 1 | | Clarifying possible cause value sets | 10.1.0 | +| 2010-12 | CT#50 | CP-100695 | 0823 | 2 | | SGSN Failure handling | 10.1.0 | +| 2010-12 | CT#50 | CP-100695 | 0835 | 1 | | Handover Indication | 10.1.0 | +| 2010-12 | CT#50 | CP-100695 | 0842 | 1 | | Cause values for Delete Bearer Request | 10.1.0 | +| 2010-12 | CT#50 | CP-100688 | 0848 | 2 | | MME/SGSN overload control by throttling of DL low priority traffic | 10.1.0 | +| 2010-12 | CT#50 | CP-100675 | 0773 | 1 | | Suspend and Resume procedure | 10.1.0 | +| 2010-12 | CT#50 | CP-100675 | 0775 | 1 | | Range for BSSGP Cause | 10.1.0 | +| 2010-12 | CT#50 | CP-100675 | 0777 | 1 | | RAT Type in the Modify Bearer Request message | 10.1.0 | +| 2010-12 | CT#50 | CP-100675 | 0781 | - | | ISR for SGW | 10.1.0 | +| 2010-12 | CT#50 | CP-100675 | 0783 | 1 | | ISR in the Detach procedure | 10.1.0 | +| 2010-12 | CT#50 | | | | | Missing Cause Code mapping for IRAT Handover between GERAN and EUTRAN | 10.1.0 | +| 2010-12 | CT#50 | CP-100675 | 0789 | 1 | | | | +| 2010-12 | CT#50 | CP-100675 | 0794 | - | | Voice bearer flag | 10.1.0 | +| 2010-12 | CT#50 | CP-100675 | 0801 | 1 | | MBMS corrections | 10.1.0 | +| 2010-12 | CT#50 | CP-100675 | 0821 | 1 | | CSG Reporting | 10.1.0 | +| 2010-12 | CT#50 | CP-100675 | 0825 | - | | Target Identification | 10.1.0 | +| 2010-12 | CT#50 | CP-100675 | 0830 | 2 | | Reporting UE Time Zone changes | 10.1.0 | +| 2010-12 | CT#50 | CP-100675 | 0838 | 1 | | Essential correction for UE Timezone reporting | 10.1.0 | +| 2010-12 | CT#50 | CP-100675 | 0846 | 2 | | ISR activated flag | 10.1.0 | +| 2010-12 | CT#50 | CP-100672 | 0851 | 1 | | Determination of type of source node during TAU/RAU | 10.1.0 | +| 2010-12 | CT#50 | | | | | Essential correction to Create Indirect Data Forwarding Tunnel Response | 10.1.0 | +| 2010-12 | CT#50 | CP-100674 | 0765 | 1 | | | | +| 2010-12 | CT#50 | CP-100686 | 0767 | 1 | | GTP-C Information Elements for GTP based S2b interface | 10.1.0 | +| 2010-12 | CT#50 | CP-100686 | 0786 | - | | Delete PDN Connection Set | 10.1.0 | +| 2010-12 | CT#50 | CP-100686 | 0796 | - | | Addition of GTP over S2b to clauses 1 to 6 | 10.1.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------------------|--------| +| 2010-12 | CT#50 | CP-100686 | 0797 | 3 | | Create Session Request/Response & Create Bearer Request/Response | 10.1.0 | +| 2010-12 | CT#50 | CP-100686 | 0802 | - | | Delete Session and Bearer messages | 10.1.0 | +| 2010-12 | CT#50 | CP-100686 | 0804 | - | | Modify Bearer Command/Failure Indication and Update Bearer Req/Rsp | 10.1.0 | +| 2010-12 | CT#50 | CP-100686 | 0807 | - | | Trace Session Activation/Deactivation for GTP-S2b | 10.1.0 | +| 2010-12 | CT#50 | CP-100686 | 0839 | 1 | | Handling of Create Session Request message on header TEID = 0 | 10.1.0 | +| 2010-12 | CT#50 | CP-100687 | 0769 | 2 | | Downlink data notification information for MPS services | 10.1.0 | +| 2010-12 | CT#50 | CP-100667 | 0828 | - | | UE Time Zone adjustments | 10.1.0 | +| 2010-12 | CT#50 | CP-100669 | 0816 | 2 | | Essential alignment with PMIP spec | 10.1.0 | +| 2011-03 | CT#51 | CP-110064 | 0921 | 1 | | Data Delay Notification | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0916 | - | | Clean up with GTP-C Information Elements | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0911 | 1 | | Inclusion of Node Type in DDN Failure Indication when the ISR is active | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0897 | 1 | | Create Session Response | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0896 | - | | UE Network Capability IE | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0895 | 2 | | Adding "Initial", "Triggered" and "Initial or triggered by a Command" attributes to the messages in table 6.1 | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0894 | 1 | | Adding a separate clause for TEID=0 | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0893 | 1 | | Removing optional Cause IE from Echo Response | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0875 | 2 | | RAT type clarification for S4-SGSN | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0874 | 1 | | Essential correction to the table NOTE for the Create Session Response message | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0872 | 1 | | Error Indication for SGW | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0871 | 1 | | Cleanup for GTPv2 | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0870 | 2 | | RAT Type in Modify Access Bearers Request | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0869 | - | | Bearer context in Modify Bearer Request | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0860 | - | | S1-U eNodeB F-TEID IE in the Modify Access Bearers Request | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0855 | 1 | | Correction for VNSI | 10.2.0 | +| 2011-03 | CT#51 | CP-110064 | 0844 | 6 | | Serving Network IE | 10.2.0 | +| 2011-03 | CT#51 | CP-110061 | 0856 | 2 | | APN based congestion control | 10.2.0 | +| 2011-03 | CT#51 | CP-110061 | 0858 | 1 | | Low access priority indicator | 10.2.0 | +| 2011-03 | CT#51 | CP-110060 | 0859 | 1 | | EBI and ARP IEs in Downlink Data Notification | 10.2.0 | +| 2011-03 | CT#51 | CP-110049 | 0918 | 2 | | Protocol Configuration Options (PCO) in Delete Bearer Response | 10.2.0 | +| 2011-03 | CT#51 | CP-110049 | 0901 | 1 | | UE Time Zone condition Delete Session Request | 10.2.0 | +| 2011-03 | CT#51 | CP-110049 | 0889 | 3 | | Subscribed UE-AMBR in mobility procedure | 10.2.0 | +| 2011-03 | CT#51 | CP-110049 | 0884 | 5 | | Essential correction to the fallback to GTPv1 feature | 10.2.0 | +| 2011-03 | CT#51 | CP-110049 | 0881 | 1 | | RAT Type in the Modify bearer request message | 10.2.0 | +| 2011-03 | CT#51 | CP-110049 | 0879 | - | | Missed procedures for the Delete Session Request and Response messages | 10.2.0 | +| 2011-03 | CT#51 | CP-110049 | 0866 | 1 | | Correction to passing of LDN | 10.2.0 | +| 2011-03 | CT#51 | CP-110049 | 0862 | - | | S103 resource release | 10.2.0 | +| 2011-03 | CT#51 | CP-110049 | 0886 | - | | Essential correction to the to GTPv2 cause table | 10.2.0 | +| 2011-03 | CT#51 | CP-110042 | 0914 | 1 | | Essential correction to the encoding of Target RNC-ID | 10.2.0 | +| 2011-03 | CT#51 | CP-110056 | 0887 | 5 | | Unsupported Bearer Handling for LIPA | 10.2.0 | +| 2011-03 | CT#51 | CP-110083 | 0892 | 3 | | Adding IMSI to DDN | 10.2.0 | +| 2011-03 | CT#51 | CP-110053 | 0899 | 1 | | Temporary Mobile Group Identity | 10.2.0 | +| 2011-03 | CT#51 | CP-110042 | 0867 | 1 | | Correcting IE Type for Bearer QoS IE from Variable to Extendable | 10.2.0 | +| 2011-03 | CT#51 | CP-110266 | 0903 | 2 | | UE Time Zone condition in Modify Bearer Request | 10.2.0 | +| 2011-03 | CT#51 | CP-110059 | 0915 | - | | Serving network in the Create Session Request message | 10.2.0 | +| 2011-03 | CT#51 | CP-110072 | 0923 | - | | CS BIT to be available for initial message | 10.2.0 | +| 2011-05 | | | | | | Editorial correction in clause 7.10 because of misimplementation of CT#51 agreed CR C4-110990 | 10.2.1 | +| 2011-06 | CT#52 | CP-110355 | 0927 | 2 | | Mapping of ASN.1/PER parameters to GTPv2 IEs | 10.3.0 | +| 2011-06 | CT#52 | CP-110355 | 0940 | 3 | | Downlink Data Notification for S4 | 10.3.0 | +| 2011-06 | CT#52 | CP-110355 | 0964 | 1 | | IE Type Extendable Corrections | 10.3.0 | +| 2011-06 | CT#52 | CP-110366 | 0930 | 2 | | Fix SRVCC related data transfer between MMEs/SGSNs | 10.3.0 | +| 2011-06 | CT#52 | CP-110366 | 0932 | 1 | | UE Time Zone IE in Delete Session Request message | 10.3.0 | +| 2011-06 | CT#52 | CP-110366 | 0943 | 1 | | Higher bitrates than 16 Mbps flag | 10.3.0 | +| 2011-06 | CT#52 | CP-110366 | 0953 | 1 | | Temporary Rejection Cause | 10.3.0 | +| 2011-06 | CT#52 | CP-110366 | 0958 | 1 | | Cause IE in DDN message | 10.3.0 | +| 2011-06 | CT#52 | CP-110378 | 0928 | 2 | | Alignment with stage 2 for EPC node restart with active ISR | 10.3.0 | +| 2011-06 | CT#52 | CP-110374 | 0924 | 1 | | Setting a sequence number in a Command | 10.3.0 | +| 2011-06 | CT#52 | CP-110374 | 0941 | 1 | | Clarification for Create Session Response | 10.3.0 | +| 2011-06 | CT#52 | CP-110374 | 0944 | 2 | | Max MBR/APN-AMBR | 10.3.0 | +| 2011-06 | CT#52 | CP-110374 | 0947 | 3 | | Inactive Emergency PDN Handling | 10.3.0 | +| 2011-06 | CT#52 | CP-110374 | 0948 | | | ARP supporting on M3 interface for MBMS | 10.3.0 | +| 2011-06 | CT#52 | CP-110374 | 0949 | | | Downlink Data Notification message | 10.3.0 | +| 2011 | CT#52 | CP-110374 | 0950 | 1 | | Serving Network | 10.3.0 | +| 2011-06 | CT#52 | CP-110374 | 0956 | 2 | | Serving Network IE in Modify Bearer Request | 10.3.0 | +| 2011-06 | CT#52 | CP-110369 | 0945 | | | LAPI during UE initiated bearer resource allocation / modification procedures | 10.3.0 | +| 2011-08 | | | | | | Editorial correction in clause 7.10 because of misimplementation of CT#51 agreed CR C4-110990 | 10.3.1 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------|--------| +| 2011-09 | CT#53 | CP-110721 | 0969 | 1 | | Additional MM context for SRVCC | 10.4.0 | +| 2011-09 | CT#53 | CP-110557 | 0977 | 1 | | Condition for sending Cause IE with DBReq during a HO from 3GPP to non-3GPP | 10.4.0 | +| 2011-09 | CT#53 | CP-110557 | 0986 | 1 | | Essential Clarification for SGSN pool | 10.4.0 | +| 2011-09 | CT#53 | CP-110557 | 0994 | 1 | | Essential correction to handling of EPDN session for UICCless UE | 10.4.0 | +| 2011-09 | CT#53 | CP-110557 | 0996 | 1 | | Correction to ULI and UCI IE inclusion condition in Change Notification Req | 10.4.0 | +| 2011-09 | CT#53 | CP-110557 | 1000 | 1 | | Correction to header TEID of Suspend Notification over S3/S16 | 10.4.0 | +| 2011-09 | CT#53 | CP-110557 | 1002 | 1 | | Extended IE handling when received fields are less than expected fields | 10.4.0 | +| 2011-09 | CT#53 | CP-110557 | 1016 | 1 | | Cause Code for DDN | 10.4.0 | +| 2011-09 | CT#53 | CP-110574 | 0975 | 3 | | MDT configuration information | 10.4.0 | +| 2011-09 | CT#53 | CP-110567 | 0980 | | | Correction to Create Session Response LDN IEs | 10.4.0 | +| 2011-09 | CT#53 | CP-110567 | 0982 | 2 | | IP address parameter | 10.4.0 | +| 2011-09 | CT#53 | CP-110567 | 0967 | 1 | | Signalling path failure handling | 10.4.0 | +| 2011-09 | CT#53 | CP-110567 | 0983 | 1 | | Node Type | 10.4.0 | +| 2011-09 | CT#53 | CP-110567 | 0987 | 1 | | Clarification for Context Not Found | 10.4.0 | +| 2011-09 | CT#53 | CP-110567 | 0988 | 1 | | Recovery IE in MBMS Session Stop Response message | 10.4.0 | +| 2011-09 | CT#53 | CP-110567 | 1001 | | | Removal of PCO from Failed Bearer Context of Delete Bearer Request | 10.4.0 | +| 2011-09 | CT#53 | CP-110567 | 1006 | | | Downlink Data Notification for S4 | 10.4.0 | +| 2011-09 | CT#53 | CP-110557 | 1010 | 1 | | MEI in Modify Bearer Request | 10.4.0 | +| 2011-09 | CT#53 | CP-110577 | 0972 | 1 | | OI flag in Delete Session Request | 11.0.0 | +| 2011-09 | CT#53 | CP-110577 | 0973 | 1 | | Clarification to DAF PAA usage | 11.0.0 | +| 2011-09 | CT#53 | CP-110577 | 0974 | | | Correcting Port Number IE type definition | 11.0.0 | +| 2011-09 | CT#53 | CP-110584 | 0989 | 3 | | Add vSRVCC updates to the GTP based interfaces | 11.0.0 | +| 2011-09 | CT#53 | CP-110577 | 0990 | 1 | | Clarification on the Bearer Contexts to be removed IE in Modify Access Bearers Request message | 11.0.0 | +| 2011-09 | | | | | | CR 0914r1 title in history table corrected as in CR database. | 11.0.1 | +| 2011-12 | CT#54 | CP-110810 | 1026 | | | Delete Session Response | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1037 | 1 | | Bearer Resource Command | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1049 | | | Clarification on the length restriction of PCO, TFT IE | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1035 | 1 | | Correction on SGW-FQ-CSID | 11.1.0 | +| 2011-12 | CT#54 | CP-110790 | 1051 | 3 | | Correction to Downlink Data Notification message due to control plane signalling | 11.1.0 | +| 2011-12 | CT#54 | CP-110790 | 1048 | 2 | | MBMS IP Multicast Distribution IE | 11.1.0 | +| 2011-12 | CT#54 | CP-110784 | 1054 | 2 | | Defining the fixed number of octets for extendable IEs | 11.1.0 | +| 2011-12 | CT#54 | CP-110790 | 1063 | | | Delete Session Request granularity | 11.1.0 | +| 2011-12 | CT#54 | CP-110782 | 1058 | 2 | | Essential correction to the TAD IE inclusion in Bearer Resource Command over S4 | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1059 | 2 | | Fix inconsistency within the specification for GTP version handling | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1036 | | | IE conditions in some message | 11.1.0 | +| 2011-12 | CT#54 | CP-110790 | 1065 | 1 | | Indirect Data Forwarding messages | 11.1.0 | +| 2011-12 | CT#54 | CP-110790 | 1019 | 2 | | Referencing Information Elements defined outside GTP | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1033 | 1 | | Scope Indication IE in Delete Session Request | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1061 | 1 | | ULI in the Create Session Request | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1038 | 1 | | Update PDN Connection Set Request | 11.1.0 | +| 2011-12 | CT#54 | CP-110784 | 1022 | 2 | | Essential clarification on F-TEID in Create Bearer Response | 11.1.0 | +| 2011-12 | CT#54 | CP-110784 | 1030 | 3 | | Modify Bearer Request as implicit resume | 11.1.0 | +| 2011-12 | CT#54 | CP-110784 | 1080 | 2 | | User CSG Information in TAU/RAU procedures | 11.1.0 | +| 2011-12 | CT#54 | CP-110784 | 1083 | 2 | | Missing Originating Node IE when ISR is active | 11.1.0 | +| 2011-12 | CT#54 | CP-110784 | 1088 | 1 | | Correction to the Sender F-TEID IE description of the Forward Relocation Request | 11.1.0 | +| 2011-12 | CT#54 | CP-110784 | 1103 | 2 | | Missing Cause Value for MUPSPAP | 11.1.0 | +| 2011-12 | CT#54 | CP-110784 | 1106 | 2 | | Downlink bearers release during mobility procedure | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1027 | 2 | | SRNS relocation w/o PDN connection | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1066 | 3 | | PDN Type and DAF dependency case | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1072 | 1 | | TFT in the SGW for PMIP based S5/S8 interface | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1073 | 1 | | MBMS Flow ID in the MBMS Session Stop message | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1085 | 2 | | Change Notification Reporting with Non-Zero TEID | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1090 | 1 | | LBI in the Delete Bearer Request | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1091 | - | | DRX parameter | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1092 | - | | ZUC based EEA3 and EIA3 security algorithm | 11.1.0 | +| 2011-12 | CT#54 | CP-110810 | 1098 | 2 | | Suspend Notification | 11.1.0 | +| 2011-12 | CT#54 | CP-110790 | 1075 | 1 | | PCO IE in the Modify Bearer Request message | 11.1.0 | +| 2011-12 | CT#54 | CP-110790 | 1094 | 1 | | IMEI not known cause | 11.1.0 | +| 2011-12 | CT#54 | CP-110790 | 1096 | 2 | | Correction on the bearer context for modification procedure | 11.1.0 | +| 2011-12 | CT#54 | CP-110790 | 1108 | - | | UE Time Zone condition in Modify Bearer Request | 11.1.0 | +| 2011-12 | CT#54 | CP-110815 | 1067 | 1 | | PGW restoration upon PGW failure w/o restart | 11.1.0 | +| 2011-12 | CT#54 | CP-110792 | 1070 | 3 | | Authentication with external networks over GTP S2b | 11.1.0 | +| 2011-12 | CT#54 | CP-110816 | 1086 | - | | Add vSRVCC indicator to Delete Bearer Command | 11.1.0 | +| 2012-03 | CT#55 | CP-120017 | 1117 | - | | Handover to CSG cell with emergency bearer | 11.2.0 | +| 2012-03 | CT#55 | CP-120017 | 1120 | - | | Pre-Rel-7 QoS description correction | 11.2.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------------|--------| +| 2012-03 | CT#55 | CP-120017 | 1126 | 2 | | Reserved Bearer Context at SRNS Relocation | 11.2.0 | +| 2012-03 | CT#55 | CP-120017 | 1146 | 2 | | Higher bitrates than 16 Mbps flag | 11.2.0 | +| 2012-03 | CT#55 | CP-120017 | 1180 | 1 | | ULI reporting for S4 | 11.2.0 | +| 2012-03 | CT#55 | CP-120026 | 1133 | 6 | | UE Requested Bearer Resource Modification Procedure | 11.2.0 | +| 2012-03 | CT#55 | CP-120026 | 1135 | - | | Presence requirements of Information Elements | 11.2.0 | +| 2012-03 | CT#55 | CP-120026 | 1141 | 2 | | Max MBR/APN-AMBR in enhanced SRNS relocation procedure | 11.2.0 | +| 2012-03 | CT#55 | CP-120026 | 1147 | 1 | | Clarification of Echo Response | 11.2.0 | +| 2012-03 | CT#55 | CP-120026 | 1152 | 1 | | Location change reporting support indication related correction | 11.2.0 | +| 2012-03 | CT#55 | CP-120026 | 1154 | 1 | | Fix Inter RAT HO issue when ISR active | 11.2.0 | +| 2012-03 | CT#55 | CP-120036 | 1077 | 4 | | Bearer Context to be modified in the Modify Bearer Request message | 11.2.0 | +| 2012-03 | CT#55 | CP-120036 | 1113 | 2 | | Mapping between S11/S4 and NAS Cause values | 11.2.0 | +| 2012-03 | CT#55 | CP-120036 | 1114 | 1 | | Absolute time for MBMS data transfer start and stop | 11.2.0 | +| 2012-03 | CT#55 | CP-120036 | 1155 | 1 | | Cause code description | 11.2.0 | +| 2012-03 | CT#55 | CP-120036 | 1158 | - | | SRVCC PS to CS Response | 11.2.0 | +| 2012-03 | CT#55 | CP-120036 | 1170 | 1 | | Charging ID for Non-3GPP IP Access | 11.2.0 | +| 2012-03 | CT#55 | CP-120036 | 1171 | 1 | | Sender's F-TEID for Control Plane | 11.2.0 | +| 2012-03 | CT#55 | CP-120036 | 1173 | 1 | | Clean up of the irrelevant cause codes from the GTPv2 triggered messages | 11.2.0 | +| 2012-03 | CT#55 | CP-120036 | 1175 | 2 | | PGW based provisioning of the DNS server address for the S2b interface | 11.2.0 | +| 2012-03 | CT#55 | CP-120036 | 1177 | - | | GTPv2 header | 11.2.0 | +| 2012-03 | CT#55 | CP-120042 | 1159 | 2 | | New IEs for ePDG scenario | 11.2.0 | +| 2012-03 | CT#55 | CP-120041 | 1161 | - | | Voice/Video bearer for vSRVCC | 11.2.0 | +| 2012-03 | CT#55 | CP-120045 | 1163 | - | | Addition of GTP based S2a in clauses 1 to 6 | 11.2.0 | +| 2012-03 | CT#55 | CP-120045 | 1164 | 1 | | Create Session Request on GTP based S2a | 11.2.0 | +| 2012-03 | CT#55 | CP-120045 | 1165 | 1 | | Create Bearer Request on GTP based S2a | 11.2.0 | +| 2012-03 | CT#55 | CP-120045 | 1166 | 1 | | Delete Session Request & Delete Bearer Request on GTP based S2a | 11.2.0 | +| 2012-03 | CT#55 | CP-120045 | 1167 | 1 | | Modify Bearer Command & Update Bearer Request on GTP based S2a | 11.2.0 | +| 2012-03 | CT#55 | CP-120045 | 1168 | 1 | | Trace Session Activation & Deactivation on GTP based S2a | 11.2.0 | +| 2012-03 | CT#55 | CP-120045 | 1169 | - | | Delete PDN Connection Set on GTP based S2a | 11.2.0 | +| 2012-06 | CT#56 | CP-120230 | 1156 | 1 | | CSR and MBR message for SGW restoration procedure | 11.3.0 | +| 2012-06 | CT#56 | CP-120230 | 1157 | 3 | | Context Response message | 11.3.0 | +| 2012-06 | CT#56 | CP-120233 | 1162 | 2 | | Reporting of H(e)NB local IP address and port | 11.3.0 | +| 2012-06 | CT#56 | CP-120228 | 1182 | 5 | | | | +| 2012-06 | CT#56 | CP-120228 | 1183 | 5 | | Adding Originating Node IE to the Delete Session Request for ISR cases | 11.3.0 | +| 2012-06 | CT#56 | CP-120233 | 1186 | 1 | | Updated UE local IP in S2b procedure | 11.3.0 | +| 2012-06 | CT#56 | CP-120240 | 1187 | 2 | | Network provided Location Information | 11.3.0 | +| 2012-06 | CT#56 | CP-120224 | 1191 | 1 | | CFSI in the modify access bearers request | 11.3.0 | +| 2012-06 | CT#56 | CP-120228 | 1194 | - | | The usage of TEID0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120230 | 1195 | - | | Inclusion of MME/S4-SGSN Identifier | 11.3.0 | +| 2012-06 | CT#56 | CP-120230 | 1196 | 1 | | PGW Downlink Triggering Notification/Acknowledge | 11.3.0 | +| 2012-06 | CT#56 | CP-120234 | 1197 | 2 | | Additions for CS to PS SRVCC | 11.3.0 | +| 2012-06 | CT#56 | CP-120228 | 1198 | 1 | | Mapping of NAS ESM/SM Cause codes to S11/S4 Cause codes | 11.3.0 | +| 2012-06 | CT#56 | CP-120228 | 1199 | 3 | | Release of old S3 GTP-C TEIDs during I-RAT HO with ISR active | 11.3.0 | +| 2012-06 | CT#56 | CP-120228 | 1200 | 2 | | ULI inclusion condition during Service Request procedure when ISR is active | 11.3.0 | +| 2012-06 | CT#56 | CP-120238 | 1201 | 1 | | Addition of Subnet Mask and Default Router Address in Create Session Response for Trusted WLAN Access over S2a | 11.3.0 | +| 2012-06 | CT#56 | CP-120228 | 1202 | 1 | | Clarify mandatory/conditional IE inclusion in error response msg | 11.3.0 | +| 2012-06 | CT#56 | CP-120228 | 1210 | 2 | | TAD in the Bearer Resource Command message | 11.3.0 | +| 2012-06 | CT#56 | CP-120228 | 1211 | - | | More choices of mapping between GTPv2 cause code to the NAS ESM/SM Cause codes | 11.3.0 | +| 2012-06 | CT#56 | CP-120228 | 1213 | 1 | | Extended RNC ID in Target Identification IE | 11.3.0 | +| 2012-06 | CT#56 | CP-120228 | 1214 | 1 | | Clarification to "SGW node name" & "SGW S11/S4 IP Address and TEID for Control Plane" IE presence conditions | 11.3.0 | +| 2012-09 | CT#57 | CP-120448 | 1230 | - | | SGW DL/UL F-TEID for data forwarding in Forward Relocation Response message | 11.4.0 | +| 2012-09 | CT#57 | CP-120477 | 1216 | 1 | | RAT Type for EPC access via TWAN | 11.4.0 | +| 2012-09 | CT#57 | CP-120457 | 1217 | - | | Encoding of Absolute Time of MBMS Data Transfer | 11.4.0 | +| 2012-09 | CT#57 | CP-120457 | 1219 | 2 | | Sender's F-TEID in the Forward Relocation Response | 11.4.0 | +| 2012-09 | CT#57 | CP-120457 | 1221 | - | | Presence condition of APN-AMBR in the Modify Bearer Response message | 11.4.0 | +| 2012-09 | CT#57 | CP-120457 | 1222 | 2 | | GTP Tunnel | 11.4.0 | +| 2012-09 | CT#57 | CP-120457 | 1224 | 1 | | Delete Session Request usage in SGW with active ISR | 11.4.0 | +| 2012-09 | CT#57 | CP-120457 | 1226 | - | | Context Request note error | 11.4.0 | +| 2012-09 | CT#57 | CP-120457 | 1228 | - | | PAA clarification for PDN type IPv4v6 | 11.4.0 | +| 2012-09 | CT#57 | CP-120457 | 1232 | 2 | | F-TEID interface types for Indirect Forwarding | 11.4.0 | +| 2012-09 | CT#57 | CP-120457 | 1233 | 2 | | Zero TEID Usage In Relocation Cancel Response | 11.4.0 | +| 2012-09 | CT#57 | CP-120457 | 1235 | 1 | | PDP connection inactivity timer expires | 11.4.0 | +| 2012-09 | CT#57 | CP-120475 | 1220 | 1 | | MSV flag in rSRVCC procedure | 11.4.0 | +| 2012-09 | CT#57 | CP-120475 | 1236 | - | | Selected PLMN ID | 11.4.0 | +| 2012-09 | CT#57 | CP-120656 | 1237 | 1 | | Reference list correction to align with the corrected TS 29.212 title | 11.4.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------|--------| +| 2012-12 | CT#58 | CP-120718 | 1240 | 1 | | Removal of Maximum MBR/APN-AMBR | 11.5.0 | +| 2012-12 | CT#58 | CP-120718 | 1243 | 3 | | Change to Report Flags for delayed reporting of change of SN/TZ during inter-CN node mobility | 11.5.0 | +| 2012-12 | CT#58 | CP-120718 | 1270 | 1 | | Additional MBR for delayed reporting of change of SN/TZ/UCI | 11.5.0 | +| 2012-12 | CT#58 | CP-120718 | 1291 | 3 | | Delete Bearer Request with ISR deactivation | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1231 | 4 | | Adding a Cause Value in Delete Session Request message | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1238 | - | | Forward Relocation Request over the S3 interface | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1244 | - | | Corrections to reference titles and octet numbering of IE definitions | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1245 | - | | Clarifications on sending/new node and receiving/old node about Identification Request message | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1246 | - | | Multiple CSID | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1247 | - | | TEID of the Change Notification Request and Response messages | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1253 | 3 | | Suspend Notification/Acknowledge message in SGSN pool | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1254 | - | | Sender F-TEID IE in Modify Bearer Request message | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1262 | 1 | | Clarification of Delete Bearer Failure Indication | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1263 | 2 | | Cause value "ISR deactivation" | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1264 | 1 | | IPv4 address allocation | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1265 | 1 | | Sender F-TEID in DDN msg (network triggered service restoration procedure) | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1268 | - | | Correction to IP Address Instance values in CSReq & MBReq | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1273 | - | | Clarifications on value definitions of PDN Type, Security Mode and Used NAS Cipher IE | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1276 | 1 | | Clarification on UCI in Create Session Request message during SGW relocation | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1283 | 1 | | Change reporting requested by PCRF | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1294 | 1 | | Selected PLMN ID | 11.5.0 | +| 2012-12 | CT#58 | CP-120739 | 1271 | 1 | | Sender F-TEID in PGW Downlink Triggering Notification | 11.5.0 | +| 2012-12 | CT#58 | CP-120739 | 1278 | 2 | | SGW failure when ISR is active enhancement | 11.5.0 | +| 2012-12 | CT#58 | CP-120733 | 1272 | 2 | | TWAN operator identification for EPC access charging | 11.5.0 | +| 2012-12 | CT#58 | CP-120733 | 1286 | 3 | | Trusted WLAN AP identity over GTP S2a | 11.5.0 | +| 2012-12 | CT#58 | CP-120726 | 1279 | 1 | | H(e)NB local IP address/port in create session request | 11.5.0 | +| 2012-12 | CT#58 | CP-120710 | 1257 | 2 | | Removal of TFT IE from Create Session Response message | 11.5.0 | +| 2012-12 | CT#58 | CP-120744 | 1258 | 1 | | Clarifications on RAT Type Values "UTRAN" and "HSPA evolution" | 11.5.0 | +| 2013-03 | CT#59 | CP-130021 | 1306 | 2 | | Populating Serving Network | 11.6.0 | +| 2013-03 | CT#59 | CP-130021 | 1307 | 2 | | IMSI in Suspend Notification for UICless Emergency Call | 11.6.0 | +| 2013-03 | CT#59 | CP-130018 | 1310 | 2 | | User CSG Information reporting during inter-MME/SGSN mobility | 11.6.0 | +| 2013-03 | CT#59 | CP-130027 | 1320 | - | | Sending SSID for SaMOG in GTP | 11.6.0 | +| 2013-03 | CT#59 | CP-130029 | 1296 | 1 | | Bearer QoS | 12.0.0 | +| 2013-03 | CT#59 | CP-130029 | 1297 | 1 | | Clarification of term "PS mobility" | 12.0.0 | +| 2013-03 | CT#59 | CP-130029 | 1302 | 1 | | Corrections to abbreviation of Radio Access Technology and definition of cause value | 12.0.0 | +| 2013-03 | CT#59 | CP-130029 | 1303 | 1 | | Corrections to descriptions of RFSP Index | 12.0.0 | +| 2013-03 | CT#59 | CP-130029 | 1311 | 1 | | Correct the NOTE for Cause value | 12.0.0 | +| 2013-03 | CT#59 | CP-130029 | 1312 | 1 | | Corrections to Table Content, IE and Text Color | 12.0.0 | +| 2013-03 | CT#59 | CP-130029 | 1316 | 1 | | Cause value in Update PDN Connection Set Response | 12.0.0 | +| 2013-03 | CT#59 | CP-130029 | 1318 | 1 | | EPS bearer ID derived for Downlink Data Notification | 12.0.0 | +| 2013-03 | CT#59 | CP-130029 | 1319 | 1 | | Correcting the Flow QoS IE reference for Bearer Resource Command | 12.0.0 | +| 2013-03 | CT#59 | CP-130031 | 1308 | 1 | | Clarification of Resume when S4-U is enabled | 12.0.0 | +| 2013-03 | CT#59 | CP-130031 | 1313 | 1 | | Stop Paging Indication in service restoration procedure | 12.0.0 | +| 2013-06 | CT#60 | CP-130304 | 1324 | 1 | | Direct Tunnel Flag | 12.1.0 | +| 2013-06 | CT#60 | CP-130304 | 1322 | - | | Handling ASN.1/PER encoded parameters | 12.1.0 | +| 2013-06 | CT#60 | CP-130304 | 1321 | 2 | | Presence requirements clarification | 12.1.0 | +| 2013-06 | CT#60 | CP-130304 | 1330 | 3 | | CR on Unaccepted PDN connection during TAU and Handover | 12.1.0 | +| 2013-06 | CT#60 | CP-130304 | 1343 | 1 | | TWAN Identifier | 12.1.0 | +| 2013-06 | CT#60 | CP-130304 | 1339 | 1 | | Missing Recovery IE | 12.1.0 | +| 2013-06 | CT#60 | CP-130304 | 1337 | 2 | | The setting EPS bearer ID/ARP for MME paging strategy | 12.1.0 | +| 2013-06 | CT#60 | CP-130304 | 1336 | 2 | | Delete Bearer Request triggered by PMIP error indication message | 12.1.0 | +| 2013-06 | CT#60 | CP-130304 | 1332 | 1 | | Prohibit Payload Compression Indication Corrections | 12.1.0 | +| 2013-06 | CT#60 | CP-130296 | 1341 | 2 | | ULI Timestamp | 12.1.0 | +| 2013-06 | CT#60 | CP-130378 | 1323 | 1 | | SIPTO at the local network | 12.1.0 | +| 2013-06 | CT#60 | CP-130282 | 1346 | - | | Removal of TFT IE from Create Session Response message | 12.1.0 | +| 2013-06 | CT#60 | CP-130290 | 1329 | 2 | | Bearer Context to be modified in Modify Bearer Request | 12.1.0 | +| 2013-09 | CT#61 | CP-130449 | 1350 | 1 | | Reporting ULI and TimeZone at MME-initiated bearer related procedures | 12.2.0 | +| 2013-09 | CT#61 | CP-130454 | 1347 | 1 | | New MBMS flags for eMBMS restoration | 12.2.0 | +| 2013-09 | CT#61 | CP-130467 | 1348 | 1 | | Serving Network IE definition | 12.2.0 | +| 2013-09 | CT#61 | CP-130467 | 1354 | 3 | | Indication Flags | 12.2.0 | +| 2013-09 | CT#61 | CP-130467 | 1355 | 2 | | Sending Recovery IE in GTPv2-C messages | 12.2.0 | +| 2013-09 | CT#61 | CP-130467 | 1361 | 2 | | Enforcing access restriction during I-RAT RAU/TAU procedures | 12.2.0 | +| 2013-09 | CT#61 | CP-130467 | 1371 | 1 | | Modify Access Bearer for Intra TAU w/o SGW change | 12.2.0 | +| 2013-09 | CT#61 | CP-130467 | 1372 | 1 | | GTP-C message types for rSRVCC | 12.2.0 | +| 2013-09 | CT#61 | CP-130446 | 1352 | 1 | | Returning to former LTE PLMN after CSFB | 12.2.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2013-09 | CT#61 | CP-130443 | 1363 | 1 | | Inclusion of ePDG IP address of IKEv2 tunnel endpoint on S2b-GTP | 12.2.0 | +| 2013-09 | CT#61 | CP-130453 | 1364 | 1 | | SIPTO at the Local Network | 12.2.0 | +| 2013-09 | CT#61 | CP-130462 | 1365 | 1 | | GERAN Iu Mode | 12.2.0 | +| 2013-09 | CT#61 | CP-130470 | 1366 | - | | Update to cover the S121 | 12.2.0 | +| 2013-09 | CT#61 | CP-130583 | 1368 | 4 | | ULI Timestamp IE format | 12.2.0 | +| 2013-12 | CT#62 | CP-130626 | 1374 | 3 | | Reporting the RAN/NAS release cause during bearer release procedures | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1375 | - | | MM Context IE in Identification Response | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1376 | 4 | | Core Network Operator selection origin | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1378 | 1 | | Correct Presence requirement for Conditional IE | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1382 | 1 | | Delete Session Request/Response | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1383 | 1 | | Correction the ULI for RAI IE | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1384 | 1 | | Correct the Message Type value reserved for S101 | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1385 | 1 | | Harmonisation of the abbreviation LBI | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1391 | 1 | | Variable length parameters in GTPv2 IEs | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1392 | 1 | | Removing APN-AMBR from Modify Bearer Response | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1393 | 1 | | Clarification on encoding of bit rates when converting bits per second received over Diameter interfaces to kilo bits per second over GTPv2. | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1396 | 2 | | Correct the value of the Selection Mode IE | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1397 | 1 | | Cause IE condition in the Delete Session Request | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1398 | 2 | | S1-U eNodeB F-TEID in Create Bearer Response | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1400 | 2 | | SS code used in the Paging message | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1405 | 1 | | PGW IP Addresses in Initial Messages | 12.3.0 | +| 2013-12 | CT#62 | CP-130626 | 1406 | 2 | | PGW and SGW Charging alignment in downlink | 12.3.0 | +| 2013-12 | CT#62 | CP-130613 | 1387 | 2 | | ULI reporting in the Create Session Request and Modify Bearer Request message | 12.3.0 | +| 2013-12 | CT#62 | CP-130604 | 1390 | 1 | | Correction on Trace information | 12.3.0 | +| 2013-12 | CT#62 | CP-130633 | 1394 | 2 | | Support HO indication and additional PDN request on the S2a GTP interface | 12.3.0 | +| 2014-03 | CT#63 | CP-140029 | 1409 | 1 | | F-TEID Interface Type 8 | 12.4.0 | +| 2014-03 | CT#63 | CP-140029 | 1410 | 2 | | S12, S4-U, S1-U F-TEID values | 12.4.0 | +| 2014-03 | CT#63 | CP-140029 | 1411 | 2 | | Triggered messages | 12.4.0 | +| 2014-03 | CT#63 | CP-140029 | 1413 | 2 | | F-Container Definition Correction | 12.4.0 | +| 2014-03 | CT#63 | CP-140029 | 1417 | 2 | | CSG Membership Indication values | 12.4.0 | +| 2014-03 | CT#63 | CP-140029 | 1418 | 1 | | Dummy IMSI in Resume Notification | 12.4.0 | +| 2014-03 | CT#63 | CP-140029 | 1419 | 2 | | Sender F-TEID in the Delete Session Request message | 12.4.0 | +| 2014-03 | CT#63 | CP-140029 | 1423 | 1 | | PLMN ID communicated to the HPLMN in network sharing | 12.4.0 | +| 2014-03 | CT#63 | CP-140030 | 1421 | 1 | | TWAN-ID reporting extensions for NPLI for TWAN access | 12.4.0 | +| 2014-03 | CT#63 | CP-140030 | 1422 | 1 | | TWAN-ID contents extensions for NPLI for TWAN access | 12.4.0 | +| 2014-03 | CT#63 | CP-140030 | 1436 | - | | TWAN location retrieval in Update Bearer Request | 12.4.0 | +| 2014-03 | CT#63 | CP-140031 | 1429 | 3 | | Trusted WLAN mode indication | 12.4.0 | +| 2014-03 | CT#63 | CP-140022 | 1431 | 1 | | Update the ULI Timestamp IE format | 12.4.0 | +| 2014-03 | CT#63 | CP-140022 | 1435 | 2 | | Bearer context in Update Bearer Response when DTF is set | 12.4.0 | +| 2014-03 | CT#63 | CP-140021 | 1433 | 1 | | Temporarily rejected due to mobility procedure in progress | 12.4.0 | +| 2014-03 | CT#64 | CP-140261 | 1438 | 3 | | Introduction of Node Number and Node Identifier (to carry SGSN Lgd Identifier and MME SLg identifier) | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1443 | 1 | | Number of authentication vectors in the MM Context IE | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1444 | 2 | | Context Response with P-TMSI Signature mismatch | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1448 | 1 | | Including CSG change reporting for Change Notification procedure | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1452 | 1 | | Spare bits in MM Context | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1455 | 1 | | User CSG Information reporting in rollback case | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1456 | 1 | | Corrections to Node Type | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1457 | 1 | | Update the condition of the UE Time Zone IE | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1460 | 1 | | A new Cause Value for the case where an MME in the VPLMN refuses to setup/modify a Bearer | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1478 | 2 | | Alternate LMA address for user plane | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1479 | 1 | | PLMN ID communicated in the VPLMN in network sharing | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1482 | 1 | | Version Not Supported Indication | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1489 | 3 | | IPv6 address allocation | 12.5.0 | +| 2014-06 | CT#64 | CP-140261 | 1490 | 3 | | Context Request Indication flags | 12.5.0 | +| 2014-06 | CT#64 | CP-140235 | 1445 | 5 | | Update cause to indicate downlink message delivery failure due to crash with mobility event | 12.5.0 | +| 2014-06 | CT#64 | CP-140235 | 1447 | 2 | | MDT configuration during inter-MME handover | 12.5.0 | +| 2014-06 | CT#64 | CP-140242 | 1441 | 3 | | Reporting changes of UE presence in Presence Reporting Area | 12.5.0 | +| 2014-06 | CT#64 | CP-140247 | 1451 | - | | PCO in the HO to TWAN procedures | 12.5.0 | +| 2014-06 | CT#64 | CP-140247 | 1487 | 2 | | PCO in handover to 3GPP access | 12.5.0 | +| 2014-06 | CT#64 | CP-140252 | 1439 | 1 | | TWAN Identifier Timestamp | 12.5.0 | +| 2014-06 | CT#64 | CP-140252 | 1440 | - | | Civic address encoding | 12.5.0 | +| 2014-06 | CT#64 | CP-140252 | 1459 | 4 | | Extension to the TWAN Identifier contents: new Line Identifier (Logical Access ID) | 12.5.0 | +| 2014-06 | CT#64 | CP-140252 | 1481 | 2 | | SSID not sufficient for TWAN location | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1461 | 1 | | Propagation of MME/S4-SGSN identity to PGW | 12.5.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------|--------| +| 2014-06 | CT#64 | CP-140241 | 1462 | 1 | | Updating PGW with overload control information of target MME/S4-SGSN | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1463 | 1 | | Interaction with congestion control using APN back-off timer | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1464 | 1 | | Discovery of the support of the GTP signalling based Load Control feature by the peer node | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1465 | 1 | | Discovery of the support of the GTP signalling based Overload Control feature by the peer node | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1466 | 1 | | Issues in the network with partial support of the GTP Load Control feature | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1467 | 1 | | Issues in the network with partial support of the GTP Overload Control feature | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1468 | 1 | | Implicit overload control mechanisms | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1469 | 2 | | Load control solution: General aspects | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1470 | 3 | | Overload control solution: General aspects | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1471 | 1 | | Addition of Load & Overload Control Info IEs in session mgmt. messages | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1472 | 2 | | Definition of new IEs for Load & Overload Control feature | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1475 | 1 | | Overload problem, scenarios, load and overload control concepts | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1476 | 1 | | Overload control: message throttling | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1477 | 2 | | Enforcement of overload control | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1480 | 2 | | Load control information | 12.5.0 | +| 2014-06 | CT#64 | CP-140241 | 1488 | 2 | | Overload Control Information | 12.5.0 | +| 2014-09 | CT#65 | CP-140512 | 1492 | - | | Handovers between non-3GPP and 3GPP access | 12.6.0 | +| 2014-09 | CT#65 | CP-140512 | 1493 | 2 | | Setting Handover Indication flag | 12.6.0 | +| 2014-09 | CT#65 | CP-140512 | 1507 | 2 | | Reporting the RAN/NAS cause during bearer creation/modification failure scenarios | 12.6.0 | +| 2014-09 | CT#65 | CP-140512 | 1510 | 1 | | Correct procedure name for PDN connection deactivation | 12.6.0 | +| 2014-09 | CT#65 | CP-140512 | 1512 | 1 | | Repeated procedure description | 12.6.0 | +| 2014-09 | CT#65 | CP-140512 | 1514 | - | | Create Session Request received for an existing PDN connection | 12.6.0 | +| 2014-09 | CT#65 | CP-140512 | 1515 | 2 | | Deferred SN/CSG/Time zone change reporting in GERAN | 12.6.0 | +| 2014-09 | CT#65 | CP-140502 | 1495 | 2 | | MDT PLMN List configuration parameter | 12.6.0 | +| 2014-09 | CT#65 | CP-140502 | 1509 | 1 | | Bearer contexts in Modify Access Bearers Request | 12.6.0 | +| 2014-09 | CT#65 | CP-140505 | 1496 | 3 | | Inclusion of MME/S4-SGSN Identifier in the Create/Update/Delete Bearer Response message | 12.6.0 | +| 2014-09 | CT#65 | CP-140505 | 1498 | 1 | | Addition of missing changes | 12.6.0 | +| 2014-09 | CT#65 | CP-140522 | 1497 | 1 | | Inclusion PRA information in the Create/Update Bearer Response message | 12.6.0 | +| 2014-09 | CT#65 | CP-140522 | 1500 | - | | Reporting changes of UE presence in a Presence Reporting Area | 12.6.0 | +| 2014-09 | CT#65 | CP-140522 | 1501 | 2 | | ULI change reporting when E-RAB/RAB/user plane is established | 12.6.0 | +| 2014-09 | CT#65 | CP-140506 | 1499 | - | | P-CSCF Restoration Indication | 12.6.0 | +| 2014-09 | CT#65 | CP-140521 | 1511 | 3 | | Introduction of Dual Connectivity Function | 12.6.0 | +| 2014-09 | CT#65 | CP-140518 | 1513 | 2 | | PGW F-TEID in the PGW Downlink Triggering Notification | 12.6.0 | +| 2014-09 | CT#65 | CP-140501 | 1518 | - | | BSS container in Forward Relocation Request / Response | 12.6.0 | +| 2014-12 | CT#66 | CP-140758 | 1505 | 3 | | Target Cell Identification in E-UTRAN to GERAN PS Handover | 12.7.0 | +| 2014-12 | CT#66 | CP-140761 | 1540 | 2 | | P-CSCF Address Inclusion in PCO IE of Update Bearer Request | 12.7.0 | +| 2014-12 | CT#66 | CP-140795 | 1519 | 2 | | Handling of load control and overload control parameters | 12.7.0 | +| 2014-12 | CT#66 | CP-140795 | 1520 | 3 | | Overload control message prioritization | 12.7.0 | +| 2014-12 | CT#66 | CP-140795 | 1521 | 2 | | Propagating the MME/S4-SGSN identity to the PGW | 12.7.0 | +| 2014-12 | CT#66 | CP-140795 | 1542 | 1 | | Overload/Load Control Information IE on S2a/S2b/S4/S11 | 12.7.0 | +| 2014-12 | CT#66 | CP-140972 | 1523 | 1 | | EBI value to use in Downlink Data Notification Triggered by a Dedicated Bearer Activation procedure when ISR is active | 12.7.0 | +| 2014-12 | CT#66 | CP-140972 | 1526 | 3 | | Essential clarification on the usage of cause code "Context Not Found" | 12.7.0 | +| 2014-12 | CT#66 | CP-140972 | 1528 | 2 | | Pending subscription change | 12.7.0 | +| 2014-12 | CT#66 | CP-140972 | 1532 | 3 | | Handovers from non-3GPP IP access to 3GPP IP access | 12.7.0 | +| 2014-12 | CT#66 | CP-140972 | 1534 | 1 | | Removal of Optimized HO procedure from HRPD to EUTRAN | 12.7.0 | +| 2014-12 | CT#66 | CP-140972 | 1535 | - | | Type value of the BSS Container IE in Context Response | 12.7.0 | +| 2014-12 | CT#66 | CP-140972 | 1536 | 1 | | Length of Recovery IE | 12.7.0 | +| 2014-12 | CT#66 | CP-140972 | 1541 | 3 | | Additional cause code mapping for non-availability of Services due to LTE-Roaming | 12.7.0 | +| 2014-12 | CT#66 | CP-140972 | 1544 | - | | Missing Value definition of GUTI | 12.7.0 | +| 2014-12 | CT#66 | CP-140972 | 1545 | 3 | | Message piggybacking clarification | 12.7.0 | +| 2014-12 | CT#66 | CP-140794 | 1525 | 1 | | Paging stop indication for ISR during P-CSCF restoration procedure | 12.7.0 | +| 2014-12 | CT#66 | CP-140972 | 1527 | 2 | | MEI in Create Session Request | 12.7.0 | +| 2014-12 | CT#66 | CP-140794 | 1529 | 1 | | Bearer Contexts to be modified IE in 'Modify Bearer Request | 12.7.0 | +| 2014-12 | CT#66 | CP-140779 | 1530 | 1 | | TWAN PLMN ID | 12.7.0 | +| 2014-12 | CT#66 | CP-140780 | 1533 | 5 | | WLAN Offloadability transfer during mobility procedures | 12.7.0 | +| 2014-12 | CT#66 | CP-140789 | 1543 | 1 | | No change S1 SGW F-TEID in E-UTRAN Initiated E-RAB modification procedure | 12.7.0 | +| 2014-12 | CT#66 | CP-140784 | 1548 | 1 | | Inclusion of PCO in Delete Session/Bearer Request for TWAN access | 12.7.0 | +| 2014-12 | CT#66 | CP-140796 | 1524 | 2 | | Provisioning of P-CSCF address via APCO for S2b | 13.0.0 | +| 2014-12 | CT#66 | CP-140760 | 1546 | 1 | | GTP-C overload control from TWAN/ePDG to PGW | 13.0.0 | +| 2015-03 | CT#67 | CP-150037 | 1547 | 3 | | MBMS Alternative IP Multicast Distribution Address | 13.1.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2015-03 | CT#67 | CP-150037 | 1550 | 1 | | Clarification of RAC encoding | 13.1.0 | +| 2015-03 | CT#67 | CP-150037 | 1551 | 1 | | MBMS Flow Identifier clarification | 13.1.0 | +| 2015-03 | CT#67 | CP-150037 | 1554 | 1 | | Unexpected GTP message clarification | 13.1.0 | +| 2015-03 | CT#67 | CP-150037 | 1556 | 1 | | UE Registration Query | 13.1.0 | +| 2015-03 | CT#67 | CP-150037 | 1557 | 3 | | Correction on definition of IMSI | 13.1.0 | +| 2015-03 | CT#67 | CP-150037 | 1559 | 1 | | Bearer Contexts in Create Bearer Response, Update Bearer Response and Delete Bearer Response for partial failure and success cases. | 13.1.0 | +| 2015-03 | CT#67 | CP-150037 | 1561 | 1 | | Cause IMSI not known | 13.1.0 | +| 2015-03 | CT#67 | CP-150037 | 1566 | 1 | | TWAN Release Cause | 13.1.0 | +| 2015-03 | CT#67 | CP-150025 | 1553 | 2 | | ULI IE condition in Create session Request message | 13.1.0 | +| 2015-03 | CT#67 | CP-150025 | 1563 | 1 | | PDN Type in PAA IE for S2b case | 13.1.0 | +| 2015-03 | CT#67 | CP-150025 | 1568 | 1 | | ULI change reporting upon inter-RAT mobility | 13.1.0 | +| 2015-03 | CT#67 | CP-150041 | 1565 | 1 | | Paging Policy Indication in Downlink Data Notification message | 13.1.0 | +| 2015-06 | CT#68 | CP-150254 | 1589 | - | | ARP Value in Downlink Data Notification message | 13.2.0 | +| 2015-06 | CT#68 | CP-150254 | 1594 | 1 | | Contents of ULI IE in the Modify Bearer Request during Handovers to UTRAN | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1570 | 3 | | TEID-C header value not known / Failure Indication message Cause value rules | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1573 | - | | RAT Type in Change Notification Request | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1575 | 2 | | PCO in CSReq for handover to TWAN with GTP over S2a | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1576 | 2 | | Correction to ULI inclusion for PDP activation procedure | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1577 | 3 | | IE inclusion for non-3GPP to 3GPP handover case | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1578 | - | | Inclusion of EBI in Delete Bearer Request message | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1581 | 2 | | User CSG Information in TAU/RAU with SGW change procedure | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1582 | 2 | | Session/bearer release cause over S2a | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1583 | 2 | | Session/bearer release cause over S2b | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1599 | 1 | | At receiving Delete Bearer Failure Indication sent on zero-TEID | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1600 | 1 | | UCI condition in Modify Bearer Request message | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1601 | 2 | | Upon receiving unexpected triggered messages | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1603 | 1 | | Correction to ULI for the S5/S8 interface | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1604 | 1 | | Presence condition of embedded IEs in a Grouped IE | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1605 | 1 | | EBI and ARP in DDN message sent to S4-SGSN | 13.2.0 | +| 2015-06 | CT#68 | CP-150270 | 1606 | 1 | | Message Granularity of Restoration/Recovery and Path Management messages | 13.2.0 | +| 2015-06 | CT#68 | CP-150274 | 1595 | 1 | | IMEI(SV) signalling over GTP based S2a and S2b | 13.2.0 | +| 2015-09 | CT#69 | CP-150433 | 1615 | - | | Modify Access Bearers Request leading to unpause charging in the PGW | 13.3.0 | +| 2015-09 | CT#69 | CP-150442 | 1608 | 1 | | Receipt of a Create Session Request at SGW colliding with an existing PDN connection context | 13.3.0 | +| 2015-09 | CT#69 | CP-150442 | 1609 | 2 | | Detection and handling of late arriving requests | 13.3.0 | +| 2015-09 | CT#69 | CP-150439 | 1610 | 1 | | eDRX impact on GTPv2 for network originated control plane procedure | 13.3.0 | +| 2015-09 | CT#69 | CP-150454 | 1611 | 2 | | Enhancement in Downlink Data Notification Acknowledgement for extended buffering in the SGW | 13.3.0 | +| 2015-09 | CT#69 | CP-150454 | 1612 | 2 | | Data forwarding for buffered DL data during TAU/RAU with SGW change | 13.3.0 | +| 2015-09 | CT#69 | CP-150448 | 1613 | 1 | | Usage of Charging Characteristics for activating PCC function | 13.3.0 | +| 2015-09 | CT#69 | CP-150448 | 1616 | - | | SSID and BSSID encoding clarification | 13.3.0 | +| 2015-09 | CT#69 | CP-150448 | 1619 | 2 | | Monitoring Event Information | 13.3.0 | +| 2015-09 | CT#69 | CP-150440 | 1620 | 3 | | UE Usage Type for Dedicated Core Network Feature | 13.3.0 | +| 2015-09 | CT#69 | CP-150440 | 1621 | 2 | | Reject Cause in Context Acknowledge for Dedicated Core Network Feature | 13.3.0 | +| 2015-09 | CT#69 | CP-150451 | 1625 | 2 | | MME/SGSN/SGW/TWAN/ePDG NBIFOM support indication | 13.3.0 | +| 2015-12 | CT#70 | CP-150761 | 1626 | 1 | | Cell List in MBMS Session Requests | 13.4.0 | +| 2015-12 | CT#70 | CP-150780 | 1627 | - | | Extensions for P-CSCF restoration for trusted and untrusted WLAN access | 13.4.0 | +| 2015-12 | CT#70 | CP-150770 | 1628 | 1 | | Emergency PDN connection over untrusted WLAN access | 13.4.0 | +| 2015-12 | CT#70 | CP-150770 | 1660 | 1 | | User Location Information reporting extensions over S2b | 13.4.0 | +| 2015-12 | CT#70 | CP-150760 | 1631 | 2 | | Load and overload metrics on APN level | 13.4.0 | +| 2015-12 | CT#70 | CP-150760 | 1633 | 2 | | Load and overload IE Instances | 13.4.0 | +| 2015-12 | CT#70 | CP-150760 | 1635 | 2 | | Load and overload sequence numbers per node | 13.4.0 | +| 2015-12 | CT#70 | CP-150760 | 1636 | 2 | | Load and overload Sequence Number check | 13.4.0 | +| 2015-12 | CT#70 | CP-150752 | 1637 | 3 | | Modify Bearer Request when "Active flag" is set | 13.4.0 | +| 2015-12 | CT#70 | CP-150752 | 1639 | 2 | | PCO in Create Session Request and Response | 13.4.0 | +| 2015-12 | CT#70 | CP-150752 | 1641 | 2 | | Context not found in handovers | 13.4.0 | +| 2015-12 | CT#70 | CP-150752 | 1645 | - | | Correct the wrong IE name | 13.4.0 | +| 2015-12 | CT#70 | CP-150752 | 1646 | - | | Coding of CSG ID | 13.4.0 | +| 2015-12 | CT#70 | CP-150752 | 1651 | 1 | | Extension of GTPv2 IE type | 13.4.0 | +| 2015-12 | CT#70 | CP-150752 | 1653 | 3 | | Addition of new GTPv2 Cause Code for Credit Check | 13.4.0 | +| 2015-12 | CT#70 | CP-150752 | 1663 | 1 | | Inclusion of RAN/NAS Cause in Delete Bearer Response | 13.4.0 | +| 2015-12 | CT#70 | CP-150752 | 1665 | 2 | | F-Container Type Value | 13.4.0 | +| 2015-12 | CT#70 | CP-150773 | 1642 | 2 | | Network-initiated IP flow mobility | 13.4.0 | +| 2015-12 | CT#70 | CP-150773 | 1643 | 2 | | UE-initiated IP Flow Mobility and IP Flow Mapping | 13.4.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------|--------| +| 2015-12 | CT#70 | CP-150773 | 1644 | 2 | | Addition of one access to a PDN connection in NBIFOM | 13.4.0 | +| 2015-12 | CT#70 | | | | | Define a cause value for the rejection of additional access to a PDN connection | 13.4.0 | +| 2015-12 | CT#70 | CP-150773 | 1650 | 1 | | | | +| 2015-12 | CT#70 | CP-150773 | 1669 | 1 | | NBIFOM support indication | 13.4.0 | +| 2015-12 | CT#70 | CP-150751 | 1648 | 1 | | UE Radio Capability for Paging Information | 13.4.0 | +| 2015-12 | CT#70 | CP-150751 | 1658 | 3 | | Mapping table between GTPv2 S2a and WLCP/Diameter | 13.4.0 | +| 2015-12 | CT#70 | CP-150751 | 1667 | 1 | | Operation Indication in MME triggered Serving GW relocation procedure | 13.4.0 | +| 2015-12 | CT#70 | CP-150776 | 1649 | 2 | | Transferring DTCI and PNSI during inter MME/SGSN mobility procedure | 13.4.0 | +| 2015-12 | CT#70 | CP-150776 | 1652 | 1 | | Delay Tolerant Connection Indication | 13.4.0 | +| 2015-12 | CT#70 | CP-150776 | 1655 | 1 | | DTCI in SGW | 13.4.0 | +| 2015-12 | CT#70 | CP-150772 | 1656 | 2 | | Remote UE Report Notification | 13.4.0 | +| 2015-12 | CT#70 | CP-150756 | 1662 | 1 | | Presence Reporting Area Identifier | 13.4.0 | +| 2015-12 | CT#70 | CP-150782 | 1659 | 1 | | Handling of Create Session Request without Origination Timestamp | 13.4.0 | +| 2015-12 | CT#70 | CP-150781 | 1668 | 1 | | UE Usage Type Coding | 13.4.0 | +| 2015-12 | CT#70 | CP-150778 | 1670 | - | | Monitoring Events in Identification Response | 13.4.0 | +| 2015-12 | CT#70 | CP-150778 | 1671 | 3 | | Remove Editor's Note on the Monitoring Event Information | 13.4.0 | +| 2015-12 | CT#70 | CP-150765 | 1680 | 1 | | Instance numbers for overload control information | 13.4.0 | +| 2016-03 | CT#71 | CP-160016 | 1684 | 1 | | Add cause values to TWAN mapping table | 13.5.0 | +| 2016-03 | CT#71 | CP-160035 | 1682 | - | | Update the reference for NBIFOM container | 13.5.0 | +| 2016-03 | CT#71 | CP-160035 | 1692 | - | | PDN Connection Charging ID | 13.5.0 | +| 2016-03 | CT#71 | CP-160038 | 1685 | - | | Octet number in MM context IE | 13.5.0 | +| 2016-03 | CT#71 | CP-160038 | 1686 | 1 | | Protocol Type in Create Session Request | 13.5.0 | +| 2016-03 | CT#71 | | | | | Incorrect use of the term "full hexadecimal representation" to mean binary encoding | 13.5.0 | +| 2016-03 | CT#71 | CP-160038 | 1688 | 1 | | | | +| 2016-03 | CT#71 | | | | | Use case for inclusion of the RAN/NAS Cause in Delete Bearer Response | 13.5.0 | +| 2016-03 | CT#71 | CP-160038 | 1691 | - | | | | +| 2016-03 | CT#71 | CP-160038 | 1693 | 3 | | Transferring AAA identifier from the ePDG to the PGW | 13.5.0 | +| 2016-03 | CT#71 | | | | | S11-U tunneling for MO/MT data transport in control plane (SGi based) – with new S11-U F-TEIDs | 13.5.0 | +| 2016-03 | CT#71 | CP-160033 | 1689 | 3 | | | | +| 2016-03 | CT#71 | CP-160033 | 1690 | 1 | | RAT-Type extension for NB-IoT | 13.5.0 | +| 2016-03 | CT#71 | CP-160033 | 1697 | 6 | | Transfer of non IP PDN to peer MME during mobility | 13.5.0 | +| 2016-03 | CT#71 | | | | | Addition of NB-IoT radio access type to the Access-Restriction-Data feature | 13.5.0 | +| 2016-03 | CT#71 | CP-160033 | 1698 | 1 | | | | +| 2016-03 | CT#71 | CP-160033 | 1699 | 1 | | No Delete Session Request for non-existing PDN connection | 13.5.0 | +| 2016-03 | CT#71 | CP-160033 | 1700 | 1 | | No Create Session Request for Attach without PDN connection | 13.5.0 | +| 2016-03 | CT#71 | CP-160033 | 1701 | 2 | | No Paging and Service Information in DDN for non-IP PDN connections | 13.5.0 | +| 2016-03 | CT#71 | CP-160033 | 1704 | 1 | | Protocol change for Connection Suspend and Resume Procedure | 13.5.0 | +| 2016-03 | CT#71 | CP-160033 | 1705 | 2 | | Protocol change for introducing new non-IP PDN type | 13.5.0 | +| 2016-03 | CT#71 | CP160025 | 1687 | - | | P-CSCF_RESELECTION_SUPPORT Private Status Type | 13.5.0 | +| 2016-03 | CT#71 | CP-160036 | 1694 | 2 | | Cleanup of the editor's notes for reporting remote UE | 13.5.0 | +| 2016-03 | CT#71 | | | | | Triggering MT SM retransmission by the SMS GMSC to a UE in eDRX during inter MME/SGSN mobility procedure | 13.5.0 | +| 2016-03 | CT#71 | CP-160030 | 1695 | 1 | | | | +| 2016-06 | CT#72 | | | | | Correction to the inclusion of PRA IE in Create Session Request on S5/S8 interface | 13.6.0 | +| 2016-06 | CT#72 | CP-160214 | 1713 | 1 | | | | +| 2016-06 | CT#72 | CP-160228 | 1706 | 4 | | Handover for non-NB-IoT devices using CIoT optimisations | 13.6.0 | +| 2016-06 | CT#72 | CP-160228 | 1707 | 1 | | S11-U bearers handling during the TAU procedure | 13.6.0 | +| 2016-06 | CT#72 | | | | | Transfer of Header Compression Configuration during inter-MME mobility | 13.6.0 | +| 2016-06 | CT#72 | CP-160228 | 1708 | 3 | | | | +| 2016-06 | CT#72 | CP-160228 | 1714 | 2 | | Rejecting Context Request with RAT type change from/to NB-IoT | 13.6.0 | +| 2016-06 | CT#72 | | | | | Addressing Editor's Note on SCEF PDN Connections IE in Context Response | 13.6.0 | +| 2016-06 | CT#72 | CP-160228 | 1715 | 2 | | | | +| 2016-06 | CT#72 | CP-160228 | 1719 | 1 | | MME triggered PGW pause of charging | 13.6.0 | +| 2016-06 | CT#72 | | | | | Transfer of Header Compression Configuration during inter-MME Handover | 13.6.0 | +| 2016-06 | CT#72 | CP-160228 | 1726 | 1 | | | | +| 2016-06 | CT#72 | CP-160228 | 1734 | 3 | | Simultaneous support for CP and UP optimisation | 13.6.0 | +| 2016-06 | CT#72 | CP-160228 | 1737 | 2 | | Extended Protocol Configuration Option and Support ePCO indication | 13.6.0 | +| 2016-06 | CT#72 | CP-160228 | 1738 | 1 | | Selection of an EPC entity supporting CIoT | 13.6.0 | +| 2016-06 | CT#72 | | | | | Clarification on inclusion of the Sending Node Features IE in Echo Request & Response messages | 13.6.0 | +| 2016-06 | CT#72 | CP-160234 | 1709 | 1 | | | | +| 2016-06 | CT#72 | CP-160234 | 1710 | 4 | | Bearer mismatching handling | 13.6.0 | +| 2016-06 | CT#72 | | | | | Add both IP addresses within S1-U SGW F-TEID in Create Bearer Request | 13.6.0 | +| 2016-06 | CT#72 | CP-160234 | 1718 | 1 | | | | +| 2016-06 | CT#72 | | | | | Incorrect conditions for ULI IE in CSReq for X2 Handover and Enhanced SRNS Relocation | 13.6.0 | +| 2016-06 | CT#72 | CP-160234 | 1722 | 1 | | | | +| 2016-06 | CT#72 | CP-160234 | 1723 | - | | Selection Mode value for Wildcard authorized APN | 13.6.0 | +| 2016-06 | CT#72 | CP-160234 | 1727 | 1 | | Data Notification Delay in DDN Acknowledge | 13.6.0 | +| 2016-06 | CT#72 | CP-160234 | 1728 | - | | Associate OCI with SGW node's identity | 13.6.0 | +| 2016-06 | CT#72 | CP-160234 | 1733 | 1 | | A correction on the reference index of UE usage type in TS29.274 | 13.6.0 | +| 2016-06 | CT#72 | | | | | Essential clarification for Modify Access Bearer Request when only EBI is present | 13.6.0 | +| 2016-06 | CT#72 | CP-160234 | 1740 | 1 | | | | +| 2016-06 | CT#72 | CP-160234 | 1742 | 1 | | Extensions for EGPRS access security enhancements | 13.6.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------|--------| +| 2016-06 | CT#72 | CP-160231 | 1716 | 3 | | Handling of NW-initiated session/bearer release for NB-IFOM connections | 13.6.0 | +| 2016-06 | CT#72 | CP-160231 | 1725 | 2 | | Clarification of the Relay Identity included in TWAN Identifier | 13.6.0 | +| 2016-06 | CT#72 | CP-160231 | 1729 | 2 | | NBIFOM support indication during inter-PLMN mobility | 13.6.0 | +| 2016-06 | CT#72 | CP-160231 | 1741 | 1 | | Cause value "Multiple accesses to a PDN connection not allowed" in NW-initiated PDN disconnection procedure | 13.6.0 | +| 2016-06 | CT#72 | CP-160232 | 1735 | 1 | | Addition of IMEI in Remote User ID | 13.6.0 | +| 2016-06 | CT#72 | CP-160218 | 1681 | 6 | | Adding eNB change reporting in Location Change Reporting | 14.0.0 | +| 2016-06 | CT#72 | CP-160217 | 1736 | 1 | | GTPv2 impact for NonIP-GPRS | 14.0.0 | +| 2016-09 | CT#73 | CP-160423 | 1747 | 1 | | Dedicated bearer deletion signalling for a UE using Extended Coverage | 14.1.0 | +| 2016-09 | CT#73 | CP-160424 | 1745 | 2 | | Extended DL Data Buffering for Extended Coverage | 14.1.0 | +| 2016-09 | CT#73 | CP-160423 | 1749 | - | | Data switching from CP to UP without sending a Release Access Bearers Request | 14.1.0 | +| 2016-09 | CT#73 | CP-160423 | 1751 | - | | S11-U bearers of multiple SGi PDN connections using Data over the Control Plane | 14.1.0 | +| 2016-09 | CT#73 | CP-160423 | 1765 | 1 | | Clarification on the inclusion of the Serving PLMN Rate Control during Inter MME procedure | 14.1.0 | +| 2016-09 | CT#73 | CP-160421 | 1753 | 2 | | Unaccepted PDN connection during an Intra-MME/SGSN handover | 14.1.0 | +| 2016-09 | CT#73 | CP-160421 | 1766 | - | | Inclusion of Sender' F-TEID in the Command message | 14.1.0 | +| 2016-09 | CT#73 | CP-160422 | 1760 | 1 | | A new Flag from PGW to SGSN | 14.1.0 | +| 2016-09 | CT#73 | CP-160424 | 1763 | 3 | | Correction on ePCO | 14.1.0 | +| 2016-09 | CT#73 | CP-160424 | 1764 | 2 | | Clarification on the release of unsuccessful EPC bearer context at mobility procedures when interworking with CLoT | 14.1.0 | +| 2016-09 | CT#73 | CP-160424 | 1771 | 2 | | Handling of Exception Reports in the Core Network | 14.1.0 | +| 2016-09 | CT#73 | CP-160424 | 1773 | 1 | | Keep the S11-U SGW F-TEID the same as the S1-U SGW F-TEID | 14.1.0 | +| 2016-09 | CT#73 | CP-160586 | 1767 | 2 | | Inclusion of UE TCP Port | 14.1.0 | +| 2016-09 | CT#73 | CP-160434 | 1768 | 1 | | Adding supported feature for eNB change reporting | 14.1.0 | +| 2016-12 | CT#74 | CP-160676 | 1774 | 2 | | Support of multiple PRAs per PDN connection | 14.2.0 | +| 2016-12 | CT#74 | CP-160676 | 1797 | 2 | | Support of PRA Set Reporting | 14.2.0 | +| 2016-12 | CT#74 | CP-160679 | 1777 | 1 | | User identification for the emergency service | 14.2.0 | +| 2016-12 | CT#74 | CP-160679 | 1781 | 1 | | Emergency services over WLAN for unauthenticated UEs | 14.2.0 | +| 2016-12 | CT#74 | CP-160675 | 1778 | 3 | | Inclusion of IMSI in the Modify Bearer Request message | 14.2.0 | +| 2016-12 | CT#74 | CP-160675 | 1782 | 1 | | Message Priority Indication over GTP | 14.2.0 | +| 2016-12 | CT#74 | CP-160675 | 1784 | 1 | | Mobility support for NonIP in GPRS | 14.2.0 | +| 2016-12 | CT#74 | CP-160675 | 1796 | 2 | | IP address instance in the Create Bearer Response | 14.2.0 | +| 2016-12 | CT#74 | CP-160675 | 1800 | 2 | | eNB change reporting for inter MME handover | 14.2.0 | +| 2016-12 | CT#74 | CP-160652 | 1780 | 1 | | IOV_updates counter | 14.2.0 | +| 2016-12 | CT#74 | CP-160652 | 1802 | 1 | | Absolute Time in MBMS Session Update Request | 14.2.0 | +| 2016-12 | CT#74 | CP-160685 | 1783 | - | | Remove SGSN applicability for ePCO in the Create Session Request message | 14.2.0 | +| 2016-12 | CT#74 | CP-160657 | 1787 | 3 | | New GTP Cause to Restrict the Number of EPS Bearers for NB-IoT UE | 14.2.0 | +| 2016-12 | CT#74 | CP-160667 | 1789 | 2 | | Add Bearer Context to Context Acknowledge message for Data forwarding | 14.2.0 | +| 2016-12 | CT#74 | CP-160656 | 1793 | 1 | | Remove an editor's note | 14.2.0 | +| 2016-12 | CT#74 | CP-160655 | 1795 | - | | Remote UE Context IE type in Create Session Request | 14.2.0 | +| 2016-12 | CT#74 | CP-160680 | 1803 | 1 | | GW selection by S4-SGSN for Non-IP PDN type | 14.2.0 | +| 2016-12 | CT#74 | CP-160665 | 1805 | 1 | | Transferring subscribed UE usage type during inter MME/SGSN mobility | 14.2.0 | +| 2017-03 | CT#75 | CP-170026 | 1817 | - | | Bearer context mismatch during dedicated bearer creation procedure | 14.3.0 | +| 2017-03 | CT#75 | CP-170041 | 1806 | 2 | | PLMN ID Check and Enhanced TV Services | 14.3.0 | +| 2017-03 | CT#75 | CP-170039 | 1807 | 1 | | Enhanced Coverage | 14.3.0 | +| 2017-03 | CT#75 | CP-170039 | 1813 | 1 | | PDN Continuity at Inter-RAT mobility | 14.3.0 | +| 2017-03 | CT#75 | CP-170040 | 1808 | 1 | | Bearer Contexts in Delete Bearer Failure Indication | 14.3.0 | +| 2017-03 | CT#75 | CP-170040 | 1809 | 1 | | Including Sender's F-TEID in Delete Session Request message for S2a/S2b | 14.3.0 | +| 2017-03 | CT#75 | CP-170040 | 1814 | 3 | | Support of long and short Macro eNodeB IDs | 14.3.0 | +| 2017-03 | CT#75 | CP-170040 | 1815 | 1 | | Maximum Wait Time over the S8 | 14.3.0 | +| 2017-06 | CT#76 | CP-171019 | 1821 | 1 | | CN Operator Selection Entity | 14.4.0 | +| 2017-06 | CT#76 | CP-171021 | 1823 | 1 | | Mo Exception Data Counter | 14.4.0 | +| 2017-06 | CT#76 | CP-171044 | 1819 | - | | AMBR encoding | 15.0.0 | +| 2017-09 | CT#77 | CP-172020 | 1825 | 1 | | GTP-C Extensions for SGW-U and PGW-U selection with CUPS | 15.1.0 | +| 2017-09 | CT#77 | CP-172014 | 1828 | 1 | | TAU with SGW change and Data forwarding for CP only PDN connection | 15.1.0 | +| 2017-09 | CT#77 | CP-172014 | 1832 | 1 | | Use of MABR when support of ePCO is changed | 15.1.0 | +| 2017-09 | CT#77 | CP-172025 | 1829 | 1 | | NR as Secondary RAT | 15.1.0 | +| 2017-12 | CT#78 | CP-173031 | 1837 | 4 | | Setting of DSCP value for priority services on a GTPv2-C Interface | 15.2.0 | +| 2017-12 | CT#78 | CP-173031 | 1840 | 1 | | Reporting WLAN Location during UE initiated IPsec tunnel update procedure | 15.2.0 | +| 2017-12 | CT#78 | CP-173036 | 1845 | 4 | | Secondary RAT related data usage reporting | 15.2.0 | +| 2017-12 | CT#78 | CP-173036 | 1847 | 1 | | SGW/PGW selection for NR | 15.2.0 | +| 2017-12 | CT#78 | CP-173036 | 1848 | 1 | | Updates on the Usage Data Reporting for Dual Connectivity with NR | 15.2.0 | +| 2017-12 | CT#78 | CP-173036 | 1876 | 2 | | Access Restrictions to NR as Secondary RAT on MM Context | 15.2.0 | +| 2017-12 | CT#78 | CP-173036 | 1877 | 1 | | Addition of UE additional security capabilities | 15.2.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2017-12 | CT#78 | CP-173015 | 1851 | - | | ePCO reference to TS 24.301 | 15.2.0 | +| 2017-12 | CT#78 | CP-173034 | 1852 | 1 | | Extending the scope of the specification to cover the N26 interface | 15.2.0 | +| 2017-12 | CT#78 | CP-173034 | 1853 | 1 | | GTP-C tunnel per UE over the N26 interface | 15.2.0 | +| 2017-12 | CT#78 | CP-173034 | 1854 | 1 | | GTP-C messages over the N26 interface | 15.2.0 | +| 2017-12 | CT#78 | CP-173034 | 1855 | 1 | | Forward Relocation Request over the N26 interface | 15.2.0 | +| 2017-12 | CT#78 | CP-173034 | 1856 | 1 | | Forward Relocation Response over the N26 interface | 15.2.0 | +| 2017-12 | CT#78 | CP-173034 | 1873 | 2 | | Support of Idle Mode Mobility procedures for single-registration mode | 15.2.0 | +| 2017-12 | CT#78 | CP-173034 | 1874 | - | | Forward Relocation Complete Notification / Acknowledge over the N26 interface | 15.2.0 | +| 2017-12 | CT#78 | CP-173034 | 1875 | - | | Relocation Cancel Request / Response over the N26 interface | 15.2.0 | +| 2017-12 | CT#78 | CP-173021 | 1858 | 1 | | S11-U interface separation from S1-U interface | 15.2.0 | +| 2017-12 | CT#78 | CP-173035 | 1871 | - | | Access restriction to unlicensed spectrum as secondary RAT | 15.2.0 | +| 2018-03 | CT#79 | CP-180015 | 1892 | 1 | | Support of long and short Macro eNodeB IDs | 15.3.0 | +| 2018-03 | CT#79 | CP-180027 | 1872 | 2 | | Data usage reporting with unlicensed spectrum used as secondary RAT | 15.3.0 | +| 2018-03 | CT#79 | CP-180023 | 1879 | 1 | | Clarification to GTP-C overload control | 15.3.0 | +| 2018-03 | CT#79 | CP-180023 | 1883 | 1 | | Unpredictability of GTP TEID for PGW GTP-C | 15.3.0 | +| 2018-03 | CT#79 | CP-180023 | 1889 | 1 | | Service Gap Time Support | 15.3.0 | +| 2018-03 | CT#79 | CP-180020 | 1880 | 1 | | Condition correction for indicating DCNR to SGW/PGW | 15.3.0 | +| 2018-03 | CT#79 | CP-180020 | 1890 | 1 | | Correction for indicating DCNR to Combined SGW/PGW | 15.3.0 | +| 2018-03 | CT#79 | CP-180026 | 1881 | - | | Create/Delete Indirect Data Forwarding Tunnel | 15.3.0 | +| 2018-03 | CT#79 | CP-180026 | 1882 | 2 | | Presence Condition of some IEs in Forward Relocation req and rsp for N26 interface | 15.3.0 | +| 2018-03 | CT#79 | CP-180026 | 1884 | 1 | | Temporary identity in Idle mode mobility using N26 | 15.3.0 | +| 2018-03 | CT#79 | CP-180026 | 1885 | - | | Security context transfer in interworking between EPS and 5GS | 15.3.0 | +| 2018-03 | CT#79 | CP-180026 | 1886 | 1 | | GTP-C messages over N26 | 15.3.0 | +| 2018-03 | CT#79 | CP-180026 | 1887 | 2 | | Forward Relocation Request & Response over N26 | 15.3.0 | +| 2018-03 | CT#79 | CP-180026 | 1888 | 1 | | Context Request & Response over N26 | 15.3.0 | +| 2018-06 | CT#80 | CP-181115 | 1896 | - | | TWAN PLMN-ID encoding | 15.4.0 | +| 2018-06 | CT#80 | CP-181118 | 1905 | - | | Correction of reference to the SCEF Realm | 15.4.0 | +| 2018-06 | CT#80 | CP-181129 | 1900 | 4 | | Extended EPS Bearer Identity for INOBEAR | 15.4.0 | +| 2018-06 | CT#80 | CP-181128 | 1914 | 3 | | Identification of LTE-M (eMTC) traffic | 15.4.0 | +| 2018-06 | CT#80 | CP-181129 | 1907 | 1 | | INOBEAR for Create Bearer Request | 15.4.0 | +| 2018-06 | CT#80 | CP-181129 | 1908 | 1 | | The support of INOBEAR in mobility procedures | 15.4.0 | +| 2018-06 | CT#80 | CP-181132 | 1897 | 1 | | Presence condition of ePCO | 15.4.0 | +| 2018-06 | CT#80 | CP-181132 | 1898 | - | | SGW change indication | 15.4.0 | +| 2018-06 | CT#80 | CP-181132 | 1899 | 1 | | Indirect data forwarding between 5GS and EPS | 15.4.0 | +| 2018-06 | CT#80 | CP-181132 | 1901 | - | | New RAT Type value for NR | 15.4.0 | +| 2018-06 | CT#80 | CP-181132 | 1902 | 1 | | Identification Request procedure during 5GS to EPS Idle mode mobility | 15.4.0 | +| 2018-06 | CT#80 | CP-181132 | 1903 | 4 | | Support of DL/UL Maximum Packet Loss Rate | 15.4.0 | +| 2018-06 | CT#80 | CP-181132 | 1909 | 1 | | The use of PGW FQDN in the SMF Selection | 15.4.0 | +| 2018-06 | CT#80 | CP-181132 | 1910 | 1 | | UE NR security capability | 15.4.0 | +| 2018-06 | CT#80 | CP-181132 | 1912 | 1 | | 5GS TAI and Global NG-RAN node ID | 15.4.0 | +| 2018-06 | CT#80 | CP-181132 | 1913 | - | | Resolution of remaining editor's notes on N26 interface | 15.4.0 | +| 2018-06 | CT#80 | CP-181133 | 1911 | - | | Clarification on the flag in Change Notification | 15.4.0 | +| 2018-06 | CT#80 | CP-181133 | 1915 | 1 | | Accuracy of Secondary RAT data usage report | 15.4.0 | +| 2018-09 | CT#81 | CP-182074 | 1917 | 5 | | Correction of APN Rate Control for PDN connection release and re-establishment | 15.5.0 | +| 2018-09 | CT#81 | CP-182084 | 1918 | - | | UE AMBR during interworking | 15.5.0 | +| 2018-09 | CT#81 | CP-182084 | 1921 | - | | Identification Request procedure over N26 | 15.5.0 | +| 2018-09 | CT#81 | CP-182068 | 1920 | 1 | | Add support for 5G Trace | 15.5.0 | +| 2018-09 | CT#81 | CP-182067 | 1919 | 1 | | Secondary RAT data usage reporting using Change Notification Request | 15.5.0 | +| 2018-09 | CT#81 | CP-182070 | 1923 | 1 | | Clarification on RAT Type change in Idle mode – Modify Bearer Request procedure | 15.5.0 | +| 2018-09 | CT#81 | CP-182078 | 1925 | 1 | | S1-U Path Failure | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 1927 | 1 | | Notify 5GS Interworking Ind to PGW | 15.6.0 | +| 2018-12 | CT#82 | CP-183092 | 1931 | 1 | | Provision of dummy SGW-u F-TEIDs | 15.6.0 | +| 2018-12 | CT#82 | CP-183092 | 1932 | - | | Presence condition of the S1-AP Cause and RANAP Cause | 15.6.0 | +| 2018-12 | CT#82 | CP-183091 | 1926 | - | | Secondary RAT Usage Report in Delete Bearer Command | 15.6.0 | +| 2018-12 | CT#82 | CP-183093 | 1928 | 1 | | Correction of the description of Bearer Resource Command in 29.274 | 15.6.0 | +| 2018-12 | CT#82 | CP-183096 | 1930 | 1 | | Correction to table C.1 | 15.6.0 | +| 2019-03 | CT#83 | CP-190032 | 1935 | - | | Return Preferred indication over N26 | 15.7.0 | +| 2019-03 | CT#83 | CP-190032 | 1936 | - | | Mobility between EPC/ePDG and 5GS | 15.7.0 | +| 2019-03 | CT#83 | CP-190032 | 1937 | 2 | | N26 support indication | 15.7.0 | +| 2019-03 | CT#83 | CP-190032 | 1939 | 1 | | Correction to the Modify Bearer Request | 15.7.0 | +| 2019-03 | CT#83 | CP-190170 | 1940 | - | | Enhancements to Configuration Transfer Tunnel over S10 and N26 for EN-DC | 15.7.0 | +| 2019-03 | | | | | | CP-190170 clause numbers updated after information provided by RAN2
"See clauses 22.3.6.2 and 22.3.6.3 of 3GPP TS 36.300 [19]." | 15.7.1 | +| 2019-06 | CT#84 | CP-191025 | 1944 | - | | Correction on CR1889 Implementation | 15.8.0 | +| 2019-06 | CT#84 | CP-191025 | 1942 | 1 | | Control of notifications to SCEF | 15.8.0 | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|--------|-----------|------|-----|-----|---------------------------------------------------------------------------------|--------| +| 2019-06 | CT#84 | | | | | Correction to the location reporting with minimum reporting interval | 15.8.0 | +| | | CP-191026 | 1941 | - | | | | +| 2019-06 | CT#84 | CP-191058 | 1943 | 3 | | Cause for EPS to 5GS Mobility without N26 interface | 15.8.0 | +| 2019-06 | CT#84 | CP-191058 | 1948 | | | 5GS to EPS handover without N26 interface | 15.8.0 | +| 2019-06 | CT#84 | CP-191058 | 1947 | 1 | | Interface Type of an AMF F-TEID and new cause code | 15.8.0 | +| 2019-06 | CT#84 | CP-191045 | 1946 | 1 | | Support of Ethernet PDN connection in EPS | 16.0.0 | +| 2019-06 | CT#84 | CP-191049 | 1945 | 2 | | Cause in Context Acknowledge | 16.0.0 | +| 2019-09 | CT#85 | CP-192098 | 1956 | - | | IP addressing with IPv4/IPv6 capable GTP-C entities | 16.1.0 | +| 2019-09 | CT#85 | CP-192188 | 1954 | - | | Adding 5G SRVCC Support | 16.1.0 | +| 2019-09 | CT#85 | CP-192126 | 1959 | 1 | | Sequence Number in RAB Context | 16.1.0 | +| 2019-09 | CT#85 | CP-192126 | 1962 | 2 | | Additional RRM Policy Index | 16.1.0 | +| 2019-09 | CT#85 | CP-192118 | 1961 | 1 | | Essential Corrections for 5GS Interworking Indication | 16.1.0 | +| 2019-12 | CT#86 | CP-193036 | 1970 | 2 | | 5GS Interworking Indication when MME Change | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 1972 | - | | Identification Request procedure over N26 | 16.2.0 | +| 2019-12 | CT#86 | CP-193041 | 1965 | 1 | | UEs not supporting 5GC NAS with a 5GS subscription | 16.2.0 | +| 2019-12 | CT#86 | CP-193041 | 1966 | - | | UE NR security capability | 16.2.0 | +| 2019-12 | CT#86 | CP-193041 | 1968 | - | | Presence Reporting Area information reporting during S1 handover | 16.2.0 | +| 2019-12 | CT#86 | CP-193041 | 1973 | - | | 5GS Interworking Indication and be restricted to interworking with 5GS | 16.2.0 | +| 2019-12 | CT#86 | CP-193041 | 1975 | 1 | | Unlicensed spectrum NR-U restrictions | 16.2.0 | +| 2019-12 | CT#86 | CP-193047 | 1971 | - | | RLOS attached UEs | 16.2.0 | +| 2019-12 | CT#86 | CP-193061 | 1967 | 1 | | No PDN Connection Transferred during 5G SRVCC HO procedure | 16.2.0 | +| 2019-12 | CT#86 | CP-193061 | 1974 | - | | Adding ClassMark 2 and Supported Codec for 5G SRVCC to 29.274 | 16.2.0 | +| 2019-12 | CT#86 | CP-193062 | 1969 | - | | Transferring UE Radio Capability ID between MMEs | 16.2.0 | +| 2020-03 | CT#87e | CP-200033 | 1976 | 2 | | Idle mode mobility between EPS and 5GS with data forwarding | 16.3.0 | +| 2020-03 | CT#87e | CP-200033 | 1977 | 3 | | Support of MT-EDT | 16.3.0 | +| 2020-03 | CT#87e | CP-200046 | 1978 | 3 | | PGW Selection and the Create Session Request message | 16.3.0 | +| 2020-03 | CT#87e | CP-200022 | 1979 | 1 | | 5G-SRVCC Procedure for Emergency Session | 16.3.0 | +| 2020-03 | CT#87e | CP-200036 | 1980 | 2 | | V2X information in UE Context | 16.3.0 | +| 2020-06 | CT#88e | CP-201052 | 1983 | - | | Clarification to Cause "Invalid Reply from remote peer" | 16.3.0 | +| 2020-06 | CT#88e | CP-201052 | 1984 | 1 | | Support of inter-RAT HO from NR SA to EN-DC | 16.4.0 | +| 2020-06 | CT#88e | CP-201052 | 1987 | | | Wrong figure reference | 16.4.0 | +| 2020-06 | CT#88e | CP-201049 | 1985 | - | | V2X Context between MME and AMF | 16.4.0 | +| 2020-06 | CT#88e | CP-201067 | 1986 | - | | Correct the reference for MDT | 16.4.0 | +| 2020-06 | CT#88e | CP-201068 | 1989 | | | Inter-system handover with direct data forwarding | 16.4.0 | +| 2020-06 | CT#88e | CP-201070 | 1990 | 1 | | Data Forwarding Info | 16.4.0 | +| 2020-09 | CT#89e | CP-202097 | 1991 | 2 | | DAPS Handover information | 16.5.0 | +| 2020-09 | CT#89e | CP-202099 | 1993 | 1 | | Enhancement of network event reporting | 16.5.0 | +| 2020-09 | CT#89e | CP-202108 | 1994 | 2 | | Managing RACS ID for mobility across ePLMNs | 16.5.0 | +| 2020-12 | CT#90e | CP-203033 | 1998 | - | | DRX in MM Context during inter AMF and MME Mobility Procedure | 16.6.0 | +| 2020-12 | CT#90e | CP-203033 | 2000 | - | | IWK-SCEF ID | 16.6.0 | +| 2020-12 | CT#90e | CP-203033 | 1999 | 1 | | Last used PLMN ID during TAU or Registration | 16.6.0 | +| 2020-12 | CT#90e | CP-203058 | 1996 | 1 | | Support of PGW-C/SMF change | 17.0.0 | +| 2021-03 | CT#91e | CP-210056 | 2002 | - | | PGW Node Name IE in Create Session Response | 17.1.0 | +| 2021-03 | CT#91e | CP-210056 | 2006 | 1 | | Essential Correction to UE NR security capability | 17.1.0 | +| 2021-03 | CT#91e | CP-210033 | 2004 | 2 | | PGW reselection by rejecting CSReq with new PGW address | 17.1.0 | +| 2021-03 | | | | | | Corrupted styles under 7.2 fixed | 17.1.1 | +| 2021-06 | CT#92e | CP-211067 | 2016 | - | | LTE-M indication during mobility from 5GC to EPC | 17.2.0 | +| 2021-06 | CT#92e | CP-211024 | 2011 | 1 | | Alternative PGW-C/SMF FQDN | 17.2.0 | +| 2021-06 | CT#92e | CP-211025 | 2010 | - | | Support of Notify Start Pause of Charging via User Plane | 17.2.0 | +| 2021-06 | CT#92e | CP-211032 | 2017 | 1 | | Downlink Data Notification supporting MUSIM | 17.2.0 | +| 2021-06 | CT#92e | CP-211043 | 2012 | 2 | | Restoration of PDN connections affected by a partial or complete failure | 17.2.0 | +| 2021-06 | CT#92e | CP-211052 | 2009 | - | | GTPv2 IE with wrong octet numbering | 17.2.0 | +| 2021-06 | CT#92e | CP-211052 | 2014 | - | | Enable SRVCC after 5G to 4G handover | 17.2.0 | +| 2021-06 | CT#92e | | | | | 4G <-> 5GS mobility corrections to cope with areas of GERAN/UTRAN-only coverage | 17.2.0 | +| | | CP-211053 | 2018 | 1 | | | | +| 2021-09 | CT#93e | CP-212074 | 2024 | 3 | A | TAU reject issue during MME handover (KSI type) | 17.3.0 | +| 2021-09 | CT#93e | CP-212074 | 2027 | - | A | 4G to 5G Direct Data Forwarding | 17.3.0 | +| 2021-09 | CT#93e | | | | F | Correct the presence condition of temporary identities after integrity checking | 17.3.0 | +| | | CP-212046 | 2021 | - | | | | +| 2021-09 | CT#93e | CP-212046 | 2022 | 1 | F | PGW reselection for 5G Network Slice | 17.3.0 | +| 2021-09 | CT#93e | CP-212046 | 2025 | - | C | Passing PSCell ID to SGW for EN-DC | 17.3.0 | +| 2021-09 | CT#93e | CP-212046 | 2028 | 1 | F | Secondary RAT Usage Report | 17.3.0 | +| 2021-09 | CT#93e | | | | B | Restoration of PDN connections served by a combined SGW/PGW in a Set | 17.3.0 | +| | | CP-212033 | 2029 | 1 | | | | +| 2021-12 | CT#94e | | | | A | Support of Inter-system SON Configuration Transfer over the N26 interface | 17.4.0 | +| | | CP-213141 | 2035 | 1 | | | | +| 2021-12 | CT#94e | CP-213127 | 2031 | 1 | F | Clarification on 5GCNRI flag | 17.4.0 | +| 2021-12 | CT#94e | CP-213127 | 2032 | - | F | Communication Failure event | 17.4.0 | +| 2021-12 | CT#94e | | | | B | Support of User Plane Integrity Protection for Interworking from 5GS to EPS | 17.4.0 | +| | | CP-213123 | 2033 | 2 | | | | + +| Date | TSG # | TSG Doc | CR | Rev | Cat | Subject/Comment | New | +|---------|--------|-----------|------|------|-----|--------------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213112 | 2037 | 1 | F | Update user authentication failed cause | 17.4.0 | +| 2022-03 | CT#95e | CP-220071 | 2039 | 1 | A | CR implementation errors (5G SRVCC from 5GS to 3G) | 17.5.0 | +| 2022-03 | CT#95e | CP-220033 | 2042 | 1 | B | New SGW IP Address when moving PDN connections for a combined SGW/PGW/SMF set | 17.5.0 | +| 2022-03 | CT#95e | CP-220033 | 2049 | 1 | B | ePDG support of Restoration of PDN connections after a PGW-C/SMF change | 17.5.0 | +| 2022-03 | CT#95e | CP-220044 | 2044 | - | B | Added reference to UAV procedures | 17.5.0 | +| 2022-03 | CT#95e | CP-220044 | 2051 | - | F | Correct the reference number | 17.5.0 | +| 2022-03 | CT#95e | CP-220044 | 2052 | - | B | Update on the UAS services for ePCO support | 17.5.0 | +| 2022-03 | CT#95e | CP-220045 | 2048 | 1 | B | Transferring Alternative IMSI between MMEs | 17.5.0 | +| 2022-03 | CT#95e | CP-220072 | 2040 | - | F | 5G-SRVCC from NG-RAN to UTRAN Handover Cancellation | 17.5.0 | +| 2022-03 | CT#95e | CP-220072 | 2047 | 1 | F | SRVCC Cause in Forward Relocation Response | 17.5.0 | +| 2022-03 | CT#95e | CP-220089 | 2041 | - | F | Incorrect references | 17.5.0 | +| 2022-03 | CT#95e | CP-220093 | 2043 | 2 | B | RAT Type | 17.5.0 | +| 2022-06 | CT#96 | CP-221042 | 2053 | 1 | F | RAT Types for Satellite | 17.6.0 | +| 2022-06 | CT#96 | CP-221047 | 2054 | 1 | F | Clarification on 5GCNRI and 5GSIWKI flags | 17.6.0 | +| 2022-06 | CT#96 | CP-221047 | 2055 | 1 | F | Clarification on 5GS parameters in (e)PCO or APCO | 17.6.0 | +| 2022-06 | CT#96 | CP-221047 | 2056 | - | F | RNC ID in N26 Forward Relocation Request during 5G-SRVCC handover | 17.6.0 | +| 2022-09 | CT#97e | CP-222031 | 2061 | - | F | New Interface Type N19mb in F-TEID | 17.7.0 | +| 2022-09 | CT#97e | CP-222040 | 2062 | 1 | F | Removal of unnecessary LTE-M satellite Indication | 17.7.0 | +| 2022-09 | CT#97e | CP-222049 | 2058 | - | F | UE radio capability for paging | 17.7.0 | +| 2022-09 | CT#97e | CP-222063 | 2060 | - | A | MSC Server Identity in Forward Relocation Response during SRVCC handover | 17.7.0 | +| 2022-09 | CT#97e | CP-222023 | 2057 | 1 | B | PGW Change Info | 18.0.0 | +| 2022-12 | CT#98e | CP-223037 | 2063 | - | F | PLMN ID related to S-NSSAI | 18.1.0 | +| 2022-12 | CT#98e | CP-223037 | 2064 | - | F | PC5 QoS Flow IE | 18.1.0 | +| 2022-12 | CT#98e | CP-223037 | 2065 | - | F | USS UAV Authorization/Authentication during UE requested PDN connectivity procedure | 18.1.0 | +| 2023-03 | CT#99 | CP-230076 | 2072 | 1 | A | Encoding of PGW FQDN IE | 18.2.0 | +| 2023-03 | CT#99 | CP-230087 | 2074 | - | A | CR implementation error | 18.2.0 | +| 2023-03 | CT#99 | CP-230038 | 2068 | - | B | Secondary DN authentication and authorization in EPS interworking case | 18.2.0 | +| 2023-03 | CT#99 | CP-230038 | 2069 | - | B | Rejecting a Create Session Request due to SDNAEPC is not supported by the UE | 18.2.0 | +| 2023-03 | CT#99 | CP-230056 | 2070 | - | B | MSISDN transfer during Inter-MME/AMF mobility for Lawful Interception | 18.2.0 | +| 2023-06 | CT#100 | CP-231074 | 2076 | 1 | A | PGW-C TEID in Update Bearer Response during PGW triggered PDN connection restoration | 18.3.0 | +| 2023-06 | CT#100 | CP-231074 | 2078 | 1 | A | Corrections to Restoration of PDN connections after a PGW-CSMF change | 18.3.0 | +| 2023-06 | CT#100 | CP-231031 | 2080 | 1 | B | LCS continuity during inter-RAT mobility | 18.3.0 | +| 2023-06 | CT#100 | CP-231056 | 2081 | 1 | B | Support RFSP in use validity time during 5G to 4G mobility | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 2085 | - | F | Correct the instance number of the AMF Identifier | 18.4.0 | +| 2023-09 | CT#101 | CP-232055 | 2084 | 1 | B | MPS for WLAN EPC DSCP | 18.4.0 | +| 2023-09 | CT#101 | CP-232058 | 2084 | 2086 | F | 64bit SCEF-Reference-ID-Ext | 18.4.0 | +| 2023-12 | CT#102 | CP-233065 | 2094 | 1 | A | Support of PGW-C/SMF Set feature over S11 | 18.5.0 | +| 2023-12 | CT#102 | CP-233056 | 2092 | - | F | Duplicate APN Rate Control Status IEs in Create Session Request | 18.5.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29281/raw.md b/raw/rel-18/29_series/29281/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..007ff0ca2b5bf4edbf541e4b5e1e33efba39bc7c --- /dev/null +++ b/raw/rel-18/29_series/29281/raw.md @@ -0,0 +1,1461 @@ + + +# 3GPP TS 29.281 V18.0.0 (2023-06) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; General Packet Radio System (GPRS) Tunnelling Protocol User Plane (GTPv1-U) (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 General..... | 9 | +| 4.1 GTP Path ..... | 9 | +| 4.2 GTP-U Tunnels ..... | 9 | +| 4.2.1 GTP-U Tunnel description ..... | 9 | +| 4.2.2 IP transport ..... | 10 | +| 4.2.3 GTP-U Tunnel IP transport ..... | 10 | +| 4.2.4 Ingress GTP tunnel (GTPv1-U sending endpoint) ..... | 10 | +| 4.2.5 Egress GTP tunnel (GTPv1-U receiving endpoint)..... | 10 | +| 4.2.6 IP Multicast Distribution of User Plane Data for MBMS and MBS ..... | 11 | +| 4.2.6.1 General..... | 11 | +| 4.2.6.2 IP multicast distribution of User Plane Data ..... | 11 | +| 4.3 GTP-U Protocol Entity ..... | 11 | +| 4.3.0 General ..... | 11 | +| 4.3.1 Handling of Sequence Numbers..... | 12 | +| 4.4 Protocol stack..... | 12 | +| 4.4.0 GTP-PDU Stacks..... | 12 | +| 4.4.1 UDP/IP ..... | 13 | +| 4.4.2 UDP header and port numbers ..... | 13 | +| 4.4.2.0 General..... | 13 | +| 4.4.2.1 Echo Request Message ..... | 14 | +| 4.4.2.2 Echo Response Message ..... | 14 | +| 4.4.2.3 Encapsulated T-PDUs..... | 14 | +| 4.4.2.4 Error Indication..... | 14 | +| 4.4.2.5 Supported Extension Headers Notification..... | 14 | +| 4.4.2.6 End Marker ..... | 14 | +| 4.4.2.7 Tunnel Status ..... | 14 | +| 4.4.3 IP header and IP addresses ..... | 14 | +| 4.4.3.1 Echo Request Message ..... | 14 | +| 4.4.3.2 Echo Response Message ..... | 14 | +| 4.4.3.3 Encapsulated T-PDUs..... | 14 | +| 4.4.3.4 Error Indication..... | 15 | +| 4.4.3.5 Supported Extension Headers Notification..... | 15 | +| 4.4.3.6 End Marker ..... | 15 | +| 4.4.3.7 Tunnel Status ..... | 15 | +| 4.5 Transmission Order and Bit Definitions ..... | 15 | +| 4.6 New Functionality ..... | 15 | +| 5 GTP-U header ..... | 15 | +| 5.1 General format..... | 15 | +| 5.2 GTP-U Extension Header..... | 17 | +| 5.2.1 General format of the GTP-U Extension Header ..... | 17 | +| 5.2.2 Extension Header types ..... | 19 | +| 5.2.2.1 UDP Port..... | 19 | +| 5.2.2.2 PDCP PDU Number ..... | 19 | +| 5.2.2.2A Long PDCP PDU Number..... | 19 | +| 5.2.2.3 Service Class Indicator ..... | 20 | +| 5.2.2.4 RAN Container ..... | 21 | +| 5.2.2.5 Xw RAN Container ..... | 21 | +| 5.2.2.6 NR RAN Container..... | 22 | + +| | | | +|-------------------------------|----------------------------------------------------------------------|-----------| +| 5.2.2.7 | PDU Session Container ..... | 22 | +| 6 | GTP-U Message Formats ..... | 23 | +| 6.1 | General ..... | 23 | +| 6.2 | Presence requirements of Information Elements ..... | 23 | +| 7 | GTP-U Messages ..... | 23 | +| 7.1 | General ..... | 23 | +| 7.2 | Path Management Messages ..... | 24 | +| 7.2.1 | Echo Request ..... | 24 | +| 7.2.2 | Echo Response ..... | 24 | +| 7.2.3 | Supported Extension Headers Notification ..... | 25 | +| 7.3 | Tunnel Management Messages ..... | 25 | +| 7.3.1 | Error Indication ..... | 25 | +| 7.3.2 | End Marker ..... | 25 | +| 7.3.2.1 | General ..... | 25 | +| 7.3.2.2 | End Marker in EPS ..... | 26 | +| 7.3.2.3 | End Marker in 5GS ..... | 26 | +| 7.3.3 | Tunnel Status ..... | 26 | +| 8 | Information Elements ..... | 27 | +| 8.1 | Information Element Types ..... | 27 | +| 8.2 | Recovery ..... | 27 | +| 8.3 | Tunnel Endpoint Identifier Data I ..... | 28 | +| 8.4 | GTP-U Peer Address ..... | 28 | +| 8.5 | Extension Header Type List ..... | 28 | +| 8.6 | Private Extension ..... | 29 | +| 8.7 | GTP-U Tunnel Status Information ..... | 29 | +| 8.7 | Recovery Time Stamp ..... | 30 | +| 9 | Error Handling ..... | 30 | +| 9.1 | Protocol Errors ..... | 30 | +| 9.2 | Path Failure ..... | 30 | +| 10 | Security ..... | 30 | +| 11 | Reliable Delivery of Signalling Messages ..... | 30 | +| 12 | GTP Parameters ..... | 31 | +| 12.1 | General ..... | 31 | +| 12.2 | Timers ..... | 31 | +| 12.3 | Others ..... | 31 | +| 13 | Tunnelling Scenarios ..... | 31 | +| 13.1 | General ..... | 31 | +| 13.2 | Tunnelling between SGWs ..... | 31 | +| 13.3 | Transfer of the user plane data between PDN GWs ..... | 31 | +| 13.4 | Tunnelling between SGSNs ..... | 31 | +| 13.5 | Tunnelling between Source RNC and Target RNC ..... | 32 | +| 13.6 | Transfer of the user plane data between GGSNs ..... | 32 | +| 13.7 | Tunnelling between RNC and eNodeB ..... | 32 | +| 13.8 | Tunnelling between SGSN and eNodeB ..... | 32 | +| 13.9 | Tunnelling between Source eNodeB and Target eNodeB ..... | 32 | +| 13.10 | Tunnelling between SGSN and RNC ..... | 32 | +| 13.11 | Tunnelling between SGSN and SGW ..... | 32 | +| 13.12 | Tunnelling between SGW and eNodeB ..... | 32 | +| 13.13 | Tunnelling between SGW and RNC ..... | 33 | +| 13.14 | Tunnelling between SGW and SGSN ..... | 33 | +| Annex A (Normative): | PDU session user plane protocol over N9, N3mb and N19mb ..... | 34 | +| Annex B (informative): | Change history ..... | 34 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document defines the user plane of GTP used on: + +- the Gn and Gp interfaces of the General Packet Radio Service (GPRS); +- the Iu, Gn and Gp interfaces of the UMTS system; +- the S1-U, S11-U, S2a, S2b, X2, S4, S5, S8, S12, M1 and Sn interfaces of the Evolved Packet System (EPS); +- the F1-U, Xn, W1-U, N3, N9, N19, N3mb and N19mb interfaces of the 5G System (5GS). + +This definition ensures full backwards compatibility with RNC, SGSN and GGSN implementations according to release 7 of 3GPP TS 29.060 [6]. + +NOTE: Releases previous to Release-8 have used 3GPP TS 29.060 [6] as normative definition of the user plane of GTP. This shall be considered when essential corrections are included in the present document or in pre-release-8 version of 3GPP TS 29.060 [6]. + +Fallback from GTPv1-U to GTPv0-U shall not be supported. Therefore, 3GPP Rel-8 and onwards GTPv1-U entity should not listen to the well-known GTPv0 port 3386. If GTPv1 entity listens to the GTPv0 port, the entity shall silently discard any received GTPv0-U message. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.003: "Numbering, addressing and identification". +- [3] 3GPP TS 23.007: "Restoration procedures". +- [4] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [5] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [6] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface". + +- [7] 3GPP TS 29.274: "3GPP Evolved Packet System; Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [8] 3GPP TS 32.295: "Telecommunication management; Charging management; Charging Data Record (CDR) transfer". +- [9] IETF RFC 768 (STD 0006): "User Datagram Protocol", J. Postel. +- [10] IETF RFC 791 (STD 0005): "Internet Protocol", J. Postel. +- [11] IETF RFC 4291: "IP Version 6 Addressing Architecture". +- [12] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [13] 3GPP TS 23.121: "Architectural requirements for Release 1999". +- [14] 3GPP TS 43.129: "Packet-switched handover for GERAN A/Gb mode; Stage 2". +- [15] IETF RFC 2460: "Internet Protocol, Version 6 (IPv6) Specification". +- [16] 3GPP TS 25.413: "UTRAN Iu interface RANAP signalling". +- [17] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2". +- [18] 3GPP TS 23.246: "Multimedia Broadcast/Multicast Service (MBMS); Architecture and functional description; Stage 2". +- [19] IETF RFC 4604 (2006): "Using Internet Group Management Protocol Version 3 (IGMPv3) and Multicast Listener Discovery Protocol Version 2 (MLDv2) for Source-Specific Multicast". +- [20] IETF RFC 4607 (2006): "Source-Specific Multicast for IP". +- [21] 3GPP TS 33.102: "3G Security; Security architecture". +- [22] 3GPP TS 33.401: "3GPP System Architecture Evolution (SAE): Security architecture". +- [23] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [24] 3GPP TS 36.323: "Evolved Universal Terrestrial Radio Access (E-UTRA); Packet Data Convergence Protocol (PDCP) specification". +- [25] 3GPP TS 36.425: "E-UTRAN X2 interface user plane protocol". +- [26] IETF RFC 2474, "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [27] 3GPP TS 36.465: "Evolved Universal Terrestrial Radio Access (E-UTRAN) and Wireless LAN (WLAN) Xw interface user plane protocol". +- [28] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [29] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [30] 3GPP TS 38.425: "NG-RAN; NR user plane protocol". +- [31] 3GPP TS 38.415: "NG-RAN; PDU Session User Plane Protocol". +- [32] 3GPP TS 33.250: "Security assurance specification for the PGW network product class". +- [33] 3GPP TS 23.527: "5G System; Restoration Procedures". +- [34] 3GPP TS 38.300: "NR; NR and NG-RAN Overall Description; Stage 2". +- [35] 3GPP TS 38.323: "NR; Packet Data Convergence Protocol (PDCP) specification". +- [36] IETF RFC 8200: "Internet Protocol, Version 6 (IPv6) Specification" + +- [37] IETF RFC 6437: "IPv6 Flow Label Specification". +- [38] 3GPP TS 37.340: "Evolved Universal Terrestrial Radio Access (E-UTRA) and NR; Multi-connectivity; Stage 2". +- [39] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane Nodes". +- [40] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services". +- [41] IETF RFC 5905: "Network Time Protocol Version 4: Protocol and Algorithms Specification". +- [42] 3GPP TS 37.470: "W1 interface; General aspects and principles". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +**Common Tunnel Endpoint Identifier (C-TEID):** Unambiguously identifies a tunnel endpoint in the receiving GTP-U protocol entity for a given UDP/IP endpoint. The sending end side of a GTP tunnel locally assigns the C-TEID value used in the TEID field and signals it to the destination Tunnel Endpoint using a control plane message. + +**GTP-U Message:** GTP-U (user plane) messages are either user plane messages or signalling messages. User plane messages are used to carry user data packets between GTP-U entities. Signalling messages are sent between network nodes for path management and tunnel management. **GTP-U peer:** node implementing at least one side of any of the GTP user plane based protocols. RNC, SGSN, GGSN, eNodeB, SGW, ePDG, gNB, N3IWF, UPF, PGW or TWAN or MME. + +**GTP-U Tunnel:** A GTP-U tunnel is identified in each node with a TEID, an IP address and a UDP port number. A GTP-U tunnel is necessary to enable forwarding packets between GTP-U entities. + +**GTP-U Tunnel Endpoint:** A GTP-U tunnel endpoint identifies a user plane context (e.g EPS bearer, PDU session or a RAB) for which a received GTP-U packet is intended. A given GTP-U tunnel endpoint may receive GTP-U packets from more than one source GTP-U peer (See clause 4.3.0). **UDP/IP Path:** Connection-less unidirectional or bidirectional path defined by two end-points. An IP address and a UDP port number define an end-point. A UDP/IP path carries GTP messages between network nodes related to one or more GTP tunnels. + +**GTP-PDU:** GTP Protocol Data Unit (PDU) is a GTP-U message, which may be either a G-PDU or a signalling message. + +**G-PDU:** User data packet (T-PDU) plus GTP-U header, sent between GTP network nodes. + +**Signalling Message:** A GTP-U message (GTP-PDU that is not a G-PDU) sent between GTP network nodes. These may be Path Management messages or Tunnel Management messages. + +**T-PDU:** A user data packet, for example an IP datagram, sent between a UE and a network entity in an external packet data network. A T-PDU is the payload that is tunnelled in the GTP-U tunnel. + +**Tunnel Endpoint Identifier (TEID):** Unambiguously identifies a tunnel endpoint in the receiving GTP-U protocol entity for a given UDP/IP endpoint. The receiving end side of a GTP tunnel locally assigns the TEID value the transmitting side has to use. The TEID values are exchanged between tunnel endpoints using control plane message. + +**Trusted WLAN Access Network:** see 3GPP TS 23.402 [23]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|--------|---------------------------------------| +| C-TEID | Common Tunnel Endpoint IDentifier | +| EN-DC | E-UTRA-NR Dual Connectivity | +| ePDG | Evolved Packet Data Gateway | +| GSN | GPRS Support Node | +| GGSN | Gateway GPRS Support Node | +| G-PDU | GTP encapsulated user Plane Data Unit | +| GTP | GPRS Tunnelling Protocol | +| GTP-C | GTP Control | +| GTP-U | GTP User | +| IE | Information Element | +| IGMP | Internet Group Management Protocol | +| IP | Internet Protocol | +| IPv4 | Internet Protocol version 4 | +| IPv6 | Internet Protocol version 6 | +| MME | Mobility Management Entity | +| PDU | Packet Data Unit | +| PGW | PDN Gateway | +| QoS | Quality of Service | +| RANAP | Radio Access Network Application Part | +| RNC | Radio Network Controller | +| SGSN | Serving GPRS Support Node | +| SGW | Serving Gateway | +| TEID | Tunnel Endpoint IDentifier | +| T-PDU | Transport PDU | +| TWAN | Trusted WLAN Access Network | +| UDP | User Datagram Protocol | +| UTRAN | UMTS Terrestrial Radio Access Network | + +# --- 4 General + +## 4.1 GTP Path + +For the definition of UDP/IP Path and GTP Endpoint, see 3GPP TS 29.060 [6]. + +## 4.2 GTP-U Tunnels + +### 4.2.1 GTP-U Tunnel description + +GTP-U Tunnels are used to carry encapsulated T-PDUs and signalling messages between a given pair of GTP-U Tunnel Endpoints. The Tunnel Endpoint ID (TEID) which is present in the GTP header shall indicate which tunnel a particular T-PDU belongs to. In this manner, packets are multiplexed and de-multiplexed by GTP-U between a given pair of Tunnel Endpoints. The TEID value to be used in the TEID field shall be signalled to the peer GTP-U entity using a control plane protocol like GTPv1-C, GTPv2-C, RANAP or S1-AP. + +In what follows we refer to the outer GTPv1-U IP packet as the IP packet that carries a GTPv1-U packet. The inner IP packet in a GTPv1-U packet (T-PDU) is either + +- An IP packet sent to the UE/MS in the downlink direction over one or more tunnels from the external network identified by the APN. +- An IP packet sent from a UE/MS in the uplink direction over one or more tunnels to the external network identified by the APN. + +NOTE 1: Not all tunnels in 3GPP networks will necessarily be GTPv1-U, + +NOTE 2: The inner MTU size of the GTPv1-U tunnel is typically not the same as the outer MTU size of the IP path carrying the outer IP packets. + +The maximum size of a T-PDU that may be transmitted without fragmentation by GGSN or the MS is defined in 3GPP TS 23.060 [4]. + +### 4.2.2 IP transport + +According to IETF RFC 791 [10], any IPv4 router in the backbone may fragment the outer IPv4 GTPv1-U packet with a flag of DF=0. + +Unnecessary fragmentation should be avoided when possible due to the following; + +- Fragmentation is bandwidth inefficient, since the complete IP header is duplicated in each fragment. +- Fragmentation is CPU intensive since more fragments require more processing at both GTPv1-U endpoints and IP routers. It also requires additional memory at the receiver. +- If one fragment is lost, the complete packet has to be discarded. The reason is there is no selective retransmission of IP fragments provided in IPv4 or IPv6. + +Recommendations on how to set the default inner MTU size at the PDN GW and UE/MS to avoid IP fragmentation of both inner IP packets (in the PDN GW or UE/MS) and outer IP packets in the backbone are specified in clause 9.3 of 3GPP TS 23.060 [4]. + +### 4.2.3 GTP-U Tunnel IP transport + +Functionality for IP transport and IP fragmentation at a RAN node on the Iu interface or S12 is defined in 3GPP TS 25.414 [16]. + +Functionality for IP transport and IP fragmentation at an eNodeB on the S1-U and X2 interface is defined in 3GPP TS 36.300 [17]. + +Functionality for IP transport and IP fragmentation at an NG-RAN on the N3 and Xn interface is defined in 3GPP TS 38.300 [34]. + +Functionality for IP transport and IP fragmentation for interconnecting an ng-eNB-CU and an ng-eNB-DU of an ng-eNB within an NG-RAN on the W1-U interface is defined in 3GPP TS 37.470 [42]. + +The outer GTPv1-U packet layer shall support IPv4 as defined by IETF RFC 791 [10] and should support IPv6 as defined by IETF RFC 8200 [36]. + +The following text as well as clauses 4.2.4 and 4.2.5 apply only to core network GTPv1-U endpoints. + +GTPv1-U tunnel endpoints do not need to change the hopcount/TTL or to perform any IP routing functions in respect to inner IP packet other than the functions explicitly stated here. However, other co-located functions may do so. For example, the GGSN/PGW/UPF may change the hopcount/TTL as the IP datagram enters/leaves the Gi/SGi/N6 interface from/to the GTPv1-U tunnel interface and IP packets may be discarded or rejected at any point by a co-located function due to local policy and/or QoS (the policy enforcement point). + +### 4.2.4 Ingress GTP tunnel (GTPv1-U sending endpoint) + +An inner IP packet shall be encapsulated at the GTPv1-U sender with a GTP header, UDP and IP header. If the resulting outer IP packet is larger than the MTU of the first link towards the destination GTPv1-U endpoint, fragmentation of the IP packet shall be performed by the sender as per IETF RFC 791 [10] for an outer layer of IPv4 and IETF RFC 8200 [36] for an outer layer of IPv6. The GTPv1-U sender should preferably fragment the IP packet to the smallest MTU of any link between GTPv1-U sender and GTPv1-U receiver. + +Fragmentation policy of the inner datagram is implementation dependent but shall interwork with IETF RFC 791 [10] for inner IPv4 datagrams and IETF RFC 8200 [36] for inner IPv6 packets. + +### 4.2.5 Egress GTP tunnel (GTPv1-U receiving endpoint) + +The GTPv1-U receiving endpoint packets shall reassemble any IP fragments in datagrams received from the GTPv1-U sending endpoint as per IETF RFC 791 [10] for outer IPv4 datagrams and as per IETF RFC 8200 [36] for outer IPv6 + +datagrams. The IP reassembly buffer in the receiving endpoint shall be at least the inner MTU size plus the size of the tunnel headers (outer IP header, outer UDP header, and GTP header, including any GTP extension headers). + +The completely reassembled IP packet shall then be passed to the IP/UDP/GTPv1-U layers to extract the inner IP packet which is then processed further according to the receiving node's functionality. + +### 4.2.6 IP Multicast Distribution of User Plane Data for MBMS and MBS + +#### 4.2.6.1 General + +In GPRS and EPS, MBMS data may be delivered between the GGSN and RNC, or between the MBMS GW and the eNodeB or RNC, using IP multicast transport, as specified in clause 6.5 of 3GPP TS 23.246 [18]. + +In 5GS, MBS data may be delivered between the 5GC and NG-RAN using 5GC Individual MBS traffic delivery (applicable only to multicast MBS sessions) and/or 5GC Shared MBS traffic delivery (applicable to broadcast and multicast MBS sessions), as specified in clause 4.1 of 3GPP TS 23.247 [40]. The user plane from the MB-UPF to NG-RANs (for 5GC Shared MBS traffic delivery) and the user plane from the MB-UPF to UPFs (for 5GC Individual MBS traffic delivery) may use IP multicast transport via a common GTP-U tunnel per MBS session, or use unicast transport via separate GTP-U tunnels at NG-RAN or at UPF per MBS session, as specified in clause 6.7 of 3GPP TS 23.247 [40]. + +Specific requirements for IP multicast distribution of user plane data are specified in clause 4.2.6.2. + +#### 4.2.6.2 IP multicast distribution of User Plane Data + +When using IP multicast transport, GTP-U Multicast Tunnels shall be used for unidirectional transfer of the encapsulated T-PDUs from one GTP-U Tunnel Endpoint acting as an IP multicast source to multiple GTP-U Tunnel Endpoints acting as IP multicast listeners. The Common Tunnel Endpoint ID (C-TEID) which is present in the GTP header shall indicate which tunnel a particular T-PDU belongs to. The C-TEID value to be used in the TEID field shall be allocated at the source Tunnel Endpoint and signalled to the destination Tunnel Endpoint using a control plane protocol, i.e. GTPv1-C and RANAP, GTPv2-C and S1-AP, 5GC SBIs and/or NGAP. One C-TEID shall be allocated per MBMS bearer service or per MBS session. + +The destination IP address in the outer GTPv1-U IP header shall be an address in the multicast address range as specified in IETF RFC 4607 [20]. + +If the RNC decides to receive IP multicast packets, then the RNC shall join the IP multicast group as specified by IETF RFC 4604 [19] and IETF RFC 4607 [20]. + +If the eNodeB supports MBMS as specified in 3GPP TS 23.246 [18], it shall join the IP multicast group as specified in IETF RFC 4604 [19] and IETF RFC 4607 [20]. + +If the gNB supports MBS as specified in 3GPP TS 23.247 [40], it shall join the IP multicast group as specified in IETF RFC 4604 [19] and IETF RFC 4607 [20]. + +The characteristics for point-to-multipoint GTP-U Multicast Tunnels used for MBMS or MBS are the same as for a point-to-point GTP-U Tunnels unless specified otherwise. The differences are specified in clause 7.1. + +## 4.3 GTP-U Protocol Entity + +### 4.3.0 General + +The GTP-U protocol entity provides packet transmission and reception services to user plane entities in the RNC, SGSN, GGSN, eNodeB, SGW, ePDG, PGW, TWAN, MME, gNB, N3IWF, UPF and MB-UPF. The GTP-U protocol entity receives traffic from a number of GTP-U tunnel endpoints and transmits traffic to a number of GTP-U tunnel endpoints. There is a GTP-U protocol entity per IP address. + +The TEID in the GTP-U header is used to de-multiplex traffic incoming from remote tunnel endpoints so that it is delivered to the User plane entities in a way that allows multiplexing of different users, different packet protocols and different QoS levels. The GTP-U protocol supports the possibility for one GTP-U tunnel endpoint to receive packets from multiple remote GTP-U endpoints. This may be used in the following scenarios: + +- Tracking Area Update procedure with Serving GW change and data forwarding as specified in clause 5.3.3.1A of 3GPP TS 23.401 [5], if the above capability is supported by the receiving eNB; +- Dual connectivity in 5GC as specified in clause 5.11.1 of 3GPP TS 23.501 [28], where the master and secondary NG-RAN may be assigned the same uplink F-TEID of the UPF by the SMF for uplink traffic of the same PDU session; and +- IPv6 multihoming scenario as specified in clause 5.6.4.3 of 3GPP TS 23.501 [28], where the downlink traffic from multiple PDU Session Anchors of the same PDU session may be assigned the same N9 F-TEID of the branching point UPF by the SMF. + +### 4.3.1 Handling of Sequence Numbers + +This functionality is provided only when the S bit is set to 1 in the GTP-U header. + +For PGW, SGW, ePDG, eNodeB, TWAN, MME, gNB, N3IWF, and UPF, the usage of sequence numbers in G-PDUs is optional, but if GTP-U protocol entities in these nodes are relaying G-PDUs to other nodes, then they shall relay the sequence numbers as well. For all other cases, the PGW, SGW, ePDG, eNodeB, TWAN, MME, gNB, N3IWF and UPF should set the "S" flag to 0 in the GTPv1 header which then indicates that the sequence number is not used in the T-PDU. + +An RNC, SGSN or GGSN shall reorder out of sequence T-PDUs when in sequence delivery is required. This is optional at the SGSN for UTRAN access. The GTP-U protocol entity shall deliver to the user plane entity only in sequence T-PDUs and notify the sequence number associated to each of them. The notification of the sequence number is not necessary at the GGSN, but it is mandatory at the SGSN and RNC. The user plane entity shall provide a sequence number to the GTP-U layer together with T-PDUs to be transmitted in sequence. GTP-U protocol entities at the GGSN may optionally generate autonomously the sequence number, but should be able to use sequence numbers provided by the user plane entity. The sequence number is handled on a per GTP-U Tunnel (that is TEID) basis. During relocations and handovers, if a buffered packet is forwarded from the source to the target GTP-U protocol entity along with PDCP T-PDU extension headers, the source of the T-PDU may be considered different and may not relay the sequence numbers. + +When the sequence number is included in the GTP-U header, a user plane entity acting as a relay of T-PDUs between GTP-U protocol entities, or between PDCP (or SNDPCP) protocol entities and GTP-U protocol entities, shall relay the sequence numbers between those entities as well. In this way it is possible to keep consistent values of sequence numbers from the GGSN to the UE (MS in GPRS) by relaying the sequence number across the CN GTP-U bearer, the Iu GTP-U bearer and the Radio bearer (via PDCP or SNDPCP N-PDU numbers). This functionality is beneficial during SRNS relocation. + +For GTP-U signalling messages having a response message defined for a request message, Sequence Number shall be a message number valid for a path. Within a given set of continuous Sequence Numbers from 0 to 65535, a given Sequence Number shall, if used, unambiguously define a GTP-U signalling request message sent on the path (see clause Reliable delivery of signalling messages). The Sequence Number in a signalling response message shall be copied from the signalling request message that the GTP-U entity is replying to. For GTP-U messages not having a defined response message for a request message, i.e. for messages Supported Extension Headers Notification and Error Indication, the Sequence Number shall be ignored by the receiver. + +## 4.4 Protocol stack + +### 4.4.0 GTP-PDU Stacks + +The protocol stack for a GTP-PDU G-PDU is shown in Figure 4.4-1. The protocol stack for a GTP-PDU signaling message is shown in Figure 4.4-2. + +![Figure 4.4-1 G-PDU Protocol Stack diagram showing three stacked layers: T-PDU, GTPv1-U Header, and UDP/IP. A bracket on the right groups the top two layers as G-PDU.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +The diagram illustrates the G-PDU Protocol Stack. It consists of three vertically stacked rectangular boxes. The top box is labeled 'T-PDU', the middle box is labeled 'GTPv1-U Header', and the bottom box is labeled 'UDP/IP'. A large curly bracket on the right side of the stack groups the 'T-PDU' and 'GTPv1-U Header' layers together, with the label 'G-PDU' positioned to the right of the bracket. + +Figure 4.4-1 G-PDU Protocol Stack diagram showing three stacked layers: T-PDU, GTPv1-U Header, and UDP/IP. A bracket on the right groups the top two layers as G-PDU. + +Figure: 4.4-1 G-PDU Protocol Stack + +NOTE: T-PDU may contain an IP Datagram, Ethernet or unstructured PDU Data frames as specified in 3GPP TS 23.501 [28]. + +![Figure 4.4-2 Signalling Message Protocol Stack diagram showing three stacked layers: Zero or more IEs, GTPV1-U Header, and UDP/IP. A bracket on the right groups the top two layers as Signaling Message (Path Management or Tunnel Management).](ddc7460821484f1ae2835c67955c554c_img.jpg) + +The diagram illustrates the Signalling Message Protocol Stack. It consists of three vertically stacked rectangular boxes. The top box is labeled 'Zero or more IEs', the middle box is labeled 'GTPV1-U Header', and the bottom box is labeled 'UDP/IP'. A large curly bracket on the right side of the stack groups the 'Zero or more IEs' and 'GTPV1-U Header' layers together, with the label 'Signaling Message (Path Management or Tunnel Management)' positioned to the right of the bracket. + +Figure 4.4-2 Signalling Message Protocol Stack diagram showing three stacked layers: Zero or more IEs, GTPV1-U Header, and UDP/IP. A bracket on the right groups the top two layers as Signaling Message (Path Management or Tunnel Management). + +Figure: 4.4-2 Signalling Message Protocol Stack + +### 4.4.1 UDP/IP + +UDP/IP is the only path protocol defined to transfer GTP messages in the version 1 of GTP. + +A GTPv1-U peer shall support the User Datagram Protocol (UDP) as defined by IETF RFC 768 [9] shall be used. + +A GTPv1-U peer shall support IPv4 as defined by IETF RFC 791 [10] and should support IPv6 as defined by IETF RFC 8200 [36]. + +The DSCP marking as defined by IETF RFC 2474 [26] shall be set: + +- based on the QCI, and optionally the ARP priority level, of the associated EPS bearer, as described in clause 4.7.3 of 3GPP TS 23.401 [5]; +- based on the 5QI and ARP of the associated 5G QoS Flow, as described in clause 5.7.1.6 and clause 5.7.1.7 of 3GPP TS 23.501 [28]. + +### 4.4.2 UDP header and port numbers + +#### 4.4.2.0 General + +For the GTP-U messages described below (other than the Echo Response message, see clause 4.4.2.2), the UDP Source Port or the Flow Label field (see IETF RFC 6437 [37]) should be set dynamically by the sending GTP-U entity to help balancing the load in the transport network. + +When using GTP-U over IPv6 (see IETF RFC 8200 [36]), the UDP checksum shall not be set to zero by the sending GTP-U entity unless it is ensured that the peer GTP-U entity and the path in-between supports UDP zero checksum. + +NOTE 1: GTP-U entities complying with an earlier version of the specification or on path IPv6 middleboxes can implement IPv6 as specified in IETF RFC 2460 [15] and discard UDP packets containing a zero checksum. + +NOTE 2: How a sending GTP-U entity knows whether the peer GTP-U entity and the path in-between supports UDP zero checksum is out of scope of this specification. + +#### 4.4.2.1 Echo Request Message + +The UDP Destination Port number for GTP-U request messages is 2152. It is the registered port number for GTP-U. + +#### 4.4.2.2 Echo Response Message + +The UDP Destination Port value shall be the value of the UDP Source Port of the corresponding request message. + +The UDP Source Port shall be the value from the UDP Destination Port of the corresponding request message. + +#### 4.4.2.3 Encapsulated T-PDUs + +The UDP Destination Port number shall be 2152. It is the registered port number for GTP-U. + +#### 4.4.2.4 Error Indication + +The UDP destination port for the Error Indication shall be the user plane UDP port (2152). + +NOTE: In network deployments including non-GTP-aware stateful firewalls, those firewalls must be configured to allow response messages coming from a different UDP port and IP address than the triggering message. + +#### 4.4.2.5 Supported Extension Headers Notification + +The UDP destination port for the Supported Extension Headers Notification shall be the user plane UDP port (2152). + +#### 4.4.2.6 End Marker + +The UDP Destination Port number shall be 2152. It is the registered port number for GTP-U. + +The UDP Destination Port and UDP Source Port shall be the same as those of the corresponding GTP-U tunnel for which the End Marker message is sent. + +#### 4.4.2.7 Tunnel Status + +The UDP destination port for the Tunnel Status shall be the user plane UDP port (2152). + +### 4.4.3 IP header and IP addresses + +#### 4.4.3.1 Echo Request Message + +The IP Source Address shall be an IP address of the source GTP-U entity from which the message is originating. + +The IP Destination Address in a GTP request message shall be an IP address of the destination GTP-U entity. + +#### 4.4.3.2 Echo Response Message + +The IP Source Address shall be copied from the IP destination address of the GTP request message to which this GTP-U entity is replying. + +The IP Destination Address shall be copied from the IP Source Address of the GTP request message to which this GTP-U entity is replying. + +#### 4.4.3.3 Encapsulated T-PDUs + +The IP Source Address shall be an IP address of the source GTP-U entity from which the message is originating. + +The IP Destination Address shall be an IP address of the destination GTP-U entity. + +#### 4.4.3.4 Error Indication + +The IP source address shall be an address of the source GTP-U entity from which the message is originated + +NOTE: In network deployments including non-GTP-aware stateful firewalls, those firewalls must be configured to allow response messages coming from a different UDP port and IP address than the triggering message. + +The IP destination address for Error Indication shall be the source address of the GTP-PDU that is the cause for this GTP-U entity to send this message. + +#### 4.4.3.5 Supported Extension Headers Notification + +The IP Source Address for the Supported Extension Headers Notification shall be copied from the IP destination address of the GTP message that triggered the GTP-U entity to send this message. + +The IP Destination Address for the Supported Extension Headers Notification shall be copied from the IP source address of the GTP message that triggered the GTP-U entity to send this message. + +#### 4.4.3.6 End Marker + +The IP Source Address shall be an IP address of the source GTP-U entity from which the message is originating. + +The IP Destination Address shall be an IP address of the destination GTP-U entity. + +The IP Destination Address and IP Source Address shall be the same as those of the corresponding GTP-U tunnel for which the End Marker message is sent. + +#### 4.4.3.7 Tunnel Status + +The IP Source Address shall be an IP address of the source GTP-U entity from which the message is originating. + +The IP Destination Address shall be an IP address of the destination GTP-U entity. + +The IP Destination Address and IP Source Address shall be the same as the corresponding GTP-U tunnel (to send G-PDU) for which the Tunnel Status message is sent. + +## 4.5 Transmission Order and Bit Definitions + +As specified in 3GPP TS 29.060 [6], clause 5. + +## 4.6 New Functionality + +With regard to the previous releases, the present specification may define some new functions. Such new functions shall ensure full backwards compatibility with Pre-Rel-8 nodes conforming to 3GPP TS 29.060 [6]. If the new functions are specified with the Extension Headers, bits 8 and 7 of the Extension Header Type shall be set to 0, 0 respectively or 0, 1 respectively. If the new functions are specified with Information Elements, such Information Elements shall be TLV-encoded and optional. + +# --- 5 GTP-U header + +## 5.1 General format + +The GTP-U header is a variable length header whose minimum length is 8 bytes. There are three flags that are used to signal the presence of additional optional fields: the PN flag, the S flag and the E flag. The PN flag is used to signal the + +presence of N-PDU Numbers. The S flag is used to signal the presence of the GTP Sequence Number field. The E flag is used to signal the presence of the Extension Header field, used to enable future extensions of the GTP header defined in this document, without the need to use another version number. If and only if one or more of these three flags are set, the fields Sequence Number, N-PDU and Extension Header shall be present. The sender shall set all the bits of the unused fields to zero. The receiver shall not evaluate the unused fields. For example, if only the E flag is set to 1, then the N-PDU Number and Sequence Number fields shall also be present, but will not have meaningful values and shall not be evaluated. + +### Always present fields: + +- Version field: This field is used to determine the version of the GTP-U protocol. The version number shall be set to '1'. +- Protocol Type (PT): This bit is used as a protocol discriminator between GTP (when PT is '1') and GTP' (when PT is '0'). GTP is described in this document and the GTP' protocol in 3GPP TS 32.295 [8]. Note that the interpretation of the header fields may be different in GTP' than in GTP. +- Extension Header flag (E): This flag indicates the presence of a meaningful value of the Next Extension Header field. When it is set to '0', the Next Extension Header field either is not present or, if present, shall not be interpreted. When it is set to '1', the Next Extension Header field is present, and shall be interpreted, as described below in this clause. +- Sequence number flag (S): This flag indicates the presence of a meaningful value of the Sequence Number field. When it is set to '0', the Sequence Number field either is not present or, if present, shall not be interpreted. When it is set to '1', the Sequence Number field is present, and shall be interpreted, as described below in this clause. For the Echo Request, Echo Response, Error Indication and Supported Extension Headers Notification messages, the S flag shall be set to '1'. Since the use of Sequence Numbers is optional for G-PDUs, the PGW, SGW, ePDG, eNodeB and TWAN should set the flag to '0'. However, when a G-PDU (T-PDU+header) is being relayed by the Indirect Data Forwarding for Inter RAT HO procedure, then if the received G-PDU has the S flag set to '1', then the relaying entity shall set S flag to '1' and forward the G-PDU (T-PDU+header). In an End marker and Tunnel Status messages the S flag shall be set to '0'. +- N-PDU Number flag (PN): This flag indicates the presence of a meaningful value of the N-PDU Number field. When it is set to '0', the N-PDU Number field either is not present, or, if present, shall not be interpreted. When it is set to '1', the N-PDU Number field is present, and shall be interpreted, as described below in this clause. +- Message Type: This field indicates the type of GTP-U message. +- Length: This field indicates the length in octets of the payload, i.e. the rest of the packet following the mandatory part of the GTP header (that is the first 8 octets). The Sequence Number, the N-PDU Number or any Extension headers shall be considered to be part of the payload, i.e. included in the length count. +- Tunnel Endpoint Identifier (TEID): This field unambiguously identifies a tunnel endpoint in the receiving GTP-U protocol entity. The receiving end side of a GTP tunnel locally assigns the TEID value the transmitting side has to use. The TEID value shall be assigned in a non-predictable manner for PGW S5/S8/S2a/S2b interfaces (see 3GPP TS 33.250 [32]). The TEID shall be used by the receiving entity to find the PDP context, except for the following cases: + - The Echo Request/Response and Supported Extension Headers notification messages, where the Tunnel Endpoint Identifier shall be set to all zeroes. + - The Error Indication message where the Tunnel Endpoint Identifier shall be set to all zeros. +- When setting up a GTP-U tunnel, the GTP-U entity shall not assign the value 'all zeros' to its own TEID. However, for backward compatibility, if a GTP-U entity receives (via respective control plane message) a peer's TEID that is set to the value 'all zeros', the GTP-U entity shall accept this value as valid and send the subsequent G-PDU with the TEID field in the header set to the value 'all zeros'. + +### Optional fields: + +- Sequence Number: If Sequence Number field is used for G-PDUs (T-PDUs+headers), an increasing sequence number for T-PDUs is transmitted via GTP-U tunnels, when transmission order must be preserved. For + +Supported Extension Headers Notification and Error Indication messages, the Sequence Number shall be ignored by the receiver, even though the S flag is set to '1'. + +- N-PDU Number: This field is used at the Inter SGSN Routeing Area Update procedure and some inter-system handover procedures (e.g. between 2G and 3G radio access networks). This field is used to co-ordinate the data transmission for acknowledged mode of communication between the MS and the SGSN. The exact meaning of this field depends upon the scenario. (For example, for GSM/GPRS to GSM/GPRS, the SNDCP N-PDU number is present in this field). +- Next Extension Header Type: This field defines the type of Extension Header that follows this field in the GTP-PDU. + +| Octets | Bits | | | | | | | | | | +|--------|----------------------------------------------------------|---|----|---|-----|---|---|----|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 | Version | | PT | | (*) | E | S | PN | | | +| 2 | Message Type | | | | | | | | | | +| 3 | Length (1 st Octet) | | | | | | | | | | +| 4 | Length (2 nd Octet) | | | | | | | | | | +| 5 | Tunnel Endpoint Identifier (1 st Octet) | | | | | | | | | | +| 6 | Tunnel Endpoint Identifier (2 nd Octet) | | | | | | | | | | +| 7 | Tunnel Endpoint Identifier (3 rd Octet) | | | | | | | | | | +| 8 | Tunnel Endpoint Identifier (4 th Octet) | | | | | | | | | | +| 9 | Sequence Number (1 st Octet) 1) 4) | | | | | | | | | | +| 10 | Sequence Number (2 nd Octet) 1) 4) | | | | | | | | | | +| 11 | N-PDU Number 2) 4) | | | | | | | | | | +| 12 | Next Extension Header Type 3) 4) | | | | | | | | | | + +NOTE 0: (\*) This bit is a spare bit. It shall be sent as '0'. The receiver shall not evaluate this bit. + +NOTE 1: 1) This field shall only be evaluated when indicated by the S flag set to 1. + +NOTE 2: 2) This field shall only be evaluated when indicated by the PN flag set to 1. + +NOTE 3: 3) This field shall only be evaluated when indicated by the E flag set to 1. + +NOTE 4: 4) This field shall be present if and only if any one or more of the S, PN and E flags are set. + +Figure 5.1-1: Outline of the GTP-U Header + +## 5.2 GTP-U Extension Header + +### 5.2.1 General format of the GTP-U Extension Header + +The format of GTP-U Extension Headers is depicted in figure 5.2.1-1. The Extension Header Length field specifies the length of the particular Extension header in 4 octets units. The Next Extension Header Type field specifies the type of any Extension Header that may follow a particular Extension Header. If no such Header follows, then the value of the Next Extension Header Type shall be 0. + +| | | | +|--------|-------|----------------------------| +| Octets | 1 | Extension Header Length | +| | 2 – m | Extension Header Content | +| | m+1 | Next Extension Header Type | + +Figure 5.2.1-1: Outline of the Extension Header Format + +The length of the Extension header shall be defined in a variable length of 4 octets, i.e. $m+1 = n*4$ octets, where n is a positive integer. + +Bits 7 and 8 of the Next Extension Header Type define how the recipient shall handle unknown Extension Types, see Figure 5.2.1-2. The recipient of an extension header of unknown type but marked as 'comprehension not required' for that recipient shall read the 'Next Extension Header Type' field (using the Extension Header Length field to identify its location in the GTP-PDU). + +The recipient of an extension header of unknown type, but marked as 'comprehension required' for that recipient, shall: + +- If the message with the unknown extension header was a request or a G-PDU, send a Supported Extension Headers Notification to the originator of the GTP-PDU, discard the message and log an error. + +Bits 7 and 8 of the Next Extension Header Type have the following meaning: + +| Bits | | Meaning | +|------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 8 | 7 | | +| 0 | 0 | Comprehension of this extension header is not required. An Intermediate Node shall forward it to any Receiver Endpoint | +| 0 | 1 | Comprehension of this extension header is not required. An Intermediate Node shall discard the Extension Header Content and not forward it to any Receiver Endpoint. Other extension headers shall be treated independently of this extension header. | +| 1 | 0 | Comprehension of this extension header is required by the Endpoint Receiver but not by an Intermediate Node. An Intermediate Node shall forward the whole field to the Endpoint Receiver. | +| 1 | 1 | Comprehension of this header type is required by recipient (either Endpoint Receiver or Intermediate Node) | + +**Figure 5.2.1-2: Definition of bits 7 and 8 of the Extension Header Type** + +An Endpoint Receiver is the ultimate receiver of the GTP-PDU (e.g. an RNC or the GGSN for the GTP-U plane). An Intermediate Node is a node that handles GTP but is not the ultimate endpoint (e.g. an SGSN for the GTP-U plane traffic between GGSN and RNC). + +| Next Extension Header Field Value | Type of Extension Header | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| +| 0000 0000 | No more extension headers | +| 0000 0001 | Reserved - Control Plane only. | +| 0000 0010 | Reserved - Control Plane only. | +| 0000 0011 | Long PDCP PDU Number. See NOTE 2. | +| 0010 0000 | Service Class Indicator | +| 0100 0000 | UDP Port. Provides the UDP Source Port of the triggering message. | +| 1000 0001 | RAN Container | +| 1000 0010 | Long PDCP PDU Number. See NOTE 3. | +| 1000 0011 | Xw RAN Container | +| 1000 0100 | NR RAN Container | +| 1000 0101 | PDU Session Container. See NOTE 4. | +| 1100 0000 | PDCP PDU Number [4]-[5]. See NOTE 1. | +| 1100 0001 | Reserved - Control Plane only. | +| 1100 0010 | Reserved - Control Plane only. | +| NOTE 1: As an exception to the comprehension rule specified above, for a G-PDU with a Next Extension Header Field set to the value "1100 0000", the SGW shall consider this corresponding extension header as 'comprehension not required'. | | +| NOTE 2: This value shall be used by a source eNB or gNB complying with this release of the specification. | | +| NOTE 3: This value shall not be used by a source eNB or gNB complying with this release of the specification. It may be received from a source eNB complying with an earlier release of the specification, i.e. not supporting the extension header value "0000 0011". | | +| NOTE 4: For a GTP-PDU with several Extension Headers, the PDU Session Container should be the first Extension Header. | | + +**Figure 5.2.1-3: Definition of Extension Header Type** + +### 5.2.2 Extension Header types + +Extension header types marked as "Reserved – Control Plane only" in figure 5.2.1-3 are not used in the GTP user plane. These extension header types are defined in 3GPP TS 29.060 [6]. + +The following clauses define the format of the extension header types applicable to the GTP user plane. + +#### 5.2.2.1 UDP Port + +This extension header may be transmitted in Error Indication messages to provide the UDP Source Port of the G-PDU that triggered the Error Indication. It is 4 octets long, and therefore the Length field has value 1. + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0x01 | | | | | | | | +| 2-3 | UDP Port number | | | | | | | | +| 4 | Next Extension Header Type (note) | | | | | | | | + +NOTE: The value of this field is 0 if no other Extension header follows. + +**Figure 5.2.2.1-1: UDP Port Extension Header** + +#### 5.2.2.2 PDCP PDU Number + +This extension header is transmitted, for example in UTRAN, at SRNS relocation time, to provide the PDCP sequence number of not yet acknowledged N-PDUs. It is 4 octets long, and therefore the Length field has value 1. + +When used during a handover procedure between two eNBs at the X2 interface (direct DL data forwarding) or via the S1 interface (indirect DL data forwarding) in E-UTRAN, bit 8 of octet 2 is spare and shall be set to zero. + +When used during a handover procedure between two NG-RANs at the Xn interface (direct DL data forwarding) or via the N3 interface (indirect DL data forwarding), bits 5-8 of octet 2 are spare and shall be set to zero. + +NOTE 1: The PDCP PDU number field of the PDCP PDU number extension header has a maximum value which requires 15 bits (see 3GPP TS 36.323 [24]); thus, bit 8 of octet 2 is spare. + +NOTE 2: The PDCP PDU number field of the PDCP PDU number extension header has a maximum value which requires 12 bits (see 3GPP TS 38.323 [35]); thus, bit 5-8 of octet 2 are spare. + +| Octets | Bits | | | | | | | | +|--------|-------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0x01 | | | | | | | | +| 2 | PDCP PDU number | | | | | | | | +| 3 | PDCP PDU number. | | | | | | | | +| 4 | Next Extension Header Type (Note 3) | | | | | | | | + +NOTE 3: The value of this field is 0 if no other Extension header follows. + +**Figure 5.2.2.2-1: PDCP PDU Number Extension Header** + +#### 5.2.2.2A Long PDCP PDU Number + +This extension header is used for direct X2 or indirect S1 DL data forwarding during a Handover procedure between two eNBs. This extension header is also used for direct Xn or indirect N3 DL data forwarding during a Handover procedure between two NG-RANs. The Long PDCP PDU number extension header is 8 octets long, and therefore the Length field has value 2. + +The PDCP PDU number field of the Long PDCP PDU number extension header has a maximum value which requires 18 bits (see 3GPP TS 36.323 [24] and 3GPP TS 38.323 [35]). Bit 2 of octet 2 is the most significant bit and bit 1 of octet 4 is the least significant bit, see Figure 5.2.2.2A-1. Bits 8 to 3 of octet 2, and Bits 8 to 1 of octets 5 to 7 shall be set to 0. + +NOTE: A G-PDU which includes a PDCP PDU Number contains either the extension header PDCP PDU Number or Long PDCP PDU Number. + +| Octets | Bits | | | | | | | | | | +|--------|-------------------------------------|---|---|---|---|---|-----------------|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 | 0x02 | | | | | | | | | | +| 2 | Spare | | | | | | PDCP PDU number | | | | +| 3 | PDCP PDU number | | | | | | | | | | +| 4 | PDCP PDU number | | | | | | | | | | +| 5 | Spare | | | | | | | | | | +| 6 | Spare | | | | | | | | | | +| 7 | Spare | | | | | | | | | | +| 8 | Next Extension Header Type (Note 1) | | | | | | | | | | + +NOTE 1: The value of this field is 0 if no other Extension header follows. + +**Figure 5.2.2.2A-1: Long PDCP PDU Number Extension Header** + +#### 5.2.2.3 Service Class Indicator + +This extension header identifies the service class indicator (SCI) associated with the T-PDU carried by the downlink G-PDU. This information may be used by the A/Gb mode GERAN access for improved radio utilisation (see clause 5.3.5.3 of 3GPP TS 23.060 [4]). + +In this version of the specification, this extension header may be transmitted over the Gn/Gp, S5/S8 and S4 interface. An eNodeB, RNC or MME shall ignore this information if received over the S1-U, S12, Iu, S11-U or any other interfaces not defined above, but still shall handle the G-PDU. + +NOTE1: This extension header is also sent over the S1-U, S12, Iu interface and S11-U if the SGW receives the Service Class Indicator from S5/S8 for a UE having a user plane connection with an RNC or an eNodeB. This can happen when the PGW does not have an accurate knowledge of the current RAT of the user e.g. after a handover from GERAN to (E)UTRAN. + +It is 4 octets long and therefore the Length field has the value 1. + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0x01 | | | | | | | | +| 2 | Service Class Indicator | | | | | | | | +| 3 | Spare | | | | | | | | +| 4 | Next Extension Header Type (note) | | | | | | | | + +NOTE: The value of this field is 0 if no other Extension header follows. + +**Figure 5.2.2.3-1: Service Class Indicator Extension Header** + +If the bit 8 of octet 2 is set to 0, this indicates an operator specific Service Class Indicator value is included. Otherwise, it shall indicate that a standardised SCI is included. + +NOTE 2: No standardized SCI value is defined in this release, it is intended to standardize SCIs in a future release. + +Bits 8 to 1 of the octet 2 represent the binary coded value of the SCI, applications with similar Radio Resource Management treatment in GERAN shall be represented by the same value. + +The octet 2 is coded as shown in Table 5.2.2.3-1. + +Bits 8 to 1 of the octet 3 are spare bits and shall be set to zero. + +**Table 5.2.2.3-1: Service Class Indicator** + +| | | +|----------------------------------------|------------------------| +| Service Class Indicator (SCI), octet 2 | | +| Bit | | +| 8 | | +| 0 | Operator-specific SCI | +| Bits | | +| 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 | | +| to | | +| 0 0 0 1 1 1 1 | Operator-specific SCIs | +| 0 0 1 0 0 0 0 | | +| to | | +| 1 1 1 1 1 1 1 | Spare for future use | +| Bit | | +| 8 | | +| 1 | Standardised SCI | +| Bits | | +| 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 | | +| to | | +| 1 1 1 1 1 1 1 | Spare for future use | + +#### 5.2.2.4 RAN Container + +This extension header may be transmitted in a G-PDU over the X2 user plane interface between the eNBs. The RAN Container has a variable length and its content is specified in 3GPP TS 36.425 [25]. A G-PDU message with this extension header may be sent without a T-PDU. + +| Octets | Bits | | | | | | | | +|-----------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0xn | | | | | | | | +| 2-(4n -1) | RAN Container | | | | | | | | +| 4n | Next Extension Header Type (NOTE) | | | | | | | | + +NOTE: The value of this field is '0' if no other Extension header follows. + +**Figure 5.2.2.4-1: RAN Container Extension Header** + +#### 5.2.2.5 Xw RAN Container + +This extension header may be transmitted in a G-PDU over the Xw user plane interface between the eNB and the WLAN Termination (WT). The Xw RAN Container has a variable length and its content is specified in 3GPP TS 36.465 [27]. A G-PDU message with this extension header may be sent without a T-PDU. + +| Octets | Bits | | | | | | | | +|-----------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0xn | | | | | | | | +| 2-(4n -1) | Xw RAN Container | | | | | | | | +| 4n | Next Extension Header Type (NOTE) | | | | | | | | + +NOTE: The value of this field is '0' if no other Extension header follows. + +**Figure 5.2.2.5-1: Xw RAN Container Extension Header** + +#### 5.2.2.6 NR RAN Container + +This extension header may be transmitted in a G-PDU over the X2-U, Xn-U and F1-U user plane interfaces, within NG-RAN and, for EN-DC, within E-UTRAN. The NR RAN Container has a variable length and its content is specified in 3GPP TS 38.425 [30]. A G-PDU message with this extension header may be sent without a T-PDU. + +| Octets | Bits | | | | | | | | +|-----------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0xn | | | | | | | | +| 2-(4n -1) | NR RAN Container | | | | | | | | +| 4n | Next Extension Header Type (NOTE) | | | | | | | | + +NOTE: The value of this field is '0' if no other Extension header follows. + +**Figure 5.2.2.6-1: NR RAN Container Extension Header** + +#### 5.2.2.7 PDU Session Container + +This extension header shall be transmitted in: + +- G-PDUs over the N3 and N9 user plane interfaces, between NG-RAN and UPF, or between two UPFs; +- G-PDUs over the N3mb and N19mb user plane interfaces, between the MB-UPF and NG-RAN, or between the MB-UPF and UPF; and +- in End Marker packets over data forwarding tunnels in 5GS, for data forwarding between 5GS and EPS. + +The PDU Session Container has a variable length and its content is specified in 3GPP TS 38.415 [31]. + +A G-PDU message with this extension header may be sent without a T-PDU, e.g. when the G-PDU message is used as a dummy GTP-U packet for QoS Monitoring per QoS flow as specified in clause 5.33.3.2 of 3GPP TS 23.501 [28], where the PDU Session Container contains QoS Monitoring related parameters. An Intermediate UPF between the PSA UPF and the NG-RAN shall forward any received such G-PDU messages together with the GTP-U PDU Session Container extension header to the next GTP-U entity. + +| Octets | Bits | | | | | | | | +|-----------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0xn | | | | | | | | +| 2-(4n -1) | PDU Session Container | | | | | | | | +| 4n | Next Extension Header Type (NOTE) | | | | | | | | + +NOTE: The value of this field is '0' if no other Extension header follows. + +Figure 5.2.2.7-1: PDU Session Container Extension Header + +# 6 GTP-U Message Formats + +## 6.1 General + +GTP-U defines a set of messages between the two ends of the user plane of the interfaces Iu, Gn, Gp, S1-U, S11-U, S2a, S2b, S4, S5, S8, S12, X2, M1, Sn, Xn, N3, N9 and N19. + +GTP-U messages are sent across a GTP user plane tunnel. A GTP-U message may be either a signalling message across the user plane tunnel, or a G-PDU message. + +- GTP-U signalling messages are used for user plane path management, or for user plane tunnel management. +- G-PDU is a vanilla user plane message, which carries the original packet (T-PDU). In G-PDU message, GTP-U header is followed by a T-PDU. + +A T-PDU is an original packet, for example an IP datagram, Ethernet frame or unstructured PDU Data, from an UE, or from a network node in an external packet data network. + +The complete range of message types defined for GTPv1 is defined in 3GPP TS 29.060 [6]. The table below includes those applicable to GTP user plane. The three columns to the right define which of the three protocols sharing the common header of GTPv1 (GTP-C, GTP-U or GTP') might implement the specific message type. + +Table 6.1-1: Messages in GTP-U + +| Message Type value (Decimal) | Message | Reference | GTP-C | GTP-U | GTP' | +|------------------------------|-------------------------------------------------------|-----------|-------|-------|------| +| 1 | Echo Request | | X | X | x | +| 2 | Echo Response | | X | X | x | +| 3-25 | Reserved in 3GPP TS 32.295 [8] and 3GPP TS 29.060 [6] | | | | | +| 26 | Error Indication | | | X | | +| 27-30 | Reserved in 3GPP TS 29.060 [6] | | | | | +| 31 | Supported Extension Headers Notification | | X | X | | +| 32-252 | Reserved in 3GPP TS 29.060 [6] | | | | | +| 253 | Tunnel Status | | | X | | +| 254 | End Marker | | | X | | +| 255 | G-PDU | | | X | | + +## 6.2 Presence requirements of Information Elements + +As specified in 3GPP TS 29.060 [6], clause 7.1.1. + +# 7 GTP-U Messages + +## 7.1 General + +GTP-U Tunnels are used to carry encapsulated T-PDUs and signalling messages between a given pair of GTP-U Tunnel Endpoints. The Tunnel Endpoint ID (TEID) which is present in the GTP header shall indicate which tunnel a particular T-PDU belongs to. In this manner, packets are multiplexed and de-multiplexed by GTP-U between a given pair of Tunnel Endpoints. The TEID value to be used in the TEID field shall be negotiated for instance during the GTP-C Create PDP Context and the RAB assignment procedures that take place on the control plane. + +For IP Multicast Distribution of User Plane Data for MBMS and MBS: + +- the TEID value to be used in the TEID field shall be allocated at the source Tunnel Endpoint and signalled to the destination Tunnel Endpoint as specified in clause 4.2.6; +- because of the point-to-multipoint characteristics of IP Multicast Distribution, the path management messages Echo Request and Echo Response, the tunnel management message Error Indication, the message Supported Extension Headers Notification and the message End Marker shall not be used. + +User payload is transmitted in G-PDU packets. A G-PDU is a packet including a GTP-U header and a T-PDU. A G-PDU may include extension headers. A G-PDU shall not include any information element. + +GTP-U signalling messages are classified into path management messages, defined in clause 7.2 of the present document, and tunnel management messages, defined in clause 7.3 of the present document. + +## 7.2 Path Management Messages + +### 7.2.1 Echo Request + +A GTP-U peer may send an Echo Request on a path to the other GTP-U peer to find out if it is alive (see clause Path Failure). Echo Request messages may be sent for each path in use. A path is considered to be in use if at least one PDP context, EPS Bearer, PDU Session, MBMS UE context, or MBMS bearer context uses the path to the other GTP-U peer. When and how often an Echo Request message may be sent is implementation specific but an Echo Request shall not be sent more often than every 60 s on each path. This doesn't prevent resending an Echo Request with the same sequence number according to the T3-RESPONSE timer. + +Even if there is no path in use, a GTP-U peer shall be prepared to receive an Echo Request at any time and it shall reply with an Echo Response. The optional Private Extension contains vendor or operator specific information. + +Handling of the Recovery Time Stamp is specified in 3GPP TS 23.007 [3] and 3GPP TS 23.527 [33]. + +**Table 7.2.1-1: Information Elements in an Echo Request** + +| Information element | Presence requirement | Reference | +|---------------------|----------------------|-----------| +| Recovery Time Stamp | Optional | 8.7 | +| Private Extension | Optional | 8.6 | + +For the GTP-U tunnel setup between two nodes for forwarding user traffic, e.g. between eNodeBs for direct forwarding over X2, Echo Request path maintenance message shall not be sent except if the forwarded data and the normal data are sent over the same path. + +### 7.2.2 Echo Response + +The message shall be sent as a response to a received Echo Request. + +The Restart Counter value in the Recovery information element shall not be used, i.e. it shall be set to zero by the sender and shall be ignored by the receiver. The Recovery information element is mandatory due to backwards compatibility reasons. + +Handling of the Recovery Time Stamp is specified in 3GPP TS 23.007 [3] and 3GPP TS 23.527 [33]. The optional Private Extension contains vendor or operator specific information. + +**Table 7.2.2-1: Information Elements in an Echo Response** + +| Information element | Presence requirement | Reference | +|---------------------|----------------------|-----------| +| Recovery | Mandatory | 8.2 | +| Recovery Time Stamp | Optional | 8.7 | +| Private Extension | Optional | 8.6 | + +### 7.2.3 Supported Extension Headers Notification + +This message indicates a list of supported Extension Headers that the GTP entity on the identified IP address can support. This message is sent only in case a GTP entity was required to interpret a mandatory Extension Header but the GTP entity was not yet upgraded to support that extension header. The GTP endpoint sending this message is marked as not enabled to support some extension headers (as derived from the supported extension header list). The peer GTP entity may retry to use all the extension headers with that node, in an attempt to verify it has been upgraded. Implementers should avoid repeated attempts to use unknown extension headers with an endpoint that has signalled its inability to interpret them. + +**Table 7.2.3-1: Information Elements in Supported Extension Headers Notification** + +| Information element | Presence requirement | Reference | +|----------------------------|----------------------|-----------| +| Extension Header Type List | Mandatory | 8.5 | + +## 7.3 Tunnel Management Messages + +### 7.3.1 Error Indication + +When a GTP-U node receives a G-PDU for which no EPS Bearer context, PDP context, PDU Session, MBMS Bearer context, or RAB exists, the GTP-U node shall discard the G-PDU. If the TEID of the incoming G-PDU is different from the value 'all zeros' the GTP-U node shall also return a GTP error indication to the originating node. GTP entities may include the "UDP Port" extension header (Type 0x40), in order to simplify the implementation of mechanisms that can mitigate the risk of Denial-of-Service attacks in some scenarios. + +Handling of the received Error Indication and the Recovery Time Stamp is specified in 3GPP TS 23.007 [3] and 3GPP TS 23.527 [33]. + +The information element Tunnel Endpoint Identifier Data I shall be the TEID fetched from the G-PDU that triggered this procedure. + +The information element GTP-U Peer Address shall be the destination address (e.g. destination IP address, MBMS Bearer Context) fetched from the original user data message that triggered this procedure. A GTP-U Peer Address can be a GGSN, SGSN, RNC, PGW, SGW, ePDG, eNodeB, TWAN, MME, gNB, N3IWF, or UPF address. The TEID and GTP-U peer Address together uniquely identify the related PDP context, RAB, PDU session or EPS bearer in the receiving node. + +The optional Private Extension contains vendor or operator specific information. + +**Table 7.3.1-1: Information Elements in an Error Indication** + +| Information element | Presence requirement | Reference | +|-----------------------------------|----------------------|-----------| +| Tunnel Endpoint Identifier Data I | Mandatory | 8.3 | +| GTP-U Peer Address | Mandatory | 8.4 | +| Recovery Time Stamp | Optional | 8.7 | +| Private Extension | Optional | 8.6 | + +### 7.3.2 End Marker + +#### 7.3.2.1 General + +The End Marker message indicates the end of the payload stream on a given tunnel, i.e. a G-PDU that arrives after an End Marker message on this tunnel may be silently discarded. Table 7.3.2.1-1 specifies the information element included in the End Marker message. + +If an End Marker message is received with a TEID for which there is no context, then the receiver shall ignore this message. + +The optional Private Extension contains vendor or operator specific information. + +**Table 7.3.2.1-1: Information Elements in End Marker message** + +| Information element | Presence requirement | Reference | +|---------------------|----------------------|-----------| +| Private Extension | Optional | 8.6 | + +#### 7.3.2.2 End Marker in EPS + +The End Marker message(s) shall be sent after sending the last G-PDU that needs to be sent on a GTP-U tunnel as specified in 3GPP TS 23.401 [5] or after receiving an End Marker Indication as specified in clause 5.7.1 of 3GPP TS 23.402 [23]. + +The End Marker message(s) shall be sent for each GTP-U tunnel, except for the case of an E-UTRAN Initiated E-RAB modification procedure. During an E-UTRAN Initiated E-RAB modification procedure, the SGW shall send End marker message(s) to the eNodeB on the old S1-U tunnel for the tunnel(s) that are switched, i.e. if the S1 eNodeB F-TEID of the GTP-U tunnel provided by the MME in a Modify Bearer Request or Modify Access Bearer Request is not the same as the one previously stored in the SGW. Each GTP-U tunnel is identified with a respective TEID value in the GTP-U header. + +An MME may receive End Marker packets over an S11-U tunnel during the following procedures: + +- Inter-MME TAU procedure; +- Establishment of S1-U bearer during Data Transport in Control Plane CIoT EPS optimisation. + +The MME shall discard the End Marker packets. The MME may also initiate the release of the corresponding S11-U resources; however the release of the S11-U resources is implementation dependent. + +#### 7.3.2.3 End Marker in 5GS + +The End Marker message(s) shall also be sent after sending the last G-PDU that needs to be sent on a GTP-U tunnel or after receiving an End Marker Indication as specified in 3GPP TS 23.501 [28] and 3GPP TS 23.502 [29]. End marker packets sent over data forward tunnels in 5GS, for data forwarding between 5GS and EPS, shall be sent with the PDU Session Container extension header including the Qos Flow Identifier of one of the QoS flows mapped to the same E-RAB. + +For QoS Flows transferred to and from Secondary RAN Node in Dual Connectivity (see clause 4.14.1 of 3GPP TS 23.502 [29]), end marker packets shall be sent over old tunnel for the transferred QoS flows without the Qos Flow Identifier included as specified in 3GPP TS 37.340 [38]. + +End Marker messages shall not be sent over the N19 interface. + +### 7.3.3 Tunnel Status + +The Tunnel Status message is optional. A GTP-U entity, if it supports the message, may send one or more Tunnel Status message to the peer GTP-U entity to provide the status information related to the corresponding GTP-U tunnel in the sending GTP-U entity. Table 7.3.2.1-1 specifies the information element included in the Tunnel Status message. + +If a Tunnel Status message is received with a TEID for which there is no context, or the message is not supported, then the receiver shall ignore this message. + +The optional Private Extension contains vendor or operator specific information. + +**Table 7.3.3-1: Information Elements in Tunnel Status message** + +| Information element | Presence requirement | Reference | +|---------------------------------|----------------------|-----------| +| GTP-U Tunnel Status Information | Mandatory | 8.7 | +| Private Extension | Optional | 8.6 | + +# 8 Information Elements + +## 8.1 Information Element Types + +A GTP-U Signalling message may contain several information elements. The TLV (Type, Length, Value) or TV (Type, Value) encoding format shall be used for the GTP information elements. The information elements shall be sorted, with the Type fields in ascending order, in the signalling messages. The Length field contains the length of the information element excluding the Type and Length field. + +For all the length fields, bit 8 of the lowest numbered octet is the most significant bit and bit 1 of the highest numbered octet is the least significant bit. + +Within information elements, certain fields may be described as spare. These bits shall be transmitted with the value defined for them. To allow for future features, the receiver shall not evaluate these bits. + +The most significant bit in the Type field is set to 0 when the TV format is used and set to 1 for the TLV format. + +![Diagram showing the Type field structure for TV and TLV formats. It consists of two octets. The top octet is for TV format, with bit 8 set to 0 and bits 7-1 labeled 'Type -> TV format'. The bottom octet is for TLV format, with bit 8 set to 1 and bits 7-1 labeled 'Type -> TLV format'.](15e4a144a88176b71ea3eff2722253b0_img.jpg) + +| | | Bits | | | | | | | | +|--------|--|------|-------------------|---|---|---|---|---|---| +| Octets | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | | 0 | Type -> TV format | | | | | | | + + + +| | | Bits | | | | | | | | +|--------|--|------|--------------------|---|---|---|---|---|---| +| Octets | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | | 1 | Type -> TLV format | | | | | | | + +Diagram showing the Type field structure for TV and TLV formats. It consists of two octets. The top octet is for TV format, with bit 8 set to 0 and bits 7-1 labeled 'Type -> TV format'. The bottom octet is for TLV format, with bit 8 set to 1 and bits 7-1 labeled 'Type -> TLV format'. + +Figure 8.1-1: Type field for TV and TLV format + +The complete range of information element types defined for GTPv1 is defined in 3GPP TS 29.060 [6]. The table below includes those applicable to GTP user plane. + +Table 8.1-1: Information Elements + +| IE Type Value | Format | Information Element | Reference | +|---------------|--------|-----------------------------------|-----------| +| 0-13 | TV | Reserved in 3GPP TS 29.060 [6] | | +| 14 | TV | Recovery | 8.2 | +| 15 | TV | Reserved in 3GPP TS 29.060 [6] | | +| 16 | TV | Tunnel Endpoint Identifier Data I | 8.3 | +| 17-132 | TV/TLV | Reserved in 3GPP TS 29.060 [6] | | +| 133 | TLV | GSN Address. See NOTE 1. | 8.4 | +| 134-140 | TLV | Reserved in 3GPP TS 29.060 [6] | | +| 141 | TLV | Extension Header Type List | 8.5 | +| 142-229 | TLV | Reserved in 3GPP TS 29.060 [6] | | +| 230 | TLV | GTP-U Tunnel Status Information | 8.7 | +| 231 | TLV | Recovery Time Stamp | 8.7 | +| 232-237 | TLV | Spare. For future use. | | +| 238-254 | TLV | Reserved in 3GPP TS 29.060 [6] | | +| 255 | TLV | Private Extension | 8.6 | + +NOTE 1: This IE is named as " GTP-U Peer Address" in the rest of this specification. + +## 8.2 Recovery + +The value of the restart counter shall be set to 0 by the sending entity and ignored by the receiving entity. This information element is used in GTP user plane due to backwards compatibility reasons. + +![](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 14 (Decimal) | | | | | | | | +| 2 | Restart counter | | | | | | | | + +Figure 8.2-1: Restart Counter Information Element + +## 8.3 Tunnel Endpoint Identifier Data I + +The Tunnel Endpoint Identifier Data I information element contains the Tunnel Endpoint Identifier used by a GTP entity for the user plane. + +![](805c475f0859e607af0530ba43194bf1_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 16 (Decimal) | | | | | | | | +| 2 - 5 | Tunnel Endpoint Identifier Data I | | | | | | | | + +Figure 8.3-1: Tunnel Endpoint Identifier Data I Information Element + +## 8.4 GTP-U Peer Address + +The GTP-U peer Address information element contains the address of a GTP. The Length field may have only two values (4 or 16) that determine if the Value field contains IPv4 or IPv6 address. + +The IPv4 address structure is defined in RFC 791 [10]. + +The IPv6 address structure is defined in RFC 4291 [11]. + +The encoded address might belong not only to a GSN, but also to an RNC, eNodeB, SGW, ePDG, gNB, N3IWF, UPF, PGW or TWAN. + +![](9a159e2112eac7be06bdb97e84a0c49a_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 133 (Decimal) | | | | | | | | +| 2-3 | Length | | | | | | | | +| 4-n | IPv4 or IPv6 Address | | | | | | | | + +Figure 8.4-1: GTP-U Peer Address Information Element + +## 8.5 Extension Header Type List + +This information element contains a list of 'n' Extension Header Types. The length field is set to the number of extension header types included. + +![](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 141 (Decimal) | | | | | | | | +| 2 | Length (value= n) | | | | | | | | +| 3-n+2 | Extension types list | | | | | | | | + +Figure 8.5-1: Extension Header Type List Information Element + +## 8.6 Private Extension + +The Private Extension information element contains vendor specific information. The Extension Identifier is a value defined in the Private Enterprise number list in the most recent "Assigned Numbers" RFC (RFC 1700 or later). + +This is an optional information element that may be included in any GTP Signalling message. A signalling message may include more than one information element of the Private Extension type. + +![](f2ea0f64a770b22b902820457d262265_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 255 (Decimal) | | | | | | | | +| 2-3 | Length | | | | | | | | +| 4-5 | Extension Identifier | | | | | | | | +| 6-m | Extension Value | | | | | | | | + +Figure 8.6-1: Private Extension Information Element + +## 8.7 GTP-U Tunnel Status Information + +The GTP-U Tunnel Status Information contains the status information related to the corresponding GTP-U tunnel in the sending GTP-U entity. + +![](68d8089266ace7197304b43dcaf5d08e_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 230 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | SPOC | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.7-1: GTP-U Tunnel Status Information + +The octet 5 shall be encoded as follows: + +- Bit 1 – SPOC (Start Pause Of Charging): when set to "1", this indicates a request to the receiving GTP-U entity to stop usage measurement for the URR(s) with the Applicable for Start of Pause of Charging Flag set to "1" as specified in 3GPP TS 29.244 [39] for the PFCP session (identified by the IP address and TEID of the header of the Tunnel Status message). The GTP-U entity shall forward Tunnel Status message to the upstream GTP-U entity if it is not a PSA UPF or PGW-U connecting to N6/SGi interface. +- Bit 2 to 8 – Spare, for future use and set to "0". + +## 8.7 Recovery Time Stamp + +The Recovery Time Stamp IE is coded as shown in Figure 8.7-1. It indicates the UTC time when the GTP-U entity started. Octets 4 to 7 are encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [41]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = aa (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 to 7 | Recovery Time Stamp value | | | | | | | | +| 8 to (n+3) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.7-1: Recovery Time Stamp + +# 9 Error Handling + +## 9.1 Protocol Errors + +As specified in 3GPP TS 29.060 [6], clauses 11.1. + +## 9.2 Path Failure + +Path failure handling procedures are specified in 3GPP TS 23.007 [17] and 3GPP TS 23.527 [33]. + +# 10 Security + +Network domain security is specified in 3GPP TS 33.102 [21] and 3GPP TS 33.401 [22]. + +# 11 Reliable Delivery of Signalling Messages + +Each path maintains a queue with signalling messages to be sent to the peer. The message at the front of the queue, if it is a request for which a response has been defined, shall be sent with a Sequence Number, and shall be held in a path list until a response is received. Each path has its own list. The Sequence Number shall be unique for each outstanding request message sourced from the same IP/UDP endpoint. + +The T3-RESPONSE timer shall be started when a signalling request message (for which a response has been defined) is sent. A signalling message request or response has probably been lost if a response has not been received before the T3-RESPONSE timer expires. At the expiry of the timer the request is retransmitted if the total number of request attempts is less than N3-REQUESTS times. + +All received request messages shall be responded to and all response messages associated with a certain request shall always include the same information. Duplicated response messages shall be discarded. A response message without a matching outstanding request should be considered as a duplicate. + +If a GTP protocol entity is not successful with the transfer of a signalling message, it shall inform the upper layer of the unsuccessful transfer so that the controlling upper entity may take the necessary measures. + +# --- 12 GTP Parameters + +## 12.1 General + +The GTP system parameters defined here and their recommended values shall not be fixed, but shall be possible to configure as described in clause 'Reliable delivery of messages'. + +## 12.2 Timers + +The timer T3-RESPONSE holds the maximum wait time for a response of a request message. + +## 12.3 Others + +The counter N3-REQUESTS holds the maximum number of attempts made by GTP to send a request message. The recommended value is 5. + +# --- 13 Tunnelling Scenarios + +## 13.1 General + +There are user packets sent between network nodes without a GTP-U reference point defined. The scenarios and applicability of GTP-U tunnelling are described in the following clauses. + +## 13.2 Tunnelling between SGWs + +GTP T-PDU tunnelling is applicable from the old SGW to the new S GW only when indirect forwarding is applicable during a S1-based Handover procedure or inter-RAT handover procedure with SGW Relocation, as described in the 3GPP TS 23.401 [5]. For the GTP-U tunnel setup between SGWs, path maintenance messages do not need to be sent. + +GTP T-PDU tunnelling is applicable from the old SGW to the forwarding SGW during a TAU/RAU with SGW change procedure when indirect data forwarding is used to forward DL data buffered in the old SGW to the UE via the forwarding SGW, as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.3 Transfer of the user plane data between PDN GWs + +GTP shall not specify tunnelling between PDN GWs. Transfer of UE-to-UE traffic between PDN GWs shall use the SGi interface. + +## 13.4 Tunnelling between SGSNs + +T-PDUs, stored in the old SGSN and not yet sent to the MS, shall be tunnelled to the new SGSN as a part of the Inter SGSN Routeing Update procedure described in 3GPP TS 23.060 [4]. Some T-PDUs may still be on their way from the GGSN/PGW to the old SGSN because they have been sent before the tunnel change. These T-PDUs shall also be tunnelled to the new SGSN. + +For intersystem SRNS Relocation, the establishment of the GTP tunnel(s) for the forwarding of G-PDUs is as described in the 3GPP TS 23.121 [13] and in the 3GPP TS 23.060 [4] specifications. + +For PS Handover, the establishment of the GTP tunnel(s) for the forwarding of G-PDUs is as described in the 3GPP TS 43.129 [14]. + +The GTP T-PDU tunnelling between SGSNs is applicable also for RAU interaction with a Gn/Gp SGSN when forwarding DL data buffered in the old Gn/Gp SGSN to the UE, via the new SGSN (e.g. when direct tunnel is not established) as described in the 3GPP TS 23.060 [4]. + +## 13.5 Tunnelling between Source RNC and Target RNC + +For the 3G-3G SRNS Relocation, the establishment of the GTP tunnel for the forwarding of G-PDUs between source and target RNC, is as described in the 3GPP TS 23.121 [13] and in the 3GPP TS 23.060 [4] specifications. + +## 13.6 Transfer of the user plane data between GGSNs + +GTP shall not specify tunnelling between GGSNs. Transfer of MS-to-MS traffic between GGSNs shall use the Gi interface. + +## 13.7 Tunnelling between RNC and eNodeB + +GTP T-PDU tunnelling is applicable between RNC and eNodeB during an inter-RAT handover between E-UTRAN and UTRAN Iu mode procedure as described in the 3GPP TS 23.401 [5]. + +## 13.8 Tunnelling between SGSN and eNodeB + +GTP T-PDU tunnelling is applicable between SGSN and eNodeB during an inter-RAT handover between E-UTRAN and GERAN A/Gb mode/UTRAN Iu mode procedure as described in the 3GPP TS 23.401 [5]. + +GTP T-PDU tunnelling between SGSN and eNodeB is applicable also for a TAU interaction with a Gn/Gp SGSN when forwarding DL data buffered in the old Gn/Gp SGSN to the UE via the target eNodeB, if such forwarding is supported by the eNodeB as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.9 Tunnelling between Source eNodeB and Target eNodeB + +GTP T-PDU tunnelling is applicable between eNodeBs during an X2-based handover and E-UTRAN initiated E-RAB modification procedure as described in the 3GPP TS 23.401 [5]. + +## 13.10 Tunnelling between SGSN and RNC + +GTP T-PDU tunnelling between SGSN and RNC is applicable also for a TAU interaction with a Gn/Gp SGSN when forwarding DL data buffered in the old Gn/Gp SGSN to the UE, via the new RNC (e.g. when direct tunnel is established), if such forwarding is supported by the RNC as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.11 Tunnelling between SGSN and SGW + +GTP T-PDU tunnelling is applicable from the old Gn/Gp SGSN to the forwarding SGW during a TAU/RAU interaction with a Gn/Gp SGSN when indirect data forwarding is used to forward DL data buffered in the old Gn/Gp SGSN to the UE via the forwarding SGW, as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.12 Tunnelling between SGW and eNodeB + +GTP T-PDU tunnelling between SGW and eNodeB is applicable also for a TAU with SGW change procedure when forwarding DL data buffered in the old SGW to the UE via the target eNodeB, if such forwarding is supported by the eNodeB as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.13 Tunnelling between SGW and RNC + +GTP T-PDU tunnelling between SGW and RNC is applicable also for a RAU with SGW change procedure when forwarding DL data buffered in the old SGW to the UE via the new RNC when Direct Tunnel is used at the target side, if such forwarding is supported by the RNC as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.14 Tunnelling between SGW and SGSN + +GTP T-PDU tunnelling between SGW and SGSN is applicable also for a RAU with SGW change procedure when forwarding DL data buffered in the old SGW to the UE via the new SGSN when Direct Tunnel is not used at the target side as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +# Annex A (Normative): PDU session user plane protocol over N9, N3mb and N19mb + +The PDU session user plane protocol shall be supported over the N9, N3mb and N19mb interface as specified in 3GPP TS 38.415 [31]. + +# Annex B (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|-------------------------------------------------------------------|--------| +| 2008-12 | CT#42 | CP-080716 | | | | V2.0.0 approved in CT#42 | 8.0.0 | +| 2009-03 | CT#43 | CP-090048 | 0001 | 1 | | Correction on GTP-U path failure | 8.1.0 | +| | | | 0002 | | | UDP Port Extension Header | | +| | | | 0003 | 1 | | Correction to IP support | | +| | | | 0006 | | | Handling of End Marker packet | | +| 2009-06 | CT#44 | CP-090481 | 0007 | 3 | | GTP-U tunnelling over X2 | 8.2.0 | +| | | | 0008 | 2 | | GTP-U updates for MBMS HSPA Evolution | | +| 2009-09 | CT#45 | CP-090539 | 0010 | 1 | | Forwarding Tunnel Error Indication handling | 8.3.0 | +| | | | 0011 | 1 | | Clarification on the usage of Echo Request | | +| | | | 0012 | 2 | | Clarification to the Sequence Number usage in EPC | | +| | | | 0014 | 3 | | Updating the Error Indication clause | | +| | | | 0016 | | | Eliminating Editor's Notes | | +| | | | 0018 | 1 | | Path Failure text correction | | +| | | | 0019 | 1 | | Support of NDS/IP for LTE | | +| 2009-09 | CT#45 | CP-090559 | 0013 | 1 | | MBMS for EPS support in GTPv1-U | 9.0.0 | +| 2009-12 | CT#46 | CP-090773 | 0023 | 2 | | End Marker in S1 based handover and Inter RAT handover procedures | 9.1.0 | +| | | | 0025 | | | GTP-U sequence number handling | | +| 2010-03 | CT#47 | CP-100023 | 0027 | 1 | | Sequence Number corrections | 9.2.0 | +| 2010-06 | CT#48 | CP-100287 | 0028 | 1 | | Message applicability of MBMS in GTP-U | 9.3.0 | +| 2010-12 | CT#50 | CP-100686 | 0031 | 1 | | Addition of GTP-U interface over S2b | 10.0.0 | +| | | | 0033 | 2 | | End Marker message | | +| | | | 0035 | 1 | | Echo Request & Echo Response | | +| 2011-03 | CT#51 | CP-110258 | 0037 | 2 | | TEID value 0 for GTP-U tunnel | 10.1.0 | +| | | | 0038 | 3 | | GTP-U protocol missing information | | +| | | | 0039 | | | Scope of GTPv1 | | +| 2011-06 | CT#52 | CP-110374 | 0040 | | | eNB Error Indication Handling | 10.2.0 | +| | | | 0042 | 1 | | Addition of the MBMS reference points | | +| 2011-09 | CT#53 | CP-110567 | 0044 | | | User plane path failure handling | 10.3.0 | +| 2011-09 | CT#53 | CP-110580 | 0043 | | | Default inner MTU size | 11.0.0 | +| | | CP-110577 | 0045 | 1 | | Correction to references | | +| 2011-12 | CT#54 | CP-110810 | 0046 | 1 | | Add the definition of C-TEID | 11.1.0 | +| | | | 0048 | 1 | | Dynamic allocation of UDP source ports | | +| | | | 0049 | | | Requirement for sending Error Indication | | +| 2012-03 | CT#55 | CP-120036 | 0050 | | | Tunnelling between eNodeB and RNC | 11.2.0 | +| | | CP-120036 | 0053 | 1 | | GTP-U header | | +| | | | 0052 | 1 | | Addition of GTP based S2a | | +| 2012-06 | CT#56 | | 0054 | | | Tunnelling Scenarios | 11.3.0 | +| 2012-09 | CT#57 | CP-120682 | 0059 | 6 | | New extension header in GTP-U for SIRIG | 11.4.0 | +| 2012-12 | CT#58 | CP-120751 | 0060 | 2 | | Length of PDCP PDU number | 11.5.0 | +| | | CP-120735 | 0061 | - | | Removal of editor's note in extension header in GTP-U for SIRIG | | +| 2013-03 | CT#59 | CP-130021 | 0062 | - | | Clarification on support of GTP-U over the S2a interface | 11.6.0 | +| 2014-09 | CT#65 | CP-140521 | 0064 | 2 | | Introduction of Dual Connectivity Function | 12.0.0 | +| | | | 0065 | - | | Correct the ambiguous GTP-U PDU | | +| 2014-12 | CT#66 | CP-140789 | 0067 | 1 | | Definition of RAN Container for flow control during X2UP handover | 12.1.0 | +| | | CP-140972 | 0068 | 1 | | End Marker used in PMIP-based S5/S8 case | | +| | | CP-140972 | 0069 | 2 | | Correct the GSN Address IE name | | +| 2015-09 | CT#69 | CP-150454 | 0071 | 2 | | Tunnelling scenarios for supporting High Latency communication | 13.0.0 | +| | | CP-150448 | 0072 | 3 | | G-PDU extension header handling | | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------|--------| +| 2016-03 | CT#71 | CP-160033 | 0074 | 1 | | S11-U tunneling for MO/MT data transport in control plane (SGi based) | 13.1.0 | +| | | CP-160033 | 0075 | 1 | | End Marker handling by MME | | +| | | CP-160038 | 0076 | 1 | | Comprehension requirement for PDCP PDU Number | | +| | | CP-160040 | 0077 | 2 | | 18 bits PDCP PDU Number | | +| 2016-06 | CT#72 | CP-160228 | 0078 | 1 | | Handling of End Marker packets over S11-U by MME | 13.2.0 | +| 2017-03 | CT#75 | CP-170032 | 0080 | 1 | | Support for transport level packet marking over GTP-U interfaces | 14.0.0 | +| 2017-06 | CT#76 | CP-171019 | 0082 | - | | Xw RAN Container for LTE-WLAN Aggregation (LWA) | 14.1.0 | +| 2017-09 | CT#77 | CP-172025 | 0083 | 1 | | GTP-U Extension Header Handling | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0084 | 1 | | Supports N3, N9 and Xn userplane interface | 15.1.0 | +| 2018-03 | CT#79 | CP-180026 | 0086 | 1 | | New GTP-U extension header for 5GS | 15.2.0 | +| 2018-03 | CT#79 | CP-180026 | 0087 | 1 | | Support End Marker in 5GS | 15.2.0 | +| 2018-03 | CT#79 | CP-180026 | 0089 | 1 | | New GTP-U Extension Header for the PDU Session Container | 15.2.0 | +| 2018-03 | CT#79 | CP-180023 | 0088 | 1 | | Unpredictability of GTP TEID for PGW GTP-U | 15.2.0 | +| 2018-06 | CT#80 | CP-181128 | 0092 | 1 | | Change of Comprehension for 'Long PDCP PDU Number' extension header | 15.3.0 | +| 2018-06 | CT#80 | CP-181132 | 0093 | 2 | | Fix the location of the PDU Session Container | 15.3.0 | +| 2018-06 | CT#80 | CP-181132 | 0095 | - | | User Plane Protocol over N9 | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0096 | 1 | | General 5G Corrections | 15.4.0 | +| 2018-09 | CT#81 | CP-182084 | 0097 | 2 | | GTP-U Tunnel Endpoint Description | 15.4.0 | +| 2018-09 | CT#81 | CP-182084 | 0099 | 1 | | DSCP Marking on IPv4 Outer Header based on 5QI/ARP | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0100 | 1 | | T-PDU content | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 0101 | - | | Referencing F1-U in the Introduction clause | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 0102 | - | | Data forwarding between 5GS and EPS | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 0103 | - | | Receiving packets from multiple remote GTP-U endpoints | 15.5.0 | +| 2019-09 | CT#85 | CP-192116 | 0104 | 1 | | Error Indication and Path Failure in 5GS | 15.6.0 | +| 2019-12 | CT#85 | CP-193024 | 0108 | 1 | | PDCP PDU Number | 15.7.0 | +| 2019-12 | CT#85 | CP-193041 | 0109 | - | | Implementing the conclusions of TR 29.892 for GTP-U | 16.0.0 | +| 2019-12 | CT#85 | CP-193050 | 0107 | - | | N19 user plane interface for 5G VN group communication | 16.0.0 | +| 2020-09 | CT#89e | CP-202099 | 0110 | 1 | | End marker in EPS and 5GS | 16.1.0 | +| 2021-03 | CT#91e | CP-210056 | 0114 | 1 | | End Marker in NG-RAN initiated QoS Flow mobility | 16.2.0 | +| 2021-03 | CT#91e | CP-210033 | 0111 | 1 | | Tunnel Status notifying Pause of Charging | 17.0.0 | +| 2021-09 | CT#93e | CP-212035 | 0115 | - | B | GTP-U tunneling for N3mb and N19mb | 17.1.0 | +| 2022-03 | CT#95e | CP-220037 | 0116 | 1 | B | Detecting of the restart of a GTP-U entity | 17.2.0 | +| 2022-06 | CT#96 | CP-221023 | 0117 | - | F | PDU Session Container used over N3mb and N19mb | 17.2.0 | +| 2022-06 | CT#96 | CP-221046 | 0119 | - | F | A G-PDU message without a T-PDU | 17.3.0 | +| 2022-09 | CT#97e | CP-222031 | 0120 | 1 | F | MB-UPF | 17.4.0 | +| 2023-06 | CT#100 | CP-231066 | 0125 | - | F | Adding W1-U interface | 18.0.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29309/raw.md b/raw/rel-18/29_series/29309/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6c8768ad28752ad4171f5fdf9adcb684ed339aa8 --- /dev/null +++ b/raw/rel-18/29_series/29309/raw.md @@ -0,0 +1,1369 @@ + + +# 3GPP TS 29.309 V18.1.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Bootstrapping Server Function (GBA BSF) Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 5 Services offered by the GBA BSF ..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Nbsp_GBA Service ..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 BootstrapInfo ..... | 10 | +| 5.2.2.2.1 General ..... | 10 | +| 5.2.2.2.2 Bootstrapping Info Retrieval..... | 10 | +| 5.2.2.3 PushInfo ..... | 10 | +| 5.2.2.3.1 General ..... | 10 | +| 5.2.2.3.2 Push Info Retrieval..... | 10 | +| 6 API Definitions ..... | 11 | +| 6.1 Nbsp_GBA Service API..... | 11 | +| 6.1.1 Introduction ..... | 11 | +| 6.1.2 Usage of HTTP..... | 12 | +| 6.1.2.1 General..... | 12 | +| 6.1.2.2 HTTP standard headers..... | 12 | +| 6.1.2.2.1 General ..... | 12 | +| 6.1.2.2.2 Content type ..... | 12 | +| 6.1.2.3 HTTP custom headers..... | 12 | +| 6.1.3 Resources..... | 12 | +| 6.1.3.1 Overview..... | 12 | +| 6.1.4 Custom Operations without associated resources ..... | 13 | +| 6.1.4.1 Overview..... | 13 | +| 6.1.4.2 Operation: Bootstrapping Info Retrieval ..... | 13 | +| 6.1.4.2.1 Description ..... | 13 | +| 6.1.4.2.2 Operation Definition ..... | 13 | +| 6.1.4.3 Operation: Push Info Retrieval ..... | 14 | +| 6.1.4.3.1 Description ..... | 14 | +| 6.1.4.3.2 Operation Definition ..... | 14 | +| 6.1.5 Notifications ..... | 15 | +| 6.1.6 Data Model ..... | 15 | +| 6.1.6.1 General..... | 15 | +| 6.1.6.2 Structured data types..... | 16 | +| 6.1.6.2.1 Introduction ..... | 16 | +| 6.1.6.2.2 Type: BootstrappingInfoRequest ..... | 17 | +| 6.1.6.2.3 Type: BootstrappingInfoResponse..... | 17 | +| 6.1.6.2.4 Type: PushInfoRequest ..... | 17 | +| 6.1.6.2.5 Type: PushInfoResponse..... | 18 | +| 6.1.6.2.6 Type: NafId ..... | 18 | +| 6.1.6.2.7 Type: UssListItem..... | 18 | +| 6.1.6.2.8 Type: Uss..... | 18 | +| 6.1.6.2.9 Type: UeIdItem..... | 19 | +| 6.1.6.2.10 Type: FlagsItem..... | 19 | +| 6.1.6.3 Simple data types and enumerations..... | 19 | + +| | | | +|-------------------------------|------------------------------------|-----------| +| 6.1.6.3.1 | Introduction ..... | 19 | +| 6.1.6.3.2 | Simple data types ..... | 19 | +| 6.1.6.3.3 | Enumeration: KeyChoice ..... | 20 | +| 6.1.6.3.4 | Enumeration: UiccOrMe ..... | 20 | +| 6.1.6.3.5 | Enumeration: SecFeature ..... | 21 | +| 6.1.6.3.6 | Enumeration: GbaType ..... | 21 | +| 6.1.6.3.7 | Enumeration: UeIdType ..... | 21 | +| 6.1.7 | Error Handling ..... | 21 | +| 6.1.7.1 | General ..... | 21 | +| 6.1.7.2 | Protocol Errors ..... | 21 | +| 6.1.7.3 | Application Errors ..... | 21 | +| 6.1.8 | Feature negotiation ..... | 22 | +| 6.1.9 | Security ..... | 22 | +| Annex A (normative): | OpenAPI specification ..... | 23 | +| A.1 | General ..... | 23 | +| A.2 | Nbsp_GBA API ..... | 23 | +| Annex B (informative): | Change history ..... | 30 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nbsp Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the GBA BSF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The stage 2 architecture and procedures of SBA-enabled GBA is specified in 3GPP TS 33.220 [14] and 3GPP TS 33.223 [15]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 33.220: "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA)". +- [15] 3GPP TS 33.223: "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA) Push function". +- [16] 3GPP TS 33.224: "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA) Push Layer". + +- [17] 3GPP TS 29.109: "Generic Authentication Architecture (GAA); Zh and Zn Interfaces based on the Diameter protocol; Stage 3". +- [18] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Bootstrapping Server Function:** BSF is hosted in a network element under the control of an MNO. BSF, HSS, and UEs participate in GBA in which a shared secret is established between the network and a UE by running the bootstrapping procedure. The shared secret can be used between NAFs and UEs, for example, for authentication purposes. In the context of the present specification, the BSF is an SBA-capable BSF. + +**GBA Function:** A function on the ME executing the bootstrapping procedure with BSF (i.e. supporting the Ub reference point) and providing Ua applications with security association to run bootstrapping usage procedure. GBA function is called by a Ua application when a Ua application wants to use bootstrapped security association. + +**Network Application Function:** NAF is hosted in a network element. GBA may be used between NAFs and UEs for authentication purposes, and for securing the communication path between the UE and the NAF. In the context of the present specification, the NAF is an SBA-capable NAF. + +**GBA User Security Settings:** GUSS contains the BSF specific information element and the set of all application-specific USSs. + +**Ua Application:** An application on the ME intended to run bootstrapping usage procedure with a NAF. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|------------------------------------| +| BSF | Bootstrapping Server Function | +| GBA | Generic Bootstrapping Architecture | +| GUSS | GBA User Security Settings | +| HSS | Home Subscriber System | +| NAF | Network Application Function | +| SBA | Service-Based Architecture | +| USS | User Security Setting | + +# --- 4 Overview + +Nbsp is a Service-based interface exhibited by GBA BSF (Generic Bootstrapping Architecture; Bootstrapping Server Function) which is a Network Function that supports the following functionality: + +- Allows the NAF and the Push-NAF to fetch the key material agreed during a previous protocol run between the UE and the GBA BSF. It is also used to fetch application-specific user security settings from the GBA BSF, if requested by the NAF. + +The reference points N66 and N67 (see Fig 4-1 below) show the interaction between the GBA BSF and the NAF and Push-NAF Network Functions. + +![Figure 4-1: Reference Model – Nbsp. The diagram shows three network functions: NAF, Push-NAF, and GBA BSF. NAF and Push-NAF are connected to the GBA BSF via the Nbsp interface. The NAF is connected to the GBA BSF via the N66 interface, and the Push-NAF is connected to the GBA BSF via the N67 interface.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +graph LR + NAF[NAF] -- N66 --> GBA[GBA BSF] + PushNAF[Push-NAF] -- N67 --> GBA + GBA -- Nbsp --> NAF + GBA -- Nbsp --> PushNAF + +``` + +Figure 4-1: Reference Model – Nbsp. The diagram shows three network functions: NAF, Push-NAF, and GBA BSF. NAF and Push-NAF are connected to the GBA BSF via the Nbsp interface. The NAF is connected to the GBA BSF via the N66 interface, and the Push-NAF is connected to the GBA BSF via the N67 interface. + +Figure 4-1: Reference Model – Nbsp + +In the context of the present specification, the GBA BSF is an SBA-capable BSF, and the NAF and Push-NAF are also SBA-capable Network Functions (see 3GPP TS 33.220 [14] and 3GPP TS 33.223 [15]). + +# 5 Services offered by the GBA BSF + +## 5.1 Introduction + +The GBA BSF offers the following services via the Nbsp interface: + +- Nbsp\_GBA Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------|--------|------------------|----------------------------|----------|-------| +| Nbsp_GBA | 5.2 | Nbsp GBA Service | TS29309_Nbsp_GBA.yaml | nbsp-gba | A.2 | + +## 5.2 Nbsp\_GBA Service + +### 5.2.1 Service Description + +This service is exposed by the GBA BSF for the purpose of providing GBA bootstrap information to an SBI-capable NAF, and GBA push information (GPI) to an SBI-capable Push-NAF, for the derivation of the application key material (e.g. Ks\_(ext/int)\_NAF). It also supports to fetch application-specific user security settings (USS) from the GBA BSF. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nbsp\_GBA service the following service operations are defined: + +- BootstrapInfo +- PushInfo + +#### 5.2.2.2 BootstrapInfo + +##### 5.2.2.2.1 General + +This service operation is used between the SBI-capable NAF and the GBA BSF to request the key material agreed during bootstrapping from the UE to the GBA BSF. It is also used to fetch application-specific user security settings from the BSF, if requested by the NAF. + +##### 5.2.2.2.2 Bootstrapping Info Retrieval + +Figure 5.2.2.2.2-1 shows a scenario where the NF Service Consumer (e.g. the SBI-capable NAF) sends a request to the GBA BSF to receive the bootstrapping info and optionally the user security settings. + +![Sequence diagram showing the interaction between an NF service consumer and a GBA BSF for bootstrapping info retrieval.](54fabc351eda5228d2fa28cd9ba07971_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant GBA BSF + Note right of NF service consumer: 1. POST .../bootstrapping-info-retrieval (BootstrappingInfoRequest) + NF service consumer->>GBA BSF: Request + Note left of GBA BSF: 2a. 200 OK (BootstrappingInfoResponse) + Note left of GBA BSF: 2b. 4xx/5xx Errors + Note left of GBA BSF: 2c. 3xx Redirect + GBA BSF-->>NF service consumer: Response +``` + +The diagram illustrates a sequence of interactions between an 'NF service consumer' and a 'GBA BSF'. The 'NF service consumer' sends a '1. POST .../bootstrapping-info-retrieval (BootstrappingInfoRequest)' to the 'GBA BSF'. The 'GBA BSF' responds with '2a. 200 OK (BootstrappingInfoResponse)', '2b. 4xx/5xx Errors', or '2c. 3xx Redirect'. + +Sequence diagram showing the interaction between an NF service consumer and a GBA BSF for bootstrapping info retrieval. + +**Figure 5.2.2.2.2-1: Requesting Bootstrapping Info** + +1. The NF Service Consumer sends a POST request (custom method "bootstrapping-info-retrieval") to the GBA BSF. The request includes the B-TID, the NAF-Id and optionally a flag to indicate that the NAF is GBA\_U aware, and a list of GAA Service Identifiers (GSID). +- 2a. On success the GBA BSF responds with "200 OK" and including in the message body the key material (Ks\_NAF in case of GBA\_ME and Ks\_ext\_NAF in case of GBA\_U), the key material lifetime and the bootstrapping creation time. Optionally, it may include additional key material (i.e. Ks\_int\_NAF), application-specific user security settings and the UE private identity. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the GBA BSF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another GBA BSF (service) instance. + +#### 5.2.2.3 PushInfo + +##### 5.2.2.3.1 General + +This service operation is used between the SBI-capable Push-NAF and the GBA BSF to request the GBA Push Information (GPI) in order to bootstrap the UE with GBA key material. It is also used to fetch application-specific user security settings from the BSF, if requested by the Push-NAF. + +##### 5.2.2.3.2 Push Info Retrieval + +Figure 5.2.2.3.2-1 shows a scenario where the NF Service Consumer (e.g. the SBI-capable Push-NAF) sends a request to the GBA BSF to receive the bootstrapping info and optionally the user security settings. + +![Sequence diagram showing the interaction between an NF service consumer and a GBA BSF. The consumer sends a POST request to the BSF, which responds with a 200 OK, an error, or a redirect.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant GBA BSF + Note right of NF service consumer: 1. POST .../push-info-retrieval (PushInfoRequest) + NF service consumer->>GBA BSF: 1. POST .../push-info-retrieval (PushInfoRequest) + Note left of GBA BSF: 2a. 200 OK (PushInfoResponse) +2b. 4xx/5xx Errors +2c. 3xx Redirect + GBA BSF-->>NF service consumer: 2a. 200 OK (PushInfoResponse) + GBA BSF-->>NF service consumer: 2b. 4xx/5xx Errors + GBA BSF-->>NF service consumer: 2c. 3xx Redirect + +``` + +Sequence diagram showing the interaction between an NF service consumer and a GBA BSF. The consumer sends a POST request to the BSF, which responds with a 200 OK, an error, or a redirect. + +**Figure 5.2.2.3.2-1: Requesting Push Info** + +1. The NF Service Consumer sends a POST request (custom method "push-info-retrieval") to the GBA BSF. The request includes the User Identity (Private or Public Identity), User Identity type, UICC application identifier, Push-NAF-Id, Push-NAF SA identifier, Indicator for use of GBA\_ME or GBA\_U, Requested Push-NAF key lifetime, Private User Identity indicator, list of GAA Service Identifiers (GSID), AUTS and RAND. +- 2a. On success the GBA BSF responds with "200 OK" and including in the message body the GPI data, key material (Ks\_NAF in case of GBA\_ME and Ks\_ext\_NAF in case of GBA\_U), key material lifetime, application-specific user security settings. Optionally, it may include additional key material (i.e. Ks\_int\_NAF), application-specific user security settings and the UE private identity. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +In the case of redirection, the GBA BSF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another GBA BSF (service) instance. + +# 6 API Definitions + +## 6.1 Nbsp\_GBA Service API + +### 6.1.1 Introduction + +The Nbsp\_GBA service shall use the Nbsp\_GBA API. + +The API URI of the Nbsp\_GBA API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nbsg-gba". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nbsp\_GBA API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +In this release of this specification, no resources are defined for the Nbsp\_GBA service. + +#### 6.1.3.1 Overview + +The structure of the Resource URIs of the Nbsp\_GBA service is shown in figure 6.1.3.1-1. + +![Diagram showing the Resource URI structure of the Nbsp_GBA API. The root URI is {apiRoot}/nbsg-gba/{apiVersion}. It branches into two optional sub-URIs: /bootstrapping-info-retrieval and /push-info-retrieval, both shown in dashed boxes.](ddde3ebb7c1a58ec96bd5cc64e664ab0_img.jpg) + +``` +graph TD; Root["{apiRoot}/nbsg-gba/{apiVersion}"] --- B["/bootstrapping-info-retrieval"]; Root --- P["/push-info-retrieval"]; style B stroke-dasharray: 5 5; style P stroke-dasharray: 5 5; +``` + +Diagram showing the Resource URI structure of the Nbsp\_GBA API. The root URI is {apiRoot}/nbsg-gba/{apiVersion}. It branches into two optional sub-URIs: /bootstrapping-info-retrieval and /push-info-retrieval, both shown in dashed boxes. + +**Figure 6.1.3.1-1: Resource URI structure of the Nbsp\_GBA API** + +### 6.1.4 Custom Operations without associated resources + +#### 6.1.4.1 Overview + +**Table 6.1.4.1-1: Custom operations without associated resources** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|------------------------------|-------------------------------|--------------------|-------------| +| Bootstrapping Info Retrieval | /bootstrapping-info-retrieval | POST | | +| Push Info Retrieval | /push-info-retrieval | POST | | + +#### 6.1.4.2 Operation: Bootstrapping Info Retrieval + +##### 6.1.4.2.1 Description + +##### 6.1.4.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.2.2-1 and 6.1.4.2.2-2. + +**Table 6.1.4.2.2-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|------------------------------------------------| +| BootstrappingInfoRequest | M | 1 | Request body of the Bootstrapping Info Request | + +**Table 6.1.4.2.2-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------| +| BootstrappingInfoResponse | M | 1 | 200 OK | A response body containing the BootstrappingInfoResponse shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The NAF is not authorized to request Bootstrapping Information from the GBA BSF. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.4.2.2-3: Headers supported by the 307 Response Code** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same GBA BSF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.4.2.2-4: Headers supported by the 308 Response Code** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same GBA BSF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.1.4.3 Operation: Push Info Retrieval + +##### 6.1.4.3.1 Description + +##### 6.1.4.3.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.3.2-1 and 6.1.4.3.2-2. + +**Table 6.1.4.3.2-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|---------------------------------------| +| PushInfoRequest | M | 1 | Request body of the Push Info Request | + +**Table 6.1.4.3.2-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------| +| PushInfoResponse | M | 1 | 200 OK | A response body containing the PushInfoResponse shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The Push-NAF is not authorized to request GBA Push Information (GPI) from the GBA BSF. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.4.3.2-3: Headers supported by the 307 Response Code** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same GBA BSF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +**Table 6.1.4.3.2-4: Headers supported by the 308 Response Code** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same GBA BSF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +### 6.1.5 Notifications + +In this release of this specification, no notifications are defined for the Nbsp\_GBA service. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nbsp\_GBA service-based interface protocol. + +Table 6.1.6.1-1: Nbsp\_GBA specific Data Types + +| Data type | Clause defined | Description | +|---------------------------|----------------|--------------------------------------------------------------------------------------| +| BootstrappingInfoRequest | 6.1.6.2.2 | Request body of the HTTP POST operation for resource "/bootstrapping-info-request". | +| BootstrappingInfoResponse | 6.1.6.2.3 | Response body of the HTTP POST operation for resource "/bootstrapping-info-request". | +| PushInfoRequest | 6.1.6.2.4 | Request body of the HTTP POST operation for resource "/push-info-request". | +| PushInfoResponse | 6.1.6.2.5 | Response body of the HTTP POST operation for resource "/push-info-request". | +| NafId | 6.1.6.2.6 | NAF ID, containing the NAF FQDN and the Ua Security Protocol Identifier. | +| UssListItem | 6.1.6.2.7 | Data item in a User Security Settings array list. | +| Uss | 6.1.6.2.8 | User Security Settings for a given GAA Service. | +| UeldsItem | 6.1.6.2.9 | Data item in a UE ID array list. | +| FlagsItem | 6.1.6.2.10 | Data item in a Flags array list. | +| GsId | 6.1.6.3.2 | GAA Service Identifier. | +| GsType | 6.1.6.3.2 | GAA Service Type. | +| BtlId | 6.1.6.3.2 | Bootstrapping Transaction Identifier. | +| MeKeyMaterial | 6.1.6.3.2 | ME Key Material (hex-encoded string). | +| UiccKeyMaterial | 6.1.6.3.2 | UICC key material (hex-encoded string). | +| Ueld | 6.1.6.3.2 | Public Identity of the UE. | +| Impi | 6.1.6.3.2 | IMS Private Identity of the UE | +| Flag | 6.1.6.3.2 | GAA authorization flags, as defined in 3GPP TS 29.109 [17], Annex C. | +| GbaPushInfo | 6.1.6.3.2 | GBA Push Info (hex-encoded string). | +| NafGroup | 6.1.6.3.2 | NAF Group (string). | +| PtlId | 6.1.6.3.2 | P-TID. | +| UiccAppLabel | 6.1.6.3.2 | UICC Application Label (string). | +| Auts | 6.1.6.3.2 | AUTS in UMTS AKA. | +| Rand | 6.1.6.3.2 | RAND in UMTS AKA. | +| KeyChoice | 6.1.6.3.3 | Type of key (ME-based or UICC-based) that the NAF shall use. | +| UiccOrMe | 6.1.6.3.4 | Indicates whether GBA_ME or GBA_U is to be used for GBA push. | +| SecFeature | 6.1.6.3.5 | Security features supported by the BSF or the NAF. | +| GbaType | 6.1.6.3.6 | Authentication type used by the UE for GBA. | +| UeldType | 6.1.6.3.7 | Type of UE Identity (public or private). | + +Table 6.1.6.1-2 specifies data types re-used by the Nbsp\_GBA service-based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nbsp\_GBA service-based interface. + +Table 6.1.6.1-2: Nbsp\_GBA re-used Data Types + +| Data type | Reference | Comments | +|------------------|---------------------|--------------------------------------------------------------| +| Uint32 | 3GPP TS 29.571 [18] | Unsigned 32-bit integer. | +| DateTime | 3GPP TS 29.571 [18] | String with a "date-time" format, as defined by OpenAPI [6]. | +| ProblemDetails | 3GPP TS 29.571 [18] | Response body of error response messages. | +| RedirectResponse | 3GPP TS 29.571 [18] | Response body of a redirect response message. | +| Fqdn | 3GPP TS 29.571 [18] | Fully Qualified Domain Name | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: BootstrappingInfoRequest + +Table 6.1.6.2.2-1: Definition of type BootstrappingInfoRequest + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| btld | Btld | M | 1 | Bootstrapping Transaction Identifier | +| naflid | Nafld | M | 1 | NAF Identifier | +| gbaUAware | boolean | O | 0..1 | GBA-U Awareness Indicator.

true: The sending node is GBA_U aware
false (default) or absent: The sending node is not GBA_U aware. | +| gslds | array(Gsld) | O | 1..N | GBA Service Identifiers | + +##### 6.1.6.2.3 Type: BootstrappingInfoResponse + +Table 6.1.6.2.3-1: Definition of type BootstrappingInfoResponse + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------|--------------------|---|-------------|---------------------------------------------------------------------------------| +| meKeyMaterial | MeKeyMaterial | M | 1 | ME key material (Ks_NAF or Ks_Ext_NAF) | +| uiccKeyMaterial | UiccKeyMaterial | O | 0..1 | UICC key material (Ks_Int_NAF) | +| keyExpiryTime | DateTime | O | 0..1 | Key expiry time | +| bootstrappingInfoCreationTime | DateTime | O | 0..1 | Bootstrapping Info Creation Time | +| ussList | array(UssListItem) | O | 1..N | GBA User Security Settings per GBA Service Identifier | +| gbaType | GbaType | O | 0..1 | Authentication type that was used by the UE during the bootstrapping procedure. | +| impi | Impi | O | 0..1 | UE Private Identity | + +##### 6.1.6.2.4 Type: PushInfoRequest + +Table 6.1.6.2.4-1: Definition of type PushInfoRequest + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueId | Ueld | M | 1 | User Identity. | +| ueIdType | UeldType | M | 1 | Type of UE identity (public or private). | +| uiccAppLabel | UiccAppLabel | M | 1 | UICC Application Label. | +| naflid | Nafld | M | 1 | NAF Identifier. | +| ptld | Ptld | M | 1 | P-TID (NAF SA Identifier). | +| uiccOrMe | UiccOrMe | M | 1 | Indicates whether GBA_ME or GBA_U is to be used for GBA push. | +| requestedLifeTime | DateTime | M | 1 | Requested key lifetime for the NAF keys. | +| privateIdRequest | boolean | O | 0..1 | Indicates to the BSF whether the UE private identity shall be returned to the NAF in the response message.

true: the private identity is requested by the NAF, and it shall be returned by the BSF.

false (default) or absent: the private identity is not requested by the NAF. | +| gbaUAware | boolean | O | 0..1 | GBA-U Awareness Indicator.

true: The sending node is GBA_U aware
false (default) or absent: The sending node is not GBA_U aware. | +| gslds | array(Gsld) | O | 1..N | GBA Service Identifiers. | +| auts | Auts | O | 0..1 | AUTS in UMTS AKA. | +| rand | Rand | O | 0..1 | RAND in UMTS AKA. | +| securityFeaturesRequest | array(SecFeature) | O | 1..N | Security Features supported by the NAF. | + +##### 6.1.6.2.5 Type: PushInfoResponse + +Table 6.1.6.2.5-1: Definition of type PushInfoResponse + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| meKeyMaterial | MeKeyMaterial | M | 1 | ME key material (Ks_NAF or Ks_Ext_NAF). | +| gbaPushInfo | GbaPushInfo | M | 1 | GBA Push Info | +| uiccKeyMaterial | UiccKeyMaterial | O | 0..1 | UICC key material (Ks_Int_NAF). | +| keyExpiryTime | DateTime | O | 0..1 | Key expiry time. | +| bootstrappingInfoCreationTime | DateTime | O | 0..1 | Bootstrapping Info Creation Time. | +| ussList | array(UssListItem) | O | 1..N | GBA User Security Settings per GBA Service Identifier | +| gbaType | GbaType | O | 0..1 | GBA Type. | +| impi | Impi | O | 0..1 | UE Private Identity. | +| securityFeaturesResponse | array(SecFeature) | O | 0..N |

If the BSF does not support the usage of securityFeatures or the NAF did not include any securityFeaturesRequest attribute in the PushInfoRequest message, this IE shall be absent.

If securityFeatures element is not defined in the GUSS of the UE, or there is no common securityFeature between NAF and BSF, the BSF shall include an empty array in the securityFeaturesResponse attribute.

| + +##### 6.1.6.2.6 Type: NafId + +Table 6.1.6.2.6-1: Definition of type NafId + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nafFqdn | Fqdn | M | 1 | FQDN of the NAF. | +| uaSecProtId | string | M | 1 |

Ua Security Protocol Identifier.

It shall contain 5 octets, as described in 3GPP TS 33.220 [14], encoded as a sequence of 10 hexadecimal characters.

pattern: "^[A-Fa-f0-9]{10}\$"

| + +##### 6.1.6.2.7 Type: UssListItem + +Table 6.1.6.2.7-1: Definition of type UssListItem + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------| +| uss | Uss | M | 1 | User Security Settings. | + +##### 6.1.6.2.8 Type: Uss + +Table 6.1.6.2.8-1: Definition of type Uss + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|---------------------------------------------------------------| +| gsId | GsId | M | 1 | GAA Service ID. | +| gsType | GsType | M | 1 | GAA Service Type. | +| uelds | array(UeldsItem) | M | 1..N | List of UE Identities | +| nafGroup | NafGroup | O | 0..1 | NAF Group. | +| flags | array(FlagsItem) | O | 1..N | List of security flags supported for the current GAA service. | +| keyChoice | KeyChoice | O | 0..1 | Type of key that the NAF shall use. | + +##### 6.1.6.2.9 Type: UeldsItem + +Table 6.1.6.2.9-1: Definition of type UeldsItem + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------| +| ueld | Ueld | M | 1 | Identity of the UE | + +##### 6.1.6.2.10 Type: FlagsItem + +Table 6.1.6.2.10-1: Definition of type FlagsItem + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------| +| flag | Flag | M | 1 | Security flag supported for the corresponding GAA Service. | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +Table 6.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | +|-----------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| GsId | Uint32 | GAA Service Identifier.
For 3GPP standardized values, see 3GPP TS 29.109 [17], Annex B. | +| GsType | Uint32 | GAA Service Type.
For 3GPP standardized values, see 3GPP TS 29.109 [17], Annex B. | +| BtId | string | Bootstrapping Transaction Identifier. It shall take the form of a NAI, where the realm part identifies the FQDN of the BSF. See 3GPP TS 33.220 [14]. | +| MeKeyMaterial | string | ME key material, containing a 256-bit key, encoded as a sequence of 64 hexadecimal characters.

pattern: "[A-Fa-f0-9]{64}\$" | +| UiccKeyMaterial | string | UICC key material, containing a 256-bit key, encoded as a sequence of 64 hexadecimal characters.

pattern: "[A-Fa-f0-9]{64}\$" | +| UeId | string | Identity of the UE. | +| Impi | string | IMS Private Identity of the UE. | +| Flag | Uint32 | GAA authorization flags, associated to the specific GAA Service Type, as defined in 3GPP TS 29.109 [17], Annex C. | +| GbaPushInfo | string | GBA Push Info binary data, as defined in 3GPP TS 33.223 [15], clause 5.3.5, encoded as a sequence of hexadecimal characters.

pattern: "^[A-Fa-f0-9]{2}+\$" | +| NafGroup | string | NAF Group. | +| PtId | string | P-TID. | +| UiccAppLabel | string | UICC Application Label. | +| Auts | string | AUTS in UMTS AKA, containing a 112-bit value, encoded as a sequence of 28 hexadecimal characters.

pattern: "[A-Fa-f0-9]{28}\$" | +| Rand | string | RAND in UMTS AKA, containing a 128-bit value, encoded as a sequence of 32 hexadecimal characters.

pattern: "[A-Fa-f0-9]{32}\$" | + +##### 6.1.6.3.3 Enumeration: KeyChoice + +The enumeration KeyChoice represents the type of key that the NAF shall use. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +Table 6.1.6.3.3-1: Enumeration KeyChoice + +| Enumeration value | Description | +|----------------------|--------------------------------------------------| +| "ME_BASED_KEY" | Ks_NAF or Ks_ext_NAF shall be used by the NAF. | +| "UICC_BASED_KEY" | Ks_int_NAF shall be used by the NAF. | +| "ME_UICC_BASED_KEYS" | Ks_ext_NAF or Ks_int_NAF can be used by the NAF. | + +##### 6.1.6.3.4 Enumeration: UiccOrMe + +The enumeration UiccOrMe represents whether GBA\_ME or GBA\_U is to be used for GBA push. It shall comply with the provisions defined in table 6.1.6.3.4-1. + +Table 6.1.6.3.4-1: Enumeration UiccOrMe + +| Enumeration value | Description | +|-------------------|-----------------------| +| "GBA_ME" | GBA_ME shall be used. | +| "GBA_U" | GBA_U shall be used. | + +##### 6.1.6.3.5 Enumeration: SecFeature + +The enumeration SecFeature represents security features supported by the BSF or the NAF. It shall comply with the provisions defined in table 6.1.6.3.5-1. + +**Table 6.1.6.3.5-1: Enumeration SecFeature** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------| +| "GPL_U" | The UICC supports Generic Push Layer, as specified in 3GPP TS 33.224 [16]. | + +##### 6.1.6.3.6 Enumeration: GbaType + +The enumeration GbaType represents the authentication type that was used during bootstrapping procedure. It shall comply with the provisions defined in table 6.1.6.3.6-1. + +**Table 6.1.6.3.6-1: Enumeration GbaType** + +| Enumeration value | Description | +|-------------------|-------------------------------------------------------------------------------| +| "3G_GBA" | The 3G GBA has been performed as defined in 3GPP TS 33.220 [14]. | +| "2G_GBA" | The 2G GBA has been performed as defined in 3GPP TS 33.220 [14], Annex I. | +| "GBA_DIGEST" | The GBA Digest has been performed as defined in 3GPP TS 33.220 [14], Annex M. | + +##### 6.1.6.3.7 Enumeration: UeldType + +The enumeration UeldType represents the type of the identity of the user. It shall comply with the provisions defined in table 6.1.6.3.7-1. + +**Table 6.1.6.3.7-1: Enumeration UeldType** + +| Enumeration value | Description | +|-------------------|------------------------| +| "PUBLIC" | Public user identity. | +| "PRIVATE" | Private user identity. | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nbsp\_GBA API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nbsp\_GBA API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nbsp\_GBA service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nbsp\_GBA service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nbsp\_GBA API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nbsp\_GBA API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nbsp\_GBA API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nbsp\_GBA service. + +The Nbsp\_GBA API defines the following scopes for OAuth2 authorization: + +**Table 6.1.9-1: OAuth2 scopes defined in Nbsp\_GBA API** + +| Scope | Description | +|------------------------------------------------|--------------------------------------------------------------------| +| "nbsp-gba" | Access to the Nbsp_GBA API | +| "nbsp-gba:bootstrapping-info-retrieval:invoke" | Access to invoke the Bootstrapping Info Retrieval custom operation | +| "nbsp-gba:push-info-retrieval:invoke" | Access to invoke the Push Info Retrieval custom operation | + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## --- A.2 Nbsp\_GBA API + +``` +openapi: 3.0.0 + +info: + version: '1.1.0-alpha.2' + title: 'GBA BSF Nbsp_GBA Service' + description: | + GBA BSF Nbsp_GBA Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.309 V18.1.0; 5G System; Bootstrapping Server Function (GBA BSF) Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.309/' + +servers: + - url: '{apiRoot}/nbsp-gba/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nbsp-gba + +paths: + /bootstrapping-info-retrieval: + post: + summary: Retrieve Bootstrapping Info from GBA BSF from NAF + operationId: BootstrappingInfoRetrieval + tags: + - Bootstrapping Info Retrieval (Custom Operation) + security: + - {} + - oAuth2ClientCredentials: + - nbsp-gba + - oAuth2ClientCredentials: + - nbsp-gba + - nbsp-gba:bootstrapping-info-retrieval:invoke + requestBody: + content: + application/json: + schema: +``` + +``` + $ref: '#/components/schemas/BootstrappingInfoRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/BootstrappingInfoResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/push-info-retrieval: + post: + summary: Retrieve Push Info from GBA BSF from Push-NAF + operationId: PushInfoRetrieval + tags: + - Push Info Retrieval (Custom Operation) + security: + - {} + - oAuth2ClientCredentials: + - nbsp-gba + - oAuth2ClientCredentials: + - nbsp-gba + - nbsp-gba:push-info-retrieval:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PushInfoRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PushInfoResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +``` + +``` +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nbsp-gba: Access to the Nbsp_GBA API + nbsp-gba:bootstrapping-info-retrieval:invoke: >- + Access to invoke the Bootstrapping Info Retrieval custom operation + nbsp-gba:push-info-retrieval:invoke: >- + Access to invoke the Push Info Retrieval custom operation + + schemas: + +# +# STRUCTURED TYPES +# + + BootstrappingInfoRequest: + description: > + Request body of the HTTP POST operation for resource /bootstrapping-info-request + type: object + required: + - btId + - nafId + properties: + btId: + $ref: '#/components/schemas/BtId' + nafId: + $ref: '#/components/schemas/NafId' + gbaUAware: + type: boolean + default: false + gsIds: + type: array + items: + $ref: '#/components/schemas/GsId' + minItems: 1 + + BootstrappingInfoResponse: + description: > + Response body of the HTTP POST operation for resource /bootstrapping-info-request + type: object + required: + - meKeyMaterial + properties: + meKeyMaterial: + $ref: '#/components/schemas/MeKeyMaterial' + uiccKeyMaterial: + $ref: '#/components/schemas/UiccKeyMaterial' + keyExpiryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + bootstrappingInfoCreationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ussList: + type: array + items: + $ref: '#/components/schemas/UssListItem' + minItems: 1 + gbaType: +``` + +``` + $ref: '#/components/schemas/GbaType' + impi: + $ref: '#/components/schemas/Impi' + +PushInfoRequest: + description: Request body of the HTTP POST operation for resource /push-info-request + type: object + required: + - ueId + - ueIdType + - uiccAppLabel + - nafId + - ptId + - uiccOrMe + - requestedLifeTime + properties: + ueId: + $ref: '#/components/schemas/UeId' + ueIdType: + $ref: '#/components/schemas/UeIdType' + uiccAppLabel: + $ref: '#/components/schemas/UiccAppLabel' + nafId: + $ref: '#/components/schemas/NafId' + ptId: + $ref: '#/components/schemas/PtId' + uiccOrMe: + $ref: '#/components/schemas/UiccOrMe' + requestedLifeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + privateIdRequest: + type: boolean + default: false + gbaUAWare: + type: boolean + default: false + gsIds: + type: array + items: + $ref: '#/components/schemas/GsId' + minItems: 1 + auts: + $ref: '#/components/schemas/Auts' + rand: + $ref: '#/components/schemas/Rand' + securityFeaturesRequest: + type: array + items: + $ref: '#/components/schemas/SecFeature' + minItems: 1 + +PushInfoResponse: + description: Response body of the HTTP POST operation for resource /push-info-request + type: object + required: + - meKeyMaterial + - gbaPushInfo + properties: + meKeyMaterial: + $ref: '#/components/schemas/MeKeyMaterial' + gbaPushInfo: + $ref: '#/components/schemas/GbaPushInfo' + uiccKeyMaterial: + $ref: '#/components/schemas/UiccKeyMaterial' + keyExpiryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + bootstrappingInfoCreationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ussList: + type: array + items: + $ref: '#/components/schemas/UssListItem' + minItems: 1 + gbaType: + $ref: '#/components/schemas/GbaType' + impi: + $ref: '#/components/schemas/Impi' + securityFeaturesResponse: +``` + +``` +type: array +items: + $ref: '#/components/schemas/SecFeature' + +NafId: + description: NAF ID, containing the NAF FQDN and the Ua Security Protocol Identifier + type: object + required: + - nafFqdn + - uaSecProtId + properties: + nafFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + uaSecProtId: + type: string + pattern: '^[A-Fa-f0-9]{10}$' + +UssListItem: + description: Data item in a User Security Settings array list + type: object + required: + - uss + properties: + uss: + $ref: '#/components/schemas/Uss' + +Uss: + description: User Security Settings for a given GAA Service + type: object + required: + - gsId + - gsType + - ueIds + properties: + gsId: + $ref: '#/components/schemas/GsId' + gsType: + $ref: '#/components/schemas/GsType' + ueIds: + type: array + items: + $ref: '#/components/schemas/UeIdsItem' + minItems: 1 + nafGroup: + $ref: '#/components/schemas/NafGroup' + flags: + type: array + items: + $ref: '#/components/schemas/FlagsItem' + minItems: 1 + keyChoice: + $ref: '#/components/schemas/KeyChoice' + +UeIdsItem: + description: Data item in a UE ID array list + type: object + required: + - ueId + properties: + ueId: + $ref: '#/components/schemas/UeId' + +FlagsItem: + description: Data item in a Flags array list + type: object + required: + - flag + properties: + flag: + $ref: '#/components/schemas/Flag' + +# +# SIMPLE TYPES +# + +GsId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' +``` + +``` +GsType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + +BtId: + description: Bootstrapping Transaction Identifier + type: string + +MeKeyMaterial: + description: ME Key Material (hex-encoded string) + type: string + pattern: '^[A-Fa-f0-9]{64}$' + +UiccKeyMaterial: + description: UICC key material (hex-encoded string) + type: string + pattern: '^[A-Fa-f0-9]{64}$' + +UeId: + description: Public Identity of the UE + type: string + +Impi: + description: IMS Private Identity of the UE + type: string + +Flag: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + +GbaPushInfo: + description: GBA Push Info (hex-encoded string) + type: string + pattern: '^[A-Fa-f0-9]{2}]+$' + +NafGroup: + description: Character string representing a NAF Group + type: string + +PtId: + description: Character string representing a P-TID + type: string + +UiccAppLabel: + description: Character string representing an UICC Application Label + type: string + +Auts: + description: AUTS value in UMTS AKA + type: string + pattern: '^[A-Fa-f0-9]{28}$' + +Rand: + description: RAND in UMTS AKA + type: string + pattern: '^[A-Fa-f0-9]{32}$' + +# +# ENUMS +# + +KeyChoice: + description: Type of key (ME-based or UICC-based) that the NAF shall use + anyOf: + - type: string + enum: + - ME_BASED_KEY + - UICC_BASED_KEY + - ME_UICC_BASED_KEYS + - type: string + +UiccOrMe: + description: Indicates whether GBA_ME or GBA_U is to be used for GBA push + anyOf: + - type: string + enum: + - GBA_ME + - GBA_U + - type: string +``` + +SecFeature: +description: Security features supported by the BSF or the NAF +anyOf: +- type: string +enum: +- GPL\_U +- type: string + +GbaType: +description: Authentication type used by the UE for GBA +anyOf: +- type: string +enum: +- 3G\_GBA +- 2G\_GBA +- GBA\_DIGEST +- type: string + +UeIdType: +description: Type of UE Identity (public or private) +anyOf: +- type: string +enum: +- PUBLIC +- PRIVATE +- type: string + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-02 | CT4#102 | C4-211396 | | | | TS template agreed | 0.0.0 | +| 2021-04 | CT4#103 | C4-212594 | | | | Incorporation of agreed pCRs from CT4#103: C4-212527, C4-212528, C4-212529 | 0.1.0 | +| 2021-05 | CT4#104 | C4-213524 | | | | Incorporation of agreed pCRs from CT4#104: C4-213293, C4-213316 | 0.2.0 | +| 2021-09 | CT4#105 | C4-214751 | | | | Incorporation of agreed pCRs from CT4#105: C4-214340, C4-214341 | 0.3.0 | +| 2021-10 | CT4#106 | C4-215515 | | | | Incorporation of agreed pCRs from CT4#106: C4-215330 | 0.4.0 | +| 2021-12 | CT#94 | CP-213154 | | | | V1.0.0. presented for information | 1.0.0 | +| 2022-03 | CT4#108 | C4-221637 | | | | Incorporation of agreed pCRs from CT4#108: C4-221174, C4-221355 | 1.1.0 | +| 2022-03 | CT#95 | CP-220101 | | | | TS presented for information | 2.0.0 | +| 2022-03 | CT#95 | | | | | TS approved | 17.0.0 | +| 2022-06 | CT#96 | CP-221032 | 0001 | - | F | Fqdn Data Type Definition | 17.1.0 | +| 2022-06 | CT#96 | CP-221051 | 0002 | - | F | 29.309 Rel-17 API version and External doc update | 17.1.0 | +| 2023-09 | CT#101 | CP-232033 | 0005 | - | B | OAuth2 scopes in the Nbsp_GBA API | 18.0.0 | +| 2023-09 | CT#101 | CP-232060 | 0006 | - | F | 29.309 Rel-18 API version and External doc update | 18.0.0 | +| 2023-12 | CT#102 | CP-233028 | 0007 | 1 | F | Default values of privateIdRequest and gbaUAware | 18.1.0 | +| 2023-12 | CT#102 | CP-233027 | 0008 | - | F | Location header description | 18.1.0 | +| 2023-12 | CT#102 | CP-233028 | 0009 | 1 | B | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.1.0 | +| 2023-12 | CT#102 | CP-233029 | 0010 | 2 | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.1.0 | +| 2023-12 | CT#102 | CP-233030 | 0011 | - | F | Editorial and Style Corrections | 18.1.0 | +| 2023-12 | CT#102 | CP-233060 | 0012 | - | F | 29.309 Rel-18 API version and External doc update | 18.1.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29336/raw.md b/raw/rel-18/29_series/29336/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..054e7c1dfd0d2ae93edb2b0d79d2729473747aea --- /dev/null +++ b/raw/rel-18/29_series/29336/raw.md @@ -0,0 +1,3282 @@ + + +# 3GPP TS 29.336 V18.2.0 (2023-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications (Release 18)** + +![5G ADVANCED logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller black letters to the right. + +5G ADVANCED logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations ..... | 9 | +| 3.1 Abbreviations ..... | 9 | +| 4 General Description ..... | 9 | +| 4.1 Introduction ..... | 9 | +| 5 Diameter-based S6m/S6n Interface ..... | 11 | +| 5.1 Introduction ..... | 11 | +| 5.2 Procedure Descriptions ..... | 11 | +| 5.2.1 Subscriber Information Retrieval ..... | 11 | +| 5.2.1.1 General..... | 11 | +| 5.2.1.2 Detailed Behaviour of the HSS..... | 13 | +| 5.2.1.3 Detailed Behaviour of the MTC-IWF..... | 14 | +| 5.2.1.4 Detailed Behaviour of the MTC-AAA ..... | 14 | +| 6 Protocol Specification ..... | 15 | +| 6.1 Introduction ..... | 15 | +| 6.1.1 Use of Diameter Base Protocol ..... | 15 | +| 6.1.2 Securing Diameter Messages ..... | 15 | +| 6.1.3 Accounting Functionality ..... | 15 | +| 6.1.4 Use of Sessions..... | 15 | +| 6.1.5 Transport Protocol ..... | 15 | +| 6.1.6 Routing Considerations ..... | 15 | +| 6.1.7 Advertising Application Support..... | 16 | +| 6.1.8 Diameter Application Identifier..... | 16 | +| 6.1.9 Use of the Supported-Features AVP ..... | 16 | +| 6.1.10 User Identity to HSS resolution..... | 16 | +| 6.2 Commands..... | 17 | +| 6.2.1 Introduction ..... | 17 | +| 6.2.2 Command-Code values ..... | 17 | +| 6.2.3 Subscriber-Information-Request (SIR) Command..... | 17 | +| 6.2.4 Subscriber-Information-Answer (SIA) Command ..... | 18 | +| 6.3 Result-Code AVP and Experimental-Result AVP Values..... | 18 | +| 6.3.1 General ..... | 18 | +| 6.3.2 Success ..... | 18 | +| 6.3.3 Permanent Failures ..... | 18 | +| 6.3.3.1 DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 18 | +| 6.3.3.2 DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_ENTITY (5510)..... | 18 | +| 6.3.3.3 DIAMETER_ERROR_UNAUTHORIZED_SERVICE (5511)..... | 19 | +| 6.4 AVPs ..... | 19 | +| 6.4.1 General ..... | 19 | +| 6.4.2 User-Identifier ..... | 20 | +| 6.4.3 Service-ID..... | 20 | +| 6.4.4 SCS-Identity ..... | 20 | +| 6.4.5 Service-Parameters ..... | 21 | +| 6.4.6 T4-Parameters..... | 21 | +| 6.4.7 Service-Data ..... | 21 | +| 6.4.8 T4-Data..... | 21 | +| 6.4.9 HSS-Cause..... | 22 | +| 6.4.10 SIR-Flags ..... | 22 | +| 6.4.11 External-Identifier ..... | 22 | +| 6.4.12 Serving-Node..... | 22 | +| 6.4.13 Additional-Serving-Node ..... | 23 | + +| | | | +|---------|--------------------------------------------------------------------------|----| +| 6.4.14 | IP-SM-GW-Number ..... | 24 | +| 6.4.15 | IP-SM-GW-Name..... | 24 | +| 6.4.16 | OC-Supported-Features ..... | 24 | +| 6.4.17 | OC-OLR ..... | 24 | +| 6.4.18 | IP-SM-GW-Realm..... | 24 | +| 6.4.19 | DRMP..... | 24 | +| 6.4.20 | Load..... | 24 | +| 7 | Diameter-based S6t Interface..... | 24 | +| 7.1 | Introduction ..... | 24 | +| 7.2 | Procedure Descriptions ..... | 25 | +| 7.2.1 | Configuration Information on S6t ..... | 25 | +| 7.2.1.1 | General..... | 25 | +| 7.2.1.2 | Detailed Behaviour of the HSS..... | 28 | +| 7.2.1.3 | Detailed Behaviour of the SCEF ..... | 31 | +| 7.2.2 | Reporting on S6t..... | 32 | +| 7.2.2.1 | General..... | 32 | +| 7.2.2.2 | Detailed Behaviour of the HSS..... | 34 | +| 7.2.2.3 | Detailed Behaviour of the SCEF ..... | 35 | +| 7.2.3 | NIDD Information on S6t..... | 36 | +| 7.2.3.1 | General..... | 36 | +| 7.2.3.2 | Detailed Behaviour of the HSS..... | 38 | +| 7.2.3.3 | Detailed Behaviour of the SCEF ..... | 38 | +| 8 | Protocol Specification for S6t..... | 39 | +| 8.1 | Introduction ..... | 39 | +| 8.1.1 | Use of Diameter Base Protocol ..... | 39 | +| 8.1.2 | Securing Diameter Messages ..... | 39 | +| 8.1.3 | Accounting Functionality ..... | 39 | +| 8.1.4 | Use of Sessions..... | 39 | +| 8.1.5 | Transport Protocol..... | 39 | +| 8.1.6 | Routing Considerations ..... | 39 | +| 8.1.7 | Advertising Application Support..... | 40 | +| 8.1.8 | Diameter Application Identifier..... | 40 | +| 8.1.9 | Use of the Supported-Features AVP ..... | 40 | +| 8.1.10 | User Identity to HSS resolution..... | 40 | +| 8.2 | Commands..... | 41 | +| 8.2.1 | Introduction ..... | 41 | +| 8.2.2 | Command-Code values ..... | 41 | +| 8.2.3 | Configuration Information Request (CIR) Command..... | 41 | +| 8.2.4 | Configuration-Information-Answer (CIA) Command ..... | 42 | +| 8.2.5 | Reporting-Information-Request (RIR) Command ..... | 42 | +| 8.2.6 | Reporting-Information-Answer (RIA) Command..... | 43 | +| 8.2.7 | NIDD Information Request (NIR) Command..... | 43 | +| 8.2.8 | NIDD-Information-Answer (NIA) Command..... | 43 | +| 8.3 | Result-Code AVP and Experimental-Result AVP Values..... | 44 | +| 8.3.1 | General ..... | 44 | +| 8.3.2 | Success ..... | 44 | +| 8.3.3 | Permanent Failures ..... | 44 | +| 8.3.3.1 | DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 44 | +| 8.3.3.2 | DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_ENTITY (5510)..... | 44 | +| 8.3.3.3 | DIAMETER_ERROR_UNAUTHORIZED_SERVICE (5511)..... | 44 | +| 8.3.3.4 | DIAMETER_ERROR_REQUESTED_RANGE_IS_NOT_ALLOWED (5512) ..... | 44 | +| 8.3.3.5 | DIAMETER_ERROR_CONFIGURATION_EVENT_STORAGE_NOT_SUCCESSFUL
(5513)..... | 45 | +| 8.3.3.6 | DIAMETER_ERROR_CONFIGURATION_EVENT_NON_EXISTANT (5514)..... | 45 | +| 8.3.3.7 | DIAMETER_ERROR_USER_NO_APN_SUBSCRIPTION (5451)..... | 45 | +| 8.3.3.8 | DIAMETER_ERROR_UNAUTHORIZED_MTC_PROVIDER (5516)..... | 45 | +| 8.4 | AVPs ..... | 45 | +| 8.4.1 | General ..... | 45 | +| 8.4.2 | Monitoring-Event-Configuration ..... | 49 | +| 8.4.3 | Monitoring-Event-Report ..... | 50 | + +| | | | +|----------|------------------------------------------------|----| +| 8.4.4 | SCEF-Reference-ID ..... | 51 | +| 8.4.5 | SCEF-ID ..... | 51 | +| 8.4.6 | SCEF-Reference-ID-for-Deletion ..... | 51 | +| 8.4.7 | Monitoring-Type ..... | 51 | +| 8.4.8 | Maximum-Number-of-Reports ..... | 51 | +| 8.4.9 | UE-Reachability-Configuration ..... | 52 | +| 8.4.10 | Monitoring-Duration ..... | 52 | +| 8.4.11 | Maximum-Detection-Time ..... | 52 | +| 8.4.12 | Reachability-Type ..... | 52 | +| 8.4.13 | Maximum-Latency ..... | 52 | +| 8.4.14 | Maximum-Response-Time ..... | 52 | +| 8.4.15 | Location-Information-Configuration ..... | 53 | +| 8.4.16 | MONTE-Location-Type ..... | 53 | +| 8.4.17 | Accuracy ..... | 53 | +| 8.4.18 | Association-Type ..... | 53 | +| 8.4.19 | Roaming-Information ..... | 53 | +| 8.4.20 | Reachability-Information ..... | 54 | +| 8.4.21 | EPS-Location-Information ..... | 54 | +| 8.4.22 | IMEI-Change ..... | 54 | +| 8.4.23 | Feature-List AVP ..... | 54 | +| 8.4.23.1 | Feature-List AVP for the S6t application ..... | 54 | +| 8.4.24 | Monitoring-Event-Config-Status ..... | 56 | +| 8.4.25 | AESE-Communication-Pattern ..... | 56 | +| 8.4.26 | Communication-Pattern-Set ..... | 57 | +| 8.4.27 | Periodic-Communication-Indicator ..... | 57 | +| 8.4.28 | Communication-duration-time ..... | 58 | +| 8.4.29 | Periodic-time ..... | 58 | +| 8.4.30 | Scheduled-communication-time ..... | 58 | +| 8.4.31 | Stationary indication ..... | 58 | +| 8.4.32 | AESE-Communication-Pattern-Config-Status ..... | 58 | +| 8.4.33 | AESE-Error-Report ..... | 59 | +| 8.4.34 | MME-Location-Information ..... | 59 | +| 8.4.35 | SGSN-Location-Information ..... | 59 | +| 8.4.36 | User-Identifier ..... | 60 | +| 8.4.37 | Service-Result ..... | 60 | +| 8.4.38 | Service-Result-Code ..... | 60 | +| 8.4.39 | CIR-Flags ..... | 60 | +| 8.4.40 | Supported-Services ..... | 61 | +| 8.4.41 | Supported-Monitoring-Events ..... | 61 | +| 8.4.42 | Reference-ID-Validity-Time ..... | 62 | +| 8.4.43 | Event-Handling ..... | 62 | +| 8.4.44 | NIDD-Authorization-Request ..... | 62 | +| 8.4.45 | NIDD-Authorization-Response ..... | 63 | +| 8.4.46 | DRMP ..... | 63 | +| 8.4.47 | Service-Report ..... | 63 | +| 8.4.48 | Node-Type ..... | 63 | +| 8.4.49 | Service-Selection ..... | 63 | +| 8.4.50 | S6t-HSS-Cause ..... | 64 | +| 8.4.51 | Enhanced-Coverage-Restriction ..... | 64 | +| 8.4.52 | Enhanced-Coverage-Restriction-Data ..... | 64 | +| 8.4.53 | Restricted-PLMN-List ..... | 64 | +| 8.4.54 | Allowed-PLMN-List ..... | 65 | +| 8.4.55 | Requested-Validity-Time ..... | 65 | +| 8.4.56 | Granted-Validity-Time ..... | 65 | +| 8.4.57 | NIDD-Authorization-Update ..... | 65 | +| 8.4.58 | Loss-Of-Connectivity-Reason ..... | 65 | +| 8.4.59 | Group-Reporting-Guard-Timer ..... | 66 | +| 8.4.60 | CIA-Flags ..... | 66 | +| 8.4.61 | Group-Report ..... | 66 | +| 8.4.62 | Group-Report-Item ..... | 66 | +| 8.4.63 | RIR-Flags ..... | 67 | +| 8.4.64 | Type-Of-External-Identifier ..... | 67 | + +| | | | +|------------------------------------------------------------------------------|---------------------------------------------|-----------| +| 8.4.65 | APN-Validity-Time ..... | 68 | +| 8.4.66 | Suggested-Network-Configuration ..... | 68 | +| 8.4.67 | Monitoring-Event-Report-Status ..... | 69 | +| 8.4.68 | PLMN-ID-Requested ..... | 69 | +| 8.4.69 | AdditionalIdentifiers ..... | 69 | +| 8.4.70 | NIR-Flags ..... | 69 | +| 8.4.71 | Reporting-Time-Stamp ..... | 70 | +| 8.4.72 | NIA-Flags ..... | 70 | +| 8.4.73 | Group-User-Identifier ..... | 70 | +| 8.4.74 | MTC-Provider-Info ..... | 70 | +| 8.4.75 | MTC-Provider-ID ..... | 71 | +| 8.4.76 | PDN-Connectivity-Status-Configuration ..... | 71 | +| 8.4.77 | PDN-Connectivity-Status-Report ..... | 71 | +| 8.4.78 | PDN-Connectivity-Status-Type ..... | 72 | +| 8.4.79 | Traffic-Profile ..... | 72 | +| 8.4.80 | Updated-Network-Configuration ..... | 72 | +| 8.4.81 | Battery-Indicator ..... | 73 | +| 8.4.82 | SCEF-Reference-ID-Ext ..... | 73 | +| 8.4.83 | SCEF-Reference-ID-for-Deletion-Ext ..... | 73 | +| 8.4.84 | Exclude-Identifiers ..... | 74 | +| 8.4.85 | Include-Identifiers ..... | 74 | +| Annex A (normative): Diameter overload control mechanism ..... | | 74 | +| A.1 | General ..... | 74 | +| A.2 | S6m interface ..... | 74 | +| A.2.1 | General ..... | 74 | +| A.2.2 | HSS behaviour ..... | 74 | +| A.2.3 | MTC-IWF behaviour ..... | 75 | +| A.3 | S6t interface ..... | 75 | +| A.3.1 | General ..... | 75 | +| A.3.2 | HSS behaviour ..... | 75 | +| A.3.3 | SCEF behaviour ..... | 75 | +| Annex B (Informative): Diameter overload control node behaviour ..... | | 76 | +| B.1 | Introduction ..... | 76 | +| B.2 | Message prioritisation over S6m ..... | 76 | +| B.3 | Message prioritisation over S6t ..... | 76 | +| Annex C (normative): Diameter message priority mechanism ..... | | 77 | +| C.1 | General ..... | 77 | +| C.2 | S6m, S6n, S6t interfaces ..... | 77 | +| Annex D (normative): Diameter load control mechanism ..... | | 78 | +| D.1 | General ..... | 78 | +| D.2 | S6m interface ..... | 78 | +| D.2.1 | General ..... | 78 | +| D.2.2 | HSS behaviour ..... | 78 | +| D.2.3 | MTC-IWF behaviour ..... | 78 | +| D.3 | S6t interface ..... | 78 | +| D.3.1 | General ..... | 78 | +| D.3.2 | HSS behaviour ..... | 78 | +| D.3.3 | SCEF behaviour ..... | 79 | +| Annex E (informative): Change history ..... | | 80 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document describes the Diameter-based interfaces between the HSS and other network elements involved in the architecture for interworking with packet data networks and applications, such as Machine-Type Communications (MTC). + +In particular, this document specifies the S6m interface between the Home Subscriber Server (HSS) and the MTC Interworking Function (MTC-IWF), the S6n interface between the HSS and the MTC-AAA and the S6t interface between the HSS and the Service Capability Exposure Function (SCEF). The procedures over those interfaces are defined in 3GPP TS 23.682 [2]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [3] Void. +- [4] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [5] IETF RFC 4960: "Stream Control Transport Protocol". +- [6] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx Interface; Signalling flows and Message Elements". +- [7] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol; protocol details ". +- [8] 3GPP TS 29.173: "Diameter-based SLh interface for Control Plane LCS". +- [9] IETF RFC 5234: "Augmented BNF for Syntax Specifications: ABNF". +- [10] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol". +- [11] 3GPP TS 23.003: "Numbering, addressing and identification". +- [12] 3GPP TS 29.338: "Diameter based protocols to support SMS capable MMEs". + +- [13] 3GPP TS 29.368: "Tsp interface protocol between the MTC Interworking Function (MTC-IWF) and Service Capability Server (SCS)". +- [14] 3GPP TS 29.272: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [15] IETF RFC 7683 : "Diameter Overload Indication Conveyance". +- [16] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging applications". +- [17] 3GPP TS 29.217: "Congestion Reporting Over Np Reference Point". +- [18] IETF RFC 5777: "Traffic Classification and Quality of Service (QoS) Attributes for Diameter". +- [19] 3GPP TS 23.007: "Restoration procedures". +- [20] IETF RFC 7944: "Diameter Routing Message Priority". +- [21] IETF RFC 5778: "Diameter Mobile IPv6: Support for Home Agent to Diameter Server Interaction". +- [22] IETF RFC 8583: "Diameter Load Information Conveyance". +- [23] IETF RFC 6733: "Diameter Base Protocol". +- [24] 3GPP TS 29.128: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) interfaces for interworking with packet data networks and applications". +- [25] 3GPP TS 29.154: "Service capability exposure functionality over Nt Reference point". +- [26] 3GPP TS 29.122: "T8 reference point for Northbound APIs". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|---------|----------------------------------------------| +| AAA | Authentication, Authorization and Accounting | +| ABNF | Augmented Backus-Naur Form | +| AVP | Attribute-Value Pair | +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| IANA | Internet Assigned Numbers Authority | +| MTC | Machine-Type Communications | +| MTC-IWF | MTC Interworking Function | +| NIDD | Non-IP Data Delivery | +| SCS | Services Capability Server | +| SCEF | Service Capability Exposure Function | + +# 4 General Description + +## 4.1 Introduction + +The S6m reference point between the MTC-IWF and the HSS, the S6n reference point between the MTC-AAA and the HSS, and the S6t reference point between the SCEF and the HSS, are defined in the 3GPP TS 23.682 [2]. + +This document describes the Diameter-based S6m, S6n and S6t related procedures, message parameters and protocol specification. + +An excerpt of the architecture for Machine-Type Communication, as defined in 3GPP TS 23.682 [2] is shown in Figure 4.1-1, where the relevant interfaces towards the HSS are highlighted. + +![Figure 4.1-1: 3GPP Architecture for Machine-Type Communication. The diagram shows the network architecture for Machine-Type Communication (MTC) between a UE and a Service Capability Server (SCS). The architecture is divided into HPLMN (Home PLMN) and VPLMN (Visited PLMN) by a dashed orange line. In the HPLMN, the HSS is connected to the MTC-AAA via S6n, to the MME/SGSN via S6a/d, to the SCEF via S6t, and to the MTC-IWF via S6m. The MTC-IWF is connected to the SMS-SC/GMSC/IWMSC via T4 and to the SCS via Tsp. The SCEF is connected to the MME/SGSN via T6a/b and to the IWK-SCEF via T7. In the VPLMN, the MME/SGSN is connected to the IWK-SCEF via T6ai/T6bi. The IWK-SCEF is connected to the MSC/MME/SGSN via T5a/b/c.](daa4a6fa7e2ba1954258f86b4928eb32_img.jpg) + +Figure 4.1-1: 3GPP Architecture for Machine-Type Communication. The diagram shows the network architecture for Machine-Type Communication (MTC) between a UE and a Service Capability Server (SCS). The architecture is divided into HPLMN (Home PLMN) and VPLMN (Visited PLMN) by a dashed orange line. In the HPLMN, the HSS is connected to the MTC-AAA via S6n, to the MME/SGSN via S6a/d, to the SCEF via S6t, and to the MTC-IWF via S6m. The MTC-IWF is connected to the SMS-SC/GMSC/IWMSC via T4 and to the SCS via Tsp. The SCEF is connected to the MME/SGSN via T6a/b and to the IWK-SCEF via T7. In the VPLMN, the MME/SGSN is connected to the IWK-SCEF via T6ai/T6bi. The IWK-SCEF is connected to the MSC/MME/SGSN via T5a/b/c. + +**Figure 4.1-1: 3GPP Architecture for Machine-Type Communication** + +In this architecture, the S6m reference point connects the MTC-IWF with the HSS, where the subscription information of the UE (e.g., an MTC device) is stored. This reference point allows the MTC-IWF to retrieve subscription data and to do any necessary mapping between different identities associated to the UE. + +The S6m interface shall allow the MTC-IWF to: + +- retrieve subscription information of the UE from the HSS, +- request routing information from the HSS, i.e. the address of the UE's serving nodes supporting SMS for the UE ; in this context serving nodes of the UE are the MSC or MME but not both, the SGSN, and the IP-SM-GW, +- retrieve the IMSI of the UE, +- retrieve the External Identifier of the UE associated to an Application Port Identifier, +- perform authorization of the Service Capability Server that is requesting to send a device trigger to the UE. + +Additionally, the S6n reference point connects the MTC-AAA with the HSS, and it allows the MTC-AAA to do the mapping of the UE IMSI to the external identifier(s) of the UE. + +The S6t reference point connects the SCEF with the HSS to perform configuration and reporting of Monitoring events, and configuration of AESE Communication Pattern. + +The S6t interface shall allow the SCEF to: + +- configure UE related Monitoring events +- receive reporting of the configured Monitoring events from the HSS +- configure UE related AESE Communication Pattern + +- Authorize the UE for NIDD. + +# --- 5 Diameter-based S6m/S6n Interface + +## 5.1 Introduction + +This clause describes the Diameter-based S6m and S6n interface related procedures and Information elements exchanged between functional entities. + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the "Cat." column. For the correct handling of the Information Element according to the category type, see the description detailed in clause 6 of the 3GPP TS 29.228 [6]. + +## 5.2 Procedure Descriptions + +### 5.2.1 Subscriber Information Retrieval + +#### 5.2.1.1 General + +This procedure is used between the MTC-IWF and the HSS and between the MTC-AAA and the HSS. + +When the procedure is invoked by the MTC-IWF, it is used: + +- To translate an external identifier, or MSISDN, to the IMSI of the user, +- To retrieve information about the serving entities currently serving a certain user, +- To authorize a certain SCS to request a specific service (e.g. device triggering), +- To retrieve subscription data of the user, associated to the specific service requested by the SCS, +- To retrieve an External Identifier based on IMSI and application port identifier. + +When the procedure is invoked by the MTC-AAA, it is used: + +- To translate an IMSI to one or more external identifiers of the user. + +This procedure is mapped to the commands Subscriber-Information-Request/Answer in the Diameter application specified in clause 6. Tables 5.2.1.1/1 and 5.2.1.1/2 detail the involved information elements. + +Table 5.2.1.1/1: Subscriber Information Retrieval (Request) + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(see 6.4.2) | User-Identifier | M | This Information Element shall contain the identity of the UE. This is a grouped AVP containing either an External Identifier, an MSISDN or an IMSI (exactly one, and only one, of those identifiers shall be included in the request). | +| Requested Service
(see 6.4.3) | Service-ID | O | This Information Element shall contain the service requested by the SCS. In this release, only the Device Triggering and SMS_MO services are supported.

For S6n (i.e., when the procedure is invoked by the MTC-AAA), this IE is not applicable, and shall be absent. | +| SCS Identity
(see 6.4.4) | SCS-Identity | O | This Information Element shall contain the identity of the Service Capability Server that is requesting a service to be applied to a certain UE.
When the Service-ID indicates DEVICE_TRIGGER (0) or SMS_MO (1), the SCS-Identity shall be formatted as an E.164 address as described in clause 6.4.4.

For S6n (i.e., when the procedure is invoked by the MTC-AAA), this IE is not applicable, and shall be absent. | +| Service Parameters
(see 6.4.5) | Service-Parameters | O | This Information Element shall contain the parameters associated to the requested service by the SCS (identified by the Service-ID AVP). In this release, only parameters associated to Device Triggering via SMS-MT (T4) and parameters associated to SMS_MO are supported.

For Device Triggering via SMS-MT, this AVP may contain: Priority-Indication, SM-RP-SMEA...
For SMS_MO, this parameter may contain: Application-Port Identifier.

For S6n (i.e., when the procedure is invoked by the MTC-AAA), this IE is not applicable, and shall be absent. | +| SIR Flags
(see 6.4.10) | SIR-Flags | M | This Information Element shall contain a bit mask. See clause 6.4.10 for the meaning of the bits. | +| Supported Features
(See 3GPP TS 29.229 [7]) | Supported-Features | O | If present, this Information Element shall contain the list of features supported by the origin host. | + +**Table 5.2.1.1/2: Subscriber Information Retrieval (Response)** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|--------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [23]).
Experimental-Result AVP shall be used for S6m/S6n errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| User Identity
(see 6.4.2) | User-Identifier | C | This information element shall contain the User Identity of the UE. This is a grouped AVP containing an External Identifier, an MSISDN, an IMSI, or other service-specific identities (such as an LMSI...).

There may be multiple instances of this IE in the response provided by the HSS.

This IE shall be present only when the Result- Code is DIAMETER_SUCCESS. | +| Service Data
(see 6.4.7) | Service-Data | C | This information element shall contain data related to the requested service and additional data specific to each triggering method.

In this release, only data associated to trigger delivery via SMS-MT (T4) is supported.

This IE shall be present only when the Requested Service IE was included in the request, and the Result- Code is DIAMETER_SUCCESS. | +| Supported Features
(See 3GPP TS 29.229 [7]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 5.2.1.2 Detailed Behaviour of the HSS + +When the Subscriber Information Retrieval request is received from the MTC-IWF, indicated by the S6m/S6n indicator, which shall be set, the HSS shall, in the following order: + +1. Check that the User Identity for whom data is asked exists in HSS. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the Subscriber Information Retrieval Response. +2. Check whether the requesting/receiving SCS is authorized to request/receive the specified service for the UE. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) in the Subscriber Information Retrieval Response. +3. Check that the requested service (e.g., device trigger) is present and authorized. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_SERVICE (5511) in the Subscriber Information Retrieval Response. +4. If the requested service is DEVICE\_TRIGGER, check whether the UE is currently registered in any serving node supporting SMS for the UE (MSC or MME which has registered as MSC but not both, SGSN, IP-SM-GW). If the user is not registered in any serving node, the HSS shall answer successfully, but it shall not include any Serving Node or Additional Serving Node(s) in the response; also, it shall indicate to the MTC-IWF that the user is absent, in the Subscriber Information Retrieval Response, by setting the relevant bit in the HSS-Cause IE. + +The HSS shall also check if the UE is known to be not reachable in the registered serving nodes (i.e. check MNRF, MNRG, and UNRI) and if the trigger delivery is requested with "non-priority"; if both are true, the HSS shall answer successfully, but it shall not include any Serving Node or Additional Serving Node(s) in the response, and it shall set the "Absent Subscriber" flag in the HSS-Cause IE. + +5. If the requested service is DEVICE\_TRIGGER, check whether the requested service cannot be delivered according to the user's provisioned teleservices and the user's active barring conditions. If so, the HSS shall answer successfully, but it should not include any Serving Node or Additional Serving Node(s) in the response, and it shall set accordingly the corresponding bits in the HSS-Cause IE (see clause 6.4.9). +6. If the requested service is SMS\_MO, check whether IMSI and Application Port Identifier are present in the request within User-Identifier and Service- Parameters AVPs. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_MISSING\_APPLICATION\_DATA (5598) in the Subscriber Information Retrieval Response. + +If there is an error in any of the above steps then the HSS shall stop processing and shall return the error code specified in the respective step. + +If the HSS cannot fulfil the received request for reasons not stated in the above steps (e.g. due to a database error), it shall stop processing the request and set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +Otherwise, the requested operation shall take place and the HSS shall return the Result-Code AVP set to DIAMETER\_SUCCESS. If the requested service is DEVICE\_TRIGGER, the HSS returns the network addresses of the registered serving nodes supporting SMS for the UE (MSC or MME that has registered as MSC but not both and/or SGSN and/or IP-SM-GW), if available (and not marked "not reachable" by MNRF, MNRG, or UNRI, unless priority was indicated) in the HSS, and the IMSI of the subscriber, and the corresponding data needed by the service requested by the SCS; if available, the MSISDN of the user shall also be returned by the HSS, along with the user's IMSI. If the requested service is SMS\_MO, the HSS returns the External-Identifier associated to the Application Port Identifier. + +When the Subscriber Information Retrieval request is received from the MTC-AAA, indicated by the S6m/S6n indicator, which shall be cleared, the HSS shall check: + +- That the User Identity IE is included in the request, and that it contains an IMSI; if other IEs are included in the request, they may be ignored by the HSS. +- Whether the user identified by that IMSI is known in the HSS. + +If it is known, the HSS shall answer successfully and return in the response one or several instances of the User Identity IE, each one containing either an External-Identifier or an MSISDN (if any of these identities are present in the subscriber profile in HSS), or the subscriber's IMSI (if the subscriber does not have any External Identifiers or MSISDNs assigned). + +If it is not known, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the Subscriber Information Retrieval Response. + +#### 5.2.1.3 Detailed Behaviour of the MTC-IWF + +When the MTC-IWF sends a Subscriber Information Retrieval request to the HSS, it shall set the S6m/S6n indicator bit in the SIR Flags IE. + +Upon receipt of a successful Subscriber Information Retrieval response for the DEVICE\_TRIGGER service, when multiple serving nodes are returned from HSS, the MTC-IWF should give a higher preference to the serving node included in the "Serving Node" IE, than to those serving nodes included in the list of "Additional Serving Node" IEs. + +Upon receipt of a successful Subscriber Information Retrieval response for the SMS\_MO service, the MTC-IWF shall use the retrieved External-Identifier for communication with the SCS via Tsp. + +#### 5.2.1.4 Detailed Behaviour of the MTC-AAA + +When the MTC-AAA sends a Subscriber Information Retrieval request to the HSS, it shall clear the S6m/S6n indicator bit in the SIR Flags IE. + +The MTC-AAA shall only include the User Identifier IE in the request, and it shall contain only the IMSI of the UE. + +# --- 6 Protocol Specification + +## 6.1 Introduction + +### 6.1.1 Use of Diameter Base Protocol + +The Diameter base protocol as specified in IETF RFC 6733 [23] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +### 6.1.2 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [4]. + +### 6.1.3 Accounting Functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the S6m interface. + +### 6.1.4 Use of Sessions + +Between the MTC-IWF and the HSS, Diameter sessions shall be implicitly terminated. An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol as specified in IETF RFC 6733 [23] includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [23]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +### 6.1.5 Transport Protocol + +Diameter messages over the S6m interface shall make use of SCTP IETF RFC 4960 [5] as transport protocol. + +### 6.1.6 Routing Considerations + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host. + +The S6m reference point is defined as an intra-operator interface so, both MTC-IWF and HSS shall be located in the same network domain/realm. + +If the MTC-IWF knows the address/name of the HSS for a certain user, both the Destination-Realm AVP and the Destination-Host AVP shall be present in the request. Otherwise, only the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node. Consequently, the Destination-Host AVP is declared as optional in the ABNF for all requests initiated by the MTC-IWF. + +Destination-Realm AVP is declared as mandatory in the ABNF for all requests. + +I If the Vendor-Specific-Application-ID AVP is received in any of the commands, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +### 6.1.7 Advertising Application Support + +The HSS and the MTC-IWF shall advertise support of the Diameter S6m Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [23]. + +### 6.1.8 Diameter Application Identifier + +The S6m/S6n interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the S6m interface application is 16777310 (allocated by IANA). + +### 6.1.9 Use of the Supported-Features AVP + +When new functionality is introduced on the S6m application, it should be defined as optional. If backwards incompatible changes can not be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. The usage of the Supported-Features AVP on the S6m application is consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [7]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [7], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +### 6.1.10 User Identity to HSS resolution + +The User identity to HSS resolution mechanism enables the MTC-IWF to find the identity of the HSS that holds the subscription data for the target user when multiple and separately addressable HSSs have been deployed in the home network. The resolution mechanism is not required in networks that utilise a single HSS. + +This User identity to HSS resolution mechanism may rely on routing capabilities provided by Diameter and be implemented in the home operator network within dedicated Diameter Agents (Redirect Agents or Proxy Agents) responsible for determining the HSS identity based on the provided user identity (e.g., external identifiers provided by the MTC-IWF). + +When the Diameter Load Control mechanism is supported (see IETF RFC 8583 [22]), load values from previously received Load AVPs of type HOST may be taken into account when determining the HSS identity. + +NOTE: Alternatives to the user identity to HSS resolution Diameter based implementation are outside the scope of this specification. + +## 6.2 Commands + +### 6.2.1 Introduction + +This clause defines the Command code values and related ABNF for each command described in this specification. + +### 6.2.2 Command-Code values + +This clause defines Command-Code values for the S6m/S6n interface application as allocated by IANA. + +Every command is defined by means of the ABNF syntax IETF RFC 5234 [9], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [23]. When the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [23] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with the IETF RFC 6733 [23]. + +The following Command Codes are defined in this specification: + +**Table 6.2.2/1: Command-Code values for S6m/S6n** + +| Command-Name | Abbreviation | Code | Clause | +|--------------------------------|--------------|---------|--------| +| Subscriber-Information-Request | SIR | 8388641 | 6.2.3 | +| Subscriber-Information-Answer | SIA | 8388641 | 6.2.4 | + +For these commands, the Application-ID field shall be set to 16777310 (application identifier of the S6m/S6n interface application, allocated by IANA). + +### 6.2.3 Subscriber-Information-Request (SIR) Command + +The Subscriber-Information-Request (SIR) command, indicated by the Command-Code field set to 8388641 and the "R" bit set in the Command Flags field, is sent from the MTC-IWF to the HSS or from the MTC-AAA to the HSS. + +Message Format: + +``` +< Subscriber-Information-Request > ::= < Diameter Header: 8388641, REQ, PXY, 16777310 > +< Session-Id > +[ DRMP ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Destination-Host ] +{ Destination-Realm } +{ User-Identifier } +[ Service-ID ] +[ SCS-Identity ] +[ Service-Parameters ] +{ SIR-Flags } +[ OC-Supported-Features ] +*[ Supported-Features ] +*[ Proxy-Info ] +*[ Route-Record ] +*[ AVP ] +``` + +### 6.2.4 Subscriber-Information-Answer (SIA) Command + +The Subscriber-Information-Answer (SIA) command, indicated by the Command-Code field set to 8388641 and the "R" bit cleared in the Command Flags field, is sent from the HSS to the MTC-IWF or from the HSS to the MTC-AAA. + +Message Format: + +``` +< Subscriber-Information-Answer > ::= < Diameter Header: 8388641, PXY, 16777310 > + < Session-Id > + [ DRMP ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + *[ User-Identifier ] + [ Service-Data ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ AVP ] +``` + +## 6.3 Result-Code AVP and Experimental-Result AVP Values + +### 6.3.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 6.3.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in Diameter base protocol as specified in IETF RFC 6733 [23] shall be applied. + +### 6.3.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in Diameter base protocol as specified in IETF RFC 6733 [23] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 6.3.3.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the HSS to indicate that the user identified by the IMSI, MSISDN, or External-Identifier is unknown. This error code is defined in 3GPP TS 29.229 [7]. + +#### 6.3.3.2 DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) + +This result code shall be sent by the HSS to indicate that the SCS is not allowed to request control plane services for an UE, to the MTC-IWF. + +#### 6.3.3.3 DIAMETER\_ERROR\_UNAUTHORIZED\_SERVICE (5511) + +This result code shall be sent by the HSS to indicate that the specific service requested by the SCS is not allowed for an UE, or that it cannot be delivered according to the current subscribed services of the UE. + +## 6.4 AVPs + +### 6.4.1 General + +The following table specifies the Diameter AVPs defined for the S6m/S6n interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +**Table 6.4.1/1: S6m/S6n specific Diameter AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | May Encr. | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------|------------------|----------------|-----|------------|----------|-----------| +| | | | | Must | May | Should not | Must not | | +| IP-SM-GW-Number | 3100 | 6.4.14 | OctetString | M,V | | | | No | +| IP-SM-GW-Name | 3101 | 6.4.15 | DiameterIdentity | M,V | | | | No | +| User-Identifier | 3102 | 6.4.2 | Grouped | M,V | | | | No | +| Service-ID | 3103 | 6.4.3 | Enumerated | M,V | | | | No | +| SCS-Identity | 3104 | 6.4.4 | OctetString | M,V | | | | No | +| Service-Parameters | 3105 | 6.4.5 | Grouped | M,V | | | | No | +| T4-Parameters | 3106 | 6.4.6 | Grouped | M,V | | | | No | +| Service-Data | 3107 | 6.4.7 | Grouped | M,V | | | | No | +| T4-Data | 3108 | 6.4.8 | Grouped | M,V | | | | No | +| HSS-Cause | 3109 | 6.4.9 | Unsigned32 | M,V | | | | No | +| SIR-Flags | 3110 | 6.4.10 | Unsigned32 | M,V | | | | No | +| External-Identifier | 3111 | 6.4.11 | UTF8String | M,V | | | | No | +| IP-SM-GW-Realm | 3112 | 6.4.18 | DiameterIdentity | M,V | | | | No | +| NOTE 1: The AVP header bit denoted as "M" indicates whether support of the AVP is required. The AVP header bit denoted as "V" indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [23]. | | | | | | | | | +| NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. | | | | | | | | | + +The following table specifies the Diameter AVPs re-used by the S6m/S6n interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within S6m/S6n. + +Any other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol as specified in IETF RFC 6733 [23], do not need to be supported. The AVPs from Diameter base protocol as specified in IETF RFC 6733 [23] are not included in table 6.4.1/2, but they may be re-used for the S6m/S6n protocol. + +**Table 6.4.1/2: S6m/S6n re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | +|-----------------------------|---------------------|------------------------------------------------------------------------| +| User-Name | IETF RFC 6733 [23] | This AVP shall contain the IMSI of the UE, in the User-Identifier AVP. | +| MSISDN | 3GPP TS 29.329 [10] | | +| LMSI | 3GPP TS 29.173 [8] | | +| Serving-Node | 3GPP TS 29.173 [8] | see 6.4.12 | +| Additional-Serving-Node | 3GPP TS 29.173 [8] | see 6.4.13 | +| Supported-Features | 3GPP TS 29.229 [7] | | +| Feature-List-ID | 3GPP TS 29.229 [7] | | +| Feature-List | 3GPP TS 29.229 [7] | | +| SM-RP-SMEA | 3GPP TS 29.338 [12] | | +| Priority-Indication | 3GPP TS 29.368 [13] | | +| MME-Number-for-MT-SMS | 3GPP TS 29.272 [14] | | +| OC-Supported-Features | IETF RFC 7683 [15] | See 6.4.16 | +| OC-OLR | IETF RFC 7683 [15] | See 6.4.17 | +| DRMP | IETF RFC 7944 [20] | see clause 6.4.19 | +| Application-Port-Identifier | 3GPP TS 29.368 [13] | | +| Load | IETF RFC 8583 [22] | See 6.4.20 | + +### 6.4.2 User-Identifier + +The User-Identifier AVP is of type Grouped and it contains the different identifiers used by the UE. + +AVP format: + +User-Identifier ::= + +[ User-Name ] + +[ MSISDN ] + +[ External-Identifier ] + +[ LMSI ] + +\*[AVP] + +This AVP shall contain at least one of the identifiers used by the UE, i.e., it shall not be empty. The IMSI of the UE shall be included (when applicable) in the User-Name AVP. + +### 6.4.3 Service-ID + +The Service-ID AVP is of type Enumerated and it shall identify the service requested by the SCS. The following values are defined: + +DEVICE\_TRIGGER (0) + +The SCS requests a control plane device triggering to the UE. . + +SMS\_MO (1) + +The UE (identified by IMSI and application port identifier) requests SMS\_MO to be delivered to the SCS. + +### 6.4.4 SCS-Identity + +The SCS-Identity AVP is of type OctetString and it shall contain the identity of the SCS or UE which originated the service request towards the MTC-IWF, over the Tsp reference point. + +The encoding of the SCS-Identity AVP is defined per SCS service. + +For the device triggering service, the SCS-Identity AVP shall contain the ISDN number of the SCS in international ISDN number format as described in ITU-T Rec E.164 [41]. It shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan. + +### 6.4.5 Service-Parameters + +The Service-Parameters AVP is of type Grouped, and it contains the service-specific parameters related to the requested service. + +AVP format: + +Service-Parameters ::= +[ T4-Parameters ] +[ Application-Port-Identifier ] +\*[AVP] + +### 6.4.6 T4-Parameters + +The T4-Parameters AVP is of type Grouped. + +AVP format: + +T4-Parameters ::= +[ Priority-Indication ] +[ SM-RP-SMEA ] +\*[AVP] + +### 6.4.7 Service-Data + +The Service-Data AVP is of type Grouped, and it contains the service-specific data related to the device triggering request handled by the MTC-IWF. + +Service-Data ::= +[ T4-Data ] +\*[AVP] + +### 6.4.8 T4-Data + +The T4-Data AVP is of type Grouped and it shall contain information about the network node(s) serving the targeted user for SMS, i.e. the names/numbers of the serving nodes (MSC or MME, SGSN, IP-SM-GW) which allow the trigger delivery. AVP format: + +T4-Data ::= +[ HSS-Cause ] +[ Serving-Node ] +\*[ Additional-Serving-Node ] +\*[AVP] + +When the HSS-Cause indicates Absent Subscriber, via the corresponding flag in the bit mask, the Serving-Node and Additional-Serving-Node AVPs shall not be present. When the HSS-Cause indicates Teleservice Not Provisioned or + +Call Barred, via the corresponding flag in the bit mask, the Serving-Node and Additional-Serving-Node AVPs should not be present. Additional-Serving-Node AVP shall be absent if Serving-Node AVP is absent. + +### 6.4.9 HSS-Cause + +The HSS-Cause AVP is of type Unsigned32 and it contains a bit mask. The meaning of the bits is defined in table 6.4.9/1: + +**Table 6.4.9/1: HSS-Cause** + +| Bit | Name | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Absent Subscriber | This bit, when set, indicates that there is no serving node registered in the HSS over which the corresponding triggering method should be immediately attempted for the user. NOTE 1. | +| 1 | Teleservice Not Provisioned | This bit, when set, indicates that the required teleservice(s) for the corresponding triggering method are not provisioned in the HSS/HLR for the user. | +| 2 | Call Barred | This bit, when set, indicates that the user has an active barring condition which makes it impossible to deliver the corresponding triggering method. | +| NOTE 1: This may be caused because there is not any serving node currently registered in HSS for the user, or because the user is known to be absent in all suitable registered serving nodes (based on MNRF, MNRG and UNRI flags) and the trigger delivery is requested with "non-priority". | | | +| NOTE 2: Bits not defined in this table shall be cleared by the HSS and discarded by the receiving node, MTC-IWF. | | | + +### 6.4.10 SIR-Flags + +The SIR-Flags AVP is of type Unsigned32 and it contains a bit mask. The meaning of the bits is defined in table 6.4.10/1: + +**Table 6.4.10/1: SIR-Flags** + +| bit | name | Description | +|------------------------------------------------------------------------------------------------------------------------------------|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | S6m/S6n Indicator | This bit, when set, indicates that the SIR message is sent on the S6m interface, i.e. the source node is an MTC-IWF.
This bit, when cleared, indicates that the SIR message is sent on the S6n interface, i.e. the source node is an MTC-AAA. | +| Note: Bits not defined in this table shall be cleared by the sending node, MTC-IWF or MTC-AAA, and discarded by the receiving HSS. | | | + +### 6.4.11 External-Identifier + +The External-Identifier AVP is of type UTF8String. For S6m/S6n interface it shall contain an external identifier of the UE. See 3GPP TS 23.003 [11] for the definition and formatting of the External Identifier. For S6t interface, it shall contain an external identifier for an individual UE or a group of UEs, as indicated by Type-Of-External-Identifier AVP. See 3GPP TS 23.003 [11] for the definition and formatting of the External Group Identifier. + +### 6.4.12 Serving-Node + +The Serving-Node AVP is of type Grouped and it shall contain the name/number of the serving node to be used for T4-triggering. It is originally defined in 3GPP TS 29.173 [8]. + +Serving-Node ::= + +[ SGSN-Name ] + +[ SGSN-Realm ] + +[ SGSN-Number ] + +[ MME-Name ] + [ MME-Realm ] + [ MME-Number-for-MT-SMS ] + [ MSC-Number ] + [ IP-SM-GW-Number ] + [ IP-SM-GW-Name ] + [ IP-SM-GW-Realm ] + \*[AVP] + +The following combinations are allowed: + +- a) SGSN-Number +- b) SGSN-Name & SGSN-Realm & SGSN-Number if the HSS supports the "Gdd in SGSN" feature and has received the "Gdd in SGSN" indication over S6a or Gr interface from the SGSN (cf. 3GPP TS 29.272 [4] and 3GPP TS 29.002 [9]) +- c) MME-Name & MME-Realm & MME-Number-for-MT-SMS +- d) MSC-Number +- e) MSC-Number & MME-Name & MME-Realm +- f) IP-SM-GW-Number +- g) IP-SM-GW-Number & IP-SM-GW-Name & IP-SM-GW-Realm + +### 6.4.13 Additional-Serving-Node + +The Additional-Serving-Node AVP is of type Grouped and when present it shall contain the name/number of an additional serving node to be used for T4-triggering. It is originally defined in 3GPP TS 29.173 [8], + +Additional-Serving-Node ::= + +[ SGSN-Name ] + [ SGSN-Realm ] + [ SGSN-Number ] + [ MME-Name ] + [ MME-Realm ] + [ MME-Number-for-MT-SMS ] + [ MSC-Number ] + \*[AVP] + +The following combinations are allowed: + +- a) SGSN-Number +- b) SGSN-Name & SGSN-Realm & SGSN-Number if the HSS supports the "Gdd in SGSN" feature and has received the "Gdd in SGSN" indication over S6a or Gr interface from the SGSN (cf. 3GPP TS 29.272 [4] and 3GPP TS 29.002 [9]) +- c) MME-Name & MME-Realm & MME-Number-for-MT-SMS + +- d) MSC-Number +- e) MSC-Number & MME-Name & MME-Realm + +### 6.4.14 IP-SM-GW-Number + +The IP-SM-GW-Number AVP is of type OctetString and it shall contain the ISDN number of the IP-SM-GW in international number format as described in ITU-T Rec E.164 [41]. It shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan. + +### 6.4.15 IP-SM-GW-Name + +The IP-SM-GW-Name AVP is of type DiameterIdentity and it shall contain the Diameter identity of the registered IP-SM-GW. For further details on the encoding of this AVP, see IETF RFC 3588 [5]. + +### 6.4.16 OC-Supported-Features + +The OC-Supported-Features AVP is of type Grouped and it is defined in IETF RFC 7683 [15]. This AVP is used to support Diameter overload control mechanism, see Annex A for more information. + +### 6.4.17 OC-OLR + +The OC-OLR AVP is of type Grouped and it is defined in IETF RFC 7683 [15]. This AVP is used to support Diameter overload control mechanism, see Annex A for more information. + +### 6.4.18 IP-SM-GW-Realm + +The IP-SM-GW-Realm AVP is of type DiameterIdentity and it shall contain the Diameter identity of the registered IP-SM-GW's realm. For further details on the encoding of this AVP, see IETF RFC 3588 [5]. + +### 6.4.19 DRMP + +The DRMP AVP is of type Enumerated and it is defined in IETF RFC 7944 [20]. This AVP allows the HSS and the MTC-IWF over the S6m interface and the HSS and the MTC-AAA over the S6n interface to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +### 6.4.20 Load + +The Load AVP is of type Grouped and it is defined in IETF RFC 8583 [22]. This AVP is used to support the Diameter load control mechanism. + +# --- 7 Diameter-based S6t Interface + +## 7.1 Introduction + +This clause describes the Diameter-based S6t interface related procedures and Information elements exchanged between functional entities. + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the "Cat." column. For the correct handling of the Information Element according to the category type, see the description detailed in clause 6 of the 3GPP TS 29.228 [6]. + +## 7.2 Procedure Descriptions + +### 7.2.1 Configuration Information on S6t + +#### 7.2.1.1 General + +This procedure is used between the SCEF and the HSS for: + +- the configuration/deletion of Monitoring events for a UE or a Group of UEs; +- the deletion or addition of configured Group-based Monitoring events for certain UE(s) in a Group of UEs; +- the configuration/deletion of Communication Patterns; +- the configuration/query of Enhanced Coverage Restrictions; +- the configuration of Network Configuration parameters; +- the translation of an External Group Identifier(s) to IMSI Group Id(s). + +The following events may be configured for monitoring: + +- Association of the UE and UICC and/or new IMSI-IMEI-SV association; +- UE reachability; +- Location of the UE, and change in location of the UE; +- Loss of connectivity; +- Communication failure; +- Roaming status (i.e. Roaming or No Roaming, identity of the PLMN serving the UE) of the UE, and change in roaming status of the UE; +- Availability after DDN failure; +- Idle Status Indication in addition to UE reachability or Availability after DDN failure; +- PDN Connectivity Status. + +This procedure is mapped to the commands Configuration-Information-Request/Answer in the Diameter application specified in clause 8. The tables 7.2.1.1-1 and 7.2.1.1-2 detail the involved information elements. + +Table 7.2.1.1-1: Configuration Information Request + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------|---------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(see 6.4.2) | User-Identifier | M | This Information Element shall contain the identity of the UE or the identity of a group of UEs. This is a grouped AVP containing either an External Identifier or an MSISDN (exactly one, and only one, of those identifiers shall be included in the request).
When requesting event monitoring configuration for a group of UEs, and when requesting translation from External Group Identifier to IMSI Group ID, the SCEF shall include the External Group Identifier (see 3GPP TS 23.003 [11]) in the External-Identifier AVP. | +| Group Reporting Guard Timer (See 8.4.59) | Group-Reporting-Guard-Timer | C | If present, this Information Element indicates that the collected Status Indications and/or reports for UEs belonging to a group shall be reported no later than at the interval indicated by the Group Reporting Guard Timer.
Shall be present if the User-Identifier contains an External Group Identifier. | +| Supported Features
(See 3GPP TS 29.229 [7]) | Supported-Features | O | If present, this Information Element shall contain the list of features supported by the origin host. | +| Monitoring Event Configuration
(see 8.4.2) | Monitoring-Event-Configuration | O | If present, this Information Element shall contain the details of Monitoring event(s). Multiple instances covering different monitoring events may be present. | +| AESE Communication Pattern
(see 8.4.25) | AESE-Communication-Pattern | O | If present, this Information Element shall contain the details of Communication Pattern(s). Multiple instances covering different communication patterns may be present. | +| CIR-Flags
(see 8.4.39) | CIR-Flags | O | If present, this Information Element shall contain a bit mask. See 8.4.39 for the meaning of the bits. | +| Enhanced Coverage Restriction
(see 8.4.51) | Enhanced-Coverage-Restriction | O | If present, this Information Element shall contain the updates of the Enhanced Coverage Restriction. | +| Suggested Network Configuration
(see 8.4.66) | Suggested-Network-Configuration | O | If present, this Information Element shall contain the suggested network configuration. | +| Additional Identifiers
(see 8.4.69) | AdditionalIdentifiers | C | If the request is used to retrieve multiple IMSI Group IDs for multiple External Group Identifiers, this information element shall be present and shall contain all the External Group Identifiers for which the IMSI Group IDs are requested, except the one conveyed in the User-Identifier AVP. | + +Table 7.2.1.1-2: Configuration Information Answer + +| Information Element Name | Mapping to Diameter AVP | Cat | Description | +|----------------------------------------------------------|------------------------------------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [23]).
Experimental-Result AVP shall only be used for S6t errors which are applicable regardless of the services requested (e.g. DIAMETER_ERROR_USER_UNKNOWN). This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
Otherwise, this IE shall reflect the outcome of the procedure at Diameter base protocol level and Result-Code AVP shall be used. | +| User Identity
(see 6.4.2) | User-Identifier | C | This information element shall contain the User Identity of the UE.
This is a grouped AVP containing an External Identifier or an MSISDN for a UE.
This IE shall not be present if the External-Identifier of User-Identifier in CIR message contains the identity of a Group of UEs (i.e. External Group Identifier).
This IE shall be present only when the Result-Code is DIAMETER_SUCCESS. | +| Number of UEs
(See 3GPP TS 29.154 [25]) | Number-of-UEs | C | This IE shall contain the number of UEs belonging to the group of UEs.
This IE shall be present if the External-Identifier of User-Identifier in CIR message contains the identity of a Group of UEs (i.e. External Group Identifier). | +| Supported Features
(See 3GPP TS 29.229 [7]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Monitoring Event Report
(see 8.4.3) | Monitoring-Event-Report | O | If an immediate report is available this information element shall contain the requested data available in the HSS. | +| AESE Communication Pattern Config Status
(see 8.4.32) | AESE-Communication-Pattern-Config-Status | O | If present, this Information Element shall contain the details of Communication Pattern-Config-Status (s). Multiple instances covering different communication patterns configuration statuses may be present. | +| Monitoring Event-Config Status
(see 8.4.24) | Monitoring-Event-Config-Status | C | This IE shall be present if Monitoring Event Configuration IE is included in CIR and if the Result-Code AVP in Configuration Information Answer is DIAMETER_SUCCESS. Multiple instances of this IE may be present; they shall contain the configuration status for all monitoring event configurations that were requested. | +| Supported Services
(see 8.4.40) | Supported-Services | O | If present, this Information Element shall contain AVPs indicating details of the services supported by the HSS and authorized for the requesting SCEF.
This Information Element may additionally contain AVPs with the services supported by the serving node(s), if they are known to the HSS. | +| S6t-HSS Cause
(see 8.4.50) | S6t-HSS-Cause | C | This information element shall contain an indication of Absent Subscriber. It shall be present if the user is not registered in any serving node. | +| Enhanced Coverage Restriction Data
(see 8.4.52) | Enhanced-Coverage-Restriction-Data | C | This information element shall contain the result of a status query for Enhanced Coverage restriction control. It shall be present if the request contained a CIR-Flag AVP with the bit for Enhanced-Coverage-Query set. | +| CIA-Flags
(see 8.4.60) | CIA-Flags | O | If present, this Information Element shall contain a bit mask. See 8.4.60 for the meaning of the bits. | +| Active Network Configuration
(see 8.4.66) | Suggested-Network-Configuration | O | If present, this Information Element shall contain the parameters which are active in the HSS. | +| IMSI Group Id
(See 3GPP TS 29.272 [14]) | IMSI-Group-Id | C | This information element shall be present if the CIR-Flag for IMSI Group Retrieval was set in the request and the Result-Code is DIAMETER_SUCCESS. | + +In the following clauses (7.2.1.2 and 7.2.1.3), if the feature "Extended Reference IDs" (see clause 8.4.23.1) is supported by the SCEF and the HSS, the term "SCEF Reference ID" shall refer to the content of the 64-bit long "SCEF-Reference-ID-Ext" AVP, and the term "SCEF Reference ID for Deletion" shall refer to the content of the 64-bit long "SCEF-Reference-ID-for-Deletion-Ext" AVP. + +#### 7.2.1.2 Detailed Behaviour of the HSS + +When the Configuration Information Request is received from the SCEF, the HSS shall, in the following order: + +1. Check that the User Identity for whom data is asked exists in HSS. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN (5001) in the Configuration Information Answer. +2. Check whether the requesting SCEF is authorized to request the specified service (e.g. presence of Monitoring Event Configuration AVPs indicates the MONTE service). If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) in the Configuration Information Answer. +- 2a. If the MTC Provider Information is received, check if the MTC Provider ID is authorized for the UE or the group of UEs. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_MTC\_PROVIDER (5516) in the Configuration Information Answer. +3. Check that the requested service (e.g. MONTE, indicated by the presence of Monitoring-Event-Configuration AVPs, or Communication Pattern, indicated by the presence of AESE-Communication-Pattern AVP) is authorized for the UE or the group of UEs. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_SERVICE (5511) in the Configuration Information Answer. +- 3a. If the request is IMSI Group Id Retrieval (as indicated by the CIR-Flags AVP), the HSS shall return the IMSI Group Id(s) in the order of sequence that corresponds to the order of sequence of the received External Group Identifier(s) received in the User-Identifier AVP and AdditionalIdentifiers AVP. The Result Code shall be set to DIAMETER\_SUCCESS. Stop processing. + +Otherwise, continue to step 4. + +NOTE: Applicable steps 4-8 are performed for each monitoring event type or communication pattern requested. + +4. Check whether the limits on number of monitoring events that can be requested per monitoring type and SCEF-ID is reached. If so, Result-Code in Monitoring-Event-Config-Status for the affected service(s) shall be set to DIAMETER\_RESOURCES\_EXCEEDED (5006). The Result-Code shall be set to DIAMETER\_SUCCESS in the Configuration Information Answer. +- 4a. Check whether the requesting SCEF is authorized to request the specific service configuration(s) (e.g. Monitoring Event Type indicates a specific monitoring event configuration). If not, Experimental-Result-Code in Monitoring-Event-Config-Status for the affected service configuration(s) shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510). The Result-Code shall be set to DIAMETER\_SUCCESS in the Configuration Information Answer. +- 4b. Check that the requested specific service configuration(s) (e.g. Monitoring Event Type) is authorized for the UE or the group of UEs. If not, Experimental-Result-Code in Monitoring-Event-Config-Status for the affected service(s) shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_SERVICE (5511). The Result-Code shall be set to DIAMETER\_SUCCESS in the Configuration Information Answer. +5. When the request is for a group, i.e. because the External-Identifier AVP of the User-Identifier AVP contain an External Group Identifier, the HSS applies the Monitoring-Event-Configuration AVP to each UE of the Group and includes the CIA-Flags AVP with the Group-Configuration-In-Progress bit set in the Configuration Information Answer. The Result-Code shall be set to DIAMETER\_SUCCESS in the Configuration Information Answer. + +If the CIR command is to delete configured monitoring event(s) for certain UE(s) in a group of UEs, i.e. Monitoring-Event-Configuration AVP(s) containing Exclude-Identifier AVP, and the HSS supports Dynamic-Group-Event-Monitoring feature, the HSS shall cancel the monitoring event(s) for the UE(s) indicated by Exclude-Identifier AVP and keep monitoring events(s) for other UEs in the group, as specified in clause 5.6.1 of 3GPP TS 23.682 [2]. + +If the CIR command is to add configured monitoring event(s) for certain UE(s) in a group of UEs, i.e. Monitoring-Event-Configuration AVP(s) containing Include-Identifier AVP, and the HSS supports Dynamic-Group-Event-Monitoring feature, the HSS shall create the monitoring event(s) for the UE(s) indicated by Include-Identifier AVP, as specified in clause 5.6.1 of 3GPP TS 23.682 [2]. + +6. If a serving node is registered and is involved in the reporting of the configured monitoring event, the HSS shall forward the monitoring event configuration to the serving node and wait for the answer before sending the Configuration Information Answer to the SCEF. The monitoring event configuration status from the serving node for each event shall be conveyed by the HSS to the SCEF. The Result-Code shall be set to DIAMETER\_SUCCESS in the Configuration Information Answer. +7. If the user is not registered in any serving node or the user is purged in the registered serving node(s), the HSS shall store the configuration data related to the service; also, it shall indicate to the SCEF that the user is absent, in the Configuration Information Answer, by setting the relevant bit in the S6t-HSS-Cause IE. The Result-Code shall be set to DIAMETER\_SUCCESS in the Configuration Information Answer. +8. For Monitoring, if the data related to an immediate reporting is available in the HSS, the HSS (e.g. as being received from the MME/SGSN in the Insert Subscriber Data answer) shall include this data in the Configuration Information Answer. For Monitoring events that can be answered by the HSS without requiring interaction with the serving node (e.g. roaming status, IMEI-Change), the HSS shall respond immediately, either in the CIA or in an immediate RIR. + +If the HSS is aware that the UE is registered in an MME and an SGSN and the services supported by the MME and SGSN are different, the HSS shall additionally report the capabilities of the different nodes to the SCEF by including Supported-Services AVP(s) with the subset of services supported by the serving node(s) among those supported by the HSS, as indicated by the Node-Type AVP (e.g. HSS, MME). If the capabilities are the same reported from the MME, the SGSN and the HSS, the HSS shall report the service capabilities without Node-Type to the SCEF. If the Supported-Services of the SGSN and MME are different and the UE is purged in SGSN or MME the HSS shall report the Supported-Services to the SCEF excluding the Supported-Services from the purged node. + +If the HSS receives CIR command from SCEF and has sent IDR commands over S6a/S6d to an MME and an SGSN, the HSS shall check the Result-Codes in Monitoring-Event-Config-Status AVPs reported by the MME and the SGSN: + +- if they are different, the HSS shall include both Service-Report AVPs with the respective Node-Type (indicating the type of serving node) in the Monitoring-Event-Config-Status AVP to the SCEF in the CIA command; +- otherwise, the HSS shall include one Service-Report AVP without Node-Type in the Monitoring-Event-Config-Status AVP to the SCEF in the CIA command. + +If the configuration data in the CIR command are out of the allowed range, the HSS shall set the Experimental-Result-Code in Monitoring-Event-Config-Status for the affected service(s) to DIAMETER\_ERROR\_REQUESTED\_RANGE\_IS\_NOT\_ALLOWED (5512). + +If the received SCEF Reference ID for Deletion does not exist, the HSS shall set the Experimental-Result-Code in Monitoring-Event-Config-Status for the affected service(s) to DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_NON\_EXISTANT (5514). + +If the SCEF Reference ID exists and the old configuration data could not be replaced by new Configuration event data, the HSS shall set the Experimental-Result-Code in Monitoring-Event-Config-Status for the affected service(s) to DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_STORAGE\_NOT\_SUCCESSFUL (5513). + +If the HSS cannot fulfil the received request for reasons not stated in the above steps (e.g. due to a database error), it shall stop processing the request and set Result-Code in Configuration Information Answer to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the HSS detects that configuration data provided by a Monitoring-Event-Configuration are overwritten by a CIR command and both configurations were initiated by the same SCEF, the HSS shall include in the CIA command the Monitoring Event Report AVP including the SCEF Reference ID and SCEF Reference ID for Deletion of the overwritten configuration data. + +If the HSS needs to report loss of connectivity it shall include the Monitoring-Type AVP set to "LOSS\_OF\_CONNECTIVITY" in the Monitoring Event Report. In addition, the HSS may also include the Loss-Of-Connectivity-Reason AVP in the Monitoring Event Report. + +For the "CHANGE\_OF\_IMSI\_IMEI(SV)\_ASSOCIATION" event type, if there was no previous IMEI(SV) information stored in the HSS, and a new IMEI(SV) is received from the MME/SGSN, this is equivalent to a change of IMEI(SV) + +and the corresponding event shall be reported, by setting the "IMEI" flag (bit 0) in the IMEI-Change AVP, as described in clause 8.4.22. + +For the "ROAMING\_STATUS" event type, if there was no previous roaming status information stored in the HSS, and a certain PLMN ID value is received from the MME/SGSN, this is equivalent to a change of roaming status and the corresponding event shall be reported. + +If the SCEF indicates the support of Monitoring event feature to the HSS and the HSS supports Monitoring. The HSS shall include the Supported-Services AVP with the Supported-Monitoring-Events AVP indicating the authorized monitoring events for the requesting SCEF in the CIA command. + +If CIR message includes multiple SCEF Reference ID and one, several or all SCEF Reference ID Monitoring events cannot be handled, or fail to be configured at the registered serving node(s), the HSS shall report all SCEF Reference ID requested to the SCEF with an appropriate Experimental-Result-Code or Result-Code in the Monitoring-Event-Config-Status AVP(s). + +NOTE: In order to avoid reattempts from the SCS/AS when some configuration failed at the serving node(s), based on operator's choice, the HSS can still store the configuration data, return a successful response to SCEF and report the SCEF with monitoring event(s) suspended. The configuration data can then be forwarded whenever traffic is received from MME/SGSN and event(s) can be reported to SCEF as resumed, as described in clause 7.2.2. + +If a CIR message includes multiple SCEF Reference ID and for a SCEF Reference ID at least one CP parameter set cannot be handled, the HSS shall reply within the AESE-Communication-Pattern-Config-Status all SCEF Reference ID requested to the SCEF with an appropriate Experimental-Result-Code or Result-Code. + +If an SCEF Reference ID received in a CIR command match with an SCEF Reference ID stored in the HSS and both SCEF Reference ID are provided by the same SCEF ID, the HSS shall delete the stored CP sets associated with the SCEF reference Id and store the new CP set(s). + +If the CIR message contains combinations of monitoring events and CP parameter set it shall handle each set belonging to an SCEF Reference ID separately and shall send a combined answer to the SCEF with all SCEF Reference IDs requested. + +If the SCEF Reference ID for Deletion is present, the receiving node shall delete the corresponding configuration, if stored. + +If the SCEF Reference ID is present, the receiving node shall store the configuration event. + +If the CIR message contains the CIR-Flags with delete all monitoring events, the HSS shall delete all Monitoring events configured by the SCEF for the subscriber. This includes forwarding the deletion to involved serving nodes. In this case the CIR message shall not contain new monitoring events. + +If the CIR message contains the CIR-Flags with delete all communication pattern, and the feature Config-Eff-CP is supported, the HSS shall delete all Communication Pattern configured by the SCEF for the subscriber. This includes forwarding the deletion to involved serving nodes. In this case the CIR message shall not contain new communication pattern. + +If the CIR message contains the CIR-Flags with delete all network parameter configurations, and the feature Config-Eff-NP is supported, the HSS shall delete all Suggested Network Configurations configured by the SCEF for the subscriber. This includes the updating of involved serving nodes. In this case the CIR message shall not contain new network parameter configurations. + +If the CIR command contains the CIR-Flags AVP with the bit for Enhanced Coverage Query set, the HSS shall return the current settings of Enhanced Coverage together with the current Serving PLMN-ID (if any) in the CIA command. + +If the CIR command contains Enhanced-Coverage-Restriction AVP, the HSS shall update the subscription data for Enhanced Coverage; the update shall be a complete replacement of any stored information with the received information. This may result in the need to update the MME/SGSN via S6a/d/MAP-Gr with the new value for access restriction; there is however no need for the HSS to delay sending of CIA until updates of serving nodes are confirmed. + +If the CIR command contains Suggested-Network-Configuration AVP to update a previous Suggested Network Configuration (i.e. the SCEF Reference ID matches with an SCEF Reference ID stored in the HSS and both SCEF Reference IDs are provided by the same SCEF ID), the HSS shall check whether the suggested parameters are acceptable, and if so, update the stored UE's subscription parameters accordingly. The update shall be a complete + +replacement of any stored information with the received information. This may result in Insert Subscriber Data Signalling towards the UE's serving node. If the HSS modifies parameters received in Suggested-Network-Configuration AVP, the HSS shall inform the SCEF about the active parameters. When the HSS did not modify parameters received in the Suggested-Network-Configuration AVP, the HSS shall return a Suggested-Network-Configuration AVP to the SCEF in CIA containing only SCEF Reference ID and SCEF-ID. + +If a Monitoring-Event-Report is included in a CIA command and the Monitoring-Event-Report is related to a One-time Monitoring event request, the HSS shall delete the related Monitoring event for the UE or the individual group member UE locally after sending the Monitoring-Event-Report. + +If the subscribed periodic RAU/TAU Timer, Active Time, Suggested number of downlink packets, or any combination was previously set by a different SCEF requests including the Monitoring-Event-Configuration AVP(s) or Suggested-Network-Configuration AVP identified by a different SCEF Reference ID for the same UE, the HSS shall accept the request as follows: + +- If the newly received the value of the Maximum-Detection-Time AVP or the Maximum-Latency AVP within the Monitoring-Event-Configuration AVP(s) or the value of the Subscribed-Periodic-RAU-TAU-Timer AVP within the Suggested-Network-Configuration AVP is lower than the provided subscribed periodic RAU/TAU timer, the HSS shall set the subscribed periodic RAU/TAU timer using the newly received value. +- If the newly received the value of Maximum-Response-Time AVP within the Monitoring-Event-Configuration AVP(s) or the value of the Active-Time AVP within the Suggested-Network-Configuration AVP is higher than the provided subscribed Active Time (i.e. previously provided Maximum Response Time), the HSS shall set the subscribed Active Time using the newly received value. +- If the DL-Buffering-Suggested-Packet-Count AVP is newly received within the Monitoring-Event-Configuration AVP(s) or Suggested-Network-Configuration AVP, the HSS shall set the subscribed Suggested number of downlink packets by adding the newly received value to the currently used value of Suggested number of downlink packets if the aggregated value is within the operator defined range. If the aggregated value is not within the operator defined range, the HSS shall set the subscribed Suggested number of downlink packets according to operator defined range. + +#### 7.2.1.3 Detailed Behaviour of the SCEF + +When the SCEF receives Monitoring-Event-Report AVP from the HSS in CIA command, it shall handle it according to the procedures defined in 3GPP TS 23.682 [2]. + +When the SCEF receives an AESE-Communication-Pattern-Config-Status AVP from the HSS in a CIA command, it shall handle it according to the procedures defined in 3GPP TS 23.682 [2]. If the SCEF has included a number of CP pattern sets with several SCEF reference IDs in the request, it shall handle each AESE-Communication-Pattern-Config-Status AVP separately according to the procedures defined in 3GPP TS 23.682 [2]. + +If the SCEF receives Supported-Services AVP(s), it shall only trigger those services which are supported and authorized by the HSS and the MME/SGSN. + +The SCEF shall store the Supported-Services received from the HSS and modify them, if the HSS reports change of capabilities. + +NOTE: It depends on SCEF implementation, if the SCEF triggers only those services which are supported in both nodes when the UE is registered in both the MME and the SGSN. + +When the SCEF needs to query the current settings of Enhanced Coverage Restriction, it shall send a CIR command to the HSS with the corresponding bit in the CIR-Flags AVP set, unless the SCEF knows that Enhanced Coverage Restriction Control is not supported by the HSS. + +When the SCEF needs to update the current settings of Enhanced Coverage Restriction, it shall send a CIR command to the HSS with the new values for Enhanced Coverage Restriction within the Enhanced-Coverage-Restriction AVP. + +The SCEF shall not query and update the current settings of Enhanced Coverage Restriction by means of a single CIR command. + +When the SCEF receives Suggested-Network-Configuration AVP from the HSS in CIA command, it shall handle it according to the procedures defined in 3GPP TS 23.682 [2]. Absence of Suggested-Network-Configuration AVP from + +CIA - while it was present in CIR – indicates that the HSS does not support and has ignored the Suggested-Network-Configuration received in CIR. + +### 7.2.2 Reporting on S6t + +#### 7.2.2.1 General + +This procedure is used between the HSS and the SCEF. + +When the procedure is invoked by the HSS, it is used for reporting: + +- The change of association of the UE and UICC and/or new IMSI-IMEI-SV; +- The UE reachability for SMS; +- The Roaming status (Roaming or No Roaming) of the UE, and change in roaming status of the UE. + +It is also used: + +- To update the SCEF with the suspend/resume/cancel status of an ongoing monitoring. +- To update the SCEF with information about removal of Communication Pattern. +- To convey reports and/or status indications and/or network parameter configurations for all or some UEs belonging to a group. +- To update the SCEF about changes in previously accepted Network Parameter Configuration(s) due to a new CIR command. + +This procedure is mapped to the commands Reporting-Information-Request/Answer in the Diameter application specified in clause 8. The tables 7.2.2.1-1 and 7.2.2.1-2 detail the involved information elements. + +Table 7.2.2.1-1: Reporting Information Request + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity (see 8.4.36) | User-Identifier | C |

If present, this information element shall contain the User Identity of the UE. This is a grouped AVP containing an External Identifier and/or an MSISDN. This AVP shall not carry the IMSI towards the SCEF.

For group based configuration processing, the External-Identifier shall be present and contain an External Group Identifier (see 3GPP TS 23.003 [11]).

For reports associated to individual UEs (i.e. not associated to a group member UE), this information element may be absent.

For individual UE reports and/or status indications, if the Monitoring-Event-Report(s) with the pertaining SCEF-Reference-Id(s) are present, they uniquely identify the monitoring event(s) reported, regardless of the presence of the User-Identifier.

| +| Supported Features (See 3GPP TS 29.229 [7]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Monitoring Event Report (see 8.4.3) | Monitoring-Event-Report | O | If a report is available in the HSS this information element shall contain the requested data available in the HSS. | +| Group Report (see 8.4.61) | Group-Report | C |

If present, this information element shall contain reports and/or status indications and/or Network Parameter Configurations for all UEs or a subset of UEs belonging to a group.

Shall be present if User-Identifier contains an External Group Identifier

| +| RIR-Flags (see 8.4.63) | RIR-Flags | O | If present, this Information Element shall contain a bit mask. See 8.4.63 for the meaning of the bits. | +| Supported Services (see 8.4.40) | Supported-Services | C |

If present, this Information Element shall contain AVPs indicating details of the services supported by the HSS and authorized for the SCEF.

This Information Element may additionally contain AVPs with the services supported by the serving node(s), if there has been a change of capabilities in MME/SGSN.

If RIR-flags indicates a change of SCEF authorization for one or more monitoring events, this information element shall be present.

| + +Table 7.2.2.1-2: Reporting Information Answer + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 6.3) | Result-Code / Experimental-Result | M |

Result of the request.

Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [23]).

Experimental-Result AVP shall be used for S6t errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.

| +| Supported Features (See 3GPP TS 29.229 [7]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Monitoring Event Report Status | Monitoring-Event-Report-Status | O | If present, this information element shall contain the status of each individual monitoring event report received by the SCEF from the HSS. | + +In the following clauses (7.2.2.2 and 7.2.2.3), if the feature "Extended Reference IDs" (see clause 8.4.23.1) is supported by the SCEF and the HSS, the term "SCEF Reference ID" shall refer to the content of the 64-bit long "SCEF-Reference- + +ID-Ext" AVP, and the term "SCEF Reference ID for Deletion" shall refer to the content of the 64-bit long "SCEF-Reference-ID-for-Deletion-Ext" AVP. + +#### 7.2.2.2 Detailed Behaviour of the HSS + +For group-based configuration processing, if the Group Guard Timer was included in the CIR command, the HSS shall send the RIR command before the Group Guard Timer expires and shall include several reports and/or status indications in one or more Group Report AVPs. + +NOTE: The HSS may divide the accumulated Monitoring Configuration Indications/immediate reports into multiple messages. + +The HSS shall send immediate reports and/or status indications (for Monitoring Event Configurations) and/or Network Parameter Configurations (for Suggested Network Configurations) for group-based configuration processing using the Group-Report. + +If the HSS knows that it has additional RIR commands to send for the same group, the HSS shall include the RIR-Flags AVP with the Group-Configuration-In-Progress bit set and restart the Group Guard Timer to the value it originally received in the CIR. + +For group based configuration processing, if the MME/SGSN previously indicated that it does not support the External-Identifier in the ULR command and the UE does not have an MSISDN configured as part of its subscription data, the HSS shall indicate that the UE is absent by setting the relevant bit in the S6t-HSS-Cause IE of the Group Report-Item AVP. + +If the HSS detects that configuration data provided by a Monitoring-Event-Configuration are overwritten by a new CIR command and the configurations were initiated by different SCEFs, the HSS shall initiate an RIR command and include a Monitoring-Event-Report AVP including the SCEF Reference ID and SCEF Reference ID for Deletion of the overwritten configuration data. + +If the HSS updates a previously accepted Network Parameter Configuration(s), e.g. Active Time is updated due to several SCS/AS suggesting different values for the same network parameter(s) for the same UE (see 3GPP TS 23.682 [2], clause 5.6.1.4), the HSS may initiate a RIR command providing the SCEF Reference ID of the previous Network Parameter Configurations and include the Updated-Network-Configuration AVP including only those parameter configuration(s) which have been updated and are being applied in the network. + +If the HSS detects that suggested network configuration data provided by a Configuration Information Request are overwritten by a new CIR command and the configurations were initiated by different SCEFs, the HSS shall initiate an RIR command and include a Monitoring-Event-Report AVP including the SCEF Reference ID and SCEF Reference ID for Deletion of the overwritten configuration data. + +If the Monitoring-Event-Report is related to a One-time Monitoring event request, the HSS shall delete the related Monitoring event for the UE or the individual group member UE locally after sending the Monitoring-Event-Report. This HSS response will be performed immediately when the event does not involve direct interaction with the serving node. If UE Reachability is reported, a Maximum-UE-Availability-Time AVP may also be present in the report. + +If the HSS detects that the serving node does not support or does not activate (as indicated in IDA or NOR commands) a Monitoring event, or if the UE is part of a group and requires the External-Identifier to be supported by the serving node when it does not, it shall send to the SCEF, an RIR command with the Event-Handling AVP with the value SUSPEND. + +If an HSS detects that in the new serving node an event to be activated is supported which was not supported in the old serving node or if the HSS detects that the new serving node supports the External-Identifier for a UE that is part of a group and requires the External-Identifier which was not supported in the old serving node, it shall send an RIR command with the Event-handling AVP with the value RESUME to the SCEF. + +If the HSS receives a Notify Request from the MME/SGSN to inform the Monitoring-Event-Config-Status at the IWK-SCEF, the HSS shall send an RIR command to the SCEF, for the monitoring event configurations not accepted by the IWK-SCEF, with the Event-Handling AVP set to the value CANCEL. + +If the HSS receives a Notify Request from the MME/SGSN to inform that monitoring event configuration(s) no longer exist in the SCEF (DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN in Monitoring-Event-Config-Status), the HSS shall locally delete the monitoring event configuration(s) and shall skip the sending of a RIR command to the SCEF. + +If the HSS receives the DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN within an RIA command, it shall delete the event stored for the indicated SCEF Reference ID (see 3GPP TS 23.007 [19]). + +If the Supported-Services of the SGSN and/or MME have been previously reported to the SCEF, and the HSS detects that they have changed from a previous report, the HSS shall report all the Supported-Services AVP(s) to the SCEF with the corresponding Node-Type AVP (e.g. HSS, MME). If the services supported and authorized by the HSS are the same than those supported by the serving node(s), the Node-Type AVP shall be absent. + +If a subscriber is barred/un-barred for services relevant to an active monitoring, the HSS shall send an RIR command to the SCEF with the Event-Handling AVP set to the value SUSPEND/RESUME. + +NOTE: When there is an HSS-initiated detach (e.g. due to MM interaction) or when the subscriber is purged in registered serving node(s) while monitoring is active, the sending of a RIR command to the SCEF is not needed since it is assumed that any SCS/AS requiring to be notified when this event is detected has configured monitoring event Loss of connectivity as specified in 3GPP TS 23.682 [2], clause 5.6.8.2. + +If authorization for one or more events is granted or revoked for an SCEF and the Report-Eff-MONTE is supported by HSS and SCEF, the HSS shall send RIR command with RIR-flags indicating that authorization has changed for one or more events. The Supported-Monitoring-Events AVP shall indicate the authorized or revoked authorization for each event. + +When a subscriber or when the monitoring identity (i.e. External Identifier or MSISDN) is deleted from the HSS while monitoring is active or the authorization for monitoring is revoked or a group-based monitoring is partially cancelled for a subscriber or part of subscribers who belongs to the group, if Event Cancellation Report feature is supported by SCEF and HSS and Report-Eff-MONTE feature is not supported by SCEF or HSS, the HSS shall send an RIR command to the SCEF with the Event-Handling AVP set to the value CANCEL. If the RIR command is triggered by partially cancelling of group-based monitoring, the S6t-HSS-Cause IE shall be set to "Group Event Monitoring Partially Cancel". If the HSS and SCEF support the Report-Eff-MONTE feature, the HSS shall make use of RIR-flags AVP for a given User-Identity and no Monitoring-Event-Report AVP(s) shall be included. + +When a subscriber is deleted from the HSS or the authorization for communication pattern is revoked while communication pattern are configured, and the Config-Eff-CP feature is supported by SCEF and HSS, the HSS shall make use of the RIR-flag "All-Communication-Pattern-Cancelled" to indicate removal of Communication Pattern for a given User-Identity. + +#### 7.2.2.3 Detailed Behaviour of the SCEF + +When the SCEF receives a Reporting Information Request from the HSS, and at least one of the received Monitoring Event Reports has a SCEF-Reference-ID not known by the SCEF, it shall reply with DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN (see 3GPP TS 23.007 [19]). In that case, if the HSS had included multiple Monitoring Event Reports in the RIR command, the SCEF shall include in the Reporting Information Answer command a list of Monitoring-Event-Report-Status AVPs where the status of multiple monitoring event reports is detailed. In that AVP list, the AVPs corresponding to event reports with a successful status may be omitted by the SCEF, for efficiency. + +Otherwise when the SCEF receives a Reporting Information Request from the HSS, the SCEF shall set Experimental-Result to DIAMETER\_SUCCESS in the Reporting Information Answer and shall handle it according to the procedures defined in 3GPP TS 23.682 [2]. + +If the SCEF receives RIR command with the Event-Handling AVP set to SUSPEND it shall either notify the SCS/AS that the event is not active or initiate deletion of the event depending on operator configuration. + +If the SCEF receives a RIR command with the Event-Handling AVP set to CANCEL it shall delete the event. + +If the SCEF supports Report-Eff-MONTE feature and receives a RIR command with RIR-flags indicating that its authorization has changed for one or more events, it shall consider all events indicated in Supported-Monitoring-Events AVP as cancelled and shall delete the events for all associated UEs. + +**Editor's Note: The usage of Retry-After timer is FFS.** + +If the SCEF receives RIR command with the Event-Handling AVP set to RESUME it shall notify the SCS/AS that the event is activated in serving node. + +If the SCEF receives a Reporting Information Request from the HSS with the Monitoring-Type AVP set to LOSS\_OF\_CONNECTIVITY, it shall interpret this as the reporting of loss of connectivity of the UE. + +If the monitoring is not for One-time monitoring request (i.e. Maximum Number of Reports was configured with a value higher than one), on receiving Monitoring event reports for a Continuous Monitoring Request for an individual UE, the SCEF shall check whether the number of reports for this Monitoring event type reaches the configured maximum number of reports. When the reports reach the configured maximum number, the SCEF shall send CIR message to the HSS to delete the corresponding Monitoring Event Configuration for an individual UE, with the SCEF Reference ID for Deletion set to the related SCEF Reference ID. + +NOTE: For One-Time report, the HSS/MME/SGSN/SCEF will locally delete the event after the first report is received at the SCEF. For continuous monitoring, the HSS/MME/SGSN, as an implementation option, can delete the monitoring event if it is ensured that the SCEF has received the configured maximum number of reports (if present) for the associated event type, regardless of the Monitoring Duration. However, the CIR message to delete the corresponding Monitoring Event Configuration is always required to ensure network consistency. + +On receiving Monitoring event reports for a One-Time event for a group of UEs (i.e. External Group Identifier), the SCEF shall check whether it has received the reports for all individual group member UEs for this Monitoring event by using the total number of individual group member UE(s) (e.g. External Identifier or MSISDN) received in the reports and the number of UEs originally received within the Number-of-UEs AVP from the HSS. When the reports for all individual group member UEs have been received, the SCEF shall determine that reporting for this group is complete and send the CIR message to the HSS to delete the corresponding Monitoring Event Configuration, with the SCEF Reference ID for Deletion set to the related SCEF Reference ID. + +On receiving Monitoring event reports for a Continuous Monitoring Request for a group of UEs (i.e. External Group Identifier), the SCEF shall check whether the reports of each individual group member UE have reached the configured maximum number of reports by using the total number of individual group member UE(s) (e.g. External Identifier or MSISDN) received in the reports and the number of UEs originally within the Number-of-UEs AVP from the HSS. If the received Monitoring event reports indicate partially cancelling of group-based monitoring for certain UE(s) in the group and Maximum Number of Reports is configured for the monitoring, the SCEF shall set the stored number of reports of the indicated UE(s) to Maximum Number of Reports. When reports of each individual group member UE have reached the configured maximum number of reports, the SCEF shall determine that reporting for this group is complete and send the CIR message to the HSS to delete the corresponding Monitoring Event Configuration, with the SCEF Reference ID for Deletion set to the related SCEF Reference ID. + +If the HSS reports change of Supported-Services, the SCEF shall replace the stored Supported-Service by the received ones. The SCEF shall only trigger those services which are supported and authorized by the HSS and the MME/SGSN. + +If the SCEF receives the RIR command with the Group-Configuration-In-Progress bit of the RIR-Flags AVP set, the SCEF shall restart the associated Group Reporting Guard Timer. + +NOTE: The SCEF needs to be prepared to receive RIR for Group based configuration processing before the Group Reporting Group Timer expires. + +If the SCEF receives a Monitoring Event Report AVP with the SCEF Reference ID for Deletion, it shall initiate cancellation of the Monitoring event identified by the SCEF Reference ID for Deletion in the Monitoring Event Report AVP. + +### 7.2.3 NIDD Information on S6t + +#### 7.2.3.1 General + +This procedure is used between the SCEF and the HSS for: + +- the authorization of the UE or group of UEs for NIDD. + +This procedure is used between the HSS and the SCEF for: + +- the update/revocation of a UE's authorization for NIDD, +- sending of group user identifier list segments. + +This procedure is mapped to the commands NIDD-Information-Request/Answer in the Diameter application specified in clause 8. The tables 7.2.3.1-1 and 7.2.3.1-2 detail the involved information elements. + +**Table 7.2.3.1-1: NIDD Information Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|----------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity (see 8.4.36) | User-Identifier | M | This Information Element shall contain the identity of the UE or the identity of a group of UEs. This is a grouped AVP containing in authorization requests sent from SCEF to HSS either an External Identifier or an MSISDN (exactly one, and only one, of those identifiers shall be included in the request), and containing in update/revocation requests sent from HSS to SCEF an IMSI and either MSISDN or External Identifier or both.
When the request is for a group of UEs, the SCEF shall include the External Group Identifier (see 3GPP TS 23.003 [11]) in the External-Identifier AVP. | +| Supported Features (See 3GPP TS 29.229 [7]) | Supported-Features | O | If present, this Information Element shall contain the list of features supported by the origin host. | +| NIDD Authorization Request (see 8.4.44) | NIDD-Authorization-Request | O | If present, this Information Element shall contain the details of Authorization for NIDD.
When sent by the SCEF, the Service-Selection AVP inside NIDD-Authorization-Request shall be present, and it shall contain the APN for which NIDD authorization is requested.
Shall be absent when sent by the HSS. | +| NIDD Authorization Update (see 8.4.57) | NIDD-Authorization-Update | O | If present, this Information Element shall contain the details of the updated NIDD Authorization.
Shall be absent when sent by the SCEF. | +| NIR Flags | NIR-Flags | O | If present, this Information Element shall contain a bit mask. See 8.4.70 for the meaning of the bits. | +| Group User Identifier List | Group-User-Identifier | C | This information element shall be present if the request is sent from HSS to SCEF following a previous NIA with an incomplete Group User Identifier List. | +| MTC Provider Info | MTC-Provider-Info | O | If present, it contains the identity of the MTC Service Provider and/or MTC Application (see 3GPP TS 23.682 [2], clause 5.6). | + +**Table 7.2.3.1-2: NIDD Information Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat | Description | +|---------------------------------------------|-----------------------------------|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 6.3) | Result-Code / Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [23]).
Experimental-Result AVP shall be used for S6t errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
This AVP reflects the outcome of the procedure on Diameter level. | +| Supported Features (See 3GPP TS 29.229 [7]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| NIDD-Authorization-Response (see 8.4.45) | NIDD-Authorization-Response | C | If present, this Information Element shall contain the details of NIDD Authorization. When sent by the HSS the IE shall only be present when the Result Code is DIAMETER_SUCCESS.
Shall be absent when sent by the SCEF. | +| Group User Identifier List | Group-User-Identifier | C | This information element shall be present if the request was for a group of UEs and the Result-Code is DIAMETER_SUCCESS.
It shall contain for each UE of the group the External-Identifier/MSISDN and IMSI. | +| NIA Flags | NIA-Flags | O | If present, this Information Element shall contain a bit mask. See 8.4.72 for the meaning of the bits. | + +#### 7.2.3.2 Detailed Behaviour of the HSS + +When the NIDD Information Request is received from the SCEF, the HSS shall, in the following order: + +1. Check that the User Identity for whom data is asked exists in HSS. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the NIDD Information Answer. +2. Check that the requested service is authorized for the UE. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_SERVICE (5511) in the NIDD Information Answer. +- 2a. If the MTC Provider Information is received, check if the MTC Provider ID is authorized for the UE or the group of UEs. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_MTC\_PROVIDER (5516) in the NIDD Information Answer. +3. Check that the APN sent in the Service-Selection AVP of the NIDD-Authorization-Request AVP is subscribed for the subscriber identified by the given MSISDN or the External Identifier. If it is not subscribed, then the Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_NO\_APN\_SUBSCRIPTION (5451) in the NIDD Information Answer. +4. If the User-Identifier contains an External Identifier, the HSS shall include the IMSI and if available the MSISDN associated with the appropriate External Identifier in the NIDD-Authorization-Response. +5. If the User-Identifier contains an MSISDN, the HSS shall include the IMSI and if available, the appropriate External Identifier associated with the MSISDN in the NIDD-Authorization-Response. +6. If the User-Identifier contains an IMSI the HSS shall include the MSISDN and the appropriate External Identifier assigned to the IMSI in the NIDD-Authorization-Response. +- 6a. If the User-Identifier contains an External Group Identifier, the HSS shall include the IMSI and the MSISDN or External-Identifier assigned to each member of the group in the Group-User-Identifier. If due to message size constraints or timing constraints (NIA timeout) the complete list of group user identifier cannot be sent, the HSS shall segment the list, include the first segment in NIA and set the NIA-Flag "Incomplete Group User Identifier List", and send subsequent segments with separate NIR commands to the SCEF. +7. If the requested service is NIDD Authorization request and the feature "NIDD Authorization Update" is commonly supported by HSS and SCEF, the HSS shall store the granted NIDD Authorization in order to being able to update/revoke the Authorization towards the SCEF when so needed. The HSS may indicate within the NIDD-Authorization-Response AVP a granted validity time which shall not be later than the requested validity time as received within the NIDD-Authorization-Request AVP (if any). If so the HSS shall delete the stored Authorization at the indicated point in time. + +NOTE 1: If several External Identifiers are mapped to one IMSI, some functions might not work in this release of the specification. + +NOTE 2: Step 6 above is applicable for the case where the SCEF receives a T6a/b-CMR (see 3GPP TS 29.128 [24]) command while a valid NIDD configuration does not exist for the UE at the SCEF. + +If there is an error in any of the above steps then the HSS shall stop processing and return the error code specified in the respective step. + +If the HSS cannot fulfil the received request for reasons not stated in the above steps (e.g. due to a database error), it shall stop processing the request and set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. Otherwise the Result-Code shall be set to DIAMETER\_SUCCESS. + +When the need to update/revoke one or several stored granted NIDD Authorizations for a user is detected in the HSS, and the feature "NIDD Authorization Update" is commonly supported by the HSS and the SCEF, the HSS shall issue an NIDD-Information Request command containing a NIDD-Authorization-Update AVP towards the SCEF. The NIDD-Authorization-Update AVP may identify several granted NIDD Authorizations for the user to be updated. + +#### 7.2.3.3 Detailed Behaviour of the SCEF + +When the SCEF receives an NIDD-Authorization-Response AVP from the HSS in a NIA command, it shall handle it according to the procedures defined in 3GPP TS 23.682 [2]. If the feature "NIDD Authorization Update" is commonly + +supported by the HSS and the SCEF, and a granted validity time was received within the NIDD-Authorization-Response, the SCEF shall consider the authorization being implicitly revoked at the indicated time, and may issue a new NIDD Authorization request towards the HSS. + +# --- 8 Protocol Specification for S6t + +## 8.1 Introduction + +### 8.1.1 Use of Diameter Base Protocol + +The Diameter base protocol as specified in IETF RFC 6733 [23] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +### 8.1.2 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [4]. + +### 8.1.3 Accounting Functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the S6t interface. + +### 8.1.4 Use of Sessions + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [23]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +### 8.1.5 Transport Protocol + +Diameter messages over the S6t interface shall make use of SCTP IETF RFC 4960 [5] as transport protocol. + +### 8.1.6 Routing Considerations + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host. + +If the SCEF knows the address/name of the HSS for a certain user, both the Destination-Realm AVP and the Destination-Host AVP shall be present in the request. Otherwise, only the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node. Consequently, the Destination-Host AVP is declared as optional in the ABNF for all requests initiated by the SCEF. + +As the HSS knows the address/name and the associated home network domain name of the SCEF to which it sends RIR and NIR commands from a previously received CIR command, both the Destination-Realm and Destination-Host AVPs shall be present in request commands sent by the HSS to the SCEF. + +Destination-Realm AVP is declared as mandatory in the ABNF for all requests. + +If the Vendor-Specific-Application-ID AVP is received in any of the commands, it may be ignored by the receiving node, and it shall not be used for routing purposes. + +### 8.1.7 Advertising Application Support + +The HSS and the SCEF shall advertise support of the Diameter S6t Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [23]. + +### 8.1.8 Diameter Application Identifier + +The S6t interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the S6t interface application is 16777345 (allocated by IANA). + +### 8.1.9 Use of the Supported-Features AVP + +When new functionality is introduced on the S6t application, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. The usage of the Supported-Features AVP on the S6t application is consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [7]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [7], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +### 8.1.10 User Identity to HSS resolution + +The User identity to HSS resolution mechanism enables the SCEF to find the identity of the HSS that holds the subscription data for the target user when multiple and separately addressable HSSs have been deployed in the home network. The resolution mechanism is not required in networks that utilise a single HSS. + +This User identity to HSS resolution mechanism may rely on routing capabilities provided by Diameter and be implemented in the home operator network within dedicated Diameter Agents (Redirect Agents or Proxy Agents) responsible for determining the HSS identity based on the provided user identity (e.g. external identifiers provided by the SCEF). + +When the Diameter Load Control mechanism is supported (see IETF RFC 8583 [22]), load values from previously received Load AVPs of type HOST may be taken into account when determining the HSS identity. + +NOTE: Alternatives to the user identity to HSS resolution Diameter based implementation are outside the scope of this specification. + +## 8.2 Commands + +### 8.2.1 Introduction + +This clause defines the Command code values and related ABNF for each command described in this specification. + +### 8.2.2 Command-Code values + +This clause defines Command-Code values for the S6t interface application as allocated by IANA. + +Every command is defined by means of the ABNF syntax IETF RFC 5234 [9], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [23]. When the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [23] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with the IETF RFC 6733 [23]. + +The following Command Codes are defined in this specification for S6t: + +**Table 8.2.2-1: Command-Code values for S6t** + +| Command-Name | Abbreviation | Code | Clause | +|-----------------------------------|--------------|---------|--------| +| Configuration-Information-Request | CIR | 8388718 | 8.2.3 | +| Configuration-Information-Answer | CIA | 8388718 | 8.2.4 | +| Reporting-Information-Request | RIR | 8388719 | 8.2.5 | +| Reporting-Information-Answer | RIA | 8388719 | 8.2.6 | +| NIDD-Information-Request | NIR | 8388726 | 8.2.7 | +| NIDD-Information-Answer | NIA | 8388726 | 8.2.8 | + +For these commands, the Application-ID field shall be set to 16777345 (application identifier of the S6t interface application, allocated by IANA). + +### 8.2.3 Configuration Information Request (CIR) Command + +The Configuration Information Request (CIR) command, indicated by the Command-Code field set to 8388718 and the "R" bit set in the Command Flags field, is sent from the SCEF to the HSS. + +Message Format: + +``` +< Configuration-Information-Request > ::= < Diameter Header: 8388718, REQ, PXY, 16777345 > +< Session-Id > +[ DRMP ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Destination-Host ] +{ Destination-Realm } +{ User-Identifier } +[ OC-Supported-Features ] +*[ Supported-Features ] +*[ Monitoring-Event-Configuration ] +[ CIR-Flags ] +*[ AESE-Communication-Pattern ] +[ Enhanced-Coverage-Restriction ] +``` + +``` + +[ Group-Reporting-Guard-Timer ] +[ AdditionalIdentifiers ] +*[ Proxy-Info ] +*[ Route-Record ] +[ Suggested-Network-Configuration ] +*[AVP] + +``` + +### 8.2.4 Configuration-Information-Answer (CIA) Command + +The Configuration-Information-Answer (CIA) command, indicated by the Command-Code field set to 8388718 and the "R" bit cleared in the Command Flags field, is sent from the HSS to the SCEF. + +Message Format: + +``` + +< Configuration-Information-Answer > ::= < Diameter Header: 8388718, PXY, 16777345 > +< Session-Id > +[ DRMP ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ Supported-Features ] +[ User-Identifier ] +[ Number-of-UEs ] +*[ Monitoring-Event-Report ] +*[ Monitoring-Event-Config-Status ] +*[ AESE-Communication-Pattern-Config-Status ] +*[ Supported-Services ] +[ S6t-HSS-Cause ] +[ Enhanced-Coverage-Restriction-Data ] +[ CIA-Flags ] +*[ IMSI-Group-Id ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +[ Suggested-Network-Configuration ] +*[AVP] + +``` + +### 8.2.5 Reporting-Information-Request (RIR) Command + +The Reporting-Information-Request (RIR) command, indicated by the Command-Code field set to 8388719 and the "R" bit cleared in the Command Flags field, is sent from the HSS to the SCEF. + +Message Format: + +``` + +< Reporting-Information-Request > ::= < Diameter Header: 8388719, PXY, 16777345 > +< Session-Id > +[ DRMP ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +{ Destination-Host } +{ Destination-Realm } +*[ Supported-Features ] +[ User-Identifier ] +*[ Monitoring-Event-Report ] +*[ Group-Report ] +[ Updated-Network-Configuration ] +[ RIR-Flags ] + +``` + +``` + +*[ Supported-Services ] +*[ Proxy-Info ] +*[ Route-Record ] +*[AVP] + +``` + +### 8.2.6 Reporting-Information-Answer (RIA) Command + +The Reporting-Information-Answer (RIA) command, indicated by the Command-Code field set to 8388719 and the "R" bit cleared in the Command Flags field, is sent from the HSS to the SCEF. + +Message Format: + +``` + +< Reporting-Information-Answer > ::= < Diameter Header: 8388719, PXY, 16777345 > +< Session-Id > +[ DRMP ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +*[ Supported-Features ] +*[ Monitoring-Event-Report-Status ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +*[AVP] + +``` + +### 8.2.7 NIDD Information Request (NIR) Command + +The NIDD Information Request (NIR) command, indicated by the Command-Code field set to 8388726 and the "R" bit set in the Command Flags field, is sent from the SCEF to the HSS. It may also be sent from the HSS to the SCEF when the feature "NIDD Authorization Update" is commonly supported by the HSS and the SCEF. + +Message Format: + +``` + +< NIDD-Information-Request > ::= < Diameter Header: 8388726, REQ, PXY, 16777345 > +< Session-Id > +[ DRMP ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Destination-Host ] +{ Destination-Realm } +{ User-Identifier } +[ OC-Supported-Features ] +*[ Supported-Features ] +[ NIDD-Authorization-Request ] +[ NIDD-Authorization-Update ] +[ NIR-Flags ] +*[ Group-User-Identifier ] +[ MTC-Provider-Info ] +*[ Proxy-Info ] +*[ Route-Record ] +*[AVP] + +``` + +### 8.2.8 NIDD-Information-Answer (NIA) Command + +The NIDD-Information-Answer (NIA) command, indicated by the Command-Code field set to 8388726 and the "R" bit cleared in the Command Flags field, is sent from the HSS to the SCEF. It may also be sent from the SCEF to the HSS when the feature "NIDD Authorization Update" is commonly supported by the HSS and the SCEF. + +Message Format: + +``` + +< NIDD-Information-Answer > ::= < Diameter Header: 8388726, PXY, 16777345 > + < Session-Id > + [ DRMP ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + [ NIDD-Authorization-Response ] + *[ Group-User-Identifier ] + [ NIA-Flags ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] + +``` + +## 8.3 Result-Code AVP and Experimental-Result AVP Values + +### 8.3.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 8.3.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in Diameter base protocol specified in IETF RFC 6733 [23] shall be applied. + +### 8.3.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in Diameter base protocol specified in IETF RFC 6733 [23] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 8.3.3.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the HSS to indicate that the user identified by the IMSI, MSISDN, or External-Identifier is unknown. This error code is defined in 3GPP TS 29.229 [7]. + +#### 8.3.3.2 DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) + +This result code shall be sent by the HSS to indicate that the SCEF is not allowed to request the service. + +#### 8.3.3.3 DIAMETER\_ERROR\_UNAUTHORIZED\_SERVICE (5511) + +This result code shall be sent by the HSS to indicate that the specific service requested by the SCEF is not allowed for an UE, or that it cannot be delivered according to the current subscribed services of the UE. + +#### 8.3.3.4 DIAMETER\_ERROR\_REQUESTED\_RANGE\_IS\_NOT\_ALLOWED (5512) + +This result code shall be sent by the HSS to indicate that the specific service requested by the SCEF is not allowed for an UE, or that it cannot be delivered according to the current subscribed services of the UE. + +#### 8.3.3.5 DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_STORAGE\_NOT\_SUCCESSFUL (5513) + +This result code shall be sent by the HSS to indicate that the specific service requested by the SCEF could not be stored for an UE. + +#### 8.3.3.6 DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_NON\_EXISTANT (5514) + +This result code shall be sent by the HSS to indicate that the requested deletion by the SCEF could not be performed for an UE because the event does not exist. + +#### 8.3.3.7 DIAMETER\_ERROR\_USER\_NO\_APN\_SUBSCRIPTION (5451) + +This result code shall be sent by the HSS to indicate that the APN is not authorized for an UE. + +#### 8.3.3.8 DIAMETER\_ERROR\_UNAUTHORIZED\_MTC\_PROVIDER (5516) + +This result code shall be sent by the HSS to indicate that the MTC provider is not allowed to request the service. + +## 8.4 AVPs + +### 8.4.1 General + +The following table specifies the Diameter AVPs defined for the S6t interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +Table 8.4.1-1: S6t specific Diameter AVPs + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | | +|------------------------------------------|----------|----------------|------------------|----------------|-----|------------|----------|-----------| +| | | | | Must | May | Should not | Must not | May Encr. | +| AESE-Communication-Pattern | 3113 | 8.4.25 | Grouped | M,V | | | | No | +| Communication-Pattern-Set | 3114 | 8.4.26 | Grouped | M,V | | | | No | +| Periodic-Communication-Indicator | 3115 | 8.4.27 | Unsigned32 | M,V | | | | No | +| Communication-Duration-Time | 3116 | 8.4.28 | Unsigned32 | M,V | | | | No | +| Periodic-time | 3117 | 8.4.29 | Unsigned32 | M,V | | | | No | +| Scheduled-Communication-Time | 3118 | 8.4.30 | Grouped | M,V | | | | No | +| Stationary-Indication | 3119 | 8.4.31 | Unsigned32 | M,V | | | | No | +| AESE-Communication-Pattern-Config-Status | 3120 | 8.4.32 | Grouped | M,V | | | | No | +| AESE-Error-Report | 3121 | 8.4.33 | Grouped | M,V | | | | No | +| Monitoring-Event-Configuration | 3122 | 8.4.2 | Grouped | M,V | | | | No | +| Monitoring-Event-Report | 3123 | 8.4.3 | Grouped | M,V | | | | No | +| SCEF-Reference-ID | 3124 | 8.4.4 | Unsigned32 | M,V | | | | No | +| SCEF-ID | 3125 | 8.4.5 | DiameterIdentity | M,V | | | | No | +| SCEF-Reference-ID-for-Deletion | 3126 | 8.4.6 | Unsigned32 | M,V | | | | No | +| Monitoring-Type | 3127 | 8.4.7 | Unsigned32 | M,V | | | | No | +| Maximum-Number-of-Reports | 3128 | 8.4.8 | Unsigned32 | M,V | | | | No | +| UE-Reachability-Configuration | 3129 | 8.4.9 | Grouped | M,V | | | | No | +| Monitoring-Duration | 3130 | 8.4.10 | Time | M,V | | | | No | +| Maximum-Detection-Time | 3131 | 8.4.11 | Unsigned32 | M,V | | | | No | +| Reachability-Type | 3132 | 8.4.12 | Unsigned32 | M,V | | | | No | +| Maximum Latency | 3133 | 8.4.13 | Unsigned32 | M,V | | | | No | +| Maximum Response Time | 3134 | 8.4.14 | Unsigned32 | M,V | | | | No | +| Location-Information-Configuration | 3135 | 8.4.15 | Grouped | M,V | | | | No | +| MONTE-Location-Type | 3136 | 8.4.16 | Unsigned32 | M,V | | | | No | +| Accuracy | 3137 | 8.4.17 | Unsigned32 | M,V | | | | No | +| Association-Type | 3138 | 8.4.18 | Unsigned32 | M,V | | | | No | +| Roaming-Information | 3139 | 8.4.19 | Unsigned32 | M,V | | | | No | +| Reachability-Information | 3140 | 8.4.20 | Unsigned32 | M,V | | | | No | +| IMEI-Change | 3141 | 8.4.22 | Unsigned32 | M,V | | | | No | +| Monitoring-Event-Config-Status | 3142 | 8.4.24 | Grouped | M,V | | | | No | +| Supported-Services | 3143 | 8.4.40 | Grouped | M,V | | | | No | +| Supported-Monitoring-Events | 3144 | 8.4.41 | Unsigned64 | M,V | | | | No | +| CIR-Flags | 3145 | 8.4.39 | Unsigned32 | M,V | | | | No | +| Service-Result | 3146 | 8.4.37 | Grouped | M,V | | | | No | +| Service-Result-Code | 3147 | 8.4.38 | Unsigned32 | M,V | | | | No | +| Reference-ID-Validity-Time | 3148 | 8.4.42 | Time | M,V | | | | No | +| Event-Handling | 3149 | 8.4.43 | Unsigned32 | M,V | | | | No | +| NIDD-Authorization-Request | 3150 | 8.4.44 | Grouped | M,V | | | | No | +| NIDD-Authorization-Response | 3151 | 8.4.45 | Grouped | M,V | | | | No | +| Service-Report | 3152 | 8.4.47 | Grouped | M,V | | | | No | +| Node-Type | 3153 | 8.4.48 | Unsigned32 | M,V | | | | No | +| S6t-HSS-Cause | 3154 | 8.4.50 | Unsigned32 | M,V | | | | No | +| Enhanced-Coverage-Restriction | 3155 | 8.4.51 | Grouped | V | | | M | No | +| Enhanced-Coverage-Restriction-Data | 3156 | 8.4.52 | Grouped | V | | | M | No | +| Restricted-PLMN-List | 3157 | 8.4.53 | Grouped | V | | | M | No | +| Allowed-PLMN-List | 3158 | 8.4.54 | Grouped | V | | | M | No | +| Requested-Validity-Time | 3159 | 8.4.55 | Time | V | | | M | No | +| Granted-Validity-Time | 3160 | 8.4.56 | Time | V | | | M | No | + +| | | | | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|--------|------------|---|--|--|---|----| +| NIDD-Authorization-Update | 3161 | 8.4.57 | Grouped | V | | | M | No | +| Loss-Of-Connectivity-Reason | 3162 | 8.4.58 | Unsigned32 | V | | | M | No | +| Group-Reporting-Guard-Timer | 3163 | 8.4.59 | Unsigned32 | V | | | M | No | +| CIA-Flags | 3164 | 8.4.60 | Unsigned32 | V | | | M | No | +| Group-Report | 3165 | 8.4.61 | Grouped | V | | | M | No | +| Group-Report-Item | 3166 | 8.4.62 | Grouped | V | | | M | No | +| RIR-Flags | 3167 | 8.4.63 | Unsigned32 | V | | | M | No | +| Type-Of-External-Identifier | 3168 | 8.4.64 | Unsigned32 | V | | | M | No | +| APN-Validity-Time | 3169 | 8.4.65 | Grouped | V | | | M | No | +| Suggested-Network-Configuration | 3170 | 8.4.66 | Grouped | V | | | M | No | +| Monitoring-Event-Report-Status | 3171 | 8.4.67 | Grouped | V | | | M | No | +| PLMN-ID-Requested | 3172 | 8.4.68 | Enumerated | V | | | M | No | +| AdditionalIdentifiers | 3173 | 8.4.69 | Grouped | V | | | M | No | +| NIR-Flags | 3174 | 8.4.70 | Unsigned32 | V | | | M | No | +| Reporting-Time-Stamp | 3175 | 8.4.71 | Time | V | | | M | No | +| NIA-Flags | 3176 | 8.4.72 | Unsigned32 | V | | | M | No | +| Group-User-Identifier | 3177 | 8.4.73 | Grouped | V | | | M | No | +| MTC-Provider-Info | 3178 | 8.4.74 | Grouped | V | | | M | No | +| MTC-Provider-ID | 3179 | 8.4.75 | UTF8String | V | | | M | No | +| PDN-Connectivity-Status-Configuration | 3180 | 8.4.76 | Grouped | V | | | M | No | +| PDN-Connectivity-Status-Report | 3181 | 8.4.77 | Grouped | V | | | M | No | +| PDN-Connectivity-Status-Type | 3182 | 8.4.78 | Unsigned32 | V | | | M | No | +| Traffic-Profile | 3183 | 8.4.79 | Unsigned32 | V | | | M | No | +| Updated-Network-Configuration | 3184 | 8.4.80 | Grouped | V | | | M | No | +| Battery-Indicator | 3185 | 8.4.81 | Unsigned32 | V | | | M | No | +| SCEF-Reference-ID-Ext | 3186 | 8.4.82 | Unsigned64 | V | | | M | No | +| SCEF-Reference-ID-for-Deletion-Ext | 3187 | 8.4.83 | Unsigned64 | V | | | M | No | +| Exclude-Identifiers | 3188 | 8.4.84 | Grouped | V | | | M | No | +| Include-Identifiers | 3189 | 8.4.85 | Grouped | V | | | M | No | +| NOTE 1: The AVP header bit denoted as "M" indicates whether support of the AVP is required. The AVP header bit denoted as "V" indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [23]. | | | | | | | | | +| NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. | | | | | | | | | + +The following table specifies the Diameter AVPs re-used by the S6t interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within S6t. + +Any other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol specified in IETF RFC 6733 [23], do not need to be supported. The AVPs from Diameter base protocol specified in IETF RFC 6733 [23] are not included in table 8.4.1-2, but they may be re-used for the S6t protocol. + +Table 8.4.1-2: S6t re-used Diameter AVPs + +| Attribute Name | Reference | Comments | M-bit | +|-------------------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| User-Identifier | 6.4.2 | see 8.4.36 | | +| External-Identifier | 6.4.11 | | | +| MSISDN | 3GPP TS 29.329 [10] | | | +| User-Name | IETF RFC 6733 [23] | This AVP shall contain the IMSI of the UE | | +| Supported-Features | 3GPP TS 29.229 [7] | see 8.4.23 | | +| Feature-List-ID | 3GPP TS 29.229 [7] | | | +| Feature-List | 3GPP TS 29.229 [7] | | | +| OC-Supported-Features | IETF RFC 7683 [15] | See 6.4.16 | Must not set | +| OC-OLR | IETF RFC 7683 [15] | See 6.4.17 | Must not set | +| Visited PLMN Id | 3GPP TS 29.272 [14] | This Information Element shall contain the identity (MCC and MNC) of the serving PLMN, either the VPLMN or the HPLMN. | | +| Charged-Party | 3GPP TS 32.299 [16] | | | +| EPS-Location-Information | 3GPP TS 29.272 [14] | see 8.4.21 | | +| MME-Location-Information | 3GPP TS 29.272 [14] | see 8.4.34 | | +| SGSN-Location-Information | 3GPP TS 29.272 [14] | see 8.4.35 | | +| E-UTRAN-Cell-Global-Identity | 3GPP TS 29.272 [14] | | | +| Tracking-Area-Identity | 3GPP TS 29.272 [14] | | | +| Current-Location-Retrieved | 3GPP TS 29.272 [14] | | | +| Age-Of-Location-Information | 3GPP TS 29.272 [14] | | | +| User-CSG-Information | 3GPP TS 29.272 [14] | | | +| Cell-Global-Identity | 3GPP TS 29.272 [14] | | | +| Service-Area-Identity | 3GPP TS 29.272 [14] | | | +| Routing-Area-Identity | 3GPP TS 29.272 [14] | | | +| eNodeB-ID | 3GPP TS 29.217 [17] | | | +| Day-Of-Week-Mask | IETF RFC 5777 [18] | | | +| Time-Of-Day-Start | IETF RFC 5777 [18] | | | +| Time-Of-Day-End | IETF RFC 5777 [18] | | | +| DRMP | IETF RFC 7944 [20] | see 8.4.46 | Must not set | +| Service-Selection | IETF RFC 5778 [21] | See 8.4.49 | | +| Load | IETF RFC 8583 [22] | See 6.4.20 | Must not set | +| DL-Buffering-Suggested-Packet-Count | 3GPP TS 29.272 [14] | | | +| Extended-eNodeB-ID | 3GPP TS 29.217 [17] | | Must not set | +| Maximum-UE-Availability-Time | 3GPP TS 29.338 [12] | | | +| Idle-Status-Indication | 3GPP TS 29.128 [24] | | Must not set | +| Active-Time | 3GPP TS 29.128 [24] | When used over S6t, this AVP contains the value of Maximum Response Time (see 3GPP TS 29.122 [26], clause 5.13.2.1.2) which is used to calculate the value of subscribed Active Time as described in 3GPP TS 23.682 [2], clause 4.5.21. | Must not set | +| DL-Buffering-Suggested-Packet-Count | 3GPP TS 29.272 [14] | | Must not set | +| Subscribed-Periodic-RAU-TAU-Timer | 3GPP TS 29.272 [14] | When used over S6t, this AVP contains the value of Maximum Latency (see 3GPP TS 29.122 [26], clause 5.13.2.1.2) which is used to calculate the value of subscribed periodic RAU/TAU timer as described in 3GPP TS 23.682 [2], clause 4.5.21. | Must not set | + +| Attribute Name | Reference | Comments | M-bit | +|--------------------------------|---------------------|----------|--------------| +| IMSI-Group-Id | 3GPP TS 29.272 [14] | | Must not set | +| Number-of-UEs | 3GPP TS 29.154 [25] | | Must not set | +| Terminal-Information | 3GPP TS 29.272 [14] | | Must not set | +| PDN-Type | 3GPP TS 29.272 [14] | | Must not set | +| Non-IP-PDN-Type-Indicator | 3GPP TS 29.272 [14] | | Must not set | +| Non-IP-Data-Delivery-Mechanism | 3GPP TS 29.272 [14] | | Must not set | +| Served-Party-IP-Address | 3GPP TS 32.299 [16] | | Must not set | +| Reachability-Cause | 3GPP TS 29.128 [24] | | Must not set | + +### 8.4.2 Monitoring-Event-Configuration + +The Monitoring-Event-Configuration AVP is of type Grouped, and it contains the details of the monitoring event from the SCEF. At least SCEF-Reference-ID or one SCEF-Reference-ID-for-Deletion shall be present. + +AVP format: + +``` +Monitoring-Event-Configuration ::= + [ SCEF-Reference-ID ] + [ SCEF-Reference-ID-Ext ] + { SCEF-ID } + { Monitoring-Type } + *[ SCEF-Reference-ID-for-Deletion ] + *[ SCEF-Reference-ID-for-Deletion-Ext ] + [ Maximum-Number-of-Reports ] + [ Monitoring-Duration ] + [ Charged-Party ] + [ Maximum-Detection-Time ] + [ UE-Reachability-Configuration ] + [ Location-Information-Configuration ] + [ Association-Type ] + [ DL-Buffering-Suggested-Packet-Count ] + [ PLMN-ID-Requested ] + [ MTC-Provider-Info ] + [ PDN-Connectivity-Status-Configuration ] + [ Exclude-Identifiers ] + [ Include-Identifiers ] + *[AVP] +``` + +At least one of the SCEF-Reference-ID or SCEF-Reference-ID-for-Deletion shall be present. + +The Maximum-Number-of-Reports AVP, if present, shall contain the maximum number of event reports to be generated by the HSS, MME, or SGSN until the monitoring event configuration is considered to expire. + +The Monitoring-Duration AVP, if present, shall contain the absolute time at which the monitoring event configuration is considered to expire. + +If both Maximum-Number-of-Reports and Monitoring-Duration AVPs are present, the monitoring event configuration shall be considered to expire as soon as one of the conditions is met. + +If both Maximum-Number-of-Reports and Monitoring-Duration AVPs are absent, the monitoring event configuration shall be considered as a one-time monitoring request (same behaviour as setting Maximum-Number-of-Reports to 1). + +Monitoring-Type shall only be taken into account in combination with SCEF-Reference-ID; Monitoring-Type AVP shall be ignored for deletion of an event (in combination with SCEF-Reference-ID-for-Deletion). + +The details of how to handle expiration of Monitoring events is described in 3GPP TS 23.682 [2]. + +When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. + +When the "Dynamic-Group-Event-Monitoring" feature is supported by the HSS and SCEF, the Exclude-Identifiers AVP may be included to cancel the event monitoring for the listed UEs in a group for which there is a configured Monitoring Event, or the Include-Identifiers AVP may be included to create the event monitoring for the listed UEs in a group for which there is a configured Monitoring Event. + +### 8.4.3 Monitoring-Event-Report + +The Monitoring-Event-Report AVP is of type Grouped, and it contains the information to be reported as requested by Monitoring-Event-Configuration. + +AVP format: + +``` +Monitoring-Event-Report ::= + { SCEF-Reference-ID } + [ SCEF-Reference-ID-Ext ] + [ SCEF-ID ] + [ SCEF-Reference-ID-for-Deletion ] + [ SCEF-Reference-ID-for-Deletion-Ext ] + [ Visited-PLMN-Id ] + [ Roaming-Information ] + [ IMEI-Change ] + [ Terminal-Information ] + [ Reachability-Information ] + [ Reachability-Cause ] + [ Maximum-UE-Availability-Time ] + [ EPS-Location-Information ] + [ Monitoring-Type ] + [ Event-Handling ] + *[ Service-Report ] + [ Loss-Of-Connectivity-Reason ] + [ Idle-Status-Indication ] +``` + +\*[ PDN-Connectivity-Status-Report ] + +\*[AVP] + +When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. + +### 8.4.4 SCEF-Reference-ID + +The SCEF-Reference-ID AVP is of type Unsigned32 and it shall contain the identifier provided by the SCEF. + +### 8.4.5 SCEF-ID + +The SCEF- ID AVP is of type DiameterIdentity and it shall contain the identity of the SCEF which has originated the service request towards the HSS, i.e. when sent within a Monitoring-Event-Configuration AVP in S6t-CIR, SCEF-ID AVP and Origin-Host AVP shall have the same value. + +### 8.4.6 SCEF-Reference-ID-for-Deletion + +The SCEF-Reference-ID-for-Deletion AVP is of type Unsigned32 and it shall contain the SCEF-Reference-ID (in combination with the SCEF identified by the SCEF-ID) for the event to be deleted. + +### 8.4.7 Monitoring-Type + +The Monitoring-Type AVP is of type Unsigned32 and shall identify the type of event to be monitored. The following values are defined: + +LOSS\_OF\_CONNECTIVITY (0) + +UE\_REACHABILITY (1) + +LOCATION\_REPORTING (2) + +CHANGE\_OF\_IMSI\_IMEI(SV)\_ASSOCIATION (3) + +ROAMING\_STATUS (4) + +COMMUNICATION\_FAILURE (5) + +AVAILABILITY\_AFTER\_DDN\_FAILURE (6) + +NUMBER\_OF\_UES\_PRESENT\_IN\_A\_GEOGRAPHICAL\_AREA (7) + +UE\_REACHABILITY\_AND\_IDLE\_STATUS\_INDICATION (8) + +AVAILABILITY\_AFTER\_DDN\_FAILURE\_AND\_IDLE\_STATUS\_INDICATION (9) + +PDN\_CONNECTIVITY\_STATUS (10) + +### 8.4.8 Maximum-Number-of-Reports + +The Maximum-Number-of-Reports AVP is of type Unsigned32. It shall contain the number of reports to be generated and sent to the SCEF. + +This AVP shall not be present when Monitoring-Type is AVAILABILITY\_AFTER\_DDN\_FAILURE (6). + +This AVP shall not be greater than one if: + +- Monitoring-Type is UE\_REACHABILITY (1) and Reachability-Type is "Reachability for SMS" or + +- Monitoring-Type is LOCATION\_REPORTING (2) and MONTE-Location-Type is LAST\_KNOWN\_LOCATION (1). + +### 8.4.9 UE-Reachability-Configuration + +The UE-Reachability-Configuration AVP is of type Grouped, and it shall contain the details for configuration for UE reachability. + +AVP format: + +``` +UE-Reachability-Configuration ::= + [ Reachability-Type ] + [ Maximum-Latency ] + [ Maximum-Response-Time ] + [ DL-Buffering-Suggested-Packet-Count ] + *[AVP] +``` + +### 8.4.10 Monitoring-Duration + +The Monitoring-Duration AVP is of type Time. It shall contain the absolute time at which the related monitoring event request is considered to expire. + +### 8.4.11 Maximum-Detection-Time + +The Maximum-Detection-Time AVP is of type Unsigned32. It shall contain the maximum number of seconds without any communication with the UE after which the SCEF is to be informed that the UE is considered to be unreachable. It is used to set the subscribed periodic RAU/TAU timer by the HSS. + +### 8.4.12 Reachability-Type + +The Reachability-Type AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 8.4.12-1: + +**Table 8.4.12-1: Reachability-Type** + +| Bit | Name | Description | +|---------------------------------------------------------------------------------------------------------------------|-----------------------|-----------------------------------------------------------------------------------------------------------| +| 0 | Reachability for SMS | This bit, when set, indicates that the monitoring for reachability for SMS of the UE is to be configured | +| 1 | Reachability for Data | This bit, when set, indicates that the monitoring for reachability for data of the UE is to be configured | +| NOTE 1: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | +| NOTE 2: Bit 0 and 1 shall not be set simultaneously. | | | + +The default value, when this AVP is not included, is Reachability for SMS (bit 0 set). + +### 8.4.13 Maximum-Latency + +The Maximum-Latency AVP is of type Unsigned32. It shall contain the maximum acceptable delay time for downlink data transfer in seconds. It is used to set the subscribed periodic RAU/TAU timer by the HSS. + +### 8.4.14 Maximum-Response-Time + +The Maximum-Response-Time AVP is of type Unsigned32. It shall contain the maximum time in seconds for which the UE stays reachable. It is used to set the active time by the HSS. + +### 8.4.15 Location-Information-Configuration + +The Location-Information-Configuration AVP is of type Grouped, and it contains the details for location reporting. + +AVP format: + +``` +Location-Information-Configuration ::= + [ MONTE-Location-Type ] + [ Accuracy ] + [ Periodic-Time ] + *[AVP] +``` + +If present, Periodic-Time contains the minimum periodic location reporting time. + +### 8.4.16 MONTE-Location-Type + +The MONTE-Location-Type AVP is of type Unsigned32. It indicates the type of location information to be provided. The following values are defined: + +``` +CURRENT_LOCATION (0) +LAST_KNOWN_LOCATION (1) +``` + +The default value, when this AVP is not included, is LAST\_KNOWN\_LOCATION (1). + +### 8.4.17 Accuracy + +The Accuracy AVP is of type Unsigned32. It shall indicate the requested accuracy. The following values are defined: + +``` +CGI-ECGI (0) +eNB (1) +LA-TA-RA (2) +PRA (3) +PLMN-ID (4) +``` + +### 8.4.18 Association-Type + +The Association-Type AVP is of type Unsigned32. It shall indicate the details of the event configuration related to the change of IMEI(SV)-IMSI association. The following values are defined: + +``` +IMEI-CHANGE (0) +``` + +The event shall be reported if the association between IMSI and IMEI has changed; if only the Software Version (SV) has changed, no event shall be reported. + +``` +IMEISV-CHANGE (1) +``` + +The event shall be reported if the association between IMSI and IMEI, or SV, or both, has changed (this includes the case where only the SV has changed). + +### 8.4.19 Roaming-Information + +The Roaming-Information AVP is of type Unsigned32. It shall indicate the roaming status of the subscriber. The following values are defined: + +``` +SUBSCRIBER_ROAMING (0) +``` + +SUBSCRIBER\_NOT\_ROAMING (1) + +### 8.4.20 Reachability-Information + +The Reachability-Information AVP is of type Unsigned32. It shall indicate the reachability of the subscriber. The following values are defined: + +REACHABLE\_FOR\_SMS (0) + +REACHABLE\_FOR\_DATA (1) + +### 8.4.21 EPS-Location-Information + +The EPS-Location-Information AVP is of type Grouped. It shall contain the information related to the user location relevant for EPS. It was originally defined in 3GPP TS 29.272 [49]. + +AVP format: + +``` +EPS-Location-Information ::= + [ MME-Location-Information ] + [ SGSN-Location-Information ] + *[AVP] +``` + +### 8.4.22 IMEI-Change + +The IMEI-Change AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 8.4.22-1: + +**Table 8.4.22-1: IMEI-Change** + +| Bit | Name | Description | +|---------------------------------------------------------------------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------| +| 0 | IMEI | This bit, when set, indicates that the IMEI has changed (regardless of whether the IMEI Software Version has changed or not). | +| 1 | IMEISV | This bit, when set, indicates that only the IMEI Software Version has changed but the IMEI has not changed. | +| NOTE 1: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | +| NOTE 2: Bits 0 and 1 shall not be set simultaneously. | | | + +When a change of IMEI(SV) is reported, the new IMEI(SV) values may be reported to the SCEF in the Terminal-Information AVP inside the Monitoring-Event-Report AVP (see clause 8.4.3). + +### 8.4.23 Feature-List AVP + +#### 8.4.23.1 Feature-List AVP for the S6t application + +The syntax of this AVP is defined in 3GPP TS 29.229 [7]. + +For the S6t application, the meaning of the bits shall be as defined in table 8.4.23-1 for the Feature-List-ID. + +Table 8.4.23-1: Features of Feature-List-ID used in S6t + +| Feature bit | Feature | M/O | Description | +|-------------|---------------------------------------|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | MONTE | O |

Configuration and reporting of monitoring events

This feature is applicable to from an SCEF with CIR/CIA command pair and the reporting of events to the SCEF with RIR/RIA command pair.

If the HSS does not support this feature, the SCEF shall not send monitoring event configurations to the HSS within CIR.

| +| 1 | AESE-Communication-Pattern | O |

Configuration of CP parameter sets

This feature is applicable to from an SCEF with CIR/CIA command pair.

If the HSS does not support this feature, the SCEF shall not send CP parameter set to the HSS within CIR.

| +| 2 | NIDD-Authorization | O |

Authorization of NIDD

This feature is applicable to from an SCEF with NIR/NIA command pair.

If the HSS indicates in the NIA command that it does not support Authorization of NIDD, the SCEF shall not send NIDD Authorizations requests to the HSS in subsequent NIR commands towards that HSS.

| +| 3 | Enhanced-Coverage-Restriction-Control | O |

Control Of Enhanced Coverage Restriction

This feature is applicable for the CIR/CIA command pair.

If the SCEF detects that the HSS does not support this feature, it may refrain from sending further CIR commands containing an Enhanced-Coverage-Restriction AVP or a CIR-Flags AVP with the bit for Enhanced-Coverage-Query set.

| +| 4 | NIDD Authorization Update | O |

Update/Revocation of NIDD Authorization

This feature is applicable for the NIR/NIA command pair. It shall not be supported when NIDD-Authorization is not supported.

If the SCEF indicates in the NIR command that it does not support NIDD Authorization Update, the HSS shall not send subsequent NIR commands to update or revoke a granted NIDD Authorization. The HSS may decide not to grant NIDD Authorization when Update/Revocation is not supported by the SCEF.

| +| 5 | Report-Eff-MONTE | O |

Reporting Efficiency for MONTE

This feature is applicable for the RIR/RIA command pair.

If the SCEF indicates in the CIR command that it does not support Reporting Efficiency for MONTE, the HSS shall not make use of RIR-flags to indicate the cancellation/removal of all monitoring events nor a change of SCEF authorization for one or more monitoring events.

| +| 6 | Event Cancellation Report | O |

Event Cancellation Report

This feature is applicable to from an SCEF for the CIR/CIA and RIR/RIA command pairs.

If the SCEF does not indicate in the CIR command that it does support Event Cancellation Report, the HSS shall not send a report indicating the cancellation of a report in the CIA or subsequent RIR commands towards that SCEF.

| +| 7 | Config-Eff-CP | O |

Configuration Efficiency for Communication Pattern

This feature is applicable for the CIR/CIA and RIR/RIA command pairs.

If the SCEF indicates in the CIR command that it does not support this feature, the HSS shall not make use of RIR-flags to indicate the removal of all communication pattern.

If the HSS indicates in the CIA command that it does not support this feature, the SCEF shall not set the CIR-flag "Delete All Communication Pattern" in a subsequent CIR command.

| + +| | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 8 | Config-Eff-NP | O |

Configuration Efficiency for Network Parameter Configuration

This feature is applicable for the CIR/CIA and RIR/RIA command pairs.

If the SCEF indicates in the CIR command that it does not support this feature, the HSS shall not make use of RIR-flags to indicate the removal of all Suggested Network Configuration.

If the HSS indicates in the CIA command that it does not support this feature, the SCEF shall not set the CIR-flag "Delete All Suggested Network Configurations" in a subsequent CIR command.

| +| 9 | Extended Reference IDs | O |

Extended Reference IDs

This feature is applicable for the CIR/CIA command pair.

If the SCEF detects that the HSS does not support this feature, it shall refrain from sending CIR commands containing 64-bit long SCEF Reference IDs.

| +| 10 | Dynamic-Group-Event-Monitoring | |

Dynamic Management of Group-based Event Monitoring

This feature is applicable for the CIR/CIA command pair.

If the SCEF detects that the HSS does not support this feature, it shall refrain from sending CIR commands to cancel or create the event monitoring for certain UEs (i.e. one individual UE or a sub-set of UEs) in a group of UEs for which there is a configured Monitoring Event.

If the HSS detects that the SCEF does not support this feature, it shall refrain from sending RIR commands to inform the SCEF that the event monitoring is cancelled for certain UEs (i.e. one individual UE or a sub-set of UEs) in a group of UEs for which there is a configured Monitoring Event.

| +|

Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "MONTE".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.

| | | | + +### 8.4.24 Monitoring-Event-Config-Status + +The Monitoring-Event-Config-Status AVP is of type Grouped, and it contains the details of the result of the handling of the Requested action for the Monitoring event. + +AVP format: + +``` +Monitoring-Event-Config-Status ::= + *[ Service-Report ] + { SCEF-Reference-ID } + [ SCEF-Reference-ID-Ext ] + [ SCEF-ID ] + *[AVP] +``` + +When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext AVP shall be used instead of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. + +### 8.4.25 AESE-Communication-Pattern + +The AESE-Communication-Pattern AVP is of type Grouped, and it shall contain the details of the Communication-Pattern from the SCEF. + +AVP format + +AESE-Communication-Pattern ::= + +[ SCEF-Reference-ID ] + [ SCEF-Reference-ID-Ext ] + { SCEF-ID } + \*[ SCEF-Reference-ID-for-Deletion ] + \*[ SCEF-Reference-ID-for-Deletion-Ext ] + \*[ Communication-Pattern-Set ] + [ MTC-Provider-Info ] + \*[ AVP ] + +At least one reference ID (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext) or a reference ID for deletion (either in SCEF-Reference-ID-for-Deletion or in SCEF-Reference-ID-for-Deletion-Ext) shall be present. + +When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. + +### 8.4.26 Communication-Pattern-Set + +The Communication-Pattern-Set AVP is of type Grouped, and it shall contain a set of Communication-Pattern. + +AVP format + +Communication-Pattern-Set ::= + +[ Periodic-Communication-Indicator ] + [ Communication-Duration-Time ] + [ Periodic-Time ] + \*[ Scheduled-Communication-Time ] + [ Stationary-Indication ] + [ Reference-ID-Validity-Time ] + [ Traffic-Profile ] + [ Battery-Indicator ] + \*[ AVP ] + +Communication-duration-time and Periodic-Time shall be only provided when the Periodic-Communication-Indicator is set to PERIODICALLY. + +If the Reference-ID-Validity-Time AVP is absent, it indicates that there is no expiration time defined for the Communication-Pattern-Set. + +### 8.4.27 Periodic-Communication-Indicator + +The Periodic-communication-indicator AVP is of type Unsigned32. The following values are defined: + +PERIODICALLY (0) + +ON\_DEMAND (1) + +### 8.4.28 Communication-duration-time + +The Communication-duration-time AVP is of type Unsigned32 and shall provide the time in seconds of the duration of the periodic communication. + +### 8.4.29 Periodic-time + +Periodic-time AVP is of type Unsigned32 and shall provide the time in seconds of the interval for periodic communication. + +### 8.4.30 Scheduled-communication-time + +The Scheduled-communication-time AVP is of type Grouped. + +AVP format + +Scheduled-communication-time ::= + +[ Day-Of-Week-Mask ] + +[ Time-Of-Day-Start ] + +[ Time-Of-Day-End ] + +\*[AVP] + +If Day-Of-Week-Mask is not provided this shall be interpreted as every day of the week. + +If Time-Of-Day-Start is not provided, starting time shall be set to start of the day(s) indicated by Day-Of-Week-Mask. + +If Time-Of-Day-End is not provided, ending time is end of the day(s) indicated by Day-Of-Week-Mask. + +### 8.4.31 Stationary indication + +The Stationary-indication AVP are of type Unsigned32. + +STATIONARY\_UE (0) + +MOBILE\_UE (1) + +### 8.4.32 AESE-Communication-Pattern-Config-Status + +The AESE-Communication-Pattern-Config-Status AVP is of type Grouped, and it shall contain the details of the outcome of Communication-Pattern handling from the HSS. + +AVP format + +AESE-Communication-Pattern-Config-Status ::= + +{ SCEF-Reference-ID } + +[ SCEF-Reference-ID-Ext ] + +[ SCEF-ID ] + +[ AESE-Error-Report ] + +\*[AVP] + +When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext AVP shall be used instead of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. + +### 8.4.33 AESE-Error-Report + +The AESE-Error-Report AVP is of type Grouped, and it contains the details of the Error occurred during handling of the Requested action for the Communication-Pattern-Set. + +AVP format + +``` +AESE-Error-Report ::= + [ Service-Result ] + *[AVP] +``` + +### 8.4.34 MME-Location-Information + +The MME-Location-Information AVP is of type Grouped. It shall contain the information related to the user location relevant for the MME. It was originally defined in 3GPP TS 29.272 [49]. + +AVP format + +``` +MME-Location-Information ::= + [ E-UTRAN-Cell-Global-Identity ] + [ Tracking-Area-Identity ] + [ Current-Location-Retrieved ] + [ Age-Of-Location-Information ] + [ User-CSG-Information ] + [ eNodeB-ID ] + [ Extended-eNodeB-ID ] + *[AVP] +``` + +### 8.4.35 SGSN-Location-Information + +The SGSN-Location-Information AVP is of type Grouped. It shall contain the information related to the user location relevant for the SGSN. It was originally defined in 3GPP TS 29.272 [49]. + +AVP format + +``` +SGSN-Location-Information ::= + [ Cell-Global-Identity ] + [ Service-Area-Identity ] + [ Routing-Area-Identity ] + [ Current-Location-Retrieved ] + [ Age-Of-Location-Information ] + [ User-CSG-Information ] + *[AVP] +``` + +### 8.4.36 User-Identifier + +The User-Identifier AVP is of type Grouped and it contains the different identifiers used by the UE. This AVP is defined in clause 6.4.2. The AVP format for the S6t interface shall be as given below. + +AVP format: + +User-Identifier ::= + +[ User-Name ] + [ MSISDN ] + [ External-Identifier ] + [ Type-Of-External-Identifier ] + \*[AVP] + +This AVP shall contain one of the identifiers (IMSI, MSISDN or External-Identifier). The IMSI of the UE shall be included (when applicable) in the User-Name AVP. + +The External-Identifier AVP may either contain the identity of an individual UE or the identity of a Group of UEs. The Type-Of-External-Identifier is used to indicate which type of identity is carried in the External-Identifier. When the Type-Of-External-Identifier is not present, it means the External-Identifier AVP contains the identity of an individual UE. + +### 8.4.37 Service-Result + +The Service-Result AVP is of type Grouped, and it contains the Error code identified during the handling of the Requested action for the Monitoring event. + +AVP format: + +Service-Result ::= + +[ Vendor-Id ] + [ Service-Result-Code ] + \*[AVP] + +If the Service-Result-Code contains an Experimental-Result-Code value defined by 3GPP, then the Vendor-Id shall be set to the value 10415. If the Service-Result-Code contains a Result-Code value defined in the Diameter base protocol by IETF (see IETF RFC 6733 [23]), then the Vendor-Id shall be absent or set to the value 0. + +### 8.4.38 Service-Result-Code + +The Service-Result-Code AVP is of type Unsigned32. This AVP shall contain either the value of an Experimental-Result-Code defined by 3GPP or the value of a Result-Code defined in Diameter base protocol by IETF (see IETF RFC 6733 [23]). + +### 8.4.39 CIR-Flags + +The CIR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 8.4.39-1: + +**Table 8.4.39-1: CIR-Flags** + +| Bit | Name | Description | +|-------|-------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| 0 | Delete all Monitoring events | This bit shall be set if the SCEF wants to delete all Monitoring events for a subscriber stored in the HSS. | +| 1 | Enhanced Coverage Query | This bit shall be set if the SCEF wants to query the current settings of the Enhanced-Coverage-Restriction. | +| 2 | IMSI Group Id retrieval | This bit shall be set if the SCEF wants to retrieve the IMSI Group Id that corresponds to the provided External Group Identifier. | +| 3 | Delete all Communication Pattern | This bit shall be set if the SCEF wants to delete all Communication Pattern for a subscriber stored in the HSS. | +| 4 | Delete all Network Parameter Configurations | This bit shall be set if the SCEF wants to delete all Suggested Network Configuration for a subscriber stored in the HSS. | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | + +### 8.4.40 Supported-Services + +The Supported-Services AVP is of type Grouped and it shall contain the different bit masks representing the services supported by the HSS: + +AVP format + +``` +Supported-Services ::= + [ Supported-Monitoring-Events ] + [ Node-Type ] + *[AVP] +``` + +### 8.4.41 Supported-Monitoring-Events + +The Supported-Monitoring-Events AVP is of type Unsigned64 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 8.4.41-1: + +**Table 8.4.41-1: Supported-Monitoring-Events** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | UE and UICC and/or new IMSI-IMEI-SV association | This bit shall be set if Monitoring the association of the UE and UICC and/or new IMSI-IMEI-SV association monitoring event is supported in the HSS | +| 1 | UE-reachability | This bit shall be set if UE reachability monitoring event is supported in the HSS/MME/SGSN | +| 2 | Location-of-the-UE | This bit shall be set if Location of the UE and change in location of the UE monitoring event is supported in the HSS/MME/SGSN | +| 3 | Loss-of-connectivity | This bit shall be set if Loss of connectivity monitoring event is supported in the HSS/MME/SGSN | +| 4 | Communication-failure | This bit shall be set if Communication failure monitoring event is supported in the HSS/MME/SGSN | +| 5 | Roaming-status | This bit shall be set if Roaming status (i.e. Roaming or No Roaming) of the UE, and change in roaming status of the UE monitoring event is supported in the HSS | +| 6 | Availability after DDN failure | This bit shall be set if Availability after DDN failure monitoring event is supported in the HSS/MME/SGSN | +| 7 | Idle Status Indication | This bit shall be set if Idle Status Indication monitoring event is supported in the HSS/MME/SGSN in addition to Availability after DDN failure and UE reachability | +| 8 | PDN Connectivity Status | This bit shall be set if PDN Connectivity Status monitoring event is supported in the HSS/MME/SGSN | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +Absence of this AVP shall have the same meaning as all bits cleared (i.e. serving node does not support MONTE). + +If RIR-flags is included in Reporting-Information-Request to indicate a change of authorized monitoring events, each bit in Supported-Monitoring-Events AVP, if cleared, shall indicate the SCEF that associated monitoring event is not authorized. + +### 8.4.42 Reference-ID-Validity-Time + +The Reference-ID-Validity-Time AVP is of type Time (see IETF RFC 6733 [23]), and contains the point of time when the CP sets associated to an SCEF-Reference-ID (in combination with an SCEF-ID) becoming invalid and shall be deleted. + +### 8.4.43 Event-Handling + +The Event-handling AVP is of type Unsigned32. The following Values are defined: + +SUSPEND (0) + +RESUME (1) + +CANCEL (2) + +### 8.4.44 NIDD-Authorization-Request + +The NIDD-Authorization-Request AVP is of type Grouped, and it contains the details for the Authorisation of NIDD via the SCEF. + +AVP format: + +``` +NIDD-Authorization-Request ::= + [ Service-Selection ] + [ Requested-Validity-Time ] + *[AVP] +``` + +### 8.4.45 NIDD-Authorization-Response + +The NIDD-Authorization-Response AVP is of type Grouped, and it contains the information to be provided triggered by NIDD-Authorization-Request. + +AVP format: + +``` +NIDD-Authorization-Response ::= + [ MSISDN ] + [ User-Name ] + [ External-Identifier ] + [ Granted-Validity-Time ] + *[AVP] +``` + +The User-Name AVP, when present, shall contain the IMSI. + +### 8.4.46 DRMP + +The DRMP AVP is of type Enumerated and it is defined in IETF RFC 7944 [20]. This AVP allows the HSS and the SCEF over the S6t interface to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +### 8.4.47 Service-Report + +The Service-Report AVP is of type Grouped, and it contains the result of the handling of the Requested action for the Monitoring event, the type of node and the services it supports. + +AVP format: + +``` +Service-Report ::= + [ Service-Result ] + [ Node-Type ] + *[AVP] +``` + +### 8.4.48 Node-Type + +The Node-Type AVP is of type Unsigned32 and shall identify the type of node sending the information. The following values are defined: + +HSS (0) +MME (1) +SGSN (2) + +### 8.4.49 Service-Selection + +The Service-Selection AVP is of type of UTF8String. This AVP shall contain the APN Network Identifier (i.e. an APN without the Operator Identifier) per 3GPP TS 23.003 [11], clauses 9.1 & 9.1.1.). + +The contents of the Service-Selection AVP shall be formatted as a character string composed of one or more labels separated by dots ("."). + +This AVP is defined in IETF RFC 5778 [21]. + +### 8.4.50 S6t-HSS-Cause + +The S6t-HSS-Cause AVP is of type Unsigned32 and it contains a bitmask. The meaning of the bits is defined in table 8.4.50-1: + +**Table 8.4.50-1: S6t-HSS-Cause** + +| Bit | Name | Description | +|-------|----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Absent Subscriber | This bit, when set, indicates that the configuration could not be forwarded and/or the UE is not reachable at the serving node, either because there is no serving node registered in the HSS or because the subscriber is purged in the registered serving node(s). | +| 1 | Group Event Monitoring Partially Cancel | This bit, when set, indicates that a configured group-based event monitoring is cancelled for the member UE. | +| NOTE: | Bits not defined in this table shall be cleared by the sending node and discarded by the receiving node. | | + +### 8.4.51 Enhanced-Coverage-Restriction + +The Enhanced-Coverage-Restriction AVP is of type Grouped and shall identify either a complete (and possibly empty) list of serving PLMNs where Enhanced Coverage shall be restricted or a complete (and possibly empty) list of serving PLMNs where Enhanced Coverage shall not be restricted. + +AVP format: + +``` +Enhanced-Coverage-Restriction ::= + [ Restricted-PLMN-List ] + [ Allowed-PLMN-List ] + *[AVP] +``` + +### 8.4.52 Enhanced-Coverage-Restriction-Data + +The Enhanced-Coverage-Restriction-Data AVP is of type Grouped and shall identify the current visited PLMN (if any) and the current settings of Enhanced-Coverage-Restriction. + +AVP format: + +``` +Enhanced-Coverage-Restriction-Data ::= + { Enhanced-Coverage-Restriction } + [ Visited-PLMN-Id ] + *[AVP] +``` + +### 8.4.53 Restricted-PLMN-List + +The Restricted-PLMN-List AVP is of type Grouped and shall identify the complete set of serving PLMNs where Enhanced Coverage is restricted. + +AVP format: + +``` +Restricted-PLMN-List ::= + *[ Visited-PLMN-Id ] + *[AVP] +``` + +Absence of Visited-PLMN-Id AVPs indicates that Enhanced Coverage is allowed in all serving PLMNs. + +### 8.4.54 Allowed-PLMN-List + +The Allowed-PLMN-List AVP is of type Grouped and shall identify the complete set of serving PLMNs where Enhanced Coverage is allowed. + +AVP format: + +``` +Allowed-PLMN-List ::= + *[ Visited-PLMN-Id ] + *[AVP] +``` + +Absence of Visited-PLMN-Id AVPs indicates that Enhanced Coverage is restricted in all serving PLMNs. + +### 8.4.55 Requested-Validity-Time + +The Requested-Validity-Time AVP is of type Time (see IETF RFC 6733 [23]), and contains the point of time after which the SCEF is willing to consider a granted NIDD authorization as being implicitly revoked. + +### 8.4.56 Granted-Validity-Time + +The Granted-Validity-Time AVP is of type Time (see IETF RFC 6733 [23]), and contains the point of time after which the HSS removes a stored NIDD Authorization and after which the SCEF shall consider a granted NIDD authorization as being implicitly revoked. + +A value in the past indicates that the NIDD Authorization is explicitly revoked. + +### 8.4.57 NIDD-Authorization-Update + +The NIDD-Authorization-Update AVP is of type Grouped, and it contains the information to be provided triggered by an update or revocation of the NIDD-Authorization. + +AVP format: + +``` +NIDD-Authorization-Update ::= + *[ APN-Validity-Time ] + *[AVP] +``` + +### 8.4.58 Loss-Of-Connectivity-Reason + +The Loss-Of-Connectivity-Reason AVP is of type Unsigned32 and shall identify the reason why loss of connectivity is reported. The following values are defined: + +- UE\_DETACHED\_MME (0) +- UE\_DETACHED\_SGSN (1) +- MAX\_DETECTION\_TIME\_EXPIRED\_MME (2) +- MAX\_DETECTION\_TIME\_EXPIRED\_SGSN (3) +- UE\_PURGED\_MME (4) +- UE\_PURGED\_SGSN (5) + +### 8.4.59 Group-Reporting-Guard-Timer + +The Group-Reporting-Guard-Timer AVP is of type Unsigned32. The Group Reporting Guard Timer indicates an interval in seconds after which time the HSS (at the latest) shall send aggregated Status Indications and/or event report(s) which have been detected for UEs that are part of a group. + +### 8.4.60 CIA-Flags + +The CIA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 8.4.60-1: + +**Table 8.4.60-1: CIA-Flags** + +| Bit | Name | Description | +|-------|-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Group-Configuration-In-Progress | This bit is set when the HSS indicates that the HSS is processing the Group Monitoring configuration(s) and will report further status using the RIR command. | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | + +### 8.4.61 Group-Report + +The Group-Report AVP is of type Grouped, and it contains the information to be reported as requested by Monitoring-Event-Configuration or Suggested-Network-Configuration for a group. + +VP format: + +``` +Group-Report ::= + { SCEF-Reference-ID } + [ SCEF-Reference-ID-Ext ] + [ SCEF-ID ] + *[ Group-Report-Item ] + *[AVP] +``` + +When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext AVP shall be used instead of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. + +### 8.4.62 Group-Report-Item + +The Group-Report-Item AVP is of type Grouped, and it contains the information to be reported as requested by Monitoring-Event-Configuration or Suggested-Network-Configuration for a specific UE as part of group processing. + +AVP format: + +``` +Group-Report-Item ::= + { User-Identifier } + [ Visited-PLMN-Id ] + [ Roaming-Information ] + [ IMEI-Change ] + [ Reachability-Information ] + [ Maximum-UE-Availability-Time ] +``` + +[ EPS-Location-Information ] + [ Monitoring-Type ] + \*[ Service-Report ] + [ S6t-HSS-Cause ] + [ Idle-Status-Indication ] + [ Reporting-Time-Stamp ] + [ Updated-Network-Configuration ] + \*[ SCEF-Reference-ID-for-Deletion ] + \*[ SCEF-Reference-ID-for-Deletion-Ext ] + [ Event-Handling ] + [ Loss-Of-Connectivity-Reason ] + \*[ PDN-Connectivity-Status-Report ] + \*[AVP] + +When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-for-Deletion-Ext AVP shall be used instead of SCEF-Reference-ID-for-Deletion. + +## 8.4.63 RIR-Flags + +The RIR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 8.4.63-1: + +**Table 8.4.63-1: RIR-Flags** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Group-Configuration-In-Progress | This bit is set when the HSS indicates that the HSS is processing the Group Monitoring configuration and will report further status/reports for the group using additional RIR command(s). | +| 1 | All-Monitoring-Events-Cancelled | This bit is set when the HSS indicates that all existing events (if any) are cancelled, e.g. due to subscription removal | +| 2 | Change-Of-Authorized-Monitoring-Events | This bit is set when the HSS indicates that the SCEF authorization for one or more monitoring events has changed. | +| 3 | All-Communication-Pattern-Cancelled | This bit is set when the HSS indicates that all existing communication pattern (if any) are cancelled, e.g. due to subscription removal | +| 4 | All-Suggested-Network-Configuration-Cancelled | This bit is set when the HSS indicates that all existing Network Parameter Configurations (if any) are cancelled, e.g. due to subscription removal | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +## 8.4.64 Type-Of-External-Identifier + +The Type-Of-External-Identifier AVP is of type Unsigned32 and it shall indicate which type of identity is carried in the External-Identifier AVP. The following values are defined: + +EXTERNAL-UE-IDENTIFIER-TYPE (0) + +The value 0 indicates the External-Identifier AVP carries the identity of an individual UE. + +## EXTERNAL-GROUP-IDENTIFIER-TYPE (1) + +The value 1 indicates the External-Identifier AVP carries the identity of a Group of UEs. + +## 8.4.65 APN-Validity-Time + +The APN-Validity-Time AVP is of type Grouped, and it contains the APN (within the Service-Selection AVP) and the updated validity time for the granted NIDD authorization associated to the APN. + +AVP format: + +``` +APN-Validity-Time ::= + { Granted-Validity-Time } + [ Service-Selection ] + *[AVP] +``` + +Absence of Service-Selection AVP indicates that the Granted-Validity-Time applies to all granted NIDD Authorizations for the user. In this case only one APN-Validity-Time AVP shall be present within the NIDD-Authorization-Update AVP. + +## 8.4.66 Suggested-Network-Configuration + +The Suggested-Network-Configuration AVP is of type Grouped, and it shall contain the details for configuration for Suggested Network configuration. + +AVP format: + +``` +Suggested-Network-Configuration ::= + { SCEF-Reference-ID } + [ SCEF-Reference-ID-Ext ] + { SCEF-ID } + [ Subscribed-Periodic-RAU-TAU-Timer ] + [ Active-Time ] + [ DL-Buffering-Suggested-Packet-Count ] + [ MTC-Provider-Info ] + *[ SCEF-Reference-ID-for-Deletion ] + *[ SCEF-Reference-ID-for-Deletion-Ext ] + *[AVP] +``` + +If the values of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion are the same, no Network Parameter Configurations AVP(s) shall be present, that is, SCEF-Reference-ID-for-Deletion takes precedence. If the values of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion are not the same, Network Parameter Configurations AVP(s) are related to SCEF-Reference-ID. + +When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. + +## 8.4.67 Monitoring-Event-Report-Status + +The Monitoring-Event-Report-Status AVP is of type Grouped, and it contains the result of a specific event report (identified by the pair SCEF-ID and SCEF-Reference-ID) received by the SCEF. + +AVP format: + +``` +Monitoring-Event-Report-Status ::= + { SCEF-Reference-ID } + [ SCEF-Reference-ID-Ext ] + { SCEF-ID } + [ Result-Code ] + [ Experimental-Result-Code ] + *[AVP] +``` + +When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext AVP shall be used instead of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. + +## 8.4.68 PLMN-ID-Requested + +The PLMN-ID-Requested AVP is of type Enumerated and it shall indicate whether the PLMN-ID value needs to be returned in the event report associated to the monitoring type "ROAMING\_STATUS". The following values are defined: + +TRUE (0) + +The value TRUE (0) indicates that the PLMN-ID value shall be returned in the corresponding event report for "ROAMING\_STATUS". + +FALSE (1) + +The value FALSE (1) indicates that the PLMN-ID value shall not be returned in the corresponding event report for "ROAMING\_STATUS". + +The default value, when this AVP is not included, is TRUE (0). + +## 8.4.69 AdditionalIdentifiers + +The AdditionalIdentifiers AVP is of type Grouped, and it shall contain External Group Identifiers. + +AVP format: + +``` +AdditionalIdentifiers ::= + *[ External-Identifier ] + *[AVP] +``` + +## 8.4.70 NIR-Flags + +The NIR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 8.4.70-1: + +**Table 8.4.70-1: NIR-Flags** + +| Bit | Name | Description | +|-------|-------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Incomplete Group-User-Identifier-List | This bit is set when the SCEF indicates that the union of the Group User Identifier Lists sent in this and in previous messages is still incomplete and more segments of the list will follow within subsequent NIR commands. The bit is not set when NIR contains the last segment of the list. | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | + +## 8.4.71 Reporting-Time-Stamp + +The Reporting-Time-Stamp AVP is of type Time (see IETF RFC 6733 [23]), and contains the point of time when the report was generated. + +## 8.4.72 NIA-Flags + +The NIA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 8.4.72-1: + +**Table 8.4.72-1: NIA-Flags** + +| Bit | Name | Description | +|-------|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Incomplete Group-User-Identifier-List | This bit is set when the HSS indicates that the sent Group User Identifier List is incomplete and more segments of the list will follow within subsequent NIR commands. | +| NOTE: | Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | + +## 8.4.73 Group-User-Identifier + +The Group-User-Identifier AVP is of type Grouped and it contains the External-Identifier or MSISDN and the IMSI of a user belonging to a group. + +AVP format: + +Group-User-Identifier ::= + +[ User-Name ] + +[ MSISDN ] + +[ External-Identifier ] + +\*[AVP] + +## 8.4.74 MTC-Provider-Info + +The MTC-Provider-Info AVP is of type Grouped and it contains the information associated to the MTC Service Provider and/or MTC Application (see 3GPP TS 23.682 [2], clause 5.6). + +AVP format: + +MTC-Provider-Info ::= + +[ MTC-Provider-ID ] + +\*[AVP] + +## 8.4.75 MTC-Provider-ID + +The MTC-Provider-ID AVP is of type UTF8String and it contains a character string representing the identity of the MTC Service Provider and/or MTC Application. + +## 8.4.76 PDN-Connectivity-Status-Configuration + +The PDN-Connectivity-Status-Configuration AVP is of type Grouped and it indicates the APN(s) for which the PDN Connectivity Status is to be monitored. If the Service-Selection AVP is included, then the monitoring applies to that specific APN; if the Service-Selection is absent, the monitoring request applies to all APNs. + +AVP format: + +``` +PDN-Connectivity-Status-Configuration ::= + [ Service-Selection ] + *[AVP] +``` + +## 8.4.77 PDN-Connectivity-Status-Report + +The PDN-Connectivity-Status-Report AVP is of type Grouped and it contains the different parameters associated to the reporting of the PDN Connectivity Status event type. + +AVP format: + +``` +PDN-Connectivity-Status-Report ::= + { Service-Selection } + { PDN-Connectivity-Status-Type } + [ PDN-Type ] + [ Non-IP-PDN-Type-Indicator ] + [ Non-IP-Data-Delivery-Mechanism ] + *2 [ Served-Party-IP-Address ] + *[AVP] +``` + +Absence of PDN-Connectivity-Status-Report in Monitoring-Event-Report AVP including Monitoring-Type AVP with value PDN\_CONNECTIVITY\_STATUS (10) in responses (immediate report) shall indicate that none of the requested APNs are active. The AVP shall always be present in RIR command if Monitoring-Event-Report AVP includes Monitoring-Type AVP with value PDN\_CONNECTIVITY\_STATUS (10). + +The PDN-Type AVP is defined in 3GPP TS 29.272 [14] and it shall be present when the PDN Connection is an IP connection, and it may contain the value IPv4, IPv6 or IPv4v6. The value IPv4\_OR\_IPv6 shall not be used for this event reporting. If PDN-Type AVP is present, then the Non-IP-PDN-Type-Indicator and Non-IP-Data-Delivery-Mechanism AVPs shall be absent. + +The Non-IP-PDN-Type-Indicator AVP is defined in 3GPP TS 29.272 [14] and it indicates whether the PDN Connection is of type "Non-IP". If this AVP is present, it shall be set to TRUE and the PDN-Type AVP shall be absent. + +The Non-IP-Data-Delivery-Mechanism AVP is defined in 3GPP TS 29.272 [14] and it shall be present if the Non-IP-PDN-Type-Indicator AVP is present and set to TRUE. It shall indicate whether the Non-IP data delivery is done via Point-To-Point tunnelling over the SGi interface, or via the SCEF. + +NOTE: In 3GPP TS 23.682 [2], clause 5.6.3.9, the reporting of the data delivery mechanism is described in terms of a parameter called "3GPP Interface Indication"; however, the conveyance of such information inside the PDN-Connectivity-Status-Report AVP is done in the present specification in terms of the same set of AVPs used for the definition of the subscription data in 3GPP TS 29.272 [14]. The correspondence of the values of the parameter "3GPP Interface Indication" from 3GPP TS 23.682 [2] is as follows: + +- "API-Connectivity" corresponds to the presence of Non-IP-Data-Delivery-Mechanism set to value SCEF-BASED-DATA-DELIVERY; +- "IP-connectivity" corresponds to the presence of PDN-Type AVP, and the absence of Non-IP-PDN-Type-Indicator and Non-IP-Data-Delivery-Mechanism AVPs; +- "Other" corresponds to the presence of Non-IP-Data-Delivery-Mechanism set to value SGi-BASED-DATA-DELIVERY. + +The Served-Party-IP-Address AVP may be present 0, 1 or 2 times, and contain the IP address(es) used by the UE (if available) and, if present, they shall contain either of: + +- an IPv4 address, or +- an IPv6 address/prefix, or +- both, an IPv4 address and an IPv6 address/prefix (for dual-stack UEs with PDN-Type set to "IPv4v6"). + +For the IPv6 prefix, the lower 64 bits of the address shall be set to zero. + +## 8.4.78 PDN-Connectivity-Status-Type + +The PDN-Connectivity-Status-Type AVP is of type Unsigned32 and it shall indicate the status of the PDN Connection being monitored. The following values are defined: + +### CREATED (0) + +The value CREATED (0) indicates that the event corresponds to the creation of a new PDN Connection on the monitored APN. + +### DELETED (1) + +The value DELETED (1) indicates that the event corresponds to the deletion of a PDN Connection on the monitored APN. + +## 8.4.79 Traffic-Profile + +The Traffic-Profile AVP is of type Unsigned32. The following values are defined: + +SINGLE\_TRANSMISSION\_UL (0) + +SINGLE\_TRANSMISSION\_DL (1) + +DUAL\_TRANSMISSION\_UL\_WITH\_SUBSEQUENT\_DL (2) + +DUAL\_TRANSMISSION\_DL\_WITH\_SUBSEQUENT\_UL (3) + +MULTI\_TRANSMISSION (4) + +## 8.4.80 Updated-Network-Configuration + +The Updated-Network-Configuration AVP is of type Grouped. If not included inside Group-Report-Item AVP, it shall contain only the Network Parameter Configurations which were received in a previous CIR command and have been updated due to a new CIR command. If included inside Group-Report-Item AVP, it shall contain the current values applied in the network for each group member. + +AVP format: + +``` +Updated-Network-Configuration ::= + { SCEF-ID } + [ SCEF-Reference-ID ] + [ SCEF-Reference-ID-Ext ] + *[ SCEF-Reference-ID-for-Deletion ] + *[ SCEF-Reference-ID-for-Deletion-Ext ] + [ Subscribed-Periodic-RAU-TAU-Timer ] + [ Active-Time ] + [ DL-Buffering-Suggested-Packet-Count ] + *[AVP] +``` + +At least one reference ID (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext) or a reference ID for deletion (either in SCEF-Reference-ID-for-Deletion or in SCEF-Reference-ID-for-Deletion-Ext) shall be present. + +When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. + +## 8.4.81 Battery-Indicator + +The Battery-Indicator AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits shall be as defined in table 8.4.81-1: + +**Table 8.4.81-1: Battery-Indicator** + +| Bit | Name | Description | +|--------------------------------------------------------------------------------------------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | NO BATTERY | When this bit is set it indicates that UE is not battery powered. | +| 1 | BATTERY_REPLACEABLE_INDICATION | When this bit is set it indicates that battery of the UE is replaceable, when this bit is not set it indicates that battery of UE is not replaceable. | +| 2 | BATTERY_RECHARGEABLE_INDICATION | When this bit is set it indicates that the battery of the UE is rechargeable, when this bit is not set it indicates that battery of the UE is not rechargeable. | +| NOTE1: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | +| NOTE2: If bit 0 is set, bit 1 and bit 2 shall be cleared. | | | + +## 8.4.82 SCEF-Reference-ID-Ext + +The SCEF-Reference-ID-Ext AVP is of type Unsigned64 and it shall contain a 64-bit identifier provided by the SCEF, which shall be used instead of the 32-bit identifier SCEF-Reference-ID, when supported by both SCEF and HSS. + +## 8.4.83 SCEF-Reference-ID-for-Deletion-Ext + +The SCEF-Reference-ID-for-Deletion-Ext AVP is of type Unsigned64 and it shall contain a 64-bit identifier provided by the SCEF, which shall be used instead of the 32-bit identifier SCEF-Reference-ID-for-Deletion, when supported by both SCEF and HSS. + +## 8.4.84 Exclude-Identifiers + +The Exclude-Identifiers AVP is of type Grouped, and it shall contain External Group Identifiers or MSISDNs. + +AVP format: + +``` +Exclude-Identifiers ::= + *[ External-Identifier ] + *[ MSISDN ] + *[AVP] +``` + +## 8.4.85 Include-Identifiers + +The Include-Identifiers AVP is of type Grouped, and it shall contain External Group Identifiers or MSISDNs. + +AVP format: + +``` +Include-Identifiers ::= + *[ External-Identifier ] + *[ MSISDN ] + *[AVP] +``` + +--- + +# Annex A (normative): Diameter overload control mechanism + +## A.1 General + +IETF RFC 7683 [15] specifies a Diameter overload control mechanism which includes the definition and the transfer of related AVPs between Diameter nodes. + +--- + +## A.2 S6m interface + +### A.2.1 General + +The Diameter overload control mechanism is an optional feature over the S6m interface. + +It is recommended to make use of the IETF RFC 7683 [15] on the S6m interface where, when applied, the MTC-IWF shall behave as a reacting node and the HSS as a reporting node. + +NOTE: There is no need to support this mechanism in the other way (overload of the MTC-IWF) as no Diameter request commands are sent by the HSS to the MTC-IWF. + +### A.2.2 HSS behaviour + +The HSS requests traffic reduction from the MTC-IWF when it is in an overload situation, by including OC-OLR AVP in answer commands as described in IETF RFC 7683 [15]. + +The HSS identifies that it is in an overload situation by implementation specific means. For example, the HSS may take into account the traffic over the S6m interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources etc. + +The HSS determines the specific contents of the OC-OLR AVP in overload reports and the HSS decides when to send OC-OLR AVPs by implementation specific means. + +## A.2.3 MTC-IWF behaviour + +The MTC-IWF applies required traffic reduction received in answer commands to subsequent applicable requests, as per IETF RFC 7683 [15]. + +Requested traffic reduction is achieved by the MTC-IWF by implementation specific means. For example, it may implement message throttling with prioritization. + +Annex B gives guidance on message prioritisation over the S6m interface. + +--- + +## A.3 S6t interface + +### A.3.1 General + +The Diameter overload control mechanism is an optional feature over the S6t interface. + +It is recommended to make use of the IETF RFC 7683 [15] on the S6t interface where, when applied, the SCEF shall behave as a reacting node and the HSS as a reporting node. + +NOTE: With the current services used on this interface there is no need to support this mechanism in the other direction (overload of the SCEF) as the number of Diameter request commands sent by the HSS to the SCEF is determined by the SCEF in one earlier command of the SCEF and they corresponds to non-frequent events. + +### A.3.2 HSS behaviour + +The HSS requests traffic reduction from the SCEF when it is in an overload situation, by including OC-OLR AVP in answer commands as described in IETF RFC 7683 [15]. + +The HSS identifies that it is in an overload situation by implementation specific means. For example, the HSS may take into account the traffic over the S6t interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources etc. + +The HSS determines the specific contents of the OC-OLR AVP in overload reports and the HSS decides when to send OC-OLR AVPs by implementation specific means. + +### A.3.3 SCEF behaviour + +The SCEF applies required traffic reduction received in answer commands to subsequent applicable requests, as per IETF RFC 7683 [15]. + +Requested traffic reduction is achieved by the SCEF by implementation specific means. For example, it may implement monitoring event activation throttling with prioritization. + +--- + +## Annex B (Informative): Diameter overload control node behaviour + +### B.1 Introduction + +Annex B gives guidance on the Diameter overload control node behaviours regarding message prioritisation over the S6m and S6t interface. + +--- + +### B.2 Message prioritisation over S6m + +This clause gives an analysis of possible behaviours of the MTC-IWF regarding message prioritisation as guidance and for an informative purpose. + +When the HSS is overloaded, the MTC-IWF will receive overload reports from the HSS requesting a reduction of requests sent by the MTC-IWF. This will apply to the SIR request commands. + +The MTC-IWF can consider some messages with a lower or a higher priority; lower priority messages will be candidates for throttling before higher priority messages. + +Following considerations can be taken into account: + +- SIR messages for a given SCS can have a lower priority according to operator policies; +- If a SCS node generates a peak signalling over the Tsp interface, SIR messages over S6m related to this SCS can have a lower priority; +- The SIR messages over S6m related to a recall procedure or a replace procedure over the Tsp interface (see 3GPP TS 29.368 [13]) may have a lower priority according to operator policies. + +--- + +### B.3 Message prioritisation over S6t + +This clause gives an analysis of possible behaviours of the SCEF regarding message prioritisation as guidance and for an informative purpose. + +When the HSS is overloaded, the SCEF will receive overload reports from the HSS requesting a reduction of requests sent by the SCEF. This will apply to the CIR request commands. + +The SCEF can consider some messages with a lower or a higher priority; lower priority messages will be candidates for throttling before higher priority messages. + +Following considerations can be taken into account: + +- CIR messages for a given SCEF can have a lower priority according to operator policies; +- If a SCEF node generates a peak signalling over the S6t interface, CIR messages from this SCEF can have a lower priority; + +--- + +## Annex C (normative): Diameter message priority mechanism + +### C.1 General + +IETF 7944 [20] specifies a Diameter routing message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may leverage the relative priority of Diameter messages into routing, resource allocation, set the DSCP marking for transport of the associated Diameter message, and also abatement decisions when overload control is applied. + +It is recommended to make use of IETF 7944 [20] over the S6m, S6n and S6t interfaces of an operator network when the overload control defined in Annex A is applied on these interfaces. + +--- + +### C.2 S6m, S6n, S6t interfaces + +The Diameter message priority mechanism is an optional feature which may apply on one or several of the S6m, S6n, S6t interfaces. + +A 3GPP functional entity supporting the Diameter message priority mechanism over one or several of the S6m, S6n, S6t interfaces shall comply with IETF RFC 7944 [20]. + +A 3GPP functional entity sending a request shall determine the required priority according to its policies. When priority is required, it shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the request according to the required priority level. + +When the 3GPP functional entity receives the corresponding response, it shall prioritise received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When a 3GPP functional entity receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, it may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, it shall include the DRMP AVP in the response. + +The decisions of the 3GPP functional entity for a required priority and for the priority level value are implementation specific. + +If: + +- a 3GPP functional entity supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the 3GPP functional entity shall set the DSCP marking for transport of the request or response according to the required priority level. + +Diameter requests related to high priority traffic should contain a DRMP AVP with a high priority of which the level value is operator dependent. + +--- + +## Annex D (normative): Diameter load control mechanism + +### D.1 General + +IETF RFC 8583 [22] specifies a mechanism for sharing of Diameter load information. It includes the definition and the transfer of related AVPs between Diameter nodes. + +--- + +### D.2 S6m interface + +#### D.2.1 General + +The Diameter load control mechanism is an optional feature over the S6m interface. + +It is recommended to make use of IETF RFC 8583 [22] on the S6m interface where, when applied, the MTC-IWF shall behave as reacting nodes and the HSS as a reporting node. + +#### D.2.2 HSS behaviour + +The HSS may report its current load by including a Load AVP of type HOST in answer commands as described in IETF RFC 8583 [22]. + +The HSS calculates its current load by implementation specific means. For example, the HSS may take into account the traffic over the S6m interface or other interfaces, the level of usage of internal resources (e.g. CPU, memory), the access to external resources, etc. + +The HSS determines when to send Load AVPs of type HOST by implementation specific means. + +#### D.2.3 MTC-IWF behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the MTC-IWF may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [22]. + +--- + +### D.3 S6t interface + +#### D.3.1 General + +The Diameter load control mechanism is an optional feature over the S6t interface. + +It is recommended to make use of IETF RFC 8583 [22] on the S6t interface where, when applied, the SCEF shall behave as reacting nodes and the HSS as a reporting node. + +#### D.3.2 HSS behaviour + +The HSS may report its current load by including a Load AVP of type HOST in answer commands as described in IETF RFC 8583 [22]. + +The HSS calculates its current load by implementation specific means. For example, the HSS may take into account the traffic over the S6t interface or other interfaces, the level of usage of internal resources (e.g. CPU, memory), the access to external resources, etc. + +The HSS determines when to send Load AVPs of type HOST by implementation specific means. + +### D.3.3 SCEF behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the SCEF may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [22]. + +## Annex E (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|---------------------------------------------------------------------------------------|--------| +| 2012-09 | CT#57 | CP-120485 | | | | V.1.0.0 presented for information and approval | 11.0.0 | +| 2012-12 | CT#58 | CP-120731 | 0001 | 3 | | T4 device triggering via IMS | 11.1.0 | +| 2012-12 | CT#58 | CP-120731 | 0002 | 1 | | MWD and SMS-SC address | | +| 2012-12 | CT#58 | CP-120731 | 0003 | - | | Application ID and Command Codes | | +| 2013-06 | CT#60 | CP-130300 | 0004 | 2 | | S6m complements related to Diameter for SMS with SGSN | 12.0.0 | +| 2013-09 | CT#61 | CP-130456 | 0005 | 2 | | SGSN Diameter address with Gdd support | 12.1.0 | +| 2014-06 | CT#64 | CP-140243 | 0007 | 3 | | Diameter overload over S6m | 12.2.0 | +| 2014-12 | CT#66 | CP-140775 | 0008 | 1 | | Absent Subscriber detection | 12.3.0 | +| 2015-06 | CT#68 | CP-150248 | 0012 | 1 | | IP-SM-GW-Realm | 12.4.0 | +| 2015-06 | CT#68 | CP-150265 | 0009 | 1 | | Unsuccessful Triggering due to MT-SMS barring | 13.0.0 | +| 2015-06 | CT#68 | CP-150271 | 0013 | 3 | | Introducing S6t reference point | 13.0.0 | +| 2015-09 | CT#69 | CP-150456 | 0019 | 3 | | New Monitoring configuration commands on S6t | 13.1.0 | +| 2015-09 | CT#69 | CP-150456 | 0020 | 2 | | Update S6t description to support AESE Communication Pattern provision | 13.1.0 | +| 2015-09 | CT#69 | CP-150456 | 0022 | 3 | | Introducing CP parameter to commands on S6t | 13.1.0 | +| 2015-12 | CT#70 | CP-150778 | 0023 | - | | S6t Application ID and Command Codes | 13.2.0 | +| 2015-12 | CT#70 | CP-150778 | 0024 | 3 | | Enhancements to S6t on MONTE | 13.2.0 | +| 2015-12 | CT#70 | CP-150778 | 0026 | 1 | | Diameter Overload on S6t | 13.2.0 | +| 2015-12 | CT#70 | CP-150778 | 0028 | 1 | | Corrections to some MONTE AVPs, references and procedures | 13.2.0 | +| 2015-12 | CT#70 | CP-150778 | 0030 | 3 | | Multiple instances in a configuration request command | 13.2.0 | +| 2015-12 | CT#70 | CP-150778 | 0031 | 2 | | Enhancements and clarification on MONTE | 13.2.0 | +| 2015-12 | CT#70 | CP-150778 | 0033 | 3 | | Deletion of all Monitoring events assigned to a subscriber (UE) | 13.2.0 | +| 2015-12 | CT#70 | CP-150785 | 0025 | 3 | | Introducing a Bitmask to inform the SCEF of the Monitoring capabilities of the HSS | 13.2.0 | +| 2015-12 | CT#70 | CP-150771 | 0027 | 3 | | Introducing CP parameter to CIR/CIA commands on S6t | 13.2.0 | +| 2015-12 | CT#70 | CP-150759 | 0032 | 1 | | Reference to DOIC updated with IETF RFC 7683 | 13.2.0 | +| 2016-03 | CT#71 | CP-160029 | 0037 | 2 | | Clarification on LOSS_OF_CONNECTIVITY reporting | 13.3.0 | +| 2016-03 | CT#71 | CP-160029 | 0039 | 2 | | SCEF Restart | 13.3.0 | +| 2016-03 | CT#71 | CP-160029 | 0040 | 2 | | Reporting of the start and stop of the reporting of monitoring events | 13.3.0 | +| 2016-03 | CT#71 | CP-160029 | 0044 | 1 | | Count and Stop Monitoring Event Reports at SCEF | 13.3.0 | +| 2016-03 | CT#71 | CP-160029 | 0045 | 1 | | Change of type of Monitoring-Duration AVP to represent an absolute time | 13.3.0 | +| 2016-03 | CT#71 | CP-160033 | 0046 | 4 | | Authorization for NIDD procedure over S6t | 13.3.0 | +| 2016-03 | CT#71 | CP-160023 | 0047 | 1 | | Diameter message priority over S6m, S6n, S6t | 13.3.0 | +| 2016-03 | CT#71 | CP-160129 | 0048 | 4 | | Definition of Monitoring-Type and clarifications on UE in MME and SGSN for MONTE | 13.3.0 | +| 2016-06 | CT#72 | CP-160225 | 0049 | 1 | | Cleanup on MONTE | 13.4.0 | +| 2016-06 | CT#72 | CP-160225 | 0056 | - | | Address editor's note on retry-after when sending cancel monitoring event to the SCEF | 13.4.0 | +| 2016-06 | CT#72 | CP-160228 | 0050 | 7 | | NIDD authorisation update | 13.4.0 | +| 2016-06 | CT#72 | CP-160228 | 0051 | - | | IANA Command Code Registration | 13.4.0 | +| 2016-06 | CT#72 | CP-160228 | 0052 | - | | Type of SCEF-ID AVP | 13.4.0 | +| 2016-06 | CT#72 | CP-160233 | 0053 | - | | Renaming of Validity-Time AVP | 13.4.0 | +| 2016-06 | CT#72 | CP-160233 | 0057 | 1 | | Missing reference to SIR-flags | 13.4.0 | +| 2016-09 | CT#73 | CP-160416 | 0043 | 2 | | SCS identity format | 13.5.0 | +| 2016-12 | CT#74 | CP-160650 | 0059 | 1 | | AVP code alignment with 29.230 | 13.6.0 | +| 2016-12 | CT#74 | CP-160657 | 0060 | 1 | | User Identity correction on NIDD configuration procedure | 13.6.0 | +| 2016-12 | CT#74 | CP-160657 | 0061 | 1 | | IMSI in NIR | 13.6.0 | +| 2016-12 | CT#74 | CP-160657 | 0063 | 2 | | External-Identifier Retrieval when no NIDD configuration exists | 13.6.0 | +| 2016-12 | CT#74 | CP-160664 | 0065 | - | | Correction to change IETF drmp draft version to official RFC 7944 | 13.6.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|---------------------------------------------------------------------------|--------| +| 2016-12 | CT#74 | CP-160660 | 0066 | 2 | | HSS-Cause in CIA | 13.6.0 | +| 2016-12 | CT#74 | CP-160660 | 0067 | 1 | | Maximum Detection Time | 13.6.0 | +| 2016-12 | CT#74 | CP-160673 | 0062 | 1 | | MO SMS over T4 | 14.0.0 | +| 2016-12 | CT#74 | CP-160681 | 0064 | 1 | | Load Control | 14.0.0 | +| 2017-03 | CT#75 | CP-170031 | 0081 | 1 | | S6t Update to Provide the Suggested Buffering Packet Count to the HSS | 14.1.0 | +| 2017-03 | CT#75 | CP-170039 | 0068 | 2 | | Enhanced Coverage | 14.1.0 | +| 2017-03 | CT#75 | CP-170039 | 0070 | 2 | | NIDD Authorization revocation | 14.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0069 | 2 | | Loss Of Connectivity Reason | 14.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0072 | 1 | | Monitoring Status Update | 14.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0073 | 1 | | Recourses Exceeded | 14.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0076 | - | | Failed-AVP AVP in Request Commands | 14.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0077 | 1 | | Bit ordering in Diameter AVPs used as bit-masks | 14.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0078 | - | | Support of long and short Macro eNodeB IDs | 14.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0079 | - | | Service-ID in SIR | 14.1.0 | +| 2017-03 | CT#75 | CP-170029 | 0083 | 1 | | Maximum UE Availability Time | 14.1.0 | +| 2017-03 | CT#75 | CP-170048 | 0084 | - | | Update of reference for the Diameter base protocol | 14.1.0 | +| 2017-03 | CT#75 | CP-170048 | 0085 | - | | Handling of the Vendor-Specific-Application-Id AVP | 14.1.0 | +| 2017-03 | CT#75 | CP-170048 | 0086 | - | | Cardinality of the Failed-AVP AVP in answer | 14.1.0 | +| 2017-06 | CT#76 | CP-171029 | 0087 | 3 | | Support for group based reporting and status indication for MONTE | 14.2.0 | +| 2017-06 | CT#76 | CP-171030 | 0088 | - | | NIDD Authorization revocation | 14.2.0 | +| 2017-06 | CT#76 | CP-171030 | 0089 | 1 | | NIDD Authorization update per APN | 14.2.0 | +| 2017-06 | CT#76 | CP-171038 | 0090 | 1 | | MO-SMS | 14.2.0 | +| 2017-06 | CT#76 | CP-171184 | 0092 | 1 | | Communication Patterns without Expiry Time | 14.2.0 | +| 2017-06 | CT#76 | CP-171021 | 0094 | 1 | | Remove User-Identifier from NIA | 14.2.0 | +| 2017-06 | CT#76 | CP-171029 | 0095 | 1 | | Unauthorized Requesting Entity on S6t | 14.2.0 | +| 2017-06 | CT#76 | CP-171018 | 0097 | 1 | | Support for signaling transport level packet marking | 14.2.0 | +| 2017-09 | CT#77 | CP-172013 | 0104 | - | | Correction of DRMP Procedures | 14.3.0 | +| 2017-09 | CT#77 | CP-172026 | 0101 | 2 | | Enhancements for NAPS on Idle Status Indication | 15.0.0 | +| 2017-09 | CT#77 | CP-172026 | 0105 | 1 | | Enhancements for NAPS on Accuracy | 15.0.0 | +| 2017-12 | CT#78 | CP-173029 | 0100 | 2 | | Reachability Type | 15.1.0 | +| 2017-12 | CT#78 | CP-173033 | 0106 | 2 | | Enable minimum time interval for Continuous Location Reporting | 15.1.0 | +| 2017-12 | CT#78 | CP-173033 | 0107 | 2 | | Suggested Network Configuration Request | 15.1.0 | +| 2017-12 | CT#78 | CP-173028 | 0108 | 3 | | Monitoring Event Report Status | 15.1.0 | +| 2017-12 | CT#78 | CP-173028 | 0113 | 1 | | Corrections to S6t procedures | 15.1.0 | +| 2018-03 | CT#79 | CP-180025 | 0116 | 3 | | Reporting of Suggested Network Configuration changes by HSS | 15.2.0 | +| 2018-03 | CT#79 | CP-180025 | 0117 | 2 | | IMSI-Group-Id retrieval | 15.2.0 | +| 2018-06 | CT#80 | CP-181116 | 0126 | 1 | | Presence of Monitoring-type AVP in Monitoring event configuration | 15.3.0 | +| 2018-06 | CT#80 | CP-181117 | 0121 | 1 | | Monitoring Event configuration removal for a group | 15.3.0 | +| 2018-06 | CT#80 | CP-181126 | 0124 | 1 | | Conditional User-Identity clarification in Reporting Information Request | 15.3.0 | +| 2018-06 | CT#80 | CP-181126 | 0125 | - | | Optimization of the MONTE reporting procedure in S6t | 15.3.0 | +| 2018-06 | CT#80 | CP-181127 | 0123 | - | | Group Message Delivery via Unicast MT NIDD | 15.3.0 | +| 2018-06 | CT#80 | CP-181130 | 0118 | 2 | | Overwriting of configuration data triggers deletion of a monitoring event | 15.3.0 | +| 2018-06 | CT#80 | CP-181130 | 0119 | 2 | | Suggested-Network-Configuration parameter content | 15.3.0 | +| 2018-06 | CT#80 | CP-181130 | 0122 | 2 | | Deletion of Network Parameter Configuration | 15.3.0 | +| 2018-09 | CT#81 | CP-182075 | 0127 | 1 | | Multiple instances in a configuration request command clarifications | 15.4.0 | +| 2018-09 | CT#81 | CP-182075 | 0128 | 1 | | One time report handling | 15.4.0 | +| 2018-09 | CT#81 | CP-182075 | 0129 | 1 | | Configuration of MONTE when user is purged | 15.4.0 | +| 2018-09 | CT#81 | CP-182075 | 0130 | - | | No default value for Supported-Monitoring-Events AVP | 15.4.0 | +| 2018-09 | CT#81 | CP-182075 | 0131 | 1 | | Supported Services AVP handling | 15.4.0 | +| 2018-09 | CT#81 | CP-182081 | 0133 | 1 | | Completion of Monitoring Event configuration removal for a group | 15.4.0 | +| 2018-12 | CT#82 | CP-183097 | 0140 | 1 | | Reporting corrections for IMEI change and idle status indication | 15.5.0 | +| 2018-12 | CT#82 | CP-182095 | 0135 | 3 | | Monitoring event report | 15.5.0 | +| 2018-12 | CT#82 | CP-182095 | 0142 | 3 | | Fixing Group NIDD | 15.5.0 | +| 2018-12 | CT#82 | CP-182098 | 0134 | 1 | | Location reporting details for MONTE | 15.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------|--------| +| 2018-12 | CT#82 | CP-182098 | 0136 | 1 | | Default Values in Reachability Type and Location Type | 15.5.0 | +| 2018-12 | CT#82 | CP-182098 | 0137 | - | | Deletion of monitoring events when unknown in SCEF | 15.5.0 | +| 2018-12 | CT#82 | CP-182098 | 0138 | - | | Event configuration failure in S6a/ULA | 15.5.0 | +| 2018-12 | CT#82 | CP-182098 | 0139 | 1 | | External Identifier AVP definition is not correct | 15.5.0 | +| 2018-12 | CT#82 | CP-182098 | 0141 | - | | Applicability of Maximum Number of Reports | 15.5.0 | +| 2018-12 | CT#82 | CP-182098 | 0144 | 1 | | IMEI Change Event Type | 15.5.0 | +| 2019-03 | CT#83 | CP-190061 | 0146 | 1 | | Absence of MSISDN in S6n | 15.6.0 | +| 2019-03 | CT#83 | CP-190038 | 0147 | 1 | | MONTE Corrections | 15.6.0 | +| 2019-03 | CT#83 | CP-190037 | 0148 | 1 | | Handling of multiple external IDs for the same UE | 15.6.0 | +| 2019-03 | CT#83 | CP-190038 | 0149 | 1 | | SCEF-ID clarification | 15.6.0 | +| 2019-03 | CT#83 | CP-190038 | 0150 | 1 | | Communication Pattern Deletion | 15.6.0 | +| 2019-09 | CT#85 | CP-192094 | 0155 | 2 | | draft-ietf-dime-load published as RFC 8583 | 15.7.0 | +| 2019-09 | CT#85 | CP-192121 | 0153 | 2 | | Communication pattern enhancement | 16.0.0 | +| 2019-09 | CT#85 | CP-192121 | 0152 | 1 | | Event type PDN Connectivity Status | 16.0.0 | +| 2019-12 | CT#86 | CP-193038 | 0156 | - | | Suggested Network Configuration overwrite | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0158 | - | | Enhancement of Monitoring Event configuration and Network Parameter Configuration | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0159 | - | | MTC Provider Info authorization | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0160 | 1 | | Network Parameter Configuration Reporting | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0161 | - | | PDN connectivity status event correction | 16.1.0 | +| 2019-12 | CT#86 | CP-193052 | 0157 | 2 | | Battery Indication for Communication pattern enhancement | 16.1.0 | +| 2020-06 | CT#88e | CP-201028 | 0165 | 2 | | Update of Suggested Network Configuration | 16.2.0 | +| 2020-06 | CT#88e | CP-201028 | 0170 | - | | Wrong name of Network Configuration parameters | 16.2.0 | +| 2020-06 | CT#88e | CP-201028 | 0172 | - | | Removal of Editor's Note in References | 16.2.0 | +| 2020-06 | CT#88e | CP-201027 | 0168 | - | | Suggested-Network-Configuration | 16.2.0 | +| 2020-06 | CT#88e | CP-201053 | 0162 | - | | CIR-Flags | 16.2.0 | +| 2020-06 | CT#88e | CP-201053 | 0163 | - | | User-Name in NIDD-Authorization-Update | 16.2.0 | +| 2020-06 | CT#88e | CP-201053 | 0166 | - | | Event-Handling in Group-Report-Item | 16.2.0 | +| 2020-12 | CT#90e | CP-203024 | 0173 | - | | Extended Reference ID | 16.3.0 | +| 2021-03 | CT#91e | CP-210031 | 0174 | - | | Missing AVPs in Group-Report-Item | 17.0.0 | +| 2021-09 | CT#93e | CP-212037 | 0176 | 1 | B | Dynamic management of group based event monitoring | 17.1.0 | +| 2021-12 | CT#94e | CP-213110 | 0178 | - | F | Resolve EN for Partial Cancellation | 17.2.0 | +| 2021-12 | CT#94e | CP-213110 | 0179 | - | B | Addition of UEs for group based event subscription | 17.2.0 | +| 2022-03 | CT#95e | CP-220063 | 0180 | - | F | Event Cancellation Report feature | 17.3.0 | +| 2022-09 | CT#97e | CP-222022 | 0181 | - | F | User Identity in NIDD Information Request | 18.0.0 | +| 2023-06 | CT#100 | CP-231063 | 0182 | - | F | Reachability Cause in immediate reports | 18.1.0 | +| 2023-09 | CT#100 | CP-232079 | 0186 | 3 | A | Misalignment between Stage 2 and Stage 3 when Roaming Status request is received by HSS | 18.2.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29338/raw.md b/raw/rel-18/29_series/29338/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..48962c987461828e4219c07cbcb3b9be55a85702 --- /dev/null +++ b/raw/rel-18/29_series/29338/raw.md @@ -0,0 +1,2103 @@ + + +# 3GPP TS 29.338 V18.2.0 (2023-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Diameter based protocols to support Short Message Service (SMS) capable Mobile Management Entities (MMEs) (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 General ..... | 9 | +| 4.1 Introduction ..... | 9 | +| 4.2 Use of Diameter Base protocol ..... | 9 | +| 4.3 Securing Diameter messages..... | 9 | +| 4.4 Accounting functionality..... | 9 | +| 4.5 Use of sessions ..... | 9 | +| 4.6 Transport protocol..... | 9 | +| 4.7 Advertising application support ..... | 9 | +| 4.8 Diameter Application Identifier ..... | 10 | +| 4.9 Use of the Supported-Features AVP ..... | 10 | +| 5 Diameter based S6c interface between HSS and central SMS functions ..... | 10 | +| 5.1 Introduction ..... | 10 | +| 5.2 Procedures description ..... | 11 | +| 5.2.1 Send Routing Info for SM procedure ..... | 11 | +| 5.2.1.1 General..... | 11 | +| 5.2.1.2 Detailed behaviour of the SMS-GMSC ..... | 16 | +| 5.2.1.3 Detailed behaviour of the HSS ..... | 16 | +| 5.2.1.4 Detailed behaviour of the SMS Router..... | 17 | +| 5.2.2 Alert Service Centre procedure ..... | 17 | +| 5.2.2.1 General..... | 17 | +| 5.2.2.2 Detailed behaviour of the HSS ..... | 18 | +| 5.2.2.3 Detailed behaviour of the SMS-IWMSC..... | 19 | +| 5.2.3 Report SM Delivery Status procedure..... | 19 | +| 5.2.3.1 General..... | 19 | +| 5.2.3.2 Detailed behaviour of the SMS-GMSC ..... | 21 | +| 5.2.3.3 Detailed behaviour of IP-SM-GW ..... | 21 | +| 5.2.3.4 Detailed behaviour of the HSS ..... | 21 | +| 5.3 Protocol specification..... | 21 | +| 5.3.1 Routing considerations ..... | 21 | +| 5.3.1.1 Requests from the SMS-GMSC or the SMS router ..... | 21 | +| 5.3.1.1.1 Introduction ..... | 21 | +| 5.3.1.1.2 Routing from the originating PLMN..... | 22 | +| 5.3.1.1.3 Routing in the HPLMN ..... | 22 | +| 5.3.1.2 Requests from the HSS ..... | 23 | +| 5.3.2 Commands ..... | 23 | +| 5.3.2.1 Introduction..... | 23 | +| 5.3.2.2 Command-Code values..... | 23 | +| 5.3.2.3 Send-Routing-Info-for-SM-Request (SRR) Command ..... | 24 | +| 5.3.2.4 Send-Routing-info-for-SM-Answer (SRA) Command ..... | 24 | +| 5.3.2.5 Alert-Service-Centre-Request (ALR) Command ..... | 25 | +| 5.3.2.6 Alert-Service-Centre-Answer (ALA) Command..... | 25 | +| 5.3.2.7 Report-SM-Delivery-Status-Request (RDR) Command ..... | 25 | +| 5.3.2.8 Report-SM-Delivery-Status-Answer (RDA) Command ..... | 26 | +| 5.3.3 AVPs..... | 26 | +| 5.3.3.1 General..... | 26 | +| 5.3.3.2 SM-RP-MTI..... | 28 | +| 5.3.3.3 SM-RP-SMEA ..... | 28 | +| 5.3.3.4 SRR-Flags..... | 29 | + +| | | | +|----------|------------------------------------------------------------------------------------|----| +| 5.3.3.5 | SM-Delivery-Not-Intended..... | 29 | +| 5.3.3.6 | Serving-Node ..... | 29 | +| 5.3.3.7 | Additional-Serving-Node..... | 30 | +| 5.3.3.8 | MWD-Status ..... | 30 | +| 5.3.3.9 | MME-Absent-User-Diagnostic-SM..... | 31 | +| 5.3.3.10 | MSC-Absent-User-Diagnostic-SM..... | 31 | +| 5.3.3.11 | SGSN-Absent-Subscriber-Diagnostic-SM ..... | 31 | +| 5.3.3.12 | Feature-List-ID AVP ..... | 31 | +| 5.3.3.13 | Feature-List AVP..... | 31 | +| 5.3.3.14 | SM-Delivery-Outcome ..... | 32 | +| 5.3.3.15 | MME-SM-Delivery-Outcome ..... | 32 | +| 5.3.3.16 | MSC-SM-Delivery-Outcome..... | 32 | +| 5.3.3.17 | SGSN-SM-Delivery-Outcome..... | 32 | +| 5.3.3.18 | IP-SM-GW-SM-Delivery-Outcome ..... | 32 | +| 5.3.3.19 | SM-Delivery-Cause ..... | 33 | +| 5.3.3.20 | Absent-User-Diagnostic-SM ..... | 33 | +| 5.3.3.21 | RDR-Flags ..... | 33 | +| 5.3.3.22 | Maximum-UE-Availability-Time ..... | 33 | +| 5.3.3.23 | SMS-GMSC-Alert-Event..... | 33 | +| 5.3.3.24 | DRMP ..... | 34 | +| 5.3.3.25 | SMSF-3GPP-Absent-User-Diagnostic-SM ..... | 34 | +| 5.3.3.26 | SMSF-Non-3GPP-Absent-User-Diagnostic-SM ..... | 34 | +| 5.3.3.27 | SMSF-3GPP-SM-Delivery-Outcome ..... | 34 | +| 5.3.3.28 | SMSF-Non-3GPP-SM-Delivery-Outcome ..... | 34 | +| 5.3.3.29 | SMSF-3GPP-Number ..... | 34 | +| 5.3.3.30 | SMSF-Non-3GPP-Number ..... | 34 | +| 5.3.3.31 | SMSF-3GPP-Name..... | 35 | +| 5.3.3.32 | SMSF-Non-3GPP-Name ..... | 35 | +| 5.3.3.33 | SMSF-3GPP-Realm..... | 35 | +| 5.3.3.34 | SMSF-Non-3GPP-Realm..... | 35 | +| 5.3.3.35 | SMSF-3GPP-Address ..... | 35 | +| 5.3.3.36 | SMSF-Non-3GPP-Address ..... | 35 | +| 5.3.3.37 | SMSF-3GPP-SBI-Support-Indicator ..... | 35 | +| 5.3.3.38 | SMSF-Non-3GPP-SBI-Support-Indicator ..... | 36 | +| 5.3.3.39 | IP-SM-GW-SBI-Support-Indicator ..... | 36 | +| 5.4 | User identity to HSS resolution..... | 36 | +| 6 | Diameter based SGd/Gdd interfaces between MME/SGSN and central SMS functions ..... | 37 | +| 6.1 | Introduction ..... | 37 | +| 6.2 | Procedures description ..... | 37 | +| 6.2.1 | MO Forward Short Message procedure ..... | 37 | +| 6.2.1.1 | General..... | 37 | +| 6.2.1.2 | Detailed behaviour of the MME, the SGSN and the IP-SM-GW ..... | 39 | +| 6.2.1.3 | Detailed behaviour of the SMS-IWMSC..... | 39 | +| 6.2.2 | MT Forward Short Message procedure..... | 40 | +| 6.2.2.1 | General..... | 40 | +| 6.2.2.2 | Detailed behaviour of the MME and the SGSN ..... | 41 | +| 6.2.2.3 | Detailed behaviour of the SMS-GMSC ..... | 42 | +| 6.2.3 | Alert Service Centre procedure ..... | 43 | +| 6.2.3.1 | General..... | 43 | +| 6.2.3.2 | Detailed behaviour of the MME and the SGSN ..... | 44 | +| 6.2.3.3 | Detailed behaviour of the SMS-GMSC ..... | 45 | +| 6.2.3.4 | Detailed behaviour of the SMS-Router ..... | 45 | +| 6.3 | Protocol specification..... | 45 | +| 6.3.1 | Routing considerations ..... | 45 | +| 6.3.1.1 | Routing for MO Forward SM messages: ..... | 45 | +| 6.3.1.2 | Routing for MT Forward SM messages: ..... | 46 | +| 6.3.2 | Commands ..... | 46 | +| 6.3.2.1 | Introduction..... | 46 | +| 6.3.2.2 | Command-Code values..... | 46 | +| 6.3.2.3 | MO-Forward-Short-Message-Request (OFR) Command ..... | 47 | +| 6.3.2.4 | MO-Forward-Short-Message-Answer (OFA) Command..... | 47 | + +| | | | +|-------------------------------|------------------------------------------------------|-----------| +| 6.3.2.5 | MT-Forward-Short-Message-Request (TFR) Command ..... | 48 | +| 6.3.2.6 | MT-Forward-Short-Message-Answer (TFA) Command..... | 48 | +| 6.3.3 | AVPs..... | 49 | +| 6.3.3.1 | General..... | 49 | +| 6.3.3.2 | SC-Address ..... | 50 | +| 6.3.3.3 | SM-RP-UI..... | 50 | +| 6.3.3.4 | TFR-Flags ..... | 50 | +| 6.3.3.5 | SM-Delivery-Failure-Cause..... | 51 | +| 6.3.3.6 | SM-Enumerated-Delivery-Failure-Cause ..... | 51 | +| 6.3.3.7 | SM-Diagnostic-Info ..... | 51 | +| 6.3.3.8 | Feature-List-ID AVP ..... | 51 | +| 6.3.3.9 | Feature-List AVP..... | 51 | +| 6.3.3.10 | SM-Delivery-Timer ..... | 51 | +| 6.3.3.11 | SM-Delivery-Start-Time..... | 51 | +| 6.3.3.12 | OFR-Flags..... | 52 | +| 6.3.3.13 | SMSMI-Correlation-ID ..... | 52 | +| 6.3.3.14 | HSS-ID..... | 52 | +| 6.3.3.15 | Originating-SIP-URI..... | 52 | +| 6.3.3.16 | Destination-SIP-URI..... | 52 | +| 6.3.3.17 | Maximum-Retransmission-Time..... | 52 | +| 6.3.3.18 | Requested-Retransmission-Time..... | 52 | +| 6.3.3.19 | SMS-GMSC-Address ..... | 53 | +| 6.3.3.20 | DRMP ..... | 53 | +| 7 | Result Codes and Experimental-Result values ..... | 53 | +| 7.1 | General ..... | 53 | +| 7.2 | Success ..... | 53 | +| 7.3 | Permanent Failures ..... | 53 | +| 7.3.1 | General ..... | 53 | +| 7.3.2 | DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 53 | +| 7.3.3 | DIAMETER_ERROR_ABSENT_USER (5550)..... | 53 | +| 7.3.4 | DIAMETER_ERROR_USER_BUSY_FOR_MT_SMS (5551)..... | 54 | +| 7.3.5 | DIAMETER_ERROR_FACILITY_NOT_SUPPORTED (5552)..... | 54 | +| 7.3.6 | DIAMETER_ERROR_ILLEGAL_USER (5553) ..... | 54 | +| 7.3.7 | DIAMETER_ERROR_ILLEGAL_EQUIPMENT (5554) ..... | 54 | +| 7.3.8 | DIAMETER_ERROR_SM_DELIVERY_FAILURE (5555)..... | 54 | +| 7.3.9 | DIAMETER_ERROR_SERVICE_NOT_SUBSCRIBED (5556)..... | 54 | +| 7.3.10 | DIAMETER_ERROR_SERVICE_BARRED (5557)..... | 54 | +| 7.3.11 | DIAMETER_ERROR_MWD_LIST_FULL (5558)..... | 54 | +| 7.4 | Transient Failures..... | 54 | +| 7.4.1 | General ..... | 54 | +| Annex A (normative): | Diameter message priority mechanism..... | 55 | +| A.1 | General..... | 55 | +| A.2 | S6c, SGd, Gdd interfaces ..... | 55 | +| Annex B (informative): | Change history ..... | 55 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document defines the Diameter-based interfaces specific to SMS when they are used in conjunction with the "SMS in MME" architecture specified in 3GPP TS 23.272 [2] or for SGSN supporting EPS interfaces, or the "SMS in 5GS" architecture specified in 3GPP TS 23.501 [21]. It comprises: + +- the Diameter application for the S6c interface between the HSS/UDM and the central SMS functions (SMS-GMSC, SMS Router) ; +- the Diameter application + - for the SGd interface between the MME/SMSF, the SMS-IWMSC, the SMS-GMSC and the SMS Router. + - for the Gdd interface between the SGSN, the SMS-IWMSC, the SMS-GMSC and the SMS Router. + +For the purpose of supporting SMS in 5GS, the UDM may implement the requirements specified in the present specification for HSS, with the following modification: + +- "HSS" is to be replaced with "UDM". + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.272: "Circuit Switched (CS) fallback in Evolved Packet System (EPS); Stage 2". +- [3] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)". +- [4] 3GPP TS 29.272: "Evolved Packet System (EPS); Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [5] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol; Protocol details". +- [6] IETF RFC 2234: "Augmented BNF for Syntax Specifications: ABNF". +- [7] Void. +- [8] IETF RFC 5516: "Diameter Command Code Registration for the Third Generation Partnership Project (3GPP) Evolved Packet System (EPS)". + +- [9] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [10] 3GPP TS 29.173: "Location Services (LCS); Diameter-based SLh interface for Control Plane LCS". +- [11] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security ". +- [12] IETF RFC 4960: "Stream Control Transport Protocol". +- [13] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [14] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol; Protocol details". +- [15] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [16] 3GPP TS 23.003: "Numbering, addressing and identification". +- [17] 3GPP TS 23.204: "Support of Short Message Service (SMS) over generic 3GPP Internet Protocol (IP) access; Stage 2". +- [18] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [19] IETF RFC 7944: "Diameter Routing Message Priority". +- [20] IETF RFC 6733: "Diameter Base Protocol". +- [21] 3GPP TS 23.501:"System Architecture for the 5G System". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|-----------|-------------------------------------| +| ABNF | Augmented Backus-Naur Form | +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| IANA | Internet Assigned Numbers Authority | +| IP-SM-GW | IP Short Message Gateway | +| MWD | Message Waiting Data | +| RP | Relay layer Protocol | +| RP-MTI | RP Message Type Indicator | +| RP-SMEA | RP SME-Address | +| RP-UI | RP User Information | +| SM RL | Short Message Relay Layer | +| SMS-GMSC | Gateway MSC for SMS | +| SMS-IWMSC | Interworking MSC for SMS | +| SMSMI | SMS without MSISDN in IMS | + +# 4 General + +## 4.1 Introduction + +The SMS in MME architecture is described in 3GPP TS 23.272 [2] and the SMS in 5GS architecture is described in 3GPP TS 23.501 [21], have specified the reference points S6c and SGd. + +The clause 4 addresses Diameter aspects which are common to S6c, SGd and Gdd. + +## 4.2 Use of Diameter Base protocol + +The Diameter base protocol as specified in IETF RFC 6733 [20] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +## 4.3 Securing Diameter messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [11]. + +## 4.4 Accounting functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the S6c, SGd and Gdd interfaces. + +## 4.5 Use of sessions + +Diameter sessions shall be implicitly terminated over the S6c, SGd and Gdd interfaces. An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol specified in IETF RFC 6733 [20] includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [20]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +## 4.6 Transport protocol + +Diameter messages over the S6c, SGd and Gdd interfaces shall make use of SCTP as specified in IETF RFC 4960 [12] as transport protocol. + +## 4.7 Advertising application support + +The MME, HSS, SMS-IWMSC, SMS-GMSC and SMS Router shall advertise support of the Diameter S6c Application over the S6c interface and of the Diameter SGd Application over the SGd interface by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. The MME, SMS-GMSC and SMS Router shall additionally advertise support of the Diameter S6c Application over the SGd interface if they support the Alert Service Centre procedure between the MME, SMS-GMSC and SMS Router. + +The SGSN, SMS-IWMSC, SMS-GMSC and SMS Router shall advertise support of the Diameter SGd Application over the Gdd interface by including the value of the application identifier in the Auth-Application-Id AVP within the + +Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. The SGSN, SMS-GMSC and SMS Router shall additionally advertise support of the Diameter S6c Application over the Gdd interface if they support the Alert Service Centre procedure between the SGSN, SMS-GMSC and SMS Router. + +The MTC-IWF and SMS-IWMSC shall advertise support of the Diameter SGd Application over the T4 interface if they support the MO-Forward-Short-Message procedure between the SMS-IWMSC and the MTC-IWF. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [20]. + +## 4.8 Diameter Application Identifier + +The S6c and the SGd/Gdd interface protocols shall be defined, each, as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the S6c Diameter application is 16777312 (allocated by IANA). + +The Diameter application identifier assigned to the SGd Diameter application, which is also applicable to the Gdd and T4 interfaces is 16777313 (allocated by IANA). + +## 4.9 Use of the Supported-Features AVP + +When new functionality is introduced on the S6c or SGd Diameter applications, it should be defined as optional. If backwards incompatible changes can not be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. The usage of the Supported-Features AVP on the S6c or SGd applications is consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [5]. + +When extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [5], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Table 5.3.3.13/1 defines the features applicable to the S6c interface for the feature list with a Feature-List-ID of 1. + +# --- 5 Diameter based S6c interface between HSS and central SMS functions + +## 5.1 Introduction + +The S6c interface enables the retrieval of routing information for the transfer of short messages, the report of status of the delivery status of a short message and the alerting of the SMS-SC between the HSS, the SMS-GMSC and the SMS Router as described in 3GPP TS 23.040 [3]. + +## 5.2 Procedures description + +### 5.2.1 Send Routing Info for SM procedure + +#### 5.2.1.1 General + +This procedure shall be used between the SMS-GMSC or the IP-SM-GW and the HSS to retrieve the routing information needed for routing the short message to the serving MSC or MME or SGSN or SMSF. This procedure is also used between the SMS-GMSC and the SMS Router or the IP-SM-GW, and between the HSS and the SMS Router or the IP-SM-GW in order to enforce routing of the SM delivery via the HPLMN of the receiving MS. + +This procedure is applicable to an IP-SM-GW for its SMS Router function when using the S6c interface. + +This procedure is used according to the call flows described in 3GPP TS 23.040 [2] clause 10. + +Table 5.2.1.1-1 specifies the involved information elements for the request. + +Table 5.2.1.1-2 specifies the involved information elements for the answer. + +This procedure is mapped to the commands Send-Routing-Info-for-SM-Request/Answer (SRR/SRA) in the Diameter application specified in clause 5.3.2. + +Table 5.2.1.1-1: Send Routing Info for SM Request + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|------------------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MSISDN | MSISDN | C | This information element shall be present when the MSISDN exists and shall contain the MSISDN of the user. | +| IMSI | User-Name
(See IETF RFC 6733 [20]) | C | This information element shall be present when the MSISDN does not exist and shall contain
- the IMSI of the user in the context of T4 device triggering (see 3GPP TS 23.682 [18]);
- or the HSS ID value in the context of MSISDN-less SMS delivery in IMS (see 3GPP TS 23.204 [17]),. | +| SMSMI Correlation ID | SMSMI-Correlation-ID | C | This information element indicates by its presence that the request is sent in the context of MSISDN-less SMS delivery in IMS (see 3GPP TS 23.204 [17]).
This information element shall contain the SIP-URI of the (MSISDN-less) destination user. The SIP-URI of the originating user and the HSS-ID shall be absent from this information element. | +| Service Centre Address | SC-Address | M | This information element shall contain the Service Centre address. | +| SM-RP-MTI | SM-RP-MTI | C | This information element shall contain the RP-Message Type Indicator of the Short Message. It is used to distinguish a SM sent to the mobile station in order to acknowledge an MO-SM initiated by the mobile from a normal MT-SM. | +| SM-RP-SMEA | SM-RP-SMEA | C | This information element shall contain the RP-Originating SME-address of the Short Message Entity that has originated the SM. This information element shall be present if the SMS-GMSC supports receiving of the two numbers from the HSS. Used by the short message service relay sub-layer protocol it shall be formatted according to the formatting rules of address fields as described in 3GPP TS 23 040 [2]. | +| SRR Flags | SRR-Flags | C | This Information Element contains a bit mask. See 5.3.3.4 for the meaning of the bits and the condition for each bit to be set or not. | +| SM-Delivery Not Intended | SM-Delivery-Not-Intended | O | This information element, when present, shall indicate that delivery of a short message is not intended. It further indicates whether only IMSI or only MCC+MNC are requested.
This information element may be set by entities that request the service without intending to deliver a short message, and shall be evaluated by the SMS Router and may be evaluated by the HSS. | +| Supported Features | Supported-Features
(See 3GPP TS 29.229 [5]) | O | If present, this Information Element shall contain the list of features supported by the origin host. | + +**Table 5.2.1.1-2: Send Routing Info for SM Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M |

Result of the request.

Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [20]).

Experimental-Result AVP shall be used for S6c errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. This information element shall contain the result of the operation with an indication of the success / errors.

The following errors are applicable in this case:

  • - Unknown User;
  • - Service Barred;
  • - Teleservice Not Provisioned;
  • - Absent User;
  • - Facility Not Supported.
| +| IMSI | User-Name (See IETF RFC 6733 [20]) | C |

This information element:

  • - either shall contain the IMSI of the user.
  • - or, if enforcement of routing an SM via the HPLMN of the receiving MS or UE is deployed, shall contain an MT Correlation ID instead of an IMSI when the service is used between SMS-GMSC and SMS Router (see 3GPP TS 23.040 [2] for more information).
  • - or, if the "SM-Delivery-Not-Intended" Information Element was present in the request with a value of "only MCC+MNC requested", may contain MCC+MNC+dummy MSIN.

This information element shall be present in a successful answer.

This information element shall be present in an answer from the HSS to the IP-SM-GW, if an Absent User result is returned and the UNRI is not set.

| +| Serving-Node | Serving-Node | C |

If the "SM-Delivery-Not-Intended" Information Element was not present in the request, this information element shall contain the identity of one serving node on which the user is registered. This identity shall either be:

  • - the Diameter identity and the Diameter realm of the MME registered for MT SMS plus the E.164 number of the MME for MT SMS;
  • - or the ISDN number of the MSC;
  • - or the Diameter identity and the Diameter realm of the SGSN, if they are available, and the ISDN number of the SGSN,
  • - or the Diameter identity and the Diameter realm of the IP-SM-GW, if they are available, and the ISDN number of the IP-SM-GW;
  • - or the Diameter identity and the Diameter realm of the SMSF registered for 3GPP access, if they are available, and the E.164 number of the SMSF registered for 3GPP access;
  • - or the Diameter identity and the Diameter realm of the SMSF registered for non 3GPP access, if they are available, and the E.164 number of the SMSF registered for non 3GPP access.

If the "SM-Delivery-Not-Intended" Information Element was present in the request, this information element may be absent.

This information element shall be present in a successful answer.

See NOTE.

| +| LMSI | LMSI | C |

The HSS shall include the LMSI in a successful response, if the VLR has used the LMSI and if there is the ISDN number of an MSC in the answer.

| + +| | | | | +|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Additional Serving Node | Additional-Serving-Node | C | This information element, when present shall either contain:
  • - the Diameter identity and the Diameter realm of the MME registered for MT SMS plus the E.164 number of the MME for MT SMS.
  • - or the ISDN number of the MSC
  • - or the Diameter identity and the Diameter realm of the SGSN, if they are available, and the ISDN number of the SGSN;
  • - or the Diameter identity and the Diameter realm of the SMSF registered for 3GPP access, if they are available, and the E.164 number of the SMSF registered for 3GPP access;
  • - or the Diameter identity and the Diameter realm of the SMSF registered for non 3GPP access, if they are available, and the E.164 number of the SMSF registered for non 3GPP access.
It shall not contain information delivered in the Serving Node information element.
See NOTE. | +| User Identifier Alert | User-Identifier | C | This information element shall contain the MSISDN stored in the HSS, when available. | +| MWD Status | MWD-Status | C | This Information Element is sent when appropriate and shall contain a bit mask. See 5.3.3.8 for the meaning of the bits. | +| MME Absent User Diagnostic SM | MME-Absent-User-Diagnostic-SM | C | This information element shall contain the reason of the absence of the user when given by the MME and stored in the HSS | +| MSC Absent User Diagnostic SM | MSC-Absent-User-Diagnostic-SM | C | This information element shall contain the reason of the absence of the user when given by the MSC and stored in the HSS | +| SGSN Absent User Diagnostic SM | SGSN-Absent-User-Diagnostic-SM | C | This information element shall contain the reason of the absence of the user when given by the SGSN and stored in the HSS | +| Supported Features | Supported-Features
(See 3GPP TS 29.229 [5]) | O | If present, this information element shall contain the list of features supported by the origin host. | +| SMSF 3GPP Address | SMSF-3GPP-Address | C | If the "SM-Delivery-Not-Intended" Information Element was not present in the request, this information element shall contain the identity of the registered SMSF for 3GPP access.
If the "SM-Delivery-Not-Intended" Information Element was present in the request, this information element may be absent.
See NOTE. | +| SMSF Non 3GPP Address | SMSF-Non-3GPP-Address | C | If the "SM-Delivery-Not-Intended" Information Element was not present in the request, this information element shall contain the identity of the registered SMSF or Non-3GPP access.
If the "SM-Delivery-Not-Intended" Information Element was present in the request, this information element may be absent.
See NOTE. | +| SMSF 3GPP Absent User Diagnostic SM | SMSF-3GPP-Absent-User-Diagnostic-SM | C | This information element shall contain the reason of the absence of the user when given by the SMSF registered for 3GPP access.
See NOTE | +| SMSF Non 3GPP Absent User Diagnostic SM | SMSF-Non-3GPP-Absent-User-Diagnostic-SM | C | This information element shall contain the reason of the absence of the user when given by the SMSF registered for Non-3GPP access.
See NOTE | +| NOTE: | If the feature "SMSF-Support" is not supported by the SMS-GMSC, IP-SM-GW, or SMS Router, the AVPs SMSF-3GPP-Address, SMSF-Non-3GPP-Address, SMSF-3GPP-Absent-User-Diagnostic and SMSF-Non-3GPP-Absent-User-Diagnostic shall not be present. In this case the SMSF 3GPP Address and/or the SMSF Non 3GPP Address may be populated in the existing Serving-Node and Additional-Serving-Node AVPs as applicable. | | | + +#### 5.2.1.2 Detailed behaviour of the SMS-GMSC + +The SMS-GMSC shall make use of this procedure to retrieve the routing information needed for routing the short message to the serving MSC or MME or SGSN or SMSF registered for 3GPP access or SMSF registered for non-3GPP access for enforcing routing of the SM delivery via the SMS Router of HPLMN. + +It shall populate the information elements in the Send Routing Info for SM request according to the table 5.2.1.1-1. + +When the Send Routing Info for SM Request is sent by the SMS-GMSC to the HSS in a retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [17]), IMSI may not be available. In this case the IMSI information element shall be populated with the HSS-ID value. + +When receiving the Send Routing Info for SM Answer, the SMS-GMSC or the SMS Router shall use the received Diameter address if the SMS-GMSC or the SMS Router transfers the terminating short message over the SGd or the Gdd interface. + +#### 5.2.1.3 Detailed behaviour of the HSS + +This clause describes the HSS behaviour when the HSS receives a Send Routing Info for SM request which is not forwarded to an SMS Router or an IP-SM-GW. + +The HSS shall check if the user identified by the MSISDN is known; otherwise, the HSS shall return an Experimental-Result-Code set to DIAMETER\_ERROR\_USER\_UNKNOWN. + +The HSS shall check if a MT SMS Teleservice subscription exists; otherwise, the HSS shall return an Experimental-Result-Code set to DIAMETER\_ERROR\_SERVICE\_NOT\_SUBSCRIBED. + +The HSS shall check if the user is not barred for receiving MT short messages; otherwise, the HSS shall return an Experimental-Result-Code set to DIAMETER\_SERVICE\_ERROR\_BARRED. + +The HSS shall check if one or more serving nodes (not marked with the mobile not reachable flag) are registered for MT SMS; otherwise, the HSS shall return an Experimental-Result-Code set to DIAMETER\_ERROR\_ABSENT\_USER and update the MWD list and MNRF/MNRG. If there is no serving node being registered for MT SMS and the Single-Attempt-Delivery flag in SRR-Flags AVP is set, the HSS shall not add the SC address into the MWD list. + +The HSS shall then return a Send Routing Info for SM answer with a Result-Code set to DIAMETER\_SUCCESSFUL that shall contain the addresses of the serving nodes that are registered for MT SMS according the following rules: + +- if the GPRS indicator is not set, only one serving node address shall be returned according to the SM transfer option where MME is considered as a MSC. The address of the MME, if returned, shall comprise the MME Diameter address and the MME Number for MT SMS. The address of the SMSF, if returned, shall comprise the SMSF Diameter address and the SMSF Number. +- if the GPRS indicator is set, two serving node addresses may be returned of which + - the Diameter address of the SGSN if available and the SGSN number, + - either the number of the MSC or the Diameter address and the number of the MME for MT SMS. +- when two serving g nodes addresses are returned, the HSS selects which serving node it will populate in the Serving Node information element and in the Additional Serving Node information elements. +- if the feature SMSF-Support is commonly supported, the HSS includes addresses of the registered SMSFs (if any) in the response, regardless of the GPRS indicator. + +NOTE: MSC and MME cannot be both registered as serving nodes for MT SMS at a given time (cf 3GPP TS 23.272 [2]) + +If the stored MSISDN number is not the same as the one received in the Send Routing Info for SM request service, the stored MSISDN number shall be included in the message. + +In the context of MSISDN-less SMS delivery in IMS (see 3GPP TS 23.204 [17]), if the HSS receives an SMSMI correlation ID, the HSS shall return the IP-SM-GW number and shall not forward the request to an IP-SM-GW. + +#### 5.2.1.4 Detailed behaviour of the SMS Router + +When receiving a Send Routing Info for SM request, the SMS Router shall: + +- send a Send Routing Info for SM request to the HSS to retrieve the routing information needed for routing the short message to the serving MSC or MME or SGSN or SMSF; +- if the Send Routing Info for SM answer received from HSS is successful, the SMS Router shall send a Send Routing Info for SM answer to the SMS-GMSC where + - the SMS router shall populate the same Serving Node and Additional Serving Node fields (i.e AVPs) as the ones it received in the Send Routing Info for SM answer from HSS, but with its own SMS Router number and its own SMS Router Diameter address; +- if the Send Routing Info for SM answer received from HSS is not successful, the SMS Router shall send a Send Routing Info for SM answer to the SMS-GMSC with the same Diameter error result code. + +If the SMS Router receives some of the following information elements, User Identifier Alert, MWD Status, MSC Absent User Diagnostic SM, MME Absent User Diagnostic SM, SGSN Absent User Diagnostic SM, it shall transfer them in the Send-Routing Info for SM answer to the SMS-GMSC. + +### 5.2.2 Alert Service Centre procedure + +#### 5.2.2.1 General + +This procedure shall be used between the HSS and the SMS-IWMSC to indicate that the MS is now recognized by the PLMN to have recovered its operation to allow for an MT SMS delivery. This procedure is used according to the call flows described in 3GPP TS 23.040 [2] clause 10. + +Table 5.2.2.1-1 specifies the involved information elements for the request. + +Table 5.2.2.1-2 specifies the involved information elements for the answer. + +This procedure is mapped to the commands Alert-Service-Centre-Request/Answer (ALR/ALA) in the Diameter application specified in clause 5.3.2. + +Table 5.2.2.1-1: Alert Service Centre Request + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------|---------------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Service Centre Address | SC-Address | M | This information element shall contain the Service Centre address received from the mobile station. | +| User Identifier Alert | User-Identifier | M | This information element shall contain:
  • - either the Alert MSISDN when it exists;
  • - or the IMSI in the context of T4 device triggering (see 3GPP TS 23.682 [18] if MSISDN is not available;
  • - or a dummy MSISDN value (see clause 3 of 3GPP TS 23.003 [16]) if no MSISDN in a retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [17]).
| +| SMSMI Correlation ID | SMSMI-Correlation-ID | C | This information shall contain the SIP-URI of the destination user which is stored in the Message Waiting Data list in a retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [17]). The HSS-ID and the Originating SIP-URI shall be absent. | +| Maximum UE Availability Time | Maximum-UE-Availability-Time | C | This information element shall be included, if available. When present, it shall indicate the timestamp (in UTC) until which a UE using a power saving mechanism (such as extended idle mode DRX) is expected to be reachable for SM Delivery.
This information may be used by the SMS Center to prioritize the retransmission of Short Message to UEs using a power saving mechanism. | +| Supported Features | Supported-Features (See 3GPP TS 29.229 [5]) | O | If present, this information element shall contain the list of features supported by the origin host. | + +Table 5.2.2.1-2: Alert Service Centre Answer + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|---------------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This information element shall contain the result of the request.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol see IETF RFC 6733 [20].
The Experimental-Result AVP shall be used for S6c errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. This information element shall contain the result of the operation with an indication of the success / errors. No errors are defined for this case. | +| Supported Features | Supported-Features (See 3GPP TS 29.229 [5]) | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 5.2.2.2 Detailed behaviour of the HSS + +The HSS shall make use of this procedure to alert the service centre when the mobile user is active after a short message transfer has failed because the mobile user is not reachable, or when the UE has indicated that it has memory capacity to accept a short message. + +It is an operator option to resend an Alert Service Centre request to the SMS-IWMSC if the alert is unsuccessful. The number of repeat attempts and the interval between them is also an operator option. The service centre address should be purged from the MWD list if the alert is consistently unsuccessful. + +#### 5.2.2.3 Detailed behaviour of the SMS-IWMSC + +When receiving an Alert Service Centre request the SMS-IWMSC shall check whether the service centre address is known. If the service centre address is not valid, then no further action shall be taken. + +If the service centre address is valid, the SMS-IW-MSC generates an Alert Service Centre message towards the SMS Centre. + +### 5.2.3 Report SM Delivery Status procedure + +#### 5.2.3.1 General + +This procedure shall be used between the SMS-GMSC or the IP-SM-GW and the HSS to update the Message Waiting Data in the HSS or to inform the HSS of a successful SM transfer after polling. This procedure is invoked by the SMS-GMSC or the IP-SM-GW. + +This procedure is applicable to an IP-SM-GW for its SMS Router function when using the S6c interface. + +This procedure is used according to the call flows described in 3GPP TS 23.040 [2] clause 10. + +Table 5.2.3.1-1 specifies the involved information elements for the request. + +Table 5.2.3.1-2 specifies the involved information elements for the answer. + +This procedure is mapped to the commands Report-SM-Delivery-Status-Request/Answer (RDR/RDA) in the Diameter application specified in clause 5.3.2. + +Table 5.2.3.1-1: Report SM Delivery Status Request + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|---------------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identifier | User-Identifier | M | This information element shall contain:
  • - the MSISDN of the user when it exists.
  • - or the IMSI of the UE if MSISDN is not available in the context of a SM delivery status report following a T4 Submit Trigger (see 3GPP TS 23.682 [18]) .
  • - or the value of the HSS ID within the User-Name AVP in a retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [17]).
| +| SMSMI-Correlation ID | SMSMI-Correlation-ID | C | In a retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [17]), this information element shall contain the SIP-URI of the (MSISDN-less) destination user. The originating SIP-URI and the HSS-ID shall be absent from this information element. | +| Service Centre Address | SC-Address | M | This information element shall contain the Service Centre address. | +| SM Delivery Outcome | SM-Delivery-Outcome | M | This information element shall contain the causes for setting the message waiting data in the HSS according to the network node(s) used for the SM delivery:
  • - MSC
  • - MME
  • - SGSN
  • - IP-SM-GW
  • - SMSF-3GPP
  • - SMSF-Non3GPP.
At least one cause shall be present. A cause originated from a MSC and a cause originated from a MME shall not be both present. When the cause is Absent User, the Absent User Diagnostic, if available, shall be associated to the cause. | +| RDR Flags | RDR-Flags | O | This Information Element contains a bit mask. See 5.3.3.21 for the meaning of the bits and the condition for each bit to be set or not. | +| Supported Features | Supported-Features (See 3GPP TS 29.229 [5]) | O | If present, this Information Element shall contain the list of features supported by the origin host. | + +Table 5.2.3.1-2: Report SM Delivery Status Answer + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|---------------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This information element shall contain the Result of the request. The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [20]). The Experimental-Result AVP shall be used for S6c errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. This information element shall contain the result of the operation with an indication of the success / errors. The following errors are applicable:
  • - Unknown User;
  • - Message Waiting List Full.
| +| MSISDN-Alert | User-Identifier | C | This information element shall contain the Alert MSISDN of the user if it is different from the MSISDN received in the request. | +| Supported Features | Supported-Features (See 3GPP TS 29.229 [5]) | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 5.2.3.2 Detailed behaviour of the SMS-GMSC + +The SMS-GMSC shall make use of this procedure if: + +- the reason received from the serving node for failure to deliver the message is absent user, unidentified user or SM delivery failure with error cause "UE memory capacity exceeded", and the SC address is not yet included in the MWD set, and the serving node did not request the SMS-GMSC to retransmit the Short Message at a later requested retransmission time, or +- the reason received from the serving node for failure to deliver the message is absent user, unidentified user or SM delivery failure with error cause "UE memory capacity exceeded", and the corresponding flag in the HSS (as indicated in the information received from HSS) is not set, or +- the reason received from the serving node (MSC/MME, SGSN or SMSF) for failure to deliver the message is absent user and the absent user diagnostic is different from the absent user diagnostic received from the HSS. + +If absent user diagnostic information (see 3GPP TS 23.040 [3]) is received with the absent user error indication then the SMS-GMSC shall relay this information to the HSS. + +#### 5.2.3.3 Detailed behaviour of IP-SM-GW + +The IP-SM-GW shall make use of this procedure if: + +- the reason for failure to deliver the message is absent user, unidentified user or SM delivery failure with error cause "UE memory capacity exceeded", and the SC address is not yet included in the MWD set, or +- the reason for failure to deliver the message is absent user, unidentified user or SM delivery failure with error cause "UE memory capacity exceeded", and the corresponding flag in the HSS (as indicated in the information received in the MAP\_INFORM\_SERVICE\_CENTRE) is not set, or +- the reason for failure to deliver the message is absent user and the absent user diagnostic is different from the absent user diagnostic received from the HSS. + +#### 5.2.3.4 Detailed behaviour of the HSS + +When receiving a Report SM Delivery Status request the HSS shall check if the user is known. + +If the user is not known, the HSS shall return an Experimental-Result-Code set to DIAMETER\_ERROR\_USER\_UNKNOWN. + +If it is known, the HSS shall update the Message Waiting data as described in 3GPP TS 23.040 [3]. If the Single-Attempt-Delivery flag in RDR-Flags AVP is set, the HSS shall not add the SC address into the MWD list. + +If the message waiting data is full, the HSS shall return an Experimental-Result-Code set to DIAMETER\_ERROR\_MWD\_LIST\_FULL. + +If the received MSISDN is different from the stored MSISDN, the HSS shall return the Alert MSISDN. + +## 5.3 Protocol specification + +### 5.3.1 Routing considerations + +#### 5.3.1.1 Requests from the SMS-GMSC or the SMS router + +##### 5.3.1.1.1 Introduction + +The clauses in 5.3.1.1 specify the use of the Diameter routing AVPs Destination-Realm and Destination-Host over the S6c interface for Diameter command requests from the SMS-GMSC or the SMS router or the IP-SM-GW (i.e. for the Send Routing Info for SM and the Report SM Delivery Status procedures). The clause 5.3.1.1 also applies for the Report SM Delivery Status request generated by a SMS-SC in a retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [17]). + +##### 5.3.1.1.2 Routing from the originating PLMN + +If the SMS-GMSC or the SMS router has stored or can obtain the address/name and the home network domain name of the HSS identified by the MSISDN or the IMSI, both the Destination-Realm and Destination-Host AVPs shall be present in the request. + +The SMS Router shall use the MCC/MNC values of the PLMN to which it belongs, to build the MCC/MNC based network domain as described in clause 19.2 of 3GPP TS 23.003 [16] and include it in the Destination-Realm AVP of the request. The request shall then be routed to the next Diameter node. + +If the SMS-GMSC can only obtain the MCC/MNC values from the MSISDN or the IMSI, the SMS-GMSC shall use them to build the MCC/MNC based network domain as described in clause 19.2 of 3GPP TS 23.003 [16] and include it in the Destination-Realm AVP of the request. The request shall then be routed to the next Diameter node. + +If the SMS-GMSC cannot obtain the MCC/MNC values from the MSISDN of the user, the SMS-GMSC may forward the request to a Diameter node within the same PLMN, the Destination Realm content being left to the PLMN operator choice. Then: + +- if a Diameter node in the routing path insides the PLMN of the SMS-GMSC can obtain the MCC/MNC values of the PLMN to which the user is subscribed to (i.e. when the number portability is resolved in the network of the SMS-GMSC), or +- if, otherwise, the Diameter node can obtain the MCC/MNC values of the PLMN associated to the CC and NDC codes of the MSISDN of the user, then +- the Diameter node shall use them to build the MCC/MNC based network domain as described in clause 19.2 of 3GPP TS 23.003 [16] and include it in the Destination-Realm AVP of the request. The request shall then be routed to the next Diameter node. + +If the MCC/MNC values of the PLMN associated to the CC and NDC codes of the MSISDN or the MCC/MNC values of the PLMN to which the user is subscribed to cannot be obtained in the PLMN of the SMS-GMSC, the request shall be replaced in the PLMN of the SMS-GMSC by an equivalent request routed through a MAP interface (e.g. via an IWF). + +NOTE 1: The inter PLMN routing principle is to reuse the routing based on a MCC/MNC based domain name as used by other Diameter applications such as S6a/d. It is assumed that obtaining the relevant MCC/MNC values from the MSISDN can be achieved in the PLMN to which the SMS-GMSC belongs. Otherwise MAP based routing is used. This routing principle may be completed with other routing solutions in the future. + +NOTE 2: The Number portability resolution in the PLMN of the SMS-GMSC can be handled by an intermediate Diameter agent consulting a Number Portability Database of the Network Portability domain to which the PLMN of the SMS-GMSC belongs. + +If the SMS-SC or the SMS-GMSC, in a retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [17]), has stored or can obtain the address/name and the home network domain name of the HSS identified by the HSS ID, both the Destination-Realm and Destination-Host AVPs shall be present in the request. + +If the SMS-SC or the SMS-GMSC, in a retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [17]), can only obtain the MCC/MNC values from the HSS ID, the SMS-SC shall use them to build the MCC/MNC based network domain as described in clause 19.2 of 3GPP TS 23.003 [16] and include it in the Destination-Realm AVP of the request. The request shall then be routed to the next Diameter node. + +NOTE: In a retry context of MSISDN-less SMS delivery in IMS (see 3GPP TS 23.204 [17]), the SMS-SC gets the HSS-ID from the MO Forward Short Message request as described in clause 6.2.1. + +##### 5.3.1.1.3 Routing in the HPLMN + +When the request reaches a Diameter node in the home PLMN of the user and when multiple and separately addressable HSSs have been deployed in the home PLMN, the identity of the HSS that holds the subscriber data for a given user identified by its MSISDN may be retrieved by a user identity to HSS resolution mechanism as described in clause 5.4. + +When the request (i.e Send Routing Info for SM or Report SM Delivery Status) for SM occurs in the retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [17]), the Diameter identity of the HSS that holds + +the subscriber data for a given user may be retrieved by a user identity to HSS resolution mechanism as described in clause 5.4, where the HSS ID conveyed in the request is considered as a user identity. + +Consequently, the Destination-Host AVP is declared as optional in the ABNF for all requests initiated by an SMS-GMSC or a SMS Router. + +The HSS, when receiving a Send Routing Info for SM request, checks if an SMS Router is configured in the home network or if an IP-SM-GW has been registered for the user. If yes, the HSS shall act as a Diameter proxy and forward the request to the SMS Router or to the IP-SM-GW, by inserting the Diameter address of the SMS Router or of the IP-SM-GW as the Diameter destination address. If the Send Routing Info for SM request occurs in the retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [17]), the HSS shall return the IP-SM-GW address and shall not forward the request to an IP-SM-GW. + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +#### 5.3.1.2 Requests from the HSS + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host over the S6c interface for Diameter command requests from the HSS (i.e. for the Alert SC procedure). + +If the HSS has stored the address/name of the SMS-SC and the associated home network domain name in the Message Waiting Data of the user, both the Destination-Realm and Destination-Host AVPs shall be present in the Diameter request. Otherwise the routing shall use MAP. + +### 5.3.2 Commands + +#### 5.3.2.1 Introduction + +This clause defines the Command code values and related ABNF for each command described for the S6c interface. + +#### 5.3.2.2 Command-Code values + +This clause defines the Command-Code values for the S6c interface application as allocated by IANA in the IETF RFC 5516 [8]. + +Every command is defined by means of the ABNF syntax IETF RFC 2234 [6], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [20]. In the case, the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [20] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with IETF RFC 6733 [20]. + +The following Command Codes are defined in this specification: + +**Table 5.3.2.2/1: Command-Code values for S6c** + +| Command-Name | Abbreviation | Code | Clause | +|-----------------------------------|--------------|---------|---------| +| Send-Routing-Info-for-SM-Request | SRR | 8388647 | 5.3.2.3 | +| Send-Routing-Info-for-SM-Answer | SRA | 8388647 | 5.3.2.4 | +| Alert-Service-Centre-Request | ALR | 8388648 | 5.3.2.5 | +| Alert-Service-Centre-Answer | ALA | 8388648 | 5.3.2.6 | +| Report-SM-Delivery-Status-Request | RDR | 8388649 | 5.3.2.7 | +| Report-SM-Delivery-Status-Answer | RDA | 8388649 | 5.3.2.8 | + +For these commands, the Application-ID field shall be set to 16777312 (application identifier of the S6c interface application allocated by IANA). + +#### 5.3.2.3 Send-Routing-Info-for-SM-Request (SRR) Command + +The Send-Routing-Info-for-SM-Request (SRR) command, indicated by the Command-Code field set to 8388647 and the "R" bit set in the Command Flags field, is sent from SMS-GMSC to HSS or SMS Router or from SMS Router to HSS. + +Message Format: + +``` +< Send-Routing-Info-for-SM-Request > ::= < Diameter Header: 8388647, REQ, PXY, 16777312 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Destination-Host ] +{ Destination-Realm } +[ MSISDN ] +[ User-Name ] +[ SMSMI-Correlation-ID ] +*[ Supported-Features ] +[ SC-Address ] +[ SM-RP-MTI ] +[ SM-RP-SMEA ] +[ SRR-Flags ] +[ SM-Delivery-Not-Intended ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +``` + +#### 5.3.2.4 Send-Routing-info-for-SM-Answer (SRA) Command + +The Send-Routing-Info-for-SM-Answer (SRA) command, indicated by the Command-Code field set to 8388647 and the 'R' bit cleared in the Command Flags field, is sent from HSS to SMS-GMSC or SMS Router or from SMS Router to SMS-GMSC. + +Message Format: + +``` +< Send-Routing-info-for-SM-Answer > ::= < Diameter Header: 8388647, PXY, 16777312 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ User-Name ] +*[ Supported-Features ] +[ Serving-Node ] +[ Additional-Serving-Node ] +[ SMSF-3GPP-Address ] +[ SMSF-Non-3GPP-Address ] +[ LMSI ] +[ User-Identifier ] +[ MWD-Status ] +[ MME-Absent-User-Diagnostic-SM ] +[ MSC-Absent-User-Diagnostic-SM ] +[ SGSN-Absent-User-Diagnostic-SM ] +[ SMSF-3GPP-Absent-User-Diagnostic-SM ] +[ SMSF-Non-3GPP-Absent-User-Diagnostic-SM ] +*[ AVP ] +``` + +``` +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +``` + +#### 5.3.2.5 Alert-Service-Centre-Request (ALR) Command + +The Alert-Service-Centre-Request (ALR) command, indicated by the Command-Code field set to 8388648 and the "R" bit set in the Command Flags field, is sent from the HSS to the SMS-IWMSC and from the MME or SGSN to the SMS-GMSC (possibly via an SMS Router). + +Message Format: + +``` +< Alert-Service-Centre-Request > ::= < Diameter Header: 8388648, REQ, PXY, 16777312 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { SC-Address } + { User-Identifier } + [ SMSMI-Correlation-ID ] + [ Maximum-UE-Availability-Time ] + [ SMS-GMSC-Alert-Event ] + [ Serving-Node ] + *[ Supported-Features ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +#### 5.3.2.6 Alert-Service-Centre-Answer (ALA) Command + +The Alert-Service-Centre-Answer (ALA) command, indicated by the Command-Code field set to 8388648 and the 'R' bit cleared in the Command Flags field, is sent from the SMS-IWMSC to the HSS and from the SMS-GMSC to the MME or SGSN (possibly via an SMS Router). + +Message Format + +``` +< Alert-Service-Centre-Answer > ::= < Diameter Header: 8388648, PXY, 16777312 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ Supported-Features ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +#### 5.3.2.7 Report-SM-Delivery-Status-Request (RDR) Command + +The Report-SM-Delivery-Status-Request (RDR) command, indicated by the Command-Code field set to 8388649 and the "R" bit set in the Command Flags field, is sent from SMS-GMSC or IP-SM-GW to HSS. + +Message Format: + +``` + +< Report-SM-Delivery-Status-Request > ::= < Diameter Header: 8388649, REQ, PXY, 16777312 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + *[ Supported-Features ] + { User-Identifier } + [ SMSMI-Correlation-ID ] + { SC-Address } + { SM-Delivery-Outcome } + [ RDR-Flags ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +#### 5.3.2.8 Report-SM-Delivery-Status-Answer (RDA) Command + +The Report-SM-Delivery-Status-Answer (RDA) command, indicated by the Command-Code field set to 8388649 and the 'R' bit cleared in the Command Flags field, is sent from HSS to SMS-GMSC or IP-SM-GW. + +Message Format + +``` + +< Report-SM-Delivery-Status-Answer > ::= < Diameter Header: 8388649, PXY, 16777312 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ Supported-Features ] + [ User-Identifier ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +### 5.3.3 AVPs + +#### 5.3.3.1 General + +The following table specifies the Diameter AVPs defined for the S6c interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +For all AVPs which contain bit masks and are of the type Unsigned32, e.g. TFR-Flags, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. + +Table 5.3.3.1/1: S6c specific Diameter AVPs + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | | +|-----------------------------------------|----------|----------------|------------------|----------------|-----|------------|----------|-----------| +| | | | | Must | May | Should not | Must not | May Encr. | +| SM-RP-MTI | 3308 | 5.3.3.2 | Enumerated | M, V | | | | No | +| SM-RP-SMEA | 3309 | 5.3.3.3 | OctetString | M, V | | | | No | +| SRR-Flags | 3310 | 5.3.3.4 | Unsigned32 | M, V | | | | No | +| SM-Delivery-Not-Intended | 3311 | 5.3.3.5 | Enumerated | M, V | | | | No | +| MWD-Status | 3312 | 5.3.3.8 | Unsigned32 | M, V | | | | No | +| MME-Absent-User-Diagnostic-SM | 3313 | 5.3.3.9 | Unsigned32 | M, V | | | | No | +| MSC-Absent-User-Diagnostic-SM | 3314 | 5.3.3.10 | Unsigned32 | M, V | | | | No | +| SGSN-Absent-User-Diagnostic SM | 3315 | 5.3.3.11 | Unsigned32 | M, V | | | | No | +| SM-Delivery-Outcome | 3316 | 5.3.3.14 | Grouped | M, V | | | | No | +| MME-SM-Delivery-Outcome | 3317 | 5.3.3.15 | Grouped | M, V | | | | No | +| MSC-SM-Delivery-Outcome | 3318 | 5.3.3.16 | Grouped | M, V | | | | No | +| SGSN-SM-Delivery-Outcome | 3319 | 5.3.3.17 | Grouped | M, V | | | | No | +| IP-SM-GW-SM-Delivery-Outcome | 3320 | 5.3.3.18 | Grouped | M, V | | | | No | +| SM-Delivery-Cause | 3321 | 5.3.3.19 | Enumerated | M, V | | | | No | +| Absent-User-Diagnostic-SM | 3322 | 5.3.3.20 | Unsigned32 | M, V | | | | No | +| RDR-Flags | 3323 | 5.3.3.21 | Unsigned32 | V | | | M | No | +| Maximum-UE-Availability-Time | 3329 | 5.3.3.22 | Time | V | | | M | No | +| SMS-GMSC-Alert-Event | 3333 | 5.3.3.23 | Unsigned32 | V | | | M | No | +| SMSF-3GPP-Absent-User-Diagnostic-SM | 3334 | 5.3.3.25 | Unsigned32 | V | | | M | No | +| SMSF-Non-3GPP-Absent-User-Diagnostic-SM | 3335 | 5.3.3.26 | Unsigned32 | V | | | M | No | +| SMSF-3GPP-SM-Delivery-Outcome | 3336 | 5.3.3.27 | Grouped | V | | | M | No | +| SMSF-Non-3GPP-SM-Delivery-Outcome | 3337 | 5.3.3.28 | Grouped | V | | | M | No | +| SMSF-3GPP-Number | 3338 | 5.3.3.29 | OctetString | V | | | M | No | +| SMSF-Non-3GPP-Number | 3339 | 5.3.3.30 | OctetString | V | | | M | No | +| SMSF-3GPP-Name | 3340 | 5.3.3.31 | DiameterIdentity | V | | | M | No | +| SMSF-Non-3GPP-Name | 3341 | 5.3.3.32 | DiameterIdentity | V | | | M | No | +| SMSF-3GPP-Realm | 3342 | 5.3.3.33 | DiameterIdentity | V | | | M | No | +| SMSF-Non-3GPP-Realm | 3343 | 5.3.3.34 | DiameterIdentity | V | | | M | No | +| SMSF-3GPP-Address | 3344 | 5.3.3.35 | Grouped | V | | | M | No | +| SMSF-Non-3GPP-Address | 3345 | 5.3.3.36 | Grouped | V | | | M | No | +| SMSF-3GPP-SBI-Support-Indicator | 3346 | 5.3.3.37 | Enumerated | V | | | M | No | +| SMSF-Non-3GPP-SBI-Support-Indicator | 3347 | 5.3.3.38 | Enumerated | V | | | M | No | +| IP-SM-GW-SBI-Support-Indicator | 3348 | 5.3.3.39 | Enumerated | V | | | M | No | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V" indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [20]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table specifies the Diameter AVPs re-used from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within this interface. + +Any other AVPs from existing Diameter Applications, except for the AVPs from Diameter Base Protocol specified in IETF RFC 6733 [20], do not need to be supported. The AVPs from Diameter base protocol specified in IETF RFC 6733 [20] are not included in table 5.3.3.1/2, but they may be re-used for this interface. + +Table 5.3.3.1/2: S6c re-used Diameter AVPs + +| Attribute Name | Reference | Comments | M-bit | +|---------------------------|---------------------|-------------------------------------------------------------|--------------| +| User-Name | IETF RFC 6733 [20] | | Must | +| MSISDN | 3GPP TS 23.329 [14] | | | +| SC-Address | 3GPP TS 29.338 | It is defined for the SGd/Gdd interface, see clause 6.3.3.2 | | +| LMSI | 3GPP TS 29.173 [10] | | | +| Serving-Node | 3GPP TS 29.173 [10] | See clause 5.3.3.6 | | +| MSC-Number | 3GPP TS 29.173 [10] | | | +| MME-Name | 3GPP TS 29.173 [10] | | | +| MME-Realm | 3GPP TS 29.173 [10] | | Must | +| MME-Number-for-MT-SMS | 3GPP TS 29.272 [4] | | Must | +| SGSN-Number | 3GPP TS 29.272 [4] | | | +| SGSN-Name | 3GPP TS 29.173 [10] | | | +| SGSN-Realm | 3GPP TS 29.173 [10] | | | +| Additional-Serving-Node | 3GPP TS 29.173 [10] | See clause 5.3.3.7 | | +| User-Identifier | 3GPP TS 29.336 [15] | | | +| SM-Delivery-Failure-Cause | 3GPP TS 29.338 | It is defined for the SGd/Gdd interface, see clause 6.3.3.5 | | +| IP-SM-GW-Name | 3GPP TS 29.336 [15] | | | +| IP-SM-GW-Number | 3GPP TS 29.336 [15] | | | +| SMSMI-Correlation-ID | 3GPP TS 29.338 | It is defined for the SGd/Gdd interface, see clause 6.3.3.2 | | +| Destination-SIP-URI | 3GPP TS 29.338 | It is defined for the SGd/Gdd interface, see clause 6.3.3.2 | | +| Supported-Features | 3GPP TS 29.229 [5] | | | +| Feature-List-ID | 3GPP TS 29.229 [5] | See clause 5.3.3.12 | | +| Feature-List | 3GPP TS 29.229 [5] | See clause 5.3.3.13 | | +| DRMP | IETF RFC 7944 [19] | see clause 5.3.3.24 | Must not set | + +NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +#### 5.3.3.2 SM-RP-MTI + +The SM-RP-MTI AVP is of type Enumerated and shall contain the RP-Message Type Indicator of the Short Message. The following values are defined: + +- SM\_DELIVER (0) +- SM\_STATUS\_REPORT (1) + +#### 5.3.3.3 SM-RP-SMEA + +The SM-RP-SMEA AVP is of type OctetString and shall contain the RP-Originating SME-address of the Short Message Entity that has originated the SM. It shall be formatted according to the formatting rules of the address fields described in 3GPP TS 23.040 [3]. + +#### 5.3.3.4 SRR-Flags + +The SRR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 5.3.3.4/1: + +**Table 5.3.3.4/1: SRR-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | GPRS-Indicator | This bit shall be set if the SMS-GMSC supports receiving of two serving nodes addresses from the HSS. | +| 1 | SM-RP-PRI | This bit shall be set if the delivery of the short message shall be attempted when a service centre address is already contained in the Message Waiting Data file | +| 2 | Single-Attempt-Delivery | This bit if set indicates that only one delivery attempt shall be performed for this particular SM. | +| NOTE 1: Bits not defined in this table shall be cleared by the sending entity and discarded by the receiving entity. | | | + +#### 5.3.3.5 SM-Delivery-Not-Intended + +The SM-Delivery-Not-Intended AVP is of type Enumerated and shall indicate by its presence that delivery of a short message is not intended. It further indicates whether only IMSI or only MCC+MNC with the following values: + +- ONLY\_IMSI\_REQUESTED (0), +- ONLY\_MCC\_MNC\_REQUESTED (1). + +#### 5.3.3.6 Serving-Node + +The Serving-Node AVP is of type Grouped. This AVP shall contain the information about the network node serving the targeted SMS user. It is originally defined in 3GPP TS 29.173 [10]. + +AVP format + +``` +Serving-Node ::= + [ SGSN-Name ] + [ SGSN-Realm ] + [ SGSN-Number ] + [ MME-Name ] + [ MME-Realm ] + [ MME-Number-for-MT-SMS ] + [ MSC-Number ] + [ IP-SM-GW-Number ] + [ IP-SM-GW-Name ] + [ IP-SM-GW-Realm ] + [ IP-SM-GW-SBI-Support-Indicator ] + *[AVP] +``` + +The following combinations are allowed: + +- a) SGSN-Number + +- b) SGSN-Name & SGSN-Realm & SGSN-Number if the HSS supports the "Gdd in SGSN" feature and has received the "Gdd in SGSN" indication over S6a or Gr interface from the SGSN (cf. 3GPP TS 29.272 [4] and 3GPP TS 29.002 [9]) +- c) MME-Name & MME-Realm & MME-Number-for-MT-SMS +- d) MSC-Number +- e) MSC-Number & MME-Name & MME-Realm +- f) IP-SM-GW-Number +- g) IP-SM-GW-Number & IP-SM-GW-Name. +- h) IP-SM-GW-Number & IP-SM-GW-SBI-Support-Indicator +- i) IP-SM-GW-Number & IP-SM-GW-Name & IP-SM-GW-SBI-Support-Indicator. + +#### 5.3.3.7 Additional-Serving-Node + +The Additional-Serving-Node AVP is of type Grouped. This AVP shall contain the information about the network node serving the targeted user. It is originally defined in 3GPP TS 29.173 [10]. + +AVP format + +``` +Additional-Serving-Node ::= + [ SGSN-Name ] + [ SGSN-Realm ] + [ SGSN-Number ] + [ MME-Name ] + [ MME-Realm ] + [ MME-Number-for-MT-SMS ] + [ MSC-Number ] + *[AVP] +``` + +The following combinations are allowed: + +- a) SGSN-Number +- b) SGSN-Name & SGSN-Realm & SGSN-Number if the HSS supports the "Gdd in SGSN" feature and has received the "Gdd in SGSN" indication over S6a or Gr interface from the SGSN (cf. 3GPP TS 29.272 [4] and 3GPP TS 29.002 [9]) +- c) MME-Name & MME-Realm & MME-Number-for-MT-SMS +- d) MSC-Number +- e) MSC-Number & MME-Name & MME-Realm + +#### 5.3.3.8 MWD-Status + +The MWD-Status AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 5.3.3.8/1: + +**Table 5.3.3.8/1: MWD Status** + +| bit | name | Description | +|--------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| 0 | SC-Address Not included | This bit when set shall indicate that the SC Address has not been added to the Message Waiting Data in the HSS. | +| 1 | MNRF-Set | This bit, when set, shall indicate that the MNRF flag is set in the HSS | +| 2 | MCEF-Set | This bit, when set, shall indicate that the MCEF flag is set in the HSS. | +| 3 | MNRG-Set | This bit, when set, shall indicate that the MNRG flag is set in the HSS | +| 4 | MNR5G-Set | This bit, when set, shall indicate that the HSS/UDM is waiting for a reachability notification / registration from 5G serving nodes. | +| NOTE: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME. | | | + +#### 5.3.3.9 MME-Absent-User-Diagnostic-SM + +The MME-Absent-User-Diagnostic-SM AVP is of type Unsigned32 and shall indicate the diagnostic explaining the absence of the user given by the MME. The values are defined in 3GPP TS 23.040 [3] clause 3.3.2. + +#### 5.3.3.10 MSC-Absent-User-Diagnostic-SM + +The MSC-Absent-User-Diagnostic-SM AVP is of type Unsigned32 and shall indicate the diagnostic explaining the absence of the user given by the MSC. The values are defined in 3GPP TS 23.040 [3] clause 3.3.2. + +#### 5.3.3.11 SGSN-Absent-Subscriber-Diagnostic-SM + +The SGSN-Absent-User-Diagnostic-SM AVP is of type Unsigned32 and shall indicate the diagnostic explaining the absence of the user given by the SGSN. The values are defined in 3GPP TS 23.040 [3] clause 3.3.2. + +#### 5.3.3.12 Feature-List-ID AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [5]. For this release, the Feature-List-ID AVP value shall be set to 1. + +#### 5.3.3.13 Feature-List AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [5]. A null value indicates that there is no feature used by the application. + +For the S6c application, the meaning of the bits shall be as defined in table 5.3.3.13/1 for the Feature-List-ID 1. + +**Table 5.3.3.13/1: Features of Feature-List-ID 1 used in S6c** + +| Feature bit | Feature | M/O | Description | +|-------------|--------------|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | SMSF-Support | O |

SMSF-Support

This feature is applicable for the SRR/SRA command pair.
If the SMS-GMSC or IP-SM-GW or SMS-Router does not support this feature, the HSS shall not return SMSF related AVPs (SMSF-3GPP-Address, SMSF-Non-3GPP-Address, SMSF-3GPP-Absent-User-Diagnostic-SM, SMSF-Non-3GPP-Absent-User-Diagnostic-SM) in SRA, and when the UE is known not to be reachable for SMS via MSC/MME and/or SGSN, the HSS may populate AVPs within the Serving-Node AVP and within the Additional-Serving-Node AVP with available SMSF address information.

| + +Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1". +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "SMSF-Support". +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. + +#### 5.3.3.14 SM-Delivery-Outcome + +The SM-Delivery-Outcome AVP is of type Grouped. This AVP contains the result of the SM delivery. + +AVP format: + +SM-Delivery-Outcome ::= + +[ MME-SM-Delivery-Outcome ] + +[ MSC-SM-Delivery-Outcome ] + +[ SGSN-SM-Delivery-Outcome ] + +[ IP-SM-GW-SM-Delivery-Outcome ] + +[ SMSF-3GPP-SM-Delivery-Outcome ] + +[ SMSF-Non-3GPP-SM-Delivery-Outcome ] + +\*[AVP] + +#### 5.3.3.15 MME-SM-Delivery-Outcome + +The MME-Delivery-Outcome AVP is of type grouped and shall indicate the outcome of the SM delivery for setting the message waiting data in the HSS when the SM delivery is with an MME. + +AVP format: + +MME-SM-Delivery-Outcome ::= > + +[ SM-Delivery-Cause ] + +[ Absent-User-Diagnostic-SM ] + +#### 5.3.3.16 MSC-SM-Delivery-Outcome + +The MSC-Delivery-Outcome AVP is of type grouped and shall indicate the outcome of the SM delivery for setting the message waiting data in the HSS when the SM delivery is with an MSC. + +AVP format: + +MSC-SM-Delivery-Outcome ::= + +[ SM-Delivery-Cause ] + +[ Absent-User-Diagnostic-SM ] + +#### 5.3.3.17 SGSN-SM-Delivery-Outcome + +The SGSN-Delivery-Outcome AVP is of type grouped and shall indicate the outcome of the SM delivery for setting the message waiting data in the HSS when the SM delivery is with an SGSN. + +AVP format: + +SGSN-SM-Delivery-Outcome ::= + +[ SM-Delivery-Cause ] + +[ Absent-User-Diagnostic-SM ] + +#### 5.3.3.18 IP-SM-GW-SM-Delivery-Outcome + +The IP-SM-GW-SM-Delivery-Outcome AVP is of type grouped and shall indicate the outcome of the SM delivery for setting the message waiting data when the SM delivery is with an IP-SM-GW. The following values are defined. + +AVP format: + +IP-SM-GW-SM-Delivery-Outcome ::= + +[ SM-Delivery-Cause ] + +[ Absent-User-Diagnostic-SM ] + +#### 5.3.3.19 SM-Delivery-Cause + +The SM-Delivery-Cause AVP is of type Enumerated and shall indicate the cause of the SMP delivery result. The following values are defined: + +- UE\_MEMORY\_CAPACITY\_EXCEEDED (0) +- ABSENT\_USER (1) +- SUCCESSFUL\_TRANSFER (2) + +#### 5.3.3.20 Absent-User-Diagnostic-SM + +The Absent-User-Diagnostic-SM AVP is of type Unsigned32 and shall indicate the diagnostic explaining the absence of the subscriber. The values are defined in 3GPP TS 23.040 [3] clause 3.3.2. + +#### 5.3.3.21 RDR-Flags + +The RDR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 5.3.3.21/1: + +**Table 5.3.3.21/1: RDR-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------------|-------------------------|-----------------------------------------------------------------------------------------------------| +| 0 | Single-Attempt-Delivery | This bit if set indicates that only one delivery attempt shall be performed for this particular SM. | +| NOTE 1: Bits not defined in this table shall be cleared by the sending entity and discarded by the receiving entity. | | | + +#### 5.3.3.22 Maximum-UE-Availability-Time + +The Maximum-UE-Availability-Time is of type Time and in shall contain the timestamp (in UTC) until which a UE using a power saving mechanism (such as extended idle mode DRX) is expected to be reachable for SM Delivery. + +#### 5.3.3.23 SMS-GMSC-Alert-Event + +The SMS-GMSC-Alert-Event AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 5.3.3.23/1: + +**Table 5.3.3.23/1: SMS-GMSC-Alert-Event** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------| +| 0 | UE-Available-For-MT-SMS | This bit, when set, shall indicate that the UE is now available for MT SMS | +| 1 | UE-Under-New-Serving-Node | This bit, when set, shall indicate that the UE has moved under the coverage of another MME or SGSN. | +| NOTE 1: Bits not defined in this table shall be cleared by the sending entity and discarded by the receiving entity. | | | + +#### 5.3.3.24 DRMP + +The DRMP AVP is of type Enumerated and it is defined in IETF RFC 7944 [19]. This AVP allows the HSS, the SMS-GMSC, the SMS-Router and the IP-SM-GW to indicate the relative priority of Diameter messages over the S6c interface. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +#### 5.3.3.25 SMSF-3GPP-Absent-User-Diagnostic-SM + +The SMSF-3GPP-Absent-User-Diagnostic-SM AVP is of type Unsigned32 and shall indicate the diagnostic explaining the absence of the user given by the SMSF registered for 3GPP access. The values are defined in 3GPP TS 23.040 [3] clause 3.3.2. + +#### 5.3.3.26 SMSF-Non-3GPP-Absent-User-Diagnostic-SM + +The SMSF-Non-3GPP-Absent-User-Diagnostic-SM AVP is of type Unsigned32 and shall indicate the diagnostic explaining the absence of the user given by the SMSF registered for Non-3GPP access. The values are defined in 3GPP TS 23.040 [3] clause 3.3.2. + +#### 5.3.3.27 SMSF-3GPP-SM-Delivery-Outcome + +The SMSF-3GPP-SM-Delivery-Outcome AVP is of type grouped and shall indicate the outcome of the SM delivery for setting the message waiting data in the HSS when the SM delivery is with an SMSF registered for 3GPP access. + +AVP format: + +SMSF-3GPP-SM-Delivery-Outcome ::= > + +[ SM-Delivery-Cause ] + +[ Absent-User-Diagnostic-SM ] + +#### 5.3.3.28 SMSF-Non-3GPP-SM-Delivery-Outcome + +The SMSF-Non-3GPP-SM-Delivery-Outcome AVP is of type grouped and shall indicate the outcome of the SM delivery for setting the message waiting data in the HSS when the SM delivery is with an SMSF registered for Non-3GPP access. + +AVP format: + +SMSF-Non-3GPP-SM-Delivery-Outcome ::= > + +[ SM-Delivery-Cause ] + +[ Absent-User-Diagnostic-SM ] + +#### 5.3.3.29 SMSF-3GPP-Number + +The SMSF-3GPP-Number AVP is of type OctetString and it shall contain the ISDN number of the SMSF registered for 3GPP access. For further details on the definition of this AVP, see 3GPP TS 23.003 [3]. This AVP contains an SMSF-3GPP-Number in international number format as described in ITU-T Rec E.164 [13] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [9] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +#### 5.3.3.30 SMSF-Non-3GPP-Number + +The SMSF-Non-3GPP-Number AVP is of type OctetString and it shall contain the ISDN number of the SMSF registered for Non-3GPP access. For further details on the definition of this AVP, see 3GPP TS 23.003 [3]. This AVP contains an SMSF-Non-3GPP-Number in international number format as described in ITU-T Rec E.164 [13] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [9] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +#### 5.3.3.31 SMSF-3GPP-Name + +The SMSF-3GPP-Name AVP is of type DiameterIdentity and it shall contain the Diameter identity of the serving SMSF registered for 3GPP access. For further details on the encoding of this AVP, see IETF RFC 6733 [20]. + +#### 5.3.3.32 SMSF-Non-3GPP-Name + +The SMSF-Non-3GPP-Name AVP is of type DiameterIdentity and it shall contain the Diameter identity of the serving SMSF registered for Non-3GPP access. For further details on the encoding of this AVP, see IETF RFC 6733 [20]. + +#### 5.3.3.33 SMSF-3GPP-Realm + +The SMSF-3GPP-Realm AVP is of type DiameterIdentity and it shall contain the Diameter Realm Identity of the serving SMSF registered for 3GPP access. For further details on the encoding of this AVP, see IETF RFC 6733 [20]. + +#### 5.3.3.34 SMSF-Non-3GPP-Realm + +The SMSF-Non-3GPP-Realm AVP is of type DiameterIdentity and it shall contain the Diameter Realm Identity of the serving SMSF registered for Non-3GPP access. For further details on the encoding of this AVP, see IETF RFC 6733 [20]. + +#### 5.3.3.35 SMSF-3GPP-Address + +The SMSF-3GPP-Address AVP is of type Grouped. This AVP shall contain the information about the SMSF serving the targeted user for 3GPP access. + +AVP format + +``` +SMSF-3GPP-Address ::= + [ SMSF-3GPP-Number ] + [ SMSF-3GPP-Name ] + [ SMSF-3GPP-Realm ] + [ SMSF-3GPP-SBI-Support-Indicator ] + *[AVP] +``` + +#### 5.3.3.36 SMSF-Non-3GPP-Address + +The SMSF-Non-3GPP-Address AVP is of type Grouped. This AVP shall contain the information about the SMSF serving the targeted user for Non-3GPP access. + +AVP format + +``` +SMSF-Non-3GPP-Address ::= + [ SMSF-Non-3GPP-Number ] + [ SMSF-Non-3GPP-Name ] + [ SMSF-Non-3GPP-Realm ] + [ SMSF-Non-3GPP-SBI-Support-Indicator ] + *[AVP] +``` + +#### 5.3.3.37 SMSF-3GPP-SBI-Support-Indicator + +The SMSF-3GPP-SBI-Support-Indicator AVP is of type Enumerated and shall indicate whether the SMSF support service-based-interface or not, with the following values: + +- NOT\_SUPPORT\_SBI (0), +- SUPPORT\_SBI (1). + +#### 5.3.3.38 SMSF-Non-3GPP-SBI-Support-Indicator + +The SMSF-Non-3GPP-SBI-Support-Indicator AVP is of type Enumerated and shall indicate whether the SMSF support service-based-interface or not, with the following values: + +- NOT\_SUPPORT\_SBI (0), +- SUPPORT\_SBI (1). + +#### 5.3.3.39 IP-SM-GW-SBI-Support-Indicator + +The IP-SM-GW-SBI-Support-Indicator AVP is of type Enumerated and shall indicate whether the IP-SM-GW support service-based-interface or not, with the following values: + +- NOT\_SUPPORT\_SBI (0), +- SUPPORT\_SBI (1). + +## 5.4 User identity to HSS resolution + +The User identity to HSS resolution mechanism enables the SMS-GMSC or SMS Router in the home PLMN or Diameter proxy agents in the home PLMN to find the identity of the HSS that holds the subscriber data for a given user identified by its MSISDN or by its IMSI when multiple and separately addressable HSSs have been deployed in the home PLMN. The resolution mechanism is not required in PLMNs that utilise a single HSS. + +This User identity to HSS resolution mechanism may rely on routing capabilities provided by Diameter and be implemented in the home PLMN within dedicated Diameter Agents (Proxy Agents) responsible for determining the HSS identity based on the provided user identity. If this Diameter based implementation is selected by the home PLMN operator, the principles described below shall apply. + +When more than one independently addressable HSS are deployed in the home PLMN, each SMS-GMSC or SMS-Router network of the home PLMN shall be configured with the address/identity of a Diameter Agent (Proxy Agent) implementing this resolution mechanism. + +Diameter Relay agents and/or Diameter Proxy agents in the home PLMN receiving the Diameter signalling from SMS-GMSC located in other PLMNs shall be configured with the address/identity of a Diameter Agent (Proxy Agent) implementing this resolution mechanism. + +To get the HSS identity that holds the subscriber data for a given user identity in the home network, the Diameter request normally destined to the HSS shall be sent to the pre-configured address/identity of a Diameter Proxy agent supporting the User identity to HSS resolution mechanism. + +- If this Diameter request is received by a Diameter Redirect Agent, the Diameter Redirect Agent shall determine the HSS identity based on the provided user identity (i.e. MSISDN or IMSI) and shall return a notification of redirection towards the HSS identity, in response to the Diameter request. Multiple HSS identities may be included in the response, as specified in IETF RFC 6733 [20]. In such a case, the requesting Diameter entity shall send the Diameter request to the first HSS identity in the ordered list received in the Diameter response from the Diameter Redirect Agent. If no successful response to the Diameter request is received, the requesting Diameter entity shall send a Diameter request to the next HSS identity in the ordered list. This procedure shall be repeated until a successful response from an HSS is received. After the user identity to HSS resolution, the MME or the SGSN shall store the determined HSS identity/name/Realm and shall use it in further Diameter requests to the same user identity. +- If this Diameter request is received by a Diameter Proxy Agent, the Diameter Proxy Agent shall determine the HSS identity based on the provided user identity (i.e. MSISDN or IMSI) and shall forward the Diameter request directly to the HSS. In this case, the user identity to HSS resolution decision is communicated to the SMS-GMSC in the Origin-Host/Origin-Realm AVPs of the response. + +NOTE: Alternatives to the user identity to HSS resolution Diameter based implementation are outside the scope of this specification. + +The User identity to HSS resolution mechanism, in a retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [17]), applies as described in this clause for requests issued by the SMS-SC to a HSS and where the IMSI of the user is replaced by the HSS ID of the HSS storing the subscription data of the user. + +# --- 6 Diameter based SGd/Gdd interfaces between MME/SGSN and central SMS functions + +## 6.1 Introduction + +The SGd interface enables the transfer of short messages between the MME, the SMS-IWMSC, the SMS-GMSC and the SMS Router, and the alerting of the SMS-GMSC by the MME (possibly via an SMS Router), as described in 3GPP TS 23.040 [3]. + +The Gdd interface enables the transfer of short messages between the SGSN, the SMS-IWMSC, the SMS-GMSC and the SMS Router, and the alerting of the SMS-GMSC by the SGSN (possibly via an SMS Router) as described in 3GPP TS 23.040 [3]. + +## 6.2 Procedures description + +### 6.2.1 MO Forward Short Message procedure + +#### 6.2.1.1 General + +This procedure shall be used between the serving MME or SGSN or IP-SM-GW and the SMS-IWMSC to forward mobile originated short messages from a mobile user to a Service Centre. + +This procedure is used according to the call flows described in 3GPP TS 23.040 [3] clause 10. + +This procedure may also be used between the SMS-IWMSC and the MTC-IWF to forward mobile originated short messages from a mobile user to an MTC-IWF; see 3GPP TS 23.682 [18]. + +Table 6.2.1.1/1 specifies the involved information elements for the request. + +Table 6.2.1.1/2 specifies the involved information elements for the answer. + +This procedure is mapped to the commands MO-Forward-Short-Message-Request/Answer (OFR/OFA) in the Diameter application specified in clause 6.3.2. + +Table 6.2.1.1/1: MO Forward Short Message Request + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|--------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SM RP DA | SC-Address | M | When used between MME or SGSN or IP-SM-GW and SMS-IWMSC, this information element shall contain the Service Centre address received from the mobile station.
When used between SMS-IWMSC and MTC-IWF, this information element shall contain the MTC-IWF address as pre-configured in the SMS-SC. | +| SM RP OA | User-Identifier | M | This information element shall contain:
- the IMSI if it is available;
- the MSISDN of the user when it exists.
- a dummy MSISDN value in the context of MSISDN-less SMS delivery in IMS (see 3GPP TS 23.204 [17]), if IMSI is not available. In this case the originating user is identified by the Originating SIP-URI (see SMSMI-Correlation ID). | +| SM RP UI | SM-RP-UI | M | This information element shall contain the short message transfer protocol data unit | +| SMSMI-Correlation ID | SMSMI-Correlation-ID | C | This information element indicates by its presence that the request is sent in the context of MSISDN-less SMS delivery in IMS (see 3GPP TS 23.204 [17]).
When present, this information element shall contain an HSS-ID identifying the destination user's HSS, a Destination SIP-URI identifying the MSISDN-less destination user, and an Originating SIP-URI identifying the MSISDN-less originating user. | +| OFR Flags | OFR-Flags | C | This information element shall contain a bit mask. See 6.3.3.12 for the meaning of the bits. | +| EPS-Location-Information | EPS-Location-Information | O | When present, this Information Element shall contain the EPS-Location Information (as defined in TS 29.272, clause 7.3.111) indicating the serving cell where the UE is originating the SMS from. | +| SM Delivery Outcome | SM-Delivery-Outcome | C | This information element shall be present if the SMSMI Correlation ID is present and shall contain the IP-SM-GW SM Delivery Outcome with the causes for setting the message waiting data in the HSS. | +| Supported Features | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +NOTE: In the context of MSISDN-less SMS delivery in IMS (see 3GPP TS 23.204 [17]), the IP-SM-GW gets the HSS-ID and the SM Delivery Outcome from the SIP message coming from the IMS network of the destination user and indicating a temporary SMS delivery failure. + +Table 6.2.1.1/2: MO-Forward Short Message Answer + +| Information element name | Mapping to Diameter AVP | Cat | Description | +|---------------------------|-----------------------------------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This information element shall contain the result of the operation. The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [20]). The Experimental-Result AVP shall be used for SGd/Gdd/T4 errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. The following errors are applicable:
- Facility Not Supported;
- SM Delivery Failure. | +| SM Delivery Failure Cause | SM-Delivery-Failure-Cause | C | If the Experimental-Result-Code is set to DIAMETER_ERROR_SM_DELIVERY_FAILURE, this information element shall be present and indicate one of the following:
- unknown Service Centre/MTC-IWF address;
- Service Centre/MTC-IWF congestion;
- invalid Short Message Entity address;
- user not Service Centre/SCS-AS user.
It may be completed with a Diagnostic information element. | +| SM RP UI | SM-RP-UI | O | If present, this information element shall contain a short message transfer protocol data unit in the message delivery acknowledgement from the SMS-IWMSC to the MME or SGSN | +| Supported Features | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| External-Identifier | External-Identifier | C | This information element shall contain the External Identifier identifying the sender of the short message. Shall be present when the answer is sent over T4 to the SMS-IWMSC for charging. | + +#### 6.2.1.2 Detailed behaviour of the MME, the SGSN and the IP-SM-GW + +When the "SMS in MME" feature is applied for the UE, the MME shall make use of this procedure to forward mobile originated short messages received from the UE to the SMS-IWMSC associated to the SMS-SC indicated by the UE. + +When the SGSN supports the SMS service for the UE, the SGSN shall make use of this procedure to forward mobile originated short messages received from the UE to the SMS-IWMSC associated to the SMS-SC indicated by the UE. + +The IP-SM-GW shall make use of this procedure to forward mobile originated short messages received from the UE to the SMS-IWMSC associated to the SMS-SC indicated by the UE. This procedure shall be also used in the context of MSISDN-less SMS delivery in IMS (see 3GPP TS 23.204 [17]), when the direct SMS delivery has failed, + +The MME or the SGSN shall check if the SMS related subscription data (e.g. ODB data and Call Barring) allows forwarding the short message. + +#### 6.2.1.3 Detailed behaviour of the SMS-IWMSC + +When receiving the MO Forward Short Message Request, the SMS-IWMSC shall check if the SMS-SC is known, if it is not, an Experimental-Result-Code set to DIAMETER\_ERROR\_SM\_DELIVERY\_FAILURE and a SM Delivery Failure Cause indicating "unknown Service Centre address" shall be returned to the MME or the SGSN. + +The SMS IWMSC shall then pass the short message to the addressed SMS-SC, or, if the destination user identity maps to an MTC-IWF based on a pre-configured mapping table, forward it to the appropriate MTC-IWF. + +If the SMS-SC or MTC-IWF returns a negative acknowledgement, an Experimental-Result-Code set to DIAMETER\_ERROR\_SM\_DELIVERY\_FAILURE and a SM Delivery Failure Cause indicating the cause given by the SMC-SC or MTC-IWF shall be returned to the MME or the SGSN. + +If the SMS-SC or MTC-IWF returns a positive acknowledgement to the SMS IWMSC, a Result-Code set to DIAMETER\_SUCCESS shall be returned to the MME or the SGSN. + +If a requested facility is not supported, an Experimental-Result-Code set to DIAMETER\_ERROR\_FACILITY\_NOT\_SUPPORTED shall be returned. + +### 6.2.2 MT Forward Short Message procedure + +#### 6.2.2.1 General + +This procedure shall be used between the SMS-GMSC and the serving MME or SGSN (transiting an SMS Router, if present) or IP-SM-GW to forward mobile terminated short messages. + +This procedure is used according to the call flows described in 3GPP TS 23.040 [3] clause 10. + +Table 6.2.2.1/1 specifies the involved information elements for the request. + +Table 6.2.2.1/2 specifies the involved information elements for the answer. + +This procedure is mapped to the commands MT-Forward-Short-Message-Request/Answer (TFR/TFA) in the Diameter application specified in clause 6.3.2. + +**Table 6.2.2.1/1: MT Forward Short Message Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------|------------------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SM RP DA | User-Name
(See IETF RFC 673 3 [20]) | M | This information element shall contain
- either an IMSI
- or a HSS ID value if an SMSMI-Correlation ID is present, the destination user being identified by the Destination SIP-URI within the SMSMI Correlation ID. | +| SM RP OA | SC-Address | M | This information element shall contain the Service Centre address. | +| SMSMI Correlation ID | SMSMI-Correlation-ID | C | This information element indicates by its presence that the request is sent in the context of MSISDN-less SMS delivery in IMS (see 3GPP TS 23.204 [17]).
When present, this information element shall contain the Destination SIP-URI identifying the (MSISDN-less) destination user and the Originating SIP-URI identifying the (MSISDN-less) originating user. The HSS-ID shall be absent from this information element. | +| SM RP UI | SM-RP-UI | M | This information element shall contain the short message transfer protocol data unit. | +| MME Number for MT SMS | MME-Number-for-MT-SMS | C | This Information Element contains the ISDN number of the MME (see 3GPP TS 23.003 [3]) and shall be present when the request is sent to a MME. | +| SGSN Number | SGSN-Number | C | This Information Element contains the ISDN number of the SGSN (see 3GPP TS 23.003 [3]) and shall be present when the request is sent to a SGSN. | +| TFR-Flags | TFR-Flags | C | This information element shall contain a bit mask. Bit 0 indicates when set if the Service Centre has more messages to send | +| SM Delivery Timer | SM-Delivery-Timer | C | This information element should be included. When present, it shall indicate the SM Delivery Timer value set in the SMS-GMSC to the IP-SM-GW, MME or S4-SGSN. | +| SM Delivery Start Time | SM-Delivery-Start-Time | C | This information element should be included. When present, it shall indicate the timestamp (in UTC) at which the SM Delivery Supervision Timer was started in the SMS-GMSC. | +| Maximum Retransmission Time | Maximum-Retransmission-Time | O | This information element, when present, shall indicate the maximum retransmission time (in UTC) until which the SMS-GMSC is capable to retransmit the MT Short Message. | +| SMS-GMSC Address | SMS-GMSC-Address | C | This IE shall be present if the Maximum Retransmission Time IE is present in the message.
When present, this IE shall contain the E.164 number of the SMS-GMSC in the request sent by the SMS-GMSC or the E.164 number of the SMS Router in the request sent by the SMS Router. | +| Supported Features | Supported-Features
(See 3GPP TS 29.229 [5]) | O | If present, this information element shall contain the list of features supported by the origin host. | + +Table 6.2.2.1/2: MT Forward Short Message Answer + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------|---------------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This information element shall contain the result of the operation. The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [20]). The Experimental-Result AVP shall be used for SGd/Gdd errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. The following errors are applicable:
- Unknown User;
- Absent User;
- User busy for MT SMS;
- Illegal User;
- Illegal Equipment;
- SM Delivery Failure. | +| Absent User Diagnostic SM | Absent-User-Diagnostic-SM | O | This information element may be present when Experimental-Result-Code is set to DIAMETER_ERROR_ABSENT_USER and it shall contain the reason of the absence of the user given by the MME or the SGSN. | +| SM Delivery Failure Cause | SM-Delivery-Failure-Cause | C | If Experimental-Result-Code is set to DIAMETER_ERROR_SM_DELIVERY_FAILURE, this information element shall be present and indicate one of the following:
- memory capacity exceeded in the mobile equipment;
- UE error;
- mobile equipment not equipped to support the mobile terminated short message service.
It may be completed with a Diagnostic information element | +| SM RP UI | SM-RP-UI | O | If present, this information element shall contain a short message transfer protocol data unit in the message delivery acknowledgement from the MME to the Service Centre. | +| Requested Retransmission Time | Requested-Retransmission-Time | O | This information element may only be present if the Experimental-Result-Code is set to DIAMETER_ERROR_ABSENT_USER and if the Maximum Retransmission Time information element is present in the MT Forward Short Message Request. It may be included if the UE is using a power saving mechanism (such as extended idle mode DRX) and the UE is currently not reachable.

When present, this shall indicate the retransmission time (in UTC) at which the SMS-GMSC is requested to retransmit the MT Short Message. The Requested Retransmission Time shall not exceed the Maximum Retransmission Time received from the SMS-GMSC. | +| User Identifier Alert | User-Identifier | C | This IE shall be present in the message from the SMS Router to the SMS-GMSC, if the Requested Retransmission Time IE is present in the message.
When present, this information shall contain an MT Correlation ID (encoded in the User-Name AVP). | +| EPS-Location-Information | EPS-Location-Information | O | When present, this Information Element shall contain the EPS-Location Information (as defined in TS 29.272, clause 7.3.111) indicating the serving cell where the MT UE is located. | +| Supported Features | Supported-Features (See 3GPP TS 29.229 [5]) | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 6.2.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a MT Forward Short Message Request, the MME or the SGSN shall check if the IMSI is known, + +If it is not known, an Experimental-Result-Code set to DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +The MME or the SGSN shall attempt to deliver the short message to the UE. + +If the delivery of the short message to the UE is successful, the MME or the SGSN shall return a Result-Code set to DIAMETER\_SUCCESS. + +If the UE is not reachable via the MME, the MME shall set the MNRF flag and shall return an Experimental-Result-Code set to DIAMETER\_ERROR\_ABSENT\_USER. + +If the UE is not reachable via the SGSN, the SGSN shall set the MNRG flag and shall return an Experimental-Result-Code set to DIAMETER\_ERROR\_ABSENT\_USER. + +If the UE is using extended idle mode DRX (as defined in 3GPP TS 23.682 [18]) and the UE is expected to not respond to paging shortly or within the time frame indicated by the SM-Delivery-Timer and SM-Delivery-Start-Time IEs, the MME or SGSN may behave as specified above for a UE that is not reachable, while still paging the UE. + +NOTE 1: This mechanism is not intended for UEs which are known to wake up shortly (e.g. within the next 10 seconds) as enough time needs to elapse, between the sending of the MT Forward Short Message Answer and the subsequent Notification procedure towards the HSS when the UE becomes reachable, to enable the Report SM Delivery Status procedure to take place beforehand from the SMS-GMSC to the HSS. + +If the UE is using extended idle mode DRX (as defined in 3GPP TS 23.682 [18]) and the UE is expected to respond to paging shortly or within the time frame indicated by the SM-Delivery-Timer and SM-Delivery-Start-Time IEs, the MME or SGSN should page the UE and attempt to deliver the short message to the UE. + +If the UE is using a power saving mechanism such as extended idle mode DRX (see 3GPP TS 23.682 [18]), and if the MT Forward Short Message Request includes the Maximum-Retransmission-Time AVP, the MME or SGSN may return an MT Forward Short Message Answer with the Experimental-Result-Code set to DIAMETER\_ERROR\_ABSENT\_USER and with the Requested-Retransmission-Time AVP requesting the SMS-GMSC to retransmit the Short Message at a later time prior to the Maximum-Retransmission-Time. In that case, the MME or SGSN shall store (if not already done) the Origin-Host, the Origin-Realm and the SMS-GMSC address received in request and shall not set the MNRF or MNRG flag. + +NOTE 2: This mechanism does not cause additional signalling at the HSS to retransmit the Short Message. + +If the delivery of the mobile terminated short message failed because of memory capacity exceeded or UE error or UE not SM equipped, the MME or the SGSN shall return an Experimental-Result-Code set to DIAMETER\_ERROR\_SM\_DELIVERY\_FAILURE complemented with a SM Delivery Failure Cause indication. + +If a requested facility is not supported, the MME or the SGSN shall return an Experimental-Result-Code set to DIAMETER\_ERROR\_FACILITY\_NOT\_SUPPORTED. + +If the user is busy for MT SMS, i.e. the mobile terminated short message transfer cannot be completed because: + +- another mobile terminated short message transfer is going on and the delivery node does not support message buffering; or +- another mobile terminated short message transfer is going on and it is not possible to buffer the message for later delivery; or +- the message was buffered but it is not possible to deliver the message before the expiry of the buffering time defined in 3GPP TS 23.040 [3], + +the MME or the SGSN shall return an Experimental-Result-Code set to DIAMETER\_ERROR\_USER\_BUSY\_FOR\_MT\_SMS. + +If the delivery of the mobile terminated short message failed because the mobile station failed authentication, the MME or the SGSN shall return an Experimental-Result-Code set to DIAMETER\_ERROR\_ILLEGAL\_USER. + +If the delivery of the mobile terminated short message failed because an IMEI check failed, i.e. the IMEI was prohibited-listed or not permitted-listed, the MME or the SGSN shall return an Experimental-Result-Code set to DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT. + +#### 6.2.2.3 Detailed behaviour of the SMS-GMSC + +The SMS-GMSC shall make use of this procedure over the SGd interface or over the Gdd interface for the delivery of a MT short message when it has selected the serving node of which it obtained the Diameter Identity from the answer of the Send Routing Info for SM procedure. + +NOTE: The SMS-GMSC is not aware that the MT Forward Short Message Request may be routed to a SMS router. + +The SMS-GMSC may include the Maximum-Retransmission-Time AVP in the MT Forward Short Request to indicate that it is capable to retransmit the Short Message until the indicated maximum retransmission time, if the following conditions are fulfilled: + +- the destination user pertains to the PLMN of the SMS-GMSC; and +- if an SMS Router is used for MT SMS sent to destination users pertaining to the PLMN of the SMS-GMSC, the SMS Router is known to support the Alert Service Centre procedure specified in clause 6.2.3. + +The SMS-GMSC shall include its E.164 number in the SMS-GMSC address in the request if it also includes the Maximum-Retransmission-Time AVP. + +When the SMS router has received a MT Forward Short Message from the SMS-GMSC and the SMS Router has selected the MME or the SGSN for delivery, the SMS Router shall forward it to the MME or the SGSN. + +If the MT Forward Short Message Request includes the Maximum-Retransmission-Time AVP, the SMS Router shall store the SMS-GMSC Diameter Identity (received in the Origin-Host and Origin-Realm AVPs) and the SMS-GMSC address received in the request and replace them by its SMS Router Diameter Identity (in the Origin-Host and Origin-Realm AVPs) and SMS Router address (E.164 number) when forwarding the request to the MME or SGSN. + +When a MT Forward Short Message Answer is received from the MME, the SMS Router shall forward it to the SMS-GMSC. + +If the MT Forward Short Message Answer includes the Requested-Retransmission-Time AVP, the SMS Router shall include a User Identifier Alert AVP when forwarding the answer to the SMS-GMSC. + +NOTE: The User Identifier Alert is further used in the Alert Service Centre procedure specified in clause 6.2.3 to enable the SMS-GMSC to identify and retransmit all pending MT SMS messages towards the destination user. + +### 6.2.3 Alert Service Centre procedure + +#### 6.2.3.1 General + +This procedure shall be used between the MME or SGSN and the SMS-GMSC, possibly via an SMS Router, to indicate that a UE, for which one or more MT SMS have been requested to be retransmitted at a later time, is now available for MT SMS delivery or that it has moved under the coverage of another MME or SGSN. This procedure is used according to the call flows described in 3GPP TS 23.040 [2] clause 10. + +Table 6.2.3.1-1 specifies the involved information elements for the request. + +Table 6.2.3.1-2 specifies the involved information elements for the answer. + +This procedure is mapped to the commands Alert-Service-Centre-Request/Answer (ALR/ALA) in the Diameter application specified in clause 5.3.2. + +Table 6.2.3.1-1: Alert Service Centre Request + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------|---------------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Service Centre Address | SC-Address | M | This IE shall contain the E.164 number of the SMS-GMSC (or SMS Router) previously received in the SMS-GMSC Address IE in the MT Forward Short Message Request. | +| User Identifier Alert | User-Identifier | M | This IE shall contain:
  • - the IMSI when the request is sent from the MME or SGSN,
  • - the User Identifier Alert previously sent in the MT Forward Short Message Answer, when the request is sent from the SMS Router to the SMS-GMSC,
encoded in the User-Name AVP. | +| SMS-GMSC Alert Event | SMS-GMSC-Alert-Event | M | This IE shall contain the type of event that caused the Alert Service Centre Request to the SMS-GMSC:
  • - UE is available for MT SMS;
  • - UE has moved under the coverage of another MME or SGSN.
| +| New Serving Node Identity | Serving-Node | C | This IE shall be present if available and if the SMS-GMSC Alert Event indicates that the UE has moved under the coverage of another MME or SGSN.
When present, this IE shall contain the Diameter Identity and/or the E.164 number of the new serving node of the UE.
It shall be encoded as:
  • - an MME-Name, MME Realm and MME-Number-for-MT-SMS, if the new serving node is an MME;
  • - an SGSN-Number and, an SGSN-Name and SGSN Realm if available, if the new serving node is an SGSN.
| +| Supported Features | Supported-Features (See 3GPP TS 29.229 [5]) | O | If present, this information element shall contain the list of features supported by the origin host. | + +Table 6.2.3.1-2: Alert Service Centre Answer + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|---------------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result | Result-Code / Experimental-Result | M | This information element shall contain the result of the request.
The Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [20]).
The Experimental-Result AVP shall be used for S6c errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. This information element shall contain the result of the operation with an indication of the success / errors. No errors are defined for this case. | +| Supported Features | Supported-Features (See 3GPP TS 29.229 [5]) | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 6.2.3.2 Detailed behaviour of the MME and the SGSN + +The MME or SGSN shall make use of this procedure to alert the SMS-GMSC when the UE, for which one or more MT SMS have been requested to be retransmitted at a later time, becomes available for MT SMS delivery or moves under the coverage of another MME or SGSN prior to the requested SM retransmission time. + +The MME or SGSN shall delete the stored SMS-GMSC Diameter Identity (i.e. Origin-Host and Origin-Realm) and address after the Alert Service Centre procedure is completed. + +#### 6.2.3.3 Detailed behaviour of the SMS-GMSC + +When receiving an Alert Service Centre request, the SMS-GMSC shall retransmit pending MT SMS(s) for the destination user identified by the User Identifier Alert, to the same serving node if the SMS-GMSC Alert Event indicates that the UE is available for MT SMS, or to the new serving node if the SMS-GMSC Alert Event indicates that the UE has moved under the coverage of another MME or SGSN. In the latter case, if no New Serving Node Identity is received in the Alert Service Centre request, the SMS-GMSC shall initiate a Send Routing Info for SM procedure to retrieve the new serving node 's address from the HSS. + +#### 6.2.3.4 Detailed behaviour of the SMS-Router + +When receiving an Alert Service Centre request, the SMS-Router shall replace the IMSI received in the User Identifier Alert by the User Identifier Alert previously sent in the MT Forward Short Message Answer, and forward that request to the SMS-GMSC. + +## 6.3 Protocol specification + +### 6.3.1 Routing considerations + +#### 6.3.1.1 Routing for MO Forward SM messages: + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host over the SGd or Gdd interfaces for the Diameter command requests from the MME or from the SGSN (i.e. for the MO forward SM procedure). + +Also, this clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host over the T4 interface for the Diameter command requests from the SMS-IWMSC (i.e. for the MO forward SM procedure). + +This clause also applies for the Diameter command MO forward SM request from the IP-SM-GW towards an SMS-SC/SMS-IWMSC, including the case where the MO forward SM request occurs in the retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [17]). MME or SGSN is replaced by IP-SM-GW in the text of this clause. + +If the MME or the SGSN, from the SMS-SC E.164 number received from the UE, can obtain the address/name of the SMS-IWMSC and the associated home network domain name (e.g. by local configuration), both the Destination-Realm and Destination-Host AVPs shall be present in the request. + +If the MME or the SGSN, from the SMS-SC E.164 number received from the UE, can only obtain the MCC/MNC values of the PLMN to which the SMS-SC belongs, the MME or the SGSN shall use them to build the MCC/MNC based network domain as described in clause 19.2 of 3GPP TS 23.003 [16] and include it in the Destination-Realm AVP of the request. The request shall then be routed to the next Diameter node. + +If the MME or the SGSN cannot obtain the MCC/MNC values from the SMS-SC E.164 number, the MME or the SGSN shall forward the request to a Diameter node within the same PLMN, the Destination Realm content being left to the PLMN operator choice. Then: + +- if a Diameter node in the routing path insides the PLMN of the MME can obtain the MCC/MNC values of the PLMN to which the SMS-SC belongs, +- it shall use them to build the MCC/MNC based network domain as described in clause 19.2 of 3GPP TS 23.003 [16] and include it in the Destination-Realm AVP of the request. The request shall then be routed to the next Diameter node. + +If the MCC/MNC values of the PLMN to which the SMS-SC belongs cannot be obtained in the PLMN of the MME or the SGSN, the request shall be replaced in the PLMN of the MME or the SGSN by an equivalent request routed through a MAP interface (e.g. via an IWF). + +NOTE 1: The inter PLMN routing principle is to reuse the routing based on a MCC/MNC based domain name as used by other Diameter applications such as S6a/d. It is assumed that obtaining the relevant MCC/MNC values from the E.164 number of the SMS-SC can be achieved in the PLMN which the MME belongs to. Otherwise a MAP based routing is used. This routing principle may be completed with other routing solutions in the future. + +Consequently, the Destination-Host AVP is declared as optional in the ABNF for all requests initiated by an MME or a SGSN. + +The SMS-IWMSC shall be able to obtain the address/name of the MTC-IWF and the associated home network domain name from the destination SME address included in the MO TPDU (e.g. by local configuration); therefore both the Destination-Realm and Destination-Host AVPs shall be present in the request. + +#### 6.3.1.2 Routing for MT Forward SM messages: + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host for the Diameter command requests from the SMS-GMSC or the SMS Router (i.e. for the MT forward SM procedure). + +- if the SMS-GMSC has received the Diameter address/name of an MME or of the SGSN in the answer to its interrogation to the HSS/HLR for retrieving routing information and if it selects this serving node, it shall use it to populate the Destination-Realm and Destination-Host AVPs. +- If the SMS Router has received the Diameter address/name of the MME or of the SGSN in the answer to its interrogation to the HSS/HLR for retrieving routing information and if it selects this serving node, it shall use this Diameter address/name to populate the Destination-Realm and Destination-Host AVPs. + +Consequently, the Destination-Host AVP is declared as mandatory in the ABNF for all requests initiated by an SMS-GMSC or a SMS router. + +### 6.3.2 Commands + +#### 6.3.2.1 Introduction + +This clause defines the Command code values and related ABNF for each command described for the SGd interface. + +#### 6.3.2.2 Command-Code values + +This clause defines the Command-Code values for the SGd interface application as allocated by IANA in the IETF RFC 5516 [8], the SGd interface application being used over the SGd and Gdd interfaces. The Alert Service Centre procedure used over the SGd and Gdd interfaces also uses commands of the S6c interface application. + +Every command is defined by means of the ABNF syntax IETF RFC 2234 [6], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [20]. In the case, the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [20] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to ensure potential interoperability issues with Diameter agents non-compliant with IETF RFC 6733 [20]. + +The following Command Codes are defined in this specification: + +**Table 6.3.2.2/1: Command-Code values for SGd/Gdd** + +| Command-Name | Abbreviation | Code | Clause | +|----------------------------------|--------------|---------|---------| +| MO-Forward-Short-Message Request | OFR | 8388645 | 6.3.2.3 | +| MO-Forward-Short-Message Answer | OFA | 8388645 | 6.3.2.4 | +| MT-Forward-Short-Message Request | TFR | 8388646 | 6.3.2.5 | +| MT-Forward-Short-Message Answer | TFA | 8388646 | 6.3.2.6 | +| Alert-Service-Centre-Request | ALR | 8388648 | 5.3.2.5 | +| Alert-Service-Centre-Answer | ALA | 8388648 | 5.3.2.6 | + +For these commands, the Application-ID field shall be set to 16777313 (application identifier of the SGd interface application, allocated by IANA), except for the ALR/ALA commands for which the Application-ID field shall be set to 16777312 (application identifier of the S6c interface application, allocated by IANA). + +#### 6.3.2.3 MO-Forward-Short-Message-Request (OFR) Command + +The MO-Forward-Short-Message-Request (OFR) command, indicated by the Command-Code field set to 8388645 and the "R" bit set in the Command Flags field, is sent from the MME / SGSN to the SMS-IWMSC and it is also sent from the SMS-IWMSC to the MTC-IWF. + +Message Format + +``` +< MO-Forward-Short-Message-Request > ::= < Diameter Header: 8388645, REQ, PXY, 16777313 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { SC-Address } + [ OFR-Flags ] + *[ Supported-Features ] + { User-Identifier } + [ EPS-Location-Information ] + { SM-RP-UI } + [ SMSMI-Correlation-ID ] + [ SM-Delivery-Outcome ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +#### 6.3.2.4 MO-Forward-Short-Message-Answer (OFA) Command + +The MO-Forward-Short-Message-Answer Command (OFA) command, indicated by the Command-Code field set to 8388645 and the 'R' bit cleared in the Command Flags field, is sent from the SMS-IWMSC to the MME / SGSN and it is also sent from the MTC-IWF to the SMS-IWMSC. + +Message Format + +``` +< MO-Forward-Short-Message-Answer > ::= < Diameter Header: 8388645, PXY, 16777313 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ Supported-Features ] + [ SM-Delivery-Failure-Cause ] +``` + +``` +[ SM-RP-UI ] +[ External-Identifier ] +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +``` + +#### 6.3.2.5 MT-Forward-Short-Message-Request (TFR) Command + +The MT-Forward-Short-Message-Request (TFR) command, indicated by the Command-Code field set to 8388646 and the "R" bit set in the Command Flags field, is sent from the SMS-GMSC to the MME / SGSN (transiting an SMS Router, if present). + +Message Format + +``` +< MT-Forward-Short-Message-Request > ::= < Diameter Header: 8388646, REQ, PXY, 16777313 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +{ Destination-Host } +{ Destination-Realm } +{ User-Name } +*[ Supported-Features ] +[ SMSMI-Correlation-ID ] +{ SC-Address } +{ SM-RP-UI } +[ MME-Number-for-MT-SMS ] +[ SGSN-Number ] +[ TFR-Flags ] +[ SM-Delivery-Timer ] +[ SM-Delivery-Start-Time ] +[ Maximum-Retransmission-Time ] +[ SMS-GMSC-Address ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +``` + +#### 6.3.2.6 MT-Forward-Short-Message-Answer (TFA) Command + +The MT-Forward-Short-Message-Answer Command (TFA) command, indicated by the Command-Code field set to 8388646 and the 'R' bit cleared in the Command Flags field, is sent from the MME / SGSN to the SMS-GMSC (transiting an SMS Router, if present). + +Message Format + +``` +< MT-Forward-Short-Message-Answer > ::= < Diameter Header: 8388646, PXY, 16777313 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +*[ Supported-Features ] +[ Absent-User-Diagnostic-SM ] +[ SM-Delivery-Failure-Cause ] +[ SM-RP-UI ] +[ Requested-Retransmission-Time ] +``` + +[ User-Identifier ] + [ EPS-Location-Information ] + \*[ AVP ] + [ Failed-AVP ] + \*[ Proxy-Info ] + \*[ Route-Record ] + +### 6.3.3 AVPs + +#### 6.3.3.1 General + +The following table specifies the Diameter AVPs defined for the SGd/Gdd interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +For all AVPs which contain bit masks and are of the type Unsigned32, e.g., TFR-Flags, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. + +**Table 6.3.3.1/1: SGd/Gdd specific Diameter AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | | +|--------------------------------------|----------|----------------|-------------|----------------|-----|------------|----------|-----------| +| | | | | Must | May | Should not | Must not | May Encr. | +| SC-Address | 3300 | 6.3.3.2 | OctetString | M, V | | | | No | +| SM-RP-UI | 3301 | 6.3.3.3 | OctetString | M, V | | | | No | +| TFR-Flags | 3302 | 6.3.3.4 | Unsigned32 | M, V | | | | No | +| SM-Delivery-Failure-Cause | 3303 | 6.3.3.5 | Grouped | M, V | | | | No | +| SM-Enumerated-Delivery-Failure-Cause | 3304 | 6.3.3.6 | Enumerated | M, V | | | | No | +| SM-Diagnostic-Info | 3305 | 6.3.3.7 | OctetString | M, V | | | | No | +| SM-Delivery-Timer | 3306 | 6.3.3.10 | Unsigned32 | M, V | | | | No | +| SM-Delivery-Start-Time | 3307 | 6.3.3.11 | Time | M, V | | | | No | +| SMSMI-Correlation-ID | 3324 | 6.3.3.13 | Grouped | V | | | M | No | +| HSS-ID | 3325 | 6.3.3.14 | UTF8String | V | | | M | No | +| Originating-SIP-URI | 3326 | 6.3.3.15 | UTF8String | V | | | M | No | +| Destination-SIP-URI | 3327 | 6.3.3.16 | UTF8String | V | | | M | No | +| OFR-Flags | 3328 | 6.3.3.12 | Unsigned32 | V | | | M | No | +| Maximum-Retransmission-Time | 3330 | 6.3.3.17 | Time | V | | | M | No | +| Requested-Retransmission-Time | 3331 | 6.3.3.18 | Time | V | | | M | No | +| SMS-GMSC-Address | 3332 | 6.3.3.19 | OctetString | V | | | M | No | + +NOTE 1: The AVP header bit denoted as "M", indicates whether support of the AVP is required. The AVP header bit denoted as "V" indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [20]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table specifies the Diameter AVPs re-used from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within this interface. + +Any other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol specified in IETF RFC 6733 [20], do not need to be supported. The AVPs from Diameter base protocol specified in IETF RFC 6733 [20] are not included in table 6.3.3.1/2, but they may be re-used for this interface. + +Table 6.3.3.1/2: SGd/Gdd re-used Diameter AVPs + +| Attribute Name | Reference | Comments | M-bit | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|----------------------------------------------------------|--------------| +| User-Name | IETF RFC 6733 [20] | | Must | +| User-Identifier | 3GPP TS 29.336 [15] | | | +| MME-Number-for-MT-SMS | 3GPP TS 29.272 [4] | | | +| SGSN-Number | 3GPP TS 29.272 [4] | | Must not | +| EPS-Location-Information | 3GPP TS 29.272 [4] | | Must not set | +| Absent-User-Diagnostic-SM | 3GPP TS 29.338 | It is defined for the S6c interface, see clause 5.3.3.20 | | +| Supported-Features | 3GPP TS 29.229 [5] | | | +| Feature-List-ID | 3GPP TS 29.229 [5] | See clause 6.3.3.8 | | +| Feature-List | 3GPP TS 29.229 [5] | See clause 6.3.3.9 | | +| DRMP | IETF RFC 7944 [19] | see clause 6.3.3.20 | Must not set | +| External-Identifier | 3GPP TS 29.336 [15] | | Must not | +| NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. | | | | +| NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. | | | | + +#### 6.3.3.2 SC-Address + +The SC-Address AVP is of type OctetString and it shall contain the E.164 number of the SMS-SC or MTC-IWF, in international number format as described in ITU-T Recommendation E.164 [13] and encoded as a TBCD-string. See 3GPP TS 29.002 [9] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +#### 6.3.3.3 SM-RP-UI + +The SM-RP-UI is of type OctetString and it shall contain a short message transfer protocol data unit (TPDU) which is defined in 3GPP TS 23.040 [3] and represents the user data field carried by the short message service relay sub-layer protocol. Its maximum length is of 200 octets. + +#### 6.3.3.4 TFR-Flags + +The TFR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 6.3.3.4/1: + +Table 6.3.3.4/1: TFR-Flags + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------------|-----------------------|---------------------------------------------------------------------------------------------| +| 0 | More-Messages-To-Send | This bit, when set, shall indicate that the service centre has more short messages to send. | +| NOTE 1: Bits not defined in this table shall be cleared by the sending entity and discarded by the receiving entity. | | | + +#### 6.3.3.5 SM-Delivery-Failure-Cause + +The SM-Delivery-Failure-Cause AVP is of type Grouped. It shall contain information about the cause of the failure of a SM delivery with an optional Diagnostic information. + +The AVP format shall conform to: + +``` +SM-Delivery-Failure-Cause ::= + { SM-Enumerated-Delivery-Failure-Cause } + [ SM-Diagnostic-Info ] + *[ AVP ] +``` + +#### 6.3.3.6 SM-Enumerated-Delivery-Failure-Cause + +The SM-Enumerated-Delivery-Failure-Cause AVP is of type enumerated and it shall contain the cause of the failure of a SM delivery. The following values are defined: + +MEMORY\_CAPACITY\_EXCEEDED (0), +EQUIPMENT\_PROTOCOL\_ERROR (1), +EQUIPMENT\_NOT\_SM-EQUIPPED (2), +UNKNOWN\_SERVICE\_CENTRE (3), +SC-CONGESTION (4), +INVALID\_SME-ADDRESS (5), +USER\_NOT\_SC-USER (6). + +NOTE: The values of the SM-Enumerated-Delivery-Failure-Cause AVP correspond to the ones for the SM-EnumeratedDeliveryFailureCause parameter in MAP as described in 3GPP TS 29.002[9]. + +#### 6.3.3.7 SM-Diagnostic-Info + +The SM-Diagnostic-Info AVP is of type OctetString and it shall contain a complementary information associated to the SM Delivery Failure cause. + +#### 6.3.3.8 Feature-List-ID AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [5]. For this release, the Feature-List-ID AVP value shall be set to 1. + +#### 6.3.3.9 Feature-List AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [5]. A null value indicates that there is no feature used by the application. + +NOTE: There is no feature defined for this release. + +#### 6.3.3.10 SM-Delivery-Timer + +The SM-Delivery-Timer is of type Integer and it shall contain the value in seconds of the timer for SM Delivery. + +#### 6.3.3.11 SM-Delivery-Start-Time + +The SM-Delivery-Start-Time is of type Time and in shall contain the timestamp (in UTC) at which the SM Delivery Supervision Timer was started. + +#### 6.3.3.12 OFR-Flags + +The OFR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 6.3.3.12/1: + +**Table 6.3.3.12/1: OFR-Flags** + +| Bit | Name | Description | +|-----|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | S6a/S6d-Indicator | This bit, when set, indicates that the OFR message is sent on the Gdd interface, i.e. the source node is an SGSN (or a combined MME/SGSN to which the UE is attached via UTRAN). This bit, when cleared, indicates that the OFR message is sent on the SGd interface, i.e. the source node is an MME (or a combined MME/SGSN to which the UE is attached via UTRAN or GERAN). | + +#### 6.3.3.13 SMSMI-Correlation-ID + +The SMSMI-Correlation-ID AVP is of type Grouped. It shall contain information identities used in the context of MSISDN-less SMS delivery in IMS (see 3GPP TS 23.204 [17]). + +The AVP format shall conform to: + +SMS-MI-Correlation-ID ::= + +[ HSS-ID ] + +[ Originating-SIP-URI ] + +[ Destination-SIP-URI ] + +\*[ AVP ] + +#### 6.3.3.14 HSS-ID + +The HSS-ID AVP is of type UTF8String. The definition and the composition of the HSS-ID are specified in 3GPP TS 23.003 [16]. + +#### 6.3.3.15 Originating-SIP-URI + +The Originating-SIP-URI AVP is of type UTF8String. It shall contain the Public identity of the IMS UE without MSISDN which is the sender of a short message, in the context of MSISDN-less SMS delivery in IMS (see 3GPP TS 23.204 [17]). + +#### 6.3.3.16 Destination-SIP-URI + +The Destination-SIP-URI AVP is of type UTF8String. It shall contain the Public identity of the IMS UE without MSISDN which is the recipient of a short message, in the context of MSISDN-less SMS delivery in IMS (see 3GPP TS 23.204 [17]). + +#### 6.3.3.17 Maximum-Retransmission-Time + +The Maximum-Retransmission-Time is of type Time and in shall contain the maximum retransmission time (in UTC) until which the SMS-GMSC is capable to retransmit the MT Short Message. + +#### 6.3.3.18 Requested-Retransmission-Time + +The Requested-Retransmission-Time is of type Time and in shall contain the timestamp (in UTC) at which the SMS-GMSC is requested to retransmit the MT Short Message. + +#### 6.3.3.19 SMS-GMSC-Address + +The SMS-GMSC-Address AVP is of type OctetString and it shall contain the E.164 number of the SMS-GMSC or SMS Router, in international number format as described in ITU-T Recommendation E.164 [13] and encoded as a TBCD-string. See 3GPP TS 29.002 [9] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +#### 6.3.3.20 DRMP + +The DRMP AVP is of type Enumerated and it is defined in IETF RFC 7944 [19]. This AVP allows the MME, the SGSN, the SMS-IWMSC, the SMS-GMSC, the SMS Router and the IP-SM-GW to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +# --- 7 Result Codes and Experimental-Result values + +## 7.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +## 7.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in Diameter base protocol specified in IETF RFC 6733 [20] shall be applied. + +## 7.3 Permanent Failures + +### 7.3.1 General + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in Diameter base protocol specified in IETF RFC 6733 [20] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +### 7.3.2 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the MME over the SGd interface or by the SGSN over the Gdd interface to indicate that the user identified by the IMSI is unknown. + +This result code shall be sent by the SMS-IWMSC over the SGd interface to indicate that the user identified by the MSISDN is unknown. + +This result code shall be sent by the HSS or the SMS Router over the S6c interface to indicate that the user identified by the MSISDN is unknown. + +### 7.3.3 DIAMETER\_ERROR\_ABSENT\_USER (5550) + +This result code shall be sent by the MME over the SGd interface or by the SGSN over the Gdd interface to indicate that the UE is not reachable. + +This result code shall be sent by the HSS or the SMS Router over the S6c interface to indicate that the UE is not reachable. + +### 7.3.4 DIAMETER\_ERROR\_USER\_BUSY\_FOR\_MT\_SMS (5551) + +This result code shall be sent by the MME or the SGSN when the user is busy for MT SMS. + +### 7.3.5 DIAMETER\_ERROR\_FACILITY\_NOT\_SUPPORTED (5552) + +This result code shall be sent to indicate a requested facility is not supported. + +NOTE: This code corresponds to the Facility Not Supported MAP error and may be used by an IWF. + +### 7.3.6 DIAMETER\_ERROR\_ILLEGAL\_USER (5553) + +This result code shall be sent by the MME or the SGSN to indicate that the delivery of the mobile terminated short message failed because the mobile station failed authentication. + +### 7.3.7 DIAMETER\_ERROR\_ILLEGAL\_EQUIPMENT (5554) + +This result code shall be sent by the MME or the SGSN to indicate that the delivery of the mobile terminated short message failed because an IMEI check failed, i.e. the IMEI was prohibited-listed or not permitted-listed. + +### 7.3.8 DIAMETER\_ERROR\_SM\_DELIVERY\_FAILURE (5555) + +This result code shall be sent by the MME or the SGSN or the SMS-IWMSC to indicate that the delivery of the mobile terminated short message failed. + +### 7.3.9 DIAMETER\_ERROR\_SERVICE\_NOT\_SUBSCRIBED (5556) + +This result code shall be sent by the HSS or the SMS Router over the S6c interface to indicate that the MT SMS Teleservice is not part of the subscription. + +### 7.3.10 DIAMETER\_ERROR\_SERVICE\_BARRED (5557) + +This result code shall be sent by the HSS or the SMS Router over the S6c interface to indicate that the MT SMS Teleservice is barred. + +This result code shall be sent by the MME to indicate that the delivery of the mobile terminated short message failed because of the barring of the SMS service. + +### 7.3.11 DIAMETER\_ERROR\_MWD\_LIST\_FULL (5558) + +This result code shall be sent by the HSS over the S6c interface to indicate that the Message Waiting List is full. + +## 7.4 Transient Failures + +### 7.4.1 General + +Result codes that fall within the transient failures category shall be used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. The Result-Code AVP values defined in Diameter base protocol specified in IETF RFC 6733 [20] shall be applied. + +# Annex A (normative): Diameter message priority mechanism + +## A.1 General + +IETF RFC 7944 [19] specifies a Diameter routing message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may leverage the relative priority of Diameter messages into routing, resource allocation, set the DSCP marking for transport of the associated Diameter message, and also abatement decisions when overload control is applied. + +## A.2 S6c, SGd, Gdd interfaces + +The Diameter message priority mechanism is an optional feature which may apply on one or several of the S6c,SGd,Gdd interfaces. + +A 3GPP functional entity supporting the Diameter message priority mechanism over one or several of the S6c,SGd,Gdd interfaces shall comply with IETF RFC 7944 [19]. + +A 3GPP functional entity sending a request shall determine the required priority according to its policies. When priority is required, it shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the request according to the required priority level. + +When a 3GPP functional entity receives the corresponding response, it shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When a 3GPP functional entity receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, it may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, it shall include the DRMP AVP in the response. + +The decisions of the 3GPP functional entity for a required priority and for the priority level value are implementation specific. + +If: + +- a 3GPP functional entity supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the 3GPP functional entity shall set the DSCP marking for transport of the request or response according to the required priority level. + +Diameter requests related to high priority traffic shall contain a DRMP AVP with a high priority of which the level value is operator dependent. + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|----|---------|-----|----------------------|----------------| +| Date | Meeting | TDoc | CR | R
ev | Cat | Subject/Comment | New
version | +| 2012 | CT#58 | CP-120762 | | | F | TS sent for approval | | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------|--------| +| 2013-03 | CT#59 | CP-130030 | 0003 | 2 | F | Validity Time of Short Message | | +| 2013-06 | CT#60 | CP-130300 | 0001 | 2 | F | Diameter for SMS with SGSN General | | +| 2013-06 | CT#60 | CP-130300 | 0002 | 2 | F | Diameter for SMS with SGSN Complements | | +| 2013-06 | CT#60 | CP-130300 | 0004 | 1 | F | S6c complements related to Diameter for SMS with SGSN | | +| 2013-09 | CT#61 | CP-130450 | 0007 | 1 | F | Correction on Routing for MO SM | | +| 2013-0 | CT#61 | CP-130456 | 0008 | 2 | F | SGSN Diameter address with Gdd support | | +| 2013-12 | CT#62 | CP-130800 | 0009 | 3 | F | Diameter based protocols with SMS for IMS UE without MSISDN | | +| 2014-09 | CT#65 | CP-140513 | 0010 | 2 | F | Identification of the HSS | | +| 2014-12 | CT#66 | CP-140767 | 0013 | 1 | F | Corrections for some AVPs | | +| 2014-12 | CT#66 | CP-140767 | 0011 | 1 | F | SC-Address in SRR | | +| 2014-12 | CT#66 | CP-140767 | 0014 | - | F | AVP codes corrections for SMSMI | | +| 2014-12 | CT#66 | CP-140767 | 0016 | | F | OFR-Flags AVP correction | | +| 2015-12 | CT#70 | CP-150776 | 0017 | 3 | F | Mobile Terminating SMS handling for extended Idle mode DRX | 13.0.0 | +| 2015-12 | CT#70 | CP-150776 | 0018 | 1 | F | Mobile Terminating SMS handling for extended Idle mode DRX – Additional Option | | +| 2016-03 | CT#71 | CP-160030 | 0019 | - | F | Alert procedure from MME/SGSN to SMS-GMSC for MT SMS to UE using eDRX | 13.1.0 | +| 2016-03 | CT#71 | CP-160023 | 0020 | 1 | F | Diameter message priority over S6c, SGd, Gdd | | +| 2016-06 | CT#72 | CP-160226 | 0021 | - | F | Missing Requested-Retransmission-Time AVP in TFA Command | 13.2.0 | +| 2016-12 | CT#74 | CP-160664 | 0023 | | F | Correction to change IETF drmp draft version to official RFC 7944 | 13.3.0 | +| 2016-12 | CT#74 | CP-160673 | 0022 | 1 | F | MO SMS over T4 | 14.0.0 | +| 2017-03 | CT#75 | CP-170036 | 0024 | | F | SMS-MO over T4 | 14.1.0 | +| 2017-03 | CT#75 | CP-170048 | 0025 | 1 | F | Update of reference for the Diameter base protocol | 14.1.0 | +| 2017-03 | CT#75 | CP-170048 | 0026 | 1 | F | Handling of the Vendor-Specific-Application-Id AVP | 14.1.0 | +| 2017-03 | CT#75 | CP-170048 | 0027 | 1 | F | Cardinality of the Failed-AVP AVP in answer | 14.1.0 | +| 2017-06 | CT#76 | CP-171018 | 0029 | 1 | F | Support for signaling transport level packet marking | 14.2.0 | +| 2017-09 | CT#77 | CP-172013 | 0032 | - | F | Correction of DRMP Procedures | 14.3.0 | +| 2017-09 | CT#77 | CP-172022 | 0030 | 2 | F | Correction of the data type used for SC-Address and SMS-GMSC-Address | 15.0.0 | +| 2018-12 | CT#82 | CP-183100 | 0033 | 2 | F | Clarification on presence of SC-Address in SRR and on MWD Status | 15.1.0 | +| 2020-06 | CT#88e | CP-201016 | 0034 | 1 | F | SMSF Address | 15.2.0 | +| 2020-06 | CT#88e | CP-201016 | 0035 | 1 | F | Support of SMS in 5G | 15.2.0 | +| 2020-07 | - | - | - | - | - | Update to Rel-16 version (MCC) | 16.0.0 | +| 2020-09 | CT#89e | CP-202043 | 0037 | - | A | SMSF Address Corrections | 16.1.0 | +| 2021-03 | CT#91e | CP-210053 | 0039 | 1 | F | Corrections on SM-Delivery-Not-Intended | 16.2.0 | +| 2021-03 | CT#91e | CP-210027 | 0038 | - | d | Inclusive language review: EIR lists | 17.0.0 | +| 2022-06 | CT#96 | CP-221060 | 0040 | - | F | Clarification on detailed HSS behaviour for SMS | 17.1.0 | +| 2022-12 | CT#98e | CP-223038 | 0042 | 1 | B | UE Location (Cell-ID) missing over SGd (OFR & TFA) | 18.0.0 | +| 2023-06 | CT#100 | CP-231039 | 0043 | - | B | Add SBI support Indication in S6c Routing Info for SM Answer | 18.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232076 | 0050 | - | A | HSS-ID AVP type correction | 18.2.0 | +| 2023-09 | CT#101 | CP-232077 | 0058 | - | A | SM-Delivery-Failure-Cause AVP code correction | 18.2.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29380/5bba23cc120ad806779f82df1c01bebf_img.jpg b/raw/rel-18/29_series/29380/5bba23cc120ad806779f82df1c01bebf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6dbfadc80a29cec661ea2f2f43dc764534a64b4a --- /dev/null +++ b/raw/rel-18/29_series/29380/5bba23cc120ad806779f82df1c01bebf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d597d05b2b3ba171b5733be5d9b09473d455b68de48d0c893718fefdfc4d5ce7 +size 67197 diff --git a/raw/rel-18/29_series/29380/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29380/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b171aaa9ec6934460a135243237cda6cb59ef017 --- /dev/null +++ b/raw/rel-18/29_series/29380/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:41d0d38ee0e5be31aba6839839a91a287ed77adc5177db66d92d98ff323bf0e3 +size 9303 diff --git a/raw/rel-18/29_series/29380/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29380/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9a9e30b11cd7ee96d3e1589af8bbbbd4ebaad6ba --- /dev/null +++ b/raw/rel-18/29_series/29380/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fcc613883021796138aa34f50238fb939100f75ce1669593319b750497b23836 +size 5801 diff --git a/raw/rel-18/29_series/29380/6e15fc9ea763541c5913d26f85072ae1_img.jpg b/raw/rel-18/29_series/29380/6e15fc9ea763541c5913d26f85072ae1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ca7413a6d1d7d524da351cc915e00a6622f27801 --- /dev/null +++ b/raw/rel-18/29_series/29380/6e15fc9ea763541c5913d26f85072ae1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:df9dbf342a64ca9c58af6b76601be27dca265cdb7f2fa1fca86bc70b60f6a889 +size 147589 diff --git a/raw/rel-18/29_series/29380/96b0240f56d14453b5da05ec30fd5c6e_img.jpg b/raw/rel-18/29_series/29380/96b0240f56d14453b5da05ec30fd5c6e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..00ce8ed4d05cc159cfbb91a7f70069606926d67c --- /dev/null +++ b/raw/rel-18/29_series/29380/96b0240f56d14453b5da05ec30fd5c6e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85ea150696c5b24467261bb9e02539a47d3ca383a7dcd71eea3a7bce71dfb607 +size 41069 diff --git a/raw/rel-18/29_series/29380/9b1ec0090070bdf52ea28763b8d52477_img.jpg b/raw/rel-18/29_series/29380/9b1ec0090070bdf52ea28763b8d52477_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..49e9ad6231188297542474f26b4acde727939feb --- /dev/null +++ b/raw/rel-18/29_series/29380/9b1ec0090070bdf52ea28763b8d52477_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c058010bbfbccfe2889789846014fc297373793a3eb0fd3f4c8017a71289cacf +size 81283 diff --git a/raw/rel-18/29_series/29380/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg b/raw/rel-18/29_series/29380/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7e337ab4ec0cd7cfb276ccfe1fdd071023f7f871 --- /dev/null +++ b/raw/rel-18/29_series/29380/e180f2b5fcbe8001554a7c0677cd3f82_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:867f5fe25b8e7e7b0c2f0645f73557e1391210a70778c3ac0f595cefbaad8acd +size 151350 diff --git a/raw/rel-18/29_series/29380/e190b6ddb7c2e64b940749a1c5612256_img.jpg b/raw/rel-18/29_series/29380/e190b6ddb7c2e64b940749a1c5612256_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..42d3501dad58eec00d0d16ef1ddd266b85fbc3a0 --- /dev/null +++ b/raw/rel-18/29_series/29380/e190b6ddb7c2e64b940749a1c5612256_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a620a9bbf0a8a3c515b0a6eca17587c490babcd9046dd04c4969eff872927afa +size 81157 diff --git a/raw/rel-18/29_series/29413/raw.md b/raw/rel-18/29_series/29413/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d3bc8884b6cc260bd09fed08b43dc811ba7ca189 --- /dev/null +++ b/raw/rel-18/29_series/29413/raw.md @@ -0,0 +1,430 @@ + + +# 3GPP TS 29.413 V18.0.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Radio Access Network; Application of the NG Application Protocol (NGAP) to non-3GPP access (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green wave-like graphic above the 'G', and the word 'ADVANCED' in smaller black letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'P' has a red signal icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|--------------------------------------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Abbreviations ..... | 5 | +| 4 Principles for the use of NGAP for non-3GPP access ..... | 5 | +| 4.1 General ..... | 5 | +| 5 Non-3GPP access..... | 6 | +| 5.1 Use of the NGAP for non-3GPP access ..... | 6 | +| 5.2 NGAP messages used for non-3GPP access ..... | 7 | +| 5.3 Exceptions for NGAP message contents and information element coding when used for non-3GPP access..... | 8 | +| 5.4 Handling of NGAP messages not specified to be applicable between the Non-3GPP access network node and AMF..... | 13 | +| Annex A (informative): Change history ..... | 14 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document describes the applicability of NG Application Protocol (NGAP) messages and procedures, defined in 3GPP TS 38.413 [2], to non-3GPP access. A general description for non-3GPP access can be found in 3GPP TS 23.501 [3], 3GPP TS 23.502 [4], and 3GPP TS 23.316 [6]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP)". +- [3] 3GPP TS 23.501: "System Architecture for the 5G System". +- [4] 3GPP TS 23.502: "Procedures for the 5G System". +- [5] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [6] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [7] 3GPP TS 24.502: "Access to the 3GPP 5G Core Network (5GCN) via Non-3GPP Access Networks (N3AN)". + +# --- 3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|------------------------------------| +| 5G-RG | 5G Residential Gateway | +| FN-RG | Fixed Network Residential Gateway | +| N3IWF | Non-3GPP InterWorking Function | +| TNAP | Trusted Non-3GPP Access Point | +| TNGF | Trusted Non-3GPP Gateway Function | +| TWIF | Trusted WLAN Interworking Function | +| W-AGF | Wireline Access Gateway Function | + +# --- 4 Principles for the use of NGAP for non-3GPP access + +## 4.1 General + +TS 23.501 [3] specifies the NGAP used between the Non-3GPP access network node and the AMF. The Non-3GPP access network node is either a Non-3GPP InterWorking Function (N3IWF), or a Trusted Non-3GPP Gateway Function (TNGF), or a Trusted WLAN Interworking Function (TWIF), or a Wireline Access Gateway Function (W-AGF). + +NGAP is used as specified in TS 38.413 [2] with clarifications or additions as specified in Clause 5. + +# 5 Non-3GPP access + +## 5.1 Use of the NGAP for non-3GPP access + +The following NGAP procedures are used between the Non-3GPP access network node and the AMF: + +- PDU Session Management Procedures + - PDU Session Resource Setup + - PDU Session Resource Release + - PDU Session Resource Modify + - PDU Session Resource Notify +- UE Context Management Procedures + - Initial Context Setup + - UE Context Release Request + - UE Context Release + - UE Context Modification +- Transport of NAS Messages Procedures + - Initial UE Message + - Downlink NAS Transport + - Uplink NAS Transport + - NAS Non Delivery Indication + - Reroute NAS Request +- Interface Management Procedures + - NG Setup + - RAN Configuration Update + - AMF Configuration Update + - NG Reset + - Error Indication + - AMF Status Indication + - Overload Start + - Overload Stop +- UE TNLA Binding Procedures + - UE TNLA Binding Release + +For the NGAP procedures used between the Non-3GPP access network node and the AMF, the Non-3GPP access network node fulfils the behaviour of the NG-RAN node as specified in clause 8 of TS 38.413 [2], with clarifications as specified in Clause 5.3. The text in clause 8 of TS 38.413 [2] referring to Uu should be understood as referring to the Y2 reference point as specified in TS 23.501 [3]. + +## 5.2 NGAP messages used for non-3GPP access + +The list given below shows the NGAP messages, as specified in TS 38.413 [2] subclause 9.2 (tabular format) and 9.4 (ASN.1 notation) that are used between the Non-3GPP access network node and the AMF. + +- PDU SESSION RESOURCE SETUP REQUEST +- PDU SESSION RESOURCE SETUP RESPONSE +- PDU SESSION RESOURCE RELEASE COMMAND +- PDU SESSION RESOURCE RELEASE RESPONSE +- PDU SESSION RESOURCE MODIFY REQUEST +- PDU SESSION RESOURCE MODIFY RESPONSE +- PDU SESSION RESOURCE NOTIFY +- INITIAL CONTEXT SETUP REQUEST +- INITIAL CONTEXT SETUP RESPONSE +- INITIAL CONTEXT SETUP FAILURE +- UE CONTEXT RELEASE REQUEST +- UE CONTEXT RELEASE COMMAND +- UE CONTEXT RELEASE COMPLETE +- UE CONTEXT MODIFICATION REQUEST +- UE CONTEXT MODIFICATION RESPONSE +- UE CONTEXT MODIFICATION FAILURE +- INITIAL UE MESSAGE +- DOWNLINK NAS TRANSPORT +- UPLINK NAS TRANSPORT +- NAS NON DELIVERY INDICATION +- REROUTE NAS REQUEST +- NG SETUP REQUEST +- NG SETUP RESPONSE +- NG SETUP FAILURE +- RAN CONFIGURATION UPDATE +- RAN CONFIGURATION UPDATE ACKNOWLEDGE +- RAN CONFIGURATION UPDATE FAILURE +- AMF CONFIGURATION UPDATE +- AMF CONFIGURATION UPDATE ACKNOWLEDGE +- AMF CONFIGURATION UPDATE FAILURE +- NG RESET +- NG RESET ACKNOWLEDGE + +- ERROR INDICATION +- AMF STATUS INDICATION +- OVERLOAD START +- OVERLOAD STOP +- UE TNLA BINDING RELEASE REQUEST + +## 5.3 Exceptions for NGAP message contents and information element coding when used for non-3GPP access + +For the NGAP messages transferred between the Non-3GPP access network node and the AMF, the following exceptions to the specification in TS 38.413 [2] shall be applied: + +PDU SESSION RESOURCE SETUP REQUEST message: + +- the following IEs shall be ignored, when received: + - *RAN Paging Priority* IE + - *UE Aggregate Maximum Bit Rate* IE (except for non-trusted non-3GPP access, trusted non-3GPP access and trusted WLAN access as specified in TS 23.501 [3]). + - *Notification Control* IE included in the *QoS Flow Level QoS Parameters* IE + - *Alternative QoS Parameters Set List* IE included in the *QoS Flow Level QoS Parameters* IE + - *UE Slice Maximum Bit Rate List* IE + +PDU SESSION RESOURCE RELEASE COMMAND message: + +- the following IEs shall be ignored, when received: + - *RAN Paging Priority* IE + +PDU SESSION RESOURCE MODIFY REQUEST message: + +- the following IEs shall be ignored, when received: + - *RAN Paging Priority* IE + - *Notification Control* IE included in the *QoS Flow Level QoS Parameters* IE + - *Alternative QoS Parameters Set List* IE included in the *QoS Flow Level QoS Parameters* IE + +INITIAL CONTEXT SETUP REQUEST message: + +- the following IEs shall be ignored, when received: + - *Core Network Assistance Information for RRC INACTIVE* IE + - *Trace Activation* IE + - *Mobility Restriction List* IE + - *UE Radio Capability* IE + - *Index to RAT/Frequency Selection Priority* IE + - *Emergency Fallback Indicator* IE + - *RRC Inactive Transition Report Request* IE + - *UE Radio Capability for Paging* IE + +- *Redirection for Voice EPS Fallback IE* +- *Location Reporting Request Type IE* +- *CN Assisted RAN Parameters Tuning IE* +- *SRVCC Operation Possible IE* +- *IAB Authorized IE* +- *Enhanced Coverage Restriction IE* +- *Extended Connected Time IE* +- *UE Differentiation Information IE* +- *NR V2X Services Authorized IE* +- *LTE V2X Services Authorized IE* +- *NR UE Sidelink Aggregate Maximum Bit Rate IE* +- *LTE UE Sidelink Aggregate Maximum Bit Rate IE* +- *PC5 QoS Parameters IE* +- *CE-mode-B Restricted IE* +- *UE User Plane CIoT Support Indicator IE* +- *Management Based MDT PLMN List IE* +- *UE Radio Capability ID IE* +- *UE Aggregate Maximum Bit Rate IE* (except for non-trusted non-3GPP access, trusted non-3GPP access and trusted WLAN access as specified in TS 23.501 [3]) +- *UE Security Capabilities IE* +- *Time Synchronisation Assistance Information IE* +- *QMC Configuration Information IE* +- *Target NSSAI Information IE* +- *UE Slice Maximum Bit Rate List IE* +- *5G ProSe Authorized IE* +- *5G ProSe UE PC5 Aggregate Maximum Bit Rate IE* +- *5G ProSe PC5 QoS Parameters IE- RG Level Wireline Access Characteristics IE*: the information given within this IE between the W-AGF and the AMF shall be stored in the UE context by the W-AGF as specified in TS 23.316 [6]. +- *Notification Control IE* included in the *QoS Flow Level QoS Parameters IE* +- *Alternative QoS Parameters Set List IE* included in the *QoS Flow Level QoS Parameters IE* + +UE CONTEXT RELEASE COMPLETE message: + +- the following IEs shall be ignored, when received: + - *Information on Recommended Cells and RAN Nodes for Paging IE* + - *Paging Assistance Data for CE Capable UE IE* + +UE CONTEXT MODIFICATION REQUEST message: + +- the following IEs shall be ignored, when received: + - *RAN Paging Priority IE* + - *Index to RAT/Frequency Selection Priority IE* + - *Core Network Assistance Information IE* + - *Emergency Fallback Indicator IE* + - *RRC Inactive Transition Report Request IE* + - *CN Assisted RAN Parameters Tuning IE* + - *SRVCC Operation Possible IE* + - *IAB Authorized IE* + - *NR V2X Services Authorized IE* + - *LTE V2X Services Authorized IE* + - *NR UE Sidelink Aggregate Maximum Bit Rate IE* + - *LTE UE Sidelink Aggregate Maximum Bit Rate IE* + - *PC5 QoS Parameters IE* + - *UE Radio Capability ID IE* + - *UE Aggregate Maximum Bit Rate IE* (except for non-trusted non-3GPP access, trusted non-3GPP access and trusted WLAN access as specified in TS 23.501 [3]) + - *UE Security Capabilities IE* + - *Time Synchronisation Assistance Information IE* + - *QMC Configuration Information IE* + - *QMC Deactivation IE* + - *UE Slice Maximum Bit Rate List IE* + - *Management Based MDT PLMN Modification List IE* + - *5G ProSe Authorized IE* + - *5G ProSe UE PC5 Aggregate Maximum Bit Rate IE* + - *5G ProSe PC5 QoS Parameters IE* +- if this is the first message received from a new AMF, the N3IWF shall identify the old AMF and the UE using the received *RAN UE NGAP ID*, release the UE-associated logical NG-connection to the old AMF and create a new UE-associated logical NG-connection to the new AMF. +- *RG Level Wireline Access Characteristics IE*: the information given within this IE between the W-AGF and the AMF shall be stored in the UE context by the W-AGF as specified in TS 23.316 [6]. + +UE CONTEXT MODIFICATION RESPONSE message: + +- the following IEs shall be ignored, when received: + - *RRC State IE* + +INITIAL UE MESSAGE message: + +- the following IEs shall be ignored, when received: + - *IAB Node Indication IE* + +- *CE-mode-B Support Indicator IE* +- *LTE-M Indication IE* +- *EDT Session IE* +- *NPN Access Information IE* +- *RedCap Indication IE* +- *RRC Establishment Cause IE*: the information given within this IE is to indicate the Establishment cause for non-3GPP access as specified in TS 24.502 [7]. +- *Selected PLMN Identity IE*: the information given within this IE provides the selected PLMN ID for untrusted non-3GPP access as specified in TS 23.502 [4]. +- *Authenticated Indication IE*: the information given within this IE between the W-AGF and the AMF is to indicate that the FN-RG has been authenticated by the wireline 5G access network as specified in TS 23.316 [6]. +- *Selected PLMN Identity IE*: the information given within this IE contains the PLMN Identity for wireline access as specified in TS 23.316 [6], or for trusted non-3GPP access as specified in TS 23.502 [4]. +- *Selected NID IE*: the information given within this IE contains the NID which, together with the *Selected PLMN Identity IE*, indicates the SNPN identity for wireline access as specified in TS 23.316 [6], or for trusted/untrusted non-3GPP access as specified in TS 23.502 [4]. + +### DOWNLINK NAS TRANSPORT message: + +- the following IEs shall be ignored, when received: + - *RAN Paging Priority IE* + - *Mobility Restriction List IE* + - *Index to RAT/Frequency Selection Priority IE* + - *SRVCC Operation Possible IE* + - *Enhanced Coverage Restriction IE* + - *Extended Connected Time IE* + - *UE Differentiation Information IE* + - *CE-mode-B Restricted IE* + - *UE Radio Capability IE* + - *UE Capability Info Request IE* + - *End Indication IE* + - *UE Radio Capability ID IE* + - *UE Aggregate Maximum Bit Rate IE* (except for non-trusted non-3GPP access, trusted non-3GPP access and trusted WLAN access as specified in TS 23.501 [3]) + - *Target NSSAI Information IE* + +### UPLINK NAS TRANSPORT message: + +- *TNGF Identity Information IE*: the information given within this IE between the TNGF and the AMF contains a list of identifiers of NG-U terminations at TNGF as specified in TS 23.502 [4]. +- *TWIF Identity Information IE*: the information given within this IE between the TWIF and the AMF contains a list of identifiers of NG-U terminations at TWIF as specified in TS 23.502 [4]. + +- *W-AGF Identity Information* IE: the information given within this IE between the W-AGF and the AMF contains a list of identifiers of NG-U terminations at W-AGF as specified in TS 23.316 [6]. + +NG SETUP REQUEST message: + +- the following IEs shall be ignored, when received: + - *Default Paging DRX* IE + - *NB-IoT Default Paging DRX* IE + +NG SETUP RESPONSE message: + +- the following IEs shall be ignored, when received: + - *IAB Supported* IE + +RAN CONFIGURATION UPDATE message: + +- the following IEs shall be ignored, when received: + - *Default Paging DRX* IE + - *NB-IoT Default Paging DRX* IE + +OVERLOAD START message: + +- *AMF Overload Response* IE: if the *Overload Action* IE is included, the contained information is used to identify the related signalling traffic corresponding to the Establishment cause for non-3GPP access as specified in TS 24.502 [7]. +- *Slice Overload Response* IE: if the *Overload Action* IE is included, the contained information is used to identify the related signalling traffic corresponding to the Establishment cause for non-3GPP access as specified in TS 24.502 [7]. + +The *Global RAN Node ID* IE in the applicable NGAP messages includes the following IEs as specified in TS 38.413 [2]: + +- *Global N3IWF ID* IE for the untrusted non-3GPP access. +- *Global TNGF ID* IE for the trusted non-3GPP access. +- *Global TWIF ID* IE for the trusted WLAN access. +- *Global W-AGF ID* IE for the wireline 5G access. + +The *User Location Information* IE in the applicable NGAP messages includes the following IEs as specified in TS 38.413 [2]: + +- *N3IWF User Location Information* IE for the untrusted non-3GPP access. +- *TNGF User Location Information* IE for the trusted non-3GPP access. +- *TWIF User Location Information* IE for the trusted WLAN access. +- *W-AGF User Location Information* IE for the wireline 5G access. + +The *Security Key* IE in the applicable NGAP messages includes the $K_{N3IWF}$ , or the $K_{TNGF}$ , or the $K_{TWIF}$ , or the $K_{WAGF}$ as specified in TS 33.501 [5]. + +The *RAN UE NGAP ID* IE in the applicable NGAP messages identifies the UE association over the NG interface within the N3IWF node, or the TNGF node, or the TWIF node, or the W-AGF node, as specified in TS 38.413 [2]. + +## 5.4 Handling of NGAP messages not specified to be applicable between the Non-3GPP access network node and AMF + +If the Non-3GPP access network node or the AMF receive an NGAP message not listed in section 5.2 as being applicable between the Non-3GPP access network node and AMF, the receiving node shall act according to the criticality defined for the elementary procedure and ignore the message or discard the message and send an ERROR INDICATION message indicating that the procedure is not supported, as specified in in TS 38.413 [2]. + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|-----------|------|-----|-----|---------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-04 | R3#99bis | R3-181817 | - | - | - | TS skeleton | 0.0.1 | +| 2018-04 | R3#99bis | R3-182522 | - | - | - | covering agreements of RAN3#99Bis | 0.1.0 | +| 2018-05 | RAN#100 | R3-183589 | - | - | - | covering agreements of RAN3#100 | 0.2.0 | +| 2018-06 | RAN#80 | RP-180755 | - | - | - | For approval | 1.0.0 | +| 2018-06 | RAN#80 | | - | - | - | Specification approved at TSG-RAN and placed under change control | 15.0.0 | +| 2018-12 | RP-82 | RP-182447 | 0001 | - | F | Add the UE TNLA Binding release and overload control procedures | 15.1.0 | +| 2019-07 | RP-84 | RP-191394 | 0002 | 1 | F | N2 AMF mobility | 15.2.0 | +| 2019-09 | RP-85 | RP-192166 | 0004 | 1 | F | Correction of N3IWF key | 15.3.0 | +| 2020-07 | RP-88-e | RP-201092 | 0005 | - | F | Selected PLMN ID for untrusted non-3GPP access | 15.4.0 | +| 2020-07 | RP-88-e | RP-201081 | 0003 | 11 | B | CR for introducing WWC in RAN | 16.0.0 | +| 2020-09 | RP-89-e | RP-201954 | 0007 | 1 | A | Update the list of IEs that is not applicable to non-3GPP access | 16.1.0 | +| 2020-12 | RP-90-e | RP-202310 | 0008 | 1 | F | Add the support for updating RG Level Wireline Access Characteristics | 16.2.0 | +| 2020-12 | RP-90-e | RP-202313 | 0010 | 1 | F | Handling OVERLOAD START message in the N3IWF | 16.2.0 | +| 2021-09 | RP-93-e | RP-211872 | 0011 | 1 | F | Ignoring the notification control for WWC | 16.3.0 | +| 2022-03 | SA#95-e | | | | | Promotion to Release 17 without technical change | 17.0.0 | +| 2022-06 | RAN#96 | RP-221150 | 0013 | | A | Clarify the UE Security Capabilities IE not applicable to non-3GPP access | 17.1.0 | +| 2022-09 | RAN#97-e | RP-222201 | 0014 | 1 | F | Update for Rel-17 NGAP IEs not applicable to non-3GPP access | 17.2.0 | +| 2023-03 | RAN#99 | RP-230593 | 0015 | - | F | Correction of ULI for non-3GPP access | 17.3.0 | +| 2023-12 | RAN#102 | RP-233840 | 0017 | 6 | B | Support of the enhanced NPN phase 2 | 18.0.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29501/00504fc688ebcf131ccbeff94dfc9939_img.jpg b/raw/rel-18/29_series/29501/00504fc688ebcf131ccbeff94dfc9939_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec179517311e4306d45067a80afcc7c97b6c31fb --- /dev/null +++ b/raw/rel-18/29_series/29501/00504fc688ebcf131ccbeff94dfc9939_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:76bdb7aaff329eae8a34ff58ec7908dd579fa128b4dd89a3122ec5556aa57a3c +size 25966 diff --git a/raw/rel-18/29_series/29501/17a1ba23b641c01871b08f0a4f08ef48_img.jpg b/raw/rel-18/29_series/29501/17a1ba23b641c01871b08f0a4f08ef48_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4fe1d4e864b50988044edc1a01b90eb8d4ca7d78 --- /dev/null +++ b/raw/rel-18/29_series/29501/17a1ba23b641c01871b08f0a4f08ef48_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:959b0278e6a35dd67b0320b499f2b444e5590de1ae82926455e12a1580defc25 +size 33676 diff --git a/raw/rel-18/29_series/29501/329c96049bb432e9c2cbda4e224a0c9c_img.jpg b/raw/rel-18/29_series/29501/329c96049bb432e9c2cbda4e224a0c9c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..53cb26bc6f55972ad0886101b5a759ec242564a3 --- /dev/null +++ b/raw/rel-18/29_series/29501/329c96049bb432e9c2cbda4e224a0c9c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0c76ab18934db766de8bcfcbef158bf94b9cd75a4197677eeec9521ab2b45b51 +size 177580 diff --git a/raw/rel-18/29_series/29501/37819f1170c36655c57129b6bd8a5ceb_img.jpg b/raw/rel-18/29_series/29501/37819f1170c36655c57129b6bd8a5ceb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cfacb4354a278ff05bb1e47be9ac15f145dfced0 --- /dev/null +++ b/raw/rel-18/29_series/29501/37819f1170c36655c57129b6bd8a5ceb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5c793587ffcba835c58c8a2b34a43e807e3714d578db8cef8b775f9496cc233e +size 30561 diff --git a/raw/rel-18/29_series/29501/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg b/raw/rel-18/29_series/29501/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4b8cdbede719a2c08af7a8c80615f2b52b69a51e --- /dev/null +++ b/raw/rel-18/29_series/29501/4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a36aab109e941769daad30806b1f7e512499054420ab2f190d5da0e828abd465 +size 80232 diff --git a/raw/rel-18/29_series/29501/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29501/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7ab2fc622ecbfd56d783e234c4854811bb3611f2 --- /dev/null +++ b/raw/rel-18/29_series/29501/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:da1befd0b963248f701ce3d2d93437fd7e02ee2a3e806d9b64b73fd244e44ee1 +size 9918 diff --git a/raw/rel-18/29_series/29501/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29501/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6afa44e2c47875e5da44542c898c22bcdff166b6 --- /dev/null +++ b/raw/rel-18/29_series/29501/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:69579bf38f4c3d65131528646668bdcb14eac57ae7230dcb7e5512ced5054bb9 +size 5710 diff --git a/raw/rel-18/29_series/29501/84e5b251aa38db522f76f5cc3afcb853_img.jpg b/raw/rel-18/29_series/29501/84e5b251aa38db522f76f5cc3afcb853_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5846f7e503c48977e26ce96a1f4819dbb3afcf82 --- /dev/null +++ b/raw/rel-18/29_series/29501/84e5b251aa38db522f76f5cc3afcb853_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6b1a528eaa593dd47b12bdc63656193bc3f8e15d5b60486107b45dd12d45cc44 +size 30745 diff --git a/raw/rel-18/29_series/29501/90ddb84c323b956e2d50a54d3f870566_img.jpg b/raw/rel-18/29_series/29501/90ddb84c323b956e2d50a54d3f870566_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..822ac733e26ac8607f9d2d5b949091b3cb81b981 --- /dev/null +++ b/raw/rel-18/29_series/29501/90ddb84c323b956e2d50a54d3f870566_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cbc8b3ec821b8f7f704dd43aa080ddd5514c239c67ab45a36bd3f0fed44ac82d +size 43052 diff --git a/raw/rel-18/29_series/29501/90ddf538ef276510e2b631f7b96654e6_img.jpg b/raw/rel-18/29_series/29501/90ddf538ef276510e2b631f7b96654e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f73e9dfd3726c29e86f49b739a5a250bef920f24 --- /dev/null +++ b/raw/rel-18/29_series/29501/90ddf538ef276510e2b631f7b96654e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fd399922fdb6981c049c0c616587e5cf9571e5224f428c09f3f3cee51c8970e7 +size 27349 diff --git a/raw/rel-18/29_series/29501/9b686adccf125267a013fa25721231a3_img.jpg b/raw/rel-18/29_series/29501/9b686adccf125267a013fa25721231a3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..94f13c839656b606f6220fd75e0ac8eda79e0bc5 --- /dev/null +++ b/raw/rel-18/29_series/29501/9b686adccf125267a013fa25721231a3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:233547c4c4180d4a1fcc2b240c9e46fa2e5dd4f598dcca5b0b581f50a7073006 +size 40553 diff --git a/raw/rel-18/29_series/29501/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg b/raw/rel-18/29_series/29501/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..163fd7a633b84c8d7bedc17eff93dd32b15fc412 --- /dev/null +++ b/raw/rel-18/29_series/29501/ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4d1ade5c22c917aa6a5dd8a38d69d28670eb5c7b587b64c7515b2659796d6945 +size 29606 diff --git a/raw/rel-18/29_series/29501/bed6d614aeb513fab7c7299bff6c0523_img.jpg b/raw/rel-18/29_series/29501/bed6d614aeb513fab7c7299bff6c0523_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..510071ff4b785157831e7086f8432df6fb8c86e4 --- /dev/null +++ b/raw/rel-18/29_series/29501/bed6d614aeb513fab7c7299bff6c0523_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:12f59d7333d1dec929610d5452d6258199335d7a4d2c8fe3056e098c0d756b35 +size 31506 diff --git a/raw/rel-18/29_series/29501/c0e369274e53b2e5364666be6f786c7a_img.jpg b/raw/rel-18/29_series/29501/c0e369274e53b2e5364666be6f786c7a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a018ca48aed7c5c715aa0b7b18af78236847c7c4 --- /dev/null +++ b/raw/rel-18/29_series/29501/c0e369274e53b2e5364666be6f786c7a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d47efd9557677dc6d7b32fd81a7e6e187307afca01b0d2c39fa05f41470c63b4 +size 29566 diff --git a/raw/rel-18/29_series/29501/ca5dc5fde2061d0ca2051ef7840fc842_img.jpg b/raw/rel-18/29_series/29501/ca5dc5fde2061d0ca2051ef7840fc842_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..55d56425a0a316c607ba6eb61569a19a5d0edc82 --- /dev/null +++ b/raw/rel-18/29_series/29501/ca5dc5fde2061d0ca2051ef7840fc842_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:22352791f2e7d82ca3085f3d166de27d587d297f273995b8cc169b2962f923e9 +size 41212 diff --git a/raw/rel-18/29_series/29501/d3b5eac55166fc428a223bba5c46961b_img.jpg b/raw/rel-18/29_series/29501/d3b5eac55166fc428a223bba5c46961b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..08e5c8b473589f14ee411653382129971ce3672e --- /dev/null +++ b/raw/rel-18/29_series/29501/d3b5eac55166fc428a223bba5c46961b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d4bff54e424c2b7b81c99df3fe1d054eedfae787524a4dd96e7a4223d2b5541 +size 24435 diff --git a/raw/rel-18/29_series/29501/d5918cee231b536f20789a18d861fae3_img.jpg b/raw/rel-18/29_series/29501/d5918cee231b536f20789a18d861fae3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2084d47455014711227663164aabd8d57a2b6d7a --- /dev/null +++ b/raw/rel-18/29_series/29501/d5918cee231b536f20789a18d861fae3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bc73de04b858f5ad1c240fd3bc6b2abf3cca3f13cb89bcd3d7c6c4a8850a9a4c +size 30889 diff --git a/raw/rel-18/29_series/29501/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/raw/rel-18/29_series/29501/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e8b626afe82426504ec12910b7625c214bd71fc4 --- /dev/null +++ b/raw/rel-18/29_series/29501/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0dab8faa340c55001c0a664fa6f4c75598f6760c50abf6d2c85107ee61e04e6e +size 29462 diff --git a/raw/rel-18/29_series/29502/raw.md b/raw/rel-18/29_series/29502/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..f622c9ab0c3b354563e056c83df495971ed0df76 --- /dev/null +++ b/raw/rel-18/29_series/29502/raw.md @@ -0,0 +1,14342 @@ + + +# 3GPP TS 29.502 V18.5.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Session Management Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the letters is a red signal wave icon, and below that, the text 'A GLOBAL INITIATIVE' in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword..... | 10 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions and abbreviations..... | 13 | +| 3.1 Definitions..... | 13 | +| 3.2 Abbreviations..... | 13 | +| 4 Overview..... | 14 | +| 4.1 Introduction..... | 14 | +| 5 Services offered by the SMF..... | 14 | +| 5.1 Introduction..... | 14 | +| 5.2 Nsmf_PDUSession Service..... | 15 | +| 5.2.1 Service Description..... | 15 | +| 5.2.2 Service Operations..... | 16 | +| 5.2.2.1 Introduction..... | 16 | +| 5.2.2.2 Create SM Context service operation..... | 17 | +| 5.2.2.2.1 General..... | 17 | +| 5.2.2.2.2 EPS to 5GS Idle mode mobility using N26 interface (with or without data forwarding)..... | 21 | +| 5.2.2.2.3 EPS to 5GS Handover Preparation using N26 interface..... | 23 | +| 5.2.2.2.4 I-SMF Insertion, Change or Removal during Xn based Handover..... | 24 | +| 5.2.2.2.5 I-SMF Insertion, Change or Removal during N2 based Handover..... | 24 | +| 5.2.2.2.6 Service Request with I-SMF insertion/change/removal or with V-SMF change..... | 25 | +| 5.2.2.2.7 Registration procedure for a UE with a PDU session with I-SMF or V-SMF insertion, change and removal..... | 26 | +| 5.2.2.2.8 SMF Context Transfer procedure, LBO or no Roaming, no I-SMF..... | 27 | +| 5.2.2.2.9 I-SMF Context Transfer procedure..... | 27 | +| 5.2.2.2.10 Handover between 3GPP and non-3GPP accesses with I-SMF insertion/removal or V-SMF change..... | 27 | +| 5.2.2.2.11 Void..... | 28 | +| 5.2.2.2.12 SMF triggered I-SMF selection/removal or V-SMF selection..... | 28 | +| 5.2.2.3 Update SM Context service operation..... | 29 | +| 5.2.2.3.1 General..... | 29 | +| 5.2.2.3.2 Activation and Deactivation of the User Plane connection of a PDU session..... | 31 | +| 5.2.2.3.2.1 General..... | 31 | +| 5.2.2.3.2.2 Activation of User Plane connectivity of a PDU session..... | 32 | +| 5.2.2.3.2.3 Deactivation of User Plane connectivity of a PDU session..... | 34 | +| 5.2.2.3.2.4 Changing the access type of a PDU session from non-3GPP access to 3GPP access during a Service Request procedure..... | 34 | +| 5.2.2.3.3 Xn Handover..... | 35 | +| 5.2.2.3.4 N2 Handover..... | 37 | +| 5.2.2.3.4.1 General..... | 37 | +| 5.2.2.3.4.2 N2 Handover Preparation..... | 37 | +| 5.2.2.3.4.3 N2 Handover Execution..... | 39 | +| 5.2.2.3.4.4 N2 Handover Cancellation..... | 40 | +| 5.2.2.3.5 Handover between 3GPP and untrusted non-3GPP access procedures..... | 40 | +| 5.2.2.3.5.1 General..... | 40 | +| 5.2.2.3.5.2 Handover of a PDU session without AMF change or with target AMF in same PLMN..... | 40 | +| 5.2.2.3.6 Inter-AMF change or mobility..... | 41 | +| 5.2.2.3.7 RAN Initiated QoS Flow Mobility..... | 42 | +| 5.2.2.3.8 EPS to 5GS Handover using N26 interface..... | 42 | +| 5.2.2.3.8.1 General..... | 42 | +| 5.2.2.3.8.2 EPS to 5GS Handover Preparation..... | 42 | +| 5.2.2.3.8.3 EPS to 5GS Handover Execution..... | 43 | +| 5.2.2.3.8.4 EPS to 5GS Handover Cancellation..... | 43 | +| 5.2.2.3.8.5 EPS to 5GS Handover Failure..... | 44 | +| 5.2.2.3.9 5GS to EPS Handover using N26 interface..... | 44 | + +| | | | +|--------------|--------------------------------------------------------------------------------------------------------------------------------------|----| +| 5.2.2.3.9.1 | General..... | 44 | +| 5.2.2.3.9.2 | Data forwarding tunnels setup during 5GS to EPS handover..... | 44 | +| 5.2.2.3.9.3 | Indirect data forwarding tunnels removal for 5GS to EPS handover cancellation or failure.... | 45 | +| 5.2.2.3.10 | P-CSCF Restoration Procedure via AMF..... | 45 | +| 5.2.2.3.11 | AMF requested PDU Session Release due to duplicated PDU Session Id..... | 45 | +| 5.2.2.3.12 | AMF requested PDU Session Release due to slice not available..... | 46 | +| 5.2.2.3.13 | Indirect Data Forwarding Tunnel establishment during N2 based Handover with I-SMF..... | 46 | +| 5.2.2.3.13A | Indirect Data Forwarding Tunnel removal during N2 based Handover with I-SMF..... | 47 | +| 5.2.2.3.14 | Request to forward buffered downlink data packets at I-UPF..... | 48 | +| 5.2.2.3.15 | Connection Suspend procedure..... | 48 | +| 5.2.2.3.16 | Connection Resume in CM-IDLE with Suspend procedure..... | 49 | +| 5.2.2.3.17 | AMF requested PDU Session Release due to Network Slice-Specific Authentication and Authorization failure or revocation..... | 50 | +| 5.2.2.3.18 | 5GS to EPS Idle mode mobility using N26 interface with data forwarding..... | 50 | +| 5.2.2.3.19 | AMF requested PDU Session Release due to Control Plane Only indication associated with PDU Session is not applicable any longer..... | 50 | +| 5.2.2.3.20 | AMF requested PDU Session Release due to ODB changes..... | 50 | +| 5.2.2.3.21 | N9 Forwarding Tunnel establishment between Branching Points or UL CLs controlled by different I-SMFs..... | 51 | +| 5.2.2.3.22 | Remote UE Report during 5G ProSe Communication via 5G ProSe Layer-3 UE-to-Network Relay without N3IWF procedure..... | 51 | +| 5.2.2.3.23 | AMF requested PDU Session Release due to V/I-SMF failure..... | 52 | +| 5.2.2.3.24 | Connection Inactive procedure with CN based MT communication handling..... | 52 | +| 5.2.2.3.25 | UE Triggered Connection Resume in RRC Inactive procedure..... | 53 | +| 5.2.2.3.26 | AMF requested PDU Session Release due to Network Slice instance not available..... | 54 | +| 5.2.2.3.27 | AMF requested PDU Session Release due to MBSR not authorized..... | 54 | +| 5.2.2.4 | Release SM Context service operation..... | 54 | +| 5.2.2.4.1 | General..... | 54 | +| 5.2.2.5 | Notify SM Context Status service operation..... | 56 | +| 5.2.2.5.1 | General..... | 56 | +| 5.2.2.6 | Retrieve SM Context service operation..... | 60 | +| 5.2.2.6.1 | General..... | 60 | +| 5.2.2.7 | Create service operation..... | 62 | +| 5.2.2.7.1 | General..... | 62 | +| 5.2.2.7.2 | EPS to 5GS Idle mode mobility..... | 66 | +| 5.2.2.7.3 | EPS to 5GS Handover Preparation..... | 67 | +| 5.2.2.7.4 | N2 Handover Preparation with I-SMF Insertion..... | 68 | +| 5.2.2.7.5 | Xn Handover with I-SMF Insertion..... | 68 | +| 5.2.2.7.6 | UE Triggered Service Request with I-SMF Insertion..... | 68 | +| 5.2.2.8 | Update service operation..... | 69 | +| 5.2.2.8.1 | General..... | 69 | +| 5.2.2.8.2 | Update service operation towards H-SMF or SMF..... | 70 | +| 5.2.2.8.2.1 | General..... | 70 | +| 5.2.2.8.2.2 | UE or network (e.g. AMF, V-SMF, I-SMF) requested PDU session modification..... | 72 | +| 5.2.2.8.2.3 | UE requested PDU session release..... | 72 | +| 5.2.2.8.2.4 | EPS to 5GS Handover Execution..... | 72 | +| 5.2.2.8.2.5 | Handover between 3GPP access and untrusted or trusted non-3GPP access..... | 73 | +| 5.2.2.8.2.6 | P-CSCF Restoration Procedure via AMF..... | 74 | +| 5.2.2.8.2.7 | Addition of PSA and BP or UL CL controlled by I-SMF..... | 74 | +| 5.2.2.8.2.8 | Removal of PSA and BP or UL CL controlled by I-SMF..... | 74 | +| 5.2.2.8.2.9 | Change of PSA for IPv6 multi-homing or UL CL controlled by I-SMF..... | 75 | +| 5.2.2.8.2.10 | PDU Session modification with I-SMF or V-SMF change..... | 75 | +| 5.2.2.8.2.11 | Sending by I-SMF of N4 notifications related with traffic usage reporting..... | 76 | +| 5.2.2.8.2.12 | N2 Handover Execution with I-SMF Insertion..... | 76 | +| 5.2.2.8.2.13 | N2 Handover Cancellation with I-SMF Insertion..... | 77 | +| 5.2.2.8.2.14 | EPS to 5GS Handover Cancellation..... | 77 | +| 5.2.2.8.2.15 | 5G-AN requested PDU session resource release..... | 77 | +| 5.2.2.8.2.16 | Xn Handover with or without I-SMF or V-SMF Change..... | 78 | +| 5.2.2.8.2.17 | EPS to 5GS Handover Failure..... | 78 | +| 5.2.2.8.2.18 | EPS Bearer ID revocation..... | 78 | +| 5.2.2.8.2.19 | Network requested PDU session release..... | 79 | + +| | | | +|--------------|------------------------------------------------------------------------------------------------------------|-----| +| 5.2.2.8.2.20 | N2 Handover Execution with or without I-SMF or V-SMF Change..... | 79 | +| 5.2.2.8.2.21 | Reporting of satellite backhaul change to (H-)SMF..... | 79 | +| 5.2.2.8.2.22 | Simultaneous change of PSA and BP or UL CL controlled by I-SMF..... | 79 | +| 5.2.2.8.2.23 | Service Request without I-SMF/V-SMF Change or with I-SMF/V-SMF Change or with I-SMF Insertion..... | 80 | +| 5.2.2.8.2.24 | Remote UE Report during 5G ProSe Communication via 5G ProSe Layer-3 UE-to-Network Relay without N3IWF..... | 81 | +| 5.2.2.8.3 | Update service operation towards V-SMF or I-SMF..... | 82 | +| 5.2.2.8.3.1 | General..... | 82 | +| 5.2.2.8.3.2 | Network (e.g. H-SMF, SMF) requested PDU session modification..... | 83 | +| 5.2.2.8.3.3 | Network (e.g. H-SMF, SMF) or UE requested PDU session release..... | 84 | +| 5.2.2.8.3.4 | Handover between 3GPP and untrusted non-3GPP access, from 5GC-N3IWF to EPS or from 5GS to EPC/ePDG..... | 84 | +| 5.2.2.8.3.5 | EPS Bearer ID assignment..... | 85 | +| 5.2.2.8.3.6 | Addition of PSA and BP or UL CL controlled by I-SMF..... | 85 | +| 5.2.2.8.3.7 | Removal of PSA and BP or UL CL controlled by I-SMF..... | 86 | +| 5.2.2.8.3.8 | Change of PSA for IPv6 multi-homing or UL CL controlled by I-SMF..... | 86 | +| 5.2.2.8.3.9 | Policy update procedures with an I-SMF..... | 87 | +| 5.2.2.8.3.10 | Simultaneous change of PSA and BP or UL CL controlled by I-SMF..... | 87 | +| 5.2.2.8.3.11 | Network (e.g. AMF) triggered network slice replacement with PDU session retained..... | 88 | +| 5.2.2.9 | Release service operation..... | 88 | +| 5.2.2.9.1 | General..... | 88 | +| 5.2.2.10 | Notify Status service operation..... | 90 | +| 5.2.2.10.1 | General..... | 90 | +| 5.2.2.11 | Send MO Data service operation..... | 91 | +| 5.2.2.11.1 | General..... | 91 | +| 5.2.2.12 | Transfer MO Data service operation..... | 92 | +| 5.2.2.12.1 | General..... | 92 | +| 5.2.2.13 | Transfer MT Data service operation..... | 93 | +| 5.2.2.13.1 | General..... | 93 | +| 5.2.2.14 | Retrieve service operation..... | 94 | +| 5.2.2.14.1 | General..... | 94 | +| 5.2.3 | General procedures..... | 95 | +| 5.2.3.1 | Transfer of NAS SM information between UE and H-SMF for Home Routed PDU sessions..... | 95 | +| 5.2.3.1.1 | General..... | 95 | +| 5.2.3.1.2 | V-SMF Behaviour..... | 95 | +| 5.2.3.1.3 | H-SMF Behaviour..... | 95 | +| 5.2.3.2 | Transfer of NAS SM information between UE and SMF for PDU sessions with an I-SMF..... | 96 | +| 5.2.3.2.1 | General..... | 96 | +| 5.2.3.3 | Detection and handling of late arriving requests..... | 96 | +| 5.2.3.3.1 | Handling of requests which collide with an existing SM context or PDU session context..... | 96 | +| 5.2.3.3.1.1 | General..... | 96 | +| 5.2.3.3.1.2 | Principles..... | 96 | +| 5.2.3.3.2 | Detection and handling of requests which have timed out at the HTTP client..... | 96 | +| 5.2.3.3.2.1 | General..... | 96 | +| 5.2.3.4 | UE Location Information..... | 97 | +| 6 | API Definitions..... | 97 | +| 6.1 | Nsmf_PDUSession Service API..... | 97 | +| 6.1.1 | API URI..... | 97 | +| 6.1.2 | Usage of HTTP..... | 98 | +| 6.1.2.1 | General..... | 98 | +| 6.1.2.2 | HTTP standard headers..... | 98 | +| 6.1.2.2.1 | General..... | 98 | +| 6.1.2.2.2 | Content type..... | 98 | +| 6.1.2.3 | HTTP custom headers..... | 98 | +| 6.1.2.3.1 | General..... | 98 | +| 6.1.2.3.2 | 3gpp-Sbi-Originating-Timestamp..... | 99 | +| 6.1.2.4 | HTTP multipart messages..... | 99 | +| 6.1.2.5 | HTTP/2 request retries..... | 99 | +| 6.1.3 | Resources..... | 100 | +| 6.1.3.1 | Overview..... | 100 | + +| | | | +|---------------|--------------------------------------------------------|-----| +| 6.1.3.2 | Resource: SM contexts collection..... | 102 | +| 6.1.3.2.1 | Description..... | 102 | +| 6.1.3.2.2 | Resource Definition..... | 102 | +| 6.1.3.2.3 | Resource Standard Methods..... | 103 | +| 6.1.3.2.3.1 | POST..... | 103 | +| 6.1.3.2.4 | Resource Custom Operations..... | 106 | +| 6.1.3.3 | Resource: Individual SM context..... | 106 | +| 6.1.3.3.1 | Description..... | 106 | +| 6.1.3.3.2 | Resource Definition..... | 107 | +| 6.1.3.3.3 | Resource Standard Methods..... | 107 | +| 6.1.3.3.4 | Resource Custom Operations..... | 107 | +| 6.1.3.3.4.1 | Overview..... | 107 | +| 6.1.3.3.4.2 | Operation: modify..... | 107 | +| 6.1.3.3.4.2.1 | Description..... | 107 | +| 6.1.3.3.4.2.2 | Operation Definition..... | 107 | +| 6.1.3.3.4.3 | Operation: release..... | 110 | +| 6.1.3.3.4.3.1 | Description..... | 110 | +| 6.1.3.3.4.3.2 | Operation Definition..... | 110 | +| 6.1.3.3.4.4 | Operation: retrieve..... | 111 | +| 6.1.3.3.4.4.1 | Description..... | 111 | +| 6.1.3.3.4.4.2 | Operation Definition..... | 111 | +| 6.1.3.3.4.5 | Operation: send-mo-data..... | 112 | +| 6.1.3.3.4.5.1 | Description..... | 112 | +| 6.1.3.3.4.5.2 | Operation Definition..... | 112 | +| 6.1.3.4 | Void..... | 114 | +| 6.1.3.5 | Resource: PDU sessions collection (H-SMF or SMF)..... | 114 | +| 6.1.3.5.1 | Description..... | 114 | +| 6.1.3.5.2 | Resource Definition..... | 114 | +| 6.1.3.5.3 | Resource Standard Methods..... | 114 | +| 6.1.3.5.3.1 | POST..... | 114 | +| 6.1.3.5.4 | Resource Custom Operations..... | 117 | +| 6.1.3.5.4.1 | Overview..... | 117 | +| 6.1.3.6 | Resource: Individual PDU session (H-SMF or SMF)..... | 117 | +| 6.1.3.6.1 | Description..... | 117 | +| 6.1.3.6.2 | Resource Definition..... | 118 | +| 6.1.3.6.3 | Resource Standard Methods..... | 118 | +| 6.1.3.6.4 | Resource Custom Operations..... | 118 | +| 6.1.3.6.4.1 | Overview..... | 118 | +| 6.1.3.6.4.2 | Operation: modify..... | 118 | +| 6.1.3.6.4.2.1 | Description..... | 118 | +| 6.1.3.6.4.2.2 | Operation Definition..... | 118 | +| 6.1.3.6.4.3 | Operation: release..... | 120 | +| 6.1.3.6.4.3.1 | Description..... | 120 | +| 6.1.3.6.4.3.2 | Operation Definition..... | 120 | +| 6.1.3.6.4.4 | Operation: transfer-mo-data..... | 121 | +| 6.1.3.6.4.4.1 | Description..... | 121 | +| 6.1.3.6.4.4.2 | Operation Definition..... | 121 | +| 6.1.3.6.4.5 | Operation: retrieve..... | 122 | +| 6.1.3.6.4.5.1 | Description..... | 122 | +| 6.1.3.6.4.5.2 | Operation Definition..... | 122 | +| 6.1.3.7 | Resource: Individual PDU session (V-SMF or I-SMF)..... | 123 | +| 6.1.3.7.1 | Description..... | 123 | +| 6.1.3.7.2 | Resource Definition..... | 123 | +| 6.1.3.7.3 | Resource Standard Methods..... | 123 | +| 6.1.3.7.3.1 | POST..... | 123 | +| 6.1.3.7.4 | Resource Custom Operations..... | 125 | +| 6.1.3.7.4.1 | Overview..... | 125 | +| 6.1.3.7.4.2 | Operation: modify..... | 125 | +| 6.1.3.7.4.2.1 | Description..... | 125 | +| 6.1.3.7.4.2.2 | Operation Definition..... | 125 | +| 6.1.3.7.4.3 | Operation: transfer-mt-data..... | 128 | + +| | | | +|---------------|-----------------------------------------------------|-----| +| 6.1.3.7.4.3.1 | Description..... | 128 | +| 6.1.3.7.4.3.2 | Operation Definition..... | 128 | +| 6.1.4 | Custom Operations without associated resources..... | 129 | +| 6.1.5 | Notifications..... | 129 | +| 6.1.5.1 | General..... | 129 | +| 6.1.5.2 | SM Context Status Notification..... | 130 | +| 6.1.5.2.1 | Description..... | 130 | +| 6.1.5.2.2 | Notification Definition..... | 130 | +| 6.1.6 | Data Model..... | 131 | +| 6.1.6.1 | General..... | 131 | +| 6.1.6.2 | Structured data types..... | 137 | +| 6.1.6.2.1 | Introduction..... | 137 | +| 6.1.6.2.2 | Type: SmContextCreateData..... | 138 | +| 6.1.6.2.3 | Type: SmContextCreatedData..... | 152 | +| 6.1.6.2.4 | Type: SmContextUpdateData..... | 155 | +| 6.1.6.2.5 | Type: SmContextUpdatedData..... | 165 | +| 6.1.6.2.6 | Type: SmContextReleaseData..... | 168 | +| 6.1.6.2.7 | Type: SmContextRetrieveData..... | 171 | +| 6.1.6.2.8 | Type: SmContextStatusNotification..... | 174 | +| 6.1.6.2.9 | Type: PduSessionCreateData..... | 178 | +| 6.1.6.2.10 | Type: PduSessionCreatedData..... | 188 | +| 6.1.6.2.11 | Type: HsmfUpdateData..... | 195 | +| 6.1.6.2.12 | Type: HsmfUpdatedData..... | 205 | +| 6.1.6.2.13 | Type: ReleaseData..... | 209 | +| 6.1.6.2.14 | Type: HsmfUpdateError..... | 210 | +| 6.1.6.2.15 | Type: VsmfUpdateData..... | 211 | +| 6.1.6.2.16 | Type: VsmfUpdatedData..... | 216 | +| 6.1.6.2.17 | Type: StatusNotification..... | 219 | +| 6.1.6.2.18 | Type: QosFlowItem..... | 221 | +| 6.1.6.2.19 | Type: QosFlowSetupItem..... | 222 | +| 6.1.6.2.20 | Type: QosFlowAddModifyRequestItem..... | 223 | +| 6.1.6.2.21 | Type: QosFlowReleaseRequestItem..... | 223 | +| 6.1.6.2.22 | Type: QosFlowProfile..... | 224 | +| 6.1.6.2.23 | Type: GbrQosFlowInformation..... | 225 | +| 6.1.6.2.24 | Type: QosFlowNotifyItem..... | 225 | +| 6.1.6.2.25 | Type: Void..... | 226 | +| 6.1.6.2.26 | Type: Void..... | 226 | +| 6.1.6.2.27 | Type: SmContextRetrievedData..... | 226 | +| 6.1.6.2.28 | Type: TunnelInfo..... | 227 | +| 6.1.6.2.29 | Type: StatusInfo..... | 227 | +| 6.1.6.2.30 | Type: VsmfUpdateError..... | 228 | +| 6.1.6.2.31 | Type: EpsPdnCnxInfo..... | 230 | +| 6.1.6.2.32 | Type: EpsBearerInfo..... | 230 | +| 6.1.6.2.33 | Type: PduSessionNotifyItem..... | 230 | +| 6.1.6.2.34 | Type: EbiArpMapping..... | 231 | +| 6.1.6.2.35 | Type: SmContextCreateError..... | 231 | +| 6.1.6.2.36 | Type: SmContextUpdateError..... | 232 | +| 6.1.6.2.37 | Type: PduSessionCreateError..... | 233 | +| 6.1.6.2.38 | Type: MmeCapabilities..... | 234 | +| 6.1.6.2.39 | Type: SmContext..... | 235 | +| 6.1.6.2.40 | Type: ExemptionInd..... | 243 | +| 6.1.6.2.41 | Type: PsaInformation..... | 243 | +| 6.1.6.2.42 | Type: DnailInformation..... | 244 | +| 6.1.6.2.43 | Type: N4Information..... | 244 | +| 6.1.6.2.44 | Type: IndirectDataForwardingTunnelInfo..... | 245 | +| 6.1.6.2.45 | Type: SmContextReleasedData..... | 245 | +| 6.1.6.2.46 | Type: ReleasedData..... | 246 | +| 6.1.6.2.47 | Type: SendMoDataReqData..... | 246 | +| 6.1.6.2.48 | Type: CnAssistedRanPara..... | 247 | +| 6.1.6.2.49 | Type: UlclBpInformation..... | 247 | +| 6.1.6.2.50 | Type: TransferMoDataReqData..... | 247 | + +| | | | +|------------|-------------------------------------------------|-----| +| 6.1.6.2.51 | Type: TransferMtDataReqData..... | 248 | +| 6.1.6.2.52 | Type: TransferMtDataError..... | 248 | +| 6.1.6.2.53 | Type: TransferMtDataAddInfo..... | 248 | +| 6.1.6.2.54 | Type: VplmnQos..... | 249 | +| 6.1.6.2.55 | Type: DdnFailureSubs..... | 249 | +| 6.1.6.2.56 | Type: RetrieveData..... | 250 | +| 6.1.6.2.57 | Type: RetrievedData..... | 250 | +| 6.1.6.2.58 | Type: SecurityResult..... | 250 | +| 6.1.6.2.59 | Type: UpSecurityInfo..... | 251 | +| 6.1.6.2.60 | Type: DdnFailureSubInfo..... | 251 | +| 6.1.6.2.61 | Type: AlternativeQosProfile..... | 252 | +| 6.1.6.2.62 | Type: ProblemDetailsAddInfo..... | 252 | +| 6.1.6.2.63 | Type: ExtProblemDetails..... | 252 | +| 6.1.6.2.64 | Type: QosMonitoringInfo..... | 253 | +| 6.1.6.2.65 | Type: IpAddress..... | 253 | +| 6.1.6.2.66 | Type: RedundantPduSessionInformation..... | 253 | +| 6.1.6.2.67 | Type: QosFlowTunnel..... | 253 | +| 6.1.6.2.68 | Type: TargetDnailInfo..... | 254 | +| 6.1.6.2.69 | Type: AfCoordinationInfo..... | 254 | +| 6.1.6.2.70 | Type: NotificationInfo..... | 254 | +| 6.1.6.2.71 | Type: AnchorSmfFeatures..... | 254 | +| 6.1.6.2.72 | Type: HrsboInfoFromVplmn..... | 256 | +| 6.1.6.2.73 | Type: HrsboInfoFromHplmn..... | 257 | +| 6.1.6.2.74 | Type: EasInfoToRefresh..... | 259 | +| 6.1.6.2.75 | Type: EcnMarkingCongestionInfoReq..... | 260 | +| 6.1.6.2.76 | Type: EcnMarkingCongestionInfoStatus..... | 260 | +| 6.1.6.2.77 | Type: TscAssistanceInformation..... | 260 | +| 6.1.6.2.78 | Type: N6JitterInformation..... | 261 | +| 6.1.6.3 | Simple data types and enumerations..... | 261 | +| 6.1.6.3.1 | Introduction..... | 261 | +| 6.1.6.3.2 | Simple data types..... | 261 | +| 6.1.6.3.3 | Enumeration: UpCnxState..... | 262 | +| 6.1.6.3.4 | Enumeration: HoState..... | 263 | +| 6.1.6.3.5 | Enumeration: RequestType..... | 263 | +| 6.1.6.3.6 | Enumeration: RequestIndication..... | 263 | +| 6.1.6.3.7 | Enumeration: NotificationCause..... | 264 | +| 6.1.6.3.8 | Enumeration: Cause..... | 264 | +| 6.1.6.3.9 | Enumeration: ResourceStatus..... | 268 | +| 6.1.6.3.10 | Enumeration: DnnSelectionMode..... | 269 | +| 6.1.6.3.11 | Enumeration: EpsInterworkingIndication..... | 269 | +| 6.1.6.3.12 | Enumeration: N2SmInfoType..... | 270 | +| 6.1.6.3.13 | Enumeration: MaxIntegrityProtectedDataRate..... | 271 | +| 6.1.6.3.14 | Enumeration: MaReleaseIndication..... | 271 | +| 6.1.6.3.15 | Enumeration: SmContextType..... | 271 | +| 6.1.6.3.16 | Enumeration: PsaIndication..... | 271 | +| 6.1.6.3.17 | Enumeration: N4MessageType..... | 271 | +| 6.1.6.3.18 | Enumeration: QosFlowAccessType..... | 272 | +| 6.1.6.3.19 | Enumeration: UnavailableAccessIndication..... | 272 | +| 6.1.6.3.20 | Enumeration: ProtectionResult..... | 272 | +| 6.1.6.3.21 | Enumeration: QosMonitoringReq..... | 272 | +| 6.1.6.3.22 | Enumeration: Rsn..... | 273 | +| 6.1.6.3.23 | Enumeration: SmfSelectionType..... | 273 | +| 6.1.6.3.24 | Enumeration: PduSessionContextType..... | 273 | +| 6.1.6.3.25 | Enumeration: PendingUpdateInfo..... | 273 | +| 6.1.6.3.26 | Enumeration: EstablishmentRejectionCause..... | 273 | +| 6.1.6.3.27 | Enumeration: EcnMarkingReq..... | 274 | +| 6.1.6.3.28 | Enumeration: CongestionInfoReq..... | 274 | +| 6.1.6.3.29 | Enumeration: ActivationStatus..... | 274 | +| 6.1.6.4 | Binary data..... | 274 | +| 6.1.6.4.1 | Introduction..... | 274 | +| 6.1.6.4.2 | N1 SM Message..... | 275 | + +| | | | +|-------------------------------|--------------------------------------------------------------------|------------| +| 6.1.6.4.3 | N2 SM Information..... | 275 | +| 6.1.6.4.4 | n1SmInfoFromUe, n1SmInfoToUe, unknownN1SmInfo..... | 276 | +| 6.1.6.4.5 | N4 Message Payload..... | 278 | +| 6.1.6.4.6 | Mobile Originated Data..... | 278 | +| 6.1.6.4.7 | Mobile Terminated Data..... | 279 | +| 6.1.7 | Error Handling..... | 279 | +| 6.1.7.1 | General..... | 279 | +| 6.1.7.2 | Protocol Errors..... | 279 | +| 6.1.7.3 | Application Errors..... | 279 | +| 6.1.8 | Feature Negotiation..... | 283 | +| 6.1.9 | Security..... | 288 | +| 6.1.10 | HTTP redirection..... | 288 | +| Annex A (normative): | OpenAPI specification..... | 290 | +| A.1 | General..... | 290 | +| A.2 | Nsmf_PDUSession API..... | 290 | +| Annex B (Informative): | HTTP Multipart Messages..... | 359 | +| B.1 | Example of HTTP multipart message..... | 359 | +| B.1.1 | General..... | 359 | +| B.1.2 | Example HTTP multipart message with N1 SM Message binary data..... | 359 | +| Annex C (Normative): | ABNF grammar for 3GPP SBI HTTP custom headers..... | 359 | +| C.1 | General..... | 359 | +| C.2 | ABNF definitions (Filename: "TS29502_CustomHeaders.abnf")..... | 360 | +| Annex D (Informative): | Charging Identifier Handling..... | 361 | +| D.1 | Usage of Charging ID and SMF Charging ID..... | 361 | +| D.1.1 | General..... | 361 | +| D.1.2 | HPLMN supporting the SMF Charging ID..... | 361 | +| D.1.3 | HPLMN not supporting the SMF Charging ID..... | 361 | +| D.1.4 | Transfer of (SMF) Charging ID between SMFs..... | 361 | +| Annex E (informative): | Change history..... | 363 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nsmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the SMF other than the Session Management Event Exposure service and Session Management services for Non-IP Data Delivery (NIDD). + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +The Session Management Event Exposure Service is specified in 3GPP TS 29.508 [6]. The Session Management services for Non-IP Data Delivery (NIDD) are specified in 3GPP TS 29.542 [37]. + +--- + +## 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [7] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [8] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General aspects". +- [9] 3GPP TS 38.413: "NG Radio Access Network (NG-RAN); NG Application Protocol (NGAP)". +- [10] IETF RFC 2387: "The MIME Multipart/Related Content-type". +- [11] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [12] IETF RFC 2045: "Multipart Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies". + +- [13] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [14] IETF RFC 9113: "HTTP/2". +- [15] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", . +- [16] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [17] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [18] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [19] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [20] 3GPP TS 29.518: "5G System; Access and Mobility Management Service; Stage 3". +- [21] 3GPP TS 23.380: "IMS Restoration Procedures". +- [22] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [23] IETF RFC 9457: "Problem Details for HTTP APIs". +- [24] 3GPP TS 23.527: "5G System; Restoration Procedures". +- [25] 3GPP TS 32.255: "Charging management; 5G data connectivity domain charging; stage 2". +- [26] 3GPP TS 32.291: "Charging management; 5G system, charging service; Stage 3". +- [27] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [28] 3GPP TR 21.900: "Technical Specification Group working methods". +- [29] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane Nodes; stage 3". +- [30] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [31] Void +- [32] IETF RFC 9110: "HTTP Semantics". +- [33] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access; Stage 2". +- [34] 3GPP TS 29.524: "5G System; Cause codes mapping between 5GC interfaces; Stage 3". +- [35] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC); Stage 2". +- [36] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [37] 3GPP TS 29.542: "5G System; Session Management Services for Non-IP Data Delivery (NIDD); Stage 3". +- [38] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository service for Policy Control Data, Application Data and Structured Data for Exposure; Stage 3". +- [39] 3GPP TS 23.548: "5G System Enhancements for Edge Computing; Stage 2". +- [40] 3GPP TS 29.531: "5G System; Network Slice Selection Services; Stage 3". +- [41] 3GPP TS 23.256: "Support of Uncrewed Aerial Systems (UAS) connectivity, identification and tracking; Stage 2". +- [42] 3GPP TS 23.015: "Technical realization of Operator Determined Barring (ODB)". +- [43] 3GPP TS 23.304: "Proximity based Services (ProSe) in the 5G System (5GS)". + +- [44] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services; Stage 2". +- [45] 3GPP TS 23.007: "Restoration procedures". +- [46] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Alternative S-NSSAI:** Indicating a compatible S-NSSAI for an S-NSSAI in the Allowed NSSAI that the AMF uses to replace an S-NSSAI when the S-NSSAI is not available or congested, as specified in 3GPP TS 23.501 [2]. + +### 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|--------------------------------------------------| +| BP | Branching Point | +| DNAI | Data Network Access Identifier | +| DNN | Data Network Name | +| HR | Home Routed | +| HR-SBO | Home Routed Session BreakOut | +| H-SMF | Home SMF | +| I-SMF | Intermediate SMF | +| JSON | Javascript Object NotationNAS Non-Access Stratum | +| LADN | Local Area Data Network | +| MA | Multi-Access | +| MO | Mobile Originated | +| MT | Mobile TerminatedPSA PDU Session Anchor | +| RSN | Redundancy Sequence Number | +| SM | Session Management | +| SMF | Session Management Function | +| SNPN | Stand-alone Non-Public Network | +| TNGF | Trusted Non-3GPP Gateway Function | +| TWIF | Trusted WLAN Interworking Function | +| UAS | Uncrewed Aerial System | +| UAV | Uncrewed Aerial Vehicle | +| UL CL | Uplink Classifier | +| UPF | User Plane Function | +| USS | UAS Service Supplier | +| UUAA | USS UAV Authorization/Authentication | +| V-SMF | Visited SMF | +| W-AGF | Wireline Access Gateway Function | + +## 4 Overview + +### 4.1 Introduction + +Within the 5GC, the SMF offers services to NF service consumers via the Nsmf service based interface (see 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the SMF services specified within the present specification. + +![Figure 4.1-1: Reference model – SMF. The diagram shows two SMF blocks and one AMF block. On the left, an SMF block is connected to an AMF block via a line labeled N11. Both the SMF and AMF blocks are connected to a central Nsmf service interface (represented by a circle) via lines labeled N16, N16a, and N38. The Nsmf interface is connected to a large SMF block on the right.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg) + +Figure 4.1-1: Reference model – SMF. The diagram shows two SMF blocks and one AMF block. On the left, an SMF block is connected to an AMF block via a line labeled N11. Both the SMF and AMF blocks are connected to a central Nsmf service interface (represented by a circle) via lines labeled N16, N16a, and N38. The Nsmf interface is connected to a large SMF block on the right. + +**Figure 4.1-1: Reference model – SMF** + +N16 is the reference point between the V-SMF and H-SMF in Home Routed (HR) roaming cases. + +N16a is the reference point between SMF and I-SMF. + +N38 is the reference point between I-SMFs or V-SMFs. + +The functionalities supported by the SMF are listed in clause 6.2.2 of 3GPP TS 23.501 [2]. + +## 5 Services offered by the SMF + +### 5.1 Introduction + +The SMF supports the following services. + +**Table 5.1-1: NF Services provided by SMF** + +| Service Name | Description | Example Consumer | +|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| Nsmf_PDUSession | This service manages the PDU sessions and uses the policy and charging rules received from the PCF. The service operations exposed by this NF service allows the consumer NFs to establish, modify and delete the PDU sessions, and to send mobile originated data. | V-SMF, H-SMF, I-SMF, SMF, AMF | +| Nsmf_EventExposure | See 3GPP TS 29.508 [6]. | | +| Nsmf_NIDD | See 3GPP TS 29.542 [37]. | | + +Table 5.1-2 summarizes the corresponding APIs defined in this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-----------------|--------|-------------------------|------------------------------|-----------------|-------| +| Nsmf_PDUSession | 6.1 | SMF PDU Session Service | TS29502_Nsmf_PDUSession.yaml | nsmf-pdusession | A.2 | + +## 5.2 Nsmf\_PDUSession Service + +### 5.2.1 Service Description + +The Nsmf\_PDUSession service operates on the PDU Sessions. The service operations exposed by this service allow other NFs to establish, modify and release the PDU Sessions. The following are the key functionalities of this NF service: + +- Creation, modification and deletion of SM contexts for PDU Sessions; an SM context represents an association between the NF Service Consumer (e.g. AMF) and the SMF for a PDU session; +- Retrieval of SM contexts of PDU sessions (i.e. UE EPS PDN connection or complete SM context), e.g. to move PDU sessions towards the EPC using the N26 interface or to transfer SM contexts between I-SMFs or V-SMFs over the N38 interface; +- Creation, modification and deletion of PDU sessions between the V-SMF and H-SMF in HR roaming scenarios, or between the I-SMF and SMF for PDU sessions involving an I-SMF; +- Sending of mobile originated data (received over NAS) for a PDU session to the SMF, V-SMF in HR roaming scenarios, or I-SMF for PDU sessions involving an I-SMF; +- Transferring of NEF anchored mobile originated data for a PDU session to the H-SMF in HR roaming scenarios, or SMF for PDU sessions involving an I-SMF; +- Transferring of NEF anchored mobile terminated data for a PDU session to the V-SMF in HR roaming scenarios, or I-SMF for PDU sessions involving an I-SMF; +- Association of policy and charging rules with PDU Sessions and binding the policy and charging rules to flows; +- Interacting with the UPF over N4 for creating, modifying and releasing user plane sessions; +- Process user plane events from the UPF and apply the corresponding policy and charging rules. + +The Nsmf\_PDUSession service supports the following service operations. + +**Table 5.2.1-1: Service operations supported by the Nsmf\_PDUSession service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|--------------------------| +| Create SM Context | Create an SM context in SMF, or in V-SMF in HR roaming scenarios, or in I-SMF during the I-SMF insertion and change scenarios, for a PDU session. | Request/Response | AMF | +| Update SM Context | Update the SM context of a PDU session and/or provide the SMF with N1 or N2 SM information received from the UE or from the AN. | Request/Response | AMF, I-SMF | +| Release SM Context | Release the SM context of a PDU session when the PDU session has been released. | Request/Response | AMF | +| Notify SM Context Status (NOTE 1) | Notify the NF Service Consumer about the status of an SM Context of a PDU session (e.g. the SM Context is released within the SMF). | Subscribe/Notify | AMF | +| Retrieve SM Context (NOTE 2) | Retrieve an SM context of a PDU session:
- from SMF, or from V-SMF in HR roaming scenarios, for 5GS to EPS mobility;
- from SMF during I-SMF insertion or from I-SMF during I-SMF change/removal;
- from V-SMF during change of V-SMF. | Request/Response | AMF, I-SMF, V-SMF, SMF | +| Create | Create a PDU session in the H-SMF in HR roaming scenarios, or in the SMF for PDU sessions involving an I-SMF. | Request/Response | V-SMF, I-SMF | +| Update | Update a PDU session in the H-SMF or V-SMF in HR roaming scenarios, or in the I-SMF or SMF for PDU sessions involving an I-SMF. | Request/Response | V-SMF, H-SMF, I-SMF, SMF | +| Release | Release a PDU session in the H-SMF in HR roaming scenarios, or in the SMF for PDU sessions involving an I-SMF. | Request/Response | V-SMF, I-SMF | +| Notify Status (NOTE 3) | Notify the NF Service Consumer about the status of a PDU session (e.g. the PDU session is released due to local reasons within the SMF). | Subscribe/Notify | V-SMF, I-SMF | +| Retrieve (NOTE 2) | Retrieve information from a PDU session context from the H-SMF for a HR PDU session, or from the SMF for a PDU session with an I-SMF. | Request/Response | V-SMF, I-SMF | +| Send MO Data | Send mobile originated data received over NAS for a PDU session | Request/Response | AMF | +| Transfer MO Data (NOTE 4) | Transfer NEF anchored mobile originated data received from AMF for a PDU session | Request/Response | V-SMF, I-SMF | +| Transfer MT Data (NOTE 5) | Transfer NEF anchored mobile terminated data received from NEF for a PDU session | Request/Response | H-SMF, SMF | +| NOTE 1: This corresponds to the SMContextStatusNotify service operation defined in 3GPP TS 23.502 [3]. | | | | +| NOTE 2: This corresponds to the ContextRequest service operation defined in 3GPP TS 23.502 [3]. | | | | +| NOTE 3: This corresponds to the StatusNotify service operation defined in 3GPP TS 23.502 [3]. | | | | +| NOTE 4: This corresponds to the MessageTransfer service operation in clause 4.25.4 of 3GPP TS 23.502 [3]. | | | | +| NOTE 5: This corresponds to the MessageTransfer service operation in clause 4.25.5 of 3GPP TS 23.502 [3]. | | | | + +## 5.2.2 Service Operations + +### 5.2.2.1 Introduction + +See Table 5.2.1-1 for an overview of the service operations supported by the Nsmf\_PDUSession service. + +## 5.2.2.2 Create SM Context service operation + +### 5.2.2.2.1 General + +The Create SM Context service operation shall be used to create an individual SM context, for a given PDU session, in the SMF, in the V-SMF for HR roaming scenarios, or in the I-SMF for a PDU session with an I-SMF. + +It is used in the following procedures: + +- UE requested PDU Session Establishment (see clauses 4.3.2 and 4.23.5.1 of 3GPP TS 23.502 [3]); +- EPS to 5GS Idle mode mobility, EPS to 5GS Idle mode mobility with data forwarding or handover using N26 interface (see clauses 4.11.1, 4.23.12.3, 4.23.12.5 and 4.23.12.7 of 3GPP TS 23.502 [3]); +- EPS to 5GS mobility without N26 interface (see clause 4.11.2.3 3GPP TS 23.502 [3]); +- Handover of a PDU session between 3GPP access and non-3GPP access, when the target AMF does not know the SMF resource identifier of the SM context used by the source AMF, e.g. when the target AMF is not in the PLMN of the N3IWF (see clause 4.9.2.3.2 of 3GPP TS 23.502 [3]), or when the UE is roaming and the selected N3IWF is in the HPLMN (see clause 4.9.2.4.2 of 3GPP TS 23.502 [3]); +- Handover from EPS to 5GC-N3IWF (see clause 4.11.3.1 of 3GPP TS 23.502 [3]); +- Handover from EPC/ePDG to 5GS (see clause 4.11.4.1 of 3GPP TS 23.502 [3]); +- Xn based or N2 based handover with I-SMF or V-SMF insertion and change (see clauses 4.23.7.3, 4.23.11 and 4.23.12 of 3GPP TS 23.502 [3]); +- UE Triggered Service Request with I-SMF insertion/change/removal or V-SMF change (see clause 4.23.4.3 of 3GPP TS 23.502 [3]); +- Registration procedure for a UE with a PDU session with I-SMF or V-SMF insertion, change and removal (see clause 4.23.3 of 3GPP TS 23.502 [3]); +- Handover from EPC/ePDG to 5GS with I-SMF insertion (see clause 4.23 of 3GPP TS 23.502 [3]); +- Handover from non-3GPP to 3GPP access with I-SMF insertion or V-SMF change, and Handover from 3GPP to non-3GPP access with I-SMF removal (see clause 4.23.16 of 3GPP TS 23.502 [3]); +- SMF Context Transfer procedure, LBO or no Roaming, no I-SMF (see clause 4.26.5.3 of 3GPP TS 23.502 [3]); +- I-SMF Context Transfer procedure (see clause 4.26.5.2 of 3GPP TS 23.502 [3]); +- 5G-RG requested PDU Session Establishment via W-5GAN (see clause 7.3.1 of 3GPP TS 23.316 [36]); +- FN-RG related PDU Session Establishment via W-5GAN (see clause 7.3.4 of 3GPP TS 23.316 [36]); +- Non-5G capable device behind 5G-CRG and FN-CRG requested PDU Session Establishment via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [36]); +- Handover from 3GPP access/EPS to W-5GAN/5GC (see clause 7.6.4.1 of 3GPP TS 23.316 [36]); +- SMF triggered I-SMF selection or removal (see clause 4.23.5.4 of 3GPP TS 23.502 [3]); +- Multicast Session join and session establishment procedure in clause 7.2.1.3 of 3GPP TS 23.247 [44]. + +There shall be only one individual SM context per PDU session. + +The NF Service Consumer (e.g. AMF) shall create an SM context by using the HTTP POST method as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram illustrating SM context creation. Two rectangular boxes represent the NF Service Consumer and the SMF. A solid arrow points from the consumer to the SMF. Two dashed arrows point from the SMF back to the consumer. Vertical dashed lines extend downwards from each box, representing lifelines.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +Sequence diagram illustrating SM context creation. Two rectangular boxes represent the NF Service Consumer and the SMF. A solid arrow points from the consumer to the SMF. Two dashed arrows point from the SMF back to the consumer. Vertical dashed lines extend downwards from each box, representing lifelines. + +**Figure 5.2.2.2.1-1: SM context creation** + +1. The NF Service Consumer shall send a POST request to the resource representing the SM contexts collection resource of the SMF. The content of the POST request shall contain: + - a representation of the individual SM context resource to be created; + - the requestType IE, if the Request type IE is received from the UE for a single access PDU session and if the request refers to an existing PDU session or an existing Emergency PDU session; the requestType IE shall not be included for a MA-PDU session establishment request; it may be included otherwise; + - the Old PDU Session ID, if it is received from the UE (i.e. for a PDU session establishment for the SSC mode 3 operation); + - the indication that the UE is inside or outside of the LADN (Local Area Data Network) service area, if the DNN corresponds to a LADN; + - the perLadnDnnSnssaiInd IE, indicating that the PDU Session is subject to LADN per LADN DNN and S-NSSAI, if the AMF enforces the LADN Service Area per LADN DNN and S-NSSAI; + - the indication that a MA-PDU session is requested if a MA-PDU session is requested to be established by the UE, or the indication that the PDU session is allowed to be upgraded to a MA-PDU session if so indicated by the UE; + - the n3gPathSwitchSupportInd IE if the AMF supports non-3GPP access path switching while maintaining two N2 connections for non-3GPP access, the selected SMF supports non-3GPP path switching and if the UE supports non-3GPP access path switching as specified in clause 4.22.2.1 of 3GPP TS 23.502 [3]; + - the indication that the same PCF is required for the requested DNN and S-NSSAI, if it is received by the AMF from UE Subscription data in the UDM, together with the PCF ID selected by the AMF; + - the alternative S-NSSAI, if the NF service consumer and UE support the network slice replacement and it is requested to replace the S-NSSAI with the alternative S-NSSAI (see clause 5.15.19 of 3GPP TS 23.501 [2]); + - the alternative HPLMN S-NSSAI, if the NF service consumer and UE support the network slice replacement and it is requested to replace the HPLMN S-NSSAI with the alternative HPLMN S-NSSAI for a HR PDU session (see clause 5.15.19 of 3GPP TS 23.501 [2]); + - the anType; + - the additionalAnType, if the UE is registered over both 3GPP and Non-3GPP accesses; + - the cpCiotEnabled IE with the value "True", if the NF service consumer (e.g. the AMF) has verified that the CIoT feature is supported by the SMF (and for a home-routed session, that it is also supported by the H-SMF), and Control Plane CIoT 5GS Optimisation is enabled for this PDU session; + - the cpOnlyInd IE with the value "True", if the PDU session shall only use Control Plane CIoT 5GS Optimisation; + - the Invoke NEF indication with the value "True" for a home-routed PDU session, if the cpCiotEnabled IE is set to "True" and data delivery via NEF is selected for the PDU session; + - a subscription for SM context status notification; + - the servingNfId identifying the serving AMF; + +- trace control and configuration parameters, if trace is to be activated (see 3GPP TS 32.422 [22]); +- identifiers (i.e. FQDN or IP address) of N3 terminations at the W-AGF, TNGF or TWIF, if available; +- a subscription for DDN failure notification, if the Availability after DDN failure event is subscribed by the UDM; +- the upipSupported IE set to "true", if the UE supports User Plane Integrity Protection with EPS and if the AMF supports the related functionality. + +For the UE requested PDU Session Establishment procedure in home routed roaming scenario (see clause 4.3.2.2.2 of 3GPP TS 23.502 [3]), the NF Service Consumer shall provide the URI of the Nsmf\_PDUSession service of the H-SMF in the hSmfUri IE and optionally the corresponding SMF ID, and may provide the URI of the Nsmf\_PDUSession service of additional H-SMF(s) with the corresponding SMF ID(s). The V-SMF shall try to create the PDU session using the hSmfUri IE. If due to communication failure on the N16 interface the V-SMF does not receive any response from the H-SMF, then: + +- depending on operator policy, the V-SMF may try reaching the hSmfUri via an alternate path; or +- if additional H-SMF URI is provided, the V-SMF may try to create the PDU session on one of the additional H-SMF(s) provided. + +For a PDU session establishment with an I-SMF (see clause 4.23.5.1 of 3GPP TS 23.502 [3]), the NF Service Consumer shall provide the URI of the Nsmf\_PDUSession service of the SMF in the smfUri IE and optionally the corresponding SMF ID, and may provide the URI of the Nsmf\_PDUSession service of additional SMF(s) with the corresponding SMF ID(s). The I-SMF shall try to create the PDU session using the smfUri IE. If due to communication failure on the N16a interface the I-SMF does not receive any response from the SMF, then: + +- depending on operator policy, the I-SMF may try reaching the smfUri via an alternate path; or +- if additional SMF URI is provided, the I-SMF may try to create the PDU session on one of the additional SMF(s) provided. + +For the UE requested PDU Session Establishment procedure, if the AMF determines that the RAT type is NB-IoT and the UE has already 2 PDU Sessions with user plane resources activated, the AMF may continue with the PDU Session establishment and include the cpCiotEnabled IE or cpOnlyInd IE with the value "True" to the SMF as specified in clause 4.3.2.2.1 of 3GPP TS 23.502 [3]. + +The content of the POST request may further contain: + +- the name of the AMF service to which SM context status notification are to be sent (see clause 6.5.2.2 of 3GPP TS 29.500 [4]), encoded in the serviceName attribute; +- the remote provisioning server information, if both the AMF and SMF support the Remote Provisioning of UEs in Onboarding Network procedures and the AMF received the information from AUSF for remote provisioning of the UE via user plane; +- the Onboarding Indication, if the UE is registered for onboarding in an SNPN; +- the indication of Notification for SM Policy Association events with the value "true" and the callback information of the PCF for the UE (i.e. the PCF for AM Policy and possibly UE Policy) to receive the notification, if both NF service consumer and the SMF support the "SPAE" feature and if the SM Policy Association Establishment and Termination events should be reported for the PDU session by the PCF for SM Policy to the PCF for the UE. See clause 4.3.2.2.1 of 3GPP TS 23.502 [3]; +- the satelliteBackhaulCat IE indicating the category of the satellite backhaul used towards the 5G AN serving the UE, if the AMF is aware of that a satellite backhaul is used towards the 5G AN; +- the disasterRoamingInd IE set to true if the UE is registered for Disaster Roaming service; +- the hrsboAllowedInd IE set to true if the Session Breakout for HR session in VPLMN is allowed; +- the indication of PDU session establishment rejection together with the corresponding rejection cause, if the SMF supports the "PSER" (PDU Session Establishment Rejection) feature and the NF service consumer (i.e. the AMF) has determined that the PDU Session Establishment shall be rejected (e.g. due to the ODB configuration retrieved from the UDM). + +- 2a. On success, "201 Created" shall be returned, the content of the POST response shall contain the representation describing the status of the request and the "Location" header shall be present and shall contain the URI of the created resource. The authority and/or deployment-specific string of the apiRoot of the created resource URI may differ from the authority and/or deployment-specific string of the apiRoot of the request URI received in the POST request. + +If the requestType IE was received in the request and set to EXISTING\_PDU\_SESSION or EXISTING\_EMERGENCY\_PDU\_SESSION (i.e. indicating that this is a UE request for an existing PDU session or an existing emergency PDU session), the SMF shall identify the existing PDU session or emergency PDU session based on the PDU Session ID; in this case, the SMF shall not create a new SM context but instead update the existing SM context and provide the representation of the updated SM context in the "201 Created" response to the NF Service Consumer. + +The POST request shall be considered as colliding with an existing SM context if: + +- this is a request to establish a new PDU session, i.e.: + - the RequestType IE is present in the request and set to INITIAL\_REQUEST or INITIAL\_EMERGENCY\_REQUEST (e.g. single access PDU session establishment request); + - the RequestType IE and the maRequestInd IE are both absent in the request (e.g. EPS to 5GS mobility); or + - the maRequestInd IE is present in the request (i.e. MA-PDU session establishment request) and the access type indicated in the request corresponds to the access type of the existing SM context. + +and either of the following conditions is met: + +- this is a request to establish a non-emergency PDU session and the request includes the same SUPI and the same PDU Session ID as for an existing SM context; or +- this is a request to establish an emergency PDU session and the request includes the same SUPI, or PEI for an emergency registered UE without a UICC or without an authenticated SUPI, as for an existing SM context for an emergency PDU session. + +A POST request that collides with an existing SM context shall be treated as a request for a new SM context. Before creating the new SM context, the SMF should delete the existing SM context locally and any associated resources in the UPF, PCF, CHF, and UDM. If the UP connection of the existing PDU session is active, the SMF should also request (R)AN to release associated resources. See also clause 5.2.3.3.1 for the handling of requests which collide with an existing SM context. If the smContextStatusUri of the existing SM context differs from the smContextStatusUri received in the POST request, the SMF shall also send an SM context status notification (see clause 5.2.2.5) targeting the smContextStatusUri of the existing SM context to notify the release of the existing SM context. For a HR PDU session, if the H-SMF URI in the request is different from the H-SMF URI of the existing PDU session, the V-SMF should also delete the existing PDU session in the H-SMF by invoking the Release service operation (see clause 5.2.2.9). For a PDU session with an I-SMF, if the SMF URI in the request is different from the SMF URI of the existing PDU session, the I-SMF should also delete the existing PDU session in the SMF by invoking the Release service operation (see clause 5.2.2.9). + +If the requestType IE was received in the request and indicates this is a request for a new PDU session (i.e. INITIAL\_REQUEST) and if the Old PDU Session ID was also included in the request, the SMF shall identify the existing PDU session to release and to which the new PDU session establishment relates, based on the Old PDU Session ID. + +If no GPSI IE is provided in the request, e.g. for a PDU session moved from another access or another system, and the SMF knows that a GPSI is already associated with the PDU session (or a GPSI is received from h-SMF for a HR PDU session), the SMF shall include the GPSI in the response. + +If the indication of Notification for SM Policy Association events was received with the value "true" together with the callback information of the PCF for the UE in the request and SM Policy Association is to be established for the PDU session, the SMF shall provide the callback information of the PCF for the UE to the PCF for SM Policy during SM Policy Association Establishment. + +- 2b. If the request does not include the "UE presence in LADN service area" indication and the SMF determines that the DNN corresponds to a LADN, then the SMF shall consider that the UE is outside of the LADN service area. The SMF shall reject the request if the UE is outside of the LADN service area. + +On failure, or redirection during a UE requested PDU Session Establishment, one of the HTTP status code listed in Table 6.1.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain an SmContextCreateError structure, including: + +- a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.3.1-3; +- N1 SM information (PDU Session Reject), if the request included N1 SM information, except if the error prevents the SMF from generating a response to the UE (e.g. invalid request format). + +For the UE requested PDU Session Establishment, the SMF shall reject the request with "EXCEEDED\_SLICE\_DATA\_RATE" application error if the SMF receives from the PCF that the maximum bit rate per S-NSSAI is exceeded, or with "EXCEEDED\_UE\_SLICE\_DATA\_RATE" application error if the SMF receives from the PCF that the maximum bit rate per S-NSSAI per UE is exceeded. + +For the UE requested PDU Session Establishment, the SMF shall directly reject the request if the SMF supports the "PSER" feature and it has received the indication of PDU Session Establishment Rejection from the AMF in the Create SM Context request. + +#### 5.2.2.2.2 EPS to 5GS Idle mode mobility using N26 interface (with or without data forwarding) + +The NF Service Consumer (e.g. AMF) shall request the SMF to move a UE EPS PDN connection to 5GS using N26 interface, as follows. + +![Sequence diagram showing EPS to 5GS Idle mode mobility using N26 interface. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 201 Created or a 4xx/5xx error. A note indicates that if the request is accepted and the UP connection is to be reactivated, upCnxState = ACTIVATING. The diagram then points to steps 3 to 4 of Figure 5.2.2.3.2.2-1.](7ede87328f6b696dcffa65ebc4570cc8_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of SMF: If request accepted and UP connection to be reactivated: upCnxState = ACTIVATING + NF Service Consumer->>SMF: 1. POST .../sm-contexts (SmContextCreateData) + SMF-->>NF Service Consumer: 2a. 201 Created (SmContextCreatedData) + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextCreateError) or 3xx + Note bottom: Step 3 to 4 of Figure 5.2.2.3.2.2-1 + +``` + +Sequence diagram showing EPS to 5GS Idle mode mobility using N26 interface. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 201 Created or a 4xx/5xx error. A note indicates that if the request is accepted and the UP connection is to be reactivated, upCnxState = ACTIVATING. The diagram then points to steps 3 to 4 of Figure 5.2.2.3.2.2-1. + +**Figure 5.2.2.2.2-1: EPS to 5GS Idle mode mobility using N26 interface** + +1. The NF Service Consumer shall send a POST request towards the SMF (+PGW-C) of each UE EPS PDN connection, as specified in clause 5.2.2.2.1, with the following additional information: + - UE EPS PDN connection, including the EPS bearer contexts, received from the MME, representing the individual SM context resource to be created; + - the pduSessionsActivateList attribute, including the PDU Session ID of all the PDU session(s) to be re-activated; + - the epsBearerCtxStatus attribute, indicating the status of all the EPS bearer contexts in the UE, if corresponding information is received in the Registration Request from the UE; + - the dlDataWaitingInd attribute, indicating that DL data buffered in EPS needs to be forwarded to the UE, if such indication is present in the Context Response received from the MME. +- 2a. Upon receipt of such a request, if: + +- a corresponding PDU session is found based on the EPS bearer contexts (after invoking a Create service operation towards the H-SMF for a Home Routed PDU session, or towards the SMF for a PDU session with an I-SMF); +- the default EPS bearer context of the corresponding PDU session is not reported as inactive by the UE in the epsBearerCtxStatus attribute, if received; and +- it is possible to proceed with moving the PDN connection to 5GS, + +then the SMF shall return a 201 Created response including the following information: + +- PDU Session ID corresponding to the default EPS bearer ID of the EPS PDN connection; +- S-NSSAI assigned to the PDU session; in home routed roaming case, the S-NSSAI for home PLMN shall be returned; +- the allocatedEbiList attribute, containing the EBI(s) allocated to the PDU session; + +and, if the PDU session that is derived by the SMF based on the EPS bearer contexts was requested to be re-activated, i.e. if the PDU Session ID was present in the pduSessionsActivateList, or if DL data buffered in EPS needs to be forwarded to the UE: + +- the upCnxState attribute set to ACTIVATING; +- N2 SM information to request the 5G-AN to assign resources to the PDU session (see PDU Session Resource Setup Request Transfer IE in clause 9.3.4.1 of 3GPP TS 38.413 [9]), including (among others) the transport layer address and tunnel endpoint of the uplink termination point for the user plane data for this PDU session (i.e. UPF's GTP-U F-TEID for uplink traffic). + +The "Location" header shall be present in the POST response and shall contain the URI of the created SM context resource. + +If the epsBearerCtxStatus attribute is received in the request, the SMF shall check whether some EPS bearer(s) of the corresponding PDU session have been deleted by the UE but not notified to the EPS, and if so, the SMF shall release these EPS bearers, corresponding QoS rules and QoS flow level parameters locally, as specified in clause 4.11.1.3.3 of 3GPP TS 23.502 [3]. + +The NF Service Consumer (e.g. AMF) shall store the association of the PDU Session ID and the SMF ID, and store the allocated EBI(s) associated to the PDU Session ID. + +NOTE: The behaviour specified in this step also applies if the POST request collides with an existing SM context, i.e. if the POST request includes the same SUPI, or PEI for an emergency registered UE without a UICC or without an authenticated SUPI, and the default EPS bearer ID received in the UE EPS PDN connection is the same as in the existing SM context. + +2b. Same as step 2b of figure 5.2.2.2.1-1. Steps 3 to 4 are skipped in this case. + +If the SMF determines that seamless session continuity from EPS to 5GS is not supported for the PDU session, the SMF shall set the "cause" attribute in the ProblemDetails structure to "NO\_EPS\_5GS\_CONTINUITY". + +If the default EPS bearer context of the PDU session is reported as inactive by the UE in the epsBearerCtxStatus attribute, the SMF shall set the "cause" attribute in the ProblemDetails structure to "DEFAULT\_EPS\_BEARER\_INACTIVE". + +3. Same as step 3 of figure 5.2.2.3.2.2-1, if the SMF returned a 201 Created response with the upConnectionState set to ACTIVATING and N2 SM Information, +4. Same as step 4 of figure 5.2.2.3.2.2-1. During an EPS to 5GS Idle mode mobility using N26 interface with data forwarding (see clause 4.11.1.3.3A of 3GPP TS 23.502 [3]), the 200 OK response shall additionally contain the CN tunnel information for data forwarding from EPS, i.e. the forwardingFteid attribute or the forwarding bearer contexts to be sent to the MME in the Context Acknowledge, based on the association between the EPS bearer ID(s) and QFI(s) for the QoS flow(s). + +### 5.2.2.2.3 EPS to 5GS Handover Preparation using N26 interface + +The NF Service Consumer (e.g. AMF) shall request the SMF to handover a UE EPS PDN connection to 5GS using N26 interface, as follows. + +![Sequence diagram showing EPS to 5GS handover preparation using N26 interface. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 201 Created or an error. A dashed box indicates steps 3 to 4 of Figure 5.2.2.3.8.2-1.](d9c0a780cd22626253dab4aa41699e2f_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of SMF: If request accepted: +hoState = PREPARING + NF Service Consumer->>SMF: 1. POST .../sm-contexts (SmContextCreateData) + SMF-->>NF Service Consumer: 2a. 201 Created (SmContextCreatedData) + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextCreateError) or 3xx + Note over NF Service Consumer, SMF: Steps 3 to 4 of Figure 5.2.2.3.8.2-1 + +``` + +Sequence diagram showing EPS to 5GS handover preparation using N26 interface. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 201 Created or an error. A dashed box indicates steps 3 to 4 of Figure 5.2.2.3.8.2-1. + +**Figure 5.2.2.2.3-1: EPS to 5GS handover using N26 interface** + +- The NF Service Consumer shall send a POST request, as specified in clause 5.2.2.2.1, with the following additional information: + +- UE EPS PDN connection, including the EPS bearer contexts, representing the individual SM context resource to be created; +- hoState attribute set to PREPARING (see clause 5.2.2.3.4.1); +- the indication of whether direct or indirect DL data forwarding applies; +- targetId identifying the target RAN Node ID and TAI based on the Target ID IE received in the Forward Relocation Request message from the source MME. + +NOTE 1: The Target ID IE can be set to the Target NG-RAN Node ID containing a Global RAN Node ID and selected TAI with 3-octets length, or the Target eNB ID containing a Global eNB ID and selected TAI with 2-octets length; for the latter case, the NF Service Consumer, i.e. the AMF needs determine a value for the Target NG-RAN Node ID and TAI with 3-octets length based on the local configuration to be provided to the SMF. + +- Upon receipt of such a request, if a corresponding PDU session is found based on the EPS bearer contexts (after invoking a Create service operation towards the H-SMF, for a Home Routed PDU session) and it is possible to proceed with handing over the PDN connection to 5GS, the SMF shall return a 201 Created response including the following information: + +- hoState attribute set to PREPARING and N2 SM information to request the target 5G-AN to assign resources to the PDU session, as specified in step 2 of Figure 5.2.2.3.4.2-1; if the SMF was indicated in step 1 that direct data forwarding is applicable, the SMF shall include an indication that a direct forwarding path is available in the N2 SM information; +- PDU Session ID corresponding to the default EPS bearer ID of the EPS PDN connection; +- S-NSSAI assigned to the PDU session; in home routed roaming case, the S-NSSAI for home PLMN shall be returned; +- allocatedEbiList, containing the EBI(s) allocated to the PDU session; +- optional udmGroupId, containing the identity of the UDM group serving the UE, to facilitate the UDM selection at the target AMF; +- optional pcfGroupId, containing the identity of the PCF group for Session Management Policy for the PDU session, to facilitate the PCF selection at the target AMF. + +The "Location" header shall be present in the POST response and shall contain the URI of the created SM context resource. + +The NF Service Consumer (e.g. AMF) shall store the association of the PDU Session ID and the SMF ID, and store the allocated EBI(s) associated to the PDU Session ID. + +NOTE 2: The behaviour specified in this step also applies if the POST request collides with an existing SM context, i.e. if the POST request includes the same SUPI, or PEI for an emergency registered UE without a UICC or without an authenticated SUPI, and the default EPS bearer ID received in the UE EPS PDN connection is the same as in the existing SM context. + +2b. Same as step 2b of figure 5.2.2.2.1-1 with the following additions. Steps 3 and 4 of figure 5.2.2.3.8.2-1 are skipped in this case. + +If the SMF determines that seamless session continuity from EPS to 5GS is not supported for the PDU session, the SMF shall set the "cause" attribute in the ProblemDetails structure to "NO\_EPS\_5GS\_CONTINUITY". + +When receiving a 4xx/5xx response from the SMF, the NF service consumer (e.g. the AMF) shall regard the hoState of the SM Context to be NONE. + +#### 5.2.2.2.4 I-SMF Insertion, Change or Removal during Xn based Handover + +The NF Service Consumer (e.g. AMF) shall request the I-SMF (for I-SMF insertion or change) or the SMF (for I-SMF removal) to create a SM context during Xn based handover, as follows. + +1. The NF Service Consumer shall send a POST request, with the following additional information: + +- N2 SM information received from the target 5G-AN (see Path Switch Request Transfer IE in clause 9.3.4.8 of 3GPP TS 38.413 [9]); +- additional N2 SM information received from the source 5G-AN (see Secondary RAT Data Usage Report Transfer IE in clause 9.3.4.23 of 3GPP TS 38.413 [9]), if any; +- the smContextRef attribute set to the identifier of the SM Context resource in the SMF during I-SMF insertion, or the SM Context resource in the source I-SMF during I-SMF change or removal, and optionally the NF instance identifier of the SMF hosting the SM Context resource; +- the smfUri IE attribute set to the API URI of the Nsmf\_PDUSession service of the SMF during I-SMF insertion or change, and optionally the NF instance identifier of the SMF, if the "ACSCR" feature is not supported by the AMF and I-SMF. + +2a. On success, the SMF shall return a 201 Created response. + +The "Location" header shall be present in the POST response and shall contain the URI of the created SM context resource. + +The NF Service Consumer (e.g. AMF) shall store the association of the PDU Session ID and the SMF ID. + +2b. Same as step 2b of figure 5.2.2.2.1-1. + +If the Path Switch Request Transfer IE is included within the N2 SM Information in the request message but the path switch failed, the message body shall contain an SmContextCreateError structure, including: + +- N2 SM information (Path Switch Request Unsuccessful Transfer). + +#### 5.2.2.2.5 I-SMF Insertion, Change or Removal during N2 based Handover + +The NF Service Consumer (e.g. AMF) shall request the I-SMF (for I-SMF insertion or change) or the SMF (for I-SMF removal) to create a SM context during N2 based handover, as follows. + +1. The NF Service Consumer shall send a POST request, with the following additional information: + +- N2 SM information received from the source NG-RAN (see Handover Required Transfer IE in clause 9.3.4.14 of 3GPP TS 38.413 [9]); + +- the hoState attribute set to PREPARING (see clause 5.2.2.3.4.1); +- the smContextRef attribute set to the identifier of the SM Context resource in the SMF during I-SMF insertion,,or the SM Context resource in the source I-SMF during I-SMF change or removal, and optionally the NF instance identifier of the SMF hosting the SM Context resource; +- the smfUri IE attribute set to the API URI of the Nsmf\_PDUSession service of the SMF during I-SMF insertion or change, and optionally the NF instance identifier of the SMF, if the "ACSCR" feature is not supported by the AMF and I-SMF. + +2a. On success, the SMF shall return a 201 Created response including the following information: + +- hoState attribute set to PREPARING and N2 SM information to request the target 5G-AN to assign resources to the PDU session, as specified in step 2 of Figure 5.2.2.3.4.2-1; + +The "Location" header shall be present in the POST response and shall contain the URI of the created SM context resource. + +The NF Service Consumer (e.g. AMF) shall store the association of the PDU Session ID and the SMF ID. + +2b. Same as step 2b of figure 5.2.2.2.1-1. + +#### 5.2.2.2.6 Service Request with I-SMF insertion/change/removal or with V-SMF change + +The NF Service Consumer (e.g. AMF) shall request the new I-SMF or new V-SMF to create a SM context during a Service Request with I-SMF insertion/change or with V-SMF change, or shall request the SMF to create a SM context during a Service Request with I-SMF removal, as follows. + +![Sequence diagram for Service Request with I-SMF insertion/change/removal or with V-SMF change. The diagram shows the interaction between an NF Service Consumer and an SMF. Step 1: The NF Service Consumer sends a POST request to the SMF with the path ../sm-contexts and the body SmContextCreateData. Step 2a: The SMF responds with a 201 Created status and the body SmContextCreatedData. A note indicates that if the request is accepted, upCnxState is set to ACTIVATING. Step 2b: The SMF responds with a 4xx/5xx status and the body SmContextCreateError, or a 3xx status. A note indicates that steps 3 to 4 of Figure 5.2.2.3.2.2-1 follow.](303fadfb9def251d1575d6221199b158_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of SMF: If request accepted: +upCnxState = ACTIVATING + Note left of NF Service Consumer: Step 3 to 4 of Figure 5.2.2.3.2.2-1 + NF Service Consumer->>SMF: 1. POST ../sm-contexts (SmContextCreateData) + SMF-->>NF Service Consumer: 2a. 201 Created (SmContextCreatedData) + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextCreateError) or 3xx + +``` + +Sequence diagram for Service Request with I-SMF insertion/change/removal or with V-SMF change. The diagram shows the interaction between an NF Service Consumer and an SMF. Step 1: The NF Service Consumer sends a POST request to the SMF with the path ../sm-contexts and the body SmContextCreateData. Step 2a: The SMF responds with a 201 Created status and the body SmContextCreatedData. A note indicates that if the request is accepted, upCnxState is set to ACTIVATING. Step 2b: The SMF responds with a 4xx/5xx status and the body SmContextCreateError, or a 3xx status. A note indicates that steps 3 to 4 of Figure 5.2.2.3.2.2-1 follow. + +**Figure 5.2.2.2.6-1: Service Request with I-SMF insertion/change/removal or with V-SMF change** + +1. The NF Service Consumer shall send a POST request as specified in clause 5.2.2.2.1, with the following additional information: + +- the smContextRef attribute set to the identifier of the SM Context resource in the SMF (for a Service Request with an I-SMF insertion) or in the old I-SMF (for a Service Request with an I-SMF change or removal) or in the old V-SMF (for a Service Request with a V-SMF change), and optionally the NF instance identifier of the SMF hosting the SM Context resource. +- the upCnxState attribute set to ACTIVATING (see clause 5.2.2.3.2.1) to indicate the establishment of N3 tunnel User Plane resources for the PDU Session; +- the smfUri IE attribute set to the API URI of the Nsmf\_PDUSession service of the SMF (for a Service Request with an I-SMF insertion or change), and optionally the NF instance identifier of the SMF, if the "ACSCR" feature is not supported by the AMF and I-SMF; +- the hSmfUri IE attribute set to the API URI of the Nsmf\_PDUSession service of the H-SMF (for a Service Request with an V-SMF change), and optionally the NF instance identifier of the H-SMF, if the "ACSCR" feature is not supported by the AMF and V-SMF. + +- 2a. On success, the SMF shall return a 201 Created response as specified in clause 5.2.2.2.1 with the following additional information: + - the upCnxState attribute set to ACTIVATING; + - N2 SM information to request the 5G-AN to assign resources to the PDU session (see PDU Session Resource Setup Request Transfer IE in clause 9.3.4.1 of 3GPP TS 38.413 [9]), including the transport layer address and tunnel endpoint of the uplink termination point for the user plane data for this PDU session (i.e. UPF's GTP-U F-TEID for uplink traffic). +- 2b. Same as step 2b of figure 5.2.2.2.1-1. Steps 3 to 4 of figure 5.2.2.3.2.2-1 are skipped in this case. + +#### 5.2.2.2.7 Registration procedure for a UE with a PDU session with I-SMF or V-SMF insertion, change and removal + +The NF Service Consumer (e.g. AMF) shall request the SMF to create a SM context during UE Registration procedure for a PDU session with I-SMF or V-SMF insertion, change and removal, as follows. + +1. Same as step 1 of 5.2.2.2.1-1, the NF Service Consumer shall send a POST request, with the following additional information: + - the smContextRef attribute set to the identifier of the SM Context resource in the SMF during I-SMF or V-SMF insertion or the SM Context resource in the I-SMF or V-SMF during I-SMF or V-SMF removal or the SM Context resource in the old I-SMF or old V-SMF during I-SMF or V-SMF change, and optionally the NF instance identifier of the SMF hosting the SM Context resource; + - the upCnxState attribute set to ACTIVATING (see clause 5.2.2.3.2.1) to indicate the establishment of N3 tunnel User Plane resources for the PDU Session, if the UE requested to activate the PDU session; + - if the UE is in CM-CONNECTED state during the registration procedure after an EPS to 5GS handover (see clause 4.11.1.3.3 of 3GPP TS 23.502 [3]), the ranUnchangedInd attribute shall be set to indicate that NG-RAN is not changed for the PDU Session (i.e. for this case, the NG-RAN tunnel info shall be included in SM context retrieved from old I-SMF, or old V-SMF or SMF); + - the smfUri IE attribute set to the API URI of the Nsmf\_PDUSession service of the SMF during I-SMF insertion or change, and optionally the NF instance identifier of the SMF, if the "ACSCR" feature is not supported by the AMF and I-SMF. +- 2a. On success, the SMF shall return a 201 Created response. + +If the SMF establishes N3 tunnel User Plane resources for the PDU Session, e.g. due to the NF Service Consumer requesting so or due to buffered DL data in the old I-SMF/I-UPF or old V-SMF/V-UPF (see clause 4.23.3 of 3GPP TS 23.502 [3]), the 201 Created response shall contain the following additional information: + +- the upCnxState attribute set to ACTIVATING; +- N2 SM information to request the 5G-AN to assign resources to the PDU session (see PDU Session Resource Setup Request Transfer IE in clause 9.3.4.1 of 3GPP TS 38.413 [9]), including the transport layer address and tunnel endpoint of the uplink termination point for the user plane data for this PDU session (i.e. UPF's GTP-U F-TEID for uplink traffic). + +If the SMF receives the ranUnchangedInd attribute set to indicate that NG-RAN is not changed for the PDU Session, the SMF shall respond with a 201 Created with the following additional information: + +- N2 SM information to request the 5G-AN to update UPF tunnel info of the PDU session (see PDU Session Resource Modify Request Transfer IE in clause 9.3.4.3 of 3GPP TS 38.413 [9]), including the transport layer address and tunnel endpoint of the uplink termination point for the user plane data for this PDU session (i.e. UPF's GTP-U F-TEID for uplink traffic and NG-RAN's GTP-U F-TEID for downlink traffic). + +The "Location" header shall be present in the POST response and shall contain the URI of the created SM context resource. + +The NF Service Consumer (e.g. AMF) shall store the association of the PDU Session ID and the SMF ID. + +2b. Same as step 2b of figure 5.2.2.2.1-1. + +#### 5.2.2.2.8 SMF Context Transfer procedure, LBO or no Roaming, no I-SMF + +The NF Service Consumer (e.g. AMF) shall request the SMF to create a SM context during an SMF Context Transfer procedure, LBO or no Roaming, no I-SMF, as follows. + +1. Same as step 1 of 5.2.2.2.1-1, the NF Service Consumer shall send a POST request, with the following additional information: + +- SMF transfer indication, Old SMF ID, the identifier of the SM Context resource in old SMF. + +2a. On success, the SMF shall return a 201 Created response. + +The "Location" header shall be present in the POST response and shall contain the URI of the created SM context resource. + +The NF Service Consumer (e.g. AMF) shall store the association of the PDU Session ID and the SMF ID. + +2b. Same as step 2b of figure 5.2.2.2.1-1. + +#### 5.2.2.2.9 I-SMF Context Transfer procedure + +The NF Service Consumer (e.g. AMF) shall request the SMF to create a SM context during I-SMF Context Transfer procedure, as follows. + +1. Same as step 1 of 5.2.2.2.1-1, the NF Service Consumer shall send a POST request, with the following additional information: + +- SMF transfer indication, Old SMF ID, the identifier of the SM Context resource in old SMF. + +2a. On success, the SMF shall return a 201 Created response. + +The "Location" header shall be present in the POST response and shall contain the URI of the created SM context resource. + +The NF Service Consumer (e.g. AMF) shall store the association of the PDU Session ID and the SMF ID. + +2b. Same as step 2b of figure 5.2.2.2.1-1. + +#### 5.2.2.2.10 Handover between 3GPP and non-3GPP accesses with I-SMF insertion/removal or V-SMF change + +The NF Service Consumer (e.g. AMF) shall request the I-SMF (for I-SMF insertion during a handover from non-3GPP to 3GPP access), the V-SMF (for V-SMF change during a handover from non-3GPP to 3GPP access) or the SMF (for I-SMF removal during a handover from 3GPP to non-3GPP access) to create a SM context as follows. + +1. The NF Service Consumer shall send a POST request as specified in clause 5.2.2.2.1, with the following additional information: + +- the smContextRef attribute set to the identifier of the SM Context resource in the SMF (during I-SMF insertion), the SM Context resource in the source I-SMF during I-SMF removal, or the SM Context resource in the source V-SMF during V-SMF change, and optionally the NF instance identifier of the SMF hosting the SM Context resource; +- the smfUri IE attribute set to the API URI of the Nsmf\_PDUSession service of the SMF (during I-SMF insertion), and optionally the NF instance identifier of the SMF, if the "ACSCR" feature is not supported by the AMF and I-SMF; +- the hSmfUri IE attribute set to the API URI of the Nsmf\_PDUSession service of the H-SMF (during V-SMF change), and optionally the NF instance identifier of the H-SMF, if the "ACSCR" feature is not supported by the AMF and V-SMF. + +2a. Same as step 2a of figure 5.2.2.2.1-1. + +2b. Same as step 2b of figure 5.2.2.2.1-1. + +The SMF (for I-SMF removal during a handover from 3GPP to non-3GPP access) may perform Network Slice Admission Control before the PDU Session is moved to the target access (i.e., before the N3 tunnel for the PDU Session is established). + +#### 5.2.2.2.11 Void + +#### 5.2.2.2.12 SMF triggered I-SMF selection/removal or V-SMF selection + +The NF Service Consumer (e.g. AMF) shall invoke the following procedure to request: + +- the new I-SMF to create a SM context if the SMF (or the associated old I-SMF) cannot serve the target DNAI; or +- the SMF to create the SM context if an I-SMF is used for the PDU Session and the SMF itself can serve the target DNAI hence the existing I-SMF is no longer needed; or +- the SMF to create the SM context if an I-SMF is used for the PDU Session and the DNAI currently served by I-SMF is not used for the PDU Session anymore, hence the existing I-SMF is not needed; or +- the new V-SMF to create a SM context if the associated old V-SMF cannot serve the target DNAI. + +![Sequence diagram showing the interaction between an NF Service Consumer and an SMF for I-SMF selection/removal or V-SMF selection per DNAI. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 201 Created response or an error response (4xx/5xx or 3xx).](9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note left of NF Service Consumer: Request SM context creation + NF Service Consumer->>SMF: 1. POST ../sm-contexts (SmContextCreateData) + Note right of SMF: Processing... + SMF-->>NF Service Consumer: 2a. 201 Created (SmContextCreatedData) + Note right of SMF: Error handling + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextCreateError) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an SMF for I-SMF selection/removal or V-SMF selection per DNAI. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 201 Created response or an error response (4xx/5xx or 3xx). + +**Figure 5.2.2.2.12-1: I-SMF selection/removal or V-SMF selection per DNAI** + +1. The NF Service Consumer shall send a POST request as defined in step 1 of Figure 5.2.2.2.6-1, with the following additional information: + - the smContextRef attribute set to the identifier of the SM Context resource in the SMF during I-SMF insertion, or the SM Context resource in the source I-SMF during I-SMF change/removal, or the SM Context resource in the source V-SMF during V-SMF change, and optionally the NF instance identifier of the SMF hosting the SM Context resource; + - the target DNAI, if it is received in the targetDnaiInfo attribute of the SM context status notification; + - if the UE is in CM-CONNECTED state, the ranUnchangedInd attribute shall be set to indicate that NG-RAN is not changed for the PDU Session (i.e. for this case, the NG-RAN tunnel info shall be included in SM context retrieved from old I-SMF, old V-SMF or SMF) as specified in clause 4.23.5.4 of 3GPP TS 23.502 [3] and clause 6.7.3.2 of 3GPP TS 23.548 [74]; + - the smfUri IE attribute set to the API URI of the Nsmf\_PDUSession service of the SMF (during I-SMF insertion/change, or V-SMF change), and optionally the NF instance identifier of the SMF, if the "ACSCR" feature is not supported by the AMF, I-SMF or V-SMF. +- 2a. On success, the SMF shall return a 201 Created response, with the following additional information: + +If the SMF receives the ranUnchangedInd attribute set to indicate that NG-RAN is not changed for the PDU Session, the SMF shall include the N2 SM information to request the 5G-AN to update UPF tunnel info of the PDU session (see PDU Session Resource Modify Request Transfer IE in clause 9.3.4.3 of 3GPP TS 38.413 [9]), including the transport layer address and tunnel endpoint of the uplink termination point for the user plane data for this PDU session (i.e. UPF's GTP-U F-TEID for uplink traffic and NG-RAN's GTP-U F-TEID for downlink traffic). + +The "Location" header shall be present in the POST response and shall contain the URI of the created SM context resource. + +The NF Service Consumer (e.g. AMF) shall store the association of the PDU Session ID and the SMF ID. + +2b. Same as step 2b of figure 5.2.2.2.1-1. + +## 5.2.2.3 Update SM Context service operation + +### 5.2.2.3.1 General + +The Update SM Context service operation shall be used to update an individual SM context and/or provide N1 or N2 SM information received from the UE or the AN, for a given PDU session, towards the SMF, or the V-SMF for HR roaming scenarios, or the I-SMF for a PDU session with an I-SMF. + +It is used in the following procedures: + +- PDU Session modification (see clause 4.3.3 of 3GPP TS 23.502 [3]); +- UE or network requested PDU session release (see clause 4.3.4.2 and clause 4.3.4.3 of 3GPP TS 23.502 [3]); +- UE requested MA PDU session establishment over the other access (see clause 4.22.7 of 3GPP TS 23.502 [3]); +- UE or network-initiated MA PDU session release over a single access (see clause 4.22 of 3GPP TS 23.502 [3]); +- Activation or Deactivation of the User Plane connection of an existing PDU session, i.e. establishment or release of the N3 tunnel between the AN and serving CN (see clause 5.6.8 of 3GPP TS 23.501 [2], clauses 4.2.2.2, 4.2.3, 4.2.6, 4.2.10 and 4.9.1.3.3 of 3GPP TS 23.502 [3], clauses 7.2.2.1, 7.2.2.2, 7.2.5.2 and 7.2.5.3 of 3GPP TS 23.316 [36]) and clause 7.2.5.2 of 3GPP TS 23.247 [44]; +- Xn and N2 Handover procedures (see clauses 4.9.1, 4.23.7 and 4.23.11 of 3GPP TS 23.502 [3]); +- Handover between 3GPP and untrusted non-3GPP access procedures (see clause 4.9.2 of 3GPP TS 23.502 [3]); +- Inter-AMF change due to AMF planned maintenance or AMF failure (see clause 5.21.2 of 3GPP TS 23.501 [2]), or inter-AMF mobility in CM-IDLE mode (see clauses 4.2.2.2 and 4.23.3 of 3GPP TS 23.502 [3]); +- RAN Initiated QoS Flow Mobility (see clause 4.14.1 of 3GPP TS 23.502 [3] and clause 8.2.5 of 3GPP TS 38.413 [9]); +- All procedures requiring to provide N1 or N2 SM information to the SMF, e.g. UE requested PDU Session Establishment procedure (see clause 4.3.2.2 of 3GPP TS 23.502 [3]), USS UAV Authorization/Authentication (UUAA) to carry the UUAA authentication message during the PDU Session Establishment (see clause 5.2.3.2 of 3GPP TS 23.256 [41] and Service-level-AA container in 3GPP TS 24.501 [7]), session continuity procedure (see clause 4.3.5 of 3GPP TS 23.502 [3]); +- EPS to 5GS Idle mode mobility, EPS to 5GS Idle mode mobility with data forwarding or handover using N26 interface (see clause 4.11 of 3GPP TS 23.502 [3]); +- 5GS to EPS Handover using N26 interface (see clause 4.11.1.2 of 3GPP TS 23.502 [3]); +- 5GS to EPS Idle mode mobility using N26 interface with data forwarding (see clause 4.11.1.3.2A of 3GPP TS 23.502 [3]); +- PDU Session Reactivation during P-CSCF Restoration procedure via AMF (see clause 5.8.4.3 of 3GPP TS 23.380 [21]); +- AMF requested PDU session release due to a change of the set of network slices for a UE where a network slice instance is no longer available (see clause 4.3.4.2 of 3GPP TS 23.502 [3]); +- AMF receives an "initial request" with PDU Session Id which already exists in PDU session context of the UE (see clause 5.4.5.2.5 of 3GPP TS 24.501 [7]); +- Secondary RAT Usage Data Reporting (see clause 4.21 of 3GPP TS 23.502 [3]); + +- Service Request Procedures with I-SMF change or I-SMF removal when downlink data packets are buffered at the I-UPF (See clause 4.23.4 of 3GPP TS 23.502 [3]); +- Connection Suspend procedure (see clause 4.8.1.2 of 3GPP TS 23.502 [3]); +- Connection Resume in CM-IDLE with Suspend procedure (see clause 4.8.2.3 of 3GPP TS 23.502 [3]); +- 5G-RG or Network requested PDU Session Modification via W-5GAN (see clause 7.3.2 of 3GPP TS 23.316 [36]); +- 5G-RG or Network requested PDU Session Release via W-5GAN (see clause 7.3.3 of 3GPP TS 23.316 [36]); +- FN-RG or Network requested PDU Session Modification via W-5GAN (see clause 7.3.6 of 3GPP TS 23.316 [36]); +- FN-RG or Network requested PDU Session Release via W-5GAN (see clause 7.3.7 of 3GPP TS 23.316 [36]); +- Handover between 3GPP access/5GC and W-5GAN access (see clause 7.6.3 of 3GPP TS 23.316 [36]); +- AMF requested PDU session release due to Network Slice-Specific (Re-)Authentication and (Re-)Authorization failure or revocation (see clauses 4.2.9.2, 4.2.9.3 and 4.2.9.4 of 3GPP TS 23.502 [3]); +- 5G-RG requested PDU Session Establishment via W-5GAN (see clause 7.3.1 of 3GPP TS 23.316 [36]); +- FN-RG related PDU Session Establishment via W-5GAN (see clause 7.3.4 of 3GPP TS 23.316 [36]); +- Non-5G capable device behind 5G-CRG and FN-CRG requested PDU Session Establishment via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [36]); +- Non-5G capable device behind 5G-CRG and FN-CRG or Network requested PDU Session Modification via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [36]); +- Non-5G capable device behind 5G-CRG and FN-CRG or Network requested PDU Session Release via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [36]); +- CN-initiated selective deactivation of UP connection of an existing PDU Session associated with W-5GAN Access (see clause 7.3.5 of 3GPP TS 23.316 [36]); +- Handover between 3GPP access / EPS and W-5GAN/5GC access (see clause 7.6.4 of 3GPP TS 23.316 [36]); +- AMF requested PDU session release due to Control Plane Only indication associated with PDU Session is not applicable any longer as described in 3GPP TS 23.501 [2] clause 5.31.4.1; +- Subscribe to / unsubscribe from the DDN failure status notification (see clauses 4.15.3.2.7 and 4.15.3.2.9 of 3GPP TS 23.502 [3]); +- AMF requested PDU session release due to ODB changes (see clause 2.6C.2 of 3GPP TS 23.015 [42]); +- Simultaneous change of Branching Points or UL CLs controlled by different I-SMFs (see clause 4.23.9.5 of 3GPP TS 23.502 [3]); +- Remote UE Report during 5G ProSe Communication via 5G ProSe Layer-3 UE-to-Network Relay without N3IWF (see clause 6.5.1.1 of 3GPP TS 23.304 [43]); +- Multicast Session join and session establishment procedure in clause 7.2.1.3 of 3GPP TS 23.247 [44]; +- Multicast MBS session leave and release procedure in clause 7.2.2 of 3GPP TS 23.247 [44]; +- MBS session activation procedure in clause 7.2.5.2 of 3GPP TS 23.247 [44]; +- Mobility procedures for MBS in clause 7.2.3 of 3GPP TS 23.247 [44]; +- Connection Inactive procedure with CN based MT communication handling in clause 4.8.1.1a of 3GPP TS 23.502 [3]; +- UE Triggered Connection Resume in RRC Inactive procedure in clause 4.8.2.2 of 3GPP TS 23.502 [3]; + +- Network Slice Replacement, see clause 5.15.19 of 3GPP TS 23.501 [2]; +- AMF requested PDU Session release due to MBSR not authorized as described in clause 5.35A.4 of 3GPP TS 23.501 [2] and in clause 4.3.4.2 of 3GPP TS 23.502 [3]. + +The NF Service Consumer (e.g. AMF) shall update an individual SM context and/or provide N1 or N2 SM information to the SMF by using the HTTP POST method (modify custom operation) as shown in Figure 5.2.2.3.1-1. + +![Sequence diagram showing the SM context update process between an NF Service Consumer and an SMF. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 204 No Content or 200 OK (SmContextUpdatedData) on success, or a 4xx/5xx (SmContextUpdateError) or 3xx on failure or redirection.](3cc095fb84e92690c9d49d3e17c0f1dc_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer + participant SMF as SMF + Note right of SMF: 1. POST .../sm-contexts/{smContextRef}/modify +(SmContextUpdateData) + SMF-->>NFSC: 2a. 204 No Content or 200 OK (SmContextUpdatedData) + Note right of SMF: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + SMF-->>NFSC: + +``` + +Sequence diagram showing the SM context update process between an NF Service Consumer and an SMF. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 204 No Content or 200 OK (SmContextUpdatedData) on success, or a 4xx/5xx (SmContextUpdateError) or 3xx on failure or redirection. + +**Figure 5.2.2.3.1-1: SM context update** + +- The NF Service Consumer shall send a POST request to the resource representing the individual SM context resource in the SMF. The content of the POST request shall contain the modification instructions and/or the N1 or N2 SM information, or the indication that the PDU session is allowed to be upgraded to a MA PDU session if so indicated by the UE as specified in clause 6.4.2.2 of 3GPP TS 24.501 [7], or subscribe/unsubscribe of the DDN failure notification as specified in clause 4.15.3.2.7 of 3GPP TS 23.502 [3]. If the request contains EBI(s) to revoke, then the SMF shall disassociate the EBI(s) with the QFI(s) with which they are associated. +- On success, "204 No Content" or "200 OK" shall be returned; in the latter case, the content of the POST response shall contain the representation describing the status of the request and/or N1 or N2 SM information. + +If the ExemptionInd IE is included in the request message, indicating that the NAS SM message included in the request was exempted from NAS congestion control by the AMF, the SMF shall verify that the included 5G SM message can be exempted from a NAS SM congestion control activated in the AMF as specified in clause 5.19.7 of 3GPP TS 23.501 [2]. + +The SMF may indicate to the NF Service Consumer that it shall release EBI(s) that were assigned to the PDU session by including the releaseEbiList IE, e.g. when a QoS flow is released. + +- On failure or redirection, one of the HTTP status codes listed in Table 6.1.3.3.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain an SmContextUpdateError structure, including: + +- a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.4.2.2-2; +- N1 SM information, if the SMF needs and can return a response to the UE; +- N2 SM information, if the SMF needs and can return a response to the NG-RAN. + +The following clauses specify additional requirements applicable to specific scenarios. + +### 5.2.2.3.2 Activation and Deactivation of the User Plane connection of a PDU session + +#### 5.2.2.3.2.1 General + +The upCnxState attribute of an SM context represents the state of the User Plane connection of the PDU session. The upCnxState attribute may take the following values: + +- ACTIVATED: a N3 tunnel is established between the 5G-AN and UPF (F-TEIDs assigned for both uplink and downlink traffic); +- DEACTIVATED: no N3 tunnel is established between the 5G-AN and UPF; +- ACTIVATING: a N3 tunnel is being established (5G-AN's F-TEID for downlink traffic is not assigned yet). + +Clauses 5.2.2.3.2.2 and 5.2.2.3.2.3 specify how the NF Service Consumer (e.g. AMF) request the SMF to activate or deactivate the User Plane connection of the PDU session, e.g. upon receiving a Service Request from the UE requesting to activate a PDU session or upon an AN release procedure respectively. Clause 5.2.2.3.2.3 also applies in case of 5G-AN requested PDU session resource release by sending the NGAP PDU SESSION RESOURCE NOTIFY to the AMF (see step 1d in clause 4.3.4.2 of 3GPP TS 23.502 [3]). + +In scenarios where the SMF takes the initiative to activate or deactivate the User Plane connection of the PDU session, e.g. during a Network Triggered Service Request or CN-initiated selective deactivation of the User Plane connection of a PDU session respectively, the SMF invokes the Namf\_N1N2MessageTransfer procedure with the inclusion of N2 SM Information (and optionally of a N1 SM Container) as specified in 3GPP TS 23.502 [3] to request the establishment or release of the PDU session's resources in the 5G-AN. The Update SM Context service operation is then used as specified in clause 5.2.2.3.1 to transfer the response to the SMF. + +Clause 5.2.2.3.2.4 specifies how the NF Service Consumer (e.g. AMF) indicates to the SMF that the access type of a PDU session can be changed from non-3GPP access to 3GPP access, during a Network Triggered Service Request initiated for a PDU session associated to the non-3GPP access, if the PDU Session for which the UE was paged or notified is in the List Of Allowed PDU Sessions provided by the UE and if the AMF has received N2 SM Information only or N1 SM Container and N2 SM Information for that PDU session from the SMF in step 3a of clause 4.2.3.3 of 3GPP TS 23.502 [3]. + +#### 5.2.2.3.2.2 Activation of User Plane connectivity of a PDU session + +The NF Service Consumer (e.g. AMF) shall request the SMF to activate the User Plane connection of an existing PDU session, i.e. establish the N3 tunnel between the 5G-AN and UPF, as follows. + +![Sequence diagram showing the activation of the User Plane connection of a PDU session between an NF Service Consumer and an SMF.](f0b7abcb093621bb310bf61fbe0f0d2d_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of SMF: If request accepted: +upCnxState +ACTIVATING + NF Service Consumer->>SMF: 1. POST (upCnxState=ACTIVATING) + SMF-->>NF Service Consumer: 2a. 200 OK (upCnxState=ACTIVATING, N2 SM Information) + Note right of SMF: If successful: +upCnxState +ACTIVATED + SMF-->>NF Service Consumer: 2b. 4xx/5xx (upCnxState=DEACTIVATED) or 3xx- + NF Service Consumer-->>SMF: 3. POST (N2 SM Information) + SMF-->>NF Service Consumer: 4. 200 OK (upCnxState=ACTIVATED) + +``` + +The diagram illustrates the interaction between the NF Service Consumer and the SMF for activating the User Plane connection of a PDU session. The sequence of messages is as follows: + + +- The NF Service Consumer sends a POST request with `upCnxState=ACTIVATING` to the SMF. +- The SMF responds with either a 200 OK (with `upCnxState=ACTIVATING` and N2 SM Information) or a 4xx/5xx (with `upCnxState=DEACTIVATED`) or 3xx- message. A note indicates that if the request is accepted, the `upCnxState` is ACTIVATING. +- The NF Service Consumer then sends a POST request with N2 SM Information to the SMF. +- The SMF responds with a 200 OK (with `upCnxState=ACTIVATED`). A note indicates that if successful, the `upCnxState` is ACTIVATED. + +Sequence diagram showing the activation of the User Plane connection of a PDU session between an NF Service Consumer and an SMF. + +**Figure 5.2.2.3.2.2-1: Activation of the User Plane connection of a PDU session** + +- The NF Service Consumer shall request the SMF to activate the user plane connection of the PDU session by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - the `upCnxState` attribute set to `ACTIVATING`; + - the user location and access type associated to the PDU session, if modified; + - the indication that the UE is inside or outside of the LADN service area, if the DNN of the established PDU session corresponds to a LADN; + - the access type for which the user plane connection needs to be re-activated, for a MA PDU session (i.e. the access type over which a Registration or Service Request was received); + - the "MO Exception Data Counter" if the UE has accessed the network by using "MO exception data" RRC establishment cause; + - the `n3gPathSwitchExecutionInd` IE if the AMF receives the indication "Non-3GPP access path switching while using old AN resources" in the registration request message from the UE and if the SMF supports + +non-3GPP path switching, so to request the SMF to add a new non-3GPP access path (while also keeping the existing one) during a UE requested non-3GPP access switching for a MA-PDU session; + +- other information, if necessary. + +2a. Upon receipt of such a request, if the SMF can proceed with activating the user plane connection of the PDU session (see clause 4.2.3 of 3GPP TS 23.502 [3]), the SMF shall set the upCnxState attribute to ACTIVATING and shall return a 200 OK response including the following information: + +- upCnxState attribute set to ACTIVATING; +- N2 SM information to request the 5G-AN to assign resources to the PDU session (see PDU Session Resource Setup Request Transfer IE in clause 9.3.4.1 of 3GPP TS 38.413 [9]), including the transport layer address and tunnel endpoint of the uplink termination point for the user plane data for this PDU session (i.e. UPF's GTP-U F-TEID for uplink traffic). + +If the SMF finds the PDU session already activated when receiving the request in step 1, the SMF shall delete the N3 tunnel information and update the UPF accordingly (see step 8a of clause 4.2.3.2 of 3GPP TS 23.502 [3]). + +For a MA-PDU session, the SMF shall perform the above requirements for the access type for which the user plane connection is requested to be re-activated (i.e. the access type indicated in the anTypeToReactivate attribute). The SMF shall not modify the user plane connection status for the other access type, e.g. if the user plane connection is already established for the other access type, it shall remain established. If the SMF receives the n3gPathSwitchExecutionInd IE the SMF shall not trigger the release of the UP connection in the old non-3GPP access. + +If the "MO Exception Data Counter" is included in the request and Small Data Rate Control is enabled for the PDU session, then the V-SMF/I-SMF shall forward the counter to the H-SMF/SMF. + +2b. If the request does not include the "UE presence in LADN service area" indication and the SMF determines that the DNN corresponds to a LADN, then the SMF shall consider that the UE is outside of the LADN service area. The SMF shall reject the request if the UE is outside of the LADN service area. + +If the SMF cannot proceed with activating the user plane connection of the PDU session (e.g. if the PDU session corresponds to a PDU session of SSC mode 2 and the SMF decides to change the PDU Session Anchor), the SMF shall return an error response, as specified for step 2b of figure 5.2.2.3.1-1. For a 4xx/5xx response, the SmContextUpdateError structure shall include the following additional information: + +- upCnxState attribute set to DEACTIVATED. + +3. If the SMF returned a 200 OK response, the NF Service Consumer (e.g. AMF) shall subsequently update the SM context in the SMF by sending POST request, as specified in clause 5.2.2.3.1, with the following information: + +- N2 SM information received from the 5G-AN (see PDU Session Resource Setup Response Transfer IE in clause 9.3.4.2 of 3GPP TS 38.413 [9]), including the transport layer address and tunnel endpoint of one or two downlink termination point(s) and the associated list of QoS flows for this PDU session (i.e. 5G-AN's GTP-U F-TEID(s) for downlink traffic), if the 5G-AN succeeded in establishing resources for the PDU sessions; or +- N2 SM information received from the 5G-AN (see PDU Session Resource Setup Unsuccessful Transfer IE in clause 9.3.4.16 of 3GPP TS 38.413 [9]), including the Cause of the failure, if resources failed to be established for the PDU session. + +Upon receipt of this request, the SMF shall: + +- update the UPF with the 5G-AN's F-TEID(s) and set the upCnxState attribute to ACTIVATED, if the 5G-AN succeeded in establishing resources for the PDU sessions; or +- consider that the activation of the User Plane connection has failed and set the upCnxState attribute to DEACTIVATED" otherwise. + +4. The SMF shall then return a 200 OK response including the upCnxState attribute representing the final state of the user plane connection. If the activation of the User Plane connection failed due to insufficient resources, the cause IE shall be included in the response and set to "INSUFFICIENT\_UP\_RESOURCES". + +### 5.2.2.3.2.3 Deactivation of User Plane connectivity of a PDU session + +The NF Service Consumer (e.g. AMF) shall request the SMF to deactivate the User Plane connectivity of an existing PDU session, i.e. release the N3 tunnel, as follows. + +![Diagram illustrating the deactivation of the User Plane connection of a PDU session. It shows two rectangular boxes at the top, representing the NF Service Consumer (e.g., AMF) and the SMF. A dashed vertical line descends from the left box to a large black horizontal bar. A solid horizontal line descends from the right box to the same black bar, ending in an arrowhead pointing right. Below the black bar, a white rectangular box is partially visible on the right side.](a4b963a07cc368283154762c4b156fe7_img.jpg) + +Diagram illustrating the deactivation of the User Plane connection of a PDU session. It shows two rectangular boxes at the top, representing the NF Service Consumer (e.g., AMF) and the SMF. A dashed vertical line descends from the left box to a large black horizontal bar. A solid horizontal line descends from the right box to the same black bar, ending in an arrowhead pointing right. Below the black bar, a white rectangular box is partially visible on the right side. + +**Figure 5.2.2.3.2.2-1: Deactivation of the User Plane connection of a PDU session** + +- The NF Service Consumer shall request the SMF to deactivate the user plane connection of the PDU session by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - upCnxState attribute set to DEACTIVATED; + - user location and user location timestamp; + - cause of the user plane deactivation; the cause may indicate a cause received from the 5G-AN or AMF has detected that the UE has moved out of the network slice support area or due to an AMF internal event; + - N2 SM information received from the 5G-AN (see PDU Session Resource Notify Released Transfer IE in clause 9.3.4.13 of 3GPP TS 38.413 [9] and PDU Session Resource Release Response Transfer IE in clause 9.3.4.21 of 3GPP TS 38.413 [9]), if the request is triggered due to an 5G-AN requested PDU session resource release or due to an AN Release procedure respectively; + - other information, if necessary. + +NOTE: The SMF can receive a N2 SM information (PDU Session Resource Release Response Transfer IE) without having sent any prior N2 SM information (PDU Session Resource Release Command Transfer IE) to the AMF. + +- Upon receipt of such a request, the SMF shall deactivate release the N3 tunnel of the PDU session, set the upCnxState attribute to DEACTIVATED and return a 200 OK response including the upCnxState attribute set to DEACTIVATED. + +If the request is triggered due to 5G-AN requested PDU session resource release, the SMF may decide to keep the PDU Session (with user plane connection deactivated) or release the PDU Session. If the SMF decides to keep the PDU Session, it shall return "200 OK" with the *upCnxState* attribute set to DEACTIVATED, but not including *n1SmMsg* and *n2SmInfo*. If the SMF decides to release the PDU Session, it shall return "200 OK" with the *upCnxState* attribute set to DEACTIVATED, including *n1SmMsg* IE but not-including *n2SmInfo* IE. + +### 5.2.2.3.2.4 Changing the access type of a PDU session from non-3GPP access to 3GPP access during a Service Request procedure + +The NF Service Consumer (e.g. AMF) shall indicate to the SMF that the access type of a PDU session can be changed as follows: + +![Sequence diagram for Figure 5.2.2.3.2.4-1: Indicating that the access type of a PDU session can be changed. The diagram shows an NF Service Consumer sending a POST request to an SMF. The SMF responds with either a 204 No Content or 200 OK (SmContextUpdatedData) or an error response (4xx/5xx or 3xx).](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note left of NF Service Consumer: 1. POST (anTypeCanBeChanged=true) + NF Service Consumer->>SMF: 1. POST (anTypeCanBeChanged=true) + Note right of SMF: 2a. 204 No Content or 200 OK (SmContextUpdatedData) + SMF-->>NF Service Consumer: 2a. 204 No Content or 200 OK (SmContextUpdatedData) + Note right of SMF: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +Sequence diagram for Figure 5.2.2.3.2.4-1: Indicating that the access type of a PDU session can be changed. The diagram shows an NF Service Consumer sending a POST request to an SMF. The SMF responds with either a 204 No Content or 200 OK (SmContextUpdatedData) or an error response (4xx/5xx or 3xx). + +**Figure 5.2.2.3.2.4-1: Indicating that the access type of a PDU session can be changed** + +1. The NF Service Consumer shall indicate that the access type of a PDU session can be changed by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - anTypeCanBeChanged attribute set to "true"; + - other information, if necessary. +- 2a. Same as step 2a of figure 5.2.2.3.1-1. In HR roaming scenarios, the V-SMF shall invoke the Update service operation towards the H-SMF to notify that the access type of the PDU session can be changed (see clause 5.2.2.8.2.2). +- 2b. Same as step 2b of figure 5.2.2.3.1-1. + +NOTE: This is used during a Service Request procedure (see clause 4.2.3.2 of 3GPP TS 23.502 [3]), in response to paging or NAS notification indicating non-3GPP access, if the PDU Session for which the UE was paged or notified is in the List Of Allowed PDU Sessions provided by the UE and if the AMF has received N2 SM Information only or N1 SM Container and N2 SM Information for that PDU session from the SMF in step 3a of clause 4.2.3.3 of 3GPP TS 23.502 [3]. + +The SMF may perform Network Slice Admission Control before the PDU Session is moved from the non-3GPP access to 3GPP access (i.e, before N3 tunnel for the PDU Session is established). + +If the PDU Session is moved from the non-3GPP access to 3GPP access (i.e. N3 tunnel for the PDU Session is established successfully), the SMF and NF Service Consumer (e.g. AMF) updates the associated access of the PDU Session. + +### 5.2.2.3.3 Xn Handover + +The NF Service Consumer (e.g. AMF) shall request the SMF to switch the downlink N3 tunnel of the PDU session towards a new GTP tunnel endpoint as follows. + +![Sequence diagram for Figure 5.2.2.3.3-1: Xn handover. The diagram shows an NF Service Consumer sending a POST request to an SMF. The SMF responds with either a 200 OK (N2 SM Information) or an error response (4xx/5xx or 3xx).](df6b7ae63e53e5f93dbd0a70acdae4a6_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note left of NF Service Consumer: 1. POST (To Be Switched Indication, N2 SM Information) + NF Service Consumer->>SMF: 1. POST (To Be Switched Indication, N2 SM Information) + Note right of SMF: 2a. 200 OK (N2 SM Information) + SMF-->>NF Service Consumer: 2a. 200 OK (N2 SM Information) + Note right of SMF: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +Sequence diagram for Figure 5.2.2.3.3-1: Xn handover. The diagram shows an NF Service Consumer sending a POST request to an SMF. The SMF responds with either a 200 OK (N2 SM Information) or an error response (4xx/5xx or 3xx). + +**Figure 5.2.2.3.3-1: Xn handover** + +1. The NF Service Consumer shall request the SMF to switch the downlink N3 tunnel of the PDU session towards a new GTP tunnel endpoint by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - the indication that the PDU session is to be switched; + +- N2 SM information received from the target 5G-AN (see Path Switch Request Transfer IE in clause 9.3.4.8 of 3GPP TS 38.413 [9]), including the new transport layer address and tunnel endpoint of the downlink termination point for the user data for this PDU session (i.e. 5G-AN's GTP-U F-TEID for downlink traffic); + - additional N2 SM information received from the source 5G-AN (see Secondary RAT Data Usage Report Transfer IE in clause 9.3.4.23 of 3GPP TS 38.413 [9]), if any; + - the user location associated to the PDU session; + - the indication that the UE is inside or outside of the LADN service area, if the DNN of the established PDU session corresponds to a LADN; + - other information, if necessary. +- 2a. If the SMF can proceed with switching the user plane connection of the PDU session, the SMF shall return a 200 OK response including the following information: +- N2 SM information (see Path Switch Request Acknowledge Transfer IE in clause 9.3.4.9 of 3GPP TS 38.413 [9]), including the transport layer address and tunnel endpoint of the uplink termination point for the user data for this PDU session (i.e. UPF's GTP-U F-TEID for uplink traffic). +- If the request does not include the "UE presence in LADN service area" indication and the SMF determines that the DNN corresponds to a LADN, then the SMF shall consider that the UE is outside of the LADN service area. The SMF shall proceed as specified in clause 5.6.5 of 3GPP TS 23.501 [2]. +- 2b. If the SMF cannot proceed with switching the user plane connection of the PDU session, the SMF shall return an error response, as specified for step 2b of figure 5.2.2.3.1-1, including: +- N2 SM information (see Path Switch Request Unsuccessful Transfer IE in clause 9.3.4.20 of 3GPP TS 38.413 [9]), including the cause of the failure. + +For a PDU session that is rejected by the target RAN (i.e. a PDU session indicated as failed to setup in the PATH SWITCH REQUEST), the NF Service Consumer (e.g. AMF) shall indicate the failure to setup the PDU session in the target RAN as follows. + +![Sequence diagram showing the interaction between NF Service Consumer and SMF for PDU session rejection. Step 1: POST (Failed To Be Switched Indication, N2 SM Information) from NF Service Consumer to SMF. Step 2a: 204 No Content from SMF to NF Service Consumer. Step 2b: 4xx/5xx (SmContextUpdateError) or 3xx from SMF to NF Service Consumer.](fcbc3c31776721edc98ceb1944ec438f_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: 1. POST (Failed To Be Switched Indication, N2 SM Information) + NF Service Consumer->>SMF: 1. POST (Failed To Be Switched Indication, N2 SM Information) + Note left of SMF: 2a. 204 No Content + SMF-->>NF Service Consumer: 2a. 204 No Content + Note left of SMF: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +Sequence diagram showing the interaction between NF Service Consumer and SMF for PDU session rejection. Step 1: POST (Failed To Be Switched Indication, N2 SM Information) from NF Service Consumer to SMF. Step 2a: 204 No Content from SMF to NF Service Consumer. Step 2b: 4xx/5xx (SmContextUpdateError) or 3xx from SMF to NF Service Consumer. + +**Figure 5.2.2.3.3-2: Xn handover – PDU session rejected by the target RAN** + +1. The NF Service Consumer shall indicate to the SMF that the PDU session could not be setup in the target RAN by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - the indication that the PDU session failed to be switched; + - N2 SM information received from the target 5G-AN (see Path Switch Request Setup Failed Transfer IE in clause 9.3.4.15 of 3GPP TS 38.413 [9]), including the cause why the session could not be setup; + - additional N2 SM information received from the source 5G-AN (see Secondary RAT Data Usage Report Transfer IE in clause 9.3.4.23 of 3GPP TS 38.413 [9]), if any; + - other information, if necessary. + +2a. Upon receipt of such a request, the SMF shall return a "204 No Content" response. The SMF shall decide whether to release the PDU session or deactivate the user plane connection of the PDU session, as specified in clause 4.9.1.2 of 3GPP TS 23.502 [3]. + +2b. Same as step 2b of figure 5.2.2.3.1-1. + +#### 5.2.2.3.4 N2 Handover + +##### 5.2.2.3.4.1 General + +The hoState attribute of an SM context represents the handover state of the PDU session. The hoState attribute may take the following values: + +- NONE: no handover is in progress for the PDU session; +- PREPARING: a handover is in preparation for the PDU session; SMF is preparing the N3 tunnel between the target 5G-AN and UPF, i.e. the UPF's F-TEID is assigned for uplink traffic; +- PREPARED: a handover is prepared for the PDU session; SMF is updated for the N3 tunnel between the target 5G-AN and UPF, with the target 5G-AN's F-TEID to be assigned for downlink traffic upon handover execution; +- COMPLETED: the handover is completed (successfully); +- CANCELLED: the handover is cancelled. + +##### 5.2.2.3.4.2 N2 Handover Preparation + +The NF Service Consumer (e.g. T-AMF) shall request the SMF to prepare the handover of an existing PDU session, i.e. prepare the N3 tunnel between the target 5G-AN and UPF, as follows. + +![Sequence diagram for N2 Handover Preparation between NF Service Consumer and SMF.](e38206fcefa2045af01d494b2956775a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of SMF: If request accepted: +hoState +PREPARING + Note right of SMF: If successful: +hoState +PREPARED + NF Service Consumer->>SMF: 1. POST (hoState=PREPARING, N2 SM Information) + SMF-->>NF Service Consumer: 2a. 200 OK (hoState=PREPARING, N2 SM Information) + Note right of SMF: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + Note right of SMF: 3. POST (hoState=PREPARED, N2 SM Information) + SMF-->>NF Service Consumer: 4a. 200 OK (hoState=PREPARED, N2 SM Information) + Note right of SMF: 4b. 4xx/5xx (SmContextUpdateError) or 3xx + SMF-->>NF Service Consumer: 4b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +The diagram illustrates the N2 Handover Preparation process between an NF Service Consumer and an SMF. The sequence starts with the NF Service Consumer sending a POST request (step 1) with hoState=PREPARING and N2 SM Information to the SMF. The SMF responds with a 200 OK (step 2a) if the request is accepted, setting hoState to PREPARING. Alternatively, it can respond with a 4xx/5xx (SmContextUpdateError) or 3xx (step 2b). Next, the NF Service Consumer sends another POST request (step 3) with hoState=PREPARED and N2 SM Information. The SMF responds with a 200 OK (step 4a) if successful, setting hoState to PREPARED, or with a 4xx/5xx (SmContextUpdateError) or 3xx (step 4b). + +Sequence diagram for N2 Handover Preparation between NF Service Consumer and SMF. + +Figure 5.2.2.3.4.2-1: N2 Handover Preparation + +1. The NF Service Consumer shall request the SMF to prepare the handover of the PDU session by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + +- updating the hoState attribute of the individual SM Context resource in the SMF to PREPARING; +- targetId identifying the target RAN Node ID and TAI received in the Handover Required from the source NG-RAN; +- targetServingNfId set to the target AMF Id, for a N2 handover with AMF change; +- N2 SM information received from the source NG-RAN (see Handover Required Transfer IE in clause 9.3.4.14 of 3GPP TS 38.413 [9]), indicating whether a direct path is available; + +- the supportedFeatures IE indicating the optional features it supports, if at least one optional feature defined in clause 6.1.8 is supported; + - other information, if necessary. +- 2a. Upon receipt of such a request, if the SMF can proceed with preparing the handover of the PDU session (see clause 4.9.1.3 of 3GPP TS 23.502 [3]), the SMF shall set the hoState attribute to PREPARING and shall return a 200 OK response including the following information: +- hoState attribute set to PREPARING; + - N2 SM information to request the target 5G-AN to assign resources to the PDU session (see PDU Session Resource Setup Request Transfer IE in clause 9.3.4.1 of 3GPP TS 38.413 [9]), including (among others) the transport layer address and tunnel endpoint of the uplink termination point for the user plane data for this PDU session (i.e. UPF's GTP-U F-TEID for uplink traffic); + - the supportedFeatures IE in the response, if the supportedFeatures IE was received in the request and at least one optional feature defined in clause 6.1.8 is supported by the updated SM context resource. + +The SMF shall store the targetServingNfId, if received in the request, but the SMF shall still consider the AMF (previously) received in the servingNfId IE as the serving AMF for the UE. + +- 2b. If the SMF cannot proceed with preparing the handover of the PDU session (e.g. the UE moves into a non-allowed service area), the SMF shall return an error response, as specified in step 2b of figure 5.2.2.3.1-1. + +When receiving a 4xx/5xx response from the SMF, the NF service consumer (e.g. the AMF) shall regard the hoState of the SM Context to be NONE. + +3. If the SMF returned a 200 OK response in step 2a, the NF Service Consumer (e.g. AMF) shall subsequently update the SM context in the SMF by sending POST request, as specified in clause 5.2.2.3.1, with the following information: +- hoState attribute set to PREPARED; + - N2 SM information received from the target 5G-AN (see Handover Request Acknowledge Transfer IE in clause 9.3.4.11 of 3GPP TS 38.413 [9]), including (among others) the transport layer address and tunnel endpoint of the downlink termination point for the user data for this PDU session (i.e. target 5G-AN's GTP-U F-TEID for downlink traffic), if the target 5G-AN succeeded in establishing resources for the PDU session; + - N2 SM information received from the target 5G-AN (see Handover Resource Allocation Unsuccessful Transfer IE in clause 9.3.4.19 of 3GPP TS 38.413 [9]), including the Cause of the failure, if resources failed to be established for the PDU sessions. +- 4a. If the target 5G-AN succeeded in establishing resources for the PDU sessions, the SMF shall set the hoState attribute to PREPARED and return a 200 OK response including the following information: +- hoState attribute to PREPARED; + - N2 SM information (see Handover Command Transfer IE in clause 9.3.4.10 of 3GPP TS 38.413 [9]) containing DL forwarding tunnel information to be sent to the source 5G-AN by the AMF if direct or indirect data forwarding applies (see step 11f of clause 4.9.1.3.2 of 3GPP TS 23.502 [3]). +- 4b. If the SMF cannot proceed with preparing the handover of the PDU session (e.g. the target 5G-AN failed to establish resources for the PDU session), the SMF shall set the hoState to NONE, release resources reserved for the handover to the target 5G-AN, and return an error response as specified in step 2b of figure 5.2.2.3.1-1. For a 4xx/5xx response, the SmContextUpdateError structure shall include the following additional information: +- N2 SM information (see Handover Preparation Unsuccessful Transfer IE in clause 9.3.4.18 of 3GPP TS 38.413 [9]) indicating the cause of the failure; + - the cause in the error attribute set to HANDOVER\_RESOURCE\_ALLOCATION\_FAILURE, if the target 5G-AN failed to establish resources for the PDU session. + +When receiving a 4xx/5xx response from the SMF, the NF service consumer (e.g. the AMF) shall regard the hoState of the SM Context to be NONE. + +If the handover preparation fails completely on the target 5G-AN (i.e. target 5G-AN returns a NGAP HANDOVER\_FAILURE), the (T-)AMF shall request the SMF to cancel the handover of the PDU session as described in clause 5.2.2.3.4.4. + +#### 5.2.2.3.4.3 N2 Handover Execution + +The NF Service Consumer (e.g. T-AMF) shall request the SMF to complete the execution the handover of an existing PDU session, upon being notified by the target 5G-AN that the handover to the target 5G-AN has been successful, as follows. + +![Sequence diagram for N2 Handover Execution. The NF Service Consumer sends a POST request (hoState=COMPLETED, N2 SM Information) to the SMF. The SMF responds with a 200 OK (hoState=COMPLETED). The SMF then updates its internal state to hoState NONE.](b6ad8b32179842fca5ad086cf22b03eb_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of SMF: hoState NONE + NF Service Consumer->>SMF: 1. POST (hoState=COMPLETED, N2 SM Information) + SMF-->>NF Service Consumer: 2. 200 OK (hoState=COMPLETED) + Note right of SMF: hoState NONE + +``` + +Sequence diagram for N2 Handover Execution. The NF Service Consumer sends a POST request (hoState=COMPLETED, N2 SM Information) to the SMF. The SMF responds with a 200 OK (hoState=COMPLETED). The SMF then updates its internal state to hoState NONE. + +**Figure 5.2.2.3.4.3-1: N2 Handover Execution** + +- The NF Service Consumer shall request the SMF to complete the execution of the handover of the PDU session by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - updating the hoState attribute of the individual SM Context resource in the SMF to COMPLETED; + - servingNfId set to the new serving AMF Id, for a N2 handover with AMF change; + - the indication that the UE is inside or outside of the LADN service area, if the DNN of the established PDU session corresponds to a LADN; + - N2 SM information received from the source 5G-AN (see Secondary RAT Data Usage Report Transfer IE in clause 9.3.4.23 of 3GPP TS 38.413 [9]), if any; + - other information, if necessary. +- Upon receipt of such a request, the SMF shall return a 200 OK response including the following information: + - hoState attribute set to COMPLETED. + +The SMF shall complete the execution of the handover, e.g. switch the PDU session towards the downlink termination point for the user data received from the target 5G-AN (i.e. target 5G-AN's GTP-U F-TEID for downlink traffic), set the hoState to NONE and delete any stored targetServingNfId. For PDU session with I-SMF insertion, the I-SMF shall complete the execution of the handover by initiating an Update service operation towards the anchor SMF in order to switch the PDU session towards the I-UPF controlled by I-SMF (see clause 5.2.2.8.2.12). + +If the request does not include the "UE presence in LADN service area" indication and the SMF determines that the DNN corresponds to a LADN, then the SMF shall consider that the UE is outside of the LADN service area. The SMF shall proceed as specified in clause 5.6.5 of 3GPP TS 23.501 [2]. + +The (T-)AMF shall request the SMF to complete the execution of the handover of the PDU session only for those PDU sessions that successfully completed the handover procedure. If there are PDU sessions that failed to handover due to timeout of SMF responses in any step of the handover preparation phase (e.g. if the Update SM Context Response arrived too late or not at all during the handover preparation phase, see step 7 of clause 4.9.1.3.3 of 3GPP TS 23.502 [3]), then the (T-)AMF shall inform the SMF about this failure, by sending a POST request with the cause attribute set to "HO\_FAILURE" for every such PDU session, upon receipt of the NGAP HANDOVER NOTIFY. The SMF shall then release the resources prepared for the handover and consider that the PDU session is deactivated and that the handover attempt is terminated for the PDU session. + +If the handover fails completely on the target 5G-AN due to the execution phase not completed successfully (i.e. missing NGAP HANDOVER NOTIFY), the (T-)AMF shall request the SMF to cancel the handover of the PDU session as described in clause 5.2.2.3.4.4. + +#### 5.2.2.3.4.4 N2 Handover Cancellation + +The NF Service Consumer (e.g. T-AMF) shall request the SMF to cancel the handover of an existing PDU session, e.g. upon receipt of such a request from the source 5G-AN, as follows. + +![Sequence diagram for N2 Handover Cancellation. On the left, a box representing the NF Service Consumer (e.g., T-AMF) sends a request arrow to a box representing the SMF. On the right, a box representing the SMF sends a response arrow back to the NF Service Consumer. Vertical dashed lines extend downwards from each box, representing lifelines.](107da2e3495b2f24352c9e3b26ec4841_img.jpg) + +Sequence diagram for N2 Handover Cancellation. On the left, a box representing the NF Service Consumer (e.g., T-AMF) sends a request arrow to a box representing the SMF. On the right, a box representing the SMF sends a response arrow back to the NF Service Consumer. Vertical dashed lines extend downwards from each box, representing lifelines. + +**Figure 5.2.2.3.4.3-1: N2 Handover Cancellation** + +1. The NF Service Consumer shall request the SMF to cancel the execution of the handover of the PDU session by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - updating the hoState attribute of the individual SM Context resource in the SMF to CANCELLED; + - cause information; + - other information, if necessary. +2. Upon receipt of such a request, the SMF return a 200 OK response including the following information: + - hoState attribute set to CANCELLED. + +The SMF shall cancel the execution of the handover, e.g. release resources reserved for the handover to the target 5G-AN, set the hoState to NONE and delete any stored targetServingNfId. For PDU Session with I-SMF insertion, the I-SMF shall cancel the handover by initiating an Update service operation towards the anchor SMF in order to release resources at the SMF and PSA UPF reserved during handover preparation (see clause 5.2.2.8.2.13). + +#### 5.2.2.3.5 Handover between 3GPP and untrusted non-3GPP access procedures + +##### 5.2.2.3.5.1 General + +The handover of a PDU session between 3GPP and untrusted non-3GPP access shall be supported as specified in clause 4.9.2 of 3GPP TS 23.502 [3]. Such a handover may involve: + +- the same AMF, or a target AMF in the same PLMN as the source AMF (see clauses 4.9.2.1, 4.9.2.2, 4.9.2.3.1 and 4.9.2.4.1 of 3GPP TS 23.502 [3]). The Update SM Context service operation is used in these cases; or +- a target AMF in a different PLMN than the source AMF (see clauses 4.9.2.3.2 and 4.9.2.4.2 of 3GPP TS 23.502 [3]). The Create SM Context service operation is used in this case (see clause 5.2.2.2). + +For a Home-Routed PDU session, the target AMF may be located in the VPLMN, or in the HPLMN when the N3IWF is in the HPLMN. + +##### 5.2.2.3.5.2 Handover of a PDU session without AMF change or with target AMF in same PLMN + +In these scenarios, the same V-SMF is used before and after the handover. + +The NF Service Consumer (e.g. AMF) shall request the SMF to handover an existing PDU session from 3GPP access to untrusted non-3GPP access, or vice-versa, as follows. + +![Sequence diagram for Handover between 3GPP and untrusted non-3GPP access. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 200 OK or an error response (4xx/5xx or 3xx).](c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of SMF: 1. POST (target Access Type, N1 SM Information) + NF Service Consumer->>SMF: 1. POST (target Access Type, N1 SM Information) + Note left of SMF: 2a. 200 OK () + SMF-->>NF Service Consumer: 2a. 200 OK () + Note left of SMF: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +Sequence diagram for Handover between 3GPP and untrusted non-3GPP access. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 200 OK or an error response (4xx/5xx or 3xx). + +**Figure 5.2.2.3.5.2-1: Handover between 3GPP and untrusted non-3GPP access** + +1. The NF Service Consumer shall request the SMF to handover an existing PDU session from 3GPP access to untrusted non-3GPP access, or vice-versa, by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - updating the anType attribute of the individual SM Context resource in the SMF to the target access type, i.e. to 3GPP\_ACCESS or NON\_3GPP\_ACCESS; + - other information, if necessary. +- 2a. Same as step 2a of Figure 5.2.2.3.1-1. +- 2b. If the SMF cannot proceed with handing over the PDU session to the target access type, the SMF shall return an error response, as specified for step 2b of figure 5.2.2.3.1-1. For a 4xx/5xx response, the SmContextUpdateError structure shall include the following additional information: + - N1 SM Information to reject the UE request. + +The anchor SMF may perform Network Slice Admission Control before the PDU Session is moved to the target access (i.e., before the N3 tunnel for the PDU Session is established). + +### 5.2.2.3.6 Inter-AMF change or mobility + +The NF Service Consumer (e.g. new AMF) shall inform the SMF that it has taken over the role of serving the UE (e.g. it has taken the responsibility of the signalling towards the UE), when so required by 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3], as follows. + +![Sequence diagram for Inter-AMF change or mobility. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 204 No Content or 200 OK (SmContextUpdatedData) or an error response (4xx/5xx or 3xx).](e94cbc0895c6914a2bb53f150ab7495e_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of SMF: 1. POST (amfId) + NF Service Consumer->>SMF: 1. POST (amfId) + Note left of SMF: 2a. 204 No Content or 200 OK (SmContextUpdatedData) + SMF-->>NF Service Consumer: 2a. 204 No Content or 200 OK (SmContextUpdatedData) + Note left of SMF: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +Sequence diagram for Inter-AMF change or mobility. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 204 No Content or 200 OK (SmContextUpdatedData) or an error response (4xx/5xx or 3xx). + +**Figure 5.2.2.3.6-1: Inter-AMF change or mobility** + +1. The NF Service Consumer shall update the SMF with the new serving AMF, by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - servingNfId set to the new serving AMF Id; + - the supportedFeatures IE indicating the optional features it supports, if at least one optional feature defined in clause 6.1.8 is supported; + - other information, if necessary, e.g. to activate the user plane connection of the PDU session (see clause 5.2.2.3.2.2). + +- 2a. Same as step 2a of Figure 5.2.2.3.1-1. In addition, the SMF shall include the supportedFeatures IE in the response, if the supportedFeatures IE was received in the request and at least one optional feature defined in clause 6.1.8 is supported by the updated SM context resource. +- 2b. Same as step 2b of figure 5.2.2.3.1-1. + +### 5.2.2.3.7 RAN Initiated QoS Flow Mobility + +The NF Service Consumer (e.g. AMF) shall request the SMF to transfer QoS flows to and from Secondary RAN node, or more generally, handle a NG-RAN PDU Session Resource Modify Indication, as follows. + +![Sequence diagram for RAN Initiated QoS Flow Mobility. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'SMF' on the right. Step 1 is a solid arrow from NF Service Consumer to SMF labeled '1. POST (N2 SM Information)'. Step 2a is a dashed return arrow from SMF to NF Service Consumer labeled '2a. 200 OK (N2 SM Information)'. Step 2b is a dashed return arrow from SMF to NF Service Consumer labeled '2b. 4xx/5xx (SmContextUpdateError) or 3xx'.](82fbb97c1145cac89ac72dd080fad17a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of SMF: 1. POST (N2 SM Information) + SMF-->>NF Service Consumer: 2a. 200 OK (N2 SM Information) + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +Sequence diagram for RAN Initiated QoS Flow Mobility. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'SMF' on the right. Step 1 is a solid arrow from NF Service Consumer to SMF labeled '1. POST (N2 SM Information)'. Step 2a is a dashed return arrow from SMF to NF Service Consumer labeled '2a. 200 OK (N2 SM Information)'. Step 2b is a dashed return arrow from SMF to NF Service Consumer labeled '2b. 4xx/5xx (SmContextUpdateError) or 3xx'. + +**Figure 5.2.2.3.7-1: RAN Initiated QoS Flow Mobility** + +1. The NF Service Consumer shall request the SMF to modify the PDU session, as requested by the NG-RAN, by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - N2 SM information received from the 5G-AN (see PDU Session Resource Modify Indication Transfer IE in clause 9.3.4.6 of 3GPP TS 38.413 [9]), including the transport layer information for the QoS flows of this PDU session (i.e. 5G-AN's GTP-U F-TEIDs for downlink traffic); + - other information, if necessary. +- 2a. Upon receipt of such a request, if the SMF can proceed with switching the QoS flows of the PDU session, the SMF shall return a 200 OK response including the following information: + - N2 SM information (see PDU Session Resource Modify Confirm Transfer IE in clause 9.3.4.7 of 3GPP TS 38.413 [9]), including the list of QoS flows which were modified successfully and the list of QoS flows which failed to be modified if available. +- 2b. If the SMF cannot proceed with switching the QoS flows of the PDU session, the SMF shall return an error response, as specified for step 2b of figure 5.2.2.3.1-1, including: + - N2 SM information (see PDU Session Resource Modify Indication Unsuccessful Transfer IE in clause 9.3.4.22 of 3GPP TS 38.413 [9]). + +### 5.2.2.3.8 EPS to 5GS Handover using N26 interface + +#### 5.2.2.3.8.1 General + +The NF Service Consumer (e.g. AMF) shall request the SMF to handover a UE EPS PDN connection to 5GS using N26 interface, following the same requirements as specified for N2 handover in clause 5.2.2.3.4 with the modifications specified in this clause. + +#### 5.2.2.3.8.2 EPS to 5GS Handover Preparation + +The requirements specified in clause 5.2.2.3.4.2 shall apply with the following modifications. + +![Sequence diagram for EPS to 5GS Handover Preparation. The diagram shows two lifelines: NF Service Consumer and SMF. A box labeled 'Steps 1 to 2 of Figure 5.2.2.2.3-1' spans the top. Below it, the NF Service Consumer sends a POST message (step 3) to the SMF with hoState=PREPARED and N2 SM Information. The SMF responds with a 200 OK message (step 4a) containing hoState=PREPARED and epsBearerSetup(s). A box next to the SMF indicates 'If successful: hoState PREPARED'. The NF Service Consumer also receives a 4xx/5xx message (step 4b) with hoState=NONE or a 3xx message.](8269648391c59363ea61243864a2adf7_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note over NF Service Consumer, SMF: Steps 1 to 2 of Figure 5.2.2.2.3-1 + Note left of NF Service Consumer: + NF Service Consumer->>SMF: 3. POST (hoState=PREPARED, N2 SM Information) + Note right of SMF: If successful: hoState PREPARED + SMF-->>NF Service Consumer: 4a. 200 OK (hoState=PREPARED, epsBearerSetup(s)) + SMF-->>NF Service Consumer: 4b. 4xx/5xx (hoState=NONE) or 3xx + +``` + +Sequence diagram for EPS to 5GS Handover Preparation. The diagram shows two lifelines: NF Service Consumer and SMF. A box labeled 'Steps 1 to 2 of Figure 5.2.2.2.3-1' spans the top. Below it, the NF Service Consumer sends a POST message (step 3) to the SMF with hoState=PREPARED and N2 SM Information. The SMF responds with a 200 OK message (step 4a) containing hoState=PREPARED and epsBearerSetup(s). A box next to the SMF indicates 'If successful: hoState PREPARED'. The NF Service Consumer also receives a 4xx/5xx message (step 4b) with hoState=NONE or a 3xx message. + +**Figure 5.2.2.3.8.2-1: EPS to 5GS Handover Preparation** + +1. Same as step 1 of Figure 5.2.2.2.3-1. +- 2a. Same as step 2 of Figure 5.2.2.2.3-1. +- 2b. Same as step 2b of figure 5.2.2.3.1-1. +3. Same as step 3 of Figure 5.2.2.3.4.2-1. +- 4a. Same as step 4 of Figure 5.2.2.3.4.2-1, with the following modifications: + +The 200 OK response shall not include N2 SM information for DL forwarding tunnel setup, but shall additionally contain: + +- the epsBearerSetup IE(s), containing the list of EPS bearer context(s) successfully handed over to the 5GS and DL data forwarding information, containing either: + - CN tunnel information generated based on the list of accepted QFI(s) received from the 5G-RAN, if indirect data forwarding applies; or + - NG-RAN F-TEID per E-RAB accepted for direct data forwarding, as received from the target NG-RAN, if direct data forwarding applies. + +- 4b. Same as step 2b of figure 5.2.2.3.4.2-1. + +#### 5.2.2.3.8.3 EPS to 5GS Handover Execution + +The requirements specified in clause 5.2.2.3.4.3 shall apply, with the following modifications. + +In step 1 of Figure 5.2.2.3.4.3-1, the NF Service Consumer, i.e. the target AMF, shall include one or more SecondaryRatUsageDataReportContainer(s) in the SmContextUpdateData for the POST request if it received one or more Secondary RAT Usage Data Report(s) applicable for the PDU session from the source MME. + +In step 2 of Figure 5.2.2.3.4.3-1, for a Home Routed PDU session, the SMF shall complete the execution of the handover by initiating an Update service operation towards the H-SMF in order to switch the PDU session towards the V-UPF (see clause 5.2.2.8.2.3). + +If there are PDU sessions that failed to handover due to timeout of SMF responses in any step of the handover preparation phase (e.g. if the Update SM Context Response arrived too late or not at all during the handover preparation phase), then the AMF shall consider that the PDU session will be released by the MME and remove the PDU session context from the UE context. For a HR PDU session or a PDU session with I-SMF, the AMF shall also release the SM Context in the V-SMF or the I-SMF only. + +#### 5.2.2.3.8.4 EPS to 5GS Handover Cancellation + +The requirements specified in clause 5.2.2.3.4.4 shall apply, with the following modifications. + +In step 2 of Figure 5.2.2.3.4.4-1, for a Home Routed PDU session, the V-SMF shall cancel the handover by initiating an Update service operation towards the H-SMF in order to release resources at H-SMF and H-UPF reserved for handover (see clause 5.2.2.8.2.14). + +#### 5.2.2.3.8.5 EPS to 5GS Handover Failure + +If the handover to 5GS failed, e.g. rejected by the target NG-RAN, the requirements specified in clause 5.2.2.3.4.4 shall apply, with the following modifications: + +- the hoState attribute set to "CANCELLED", to indicate the handover is cancelled; +- the cause attribute set to "HO\_FAILURE". + +In step 2 of Figure 5.2.2.3.4.4-1, for a Home Routed PDU session, the V-SMF shall cancel the handover by initiating an Update service operation towards the H-SMF in order to release resources at H-SMF and H-UPF reserved for handover (see clause 5.2.2.8.2.17). + +#### 5.2.2.3.9 5GS to EPS Handover using N26 interface + +##### 5.2.2.3.9.1 General + +The NF Service Consumer (e.g. AMF) shall request the SMF to setup data forwarding tunnels if direct or indirect data forwarding applies to the 5GS to EPS handover using N26 interface, and to remove the indirect data forwarding tunnels previously established when the handover is cancelled or failed. + +The AMF should initiate this procedure only if data forwarding is enabled and the MME returns data forwarding F-TEIDs for the related PDN connection context in the Forward Relocation response. + +##### 5.2.2.3.9.2 Data forwarding tunnels setup during 5GS to EPS handover + +If direct or indirect data forwarding applies to the 5GS to EPS handover, the NF Service Consumer (e.g. AMF) shall provide the SMF with the data forwarding information received from the MME, as specified in clause 4.11.1.2.1 of 3GPP TS 23.502 [3], as follows. + +![Sequence diagram showing the interaction between NF Service Consumer and SMF for 5GS to EPS handover using N26 interface. The NF Service Consumer sends a POST request (dataForwarding=true, epsBearerSetup(s)) to the SMF. The SMF responds with a 200 OK (dataForwarding=true, N2 SM Information) or a 4xx/5xx (SmContextUpdateError) or 3xx response.](c8fcc1ae5d86caaae5607b58d16be8e4_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note left of NF Service Consumer: 1. POST (dataForwarding=true, epsBearerSetup(s)) + NF Service Consumer->>SMF: 1. POST (dataForwarding=true, epsBearerSetup(s)) + Note right of SMF: 2a. 200 OK (dataForwarding=true, N2 SM Information) + SMF-->>NF Service Consumer: 2a. 200 OK (dataForwarding=true, N2 SM Information) + Note right of SMF: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +Sequence diagram showing the interaction between NF Service Consumer and SMF for 5GS to EPS handover using N26 interface. The NF Service Consumer sends a POST request (dataForwarding=true, epsBearerSetup(s)) to the SMF. The SMF responds with a 200 OK (dataForwarding=true, N2 SM Information) or a 4xx/5xx (SmContextUpdateError) or 3xx response. + +**Figure 5.2.2.3.9-1: 5GS to EPS Handover using N26 interface (data forwarding tunnels setup)** + +1. The NF Service Consumer shall send a POST request, as specified in clause 5.2.2.3.1, with the following information: + - dataForwarding IE set to true; + - EPS bearer contexts received from the MME in the Forward Relocation Response, including F-TEID(s) for DL data forwarding tunnel(s) towards the target eNB (for direct data forwarding) or towards the forwarding SGW (for indirect data forwarding). +- 2a. If indirect data forwarding applies, the SMF shall map the EPS bearers for Data Forwarding to the 5G QoS flows based on the association between the EPS bearer ID(s) and QFI(s) for the QoS flow(s). + +The SMF shall return a 200 OK response including the following information: + +- N2 SM information (see Handover Command Transfer IE in clause 9.3.4.10 of 3GPP TS 38.413 [9]) containing DL forwarding tunnel information to be sent to the source 5G-AN by the AMF if direct or indirect data forwarding applies (see step 11f of clause 4.9.1.3.2 of 3GPP TS 23.502 [3]). + +If direct data forwarding applies, the DL forwarding tunnel information shall contain the E-UTRAN tunnel info for data forwarding per EPS bearer received from the MME. + +If indirect data forwarding applies, the DL forwarding tunnel information shall contain the CN transport layer address and tunnel endpoint (i.e. UPF's GTP-U F-TEID) for Data Forwarding and the QoS flows for Data Forwarding for this PDU session. + +- 2b. If the SMF cannot proceed with the request, the SMF shall return an error response, as specified for step 2b of figure 5.2.2.3.1-1. + +If none of the EPS bearer contexts received in the POST request body includes an F-TEID for DL data forwarding, the SMF shall return a 403 Forbidden response including a ProblemDetails structure with the "cause" attribute set to "NO\_DATA\_FORWARDING". Upon receipt of this response, the AMF shall proceed with the handover procedure (as if data forwarding was disabled). + +NOTE: The above use case can occur if an AMF initiates this procedure without checking whether the MME returns data forwarding F-TEIDs for the related PDN connection context in the Forward Relocation response (e.g. pre-Rel-17 or Rel-17 AMF that does not support such checking). + +#### 5.2.2.3.9.3 Indirect data forwarding tunnels removal for 5GS to EPS handover cancellation or failure + +During 5GS to EPS handover, if indirect data forwarding tunnel(s) have been previously established during the preparation phase and the handover is cancelled, the AMF shall update the SMF of handover cancellation by sending a POST request with the cause attribute set to "HO\_CANCEL" and dataForwarding IE set to false with an empty list of EPS bearer contexts. The SMF shall then release the resources prepared for the handover and proceed with the PDU session as if no handover procedure had taken place. + +If no resources for EPS bearer(s) can be assigned for any PDU session attempted to be handed over, the AMF shall update the SMF with the information that the handover preparation failed by sending a POST request with the cause attribute set to "HO\_FAILURE" and with an empty list of EPS bearer contexts (and without the dataForwarding IE). The SMF shall then release the resources prepared for the handover and proceed with the PDU session as if no handover procedure had taken place. + +#### 5.2.2.3.10 P-CSCF Restoration Procedure via AMF + +The requirements specified in clause 5.2.2.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.3.1-1, with the following modifications. + +The POST request shall contain: + +- the release IE set to true; +- the cause IE set to REL\_DUE\_TO\_REACTIVATION. + +#### 5.2.2.3.11 AMF requested PDU Session Release due to duplicated PDU Session Id + +When the AMF receives an "initial request" with PDU Session Id which already exists in PDU session context of the UE (see clause 5.4.5.2.5 of 3GPP TS 24.501 [7]), the AMF shall request the SMF to release the existing PDU Session; upon subsequent receipt of an SM context status notification indicating that the SM context has been deleted in the SMF, the AMF shall release the stored context for the PDU session and proceed with the "initial request" with the PDU Session Id. + +The requirements for releasing the existing PDU Session specified in clause 5.2.2.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.3.1-1, with the following modifications. + +The POST request shall contain: + +- the release IE set to true; +- the cause IE set to REL\_DUE\_TO\_DUPLICATE\_SESSION\_ID. + +When the SMF receives the request from AMF, the SMF shall start the PDU Session Release procedure to release all the associated resources in UPF, PCF, CHF, and UDM. If the UP connection of the existing PDU session is active, the SMF should also request (R)AN to release associated resources. + +NOTE: The SMF does not send NAS signaling to UE for the PDU session release in this procedure. + +#### 5.2.2.3.12 AMF requested PDU Session Release due to slice not available + +If a network slice is detected as not available (e.g. due to slice congestion or operational disable the slice), the NF Service Consumer (i.e. AMF) shall use this procedure to release the PDU session associated to the unavailable network slice. Such handling of PDU session release may also happen in network slice replacement procedure (see clause 4.3.3.3 of 3GPP TS 23.502 [3]) when the AMF determines the existing PDU session cannot serve the alternative S-NSSAI. + +The requirements specified in clause 5.2.2.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.3.1-1, with the following modifications. + +The POST request shall contain: + +- the release IE set to true; +- the cause IE set to S\_NSSAI\_CONGESTION or REL\_DUE\_TO\_SLICE\_NOT\_AVAILABLE; +- optionally the skipN2PduSessionResRelInd IE with the value "true" to skip RAN resources release for the PDU session, e.g. for a PDU session with active UP associated with a slice that is no longer available after a handover. + +#### 5.2.2.3.13 Indirect Data Forwarding Tunnel establishment during N2 based Handover with I-SMF + +During N2 based handover with I-SMF insertion/change/removal, the NF Service Consumer (e.g. target I-SMF) shall use this procedure to exchange N3/N9 forwarding tunnel information with the NF Service Producer (e.g. source I-SMF). + +The NF Service Consumer (e.g. target I-SMF) shall request the SMF to establish one or more downlink and/or uplink indirect data forwarding tunnels, as follows. + +![Sequence diagram showing the indirect data forwarding tunnel establishment procedure between an NF Service Consumer and an SMF.](5391e1303dec02a02e7e42b5a4ffe58a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: POST request + NF Service Consumer->>SMF: 1.POST (dataForwarding=true, n9ForwardingTunnel) + Note left of SMF: OK or Error + SMF-->>NF Service Consumer: 2a.200 OK (n3ForwardingTunnel) + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +The diagram illustrates the interaction between the NF Service Consumer and the SMF. The NF Service Consumer sends a POST request (step 1) with parameters dataForwarding=true and n9ForwardingTunnel. The SMF responds with either a 200 OK message (step 2a) containing n3ForwardingTunnel information, or an error message (step 2b) such as 4xx/5xx (SmContextUpdateError) or 3xx. + +Sequence diagram showing the indirect data forwarding tunnel establishment procedure between an NF Service Consumer and an SMF. + +**Figure 5.2.2.3.13-1: Indirect Data Forwarding Tunnel establishment during N2 based Handover with I-SMF** + +1. The NF Service Consumer shall send a POST request, as specified in clause 5.2.2.3.1, with the following information: + - dataForwarding attribute set to true, for the N2 based handover with I-SMF insertion/change/removal; + +- n9DIForwardingTnlList attribute carrying the N9 downlink indirect data forwarding tunnel(s) info of target I-UPF; +- n9UIForwardingTnlList attribute carrying the N9 uplink indirect data forwarding tunnel(s) info of target I-UPF; +- other information, if necessary. + +2a. Same as step 2a of Figure 5.2.2.3.1-1, with the following information: + +- n3DIForwardingTnlList attribute carrying the N3 downlink indirect data forwarding tunnel(s) info of source I-UPF or source UPF; +- n3UIForwardingTnlList attribute carrying the N3 uplink indirect data forwarding tunnel(s) info of source I-UPF or source UPF; +- other information, if necessary. + +2b. If the source SMF cannot proceed with the request, the source I-SMF shall return an error response, as specified for step 2b of figure 5.2.2.3.1-1. + +#### 5.2.2.3.13A Indirect Data Forwarding Tunnel removal during N2 based Handover with I-SMF + +During N2 based handover cancellation with I-SMF insertion/change/removal, the NF Service Consumer (e.g. target I-SMF) shall use this procedure to remove previously established Indirect Data Forwarding Tunnel(s) at NF Service Producer (e.g. source I-SMF). + +The NF Service Consumer (e.g. target I-SMF) shall request the NF service producer to remove the established Indirect Data Forwarding Tunnel(s), as follows. + +![Sequence diagram for Indirect Data Forwarding Tunnel Removal during N2 based Handover with I-SMF. The diagram shows two lifelines: NF Service Consumer and SMF. Step 1: NF Service Consumer sends a POST request (dataForwarding=false) to SMF. Step 2a: SMF returns a 204 No Content response. Step 2b: SMF returns an error response (4xx/5xx SmContextUpdateError or 3xx).](d116934392360da963e91d840d1e45a8_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: 1.POST (dataForwarding=false) + NF Service Consumer->>SMF: 1.POST (dataForwarding=false) + Note right of SMF: 2a.204 No Content + SMF-->>NF Service Consumer: 2a.204 No Content + Note right of SMF: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx +``` + +Sequence diagram for Indirect Data Forwarding Tunnel Removal during N2 based Handover with I-SMF. The diagram shows two lifelines: NF Service Consumer and SMF. Step 1: NF Service Consumer sends a POST request (dataForwarding=false) to SMF. Step 2a: SMF returns a 204 No Content response. Step 2b: SMF returns an error response (4xx/5xx SmContextUpdateError or 3xx). + +**Figure 5.2.2.3.13A-1: Indirect Data Forwarding Tunnel Removal during N2 based Handover with I-SMF** + +1. The NF Service Consumer shall send a POST request, as specified in clause 5.2.2.3.1, with the following information: + +- dataForwarding attribute set to false; +- other information, if necessary. + +2a. If successful, the SMF shall return a 204 No Content response. + +2b. If the SMF cannot proceed with the request, the SMF shall return an error response, as specified for step 2b of figure 5.2.2.3.1-1. + +#### 5.2.2.3.14 Request to forward buffered downlink data packets at I-UPF + +For I-SMF change or I-SMF removal when downlink data packets are buffered at the I-UPF, the new I-SMF (for I-SMF change) or SMF (for I-SMF removal) shall request the (old) I-SMF to forward buffered downlink data packets as following: + +![Sequence diagram for Figure 5.2.2.3.14-1: Request to forward buffered downlink data packets at I-UPF. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'SMF' on the right. A solid arrow labeled '1. POST (SmContextUpdateData)' points from the NF Service Consumer to the SMF. Two dashed return arrows point from the SMF back to the NF Service Consumer: '2a. 204 No Content' and '2b. 4xx/5xx (SmContextUpdateError) or 3xx'.](73b28b0f5e3be628bb5a3d6bd1d79d21_img.jpg) + +Sequence diagram for Figure 5.2.2.3.14-1: Request to forward buffered downlink data packets at I-UPF. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'SMF' on the right. A solid arrow labeled '1. POST (SmContextUpdateData)' points from the NF Service Consumer to the SMF. Two dashed return arrows point from the SMF back to the NF Service Consumer: '2a. 204 No Content' and '2b. 4xx/5xx (SmContextUpdateError) or 3xx'. + +**Figure 5.2.2.3.14-1: Request to forward buffered downlink data packets at I-UPF** + +1. The NF Service Consumer shall send a POST request, as specified in clause 5.2.2.3.1, with the following information: + - n9ForwardingTunnel IE indicating the allocated tunnel endpoints information to receive the buffered downlink data packets. +- 2a. On success, the SMF shall initiate N4 session modification to the I-UPF trigger the sending of buffered DL data towards received tunnel endpoints and shall return "204 No Content" response. +- 2b. If the SMF cannot proceed with the request, the SMF shall return an error response, as specified for step 2b of figure 5.2.2.3.1-1. + +#### 5.2.2.3.15 Connection Suspend procedure + +The procedures specified in this clause and clause 5.2.2.3.16 are to support the Connection Suspend and Connection Resume in CM-IDLE with Suspend procedures as specified in clauses 4.8.1.2 and 4.8.2.3 of 3GPP TS 23.502 [3]. These procedures are used to support the User Plane CIoT 5GS Optimisation feature for E-UTRAN access as specified in clauses 5.31.1 and 5.31.18 of 3GPP TS 23.501 [2]. + +The NF Service Consumer (e.g. AMF) shall request the SMF to suspend the User Plane connection of an existing PDU session if the SMF support the UPCSMT feature, as follows. + +![Sequence diagram for Figure 5.2.2.3.15-1: Connection Suspend. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'SMF' on the right. A solid arrow points from the NF Service Consumer to the SMF. A dashed return arrow points from the SMF back to the NF Service Consumer.](678ac9faaa56bb929499cebeea83a110_img.jpg) + +Sequence diagram for Figure 5.2.2.3.15-1: Connection Suspend. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'SMF' on the right. A solid arrow points from the NF Service Consumer to the SMF. A dashed return arrow points from the SMF back to the NF Service Consumer. + +**Figure 5.2.2.3.15-1: Connection Suspend** + +1. The NF Service Consumer shall request the SMF to suspend the user plane connection of the PDU session by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - upCnxState attribute set to SUSPENDED; + - user location and user location timestamp; + - N2 SM information received from the 5G-AN, including UE Context Suspend Request Transfer IE, if available; + +- other information, if necessary. +- Upon receipt of such a request, the SMF shall deactivate the N3 tunnel of the PDU session, set the upCnxState attribute to SUSPENDED and return a 200 OK response including the upCnxState attribute set to SUSPENDED. The SMF shall store the N3 tunnel info (including both AN Tunnel Info and the CN Tunnel Info), and upon receiving subsequent DL Data report from the UPF, the SMF will invoke the Namf\_MT EnableUEReachability service operation to trigger the AMF to page the UE. + +#### 5.2.2.3.16 Connection Resume in CM-IDLE with Suspend procedure + +The NF Service Consumer (e.g. AMF) shall request the SMF to resume the User Plane connection of an existing PDU session, i.e. establish the N3 tunnel between the 5G-AN and UPF, as follows. + +![Sequence diagram showing the Connection Resume in CM-IDLE with Suspend procedure between an NF Service Consumer and an SMF. The diagram consists of three steps: 1. The NF Service Consumer sends a POST request (upCnxState=ACTIVATING, N2 SM Information) to the SMF. 2a. The SMF responds with a 200 OK (upCnxState=ACTIVATED, N2 SM Information). 2b. Alternatively, the SMF can respond with an error (4xx/5xx SmContextUpdateError or 3xx).](4346261cc730a1eb683f35e4ce9deacf_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note left of NF Service Consumer: + NF Service Consumer->>SMF: 1. POST (upCnxState=ACTIVATING, N2 SM Information) + Note right of SMF: + SMF-->>NF Service Consumer: 2a. 200 OK (upCnxState=ACTIVATED, N2 SM Information) + Note right of SMF: + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +Sequence diagram showing the Connection Resume in CM-IDLE with Suspend procedure between an NF Service Consumer and an SMF. The diagram consists of three steps: 1. The NF Service Consumer sends a POST request (upCnxState=ACTIVATING, N2 SM Information) to the SMF. 2a. The SMF responds with a 200 OK (upCnxState=ACTIVATED, N2 SM Information). 2b. Alternatively, the SMF can respond with an error (4xx/5xx SmContextUpdateError or 3xx). + +**Figure 5.2.2.3.16-1: Connection Resume in CM-IDLE with Suspend** + +- The NF Service Consumer shall request the SMF to resume the user plane connection of the PDU session by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - the upCnxState attribute set to ACTIVATING; + - user location and user location timestamp; + - cause attribute set to "PDU\_SESSION\_RESUMED"; + - N2 SM information received from the 5G-AN, i.e. Path Switch Request Transfer including the new transport layer address and tunnel endpoint of the downlink termination point for the user data for this PDU session (i.e. 5G-AN's GTP-U F-TEID for downlink traffic), or UE Context Resume Request Transfer; + - additional N2 SM information received from the 5G-AN, if any; + - the "MO Exception Data Counter" if the UE has accessed the network by using "MO exception data" RRC establishment cause; + - other information, if necessary. +- If the SMF can proceed with resuming the user plane connection of the PDU session, the SMF shall return a 200 OK response including the following information: + - the upCnxState attribute set to ACTIVATED; + - N2 SM information, i.e. Path Switch Response Transfer including the transport layer address and tunnel endpoint of the uplink termination point for the user data for this PDU session (i.e. UPF's GTP-U F-TEID for uplink traffic), or UE Context Resume Response Transfer. + +If the "MO Exception Data Counter" is included in the request and Small Data Rate Control is enabled for the PDU session, the V-SMF shall update the H-SMF (see clause 5.2.2.8.2.2) for HR PDU Session (or I-SMF shall update the SMF for PDU session with I-SMF). +- If the SMF cannot proceed with resuming the user plane connection of the PDU session, the SMF shall return an error response, as specified for step 2b of figure 5.2.2.3.1-1, including: + - the upCnxState attribute representing the final state of the user plane connection (e.g. SUSPENDED); + +- N2 SM information, including the cause of the failure. + +#### 5.2.2.3.17 AMF requested PDU Session Release due to Network Slice-Specific Authentication and Authorization failure or revocation + +The requirements specified in clause 5.2.2.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.3.1-1, with the following modifications. + +The POST request shall contain: + +- the release IE set to true; +- the cause IE set to REL\_DUE\_TO\_SLICE\_NOT\_AUTHORIZED. + +#### 5.2.2.3.18 5GS to EPS Idle mode mobility using N26 interface with data forwarding + +The NF Service Consumer (e.g. AMF) shall request the SMF to forward buffered DL data towards the EPS during a 5GS to EPS Idle mode mobility using N26 interface with data forwarding (see 4.11.1.3.2A of 3GPP TS 23.502 [3]), as follows. + +![Sequence diagram for 5GS to EPS Idle mode mobility using N26 interface with data forwarding. The diagram shows two participants: NF Service Consumer and SMF. The sequence of messages is: 1. POST (forwardingFTeid or forwardingBearerContexts) from NF Service Consumer to SMF; 2a. 204 No Content from SMF to NF Service Consumer; 2b. 4xx/5xx (SmContextUpdateError) or 3xx from SMF to NF Service Consumer.](215165a27ad7d72bd39fdf55a3cb7486_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: 1. POST (forwardingFTeid or forwardingBearerContexts) + NF Service Consumer->>SMF: 1. POST (forwardingFTeid or forwardingBearerContexts) + Note left of SMF: 2a. 204 No Content + SMF-->>NF Service Consumer: 2a. 204 No Content + Note left of SMF: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +Sequence diagram for 5GS to EPS Idle mode mobility using N26 interface with data forwarding. The diagram shows two participants: NF Service Consumer and SMF. The sequence of messages is: 1. POST (forwardingFTeid or forwardingBearerContexts) from NF Service Consumer to SMF; 2a. 204 No Content from SMF to NF Service Consumer; 2b. 4xx/5xx (SmContextUpdateError) or 3xx from SMF to NF Service Consumer. + +**Figure 5.2.2.3.18-1: 5GS to EPS Idle mode mobility using N26 interface with data forwarding** + +1. The NF Service Consumer shall send a POST request, as specified in clause 5.2.2.3.1, with the following information: + - forwardingFTeid received from the MME in the Context Acknowledge, if any; or + - forwarding bearer contexts received from the MME in Context Acknowledge, if any. +- 2a. Upon receipt of such a request, the SMF shall forward the buffered DL data on the forwarding tunnel(s). +- 2b. If the SMF cannot proceed with the request, the SMF shall return an error response, as specified for step 2b of figure 5.2.2.3.1-1. + +#### 5.2.2.3.19 AMF requested PDU Session Release due to Control Plane Only indication associated with PDU Session is not applicable any longer + +The requirements specified in clause 5.2.2.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.3.1-1, with the following modifications. + +The POST request shall contain: + +- the release IE set to true; +- the cause IE set to REL\_DUE\_TO\_CP\_ONLY\_NOT\_APPLICABLE. + +#### 5.2.2.3.20 AMF requested PDU Session Release due to ODB changes + +The requirements specified in clause 5.2.2.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.3.1-1, with the following modifications. + +The POST request shall contain: + +- the release IE set to true; +- the cause IE set to REL\_DUE\_TO\_SUBSCRIPTION\_CHANGE. + +#### 5.2.2.3.21 N9 Forwarding Tunnel establishment between Branching Points or UL CLs controlled by different I-SMFs + +During simultaneous change of Branching Points or UL CLs controlled by different I-SMFs, the NF Service Consumer (e.g. target I-SMF) shall use this procedure to exchange N9 forwarding tunnel information with the NF Service Producer (e.g. source I-SMF). + +The NF Service Consumer (e.g. target I-SMF) shall request the source I-SMF to establish one downlink and/or one uplink N9 data forwarding tunnels, as follows. + +![Sequence diagram showing N9 Forwarding Tunnel establishment between NF Service Consumer and SMF.](78e846f2858d131dc5a4dcbabcca1e4d_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: POST request + NF Service Consumer->>SMF: 1.POST (dataForwarding=true, n9DIForwardingTunnel) + Note left of SMF: OK response + SMF-->>NF Service Consumer: 2a.200 OK (n9UIForwardingTunnel) + Note left of SMF: Error response + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +The diagram illustrates the interaction between an NF Service Consumer and an SMF. The NF Service Consumer sends a POST request (step 1) with 'dataForwarding=true' and 'n9DIForwardingTunnel' attributes to the SMF. The SMF responds with a 200 OK message (step 2a) containing 'n9UIForwardingTunnel' information, or an error response (step 2b) with a 4xx/5xx status code and 'SmContextUpdateError' or a 3xx status code. + +Sequence diagram showing N9 Forwarding Tunnel establishment between NF Service Consumer and SMF. + +**Figure 5.2.2.3.21-1: N9 Forwarding Tunnel establishment between Branching Points or UL CLs controlled by different I-SMFs** + +- The NF Service Consumer shall send a POST request, as specified in clause 5.2.2.3.1, with the following information: + - dataForwarding attribute set to true, for the N9 Forwarding Tunnel establishment between Branching Points or UL CLs controlled by different I-SMFs; + - n9DIForwardingTunnel attribute carrying the N9 downlink data forwarding tunnel info of target Branching Point or UL CL; + - other information, if necessary. +- Same as step 2a of Figure 5.2.2.3.1-1, with the following information: + - n9UIForwardingTunnel attribute carrying the N9 uplink data forwarding tunnel info of source Branching Point or UL CL; + - other information, if necessary. +- If the source I-SMF cannot proceed with the request, the source I-SMF shall return an error response, as specified for step 2b of figure 5.2.2.3.1-1. + +#### 5.2.2.3.22 Remote UE Report during 5G ProSe Communication via 5G ProSe Layer-3 UE-to-Network Relay without N3IWF procedure + +The requirements specified in clause 5.2.2.3.1 shall apply with the following modifications. + +- Same as step 1 of Figure 5.2.2.3.1-1, with the following modifications. + +The POST request shall contain: + +- the n1SmMsg IE containing the Remote UE Report NAS Message. + +For Home-Routed PDU Session or PDU session with I-SMF, the V-SMF or I-SMF shall invoke the Update service operation on the (H-)SMF, as specified in clause 5.2.2.8.2.24. + +- Same as step 2 of Figure 5.2.2.3.1-1, with the following modifications. + +The POST response shall contain: + +- the n1SmMsg IE containing the Remote UE Report Response NAS Message. + +#### 5.2.2.3.23 AMF requested PDU Session Release due to V/I-SMF failure + +The AMF may request PDU Session Release towards an alternative V/I-SMF in the same SMF Set when it detects the V/I-SMF has failed and if the V/I-SMF supports the DLSET feature while the (H-)SMF doesn't support the PSETR feature as specified in clause 6.8.2 of 3GPP TS 23.527 [24]. When the AMF sends an Update SM Context Request, the requirements specified in clause 5.2.2.3.1 shall apply with the following modifications. + +- Same as step 1 of Figure 5.2.2.3.1-1, with the following modifications. + +The POST request shall contain: + +- the release IE set to true; +- the cause IE set to REL\_DUE\_TO\_SMF\_NOT\_SUPPORT\_PSETR. + +#### 5.2.2.3.24 Connection Inactive procedure with CN based MT communication handling + +The NF Service Consumer (e.g. AMF) shall request the SMF to apply CN based MT communication handling as specified in clauses 4.8.1.1a and 4.8.2.2b of 3GPP TS 23.502 [3] when the AMF is notified by the NG-RAN that the NG-RAN has transited the UE using eDRX to RRC\_INACTIVE state and the SMF supports the UPCSMT feature (see clause 6.1.8). + +![Sequence diagram for NG-RAN initiated Connection Inactive procedure. The NF Service Consumer sends a POST request (upCnxState=SUSPENDED, cnBasedMt=true) to the SMF. The SMF responds with 200 OK (upCnxState=SUSPENDED) and a box indicating 'upCnxState SUSPENDED and CN based MT handling is to be applied'. A dashed line represents a potential error response (4xx/5xx or 3xx).](507e8bc710c80563f5ee9e2f0ebb603d_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of SMF: upCnxState SUSPENDED +and CN based MT handling +is to be applied + NF Service Consumer->>SMF: 1. POST (upCnxState=SUSPENDED, cnBasedMt=true) + SMF-->>NF Service Consumer: 2a. 200 OK (upCnxState=SUSPENDED) + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +Sequence diagram for NG-RAN initiated Connection Inactive procedure. The NF Service Consumer sends a POST request (upCnxState=SUSPENDED, cnBasedMt=true) to the SMF. The SMF responds with 200 OK (upCnxState=SUSPENDED) and a box indicating 'upCnxState SUSPENDED and CN based MT handling is to be applied'. A dashed line represents a potential error response (4xx/5xx or 3xx). + +**Figure 5.2.2.3.24-1: NG-RAN initiated Connection Inactive procedure** + +- The NF Service Consumer shall request the SMF to suspend the user plane connection of the PDU session by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + - cnBasedMt is set to "true" + - upCnxState attribute set to SUSPENDED; + - user location and user location timestamp; + - N2 SM information received from the 5G-AN, e.g. Secondary RAT Data Usage, if available; + - other information, if necessary. + +**Editor's Note:** The N2 message and N2 IE(s) are to be aligned with RAN3. + +NOTE 1: As an implementation option, the AMF can force the UE to enter CM Idle if the SMF does not support the UPCSMT feature. + +2a. Upon receipt of such a request, the SMF shall keep the NG-RAN N3 DL F-TEID and set the upCnxState attribute to SUSPENDED and return a 200 OK response including the upCnxState attribute set to SUSPENDED. The SMF will request the UPF to buffer any subsequent downlink data and report the receiving DL data to the SMF. Upon receiving DL data report, the SMF will invoke the Namf\_MT\_EnableUEReachability service operation when the upCnxState of the PDU session is set to SUSPENDED, to trigger a NG-RAN paging. + +NOTE 2: The SMF applies the same behaviour for a PDU session with user plane connection set to "SUSPENDED" with or without a cnBasedMt indication. The cnBasedMt indication can be used for statistics purpose for UEs entering RRC\_Inactive with long eDRX. + +2b. Same as step 2b of figure 5.2.2.3.1-1. + +### 5.2.2.3.25 UE Triggered Connection Resume in RRC Inactive procedure + +Upon receiving a notification from NG-RAN that the UE is in RRC\_CONNECTED mode or when receiving from NG-RAN a MT Communication Handling request indicating the UE is now reachable for downlink data and/or signalling as specified in clause 4.8.2.2 of 3GPP TS 23.502 [3], the NF Service Consumer (e.g. AMF) shall request the SMF to resume the User Plane connection of an existing PDU session, i.e. establish the N3 tunnel between the 5G-AN and UPF, as follows. + +![Sequence diagram for UE Triggered Connection Resume in RRC Inactive procedure. The diagram shows two participants: NF Service Consumer and SMF. The sequence of messages is: 1. POST (upCnxState=ACTIVATING, N2 SM Information) from NF Service Consumer to SMF; 2a. 200 OK (upCnxState=ACTIVATED, N2 SM Information) from SMF to NF Service Consumer; 2b. 4xx/5xx (SmContextUpdateError) or 3xx from SMF to NF Service Consumer (indicated by a dashed line).](c3e8a7fe2e4f51806e05b9b1aae20d57_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note left of NF Service Consumer: UE in RRC_CONNECTED mode or MT Communication Handling request + NF Service Consumer->>SMF: 1. POST (upCnxState=ACTIVATING, N2 SM Information) + SMF-->>NF Service Consumer: 2a. 200 OK (upCnxState=ACTIVATED, N2 SM Information) + SMF-->>NF Service Consumer: 2b. 4xx/5xx (SmContextUpdateError) or 3xx + +``` + +Sequence diagram for UE Triggered Connection Resume in RRC Inactive procedure. The diagram shows two participants: NF Service Consumer and SMF. The sequence of messages is: 1. POST (upCnxState=ACTIVATING, N2 SM Information) from NF Service Consumer to SMF; 2a. 200 OK (upCnxState=ACTIVATED, N2 SM Information) from SMF to NF Service Consumer; 2b. 4xx/5xx (SmContextUpdateError) or 3xx from SMF to NF Service Consumer (indicated by a dashed line). + +**Figure 5.2.2.3.25-1: UE Triggered Connection Resume in RRC Inactive** + +1. The NF Service Consumer shall request the SMF to resume the user plane connection of the PDU session by sending a POST request, as specified in clause 5.2.2.3.1, with the following information: + +- the upCnxState attribute set to ACTIVATING; +- user location and user location timestamp; +- cause attribute set to "PDU\_SESSION\_RESUMED"; +- N2 SM information received from the 5G-AN, i.e. the Path Switch Request Transfer including the new transport layer address and tunnel endpoint of the downlink termination point for the user data for this PDU session (i.e. 5G-AN's GTP-U F-TEID for downlink traffic), or the N2 Notification Request Transfer; + +**Editor's Note:** The N2 message (and its IEs, e.g. N2 Notification Request/Response Transfer) to notify the AMF that UE transits into RRC\_CONNECTED when the NG-RAN has the UE context is to be aligned with NGAP specification. + +- additional N2 SM information received from the 5G-AN, if any; +- other information, if necessary. + +2a. If the SMF can proceed with resuming the user plane connection of the PDU session, i.e. request the UPF to forward any received DL data to the NG-RAN DL F-TEID which is stored in the SMF when the SMF is + +requested to apply CN based MT handling, the SMF shall return a 200 OK response including the following information: + +- the upCnxState attribute set to ACTIVATED; +- N2 SM information, i.e. Path Switch Response Transfer including the transport layer address and tunnel endpoint of the uplink termination point for the user data for this PDU session (i.e. UPF's GTP-U F-TEID for uplink traffic), or N2 Notification Response Transfer. + +2b. If the SMF cannot proceed with resuming the user plane connection of the PDU session, the SMF shall return an error response, as specified for step 2b of figure 5.2.2.3.1-1, including: + +- the upCnxState attribute representing the final state of the user plane connection (e.g. DEACTIVATED); +- N2 SM information, including the cause of the failure. + +#### 5.2.2.3.26 AMF requested PDU Session Release due to Network Slice instance not available + +The requirements specified in clause 5.2.2.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.3.1-1, with the following modifications. + +The POST request shall contain: + +- the release IE set to true; +- the cause IE set to "REL\_DUE\_TO\_NSI\_NOT\_AVAILABLE". + +#### 5.2.2.3.27 AMF requested PDU Session Release due to MBSR not authorized + +The requirements specified in clause 5.2.2.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.3.1-1, with the following modifications. + +The POST request shall contain: + +- the release IE set to true; +- the cause IE set to "REL\_DUE\_TO\_MBSR\_NOT\_AUTHORIZED". + +### 5.2.2.4 Release SM Context service operation + +#### 5.2.2.4.1 General + +The Release SM Context service operation shall be used to release the SM Context of a given PDU session, in the SMF, in the V-SMF for HR roaming scenarios, or in the I-SMF for a PDU session with an I-SMF, in the following procedures: + +- Registration procedure with I-SMF/V-SMF change and removal (see clause 4.23.3 of 3GPP TS 23.502 [3]); +- UE Triggered Service Request with I-SMF change and removal or V-SMF change (see clause 4.23.4.3 of 3GPP TS 23.502 [3]); +- UE initiated Deregistration (see clause 4.2.2.3.2 of 3GPP TS 23.502 [3]); +- Network initiated Deregistration, e.g. AMF initiated deregistration (see clause 4.2.2.3.3 of 3GPP TS 23.502 [3]), UDM triggered deregistration by sending Deregistration notification with initial Registration indication (see clause 4.2.2.2.2 of 3GPP TS 23.502 [3]); +- Network requested PDU session release (see clause 4.3.4.2 of 3GPP TS 23.502 [3]), e.g. AMF initiated release: + - when there is a mismatch of the PDU session status between the UE and the; + +- when there is a change of the set of network slices for a UE where a network slice instance is no longer available (as described in clause 5.15.5.2.2 of 3GPP TS 23.501 [2] and in clause 4.2.2.2 of 3GPP TS 23.502 [3]) and the PDU session is not activated; +- when there is a PDU session rejected by the new AMF to the old AMF during Registration procedure (as described in clause 4.2.2.2.2 of 3GPP TS 23.502 [3]); or +- due to Mobility or Access Restrictions (see clause 5.16.4.3 of 3GPP TS 23.501 [2]). +- 5GS to EPS Idle mode mobility or handover, to release the SM context in the V-SMF only for a Home Routed PDU session or in the I-SMF only for a PDU session with an I-SMF (see clauses 4.23.12.2 and 4.23.12.6 of 3GPP TS 23.502 [3]), for the PDU sessions that are transferred to EPC; +- 5GS to EPS handover using N26 interface and 5GS to EPS Idle mode mobility using N26, to release the PDU session not transferred to EPC (see clauses 4.11.1.2.1 and 4.11.1.3.2 of 3GPP TS 23.502 [3]); +- Inter NG-RAN node Xn based handover and N2 based handover with I-SMF change and removal; +- 5G-SRVCC from NG-RAN to 3GPP UTRAN procedure (see clause 6.5.4 of 3GPP TS 23.216 [35]); +- 5G-RG Deregistration via W-5GAN (see clause 7.2.1.2 of 3GPP TS 23.316 [36]); +- FN-RG Deregistration via W-5GAN (see clause 7.2.1.4 of 3GPP TS 23.316 [36]); +- Non-5G capable device behind 5G-CRG and FN-CRG Deregistration via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [36]); +- 5G-RG or Network requested PDU Session Release via W-5GAN (see clause 7.3.3 of 3GPP TS 23.316 [36]); +- FN-RG or Network Requested PDU Session Release via W-5GAN (see clause 7.3.7 of 3GPP TS 23.316 [36]); +- Non-5G capable device behind 5G-CRG and FN-CRG or Network Requested PDU Session Release via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [36]); +- Mobility procedures with AMF changes (e.g. Registration / N2 based handover with AMF changes), to release the MA-PDU session if target AMF does not support MA-PDU session (see clause 4.22.9 of 3GPP TS 23.502 [3]). + +The SMF shall release the SM context without sending any signalling towards the 5G-AN and the UE. + +The NF Service Consumer (e.g. AMF) shall release the SM Context of a given PDU session by using the HTTP "release" custom operation as shown in Figure 5.2.2.4.1-1. + +![Sequence diagram showing SM context release between NF Service Consumer and SMF.](21327313f7b18a481da0c87a6472a80d_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: 1. POST .../sm-contexts/{smContextRef}/release (SmContextReleaseData) + NF Service Consumer->>SMF: 1. POST .../sm-contexts/{smContextRef}/release (SmContextReleaseData) + Note left of SMF: -2a. 200 OK (SmContextReleasedData) / 204 No Content + SMF-->>NF Service Consumer: -2a. 200 OK (SmContextReleasedData) / 204 No Content + Note left of SMF: -2b. 4xx/5xx (ProblemDetails) or 3xx + SMF-->>NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +The diagram illustrates the interaction for SM context release. It starts with the NF Service Consumer sending a POST request to the SMF. The request path is labeled '1. POST .../sm-contexts/{smContextRef}/release (SmContextReleaseData)'. The SMF then responds with one of two possible messages: '-2a. 200 OK (SmContextReleasedData) / 204 No Content' or '-2b. 4xx/5xx (ProblemDetails) or 3xx'. These response paths are shown as dashed lines returning from the SMF to the NF Service Consumer. + +Sequence diagram showing SM context release between NF Service Consumer and SMF. + +**Figure 5.2.2.4.1-1: SM context release** + +1. The NF Service Consumer shall send a POST request to the resource representing the individual SM context to be deleted. The content of the POST request shall contain any data that needs to be passed to the SMF and/or N2 SM information (if Secondary RAT usage data needs to be reported). + +For a 5GS to EPS Idle mode mobility or handover, for a Home Routed PDU session associated with 3GPP access and with assigned EBI(s), the POST request shall contain the vsmfReleaseOnly indication; for a PDU session with an I-SMF and assigned EBI(s), the POST request shall contain the ismfReleaseOnly indication. + +For a 5GS to EPS Idle mode mobility or handover, for a Home Routed PDU session associated with 3GPP access and with no assigned EBI(s), the POST request shall not contain the vsmfReleaseOnly indication to + +release the PDU session in the V-SMF and H-SMF; for a PDU session with an I-SMF and with no assigned EBI(s), the POST request shall not contain the ismfReleaseOnly indication to release the PDU session in the I-SMF and SMF. + +For Registration, UE Triggered Service Request, Inter NG-RAN node Xn based handover and N2 based handover procedures with I-SMF change or removal, the POST request shall contain the ismfReleaseOnly indication; if with V-SMF change or removal, the POST request shall contain the vsmfReleaseOnly indication. + +For 5G-SRVCC from NG-RAN to 3GPP UTRAN, the POST request body shall contain the "cause" attribute with the value "REL\_DUE\_TO\_PS\_TO\_CS\_HO". + +- 2a. On success, the SMF shall return a "200 OK" with message body containing the representation of the SmContextReleasedData when information needs to be returned to the NF Service Consumer, or a "204 No Content" response with an empty content in the POST response. + +If the POST request contains a vsmfReleaseOnly indication (i.e. for a 5GS to EPS Idle mode mobility or handover, for a Home Routed PDU session with assigned EBI(s)), the V-SMF shall release its SM context and corresponding PDU session resource locally, i.e. without signalling towards the H-SMF. + +If the POST request contains an ismfReleaseOnly indication (i.e. for a 5GS to EPS Idle mode mobility or handover, for a PDU session with an I-SMF and assigned EBI(s)), the I-SMF shall release its SM context and corresponding PDU session resource locally, i.e. without signalling towards the SMF. + +If the POST request body contains the "cause" attribute with the value "REL\_DUE\_TO\_PS\_TO\_CS\_HO", the SMF shall indicate to the PCF within SM Policy Association termination that the PDU session is released due to 5G-SRVCC, or the cause value shall be passed from the V-SMF to the H-SMF (for a HR PDU session) or from the I-SMF to the SMF (for a PDU session with an I-SMF) within the Release service operation. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.4.3.2-2 shall be returned. For a 4xx/5xx response, the message body shall include a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.3.4.3.2-2. + +## 5.2.2.5 Notify SM Context Status service operation + +### 5.2.2.5.1 General + +The Notify SM Context Status service operation shall be used by the SMF to notify the NF Service Consumer about the status of an SM context related to a PDU session (e.g. when the SM context is released and the release is not triggered by a Release SM Context Request, or when the SM context is moved to another system, or when the control of the PDU session is taken over by another I-SMF/V-SMF/SMF in the same SMF set) in the SMF, or in the V-SMF for HR roaming scenarios, or in the I-SMF for a PDU session with an I-SMF. + +The Notify SM Context Status service operation may also be used by the SMF to provide the SMF derived CN assisted RAN parameters tuning to the NF Service Consumer (e.g. AMF), if the NF Service Consumer has indicated support of the CARPT (CN Assisted RAN Parameters Tuning) feature. + +The Notify SM Context Status service operation may also be used by the SMF to notify the DDN failure status. + +The Notify SM Context Status service operation may also be used to inform the NF service consumer (e.g. AMF) that the V-SMF has created the PDU session towards an alternative H-SMF for a HR PDU session or the I-SMF has created the PDU session towards an alternative SMF for a PDU session with I-SMF, during the PDU session establishment procedure. + +It is used in the following procedures: + +- UE requested PDU Session Establishment procedure, when the PDU session establishment fails after the Create SM Context response or to provide the SMF derived CN assisted RAN parameters tuning, or when an alternative H-SMF is used by the V-SMF for a HR PDU session (see clause 4.3.2.2 of 3GPP TS 23.502 [3]), or when an alternative SMF is used by the I-SMF for a PDU session with an I-SMF (see clause 4.23.5.1 of 3GPP TS 23.502 [3]); +- UE or Network requested PDU session Modification (see clause 4.3.3.2 of 3GPP TS 23.502 [3]) to provide the SMF derived CN assisted RAN parameters tuning; + +- UE or Network requested PDU session release (see clause 4.3.4.2 of 3GPP TS 23.502 [3]), e.g. SMF initiated release; +- Handover of a PDU Session procedure between untrusted non-3GPP to 3GPP access (see clauses 4.9.2.3.2, 4.9.2.4.2 and 4.23.16.2 of 3GPP TS 23.502 [3]); +- Interworking procedures without N26 interface, e.g. 5GS to EPS Mobility (see clause 4.11.2.2 of 3GPP TS 23.502 [3]); +- Handover from 5GC-N3IWF to EPS (see clause 4.11.3.2 of 3GPP TS 23.502 [3]); +- Handover from 5GS to EPC/ePDG (see clause 4.11.4.2 of 3GPP TS 23.502 [3]); +- I-SMF Context Transfer (see clause 4.26.5.2 of 3GPP TS 23.502 [3]); +- SMF Context Transfer procedure, LBO or no Roaming, no I-SMF (see clause 4.26.5.3 of 3GPP TS 23.502 [3]); +- Handover from W-5GAN/5GC to 3GPP access/EPS (see clause 7.6.4.2 of 3GPP TS 23.316 [36]); +- 5G-RG requested PDU Session Establishment via W-5GAN (see clause 7.3.1 of 3GPP TS 23.316 [36]); +- 5G-RG or Network requested PDU Session Modification via W-5GAN (see clause 7.3.2 of 3GPP TS 23.316 [36]); +- 5G-RG or Network requested PDU Session Release via W-5GAN (see clause 7.3.3 of 3GPP TS 23.316 [36]) +- FN-RG related PDU Session Establishment via W-5GAN (see clause 7.3.4 of 3GPP TS 23.316 [36]); +- FN-RG or Network Requested PDU Session Modification via W-5GAN (see clause 7.3.6 of 3GPP TS 23.316 [36]); +- FN-RG or Network Requested PDU Session Release via W-5GAN (see clause 7.3.7 of 3GPP TS 23.316 [36]); +- Non-5G capable device behind 5G-CRG and FN-CRG requested PDU Session Establishment via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [36]); +- Non-5G capable device behind 5G-CRG and FN-CRG or Network requested PDU Session Modification via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [36]); +- Non-5G capable device behind 5G-CRG and FN-CRG or Network requested PDU Session Release via W-5GAN (see clause 4.10a of 3GPP TS 23.316 [36]); +- Handover between 3GPP access/5GC and W-5GAN access (see clause 7.6.3 of 3GPP TS 23.316 [36]); +- Handover from 3GPP access/EPS to W-5GAN/5GC (see clause 7.6.4.1 of 3GPP TS 23.316 [36]); +- Information flow for Availability after DDN Failure with SMF buffering (see clause 4.15.3.2.7 of 3GPP TS 23.502 [3]); +- Information flow for Availability after DDN Failure with UPF buffering (see clause 4.15.3.2.9 of 3GPP TS 23.502 [3]); +- The control of the PDU session is taken over by a new anchor SMF within the same SMF set (see clause 5.22 of 3GPP TS 29.244 [29]) or taken over by a new intermediate SMF (e.g. I-SMF or V-SMF) within the same SMF set, and the new SMF instance decides to notify the change of SMF; +- SMF triggered I-SMF selection or removal (see clause 4.23.5.4 of 3GPP TS 23.502 [3]); +- Change of SSC mode 2 PDU Session Anchor with different PDU Sessions (see clause 4.3.5.1 of 3GPP TS 23.502 [3]); +- Change of SSC mode 3 PDU Session Anchor with multiple PDU Sessions (see clause 4.3.5.2 of 3GPP TS 23.502 [3]); +- Network triggered EAS change in HR-SBO context (see clause 6.7.3.2 of 3GPP TS 23.548 [74]); + +- Network slice usage behaviour control, i.e. SMF initiated PDU session release due to slice inactivity, see clause 5.15.15.3 of 3GPP TS 23.501 [2]. + +The SMF shall notify the NF Service Consumer by using the HTTP POST method as shown in Figure 5.2.2.5.1-1. + +![Sequence diagram showing SM context status notification from SMF to NF Service Consumer. The SMF sends a POST request to the smContextStatusUri. The NF Service Consumer responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx status.](1033dc9fde75540d224c907681b1b7aa_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant NFSC as NF Service Consumer + Note left of SMF: 1. POST {smContextStatusUri} (SmContextStatusNotification) + SMF->>NFSC: + Note right of SMF: -2a. 204 No Content- + SMF-->>NFSC: + Note right of SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + SMF-->>NFSC: + +``` + +Sequence diagram showing SM context status notification from SMF to NF Service Consumer. The SMF sends a POST request to the smContextStatusUri. The NF Service Consumer responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx status. + +**Figure 5.2.2.5.1-1: SM context status notification** + +1. The SMF shall send a POST request to the SM Context Status callback reference provided by the NF Service Consumer during the subscription to this notification. The content of the POST request shall contain the notification content. + +If the notification is triggered by PDU session handover to release resources of the PDU session in the source access, the notification content shall contain the resourceStatus IE with the value "RELEASED" and the Cause IE with the value "PDU\_SESSION\_HANDED\_OVER" as specified in clause 4.9.2.3.2 of 3GPP TS 23.502 [3]. + +If the notification is triggered by PDU session handover to release only the SM Context with the I-SMF in the source access but without releasing the PDU session in the AMF, the notification content shall contain the resourceStatus IE with the value "UPDATED" and the Cause IE with the value "PDU\_SESSION\_HANDED\_OVER" as specified in clause 4.23.16.2 of 3GPP TS 23.502 [3]. If the notification is triggered by PDU session handover to release resources of the PDU session in the target access due to handover failure between 3GPP access and non-3GPP access, the notification content shall contain the resourceStatus IE with the value "RELEASED" and the Cause IE with the value "PDU\_SESSION\_HAND\_OVER\_FAILURE". + +If the NF Service Consumer indicated support of the HOFAIL feature (see clause 6.1.8) and if the notification is triggered by PDU session handover to update the access type of the PDU session due to a handover failure between 3GPP access and non-3GPP access, the notification content shall contain the resourceStatus IE with the value "UPDATED", the anType IE with the value "3GPP" or "NON\_3GPP" indicating the access type of the PDU session after the handover failure scenario and the Cause IE with the value "PDU\_SESSION\_HAND\_OVER\_FAILURE". + +If the notification is triggered by the SMF derived CN assisted RAN parameters tuning, the notification content shall contain the resourceStatus IE with the value "UNCHANGED" and the Cause IE with the value "CN\_ASSISTED\_RAN\_PARAMETER\_TUNING". + +If the notification is triggered by SMF Context Transfer procedure, the notification content shall contain the Cause IE with the value "ISMF\_CONTEXT\_TRANSFER" or "SMF\_CONTEXT\_TRANSFER". + +If the notification is triggered by the report of the DDN failure, the notification content shall contain the resourceStatus IE with the value "UNCHANGED" and the Cause IE with the value "DDN\_FAILURE\_STATUS". + +If the notification is triggered to report that an alternative (H-)SMF has been used during a HR PDU session establishment or the establishment of a PDU session with an I-SMF, the notification content shall contain the resourceStatus IE with the value "ALT\_ANCHOR\_SMF". The notification content shall also include the altAnchorSmfUri IE containing the API URI of the alternative (H-)SMF used for the PDU session and if available the altAnchorSmfId IE containing the NF Instance Id of the alternative (H-)SMF. The Notification shall only be sent to the NF service consumer (e.g. AMF) supporting the AASN feature. + +For a PDU session without an I-SMF or V-SMF, if upon a change of anchor SMF, the new anchor SMF instance decides to notify the change of anchor SMF, then the notification content shall contain the resourceStatus IE with the value "UPDATED" and the Cause IE with the value "CHANGED\_ANCHOR\_SMF". In addition, the new anchor SMF shall include its SMF Instance ID in the notification content, and/or carry an updated binding + +indication in the HTTP headers to indicate the change of anchor SMF (as per step 6 of clause 6.5.3.3 of 3GPP TS 29.500 [4]). + +For a PDU session with an I-SMF or V-SMF, if upon a change of intermediate SMF (e.g. I-SMF or V-SMF), the new intermediate SMF instance decides to notify the change of intermediate SMF, then the notification content shall contain the resourceStatus IE with the value "UPDATED" and the Cause IE with the value "CHANGED\_INTERMEDIATE\_SMF". In addition, the new intermediate SMF shall include its SMF Instance ID in the notification content, and/or carry an updated binding indication in the HTTP headers to indicate the change of intermediate SMF (as per step 6 of clause 6.5.3.3 of 3GPP TS 29.500 [4]). + +For a PDU session with an I-SMF or V-SMF, if the notification is triggered by the change of the anchor SMF (e.g. the PDU session is taken over by a new SMF within the same SMF Set selected by the UPF), the notification content shall contain the resourceStatus IE with the value "UPDATED", the Cause IE with the value "CHANGED\_ANCHOR\_SMF" and the SMF Instance ID of the new anchor SMF. + +If the notification is triggered by SMF for I-SMF selection or removal or V-SMF selection for the current PDU session, or SMF selection during PDU Session re-establishment for SSC mode 2/3, the notification content shall contain the resourceStatus IE with the value "UNCHANGED", the Cause IE with the value "TARGET\_DNAI\_NOTIFICATION" and the targetDnaiInfo IE. The targetDnai IE in the targetDnaiInfo IE shall be absent if the I-SMF removal is triggered due to the DNAI currently served by the I-SMF being no longer used for the PDU Session. If the notification is triggered for SMF selection during PDU Session re-establishment for SSC mode 3, the notification content may also contain the oldPduSessionRef IE received from the SMF or the oldSmContextRef IE as specified in clause 4.3.5.2 of 3GPP TS 23.502 [3]. + +If the notification is triggered by a PDU session release due to slice inactivity as specified in clause 5.15.15.3 of 3GPP TS 23.501 [2] and clause 5.11.2 of 3GPP TS 29.244 [29], the notification content shall contain the resourceStatus IE with the value "RELEASED" and the Cause IE with the value "REL\_DUE\_TO\_SLICE\_INACTIVITY". + +- 2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. + +If the SMF indicated in the request that the SM context resource is released, the NF Service Consumer shall release its association with the SMF for the PDU session and release the EBI(s) that were assigned to the PDU session. + +If the SMF indicated in the request that the SM context resource is updated with the anType IE, the NF Service Consumer shall change the access type of the PDU session with the value of anType IE. + +If the notification request was triggered by PDU session handover to release only the SM Context with the I-SMF in the source access but without releasing the PDU session in the AMF, the AMF shall remove its resources associated to the SM context with the I-SMF, but the AMF shall not release the PDU session in the AMF, and the I-SMF shall remove its resources associated to the PDU session. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.7.3.1-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.7.3.1-2. + +If the NF Service Consumer (e.g. AMF) is not able to handle the notification but knows by implementation specific means that another NF Service Consumer (e.g. AMF) is able to handle the notification (e.g. AMF deployment with Backup AMF), it shall reply with an HTTP "307 temporary redirect" response pointing to the URI of the new NF Service Consumer. If the NF Service Consumer is not able to handle the notification but another unknown NF Service Consumer could possibly handle the notification (e.g. AMF deployment with UDSF), it shall reply with an HTTP "404 Not found" error response. + +If the SMF receives a "307 temporary redirect" response, the SMF shall use this URI as Notification URI in subsequent communication and shall resend the notification to that URI. + +If the SMF becomes aware that a new NF Service Consumer (e.g. AMF) is requiring notifications (e.g. via the "404 Not found" response or via Namf\_Communication service AMFStatusChange Notifications, or via link level failures, see clause 6.5.2 of 3GPP TS 29.500 [4]), and the SMF knows alternate or backup Address(es) where to send Notifications (e.g. via the GUAMI and/or backupAmfInfo received when the SM context was established or via AMFStatusChange Notifications, or via the Nnrf\_NFDiscovery service specified in 3GPP TS 29.510 [19] using the service name and GUAMI or backupAMFInfo obtained during the creation of the SM context, see clause 6.5.2.2 of 3GPP TS 29.500 [4]), the SMF shall exchange the authority part of the + +corresponding Notification URI with one of those addresses and shall use that URI in subsequent communication; the SMF shall resend the notification to that URI. + +## 5.2.2.6 Retrieve SM Context service operation + +### 5.2.2.6.1 General + +The Retrieve SM Context service operation shall be used to retrieve an individual SM context, for a given PDU session, from the (H-)SMF, from the V-SMF during change or removal of V-SMF, or from the I-SMF during change or removal of I-SMF. + +It is used in the following procedures: + +- 5GS to EPS handover using N26 interface (see clause 4.11.1.2.1 of 3GPP TS 23.502 [3]), for PDU sessions associated with 3GPP access; +- 5GS to EPS Idle mode mobility using N26 interface (see clause 4.11.1.3.2 of 3GPP TS 23.502 [3]), for PDU sessions associated with 3GPP access; +- UE Triggered Service Request with I-SMF insertion/change/removal or with V-SMF insertion/change/removal (see clause 4.23.4.3 of 3GPP TS 23.502 [3]); +- Xn based inter NG-RAN handover with insertion of intermediate SMF (see clause 4.23.11 of 3GPP TS 23.502 [3]), for PDU sessions associated with 3GPP access; +- Inter NG-RAN node N2 based handover, preparation phase, with I-SMF or V-SMF insertion/change (see clause 4.23.7.3.2 of 3GPP TS 23.502 [3]), for PDU sessions associated with 3GPP access; +- SMF Context Transfer procedure, LBO or no Roaming, no I-SMF (see clause 4.26.5.3 of 3GPP TS 23.502 [3]), for PDU sessions associated with 3GPP access; +- I-SMF selection per DNAI (see clause 4.23.5.4 of 3GPP TS 23.502 [3]); +- Change of SSC mode 3 PDU Session Anchor with multiple PDU Sessions (see clause 4.3.5.2 of 3GPP TS 23.502 [3]); +- Network triggered EAS change in HR-SBO context (see clause 6.7.3.2 of 3GPP TS 23.548 [74]); +- N2 Handover with V-SMF insertion/change/removal in HR-SBO case (see clause 6.7.2.6 of 3GPP TS 23.548 [39]); +- Inter V-SMF mobility registration update procedure in HR-SBO case (see clause 6.7.2.7 of 3GPP TS 23.548 [39]); +- Xn Handover with V-SMF change in HR-SBO case (see clause 6.7.2.9 of 3GPP TS 23.548 [39]). + +The NF Service Consumer (e.g. AMF or SMF) shall retrieve an SM context by using the HTTP POST method (retrieve custom operation) as shown in Figure 5.2.2.6.1-1. + +![Sequence diagram showing SM context retrieval between NF Service Consumer and SMF.](87b70d2e8951032d28b4412d82cf1413_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: 1. POST .../sm-contexts/{smContextRef}/retrieve (SmContextRetrieveData) + NF Service Consumer->>SMF: Request + Note left of SMF: 2a. 200 OK (SmContextRetrievedData) + SMF-->>NF Service Consumer: Response 2a + Note left of SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + SMF-->>NF Service Consumer: Response 2b + +``` + +The diagram illustrates the interaction for SM context retrieval. It starts with the NF Service Consumer sending a POST request to the SMF. The request is labeled '1. POST .../sm-contexts/{smContextRef}/retrieve (SmContextRetrieveData)'. The SMF responds with either '2a. 200 OK (SmContextRetrievedData)' or '2b. 4xx/5xx (ProblemDetails) or 3xx'. The responses are shown as dashed arrows pointing back to the consumer. + +Sequence diagram showing SM context retrieval between NF Service Consumer and SMF. + +Figure 5.2.2.6.1-1: SM context retrieval + +1. The NF Service Consumer shall send a POST request to the resource representing the individual SM context to be retrieved. The POST request may contain a content with the following parameters: + +- target MME capabilities, if available, to allow the SMF to determine whether to include EPS bearer contexts for Ethernet PDN Type, non-IP PDN type, or requiring UP integrity protection or not; + - SM context type: + - indicating that this is a request to retrieve the complete SM context (i.e. 5G SM context including EPS context information as defined in clause 6.1.6.2.39), during scenarios with an I-SMF or V-SMF insertion/change/removal or SMF Context Transfer procedure; or + - indicating that this is a request to retrieve the AF Coordination Information as defined in clause 6.1.6.2.69, during the change of SSC mode 3 PDU Session Anchor with multiple PDU Sessions, if the runtime coordination between old SMF and AF is enabled. + - serving core network operator PLMN ID of the new V-SMF, when the procedure is triggered by a new V-SMF, if the new V-SMF supports inter-PLMN V-SMF change or insertion. Or the serving core network operator PLMN ID of the new I-SMF during the procedure with an I-SMF insertion; + - notToTransferEbiList IE, if the SM context type IE is absent or indicate a request to retrieve the EPS PDN connection, to request the SMF to not transfer EPS bearer context(s) corresponding to EBIs in the list, during an 5GS to EPS mobility when the target MME does not support 15 EPS bearers; + - ranUnchangedInd IE, if the NG-RAN Tunnel info is required in scenario of I-SMF/V-SMF change/insertion during registration procedure after EPS to 5GS handover, I-SMF selection/removal per DNAI or V-SMF selection per DNAI, when the UE is in CM-CONNECTED state as specified in clauses 5.2.2.2.7 and 5.2.2.2.12; + - hrsboSupportInd IE, if the procedure is triggered by a target V-SMF supporting the HR-SBO feature; + - storedOffloadIds IE, if the target V-SMF has a list of stored offload identifiers from the previous procedures for the HPLMN of the PDU session. +- 2a. On success, "200 OK" shall be returned; the content of the POST response shall contain the mapped EPS bearer contexts if this is a request for the UE EPS PDN connection, or the complete SM context if this is a request for retrieving the complete SM context, or the AF Coordination Information if this is a request for retrieving the AF Coordination Information. + +If this is a request for the UE EPS PDN connection and the target MME capabilities were provided in the request parameters: + +- if the target MME supports the non-IP PDN type, the SMF shall return, for a PDU session with PDU session type "Unstructured", an EPS bearer context with the "non-IP" PDN type; +- if the target MME supports the Ethernet PDN type, the SMF shall return, for a PDU session with PDU session type "Ethernet", an EPS bearer context with the "Ethernet" PDN type; +- if the target MME does not support the Ethernet PDN type but supports the non-IP PDN type, the SMF shall return, for a PDU session with PDU session type "Ethernet", an EPS bearer context with the "non-IP" PDN type. + +If the notToTransferEbiList IE was included in the request, the SMF shall not provide EPS bearer context(s) corresponding to EBIs in the list. + +If this is a request for retrieving the complete SM context and there are downlink data packets buffered at I-UPF, the SMF shall include the "forwardingInd" attribute with value "true" in the response body to indicate downlink data packets are buffered at the I-UPF. The NF Service Consumer receiving the "forwardingInd" attribute with the value "true" shall setup a forwarding tunnel for receiving the buffered downlink data packets. + +If this is a request for retrieving the complete SM context for an inter-PLMN V-SMF change, i.e. if the request contains the serving core network operator PLMN ID indicating a different PLMN than the PLMN of the SMF (acting as the old V-SMF), the latter shall not include the chargingInfo IE and the roamingChargingProfile IE in the SM context returned in the response. + +During a procedure with an I-SMF or V-SMF insertion, the anchor SMF should use the servingNetwork IE received in the Retrieve SM Context Request to determine whether the inserted entity is an I-SMF or V-SMF, and if so, encode in the SM Context returned in the response the applicable set of attributes (e.g. hsmfUri, + +hSmfInstanceId, hSmfServiceInstanceId to a V-SMF, or smfUri, smfInstanceId, smfServiceInstanceId to an I-SMF) and the applicable URI in the pduSessionRef if different URIs are used for intra-PLMN and inter-PLMN signaling requests targeting the PDU session context. + +NOTE 1: During an inter-PLMN procedure with an I-SMF or V-SMF change, the old V-SMF or I-SMF returns the attributes of the SM context as were received from the anchor SMF. + +If the UE, target MME and AMF support User Plane integrity protection with EPS, the SMF shall include the UP Security Policy IE in the UE EPS PDN connection context if User Plane integrity protection has been enabled by the SMF as specified in clauses 4.11.1.2.1 and 4.11.1.3.2 of 3GPP TS 23.502 [3]. + +NOTE 2: During a 5GS to EPS handover, if User Plane Integrity Protection is used in 5GS and QoS flows are associated with EPS bearer IDs, the I-SMF/V-SMF considers that the UE supports User Plane Integrity Protection in EPS. + +If this is a request for retrieving the complete SM context for an I-SMF or V-SMF insertion, and the smfUri IE or hSmfUri IE is provided by the AMF in the Create SM Context request and is different from the smfUri IE or hSmfUri IE in the SM context returned in the Retrieve SM Context response, the latter (i.e. the IEs received in the Retrieve SM Context response) shall prevail and be used by the I-SMF or V-SMF to trigger the create service operation to the (H-)SMF. + +If the target V-SMF supports the HR-SBO feature, for a HR-SBO session, the content of the POST response message may also contain the HR-SBO related information, e.g., hrsboAuthResult, hDnsAddr, hPlmnAddr, vplmnOffloadingInfoList. + +The source V-SMF shall determine if the target V-SMF has already received the corresponding VPLMN Offloading Information for an offload identifier based on the storedOffloadIds for the HPLMN of the PDU session provided by the target V-SMF in the Retrieve SM context request message for an intra PLMN V-SMF change, the source V-SMF shall include: + +- the Offload Identifier(s) only, if the Offload Identifier(s) are known by the target V-SMF, i.e., the Offload Identifier(s) are part of the storedOffloadIds; otherwise +- a list of vplmnOffloadingInfo attributes where each vplmnOffloadingInfo contains an offload identifier and the corresponding VPLMN Offloading Information. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.4.4.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.3.4.4.2-2. + +If the EBI value of the QoS Flow associated with the default QoS Rule is included in the notToTransferEbiList IE, the SMF shall set the "cause" attribute in the ProblemDetails structure to "DEFAULT\_EBI\_NOT\_TRANSFERRED". + +If a request for the UE EPS PDN connection is rejected due to the target MME not being capable to support the PDU session, e.g. if the PDU session requires UP integrity protection but the target MME does not support User Plane Integrity Protection with EPS, the SMF shall return a 403 Forbidden response with the "cause" attribute in the ProblemDetails structure set to " TARGET\_MME\_CAPABILITY". + +## 5.2.2.7 Create service operation + +### 5.2.2.7.1 General + +The Create service operation shall be used to create an individual PDU session in the H-SMF for HR roaming scenarios, or in the SMF for PDU sessions involving an I-SMF. + +It is used in the following procedures: + +- UE requested PDU Session Establishment for home-routed roaming or with an I-SMF (see clauses 4.3.2.2.2 and 4.23.5.1 of 3GPP TS 23.502 [3]); +- when an I-SMF is inserted during the Registration, Service Request, Inter NG-RAN node N2 based handover, Xn based handover and Handover from non-3GPP to 3GPP access procedures (see clauses 4.23.3, 4.23.4, 4.23.7.3, 4.23.11.2 and 4.23.16 of 3GPP TS 23.502 [3]); + +- when a V-SMF is inserted during the Registration and Inter NG-RAN node N2 based handover (see clauses 4.23.3 and 4.23.7.3 of 3GPP TS 23.502 [3]); +- EPS to 5GS Idle mode mobility or handover using N26 interface (see clauses 4.11, 4.23.12.3, 4.23.12.5 and 4.23.12.7 of 3GPP TS 23.502 [3]); +- EPS to 5GS mobility without N26 interface (see clause 4.11.2.3 of 3GPP TS 23.502 [3]); +- Handover of a PDU session between 3GPP access and non-3GPP access, when the target AMF does not know the SMF resource identifier of the SM context used by the source AMF, e.g. when the target AMF is not in the PLMN of the N3IWF (see clause 4.9.2.3.2 of 3GPP TS 23.502 [3]); +- Handover from EPS to 5GC-N3IWF (see clause 4.11.3.1 of 3GPP TS 23.502 [3]); +- Handover from EPC/ePDG to 5GS (see clause 4.11.4.1 of 3GPP TS 23.502 [3]); +- Support of Network Slice Replacement (see clause 5.15.19 of 3GPP TS 23.501 [2]); +- PDU Session establishment for supporting HR-SBO in VPLMN (see clause 6.7.2.2 of 3GPP TS 23.548 [39]). + +The NF Service Consumer (e.g. V-SMF or I-SMF) shall create a PDU session in the SMF (i.e. H-SMF for a HR PDU session, or SMF for a PDU session involving an I-SMF) by using the HTTP POST method as shown in Figure 5.2.2.7.1-1. + +![Sequence diagram showing PDU session creation between an NF Service Consumer and an SMF. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 201 Created status or an error status (4xx/5xx or 3xx).](4cd9eeaee1deb05bf88a8abf02ff7d7f_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer + participant SMF + Note right of SMF: 1. POST .../pdu-sessions (PduSessionCreateData) + SMF-->>NFSC: 2a. 201 Created (PduSessionCreatedData) + Note right of SMF: 2b. 4xx/5xx (PduSessionCreateError) or 3xx + SMF-->>NFSC: + +``` + +Sequence diagram showing PDU session creation between an NF Service Consumer and an SMF. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 201 Created status or an error status (4xx/5xx or 3xx). + +**Figure 5.2.2.7.1-1: PDU session creation** + +1. The NF Service Consumer shall send a POST request to the resource representing the PDU sessions collection resource of the SMF. The content of the POST request shall contain: + - a representation of the individual PDU session resource to be created; + - the requestType IE, if the Request type IE is received from the UE for a single access PDU session and if the request refers to an existing PDU session or an existing Emergency PDU session; the requestType IE shall not be included for a MA-PDU session establishment request; it may be included otherwise; + - the indication that a MA-PDU session is requested if a MA-PDU session is requested to be established by the UE, or the indication that the PDU session is allowed to be upgraded to a MA PDU session if the UE indicated so; + - the vsmfId IE or ismfId IE identifying the V-SMF or I-SMF respectively; + - the cpCiotEnabled IE with the value "True", if Control Plane CIoT 5GS Optimisation is enabled for this PDU session; + - the cpOnlyInd IE with the value "True", if the PDU session shall only use Control Plane CIoT 5GS Optimisation; + - the Invoke NEF indication with the value "True", if the cpCiotEnabled IE is set to "True" and data delivery via NEF is selected for the PDU session; + - the vcnTunnelInfo IE or icnTunnelInfo IE with the DL N9 tunnel CN information of the UPF controlled by the V-SMF or I-SMF respectively, except for EPS to 5GS handover using N26 interface and when Control Plane CIoT 5GS Optimisation is enabled and data delivery via NEF is selected for this PDU session; + +- the additionalCnTunnelInfo IE with additional DL N9 tunnel CN information, if a MA PDU session is requested or if the PDU session is allowed to be upgraded to a MA PDU session, and if the UE is registered over both 3GPP and Non-3GPP accesses; +- the alternative S-NSSAI, if the NF service consumer and UE support the network slice replacement and it is requested to replace the S-NSSAI with the alternative S-NSSAI (see clause 5.15.19 of 3GPP TS 23.501 [2]); +- the anType IE, indicating the access network type (3GPP or non-3GPP access) associated to the PDU session; +- the additionalAnType IE indicating an additional access network type associated to the PDU session, for a MA PDU session, if the UE is registered over both 3GPP and Non-3GPP accesses; +- the n9ForwardingTunnelInfo IE indicating the allocated N9 tunnel endpoints information for receiving the buffered downlink data packets, when downlink data packets are buffered at I-UPF controlled by the SMF during I-SMF insertion; +- a callback URI ({vsmfPduSessionUri} or {ismfPduSessionUri}) representing the PDU session resource in the V-SMF or I-SMF. The SMF shall construct the callback URIs based on the received {vsmfPduSessionUri} or {ismfPduSessionUri} as defined in clause 6.1, e.g. the callback URI "{vsmfPduSessionUri}/modify" to modify a PDU session in the V-SMF; +- the list of DNAsI supported by the I-SMF, for a PDU session with an I-SMF; +- the QoS constraints from the VPLMN for the QoS Flow associated with the default QoS rule and/or for the Session-AMBR if any, for the HR PDU session, if the VQOS feature is supported by the V-SMF; +- the upipSupported IE set to "true", if the UE supports User Plane Integrity Protection with EPS and if the AMF supports the related functionality. + +The content of the POST request may further contain: + +- the satelliteBackhaulCat IE indicating the category of the satellite backhaul used towards the 5G AN serving the UE, if the V-SMF/I-SMF received this information from the AMF; +- the disasterRoamingInd IE set to true during the PDU session establishment or a V-SMF insertion procedure when the V-SMF is indicated by the AMF that the UE is registered for Disaster Roaming service; +- the hrsboInfo IE including the HR-SBO information sent from the VPLMN when the V-SMF requests HR SBO authorization; +- the ecsAddrConfigInfos IE including the ECS Address Configuration information Parameters received from the NEF. + +As specified in clause 4.3.2.2.2 of 3GPP TS 23.502 [3], the NF Service Consumer shall be able to receive an Update request before receiving the Create Response, e.g. for EPS bearer ID allocation (see clause 4.11.1.4.1 of 3GPP TS 23.502 [3]) or Secondary authorization/authentication (see clause 4.3.2.3 of 3GPP TS 23.502 [3]). + +NOTE: If the H-SMF supports the VQOS feature, when QoS constraints are received from the VPLMN and PCF is deployed, the H-SMF provides the QoS constraints from the VPLMN to the PCF; otherwise, in case dynamic PCC is not deployed, the SMF takes them into account when generating the default QoS rule. + +2a. On success, "201 Created" shall be returned, the content of the POST response shall contain: + +- the representation describing the status of the request; +- the QoS flow(s) to establish for the PDU session, except when Control Plane CIoT 5GS Optimisation is enabled for this PDU session; +- the epsPdnCnxInfo IE and, for each EPS bearer, an epsBearerInfo IE, if the PDU session is associated to (or handed over to) the 3GPP access type and may be moved to EPS during its lifetime; +- a MA PDU Session Accepted indication, if a MA PDU session is established; +- the smallDataRateControlEnabled indication set to "true" if small data rate control is applicable on the PDU session; + +- the "Location" header containing the URI of the created resource; +- the hcnTunnelInfo IE or cnTunnelInfo IE with the UL N9 Tunnel CN information of the UPF controlled by the H-SMF or SMF respectively, except for when Control Plane CIoT 5GS Optimisation is enabled and data delivery via NEF is selected for this PDU session. +- the additionalCnTunnelInfo IE with additional UL N9 tunnel CN information of the UPF controlled by the H-SMF or SMF if a MA-PDU session is established for a UE registered over both 3GPP access and Non-3GPP access. + +The content of the POST response may further contain: + +- the pending update information list, indicating the information elements whose change(s) are not required to be updated in real-time to the (H-)SMF, i.e. the change(s) of the indicated information elements may be piggybacked in a subsequent update to the (H-)SMF together with other information elements. + +The content of the POST response may also contain the upSecurity, maxIntegrityProtectedDataRate and maxIntegrityProtectedDataRateDI IEs, if the PDU session is associated to (or handed over to) the 3GPP access type. + +The SMF may provide alternative QoS profiles for each GBR QoS flow with Notification control enabled, to allow the NG-RAN to accept the setup of the QoS flow if the requested QoS parameters or at least one of the alternative QoS parameters sets can be fulfilled at the time of setup. + +The authority and/or deployment-specific string of the apiRoot of the created resource URI may differ from the authority and/or deployment-specific string of the apiRoot of the request URI received in the POST request. + +If an Update Request was sent to the NF Service Consumer before the Create Response, the URI in the "Location" header and in the hsmfPduSessionUri IE (carrying the PDU session resource URI of a HR PDU session or a PDU session with an I-SMF) of the SMF initiated Update Request shall be the same. If the requestType IE was received in the request and set to EXISTING\_PDU\_SESSION or EXISTING\_EMERGENCY\_PDU\_SESSION (i.e. indicating that this is a UE request for an existing PDU session or an existing emergency PDU session), the SMF shall identify the existing PDU session or emergency PDU session based on the PDU Session ID; in this case, the SMF shall not create a new PDU session or emergency PDU session but instead update the existing PDU session or emergency PDU session and provide the representation of the updated PDU session or emergency PDU session in the response to the NF Service Consumer. + +The POST request shall be considered as colliding with an existing PDU session context if: + +- this is a request to establish a new PDU session, i.e.: + - the RequestType IE is present in the request and set to INITIAL\_REQUEST or INITIAL\_EMERGENCY\_REQUEST (e.g. single access PDU session establishment request); + - the RequestType IE and the maRequestInd IE are both absent in the request (e.g. EPS to 5GS mobility); or + - the maRequestInd IE is present in the request (i.e. MA-PDU session establishment request) and the access type indicated in the request corresponds to the access type of the existing PDU session context. + +and either of the following conditions is met: + +- this is a request to establish a non-emergency PDU session and the request includes the same SUPI and the same PDU Session ID as for an existing PDU session context; or +- this is a request to establish an emergency PDU session and the request includes the same SUPI, or PEI for an emergency registered UE without a UICC or without an authenticated SUPI, as for an existing PDU session context for an emergency PDU session. + +A POST request that collides with an existing PDU session context shall be treated as a request for a new PDU session context. The SMF shall assign a new PDU session reference, i.e. {pduSessionRef} (see clause 6.1.3.6.2), which is different from the existing PDU session context. Before creating the new PDU session context, the SMF should delete the existing PDU session context locally and any associated resources in the UPF, PCF, CHF and UDM. See also clause 5.2.3.3.1 for the handling of requests which collide with an existing PDU session context. + +If the vsmfPduSessionUri or ismfPduSessionUri of the existing PDU session context differs from the vsmfPduSessionUri or ismfPduSessionUri received in the POST request, the SMF shall also send a status notification (see clause 5.2.2.10) targeting the vsmfPduSessionUri or ismfPduSessionUri of the existing PDU session context to notify the release of the existing PDU session context. The SMF should include a cause IE with value "REL\_DUE\_TO\_DUPLICATE\_SESSION\_ID" in such a status notification. Upon receipt of such a status notification, the V-SMF or I-SMF shall not send SM context status notification to the AMF. + +If the requestType IE was received in the request and indicates this is a request for a new PDU session (i.e. INITIAL\_REQUEST) and if the Old PDU Session ID was also included in the request, the SMF shall identify the existing PDU session to be released and to which the new PDU session establishment relates, based on the Old PDU Session ID. + +The NF Service Consumer shall store any epsPdnCnxInfo and EPS bearer information received from the SMF. + +If the response received from the SMF contains the alwaysOnGranted attribute set to true, the NF Service Consumer shall check and determine whether the PDU session can be established as an always-on PDU session based on local policy. + +If no GPSI IE is provided in the request, e.g. for a PDU session moved from another access or another system, and the SMF knows that a GPSI is already associated with the PDU session, the SMF shall include the GPSI in the response. + +If one or more requested QoS flow(s) fail to be established, the V-SMF or I-SMF shall send an Update Request including the qosFlowsRelNotifyList attribute to report the failure to the H-SMF or SMF (see clause 5.2.2.8.2.2), or a Release Request to release the PDU session if no QoS flow can be established (see clause 5.2.2.9). + +For UE mobility with I-SMF/V-SMF insertion procedure, if a requested functionality is not supported for a PDU session with an I-SMF/V-SMF, the SMF shall accept the POST request and release the PDU Session after the mobility procedure, as specified in clause 4.23.1 of 3GPP TS 23.502 [3]. + +For a HR-SBO session, the content of the POST response may also contain the hrsboInfo IE including the HR-SBO information sent from the HPLMN, e.g., hrsboAuthResult. + +2b. On failure, or redirection during a UE requested PDU Session Establishment, one of the HTTP status code listed in Table 6.1.3.5.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a PduSessionCreateError structure, including: + +- a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.5.3.1-3. The application error shall be set to "NOT\_SUPPORTED\_WITH\_ISMF" during a UE requested PDU Session Establishment, if a requested functionality is not supported for a PDU session with an I-SMF/V-SMF. +- the n1SmCause IE with the 5GSM cause that the SMF proposes the NF Service Consumer to return to the UE, if the request included n1SmInfoFromUe; +- n1SmInfoToUe with any information to be sent to the UE (in the PDU Session Establishment Reject). + +## 5.2.2.7.2 EPS to 5GS Idle mode mobility + +The requirements specified in clause 5.2.2.7.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.7.1-1, with the following additions. + +The POST request shall contain: + +- the list of EPS Bearer Ids received from the MME; +- the PGW S8-C F-TEID received from the MME; +- the epsBearerCtxStatus attribute, indicating the status of all the EPS bearer contexts in the UE, if corresponding information has been received in the Create SM Context request (see clause 5.2.2.2.2). + +2a. Same as step 2 of Figure 5.2.2.7.1-1, with the following modifications. + +If: + +- the SMF finds a corresponding PDU session based on the EPS Bearer Ids and PGW S8-C F-TEID received in the request; +- the default EPS bearer context of the corresponding PDU session is not reported as inactive by the UE in the epsBearerCtxStatus attribute, if received; and +- the SMF can proceed with moving the PDN connection to 5GS, + +then the SMF shall return a 201 Created response including the following additional information: + +- PDU Session ID corresponding to the EPS PDN connection; +- other PDU session parameters, such as PDU Session Type, Session AMBR, QoS flows information. + +If the epsBearerCtxStatus attribute is received in the request, the SMF shall check whether some EPS bearer(s) of the corresponding PDU session have been deleted by the UE but not notified to the EPS, and if so, the SMF shall release these EPS bearers, corresponding QoS rules and QoS flow level parameters locally, as specified in clause 4.11.1.3.3 of 3GPP TS 23.502 [3]. + +NOTE: The behaviour specified in this step also applies if the POST request collides with an existing PDU session context, i.e. if the POST request includes the same SUPI, or PEI for an emergency registered UE without a UICC or without an authenticated SUPI, and the received EPS bearer ID is the same as in the existing PDU session context. + +2b. Same as step 2b of Figure 5.2.2.7.1-1, with the following additions. + +If the SMF determines that seamless session continuity from EPS to 5GS is not supported for the PDU session, the SMF shall set the "cause" attribute in the ProblemDetails structure to "NO\_EPS\_5GS\_CONTINUITY". + +If the default EPS bearer context of the PDU session is reported as inactive by the UE in the epsBearerCtxStatus attribute, the SMF shall set the "cause" attribute in the ProblemDetails structure to "DEFAULT\_EPS\_BEARER\_INACTIVE". + +### 5.2.2.7.3 EPS to 5GS Handover Preparation + +The requirements specified in clause 5.2.2.7.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.7.1-1, with the following modifications. + +The POST request shall contain: + +- the list of EPS Bearer Ids received from the MME; +- the PGW S8-C F-TEID received from the MME; +- the hoPreparationIndication IE set to "true", to indicate that a handover preparation is in progress and the PGW-C/SMF shall not switch the DL user plane of the PDU session yet. + +2a. Same as step 2 of Figure 5.2.2.7.1-1, with the following modifications. + +If the SMF finds a corresponding PDU session based on the EPS Bearer Ids and PGW S8-C F-TEID received in the request, and if it can proceed with the procedure, the SMF shall return a 201 Created response including the following information: + +- PDU Session ID corresponding to the EPS PDN connection; +- other PDU session parameters, such as PDU Session Type, Session AMBR, QoS flows information; +- optional udmGroupId, containing the identity of the UDM group serving the UE, to facilitate the UDM selection at the target AMF. The V/I-SMF shall forward this IE in the SmContextCreatedData to the target AMF. +- optional pcfGroupId, containing the identity of the PCF group for Session Management Policy for the PDU session, to facilitate the PCF selection at the target AMF. The V/I-SMF shall forward this IE in the SmContextCreatedData to the target AMF. + +The SMF shall not switch the DL user plane of the PDU session, if the hoPreparationIndication IE was set to "true" in the request. + +NOTE: The behaviour specified in this step also applies if the POST request collides with an existing PDU session context, i.e. if the POST request includes the same SUPI, or PEI for an emergency registered UE without a UICC or without an authenticated SUPI, and the received EPS bearer ID is the same as in the existing PDU session context. + +2b. Same as step 2b of Figure 5.2.2.7.1-1, with the following additions. + +If the H-SMF determines that seamless session continuity from EPS to 5GS is not supported for the PDU session, the H-SMF shall set the "cause" attribute in the ProblemDetails structure to "NO\_EPS\_5GS\_CONTINUITY". + +#### 5.2.2.7.4 N2 Handover Preparation with I-SMF Insertion + +The requirements specified in clause 5.2.2.7.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.7.1-1, with the following modifications. + +The POST request shall contain: + +- the hoPreparationIndication IE set to "true", to indicate that a handover preparation is in progress and the SMF shall not switch the DL user plane of the PDU session yet. + +2a. Same as step 2 of Figure 5.2.2.7.1-1, with the following modifications: + +The SMF shall not switch the DL user plane of the PDU session, if the hoPreparationIndication IE was set to "true" in the request. + +#### 5.2.2.7.5 Xn Handover with I-SMF Insertion + +The requirements specified in clause 5.2.2.7.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.7.1-1, with the following modifications. + +The POST request shall contain: + +- the upSecurityInfo IE, if received from the AMF. + +2a. Same as step 2 of Figure 5.2.2.7.1-1, with the following modifications: + +The SMF shall verify that the upSecurity IE included in the received upSecurityInfo IE is same as the security policy for integrity protection and encryption that the SMF has locally stored. If there is a mismatch, the SMF shall send its locally stored security policy for integrity protection and encryption in upSecurity IE to NG-RAN as specified in clause 6.6.1 of 3GPP TS 33.501 [17]. + +#### 5.2.2.7.6 UE Triggered Service Request with I-SMF Insertion + +The requirements specified in clause 5.2.2.7.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.7.1-1, with the following modifications. + +The POST request shall additionally contain: + +- the upCnxState IE set to ACTIVATING to indicate that User Plane resource for the PDU Session is going to be established by the I-SMF. + +2a. Same as step 2 of Figure 5.2.2.7.1-1, with the following modifications: + +The SMF shall behave as specified in clause 4.23.4.3 (step 8a) of 3GPP TS 23.502 [3]. + +The SMF handling of a subsequent Update request with the upCnxState IE set to ACTIVATED is specified in step 3 of clause 5.2.2.8.2.23. + +NOTE: The upCnxState IE set to ACTIVATING implements the "Operation Type" parameter set to "UP Activate" specified in clause 4.23.4.3 (step 8a) in 3GPP TS 23.502 [3]. + +## 5.2.2.8 Update service operation + +### 5.2.2.8.1 General + +The Update service operation shall be used for HR PDU sessions or for PDU sessions involving an I-SMF to: + +- update an individual PDU session in the H-SMF or SMF and/or provide the H-SMF or SMF with information received by the V-SMF or I-SMF in N1 SM signalling from the UE; +- update a MA PDU session to indicate an additional access type, if the UE requests establishment of MA PDU session via the other access after the UE is registered to both 3GPP access and non-3GPP access and the MA PDU session was successfully established on the first access (see clause 4.22.2.2 of 3GPP TS 23.502 [3]); +- release a MA PDU session over a single access in the H-SMF or SMF; +- update an individual PDU session in the V-SMF or I-SMF and/or provide information necessary for the V-SMF or I-SMF to send N1 SM signalling to the UE. + +It is invoked by the V-SMF or I-SMF in the following procedures: + +- UE or network (e.g. V-SMF, I-SMF) requested PDU session modification (see clauses 4.3.3.3 and 4.23.5.3 of 3GPP TS 23.502 [3]); +- UE or network (e.g. AMF, V-SMF, I-SMF) requested PDU session release (see clause 4.3.4.3 of 3GPP TS 23.502 [3]); +- UE or network (e.g. AMF, V-SMF, I-SMF) initiated MA PDU session release over a single access (see clause 4.22 of 3GPP TS 23.502 [3]); +- EPS to 5GS handover execution using N26 interface (see clause 4.11 of 3GPP TS 23.502 [3]); +- Handover between 3GPP and untrusted or trusted non-3GPP access procedures (see clauses 4.9.2 and 4.9.3 of 3GPP TS 23.502 [3]), without AMF change or with target AMF in same PLMN; +- All procedures requiring to provide the H-SMF or SMF with information received by the V-SMF or I-SMF in N1 SM signalling from the UE to the H-SMF or SMF; +- Secondary RAT Usage Data Reporting (see clause 4.21 of 3GPP TS 23.502 [3]); +- UPF anchored Mobile Originated Data Transport in Control Plane CIoT 5GS Optimisation (see clause 4.24.1 of 3GPP TS 23.502 [3]); +- Connection Resume in CM-IDLE with Suspend procedure (see clause 4.8.2.3 of 3GPP TS 23.502 [3]); +- Reporting of satellite backhaul change to SMF (see clause 5.43.4 of 3GPP TS 23.501 [2]); +- UE Triggered Service Request without I-SMF/V-SMF change/removal (see clause 4.23.4.2 of 3GPP TS 23.502 [2]) or UE Triggered Service Request with I-SMF/V-SMF change or with I-SMF insertion (see clause 4.23.4.3 of 3GPP TS 23.502 [2]); +- Remote UE Report during 5G ProSe Communication via 5G ProSe Layer-3 UE-to-Network Relay without N3IWF (see clause 6.5.1.1 of 3GPP TS 23.304 [43]); +- Support of Network Slice Replacement (see clause 5.15.19 of 3GPP TS 23.501 [2]). + +It is invoked by the I-SMF in the following procedures: + +- Addition of PDU Session Anchor and Branching Point or UL CL controlled by I-SMF (see clause 4.23.9.1 of 3GPP TS 23.502 [3]); +- Removal of PDU Session Anchor and Branching Point or UL CL controlled by I-SMF (see clause 4.23.9.2 of 3GPP TS 23.502 [3]); + +- Change of PDU Session Anchor for IPv6 multi-homing or UL CL controlled by I-SMF (see clause 4.23.9.3 of 3GPP TS 23.502 [3]); +- Sending by I-SMF of N4 notifications related with traffic usage reporting (see clause 5.34.6 of 3GPP TS 23.501 [2]); +- Simultaneous change of Branching Point or UL CL and additional PSA controlled by I-SMF (see clause 4.23.9.4 of 3GPP TS 23.502 [3]); +- Simultaneous change of Branching Points or UL CLs controlled by different I-SMFs (see clause 4.23.9.5 of 3GPP TS 23.502 [3]). + +It is invoked by the H-SMF or SMF in the following procedures: + +- Network (e.g. H-SMF, SMF) requested PDU session modification (see clauses 4.3.3.3 and 4.23.5.3 of 3GPP TS 23.502 [3]); +- Network (e.g. H-SMF, SMF) requested PDU session release (see clause 4.3.4.3 of 3GPP TS 23.502 [3]); +- Network (e.g. H-SMF, SMF) initiated MA PDU session release over a single access (see clause 4.22 of 3GPP TS 23.502 [3]); +- All procedures requiring to provide information necessary for the V-SMF or I-SMF to send N1 SM signalling to the UE; +- EPS Bearer ID allocation or revocation (see clauses 4.11.1.4.1 and 4.11.1.4.3 of 3GPP TS 23.502 [3]); +- Secondary authorization/authentication by an DN-AAA server (see clause 4.3.2.3 of 3GPP TS 23.502 [3]). + +It is invoked by the SMF in the following procedures: + +- Addition of PDU Session Anchor and Branching Point or UL CL controlled by I-SMF (see clause 4.23.9.1 of 3GPP TS 23.502 [3]); +- Removal of PDU Session Anchor and Branching Point or UL CL controlled by I-SMF (see clause 4.23.9.2 of 3GPP TS 23.502 [3]); +- Change of PDU Session Anchor for IPv6 multi-homing or UL CL controlled by I-SMF (see clause 4.23.9.3 of 3GPP TS 23.502 [3]); +- Policy update procedures with an I-SMF (see clause 4.23.6.2 of 3GPP TS 23.502 [3]); +- Simultaneous change of Branching Point or UL CL and additional PSA controlled by I-SMF (see clause 4.23.9.4 of 3GPP TS 23.502 [3]); +- Simultaneous change of Branching Points or UL CLs controlled by different I-SMFs (see clause 4.23.9.5 of 3GPP TS 23.502 [3]). + +## 5.2.2.8.2 Update service operation towards H-SMF or SMF + +### 5.2.2.8.2.1 General + +The NF Service Consumer (i.e. the V-SMF for a HR PDU session, or the I-SMF for a PDU session with an I-SMF) shall update a PDU session in the H-SMF or SMF and/or provide the H-SMF or SMF with information received by the NF Service Consumer in N1 SM signalling from the UE, by using the HTTP POST method (modify custom operation) as shown in Figure 5.2.2.8.2-1. + +![Sequence diagram showing PDU session update towards H-SMF or SMF. The NF Service Consumer sends a POST request to the H-SMF/SMF. The H-SMF/SMF responds with either a 204 No Content or 200 OK (HsmfUpdatedData) on success, or a 4xx/5xx (HsmfUpdateError) or 3xx on failure or redirection.](5e9af8986a5845504f251d3079da8078_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant H-SMF/SMF + Note right of NF Service Consumer: 1. POST .../pdu-sessions/{pduSessionRef}/modify (HsmfUpdateData) + NF Service Consumer->>H-SMF/SMF: Request + Note left of H-SMF/SMF: 2a. 204 No Content or 200 OK (HsmfUpdatedData) + H-SMF/SMF-->>NF Service Consumer: Success Response + Note left of H-SMF/SMF: 2b. 4xx/5xx (HsmfUpdateError) or 3xx + H-SMF/SMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram showing PDU session update towards H-SMF or SMF. The NF Service Consumer sends a POST request to the H-SMF/SMF. The H-SMF/SMF responds with either a 204 No Content or 200 OK (HsmfUpdatedData) on success, or a 4xx/5xx (HsmfUpdateError) or 3xx on failure or redirection. + +**Figure 5.2.2.8.2-1: PDU session update towards H-SMF or SMF** + +- The NF Service Consumer shall send a POST request to the resource representing the individual PDU session resource in the H-SMF or SMF. The content of the POST request shall contain: + - the requestIndication IE indicating the request type. Unless specified otherwise in clause 5.2.2.8.2, the value of the requestIndication IE shall be set to NW\_REQ\_PDU\_SES\_MOD; + - the modification instructions and/or the information received by the NF Service Consumer in N1 signalling from the UE. + +The NF service consumer shall not include the hoPreparationIndication IE with the value "false" in procedures other than handover execution, cancel and failure procedures. + +If the pending update information list was previously received from the (H-)SMF, the NF service consumer should not send a request to the (H-)SMF including only the information elements indicated by the pending update information list. The change(s) of the indicated information elements may be piggybacked in a subsequent update to the (H-)SMF together with other information elements. + +For a HR-SBO session, the content of the POST request may further contain: + +- the hrsboInfo IE including the HR-SRO information sent from the VPLMN when the V-SMF requests HR SBO authorization. +- the ecsAddrConfigInfos IE including the ECS Address Configuration information if the information is modified by the NEF. + +- On success, "204 No Content" or "200 OK" shall be returned; in the latter case, the content of the POST response shall contain the representation describing the status of the request and/or information necessary for the NF Service Consumer to send N1 SM signalling to the UE. If the PDU session may be moved to EPS with N26 and the EPS PDN Connection Context information of the PDU session is changed, e.g. due to a new anchor SMF is reselected, the content shall include the "epsPdnCnxInfo" IE including the updated EPS PDN Connection Context information. The NF Service consumer shall overwrite the locally stored EPS PDN Connection Context information with the new one if received. + +For a HR-SBO session, the content of the POST response may also contain the hrsboInfo IE including the HR-SBO information sent from the HPLMN, e.g., hrsboAuthResult. + +- On failure or redirection, one of the HTTP status codes listed in Table 6.1.3.6.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain an HsmfUpdateError structure, including: + +- a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.6.4.2.2-2; +- the n1SmCause IE with the 5GSM cause the H-SMF or SMF proposes the NF Service Consumer to return to the UE, if the request included n1SmInfoFromUe; +- n1SmInfoToUe binary data, if the H-SMF or SMF needs to return NAS SM information which the NF Service Consumer does not need to interpret; +- the procedure transaction id that was received in the request, if this is a response sent to a UE requested PDU session modification. + +If the H-SMF or SMF receives the hoPreparationIndication IE set to "false" value in step 1, while it did not receive the hoPreparationIndication IE set to "true" value in previous steps (see clauses 5.2.2.7.3 and 5.2.2.7.4), the H-SMF or SMF shall ignore the hoPreparationIndication IE with "false" value and proceed with the processing of the request. + +#### 5.2.2.8.2.2 UE or network (e.g. AMF, V-SMF, I-SMF) requested PDU session modification + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the requestIndication set to UE\_REQ\_PDU\_SES\_MOD, and the modifications requested by the UE, e.g. UE requested QoS rules or UE requested QoS flow descriptions, in an N1 SM container IE as specified in clause 5.2.3.1, or indication that the PDU session is allowed to be upgraded to a MA PDU session as specified in clause 6.4.2.2 of 3GPP TS 24.501 [7], for a UE requested PDU session modification; or +- the requestIndication set to NW\_REQ\_PDU\_SES\_MOD, and the modifications requested by the visited network or the notifications initiated by the visited network, for a visited network requested PDU session modification, e.g. to: + - report the release of QoS flow(s) or notify QoS flow(s) whose targets QoS are no longer fulfilled; in the latter case, the V-SMF/I-SMF may also report an alternative QoS profile which the NG-RAN can currently fulfil in the currentQosProfileIndex IE or report that the NG-RAN cannot even fulfil the lowest alternative QoS profile by setting the nullQoSProfileIndex IE to "true" for the corresponding QoS flow(s); + - report that the user plane security enforcement with a value Preferred is not fulfilled or is fulfilled again, in the NotifyList IE and the securityResult IE, if the new security status is received from NG-RAN; + - report that access type of the PDU session can be changed; in this case, the anTypeCanBeChanged attribute shall be set to "true"; + - report the "MO Exception Data Counter"; + - request for QoS modification initiated by VPLMN, if the H-SMF supports the VPLMN QoS (VQOS) feature; + - report the QoS flow(s) that are rejected by the RAN or rejected by the V-SMF, during PDU session establishment procedure; in the latter case, the V-SMF may also include the qosFlowsVsmfRejectedAddModList IE with the QoS flow(s) that are rejected by the V-SMF. + +If the update is performed to transfer the PDU Session from non-3gpp access to 3gpp access by setting the attribute anTypeCanBeChanged to "true", the SMF may perform Network Slice Admission Control before the PDU Session is moved to 3GPP access (i.e, before N3/N9 tunnel for the PDU Session is established). + +#### 5.2.2.8.2.3 UE requested PDU session release + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the requestIndication set to UE\_REQ\_PDU\_SES\_REL. + +#### 5.2.2.8.2.4 EPS to 5GS Handover Execution + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the requestIndication set to PDU\_SES\_MOB; + +- the list of EPS Bearer Ids successfully handed over to 5GS; +- the hoPreparationIndication IE set to "false", to indicate that there is no handover preparation in progress anymore and that the PGW-C/SMF shall switch the DL user plane of the PDU session; +- one or more SecondaryRatUsageDataReportContainer(s) if it received the same in the SmContextUpdateData from the AMF. + +2. Same as step 2 of Figure 5.2.2.8.2-1, with the following modifications. + +The H-SMF or SMF shall return a 200 OK response. The H-SMF or SMF shall switch the DL user plane of the PDU session using the N9 tunnel information that has been received in the vcnTunnelInfo or icnTunnelInfo, if the hoPreparationIndication IE was set to "false" in the request. + +If the handover preparation failed (e.g. the target 5G-AN failed to establish resources for the PDU session), the requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the requestIndication set to PDU\_SES\_MOB;- the cause attribute set to "HO\_FAILURE"; +- an empty list of EPS Bearer Ids; +- the hoPreparationIndication IE set to "false", to indicate that there is no handover preparation in progress anymore. + +2. Same as step 2 of Figure 5.2.2.8.2-1, with the following modifications. + +The H-SMF or SMF shall return a 200 OK response. The H-SMF or SMF shall release the resources prepared for the handover. + +#### 5.2.2.8.2.5 Handover between 3GPP access and untrusted or trusted non-3GPP access + +For Handover between 3GPP access and untrusted or trusted non-3GPP access procedures, without AMF change or with the target AMF in the same PLMN, the requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain the anType set to the target access type, i.e. to 3GPP\_ACCESS or NON\_3GPP\_ACCESS. + +The requestIndication IE shall be set to PDU\_SES\_MOB. + +For a handover from non-3GPP access to 3GPP access with a V-SMF change, the requirements specified in step 1 of clause 5.2.2.8.2.10, other than how to set the requestIndication, shall also apply. + +2a. Same as step 2a of Figure 5.2.2.8.2-1, with the following modifications. + +The content of the POST response shall include: + +- all QoS information for the QoS Flow(s) applicable to the PDU Session for the target access type, so that when sending the PDU Session Establishment Accept, the V-SMF or I-SMF can include all QoS information (e.g. QoS Rule(s) in N1 SM container, QFI(s) and QoS Profile(s) in N2 SM information) for the QoS Flow(s) (acceptable according to VPLMN policies for a HR PDU session); and +- the epsPdnCnxInfo IE and, for each EPS bearer, an epsBearerInfo IE, if the PDU session may be moved to EPS during its lifetime, for a handover from non-3GPP access to 3GPP access. + +The content of the POST response may also contain the upSecurity, maxIntegrityProtectedDataRateUI and maxIntegrityProtectedDataRateDI IEs during a handover from non-3GPP access to 3GPP access. + +For a handover from non-3GPP access to 3GPP access with a V-SMF change, the requirements specified in step 2 of clause 5.2.2.8.2.10 shall also apply. + +Upon receipt of the 200 OK response, the V-SMF or I-SMF shall delete any above information received earlier for the source access type and use the new information received for the target access type (see clause 6.1.6.2.12). + +NOTE: As specified in clause 4.11.1.4.3 of 3GPP TS 23.502 [3], the AMF, the SMF and the UE release locally the EBI(s) allocated to a PDU Session handed over from 3GPP access to non-3GPP access. + +For a handover from non-3GPP access to 3GPP access, if the PDU session may be moved to EPS during its lifetime, the H-SMF or SMF may send an Update Request towards the V-SMF or I-SMF to request the allocation of EBIs prior to step 2a. + +If one or more requested QoS flow(s) fail to be established in the target access type, the V-SMF or I-SMF shall send an Update Request including the qosFlowsRelNotifyList attribute to report the failure to the H-SMF or SMF (see clause 5.2.2.8.2.2), or a Release Request to release the PDU session if no QoS flow can be established (see clause 5.2.2.9). + +The SMF may perform Network Slice Admission Control for the target access and reject the request when the NSAC has failed for the target access. + +#### 5.2.2.8.2.6 P-CSCF Restoration Procedure via AMF + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications: + +The POST request shall contain: + +- the requestIndication IE set to NW\_REQ\_PDU\_SES\_REL; +- the cause IE set to REL\_DUE\_TO\_REACTIVATION. + +#### 5.2.2.8.2.7 Addition of PSA and BP or UL CL controlled by I-SMF + +This clause applies only in case of non-roaming or LBO roaming as control of an UL CL or BP in VPLMN is not supported in HR roaming case (see clause 5.34.4 of 3GPP TS 23.501 [2]). + +An I-SMF and I-UPF have already been inserted for the PDU session. + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications: + +The POST request shall contain: + +- the requestIndication IE set to NW\_REQ\_PDU\_SES\_MOD; +- the indication that an UL CL or BP has been inserted into the data path of the PDU session; +- the list of DNAIs supported by the inserted PSA; +- the new UE IPv6 prefix at the PSA, assigned by the I-SMF or by the UPF supporting the PSA, if IPv6 multi-homing applies to the PDU session; +- the icnTunnelInfo with the N9 tunnel information of the UL CL or BP for the downlink traffic, if a UPF different from the earlier I-UPF is selected for the UL CL or BP. + +- 2a. Same as step 2a of Figure 5.2.2.8.2-1. + +#### 5.2.2.8.2.8 Removal of PSA and BP or UL CL controlled by I-SMF + +This clause applies only in case of non-roaming or LBO roaming as control of an UL CL or BP in VPLMN is not supported in HR roaming case (see clause 5.34.4 of 3GPP TS 23.501 [2]). + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications: + +The POST request shall contain: + +- the requestIndication IE set to NW\_REQ\_PDU\_SES\_MOD; +- the indication that an UL CL or BP has been removed from the data path of the PDU session; +- the removed UE IPv6 prefix at the PSA, if IPv6 multi-homing applies to the PDU session; +- the list of DNAIs supported by the removed PSA; +- the icnTunnelInfo with the N9 tunnel information of the I-UPF for the downlink traffic. + +2a. Same as step 2a of Figure 5.2.2.8.2-1. + +#### 5.2.2.8.2.9 Change of PSA for IPv6 multi-homing or UL CL controlled by I-SMF + +This clause applies only in case of non-roaming or LBO roaming as control of an UL CL or BP in VPLMN is not supported in HR roaming case (see clause 5.34.4 of 3GPP TS 23.501 [2]). + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications: + +The POST request shall contain: + +- the requestIndication IE set to NW\_REQ\_PDU\_SES\_MOD; +- the indication that a PSA is removed and another PSA is inserted; +- the list of DNAIs supported by the inserted PSA; +- the new UE IPv6 prefix at the inserted PSA, assigned by the I-SMF or by the UPF supporting the PSA, if IPv6 multi-homing applies to the PDU session; +- the removed UE IPv6 prefix at the removed PSA, if IPv6 multi-homing applies to the PDU session; +- the list of DNAIs supported by the removed PSA. + +2a. Same as step 2a of Figure 5.2.2.8.2-1. + +#### 5.2.2.8.2.10 PDU Session modification with I-SMF or V-SMF change + +During PDU Session modification with I-SMF or V-SMF change, the NF Service Consumer (i.e. the new V-SMF for a HR PDU session, or the new I-SMF for a PDU session with an I-SMF) shall update the PDU session in the H-SMF or SMF and provide the information of the new I-SMF or V-SMF. + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following additions: + +The POST request shall contain: + +- the requestIndication set to NW\_REQ\_PDU\_SES\_MOD or UE\_REQ\_PDU\_SES\_MOD for network requested or UE requested PDU session modification respectively; +- the ismfPduSessionUri or vsmfPduSessionUri IE containing the callback URI ({vsmfPduSessionUri} or {ismfPduSessionUri}) representing the PDU session in the new I-SMF or new V-SMF. The H-SMF or SMF shall construct the callback URIs based on the received {vsmfPduSessionUri} or {ismfPduSessionUri} as defined in clause 6.1, e.g. the callback URI "{vsmfPduSessionUri}/modify" to modify a PDU session in the V-SMF; +- the ismfId or vsmfId IE containing the identifier of the new I-SMF or new V-SMF; +- optionally the iSmfServiceInstanceId or vSmfServiceInstanceId IE containing the serviceInstanceId of the new I-SMF or new V-SMF service instance serving the PDU session; + +- the disasterRoamingInd IE set to true if the V-SMF is indicated by the AMF that the UE is registered for Disaster Roaming service; + - the supportedFeatures IE indicating the optional features the NF Service Consumer supports, if at least one optional feature defined in clause 6.1.8 is supported. +2. Same as step 1 of Figure 5.2.2.8.2-1, the SMF shall replace the corresponding information for the old I-SMF or old V-SMF stored locally with the received information. In addition, the SMF shall include the supportedFeatures IE in the response, if the supportedFeatures IE was received in the request and at least one optional feature defined in clause 6.1.8 is supported by the updated PDU session resource. + +#### 5.2.2.8.2.11 Sending by I-SMF of N4 notifications related with traffic usage reporting + +This clause applies only in case of non-roaming or LBO roaming as control of an UL CL or BP in VPLMN is not supported in HR roaming case (see clause 5.34.4 of 3GPP TS 23.501 [2]). + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications: + +The POST request shall contain: + +- the requestIndication IE set to NW\_REQ\_PDU\_SES\_MOD; +- N4 information related with traffic usage reporting (i.e. PFCP Session Report Request, see Annex D of 3GPP TS 29.244 [29]); +- the DNAI related to the N4 information if the latter relates to a local PSA; + +- 2a. Same as step 2a of Figure 5.2.2.8.2-1, with the following modifications: + +The content of the POST response shall contain: + +- N4 response information (i.e. PFCP Session Report Response); +- the DNAI related to the N4 information if the latter relates to a local PSA. + +#### 5.2.2.8.2.12 N2 Handover Execution with I-SMF Insertion + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the requestIndication set to NW\_REQ\_PDU\_SES\_MOD; +- the hoPreparationIndication IE set to "false", to indicate that there is no handover preparation in progress anymore and that the SMF shall switch the DL user plane of the PDU session; +- the qosFlowsRelNotifyList IE indicating the failed QoS flow(s), if one or more QoS flow(s) cannot be established at the target RAN. + +2. Same as step 2 of Figure 5.2.2.8.2-1, with the following modifications. + +The SMF shall return a 200 OK response. The SMF shall switch the DL user plane of the PDU session using the N9 tunnel information that has been received in the icnTunnelInfo, if the hoPreparationIndication IE was set to "false" in the request. + +If the handover preparation failed (e.g. the target 5G-AN failed to establish resources for the PDU session), the requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the requestIndication set to NW\_REQ\_PDU\_SES\_MOD; +- the cause attribute set to "HO\_FAILURE"; +- the hoPreparationIndication IE set to "false", to indicate that there is no handover preparation in progress anymore. + +2. Same as step 2 of Figure 5.2.2.8.2-1, with the following modifications. + +The SMF shall return a 200 OK response. The SMF shall release the resources prepared for the handover. + +#### 5.2.2.8.2.13 N2 Handover Cancellation with I-SMF Insertion + +For handover cancellation, the requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the requestIndication set to NW\_REQ\_PDU\_SES\_MOD; +- the cause attribute set to "HO\_CANCEL"; +- the hoPreparationIndication IE set to "false", to indicate that there is no handover preparation in progress anymore. + +2. Same as step 2 of Figure 5.2.2.8.2-1, with the following modifications. + +The SMF shall return a 200 OK response. The SMF shall release the resources prepared for the handover. + +#### 5.2.2.8.2.14 EPS to 5GS Handover Cancellation + +If the handover cancellation, the requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the requestIndication set to PDU\_SES\_MOB; +- the cause attribute set to "HO\_CANCEL"; +- an empty list of EPS Bearer Ids; +- the hoPreparationIndication IE set to "false", to indicate that there is no handover preparation in progress anymore. + +2. Same as step 2 of Figure 5.2.2.8.2-1, with the following modifications. + +The H-SMF or SMF shall return a 200 OK response. The H-SMF or SMF shall release the resources prepared for the handover. The combined PGW-C+SMF shall not release the PDN connection that was attempted to be handed over. + +#### 5.2.2.8.2.15 5G-AN requested PDU session resource release + +This clause applies only in case of 5G-AN requested PDU session resource release by sending the NGAP PDU SESSION RESOURCE NOTIFY to the AMF case (see step 1d in clause 4.3.4.3 of 3GPP TS 23.502 [3]). + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the requestIndication set to REL\_DUE\_TO\_5G\_AN\_REQUEST to indicate that the PDU session resource has been released by the 5G-AN. + +After receiving the request, the SMF may decide to keep the PDU Session (with user plane connection deactivated) or release the PDU Session. If the SMF decides to keep the PDU Session, it shall return "200 OK" not including *n1SmInfoToUe*. If the SMF decides to release the PDU Session, it shall return "200 OK" including *n1SmInfoToUe* binary data containing the Message Type "PDU Session Release Command" and possibly PCO and cause information. + +#### 5.2.2.8.2.16 Xn Handover with or without I-SMF or V-SMF Change + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the upSecurityInfo IE, if received from the NG-RAN; +- the qosFlowsRelNotifyList IE indicating the failed QoS flow(s), if one or more QoS flow(s) cannot be established at the target RAN. + +For an Xn handover with an I-SMF or V-SMF change, the requirements specified in step 1 of clause 5.2.2.8.2.10, other than how to set the requestIndication, shall also apply. + +2. Same as step 2 of Figure 5.2.2.8.2-1, with the following modifications. + +The SMF shall verify that the upSecurity IE included in the received upSecurityInfo IE is same as the security policy for integrity protection and encryption that the SMF has locally stored. If there is a mismatch, the SMF shall send its locally stored security policy for integrity protection and encryption in upSecurity IE to NG-RAN as specified in clause 6.6.1 of 3GPP TS 33.501 [17]. + +For an Xn handover with an I-SMF or V-SMF change, the requirements specified in step 2 of clause 5.2.2.8.2.10 shall also apply. + +#### 5.2.2.8.2.17 EPS to 5GS Handover Failure + +If the handover to 5GS failed, e.g. rejected by the target NG-RAN, the requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the requestIndication set to PDU\_SES\_MOB; +- the cause attribute set to "HO\_FAILURE"; +- an empty list of EPS Bearer Ids; +- the hoPreparationIndication IE set to "false", to indicate that there is no handover preparation in progress anymore. + +2. Same as step 2 of Figure 5.2.2.8.2-1, with the following modifications. + +The H-SMF or SMF shall return a 200 OK response. The H-SMF or SMF shall release the resources prepared for the handover. The combined PGW-C+SMF shall not release the PDN connection that was attempted to be handed over. + +#### 5.2.2.8.2.18 EPS Bearer ID revocation + +When the AMF decides to revoke some EBI(s) and the I-SMF or V-SMF receives the request from AMF, the requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +The requestIndication shall be set to EBI\_ASSIGNMENT\_REQ. + +The NF Service Consumer shall include the revokeEbiList IE to request the SMF to release some EBI(s). The SMF shall disassociate the EBI(s) with the QFI(s) with which they are associated. + +#### 5.2.2.8.2.19 Network requested PDU session release + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the requestIndication set to NW\_REQ\_PDU\_SES\_REL. + +#### 5.2.2.8.2.20 N2 Handover Execution with or without I-SMF or V-SMF Change + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the qosFlowsRelNotifyList IE indicating the failed QoS flow(s), if one or more QoS flow(s) cannot be established at the target RAN. + +For an N2 handover with an I-SMF or V-SMF change, the requirements specified in step 1 of clause 5.2.2.8.2.10, other than how to set the requestIndication, shall also apply. + +2. Same as step 2 of Figure 5.2.2.8.2-1, with the following modifications. + +For an N2 handover with an I-SMF or V-SMF change, the requirements specified in step 2 of clause 5.2.2.8.2.10 shall also apply. + +#### 5.2.2.8.2.21 Reporting of satellite backhaul change to (H-)SMF + +If the V-SMF/I-SMF and the anchor SMF support the 5GSAT feature (see clause 6.1.8), the V-SMF/I-SMF shall report a change of the satellite backhaul category used towards the 5G AN currently serving the UE if: + +- the satelliteBackhaulCat IE has been received from the AMF and there is a change of the satelliteBackhaulCat IE compared to what has been signalled earlier to the (H-)SMF (as determined from the SmContext); or +- upon inter-AMF mobility (when a target AMF is taking over the control of the PDU session), the new AMF does not include the satelliteBackhaulCat IE and a satellite backhaul category had been signalled to the SMF (as determined from the SmContext). + +To report a change of the satellite backhaul category, the requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the requestIndication IE set to NW\_REQ\_PDU\_SES\_MOD, unless specified otherwise in clause 5.2.2.8. if the change of the satelliteBackhaulCat IE is detected during a procedure for which it is requested to report a different requestIndication value; and +- the satelliteBackhaulCat IE set to the value received from the AMF or, in the latter case, set to the value "NON\_SATELLITE" to indicate that there is no longer any satellite backhaul towards the new 5G AN serving the UE. + +#### 5.2.2.8.2.22 Simultaneous change of PSA and BP or UL CL controlled by I-SMF + +This clause applies only in case of non-roaming or LBO roaming as control of an UL CL or BP in VPLMN is not supported in HR roaming case (see clause 5.34.4 of 3GPP TS 23.501 [2]). + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications: + +The POST request shall contain: + +- the requestIndication IE set to NW\_REQ\_PDU\_SES\_MOD; +- a PsaInformation corresponding to the new PSA: + - a PsaIndication set to "PSA\_INSERTED"; + - the list of DNAIs supported by the inserted PSA; + - the new UE IPv6 prefix at the inserted PSA, assigned by the I-SMF or by the UPF supporting the PSA, if IPv6 multi-homing applies to the PDU session; + - the NF Instance Id of the inserted PSA; +- a UlclBpInformation corresponding to the new UL CL or BP if it separate from the new PSA: + - the NF Instance Id of the inserted UL CL or BP; +- a PsaInformation corresponding to the removed PSA, if either the I-SMF or the SMF does not support the "N9FSC" feature: + - a PsaIndication set to "PSA\_REMOVED"; + - the removed UE IPv6 prefix at the removed PSA, if IPv6 multi-homing applies to the PDU session; + - the list of DNAIs supported by the removed PSA. + +NOTE: The I-SMF only includes the PsaInformation corresponding to the new PSA and the UlclBpInformation corresponding to the new UL CL or BP during simultaneous change of PSA and BP or UL CL as specified in clause D.2.7 of 3GPP TS 29.244 [29], if both the I-SMF and SMF support the "N9FSC" feature. This enables the SMF to possibly request the I-SMF to apply data forwarding between the old and the new UL CL/BP, in which case the I-SMF later informs the SMF that it has removed the old UL CL/BP and local PSA upon user plane inactivity of the N9 data forwarding tunnel. + +- 2a. Same as step 2a of Figure 5.2.2.8.2-1. + +#### 5.2.2.8.2.23 Service Request without I-SMF/V-SMF Change or with I-SMF/V-SMF Change or with I-SMF Insertion + +During a Service Request without I-SMF/V-SMF Change or with I-SMF/V-SMF Change or with I-SMF Insertion, the NF Service Consumer (i.e. the V-SMF for a HR PDU session, or the I-SMF for a PDU session with an I-SMF) shall update the PDU session in the H-SMF or SMF as follows: + +![Sequence diagram showing PDU session update towards H-SMF or SMF during Service Request. The diagram involves two participants: NF Service Consumer and SMF. The sequence of messages is: 1. POST (upCnxState=ACTIVATING) from NF Service Consumer to SMF; 2a. 204 No Content or 200 OK (HsmfUpdatedData) from SMF to NF Service Consumer; 2b. 4xx/5xx (HsmfUpdateError) or 3xx from SMF to NF Service Consumer; 3. POST (upCnxState=ACTIVATED) from NF Service Consumer to SMF; 4a. 204 No Content or 200 OK (HsmfUpdatedData) from SMF to NF Service Consumer; 4b. 4xx/5xx (HsmfUpdateError) or 3xx from SMF to NF Service Consumer.](2f587210e4f97c32758c5972e2e83d20_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: 1. POST (upCnxState=ACTIVATING) + NF Service Consumer-->>SMF: 1. POST (upCnxState=ACTIVATING) + Note left of SMF: 2a. 204 No Content or 200 OK (HsmfUpdatedData) + SMF-->>NF Service Consumer: 2a. 204 No Content or 200 OK (HsmfUpdatedData) + Note left of SMF: 2b. 4xx/5xx (HsmfUpdateError) or 3xx + SMF-->>NF Service Consumer: 2b. 4xx/5xx (HsmfUpdateError) or 3xx + Note right of NF Service Consumer: 3. POST (upCnxState=ACTIVATED) + NF Service Consumer-->>SMF: 3. POST (upCnxState=ACTIVATED) + Note left of SMF: 4a. 204 No Content or 200 OK (HsmfUpdatedData) + SMF-->>NF Service Consumer: 4a. 204 No Content or 200 OK (HsmfUpdatedData) + Note left of SMF: 4b. 4xx/5xx (HsmfUpdateError) or 3xx + SMF-->>NF Service Consumer: 4b. 4xx/5xx (HsmfUpdateError) or 3xx + +``` + +Sequence diagram showing PDU session update towards H-SMF or SMF during Service Request. The diagram involves two participants: NF Service Consumer and SMF. The sequence of messages is: 1. POST (upCnxState=ACTIVATING) from NF Service Consumer to SMF; 2a. 204 No Content or 200 OK (HsmfUpdatedData) from SMF to NF Service Consumer; 2b. 4xx/5xx (HsmfUpdateError) or 3xx from SMF to NF Service Consumer; 3. POST (upCnxState=ACTIVATED) from NF Service Consumer to SMF; 4a. 204 No Content or 200 OK (HsmfUpdatedData) from SMF to NF Service Consumer; 4b. 4xx/5xx (HsmfUpdateError) or 3xx from SMF to NF Service Consumer. + +**Figure 5.2.2.8.2.23-1: PDU session update towards H-SMF or SMF during Service Request** + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +- Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall additionally contain: + +- the upCnxState IE set to ACTIVATING if the User Plane resource for the PDU Session is going to be established by the I-SMF/V-SMF. + +- Same as step 2a of Figure 5.2.2.8.2-1, with the following modifications. + +The SMF shall behave as specified in clause as specified in clause 4.23.4.2 (step 7a) and clause 4.23.4.3 (step 8a) of 3GPP TS 23.502 [3]. + +- Same as step 2b of Figure 5.2.2.8.2-1. + +- Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall additionally contain: + +- the upCnxState IE set to ACTIVATED when User Plane resource has been established, if the upCnxState IE with the value ACTIVATING was previously provided to the SMF in the procedure, via a previous Update operation (step 1) or via Create operation for I-SMF/V-SMF insertion (see clause 5.2.2.7.6). + +- Same as step 2a of Figure 5.2.2.8.2-1, with the following modifications. + +The SMF shall behave as specified in clause as specified in clause 4.23.4.2 (step 16) and clause 4.23.4.3 (step 20a) of 3GPP TS 23.502 [3]. + +- Same as step 2b of Figure 5.2.2.8.2-1. + +NOTE: The upCnxState IE set to ACTIVATING or ACTIVATED implements the "Operation Type" parameter set to "UP Activate" or "UP Activated" (respectively) specified in clause 4.23.4.2 (step 7a, 16) and clause 4.23.4.3 (step 8a, 20a) in 3GPP TS 23.502 [3]. + +#### 5.2.2.8.2.24 Remote UE Report during 5G ProSe Communication via 5G ProSe Layer-3 UE-to-Network Relay without N3IWF + +The requirements specified in clause 5.2.2.8.2.1 shall apply with the following modifications. + +- Same as step 1 of Figure 5.2.2.8.2-1, with the following modifications. + +The POST request shall contain: + +- the n1SmInfoFromUe IE containing "Remote UE context connected" and/or "Remote UE context disconnected" NAS IE. + +### 5.2.2.8.3 Update service operation towards V-SMF or I-SMF + +#### 5.2.2.8.3.1 General + +The NF Service Consumer (i.e. the H-SMF for a HR PDU session, or the SMF for a PDU session with an I-SMF) shall update a PDU session in the V-SMF or I-SMF and/or provide information necessary for the V-SMF or I-SMF to send N1 SM signalling to the UE, or request to allocate or revoke EPS Bearer ID(s) for the PDU session, by using the HTTP "modify" custom operation as shown in Figure 5.2.2.8.3.1-1. + +![Sequence diagram showing the PDU session update procedure between an NF Service Consumer and a V-SMF/I-SMF. The NF Service Consumer sends two possible POST requests (1a and 1b) to the V-SMF/I-SMF. The V-SMF/I-SMF responds with either a 2a. 204 No Content or 200 OK (VsmfUpdatedData) or a 2b. 4xx/5xx (VsmfUpdateError) or 3xx response.](78de09c382ab51b5c3e87979204228c8_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant V-SMF/I-SMF + Note left of NF Service Consumer: 1a. POST {vsmfPduSessionUri}/modify (VsmfUpdateData) + Note left of NF Service Consumer: 1b. POST {ismfPduSessionUri}/modify (VsmfUpdateData) + NF Service Consumer->>V-SMF/I-SMF: Request + V-SMF/I-SMF-->>NF Service Consumer: 2a. 204 No Content or 200 OK (VsmfUpdatedData) + V-SMF/I-SMF-->>NF Service Consumer: 2b. 4xx/5xx (VsmfUpdateError) or 3xx + +``` + +Sequence diagram showing the PDU session update procedure between an NF Service Consumer and a V-SMF/I-SMF. The NF Service Consumer sends two possible POST requests (1a and 1b) to the V-SMF/I-SMF. The V-SMF/I-SMF responds with either a 2a. 204 No Content or 200 OK (VsmfUpdatedData) or a 2b. 4xx/5xx (VsmfUpdateError) or 3xx response. + +**Figure 5.2.2.8.3.1-1: PDU session update towards V-SMF or I-SMF** + +1. The NF Service Consumer shall send a POST request to the resource representing the individual PDU session resource in the V-SMF or I-SMF. The content of the POST request shall contain: + +- the requestIndication IE indicating the request type, which is set to NW\_REQ\_PDU\_SES\_MOD; +- the modification instructions and/or the information necessary for the V-SMF or I-SMF to send N1 SM signalling to the UE; +- the hsmfPduSessionUri IE if the Update Request is sent to the V-SMF or I-SMF before the Create Response, and the H-SMF or SMF PDU session resource URI has not been previously provided to the V-SMF or I-SMF; in this case, the supportedFeatures IE shall also be included if at least one optional feature defined in clause 6.1.8 is supported. + +The content of the POST request may further contain: + +- the (updated) pending update information list. + +If the PDU session may be moved to EPS with N26 and the EPS PDN Connection Context information of the PDU session is changed, e.g. due to a new anchor SMF is reselected, the content shall include the "epsPdnCnxInfo" IE including the updated EPS PDN Connection Context information. The NF Service consumer shall overwrite the locally stored EPS PDN Connection Context information with the new one if received. + +If the service operation is invoked after the reselection of the anchor SMF and the change of anchor SMF has not been signalled to the V-SMF or I-SMF previously, the request may carry the SMF Instance ID of the new anchor SMF and the updated PDU session resource URI in the HTTP content, and/or carry an updated binding indication in the HTTP headers to indicate the change of anchor SMF (as per step 6 of clause 6.5.3.3 of 3GPP TS 29.500 [4]). + +For a HR-SBO session, the content of the POST request may also contain the hrsboInfo IE including the HR-SBO information sent from the HPLMN, e.g., due to a change of the user subscription data or policy information. If the VPLMN Specific Offloading Information for a given Offload Identifier is changed, for each V-SMF service instance using the Offload Identifier, the H-SMF shall choose one existing HR-SBO PDU Session served by the V-SMF service instance and using the Offload Identifier to update VPLMN Specific Offloading Information and corresponding Offload Identifier to the V-SMF service instance. + +- 2a. On success, "204 No Content" or "200 OK" shall be returned; in the latter case, the content of the POST response shall contain the representation describing the status of the request and/or information received by the V-SMF or I-SMF in N1 signalling from the UE. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.7.4.2.2-1 shall be returned. For a 4xx/5xx response, the message body shall contain a VsmfUpdateError structure, including: +- a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.7.4.2.2-1; + - the n1SmCause IE with the 5GSM cause returned by the UE, if available; + - n1SmInfoFromUe and/or unknownN1SmInfo binary data, if NAS SM information has been received from the UE that needs to be transferred to the H-SMF or SMF, or that the V-SMF or I-SMF does not comprehend; + - the procedure transaction id received from the UE, if available. + +#### 5.2.2.8.3.2 Network (e.g. H-SMF, SMF) requested PDU session modification + +The requirements specified in clause 5.2.2.8.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.3.1-1, with the following modifications. + +The requestIndication shall be set to NW\_REQ\_PDU\_SES\_MOD. + +As part of the modification instructions, the NF Service Consumer may request to modify QoS parameters applicable at the PDU session level (e.g. modify the authorized Session AMBR values) or at the QoS flow level (e.g. modify the MFBR of a particular QoS flow). + +The NF Service Consumer may request to establish, modify and/or release QoS flows by including the qosFlowsAddModRequestList IE and/or the qosFlowsRelRequestList IE in the content. + +The H-SMF or SMF may provide alternative QoS profiles for each GBR QoS flow with Notification control enabled, to allow the NG-RAN to accept the setup of the QoS flow if the requested QoS parameters or at least one of the alternative QoS parameters sets can be fulfilled at the time of setup. If the H-SMF or SMF provides a new list of alternative QoS profile(s) for a given GBR QoS flow, the V-SMF or I-SMF shall replace any previously stored list for this QoS flow with it. + +The NF Service Consumer may include epsBearerInfo IE(s), if the PDU session may be moved to EPS during its lifetime and the EPS Bearer(s) information has changed (e.g. a new EBI has been assigned or the mapped EPS bearer QoS for an existing EBI has changed). + +The NF Service Consumer may include the modifiedEbiList IE if the PDU session modification procedure resulted in the change of ARP for a QoS flow that has already been allocated an EBI. + +The NF Service Consumer may include the revokeEbiList IE to request the V-SMF or I-SMF to release some EBI(s) and delete any corresponding EPS bearer context stored in the V-SMF or I-SMF. The V-SMF or I-SMF shall disassociate the EBI(s) with the QFI(s) with which they are associated. + +The H-SMF may include the hrsboInfo IE if the V-SMF supports the HR-SBO feature and if the H-SMF needs to update the HR-SBO information towards the V-SMF, e.g. due to a change of the user subscription data or policy information. When doing so, H-SMF shall include the complete information for HR-SBO and the V-SMF shall replace any earlier received HR-SBO information by the new HR-SBO information. + +2. Same as step 2 of Figure 5.2.2.8.3.1-1, with the following modifications. + +The V-SMF or I-SMF may accept all or only a subset of the QoS flows requested to be created or modified within the request. + +The list of QoS flows which have been successfully setup or modified, and those which failed to be so, if any, shall be included in the qosFlowsAddModList IE and/or the qosFlowsFailedtoAddModList IE respectively. If any QoS flow(s) are failed to be setup or modified due to rejection by the V-SMF, the V-SMF may also include the qosFlowsVsmfRejectedAddModList IE with the QoS flow(s) that are rejected by the V-SMF. + +The V-SMF or I-SMF may report an alternative QoS profile which the NG-RAN currently fulfils in the currentQosProfileIndex IE of the corresponding QoS flow in the qosFlowsAddModList IE, or report that the NG-RAN cannot even fulfil the lowest alternative QoS profile by setting the nullQoSProfileIndex IE to "true" for the corresponding QoS flow in the qosFlowsAddModList IE. + +If the NG-RAN rejects the establishment of a voice QoS flow due to EPS Fallback for IMS voice (see clause 4.13 of 3GPP TS 23.502 [3]), the V-SMF or I-SMF shall return the cause indicating that "mobility due to EPS fallback for IMS voice is on-going" for the corresponding flow in the qosFlowsFailedtoAddModList IE. + +The list of QoS flows which have been successfully released, and those which failed to be so, if any, shall be included in the qosFlowsRelList and/or qosFlowsFailedtoRelList IE respectively. + +For a QoS flow which failed to be modified, the V-SMF or I-SMF shall fall back to the configuration of the QoS flow as it was configured prior to the reception of the PDU session update request from the NF Service Consumer. + +The V-SMF or I-SMF shall store any EPS bearer information received from the H-SMF or SMF. If the revokeEbiList IE is present in the request, the V-SMF or I-SMF shall request delete the corresponding EPS bearer contexts and request the AMF to release the EBIs listed in this IE. If the modifiedEbiList IE is present in the request, the V-SMF or I-SMF shall request the AMF to update the mapping of EBI and ARP if the EAEA feature is supported by both the AMF and the V-SMF (or I-SMF), otherwise the V-SMF (or I-SMF) should indicate in the response that the modifiedEbiList was not delivered to the AMF. + +If the request received from the H-SMF or SMF contains the alwaysOnGranted attribute set to true, the V-SMF or I-SMF shall check and determine whether the PDU session can be established as an always-on PDU session based on local policy. + +#### 5.2.2.8.3.3 Network (e.g. H-SMF, SMF) or UE requested PDU session release + +The requirements specified in clause 5.2.2.8.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.3.1-1, with the following modifications. + +The requestIndication shall be set to NW\_REQ\_PDU\_SES\_REL or UE\_REQ\_PDU\_SES\_REL for a Network requested PDU session release or UE requested PDU session release respectively. + +2. Same as step 2 of Figure 5.2.2.8.3.1-1, with the following modifications. + +If the requestIndication in the request is set to NW\_REQ\_PDU\_SES\_REL or UE\_REQ\_PDU\_SES\_REL, the V-SMF or I-SMF shall initiate the release of RAN resources allocated for the PDU session if any and shall send a PDU session release command to the UE. + +The V-SMF or I-SMF shall not release the SM context for the PDU session. + +NOTE: The SM context will be released when receiving Status notification from the H-SMF or SMF indicating the PDU session is released in the H-SMF or SMF. + +#### 5.2.2.8.3.4 Handover between 3GPP and untrusted non-3GPP access, from 5GC-N3IWF to EPS or from 5GS to EPC/ePDG + +The requirements specified in clause 5.2.2.8.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.3.1-1, with the following modifications. + +The NF Service Consumer shall request the source V-SMF or I-SMF to release the resources in the VPLMN without sending a PDU session release command to the UE, by setting the requestIndication IE to NW\_REQ\_PDU\_SES\_REL and the Cause IE indicating "Release due to Handover", in the following scenarios: + +- Handover of a PDU session between 3GPP and untrusted non-3GPP access, when the UE is roaming and the selected N3IWF is in the HPLMN (see clause 4.9.2.4.2 of 3GPP TS 23.502 [3]); +- Handover from 5GC-N3IWF to EPS (see clause 4.11.3.2 of 3GPP TS 23.502 [3]); +- Handover from 5GS to EPC/ePDG (see clause 4.11.4.2 of 3GPP TS 23.502 [3]). + +2. Same as step 2 of Figure 5.2.2.8.3.1-1, with the following modifications. + +If the requestIndication in the request is set to NW\_REQ\_PDU\_SES\_REL and if the Cause IE indicates "Release due to Handover", the V-SMF or I-SMF shall initiate the release of RAN resources reserved for the PDU session if any but shall not send a PDU session release command to the UE. + +The V-SMF or I-SMF shall not release the SM context for the PDU session. + +NOTE: The SM context will be released when receiving Status notification from the H-SMF or SMF indicating the PDU session is released in the H-SMF or SMF. + +#### 5.2.2.8.3.5 EPS Bearer ID assignment + +The requirements specified in clause 5.2.2.8.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.3.1-1, with the following modifications. + +The requestIndication shall be set to EBI\_ASSIGNMENT\_REQ. + +The NF Service Consumer may include the assignEbiList IE to request the allocation of EBI(s). The NF Service Consumer may include the revokeEbiList IE to request the V-SMF or I-SMF to release some EBI(s) and delete any corresponding EPS bearer context stored in the V-SMF or I-SMF. The V-SMF or I-SMF shall disassociate the EBI(s) with the QFI(s) with which they are associated. + +NOTE: The SMF does not request EBI allocation when MA PDU Session is established only over non-3GPP access. For MA PDU Session with both 3GPP and non-3GPP accesses, the SMF does not allocate EBI(s) for GBR QoS Flow(s) that are only allowed over non-3GPP access. + +Upon receipt of this request, the V-SMF or I-SMF shall request the AMF to assign (and release if required) EBIs (see clause 5.2.2.6 of 3GPP TS 29.518 [20]). + +- 2a. Same as step 2a of Figure 5.2.2.8.3.1-1, with the following modifications. + +If the AMF has successfully assigned all or part of the requested EBIs, the V-SMF or I-SMF shall respond with the status code 200 OK, and include the list of EBIs successfully allocated, those which failed to be so if any, and the list of EBIs released for this PDU session at AMF if any, in the assignedEbiList IE, the failedtoAssignEbiList IE and/or the releasedEbiList IE respectively. + +- 2b. Same as step 2b of Figure 5.2.2.8.3.1-1, with the following modifications. + +For a 4xx/5xx response, the message body shall contain a VsmfUpdateError structure, including the list of EBIs which failed to be allocated in the failedtoAssignEbiList IE. + +#### 5.2.2.8.3.6 Addition of PSA and BP or UL CL controlled by I-SMF + +The requirements specified in clause 5.2.2.8.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.3.1-1, with the following modifications. + +The requestIndication shall be set to NW\_REQ\_PDU\_SES\_MOD. + +The content of the POST request shall contain: + +- N4 information for the handling of the local traffic that is offloaded at the PSA (see Annex D of 3GPP TS 29.244 [29]); +- N4 information for the local offload rules at the UL CL/BP (see Annex D of 3GPP TS 29.244 [29]); +- the DNAI related to N4 information targeting the local PSA; +- the indication that the DNAI shall not change, if applicable; +- the indication that the local PSA shall not change, if applicable. + +For the Simultaneous change of Branching Points or UL CLs controlled by different I-SMFs (see clause 4.23.9.5 of 3GPP TS 23.502 [3]), the POST request may also contain: + +- n9DataForwardingInd set to true, if the N9 Forwarding Tunnel establishment between Branching Points or UL CLs to support the EAS session continuity is required; +- n9UIPdrIdList pointing to the UL PDR(s) included in the N4 information for UL N9 forwarding in the target Branching Point or UL CL to support the EAS session continuity; + +- n9InactivityTimer to detect the end of activity on the N9 forwarding tunnel to support the EAS session continuity. + +2a. Same as step 2a of Figure 5.2.2.8.3.1-1, with the following modifications. + +The content of the POST response shall contain: + +- N4 response information; +- the DNAI related to the N4 information if the latter relates to a local PSA. + +2b. Same as step 2b of Figure 5.2.2.8.3.1-1, with the following modifications. + +For a 4xx/5xx response, the message body shall contain a VsmfUpdateError structure, including N4 response information if available (e.g. PFCP Session Establishment Response with a rejection cause). + +#### 5.2.2.8.3.7 Removal of PSA and BP or UL CL controlled by I-SMF + +The requirements specified in clause 5.2.2.8.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.3.1-1, with the following modifications. + +The requestIndication shall be set to NW\_REQ\_PDU\_SES\_MOD. + +The content of the POST request shall contain: + +- N4 information for the removal of the local offload rules at the UL CL/BP and PSA (see Annex D of 3GPP TS 29.244 [29]); +- the DNAI related to N4 information targeting the local PSA. + +2a. Same as step 2a of Figure 5.2.2.8.3.1-1, with the following modifications. + +The content of the POST response shall contain: + +- N4 response information; +- the DNAI related to the N4 information if the latter relates to a local PSA. + +2b. Same as step 2b of Figure 5.2.2.8.3.1-1, with the following modifications. + +For a 4xx/5xx response, the message body shall contain a VsmfUpdateError structure, including N4 response information if available (e.g. PFCP Session Deletion Response with a rejection cause). + +#### 5.2.2.8.3.8 Change of PSA for IPv6 multi-homing or UL CL controlled by I-SMF + +The requirements specified in clause 5.2.2.8.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.3.1-1, with the following modifications. + +The requestIndication shall be set to NW\_REQ\_PDU\_SES\_MOD. + +The content of the POST request shall contain: + +- N4 information for the removal of the local offload rules at the removed PSA (see Annex D of 3GPP TS 29.244 [29]); +- N4 information for the handling of the local traffic that is offloaded at the inserted PSA (see Annex D of 3GPP TS 29.244 [29]); +- N4 information for the updating of the local offload rules at the UL CL/BP (see Annex D of 3GPP TS 29.244 [29]); +- the DNAIs related to N4 information targeting the removed or inserted PSA. + +2a. Same as step 2a of Figure 5.2.2.8.3.1-1, with the following modifications. + +The content of the POST response shall contain: + +- N4 response information; +- the DNAI related to the N4 information if the latter relates to a local PSA. + +2b. Same as step 2b of Figure 5.2.2.8.3.1-1, with the following modifications. + +For a 4xx/5xx response, the message body shall contain a VsmfUpdateError structure, including N4 response information if available (e.g. PFCP Session Establishment Response with a rejection cause). + +#### 5.2.2.8.3.9 Policy update procedures with an I-SMF + +The requirements specified in clause 5.2.2.8.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.3.1-1, with the following modifications. + +The requestIndication shall be set to NW\_REQ\_PDU\_SES\_MOD. + +The content of the POST request may contain: + +- N4 information updating local offload rules at the I-SMF (see Annex D of 3GPP TS 29.244 [29]); +- the DNAI related to the N4 information if the latter relates to a local PSA; +- an updated list of DNAI(s) of interest for the PDU Session. + +2a. Same as step 2a of Figure 5.2.2.8.3.1-1, with the following modifications. + +The content of the POST response shall contain: + +- N4 response information, if N4 information was received in the request; +- the DNAI related to the N4 information if the latter relates to a local PSA. + +2b. Same as step 2b of Figure 5.2.2.8.3.1-1, with the following modifications. + +For a 4xx/5xx response, the message body shall contain a VsmfUpdateError structure, including N4 response information if available (e.g. PFCP Session Modification Response with a rejection cause). + +#### 5.2.2.8.3.10 Simultaneous change of PSA and BP or UL CL controlled by I-SMF + +The requirements specified in clause 5.2.2.8.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.3.1-1, with the following modifications. + +The requestIndication shall be set to NW\_REQ\_PDU\_SES\_MOD. + +The content of the POST request shall contain: + +- N4 information for the removal of the local offload rules at the removed PSA (see Annex D of 3GPP TS 29.244 [29]); +- N4 information for the handling of the local traffic that is offloaded at the inserted PSA (see Annex D of 3GPP TS 29.244 [29]); +- N4 information for the removal of the local offload rules at the removed UL CL/BP (see Annex D of 3GPP TS 29.244 [29]); +- N4 information for the creation of the local offload rules at the inserted UL CL/BP (see Annex D of 3GPP TS 29.244 [29]); +- the DNAIs related to N4 information targeting the removed or inserted PSA. + +The content of the POST request may contain: + +- n9DataForwardingInd set to true, if the N9 Forwarding Tunnel establishment between Branching Points or UL CLs to support the EAS session continuity is required; +- n9UIPdrIdList pointing to the UL PDR(s) included in the N4 information for UL N9 forwarding in the target Branching Point or UL CL to support the EAS session continuity; +- n9InactivityTimer to detect the end of activity on the N9 forwarding tunnel to support the EAS session continuity. + +The SMF may only include the N4 information for the inserted PSA and the inserted UL CL/BP as specified in clause D.2.7 of 3GPP TS 29.244 [29], if the I-SMF only includes the PsaInformation corresponding to the new PSA and the UclBpInformation corresponding to the new UL CL or BP during simultaneous change of PSA and BP or UL CL and data forwarding between the new and old UL CL/BPs for EAS session continuity is required. + +2a. Same as step 2a of Figure 5.2.2.8.3.1-1, with the following modifications. + +The content of the POST response shall contain: + +- N4 response information; +- the DNAI related to the N4 information if the latter relates to a local PSA. + +2b. Same as step 2b of Figure 5.2.2.8.3.1-1, with the following modifications. + +For a 4xx/5xx response, the message body shall contain a VsmfUpdateError structure, including N4 response information if available (e.g. PFCP Session Establishment Response with a rejection cause). + +#### 5.2.2.8.3.11 Network (e.g. AMF) triggered network slice replacement with PDU session retained + +During network slice replacement procedure, for HR PDU session, if the H-SMF determines to retain the PDU session for the alternative HPLMN S-NSSAI, the H-SMF shall use this procedure to instruct the V-SMF that the PDU session is retained for the alternative HPLMN S-NSSAI (see clause 4.3.3.3 of 3GPP TS 23.502 [3]). + +The requirements specified in clause 5.2.2.8.3.1 shall apply with the following modifications. + +1. Same as step 1 of Figure 5.2.2.8.3.1-1, with the following modifications. + +The requestIndication shall be set to NW\_REQ\_PDU\_SES\_MOD. + +The content of the POST request shall contain: + +- an altHplmnSnssai IE to indicate the alternative HPLMN S-NSSAI applied to the PDU session; +- a pduSessionRetainInd IE to indicate the PDU session is retained; + +2a. Same as step 2a of Figure 5.2.2.8.3.1-1. + +### 5.2.2.9 Release service operation + +#### 5.2.2.9.1 General + +The Release service operation shall be used to request an immediate and unconditional deletion of an individual PDU session resource in the SMF (i.e. in the H-SMF for a HR PDU session, or in the SMF for a PDU session with an I-SMF). + +It is invoked by the NF Service Consumer (i.e. V-SMF or I-SMF) in the following procedures: + +- UE initiated Deregistration (see clause 4.2.2.3.2 of 3GPP TS 23.502 [3]); +- Network initiated Deregistration (see clause 4.2.2.3.2 of 3GPP TS 23.502 [3]), e.g. AMF initiated deregistration; +- visited network requested PDU Session release (see clause 4.3.4.3 of 3GPP TS 23.502 [3]), e.g. AMF initiated release in the following cases: + - when there is a mismatch of the PDU session status between the UE and the AMF; + +- when a network slice is no longer available; +- when the PDU session is rejected by the new AMF to the old AMF during Registration procedure (as described in clause 4.2.2.2.2 of 3GPP TS 23.502 [3]); or +- due to Mobility or Access Restrictions (see clause 5.16.4.3 of 3GPP TS 23.501 [2]). +- 5GS to EPS handover using N26 interface and 5GS to EPS Idle mode mobility using N26, to release the PDU session not transferred to EPC (see clauses 4.11.1.2.1 and 4.11.1.3.2 of 3GPP TS 23.502 [3]); +- PDU session release procedure, for a PDU session with an I-SMF (see clause 4.23.5.2 of 3GPP TS 23.502 [3]); +- 5G-SRVCC from NG-RAN to 3GPP UTRAN procedure (see clause 6.5.4 of 3GPP TS 23.216 [35]). + +The SMF shall release the PDU session context without triggering any signalling towards the 5G-AN and the UE. + +The NF Service Consumer shall release a PDU session in the SMF by using the HTTP "release" custom operation as shown in Figure 5.2.2.9.1-1. + +![Sequence diagram showing the PDU session release procedure between an NF Service Consumer and an SMF. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 200 OK (ReleasedData) / 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx response.](384ca4ed072674dbb16642cd334b1c15_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note left of NF Service Consumer: 1. POST .../pdu-sessions/{pduSessionRef}/release (ReleaseData) + NF Service Consumer->>SMF: Request + Note right of SMF: 2a. 200 OK (ReleasedData) / 204 No Content + SMF-->>NF Service Consumer: Response 2a + Note right of SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + SMF-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram showing the PDU session release procedure between an NF Service Consumer and an SMF. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 200 OK (ReleasedData) / 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.2.2.9.1-1: Pdu session release** + +1. The NF Service Consumer shall send a POST request to the resource representing the individual PDU session resource in the SMF. The content of the POST request shall contain any data that needs to be passed to the SMF. + +If an UL CL/BP was inserted in the data path of the PDU session and traffic usage measurements need to be reported to the SMF, the POST request shall contain: + +- N4 information related with traffic usage reporting (i.e. PFCP Session Report Request, see Annex D of 3GPP TS 29.244 [29]); +- the DNAI related to the N4 information if the latter relates to a local PSA. + +If VPLMN QoS constraints are required for the PDU session and the H-SMF provides QoS parameters not complying with VPLMN QoS required by the V-SMF, the V-SMF may release the PDU session with the "cause" attribute set to "REL\_DUE\_TO\_VPLMN\_QOS\_FAILURE". + +- 2a. On success, the SMF shall return a "200 OK" with message body containing the representation of the ReleasedData when information needs to be returned to the NF Service Consumer, or a "204 No Content" response with an empty content in the POST response. + +If N4 information was received in the request, the POST response shall contain: + +- N4 response information (i.e. PFCP Session Report Response); +- the DNAI related to the N4 information if the latter relates to a local PSA. + +If the request body contains the "cause" attribute with the value "REL\_DUE\_TO\_PS\_TO\_CS\_HO", the (H-) SMF shall indicate to the PCF within SM Policy Association termination that the PDU session is released due to 5G-SRVCC. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.6.4.3.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.6.4.3.2-2. + +## 5.2.2.10 Notify Status service operation + +### 5.2.2.10.1 General + +The Notify Status service operation shall be used to notify the NF Service Consumer about status changes of a PDU session (e.g. when the PDU session is released and the release is not triggered by a Release Request, or when the PDU session is moved to another system, or when the control of the PDU session is taken over by another anchor SMF), for a HR PDU session or a PDU session involving an I-SMF. + +It is used in the following procedures: + +- Home network requested PDU Session release (see clause 4.3.4.3 of 3GPP TS 23.502 [3]), e.g. H-SMF initiated release; +- SMF requested PDU session release, for a PDU session involving an I-SMF (see clause 4.23 of 3GPP TS 23.502 [3]); +- Handover of a PDU Session procedure from 3GPP to untrusted non-3GPP access (see clauses 4.9.2.4.2 and 4.23.16.2 of 3GPP TS 23.502 [3]); +- Interworking procedures without N26 interface, e.g. 5GS to EPS Mobility (see clause 4.11.2.2 of 3GPP TS 23.502 [3]); +- Handover from 5GC-N3IWF to EPS (see clause 4.11.3.2 of 3GPP TS 23.502 [3]); +- Handover from 5GS to EPC/ePDG (see clause 4.11.4.2 of 3GPP TS 23.502 [3]); +- The control of PDU session is taken over by a new anchor SMF within the same SMF set (see clause 5.22 of 3GPP TS 29.244 [29]), and the new SMF instance decides to notify the change of SMF; +- SMF triggered I-SMF selection or removal (see clause 4.23.5.4 of 3GPP TS 23.502 [3]); +- Change of SSC mode 2 PDU Session Anchor with different PDU Sessions (see clause 4.3.5.1 of 3GPP TS 23.502 [3]); +- Change of SSC mode 3 PDU Session Anchor with multiple PDU Sessions (see clause 4.3.5.2 of 3GPP TS 23.502 [3]); +- Network slice usage behaviour control, i.e. SMF initiated PDU session release due to slice inactivity, see clause 5.15.15.3 of 3GPP TS 23.501 [2]. + +The SMF (i.e. H-SMF for a HR PDU session, or SMF for a PDU session involving an I-SMF) shall notify the NF Service Consumer (i.e. V-SMF for a HR PDU session, or I-SMF for a PDU session involving an I-SMF) by using the HTTP POST method as shown in Figure 5.2.2.10-1. + +![Sequence diagram showing the PDU session status notification process between an NF Service Consumer and an SMF. The SMF sends two POST requests (1a and 1b) to the NF Service Consumer. The NF Service Consumer responds with 2a. 204 No Content and 2b. 4xx/5xx (ProblemDetails) or 3xx.](4aeaa51a3999fab21171224e238cb571_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant NFSC as NF Service Consumer + Note right of SMF: 1a. POST {vsmfPduSessionUri} (StatusNotification) + SMF->>NFSC: 1a. POST {vsmfPduSessionUri} (StatusNotification) + Note right of SMF: 1b. POST {ismfPduSessionUri} (StatusNotification) + SMF->>NFSC: 1b. POST {ismfPduSessionUri} (StatusNotification) + Note left of SMF: 2a. 204 No Content + NFSC-->>SMF: 2a. 204 No Content + Note left of SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + NFSC-->>SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the PDU session status notification process between an NF Service Consumer and an SMF. The SMF sends two POST requests (1a and 1b) to the NF Service Consumer. The NF Service Consumer responds with 2a. 204 No Content and 2b. 4xx/5xx (ProblemDetails) or 3xx. + +**Figure 5.2.2.10-1: PDU session status notification** + +1. The SMF shall send a POST request to the resource representing the individual PDU session resource in the NF Service Consumer. The content of the POST request shall contain the notification content, with the status information. + +If the notification is triggered by PDU session handover to release resources of the PDU Session in the source access, the notification content shall contain the resourceStatus IE with the value "RELEASED" and the Cause IE with value "PDU\_SESSION\_HANDED\_OVER" as specified in clause 4.2.9.4.2 of 3GPP TS 23.502 [3]. + +If the notification is triggered by PDU session handover to release only the SM Context with the I-SMF in the source access but without releasing the PDU session in the AMF, the notification content shall contain the resourceStatus IE with the value "UPDATED" and the Cause IE with the value "PDU\_SESSION\_HANDED\_OVER" as specified in clause 4.23.16.2 of 3GPP TS 23.502 [3]. + +If the notification is triggered by SMF for I-SMF selection or removal for the current PDU session, or SMF selection during PDU Session re-establishment for SSC mode 2/3, the notification content shall contain the resourceStatus IE with the value "UNCHANGED", the Cause IE with the value "TARGET\_DNAI\_NOTIFICATION" and the targetDnaiInfo IE. The targetDnai IE in the targetDnaiInfo IE shall be absent if the I-SMF removal is triggered due to the DNAI currently served by the I-SMF being no longer used for the PDU Session. If the notification is triggered for SMF selection during PDU Session re-establishment for SSC mode 3, the notification content may also contain the oldPduSessionRef IE as specified in clause 4.3.5.2 of 3GPP TS 23.502 [3]. + +If the notification is triggered by PDU session handover to release resources of the PDU Session in the target access due to handover failure between 3GPP access and non-3GPP access, the notification content shall contain the resourceStatus IE with the value "RELEASED" and the Cause IE with the value "PDU\_SESSION\_HAND\_OVER\_FAILURE". + +If the NF Service Consumer indicated support of the HOFAIL feature (see clause 6.1.8) and if the notification is triggered by PDU session handover to update access type of the PDU Session due to handover failure between 3GPP access and non-3GPP access, the notification content shall contain the resourceStatus IE with the value "UPDATED", the anType IE with the value "3GPP" or "NON\_3GPP" indicating the access type of the PDU session after the handover failure scenario and the Cause IE with the value "PDU\_SESSION\_HAND\_OVER\_FAILURE". + +If upon a change of anchor SMF, the new anchor SMF instance decides to notify the change of anchor SMF, then the notification content shall contain the resourceStatus IE with the value "UPDATED" and the Cause IE with the value "CHANGED\_ANCHOR\_SMF". In addition, the new anchor SMF instance shall include its SMF Instance ID in the notification content, and/or carry an updated binding indication in the HTTP headers to indicate the change of anchor SMF (as per step 6 of clause 6.5.3.3 of 3GPP TS 29.500 [4]). If the PDU session may be moved to EPS with N26 and the EPS PDN Connection Context information of the PDU session on the new anchor SMF is different from the one on the old anchor SMF, the content shall also include the "epsPdnCnxInfo" IE including the updated EPS PDN Connection Context information. The NF Service consumer shall overwrite the locally stored EPS PDN Connection Context information with the new one if received. + +If the notification is triggered by a PDU session release due to slice inactivity as specified in clause 5.15.15.3 of 3GPP TS 23.501 [2] and clause 5.11.2 of 3GPP TS 29.244 [29], the notification content shall contain the resourceStatus IE with the value "RELEASED" and the Cause IE with the value "REL\_DUE\_TO\_SLICE\_INACTIVITY". + +2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. + +If the SMF indicated in the request that the PDU session in the SMF is released, the NF Service Consumer shall release the SM context for the PDU session. + +If the SMF indicated in the request that the SM context resource is updated with the anType IE, the NF Service Consumer shall change the access type of the PDU session with the value of anType IE. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.7.3.1-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.7.3.1-2. + +## 5.2.2.11 Send MO Data service operation + +### 5.2.2.11.1 General + +The Send MO Data service operation shall be used to send mobile originated data received over NAS, for a given PDU session, towards the SMF, or the V-SMF for HR roaming scenarios, or the I-SMF for a PDU session with an I-SMF. + +It is used in the following procedures: + +- UPF anchored Mobile Originated Data Transport in Control Plane CIoT 5GS Optimisation (see clause 4.24.1 of 3GPP TS 23.502 [3]); +- NEF anchored Mobile Originated Data Transport (see clause 4.25.4 of 3GPP TS 23.502 [3]). + +The NF Service Consumer (e.g. AMF) shall send mobile originated data to the SMF by using the HTTP POST method (send-mo-data custom operation) as shown in Figure 5.2.2.11.1-1. + +![Sequence diagram showing the 'Send MO Data' procedure between an NF Service Consumer and an SMF. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response.](333992a0b3b7a9d826f72f7bf199221b_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: 1. POST .../sm-contexts/{smContextRef}/send-mo-data +(SendMoDataReqData) + NF Service Consumer->>SMF: Request + Note left of SMF: 2a. 204 No Content + SMF-->>NF Service Consumer: Response 2a + Note left of SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + SMF-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram showing the 'Send MO Data' procedure between an NF Service Consumer and an SMF. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response. + +**Figure 5.2.2.11.1-1: Send MO Data** + +1. The NF Service Consumer shall send a POST request to the resource representing the individual SM context resource in the SMF. The content of the POST request shall contain the mobile originated data to send. + +The request body may include the "MO Exception Data Counter", which indicates that the UE has accessed the network by using "MO exception data" RRC establishment, if Small Data Rate Control is enabled for the PDU session and the UE is accessing via the NB-IoT RAT. + +- 2a. On success, "204 No Content" shall be returned. + +For UPF anchored Mobile Originated Data Transport in Control Plane CIoT 5GS Optimisation, if the "MO Exception Data Counter" is included in the request then: + +- for HR PDU session, the V-SMF shall update the H-SMF (see clause 5.2.2.8.2.2); +- for PDU session with I-SMF, the I-SMF shall update the SMF (see clause 5.2.2.8.2.2). + +- 2b. On failure or redirection, one of the HTTP status codes listed in Table 6.1.3.3.4.5.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails, with the "cause" attribute indicating the cause of the failure. + +## 5.2.2.12 Transfer MO Data service operation + +### 5.2.2.12.1 General + +The Transfer MO Data service operation shall be used to transfer NEF anchored mobile originated data received from AMF, for a given PDU session, towards the H-SMF for HR roaming scenarios, or the SMF for a PDU session with an I-SMF. + +It is used in the following procedures: + +- NEF anchored Mobile Originated Data Transport (see clause 4.25.4 of 3GPP TS 23.502 [3]). + +The NF Service Consumer (e.g. V-SMF or I-SMF) shall transfer NEF anchored mobile originated data to the SMF by using the HTTP POST method (transfer-mo-data custom operation) as shown in Figure 5.2.2.12.1-1. + +![Sequence diagram for Transfer MO Data. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response.](11f18bf0233d812ad2604f88f3385d60_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: 1. POST .../pdu-sessions/{pduSessionRef}/transfer-mo-data (TransferMoDataReqData) + NF Service Consumer->>SMF: Request + Note left of SMF: 2a. 204 No Content + SMF-->>NF Service Consumer: Success Response + Note left of SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + SMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for Transfer MO Data. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response. + +**Figure 5.2.2.12.1-1: Transfer MO Data** + +1. The NF Service Consumer shall send a POST request to the URI of Transfer MO Data custom operation on an individual PDU Session resource in the SMF. The content of the POST request shall contain the mobile originated data to be transferred. + +The content shall also contain the MO Exception Data Counter, if received from AMF. + +- 2a. On success, "204 No Content" shall be returned. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.6.4.4.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails, with the "cause" attribute indicating the cause of the failure. + +## 5.2.2.13 Transfer MT Data service operation + +### 5.2.2.13.1 General + +The Transfer MT Data service operation shall be used to transfer NEF anchored mobile terminated data received from NEF, for a given PDU session, towards the V-SMF for HR roaming scenarios, or the I-SMF for a PDU session with an I-SMF. + +It is used in the following procedures: + +- NEF anchored Mobile Terminated Data Transport (see clause 4.25.5 of 3GPP TS 23.502 [3]). + +The NF Service Consumer (e.g. H-SMF or SMF) shall transfer NEF anchored mobile terminated data to the SMF by using the HTTP POST method (transfer-mt-data custom operation) as shown in Figure 5.2.2.13.1-1. + +![Sequence diagram for Transfer MT Data. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 204 No Content (success) or a 4xx/5xx (TransferMtDataError/ProblemDetails) or 3xx (failure/redirection) response.](a4c8a0374a5b7405a4cdbb6906a2a750_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: 1. POST .../pdu-sessions/{pduSessionRef}/transfer-mt-data (TransferMtDataReqData) + NF Service Consumer->>SMF: Request + Note left of SMF: 2a. 204 No Content + SMF-->>NF Service Consumer: Success Response + Note left of SMF: 2b. 4xx/5xx (TransferMtDataError/ProblemDetails) or 3xx + SMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for Transfer MT Data. The NF Service Consumer sends a POST request to the SMF. The SMF responds with either a 204 No Content (success) or a 4xx/5xx (TransferMtDataError/ProblemDetails) or 3xx (failure/redirection) response. + +**Figure 5.2.2.13.1-1: Transfer MT Data** + +1. The NF Service Consumer shall send a POST request to the URI of Transfer MT Data custom operation on an individual PDU Session resource in the SMF. The content of the POST request shall contain the mobile terminated data to be transferred. + +The SMF shall forward the mobile terminated data to AMF. If SMF determines Extended Buffering is allowed by local policy and the NEF supports Extended Buffering, the SMF indicate the Extending Buffering support to AMF. + +If AMF responds that it is attempting to reach the UE, the SMF shall wait for potential failure notification from AMF before responding to the NF consumer. + +- 2a. On success, "204 No Content" shall be returned. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.7.4.3.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a TransferMtDataError or ProblemDetails object, with the "cause" attribute indicating the cause of the failure. If Estimated Maximum Waiting Time is received from AMF, the SMF shall include it in the message body. + +## 5.2.2.14 Retrieve service operation + +### 5.2.2.14.1 General + +The Retrieve service operation shall be used to retrieve information from a PDU session context from the H-SMF for a HR PDU session, or from the SMF for a PDU session with an I-SMF. + +It is used in the following procedures: + +- 5GS to EPS handover using N26 interface and 5GS to EPS Idle mode mobility using N26 interface (see clauses 4.11.1.2.1 and 4.11.1.2.3 of 3GPP TS 23.502 [3]), for PDU sessions associated with 3GPP access and for which small data rate control is applicable. +- Change of SSC mode 3 PDU Session Anchor with multiple PDU Sessions (see clause 4.3.5.2 of 3GPP TS 23.502 [3]). + +The NF Service Consumer (e.g. V-SMF or I-SMF) shall retrieve information from a PDU session context by using the HTTP POST method (retrieve custom operation) as shown in Figure 5.2.2.14.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an SMF for retrieving information from a PDU session context. The consumer sends a POST request to the SMF, and the SMF responds with either a 200 OK or a 4xx/5xx error.](4ee2de50739c96fd7bd5a38150ec9c78_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: 1. POST .../pdu-sessions/{pduSessionRef}/retrieve (RetrieveData) + NF Service Consumer->>SMF: Request + Note left of SMF: 2a. 200 OK (RetrievedData) + SMF-->>NF Service Consumer: Response + Note left of SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + SMF-->>NF Service Consumer: Error Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an SMF for retrieving information from a PDU session context. The consumer sends a POST request to the SMF, and the SMF responds with either a 200 OK or a 4xx/5xx error. + +**Figure 5.2.2.14.1-1: Retrieval of information from a PDU session context** + +1. The NF Service Consumer shall send a POST request to the resource representing the individual PDU session context for which information needs to be retrieved. The POST request may contain a content with the following parameters: + - smallDataRateStatusReq set to "true" to indicate a request to retrieve the small data rate control status of the PDU session, if small data rate control is applicable on the PDU session. + - pduSessionContextType indicates that this is a request to retrieve the AF Coordination Information as defined in clause 6.1.6.2.69, during the change of SSC mode 3 PDU Session Anchor with multiple PDU Sessions, if the runtime coordination between old SMF and AF is enabled. +- 2a. On success, "200 OK" shall be returned and the content of the POST response shall contain the small data rate control status if this is a request for retrieving the small data rate control status. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.6.4.5.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.6.4.5.2-2. + +## 5.2.3 General procedures + +### 5.2.3.1 Transfer of NAS SM information between UE and H-SMF for Home Routed PDU sessions + +#### 5.2.3.1.1 General + +As specified in clause 4.3.1 of 3GPP TS 23.502 [3], for Home Routed PDU sessions, there is NAS SM information that the V-SMF and H-SMF need to interpret, and NAS SM information that the V-SMF only needs to transfer between the UE and H-SMF but which it does not need to interpret. + +NAS SM information that only needs to be transferred between the UE and H-SMF by the V-SMF can be extended in later versions or releases of the NAS specification, e.g. defining new fields or values within existing IEs, and the extensions should not impact the V-SMF. + +Besides, in HR roaming scenarios, the V-SMF and H-SMF can comply to different versions or releases of the NAS specification. It should be possible to support new SM features only requiring support from the H-SMF without impacting the V-SMF, when the H-SMF complies with a more recent release than the V-SMF, e.g. defining new NAS SM IEs in signalling from the UE to the H-SMF and/or signalling from the H-SMF to the UE. + +#### 5.2.3.1.2 V-SMF Behaviour + +The V-SMF shall transfer NAS SM information that it only needs to transfer to the H-SMF (i.e. known IEs, and IEs that have an unknown value not set to "reserved" according to the release to which the V-SMF complies, that only need to be forwarded by the V-SMF) in n1SmInfoFromUe binary data within the HTTP content. This carries N1 SM IE(s), encoded as specified in 3GPP TS 24.501 [7], including the Type field and, for TLV or TLV-E IEs, the Length field. + +NOTE 1: N1 SM IEs defined without a Type field need to be defined over N16/N16a as specific IEs. + +The V-SMF shall transfer NAS SM information that it does not comprehend (i.e. unknown IEs, or known IEs to be interpreted by the V-SMF that have an unknown value not set to "reserved" according to the release to which the V-SMF complies) in unknownN1SmInfo binary data within the HTTP content. This carries N1 SM IE(s), encoded as specified in 3GPP TS 24.501 [7], including the Type field and, for TLV or TLV-E IEs, the Length field. + +When receiving n1SmInfoToUe binary data in the HTTP content from the H-SMF, the V-SMF shall parse all the N1 SM IEs received in the binary data and construct the NAS SM message to the UE according to 3GPP TS 24.501 [7]. The V-SMF shall append unknown NAS SM IEs received in the binary data at the end of the NAS SM message it sends to the UE. + +NOTE 2: The V-SMF can infer the length of an unknown IE based on the IEI value. See clause 11.2.4 of 3GPP TS 24.007 [8]. + +The V-SMF shall comprehend and be able to encode at their right place in a given NAS message, all the IEs of the version of the NAS specification it implements that do not need to be interpreted by the V-SMF and which precede the last interpreted IE that the V-SMF implements in a NAS message. + +NOTE 3: The V-SMF encodes comprehended IEs at their right place in the NAS SM message + +#### 5.2.3.1.3 H-SMF Behaviour + +When receiving unknownN1SmInfo binary data in the HTTP content from the V-SMF, the H-SMF shall process any N1 SM IE received in this binary data that do not require to be interpreted by the V-SMF. Other N1 SM IEs shall be dropped, e.g. IEs that the H-SMF comprehends but which require to be interpreted by the V-SMF. + +The H-SMF shall transfer NAS SM information which the V-SMF does not need to interpret (i.e. that it only needs to transfer to the UE) in n1SmInfoToUe binary data within the HTTP content. This carries N1 SM IE(s), encoded as specified in 3GPP TS 24.501 [7], including the Type field and, for TLV or TLV-E IEs, the Length field. + +NOTE 1: N1 SM IEs defined without a Type field need to be defined over N16/N16a as specific IEs. + +The NAS SM IEs in n1SmInfoToUe binary data shall be encoded in the same order as specified in 3GPP TS 24.501 [7]. + +N1 SM information which does not require to be interpreted by the V-SMF is information that is not defined as specific IEs over N16. + +### 5.2.3.2 Transfer of NAS SM information between UE and SMF for PDU sessions with an I-SMF + +#### 5.2.3.2.1 General + +The requirements specified in clause 5.2.3.1 shall also apply for the transfer of NAS SM information between the UE and the SMF for PDU sessions with an I-SMF, whereby the I-SMF and SMF shall take the role of the V-SMF and H-SMF respectively. + +#### 5.2.3.3 Detection and handling of late arriving requests + +##### 5.2.3.3.1 Handling of requests which collide with an existing SM context or PDU session context + +###### 5.2.3.3.1.1 General + +This procedure enables an SMF, which receives a request colliding with an existing SM context or PDU session context, to know the time at which the new request and the existing PDU session were originated, and to accept the new request only if it is more recent than the existing PDU session. + +The originating entities within the PLMN (i.e. AMFs) shall be NTP synchronized. + +###### 5.2.3.3.1.2 Principles + +The following principles shall apply if this procedure is supported and enabled by operator policy. + +An AMF originating a Create SM Context request shall include in the message the Origination Time Stamp indicating the absolute time at which the request is initiated. + +The V-SMF or I-SMF shall forward this header to the H-SMF or SMF, if it is received from the AMF. + +Upon receipt of a Create SM Context request or a Create request which collides with an existing SM context or PDU session context, the SMF shall accept the new PDU session establishment request only if it contains a more recent time stamp than the time stamp stored for the existing PDU session. An incoming PDU session establishment request shall be considered as more recent than an existing PDU session and be accepted if no Origination Time Stamp information was provided for at least one of the two PDU sessions. The SMF shall reject an incoming request whose time stamp is less recent than the time stamp of the existing PDU session with the HTTP status code "403 Forbidden" and the application error "LATE\_OVERLAPPING\_REQUEST". + +3GPP TS 29.512 [30] further specify: + +- the SMF requirements regarding the forwarding of the Origination Time Stamp towards the PCF, when received from the AMF; +- the handling of the Origination Time Stamp parameter by the PCF for an incoming request colliding with an existing Individual SM Policy Association. + +##### 5.2.3.3.2 Detection and handling of requests which have timed out at the HTTP client + +###### 5.2.3.3.2.1 General + +The procedure specified in clause 6.11.2 of 3GPP TS 29.500 [4] shall apply with the following additions. + +An HTTP request may include the 3gpp-Sbi-Origination-Timestamp and the 3gpp-Sbi-Max-Rsp-Time headers, with or without the 3gpp-Sbi-Sender-Timestamp header. + +The 3gpp-Sbi-Max-Rsp-Time header shall indicate the duration expressed in milliseconds since the absolute time indicated in the 3gpp-Sbi-Sender-Timestamp header, if this header is present, or indicated in the 3gpp-Sbi-Origination-Timestamp header otherwise. + +NOTE: The AMF does not need to include the 3gpp-Sbi-Sender-Timestamp if it includes the 3gpp-Sbi-Origination-Timestamp. A V-SMF or I-SMF forwards the 3gpp-Sbi-Origination-Timestamp over N16 or N16a, if received, and can include a 3gpp-Sbi-Sender-Timestamp header set to the time when it sends the Create request, in which case the 3gpp-Sbi-Max-Rsp-Time header contains the response time with respect to the 3gpp-Sbi-Sender-Timestamp header. + +### 5.2.3.4 UE Location Information + +When attributes with the UserLocation data type (as defined in clause 5.4.4.7 of 3GPP TS 29.571 [13]) are included in the messages (as specified in clause 6) to report the UE location information to the SMF, the following information shall be included in these attributes: + +- the TAI and NCGI for NR user location; or +- the TAI and ECGI for E-UTRA user location; or +- the TAI, UE local IP address, Port if NAT is detected, and optionally n3Iwid if available, for untrusted non-3GPP access; or +- the TAI and TNAP Id/TWAP Id for trusted non-3GPP access; or +- the TAI and GLI and optionally LineType if available, or the TAI and hfcNodeId, or the TAI and GCI, for wireline network access. + +--- + +## 6 API Definitions + +### 6.1 Nsmf\_PDUSession Service API + +#### 6.1.1 API URI + +The Nsmf\_PDUSession service shall use the Nsmf\_PDUSession API. + +The API URI of the Nsmf\_PDUSession API shall be: + +**{apiRoot}
** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nsmf-pdusession". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +## 6.1.2 Usage of HTTP + +### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [14], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nsmf\_PDUSession service shall comply with the OpenAPI [15] specification contained in Annex A. + +### 6.1.2.2 HTTP standard headers + +#### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +#### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- the JSON format (IETF RFC 8259 [11]). The use of the JSON format shall be signalled by the content type "application/json". See also clause 5.4 of 3GPP TS 29.500 [4]. +- the Problem Details JSON Object (IETF RFC 9457 [23]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +NOTE: "application/json" is used in a response that includes a content containing an application-specific data structure, see clause 4.8 of 3GPP TS 29.501 [5]. + +Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one or two binary body parts with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported. + +**Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| vnd.3gpp.ngap | Binary encoded content, encoding NG Application Protocol (NGAP) IEs, as specified in clause 9.3 of 3GPP TS 38.413 [9] (ASN.1 encoded). | +| vnd.3gpp.5gnas | Binary encoded content, encoding a 5GS NAS message or 5G NAS IEs, as specified in 3GPP TS 24.501 [7]. | +| vnd.3gpp.pfcp | Binary encoded content, encoding a PFCP message, as specified in 3GPP TS 29.244 [29]. (NOTE 2) | +| NOTE 1: Using 3GPP vendor content subtypes allows to describe the nature of the opaque content (e.g. NGAP or 5GS NAS information) without having to rely on metadata in the JSONcontent. | | +| NOTE 2: Binary encoded content in vnd.3gpp.pfcp content subtype shall include application layer headers for PFCP and shall not include transport layer headers, i.e. IP and UDP. | | + +See clause 6.1.2.4 for the binary contents supported in the binary content part of multipart messages. + +### 6.1.2.3 HTTP custom headers + +#### 6.1.2.3.1 General + +For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +Additional HTTP custom headers applicable to the Nsmf\_PDUSession service are specified in the following clauses. + +### 6.1.2.3.2 3gpp-Sbi-Origination-Timestamp + +The header contains the date and time (with a millisecond granularity) when the originating entity initiated the request. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [32]. + +``` +Sbi-Origination-Timestamp-Header = "3gpp-Sbi-Origination-Timestamp:" OWS day-name "," SP date1 SP +time-of-day "." milliseconds SP "GMT" OWS +``` + +``` +milliseconds = 3DIGIT +``` + +day-name, date1, time-of-day shall comply with the definition in clause 7.1.1.1 of IETF RFC 9110 [32]. + +NOTE: This is the same format as the Date header of clause 7.1.1.2 of IETF RFC 9110 [32], but with the time expressed with a millisecond granularity. + +EXAMPLE: 3gpp-Sbi-Origination-Timestamp: Sun, 04 Aug 2019 08:49:37.845 GMT + +### 6.1.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque N1 and/or N2 SM payloads or N4 information, in the following service operations (and HTTP messages): + +- Create SM Context Request and Response (POST); +- Update SM Context Request and Response (POST); +- Release SM Context Request (POST); +- Create Request and Response (POST); +- Update Request and Response (POST (modify)). + +HTTP multipart messages shall include one JSON body part and one or two binary body parts comprising: + +- an N1 SM payload, an N2 SM payload or both, over N11 (see clause 6.1.6.4); +- one or two N1 SM payloads, over N16 (see clause 6.1.6.4); +- one or two N2 SM payloads over N11 (see clause 5.2.2.3.3); +- one, two or three N4 payloads over N16a (see clause 6.1.6.4.5). + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [10]) specifying the media type of the root body part, i.e. "application/json". + +NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [10]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [12]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +Examples of multipart/related messages can be found in Annex B. + +### 6.1.2.5 HTTP/2 request retries + +The principles specified in clause 5.2.8 of 3GPP TS 29.500 [4] shall be applied with the following modifications. + +The NF Service Consumer of Nsmf\_PDUSession service, e.g. the AMF, shall retry the same HTTP request in the following scenarios through a new TCP connection towards an (alternative) service endpoint pertaining to the same NF + +(Service) instance or set if the corresponding procedure triggering the service request allows such retries, e.g. before the timeout of the corresponding N1 or N2 procedure: + +- If the stream for the service request has not been processed in the SMF as specified in clause 5.2.8 of 3GPP TS 29.500 [4]; +- if the request is rejected by a HTTP status code indicating a temporary failure in the SMF, e.g. the status code 429, 500 and 503, as specified in clause 5.2.7 of 3GPP TS 29.500 [4]; +- if the request is timeout (i.e. the NF Service consumer doesn't receive any response after an implementation specific timer expires). + +The NF Service Consumer shall determine an alternative service instance as specified in clause 6.5 of 3GPP TS 23.527 [24], i.e. using Binding Indication if supported/available or the NF (service) set or service persistency info from NF profile. The NF Service Consumer should also consider the Load control Information and the Overload Control Information if available as specified in clauses 6.3 and 6.4 in 3GPP TS 29.500 [4] when reselecting an alternative NF service instance. + +The SMF shall support handling repeated retries successfully. + +NOTE: See clauses 5.2.2.2 and 5.2.2.7 for the handling by the SMF of an HTTP POST request that would have already been processed by the SMF and that would be retried by the NF Service Consumer. + +HTTP conditional requests are not supported by the Nsmf\_PDUSession service in this version of the API. + +## 6.1.3 Resources + +### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 describes the resource URI structure of the Nsmf\_PDUSession API. + +![Resource URI structure of the Nsmf_PDUSession API diagram](e16bfa31d748f4d99ec4ae3d16656926_img.jpg) + +``` +graph TD; Root["//{apiRoot}/nsmf-pdusession/{apiVersion}"] --- smContexts["/sm-contexts"]; Root --- pduSessions["/pdu-sessions"]; smContexts --- smContextRef["/{smContextRef}"]; smContextRef --- modify1["/modify"]; smContextRef --- retrieve1["/retrieve"]; smContextRef --- release1["/release"]; smContextRef --- sendMoData1["/send-mo-data"]; pduSessions --- pduSessionRef["/{pduSessionRef}"]; pduSessionRef --- modify2["/modify"]; pduSessionRef --- release2["/release"]; pduSessionRef --- retrieve2["/retrieve"]; pduSessionRef --- transferMoData["/transfer-mo-data"]; +``` + +The diagram illustrates the hierarchical structure of the Nsmf\_PDUSession API. It starts with a root URI: `//{apiRoot}/nsmf-pdusession/{apiVersion}`. From this root, two main collection resources are accessible: `/sm-contexts` and `/pdu-sessions`. The `/sm-contexts` collection leads to an individual resource `/{smContextRef}`, which supports the operations `/modify`, `/retrieve`, `/release`, and `/send-mo-data`. The `/pdu-sessions` collection leads to an individual resource `/{pduSessionRef}`, which supports the operations `/modify`, `/release`, `/retrieve`, and `/transfer-mo-data`. The individual resource paths and their associated operations are shown in dashed boxes in the original image. + +Resource URI structure of the Nsmf\_PDUSession API diagram + +**Figure 6.1.3.1-1: Resource URI structure of the Nsmf\_PDUSession API** + +NOTE: The sm-contexts and pdu-sessions collection resources can be distributed on different processing instances or hosts. Thus, the authority and/or deployment-specific string of the apiRoot of the created individual sm context and pdu-session resources' URIs can differ from the authority and/or deployment-specific string of the apiRoot of the sm-contexts and pdu-sessions distributed collections' URIs. + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------------|-------------------------------------------------------------------------------|---------------------------------|--------------------------------------| +| SM contexts collection | /sm-contexts | POST | Create SM Context | +| Individual SM context | /sm-contexts/{smContextRef}/retrieve | retrieve (POST) | Retrieve SM Context | +| | /sm-contexts/{smContextRef}/modify | modify (POST) | Update SM Context | +| | /sm-contexts/{smContextRef}/release | release (POST) | Release SM Context | +| | /sm-contexts/{smContextRef}/send-mo-data | send-mo-data (POST) | Send MO Data | +| PDU sessions collection (H-SMF or SMF) | /pdu-sessions | POST | Create | +| Individual PDU session (H-SMF or SMF) | /pdu-sessions/{pduSessionRef}/modify | modify (POST) | Update (initiated by V-SMF or I-SMF) | +| | /pdu-sessions/{pduSessionRef}/release | release (POST) | Release | +| | /pdu-sessions/{pduSessionRef}/retrieve | retrieve (POST) | Retrieve | +| | /pdu-sessions/{pduSessionRef}/transfer-mo-data | transfer-mo-data (POST) | Transfer MO Data | +| Individual PDU session (V-SMF or I-SMF) | {vsmfPduSessionUri}/modify or {ismfPduSessionUri}/modify | modify (POST) | Update (initiated by H-SMF or SMF) | +| | {vsmfPduSessionUri} or {ismfPduSessionUri} | POST | Notify Status | +| | {vsmfPduSessionUri}/transfer-mt-data or {ismfPduSessionUri}/ transfer-mt-data | transfer-mt-data (POST) | Transfer MT Data | + +### 6.1.3.2 Resource: SM contexts collection + +#### 6.1.3.2.1 Description + +This resource represents the collection of the individual SM contexts created in the SMF. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +#### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nsmf-pdusession//sm-contexts + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-------------------| +| apiRoot | string | See clause 6.1.1. | + +### 6.1.3.2.3 Resource Standard Methods + +#### 6.1.3.2.3.1 POST + +This method creates an individual SM context resource in the SMF, or in V-SMF in HR roaming scenarios. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|------------------------------------------------------------| +| SmContextCreate Data | M | 1 | Representation of the SM context to be created in the SMF. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmContextCreated Data | M | 1 | 201 Created | Successful creation of an SM context. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| SmContextCreate Error | M | 1 | 400 Bad Request | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 400 Bad Request | This error shall only be returned by an SCP for errors it originates. As an exception, this error may also be returned by an SMF, with an empty content, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). | +| SmContextCreate Error | M | 1 | 403 Forbidden | The "cause" attribute shall be set to one of the following application error:
- N1_SM_ERROR
- N2_SM_ERROR
- SNSSAI_DENIED
- DNN_DENIED
- PDUTYPE_DENIED
- SSC_DENIED
- SUBSCRIPTION_DENIED
- DNN_NOT_SUPPORTED
- PDUTYPE_NOT_SUPPORTED
- SSC_NOT_SUPPORTED
- HOME_ROUTED_ROAMING_REQUIRED
- OUT_OF_LADN_SERVICE_AREA
- NO_EPS_5GS_CONTINUITY
- INTEGRITY_PROTECTED_MDR_NOT_ACCEPTABLE
- DEFAULT_EPS_BEARER_INACTIVE
- NOT_SUPPORTED_WITH_ISMF
- SERVICE_NOT_AUTHORIZED_BY_NEXT_HOP
- EXCEEDED_UE_SLICE_DATA_RATE
- EXCEEDED_SLICE_DATA_RATE
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This error shall only be returned by an SCP for errors it originates. As an exception, this error may also be returned by an SMF, with an empty content, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). | +| SmContextCreate Error | M | 1 | 404 Not Found | The "cause" attribute shall be set to one of the following application error:
- CONTEXT_NOT_FOUND
See table 6.1.7.3-1 for the description of these errors. | +| ExtProblemDetails | O | 0..1 | 413 Content Too Large | | +| ExtProblemDetails | O | 0..1 | 415 Unsupported Media Type | | +| ExtProblemDetails | O | 0..1 | 429 Too Many Requests | | +| SmContextCreate Error | M | 1 | 500 Internal Server Error | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] or to one of the following application errors:
- INSUFFICIENT_RESOURCES_SLICE
- INSUFFICIENT_RESOURCES_SLICE_DNN
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | This error shall only be returned by an SCP for errors it originates. As an exception, this error may also be returned by an SMF, with an empty content, for a general server error other than those specified for the SMF PDUSession service logic. | + +| | | | | | +|-----------------------|---|------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmContextCreate Error | M | 1 | 503 Service Unavailable | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] or to one of the following application errors:
- DNN_CONGESTION
- S_NSSAI_CONGESTION
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 503 Service Unavailable | This error shall only be returned by an SCP for errors it originates. As an exception, this error may also be returned by an SMF, with an empty content, for a general server error other than those specified for the SMF PDUSession service logic. | +| SmContextCreate Error | M | 1 | 504 Gateway Timeout | The "cause" attribute shall be set to one of the following application error:
- PEER_NOT_RESPONDING
- NETWORK_FAILURE
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 504 Gateway Timeout | This error shall only be returned by an SCP for errors it originates. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-pdusession//sm-contexts/{smContextRef} | + +**Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +#### 6.1.3.2.4 Resource Custom Operations + +None. + +#### 6.1.3.3 Resource: Individual SM context + +##### 6.1.3.3.1 Description + +This resource represents an individual SM context created in the SMF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nsmf-pdusession//sm-contexts/{smContextRef} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|-----------|------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1. | +| smContextRef | string | SM context reference assigned by the SMF during the Create SM Context service operation. | + +### 6.1.3.3.3 Resource Standard Methods + +None. + +### 6.1.3.3.4 Resource Custom Operations + +#### 6.1.3.3.4.1 Overview + +**Table 6.1.3.3.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------------|--------------------|---------------------------------------| +| modify | {resourceUri}/modify | POST | Update SM Context service operation | +| release | {resourceUri}/release | POST | Release SM Context service operation | +| retrieve | {resourceUri}/retrieve | POST | Retrieve SM Context service operation | +| send-mo-data | {resourceUri}/send-mo-data | POST | Send MO Data service operation | + +#### 6.1.3.3.4.2 Operation: modify + +##### 6.1.3.3.4.2.1 Description + +##### 6.1.3.3.4.2.2 Operation Definition + +This custom operation updates an individual SM context resource and/or provide N1 or N2 SM information received from the UE or the AN, for a given PDU session, towards the SMF, or in V-SMF in HR roaming scenario. + +This operation shall support the request data structures specified in table 6.1.3.3.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.2.2-2. + +**Table 6.1.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-----------------------------------------------------------| +| SmContextUpdateData | M | 1 | Representation of the updates to apply to the SM context. | + +**Table 6.1.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmContextUpdatedData | C | 0..1 | 200 OK | Successful update of the SM context, when the SMF needs to return information in the response. | +| n/a | | | 204 No Content | Successful update of the SM context, when the SMF does not need to return information in the response. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| SmContextUpdateError | M | 1 | 400 Bad Request | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 400 Bad Request | This error shall only be returned by an SCP for errors it originates. As an exception, this error may also be returned by an SMF, with an empty content, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). | +| SmContextUpdateError | M | 1 | 403 Forbidden | The "cause" attribute shall be set to one of the following application error:
- N1_SM_ERROR
- N2_SM_ERROR
- SUBSCRIPTION_DENIED
- OUT_OF_LADN_SERVICE_AREA
- PRIORITIZED_SERVICES_ONLY
- PDU_SESSION_ANCHOR_CHANGE
- NO_DATA_FORWARDING
- S_NSSAI_UNAVAILABLE_DUE_TO_NSAC
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This error shall only be returned by an SCP for errors it originates. As an exception, this error may also be returned by an SMF, with an empty content, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). | +| SmContextUpdateError | M | 1 | 404 Not Found | The "cause" attribute shall be set to one of the following application error:
- CONTEXT_NOT_FOUND
See table 6.1.7.3-1 for the description of these errors. | +| ExtProblemDetails | O | 0..1 | 413 Content Too Large | | +| ExtProblemDetails | O | 0..1 | 415 Unsupported Media Type | | +| ExtProblemDetails | O | 0..1 | 429 Too Many Requests | | +| SmContextUpdateError | M | 1 | 500 Internal Server Error | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | This error shall only be returned by an SCP for errors it originates. As an exception, this error may also be returned by an SMF, with an empty content, for a general server error other than those specified for the SMF PDUSession service logic. | +| SmContextUpdateError | M | 1 | 503 Service Unavailable | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] or to one of the following application errors:
- DNN_CONGESTION
- S_NSSAI_CONGESTION
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 503 Service Unavailable | This error shall only be returned by an SCP for errors it originates. As an exception, this error may also be returned by an SMF, with an empty content, for a general server error other than those specified for the SMF PDUSession service logic. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +#### 6.1.3.3.4.3 Operation: release + +##### 6.1.3.3.4.3.1 Description + +##### 6.1.3.3.4.3.2 Operation Definition + +This custom operation releases an individual SM context resource in the SMF, or in V-SMF in HR roaming scenario + +This operation shall support the request data structures specified in table 6.1.3.3.4.3.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.3.2-2. + +**Table 6.1.3.3.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|---------------------------------------------------------------------------------| +| SmContextReleaseData | C | 0..1 | Representation of the data to be sent to the SMF when releasing the SM context. | + +**Table 6.1.3.3.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------| +| SmContextReleasedData | M | 1 | 200 OK | Successful release of an SM context, when information needs to be returned to the NF Service Consumer (NOTE 2). | +| n/a | | | 204 No Content | Successful release of an SM context. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 3) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: The support for 200 OK shall be dependent on the support of the indicated feature. + +NOTE 3: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +#### 6.1.3.3.4.4 Operation: retrieve + +##### 6.1.3.3.4.4.1 Description + +##### 6.1.3.3.4.4.2 Operation Definition + +This custom operation retrieves an individual SM context resource from the SMF, from the V-SMF in HR roaming scenario or from the I-SMF. + +This operation shall support the request data structures specified in table 6.1.3.3.4.4.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.4.2-2. + +**Table 6.1.3.3.4.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| SmContextRetrieveData | O | 0..1 | Optional parameters used to retrieve the SM context, e.g. target MME capabilities, SM context type. | + +**Table 6.1.3.3.4.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmContextRetrievedData | M | 1 | 200 OK | Successful retrieval of the SM context. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | M | 1 | 403 Forbidden | The "cause" attribute shall be set to one of the following application error:
- TARGET_MME_CAPABILITY
- DEFAULT_EBI_NOT_TRANSFERRED
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 504 Gateway Timeout | The "cause" attribute may be set to one of the following application errors:
- UPF_NOT_RESPONDING
See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.4.4.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.4.4.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +#### 6.1.3.3.4.5 Operation: send-mo-data + +##### 6.1.3.3.4.5.1 Description + +##### 6.1.3.3.4.5.2 Operation Definition + +This custom operation enables to send mobile originated data received over NAS, for a given PDU session, towards the SMF, or the V-SMF for HR roaming scenarios, or the I-SMF for a PDU session with an I-SMF. + +This operation shall support the request data structures specified in table 6.1.3.3.4.5.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.5.2-2. + +**Table 6.1.3.3.4.5.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|---------------------------------------------------------| +| SendMoDataReq Data | M | 1 | Representation of the content of a Send MO Data Request | + +**Table 6.1.3.3.4.5.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|----------------------------|---------------------------------| +| n/a | | | 204 No Content | Successful MO data transfer | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ExtProblemDetails | O | 0..1 | 400 Bad Request | | +| ExtProblemDetails | O | 0..1 | 401 Unauthorized | | +| ExtProblemDetails | O | 0..1 | 403 Forbidden | | +| ExtProblemDetails | O | 0..1 | 404 Not Found | | +| ExtProblemDetails | O | 0..1 | 413 Content Too Large | | +| ExtProblemDetails | O | 0..1 | 415 Unsupported Media Type | | +| ExtProblemDetails | O | 0..1 | 429 Too Many Requests | | +| ExtProblemDetails | O | 0..1 | 500 Internal Server Error | | +| ExtProblemDetails | O | 0..1 | 503 Service Unavailable | | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.4.5.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.4.5.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +### 6.1.3.4 Void + +### 6.1.3.5 Resource: PDU sessions collection (H-SMF or SMF) + +#### 6.1.3.5.1 Description + +This resource represents the collection of the individual PDU sessions created in the H-SMF for HR PDU sessions or in the SMF for PDU sessions with an I-SMF. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +#### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nsmf-pdusession//pdu-sessions + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-------------------| +| apiRoot | string | See clause 6.1.1. | + +#### 6.1.3.5.3 Resource Standard Methods + +##### 6.1.3.5.3.1 POST + +This method creates an individual PDU session resource in the H-SMF or SMF. + +This method shall support the URI query parameters specified in table 6.1.3.5.3.1-1. + +**Table 6.1.3.5.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.1-2 and the response data structures and response codes specified in table 6.1.3.5.3.1-3. + +**Table 6.1.3.5.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|----------------------------------------------------------------------| +| PduSessionCreateData | M | 1 | Representation of the PDU session to be created in the H-SMF or SMF. | + +**Table 6.1.3.5.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PduSessionCreatedData | M | 1 | 201 Created | Successful creation of a PDU session. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| PduSessionCreatedError | M | 1 | 400 Bad Request | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 400 Bad Request | This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty content, for a protocol error other than those specified for the SMF PduSession service logic (e.g. protocol error found by the HTTP stack). | +| PduSessionCreatedError | M | 1 | 403 Forbidden | The "cause" attribute shall be set to one of the following application error:
- N1_SM_ERROR
- SNSSAI_DENIED
- DNN_DENIED
- PDUTYPE_DENIED
- SSC_DENIED
- SUBSCRIPTION_DENIED
- DNN_NOT_SUPPORTED
- PDUTYPE_NOT_SUPPORTED
- SSC_NOT_SUPPORTED
- NO_EPS_5GS_CONTINUITY
- INTEGRITY_PROTECTED_MDR_NOT_ACCEPTABLE
- NOT_SUPPORTED_WITH_ISMF
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty content, for a protocol error other than those specified for the SMF PduSession service logic (e.g. protocol error found by the HTTP stack). | +| PduSessionCreatedError | M | 1 | 404 Not Found | The "cause" attribute shall be set to one of the following application error:
- CONTEXT_NOT_FOUND
See table 6.1.7.3-1 for the description of these errors. | +| PduSessionCreatedError | M | 1 | 500 Internal Server Error | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] or to one of the following application errors:
- INSUFFIC_RESOURCES_SLICE
- INSUFFIC_RESOURCES_SLICE_DNN
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty content, for a general server error other than those specified for the SMF PduSession service logic. | +| PduSessionCreatedError | M | 1 | 503 Service Unavailable | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] or to one of the following application errors:
- DNN_CONGESTION
- S-NSSAI_CONGESTION
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 503 Service Unavailable | This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty content, for a general server error other than those specified for the SMF PduSession service logic. | +| PduSessionCreatedError | M | 1 | 504 Gateway Timeout | The "cause" attribute shall be set to one of the following application error:
- PEER_NOT_RESPONDING
- NETWORK_FAILURE
See table 6.1.7.3-1 for the description of these errors. | + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|------|---------------------------|----------------------------------------------------------------------------------| +| ProblemDetails | O | 0..1 | 504
Gateway
Timeout | This error shall only be returned by an SCP or a SEPP for errors they originate. | +| NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | | +| NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. | | | | | + +**Table 6.1.3.5.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-pdusession//pdu-sessions/{pduSessionRef} | + +**Table 6.1.3.5.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.5.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +## 6.1.3.5.4 Resource Custom Operations + +### 6.1.3.5.4.1 Overview + +**Table 6.1.3.5.4.1-1: Custom operations** + +| Custom operation URI | Mapped HTTP method | Description | +|----------------------|--------------------|-------------| +| n/a | | | + +## 6.1.3.6 Resource: Individual PDU session (H-SMF or SMF) + +### 6.1.3.6.1 Description + +This resource represents an individual PDU session created in the H-SMF for a HR PDU session or in the SMF for a PDU session with an I-SMF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +### 6.1.3.6.2 Resource Definition + +Resource URI: {apiRoot}/nsmf-pdusession//pdu-sessions/{pduSessionRef} + +This resource shall support the resource URI variables defined in table 6.1.3.6.2-1. + +**Table 6.1.3.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------------|-----------|-----------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1. | +| pduSessionRef | string | PDU session reference assigned by the H-SMF or SMF during the Create service operation. | + +### 6.1.3.6.3 Resource Standard Methods + +None. + +### 6.1.3.6.4 Resource Custom Operations + +#### 6.1.3.6.4.1 Overview + +**Table 6.1.3.6.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|------------------|---------------------------------|--------------------|------------------------------------| +| modify | {resourceUri}/modify | POST | Update service operation | +| release | {resourceUri}/release | POST | Release service operation | +| transfer-mo-data | {resourceUri}/ transfer-mo-data | POST | Transfer MO Data service operation | +| retrieve | {resourceUri}/retrieve | POST | Retrieve service operation | + +#### 6.1.3.6.4.2 Operation: modify + +##### 6.1.3.6.4.2.1 Description + +##### 6.1.3.6.4.2.2 Operation Definition + +This custom operation updates an individual PDU session resource in the H-SMF or SMF and/or provide the H-SMF or SMF with information received by the V-SMF or I-SMF in N1 SM signalling from the UE. + +This operation shall support the request data structures specified in table 6.1.3.6.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.6.4.2.2-2. + +**Table 6.1.3.6.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|------------------------------------------------------------| +| HsmfUpdateData | M | 1 | Representation of the updates to apply to the PDU session. | + +**Table 6.1.3.6.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| HsmfUpdatedData | C | 0..1 | 200 OK | This case represents a successful update of the PDU session, when the H-SMF or SMF needs to return information in the response. | +| n/a | | | 204 No Content | This case represents a successful update of the PDU session, when the H-SMF or SMF does not need to return information in the response. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| HsmfUpdateError | M | 1 | 400 Bad Request | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 400 Bad Request | This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty content, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). | +| HsmfUpdateError | M | 1 | 403 Forbidden | The "cause" attribute shall be set to one of the following application errors:
- N1_SM_ERROR
- SUBSCRIPTION_DENIED
- PDU_SESSION_ANCHOR_CHANGE
- S_NSSAI_UNAVAILABLE_DUE_TO_NSAC
- INTEGRITY_PROTECTED_MDR_NOT_ACCEPTABLE

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty content, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). | +| HsmfUpdateError | M | 1 | 404 Not Found | The "cause" attribute shall be set to one of the following application error:
- CONTEXT_NOT_FOUND
See table 6.1.7.3-1 for the description of these errors. | +| HsmfUpdateError | M | 1 | 500 Internal Server Error | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty content, for a general server error other than those specified for the SMF PDUSession service logic. | +| HsmfUpdateError | M | 1 | 503 Service Unavailable | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] or to one of the following application errors:
- DNN_CONGESTION
- S_NSSAI_CONGESTION

See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 503 Service Unavailable | This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty content, for a general server error other than those specified for the SMF PDUSession service logic. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table Table 6.1.3.6.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table Table 6.1.3.6.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +#### 6.1.3.6.4.3 Operation: release + +##### 6.1.3.6.4.3.1 Description + +##### 6.1.3.6.4.3.2 Operation Definition + +This custom operation releases an individual PDU session resource in the H-SMF for a HR PDU session or in the SMF for a PDU session with an I-SMF. + +This operation shall support the request data structures specified in table 6.1.3.6.4.3.2-1 and the response data structure and response codes specified in table 6.1.3.6.4.3.2-2. + +**Table 6.1.3.6.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|-------------------------------------------------------------------------------------------| +| ReleaseData | C | 0..1 | Representation of the data to be sent to the H-SMF or SMF when releasing the PDU session. | + +**Table 6.1.3.6.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------| +| ReleasedData | M | 1 | 200 OK | Successful release of a PDU session context, when information needs to be returned to the NF Service Consumer.
(NOTE 2) | +| n/a | | | 204 No Content | Successful release of a PDU session. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 3) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: The support for 200 OK shall be dependent on the support of the indicated feature. + +NOTE 3: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.6.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.6.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +#### 6.1.3.6.4.4 Operation: transfer-mo-data + +##### 6.1.3.6.4.4.1 Description + +##### 6.1.3.6.4.4.2 Operation Definition + +This custom operation enables to transfer mobile originated data received from AMF, for a given PDU session, towards the H-SMF for HR roaming scenarios, or the SMF for a PDU session with an I-SMF. + +This operation shall support the request data structures specified in table 6.1.3.6.4.4.2-1 and the response data structure and response codes specified in table 6.1.3.6.4.4.2-2. + +**Table 6.1.3.6.4.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-------------------------------------------------------------| +| TransferMoDataReqData | M | 1 | Representation of the content of a Transfer MO Data Request | + +**Table 6.1.3.6.4.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | Successful MO data transfer | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.6.4.4.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.6.4.4.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +#### 6.1.3.6.4.5 Operation: retrieve + +##### 6.1.3.6.4.5.1 Description + +##### 6.1.3.6.4.5.2 Operation Definition + +This custom operation retrieves information from an individual PDU session context in the H-SMF for a HR PDU session or in the SMF for a PDU session with an I-SMF. + +This operation shall support the request data structures specified in table 6.1.3.6.4.5.2-1 and the response data structure and response codes specified in table 6.1.3.6.4.5.2-2. + +**Table 6.1.3.6.4.5.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|-----------------------------------------------------| +| RetrieveData | M | 1 | Representation of the content of a Retrieve Request | + +**Table 6.1.3.6.4.5.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RetrievedData | M | 1 | 200 OK | Successful retrieval of information from a PDU session context. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 504
Gateway Timeout | The "cause" attribute may be set to one of the following application errors:
- UPF_NOT_RESPONDING
See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.6.4.5.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.6.4.5.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +## 6.1.3.7 Resource: Individual PDU session (V-SMF or I-SMF) + +### 6.1.3.7.1 Description + +This resource represents an individual PDU session created in the V-SMF for a HR PDU session or in the I-SMF for a PDU session with an I-SMF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +### 6.1.3.7.2 Resource Definition + +Callback URI: {vsmfPduSessionUri} or {ismfPduSessionUri} + +This resource shall support the callback URI variables defined in table 6.1.3.7.2-1. + +**Table 6.1.3.7.2-1: Callback URI variables for this resource** + +| Name | Data type | Definition | +|-------------------|-----------|----------------------------------------------------------------------------------| +| vsmfPduSessionUri | Uri | PDU session reference assigned by the V-SMF during the Create service operation. | +| ismfPduSessionUri | Uri | PDU session reference assigned by the I-SMF during the Create service operation. | + +### 6.1.3.7.3 Resource Standard Methods + +#### 6.1.3.7.3.1 POST + +This method sends a status notification to the NF Service Consumer. + +This method shall support the URI query parameters specified in table 6.1.3.7.3.1-1. + +**Table 6.1.3.7.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.7.3.1-2 and the response data structures and response codes specified in table 6.1.3.7.3.1-3. + +**Table 6.1.3.7.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|--------------------------------------------| +| StatusNotification | M | 1 | Representation of the status notification. | + +**Table 6.1.3.7.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------| +| n/a | | | 204 No Content | Successful notification of status change | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.7.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.7.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +## 6.1.3.7.4 Resource Custom Operations + +### 6.1.3.7.4.1 Overview + +**Table 6.1.3.7.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|------------------|------------------------------------------------------------------------------|--------------------|------------------------------------------------------| +| modify | {vsmfPduSessionUri}/modify or {ismfPduSessionUri}/modify | POST | Update service operation (initiated by H-SMF or SMF) | +| transfer-mt-data | {vsmfPduSessionUri}/transfer-mt-data or {ismfPduSessionUri}/transfer-mt-data | POST | Transfer MT Data service operation | + +#### 6.1.3.7.4.2 Operation: modify + +##### 6.1.3.7.4.2.1 Description + +##### 6.1.3.7.4.2.2 Operation Definition + +This custom operation modifies an individual PDU session resource in the V-SMF for a HR PDU session or in the I-SMF for a PDU session with an I-SMF. + +This operation shall support the request data structures specified in table 6.1.3.7.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.7.4.2.2-2. + +**Table 6.1.3.7.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|------------------------------------------------------------| +| VsmfUpdateData | M | 1 | Representation of the updates to apply to the PDU session. | + +**Table 6.1.3.7.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| VsmfUpdatedData | M | 1 | 200 OK | This case represents a successful update of the PDU session, when the V-SMF or I-SMF needs to return information in the response. | +| n/a | | | 204 No Content | This case represents a successful update of the PDU session, when the V-SMF or I-SMF does not need to return information in the response. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| VsmfUpdateError | M | 1 | 400 Bad Request | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 400 Bad Request | This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty content, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). | +| VsmfUpdateError | M | 1 | 403 Forbidden | The "cause" attribute shall be set to one of the following application errors:
- N1_SM_ERROR
- UNABLE_TO_PAGE_UE
- UE_NOT_RESPONDING
- REJECTED_BY_UE
- REJECTED_DUE_VPLMN_POLICY
- HO_TAU_IN_PROGRESS
- EBI_EXHAUSTED
- EBI_REJECTED_LOCAL_POLICY, if the EBI allocation was rejected due to local policies at the AMF as specified in clause 4.11.1.4.1 of 3GPP TS 23.502 [3].
- EBI_REJECTED_NO_N26, if the EBI allocation was rejected when the AMF is in a serving PLMN that does not support 5GS-EPS interworking procedures with N26 interface as specified in clause 5.17.2.3.1 of 3GPP TS 23.501 [2].
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty content, for a protocol error other than those specified for the SMF PDUSession service logic (e.g. protocol error found by the HTTP stack). | +| VsmfUpdateError | M | 1 | 404 Not Found | The "cause" attribute shall be set to one of the following application error:
- CONTEXT_NOT_FOUND
See table 6.1.7.3-1 for the description of these errors. | +| VsmfUpdateError | O | 0..1 | 409 Conflict | The "cause" attribute may be used to indicate one of the following application errors:
- HIGHER_PRIORITY_REQUEST_ONGOING;
- UE_IN_CM_IDLE_STATE
See table 6.1.7.3-1 for the description of these errors. | +| VsmfUpdateError | M | 1 | 500 Internal Server Error | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty content, for a general server error other than those specified for the SMF PDUSession service logic. | +| VsmfUpdateError | M | 1 | 503 Service Unavailable | The "cause" attribute shall be set to one of the errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | +| ProblemDetails | O | 0..1 | 503 Service Unavailable | This error shall only be returned by an SCP or a SEPP for errors they originate. As an exception, this error may also be returned by an SMF, with an empty content, for a general server error other than those specified for the SMF PDUSession service logic. | +| VsmfUpdateError | M | 1 | 504 | The "cause" attribute shall be set to one of the following | + +| | | | | | +|----------------|---|------|---------------------|-------------------------------------------------------------------------------------------------------------------------------| +| | | | Gateway Timeout | application errors:
- PEER_NOT_RESPONDING
- NETWORK_FAILURE
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 504 Gateway Timeout | This error shall only be returned by an SCP or a SEPP for errors they originate. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.7.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.7.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +#### 6.1.3.7.4.3 Operation: transfer-mt-data + +##### 6.1.3.7.4.3.1 Description + +This custom operation enables to transfer mobile terminated data received from NEF, for a given PDU session, towards the V-SMF for HR roaming scenarios, or the I-SMF for a PDU session with an I-SMF. + +##### 6.1.3.7.4.3.2 Operation Definition + +This operation shall support the request data structures specified in Table 6.1.3.7.4.3.2-1 and the response data structure and response codes specified in Table 6.1.3.7.4.3.2-2. + +**Table 6.1.3.7.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-------------------------------------------------------------| +| TransferMtDataReqData | M | 1 | Representation of the content of a Transfer MT Data Request | + +**Table 6.1.3.7.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful MT data transfer | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| TransferMtDataError | M | 1 | 504 Gateway Timeout | The "cause" attribute may be used to indicate the following application errors:
- UE_NOT_REACHABLE, if the UE is not reachable to deliver the mobile terminated data; Estimated Maximum Waiting Time shall be included if available;

See table 6.1.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.7.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.7.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMF or SMF (service) set. For the case when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target SMF (service) instance ID towards which the request is redirected | + +## 6.1.4 Custom Operations without associated resources + +None. + +## 6.1.5 Notifications + +### 6.1.5.1 General + +This clause specifies the notifications provided by the Nsmf\_PDUSession service. + +The delivery of notifications shall be supported as specified in clause 6.2 of 3GPP TS 29.500 [4] for Server-initiated communication. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------|---------------------------------------------------------------------------|---------------------------------|---------------------------------| +| SM Context Status Notification | {smContextStatusUri}
(NF Service Consumer provided callback reference) | POST | Notify SM Context Status | + +## 6.1.5.2 SM Context Status Notification + +### 6.1.5.2.1 Description + +If the NF Service Consumer (e.g AMF) has provided the callback URI for getting notified about change of SM context status, the SMF shall notify the NF Service Consumer when the SM context status information is updated. + +### 6.1.5.2.2 Notification Definition + +The POST method shall be used for SM context status notification and the URI shall be the callback reference provided by the NF Service Consumer during the subscription to this notification. + +Callback URI: {smContextStatusUri} + +Support of URI query parameters is specified in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.1.5.2.2-2, and support of response data structures and response codes is specified in table 6.1.5.2.2-3. + +**Table 6.1.5.2.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|-------------------------------------------------------| +| SmContextStatus Notification | M | 1 | Representation of the SM context status notification. | + +**Table 6.1.5.2.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Successful notification of the SM context status change | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +**Table 6.1.5.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +## 6.1.6 Data Model + +### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nsmf service-based interface protocol. + +**Table 6.1.6.1-1: Nsmf specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------------|----------------|--------------------------------------------------------------------------| +| SmContextCreateData | 6.1.6.2.2 | Data within Create SM Context Request | +| SmContextCreatedData | 6.1.6.2.3 | Data within Create SM Context Response | +| SmContextUpdateData | 6.1.6.2.4 | Data within Update SM Context Request | +| SmContextUpdatedData | 6.1.6.2.5 | Data within Update SM Context Response | +| SmContextReleaseData | 6.1.6.2.6 | Data within Release SM Context Request | +| SmContextRetrieveData | 6.1.6.2.7 | Data within Retrieve SM Context Request | +| SmContextStatusNotification | 6.1.6.2.8 | Data within Notify SM Context Status Request | +| PduSessionCreateData | 6.1.6.2.9 | Data within Create Request | +| PduSessionCreatedData | 6.1.6.2.10 | Data within Create Response | +| HsmfUpdateData | 6.1.6.2.11 | Data within Update Request towards H-SMF, or from I-SMF to SMF | +| HsmfUpdatedData | 6.1.6.2.12 | Data within Update Response from H-SMF to V-SMF, or from SMF to I-SMF | +| ReleaseData | 6.1.6.2.13 | Data within Release Request | +| HsmfUpdateError | 6.1.6.2.14 | Error within Update Response from H-SMF to V-SMF, or from SMF to I-SMF | +| VsmfUpdateData | 6.1.6.2.15 | Data within Update Request towards V-SMF, or from SMF to I-SMF | +| VsmfUpdatedData | 6.1.6.2.16 | Data within Update Response from V-SMF, or from I-SMF to SMF | +| StatusNotification | 6.1.6.2.17 | Data within Notify Status Request | +| QosFlowItem | 6.1.6.2.18 | Individual QoS flow | +| QosFlowSetupItem | 6.1.6.2.19 | Individual QoS flow to setup | +| QosFlowAddModifyRequestItem | 6.1.6.2.20 | Individual QoS flow requested to be created or modified | +| QosFlowReleaseRequestItem | 6.1.6.2.21 | Individual QoS flow requested to be released | +| QosFlowProfile | 6.1.6.2.22 | QoS flow profile | +| GbrQosFlowInformation | 6.1.6.2.23 | GBR QoS flow information | +| QosFlowNotifyItem | 6.1.6.2.24 | Notification related to a QoS flow | +| SmContextRetrievedData | 6.1.6.2.27 | Data within Retrieve SM Context Response | +| TunnelInfo | 6.1.6.2.28 | Tunnel Information | +| StatusInfo | 6.1.6.2.29 | Status of SM context or of PDU session | +| VsmfUpdateError | 6.1.6.2.30 | Error within Update Response from V-SMF, or from I-SMF to SMF | +| EpsPdnCnxInfo | 6.1.6.2.31 | EPS PDN Connection Information from H-SMF to V-SMF, or from SMF to I-SMF | +| EpsBearerInfo | 6.1.6.2.32 | EPS Bearer Information from H-SMF to V-SMF, or from SMF to I-SMF | +| PduSessionNotifyItem | 6.1.6.2.33 | Notification related to a PDU session | +| EbiArpMapping | 6.1.6.2.34 | EBI to ARP mapping | +| SmContextCreateError | 6.1.6.2.35 | Error within Create SM Context Response | +| SmContextUpdateError | 6.1.6.2.36 | Error within Update SM Context Response | +| PduSessionCreateError | 6.1.6.2.37 | Error within Create Response | +| MmeCapabilities | 6.1.6.2.38 | MME capabilities | +| SmContext | 6.1.6.2.39 | Complete SM Context | +| ExemptionInd | 6.1.6.2.40 | Exemption Indication | +| PsaInformation | 6.1.6.2.41 | PSA Information | +| DnaiInformation | 6.1.6.2.42 | DNAI Information | +| N4Information | 6.1.6.2.43 | N4 Information | +| IndirectDataForwardingTunnelInfo | 6.1.6.2.44 | Indirect Data Forwarding Tunnel Information | +| SmContextReleasedData | 6.1.6.2.45 | Data within Release SM Context Response | +| ReleasedData | 6.1.6.2.46 | Data within Release Response | +| SendMoDataReqData | 6.1.6.2.47 | Data within Send MO Data Request | +| CnAssistedRanPara | 6.1.6.2.48 | SMF derived CN assisted RAN parameters tuning | +| UlcBpInformation | 6.1.6.2.49 | UL CL or BP Information | +| TransferMoDataReqData | 6.1.6.2.50 | Data within Transfer MO Data Request | +| TransferMtDataReqData | 6.1.6.2.51 | Data within Transfer MT Data Request | +| TransferMtDataError | 6.1.6.2.52 | Transfer MT Data Error Response | +| TransferMtDataAddInfo | 6.1.6.2.53 | Transfer MT Data Error Response Additional Information | +| VplmnQos | 6.1.6.2.54 | VPLMN QoS | +| DdnFailureSubs | 6.1.6.2.55 | DDN Failure Subscription | +| RetrieveData | 6.1.6.2.56 | Data within Retrieve Request | +| RetrievedData | 6.1.6.2.57 | Data within Retrieve Response | +| SecurityResult | 6.1.6.2.58 | Security Result | +| UpSecurityInfo | 6.1.6.2.59 | User Plane Security Information | + +| | | | +|--------------------------------|------------|-----------------------------------------------------------------------------------------| +| DdnFailureSubInfo | 6.1.6.2.60 | DDN Failure Subscription Information | +| AlternativeQosProfile | 6.1.6.2.61 | Alternative QoS Profile | +| ProblemDetailsAddInfo | 6.1.6.2.62 | Problem Details Additional Information | +| ExtProblemDetails | 6.1.6.2.63 | Extended Problem Details | +| QosMonitoringInfo | 6.1.6.2.64 | QoS Monitoring Information | +| IpAddress | 6.1.6.2.65 | IP Address | +| RedundantPduSessionInformation | 6.1.6.2.66 | Redundant PDU Session Information | +| QosFlowTunnel | 6.1.6.2.67 | Tunnel Information per QoS Flow | +| TargetDnailInfo | 6.1.6.2.68 | Target DNAI Information | +| AfCoordinationInfo | 6.1.6.2.69 | AF Coordination Information | +| NotificationInfo | 6.1.6.2.70 | Notification Correlation ID and Notification URI provided by the NF service consumer | +| AnchorSmfFeatures | 6.1.6.2.71 | Anchor SMF supported features | +| HrsboInfoFromVplmn | 6.1.6.2.72 | HR-SBO Information signaled from VPLMN | +| HrsboInfoFromHplmn | 6.1.6.2.73 | HR-SBO Information signaled from HPLMN | +| EasInfoToRefresh | 6.1.6.2.74 | EAS information to be refreshed for EAS re-discovery | +| EcnMarkingCongestionInfoReq | 6.1.6.2.75 | ECN Marking or Congestion Information Request | +| EcnMarkingCongestionInfoStatus | 6.1.6.2.76 | ECN Marking or Congestion Information Status | +| TscAssistanceInformation | 6.1.6.2.77 | TSC Assistance Information | +| N6JitterInformation | 6.1.6.2.78 | N6 Jitter Information | +| Teid | 6.1.6.3.2 | GTP Tunnel Endpoint Identifier | +| ProcedureTransactionId | 6.1.6.3.2 | Procedure Transaction Identifier | +| EpsPdnCnxContainer | 6.1.6.3.2 | UE EPS PDN Connection container from SMF to AMF | +| EpsBearerId | 6.1.6.3.2 | EPS Bearer Id | +| EpsBearerContainer | 6.1.6.3.2 | EPS Bearer container from SMF to AMF | +| EpsBearerContextStatus | 6.1.6.3.2 | EPS Bearer context status | +| DrbId | 6.1.6.3.2 | Data Radio Bearer Identifier | +| UpCnxState | 6.1.6.3.3 | User Plane Connection State | +| HoState | 6.1.6.3.4 | Handover State | +| RequestType | 6.1.6.3.5 | Request Type in Create (SM context) service operation. | +| RequestIndication | 6.1.6.3.6 | Request Indication in Update (SM context) service operation. | +| NotificationCause | 6.1.6.3.7 | Cause for generating a notification | +| Cause | 6.1.6.3.8 | Cause information | +| ResourceStatus | 6.1.6.3.9 | Status of SM context or PDU session resource | +| DnnSelectionMode | 6.1.6.3.10 | DNN Selection Mode | +| EpsInterworkingIndication | 6.1.6.3.11 | EPS Interworking Indication | +| N2SmInfoType | 6.1.6.3.12 | N2 SM Information Type | +| MaxIntegrityProtectedDataRate | 6.1.6.3.13 | Maximum Integrity Protected Data Rate | +| MaReleaseIndication | 6.1.6.3.14 | Multi-Access PDU session release Indication | +| SmContextType | 6.1.6.3.15 | Type of SM Context information | +| PsaIndication | 6.1.6.3.16 | Indication of whether a PSA is inserted or removed | +| N4MessageType | 6.1.6.3.17 | N4 Message Type | +| QosFlowAccessType | 6.1.6.3.18 | Access type associated with the QoS Flow | +| UnavailableAccessIndication | 6.1.6.3.19 | Indicates the access type of a MA PDU session that is unavailable | +| ProtectionResult | 6.1.6.3.20 | Protection Result of the security policy indicated as "preferred" | +| QosMonitoringReq | 6.1.6.3.21 | Indicates to measure UL, or DL, or both UL/DL delays, or to stop on-going measurements. | +| Rsn | 6.1.6.3.22 | Redundancy Sequence Number | +| SmfSelectionType | 6.1.6.3.23 | SMF Selection Type | +| PduSessionContextType | 6.1.6.3.24 | PDU Session Context Type | +| PendingUpdateInfo | 6.1.6.3.25 | Pending Update Information | +| EstablishmentRejectionCause | 6.1.6.3.26 | PDU Session Establishment Rejection Cause | +| EcnMarkingReq | 6.1.6.3.27 | ECN Marking Request | +| CongestionInfoReq | 6.1.6.3.28 | Congestion Information Request | +| ActivationStatus | 6.1.6.3.29 | Activation Status | + +Table 6.1.6.1-2 specifies data types re-used by the Nsmf service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nsmf service based interface. + +**Table 6.1.6.1-2: Nsmf re-used Data Types** + +| Data type | Reference | Comments | +|----------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Uint32 | 3GPP TS 29.571 [13] | Unsigned 32-bit integers | +| Ipv4Addr | 3GPP TS 29.571 [13] | IPv4 Address | +| Ipv6Prefix | 3GPP TS 29.571 [13] | IPv6 Prefix | +| Uri | 3GPP TS 29.571 [13] | Uniform Resource Identifier | +| Supi | 3GPP TS 29.571 [13] | Subscription Permanent Identifier | +| Pei | 3GPP TS 29.571 [13] | Permanent Equipment Identifier | +| Gpsi | 3GPP TS 29.571 [13] | General Public Subscription Identifier | +| AccessType | 3GPP TS 29.571 [13] | Access Type (3GPP or non-3GPP access) | +| SupportedFeatures | 3GPP TS 29.571 [13] | Supported features | +| Qfi | 3GPP TS 29.571 [13] | QoS Flow Identifier | +| PduSessionId | 3GPP TS 29.571 [13] | PDU Session Identifier | +| PduSessionType | 3GPP TS 29.571 [13] | PDU Session Type | +| Ambr | 3GPP TS 29.571 [13] | PDU Session Aggregate Maximum Bit Rate | +| 5Qi | 3GPP TS 29.571 [13] | 5G QoS Identifier | +| Arp | 3GPP TS 29.571 [13] | Allocation and Retention Priority | +| ReflectiveQoSAttribute | 3GPP TS 29.571 [13] | Reflective QoS Attribute | +| Dynamic5Qi | 3GPP TS 29.571 [13] | QoS characteristics for a 5Qi that is neither standardized nor pre-configured. | +| NonDynamic5Qi | 3GPP TS 29.571 [13] | QoS characteristics that replace the default QoS characteristics for a standardized or pre-configured 5Qi. | +| PacketLossRate | 3GPP TS 29.571 [13] | Packet Loss Rate | +| NotificationControl | 3GPP TS 29.571 [13] | Notification Control | +| Dnn | 3GPP TS 29.571 [13] | Data Network Name | +| Snsai | 3GPP TS 29.571 [13] | Single Network Slice Selection Assistance Information | +| NfInstanceId | 3GPP TS 29.571 [13] | NF Instance Identifier | +| UserLocation | 3GPP TS 29.571 [13] | User Location | +| TimeZone | 3GPP TS 29.571 [13] | Time Zone | +| ProblemDetails | 3GPP TS 29.571 [13] | Error description | +| UpSecurity | 3GPP TS 29.571 [13] | User Plane Security Policy Enforcement information | +| RefToBinaryData | 3GPP TS 29.571 [13] | Cross-Reference to binary data encoded within a binary body part in an HTTP multipart message. | +| Guami | 3GPP TS 29.571 [13] | Globally Unique AMF ID | +| BackupAmfInfo | 3GPP TS 29.571 [13] | Backup AMF Information | +| PresenceState | 3GPP TS 29.571 [13] | Indicates the UE presence in or out of a LADN service area | +| TraceData | 3GPP TS 29.571 [13] | Trace control and configuration parameters | +| PlmnId | 3GPP TS 29.571 [13] | PLMN Identity | +| RatType | 3GPP TS 29.571 [13] | RAT Type | +| NgApCause | 3GPP TS 29.571 [13] | NGAP Cause | +| 5GMmCause | 3GPP TS 29.571 [13] | 5G MM Cause | +| DurationSec | 3GPP TS 29.571 [13] | Duration in units of seconds | +| AdditionalQosFlowInfo | 3GPP TS 29.571 [13] | Additional QoS Flow Information | +| NfGroupId | 3GPP TS 29.571 [13] | Network Function Group Id | +| SecondaryRatUsageReport | 3GPP TS 29.571 [13] | Secondary RAT Usage Report | +| SecondaryRatUsageInfo | 3GPP TS 29.571 [13] | Secondary RAT Usage Information | +| Dnai | 3GPP TS 29.571 [13] | Data Network Access Identifier | +| PlmnIdNid | 3GPP TS 29.571 [13] | PLMN Identity and, for SNPn, Network Identity | +| SmallDataRateStatus | 3GPP TS 29.571 [13] | Small Data Rate Control Status | +| ApnRateStatus | 3GPP TS 29.571 [13] | APN Rate Control Status | +| StationaryIndication | 3GPP TS 29.571 [13] | Stationary Indication | +| ScheduledCommunicationTime | 3GPP TS 29.571 [13] | Scheduled Communication Time | +| ScheduledCommunicationType | 3GPP TS 29.571 [13] | Scheduled Communication Type | +| TrafficProfile | 3GPP TS 29.571 [13] | Traffic Profile | +| BatteryIndication | 3GPP TS 29.571 [13] | Battery Indication | +| NfSetId | 3GPP TS 29.571 [13] | NF Set Identifier | +| MoExpDataCounter | 3GPP TS 29.571 [13] | MO Exception Data Counter | +| DddTrafficDescriptor | 3GPP TS 29.571 [13] | Traffic Descriptor | +| NfServiceSetId | 3GPP TS 29.571 [13] | NF Service Set ID | +| RedirectResponse | 3GPP TS 29.571 [13] | Response body of the redirect response message | +| ServerAddressingInfo | 3GPP TS 29.571 [13] | Information of a Provisioning Server | +| PcfUeCallbackInfo | 3GPP TS 29.571 [13] | The callback information of the PCF for the UE to allow the PCF for the PDU session to send SM Policy Association Establishment and Termination events notification | +| SatelliteBackhaulCategory | 3GPP TS 29.571 [13] | Satellite backhaul category | + +| | | | +|------------------------|---------------------|--------------------------------------------------------------------------------------------------------| +| Uint16 | 3GPP TS 29.571 [13] | Unsigned 16-bit integer | +| GeoSatelliteId | 3GPP TS 29.571 [13] | GEO satellite ID (string) | +| UInteger | 3GPP TS 29.571 [13] | Unsigned Integer common data type | +| VplmnOffloadingInfo | 3GPP TS 29.571 [13] | VPLMN Specific Offloading Information | +| GroupId | 3GPP TS 29.571 [13] | Internal Group Id | +| OffloadIdentifier | 3GPP TS 29.571 [13] | Offload identifier uniquely identifying a VPLMN offloading policy information instance from the HPLMN. | +| Ipv4AddressRange | 3GPP TS 29.571 [13] | IPv4 address range | +| Ipv6AddressRange | 3GPP TS 29.571 [13] | IPv6 address range | +| Fqdn | 3GPP TS 29.571 [13] | FQDN | +| EasIpReplacementInfo | 3GPP TS 29.571 [13] | EAS IP replacement information | +| PduSetQosPara | 3GPP TS 29.571 [13] | PDU Set QoS Parameters | +| SmfChargingId | 3GPP TS 29.571 [13] | SMF Charging Identifier | +| Int32 | 3GPP TS 29.571 [13] | Signed 32-bit integer | +| EcsAddrConfigInfo | 3GPP TS 29.503 [46] | ECS Address Configuration Information | +| ServiceName | 3GPP TS 29.510 [19] | Service Name | +| WAgfInfo | 3GPP TS 29.510 [19] | Information about N3 terminations at the W-AGF | +| TngfInfo | 3GPP TS 29.510 [19] | Information about N3 terminations at the TNGF | +| TwifInfo | 3GPP TS 29.510 [19] | Information about N3 terminations at the TWIF | +| ChargingInformation | 3GPP TS 29.512 [30] | CHF addresses | +| NgRanTargetId | 3GPP TS 29.518 [20] | NG-RAN Target Id | +| SbiBindingLevel | 3GPP TS 29.518 [20] | SBI Binding Level | +| IpIndex | 3GPP TS 29.519 [38] | Information that identifies which IP pool or external server is used to allocate the IP address. | +| RoamingChargingProfile | 3GPP TS 32.291 [26] | Roaming Charging Profile | + +## 6.1.6.2 Structured data types + +### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.1.6.2.2 Type: SmContextCreateData + +**Table 6.1.6.2.2-1: Definition of type SmContextCreateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|--------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | This IE shall be present, except if the UE is emergency registered and UICless. When present, it shall contain the subscriber permanent identity. | | +| unauthenticatedSupi | boolean | C | 0..1 | This IE shall be present if the SUPI is present in the message but is not authenticated and is for an emergency registered UE. When present, it shall be set as follows:
- true: unauthenticated SUPI;
- false (default): authenticated SUPI. | | +| roamingUeInd | boolean | O | 0..1 | This IE may be present, when the requestType IE indicates that the request refers to an emergency PDU session and the supi IE is present.

When present, this IE shall indicate whether the UE is a roaming UE or not:
- true: the UE is a roaming UE.
- false: the UE is a non-roaming UE. | | +| pei | Pei | C | 0..1 | This IE shall be present if the UE is emergency registered and it is either UICless or the SUPI is not authenticated. For all other cases, this IE shall be present if it is available. When present, it shall contain the permanent equipment identifier. | | +| gpsi | Gpsi | C | 0..1 | This IE shall be present if it is available. When present, it shall contain the user's GPSI. | | +| pduSessionId | PduSessionId | C | 0..1 | This IE shall be present, except during an EPS to 5GS Idle mode mobility or handover using the N26 interface. When present, it shall contain the PDU Session ID. | | +| dnn | Dnn | C | 0..1 | This IE shall be present, except during an EPS to 5GS Idle mode mobility or handover using the N26 interface. When present, it shall contain the requested DNN; the DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. | | +| selectedDnn | Dnn | C | 0..1 | This IE shall be present, if another DNN other than the UE requested DNN is selected for this PDU session. When present, it shall contain the selected DNN. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. | | +| sNssai | Snssai | C | 0..1 | This IE shall be present during the PDU session establishment procedure. In this case, it shall contain the requested S-NSSAI for the serving PLMN. This corresponds to an S-NSSAI from the allowed NSSAI.

This IE shall also be present during an EPS to 5GS idle mode mobility or handover with I-SMF/V-SMF involved using the N26 interface. In this case, it shall contain the S-NSSAI configured in the AMF for EPS interworking. | | +| altSnssai | Snssai | C | 0..1 | This IE shall be present during the PDU session establishment procedure if the NF service consumer | NSRP | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | supports the network slice replacement, and the network slice indicated in the sNssai IE is requested to be replaced. In this case, the NF service consumer shall send the S-NSSAI and the alternative S-NSSAI. See clause 5.15.19 of 3GPP TS 23.501 [2]. | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------|-----------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| hplmnSnssai | Snssai | C | 0..1 | This IE shall be present for a roaming PDU session, except during an EPS to 5GS idle mode mobility or handover using the N26 interface.
When present, it shall contain the requested S-NSSAI for the HPLMN. This corresponds to an S-NSSAI from the Mapping Of Allowed NSSAI corresponding to the SNSSAI value included in the sNssai IE. | | +| altHplmnSnssai | Snssai | C | 0..1 | This IE shall be present for HR PDU session during the PDU session establishment procedure if the NF service consumer supports the network slice replacement, and the network slice indicated in the hplmnSnssai IE is requested to be replaced. In this case, the NF service consumer shall send the HPLMN S-NSSAI and the alternative HPLMN S-NSSAI. See clause 5.15.19 of 3GPP TS 23.501 [2]. | NSRP | +| servingNfId | NfInstanceId | M | 1 | This IE shall contain the identifier of the serving NF (e.g. serving AMF). | | +| guami | Guami | C | 0..1 | This IE shall contain the serving AMF's GUAMI. It shall be included if the NF service consumer is an AMF. | | +| serviceName | ServiceName | O | 0..1 | When present, this IE shall contain the name of the AMF service to which SM context status notifications are to be sent (see clause 6.5.2.2 of 3GPP TS 29.500 [4]). This IE may be included if the NF service consumer is an AMF. | | +| servingNetwork | PlmnIdNid | M | 1 | This IE shall contain the serving core network operator PLMN ID and, for an SNPn, the NID that together with the PLMN ID identifies the SNPn. | | +| requestType | RequestType | C | 0..1 | This IE shall be present if the Request type IE is received from the UE for a single access PDU session and if the request refers to an existing PDU session or an existing emergency PDU session. The requestType IE shall not be included for a MA-PDU session establishment request. It may be present otherwise.
When present, it shall indicate whether the request refers to a new PDU session or emergency PDU session, or to an existing PDU session or emergency PDU session.
For request sent from UE, this IE shall be set based on the Request type IE received (see clause 9.11.3.47 of 3GPP TS 24.501 [7]). | | +| n1SmMsg | RefToBinaryData | C | 0..1 | This IE shall be present and reference the N1 SM Message binary data (see clause 6.1.6.4.2), except during an EPS to 5GS Idle mode mobility or handover using N26. | | +| anType | AccessType | M | 1 | This IE shall indicate the Access Network Type to which the PDU session is to be associated. | | +| additionalAnType | AccessType | C | 0..1 | This IE shall indicate the additional Access Network Type to which the PDU session is to be associated. This IE shall be present if a MA-PDU session is requested and the UE is registered over both 3GPP access and Non-3GPP access. | MAPDU | +| ratType | RatType | C | 0..1 | This IE shall be present and indicate the RAT Type used by the UE, if available. | | +| presenceInLadn | PresenceState | C | 0..1 | This IE shall be present if the DNN corresponds to a LADN. When present, it shall be set to "IN" or "OUT" to indicate that the UE is in or out of the LADN service area. | | +| perLadnDnnSnssaiInd | boolean | C | 0..1 | This IE shall be present, if the AMF enforces the LADN Service Area per LADN DNN and S-NSSAI (see clause 4.3.2.2.1 of 3GPP TS 23.502 [3]).
When present, it shall indicate that the PDU Session is subject to LADN per LADN DNN and S-NSSAI and be set as follows:
- True: the PDU Session is subject to LADN per | | + +| | | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------|--| +| | | | | LADN DNN and S-NSSAI.
- False (default): the PDU Session is not subject to LADN per LADN DNN and S-NSSAI. | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------------|---------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| ueLocation | UserLocation | C | 0..1 | This IE shall contain the UE location information (see clause 5.2.3.4), if it is available. (NOTE 1). | | +| ueTimeZone | TimeZone | C | 0..1 | This IE shall contain the UE Time Zone, if it is available. | | +| addUeLocation | UserLocation | O | 0..1 | Additional UE location.
This IE may be present, if anType indicates a non-3GPP access and valid 3GPP access user location information is available.
When present, it shall contain:
  • - the last known 3GPP access user location (see clause 5.2.3.4); and
  • - the timestamp, if available, indicating the UTC time when the addUeLocation information was acquired.
(NOTE 1) | | +| smContextStatusUri | Uri | M | 1 | This IE shall include the callback URI to receive notification of SM context status. | | +| hSmfUri | Uri | C | 0..1 | This IE shall be present in HR roaming scenarios, including Indirect Communication with Delegated Discovery, if the AMF and V-SMF do not support the ACSCR feature.
This IE shall be present in HR roaming scenarios during a PDU session establishment procedure and EPS to 5GS mobility procedures, if the AMF and V-SMF support the ACSCR feature. When present, it shall contain the API URI of the Nsmf_PDUSession service of the selected H-SMF. The API URI shall be formatted as specified in clause 6.1.1. (NOTE 8) | | +| hSmfId | NfInstanceId | O | 0..1 | This IE may be present when hSmfUri is present.

If present, this IE shall carry the NF instance ID of the selected H-SMF. (NOTE 2) | | +| smfUri | Uri | C | 0..1 | This IE shall be present for a PDU session with an I-SMF, including Indirect Communication with Delegated Discovery, if the AMF and I-SMF do not support the ACSCR feature.
This IE shall be present for a PDU session with an I-SMF during a PDU session establishment procedure and EPS to 5GS mobility procedures, if the AMF and I-SMF support the ACSCR feature.
When present, it shall contain the API URI of the Nsmf_PDUSession service of the selected SMF. The API URI shall be formatted as specified in clause 6.1.1. (NOTE 8) | DTSSA | +| smfId | NfInstanceId | O | 0..1 | This IE may be present when smfUri is present.

If present, this IE shall carry the NF instance ID of the selected SMF. (NOTE 2) | DTSSA | +| oldPduSessionId | PduSessionId | C | 0..1 | This IE shall be present if this information is received from the UE.
When present, it shall contain the old PDU Session ID received from the UE. See clauses 4.3.2.2.1 and 4.3.5.2 of 3GPP TS 23.502 [3]. | | +| pduSessionsActivateList | array(PduSessionId) | C | 1..N | This IE shall be present, during an EPS to 5GS Idle mode mobility using the N26 interface, if the UE indicated PDU session(s) to be activated in the Registration Request.
When present, it shall indicate all the PDU session(s) requested to be re-activated by the UE. | | +| ueEpsPdnConnection | EpsPdnCnxContainer | C | 0..1 | This IE shall be present, during an EPS to 5GS Idle mode mobility or handover using the N26 interface. When present, it shall contain an MME/SGSN UE EPS PDN connection including the EPS bearer context(s). | | + +| | | | | | | +|-------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| hoState | HoState | C | 0..1 | This IE shall be present during an EPS to 5GS handover using N26 interface or during a N2 handover with I-SMF insertion/change/removal procedure, to request the preparation of a handover of the PDU session.
When present, it shall be set as specified in clauses 5.2.2.2.3 or 5.2.2.2.5. | | +| additionalHsmfUri | array(Uri) | O | 1..N | This IE may be present in HR roaming scenarios. When present, it shall contain an array of API URI of the Nsmf_PDUSession service of the additional H-SMFs discovered by the AMF for the given DNN, hplmnSnssai and for this PDU session. If provided, the V-SMF shall use these additional H-SMF(s) if the V-SMF is not able to receive any response from the H-SMF identified by hSmfUri.

The API URI shall be formatted as specified in clause 6.1.1. | | +| additionalHsmfId | array(NfInstanceId) | O | 1..N | This IE may be present when additionalHsmfUri is present.

If present, this IE shall carry the NF instance ID(s) of H-SMF(s) as stated in additionalHsmfUri IE, in exactly the same order. (NOTE 2) | | +| additionalSmfUri | array(Uri) | O | 1..N | This IE may be present for a PDU session with an I-SMF. When present, it shall contain an array of API URI of the Nsmf_PDUSession service of the additional SMFs discovered by the AMF for the given DNN, Snssai and for this PDU session. If provided, the I-SMF shall use these additional SMF(s) if the I-SMF is not able to receive any response from the SMF identified by smfUri.

The API URI shall be formatted as specified in clause 6.1.1. | DTSSA | +| additionalSmfId | array(NfInstanceId) | O | 1..N | This IE may be present when additionalSmfUri is present.

If present, this IE shall carry the NF instance ID(s) of SMF(s) as stated in additionalSmfUri IE, in exactly the same order. (NOTE 2) | DTSSA | +| pcfId | NfInstanceId | O | 0..1 | When present, this IE shall contain the identifier of:
  • - the H-PCF selected by the AMF (for UE Policy), for a HR PDU session; or
  • - the V-PCF selected by the AMF (for Access and Mobility Policy), for a PDU session in LBO roaming scenarios; or
  • - the PCF selected by the AMF (for Access and Mobility Policy and/or UE Policy), for a PDU session in non-roaming scenarios.
| | +| pcfGroupId | NfGroupId | O | 0..1 | This IE may be present in non-roaming and HR roaming scenarios. When present, this IE shall contain the identity of the (home) PCF group serving the UE for Access and Mobility Policy and/or UE Policy. | | +| pcfSetId | NfSetId | O | 0..1 | This IE may be present if pcfId IE is present.

When present, this IE shall contain the NF Set ID of the PCF indicated by the pcfId IE. | | +| nrfUri | Uri | O | 0..1 | This IE may be present to indicate the NRF to use for PCF selection within the same network slice instance. When present, the SMF shall use the NRF URI to select the PCF. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +| | | | | | | +|------------------------|---------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| selMode | DnnSelectionMode | C | 0..1 | This IE shall be present if it is available. When present, it shall be set to:
  • - "VERIFIED", if the requested DNN provided by UE or the selected DNN provided by the network corresponds to an explicitly subscribed DNN; or
  • - "UE_DNN_NOT_VERIFIED", if the requested DNN provided by UE corresponds to the usage of a wildcard subscription; or
  • - "NW_DNN_NOT_VERIFIED", if the selected DNN provided by the network corresponds to the usage of a wildcard subscription.
If both the requested DNN (i.e. dnn IE) and selected DNN (i.e. selected Dnn IE) are present, the selMode shall be related to the selected DNN. | | +| backupAmfInfo | array(BackupAmfInfo) | C | 1..N | This IE shall be included if the NF service consumer is an AMF and the AMF supports the AMF management without UDSF for the following cases:
  • - First interaction with SMF.
- Modification of the BackupAmfInfo. | | +| traceData | TraceData | C | 0..1 | This IE shall be included if trace is required to be activated (see 3GPP TS 32.422 [22]). | | +| udmGroupId | NfGroupId | O | 0..1 | When present, it shall indicate the identity of the UDM group serving the UE. | | +| routingIndicator | string | O | 0..1 | When present, it shall indicate the Routing Indicator of the UE. | | +| hNwPubKeyId | integer | O | 0..1 | When present, it shall indicate the Home Network Public Key Identifier of the UE. (NOTE 3) | | +| epsInterworkingInd | EpsInterworkingIndication | O | 0..1 | The AMF may provide the indication when a PGW-C+SMF is selected to serve the PDU Session.

When present, this IE shall indicate whether the PDU session may possibly be moved to EPS and whether N26 interface to be used during EPS interworking procedures.

The AMF may derive the value of the indication from different sources, like UE 5GMM capabilities (e.g. "S1 mode supported"), UE subscription data (e.g. "Core Network Type Restriction to EPC" and "Interworking with EPS Indication" for the DNN) and configurations. | | +| indirectForwardingFlag | boolean | C | 0..1 | The AMF shall include this indication during N26 based Handover procedure from EPS to 5GS (see 3GPP TS 23.502 [3], clause 4.11.1.2.2), to inform the SMF of the applicability or non-applicability of indirect data forwarding.
When present, it shall be set as follows:
  • - True: indirect data forwarding is applicable
  • - False: indirect data forwarding is not applicable
| | +| directForwardingFlag | boolean | C | 0..1 | The AMF shall include this indication during N26 based Handover procedure from EPS to 5GS (see 3GPP TS 23.502 [3], clause 4.11.1.2.2), to inform the SMF of the applicability or non-applicability of direct data forwarding.
When present, it shall be set as follows:
  • - True: direct data forwarding is applicable
  • - False: direct data forwarding is not applicable
| | +| targetId | NgRanTargetId | C | 0..1 | This IE shall be present in the following cases:
  • - during an EPS to 5GS handover preparation using the N26 interface, when the hoState IE is
| | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

set to the value "PREPARING";

  • - during N2 based handover procedure with I-SMF or V-SMF insertion/change/removal, when hostate IE is set to the value "PREPARING".

When present, it shall contain the Target ID identifying the target RAN Node ID and TAI. In case of EPS to 5GS handover, the TAI is received in the Forward Relocation Request from the Source MME.

| | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------------|------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| epsBearerCtxStatus | EpsBearerContextStatus | C | 0..1 | This IE shall be present during an EPS to 5GS idle mode mobility using the N26 interface, if received in the Registration Request from the UE. When present, it shall be set to the value received from the UE. | | +| cpCiotEnabled | boolean | C | 0..1 | This IE shall be present with the value "True", if
  • - the NF service consumer (e.g. the AMF) has verified that the CIOT feature is supported by the SMF (and for a home-routed session, that it is also supported by the H-SMF); and
  • - Control Plane CIoT 5GS Optimisation is enabled for the PDU session
(see 3GPP TS 23.502 [3], clauses 4.3.2.2.1 and 4.3.2.2.2).
When present, it shall be set as follows:
  • - True: Control Plane CIoT 5GS Optimisation is enabled.
  • - False (default): Control Plane CIoT 5GS Optimisation is not enabled.
| CIOT | +| cpOnlyInd | boolean | C | 0..1 | This IE shall be present with the value "True", if the PDU session shall only use Control Plane CIoT 5GS Optimisation (see clause 5.31.4.1 of 3GPP TS 23.501 [2]).
When present, it shall be set as follows:
  • - True: the PDU session shall only use Control Plane CIoT 5GS Optimisation
  • - False (default): the PDU session is not constrained to only use Control Plane CIoT 5GS Optimisation.
| CIOT | +| invokeNef | boolean | C | 0..1 | This IE shall be present with the value "True", if Control Plane CIoT 5GS Optimisation is enabled and data delivery via NEF is selected for the PDU session (see 3GPP TS 23.502 [3], clause 4.3.2.2.2).
When present, it shall be set as follows:
  • - True: Data delivery via NEF is selected.
  • - False (default): Data delivery via NEF is not selected.
| CIOT | +| maRequestInd | boolean | C | 0..1 | This IE shall be present if a MA-PDU session is requested to be established. When present, it shall be set as follows:
  • - True: a MA-PDU session is requested
  • - False (default): a MA-PDU session is not requested
| MAPDU | +| maNwUpgradeInd | boolean | C | 0..1 | This IE shall only be present if the PDU session is allowed to be upgraded to MA PDU session (see clause 4.22.3 of 3GPP TS 23.502 [3]).
When present, it shall be set as follows:
  • - True: the PDU session is allowed to be upgraded to MA PDU session
  • - False (default): the PDU session is not allowed to be upgraded to MA PDU session
When maRequestInd is present and set to "true", this IE shall not be present. | MAPDU | +| n3gPathSwitchSupportInd | boolean | C | 0..1 | This IE shall be present if AMF supports non-3GPP access path switching while maintaining two N2 connections for non-3GPP access, the selected SMF supports non-3GPP path switching and if the UE supports non-3GPP access path switching for a MA-PDU session. When present, it shall be set as follows: | N3GPS | + +| | | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |
  • - true: non-3GPP access path switching is supported
  • - false (default): non-3GPP access path switching is not supported
| | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|--------------------------|-----------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| n2SmInfo | RefToBinaryData | C | 0..1 | This IE shall be present if N2 SM Information needs to be sent to the I-SMF. | DTSSA | +| n2SmInfoType | N2SmInfoType | C | 0..1 | This IE shall be present if "n2SmInfo" attribute is present.
When present, this IE shall indicate the NG AP IE type for the NG AP SMF related IE container carried in "n2SmInfo" attribute. | DTSSA | +| n2SmInfoExt1 | RefToBinaryData | C | 0..1 | This IE shall be present if more than one N2 SM Information has been received from the AN.
When present, this IE shall reference the N2 SM Information binary data (see clause 6.1.6.4.3). | DTSSA | +| n2SmInfoTypeExt1 | N2SmInfoType | C | 0..1 | This IE shall be present if "n2SmInfoExt1" attribute is present.
When present, this IE shall indicate the NG AP IE type for the NG AP SMF related IE container carried in "n2SmInfoExt1" attribute. | DTSSA | +| smContextRef | Uri | C | 0..1 | This IE shall be present during an I-SMF or V-SMF insertion if available and during an I-SMF or V-SMF change or removal.
When present, this IE shall contain the URI of the SM Context resource in the SMF or of the SM context resource in the source I-SMF or V-SMF during an I-SMF or V-SMF insertion or during an I-SMF or V-SMF change/removal respectively. The URI shall be an absolute URI, including apiRoot (see clause 6.1.3.3.2).
(NOTE 6) | DTSSA | +| smContextSmfPlmnId | PlmnIdNid | C | 0..1 | This IE shall be present during an inter-PLMN mobility procedure if the smContextRef IE is present. It may be present otherwise, if the smContextRef IE is present.

When present, this IE shall carry the PLMN ID of the SMF which hosts the SM Context resource identified by smContextRef IE. For an SNPN, the NID together with the PLMN ID shall identify the SNPN.
(NOTE 7) | DTSSA | +| smContextSmfId | NfInstanceId | O | 0..1 | This IE may be present if smContextRef is present.

When present, this IE shall carry the NF instance ID of the SMF which hosts the SM Context resource identified by smContextRef IE. (NOTE 2) | DTSSA | +| smContextSmfSetId | NfSetId | C | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the NF Set ID of the old V-SMF or the old I-SMF or the SMF as identified by the smContextSmfId. | DTSSA | +| smContextSmfServiceSetId | NfServiceSetId | C | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the NF Service Set ID of the PDUSession service instance (for this SmContext) in the old V-SMF or the old I-SMF or the SMF. | DTSSA | +| smContextSmfBinding | SbiBindingLevel | C | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the SBI binding level of the SM context resource. | DTSSA | +| upCnxState | UpCnxState | C | 0..1 | This IE shall be present to request the activation of the user plane connection of the PDU session, in the following cases:
- during Service Request procedure with an I-SMF insertion / change / removal, or with a V-SMF change (see clause 5.2.2.2.6);
- during Registration procedure with an I-SMF insertion / change / removal, or with a V-SMF insertion / change / removal (see clause 5.2.2.2.7), | DTSSA | + +| | | | | | | +|--|--|--|--|-------------------------------------------------------------|--| +| | | | | if this PDU session is requested to be activated by the UE. | | +|--|--|--|--|-------------------------------------------------------------|--| + +| | | | | | | +|-----------------------|---------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| smallDataRateStatus | SmallDataRateStatus | C | 0..1 | This IE shall be present if the small data rate control status is available in AMF, see clause 5.31.14.3 of 3GPP TS 23.501 [2] and clause 4.3.2.2.1 of 3GPP TS 23.502 [3]. | CIOT | +| apnRateStatus | ApnRateStatus | C | 0..1 | This IE shall be present if the APN rate control status is available in AMF, see clause 4.7.7.3 in 3GPP TS 23.401 [33] and clause 5.2.8.2.5 in 3GPP TS 23.502 [3]. | CIOT | +| extendedNasSmTimerInd | boolean | C | 0..1 | This IE shall be present with the value "True" if the UE supports CE mode B and use of CE mode B is not restricted according to the Enhanced Coverage Restriction information in the UE context in the AMF.

When present, it shall indicate whether extended NAS SM timers shall be used for the UE as specified in 3GPP TS 24.501 [7], as follows:
- True: extended NAS SM timers shall be used
- False (default): normal NAS SM timers shall be used. | CIOT | +| dlDataWaitingInd | boolean | C | 0..1 | This IE shall be present during an EPS to 5GS Idle mode mobility using N26 interface with data forwarding (see clause 4.11.1.3.3A of 3GPP TS 23.502 [3]), if the same indication is received from the MME in the Context Response message.

When present, it shall be set as follows:
- true: DL data needs to be sent to the UE;

- false (default): no DL data needs to be sent to the UE. | CIOT | +| ddnFailureSubs | DdnFailureSubs | C | 0..1 | This IE shall be present to subscribe the notification of the DDN Failure if the Availability after DDN failure event is subscribed by the UDM, see clause 4.15.3.2.7 of 3GPP TS 23.502 [3]. | CIOT | +| smfTransferInd | boolean | C | 0..1 | This IE shall be present during an SMF Context Transfer procedure, LBO or no Roaming, no I-SMF. When present, it shall be set as follows:
- True: SMF Context Transfer
- False (default): Not an SMF Context Transfer | CTXTR | +| oldSmfId | NfInstanceId | C | 0..1 | This IE shall be present if smfTransferInd is set to true.
When present, it shall indicate old SMF instance identifier. | CTXTR | +| oldSmContextRef | Uri | C | 0..1 | This IE shall be present if smfTransferInd is set to true.
When present, this IE shall contain the identifier of the SM Context resource in the old SMF.

This IE shall also be present, without smfTransferInd set, if this information was received earlier in Notify SM Context Status, see clause 4.3.5.2 of 3GPP TS 23.502 [3]. | CTXTR

EnEDGE | +| wAgfInfo | WAgfInfo | C | 0..1 | This IE shall be present, if received from the W-AGF. When present, it shall contain information about the N3 terminations of the W-AGF. The SMF may use this information when selecting the UPF. | | +| tngfInfo | tngfInfo | C | 0..1 | This IE shall be present, if received from the TNGF. When present, it shall contain information about the N3 terminations of the TNGF. The SMF may use this information when selecting the UPF. | | +| twifInfo | twifInfo | C | 0..1 | This IE shall be present, if received from the TWIF. When present, it shall contain information about the N3 terminations of the TWIF. The SMF may use this information when selecting the UPF. | | +| ranUnchangedInd | boolean | C | 0..1 | This IE shall be present if the NG-RAN is not | DTSSA | + +| | | | | | +|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | |

changed in case of I-SMF/V-SMF change or insertion during CM-CONNECTED registration procedure after EPS to 5GS handover (see clause 5.2.2.2.7) or I-SMF/V-SMF selection per DNAI (see clause 5.2.2.2.12).

When present, it shall be set as follows:

  • - true: NG-RAN is not changed;
  • - false: NG-RAN is changed.
| | +|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------|--------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| samePcfSelectionInd | boolean | C | 0..1 | This IE shall be present, if the AMF received the PCF Selection Assistance info from the UDM indicating that the same PCF is required. (NOTE 4)

When present, it shall be set as follows:
- True: the SMF is indicated to select the same PCF instance for the PDU session.
- False (default): the SMF is not indicated to select the same PCF instance for the PDU session. | | +| targetDnai | Dnai | C | 0..1 | This IE shall be present, if this information was received earlier in Notify SM Context Status. I-SMF or SMF shall use this information for I-UPF / L-PSA / PSA selection, see clauses 4.3.5.1, 4.3.5.2 or 4.23.5.4 of 3GPP TS 23.502 [3]. V-SMF shall use this information for V-UPF selection, see clause 6.7.3.2 of 3GPP TS 23.548 [74]. | EnEDGE

HR-SBO | +| nrfManagementUri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the NFManagement Service (see clause 6.1.1 of 3GPP TS 29.510 [19]) of the NRF or hNRF.

It shall be present during the PDU session establishment procedure with an I-SMF/V-SMF or mobility procedure with I-SMF/V-SMF insertion/change, if it is returned from the NSSF or hNSSF (see clause 6.1.6.2.7 of 3GPP TS 29.531 [40]). | | +| nrfDiscoveryUri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the NFDiscovery Service (see clause 6.2.1 of 3GPP TS 29.510 [19]) of the NRF or hNRF.

It shall be present during the PDU session establishment procedure with an I-SMF/V-SMF or mobility procedure with I-SMF/V-SMF insertion/change, if it is returned from the NSSF or hNSSF (see clause 6.1.6.2.7 of 3GPP TS 29.531 [40]). | | +| nrfAccessTokenUri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the Access Token Service (see clause 6.3.2 of 3GPP TS 29.510 [19]) of the NRF or hNRF.

It shall be present during the PDU session establishment procedure with an I-SMF/V-SMF or mobility procedure with I-SMF/V-SMF insertion/change, if it is returned from the NSSF or hNSSF (see clause 6.1.6.2.7 of 3GPP TS 29.531 [40]). | | +| nrfOauth2Required | map(boolean) | C | 1..N | This IE should be present if the nrfUri IE, nrfManagementUri IE or nrfDiscoveryUri IE is present and if the information is available.

When present, this IE shall indicate whether the NRF requires Oauth2-based authorization for accessing its services. The key of the map shall be the name of an NRF service, e.g. "nnrf-nfm" or "nnrf-disc".

The value of each entry of the map shall be encoded as follows:
- true: OAuth2 based authorization is required.

- false: OAuth2 based authorization is not required.

The absence of this IE means that no indication is available about the usage of Oauth2 for authorization of NRF services. | | +| smfBindingInfo | string | C | 0..1 | This IE shall be present, if available. | DTSSA | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | When present, this IE shall contain the Binding indications of the SM context resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|----------------------|-----------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| pvsInfo | array(ServerAddressingInfo) | C | 1..N | This IE shall be present, if the AMF received this information from AUSF during User Plane Remote Provisioning of UEs procedure (see clause 5.30.2.10.4 of 3GPP TS 23.501 [40]).

When present, this IE shall contain the remote Provisioning Server(s) information. | ENPN | +| onboardingInd | boolean | C | 0..1 | This IE shall be present, if the UE is registered for onboarding in an SNPN (see clause 5.30.2.10.4 in 3GPP TS 23.501 [40] and clause 4.2.2.2.4 in 3GPP TS 23.502 [3]).

  • - false (default): The UE is not registered in an SNPN for the purpose of onboarding;
  • - true: The UE has registered in the SNPN for the purpose of onboarding.
| ENPN | +| oldPduSessionRef | Uri | C | 0..1 | This IE shall be present if this information was received earlier in Notify SM Context Status, see clause 4.3.5.2 of 3GPP TS 23.502 [3].

When present, this IE shall contain the URI of the PDU session resource in the old SMF. The URI shall be an absolute URI, including apiRoot (see clause 6.1.3.6.2). | EnEDGE | +| smPolicyNotifyInd | boolean | O | 0..1 | When present, this IE shall indicate whether the SM Policy Association Establishment and Termination events shall be reported for the PDU session by the PCF for the SM Policy to the PCF for the UE:

  • - true: SM Policy Association Establishment and Termination events shall be reported
  • - false (default): SM Policy Association Establishment and Termination events is not required
(NOTE 5) | SPAE | +| pcfUeCallbackInfo | PcfUeCallbackInfo | C | 0..1 | This IE shall be present when the smPolicyNotifyInd IE is present with value true.

When present, this IE shall contain the callback information of the PCF for the UE to receive SM Policy Association Establishment and Termination events notification from the PCF for the SM Policy. (NOTE 5) | SPAE | +| satelliteBackhaulCat | SatelliteBackhaulCategory | O | 0..1 | This IE may be present if the AMF supports the 5GSAT feature and the AMF is aware that there is a satellite backhaul towards the 5G AN serving the UE. When present, this IE shall indicate the category of the satellite backhaul used towards the 5G AN serving the UE. | 5GSAT | +| upipSupported | boolean | C | 0..1 | This IE shall be present during the PDU session establishment procedure, if the UE supports User Plane Integrity Protection with EPS and if the AMF supports the related functionality. It may be present otherwise. When present, this IE shall be set as follows:

  • - true: User Plane Integrity Protection with EPS is supported;
  • - false (default): User Plane Integrity Protection with EPS is not supported.
| UPIPE | +| disasterRoamingInd | boolean | O | 0..1 | This IE may be set when the UE is registered for Disaster Roaming service. When present, this IE shall be set as follows: | | + +| | | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |
  • - true: the UE is registered for Disaster Roaming service
  • - false (default): the UE is not registered for Disaster Roaming service
| | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| anchorSmfOAuth2Required | boolean | O | 0..1 |

When present, this IE shall indicate whether the H-SMF or SMF for a PDU session with an I-SMF requires OAuth2-based authorization for accessing its Nsmf_PDUSession service.

- true: OAuth2 based authorization is required.
- false: OAuth2 based authorization is not required.

The absence of this IE means that no indication is available about the usage of OAuth2 for authorization of the anchor SMF's Nsmf_PDUSession service. (NOTE 2)

| | +| smContextSmfOAuth2Required | boolean | O | 0..1 |

This IE may be present during an I-SMF insertion, change or removal. This IE may be present when V-SMF changes within the same PLMN.

When present, this IE shall indicate whether the SMF hosting the SM Context requires OAuth2-based authorization for accessing its Nsmf_PDUSession service.

- true: OAuth2 based authorization is required.
- false: OAuth2 based authorization is not required.

The absence of this IE means that no indication is available about the usage of OAuth2 for authorization of the Nsmf_PDUSession service on the SMF hosting the SM Context. (NOTE 2)

| | +| geoSatelliteId | GeoSatelliteId | O | 0..1 |

The AMF may include this IE during a PDU Session Establishment procedure (see clause 4.3.2.2.1 of 3GPP TS 23.502 [3]).

When present, this IE shall contain a GEO satellite ID.

| 5GSATB | +| hrsboAllowedInd | boolean | O | 0..1 |

This IE may be present in HR roaming scenarios. When present, this IE shall indicate whether Session Breakout for HR Session in VPLMN is allowed:

- true: Allowed.
- false (default): Not allowed.

| HR-SBO | +| estabRejectionInd | boolean | O | 0..1 |

This IE may be present with the value true if the AMF has determined that the PDU Session Establishment shall be rejected, e.g. according to the ODB configuration of the UE retrieved from the UDM.

Presence of this IE with the value false shall be prohibited.

| PSER | +| estabRejectionCause | EstablishmentRejectionCause | C | 0..1 |

This IE shall be included if the estabRejectionInd is present with the value true.

When present, this IE shall indicate the cause of the PDU session establishment rejection.

| PSER | +|

NOTE 1: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator.
In shared networks, when the AMF and SMF pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI or NCGI to the SMF. The Core Network Operator PLMN ID shall be communicated in the TAI and the Serving Network.

| | | | | | +|

NOTE 2: If the SMF is aware that OAuth is enabled for the indicated next hop SMF, e.g. when the anchorSmfOAuth2Required IE and/or the smContextSmfOAuth2Required IE are received with the value true or when received a "401 Unauthorized" response code from next hop SMF, the SMF shall use the NF instance Identifier to acquire the access token for the Nsmf_PduSession service on the indicated SMF.

| | | | | | +|

NOTE 3: If present, this attribute shall be used together with routingIndicator. This attribute is only used by the HPLMN in roaming scenarios.

| | | | | | +|

NOTE 4: If present, this attribute shall be used together with the PCF ID received from the AMF for selecting the same PCF instance for the PDU session.

| | | | | | +|

NOTE 5: If the AMF has received the callback information of the PCF for the UE together with the information of the PDU

| | | | | | + +sessions (i.e. Slice and DNN combination) that are applicable for notification of SM Policy Association events, the AMF shall identify whether the non-roaming or local breakout PDU session to be created is applicable for SM Policy Association events, i.e, whether the slice and DNN combination of the PDU session is listed in the received PDU session information from the PCF for the UE. If the PDU session is applicable for notification of SM Policy Association events, the AMF shall include the smPolicyNotifyInd IE with the value "true" and the callback information of the PCF for the UE in the request. The SMF shall forward the callback information of the PCF for the UE to the PCF for SM Policy during SM Policy Association Establishment. See clause 4.3.2.2.1 of 3GPP TS 23.502 [3]. + +NOTE 6: See NOTE 2 of Table 6.1.6.2.3-1. + +NOTE 7: If the PLMN ID of the SMF holding the SM context received in smContextSmfPlmnId attribute is different from the PLMN ID of the target V-SMF/I-SMF/anchor SMF, the target V-SMF/I-SMF/anchor SMF shall retrieve the SM Context from the SMF via the SEPP. In this case, the smContextSmfPlmnId attribute may also be used for the discovery and selection of the local SEPP. + +NOTE 8: The smfUri and hSmfUri attributes need not be included in Create SM Context request in procedures other than PDU session establishment procedure and EPS to 5GS mobility procedures if the NF Service Consumer (e.g. AMF) and I-SMF/V-SMF support the "ACSCR" feature. See clause 6.1.8. + +### 6.1.6.2.3 Type: SmContextCreatedData + +**Table 6.1.6.2.3-1: Definition of type SmContextCreatedData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| hsmfUri | Uri | C | 0..1 | This IE shall be present in HR roaming scenarios if the additionalHsmfUri IE was received in the request and the V-SMF established the PDU session towards an alternative SMF listed in the additionalHsmfUri IE. When present, it shall contain the API URI of the H-SMF towards which the PDU session was established. The API URI shall be formatted as specified in clause 6.1.1. | | +| smfUri | Uri | C | 0..1 | This IE shall be present for a PDU session with an I-SMF, if the additionalSmfUri IE was received in the request and the I-SMF established the PDU session towards an alternative SMF listed in the additionalSmfUri IE. When present, it shall contain the API URI of the SMF towards which the PDU session was established. The API URI shall be formatted as specified in clause 6.1.1. | DTSSA | +| pduSessionId | PduSessionId | C | 0..1 | This IE shall be present, during an EPS to 5GS Idle mode mobility or handover using the N26 interface. When present, it shall be set to the PDU Session ID. | | +| sNssai | Snssai | C | 0..1 | This IE shall be present during an EPS to 5GS Idle mode mobility or handover using the N26 interface. When present, it shall contain the S-NSSAI assigned to the PDU session. In Home-Routed roaming case, this IE shall contain the S-NSSAI for home PLMN. | | +| additionalSnssai | Snssai | C | 0..1 | This IE shall be present during an EPS to 5GS Idle mode mobility or handover using the N26 interface for LBO roaming case. When present, this IE shall indicate the associated S-NSSAI in HPLMN for the PDU Session. | | +| upCnxState | UpCnxState | C | 0..1 | This IE shall be present if the SMF was requested to activate the user plane connection of the PDU session in the corresponding request. When present, it shall be set as specified in clauses 5.2.2.2.2, 5.2.2.2.6 or 5.2.2.2.7. | | +| n2SmInfo | RefToBinaryData | C | 0..1 | This IE shall be present if N2 SM Information needs to be sent to the AN. | | +| n2SmInfoType | N2SmInfoType | C | 0..1 | This IE shall be present if "n2SmInfo" attribute is present. When present, this IE shall indicate the NG AP IE type for the NG AP SMF related IE container carried in "n2SmInfo" attribute. | | +| allocatedEbiList | array(EbiArpMapping) | C | 1..N | This IE shall be present if the consumer NF is an AMF and Inter-system mobility happens. When present, it shall contain an array of EBI to ARP mappings currently allocated to the PDU session. | | +| hoState | HoState | C | 0..1 | This IE shall be present if the SMF was requested to prepare an EPS to 5GS handover for the PDU session in the corresponding request. When present, it shall be set as specified in clause 5.2.2.2.3. | | +| gpsi | Gpsi | C | 0..1 | This IE shall be present if no GPSI IE is provided in the request, e.g. for a PDU session moved from another access or another system, and the SMF knows that a GPSI is already associated with the PDU session (or a GPSI is received from h-SMF for a HR PDU session).

When present, it shall contain the user's GPSI associated with the PDU session. | | +| smfServiceInstanceId | string | O | 0..1 | When present, this IE shall contain the serviceInstanceId of the SMF PDU Session service instance serving the SM Context, i.e. of:
- the I-SMF, for a PDU session with I-SMF; | | + +| | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| | | | |
  • - the V-SMF, for a HR PDU session; or
  • - the SMF, for a non-roaming or an LBO roaming PDU session without I-SMF.

This IE may be used by the AMF to identify PDU session contexts affected by a failure or restart of the SMF service instance (see clause 6.2 of 3GPP TS 23.527 [24]).

| | +| recoveryTime | DateTime | O | 0..1 | Timestamp (in UTC) when the SMF service instance serving the PDU session was (re)started (see clause 6.3 of 3GPP TS 23.527 [24]). | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | +| selectedSmfId | NfInstanceId | C | 0..1 |

This IE shall be present if a new (h)SMF is selected e.g. by the new I/V-SMF, or a SCP between the new I/V-SMF and the (h)SMF. (NOTE 1)

When present, it shall contain the selected SMF NF Instance Id.

| DTSSA | +| selectedOldSmfId | NfInstanceId | C | 0..1 |

This IE shall be present if another old I/V-SMF(as alternative to the old I/V-SMF) is selected, e.g. by the new I/V-SMF, anchor SMF or a SCP between the new I/V-SMF and the old I/V-SMF. (NOTE 1)

When present, it shall contain the selected old I/V-SMF NF Instance Id.

| DTSSA | +| interPlmnApiRoot | Uri | C | 0..1 |

This IE should be present if the PDU session may be subject to inter-PLMN mobility and different SM context URIs shall be used for intra-PLMN and inter-PLMN signaling requests targeting the SM context. When present, it shall contain the apiRoot of the SM context to be used in inter-PLMN signalling request targeting the SM context. (NOTE 2)

| | +| udmGroupId | NfGroupId | O | 0..1 | This IE may be present during an EPS to 5GS handover using the N26 interface procedure. When present, it shall indicate the identity of the UDM group serving the UE. | | +| pcfGroupId | NfGroupId | O | 0..1 |

This IE may be present during an EPS to 5GS handover using the N26 interface procedure. When present, this IE shall contain the identity of the (home) PCF group serving the PDU session for Session Management policy.

| | +| NOTE 1: During an SmContext Creation procedure, e.g. for I-SMF insertion or I-SMF change procedure, when the new I/V-SMF attempts to contact the old I/V-SMF or (h)SMF by invoking Nsmf_PDUSession_Context Request, if a new (h)SMF and/or another old I/V-SMF has been re-selected (since the old I/V-SMF or the (h)SMF is not reachable) by the new I/V-SMF or a SCP, the selected old I/V-SMF and/or (h)SMF shall be returned to the AMF, in order to perform potential subsequent operations on the SMF hosting the resource, e.g. to release the SM Context on old I/V-SMF, or to create SM Context on SMF when the I/V-SMF needs to be removed. | | | | | | +| NOTE 2: The SM Context URI returned in the Location header in the Create SM Context response shall contain an URI suitable for use in intra-PLMN signaling requests targeting the SM Context. During an inter-PLMN mobility, the target AMF shall replace the apiRoot of the smContextRef with the interPlmnApiRoot if available and send the resulting smContextRef in the Create SM Context request towards the target V-SMF, I-SMF or anchor SMF. | | | | | | + +#### 6.1.6.2.4 Type: SmContextUpdateData + +**Table 6.1.6.2.4-1: Definition of type SmContextUpdateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pei | Pei | C | 0..1 | This IE shall be present if it is available and has not been provided earlier to the SMF. When present, this IE shall contain the permanent equipment identifier. | | +| servingNfId | NfInstanceId | C | 0..1 | This IE shall be present upon inter-AMF change or mobility, or upon a N2 handover execution with AMF change. When present, it shall contain the identifier of the serving NF (e.g. AMF). | | +| smContextStatusUri | Uri | C | 0..1 | This IE shall be present if the servingNfId IE is present. It may be present otherwise. When present, this IE shall include the callback URI to receive notification of SM context status. | | +| guami | Guami | C | 0..1 | This IE shall be present if the servingNfId of AMF is present. When present, it shall contain the serving AMF's GUAMI. | | +| servingNetwork | PlmnIdNid | C | 0..1 | This IE shall be present if the servingNfId IE is present. When present, it shall contain the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN. | | +| backupAmfInfo | array(BackupAmfInfo) | C | 1..N | This IE shall be included for the modification of the BackupAmfInfo if the NF service consumer is an AMF and the AMF supports the AMF management without UDSF. For deleting the backupAmfInfo, it shall contain the Null value. | | +| anType | AccessType | C | 0..1 | This IE shall be present upon a change of the Access Network Type associated to the PDU session, e.g. during a handover of the PDU session between 3GPP access and untrusted non-3GPP access (see clause 5.2.2.3.5.2). When present, this IE shall indicate the Access Network Type to which the PDU session is to be associated. | | +| additionalAnType | AccessType | C | 0..1 | This IE shall indicate the additional Access Network Type to which the PDU session is to be associated. This IE shall be present when the UE requests to establish resources for MA PDU session over the other access. | MAPDU | +| anTypeToReactivate | AccessType | C | 0..1 | This IE shall indicate the Access Network Type for which the UP connection is requested to be re-activated, for a MA PDU session. | MAPDU | +| ratType | RatType | C | 0..1 | This IE shall be present and indicate the RAT Type used by the UE, if available, upon a change of RAT Type. | | +| presenceInLadn | PresenceState | C | 0..1 | This IE shall be present during a Service Request procedure (see clause 5.2.2.3.2.2), an Xn handover (see clause 5.2.2.3.3) or a N2 handover execution (see clause 5.2.2.3.4.3), if the DNN of the PDU session corresponds to a LADN. When present, it shall be set to "IN" or "OUT" to indicate that the UE is in or out of the LADN service area. | | +| ueLocation | UserLocation | C | 0..1 | This IE shall be present if it is available and if it needs to be reported to the SMF (e.g. the user location has changed or the user plane of the PDU session is deactivated). When present, this IE shall contain:
  • - the UE location information (see clause 5.2.3.4); and
  • - the timestamp, if available, indicating the UTC time when the UeLocation information was
| | + +| | | | | | | +|--|--|--|--|-----------------------|--| +| | | | | acquired.
(NOTE 1) | | +|--|--|--|--|-----------------------|--| + +| | | | | | | +|--------------------|-----------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| ueTimeZone | TimeZone | C | 0..1 | This IE shall be present if it is available, the UE Time Zone has changed and needs to be reported to the SMF.
When present, this IE shall contain the UE Time Zone. | | +| addUeLocation | UserLocation | O | 0..1 | Additional UE location.
This IE may be present, if anType indicates a non-3GPP access and a valid 3GPP access user location information is available.
When present, it shall contain:
  • - the last known 3GPP access user location (see clause 5.2.3.4); and
  • - the timestamp, if available, indicating the UTC time when the addUeLocation information was acquired.
(NOTE 1) | | +| upCnxState | UpCnxState | C | 0..1 | This IE shall be present to request the activation or the deactivation of the user plane connection of the PDU session.
When present, it shall be set as specified in clauses 5.2.2.3.2, 5.2.2.3.15 and 5.2.2.3.16. | | +| hoState | HoState | C | 0..1 | This IE shall be present to request the preparation, execution or cancellation of a handover of the PDU session.
When present, it shall be set as specified in clause 5.2.2.3.4. | | +| toBeSwitched | boolean | C | 0..1 | This IE shall be present during an Xn Handover (see clause 5.2.2.3.3) to request to switch the PDU session to a new downlink N3 tunnel endpoint.
When present, it shall be set as follows:
  • - true: request to switch to the PDU session.
  • - false (default): no request to switch the PDU session.
| | +| failedToBeSwitched | boolean | C | 0..1 | This IE shall be present during an Xn Handover (see clause 5.2.2.3.3) if the PDU session failed to be setup in the target RAN.
When present, it shall be true to indicate that the PDU session failed to be setup in the target RAN. | | +| n1SmMsg | RefToBinaryData | C | 0..1 | This IE shall be present if N1 SM Information has been received from the UE.
When present, this IE shall reference the N1 SM Message binary data (see clause 6.1.6.4.2). | | +| n2SmInfo | RefToBinaryData | C | 0..1 | This IE shall be present if N2 SM Information has been received from the AN.
When present, this IE shall reference the N2 SM Information binary data (see clause 6.1.6.4.3). | | +| n2SmInfoType | N2SmInfoType | C | 0..1 | This IE shall be present if "n2SmInfo" attribute is present.
When present, this IE shall indicate the NG AP IE type for the NG AP SMF related IE container carried in "n2SmInfo" attribute. | | +| targetId | NgRanTargetId | C | 0..1 | This IE shall be present during a N2 handover preparation, when the hoState IE is set to the value "PREPARING".
When present, it shall contain the Target ID identifying the target RAN Node ID and TAI received in the Handover Required from the Source RAN. | | +| targetServingNfId | NfInstanceId | C | 0..1 | This IE shall be present during a N2 handover preparation with AMF change, when the hoState IE is set to the value "PREPARING".
When present, it shall contain the identifier of the target serving NF (e.g. AMF). | | + +| | | | | | | +|-----------------------|------------------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| dataForwarding | boolean | C | 0..1 | This IE shall be present and set as specified in clause 5.2.2.3.9 during a 5GS to EPS handover, or as specified in 5.2.2.3.13 during a N2 based handover with I-SMF insertion/change/removal, or as specified in clause 5.2.2.3.21 during N9 Forwarding Tunnel establishment between Branching Points or UL CLs controlled by different I-SMFs.
When present, it shall be set as follows:
- true: setup the direct or indirect data forwarding tunnels;
- false (default): data forwarding tunnels are not required to be setup. | | +| n9ForwardingTunnel | TunnelInfo | C | 0..1 | This IE shall be present in the following case:
- UE triggered Service Request with I-SMF change/removal, if requesting to forward buffered downlink data packets at I-UPF (See clause 4.23.4 of 3GPP TS 23.502 [3]).
When present, it shall carry the N9 forwarding tunnel info of I-UPF. | DTSSA | +| n9DIForwardingTnlList | array (IndirectDataForwardingTunnelInfo) | C | 1..N | This IE shall be present in the following case:
- N2 based handover with I-SMF insertion/change/removal, if downlink indirect data forwarding tunnels are requested to be established between target I-UPF and source I-UPF / source UPF (see clause 4.23.7 and 4.23.11 of 3GPP TS 23.502 [3]).
When present, it shall carry the list of N9 downlink indirect data forwarding tunnel(s) info of I-UPF. | DTSSA | +| n9UIForwardingTnlList | array (IndirectDataForwardingTunnelInfo) | C | 1..N | This IE shall be present in the following case:
- N2 based handover with I-SMF insertion/change/removal, if uplink indirect data forwarding tunnels are requested to be established between target I-UPF and source I-UPF / source UPF (see clause 4.23.7 and 4.23.11 of 3GPP TS 23.502 [3]).
When present, it shall carry the list of N9 uplink indirect data forwarding tunnel(s) info of I-UPF. | DTSSA | +| n9DIForwardingTunnel | TunnelInfo | C | 0..1 | This IE shall be present in the following case:
- simultaneous change of Branching Points or UL CLs controlled by different I-SMFs, if downlink data forwarding tunnel is requested to be established from source BP / UL CL to target BP / UL CL (see clause 4.23.9.5 of 3GPP TS 23.502 [3]).
When present, it shall carry the N9 downlink data forwarding tunnel info of the target BP / UL CL. | N9FSC | +| n9InactivityTimer | DurationSec | O | 0..1 | When present, this IE shall indicate an inactivity detection timer, in seconds, that the I-SMF may use to set the N9 forwarding tunnel inactive traffic detection timer in Branching Point or UL CL as specified in clause 4.23.9.5 of 3GPP TS 23.502 [3]. | N9FSC | +| epsBearerSetup | array(EpsBearerContainer) | C | 0..N | This IE shall be present during a 5GS to EPS handover using the N26 interface.
When present, it shall include the EPS bearer context(s) successfully setup in EPS. The array shall be empty if no resource was successfully allocated in EPS for any PDU session. | | +| revokeEbiList | array(EpsBearerId) | C | 1..N | This IE shall be present to request the SMF to revoke some EBIs (see clause 4.11.1.4.1 of 3GPP TS 23.502 [3]). When present, it shall contain the EBIs to revoke. | | +| release | boolean | C | 0..1 | This IE shall be used to indicate a network initiated PDU session release is requested. | | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

This IE shall be present and set as specified in clause 5.2.2.3.10 during P-CSCF restoration procedure, in clause 5.2.2.3.11 during AMF requested PDU Session Release due to duplicated PDU Session Id, in clause 5.2.2.3.12 during AMF requested PDU Session Release due to slice not available, in clause 5.2.2.3.17 during AMF requested PDU Session Release due to Network Slice-Specific Authentication and Authorization failure or revocation, in clause 5.2.2.3.19 during AMF requested PDU Session Release due to Control Plane Only indication associated with PDU Session is not applicable any longer, in clause 5.2.2.3.20 during AMF requested PDU Session Release due to ODB changes, and in clause 5.2.2.3.27 during AMF requested PDU Session Release due to MBSR not authorized.

When present, it shall be set as follows:

  • - true: PDU session release is required;
  • - false (default): PDU session release is not required.
| | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|--------------------|---------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| cause | Cause | O | 0..1 | When present, this IE shall indicate the cause for the requested modification, e.g. the NF Service Consumer cause for requesting to deactivate the user plane connection of the PDU session. | | +| ngApCause | NgApCause | C | 0..1 | This IE shall be present, if the information is available. When present, this IE shall indicate the cause for the requested modification, e.g. the NGAP cause for requesting to deactivate the user plane connection of the PDU session. | | +| 5gMmCauseValue | 5GMmCause | C | 0..1 | This IE shall be included if the AMF received a 5GMM cause code from the UE during any network initiated PDU session modification or release procedure. (e.g 5GMM Status message in response to a Downlink NAS Transport message carrying 5GSM payload). | | +| sNssai | Snssai | C | 0..1 | This IE shall be present and sent to the V-SMF, during an EPS to 5GS mobility registration using the N26 interface, if the S-NSSAI for the serving PLMN derived from the S-NSSAI of the home PLMN differs from the S-NSSAI provided in the Create SM Context Request.
When present, it shall contain the S-NSSAI for the serving PLMN. | | +| traceData | TraceData | C | 0..1 | This IE shall be included if trace is required to be activated, modified or deactivated (see 3GPP TS 32.422 [22]).
For trace modification, it shall contain a complete replacement of trace data.
For trace deactivation, it shall contain the Null value. | | +| epsInterworkingInd | EpsInterworkingIndication | O | 0..1 | This IE may be present if its value has changed after session creation or last update.

When present, this IE shall indicate whether the PDU session may possibly be moved to EPS and whether N26 interface to be used during EPS interworking procedures. | | +| anTypeCanBeChanged | boolean | C | 0..1 | This IE shall be present and set to true to indicate that the Access Network Type associated to the PDU session can be changed (see clause 5.2.2.3.2.4), during a Service Request procedure (see clause 4.2.3.2 of 3GPP TS 23.502 [3])), in response to paging or NAS notification indicating non-3GPP access, when the PDU Session for which the UE was paged or notified is in the List Of Allowed PDU Sessions provided by the UE, and the AMF received N2 SM Information only or N1 SM Container and N2 SM Information from the SMF in step 3a of clause 4.2.3.3 of 3GPP TS 23.502 [3].

When present, it shall be set as follows:
- true: the access type of the PDU session can be changed.

- false (default): the access type of the PDU session cannot be changed. | | +| n2SmInfoExt1 | RefToBinaryData | C | 0..1 | This IE shall be present if more than one N2 SM Information has been received from the AN. When present, this IE shall reference the N2 SM Information binary data (see clause 6.1.6.4.3). | | +| n2SmInfoTypeExt1 | N2SmInfoType | C | 0..1 | This IE shall be present if "n2SmInfoExt1" attribute is present.
When present, this IE shall indicate the NG AP IE type for the NG AP SMF related IE container carried in "n2SmInfoExt1" attribute. | | +| maReleaseInd | MaReleaseIndication | C | 0..1 | This IE shall be present if one access of a MA PDU session is requested to be released, in the following cases: | MAPDU | + +| | | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |
  • - when UE/AMF initiates MA PDU session release over one access; or
  • - when UE deregisters from one access.

When present, it indicates the access to be released.

| | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------------|-------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| maNwUpgradeInd | boolean | C | 0..1 | This IE shall be present if the PDU session is allowed to be upgraded to MA PDU session (see clause 6.4.2.2 of 3GPP TS 24.501 [7]).

When present, it shall be set as follows:
- true: the PDU session is allowed to be upgraded to MA PDU session

- false (default): the PDU session is not allowed to be upgraded to MA PDU session | MAPDU | +| maRequestInd | boolean | C | 0..1 | This IE shall be present if a MA-PDU session is requested to be established (see clause 4.22.6.3 of 3GPP TS 23.502 [3]).
When present, it shall be set as follows:
- true: a MA-PDU session is requested
- false (default): a MA-PDU session is not requested | MAPDU | +| n3gPathSwitchExecutionInd | boolean | O | 0..1 | This IE may be present and set to true if the AMF receives the indication "Non-3GPP access path switching while using old AN resources" in the registration request message from the UE and if the SMF supports non-3GPP path switching, so to request the SMF to add a new non-3GPP access path (while also keeping the existing one) during a UE requested non-3GPP access switching for a MA-PDU session. | N3GPS | +| exemptionInd | ExemptionInd | C | 0..1 | This IE shall be present if the AMF has exempted the NAS message from a NAS SM congestion control activated in the AMF. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if the servingNfId or the targetServingNfId is present (i.e. during a change of AMF) and at least one optional feature defined in clause 6.1.8 is supported by the new AMF.
If this IE is absent when the servingNfId or the targetServingNfId is present, the new serving AMF or the target AMF respectively shall be considered as not supporting any optional feature. | | +| moExpDataCounter | MoExpDataCounter | C | 0..1 | This IE shall be included if the UE has accessed the network by using "MO exception data" RRC establishment cause and when the AMF decides to send a non-zero value to the SMF.
(NOTE 2)

When present, this IE shall contain the MO Exception Data Counter. | CIOT | +| extendedNasSmTimerInd | boolean | C | 0..1 | This IE shall be present if the UE supports CE mode B and use of CE mode B changes from restricted to unrestricted or vice versa in the Enhanced Coverage Restriction information in the UE context in the AMF.

When present, it shall indicate whether extended NAS SM timers shall be used for the UE as specified in 3GPP TS 24.501 [7], as follows:
- True: extended NAS SM timers shall be used
- False: normal NAS SM timers shall be used. | CIOT | +| forwardingFTEid | Bytes | C | 0..1 | This IE shall be present during a 5GS to EPS Idle mode mobility using N26 interface with data forwarding (see clause 4.11.1.3.2A of 3GPP TS 23.502 [3]), if the Forwarding F-TEID IE is present in the Context Acknowledge message received from the MME.
When present, it shall contain Base64-encoded characters, encoding the Forwarding F-TEID in the Context Acknowledge message, as specified in Figure 8.22-1 of 3GPP TS 29.274 [16] (starting from octet 1). | CIOT | + +| | | | | | | +|--------------------------------------|---------------------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| forwardingBearerContexts | array(ForwardingBearerContainer) | C | 1..N | This IE shall be present during a 5GS to EPS Idle mode mobility using N26 interface with data forwarding (see clause 4.11.1.3.2A of 3GPP TS 23.502 [3]), if the Bearer Contexts IE is present in the Context Acknowledge message received from the MME.
When present, it shall contain the Bearer Contexts in the Context Acknowledge message. | CIOT | +| ddnFailureSubs | DdnFailureSubs | C | 0..1 | This IE shall be present to subscribe or unsubscribe to the notification of the DDN Failure if the Availability after DDN failure event is subscribed/unsubscribed by the UDM, see clause 4.15.3.2.7 of 3GPP TS 23.502 [3].

This IE shall also be present if it is required to add, modify or remove DDN failure subscriptions. If it is present and the included ddnFailureSubsInd indicates notification of DDN failure is subscribed, the content of the received ddnFailureSubs shall overwrite any ddnFailureSubs received earlier. | CIOT | +| skipN2PduSessionReleaseInd | boolean | O | 0..1 | This IE may be present when the release IE is present with value "true".

When present, this IE shall indicate whether N2 message shall be skipped for the PDU session RAN resources release, if the UP connection is active:
- true: N2 message shall be skipped.
- false (default): N2 message shall not be skipped. | | +| secondaryRatUsageDataReportContainer | array(SecondaryRatUsageDataReportContainer) | C | 1..N | The IE shall be present during an EPS to 5GS handover procedure, if one or more instance of Secondary RAT Usage Data Report IE(s) are present and applicable to the PDU session.

When present, it shall contain Base64-encoded characters, encoding the Secondary RAT Usage Data Report in the Forward Relocation Complete Acknowledge message, as specified in Figure 8.132-1 of 3GPP TS 29.274 [16] (starting from octet 1). | | +| smPolicyNotifyInd | boolean | O | 0..1 | When present, this IE shall indicate that the SM Policy Association Establishment and Termination events shall be reported for the PDU session by the PCF for the SM Policy to the PCF for the UE:

- true: SM Policy Association Establishment and Termination events shall be reported

(NOTE 3) | SPAE | +| pcfUeCallbackInfo | PcfUeCallbackInfo | C | 0..1 | This IE shall be present when the smPolicyNotifyInd IE is present with value true.

When present, this IE shall contain the callback information of the PCF for the UE to receive SM Policy Association Establishment and Termination events notification from the PCF for the SM Policy. (NOTE 3) | SPAE | +| satelliteBackhaulCat | SatelliteBackhaulCategory | O | 0..1 | This IE may be present if the AMF and the SMF supports the 5GSAT feature and the AMF is aware that:
- there is a change of the satellite backhaul category; or
- the UE is newly served by a 5G-AN without any satellite backhaul and a satellite backhaul category had been signalled to the SMF; or
- the UE is newly served by a 5G-AN with a satellite backhaul and no satellite backhaul category had been signalled to the SMF; or | 5GSAT | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| | | | |

- there is a satellite backhaul towards the 5G AN serving the UE, but it does not know whether a satellite backhaul category had been signalled to the SMF (e.g. upon Inter-AMF mobility).

When present, this IE shall indicate the category of the satellite backhaul used towards the new 5G AN serving the UE, or that there is no longer any satellite backhaul towards the new 5G AN serving the UE.

| | +| cnBasedMt | boolean | O | 0..1 |

When present, this IE shall indicate to the SMF that UE is in RRC_INACTIVE mode with eDRX and CN Based MT handling is applied for the PDU session, i.e. the user plane connection is suspended and the UPF is requested to buffer subsequent DL Data and send a report upon subsequent DL data arrival, the SMF will then invoke the AMF EnableUEReachability service, see also clauses 4.8.1.1a and 4.8.2.2b of 3GPP TS 23.502 [3].

- true: CN Based MT handling is to be applied.

| | +| geoSatelliteId | GeoSatelliteId | C | 0..1 |

The AMF shall include this attribute when the Geo satellite ID changes.

When present, this IE shall contain a GEO satellite ID.

| 5GSATB | +| altSnssai | Snssai | C | 0..1 |

This IE shall be present when the PDU Session is to be transferred to an alternative S-NSSAI. When present, this IE shall indicate the alternative network slice to be used by the PDU session. See clause 5.15.19 of 3GPP TS 23.501 [2].

| NSRP | +| altHplmnSnssai | Snssai | C | 0..1 |

This IE shall be present for HR PDU session when the PDU Session is to be transferred to an alternative S-NSSAI in HPLMN. When present, this IE shall indicate the alternative network slice to be used by the PDU session in the HPLMN. See clause 5.15.19 of 3GPP TS 23.501 [2].

| NSRP | +|

NOTE 1: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator. In shared networks, when the AMF and SMF pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI or NCGI to the SMF. The Core Network Operator PLMN ID shall be communicated in the TAI and the Serving Network.

NOTE 2: The AMF increments the MO Exception Data Counter when the UE establishes/resumes RRC with "MO Exception Data" RRC cause. The AMF may defer sending the moExpDataCounter attribute to the SMF based on local configuration. The AMF resets the MO Exception Data Counter when receiving successful response from the SMF. The SMF however keeps incrementing the counter locally.

NOTE 3: If the AMF has received the callback information of the PCF for the UE together with the information of the PDU sessions (i.e. Slice and DNN combination) that are applicable for notification of SM Policy Association events, the AMF shall identify whether any ongoing non-roaming or local breakout PDU session is applicable for SM Policy Association events, i.e. whether the slice and DNN combination of the PDU session is listed in the received PDU session information from the PCF for the UE. If the PDU session is applicable for notification of SM Policy Association events, the AMF shall invoke Update SM context service operation for the PDU session and include the smPolicyNotifyInd IE with the value "true" and the callback information of the PCF for the UE in the request. The SMF shall forward the callback information of the PCF for the UE to the PCF for SM Policy if exists via SM Policy Association Modification. See clause 4.3.3.2 of 3GPP TS 23.502 [3]. The AMF needs not update the SMF if the subscription to the SM Policy Association events for the PDU session is cancelled by the PCF for UE.

| | | | | | + +### 6.1.6.2.5 Type: SmContextUpdatedData + +**Table 6.1.6.2.5-1: Definition of type SmContextUpdatedData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-----------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| upCnxState | UpCnxState | C | 0..1 | This IE shall be present if the SMF was requested to activate or deactivate the user plane connection of the PDU session in the corresponding request. When present, it shall be set as specified in clauses 5.2.2.3.2, 5.2.2.3.15 and 5.2.2.3.16. | | +| hoState | HoState | C | 0..1 | This IE shall be present if the SMF was requested to prepare, execute or cancel a handover for the PDU session in the corresponding request. When present, it shall be set as specified in clause 5.2.2.3.4. | | +| releaseEbiList | array(EpsBearerId) | C | 1..N | This IE shall be present if the SMF determines that some EBIs are not needed. When present, it shall contain the EBIs to be released. | | +| allocatedEbiList | array(EbiArpMapping) | C | 1..N | This IE shall be present if the consumer NF is an AMF and Inter-system mobility happens. When present, it shall contain an array of EBI to ARP mappings currently allocated to the PDU session. | | +| modifiedEbiList | array(EbiArpMapping) | C | 1..N | This IE shall be present if a PDU session modification procedure resulted in the change of ARP for a QoS flow that was already allocated an EBI. | | +| n1SmMsg | RefToBinaryData | C | 0..1 | This IE shall be present if N1 SM Information needs to be sent to the UE. When present, this IE shall reference the N1 SM Message binary data (see clause 6.1.6.4.2). | | +| n2SmInfo | RefToBinaryData | C | 0..1 | This IE shall be present if N2 SM Information needs to be sent to the AN. When present, this IE shall reference the N2 SM Information binary data (see clause 6.1.6.4.3). | | +| n2SmInfoType | N2SmInfoType | C | 0..1 | This IE shall be present if "n2SmInfo" attribute is present. When present, this IE shall indicate the NG AP IE type for the NG AP SMF related IE container carried in "n2SmInfo" attribute. | | +| epsBearerSetup | array(EpsBearerContainer) | C | 1..N | This IE shall be present during an EPS to 5GS handover using the N26 interface. When present, it shall include the EPS bearer context(s) successfully handed over to 5GS. | | +| dataForwarding | boolean | C | 0..1 | This IE shall be present if it was present in the corresponding request. When present, it shall be set as specified in clause 5.2.2.3.9 or 5.2.2.3.21. | | +| n3DIForwardingTnlList | array(IndirectDataForwardingTunnelInfo) | C | 1..N | This IE shall be present if indirect data forwarding is requested and N9 downlink indirect data forwarding tunnels info is included in the corresponding request. When present, it shall carry the list of N3 downlink indirect data forwarding tunnels info of source I-UPF or source UPF. | DTSSA | +| n3UIForwardingTnlList | array(IndirectDataForwardingTunnelInfo) | C | 1..N | This IE shall be present if indirect data forwarding is requested and N9 uplink indirect data forwarding tunnels info is included in the corresponding request. When present, it shall carry the list of N3 uplink indirect data forwarding tunnels info of source I-UPF or source UPF. | DTSSA | +| n9UIForwardingTunnel | TunnelInfo | C | 0..1 | This IE shall be present in the following case:
- simultaneous change of Branching Points or UL CLs controlled by different I-SMFs, if uplink data forwarding tunnel is requested to be established from target BP / UL CL to source BP / UL CL (see clause 4.23.9.5 of 3GPP TS 23.502 [3]).

When present, it shall carry the N9 uplink data forwarding tunnel info of the source BP / UL CL. | N9FSC | +| cause | Cause | C | 0..1 | This IE shall be present if the activation of the User | | + +| | | | | | | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| | | | | Plane connection failed due to insufficient resources (see clause 5.2.2.3.2.2). | | +| maAcceptedInd | boolean | C | 0..1 | This IE shall be present if a request to modify a single access PDU session into a MA PDU session was accepted (see clause 4.22.6.3 of 3GPP TS 23.502 [3]).
When present, it shall be set as follows:

- true: MA PDU session

- false (default): single access PDU session | MAPDU | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if the supportedFeatures IE was received in the request and at least one optional feature defined in clause 6.1.8 is supported by the updated SM context resource. | | +| forwardingFTeid | Bytes | C | 0..1 | This IE shall be present during an EPS to 5GS Idle mode mobility using N26 interface with data forwarding (see clause 4.11.1.3.3A of 3GPP TS 23.502 [3]), if the Forwarding F-TEID IE shall be sent to the MME in the Context Acknowledge message.
When present, it shall contain Base64-encoded characters, encoding the Forwarding F-TEID to be sent in the Context Acknowledge message, as specified in Figure 8.22-1 of 3GPP TS 29.274 [16] (starting from octet 1). | CIOT | +| forwardingBearerContexts | array(ForwardingBearerContainer) | C | 1..N | This IE shall be present during an EOS to 5GS Idle mode mobility using N26 interface with data forwarding (see clause 4.11.1.3.3A of 3GPP TS 23.502 [3]), if the Bearer Contexts IE shall be sent to the MME in the Context Acknowledge message.
When present, it shall contain the Bearer Contexts to be sent in the Context Acknowledge message. | CIOT | +| selectedSmfId | NfInstanceId | C | 0..1 | This IE shall be present if a new (h)SMF is selected e.g. by the new I/V-SMF, or a SCP between the new I/V-SMF and the (h)SMF. (NOTE)

When present, it shall contain the selected SMF NF Instance Id. | DTSSA | +| selectedOldSmfId | NfInstanceId | C | 0..1 | This IE shall be present if if another old I/V-SMF(as alternative to the old I/V-SMF) is selected, e.g. by the new I/V-SMF or a SCP between the new I/V-SMF and the old I/V-SMF. (NOTE)

When present, it shall contain the selected old I/V-SMF NF Instance Id. | DTSSA | +| interPlmnApiRoot | Uri | C | 0..1 | This IE should be present if the information has changed. When present, it shall contain the apiRoot of the SM context to be used in inter-PLMN signalling request targeting the SM context. | | +| anchorSmfFeatures | AnchorSmfFeatures | O | 0..1 | This IE may be present to indicate a list of features supported by the (H-)SMF to the AMF. | | +| NOTE: | During an SmContext Update procedure, if a new (h)SMF and/or another old I/V-SMF has been re-selected (since the old I/V-SMF or the (h)SMF is not reachable) by the new I/V-SMF or a SCP, the selected old I/V-SMF and/or (h)SMF shall be returned to the AMF, in order to perform potential subsequent operations on the SMF hosting the resource, e.g. to release the SM Context on old I/V-SMF, or to create SM Context on SMF when the I/V-SMF needs to be removed. | | | | | + +## 6.1.6.2.6 Type: SmContextReleaseData + +**Table 6.1.6.2.6-1: Definition of type SmContextReleaseData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| cause | Cause | C | 0..1 | This IE shall be present, if the information is available. When present, this IE shall indicate the NF Service Consumer cause for the requested SM context release. | | +| ngApCause | NgApCause | C | 0..1 | This IE shall be present, if the information is available. When present, this IE shall indicate the NGAP cause for the requested SM context release. | | +| 5gMmCauseValue | 5GMmCause | C | 0..1 | This IE shall be included if the PDU session is released by the AMF due to any 5GMM failure. When present, this IE shall contain the 5GMM cause code value received from the UE. | | +| ueLocation | UserLocation | C | 0..1 | This IE shall be present, if available. When present, it shall contain the UE location information (see clause 5.2.3.4). See NOTE. | | +| ueTimeZone | TimeZone | C | 0..1 | This IE shall be present, if available. When present, it shall contain the UE Time Zone information. | | +| addUeLocation | UserLocation | O | 0..1 | Additional UE location.
This IE may be present, if anType previously reported is a non-3GPP access and a valid 3GPP access user location information is available. When present, it shall contain:
  • - the last known 3GPP access user location (see clause 5.2.3.4); and
  • - the timestamp, if available, indicating the UTC time when the addUeLocation information was acquired.
See NOTE. | | +| vsmfReleaseOnly | boolean | C | 0..1 | This IE shall be present and set to "true" during a 5GS to EPS Idle mode mobility or handover, for a Home Routed PDU session associated with 3GPP access and with assigned EBI(s), or during Registration, UE Triggered Service Request, Inter NG-RAN node Xn based handover and N2 based handover procedures with V-SMF change or removal. When present, it shall be set as follows:
  • - true: release the SM context and PDU session in the V-SMF only;
  • - false (default): release the SM context and PDU session in V-SMF and H-SMF.
| | +| n2SmInfo | RefToBinaryData | C | 0..1 | This IE shall be present if N2 SM Information has been received from the AN. When present, this IE shall reference the N2 SM Information binary data (see clause 6.1.6.4.3). | | +| n2SmInfoType | N2SmInfoType | C | 0..1 | This IE shall be present if "n2SmInfo" attribute is present. When present, this IE shall indicate the NG AP IE type for the NG AP SMF related IE container carried in "n2SmInfo" attribute. | | +| ismfReleaseOnly | boolean | C | 0..1 | This IE shall be present and set to "true" during a 5GS to EPS Idle mode mobility or handover with I-SMF removal, or during Registration, UE Triggered Service Request, Inter NG-RAN node Xn based handover and N2 based handover with I-SMF change or removal. When present, it shall be set as follows:
  • - true: only release the SM context of the PDU session in the I-SMF;
  • - false (default): release the SM context and PDU session in I-SMF and SMF.
| DTSSA | + +NOTE: In shared networks, when the message is sent from the VPLMN to the HPLMN, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator. In shared networks, when the AMF and SMF pertain to the same PLMN, the Primary PLMN ID shall be communicated in the ECGI or NCGI to the SMF. The Core Network Operator PLMN ID shall be communicated in the TAI and the Serving Network. + + + +## 6.1.6.2.7 Type: SmContextRetrieveData + +**Table 6.1.6.2.7-1: Definition of type SmContextRetrieveData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| targetMmeCap | MmeCapabilities | C | 0..1 | This IE shall be present if it is available. When present, it shall contain the target MME capabilities. | | +| smContextType | SmContextType | C | 0..1 |

This IE shall be present if this is a request to retrieve the complete SM context, during scenarios with an I-SMF or V-SMF insertion/change/removal, or during SMF Context Transfer procedure for LBO or non-roaming PDU session without I-SMF (see clause 4.26.5.3 of 3GPP TS 23.502 [3]).

This IE shall also be present if this is a request to retrieve the AF Coordination Information during the change of SSC mode 3 PDU Session Anchor with multiple PDU Sessions, if the runtime coordination between old SMF and AF is enabled (see clause 4.3.5.2 of 3GPP TS 23.502 [3]).

| DTSSA, CTXTR

EnEDGE | +| servingNetwork | PlmnId | C | 0..1 |

This IE shall be present when the procedure is triggered by a new V-SMF, if the new V-SMF supports inter-PLMN V-SMF change or insertion.

This IE shall also be present during the procedure with an I-SMF insertion.

When present, this IE shall contain the serving core network operator PLMN ID of the NF Service Consumer (i.e. new V-SMF or new I-SMF).

| DTSSA | +| notToTransferEbiList | array(EpsBearerId) | C | 1..N | This IE shall be present, if the SM context type IE is absent or indicate a request to retrieve the EPS PDN connection, and the AMF determines that certain EPS bearers shall not to be transferred to EPS during a 5GS to EPS mobility procedure, as specified in clause 4.11.1 of 3GPP TS 23.502 [3]. When present, it shall contain the EBI list not to be transferred. | | +| ranUnchangedInd | boolean | C | 0..1 |

This IE shall be present if AN Tunnel is required, in scenario of I-SMF/V-SMF change/insertion during registration procedure after EPS to 5GS handover or I-SMF selection per DNAI, when UE is in CM-CONNECTED state (see clause 5.2.2.6.1).

When present, it shall be set as follows:

  • - true: NG-RAN is not changed and the tunnel information is required;
  • - false (default): NG-RAN is changed and the tunnel information is not required.
| DTSSA | +| hrsboSupportInd | boolean | C | 0..1 |

This IE shall be present if the procedure is triggered by a new V-SMF which supports the HR-SBO feature.

When present, it shall be set as follows:

  • - true: HR-SBO is supported;
  • - false (default): HR-SBO is not supported.
| | +| storedOffloadIds | array(OffloadIdentifier) | C | 1..N |

The IE shall be present when the target V-SMF has a list of the stored offload identifiers for the HPLMN of the PDU session from previous procedures (for the same or different PDU sessions) with the HPLMN.

When present, this IE shall contain the list of offload identifiers known by the target V-SMF for the HPLMN of the PDU session.

(NOTE)

| HR-SBO | + +NOTE: The stored VPLMN Offload identifiers shall be included in any subsequent request message to the source V-SMF for other HR-PDU sessions. + + + +6.1.6.2.8 Type: SmContextStatusNotification + +**Table 6.1.6.2.8-1: Definition of type SmContextStatusNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| statusInfo | StatusInfo | M | 1 | This IE shall contain status information about the SM context. | | +| smallDataRateStatus | SmallDataRateStatus | C | 0..1 | This IE shall be present, if the NF Service Consumer has indicated support of CIoT and if the status is available.
When present, it shall indicate the current small data rate control status for the PDU session. | CIOT | +| apnRateStatus | ApnRateStatus | C | 0..1 | This IE shall be present, if the NF Service Consumer has indicated support of CIoT and if the status is available.
When present, it shall indicate the current APN rate control status for the PDN connection (APN rates are shared by all PDN connections of the UE to this APN). | CIOT | +| ddnFailureStatus | boolean | C | 0..1 | This IE shall be present if the DDN Failure shall be reported (see clause 5.2.8.2.8 of 3GPP TS 23.502 [3]).

When present, it shall be set as follows:
- true: DDN failure detected

- false (default): DDN failure is not detected | CIOT | +| notifyCorrelationIdsForDdnFailure | array(string) | C | 1..N | This IE shall be present if the DDN Failure shall be reported.

When present, it shall contain the notification correlation Id(s) of the DDN failure subscriptions for which a DDN failure has been detected. This parameter can be useful if the NF service consumer has multiple subscriptions for the same PDU session. | CIOT | +| newIntermediateSmfId | NfInstanceId | C | 0..1 | This IE may be present for a PDU session with an I-SMF or V-SMF, if the resourceStatus attribute in statusInfo is set to "UPDATED" and the cause in statusInfo is set to "CHANGED_INTERMEDIATE_SMF".
When present, it shall include the NF instance identifier of the new intermediate SMF when it is changed within an SMF set. | ES3XX | +| newSmfId | NfInstanceId | C | 0..1 | This IE may be present if resourceStatus in statusInfo is set to "TRANSFERRED".

When present, it shall include:
- the new I-SMF instance identifier if the cause in statusInfo is "ISMF_CONTEXT_TRANSFER";
- the new SMF instance identifier if the cause in statusInfo is "SMF_CONTEXT_TRANSFER". | CTXTR | +| | | | | This IE may also be present if the resourceStatus attribute in statusInfo is set to "UPDATED". When present, it shall include the NF instance identifier of the new H-SMF or SMF (for a PDU session with an I-SMF) handling the PDU session, when it is changed within an SMF set, if the cause in statusInfo is "CHANGED_ANCHOR_SMF". | ES3XX | +| newSmfSetId | NfSetId | C | 0..1 | This IE may be present if resourceStatus in statusInfo is:
- TRANSFERRED

When present, it shall include:
- The new I-SMF set identifier if cause in statusInfo is "ISMF_SERVICE_CONTEXT_TRANSFER";
- The new SMF set identifier if cause in statusInfo is statusInfo | CTXTR | + +| | | | | | | +|--|--|--|--|------------------------------------|--| +| | | | | is "SMF_SERVICE_CONTEXT_TRANSFER". | | +|--|--|--|--|------------------------------------|--| + +| | | | | | | +|------------------|-----------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| oldSmfId | NfInstanceId | C | 0..1 | This IE shall be present if resourceStatus in statusInfo is:
- TRANSFERRED

When present, it shall include:
- The old I-SMF instance identifier if cause in statusInfo is "ISMF_CONTEXT_TRANSFER";
- The old SMF instance identifier if cause in statusInfo is "SMF_CONTEXT_TRANSFER". | CTXTR | +| oldSmContextRef | Uri | C | 0..1 | This IE may be present if resourceStatus in statusInfo is:
- TRANSFERRED

When present, this IE shall include the identifier of the SM Context resource in the old I-SMF or SMF.

This IE may also be present if resourceStatus in statusInfo is "UNCHANGED", the SMF selection during PDU Session re-establishment for SSC mode 3 is needed and the runtime coordination between old SMF and AF is enabled. When present, this IE shall contain the URI of the SM Context resource in the old SMF with the structure:
{apiRoot}/nsmf-pdusession/v1/sm-contexts/{smContextRef}. | CTXTR

EnEDGE | +| altAnchorSmfUri | Uri | C | 0..1 | This IE shall be present if resourceStatus in statusInfo is:
- ALT_ANCHOR_SMF

When present, it shall contain the API URI of the alternative (H-)SMF towards which the PDU session is established. | AASN | +| altAnchorSmfId | NfInstanceId | C | 0..1 | This IE may be present if resourceStatus in statusInfo is:
- ALT_ANCHOR_SMF

When present, it shall contain the NF Instance Id of the alternative (H-)SMF towards which the PDU session is established. | AASN | +| targetDnailInfo | TargetDnailInfo | C | 0..1 | This IE shall be present if the I-SMF selection or removal for the current PDU session, or SMF selection during PDU Session re-establishment for SSC mode 2/3 is needed, or if it is received from the SMF in Notify Status.
When present, this IE shall include the target DNAI Information. | EnEDGE | +| oldPduSessionRef | Uri | C | 0..1 | This IE shall be present if resourceStatus in statusInfo is "UNCHANGED", the SMF selection during PDU Session re-establishment for SSC mode 3 is needed and the runtime coordination between old SMF and AF is enabled.
When present, this IE shall contain the URI of the PDU session resource in the old SMF. The URI shall be an absolute URI, including apiRoot (see clause 6.1.3.6.2). | EnEDGE | +| interPlmnApiRoot | Uri | C | 0..1 | This IE should be present if the information has changed and, within the statusInfo IE, the resourceStatus IE is set to "UPDATED" and the cause IE set to "CHANGED_INTERMEDIATE_SMF".

When present, it shall contain the apiRoot of the SM context to be used in inter-PLMN signalling request targeting the SM context. | | +| targetDnai | Dnai | C | 0..1 | This IE shall be present if it is received from H-SMF in Update Request (see clause 6.7.3.2 of 3GPP TS 23.548 [74]).

When present, this IE shall include the target DNAI. | HR-SBO | + +| | +|---------------------------------------------------------------------------------------------------------------------| +| NOTE: If resourceStatus in statusInfo is "TRANSFERRED", at least one of newSmfId and newSmfSetId shall be included. | +|---------------------------------------------------------------------------------------------------------------------| + +## 6.1.6.2.9 Type: PduSessionCreateData + +**Table 6.1.6.2.9-1: Definition of type PduSessionCreateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | This IE shall be present, except if the UE is emergency registered and UICless. When present, it shall contain the subscriber permanent identity. | | +| unauthenticatedSupi | boolean | C | 0..1 | This IE shall be present if the SUPI is present in the message but is not authenticated and is for an emergency registered UE. When present, it shall be set as follows:
- true: unauthenticated SUPI;
- false (default): authenticated SUPI. | | +| pei | Pei | C | 0..1 | This IE shall be present if the UE is emergency registered and it is either UICless or the SUPI is not authenticated. For all other cases, this IE shall be present if it is available. When present, it shall contain the permanent equipment identifier. | | +| pduSessionId | PduSessionId | C | 0..1 | This IE shall contain the PDU Session ID, except during an EPS to 5GS Idle mode mobility or handover using the N26 interface. | | +| dnn | Dnn | M | 1 | This IE shall contain the requested DNN. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. | | +| selectedDnn | Dnn | C | 0..1 | This IE shall be present, if another DNN other than the UE requested DNN is selected for this PDU session. When present, it shall contain the selected DNN. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. | | +| sNssai | Snssai | C | 0..1 | This IE shall be present, except during an EPS to 5GS idle mode mobility or handover using the N26 interface. When present, it shall contain:
- the HPLMN S-NSSAI for a HR PDU session, which is mapped from the requested S-NSSAI by the VPLMN; or
- the requested S-NSSAI in the serving PLMN for a PDU session with an I-SMF. | | +| altSnssai | Snssai | C | 0..1 | This IE shall be present during the PDU session establishment procedure if the NF service consumer supports the network slice replacement, and the network slice indicated in the sNssai IE is requested to be replaced. In this case, the NF service consumer shall send the S-NSSAI and the alternative S-NSSAI. See clause 5.15.19 of 3GPP TS 23.501 [2]. | NSRP | +| hplmnSnssai | Snssai | C | 0..1 | This IE shall be present for an LBO PDU session with an I-SMF, except during an EPS to 5GS idle mode mobility or handover using the N26 interface. When present, it shall contain the HPLMN S-NSSAI of the LBO PDU session, which is mapped from the requested S-NSSAI by the VPLMN. | DTSSA | +| vsmfId | NfInstanceId | C | 0..1 | This IE shall be present for a HR PDU session. When present, it shall contain the identifier of the V-SMF. | | +| ismfId | NfInstanceId | C | 0..1 | This IE shall be present for a PDU session with an I-SMF. When present, it shall contain the identifier of the I-SMF. | DTSSA | +| servingNetwork | PlmnIdNid | M | 1 | This IE shall contain the serving core network operator PLMN ID and, for an SNPn, the NID that | | + +| | | | | | +|--|--|--|------------------------------------------------|--| +| | | | together with the PLMN ID identifies the SNPN. | | +|--|--|--|------------------------------------------------|--| + +| | | | | | | +|------------------------|--------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| requestType | RequestType | C | 0..1 | This IE shall be present if the Request type IE is received from the UE for a single access PDU session and if the request refers to an existing PDU session or an existing emergency PDU session. The requestType IE shall not be included for a MA-PDU session establishment request. It may be present otherwise.

When present, it shall indicate whether the request refers to a new PDU session or emergency PDU session, or to an existing PDU session or emergency PDU session.
For request sent from AMF, this IE shall be set based on the requestType received. | | +| epsBearerId | array(EpsBearerId) | C | 1..N | This IE shall be present during an EPS to 5GS Idle mode mobility or handover preparation using the N26 interface.
When present, it shall contain the list of EPS bearer Id(s) received from the MME. | | +| pgwS8cFteid | Bytes | C | 0..1 | This IE shall be present during an EPS to 5GS Idle mode mobility or handover preparation using the N26 interface.
When present, it shall contain Base64-encoded characters, encoding the PGW S8 F-TEID for Control Plane as specified in Figure 8.22-1 of 3GPP TS 29.274 [16] (starting from octet 1), received from the MME. | | +| vsmfPduSessionUri | Uri | C | 0..1 | This IE shall be present for a HR PDU session. When present, it shall include the callback URI representing the PDU session in the V-SMF. | | +| ismfPduSessionUri | Uri | C | 0..1 | This IE shall be present for a PDU session with an I-SMF. When present, it shall include the callback URI representing the PDU session in the I-SMF. | DTSSA | +| vcnTunnelInfo | TunnelInfo | C | 0..1 | This IE shall be present for a HR PDU session, except for EPS to 5GS handover using N26 interface and when Control Plane CIoT 5GS Optimisation is enabled and data delivery via NEF is selected for this PDU session.
When present, this IE shall contain the DL N9 tunnel CN information of the visited CN side, i.e. V-UPF. | | +| icnTunnelInfo | TunnelInfo | C | 0..1 | This IE shall be present for a PDU session involving an I-SMF, except when Control Plane CIoT 5GS Optimisation is enabled and data delivery via NEF is selected for this PDU session.

When present, this IE shall contain the DL N9 tunnel CN information of the I-UPF controlled by the I-SMF. | DTSSA | +| n9ForwardingTunnelInfo | TunnelInfo | C | 0..1 | This IE shall be present during Service Request procedures with I-SMF insertion, if buffered DL data is available at the I-UPF that is controlled by the SMF (see clause 4.23.4 in 3GPP TS 23.502 [3]).
When present, this IE shall contain the N9 tunnel information of the I-UPF controlled by the I-SMF. | DTSSA | +| additionalCnTunnelInfo | TunnelInfo | C | 0..1 | This IE shall be present if a MA PDU session is requested or if the PDU session is allowed to be upgraded to a MA PDU session, and the UE is registered over both 3GPP access and Non-3GPP access.
When present, it shall contain additional DL N9 tunnel CN information of the UPF controlled by the V-SMF or I-SMF. | MAPDU | +| anType | AccessType | M | 1 | This IE shall indicate the Access Network Type to which the PDU session is to be associated. | | +| additionalAnType | AccessType | C | 0..1 | This IE shall indicate the additional Access Network Type to which the PDU session is to be associated.
This IE shall be present if a MA-PDU session is requested and the UE is registered over both 3GPP access and Non-3GPP access. | MAPDU | + +| | | | | | | +|-------------------------|-------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| ratType | RatType | C | 0..1 | This IE shall be present and indicate the RAT Type used by the UE, if available. | | +| ueLocation | UserLocation | C | 0..1 | This IE shall contain the UE location information (see clause 5.2.3.4), if it is available. (NOTE 1) | | +| ueTimeZone | TimeZone | C | 0..1 | This IE shall contain the UE Time Zone, if it is available. | | +| addUeLocation | UserLocation | O | 0..1 | Additional UE location.
This IE may be present, if anType indicates a non-3GPP access and a valid 3GPP access user location information is available.
When present, it shall contain:
  • - the last known 3GPP access user location (see clause 5.2.3.4); and
  • - the timestamp, if available, indicating the UTC time when the addUeLocation information was acquired.
(NOTE 1) | | +| gpsI | Gpsi | C | 0..1 | This IE shall be present if it is available. When present, it shall contain the user's GPSI. | | +| n1SmInfoFromUe | RefToBinaryData | C | 0..1 | This IE shall be present if the V-SMF or I-SMF has received known N1 SM information from the UE that does not need to be interpreted by the V-SMF or I-SMF. When present, this IE shall reference the n1SmInfoFromUe binary data (see clause 6.1.6.4.4). | | +| unknownN1SmInfo | RefToBinaryData | C | 0..1 | This IE shall be present if the V-SMF or I-SMF has received unknown N1 SM information from the UE. When present, this IE shall reference the unknownN1SmInfo binary data (see clause 6.1.6.4.4). | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | +| hPcfId | NfInstanceId | O | 0..1 | This IE may be used by V-SMF to indicate the home PCF selected by the AMF for the UE to the H-SMF, for a HR PDU session.
When present, this IE shall contain the identifier of the H-PCF selected by the AMF for the UE (for UE Policy Control). | | +| pcfId | NfInstanceId | O | 0..1 | This IE may be used by I-SMF to indicate the (V-)PCF selected by the AMF for the UE to the SMF, for a PDU session with an I-SMF.
When present, this IE shall contain the identifier of the PCF (for Access and Mobility Policy Control and/or UE Policy Control) in non-roaming scenarios, or the V-PCF (for Access and Mobility Policy Control) in LBO roaming scenarios. | DTSSA | +| pcfGroupId | NfGroupId | O | 0..1 | This IE may be present in non-roaming and HR roaming scenarios.
When present, this IE shall contain the identity of the (home) PCF group serving the UE for Access and Mobility Policy and/or UE Policy. | | +| pcfSetId | NfSetId | O | 0..1 | When present, it shall contain the NF Set ID of the H-PCF indicated by the hPcfId IE or the (V-)PCF indicated by the pcfId IE. | | +| hoPreparationIndication | boolean | C | 0..1 | This IE shall be present during an EPS to 5GS handover preparation using the N26 interface or during N2 handover preparation with I-SMF insertion.
When present, it shall be set as follows:
  • - true: an EPS to 5GS handover preparation or N2 handover preparation with I-SMF is in progress; the PGW-C/SMF shall not switch the DL user plane of the PDU session yet.
  • - false: there is no on-going EPS to 5GS handover preparation or N2 handover preparation with I-SMF in progress. If a handover preparation was in progress, the handover has been completed. The PGW-C/SMF shall switch the DL user plane of the PDU session using the N9 tunnel information that has been received
| | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | in the vcnTunnelInfo or icnTunnelInfo.
It shall be set to "true" during an EPS to 5GS handover preparation using the N26 interface or during N2 handover preparation with I-SMF insertion. | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|------------------------|---------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| selMode | DnnSelectionMode | C | 0..1 | This IE shall be present if it is available. When present, it shall be set to:
  • - "VERIFIED", if the requested DNN provided by UE or the selected DNN provided by the network corresponds to an explicitly subscribed DNN; or
  • - "UE_DNN_NOT_VERIFIED", if the requested DNN provided by UE corresponds to the usage of a wildcard subscription; or
  • - "NW_DNN_NOT_VERIFIED", if the selected DNN provided by the network corresponds to the usage of a wildcard subscription.
If both the requested DNN (i.e. dnn IE) and selected DNN (i.e. selected Dnn IE) are present, the selMode shall be related to the selected DNN. | | +| alwaysOnRequested | boolean | C | 0..1 | This IE shall be present and set to true if the UE requests to setup an always-on PDU session and this is allowed by local policy in the V-SMF or I-SMF.
When present, it shall be set as follows:
  • - true: request for an always-on PDU session
  • - false (default): not a request for an always-on PDU session
| | +| udmGroupId | NfGroupId | O | 0..1 | When present, it shall indicate the identity of the UDM group serving the UE. | | +| routingIndicator | string | O | 0..1 | When present, it shall indicate the Routing Indicator of the UE. | | +| hNwPubKeyId | integer | O | 0..1 | When present, it shall indicate the Home Network Public Key Identifier of the UE. (NOTE 2) | | +| epsInterworkingInd | EpsInterworkingIndication | O | 0..1 | This IE may be present if the indication has been received from AMF and is allowed to be forwarded to H-SMF by operator configuration.
When present, this IE shall indicate whether the PDU session may possibly be moved to EPS and whether N26 interface to be used during EPS interworking procedures. | | +| vSmfServiceInstanceId | string | O | 0..1 | When present, this IE shall contain the serviceInstanceId of the V-SMF service instance serving the PDU session.
This IE may be used by the H-SMF to identify PDU sessions affected by a failure or restart of the V-SMF service (see clauses 6.2 and 6.3 of 3GPP TS 23.527 [24]). | | +| iSmfServiceInstanceId | string | O | 0..1 | When present, this IE shall contain the serviceInstanceId of I-SMF service instance serving the PDU session.
This IE may be used by the SMF to identify PDU sessions affected by a failure or restart of the I-SMF service (see clauses 6.2 and 6.3 of 3GPP TS 23.527 [24]). | DTSSA | +| recoveryTime | DateTime | O | 0..1 | Timestamp (in UTC) when the V-SMF or I-SMF service instance serving the PDU session was (re)started (see clause 6.3 of 3GPP TS 23.527 [24]). | | +| roamingChargingProfile | RoamingChargingProfile | O | 0..1 | Roaming Charging Profile applicable in the VPLMN (see clauses 5.1.9.1, 5.2.1.7 and 5.2.2.12.2 of 3GPP TS 32.255 [25]). | | +| chargingId | string | O | 0..1 | Charging ID (see clauses 5.1.9.1 of 3GPP TS 32.255 [25]).
The string shall encode the Charging ID (32-bit unsigned integer value, with maximum value "4294967295") in decimal representation.
Pattern: '^0([1-9]{1}[0-9]{0,9})\$' | | + +| | | | | | +|--|--|--|----------|--| +| | | | (NOTE 4) | | +|--|--|--|----------|--| + +| | | | | | | +|----------------------------------|-------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| smfChargingId | SmfChargingId | C | 0..1 | String based Charging ID (see 3GPP TS 32.255 [25]).

This IE shall be present when the chargingId IE is present and the "SCID" feature is supported by both SMFs.

When present, this IE shall encode the String based Charging ID of the PDU session and the base Charging ID segment shall be identical to the value carried in the chargingId IE. | SCID | +| oldPduSessionId | PduSessionId | C | 0..1 | This IE shall be present if this information is received from the UE and the same SMF is selected for SSC mode 3.
When present, it shall contain the old PDU Session ID received from the UE. See clauses 4.3.2.2.1 and 4.3.5.2 of 3GPP TS 23.502 [3]. | | +| epsBearerCtxStatus | EpsBearerContextStatus | C | 0..1 | This IE shall be present during an EPS to 5GS idle mode mobility using the N26 interface, if received in the Create SM Context request.
When present, it shall be set to the value received in the Create SM Context request. | | +| amfNfId | NfInstanceId | C | 0..1 | This IE shall be present if it is received in the Create SM Context request, unless the PDU session is related to regulatory prioritized service.
When present, it shall contain the identifier of the serving AMF. | | +| guami | Guami | C | 0..1 | This IE shall be present if the amfNfId is present.
When present, it shall contain the serving AMF's GUAMI. | | +| maxIntegrityProtectedDataRateUpl | MaxIntegrityProtectedDataRate | C | 0..1 | This IE shall be present if it is available.
When present, it shall indicate the maximum integrity protected data rate supported by the UE for uplink. | | +| maxIntegrityProtectedDataRateDl | MaxIntegrityProtectedDataRate | C | 0..1 | This IE shall be present if it is available.
When present, it shall indicate the maximum integrity protected data rate supported by the UE for downlink. | | +| cpCiotEnabled | boolean | C | 0..1 | This IE shall be present with the value "True" if the "5gCiotCpEnabled" attribute is received with "True" value in SM Context Create request, indicating the Control Plane CIoT 5GS Optimisation is enabled for the PDU session (see 3GPP TS 23.502 [3], clause 4.3.2.2.2).
When present, it shall be set as follows:
- True: Control Plane CIoT 5GS Optimisation is enabled.
- False (default): Control Plane CIoT 5GS Optimisation is not enabled. | CIOT | +| cpOnlyInd | boolean | C | 0..1 | This IE shall be present with the value "True", if the PDU session shall only use Control Plane CIoT 5GS Optimisation (see clause 5.31.4.1 of 3GPP TS 23.501 [2]).

When present, it shall be set as follows:
- True: the PDU session shall only use Control Plane CIoT 5GS Optimisation
- False (default): the PDU session is not constrained to only use Control Plane CIoT 5GS Optimisation. | CIOT | +| invokeNef | boolean | C | 0..1 | This IE shall be present with value "True", if Control Plane CIoT 5GS Optimisation is enabled and data delivery via NEF is selected for the PDU session.
When present, it shall be set as follows:
- True: Data delivery via NEF is selected.
- False (default): Data delivery via NEF is not selected. | CIOT | + +| | | | | | | +|-----------------------|------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| maRequestInd | boolean | C | 0..1 | This IE shall be present if a MA-PDU session is requested to be established by the UE.
When present, it shall be set as follows:
- True: a MA-PDU session is requested
- False (default): a MA-PDU session is not requested | MAPDU | +| maNwUpgradeInd | boolean | C | 0..1 | This IE shall only be present if the PDU session is allowed to be upgraded to MA PDU session (see clause 4.22.3 of 3GPP TS 23.502 [3]).

When present, it shall be set as follows:
- True: the PDU session is allowed to be upgraded to MA PDU session
- False (default): the PDU session is not allowed to be upgraded to MA PDU session

When maRequestInd is present and set to "true", this IE shall not be present. | MAPDU | +| dnaiList | array(Dnai) | C | 1..N | This IE shall be present over N16a if an I-SMF is inserted into a PDU session during the following procedures: PDU session establishment, Registration, Service Request, Xn based handover, Inter NG-RAN node N2 based handover (see clause 4.23 of 3GPP TS 23.502 [3]).
When present, it shall include the list of DNAs supported by the I-SMF. | DTSSA | +| presenceInLadn | PresenceState | C | 0..1 | This IE shall be present during Xn based handover with I-SMF insertion, if the DNN corresponds to a LADN.
When present, it shall be set to "IN" or "OUT" to indicate that the UE is in or out of the LADN service area. | DTSSA | +| secondaryRatUsageInfo | array(SecondaryRatUsageInfo) | O | 1..N | This IE may be present to report usage data for a secondary RAT for QoS flows and/or the whole PDU session. | DTSSA | +| smallDataRateStatus | SmallDataRateStatus | C | 0..1 | This IE shall be present if the small data rate control status is received from AMF, see clause 5.31.14.3 of 3GPP TS 23.501 [2] and clause 4.3.2.2.2 of 3GPP TS 23.502 [3]. | CIOT | +| apnRateStatus | ApnRateStatus | C | 0..1 | This IE shall be present, if the APN rate control status (APN rates are shared by all PDN connections of the UE to this APN) is received from the AMF, see clause 4.7.7.3 in 3GPP TS 23.401 [33] and clause 4.11.5.3 in 3GPP TS 23.502 [3]. | CIOT | +| dlServingPlmnRateCtl | integer | C | 0..1 | This IE shall be present if Serving PLMN Rate Control for downlink data packets is enabled in the PLMN and Control Plane CIoT 5GS Optimisation is enabled for the PDU session.

When present, this IE shall contain the maximum allowed number of Downlink NAS Data PDUs per deci hour of the serving PLMN, as specified in clause 5.31.14.2 of 3GPP TS 23.501 [2].

Minimum: 10 | CIOT | +| upSecurityInfo | UpSecurityInfo | C | 0..1 | This IE shall be present if received from NG-RAN during Xn handover procedure with I-SMF Insertion (see clause 5.2.2.7.5).
When present, this IE shall contain the User Plane Security Information associated to the PDU session. See clause 9.3.1.60 of 3GPP TS 38.413 [9]. | DTSSA | +| vplmnQos | VplmnQos | C | 0..1 | This IE shall be present for a HR PDU session, if the V-SMF supports the VQOS feature and if VPLMN QoS constraints are required for the PDU session.

When present, this IE shall contain the QoS constraints from the VPLMN. | VQOS | +| oldSmContextRef | Uri | C | 0..1 | This IE shall be present, if it is received in the Create | EnEDGE | + +| | | | | | | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------|--| +| | | | | SM Context request.
When present, this IE shall contain the identifier of the SM Context resource in the old SMF. | | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------------|--------------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| redundantPduSessionInfo | RedundantPduSessionInformation | C | 0..1 | This IE shall be present for a PDU session with an I-SMF, if an RSN and/or PDU Session Pair ID was received from the UE. | DCE2ER | +| oldPduSessionRef | Uri | C | 0..1 | This IE shall be present, if it is received in the Create SM Context request.

When present, this IE shall contain the URI of the PDU session resource in the old SMF. The URI shall be an absolute URI, including apiRoot (see clause 6.1.3.6.2). | EnEDGE | +| smPolicyNotifyInd | boolean | C | 0..1 | This IE shall be included by I-SMF to SMF, if received from AMF.

When present, this IE shall indicate whether the SM Policy Association Establishment and Termination events shall be reported for the PDU session by the PCF for the SM Policy to the PCF for the UE:

- true: SM Policy Association Establishment and Termination events shall be reported

- false (default): SM Policy Association Establishment and Termination events is not required

(NOTE 3) | SPAE | +| pcfUeCallbackInfo | PcfUeCallbackInfo | C | 0..1 | This IE shall be present when the smPolicyNotifyInd IE is present with value true.

When present, this IE shall contain the callback information of the PCF for the UE to receive SM Policy Association Establishment and Termination events notification from the PCF for the SM Policy. (NOTE 3) | SPAE | +| satelliteBackhaulCat | SatelliteBackhaulCategory | O | 0..1 | This IE may be present if the V-SMF/I-SMF supports the 5GSAT feature and the satelliteBackhaulCat IE has been received from the AMF.
When present, this IE shall indicate the value received from the AMF. | 5GSAT | +| upipSupported | boolean | C | 0..1 | This IE shall be present during the PDU session establishment procedure if the UE supports User Plane Integrity Protection with EPS and if the AMF supports the related functionality. It may be present otherwise. When present, this IE shall be set as follows:

- true: User Plane Integrity Protection with EPS is supported;

- false (default): User Plane Integrity Protection with EPS is not supported. | UPIPE | +| upCnxState | UpCnxState | C | 0..1 | This IE shall be present to indicate that the User Plane resource for the PDU session is going to be established by the I-SMF/V-SMF, during a service request procedure with I-SMF/V-SMF insertion (see clause 4.23.4.3 of 3GPP TS 23.502 [3]).
When present, this IE shall be set as specified in clause 5.2.2.7.6. | | +| disasterRoamingInd | boolean | O | 0..1 | This IE may be set during the PDU session establishment or a V-SMF insertion procedure when the V-SMF is indicated by the AMF that the UE is registered for Disaster Roaming service. When present, this IE shall be set as follows:

- true: the UE is registered for Disaster Roaming service

- false (default): the UE is not registered for | | + +| | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| | | | | Disaster Roaming service | | +| hrsboInfo | HrsboInfoFromVplmn | C | 0..1 | This IE shall be present in HR roaming scenarios if the V-SMF requests HR SBO authorization. When present, this IE shall include the information for HR-SBO. | HR-SBO | +| ecsAddrConfigInfos | array(EcsAddrConfigInfo) | C | 1..N | This IE shall be included by V-SMF to SMF, if received from NEF.

When present, this IE shall contain the ECS Address Configuration Information Parameters. See 3GPP TS 23.548 [39]. | HR-SBO | +| pduSetSupportInd | boolean | C | 0..1 | This IE shall be included by I-SMF to SMF for a PDU session with an I-SMF if the NG-RAN has indicated it supports the PDU Set based handling during a Xn based inter NG-RAN handover with the I-SMF insertion.

When present, this IE shall indicate whether the PDU Set based handling is supported by the NG-RAN:
  • - true: the PDU Set based handling is supported
  • - false(default): the PDU Set based handling is not supported
| | +| ecnMarkingCongestionInfoStatus | array(EcnMarkingCongestionInfoStatus) | C | 1..N | This IE shall be present when the V/I-SMF receives the ECN Marking or Congestion Monitoring Reporting Status during an I/V-SMF insertion procedure, e.g. for an Xn based handover.

When present, this IE shall contain a list of QoS flows with status for QoS monitoring for congestion information or for ECN marking for L4S. | | +| NOTE 1: In shared networks, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator. | | | | | | +| NOTE 2: If present, this attribute shall be used together with routingIndicator. This attribute is only used by the HPLMN in roaming scenarios. | | | | | | +| NOTE 3: If the smPolicyNotifyInd IE is received with the value "true", the SMF shall forward the callback information of the PCF for the UE to the PCF for SM Policy during SM Policy Association Establishment. See clause 4.3.2.2.1 of 3GPP TS 23.502 [3]. | | | | | | +| NOTE 4: Usage of Charging ID with Uint32 value for roaming scenarios may lead to Charging ID collision between SMFs. | | | | | | + +Editor's Note: How the V-SMF gets to know the supported feature by the H-SMF is FFS. + +## 6.1.6.2.10 Type: PduSessionCreatedData + +**Table 6.1.6.2.10-1: Definition of type PduSessionCreatedData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSessionType | PduSessionType | M | 1 | This IE shall indicate the selected PDU type. | | +| sscMode | string | M | 1 | This IE shall indicate the SSC mode applicable to the PDU session.
When present, it shall be encoded as one character in hexadecimal representation, taking a value of "0" to "7", representing the 3 bits of the SSC mode value of the SSC mode IE specified in clause 9.11.4.16 of 3GPP TS 24.501 [7].

Pattern: "[0-7]\$"

Example: SSC mode 3 shall be encoded as "3". (NOTE 1). | | +| hcnTunnelInfo | TunnelInfo | C | 0..1 | This IE shall be present for a HR PDU session, except when Control Plane CIoT 5GS Optimisation is enabled and data delivery via NEF is selected for this PDU session.

When present, this IE shall contain the UL N9 tunnel CN information of the home CN side, i.e. H-UPF. | | +| cnTunnelInfo | TunnelInfo | C | 0..1 | This IE shall be present for a PDU session involving an I-SMF, except when Control Plane CIoT 5GS Optimisation is enabled and data delivery via NEF is selected for this PDU session.

When present, this IE shall contain the UL N9 tunnel CN information of the PSA UPF. | DTSSA | +| additionalCnTunnelInfo | TunnelInfo | C | 0..1 | This IE shall be present if a MA-PDU session is established for a UE registered over both 3GPP access and Non-3GPP access.
When present, it shall contain additional UL N9 tunnel CN information of the UPF controlled by the H-SMF or SMF. | MAPDU | +| sessionAmbr | Ambr | C | 0..1 | This IE shall be present, except when Control Plane CIoT 5GS Optimisation is enabled for the PDU session.

When present, this IE shall contain the Session AMBR granted to the PDU session. | | +| qosFlowsSetupList | array(QosFlowSetupItem) | C | 1..N | This IE shall be present, except when Control Plane CIoT 5GS Optimisation is enabled for the PDU session.

When present, this IE shall contain the full set of QoS flow(s) to establish for the PDU session. It shall contain at least the QoS flow associated to the default QoS rule.

In V-SMF/I-SMF insertion scenarios where no QoS Rule(s) associated to a QoS flow can or need to be sent to the UE, the qosRules attribute of the QosFlowSetupItem may be set to an empty string or to the latest QoS Rule(s) associated to the QoS flow. (NOTE 3) | | +| hSmfInstanceId | NfInstanceId | C | 0..1 | This IE shall be present for a HR PDU session. When present, it shall contain the identifier of the home SMF. | | +| smfInstanceId | NfInstanceId | C | 0..1 | This IE shall be present for a PDU session with an I-SMF. When present, it shall contain the identifier of the SMF. | DTSSA | +| pduSessionId | PduSessionId | C | 0..1 | This IE shall be present during an EPS to 5GS Idle mode mobility or handover preparation using the N26 interface.
When present, it shall be set to the PDU Session ID. | | + +| | | | | | | +|---------------------------------|-------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| sNssai | Snssai | C | 0..1 | This IE shall be present during an EPS to 5GS Idle mode mobility or handover using the N26 interface. When present, it shall contain:
  • - the S-NSSAI assigned to the PDU session in the Home PLMN, for a HR PDU session;
  • - the S-NSSAI assigned to the PDU session in the serving PLMN, for a PDU session with an I-SMF. The Snssai shall overwrite the S-NSSAI earlier stored in I-SMF, if they are different.
| | +| additionalSnssai | Snssai | C | 0..1 | This IE shall be present during an EPS to 5GS Idle mode mobility or handover using the N26 interface for LBO roaming case. When present, this IE shall indicate the associated S-NSSAI in HPLMN for the PDU Session. | | +| enablePauseCharging | boolean | C | 0..1 | This IE shall be present, based on operator's policy, to enable the use of Pause of Charging for the PDU session (see clause 4.4.4 of 3GPP TS 23.502 [3]).

When present, it shall be set as follows:
  • - true: enable Pause of Charging;
  • - false (default): disable Pause of Charging.
| | +| uelpv4Address | Ipv4Addr | C | 0..1 | This IE shall be present if the SMF assigns a UE IPv4 address to the PDU session. | | +| uelpv6Prefix | Ipv6Prefix | C | 0..1 | This IE shall be present if the SMF assigns a UE IPv6 prefix to the PDU session. | | +| n1SmInfoToUe | RefToBinaryData | C | 0..1 | This IE shall be present if the SMF needs to send N1 SM information to the UE that does not need to be interpreted by the V-SMF or I-SMF. When present, this IE shall reference the n1SmInfoToUe binary data (see clause 6.1.6.4.4). | | +| epsPdnCnxInfo | EpsPdnCnxInfo | C | 0..1 | This IE shall be present if the PDU session may be moved to EPS during its lifetime. | | +| epsBearerInfo | array(EpsBearerInfo) | C | 1..N | This IE shall be present if the PDU session may be moved to EPS during its lifetime. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | +| maxIntegrityProtectedDataRate | MaxIntegrityProtectedDataRate | C | 0..1 | This IE shall be present if the upSecurity IE is present and indicates that integrity protection is preferred or required. When present, it shall indicate the maximum integrity protected data rate for uplink. If the maxIntegrityProtectedDataRateDI IE is absent, this IE applies to both uplink and downlink. (NOTE 6) | | +| maxIntegrityProtectedDataRateDI | MaxIntegrityProtectedDataRate | C | 0..1 | This IE may be present if the upSecurity IE is present and indicates that integrity protection is preferred or required. When present, it shall indicate the maximum integrity protected data rate for downlink. (NOTE 6) | | +| alwaysOnGranted | boolean | C | 0..1 | This IE shall be present if the alwaysOnRequested IE was received in the request or if the SMF determines, based on local policy, that the PDU session needs to be established as an always-on PDU session.

When present, it shall be set as follows:
  • - true: always-on PDU session granted.
  • - false (default): always-on PDU session not granted.
| | +| gpsi | Gpsi | C | 0..1 | This IE shall be present if no GPSI IE is provided in | | + +| | | | | | | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

the request, e.g. for a PDU session moved from another access or another system, and the SMF knows that a GPSI is already associated with the PDU session.

When present, it shall contain the user's GPSI associated with the PDU session.

| | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|------------------------|------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| upSecurity | UpSecurity | O | 0..1 | When present, this IE shall indicate the security policy for integrity protection and encryption for the user plane of the PDU session.
If this IE is present, it shall not indicate that integrity protection is preferred or required, if the maxIntegrityProtectedDataRate IE is not present (e.g. if UE Integrity Protection Maximum Data Rate is not available in the SMF).
(NOTE 6) | | +| roamingChargingProfile | RoamingChargingProfile | O | 0..1 | Roaming Charging Profile selected by the HPLMN (see clauses 5.1.9.1, 5.2.1.7 and 5.2.2.12.2 of 3GPP TS 32.255 [25]). | | +| hSmfServiceInstanceId | string | O | 0..1 | When present, this IE shall contain the serviceInstanceId of the H-SMF service instance serving the PDU session, for a HR PDU session.
This IE may be used by the V-SMF to identify PDU sessions affected by a failure or restart of the H-SMF service (see clause 6.2 of 3GPP TS 23.527 [24]). | | +| smfServiceInstanceId | string | O | 0..1 | When present, this IE shall contain the serviceInstanceId of the SMF service instance serving the PDU session, for a PDU session with an I-SMF.
This IE may be used by the I-SMF to identify PDU sessions affected by a failure or restart of the SMF service (see clause 6.2 of 3GPP TS 23.527 [24]). | DTSSA | +| recoveryTime | DateTime | O | 0..1 | Timestamp (in UTC) when the SMF service instance serving the PDU session was (re)started (see clause 6.3 of 3GPP TS 23.527 [24]). | | +| dnaiList | array(Dnai) | C | 1..N | This IE shall be present over N16a, if available and an I-SMF has been inserted into a PDU session, during the following procedures: PDU session establishment, Registration, Service Request, Xn based handover, Inter NG-RAN node N2 based handover (see clause 4.23 of 3GPP TS 23.502 [3]).
When present, it shall include the list of DNAsI of interest for the PDU session for local traffic steering at the I-SMF.

If the I-SMF and the SMF support the DTSSA-Ext1 feature, when present, this IE should include the full list of DNAsI of interest for PDU session, including DNAsI that may not be supported by the I-SMF and excluding the ones supported by the Anchor SMF. | DTSSA

DTSSA-Ext1 | +| ipv6MultiHomingInd | boolean | C | 0..1 | This IE shall be present over N16a, if available and an I-SMF has been inserted into the PDU session during the following procedures: PDU session establishment, Registration, Service Request, Xn based handover, Inter NG-RAN node N2 based handover (see clause 4.23 of 3GPP TS 23.502 [3]).

When present, it shall be set as follows:

- true: IPv6 multi-homing is permitted.

- false (default): IPv6 multi-homing is not allowed. | DTSSA | +| maAcceptedInd | boolean | C | 0..1 | This IE shall be present if a request to establish a MA PDU session was accepted or if a single access PDU session was upgraded into a MA PDU session (see clauses 4.22.2 and 4.22.3 of 3GPP TS 23.502 [3]).
When present, it shall be set as follows:

- true: MA PDU session

- false (default): single access PDU session | MAPDU | +| homeProvidedChargin | string | O | 0..1 | When present, this IE shall contain the Home | | + +| | | | | | | +|-----------------------------|--------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| gld | | | |

provided Charging ID (see 3GPP TS 32.255 [25]). This IE shall be present during an EPS to 5GS Idle mode mobility or Handover of a HR PDU session. (NOTE 5)

The string shall encode the Charging ID (32-bit unsigned integer value, with maximum value "4294967295") in decimal representation.

Pattern: '^(0 ([1-9]{1}[0-9]{0,9}))\$'

(NOTE 8)

| | +| homeProvidedSmfChargingId | SmfChargingId | C | 0..1 |

When present, this IE shall contain the Home provided String based Charging ID (see 3GPP TS 32.255 [25]).

This IE shall be present during an EPS to 5GS Idle mode mobility or Handover of a HR PDU session, if both the V-SMF and the H-SMF support the "SCID" feature.

(NOTE 9)

| SCID | +| nefExtBufSupportInd | boolean | C | 0..1 |

This IE shall be present with value "true", if NEF has indicated Extended Buffering Support for mobile terminated data in SMF-NEF connection establishment response.

When present, this IE shall be set as following:

  • - true: Extended Buffering supported by NEF
  • - false (default): Extended Buffering not supported by NEF
| CIOT | +| smallDataRateControlEnabled | boolean | C | 0..1 |

This IE shall be present and set to "true" if small data rate control is applicable on the PDU session.

When present, it shall be set as follows:

  • - true: small data rate control is applicable.
  • - false (default): small data rate control is not applicable.
| CIOT | +| ueIpv6InterfaceId | string | C | 0..1 |

This IE shall be present if the H-SMF/SMF has assigned IPv6 interface identifier to the UE during the PDU session establishment for the Home-routed Roaming scenario or for a PDU session with an I-SMF.

When present, it shall encode the UE IPv6 Interface Identifier to be used by the UE for its link-local address configuration with 16 hexadecimal digits.

Pattern: "^[A-Fa-f0-9]{16}\$"

| | +| ipv6Index | IpIndex | C | 0..1 |

This IE shall be present if IPv6 Index has been received from PCF during SM Policy Creation. (NOTE 4)

| DTSSA | +| dnAaaAddress | IpAddress | O | 0..1 |

When present, this IE shall contain the address of DN-AAA server for UE IP Address allocation that has been received from UDM. (NOTE 4).

| DTSSA | +| redundantPduSessionInfo | RedundantPduSessionInformation | C | 0..1 |

This IE shall be present for a PDU session with an I-SMF, if Dual Connectivity based end to end Redundant User Plane Paths shall apply as specified in clause 5.33.2.1 of 3GPP TS 23.501 [2], regardless of whether the redundantPduSessionInfo IE was received or not in the request. If an RSN and/or PDU Session Pair ID was received from the UE, the same RSN and/or PDU Session Pair ID shall be returned in the response; additionally, if either the RSN or PDU Session Pair ID was not received from the UE, the anchor SMF shall determine and also return an RSN or PDU Session Pair ID respectively in the response.

| DCE2ER | +| nspuSupportInd | boolean | C | 0..1 |

This IE shall be present and set to "true" if

| | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

enablePauseCharging is set to "true" and if the (H-)SMF and PSA UPF support Notify Start Pause of Charging via user plane feature as specified in clause 5.30 of 3GPP TS 29.244 [29].

When present, it shall be set as follows:

  • - true: Notify Start Pause of Charging via user plane feature is supported.
| | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| interPlmnApiRoot | Uri | C | 0..1 | This IE should be present if the PDU session may be subject to inter-PLMN mobility and different PDU session context URIs shall be used for intra-PLMN and inter-PLMN signaling requests targeting the PDU session context.
When present, it shall contain the apiRoot of the PDU session context to be used in inter-PLMN signalling request targeting the PDU session context. (NOTE 7) | | +| intraPlmnApiRoot | Uri | C | 0..1 | This IE should be present if the PDU session may be subject to inter-PLMN mobility and different PDU session context URIs shall be used for intra-PLMN and inter-PLMN signaling requests targeting the PDU session context.
When present, it shall contain the apiRoot of the PDU session context to be used in intra-PLMN signalling request targeting the PDU session context. (NOTE 7) | | +| udmGroupId | NfGroupId | O | 0..1 | This IE may be present during an EPS to 5GS handover using the N26 interface procedure. When present, it shall indicate the identity of the UDM group serving the UE. | | +| pcfGroupId | NfGroupId | O | 0..1 | This IE may be present during an EPS to 5GS handover using the N26 interface procedure. When present, this IE shall contain the identity of the (home) PCF group serving the PDU session for Session Management policy. | | +| hrsboInfo | HrsboInfoFromHplmn | C | 0..1 | This IE shall be present in HR roaming scenarios if the H-SMF supports the HR-SBO feature and it receives a request for HR-SBO.
When present, this IE shall include the information for HR-SBO.
The absence of this IE shall indicate that the HR-SBO is not allowed. | HR-SBO | +| pendingUpdateInfoList | array(PendingUpdateInfo) | O | 1..N | When present, this IE shall indicate the list of information that are not required to be updated in real-time to the (H-)SMF, i.e. the change of the listed information (e.g. UE location or Timezone) may be piggybacked in a subsequent essential update (e.g. to exchange the N1 message from the UE) to the (H-)SMF. The NF service consumer (i.e. I-SMF/V-SMF) should not trigger an Update to the (H-)SMF including only the change(s) of the listed information. | | +| NOTE 1: This IE contains information that the V-SMF or I-SMF only needs to transfer to the UE (without interpretation). It is sent as a separate IE rather than within the n1SmInfoToUE binary data because the Selected SSC mode IE is defined as a "V" IE (i.e. without a Type field) in the NAS PDU Session Establishment Accept message. | | | | | | +| NOTE 2: In scenarios with a V-SMF/I-SMF insertion, the V-SMF/I-SMF may receive in the Create Response some IEs it has already received during the earlier SM context retrieval from the SMF (e.g. due to the condition of presence of IEs in the Create Response). In such a case, the V-SMF/I-SMF shall overwrite the IEs earlier received with the new IEs received in the Create Response. | | | | | | +| NOTE 3: The V-SMF/I-SMF shall ignore any QoS Rule(s) associated to a QoS flow received in PduSessionCreatedData during V-SMF/I-SMF insertion scenarios where no QoS Rule(s) can be sent to the UE, i.e. during Registration, Inter NG-RAN node N2 based handover, and EPS to 5GS Idle mode mobility/handover using N26 interface procedures with V-SMF/I-SMF insertion, or during Service Request and Xn based handover procedures with I-SMF insertion. In such scenarios, the (H-)SMF shall initiate a subsequent PDU session modification procedure if it needs to change the QoS Rules associated to the QoS flows. | | | | | | +| NOTE 4: The I-SMF may use IPv6 index to assist in selecting how the IPv6 prefix is to be allocated for local PSA when IPv6 multi-homing is applied for the PDU session. If the IPv6 index indicates UE IP address allocation should be performed towards DN-AAA server, the DN-AAA server address may be included from the SMF to the I-SMF. | | | | | | +| NOTE 5: The chargingId IE in SmContext (see clause 6.1.6.2.39) shall be set to the value received in the homeProvidedChargingId IE during an EPS to 5GS Idle mode mobility or Handover of a HR PDU session. | | | | | | +| NOTE 6: During inter-system mobility from EPS to 5GS, the UE Integrity Protection Maximum Data Rate is not available at the SMF during PDU Session Creation. The UE will provide UE Integrity Protection Maximum Data Rate to the network within a subsequent UE triggered PDU session modification procedure, as specified in clause 4.3.3.2 of 3GPP TS 23.502 [3]. | | | | | | +| NOTE 7: During an inter-PLMN mobility, after retrieving the SM context from the old V-SMF, I-SMF or anchor SMF, the target V-SMF or I-SMF shall replace the apiRoot of the pduSessionRef with the interPlmnApiRoot (if available) if the anchor SMF is not in the target PLMN, or with the intraPlmnApiRoot (if available) otherwise. The Operator | | | | | | + +Identifier in the DNN indicates the PLMN ID of the anchor SMF. + +NOTE 8: Usage of Charging ID with Uint32 value for roaming scenarios may lead to Charging ID collision between SMFs. + +NOTE 9: The smfChargingId IE in SmContext (see clause 6.1.6.2.39) shall be set to the value in the homeProvidedSmfChargingId IE if received from the H-SMF. + +6.1.6.2.11 Type: HsmfUpdateData + +**Table 6.1.6.2.11-1: Definition of type HsmfUpdateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| requestIndication | RequestIndication | M | 1 | This IE shall indicate the request type. | | +| pei | Pei | C | 0..1 | This IE shall be present if it is available and has not been provided earlier to the H-SMF or SMF. When present, this IE shall contain the permanent equipment identifier. | | +| vcnTunnelInfo | TunnelInfo | C | 1 | This IE shall be present if the N9 tunnel information on the visited CN side provided earlier to the H-SMF has changed. When present, this IE shall contain the new N9 tunnel information on the visited CN side. | | +| icnTunnelInfo | TunnelInfo | C | 0..1 | This IE shall be present if the N9 tunnel information of the I-UPF for DL traffic provided earlier by the I-SMF to the SMF has changed. When present, this IE shall contain the new N9 tunnel information of the I-UPF. | DTSSA | +| additionalCnTunnelInfo | TunnelInfo | C | 0..1 | This IE shall be present if additional N9 tunnel information provided earlier has changed, or if the UE requests to establish resources for a MA PDU session over the other access. When present, it shall contain additional N9 tunnel information of the UPF controlled by the V-SMF or I-SMF. | MAPDU | +| servingNetwork | PlmnIdNid | C | 0..1 | This IE shall contain the serving core network operator PLMN ID, and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN, if the serving network has changed. | | +| anType | AccessType | C | 0..1 | This IE shall be present if the Access Network Type provided earlier to the H-SMF or SMF has changed, e.g. during a handover of the PDU session between 3GPP access and untrusted non-3GPP access (see clause 5.2.2.8.2.5). When present, this IE shall indicate the new Access Network Type to which the PDU session is to be associated. | | +| additionalAnType | AccessType | C | 0..1 | This IE shall indicate the additional Access Network Type to which the PDU session is to be associated. This IE shall be present when the UE requests to establish resources for MA PDU session over the other access. | MAPDU | +| ratType | RatType | C | 0..1 | This IE shall be present and indicate the RAT Type used by the UE, if available, upon a change of RAT Type. | | +| ueLocation | UserLocation | C | 0..1 | This IE shall be present if it is available, the UE Location has changed and needs to be reported to the H-SMF or SMF. When present, this IE shall contain:
  • - the new UE location information (see clause 5.2.3.4); and
  • - the timestamp, if available, indicating the UTC time when the UeLocation information was acquired.
(NOTE 1) | | +| ueTimeZone | TimeZone | C | 0..1 | This IE shall be present if it is available, the UE Time Zone has changed and needs to be reported to the H-SMF or SMF. When present, this IE shall contain the new UE Time Zone. | | +| addUeLocation | UserLocation | O | 0..1 | Additional UE location. This IE may be present, if anType indicates a non-3GPP access and a valid 3GPP access user location information is available. When present, it shall contain:
  • - the last known 3GPP access user location (see clause 5.2.3.4); and
  • - the timestamp, if available, indicating the UTC time when the addUeLocation information
| | + +| | | | | | | +|--|--|--|--|---------------------------|--| +| | | | | was acquired.
(NOTE 1) | | +|--|--|--|--|---------------------------|--| + +| | | | | | | +|--------------------------|-----------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| pauseCharging | boolean | C | 0..1 | This IE shall be present if the H-SMF or SMF enabled the use of Pause Pause of Charging for the PDU session during the PDU session establishment and Pause of Charging needs to be started or stopped (see clause 4.4.4 of 3GPP TS 23.502 [3]).
When present, it shall be set as follows:
- true: to Start Pause of Charging;
- false: to Stop Pause of Charging. | | +| pti | ProcedureTransactionId | C | 0..1 | This IE shall be present if the requestIndication indicates a UE requested PDU session modification or release. When present, it shall contain the PTI value received from the UE. | | +| n1SmInfoFromUe | RefToBinaryData | C | 0..1 | This IE shall be present if the V-SMF or I-SMF has received known N1 SM information from the UE that does not need to be interpreted by the V-SMF or I-SMF. When present, this IE shall reference the n1SmInfoFromUe binary data (see clause 6.1.6.4.4). (NOTE 5) | | +| unknownN1SmInfo | RefToBinaryData | C | 0..1 | This IE shall be present if the V-SMF or I-SMF has received unknown N1 SM information from the UE. When present, this IE shall reference the unknownN1SmInfo binary data (see clause 6.1.6.4.4). | | +| qosFlowsRelNotifyList | array(QosFlowItem) | C | 1..N | This IE shall be present if QoS flows have been released.
This IE shall also be present if QoS flow(s) have been rejected by the RAN or rejected by the V-SMF, during PDU session establishment procedure. | | +| qosFlowsVsmfRejectedList | array(Qfi) | O | 1..N | This IE may be present from V-SMF to H-SMF when qosFlowsRelNotifyList is present.

When present, this IE shall include the QFIs of the QoS flows that were rejected by the V-SMF.

When the H-SMF subsequently send N1 Message to the UE to remove the QoS rules and QoS Flow level QoS parameters associated with the rejected QoS Flow(s) as indicated in the qosFlowsRelNotifyList IE, the H-SMF should exclude the V-SMF rejected QoS flow(s). If all the rejected QoS flow(s) were rejected by the V-SMF, the H-SMF should skip the subsequent N1 message update to the UE. | | +| qosFlowsNotifyList | array(QosFlowNotifyItem) | C | 1..N | This IE shall be present if the QoS targets for GBR QoS flow(s) are not fulfilled anymore or when they are fulfilled again. For each GBR QoS flow indicated as not fulfilled anymore, the V-SMF/I-SMF may also indicate an alternative QoS profile which the NG-RAN currently fulfils in the currentQosProfileIndex IE or indicate that the NG-RAN cannot even fulfil the lowest alternative QoS profile. | | +| NotifyList | array(PduSessionNotifyItem) | C | 1..N | Description of notifications related to the PDU session. This IE shall be present if the NG-RAN has established user plane resources for the PDU session that do not fulfil the User Plane Security Enforcement with a value Preferred, or when the user plane security enforcement is fulfilled again. When present, this IE shall include the notification cause "UP_SEC_NOT_FULFILLED" if at least one of the UP integrity protection or UP ciphering security enforcement is not fulfilled.
If the securityResult IE is present in the message, it provides additional details on the security enforcement results. (NOTE 4) | | +| epsBearerId | array(EpsBearerId) | C | 0..N | This IE shall be present during an EPS to 5GS handover execution using the N26 interface. | | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | When present, it shall contain the list of EPS bearer Id(s) successfully handed over to 5GS. The array shall be empty if no resource was successfully allocated in 5GS for any PDU session. | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------------|--------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| hoPreparationIndication | boolean | C | 0..1 |

This IE shall be present during an EPS to 5GS handover preparation and handover execution using the N26 interface or during N2 handover execution with I-SMF insertion.

When present, it shall be set as follows:

  • - true: an EPS to 5GS handover preparation or N2 handover preparation with I-SMF is in progress; the PGW-C/SMF shall not switch the DL user plane of the PDU session yet.
  • - false: there is no on-going EPS to 5GS handover preparation or N2 handover preparation with I-SMF in progress. If a handover preparation was in progress, the handover has been completed. The PGW-C/SMF shall switch the DL user plane of the PDU session using the N9 tunnel information that has been received in the vcnTunnelInfo or icnTunnelInfo.

It shall be set to "true" during an EPS to 5GS handover preparation using the N26 interface.

It shall be set to "false" during an EPS to 5GS handover execution using the N26 interface or during N2 handover execution with I-SMF insertion.

| | +| revokeEbiList | array(EpsBearerId) | C | 1..N | This IE shall be present to request the H-SMF or SMF to revoke some EBIs (see clause 4.11.1.4.1 of 3GPP TS 23.502 [3]). When present, it shall contain the EBIs to revoke. | | +| cause | Cause | C | 0..1 |

This IE shall be present and set as specified in clause 5.2.2.8.2.6 during P-CSCF restoration procedure, clause 5.2.2.8.2.3 during 5G-AN requested PDU session resource release procedure and clause 5.2.2.3.26 during AMF requested PDU Session Release due to Network Slice instance not available.

When present, this IE shall indicate the NF Service Consumer cause of the requested modification.

| | +| ngApCause | NgApCause | C | 0..1 | The V-SMF or I-SMF shall include this IE if it received it from the 5G-AN and, for a HR PDU session, if this information is permitted to be sent to the H-SMF operator according to the V-SMF operator's policy. When present, this IE shall indicate the NGAP cause for the requested modification. | | +| 5gMmCauseValue | 5GMmCause | C | 0..1 | The V-SMF or I-SMF shall include this IE if it received it from the AMF and, for a HR PDU session, if this information is permitted to be sent to the H-SMF operator according to the V-SMF operator's policy. | | +| alwaysOnRequested | boolean | C | 0..1 |

This IE shall be present and set to true if the UE requests to change the PDU session to an always-on PDU session and this is allowed by local policy in the V-SMF or I-SMF.

When present, it shall be set as follows:

  • - true: request for an always-on PDU session
  • - false (default): not a request for an always-on PDU session
| | +| epsInterworkingInd | EpsInterworkingIndication | O | 0..1 |

This IE may be present if the indication has been received from AMF and, for a HR PDU session, it is allowed to be forwarded to H-SMF by operator configuration.

When present, this IE shall indicate whether the PDU session may possibly be moved to EPS and whether N26 interface to be used during EPS interworking procedures.

| | +| secondaryRatUsageReport | array(SecondaryRatUsageReport) | O | 1..N | This IE may be present to report usage data for a secondary RAT for QoS flows. (NOTE 2) | | +| secondaryRatUsageInf | array(SecondaryRat | O | 1..N | This IE may be present to report usage data for a | | + +| | | | | | | +|----------------------|-----------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| o | UsageInfo) | | | secondary RAT for QoS flows and/or the whole PDU session. | | +| anTypeCanBeChanged | boolean | C | 0..1 | This IE shall be present and set to true to indicate that the Access Network Type associated to the PDU session can be changed (see clause 5.2.2.8.2.2), during a Service Request procedure (see clauses 4.2.3.2 and 4.3.3.3 of 3GPP TS 23.502 [3]), in response to paging or NAS notification indicating non-3GPP access, when the PDU Session for which the UE was paged or notified is in the List Of Allowed PDU Sessions provided by the UE, and the AMF received N2 SM Information only or N1 SM Container and N2 SM Information from the SMF in step 3a of clause 4.2.3.3 of 3GPP TS 23.502 [3].
When present, it shall be set as follows:
- true: the access type of the PDU session can be changed.
- false (default): the access type of the PDU session cannot be changed. | | +| maReleaseInd | MaReleaseIndication | C | 0..1 | This IE shall be present if a MA PDU session is requested to be released over a single access, in the following cases:
- when UE/AMF/V-SMF initiates MA PDU session release over one access; or
- when UE deregisters from one access.
When present, it shall indicate the access to be released. | MAPDU | +| maNwUpgradeInd | boolean | C | 0..1 | This IE shall be present if the PDU session is allowed to be upgraded to MA PDU session (see clause 6.4.2.2 of 3GPP TS 24.501 [7]).

When present, it shall be set as follows:
- true: the PDU session is allowed to be upgraded to MA PDU session
- false (default): the PDU session is not allowed to be upgraded to MA PDU session | MAPDU | +| maRequestInd | boolean | C | 0..1 | This IE shall be present if a MA-PDU session is requested to be established (see clause 4.22.6.3 of 3GPP TS 23.502 [3]).
When present, it shall be set as follows:
- true: a MA-PDU session is requested
- false (default): a MA-PDU session is not requested | MAPDU | +| unavailableAccessInd | UnavailableAccessIndication | C | 0..1 | This IE shall be present if an access of a MA-PDU session is unavailable (see clause 4.22.7 of 3GPP TS 23.502 [3]).
When present, it shall indicate the access that is unavailable. | MAPDU | +| psaInfo | array(PsaInformation) | C | 1..N | This IE shall be present, for a PDU session with an I-SMF, if one or more PSAs UPF are inserted and/or removed by the I-SMF. | DTSSA | +| ulclBpInfo | UlclBpInformation | C | 0..1 | This IE shall be present, for a PDU session with an I-SMF, if an UL CL or BP UPF separate from the local PSA is inserted. | DTSSA | +| n4Info | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send N4 information (e.g. traffic usage reporting) to the SMF for traffic offloaded at a PSA controlled by an I-SMF. | DTSSA | +| n4InfoExt1 | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send additional N4 information (e.g. traffic usage reporting) to the SMF for traffic offloaded at a PSA controlled by an I-SMF. | DTSSA | +| n4InfoExt2 | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send additional N4 information to the SMF (e.g. during a change of PSA). | DTSSA | +| presenceInLadn | PresenceState | C | 0..1 | This IE shall be present during Xn based handover with I-SMF change, if the DNN corresponds to a LADN. | DTSSA | + +| | | | | | +|--|--|--|---------------------------------------------------------------------------------------------------------------|--| +| | | | When present, it shall be set to "IN" or "OUT" to indicate that the UE is in or out of the LADN service area. | | +|--|--|--|---------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-----------------------|--------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| vsmfPduSessionUri | Uri | C | 0..1 | This IE shall be present during any procedure when the V-SMF has changed, as specified in clause 4.23.4.3 of 3GPP TS 23.502 [3].

When present, it shall include the callback URI representing the PDU session in the new V-SMF. | DTSSA | +| ismfPduSessionUri | Uri | C | 0..1 | This IE shall be present during any procedure when the I-SMF has changed, as specified in clause 4.23.4.3 of 3GPP TS 23.502 [3].

When present, it shall include the callback URI representing the PDU session in the new I-SMF. | DTSSA | +| vsmfId | NfInstanceId | C | 0..1 | This IE shall be present during any procedure when the V-SMF has changed, as specified in clause 4.23.4.3 of 3GPP TS 23.502 [3].

When present, it shall contain the identifier of the new V-SMF. | DTSSA | +| ismfId | NfInstanceId | C | 0..1 | This IE shall be present during any procedure when the I-SMF has changed, as specified in clause 4.23.4.3 of 3GPP TS 23.502 [3].

When present, it shall contain the identifier of the new I-SMF. | DTSSA | +| vSmfServiceInstanceId | string | O | 0..1 | This IE may be present during any procedure when the V-SMF has changed, as specified in clause 4.23.4.3 of 3GPP TS 23.502 [3].

When present, this IE shall contain the serviceInstanceId of the new V-SMF service instance serving the PDU session.

This IE may be used by the H-SMF to identify PDU sessions affected by a failure or restart of the V-SMF service (see clauses 6.2 and 6.3 of 3GPP TS 23.527 [24]). | DTSSA | +| iSmfServiceInstanceId | string | O | 0..1 | This IE may be present during any procedure when the I-SMF has changed, as specified in clause 4.23.4.3 of 3GPP TS 23.502 [3].

When present, this IE shall contain the serviceInstanceId of the new I-SMF service instance serving the PDU session.

This IE may be used by the SMF to identify PDU sessions affected by a failure or restart of the I-SMF service (see clauses 6.2 and 6.3 of 3GPP TS 23.527 [24]). | DTSSA | +| dlServingPlmnRateCtl | integer | C | 0..1 | The IE shall be present when the Serving PLMN Rate Control for Downlink data packets has changed since last update to the H-SMF (for HR PDU session) or SMF (for PDU sessions with an I-SMF).

When present, this IE shall contain the maximum allowed number of Downlink NAS Data PDUs per deci hour of the serving PLMN, as specified in clause 5.31.14.2 of 3GPP TS 23.501 [2]. If Serving PLMN Rate Control is disabled, the IE shall be set to null value.

Minimum: 10 | CIOT | +| dnaiList | array(Dnai) | C | 1..N | This IE shall be present over N16a during UE Triggered Service Request procedure with I-SMF change, Xn based handover and Inter NG-RAN node N2 based handover with I-SMF change (see clauses 4.23.4.3, 4.23.11.3 and 4.23.7.3.3 in 3GPP TS 23.502 [3]).
When present, it shall include the list of DNAsI | DTSSA | + +| | | | | | | +|--|--|--|--|-----------------------------|--| +| | | | | supported by the new I-SMF. | | +|--|--|--|--|-----------------------------|--| + +| | | | | | | +|--------------------------------------|---------------------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if the vsmfld or the ismfld is present (i.e. during a change of V-SMF or I-SMF) and at least one optional feature defined in clause 6.1.8 is supported by the new V-SMF or I-SMF.

If this IE is absent when the vsmfld or the ismfld is present, the new V-SMF or I-SMF respectively shall be considered as not supporting any optional feature. | | +| roamingChargingProfile | RoamingChargingProfile | O | 0..1 | This IE may be present during an inter-PLMN V-SMF change (including the inter-PLMN mobility from HPLMN with I-SMF to VPLMN). When present, it shall contain the Roaming Charging Profile applicable in the VPLMN (see clauses 5.1.9.1, 5.2.1.7 and 5.2.2.12.2 of 3GPP TS 32.255 [25]). | | +| moExpDataCounter | MoExpDataCounter | C | 0..1 | This IE shall be present if received from AMF. When present, this IE shall contain the MO Exception Data Counter. | CIOT | +| vplmnQos | VplmnQos | O | 0..1 | When present, this IE shall contain the VPLMN QoS to be applied to the QoS flow with default QoS of the PDU Session. | VQOS | +| securityResult | SecurityResult | C | 0..1 | This IE shall be present if received from NG-RAN. When present, this IE shall contain the Security Result associated to the PDU session. See clause 9.3.1.59 of 3GPP TS 38.413 [9]. | | +| upSecurityInfo | UpSecurityInfo | C | 0..1 | This IE shall be present if received from NG-RAN during Xn handover procedure (see clause 5.2.2.8.2.16).
When present, this IE shall contain the User Plane Security Information associated to the PDU session. See clause 9.3.1.60 of 3GPP TS 38.413 [9]. | | +| amfNfld | NfInstanceId | C | 0..1 | This IE shall be present if it is received in the Update SM Context request.
When present, it shall contain the identifier of the serving AMF. | | +| guami | Guami | C | 0..1 | This IE shall be present if the amfNfld is present. When present, it shall contain the serving AMF's GUAMI. | | +| secondaryRatUsageDataReportContainer | array(SecondaryRatUsageDataReportContainer) | C | 1..N | The IE shall be present during an EPS to 5GS handover procedure, if one or more instance of Secondary RAT Usage Data Report IE(s) are present and applicable to the PDU session.

The V-/I-SMF may determine to pass or not the information to the (H-)SMF based on operator policy; if the V-/I-SMF determines to pass the information, the V-/I-SMF shall transparently forward this information to the (H-)SMF.

When present, it shall contain Base64-encoded characters, encoding the Secondary RAT Usage Data Report in the Forward Relocation Complete Acknowledge message, as specified in Figure 8.132-1 of 3GPP TS 29.274 [16] (starting from octet 1). | | +| smPolicyNotifyInd | boolean | C | 0..1 | This IE shall be included by I-SMF to SMF, if it is received from AMF and it is not previously provided to the SMF.

When present, this IE shall indicate that the SM Policy Association Establishment and Termination events shall be reported for the PDU session by the PCF for the SM Policy to the PCF for the UE:

- true: SM Policy Association Establishment and Termination events shall be reported

(NOTE 3) | SPAE | +| pcfUeCallbackInfo | PcfUeCallbackInfo | C | 0..1 | This IE shall be present when the smPolicyNotifyInd | SPAE | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

IE is present with value true.

When present, this IE shall contain the callback information of the PCF for the UE to receive SM Policy Association Establishment and Termination events notification from the PCF for the SM Policy.
(NOTE 3)

| | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------------------|-------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| satelliteBackhaulCat | SatelliteBackhaulCategory | C | 0..1 |

This IE shall be present if the V-SMF/I-SMF and the anchor SMF supports the 5GSAT feature and:

  • - the satelliteBackhaulCat IE has been received from the AMF and there is a change of the satelliteBackhaulCat IE compared to what has been signalled earlier to the (H-)SMF (as determined from the SmContext); or
  • - upon inter-AMF mobility (when a target AMF is taking over the control of the PDU session), the new AMF does not include the satelliteBackhaulCat IE and a satellite backhaul category had been signalled to the SMF (as determined from the SmContext).

When present, this IE shall indicate the value received from the AMF or, in the latter case, the value "NON_SATELLITE" to indicate that there is no longer any satellite backhaul towards the new 5G AN serving the UE.

| 5GSAT | +| maxIntegrityProtectedDataRateUl | MaxIntegrityProtectedDataRate | C | 0..1 |

This IE shall be present if received from the UE during PDU session modification procedure, see clause 4.3.3.2 of 3GPP TS 23.502 [3].

When present, it shall indicate the maximum integrity protected data rate supported by the UE for uplink. (NOTE 5)

| | +| maxIntegrityProtectedDataRateDl | MaxIntegrityProtectedDataRate | C | 0..1 |

This IE shall be present if received from the UE during PDU session modification procedure, see clause 4.3.3.2 of 3GPP TS 23.502 [3].

When present, it shall indicate the maximum integrity protected data rate supported by the UE for downlink. (NOTE 5)

| | +| upCnxState | UpCnxState | C | 0..1 |

This IE shall be present to indicate the User Plane resource establishment status in the I-SMF/V-SMF, if an Update or Create request is required to be sent to the (H-)SMF before the User Plane resource for the PDU session is established during a service request procedure for a PDU session with an I-SMF/V-SMF (see clause 4.23.4.2 and clause 4.23.4.3 of 3GPP TS 23.502 [3]).

When present, this IE shall be set as specified in clause 5.2.2.8.2.23.

| | +| ecsAddrConfigInfos | array(EcsAddrConfigInfo) | C | 1..N |

This IE shall be sent if the information is modified by the NEF.

When present, this IE shall replace any earlier received ECS Address Configuration Information Parameters in SMF.

| HR-SBO | +| hrsboInfo | HrsboInfoFromVplmn | C | 0..1 |

This IE shall be present in the following scenarios, for a HR PDU session, if the new V-SMF requests HR SBO authorization:

  • - V-SMF insertion (i.e. H-PLMN to V-PLMN mobility); and
  • - Inter-PLMN V-SMF change (i.e. mobility between different V-PLMNs).

This IE shall also be present, for a HR PDU session, if the HR-SBO information signaled earlier by the V-SMF to the H-SMF needs to be changed, e.g. to signal a new V-EASDF IP address upon a change of V-SMF.

When present, this IE shall include the information for HR-SBO as defined in clause 6.1.6.2.72.

| HR-SBO | + +| | | | | | | +|--------------------------------|---------------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| altSnssai | Snssai | C | 0..1 | This IE shall be present when the PDU Session is to be transferred to an alternative S-NSSAI.
When present, this IE shall indicate the alternative network slice to be used by the PDU session.
See clause 5.15.19 of 3GPP TS 23.501 [2]. | NSRP | +| disasterRoamingInd | boolean | O | 0..1 | This IE may be set if the V-SMF is indicated by the AMF that the UE is registered for Disaster Roaming service during a V-SMF change procedure. (NOTE 6)

When present, this IE shall be set as follows:

- true: the UE is registered for Disaster Roaming service | | +| pduSetSupportInd | boolean | C | 0..1 | This IE shall be included by I-SMF/V-SMF to SMF/H-SMF for a PDU session with an I-SMF or a Home-Routed PDU session if the support of the PDU Set based handling in the NG-RAN has been changed and during a V-SMF change.

(NOTE 7)

When present, this IE shall indicate whether the PDU Set based handling is supported by the NG-RAN:

- true: the PDU Set based handling is supported
- false: the PDU Set based handling is not supported | | +| ecnMarkingCongestionInfoStatus | array(EcnMarkingCongestionInfoStatus) | C | 1..N | This IE shall be present when the V/I-SMF receives the ECN Marking or Congestion Monitoring Reporting Status, e.g. during an PDU Session Establishment procedure.

When present, this IE shall contain a list of QoS flows with status for QoS monitoring for congestion information or for ECN marking for L4S. | | + +NOTE 1: In shared networks, the PLMN ID that is communicated in this IE shall be that of the selected Core Network Operator. + +NOTE 2: An SMF complying with this version of the specification should report secondary RAT usage using the secondaryRatUsageInfo attribute that replaces the secondaryRatUsageReport attribute. + +NOTE 3: If the smPolicyNotifyInd IE is received with the value "true", the SMF shall forward the callback information of the PCF for the UE to the PCF for SM Policy if exists via SM Policy Association Modification. See clause 4.3.3.2 of 3GPP TS 23.502 [3]. + +NOTE 4: The attribute name does not follow the naming conventions specified in 3GPP TS 29.501 [5]. The attribute name is kept though as defined in the current specification for backward compatibility reason. + +NOTE 5: The maxIntegrityProtectedDataRateUI and maxIntegrityProtectedDataRateDI IEs shall be ignored by the H-SMF or SMF if the Integrity protection maximum data rate in n1SmInfoFromUe IE is received. + +NOTE 6: The H-SMF shall determine that the UE is not registered for Disaster Roaming service if the disasterRoamingInd is not present during a V-SMF change procedure. + +NOTE 7: The (H-)SMF shall consider the PDU Set based handling is not supported if the pduSetSupportInd IE is absent during a V-SMF change. + +## 6.1.6.2.12 Type: HsmfUpdatedData + +**Table 6.1.6.2.12-1: Definition of type HsmfUpdatedData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------| +| n1SmInfoToUe | RefToBinaryData | C | 0..1 | This IE shall be present if the H-SMF/SMF needs to send N1 SM information to the UE that does not need to be interpreted by the V-SMF/I-SMF. When present, this IE shall reference the n1SmInfoToUe binary data (see clause 6.1.6.4.4). | | +| n4Info | N4Information | O | 0..1 | This IE may be present if the SMF needs to send N4 response information to the I-SMF (e.g. related with traffic usage reporting). | DTSSA | +| n4InfoExt1 | N4Information | O | 0..1 | This IE may be present if the SMF needs to send additional N4 response information to the I-SMF(e.g. related with traffic usage reporting). | DTSSA | +| n4InfoExt2 | N4Information | O | 0..1 | This IE may be present if the SMF needs to send additional N4 response information to the I-SMF (e.g. related with traffic usage reporting). | DTSSA | +| dnaiList | array(Dnai) | C | 1..N | This IE shall be present over N16a during UE Triggered Service Request procedure with I-SMF change, Xn based handover and Inter NG-RAN node N2 based handover with I-SMF change (see clauses 4.23.4.3, 4.23.11.3 and 4.23.7.3.3 in 3GPP TS 23.502 [3]).
When present, it shall include the DNAI(s) of interest for this PDU Session.

If the I-SMF and the SMF support the DTSSA-Ext1 feature, when present, this IE should include the full list of DNAIs of interest for PDU session, including DNAIs that may not be supported by the I-SMF and excluding the ones supported by the Anchor SMF. | DTSSA








DTSSA-Ext1 | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if the supportedFeatures IE was received in the request and at least one optional feature defined in clause 6.1.8 is supported by the updated PDU session resource. | | +| roamingChargingProfile | RoamingChargingProfile | O | 0..1 | This IE may be present during an inter-PLMN V-SMF change (including the inter-PLMN mobility from HPLMN with I-SMF to VPLMN). When present, it shall contain the Roaming Charging Profile selected by the HPLMN (see clauses 5.1.9.1, 5.2.1.7 and 5.2.2.12.2 of 3GPP TS 32.255 [25]). | | +| homeProvidedChargingId | string | C | 0..1 | When present, this IE shall contain the Home provided Charging ID (see 3GPP TS 32.255 [25]).
This IE shall be present during a HPLMN to VPLMN mobility of a PDU session with I-SMF in HPLMN.

The string shall encode the Charging ID (32-bit unsigned integer value, with maximum value "4294967295") in decimal representation.

Pattern: '^0([1-9]{1}[0-9]{0,9})\$'

(NOTE 3, NOTE 4) | DTSSA | +| homeProvidedSmfChargingId | SmfChargingId | C | 0..1 | When present, this IE shall contain the Home provided String based Charging ID (see 3GPP TS 32.255 [25]).

This IE shall be present during a HPLMN to VPLMN mobility of a PDU session with I-SMF in HPLMN, if both the V-SMF and the H-SMF support the "SCID" feature. This IE shall also be included when the V-SMF changes, if the new V-SMF supports the "SCID" feature.

(NOTE 5) | DTSSA, SCID | +| ipv6MultiHomingInd | boolean | C | 0..1 | This IE shall be present over N16a, if available and an I-SMF has been changed during the following | DTSSA | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

procedures: Registration, Service Request, Xn based handover, Inter NG-RAN node N2 based handover (see clause 4.23 of 3GPP TS 23.502 [3]).

When present, it shall be set as follows:

  • - true: IPv6 multi-homing is permitted.
  • - false (default): IPv6 multi-homing is not allowed.
| | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | +|---------------------------------|-------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| upSecurity | UpSecurity | C | 0..1 |

This IE shall be present if the "upSecurityInfo" IE was received in the request (i.e. during an Xn handover), and there is a mismatch between security policy received and stored (see clause 5.2.2.8.2.16). When present, this IE shall indicate the security policy for integrity protection and encryption for the user plane of the PDU session.

This IE may be present during a handover from non-3GPP access to 3GPP access, to indicate the security policy for integrity protection and encryption for the user plane of the PDU session in the target access type.

This IE may be present when UE Integrity Protection Maximum Data Rate was received in the request, during a UE triggered PDU session modification procedure.

(NOTE 1, NOTE 2)

| +| maxIntegrityProtectedDataRateUI | MaxIntegrityProtectedDataRate | C | 0..1 |

This IE shall be present if the upSecurity IE is present and indicates that integrity protection is preferred or required. When present, it shall indicate the maximum integrity protected data rate supported by the UE for uplink. (NOTE 1)

| +| maxIntegrityProtectedDataRateDI | MaxIntegrityProtectedDataRate | C | 0..1 |

This IE shall be present if the upSecurity IE is present and indicates that integrity protection is preferred or required. When present, it shall indicate the maximum integrity protected data rate supported by the UE for downlink. (NOTE 1)

| +| qosFlowsSetupList | array(QosFlowSetupItem) | C | 1..N |

This IE shall be present during a handover between 3GPP and non-3GPP accesses. When present, it shall contain the set of QoS flow(s) to establish for the PDU session for the target access type. (NOTE 1)

| +| sessionAmbr | Ambr | C | 0..1 |

This IE shall be present during a handover between 3GPP and non-3GPP accesses. When present, this IE shall contain the Session AMBR authorized for the PDU session for the target access type. (NOTE 1)

| +| epsPdnCnxInfo | EpsPdnCnxInfo | C | 0..1 |

This IE shall be present during a handover from non-3GPP access to 3GPP access, if the PDU session may be moved to EPS during its lifetime. (NOTE 1)

The IE shall also be included when the EPS PDN Connection Context Information of the PDU session is changed, e.g. due to reselection of anchor SMF.

| +| epsBearerInfo | array(EpsBearerInfo) | C | 1..N |

This IE shall be present during a handover from non-3GPP access to 3GPP access, if the PDU session may be moved to EPS during its lifetime. When present, it shall include the complete epsBearerInfo IE(s) for all EBIs. (NOTE 1)

| +| pti | ProcedureTransactionId | C | 0..1 |

This IE shall be present during a handover between 3GPP and non-3GPP accesses. When present, it shall contain the PTI value received in the corresponding request.

| +| interPlmnApiRoot | Uri | C | 0..1 |

This IE should be present if the information has changed. When present, it shall contain the apiRoot of the PDU session context to be used in inter-PLMN signalling request targeting the PDU session context.

| +| intraPlmnApiRoot | Uri | C | 0..1 |

This IE should be present if the information has

| + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| | | | |

changed. When present, it shall contain the apiRoot of the PDU session context to be used in intra-PLMN signalling request targeting the PDU session context.

| | +| hrsboInfo | HrsboInfoFromHplmn | C | 0..1 |

This IE shall be present in the following scenarios if the H-SMF supports the HR-SBO feature and if it receives a request for HR-SBO authorization in the Update request:

  • - V-SMF insertion (i.e. H-PLMN to V-PLMN mobility); and
  • - Inter-PLMN V-SMF change (i.e. mobility between different V-PLMNs).

This IE shall also be present, for a HR PDU session, if the HR-SBO information signaled earlier by the H-SMF to the V-SMF needs to be changed, e.g. to signal a new Home DNS Server address.

When present, this IE shall include the information for HR-SBO as defined in clause 6.1.6.2.73.

The absence of this IE in an Update response when the Update request includes a request for HR SBO authorization shall be interpreted as indicating that HR-SBO is not allowed.

| HR-SBO | +|

NOTE 1: During a handover between 3GPP and non-3GPP accesses, the V-SMF or I-SMF shall delete any corresponding information received earlier for the source access type and use the new information received for the target access type.

NOTE 2: During inter-system mobility from EPS to 5GS, the UE Integrity Protection Maximum Data Rate is not available at the SMF during PDU Session Creation. The UE will provide UE Integrity Protection Maximum Data Rate to the network within a subsequent UE triggered PDU session modification procedure, as specified in clause 4.3.3.2 of 3GPP TS 23.502 [3].

NOTE 3: The chargingId IE in SmContext (see clause 6.1.6.2.39) shall be set to the value received in the homeProvidedChargingId IE during a HPLMN to VPLMN mobility of a PDU session with I-SMF in HPLMN.

NOTE 4: Usage of Charging ID with Uint32 value for roaming scenarios may lead to Charging ID collision between SMFs.

NOTE 5: The smfChargingId IE in SmContext (see clause 6.1.6.2.39) shall be set to the value in the homeProvidedSmfChargingId IE if received from the H-SMF.

| | | | | | + +## 6.1.6.2.13 Type: ReleaseData + +Table 6.1.6.2.13-1: Definition of type ReleaseData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| cause | Cause | C | 0..1 | This IE shall be present, if the information is available. When present, this IE shall indicate the NF Service Consumer cause for the requested PDU session release. | | +| ngApCause | NgApCause | C | 0..1 | The V-SMF or I-SMF shall include this IE, if it is available and, for a HR PDU session, if this information is permitted to be sent to the H-SMF operator according to the V-SMF operator's policy. When present, this IE shall indicate the NGAP cause for the requested PDU session release. | | +| 5gMmCauseValue | 5GMmCause | C | 0..1 | The V-SMF or I-SMF shall include this IE if it received it from the AMF and, for a HR PDU session, if this information is permitted to be sent to the H-SMF operator according to the V-SMF operator's policy. | | +| ueLocation | UserLocation | C | 0..1 | This IE shall be present, if available. When present, it shall contain the UE location information (see clause 5.2.3.4). | | +| ueTimeZone | TimeZone | C | 0..1 | This IE shall be present, if available. When present, it shall contain the UE Time Zone. | | +| addUeLocation | UserLocation | O | 0..1 | Additional UE location.
This IE may be present, if anType previously reported is a non-3GPP access and a valid 3GPP access user location information is available.
When present, it shall contain:
  • - the last known 3GPP access user location (see clause 5.2.3.4); and
  • - the timestamp, if available, indicating the UTC time when the addUeLocation information was acquired.
| | +| secondaryRatUsageReport | array(SecondaryRatUsageReport) | O | 1..N | This IE may be present to report usage data for a secondary RAT for QoS flows.
(NOTE) | | +| secondaryRatUsageInfo | array(SecondaryRatUsageInfo) | O | 1..N | This IE may be present to report usage data for a secondary RAT for QoS flows and/or the whole PDU session. | | +| n4Info | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send N4 information (e.g. traffic usage reporting) to the SMF for traffic offloaded at a PSA controlled by an I-SMF. | DTSSA | +| n4InfoExt1 | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send additional N4 information (e.g. traffic usage reporting) to the SMF for traffic offloaded at a PSA controlled by an I-SMF. | DTSSA | +| n4InfoExt2 | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send additional N4 information (e.g. traffic usage reporting) to the SMF for traffic offloaded at a PSA controlled by an I-SMF. | DTSSA | + +NOTE: An SMF complying with this version of the specification should report secondary RAT usage using the secondaryRatUsageInfo attribute that replaces the secondaryRatUsageReport attribute. + +## 6.1.6.2.14 Type: HsmfUpdateError + +**Table 6.1.6.2.14-1: Definition of type HsmfUpdateError** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| error | ProblemDetails | M | 1 | More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure. | +| pti | ProcedureTransactionId | C | 0..1 | This IE shall be present if this is a response sent to a UE requested PDU session modification. When present, it shall contain the PTI value received in the corresponding request. | +| n1smCause | string | C | 0..1 | This IE shall be present if the request included n1SmInfoFromUe.
When present, it shall contain the 5GSM cause the H-SMF or SMF proposes the V-SMF or I-SMF to return to the UE. It shall be encoded as two characters in hexadecimal representation with each character taking a value of "0" to "9" or "A" to "F", and represent the cause value of the 5GSM cause IE specified in clause 9.11.4.2 of 3GPP TS 24.501 [7].

Pattern: "^[A-F0-9]{2}\$"

Example: the cause "Invalid mandatory information" shall be encoded as "60".
See NOTE. | +| n1SmInfoToUe | RefToBinaryData | C | 0..1 | This IE shall be present if the H-SMF or SMF needs to send N1 SM information to the UE that does not need to be interpreted by the V-SMF or I-SMF. When present, this IE shall reference the n1SmInfoToUe binary data (see clause 6.1.6.4.4). | +| backOffTimer | DurationSec | O | 0..1 | When present, this IE shall indicate a Back-off timer value, in seconds, that the V-SMF or I-SMF may use when rejecting the NAS message towards the UE. | +| recoveryTime | DateTime | O | 0..1 | Timestamp (in UTC) when the H-SMF or SMF service instance was (re)started (see clause 6.3 of 3GPP TS 23.527 [24]). | + +NOTE: This IE contains information that the V-SMF or I-SMF shall transfer to the UE without interpretation. It is sent as a separate IE rather than within the n1SmInfoToUe binary data because the 5GSM cause IE is defined as a "V" IE (i.e. without a Type field) in the NAS PDU Session Modification Reject message. + +## 6.1.6.2.15 Type: VsmfUpdateData + +**Table 6.1.6.2.15-1: Definition of type VsmfUpdateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| requestIndication | RequestIndication | M | 1 | This IE shall indicate the request type. | | +| sessionAmbr | Ambr | C | 1 | This IE shall be present if the Session AMBR authorized for the PDU session is modified. When present, it shall contain the new Session AMBR authorized for the PDU session. | | +| qosFlowsAddModRequestList | array(QosFlowAddModifyRequestItem) | C | 1..N | This IE shall be present if QoS flows are requested to be established or modified. | | +| qosFlowsRelRequestList | array(QosFlowReleaseRequestItem) | C | 1..N | This IE shall be present if QoS flows are requested to be released. | | +| epsBearerInfo | array(EpsBearerInfo) | C | 1..N | This IE shall be present if the PDU session may be moved to EPS during its lifetime and the ePSBearerInfo has changed. When present, it shall only include epsBearerInfo IE(s) for new EBI or for EBIs for which the epsBearerInfo has changed. The complete epsBearerInfo shall be provided for an EBI that is included (i.e. the epsBearerInfo newly received for a given EBI replaces any epsBearerInfo previously received for this EBI). | | +| assignEbiList | array(Arp) | C | 1..N | This IE shall be present if the H-SMF requests EBIs to be assigned. | | +| revokeEbiList | array(EpsBearerId) | C | 1..N | This IE shall be present if the H-SMF/SMF requests the V-SMF/I-SMF to revoke some EBI(s). When present, it shall contain the EBIs to revoke. | | +| modifiedEbiList | array(EbiArpMapping) | C | 1..N | This IE shall be present if a PDU session modification procedure resulted in the change of ARP for a QoS flow that was already allocated an EBI. | | +| pti | ProcedureTransactionId | C | 0..1 | This IE shall be present if the request is sent in response to a UE requested PDU session modification or release. When present, it shall contain the PTI value received in the corresponding request. | | +| n1SmInfoToUe | RefToBinaryData | C | 0..1 | This IE shall be present if the H-SMF/SMF needs to send N1 SM information to the UE that does not need to be interpreted by the V-SMF/I-SMF. When present, this IE shall reference the n1SmInfoToUe binary data (see clause 6.1.6.4.4). | | +| alwaysOnGranted | boolean | C | 0..1 | This IE shall be present if:
  • - an alwaysOnRequested IE was received in an earlier V-SMF/I-SMF initiated Update request to change the PDU session to an always-on PDU session; or
  • - the H-SMF/SMF determines, based on local policy, that the PDU session needs to be established as an always-on PDU session.
When present, it shall be set as follows:
  • - true: always-on PDU session granted.
  • - false (default): always-on PDU session not granted.
| | +| hsmfPduSessionUri | Uri | C | 0..1 | This IE shall be included if:
  • - an Update Request is sent to the V-SMF/I-SMF before the Create Response (e.g. for EPS bearer ID allocation as specified in clause 4.11.1.4.1 of 3GPP TS 23.502 [3], or for Secondary authorization/authentication as specified in clause 4.3.2.3 of 3GPP TS 23.502 [3]), and
  • - the H-SMF PDU Session Resource URI has not been previously provided to the V-SMF/I-
| | + +| | | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

SMF.

This IE shall not be included otherwise.

When present, this IE shall include the URI representing the PDU session resource in the H-SMF.

| | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|------------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| newSmfId | NfInstanceId | C | 0..1 | This IE may be present if the anchor SMF has changed and the SMF Instance ID of the new anchor SMF has not been already signalled to the I-SMF or V-SMF.
When present, it shall carry the NF instance identifier of the new anchor SMF handling the PDU session. | | +| newSmfPduSessionUri | Uri | C | 0..1 | This IE shall be present if the newSmfId is present. When present, it shall carry the URI representing the updated PDU session resource in the new anchor SMF. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if "hsmfPduSessionUri" IE is present and at least one optional feature defined in clause 6.1.8 is supported. | | +| cause | Cause | O | 0..1 | When present, this IE shall indicate the cause for the requested modification. | | +| n1smCause | string | O | 0..1 | When present, this IE shall contain the 5GSM cause the H-SMF proposes the V-SMF/I-SMF to send to the UE. It shall be encoded as two characters in hexadecimal representation with each character taking a value of "0" to "9" or "A" to "F", and represent the cause value of the 5GSM cause IE specified in clause 9.11.4.2 of 3GPP TS 24.501 [7].
Example: the cause "Invalid mandatory information" shall be encoded as "60".
See NOTE. | | +| backOffTimer | DurationSec | O | 0..1 | When present, this IE shall indicate a Back-off timer value, in seconds, that the V-SMF/I-SMF may use when sending the NAS message (PDU Session Release Command) towards the UE. | | +| maReleaseInd | MaReleaseIndication | C | 0..1 | This IE shall be present if one access of a MA PDU session is to be released, when H-SMF or SMF initiates MA PDU session release over one access. When present, it shall indicate the access requested to be released. | MAPDU | +| maAcceptedInd | boolean | C | 0..1 | This IE shall be present if a request to modify a single access PDU session into a MA PDU session was accepted (see clause 4.22.6.3 of 3GPP TS 23.502 [3]).
When present, it shall be set as follows:

- true: MA PDU session

- false (default): single access PDU session | MAPDU | +| additionalCnTunnelInfo | TunnelInfo | C | 0..1 | This IE shall be present for a MA-PDU session if the UE requested to establish resources for a MA PDU session over the other access. When present, it shall contain additional N9 tunnel information of the UPF controlled by the H-SMF or SMF. | MAPDU | +| dnaiList | array(Dnai) | C | 0..N | This IE shall be present if received from PCF during I-SMF Related Procedures with PCF (see clause 4.23.6.2 in 3GPP TS 23.502 [3]).
When present, the IE shall include a list of DNAI(s) the SMF deems relevant for the PDU Session.

If the I-SMF and the SMF support the DTSSA-Ext1 feature, when present, this IE should include the full list of DNAIs of interest for PDU session, including DNAIs that may not be supported by the I-SMF and excluding the ones supported by the Anchor SMF.

If this IE is not present, the I-SMF shall consider that the dnaiList has not changed. If there is no more DNAI of interest for the PDU session, the dnaiList attribute shall be present and be encoded as an empty array. | DTSSA

DTSSA-Ext1 | +| n4Info | N4Information | O | 0..1 | This IE may be present if the SMF needs to send N4 | DTSSA | + +| | | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------|--| +| | | | | information to the I-SMF for the control of traffic offloaded at a PSA/BP/ULCL controlled by an I-SMF. | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-----------------------------|--------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| n4InfoExt1 | N4Information | O | 0..1 | This IE may be present if the SMF needs to send additional N4 information to the I-SMF for the control of traffic offloaded at a PSA/BP/ULCL controlled by an I-SMF. | DTSSA | +| n4InfoExt2 | N4Information | O | 0..1 | This IE may be present if the SMF needs to send additional N4 information to the I-SMF for the control of traffic offloaded at a PSA/BP/ULCL controlled by an I-SMF (e.g. during a change of PSA). | DTSSA | +| n4InfoExt3 | N4Information | O | 0..1 | This IE may be present if the SMF needs to send additional N4 information to the I-SMF for the control of traffic offloaded at a PSA/BP/ULCL controlled by an I-SMF (e.g. during simultaneous change of BP/ULCL and PSA). | SCPBU | +| smallDataRateControlEnabled | boolean | C | 0..1 | This IE shall be present if the applicability of small data rate control on the PDU session changes.

When present, it shall be set as follows:
- true: small data rate control is applicable.
- false: small data rate control is not applicable. | CIOT | +| qosMonitoringInfo | QosMonitoringInfo | C | 0..1 | This IE may be present if QoS monitoring has been activated for at least one QoS flow of the PDU session (see the qosMonitoringReq attribute in clause 6.1.6.2.22). | DTSSA | +| epsPdnCnxInfo | EpsPdnCnxInfo | C | 0..1 | This IE shall be present if the PDU session may be moved to EPS during its lifetime and the EpsInterworkingIndication is changed to "WITH_N26".

The IE shall also be present when the EPS PDN Connection Context Information of the PDU session is changed, e.g. due to change of anchor SMF. | | +| n9DataForwardingInd | boolean | C | 0..1 | This IE shall be present and set as specified in clauses 4.23.9.4 and 4.23.9.5 of 3GPP TS 23.502 [3] during simultaneous change of Branching Points or UL CLs controlled by I-SMF or controlled by different I-SMFs.
When present, it shall be set as follows:
- true: setup N9 forwarding tunnels between Branching Points or UL CLs;

- false (default): N9 forwarding tunnels between Branching Points or UL CLs are not required to be setup (see clauses 5.2.2.8.3.6 and 5.2.2.8.3.10). | N9FSC | +| n9InactivityTimer | DurationSec | O | 0..1 | When present, this IE shall indicate an inactivity detection timer, in seconds, that the I-SMF may use to set the N9 forwarding tunnel inactive traffic detection timer in Branching Point or UL CL as specified in clauses 4.23.9.4 and 4.23.9.5 of 3GPP TS 23.502 [3]. | N9FSC | +| hrsboInfo | HrsboInfoFromHplmn | O | 0..1 | This IE may be present if the H-SMF and the V-SMF supports the HR-SBO feature and if the H-SMF needs to update the HR-SBO information towards the V-SMF, e.g. due to a change of the user subscription data or policy information.

When present, this IE shall include the complete information for HR-SBO as defined in clause 6.1.6.2.73 and the V-SMF shall replace any earlier received HR-SBO information by the new HR-SBO information. | HR-SBO | +| altHplmnSnssai | Snssai | C | 0..1 | This IE shall be present for a HR PDU session if the H-SMF determines to retain the PDU session for the alternative HPLMN S-NSSAI, during network slice replacement. | NSRP | + +| | | | | | | +|-----------------------|--------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| | | | | When present, this IE shall indicate the alternative HPLMN S-NSSAI to be used by the HR PDU session.

See clause 5.15.19 of 3GPP TS 23.501 [2]. | | +| pduSessionRetainInd | boolean | C | 0..1 | This IE shall be present and set to true, if the H-SMF determines to retain the PDU session for the alternative HPLMN S-NSSAI during network slice replacement.

When present with true value, this IE indicates the PDU session is retained for the alternative HPLMN S-NSSAI.
Present with false value shall be prohibited.

See clause 4.3.3.3 of 3GPP TS 23.502 [3]. | NSRP | +| pendingUpdateInfoList | array(PendingUpdateInfo) | O | 0..N | When present, this IE shall indicate the updated list of information that are not required to be updated in real-time to the (H-)SMF, i.e. the change of the listed information (e.g. UE location or Timezone) may be piggybacked in a subsequent essential update (e.g. to exchange the N1 message from the UE) to the (H-)SMF. The NF service consumer (i.e. I-SMF/V-SMF) should not trigger an Update to the (H-)SMF including only the change(s) of the listed information.

When present, the NF service consumer (i.e. I-SMF/V-SMF) shall replace any pendingUpdateInfoList received earlier by the new information received in this IE. | | + +NOTE: This IE contains information that the V-SMF shall transfer to the UE without interpretation. It is sent as a separate IE rather than within the n1SmInfoToUE binary data because the 5GSM cause IE is defined as a "V" IE (i.e. without a Type field) in the NAS PDU Session Release Command message. + +6.1.6.2.16 Type: VsmfUpdatedData + +**Table 6.1.6.2.16-1: Definition of type VsmfUpdatedData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| qosFlowsAddModList | array(QosFlowItem) | C | 1..N | This IE shall be present if QoS flows have been successfully established or modified. For each GBR QoS flow, the V-SMF/I-SMF may also indicate an alternative QoS profile which the NG-RAN currently fulfils in the currentQosProfileIndex IE or indicate that the NG-RAN cannot even fulfil the lowest alternative QoS profile. | | +| qosFlowsRelList | array(QosFlowItem) | C | 1..N | This IE shall be present if QoS flows have been successfully released. | | +| qosFlowsFailedtoAddModList | array(QosFlowItem) | C | 1..N | This IE shall be present if QoS flows failed to be established or modified. | | +| qosFlowsVsmfRejectedAddModList | array(Qfi) | O | 1..N | This IE may be present from V-SMF to H-SMF when the qosFlowsFailedtoAddModList IE is present.

When present, this IE shall include the QFIs of the QoS flows failed to be established or modified due to rejection by the V-SMF.

When the H-SMF subsequently send N1 Message to the UE to revert the update of QoS rules and QoS Flow level QoS parameters associated with the failed QoS Flow(s) indicated in the qosFlowsFailedtoAddModList IE, the H-SMF should exclude the QoS flow(s) that were failed to be established or modified due to rejection by the V-SMF. If all the failed QoS flow(s) were due to rejection by the V-SMF, the H-SMF should skip the subsequent N1 message update to the UE. | | +| qosFlowsFailedtoRelList | array(QosFlowItem) | C | 1..N | This IE shall be present if QoS flows failed to be released. | | +| n1SmInfoFromUe | RefToBinaryData | C | 0..1 | This IE shall be present if the V-SMF/I-SMF has received known N1 SM information from the UE that does not need to be interpreted by the V-SMF/I-SMF. When present, this IE shall reference the n1SmInfoFromUe binary data (see clause 6.1.6.4.4). | | +| unknownN1SmInfo | RefToBinaryData | C | 0..1 | This IE shall be present if the V-SMF/I-SMF has received unknown N1 SM information from the UE. When present, this IE shall reference the unknownN1SmInfo binary data (see clause 6.1.6.4.4). | | +| ueLocation | UserLocation | C | 0..1 | This IE shall be present if it is available and QoS flows have been successfully established, modified or released. When present, this IE shall contain the UE location information (see clause 5.2.3.4). | | +| ueTimeZone | TimeZone | C | 0..1 | This IE shall be present if it is available and QoS flows have been successfully established, modified or released. When present, this IE shall contain the new UE Time Zone. | | +| addUeLocation | UserLocation | O | 0..1 | Additional UE location.
This IE may be present, if anType previously reported is a non-3GPP access and a valid 3GPP access user location information is available.
When present, it shall contain:
  • - the last known 3GPP access user location (see clause 5.2.3.4); and
  • - the timestamp, if available, indicating the UTC time when the addUeLocation information was acquired.
| | +| assignedEbiList | array(EbiArpMapping) | C | 1..N | This IE shall be present if the AMF assigned the requested EBI(s). When present, it shall contain the EBIs that were successfully assigned. | | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| failedToAssignEbiList | array(Arp) | C | 1..N | This IE shall be present if the AMF failed to assign EBIs for a set of ARPs. | | +| releasedEbiList | array(EpsBearerId) | C | 1..N | This IE shall be present if the NF Service Consumer requested the revoke EBI(s) or if the AMF revoked already assigned EBI(s) for this PDU session towards the V-SMF. This IE shall contain the list of EBI(s) released for this PDU session at the AMF. | | +| secondaryRatUsageReport | array(SecondaryRatUsageReport) | O | 1..N | This IE may be present to report usage data for a secondary RAT for QoS flows.
(NOTE) | | +| secondaryRatUsageInfo | array(SecondaryRatUsageInfo) | O | 1..N | This IE may be present to report usage data for a secondary RAT for QoS flows and/or the whole PDU session. | | +| n4Info | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send N4 response information to the SMF for the control of traffic offloaded at a PSA/BP/ULCL controlled by an I-SMF. | DTSSA | +| n4InfoExt1 | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send additional N4 response information to the SMF for the control of traffic offloaded at a PSA/BP/ULCL controlled by an I-SMF. | DTSSA | +| n4InfoExt2 | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send additional N4 response information to the SMF for the control of traffic offloaded at a PSA/BP/ULCL controlled by an I-SMF (e.g. during a change of PSA). | DTSSA | +| n4InfoExt3 | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send additional N4 response information to the SMF for the control of traffic offloaded at a PSA/BP/ULCL controlled by an I-SMF (e.g. during simultaneous change of BP/ULCL and PSA). | SCPBU | +| modifiedEbiListNotDelivered | boolean | C | 0..1 | This IE should be present with the value true when the modifiedEbiList IE was received in VsmfUpdateData in request but cannot be updated to the AMF, e.g., during (H-)SMF triggered PDU session modification procedure and the AMF doesn't support the EAEA feature.

When present, the IE shall be set as following:
- true: the received modifiedEbiList was not delivered to the AMF.
- false: the received modifiedEbiList was delivered to the AMF.

Absence of this IE means whether modifiedEbiList was delivered or not is unknown. | | +| ecnMarkingCongestionInfoStatus | array(EcnMarkingCongestionInfoStatus) | C | 1..N | This IE shall be present when the V/I-SMF receives the ECN Marking or Congestion Monitoring Reporting Status, e.g. during an PDU Session Modification procedure.

When present, this IE shall contain a list of QoS flows with status for QoS monitoring for congestion information or for ECN marking for L4S. | | +| NOTE: An SMF complying with this version of the specification should report secondary RAT usage using the secondaryRatUsageInfo attribute that replaces the secondaryRatUsageReport attribute. | | | | | | + +6.1.6.2.17 Type: StatusNotification + +**Table 6.1.6.2.17-1: Definition of type StatusNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| statusInfo | StatusInfo | M | 1 | This IE shall contain status information about the PDU session. | | +| smallDataRateStatuses | SmallDataRateStatus | C | 0..1 | This IE shall be present, if the NF Service Consumer has indicated support of CIoT and if the status is available.
When present, it shall indicate the current small data rate control status for the PDU session. | CIoT | +| apnRateStatus | ApnRateStatus | C | 0..1 | This IE shall be present, if the NF Service Consumer has indicated support of CIoT and if the status is available.
When present, it shall indicate the current APN rate control status for the PDN connection (APN rates are shared by all PDN connections of the UE to this APN). | CIoT | +| targetDnailInfo | TargetDnailInfo | C | 0..1 | This IE shall be present if the I-SMF selection or removal for the current PDU session, or SMF selection during PDU Session re-establishment for SSC mode 2/3 is needed.
When present, this IE shall include the target DNAIL Information. | EnEDGE | +| oldPduSessionRef | Uri | C | 0..1 | This IE shall be present if resourceStatus in statusInfo is "UNCHANGED", the SMF selection during PDU Session re-establishment for SSC mode 3 is needed and the runtime coordination between old SMF and AF is enabled.
When present, this IE shall contain the URI of the PDU session resource in the old SMF. The URI shall be an absolute URI, including apiRoot (see clause 6.1.3.6.2). | EnEDGE | +| newSmfId | NfInstanceId | C | 0..1 | This IE may be present if the resourceStatus attribute in statusInfo is set to "UPDATED" and the cause IE in statusInfo is set to "CHANGED_ANCHOR_SMF". When present, it shall include the NF instance identifier of the new H-SMF or SMF (for a PDU session with an I-SMF) handling the PDU session, when it is changed within an SMF set. | ES3XX | +| epsPdnCnxInfo | EpsPdnCnxInfo | C | 0..1 | This IE shall be present when the EPS PDN Connection Context Information of the PDU session is changed, e.g. due to change of anchor SMF.

When present, this IE shall include the EPS PDN Connection Context Information of the PDU session on the new anchor SMF. | ES3XX | +| interPlmnApiRoot | Uri | C | 0..1 | This IE should be present if the information has changed and, within the statusInfo IE, the resourceStatus IE is set to "UPDATED" and the cause IE set to "CHANGED_ANCHOR_SMF".

When present, it shall contain the apiRoot of the PDU session context to be used in inter-PLMN signalling request targeting the PDU session context. | | +| intraPlmnApiRoot | Uri | C | 0..1 | This IE should be present if the information has changed and, within the statusInfo IE, the resourceStatus IE is set to "UPDATED" and the cause IE set to "CHANGED_ANCHOR_SMF".

When present, it shall contain the apiRoot of the PDU session context to be used in intra-PLMN signalling request targeting the PDU session context. | | + +## 6.1.6.2.18 Type: QosFlowItem + +**Table 6.1.6.2.18-1: Definition of type QosFlowItem** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| qfi | Qfi | M | 1 | This IE shall contain the QoS Flow Identifier. | +| cause | Cause | O | 0..1 | When present, this IE shall contain cause information. | +| currentQosProfileIndex | Integer | C | 0..1 | When present, this IE shall indicate the index of the currently fulfilled alternative QoS profile. This IE shall not be present if the nullQoSProfileIndex IE is present. | +| nullQoSProfileIndex | boolean | C | 0..1 | This IE shall be present and set to "true" if the NG-RAN cannot even fulfil the lowest alternative QoS profile. This IE shall not be present if the currentQosProfileIndex IE is present. | +| ngApCause | NgApCause | C | 0..1 | The V-SMF or I-SMF shall include this IE if it is available and, for a HR PDU session, if this information is permitted to be sent to the H-SMF operator according to the V-SMF operator's policy. When present, this IE shall indicate the NGAP cause for the requested QoS Flow setup or modification failure. | + +## 6.1.6.2.19 Type: QosFlowSetupItem + +Table 6.1.6.2.19-1: Definition of type QosFlowSetupItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| qfi | Qfi | M | 1 | This IE shall contain the QoS Flow Identifier. | | +| qosRules | Bytes | M | 1 | This IE shall contain the QoS Rule(s) associated to the QoS flow to be sent to the UE. It shall be encoded as the Qos rules IE specified in clause 9.11.4.13 of 3GPP TS 24.501 [7] (starting from octet 4). | | +| ebi | EpsBearerId | C | 0..1 | This IE shall be included when an EPS Bearer ID is allocated for the QoS Flow for interworking with EPS. When present, this IE shall contain the allocated EPS Bearer ID. | | +| qosFlowDescription | Bytes | O | 0..1 | When present, this IE shall contain the description of the QoS Flow level Qos parameters to be sent to the UE. It shall be encoded as the Qos flow descriptions IE specified in clause 9.11.4.12 of 3GPP TS 24.501 [7] (starting from octet 1), encoding one single Qos flow description for the QoS flow to be set up. | | +| qosFlowProfile | QosFlowProfile | O | 0..1 | When present, this IE shall contain the description of the QoS Flow level Qos parameters. | | +| associatedAnType | QosFlowAccessType | O | 0..1 | This IE may be present if the QoS Flow belongs to MA PDU session. When present, this IE shall contain the indicated access type associated with the QoS Flow. | MAPDU | +| defaultQosRuleInd | boolean | C | 0..1 | This IE shall be present if available.

When present, it shall be set as follows:
- true: QoS Flow is associated with the default QoS Rule.

- false: QoS Flow is not associated with the default QoS Rule.

(NOTE) | | +| ecnMarkingCongestionInfoReq | EcnMarkingCongestionInfoReq | O | 0..1 | When present, this IE shall indicate that ECN marking for the L4S or QoS monitoring for congestion information is requested in the NG-RAN. | | + +NOTE: Anchor SMF implementations complying with earlier versions of the specification may not support setting this Indication. If the attribute is absent, the I-SMF or V-SMF can determine whether the QoS Rule is the default QoS Rule by decoding the available qosRules IE. The absence of the attribute shall not be interpreted as meaning that the QoS flow is not associated with the default QoS Rule. + +## 6.1.6.2.20 Type: QosFlowAddModifyRequestItem + +Table 6.1.6.2.20-1: Definition of type QosFlowAddModifyRequestItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| qfi | Qfi | M | 1 | This IE shall contain the QoS Flow Identifier. | | +| ebi | EpsBearerId | C | 0..1 | This IE shall be included when the EPS Bearer ID associated with a QoS Flow is modified. When present, this IE shall contain the EPS Bearer ID. | | +| qosRules | Bytes | O | 0..1 | When present, this IE shall contain the QoS Rule(s) to be sent to the UE. It shall be encoded as the Qos rules IE specified in clause 9.11.4.13 of 3GPP TS 24.501 [7] (starting from octet 4). | | +| qosFlowDescription | Bytes | O | 0..1 | When present, this IE shall contain the description of the QoS Flow level Qos parameters to be sent to the UE. It shall be encoded as the Qos flow descriptions IE specified in clause 9.11.4.12 of 3GPP TS 24.501 [7] (starting from octet 1), encoding one single Qos flow description for the QoS flow to be added or modified. | | +| qosFlowProfile | QosFlowProfile | O | 0..1 | When present, this IE shall contain the description of the QoS Flow level QoS parameters. When modifying a QoS flow, the IE shall only contain the QoS Flow profile's attributes which are modified. | | +| associatedAnType | QosFlowAccessType | O | 0..1 | This IE may be present if the QoS Flow belongs to MA PDUsession. When present, this IE shall contain the indicated access type associated with the QoS Flow. | MAPDU | +| ecnMarkingCongestionInfoReq | EcnMarkingCongestionInfoReq | O | 0..1 | When present, this IE shall indicate that ECN marking for the L4S or QoS monitoring for congestion information is requested in the NG-RAN. | | +| tscaiUl | TscAssistanceInformation | O | 0..1 | When present, this IE shall indicate TSCAI input parameters at the uplink flow direction. | | +| tscaiDl | TscAssistanceInformation | O | 0..1 | When present, this IE shall indicate TSCAI input parameters at the downlink flow direction. | | + +## 6.1.6.2.21 Type: QosFlowReleaseRequestItem + +Table 6.1.6.2.21-1: Definition of type QosFlowReleaseRequestItem + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| qfi | Qfi | M | 1 | This IE shall contain the QoS Flow Identifier. | +| qosRules | Bytes | O | 0..1 | When present, this IE shall contain the QoS Rule(s) to be sent to the UE. It shall be encoded as the Qos rules IE specified in clause 9.11.4.13 of 3GPP TS 24.501 [7] (starting from octet 4). | +| qosFlowDescription | Bytes | O | 0..1 | When present, this IE shall contain the description of the QoS Flow level Qos parameters to be sent to the UE. It shall be encoded as the Qos flow descriptions IE specified in clause 9.11.4.12 of 3GPP TS 24.501 [7] (starting from octet 1), encoding one single Qos flow description for the QoS flow to be released. | + +## 6.1.6.2.22 Type: QosFlowProfile + +**Table 6.1.6.2.22-1: Definition of type QosFlowProfile** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5qi | 5Qi | M | 1 | This IE shall contain the 5G QoS Identifier (5QI) of the QoS flow. | +| nonDynamic5Qi | NonDynamic5Qi | C | 0..1 | When present, this IE shall indicate the QoS Characteristics for a standardized or pre-configured 5QI for downlink and uplink.
See NOTE 1. | +| dynamic5Qi | Dynamic5Qi | C | 0..1 | When present, this IE shall indicate the QoS Characteristics for a Non-standardised or not pre-configured 5QI for downlink and uplink.
See NOTE 1. | +| arp | Arp | C | 0..1 | This IE shall be present when establishing a QoS flow; it may be present when modifying a QoS flow. When present, this IE shall contain the Allocation and Retention Priority (ARP) assigned to the QoS flow. | +| gbrQosFlowInfo | GbrQosFlowInformation | C | 0..1 | This IE shall be present when establishing a GBR QoS flow or if the GBR QoS flow information is modified. | +| rqa | ReflectiveQoSAttribute | O | 0..1 | This IE may be present for a non-GBR QoS flow and it shall be ignored otherwise. When present, it shall indicate whether certain traffic on this QoS flow may be subject to Reflective QoS. | +| additionalQosFlowInfo | AdditionalQosFlowInfo | O | 0..1 | This IE may be present for a non-GBR QoS flow. When present, this IE indicates that traffic for this QoS flow is likely to appear more often than traffic for other flows established for the PDU session. See clause 9.3.1.12 of 3GPP TS 38.413 [9]. | +| qosMonitoringReq | QosMonitoringReq | O | 0..1 | This IE may be present to indicate the measurement of UL, or DL, or both UL/DL delays for the associated QoS flow. This IE may also be used to indicate the stop of corresponding measurement, by setting the value to "NONE". See clause 9.3.1.12 of 3GPP TS 38.413 [9]. | +| qosRepPeriod | DurationSec | O | 0..1 | This IE should be present if QoS monitoring is required.
When present, this IE shall indicate the reporting period. See clause 4.23.5.3 of 3GPP TS 23.502 [3]. | +| pduSetQosPara | PduSetQosPara | O | 0..1 | This IE should be present if PDU Set based QoS handling is enabled on the QoS flow. See clause 5.37.5 of 3GPP TS 23.501 [2]. | + +NOTE 1: Either the nonDynamic5Qi IE or the dynamic5Qi IE may be present when establishing a QoS flow. Either the nonDynamic5Qi IE or the dynamic5Qi IE may be present when modifying a QoS flow; when present, the received nonDynamic5Qi IE or dynamic5Qi IE shall replace any value received previously for this IE. + +## 6.1.6.2.23 Type: GbrQosFlowInformation + +**Table 6.1.6.2.23-1: Definition of type GbrQosFlowInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| maxFbrDl | BitRate | M | 1 | This IE shall contain the Maximum Bit Rate in Downlink. See 3GPP TS 23.501 [2]. | +| maxFbrUl | BitRate | M | 1 | This IE shall contain the Maximum Bit Rate in Uplink. See 3GPP TS 23.501 [2]. | +| guaFbrDl | BitRate | M | 1 | This IE shall contain the Guaranteed Bit Rate in Downlink. See 3GPP TS 23.501 [2]. | +| guaFbrUl | BitRate | M | 1 | This IE shall contain the Guaranteed Bit Rate in Uplink. See 3GPP TS 23.501 [2]. | +| notifControl | NotificationControl | O | 0..1 | When present, this IE shall indicate whether notifications are requested from the RAN when the GFBR can no longer (or again) be fulfilled for a QoS flow during the lifetime of the QoS flow. See 3GPP TS 23.501 [2]. | +| maxPacketLossRateDl | PacketLossRate | O | 0..1 | When present, this IE shall indicate the maximum rate for lost packets that can be tolerated in the downlink direction. See 3GPP TS 23.501 [2]. | +| maxPacketLossRateUl | PacketLossRate | O | 0..1 | When present, this IE shall indicate the maximum rate for lost packets that can be tolerated in the Uplink direction. See 3GPP TS 23.501 [2]. | +| alternativeQosProfileList | array(AlternativeQosProfile) | O | 0..N | When present, this IE shall indicate alternative QoS profiles for the QoS flow. An empty array shall be interpreted as a request to delete any list of alternative QoS profiles associated with this QoS flow. | + +## 6.1.6.2.24 Type: QosFlowNotifyItem + +**Table 6.1.6.2.24-1: Definition of type QosFlowNotifyItem** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| qfi | Qfi | M | 1 | This IE shall contain the QoS Flow Identifier. | +| notificationCause | NotificationCause | M | 1 | | +| currentQosProfileIndex | Integer | C | 0..1 | When present, this IE shall indicate the index of the currently fulfilled alternative QoS profile. This IE shall not be present if the nullQoSProfileIndex IE is present. | +| nullQoSProfileIndex | boolean | C | 0..1 | This IE shall be present and set to "true" if the NG-RAN cannot even fulfil the lowest alternative QoS profile. This IE shall not be present if the currentQosProfileIndex IE is present. | + +6.1.6.2.25 Type: Void + +6.1.6.2.26 Type: Void + +6.1.6.2.27 Type: SmContextRetrievedData + +**Table 6.1.6.2.27-1: Definition of type SmContextRetrievedData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueEpsPdnConnection | EpsPdnCnxContainer | M | 1 | This IE shall contain an MME/SGSN UE EPS PDN Connection including the mapped EPS bearer context(s), if the SM context type was not present in the request or if it was present and indicated a request to retrieve the UE EPS PDN Connection.

This IE shall be set to an empty string if the SM context type was present in the request and indicated a request to retrieve the complete SM context or the AF Coordination Information. | | +| smContext | SmContext | C | 0..1 | This IE shall be present if the SM context type was present in the request and indicated a request to retrieve the complete SM context. | DTSSA | +| smallDataRateStatus | SmallDataRateStatuses | C | 0..1 | This IE shall be present during N26 based Interworking Procedures, if in the request the smContextType is set to "EPS_PDN_CONNECTION" and if the status is available (see clauses 4.11.1.1 and 4.11.1.3.2 in 3GPP TS 23.502 [3]). When present, it shall indicate the small data rate control status for the PDU session. | CIOT | +| apnRateStatus | ApnRateStatus | C | 0..1 | This IE shall be present during N26 based Interworking Procedures, if in the request the smContextType is set to "EPS_PDN_CONNECTION" and if the status is available (see clauses 4.11.1.1 and 4.11.1.3.2 in 3GPP TS 23.502 [3]). When present, it shall indicate the APN rate control status for the PDN connection (APN rates are shared by all PDN connections of the UE to this APN). | CIOT | +| dlDataWaitingInd | boolean | C | 0..1 | This IE shall be present, if the SM context type was not present in the request or if it was present and indicated a request to retrieve the UE EPS PDN Connection, and if downlink data buffered in the SMF/UPF needs to be forwarded to EPS (see clause 4.11.1.3.2A of 3GPP TS 23.502 [3]).

When present, it shall be set as follows:
- true: DL data needs to be sent to the UE;

- false (default): no DL data needs to be sent to the UE. | CIOT | +| afCoordinationInfo | AfCoordinationInfo | C | 0..1 | This IE shall be present if the SM context type was present in the request and indicated a request to retrieve the AF Coordination Information. | EnEDGE | + +## 6.1.6.2.28 Type: TunnelInfo + +Table 6.1.6.2.28-1: Definition of type TunnelInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ipv4Addr | Ipv4Addr | C | 0..1 | When present, this IE shall contain the GTP tunnel IPv4 address.
At least one of the ipv4Addr or ipv6Addr shall be present. Both may be present. | | +| ipv6Addr | Ipv6Addr | C | 0..1 | When present, this IE shall contain the GTP tunnel IPv6 address.
At least one of the ipv4Addr or ipv6Addr shall be present. Both may be present. | | +| gtpTeid | Teid | M | 1 | This IE shall contain the 4-octet GTP tunnel endpoint identifier.
If both ipv4Addr and ipv6Addr are present, the TEID shall be shared by both addresses. | | +| anType | AccessType | C | 0..1 | This IE shall be present over N16a/N16 in MA PDU session scenarios, to indicate the access type associated to the N9 tunnel. | MAPDU | + +## 6.1.6.2.29 Type: StatusInfo + +Table 6.1.6.2.29-1: Definition of type StatusInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| resourceStatus | ResourceStatus | M | 1 | This IE shall indicate the status of the SM context or PDU session resource. | | +| cause | Cause | O | 0..1 | When present, this IE shall indicate the cause for the resource status change. | | +| remoteError | boolean | O | 0..1 | This IE may be present in the SM context Status Notification sent from the V-SMF or I-SMF to the AMF.

When present, this IE shall indicate whether the cause indicated in the cause IE is originated by the remote entity or by the entity sending the message, as follows:
  • - true: the error is originated by the remote entity (i.e. H-SMF or SMF for a PDU session with an I-SMF).
  • - false: the error is originated by the entity sending the message (i.e. V-SMF/I-SMF).
This IE shall be present and set to true for a HR PDU session, or for a PDU session with an I-SMF, when the cause indicated in the cause IE is originated by the remote entity. | | +| cnAssistedRanPara | CnAssistedRanPara | C | 0..1 | This attribute shall be present when the cause value is "CN_ASSISTED_RAN_PARAMETER_TUNING".
When present, this IE shall include the SMF derived CN assisted RAN parameters tuning. | CARPT | +| anType | AccessType | C | 0..1 | This IE shall indicate the access type of PDU session. | HOFail | + +6.1.6.2.30 Type: VsmfUpdateError + +**Table 6.1.6.2.30-1: Definition of type VsmfUpdateError** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| error | ExtProblemDetails | M | 1 | More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure. | | +| pti | ProcedureTransactionId | C | 0..1 | This IE shall be present if available. When present, it shall contain the PTI value received from the UE. | | +| n1smCause | string | C | 0..1 | This IE shall be present if available. When present, it shall contain the 5GSM cause received from the UE. It shall be encoded as two characters in hexadecimal representation with each character taking a value of "0" to "9" or "A" to "F", and represent the cause value of the 5GSM cause IE specified in clause 9.11.4.2 of 3GPP TS 24.501 [7].

Pattern: "[A-F0-9]{2}\$"

Example: the cause "Invalid mandatory information" shall be encoded as "60".
See NOTE. | | +| n1SmInfoFromUe | RefToBinaryData | C | 0..1 | This IE shall be present if the V-SMF or I-SMF has received known N1 SM information from the UE that does not need to be interpreted by the V-SMF or I-SMF. When present, this IE shall reference the n1SmInfoFromUe binary data (see clause 6.1.6.4.4). | | +| unknownN1SmInfo | RefToBinaryData | C | 0..1 | This IE shall be present if the V-SMF or I-SMF has received unknown N1 SM information from the UE. When present, this IE shall reference the unknownN1SmInfo binary data (see clause 6.1.6.4.4). | | +| failedToAssignEbiList | array(Arp) | C | 1..N | This IE shall be present if the AMF failed to assign the requested EBIs. | | +| ngApCause | NgApCause | C | 0..1 | The V-SMF or I-SMF shall include this IE, if it is available and, for a HR PDU session, if this information is permitted to be sent to the H-SMF operator according to the V-SMF operator's policy. | | +| 5gMmCauseValue | 5GMmCause | C | 0..1 | The V-SMF or I-SMF shall include this IE if it received it from the AMF and, for a HR PDU session, if this information is permitted to be sent to the H-SMF operator according to the V-SMF operator's policy. | | +| recoveryTime | DateTime | O | 0..1 | Timestamp (in UTC) when the V-SMF or I-SMF service instance was (re)started (see clause 6.3 of 3GPP TS 23.527 [24]). | | +| n4Info | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send N4 response information to the SMF for the control of traffic offloaded at a PSA/BP/ULCL controlled by an I-SMF. | DTSSA | +| n4InfoExt1 | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send additional N4 response information to the SMF for the control of traffic offloaded at a PSA/BP/ULCL controlled by an I-SMF. | DTSSA | +| n4InfoExt2 | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send additional N4 response information to the SMF for the control of traffic offloaded at a PSA/BP/ULCL controlled by an I-SMF (e.g. during a change of PSA). | DTSSA | +| n4InfoExt3 | N4Information | O | 0..1 | This IE may be present if the I-SMF needs to send additional N4 response information to the SMF for the control of traffic offloaded at a PSA/BP/ULCL controlled by an I-SMF (e.g. during simultaneous change of BP/ULCL and PSA). | SCPBU | +| retryAfter | UInteger | O | 0..1 | This IE may be included if received from the AMF within an error response, e.g., during N1N2MessageTransfer service operation when UE is not responding to paging.

When present, this IE indicates the period in number of seconds. The NF consumer, i.e. the (H-)SMF, should not send new update request to the V-SMF/I-SMF | | + +| | | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|------------------------------|--| +| | | | | during the indicated period. | | +| NOTE: This IE is sent as a separate IE rather than within the n1SmInfoFromUE binary data because the 5GSM cause IE is defined as a "V" IE (i.e. without a Type field) in the NAS PDU Session Modification Command Reject message. | | | | | | + +#### 6.1.6.2.31 Type: EpsPdnCnxInfo + +**Table 6.1.6.2.31-1: Definition of type EpsPdnCnxInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| pgwS8cFteid | Bytes | M | 1 | Base64-encoded characters, encoding the PGW S8 F-TEID for Control Plane as specified in Figure 8.22-1 of 3GPP TS 29.274 [16] (starting from octet 1). | +| pgwNodeName | Bytes | C | 0..1 | Base64-encoded characters, encoding the PGW FQDN IE as specified in Figure 8.66-1 of 3GPP TS 29.274 [16] (starting from octet 1). It shall be present, if it is available. | +| pgwChangeInfo | Bytes | O | 0..1 | Base64-encoded characters, encoding the PGW Change Info IE as specified in Table 8.145-1 of 3GPP TS 29.274 [16] (starting from octet 1). See clause 31.5 of 3GPP TS 23.007 [45]. | +| linkedBearerId | EpsBearerId | C | 0..1 | An implementation complying with this version of the specification shall include this attribute and set it to the default bearer ID associated with the PDU session moved to EPS. | + +#### 6.1.6.2.32 Type: EpsBearerInfo + +**Table 6.1.6.2.32-1: Definition of type EpsBearerInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| ebi | EpsBearerId | M | 1 | EPS Bearer ID | +| pgwS8uFteid | Bytes | M | 1 | Base64-encoded characters, encoding the PGW S8 F-TEID for User Plane as specified in Figure 8.22-1 of 3GPP TS 29.274 [16] (starting from octet 1). | +| bearerLevelQoS | Bytes | M | 1 | Base64-encoded characters, encoding the Bearer QoS IE as specified in Figure 8.15-1 of 3GPP TS 29.274 [16] (starting from octet 1). | + +#### 6.1.6.2.33 Type: PduSessionNotifyItem + +**Table 6.1.6.2.33-1: Definition of type PduSessionNotifyItem** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------| +| notificationCause | NotificationCause | M | 1 | | + +#### 6.1.6.2.34 Type: EbiArpMapping + +**Table 6.1.6.2.34-1: Definition of type EbiArpMapping** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|---------------------------------------------------------| +| epsBearerId | EpsBearerId | M | 1 | This IE shall contain the EPS bearer identities. | +| arp | Arp | M | 1 | This IE shall contain the ARP corresponding to the EBI. | + +## 6.1.6.2.35 Type: SmContextCreateError + +Table 6.1.6.2.35-1: Definition of type SmContextCreateError + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| error | ExtProblemDetails | M | 1 | More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure. | +| n1SmMsg | RefToBinaryData | C | 0..1 | This IE shall be present, if an N1 SM information is received in the request and the SMF is able to return N1 SM information to the UE. When present, it shall reference the N1 SM Message binary data (see clause 6.1.6.4.2). | +| n2SmInfo | RefToBinaryData | C | 0..1 | This IE shall be present, if N2 SM information needs to be returned to the NG-RAN during Xn based handover procedure with I-SMF/V-SMF insertion, change or removal. When present, it shall reference the N2 SM Message binary data (see clause 6.1.6.4.3). | +| n2SmInfoType | N2SmInfoType | C | 0..1 | This IE shall be present if "n2SmInfo" attribute is present. When present, this IE shall indicate the NG AP IE type for the NG AP SMF related IE container carried in "n2SmInfo" attribute. | +| recoveryTime | DateTime | O | 0..1 | Timestamp (in UTC) when the SMF service instance was (re)started (see clause 6.3 of 3GPP TS 23.527 [24]). | + +## 6.1.6.2.36 Type: SmContextUpdateError + +Table 6.1.6.2.36-1: Definition of type SmContextUpdateError + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| error | ExtProblemDetails | M | 1 | More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure. | +| n1SmMsg | RefToBinaryData | C | 0..1 | This IE shall be present, if N1 SM Information needs to be returned to the UE. When present, it shall reference the N1 SM Message binary data (see clause 6.1.6.4.2). | +| n2SmInfo | RefToBinaryData | C | 0..1 | This IE shall be present, if N2 SM information needs to be returned to the NG-RAN. When present, it shall reference the N2 SM Message binary data (see clause 6.1.6.4.3). | +| n2SmInfoType | N2SmInfoType | C | 0..1 | This IE shall be present if "n2SmInfo" attribute is present. When present, this IE shall indicate the NG AP IE type for the NG AP SMF related IE container carried in "n2SmInfo" attribute. | +| upCnxState | UpCnxState | C | 0..1 | This IE shall be present if the SMF was requested to activate or deactivate the user plane connection of the PDU session in the corresponding request. When present, it shall be set as specified in clauses 5.2.2.3.2 and 5.2.2.3.16. | +| recoveryTime | DateTime | O | 0..1 | Timestamp (in UTC) when the SMF service instance was (re)started (see clause 6.3 of 3GPP TS 23.527 [24]). | + +## 6.1.6.2.37 Type: PduSessionCreateError + +**Table 6.1.6.2.37-1: Definition of type PduSessionCreateError** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| error | ProblemDetails | M | 1 | More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure. | +| n1smCause | string | C | 0..1 | This IE shall be present if the request included n1SmInfoFromUe.
When present, it shall contain the 5GSM cause the H-SMF or SMF proposes the V-SMF or I-SMF to return to the UE. It shall be encoded as two characters in hexadecimal representation with each character taking a value of "0" to "9" or "A" to "F", and represent the cause value of the 5GSM cause IE specified in clause 9.11.4.2 of 3GPP TS 24.501 [7].

Pattern: "^[A-F0-9]{2}\$"

Example: the cause "Invalid mandatory information" shall be encoded as "60".
(NOTE) | +| n1SmInfoToUe | RefToBinaryData | C | 0..1 | This IE shall be present if the H-SMF or SMF needs to send N1 SM information to the UE that does not need to be interpreted by the V-SMF or I-SMF. When present, this IE shall reference the n1SmInfoToUe binary data (see clause 6.1.6.4.4). | +| backOffTimer | DurationSec | O | 0..1 | When present, this IE shall indicate a Back-off timer value, in seconds, that the V-SMF or I-SMF may use when rejecting the NAS message towards the UE. | +| recoveryTime | DateTime | O | 0..1 | When present, this IE shall contain the timestamp (in UTC) of the event when the H-SMF or SMF service instance was (re)started (see clause 6.3 of 3GPP TS 23.527 [24]). | +| NOTE: This IE contains information that the V-SMF or I-SMF may transfer to the UE without interpretation. It is sent as a separate IE rather than within the n1SmInfoToUe binary data because the 5GSM cause IE is defined as a "V" IE (i.e. without a Type field) in the NAS PDU Session Establishment Reject message. | | | | | + +## 6.1.6.2.38 Type: MmeCapabilities + +**Table 6.1.6.2.38-1: Definition of type MmeCapabilities** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nonIpSupported | boolean | C | 0..1 | This IE shall be present if non-IP PDN type is supported. It may be present otherwise. When present, this IE shall be set as follows:

  • - true: non-IP PDN type is supported;
  • - false (default): non-IP PDN type is not supported.
| +| ethernetSupported | boolean | C | 0..1 | This IE shall be present if Ethernet PDN type is supported. It may be present otherwise. When present, this IE shall be set as follows:

  • - true: Ethernet PDN type is supported;
  • - false (default): Ethernet PDN type is not supported.
| +| upipSupported | boolean | C | 0..1 | This IE shall be present if the MME supports User Plane Integrity Protection with EPS. It may be present otherwise. When present, this IE shall be set as follows:

  • - true: User Plane Integrity Protection with EPS is supported;
  • - false (default): User Plane Integrity Protection with EPS is not supported.
| +| NOTE: The AMF should know the MME capability to support, or not, non-IP PDN type, Ethernet PDN type and User Plane Integrity Protection, through local configuration. Note however that the actual EPS support of User Plane Integrity Protection may depend on the target E-UTRAN coverage. | | | | | + +6.1.6.2.39 Type: SmContext + +**Table 6.1.6.2.39-1: Definition of type SmContext** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSessionId | PduSessionId | M | 1 | This IE shall contain the PDU Session ID. | | +| dnn | Dnn | M | 1 | This IE shall contain the UE requested DNN of the PDU session.
The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. | | +| selectedDnn | Dnn | C | 0..1 | This IE shall be present, if another DNN other than the UE requested DNN is selected for this PDU session. When present, it shall contain the selected DNN. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. | | +| sNssai | Snssai | M | 1 | This IE shall contain the S-NSSAI for the serving PLMN. | | +| hplmnSnssai | Snssai | C | 0..1 | This IE shall be present for a HR PDU session. When present, it shall contain the S-NSSAI for the HPLMN. | | +| pduSessionType | PduSessionType | M | 1 | This IE shall indicate the PDU session type. | | +| gpsi | Gpsi | C | 0..1 | This IE shall be present if it is available. When present, it shall contain the user's GPSI. | | +| hSmfUri | Uri | C | 0..1 | This IE shall be present in HR roaming scenarios. When present, it shall contain the API URI of the Nsmf_PDUSession service of the H-SMF. The API URI shall be formatted as specified in clause 6.1.1. | | +| smfUri | Uri | C | 0..1 | This IE shall be present for a PDU session with an I-SMF. When present, it shall contain the API URI of the Nsmf_PDUSession service of the SMF. The API URI shall be formatted as specified in clause 6.1.1. | | +| pduSessionRef | Uri | C | 0..1 | This IE shall be present for a HR PDU session or a PDU session with an I-SMF. When present, this IE shall include the absolute URI of the PDU Session in H-SMF or SMF, including apiRoot (see clause 6.1.3.6.2) | | +| interPlmnApiRoot | Uri | C | 0..1 | This IE shall be present, if available. When present, it shall contain the apiRoot of the PDU session context to be used in inter-PLMN signalling request targeting the PDU session context. (NOTE 2) | | +| intraPlmnApiRoot | Uri | C | 0..1 | This IE shall be present, if available. When present, it shall contain the apiRoot of the PDU session context to be used in intra-PLMN signalling request targeting the PDU session context. (NOTE 2) | | +| pcfId | NfInstanceId | O | 0..1 | When present, this IE shall contain the identifier of:
  • - the H-PCF selected by the AMF (for UE Policy), for a HR PDU session; or
  • - the V-PCF selected by the AMF (for Access and Mobility Policy), for a PDU session in LBO roaming scenarios; or
  • - the PCF selected by the AMF (for Access and Mobility Policy and/or UE Policy), for a PDU session in non-roaming scenarios.
| | +| pcfGroupId | NfGroupId | O | 0..1 | This IE may be present in non-roaming and HR roaming scenarios. When present, this IE shall contain the identity of the (home) PCF group serving the UE for Access and Mobility Policy and/or UE Policy. | | +| pcfSetId | NfSetId | O | 0..1 | This IE may be present if the pcfId IE is present. | | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------|--| +| | | | | When present, it shall contain the NF Set ID of the PCF indicated by the pcflD IE. | | +|--|--|--|--|------------------------------------------------------------------------------------|--| + +| | | | | | +|---------------------------|-------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| selMode | DnnSelectionMode | C | 0..1 | This IE shall be present if it is available. When present, it shall be set to:
  • - "VERIFIED", if the requested DNN provided by UE or the selected DNN provided by the network corresponds to an explicitly subscribed DNN; or
  • - "UE_DNN_NOT_VERIFIED", if the requested DNN provided by UE corresponds to the usage of a wildcard subscription; or
  • - "NW_DNN_NOT_VERIFIED", if the selected DNN provided by network corresponds to the usage of a wildcard subscription.
If both the requested DNN (i.e. dnn IE) and selected DNN (i.e. selected Dnn IE) are present, the selMode shall be related to the selected DNN. | +| udmGroupId | NfGroupId | O | 0..1 | When present, it shall indicate the identity of the UDM group serving the UE. | +| routingIndicator | string | O | 0..1 | When present, it shall indicate the Routing Indicator of the UE. | +| hNwPubKeyId | integer | O | 0..1 | When present, it shall indicate the Home Network Public Key Identifier of the UE. (NOTE 1) | +| sessionAmbr | Ambr | M | 1 | This IE shall contain the Session AMBR granted to the PDU session. | +| qosFlowsList | array(QosFlowSetupItem) | M | 1..N | This IE shall contain the set of QoS flow(s) established for the PDU session. It shall contain at least the Qos flow associated to the default Qos rule. The qosRules attribute of each QosFlowSetupItem shall be set to an empty string. | +| hSmfInstanceId | NfInstanceId | C | 0..1 | This IE shall be present for a HR PDU session. When present, it shall contain the identifier of the home SMF. | +| smfInstanceId | NfInstanceId | C | 0..1 | This IE shall be present for a PDU session with an I-SMF. When present, it shall contain the identifier of the SMF. | +| pduSessionSmfSetId | NfSetId | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the NF Set ID of the home SMF as identified by hSmfInstanceId, or the SMF as identified by the smfInstanceId. | +| pduSessionSmfServiceSetId | NfServiceSetId | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the NF Service Set ID of the PDUSession service instance (for this PDU session) in the home SMF or the SMF. | +| pduSessionSmfBinding | SbiBindingLevel | C | 0..1 | This IE shall be present, if available. When present, this IE shall contain the SBI binding level of the PDU session resource in the home SMF or the SMF. | +| enablePauseCharging | boolean | C | 0..1 | This IE shall be present for a HR PDU session, if available. When present, it shall indicate whether the use of Pause of Charging is enabled for the PDU session (see clause 4.4.4 of 3GPP TS 23.502 [3]). When present, it shall be set as follows:
  • - true: enable Pause of Charging;
  • - false (default): disable Pause of Charging.
| +| uelpv4Address | Ipv4Addr | C | 0..1 | This IE shall be present if a UE IPv4 address to the PDU session. | +| uelpv6Prefix | Ipv6Prefix | C | 0..1 | This IE shall be present if a UE IPv6 prefix to the PDU session. | +| epsPdnCnxInfo | EpsPdnCnxInfo | C | 0..1 | This IE shall be present if the PDU session may be | + +| | | | | | | +|--|--|--|--|-----------------------------------|--| +| | | | | moved to EPS during its lifetime. | | +|--|--|--|--|-----------------------------------|--| + +| | | | | | | +|---------------------------------|-------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| epsBearerInfo | array(EpsBearerInfo) | C | 1..N | This IE shall be present if the PDU session may be moved to EPS during its lifetime. | | +| maxIntegrityProtectedDataRate | MaxIntegrityProtectedDataRate | C | 0..1 | This IE shall be present if the upSecurity IE is present and indicates that integrity protection is preferred or required.
When present, it shall indicate the maximum integrity protected data rate for uplink.
If the maxIntegrityProtectedDataRateDI IE is absent, this IE applies to both uplink and downlink. | | +| maxIntegrityProtectedDataRateDI | MaxIntegrityProtectedDataRate | C | 0..1 | This IE may be present if the upSecurity IE is present and indicates that integrity protection is preferred or required.
When present, it shall indicate the maximum integrity protected data rate for downlink. | | +| alwaysOnGranted | boolean | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether this is an always On PDU session and it shall be set as follows:
- true: always-on PDU session granted.
- false (default): always-on PDU session not granted. | | +| upSecurity | UpSecurity | O | 0..1 | When present, this IE shall indicate the security policy for integrity protection and encryption for the user plane of the PDU session. | | +| hSmfServiceInstanceId | string | O | 0..1 | This IE may be present for a HR PDU session. When present, this IE shall contain the serviceInstanceId of the H-SMF service instance serving the PDU session.
This IE may be used by the V-SMF to identify PDU sessions affected by a failure or restart of the H-SMF service (see clause 6.2 of 3GPP TS 23.527 [24]). | | +| smfServiceInstanceId | string | O | 0..1 | This IE may be present for a PDU session with an I-SMF.
When present, this IE shall contain the serviceInstanceId of the SMF service instance serving the PDU session.
This IE may be used by the I-SMF to identify PDU sessions affected by a failure or restart of the SMF service (see clause 6.2 of 3GPP TS 23.527 [24]). | | +| recoveryTime | DateTime | O | 0..1 | This IE may be present if available. When present, this IE shall indicate the timestamp (in UTC) when the H-SMF or SMF service instance serving the PDU session was (re)started (see clause 6.3 of 3GPP TS 23.527 [24]). | | +| forwardingInd | boolean | C | 0..1 | This IE shall be present, when downlink data packets are buffered at I-UPF. The SMF or I-SMF shall use this IE to inform the NF service consumer that a forwarding tunnel is needed for receiving the buffered downlink data packets, as specified in clause 4.23.4 of 3GPP TS 23.502 [3].
When present, this IE shall be set as follows:
- true: a forwarding tunnel is needed for sending buffered downlink data packets;
- false (default): forwarding tunnel is not needed | | +| psaTunnelInfo | TunnelInfo | C | 0..1 | This IE shall be present if available. When present, this IE shall contain the N9 tunnel information of PDU Session Anchor UPF controlled by SMF or H-SMF. | | +| chargingId | string | C | 0..1 | This IE shall be present for a HR PDU session, in scenarios with a V-SMF insertion/change/removal. When present, it shall contain the Charging ID of the PDU session (see 3GPP TS 32.255 [25]).

The string shall encode the Charging ID (32-bit unsigned integer value, with maximum value "4294967295") in decimal representation.

Pattern: '^(0 ([1-9]{1}[0-9]{0,9}))\$'

(NOTE 4) | | + +| | | | | | | +|-------------------------|--------------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| smfChargingId | SmfChargingId | C | 0..1 | This IE shall be present if available for a HR PDU session, in scenarios with a V-SMF insertion/change/removal.

When present, it shall contain the String based Charging ID of the PDU session (see 3GPP TS 32.255 [25]). | SCID | +| chargingInfo | ChargingInformation | C | 0..1 | This IE shall be present for a HR PDU session, if available and if the NF Service Consumer requesting the SM Context pertains to the same PLMN (i.e. if the Retrieve SM Context Request does not contain the servingNetwork attribute set to a different PLMN ID). When present, it shall contain the addresses of the V-CHF used for the PDU session. | | +| roamingChargingProfile | RoamingChargingProfile | C | 0..1 | This IE shall be present for a HR PDU session, if available and if the NF Service Consumer requesting the SM Context pertains to the same PLMN (i.e. if the Retrieve SM Context Request does not contain the servingNetwork attribute set to a different PLMN ID). When present, it shall contain the Roaming Charging Profile selected by the HPLMN (see clauses 5.1.9.1, 5.2.1.7 and 5.2.2.12.2 of 3GPP TS 32.255 [25]). | | +| nefExtBufSupportInd | boolean | C | 0..1 | This IE shall be present with value "true", if the anchor NEF has indicated support of Extended Buffering for mobile terminated data during SMF-NEF connection establishment.

When present, this IE shall be set as following:
- true: Extended Buffering supported by NEF
- false (default): Extended Buffering not supported by NEF | | +| ipv6Index | IpIndex | C | 0..1 | This IE shall be present during I-SMF change scenarios, if IPv6 Index has previously been received by old I-SMF. | | +| dnAaaAddress | IpAddress | O | 0..1 | When present, this IE shall contain the address of DN-AAA server for UE IP Address allocation previously received by old I-SMF. | | +| redundantPduSessionInfo | RedundantPduSessionInformation | C | 0..1 | This IE shall be present for a PDU session with an I-SMF, if this information has been received previously from the UE, the anchor SMF or the old I-SMF. | | +| ranTunnelInfo | QosFlowTunnel | C | 0..1 | This IE shall be present if the ranUnchangedInd IE is set to "true" in the SM context retrieve request.

When present, this IE shall contain the N2 tunnel information of NG-RAN with associated QoS flows (see "DL QoS Flow per TNL Information" in clause 9.3.4.2 of 3GPP 38.413 [9]). | | +| addRanTunnelInfo | array(QosFlowTunnel) | C | 1..N | This IE shall be present if the ranUnchangedInd IE is set to "true" in the SM context retrieve request.

When present, this IE shall contain the additional N2 tunnel information of NG-RAN together with associated QoS flows for split PDU session (see "Additional DL QoS Flow per TNL Information" in clause 9.3.4.2 of 3GPP 38.413 [9]). | | +| redRanTunnelInfo | QosFlowTunnel | C | 0..1 | This IE shall be present if the ranUnchangedInd IE is set to "true" in the SM context retrieve request.

When present, this IE shall contain the additional N2 tunnel information of NG-RAN together with associated QoS flows for Redundant QoS Flow(s) (see "Redundant DL QoS Flow per TNL Information" in clause 9.3.4.2 of 3GPP 38.413 [9]). | | +| addRedRanTunnelInfo | array(QosFlowTunnel) | C | 1..N | This IE shall be present if the ranUnchangedInd IE is set to "true" in the SM context retrieve request.

When present, this IE shall contain the additional N2 tunnel information of NG-RAN together with associated | | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | QoS flows for Redundant QoS Flow(s) with split PDU session (see "Additional Redundant DL QoS Flow per TNL Information" in clause 9.3.4.2 of 3GPP 38.413 [9]). | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------------|---------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| nspuSupportInd | boolean | C | 0..1 | This IE shall be present and set to "true" if the enablePauseCharging in the SmContext data type is set to "true" and if the (H-)SMF and PSA UPF support Notify Start Pause of Charging via user plane feature as specified in clause 5.30 of 3GPP TS 29.244 [29].

When present, it shall be set as follows:
- true: Notify Start Pause of Charging via user plane feature is supported. | | +| smfBindingInfo | string | C | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the Binding indications of the PDU session resource in the home SMF or the SMF and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. | | +| satelliteBackhaulCat | SatelliteBackhaulCategory | O | 0..1 | When present, this IE shall indicate the satellite backhaul category information last signalled towards the anchor SMF, if any. | | +| sscMode | string | C | 0..1 | This IE shall be present, if available.

When present, this IE shall indicate the SSC mode applicable to the PDU session.
When present, it shall be encoded as one character in hexadecimal representation, taking a value of "0" to "7", representing the 3 bits of the SSC mode value of the SSC mode IE specified in clause 9.11.4.16 of 3GPP TS 24.501 [7].

Pattern: "[0-7]\$"

Example: SSC mode 3 shall be encoded as "3". | | +| dlsetSupportInd | boolean | C | 0..1 | This IE shall be present and set to "true" if the (H-)SMF supports the "DLSET" feature as specified in clause 6.1.8.

When present, it shall be set as follows:
- true: the (H-)SMF supports the "DLSET" feature.
- false: the (H-)SMF does not support the "DLSET" feature | | +| n9fscSupportInd | boolean | C | 0..1 | This IE shall be present and set to "true" if the SMF supports the "N9FSC" feature as specified in clause 6.1.8.

When present, it shall be set as follows:
- true: "N9FSC" feature is supported. | | +| anchorSmfOAuth2Required | boolean | O | 0..1 | This IE may be present when the NF consumer (i.e. new I-SMF or new V-SMF) and the NF producer (i.e. the old I-SMF, V-SMF or SMF) belong to the same PLMN.

When present, this IE shall indicate whether the H-SMF or SMF for a PDU session with an I-SMF requires OAuth2-based authorization for accessing its Nsmf_PDUSession service.

- true: OAuth2 based authorization is required.
- false: OAuth2 based authorization is not required.

The absence of this IE means that no indication is available about the usage of OAuth2 for authorization of the anchor SMF's Nsmf_PDUSession service.
(NOTE 3) | | +| fullDnailList | array(Dnail) | O | 1..N | This IE may be present to contain the full list of DNAIs | DTSSA- | + +| | | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------|------| +| | | | | of interest for PDU session, including DNAIs that may not be supported by the (source) I-SMF and excluding the ones supported by the Anchor SMF. | Ext1 | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------|------| + +| | | | | | | +|--------------------------|----------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| hrsboAuthResult | boolean | C | 0..1 |

This IE shall be present for a HR PDU session, during a V-SMF change within the same PLMN (i.e. if the Retrieve SM Context Request does not contain the servingNetwork attribute set to a different PLMN ID), if HR-SBO was authorized by the H-SMF and the request indicates that the new V-SMF supports HR-SBO.

When present, it shall Indicate whether HR-SBO request is authorized

  • - true: authorized.
  • - false: Not authorized.
| HR-SBO | +| hDnsAddr | lpAddress | C | 0..1 |

This IE shall be present for a HR PDU session, during a V-SMF change within the same PLMN (i.e. if the Retrieve SM Context Request does not contain the servingNetwork attribute set to a different PLMN ID), if available, HR-SBO was authorized by the H-SMF and the request indicates that the new V-SMF supports HR-SBO.

When present, this IE shall contain the DNS server address of HPLMN.

| HR-SBO | +| hPlmnAddr | lpAddress | C | 0..1 |

This IE shall be present for a HR PDU session, during a V-SMF change within the same PLMN (i.e. if the Retrieve SM Context Request does not contain the servingNetwork attribute set to a different PLMN ID), if available, HR-SBO was authorized by the H-SMF and the request indicates that the new V-SMF supports HR-SBO.

When present, this IE shall contain the HPLMN address information (e.g. H-UPF IP address on N6). The new V-SMF may configure the new V-EASDF to build EDNS Client Subnet option based on this HPLMN address information for target FQDN of DNS queries which are not authorized for HR-SBO.

| HR-SBO | +| vplmnOffloadingInfo List | array(VplmnOffloadingInfo) | C | 1..N |

This IE shall be present for a HR PDU session, during a V-SMF change within the same PLMN (i.e. if the Retrieve SM Context Request does not contain the servingNetwork attribute set to a different PLMN ID), if available, HR-SBO was authorized by the H-SMF and the request indicates that the new V-SMF supports HR-SBO.

When present, it shall contain the list of V-PLMN Offloading policies that apply to the PDU session and whose offload identifiers are not yet known by the target V-SMF.
(NOTE 5)

| HR-SBO | +| offloadIds | array(OffloadIdentifier) | C | 1..N |

This IE shall be present for a HR PDU session, during a V-SMF change within the same PLMN (i.e. if the Retrieve SM Context Request does not contain the servingNetwork attribute set to a different PLMN ID), if available, HR-SBO was authorized by the H-SMF and the request indicates that the new V-SMF supports HR-SBO, and if the offloadIds are part of the storedOffloadIds included in the the Retrieve SM Context Request.

When present, this IE shall contain a list of offload identifiers that apply to the PDU session and that are already known by the target V-SMF.
(NOTE 5)

| HR-SBO | +| easInfoToRefresh | EasInfoToRefresh | C | 0..1 | This IE shall be present for a HR PDU session, during a V-SMF change within the same PLMN (i.e. if the | HR-SBO | + +| | | | | | | +|-----------------------|--------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| | | | | Retrieve SM Context Request does not contain the servingNetwork attribute set to a different PLMN ID), if available, HR-SBO was authorized by the H-SMF and the request indicates that the new V-SMF supports HR-SBO.

When present, it shall contain the EAS information to be refreshed for EAS re-discovery. | | +| easIpReplacementInfo | EasIpReplacementInfo | C | 0..1 | This IE shall be present, for a HR PDU session, if it is received from H-SMF in AF during AF triggered EAS re-discovery and edge relocation via interacting with HPLMN (see clause 6.7.3.2 of 3GPP TS 23.548 [74]).

When present, this IE shall contain the EAS IP replacement information. | HR-SBO | +| targetDnai | Dnai | C | 0..1 | This IE shall be present, for a HR PDU session, if it is received from H-SMF in AF triggered EAS re-discovery and edge relocation via interacting with HPLMN (see clause 6.7.3.2 of 3GPP TS 23.548 [74]).

When present, this IE shall contain the target DNAI. | HR-SBO | +| pendingUpdateInfoList | array(PendingUpdateInfo) | O | 1..N | This IE should be included by the old V-SMF/I-SMF if received from the (H-)SMF.

When present, this IE shall indicate the list of information that are not required to be updated in real-time to the (H-)SMF, i.e. the change of the listed information (e.g. UE location or Timezone) may be piggybacked in a subsequent essential update (e.g. to exchange the N1 message from the UE) to the (H-)SMF. The NF service consumer (i.e. I-SMF/V-SMF) should not trigger an Update to the (H-)SMF including only the change(s) of the listed information. | | + +NOTE 1: If present, this attribute shall be used together with routingIndicator. This attribute is only used by the HPLMN in roaming scenarios. + +NOTE 2: See NOTE 7 of Table 6.1.6.2.10-1. + +NOTE 3: If the anchorSmfOAuth2Required IE was received in SmContextCreateData from the AMF, this IE shall be ignored by the new I-SMF or V-SMF. + +NOTE 4: Usage of Charging ID with Uint32 value for roaming scenarios may lead to Charging ID collision between SMFs. + +NOTE 5: The same offloadId should not appear in both the vplmnOffloadingInfoList and offloadIds attributes. Both vplmnOffloadingInfoList and offloadIds attributes may be present when multiple offload identifiers apply to the PDU session and some of them are already known by the target V-SMF while others are not yet known by the target V-SMF. + +#### 6.1.6.2.40 Type: ExemptionInd + +The ExemptionInd indicates that the included NAS SM message was exempted from one or more NAS SM congestion control, e.g. DNN, and/or S-NSSAI based congestion control, activated in the AMF. + +**Table 6.1.6.2.40-1: Definition of type ExemptionInd** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnnCongestion | boolean | C | 0..1 | This IE shall be present and set to Yes if the included NAS Session Management message was exempted from the DNN based congestion activated in the AMF.
true: Yes
false (default): No | +| snssaiCongestion | boolean | C | 0..1 | This IE shall be present and set to Yes if the included NAS Session Management message was exempted from the S-NSSAI only based congestion activated in the AMF.
true: Yes
false (default): No | +| snssaiDnnCongestion | boolean | C | 0..1 | This IE shall be present and set to Yes if the included NAS Session Management message was exempted from the S-NSSAI and DNN based congestion activated in the AMF.
true: Yes
false (default): No | + +## 6.1.6.2.41 Type: PsaInformation + +**Table 6.1.6.2.41-1: Definition of type PsaInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| psaInd | PsaIndication | M | 1 | This IE shall indicate, for a PDU session with an I-SMF, if a PSA and UL CL or BP, or only a PSA is inserted or removed by the I-SMF. | +| dnaiList | array(Dnai) | M | 1..N | This IE shall indicate the DNAI(s) supported by the PSA that is inserted or removed. | +| uelpv6Prefix | Ipv6Prefix | C | 0..1 | This IE shall be present if a PSA and UL CL or BP is inserted or removed, and IPv6 multi-homing applies to the PDU session. | +| psaUpfId | NfInstanceId | C | 0..1 | This IE shall be present if a PSA UPF is inserted by the I-SMF. When present, it shall contain the identifier of the PSA UPF. | + +## 6.1.6.2.42 Type: DnaiInformation + +**Table 6.1.6.2.42-1: Definition of type DnaiInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnai | Dnai | M | 1 | | +| noDnaiChangeInd | boolean | C | 0..1 | This IE shall be sent by the SMF to the I-SMF during the insertion of a PSA and BP/UL CL controlled by I-SMF.
When present, it shall be set as follows:
- true: DNAI shall not be changed;

- false: DNAI may be changed. | +| noLocalPsaChangeInd | boolean | C | 0..1 | This IE shall be sent by the SMF to the I-SMF during the insertion of a PSA and BP/UL CL controlled by I-SMF.
When present, it shall be set as follows:
- true: local PSA shall not be changed;

- false: local PSA may be changed. | + +## 6.1.6.2.43 Type: N4Information + +Table 6.1.6.2.43-1: Definition of type N4Information + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| n4MessageType | N4MessageType | M | 1 | This IE shall indicate the PFCP message signalled in the n4MessagePayload. | | +| n4MessagePayload | ReftoBinaryData | M | 1 | This IE shall reference the N4 Message Payload binary data (for the n4Info attribute) or the N4 Information extension binary data (for the n4InfoExt1, n4InfoExt2 and n4InfoExt3 attributes), see clause 6.1.6.4.5. | | +| n4DnailInfo | DnailInformation | C | 0..1 | This IE shall be present if the N4 information relates to a PSA. When present, it shall indicate the DNAI related to the N4 Information. If this IE is not present, this indicates N4 information relates to an UL CL or BP. | | +| psaUpfld | NfInstanceId | O | 0..1 | This IE may be sent by SMF to I-SMF if multiple local PSAs are inserted for the PDU session. When present, it shall contain the identifier of the PSA UPF for which the N4 information applies. | | +| ulClBpId | NfInstanceId | O | 0..1 | When present, it shall contain the identifier of the UL CL/BP for which the N4 information applies. | | +| n9UIPdrIdList | array( Uint16) | C | 1..N | This IE shall be sent by the anchor SMF to the (new) I-SMF as specified in clauses 4.23.9.4 and 4.23.9.5 of 3GPP TS 23.502 [3] during simultaneous change of Branching Points or UL CLs controlled by I-SMF or controlled by different I-SMFs, if EAS session continuity upon UL CL relocation is required. When present, it shall contain the list of Rule IDs of the UL PDR(s) included in the N4Information to establish the UL N9 data forwarding in the target Branching Point or UL CL towards the old Branching Point or UL CL. | N9FSC | + +## 6.1.6.2.44 Type: IndirectDataForwardingTunnelInfo + +Table 6.1.6.2.44-1: Definition of type IndirectDataForwardingTunnelInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipv4Addr | Ipv4Addr | C | 0..1 | When present, this IE shall contain the GTP tunnel IPv4 address.
At least one of the ipv4Addr or ipv6Addr shall be present. Both may be present. | +| ipv6Addr | Ipv6Addr | C | 0..1 | When present, this IE shall contain the GTP tunnel IPv6 address.
At least one of the ipv4Addr or ipv6Addr shall be present. Both may be present. | +| gtpTeid | Teid | M | 1 | This IE shall contain the 4-octet GTP tunnel endpoint identifier.
If both ipv4Addr and ipv6Addr are present, the TEID shall be shared by both addresses. | +| drbId | DrbId | C | 0..1 | This IE shall be present if this is an indirect data forwarding tunnel for a specific Data Radio Bearer (see clause 9.3.1.77 of 3GPP TS 38.413 [9]).

This IE shall not present if the additionalTnlNb IE is present.
(NOTE) | +| additionalTnlNb | AdditionalTnlNb | C | 0..1 | This IE shall be present if this is an additional indirect data forwarding tunnel for multi-connectivity.

When present, it shall be set to the value 1 to 3 to indicate whether this is the first, second or third additional indirect data forwarding tunnel for multi-connectivity.

This IE shall not present if the drbId IE is present.
(NOTE) | + +NOTE: If neither the drbId IE nor the additionalTnlNb IE is present, the tunnel information shall correspond to the PDU session level indirect data forwarding tunnel (i.e. DL Forwarding UP TNL Information IE or UL Forwarding UP TNL Information IE of the Handover Request Acknowledge Transfer IE of clause 9.3.4.11 of 3GPP TS 38.413 [9]). + +## 6.1.6.2.45 Type: SmContextReleasedData + +Table 6.1.6.2.45-1: Definition of type SmContextReleasedData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| smallDataRateStatus | SmallDataRateStatus | C | 0..1 | This IE shall be present, if the NF Service Consumer has indicated support of CIoT and if the status is available.
When present, it shall indicate the current small data rate control status for the PDU session. | CIoT | +| apnRateStatus | ApnRateStatus | C | 0..1 | This IE shall be present, if the NF Service Consumer has indicated support of CIoT and if the status is available.
When present, it shall indicate the current APN rate control status for the PDN connection (APN rates are shared by all PDN connections of the UE to this APN). | CIoT | + +## 6.1.6.2.46 Type: ReleasedData + +Table 6.1.6.2.46-1: Definition of type ReleasedData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| smallDataRateStatus | SmallDataRateStatus | C | 0..1 | This IE shall be present, if the NF Service Consumer has indicated support of CIoT and if available. When present, it shall indicate the current small data rate control status for the PDU session. | CIoT | +| apnRateStatus | ApnRateStatus | C | 0..1 | This IE shall be present, if the NF Service Consumer has indicated support of CIoT and if the status is available. When present, it shall indicate the current APN rate control status for the PDN connection (APN rates are shared by all PDN connections of the UE to this APN). | CIoT | +| n4Info | N4Information | O | 0..1 | This IE may be present if the SMF needs to send N4 information (e.g. acknowledgement of traffic usage reporting) to the I-SMF for traffic offloaded at a PSA controlled by an I-SMF. | DTSSA | +| n4InfoExt1 | N4Information | O | 0..1 | This IE may be present if the SMF needs to send additional N4 information (e.g. acknowledgement of traffic usage reporting) to the I-SMF for traffic offloaded at a PSA controlled by an I-SMF. | DTSSA | +| n4InfoExt2 | N4Information | O | 0..1 | This IE may be present if the SMF needs to send additional N4 information (e.g. acknowledgement of traffic usage reporting) to the I-SMF for traffic offloaded at a PSA controlled by an I-SMF. | DTSSA | + +## 6.1.6.2.47 Type: SendMoDataReqData + +Table 6.1.6.2.47-1: Definition of type SendMoDataReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| moData | ReftToBinaryData | M | 1 | This IE shall reference the mobile originated data (see clause 6.1.6.4.6). | CIoT | +| moExpDataCounter | MoExpDataCounter | C | 0..1 | This IE shall be included if the UE has accessed the network by using "MO exception data" RRC establishment cause and when the AMF decides to send a non-zero value to the SMF.
(NOTE)

When present, this IE shall contain the MO Exception Data Counter. | CIoT | +| ueLocation | UserLocation | O | 0..1 | When present, this IE shall contain the user location. | CIoT | + +NOTE: The AMF increments the MO Exception Data Counter when the UE establishes/resumes RRC with "MO Exception Data" RRC cause. The AMF may defer sending the moExpDataCounter attribute to the SMF based on local configuration. The AMF resets the MO Exception Data Counter when receiving successful response from the SMF. The SMF however keeps incrementing the counter locally. + +## 6.1.6.2.48 Type: CnAssistedRanPara + +Table 6.1.6.2.48-1: Definition of type CnAssistedRanPara + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------|----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| stationaryIndication | StationaryIndication | O | 0..1 | Identifies whether the UE is stationary or mobile (see 3GPP TS 23.502 [3] clause 4.15.6.3). | +| communicationDurationTime | DurationSec | O | 0..1 | Indicates for how long the UE will normally stay in CM-Connected for data transmission (see 3GPP TS 23.502 [3] clause 4.15.6.3). | +| periodicTime | DurationSec | O | 0..1 | Identifies interval time of periodic communication (see 3GPP TS 23.502 [3] clause 4.15.6.3). | +| scheduledCommunicationTime | ScheduledCommunicationTime | O | 0..1 | Identifies time and day of the week when the UE is available for communication (see 3GPP TS 23.502 [3] clause 4.15.6.3). | +| scheduledCommunicationType | ScheduledCommunicationType | O | 0..1 | Indicates that the Scheduled Communication Type (see 3GPP TS 23.502 [3] clause 4.15.6.3). (NOTE 2) | +| trafficProfile | TrafficProfile | O | 0..1 | Identifies the type of data transmission: single packet transmission (UL or DL), dual packet transmission (UL with subsequent DL or DL with subsequent UL), and multiple packets transmission (see 3GPP TS 23.502 [3] clause 4.15.6.3). | +| batteryIndication | BatteryIndication | O | 0..1 | Indicates the power consumption type(s) of the UE (see 3GPP TS 23.502 [3] clause 4.15.6.3). | + +NOTE 1: At least one of optional parameters above shall be present. +NOTE 2: The value of attribute "scheduledCommunicationType" shall be used together with the value of "scheduledCommunicationTime". + +## 6.1.6.2.49 Type: UlclBpInformation + +Table 6.1.6.2.49-1: Definition of type UlclBpInformation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ulclBpUpfId | NfInstanceId | C | 0..1 | This IE shall be present if an UL CL or BP UPF separate from the local PSA is inserted by the I-SMF. When present, it shall contain the identifier of the UL CL or BP UPF. | + +## 6.1.6.2.50 Type: TransferMoDataReqData + +Table 6.1.6.2.50-1: Definition of type TransferMoDataReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------|---------------| +| moData | RefToBinaryData | M | 1 | This IE shall reference the mobile originated data (see clause 6.1.6.4.6). | CIOT | +| moExpDataCounter | MoExpDataCounter | C | 0..1 | This IE shall be present if received from AMF.
When present, this IE shall contain the MO Exception Data Counter. | CIOT | +| ueLocation | UserLocation | O | 0..1 | When present, this IE shall contain the user location. | CIOT | + +## 6.1.6.2.51 Type: TransferMtDataReqData + +Table 6.1.6.2.51-1: Definition of type TransferMtDataReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------|---------------| +| mtData | RefToBinaryData | M | 1 | This IE shall reference the mobile terminated data (see clause 6.1.6.4.7). | CIOT | + +## 6.1.6.2.52 Type: TransferMtDataError + +**Table 6.1.6.2.52-1: Definition of type TransferMtDataError as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|-----------------------|-------------|----------------------------------------------------------|---------------| +| ExtProblemDetails | 1 | Detail information of the problem | | +| TransferMtDataAddInfo | 1 | Additional information to be returned in error response. | | + +## 6.1.6.2.53 Type: TransferMtDataAddInfo + +**Table 6.1.6.2.53-1: Definition of type TransferMtDataAddInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| maxWaitingTime | DurationSec | C | 0..1 | This IE shall be present if available.

When present, this IE shall contain the estimated maximum wait time (see clause 4.25.5 of 3GPP 23.502 [3]). | CIOT | + +## 6.1.6.2.54 Type: VplmnQos + +**Table 6.1.6.2.54-1: Definition of type VplmnQos** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5qi | 5Qi | O | 0..1 | When present, this IE shall contain the 5G QoS Identifier (5QI) accepted or requested for the QoS Flow associated with the default QoS rule. | +| arp | Arp | O | 0..1 | When present, this IE shall contain the Allocation and Retention Priority (ARP) accepted by the VPLMN for the QoS Flow associated with the default QoS rule. | +| sessionAmbr | Ambr | O | 0..1 | When present, this IE shall contain the highest Session-AMBR accepted by the VPLMN for the PDU session. | +| maxFbrDI | BitRate | O | 0..1 | When present, this IE shall contain the Maximum Bit Rate in Downlink accepted by the VPLMN for the QoS Flow associated with the default QoS rule (if this is a GBR QoS Flow). See 3GPP TS 23.501 [2]. | +| maxFbrUI | BitRate | O | 0..1 | When present, this IE shall contain the Maximum Bit Rate in Uplink accepted by the VPLMN for the QoS Flow associated with the default QoS rule (if this is a GBR QoS Flow). See 3GPP TS 23.501 [2]. | +| guaFbrDI | BitRate | O | 0..1 | When present, this IE shall contain the Guaranteed Bit Rate in Downlink accepted by the VPLMN for the QoS Flow associated with the default QoS rule (if this is a GBR QoS Flow). See 3GPP TS 23.501 [2]. | +| guaFbrUI | BitRate | O | 0..1 | This IE shall contain the Guaranteed Bit Rate in Uplink accepted by the VPLMN for the QoS Flow associated with the default QoS rule (if this is a GBR QoS Flow). See 3GPP TS 23.501 [2]. | +| 5qiPL | 5QiPriorityLevel | O | 0..1 | This IE shall contain the 5QI Priority Level when a 5QI Priority Level value different from the standardized Default Priority Level value in the QoS characteristics Table 5.7.4-1 in 3GPP TS 23.501 [2] is required. | + +## 6.1.6.2.55 Type: DdnFailureSubs + +**Table 6.1.6.2.55-1: Definition of type DdnFailureSubs** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|---------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ddnFailureSubsInd | boolean | M | 1 | When present, it shall be set as follows:
- true: Notification of DDN failure is subscribed.

- false (default): Notification of DDN failure is not subscribed. | +| ddnFailureSubsInfoList | array(DdnFailureSubsInfo) | C | 1..N | This IE shall be present, if notification of DDN failure is subscribed, to provide DDN failure subscription details. | + +## 6.1.6.2.56 Type: RetrieveData + +**Table 6.1.6.2.56-1: Definition of type RetrieveData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| smallDataRateStatusReq | boolean | C | 0..1 | This IE shall be present and set to "true" if this is a request to retrieve the Small Data Rate Status of the PDU session.
When present, it shall be set as follows:
- true: small data rate control status is requested.
- false (default): small data rate control status is not requested. | CIOT | +| pduSessionContextType | PduSessionContextType | C | 0..1 | This IE shall be present if this is a request to retrieve the AF Coordination Information during the change of SSC mode 3 PDU Session Anchor with multiple PDU Sessions, if the runtime coordination between old SMF and AF is enabled (see clause 4.3.5.2 of 3GPP TS 23.502 [3]). | EnEDGE | + +## 6.1.6.2.57 Type: RetrievedData + +**Table 6.1.6.2.57-1: Definition of type RetrievedData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| smallDataRateStatus | SmallDataRateStatus | C | 0..1 | This IE shall be present if the information has been requested in the request and is available.
When present, it shall indicate the current small data rate control status for the PDU session. | CIOT | +| afCoordinationInfo | AfCoordinationInfo | C | 0..1 | This IE shall be present if the PDU Session Context type was present in the request and indicated a request to retrieve the AF Coordination Information. | EnEDGE | + +## 6.1.6.2.58 Type: SecurityResult + +**Table 6.1.6.2.58-1: Definition of type SecurityResult** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------|------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| integrityProtectionResult | ProtectionResult | C | 0..1 | This IE shall be included if available.
If present, this IE indicates whether UP integrity protection is performed or not for the concerned PDU session. | +| confidentialityProtectionResult | ProtectionResult | C | 0..1 | This IE shall be included if available.
If present, this IE indicates whether UP ciphering is performed or not for the concerned PDU session. | + +## 6.1.6.2.59 Type: UpSecurityInfo + +**Table 6.1.6.2.59-1: Definition of type UpSecurityInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------|-------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| upSecurity | UpSecurity | M | 1 | This IE shall indicate the security policy for integrity protection and encryption for the user plane of the PDU session. See clause 9.3.1.60 of 3GPP TS 38.413 [9]. | +| maxIntegrityProtectedDataRateUI | MaxIntegrityProtectedDataRate | C | 0..1 | This IE shall be present if the upSecurity IE is present and indicates that integrity protection is preferred or required. See clause 9.3.1.60 of 3GPP TS 38.413 [9].
When present, it shall indicate the maximum integrity protected data rate supported by the UE for uplink. | +| maxIntegrityProtectedDataRateDI | MaxIntegrityProtectedDataRate | C | 0..1 | This IE shall be present if the upSecurity IE is present and indicates that integrity protection is preferred or required.
When present, it shall indicate the maximum integrity protected data rate supported by the UE for downlink. | +| securityResult | SecurityResult | C | 0..1 | This IE shall be included if available.
If present, this IE shall contain the Security Result associated to the PDU session. See clause 9.3.1.60 of 3GPP TS 38.413 [9]. | + +## 6.1.6.2.60 Type: DdnFailureSubInfo + +**Table 6.1.6.2.60-1: Definition of type DdnFailureSubInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifyCorrelationId | string | M | 1 | This IE shall indicate the notification correlation Id provided by the NF service consumer (e.g. AMF) when subscribing to the notification of the DDN Failure, which shall be returned by the SMF when a DDN Failure is notified for this subscription. This parameter can be useful if the NF service consumer has multiple subscriptions for the same PDU session. | +| dddTrafficDescriptorList | array(DddTrafficDescriptor) | C | 1..N | This IE shall be present if it is received from the UDM. When present, it shall contain a list of Traffic Descriptors related to the event of DDN Failure for which the subscription applies. | + +## 6.1.6.2.61 Type: AlternativeQosProfile + +**Table 6.1.6.2.61-1: Definition of type AlternativeQosProfile** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| index | Integer | M | 1 | When present, this IE shall contain the index identifying the alternative QoS profile.
Minimum = 1. Maximum = 8. | +| guaFbrDI | BitRate | O | 0..1 | When present, this IE shall contain the Guaranteed Bit Rate in Downlink. See 3GPP TS 23.501 [2]. | +| guaFbrUI | BitRate | O | 0..1 | When present, this IE shall contain the Guaranteed Bit Rate in Uplink. See 3GPP TS 23.501 [2]. | +| packetDelayBudget | PacketDelBudget | O | 0..1 | When present, this IE shall indicate the packet delay budget. | +| packetErrRate | PacketErrRate | O | 0..1 | When present, this IE shall indicate the packet error rate. | +| maxDataBurstVol | integer | O | 0..1 | Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in Bytes.
Minimum = 1. Maximum = 2000000. | + +## 6.1.6.2.62 Type: ProblemDetailsAddInfo + +**Table 6.1.6.2.62-1: Definition of type ProblemDetailsAddInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| remoteError | boolean | O | 0..1 | When present, this IE shall indicate whether the error is originated by the remote entity or by the entity sending the response, as follows:

  • - true: the error is originated by the remote entity (i.e. H-SMF/SMF or AMF).
  • - false: the error is originated by the entity sending the response (i.e. V-SMF/I-SMF).
This IE shall be present and set to "true" for a HR PDU session or for a PDU session with an I-SMF, when the V-SMF/I-SMF returns an error response to the AMF that was originated by the H-SMF/SMF, or when the V-SMF/I-SMF returns an error response to the H-SMF/SMF that was originated by the AMF.

This IE may be present if the error is originated by the V-SMF/I-SMF. | + +## 6.1.6.2.63 Type: ExtProblemDetails + +**Table 6.1.6.2.63-1: Definition of type ExtProblemDetails as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|-----------------------|-------------|----------------------------------------------------------|---------------| +| ProblemDetails | 1 | Detail information of the problem | | +| ProblemDetailsAddInfo | 1 | Additional information to be returned in error response. | | + +## 6.1.6.2.64 Type: QosMonitoringInfo + +**Table 6.1.6.2.64-1: Definition of type QosMonitoringInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| qosMonitoringInd | boolean | C | 0..1 |

This IE shall be present and set to "true" if QoS monitoring activated for QoS flows of the PDU session is performed using end to end accumulated packet delay reporting in UL GTP-U packets (see clause 5.33.3.3 of 3GPP TS 23.501 [2]).

  • - True: QoS monitoring is performed using end to end accumulated packet delay reporting in UL GTP-U packets (see clause 5.33.3.3 of 3GPP TS 23.501 [2]).
  • - False (default): QoS monitoring is performed using UPF and RAN time information in GTP-U packets (see clause 5.33.3.2 of 3GPP TS 23.501 [2]).

When this attribute is present and set to "true", the I-SMF shall provision the I-UPF to report an end to end accumulated packet delay in UL GTP-U packets as specified in 3GPP TS 29.244 [29].

| + +## 6.1.6.2.65 Type: IpAddress + +**Table 6.1.6.2.65-1: Definition of type IpAddress** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|--------------------------| +| ipv4Addr | Ipv4Addr | C | 0..1 | Indicate an IPv4 Address | +| ipv6Addr | Ipv6Addr | C | 0..1 | Indicate an IPv6 Address | +| ipv6Prefix | Ipv6Prefix | C | 0..1 | Indicate an IPv6 Prefix | + +NOTE: Either ipv4Addr, or ipv6Addr, or ipv6Prefix shall be present. + +## 6.1.6.2.66 Type: RedundantPduSessionInformation + +**Table 6.1.6.2.66-1: Definition of type RedundantPduSessionInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|---------------------| +| rsn | Rsn | M | 1 | RSN | +| pduSessionPairId | integer | O | 0..1 | PDU Session Pair ID | + +## 6.1.6.2.67 Type: QosFlowTunnel + +**Table 6.1.6.2.67-1: Definition of type QosFlowTunnel** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|---------------------------------------------------------| +| qfiList | array(Qfi) | M | 1..N | This IE shall contain the list of QoS Flow Identifiers. | +| tunnelInfo | TunnelInfo | M | 1 | This IE shall contain the RAN Tunnel Information. | + +## 6.1.6.2.68 Type: TargetDnailInfo + +Table 6.1.6.2.68-1: Definition of type TargetDnailInfo + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| targetDnai | Dnai | C | 0..1 | This IE shall be present if the I-SMF selection/ removal or SMF selection per target DNAI is needed.
When present, this IE shall contain the target DNAI.
This IE shall be absent for an SMF triggered I-SMF removal due to the DNAI being no longer used by the PDU Session. | +| smfSelectionType | SmfSelectionType | M | 1 | This IE shall indicate the I-SMF selection or removal for the current PDU session or SMF selection during PDU Session re-establishment for SSC mode 2/3. | + +## 6.1.6.2.69 Type: AfCoordinationInfo + +Table 6.1.6.2.69-1: Definition of type AfCoordinationInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sourceDnai | Dnai | C | 0..1 | This IE shall be present if available. If present, this IE shall contain the source DNAI. | +| sourceUelpv4Addr | Ipv4Addr | C | 0..1 | This IE shall be present if available. If present, this IE shall contain the IPv4 Address of the served UE for the source DNAI. | +| sourceUelpv6Prefix | Ipv6Prefix | C | 0..1 | This IE shall be present if available. If present, this IE shall contain the Ipv6 Address Prefix of the served UE for the source DNAI. | +| notificationInfoList | array(NotificationInfo) | C | 1..N | This IE shall be present if available. If present, this IE shall contain the list of the Notification Correlation ID and Notification URI provided by the NF service consumers. | + +## 6.1.6.2.70 Type: NotificationInfo + +Table 6.1.6.2.70-1: Definition of type NotificationInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifId | string | M | 1 | Notification Correlation ID provided by the NF service consumer. | +| notifUri | Uri | M | 1 | Identifies the recipient of Notifications sent by the SMF. | +| upBufferInd | boolean | C | 0..1 | This IE shall be present, if available.
When present, it shall be set as follows:
- true: uplink buffering is required;

- false (default): uplink buffering is not required. | + +## 6.1.6.2.71 Type: AnchorSmfFeatures + +The AnchorSmfFeatures indicates a list of features supported by the (H-)SMF to the AMF. + +**Table 6.1.6.2.71-1: Definition of type AnchorSmfFeatures** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| psetrSupportInd | boolean | C | 0..1 |

This IE shall be present and set to "true" if the (H-)SMF supports the "PSETR" feature as specified in clause 6.8.1 of 3GPP TS 23.527 [24]. It may be present otherwise.

When present, it shall be set as follows:

  • - true: the (H-)SMF supports the "PSETR" feature
  • - false: the (H-)SMF does not support the "PSETR" feature.
| + +## 6.1.6.2.72 Type: HrsbInfoFromVplmn + +Table 6.1.6.2.72-1: Definition of type HrsbInfoFromVplmn + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| hrsboAuthReqlnd | boolean | C | 0..1 |

This IE shall be present, for a HR PDU session, if the V-SMF requests HR SBO authorization:

  • - in a Create Request; and
  • - in an Update Request sent during a V-SMF insertion (i.e. H-PLMN to V-PLMN mobility) and during an Inter-PLMN V-SMF change (i.e. mobility between different V-PLMNs).

When present, this IE shall be set to true to indicate that authorization of Session Breakout for HR Session in VPLMN is requested.

| +| vEasdfAddr | IpAddress | C | 0..1 |

This IE shall be present during a request for HR-SBO authorization, when using the EAS Discovery procedure with V-EASF for HR-SBO (see clause 6.7.2.3 of 3GPP TS 23.548 [39]) and if available, or if the V-EASDF IP address previously signaled to the H-SMF needs to be changed e.g. as a result of a V-SMF change. When present, this IE shall contain the IP Address of the (new) V-EASDF.

| +| localDnsAddr | IpAddress | O | 0..1 |

This IE may be present during the EAS Discovery Procedure with Local DNS for HR-SBO (see clause 6.7.2.4 of 3GPP TS 23.548 [39]) after UL-CL/BP insertion. When present, it shall be set to the address of the Local DNS Server/Resolver.

| +| easRediscoveryInd | boolean | C | 0..1 |

This IE shall be present, for a HR PDU session, if the UE indicates the support of EAS rediscovery and the V-SMF requests EAS rediscovery in an Update Request sent during a V-SMF insertion (i.e. H-PLMN to V-PLMN mobility) and during an Inter-PLMN V-SMF change (i.e. mobility between different V-PLMNs).

When present, this IE shall be set to true to indicate that EAS rediscovery is requested.

| +| easInfoToRefresh | EasInfoToRefresh | C | 0..1 |

This IE shall be present if the easRediscoveryInd is set to true and the V-SMF receives the information in SM context from source V-SMF or H-SMF.

When present, it shall contain the EAS information to be refreshed for EAS rediscovery.

| +| storedOffloadIds | array(OffloadIdentifier) | C | 1..N |

The IE shall be present when the V-SMF service instance has stored a list of offload identifiers which were received from any H-SMF from the Home PLMN during previous signalling procedures for this HR-SBO PDU session and also for other HR-SBO PDU sessions.

When present, this IE shall contain the list of offload identifiers of the HPLMN that are known by the V-SMF service instance.
(NOTE)

| + +NOTE: The H-SMF assumes that the V-SMF does not know any Offload Identifiers of the HPLMN if this IE is absent. + +## 6.1.6.2.73 Type: HrsbolInfoFromHplmn + +**Table 6.1.6.2.73-1: Definition of type HrsbolInfoFromHplmn** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| hrsboAuthResult | boolean | C | 0..1 |

This IE shall be present, for a HR PDU session, if the H-SMF received a request for HR SBO authorization:

  • - in a Create Response; and
  • - in an Update Response sent during a V-SMF insertion (i.e. H-PLMN to V-PLMN mobility) and during an Inter-PLMN V-SMF change (i.e. mobility between different V-PLMNs).

When present, this IE shall indicate whether HR-SBO request is authorized as follows:

  • - true: authorized.
  • - false: Not authorized.
| +| hDnsAddr | IpAddress | C | 0..1 |

This IE shall be present, when using the EAS Discovery procedure with V-EASF for HR-SBO (see clause 6.7.2.3 of 3GPP TS 23.548 [39]) or the EAS discovery procedure with V-EASDF using IP replacement mechanism for supporting HR-SBO (see clause 6.7.2.5 of 3GPP TS 23.548 [39]), if available.

When present, this IE shall contain the DNS server address of HPLMN to be used:

  • - for DNS requests related with traffic not to be subject to HR-SBO, to configure the V-EASDF when using the EAS Discovery procedure with V-EASF for HR-SBO (see clause 6.7.2.3 of 3GPP TS 23.548 [39]), or
  • - for DNS requests related to traffic subject to HR-SBO, to configure the UPF in VPLMN to perform IP replacement when using the EAS discovery procedure with V-EASDF using IP replacement mechanism for supporting HR-SBO (see clause 6.7.2.5 of 3GPP TS 23.548 [39]). (NOTE 3).
| +| hPlmnAddr | IpAddress | O | 0..1 |

This IE may be present when using the EAS Discovery procedure with V-EASF for HR-SBO (see clause 6.7.2.3 of 3GPP TS 23.548 [39]).

When present, this IE shall contain the HPLMN address information (e.g. H-UPF IP address on N6) to be used by the V-SMF to configure the V-EASDF to build EDNS Client Subnet option for target FQDN of DNS queries which are not authorized for HR-SBO.

| +| vplmnOffloadingInfoList | array(VplmnOffloadingInfo) | O | 0..N |

When present, this IE shall include VPLMN specific Offloading Information list applicable to the PDU session and whose offload identifiers are not yet known by the V-SMF service instance or whose offload identifier's version has changed.

(NOTE 5)(NOTE 6)

| +| offloadIds | array(OffloadIdentifier) | C | 0..N |

When present, this IE shall include a list of specific Offload Ids applicable for the PDU session and that are part of the StoredOffloadIds included in the corresponding request message.

(NOTE 5)(NOTE 6)

| +| internalGroupIds | array(GroupId) | O | 1..N |

When present, this IE shall include the list of internal group identifier if the UE belongs to any subscribed internal group(s).

| +| easIpReplacementInfo | EasIpReplacementInfo | C | 0..1 |

This IE shall be present, for a HR PDU session, if the H-SMF receives the EAS IP replacement information from AF during AF triggered EAS re-discovery and edge relocation via interacting with HPLMN (see clause 6.7.3.2 of 3GPP TS 23.548 [74]).

| + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | When present, this IE shall contain the EAS IP replacement information. | +| targetDnai | Dnai | C | 0..1 | This IE shall be present, for a HR PDU session, if the H-SMF receives the target DNAI from AF during AF triggered EAS re-discovery and edge relocation via interacting with HPLMN (see clause 6.7.3.2 of 3GPP TS 23.548 [74]).

When present, this IE shall contain the target DNAI. | +| NOTE 1: The H-SMF sends the V-EASDF address received from the V-SMF to the UE in n1SmInfoToUe attribute when using the EAS Discovery procedure with V-EASDF for HR-SBO (see clause 6.7.2.3 of 3GPP TS 23.548 [39]). | | | | | +| NOTE 2: The H-SMF sends the Local DNS Server/Resolver address received from the V-SMF to the UE in n1SmInfoToUe attribute when using the EAS Discovery Procedure with Local DNS for HR-SBO (see clause 6.7.2.4 of 3GPP TS 23.548 [39]). | | | | | +| NOTE 3: The H-SMF also sends the DNS server IP address of the HPLMN to the UE in n1SmInfoToUe attribute (via PCO) when using the EAS discovery procedure with V-EASDF using IP replacement mechanism for supporting HR-SBO (see clause 6.7.2.5 of 3GPP TS 23.548 [39]). | | | | | +| NOTE 4: The H-SMF sends the EAS rediscovery indication and EAS information to be refreshed for EAS re-discovery received from the V-SMF to the UE in n1SmInfoToUe attribute. | | | | | +| NOTE 5: When the H-SMF determines that the V-SMF service instance has already received the corresponding Vplmn Offloading Info based on the storedOffloadIds provided by the V-SMF service instance in the corresponding request message and the associated vplmnOffloadInfo has not changed, then in the corresponding response message, the H-SMF shall include the corresponding offload identifier in the offloadIds attribute; otherwise, the H-SMF shall include it in the vplmnOffloadingInfoList attribute. The H-SMF shall always provision a complete list of vplmnOffloadingInfo and/or offloadIds. | | | | | +| NOTE 6: The V-SMF service instance shall always overwrite any vplmnOffloadingInfoList and the offloadIds stored for the PDU session with the latest vplmnOffloadingInfo and/or offloadIds received. When the V-SMF receives a VplmnOffloadingInfo containing an offloadId which is known by the V-SMF, it shall consider that the vplmnOffloadingInfo for the offloadId has changed if the offloadId does not contain a version field or if the offload id has an incremented version number, and if so, the V-SMF service instance shall enforce the changed vplmnOffloadingInfo for the HR-SBO PDU session and also for any other HR-SBO PDU sessions with the same offloadId. | | | | | + +#### 6.1.6.2.74 Type: EasInfoToRefresh + +**Table 6.1.6.2.74-1: Definition of type EasInfoToRefresh** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| ipv4AddressRanges | array(Ipv4AddressRange) | C | 1..N | This IE shall be present if available.
When present, this IE includes the list of impacted ranges of IPv4 addresses which needs to be refreshed. | +| ipv6AddressRanges | array(Ipv6AddressRange) | C | 1..N | This IE shall be present if available.
When present, this IE includes the list of impacted ranges of IPv6 addresses which needs to be refreshed. | +| fqdnList | array(Fqdn) | C | 1..N | This IE shall be present if available.
When present, this IE includes the list of impacted FQDNs which needs to be refreshed. | +| NOTE: At least one of the addressing parameters (ipv4AddressRanges, ipv6AddressRanges or fqdnList) shall be included in the EasInfoToRefresh. | | | | | + +## 6.1.6.2.75 Type: EcnMarkingCongestionInfoReq + +**Table 6.1.6.2.75-1: Definition of type EcnMarkingCongestionInformationReq** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ecnMarkingReq | EcnMarkingReq | C | 0..1 | This IE shall be present when ECN marking for L4S is requested in the NG-RAN.

When present, it shall indicate whether ECN marking for L4S is requested for the UL, the DL or both the UL and the DL, or indicate to stop ECN marking for L4S.
(NOTE) | +| congestionInfoReq | CongestionInfoReq | C | 0..1 | This IE shall be present when QoS monitoring for congestion monitoring is requested in the NG-RAN to enable ECN marking for L4S in the PSA UPF.

When present, this IE shall contain QoS monitoring for congestion information as described in clause 5.45.3 of TS 23.501 [2].
(NOTE) | + +NOTE: Either the ecnMarkingReq IE or the congestionInfoReq IE shall be present. + +## 6.1.6.2.76 Type: EcnMarkingCongestionInfoStatus + +**Table 6.1.6.2.76-1: Definition of type EcnMarkingCongestionInfoStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| qfi | Qfi | M | 1 | This IE shall contain the QoS Flow Identifier. | +| activationStatus | ActivationStatus | M | 1 | This IE shall indicate the established QoS Flows status (active/not active) for QoS monitoring for congestion information or established QoS Flows status (active/not active) for ECN marking for L4S. | + +## 6.1.6.2.77 Type: TscAssistanceInformation + +**Table 6.1.6.2.77-1: Definition of type TscAssistanceInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|---------------------------------------------------------------------------------------------------------|---------------| +| periodicity | UInt32 | O | 0..1 | When present, this IE shall indicate the time period between start of two data bursts in milliseconds. | | +| n6JitterInformation | N6JitterInformation | O | 0..1 | When present, this IE shall indicate the downlink N6 jitter range associated with downlink Periodicity. | | + +## 6.1.6.2.78 Type: N6JitterInformation + +**Table 6.1.6.2.78-1: Definition of type N6JitterInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| lowerJitterInfo | Int32 | C | 0..1 | When present, this IE shall indicate the Lower DL Jitter Measurement. This IE shall be encoded as a signed32 binary integer value containing the downlink packet Jitter (i.e. positive or negative deviation of the arrival time of first packet of a Data Burst compared to the ideal Data Burst start time which is determined based on the DL periodicity) measured in milliseconds. (See also clause 5.27.2 of 3GPP TS 23.501 [2]) | | +| higherJitterInfo | Int32 | C | 0..1 | When present, this IE shall indicate the Higher DL Jitter Measurement. This IE shall be encoded as a signed32 binary integer value containing the downlink packet Jitter (i.e. positive or negative deviation of the arrival time of first packet of a Data Burst compared to the ideal Data Burst start time which is determined based on the DL periodicity) measured in milliseconds. (See also clause 5.27.2 of 3GPP TS 23.501 [2]) | | + +## 6.1.6.3 Simple data types and enumerations + +## 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|--------------------------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProcedureTransactionId | integer | Unsigned integer representing a Procedure Transaction Identity, within the range 0 to 255, as specified in 3GPP TS 24.007 [8]. | +| EpsBearerId | integer | Integer identifying an EPS bearer, within the range 0 to 15, as specified in clause 11.2.3.1.5, bits 5 to 8, of 3GPP TS 24.007 [8]. | +| EpsPdnCnxContainer | string | String with format "byte" as defined in OpenAPI Specification [15], i.e. base64-encoded characters, encoding the UeEpsPdnConnection IE specified in Table 7.3.1-2 or Table 7.3.6-2 of 3GPP TS 29.274 [16] for the N26 interface. | +| EpsBearerContainer | string | String with format "byte" as defined in OpenAPI Specification [15], i.e. base64-encoded characters, encoding the Bearer Context IE specified in Table 7.3.2-2 of 3GPP TS 29.274 [16]. | +| Teid | string | 4-octet GTP tunnel endpoint identifier, as defined in 3GPP TS 29.274 [16], in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the TEID shall appear first in the string, and the character representing the 4 least significant bit of the TEID shall appear last in the string.

Pattern: "[A-Fa-f0-9]{8}"

Example:
A GTP TEID 0x5BD60076 shall be encoded as "5BD60076". | +| EpsBearerContextStatus | string | EPS bearer context status, as defined in octets 3 and 4 of the EPS bearer context status IE in clause 9.9.2.1 of 3GPP TS 24.301 [27], in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the EPS bearer context status shall appear first in the string, and the character representing the 4 least significant bit of the EPS bearer context status shall appear last in the string.

Pattern: '[A-Fa-f0-9]{4}\$'

Example:
An EPS bearer context status IE where only the EBIs 2, 5, 6 and 9 are active shall be encoded as "6402". | +| DrbId | integer | Unsigned integer representing a Data Radio Bearer Identity, within the range 1 to 32, as specified in clause 9.3.1.53 of 3GPP TS 38.413 [9]. | +| AdditionalTnlNb | integer | Unsigned integer, within the range 1 to 3, indicating whether this is the first, second or third additional indirect data forwarding tunnel for multi-connectivity. | +| ForwardingBearerContainer | string | String with format "byte" as defined in OpenAPI Specification [15], i.e. base64-encoded characters, encoding the Bearer Context IE within Context Acknowledge specified in Table 7.3.7-2 of 3GPP TS 29.274 [16]. | +| SecondaryRatUsageDataReportContainer | string | String with format "byte" as defined in OpenAPI Specification [15], i.e. base64-encoded characters, encoding the Secondary RAT Usage Data Report IE within Forward Relocation Complete Acknowledge specified in Table 7.3.4-1 of 3GPP TS 29.274 [16] (starting from octet 1). | + +### 6.1.6.3.3 Enumeration: UpCnxState + +The enumeration UpCnxState represents the state of the user plane connection of a PDU session. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration UpCnxState** + +| Enumeration value | Description | +|-------------------|-------------------------------------------------------------------------------------------------| +| "ACTIVATED" | A N3 tunnel is established between the 5G-AN and UPF. | +| "DEACTIVATED" | No N3 tunnel is established between the 5G-AN and UPF. | +| "ACTIVATING" | A N3 tunnel is being established (the 5G-AN's F-TEID for downlink traffic is not assigned yet). | +| "SUSPENDED" | A N3 tunnel is suspended between the 5G-AN and UPF. | + +#### 6.1.6.3.4 Enumeration: HoState + +The enumeration HoState represents the handover state of a PDU session. It shall comply with the provisions defined in table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: Enumeration HoState** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------------------| +| "NONE" | No handover is in progress for the PDU session. | +| "PREPARING" | A handover is in preparation for the PDU session; see clause 5.2.2.3.4.1. | +| "PREPARED" | A handover is prepared for the PDU session; see clause 5.2.2.3.4.1. | +| "COMPLETED" | The handover is completed. | +| "CANCELLED" | The handover is cancelled. | + +#### 6.1.6.3.5 Enumeration: RequestType + +The enumeration RequestType indicates the type of a PDU session creation request. It shall comply with the provisions defined in table 6.1.6.3.5-1. + +**Table 6.1.6.3.5-1: Enumeration RequestType** + +| Enumeration value | Description | +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "INITIAL_REQUEST" | Request to establish a new PDU session. | +| "EXISTING_PDU_SESSION" | Request referring to an existing PDU session. | +| "INITIAL_EMERGENCY_REQUEST" | Request to establish a new PDU session for Emergency Services. | +| "EXISTING_EMERGENCY_PDU_SESSION" | Request referring to an existing PDU session for Emergency Services. | +| NOTE: | Clause 9.11.3.47 of 3GPP TS 24.501 [7] defines a specific Request type value in NAS PDUs for a MA PDU request. This shall be mapped to the maRequestInd attribute in the Create SM Context Request, Update SM Context Request, Create Request and Update Request. Accordingly, no corresponding value is defined in the RequestType enumeration. | + +#### 6.1.6.3.6 Enumeration: RequestIndication + +The enumeration RequestIndication indicates the request type. It shall comply with the provisions defined in table 6.1.6.3.6-1. + +**Table 6.1.6.3.6-1: Enumeration RequestIndication** + +| Enumeration value | Description | +|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "UE_REQ_PDU_SES_MOD" | UE Requested PDU Session Modification | +| "UE_REQ_PDU_SES_REL" | UE Requested PDU Session Release | +| "PDU_SES_MOB" | PDU Session Mobility (e.g. between 3GPP and non-3GPP access, or from EPS to 5GS with N26 interface) | +| "NW_REQ_PDU_SES_AUTH" | Network Requested PDU Session Authentication. This value is used for the procedures with a secondary authorization/authentication in an Update request initiated by an H-SMF/SMF during e.g. the PDU Session establishment procedure to inform the V-SMF/I-SMF that the H-SMF/SMF decided to initiate the optional PDU Session establishment authentication/authorization procedure (see clause 4.3.2.3 in 3GPP TS 23.502 [3]). | +| "NW_REQ_PDU_SES_MOD" | Network Requested PDU Session Modification | +| "NW_REQ_PDU_SES_REL" | Network Requested PDU Session Release | +| "EBI_ASSIGNMENT_REQ" | EPS Bearer ID Assignment Request or EPS Bearer ID Revocation Request | +| "REL_DUE_TO_5G_AN_REQUEST" | 5G-AN Requested PDU Session Resource Release | + +#### 6.1.6.3.7 Enumeration: NotificationCause + +The enumeration NotificationCause indicates the cause of a notification. It shall comply with the provisions defined in table 6.1.6.3.7-1. + +**Table 6.1.6.3.7-1: Enumeration NotificationCause** + +| Enumeration value | Description | +|------------------------|-----------------------------------------------------------------------------------------| +| "QOS_FULFILLED" | The QoS targets are fulfilled again for the GBR QoS flow. | +| "QOS_NOT_FULFILLED" | The QoS targets are no longer fulfilled for the GBR QoS flow. | +| "UP_SEC_FULFILLED" | The user plane security enforcement "Preferred" is fulfilled again for the PDU session. | +| "UP_SEC_NOT_FULFILLED" | The user plane security enforcement "Preferred" is not fulfilled for the PDU session. | + +#### 6.1.6.3.8 Enumeration: Cause + +The enumeration Cause indicates a cause information. It shall comply with the provisions defined in table 6.1.6.3.8-1. + +**Table 6.1.6.3.8-1: Enumeration Cause** + +| Enumeration value | Description | +|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "REL_DUE_TO_HO" | Release due to Handover | +| "EPS_FALLBACK" | Mobility due to EPS fallback for IMS voice is on-going. | +| "REL_DUE_TO_UP_SEC" | Release due to user plane Security requirements that cannot be fulfilled. | +| "DNN_CONGESTION" | Release due to the DNN based congestion control. | +| "S_NSSAI_CONGESTION" | Release due to the S-NSSAI based congestion control. | +| "REL_DUE_TO_REACTIVATION" | Release due to PDU session reactivation. | +| "5G_AN_NOT_RESPONDING" | The 5G AN did not respond to the request initiated by the network. | +| "REL_DUE_TO_SLICE_NOT_AVAILABLE" | Release due to the associated S-NSSAI becomes no longer available (e.g. the validity time of the S-NSSAI expires, or the S-NSSAI is decommissioned, etc.). | +| "REL_DUE_TO_DUPLICATE_SESSION_ID" | Release due to a UE request to establish a new PDU session with an identical PDU session Id. | +| "PDU_SESSION_STATUS_MISMATCH" | Release due to mismatch of PDU Session status between UE and AMF. | +| "HO_FAILURE" | Handover preparation failure | +| "INSUFFICIENT_UP_RESOURCES" | Failure to activate the User Plane connection of a PDU session due to insufficient user plane resources. | +| "PDU_SESSION_HANDED_OVER" | The PDU session is handed over to another system or access. | +| "PDU_SESSION_RESUMED" | Resume the user plane connection of the PDU session. | +| "CN_ASSISTED_RAN_PARAMETER_TUNING" | SMF derived CN assisted RAN parameters tuning. | +| "ISMF_CONTEXT_TRANSFER" | The PDU session shall be transferred from old I-SMF to new I-SMF. | +| "SMF_CONTEXT_TRANSFER" | The PDU session shall be transferred from old SMF to new SMF. | +| "REL_DUE_TO_PS_TO_CS_HO" | Release due to 5G SRVCC from NG-RAN to 3GPP UTRAN, as specified in clause 6.5.4 of 3GPP TS 23.216 [35]. | +| "REL_DUE_TO_SUBSCRIPTION_CHANGE" | PDU session release due to UE subscription changes, triggered by the SMF e.g. due to the removal of subscribed DNNs, or by the AMF e.g. due to ODB changes. | +| "HO_CANCEL" | Handover cancellation | +| "REL_DUE_TO_SLICE_NOT_AUTHORIZED" | Release due to Network Slice-Specific Authentication and Authorization failure or revocation. | +| "PDU_SESSION_HAND_OVER_FAILURE" | Failure to handover PDU session to another access | +| "DDN_FAILURE_STATUS" | DDN failure status reporting | +| "REL_DUE_TO_CP_ONLY_NOT_APPLICABLE" | Release due to Control Plane Only indication associated with PDU Session is not applicable any longer | +| "NOT_SUPPORTED_WITH_ISMF" | PDU session release due to a requested functionality that is not supported for a PDU session with an I-SMF/V-SMF. | +| "CHANGED_ANCHOR_SMF" | The anchor SMF of the PDU session is changed. | +| "CHANGED_INTERMEDIATE_SMF" | The intermediate SMF (e.g. I-SMF or V-SMF) is changed. | +| "TARGET_DNAI_NOTIFICATION" | Notify the target DNAI for I-SMF selection for the current PDU Session, or SMF selection during PDU Session re-establishment for SSC mode 2/3. | +| "REL_DUE_TO_VPLMN_QOS_FAILURE" | Release due to QoS not complying with | + +| | | +|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | VPLMN QoS constraints, i.e. VPLMN QoS constraints are required for the PDU session and the H-SMF provides QoS parameters not complying with VPLMN QoS required by the V-SMF. | +|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | +|-----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "REL_DUE_TO_SMF_NOT_SUPPORT_PSETR" | Release the PDU session due to the (H-)SMF does not support the PSETR feature when the V/I-SMF has failed. | +| "REL_DUE_TO_SNPN_SNPN_MOBILITY" | Release due to the PDU session is rejected by the new AMF during registration procedure as the continuity of the PDU Session cannot be supported between networks with SNPN-SNPN mobility. | +| "REL_DUE_TO_NO_HR_AGREEMENT" | Release due to the PDU session is rejected by the new AMF during registration procedure as the continuity of the PDU Session cannot be supported between networks with inter-PLMN mobility where no HR agreement exists. | +| "REL_DUE_TO_SNSSAI_DENIED" | Release due to the subscriber does not have the necessary subscription to access the SNSSAI. | +| "REL_DUE_TO_DNN_DENIED" | Release due to the subscriber does not have the necessary subscription to access the DNN. | +| "REL_DUE_TO_PDUTYPE_DENIED" | Release due to the subscriber does not have the necessary subscription for the requested PDU session type. | +| "REL_DUE_TO_SSC_DENIED" | Release due to the subscriber does not have the necessary subscription for the requested SSC mode. | +| "REL_DUE_TO_SUBSCRIPTION_DENIED" | Release due to an error, other than those listed in this table, due to lack of necessary subscription to serve the UE request. | +| "REL_DUE_TO_DNN_NOT_SUPPORTED" | Release due to the DNN is not supported by the SMF. | +| "REL_DUE_TO_PDUTYPE_NOT_SUPPORTED" | Release due to the requested PDU session type is not supported by the SMF for the PDN corresponding to the DNN. | +| "REL_DUE_TO_SSC_NOT_SUPPORTED" | Release due to the requested SSC mode is not supported by the SMF for the PDN corresponding to the DNN. | +| "REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE" | Release due to insufficient resources for the specific slice. | +| "REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE_DNN" | Release due to insufficient resources for the specific slice and DNN. | +| "REL_DUE_TO_DNN_CONGESTION" | The SMF has detected congestion for the requested DNN and performs overload control for that DNN which does not allow the PDU session to be established. | +| "REL_DUE_TO_S_NSSAI_CONGESTION" | The SMF has detected congestion for the requested S-NSSAI and performs overload control for that S-NSSAI which does not allow the PDU session to be established. | +| "REL_DUE_TO_PEER_NOT_RESPONDING" | No response is received from a remote peer, or the remote peer is known to be not reachable, e.g. to indicate that no response has been received from the H-SMF for a HR PDU session or the SMF for a PDU session with I-SMF. | +| "REL_DUE_TO_NETWORK_FAILURE" | The request is rejected due to a network problem. | +| "REL_DUE_TO_UPF_NOT_RESPONDING" | The request is rejected due to no response received from the UPF. | +| "REL_DUE_TO_NO_EPS_5GS_CONTINUITY" | It is used during an EPS to 5GS Idle mode mobility or handover, if the PDU session does not support seamless session continuity to 5GS. | +| "REL_DUE_TO_NOT_SUPPORTED_WITH_ISMF" | The request is rejected due to a requested functionality that is not supported for a PDU session with an I-SMF/V-SMF. | + +| | | +|---------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "REL_DUE_TO_EXCEEDED_UE_SLICE_DATA_RATE" | The request is rejected due to the maximum bit rate per S-NSSAI per UE is exceeded, when the SMF receives the same application error from the PCF. | +| "REL_DUE_TO_EXCEEDED_SLICE_DATA_RATE" | The request is rejected due to the maximum bit rate per S-NSSAI is exceeded, when the SMF receives the same application error from the PCF. | +| "REL_DUE_TO_CONTEXT_NOT_FOUND" | It is used when no context corresponding to the request exists in the SMF. | +| "REL_DUE_TO_UNSPECIFIED_REASON" | Release due to unspecified reasons. | +| "REL_DUE_TO_MOB_ACCESS_RESTRICTIONS" | Release due to Mobility Restrictions or Access Restrictions (e.g. CAG restrictions). | +| "REL_DUE_TO_SLICE_INACTIVITY" | Release due to slice inactivity (i.e. slice-specific inactivity period for the PDU session expires), as specified in clause 5.15.15.3 of 3GPP TS 23.501 [2] and clause 5.11.2 of 3GPP TS 29.244 [29]. | +| "REL_DUE_TO_NSI_NOT_AVAILABLE" | Release due to the associated Network Slice Instance is congested or not available, as specified in clause 5.2.16.3.3 of 3GPP TS 23.502 [3]. | +| "REL_DUE_TO_MBSR_NOT_AUTHORIZED" | Release due to the MBSR authorization status is changed from "authorized" to "not authorized". | +| "DEACT_DUE_TO_UE_OUT_OF_SLICE_SUPPORT_AREA" | User Plane deactivation due to the UE moving out of the network slice area of support or availability, as specified in clause 4.3.7 of 3GPP TS 23.502 [3]. | +| "REJECT_DUE_TO_N1_SM_ERROR" | The PDU Session is rejected due to N1 SM Error, e.g. PDU session establishment rejected due to Operator Determined Barring. | + +### 6.1.6.3.9 Enumeration: ResourceStatus + +The enumeration ResourceStatus indicates the status of an SM context or PDU session resource. It shall comply with the provisions defined in table 6.1.6.3.9-1. + +**Table 6.1.6.3.9-1: Enumeration ResourceStatus** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| "RELEASED" | The SM context or PDU session resource is released. | | +| "UNCHANGED" | The status of SM context or PDU session resource is not changed. | | +| "TRANSFERRED" | The SM context shall be transferred. | | +| "UPDATED" | The SM context or PDU session resource context has changed:
  • - The access type of PDU session is changed.
  • - The anchor SMF (H-SMF or SMF) or intermediate SMF (I-SMF or V-SMF) has changed within the SMF set.
  • - The SM context with the I-SMF in the source access needs to be released but without releasing the PDU session in the AMF (see clauses 5.2.2.5.1 and 5.2.2.10.1).
| HOFAIL
ES3XX
DTSSA | +| "ALT_ANCHOR_SMF" | The V-SMF has established the PDU session towards an alternative H-SMF during PDU session establishment for HR PDU session, as specified in clause 4.3.2.2.2 of 3GPP TS 23.502 [3], or the I-SMF has established the PDU session towards an alternative SMF during PDU session establishment for a PDU session with I-SMF (see clause 4.23.5.1 of 3GPP TS 23.502 [3]). | AASN | + +#### 6.1.6.3.10 Enumeration: DnnSelectionMode + +The enumeration DnnSelectionMode indicates whether the DNN of a PDU session being established corresponds to an explicitly subscribed DNN or to the usage of a wildcard subscription. It shall comply with the provisions defined in table 6.1.6.3.10-1. + +**Table 6.1.6.3.10-1: Enumeration DnnSelectionMode** + +| Enumeration value | Description | +|-----------------------|--------------------------------------------------------------------------------------------------------| +| "VERIFIED" | UE or network provided DNN is authorized based on the explicitly subscribed DNN, subscription verified | +| "UE_DNN_NOT_VERIFIED" | UE provided DNN is authorized based on the wildcard DNN, subscription not verified | +| "NW_DNN_NOT_VERIFIED" | Network provided DNN is authorized based on the wildcard DNN, subscription not verified | + +#### 6.1.6.3.11 Enumeration: EpsInterworkingIndication + +The enumeration EpsInterworkingIndication indicates whether and how the PDU session will possibly be moved to EPS. + +**Table 6.1.6.3.11-1: Enumeration EpsInterworkingIndication** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "NONE" | The PDU session cannot be moved EPS.
(NOTE) | +| "WITH_N26" | The PDU session may possibly be moved to EPS, with N26 interface supported during EPS interworking procedures.

This may correspond to:
- a PDU session or an MA-PDU session with a 3GPP access; or
- a MA PDU Session with a non-3GPP access for a UE registered to the same PLMN over both 3GPP and non-3GPP accesses, i.e. served by the same AMF for both accesses. | +| "WITHOUT_N26" | The PDU session may possibly be moved to EPS, without N26 interface supported during EPS interworking procedures.

This may correspond to:
- a PDU session or an MA-PDU session with a 3GPP access; or
- a MA PDU Session with a non-3GPP access for a UE registered to the same PLMN over both 3GPP and non-3GPP accesses, i.e. served by the same AMF for both accesses. | +| "IWK_NON_3GPP" | The PDU session via non-3GPP access may possibly be moved to EPS. | +| NOTE: | Handover from 5GS to EPC/ePDG (as specified in clause 4.11.4.2 of 3GPP TS 23.502 [3]) shall be considered as allowed if the value of EpsInterworkingIndication is not set to "NONE" and if such handover is allowed based on operator's policy. | + +## 6.1.6.3.12 Enumeration: N2SmInfoType + +Table 6.1.6.3.12-1: Enumeration N2SmInfoType + +| Enumeration value | Description | +|---------------------------|--------------------------------------------------------------| +| "PDU_RES_SETUP_REQ" | PDU Session Resource Setup Request Transfer | +| "PDU_RES_SETUP_RSP" | PDU Session Resource Setup Response Transfer | +| "PDU_RES_SETUP_FAIL" | PDU Session Resource Setup Unsuccessful Transfer | +| "PDU_RES_REL_CMD" | PDU Session Resource Release Command Transfer | +| "PDU_RES_REL_RSP" | PDU Session Resource Release Response Transfer | +| "PDU_RES_MOD_REQ" | PDU Session Resource Modify Request Transfer | +| "PDU_RES_MOD_RSP" | PDU Session Resource Modify Response Transfer | +| "PDU_RES_MOD_FAIL" | PDU Session Resource Modify Unsuccessful Transfer | +| "PDU_RES_NTY" | PDU Session Resource Notify Transfer | +| "PDU_RES_NTY_REL" | PDU Session Resource Notify Released Transfer | +| "PDU_RES_MOD_IND" | PDU Session Resource Modify Indication Transfer | +| "PDU_RES_MOD_CFM" | PDU Session Resource Modify Confirm Transfer | +| "PATH_SWITCH_REQ" | Path Switch Request Transfer | +| "PATH_SWITCH_SETUP_FAIL" | Path Switch Request Setup Failed Transfer | +| "PATH_SWITCH_REQ_ACK" | Path Switch Request Acknowledge Transfer | +| "PATH_SWITCH_REQ_FAIL" | Path Switch Request Unsuccessful Transfer | +| "HANDOVER_REQUIRED" | Handover Required Transfer | +| "HANDOVER_CMD" | Handover Command Transfer | +| "HANDOVER_PREP_FAIL" | Handover Preparation Unsuccessful Transfer | +| "HANDOVER_REQ_ACK" | Handover Request Acknowledge Transfer | +| "HANDOVER_RES_ALLOC_FAIL" | Handover Resource Allocation Unsuccessful Transfer | +| "SECONDARY_RAT_USAGE" | Secondary RAT Data Usage Report Transfer | +| "PDU_RES_MOD_IND_FAIL" | PDU Session Resource Modify Indication Unsuccessful Transfer | +| "UE_CONTEXT_RESUME_REQ" | UE Context Resume Request Transfer | +| "UE_CONTEXT_RESUME_RSP" | UE Context Resume Response Transfer | +| "UE_CONTEXT_SUSPEND_REQ" | UE Context Suspend Request Transfer | + +## 6.1.6.3.13 Enumeration: MaxIntegrityProtectedDataRate + +Table 6.1.6.3.13-1: Enumeration MaxIntegrityProtectedDataRate + +| Enumeration value | Description | +|-------------------|----------------| +| "64_KBPS" | 64 kbps | +| "MAX_UE_RATE" | Full data rate | + +## 6.1.6.3.14 Enumeration: MaReleaseIndication + +The enumeration MaReleaseIndication indicates the access type over which the MA PDU session is requested to be released. + +Table 6.1.6.3.14-1: Enumeration MaReleaseIndication + +| Enumeration value | Description | +|------------------------|---------------------------------------------------------------------------------| +| "REL_MAPDU_OVER_3GPP" | The MA PDU session over 3GPP access is to be released or has been released. | +| "REL_MAPDU_OVER_N3GPP" | The MA PDU session over Non-3GPP access is to be released or has been released. | + +## 6.1.6.3.15 Enumeration: SmContextType + +The enumeration SmContextType represents the type of SM context information requested during a Retrieve SM Context service operation. It shall comply with the provisions defined in table 6.1.6.3.15-1. + +**Table 6.1.6.3.15-1: Enumeration SmContextType** + +| Enumeration value | Description | +|------------------------|------------------------------------------------------------------------------------------------------------| +| "EPS_PDN_CONNECTION" | UE EPS PDN Connection. | +| "SM_CONTEXT" | Complete SM Context (i.e. 5G SM context including EPS context information as defined in clause 6.1.6.2.39) | +| "AF_COORDINATION_INFO" | AF Coordination Information | + +#### 6.1.6.3.16 Enumeration: PsaIndication + +The enumeration PsaIndication indicates whether a PSA and an UL CL or BP, or only a PSA has been inserted or removed to/from the data path of a PDU session by an I-SMF. It shall comply with the provisions defined in table 6.1.6.3.16-1. + +**Table 6.1.6.3.16-1: Enumeration PsaIndication** + +| Enumeration value | Description | +|---------------------|---------------------------------------------------------------------------------------------------| +| "PSA_INSERTED" | A PSA and UL CL or BP has been inserted into the data path of the PDU session. | +| "PSA_REMOVED" | A PSA and UL CL or BP has been removed from the data path of the PDU session. | +| "PSA_INSERTED_ONLY" | A PSA has been inserted into the data path of the PDU session and the UL CL or BP is not changed. | +| "PSA_REMOVED_ONLY" | A PSA has been removed from the data path of the PDU session and the UL CL or BP is not changed. | + +#### 6.1.6.3.17 Enumeration: N4MessageType + +The enumeration N4MessageType indicates the PFCP message type sent within a N4 Message Payload. It shall comply with the provisions defined in table 6.1.6.3.17-1. + +**Table 6.1.6.3.17-1: Enumeration N4MessageType** + +| Enumeration value | Description | +|--------------------|-------------------------------------| +| "PFCP_SES_EST_REQ" | PFCP Session Establishment Request | +| "PFCP_SES_EST_RSP" | PFCP Session Establishment Response | +| "PFCP_SES_MOD_REQ" | PFCP Session Modification Request | +| "PFCP_SES_MOD_RSP" | PFCP Session Modification Response | +| "PFCP_SES_DEL_REQ" | PFCP Session Deletion Request | +| "PFCP_SES_DEL_RSP" | PFCP Session Deletion Response | +| "PFCP_SES_REP_REQ" | PFCP Session Report Request | +| "PFCP_SES_REP_RSP" | PFCP Session Report Response | + +#### 6.1.6.3.18 Enumeration: QosFlowAccessType + +The enumeration QosFlowAccessType indicates the access type which the QoS Flow is associated with. + +**Table 6.1.6.3.18-1: Enumeration QosFlowAccessType** + +| Enumeration value | Description | +|---------------------|-----------------------------------------------------------------------| +| "3GPP" | The QoS Flow is only associated with 3GPP access. | +| "NON_3GPP" | The QoS Flow is only associated with Non-3GPP access. | +| "3GPP_AND_NON_3GPP" | The QoS Flow is associated with both 3GPP access and Non-3GPP access. | + +#### 6.1.6.3.19 Enumeration: UnavailableAccessIndication + +The enumeration UnavailableAccessIndication indicates the access type of the MA PDU session that is unavailable. + +**Table 6.1.6.3.19-1: Enumeration UnavailableAccessIndication** + +| Enumeration value | Description | +|--------------------|-----------------------------------------------------------| +| "3GA_UNAVAILABLE" | The 3GPP access of the MA PDU session is unavailable. | +| "N3GA_UNAVAILABLE" | The Non-3GPP access of the MA PDU session is unavailable. | + +#### 6.1.6.3.20 Enumeration: ProtectionResult + +The enumeration ProtectionResult indicates whether the security policy indicated as "preferred" is performed or not. + +**Table 6.1.6.3.20-1: Enumeration ProtectionResult** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------| +| "PERFORMED" | The security policy indicated as "preferred" is performed | +| "NOT_PERFORMED" | The security policy indicated as "preferred" is not performed | + +#### 6.1.6.3.21 Enumeration: QosMonitoringReq + +The enumeration QosMonitoringReq indicates the measurement of UL, or DL, or both UL/DL delays, or no measurements are required. + +**Table 6.1.6.3.21-1: Enumeration QosMonitoringReq** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------------------------| +| "UL" | Measurement of UL delay. | +| "DL" | Measurement of DL delay. | +| "BOTH" | Measurement of both UL/DL delays. | +| "NONE" | No measurements are required. This value shall be used to stop on-going UL and/or DL measurements. | + +#### 6.1.6.3.22 Enumeration: Rsn + +The enumeration Rsn indicates the RSN value which differentiates the PDU sessions that are handled redundantly (see clause 5.33.2.1 of 3GPP TS 23.501 [2]). + +**Table 6.1.6.3.22-1: Enumeration Rsn** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------------------------------------------| +| "V1" | V1 | +| "V2" | V2 | +| "NONE" | This value indicates that no RSN value is available (NOTE) | +| NOTE: | This value shall be used in a Create Request if a PDU Session Pair ID was received from the UE without an RSN value. | + +#### 6.1.6.3.23 Enumeration: SmfSelectionType + +The enumeration SmfSelectionType represents the I-SMF selection or removal for the current PDU Session, or the SMF selection during PDU Session re-establishment for SSC mode 2/3. It shall comply with the provisions defined in table 6.1.6.3.23-1. + +**Table 6.1.6.3.23-1: Enumeration SmfSelectionType** + +| Enumeration value | Description | +|-----------------------|-----------------------------------------------------------------------------------------------| +| "CURRENT_PDU_SESSION" | I-SMF selection or removal for the current PDU Session. | +| "NEXT_PDU_SESSION" | SMF selection for the next PDU Session, i.e. the re-established PDU session for SSC mode 2/3. | + +#### 6.1.6.3.24 Enumeration: PduSessionContextType + +The enumeration PduSessionContextType represents the type of PDU Session information requested during a Retrieve service operation. It shall comply with the provisions defined in table 6.1.6.3.24-1. + +**Table 6.1.6.3.24-1: Enumeration PduSessionContextType** + +| Enumeration value | Description | +|------------------------|-----------------------------| +| "AF_COORDINATION_INFO" | AF Coordination Information | + +#### 6.1.6.3.25 Enumeration: PendingUpdateInfo + +The enumeration PendingUpdateInfo indicates the information that are not required to be updated in real-time. + +**Table 6.1.6.3.25-1: Enumeration PendingUpdateInfo** + +| Enumeration value | Description | +|-------------------|------------------------| +| "UE_LOCATION" | UE Location | +| "TIMEZONE" | Timezone | +| "ACCESS_TYPE" | Access Type | +| "RAT_TYPE" | Radio Access Type | +| "AMF_ID" | Serving AMF Identifier | + +#### 6.1.6.3.26 Enumeration: EstablishmentRejectionCause + +The enumeration EstablishmentRejectionCause indicates the reason to reject the PDU session establishment request. + +**Table 6.1.6.3.26-1: Enumeration EstablishmentRejectionCause** + +| Enumeration value | Description | +|-------------------------------|------------------------------------------------------------------------------| +| "OPERATOR_DETERMINED_BARRING" | PDU Session Establishment to be rejected due to Operator Determined Barring. | + +#### 6.1.6.3.27 Enumeration: EcnMarkingReq + +**Table 6.1.6.3.27-1: Enumeration EcnMarkingReq** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------|---------------| +| UL | ECN marking for L4S for the UL. | | +| DL | ECN marking for L4S for the DL. | | +| BOTH | ECN marking for L4S for the UL and the DL. | | +| STOP | Stop ECN marking for L4S. | | + +#### 6.1.6.3.28 Enumeration: CongestionInfoReq + +**Table 6.1.6.3.28-1: Enumeration CongestionInfoReq** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------|---------------| +| UL | Indicates to NG-RAN to report the congestion information of the QoS Flow on UL direction. | | +| DL | Indicates to NG-RAN to report the congestion information of the QoS Flow on DL direction. | | +| BOTH | Indicates to NG-RAN to report the congestion information of the QoS Flow on UL and DL directions. | | +| STOP | Indicates to NG-RAN to stop reporting the congestion information of the QoS Flow. | | + +### 6.1.6.3.29 Enumeration: ActivationStatus + +**Table 6.1.6.3.29-1: Enumeration ActivationStatus** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ACTIVE | Indicates that the established QoS Flows status for QoS monitoring for congestion information or for ECN marking for L4S is active. | | +| NOT_ACTIVTE | Indicates that the established QoS Flows status for QoS monitoring for congestion information or for ECN marking for L4S is not active. | | + +### 6.1.6.4 Binary data + +#### 6.1.6.4.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.1.2.2.2 and 6.1.2.4). + +**Table 6.1.6.4.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|--------------------|----------------|----------------| +| N1 SM Message | 6.1.6.4.2 | vnd.3gpp.5gnas | +| N2 SM Information | 6.1.6.4.3 | vnd.3gpp.ngap | +| n1SmInfoFromUe | 6.1.6.4.4 | vnd.3gpp.5gnas | +| n1SmInfoToUe | 6.1.6.4.4 | vnd.3gpp.5gnas | +| unknownN1SmInfo | 6.1.6.4.4 | vnd.3gpp.5gnas | +| N4 Message Payload | 6.1.6.4.5 | vnd.3gpp.pfcp | + +#### 6.1.6.4.2 N1 SM Message + +N1 SM Message shall encode a 5GS NAS SM message as specified in 3GPP TS 24.501 [7], using the vnd.3gpp.5gnas content-type. + +N1 SM Message may encode any 5GS NAS SM message specified in 3GPP TS 24.501 [7], as summarized in Table 6.1.6.4.2-1. + +**Table 6.1.6.4.2-1: N1 SM Message content** + +| 5GS NAS message | Reference
(3GPP TS 24.501 [7]) | +|-----------------------------------------|-----------------------------------| +| PDU session establishment request | 8.3.1 | +| PDU session establishment accept | 8.3.2 | +| PDU session establishment reject | 8.3.3 | +| PDU session authentication command | 8.3.4 | +| PDU session authentication complete | 8.3.5 | +| PDU session authentication result | 8.3.6 | +| PDU session modification request | 8.3.7 | +| PDU session modification reject | 8.3.8 | +| PDU session modification command | 8.3.9 | +| PDU session modification complete | 8.3.10 | +| PDU session modification command reject | 8.3.11 | +| PDU session release request | 8.3.12 | +| PDU session release reject | 8.3.13 | +| PDU session release command | 8.3.14 | +| PDU session release complete | 8.3.15 | +| 5GSM status | 8.3.16 | +| Service-level authentication command | 8.3.17 | +| Service-level authentication complete | 8.3.18 | +| Remote UE Report | 8.3.19 | +| Remote UE Report Response | 8.3.20 | + +### 6.1.6.4.3 N2 SM Information + +N2 SM Information shall encode NG Application Protocol (NGAP) IEs, as specified in clause 9.3 of 3GPP TS 38.413 [9] (ASN.1 encoded), using the vnd.3gpp.ngap content-type. + +N2 SM Information may encode any NGAP SMF related IE specified in 3GPP TS 38.413 [9], as summarized in Table 6.1.6.4.3-1. + +**Table 6.1.6.4.3-1: N2 SM Information content** + +| N2 SM IE | Reference
(3GPP TS 38.413 [9])
| Related NGAP message | +|--------------------------------------------------------------|-------------------------------------------|-----------------------------------------------------------------------------------------| +| PDU Session Resource Setup Request Transfer | 9.3.4.1 | PDU SESSION RESOURCE SETUP REQUEST
INITIAL CONTEXT SETUP REQUEST
HANDOVER REQUEST | +| PDU Session Resource Setup Response Transfer | 9.3.4.2 | PDU SESSION RESOURCE SETUP RESPONSE
INITIAL CONTEXT SETUP RESPONSE | +| PDU Session Resource Setup Unsuccessful Transfer | 9.3.4.16 | PDU SESSION RESOURCE SETUP RESPONSE
INITIAL CONTEXT SETUP RESPONSE | +| PDU Session Resource Release Command Transfer | 9.3.4.12 | PDU SESSION RESOURCE RELEASE COMMAND | +| PDU Session Resource Release Response Transfer | 9.3.4.21 | PDU SESSION RESOURCE RELEASE RESPONSE
UE CONTEXT RELEASE COMPLETE | +| PDU Session Resource Modify Request Transfer | 9.3.4.3 | PDU SESSION RESOURCE MODIFY REQUEST | +| PDU Session Resource Modify Response Transfer | 9.3.4.4 | PDU SESSION RESOURCE MODIFY RESPONSE | +| PDU Session Resource Modify Unsuccessful Transfer | 9.3.4.17 | PDU SESSION RESOURCE MODIFY RESPONSE | +| PDU Session Resource Notify Transfer | 9.3.4.5 | PDU SESSION RESOURCE NOTIFY | +| PDU Session Resource Notify Released Transfer | 9.3.4.13 | PDU SESSION RESOURCE NOTIFY | +| PDU Session Resource Modify Indication Transfer | 9.3.4.6 | PDU SESSION RESOURCE MODIFY INDICATION | +| PDU Session Resource Modify Confirm Transfer | 9.3.4.7 | PDU SESSION RESOURCE MODIFY CONFIRM | +| PDU Session Resource Modify Indication Unsuccessful Transfer | 9.3.4.22 | PDU SESSION RESOURCE MODIFY CONFIRM | +| Path Switch Request Transfer | 9.3.4.8 | PATH SWITCH REQUEST | +| Path Switch Request Setup Failed Transfer | 9.3.4.15 | PATH SWITCH REQUEST | +| Path Switch Request Acknowledge Transfer | 9.3.4.9 | PATH SWITCH REQUEST ACKNOWLEDGE | +| Path Switch Request Unsuccessful Transfer | 9.3.4.20 | PATH SWITCH REQUEST ACKNOWLEDGE
PATH SWITCH REQUEST FAILURE | +| Handover Required Transfer | 9.3.4.14 | HANDOVER REQUIRED | +| Handover Request Acknowledge Transfer | 9.3.4.11 | HANDOVER REQUEST ACKNOWLEDGE | +| Handover Resource Allocation Unsuccessful Transfer | 9.3.4.19 | HANDOVER REQUEST ACKNOWLEDGE | +| Handover Command Transfer | 9.3.4.10 | HANDOVER COMMAND | +| Handover Preparation Unsuccessful Transfer | 9.3.4.18 | HANDOVER COMMAND | +| Secondary RAT Data Usage Report Transfer | 9.3.4.23 | SECONDARY RAT DATA USAGE REPORT | +| UE Context Resume Request Transfer | 9.3.4.24 | UE CONTEXT RESUME REQUEST | +| UE Context Resume Response Transfer | 9.3.4.25 | UE CONTEXT RESUME RESPONSE | +| UE Context Suspend Request Transfer | 9.3.4.26 | UE CONTEXT SUSPEND REQUEST | + +#### 6.1.6.4.4 n1SmInfoFromUe, n1SmInfoToUe, unknownN1SmInfo + +n1SmInfoFromUe, n1SmInfoToUe and unknownN1SmInfo shall encode one or more NAS SM IEs, including the Type and Length fields, as specified in 3GPP TS 24.501 [7], using the vnd.3gpp.5gnas content-type. + +Clause 5.2.3.1 specifies the information that shall be included in these payloads. + +n1SmInfoFromUe and n1SmInfoToUe may encode the 5GS NAS IEs listed in tables 6.1.6.4.4-1 and 6.1.6.4.4-2. + +**Table 6.1.6.4.4-1: n1SmInfoFromUE content** + +| 5GS NAS IE | Reference
(3GPP TS 24.501 [7]) | Related NAS SM message | +|--------------------------------------------|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Message type | 9.7 | All NAS SM messages | +| PDU session type | 9.11.4.11 | PDU Session Establishment Request | +| SSC mode | 9.11.4.16 | PDU Session Establishment Request | +| Maximum number of supported packet filters | 9.11.4.9 | PDU Session Establishment Request
PDU Session Modification Request | +| Integrity protection maximum data rate | 9.11.4.7 | PDU Session Modification Request
(NOTE 3) | +| SM PDU DN request container | 9.11.4.15 | PDU Session Establishment Request | +| Extended protocol configuration options | 9.11.4.6 | PDU Session Establishment Request
PDU Session Authentication Complete
PDU Session Modification Request
PDU Session Modification Complete
PDU Session Modification Command Reject
PDU Session Release Request
PDU Session Release Complete | +| EAP message | 9.11.2.2 | PDU Session Authentication Complete | +| Requested QoS rules | 9.11.4.13 | PDU Session Modification Request | +| Requested QoS flow descriptions | 9.11.4.12 | PDU Session Modification Request | +| 5GSM cause | 9.11.4.2 | PDU Session Modification Request
PDU Session Release Request
PDU Session Release Complete
(NOTE 2) | +| 5GSM capability | 9.11.4.1 | PDU Session Establishment Request
PDU Session Modification Request
(NOTE 1) | +| Mapped EPS bearer contexts | 9.11.4.8 | PDU Session Modification Request | +| Remote UE context connected | 9.11.4.29 | Remote UE Report | +| Remote UE context disconnected | 9.11.4.29 | Remote UE Report | + +NOTE 1: The 5GSM capability IE shall be encoded as received from the UE. It may contain UE capabilities that the V-SMF (or I-SMF) only needs to transfer to the H-SMF (or SMF), e.g. support of reflective QoS, or support of multi-homed IPv6 PDU session, and/or capabilities to be interpreted and used by the V-SMF (or I-SMF). + +NOTE 2: The 5GSM cause IE shall be encoded as received from the UE. +This information is defined as a "V" IE (i.e. without a Type field) in other NAS messages, e.g. PDU Session Modification Command Reject message, in which case it shall be sent as a separate n1SmCause IE over N16/N16a and not within the n1SmInfoToUE binary data. + +NOTE 3: This information is defined as a "V" IE (i.e. without a Type field) in other NAS messages, e.g. PDU Session Establishment Request, in which case it shall be sent as separate maximum integrity protected data rate IEs over N16/N16a and not within the n1SmInfoFromUE binary data. + +**Table 6.1.6.4.4-2: n1SmInfoToUE parameters** + +| 5GS NAS IE | Reference
(3GPP TS 24.501 [7])
| Related NAS SM message | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Message type | 9.7 | All NAS SM messages | +| RQ timer value | 9.11.2.3 | PDU Session Establishment Accept
PDU Session Modification Command | +| EAP message | 9.11.2.2 | PDU Session Establishment Accept
PDU Session Establishment Reject
PDU Session Authentication Command
PDU Session Authentication Result
PDU Session Release Command | +| Allowed SSC mode | 9.11.4.5 | PDU Session Establishment Reject | +| Extended protocol configuration options | 9.11.4.6 | PDU Session Establishment Accept
PDU Session Establishment Reject
PDU Session Authentication Command
PDU Session Authentication Result
PDU Session Modification Reject
PDU Session Modification Command
PDU Session Release Reject
PDU Session Release Command | +| 5GSM cause | 9.11.4.2 | PDU Session Establishment Accept
PDU Session Modification Command
(NOTE) | +| Mapped EPS bearer contexts | 9.11.4.8 | PDU Session Establishment Accept
PDU Session Modification Command | +| ATSSS container | 9.11.4.22 | PDU Session Establishment Accept
PDU Session Modification Command | +| NOTE: This IE indicates the 5GSM cause the H-SMF (or SMF) requires the V-SMF (or I-SMF) to send to the UE. The V-SMF (or I-SMF) shall transfer the received value to the UE without interpretation. This information is defined as a "V" IE (i.e. without a Type field) in other NAS messages, e.g. PDU Session Establishment Reject message, in which case it shall be sent as a separate n1SmCause IE over N16/N16a and not within the n1SmInfoToUE binary data. | | | + +The Message Type shall be present and encoded as the first 5GS NAS IE in any n1SmInfoFromUe, n1SmInfoToUe and unknownN1SmInfo binary data, to enable the receiver to decode the 5GS NAS IEs. + +NOTE: The Information Element Identifier (see clause 11.2.1.1.3 of 3GPP TS 24.007 [8]) of a 5GS NAS IE uniquely identifies an IE in a given message. + +#### 6.1.6.4.5 N4 Message Payload + +The N4 Message Payload shall encode a PFCP session related message as specified in 3GPP TS 29.244 [29], using the vnd.3gpp.pfcp content-type. + +#### 6.1.6.4.6 Mobile Originated Data + +Mobile Originated Data shall encode the Data Contents of the CIoT small data container or Payload Container specified in 3GPP TS 24.501 [7], using the vnd.3gpp.5gnas content-type, as summarized in Table 6.1.6.4.6-1. + +**Table 6.1.6.4.6-1: Mobile Originated Data** + +| Mobile Originated Data | Reference
(3GPP TS 24.501 [7])
| Related NAS SM message | +|------------------------------------------------------------------------------------|-------------------------------------------|---------------------------------------------------| +| Data contents in octet 4 to octet up to 257 of CIoT small data container contents. | 9.11.3.18B
(Figure 9.11.3.18B.2) | Control Plane Service Request | +| Payload container contents in octets 4 to n | 9.11.3.39
(Figure 9.11.3.39.1) | Control Plane Service Request
UL NAS Transport | + +#### 6.1.6.4.7 Mobile Terminated Data + +Mobile Terminated Data shall encode the Data Contents of the Payload Container specified in 3GPP TS 24.501 [7], using the vnd.3gpp.5gnas content-type, as summarized in Table 6.1.6.4.7-1. + +**Table 6.1.6.4.7-1: Mobile Terminated Data** + +| Mobile Terminated Data | Reference
(3GPP TS 24.501 [7]) | Related NAS SM message | +|---------------------------------------------|-----------------------------------|------------------------| +| Payload container contents in octets 4 to n | 9.11.3.39
(Figure 9.11.3.39.1) | DL NAS Transport | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +The Cause codes mapping performed by AMF between the following HTTP responses returned by the SMF services to the AMF and the 5GMM related values is specified in clause 4.3.2 of 3GPP TS 29.524 [34]. + +In order to enable the AMF to figure out whether a request (e.g. PDU session establishment request) fails at the V-SMF/I-SMF or at the H-SMF/SMF for a HR PDU session or a PDU session with an I-SMF: + +- a V-SMF/I-SMF that returns an HTTP error response to the AMF that was originated by the H-SMF/SMF shall include the remoteError attribute set to "true" in the ProblemDetails information in the HTTP error response; +- a V-SMF/I-SMF that originates an error to the AMF may include the remoteError attribute set to "false" in the ProblemDetails information in the HTTP error response. + +For a HR PDU session or a PDU session with an I-SMF, if the V-SMF or I-SMF needs to reject the request from the AMF or the H-SMF/SMF because the H-SMF/SMF or the AMF is not reachable respectively (even after retrying alternative endpoint addresses e.g. according to the Binding Indication when available), the V-SMF or I-SMF shall send a 504 Gateway Timeout response including a problemDetails data structure with the cause attribute set to "PEER\_NOT\_RESPONDING" and with the remoteError attribute set to "false". + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The common application errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] may be used for the Nsmf\_PDUSession service. + +The following application errors listed in Table 6.1.7.3-1 are specific to the Nsmf\_PDUSession service. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N1_SM_ERROR | 403
Forbidden | This indicates that an error, other than those listed in this table, was detected when processing the N1 SM information received in the request, e.g. N1 SM protocol error, or a PDU session establishment is rejected due to Operator Determined Barring. | +| N2_SM_ERROR | 403
Forbidden | This indicates that an error, other than those listed in this table, was detected when processing the N2 SM information received in the request, e.g. N2 SM protocol error. | +| SNSSAI_DENIED | 403
Forbidden | The subscriber does not have the necessary subscription to access the SNSSAI. | +| DNN_DENIED | 403
Forbidden | The subscriber does not have the necessary subscription to access the DNN. | +| PDUTYPE_DENIED | 403
Forbidden | The subscriber does not have the necessary subscription for the requested PDU session type. | +| SSC_DENIED | 403
Forbidden | The subscriber does not have the necessary subscription for the requested SSC mode. | +| SUBSCRIPTION_DENIED | 403
Forbidden | This indicates an error, other than those listed in this table, due to lack of necessary subscription to serve the UE request. | +| DNN_NOT_SUPPORTED | 403
Forbidden | The DNN is not supported by the SMF. | +| PDUTYPE_NOT_SUPPORTED | 403
Forbidden | The requested PDU session type is not supported by the SMF for the PDN corresponding to the DNN. | +| SSC_NOT_SUPPORTED | 403
Forbidden | The requested SSC mode is not supported by the SMF for the PDN corresponding to the DNN. | +| HOME_ROUTED_ROAMING_REQUIRED | 403
Forbidden | It is used in LBO roaming, if the V-SMF is not able to process some part of the N1 SM information that requires Home Routed Roaming. | +| OUT_OF_LADN_SERVICE_AREA | 403
Forbidden | The PDU session corresponds to a LADN and the UE is outside of the LADN Service Area. | +| N2_SM_ERROR | 403
Forbidden | This indicates that an error, other than those listed in this table, was detected when processing the N2 SM information received in the request, e.g. N2 SM protocol error. | +| PRIORITIZED_SERVICES_ONLY | 403
Forbidden | The SMF was notified that the UE is reachable only for regulatory prioritized service and the PDU Session to be activated is not for a regulatory prioritized service. | +| PDU_SESSION_ANCHOR_CHANGE | 403
Forbidden | The SMF decided to change the PDU Session Anchor for the PDU Session. | +| TARGET_MME_CAPABILITY | 403
Forbidden | A request to retrieve an SM context is rejected due to the target MME not capable to support the PDU session. | +| NO_EPS_5GS_CONTINUITY | 403
Forbidden | It is used during an EPS to 5GS Idle mode mobility or handover, if the PDU session does not support seamless session continuity to 5GS. | +| UNABLE_TO_PAGE_UE | 403
Forbidden | The request is rejected due to a temporarily inability to page the UE. | +| UE_NOT_RESPONDING | 403
Forbidden | The UE did not respond to the request initiated by the network, e.g. paging. | +| REJECTED_BY_UE | 403
Forbidden | The request is rejected by the UE. | +| REJECTED_DUE_VPLMN_POLICY | 403
Forbidden | The request is rejected due to VPLMN operator policy. | +| HO_TAU_IN_PROGRESS | 403
Forbidden | The request is rejected temporarily due to a mobility procedure in progress. | +| INTEGRITY_PROTECTED_MDR_NOT_ACCEPTABL | 403
Forbidden | The integrity protected maximum data rate | + +| | | | +|--------------------------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| E | Forbidden | value provided by the UE is not acceptable for the PDU session based on local policy at the SMF. This error is applicable when the UP Security Policy for the PDU Session is determined to have Integrity Protection set to "Required".

An NF service consumer that receives this error cause may use it for maintaining KPIs. | +| EBI_EXHAUSTED | 403
Forbidden | The allocation of EPS Bearer ID failed due to exhaustion of EBI as the maximum number of EBIs has already been allocated to the UE. | +| EBI_REJECTED_LOCAL_POLICY | 403
Forbidden | The allocation of EPS Bearer ID was rejected due to local policy in the Serving PLMN. | +| EBI_REJECTED_NO_N26 | 403
Forbidden | The allocation of EPS Bearer ID was rejected when the AMF is in a serving PLMN that does not support 5GS-EPS interworking procedures with N26 interface. | +| DEFAULT_EPS_BEARER_INACTIVE | 403
Forbidden | It is used during EPS to 5GS mobility if the default EPS bearer context of the PDU session is reported as inactive by the UE in the epsBearerCtxStatus attribute. | +| HANDOVER_RESOURCE_ALLOCATION_FAILURE | 403
Forbidden | It is used during a N2 handover preparation or an EPS to 5GS handover preparation, if no resource is allocated by the target NG-RAN for the PDU session. | +| LATE_OVERLAPPING_REQUEST | 403
Forbidden | The request is rejected because it collides with an existing SM context or PDU session context with a more recent origination timestamp (see clause 5.2.3.3). | +| DEFAULT_EBI_NOT_TRANSFERRED | 403
Forbidden | It is used during 5GS to EPS mobility if the EBI of the default EPS bearer is included in the notToTransferEbiList attribute. | +| NOT_SUPPORTED_WITH_ISMF | 403
Forbidden | The request is rejected due to a requested functionality that is not supported for a PDU session with an I-SMF/V-SMF. | +| SERVICE_NOT_AUTHORIZED_BY_NEXT_HOP | 403
Forbidden | The SMF is not authorized to access service provided by next hop NF producer, e.g. H-SMF or SMF or old I-SMF or old V-SMF. | +| NO_DATA_FORWARDING | 403
Forbidden | The request to setup data forwarding tunnels is rejected because none of the EPS bearer contexts received in the request body contains an F-TEID for DL data forwarding. | +| S_NSSAI_UNAVAILABLE_DUE_TO_NSAC | 403
Forbidden | The NSACF has returned error for the requested S-NSSAI and hence the PDU Session cannot be transferred from non-3gpp to 3gpp. | +| EXCEEDED_UE_SLICE_DATA_RATE | 403
Forbidden | The request is rejected due to the maximum bit rate per S-NSSAI per UE is exceeded, when the SMF receives the same application error from the PCF. | +| EXCEEDED_SLICE_DATA_RATE | 403
Forbidden | The request is rejected due to the maximum bit rate per S-NSSAI is exceeded, when the SMF receives the same application error from the PCF. | +| CONTEXT_NOT_FOUND | 404 Not
Found | It is used when no context corresponding to the request exists in the SMF. | +| HIGHER_PRIORITY_REQUEST_ONGOING | 409
Conflict | The request is rejected temporarily due to procedure for higher priority session in progress. | +| UE_IN_CM_IDLE_STATE | 409
Conflict | The request is rejected due to the UE being in CM-IDLE state for the PDU session associated to non-3GPP access. | +| INSUFFICIENT_RESOURCES_SLICE | 500
Internal
Server
Error | The request cannot be provided due to insufficient resources for the specific slice. | +| INSUFFICIENT_RESOURCES_SLICE_DNN | 500 | The request cannot be provided due to | + +| | | | +|---------------------|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Internal Server Error | insufficient resources for the specific slice and DNN. | +| DNN_CONGESTION | 503 Service Unavailability | The SMF has detected congestion for the requested DNN and performs overload control for that DNN which does not allow the PDU session to be established. | +| S_NSSAI_CONGESTION | 503 Service Unavailability | During PDU session establishment, the SMF has detected congestion for the requested S-NSSAI (including the congestion due to NSAC failure) and performs overload control for that S-NSSAI which does not allow the PDU session to be established.
During handover between 3GPP access and non-3GPP access, the SMF has detected congestion for the requested S-NSSAI on the target access (e.g., due to NSAC) and performs overload control for that S-NSSAI on the target access which does not allow the PDU session to be handover to the target access. | +| PEER_NOT_RESPONDING | 504 Gateway Timeout | No response is received from a remote peer, or the remote peer is known to be not reachable, e.g. to indicate that no response has been received from the H-SMF for a HR PDU session or the SMF for a PDU session with I-SMF. | +| NETWORK_FAILURE | 504 Gateway Timeout | The request is rejected due to a network problem. | +| UPF_NOT_RESPONDING | 504 Gateway Timeout | The request is rejected due to no response received from the UPF. | +| UE_NOT_REACHABLE | 504 Gateway Timeout | The UE is not reachable for service. | + +### 6.1.8 Feature Negotiation + +The feature negotiation mechanism specified in clause 6.6 of 3GPP TS 29.500 [4] shall be used to negotiate the optional features applicable between the SMF and the NF Service Consumer, for the Nsmf\_PDUSession service, if any. + +The NF Service Consumer shall indicate the optional features it supports for the Nsmf\_PDUSession service, if any, by including the supportedFeatures attribute in the HTTP POST request when requesting the SMF to create an SM context or a PDU session resource. In scenarios with a change of NF Service Consumer (e.g. change of AMF, V-SMF or I-SMF change), the new NF Service Consumer shall indicate the optional features it supports for the Nsmf\_PDUSession service, if any, by including the supportedFeatures attribute in the HTTP POST request when requesting the SMF to update an SM context or a PDU session resource to change the NF Service Consumer. + +The SMF shall determine the supported features for the created SM context or PDU session resource, or for the updated SM context or PDU session resource in scenarios with a change of NF Service Consumer, as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in the representation of the SM context or PDU session resource it returns in the HTTP response confirming the creation or the modification of the resource. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [13]. + +The following features are defined for the Nsmf\_PDUSession service. + +**Table 6.1.8-1: Features of supportedFeatures attribute used by Nsmf\_PDUSession service** + +| Feature Number | Feature | M/O | Description | +|----------------|---------|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | CIOT | O |

Cellular IoT

Support of this feature implies the support of all the CIoT features specified in clause 5.31 of 3GPP TS 23.501 [2], including in particular corresponding SMF PDU Session service's extensions to support:

  • - NB-IoT and LTE-M RAT types;
  • - Control Plane CIoT 5GS Optimisation;
  • - Rate control of user data;
  • - Idle mode mobility with data forwarding between EPS and 5GS using N26 interface.

The SMF shall indicate its support of this feature in supportedFeatures attribute in its profile registered in NRF.

A NF service consumer (e.g. AMF) shall only select SMF(s) that supports this feature for PDU sessions with Control Plane CIoT 5GS Optimisation enabled.

| +| 2 | MAPDU | O |

Multi-Access PDU Session

An SMF that supports this feature shall support the procedures specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3] related to Access Traffic Steering, Switching and Splitting.

| +| 3 | DTSSA | O |

Deployments Topologies with specific SMF Service Areas

A NF Service Consumer and an SMF that support this feature shall support the procedures specified in clause 5.34 of 3GPP TS 23.501 [2] and in clause 4.23 of 3GPP TS 23.502 [3].

| +| 4 | CARPT | O |

SMF derived CN Assisted RAN parameters Tuning.

A NF Service Consumer (e.g. AMF) and an SMF that support this feature shall support exchanging SMF derived CN assisted RAN parameters in Notify SM Context Status service operation (see clause 5.2.2.5.1).

| +| 5 | CTXTR | O |

This feature bit indicates whether the NF Service Consumer (e.g. AMF) and SMF supports Network Function/NF Service Context Transfer Procedures specified in clause 4.26 of 3GPP TS 23.502 [3].

The SMF shall only trigger these context transfer procedures if the NF Service Consumer has indicated support of this feature.

| +| 6 | VQOS | O |

VPLMN QoS

An SMF that supports this feature shall support:

  • - the handling of QoS constraints from the VPLMN during a HR PDU session establishment as specified in clause 4.3.2.2.2 of 3GPP TS 23.502 [3]; and
  • - QoS modification requests initiated by the VPLMN, as specified in clause 4.3.3.3 of 3GPP TS 23.502 [3].
| +| 7 | HOFAIL | M |

This feature bit indicates whether the NF Service Consumer (e.g. AMF, V-SMF, I-SMF) and SMF supports the Notify (SM Context) Status procedure to indicate a handover failure with the Resource Status set to "UPDATED" between 3GPP access and non-3GPP access as specified in clauses 5.2.2.5.1 and 5.2.2.10.1.

The SMF shall only trigger such a resource status notify procedure if the NF Service Consumer has indicated support of this feature.

| +| 8 | ES3XX | M |

Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF, V-SMF, I-SMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the PDUSession service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15.

| + +| | | | | +|----|--------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 9 | DCE2ER | O |

Dual Connectivity based end to end Redundant User Plane Paths

An NF service consumer (e.g. I-SMF) and SMF that supports this feature shall support the procedures specified in clause 5.33.2.1 of 3GPP TS 23.501 [2].

| +| 10 | AASN | M |

This feature bit indicates whether the NF Service Consumer (e.g. AMF) and the SMF support the Notify SM Context Status procedure to indicate that the PDU session is established towards an alternative anchor SMF, as specified in clause 5.2.2.5.1.

The SMF shall only trigger such a Notify SM Context Status procedure if the NF Service Consumer has indicated support of this feature.

| +| 11 | EnEDGE | O |

Enhancement of Edge Computing in 5G Core network

A NF Service Consumer and an SMF that support this feature shall support to signal the target DNAI in Notify (SM Context) Status and Create SM Context service operations, support to signal the URI of the SM Context resource in Notify SM Context Status, Create SM Context and create service operations / signal the URI of the PDU Session resource in Notify (SM Context) Status, Create SM Context and create service operations to retrieve the AF Coordination Information, as specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.548 [39].

| +| 12 | SCPBU | O |

Simultaneous Change of PSA and BP or UL CL

This feature bit indicates whether the NF Service Consumer (e.g. I-SMF) and the SMF support the n4InfoExt3 IE included in VsmfUpdateData, VsmfUpdatedData or VsmfUpdateError to support the simultaneous change of PSA and BP or UL CL controlled by I-SMF.

The SMF shall only include the n4InfoExt3 IE in VsmfUpdateData if the NF Service Consumer has indicated support of this feature.

| +| 13 | ENPN | O |

Enhanced support of Non-Public Networks

Support of this feature implies the support of the Remote Provisioning of UEs in Onboarding Network procedures, as specified in clause 5.30.2.10.4 of 3GPP TS 23.501 [2] and clause 4.3.2.2.1 of 3GPP TS 23.502 [3].

The SMF shall indicate its support of this feature in supportedFeatures attribute in its profile registered in NRF.

A NF service consumer (e.g. AMF) shall select SMF(s) that supports this feature to setup PDU sessions for Remote Provisioning of UEs in Onboarding Network.

| +| 14 | SPAE | O |

SM Policy Association Events

This feature bit indicates whether the NF Service Consumer (e.g. AMF) and the SMF supports the SM Policy Association establishment and termination event notification information handling, i.e. whereby the PCF for UE subscribes to SM Policy Association events to the PCF for SM Policy via the AMF and SMF, as specified in clause 4.3.2.2.1 and clause 4.3.3.2 of 3GPP TS 23.502 [3].

| +| 15 | 5GSAT | O |

This feature bit indicates whether the NF Service Consumer (e.g. AMF, V-SMF, I-SMF) and SMF support the reporting of satellite backhaul information, as specified in clause 5.43.4 of 3GPP TS 23.501 [2].

| +| 16 | UPIPE | O |

User Plane Integrity Protection with EPS

An NF service consumer (e.g. AMF) and SMF that supports this feature shall support the User Plane Integrity Protection with EPS specified in clauses 4.11.1 and 4.11.5.3 of 3GPP TS 23.502 [3].

| +| 17 | BIUMR | O |

This feature bit indicates whether the NF Service Consumer (e.g. AMF, V-SMF, I-SMF) and SMF supports Binding Indication Update for multiple resource contexts specified in clauses 6.12.1 and 5.2.3.2.6 of 3GPP TS 29.500 [4].

| + +| | | | | +|----|------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 18 | ACSCR | O |

Absence of smfUri and hSmfUri attributes in Create SM Context Request for procedures with I-SMF/V-SMF insertion/change other than PDU session establishment and EPS to 5GS mobility procedures.

This feature bit indicates that the NF Service Consumer (e.g. AMF) supports not including, and the I-SMF/V-SMF supports not receiving, the smfUri and hSmfUri attributes in the Create SM Context request in procedures with I-SMF/V-SMF insertion/change other than PDU session establishment and EPS to 5GS mobility procedures.

An NF Service Consumer and I-SMF/V-SMF complying with this release of the specification shall support this feature if the DTSSA feature is supported.

The support of this feature may remove the need for the AMF to fetch the smfUri or hsmfUri from the NRF where the anchor SMF profile is registered, e.g. enable the AMF to skip an inter-PLMN NF Discovery procedure towards the HPLMN during a V-SMF insertion/change when the AMF can determine by other means (e.g. using the anchorSmfSupportedFeatures attribute in PDU session context received over N14) whether the HPLMN supports the DTSSA feature, and accordingly, to fasten the execution of mobility (e.g. handover) scenarios.

| +| 19 | PSETR | O |

This feature bit indicates that the SMF is able to (re)select an alternative peer SMF (when available) when it detects the peer SMF has failed. See also clause 6.8 in 3GPP TS 23.527 [24]. An SMF implementation (complying with this release of the specification) should support the PSETR feature (i.e. support reselecting a peer SMF service instance when the peer SMF fails)

| +| 20 | DLSET | O |

This feature bit indicates that the PDU session resources served by the SMF are not exclusively bound to a SMF service instance, i.e. they are shared by multiple SMF service instances. See also clause 6.8 in 3GPP TS 23.527 [24].

| +| 21 | N9FSC | O |

N9 Forwarding between Branching Points or UL CLs controlled by the same or different I-SMFs for EAS Session Continuity.

An NF Service Consumer and I-SMF/SMF that support this feature shall support the procedures specified in clauses 4.23.9.4 and 4.23.9.5 of 3GPP TS 23.502 [3] related to the N9 forwarding tunnel establishment between Branching Points or UL CLs controlled by the same or different I-SMFs to support EAS session continuity.

| +| 22 | DTSSA-Ext1 | O |

This feature bit indicates that the full list of DNAsI of interest for PDU session, including DNAsI that may not be supported by the I-SMF and excluding the ones supported by the anchor SMF, can be provisioned by the anchor SMF or handled by the I-SMF, which enables the (target) I-SMF to receive such information earlier during an I-SMF insertion or change procedures, so that the I-SMF can decide to insert UL CL/BP and/or a local PSA earlier to save some signalling transactions.

| +| 23 | 5GSATB | O |

This feature bit indicates whether the NF Service Consumer (e.g. AMF) is aware that the UE is accessing over a gNB using GEO satellite backhaul and GEO Satellite ID needs to be updated at the SMF (see clause 5.43.2 of 3GPP TS 23.501 [2]).

| +| 24 | HR-SBO | O |

Home Routed Session BreakOut

An NF service consumer (e.g. AMF and V-SMF) and SMF that supports this feature shall support local traffic routing in VPLMN for HR-SBO specified in clause 6.7 of 3GPP TS 23.548 [39].

| +| 25 | N3GPS | O |

Non-3GPP Access Path Switching

An SMF or NF service consumer that supports this feature shall support the procedures specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3] related to non-3GPP access path switching while maintaining two N2 connections for non-3GPP access.

| +| 26 | NSRP | O |

Network Slice Replacement

An NF service consumer (e.g., AMF, V-SMF or I-SMF) and SMF that supports this feature shall support network slice replacement as specified in clause 5.15.19 of 3GPP TS 23.501 [2].

| + +| | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 27 | UPCSMT | O |

User Plane Connection Suspend State and MT handling

This feature bit indicates whether the SMF supports the user plane connection suspend state for a UE entering RRC_Suspend or RRC_Inactive with long eDRX mode and to invoke Namf_MT EnableUEReachability service operation upon receiving subsequent DL Data Notification from the UPF.

| +| 28 | PSER | O |

PDU Session Establishment Rejection

A SMF which support this feature shall allow the NF service consumer (i.e. the AMF) to indicate in the Create SM Context request that the PDU session establishment shall be rejected and shall reject the PDU session establishment according to the specific rejection cause received from the NF Service Consumer.

| +| 29 | SCID | M |

String based Charging Identifier

A H-SMF shall indicate support of this feature when the SMF, the PCF and the CHF in the HPLMN all support handing of String based Charging Identifier, as specified in 3GPP TS 32.255 [25].

A V-SMF shall indicate support of this feature when the SMF and the CHF in the VPLMN both support handing of String based Charging Identifier, as specified in 3GPP TS 32.255 [25].

| +|

Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1).
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.

| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [17] and 3GPP TS 29.500 [4], the access to the Nsmf\_PDUSession API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nsmf\_PDUSession API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE 1: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nsmf\_PDUSession service. + +NOTE 2: The security credentials for accessing a child resource URI of an sm-contexts or pdu-sessions collection distributed on different processing instances or hosts are the same as for accessing the collection URI. + +The Nsmf\_PDUSession API defines a single scope "nsmf-pdusession" for the entire service, and it does not define any additional scopes at resource and operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different SMF service instance, within the same SMF or a different SMF of an SMF set, e.g. when an SMF service instance is part of an SMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.1.8. + +An SCP that reselects a different SMF producer instance will return the NF Instance ID of the new SMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an SMF within an SMF set redirects a service request to a different SMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new SMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +For a HR PDU session or a PDU session with an I-SMF, the V-SMF or I-SMF shall update the AMF upon detecting a change of the H-SMF or SMF within the SMF set, by sending an SM context status notification with the resourceStatus set to "UPDATED", the cause in statusInfo set to "CHANGED\_ANCHOR\_SMF" and with the new H-SMF or SMF identity (see clause 5.2.2.5.1). + +NOTE: This allows the AMF to receive the NF Instance ID of the new SMF handling the PDU session and to send the NF Instance ID of the last known SMF handling the PDU session during inter-AMF mobility. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nsmf\_PDUSession service. It consists of OpenAPI 3.0.0 specifications, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nsmf\_PDUSession API + +``` +openapi: 3.0.0 + +info: + version: '1.3.0-alpha.6' + title: 'Nsmf_PDUSession' + description: | + SMF PDU Session Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.502 V18.5.0; 5G System; Session Management Services; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.502/ + +servers: + - url: '{apiRoot}/nsmf-pdusession/v1' + variables: + apiRoot: + default: https://example.com + description: > + apiRoot as defined in clause 4.4 of 3GPP TS 29.501. The sm-contexts and pdu-sessions + resources can be distributed on different processing instances or hosts. Thus the + authority and/or deployment-specific string of the apiRoot of the created individual + sm context and pdu-session resources' URIs may differ from the authority and/or + deployment-specific string of the apiRoot of the sm-contexts and pdu-sessions + collections' URIs. + +security: + - {} + - oAuth2ClientCredentials: + - nsmf-pdusession + +paths: + /sm-contexts: + post: + summary: Create SM Context + tags: + - SM contexts collection + operationId: PostSmContexts + requestBody: + description: representation of the SM context to be created in the SMF + required: true + content: + multipart/related: # message with binary body part(s) + schema: + type: object +``` + +``` + +properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateData' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + binaryDataN2SmInformationExt1: + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +callbacks: + smContextStatusNotification: + '{ $request.body#/smContextStatusUri }': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SmContextStatusNotification' +responses: + '204': + description: successful notification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +responses: + '201': + description: successful creation of an SM context + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreatedData' + +``` + +``` +multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreatedData' + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nsmf-pdusession//sm-contexts/{smContextRef} + required: true + schema: + type: string + +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + description: unsuccessful creation of an SM context - bad request + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmMessage: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + +'401': + $ref: '#/components/responses/401' +'403': + description: unsuccessful creation of an SM context - forbidden + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +``` + +``` + +multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmMessage: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'404': + description: unsuccessful creation of an SM context - not found + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreateError' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmMessage: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: '#/components/responses/413' +'415': + $ref: '#/components/responses/415' +'429': + $ref: '#/components/responses/429' +'500': + description: unsuccessful creation of an SM context - internal server error + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + +``` + +``` + +schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmMessage: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'502': + $ref: '#/components/responses/502' +'503': + description: unsuccessful creation of an SM context - service unavailable + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextCreateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmMessage: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'504': + description: unsuccessful creation of an SM context - gateway timeout + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextCreateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + +``` + +``` + + $ref: '#/components/schemas/SmContextCreateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmMessage: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/sm-contexts/{smContextRef}/retrieve: + post: + summary: Retrieve SM Context + tags: + - Individual SM context + operationId: RetrieveSmContext + parameters: + - name: smContextRef + in: path + description: SM context reference + required: true + schema: + type: string + requestBody: + description: parameters used to retrieve the SM context + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/SmContextRetrieveData' + responses: + '200': + description: successful retrieval of an SM context + content: + application/json: + schema: + $ref: '#/components/schemas/SmContextRetrievedData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/sm-contexts/{smContextRef}/modify: + post: + summary: Update SM Context + tags: + - Individual SM context + operationId: UpdateSmContext + parameters: + - name: smContextRef + in: path + description: SM context reference + required: true + schema: + type: string + requestBody: + description: representation of the updates to apply to the SM context + required: true + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateData' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + binaryDataN2SmInformationExt1: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformationExt1: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + responses: + '200': + description: successful update of an SM context with content in the response + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdatedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdatedData' + binaryDataN1SmMessage: + type: string + format: binary + +``` + +``` + binaryDataN2SmInformation: + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'204': + description: successful update of an SM context without content in the response +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + description: unsuccessful update of an SM context - bad request + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'401': + $ref: '#/components/responses/401' +'403': + description: unsuccessful update of an SM context - forbidden + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateError' + binaryDataN1SmMessage: +``` + +``` + + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'404': + description: unsuccessful update of an SM context - not found + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateError' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: '#/components/responses/413' +'415': + $ref: '#/components/responses/415' +'429': + $ref: '#/components/responses/429' +'500': + description: unsuccessful update of an SM context - Internal server error + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateError' + binaryDataN1SmMessage: + type: string + +``` + +``` + + format: binary + binaryDataN2SmInformation: + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +'502': + $ref: '#/components/responses/502' +'503': + description: unsuccessful update of an SM context - Service Unavailable + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextUpdateError' + binaryDataN1SmMessage: + type: string + format: binary + binaryDataN2SmInformation: + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN1SmMessage: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/sm-contexts/{smContextRef}/release: + post: + summary: Release SM Context + tags: + - Individual SM context + operationId: ReleaseSmContext + parameters: + - name: smContextRef + in: path + description: SM context reference + required: true + schema: + type: string + requestBody: + description: representation of the data to be sent to the SMF when releasing the SM context + required: false + content: + application/json: # message without binary body part + +``` + +``` + + schema: + $ref: '#/components/schemas/SmContextReleaseData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/SmContextReleaseData' + binaryDataN2SmInformation: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2SmInformation: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + +responses: + '200': + description: successful release of a PDU session with content in the response + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/SmContextReleasedData' + '204': + description: successful release of an SM context without content in the response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/sm-contexts/{smContextRef}/send-mo-data: + post: + summary: Send MO Data + tags: + - Individual SM context + operationId: SendMoData + parameters: + - name: smContextRef + in: path + description: SM context reference + required: true + schema: + type: string + requestBody: + description: representation of the content of Send MO Data Request + required: true + content: + multipart/related: # message with a binary body part + schema: + +``` + +``` + + type: object + properties: + jsonData: + $ref: '#/components/schemas/SendMoDataReqData' + binaryMoData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryMoData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: successful sending of MO data + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: '#/components/responses/413' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + '502': + $ref: '#/components/responses/502' + '503': + $ref: '#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pdu-sessions: + post: + summary: Create + tags: + - PDU sessions collection + operationId: PostPduSessions + requestBody: + description: representation of the PDU session to be created in the H-SMF or SMF + required: true + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/PduSessionCreateData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/PduSessionCreateData' + binaryDataN1SmInfoFromUe: + type: string + format: binary + binaryDataUnknownN1SmInfo: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoFromUe: + contentType: application/vnd.3gpp.5gnas + +``` + +``` + +headers: + Content-Id: + schema: + type: string +binaryDataUnknownN1SmInfo: + contentType: application/vnd.3gpp.5gnas +headers: + Content-Id: + schema: + type: string +callbacks: + statusNotification: + "{$request.body#/vsmfPduSessionUri}": + post: + summary: Notify Status + tags: + - Individual PDU session (V-SMF) + operationId: NotifyStatus + requestBody: + $ref: '#/components/requestBodies/NotifyStatusRequestBody' + responses: + '204': + description: successful notification of the status change + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + statusNotification-ismf: + "{$request.body#/ismfPduSessionUri}": + post: + summary: Notify Status + tags: + - Individual PDU session (I-SMF) + operationId: NotifyStatus-ismf + requestBody: + $ref: '#/components/requestBodies/NotifyStatusRequestBody' + responses: + '204': + description: successful notification of the status change + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +update: + '{$request.body#/vsmfPduSessionUri}/modify': + post: + summary: Update (initiated by H-SMF) + tags: + - Individual PDU session (V-SMF) + operationId: ModifyPduSession + requestBody: + $ref: '#/components/requestBodies/VsmfUpdateRequestBody' + responses: + '200': + $ref: '#/components/responses/VsmfUpdateResponse200' + '204': + description: successful update of a PDU session without content in the response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: '#/components/responses/VsmfUpdateError' + '403': + $ref: '#/components/responses/VsmfUpdateError' + '404': + $ref: '#/components/responses/VsmfUpdateError' + '409': + $ref: '#/components/responses/VsmfUpdateError' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: '#/components/responses/VsmfUpdateError' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: '#/components/responses/VsmfUpdateError' + '504': + $ref: '#/components/responses/VsmfUpdateError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +update-ismf: + '{$request.body#/ismfPduSessionUri}/modify': + post: + summary: Update (initiated by SMF) + tags: + - Individual PDU session (I-SMF) + operationId: ModifyPduSession-ismf + requestBody: + $ref: '#/components/requestBodies/VsmfUpdateRequestBody' + responses: + '200': + $ref: '#/components/responses/VsmfUpdateResponse200' + '204': + description: successful update of a PDU session without content in the response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: '#/components/responses/VsmfUpdateError' + '403': + $ref: '#/components/responses/VsmfUpdateError' +``` + +``` + + '404': + $ref: '#/components/responses/VsmfUpdateError' + '409': + $ref: '#/components/responses/VsmfUpdateError' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: '#/components/responses/VsmfUpdateError' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: '#/components/responses/VsmfUpdateError' + '504': + $ref: '#/components/responses/VsmfUpdateError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +transferMtData: + '{$request.body#/vsmfPduSessionUri}/transfer-mt-data': + post: + summary: Transfer MT Data (by H-SMF) + tags: + - Individual PDU session (V-SMF) + operationId: TransferMtData + requestBody: + description: representation of the content of Transfer MT Data Request + required: true + content: + multipart/related: # message with a binary body part + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/TransferMtDataReqData' + binaryMtData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryMtData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: successful transfering of MT data + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + description: unsuccessful delivery of mobile terminated data - gateway timeout + content: + application/json: + schema: + $ref: '#/components/schemas/TransferMtDataError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +transferMtData-ismf: + '{$request.body#/ismfPduSessionUri}/transfer-mt-data': + post: + summary: Transfer MT Data (by SMF) + tags: + - Individual PDU session (I-SMF) + operationId: TransferMtData-ismf + requestBody: + description: representation of the content of Transfer MT Data Request + required: true + content: + multipart/related: # message with a binary body part + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/TransferMtDataReqData' + binaryMtData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryMtData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: successful transfering of MT data + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + description: unsuccessful delivery of mobile terminated data - gateway timeout + content: + application/json: + schema: + $ref: '#/components/schemas/TransferMtDataError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +``` + +``` + +responses: + '201': + description: successful creation of a PDU session + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/PduSessionCreatedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/PduSessionCreatedData' + binaryDataN1SmInfoToUe: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoToUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nsmf-pdusession//pdu-sessions/{pduSessionRef} + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: '#/components/responses/PduSessionCreateError' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: '#/components/responses/PduSessionCreateError' + '404': + $ref: '#/components/responses/PduSessionCreateError' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: '#/components/responses/PduSessionCreateError' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: '#/components/responses/PduSessionCreateError' + '504': + $ref: '#/components/responses/PduSessionCreateError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pdu-sessions/{pduSessionRef}/modify: + post: + summary: Update (initiated by V-SMF or I-SMF) + tags: + - Individual PDU session (H-SMF or SMF) + operationId: UpdatePduSession + parameters: + - name: pduSessionRef + in: path + description: PDU session reference + required: true + schema: + type: string + +``` + +``` + +requestBody: + description: representation of the updates to apply to the PDU session + required: true + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/HsmfUpdateData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/HsmfUpdateData' + binaryDataN1SmInfoFromUe: + type: string + format: binary + binaryDataUnknownN1SmInfo: + type: string + format: binary + binaryDataN4Information: + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoFromUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataUnknownN1SmInfo: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + +responses: + '200': + description: successful update of a PDU session with content in the response + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/HsmfUpdatedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/HsmfUpdatedData' + binaryDataN1SmInfoToUe: + type: string + format: binary + binaryDataN4Information: + +``` + +``` + + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoToUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string +'204': + description: successful update of a PDU session without content in the response +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: '#/components/responses/HsmfUpdateError' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: '#/components/responses/HsmfUpdateError' +'404': + $ref: '#/components/responses/HsmfUpdateError' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: '#/components/responses/HsmfUpdateError' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: '#/components/responses/HsmfUpdateError' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pdu-sessions/{pduSessionRef}/release: + post: + summary: Release + tags: + - Individual PDU session (H-SMF or SMF) + operationId: ReleasePduSession + parameters: + - name: pduSessionRef + in: path + description: PDU session reference + required: true + schema: + +``` + +``` + type: string + requestBody: + description: data sent to H-SMF or SMF when releasing the PDU session + required: false + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/ReleaseData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/ReleaseData' + binaryDataN4Information: + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + + responses: + '200': + description: successful release of a PDU session with content in the response + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/ReleasedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/ReleasedData' + binaryDataN4Information: + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp +``` + +``` + + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + '204': + description: successful release of a PDU session + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pdu-sessions/{pduSessionRef}/retrieve: + post: + summary: Retrieve + tags: + - Individual PDU session (H-SMF or SMF) + operationId: RetrievePduSession + parameters: + - name: pduSessionRef + in: path + description: PDU session reference + required: true + schema: + type: string + requestBody: + description: representation of the content of the Retrieve Request + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RetrieveData' + responses: + '200': + description: successful information retrieval + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/RetrievedData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + +``` + +``` + + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pdu-sessions/{pduSessionRef}/transfer-mo-data: + post: + summary: Transfer MO Data + tags: + - Individual PDU session (H-SMF or SMF) + operationId: TransferMoData + parameters: + - name: pduSessionRef + in: path + description: PDU session reference + required: true + schema: + type: string + requestBody: + description: representation of the content of Transfer MO Data Request + required: true + content: + multipart/related: # message with a binary body part + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/TransferMoDataReqData' + binaryMoData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryMoData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: successful transfering of MO data + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nsmf-pdusession: Access to the nsmf-pdusession API + +schemas: +# +# STRUCTURED DATA TYPES +# + +SmContextCreateData: + description: Data within Create SM Context Request + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + unauthenticatedSupi: + type: boolean + default: false + roamingUeInd: + type: boolean + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + selectedDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + altSNSSAI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + hplmnSNNSSAI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + altHplmnSNNSSAI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + servingNFId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + serviceName: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + requestType: + $ref: '#/components/schemas/RequestType' + nlSmMsg: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + additionalAnType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + presenceInLadn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' + perLadnDnnSNNSSAIInd: + type: boolean + default: false + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' +``` + +``` +ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' +addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' +smContextStatusUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +hSmfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +hSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +smfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +smfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +additionalHsmfUri: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 +additionalHsmfId: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 +additionalSmfUri: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 +additionalSmfId: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 +oldPduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' +pduSessionsActivateList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 +ueEpsPdnConnection: + $ref: '#/components/schemas/EpsPdnCnxContainer' +hoState: + $ref: '#/components/schemas/HoState' +pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' +pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +nrfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +selMode: + $ref: '#/components/schemas/DnnSelectionMode' +backupAmfInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' + minItems: 1 +traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' +udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' +routingIndicator: + type: string +hNwPubKeyId: + type: integer +epsInterworkingInd: + $ref: '#/components/schemas/EpsInterworkingIndication' +indirectForwardingFlag: + type: boolean +directForwardingFlag: + type: boolean +targetId: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/NgRanTargetId' +``` + +``` +epsBearerCtxStatus: + $ref: '#/components/schemas/EpsBearerContextStatus' +cpCiotEnabled: + type: boolean + default: false +cpOnlyInd: + type: boolean + default: false +invokeNef: + type: boolean + default: false +maRequestInd: + type: boolean + default: false +maNwUpgradeInd: + type: boolean + default: false +n3gPathSwitchSupportInd: + type: boolean + default: false +n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' +n2SmInfoExt1: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +n2SmInfoTypeExt1: + $ref: '#/components/schemas/N2SmInfoType' +smContextRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +smContextSmfPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' +smContextSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +smContextSmfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +smContextSmfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +smContextSmfBinding: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/SbiBindingLevel' +upCnxState: + $ref: '#/components/schemas/UpCnxState' +smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' +apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' +extendedNasSmTimerInd: + type: boolean + default: false +dlDataWaitingInd: + type: boolean + default: false +ddnFailureSubs: + $ref: '#/components/schemas/DdnFailureSubs' +smfTransferInd: + type: boolean + default: false +oldSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +oldSmContextRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +wAgfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/WAgfInfo' +tngfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TngfInfo' +twifInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TwifInfo' +ranUnchangedInd: + type: boolean +samePcfSelectionInd: + type: boolean + default: false +targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' +nrfManagementUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +nrfDiscoveryUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +``` + +``` + +nrfAccessTokenUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +nrfOAuth2Required: + type: object + description: 'Map indicating whether the NRF requires OAuth2-based authorization for + accessing its services. The key of the map shall be the name of an NRF service, e.g. + "nnrf-nfm" or "nnrf-disc"' + additionalProperties: + type: boolean + minProperties: 1 +smfBindingInfo: + type: string +pvsInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServerAddressingInfo' + minItems: 1 +onboardingInd: + type: boolean + default: false +oldPduSessionRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +smPolicyNotifyInd: + type: boolean + default: false +pcfUeCallbackInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' +satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' +upipSupported: + type: boolean + default: false +disasterRoamingInd: + type: boolean + default: false +anchorSmfOAuth2Required: + type: boolean +smContextSmfOAuth2Required: + type: boolean +geoSatelliteId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GeoSatelliteId' +hrsboAllowedInd: + type: boolean + default: false +estabRejectionInd: + type: boolean + enum: + - true +estabRejectionCause: + $ref: '#/components/schemas/EstablishmentRejectionCause' +required: + - servingNfId + - servingNetwork + - anType + - smContextStatusUri + +SmContextCreatedData: + description: Data within Create SM Context Response + type: object + properties: + hSmfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + additionalSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + upCnxState: + $ref: '#/components/schemas/UpCnxState' + n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' + allocatedEbiList: + type: array + +``` + +``` + + items: + $ref: '#/components/schemas/EbiArpMapping' + minItems: 1 + hoState: + $ref: '#/components/schemas/HoState' + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + smfServiceInstanceId: + type: string + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + selectedSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + selectedOldSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + +SmContextUpdateData: + description: Data within Update SM Context Request + type: object + properties: + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + servingNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + backupAmfInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' + minItems: 1 + nullable: true + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + additionalAnType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + anTypeToReactivate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + presenceInLadn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + upCnxState: + $ref: '#/components/schemas/UpCnxState' + hoState: + $ref: '#/components/schemas/HoState' + toBeSwitched: + type: boolean + default: false + failedToBeSwitched: + type: boolean + n1SmMsg: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' + targetId: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/NgRanTargetId' + targetServingNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + smContextStatusUri: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +dataForwarding: + type: boolean + default: false +n9ForwardingTunnel: + $ref: '#/components/schemas/TunnelInfo' +n9DlForwardingTnllist: + type: array + items: + $ref: '#/components/schemas/IndirectDataForwardingTunnelInfo' + minItems: 1 +n9UlForwardingTnllist: + type: array + items: + $ref: '#/components/schemas/IndirectDataForwardingTunnelInfo' + minItems: 1 +n9DlForwardingTunnel: + $ref: '#/components/schemas/TunnelInfo' +n9InactivityTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +epsBearerSetup: + type: array + items: + $ref: '#/components/schemas/EpsBearerContainer' + minItems: 0 +revokeEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 +release: + type: boolean + default: false +cause: + $ref: '#/components/schemas/Cause' +ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' +5gMmCauseValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' +sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' +epsInterworkingInd: + $ref: '#/components/schemas/EpsInterworkingIndication' +anTypeCanBeChanged: + type: boolean + default: false +n2SmInfoExt1: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +n2SmInfoTypeExt1: + $ref: '#/components/schemas/N2SmInfoType' +maReleaseInd: + $ref: '#/components/schemas/MaReleaseIndication' +maNwUpgradeInd: + type: boolean + default: false +maRequestInd: + type: boolean + default: false +n3gPathSwitchExecutionInd: + type: boolean + enum: + - true +exemptionInd: + $ref: '#/components/schemas/ExemptionInd' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +moExpDataCounter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter' +extendedNasSmTimerInd: + type: boolean +forwardingFteid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' +forwardingBearerContexts: + type: array + items: + $ref: '#/components/schemas/ForwardingBearerContainer' +``` + +``` + minItems: 1 + ddnFailureSubs: + $ref: '#/components/schemas/DdnFailureSubs' + skipN2PduSessionResRelInd: + type: boolean + default: false + secondaryRatUsageDataReportContainer: + type: array + items: + $ref: '#/components/schemas/SecondaryRatUsageDataReportContainer' + minItems: 1 + smPolicyNotifyInd: + type: boolean + enum: + - true + pcfUeCallbackInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' + satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + cnBasedMt: + type: boolean + enum: + - true + geoSatelliteId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GeoSatelliteId' + altSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altHplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +SmContextUpdatedData: + description: Data within Update SM Context Response + type: object + properties: + upCnxState: + $ref: '#/components/schemas/UpCnxState' + hoState: + $ref: '#/components/schemas/HoState' + releaseEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + allocatedEbiList: + type: array + items: + $ref: '#/components/schemas/EbiArpMapping' + minItems: 1 + modifiedEbiList: + type: array + items: + $ref: '#/components/schemas/EbiArpMapping' + minItems: 1 + n1SmMsg: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' + epsBearerSetup: + type: array + items: + $ref: '#/components/schemas/EpsBearerContainer' + minItems: 1 + dataForwarding: + type: boolean + n3DlForwardingTnlList: + type: array + items: + $ref: '#/components/schemas/IndirectDataForwardingTunnelInfo' + minItems: 1 + n3UlForwardingTnlList: + type: array + items: + $ref: '#/components/schemas/IndirectDataForwardingTunnelInfo' + minItems: 1 + n9UlForwardingTunnel: + $ref: '#/components/schemas/TunnelInfo' +``` + +``` +cause: + $ref: '#/components/schemas/Cause' +maAcceptedInd: + type: boolean + default: false +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +forwardingFTEid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' +forwardingBearerContexts: + type: array + items: + $ref: '#/components/schemas/ForwardingBearerContainer' + minItems: 1 +selectedSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +selectedOldSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +anchorSmfFeatures: + $ref: '#/components/schemas/AnchorSmfFeatures' + +SmContextReleaseData: + description: Data within Release SM Context Request + type: object + properties: + cause: + $ref: '#/components/schemas/Cause' + ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + 5gMmCauseValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + vsmfReleaseOnly: + type: boolean + default: false + n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' + ismfReleaseOnly: + type: boolean + default: false + +SmContextReleasedData: + description: Data within Release SM Context Response + type: object + properties: + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' + +SmContextStatusNotification: + description: Data within Notify SM Context Status Request + type: object + properties: + statusInfo: + $ref: '#/components/schemas/StatusInfo' + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' + ddnFailureStatus: + type: boolean + default: false + notifyCorrelationIdsForDdnFailure: + type: array + items: + type: string + minItems: 1 + newIntermediateSmfId: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +newSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +newSmfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +oldSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +oldSmContextRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +altAnchorSmfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +altAnchorSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +targetDnaiInfo: + $ref: '#/components/schemas/TargetDnaiInfo' +oldPduSessionRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' +required: +- statusInfo + +PduSessionCreateData: + description: Data within Create Request + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + unauthenticatedSupi: + type: boolean + default: false + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + selectedDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + hplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + vsmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ismfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + requestType: + $ref: '#/components/schemas/RequestType' + epsBearerId: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + pgwS8cFteid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + vsmfPduSessionUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ismfPduSessionUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + vcnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + icnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + n9ForwardingTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + additionalCnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + additionalAnType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + +``` + +``` + +ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' +ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' +addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' +gpsI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +nlSmInfoFromUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +unknownNlSmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +hPcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' +pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +hoPreparationIndication: + type: boolean +selMode: + $ref: '#/components/schemas/DnnSelectionMode' +alwaysOnRequested: + type: boolean + default: false +udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' +routingIndicator: + type: string +hNwPubKeyId: + type: integer +epsInterworkingInd: + $ref: '#/components/schemas/EpsInterworkingIndication' +vSmfServiceInstanceId: + type: string +iSmfServiceInstanceId: + type: string +recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +roamingChargingProfile: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile' +chargingId: + type: string + pattern: '^(0|([1-9]{1}[0-9]{0,9}))$' +smfChargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmfChargingId' +oldPduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' +epsBearerCtxStatus: + $ref: '#/components/schemas/EpsBearerContextStatus' +amfNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +maxIntegrityProtectedDataRateUl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' +maxIntegrityProtectedDataRateDl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' +cpCiotEnabled: + type: boolean + default: false +cpOnlyInd: + type: boolean + default: false +invokeNef: + type: boolean + default: false +maRequestInd: + type: boolean + default: false +maNwUpgradeInd: + type: boolean + +``` + +``` + default: false + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + presenceInLadn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' + secondaryRatUsageInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo' + minItems: 1 + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' + dlServingPlmnRateCtl: + type: integer + minimum: 10 + upSecurityInfo: + $ref: '#/components/schemas/UpSecurityInfo' + vplmnQos: + $ref: '#/components/schemas/VplmnQos' + oldSmContextRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + redundantPduSessionInfo: + $ref: '#/components/schemas/RedundantPduSessionInformation' + oldPduSessionRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smPolicyNotifyInd: + type: boolean + default: false + pcfUeCallbackInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' + satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + upipSupported: + type: boolean + default: false + upCnxState: + $ref: '#/components/schemas/UpCnxState' + disasterRoamingInd: + type: boolean + default: false + hrsboInfo: + $ref: '#/components/schemas/HrsboInfoFromVplmn' + ecsAddrConfigInfos: + type: array + items: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/EcsAddrConfigInfo' + minItems: 1 + pduSetSupportInd: + type: boolean + default: false + ecnMarkingCongestionInfoStatus: + type: array + items: + $ref: '#/components/schemas/EcnMarkingCongestionInfoStatus' + minItems: 1 + required: + - dnn + - servingNetwork + - anType + oneOf: + - required: [ vsmfId, vsmfPduSessionUri ] + - required: [ ismfId, ismfPduSessionUri ] + +PduSessionCreatedData: + description: Data within Create Response + type: object + properties: + pduSessionType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + sscMode: + type: string + pattern: '^[0-7]$' + hcnTunnelInfo: +``` + +``` +$ref: '#/components/schemas/TunnelInfo' +cnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' +additionalCnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' +sessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' +qosFlowsSetupList: + type: array + items: + $ref: '#/components/schemas/QosFlowSetupItem' + minItems: 1 +hSmfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' +sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +additionalSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +enablePauseCharging: + type: boolean + default: false +ueIpv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +ueIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +n1SmInfoToUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +epsPdnCnxInfo: + $ref: '#/components/schemas/EpsPdnCnxInfo' +epsBearerInfo: + type: array + items: + $ref: '#/components/schemas/EpsBearerInfo' + minItems: 1 +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +maxIntegrityProtectedDataRate: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' +maxIntegrityProtectedDataRateDl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' +alwaysOnGranted: + type: boolean + default: false +gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +upSecurity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UpSecurity' +roamingChargingProfile: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile' +hSmfServiceInstanceId: + type: string +smfServiceInstanceId: + type: string +recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 +ipv6MultiHomingInd: + type: boolean + default: false +maAcceptedInd: + type: boolean + default: false +homeProvidedChargingId: + type: string + pattern: '^(0|([1-9]{1}[0-9]{0,9}))$' +homeProvidedSmfChargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmfChargingId' +nefExtBufSupportInd: + type: boolean + default: false +``` + +``` + +smallDataRateControlEnabled: + type: boolean + default: false +ueIpv6InterfaceId: + type: string + pattern: '^[A-Fa-f0-9]{16}$' +ipv6Index: + $ref: 'TS29519_Policy_Data.yaml#/components/schemas/IpIndex' +dnAaaAddress: + $ref: '#/components/schemas/IpAddress' +redundantPduSessionInfo: + $ref: '#/components/schemas/RedundantPduSessionInformation' +nspuSupportInd: + type: boolean +interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +intraPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' +pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' +hrsboInfo: + $ref: '#/components/schemas/HrsboInfoFromHplmn' +pendingUpdateInfoList: + type: array + items: + $ref: '#/components/schemas/PendingUpdateInfo' + minItems: 1 +required: +- pduSessionType +- sscMode +oneOf: +- required: [ hSmfInstanceId ] +- required: [ smfInstanceId ] + +HsmfUpdateData: + description: Data within Update Request towards H-SMF, or from I-SMF to SMF + type: object + properties: + requestIndication: + $ref: '#/components/schemas/RequestIndication' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + vcnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + icnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + additionalCnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + additionalAnType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + pauseCharging: + type: boolean + pti: + $ref: '#/components/schemas/ProcedureTransactionId' + nlSmInfoFromUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + unknownNlSmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + qosFlowsRelNotifyList: + type: array + items: + $ref: '#/components/schemas/QosFlowItem' + minItems: 1 + qosFlowsVsmfRejectedList: + +``` + +``` +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' +minItems: 1 +qosFlowsNotifyList: +type: array +items: + $ref: '#/components/schemas/QosFlowNotifyItem' +minItems: 1 +NotifyList: +type: array +items: + $ref: '#/components/schemas/PduSessionNotifyItem' +minItems: 1 +# The attribute name does not follow the naming conventions specified in 3GPP TS 29.501. The +# attribute name is kept though as defined in the current specification for backward compatibility +# reason. +epsBearerId: +type: array +items: + $ref: '#/components/schemas/EpsBearerId' +minItems: 0 +hoPreparationIndication: +type: boolean +revokeEbiList: +type: array +items: + $ref: '#/components/schemas/EpsBearerId' +minItems: 1 +cause: + $ref: '#/components/schemas/Cause' +ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' +5gMmCauseValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' +alwaysOnRequested: +type: boolean +default: false +epsInterworkingInd: + $ref: '#/components/schemas/EpsInterworkingIndication' +secondaryRatUsageReport: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageReport' +minItems: 1 +secondaryRatUsageInfo: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo' +minItems: 1 +anTypeCanBeChanged: +type: boolean +default: false +maReleaseInd: + $ref: '#/components/schemas/MaReleaseIndication' +maNwUpgradeInd: +type: boolean +default: false +maRequestInd: +type: boolean +default: false +unavailableAccessInd: + $ref: '#/components/schemas/UnavailableAccessIndication' +psaInfo: +type: array +items: + $ref: '#/components/schemas/PsaInformation' +minItems: 1 +ulclBpInfo: + $ref: '#/components/schemas/UlclBpInformation' +n4Info: + $ref: '#/components/schemas/N4Information' +n4InfoExt1: + $ref: '#/components/schemas/N4Information' +n4InfoExt2: + $ref: '#/components/schemas/N4Information' +presenceInLadn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceState' +``` + +``` +vsmfPduSessionUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +vsmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +vSmfServiceInstanceId: + type: string +ismfPduSessionUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +ismfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +iSmfServiceInstanceId: + type: string +dlServingPlmnRateCtl: + type: integer + minimum: 10 + nullable: true +dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +roamingChargingProfile: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile' +moExpDataCounter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter' +vplmnQos: + $ref: '#/components/schemas/VplmnQos' +securityResult: + $ref: '#/components/schemas/SecurityResult' +upSecurityInfo: + $ref: '#/components/schemas/UpSecurityInfo' +amfNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +secondaryRatUsageDataReportContainer: + type: array + items: + $ref: '#/components/schemas/SecondaryRatUsageDataReportContainer' + minItems: 1 +smPolicyNotifyInd: + type: boolean + enum: + - true +pcfUeCallbackInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' +satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' +maxIntegrityProtectedDataRateUl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' +maxIntegrityProtectedDataRateDl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' +upCnxState: + $ref: '#/components/schemas/UpCnxState' +ecsAddrConfigInfos: + type: array + items: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/EcsAddrConfigInfo' + minItems: 1 +hrsboInfo: + $ref: '#/components/schemas/HrsboInfoFromVplmn' +altSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +disasterRoamingInd: + type: boolean + enum: + - true +pduSetSupportInd: + type: boolean +ecnMarkingCongestionInfoStatus: + type: array + items: + $ref: '#/components/schemas/EcnMarkingCongestionInfoStatus' + minItems: 1 +required: + - requestIndication +``` + +``` +HsmfUpdatedData: + description: Data within Update Response from H-SMF, or from SMF to I-SMF + type: object + properties: + n1SmInfoToUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n4Info: + $ref: '#/components/schemas/N4Information' + n4InfoExt1: + $ref: '#/components/schemas/N4Information' + n4InfoExt2: + $ref: '#/components/schemas/N4Information' + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + roamingChargingProfile: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile' + homeProvidedChargingId: + type: string + pattern: '^(0|([1-9]{1}[0-9]{0,9}))$' + homeProvidedSmfChargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmfChargingId' + upSecurity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UpSecurity' + maxIntegrityProtectedDataRateUl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + maxIntegrityProtectedDataRateDl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + ipv6MultiHomingInd: + type: boolean + default: false + qosFlowsSetupList: + type: array + items: + $ref: '#/components/schemas/QosFlowSetupItem' + minItems: 1 + sessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + epsPdnCnxInfo: + $ref: '#/components/schemas/EpsPdnCnxInfo' + epsBearerInfo: + type: array + items: + $ref: '#/components/schemas/EpsBearerInfo' + minItems: 1 + pti: + $ref: '#/components/schemas/ProcedureTransactionId' + interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + intraPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + hrsboInfo: + $ref: '#/components/schemas/HrsboInfoFromHplmn' +``` + +``` +ReleaseData: + description: Data within Release Request + type: object + properties: + cause: + $ref: '#/components/schemas/Cause' + ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + 5gMmCauseValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + secondaryRatUsageReport: + type: array + items: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageReport' + minItems: 1 + secondaryRatUsageInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo' + minItems: 1 + n4Info: + $ref: '#/components/schemas/N4Information' + n4InfoExt1: + $ref: '#/components/schemas/N4Information' + n4InfoExt2: + $ref: '#/components/schemas/N4Information' + +ReleasedData: + description: Data within Release Response + type: object + properties: + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' + n4Info: + $ref: '#/components/schemas/N4Information' + n4InfoExt1: + $ref: '#/components/schemas/N4Information' + n4InfoExt2: + $ref: '#/components/schemas/N4Information' + +VsmfUpdateData: + description: Data within Update Request towards V-SMF, or from SMF to I-SMF + type: object + properties: + requestIndication: + $ref: '#/components/schemas/RequestIndication' + sessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + qosFlowsAddModRequestList: + type: array + items: + $ref: '#/components/schemas/QosFlowAddModifyRequestItem' + minItems: 1 + qosFlowsRelRequestList: + type: array + items: + $ref: '#/components/schemas/QosFlowReleaseRequestItem' + minItems: 1 + epsBearerInfo: + type: array + items: + $ref: '#/components/schemas/EpsBearerInfo' + minItems: 1 + assignEbiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + revokeEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + modifiedEbiList: + type: array + items: + $ref: '#/components/schemas/EbiArpMapping' + minItems: 1 + pti: + $ref: '#/components/schemas/ProcedureTransactionId' + nlSmInfoToUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + alwaysOnGranted: + type: boolean + default: false + hsmfPduSessionUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + newSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +``` + +``` +newSmfPduSessionUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +cause: + $ref: '#/components/schemas/Cause' +nlsnCause: + type: string +backOffTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +maReleaseInd: + $ref: '#/components/schemas/MaReleaseIndication' +maAcceptedInd: + type: boolean + default: false +additionalCnTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' +dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' +n4Info: + $ref: '#/components/schemas/N4Information' +n4InfoExt1: + $ref: '#/components/schemas/N4Information' +n4InfoExt2: + $ref: '#/components/schemas/N4Information' +n4InfoExt3: + $ref: '#/components/schemas/N4Information' +smallDataRateControlEnabled: + type: boolean +qosMonitoringInfo: + $ref: '#/components/schemas/QosMonitoringInfo' +epsPdnCnxInfo: + $ref: '#/components/schemas/EpsPdnCnxInfo' +n9DataForwardingInd: + type: boolean + default: false +n9InactivityTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +hrsboInfo: + $ref: '#/components/schemas/HrsboInfoFromHplmn' +altHplmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' +pduSessionRetainInd: + type: boolean + enum: + - true +pendingUpdateInfoList: + type: array + items: + $ref: '#/components/schemas/PendingUpdateInfo' +required: + - requestIndication + +VsmfUpdatedData: + description: Data within Update Response from V-SMF, or from I-SMF to SMF + type: object + properties: + qosFlowsAddModList: + type: array + items: + $ref: '#/components/schemas/QosFlowItem' + minItems: 1 + qosFlowsRelList: + type: array + items: + $ref: '#/components/schemas/QosFlowItem' + minItems: 1 + qosFlowsFailedtoAddModList: + type: array + items: + $ref: '#/components/schemas/QosFlowItem' + minItems: 1 + qosFlowsVsmfRejectedAddModList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' +``` + +``` + + minItems: 1 + qosFlowsFailedToRelList: + type: array + items: + $ref: '#/components/schemas/QosFlowItem' + minItems: 1 + nlSmInfoFromUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + unknownNlSmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + addUeLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + assignedEbiList: + type: array + items: + $ref: '#/components/schemas/EbiArpMapping' + minItems: 1 + failedToAssignEbiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 + releasedEbiList: + type: array + items: + $ref: '#/components/schemas/EpsBearerId' + minItems: 1 + secondaryRatUsageReport: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageReport' + minItems: 1 + secondaryRatUsageInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecondaryRatUsageInfo' + minItems: 1 + n4Info: + $ref: '#/components/schemas/N4Information' + n4InfoExt1: + $ref: '#/components/schemas/N4Information' + n4InfoExt2: + $ref: '#/components/schemas/N4Information' + n4InfoExt3: + $ref: '#/components/schemas/N4Information' + modifiedEbiListNotDelivered: + type: boolean + ecnMarkingCongestionInfoStatus: + type: array + items: + $ref: '#/components/schemas/EcnMarkingCongestionInfoStatus' + minItems: 1 + +StatusNotification: + description: Data within Notify Status Request + type: object + properties: + statusInfo : + $ref: '#/components/schemas/StatusInfo' + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApnRateStatus' + targetDnaiInfo: + $ref: '#/components/schemas/TargetDnaiInfo' + oldPduSessionRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + newSmfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + epsPdnCnxInfo: + $ref: '#/components/schemas/EpsPdnCnxInfo' + interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + intraPlmnApiRoot: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + required: + - statusInfo + +QosFlowItem: + description: Individual QoS flow + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + cause: + $ref: '#/components/schemas/Cause' + currentQosProfileIndex: + type: integer + minimum: 1 + maximum: 8 + nullQosProfileIndex: + type: boolean + ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + required: + - qfi + +QosFlowSetupItem: + description: Individual QoS flow to setup + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + qosRules: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + ebi: + $ref: '#/components/schemas/EpsBearerId' + qosFlowDescription: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + qosFlowProfile: + $ref: '#/components/schemas/QosFlowProfile' + associatedAnType: + $ref: '#/components/schemas/QosFlowAccessType' + defaultQosRuleInd: + type: boolean + ecnMarkingCongestInfoReq: + $ref: '#/components/schemas/EcnMarkingCongestInfoReq' + required: + - qfi + - qosRules + +QosFlowAddModifyRequestItem: + description: Individual QoS flow requested to be created or modified + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + ebi: + $ref: '#/components/schemas/EpsBearerId' + qosRules: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + qosFlowDescription: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + qosFlowProfile: + $ref: '#/components/schemas/QosFlowProfile' + associatedAnType: + $ref: '#/components/schemas/QosFlowAccessType' + ecnMarkingCongestInfoReq: + $ref: '#/components/schemas/EcnMarkingCongestInfoReq' + tscaiUl: + $ref: '#/components/schemas/TscAssistanceInformation' + tscaiDl: + $ref: '#/components/schemas/TscAssistanceInformation' + required: + - qfi + +QosFlowReleaseRequestItem: + description: Individual QoS flow requested to be released + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' +``` + +``` + + qosRules: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + qosFlowDescription: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + required: + - qfi + +QosFlowProfile: + description: QoS flow profile + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + nonDynamic5Qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NonDynamic5Qi' + dynamic5Qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dynamic5Qi' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + gbrQosFlowInfo: + $ref: '#/components/schemas/GbrQosFlowInformation' + rqa: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReflectiveQoSAttribute' + additionalQosFlowInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AdditionalQosFlowInfo' + qosMonitoringReq: + $ref: '#/components/schemas/QosMonitoringReq' + qosRepPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + pduSetQosPara: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' + required: + - 5qi + +GbrQosFlowInformation: + description: GBR QoS flow information + type: object + properties: + maxFbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxFbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + guaFbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + guaFbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + notifControl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationControl' + maxPacketLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + maxPacketLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + alternativeQosProfileList: + type: array + items: + $ref: '#/components/schemas/AlternativeQosProfile' + required: + - maxFbrDl + - maxFbrUl + - guaFbrDl + - guaFbrUl + +QosFlowNotifyItem: + description: Notification related to a QoS flow + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + notificationCause: + $ref: '#/components/schemas/NotificationCause' + currentQosProfileIndex: + type: integer + minimum: 1 + maximum: 8 + nullQoSProfileIndex: + type: boolean + required: + - qfi + +``` + +- notificationCause + +SmContextRetrieveData: +description: Data within Retrieve SM Context Request +type: object +properties: + targetMmeCap: + \$ref: '#/components/schemas/MmeCapabilities' + smContextType: + \$ref: '#/components/schemas/SmContextType' + servingNetwork: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnId' + notToTransferEbiList: + type: array + items: + \$ref: '#/components/schemas/EpsBearerId' + minItems: 1 + ranUnchangedInd: + type: boolean + default: false + hrsboSupportInd: + type: boolean + default: false + storedOffloadIds: + type: array + items: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/OffloadIdentifier' + minItems: 1 + +SmContextRetrievedData: +description: Data within Retrieve SM Context Response +type: object +properties: + ueEpsPdnConnection: + \$ref: '#/components/schemas/EpsPdnCnxContainer' + smContext: + \$ref: '#/components/schemas/SmContext' + smallDataRateStatus: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/SmallDataRateStatus' + apnRateStatus: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/ApnRateStatus' + dlDataWaitingInd: + type: boolean + default: false + afCoordinationInfo: + \$ref: '#/components/schemas/AfCoordinationInfo' + required: + - ueEpsPdnConnection + +MmeCapabilities: +description: MME capabilities +type: object +properties: + nonIpSupported: + type: boolean + default: false + ethernetSupported: + type: boolean + default: false + upipSupported: + type: boolean + default: false + +TunnelInfo: +description: Tunnel Information +type: object +properties: + ipv4Addr: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv6Addr' + gtpTeid: + \$ref: '#/components/schemas/Teid' + anType: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/AccessType' + required: + - gtpTeid + +``` +StatusInfo: + description: Status of SM context or of PDU session + type: object + properties: + resourceStatus: + $ref: '#/components/schemas/ResourceStatus' + cause: + $ref: '#/components/schemas/Cause' + remoteError: + type: boolean + cnAssistedRanPara: + $ref: '#/components/schemas/CnAssistedRanPara' + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + required: + - resourceStatus + +EpsPdnCnxInfo: + description: EPS PDN Connection Information from H-SMF to V-SMF, or from SMF to I-SMF + type: object + properties: + pgwS8cFteid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + pgwNodeName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + pgwChangeInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + linkedBearerId: + $ref: '#/components/schemas/EpsBearerId' + required: + - pgwS8cFteid + +EpsBearerInfo: + description: EPS Bearer Information from H-SMF to V-SMF, or from SMF to I-SMF + type: object + properties: + ebi: + $ref: '#/components/schemas/EpsBearerId' + pgwS8uFteid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + bearerLevelQoS: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + required: + - ebi + - pgwS8uFteid + - bearerLevelQoS + +PduSessionNotifyItem: + description: Notification related to a PDU session + type: object + properties: + notificationCause: + $ref: '#/components/schemas/NotificationCause' + required: + - notificationCause + +EbiArpMapping: + description: EBI to ARP mapping + type: object + properties: + epsBearerId: + $ref: '#/components/schemas/EpsBearerId' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + required: + - epsBearerId + - arp + +SmContextCreateError: + description: Error within Create SM Context Response + type: object + properties: + error: + $ref: '#/components/schemas/ExtProblemDetails' + nlSmMsg: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +``` + +``` +n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' +recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +required: +- error + +SmContextUpdateError: +description: Error within Update SM Context Response +type: object +properties: + error: + $ref: '#/components/schemas/ExtProblemDetails' + nlSmMsg: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n2SmInfoType: + $ref: '#/components/schemas/N2SmInfoType' + upCnxState: + $ref: '#/components/schemas/UpCnxState' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - error + +PduSessionCreateError: +description: Error within Create Response +type: object +properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + nlSmCause: + type: string + pattern: '^[A-F0-9]{2}$' + nlSmInfoToUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + backOffTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - error + +HsmfUpdateError: +description: Error within Update Response from H-SMF, or from SMF to I-SMF +type: object +properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + pti: + $ref: '#/components/schemas/ProcedureTransactionId' + nlSmCause: + type: string + pattern: '^[A-F0-9]{2}$' + nlSmInfoToUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + backOffTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - error + +VsmfUpdateError: +description: Error within Update Response from V-SMF, or from I-SMF to SMF +type: object +properties: + error: + $ref: '#/components/schemas/ExtProblemDetails' + pti: + $ref: '#/components/schemas/ProcedureTransactionId' + nlSmCause: + type: string + pattern: '^[A-F0-9]{2}$' + nlSmInfoFromUe: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +unknownNlSmInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +failedToAssignEbiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + minItems: 1 +ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' +5gMmCauseValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' +recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +n4Info: + $ref: '#/components/schemas/N4Information' +n4InfoExt1: + $ref: '#/components/schemas/N4Information' +n4InfoExt2: + $ref: '#/components/schemas/N4Information' +n4InfoExt3: + $ref: '#/components/schemas/N4Information' +retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +required: +- error + +SmContext: + description: Complete SM Context + type: object + properties: + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + selectedDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + hPlmnSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + pduSessionType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + hSmfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + pduSessionRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + interPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + intraPlmnApiRoot: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + selMode: + $ref: '#/components/schemas/DnnSelectionMode' + udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + routingIndicator: + type: string + hNwPubKeyId: + type: integer + sessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + qosFlowsList: + type: array + items: + $ref: '#/components/schemas/QosFlowSetupItem' + minItems: 1 + hSmfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +``` + +``` +smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +pduSessionSmfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +pduSessionSmfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +pduSessionSmfBinding: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/SbiBindingLevel' +enablePauseCharging: + type: boolean + default: false +ueIpv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +ueIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +epsPdnCnxInfo: + $ref: '#/components/schemas/EpsPdnCnxInfo' +epsBearerInfo: + type: array + items: + $ref: '#/components/schemas/EpsBearerInfo' + minItems: 1 +maxIntegrityProtectedDataRate: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' +maxIntegrityProtectedDataRateDl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' +alwaysOnGranted: + type: boolean + default: false +upSecurity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UpSecurity' +hSmfServiceInstanceId: + type: string +smfServiceInstanceId: + type: string +recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +forwardingInd: + type: boolean + default: false +psaTunnelInfo: + $ref: '#/components/schemas/TunnelInfo' +chargingId: + type: string + pattern: '^(0|([1-9]{1}[0-9]{0,9}))$' +smfChargingId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmfChargingId' +chargingInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ChargingInformation' +roamingChargingProfile: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/RoamingChargingProfile' +nefExtBufSupportInd: + type: boolean + default: false +ipv6Index: + $ref: 'TS29519_Policy_Data.yaml#/components/schemas/IpIndex' +dnAaaAddress: + $ref: '#/components/schemas/IpAddress' +redundantPduSessionInfo: + $ref: '#/components/schemas/RedundantPduSessionInformation' +ranTunnelInfo: + $ref: '#/components/schemas/QosFlowTunnel' +addRanTunnelInfo: + type: array + items: + $ref: '#/components/schemas/QosFlowTunnel' + minItems: 1 +redRanTunnelInfo: + $ref: '#/components/schemas/QosFlowTunnel' +addRedRanTunnelInfo: + type: array + items: + $ref: '#/components/schemas/QosFlowTunnel' + minItems: 1 +nspuSupportInd: + type: boolean +smfBindingInfo: + type: string +``` + +``` +satelliteBackhaulCat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' +sscMode: + type: string + pattern: '^[0-7] $' +dlsetSupportInd: + type: boolean +n9fscSupportInd: + type: boolean +anchorSmfOAuth2Required: + type: boolean +fullDnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 +hrsboAuthReqInd: + type: boolean +hDnsAddr: + $ref: '#/components/schemas/IpAddress' +hPlmnAddr: + $ref: '#/components/schemas/IpAddress' +vPlmnOffloadingInfoList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VPlmnOffloadingInfo' + minItems: 1 +offloadIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OffloadIdentifier' + minItems: 1 +easIpReplacementInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EasIpReplacementInfo' +targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' +pendingUpdateInfoList: + type: array + items: + $ref: '#/components/schemas/PendingUpdateInfo' + minItems: 1 +easInfoToRefresh: + $ref: '#/components/schemas/EasInfoToRefresh' +pduSetSupportInd: + type: boolean +required: +- pduSessionId +- dnn +- sNssai +- pduSessionType +- sessionAmbr +- qosFlowsList + +ExemptionInd: + description: Exemption Indication + type: object + properties: + dnnCongestion: + type: boolean + default: false + snssaiOnlyCongestion: + type: boolean + default: false + snssaiDnnCongestion: + type: boolean + default: false + +PsaInformation: + description: PSA Information + type: object + properties: + psaInd: + $ref: '#/components/schemas/PsaIndication' + dnaList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 +``` + +``` + ueIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + psaUpfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +DnaiInformation: + description: DNAI Information + type: object + properties: + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + noDnaiChangeInd: + type: boolean + noLocalPsaChangeInd: + type: boolean + required: + - dnai + +N4Information: + description: N4 Information + type: object + properties: + n4MessageType: + $ref: '#/components/schemas/N4MessageType' + n4MessagePayload: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + n4DnaiInfo: + $ref: '#/components/schemas/DnaiInformation' + psaUpfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ulClBpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + n9UlPdrIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + minItems: 1 + required: + - n4MessageType + - n4MessagePayload + +IndirectDataForwardingTunnelInfo: + description: Indirect Data Forwarding Tunnel Information + type: object + properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + gtpTeid: + $ref: '#/components/schemas/Teid' + drbId: + $ref: '#/components/schemas/DrbId' + additionalTnlNb: + $ref: '#/components/schemas/AdditionalTnlNb' + required: + - gtpTeid + not: + required: [ drbId, additionalTnlNb ] + +SendMoDataReqData: + description: Data within Send MO Data Request + type: object + properties: + moData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + moExpDataCounter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + required: + - moData + +CnAssistedRanPara: + description: SMF derived CN assisted RAN parameters tuning + type: object + properties: + stationaryIndication: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/StationaryIndication' + communicationDurationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + periodicTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + scheduledCommunicationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime' + scheduledCommunicationType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationType' + trafficProfile: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficProfile' + batteryIndication: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BatteryIndication' + +UlclBpInformation: + description: UL CL or BP Information + type: object + properties: + ulclBpUpfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +TransferMoDataReqData: + description: Data within Transfer MO Data Request + type: object + properties: + moData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + moExpDataCounter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MoExpDataCounter' + ueLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + required: + - moData + +TransferMtDataReqData: + description: Data within Transfer MT Data Request + type: object + properties: + mtData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + required: + - mtData + +TransferMtDataError: + description: Transfer MT Data Error Response + allOf: + - $ref: '#/components/schemas/ExtProblemDetails' + - $ref: '#/components/schemas/TransferMtDataAddInfo' + +TransferMtDataAddInfo: + description: Transfer MT Data Error Response Additional Information + type: object + properties: + maxWaitingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +VplmnQos: + description: VPLMN QoS + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + sessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + maxFbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxFbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + guaFbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + guaFbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + 5qiPL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel' + +DdnFailureSubs: +``` + +``` +description: DDN Failure Subscription +type: object +properties: + ddnFailureSubsInd: + type: boolean + default: false + ddnFailureSubsInfoList: + type: array + items: + $ref: '#/components/schemas/DdnFailureSubInfo' + minItems: 1 + +DdnFailureSubInfo: + description: DDN Failure Subscription Information + type: object + required: + - notifyCorrelationId + properties: + notifyCorrelationId: + type: string + dddTrafficDescriptorList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' + minItems: 1 + +RetrieveData: + description: Data within Retrieve Request + type: object + properties: + smallDataRateStatusReq: + type: boolean + default: false + pduSessionContextType: + $ref: '#/components/schemas/PduSessionContextType' + +RetrievedData: + description: Data within Retrieve Response + type: object + properties: + smallDataRateStatus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SmallDataRateStatus' + afCoordinationInfo: + $ref: '#/components/schemas/AfCoordinationInfo' + +SecurityResult: + description: Security Result + type: object + properties: + integrityProtectionResult: + $ref: '#/components/schemas/ProtectionResult' + confidentialityProtectionResult: + $ref: '#/components/schemas/ProtectionResult' + +UpSecurityInfo: + description: User Plane Security Information + type: object + properties: + upSecurity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UpSecurity' + maxIntegrityProtectedDataRateUl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + maxIntegrityProtectedDataRateDl: + $ref: '#/components/schemas/MaxIntegrityProtectedDataRate' + securityResult: + $ref: '#/components/schemas/SecurityResult' + required: + - upSecurity + +AlternativeQosProfile: + description: Alternative QoS Profile + type: object + properties: + index: + type: integer + minimum: 1 + maximum: 8 + guaFbrDl: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + guaFbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + packetDelayBudget: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + packetErrRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + maxDataBurstVol: + type: integer + minimum: 1 + maximum: 2000000 + required: + - index + +ExtProblemDetails: + description: Extended Problem Details + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ProblemDetailsAddInfo' + +ProblemDetailsAddInfo: + description: Problem Details Additional Information + type: object + properties: + remoteError: + type: boolean + +QosMonitoringInfo: + description: QoS Monitoring Information + type: object + properties: + qosMonitoringInd: + type: boolean + default: false + +IpAddress: + description: IP Address + type: object + oneOf: + - required: + - ipv4Addr + - required: + - ipv6Addr + - required: + - ipv6Prefix + properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + ipv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + +RedundantPduSessionInformation: + description: Redundant PDU Session Information + type: object + properties: + rsn: + $ref: '#/components/schemas/Rsn' + pduSessionPairId: + type: integer + minimum: 0 + maximum: 255 + required: + - rsn + +QosFlowTunnel: + description: Tunnel Information per QoS Flow + type: object + properties: + qfiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + minItems: 1 + tunnelInfo: + $ref: '#/components/schemas/TunnelInfo' +``` + +``` + required: + - qfiList + - tunnelInfo + +TargetDnaiInfo: + description: Target DNAI Information + type: object + properties: + targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + smfSelectionType: + $ref: '#/components/schemas/SmfSelectionType' + required: + - smfSelectionType + +AfCoordinationInfo: + description: AF Coordination Information + type: object + properties: + sourceDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + sourceUeIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + sourceUeIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + notificationInfoList: + type: array + items: + $ref: '#/components/schemas/NotificationInfo' + minItems: 1 + +NotificationInfo: + description: > + Notification Correlation ID and Notification URI provided by the NF service consumer + type: object + properties: + notifId: + type: string + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + upBufferInd: + type: boolean + default: false + required: + - notifId + - notifUri + +AnchorSmfFeatures: + description: Anchor SMF supported features + type: object + properties: + psetrSupportInd: + type: boolean + +HrsboInfoFromVplmn: + description: HR-SBO Information in request message + type: object + properties: + hrsboAuthReqInd: + type: boolean + enum: + - true + vEasdfAddr: + $ref: '#/components/schemas/IpAddress' + localDnsAddr: + $ref: '#/components/schemas/IpAddress' + easRediscoveryInd: + type: boolean + enum: + - true + easInfoToRefresh: + $ref: '#/components/schemas/EasInfoToRefresh' + storedOffloadIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OffloadIdentifier' + minItems: 1 +``` + +``` +HrsboInfoFromHplmn: + description: HR-SBO Information in response message + type: object + properties: + hrsboAuthResult: + type: boolean + hDnsAddr: + $ref: '#/components/schemas/IpAddress' + hPlmnAddr: + $ref: '#/components/schemas/IpAddress' + vPlmnOffloadingInfoList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VPlmnOffloadingInfo' + offloadIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OffloadIdentifier' + internalGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + easIpReplacementInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EasIpReplacementInfo' + targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + +EasInfoToRefresh: + description: EAS information to be refreshed for EAS re-discovery + type: object + properties: + ipv4AddressRanges: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6AddressRanges: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6AddressRange' + minItems: 1 + fqdnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + +EcnMarkingCongestionInfoReq: + description: ECN Marking or Congestion Information Request + type: object + properties: + ecnMarkingReq: + $ref: '#/components/schemas/EcnMarkingReq' + congestionInfoReq: + $ref: '#/components/schemas/CongestionInfoReq' + oneOf: + - required: [ ecnMarkingReq ] + - required: [ congestionInfoReq ] + +EcnMarkingCongestionInfoStatus: + description: ECN Marking or Congestion Information Status + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + activationStatus: + $ref: '#/components/schemas/ActivationStatus' + required: + - qfi + - activationStatus + +TscAssistanceInformation: + description: TSC Assistance Information + type: object + properties: + periodicity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' +``` + +``` + n6JitterInformation: + $ref: '#/components/schemas/N6JitterInformation' + + N6JitterInformation: + description: Jitter information associated with the Periodicity in downlink + type: object + properties: + lowerJitterInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Int32' + higherJitterInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Int32' + +# +# SIMPLE DATA TYPES +# + + ProcedureTransactionId: + description: Procedure Transaction Identifier + type: integer + minimum: 0 + maximum: 255 + + EpsBearerId: + description: EPS Bearer Identifier + type: integer + minimum: 0 + maximum: 15 + + EpsPdnCnxContainer: + description: UE EPS PDN Connection container from SMF to AMF + type: string + format: byte + + EpsBearerContainer: + description: EPS Bearer container from SMF to AMF + type: string + format: byte + + Teid: + type: string + description: GTP Tunnel Endpoint Identifier + pattern: '^[A-Fa-f0-9]{8}$' + + EpsBearerContextStatus: + description: EPS bearer context status + type: string + pattern: '^[A-Fa-f0-9]{4}$' + + DrbId: + description: Data Radio Bearer Identity + type: integer + minimum: 1 + maximum: 32 + + AdditionalTnlNb: + description: indicates first, second or third additional indirect data forwarding tunnel + type: integer + minimum: 1 + maximum: 3 + + ForwardingBearerContainer: + description: Forwarding Bearer Container + type: string + format: byte + + SecondaryRatUsageDataReportContainer: + description: Secondary Rat Usage Data Report Container + type: string + format: byte + +# +# ENUMERATIONS +# + + UpCnxState: + anyOf: + - type: string + enum: + - ACTIVATED + - DEACTIVATED +``` + +``` + - ACTIVATING + - SUSPENDED +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. +description: | +User Plane Connection State. Possible values are +- ACTIVATED +- DEACTIVATED +- ACTIVATING +- SUSPENDED + +HoState: +anyOf: +- type: string +enum: +- NONE +- PREPARING +- PREPARED +- COMPLETED +- CANCELLED +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. +description: | +Handover state. Possible values are +- NONE +- PREPARING +- PREPARED +- COMPLETED +- CANCELLED + +RequestType: +anyOf: +- type: string +enum: +- INITIAL_REQUEST +- EXISTING_PDU_SESSION +- INITIAL_EMERGENCY_REQUEST +- EXISTING_EMERGENCY_PDU_SESSION +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. +description: | +Request Type in Create (SM context) service operation. Possible values are +- INITIAL_REQUEST +- EXISTING_PDU_SESSION +- INITIAL_EMERGENCY_REQUEST +- EXISTING_EMERGENCY_PDU_SESSION + +RequestIndication: +anyOf: +- type: string +enum: +- UE_REQ_PDU_SES_MOD +- UE_REQ_PDU_SES_REL +- PDU_SES_MOB +- NW_REQ_PDU_SES_AUTH +- NW_REQ_PDU_SES_MOD +- NW_REQ_PDU_SES_REL +- EBI_ASSIGNMENT_REQ +- REL_DUE_TO_5G_AN_REQUEST +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. +description: | +Request Indication in Update (SM context) service operation. Possible values are +- UE_REQ_PDU_SES_MOD +- UE_REQ_PDU_SES_REL +- PDU_SES_MOB +``` + +- NW\_REQ\_PDU\_SES\_AUTH +- NW\_REQ\_PDU\_SES\_MOD +- NW\_REQ\_PDU\_SES\_REL +- EBI\_ASSIGNMENT\_REQ +- REL\_DUE\_TO\_5G\_AN\_REQUEST + +## NotificationCause: + +## anyOf: + +- type: string + +## enum: + +- QOS\_FULFILLED +- QOS\_NOT\_FULFILLED +- UP\_SEC\_FULFILLED +- UP\_SEC\_NOT\_FULFILLED + +- type: string + +## description: > + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +## description: | + +Cause for generating a notification. Possible values are + +- QOS\_FULFILLED +- QOS\_NOT\_FULFILLED +- UP\_SEC\_FULFILLED +- UP\_SEC\_NOT\_FULFILLED + +## Cause: + +## anyOf: + +- type: string + +## enum: + +- REL\_DUE\_TO\_HO +- EPS\_FALLBACK +- REL\_DUE\_TO\_UP\_SEC +- DNN\_CONGESTION +- S\_NSSAI\_CONGESTION +- REL\_DUE\_TO\_REACTIVATION +- 5G\_AN\_NOT\_RESPONDING +- REL\_DUE\_TO\_SLICE\_NOT\_AVAILABLE +- REL\_DUE\_TO\_DUPLICATE\_SESSION\_ID +- PDU\_SESSION\_STATUS\_MISMATCH +- HO\_FAILURE +- INSUFFICIENT\_UP\_RESOURCES +- PDU\_SESSION\_HANDED\_OVER +- PDU\_SESSION\_RESUMED +- CN\_ASSISTED\_RAN\_PARAMETER\_TUNING +- ISMF\_CONTEXT\_TRANSFER +- SMF\_CONTEXT\_TRANSFER +- REL\_DUE\_TO\_PS\_TO\_CS\_HO +- REL\_DUE\_TO\_SUBSCRIPTION\_CHANGE +- HO\_CANCEL +- REL\_DUE\_TO\_SLICE\_NOT\_AUTHORIZED +- PDU\_SESSION\_HAND\_OVER\_FAILURE +- DDN\_FAILURE\_STATUS +- REL\_DUE\_TO\_CP\_ONLY\_NOT\_APPLICABLE +- NOT\_SUPPORTED\_WITH\_ISMF +- CHANGED\_ANCHOR\_SMF +- CHANGED\_INTERMEDIATE\_SMF +- TARGET\_DNAI\_NOTIFICATION +- REL\_DUE\_TO\_VPLMN\_QOS\_FAILURE +- REL\_DUE\_TO\_SMF\_NOT\_SUPPORT\_PSETR +- REL\_DUE\_TO\_SNPN\_SNPN\_MOBILITY +- REL\_DUE\_TO\_NO\_HR\_AGREEMENT +- REL\_DUE\_TO\_UNSPECIFIED\_REASON +- REL\_DUE\_TO\_MOB\_ACCESS\_RESTRICTIONS +- REL\_DUE\_TO\_SLICE\_INACTIVITY +- REL\_DUE\_TO\_NSI\_NOT\_AVAILABLE +- REL\_DUE\_TO\_DNN\_DENIED +- REL\_DUE\_TO\_PDUTYPE\_DENIED +- REL\_DUE\_TO\_SSC\_DENIED +- REL\_DUE\_TO\_SUBSCRIPTION\_DENIED +- REL\_DUE\_TO\_DNN\_NOT\_SUPPORTED +- REL\_DUE\_TO\_PDUTYPE\_NOT\_SUPPORTED +- REL\_DUE\_TO\_SSC\_NOT\_SUPPORTED +- REL\_DUE\_TO\_INSUFFICIENT\_RESOURCES\_SLICE +- REL\_DUE\_TO\_INSUFFICIENT\_RESOURCES\_SLICE\_DNN +- REL\_DUE\_TO\_DNN\_CONGESTION +- REL\_DUE\_TO\_S\_NSSAI\_CONGESTION +- REL\_DUE\_TO\_PEER\_NOT\_RESPONDING + +``` + + - REL_DUE_TO_NETWORK_FAILURE + - REL_DUE_TO_UPF_NOT_RESPONDING + - REL_DUE_TO_NO_EPS_5GS_CONTINUITY + - REL_DUE_TO_NOT_SUPPORTED_WITH_ISMF + - REL_DUE_TO_EXCEEDED_UE_SLICE_DATA_RATE + - REL_DUE_TO_EXCEEDED_SLICE_DATA_RATE + - REL_DUE_TO_CONTEXT_NOT_FOUND + - REL_DUE_TO_MBSR_NOT_AUTHORIZED + - DEACT_DUE_TO_UE_OUT_OF_SLICE_SUPPORT_AREA + - REJECT_DUE_TO_N1_SM_ERROR +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +description: | + Cause information. Possible values are + - REL_DUE_TO_HO + - EPS_FALLBACK + - REL_DUE_TO_UP_SEC + - DNN_CONGESTION + - S_NSSAI_CONGESTION + - REL_DUE_TO_REACTIVATION + - 5G_AN_NOT_RESPONDING + - REL_DUE_TO_SLICE_NOT_AVAILABLE + - REL_DUE_TO_DUPLICATE_SESSION_ID + - PDU_SESSION_STATUS_MISMATCH + - HO_FAILURE + - INSUFFICIENT_UP_RESOURCES + - PDU_SESSION_HANDED_OVER + - PDU_SESSION_RESUMED + - CN_ASSISTED_RAN_PARAMETER_TUNING + - ISMF_CONTEXT_TRANSFER + - SMF_CONTEXT_TRANSFER + - REL_DUE_TO_PS_TO_CS_HO + - REL_DUE_TO_SUBSCRIPTION_CHANGE + - HO_CANCEL + - REL_DUE_TO_SLICE_NOT_AUTHORIZED + - PDU_SESSION_HAND_OVER_FAILURE + - DDN_FAILURE_STATUS + - REL_DUE_TO_CP_ONLY_NOT_APPLICABLE + - NOT_SUPPORTED_WITH_ISMF + - CHANGED_ANCHOR_SMF + - CHANGED_INTERMEDIATE_SMF + - TARGET_DNAI_NOTIFICATION + - REL_DUE_TO_VPLMN_QOS_FAILURE + - REL_DUE_TO_SMF_NOT_SUPPORT_PSETR + - REL_DUE_TO_SNPN_SNPN_MOBILITY + - REL_DUE_TO_NO_HR_AGREEMENT + - REL_DUE_TO_UNSPECIFIED_REASON + - REL_DUE_TO_MOB_ACCESS_RESTRICTIONS + - REL_DUE_TO_SLICE_INACTIVITY + - REL_DUE_TO_NSI_NOT_AVAILABLE + - REL_DUE_TO_DNN_DENIED + - REL_DUE_TO_PDUTYPE_DENIED + - REL_DUE_TO_SSC_DENIED + - REL_DUE_TO_SUBSCRIPTION_DENIED + - REL_DUE_TO_DNN_NOT_SUPPORTED + - REL_DUE_TO_PDUTYPE_NOT_SUPPORTED + - REL_DUE_TO_SSC_NOT_SUPPORTED + - REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE + - REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE_DNN + - REL_DUE_TO_DNN_CONGESTION + - REL_DUE_TO_S_NSSAI_CONGESTION + - REL_DUE_TO_PEER_NOT_RESPONDING + - REL_DUE_TO_NETWORK_FAILURE + - REL_DUE_TO_UPF_NOT_RESPONDING + - REL_DUE_TO_NO_EPS_5GS_CONTINUITY + - REL_DUE_TO_NOT_SUPPORTED_WITH_ISMF + - REL_DUE_TO_EXCEEDED_UE_SLICE_DATA_RATE + - REL_DUE_TO_EXCEEDED_SLICE_DATA_RATE + - REL_DUE_TO_CONTEXT_NOT_FOUND + - REL_DUE_TO_MBSR_NOT_AUTHORIZED + - DEACT_DUE_TO_UE_OUT_OF_SLICE_SUPPORT_AREA + - REJECT_DUE_TO_N1_SM_ERROR + +ResourceStatus: + anyOf: + +``` + +``` +- type: string +enum: + - RELEASED + - UNCHANGED + - TRANSFERRED + - UPDATED + - ALT_ANCHOR_SMF +- type: string +description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +description: | + Status of SM context or PDU session resource. Possible values are + - RELEASED + - UNCHANGED + - TRANSFERRED + - UPDATED + - ALT_ANCHOR_SMF + +DnnSelectionMode: +anyOf: +- type: string +enum: + - VERIFIED + - UE_DNN_NOT_VERIFIED + - NW_DNN_NOT_VERIFIED +- type: string +description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +description: | + DNN Selection Mode. Possible values are + - VERIFIED + - UE_DNN_NOT_VERIFIED + - NW_DNN_NOT_VERIFIED + +EpsInterworkingIndication: +anyOf: +- type: string +enum: + - NONE + - WITH_N26 + - WITHOUT_N26 + - IWK_NON_3GPP +- type: string +description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +description: | + EPS Interworking Indication. Possible values are + - NONE + - WITH_N26 + - WITHOUT_N26 + - IWK_NON_3GPP + +N2SmInfoType: +anyOf: +- type: string +enum: + - PDU_RES_SETUP_REQ + - PDU_RES_SETUP_RSP + - PDU_RES_SETUP_FAIL + - PDU_RES_REL_CMD + - PDU_RES_REL_RSP + - PDU_RES_MOD_REQ + - PDU_RES_MOD_RSP + - PDU_RES_MOD_FAIL + - PDU_RES_NTY + - PDU_RES_NTY_REL + - PDU_RES_MOD_IND + - PDU_RES_MOD_CFM + - PATH_SWITCH_REQ + - PATH_SWITCH_SETUP_FAIL + - PATH_SWITCH_REQ_ACK + - PATH_SWITCH_REQ_FAIL +``` + +- HANDOVER\_REQUIRED +- HANDOVER\_CMD +- HANDOVER\_PREP\_FAIL +- HANDOVER\_REQ\_ACK +- HANDOVER\_RES\_ALLOC\_FAIL +- SECONDARY\_RAT\_USAGE +- PDU\_RES\_MOD\_IND\_FAIL +- UE\_CONTEXT\_RESUME\_REQ +- UE\_CONTEXT\_RESUME\_RSP +- UE\_CONTEXT\_SUSPEND\_REQ + +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | +N2 SM Information Type. Possible values are + +- PDU\_RES\_SETUP\_REQ +- PDU\_RES\_SETUP\_RSP +- PDU\_RES\_SETUP\_FAIL +- PDU\_RES\_REL\_CMD +- PDU\_RES\_REL\_RSP +- PDU\_RES\_MOD\_REQ +- PDU\_RES\_MOD\_RSP +- PDU\_RES\_MOD\_FAIL +- PDU\_RES\_NTY +- PDU\_RES\_NTY\_REL +- PDU\_RES\_MOD\_IND +- PDU\_RES\_MOD\_CFM +- PATH\_SWITCH\_REQ +- PATH\_SWITCH\_SETUP\_FAIL +- PATH\_SWITCH\_REQ\_ACK +- PATH\_SWITCH\_REQ\_FAIL +- HANDOVER\_REQUIRED +- HANDOVER\_CMD +- HANDOVER\_PREP\_FAIL +- HANDOVER\_REQ\_ACK +- HANDOVER\_RES\_ALLOC\_FAIL +- SECONDARY\_RAT\_USAGE +- PDU\_RES\_MOD\_IND\_FAIL +- UE\_CONTEXT\_RESUME\_REQ +- UE\_CONTEXT\_RESUME\_RSP +- UE\_CONTEXT\_SUSPEND\_REQ + +MaxIntegrityProtectedDataRate: +anyOf: + +- type: string +enum: + - 64\_KBPS + - MAX\_UE\_RATE +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | +Maximum Integrity Protected Data Rate. Possible values are + +- 64\_KBPS +- MAX\_UE\_RATE + +MaReleaseIndication: +anyOf: + +- type: string +enum: + - REL\_MAPDU\_OVER\_3GPP + - REL\_MAPDU\_OVER\_N3GPP +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +description: | +Multi-Access PDU session release Indication. Possible values are + +- REL\_MAPDU\_OVER\_3GPP +- REL\_MAPDU\_OVER\_N3GPP + +SmContextType: +anyOf: + +``` +- type: string +enum: + - EPS_PDN_CONNECTION + - SM_CONTEXT + - AF_COORDINATION_INFO +- type: string +description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +description: | + Type of SM Context information. Possible values are + - EPS_PDN_CONNECTION + - SM_CONTEXT + - AF_COORDINATION_INFO + +PsaIndication: +anyOf: +- type: string +enum: + - PSA_INSERTED + - PSA_REMOVED + - PSA_INSERTED_ONLY + - PSA_REMOVED_ONLY +- type: string +description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +description: | + Indication of whether a PSA is inserted or removed. Possible values are + - PSA_INSERTED + - PSA_REMOVED + - PSA_INSERTED_ONLY + - PSA_REMOVED_ONLY + +N4MessageType: +anyOf: +- type: string +enum: + - PFCP_SES_EST_REQ + - PFCP_SES_EST_RSP + - PFCP_SES_MOD_REQ + - PFCP_SES_MOD_RSP + - PFCP_SES_DEL_REQ + - PFCP_SES_DEL_RSP + - PFCP_SES_REP_REQ + - PFCP_SES_REP_RSP +- type: string +description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +description: | + N4 Message Type. Possible values are + - PFCP_SES_EST_REQ + - PFCP_SES_EST_RSP + - PFCP_SES_MOD_REQ + - PFCP_SES_MOD_RSP + - PFCP_SES_DEL_REQ + - PFCP_SES_DEL_RSP + - PFCP_SES_REP_REQ + - PFCP_SES_REP_RSP + +QoSFlowAccessType: +anyOf: +- type: string +enum: + - 3GPP + - NON_3GPP + - 3GPP_AND_NON_3GPP +- type: string +description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +description: | + Access type associated with a QoS Flow. Possible values are +``` + +- 3GPP +- NON\_3GPP +- 3GPP\_AND\_NON\_3GPP + +UnavailableAccessIndication: +anyOf: +- type: string +enum: +- 3GA\_UNAVAILABLE +- N3GA\_UNAVAILABLE +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Indicates the access type of a MA PDU session that is unavailable. Possible values are +- 3GA\_UNAVAILABLE +- N3GA\_UNAVAILABLE + +ProtectionResult: +anyOf: +- type: string +enum: +- PERFORMED +- NOT\_PERFORMED +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Protection Result of the security policy indicated as "preferred". Possible values are +- PERFORMED +- NOT\_PERFORMED + +QosMonitoringReq: +anyOf: +- type: string +enum: +- UL +- DL +- BOTH +- NONE +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +QoS monitoring request. Possible values are +- UL +- DL +- BOTH +- NONE + +Rsn: +anyOf: +- type: string +enum: +- V1 +- V2 +- NONE +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. +description: | +Redundancy Sequence Number. Possible values are +- V1 +- V2 +- NONE + +SmfSelectionType: +anyOf: +- type: string +enum: + +``` + - CURRENT_PDU_SESSION + - NEXT_PDU_SESSION + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Smf Selection Type. Possible values are + - CURRENT_PDU_SESSION + - NEXT_PDU_SESSION + +PduSessionContextType: + anyOf: + - type: string + enum: + - AF_COORDINATION_INFO + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Type of PDU Session information. Possible values are + - AF_COORDINATION_INFO + +PendingUpdateInfo: + anyOf: + - type: string + enum: + - UE_LOCATION + - TIMEZONE + - ACCESS_TYPE + - RAT_TYPE + - AMF_ID + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Pending Update Information. Possible values are + - UE_LOCATION + - TIMEZONE + - ACCESS_TYPE + - RAT_TYPE + - AMF_ID + +EstablishmentRejectionCause: + anyOf: + - type: string + enum: + - OPERATOR_DETERMINED_BARRING + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + PDU Session Establishment Rejection Cause. Possible values are + - OPERATOR_DETERMINED_BARRING + +EcnMarkingReq: + anyOf: + - type: string + enum: + - UL + - DL + - BOTH + - STOP + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + ECN Marking Request Type. Possible values are + - UL +``` + +- DL +- BOTH +- STOP + +## CongestionInfoReq: + +## anyOf: + +- type: string + - enum: + - UL + - DL + - BOTH + - STOP +- type: string + - description: > + + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + - description: | + + +Congestion Information Request Type. Possible values are + + - UL + - DL + - BOTH + - STOP + +## ActivationStatus: + +## anyOf: + +- type: string + - enum: + - ACTIVE + - NOT\_ACTIVE +- type: string + - description: > + + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + - description: | + + +Activation Status. Possible values are + + - ACTIVE + - NOT\_ACTIVE + +# + +# HTTP request bodies + +# + +## requestBodies: + +## 'VsmfUpdateRequestBody': + +- description: representation of updates to apply to the PDU session +- required: true +- content: + - application/json: # message without binary body part + - schema: + - \$ref: '#/components/schemas/VsmfUpdateData' + - multipart/related: # message with binary body part(s) + - schema: + - type: object + - properties: # Request parts + - jsonData: + - \$ref: '#/components/schemas/VsmfUpdateData' + - binaryDataN1SmInfoToUe: + - type: string + - format: binary + - binaryDataN4Information: + - type: string + - format: binary + - binaryDataN4InformationExt1: + - type: string + - format: binary + - binaryDataN4InformationExt2: + - type: string + - format: binary + - binaryDataN4InformationExt3: + - type: string + - format: binary + - encoding: + - jsonData: + - contentType: application/json + - binaryDataN1SmInfoToUe: + - contentType: application/vnd.3gpp.5gnas + - headers: + +``` + + Content-Id: + schema: + type: string + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt3: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + +'NotifyStatusRequestBody': + description: representation of the status notification + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/StatusNotification' + +# +# HTTP responses +# +responses: + 'VsmfUpdateResponse200': + description: successful update of a PDU session with content in the response + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/VsmfUpdatedData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/VsmfUpdatedData' + binaryDataN1SmInfoFromUe: + type: string + format: binary + binaryDataUnknownN1SmInfo: + type: string + format: binary + binaryDataN4Information: + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + binaryDataN4InformationExt3: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoFromUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + +``` + +``` + + type: string + binaryDataUnknownN1SmInfo: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt3: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + +'PduSessionCreateError': + description: unsuccessful creation of a PDU session + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/PduSessionCreateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/PduSessionCreateError' + binaryDataN1SmInfoToUe: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoToUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + +'HsmfUpdateError': + description: unsuccessful update of a PDU session + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/HsmfUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/HsmfUpdateError' + binaryDataN1SmInfoToUe: + type: string + format: binary + +``` + +``` + +encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoToUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + +'VsmfUpdateError': + description: unsuccessful update of a PDU session + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/VsmfUpdateError' + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/VsmfUpdateError' + binaryDataN1SmInfoFromUe: + type: string + format: binary + binaryDataUnknownN1SmInfo: + type: string + format: binary + binaryDataN4Information: + type: string + format: binary + binaryDataN4InformationExt1: + type: string + format: binary + binaryDataN4InformationExt2: + type: string + format: binary + binaryDataN4InformationExt3: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN1SmInfoFromUe: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataUnknownN1SmInfo: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + binaryDataN4Information: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt1: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt2: + contentType: application/vnd.3gpp.pfcp + headers: + Content-Id: + schema: + type: string + binaryDataN4InformationExt3: + contentType: application/vnd.3gpp.pfcp + +``` + +``` +headers: + Content-Id: + schema: + type: string + +'400': + description: Bad request + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' +'401': + description: Unauthorized + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' +'403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' +'404': + description: Not Found + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' +'413': + description: Content Too Large + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' +'415': + description: Unsupported Media Type + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' +'429': + description: Too Many Requests + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' +'500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' +'502': + description: Bad Gateway + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' +'503': + description: Service Unavailable + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' +``` + +## Annex B (Informative): HTTP Multipart Messages + +### B.1 Example of HTTP multipart message + +#### B.1.1 General + +This clause provides a (partial) example of HTTP multipart message. The example does not aim to be a complete representation of the HTTP message, e.g. additional information or headers can be included. + +This Annex is informative and the normative descriptions in this specification prevail over the description in this Annex if there is any difference. + +#### B.1.2 Example HTTP multipart message with N1 SM Message binary data + +``` +POST /example.com/nsmf-pdusession/v1/sm-contexts HTTP/2 +Content-Type: multipart/related; type="application/json"; boundary=----Boundary +Content-Length: xyz + +-----Boundary +Content-Type: application/json + +{ + "supi": "imsi-", + "pduSessionId": 235, + "dnn": "", + "sNssai": { + "sst": 0 + }, + "servingNfId": "", + "n1SmMsg": { + "contentId": "nlmsg" + }, + "anType": "3GPP_ACCESS", + "smContextStatusUri": "" +} +-----Boundary +Content-Type: application/vnd.3gpp.5gnas +Content-Id: nlmsg + +{ ... N1 SM Message binary data ...} +-----Boundary +``` + +## Annex C (Normative): ABNF grammar for 3GPP SBI HTTP custom headers + +### C.1 General + +This Annex contains a self-contained set of ABNF rules, comprising the re-used rules from IETF RFCs, and the rules defined by the 3GPP custom headers defined in this specification (see clause 6.1.2.3). + +This grammar may be used as input to existing tools to help implementations to parse 3GPP custom headers. + +## C.2 ABNF definitions (Filename: "TS29502\_CustomHeaders.abnf") + +``` + +; ----- +; RFC 5234 +; ----- + +HTAB = %x09 ; horizontal tab + +SP = %x20 + +DIGIT = %x30-39 ; 0-9 + +; ----- +; RFC 9110 +; ----- + +OWS = *( SP / HTAB ) + +date1 = day SP month SP year ; e.g., 02 Jun 1982 + +day = 2DIGIT + +month = %x4A.61.6E ; "Jan", case-sensitive + / %x46.65.62 ; "Feb", case-sensitive + / %x4D.61.72 ; "Mar", case-sensitive + / %x41.70.72 ; "Apr", case-sensitive + / %x4D.61.79 ; "May", case-sensitive + / %x4A.75.6E ; "Jun", case-sensitive + / %x4A.75.6C ; "Jul", case-sensitive + / %x41.75.67 ; "Aug", case-sensitive + / %x53.65.70 ; "Sep", case-sensitive + / %x4F.63.74 ; "Oct", case-sensitive + / %x4E.6F.76 ; "Nov", case-sensitive + / %x44.65.63 ; "Dec", case-sensitive + +year = 4DIGIT + +day-name = %x4D.6F.6E ; Mon + / %x54.75.65 ; Tue + / %x57.65.64 ; Wed + / %x54.68.75 ; Thu + / %x46.72.69 ; Fri + / %x53.61.74 ; Sat + / %x53.75.6E ; Sun + +time-of-day = hour ":" minute ":" second + +hour = 2DIGIT + +minute = 2DIGIT + +second = 2DIGIT + +; ----- +; 3GPP TS 29.502 +; +; Version: 18.5.0 (December 2023) +; +; (c) 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +; ----- + +; +; Header: 3gpp-Sbi-Originating-Timestamp +; + +Sbi-Originating-Timestamp-Header = "3gpp-Sbi-Originating-Timestamp:" OWS day-name "," + SP date1 SP time-of-day "." milliseconds SP "GMT" OWS + +``` + +milliseconds + += 3DIGIT + +--- + +## Annex D (Informative): Charging Identifier Handling + +### D.1 Usage of Charging ID and SMF Charging ID + +#### D.1.1 General + +The Charging ID has been defined (from Rel-15 onwards) as a Uint32 value which is unique within one SMF (the V-SMF or H-SMF that assigns it). To avoid possible charging identifiers' collision in H-SMF for Home Routed PDU sessions, an SMF Charging ID has been defined (from Rel-18 onwards) as a string which contains the Uint32 value and the SMF NF Instance ID (see 3GPP TS 29.571 [13]). + +This clause summarizes the principles on using Charging ID and SMF Charging ID for HR PDU sessions, especially when not all the V-SMF(s) and H-SMF of a PDU session support the SMF Charging ID. + +This Annex is informative and the normative requirements in this specification or in other 3GPP specifications prevail over the description in this Annex if there is any difference. + +#### D.1.2 HPLMN supporting the SMF Charging ID + +An SMF, CHF and PCF complying with Rel-18 onwards support the SMF Charging ID. + +If the HPLMN (H-SMF, CHF and PCF) supports the SMF Charging ID, the H-SMF indicates support of the SCID (String based Charging Identifier) feature (in its NF Profile in NRF and towards the V-SMF). + +The HPLMN uses the SMF Charging ID as the charging identifier for the PDU session. + +If the VPLMN supports the SMF Charging ID: + +- The VPLMN uses the SMF Charging ID as the charging identifier for the PDU session. + +If the VPLMN does not support the SMF Charging ID (e.g. the V-SMF complies with a release earlier than Rel-18): + +- The VPLMN uses the Charging ID as the charging identifier for the PDU session. +- The VPLMN only provides the Charging ID to the H-SMF during the HR PDU session establishment. The H-SMF derives the SMF Charging ID using the received Charging ID and V-SMF Instance ID. + +#### D.1.3 HPLMN not supporting the SMF Charging ID + +When the HPLMN does not support the SMF Charging ID (e.g. the H-SMF complies with a release earlier than Rel-18), the charging identifier used by both the V-SMF and the H-SMF is the Charging ID. + +NOTE: This applies even if the V-SMF supports the SCID feature. + +#### D.1.4 Transfer of (SMF) Charging ID between SMFs + +The following principles applies to support mobility scenarios where the source and/or target (V-) SMF may or may not support the SCID feature: + +- During a HR PDU session establishment: + - the V-SMF provides the Charging ID to the H-SMF; and + +- the V-SMF additionally provides the SMF Charging ID if both the V-SMF and H-SMF support the SCID feature. + - During a V-SMF change or insertion: + - the Charging ID is passed from the source (V-)SMF to the target V-SMF; + - the SMF Charging ID is also passed from the source (V-)SMF to the target V-SMF, if it is available at the source (V-)SMF and both the source and target (V-)SMFs support the SCID feature; and + - the H-SMF provides the SMF Charging ID to the new V-SMF if both the H-SMF and the new V-SMF support the SCID feature. +- NOTE: This enables the SMF Charging ID to be used by the new V-SMF and H-SMF, when both the new V-SMF and H-SMF support the SCID feature but the source V-SMF does not support the SCID feature. +- During EPS to 5GS mobility: + - the H-SMF provides the Charging ID to the new V-SMF; and + - the H-SMF additionally provides the SMF Charging ID to the new V-SMF if both the H-SMF and the V-SMF support the SCID feature. + +--- + +## Annex E (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | CT4#80 | C4-175050 | | | | Initial Draft. | 0.1.0 | +| 2017-10 | CT4#80 | C4-175392 | | | | Inclusion of pCRs agreed during CT4#80. | 0.2.0 | +| 2017-12 | CT4#81 | C4-176435 | | | | Inclusion of pCRs agreed during CT4#81. | 0.3.0 | +| 2018-01 | CT4#82 | C4-181389 | | | | Inclusion of pCRs agreed during CT4#82. | 0.4.0 | +| 2018-03 | CT4#83 | C4-182432 | | | | Inclusion of pCRs agreed during CT4#83. | 0.5.0 | +| 2018-03 | CT#79 | CP-180030 | | | | Presented for information | 1.0.0 | +| 2018-04 | CT4#84 | C4-183514 | | | | Inclusion of pCRs agreed during CT4#84. | 1.1.0 | +| 2018-05 | CT4#85 | C4-184619 | | | | Inclusion of pCRs agreed during CT4#85. | 1.2.0 | +| 2018-06 | CT#80 | CP-181100 | | | | Presented for approval | 2.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | +| 2018-09 | CT#81 | CP-182055 | 0002 | | F | Corrections to missing application errors in API response body description | 15.1.0 | +| 2018-09 | CT#81 | CP-182068 | 0006 | | B | Add support for 5G Trace | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0007 | | F | Error Responses | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0015 | | F | Network Sharing | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0016 | | F | RAT Type in Create and Update (SM Context) service operations | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0001 | 1 | F | Application specific error cause for Not Acceptable Integrity Protection Max Data Rate | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0008 | 1 | F | EBI Assignment for Home Routed PDU sessions | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0010 | 1 | F | Returning the H-SMF URI to the AMF | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0014 | 1 | F | N2 SM signalling | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0017 | 1 | F | Supporting AMF changes | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0018 | 1 | F | VPLMN S-NSSAI during mobility from EPS to 5GC with N26 | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0009 | 2 | F | HTTP message retransmissions and requests colliding with existing contexts | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0029 | | F | Rejected PDU session during Xn handover | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0033 | | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0034 | | F | Handling of LADN service area during handovers | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0036 | | F | Mapping to stage 2 service operation names | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0039 | | F | Stateless AMF support updates | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0040 | | F | QoS rule structure improvement | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0020 | 1 | F | NRF URI for PCF Selection | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0022 | 1 | F | BackUp AMF Info | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0031 | 1 | F | NGAP causes | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0024 | 1 | F | EPS Interworking Ind | 15.1.0 | +| 2018-09 | CT#81 | CP-182050 | 0021 | 2 | F | References to common NonDynamic5Qi and Dynamic5Qi data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0025 | 1 | F | Not Allowed Slice | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0005 | 3 | F | N2 SM Information Type Definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0028 | 1 | F | OpenAPI corrections | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0032 | 1 | F | Age of User Location | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0037 | 1 | F | Detecting SMF Failure and Restart | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0041 | | F | PresenceState reference | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0030 | 2 | F | URIs of created SM context and PDU session resources | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0023 | 2 | F | 5G MM Cause | 15.1.0 | +| 2018-09 | CT#81 | CP-182055 | 0042 | | F | API version number update | 15.1.0 | +| 2018-12 | CT#82 | CP-183013 | 0044 | 2 | F | IndDirect Forwarding Flag | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0045 | 1 | F | Data Forwarding IE | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0047 | | F | Alignments with NAS 5GS Session Management | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0048 | 1 | F | Alignments with NGAP | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0049 | | F | Corrections to N2 Handover and Inter-AMF change or mobility procedures | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0050 | 2 | F | Indication of Access Type can be changed | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0051 | | F | Roaming Charging Profile negotiation for Home Routed PDU sessions | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0052 | | F | Service restart detection by direct signalling between NFs | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0053 | | F | Use of the serviceName attribute by the Notify SM Context Status service operation | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0054 | | F | Cardinality of arrays | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0055 | | F | Data type of serviceName attribute | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0056 | | F | HTTP status code "501 Not Implemented" | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0057 | | F | Case conventions | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0058 | | F | Resource URI structure of Nsmf_PDUSession service | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0059 | | F | EPS bearer identity and data type definitions | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0060 | 3 | F | EPC Interworking in Home Routed Roaming | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0061 | 1 | F | Correction to EPS Interworking Indication | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0063 | | F | Presence condition of targetServingNfId | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0064 | 2 | F | PDU session removal during interworking with N26 | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0067 | 1 | F | Complete the SSC mode 3 in the home routed roaming scenario | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0068 | 2 | F | Clarification on EBI allocation | 15.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|------------------------------------------------------------------------------------------------------------------------|--------| +| 2018-12 | CT#82 | CP-183013 | 0069 | 1 | F | Correct description of Request type | 15.2.0 | +| 2018-12 | CT#82 | CP-183190 | 0071 | 3 | F | PDU Session Id Duplication | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0072 | 1 | F | Service Instance | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0075 | 2 | F | A new cause value 'PDU_Session_Status_Mismatch' for Cause Data Type | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0076 | 2 | F | UDM group Id | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0077 | 2 | F | Always-on PDU sessions | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0078 | 2 | F | Handover Failure scenarios | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0079 | | F | Release of PDU session during 5GS to EPS mobility | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0080 | 1 | F | Mandatory HTTP status codes | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0081 | 1 | F | Clarification of API URI definition | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0082 | | F | API version | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0083 | | F | externalDocs field in OpenAPI document | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0084 | | F | Location Header | 15.2.0 | +| 2018-12 | CT#82 | CP-183169 | 0085 | 1 | F | Regular Expression Patterns | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0086 | | F | Correct reference of EPS to 5GS handover | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0087 | | F | Secondary RAT usage data reporting | 15.2.0 | +| 2018-12 | CT#82 | CP-183013 | 0088 | 1 | F | OAuth2 requirements | 15.2.0 | +| 2018-12 | CT#82 | CP-183081 | 0089 | | F | SMF Network Function Instance | 15.2.0 | +| 2018-12 | | | | | | MaxIntegrityProtectedDataRate spare quote fixed in yaml-file | 15.2.1 | +| 2019-03 | CT#83 | CP-190018 | 0090 | | F | OpenAPI correction | 15.3.0 | +| 2019-03 | CT#83 | CP-190018 | 0091 | 1 | F | Secondary RAT usage reporting | 15.3.0 | +| 2019-03 | CT#83 | CP-190018 | 0092 | 1 | F | Target ID during inter NG-RAN node N2 based handover and EPS to 5GS Handover | 15.3.0 | +| 2019-03 | CT#83 | CP-190018 | 0093 | | F | Indirect data forwarding timer | 15.3.0 | +| 2019-03 | CT#83 | CP-190018 | 0095 | | F | API version update | 15.3.0 | +| 2019-03 | CT#83 | CP-190018 | 0096 | 2 | F | Clarification on the use of pduSessionsActivateList during EPS to 5GS Idle Mode Mobility Procedure. | 15.3.0 | +| 2019-03 | CT#83 | CP-190018 | 0097 | | F | Cause information | 15.3.0 | +| 2019-03 | CT#83 | CP-190018 | 0098 | 2 | F | Update ReleaseSMContext Service Operation Description for PDU Session Release due to Change of Set of Network Slices | 15.3.0 | +| 2019-03 | CT#83 | CP-190018 | 0099 | 1 | F | Trigger Conditions for SMContext Update | 15.3.0 | +| 2019-03 | CT#83 | CP-190018 | 0100 | 1 | F | Trigger Conditions for SMContext Release | 15.3.0 | +| 2019-03 | CT#83 | CP-190018 | 0102 | 1 | F | Status Notify for HO | 15.3.0 | +| 2019-03 | CT#83 | CP-190018 | 0103 | 1 | F | Provide Resource URI before PDU Session Creation Response | 15.3.0 | +| 2019-03 | CT#83 | CP-190018 | 0104 | 1 | F | Allocated EBIs during EPS to 5GS Preparation with N26 | 15.3.0 | +| 2019-06 | CT#84 | CP-191029 | 0106 | 1 | F | Change of access type in home routed roaming scenario | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0107 | 1 | F | EPS bearer synchronization upon EPS to 5GS idle mode mobility using N26 | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0109 | | F | Removing multiple redundant appearances of major version number | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0112 | 1 | F | Application Error "S-NSSAI_CONGESTION" | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0113 | 3 | F | Clarification on Sending SMContextStatusNotify | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0117 | 1 | F | Essential Correction of HPLMN SNSSAI during SM Context Creation | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0118 | 2 | F | Handover Preparation Failure | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0129 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0133 | 2 | F | Location header in redirect response | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0135 | 2 | F | Correct Nsmf_PDUSession_Create to support Mobility Restriction | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0139 | 1 | F | Correction of Procedure of Handover using UpdateSmContext | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0141 | 1 | F | Secondary RAT Usage reporting at PDU session level | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0142 | | F | Mapped EPS bearer contexts in n1SmInfoFromUe | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0143 | 1 | F | Target ID sent to the SMF | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0144 | | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0145 | 1 | F | Correction on GPSI for PDU session | 15.4.0 | +| 2019-06 | CT#84 | CP-191029 | 0148 | | F | 3GPP TS 29.502 API version update | 15.4.0 | +| 2019-06 | CT#84 | CP-191048 | 0147 | | B | 3GPP TS 29.502 API version update | 16.0.0 | +| 2019-06 | CT#84 | CP-191049 | 0116 | 4 | F | Updates to CreateSMContext for eNS Support | 16.0.0 | +| 2019-06 | CT#84 | | | | B | PDU Session Establishment support Control Plane CIO T Optimization | 16.0.0 | +| 2019-06 | | CP-191050 | 0130 | 4 | | | | +| 2019-06 | CT#84 | CP-191051 | 0115 | 2 | B | ATSSS: MA-PDU Session Establishment | 16.0.0 | +| 2019-06 | CT#84 | CP-191051 | 0136 | 2 | B | MA PDU Session Update | 16.0.0 | +| 2019-06 | CT#84 | CP-191051 | 0137 | 5 | B | MA PDU Session Release over a Single Access | 16.0.0 | +| 2019-06 | CT#84 | CP-191054 | 0108 | 1 | B | Updates to reference model for ETSUN | 16.0.0 | +| 2019-06 | CT#84 | | | | B | Update SM context service operation for additional PDU Session Anchor and Branching Point or UL CL controlled by I-SMF | 16.0.0 | +| 2019-06 | | CP-191054 | 0124 | 1 | | | | +| 2019-06 | CT#84 | | | | B | Update Retrieve SM Context service operation from Source I-SMF or SMF | 16.0.0 | +| 2019-06 | | CP-191054 | 0123 | 2 | | | | +| 2019-06 | CT#84 | CP-191054 | 0110 | 2 | B | SM context transfer between I-SMFs or V-SMFs | 16.0.0 | +| 2019-06 | CT#84 | | | | B | Update Release SM Context service operation for I-SMF change and removal | 16.0.0 | +| 2019-06 | | CP-191054 | 0122 | 2 | | | | +| 2019-06 | CT#84 | | | | B | Update Create SM context service operation for the I-SMF insertion and change | 16.0.0 | +| 2019-06 | | CP-191054 | 0121 | 6 | | | | +| 2019-06 | CT#84 | CP-191054 | 0134 | 3 | B | Update Create SM context service operation for the I-SMF insertion | 16.0.0 | + +| | | | | | | | | +|--|--|--|--|--|--|------------|--| +| | | | | | | and change | | +|--|--|--|--|--|--|------------|--| + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-------------------------------------------------------------------------------------------|--------| +| 2019-06 | CT#84 | CP-191059 | 0140 | 1 | F | EPS Interworking Indication for N3GPP | 16.0.0 | +| 2019-06 | CT#84 | CP-191059 | 0131 | 3 | F | Exemption Indication | 16.0.0 | +| 2019-09 | CT#85 | CP-192193 | 0149 | 3 | B | I-SMF insertion implications on Nsmf_PDUSession_Update across N16a | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0151 | 3 | B | Implications of Policy Update Procedures with I-SMF on Nsmf_PDUSession_Update across N16a | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0153 | 1 | B | Implications of I-SMF insertion on Create service operation | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0154 | | B | PDU session establishment with I-SMF insertion - Create SM Context service operation | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0155 | 1 | B | Transfer of NAS SM Information between I-SMF and SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0156 | | B | Updates to resources model and operations for PDU sessions with an I-SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0157 | | B | Release of a PDU session with an I-SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0158 | | B | Notify status of a PDU session with an I-SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0159 | | B | Update of a PDU session with an I-SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192029 | 0160 | | B | Insertion of a PSA and UL CL/BP into the data path of a PDU session with an I-SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0161 | 1 | B | Removal of a PSA and UL CL/BP from the data path of a PDU session with an I-SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0162 | 1 | B | Change of a PSA for IPv6 multi-homing or UL CL controlled by I-SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0163 | 1 | B | N4 notifications for traffic usage reporting from I-SMF to SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0164 | | B | Service Request with I-SMF insertion/change/removal or with V-SMF change | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0165 | | B | Retrieve SM Context Request to or from SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0166 | | B | N26 based interworking with I-SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0168 | 3 | B | End Marker indication during Xn/N2 handover for HR roaming and for I-SMF insertion | 16.1.0 | +| 2019-09 | CT#85 | CP-192194 | 0169 | 1 | B | SMF selection with Delegated Discovery | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0171 | 1 | B | PDUSession_CreateSMContext - Parameters Updating | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0172 | 1 | B | ReleaseSMContext - I-SMF Only Indication | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0173 | 1 | B | PDUSession_UpdateSMContext - N3/N9 Forwarding Tunnel Info | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0174 | 1 | B | Missing "UE presence in LADN service area" attribute | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0175 | 2 | B | Missing "Secondary RAT usage data" attributes | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0177 | 1 | F | Correction to Retrieve SM Context service operation during N2 based HO | 16.1.0 | +| 2019-09 | CT#85 | CP-192102 | 0179 | 2 | A | N2 Handover Preparation Failure | 16.1.0 | +| 2019-09 | CT#85 | CP-192102 | 0181 | | A | Release of Indirect Data Forwarding Tunnels during 5GS to EPS handover | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0182 | | B | Handling of requests which collide with an existing SM context / PDU session context | 16.1.0 | +| 2019-09 | CT#85 | CP-192128 | 0183 | | F | Deactivation of the User Plane connection during handover procedure | 16.1.0 | +| 2019-09 | CT#85 | CP-192134 | 0184 | 1 | B | Clarification on Additional Access Type | 16.1.0 | +| 2019-09 | CT#85 | CP-192134 | 0185 | 1 | B | Indications for MA PDU Session | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0186 | 1 | B | Item 14 - Update reference to stage 2 procedure for I-SMF insertion, change, removal | 16.1.0 | +| 2019-09 | CT#85 | CP-192133 | 0187 | | B | Serving Network Identifier for Stand-alone Non-Public Networks | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0188 | 1 | B | ETSUN_Create service operation for buffered data forwarding | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0189 | 1 | B | ETSUN_SM Context Request with buffered data forwarding | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0190 | 1 | B | ETSUN_Update Service Operation with I-V-SMF change | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0191 | 1 | B | ETSUN_Update SM Context for buffered data forwarding | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0192 | 4 | B | Missing attributes in SM Context | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0194 | 2 | B | ETSUN alignments to ReleaseSMContext service operation | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0195 | 2 | B | ETSUN alignments to RetrieveSMContext service operation | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0198 | 1 | B | Small Data Rate Control Status during PDU session establishment | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0199 | | F | CRLF between Header fields and Data | 16.1.0 | +| 2019-09 | CT#85 | CP-192120 | 0201 | | F | 3GPP TS 29.502 API version update | 16.1.0 | +| 2019-10 | | | | | | Corrupted references corrected | 16.1.1 | +| 2019-12 | CT#86 | CP-193057 | 0202 | 1 | F | Delegated discovery parameter mapping in stage 3 | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0203 | | B | N4 information in Update Request / Response | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0204 | 1 | B | Indirect data forwarding tunnels for N2 handover with I-SMF | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0205 | | B | Contents of Sm context in SmContextRetrievedData | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0206 | 1 | B | MA PDU session Accepted indication | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0207 | 1 | B | Establishment of N9 tunnel per access network for a MA PDU session | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0209 | | B | ATSSS container: ATSSS rules, Measurement Assistance Info, Network Steering Info | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0210 | 1 | F | Forwarding of Origination Time Stamp to PCF | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0211 | 1 | B | Connection suspend | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0212 | 2 | B | Connection resume | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0213 | 1 | B | MA PDU Network Upgrade Allowed indication | 16.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|--------------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193051 | 0215 | 2 | B | Access Type Associated with QoS Flow | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0217 | 1 | B | Update Description for I-SMF Scenario | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0218 | 1 | B | Delegated Discovery Parameters Conveyance in HTTP/2 Headers | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0220 | 2 | B | Serving PLMN Rate Control | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0222 | 1 | B | APN Rate Control attribute during PDU Session Establishment across N11 and N16 | 16.2.0 | +| 2019-12 | CT#86 | CP-193128 | 0223 | 4 | B | Adding Rate Control attributes to the Release operations | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0224 | 2 | B | Adding Rate Control attributes to the Update operations | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0226 | | F | smContextRef attribute in SmContextCreateData | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0227 | | B | Control Plane Only Indicator | 16.2.0 | +| 2019-12 | CT#86 | CP-193168 | 0228 | 2 | B | Mobile Originated Data Transfer for Control Plane CIoT 5GS Optimisation | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0230 | 1 | B | Secondary RAT Data Usage Report | 16.2.0 | +| 2019-12 | CT#86 | CP-193051 | 0231 | 1 | B | MA PDU request indication | 16.2.0 | +| 2019-12 | CT#86 | CP-193129 | 0232 | 4 | B | SMF derived CN assisted RAN parameters turning | 16.2.0 | +| 2019-12 | CT#86 | CP-193026 | 0234 | 1 | A | Secondary RAT Data Usage Report | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0235 | 1 | F | Add Reference to 3GPP TS 29.524 | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0236 | 3 | B | SM Transfer indication | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0237 | 2 | B | SM Context Transfer between SMFs | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0238 | 1 | F | Clarification to the buffered data handling in PduSessionCreateData | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0241 | 2 | B | Missing DNAI list across N16a | 16.2.0 | +| 2019-12 | CT#86 | CP-193061 | 0243 | 2 | B | PDU Session Release due to SRVCC | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0244 | 1 | F | Editorial Correction | 16.2.0 | +| 2019-12 | CT#86 | CP-193044 | 0246 | | F | 3GPP TS 29.502 API version update | 16.2.0 | +| 2020-03 | CT#87 | CP-200039 | 0247 | 2 | F | Add Corresponding API descriptions in clause 5.1 | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0248 | 3 | F | PCF Set ID and PCF Group ID | 16.3.0 | +| 2020-03 | CT#87 | CP-200035 | 0249 | 3 | B | N3 terminations of W-AGF, TNGF and TWIF for UPF selection | 16.3.0 | +| 2020-03 | CT#87 | CP-200035 | 0250 | 2 | B | Adding references to stage 2 procedures for wireline access | 16.3.0 | +| 2020-03 | CT#87 | CP-200042 | 0251 | 4 | F | Clarification to 3GPP vendor specific content subtypes | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0252 | 2 | F | Clarification to apnRateStatus attribute description | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0253 | 2 | F | Editor's note related to change of PSA | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0254 | 2 | F | Handover between ePDG/EPS to 5GS with I-SMF insertion or removal | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0255 | 2 | F | Missing DTSSA applicability | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0256 | 3 | F | Feature negotiation extension to support change of AMF, V-SMF or I-SMF | 16.3.0 | +| 2020-03 | CT#87 | CP-200031 | 0257 | 2 | B | Reporting that an access of a MA PDU session is unavailable | 16.3.0 | +| 2020-03 | CT#87 | CP-200031 | 0258 | 3 | B | Request Type parameter of a MA-PDU session | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0259 | 2 | B | Scope and Services offered by SMF | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0260 | 3 | F | DNN encoding in SMF PDUSession API | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0261 | 3 | B | Home Provided Charging ID and Roaming Charging Profile | 16.3.0 | +| 2020-03 | CT#87 | CP-200039 | 0262 | 2 | F | Correction - formatting consistency | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0263 | 2 | B | Corrections on the descriptions for the data types related to I-SMF | 16.3.0 | +| 2020-03 | CT#87 | CP-200031 | 0264 | | F | maNwUpgradeInd in PduSessionCreateData | 16.3.0 | +| 2020-03 | CT#87 | CP-200031 | 0265 | | F | anType in TunnelInfo | 16.3.0 | +| 2020-03 | CT#87 | CP-200042 | 0266 | | F | Void a non-existent clause | 16.3.0 | +| 2020-03 | CT#87 | CP-200042 | 0268 | | B | PDU Session Release Due to UE Subscription Change | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0269 | 1 | B | DNAI list | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0270 | 1 | B | End Marker Indication | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0271 | 1 | B | hoCompleteIndication in 5GS to EPS handover | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0272 | | B | Notify Ipv6MultiHomingInd during I-SMF change procedure | 16.3.0 | +| 2020-03 | CT#87 | CP-200055 | 0273 | 1 | A | Linked EPS Bearer ID | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0274 | 1 | B | qosRules in SM Context | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0275 | 1 | B | Definition of smContextRef and Target ID | 16.3.0 | +| 2020-03 | CT#87 | CP-200053 | 0276 | 1 | A | EPS bearer ID correction | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0277 | 1 | F | Support 504 error code in retrieve SM Context service operation | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0278 | 1 | B | Support PDN type Ethernet at 5GS to EPS mobility with N26 | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0290 | 2 | B | UPF Instance ID | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0292 | 1 | F | Handover Cancel | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0293 | 1 | B | MO Data Transfer N16 | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0294 | 1 | B | MO Exception Data Delivery CP CIOT | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0295 | 1 | B | MO Exception Data Delivery UP CIOT | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0296 | 1 | B | MT Data Transfer N16 | 16.3.0 | +| 2020-03 | CT#87 | CP-200042 | 0297 | 1 | F | VPLMN QoS | 16.3.0 | +| 2020-03 | CT#87 | CP-200042 | 0298 | | F | Multi-part message example | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0299 | 1 | B | NEF Extended Buffering Supporting Indication | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0300 | | F | Removal of Serving PLMN Rate Control | 16.3.0 | +| 2020-03 | CT#87 | CP-200034 | 0301 | 2 | C | New cause value for NSSAA failure and revocation | 16.3.0 | +| 2020-03 | CT#87 | CP-200138 | 0302 | 4 | F | Preventing PDU Session release when handover between 3GPP and non-3GPP fails | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0303 | 1 | B | EBI list not to be transferred | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0304 | | F | V-SMF insertion or removal | 16.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|----------------------------------------------------------------------------------|--------| +| 2020-03 | CT#87 | CP-200033 | 0305 | 1 | B | Extended NAS-SM timer indication for UEs using CE mode B | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0306 | | F | Feature definition for support of C IoT features | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0307 | | B | Idle mode mobility between EPS and 5GS with data forwarding | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0308 | | F | Mobile Originated Data | 16.3.0 | +| 2020-03 | CT#87 | CP-200033 | 0309 | 2 | B | Availability after DDN Failure | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0310 | | F | Clarification to N4Information type | 16.3.0 | +| 2020-03 | CT#87 | CP-200052 | 0314 | | F | 3GPP TS 29.502 Rel16 API version and External doc update | 16.3.0 | +| 2020-07 | CT#88 | CP-201018 | 0316 | 1 | F | Integrity protection maximum data rate in Create Request/Response | 16.4.0 | +| 2020-07 | CT#88 | CP-201046 | 0317 | | F | Correction to the Resource URI structure | 16.4.0 | +| 2020-07 | CT#88 | CP-201046 | 0319 | 2 | B | Retrieval of Rate Control Status over N16/N16a | 16.4.0 | +| 2020-07 | CT#88 | CP-201055 | 0320 | | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-07 | CT#88 | CP-201031 | 0321 | 1 | F | URI of the Nsmf_PDUSession service | 16.4.0 | +| 2020-07 | CT#88 | CP-201031 | 0322 | | F | V-SMF and I-SMF service instance Id | 16.4.0 | +| 2020-07 | CT#88 | CP-201055 | 0323 | 1 | F | Supported Headers Tables for Response types 2xx and 3xx | 16.4.0 | +| 2020-07 | CT#88 | CP-201055 | 0324 | 1 | F | Binary Data Types Table | 16.4.0 | +| 2020-07 | CT#88 | CP-201046 | 0325 | 1 | F | Maximum UP resources activation of 2 PDU sessions | 16.4.0 | +| 2020-07 | CT#88 | CP-201055 | 0326 | 1 | F | RAN Initiated QoS Flow Mobility failure scenario | 16.4.0 | +| 2020-07 | CT#88 | CP-201031 | 0327 | 2 | F | PDU Session Resource Notify Released Transfer | 16.4.0 | +| 2020-07 | CT#88 | CP-201031 | 0328 | 1 | F | Security Result | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0329 | 1 | F | sNSSAI during EPS to 5GS interworking | 16.4.0 | +| 2020-07 | CT#88 | CP-201048 | 0332 | 1 | F | Stage 2 procedures for wireline access | 16.4.0 | +| 2020-07 | CT#88 | CP-201044 | 0333 | 1 | B | Inform SMF that UE deregisters from one access | 16.4.0 | +| 2020-07 | CT#88 | CP-201046 | 0334 | 2 | B | Notification Correlation ID related to event Availability after DDN Failure | 16.4.0 | +| 2020-07 | CT#88 | CP-201018 | 0335 | 2 | F | Binary IE Encoding | 16.4.0 | +| 2020-07 | CT#88 | CP-201044 | 0336 | 1 | F | MAPDU via Non-3GPP Access | 16.4.0 | +| 2020-07 | CT#88 | CP-201031 | 0337 | 1 | F | SM Context Transfer | 16.4.0 | +| 2020-07 | CT#88 | CP-201055 | 0338 | 1 | F | Data type column in Resource URI variables Table | 16.4.0 | +| 2020-07 | CT#88 | CP-201068 | 0339 | 1 | B | Inter-system handover with direct data forwarding | 16.4.0 | +| 2020-07 | CT#88 | CP-201031 | 0340 | | F | Registration with I-SMF insertion/change/removal and UP connection establishment | 16.4.0 | +| 2020-07 | CT#88 | CP-201055 | 0341 | 1 | F | Add custom operation Name | 16.4.0 | +| 2020-07 | CT#88 | CP-201047 | 0342 | 2 | F | Implicit PDU Session Release | 16.4.0 | +| 2020-07 | CT#88 | CP-201046 | 0343 | 3 | F | Aligning "MO Exception data" handling with stage 2 - NEF | 16.4.0 | +| 2020-07 | CT#88 | CP-201044 | 0344 | 1 | F | MA-PDU Session Release | 16.4.0 | +| 2020-07 | CT#88 | CP-201202 | 0345 | 2 | F | N4 information exchanged over N16a during PDU session release | 16.4.0 | +| 2020-07 | CT#88 | CP-201044 | 0346 | 1 | F | MA PDU Session re-activation | 16.4.0 | +| 2020-07 | CT#88 | CP-201037 | 0347 | 1 | B | Alternative QoS Profiles | 16.4.0 | +| 2020-07 | CT#88 | CP-201031 | 0348 | 1 | F | Missing N2 SM Info in SmContextCreateError | 16.4.0 | +| 2020-07 | CT#88 | CP-201037 | 0349 | 1 | B | QoS Monitoring Request to NG-RAN | 16.4.0 | +| 2020-07 | CT#88 | CP-201031 | 0350 | 1 | F | Application errors from I-SMF to SMF | 16.4.0 | +| 2020-07 | CT#88 | CP-201031 | 0351 | 1 | F | PduSessionCreatedData from SMF to I-SMF | 16.4.0 | +| 2020-07 | CT#88 | CP-201031 | 0352 | 1 | F | RequestIndication | 16.4.0 | +| 2020-07 | CT#88 | CP-201031 | 0353 | | F | URIs in SmContextCreatedData | 16.4.0 | +| 2020-07 | CT#88 | CP-201055 | 0355 | 1 | F | Selected DNN | 16.4.0 | +| 2020-07 | CT#88 | CP-201055 | 0356 | 1 | F | Error Handling in Nsmf_PDUSession Service | 16.4.0 | +| 2020-07 | CT#88 | CP-201046 | 0357 | 1 | F | Clarification on CP Only Indication related issue in Update SM Context service | 16.4.0 | +| 2020-07 | CT#88 | CP-201044 | 0360 | | F | EPSInterworkingInd for MA PDU without N26 | 16.4.0 | +| 2020-07 | CT#88 | CP-201018 | 0361 | 1 | A | TEID encoding clarification | 16.4.0 | +| 2020-07 | CT#88 | CP-201073 | 0365 | | F | 29.502 Rel16 API version and External doc update | 16.4.0 | +| 2020-09 | CT#89 | CP-202104 | 0366 | 1 | F | Release PDU Session if NSSAA Re-Authentication and Re-Authorization Fails | 16.5.0 | +| 2020-09 | CT#89 | CP-202114 | 0367 | 2 | F | Correct the Condition of upCnxState in SmContextCreateData | 16.5.0 | +| 2020-09 | CT#89 | CP-202114 | 0368 | 2 | F | PDU session deactivation | 16.5.0 | +| 2020-09 | CT#89 | CP-202092 | 0369 | 3 | F | Callback URI correction | 16.5.0 | +| 2020-09 | CT#89 | CP-202092 | 0370 | 2 | F | Request Type | 16.5.0 | +| 2020-09 | CT#89 | CP-202107 | 0371 | 1 | F | QoS Monitoring | 16.5.0 | +| 2020-09 | CT#89 | CP-202016 | 0373 | 2 | F | Error handling for PDU sessions with an I-SMF or V-SMF | 16.5.0 | +| 2020-09 | CT#89 | CP-202107 | 0374 | | F | Indicating that NG-RAN cannot fulfil the least preferred Alternative QoS Profile | 16.5.0 | +| 2020-09 | CT#89 | CP-202092 | 0375 | 1 | F | Handover Cancel 5GS to EPS | 16.5.0 | +| 2020-09 | CT#89 | CP-202114 | 0376 | 2 | F | QoS Rules during I-SMF and V-SMF Insertion | 16.5.0 | +| 2020-09 | CT#89 | CP-202092 | 0377 | 1 | F | Service Access Authorization between SMFs | 16.5.0 | +| 2020-09 | CT#89 | CP-202206 | 0381 | 2 | F | H-SMF/SMF sending IPv6 Interface Identifier to V-SMF/I-SMF | 16.5.0 | +| 2020-09 | CT#89 | CP-202096 | 0383 | | F | 29.502 Rel-16 API version and External doc update | 16.5.0 | +| 2020-12 | CT#90 | CP-203072 | 0385 | 2 | F | HTTP 3xx redirection | 16.6.0 | +| 2020-12 | CT#90 | CP-203048 | 0386 | | F | Storage of YAML files in 3GPP Forge | 16.6.0 | +| 2020-12 | CT#90 | CP-203046 | 0387 | 1 | F | QoS monitoring of a PDU session based on GTP-U path monitoring | 16.6.0 | +| 2020-12 | CT#90 | CP-203082 | 0390 | 2 | F | Binding Information for the old V/I-SMF and SMF | 16.6.0 | +| 2020-12 | CT#90 | CP-203083 | 0391 | 3 | F | Remote NF is not reachable | 16.6.0 | +| 2020-12 | CT#90 | CP-203041 | 0392 | 2 | F | Service operations invoked in DDN Failure event | 16.6.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|----------------------------------------------------------------------------------------------|--------| +| 2020-12 | CT#90 | CP-203029 | 0394 | 1 | F | EBI and ARP mapping update | 16.6.0 | +| 2020-12 | CT#90 | CP-203046 | 0395 | 1 | F | QoS Monitoring Reporting Frequency | 16.6.0 | +| 2020-12 | CT#90 | CP-203051 | 0396 | 1 | F | Correction on H-PCF | 16.6.0 | +| 2020-12 | CT#90 | CP-203051 | 0397 | 1 | F | IPv6 Index for I-SMF | 16.6.0 | +| 2020-12 | CT#90 | CP-203029 | 0398 | | F | VPLMN QoS Constraints | 16.6.0 | +| 2020-12 | CT#90 | CP-203036 | 0401 | | F | 29.502 Rel16 API version and External doc update | 16.6.0 | +| 2021-03 | CT#91 | | | | F | Handover Failure during EPS to 5GS Handover with AMF Re-allocation | 16.7.0 | +| | | CP-210049 | 0404 | 2 | | | | +| 2021-03 | CT#91 | CP-210045 | 0405 | 1 | F | Stop of QoS Monitoring | 16.7.0 | +| 2021-03 | CT#91 | CP-210037 | 0408 | 1 | F | Error Responses for Indirect Communication | 16.7.0 | +| 2021-03 | CT#91 | CP-210040 | 0409 | | F | Charging ID of HR PDU session upon V-SMF change | 16.7.0 | +| 2021-03 | CT#91 | | | | F | Handover between 3GPP and non-3GPP accesses with I-SMF insertion/removal or V-SMF change | 16.7.0 | +| | | CP-210040 | 0410 | | | | | +| 2021-03 | CT#91 | | | | F | Redundancy Sequence Number for Dual Connectivity based end to end Redundant User Plane Paths | 16.7.0 | +| | | CP-210167 | 0411 | 2 | | | | +| 2021-03 | CT#91 | | | | F | QoS parameters handling during handover between 3GPP and non-3GPP accesses | 16.7.0 | +| | | CP-210166 | 0413 | 2 | | | | +| 2021-03 | CT#91 | CP-210040 | 0415 | 1 | F | DNNs in I-SMF | 16.7.0 | +| 2021-03 | CT#91 | CP-210040 | 0416 | 1 | F | I-SMF&V-SMF Release Only | 16.7.0 | +| 2021-03 | CT#91 | CP-210060 | 0417 | | F | Incomplete CR Implementation | 16.7.0 | +| 2021-03 | CT#91 | CP-210040 | 0422 | | F | requestIndication for EBI revocation | 16.7.0 | +| 2021-03 | CT#91 | CP-210060 | 0423 | 2 | F | Alternative Anchor SMF Notification to AMF | 16.7.0 | +| 2021-03 | CT#91 | CP-210054 | 0425 | | F | 29.502 Rel-16 API version and External doc update | 16.7.0 | +| 2021-03 | CT#91 | CP-210165 | 0407 | 1 | F | Data Types Descriptions | 17.0.0 | +| 2021-03 | CT#91 | | | | | Home Network Public Key identifier as additional input for SMF service | 17.0.0 | +| | | CP-210021 | 0414 | 2 | B | | | +| 2021-03 | CT#91 | CP-210034 | 0418 | 2 | B | UPF ID for N4 Information | 17.0.0 | +| 2021-03 | CT#91 | CP-210021 | 0419 | | F | Correction to apiVersion placeholder | 17.0.0 | +| 2021-03 | CT#91 | CP-210034 | 0421 | 1 | F | EpsInterworkingIndication Update | 17.0.0 | +| 2021-03 | CT#91 | CP-210029 | 0424 | | F | 29.502 Rel-17 API version and External doc update | 17.0.0 | +| 2021-06 | CT#92 | CP-211025 | 0427 | | B | Support of Notify Start Pause of Charging via User Plane | 17.1.0 | +| 2021-06 | CT#92 | | 0428 | 1 | B | Adding samePcfSelectionIndication in Nsmf_PDUSession service to support SPSFAS | 17.1.0 | +| | | CP-211022 | | | | | | +| 2021-06 | CT#92 | CP-211059 | 0430 | 3 | A | Notify PDU session control is taken over by another SMF | 17.1.0 | +| 2021-06 | CT#92 | CP-211031 | 0431 | 1 | B | (I-)SMF discovery based on DNAI | 17.1.0 | +| 2021-06 | CT#92 | CP-211023 | 0432 | 1 | F | hNRF from NSSF in home PLMN | 17.1.0 | +| 2021-06 | CT#92 | CP-211120 | 0433 | 1 | F | OpenAPI Reference | 17.1.0 | +| 2021-06 | CT#92 | | 0435 | 1 | F | Simultaneous change of Branching Point or UL CL and additional PSA | 17.1.0 | +| | | CP-211046 | | | | | | +| 2021-06 | CT#92 | CP-211082 | 0437 | 1 | A | DNN Selection Mode | 17.1.0 | +| 2021-06 | CT#92 | CP-211062 | 0439 | 1 | A | AMF ID in HsmfUpdateData | 17.1.0 | +| 2021-06 | CT#92 | | | | | NG-RAN tunnel information during mobility registration with I-SMF/V-SMF change | 17.1.0 | +| | | CP-211068 | 0441 | 3 | A | | | +| 2021-06 | CT#92 | CP-211054 | 0442 | 1 | F | Correction on SmContextUpdateData | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0443 | 2 | F | Secondary authorization/authentication by an DN-AAA | 17.1.0 | +| 2021-06 | CT#92 | CP-211049 | 0444 | 2 | B | I-SMF/V-SMF Restoration procedure | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0445 | 1 | F | Data forwarding during 5GS to EPS handover | 17.1.0 | +| 2021-06 | CT#92 | CP-211059 | 0446 | 1 | A | Redirect Responses | 17.1.0 | +| 2021-06 | CT#92 | CP-211059 | 0448 | | A | 3xx description correction for SCP | 17.1.0 | +| 2021-06 | CT#92 | CP-211082 | 0453 | 1 | A | User location included in session management messages | 17.1.0 | +| 2021-06 | CT#92 | CP-211082 | 0455 | | A | Missing Procedure | 17.1.0 | +| 2021-06 | CT#92 | CP-211050 | 0456 | | F | 29.502 Rel-17 API version and External doc update | 17.1.0 | +| 2021-09 | CT#93 | CP-212026 | 0472 | | F | Correction of Content-Type | 17.2.0 | +| 2021-09 | CT#93 | | | | | SMF Response in case of AN-Requested PDU Session Resource Release | 17.2.0 | +| | | CP-212026 | 0471 | 1 | B | | | +| 2021-09 | CT#93 | CP-212026 | 0480 | 1 | F | Corrections to the API URI | 17.2.0 | +| 2021-09 | CT#93 | CP-212031 | 0462 | | B | Downlink Tunnel Info of NG-RAN in I-SMF selection per DNAI | 17.2.0 | +| 2021-09 | CT#93 | CP-212031 | 0461 | 2 | B | AF Coordination Information | 17.2.0 | +| 2021-09 | CT#93 | CP-212032 | 0478 | 1 | F | Selecting the same PCF for AMF and SMF in pure 5GS | 17.2.0 | +| 2021-09 | CT#93 | CP-212042 | 0468 | 1 | B | PDUSession API extensions for Redundant PDU Sessions | 17.2.0 | +| 2021-09 | CT#93 | CP-212047 | 0463 | | F | Binding Indication | 17.2.0 | +| 2021-09 | CT#93 | CP-212047 | 0469 | | F | requestType IE in Create (SM Context) service request | 17.2.0 | +| 2021-09 | CT#93 | CP-212047 | 0470 | 1 | F | Secondary RAT Usage Report | 17.2.0 | +| 2021-09 | CT#93 | CP-212047 | 0473 | 1 | F | Correction on remoteError and Snssai | 17.2.0 | +| 2021-09 | CT#93 | CP-212047 | 0460 | 1 | F | DNAI removal | 17.2.0 | +| 2021-09 | CT#93 | CP-212059 | 0483 | | F | 29.502 Rel-17 API version and External doc update | 17.2.0 | +| 2021-09 | CT#93 | CP-212061 | 0459 | | A | Change of ULCL/BP and/or local PSA | 17.2.0 | +| 2021-09 | CT#93 | CP-212064 | 0466 | 1 | A | Handover from 5GS to ePDG | 17.2.0 | +| 2021-09 | CT#93 | CP-212079 | 0476 | 1 | A | making vcnTunnelInfo optional on N16 | 17.2.0 | +| 2021-09 | CT#93 | CP-212079 | 0475 | 1 | A | S-NSSAI Not Supported in Handover | 17.2.0 | +| 2021-12 | CT#94 | CP-213100 | 0485 | 1 | B | Provisioning Server Information During PDU Session Establishment | 17.3.0 | +| 2021-12 | CT#94 | CP-213093 | 0486 | | F | Feature name of Enhancement of Edge Computing in 5G Core | 17.3.0 | + +| | | | | | | | | +|--|--|--|--|--|--|---------|--| +| | | | | | | network | | +|--|--|--|--|--|--|---------|--| + +| | | | | | | | | +|---------|-------|-----------|------|---|---|--------------------------------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94 | CP-213085 | 0487 | | F | PDU session release upon removal of DNN subscription | 17.3.0 | +| 2021-12 | CT#94 | CP-213085 | 0488 | 1 | F | ranUnchangedInd setting after EPS to 5GS handover | 17.3.0 | +| 2021-12 | CT#94 | CP-213102 | 0489 | 1 | B | NF service consumer cleanup | 17.3.0 | +| 2021-12 | CT#94 | CP-213093 | 0490 | 1 | B | Remove the Editor's Note on AF Coordination Information | 17.3.0 | +| 2021-12 | CT#94 | CP-213093 | 0491 | 1 | B | I-SMF removal for target DNAI | 17.3.0 | +| 2021-12 | CT#94 | CP-213108 | 0492 | 4 | B | Notification for SM Policy Association Events | 17.3.0 | +| 2021-12 | CT#94 | CP-213112 | 0493 | 1 | B | Sending UUAA Authentication message | 17.3.0 | +| 2021-12 | CT#94 | | | | | Void I-SMF/V-SMF Restoration procedure from normal specification clauses | 17.3.0 | +| 2021-12 | CT#94 | CP-213122 | 0494 | 1 | B | | | +| 2021-12 | CT#94 | CP-213115 | 0495 | 1 | D | 29.502 Element name corrections | 17.3.0 | +| 2021-12 | CT#94 | | | | | Informative note for NotifyList attribute not complying with 29.501 naming conventions | 17.3.0 | +| 2021-12 | CT#94 | CP-213087 | 0498 | 1 | F | | | +| 2021-12 | CT#94 | CP-213111 | 0499 | 1 | B | Reporting of satellite backhaul category to SMF | 17.3.0 | +| 2021-12 | CT#94 | | | | | Support of User Plane Integrity Protection for Interworking from 5GS to EPS | 17.3.0 | +| 2021-12 | CT#94 | CP-213123 | 0500 | 1 | B | | | +| 2021-12 | CT#94 | CP-213087 | 0502 | 1 | B | Updating Binding Indication for multiple resource contexts feature | 17.3.0 | +| 2021-12 | CT#94 | CP-213134 | 0504 | | A | 409 Response Code for I-SMF Update | 17.3.0 | +| 2021-12 | CT#94 | CP-213134 | 0506 | 1 | A | UE requested PDU session release | 17.3.0 | +| 2021-12 | CT#94 | | | | | VPLMN triggered QoS modification for QoS flow associated with default QoS Rule | 17.3.0 | +| 2021-12 | CT#94 | CP-213144 | 0508 | 1 | A | | | +| 2021-12 | CT#94 | CP-213121 | 0510 | | F | 29.502 Rel-17 API version and External doc update | 17.3.0 | +| 2022-03 | CT#95 | CP-220047 | 0512 | 2 | B | SNPN onboarding impacts on SMF | 17.4.0 | +| 2022-03 | CT#95 | | 0515 | | B | Indicating the possible use of OAuth2 authorization in Create SM Context | 17.4.0 | +| 2022-03 | CT#95 | CP-220023 | | | | | | +| 2022-03 | CT#95 | CP-220055 | 0516 | | F | Secondary RAT data usage reporting during AN Release procedure | 17.4.0 | +| 2022-03 | CT#95 | CP-220069 | 0518 | 4 | A | Notify change of anchor SMF or intermediate SMF | 17.4.0 | +| 2022-03 | CT#95 | CP-220031 | 0519 | 1 | F | SMF triggered I-SMF removal | 17.4.0 | +| 2022-03 | CT#95 | CP-220024 | 0520 | 1 | F | Support of ODB | 17.4.0 | +| 2022-03 | CT#95 | CP-220030 | 0521 | 2 | B | NSAC during change of Access-type of a PDU-Session | 17.4.0 | +| 2022-03 | CT#95 | CP-220024 | 0522 | | F | UE Registration procedure - V-SMF insertion, change and removal | 17.4.0 | +| 2022-03 | CT#95 | CP-220025 | 0523 | 1 | F | Formatting of Description fields | 17.4.0 | +| 2022-03 | CT#95 | CP-220025 | 0524 | 1 | B | Inter-PLMN mobility of PDU sessions | 17.4.0 | +| 2022-03 | CT#95 | | 0526 | 1 | A | Handover of a PDU session with I-SMF from 3GPP to non-3GPP access | 17.4.0 | +| 2022-03 | CT#95 | CP-220079 | | | | | | +| 2022-03 | CT#95 | CP-220030 | 0527 | 1 | B | Application errors for network slice data rate control | 17.4.0 | +| 2022-03 | CT#95 | CP-220082 | 0529 | | A | Downlink UE Integrity Protection Max Data Rate in SM Context | 17.4.0 | +| 2022-03 | CT#95 | CP-220082 | 0531 | 2 | A | UE Integrity Protection Max Data Rate during Inter-System Mobility | 17.4.0 | +| 2022-03 | CT#95 | CP-220025 | 0533 | 1 | B | PLMN Id of the SMF | 17.4.0 | +| 2022-03 | CT#95 | CP-220025 | 0535 | 1 | B | ServingNetwork in SmContextRetrieveData | 17.4.0 | +| 2022-03 | CT#95 | | 0538 | 1 | F | NGAP cause in network (e.g. H-SMF, SMF) requested PDU session modification | 17.4.0 | +| 2022-03 | CT#95 | CP-220064 | | | | | | +| 2022-03 | CT#95 | | 0539 | 1 | F | SMF URI attributes in Create SM Context for PDU sessions with I-SMF/V-SMF | 17.4.0 | +| 2022-03 | CT#95 | CP-220082 | | | | | | +| 2022-03 | CT#95 | | 0540 | 1 | F | SSC Mode in SmContext and error in QoS constraints from the VPLMN | 17.4.0 | +| 2022-03 | CT#95 | CP-220064 | | | | | | +| 2022-03 | CT#95 | CP-220225 | 0542 | 1 | B | Indication from AMF to SMF | 17.4.0 | +| 2022-03 | CT#95 | CP-220066 | 0545 | | F | 29.502 Rel-17 API version and External doc update | 17.4.0 | +| 2022-03 | CT#95 | CP-220146 | 0547 | | F | PVS Info attribute definition | 17.4.0 | +| 2022-06 | CT#96 | CP-221027 | 0548 | 1 | F | Correction to smfPduSessionUri | 17.5.0 | +| 2022-06 | CT#96 | CP-221029 | 0549 | 3 | F | Clarification on hoPreparationIndication | 17.5.0 | +| 2022-06 | CT#96 | CP-221045 | 0550 | 2 | F | Notify change of anchor SMF | 17.5.0 | +| 2022-06 | CT#96 | CP-221050 | 0551 | 1 | F | Duplicate PDU Session Handling | 17.5.0 | +| 2022-06 | CT#96 | CP-221050 | 0553 | 1 | F | N9 forwarding tunnel between BPs/ULCLs controlled by I-SMF | 17.5.0 | +| 2022-06 | CT#96 | CP-221045 | 0554 | 1 | F | Mobility between HPLMN and VPLMN | 17.5.0 | +| 2022-06 | CT#96 | CP-221045 | 0555 | 1 | F | Home S-NSSAI in LBO PDU session with I-SMF | 17.5.0 | +| 2022-06 | CT#96 | CP-221050 | 0556 | | F | HTTP Request | 17.5.0 | +| 2022-06 | CT#96 | CP-221064 | 0558 | 1 | A | Missing hoState in HsmfUpdateData | 17.5.0 | +| 2022-06 | CT#96 | CP-221061 | 0560 | 3 | A | Operation Type for UP Activation via N16a | 17.5.0 | +| 2022-06 | CT#96 | CP-221061 | 0562 | 1 | A | PDN Context Info Update on Anchor SMF Reselection | 17.5.0 | +| 2022-06 | CT#96 | CP-221043 | 0563 | | F | Remote UE Report | 17.5.0 | +| 2022-06 | CT#96 | CP-221050 | 0564 | 1 | F | Released PDU Sessions during Registration | 17.5.0 | +| 2022-06 | CT#96 | | 0566 | 2 | F | Protocol support for restoration procedures for Home Routed PDU Sessions or PDU sessions with an I-SMF | 17.5.0 | +| 2022-06 | CT#96 | CP-221339 | | | | | | +| 2022-06 | CT#96 | CP-221029 | 0567 | | F | Removal of apiVersion from resource URI variables tables | 17.5.0 | +| 2022-06 | CT#96 | CP-221051 | 0568 | | F | 29.502 Rel-17 API version and External doc update | 17.5.0 | +| 2022-09 | CT#97 | CP-222043 | 0570 | | F | Essential correction to PduSessionCreatedData | 17.6.0 | +| 2022-09 | CT#97 | CP-222031 | 0572 | | F | Multicast MBS session procedures | 17.6.0 | +| 2022-09 | CT#97 | CP-222039 | 0573 | 1 | F | Disaster Roaming service indication | 17.6.0 | +| 2022-09 | CT#97 | CP-222089 | 0575 | 1 | F | hSmfUri and smfUri in Create SM Context Request | 17.6.0 | +| 2022-09 | CT#97 | CP-222043 | 0578 | 1 | F | Oauth Required Indication | 17.6.0 | +| 2022-09 | CT#97 | CP-222067 | 0582 | 1 | A | QoS Flows Failed to Resume | 17.6.0 | +| 2022-09 | CT#97 | CP-222058 | 0583 | | F | 29.502 Rel-17 API version and External doc update | 17.6.0 | +| 2022-09 | CT#97 | CP-222023 | 0571 | | B | PGW Change Info | 18.0.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------|--------| +| 2022-09 | CT#97 | CP-222024 | 0577 | 1 | B | Populating a fullDnailList to (new) I-SMF | 18.0.0 | +| 2022-09 | CT#97 | CP-222025 | 0585 | | F | 29.502 Rel-18 API version and External doc update | 18.0.0 | +| 2022-12 | CT#98 | CP-223035 | 0588 | 1 | B | Support of RRC_INACTIVE with long eDRX | 18.1.0 | +| 2022-12 | CT#98 | CP-223029 | 0589 | 1 | F | Missing mandatory status codes in OpenAPI | 18.1.0 | +| 2022-12 | CT#98 | CP-223039 | 0590 | | F | Incorrect stage 2 references | 18.1.0 | +| 2022-12 | CT#98 | CP-223060 | 0592 | | A | Handling of PDU sessions for Emergency services | 18.1.0 | +| 2022-12 | CT#98 | CP-223039 | 0596 | 1 | F | Procedures with Create service operation | 18.1.0 | +| 2022-12 | CT#98 | CP-223036 | 0600 | 1 | A | Create SM Context service operation for multicast MBS session related procedures | 18.1.0 | +| 2022-12 | CT#98 | CP-223036 | 0603 | | A | Add the description of MBS using update SM context service | 18.1.0 | +| 2022-12 | CT#98 | CP-223093 | 0604 | 1 | A | Charging Id Format | 18.1.0 | +| 2022-12 | CT#98 | CP-223033 | 0605 | | F | 29.502 Rel-18 API version and External doc update | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0610 | 1 | F | Status code 504 in Create Response | 18.2.0 | +| 2023-03 | CT#99 | CP-230041 | 0611 | 3 | B | Adding GEO satellite ID attribute | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0612 | | F | Strings with Base64-encoded characters | 18.2.0 | +| 2023-03 | CT#99 | CP-230086 | 0616 | 1 | A | Network Triggered Service Request for a context in Suspend State | 18.2.0 | +| 2023-03 | CT#99 | CP-230030 | 0617 | 1 | B | Clarification on the SMF behaviour with cnBasedMt | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0618 | 1 | F | SM context / PDU session release cause for Mobility or Access Restrictions | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0619 | 1 | B | Populating Group ID during 4G to 5G mobility | 18.2.0 | +| 2023-03 | CT#99 | CP-230074 | 0622 | 1 | A | NSAC during HO between Access Types | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0623 | 1 | B | Retry Timer via N16/N16a | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0624 | 1 | B | Vplmn QoS Flow Rejection | 18.2.0 | +| 2023-03 | CT#99 | CP-230095 | 0626 | 1 | A | Correction on EBI Assignment over N16/N16a | 18.2.0 | +| 2023-03 | CT#99 | CP-230033 | 0630 | 2 | B | PDU Session for supporting HR-SBO in VPLMN | 18.2.0 | +| 2023-03 | CT#99 | CP-230033 | 0631 | 1 | B | ECS Configuration Information in roaming | 18.2.0 | +| 2023-03 | CT#99 | CP-230071 | 0632 | | F | 29.502 Rel-18 API version and External doc update | 18.2.0 | +| 2023-06 | CT#100 | CP-231028 | 0629 | 5 | F | Location header description | 18.3.0 | +| 2023-06 | CT#100 | CP-231033 | 0634 | 1 | B | VPLMN Specific Offloading Information | 18.3.0 | +| 2023-06 | CT#100 | CP-231033 | 0635 | 2 | B | HR-SBO information handling upon V-SMF insertion or change | 18.3.0 | +| 2023-06 | CT#100 | CP-231048 | 0637 | 1 | B | Reason for S-NSSAI Not Available | 18.3.0 | +| 2023-06 | CT#100 | CP-231046 | 0639 | 3 | B | Support for non-3GPP access path switching | 18.3.0 | +| 2023-06 | CT#100 | CP-231069 | 0640 | 5 | F | Adding remoteError in Status Notification in Home Routed PDU Release | 18.3.0 | +| 2023-06 | CT#100 | CP-231048 | 0642 | 2 | B | Support of Alternative S-NSSAI | 18.3.0 | +| 2023-06 | CT#100 | CP-231205 | 0643 | 2 | B | Support of Network Slice usage control | 18.3.0 | +| 2023-06 | CT#100 | CP-231093 | 0648 | 1 | A | Correction on EPS to 5GS Handover | 18.3.0 | +| 2023-06 | CT#100 | CP-231033 | 0652 | | B | H-SMF updating the HR-SBO information to V-SMF | 18.3.0 | +| 2023-06 | CT#100 | CP-231028 | 0653 | | F | Clarification on the release of duplicated PDU Session | 18.3.0 | +| 2023-06 | CT#100 | CP-231030 | 0654 | 3 | B | Resolving Editor's Notes for support of RRC_INACTIVE with long eDRX | 18.3.0 | +| 2023-06 | CT#100 | CP-231069 | 0656 | 1 | F | Invoking Namf_MT service for UE in RRC_SUSPEND | 18.3.0 | +| 2023-06 | CT#100 | CP-231033 | 0658 | 1 | B | HPLMN address information | 18.3.0 | +| 2023-06 | CT#100 | CP-231033 | 0659 | | F | Update of the HR-SBO Ind | 18.3.0 | +| 2023-06 | CT#100 | CP-231048 | 0660 | 1 | B | Change of Network Slice instance for PDU Sessions | 18.3.0 | +| 2023-06 | CT#100 | CP-231049 | 0661 | 2 | B | Update on LADN aspects for SMF | 18.3.0 | +| 2023-06 | CT#100 | CP-231070 | 0663 | | F | 29.502 Rel-18 API version and External doc update | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0666 | 1 | B | Priority Level addition to QoS constraints | 18.4.0 | +| 2023-09 | CT#101 | CP-232043 | 0668 | 1 | B | Add new cause for deactivation of user plane connection | 18.4.0 | +| 2023-09 | CT#101 | CP-232061 | 0670 | 2 | A | Include upipSupported Indication in SM Context Transfer | 18.4.0 | +| 2023-09 | CT#101 | CP-232043 | 0671 | 1 | B | PDU Session Release during Network Slice Replacement Procedure | 18.4.0 | +| 2023-09 | CT#101 | CP-232043 | 0672 | 3 | B | PDU Session Retention during Network Slice Replacement Procedure | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0673 | | F | Correction of ABNF rule of 3gpp-Sbi-Originating-Timestamp header | 18.4.0 | +| 2023-09 | CT#101 | CP-232036 | 0674 | 2 | F | Data types defined for HR-SBO | 18.4.0 | +| 2023-09 | CT#101 | CP-232036 | 0675 | 1 | B | Retrieval of SM context with HR-SBO information | 18.4.0 | +| 2023-09 | CT#101 | CP-232150 | 0676 | 4 | B | Avoidance of unnecessary interworking on N16 and N16a | 18.4.0 | +| 2023-09 | CT#101 | CP-232053 | 0678 | 2 | B | Support of Mobile Base Station Relay in SMF services | 18.4.0 | +| 2023-09 | CT#101 | CP-232034 | 0679 | 1 | B | Small Data Transmission in RRC_INACTIVE | 18.4.0 | +| 2023-09 | CT#101 | CP-232152 | 0680 | 2 | B | EAS rediscovery indication | 18.4.0 | +| 2023-09 | CT#101 | CP-232036 | 0682 | | B | Internal Group Identifier for HR-SBO subscription from V-SMF to AF | 18.4.0 | +| 2023-09 | CT#101 | CP-232063 | 0685 | 1 | A | Home S-NSSAI in EPC to 5GS handover with AMF relocation | 18.4.0 | +| 2023-09 | CT#101 | CP-232060 | 0686 | | F | 29.502 Rel-18 API version and External doc update | 18.4.0 | +| 2023-12 | CT#102 | CP-233038 | 0688 | 1 | B | V-SMF change based on target DNAI | 18.5.0 | +| 2023-12 | CT#102 | CP-233081 | 0689 | 3 | B | EAS information to be refreshed for EAS re-discovery | 18.5.0 | +| 2023-12 | CT#102 | CP-233036 | 0691 | 1 | B | Error for NG-RAN initiated Connection Inactive procedure | 18.5.0 | +| 2023-12 | CT#102 | CP-233044 | 0692 | | F | Correction on the description of DateTime | 18.5.0 | +| 2023-12 | CT#102 | CP-233046 | 0694 | 1 | F | Remove Editor's Note on PDU Session Retention | 18.5.0 | +| 2023-12 | CT#102 | CP-233028 | 0696 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.5.0 | +| 2023-12 | CT#102 | CP-233043 | 0698 | 1 | F | Removal of non-3GPP path switching capability between V-SMF and H-SMF | 18.5.0 | +| 2023-12 | CT#102 | CP-233056 | 0700 | 1 | F | Correction on epsInterworkingIndication | 18.5.0 | +| 2023-12 | CT#102 | CP-233071 | 0702 | | A | Correction on HsmfUpdateError, VsmdUpdateError and | 18.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------------------|--------| +| | | | | | | PduSessionCreateError | | +| 2023-12 | CT#102 | CP-233071 | 0704 | 2 | A | Correction on UE Integrity Protection Maximum Data Rate | 18.5.0 | +| 2023-12 | CT#102 | CP-233044 | 0705 | 2 | F | Clarifications on DL/UL N9 Tunnel CN Info | 18.5.0 | +| 2023-12 | CT#102 | CP-233074 | 0706 | 4 | B | Describe HR-SBO related procedures and Offload Identifiers in VPLMN offload policy | 18.5.0 | +| 2023-12 | CT#102 | CP-233066 | 0708 | 1 | A | disasterRoamingInd in mobility procedure | 18.5.0 | +| 2023-12 | CT#102 | CP-233038 | 0709 | | B | Replace hrsboRsplnfo with hrsbolnfo | 18.5.0 | +| 2023-12 | CT#102 | CP-233044 | 0710 | | F | maxIntegrityProtectedDataRate in the PduSessionCreatedData | 18.5.0 | +| 2023-12 | CT#102 | CP-233053 | 0711 | 4 | B | PDU set Parameters between the V/L-SMF and the (H-)SMF | 18.5.0 | +| 2023-12 | CT#102 | CP-233029 | 0712 | 2 | B | Indication of PDU Session Establishment Rejection | 18.5.0 | +| 2023-12 | CT#102 | CP-233056 | 0714 | 2 | F | String Based Charging Id Support | 18.5.0 | +| 2023-12 | CT#102 | CP-233044 | 0716 | 2 | F | Rejection of PDU Session Establishment due to ODB | 18.5.0 | +| 2023-12 | CT#102 | CP-233046 | 0718 | 1 | F | Procedure Description for PDU session release due to slice inactivity | 18.5.0 | +| 2023-12 | CT#102 | CP-233030 | 0719 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.5.0 | +| 2023-12 | CT#102 | CP-233053 | 0720 | | B | Maximum Data Burst Volume in Alternative QoS Profile | 18.5.0 | +| 2023-12 | CT#102 | CP-233044 | 0721 | | F | Removal of the uavAuthenticated IE from Create SM Context Request | 18.5.0 | +| 2023-12 | CT#102 | CP-233053 | 0723 | 1 | B | Support of ECN marking for L4S between the V/L-SMF and the (H-)SMF | 18.5.0 | +| 2023-12 | CT#102 | CP-233031 | 0724 | 1 | B | Roaming UE Indication for Emergency Session | 18.5.0 | +| 2023-12 | CT#102 | CP-233053 | 0727 | 1 | B | Periodicity and N6 Jitter Information associated with Periodicity between the V/L-SMF and the (H-)SMF | 18.5.0 | +| 2023-12 | CT#102 | CP-233030 | 0728 | | D | Editorial correction on the name of Remote UE Report Response | 18.5.0 | +| 2023-12 | CT#102 | CP-233060 | 0729 | | F | 29.502 Rel-18 API version and External doc update | 18.5.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29503/raw.md b/raw/rel-18/29_series/29503/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..32cdbf661c7ed7711d419a3ace61ac6b197a8648 --- /dev/null +++ b/raw/rel-18/29_series/29503/raw.md @@ -0,0 +1,32735 @@ +# 3GPP TS 29.503 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Unified Data Management Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------|----| +| TOC \o "1-9" Foreword..... | 22 | +| 1 Scope..... | 23 | +| 2 References..... | 23 | +| 3 Definitions and abbreviations ..... | 26 | +| 3.1 Definitions..... | 26 | +| 3.2 Abbreviations ..... | 26 | +| 4 Overview..... | 27 | +| 4.1 Introduction ..... | 27 | +| 5 Services offered by the UDM ..... | 29 | +| 5.1 Introduction ..... | 29 | +| 5.2 Nudm_SubscriberDataManagement Service ..... | 30 | +| 5.2.1 Service Description ..... | 30 | +| 5.2.2 Service Operations..... | 31 | +| 5.2.2.1 Introduction..... | 31 | +| 5.2.2.2 Get..... | 31 | +| 5.2.2.2.1 General ..... | 31 | +| 5.2.2.2.2 Slice Selection Subscription Data Retrieval..... | 32 | +| 5.2.2.2.3 Access and Mobility Subscription Data Retrieval ..... | 33 | +| 5.2.2.2.4 SMF Selection Subscription Data Retrieval..... | 34 | +| 5.2.2.2.5 Session Management Subscription Data Retrieval ..... | 35 | +| 5.2.2.2.6 SMS Subscription Data Retrieval ..... | 35 | +| 5.2.2.2.7 SMS Management Subscription Data Retrieval..... | 36 | +| 5.2.2.2.8 UE Context In SMF Data Retrieval ..... | 36 | +| 5.2.2.2.9 Retrieval Of Multiple Data Sets..... | 37 | +| 5.2.2.2.10 Identifier Translation..... | 37 | +| 5.2.2.2.11 Shared Subscription Data Retrieval ..... | 38 | +| 5.2.2.2.12 UE Context In SMSF Data Retrieval ..... | 39 | +| 5.2.2.2.13 Trace data Retrieval ..... | 39 | +| 5.2.2.2.14 Group Identifier Translation..... | 40 | +| 5.2.2.2.15 LCS Privacy Data Retrieval ..... | 41 | +| 5.2.2.2.16 LCS Mobile Originated Data Retrieval..... | 42 | +| 5.2.2.2.17 Enhanced Coverage Restriction Data Retrieval ..... | 42 | +| 5.2.2.2.18 V2X Subscription Data Retrieval..... | 43 | +| 5.2.2.2.19 LCS Broadcast Assistance Subscription Data Retrieval..... | 43 | +| 5.2.2.2.20 UE Context In AMF Data Retrieval..... | 44 | +| 5.2.2.2.21 Individual Shared Subscription Data Retrieval..... | 44 | +| 5.2.2.2.22 Prose Subscription Data Retrieval..... | 45 | +| 5.2.2.2.23 5MBS Subscription Data Retrieval..... | 45 | +| 5.2.2.2.24 User Consent Subscription Data Retrieval..... | 46 | +| 5.2.2.2.25 Multiple Identifiers Translation ..... | 46 | +| 5.2.2.2.26 Time Synchronization Subscription Data Retrieval..... | 47 | +| 5.2.2.2.27 LCS Subscription Data Retrieval ..... | 47 | +| 5.2.2.2.28 Ranging and Sidelink Positioning Subscription Data Retrieval..... | 48 | +| 5.2.2.2.29 A2X Subscription Data Retrieval..... | 48 | +| 5.2.2.3 Subscribe..... | 49 | +| 5.2.2.3.1 General ..... | 49 | +| 5.2.2.3.2 Subscription to notifications of data change ..... | 49 | +| 5.2.2.3.3 Subscription to notifications of shared data change..... | 50 | +| 5.2.2.4 Unsubscribe ..... | 50 | +| 5.2.2.4.1 General ..... | 50 | +| 5.2.2.4.2 Unsubscribe to notifications of data change ..... | 50 | +| 5.2.2.4.3 Unsubscribe to notifications of shared data change..... | 51 | +| 5.2.2.5 Notification ..... | 52 | +| 5.2.2.5.1 General ..... | 52 | + +| | | | +|------------|----------------------------------------------------------------------------------------------|----| +| 5.2.2.5.2 | Data Change Notification To NF ..... | 52 | +| 5.2.2.5.3 | UDR-initiated Data Restoration Notification..... | 53 | +| 5.2.2.6 | Info..... | 53 | +| 5.2.2.6.1 | General ..... | 53 | +| 5.2.2.6.2 | Providing acknowledgement of Steering of Roaming ..... | 54 | +| 5.2.2.6.3 | Providing acknowledgement of UE parameters update ..... | 54 | +| 5.2.2.6.4 | Providing acknowledgement of UE for Network Slicing Subscription Change ..... | 55 | +| 5.2.2.6.5 | Providing acknowledgement of UE for CAG configuration change ..... | 55 | +| 5.2.2.6.6 | Triggering Update of Steering Of Roaming information ..... | 55 | +| 5.2.2.7 | ModifySubscription ..... | 56 | +| 5.2.2.7.1 | General ..... | 56 | +| 5.2.2.7.2 | Modification of a subscription to notifications of data change..... | 56 | +| 5.2.2.7.3 | Modification of a subscription to notifications of shared data change ..... | 57 | +| 5.3 | Nudm_UEContextManagement Service..... | 57 | +| 5.3.1 | Service Description ..... | 57 | +| 5.3.2 | Service Operations..... | 57 | +| 5.3.2.1 | Introduction..... | 57 | +| 5.3.2.2 | Registration..... | 59 | +| 5.3.2.2.1 | General ..... | 59 | +| 5.3.2.2.2 | AMF registration for 3GPP access..... | 59 | +| 5.3.2.2.3 | AMF registration for non 3GPP access..... | 60 | +| 5.3.2.2.4 | SMF registration..... | 61 | +| 5.3.2.2.5 | SMSF Registration for 3GPP Access..... | 62 | +| 5.3.2.2.6 | SMSF Registration for Non 3GPP Access..... | 63 | +| 5.3.2.2.7 | IP-SM-GW registration..... | 63 | +| 5.3.2.2.8 | NWDAF registration..... | 64 | +| 5.3.2.3 | DeregistrationNotification ..... | 64 | +| 5.3.2.3.1 | General ..... | 64 | +| 5.3.2.3.2 | UDM initiated NF Deregistration ..... | 65 | +| 5.3.2.4 | Deregistration..... | 66 | +| 5.3.2.4.1 | General ..... | 66 | +| 5.3.2.4.2 | AMF deregistration for 3GPP access..... | 66 | +| 5.3.2.4.3 | AMF deregistration for non-3GPP access..... | 67 | +| 5.3.2.4.4 | SMF deregistration..... | 67 | +| 5.3.2.4.5 | SMSF Deregistration for 3GPP Access ..... | 68 | +| 5.3.2.4.6 | SMSF Deregistration for Non 3GPP Access..... | 68 | +| 5.3.2.4.7 | IP-SM-GW deregistration ..... | 69 | +| 5.3.2.4.8 | NWDAF deregistration ..... | 69 | +| 5.3.2.5 | Get..... | 70 | +| 5.3.2.5.1 | General ..... | 70 | +| 5.3.2.5.2 | Amf3GppAccessRegistration Information Retrieval..... | 70 | +| 5.3.2.5.3 | AmfNon3GppAccessRegistration Information Retrieval ..... | 70 | +| 5.3.2.5.4 | Void..... | 71 | +| 5.3.2.5.5 | SmsfRegistration Information Retrieval for 3GPP Access..... | 71 | +| 5.3.2.5.6 | SmsfRegistration Information Retrieval for Non-3GPP Access..... | 72 | +| 5.3.2.5.7 | SmfRegistration Information Retrieval..... | 72 | +| 5.3.2.5.8 | Individual SmfRegistration Information Retrieval ..... | 73 | +| 5.3.2.5.9 | Location Information Retrieval..... | 73 | +| 5.3.2.5.10 | Retrieval Of Multiple UE Registration Data Sets ..... | 74 | +| 5.3.2.5.11 | IP-SM-GW Registration Information Retrieval..... | 74 | +| 5.3.2.5.12 | NwdafRegistration Information Retrieval..... | 75 | +| 5.3.2.6 | Update..... | 75 | +| 5.3.2.6.1 | General ..... | 75 | +| 5.3.2.6.2 | Update A Parameter (e.g. PEI) in the AMF Registration For 3GPP Access ..... | 75 | +| 5.3.2.6.3 | Update A Parameter (e.g. PEI) in the AMF Registration For Non 3GPP Access ..... | 76 | +| 5.3.2.6.4 | Update A Parameter (e.g. analyticsId(s)) in the NWDAF Registration..... | 77 | +| 5.3.2.6.5 | Update A Parameter (e.g. PGW FQDN) in the SMF Registration ..... | 78 | +| 5.3.2.6.6 | Update A Parameter (e.g. Memory Available) in the SMSF Registration for 3GPP Access ..... | 78 | +| 5.3.2.6.7 | Update A Parameter (e.g. Memory Available) in the SMSF Registration for non-3GPP Access..... | 79 | +| 5.3.2.7 | P-CSCF-RestorationNotification ..... | 79 | +| 5.3.2.7.1 | General ..... | 79 | + +| | | | +|------------|--------------------------------------------------------|----| +| 5.3.2.7.2 | UDM initiated P-CSCF-Restoration ..... | 79 | +| 5.3.2.8 | P-CSCF-RestorationTrigger ..... | 80 | +| 5.3.2.8.1 | General ..... | 80 | +| 5.3.2.8.2 | P-CSCF-RestorationTrigger ..... | 80 | +| 5.3.2.9 | AMFDeregistration ..... | 80 | +| 5.3.2.9.1 | General ..... | 80 | +| 5.3.2.9.2 | AMF-Deregistration ..... | 81 | +| 5.3.2.10 | PEI-Update ..... | 81 | +| 5.3.2.10.1 | General ..... | 81 | +| 5.3.2.10.2 | PEI Update ..... | 81 | +| 5.3.2.11 | Roaming Information Update ..... | 82 | +| 5.3.2.11.1 | General ..... | 82 | +| 5.3.2.11.2 | Roaming Information Update ..... | 82 | +| 5.3.2.12 | DataRestorationNotification ..... | 82 | +| 5.3.2.12.1 | General ..... | 82 | +| 5.3.2.12.2 | UDR-initiated Data Restoration ..... | 82 | +| 5.3.2.13 | SendRoutingInfoForSM ..... | 83 | +| 5.3.2.13.1 | General ..... | 83 | +| 5.3.2.13.2 | Send Routing Information For SM ..... | 83 | +| 5.3.2.14 | StaleCheckNotification ..... | 84 | +| 5.3.2.14.1 | General ..... | 84 | +| 5.3.2.14.2 | UDM initiated Stale SMF Registration Check ..... | 84 | +| 5.3.2.15 | Re-AuthenticationNotification ..... | 85 | +| 5.3.2.15.1 | General ..... | 85 | +| 5.3.2.15.2 | Reauthentication Notify ..... | 85 | +| 5.3.2.16 | AuthTrigger ..... | 86 | +| 5.3.2.16.1 | General ..... | 86 | +| 5.3.2.16.2 | Auth Trigger ..... | 86 | +| 5.4 | Nudm_UEAuthentication Service ..... | 86 | +| 5.4.1 | Service Description ..... | 86 | +| 5.4.2 | Service Operations ..... | 86 | +| 5.4.2.1 | Introduction ..... | 86 | +| 5.4.2.2 | Get ..... | 87 | +| 5.4.2.2.1 | General ..... | 87 | +| 5.4.2.2.2 | Authentication Information Retrieval ..... | 87 | +| 5.4.2.2.3 | FN-RG Authentication ..... | 88 | +| 5.4.2.3 | ResultConfirmationInform ..... | 89 | +| 5.4.2.3.1 | General ..... | 89 | +| 5.4.2.3.2 | Authentication Confirmation ..... | 89 | +| 5.4.2.3.3 | Authentication Result Removal ..... | 89 | +| 5.4.2.4 | GetHssAv ..... | 90 | +| 5.4.2.4.1 | General ..... | 90 | +| 5.4.2.4.2 | HSS Authentication Vector Retrieval ..... | 90 | +| 5.4.2.5 | GetGbaAv ..... | 91 | +| 5.4.2.5.1 | General ..... | 91 | +| 5.4.2.5.2 | GBA Authentication Vector Retrieval ..... | 91 | +| 5.4.2.6 | GetProseAv ..... | 91 | +| 5.4.2.6.1 | General ..... | 91 | +| 5.4.2.6.2 | ProSe Authentication Vector Retrieval ..... | 92 | +| 5.4.2.7 | Notification ..... | 92 | +| 5.4.2.7.1 | General ..... | 92 | +| 5.4.2.7.2 | UDR-initiated Data Restoration Notification ..... | 92 | +| 5.5 | Nudm_EventExposure Service ..... | 93 | +| 5.5.1 | Service Description ..... | 93 | +| 5.5.2 | Service Operations ..... | 93 | +| 5.5.2.1 | Introduction ..... | 93 | +| 5.5.2.2 | Subscribe ..... | 94 | +| 5.5.2.2.1 | General ..... | 94 | +| 5.5.2.2.2 | Subscription to Notification of event occurrence ..... | 94 | +| 5.5.2.2.3 | Void ..... | 96 | +| 5.5.2.3 | Unsubscribe ..... | 96 | +| 5.5.2.3.1 | General ..... | 96 | + +| | | | +|-----------|-----------------------------------------------------------------|-----| +| 5.5.2.3.2 | Unsubscribe to notifications of event occurrence ..... | 96 | +| 5.5.2.4 | Notify ..... | 97 | +| 5.5.2.4.1 | General ..... | 97 | +| 5.5.2.4.2 | Event Occurrence Notification..... | 97 | +| 5.5.2.4.3 | Monitoring Revocation Notification ..... | 97 | +| 5.5.2.4.4 | UDR-initiated Data Restoration ..... | 98 | +| 5.5.2.5 | ModifySubscription ..... | 99 | +| 5.5.2.5.1 | General ..... | 99 | +| 5.5.2.5.2 | Modification of a subscription ..... | 99 | +| 5.5.2.5.3 | Remove or add group member UE(s) for a group subscription ..... | 99 | +| 5.6 | Nudm_ParameterProvision Service ..... | 100 | +| 5.6.1 | Service Description ..... | 100 | +| 5.6.2 | Service Operations..... | 100 | +| 5.6.2.1 | Introduction..... | 100 | +| 5.6.2.2 | Update ..... | 101 | +| 5.6.2.2.1 | General ..... | 101 | +| 5.6.2.2.2 | Subscription data update ..... | 101 | +| 5.6.2.2.3 | 5G VN Group modification..... | 102 | +| 5.6.2.2.4 | SoR Information update ..... | 102 | +| 5.6.2.2.5 | Parameter Provisioning Data Entry per AF update ..... | 103 | +| 5.6.2.2.6 | 5G-MBS-Group modification ..... | 104 | +| 5.6.2.3 | Create ..... | 104 | +| 5.6.2.3.1 | General ..... | 104 | +| 5.6.2.3.2 | 5G-VN-Group creation ..... | 105 | +| 5.6.2.3.3 | Parameter Provisioning Data Entry per AF creation..... | 105 | +| 5.6.2.3.4 | 5G-MBS-Group creation..... | 106 | +| 5.6.2.4 | Delete ..... | 106 | +| 5.6.2.4.1 | General ..... | 106 | +| 5.6.2.4.2 | 5G-VN-Group deletion ..... | 107 | +| 5.6.2.4.3 | Parameter Provisioning Data Entry per AF deletion..... | 107 | +| 5.6.2.4.4 | 5G-MBS-Group deletion..... | 108 | +| 5.6.2.5 | Get..... | 108 | +| 5.6.2.5.1 | General ..... | 108 | +| 5.6.2.5.2 | 5G-VN-Group get ..... | 109 | +| 5.6.2.5.3 | Parameter Provisioning Data Entry per AF get..... | 109 | +| 5.6.2.5.4 | 5G-MBS-Group get..... | 110 | +| 5.7 | Nudm_NIDDAuthorization Service..... | 110 | +| 5.7.1 | Service Description ..... | 110 | +| 5.7.2 | Service Operations..... | 110 | +| 5.7.2.1 | Introduction..... | 110 | +| 5.7.2.2 | Get..... | 111 | +| 5.7.2.2.1 | General ..... | 111 | +| 5.7.2.2.2 | NIDD Authorization Data Retrieval ..... | 111 | +| 5.7.2.3 | Notification ..... | 112 | +| 5.7.2.3.1 | General ..... | 112 | +| 5.7.2.3.2 | NIDD Authorization Data Update Notification ..... | 112 | +| 5.8 | Nudm_MT Service..... | 112 | +| 5.8.1 | Service Description ..... | 112 | +| 5.8.2 | Service Operations..... | 112 | +| 5.8.2.1 | Introduction..... | 112 | +| 5.8.2.2 | ProvideUeInfo..... | 113 | +| 5.8.2.2.1 | General ..... | 113 | +| 5.8.2.2.2 | UE Information Retrieval ..... | 113 | +| 5.8.2.3 | ProvideLocationInfo ..... | 113 | +| 5.8.2.3.1 | General ..... | 113 | +| 5.8.2.3.2 | Network Provided Location Information Request ..... | 113 | +| 5.9 | Nudm_ServiceSpecificAuthorization Service..... | 114 | +| 5.9.1 | Service Description ..... | 114 | +| 5.9.2 | Service Operations..... | 114 | +| 5.9.2.1 | Introduction..... | 114 | +| 5.9.2.2 | Create ..... | 115 | +| 5.9.2.2.1 | General ..... | 115 | + +| | | | +|------------|---------------------------------------------------------------|-----| +| 5.9.2.2.2 | Service Specific Authorization Data Retrieval ..... | 115 | +| 5.9.2.3 | UpdateNotify ..... | 116 | +| 5.9.2.3.1 | General ..... | 116 | +| 5.9.2.3.2 | Service Specific Authorization Data Update Notification ..... | 116 | +| 5.10 | Nudm_ReportSMDeliveryStatus Service ..... | 117 | +| 5.10.1 | Service Description ..... | 117 | +| 5.10.2 | Service Operations..... | 117 | +| 5.10.2.1 | Introduction..... | 117 | +| 5.10.2.2 | Request..... | 117 | +| 5.10.2.2.1 | General ..... | 117 | +| 5.10.2.2.2 | Report the SM-Delivery Status ..... | 117 | +| 5.11 | Nudm_UEIdentifier Service..... | 118 | +| 5.11.1 | Service Description ..... | 118 | +| 5.11.2 | Service Operations..... | 118 | +| 5.11.2.1 | Introduction..... | 118 | +| 5.11.2.2 | Deconceal..... | 118 | +| 6 | API Definitions ..... | 119 | +| 6.1 | Nudm_SubscriberDataManagement Service API..... | 119 | +| 6.1.1 | API URI..... | 119 | +| 6.1.2 | Usage of HTTP..... | 119 | +| 6.1.2.1 | General..... | 119 | +| 6.1.2.2 | HTTP standard headers..... | 119 | +| 6.1.2.2.1 | General ..... | 119 | +| 6.1.2.2.2 | Content type ..... | 119 | +| 6.1.2.2.3 | Cache-Control ..... | 120 | +| 6.1.2.2.4 | ETag ..... | 120 | +| 6.1.2.2.5 | If-None-Match..... | 120 | +| 6.1.2.2.6 | Last-Modified..... | 120 | +| 6.1.2.2.7 | If-Modified-Since..... | 120 | +| 6.1.2.2.8 | When to Use Entity-Tags and Last-Modified Dates ..... | 120 | +| 6.1.2.3 | HTTP custom headers..... | 120 | +| 6.1.2.3.1 | General ..... | 120 | +| 6.1.3 | Resources..... | 120 | +| 6.1.3.1 | Overview..... | 120 | +| 6.1.3.2 | Resource: Nssai (Document) ..... | 125 | +| 6.1.3.2.1 | Description ..... | 125 | +| 6.1.3.2.2 | Resource Definition..... | 125 | +| 6.1.3.2.3 | Resource Standard Methods..... | 125 | +| 6.1.3.3 | Resource: SdmSubscriptions (Collection)..... | 127 | +| 6.1.3.3.1 | Description ..... | 127 | +| 6.1.3.3.2 | Resource Definition..... | 127 | +| 6.1.3.3.3 | Resource Standard Methods..... | 127 | +| 6.1.3.4 | Resource: Individual subscription (Document) ..... | 128 | +| 6.1.3.4.1 | Description ..... | 128 | +| 6.1.3.4.2 | Resource Definition..... | 128 | +| 6.1.3.4.3 | Resource Standard Methods..... | 128 | +| 6.1.3.5 | Resource: AccessAndMobilitySubscriptionData (Document) ..... | 130 | +| 6.1.3.5.1 | Description ..... | 130 | +| 6.1.3.5.2 | Resource Definition..... | 130 | +| 6.1.3.5.3 | Resource Standard Methods..... | 130 | +| 6.1.3.5.4 | Resource Custom Operations..... | 132 | +| 6.1.3.6 | Resource: SmfSelectionSubscriptionData (Document)..... | 133 | +| 6.1.3.6.1 | Description ..... | 133 | +| 6.1.3.6.2 | Resource Definition..... | 133 | +| 6.1.3.6.3 | Resource Standard Methods..... | 133 | +| 6.1.3.7 | Resource: UeContextInSmfData (Document) ..... | 134 | +| 6.1.3.7.1 | Description ..... | 134 | +| 6.1.3.7.2 | Resource Definition..... | 134 | +| 6.1.3.7.3 | Resource Standard Methods..... | 134 | +| 6.1.3.8 | Resource: SessionManagementSubscriptionData (Document) ..... | 135 | +| 6.1.3.8.1 | Description ..... | 135 | + +| | | | +|------------|----------------------------------------------------------|-----| +| 6.1.3.8.2 | Resource Definition..... | 135 | +| 6.1.3.8.3 | Resource Standard Methods..... | 136 | +| 6.1.3.9 | Resource: SMSSubscriptionData (Document) ..... | 137 | +| 6.1.3.9.1 | Description ..... | 137 | +| 6.1.3.9.2 | Resource Definition..... | 137 | +| 6.1.3.9.3 | Resource Standard Methods..... | 137 | +| 6.1.3.10 | Resource: SMSManagementSubscriptionData (Document) ..... | 138 | +| 6.1.3.10.1 | Description ..... | 138 | +| 6.1.3.10.2 | Resource Definition..... | 138 | +| 6.1.3.10.3 | Resource Standard Methods..... | 139 | +| 6.1.3.11 | Resource: Supi (Document)..... | 140 | +| 6.1.3.11.1 | Description ..... | 140 | +| 6.1.3.11.2 | Resource Definition..... | 140 | +| 6.1.3.11.3 | Resource Standard Methods..... | 140 | +| 6.1.3.12 | Resource: IdTranslationResult (Document) ..... | 142 | +| 6.1.3.12.1 | Description ..... | 142 | +| 6.1.3.12.2 | Resource Definition..... | 142 | +| 6.1.3.12.3 | Resource Standard Methods..... | 142 | +| 6.1.3.13 | Resource: SorAck (Document)..... | 144 | +| 6.1.3.13.1 | Description ..... | 144 | +| 6.1.3.13.2 | Resource Definition..... | 144 | +| 6.1.3.13.3 | Resource Standard Methods..... | 144 | +| 6.1.3.14 | Resource: TraceData (Document) ..... | 145 | +| 6.1.3.14.1 | Description ..... | 145 | +| 6.1.3.14.2 | Resource Definition..... | 145 | +| 6.1.3.14.3 | Resource Standard Methods..... | 145 | +| 6.1.3.15 | Resource: SharedData (Collection) ..... | 146 | +| 6.1.3.15.1 | Description ..... | 146 | +| 6.1.3.15.2 | Resource Definition..... | 146 | +| 6.1.3.15.3 | Resource Standard Methods..... | 146 | +| 6.1.3.16 | Resource: SharedDataSubscriptions (Collection)..... | 147 | +| 6.1.3.16.1 | Description ..... | 147 | +| 6.1.3.16.2 | Resource Definition..... | 147 | +| 6.1.3.16.3 | Resource Standard Methods..... | 148 | +| 6.1.3.17 | Resource: Individual subscription (Document) ..... | 148 | +| 6.1.3.17.1 | Description ..... | 148 | +| 6.1.3.17.2 | Resource Definition..... | 149 | +| 6.1.3.17.3 | Resource Standard Methods..... | 149 | +| 6.1.3.18 | Resource: UeContextInSmsfData (Document)..... | 150 | +| 6.1.3.18.1 | Description ..... | 150 | +| 6.1.3.18.2 | Resource Definition..... | 150 | +| 6.1.3.18.3 | Resource Standard Methods..... | 151 | +| 6.1.3.19 | Resource: UpuAck (Document)..... | 151 | +| 6.1.3.19.1 | Description ..... | 151 | +| 6.1.3.19.2 | Resource Definition..... | 151 | +| 6.1.3.19.3 | Resource Standard Methods..... | 152 | +| 6.1.3.20 | Resource: GroupIdentifiers (Document) ..... | 152 | +| 6.1.3.20.1 | Description ..... | 152 | +| 6.1.3.20.2 | Resource Definition..... | 152 | +| 6.1.3.20.3 | Resource Standard Methods..... | 152 | +| 6.1.3.21 | Resource: SnssaisAck (Document)..... | 154 | +| 6.1.3.21.1 | Description ..... | 154 | +| 6.1.3.21.2 | Resource Definition..... | 154 | +| 6.1.3.21.3 | Resource Standard Methods..... | 154 | +| 6.1.3.22 | Resource: CagAck (Document)..... | 154 | +| 6.1.3.22.1 | Description ..... | 154 | +| 6.1.3.22.2 | Resource Definition..... | 155 | +| 6.1.3.22.3 | Resource Standard Methods..... | 155 | +| 6.1.3.23 | Resource: LcsPrivacySubscriptionData (Document) ..... | 155 | +| 6.1.3.23.1 | Description ..... | 155 | +| 6.1.3.23.2 | Resource Definition..... | 155 | +| 6.1.3.23.3 | Resource Standard Methods..... | 156 | + +| | | | +|------------|------------------------------------------------------------------|-----| +| 6.1.3.24 | Resource: LcsMobileOriginatedSubscriptionData (Document)..... | 156 | +| 6.1.3.24.1 | Description ..... | 156 | +| 6.1.3.24.2 | Resource Definition..... | 156 | +| 6.1.3.24.3 | Resource Standard Methods..... | 157 | +| 6.1.3.25 | Resource: EnhancedCoverageRestrictionData ..... | 157 | +| 6.1.3.25.1 | Description ..... | 157 | +| 6.1.3.25.2 | Resource Definition..... | 157 | +| 6.1.3.25.3 | Resource Standard Methods..... | 158 | +| 6.1.3.26 | Resource: UeContextInAmfData (Document)..... | 158 | +| 6.1.3.26.1 | Description ..... | 158 | +| 6.1.3.26.2 | Resource Definition..... | 158 | +| 6.1.3.26.3 | Resource Standard Methods..... | 159 | +| 6.1.3.27 | Resource: V2xSubscriptionData (Document) ..... | 159 | +| 6.1.3.27.1 | Description ..... | 159 | +| 6.1.3.27.2 | Resource Definition..... | 159 | +| 6.1.3.27.3 | Resource Standard Methods..... | 159 | +| 6.1.3.28 | Resource: LcsBroadcastAssistanceSubscriptionData (Document)..... | 160 | +| 6.1.3.28.1 | Description ..... | 160 | +| 6.1.3.28.2 | Resource Definition..... | 160 | +| 6.1.3.28.3 | Resource Standard Methods..... | 160 | +| 6.1.3.29 | Resource: IndividualSharedData (Document)..... | 161 | +| 6.1.3.29.1 | Description ..... | 161 | +| 6.1.3.29.2 | Resource Definition..... | 161 | +| 6.1.3.29.3 | Resource Standard Methods..... | 161 | +| 6.1.3.30 | Resource: ProseSubscriptionData (Document) ..... | 162 | +| 6.1.3.30.1 | Description ..... | 162 | +| 6.1.3.30.2 | Resource Definition..... | 162 | +| 6.1.3.30.3 | Resource Standard Methods..... | 162 | +| 6.1.3.31 | Resource: MbsSubscriptionData (Document) ..... | 163 | +| 6.1.3.31.1 | Description ..... | 163 | +| 6.1.3.31.2 | Resource Definition..... | 163 | +| 6.1.3.31.3 | Resource Standard Methods..... | 163 | +| 6.1.3.32 | Resource: UcSubscriptionData (Document)..... | 164 | +| 6.1.3.32.1 | Description ..... | 164 | +| 6.1.3.32.2 | Resource Definition..... | 164 | +| 6.1.3.32.3 | Resource Standard Methods..... | 164 | +| 6.1.3.33 | Resource: MultipleIdentifiers (Document)..... | 165 | +| 6.1.3.33.1 | Description ..... | 165 | +| 6.1.3.33.2 | Resource Definition..... | 165 | +| 6.1.3.33.3 | Resource Standard Methods..... | 165 | +| 6.1.3.34 | Resource: TimeSyncSubscriptionData (Document)..... | 166 | +| 6.1.3.34.1 | Description ..... | 166 | +| 6.1.3.34.2 | Resource Definition..... | 166 | +| 6.1.3.35.3 | Resource Standard Methods..... | 166 | +| 6.1.3.36 | Resource: LcsSubscriptionData (Document)..... | 167 | +| 6.1.3.36.1 | Description ..... | 167 | +| 6.1.3.36.2 | Resource Definition..... | 167 | +| 6.1.3.36.3 | Resource Standard Methods..... | 168 | +| 6.1.3.37 | Resource: RangingSIPosSubscriptionData (Document)..... | 168 | +| 6.1.3.37.1 | Description ..... | 168 | +| 6.1.3.37.2 | Resource Definition..... | 168 | +| 6.1.3.37.3 | Resource Standard Methods..... | 169 | +| 6.1.3.38 | Resource: A2xSubscriptionData (Document) ..... | 169 | +| 6.1.3.38.1 | Description ..... | 169 | +| 6.1.3.38.2 | Resource Definition..... | 169 | +| 6.1.4 | Custom Operations without associated resources ..... | 170 | +| 6.1.5 | Notifications ..... | 170 | +| 6.1.5.1 | General..... | 170 | +| 6.1.5.2 | Data Change Notification ..... | 171 | +| 6.1.5.3 | Data Restoration Notification ..... | 172 | +| 6.1.6 | Data Model ..... | 173 | +| 6.1.6.1 | General..... | 173 | + +| | | | +|------------|----------------------------------------------|-----| +| 6.1.6.2 | Structured data types..... | 180 | +| 6.1.6.2.1 | Introduction ..... | 180 | +| 6.1.6.2.2 | Type: Nssai..... | 181 | +| 6.1.6.2.3 | Type: SdmSubscription..... | 182 | +| 6.1.6.2.4 | Type: AccessAndMobilitySubscriptionData..... | 186 | +| 6.1.6.2.5 | Type: SmfSelectionSubscriptionData ..... | 192 | +| 6.1.6.2.6 | Type: DnnInfo ..... | 193 | +| 6.1.6.2.7 | Type: SnssaiInfo..... | 193 | +| 6.1.6.2.8 | Type: SessionManagementSubscriptionData..... | 194 | +| 6.1.6.2.9 | Type: DnnConfiguration ..... | 197 | +| 6.1.6.2.10 | Void..... | 200 | +| 6.1.6.2.11 | Type: PduSessionTypes ..... | 200 | +| 6.1.6.2.12 | Type: SscModes ..... | 200 | +| 6.1.6.2.13 | Type: SmsSubscriptionData..... | 200 | +| 6.1.6.2.14 | Type: SmsManagementSubscriptionData ..... | 201 | +| 6.1.6.2.15 | Type: SubscriptionDataSets ..... | 201 | +| 6.1.6.2.16 | Type: UeContextInSmfData..... | 202 | +| 6.1.6.2.17 | Type: PduSession..... | 202 | +| 6.1.6.2.18 | Type: IdTranslationResult..... | 202 | +| 6.1.6.2.19 | Void..... | 203 | +| 6.1.6.2.20 | Void..... | 203 | +| 6.1.6.2.21 | Type: ModificationNotification ..... | 203 | +| 6.1.6.2.22 | Type: IpAddress ..... | 203 | +| 6.1.6.2.23 | Type: UeContextInSmsfData ..... | 203 | +| 6.1.6.2.24 | Type: SmsfInfo..... | 204 | +| 6.1.6.2.25 | Type: AcknowledgeInfo..... | 204 | +| 6.1.6.2.26 | Type: SorInfo ..... | 205 | +| 6.1.6.2.27 | Type: SharedData..... | 208 | +| 6.1.6.2.28 | Type: PgwInfo..... | 209 | +| 6.1.6.2.29 | Type: TraceDataResponse..... | 209 | +| 6.1.6.2.30 | Type: SteeringContainer ..... | 209 | +| 6.1.6.2.31 | Type: SdmSubsModification..... | 210 | +| 6.1.6.2.32 | Type: EmergencyInfo..... | 210 | +| 6.1.6.2.33 | Type: UpuInfo..... | 211 | +| 6.1.6.2.34 | Type: GroupIdentifiers ..... | 212 | +| 6.1.6.2.35 | Type: NiddInformation ..... | 212 | +| 6.1.6.2.36 | Type: CagData..... | 213 | +| 6.1.6.2.37 | Type: CagInfo ..... | 213 | +| 6.1.6.2.38 | Type: AdditionalSnssaiData..... | 214 | +| 6.1.6.2.39 | Type: VnGroupData..... | 215 | +| 6.1.6.2.40 | Type: AppDescriptor..... | 215 | +| 6.1.6.2.41 | Type: AppPortId..... | 215 | +| 6.1.6.2.42 | Type: LcsPrivacyData..... | 216 | +| 6.1.6.2.43 | Type: Lpi..... | 216 | +| 6.1.6.2.44 | Type: UnrelatedClass ..... | 216 | +| 6.1.6.2.45 | Type: PlmnOperatorClass ..... | 217 | +| 6.1.6.2.46 | Type: ValidTimePeriod..... | 217 | +| 6.1.6.2.47 | Type: LcsMoData..... | 217 | +| 6.1.6.2.48 | Type: EcRestrictionDataWb ..... | 217 | +| 6.1.6.2.49 | Type: ExpectedUeBehaviourData..... | 218 | +| 6.1.6.2.50 | Void..... | 219 | +| 6.1.6.2.51 | Void..... | 219 | +| 6.1.6.2.52 | Type: SuggestedPacketNumDl ..... | 219 | +| 6.1.6.2.53 | Void..... | 219 | +| 6.1.6.2.54 | Type: FrameRouteInfo ..... | 219 | +| 6.1.6.2.55 | Type: SorUpdateInfo..... | 219 | +| 6.1.6.2.56 | Type: EnhancedCoverageRestrictionData ..... | 219 | +| 6.1.6.2.57 | Type: EdrxParameters..... | 220 | +| 6.1.6.2.58 | Type: PtwParameters..... | 220 | +| 6.1.6.2.59 | Void..... | 221 | +| 6.1.6.2.60 | Void..... | 221 | +| 6.1.6.2.61 | Type: Void..... | 221 | + +| | | | +|-------------|-----------------------------------------------|-----| +| 6.1.6.2.62 | Type: ExternalUnrelatedClass..... | 221 | +| 6.1.6.2.63 | Type: AfExternal..... | 221 | +| 6.1.6.2.64 | Type: LcsClientExternal ..... | 221 | +| 6.1.6.2.65 | Type: LcsClientGroupExternal ..... | 222 | +| 6.1.6.2.66 | Type: ServiceTypeUnrelatedClass..... | 222 | +| 6.1.6.2.67 | Type: UeId..... | 222 | +| 6.1.6.2.68 | Type: DefaultUnrelatedClass ..... | 223 | +| 6.1.6.2.69 | Type: ContextInfo ..... | 223 | +| 6.1.6.2.70 | Type: UeContextInAmfData ..... | 223 | +| 6.1.6.2.71 | Type: V2xSubscriptionData..... | 224 | +| 6.1.6.2.72 | Type: LcsBroadcastAssistanceTypesData ..... | 225 | +| 6.1.6.2.73 | Type: DatasetNames ..... | 228 | +| 6.1.6.2.74 | Type: PlmnRestriction..... | 229 | +| 6.1.6.2.75 | Type: PcfSelectionAssistanceInfo..... | 229 | +| 6.1.6.2.76 | Type: ProseSubscriptionData..... | 229 | +| 6.1.6.2.77 | Type: IpIndex..... | 229 | +| 6.1.6.2.78 | Type: AerialUeSubscriptionInfo ..... | 230 | +| 6.1.6.2.79 | Type: SmSubsData..... | 230 | +| 6.1.6.2.80 | Type: ExtendedSmSubsData..... | 230 | +| 6.1.6.2.81 | Type: AmfInfo..... | 230 | +| 6.1.6.2.82 | Type: ProSeAllowedPlmn..... | 231 | +| 6.1.6.2.83 | Type: ImmediateReport..... | 231 | +| 6.1.6.2.84 | Type: MbsSubscriptionData..... | 231 | +| 6.1.6.2.85 | Type: UcSubscriptionData ..... | 231 | +| 6.1.6.2.86 | Type: UeContextInSmfDataSubFilter ..... | 232 | +| 6.1.6.2.87 | Type: UeIdentifiers ..... | 232 | +| 6.1.6.2.88 | Type: SupiInfo..... | 232 | +| 6.1.6.2.89 | Type: TimeSyncData..... | 233 | +| 6.1.6.2.90 | Type: TimeSyncSubscriptionData ..... | 233 | +| 6.1.6.2.91 | Type: AfRequestAuthorization ..... | 233 | +| 6.1.6.2.92 | Type: TimeSyncServiceId..... | 234 | +| 6.1.6.2.93 | Type: LcsSubscriptionData ..... | 234 | +| 6.1.6.2.94 | Type: ConditionalCagInfo..... | 234 | +| 6.1.6.2.95 | Void..... | 235 | +| 6.1.6.2.96 | Void..... | 235 | +| 6.1.6.2.97 | Type: RangingSIPosSubscriptionData ..... | 235 | +| 6.1.6.2.98 | Type: RangingSIPosPlmn ..... | 235 | +| 6.1.6.2.99 | Type: AppSpecificExpectedUeBehaviourData..... | 236 | +| 6.1.6.2.100 | Type: ExpectedUeBehaviourThreshold ..... | 237 | +| 6.1.6.2.101 | Type: A2xSubscriptionData..... | 239 | +| 6.1.6.2.102 | Type: RangingSIPosQos ..... | 240 | +| 6.1.6.2.103 | Type: MbsrOperationAllowed ..... | 240 | +| 6.1.6.2.104 | Type: GpsiInfo ..... | 240 | +| 6.1.6.2.105 | Type: DnnLadnServiceAreas ..... | 241 | +| 6.1.6.2.106 | Type: DnnLadnServiceArea..... | 241 | +| 6.1.6.2.107 | Type: GtpAllowedInfo ..... | 241 | +| 6.1.6.2.108 | Type: AstiAllowedInfo ..... | 242 | +| 6.1.6.3 | Simple data types and enumerations..... | 242 | +| 6.1.6.3.1 | Introduction ..... | 242 | +| 6.1.6.3.2 | Simple data types ..... | 242 | +| 6.1.6.3.3 | Enumeration: DataSetName..... | 245 | +| 6.1.6.3.4 | Void..... | 245 | +| 6.1.6.3.5 | Void..... | 245 | +| 6.1.6.3.6 | Void..... | 245 | +| 6.1.6.3.7 | Enumeration: PduSessionContinuityInd ..... | 245 | +| 6.1.6.3.8 | Enumeration: LocationPrivacyInd ..... | 246 | +| 6.1.6.3.9 | Enumeration: PrivacyCheckRelatedAction..... | 246 | +| 6.1.6.3.10 | Enumeration: LcsClientClass..... | 246 | +| 6.1.6.3.11 | Enumeration: LcsMoServiceClass ..... | 246 | +| 6.1.6.3.12 | Enumeration: OperationMode..... | 246 | +| 6.1.6.3.13 | Enumeration: SorUpdateIndicator..... | 247 | +| 6.1.6.3.14 | Enumeration: CodeWordInd ..... | 247 | + +| | | | +|------------|---------------------------------------------------------|-----| +| 6.1.6.3.15 | Enumeration: MdtUserConsent..... | 247 | +| 6.1.6.3.16 | Enumeration: SharedDataTreatmentInstruction..... | 247 | +| 6.1.6.3.17 | Enumeration: GpsiType ..... | 247 | +| 6.1.6.3.18 | Enumeration: AerialUeIndication ..... | 248 | +| 6.1.6.3.19 | Enumeration: ProseDirectAllowed ..... | 248 | +| 6.1.6.3.20 | Enumeration: UcPurpose..... | 249 | +| 6.1.6.3.21 | Enumeration: UserConsent ..... | 249 | +| 6.1.6.3.22 | Enumeration: NsacAdmissionMode ..... | 249 | +| 6.1.6.3.23 | Enumeration: PruInd ..... | 249 | +| 6.1.6.3.24 | Enumeration: AreaUsageInd ..... | 249 | +| 6.1.6.3.25 | Void..... | 250 | +| 6.1.6.3.26 | Void..... | 250 | +| 6.1.6.3.27 | Void..... | 250 | +| 6.1.6.3.28 | Enumeration: RangingSIPosAllowed..... | 250 | +| 6.1.6.3.29 | Enumeration: ExpecedUeBehaviourDataset..... | 250 | +| 6.1.6.3.30 | Enumeration: UpLoCRepIndAf ..... | 250 | +| 6.1.7 | Error Handling ..... | 251 | +| 6.1.7.1 | General ..... | 251 | +| 6.1.7.2 | Protocol Errors ..... | 251 | +| 6.1.7.3 | Application Errors..... | 251 | +| 6.1.8 | Feature Negotiation ..... | 251 | +| 6.1.9 | Security ..... | 255 | +| 6.1.10 | HTTP redirection..... | 256 | +| 6.2 | Nudm_UEContextManagement Service API..... | 256 | +| 6.2.1 | API URI..... | 256 | +| 6.2.2 | Usage of HTTP..... | 256 | +| 6.2.2.1 | General ..... | 256 | +| 6.2.2.2 | HTTP standard headers..... | 256 | +| 6.2.2.2.1 | General ..... | 256 | +| 6.2.2.2.2 | Content type ..... | 256 | +| 6.2.2.3 | HTTP custom headers..... | 257 | +| 6.2.2.3.1 | General ..... | 257 | +| 6.2.3 | Resources..... | 257 | +| 6.2.3.1 | Overview..... | 257 | +| 6.2.3.2 | Resource: Amf3GppAccessRegistration (Document) ..... | 262 | +| 6.2.3.2.1 | Description ..... | 262 | +| 6.2.3.2.2 | Resource Definition..... | 262 | +| 6.2.3.2.3 | Resource Standard Methods..... | 262 | +| 6.2.3.2.4 | Resource Custom Operations..... | 265 | +| 6.2.3.3 | Resource: AmfNon3GppAccessRegistration (Document) ..... | 266 | +| 6.2.3.3.1 | Description ..... | 266 | +| 6.2.3.3.2 | Resource Definition..... | 266 | +| 6.2.3.3.3 | Resource Standard Methods..... | 267 | +| 6.2.3.4 | Resource: SmfRegistrations..... | 269 | +| 6.2.3.4.1 | Description ..... | 269 | +| 6.2.3.4.2 | Resource Definition..... | 269 | +| 6.2.3.4.3 | Resource Standard Methods..... | 269 | +| 6.2.3.5 | Resource: IndividualSmfRegistration (Document) ..... | 270 | +| 6.2.3.5.1 | Resource Definition..... | 270 | +| 6.2.3.5.2 | Resource Standard Methods..... | 270 | +| 6.2.3.6 | Resource: Smf3GppAccessRegistration (Document) ..... | 273 | +| 6.2.3.6.1 | Description ..... | 273 | +| 6.2.3.6.2 | Resource Definition..... | 273 | +| 6.2.3.6.3 | Resource Standard Methods..... | 274 | +| 6.2.3.7 | Resource: SmfNon3GppAccessRegistration (Document) ..... | 277 | +| 6.2.3.7.1 | Description ..... | 277 | +| 6.2.3.7.2 | Resource Definition..... | 277 | +| 6.2.3.7.3 | Resource Standard Methods..... | 277 | +| 6.2.3.8 | Resource: Location ..... | 280 | +| 6.2.3.8.1 | Description ..... | 280 | +| 6.2.3.8.2 | Resource Definition..... | 281 | +| 6.2.3.8.3 | Resource Standard Methods..... | 281 | + +| | | | +|-------------|------------------------------------------------------|-----| +| 6.2.3.9 | Resource: Registrations ..... | 281 | +| 6.2.3.9.1 | Description ..... | 281 | +| 6.2.3.9.2 | Resource Definition..... | 281 | +| 6.2.3.9.3 | Resource Standard Methods..... | 282 | +| 6.2.3.9.4 | Resource Custom Operations..... | 283 | +| 6.2.3.10 | Resource: IpSmGwRegistration ..... | 284 | +| 6.2.3.10.1 | Description ..... | 284 | +| 6.2.3.10.2 | Resource Definition..... | 284 | +| 6.2.3.10.3 | Resource Standard Methods..... | 284 | +| 6.2.3.11 | Resource: NwdafRegistration (Document)..... | 286 | +| 6.2.3.11.1 | Resource Definition..... | 286 | +| 6.2.3.11.2 | Resource Standard Methods..... | 286 | +| 6.2.3.12 | Resource: NwdafRegistrations ..... | 288 | +| 6.2.3.12.1 | Description ..... | 288 | +| 6.2.3.12.2 | Resource Definition..... | 288 | +| 6.2.3.12.3 | Resource Standard Methods..... | 288 | +| 6.2.3.13 | Resource: AuthTrigger ..... | 289 | +| 6.2.3.13.1 | Description ..... | 289 | +| 6.2.3.13.2 | Resource Definition..... | 289 | +| 6.2.3.13.3 | Resource Standard Methods..... | 289 | +| 6.2.3.13.4 | Resource Custom Operations..... | 289 | +| 6.2.4 | Custom Operations without associated resources ..... | 290 | +| 6.2.4.1 | Overview..... | 290 | +| 6.2.4.2 | Operation: Trigger P-CSCF Restoration..... | 290 | +| 6.2.4.2.1 | Description ..... | 290 | +| 6.2.4.2.2 | Operation Definition ..... | 290 | +| 6.2.5 | Notifications ..... | 291 | +| 6.2.5.1 | General..... | 291 | +| 6.2.5.2 | Deregistration Notification ..... | 291 | +| 6.2.5.3 | P-CSCF Restoration Notification ..... | 292 | +| 6.2.5.4 | Data Restoration Notification ..... | 293 | +| 6.2.5.5 | Stale Check Notification..... | 294 | +| 6.2.5.6 | Re-AuthenticationNotification Notification ..... | 296 | +| 6.2.6 | Data Model ..... | 297 | +| 6.2.6.1 | General..... | 297 | +| 6.2.6.2 | Structured data types..... | 300 | +| 6.2.6.2.1 | Introduction ..... | 300 | +| 6.2.6.2.2 | Type: Amf3GppAccessRegistration ..... | 301 | +| 6.2.6.2.3 | Type: AmfNon3GppAccessRegistration..... | 306 | +| 6.2.6.2.4 | Type: SmfRegistration ..... | 311 | +| 6.2.6.2.5 | Type: DeregistrationData ..... | 314 | +| 6.2.6.2.6 | Type: SsmfRegistration..... | 315 | +| 6.2.6.2.7 | Type: Amf3GppAccessRegistrationModification..... | 317 | +| 6.2.6.2.8 | Type: AmfNon3GppAccessRegistrationModification..... | 318 | +| 6.2.6.2.9 | Type: PscfRestorationNotification ..... | 318 | +| 6.2.6.2.10 | Type: NetworkNodeDiameterAddress..... | 318 | +| 6.2.6.2.11 | Type: EpsIwkPgw ..... | 319 | +| 6.2.6.2.12 | Type: TriggerRequest..... | 319 | +| 6.2.6.2.13 | Type: AmfDeregInfo..... | 319 | +| 6.2.6.2.14 | Type: EpsInterworkingInfo ..... | 319 | +| 6.2.6.2.15 | Type: LocationInfo..... | 319 | +| 6.2.6.2.16 | Type: RegistrationLocationInfo ..... | 320 | +| 6.2.6.2.17 | Type: VgmlcAddress..... | 320 | +| 6.2.6.2.18 | Type: PeiUpdateInfo ..... | 320 | +| 6.2.6.2.19 | Type: RegistrationDataSets..... | 320 | +| 6.2.6.2.20 | Type: IpSmGwRegistration..... | 321 | +| 6.2.6.2.20A | Type: SmfRegistrationInfo..... | 321 | +| 6.2.6.2.21 | Type: NwdafRegistration ..... | 322 | +| 6.2.6.2.22 | Type: NwdafRegistrationModification ..... | 322 | +| 6.2.6.2.23 | Type: SmfRegistrationModification ..... | 322 | +| 6.2.6.2.24 | Type: RoamingInfoUpdate..... | 323 | +| 6.2.6.2.25 | Type: DataRestorationNotification ..... | 324 | + +| | | | +|------------|-----------------------------------------------------------|-----| +| 6.2.6.2.26 | Type: PscsfAddress..... | 324 | +| 6.2.6.2.27 | Type: NwdaRegistrationInfo ..... | 324 | +| 6.2.6.2.28 | Type: RoutingInfoSmRequest..... | 325 | +| 6.2.6.2.29 | Type: RoutingInfoSmResponse ..... | 325 | +| 6.2.6.2.30 | Type: IpSmGwInfo ..... | 325 | +| 6.2.6.2.31 | Type: IpSmGwGuidance..... | 325 | +| 6.2.6.2.32 | Type: SmsRouterInfo ..... | 326 | +| 6.2.6.2.33 | Type: SmsfRegistrationModification..... | 326 | +| 6.2.6.2.34 | Type: PduSessionIds ..... | 326 | +| 6.2.6.2.35 | Type: ReauthNotificationInfo ..... | 326 | +| 6.2.6.2.36 | Type: AuthTriggerInfo..... | 327 | +| 6.2.6.2.37 | Type: DeregistrationRespData ..... | 327 | +| 6.2.6.3 | Simple data types and enumerations..... | 327 | +| 6.2.6.3.1 | Introduction ..... | 327 | +| 6.2.6.3.2 | Simple data types ..... | 327 | +| 6.2.6.3.3 | Enumeration: DeregistrationReason ..... | 327 | +| 6.2.6.3.4 | Enumeration: ImsVoPs ..... | 328 | +| 6.2.6.3.5 | Enumeration: RegistrationReason..... | 328 | +| 6.2.6.3.6 | Enumeration: RegistrationDataSetName ..... | 329 | +| 6.2.6.3.7 | Enumeration: UeReachableInd ..... | 329 | +| 6.2.7 | Error Handling ..... | 329 | +| 6.2.7.1 | General ..... | 329 | +| 6.2.7.2 | Protocol Errors ..... | 329 | +| 6.2.7.3 | Application Errors..... | 329 | +| 6.2.8 | Feature Negotiation ..... | 331 | +| 6.2.9 | Security ..... | 331 | +| 6.2.10 | HTTP redirection..... | 332 | +| 6.3 | Nudm_UEAuthentication Service API ..... | 332 | +| 6.3.1 | API URI..... | 332 | +| 6.3.2 | Usage of HTTP..... | 332 | +| 6.3.2.1 | General ..... | 332 | +| 6.3.2.2 | HTTP standard headers..... | 332 | +| 6.3.2.2.1 | General ..... | 332 | +| 6.3.2.2.2 | Content type ..... | 332 | +| 6.3.2.3 | HTTP custom headers..... | 333 | +| 6.3.2.3.1 | General ..... | 333 | +| 6.3.3 | Resources..... | 333 | +| 6.3.3.1 | Overview..... | 333 | +| 6.3.3.2 | Resource: SecurityInformation (Custom operation)..... | 335 | +| 6.3.3.2.1 | Description ..... | 335 | +| 6.3.3.2.2 | Resource Definition..... | 336 | +| 6.3.3.2.3 | Resource Standard Methods..... | 336 | +| 6.3.3.2.4 | Resource Custom Operations ..... | 336 | +| 6.3.3.3 | Resource: AuthEvents (Collection) ..... | 337 | +| 6.3.3.3.1 | Description ..... | 337 | +| 6.3.3.3.2 | Resource Definition..... | 337 | +| 6.3.3.3.3 | Resource Standard Methods..... | 337 | +| 6.3.3.4 | Resource: SecurityInformationForRg..... | 338 | +| 6.3.3.4.1 | Description ..... | 338 | +| 6.3.3.4.2 | Resource Definition..... | 338 | +| 6.3.3.4.3 | Resource Standard Methods..... | 339 | +| 6.3.3.5 | Resource: HssSecurityInformation (Custom operation)..... | 339 | +| 6.3.3.5.1 | Description ..... | 339 | +| 6.3.3.5.2 | Resource Definition..... | 339 | +| 6.3.3.5.3 | Resource Standard Methods..... | 340 | +| 6.3.3.5.4 | Resource Custom Operations ..... | 340 | +| 6.3.3.6 | Resource: Individual AuthEvent..... | 341 | +| 6.3.3.6.1 | Resource Definition..... | 341 | +| 6.3.3.6.2 | Resource Standard Methods..... | 341 | +| 6.3.3.7 | Resource: GbaSecurityInformation (Custom operation) ..... | 342 | +| 6.3.3.7.1 | Description ..... | 342 | +| 6.3.3.7.2 | Resource Definition..... | 342 | + +| | | | +|-------------|-------------------------------------------------------------|-----| +| 6.3.3.7.3 | Resource Standard Methods..... | 342 | +| 6.3.3.7.4 | Resource Custom Operations..... | 342 | +| 6.3.3.8 | Resource: ProSeSecurityInformation (Custom operation) ..... | 343 | +| 6.3.3.8.1 | Description ..... | 343 | +| 6.3.3.8.2 | Resource Definition..... | 343 | +| 6.3.3.8.3 | Resource Standard Methods..... | 343 | +| 6.3.3.8.4 | Resource Custom Operations..... | 344 | +| 6.3.3.8.4.1 | Overview ..... | 344 | +| 6.3.3.8.4.2 | Operation: generate-av ..... | 344 | +| 6.3.4 | Custom Operations without associated resources ..... | 344 | +| 6.3.5 | Notifications ..... | 345 | +| 6.3.5.1 | General..... | 345 | +| 6.3.5.2 | Data Restoration Notification ..... | 345 | +| 6.3.6 | Data Model ..... | 346 | +| 6.3.6.1 | General..... | 346 | +| 6.3.6.2 | Structured data types..... | 348 | +| 6.3.6.2.1 | Introduction ..... | 348 | +| 6.3.6.2.2 | Type: AuthenticationInfoRequest ..... | 349 | +| 6.3.6.2.3 | Type: AuthenticationInfoResult..... | 350 | +| 6.3.6.2.4 | Type: AvEapAkaPrime ..... | 351 | +| 6.3.6.2.5 | Type: Av5GHeAka ..... | 351 | +| 6.3.6.2.6 | Type: ResynchronizationInfo..... | 351 | +| 6.3.6.2.7 | Type: AuthEvent ..... | 352 | +| 6.3.6.2.8 | Type: AuthenticationVector..... | 352 | +| 6.3.6.2.9 | Type: RgAuthCtx ..... | 353 | +| 6.3.6.2.10 | Type: HssAuthenticationInfoRequest ..... | 353 | +| 6.3.6.2.11 | Type: HssAuthenticationInfoResult..... | 353 | +| 6.3.6.2.12 | Type: HssAuthenticationVectors ..... | 353 | +| 6.3.6.2.13 | Type: AvEpsAka..... | 354 | +| 6.3.6.2.14 | Type: AvImsGbaEapAka ..... | 354 | +| 6.3.6.2.15 | Type: GbaAuthenticationInfoRequest..... | 354 | +| 6.3.6.2.16 | Type: GbaAuthenticationInfoResult ..... | 354 | +| 6.3.6.2.17 | Type: ProSeAuthenticationInfoRequest..... | 354 | +| 6.3.6.2.18 | Type: ProSeAuthenticationInfoResult ..... | 355 | +| 6.3.6.2.19 | Type: ProSeAuthenticationVectors..... | 355 | +| 6.3.6.3 | Simple data types and enumerations..... | 355 | +| 6.3.6.3.1 | Introduction ..... | 355 | +| 6.3.6.3.2 | Simple data types ..... | 355 | +| 6.3.6.3.3 | Enumeration: AuthType..... | 356 | +| 6.3.6.3.4 | Enumeration: AvType ..... | 356 | +| 6.3.6.3.5 | Enumeration: HssAuthType..... | 356 | +| 6.3.6.3.6 | Enumeration: HssAvType..... | 356 | +| 6.3.6.3.7 | Enumeration: HssAuthTypeInUri ..... | 357 | +| 6.3.6.3.8 | Enumeration: AccessNetworkId ..... | 357 | +| 6.3.6.3.9 | Enumeration: NodeType ..... | 357 | +| 6.3.6.3.10 | Enumeration: GbaAuthType ..... | 357 | +| 6.3.7 | Error Handling ..... | 357 | +| 6.3.7.1 | General..... | 357 | +| 6.3.7.2 | Protocol Errors ..... | 358 | +| 6.3.7.3 | Application Errors..... | 358 | +| 6.3.8 | Feature Negotiation ..... | 358 | +| 6.3.9 | Security..... | 358 | +| 6.3.10 | HTTP redirection..... | 359 | +| 6.4 | Nudm_EventExposure Service API..... | 359 | +| 6.4.1 | API URI..... | 359 | +| 6.4.2 | Usage of HTTP..... | 359 | +| 6.4.2.1 | General..... | 359 | +| 6.4.2.2 | HTTP standard headers..... | 360 | +| 6.4.2.2.1 | General ..... | 360 | +| 6.4.2.2.2 | Content type ..... | 360 | +| 6.4.2.3 | HTTP custom headers..... | 360 | +| 6.4.2.3.1 | General ..... | 360 | + +| | | | +|------------|------------------------------------------------------|-----| +| 6.4.3 | Resources..... | 360 | +| 6.4.3.1 | Overview..... | 360 | +| 6.4.3.2 | Resource: EeSubscriptions (Collection) ..... | 361 | +| 6.4.3.2.1 | Description ..... | 361 | +| 6.4.3.2.2 | Resource Definition..... | 361 | +| 6.4.3.2.3 | Resource Standard Methods..... | 361 | +| 6.4.3.3 | Resource: Individual subscription (Document) ..... | 362 | +| 6.4.3.3.1 | Resource Definition..... | 362 | +| 6.4.3.3.2 | Resource Standard Methods..... | 363 | +| 6.4.4 | Custom Operations without associated resources ..... | 364 | +| 6.4.5 | Notifications ..... | 364 | +| 6.4.5.1 | General..... | 364 | +| 6.4.5.2 | Event Occurrence Notification ..... | 365 | +| 6.4.5.3 | Monitoring Revocation Notification..... | 365 | +| 6.4.5.4 | Data Restoration Notification ..... | 366 | +| 6.4.6 | Data Model ..... | 367 | +| 6.4.6.1 | General..... | 367 | +| 6.4.6.2 | Structured data types..... | 369 | +| 6.4.6.2.1 | Introduction ..... | 369 | +| 6.4.6.2.2 | Type: EeSubscription ..... | 370 | +| 6.4.6.2.3 | Type: MonitoringConfiguration ..... | 373 | +| 6.4.6.2.4 | Type: MonitoringReport ..... | 376 | +| 6.4.6.2.5 | Type: Report..... | 377 | +| 6.4.6.2.6 | Type: ReportingOptions..... | 378 | +| 6.4.6.2.7 | Type: ChangeOfSupiPeiAssociationReport..... | 380 | +| 6.4.6.2.8 | Type: RoamingStatusReport ..... | 380 | +| 6.4.6.2.9 | Type: CreatedEeSubscription..... | 381 | +| 6.4.6.2.10 | Type: LocationReportingConfiguration..... | 383 | +| 6.4.6.2.11 | Type: CnTypeChangeReport..... | 383 | +| 6.4.6.2.12 | Type: ReachabilityForSmsReport ..... | 384 | +| 6.4.6.2.13 | Type: DatalinkReportingConfiguration ..... | 384 | +| 6.4.6.2.14 | Type: CmlInfoReport ..... | 384 | +| 6.4.6.2.15 | Type: LossConnectivityCfg ..... | 384 | +| 6.4.6.2.16 | Type: PduSessionStatusCfg ..... | 385 | +| 6.4.6.2.17 | Type: LossConnectivityReport ..... | 385 | +| 6.4.6.2.18 | Type: LocationReport ..... | 385 | +| 6.4.6.2.19 | Type: PdnConnectivityStatReport..... | 385 | +| 6.4.6.2.20 | Type: ReachabilityReport ..... | 385 | +| 6.4.6.2.21 | Type: ReachabilityForDataConfiguration..... | 386 | +| 6.4.6.2.22 | Type: EeMonitoringRevoked..... | 386 | +| 6.4.6.2.23 | Type: MonitoringEvent ..... | 386 | +| 6.4.6.2.24 | Type: FailedMonitoringConfiguration ..... | 387 | +| 6.4.6.2.25 | Type: MonitoringSuspension ..... | 387 | +| 6.4.6.2.26 | Type: GroupMembListChanges..... | 387 | +| 6.4.6.2.27 | Type: EeSubscriptionErrorAddInfo ..... | 388 | +| 6.4.6.2.28 | Type: EeSubscriptionError..... | 388 | +| 6.4.6.3 | Simple data types and enumerations..... | 388 | +| 6.4.6.3.1 | Introduction ..... | 388 | +| 6.4.6.3.2 | Simple data types ..... | 388 | +| 6.4.6.3.3 | Enumeration: EventType..... | 390 | +| 6.4.6.3.4 | Enumeration: LocationAccuracy..... | 393 | +| 6.4.6.3.5 | Enumeration: CnType ..... | 393 | +| 6.4.6.3.6 | Enumeration: AssociationType..... | 393 | +| 6.4.6.3.7 | Enumeration: EventReportMode..... | 393 | +| 6.4.6.3.8 | Enumeration: ReachabilityForSmsConfiguration ..... | 394 | +| 6.4.6.3.9 | Enumeration: PdnConnectivityStatus ..... | 394 | +| 6.4.6.3.10 | Enumeration: ReachabilityForDataReportConfig..... | 394 | +| 6.4.6.3.11 | Enumeration: RevokedCause ..... | 394 | +| 6.4.6.3.12 | Enumeration: FailedCause ..... | 395 | +| 6.4.6.3.13 | Enumeration: SubscriptionType..... | 395 | +| 6.4.7 | Error Handling ..... | 395 | +| 6.4.7.1 | General ..... | 395 | + +| | | | +|------------|------------------------------------------------------|-----| +| 6.4.7.2 | Protocol Errors ..... | 395 | +| 6.4.7.3 | Application Errors..... | 395 | +| 6.4.8 | Feature Negotiation ..... | 397 | +| 6.4.9 | Security ..... | 397 | +| 6.4.10 | HTTP redirection..... | 398 | +| 6.5 | Nudm_ParameterProvision Service API ..... | 398 | +| 6.5.1 | API URI..... | 398 | +| 6.5.2 | Usage of HTTP..... | 398 | +| 6.5.2.1 | General..... | 398 | +| 6.5.2.2 | HTTP standard headers..... | 399 | +| 6.5.2.2.1 | General ..... | 399 | +| 6.5.2.2.2 | Content type ..... | 399 | +| 6.5.2.3 | HTTP custom headers..... | 399 | +| 6.5.2.3.1 | General ..... | 399 | +| 6.5.3 | Resources..... | 399 | +| 6.5.3.1 | Overview..... | 399 | +| 6.5.3.2 | Resource: PpData..... | 401 | +| 6.5.3.2.1 | Description ..... | 401 | +| 6.5.3.2.2 | Resource Definition..... | 401 | +| 6.5.3.2.3 | Resource Standard Methods..... | 401 | +| 6.5.3.3 | Resource: 5GVnGroupConfiguration ..... | 402 | +| 6.5.3.3.1 | Description ..... | 402 | +| 6.5.3.3.2 | Resource Definition..... | 402 | +| 6.5.3.3.3 | Resource Standard Methods..... | 403 | +| 6.5.3.4 | Resource: ParameterProvisioningDataEntry ..... | 405 | +| 6.5.3.4.1 | Description ..... | 405 | +| 6.5.3.4.2 | Resource Definition..... | 406 | +| 6.5.3.4.3 | Resource Standard Methods..... | 406 | +| 6.5.3.5 | Resource: MulticastMbsGroupMemb..... | 408 | +| 6.5.3.5.1 | Description ..... | 408 | +| 6.5.3.5.2 | Resource Definition..... | 408 | +| 6.5.3.5.3 | Resource Standard Methods..... | 408 | +| 6.5.4 | Custom Operations without associated resources ..... | 410 | +| 6.5.5 | Notifications ..... | 411 | +| 6.5.6 | Data Model ..... | 411 | +| 6.5.6.1 | General..... | 411 | +| 6.5.6.2 | Structured data types..... | 412 | +| 6.5.6.2.1 | Introduction ..... | 412 | +| 6.5.6.2.2 | Type: PpData..... | 413 | +| 6.5.6.2.3 | Type: CommunicationCharacteristics ..... | 414 | +| 6.5.6.2.4 | Type: PpSubsRegTimer ..... | 414 | +| 6.5.6.2.5 | Type: PpActiveTime ..... | 415 | +| 6.5.6.2.6 | Type: 5GVnGroupConfiguration ..... | 415 | +| 6.5.6.2.7 | Type: 5GVnGroupData ..... | 417 | +| 6.5.6.2.8 | Type: ExpectedUeBehaviour ..... | 418 | +| 6.5.6.2.9 | Void..... | 419 | +| 6.5.6.2.10 | Type: LocationArea..... | 419 | +| 6.5.6.2.11 | Type: NetworkAreaInfo ..... | 419 | +| 6.5.6.2.12 | Type: EcRestriction..... | 419 | +| 6.5.6.2.13 | Type: PlmnEcInfo ..... | 420 | +| 6.5.6.2.14 | Type: PpDlPacketCountExt ..... | 420 | +| 6.5.6.2.15 | Type: PpMaximumResponseTime..... | 421 | +| 6.5.6.2.16 | Type: PpMaximumLatency..... | 421 | +| 6.5.6.2.17 | Type: LcsPrivacy..... | 422 | +| 6.5.6.2.18 | Type: UmtTime ..... | 422 | +| 6.5.6.2.19 | Type: PpDataEntry ..... | 423 | +| 6.5.6.2.20 | Type: CommunicationCharacteristicsAF ..... | 424 | +| 6.5.6.2.21 | Type: EcsAddrConfigInfo..... | 424 | +| 6.5.6.2.22 | Type: 5MbsAuthorizationInfo..... | 424 | +| 6.5.6.2.23 | Type: MulticastMbsGroupMemb..... | 424 | +| 6.5.6.2.24 | Type: DnnSnssaiSpecificGroup ..... | 425 | +| 6.5.6.2.25 | Type: AfReqDefaultQoS..... | 425 | + +| | | | +|------------|------------------------------------------------------|-----| +| 6.5.6.2.26 | Type: ExpectedUeBehaviourExtension ..... | 425 | +| 6.5.6.2.27 | Type: MbsAssistanceInfo..... | 426 | +| 6.5.6.2.28 | Type: AppSpecificExpectedUeBehaviour ..... | 426 | +| 6.5.6.2.29 | Type: MaxGroupDataRate..... | 426 | +| 6.5.6.2.30 | Type: 5GVnGroupConfigurationModification ..... | 427 | +| 6.5.6.2.31 | Type: 5GVnGroupDataModification ..... | 428 | +| 6.5.6.3 | Simple data types and enumerations..... | 428 | +| 6.5.6.3.1 | Introduction ..... | 428 | +| 6.5.6.3.2 | Simple data types ..... | 429 | +| 6.5.6.3.3 | Void..... | 429 | +| 6.5.6.3.4 | Void..... | 429 | +| 6.5.7 | Error Handling ..... | 429 | +| 6.5.7.1 | General..... | 429 | +| 6.5.7.2 | Protocol Errors ..... | 429 | +| 6.5.7.3 | Application Errors..... | 429 | +| 6.5.8 | Feature Negotiation ..... | 429 | +| 6.5.9 | Security..... | 430 | +| 6.5.10 | HTTP redirection..... | 430 | +| 6.6 | Nudm_NIDDAuthorization Service API ..... | 430 | +| 6.6.1 | API URI..... | 430 | +| 6.6.2 | Usage of HTTP..... | 431 | +| 6.6.2.1 | General..... | 431 | +| 6.6.2.2 | HTTP standard headers..... | 431 | +| 6.6.2.2.1 | General ..... | 431 | +| 6.6.2.2.2 | Content type ..... | 431 | +| 6.6.2.3 | HTTP custom headers..... | 431 | +| 6.6.2.3.1 | General ..... | 431 | +| 6.6.3 | Resources..... | 431 | +| 6.6.3.1 | Overview..... | 431 | +| 6.6.3.2 | Resource: ueIdentity (Document)..... | 432 | +| 6.6.3.2.1 | Description ..... | 432 | +| 6.6.3.2.2 | Resource Definition..... | 432 | +| 6.6.3.2.3 | Resource Standard Methods..... | 432 | +| 6.6.3.2.4 | Resource Custom Operations..... | 432 | +| 6.6.4 | Custom Operations without associated resources ..... | 433 | +| 6.6.5 | Notifications ..... | 433 | +| 6.6.5.1 | General..... | 433 | +| 6.6.5.2 | Nidd Authorization Data Update Notification..... | 433 | +| 6.6.6 | Data Model ..... | 434 | +| 6.6.6.1 | General..... | 434 | +| 6.6.6.2 | Structured data types..... | 435 | +| 6.6.6.2.1 | Introduction ..... | 435 | +| 6.6.6.2.2 | Type: AuthorizationData..... | 435 | +| 6.6.6.2.3 | Type: UserIdIdentifier ..... | 435 | +| 6.6.6.2.4 | Type: NiddAuthUpdateInfo ..... | 435 | +| 6.6.6.2.5 | Type: NiddAuthUpdateNotification..... | 436 | +| 6.6.6.2.6 | Type: AuthorizationInfo..... | 436 | +| 6.6.6.3 | Simple data types and enumerations..... | 436 | +| 6.6.6.3.1 | Introduction ..... | 436 | +| 6.6.6.3.2 | Simple data types ..... | 437 | +| 6.6.6.3.3 | Enumeration: NiddCause ..... | 437 | +| 6.6.7 | Error Handling ..... | 437 | +| 6.6.7.1 | General..... | 437 | +| 6.6.7.2 | Protocol Errors ..... | 437 | +| 6.6.7.3 | Application Errors..... | 437 | +| 6.6.8 | Feature Negotiation ..... | 437 | +| 6.6.9 | Security..... | 438 | +| 6.6.10 | HTTP redirection..... | 438 | +| 6.7 | Nudm_MT Service API ..... | 438 | +| 6.7.1 | API URI..... | 438 | +| 6.7.2 | Usage of HTTP..... | 438 | +| 6.7.2.1 | General..... | 438 | + +| | | | +|-----------|------------------------------------------------------|-----| +| 6.7.2.2 | HTTP standard headers..... | 439 | +| 6.7.2.2.1 | General ..... | 439 | +| 6.7.2.2.2 | Content type ..... | 439 | +| 6.7.2.3 | HTTP custom headers..... | 439 | +| 6.7.2.3.1 | General ..... | 439 | +| 6.7.3 | Resources..... | 439 | +| 6.7.3.1 | Overview..... | 439 | +| 6.7.3.2 | Resource: UeInfo ..... | 440 | +| 6.7.3.2.1 | Description ..... | 440 | +| 6.7.3.2.2 | Resource Definition..... | 440 | +| 6.7.3.2.3 | Resource Standard Methods..... | 440 | +| 6.7.3.3 | Resource: LocationInfo..... | 441 | +| 6.7.3.3.1 | Description ..... | 441 | +| 6.7.3.3.2 | Resource Definition..... | 441 | +| 6.7.3.3.3 | Resource Standard Methods..... | 441 | +| 6.7.3.3.4 | Resource Custom Operations..... | 441 | +| 6.7.4 | Custom Operations without associated resources ..... | 442 | +| 6.7.5 | Notifications ..... | 442 | +| 6.7.6 | Data Model ..... | 442 | +| 6.7.6.1 | General..... | 442 | +| 6.7.6.2 | Structured data types..... | 443 | +| 6.7.6.2.1 | Introduction ..... | 443 | +| 6.7.6.2.2 | Type: UeInfo ..... | 443 | +| 6.7.6.2.3 | Type: LocationInfoRequest..... | 444 | +| 6.7.6.2.4 | Type: LocationInfoResult ..... | 445 | +| 6.7.6.2.5 | Type: 5GSrvccInfo ..... | 445 | +| 6.7.6.3 | Simple data types and enumerations..... | 445 | +| 6.7.7 | Error Handling ..... | 445 | +| 6.7.7.1 | General..... | 445 | +| 6.7.7.2 | Protocol Errors ..... | 445 | +| 6.7.7.3 | Application Errors..... | 445 | +| 6.7.8 | Feature Negotiation ..... | 446 | +| 6.7.9 | Security ..... | 446 | +| 6.7.10 | HTTP redirection..... | 446 | +| 6.8 | Nudm_ServiceSpecificAuthorization Service API ..... | 446 | +| 6.8.1 | API URI..... | 446 | +| 6.8.2 | Usage of HTTP..... | 447 | +| 6.8.2.1 | General..... | 447 | +| 6.8.2.2 | HTTP standard headers..... | 447 | +| 6.8.2.2.1 | General ..... | 447 | +| 6.8.2.2.2 | Content type ..... | 447 | +| 6.8.2.3 | HTTP custom headers..... | 447 | +| 6.8.2.3.1 | General ..... | 447 | +| 6.8.3 | Resources..... | 447 | +| 6.8.3.1 | Overview..... | 447 | +| 6.8.3.2 | Resource: ServiceType (Document)..... | 448 | +| 6.8.3.2.1 | Description ..... | 448 | +| 6.8.3.2.2 | Resource Definition..... | 448 | +| 6.8.3.2.3 | Resource Standard Methods..... | 448 | +| 6.8.3.2.4 | Resource Custom Operations..... | 449 | +| 6.8.4 | Custom Operations without associated resources ..... | 450 | +| 6.8.5 | Notifications ..... | 450 | +| 6.8.5.1 | General..... | 450 | +| 6.8.5.2 | Service Specific Data Update Notification..... | 450 | + +| | | | +|------------|------------------------------------------------------|-----| +| 6.8.6 | Data Model ..... | 451 | +| 6.8.6.1 | General ..... | 451 | +| 6.8.6.2 | Structured data types ..... | 452 | +| 6.8.6.2.1 | Introduction ..... | 452 | +| 6.8.6.2.2 | Type: AuthUpdateNotification ..... | 452 | +| 6.8.6.2.3 | Type: AuthUpdateInfo ..... | 452 | +| 6.8.6.2.4 | Type: ServiceSpecificAuthorizationInfo ..... | 453 | +| 6.8.6.2.5 | Type: ServicepecificAuthorizationData ..... | 453 | +| 6.8.6.2.6 | Type: AuthorizationUeId ..... | 454 | +| 6.8.6.2.7 | Type: ServicepecificAuthorizationRemoveData ..... | 454 | +| 6.8.6.3 | Simple data types and enumerations ..... | 454 | +| 6.8.6.3.1 | Introduction ..... | 454 | +| 6.8.6.3.2 | Enumeration: ServiceType ..... | 454 | +| 6.8.6.3.3 | Enumeration: InvalidCause ..... | 454 | +| 6.8.7 | Error Handling ..... | 454 | +| 6.8.7.1 | General ..... | 454 | +| 6.8.7.2 | Protocol Errors ..... | 454 | +| 6.8.7.3 | Application Errors ..... | 455 | +| 6.8.8 | Feature Negotiation ..... | 455 | +| 6.8.9 | Security ..... | 455 | +| 6.8.10 | HTTP redirection ..... | 455 | +| 6.9 | Nudm_ReportSMDeliveryStatus Service API ..... | 456 | +| 6.9.1 | API URI ..... | 456 | +| 6.9.2 | Usage of HTTP ..... | 456 | +| 6.9.2.1 | General ..... | 456 | +| 6.9.2.2 | HTTP standard headers ..... | 456 | +| 6.9.2.2.1 | General ..... | 456 | +| 6.9.2.2.2 | Content type ..... | 456 | +| 6.9.2.3 | HTTP custom headers ..... | 456 | +| 6.9.2.3.1 | General ..... | 456 | +| 6.9.3 | Resources ..... | 457 | +| 6.9.3.1 | Overview ..... | 457 | +| 6.9.3.2 | Resource: SmDeliveryStatus (Document) ..... | 457 | +| 6.9.3.2.1 | Description ..... | 457 | +| 6.9.3.2.2 | Resource Definiton ..... | 457 | +| 6.9.3.2.3 | Resource Standard Methods ..... | 457 | +| 6.9.3.2.4 | Resource Custom Operations ..... | 458 | +| 6.9.4 | Custom Operations without associated resources ..... | 458 | +| 6.9.5 | Notifications ..... | 458 | +| 6.9.6 | Data Model ..... | 458 | +| 6.9.6.1 | General ..... | 458 | +| 6.9.6.2 | Structured data types ..... | 459 | +| 6.9.6.2.1 | Introduction ..... | 459 | +| 6.9.6.2.2 | Type: SmDeliveryStatus ..... | 459 | +| 6.9.6.3 | Simple data types and enumerations ..... | 459 | +| 6.9.6.3.1 | Introduction ..... | 459 | +| 6.9.7 | Error Handling ..... | 459 | +| 6.9.7.1 | General ..... | 459 | +| 6.9.7.2 | Protocol Errors ..... | 459 | +| 6.9.7.3 | Application Errors ..... | 459 | +| 6.9.8 | Feature Negotiation ..... | 460 | +| 6.9.9 | Security ..... | 460 | +| 6.9.10 | HTTP redirection ..... | 460 | +| 6.10 | Nudm_UEIdentifier Service API ..... | 460 | +| 6.10.1 | API URI ..... | 460 | +| 6.10.2 | Usage of HTTP ..... | 461 | +| 6.10.2.1 | General ..... | 461 | +| 6.10.2.2 | HTTP standard headers ..... | 461 | +| 6.10.2.2.1 | General ..... | 461 | +| 6.10.2.2.2 | Content type ..... | 461 | +| 6.10.2.3 | HTTP custom headers ..... | 461 | +| 6.10.2.3.1 | General ..... | 461 | + +| | | | +|-------------------------------|------------------------------------------------------|------------| +| 6.10.3 | Resources..... | 461 | +| 6.10.3.1 | Overview..... | 461 | +| 6.10.4 | Custom Operations without associated resources ..... | 462 | +| 6.10.4.1 | Overview..... | 462 | +| 6.10.4.2 | Operation: Deconceal ..... | 462 | +| 6.10.4.2.1 | Description ..... | 462 | +| 6.10.4.2.2 | Operation Definition ..... | 462 | +| 6.10.5 | Notifications ..... | 463 | +| 6.10.6 | Data Model ..... | 463 | +| 6.10.6.1 | General..... | 463 | +| 6.10.6.2 | Structured data types..... | 463 | +| 6.10.6.2.1 | Introduction ..... | 463 | +| 6.10.6.2.2 | Type: DeconcealReqData..... | 464 | +| 6.10.6.2.3 | Type: DeconcealRspData..... | 464 | +| 6.10.6.3 | Simple data types and enumerations..... | 464 | +| 6.10.6.3.1 | Introduction ..... | 464 | +| 6.10.7 | Error Handling ..... | 464 | +| 6.10.7.1 | General..... | 464 | +| 6.10.7.2 | Protocol Errors ..... | 464 | +| 6.10.7.3 | Application Errors..... | 464 | +| 6.10.8 | Feature Negotiation ..... | 464 | +| 6.10.9 | Security..... | 465 | +| Annex A (normative): | OpenAPI specification ..... | 465 | +| A.1 | General..... | 465 | +| A.2 | Nudm_SDM API..... | 465 | +| A.3 | Nudm_UECM API..... | 535 | +| A.4 | Nudm_UEAU API..... | 582 | +| A.5 | Nudm_EE API ..... | 595 | +| A.6 | Nudm_PP API..... | 610 | +| A.7 | Nudm_NIDDAU API ..... | 626 | +| A.8 | Nudm_MT API ..... | 629 | +| A.9 | Nudm_SSAU API..... | 632 | +| A.10 | Nudm_ReportSMDeliveryStatus API..... | 636 | +| A.11 | Nudm_UEIdentifier API..... | 638 | +| Annex B (informative): | Stateless UDMs ..... | 639 | +| Annex C (informative): | SUCI encoding..... | 643 | +| Annex D (informative): | Change history..... | 646 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nudm Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the UDM. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 33.501: "Security Architecture and Procedures for 5G System". +- [7] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [8] 3GPP TS 23.003: "Numbering, addressing and identification". +- [9] 3GPP TS 29.504: "5G System; Unified Data Repository Services; Stage 3". +- [10] 3GPP TS 29.505: "5G System; Usage of the Unified Data Repository Services for Subscription Data; Stage 3". +- [11] 3GPP TS 32.255: "Charging management; 5G data connectivity domain charging". +- [12] 3GPP TS 32.298: "Charging management; Charging Data Record (CDR) parameter description". +- [13] IETF RFC 9113: "HTTP/2". +- [14] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", . + +- [15] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [16] IETF RFC 9457: "Problem Details for HTTP APIs". +- [17] IETF RFC 7396: "JSON Merge Patch". +- [18] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [19] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [20] 3GPP TS 23.122: "Non-Access-Stratum (NAS) functions related to Mobile Station in idle mode". +- [21] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [22] 3GPP TS 29.338: "Diameter based protocols to support Short Message Service (SMS) capable Mobile Management Entities (MMEs)" +- [23] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [24] 3GPP TS 29.509: "Authentication Server Services; Stage 3". +- [25] Void +- [26] IETF RFC 9111: "HTTP Caching". +- [27] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [28] ETSI TS 102 225: "Smart Cards; Secured packet structure for UICC based applications". +- [29] IETF RFC 7542: "The Network Access Identifier". +- [30] 3GPP TR 21.900: "Technical Specification Group working methods". +- [31] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [32] 3GPP TS 23.632: "User Data Interworking, Coexistence and Migration" +- [33] 3GPP TS 29.519: "Policy Data, Application Data and Structured Data for Exposure; Stage 3". +- [34] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". +- [35] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [36] 3GPP TS 29.518: "Access and Mobility Management Services". +- [37] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS); Stage 2". +- [38] 3GPP TS 23.273: "5G System (5GS) Location Services (LCS); Stage 2". +- [39] 3GPP TS 29.515: "5G System; Gateway Mobile Location Services; Stage 3". +- [40] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [41] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [42] BBF TR-069: "CPE WAN Management Protocol". +- [43] BBF TR-369: "User Services Platform (USP)". +- [44] 3GPP TS 29.524: "5G System; Cause codes mapping between 5GC interfaces; Stage 3". +- [45] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [46] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [47] 3GPP TS 22.071: "Location Services (LCS); Service description; Stage 1". + +- [48] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [49] 3GPP TS 24.302: "Access to the 3GPP Evolved Packet Core (EPC) via non-3GPP access networks". +- [50] IETF RFC 9110: "http Semantics". +- [51] 3GPP TS 23.287: "Architecture enhancements for 5G System (5GS) to support Vehicle-to-Everything (V2X) services". +- [52] 3GPP TS 29.328: "IP Multimedia (IM) Subsystem Sh interface; Signalling flows and message contents". +- [53] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)". +- [54] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [55] 3GPP TS 33.535: "Authentication and Key Management for Applications (AKMA) based on 3GPP credentials in the 5G System (5GS)". +- [56] 3GPP TS 37.355: "LTE Positioning Protocol (LPP)". +- [57] 3GPP TS 23.304: "Proximity based Services (ProSe) in the 5G System (5GS)". +- [58] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [59] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services; Stage 2". +- [60] 3GPP TS 23.548: "5G System Enhancements for Edge Computing; Stage 2". +- [61] 3GPP TS 33.220: "Generic Authentication Architecture (GAA); Generic Bootstrapping Architecture (GBA)". +- [62] 3GPP TS 29.563: "5G System; Home Subscriber Server (HSS) services for interworking with Unified Data Management (UDM); Stage 3" +- [63] 3GPP TS 33.558: "Security aspects of enhancement of support for enabling edge applications; Stage 2". +- [64] 3GPP TS 33.503: " Security Aspects of Proximity based Services (ProSe) in the 5G System (5GS)". +- [65] 3GPP TS 29.562: "5G System; Home Subscriber Server (HSS) Services; Stage 3" +- [66] 3GPP TS 23.540: " 5G System; Technical realization of Service Based Short Message Service; Stage 2". +- [67] 3GPP TS 32.256: "Charging management; 5G connection and mobility domain charging; Stage 2". +- [68] 3GPP TS 29.514: " 5G System; Policy Authorization Service; Stage 3". +- [69] Void +- [70] 3GPP TS 23.256: "Support of Uncrewed Aerial Systems (UAS) connectivity, identification and tracking; Stage 2". +- [71] 3GPP TS 23.015: " Technical realization of Operator Determined Barring (ODB)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|----------------------------------------------------| +| 5GC | 5G Core Network | +| 5G PKMF | 5G ProSe Key Management Function | +| 5G ProSe | 5G Proximity-based Services | +| ACS | Auto-Configuration Server | +| AKMA | Authentication and Key Management for Applications | +| AMF | Access and Mobility Management Function | +| AUSF | Authentication Server Function | +| DCCF | Data Collection Coordination Function | +| DNN | Data Network Name | +| EES | Edge Enabler Server | +| FQDN | Fully Qualified Domain Name | +| FN-RG | Fixed Network RG | +| GMLC | Gateway Mobile Location Centre | +| GPSI | Generic Public Subscription Identifier | +| GUAMI | Globally Unique AMF Identifier | +| HGMLC | Home GMLC | +| JSON | Javascript Object Notation | +| LCS | LoCation Services | +| LPHAP | Low Power and High Accuracy Positioning | +| LPI | LCS Privacy Indicator | +| MICO | Mobile Initiated Connection Only | +| N5GC | Non-5G-Capable | +| NAI | Network Access Identifier | +| NAS | Non-Access Stratum | +| NEF | Network Exposure Function | +| NIDD | Non-IP Data Delivery | +| NRF | Network Repository Function | +| NSSAI | Network Slice Selection Assistance Information | +| NWDAF | Network Data Analytics Function | +| PEI | Permanent Equipment Identifier | +| PIN | Personal IoT Network | +| PRU | Position Reference Unit | +| QFI | QoS Flow Identifier | +| 5G-RG | 5G Residential Gateway | +| RG | Residential Gateway | +| SBI | Service Based Interface | +| SLPKMF | SideLink Positioning Key Management Function | +| SMF | Session Management Function | +| SMSF | Short Message Service Function | +| SUCI | Subscription Concealed Identifier | +| SUPI | Subscription Permanent Identifier | +| UDM | Unified Data Management | +| UDR | Unified Data Repository | +| W-AGF | Wireline Access Gateway Function | + +# --- 4 Overview + +## 4.1 Introduction + +Within the 5GC, the UDM offers services to the AMF, SMF, SMSF, NEF, GMLC, NWDAF, AUSF, HSS, GBA's BSF, SMS-GMSC, DCCF, 5GDDNMF, PAnF and 5G PKMF via the Nudm service-based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3], 3GPP TS 23.288 [35], GPP TS 23.304 [57], 3GPP TS 23.540 [66], and 3GPP TS 33.503[64]). + +Figure 4.1-1 provides the reference model (in service-based interface representation and in reference point representation), with focus on the UDM. + +![Reference model diagram showing various network functions connected to a central UDM via a Nudm interface.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +The diagram illustrates the reference model for the User Data Management (UDM) function. On the left, a vertical column of 19 network functions is shown, each connected to a central 'Nudm' interface. The functions and their associated interfaces are: DCCF (N8), NWDCAF (N10), AMF (N21), SMF (N13), SMSF (N52), AUSF (NL6), NEF (NU1), GMLC (N68), HSS (Npc4), GBA's BSF (N87), 5G DNNMF (SM1), TSCTSF (Npc10), SMS-GMSC (Npc12), 5G PKMF (Npc13), PANF, AAnF, and SLPKMF. The 'Nudm' interface is represented by a small circle, and the 'UDM' function is represented by a green rectangular box on the right. + +Reference model diagram showing various network functions connected to a central UDM via a Nudm interface. + +**Figure 4.1-1: Reference model – UDM** + +The functionalities supported by the UDM are listed in clause 6.2.7 of 3GPP TS 23.501 [2]. + +# --- 5 Services offered by the UDM + +## 5.1 Introduction + +The UDM offers the following services via the Nudm interface: + +- Nudm\_SubscriberDataManagement Service +- Nudm\_UEContextManagement Service +- Nudm\_UEAuthentication Service +- Nudm\_EventExposure Service +- Nudm\_ParameterProvision Service +- Nudm\_NIDDAuthorization Service +- Nudm\_MT Service +- Nudm\_ServiceSpecificAuthorization Service +- Nudm\_ReportSMDeliveryStatus Service +- Nudm\_UEIdentifier Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-----------------------------------|---------------|--------------------------------------------|-----------------------------------|----------------|--------------| +| Nudm_SubscriberDataManagement | 6.1 | UDM Subscriber Data Management Service | TS29503_Nudm_SDM.yaml | nudm-sdm | A.2 | +| Nudm_UEContextManagement | 6.2 | UDM Context Management Service | TS29503_Nudm_UECM.yaml | nudm-uecm | A.3 | +| Nudm_UEAuthentication | 6.3 | UDM UE Authentication Service | TS29503_Nudm_UEAU.yaml | nudm-ueau | A.4 | +| Nudm_EventExposure | 6.4 | UDM Event Exposure Service | TS29503_Nudm_EE.yaml | nudm-ee | A.5 | +| Nudm_ParameterProvision | 6.5 | UDM Parameter Provision Service | TS29503_Nudm_PP.yaml | nudm-pp | A.6 | +| Nudm_NIDDAuthorization | 6.6 | UDM NIDD Authorization Service | TS29503_Nudm_NIDDAU.yaml | nudm-niddau | A.7 | +| Nudm_MT | 6.7 | UDM MT Service | TS29503_Nudm_MT.yaml | nudm-mt | A.8 | +| Nudm_ServiceSpecificAuthorization | 6.8 | UDM Service Specific Authorization Service | TS29503_Nudm_SSAU.yaml | nudm-ssau | A.9 | +| Nudm_ReportSMDeliveryStatus | 6.9 | UDM Report SM-Delivery Status Service | TS29503_Nudm_RSDS.yaml | nudm-rsds | A.10 | +| Nudm_UEIdentifier | 6.10 | UDM UE Identifier Service | TS29503_Nudm_UEID.yaml | nudm-ueid | A.11 | + +All scenarios shown in the following clauses assume that the UDM is stateful and stores information in local memory. However, the UDM may be stateless and stores information externally in the UDR. If so, the stateless UDM makes use of Nudr services as specified in 3GPP TS 29.504 [9] and 3GPP TS 29.505 [10] to retrieve required data from the UDR and store them locally before processing an incoming request. Processing the incoming request may then include updating data in the UDR or subscribing to data change notifications at the UDR by consuming the appropriate Nudr services. After processing the incoming request, the UDM may delete the locally stored data. When data stored in UDR is then shared among the different UDM instances of the same group, as identified by UDM Group ID (see 3GPP TS 23.501 [2], clause 6.2.6), bulk subscriptions, as described in clause 4.15.3.2.4 of 3GPP TS 23.502 [3], are not applicable, i.e. an NF consumer (e.g. NEF) only subscribes towards one of the UDM instances within the group. See Annex B. + +## 5.2 Nudm\_SubscriberDataManagement Service + +### 5.2.1 Service Description + +See 3GPP TS 23.501 [2] table 7.2.5-1. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nudm\_SubscriberDataManagement service the following service operations are defined: + +- Get +- Subscribe +- ModifySubscription +- Unsubscribe +- Notification +- Info + +The Nudm\_SubscriberDataManagement Service is used by Consumer NFs (AMF, AAnF, SMF, SMSF, GMLC, NEF, 5G DDNMF, NWDAF, DCCF, trusted AF) to retrieve the UE's individual subscription data relevant to the consumer NF from the UDM by means of the Get service operation. If the consumer NF supports the feature "sharedData" (see clause 6.1.8), the retrieved individual subscription data for the UE may contain shared data identifier identifying additional parts of subscription data shared by several UEs. If so, the Nudm\_SubscriberDataManagement Service is also used by Consumer NFs to retrieve shared subscription data from the UDM by means of the Get service operation unless the shared data is already cached. The retrieved shared data shall be cached as long as the consumer NF serves an UE for which the shared data is relevant. + +It is also used by Consumer NFs to subscribe to notifications of data change by means of the Subscribe service operation. If the consumer NF supports the feature "sharedData" (see clause 6.1.8), the consumer NF may also subscribe to notifications of shared data change by means of the Subscribe service operation. + +It is also used to modify an existing subscription by means of the ModifySubscription service operation. If the consumer NF supports the feature "sharedData" (see clause 6.1.8), the consumer NF may also modify an existing subscription to notifications of shared data change by means of the ModifySubscription service operation. + +It is also used to unsubscribe from notifications of data changes by means of the Unsubscribe service operation. If the feature "sharedData" (see clause 6.1.8) is supported, it may also be used to unsubscribe from notifications of shared data changes by means of the Unsubscribe service operation. + +It is also used by the Consumer NFs (AMF, SMF, SMSF, NEF, GMLC, 5G DDNMF, NWDAF, DCCF, trusted AF) that have previously subscribed, to get notified by means of the Notification service operation when UDM decides to modify the subscribed data. If the feature "sharedData" (see clause 6.1.8) is supported by the consumer NF and the consumer NF has previously subscribed to notifications of shared data change, it is also used by the consumer NF to get notified by means of the Notification service operation when the UDM decides to modify the subscribed shared data. + +It is also used by Consumer NFs to provide the information about the status of the subscription data management procedures. + +#### 5.2.2.2 Get + +##### 5.2.2.2.1 General + +The following procedures using the Get service operation are supported: + +- Slice Selection Subscription Data Retrieval +- Access and Mobility Subscription Data Retrieval +- SMF Selection Subscription Data Retrieval +- Session Management Subscription Data Retrieval +- SMS Subscription Data Retrieval + +- SMS Management Subscription Data Retrieval +- UE Context in SMF Data Retrieval +- UE Context in SMSF Data Retrieval +- Retrieval Of Multiple Data Sets +- Identifier Translation +- Shared Subscription Data Retrieval +- Trace Data Retrieval +- LCS Privacy Data Retrieval +- Group Identifier Translation +- LCS Mobile Originated Data Retrieval +- Enhanced Coverage Restriction Data Retrieval +- V2X Subscription Data Retrieval +- LCS Broadcast Assistance Subscription Data Retrieval +- UE Context in AMF Data Retrieval +- ProSe Subscription Data Retrieval +- Individual Shared Subscription Data Retrieval +- 5MBS Subscription Data Retrieval +- User Consent Subscription Data Retrieval +- Multiple Identifiers Translation +- Time Synchronization Subscription Data Retrieval +- UE LCS Subscriber Data Retrieval +- Ranging and Sidelink Positioning Subscription Data Retrieval +- A2X Subscription Data Retrieval + +When the feature SharedData (see clause 6.1.8) is supported and the retrieved UE-individual data (i.e. data other than Shared Subscription Data) contain SharedDataIds, the NF service consumer shall also retrieve the shared data identified by the received shared data Ids unless the identified shared data are already available at the NF service consumer. The order of sequence of sharedDataIds within UE-individual data is significant: Individual data take precedence over shared data unless the feature SharedDataTreatment is supported in which case treatment instructions may be applicable; shared data "SharedDataX" identified by a sharedDataId X takes precedence over shared data "SharedDataY" identified by a sharedDataId Y if X appears immediately before Y within the list of SharedDataIds in the UE-individual data unless the feature SharedDataTreatment is supported in which case the treatment instructions associated to SharedDataY are applicable after treatment instructions associated to SharedDataX have been applied. + +##### 5.2.2.2.2 Slice Selection Subscription Data Retrieval + +Figure 5.2.2.2.2-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE's NSSAI (see also clause 5.15.5.2.1 of 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3] figure 4.2.2.2.3-1 step 3). In this example scenario the NSSAI is retrieved by the AMF, see clause 6.1.3.2.1 for other scenarios that can retrieve the NSSAI. The request contains the UE's identity (/{supi}), the type of the requested information (/nssai) and query parameters (supported-features, plmn-id). + +![Sequence diagram for Figure 5.2.2.2.2-1: Requesting a UE's NSSAI. The diagram shows an NF service consumer sending a GET request to a UDM. The UDM responds with either a 200 OK (Nssai) or a 404 Not Found.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. GET .../{supi}/nssai + NF service consumer->>UDM: 1. GET .../{supi}/nssai + Note right of UDM: 2a. 200 OK (Nssai) + UDM-->>NF service consumer: 2a. 200 OK (Nssai) + Note right of UDM: 2b. 404 Not Found + UDM-->>NF service consumer: 2b. 404 Not Found + +``` + +Sequence diagram for Figure 5.2.2.2.2-1: Requesting a UE's NSSAI. The diagram shows an NF service consumer sending a GET request to a UDM. The UDM responds with either a 200 OK (Nssai) or a 404 Not Found. + +**Figure 5.2.2.2.2-1: Requesting a UE's NSSAI** + +1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the UE's subscribed NSSAI, with query parameters indicating the supported-features and/or plmn-id. +- 2a. On success, the UDM responds with "200 OK" with the message body containing the UE's NSSAI as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.3 Access and Mobility Subscription Data Retrieval + +Figure 5.2.2.2.3-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE's Access and Mobility Subscription data (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains the UE's identity (/{supi}), the type of the requested information (/am-data) and query parameters (supported-features, plmn-id, shared-data-ids). + +![Sequence diagram for Figure 5.2.2.2.3-1: Requesting a UE's Access and Mobility Subscription Data. The diagram shows an NF service consumer sending a GET request to a UDM. The UDM responds with either a 200 OK (AccessAndMobilitySubscriptionData), a 404 Not Found, or a 4xx/5xx (Problem Details) or 3xx.](c036e2540a94b31357ceb0002f0cacab_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. GET .../{supi}/am-data + NF service consumer->>UDM: 1. GET .../{supi}/am-data + Note right of UDM: 2a. 200 OK (AccessAndMobilitySubscriptionData) + UDM-->>NF service consumer: 2a. 200 OK (AccessAndMobilitySubscriptionData) + Note right of UDM: 2b. 404 Not Found + UDM-->>NF service consumer: 2b. 404 Not Found + Note right of UDM: 2c. 4xx/5xx (Problem Details) or 3xx + UDM-->>NF service consumer: 2c. 4xx/5xx (Problem Details) or 3xx + +``` + +Sequence diagram for Figure 5.2.2.2.3-1: Requesting a UE's Access and Mobility Subscription Data. The diagram shows an NF service consumer sending a GET request to a UDM. The UDM responds with either a 200 OK (AccessAndMobilitySubscriptionData), a 404 Not Found, or a 4xx/5xx (Problem Details) or 3xx. + +**Figure 5.2.2.2.3-1: Requesting a UE's Access and Mobility Subscription Data** + +1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the UE's Access and Mobility Subscription Data, with query parameters indicating the supported-features and/or plmn-id and/or shared-data-ids. + +The optional query parameter shared-data-ids may be included by the NF service consumer to indicate to the UDM that shared AccessAndMobilitySubscriptionData identified by the shared-data-ids are already available at the NF service consumer. + +- 2a. On Success, the UDM responds with "200 OK" with the message body containing the UE's Access and Mobility Subscription Data as relevant for the requesting NF service consumer. If the UE's Access and Mobility Subscription Data contains the attribute sharedAmDataIDs identifying shared AccessAndMobilitySubscriptionData, and those are not already available at the NF consumer (i.e. the shared data IDs are not included in the shared-data-ids query parameter in the GET request message), the UE's Access and Mobility Subscription Data sent in the 200 OK message body may also contain a list of shared Access And Mobility Subscription data relevant to the UE but not yet available at the NF service consumer. + +NOTE 1: If the UDM initiated a request to obtain SoR information from the SOR-AF, the UDM starts an operator configurable timer up to which the UDM shall wait for a response from the SOR-AF for retrieving the SoR information. The UDM responds back to the NF service consumer for Access and Mobility Subscription Data Retrieval service operation before the timer expires. If the SOR-AF has not provided a response with the SoR information before the timer expires, the UDM shall behave as specified in clause C.2 of 3GPP TS 23.122 [20] (step 3d). As described in clause C.2 of 3GPP TS 23.122 [20] (step 4), if UDM supports SOR-CMCI, then UDM indicates in the response to NF service consumer (i.e. AMF) to send acknowledgement that will include the "ME support of SOR-CMCI". UDM will also delete the "ME support of SOR-CMCI" updating AuthenticationSoR of Nudr\_DataRepository service as specified in 3GPP TS 29.505 [10] clause 5.2.25, if the UE is performing initial registration or emergency registration. UDM will decide whether to provide SOR-CMCI based on "usimSupportOfSorCmci" retrieved via AuthenticationSoR of Nudr\_DataRepository service as specified in 3GPP TS 29.505 [10] clause 5.2.25. + +2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +NOTE 2: Upon reception of any Nudm\_EventExposure operation or Nudm\_PP operation, or when the validity of an event subscription or provisioned parameter with its associated maximum latency, maximum response time or DL Buffering Suggested Packet Count value expires, UDM may need to adjust the values of active time and/or periodic registration timer and/or DL Buffering Suggested Packet Count. The UDM shall notify AMF and/or SMF if the values are updated (see clause 4.15.3.2.3b and 4.15.6.3a of 3GPP TS 23.502 [3]). + +NOTE 3: If UPU data have previously been provisioned, but have not yet been acknowledged by the UE, e.g. because no AMF was registered at provisioning time, the UDM needs to convey the UPU data (after AUSF protection) within 200 OK AccessAndMobilitySubscriptionDatato to the AMF. + +2c. On failure or redirection, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.4 SMF Selection Subscription Data Retrieval + +Figure 5.2.2.2.4-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE's SMF Selection Subscription data (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains the UE's identity (/{supi}), the type of the requested information (/smf-select-data) and query parameters (supported-features, plmn-id). + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for SMF Selection Subscription Data Retrieval. The NF service consumer sends a GET request to the UDM. The UDM responds with either a 200 OK (SmfSelectionSubscriptionData) or a 404 Not Found.](70de8885bd7de15723aaad5eb5c5febf_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant UDM + Note left of NF: Request SMF Selection Subscription Data + NF->>UDM: 1. GET .../{supi}/smf-select-data + Note right of UDM: Success or Failure + UDM-->>NF: 2a. 200 OK (SmfSelectionSubscriptionData) + Note right of UDM: Failure + UDM-->>NF: 2b. 404 Not Found + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for SMF Selection Subscription Data Retrieval. The NF service consumer sends a GET request to the UDM. The UDM responds with either a 200 OK (SmfSelectionSubscriptionData) or a 404 Not Found. + +**Figure 5.2.2.2.4-1: Requesting a UE's SMF Selection Subscription Data** + +1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the UE's SMF Selection Subscription Data, with query parameters indicating the supported-features and/or plmn-id. + +2a. On success, the UDM responds with "200 OK" with the message body containing the UE's SMF Selection Subscription Data as relevant for the requesting NF service consumer. + +2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.5 Session Management Subscription Data Retrieval + +Figure 5.2.2.2.5-1 shows a scenario where the NF service consumer (e.g. SMF) sends a request to the UDM to receive the UE's session management subscription data (see also 3GPP TS 23.502 [3] figure 4.3.2.2.1-1 step 4a-4b). The request contains the UE's identity (/{supi}), the type of the requested information (/sm-data), and query parameters (single-nssai, dnn, supported-features, plmn-id). + +![Sequence diagram for Session Management Subscription Data Retrieval](a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../{supi}/sm-data? + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (SmSubsData) + Note right of UDM: + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for session management subscription data. The UDM responds with either a 200 OK (SmSubsData) or a 404 Not Found status. + +Sequence diagram for Session Management Subscription Data Retrieval + +**Figure 5.2.2.2.5-1: Requesting a UE's Session Management Subscription Data** + +1. The NF service consumer (e.g. SMF) sends a GET request to the resource representing the UE's session management subscription data, with query parameters indicating the selected network slice and/or the DNN and/or supported-features and/or plmn-id. +- 2a. On success, the UDM responds with "200 OK", the message body containing the UE's session management subscription data (an array of SessionManagementSubscriptionData objects and/or SharedDataIds, one array element per S-NSSAI) as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data for the UE, or if the UE subscription data exists, but the requested session management subscription is not available (e.g. query parameter contains network slice and/or DNN that does not belong to the UE subscription), HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.6 SMS Subscription Data Retrieval + +Figure 5.2.2.2.6-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE's SMS Subscription Data (see also 3GPP TS 23.502 [3], clause 4.13.3.1). The request contains the UE's identity (/{supi}) and the type of the requested information (/sms-data). + +![Sequence diagram for SMS Subscription Data Retrieval](96b0240f56d14453b5da05ec30fd5c6e_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant UDM + Note left of NF Service Consumer: + NF Service Consumer->>UDM: 1. GET .../{supi}/sms-data + Note right of UDM: + UDM-->>NF Service Consumer: 2. 200 OK (SmsSubscriptionData) +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer and a UDM. The NF Service Consumer sends a GET request to the UDM for SMS subscription data. The UDM responds with a 200 OK (SmsSubscriptionData) status. + +Sequence diagram for SMS Subscription Data Retrieval + +**Figure 5.2.2.2.6-1: Requesting UE's SMS Subscription Data** + +1. The NF Service Consumer (e.g. AMF) sends a GET request to the resource representing the UE's SMS Subscription Data. +2. The UDM responds with "200 OK" with the message body containing the UE's SMS Subscription Data. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.7 SMS Management Subscription Data Retrieval + +Figure 5.2.2.2.7-1 shows a scenario where the NF service consumer (e.g. SMSF) sends a request to the UDM to receive the UE's SMS Management Subscription Data (see also 3GPP TS 23.502 [3], clause 4.13.3.1). The request contains the UE's identity (*{supi}*) and the type of the requested information (*/sms-mng-data*). + +![Sequence diagram for SMS Management Subscription Data Retrieval](33a8f3f01dfa8bce75d23017855a13c5_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant UDM + Note left of NF Service Consumer: + NF Service Consumer->>UDM: 1. GET .../{supi}/sms-mng-data + Note right of UDM: + UDM-->>NF Service Consumer: 2. 200 OK (SmsManagementSubscriptionData) +``` + +The diagram shows a sequence of two messages between an NF Service Consumer and a UDM. The NF Service Consumer sends a GET request to the UDM for the resource *.../{supi}/sms-mng-data*. The UDM responds with a 200 OK status code and a message body containing the *SmsManagementSubscriptionData*. + +Sequence diagram for SMS Management Subscription Data Retrieval + +**Figure 5.2.2.2.7-1: Requesting UE's SMS Management Subscription Data** + +1. The NF Service Consumer (e.g. SMSF) sends a GET request to the resource representing the UE's SMS Management Subscription Data. +2. The UDM responds with "200 OK" with the message body containing the UE's SMS Management Subscription Data. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.8 UE Context In SMF Data Retrieval + +Figure 5.2.2.2.8-1 shows a scenario where the NF service consumer (e.g. AMF, NWDAF, DCCF) sends a request to the UDM to receive the UE's Context In SMF data (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains the UE's identity (*{supi}*), the type of the requested information (*/ue-context-in-smf-data*) and query parameters (*supported-features*). + +![Sequence diagram for UE Context In SMF Data Retrieval](b0d4609bc46c2d88a8318706bb5321f7_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../{supi}/ue-context-in-smf-data + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (UeContextInSmfData) + Note right of UDM: + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram shows a sequence of three messages between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for the resource *.../{supi}/ue-context-in-smf-data*. The UDM responds with either a 200 OK status code and a message body containing the *UeContextInSmfData* (2a), or a 404 Not Found status code (2b). + +Sequence diagram for UE Context In SMF Data Retrieval + +**Figure 5.2.2.2.8-1: Requesting a UE's Context in SMF Data** + +1. The NF service consumer (e.g. AMF) shall send a GET request to the resource representing the UE's Context In SMF Data, with query parameters indicating the supported-features. +- 2a. On Success, the UDM shall respond with "200 OK" with the message body containing the UE's Context In SMF Data as relevant for the requesting NF service consumer. If no PDU session is stored in the UDM the *UeContextInSmfData* within "200 OK" shall be empty. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" may be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.9 Retrieval Of Multiple Data Sets + +Figure 5.2.2.2.9-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive multiple data sets. In this example scenario the UE's Access and Mobility Subscription data and the the UE's SMF Selection Subscription data are retrieved with a single request; see clause 6.1.3.11.3.1 for other data sets that can be retrieved with a single request. The request contains the UE's identity (/{supi}) and query parameters identifying the requested data sets (in this example: ?dataset-names=AM, SMF\_SEL). The data sets allowed in multiple data sets retrieval are listed in table 6.1.6.3.3-1. + +![Sequence diagram showing the retrieval of multiple data sets. The NF Service Consumer sends a GET request to the UDM, and the UDM responds with a 200 OK status and the requested data sets.](8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant UDM + Note left of NF Service Consumer: + NF Service Consumer->>UDM: 1. GET .../{supi}?dataset-names=AM,SMF_SEL + UDM-->>NF Service Consumer: 2. 200 OK (SubscriptionDataSets) + Note right of UDM: +``` + +Sequence diagram showing the retrieval of multiple data sets. The NF Service Consumer sends a GET request to the UDM, and the UDM responds with a 200 OK status and the requested data sets. + +**Figure 5.2.2.2.9-1: Retrieval of Multiple Data Sets** + +1. The NF Service Consumer (e.g. AMF) sends a GET request to the resource representing the supi. Query parameters indicate the requested data sets. +2. The UDM responds with "200 OK" with the message body containing the requested and available data sets. When not all requested data sets are available at the UDM (e.g. no Trace Data), only the requested and available data sets are returned in a "200 OK" response. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.10 Identifier Translation + +Figure 5.2.2.2.10-1 shows a scenario where the NF service consumer (e.g. NEF, AAnF) sends a request to the UDM to receive the SUPI/GPSI that corresponds to the provided GPSI/SUPI (see also 3GPP TS 23.502 [3] clause 4.13.2.2, clause 4.13.7.2 and clause 4.15.6). The request contains the UE's identity (/{ueId}) which shall be a SUPI or GPSI and the type of the requested information (/id-translation-result). + +**NOTE:** This service operation can be used by a Rel-15 GMLC during 5GS-MT-LR procedure to get the SUPI of a UE from GPSI, as an authorized NF service consumer of Nudm\_SubscriberDataManagement service. + +![Sequence diagram for Identifier Translation. The NF Service Consumer sends a GET request to the UDM. The UDM responds with 200 OK (IdTranslationResult), 404 Not Found, or 403 Forbidden.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UDM + Note left of NF Service Consumer: 1. GET .../{ueid}/id-translation-result + NF Service Consumer->>UDM: Request + Note right of UDM: 2a. 200 OK (IdTranslationResult) +2b. 404 Not Found +2c. 403 Forbidden + UDM-->>NF Service Consumer: Response + +``` + +Sequence diagram for Identifier Translation. The NF Service Consumer sends a GET request to the UDM. The UDM responds with 200 OK (IdTranslationResult), 404 Not Found, or 403 Forbidden. + +**Figure 5.2.2.2.10-1: Identifier Translation** + +1. The NF Service Consumer (e.g. NEF, AAnF) shall send a GET request to the resource representing the IdTranslationResult, with query parameters indicating the supported-features and/or necessary information used for identifier translation (e.g. af-id, app-port-id, etc.). + +- 2a. On success, the UDM shall respond with "200 OK" with the message body containing the UE's requested identity (GPSI or SUPI). + +If the expected result of identifier translation is GPSI and the AF specific query parameters (e.g. af-id, app-port-id, af-service-id, mtc-provider-info, etc) are provided, the UDM shall take the provided AF specific information into account to determine the GPSI (i.e. External Identifier) to be returned for the UE. + +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +- 2c. If the AF included in the request is not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.11 Shared Subscription Data Retrieval + +Figure 5.2.2.2.11-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the shared subscription data. The request contains the type of the requested information (/shared-data) and query parameters (supported-features, shared-data-ids). + +![Sequence diagram for Requesting shared data. The NF service consumer sends a GET request to the UDM. The UDM responds with 200 OK (SharedData) or 404 Not Found.](cf4ac1058c52bc3ca37737740afb7f2c_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. GET .../shared-data?shared-data-ids=, + NF service consumer->>UDM: Request + Note right of UDM: 2a. 200 OK (SharedData) +2b. 404 Not Found + UDM-->>NF service consumer: Response + +``` + +Sequence diagram for Requesting shared data. The NF service consumer sends a GET request to the UDM. The UDM responds with 200 OK (SharedData) or 404 Not Found. + +**Figure 5.2.2.2.11-1: Requesting shared data** + +1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the SharedData, with query parameters indicating the supported-features and shared-data-ids. + +- 2a. On success, the UDM responds with "200 OK" with the message body containing the SharedData. + +- 2b. If there is no valid shared data for one or more of the shared-data-ids, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.12 UE Context In SMSF Data Retrieval + +Figure 5.2.2.2.12-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE's Context In SMSF data. The request contains the UE's identity (/{supi}), the type of the requested information (/ue-context-in-smsf-data) and query parameters (supported-features). + +![Sequence diagram for UE Context In SMSF Data Retrieval](2eb23c2210154279f8013a1594fbcc5a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. GET .../{supi}/ue-context-in-smsf-data + NF service consumer->>UDM: 1. GET .../{supi}/ue-context-in-smsf-data + Note right of UDM: 2a. 200 OK (UeContextInSmsfData) +2b. 404 Not Found + UDM-->>NF service consumer: 2a. 200 OK (UeContextInSmsfData) +2b. 404 Not Found +``` + +Sequence diagram for UE Context In SMSF Data Retrieval + +**Figure 5.2.2.2.12-1: Requesting a UE's Context in SMSF Data** + +1. The NF service consumer (e.g. AMF) shall send a GET request to the resource representing the UE's Context In SMSF Data, with query parameters indicating the supported-features. +- 2a. On Success, the UDM shall respond with "200 OK" with the message body containing the UE's Context In SMSF Data as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.13 Trace data Retrieval + +Figure 5.2.2.2.13-1 shows a scenario where the NF service consumer (e.g. AMF, SMF) sends a request to the UDM to receive the UE's trace data. The request contains the UE's identity (/{supi}), the type of the requested information (/trace-data) and query parameters. + +![Sequence diagram for Trace data Retrieval](cd141897aa368dbbaa398ace230cdd85_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. GET .../{supi}/trace-data + NF service consumer->>UDM: 1. GET .../{supi}/trace-data + Note right of UDM: 2a. 200 OK (TraceDataResponse) +2b. 404 Not Found + UDM-->>NF service consumer: 2a. 200 OK (TraceDataResponse) +2b. 404 Not Found +``` + +Sequence diagram for Trace data Retrieval + +**Figure 5.2.2.2.13-1: Requesting a UE's trace Data** + +1. The NF service consumer (e.g. AMF, SMF) shall send a GET request to the resource representing the UE's trace Data, with query parameters. +- 2a. On Success, the UDM shall respond with "200 OK" with the message body containing the UE's trace data response as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +NOTE: The Trace data Retrieval procedure allows consumers of the UDM (e.g. AMF, SMF, SMSF) to retrieve trace data that are actually part of AccessAndMobilitySubscriptionData (see clause 5.2.2.2.3), SessionManagementSubscriptionData (see clause 5.2.2.2.5) and SmsManagementSubscriptionData (see clause 5.2.2.2.7). UDM/UDR provisioning ensures consistency of trace data retrieved stand alone or as part of other subscription data, i.e. the representations of traceData within TraceDataResponse, AccessAndMobilitySubscriptionData, SessionManagementSubscriptionData and SmsManagementSubscriptionData are identically provisioned at the UDM/UDR, + +##### 5.2.2.2.14 Group Identifier Translation + +Figure 5.2.2.2.14-1 shows a scenario where the NF service consumer (e.g. NEF, GMLC) sends a request to the UDM to receive the Internal Group Identifier that corresponds to the provided External Group Identifier and / or the list of the UE identifiers (e.g. SUPIs, GPSIs) that belong to the provided External Group Identifier. + +The NF service consumer (e.g. TSCTSF) may also send a request to the UDM to receive the list of the UE identifiers (e.g. SUPIs) that corresponds to the provided External Group Identifier (see 3GPP TS 23.502 [3] clause 4.15.9.2 and clause 4.15.9.4) + +![Sequence diagram for External Group Identifier Translation. The diagram shows two participants: NF Service Consumer and UDM. The NF Service Consumer sends a GET request to the UDM for group identifiers. The UDM responds with one of three possible HTTP status codes: 200 OK (with internal group identifiers), 404 Not Found, or 403 Forbidden.](73dff6b45b2b9ffd384bab3235f869af_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant UDM + Note left of NF Service Consumer: 1. GET .../group-data/group-identifiers?ext-group-id=... + NF Service Consumer->>UDM: 1. GET .../group-data/group-identifiers?ext-group-id=... + Note right of UDM: 2a. 200 OK (InternalGroupIdentifiers) + Note right of UDM: 2b. 404 Not Found + Note right of UDM: 2c. 403 Forbidden + UDM-->>NF Service Consumer: 2a. 200 OK (InternalGroupIdentifiers) + UDM-->>NF Service Consumer: 2b. 404 Not Found + UDM-->>NF Service Consumer: 2c. 403 Forbidden +``` + +Sequence diagram for External Group Identifier Translation. The diagram shows two participants: NF Service Consumer and UDM. The NF Service Consumer sends a GET request to the UDM for group identifiers. The UDM responds with one of three possible HTTP status codes: 200 OK (with internal group identifiers), 404 Not Found, or 403 Forbidden. + +**Figure 5.2.2.2.14-1: External Group Identifier Translation** + +1. The NF Service Consumer (e.g. NEF, GMLC, TSCTSF) shall send a GET request to the resource representing the group identifiers handled by UDM; the External Group Identifier is passed in a query parameter of the request URI, and an indication is also passed if the list of UE identifiers that belong to the provided External Group Identifier are required. +- 2a. On success, the UDM shall respond with "200 OK" with the message body containing the Internal Group Identifier and / or the list of UE identifiers that belong to the provided External Group Identifier. +- 2b. If there is no valid data for this group, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the AF included in the request is not allowed to perform this operation for the group, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +Figure 5.2.2.2.14-2 shows another scenario where the NF service consumer (e.g. NEF, GMLC) sends a request to the UDM to receive the External Group Identifier that corresponds to the provided Internal Group Identifier and optionally, the list of the UE identifiers (e.g. SUPIs, GPSIs) pertaining to such group or the NF service consumer (e.g. TSCTSF) sends a request to the UDM to receive the list of the UE identifiers (e.g. SUPIs) that corresponds to the provided Internal Group Identifier (see 3GPP TS 23.502 [3] clause 4.15.9.2 and clause 4.15.9.4). + +![Sequence diagram for Internal Group Identifier Translation. The NF Service Consumer sends a GET request to the UDM. The UDM responds with 200 OK (ExternalGroupIdentifiers), 404 Not Found, or 403 Forbidden.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UDM + Note left of NF Service Consumer: 1. GET .../group-data/group-identifiers?int-group-id=... + NF Service Consumer->>UDM: Request + Note right of UDM: 2a. 200 OK (ExternalGroupIdentifiers) +2b. 404 Not Found +2c. 403 Forbidden + UDM-->>NF Service Consumer: Response + +``` + +Sequence diagram for Internal Group Identifier Translation. The NF Service Consumer sends a GET request to the UDM. The UDM responds with 200 OK (ExternalGroupIdentifiers), 404 Not Found, or 403 Forbidden. + +**Figure 5.2.2.2.14-2: Internal Group Identifier Translation** + +1. The NF Service Consumer (e.g. NEF, GMLC, TSCTSF) shall send a GET request to the resource representing the Internal Group Identifiers handled by UDM; the Internal Group Identifier is passed in a query parameter of the request URI, and an indication is also passed if the list of UE identifiers that belong to the provided Internal Group Identifier are required. +- 2a. On success, the UDM shall respond with "200 OK" with the message body containing the corresponding External Group Identifier and / or the list of UE identifiers that belong to the provided Internal Group Identifier. +- 2b. If there is no valid data for this group, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the AF included in the request is not allowed to perform this operation for the group, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.15 LCS Privacy Data Retrieval + +Figure 5.2.2.2.15-1 shows a scenario where the NF service consumer (e.g. HGMLC, NEF) sends a request to the UDM to receive the UE's LCS Privacy Subscription data (see 3GPP TS 23.273 [38] figure 6.1.2-1 step 2, figure 6.3.1-1 step 2, figure 6.5.1-1 step 7 and figure 6.8.1 step 3). The request contains the UE's identity (/{ueId}), the type of the requested information (/lcs-privacy-data) and query parameters (supported-features). + +![Sequence diagram for Requesting a UE's LCS Privacy Data. The NF service consumer sends a GET request to the UDM. The UDM responds with 200 OK (LcsPrivacyData) or 404 Not Found.](627c5195eaae3bc7e34cbc4dbdb6f9a8_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. GET .../{ueId}/lcs-privacy-data + NF service consumer->>UDM: Request + Note right of UDM: 2a. 200 OK (LcsPrivacyData) +2b. 404 Not Found + UDM-->>NF service consumer: Response + +``` + +Sequence diagram for Requesting a UE's LCS Privacy Data. The NF service consumer sends a GET request to the UDM. The UDM responds with 200 OK (LcsPrivacyData) or 404 Not Found. + +**Figure 5.2.2.2.15-1: Requesting a UE's LCS Privacy Data** + +1. The NF service consumer (e.g. HGMLC, NEF) sends a GET request to the resource representing the UE's Lcs Privacy Subscription Data, with query parameters indicating the supported-features. +- 2a. On Success, the UDM responds with "200 OK" with the message body containing the UE's Lcs Privacy Subscription Data as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.16 LCS Mobile Originated Data Retrieval + +Figure 5.2.2.2.16-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE's LCS Mobile Originated Subscription data (see 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains the UE's identity (/{supi}), the type of the requested information (/lcs-mo-data) and query parameters (supported-features). + +![Sequence diagram for LCS Mobile Originated Data Retrieval](d9c0a780cd22626253dab4aa41699e2f_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note left of NF: + NF->>UDM: 1. GET .../{supi}/lcs-mo-data + Note right of UDM: + UDM-->>NF: 2a. 200 OK (LcsMoData) + UDM-->>NF: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for the UE's LCS Mobile Originated Subscription data. The UDM responds with either a 200 OK (LcsMoData) or a 404 Not Found status code. + +Sequence diagram for LCS Mobile Originated Data Retrieval + +**Figure 5.2.2.2.16-1: Requesting a UE's LCS Mobile Originated Data** + +1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the UE's LCS Mobile Originated Subscription Data, with query parameters indicating the supported-features. +- 2a. On Success, the UDM responds with "200 OK" with the message body containing the UE's LCS Mobile Originated Subscription Data as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.17 Enhanced Coverage Restriction Data Retrieval + +Figure 5.2.2.2.17-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to retrieve a UE's subscribed Enhanced Coverage Restriction data (see also 3GPP TS 23.502 [3] figure 4.27.1-1 step 3 and 7). The request contains the identifier of the UE (/{supi}), the type of the requested information (/am-data/ecr-data) and query parameters (supported-features). + +![Sequence diagram for Enhanced Coverage Restriction Data Retrieval](86d30a7d5a9cd4ee5456b5962ae3420a_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note left of NF: + NF->>UDM: 1. GET .../{supi}/am-data/ecr-data + Note right of UDM: + UDM-->>NF: 2a. 200 OK (EnhancedCoverageRestrictionData) + UDM-->>NF: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for the UE's subscribed Enhanced Coverage Restriction data. The UDM responds with either a 200 OK (EnhancedCoverageRestrictionData) or a 404 Not Found status code. + +Sequence diagram for Enhanced Coverage Restriction Data Retrieval + +**Figure 5.2.2.2.17-1: NF service consumer retrieves Enhance Coverage Restriction Data** + +1. The NF service consumer (e.g. NEF) sends a GET request to the resource that represents a UE's subscribed Enhanced Coverage Restriction data, with query parameters indicating the supported-features. +- 2a. On success, the UDM responds with "200 OK", the message body containing the UE's subscribed Enhanced Coverage Restriction data as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscribed Enhanced Coverage Restriction data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.18 V2X Subscription Data Retrieval + +Figure 5.2.2.2.18-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to retrieve a UE's subscribed V2X data (see also 3GPP TS 23.287 [51] clause 6.5.2). The request contains the identifier of the UE (/{supi}), the type of the requested information (/v2x-data) and query parameters (supported-features). + +![Sequence diagram for V2X Subscription Data Retrieval](171115f072e42b379238ed0dd438e9d7_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../{supi}/v2x-data + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (V2xSubscriptionData) + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for V2X subscription data. The UDM responds with either a 200 OK status containing the data or a 404 Not Found status if no data is available. + +Sequence diagram for V2X Subscription Data Retrieval + +**Figure 5.2.2.2.18-1: NF service consumer retrieves V2X Subscription Data** + +1. The NF service consumer (e.g. AMF) sends a GET request to the resource that represents a UE's subscribed V2X data, with query parameters indicating the supported-features. +- 2a. On success, the UDM responds with "200 OK", the message body containing the UE's subscribed V2X data as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscribed V2X data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.19 LCS Broadcast Assistance Subscription Data Retrieval + +Figure 5.2.2.2.19-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the UE's LCS Broadcast Assistance Subscription data (see 3GPP TS 23.273 [38]). The request contains the UE's identity (/{supi}), the type of the requested information (/lcs-bca-data) and query parameters (supported-features, plmn-id). + +![Sequence diagram for LCS Broadcast Assistance Subscription Data Retrieval](14515d82ffeec9475b9add3036ff26ab_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../{supi}/lcs-bca-data + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (LcsBroadcastAssistanceData) + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for LCS Broadcast Assistance Subscription data. The UDM responds with either a 200 OK status containing the data or a 404 Not Found status if no data is available. + +Sequence diagram for LCS Broadcast Assistance Subscription Data Retrieval + +**Figure 5.2.2.2.19-1: Requesting a UE's LCS Broadcast Assistance Subscription Data** + +1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the UE's Lcs Location Assistance Subscription Data, with query parameters indicating the supported-features and/or plmn-id. +- 2a. On Success, the UDM responds with "200 OK" with the message body containing the UE's Lcs Location Assistance Subscription Data as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.20 UE Context In AMF Data Retrieval + +Figure 5.2.2.2.20-1 shows a scenario where the NF service consumer (e.g. HSS, NWDAF, DCCF) sends a request to the UDM to receive the UE's Context In AMF data (see 3GPP TS 23.632 [32] figure 5.3.4-1 step 2 and 3 and also 3GPP TS 23.288[35]). The request contains the UE's identity (`{supi}`), the type of the requested information (`/ue-context-in-amf-data`) and query parameters (`supported-features`). + +![Sequence diagram for Figure 5.2.2.2.20-1: Requesting a UE's Context in AMF Data. The diagram shows an NF service consumer sending a GET request to a UDM. The UDM responds with either a 200 OK (containing UeContextInAmfData) or a 404 Not Found.](2734e7f9be3e1dc046f14be2e6c9a085_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../{supi}/ue-context-in-amf-data + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (UeContextInAmfData) + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +Sequence diagram for Figure 5.2.2.2.20-1: Requesting a UE's Context in AMF Data. The diagram shows an NF service consumer sending a GET request to a UDM. The UDM responds with either a 200 OK (containing UeContextInAmfData) or a 404 Not Found. + +**Figure 5.2.2.2.20-1: Requesting a UE's Context in AMF Data** + +1. The NF service consumer (e.g. HSS) shall send a GET request to the resource representing the UE's Context In AMF Data, with query parameters indicating the supported-features. +- 2a. On Success, the UDM shall respond with "200 OK" with the message body containing the UE's Context In AMF Data as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.21 Individual Shared Subscription Data Retrieval + +Figure 5.2.2.2.21-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to receive the individual shared subscription data indicated by the sharedDataId. The request contains the type of the requested information (`/shared-data/{sharedDataId}`) and query parameters (`supported-features`). + +![Sequence diagram for Figure 5.2.2.2.21-1: Requesting shared data. The diagram shows an NF service consumer sending a GET request to a UDM. The UDM responds with either a 200 OK (containing SharedData) or a 404 Not Found.](b6b53a74ad203c01b81e5427e9d6a898_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../shared-data/{sharedDataId} + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (SharedData) + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +Sequence diagram for Figure 5.2.2.2.21-1: Requesting shared data. The diagram shows an NF service consumer sending a GET request to a UDM. The UDM responds with either a 200 OK (containing SharedData) or a 404 Not Found. + +**Figure 5.2.2.2.21-1: Requesting shared data** + +1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the individual SharedData indicated by the sharedDataId. +- 2a. On success, the UDM responds with "200 OK" with the message body containing the individual SharedData. +- 2b. If there is no valid individual SharedData indicated by the sharedDataId, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.22 Prose Subscription Data Retrieval + +Figure 5.2.2.2.22-1 shows a scenario where the NF service consumer (e.g. 5G DDNMF, 5G PKMF, PANF) sends a request to the UDM to receive the UE's ProSe Subscription Data. The request contains the UE's identity (/{supi}), the type of the requested information (/prose-data) and query parameters (supported-features). + +![Sequence diagram for ProSe Subscription Data Retrieval](392a79ccd95e682ccd08f35ab2e64144_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: Request ProSe Subscription Data + NF service consumer->>UDM: 1. GET .../{supi}/prose-data + Note right of UDM: Success or Failure + UDM-->>NF service consumer: 2a. 200 OK (ProSeSubscriptionData) + Note right of UDM: Failure case + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for ProSe Subscription Data. The UDM responds with either a 200 OK status containing the data or a 404 Not Found status if the data is not available. + +Sequence diagram for ProSe Subscription Data Retrieval + +**Figure 5.2.2.2.22-1: Requesting a UE's ProSe Subscription Data** + +1. The NF service consumer (e.g. 5G DDNMF, 5G PKMF, PANF) sends a GET request to the resource representing the UE's ProSe Subscription Data, with query parameters indicating the supported-features. +- 2a. On Success, the UDM responds with "200 OK" with the message body containing the UE's ProSe Data as relevant for the requesting NF service consumer. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.23 5MBS Subscription Data Retrieval + +Figure 5.2.2.2.23-1 shows a scenario where the NF service consumer (e.g. SMF) sends a request to the UDM to receive the UE's 5MBS Subscription Data. The request contains the UE's identity (/{supi}), the type of the requested information (/mbs-data) and query parameters (supported-features). + +![Sequence diagram for 5MBS Subscription Data Retrieval](e05c1a13b44ab41505609d82b00cf4df_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: Request 5MBS Subscription Data + NF service consumer->>UDM: 1. GET .../{supi}/mbs-data + Note right of UDM: Success + UDM-->>NF service consumer: 2a. 200 OK (MbsSubscriptionData) + Note right of UDM: Failure case + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for 5MBS Subscription Data. The UDM responds with either a 200 OK status containing the data or a 404 Not Found status if the data is not available. + +Sequence diagram for 5MBS Subscription Data Retrieval + +**Figure 5.2.2.2.23-1: Requesting a UE's 5MBS Subscription Data** + +1. The NF service consumer (e.g. SMF) sends a GET request to the resource representing the UE's 5MBS Subscription Data, with query parameters indicating the supported-features. +- 2a. On Success, the UDM responds with "200 OK" with the message body containing the UE's 5MBS Subscription Data as relevant for the requesting NF service consumer. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.24 User Consent Subscription Data Retrieval + +Figure 5.2.2.2.24-1 shows a scenario where the NF service consumer (e.g. NWDAF, DCCF, NEF, trusted AF) sends a request to the UDM to receive the UE's User Consent Subscription Data. The request contains the UE's identity (/{supi}), the type of the requested information (/uc-data) and query parameters (uc-purpose and/or supported-features). + +![Sequence diagram for User Consent Subscription Data Retrieval](4cde160bcc69b7b6c81b648dd0e4252e_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../{supi}/uc-data + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (UcSubscriptionData) + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for the UE's User Consent Subscription Data. The UDM responds with either a 200 OK status containing the data or a 404 Not Found status. + +Sequence diagram for User Consent Subscription Data Retrieval + +**Figure 5.2.2.2.24-1: Requesting a UE's User Consent Subscription Data** + +1. The NF service consumer (e.g. NWDAF, DCCF, NEF, trusted AF) sends a GET request to the resource representing the UE's User Consent Subscription Data, with query parameters indicating the uc-purpose and/or supported-features. +- 2a. On Success, the UDM responds with "200 OK" with the message body containing the UE's User Consent Subscription Data as relevant for the requesting NF service consumer. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.25 Multiple Identifiers Translation + +Figure 5.2.2.2.25-1 shows a scenario where the NF service consumer (e.g. TSCTSF) sends a request to the UDM to receive the list of the UE identifiers (i.e. SUPIs) that corresponds to the provided UE identifiers (i.e. GPSIs) (see 3GPP TS 23.502 [3] clause 4.15.9.2 and clause 4.15.9.4). + +![Sequence diagram for GPSIs Translation](82b40cb8b2a5ac361973859400fa128a_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant UDM + Note left of NF Service Consumer: + NF Service Consumer->>UDM: 1. GET .../multiple-identifiers?gps-list=... + Note right of UDM: + UDM-->>NF Service Consumer: 2a. 200 OK (UeIdentifiers) + UDM-->>NF Service Consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer and a UDM. The NF Service Consumer sends a GET request to the UDM for the list of UE identifiers (SUPIs) corresponding to the provided GPSIs. The UDM responds with either a 200 OK status containing the list of SUPIs or a 404 Not Found status. + +Sequence diagram for GPSIs Translation + +**Figure 5.2.2.2.25: GPSIs Translation** + +1. The NF Service Consumer (e.g. TSCTSF) shall send a GET request to the resource representing the list of GPSIs handled by UDM; the list of GPSIs are passed in a query parameter of the request URI. +- 2a. On success, the UDM shall respond with "200 OK" with the message body containing the list of UE Identifiers with list of SUPIs that belong to each provided GPSI. +- 2b. If there is no valid data for this list of GPSIs, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.26 Time Synchronization Subscription Data Retrieval + +Figure 5.2.2.2.26-1 shows a scenario where the NF service consumer (e.g. TSCTSF) sends a request to the UDM to receive the UE's Time Synchronization Subscription Data (see also clause 5.27.1.11 of 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3] figure 4.28.3.1-1 step 3). + +![Sequence diagram for Time Synchronization Subscription Data Retrieval](759c7d62402f0b4651ddce292be5bdef_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../{supi}/time-sync-data + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (TimeSyncSubscriptionData) + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for time synchronization subscription data. The UDM responds with either a 200 OK status containing the data or a 404 Not Found status if no valid subscription data exists. + +Sequence diagram for Time Synchronization Subscription Data Retrieval + +**Figure 5.2.2.2.26-1: Requesting a UE's Time Synchronization Subscription Data** + +1. The NF service consumer (e.g. TSCTSF) sends a GET request to the resource representing the UE's subscribed Time Synchronization Subscription Data. +- 2a. On success, the UDM responds with "200 OK" with the message body containing the UE's Time Synchronization Subscription Data. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.27 LCS Subscription Data Retrieval + +Figure 5.2.2.2.27-1 shows a scenario where the NF service consumer (e.g. AMF, H-GMLC) sends a request to the UDM to receive the UE's LCS Subscriber Data, i.e. other Subscription data, (see 3GPP TS 23.273 [38] clause 6.1.2, clause 6.2.1 and clause 7.1). The request contains the UE's identity (/{supi}), the type of the requested information (/lcs-subscription-data) and query parameters (supported-features). + +![Sequence diagram for LCS Subscription Data Retrieval](68ea9310fb829dd6007635a6cd4ea2ad_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../{supi}/lcs-subscription-data + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (LcsSubscriptionData) + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for LCS subscription data. The UDM responds with either a 200 OK status containing the data or a 404 Not Found status if no valid subscription data exists. + +Sequence diagram for LCS Subscription Data Retrieval + +**Figure 5.2.2.2.27-1: Requesting a UE's LCS Subscription Data** + +1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the UE's LCS Subscription Data, with query parameters indicating the supported-features. +- 2a. On Success, the UDM responds with "200 OK" with the message body containing the UE's LCS Subscription Data as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.28 Ranging and Sidelink Positioning Subscription Data Retrieval + +Figure 5.2.2.2.28-1 shows a scenario where the NF service consumer (e.g. AMF, SLPKMF) sends a request to the UDM to receive the UE's Ranging and Sidelink Positioning Subscription Data. The request contains the UE's identity (/{supi}), the type of the requested information (/ranging-slpos-data) and query parameters (supported-features). + +![Sequence diagram for Ranging and Sidelink Positioning Subscription Data Retrieval](6ca05954842b17f14dfd52f26b9d43d2_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: Request + NF service consumer->>UDM: 1. GET .../{supi}/ranging-slpos-data + Note right of UDM: Success or Failure + UDM-->>NF service consumer: 2a. 200 OK (RangingSlPosSubscriptionData) + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for ranging and sidelink positioning subscription data. The UDM responds with either a 200 OK status containing the subscription data or a 404 Not Found status. + +Sequence diagram for Ranging and Sidelink Positioning Subscription Data Retrieval + +**Figure 5.2.2.2.28-1: Requesting a UE's Ranging and Sidelink Positioning Subscription Data** + +1. The NF service consumer (e.g. AMF, SLPKMF) sends a GET request to the resource representing the UE's Ranging and Sidelink Positioning Subscription Data, with query parameters indicating the supported-features. +- 2a. On Success, the UDM responds with "200 OK" with the message body containing the UE's Ranging and Sidelink Positioning Subscription Data as relevant for the requesting NF service consumer. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.2.2.2.29 A2X Subscription Data Retrieval + +Figure 5.2.2.2.29-1 shows a scenario where the NF service consumer (e.g. AMF) sends a request to the UDM to retrieve a UE's subscribed A2X data (see also 3GPP TS 23.256 [70] clause 6.3.5.2). The request contains the identifier of the UE (/{supi}), the type of the requested information (/a2x-data) and query parameters (supported-features). + +![Sequence diagram for A2X Subscription Data Retrieval](1c29dadab94c3fa552d270434db09c81_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: Request + NF service consumer->>UDM: 1. GET .../{supi}/a2x-data + Note right of UDM: Success or Failure + UDM-->>NF service consumer: 2a. 200 OK (A2xSubscriptionData) + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for A2X subscription data. The UDM responds with either a 200 OK status containing the subscription data or a 404 Not Found status. + +Sequence diagram for A2X Subscription Data Retrieval + +**Figure 5.2.2.2.29-1: NF service consumer retrieves A2X Subscription Data** + +1. The NF service consumer (e.g. AMF) sends a GET request to the resource that represents a UE's subscribed A2X data, with query parameters indicating the supported-features. +- 2a. On success, the UDM responds with "200 OK", the message body containing the UE's subscribed A2X data as relevant for the requesting NF service consumer. +- 2b. If there is no valid subscribed A2X data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +#### 5.2.2.3 Subscribe + +##### 5.2.2.3.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscription to notification of data change (for UE individual data) +- Subscription to notification of shared data change + +##### 5.2.2.3.2 Subscription to notifications of data change + +Figure 5.2.2.3.2-1 shows a scenario where the NF service consumer sends a request to the UDM to subscribe to notifications of data change (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains a callback URI and the URI of the monitored resource. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for subscribing to notifications. The consumer sends a POST request to the UDM. The UDM responds with one of three possible status codes: 201 Created, 404 Not Found, or 501 Not Implemented.](7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note left of NF: 1. POST.../{ueId}/sdm-subscriptions (SdmSubscription) + NF->>UDM: Request + Note right of UDM: 2a. 201 Created (SdmSubscription) +2b. 404 Not Found +2c. 501 Not Implemented + UDM-->>NF: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for subscribing to notifications. The consumer sends a POST request to the UDM. The UDM responds with one of three possible status codes: 201 Created, 404 Not Found, or 501 Not Implemented. + +**Figure 5.2.2.3.2-1: NF service consumer subscribes to notifications** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (`.../{ueId}/sdm-subscriptions`), to create a subscription as present in message body. The content of the POST request shall contain a representation of the individual subscription resource to be created. + +An NF consumer supporting the "LimitedSubscriptions" feature shall create only one unique subscription per UE (identified by the ueId in URI) without additional filter criteria, or with a specific filter criteria (e.g. dnn and/or singleNssai), and set the "uniqueSubscription" IE with the value "true" in request body. + +For immediate reporting, the optional query parameter shared-data-ids may be included by the NF service consumer to indicate to the UDM that shared AccessAndMobilitySubscriptionData identified by the shared-data-ids are already available at the NF service consumer. + +If the NF consumer subscribes to notifications of data change to URIs containing expected UE behaviours (e.g. Access and Mobility Subscription Data, Session Management Subscription Data), the subscription may include a threshold indicating that certain confidence and/or accuracy levels that must be met for the parameter(s) to be notified by UDM. + +- 2a. On success, the UDM responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. + +If the SdmSubscription received in the POST request contains the immediateReport indication, the SdmSubscription in the "201 Created" response may also contain a report attribute with the current representation of the subscribed data. + +In addition, if the received POST request contains the optional query parameter shared-data-ids identifying shared data available at the NF service consumer, and the current representation of the subscribed data contains shared data IDs identifying shared data not yet available at the NF service consumer, the current representation of the subscribed data sent in the "201 Created" response may also contain shared data that are not yet available at the NF service consumer. + +In case of partial success, "201 Created" should contain only the monitored resource URIs that are supported by the UDM. + +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +- 2c. If the UE subscription data exist, but the requested subscription to data change notification cannot be created (e.g. due to an invalid/unsupported data reference to be monitored, contained in the SdmSubscription parameter), HTTP status code "501 Not Implemented" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +"501 Not Implemented" shall be returned only when none of the monitoredResourceUris are supported by the UDM. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +##### 5.2.2.3.3 Subscription to notifications of shared data change + +Figure 5.2.2.3.3-1 shows a scenario where the NF service consumer sends a request to the UDM to subscribe to notifications of shared data change. The request contains a callback URI and the URI of the monitored resource. + +![Sequence diagram showing the NF service consumer sending a POST request to the UDM to subscribe to notifications of shared data change, and the UDM responding with a 201 Created status.](dc1f232cfd39be5c20b21374ad4c04c0_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. POST.../shared-data-subscriptions (SdmSubscription) + Note right of UDM: + UDM-->>NF service consumer: 2. 201 Created (SdmSubscription) + Note left of NF service consumer: +``` + +Sequence diagram showing the NF service consumer sending a POST request to the UDM to subscribe to notifications of shared data change, and the UDM responding with a 201 Created status. + +**Figure 5.2.2.3.3-1: NF service consumer subscribes to notifications of shared data change** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../shared-data-subscriptions), to create a subscription as present in message body. The content of the POST request shall contain a representation of the shared data individual subscription resource to be created. An NF consumer supporting the "LimitedSubscriptions" feature shall create only one unique shared data individual subscription and set the "uniqueSubscription" IE with the value "true" in request body. +2. On success, the UDM responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.2.2.4 Unsubscribe + +##### 5.2.2.4.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to notification of data change (for UE individual data) +- Unsubscribe to notifications of shared data change + +##### 5.2.2.4.2 Unsubscribe to notifications of data change + +Figure 5.2.2.4.2-1 shows a scenario where the NF service consumer sends a request to the UDM to unsubscribe from notifications of data changes (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the NF service consumer unsubscribing to notifications from the UDM.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. DELETE.../{ueId}/sdm-subscriptions/{subscriptionId} + NF service consumer->>UDM: 1. DELETE.../{ueId}/sdm-subscriptions/{subscriptionId} + Note right of UDM: 2a. 204 No Content + UDM-->>NF service consumer: 2a. 204 No Content + Note right of UDM: 2b. 404 Not Found + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a DELETE request to the UDM. The UDM responds with either a 204 No Content status code (2a) or a 404 Not Found status code (2b). + +Sequence diagram showing the NF service consumer unsubscribing to notifications from the UDM. + +**Figure 5.2.2.4.2-1: NF service consumer unsubscribes to notifications** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the UDM responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +##### 5.2.2.4.3 Unsubscribe to notifications of shared data change + +Figure 5.2.2.4.3-1 shows a scenario where the NF service consumer sends a request to the UDM to unsubscribe from notifications of shared data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the NF service consumer unsubscribing to notifications for shared data from the UDM.](1c9a5a80a4ed18fdfda1c8ae915966bf_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. DELETE.../shared-data-subscriptions/{subscriptionId} + NF service consumer->>UDM: 1. DELETE.../shared-data-subscriptions/{subscriptionId} + Note right of UDM: 2a. 204 No Content + UDM-->>NF service consumer: 2a. 204 No Content + Note right of UDM: 2b. 404 Not Found + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a DELETE request to the UDM. The UDM responds with either a 204 No Content status code (2a) or a 404 Not Found status code (2b). + +Sequence diagram showing the NF service consumer unsubscribing to notifications for shared data from the UDM. + +**Figure 5.2.2.4.3-1: NF service consumer unsubscribes to notifications for shared data** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the UDM responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +#### 5.2.2.5 Notification + +##### 5.2.2.5.1 General + +The following procedures using the Notification service operation are supported: + +- Data change notification to NF, including the updates of UE's Subscriber Data indicated by the "subscription data Type" input and additional UE's UDM-related parameters. +- Delivery of UE Parameters Update Data to the UE via control plane procedure as defined in 3GPP TS 23.502 [3] clause 4.20. +- UDR-initiated Data Restoration Notification + +##### 5.2.2.5.2 Data Change Notification To NF + +Figure 5.2.2.5.2-1 shows a scenario where the UDM notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change (see also 3GPP TS 23.502 [3] clause 4.5.1 or 3GPP TS 23.502 [3] clause 4.5.2) or shared data change. The delivery of UE Parameters Update Data to the UE via control plane procedure is also conveyed using this notification, as defined in 3GPP TS 23.502 [3] clause 4.20. The notification request shall be sent to the callbackReference URI as previously received in the SdmSubscription (see clause 6.1.6.2.3). + +![Sequence diagram showing the Subscription Data Change Notification process between an NF service consumer and a UDM. The UDM sends a POST request to the NF service consumer. The NF service consumer responds with either a 204 No Content (success) or a 4xx/5xx status code (failure/redirection).](dfaa8b98082261913dac00eae86b2889_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note right of UDM: 1. POST {callbackReference} (ModificationNotification) + UDM->>NF: + Note left of NF: 2a. 204 No Content + Note left of NF: 2b. 4xx/5xx (Problem Details) or 3xx + NF-->>UDM: + +``` + +Sequence diagram showing the Subscription Data Change Notification process between an NF service consumer and a UDM. The UDM sends a POST request to the NF service consumer. The NF service consumer responds with either a 204 No Content (success) or a 4xx/5xx status code (failure/redirection). + +**Figure 5.2.2.5.2-1: Subscription Data Change Notification** + +1. The UDM sends a POST request to the callbackReference as provided by the NF service consumer during the subscription. + +When the notification in the POST request body includes one or more arrays, the UDM shall use the complete replacement representation of the arrays, see 3GPP TS 29.501 [5], Annex E. + +When the notification in the POST request body includes one or more arrays where all the array elements have been removed, the UDM shall include the original array representation, i.e. in the origValue attribute of the ChangeItem. + +- 2a. On success, the NF service consumer responds with "204 No Content". +- 2b. On failure or redirection, one of the appropriate HTTP status code listed in Table 6.1.5.2-3 shall be returned. For a 4xx/5xx response, the message body may contain appropriate additional error information. + +NOTE 1: If the NF service consumer detects that the received Data Change Notification contains an origValue that does not match the currently stored value, it can re-sync by using the Nudm\_SDM\_Get service operation. + +NOTE 2: When the notification is used for the delivery of UE Parameter Update Data to the UE, the trigger for UDM to start this procedure is out of the scope of this specification. This can be based, e.g., on O&M commands or provisioning orders. When a given UE parameter can be updated either in the USIM or in the ME side of the UE (e.g., Routing Indicator, see 3GPP TS 23.502 [3] clause 4.20.1) it is assumed that the trigger for the UE parameter update procedure includes an indication to the UDM of the target for the UE parameters update (i.e., USIM or ME). This indication is used by the UDM to decide which UE parameter update data set type to use and whether the UE parameter update requires secured packet protection via SP-AF. + +##### 5.2.2.5.3 UDR-initiated Data Restoration Notification + +Figure 5.2.2.5.3-1 shows a scenario where the UDM notifies the NF Service Consumer about the need to restore data (e.g., SDM subscriptions) due to a potential data-loss event occurred at the UDR. The request contains identities representing those UEs potentially affected by such event. + +![Sequence diagram showing UDR-initiated Data Restoration. The UDM sends a POST request to the NF Service Consumer, which responds with 204 No Content or an error code.](a4b963a07cc368283154762c4b156fe7_img.jpg) + +``` + +sequenceDiagram + participant UDM + participant NFSC as NF Service Consumer + Note left of UDM: Potential data-loss event at UDR + UDM->>NFSC: 1. POST {dataRestorationCallbackUri} (DataRestorationNotification) + Note right of NFSC: Success + NFSC-->>UDM: 2a. 204 No Content + Note right of NFSC: Failure or redirection + NFSC-->>UDM: 2b. 4xx/5xx (Problem Details) or 3xx + +``` + +Sequence diagram showing UDR-initiated Data Restoration. The UDM sends a POST request to the NF Service Consumer, which responds with 204 No Content or an error code. + +**Figure 5.2.2.5.3-1: UDR-initiated Data Restoration** + +1. The UDM (after receiving a notification from UDR about a potential data-loss event) sends a POST request to the dataRestorationCallbackUri; such callback URI may be provided by the NF service consumer during the creation of an SDM subscription, or dynamically discovered by UDM by querying the NRF for the NF Profile of the NF Service Consumer. +- 2a. On success, the NF Service Consumer responds with "204 No Content". +- 2b. On failure or redirection, one of the appropriate HTTP status codes listed in Table 6.1.5.3-3 shall be returned. For a 4xx/5xx response, the message body may contain appropriate additional error information. + +#### 5.2.2.6 Info + +##### 5.2.2.6.1 General + +The following procedures using the Info service operation are supported: + +- Providing acknowledgement from the UE to UDM about successful delivery of Steering of Roaming information via the AMF as defined in 3GPP TS 23.122 [20] +- Providing acknowledgement from the UE to UDM about successful delivery of updated Default Configured NSSAI or UICC data (Secured-Packet, containing e.g. Routing indicator) via the AMF as defined in 3GPP TS 23.502 [3]. +- Providing acknowledgement from the UE to the UDM about successful delivery of the Network Slicing Subscription Change Indication. +- Providing acknowledgement from the UE to UDM about successful delivery of CAG configuration (see 3GPP TS 23.501 [2] clause 5.30.3.3). +- Providing indication from AMF to UDM about unsuccessful delivery of Steering of Roaming Information, updated Default Configured NSSAI or UICC data. +- Triggering update of Steering of Roaming information at the UE due to "initial registration" or "emergency registration" in a VPLMN. + +##### 5.2.2.6.2 Providing acknowledgement of Steering of Roaming + +Figure 5.2.2.6.2-1 shows a scenario where the NF service consumer (e.g. AMF) sends the UE acknowledgement to the UDM (see also 3GPP TS 23.122 [20] Annex C). The request contains the UE's identity (/{supi}), the type of the acknowledgement information (/am-data/sor-ack), and the SOR-MAC-Iue. + +![Sequence diagram for Figure 5.2.2.6.2-1: Providing acknowledgement of Steering of Roaming. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. Step 1: A solid arrow points from the NF service consumer to the UDM with the message '1. PUT.../{supi}/am-data/sor-ack (AcknowledgeInfo)'. Step 2: A solid arrow points from the UDM back to the NF service consumer with the message '2. 204 No Content'.](0ee9d674085524d589646a6c3fb21ec3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. PUT.../{supi}/am-data/sor-ack (AcknowledgeInfo) + Note right of UDM: + UDM-->>NF service consumer: 2. 204 No Content + Note left of NF service consumer: +``` + +Sequence diagram for Figure 5.2.2.6.2-1: Providing acknowledgement of Steering of Roaming. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. Step 1: A solid arrow points from the NF service consumer to the UDM with the message '1. PUT.../{supi}/am-data/sor-ack (AcknowledgeInfo)'. Step 2: A solid arrow points from the UDM back to the NF service consumer with the message '2. 204 No Content'. + +**Figure 5.2.2.6.2-1: Providing acknowledgement of Steering of Roaming** + +1. The NF service consumer (e.g. AMF) sends a PUT request to the resource representing the UE's Access and Mobility Subscription Data, with the AcknowledgeInfo (SOR-MAC-Iue received from the UE, or UE not reachable indication). +2. The UDM responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.2.2.6.3 Providing acknowledgement of UE parameters update + +Figure 5.2.2.6.3-1 shows a scenario where the NF service consumer (e.g. AMF) sends the UE acknowledgement to the UDM (see also 3GPP TS 23.502 [3]). The request contains the UE's identity (/{supi}), the type of the acknowledgement information (/am-data/upu-ack), and the UPU-MAC-Iue. + +![Sequence diagram for Figure 5.2.2.6.3-1: Providing acknowledgement of UE parameters update. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. Step 1: A solid arrow points from the NF service consumer to the UDM with the message '1. PUT.../{supi}/am-data/upu-ack (AcknowledgeInfo)'. Step 2: A solid arrow points from the UDM back to the NF service consumer with the message '2. 204 No Content'.](df6b7ae63e53e5f93dbd0a70acdae4a6_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. PUT.../{supi}/am-data/upu-ack (AcknowledgeInfo) + Note right of UDM: + UDM-->>NF service consumer: 2. 204 No Content + Note left of NF service consumer: +``` + +Sequence diagram for Figure 5.2.2.6.3-1: Providing acknowledgement of UE parameters update. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. Step 1: A solid arrow points from the NF service consumer to the UDM with the message '1. PUT.../{supi}/am-data/upu-ack (AcknowledgeInfo)'. Step 2: A solid arrow points from the UDM back to the NF service consumer with the message '2. 204 No Content'. + +**Figure 5.2.2.6.3-1: Providing acknowledgement of UE parameters update** + +1. The NF service consumer (e.g. AMF) sends a PUT request to the resource representing the UE's Access and Mobility Subscription Data, with the AcknowledgeInfo(UPU-MAC-Iue received from the UE, or UE not reachable indication). +2. The UDM responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.2.2.6.4 Providing acknowledgement of UE for Network Slicing Subscription Change + +Figure 5.2.2.6.4-1 shows a scenario where the NF service consumer (e.g. AMF) sends the UE acknowledgement to the UDM (see also 3GPP TS 23.502 [3]). The request contains the UE's identity (/{supi}) and the type of the acknowledgement information (/am-data/subscribed-snssais-ack). + +![Sequence diagram for Figure 5.2.2.6.4-1: Providing acknowledgement of UE for Network Slicing Subscription Change. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. Step 1: A solid arrow points from the NF service consumer to the UDM with the text '1. PUT.../{supi}/am-data/subscribed-snssais-ack (AcknowledgeInfo)'. Step 2: A solid arrow points from the UDM back to the NF service consumer with the text '2. 204 No Content'.](fcbc3c31776721edc98ceb1944ec438f_img.jpg) + +Sequence diagram for Figure 5.2.2.6.4-1: Providing acknowledgement of UE for Network Slicing Subscription Change. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. Step 1: A solid arrow points from the NF service consumer to the UDM with the text '1. PUT.../{supi}/am-data/subscribed-snssais-ack (AcknowledgeInfo)'. Step 2: A solid arrow points from the UDM back to the NF service consumer with the text '2. 204 No Content'. + +**Figure 5.2.2.6.4-1: Providing acknowledgement of UE for Network Slicing Subscription Change** + +1. The NF service consumer (e.g. AMF) sends a PUT request to the resource representing the UE's Access and Mobility Subscription Data, with the AcknowledgeInfo. +2. The UDM responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.2.2.6.5 Providing acknowledgement of UE for CAG configuration change + +Figure 5.2.2.6.5-1 shows a scenario where the NF service consumer (e.g. AMF) sends the UE acknowledgement to the UDM (see also 3GPP TS 23.502 [3]). The request contains the UE's identity (/{supi}) and the type of the acknowledgement information (/am-data/cag-ack). + +![Sequence diagram for Figure 5.2.2.6.5-1: Providing acknowledgement of UE for CAG configuration change. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. Step 1: A solid arrow points from the NF service consumer to the UDM with the text '1. PUT.../{supi}/am-data/cag-ack (AcknowledgeInfo)'. Step 2: A solid arrow points from the UDM back to the NF service consumer with the text '2. 204 No Content'.](f1cbfa3fc27f58581615654fec4335d8_img.jpg) + +Sequence diagram for Figure 5.2.2.6.5-1: Providing acknowledgement of UE for CAG configuration change. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. Step 1: A solid arrow points from the NF service consumer to the UDM with the text '1. PUT.../{supi}/am-data/cag-ack (AcknowledgeInfo)'. Step 2: A solid arrow points from the UDM back to the NF service consumer with the text '2. 204 No Content'. + +**Figure 5.2.2.6.5-1: Providing acknowledgement of UE for CAG configuration change** + +1. The NF service consumer (e.g. AMF) sends a PUT request to the resource representing the UE's Access and Mobility Subscription Data, with the AcknowledgeInfo. +2. The UDM responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.2.2.6.6 Triggering Update of Steering Of Roaming information + +Figure 5.2.2.6.6-1 shows a scenario where the NF service consumer (e.g. AMF) sends the request to the UDM to trigger the update of Steering of Roaming information at the UE. The request contains the UE's identity (/{supi}), the type of request (/am-data/update-sor) and the VPLMN ID. + +![Sequence diagram showing the triggering update of Steering Of Roaming information. An NF service consumer sends a POST request to the UDM, and the UDM responds with a 200 OK.](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. POST.../{supi}/am-data/update-sor (SorUpdateInfo) + Note right of UDM: + UDM-->>NF service consumer: 2. 200 OK (SorInfo) + +``` + +Sequence diagram showing the triggering update of Steering Of Roaming information. An NF service consumer sends a POST request to the UDM, and the UDM responds with a 200 OK. + +**Figure 5.2.2.6.6-1: Triggering update of Steering Of Roaming information** + +1. The NF service consumer (e.g. AMF) sends a POST request to the resource representing the UE's Access and Mobility Subscription Data, with the request to update the Steering of Roaming information at the UE. +2. The UDM responds with "200 OK" containing the updated Sor Information. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.2.2.7 ModifySubscription + +##### 5.2.2.7.1 General + +The following procedures using the ModifySubscription service operation are supported: + +- Modification of a Subscription to notification of data change (for UE individual data) +- Modification of a Subscription to notification of shared data change + +The ModifySubscription service operation can be used for the following purpose: + +- Extend the expiry time of SdmSubscription; +- Modify the resource URIs to be monitored, e.g. add/remove resource URIs to/from the monitored resource URI list. + +##### 5.2.2.7.2 Modification of a subscription to notifications of data change + +Figure 5.2.2.7.2-1 shows a scenario where the NF service consumer sends a request to the UDM to modify a subscription to notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the modification of a subscription to notifications of data change. An NF service consumer sends a PATCH request to the UDM, and the UDM responds with either a 200 OK or a 404 Not Found.](6e612452d995bb03cc3f3d004493f7bf_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. PATCH.../{ueId}/sdm-subscriptions/{subscriptionId} (SdmSubsModification) + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (SdmSubscription) + Note right of UDM: + UDM-->>NF service consumer: 2b. 404 Not Found + +``` + +Sequence diagram showing the modification of a subscription to notifications of data change. An NF service consumer sends a PATCH request to the UDM, and the UDM responds with either a 200 OK or a 404 Not Found. + +**Figure 5.2.2.7.2-1: NF service consumer modifies a subscription to notifications** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. + +The NF service consumer may include "monitoredResourceUris" to replace the existing monitored resource URIs, e.g. to add/remove specific resource URIs from the monitored resource URI list. + +- 2a. On success, the UDM responds with "200 OK". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.2.2.7.3 Modification of a subscription to notifications of shared data change + +Figure 5.2.2.7.3-1 shows a scenario where the NF service consumer sends a request to the UDM to modify a subscription to notifications of shared data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for modifying a subscription. The consumer sends a PATCH request to a specific subscription ID. The UDM responds with either a 200 OK (success) or a 404 Not Found (failure).](896e86ed12aff206d302c64f2e3091fa_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note right of NF: 1. PATCH.../shared-data-subscriptions/{subscriptionId} +(SdmSubsModification) + NF->>UDM: Request + Note right of UDM: 2a. 200 OK (SdmSubscription) +2b. 404 Not Found + UDM-->>NF: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for modifying a subscription. The consumer sends a PATCH request to a specific subscription ID. The UDM responds with either a 200 OK (success) or a 404 Not Found (failure). + +**Figure 5.2.2.7.3-1: NF service consumer modifies a subscription to notifications for shared data** + +1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation. + +The NF service consumer may include "monitoredResourceUris" to replace the existing monitored resource URIs, e.g. for the purposes to add/remove specific resource URIs from the monitored resource URI list. + +- 2a. On success, the UDM responds with "200 OK". +- 2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +## 5.3 Nudm\_UEContextManagement Service + +### 5.3.1 Service Description + +See 3GPP TS 23.501 [2] table 7.2.5-1, 3GPP TS 33.501 [6] and 3GPP TS 23.632 [32]. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +For the Nudm\_UEContextManagement service the following service operations are defined: + +- Registration +- DeregistrationNotification + +- Deregistration +- Get +- Update +- P-CSCF-RestorationNotification +- P-CSCF-RestorationTrigger +- AMFDeregistration +- PEI-Update +- Roaming-Info-Update +- DataRestorationNotification +- SendRoutingInfoForSM +- StaleCheckNotification +- ReauthNotification +- AuthTrigger + +The Nudm\_UEContextManagement Service is used by Consumer NFs (AMF, SMF, SMSF, NWDAF) to register at the UDM by means of the Registration service operation. + +It is also used by the registered Consumer NFs (AMF) to get notified by means of the DeregistrationNotification service operation when UDM decides to deregister the registered consumer NF. + +It is also used by the registered Consumer NFs (AMF, SMF, SMSF, NWDAF) to deregister from the UDM by means of the Deregistration service operation. + +It is also used by consumer NFs (NEF, NWDAF, NSSAAF, DCCF, SMF) to retrieve registration information from the UDM by means of the Get service operation. + +It is also used by the registered Consumer NFs (AMF, SMF, NWDAF) to update registration information stored at the UDM by means of the Update service operation. + +It is also used by the registered Consumer NFs (AMF, SMF) to get notified by means of the P-CSCF-RestorationNotification service operation when UDM detects the need for P-CSCF restoration. + +It is also used by the consumer NF (HSS) to trigger P-CSCF restoration by means of the P-CSCF-RestorationTrigger service operation. + +It is also used by the consumer NF (HSS) to trigger deregistration of the registered AMF for 3GPP access by means of the AMFDeregistration service operation + +It is also used by the consumer NF (HSS) to update the stored PEI in e.g. the UDR, by means of the PEI-Update service operation. + +It is also used by the consumer NF (HSS) to update the stored Roaming Information in e.g. the UDR, by means of the Roaming-Info-Update service operation. + +It is also used by consumer NFs to retrieve NWDAF registration information from the UDM by means of the Get service operation. + +It is also used by consumer NFs to retrieve addressing information for MT SMS delivery, e.g. addressing of the IP-SM-GW, SMS Router or SMSF serving nodes in both 3GPP and non-3GPP accesses, by means of the SendRoutingInfoForSM service operation. + +It is also used by the registered Consumer NFs (AMF) to get notified by means of the ReauthNotification service operation when UDM detects the need for UE primary reauthentication. + +It is also used by the consumer NF (e.g. AAnF) to request UDM to trigger a primary (re-)authentication by means of the AuthTrigger service operation. + +#### 5.3.2.2 Registration + +##### 5.3.2.2.1 General + +The Registration service operation is invoked by a NF that has been selected to provide service to the UE to store related UE Context Management information in UDM. + +NF Consumers are AMF for access and mobility management service, SMF for session management services, SMSF providing SMS services and HSS for IP-SM-GW registration in SMSSoIP scenarios. + +As part of this registration procedure, the UDM authorizes or rejects the subscriber to use the service provided by the registered NF, based on subscription data (e.g. roaming restrictions). + +The following procedures using the Registration service operation are supported: + +- AMF registration for 3GPP access +- AMF registration for non-3GPP access +- SMF registration +- SMSF registration for 3GPP access +- SMSF registration for non-3GPP access +- IP-SM-GW registration +- NWDAF registration + +##### 5.3.2.2.2 AMF registration for 3GPP access + +Figure 5.3.2.2.2-1 shows a scenario where the AMF sends a request to the UDM to update the AMF registration information for 3GPP access (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains the UE's identity (/{ueId}) which shall be a SUPI and the AMF Registration Information for 3GPP access. + +![Sequence diagram showing AMF sending a PUT request to UDM for 3GPP access registration. The request is '1. PUT .../{ueId}/registrations/amf-3gpp-access (Amf3GppAccessRegistration)'. The response includes '2a. 200 OK / 204 No Content', '2b. 201 Created', '2c. 403 Forbidden', and '2d. General failure error codes'.](6757222e979ee95c44354a897c5cc1c1_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM + Note left of AMF: AMF sends registration request + AMF->>UDM: 1. PUT .../{ueId}/registrations/amf-3gpp-access (Amf3GppAccessRegistration) + Note right of UDM: UDM processes request + UDM-->>AMF: 2a. 200 OK / 204 No Content + UDM-->>AMF: 2b. 201 Created + UDM-->>AMF: 2c. 403 Forbidden + UDM-->>AMF: 2d. General failure error codes + +``` + +Sequence diagram showing AMF sending a PUT request to UDM for 3GPP access registration. The request is '1. PUT .../{ueId}/registrations/amf-3gpp-access (Amf3GppAccessRegistration)'. The response includes '2a. 200 OK / 204 No Content', '2b. 201 Created', '2c. 403 Forbidden', and '2d. General failure error codes'. + +**Figure 5.3.2.2.2-1: AMF registering for 3GPP access** + +1. The AMF sends a PUT request to the resource representing the UE's AMF registration for 3GPP access to update or create AMF registration information. + +If EPS interworking with N26 is supported, and the AMF has per DNN selected the PGW-C+SMF for EPS interworking, the AMF shall include the info of selected PGW-C+SMF to the UDM. + +The AMF shall include ueReachableInd IE if the UE is currently not reachable (e.g. in not allowed areas) or the + +UE reachability is unknown (e.g. service restriction area of the UE is not received at the AMF during initial registration). + +The AMF shall include the "backupAmfInfo" IE containing all of the GUAMI served by the AMF and the related backup AMF name if the AMF supports the AMF management without UDSF as specified in clause 6.5.2 of 3GPP TS 29.500 [4]. The "backupAmfInfo" IE is only applicable to this UE in 3GPP access. + +- 2a. On success, the UDM updates the Amf3GppAccessRegistration resource by replacing it with the received resource information, and responds with "200 OK" or "204 No Content". + +UDM shall invoke the Deregistration Notification service operation towards the old AMF using the callback URI provided by the old AMF. + +When AMF indicates there are no ongoing event subscriptions (e.g. during UE initial registration), but UDM has ongoing event exposure subscriptions stored (e.g. in UDR), UDM shall invoke one Namf\_EventExposure Subscribe Service operations (see clause 5.3.2.2 of 3GPP TS 29.518 [36]) on behalf of NEF per subscription stored. When the AMF identified that event synchronization is needed but AMF and/or UDM are not supporting event synchronization (see clause 5.3.2.4.2 of 3GPP TS 29.518 [36]), the AMF may also ask the UDM to re-subscribe the stored events by indicating there is no ongoing event subscriptions in the UECM operation. + +If ueReachableInd IE is received indicating that the UE is not reachable, the UDM shall not trigger Reachability Report for the UE upon this UECM registration. The AMF shall subsequently generate UE Reachability Report when it detects the UE is reachable. If the If ueReachableInd IE is received indicating that the UE reachability is unknown, the UDM may trigger Reachability Report for the UE when needed based on operator policy. + +- 2b. If the resource does not exist (there is no previous AMF information stored in UDM for that user), UDM stores the received AMF registration data for 3GPP access and responds with HTTP Status Code "201 created". A response body may be included to convey additional information to the NF consumer (e.g., features supported by UDM). +- 2c. If the operation cannot be authorized due to e.g UE does not have required subscription data, the AMF does not support CAG feature and the UE is allowed to access 5GS via CAG cell(s) only, access barring, roaming restrictions, core network restriction, or if an UE performs registration in an SNPN using credentials from the Credentials Holder, but it is not authorized to access the SNPN, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +NOTE: Clause 5.4.2.2 in 3GPP TS 29.505 [10] explains how an UDM determines if the UE, which performs registration in an SNPN using credentials from a Credentials Holder is authorized to access the specific SNPN. + +- 2d. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.3.2.2.3 AMF registration for non 3GPP access + +Figure 5.3.2.2.3-1 shows a scenario where the AMF sends a request to the UDM to update the AMF registration information for non 3GPP access (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14). The request contains the UE's identity (/{ueId}) which shall be a SUPI and the AMF Registration Information for non 3GPP access. + +![Sequence diagram showing AMF registration for non 3GPP access. The AMF sends a PUT request to the UDM. The UDM responds with one of three possible status codes: 200 OK / 204 No Content, 201 Created, or 403 Forbidden.](2dfd7b53bd3c518fc1f68921ed2bf441_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM + Note left of AMF: AMF sends registration request + AMF->>UDM: 1. PUT .../{ueId}/registrations/amf-non-3gpp-access (AmfNon3GppAccessRegistration) + Note right of UDM: Possible responses + UDM-->>AMF: 2a. 200 OK / 204 No Content + UDM-->>AMF: 2b. 201 Created + UDM-->>AMF: 2c. 403 Forbidden + +``` + +Sequence diagram showing AMF registration for non 3GPP access. The AMF sends a PUT request to the UDM. The UDM responds with one of three possible status codes: 200 OK / 204 No Content, 201 Created, or 403 Forbidden. + +Figure 5.3.2.2.3-1: AMF registering for non 3GPP access + +1. The AMF sends a PUT request to the resource representing the UE's AMF registration for non 3GPP access to update or create AMF registration information. + +The AMF shall include the "backupAmfInfo" IE containing all of the GUAMI served by the AMF and the related backup AMF name if the AMF supports the AMF management without UDSF as specified in clause 6.5.2 of 3GPP TS 29.500 [4]. The "backupAmfInfo" IE is only applicable to this UE in non 3GPP access. + +- 2a. On success, the UDM updates the AmfNon3GppAccessRegistration resource by replacing it with the received resource information, and responds with "200 OK" or "204 No Content". + +UDM shall invoke the Deregistration Notification service operation towards the old AMF using the callback URI provided by the old AMF. + +When AMF indicates there are no ongoing event subscriptions (e.g. during UE initial registration), but UDM has ongoing event exposure subscriptions stored (e.g. in UDR), UDM shall invoke one Namf\_EventExposure Subscribe Service operations (see clause 5.3.2.2 of 3GPP TS 29.518 [36]) on behalf of NEF per subscription stored. When the AMF identified that event synchronization is needed but AMF and/or UDM are not supporting event synchronization (see clause 5.3.2.4.2 of 3GPP TS 29.518 [36]), the AMF may also ask the UDM to re-subscribe the stored events by indicating there is no ongoing event subscriptions in the UECM operation. + +- 2b. If the resource does not exist (there is no previous AMF information stored in UDM for that user), UDM stores the received AMF registration data for non-3GPP access and responds with HTTP Status Code "201 created". A response body may be included to convey additional information to the NF consumer (e.g., features supported by UDM). +- 2c. If the operation cannot be authorized due to e.g UE does not have required subscription data, the AMF does not support CAG feature and the UE is allowed to access 5GS via CAG cell(s) only, access barring, roaming restrictions or core network restriction, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.3.2.2.4 SMF registration + +Figure 5.3.2.2.4-1 shows a scenario where an SMF sends a request to the UDM to create a new registration (see also 3GPP TS 23.502 [3] clause 4.3.2.2.1 step 16c and clause 4.26.5.3 step 11). The request contains the UE's identity ({ueId}) which shall be a SUPI and the SMF Registration Information. + +![Sequence diagram for SMF registration. The SMF sends a PUT request to the UDM for a specific UE's SMF registration. The UDM responds with one of three possible status codes: 201 Created, 200 OK, or 403 Forbidden.](19d7a7ce68d3e9036613910b761c4b24_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant UDM + Note right of SMF: 2. PUT .../{ueId}/registrations/smf-registrations/{pduSessionId} (SmfRegistration) + SMF->>UDM: Request + Note left of UDM: 2a. 201 Created (SmfRegistration) + Note left of UDM: 2b. 200 OK (SmfRegistration) + Note left of UDM: 2c. 403 Forbidden + UDM-->>SMF: Response + +``` + +Sequence diagram for SMF registration. The SMF sends a PUT request to the UDM for a specific UE's SMF registration. The UDM responds with one of three possible status codes: 201 Created, 200 OK, or 403 Forbidden. + +**Figure 5.3.2.2.4-1: SMF registration** + +1. The SMF sends a PUT request to the resource .../{ueId}/registrations/smf-registrations/{pduSessionId}, to create an SMF Registration as present in the message body. + +During SM Context Transfer procedure (see clause 4.26.5.3 of 3GPP TS 23.502 [3]) the SMF shall include registrationReason IE set to the value "SMF\_CONTEXT\_TRANSFERRED" in the message body. + +If the SMF belongs to an SMF Set, the NF Set ID of the SMF Set shall be included in the request message. + +If EPS interworking is supported, the SMF+PGW-C shall include the PCF ID selected for the PDU session to the UDM when the SMF+PGW-C register in the UDM. + +2a. The UDM responds with "201 Created" with the message body containing a representation of the created SMF registration. + +2b. If the individual resource exists, on success, the UDM updates the resource by replacing it with the received resource information, and responds with "200 OK" with the message body containing a representation of the updated Individual SmfRegistration resource. + +If the new SMF is not in a SMF set or is not in the same SMF Set as the old SMF, the UDM shall invoke the Deregistration Notification service operation towards the old SMF using the callback URI provided by the old SMF. + +2c. If the operation cannot be authorized due to e.g UE does not have required subscription data, access barring or roaming restrictions, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). Subscription information associated to a specific DNN (if any) shall take precedence over subscription information associated to the Wildcard DNN. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.3.2.2.5 SMSF Registration for 3GPP Access + +Figure 5.3.2.2.5-1 shows a scenario where the SMSF sends a request to the UDM to create or update the SMSF registration information for 3GPP access (see also 3GPP TS 23.502 [3], clause 4.13.3.1). The request contains the UE's identity (/{ueId}) which shall be a SUPI and the SMSF Registration Information for SMS service. + +When a UE requests SMS service from both 3GPP access and Non-3GPP access, the SMSF shall perform separate individual SMSF registration for each access type. + +![Sequence diagram showing SMSF sending a PUT request to UDM for 3GPP access registration. The diagram shows two lifelines: SMSF and UDM. Step 1: SMSF sends a PUT request to UDM. Step 2a: UDM responds with 200 OK or 201 Created. Step 2b: UDM responds with 403 Forbidden.](ddd86d7df6cf14d68c0faf111c1e8fae_img.jpg) + +``` + +sequenceDiagram + participant SMSF + participant UDM + Note right of SMSF: 1. PUT .../{ueId}/registrations/smsf-3gpp-access (SmsfRegistration) + SMSF->>UDM: 1. PUT .../{ueId}/registrations/smsf-3gpp-access (SmsfRegistration) + Note right of UDM: 2a. 200 OK / 201 Created (SmsfRegistration) + UDM-->>SMSF: 2a. 200 OK / 201 Created (SmsfRegistration) + Note right of UDM: 2b. 403 Forbidden + UDM-->>SMSF: 2b. 403 Forbidden + +``` + +Sequence diagram showing SMSF sending a PUT request to UDM for 3GPP access registration. The diagram shows two lifelines: SMSF and UDM. Step 1: SMSF sends a PUT request to UDM. Step 2a: UDM responds with 200 OK or 201 Created. Step 2b: UDM responds with 403 Forbidden. + +**Figure 5.3.2.2.5-1: SMSF registering for 3GPP Access** + +1. The SMSF sends a PUT request to the resource representing the UE's SMSF registration for 3GPP Access to update or create SMSF registration information. + +If the SMSF supports SBI-based MT SM transmit, the "SBI support indication" of the SMSF shall be included in the SMSF registration information. + +If the SMSF belongs to an SMSF Set, the NF Set ID of the SMSF Set shall be included in the request message. + +2a. If successful, the UDM responds with "200 OK", or "201 Created" with the message body containing the representation of the SmsfRegistration. + +2b. If the operation cannot be authorized due to e.g UE does not have required subscription data, access barring or roaming restrictions, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.3.2.2.6 SMSF Registration for Non 3GPP Access + +Figure 5.3.2.2.6-1 shows a scenario where the SMSF sends a request to the UDM to create or update the SMSF registration information for non 3GPP access (see also 3GPP TS 23.502 [3], clause 4.13.3.1). The request contains the UE's identity (`{ueId}`) which shall be a SUPI and the SMSF Registration Information for SMS service. + +When a UE requests SMS service from both 3GPP access and Non-3GPP access, the SMSF shall perform separate individual SMSF registration for each access type. + +![Sequence diagram for SMSF registration for Non 3GPP Access. The diagram shows two lifelines: SMSF and UDM. The SMSF sends a PUT request to the UDM for the resource .../{ueId}/registrations/smsf-non-3gpp-access. The UDM responds with either 200 OK / 201 Created (SmsfRegistration) or 403 Forbidden.](a5184899f915014fa38608754efcc9c7_img.jpg) + +``` + +sequenceDiagram + participant SMSF + participant UDM + Note right of SMSF: 1. PUT .../{ueId}/registrations/smsf-non-3gpp-access (SmsfRegistration) + SMSF->>UDM: 1. PUT .../{ueId}/registrations/smsf-non-3gpp-access (SmsfRegistration) + Note left of UDM: 2a. 200 OK / 201 Created (SmsfRegistration) + Note left of UDM: 2b. 403 Forbidden + UDM-->>SMSF: 2a. 200 OK / 201 Created (SmsfRegistration) + UDM-->>SMSF: 2b. 403 Forbidden + +``` + +Sequence diagram for SMSF registration for Non 3GPP Access. The diagram shows two lifelines: SMSF and UDM. The SMSF sends a PUT request to the UDM for the resource .../{ueId}/registrations/smsf-non-3gpp-access. The UDM responds with either 200 OK / 201 Created (SmsfRegistration) or 403 Forbidden. + +**Figure 5.3.2.2.6-1: SMSF registering for Non 3GPP Access** + +- The SMSF sends a PUT request to the resource representing the UE's SMSF registration for Non 3GPP Access to update or create SMSF registration information. + +If the SMSF supports SBI-based MT SM transmit, the "SBI support indication" of the SMSF shall be included in the SMSF registration information. + +If the SMSF belongs to an SMSF Set, the NF Set ID of the SMSF Set shall be included in the request message. + +- If successful, the UDM responds with "200 OK", or "201 Created" with the message body containing the representation of the SmsfRegistration. +- If the operation cannot be authorized due to e.g UE does not have required subscription data, access barring or roaming restrictions, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.3.2.2.7 IP-SM-GW registration + +Figure 5.3.2.2.7-1 shows a scenario where an HSS sends a request to the UDM to create a new registration of an IP-SM-GW (see also 3GPP TS 23.632 [32] figure 5.5.6.2.1-1 step 2). The request contains the UE's identity (`{ueId}`) which shall be a SUPI and the IP-SM-GW registration information. + +![Sequence diagram for IP-SM-GW registration. The diagram shows two lifelines: HSS and UDM. The HSS sends a PUT request to the UDM for the resource .../{ueId}/registrations/ip-sm-gw. The UDM responds with either 201 Created (IpSmGwRegistration), 200 OK (IpSmGwRegistration), or 403 Forbidden.](6ff6e507698d693fcd1ae210ac1ab954_img.jpg) + +``` + +sequenceDiagram + participant HSS + participant UDM + Note right of HSS: 2. PUT .../{ueId}/registrations/ip-sm-gw (IpSmGwRegistration) + HSS->>UDM: 2. PUT .../{ueId}/registrations/ip-sm-gw (IpSmGwRegistration) + Note left of UDM: 2a. 201 Created (IpSmGwRegistration) + Note left of UDM: 2b. 200 OK (IpSmGwRegistration) + Note left of UDM: 2c. 403 Forbidden + UDM-->>HSS: 2a. 201 Created (IpSmGwRegistration) + UDM-->>HSS: 2b. 200 OK (IpSmGwRegistration) + UDM-->>HSS: 2c. 403 Forbidden + +``` + +Sequence diagram for IP-SM-GW registration. The diagram shows two lifelines: HSS and UDM. The HSS sends a PUT request to the UDM for the resource .../{ueId}/registrations/ip-sm-gw. The UDM responds with either 201 Created (IpSmGwRegistration), 200 OK (IpSmGwRegistration), or 403 Forbidden. + +**Figure 5.3.2.2.7-1: IP-SM-GW registration** + +- The HSS sends a PUT request to the resource `.../{ueId}/registrations/ip-sm-gw`, to create an IP-SM-GW registration as present in the message body. + +If the IP-SM-GW indicated support for SBI-based SMS when registering in HSS, "SBI Support Indication" shall be included in the IP-SM-GW registration information. + +- 2a. If there was not a prior registration, the UDM responds with "201 Created" with the message body containing a representation of the created IP-SM-GW registration. +- 2b. If there was a prior registration, the UDM responds with "200 OK" with the message body containing a representation of the updated IP-SM-GW registration. +- 2c. If the operation cannot be authorized due to e.g UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.3.2.2.8 NWDAF registration + +Figure 5.3.2.2.8-1 shows a scenario where an NWDAF sends a request to the UDM to create a new registration. The request contains the UE's identity (/{ueId}) which shall be a SUPI, the NWDAF's registration identity (/{nwdafRegistrationId}), and the NWDAF Registration Information. + +![Sequence diagram showing NWDAF registration. The NWDAF sends a PUT request to the UDM. The UDM responds with 200 OK / 201 Created or 403 Forbidden.](a97518a839da75f8379c578562b01bc2_img.jpg) + +``` + +sequenceDiagram + participant NWDAF + participant UDM + Note left of NWDAF: 2. PUT .../{ueId}/registrations/nwdaf-registrations/{nwdafRegistrationId}(NwdafRegistration) + NWDAF->>UDM: Request + Note right of UDM: 2a. 200 OK / 201 Created (NwdafRegistration) +2b. 403 Forbidden + UDM-->>NWDAF: Response + +``` + +Sequence diagram showing NWDAF registration. The NWDAF sends a PUT request to the UDM. The UDM responds with 200 OK / 201 Created or 403 Forbidden. + +**Figure 5.3.2.2.8-1: NWDAF registration** + +1. The NWDAF sends a PUT request to the resource .../{ueId}/registrations/nwdaf-registrations/{nwdafRegistrationId}, to create an NWDAF Registration as present in the message body. + +NOTE 1: nwdafRegistrationId could be the NfInstanceId, the combination of NfSetId and NfInstanceId or other identifier forms of the NWDAF. NWDAF implementation shall secure the global uniqueness of this resource ID. + +- 2a. The UDM responds with "200 OK" or "201 Created" with the message body containing a representation of the created NWDAF registration. +- 2b. If the operation cannot be authorized due to e.g UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +#### 5.3.2.3 DeregistrationNotification + +##### 5.3.2.3.1 General + +The following procedure using the DeregistrationNotification service operation is supported: + +- UDM initiated NF Deregistration + +##### 5.3.2.3.2 UDM initiated NF Deregistration + +Figure 5.3.2.3.2-1 shows a scenario where the UDM notifies the registered NF about its deregistration (see also 3GPP TS 23.502 [3] figure 4.2.2.2.2-1 step 14, 3GPP TS 23.502 [3] figure 4.2.2.3.3-1 step 1 and 3GPP TS 23.502 [3] figure 4.26.4.1.1-1 step 14). The request contains the deregCallbackUri URI for deregistration notification as received by the UDM during registration, and Deregistration Data. + +The UDM initiates the deregistration procedure when the UE is registered to the AMF which does not support CAG feature and the CAG subscription of the UE changes and it is allowed to access the 5GS via CAG cell(s) only. + +The UDM also initiates deregistration notification when UE moves to different AMF within same AMF-Set. + +The UDM may also initiate deregistration notification for the disaster inbound roaming UE when a disaster condition is no longer being applicable. + +Deregistration notification shall not be sent if the nfInstanceId of the AMF initiating registration is same as the old AMF already registered in UDM (e.g. when multiple PLMNs are hosted on same AMF and UE moves across PLMNs). + +The UDM also initiates the deregistration procedures towards the SMF of the old PDU session when a new PDU session has been established with the same PDU session ID from a different SMF, during SM Context Transfer procedure (see clause 4.26.5.3 of 3GPP TS 23.502 [3]) or when duplicated PDU sessions existing in the network (e.g. the AMF failed to release the old PDU session before creation of the new PDU session with the same PDU session ID). + +![Sequence diagram showing UDM initiated NF Deregistration. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. A dashed vertical line extends downwards from each box. The sequence of messages is: 1. A solid horizontal arrow points from the UDM lifeline to the NF service consumer lifeline, labeled '1. POST {deregCallbackUri} (DeregistrationData)'. 2a. A solid horizontal arrow points from the NF service consumer lifeline to the UDM lifeline, labeled '2a. 204 No Content or 200 OK'. 2b. A solid horizontal arrow points from the UDM lifeline to the NF service consumer lifeline, labeled '2b. 4xx/5xx (Problem Details) or 3xx'.](762a17cd79880dbca172bcbbe9375223_img.jpg) + +Sequence diagram showing UDM initiated NF Deregistration. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. A dashed vertical line extends downwards from each box. The sequence of messages is: 1. A solid horizontal arrow points from the UDM lifeline to the NF service consumer lifeline, labeled '1. POST {deregCallbackUri} (DeregistrationData)'. 2a. A solid horizontal arrow points from the NF service consumer lifeline to the UDM lifeline, labeled '2a. 204 No Content or 200 OK'. 2b. A solid horizontal arrow points from the UDM lifeline to the NF service consumer lifeline, labeled '2b. 4xx/5xx (Problem Details) or 3xx'. + +**Figure 5.3.2.3.2-1: UDM initiated NF Deregistration** + +1. The UDM sends a POST request to the deregCallbackUri as provided by the NF service consumer during the registration. + +If the SMF deregistration is triggered by SM Context Transfer procedure, i.e. the UDM has received a registration request with registrationReason IE set to the value "SMF\_CONTEXT\_TRANSFERRED" from another SMF, the UDM shall set the deregReason IE to the value "SMF\_CONTEXT\_TRANSFERRED". If the SMF deregistration is due to duplicated PDU sessions in the network, i.e. the UDM has received a registration request from another SMF without registrationReason IE set to the value "SMF\_CONTEXT\_TRANSFERRED", the UDM shall set the deregReason IE to the value "DUPLICATE\_PDU\_SESSION". + +If the SMF deregistration is due to an UDM-triggered PDU session release with re-activation, the UDM shall set the deregReason attribute in DeregistrationData to the value "PDU\_SESSION\_REACTIVATION\_REQUIRED"; in this case, the SMF shall trigger a network-initiated PDU session release procedure (see clause 4.3.4 of 3GPP TS 23.502 [3]) with 5GSM cause "Reactivation requested" (see clause 8.3.14 of 3GPP TS 24.501 [27]) + +- 2a. On success, the NF service consumer responds with "204 No Content" if no information is to be sent to the UDM. Otherwise, if the "DeregistrationResponseBody" feature is supported by both the UDM and the NF service consumer, the NF service consumer (e.g. the SMF) responds with "200 OK" with the response body including the information to the UDM (e.g. the indication that the SMF event subscription on the SMF for the UE have been implicitly removed). + +An SMF receiving the deregistration notification shall release the PDU session but shall not send a SM Context Status Notification to the AMF. For a PDU session with I-SMF or V-SMF, the anchor SMF shall send a Status Notification to the I-SMF or V-SMF indicating that the PDU session is released due to duplicated PDU sessions. + +2b. On failure or redirection, one of the appropriate HTTP status code listed in Table 6.2.5.2-3 shall be returned. For a 4xx/5xx response, the message body may contain appropriate additional error information. + +#### 5.3.2.4 Deregistration + +##### 5.3.2.4.1 General + +The following procedures using the Deregistration service operation are supported: + +- AMF deregistration for 3GPP access +- AMF deregistration for non-3GPP access +- SMF deregistration +- SMSF deregistration for 3GPP access +- SMSF deregistration for non-3GPP access +- IP-SM-GW deregistration +- NWDAF deregistration + +##### 5.3.2.4.2 AMF deregistration for 3GPP access + +Figure 5.3.2.4.2-1 shows a scenario where the AMF sends a request to the UDM to deregister (purge) from the UDM for 3GPP access (see also 3GPP TS 23.502 [3] figure 4.5.3.1-1 step 3). The request contains the UE's identity (/{ueId}) which shall be a SUPI and an instruction to set the purgeFlag within the Amf3GppAccessRegistration resource. + +![Sequence diagram showing AMF sending a PATCH request to UDM for 3GPP access deregistration. The AMF sends a PATCH request to the UDM. The UDM responds with either 2a. 204 No Content or 2b. 403 Forbidden.](659a041a7997f9eea79f4e2f3ba265a5_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM + Note right of AMF: 1. PATCH .../{ueId}/registrations/amf-3gpp-access +(Instruction: set PurgeFlag) + AMF->>UDM: Request + Note right of UDM: 2a. 204 No Content + UDM-->>AMF: Response 2a + Note right of UDM: 2b. 403 Forbidden + UDM-->>AMF: Response 2b + +``` + +Sequence diagram showing AMF sending a PATCH request to UDM for 3GPP access deregistration. The AMF sends a PATCH request to the UDM. The UDM responds with either 2a. 204 No Content or 2b. 403 Forbidden. + +**Figure 5.3.2.4.2-1: AMF deregistering for 3GPP access** + +1. The AMF sends a PATCH request to the resource representing the UE's AMF registration for 3GPP access. +- 2a. The UDM shall check whether the received GUAMI matches the stored GUAMI. If so, the UDM shall set the PurgeFlag. The UDM responds with "204 No Content". +- 2b. Otherwise the UDM responds with "403 Forbidden". + +NOTE: Based on operator policy, when AMF receives 403 Forbidden, the AMF can avoid freezing the 5G-TMSI that the UE used, under consideration that the UE has been assigned another 5G-TMSI by another AMF. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.3.2.4.3 AMF deregistration for non-3GPP access + +Figure 5.3.2.4.3-1 shows a scenario where the AMF sends a request to the UDM to deregister (purge) from the UDM for non-3GPP access (see also 3GPP TS 23.502 [3] figure 4.5.3.1-1 step 3). The request contains the UE's identity (`{ueId}`) which shall be a SUPI and an instruction to set the `purgeFlag` within the `AmfNon3GppAccessRegistration` resource. + +![Sequence diagram for AMF deregistration for non-3GPP access](73b28b0f5e3be628bb5a3d6bd1d79d21_img.jpg) + +``` +sequenceDiagram + participant AMF + participant UDM + Note right of AMF: 1. PATCH .../{ueId}/registrations/amf-non-3gpp-access +(Instruction: set PurgeFlag) + AMF->>UDM: 1. PATCH .../{ueId}/registrations/amf-non-3gpp-access +(Instruction: set PurgeFlag) + Note left of UDM: 2a. 204 No Content + UDM-->>AMF: 2a. 204 No Content + Note left of UDM: 2b. 403 Forbidden + UDM-->>AMF: 2b. 403 Forbidden +``` + +Sequence diagram for AMF deregistration for non-3GPP access + +**Figure 5.3.2.4.3-1: AMF deregistering for non-3GPP access** + +1. The AMF sends a PATCH request to the resource representing the UE's AMF registration for non-3GPP access. +- 2a. The UDM shall check whether the received GUAMI matches the stored GUAMI. If so, the UDM shall set the `PurgeFlag`. The UDM responds with "204 No Content". +- 2b. Otherwise the UDM responds with "403 Forbidden". + +NOTE: Based on operator policy, when AMF receives 403 Forbidden, the AMF can avoid freezing the 5G-TMSI that the UE used, under consideration that the UE has been assigned another 5G-TMSI by another AMF. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.3.2.4.4 SMF deregistration + +Figure 5.3.2.4.4-1 shows a scenario where the SMF sends a request to the UDM to deregister an individual SMF registration (see also 3GPP TS 23.502 [3] figure 4.3.2.2-1 step 20). The request contains the UE's identity (`{ueId}`) which shall be a SUPI and the PDU Session ID (`{pduSessionId}`). + +![Sequence diagram for SMF deregistration](a89d151b67109378baed0c117830cf78_img.jpg) + +``` +sequenceDiagram + participant SMF + participant UDM + Note right of SMF: 1. DELETE .../{ueId}/registrations/smf-registrations/ +{pduSessionId} + SMF->>UDM: 1. DELETE .../{ueId}/registrations/smf-registrations/ +{pduSessionId} + Note left of UDM: 2. 204 No Content + UDM-->>SMF: 2. 204 No Content +``` + +Sequence diagram for SMF deregistration + +**Figure 5.3.2.4.4-1: SMF deregistration** + +1. The SMF sends a DELETE request to the resource representing the individual SMF registration that is to be deregistered. + +When the SMF deregisters the last PDU session for a UE on the UDM, the SMF should include an indication to inform the UDM if all SMF event subscriptions for the UE previously created on the SMF have been implicitly unsubscribed. + +2. The UDM responds with "204 No Content". If the SMF had requested the SDM Subscription to be created with the "implicitUnsubscribe" flag set, then UDM will terminate the SDM Subscription when the last PDU Session for that SUPI and SMF is deregistered. + +If the UDM has received the indication that the SMF event subscriptions have been implicitly unsubscribed in the request, the UDM should not send requests to unsubscribe the SMF event subscriptions on the SMF for the UE. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +##### 5.3.2.4.5 SMSF Deregistration for 3GPP Access + +Figure 5.3.2.4.5-1 shows a scenario where the SMSF sends a request to the UDM to delete the SMSF registration information for 3GPP access (see also 3GPP TS 23.502 [3], clause 4.13.3.2). The request contains the UE's identity (`{ueId}`) which shall be a SUPI. + +For a UE previously requests SMS service from both 3GPP access and Non-3GPP access, if SMS service is disabled from one access type, the SMSF shall only delete the corresponding SMSF registration for that access type. If SMS service is disabled from both 3GPP access and Non-3GPP access, the SMSF shall delete the SMSF registration for both access types. + +![Sequence diagram for SMSF Deregistration for 3GPP Access](772cc583a60eeb058cc19de48269ad22_img.jpg) + +``` +sequenceDiagram + participant SMSF + participant UDM + Note left of SMSF: + SMSF->>UDM: 1. DELETE .../{ueId}/registrations/smsf-3gpp-access + Note right of UDM: + UDM-->>SMSF: 2. 204 No Content + Note left of SMSF: +``` + +The diagram shows a sequence of two messages between the SMSF and the UDM. The SMSF sends a DELETE request to the UDM for the resource `.../{ueId}/registrations/smsf-3gpp-access`. The UDM responds with a 204 No Content status. + +Sequence diagram for SMSF Deregistration for 3GPP Access + +Figure 5.3.2.4.5-1: SMSF Deregistering for 3GPP Access + +1. The SMSF sends a DELETE request to the resource representing the UE's SMSF registration for 3GPP access. +2. If successful, the UDM responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +##### 5.3.2.4.6 SMSF Deregistration for Non 3GPP Access + +Figure 5.3.2.4.6-1 shows a scenario where the SMSF sends a request to the UDM to delete the SMSF registration information for non 3GPP access (see also 3GPP TS 23.502 [3], clause 4.13.3.2). The request contains the UE's identity (`{ueId}`) which shall be a SUPI. + +For a UE previously requests SMS service from both 3GPP access and Non-3GPP access, if SMS service is disabled from one access type, the SMSF shall only delete the corresponding SMSF registration for that access type. If SMS service is disabled from both 3GPP access and Non-3GPP access, the SMSF shall delete the SMSF registration for both access types. + +![Sequence diagram for SMSF Deregistration for Non 3GPP Access](1878426572e3fcbc4483578a685d7c7d_img.jpg) + +``` +sequenceDiagram + participant SMSF + participant UDM + Note left of SMSF: + SMSF->>UDM: 1. DELETE .../{ueId}/registrations/smsf-non-3gpp-access + Note right of UDM: + UDM-->>SMSF: 2. 204 No Content + Note left of SMSF: +``` + +The diagram shows a sequence of two messages between the SMSF and the UDM. The SMSF sends a DELETE request to the UDM for the resource `.../{ueId}/registrations/smsf-non-3gpp-access`. The UDM responds with a 204 No Content status. + +Sequence diagram for SMSF Deregistration for Non 3GPP Access + +Figure 5.3.2.4.6-1: SMSF Deregistering for Non 3GPP Access + +1. The SMSF sends a DELETE request to the resource representing the UE's SMSF registration for non 3GPP access. +2. If successful, the UDM responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +##### 5.3.2.4.7 IP-SM-GW deregistration + +Figure 5.3.2.4.7-1 shows a scenario where the HSS sends a request to the UDM to deregister the IP-SM-GW from the UDM (see also 3GPP TS 23.632 [32] figure 5.5.6.2-2 step 2). The request contains the UE's identity (*{ueId}*) which shall be a SUPI. + +![Sequence diagram for IP-SM-GW deregistration showing HSS sending a DELETE request to UDM and UDM responding with 204 No Content.](fd76efce549d3713543bb5ed9b023c2e_img.jpg) + +``` +sequenceDiagram + participant HSS + participant UDM + Note left of HSS: + HSS->>UDM: 1. DELETE .../{ueId}/registrations/ip-sm-gw + Note right of UDM: + UDM-->>HSS: 2. 204 No Content + Note left of HSS: +``` + +Sequence diagram for IP-SM-GW deregistration showing HSS sending a DELETE request to UDM and UDM responding with 204 No Content. + +**Figure 5.3.2.4.7-1: IP-SM-GW deregistration** + +1. The HSS sends a DELETE request to the resource representing the UE's IP-SM-GW registration. +2. The UDM responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +##### 5.3.2.4.8 NWDAF deregistration + +Figure 5.3.2.4.8-1 shows a scenario where the NWDAF sends a request to the UDM to deregister the NWDAF from the UDM. The request contains the UE's identity (*{ueId}*) which shall be a SUPI, and the NWDAF's registration identity (*{nwdafRegistrationId}*). + +![Sequence diagram for NWDAF deregistration showing NWDAF sending a DELETE request to UDM and UDM responding with 204 No Content.](f9528ea5b0d2cd0192b7242e5a6af969_img.jpg) + +``` +sequenceDiagram + participant NWDAF + participant UDM + Note left of NWDAF: + NWDAF->>UDM: 1. DELETE .../{ueId}/registrations/nwdaf-registrations/{nwdafRegistrationId} + Note right of UDM: + UDM-->>NWDAF: 2. 204 No Content + Note left of NWDAF: +``` + +Sequence diagram for NWDAF deregistration showing NWDAF sending a DELETE request to UDM and UDM responding with 204 No Content. + +**Figure 5.3.2.4.8-1: NWDAF deregistration** + +1. The NWDAF sends a DELETE request to the resource representing the UE's NWDAF registration. +2. The UDM responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +#### 5.3.2.5 Get + +##### 5.3.2.5.1 General + +The following procedures using the Get service operation are supported: + +- Amf3GppAccessRegistration Information Retrieval +- AmfNon3GppAccessRegistration Information Retrieval +- SmfRegistrations Information Retrieval +- SmsfRegistration Information Retrieval for 3GPP Access +- SmsfRegistration Information Retrieval for Non-3GPP Access +- Location Information Retrieval +- Retrieval Of Multiple UE Registration Data Sets +- IP-SM-GW Registration Information Retrieval +- NwdafRegistration Information Retrieval + +##### 5.3.2.5.2 Amf3GppAccessRegistration Information Retrieval + +Figure 5.3.2.5.2-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to retrieve the UE's Amf3GppAccessRegistration Information. The request contains the UE's identity (/{ueId}) which shall be a GPSI or SUPI, the type of the requested information (/registrations/amf-3gpp-access) and query parameters (supported-features). + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for Amf3GppAccessRegistration Information Retrieval.](2aa94b70ba3fadcba8420d9e3128253a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: Requesting UE's AMF Registration Information for 3GPP Access + NF service consumer->>UDM: 1. GET .../{ueId}/registrations/amf-3gpp-access + UDM-->>NF service consumer: 2. 200 OK (Amf3GppAccessRegistration) +``` + +The diagram illustrates a sequence of two messages between an 'NF service consumer' and a 'UDM'. The first message, labeled '1. GET .../{ueId}/registrations/amf-3gpp-access', is sent from the NF service consumer to the UDM. The second message, labeled '2. 200 OK (Amf3GppAccessRegistration)', is sent from the UDM back to the NF service consumer. Vertical dashed lines extend from the boxes representing the entities, and horizontal arrows represent the message flow. + +Sequence diagram showing the interaction between an NF service consumer and a UDM for Amf3GppAccessRegistration Information Retrieval. + +**Figure 5.3.2.5.2-1: Requesting a UE's AMF Registration Information for 3GPP Access** + +1. The NF service consumer (e.g. NEF) sends a GET request to the resource representing the UE's AMF registration information for 3GPP access, with query parameters indicating the supported-features. +2. The UDM responds with "200 OK" with the message body containing the UE's Amf3GppAccessRegistration. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.3.2.5.3 AmfNon3GppAccessRegistration Information Retrieval + +Figure 5.3.2.5.3-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to retrieve the UE's AmfNon3GppAccessRegistration Information. The request contains the UE's identity (/{ueId}) which shall be a GPSI or SUPI, the type of the requested information (/registrations/amf-non-3gpp-access) and query parameters (supported-features). + +![Sequence diagram for Figure 5.3.2.5.3-1: Requesting a UE's AMF Registration Information for non-3GPP Access. The diagram shows two lifelines: 'NF service consumer' and 'UDM'. Step 1: The NF service consumer sends a GET request to the UDM for the resource .../{ueId}/registrations/amf-non-3gpp-access. Step 2: The UDM responds with a 200 OK status and a message body containing the AmfNon3GppAccessRegistration object.](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../{ueId}/registrations/amf-non-3gpp-access + UDM-->>NF service consumer: 2. 200 OK (AmfNon3GppAccessRegistration) +``` + +Sequence diagram for Figure 5.3.2.5.3-1: Requesting a UE's AMF Registration Information for non-3GPP Access. The diagram shows two lifelines: 'NF service consumer' and 'UDM'. Step 1: The NF service consumer sends a GET request to the UDM for the resource .../{ueId}/registrations/amf-non-3gpp-access. Step 2: The UDM responds with a 200 OK status and a message body containing the AmfNon3GppAccessRegistration object. + +**Figure 5.3.2.5.3-1: Requesting a UE's AMF Registration Information for non-3GPP Access** + +1. The NF service consumer (e.g. NEF) sends a GET request to the resource representing the UE's AMF registration information for non-3GPP access, with query parameters indicating the supported-features. +2. The UDM responds with "200 OK" with the message body containing the UE's AmfNon3GppAccessRegistration. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.3.2.5.4 Void + +##### 5.3.2.5.5 SmsfRegistration Information Retrieval for 3GPP Access + +Figure 5.3.2.5.5-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to retrieve the UE's SmsfRegistration Information. The request contains the UE's identity (/ {ueId}) which shall be a GPSI, the type of the requested information (/registrations/smsf-3gpp-access) and query parameters (supported-features). + +![Sequence diagram for Figure 5.3.2.5.5-1: Requesting a UE's SMSF Registration Information for 3GPP Access. The diagram shows two lifelines: 'NF Service Consumer' and 'UDM'. Step 1: The NF Service Consumer sends a GET request to the UDM for the resource .../{ueId}/registrations/smsf-3gpp-access. Step 2a: The UDM responds with a 200 OK status and a message body containing the SmsfRegistration object. Step 2b: If the UE does not have required subscription data for SMS service or SMS service is barred, the UDM responds with a 403 Forbidden status.](ddfa5b18550d1a022a941e3c31843814_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant UDM + Note left of NF Service Consumer: + NF Service Consumer->>UDM: 1. GET .../{ueId}/registrations/smsf-3gpp-access + UDM-->>NF Service Consumer: 2a. 200 OK (SmsfRegistration) + UDM-->>NF Service Consumer: 2b. 403 Forbidden +``` + +Sequence diagram for Figure 5.3.2.5.5-1: Requesting a UE's SMSF Registration Information for 3GPP Access. The diagram shows two lifelines: 'NF Service Consumer' and 'UDM'. Step 1: The NF Service Consumer sends a GET request to the UDM for the resource .../{ueId}/registrations/smsf-3gpp-access. Step 2a: The UDM responds with a 200 OK status and a message body containing the SmsfRegistration object. Step 2b: If the UE does not have required subscription data for SMS service or SMS service is barred, the UDM responds with a 403 Forbidden status. + +**Figure 5.3.2.5.5-1: Requesting a UE's SMSF Registration Information for 3GPP Access** + +1. The NF service consumer (e.g. NEF) sends a GET request to the resource representing the UE's SMSF registration information for 3GPP access, with query parameters indicating the supported-features. +- 2a. The UDM responds with "200 OK" with the message body containing the UE's SmsfRegistration for 3GPP access. +- 2b. If the UE does not have required subscription data for SMS service or SMS service is barred, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.3.2.5.6 SmsfRegistration Information Retrieval for Non-3GPP Access + +Figure 5.3.2.5.6-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to retrieve the UE's SsmfRegistration Information for non-3GPPP access. The request contains the UE's identity (/{ueId}) which shall be a GPSI, the type of the requested information (/registrations/smsf-non-3gpp-access) and query parameters (supported-features). + +![Sequence diagram for SsmfRegistration Information Retrieval for Non-3GPP Access](df1966d80c74bc127f159a48f38b13ee_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant UDM + Note left of NF Service Consumer: + NF Service Consumer->>UDM: 1. GET .../{ueId}/registrations/smsf-non-3gpp-access + Note right of UDM: + UDM-->>NF Service Consumer: 2a. 200 OK (SsmfRegistration) + UDM-->>NF Service Consumer: 2b. 403 Forbidden +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer and a UDM. The NF Service Consumer sends a GET request to the UDM for the UE's SsmfRegistration Information for non-3GPP access. The UDM responds with either a 200 OK (SsmfRegistration) or a 403 Forbidden status code. + +Sequence diagram for SsmfRegistration Information Retrieval for Non-3GPP Access + +**Figure 5.3.2.5.6-1: Requesting a UE's SMSF Registration Information for Non-3GPP Access** + +1. The NF service consumer (e.g. NEF) sends a GET request to the resource representing the UE's SMSF registration information for non-3GPP access, with query parameters indicating the supported-features. +- 2a. The UDM responds with "200 OK" with the message body containing the UE's SsmfRegistration for non-3GPP access. +- 2b. If the UE does not have required subscription data for SMS service or SMS service is barred, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.3.2.5.7 SmfRegistration Information Retrieval + +Figure 5.3.2.5.7-1 shows a scenario where the NF service consumer (e.g. NWDAF, SMF) sends a request to the UDM to retrieve the UE's SmfRegistration Information. NF Service Consumer (e.g. SMF) may send request to UDM to retrieve SMF registration information to ensure the uniqueness of PDU Session ID if handover between EPS and EPC/ePDG. The request contains the UE's identity (/{ueId}) which shall be a GPSI or SUPI, the type of the requested information (/registration/smf-registrations) and query parameters (single-nssai, dnn, supported-features). + +![Sequence diagram for SmfRegistration Information Retrieval](f5d2a88925807080157c7cfb1d41cf0b_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../{ueId}/registrations/smf-registrations + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (SmfRegistrationInfo) + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for the UE's SmfRegistration Information. The UDM responds with either a 200 OK (SmfRegistrationInfo) or a 404 Not Found status code. + +Sequence diagram for SmfRegistration Information Retrieval + +**Figure 5.3.2.5.7-1: Requesting a UE's SMF Registration Information** + +1. The NF service consumer (e.g. NWDAF) sends a GET request to the resource representing the UE's SMF registration information, with query parameters indicating the single-nssai, dnn, supported-features. +- 2a. The UDM responds with "200 OK" with the message body containing the UE's SmfRegistrationInfo. + +- 2b. If there is no valid SMF Registration data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.3.2.5.8 Individual SmfRegistration Information Retrieval + +NF Service Consumer (e.g. AMF) may send request to UDM to retrieve individual SMF registration information identified by PDU Session ID. + +![Sequence diagram for Figure 5.3.2.5.8-1: Requesting individual SMF Registration Information. The diagram shows an NF service consumer sending a GET request to a UDM for individual SMF registration information. The UDM responds with either a 200 OK (SmfRegistrationInfo) or a 404 Not Found.](db5deafdae53dbc7d5972957f708c691_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. GET .../{ueId}/registrations/smf-Registrations/{pduSessionId} + NF service consumer->>UDM: 1. GET .../{ueId}/registrations/smf-Registrations/{pduSessionId} + Note right of UDM: 2a. 200 OK (SmfRegistrationInfo) + Note right of UDM: 2b. 404 Not Found + UDM-->>NF service consumer: 2a. 200 OK (SmfRegistrationInfo) + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +Sequence diagram for Figure 5.3.2.5.8-1: Requesting individual SMF Registration Information. The diagram shows an NF service consumer sending a GET request to a UDM for individual SMF registration information. The UDM responds with either a 200 OK (SmfRegistrationInfo) or a 404 Not Found. + +**Figure 5.3.2.5.8-1: Requesting individual SMF Registration Information** + +1. The NF service consumer (e.g. AMF) sends a GET request to the resource representing the individual SMF registration information. +- 2a. The UDM responds with "200 OK" with the message body containing the SmfRegistration corresponding to the indicated PDU session. +- 2b. If there is no valid SMF Registration data for the indicated PDU session, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.3.2.5.9 Location Information Retrieval + +Figure 5.3.2.5.9-1 shows a scenario where the NF service consumer (e.g. (H)GMLC) sends a request to the UDM to retrieve the UE's Location Information. The request contains the UE's identity (/ {ueId}), which shall be a GPSI or SUPI, and query parameters (supported-features). + +![Sequence diagram for Figure 5.3.2.5.9-1: Requesting a UE's Location Information. The diagram shows an NF service consumer sending a GET request to a UDM for a UE's location information. The UDM responds with either a 200 OK (LocationInfo) or a 404 Not Found.](914919be6b64b1c8bb74e12616c85f71_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. GET .../{ueId}/registrations/location + NF service consumer->>UDM: 1. GET .../{ueId}/registrations/location + Note right of UDM: 2a. 200 OK (LocationInfo) + Note right of UDM: 2b. 404 Not Found + UDM-->>NF service consumer: 2a. 200 OK (LocationInfo) + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +Sequence diagram for Figure 5.3.2.5.9-1: Requesting a UE's Location Information. The diagram shows an NF service consumer sending a GET request to a UDM for a UE's location information. The UDM responds with either a 200 OK (LocationInfo) or a 404 Not Found. + +**Figure 5.3.2.5.9-1: Requesting a UE's Location Information** + +1. The NF service consumer (e.g. (H)GMLC) sends a GET request to the resource representing the UE's Location information, with query parameters indicating the supported-features. +- 2a. The UDM responds with "200 OK" with the message body containing the UE's LocationInfo. + +The returned LocationInfo shall include the NF instance ID of the serving AMF ID, and may include the GUAMI of the serving AMF, the VGMLC address info. + +- 2b. If there is no valid location information data for the UE, a response with HTTP status code "404 Not Found" shall be returned to the NF service including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.3.2.5.10 Retrieval Of Multiple UE Registration Data Sets + +Figure 5.3.2.5.10-1 shows a scenario where the NF service consumer (e.g. HSS, NWDAF, NSSAAF) sends a request to the UDM to receive multiple UE registration data sets. In this example scenario the UE's AMF registration data sets are retrieved with a single request; see clause 6.2.6.3.6 for other data sets that can be retrieved with a single request. The request contains the resource of UE's registrations({ueId}/registrations) and query parameters identifying the requested registration data sets (in this example: ?registration-dataset-names=AMF\_3GPP, AMF\_NON\_3GPP). + +![Sequence diagram showing the retrieval of multiple UE registration data sets. The NF Service Consumer sends a GET request to the UDM, and the UDM responds with a 200 OK status containing the registration data sets.](3e2dcee303cecdd31b7f9ec0d8942fed_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant UDM + Note left of NF Service Consumer: 1. GET .../{ueId}/Registrations?registration-dataset-names=AMF_3GPP,AMF_NON_3GPP + NF Service Consumer->>UDM: Request + Note right of UDM: 2. 200 OK (RegistrationDataSets) + UDM-->>NF Service Consumer: Response +``` + +Sequence diagram showing the retrieval of multiple UE registration data sets. The NF Service Consumer sends a GET request to the UDM, and the UDM responds with a 200 OK status containing the registration data sets. + +**Figure 5.3.2.5.10-1: Retrieval of Multiple UE Registration Data Sets** + +1. The NF Service Consumer (e.g. HSS, NWDAF) sends a GET request to the resource representing the UE registrations. Query parameters indicate the requested UE registration data sets. +2. The UDM responds with "200 OK" with the message body containing the requested UE registration data sets. When not all requested data sets are available at the UDM, only the requested and available data sets are returned in a "200 OK" response. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.3.2.5.11 IP-SM-GW Registration Information Retrieval + +Figure 5.3.2.5.11-1 shows a scenario where the NF service consumer sends a request to the UDM to retrieve the UE's IP-SM-GW Registration Information. The request contains the UE's identity (/ {ueId}) which shall be a SUPI. + +![Sequence diagram showing the request for a UE's IP-SM-GW registration information. The NF service consumer sends a GET request to the UDM, and the UDM responds with a 200 OK.](68d50e85fb8de4fae0e0eafaf20e63c0_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + Note right of UDM: + NF service consumer->>UDM: 1. GET .../{ueId}/registrations/ip-sm-gw + UDM-->>NF service consumer: 2. 200 OK (IpSmGwRegistration) + +``` + +Sequence diagram showing the request for a UE's IP-SM-GW registration information. The NF service consumer sends a GET request to the UDM, and the UDM responds with a 200 OK. + +**Figure 5.3.2.5.11-1: Requesting a UE's IP-SM-GW Registration Information** + +1. The NF service consumer sends a GET request to the resource representing the UE's IP-SM-GW registration information for 3GPP access. +2. The UDM responds with "200 OK" with the message body containing the UE's IP-SM-GW Registration. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.3.2.5.12 NwdafRegistration Information Retrieval + +Figure 5.3.2.5.12-1 shows a scenario where the NF service consumer (e.g. NWDAF) sends a request to the UDM to retrieve the UE's NwdafRegistration Information. The request contains the UE's identity (/{ueId}), which shall be a SUPI, the type of the requested information (/registrations/nwdaf-registrations) and query parameters (analyticsIds, supported-features). + +![Sequence diagram showing the request for a UE's NwdafRegistration information. The NF service consumer sends a GET request to the UDM, and the UDM responds with either a 200 OK or a 404 Not Found.](868ef3e0abb37916a7af1e923995f329_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + Note right of UDM: + NF service consumer->>UDM: 1. GET .../{ueId}/registrations/nwdaf-registrations + UDM-->>NF service consumer: 2a. 200 OK (NwdafRegistration(s)) + UDM-->>NF service consumer: 2b. 404 Not Found + +``` + +Sequence diagram showing the request for a UE's NwdafRegistration information. The NF service consumer sends a GET request to the UDM, and the UDM responds with either a 200 OK or a 404 Not Found. + +**Figure 5.3.2.5.12-1: Requesting a UE's NwdafRegistration Information** + +1. The NF service consumer (e.g. NWDAF) sends a GET request to the resource representing the UE's NwdafRegistration information, with query parameters indicating the analyticsIds, supported-features. +- 2a. The UDM responds with "200 OK" with the message body containing the UE's NwdafRegistration(s). + +NOTE: if there are multiple NwdafRegistration for the same UE, all matched NwdafRegistration(s) will be returned. + +- 2b. If there is no valid NwdafRegistration information data for the UE, a response with HTTP status code "404 Not Found" shall be returned to the NF service including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +#### 5.3.2.6 Update + +##### 5.3.2.6.1 General + +The following procedures using the Update service operation are supported: + +- Update a parameter (e.g. PEI, EPS Interworking Info, etc) in the AMF registration for 3GPP access + +- Update a parameter (e.g. PEI) in the AMF registration for non-3GPP access +- Update a parameter (e.g. analyticsId(s)) in the NWDAF registration +- Update a parameter (e.g. PGW FQDN) in the SMF registration + +##### 5.3.2.6.2 Update A Parameter (e.g. PEI) in the AMF Registration For 3GPP Access + +Figure 5.3.2.6.2-1 shows a scenario where the AMF sends a request to the UDM to update a parameter within the Amf3GppAccessRegistration resource. The request contains the UE's identity (/{ueId}) which shall be a SUPI and an instruction to modify a parameter (e.g. PEI). + +![Sequence diagram showing the interaction between AMF and UDM for updating a parameter in the AMF registration for 3GPP access. The AMF sends a PATCH request to the UDM. The UDM responds with one of four possible status codes: 2a. 204 No Content, 2b. 200 OK (PatchResult), 2c. 404 Not Found, or 2d. 422 Unprocessable Request.](895d588a848d9963890c938763de9ecf_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM + Note right of AMF: 1. PATCH .../{ueId}/registrations/amf-3gpp-access +(Amf3GppAccessRegistrationModification) + AMF->>UDM: Request + Note left of UDM: 2a. 204 No Content +2b. 200 OK (PatchResult) +2c. 404 Not Found +2d. 422 Unprocessable Request + UDM-->>AMF: Response + +``` + +Sequence diagram showing the interaction between AMF and UDM for updating a parameter in the AMF registration for 3GPP access. The AMF sends a PATCH request to the UDM. The UDM responds with one of four possible status codes: 2a. 204 No Content, 2b. 200 OK (PatchResult), 2c. 404 Not Found, or 2d. 422 Unprocessable Request. + +**Figure 5.3.2.6.2-1: AMF registration parameter update for 3GPP access** + +1. The AMF sends a PATCH request to the UDM for the resource representing the UE's AMF registration for 3GPP access. + +If the AMF needs to modify the backupAmfInfo, the AMF shall include the IE in the PATCH request. The modified backupAmfInfo is only applicable to this UE in 3GPP access. + +- 2a. If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with "204 No Content" response. +- 2b. If some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with "200 OK" with the response body containing PatchResult. +- 2c. If the resource does not exist e.g. the UE is not registered yet, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2d. If the resource exists, but the requesting AMF is not the one currently registered for the UE, HTTP status code "422 Unprocessable Entity" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.3.2.6.3 Update A Parameter (e.g. PEI) in the AMF Registration For Non 3GPP Access + +Figure 5.3.2.6.3-1 shows a scenario where the AMF sends a request to the UDM to update a parameter within the AmfNon3GppAccessRegistration resource. The request contains the UE's identity (/{ueId}) which shall be a SUPI and an instruction to modify a parameter (e.g. PEI). + +![Sequence diagram for AMF registration parameter update for non-3GPP access. The AMF sends a PATCH request to the UDM. The UDM responds with one of the following: 2a. 204 No Content, 2b. 200 OK (PatchResult), 2c. 404 Not Found, or 2d. 422 Unprocessable Request.](69edc2887e907309499ac95b47ab6905_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM + Note right of AMF: 1. PATCH .../{ueId}/registrations/amf-3gpp-access +(AmfNon3GppAccessRegistrationModification) + AMF->>UDM: Request + Note right of UDM: 2a. 204 No Content + UDM-->>AMF: Response + Note right of UDM: 2b. 200 OK (PatchResult) + UDM-->>AMF: Response + Note right of UDM: 2c. 404 Not Found + UDM-->>AMF: Response + Note right of UDM: 2d. 422 Unprocessable Request + UDM-->>AMF: Response + +``` + +Sequence diagram for AMF registration parameter update for non-3GPP access. The AMF sends a PATCH request to the UDM. The UDM responds with one of the following: 2a. 204 No Content, 2b. 200 OK (PatchResult), 2c. 404 Not Found, or 2d. 422 Unprocessable Request. + +**Figure 5.3.2.6.3-1: AMF registration parameter update for non-3GPP access** + +1. The AMF sends a PATCH request to the resource representing the UE's AMF registration for non-3GPP access. + +If the AMF needs to modify the backupAmfInfo, the AMF shall include the IE in the PATCH request. The modified backupAmfInfo is only applicable to this UE in non-3GPP access. + +- 2a. If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with "204 No Content" response. +- 2b. If some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with "200 OK" with the response body containing PatchResult. +- 2c. If the resource does not exist e.g. the UE is not registered yet, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2d. If the resource exists, but the requesting AMF is not the one currently registered for the UE, HTTP status code "422 Unprocessable Entity" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.3.2.6.4 Update A Parameter (e.g. analyticsId(s)) in the NWDAF Registration + +Figure 5.3.2.6.4-1 shows a scenario where the NWDAF sends a request to the UDM to update a parameter within the NwdafRegistration resource. The request contains the UE's identity (/{ueId}) which shall be a SUPI, the NWDAF's registration identity (/{nwdafRegistrationId}) and an instruction to modify a parameter (e.g. analyticsId(s)). + +![Sequence diagram for NWDAF registration parameter update. The NWDAF sends a PATCH request to the UDM. The UDM responds with one of the following: 2a. 204 No Content, 2b. 200 OK (PatchResult) or 200 OK (NwdafRegistration), 2c. 404 Not Found, or 2d. 422 Unprocessable Entity.](062ad684575a714449a7e040c0e1ec00_img.jpg) + +``` + +sequenceDiagram + participant NWDAF + participant UDM + Note right of NWDAF: 1. PATCH .../{ueId}/registrations/nwdaf- +registrations/{nwdafRegistrationId} +(NwdafRegistrationModification) + NWDAF->>UDM: Request + Note right of UDM: 2a. 204 No Content + UDM-->>NWDAF: Response + Note right of UDM: 2b. 200 OK (PatchResult) or 200 OK (NwdafRegistration) + UDM-->>NWDAF: Response + Note right of UDM: 2c. 404 Not Found + UDM-->>NWDAF: Response + Note right of UDM: 2d. 422 Unprocessable Entity + UDM-->>NWDAF: Response + +``` + +Sequence diagram for NWDAF registration parameter update. The NWDAF sends a PATCH request to the UDM. The UDM responds with one of the following: 2a. 204 No Content, 2b. 200 OK (PatchResult) or 200 OK (NwdafRegistration), 2c. 404 Not Found, or 2d. 422 Unprocessable Entity. + +**Figure 5.3.2.6.4-1: NWDAF registration parameter update** + +1. The NWDAF sends a PATCH request to the resource representing the UE's NWDAF registration. +- 2a. If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with "204 No Content" response. +- 2b. If some of the modification instructions in the PATCH request have been discarded: + +- the UDM shall respond with "200 OK" with the response body containing PatchResult, if the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number; or + - the UDM shall respond with "200 OK" with the response body containing NwdaRegistration, if the NF service consumer does not support the "PatchReport" feature. +- 2c. If the resource does not exist e.g. the UE is not registered yet, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2d. If the resource exists, but the requesting NWDAF is not the one currently registered for the UE, HTTP status code "422 Unprocessable Entity" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.3.2.6.5 Update A Parameter (e.g. PGW FQDN) in the SMF Registration + +Figure 5.3.2.6.5-1 shows a scenario where the SMF sends a request to the UDM to update a parameter within the SmfRegistration resource (see also clause 4.11.5.2 of 3GPP TS 23.502 [3]). The request contains the UE's identity (/{ueId}) which shall be a SUPI and an instruction to modify a parameter (e.g. PGW FQDN). + +![Sequence diagram showing SMF sending a PATCH request to UDM for SMF registration parameter update. The request is '1. PATCH .../{ueId}/registrations/smf-registrations/{pduSessionId} (Modification instruction)'. The UDM responds with '2a. 204 No Content or 200 OK (PatchResult)', '2b. 404 Not Found', or '2c. 422 Unprocessable Request'.](0c9723d1620cf51bc2b7a380ce7e23c0_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant UDM + Note right of SMF: 1. PATCH .../{ueId}/registrations/smf-registrations/{pduSessionId} +(Modification instruction) + SMF->>UDM: Request + Note left of UDM: 2a. 204 No Content or 200 OK (PatchResult) +2b. 404 Not Found +2c. 422 Unprocessable Request + UDM-->>SMF: Response + +``` + +Sequence diagram showing SMF sending a PATCH request to UDM for SMF registration parameter update. The request is '1. PATCH .../{ueId}/registrations/smf-registrations/{pduSessionId} (Modification instruction)'. The UDM responds with '2a. 204 No Content or 200 OK (PatchResult)', '2b. 404 Not Found', or '2c. 422 Unprocessable Request'. + +**Figure 5.3.2.6.5-1: SMF registration parameter update** + +1. The SMF sends a PATCH request to the resource representing the UE's SMF registration .../{ueId}/registrations/smf-registrations/{pduSessionId}. +- 2a. On success, the UDM responds with "204 No Content" or "200 OK" shall be returned; in the latter case, the content of the PATCH response shall contain the PatchResult indicating that some of the modification instructions in the PATCH request have been discarded. +- 2b. If the resource does not exist, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the resource exists, but the requesting SMF is not the one currently registered for the UE, HTTP status code "422 Unprocessable Entity" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.3.2.6.6 Update A Parameter (e.g. Memory Available) in the SMSF Registration for 3GPP Access + +Figure 5.3.2.6.6-1 shows a scenario where the SMSF sends a request to the UDM to update a parameter within the Smf3GppAccessRegistration resource. The request contains the UE's identity (/{ueId}) which shall be a SUPI and an instruction to modify a parameter (e.g. Memory Available). + +![Sequence diagram for SMSF registration (3GPP access) parameter update](aa81b9b80bd1e3d723922b3a033564a2_img.jpg) + +A sequence diagram showing the interaction between an SMSF and a UDM. The SMSF sends a PATCH request to the UDM. The UDM responds with one of three possible status codes: 204 No Content or 200 OK (PatchResult), 404 Not Found, or 422 Unprocessable Request. + +``` +sequenceDiagram + participant SMSF + participant UDM + Note right of SMSF: 1. PATCH .../{ueId}/registrations/smsf-3gpp-access (Modification instruction) + SMSF->>UDM: 1. PATCH .../{ueId}/registrations/smsf-3gpp-access (Modification instruction) + Note right of UDM: 2a. 204 No Content or 200 OK (PatchResult) + UDM-->>SMSF: 2a. 204 No Content or 200 OK (PatchResult) + Note right of UDM: 2b. 404 Not Found + UDM-->>SMSF: 2b. 404 Not Found + Note right of UDM: 2c. 422 Unprocessable Request + UDM-->>SMSF: 2c. 422 Unprocessable Request +``` + +Sequence diagram for SMSF registration (3GPP access) parameter update + +**Figure 5.3.2.6.6-1: SMSF registration (3GPP access) parameter update** + +1. The SMSF sends a PATCH request to the resource representing the UE's SMSF registration for 3GPP access .../{ueId}/registrations/smsf-3gpp-access. +- 2a. On success, the UDM responds with "204 No Content" or "200 OK" shall be returned; in the latter case, the content of the PATCH response shall contain the PatchResult indicating that some of the modification instructions in the PATCH request have been discarded. +- 2b. If the resource does not exist, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the resource exists, but the requesting SMSF is not the one currently registered for the UE, HTTP status code "422 Unprocessable Entity" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.3.2.6.7 Update A Parameter (e.g. Memory Available) in the SMSF Registration for non-3GPP Access + +Figure 5.3.2.6.7-1 shows a scenario where the SMSF sends a request to the UDM to update a parameter within the SmsfNon3GppAccessRegistration resource. The request contains the UE's identity (/{ueId}) which shall be a SUPI and an instruction to modify a parameter (e.g. Memory Available). + +![Sequence diagram for SMSF registration (non-3GPP access) parameter update](b4a7906eddfd40aaa750e19e56c94a8b_img.jpg) + +A sequence diagram showing the interaction between an SMSF and a UDM. The SMSF sends a PATCH request to the UDM. The UDM responds with one of three possible status codes: 204 No Content or 200 OK (PatchResult), 404 Not Found, or 422 Unprocessable Request. + +``` +sequenceDiagram + participant SMSF + participant UDM + Note right of SMSF: 1. PATCH .../{ueId}/registrations/smsf-non-3gpp-access (Modification instruction) + SMSF->>UDM: 1. PATCH .../{ueId}/registrations/smsf-non-3gpp-access (Modification instruction) + Note right of UDM: 2a. 204 No Content or 200 OK (PatchResult) + UDM-->>SMSF: 2a. 204 No Content or 200 OK (PatchResult) + Note right of UDM: 2b. 404 Not Found + UDM-->>SMSF: 2b. 404 Not Found + Note right of UDM: 2c. 422 Unprocessable Request + UDM-->>SMSF: 2c. 422 Unprocessable Request +``` + +Sequence diagram for SMSF registration (non-3GPP access) parameter update + +**Figure 5.3.2.6.7-1: SMSF registration (non-3GPP access) parameter update** + +1. The SMSF sends a PATCH request to the resource representing the UE's SMSF registration for non-3GPP access .../{ueId}/registrations/smsf-non-3gpp-access. +- 2a. On success, the UDM responds with "204 No Content" or "200 OK" shall be returned; in the latter case, the content of the PATCH response shall contain the PatchResult indicating that some of the modification instructions in the PATCH request have been discarded. +- 2b. If the resource does not exist, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the resource exists, but the requesting SMSF is not the one currently registered for the UE, HTTP status code "422 Unprocessable Entity" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +#### 5.3.2.7 P-CSCF-RestorationNotification + +##### 5.3.2.7.1 General + +The following procedure using the P-CSCF-RestorationNotification service operation is supported: + +- UDM initiated P-CSCF-Restoration + +##### 5.3.2.7.2 UDM initiated P-CSCF-Restoration + +Figure 5.3.2.7.2-1 shows a scenario where the UDM notifies the registered AMF or SMF about the need for P-CSCF restoration. The request contains the pscfRestorationCallbackUri URI for P-CSCF restoration as received by the UDM during registration, and P-CSCF Restoration Indication. + +![Sequence diagram showing UDM initiated P-CSCF Restoration. The UDM sends a POST request to the AMF/SMF. The AMF/SMF responds with 204 No Content on success or 4xx/5xx (Problem Details) or 3xx on failure.](47e8c2042061e08a14e012472e9fdbaa_img.jpg) + +``` +sequenceDiagram + participant AMF/SMF + participant UDM + Note right of UDM: 1. POST {pcscfRestorationCallbackUri} +(PscfRestorationNotification) + UDM->>AMF/SMF: Request + Note left of AMF/SMF: 2a. 204 No Content + AMF/SMF-->>UDM: Response 2a + Note left of AMF/SMF: 2b. 4xx/5xx (Problem Details) or 3xx + AMF/SMF-->>UDM: Response 2b +``` + +Sequence diagram showing UDM initiated P-CSCF Restoration. The UDM sends a POST request to the AMF/SMF. The AMF/SMF responds with 204 No Content on success or 4xx/5xx (Problem Details) or 3xx on failure. + +**Figure 5.3.2.7.2-1: UDM initiated P-CSCF Restoration** + +1. The UDM sends a POST request to the pscfRestorationCallbackUri as provided by the NF service consumer during the registration. +- 2a. On success, the AMF or SMF responds with "204 No Content". +- 2b. On failure or redirection, one of the appropriate HTTP status code listed in Table 6.2.5.3-3 shall be returned. For a 4xx/5xx response, the message body may contain appropriate additional error information. + +#### 5.3.2.8 P-CSCF-RestorationTrigger + +##### 5.3.2.8.1 General + +The following procedure using the P-CSCF-RestorationTrigger service operation is supported: + +- P-CSCF-RestorationTrigger + +##### 5.3.2.8.2 P-CSCF-RestorationTrigger + +Figure 5.3.2.8.2-1 shows a scenario where the HSS sends a request to the UDM to initiate P-CSCF restoration. The request contains the UE's identity which shall be a SUPI. + +![Sequence diagram for P-CSCF-RestorationTrigger showing HSS sending a POST request to UDM and receiving a 204 No Content response.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +``` +sequenceDiagram + participant HSS + participant UDM + Note left of HSS: HSS + Note right of UDM: UDM + HSS->>UDM: 1. POST .../restore-pcsf (supi) + UDM-->>HSS: 2. 204 No Content +``` + +Sequence diagram for P-CSCF-RestorationTrigger showing HSS sending a POST request to UDM and receiving a 204 No Content response. + +**Figure 5.3.2.8.2-1: P-CSCF-RestorationTrigger** + +1. The HSS sends a POST request (custom method: restore-pcsf) to the UDM. +2. The UDM responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.3.2.9 AMFDeregistration + +##### 5.3.2.9.1 General + +The following procedure using the AMFDeregistration service operation is supported: + +- AMF-Deregistration + +##### 5.3.2.9.2 AMF-Deregistration + +Figure 5.3.2.9.2-1 shows a scenario where the HSS sends a request to the UDM to deregister the registered AMF. The request contains the UE's identity which shall be an IMSI. + +![Sequence diagram for AMF-Deregistration showing HSS sending a POST request to UDM and receiving either a 204 No Content or a 404 Not Found response.](34f788b0e5bc8af774fa5561c22e6d01_img.jpg) + +``` +sequenceDiagram + participant HSS + participant UDM + Note left of HSS: HSS + Note right of UDM: UDM + HSS->>UDM: 1. POST .../{ueid}/registrations/amf-3gpp-access/dereg-amf (AmfDeregInfo) + UDM-->>HSS: 2a. 204 No Content + UDM-->>HSS: 2b. 404 Not Found +``` + +Sequence diagram for AMF-Deregistration showing HSS sending a POST request to UDM and receiving either a 204 No Content or a 404 Not Found response. + +**Figure 5.3.2.9.2-1: AMF-Deregistration** + +1. The HSS sends a POST request (custom method: dereg-amf) to the resource representing the UE's registration for 3GPP access. This shall result in sending of Nudm\_UECM\_DeregistrationNotification to the AMF (see 3GPP TS 23.632 [32]) and setting the purgeFlag in the Amf3GppAccessRegistration stored in the UDR. +- 2a. The UDM responds with "204 No Content". +- 2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.3.2.10 PEI-Update + +##### 5.3.2.10.1 General + +The following procedure using the PEI-Update service operation is supported: + +- PEI Update + +##### 5.3.2.10.2 PEI Update + +Figure 5.3.2.10.2-1 shows a scenario where the HSS sends a request to the UDM to update the PEI attribute in the 3GPP Access Registration context. The request contains the UE's identity which shall be an IMSI. + +![Sequence diagram for PEI Update showing HSS sending a POST request to UDM and receiving a 204 or 404 response.](731f533b0599c8e42a063f06e4332045_img.jpg) + +``` +sequenceDiagram + participant HSS + participant UDM + Note right of HSS: 1. POST.../{ueid}/registrations/amf-3gpp-access/pei-update (PeiUpdateInfo) + HSS->>UDM: Request + Note left of UDM: 2a. 204 No Content + Note left of UDM: 2b. 404 Not Found + UDM-->>HSS: Response +``` + +Sequence diagram for PEI Update showing HSS sending a POST request to UDM and receiving a 204 or 404 response. + +Figure 5.3.2.10.2-1: PEI Update + +1. The HSS sends a POST request (custom method: pei-update) to the resource representing the UE's registration for 3GPP access. This shall result in the UDM updating the stored pei attribute in e.g. the UDR. +- 2a. The UDM responds with "204 No Content". +- 2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.3.2.11 Roaming Information Update + +##### 5.3.2.11.1 General + +The following procedure using the Roaming-Info-Update service operation is supported: + +- Roaming Information Update + +##### 5.3.2.11.2 Roaming Information Update + +Figure 5.3.2.11.2-1 shows a scenario where the HSS sends a request to the UDM to update the Roaming Information Update in the 3GPP Access Registration context. The request contains the UE's identity which shall be an IMSI. + +![Sequence diagram for Roaming Information Update showing HSS sending a POST request to UDM and receiving a 204 or 201 response.](f4535959316aea381fb56b9225d8e4bd_img.jpg) + +``` +sequenceDiagram + participant HSS + participant UDM + Note right of HSS: 1. POST.../{ueid}/registrations/amf-3gpp-access/roaming-information (RoamingInfoUpdate) + HSS->>UDM: Request + Note left of UDM: 2a. 204 No Content + Note left of UDM: 2b. 201 Created + UDM-->>HSS: Response +``` + +Sequence diagram for Roaming Information Update showing HSS sending a POST request to UDM and receiving a 204 or 201 response. + +Figure 5.3.2.11.2-1: Roaming Information Update + +1. The HSS sends a POST request to the resource representing the UE's Roaming information to update or create the Roaming Information. +- 2a. On success, the UDM updates the RoamingInfoUpdate resource by replacing it with the received resource information, and responds with "204 No Content". +- 2b. If the resource does not exist (there is no previous Roaming Information Update stored in UDM for the user, UDM stores the received Roaming Information Update and responds with HTTP Status Code "201 created" with the created Roaming Information Update. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.3.2.12 DataRestorationNotification + +##### 5.3.2.12.1 General + +The following procedure using the DataRestorationNotification service operation is supported: + +- UDR-initiated Data Restoration + +##### 5.3.2.12.2 UDR-initiated Data Restoration + +Figure 5.3.2.12.2-1 shows a scenario where the UDM notifies the NF Service Consumer (e.g., a registered AMF, SMF, SMSF) about the need to restore subscription-data due to a potential data-loss event occurred at the UDR. The request contains identities representing those UEs potentially affected by such event. + +![Sequence diagram for UDR-initiated Data Restoration. The diagram shows two lifelines: NF Service Consumer and UDM. The UDM sends a POST request (1. POST {dataRestorationCallbackUri} (DataRestorationNotification)) to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content or 2b. 4xx/5xx (Problem Details) or 3xx.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg) + +``` +sequenceDiagram + participant UDM + participant NFSC as NF Service Consumer + Note right of UDM: 1. POST {dataRestorationCallbackUri} (DataRestorationNotification) + UDM->>NFSC: 1. POST {dataRestorationCallbackUri} (DataRestorationNotification) + Note left of NFSC: 2a. 204 No Content + NFSC-->>UDM: 2a. 204 No Content + Note left of NFSC: 2b. 4xx/5xx (Problem Details) or 3xx + NFSC-->>UDM: 2b. 4xx/5xx (Problem Details) or 3xx +``` + +Sequence diagram for UDR-initiated Data Restoration. The diagram shows two lifelines: NF Service Consumer and UDM. The UDM sends a POST request (1. POST {dataRestorationCallbackUri} (DataRestorationNotification)) to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content or 2b. 4xx/5xx (Problem Details) or 3xx. + +**Figure 5.3.2.12.2-1: UDR-initiated Data Restoration** + +1. The UDM (after receiving a notification from UDR about a potential data-loss event) sends a POST request to the dataRestorationCallbackUri; such callback URI may be provided by the NF service consumer during the registration, or dynamically discovered by UDM by querying the NRF for the NF Profile of the NF Service Consumer. +- 2a. On success, the NF Service Consumer responds with "204 No Content". +- 2b. On failure or redirection, one of the appropriate HTTP status codes listed in Table 6.2.5.3-3 shall be returned. For a 4xx/5xx response, the message body may contain appropriate additional error information. + +#### 5.3.2.13 SendRoutingInfoForSM + +##### 5.3.2.13.1 General + +The following procedure using the SendRoutingInfoForSM service operation is supported: + +- Successful Mobile Terminated short message transfer as defined in 3GPP TS 23.540 [66] clause 5.1.2, clause 5.1.3 and clause 5.1.4. + +- Unsuccessful Mobile Terminated short message transfer as defined in 3GPP TS 23.540 [66] clause 5.1.5, clause 5.1.6 and clause 5.1.9. +- GPSI-to-Subscription-Network resolution as defined in 3GPP TS 23.540 [66] clause 5.1.7. + +##### 5.3.2.13.2 Send Routing Information For SM + +Figure 5.3.2.13.2-1 shows a scenario where the NF consumer (e.g. SMS-GMSC, HSS...) sends a request to the UDM to retrieve the addressing information for SMS delivery, e.g. addressing of the available SMSF nodes registered in the UDM. + +![Sequence diagram showing the interaction between an NF Service Consumer and a UDM for sending routing information for SMS. The consumer sends a POST request to the UDM, and the UDM responds with either a 200 OK, 404 Not Found, or 403 Forbidden status.](053f1077d592e6622cd21dc4bb4cb366_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UDM + Note right of NF Service Consumer: 1. POST .../{ueId}/registrations/ +send-routing-info-sm + NF Service Consumer->>UDM: Request + Note left of UDM: 2a. 200 OK (RoutingInfoSm) +2b. 404 Not Found +2c. 403 Forbidden + UDM-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a UDM for sending routing information for SMS. The consumer sends a POST request to the UDM, and the UDM responds with either a 200 OK, 404 Not Found, or 403 Forbidden status. + +**Figure 5.3.2.13.2-1: Send Routing Info For SM** + +1. The NF Service Consumer sends a POST request (custom method: send-routing-info-sm) to the UDM. The request URI contains the UE's identity ({ueId}). The request body may contain a list of features of the Nudm\_UECM API supported by the NF Service Consumer, if any; otherwise, the request body may contain an empty JSON object. +- 2a. The UDM responds with "200 OK" with the message body containing a RoutingInfoSm data structure, including the addressing info of the nodes that are currently available to be used for sending SMS to the recipient UE, if any. +- 2b. If there is no node at UDM currently available to be used for sending SMS to the recipient UE, then the UDM responds with "404 Not Found" with the message body containing a ProblemDetails object, with a cause code indicating "ABSENT\_SUBSCRIBER\_SM". +- 2c. If the UE does not have required subscription data for SMS service or SMS service is barred, the UDM responds with HTTP status code "403 Forbidden", with the response body including a ProblemDetails object containing an application error indicating "SERVICE\_NOT\_PROVISIONED" or "SERVICE\_NOT\_ALLOWED". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.3.2.14 StaleCheckNotification + +##### 5.3.2.14.1 General + +The following procedure using the StaleCheckNotification service operation is supported: + +- UDM initiated Stale SMF Registration Check + +##### 5.3.2.14.2 UDM initiated Stale SMF Registration Check + +Figure 5.3.2.14.2-1 shows a scenario where the UDM notifies the registered SMF to check whether a SMF registration is still valid. The request contains the deregCallbackUri URI for stale check notification as received by the UDM during SMF registration. + +The UDM initiates the Stale Check procedure when the registered SMF is suspected to be stale in the UDM/UDR, e.g. due to a lost Deregistration request. + +![Sequence diagram for UDM initiated Stale Check](d26959f4514c26ca19c3d6f00da85956_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note right of UDM: 1. POST {staleCheckCallbackUri} (PduSessionIds) + UDM->>NF service consumer: 2a. 204 No Content + Note right of UDM: 2b. 200 OK (StalePduSessionIds) + Note right of UDM: 2c. 4xx/5xx (Problem Details) or 3xx + NF service consumer-->>UDM: 2b. 200 OK (StalePduSessionIds) +``` + +The diagram illustrates the interaction between an NF service consumer and a UDM for a stale check. The UDM sends a POST request to the NF service consumer's staleCheckCallbackUri with PduSessionIds. The NF service consumer responds with one of three options: 2a. 204 No Content (success), 2b. 200 OK with StalePduSessionIds (partial success), or 2c. 4xx/5xx (Problem Details) or 3xx (failure or redirection). + +Sequence diagram for UDM initiated Stale Check + +**Figure 5.3.2.14.2-1: UDM initiated Stale Check** + +1. The UDM sends a POST request to the staleCheckCallbackUri as provided by the NF service consumer during the registration. +- 2a. On success, i.e. all PDU sessions are still in use, the NF service consumer responds with "204 No Content" +- 2b. On partial success, i.e. at least one PDU session ID is unknown, the NF service consumer responds with "200 OK" indicating the unknown PDU session IDs. +- 2c. On failure or redirection, one of the appropriate HTTP status code listed in Table 6.2.5.2-3 shall be returned. For a 4xx/5xx response, the message body may contain appropriate additional error information. + +#### 5.3.2.15 Re-AuthenticationNotification + +##### 5.3.2.15.1 General + +The following procedure using the Re-AuthenticationNotification service operation is supported: + +- Reauthentication Notify + +##### 5.3.2.15.2 Reauthentication Notify + +Figure 5.3.2.15.2-1 shows a scenario where the UDM notifies the NF Service Consumer (registered AMF) about the need to initiate primary UE authentication. The request contains the ReauthNotificationInfo. + +![Sequence diagram for Reauthentication Notify](f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant UDM + Note right of UDM: 1. POST {reauthNotifyCallbackUri} (ReauthNotificationInfo) + UDM->>NF Service Consumer: 2a. 204 No Content + Note right of UDM: 2b. 4xx/5xx (Problem Details) or 3xx + NF Service Consumer-->>UDM: 2b. 4xx/5xx (Problem Details) or 3xx +``` + +The diagram illustrates the interaction between an NF Service Consumer and a UDM for reauthentication notification. The UDM sends a POST request to the NF Service Consumer's reauthNotifyCallbackUri with ReauthNotificationInfo. The NF Service Consumer responds with one of two options: 2a. 204 No Content (success) or 2b. 4xx/5xx (Problem Details) or 3xx (failure or redirection). + +Sequence diagram for Reauthentication Notify + +**Figure 5.3.2.15.2-1: Reauthentication Notify** + +1. The UDM sends a POST request to the reauthNotifyCallbackUri; such callback URI may be provided by the NF service consumer during the registration, or dynamically discovered by UDM by querying the NRF for the NF Profile of the NF Service Consumer. +- 2a. On success, the NF Service Consumer responds with "204 No Content". +- 2b. On failure or redirection, one of the appropriate HTTP status codes listed in Table 6.2.5.6-3 shall be returned. For a 4xx/5xx response, the message body may contain appropriate additional error information. + +#### 5.3.2.16 AuthTrigger + +##### 5.3.2.16.1 General + +The following procedure using the AuthTrigger service operation is supported: + +- Home network triggered primary authentication procedure as defined in 3GPP TS 33.501 [6] clause 6.1.5. + +##### 5.3.2.16.2 Auth Trigger + +Figure 5.3.2.16.2-1 shows a scenario where the NF consumer (e.g. AAnF) sends a request to the UDM to request UDM to trigger a primary (re-)authentication. + +![Sequence diagram for Auth Trigger. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. A solid arrow labeled '1. POST .../{ueId}/registrations/auth-trigger' points from the NF service consumer to the UDM. A return arrow labeled '2a. 204 No Content' and '2b. 404 Not Found' points from the UDM back to the NF service consumer.](af6be343f0c0a8f155f965dcf337b8af_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. POST .../{ueId}/registrations/auth-trigger + NF service consumer->>UDM: Request + Note right of UDM: 2a. 204 No Content +2b. 404 Not Found + UDM-->>NF service consumer: Response +``` + +Sequence diagram for Auth Trigger. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. A solid arrow labeled '1. POST .../{ueId}/registrations/auth-trigger' points from the NF service consumer to the UDM. A return arrow labeled '2a. 204 No Content' and '2b. 404 Not Found' points from the UDM back to the NF service consumer. + +**Figure 5.3.2.16.2-1: Auth Trigger** + +1. The NF Service Consumer sends a POST request (custom method: trigger-auth) to the UDM. +- 2a. On success, the NF Service Consumer responds with "204 No Content". +- 2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +## 5.4 Nudm\_UEAuthentication Service + +### 5.4.1 Service Description + +See 3GPP TS 23.501 [2] table 7.2.5-1. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +For the Nudm\_UEAuthentication service the following service operations are defined: + +- Get +- GetHssAv +- ResultConfirmation +- GetProseAv +- GetGbaAv +- Notification + +The Nudm\_UEAuthentication service is used by the AUSF to request the UDM to select an authentication method, calculate a fresh authentication vector (AV) if required for the selected method, and provide it to the AUSF by means of the Get service operation. See 3GPP TS 33.501 [6] clause 14.2.2 and 3GPP TS 33.535 [55] clause 6.1. The service may also be used by the AUSF to indicate to the UDM that the user is using a N5GC device behind Cable RGs in private networks or in isolated deployment scenarios with wireline access and that therefore the applicable authentication method shall be EAP based. See 3GPP TS 23.316 [37] clause 4.10a. + +The Nudm\_UEAuthentication service is also used by the HSS to request UDM to generate the authentication vector(s) for EPS or IMS domain by means of GetHssAv service operation. See 3GPP TS 23.632 [32] clause 5.6.3. + +The Nudm\_UEAuthentication service is also used by the AUSF to inform the UDM about the occurrence of a successful or unsuccessful authentication by means of the ResultConfirmation service operation. See 3GPP TS 33.501 [6] clause 14.2.3. + +The Nudm\_UEAuthentication service is also used by the AUSF to request the UDM to authenticate the FN-RG accessing to 5GC via W-AGF. See 3GPP TS 23.316 [37] clause 7.2.1.3. + +The Nudm\_UEAuthentication service is also used by the NF service consumer to request the UDM to remove the UE authentication result during the Purge of subscriber data in AMF after the UE deregisters from the network or NAS SMC fails following the successful authentication in the registration procedure. + +The Nudm\_UEAuthentication service is also used by the AUSF to request UDM to retrieve the Authentication Vectors for 5G ProSe by means of GetProseAv service operation. See 3GPP TS 33.503 [64] clause 7.4. + +The Nudm\_UEAuthentication service is also used by the GBA's BSF to request UDM to generate the GBA authentication vector by means of GetGbaAv service operation. See 3GPP TS 33.220 [61] clause N.2.2. + +#### 5.4.2.2 Get + +##### 5.4.2.2.1 General + +The following procedure using the Get service operation is supported: + +- Authentication Information Retrieval +- FN-RG Authentication + +As part of this Authentication Information Retrieval operation, the UDM authorizes or rejects the subscriber to use the service provided by the registered NF, based on subscription data (e.g. roaming restrictions). + +As part of this FN-RG Authentication operation, the UDM decides, based on the stored authentication profile of the SUPI and the authenticated indication that authentication has been completed by the W-AGF, that authentication by the home network is not required for the FN-RG. + +##### 5.4.2.2.2 Authentication Information Retrieval + +Figure 5.4.2.2.2-1 shows a scenario where the NF service consumer (AUSF) retrieves authentication information for the UE from the UDM (see also 3GPP TS 33.501 [6] clause 6.1.2). The request contains the UE's identity (supi or suci), the serving network name, and may contain resynchronization info. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for authentication information retrieval. The consumer sends a POST request to the UDM, and the UDM responds with either a 200 OK or a 403 Forbidden.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. POST .../{supiOrSuci}/security-information/generate-auth-data +(serving network name, resync. info) + NF service consumer->>UDM: Request + Note right of UDM: 2a. 200 OK (AuthenticationInfoResult) +2b. 403 Forbidden + UDM-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for authentication information retrieval. The consumer sends a POST request to the UDM, and the UDM responds with either a 200 OK or a 403 Forbidden. + +**Figure 5.4.2.2.2-1: NF service consumer requesting authentication information** + +1. The NF service consumer sends a POST request (custom method: generate-auth-data) to the resource representing the UE's security information. +- 2a. The UDM responds with "200 OK" with the message body containing the authentication data information. + +The AUSF shall store the authentication data information for subsequent authentication processing. If the AUSF is configured to store Kausf (e.g. based on its support of SoRProtection / UPUProtection service operations / deriving AKMA key after primary authentication), the AUSF shall preserve the Kausf and related information (e.g. SUPI) after the completion of the primary authentication. If the UDM decides that the primary authentication by an AAA server in a Credentials Holder is required, the AUSF shall perform the authentication with the AAA Server. In case the UDM receives an anonymous SUCI that contains the realm part, the UDM authorizes the UE based on realm part of SUCI, and send anonymous SUPI and the indicator to indicate to the AUSF to run primary authentication with an external Credentials holder (see 3GPP TS 33.501 [6], clause I.2.2). If the Default Credentials Server (DCS) provides UDM with the information of a Provisioning Server (PVS FQDN(s) and/or IP address(es)), the UDM provides the PVS info to the AUSF. + +- 2b. If the operation cannot be authorized due to e.g UE does not have required subscription data, none of the CAG IDs in the CAG cell match any of the subscribed and UE-acknowledged CAG IDs in the allowed CAG list, access barring or roaming restrictions, UDM receives an anonymous SUCI that does not contain the realm part, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). If the cellCagInfo is not received, the UDM shall not assume the UE is accessing from the PLMN and shall not stop the authentication if the UE is allowed to access 5GS via CAG cell(s) only. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +##### 5.4.2.2.3 FN-RG Authentication + +Figure 5.4.2.2.3-1 shows a scenario where the NF service consumer (AUSF) requests the UDM to authenticate the FN-RG accessing to 5GC via W-AGF. (see also 3GPP TS 23.316 [37] clause 7.2.1.3). The request contains the UE's identity (suci), and the authenticated indication. + +![Sequence diagram showing the NF service consumer requesting authentication information for FN-RG from the UDM.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../{supiOrSuci}/security-information-rg + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (RgAuthCtx) + UDM-->>NF service consumer: 2b. 403 Forbidden +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a GET request to the UDM for security information. The UDM responds with either a 200 OK status containing authentication data (RgAuthCtx) or a 403 Forbidden status. + +Sequence diagram showing the NF service consumer requesting authentication information for FN-RG from the UDM. + +**Figure 5.4.2.2.3-1: NF service consumer requesting authentication information for FN-RG** + +1. The NF service consumer sends a GET request to the resource representing the UE's security information. +- 2a. The UDM responds with "200 OK" with the message body containing the authentication data information of FN-RG. +- 2b. If the operation cannot be authorized due to e.g. UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.4.2.3 ResultConfirmationInform + +##### 5.4.2.3.1 General + +The following procedure using the ResultConfirmation service operation is supported: + +- Authentication Confirmation +- Authentication Result Removal + +##### 5.4.2.3.2 Authentication Confirmation + +Figure 5.4.2.3.2-1 shows a scenario where the NF service consumer (AUSF) confirms the occurrence of a successful or unsuccessful authentication in a serving network to the UDM (see also 3GPP TS 33.501 [6] clause 6.1.4.1a). The request contains the UE's identity (supi), and information about the authentication occurrence (AuthEvent). + +![Sequence diagram showing the NF service consumer confirming UE authentication to the UDM.](e4c6fa93821e3546ee9fcae897ae2771_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. POST .../{supi}/auth-events (AuthEvent) + Note right of UDM: + UDM-->>NF service consumer: 2a. 201 Created + UDM-->>NF service consumer: 2b. 4xx/5xx (ProblemDetails) +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a POST request to the UDM to confirm authentication events. The UDM responds with either a 201 Created status or a 4xx/5xx status with problem details. + +Sequence diagram showing the NF service consumer confirming UE authentication to the UDM. + +**Figure 5.4.2.3.2-1: NF service consumer confirms UE authentication** + +1. The NF service consumer sends a POST request to the resource representing the UE's authentication events. The content of the POST request shall contain a representation of the individual AuthEvent resource to be created. + +There shall be only one individual AuthEvent per UE per Serving Network identified by the supi in URI and servingNetworkName in AuthEvent. + +- 2a. On success, the UDM responds with "201 Created" and the "Location" header shall be present and shall contain the URI of the created resource. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned. + +##### 5.4.2.3.3 Authentication Result Removal + +Figure 5.4.2.3.3-1 shows a scenario where the NF service consumer requests the UDM to remove the Authentication Result. The request contains the UE's identity {supi}, the authEvent Id, and an indication to remove Authentication result. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM to remove an authentication result.](cb4cfa42ce34febde7bdb882f3fc3094_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. PUT .../{supi}/auth-events/{authEventId} (AuthEvent) + NF service consumer->>UDM: Request + Note right of UDM: 2a. 204 No Content + UDM-->>NF service consumer: Success Response + Note right of UDM: 2b. 4xx/5xx (ProblemDetails) + UDM-->>NF service consumer: Error Response +``` + +The diagram illustrates a sequence of interactions between an 'NF service consumer' and a 'UDM'. The consumer sends a '1. PUT .../{supi}/auth-events/{authEventId} (AuthEvent)' request to the UDM. The UDM responds with either '2a. 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails)' on failure. + +Sequence diagram showing the interaction between an NF service consumer and a UDM to remove an authentication result. + +**Figure 5.4.2.3.3-1: NF service consumer removes the authentication result** + +1. The NF service consumer shall send a PUT request to the UDM. The content shall contain the indication to remove authentication result. +- 2a. On success, "204 No Content" shall be returned. The UDM shall remove the Authentication result of the UE by completely replacing the individual AuthEvent resource. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned. + +#### 5.4.2.4 GetHssAv + +##### 5.4.2.4.1 General + +The following procedure using the GetHssAv service operation is supported: + +- HSS Authentication Vector Retrieval + +##### 5.4.2.4.2 HSS Authentication Vector Retrieval + +Figure 5.4.2.4.2-1 shows a scenario where the NF service consumer (HSS) retrieves authentication vector(s) for the UE from the UDM (see also 3GPP TS 23.632 [32] clause 5.6.3). The request contains the UE's identity (SUPI), the authentication method, serving network id, and may contain resynchronization info. + +![Sequence diagram showing the NF service consumer requesting authentication vector(s) from the UDM. The consumer sends a POST request to .../{supi}/hss-security-information/{hssAuthType}/generate-av. The UDM responds with 200 OK, 403 Forbidden, or 404 Not Found.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. POST .../{supi}/hss-security-information/{hssAuthType}/generate-av (HssAuthenticationInfoRequest) + NF service consumer->>UDM: Request + Note right of UDM: 2a. 200 OK (HssAuthenticationInfoResult) +2b. 403 Forbidden +2c. 404 Not Found + UDM-->>NF service consumer: Response + +``` + +Sequence diagram showing the NF service consumer requesting authentication vector(s) from the UDM. The consumer sends a POST request to .../{supi}/hss-security-information/{hssAuthType}/generate-av. The UDM responds with 200 OK, 403 Forbidden, or 404 Not Found. + +**Figure 5.4.2.4.2-1: NF service consumer requesting authentication vector(s)** + +1. The NF service consumer sends a POST request (custom method: generate-av) to the resource representing the UE's HSS security information; the type of requested AV is included as part of the resource URI. +- 2a. The UDM responds with "200 OK" with the message body containing the authentication vector(s). +- 2b. If the operation cannot be authorized due to e.g UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). +- 2c. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.4.2.5 GetGbaAv + +##### 5.4.2.5.1 General + +The following procedure using the GetGbaAv service operation is supported: + +- GBA Authentication Vector Retrieval + +##### 5.4.2.5.2 GBA Authentication Vector Retrieval + +Figure 5.4.2.5.2-1 shows a scenario where the NF service consumer (GBA's BSF) retrieves authentication vector(s) for the UE from the UDM (see also 3GPP TS 33.220 [61]). The request contains the UE's identity (SUPI), the authentication method and may contain resynchronization info. + +![Sequence diagram showing the NF service consumer requesting authentication vector(s) from the UDM. The consumer sends a POST request to .../{supi}/gba-security-information/generate-av. The UDM responds with 200 OK, 403 Forbidden, or 403 Not Found.](6f659142d4789aa889184459f884787e_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. POST .../{supi}/gba-security-information/generate-av (GbaAuthenticationInfoRequest) + NF service consumer->>UDM: Request + Note right of UDM: 2a. 200 OK (GbaAuthenticationInfoResult) +2b. 403 Forbidden +2c. 403 Not Found + UDM-->>NF service consumer: Response + +``` + +Sequence diagram showing the NF service consumer requesting authentication vector(s) from the UDM. The consumer sends a POST request to .../{supi}/gba-security-information/generate-av. The UDM responds with 200 OK, 403 Forbidden, or 403 Not Found. + +**Figure 5.4.2.5.2-1: NF service consumer requesting authentication vector(s)** + +1. The NF service consumer sends a POST request (custom method: generate-av) to the resource representing the UE's GBA security information. +- 2a. The UDM responds with "200 OK" with the message body containing the authentication vector(s). + +- 2b. If the operation cannot be authorized due to e.g UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). +- 2c. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.4.2.6 GetProseAv + +##### 5.4.2.6.1 General + +The following procedure using the GetProseAv service operation: + +- ProSe Authentication Vector Retrieval + +##### 5.4.2.6.2 ProSe Authentication Vector Retrieval + +Figure 5.4.2.6.2-1 shows a scenario where the NF service consumer (AUSF) retrieves ProSe authentication vector(s) for the 5G ProSe Remote UE or for the 5G ProSe End UE from the UDM (see also 3GPP TS 33.503 [64] clause 7.4). The request contains the UE's identity (supi or suci), Relay Service Code, and may contain resynchronization info. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for ProSe authentication vector retrieval.](e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note right of NF: 1. POST .../{supiOrSuci}/prose-security-information/generate-av(ProSeAuthenticationInfoRequest) + NF->>UDM: Request + Note left of UDM: 2a. 200 OK (ProSeAuthenticationInfoResult) + Note left of UDM: 2b. 403 Forbidden + Note left of UDM: 2c. 404 Not Found + UDM-->>NF: Response +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a POST request to the UDM. The UDM responds with one of three possible outcomes: 2a. 200 OK (ProSeAuthenticationInfoResult), 2b. 403 Forbidden, or 2c. 404 Not Found. + +Sequence diagram showing the interaction between an NF service consumer and a UDM for ProSe authentication vector retrieval. + +**Figure 5.4.2.6.2-1: NF service consumer requesting authentication vector(s)** + +1. The NF service consumer sends a POST request to the UDM. +- 2a. The UDM responds with "200 OK" with the message body containing the authentication vector. Exactly one ProSeAuthenticationVector should be included within the ProSeAuthenticationInfoResult. +- 2b. If the operation cannot be authorized due to e.g UE does not have required subscription data, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). +- 2c. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.4.2.7 Notification + +##### 5.4.2.7.1 General + +The following procedures using the Notification service operation are supported: + +- UDR-initiated Data Restoration Notification + +##### 5.4.2.7.2 UDR-initiated Data Restoration Notification + +Figure 5.4.2.7.2-1 shows a scenario where the UDM notifies the NF Service Consumer (e.g. AUSF) about the need to restore data (e.g. confirmation of successful authentication events) due to a potential data-loss event occurred at the UDR. The request contains identities representing those UEs potentially affected by such event. + +![Sequence diagram showing UDR-initiated Data Restoration. The NF Service Consumer and UDM exchange messages: 1. POST {dataRestorationCallbackUri} (DataRestorationNotification) from UDM to NF Service Consumer; 2a. 204 No Content from NF Service Consumer to UDM; 2b. 4xx/5xx (Problem Details) or 3xx from NF Service Consumer to UDM.](898fb89a50d9ec1dfb4e425c816976a7_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UDM + Note right of UDM: 1. POST {dataRestorationCallbackUri} +(DataRestorationNotification) + UDM->>NF Service Consumer: 1. POST {dataRestorationCallbackUri} +(DataRestorationNotification) + Note left of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>UDM: 2a. 204 No Content + Note left of NF Service Consumer: 2b. 4xx/5xx (Problem Details) or 3xx + NF Service Consumer-->>UDM: 2b. 4xx/5xx (Problem Details) or 3xx + +``` + +Sequence diagram showing UDR-initiated Data Restoration. The NF Service Consumer and UDM exchange messages: 1. POST {dataRestorationCallbackUri} (DataRestorationNotification) from UDM to NF Service Consumer; 2a. 204 No Content from NF Service Consumer to UDM; 2b. 4xx/5xx (Problem Details) or 3xx from NF Service Consumer to UDM. + +**Figure 5.4.2.7.2-1: UDR-initiated Data Restoration** + +1. The UDM (after receiving a notification from UDR about a potential data-loss event) sends a POST request to the dataRestorationCallbackUri; such callback URI may be provided by the NF service consumer during the confirmation of a successful authentication event, or dynamically discovered by UDM by querying the NRF for the NF Profile of the NF Service Consumer. +- 2a. On success, the NF Service Consumer responds with "204 No Content". +- 2b. On failure or redirection, one of the appropriate HTTP status codes listed in Table 6.3.5.y-3 shall be returned. For a 4xx/5xx response, the message body may contain appropriate additional error information. + +## 5.5 Nudm\_EventExposure Service + +### 5.5.1 Service Description + +See 3GPP TS 23.501 [2] table 7.2.5-1. + +### 5.5.2 Service Operations + +#### 5.5.2.1 Introduction + +For the Nudm\_EventExposure service the following service operations are defined: + +- Subscribe +- Unsubscribe +- Notify +- ModifySubscription + +The Nudm\_EventExposure service is used by consumer NFs (e.g. NEF) to subscribe to notifications of event occurrence by means of the Subscribe service operation. For events that can be detected by the AMF, the UDM makes use of the appropriate AMF service operation to subscribe on behalf of the consumer NF (e.g. NEF). + +The Nudm\_EventExposure service is also used by the consumer NFs (e.g. NEF) that have previously subscribed to notifications, to unsubscribe by means of the Unsubscribe service operation. For events that can be detected by the AMF, the UDM makes use of the appropriate AMF service operation to unsubscribe on behalf of the consumer NF (e.g. NEF). + +The Nudm\_EventExposure service is also used by the subscribed consumer NFs (e.g. NEF) to get notified by the UDM when a subscribed event occurs at the UDM by means of the Notify service operation. For subscribed events that can occur at the AMF, the consumer NF (e.g. NEF) makes use of the corresponding AMF service operation to get notified by the AMF directly without UDM involvement. + +The Nudm\_EventExposure service is also used by the subscribed consumer NFs (e.g. NEF) to modify an existing subscription by means of the ModifySubscription service operation. + +For details see 3GPP TS 23.502 [3] clause 4.15. + +#### 5.5.2.2 Subscribe + +##### 5.5.2.2.1 General + +The following procedures using the Subscribe service operation are supported: + +- Subscribe to Notification of event occurrence + +##### 5.5.2.2.2 Subscription to Notification of event occurrence + +Figure 5.5.2.2.2-1 shows a scenario where the NF service consumer sends a request to the UDM to subscribe to notifications of event occurrence (see also 3GPP TS 23.502 [3] figure 4.15.3.2.2-1 step 1 and 3GPP TS 23.502 [3] Figure 4.15.3.2.3b-1 step 1). The request contains a callback URI, the type of event that is monitored and additional information e.g. event filters and reporting options. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for subscription. The consumer sends a POST request to the UDM. The UDM responds with either 201 Created, 404 Not Found, or 403 Forbidden.](cd141897aa368dbbaa398ace230cdd85_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note right of UDM: 2a. 201 Created (CreatedEeSubscription) +2b. 404 Not Found +2c. 403 Forbidden + NF->>UDM: 1. POST.../{ueIdentity}/ee-subscriptions (EeSubscription) + UDM-->>NF: 2a. 201 Created (CreatedEeSubscription) + Note left of NF: 2b. 404 Not Found +2c. 403 Forbidden + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for subscription. The consumer sends a POST request to the UDM. The UDM responds with either 201 Created, 404 Not Found, or 403 Forbidden. + +**Figure 5.5.2.2.2-1: NF service consumer subscribes to notifications** + +1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (.../{ueIdentity}/ee-subscriptions), to create a subscription as present in message body. The values ueIdentity shall take are specified in Table 6.4.3.2.2-1. The request may contain an expiry time, suggested by the NF Service Consumer, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event(s) shall stop generating notifications, the indication on whether the subscription applies also to EPC. + +If MTC Provider information and/or AF ID are received in the request, the UDM shall check whether the MTC Provider and/or the AF is allowed to perform this operation for the UE or for the group of UEs or Any UE which is indicated in the Resource URI variable ueIdentity; otherwise, the UDM shall skip the MTC provider and/or AF authorization check. + +- 2a. On success, the UDM responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription. + +If the event subscription was for a group of UEs: + +- The "maxNumOfReports" in the "reportingOptions" IE shall be applicable to each UE in the group; +- The UDM shall return the number of UEs in that group in the "numberOfUes" IE. + +The NF service consumer shall keep track of the maximum number of reports reported for each UE in the event report and when "maxNumOfReports\*numberOfUes" limit is reached, the NF service consumer shall initiate the unsubscription of the notification towards the UDM (see clause 5.5.2.3.2). + +If the event subscription was for a list events, the "reportingOptions" attribute (containing, e.g., "reportMode", "maxNumOfReports",...) shall be applicable to each event in the list. The NF service consumer shall keep track of the maximum number of reports reported for each event in the event report and when "maxNumOfReports\*number of events" limit is reached, the NF service consumer shall initiate the unsubscription of the notification towards the UDM (see clause 5.5.2.3.2). If the "reportMode" included in "reportingOptions" is not applicable (see clause 6.4.6.3.7) to all events in the list, the request shall be rejected with error "400 Bad Request", and with ProblemDetails containing application error set to cause value "OPTIONAL\_IE\_INCORRECT". + +The response, based on operator policy, may contain the expiry time, as determined by the UDM, after which the subscription becomes invalid. Before the subscription is going to expire, if the NF Service Consumer wants to keep receiving notifications, it shall modify the subscription in the UDM with a new expiry time. The NF Service Producer shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall not associate an expiry time for the subscription. + +If the indication on whether the subscription applies also to EPC is included and set to true in the request, the response shall include the indication on whether the subscription was also successful in EPC domain. If the subscription also applies to the EPC domain, the only the Event Types below shall apply to the EPC domain, + +- The event type "LOSS\_OF\_CONNECTIVITY", it shall be mapped to event type "LOSS\_OF\_CONNECTIVITY" on Nhss +- The event type "UE\_REACHABILITY\_FOR\_DATA" and the reportCfg in reachabilityForDataCfg set to "DIRECT\_REPORT", it shall be mapped to event type "UE\_REACHABILITY\_FOR\_DATA" on Nhss +- The event type "LOCATION\_REPORTING", and dddTrafficDes or Dnn is not included in the request, it shall be mapped to event type "LOCATION\_REPORTING" on Nhss +- The event type "COMMUNICATION\_FAILURE", it shall be mapped to event type "COMMUNICATION\_FAILURE" on Nhss +- The event type "AVAILABILITY\_AFTER\_DDN\_FAILURE", it shall be mapped to event type "AVAILABILITY\_AFTER\_DDN\_FAILURE" on Nhss +- The event type "PDN\_CONNECTIVITY\_STATUS", it shall be mapped to event type "PDN\_CONNECTIVITY\_STATUS" on Nhss +- The event type "UE\_REACHABILITY\_FOR\_SMS" and reachabilityForSmsCfg set to "REACHABILITY\_FOR\_SMS\_OVER\_NAS", it shall be mapped to event type "UE\_REACHABILITY\_FOR\_SMS" on Nhss +- The event type "UE\_MEMORY\_AVAILABLE\_FOR\_SMS", it shall be mapped to event type "UE\_MEMORY\_AVAILABLE\_FOR\_SMS" on Nhss + +If some of the requested monitoring configurations fails, the response may include the failedMonitoringConfigs to indicate the failed cause of the failed monitoring configurations. + +If some of the requested monitoring configurations fails in the EPC domain or the EE subscription fails in the EPC domain, the response may include the failedMoniConfigsEPC to indicate the failed cause of the failed monitoring configurations or the failed cause of the EE subscription in the EPC domain. + +If the NF Service Consumer has included the immediateFlag with value as "true" in the event subscription for an individual UE and the event requested for immediate reporting is reported by the UDM (e.g. "CHANGE\_OF\_SUPI\_PEI\_ASSOCIATION" or "ROAMING\_STATUS"), the UDM may include the current status of the event if available in the response. + +If the NF Service Consumer has included the immediateFlag with value as "true" in the event subscription for an individual UE and the event requested for immediate reporting is reported by the AMF (e.g. LOCATION\_REPORT) and the NF service consumer has indicated supporting of "IERSR" feature (see clause 6.4.8), the UDM shall indicate the support of "IERSR" feature when subscribing to the event on the AMF (see clause 6.2.8 of 3GPP TS 29.518 [36]). UDM shall include the current status of the event if received from the AMF in subscription creation response. + +If the NF Service Consumer has included the immediateFlag with value as "true" in the event subscription for an individual UE, the indication on whether the subscription applies also to EPC is included and set to "true" in the request and the NF service consumer has indicated supporting of "IERSR" feature (see clause 6.4.8), the UDM shall indicate the support of "ERIR" feature when subscribing to the event on the HSS (see clause 6.4.8 of 3GPP TS 29.563 [62]). UDM shall include the current status of the event in EPC if received from the HSS in subscription creation response. + +NOTE: IERSR feature is not applicable to events detected by the SMF. + +If the UDM supports the EneNA feature (see clause 6.2.8), the event is detected by a remote NF (e.g. AMF) and directly notified to the NF consumer (e.g. NWDAF) and the "notifFlag" attribute is included in the request by e.g. the NWDAF or DCCF, the UDM shall forward the "notifFlag" attribute to the remote NF (e.g. AMF). Additionally, if the UDM also supports the ENAPH3 feature (see clause 6.2.8) and the NF service consumer also included event muting instructions in the request, the UDM shall also forward the event muting instructions to the remote NF, if the subscription creation request is accepted by the remote NF, the UDM may also forward the following information to the NF service consumer in the response if it is received: + +- the maximum number of notifications that the remote NF expects to be able to store for the subscription; +- an estimate of the duration for which notifications can be buffered. + +2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +2c. If there is no valid subscription data for the UE, i.e. based on the UE's subscription information monitoring of the requested EventType is not allowed, or the requested EventType is not supported, or when MTC Provider or AF are not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +If the UDM supports the EneNA and ENAPH3 features (see clause 6.2.8), the NF service consumer sets the "notifFlag" attribute to "DEACTIVATE" and event muting instructions in the request, but the remote NF cannot accept the received instructions and reject the request with a 403 Forbidden response and the application error "MUTING\_EXC\_INSTR\_NOT\_ACCEPTED", the UDM shall forward the error response to the NF service consumer. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +##### 5.5.2.2.3 Void + +#### 5.5.2.3 Unsubscribe + +##### 5.5.2.3.1 General + +The following procedures using the Unsubscribe service operation are supported: + +- Unsubscribe to Notifications of event occurrence + +##### 5.5.2.3.2 Unsubscribe to notifications of event occurrence + +Figure 5.5.2.3.2-1 shows a scenario where the NF service consumer sends a request to the UDM to unsubscribe from notifications of event occurrence. The request contains the URI previously received in the Location HTTP header of the response to the subscription. + +![Sequence diagram showing the NF service consumer unsubscribing to notifications from the UDM.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. DELETE...{ueIdentity}/ee-subscriptions/{subscriptionId} + NF service consumer->>UDM: 1. DELETE...{ueIdentity}/ee-subscriptions/{subscriptionId} + Note right of UDM: 2a. 204 No Content + Note right of UDM: 2b. 404 Not Found + UDM-->>NF service consumer: 2a. 204 No Content + UDM-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDM. The NF service consumer sends a DELETE request (step 1) to the UDM. The UDM responds with either a 204 No Content (step 2a) or a 404 Not Found (step 2b) response. + +Sequence diagram showing the NF service consumer unsubscribing to notifications from the UDM. + +**Figure 5.5.2.3.2-1: NF service consumer unsubscribes to notifications** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation. +- 2a. On success, the UDM responds with "204 No Content". +- 2b. If there is no valid subscription available (e.g. due to an unknown SubscriptionId value), HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +#### 5.5.2.4 Notify + +##### 5.5.2.4.1 General + +The following procedures using the Notify service operation are supported: + +- Event Occurrence Notification +- Monitoring Revocation Notification +- UDR-initiated Data Restoration Notification + +##### 5.5.2.4.2 Event Occurrence Notification + +Figure 5.5.2.4.2-1 shows a scenario where the UDM notifies the NF service consumer (that has subscribed to receive such notification) about occurrence of an event (see also 3GPP TS 23.502 [3] figure 4.15.3.2.2-1 step 4a), or the current status of subscribed events for immediate reporting if event reports cannot be included in the subscription response (i.e. the IERSR/ERIR features are not supported end-to-end by NEF/UDM/AMF/HSS). The request contains the Reference IDs as previously received in the EeSubscription (see clause 6.4.6.2.2). + +![Sequence diagram showing the UDM notifying the NF service consumer about an event occurrence.](bd57a547bec253d4179e5c4491c53dbb_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note right of UDM: 1. POST {callbackReference} (MonitoringReport) + UDM->>NF service consumer: 1. POST {callbackReference} (MonitoringReport) + Note left of NF service consumer: 2. 204 No Content + NF service consumer-->>UDM: 2. 204 No Content +``` + +The diagram illustrates a sequence of interactions between a UDM and an NF service consumer. The UDM sends a POST request (step 1) to the NF service consumer. The NF service consumer responds with a 204 No Content (step 2) response. + +Sequence diagram showing the UDM notifying the NF service consumer about an event occurrence. + +**Figure 5.5.2.4.2-1: Event Occurrence Notification** + +1. The UDM sends a POST request to the callbackReference URI as provided by the NF service consumer during the subscription, the request shall include in each report the Reference ID of the associated monitoring configuration. +2. The NF Service Consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +##### 5.5.2.4.3 Monitoring Revocation Notification + +Figure 5.5.2.4.3-1 shows a scenario where the UDM notifies the NF service consumer (that has subscribed to receive such notification) about revocation of the monitoring events due to some reasons (e.g. the revocation of the authorisation on AF or MTC Provider for certain events of the UE, or group member UE(s) are removed from a group subscription). The request contains the secondCallbackRef URI as previously received in the EeSubscription (see clause 6.4.6.2.2). + +![Sequence diagram for Monitoring Revocation Notification](5132b3a97ac70fe4765c1e07e66b72b3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + Note right of UDM: + UDM->>NF service consumer: 1. POST {secondCallbackRef} (EeMonitoringRevoked) + NF service consumer-->>UDM: 2. 204 No Content +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a UDM. The NF service consumer is on the left and the UDM is on the right. The first message is a POST request from the UDM to the NF service consumer, labeled "1. POST {secondCallbackRef} (EeMonitoringRevoked)". The second message is a 204 No Content response from the NF service consumer to the UDM, labeled "2. 204 No Content". + +Sequence diagram for Monitoring Revocation Notification + +**Figure 5.5.2.4.3-1: Monitoring Revocation Notification** + +1. The UDM sends a POST request to the secondCallbackRef as provided by the NF service consumer during the subscription, the request shall include the revoked monitoring events due to some reasons (e.g. the revocation of the authorisation on AF or MTC Provider for certain events of the UE). + +If the revocation is triggered by network initiated explicit event notification subscription cancel procedure (see clause 4.15.3.2.11 of 3GPP TS 23.502 [3]), the request body shall contain either: + +- a list of group member UE(s) that are excluded from the group subscription and the revocation cause shall be set to "EXCLUDED\_FROM\_GROUP", or +- a GPSI which is not longer associated to an individual subscription and the revocation cause shall be set to "GPSI\_REMOVED". + +2. The NF Service Consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +##### 5.5.2.4.4 UDR-initiated Data Restoration + +Figure 5.5.2.4.4-1 shows a scenario where the UDM notifies the NF Service Consumer (e.g. a NEF) about the need to restore subscription-data due to a potential data-loss event occurred at the UDR. The request contains identities representing those UEs potentially affected by such event. + +![Sequence diagram for UDR-initiated Data Restoration. The diagram shows two lifelines: NF Service Consumer and UDM. The UDM sends a POST request to the NF Service Consumer's dataRestorationCallbackUri with a DataRestorationNotification. The NF Service Consumer responds with either a 204 No Content (2a) or an error status code (2b) such as 4xx/5xx (Problem Details) or 3xx.](26d664119ad25250780f554633444e54_img.jpg) + +``` + +sequenceDiagram + participant UDM + participant NFSC as NF Service Consumer + Note right of UDM: 1. POST {dataRestorationCallbackUri} +(DataRestorationNotification) + UDM->>NFSC: 1. POST {dataRestorationCallbackUri} +(DataRestorationNotification) + Note right of NFSC: 2a. 204 No Content + NFSC-->>UDM: 2a. 204 No Content + Note right of NFSC: 2b. 4xx/5xx (Problem Details) or 3xx + NFSC-->>UDM: 2b. 4xx/5xx (Problem Details) or 3xx + +``` + +Sequence diagram for UDR-initiated Data Restoration. The diagram shows two lifelines: NF Service Consumer and UDM. The UDM sends a POST request to the NF Service Consumer's dataRestorationCallbackUri with a DataRestorationNotification. The NF Service Consumer responds with either a 204 No Content (2a) or an error status code (2b) such as 4xx/5xx (Problem Details) or 3xx. + +**Figure 5.5.2.4.4-1: UDR-initiated Data Restoration** + +1. The UDM (after receiving a notification from UDR about a potential data-loss event) sends a POST request to the dataRestorationCallbackUri; such callback URI may be provided by the NF service consumer during the registration, or dynamically discovered by UDM by querying the NRF for the NF Profile of the NF Service Consumer. +- 2a. On success, the NF Service Consumer responds with "204 No Content". +- 2b. On failure or redirection, one of the appropriate HTTP status codes listed in Table 6.4.5.4-3 shall be returned. For a 4xx/5xx response, the message body may contain appropriate additional error information. + +#### 5.5.2.5 ModifySubscription + +##### 5.5.2.5.1 General + +The following procedures using the ModifySubscription service operation are supported: + +- Modification of an EE-Subscription to notification of events +- Remove or add group member UE(s) for a group subscription + +##### 5.5.2.5.2 Modification of a subscription + +The service operation is invoked by a NF Service Consumer, e.g. NEF, towards the UDM, when it needs to modify an existing subscription previously created by itself at the UDM. + +The NF Service Consumer shall modify the subscription by using HTTP method PATCH with the URI of the individual subscription resource (see clause 6.4.3.3) to be modified. + +![Sequence diagram for NF service consumer updates subscription. The diagram shows two lifelines: NF service consumer and UDM. The NF service consumer sends a PATCH request to the UDM for a specific subscription resource. The UDM responds with one of the following status codes: 204 No Content (2a), 200 OK (PatchResult) (2b), 404 Not Found (2c), or 403 Forbidden (2d).](c8e5b3ef81948bb13d5c6c3c326799ea_img.jpg) + +``` + +sequenceDiagram + participant NSC as NF service consumer + participant UDM + Note left of NSC: 1. PATCH .../{ueIdentity}/ee-subscriptions/{subscriptionId} +(array(PatchItem)) + NSC->>UDM: 1. PATCH .../{ueIdentity}/ee-subscriptions/{subscriptionId} +(array(PatchItem)) + Note right of UDM: 2a. 204 No Content + UDM-->>NSC: 2a. 204 No Content + Note right of UDM: 2b. 200 OK (PatchResult) + UDM-->>NSC: 2b. 200 OK (PatchResult) + Note right of UDM: 2c. 404 Not Found + UDM-->>NSC: 2c. 404 Not Found + Note right of UDM: 2d. 403 Forbidden + UDM-->>NSC: 2d. 403 Forbidden + +``` + +Sequence diagram for NF service consumer updates subscription. The diagram shows two lifelines: NF service consumer and UDM. The NF service consumer sends a PATCH request to the UDM for a specific subscription resource. The UDM responds with one of the following status codes: 204 No Content (2a), 200 OK (PatchResult) (2b), 404 Not Found (2c), or 403 Forbidden (2d). + +**Figure 5.5.2.5.2-1: NF service consumer updates subscription** + +1. The NF service consumer (e.g. NEF) shall send a PATCH request to the resource representing a subscription. The modification may be for the events subscribed or for updating the event report options. +- 2a. On success, the request is accepted, and all the modification instructions in the PATCH request have been implemented, the UDM shall respond with "204 No Content". +- 2b. On success, the request is accepted, but some of the modification instructions in the PATCH request have been discarded, the UDM shall respond with "200 OK" including PatchResult to indicate the failed modifications. +- 2c. If the resource does not exist e.g. the subscriptionId cannot be found, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2d. If the modification can't be accepted, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.5.2.5.3 Remove or add group member UE(s) for a group subscription + +The service operation is invoked by a NF Service Consumer, e.g. NEF, towards the UDM, to remove or add group member UE(s) for the group subscription. + +The NF Service Consumer shall modify the subscription by using HTTP method PATCH with the URI of the individual subscription resource (see clause 6.4.3.3) to be modified. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for updating a subscription. The consumer sends a PATCH request to the UDM. The UDM responds with one of three possible status codes: 204 No Content (success), 404 Not Found (resource not found), or 403 Forbidden (modification not accepted).](9b686adccf125267a013fa25721231a3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note right of NF service consumer: 1. PATCH .../{ueIdentity}/ee-subscriptions/{subscriptionId} (array(PatchItem)) + NF service consumer->>UDM: 1. PATCH .../{ueIdentity}/ee-subscriptions/{subscriptionId} (array(PatchItem)) + Note left of UDM: 2a. 204 No Content + Note left of UDM: 2b. 404 Not Found + Note left of UDM: 2c. 403 Forbidden + UDM-->>NF service consumer: 2a. 204 No Content + UDM-->>NF service consumer: 2b. 404 Not Found + UDM-->>NF service consumer: 2c. 403 Forbidden +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for updating a subscription. The consumer sends a PATCH request to the UDM. The UDM responds with one of three possible status codes: 204 No Content (success), 404 Not Found (resource not found), or 403 Forbidden (modification not accepted). + +**Figure 5.5.2.5.3-1: NF service consumer updates subscription** + +1. The NF service consumer (e.g. NEF) shall send a PATCH request to the resource representing a group subscription and the request body shall contain a PatchItem with the JSON pointer to the "/excludeGpsiList" or the "/includeGpsiList" object in the subscription. +- 2a. On success, the request is accepted, and all the modification instructions in the PATCH request have been implemented, the UDM shall respond with "204 No Content". +- 2b. If the resource does not exist e.g. the subscriptionId cannot be found, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the modification can't be accepted, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +## 5.6 Nudm\_ParameterProvision Service + +### 5.6.1 Service Description + +See 3GPP TS 23.501 [2] table 7.2.5-1. + +### 5.6.2 Service Operations + +#### 5.6.2.1 Introduction + +For the Nudm\_ParameterProvision service the following service operations are defined: + +- Update +- Create +- Delete +- Get + +The Nudm\_ParameterProvision service is used by consumer NFs (e.g. NEF) to update a UE's or a group of UEs' subscription data by means of the Update service operation. + +For details see 3GPP TS 23.502 [3] clause 4.15.6.2. + +The Nudm\_ParameterProvision service can also be used by a NF Service Consumer (e.g. SOR-AF) to send updated Steering of Roaming Information for a UE to the UDM at any time, as specified in Annex C.3 of 3GPP TS 23.122 [20]. + +#### 5.6.2.2 Update + +##### 5.6.2.2.1 General + +The following procedures using the Update service operation are supported: + +- Subscription data update +- SoR Information update +- 5G VN Group modification +- Parameter Provisioning Data Entry per AF update +- 5G-MBS-Group modification + +##### 5.6.2.2.2 Subscription data update + +Figure 5.6.2.2.2-1 shows a scenario where the NF service consumer (e.g. NEF, AMF) sends a request to the UDM to update a UE's subscription data (see 3GPP TS 23.502 [3] figure 4.15.6.2-1 step 2 and also 3GPP TS 23.273 [38] Figure 6.12.1-1 step 2). The request contains the identifier of the UE's parameter provision data ( .../{ueId}/pp-data) and the modification instructions. The values ueId shall take are specified in Table 6.5.3.2.2-1. + +![Sequence diagram showing NF service consumer sending a PATCH request to UDM for subscription data modification. The request is '1. PATCH.../{ueId}/pp-data (ModificationInstruction)'. The UDM responds with '2a. 204 No Content', '2b. 200 OK', or '2c. 403 Forbidden'.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. PATCH.../{ueId}/pp-data (ModificationInstruction) + NF service consumer->>UDM: Request + Note right of UDM: 2a. 204 No Content +2b. 200 OK +2c. 403 Forbidden + UDM-->>NF service consumer: Response + +``` + +Sequence diagram showing NF service consumer sending a PATCH request to UDM for subscription data modification. The request is '1. PATCH.../{ueId}/pp-data (ModificationInstruction)'. The UDM responds with '2a. 204 No Content', '2b. 200 OK', or '2c. 403 Forbidden'. + +**Figure 5.6.2.2.2-1: NF service consumer updates subscription data** + +1. The NF service consumer (e.g. NEF, AMF) sends a PATCH request to the resource that represents a UE's modifiable subscription data. + +If MTC Provider information and/or AF ID are received in the request, the UDM shall check whether the MTC Provider and/or the AF is allowed to perform this operation for the UE; otherwise, the UDM shall skip the MTC provider and/or AF authorization check. + +- 2a. The UDM responds with "204 No Content". + +- 2b. Upon partial success, UDM responds with "200 OK". + +If the request includes the "Expected UE Behaviour Data" parameters, then, based on local configuration, the UDM may determine if there are any requirements in the UDM with respect to threshold conditions that need to be met by the received parameter before the UDM stores the parameter in, e.g. the UDR. If the threshold criteria is satisfied, the UDM may continue to process the request. If the threshold criteria is not satisfied, UDM may return partial success with a related cause value e.g. "confidence level not sufficient" or "accuracy level not sufficient". + +- 2c. If MTC Provider or AF are not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +NOTE: Upon reception of an update or removal of maximum latency, maximum response time or DL Buffering Suggested Packet Count, UDM may need to adjust the value of active time and/or periodic registration timer and/or DL Buffering Suggested Packet Count and the UDM shall notify AMF and/or SMF if the values are updated (see clause 4.15.6.3a of 3GPP TS 23.502 [3]). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.6.2.2.3 5G VN Group modification + +Figure 5.6.2.2.3-1 shows a scenario where the NF service consumer sends a request to the UDM to modify an external group id's group data. The request contains the external group identifier of the group and the modification instructions. + +![Sequence diagram showing NF service consumer sending a PATCH request to UDM for 5G VN Group modification. The request is '1. PATCH.../5g-vn-groups/{extGroupId} (5GVnGroupConfigurationModification)'. The UDM responds with '2a. 204 No Content', '2b. 404 Not Found', or '2c. 403 Forbidden'.](d5918cee231b536f20789a18d861fae3_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. PATCH.../5g-vn-groups/{extGroupId} +(5GVnGroupConfigurationModification) + NF service consumer->>UDM: Request + Note right of UDM: 2a. 204 No Content +2b. 404 Not Found +2c. 403 Forbidden + UDM-->>NF service consumer: Response + +``` + +Sequence diagram showing NF service consumer sending a PATCH request to UDM for 5G VN Group modification. The request is '1. PATCH.../5g-vn-groups/{extGroupId} (5GVnGroupConfigurationModification)'. The UDM responds with '2a. 204 No Content', '2b. 404 Not Found', or '2c. 403 Forbidden'. + +**Figure 5.6.2.2.3-1: NF service consumer modifies a 5G VN Group** + +1. The NF service consumer sends a PATCH request to the resource that represents a 5G VN Group. + +If MTC Provider information and/or AF ID are received in the request, the UDM shall check whether the MTC Provider and/or the AF is allowed to perform this operation for the UE; otherwise, the UDM shall skip the MTC provider and/or AF authorization check. + +- 2a. On success, the UDM responds with "204 No Content". +- 2b. If the external group id does not exist in the UDM, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If MTC Provider or AF are not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.6.2.2.4 SoR Information update + +Figure 5.6.2.2.4-1 shows a scenario where the NF service consumer (e.g. SOR-AF) sends updated SoR Information for a UE to the UDM to trigger the sending of this updated SoR Information to the UE via the AMF (as per Annex C.1.1, C.1.2 and C.3 of 3GPP TS 23.122 [20]). The request contains the identifier of the UE's parameter provision data ( .../{ueId}/pp-data), the SUPI in this case, and the modification instructions. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for SoR Information update. The NF service consumer sends a PATCH request to the UDM. The UDM responds with either 204 No Content (success) or 403 Forbidden (failure).](e9b43ac020435f8121e8592f31afdc52_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. PATCH.../{ueId}/pp-data (PpData) + NF service consumer->>UDM: 1. PATCH.../{ueId}/pp-data (PpData) + Note right of UDM: 2a. 204 No Content +2b. 403 Forbidden + UDM-->>NF service consumer: 2a. 204 No Content +2b. 403 Forbidden + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for SoR Information update. The NF service consumer sends a PATCH request to the UDM. The UDM responds with either 204 No Content (success) or 403 Forbidden (failure). + +**Figure 5.6.2.2.4-1: NF service consumer updates SoR Information for a UE** + +1. The NF service consumer (e.g. SOR-AF) sends a PATCH request to the resource that represents a UE's modifiable subscription data, containing updated Steering of Roaming Information (i.e. new list of preferred PLMN/access technology combinations, the SOR-CMCI, SOR-SNPN-SI, SOR-SNPN-SI-LS, if any, and the "Store the SOR-CMCI in the ME" indicator, if any, or a secured packet for a UE). + +The UDM, after contacting the AUSF to perform integrity protection and getting the related information (sorMacIausf and coutersor), shall immediately convey this updated SoR Information to the concerned UE by triggering a notification to the registered AMF (that has subscribed to receive notifications on change of AccessAndMobilitySubscriptionData) for the UE, if any, as per annex C.3 of 3GPP TS 23.122 [20]. Once the subscribing AMF is notified (or when no AMF has subscribed), the UDM shall delete the updated SorInfo and shall not send it as part of AccessAndMobilitySubscriptionData to an NF (e.g. AMF) retrieving the AccessAndMobilitySubscriptionData. + +- 2a. The UDM responds with "204 No Content". +- 2b. If the operation cannot be authorized due to e.g UE isn't registered in the network, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +##### 5.6.2.2.5 Parameter Provisioning Data Entry per AF update + +Figure 5.6.2.2.5-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to update the Parameter Provisioning Data entry for a certain AF, which will influence the UE's subscription data (see + +3GPP TS 23.502 [3] figure 4.15.6.2-1 step 2 and also 3GPP TS 23.273 [38] Figure 6.12.1-1 step 2). The NF consumer shall send a PUT request towards the resource URI of an existing Parameter Provisioning Data entry for the AF (.../{ueId}/pp-data-store/{afInstanceId}) with the new value in the request body. The URI variants ueId and afInstanceId shall take values as specified in Table 6.5.3.4.2-1. + +![Sequence diagram showing the NF service consumer sending a PUT request to the UDM to update a Parameter Provisioning Data Entry per AF. The request is labeled '1. PUT.../{ueId}/pp-data-store/{afInstanceId} (PpDataEntry)'. The UDM responds with '2a. 204 No Content' or '2b. 4xx or 5xx (ProblemDetails)'.](744acfe8d4e31bcf03f95714c2f6e567_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. PUT.../{ueId}/pp-data-store/{afInstanceId} (PpDataEntry) + Note right of UDM: + UDM-->>NF service consumer: 2a. 204 No Content + UDM-->>NF service consumer: 2b. 4xx or 5xx (ProblemDetails) + +``` + +Sequence diagram showing the NF service consumer sending a PUT request to the UDM to update a Parameter Provisioning Data Entry per AF. The request is labeled '1. PUT.../{ueId}/pp-data-store/{afInstanceId} (PpDataEntry)'. The UDM responds with '2a. 204 No Content' or '2b. 4xx or 5xx (ProblemDetails)'. + +**Figure 5.6.2.2.5-1: NF service consumer updates a Parameter Provisioning Data Entry per AF** + +1. The NF service consumer (e.g. NEF) sends a PUT request to the resource that represents an existing Parameter Provisioning Data entry for the AF identified by the afInstanceId. The request body shall contain a PpDataEntry object representing the new value of the resource. + +The UDM shall check whether the AF is allowed to perform this operation for the UE. If MTC Provider information is received in the request, the UDM shall check whether the MTC Provider is allowed to perform this operation for the UE; otherwise, the UDM shall skip the MTC provider authorization check. + +- 2a. The UDM responds with "204 No Content". + +- 2b. If MTC Provider or AF are not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +NOTE: Upon reception of an update or removal of maximum latency, maximum response time or DL Buffering Suggested Packet Count, UDM may need to adjust the value of active time and/or periodic registration timer and/or DL Buffering Suggested Packet Count and the UDM shall notify AMF and/or SMF if the values are updated (see clause 4.15.6.3a of 3GPP TS 23.502 [3]). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body as specified in table 6.5.3.4.3.1-3. + +##### 5.6.2.2.6 5G-MBS-Group modification + +Figure 5.6.2.2.6-1 shows a scenario where the NF service consumer sends a request to the UDM to modify an external group id's group data. The request contains the external group identifier of the group and the modification instructions. + +![Sequence diagram showing the NF service consumer sending a PATCH request to the UDM to modify a 5G-MBS-Group. The request is labeled '1. PATCH.../mbs-group-membership/{extGroupId} (ModificationInstruction)'. The UDM responds with '2a. 204 No Content', '2b. 404 Not Found', or '2c. 403 Forbidden'.](718be1eb075833deb7a3b80729a06264_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. PATCH.../mbs-group-membership/{extGroupId} (ModificationInstruction) + Note right of UDM: + UDM-->>NF service consumer: 2a. 204 No Content + UDM-->>NF service consumer: 2b. 404 Not Found + UDM-->>NF service consumer: 2c. 403 Forbidden + +``` + +Sequence diagram showing the NF service consumer sending a PATCH request to the UDM to modify a 5G-MBS-Group. The request is labeled '1. PATCH.../mbs-group-membership/{extGroupId} (ModificationInstruction)'. The UDM responds with '2a. 204 No Content', '2b. 404 Not Found', or '2c. 403 Forbidden'. + +**Figure 5.6.2.2.6-1: NF service consumer modifies a 5G-MBS-Group** + +1. The NF service consumer sends a PATCH request to the resource that represents a 5G MBS Group. + +If AF ID are received in the request, the UDM shall check whether the AF is allowed to perform this operation for the UE; otherwise, the UDM shall skip the AF authorization check. + +- 2a. On success, the UDM responds with "204 No Content". +- 2b. If the external group id does not exist in the UDM, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If AF are not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body. + +#### 5.6.2.3 Create + +##### 5.6.2.3.1 General + +The following procedures using the Create service operation are supported: + +- 5G-VN-Group creation +- Parameter Provisioning Data Entry per AF creation +- 5G-MBS-Group creation + +##### 5.6.2.3.2 5G-VN-Group creation + +Figure 5.6.2.3.2-1 shows a scenario where the NF service consumer sends a request to the UDM to create a 5G VN Group. The request contains the group's external identifier and the group configuration. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM to create a 5G-VN-Group. The consumer sends a PUT request to /5g-vn-groups/{extGroupId} with a 5GVnGroupConfiguration body. The UDM responds with either a 201 Created or a 403 Forbidden status code.](ca5dc5fde2061d0ca2051ef7840fc842_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note left of NF: + NF->>UDM: 1. PUT.../5g-vn-groups/{extGroupId} (5GVnGroupConfiguration) + Note right of UDM: + UDM-->>NF: 2a. 201 Created + UDM-->>NF: 2b. 403 Forbidden +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM to create a 5G-VN-Group. The consumer sends a PUT request to /5g-vn-groups/{extGroupId} with a 5GVnGroupConfiguration body. The UDM responds with either a 201 Created or a 403 Forbidden status code. + +**Figure 5.6.2.3.2-1: NF service consumer creates a 5G-VN-Group** + +1. The NF service consumer sends a PUT request to the resource .../5g-vn-groups/{extGroupId}, to create a 5G VN Group as present in the message body. + +If MTC Provider information and/or AF ID are received in the request, the UDM shall check whether the MTC Provider and/or the AF is allowed to perform this operation for the UE; otherwise, the UDM shall skip the MTC provider and/or AF authorization check. + +- 2a. On success the UDM responds with "201 Created". +- 2b. If the creation can't be accepted (e.g. MTC Provider or AF are not allowed to perform this operation for the UE), HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +##### 5.6.2.3.3 Parameter Provisioning Data Entry per AF creation + +Figure 5.6.2.3.3-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to create the Parameter Provisioning Data entry for a certain AF, which will influence the UE's subscription data (see + +3GPP TS 23.502 [3] figure 4.15.6.2-1 step 2 and also 3GPP TS 23.273 [38] Figure 6.12.1-1 step 2). The NF consumer shall send a PUT request towards the resource URI of new Parameter Provisioning Data entry for the AF (.../{ueId}/pp-data-store/{afInstanceId}) with the new value in the request body. The URI variants ueId and afInstanceId shall take values as specified in Table 6.5.3.4.2-1. + +![Sequence diagram showing the NF service consumer sending a PUT request to the UDM to create a Parameter Provisioning Data Entry per AF. The request is labeled '1. PUT.../{ueId}/pp-data-store/{afInstanceId} (PpDataEntry)'. The UDM responds with '2a. 201 Created (PpDataEntry)' or '2b. 4xx or 5xx (ProblemDetails)'.](9f9386d5b3d6cbeb1ed104a799320ebf_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. PUT.../{ueId}/pp-data-store/{afInstanceId} (PpDataEntry) + Note right of UDM: + UDM-->>NF service consumer: 2a. 201 Created (PpDataEntry) + UDM-->>NF service consumer: 2b. 4xx or 5xx (ProblemDetails) + +``` + +Sequence diagram showing the NF service consumer sending a PUT request to the UDM to create a Parameter Provisioning Data Entry per AF. The request is labeled '1. PUT.../{ueId}/pp-data-store/{afInstanceId} (PpDataEntry)'. The UDM responds with '2a. 201 Created (PpDataEntry)' or '2b. 4xx or 5xx (ProblemDetails)'. + +**Figure 5.6.2.3.3-1: NF service consumer creates a Parameter Provisioning Data Entry per AF** + +1. The NF service consumer (e.g. NEF) sends a PUT request to the resource that represents the new Parameter Provisioning Data entry for the AF identified by the afInstanceId. The request body shall contain a PpDataEntry object representing the value of the new resource. + +The UDM shall check whether the AF is allowed to perform this operation for the UE. If MTC Provider information is received in the request, the UDM shall check whether the MTC Provider is allowed to perform this operation for the UE; otherwise, the UDM shall skip the MTC provider authorization check. + +The UDM allocates an internal group identifier to the 5G VN Group. The UDM stores the external group identifier and the group configuration received from the NF service consumer together with the allocated internal group identifier (e.g. in UDR). + +- 2a. The UDM responds with "201 Created" and the response body shall contain a PpDataEntry object representing the new created resource. + +- 2b. If MTC Provider or AF are not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +**NOTE:** Upon reception of creation of maximum latency, maximum response time or DL Buffering Suggested Packet Count, UDM may need to adjust the value of active time and/or periodic registration timer and/or DL Buffering Suggested Packet Count and the UDM shall notify AMF and/or SMF if the values are updated (see clause 4.15.6.3a of 3GPP TS 23.502 [3]). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body as specified in table 6.5.3.4.3.1-3. + +##### 5.6.2.3.4 5G-MBS-Group creation + +Figure 5.6.2.3.4-1 shows a scenario where the NF service consumer sends a request to the UDM to create a 5G MBS Group. The request contains the group's external identifier and the group configuration. + +![Sequence diagram showing the NF service consumer sending a PUT request to the UDM to create a 5G-MBS-Group. The request is labeled '1. PUT.../mbs-group-membership/{extGroupId} (MulticastMbsGroupMemb)'. The UDM responds with '2a. 201 Created' or '2b. 403 Forbidden'.](a796a6e439fe5969697f79dc5e124acc_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. PUT.../mbs-group-membership/{extGroupId} (MulticastMbsGroupMemb) + Note right of UDM: + UDM-->>NF service consumer: 2a. 201 Created + UDM-->>NF service consumer: 2b. 403 Forbidden + +``` + +Sequence diagram showing the NF service consumer sending a PUT request to the UDM to create a 5G-MBS-Group. The request is labeled '1. PUT.../mbs-group-membership/{extGroupId} (MulticastMbsGroupMemb)'. The UDM responds with '2a. 201 Created' or '2b. 403 Forbidden'. + +**Figure 5.6.2.3.4-1: NF service consumer creates a 5G-MBS-Group** + +1. The NF service consumer sends a PUT request to the resource `../mbs-group-membership/{extGroupId}`, to create a 5G MBS Group as present in the message body. + +If AF ID are received in the request, the UDM shall check whether the AF is allowed to perform this operation for the UE; otherwise, the UDM shall skip the AF authorization check. + +- 2a. On success the UDM responds with "201 Created". +- 2b. If the creation can't be accepted (e.g. AF are not allowed to perform this operation for the UE), HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +#### 5.6.2.4 Delete + +##### 5.6.2.4.1 General + +The following procedures using the Delete service operation are supported: + +- 5G-VN-Group deletion +- Parameter Provisioning Data Entry per AF deletion +- 5G-MBS-Group deletion + +##### 5.6.2.4.2 5G-VN-Group deletion + +Figure 5.6.2.4.2-1 shows a scenario where the NF service consumer sends a request to the UDM to delete a 5G VN Group. The request contains the group's external identifier. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for deleting a 5G-VN-Group. The consumer sends a DELETE request to the UDM. The UDM responds with one of three possible status codes: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 403 Forbidden.](e4a14961bdc9882e296b25f7ae5f9760_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. DELETE.../5g-vn-groups/{extGroupId} + NF service consumer->>UDM: 1. DELETE.../5g-vn-groups/{extGroupId} + Note right of UDM: 2a. 204 No Content + UDM-->>NF service consumer: 2a. 204 No Content + Note right of UDM: 2b. 404 Not Found + UDM-->>NF service consumer: 2b. 404 Not Found + Note right of UDM: 2c. 403 Forbidden + UDM-->>NF service consumer: 2c. 403 Forbidden +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for deleting a 5G-VN-Group. The consumer sends a DELETE request to the UDM. The UDM responds with one of three possible status codes: 2a. 204 No Content, 2b. 404 Not Found, or 2c. 403 Forbidden. + +**Figure 5.6.2.4.2-1: NF service consumer deletes a 5G-VN-Group** + +1. The NF service consumer sends a DELETE request to the resource `../5g-vn-groups/{extGroupId}`, to delete the 5G VN Group identified by the external group id. + +If MTC Provider information and/or AF ID are received in the request, the UDM shall check whether the MTC Provider and/or the AF is allowed to perform this operation for the UE; otherwise, the UDM shall skip the MTC provider and/or AF authorization check. + +- 2a. On success, the UDM responds with "204 No Content". +- 2b. If the external group id does not exist in the UDM, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If MTC Provider or AF are not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +##### 5.6.2.4.3 Parameter Provisioning Data Entry per AF deletion + +Figure 5.6.2.4.3-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to delete a Parameter Provisioning Data Entry for a certain AF. The NF consumer shall send a DELETE request towards the resource URI of an existing Parameter Provisioning Data entry for the AF (.../{ueId}/pp-data-store/{afInstanceId}). The URI variants ueId and afInstanceId shall take values as specified in Table 6.5.3.4.2-1. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for deleting a Parameter Provisioning Data Entry per AF. The consumer sends a DELETE request to the UDM. The UDM responds with one of three options: 2a. 204 No Content (success), 2b. 404 Not Found (resource not found), or 2c. 4xx or 5xx (ProblemDetails) (error).](a1890b9a9b85f13e67ed59bbad623659_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note left of NF: + NF->>UDM: 1. DELETE .../{ueId}/pp-data-store/{afInstanceId} + Note right of UDM: + UDM-->>NF: 2a. 204 No Content + UDM-->>NF: 2b. 404 Not Found + UDM-->>NF: 2c. 4xx or 5xx (ProblemDetails) +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for deleting a Parameter Provisioning Data Entry per AF. The consumer sends a DELETE request to the UDM. The UDM responds with one of three options: 2a. 204 No Content (success), 2b. 404 Not Found (resource not found), or 2c. 4xx or 5xx (ProblemDetails) (error). + +**Figure 5.6.2.4.3-1: NF service consumer deletes a Parameter Provisioning Data Entry per AF** + +1. The NF service consumer sends a DELETE request to the resource ... /{ueId}/pp-data-store/{afInstanceId}, to delete the Parameter Provisioning Data Entry for the AF identified by afInstanceId. + +The UDM shall check whether the AF is allowed to perform this operation for the UE. If MTC Provider information is received in the request, the UDM shall check whether the MTC Provider is allowed to perform this operation for the UE; otherwise, the UDM shall skip the MTC provider authorization check. + +- 2a. On success, the UDM responds with "204 No Content". +- 2b. If the Parameter Provisioning Data Entry for the AF does not exist in the UDM, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If MTC Provider or AF are not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body as specified in table 6.5.3.4.3.2-3. + +##### 5.6.2.4.4 5G-MBS-Group deletion + +Figure 5.6.2.4.4-1 shows a scenario where the NF service consumer sends a request to the UDM to delete a 5G MBS Group. The request contains the group's external identifier. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for deleting a 5G-MBS-Group. The consumer sends a DELETE request to the UDM. The UDM responds with one of three options: 2a. 204 No Content (success), 2b. 404 Not Found (resource not found), or 2c. 403 Forbidden (forbidden).](ae9b822eaafef535b7a0fbb97a7c713b_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note left of NF: + NF->>UDM: 1. DELETE .../mbs-group-membership/{extGroupId} + Note right of UDM: + UDM-->>NF: 2a. 204 No Content + UDM-->>NF: 2b. 404 Not Found + UDM-->>NF: 2c. 403 Forbidden +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for deleting a 5G-MBS-Group. The consumer sends a DELETE request to the UDM. The UDM responds with one of three options: 2a. 204 No Content (success), 2b. 404 Not Found (resource not found), or 2c. 403 Forbidden (forbidden). + +**Figure 5.6.2.4.4-1: NF service consumer deletes a 5G-MBS-Group** + +1. The NF service consumer sends a DELETE request to the resource .../mbs-group-membership/{extGroupId}, to delete the 5G MBS Group identified by the external group id. + +If AF ID are received in the request, the UDM shall check whether the AF is allowed to perform this operation for the UE; otherwise, the UDM shall skip the AF authorization check. + +- 2a. On success, the UDM responds with "204 No Content". +- 2b. If the external group id does not exist in the UDM, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If AF are not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body. + +#### 5.6.2.5 Get + +##### 5.6.2.5.1 General + +The following procedures using the Get service operation are supported: + +- 5G-VN-Group get +- Parameter Provisioning Data Entry per AF get +- 5G-MBS-Group get + +##### 5.6.2.5.2 5G-VN-Group get + +Figure 5.6.2.5.2-1 shows a scenario where the NF service consumer sends a request to the UDM to get 5G VN Group. The request contains the group's external identifier. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for a 5G-VN-Group GET request.](4b587081b669e7c6695b0e5db5ea7f6d_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDM + Note right of UDM: 2a. 200 OK + Note right of UDM: 2b. 404 Not Found + Note right of UDM: 2c. 403 Forbidden + NF service consumer->>UDM: 1. GET .../5g-vn-groups/{extGroupId} + UDM-->>NF service consumer: 2a. 200 OK + UDM-->>NF service consumer: 2b. 404 Not Found + UDM-->>NF service consumer: 2c. 403 Forbidden +``` + +The diagram illustrates a sequence of interactions between an 'NF service consumer' and a 'UDM'. The consumer sends a 'GET .../5g-vn-groups/{extGroupId}' request (labeled '1.') to the UDM. The UDM responds with one of three possible status codes: '2a. 200 OK', '2b. 404 Not Found', or '2c. 403 Forbidden'. + +Sequence diagram showing the interaction between an NF service consumer and a UDM for a 5G-VN-Group GET request. + +**Figure 5.6.2.5.2-1: NF service consumer gets 5G-VN-Group** + +1. The NF service consumer sends a GET request to the resource .../5g-vn-groups/{extGroupId}, to get the 5G VN Group identified by the external group id. +- 2a. On success, the UDM responds with "200 Ok" with the 5G VN Group Information +- 2b. If the external group id does not exist in the UDM, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the original AF is not allowed to get this information, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +##### 5.6.2.5.3 Parameter Provisioning Data Entry per AF get + +Figure 5.6.2.5.3-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to get a Parameter Provisioning Data Entry for a certain AF. The NF consumer shall send a GET request towards the resource URI of an existing Parameter Provisioning Data entry for the AF (`.../{ueId}/pp-data-store/{afInstanceId}`). The URI variants `ueId` and `afInstanceId` shall take values as specified in Table 6.5.3.4.2-1. + +![Sequence diagram for Figure 5.6.2.5.3-1: NF service consumer gets a Parameter Provisioning Data Entry per AF. The diagram shows a GET request from the NF service consumer to the UDM, and three possible responses: 2a. 200 OK (PpDataEntry), 2b. 404 Not Found, and 2c. 4xx or 5xx (ProblemDetails).](fcbc3c31776721edc98ceb1944ec438f_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note right of UDM: 2a. 200 OK (PpDataEntry) + Note right of UDM: 2b. 404 Not Found + Note right of UDM: 2c. 4xx or 5xx (ProblemDetails) + NF->>UDM: 1. GET .../{ueId}/pp-data-store/{afInstanceId} + UDM-->>NF: 2a. 200 OK (PpDataEntry) + UDM-->>NF: 2b. 404 Not Found + UDM-->>NF: 2c. 4xx or 5xx (ProblemDetails) +``` + +Sequence diagram for Figure 5.6.2.5.3-1: NF service consumer gets a Parameter Provisioning Data Entry per AF. The diagram shows a GET request from the NF service consumer to the UDM, and three possible responses: 2a. 200 OK (PpDataEntry), 2b. 404 Not Found, and 2c. 4xx or 5xx (ProblemDetails). + +**Figure 5.6.2.5.3-1: NF service consumer gets a Parameter Provisioning Data Entry per AF** + +1. The NF service consumer sends a GET request to the resource `.../{ueId}/pp-data-store/{afInstanceId}`, to get the Parameter Provisioning Data Entry for the AF identified by `afInstanceId`. + +The UDM shall check whether the AF is allowed to perform this operation for the UE. If MTC Provider information is received in the request, the UDM shall check whether the MTC Provider is allowed to perform this operation for the UE; otherwise, the UDM shall skip the MTC provider authorization check. + +- 2a. On success, the UDM responds with "200 OK" with the Parameter Provisioning Data Entry for the AF. +- 2b. If the Parameter Provisioning Data Entry for the AF does not exist in the UDM, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If MTC Provider or AF are not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body as specified in table 6.5.3.4.3.3-3. + +##### 5.6.2.5.4 5G-MBS-Group get + +Figure 5.6.2.5.4-1 shows a scenario where the NF service consumer sends a request to the UDM to get 5G MBS Group. The request contains the group's external identifier. + +![Sequence diagram for Figure 5.6.2.5.4-1: NF service consumer gets 5G-MBS-Group. The diagram shows a GET request from the NF service consumer to the UDM, and three possible responses: 2a. 200 OK, 2b. 404 Not Found, and 2c. 403 Forbidden.](dec689324b075952626a86da862b9549_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note right of UDM: 2a. 200 OK + Note right of UDM: 2b. 404 Not Found + Note right of UDM: 2c. 403 Forbidden + NF->>UDM: 1. GET .../mbs-group-membership/{extGroupId} + UDM-->>NF: 2a. 200 OK + UDM-->>NF: 2b. 404 Not Found + UDM-->>NF: 2c. 403 Forbidden +``` + +Sequence diagram for Figure 5.6.2.5.4-1: NF service consumer gets 5G-MBS-Group. The diagram shows a GET request from the NF service consumer to the UDM, and three possible responses: 2a. 200 OK, 2b. 404 Not Found, and 2c. 403 Forbidden. + +**Figure 5.6.2.5.4-1: NF service consumer gets 5G-MBS-Group** + +1. The NF service consumer sends a GET request to the resource `.../mbs-group-membership/{extGroupId}`, to get the 5G MBS Group identified by the external group id. +- 2a. On success, the UDM responds with "200 Ok" with the MBS Group Information + +- 2b. If the external group id does not exist in the UDM, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If the original AF is not allowed to get this information, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +## 5.7 Nudm\_NIDDAuthorization Service + +### 5.7.1 Service Description + +See 3GPP TS 23.501 [2] table 7.2.5-1. + +### 5.7.2 Service Operations + +#### 5.7.2.1 Introduction + +For the Nudm\_NIDDAuthorization service the following service operations are defined: + +- Get +- Notification + +The Nudm\_NIDDAuthorization Service is used by Consumer NFs (NEF) to retrieve the UE's authorization for NIDD Configuration relevant to the consumer NF from the UDM by means of the Get service operation. + +It is also used by the Consumer NFs (NEF) that have previously subscribed, to get notified by means of the Notification service operation when UDM decides to modify the subscribed data. + +#### 5.7.2.2 Get + +##### 5.7.2.2.1 General + +The following procedures using the Get service operation are supported: + +- NIDD Authorization Data Retrieval + +##### 5.7.2.2.2 NIDD Authorization Data Retrieval + +Figure 5.7.2.2.2-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to authorize the NIDD configuration request (see also 3GPP TS 23.502 [3] figure 4.25.3-1 step 4). The request contains the UE's identity (/{ueIdentity}), and information used for NIDD authorization (AuthorizationInfo). + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for requesting a UE's NIDD Authorization Data. The consumer sends a POST request to .../{ueIdentity}/authorize (AuthorizationInfo). The UDM responds with 2a. 200 OK (AuthorizationData), 2b. 404 Not Found, or 2c. 403 Forbidden.](6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. POST .../{ueIdentity}/authorize (AuthorizationInfo) + NF service consumer->>UDM: Request + Note right of UDM: 2a. 200 OK (AuthorizationData) +2b. 404 Not Found +2c. 403 Forbidden + UDM-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for requesting a UE's NIDD Authorization Data. The consumer sends a POST request to .../{ueIdentity}/authorize (AuthorizationInfo). The UDM responds with 2a. 200 OK (AuthorizationData), 2b. 404 Not Found, or 2c. 403 Forbidden. + +**Figure 5.7.2.2.2-1: Requesting a UE's NIDD Authorization Data** + +1. The NF service consumer (e.g. NEF) sends a POST request to invoke "authorize" custom method on the resource representing the UE's subscribed NIDD authorization information. The content of the request shall be an object of "AuthorizationInfo" which shall contain NSSAI, DNN, MTC Provider Information, callback URI. + +If MTC Provider information and/or AF ID are received in the request, the UDM shall check whether the MTC Provider and/or the AF is allowed to perform this operation for the UE; otherwise, the UDM shall skip the MTC provider and/or AF authorization check. + +- 2a. On success, the UDM responds with "200 OK" with the message body containing the single value or list of AuthorizationData (SUPI and GPSI) as relevant for the requesting NF service consumer. +- 2b. If there is no valid AuthorizationData for the UE Identity, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If SNSSAI and/or DNN are not authorized for this UE, or MTC Provider or AF are not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +**Editor's Note: On success if the response exceeds the maximum length of a message segmentation need to be introduced, how this is done is FFS.** + +#### 5.7.2.3 Notification + +##### 5.7.2.3.1 General + +The following procedures using the Notification service operation are supported: + +- NIDD Authorization Data Update Notification + +##### 5.7.2.3.2 NIDD Authorization Data Update Notification + +Figure 5.7.2.3.2-1 shows a scenario where the UDM notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change (see also 3GPP TS 23.502 [3] figure 4.25.6-1 step 1 and 2). The request contains the authUpdateCallbackUri URI as previously received by the UDM during NIDD Authorization Data Retrieval. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM. The UDM sends a POST request to the NF service consumer's authUpdateCallbackUri with a NiddAuthUpdateNotification. The NF service consumer responds with a 204 No Content status.](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +``` + +sequenceDiagram + participant UDM + participant NF as NF service consumer + Note right of UDM: 1. POST {authUpdateCallbackUri} (NiddAuthUpdateNotification) + UDM->>NF: + Note left of NF: 2. 204 No Content + NF-->>UDM: + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM. The UDM sends a POST request to the NF service consumer's authUpdateCallbackUri with a NiddAuthUpdateNotification. The NF service consumer responds with a 204 No Content status. + +**Figure 5.7.2.3.2-1: Requesting a UE's NIDD Authorization Data** + +1. The UDM sends a POST request to the `authUpdateCallbackUri` as provided by the NF service consumer during NIDD Authorization Data Retrieval. +2. The NF service consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +## 5.8 Nudm\_MT Service + +### 5.8.1 Service Description + +See 3GPP TS 23.632 [32]. + +### 5.8.2 Service Operations + +#### 5.8.2.1 Introduction + +For the Nudm\_MT service the following service operations are defined: + +- `ProvideUeInfo` +- `ProvideLocationInfo` + +The Nudm\_MT service is used by the HSS to request the UDM to provide terminating access domain selection information and/or user state and/or 5GSRVCCInfo by means of the `ProvideUeInfo` service operation. + +**Note:** The stage 2 service operations `Nudm_MT_ProvideDomainSelectionInfo`, `Nudm_MT_ProvideUserState` and `Nudm_MT_Provide5GSRVCCInfo` as defined in 3GPP TS 23.632 [32] clause 6.2.3 are all covered by the single stage 3 service operation `ProvideUeInfo`. This allows retrieval of TADS info, user state and/or 5GSRVCCInfo with a single GET request. + +It is also used by the HSS to request the UE's Location Information in 5GC by means of the `ProvideLocationInfo` service operation. + +#### 5.8.2.2 ProvideUeInfo + +##### 5.8.2.2.1 General + +The following procedure using the `ProvideUeInfo` service operation is supported: + +- UE Information Retrieval + +##### 5.8.2.2.2 UE Information Retrieval + +Figure 5.8.2.2.2-1 shows a scenario where the NF service consumer (HSS) retrieves domain selection information and/or user state and/or 5GSRVCCInfo for a UE from the UDM. The request contains the UE's identity (supi). + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for domain selection information. The consumer sends a GET request to the UDM. The UDM responds with either a 200 OK (UeInfo) or a 404 Not Found.](329c96049bb432e9c2cbda4e224a0c9c_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. GET .../{supi}? + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (UeInfo) + UDM-->>NF service consumer: 2b. 404 Not Found + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for domain selection information. The consumer sends a GET request to the UDM. The UDM responds with either a 200 OK (UeInfo) or a 404 Not Found. + +**Figure 5.8.2.2.2-1: NF service consumer requesting domain selection information** + +1. The NF service consumer sends a GET request to the UDM to query the UeInfo. Query parameters indicate that TadsInfo and/or UserState and/or 5GSRVCCInfo is requested. +- 2a. The UDM responds with "200 OK" with the message body containing the requested information. +- 2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and additional error information should be included in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +#### 5.8.2.3 ProvideLocationInfo + +##### 5.8.2.3.1 General + +The following procedure using the ProvideLocationInfo service operation is supported: + +- Network Provided Location Information Request + +##### 5.8.2.3.2 Network Provided Location Information Request + +Figure 5.8.2.3.2-1 shows a scenario where the NF service consumer (HSS) request UE's location information from UDM. The request contains the UE's identity (supi), and requested information (current location, local time zone, RAT type, or serving node identity) + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for location information. The consumer sends a POST request to the UDM. The UDM responds with either a 200 OK (LocationInfoResult) or a 404 Not Found.](6757222e979ee95c44354a897c5cc1c1_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: + NF service consumer->>UDM: 1. POST .../{supi}/loc-info/provide-loc-info (LocationInfoRequest) + Note right of UDM: + UDM-->>NF service consumer: 2a. 200 OK (LocationInfoResult) + UDM-->>NF service consumer: 2b. 404 Not Found + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for location information. The consumer sends a POST request to the UDM. The UDM responds with either a 200 OK (LocationInfoResult) or a 404 Not Found. + +**Figure 5.8.2.3.2-1: NF service consumer requesting domain selection information** + +1. The NF service consumer sends a POST request (custom method: provide-loc-info) to the resource representing UE's location information in 5GC. +- 2a. The UDM responds with "200 OK" with the message body containing the requested information. +- 2b. If there is no valid subscription data for the UE, or the requested information is not available, HTTP status code "404 Not Found" shall be returned and additional error information should be included in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +## 5.9 Nudm\_ServiceSpecificAuthorization Service + +### 5.9.1 Service Description + +See 3GPP TS 23.501 [2] table 7.2.5-1. + +### 5.9.2 Service Operations + +#### 5.9.2.1 Introduction + +For the Nudm\_ServiceSpecificAuthorization service the following service operations are defined: + +- Create +- UpdateNotify +- Remove + +The Nudm\_ServiceSpecificAuthorization Service is used by Consumer NFs (e.g. NEF) to retrieve the UE's authorization for a specific service relevant to the consumer NF from the UDM by means of the Create service operation. + +It is also used by the Consumer NFs (e.g. NEF) that have previously received the service specific authorization result, to get notified by means of the UpdateNotify service operation when the authorization for a specific service is revoked. + +It is also used by the Consumer NFs (NEF) that have previously received the service specific authorization result, to request UDM to remove the UE's authorization for a specific service relevant to the consumer NF in the UDM by means of the Remove service operation. + +#### 5.9.2.2 Create + +##### 5.9.2.2.1 General + +The following procedures using the Create service operation are supported: + +- Service Specific Authorization Data Retrieval + +##### 5.9.2.2.2 Service Specific Authorization Data Retrieval + +Figure 5.9.2.2.2-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to receive the service specific authorization for the service parameters for an individual UE or a group of UEs (see also 3GPP TS 23.502 [3] figure 4.15.6.7a-1). The request contains the UE's identity (/{ueIdentity}), service type, and service parameters (ServiceSpecificAuthorizationInfo) associated with the UE's identity. The response from UDM may contain the authorization result (AuthorizationData). + +![Sequence diagram showing the interaction between an NF service consumer and a UDM for requesting UE authorization data. The consumer sends a POST request to {ueIdentity}/{serviceType}/authorize. The UDM responds with 200 OK, 404 Not Found, or 403 Forbidden.](9252ccfbbe9e34cb108f0060f2b563f1_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDM + Note left of NF service consumer: 1. POST .../{ueIdentity}/{serviceType}/authorize (ServiceSpecificAuthorizationInfo) + NF service consumer->>UDM: Request + Note right of UDM: 2a. 200 OK (ServiceSpecificAuthorizationData) +2b. 404 Not Found +2c. 403 Forbidden + UDM-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDM for requesting UE authorization data. The consumer sends a POST request to {ueIdentity}/{serviceType}/authorize. The UDM responds with 200 OK, 404 Not Found, or 403 Forbidden. + +**Figure 5.9.2.2.2-1: Requesting a UE's Authorization Data for a specific service** + +1. The NF service consumer (e.g. NEF) sends a POST request to invoke "authorize" custom method on the resource representing the subscribed information for service identified by the service type of a UE or a group of UEs. The content of the request shall be an object of "ServiceSpecificAuthorizationInfo" which should contain the callback URI and may contain S-NSSAI, DNN, MTC Provider Information, AF ID. + +If MTC Provider information and/or AF ID are received in the request, the UDM shall check whether the MTC Provider and/or the AF is allowed to perform this operation for the UE; otherwise, the UDM shall skip the MTC provider and/or AF authorization check. + +- 2a. If S-NSSAI, DNN and service type received in the request are allowed or is part of the UE's subscription data or group data (for a request targeting a group), UDM shall respond successfully with "200 OK" HTTP response. The message body shall include the ServiceSpecificAuthorizationData object containing the SUPI of the UE (or the Internal Group Identifier mapped from External Group ID if the request is targeting a group) and the Service Specific Authorization Id. +- 2b. If there is no valid AuthorizationData for the UE Identity or unknown UE Identity, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2c. If S-NSSAI and/or DNN are not authorized for the service type according to the UE's subscription (including group data associated to the UE), or MTC Provider or AF are not allowed to perform this operation for the UE, HTTP status code "403 Forbidden" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.9.2.3 UpdateNotify + +##### 5.9.2.3.1 General + +The following procedures using the UpdateNotify service operation are supported: + +- Service Specific Authorization Data Update Notification + +##### 5.9.2.3.2 Service Specific Authorization Data Update Notification + +Figure 5.9.2.3.2-1 shows a scenario where the UDM notifies the NF service consumer (that has subscribed during Service Specific Authorization Data Retrieval to receive such notification) about authorization revoke or update of subscription data associated to the UE or group of UE (see also 3GPP TS 23.502 [3] figure 4.15.6.7a-2). The request contains the authUpdateCallbackUri URI as previously received by the UDM during Service Specific Authorization Data Retrieval. + +![Sequence diagram for Figure 5.9.2.3.2-1: Update UE's service specific authorization data. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. A solid arrow labeled '1. POST {authUpdateCallbackUri} (AuthUpdateNotification)' points from the UDM to the NF service consumer. A solid arrow labeled '2. 204 No Content' points from the NF service consumer back to the UDM.](8269648391c59363ea61243864a2adf7_img.jpg) + +Sequence diagram for Figure 5.9.2.3.2-1: Update UE's service specific authorization data. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. A solid arrow labeled '1. POST {authUpdateCallbackUri} (AuthUpdateNotification)' points from the UDM to the NF service consumer. A solid arrow labeled '2. 204 No Content' points from the NF service consumer back to the UDM. + +**Figure 5.9.2.3.2-1: Update UE's service specific authorization data** + +1. The UDM sends a POST request to the updNotifyCallbackUri (as provided by the NF service consumer during Service Specific Authorization Result Retrieval) when the UEs subscription data (or group data associated to the UE) is modified so that the authorization of UEs association with the service type (and S-NSSAI, DNN if requested) is changed. When the authorization becomes invalid, the request body may include the cause indicating the reason why the authorization is invalid. The request body may also contain the MTC provider Information and the AF ID. +2. The NF service consumer responds with "204 No Content". + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +#### 5.9.2.3 Remove + +##### 5.9.2.3.1 General + +The following procedures using the Remove service operation are supported: + +- Service Specific Authorization Data Removal. + +##### 5.9.2.3.2 Service Specific Authorization Data Removal + +Figure 5.9.2.3.2-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDM to remove the service specific authorization for the service parameters for an individual UE or a group of UEs (see also 3GPP TS 23.502 [3] clause 4.15.6.7). The request contains the UE's identity (/{ueIdentity}), service type, and service parameters (ServiceSpecificAuthorizationRemoveData). + +![Sequence diagram for Figure 5.9.2.3.2-1: Service Specific Authorization Data Removal. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. A solid arrow labeled '1. POST.../{ueIdentity}/{serviceType}/remove(ServiceSpecificAuthorizationRemoveData)' points from the NF service consumer to the UDM. Two dashed arrows point from the UDM back to the NF service consumer: '2a. 204 No Content' and '2b. 404 Not Found'.](5879500ca01e1a2521654beff6c289a4_img.jpg) + +Sequence diagram for Figure 5.9.2.3.2-1: Service Specific Authorization Data Removal. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDM' on the right. A solid arrow labeled '1. POST.../{ueIdentity}/{serviceType}/remove(ServiceSpecificAuthorizationRemoveData)' points from the NF service consumer to the UDM. Two dashed arrows point from the UDM back to the NF service consumer: '2a. 204 No Content' and '2b. 404 Not Found'. + +**Figure 5.9.2.3.2-1: Service Specific Authorization Data Removal** + +1. The NF service consumer (e.g. NEF) sends a POST request to invoke "remove" custom method on the resource representing the UE's subscribed information for service identified by the service type. The content of the request shall be an object of "ServiceSpecificAuthorizationRemoveData" which contains the Service Specific Authorization Id previously received from UDM via Create Operation (see clause 5.9.2.2.2). +- 2a. On success, the UDM shall respond with "204 No Content". +- 2b. If the indicated authorization to be removed cannot be found at UDM, the UDM shall return "404 Not Found" with cause IE set to the application error "AUTHORIZATION\_NOT\_FOUND". + +On other failures, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the response body. + +## 5.10 Nudm\_ReportSMDeliveryStatus Service + +### 5.10.1 Service Description + +See 3GPP TS 23.540 [66]. + +### 5.10.2 Service Operations + +#### 5.10.2.1 Introduction + +For the Nudm\_ReportSMDeliveryStatus service the following service operations are defined: + +- Request + +The Nudm\_ReportSMDeliveryStatus Service is used by Consumer NFs (SMS-GMSC, IP-SM-GW) to report the SM-Delivery Status to UDM by means of the Request service operation. + +#### 5.10.2.2 Request + +##### 5.10.2.2.1 General + +The following procedures using the Request service operation are supported: + +- Report the SM-Delivery Status + +##### 5.10.2.2.2 Report the SM-Delivery Status + +Figure 5.10.2.2.2-1 shows a scenario where the NF service consumer (e.g. SMS-GMSC, IP-SM-GW) sends a request to the UDM to report the SM-Delivery Status (see also 3GPP TS 23.540 [66]). The request contains the UE's identity which shall be an GPSI. + +![Sequence diagram showing the interaction between an NF service consumer and a UDM to report the SM-Delivery Status.](5837d4aa3bb1d08bbebcd757248f5515_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note left of NF: + NF->>UDM: 1. POST.../{ueId}/sm-delivery-status (SmDeliveryStatus) + Note right of UDM: + UDM-->>NF: 2a. 204 No Content + Note right of UDM: + UDM-->>NF: 2b. 4xx/5xx (ProblemDetails) +``` + +The diagram illustrates a sequence of interactions between an 'NF service consumer' and a 'UDM'. The sequence starts with the NF service consumer sending a POST request (labeled '1. POST.../{ueId}/sm-delivery-status (SmDeliveryStatus)') to the UDM. The UDM then responds with either a '204 No Content' (labeled '2a. 204 No Content') or an error status code (labeled '2b. 4xx/5xx (ProblemDetails)'). + +Sequence diagram showing the interaction between an NF service consumer and a UDM to report the SM-Delivery Status. + +**Figure 5.10.2.2.2-1: Report the SM-Delivery Status** + +1. The NF service consumer sends a POST request to the resource representing the SM-Delivery status. +- 2a. On success, "204 No Content" shall be returned. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned. + +## 5.11 Nudm\_UEIdentifier Service + +### 5.11.1 Service Description + +See 3GPP TS 33.503 [64]. + +### 5.11.2 Service Operations + +#### 5.11.2.1 Introduction + +For the Nudm\_UEIdentifier service the following service operations are defined: + +- Deconceal + +The Nudm\_UEIdentifier Service is used by Consumer NF (i.e. the 5G PKMF) to de-conceal the SUCI of the 5G ProSe Remote UE to the SUPI. + +#### 5.11.2.2 Deconceal + +Figure 5.11.2.2-1 shows a scenario where the NF service consumer (i.e., the 5G PKMF) sends a request to the UDM to de-conceal the SUCI of the 5G ProSe Remote UE to the SUPI (see also 3GPP TS 33.503 [64]). + +![Sequence diagram showing the Deconceal SUCI to SUPI operation. The NF service consumer sends a POST request to the UDM, which responds with either a 200 OK or a 4xx/5xx status code.](d6015fcef74bce83d04acd2e17b4fc15_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UDM as UDM + Note left of NF: + NF->>UDM: 1. POST.../deconceal (DeconcealReqData) + Note right of UDM: + UDM-->>NF: 2a. 200 OK (DeconcealRspData) + Note right of UDM: + UDM-->>NF: 2b. 4xx/5xx (ProblemDetails) +``` + +Sequence diagram showing the Deconceal SUCI to SUPI operation. The NF service consumer sends a POST request to the UDM, which responds with either a 200 OK or a 4xx/5xx status code. + +Figure 5.11.2.2-1: Deconceal SUCI to SUPI + +1. The NF service consumer sends a POST request to the resource representing the deconceal custom operation. The request body shall contain the SUCI to be de-concealed. +- 2a. On success, "200 OK" shall be returned. The response body shall contain the SUPI de-concealed from the input SUCI. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned. + +# --- 6 API Definitions + +## 6.1 Nudm\_SubscriberDataManagement Service API + +### 6.1.1 API URI + +The Nudm\_SDM service shall use the Nudm\_SDM API. + +The API URI of the Nudm\_SDM API shall be: + +#### **{apiRoot}
/** + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +#### **{apiRoot}
//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nudm-sdm". +- The shall be "v2". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [13], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nudm\_SDM service shall comply with the OpenAPI [14] specification contained in Annex A2. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 9457 [16]) signalled by the content type "application/problem+json" + +JSON Merge Patch, as defined in IETF RFC 7396 [17], signalled by the content type "application/merge-patch+json" + +##### 6.1.2.2.3 Cache-Control + +As described in IETF RFC 9111 [26] clause 5.2, a "Cache-Control" header should be included in HTTP responses except for non-cacheable resources (e.g. UeContextInSmfData). If it is included, it shall contain a "max-age" value, indicating the amount of time in seconds after which the received response is considered stale. + +The "max-age" value shall be configurable by operator policy. + +##### 6.1.2.2.4 ETag + +As described in IETF RFC 9110 [50] clause 2.32, an "ETag" (entity-tag) header should be included in HTTP responses except for non-cacheable resources (e.g. UeContextInSmfData) to allow an NF Service Consumer performing a conditional request with "If-None-Match" header. If it is included, it shall contain a server-generated strong validator, that allows further matching of this value (included in subsequent client requests) with a given resource representation stored in the server or in a cache. + +##### 6.1.2.2.5 If-None-Match + +As described in IETF RFC 9110 [50] clause 3.2, an NF Service Consumer may issue conditional GET request towards UDM by including an "If-None-Match" header in HTTP requests containing one or several entity tags received in previous responses for the same resource. + +##### 6.1.2.2.6 Last-Modified + +As described in IETF RFC 9110 [50] clause 2.2, a "Last-Modified" header should be included in HTTP responses except for non-cacheable resources (e.g. SorAck) to allow an NF Service Consumer performing a conditional request with "If-Modified-Since" header. + +##### 6.1.2.2.7 If-Modified-Since + +As described in IETF RFC 9110 [50] clause 3.3, an NF Service Consumer may issue conditional GET request towards UDM, by including an "If-Modified-Since" header in HTTP requests. + +##### 6.1.2.2.8 When to Use Entity-Tags and Last-Modified Dates + +Both "ETag" and "Last-Modified" headers should be sent in the same HTTP response as stated in IETF RFC 9110 [50] clause 2.4. + +NOTE: "ETag" is a stronger validator than "Last-Modified" and is preferred. + +If the NF Service Producer included an "ETag" header with the resource then a conditional request for this resource shall be performed with the "If-None-Match" header. + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the Nudm-SDM API. + +{apiRoot}/nudm-sdm/v2 + +![A hierarchical tree diagram showing the structure of {apiRoot}/nudm-sdm/v2. The root branches into /{supi}, /{ueId}, /shared-data, /shared-data-subscriptions, /group-data, and /multiple-identifiers. /{supi} branches into /nssai, /am-data, /smf-select-data, /ue-context-in-amf-data, /ue-context-in-smf-data, /ue-context-in-smf-data, /trace-data, /sm-data, /sms-data, /sms-mng-data, /lcs-subscription-data, /lcs-mo-data, /lcs-bca-data, /v2x-data, /prose-data, /mbs-data, /uc-data, /time-sync-data, /ranging-slpos-data, and /a2x-data. /am-data branches into /sor-ack, /upu-ack, /subscribed-snssais-ack, /cag-ack, /update-sor (dashed box), and /ecr-data. /{ueId} branches into /id-translation-result, /lcs-privacy-data, and /sdm-subscriptions. /sdm-subscriptions branches into /{subscriptionId}. /shared-data branches into /{sharedDataId}. /shared-data-subscriptions branches into /{subscriptionId}. /group-data branches into /group-identifiers.](7fe5741e83bc9702d1b1d7585ddf66bd_img.jpg) + +``` +graph TD; Root["{apiRoot}/nudm-sdm/v2"] --- supi["/{supi}"]; Root --- ueId["/{ueId}"]; Root --- sharedData["/shared-data"]; Root --- sharedDataSubscriptions["/shared-data-subscriptions"]; Root --- groupData["/group-data"]; Root --- multipleIdentifiers["/multiple-identifiers"]; supi --- nssai["/nssai"]; supi --- amData["/am-data"]; supi --- smfSelectData["/smf-select-data"]; supi --- ueContextInAmfData["/ue-context-in-amf-data"]; supi --- ueContextInSmfData1["/ue-context-in-smf-data"]; supi --- ueContextInSmfData2["/ue-context-in-smf-data"]; supi --- traceData["/trace-data"]; supi --- smData["/sm-data"]; supi --- smsData["/sms-data"]; supi --- smsMngData["/sms-mng-data"]; supi --- lcsSubscriptionData["/lcs-subscription-data"]; supi --- lcsMoData["/lcs-mo-data"]; supi --- lcsBcaData["/lcs-bca-data"]; supi --- v2xData["/v2x-data"]; supi --- proseData["/prose-data"]; supi --- mbsData["/mbs-data"]; supi --- ucData["/uc-data"]; supi --- timeSyncData["/time-sync-data"]; supi --- rangingSlposData["/ranging-slpos-data"]; supi --- a2xData["/a2x-data"]; amData --- sorAck["/sor-ack"]; amData --- upuAck["/upu-ack"]; amData --- subscribedSnssaisAck["/subscribed-snssais-ack"]; amData --- cagAck["/cag-ack"]; amData --- updateSor["/update-sor"]; amData --- ecrData["/ecr-data"]; ueId --- idTranslationResult["/id-translation-result"]; ueId --- lcsPrivacyData["/lcs-privacy-data"]; ueId --- sdmSubscriptions["/sdm-subscriptions"]; sdmSubscriptions --- subscriptionId1["/{subscriptionId}"]; sharedData --- sharedDataId["/{sharedDataId}"]; sharedDataSubscriptions --- subscriptionId2["/{subscriptionId}"]; groupData --- groupIdentifiers["/group-identifiers"]; style updateSor stroke-dasharray: 5 5 +``` + +A hierarchical tree diagram showing the structure of {apiRoot}/nudm-sdm/v2. The root branches into /{supi}, /{ueId}, /shared-data, /shared-data-subscriptions, /group-data, and /multiple-identifiers. /{supi} branches into /nssai, /am-data, /smf-select-data, /ue-context-in-amf-data, /ue-context-in-smf-data, /ue-context-in-smf-data, /trace-data, /sm-data, /sms-data, /sms-mng-data, /lcs-subscription-data, /lcs-mo-data, /lcs-bca-data, /v2x-data, /prose-data, /mbs-data, /uc-data, /time-sync-data, /ranging-slpos-data, and /a2x-data. /am-data branches into /sor-ack, /upu-ack, /subscribed-snssais-ack, /cag-ack, /update-sor (dashed box), and /ecr-data. /{ueId} branches into /id-translation-result, /lcs-privacy-data, and /sdm-subscriptions. /sdm-subscriptions branches into /{subscriptionId}. /shared-data branches into /{sharedDataId}. /shared-data-subscriptions branches into /{subscriptionId}. /group-data branches into /group-identifiers. + +###### **Figure 6.1.3.1-1: Resource URI structure of the Nudm-SDM API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +###### **Table 6.1.3.1-1: Resources and methods overview** + +| Resource name
(Archetype) | Resource URI | HTTP
method
or
custom
operation | Description | +|------------------------------------------------------|---------------------------------------------|---------------------------------------------|-----------------------------------------------------------------------------| +| Supi
(Document) | //{supi} | GET | Retrieve multiple data sets from UE's subscription data | +| Nssai
(Document) | //{supi}/nssai | GET | Retrieve the UE's subscribed Network Slice Selection Assistance Information | +| UeContextInAmfData
(Document) | //{supi}/ue-context-in-amf-data | GET | Retrieve the UE's Context in AMF Data | +| AccessAndMobilitySubscription Data
(Document) | //{supi}/am-data | GET | Retrieve the UE's subscribed Access and Mobility Data | +| | //{supi}/am-data/update-sor | update-sor
(POST) | Trigger the update of Steering of Roaming Information at the UE | +| SorAck
(Document) | //{supi}/am-data/sor-ack | PUT | Providing acknowledgement of Steering of Roaming | +| UpuAck
(Document) | //{supi}/am-data/upu-ack | PUT | Providing acknowledgement of UE parameters update | +| CagAck
(Document) | //{supi}/am-data/cag-ack | PUT | Providing acknowledgement of UE CAG configuration update | +| EnhancedCoverageRestriction Data | //{supi}/am-data/ecr-data | GET | Retrieve the UE's subscribed Enhance Coverage Restriction Data | +| SmfSelectionSubscriptionData
(Document) | //{supi}/smf-select-data | GET | Retrieve the UE's subscribed SMF Selection Data | +| UeContextInSmfData
(Document) | //{supi}/ue-context-in-smf-data | GET | Retrieve the UE's Context in SMF Data | +| SessionManagementSubscription Data
(Document) | //{supi}/sm-data | GET | Retrieve the UE's session management subscription data | +| SMSSubscriptionData
(Document) | //{supi}/sms-data | GET | Retrieve the UE's SMS subscription data | +| SMSManagementSubscription Data
(Document) | //{supi}/sms-mng-data | GET | Retrieve the UE's SMS management subscription data | +| LcsPrivacySubscriptionData
(Document) | //{ueId}/lcs-privacy-data | GET | Retrieve the UE's LCS privacy subscription data | +| LcsSubscriptionData
(Document) | //{supi}/lcs-subscription-data | GET | Retrieve the UE's LCS subscription data | +| LcsMobileOriginatedSubscriptionData
(Document) | //{supi}/lcs-mo-data | GET | Retrieve the UE's LCS Mobile Originated subscription data | +| LcsBroadcastAssistanceSubscriptionData
(Document) | //{supi}/lcs-bca-data | GET | Retrieve the UE's LCS Broadcast Assistance subscription data | +| ProseSubscriptionData
(Document) | //{supi}/prose-data | GET | Retrieve the UE's ProSe subscription data | +| V2xSubscriptionData
(Document) | //{supi}/v2x-data | GET | Retrieve the UE's V2X subscription data | +| MbsSubscriptionData
(Document) | //{supi}/mbs-data | GET | Retrieve the UE's 5MBS subscription data | +| UcSubscriptionData
(Document) | //{supi}/uc-data | GET | Retrieve the UE's User Consent subscription data | +| SdmSubscriptions
(Collection) | //{ueId}/sdm-subscriptions | POST | Create a subscription | +| Individual subscription
(Document) | //{ueId}/sdm-subscriptions/{subscriptionId} | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the sdm-subscription identified by {subscriptionId} | +| IdTranslationResult
(Document) | //{ueId}/id-translation-result | GET | Retrieve a UE's SUPI or GPSI | +| UeContextInSmsfData
(Document) | //{supi}/ue-context-in-smsf-data | GET | Retrieve the UE's Context in SMSF Data | +| TraceData
(Document) | //{supi}/trace-data | GET | Retrieve Trace Configuration Data | + +| | | | | +|----------------------------------------------|---------------------------------------------|--------|------------------------------------------------------------------------------------| +| SharedData (Collection) | /shared-data | GET | Retrieve shared data | +| IndividualSharedData (Document) | /shared-data/{sharedDataId} | GET | Retrieve the individual Shared Data | +| SharedDataSubscriptions (Collection) | /shared-data-subscriptions | POST | Create a subscription | +| SharedDataIndividual subscription (Document) | /shared-data-subscriptions/{subscriptionId} | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | +| | | PATCH | Modify the shared data subscription identified by {subscriptionId} | +| GroupIdentifiers (Document) | /group-data/group-identifiers | GET | Retrieve group identifiers and the UE identifiers belong to the group identifiers. | +| SNSSAISack (Document) | /{supi}/am-data/subscribed-snsais-ack | PUT | Providing acknowledgement of UE for subscribed S-NSSAIs | +| MultipleIdentifiers (Document) | /multiple-identifiers | GET | Retrieve SUPIs belong to the GPSIs. | +| TimeSyncSubscriptionData (Document) | /{supi}/time-sync-data | GET | Retrieve the UE's Time Synchronization Subscription Data | +| RangingSIPosSubscriptionData (Document) | /{supi}/ranging-spos-data | GET | Retrieve the UE's Ranging and Sidelink Positioning subscription data | +| A2xSubscriptionData (Document) | /{supi}/a2x-data | GET | Retrieve the UE's A2X subscription data | + +#### 6.1.3.2 Resource: Nssai (Document) + +##### 6.1.3.2.1 Description + +This resource represents the subscribed Nssai for a SUPI. It is queried by the AMF before registering, and is used to assist network slice selection. See 5.2.2.2.2 and 3GPP TS 23.501 [2] clause 5.15.3. + +This resource is also queried by the PGW-C+SMF during PDN connection establishment in the EPC, and is used to select the S-NSSAI provided to the UE, see 3GPP TS 23.502 [3] clause 4.11.0a.5. The PGW-C+SMF shall not indicate support to "Nssaa" feature (see clause 6.1.8) in this query to UDM. If a slice is not present in the Nssai resource returned by UDM, i.e. not subscribed by the UE or subject to Network Slice-Specific Authentication and Authorization, the slice shall not be selected by the PGW-C+SMF. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/nssai + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| plmn-id | PlmnId | O | 0..1 | PLMN identity of the PLMN serving the UE | +| disaster-roaming-ind | boolean | O | 0..1 | Disaster Roaming Indicator (see 3GPP TS 23.502 [3]).
When present, this IE shall be set as follows:
- true: Disaster Roaming service is applied;
- false (default): Disaster Roaming service is not applied. | + +If "plmn-id" is included, UDM shall return the Subscribed S-NSSAIs which the UE is subscribed to use in the PLMN identified by "plmn-id". + +If "plmn-id" is not included, UDM shall return the Subscribed S-NSSAIs for HPLMN. + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| Nssai | M | 1 | 200 OK | Upon success, a response body containing the NSSAI shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.1.3.2.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.2.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +#### 6.1.3.3 Resource: SdmSubscriptions (Collection) + +##### 6.1.3.3.1 Description + +This resource is used to represent subscriptions to notifications. + +The UDM will only recognize subscribed DNNs in this resource so for instance, if the SMF receives SessionManagementSubscriptionData for the Wildcard DNN, SMF shall include the wildcard DNN in SdmSubscription. Any request for non-subscribed DNN will be rejected with "404 Not Found". + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm///sdm-subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) or Generic Public Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.8)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7] | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| shared-data-ids | array(SharedDataId) | O | 0..N | Shared Data IDs identifying shared Data that are already available at the NF consumer. An empty array indicates that no shared data are available at the NF consumer. In this case the UDM may include all shared data identified by IDs conveyed in the POST response.
If this query parameter is absent, shared data shall not be conveyed in the POST response. | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-----------------------------------------| +| SdmSubscription | M | 1 | The subscription that is to be created. | + +**Table 6.1.3.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SdmSubscription | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned including the accepted values, e.g. in case of partial success UDM shall return the list of monitors resource Uri successfully subscribed.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. When stateless UDM is deployed, the stateless UDM may use an FQDN identifying the UDM group to which the UDM belongs as the host part of the resource URI. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate one of the following application errors:
- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +NOTE: In the scenario of stateless UDM deployment, it is assumed that stateless UDMs are organized into several UDM groups, and for each UDM group an FQDN can be allocated. + +**Table 6.1.3.3.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-sdm//{ueId}/sdm-subscriptions/{subscriptionId} | + +#### 6.1.3.4 Resource: Individual subscription (Document) + +##### 6.1.3.4.1 Description + +This resource is used to represent an individual subscription to notifications. + +##### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{ueId}/sdm-subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) or Generic Public Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.8) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7] | +| subscriptionId | string | The subscriptionId identifies an individual subscription to notifications. | + +##### 6.1.3.4.3 Resource Standard Methods + +###### 6.1.3.4.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1. + +**Table 6.1.3.4.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.1.3.4.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +###### 6.1.3.4.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.1.3.4.3.2-1. + +**Table 6.1.3.4.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.4.3.2-2 and the response data structures and response codes specified in table 6.1.3.4.3.2-3. + +**Table 6.1.3.4.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|------------------------------| +| SdmSubsModification | M | 1 | The modification Instruction | + +**Table 6.1.3.4.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|----------|--------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SdmSubscription | C | 0..1 | 200 OK | Upon partial success, if any of the requested modifications have not been accepted, but the server has set different values than those requested by the client, in any of the attributes of the resource, the modified SdmSubscription shall be returned including the accepted values, e.g. UDM shall return the list of monitored resource Uri successfully subscribed and/or the confirmed expiry time.
Also, upon partial success, if the NF service consumer does not support the "PatchReport" feature, the UDM shall return an SdmSubscription object in the response.
(NOTE 2) | +| PatchResult | C | 0..1 | 200 OK | Upon partial success, if the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature, and in case some of the requested modifications are discarded while the rest of the modification instructions are fully accepted, UDM may return the execution report instead of the whole SdmSubscription. (NOTE 2) | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. +NOTE 2: One of SdmSubscription or PatchResult shall be returned. + +#### 6.1.3.5 Resource: AccessAndMobilitySubscriptionData (Document) + +##### 6.1.3.5.1 Description + +This resource represents the subscribed Access and Mobility Data for a SUPI. It is queried by the AMF after registering. + +##### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm///am-data + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.5.3 Resource Standard Methods + +###### 6.1.3.5.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.5.3.1-1. + +**Table 6.1.3.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------------|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| plmn-id | PlmnIdNid | O | 0..1 | PLMN identity of the PLMN serving the UE | +| adjacent-plmns | array(PlmnId) | O | 1..N | PLMN identities of PLMNs adjacent to the PLMN serving the UE. If present the GET response may contain adjacentPlmnRestrictions for the indicated PLMNs. | +| disaster-roaming-ind | boolean | O | 0..1 | Disaster Roaming Indicator (see 3GPP TS 23.502 [3]). When present, this IE shall be set as follows:
- true: Disaster Roaming service is applied;
- false (default): Disaster Roaming service is not applied. | +| shared-data-ids | array(SharedDataId) | O | 0..N | Shared Data IDs identifying shared AccessAndMobilitySubscriptionData that are already available at the NF consumer. An empty array indicates that no shared data are available at the NF consumer. In this case the UDM may include all shared data identified by IDs conveyed in the GET response.
If this query parameter is absent, shared data shall not be conveyed in the GET response. | + +If "plmn-id" is included, UDM shall return the Access and Mobility Data for the SUPI associated to the PLMN or SNPN identified by "plmn-id". + +If "plmn-id" is not included, UDM shall return the Access and Mobility Data for the SUPI associated to the HPLMN. + +This method shall support the request data structures specified in table 6.1.3.5.3.1-2 and the response data structures and response codes specified in table 6.1.3.5.3.1-3. + +**Table 6.1.3.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| AccessAndMobilitySubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the Access and Mobility Subscription Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- REAUTHENTICATION_REQUIRED | + +NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.1.3.5.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.5.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +##### 6.1.3.5.4 Resource Custom Operations + +###### 6.1.3.5.4.1 Overview + +**Table 6.1.3.5.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------------|--------------------|-----------------------------------------------------------------| +| update-sor | /{supi}/am-data/update-sor | POST | Trigger the update of Steering of Roaming information at the UE | + +###### 6.1.3.5.4.2 Operation: update-sor + +###### 6.1.3.5.4.2.1 Description + +When a UE performs initial registration or emergency registration at an AMF (which already has AccessAndMobilitySubscriptionData stored) within a VPLMN, and the sorUpdateIndicatorList is present in AccessAndMobilitySubscriptionData and contains the corresponding registration type, the AMF shall make use of this operation to trigger the HPLMN to update steering of roaming information for the UE. + +###### 6.1.3.5.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.5.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.5.4.2.2-2. + +**Table 6.1.3.5.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|------------------------------| +| SorUpdateInfo | M | 1 | Contains the ID of the VPLMN | + +**Table 6.1.3.5.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| SorInfo | M | 1 | 200 OK | Upon success, a response body containing the updated Steering Of Roaming information shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +#### 6.1.3.6 Resource: SmfSelectionSubscriptionData (Document) + +##### 6.1.3.6.1 Description + +This resource represents the subscribed SMF Selection Data for a SUPI. It is queried by the AMF after registering. + +##### 6.1.3.6.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/smf-select-data + +This resource shall support the resource URI variables defined in table 6.1.3.6.2-1. + +**Table 6.1.3.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.6.3 Resource Standard Methods + +###### 6.1.3.6.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.6.3.1-1. + +**Table 6.1.3.6.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| plmn-id | PlmnId | O | 0..1 | PLMN identity of the PLMN serving the UE | +| disaster-roaming-ind | boolean | O | 0..1 | Disaster Roaming Indicator (see 3GPP TS 23.502 [3]).
When present, this IE shall be set as follows:
- true: Disaster Roaming service is applied;
- false (default): Disaster Roaming service is not applied. | + +If "plmn-id" is included, UDM shall return the SMF Selection Subscription Data for the SUPI associated to the PLMN identified by "plmn-id". + +If "plmn-id" is not included, UDM shall return the SMF Selection Subscription Data for the SUPI associated to the HPLMN. + +This method shall support the request data structures specified in table 6.1.3.6.3.1-2 and the response data structures and response codes specified in table 6.1.3.6.3.1-3. + +**Table 6.1.3.6.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.6.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| SmfSelectionSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the SMF Selection Subscription Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.1.3.6.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.6.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +#### 6.1.3.7 Resource: UeContextInSmfData (Document) + +##### 6.1.3.7.1 Description + +This resource represents the allocated SMFs for a SUPI. It is queried by the AMF after registering. + +##### 6.1.3.7.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm/{apiVersion}/{supi}/ue-context-in-smf-data + +This resource shall support the resource URI variables defined in table 6.1.3.7.2-1. + +**Table 6.1.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.7.3 Resource Standard Methods + +###### 6.1.3.7.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.7.3.1-1. + +**Table 6.1.3.7.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.7.3.1-2 and the response data structures and response codes specified in table 6.1.3.7.3.1-3. + +**Table 6.1.3.7.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.7.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| UeContextInSmfData | M | 1 | 200 OK | Upon success, a response body containing the UeContextInSmfData shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.8 Resource: SessionManagementSubscriptionData (Document) + +##### 6.1.3.8.1 Description + +This resource represents the Session Management subscription data for a SUPI. It is queried by the SMF during session setup, using query parameters representing the selected network slice and the DNN. The SMF is responsible for enforcing the user session management subscription data. + +UDM will only recognize subscribed DNNs in this resource so for instance, in case SMF receives indication from AMF that the DNN was authorized based on the wildcard APN in the Selection Mode Value, SMF shall include the wildcard DNN in the query parameter and SMF will receive SessionManagementSubscriptionData for the Wildcard DNN. Any request for non-subscribed DNN will be rejected with "404 Not Found". + +This resource is also queried by the PGW-C+SMF during PDN connection establishment in the EPC, to select the S-NSSAI for the APN/DNN of the PDN connection, see 3GPP TS 23.502 [3] clause 4.11.0a.5. + +NOTE : The PGW-C+SMF shall also retrieve the Nssai resource from UDM, to avoid selection a slice that is subject to Network Slice-Specific Authentication and Authorization (see clause 6.1.3.2.1). + +##### 6.1.3.8.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm/{apiVersion}/{supi}/sm-data + +This resource shall support the resource URI variables defined in table 6.1.3.8.2-1. + +**Table 6.1.3.8.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.8.3 Resource Standard Methods + +##### 6.1.3.8.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.8.3.1-1. + +**Table 6.1.3.8.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| single-nssai | Snssai | O | 0..1 | When present without Slice Differentiator (sd), all slices identified by the given Slice/Service Type (sst) and any sd value (if any) shall be considered matching the query parameter. When present with the reserved sd value of FFFFFFF (see 3GPP TS 23.003 [8] clause 28.4.2) only the slice identified by the given sst value and absent sd value shall be considered matching the query parameter. | +| dnn | Dnn | O | 0..1 | The DNN shall be the DNN Network Identifier only. | +| plmn-id | PlmnId | O | 0..1 | PLMN identity of the PLMN serving the UE | +| disaster-roaming-ind | boolean | O | 0..1 | Disaster Roaming Indicator (see 3GPP TS 23.502 [3]).
When present, this IE shall be set as follows:
- true: Disaster Roaming service is applied;
- false (default): Disaster Roaming service is not applied. | + +JSON objects (such as Snssai, PlmnId...) shall be included directly as part of the URI query parameters by specifying in the OpenAPI file that the "Content-Type" of such parameters is "application/json". + +If "single-nssai" is not included, and "dnn" is not included, UDM shall return all DNN configurations for all network slice(s). + +If "single-nssai" is included, and "dnn" is not included, UDM shall return all DNN configurations for the requested network slice identified by "singleNssai". + +If "single-nssai" is not included, and "dnn" is included, UDM shall return all DNN configurations identified by "dnn" for all network slices where such DNN is available. + +If "single-nssai" is included, and "dnn" is included, UDM shall return the DNN configuration identified by "dnn", if such DNN is available in the network slice identified by "singleNssai". + +For all the combinations about the inclusion of "dnn" and "singleNssai" as URI query parameters, if "plmn-id" is included, UDM shall return the configurations for the DNN and network slices associated to the PLMN identified by "plmn-id". Otherwise (i.e. if "plmn-id" is not included), UDM shall return the configurations for the DNN and network slices associated to the HPLMN. + +This method shall support the request data structures specified in table 6.1.3.8.3.1-2 and the response data structures and response codes specified in table 6.1.3.8.3.1-3. + +**Table 6.1.3.8.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.8.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| SmSubsData | M | 1 | 200 OK | Upon success, a response body containing the Session Management Subscription data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.1.3.8.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.8.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +#### 6.1.3.9 Resource: SMSSubscriptionData (Document) + +##### 6.1.3.9.1 Description + +This resource represents the subscribed SMS Subscription Data for a SUPI. It is queried by the AMF after registering. + +##### 6.1.3.9.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm/{apiVersion}/{supi}/sms-data + +This resource shall support the resource URI variables defined in table 6.1.3.9.2-1. + +**Table 6.1.3.9.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.9.3 Resource Standard Methods + +##### 6.1.3.9.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.9.3.1-1. + +**Table 6.1.3.9.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------| +| plmn-id | PlmnId | C | 0..1 | if absent, H-PLMN ID is used as default | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.9.3.1-2 and the response data structures and response codes specified in table 6.1.3.9.3.1-3. + +**Table 6.1.3.9.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.9.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| SmsSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the SMS Subscription Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.1.3.9.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.9.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +#### 6.1.3.10 Resource: SMSManagementSubscriptionData (Document) + +##### 6.1.3.10.1 Description + +This resource represents the subscribed SMS Management Data for a SUPI. It is queried by the SMSF after registering. + +##### 6.1.3.10.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/sms-mng-data + +This resource shall support the resource URI variables defined in table 6.1.3.10.2-1. + +**Table 6.1.3.10.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.10.3 Resource Standard Methods + +##### 6.1.3.10.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.10.3.1-1. + +**Table 6.1.3.10.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------| +| plmn-id | PlmnId | C | 0..1 | if absent, H-PLMN ID is used as default | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.10.3.1-2 and the response data structures and response codes specified in table 6.1.3.10.3.1-3. + +**Table 6.1.3.10.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.10.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| SmsManagementSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the SMS Management Subscription Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.1.3.10.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.10.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +#### 6.1.3.11 Resource: Supi (Document) + +##### 6.1.3.11.1 Description + +This resource represents the subscription profile of the subscriber identified by a given SUPI. + +##### 6.1.3.11.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi} + +This resource shall support the resource URI variables defined in table 6.1.3.11.2-1. + +**Table 6.1.3.11.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.11.3 Resource Standard Methods + +##### 6.1.3.11.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.11.3.1-1. + +NOTE: The retrieval of these data sets can also be achieved by sending individual GET requests to the corresponding sub-resources under the {supi} resource. When multiple data sets need to be retrieved by the NF Service consumer, it is recommended to use a single GET request with query parameters rather than issuing multiple GET requests. + +**Table 6.1.3.11.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dataset-names | DatasetNames | M | 1 | Contains names of the data sets that are required to retrieve. | +| plmn-id | PlmnIdNid | C | 0..1 | If absent, H-PLMN ID is used as default.
This IE is only used for data sets whose DataSetNames are listed below:
"AM"
"SMF_SEL"
"SMS_SUB"
"SM"
"TRACE"
"SMS_MNG" | +| adjacent-plmns | array(PlmnId) | O | 1..N | PLMN identities of PLMNs adjacent to the PLMN serving the UE. If present the GET response may contain adjacentPlmnRestrictions for the indicated PLMNs.
May be present if Access And Mobility Subscription Data is included in DatasetNames. | +| disaster-roaming-ind | boolean | O | 0..1 | Disaster Roaming Indicator (see 3GPP TS 23.502 [3]).
When present, this IE shall be set as follows:
- true: Disaster Roaming service is applied;
- false (default): Disaster Roaming service is not applied.
May be present if "Access and Mobility Subscription Data" or "SMF Selection Subscription Data" or "Session Management Subscription Data" is included in DatasetNames. | +| single-nssai | Snssai | O | 0..1 | When present without Slice Differentiator (sd), all slices identified by the given Slice/Service Type (sst) and any sd value (if any) shall be considered matching the query parameter.
When present with the reserved sd value of FFFFFFFF (see 3GPP TS 23.003 [8] clause 28.4.2) only the slice identified by the given sst value and absent sd value shall be considered matching the query parameter.
May be present if Session Management Subscription Data is included in DatasetNames. | +| dnn | Dnn | O | 0..1 | The DNN shall be the DNN Network Identifier only.
May be present if Session Management Subscription Data is included in DatasetNames. | +| uc-purpose | UcPurpose | O | 0..1 | Contains a user consent purpose.
See clause 6.1.6.3.20.
May be present if User Consent Data is included in DatasetNames. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.11.3.1-2 and the response data structures and response codes specified in table 6.1.3.11.3.1-3. + +**Table 6.1.3.11.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.11.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData Sets | M | 1 | 200 OK | Upon success, a response body containing the requested data sets shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 6.1.3.11.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.11.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +#### 6.1.3.12 Resource: IdTranslationResult (Document) + +#### 6.1.3.12.1 Description + +This resource represents the SUPI or GPSI. It is queried by the NEF for GPSI to SUPI translation or SUPI to GPSI translation. See 3GPP TS 23.502 [3] clauses 4.13.2.2, 4.13.7.2 and 4.15.6.8. + +##### 6.1.3.12.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{ueId}/id-translation-result + +This resource shall support the resource URI variables defined in table 6.1.3.12.2-1. + +**Table 6.1.3.12.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeld | Represents the Generic Public Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.8) or Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeld in 3GPP TS 29.571 [7] | + +##### 6.1.3.12.3 Resource Standard Methods + +##### 6.1.3.12.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.12.3.1-1. + +**Table 6.1.3.12.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| af-id | string | O | 0..1 | AF Identifier, see 3GPP TS 23.502 [3] clause 4.13.2.2 and clause 4.13.7.2

If not present, additional authorization on AF indentifier is not required (see 3GPP TS 23.502 [3] clause 4.15.6.8) | +| app-port-id | AppPortId | C | 0..1 | Indicates the Application port identity, see 3GPP TS 23.501 [2] clause 4.4.7 or 3GPP TS 23.502 [3] clause 4.13.7.2.

This attribute shall be present if ueld is a SUPI in Resource URI variables and if the application port identity is available. | +| af-service-id | string | C | 0..1 | Indicates the Application Service Identifier, see 3GPP TS 23.502 [3] clause 4.15.6.

This attribute shall be present if ueid is a SUPI in Resouce URI variables and if the application service identifier is available. | +| mtc-provider-info | MtcProviderInformation | C | 0..1 | Indicates the information of MTC Service Provider and/or MTC Application.

This attribute shall be present if ueid is a SUPI in Resource URI variables and if the MTC provider information is available. | +| requested-gpsi-type | GpsiType | C | 0..1 | Indicates the requested GPSI type, and it may be included when the ueld variable in the resource URI is a SUPI.

If the ueld variable in the resource URI is a GPSI, this parameter should not be included (i.e., in that case, the UDM returns the GPSI type that was not used in ueld, if available). | + +This method shall support the request data structures specified in table 6.1.3.12.3.1-2 and the response data structures and response codes specified in table 6.1.3.12.3.1-3. + +**Table 6.1.3.12.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.12.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| IdTranslationResult | M | 1 | 200 OK | Upon success, a response body containing the SUPI and optionally the MSISDN shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AF_NOT_ALLOWED | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.1.3.12.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.12.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +#### 6.1.3.13 Resource: SorAck (Document) + +#### 6.1.3.13.1 Description + +This resource represents the acknowledgement of the SoR for a SUPI. + +##### 6.1.3.13.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm/{apiVersion}/{supi}/am-data/sor-ack + +This resource shall support the resource URI variables defined in table 6.1.3.13.2-1. + +**Table 6.1.3.13.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.13.3 Resource Standard Methods + +##### 6.1.3.13.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.13.3.1-1. + +**Table 6.1.3.13.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.13.3.1-2 and the response data structures and response codes specified in table 6.1.3.13.3.1-3. + +**Table 6.1.3.13.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|------------------------------------------------| +| AcknowledgeInfo | M | 1 | Contains the SOR-MAC-lue received from the UE. | + +**Table 6.1.3.13.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|----------|--------------------|-----------------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful receiving the SorXmaclue in the Request. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.14 Resource: TraceData (Document) + +##### 6.1.3.14.1 Description + +This resource represents the trace configuration data for a SUPI. It is queried by the AMF and SMF after registering. + +##### 6.1.3.14.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/trace-data + +This resource shall support the resource URI variables defined in table 6.1.3.14.2-1. + +**Table 6.1.3.14.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.14.3 Resource Standard Methods + +##### 6.1.3.14.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.14.3.1-1. + +**Table 6.1.3.14.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|----------|--------------------|------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| plmn-id | PlmnId | O | 0..1 | PLMN identity of the PLMN serving the UE | + +If "plmn-id" is included, UDM shall return the Trace Data for the SUPI associated to the PLMN identified by "plmn-id". + +If "plmn-id" is not included, UDM shall return the Trace Data for the SUPI associated to the HPLMN. + +This method shall support the request data structures specified in table 6.1.3.14.3.1-2 and the response data structures and response codes specified in table 6.1.3.14.3.1-3. + +**Table 6.1.3.14.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|----------|--------------------|--------------------| +| n/a | | | | + +**Table 6.1.3.14.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|----------|--------------------|-----------------------|--------------------------------------------------------------------------------------------------------------------------------| +| TraceDataResponse | M | 1 | 200 OK | Upon success, a response body containing the Trace Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.1.3.14.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|------------------|----------|--------------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.14.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|------------------|----------|--------------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +#### 6.1.3.15 Resource: SharedData (Collection) + +##### 6.1.3.15.1 Description + +This resource represents the collection of data that can be shared by multiple UEs. + +##### 6.1.3.15.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//shared-data + +This resource shall support the resource URI variables defined in table 6.1.3.15.2-1. + +**Table 6.1.3.15.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|------------------|-------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.15.3 Resource Standard Methods + +##### 6.1.3.15.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.15.3.1-1. + +**Table 6.1.3.15.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|---------------------|---|-------------|-----------------------------------| +| shared-data-ids | array(SharedDataId) | M | 1..N | Contains unique items | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.15.3.1-2 and the response data structures and response codes specified in table 6.1.3.15.3.1-3. + +**Table 6.1.3.15.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.15.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| array(SharedData) | M | 0..N | 200 OK | Upon success, a response body containing a list of SharedData shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.1.3.15.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.15.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +#### 6.1.3.16 Resource: SharedDataSubscriptions (Collection) + +##### 6.1.3.16.1 Description + +This resource is used to represent subscriptions to notifications for shared data. + +##### 6.1.3.16.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//shared-data-subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.16.2-1. + +**Table 6.1.3.16.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.16.3 Resource Standard Methods + +##### 6.1.3.16.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.16.3.1-1. + +**Table 6.1.3.16.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.16.3.1-2 and the response data structures and response codes specified in table 6.1.3.16.3.1-3. + +**Table 6.1.3.16.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-----------------------------------------| +| SdmSubscription | M | 1 | The subscription that is to be created. | + +**Table 6.1.3.16.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SdmSubscription | M | 1 | 201
Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. When stateless UDM is deployed, the stateless UDM shall use the FQDN identifying the UDM set to which the UDM belongs as the host part of the resource URI. | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate one of the following application errors:
- UNSUPPORTED_RESOURCE_URI

This response shall not be cached. | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +NOTE: In the scenario of stateless UDM deployment, it is assumed that stateless UDMs are organized into several UDM sets, and each UDM set is allocated an FQDN. + +**Table 6.1.3.16.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-sdm//shared-data-subscriptions/{subscriptionId} | + +#### 6.1.3.17 Resource: Individual subscription (Document) + +##### 6.1.3.17.1 Description + +This resource is used to represent an individual subscription to notifications for shared data. + +##### 6.1.3.17.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//shared-data-subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.17.2-1. + +**Table 6.1.3.17.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| subscriptionId | string | The subscriptionId identifies an individual subscription to notifications. | + +##### 6.1.3.17.3 Resource Standard Methods + +##### 6.1.3.17.3.1 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.17.3.1-1. + +**Table 6.1.3.17.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.17.3.1-2 and the response data structures and response codes specified in table 6.1.3.17.3.1-3. + +**Table 6.1.3.17.3.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.1.3.17.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The resource corresponding to the SubscriptionId can't be found.

The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +##### 6.1.3.17.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.1.3.17.3.2-1. + +**Table 6.1.3.17.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.17.3.2-2 and the response data structures and response codes specified in table 6.1.3.17.3.2-3. + +**Table 6.1.3.17.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|------------------------------| +| SdmSubsModification | M | 1 | The modification Instruction | + +**Table 6.1.3.17.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SdmSubscription | C | 0..1 | 200 OK | Upon partial success, if any of the requested modifications have not been accepted, but the server has set different values than those requested by the client, in any of the attributes of the resource, the modified SdmSubscription shall be returned including the accepted values, e.g. UDM shall return the list of monitored resource Uri successfully subscribed and/or the confirmed expiry time.
Also, upon partial success, if the NF service consumer does not support the "PatchReport" feature, the UDM shall return an SdmSubscription object in the response. (NOTE 2) | +| PatchResult | C | 0..1 | 200 OK | Upon partial success, if the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature, and in case some of the requested modifications are discarded while the rest of the modification instructions are fully accepted, UDM may return the execution report instead of the whole SdmSubscription. (NOTE 2) | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The resource corresponding to the SubscriptionId can't be found.

The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. +NOTE 2: One of SdmSubscription or PatchResult shall be returned. + +#### 6.1.3.18 Resource: UeContextInSmsfData (Document) + +##### 6.1.3.18.1 Description + +This resource represents the allocated SMSFs for a SUPI. + +##### 6.1.3.18.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/ue-context-in-smsf-data + +This resource shall support the resource URI variables defined in table 6.1.3.18.2-1. + +**Table 6.1.3.18.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.18.3 Resource Standard Methods + +##### 6.1.3.18.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.18.3.1-1. + +**Table 6.1.3.18.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.18.3.1-2 and the response data structures and response codes specified in table 6.1.3.18.3.1-3. + +**Table 6.1.3.18.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.18.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| UeContextInSmsfData | M | 1 | 200 OK | Upon success, a response body containing the UeContextInSmsfData shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.19 Resource: UpuAck (Document) + +#### 6.1.3.19.1 Description + +This resource represents the acknowledgement of UE parameters update for a SUPI. + +##### 6.1.3.19.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/am-data/upu-ack + +This resource shall support the resource URI variables defined in table 6.1.3.19.2-1. + +**Table 6.1.3.19.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.19.3 Resource Standard Methods + +##### 6.1.3.19.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.19.3.1-1. + +**Table 6.1.3.19.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.19.3.1-2 and the response data structures and response codes specified in table 6.1.3.19.3.1-3. + +**Table 6.1.3.19.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| AcknowledgeInfo | M | 1 | Contains the UPU-MAC-lue received from the UE and the provisioning time stamp as received within UpuInfo. | + +**Table 6.1.3.19.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful receiving the UpuXmaclue in the Request. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +#### 6.1.3.20 Resource: GroupIdentifiers (Document) + +##### 6.1.3.20.1 Description + +This resource represents the Group Identifiers handled by UDM/UDR. It is queried by the NEF or GMLC for translation between External and Internal Group Identifiers or query the UE identifiers that belong to the provided External or Internal Group Identifier. + +It is also queried by the TSCTSF for the SUPI(s) that belong to the provided External or Internal Group Identifier. + +##### 6.1.3.20.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//group-data/group-identifiers + +This resource shall support the resource URI variables defined in table 6.1.3.20.2-1. + +**Table 6.1.3.20.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.20.3 Resource Standard Methods + +##### 6.1.3.20.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.20.3.1-1. + +**Table 6.1.3.20.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| af-id | string | O | 0..1 | AF Identifier, see 3GPP TS 23.502 [3] clause 4.13.2.2 and clause 4.13.7.2

If not present, additional authorization on AF identifier is not required (see 3GPP TS 23.502 [3] clause 4.15.6.8) | +| ext-group-id | ExtGroupId | C | 0..1 | External Group ID | +| int-group-id | GroupId | C | 0..1 | Internal Group ID | +| ue-id-ind | boolean | C | 0..1 | Indication whether UE identifiers are required or not.

When present, it shall be set as following:
- true: UE identifiers are required
- false (default): UE identifiers are not required | +| NOTE: Either ext-group-id or int-group-id shall be present in the request. | | | | | + +This method shall support the request data structures specified in table 6.1.3.20.3.1-2 and the response data structures and response codes specified in table 6.1.3.20.3.1-3. + +**Table 6.1.3.20.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.20.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| GroupIdIdentifiers | M | 1 | 200 OK | Upon success, a response body containing the group identifier(s) shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- GROUP_IDENTIFIER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AF_NOT_ALLOWED | +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.1.3.20.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.20.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +#### 6.1.3.21 Resource: SnssaisAck (Document) + +##### 6.1.3.21.1 Description + +This resource represents the acknowledgement of UE for subscribed S-NSSAIs update for a SUPI. + +##### 6.1.3.21.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/am-data/subscribed-snssais-ack + +This resource shall support the resource URI variables defined in table 6.1.3.21.2-1. + +**Table 6.1.3.21.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.21.3 Resource Standard Methods + +##### 6.1.3.21.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.21.3.1-1. + +**Table 6.1.3.21.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.21.3.1-2 and the response data structures and response codes specified in table 6.1.3.21.3.1-3. + +**Table 6.1.3.21.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|--------------------------------------------------------------------| +| AcknowledgeInfo | M | 1 | Contains the provisioning time stamp as received within the Nssai. | + +**Table 6.1.3.21.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful receiving the UE acknowledgement for subscribed S-NSSAIs update. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.22 Resource: CagAck (Document) + +##### 6.1.3.22.1 Description + +This resource represents the acknowledgement of UE for CAG update for a SUPI. + +##### 6.1.3.22.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/am-data/cag-ack + +This resource shall support the resource URI variables defined in table 6.1.3.22.2-1. + +**Table 6.1.3.22.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.22.3 Resource Standard Methods + +##### 6.1.3.22.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.22.3.1-1. + +**Table 6.1.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.22.3.1-2 and the response data structures and response codes specified in table 6.1.3.22.3.1-3. + +**Table 6.1.3.22.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|----------------------------------------------------------------------| +| AcknowledgeInfo | M | 1 | Contains the provisioning time stamp as received within the CagInfo. | + +**Table 6.1.3.22.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful receiving the UE acknowledgement for CAG configuration update. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.23 Resource: LcsPrivacySubscriptionData (Document) + +#### 6.1.3.23.1 Description + +This resource represents the subscribed LCS Privacy Data for a UE. It is queried by the HGMLC or NEF. + +##### 6.1.3.23.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{ueId}/lcs-privacy-data + +This resource shall support the resource URI variables defined in table 6.1.3.23.2-1. + +**Table 6.1.3.23.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------------------------------------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) or Generic Public Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.8)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7]. | +| NOTE: SUPI is only used to retrieve Location Privacy profile by GMLC. | | | + +##### 6.1.3.23.3 Resource Standard Methods + +##### 6.1.3.23.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.23.3.1-1. + +**Table 6.1.3.23.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +UDM shall return the LCS Privacy Data for the UE identified by the ueId. + +This method shall support the request data structures specified in table 6.1.3.23.3.1-2 and the response data structures and response codes specified in table 6.1.3.23.3.1-3. + +**Table 6.1.3.23.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.23.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------| +| LcsPrivacyData | M | 1 | 200 OK | Upon success, a response body containing the LCS Privacy Subscription Data shall be returned (see 3GPP TS 23.273 [38] clause 5.4.2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.24 Resource: LcsMobileOriginatedSubscriptionData (Document) + +##### 6.1.3.24.1 Description + +This resource represents the subscribed LCS Mobile Originated Data for a SUPI. It is queried by the AMF after registering. + +##### 6.1.3.24.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm/{apiVersion}/{supi}/lcs-mo-data + +This resource shall support the resource URI variables defined in table 6.1.3.24.2-1. + +**Table 6.1.3.24.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.24.3 Resource Standard Methods + +##### 6.1.3.24.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.24.3.1-1. + +**Table 6.1.3.24.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +UDM shall return the LCS Mobile Originated Data for the SUPI. + +This method shall support the request data structures specified in table 6.1.3.24.3.1-2 and the response data structures and response codes specified in table 6.1.3.24.3.1-3. + +**Table 6.1.3.24.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.24.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| LcsMoData | M | 1 | 200 OK | Upon success, a response body containing the LCS Mobile Originated Subscription Data shall be returned (see 3GPP TS 23.273 [38] clause 5.4.2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.25 Resource: EnhancedCoverageRestrictionData + +##### 6.1.3.25.1 Description + +This resource represents the subscribed Enhance Coverage Restriction Data for a SUPI. + +##### 6.1.3.25.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm///am-data/ecr-data + +This resource shall support the resource URI variables defined in table 6.1.3.25.2-1. + +**Table 6.1.3.25.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.25.3 Resource Standard Methods + +##### 6.1.3.25.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.25.3.1-1. + +**Table 6.1.3.25.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.25.3.1-2 and the response data structures and response codes specified in table 6.1.3.25.3.1-3. + +**Table 6.1.3.25.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.25.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| EnhancedCoverageRestrictionData | M | 1 | 200 OK | Upon success, a response body containing the Access and Mobility Subscription Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.26 Resource: UeContextInAmfData (Document) + +##### 6.1.3.26.1 Description + +This resource represents the allocated AMF for a SUPI. + +##### 6.1.3.26.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm/{apiVersion}/{supi}/ue-context-in-amf-data + +This resource shall support the resource URI variables defined in table 6.1.3.26.2-1. + +**Table 6.1.3.26.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.26.3 Resource Standard Methods + +##### 6.1.3.26.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.26.3.1-1. + +**Table 6.1.3.26.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.26.3.1-2 and the response data structures and response codes specified in table 6.1.3.26.3.1-3. + +**Table 6.1.3.26.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.26.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| UeContextInAmfData | M | 1 | 200 OK | Upon success, a response body containing the UeContextInAmfData shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.27 Resource: V2xSubscriptionData (Document) + +##### 6.1.3.27.1 Description + +This resource represents the subscribed V2X Data for a SUPI. It is queried by the AMF after registering. + +##### 6.1.3.27.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/v2x-data + +This resource shall support the resource URI variables defined in table 6.1.3.27.2-1. + +**Table 6.1.3.27.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.27.3 Resource Standard Methods + +##### 6.1.3.27.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.27.3.1-1. + +**Table 6.1.3.27.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.27.3.1-2 and the response data structures and response codes specified in table 6.1.3.27.3.1-3. + +**Table 6.1.3.27.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.27.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| V2xSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the V2X Subscription Data shall be returned (see 3GPP TS 23.273 [38] clause 5.4.2) | +| ProblemDetails | O | 1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.28 Resource: LcsBroadcastAssistanceSubscriptionData (Document) + +#### 6.1.3.28.1 Description + +This resource represents the subscribed LCS Broadcast Assistance Data Types for a SUPI. It is queried by the AMF. + +##### 6.1.3.28.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm///lcs-bca-data + +This resource shall support the resource URI variables defined in table 6.1.3.28.2-1. + +**Table 6.1.3.28.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.28.3 Resource Standard Methods + +##### 6.1.3.28.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.28.3.1-1. + +**Table 6.1.3.28.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| plmn-id | PlmnId | O | 0..1 | PLMN identity of the PLMN serving the UE | + +If "plmn-id" is included, the UDM shall return the LCS Broadcast Assistance Data Types for the SUPI associated to the PLMN identified by "plmn-id". + +If "plmn-id" is not included, the UDM shall return the LCS Broadcast Assistance Data Types for the SUPI associated to the HPLMN. + +This method shall support the request data structures specified in table 6.1.3.28.3.1-2 and the response data structures and response codes specified in table 6.1.3.28.3.1-3. + +**Table 6.1.3.28.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.28.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LcsBroadcastAssistanceTypesData | M | 1 | 200 OK | Upon success, a response body containing the list of Broadcast Assistance Data Types Subscription Data shall be returned (see 3GPP TS 23.273 [38] clause 7.1) | +| ProblemDetails | O | 1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.29 Resource: IndividualSharedData (Document) + +##### 6.1.3.29.1 Description + +This resource represents the individual Shared Data. + +##### 6.1.3.29.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//shared-data/{sharedDataId} + +This resource shall support the resource URI variables defined in table 6.1.3.29.2-1. + +**Table 6.1.3.29.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|--------------|-------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| sharedDataId | SharedDataId | Contains the individual Shared Data Identifier. | + +##### 6.1.3.29.3 Resource Standard Methods + +##### 6.1.3.29.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.29.3.1-1. + +**Table 6.1.3.29.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.29.3.1-2 and the response data structures and response codes specified in table 6.1.3.29.3.1-3. + +**Table 6.1.3.29.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.29.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| SharedData | M | 1 | 200 OK | Upon success, a response body containing the individual Shared Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.30 Resource: ProseSubscriptionData (Document) + +##### 6.1.3.30.1 Description + +This resource represents the subscribed ProSe Data for a UE. It is queried by the 5G DDNMF, 5G PKMF, PAnF. + +##### 6.1.3.30.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/prose-data + +This resource shall support the resource URI variables defined in table 6.1.3.30.2-1. + +**Table 6.1.3.30.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.30.3 Resource Standard Methods + +##### 6.1.3.30.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.30.3.1-1. + +**Table 6.1.3.30.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +UDM shall return the ProSe Data for the UE identified by the supi. + +This method shall support the request data structures specified in table 6.1.3.30.3.1-2 and the response data structures and response codes specified in table 6.1.3.30.3.1-3. + +**Table 6.1.3.30.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.30.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| ProseSubscription Data | M | 1 | 200 OK | Upon success, a response body containing the ProSe Subscription Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +#### 6.1.3.31 Resource: MbsSubscriptionData (Document) + +##### 6.1.3.31.1 Description + +This resource represents the subscribed 5MBS Data for a UE as defined in clause 6.4.2 of 3GPP TS 23.247 [59]. It is queried by the SMF. + +##### 6.1.3.31.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/mbs-data + +This resource shall support the resource URI variables defined in table 6.1.3.31.2-1. + +**Table 6.1.3.31.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.31.3 Resource Standard Methods + +##### 6.1.3.31.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.31.3.1-1. + +**Table 6.1.3.31.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +UDM shall return the 5MBS Subscription Data for the UE identified by the supi. + +This method shall support the request data structures specified in table 6.1.3.31.3.1-2 and the response data structures and response codes specified in table 6.1.3.31.3.1-3. + +**Table 6.1.3.31.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.31.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| MbsSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the 5MBS Subscription Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +#### 6.1.3.32 Resource: UcSubscriptionData (Document) + +#### 6.1.3.32.1 Description + +This resource represents the subscribed User Consent Data for a UE as defined in Annex V.2 of 3GPP TS 33.501 [6], clause 5.1.3 of 3GPP TS 33.558 [63] and clause 6.2 of 3GPP TS 23.288 [35]. It is queried by the NWDAF, DCCF, NEF and trusted AF (e.g. EES). + +##### 6.1.3.32.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/uc-data + +This resource shall support the resource URI variables defined in table 6.1.3.32.2-1. + +**Table 6.1.3.32.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.32.3 Resource Standard Methods + +##### 6.1.3.32.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.32.3.1-1. + +**Table 6.1.3.32.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| uc-purpose | UcPurpose | O | 0..1 | Contains a user consent purpose.
See clause 6.1.6.3.20. | + +UDM shall return the User Consent Subscription Data for the UE identified by the supi. + +This method shall support the request data structures specified in table 6.1.3.32.3.1-2 and the response data structures and response codes specified in table 6.1.3.32.3.1-3. + +**Table 6.1.3.32.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.32.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| UcSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the User Consent Subscription Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +#### 6.1.3.33 Resource: MultipleIdentifiers (Document) + +##### 6.1.3.33.1 Description + +This resource represents the Multiple Identifiers handled by UDM. It is queried by the TSCTSF for translation from list of GPSIs to the list of SUPIs. + +##### 6.1.3.33.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//multiple-identifiers + +This resource shall support the resource URI variables defined in table 6.1.3.33.2-1. + +**Table 6.1.3.33.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.33.3 Resource Standard Methods + +##### 6.1.3.33.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.33.3.1-1. + +**Table 6.1.3.33.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| gpsi-list | array(Gpsi) | M | 1..N | List of GPSIs. | + +This method shall support the request data structures specified in table 6.1.3.33.3.1-2 and the response data structures and response codes specified in table 6.1.3.33.3.1-3. + +**Table 6.1.3.33.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.33.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| UeIdentifiers | M | 1 | 200 OK | Upon success, a response body containing the list of UE identifier(s) shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | + +NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.1.3.33.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.33.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +#### 6.1.3.34 Resource: TimeSyncSubscriptionData (Document) + +##### 6.1.3.34.1 Description + +This resource represents the subscribed Time Synchronization Subscription Data for a UE. It is queried by the TSCTSF. + +##### 6.1.3.34.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/time-sync-data + +This resource shall support the resource URI variables defined in table 6.1.3.34.2-1. + +**Table 6.1.3.34.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.35.3 Resource Standard Methods + +##### 6.1.3.35.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.35.3.1-1. + +**Table 6.1.3.35.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.35.3.1-2 and the response data structures and response codes specified in table 6.1.3.35.3.1-3. + +**Table 6.1.3.35.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.35.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| TimeSyncSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the Time Synchronization Subscription Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.1.3.35.3.1-4: Headers supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-None-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.2 | +| If-Modified-Since | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.3 | + +**Table 6.1.3.35.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------| +| Cache-Control | string | O | 0..1 | Cache-Control containing max-age, as described in IETF RFC 9111 [26], clause 5.2 | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3 | +| Last-Modified | string | O | 0..1 | Timestamp for last modification of the resource, as described in IETF RFC 9110 [50], clause 2.2 | + +#### 6.1.3.36 Resource: LcsSubscriptionData (Document) + +##### 6.1.3.36.1 Description + +This resource represents the LCS Subscription Data for a SUPI. It is queried by the AMF after registering. + +##### 6.1.3.36.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm/{apiVersion}/{supi}/lcs-subscription-data + +This resource shall support the resource URI variables defined in table 6.1.3.36.2-1. + +**Table 6.1.3.36.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.36.3 Resource Standard Methods + +##### 6.1.3.36.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.36.3.1-1. + +**Table 6.1.3.36.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +UDM shall return the LCS Subscription Data for the SUPI. + +This method shall support the request data structures specified in table 6.1.3.36.3.1-2 and the response data structures and response codes specified in table 6.1.3.36.3.1-3. + +**Table 6.1.3.36.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.36.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| LcsSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the LCS Subscription Data shall be returned (see 3GPP TS 23.273 [38] clause 7.1) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.37 Resource: RangingSIPosSubscriptionData (Document) + +##### 6.1.3.37.1 Description + +This resource represents the subscribed Ranging and Sidelink Positioning Data for a UE. It is queried by the AMF and SLPKMF. + +##### 6.1.3.37.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/ranging-slpos-data + +This resource shall support the resource URI variables defined in table 6.1.3.37.2-1. + +**Table 6.1.3.37.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.37.3 Resource Standard Methods + +##### 6.1.3.37.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.37.3.1-1. + +**Table 6.1.3.37.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +UDM shall return the Ranging and Sidelink Positioning Subscription Data for the UE identified by the supi. + +This method shall support the request data structures specified in table 6.1.3.37.3.1-2 and the response data structures and response codes specified in table 6.1.3.37.3.1-3. + +**Table 6.1.3.37.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.37.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| RangingSIPosSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the Ranging and Sidelink Positioning Subscription Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.1.3.38 Resource: A2xSubscriptionData (Document) + +##### 6.1.3.38.1 Description + +This resource represents the subscribed A2X Data for a SUPI. It is queried by the AMF after registering. + +##### 6.1.3.38.2 Resource Definition + +Resource URI: {apiRoot}/nudm-sdm//{supi}/a2x-data + +This resource shall support the resource URI variables defined in table 6.1.3.38.2-1. + +**Table 6.1.3.38.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.1.3.38.3 Resource Standard Methods + +##### 6.1.3.38.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.38.3.1-1. + +**Table 6.1.3.38.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.38.3.1-2 and the response data structures and response codes specified in table 6.1.3.38.3.1-3. + +**Table 6.1.3.38.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.38.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| A2xSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the A2X Subscription Data shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +### 6.1.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nudm\_SubscriberDataManagement Service. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +This clause will specify the use of notifications and corresponding protocol details if required for the specific service. When notifications are supported by the API, it will include a reference to the general description of notifications support over the 5G SBIs specified in 3GPP TS 29.500 [4] / 3GPP TS 29.501 [5]. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|-------------------------------|------------------------------|---------------------------------|---------------------------------| +| Data Change Notification | {callbackReference} | POST | | +| Data Restoration Notification | {dataRestorationCallbackUri} | POST | | + +#### 6.1.5.2 Data Change Notification + +The POST method shall be used for Data Change Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.1.5.2-1. + +**Table 6.1.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.1.5.2-2 and of response data structures and response codes is specified in table 6.1.5.2-3. + +**Table 6.1.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-------------| +| ModificationNotification | M | 1 | | + +**Table 6.1.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of this error. | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.1.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected. | + +#### 6.1.5.3 Data Restoration Notification + +The POST method shall be used to inform the NF Service Consumer about a potential data-loss event occurred at the UDR, and the callback URI may be provided during the creation of an SDM subscription, or dynamically discovered by UDM by querying NRF for a default notification URI. + +Resource URI: {dataRestorationCallbackUri} + +Support of URI query parameters is specified in table 6.1.5.3-1. + +**Table 6.1.5.3-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.1.5.3-2 and of response data structures and response codes is specified in table 6.1.5.3-3. + +**Table 6.1.5.3-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------| +| DataRestorationNotification | M | 1 | Contains identifiers representing those UEs potentially affected by a data-loss event at the UDR. | + +**Table 6.1.5.3-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.1.5.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nudm\_SDM service API. + +###### **Table 6.1.6.1-1: Nudm\_SDM specific Data Types** + +| Data type | Clause defined | Description | +|-----------------------------------|----------------|-----------------------------------------------------------------------------------| +| Nssai | 6.1.6.2.2 | Network Slice Selection Assistance Information | +| SdmSubscription | 6.1.6.2.3 | A subscription to notifications | +| AccessAndMobilitySubscriptionData | 6.1.6.2.4 | Access and Mobility Subscription Data | +| SmfSelectionSubscriptionData | 6.1.6.2.5 | SMF Selection Subscription Data | +| DnnInfo | 6.1.6.2.6 | Data Network Name and associated information (LBO roaming allowed flag) | +| SnssaiInfo | 6.1.6.2.7 | S-NSSAI and associated information (DNN Info) | +| SessionManagementSubscriptionData | 6.1.6.2.8 | User subscribed session management data | +| DnnConfiguration | 6.1.6.2.9 | User subscribed data network configuration | +| PduSessionTypes | 6.1.6.2.11 | Default/allowed session types for a data network | +| ScsModes | 6.1.6.2.12 | Default/allowed SSC modes for a data network | +| SmsSubscriptionData | 6.1.6.2.13 | | +| SmsManagementSubscriptionData | 6.1.6.2.14 | SMS Management Subscription Data | +| SubscriptionDataSets | 6.1.6.2.15 | | +| UeContextInSmfData | 6.1.6.2.16 | UE Context In SMF Data | +| PduSession | 6.1.6.2.17 | | +| IdTranslationResult | 6.1.6.2.18 | SUPI that corresponds to a given GPSI | +| ModificationNotification | 6.1.6.2.21 | | +| IpAddress | 6.1.6.2.22 | IP address (IPv4, or IPv6, or IPv6 prefix) | +| UeContextInSmfData | 6.1.6.2.23 | | +| SmsfInfo | 6.1.6.2.24 | | +| AcknowledgeInfo | 6.1.6.2.25 | | +| SorInfo | 6.1.6.2.26 | Steering Of Roaming Information | +| SharedData | 6.1.6.2.27 | Subscription Data shared by multiple UEs | +| PgwInfo | 6.1.6.2.28 | Information about the DNNs/APNs and PGW-C+SMF FQDNs used in interworking with EPS | +| TraceDataResponse | 6.1.6.2.29 | Contains Trace Data or a shared data Id identifying shared Trace Data | +| SteeringContainer | 6.1.6.2.30 | | +| SdmSubsModification | 6.1.6.2.31 | Modification instruction for a subscription to notifications | +| EmergencyInfo | 6.1.6.2.32 | Information about emergency session | +| Upulnfo | 6.1.6.2.33 | UE Parameters Update Information | +| GroupIdIdentifiers | 6.1.6.2.34 | | +| NiddInformation | 6.1.6.2.35 | Non-IP Data Delivery information | +| CagData | 6.1.6.2.36 | | +| CagInfo | 6.1.6.2.37 | | +| DataSetName | 6.1.6.3.3 | | +| PduSessionContinuityInd | 6.1.6.3.7 | | +| AdditionalSnssaiData | 6.1.6.2.38 | Additional information specific to a slice | +| VnGroupData | 6.1.6.2.39 | | +| AppDescriptor | 6.1.6.2.40 | | +| AppPortId | 6.1.6.2.41 | Application Port Id | +| LcsPrivacyData | 6.1.6.2.42 | | +| Lpi | 6.1.6.2.43 | | +| UnrelatedClass | 6.1.6.2.44 | | +| PlmnOperatorClass | 6.1.6.2.45 | | +| ValidTimePeriod | 6.1.6.2.46 | | +| LcsMoData | 6.1.6.2.47 | | +| EcRestrictionDataWb | 6.1.6.2.48 | Enhance Coverage Restriction Data | +| ExpectedUeBehaviourData | 6.1.6.2.49 | Expected UE Behaviour Data | +| SuggestedPacketNumDl | 6.1.6.2.52 | Suggested Number of Downlink Packets | +| FrameRouteInfo | 6.1.6.2.54 | Frame Route Information | +| SorUpdateInfo | 6.1.6.2.55 | | +| EnhancedCoverageRestrictionData | 6.1.6.2.56 | Enhanced Coverage Restriction Data | +| EdrxParameters | 6.1.6.2.57 | eDRX Parameters | +| PtwParameters | 6.1.6.2.58 | Paging Time Window Parameters | +| OperationMode | 6.1.6.3.12 | Operation Mode | +| SorUpdateIndicator | 6.1.6.3.13 | SoR Update Indicator | +| ExternalUnrelatedClass | 6.1.6.2.62 | | +| AfExternal | 6.1.6.2.63 | | +| LcsClientExternal | 6.1.6.2.64 | | +| LcsClientGroupExternal | 6.1.6.2.65 | | +| ServiceTypeUnrelatedClass | 6.1.6.2.66 | | +| Ueld | 6.1.6.2.67 | | + +| | | | +|------------------------------------|-------------|--------------------------------------------------------------------------| +| DefaultUnrelatedClass | 6.1.6.2.68 | | +| ContextInfo | 6.1.6.2.69 | Contains the HTTP Headers received by the NFs | +| UeContextInAmfData | 6.1.6.2.70 | | +| V2xSubscriptionData | 6.1.6.2.71 | V2X Subscription Data | +| LcsBroadcastAssistanceTypesData | 6.1.6.2.72 | LCS Broadcast Assistance Data Types | +| DataSetNames | 6.1.6.2.73 | Data Set Names | +| PlmnRestriction | 6.1.6.2.74 | | +| ProseSubscriptionData | 6.1.6.2.76 | ProSe Subscription Data | +| AerialUeSubscriptionInfo | 6.1.6.2.78 | Aerial UE Subscription Information | +| SmSubsData | 6.1.6.2.79 | | +| ExtendedSmSubsData | 6.1.6.2.80 | | +| AmfInfo | 6.1.6.2.81 | AMF information | +| ProSeAllowedPlmn | 6.1.6.2.82 | Contains the allowed PLMN information for ProSe Service | +| ImmediateReport | 6.1.6.2.83 | UDM SDM Immediate Report | +| MbsSubscriptionData | 6.1.6.2.84 | 5MBS Subscription Data | +| UcSubscriptionData | 6.1.6.2.85 | User Consent Subscription Data | +| UeContextInSmfDataSubFilter | 6.1.6.2.86 | UE Context In Smf Data Subscription Filter | +| UeIdentifiers | 6.1.6.2.87 | List of UE identifiers | +| SupiInfo | 6.1.6.2.88 | List of the SUPIs | +| TimeSyncData | 6.1.6.2.89 | Time Synchronization Data | +| TimeSyncSubscriptionData | 6.1.6.2.90 | | +| AfRequestAuthorization | 6.1.6.2.91 | | +| TimeSyncServiceId | 6.1.6.2.92 | | +| LcsSubscriptionData | 6.1.6.2.93 | LCS Subscription Data | +| ConditionalCagInfo | 6.1.6.2.94 | | +| RangingSIPosSubscriptionData | 6.1.6.2.97 | Ranging/SL positioning Subscription Data | +| RangingSIPosPlmn | 6.1.6.2.98 | Contains the allowed PLMN information for Ranging/SL positioning Service | +| AppSpecificExpectedUeBehaviourData | 6.1.6.2.99 | Application specific UE Behaviour Data | +| ExpectedUeBehaviourThreshold | 6.1.6.2.100 | Expected UE Behaviour Threshold in SdmSubscription | +| A2xSubscriptionData | 6.1.6.2.101 | A2X Subscription Data | +| RangingSIPosQos | 6.1.6.2.102 | Ranging/SL Positioning QoS | +| MbsrOperationAllowed | 6.1.6.2.103 | MBSR Operation Allowed Information | +| DnnLadnServiceAreas | 6.1.6.2.105 | LADN Service Areas for DNNs | +| DnnLadnServiceArea | 6.1.6.2.106 | LADN ServiceArea for a DNN | +| GtpAllowedInfo | 6.1.6.2.107 | AF Authorization Info for gPTP | +| AstiAllowedInfo | 6.1.6.2.108 | AF Authorization Info for ASTI | +| DefaultDnnIndicator | 6.1.6.3.2 | | +| LboRoamingAllowed | 6.1.6.3.2 | | +| UeUsageType | 6.1.6.3.2 | | +| MpsPriorityIndicator | 6.1.6.3.2 | | +| McsPriorityIndicator | 6.1.6.3.2 | | +| 3GppChargingCharacteristics | 6.1.6.3.2 | 3GPP Charging Characteristics | +| MicoAllowed | 6.1.6.3.2 | | +| SmsSubscribed | 6.1.6.3.2 | | +| SharedDataId | 6.1.6.3.2 | | +| IwkEpsInd | 6.1.6.3.2 | Interworking with EPS Indication | +| SecuredPacket | 6.1.6.3.2 | | +| UpuRegInd | 6.1.6.3.2 | | +| ExtGroupId | 6.1.6.3.2 | | +| NbloTUePriority | 6.1.6.3.2 | | +| CodeWord | 6.1.6.3.2 | | +| AfId | 6.1.6.3.2 | | +| LcsClientId | 6.1.6.3.2 | | +| DataSetName | 6.1.6.3.3 | | +| PduSessionContinuityInd | 6.1.6.3.7 | | +| LocationPrivacyInd | 6.1.6.3.8 | | +| PrivacyCheckRelatedAction | 6.1.6.3.9 | | +| LcsClientClass | 6.1.6.3.10 | | +| LcsMoServiceClass | 6.1.6.3.11 | | +| OperationMode | 6.1.6.3.12 | | +| CodeWordInd | 6.1.6.3.14 | | +| MdtUserConsent | 6.1.6.3.15 | MDT User Consent | + +| | | | +|--------------------------------|------------|-------------------------------------------------------------------------------------------------| +| SharedDataTreatmentInstruction | 6.1.6.3.16 | | +| GpsiType | 6.1.6.3.17 | Type of GPSI (MSISDN or External-ID) | +| SorTransparentContainer | 6.1.6.3.2 | | +| AerialUeIndication | 6.1.6.3.18 | Indication on whether Aerial service for UE is allowed or not. | +| UpuTransparentContainer | 6.1.6.3.2 | | +| ProseDirectAllowed | 6.1.6.3.19 | Contains the ProSe Services that can be authorised by the given PLMN identity. | +| UcPurpose | 6.1.6.3.20 | Purpose of the user consent | +| UserConsent | 6.1.6.3.21 | User Consent | +| NsacAdmissionMode | 6.1.6.3.22 | NSAC Admission Mode | +| Prulnd | 6.1.6.3.23 | PRU Indicator | +| AreaUsageInd | 6.1.6.3.24 | Area Usage Indication | +| RangingSIPosAllowed | 6.1.6.3.28 | Contains the Ranging/SL positioning Services that can be authorised by the given PLMN identity. | +| ExpecedUeBehaviourDataset | 6.1.6.3.29 | Expected UE Behaviour Dataset Names | + +Table 6.1.6.1-2 specifies data types re-used by the Nudm\_SDM service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudm\_SDM service API. + +##### **Table 6.1.6.1-2: Nudm\_SDM re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Dnn | 3GPP TS 29.571 [7] | Data Network Name with Network Identifier only; this type is used as key in a map of:
- DnnConfigurations; see clause 6.1.6.2.8;
- EpslwkPgws; see clause 6.2.6.2.2;
- ExpectedUeBehaviourData; see clause 6.1.6.2.8; | +| DurationSec | 3GPP TS 29.571 [7] | Time value in seconds | +| ProblemDetails | 3GPP TS 29.571 [7] | Common data type used in response bodies | +| Snssai | 3GPP TS 29.571 [7] | Single NSSAI | +| Uri | 3GPP TS 29.571 [7] | Uniform Resource Identifier | +| Gpsi | 3GPP TS 29.571 [7] | Generic Public Subscription Identifier | +| RatType | 3GPP TS 29.571 [7] | Radio Access Technology Type | +| Area | 3GPP TS 29.571 [7] | | +| ServiceAreaRestriction | 3GPP TS 29.571 [7] | | +| CoreNetworkType | 3GPP TS 29.571 [7] | | +| SupportedFeatures | 3GPP TS 29.571 [7] | see 3GPP TS 29.500 [4] clause 6.6 | +| PlmnId | 3GPP TS 29.571 [7] | PLMN Identity | +| PduSessionType | 3GPP TS 29.571 [7] | | +| SubscribedDefaultQos | 3GPP TS 29.571 [7] | Subscribed Default QoS | +| Ambr | 3GPP TS 29.571 [7] | | +| AmbrRm | 3GPP TS 29.571 [7] | | +| SliceMbrRm | 3GPP TS 29.571 [7] | | +| PduSessionId | 3GPP TS 29.571 [7] | PduSessionId is used as key in a map of PduSessions; see clause 6.1.6.2.16. | +| NfInstanceId | 3GPP TS 29.571 [7] | | +| Supi | 3GPP TS 29.571 [7] | | +| RfspIndexRm | 3GPP TS 29.571 [7] | | +| SscMode | 3GPP TS 29.571 [7] | | +| Ipv4Addr | 3GPP TS 29.571 [7] | | +| Ipv6Addr | 3GPP TS 29.571 [7] | | +| Ipv6Prefix | 3GPP TS 29.571 [7] | | +| SorMac | 3GPP TS 29.509 [24] | | +| SteeringInfo | 3GPP TS 29.509 [24] | | +| AckInd | 3GPP TS 29.509 [24] | | +| CounterSor | 3GPP TS 29.509 [24] | | +| UpuMac | 3GPP TS 29.509 [24] | | +| UpuData | 3GPP TS 29.509 [24] | | +| UpuAckInd | 3GPP TS 29.509 [24] | | +| CounterUpu | 3GPP TS 29.509 [24] | | +| TraceData | 3GPP TS 29.571 [7] | Trace control and configuration parameters | +| NotifyItem | 3GPP TS 29.571 [7] | | +| UpSecurity | 3GPP TS 29.571 [7] | | +| ServiceName | 3GPP TS 29.510 [19] | | +| OdbPacketServices | 3GPP TS 29.571 [7] | | +| GroupId | 3GPP TS 29.571 [7] | This type is also used as key of a map in attributes:
- vnGroupInfo and sharedVnGroupDataIds; see clause 6.1.6.2.4, 6.1.6.2.8, 6.1.6.2.27; | +| DateTime | 3GPP TS 29.571 [7] | | +| CagId | 3GPP TS 29.571 [7] | | +| StnSr | 3GPP TS 29.571 [7] | Session Transfer Number for SRVCC | +| CMsisdn | 3GPP TS 29.571 [7] | Correlation MSISDN | +| OsId | 3GPP TS 29.519 [33] | | +| Uint16 | 3GPP TS 29.571 [7] | | +| RgWirelineCharacteristics | 3GPP TS 29.571 [7] | | +| GeographicArea | 3GPP TS 29.572 [34] | | +| LcsServiceType | 3GPP TS 29.572 [34] | | +| ScheduledCommunicationTime | 3GPP TS 29.571 [7] | Scheduled Communication Time | +| LocationArea | 6.5.6.2.10 | | +| DataRestorationNotification | 6.2.6.2.25 | Contains identities representing those UEs potentially affected by a data-loss event at the UDR | +| StationaryIndication | 3GPP TS 29.571 [7] | Stationary Indication | +| TrafficProfile | 3GPP TS 29.571 [7] | Traffic Profile | +| ScheduledCommunicationType | 3GPP TS 29.571 [7] | Scheduled Communication Type | + +| | | | +|---------------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------| +| BatteryIndication | 3GPP TS 29.571 [7] | Battery Indication | +| AcslInfo | 3GPP TS 29.571 [7] | ACS Information | +| IPv4AddrMask | 3GPP TS 29.571 [7] | | +| Fqdn | 3GPP TS 29.571 [7] | Fully Qualified Domain Name | +| NefId | 3GPP TS 29.510 [19] | | +| PatchResult | 3GPP TS 29.571 [7] | | +| NrV2xAuth | 3GPP TS 29.571 [7] | | +| LteV2xAuth | 3GPP TS 29.571 [7] | | +| ProseServiceAuth | 3GPP TS 29.571 [7] | | +| BitRate | 3GPP TS 29.571 [7] | | +| MdtConfiguration | 3GPP TS 29.571 [7] | | +| Uint64 | 3GPP TS 29.571 [7] | | +| WirelineArea | 3GPP TS 29.571 [7] | | +| WirelineServiceAreaRestriction | 3GPP TS 29.571 [7] | | +| NfGroupId | 3GPP TS 29.571 [7] | | +| EcsServerAddr | 3GPP TS 29.571 [7] | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of the redirect response message | +| Bytes | 3GPP TS 29.571 [7] | Binary data encoded as a base64 character string | +| SpatialValidityCond | 3GPP TS 29.571 [7] | | +| AccessType | 3GPP TS 29.571 [7] | Access Type | +| NsSrg | 3GPP TS 29.571 [7] | NSSRG value | +| MbsSessionId | 3GPP TS 29.571 [7] | 5MBS Session Id | +| RoamingRestrictions | 3GPP TS 29.571 [7] | Roaming Restrictions related information | +| PlmnIdNid | 3GPP TS 29.571 [7] | | +| UInteger | 3GPP TS 29.571 [7] | Unsigned Integer | +| Tai | 3GPP TS 29.571 [7] | Tracking Area Identity | +| TemporalValidity | 3GPP TS 29.514 [68] | Temporal Validity contains start time and stop time | +| LMFIdentification | 3GPP TS 29.572 [34] | LMF Identification | +| LpHapType | 3GPP TS 29.518 [36] | Low Power and High Accuracy Positioning type | +| RangingSIPosAuth | 3GPP TS 29.571 [7] | | +| ApplicationId | 3GPP TS 29.571 [7] | Application ID | +| ClockQualityAcceptanceCriterion | 3GPP TS 29.571 [7] | Clock Quality Acceptance Criterion | +| ClockQualityDetailLevel | 3GPP TS 29.571 [7] | Clock Quality Detail Level | +| QmcConfigInfo | 3GPP TS 29.571 [7] | Configuration information for signaling-based activation of QMC (Quality of Experience Measurements Collection) | +| NrA2xAuth | 3GPP TS 29.571 [7] | | +| LteA2xAuth | 3GPP TS 29.571 [7] | | +| Accuracy | 3GPP TS 29.572 [34] | Indicates value of accuracy | +| ResponseTime | 3GPP TS 29.572 [34] | Indicates acceptable delay of location request | +| MinorLocationQoS | 3GPP TS 29.572 [34] | Minor Location QoS | +| LcsQoSClass | 3GPP TS 29.572 [34] | Specifies LCS QoS class | +| FlowInfo | 3GPP TS 29.122 [45] | Contains the flow information. | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 + +Type: Nssai + +Table 6.1.6.2.2-1: Definition of type Nssai + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.1.8 | | +| defaultSingleNssais | array(Snssai) | M | 1..N | A list of Single Nssais used as default. (NOTE 1) (NOTE 2) (NOTE 3) (NOTE 4) | | +| singleNssais | array(Snssai) | O | 1..N | List of non default Single Nssais. (NOTE 1) (NOTE 3) | | +| provisioningTime | DateTime | C | 0..1 | This attribute shall be present if the Nssai is sent to the AMF while reception has not yet been acknowledged from the UE; otherwise shall be absent.
This attribute serves as Network Slicing Subscription Change Indication. | | +| additionalSnssaiData | map(AdditionalSnssaiData) | O | 1..N | A map (list of key-value pairs where singleNssai converted to string serves as key) of additional information related to this single Nssai. | Nssaa, Nsac, Nssrg, TempSliceSupport | +| suppressNssrgInd | boolean | O | 0..1 | Indicates whether the AMF shall provide all subscribed S-NSSAIs to the UE not indicating support of subscription-based restrictions to simultaneous registration of network slices, even if these S-NSSAIs do not share a common NSSRG.

true: indicates that the AMF shall provide all subscribed S-NSSAIs to the UE not indicating support of subscription-based restrictions to simultaneous registration of network slices.
false: indicates that the AMF does not need to provide all subscribed S-NSSAIs to the UE not indicating support of subscription-based restrictions to simultaneous registration of network slices. | Nssrg | + +NOTE 1: If the NF consumer does not support Nssaa optional feature, the UDM shall not include S-NSSAI(s) subject to Network Slice-Specific Authentication and Authorization in Get response messages, immediate reports within Subscribe response messages, or data change notifications where the data change is limited to S-NSSAI(s) subject to Network Slice-Specific Authentication and Authorization. + +The total number of subscribed S-NSSAIs (including default S-NSSAIs and non-default S-NSSAIs) shall not exceed 16. +NOTE 2: If NSSRG information is present in the subscription data, the default S-NSSAIs, if more than one is present, are associated with the same NSSRG values as defined in clause 5.15.12 of 3GPP TS 23.501 [2]. + +NOTE 3: If NSSRG information is present, at least one NSSRG shall be associated with each of the S-NSSAIs in the subscription information. + +NOTE 4: If the use case requires the UE to remain reachable at all times with at least one slice, it is recommended that at least one default S-NSSAI is not subject to network slice admission control, to avoid registration rejection in the case of no requested NSSAI was provided or none of the S-NSSAIs in the requested NSSAI was allowed (e.g. due to exceeding the maximum number of UEs configured for that S-NSSAI) as specified in clause 4.2.11.2 of 3GPP TS 23.502 [3]. + +##### 6.1.6.2.3 Type: SdmSubscription + +**Table 6.1.6.2.3-1: Definition of type SdmSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| nfInstanceId | NfInstanceId | M | 1 | Identity of the NF Instance creating the subscription. | | +| implicitUnsubscribe | boolean | O | 0..1 |

If present with value true indicates that the subscription expires when the subscribing NF (AMF, SMF, SMSF) identified by the nfInstanceId ceases to be registered at the UDM.

When the subscribing NF is an SMF, this means that the subscription is terminated by UDM when the last PDU session of such SMF is deregistered for a given SUPI.

If the subscribing NF (AMF, SMF, SMSF) is not registered when the SDM subscription with implicitUnsubscribe indicator set to true is received by the UDM, the UDM should return a confirmed expiry time in the expires attribute to the subscribing NF even when the expires attribute is absent from the request.

See NOTE 1.

| | +| expires | DateTime | C | 0..1 |

If present, indicates the point in time at which the subscription expires. Shall be present if implicitUnsubscribe is absent or false.

Within a POST request the proposed expiry time is conveyed whereas in a POST response or PATCH response the confirmed expiry time is returned.

| | +| callbackReference | Uri | M | 1 | URI provided by the NF service consumer to receive notifications | | +| amfServiceName | ServiceName | O | 0..1 | When present, this IE shall contain the name of the AMF service to which Data Change Notifications are to be sent (see clause 6.5.2.2 of 3GPP TS 29.500 [4]). This IE may be included if the NF service consumer is an AMF. | | +| monitoredResourceUris | array(Uri) | M | 1..N |

A set of URIs that identify the resources for which a change triggers a notification.

The URI shall take the form of either an absolute URI or an absolute-path reference as defined in IETF RFC 3986 [31].

See NOTE 3.

Monitored Resource URIs should not contain query parameters. Instead, attributes within the SdmSubscription (e.g. singleNssai, dnn, plmnId) may be used for filtering. Received query parameters may be ignored by the UDM.

| | +| singleNssai | Snsai | O | 0..1 |

This IE may be present if the consumer is SMF.

This attribute shall be also used as filter for the Nudr notifications when sdmSubscription is included in subscriptionDataSubscription in Nudr POST operation.

See NOTE 2.

| | +| dnn | Dnn | O | 0..1 |

This IE may be present if the consumer is SMF.

This attribute shall be also used as filter for the Nudr notifications when sdmSubscription is included in subscriptionDataSubscription in Nudr POST operation.

When present, this IE shall contain the Network Identifier only, or Wildcard DNN.

See NOTE 2.

| | +| subscriptionId | string | C | 0..1 | This attribute shall be present if the SdmSubscription is sent in a GET response message on Nudr. It identifies the individual sdmSubscription stored in the UDR and may be used by the UDM to delete an expired or implicitly unsubscribed sdmSubscription. | | + +| | | | | | | +|-----------------------|-----------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| plmnId | PlmnId | C | 0..1 |

If present, it indicates the PLMN of the NF Instance creating the subscription (i.e., the PLMN serving the UE).

It shall be present if the NF Instance is located in a different PLMN than the UDM.

If absent, the Home PLMN ID is used as default.

| | +| immediateReport | boolean | O | 0..1 |

This IE indicates whether immediate report is needed or not.

When present, this IE shall be set as following:
- true: immediate report is required
- false (default) immediate report is not required

| ImmediateReport | +| report | ImmediateReport | C | 0..1 |

This IE shall be present in Subscribe response, if the immediateReport attribute is set to "true" in Subscribe request.

When present, this IE shall contain the representation of subscription data sets that to be monitored, i.e. listed in monitoredResourceUris attribute.

| ImmediateReport | +| supportedFeatures | SupportedFeatures | O | 0..1 |

See clause 6.1.8

These are the features supported by the NF subscribing at the UDM.

| | +| contextInfo | ContextInfo | C | 0..1 |

This IE if present may contain e.g. the headers received by the UDM along with the SdmSubscription.

Shall be absent on Nudm and may be present on Nudr.

| | +| nfChangeFilter | boolean | O | 0..1 |

It may be present when monitoredResourceUris is related to the ue-context-in-amf-data and ue-context-in-smf-data.

If present, it indicates the consumer NF wants notification when NF is changed in the ue-context-in-amf-data and ue-context-in-smf-data.

| ENA | +| uniqueSubscription | boolean | O | 0..1 |

When present, this IE shall be set to indicate whether the subscription is a unique subscription, as specified in clause 5.2.2.3.2 and clause 5.2.2.3.3:
- true: the subscription is unique
- false: the subscription is not unique

| LimitedSubscriptions | +| resetIds | array(string) | O | 1..N |

May be present in subscribe response messages.

The NF service consumer may decide to re-subscribe at the UDM when receiving a data restoration notification containing a matching resetId.

| | +| ueConSmfDataSubFilter | UeContextInSmfDataSubFilter | O | 0..1 |

This IE may be present to receive the notification on changes for information in UeContextInSmfData related to specific PDU sessions.

| UeConSmfDataSubFilter | +| adjacentPlmns | array(PlmnId) | O | 1..N |

PLMN identities of PLMNs adjacent to the PLMN serving the UE. If present the report in the subscribe response may contain adjacentPlmnRestrictions for the indicated PLMNs.

May be present when changes to AccessAndMobilitySubscriptionData are subscribed.

| ImmediateReport | + +| | | | | | | +|-------------------------------|-----------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| disasterRoamingInd | boolean | O | 0..1 | Disaster Roaming Indicator (see 3GPP TS 23.502 [3]).
When present, this IE shall be set as follows:
- true: Disaster Roaming service is applied;
- false (default): Disaster Roaming service is not applied.
May be present when changes to resources AccessAndMobilitySubscriptionData or SmfSelectionSubscriptionData or SessionManagementSubscriptionData or Nssai are subscribed. | ImmediateReport | +| dataRestorationCallbackUri | Uri | O | 0..1 | If present, it contains the URI where notifications about UDR-initiated data restoration shall be sent by UDM. | | +| udrRestartInd | boolean | O | 0..1 | May be present in request messages from the UDM consumers to the UDM.
If present:
- true: indicates that the registration message sent by the UDM consumer is due to a re-synchronization event, motivated by a previous reception at the UDM consumer of a Data Restoration Notification from the UDM
- false (or absent): indicates that this is a normal request message (i.e., not motivated by a data restoration notification event) | | +| expectedUeBehaviourThresholds | map(ExpectedUeBehaviourThreshold) | O | 1..N | A map of expected UE Behaviour parameter thresholds. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

This IE may be present when NF-Consumer creating subscription requires certain confidence and/or accuracy levels to be met for the Expected UE Behaviour parameter(s) to be notified by the UDM, as specified in clause 4.15.6.2 of 3GPP TS 23.502 [3]. | | + +NOTE 1: The subscription expires if the last registration identified by the nfnInstanceId for the UE is deregistered at the UDM, e.g. the UDM shall remove the SdmSubscription of the SMF, if the UE's last PDU session SMF registration of this SMF is deregistered. + +NOTE 2: If "singleNssai" is not included, and "dnn" is not included, the UDM shall notify the data change of all DNN configurations and network slice(s). +If "singleNssai" is included, and "dnn" is not included, the UDM shall notify the data change of network slice identified by "singleNssai" and all DNN configurations for the requested network slice identified by "singleNssai". +If "singleNssai" is not included, and "dnn" is included, the UDM shall notify the data change of all network slices where such DNN is available and all DNN configurations identified by "dnn". +If "singleNssai" is included, and "dnn" is included, the UDM shall notify the data change of network slice identified by "singleNssai" where such DNN is available and the DNN configuration identified by "dnn", if such DNN is available in the network slice identified by "singleNssai". + +NOTE 3: The UDM should handle only the relative-path part (apiSpecificResourceUriPart, see 3GPP TS 29.501 [5] clause 4.4.1) and ignore possible inconsistencies in the base URI part. + +##### 6.1.6.2.4 Type: AccessAndMobilitySubscriptionData + +**Table 6.1.6.2.4-1: Definition of type AccessAndMobilitySubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.1.8 | | +| gpsi | array(Gpsi) | O | 0..N | List of Generic Public Subscription Identifier; see 3GPP TS 29.571 [7] | | +| internalGroupIds | array(GroupId) | O | 1..N | List of internal group identifier; see 3GPP TS 23.501 [2] clause 5.9.7 | | +| sharedVnGroupDataIds | map(SharedDataId) | O | 1..N | A map of identifiers of shared 5G VN group data (list of key-value pairs where GroupId serves as key; see clause 6.1.6.1). | | +| hssGroupId | NfGroupId | O | 0..1 | Identity of the HSS group associated with the subscription, which may be used by the UDM in discovering the HSS; see 3GPP TS 29.510 [19]. This attribute may be included if the coreNetworkTypeRestrictions does not indicate a value of "EPC". This attribute is only applicable to the Nudr interface and shall not be included over the Nudm interface. | | +| subscribedUeAmbr | AmbrRm | O | 0..1 | | | +| ns sai | Nssai | O | 0..1 | Network Slice Selection Assistance Information | | +| ratRestrictions | array(RatType) | O | 0..N | List of RAT Types that are restricted in 5GC and EPC; see 3GPP TS 29.571 [7] (NOTE 2) Contains unique items | | +| forbiddenAreas | array(Area) | O | 0..N | List of forbidden areas in 5GS (NOTE 6, NOTE 7) | | +| serviceAreaRestriction | ServiceAreaRestriction | O | 0..1 | Subscribed Service Area Restriction (NOTE 7) | | +| coreNetworkTypeRestrictions | array(CoreNetworkType) | O | 0..N | List of Core Network Types that are restricted. The use of the value "5GC" is deprecated on Nudm and shall be discarded by the receiving AMF. | | +| accessTypeRestrictions | array(AccessType) | O | 0..2 | List of Access Types that are restricted. If non-3GPP access is restricted, then the UDM shall reject/deregister the AMF non-3GPP registration. If 3GPP access is restricted, then the UDM shall reject/deregister the AMF 3GPP registration. Otherwise, the UDM shall pass the IE to the AMF. | | +| rfspIndex | RfspIndexRm | O | 0..1 | Index to RAT/Frequency Selection Priority; | | +| subsRegTimer | DurationSecRm | O | 0..1 | Subscribed periodic registration timer; (see clause 5.20 of 3GPP TS 23.501 [2], clause 4.15.3.2.3b and 4.15.6.3a of 3GPP TS 23.502 [3] and 3GPP TS 29.571 [7]) | | +| ueUsageType | UeUsageType | O | 0..1 | | | +| mpsPriority | MpsPriorityIndicator | O | 0..1 | | | +| mcsPriority | McsPriorityIndicator | O | 0..1 | | | +| activeTime | DurationSecRm | O | 0..1 | subscribed active time for PSM UEs (see clause 5.20 of 3GPP TS 23.501 [2] and clause 4.15.3.2.3b and 4.15.6.3a of 3GPP TS 23.502 [3]). | | +| sorInfo | SorInfo | O | 0..1 | On Nudm, this IE shall be present if the UDM shall send the information for Steering of Roaming during registration or the subscription data update to the UE. The UDM may detect the need to send sorInfo by retrieving context information from the UDR. (NOTE 4) | | + +| | | | | | | +|------------------------|---------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| sorInfoExpectInd | boolean | C | 0..1 |

Contains the indication on whether or not the UE is expecting to receive SoR information at initial registration.

  • - When set to true; it indicates that the UE is expecting to receive SoR information at initial registration in a VPLMN, i.e. the UDM shall send SoR information to the AMF on Nudm even when nothing was received from UDR or SOR-AF. In case the UDM was not able to obtain SoR information, SoR information sent on Nudm shall contain the indication that "no change" is needed.
  • - When set to false: it indicates that the UE is not expecting to receive SoR information at initial registration, i.e. the UDM shall send SoR information to the AMF based on operator policy.

This attribute may be present on Nudr interface and shall be absent on UDM interface.

The UDM shall ignore this attribute if the UE is not roaming out of its HPLMN.

| | +| sorafRetrieval | boolean | C | 0..1 |

Contains the indication on whether or not SoR information shall be retrieved from the SOR-AF.

  • - When set to true: it indicates that the UDM shall retrieve SoR information from the SOR-AF.
  • - When set to false or absent: it indicates that the retrieval of SorInfo from the SOR-AF is not required.

This attribute may be present on Nudr interface and shall be absent on Nudm interface.

The UDM shall ignore this attribute if it is received in Nudr but the UE is not roaming out of its HPLMN.

| | +| sorUpdateIndicatorList | array(SorUpdateIndicator) | C | 1..N |

When present, it contains the list of SoR Update Indicators;

  • - It shall indicate that the AMF shall retrieve SoR information when the UE performs Registration with NAS Registration Type "Initial Registration" if the value "INITIAL_REGISTRATION" is included;
  • - And/or it shall indicate that the AMF shall retrieve SoR information when the UE performs Registration with NAS Registration Type "Emergency Registration" if the value "EMERGENCY_REGISTRATION" is included.

When absent on Nudm interface, it indicates that the AMF is not requested to retrieve SoR information when the UE performs Registration with either NAS Registration Type "Initial Registration" or NAS Registration Type "Emergency Registration".

The UDM shall ignore this attribute if the UE is not roaming out of its HPLMN.

| | +| upulInfo | UpulInfo | O | 0..1 | This IE shall be present if the UDM shall send the information for UE Parameters Update after the UE has been successfully authenticated and registered to the 5G system. | | +| routingIndicator | string | O | 0..1 | This IE may be sent in Nudm_SDM notification as defined in 3GPP TS 23.502 Clause 4.20.2, if UE Parameter Update was sent for Routing Indicator Update, but without requesting the UE to re-register. | | +| micoAllowed | MicoAllowed | O | 0..1 | Indicates whether the UE subscription allows MICO mode. | | + +| | | | | | | +|-------------------------------|---------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| sharedAmDataIds | array(SharedDataId) | O | 0..N | Identifier of shared Access And Mobility Subscription data | SharedData | +| odbPacketServices | OdbPacketServices | O | 0..1 | Operator Determined Barring for Packet Oriented Services (NOTE 3). | | +| subscribedDnnList | array(Dnn) | O | 0..N | List of the subscribed DNNs for the UE (including optionally the Wildcard DNN). Used to determine the list of LADN available to the UE as defined in clause 5.6.5 of TS 23.501 [2].
When present, this IE shall contain the Network Identifier only.
Shall be ignored if ladnServiceArea is present. | | +| serviceGapTime | DurationSec | O | 0..1 | Used to set the Service Gap timer for Service Gap Control (see TS 23.501 [2] clause 5.26.16 and TS 23.502 [3] clause 4.2.2.2.2). | | +| mdtUserConsent | MdtUserConsent | O | 0..1 | When present, this IE shall indicate whether the user has given his consent for MDT activation or not (see clause 4.9 of 3GPP TS 32.422 [48]).
When absent, "CONSENT_NOT_GIVEN" is the default value. | | +| mdtConfiguration | MdtConfiguration | C | 0..1 | This IE shall be present if the MDT task is activated. When present, this IE shall contain MDT configuration data for UE (see clause 4.1.2.17 of 3GPP TS 32.422 [48]). | | +| traceData | TraceData | O | 0..1 | Trace requirements about the UE, only sent to AMF in the HPLMN or one of its equivalent PLMN(s) | | +| cagData | CagData | O | 0..1 | Closed Access Group Data.
Shall be absent if both
- no CAG is subscribed for the serving PLMN and
- an acknowledgement from the UE is not pending. | CAGFeature | +| stnSr | StnSr | O | 0..1 | This IE shall be present if the UE is subscribed to 5G SRVCC.
When present, it indicates the STN-SR (Session Transfer Number for SRVCC) of the UE. | | +| cMsisdn | CMsisdn | O | 0..1 | This IE shall be present if the UE is subscribed to 5G SRVCC.
When present, it indicates the C-MSISDN (Correlation MSISDN) of the UE. | | +| nbIoTUePriority | NbIoTUePriority | O | 0..1 | Indicates NB IoT UE priority which is used by the NG-RAN to prioritise resource allocation between UEs accessing via NB-IoT (see clause 5.31.17 of 3GPP TS 23.501 [2]). | | +| nssaiInclusionAllowed | boolean | O | 0..1 | Indicates that the UE is allowed to include NSSAI in the RRC connection establishment in clear text for 3GPP access, as specified in clause 5.15.9 of 3GPP TS 23.501 [2] and clause 4.2.2.2.2 of 3GPP TS 23.502 [3].

true: indicates that NSSAI can be included in RRC connection establishment by the UE.

false or absent: indicates that NSSAI cannot be included. | | +| rgWirelineCharacteristics | RgWirelineCharacteristics | O | 0..1 | Indicates the RG Level Wireline Access Characteristics as specified in 3GPP TS 23.316 [37]. | | +| aun3DeviceConnectivityAllowed | boolean | O | 0..1 | Indicates whether the UE is allowed to access as an AUN3 device; see 3GPP TS 23.316 [37].
true: indicates allowed
false or absent indicates not allowed | | +| ecRestrictionDataWb | EcRestrictionDataWb | O | 0..1 | Indicates Enhanced Coverage Restriction Data for WB-N1 mode.
If absent, indicates Enhanced Coverage is not restricted for WB-N1 mode. | | + +| | | | | | | +|--------------------------------|-----------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| ecRestrictionDataNb | boolean | O | 0..1 | If present, this IE shall indicate whether Enhanced Coverage for NB-N1 mode is restricted or not.

true: Enhanced Coverage for NB-N1 mode is restricted.
false or absent: Enhanced Coverage for NB-N1 mode is allowed. | | +| expectedUeBehaviour List | ExpectedUeBehaviourData | O | 0..1 | Indicates Expected UE Behaviour parameters associated with AMF(see clause 5.20 of 3GPP TS 23.501 [2] and clause 4.15.6.3 of 3GPP TS 23.502 [3]).

This attribute is only applicable to the Nudm interface and shall not be included over the Nudr interface.

This IE, if present, shall be ignored if parameter expectedUeBehavioursData is present in AccessAndMobilitySubscriptionData. | | +| expectedUeBehaviour Data | map(ExpectedUeBehaviourData) | O | 1..N | A map of ExpectedUeBehaviourData associated with AMF (see clause 5.20 of 3GPP TS 23.501 [2] and clause 4.15.6.3 of 3GPP TS 23.502 [3]). The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

Each attribute in the ExpectedUeBehaviourData shall only be present in one entry of the map.

This attribute is only applicable to the Nudm interface and shall not be included over the Nudr interface. | ExpectedBehaviour Map | +| primaryRatRestrictions | array(RatType) | O | 0..N | List of RAT Types that are restricted for use as primary RAT in 5GC and EPC; see 3GPP TS 29.571 [7] (NOTE 2)
Contains unique items | | +| secondaryRatRestrictions | array(RatType) | O | 0..N | List of RAT Types that are restricted for use as secondary RAT in 5GC and EPC; see 3GPP TS 29.571 [7] (NOTE 2)
Contains unique items | | +| edrxParametersList | array(EdrxParameters) | O | 1..N | List of subscribed the extended idle mode DRX parameters (see clause 5.31.7.2.1 of 3GPP TS 23.501 [2]). | | +| ptwParametersList | array(PtwParameters) | O | 1..N | List of subscribed the Paging Time Window parameters (see clause 5.31.7.2.1 of 3GPP TS 23.501 [2]). | | +| iabOperationAllowed | boolean | O | 0..1 | Indicates that the UE is allowed for IAB operation as specified in 3GPP TS 23.501 [2].

true: indicates that the UE is allowed for IAB operation.

false or absent: indicates that the UE is not allowed for IAB operation. | | +| adjacentPlmnRestrictions | map(PlmnRestriction) | O | 1..N | A map (list of key-value pairs where PlmnId converted to string serves as key; see 3GPP TS 29.571 [7]) of PlmnRestrictions for adjacent PLMNs | | +| wirelineForbiddenAreas | array(WirelineAreas) | O | 0..N | List of forbidden areas for 5G-BRG/5G-CRG/FN-CRG (NOTE 6, NOTE 7) | | +| wirelineServiceAreaRestriction | WirelineServiceAreaRestriction | O | 0..1 | Subscribed Service Area Restriction for 5G-BRG/5G-CRG/FN-CRG (NOTE 7) | | +| pcfSelectionAssistanceInfos | array(PcfSelectionAssistanceInfo) | C | 1..N | List of combination of DNN and S-NSSAI that indicates that the same PCF needs to be selected by the AMF. (NOTE 5) | | +| aerialUeSubInfo | AerialUeSubscriptionInfo | O | 0..1 | This IE shall contain the subscribed Aerial UE Subscription Information when present. | | + +| | | | | | | +|-----------------------------|-----------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| roamingRestrictions | RoamingRestrictions | O | 0..1 | This IE is used by Nudr_DataRepository API starting with 3GPP Rel-17 and onwards (see Table 5.2.3.3.1-3 in 3GPP TS 29.505 [10]). If present, this IE contains information on the roaming restrictions. If this IE is absent e.g. if the UDR is not provisioned with the serving PLMN ID, then the UDM may use the UE's home subscribed profile as the default profile to handle the roaming and SNPN scenarios. | | +| remoteProvInd | boolean | O | 0..1 | Indicates whether the UE is allowed only for Remote Provisioning as specified in clause 5.30.2.10.3.2 of 3GPP TS 23.501 [2]. UE subscription either allows, or does not allow the UE to access the PLMN as the Onboarding Network using PLMN credentials.
  • - false (default), or the attribute is absent: indicates that the UE is not restricted to the Onboarding only;
  • - true: indicates that the UE is allowed only for the Onboarding.
| | +| 3gppChargingCharacteristics | 3GppChargingCharacteristics | O | 0..1 | Subscribed charging characteristics data associated to the subscription. | | +| timeSyncData | TimeSyncData | O | 0..1 | Contains subscription data for Access Stratum Time Synchronization (see 3GPP TS 23.502 [3] clause 4.28.2.1 and 3GPP TS 23.501 [2] clause 5.27.1.11). | | +| sharedDataList | array(SharedData) | O | 1..N | May be present if sharedAmDataIds is present. If present this IE contains a list of shared Access And Mobility Subscription Data identified by the sharedAmDataIds and known not to be already available at the consumer. | | +| qmcConfigInfo | QmcConfigInfo | O | 0..1 | Configuration information for the Quality of Experience (QoE) Measurements Collection (QMC) functionality. | | +| mbsrOperationAllowed | MbsrOperationAllowed | O | 0..1 | Indicates whether the subscriber is allowed for MBSR operation as specified in clause 5.35A.4 of 3GPP TS 23.501 [2], optionally, with corresponding location and time period. | | +| ladnServiceAreas | map(DnnLadnServiceAreas) | O | 0..N | A map (list of key-value pairs where Snssai converted to string serves as key; see 3GPP TS 29.571 [7] clause 5.4.4.2) of DnnLadnServiceAreas | | + +| | | | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| NOTE 1: | AccessAndMobilitySubscriptionData can be UE-individual data or shared data.
UE-individual data take precedence over shared data unless treatment instructions associated to the shared data indicate otherwise.
E.g.: When an attribute of type array is present but empty within UE-Individual data and present (with any cardinality) in shared data and no treatment instructions are applicable, the empty array takes precedence. Similarly, when a nullable attribute is present with value null within the individual data and present (with any value) in shared data and no treatment instructions are applicable, the null value takes precedence (i.e. for the concerned UE the attribute is considered absent). | | +| NOTE 2: | If the primaryRatRestrictions and secondaryRatRestrictions attributes are supported by the sender, the sender shall include the list of RAT Types that are restricted, if any, in the ratRestrictions attribute, shall include the list of RAT Types that are restricted for use as primary RAT, if any, in the primaryRatRestrictions attribute and shall include the list of RAT Types that are restricted for use as secondary RAT, if any, in the secondaryRatRestrictions attribute. If the primaryRatRestrictions and secondaryRatRestrictions attributes are supported by the receiver, the receiver shall use the data in the primaryRatRestrictions attribute, if received, as the list of RAT Types that are restricted for use as primary RAT, and shall use the data in the secondaryRatRestrictions attribute, if received, as the list of RAT Types that are restricted for use as secondary RAT, otherwise the receiver shall use the data in the ratRestrictions attribute, if received, as the list of RAT Types that are restricted.
If the secondaryRatRestrictions attribute is included in the subscription profile, the content may be sent to MME during inter RAT handover from NR SA to EN-DC, for the purpose of adequate SGW selection at MME based on subscription profile, and to avoid allocating unnecessary resources for secondary RAT at EPC if it is restricted. | | +| NOTE 3: | The AMF shall take responsibility to perform PDU session related actions subject to change of OdbPacketService, e.g. release existing PDU session. | | +| NOTE 4: | The UDM shall ignore the content of sorInfo received on Nudr if "sorafRetrieval" is set to true. | | +| NOTE 5: | If multiple PDU sessions to one DNN and S-NSSAI are established in EPS, the AMF shall select the same PCF by configuration or by using existing method, e.g. same PCF selection in usage monitoring. | | +| NOTE 6: | When UE is only permitted in a small area, i.e. the UE is forbidden in most of TAIIs in the PLMN, AreaCode (e.g. "All TAIIs except xxx") may be used to avoid provisioning and transferring large number of TAIIs.
AreaCode may be used otherwise. | | +| NOTE 7: | AreaCode for VPLMN(s) may be provisioned under agreement between operators. | | + +##### 6.1.6.2.5 Type: SmfSelectionSubscriptionData + +**Table 6.1.6.2.5-1: Definition of type SmfSelectionSubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.1.8 | | +| subscribedSnssaiInfos | map(SNSSAIInfo) | O | 0..N | List of S-NSSAIs and associated information (DNN Info); see 3GPP TS 23.501 [2] clause 6.3.2.
A map (list of key-value pairs where singleNssai converted to string serves as key; see 3GPP TS 29.571 [7]) of arrays of DnnInfo | | +| sharedSnssaiInfosId | SharedDataId | O | 0..1 | Identifier of shared SnssaiInfos. | SharedData | +| hssGroupId | NfGroupId | O | 0..1 | Identity of the HSS group associated with the subscription, which may be used by the UDM in discovering the HSS; see 3GPP TS 29.510 [19].

May be present on the Nudr interface if there is DNN interworking with EPC and shall not be included over the Nudm interface. | | +| NOTE: | A single UE-individual subscribedSnssaiInfo (within subscribedSnssaiInfos) may clash with a sharedSnssaiInfo (i.e. both have the same singleNssai value as key). In this case the UE-individual subscribedSnssaiInfo takes precedence unless treatment instructions associated to the shared data indicate otherwise. | | | | | + +##### 6.1.6.2.6 Type: DnnInfo + +Table 6.1.6.2.6-1: Definition of type DnnInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------------------------------------------------------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Data Network Name with Network Identifier only., or Wildcard DNN (NOTE) | +| defaultDnnIndicator | DefaultDnnIndicator | O | 0..1 | Indicates whether this DNN is the default DNN:
true: The DNN is the default DNN (NOTE);
false: The DNN is not the default DNN;
If this attribute is absent it means the DNN is not the default DNN. | +| lboRoamingAllowed | LboRoamingAllowed | O | 0..1 | Indicates whether local breakout for the DNN is allowed when roaming:
true: Allowed;
false: Not allowed;
If this attribute is absent it means not allowed. | +| iwkEpsInd | IwkEpsInd | O | 0..1 | Indicates whether interworking with EPS is subscribed:
true: Subscribed;
false: Not subscribed;
If this attribute is absent it means not subscribed. | +| dnnBarred | boolean | C | 0..1 | Indicates whether the DNN is barred. Absence and false indicates "not barred".
This attribute is only used on the Nudr interface. The UDM shall handle barred DNNs received from the UDR as not subscribed. | +| invokeNefInd | boolean | O | 0..1 | Indicates whether the NEF based infrequent small data transfer shall be used for the PDU Session associated with the S-NSSAI and DNN.
true: Used;
false: Not used;
If this attribute is absent it means not used. | +| smfList | array(NfInstanceId) | O | 1..N | Indicate the associated SMF(s) if the static IP address/prefix is used. | +| sameSmfInd | boolean | O | 0..1 | Indicates whether the same SMF for multiple PDU sessions to the same DNN and S-NSSAI is required.
true: Required;
false: Not required;
If this attribute is absent it means not required. | +| hrSboAllowed | boolean | O | 0..1 | Indicates whether Session Breakout for HR Session in VPLMN is allowed (see 3GPP TS 23.502 [3] and 3GPP TS 23.548 [60]).
true: Allowed;
false: Not allowed;
If this attribute is absent it means not allowed. | +| NOTE: If the dnn attribute contains the value of the Wildcard DNN ("*"), the defaultDnnIndicator shall not be set to true. | | | | | + +##### 6.1.6.2.7 Type: SnssaiInfo + +Table 6.1.6.2.7-1: Definition of type SnssaiInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|----------------------------------------------------------------------| +| dnnInfos | array(DnnInfo) | M | 1..N | list of Data Network Names for an S-NSSAI and associated information | + +##### 6.1.6.2.8 Type: SessionManagementSubscriptionData + +**Table 6.1.6.2.8-1: Definition of type SessionManagementSubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|-----------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| singleNssai | Snssai | M | 1 | A single Network Slice Selection Assistance Information | | +| dnnConfigurations | map(DnnConfiguration) | O | 0..N | Additional DNN configurations for the network slice;
A map (list of key-value pairs where DNN, or optionally the Wildcard DNN, serves as key; see clause 6.1.6.1) of DnnConfigurations. (NOTE 1) | | +| internalGroupIds | array(GroupId) | O | 1..N | List of internal group identifier; see 3GPP TS 23.501 [2] clause 5.9.7 | | +| sharedVnGroupDataIds | map(SharedDataId) | O | 1..N | A map of identifiers of shared 5G VN group data (list of key-value pairs where GroupId serves as key; see clause 6.1.6.1). | | +| traceData | TraceData | O | 0..1 | Trace requirements about the UE, only sent to SMF in the HPLMN or one of its equivalent PLMN(s) | | +| sharedDnnConfigurationId | SharedDataId | O | 0..1 | Identifier of shared data for DNN configuration. | SharedData | +| sharedTraceDataId | SharedDataId | O | 0..1 | Identifier of shared data for trace requirements | | +| odbPacketServices | OdbPacketServices | O | 0..1 | Operator Determined Barring for Packet Oriented Services (NOTE 2). | | +| expectedUeBehavioursList | map(ExpectedUeBehaviourData) | O | 1..N | A map of ExpectedUeBehaviourDatas associated with SMF (DNN serves as key; see clause 6.1.6.1), see clause 5.20 of 3GPP TS 23.501 [2] and clause 4.15.6.3 of 3GPP TS 23.502 [3].
This attribute is only applicable to the Nudm interface and shall not be included over the Nudr interface.

This IE, if present, shall be ignored if parameter expectedUeBehavioursData is present in SessionManagementSubscriptionData. | | +| expectedUeBehaviourData | map(map(ExpectedUeBehaviourData)) | O | 1..N(1..M) | A map of ExpectedUeBehaviourData associated with SMF (see clause 5.20 of 3GPP TS 23.501 [2] and clause 4.15.6.3 of 3GPP TS 23.502 [3]).

The key of external map is the DNN, see clause 6.1.6.1.

The key of the internal map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

Each attribute in the ExpectedUeBehaviourData shall only be present in one entry of the map.

This attribute is only applicable to the Nudm interface and shall not be included over the Nudr interface. | ExpectedBehaviourMap | + +| | | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appSpecificExpectedUeBehaviourData | map(map(AppSpecificExpectedUeBehaviourData)) | O | 1..N |

A map of application specific expected UE Behaviour parameters.

The key of external map is the DNN, see clause 6.1.6.1.

The key of the internal map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

Each attribute in the AppSpecificExpectedUeBehaviourData shall only be present in one entry of the internal map for one Application ID.

This attribute is only applicable to the Nudm interface and shall not be included over the Nudr interface.

| | +| suggestedPacketNumDlList | map(SuggestedPacketNumDl) | O | 1..N |

A map (list of key-value pairs where dnn serves as key; see clause 6.1.6.1) of SuggestedPacketNumDls which are associated with SMF (see clause 5.20 of 3GPP TS 23.501 [2] and clause 4.15.6.3 of 3GPP TS 23.502 [3]).

This attribute is only applicable to the Nudm interface and shall not be included over the Nudr interface.

| | +| 3gppChargingCharacteristics | 3GppChargingCharacteristics | O | 0..1 | Subscribed charging characteristics data associated to the subscription. | | +| nsacMode | NsacAdmissionMode | O | 0..1 | Indicates which NSAC admission mode shall be applied for roaming scenario (see 3GPP TS 23.501 [2] clause 5.15.11.3). | | +| sessInactTimer | DurationSec | O | 0..1 | Identifies the slice PDU Session inactivity timer for the Network Slice identified by the sNssai IE (see TS 23.501 [8] clause 5.15.15.3). | | +| onDemand | boolean | O | 0..1 |

Indicates whether the S-NSSAI is an On Demand slice:

  • - true: S-NSSAI is an On Demand slice.
  • - false or absent: not an On Demand slice.
| | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.1.8 | | +| additionalSharedDnnConfigurationsIds | array(SharedDataId) | O | 1..N |

Additional Identifiers of shared data for DNN configuration.

Shall be absent if sharedDnnConfigurationsId is absent.

| SharedDataExt | +|

NOTE 1: A given UE-individual dnnConfiguration (within dnnConfigurations) may clash with a shared dnnConfiguration (i.e. both have the same dnn value as key). In this case the clashing attributes of the UE-individual dnnConfiguration take precedence unless treatment instructions indicate otherwise.

NOTE 2: For the same UE, the value of this IE shall be identical to the value of the odbPacketServices IE in AccessAndMobilitySubscriptionData data set (see clause 6.1.6.2.4). The SMF shall not trigger PDU session release when receiving change of OdbPacketService. Only the AMF take responsibility to perform PDU session related actions subject to change of ODB setting, e.g. release existing PDU session.

| | | | | | + +##### 6.1.6.2.9 Type: DnnConfiguration + +**Table 6.1.6.2.9-1: Definition of type DnnConfiguration** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| pduSessionTypes | PduSessionTypes | M | 1 | Default/Allowed session types | +| sscModes | SscModes | M | 1 | Default/Allowed SSC modes | +| iwkEpsInd | IwkEpsInd | O | 0..1 | Indicates whether interworking with EPS is subscribed:
true: Subscribed;
false: Not subscribed;
If this attribute is absent it means not subscribed. | +| 5gQosProfile | SubscribedDefaultQoS | O | 0..1 | 5G QoS parameters associated to the session for a data network | +| sessionAmbr | Ambr | O | 0..1 | The maximum aggregated uplink and downlink bit rates to be shared across all Non-GBR QoS Flows in each PDU Session. | +| 3gppChargingCharacteristics | 3GppChargingCharacteristics | O | 0..1 | Subscribed charging characteristics data associated to the session for a data network.
(NOTE 1) | +| staticIpAddress | array(IpAddress) | O | 1..2 | Subscribed static IP address(es) of the IPv4 and/or IPv6 type. | +| upSecurity | UpSecurity | O | 0..1 | When present, this IE shall indicate the security policy for integrity protection and encryption for the user plane. | +| pduSessionContinuityInd | PduSessionContinuityInd | O | 0..1 | When present, this IE shall indicate how to handle a PDU Session when UE moves to or from NB-IoT.
If this attribute is absent it means that Local policy shall be used. | +| niddNefId | NefId | O | 0..1 | Indicates the identity of the NEF to be selected for NIDD service for this DNN. | +| niddInfo | NiddInformation | O | 0..1 | When present, this IE shall indicate information used for SMF-NEF Connection. | +| redundantSessionAllowed | boolean | O | 0..1 | Indicates whether redundant PDU Sessions are allowed:
true: Allowed;
false: Not allowed;
If this attribute is absent it means not allowed. | +| acsInfo | AcsInfo | O | 0..1 | When present, this IE shall include the ACS information for the 5G-RG as defined in BBF TR-069 [42] or in BBF TR-369 [43]. | +| ipv4FrameRouteList | array(FrameRouteInfo) | O | 1..N | List of Frame Route information of IPv4, see clause 5.6.14 of 3GPP TS 23.501 [2]. | +| ipv6FrameRouteList | array(FrameRouteInfo) | O | 1..N | List of Frame Route information of IPv6, see clause 5.6.14 of 3GPP TS 23.501 [2]. | +| atsssAllowed | boolean | O | 0..1 | Indicates whether this DNN supports ATSSS, i.e. whether Multi-Access PDU session is allowed to this DNN.
true: Allowed;
false (default): Not allowed;
If this attribute is absent it means this DNN does not allow ATSSS. | +| secondaryAuth | boolean | O | 0..1 | Indicates whether DN-AAA based secondary authentication and authorization is needed.
true: required.
false: not required.
If absent, it indicates that DN-AAA based secondary authentication is not required by subscription data, but it still may be required by local policies at the SMF.
(NOTE 2) | +| uavSecondaryAuth | boolean | O | 0..1 | Indicates whether SBI-based secondary authentication and authorization for Uncrewed Aerial Vehicles (UAV) is needed.
true: required.
false or absent: not required. | + +| | | | | | +|--------------------------------------|--------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnAaaIpAddressAllocation | boolean | O | 0..1 | Indicates whether the SMF is required to request the UE IP address from the DN-AAA server for PDU Session Establishment.
true: required
false: not required
If absent, it indicates that the request by SMF of the UE IP address from the DN-AAA server is not required by subscription data, but it still may be required by local policies at the SMF. (NOTE 2) | +| dnAaaAddress | IpAddress | O | 0..1 | The IP address of the DN-AAA server used for secondary authentication and authorization. (NOTE 2) | +| additionalDnAaaAddresses | array(IpAddress) | O | 1..N | Additional IP addresses of the DN-AAA server used for secondary authentication and authorization. (NOTE 2) | +| dnAaaFqdn | Fqdn | O | 0..1 | The FQDN of the DN-AAA server used for secondary authentication and authorization. (NOTE 2) | +| iptvAccCtrlInfo | string | O | 0..1 | The IPTV access control information used in IPTV access procedure, see clause 7.7.1.1.2 of 3GPP TS 23.316 [37]. | +| ipv4Index | IpIndex | O | 0..1 | Indicates the "IP Index" (i.e. information that identifies an address pool or an external server) to be sent to the SMF for allocation of an IPv4 address to the UE, for this DNN configuration. | +| ipv6Index | IpIndex | O | 0..1 | Indicates the "IP Index" (i.e. information that identifies an address pool or an external server) to be sent to the SMF for allocation of an IPv6 address to the UE, for this DNN configuration. | +| ecsAddrConfigInfo | EcsAddrConfigInfo | O | 0..1 | ECS Address Configuration Information Parameters. See 3GPP TS 23.502 [3] | +| additionalEcsAddrConfigInfos | array(EcsAddrConfigInfo) | O | 1..N | This IE may be present when ecsAddrConfigInfo IE is present.

When present, this IE shall contain the additional ECS Address Configuration Information Parameters. See 3GPP TS 23.548 [60] | +| sharedEcsAddrConfigInfoId | SharedDataId | O | 0..1 | Identifier of shared data indicating an ECS Configuration Information. | +| additionalSharedEcsAddrConfigInfoIds | array(SharedDataId) | O | 1..N | This IE may be present when sharedEcsAddrConfigInfoId IE is present.

When present, this IE shall contain the identifiers of shared data indicating the additional ECS Address Configuration Information. | +| easDiscoveryAuthorized | boolean | O | 0..1 | Indicates whether the UE is authorized to use 5GC assisted EAS discovery via EASDF.
true: Authorized;
false (default): Not authorized;
See 3GPP TS 23.548 [60] | +| onboardingInd | boolean | O | 0..1 | Indicates whether the UE is allowed to use this DNN for onboarding. UE subscription allows, or does not allow the UE to access the PLMN as the Onboarding Network using PLMN credentials (see clause 5.30.2.10.4.4 in 3GPP TS 23.501 [2]).
- false (default): not restricted to onboarding only;

- true: allowed for onboarding only. | + +| | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aerialUeInd | AerialUeIndication | O | 0..1 | This IE shall indicate Aerial service for the UE is allowed or not allowed. | +| subscribedMaxIpv6PrefixSize | integer | O | 0..1 | maximum size of the IPv6 prefix that may be allocated for the PDU Session. See 3GPP TS 23.316 [37] clause 4.6.2.3. | +| hrSboAuthorized | boolean | O | 0..1 | Indicates whether Home Routed Session Breakout (HR-SBO) is authorized (see 3GPP TS 23.548 [60] clause 6.7.2.2)
true: Authorized;
false: Not authorized;
If this attribute is absent it means not authorized. | +| NOTE 1: When present, this attribute shall take precedence over the "3gppChargingCharacteristics" attribute in the SessionManagementSubscriptionData level. | | | | | +| NOTE 2: These attributes shall be consistent with the information received on the 5GVnGroupData (see clause 6.5.6.2.7), in the Nudm_PP API. If both FQDN and IP addresses are provided, the IP addresses should be preferred to target the DN-AAA server. | | | | | + +6.1.6.2.10 Void + +6.1.6.2.11 Type: PduSessionTypes + +**Table 6.1.6.2.11-1: Definition of type PduSessionTypes** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------------------|---|-------------|-----------------------------------------------------------------------------| +| defaultSessionType | PduSessionType | C | 0..1 | Default session type, shall be present unless the VnGroupData is supported. | +| allowedSessionTypes | array(PduSessionType) | O | 1..N | Additional session types allowed for the data network | + +6.1.6.2.12 Type: SscModes + +**Table 6.1.6.2.12-1: Definition of type SscModes** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|----------------|---|-------------|---------------------------------------------------| +| defaultSscMode | SscMode | M | 1 | Default SSC mode | +| allowedSscModes | array(SscMode) | O | 1..2 | Additional SSC modes allowed for the data network | + +6.1.6.2.13 Type: SmsSubscriptionData + +**Table 6.1.6.2.13-1: Definition of type SmsSubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smsSubscribed | SmsSubscribed | C | 0..1 | Indicates whether the UE subscription allows SMS delivery over NAS. Shall not be absent unless the feature SharedData is supported and smsSubscribed is present within shared data. | +| sharedSmsSubsDataId | SharedDataId | C | 0..1 | Identifier of shared data. Shall be present if smsSubscribed is absent. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.1.8 | + +##### 6.1.6.2.14 Type: SmsManagementSubscriptionData + +Table 6.1.6.2.14-1: Definition of type SmsManagementSubscriptionData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.1.8 | | +| mtSmsSubscribed | boolean | C | 0..1 | Indicates the SMS teleservice subscription for MT-SMS. Shall not be absent unless the feature SharedData is supported and mtSmsSubscribed is present within shared data. | | +| mtSmsBarringAll | boolean | C | 0..1 | Barring of all MT-SMS | | +| mtSmsBarringRoaming | boolean | C | 0..1 | Barring of MT-SMS when roaming outside the Home Public Land Mobile Network (PLMN) country | | +| moSmsSubscribed | boolean | C | 0..1 | Indicates the SMS teleservice subscription for MO-SMS. Shall not be absent unless the feature SharedData is supported and moSmsSubscribed is present within shared data. | | +| moSmsBarringAll | boolean | C | 0..1 | Barring of all MO-SMS | | +| moSmsBarringRoaming | boolean | C | 0..1 | Barring of MO-SMS when roaming outside the Home Public Land Mobile Network (PLMN) country | | +| traceData | TraceData | O | 0..1 | Trace requirements about the UE, only sent to SMSF in HPLMN | | +| sharedSmsMngDataIds | array(SharedDataId) | C | 1..N | Identifier of shared data. Shall be present if mtSmsSubscribed and/or moSmsSubscribed and/or traceData are absent. | SharedData | + +##### 6.1.6.2.15 Type: SubscriptionDataSets + +Table 6.1.6.2.15-1: Definition of type SubscriptionDataSets + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------|-----------------------------------|---|-------------|----------------------------------------------------------------| +| amData | AccessAndMobilitySubscriptionData | O | 0..1 | Access and Mobility Subscription Data | +| smfSelData | SmfSelectionSubscriptionData | O | 0..1 | SMF Selection Subscription Data | +| uecAmfData | UeContextInAmfData | O | 0..1 | UE Context In AMF Data | +| uecSmfData | UeContextInSmfData | O | 0..1 | UE Context In SMF Data | +| uecSmsfData | UeContextInSmsfData | O | 0..1 | UE Context In SMSF Data | +| smsSubsData | SmsSubscriptionData | O | 0..1 | SMS Subscription Data | +| smData | SmSubsData | O | 0..1 | Session Management Subscription Data | +| traceData | TraceData | O | 0..1 | Trace Data. The Null value indicates that trace is not active. | +| smsMngData | SmsManagementSubscriptionData | O | 0..1 | SMS Management Subscription Data | +| lcsPrivacyData | LcsPrivacyData | O | 0..1 | LCS Privacy Subscription Data | +| lcsMoData | LcsMoData | O | 0..1 | LCS Mobile Originated Subscription Data | +| lcsSubscriptionData | LcsSubscriptionData | O | 0..1 | Other LCS Subscription Data | +| v2xData | V2xSubscriptionData | O | 0..1 | V2x Subscription Data | +| lcsBroadcastAssistanceTypesData | LcsBroadcastAssistanceTypesData | O | 0..1 | LCS List of Broadcast Assistance Data Types Subscription Data | +| proseData | ProseSubscriptionData | O | 0..1 | ProSe Service Subscription Data | +| mbsData | MbsSubscriptionData | O | 0..1 | 5MBS Subscription Data | +| ucData | UcSubscriptionData | O | 0..1 | User Consent Subscription Data | +| a2xData | A2xSubscriptionData | O | 0..1 | A2x Subscription Data | + +##### 6.1.6.2.16 Type: UeContextInSmfData + +Table 6.1.6.2.16-1: Definition of type UeContextInSmfData + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| pduSessions | map(PduSession) | O | 0..N | A map (list of key-value pairs where pduSessionId converted from integer to string serves as key; see clause 6.1.6.1) of PduSessions. | +| pgwInfo | array(PgwInfo) | O | 1..N | Information about the DNNs/APNs and PGW-C+SMF FQDNs used in interworking with EPS | +| emergencyInfo | EmergencyInfo | O | 0..1 | Information about emergency session | +| NOTE: If sdmSubscription contains nfChangeFilter flag, then the UDM shall suppress the change notification for the pgwInfo and emergencyInfo. | | | | | + +##### 6.1.6.2.17 Type: PduSession + +Table 6.1.6.2.17-1: Definition of type PduSession + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|---|-------------|--------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Data Network Name with Network Identifier only. | +| smfInstanceId | NfInstanceId | M | 1 | NF Instance Id of the SMF | +| plmnId | PlmnId | M | 1 | PLMN Id of the SMF | +| singleNssai | Snssai | O | 0..1 | A single Network Slice Selection Assistance Information.
(NOTE) | +| NOTE: For supporting selection of the same SMF if a UE requests multiple PDU sessions associated with the same DNN and same S-NSSAI, the S-NSSAI associated to the PDU session is required to be included. | | | | | + +##### 6.1.6.2.18 Type: IdTranslationResult + +Table 6.1.6.2.18-1: Definition of type IdTranslationResult + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.1.8 | +| supi | Supi | M | 1 | SUPI | +| gpsi | Gpsi | C | 0..1 | If ueld is a SUPI in Resource URI variables, this shall be present and indicates an MSISDN or external identifier. | +| additionalSupis | array(Supi) | O | 1..N | May be present when ueld is a GPSI in resource URI variables and more than one SUPIs matching the retrieval request have been received from the UDR. | +| additionalGpsis | array(Gpsi) | O | 1..N | May be present when ueld is a SUPI in Resource URI variables and more than one GPSIs matching the retrieval request have been received from the UDR. | +| NOTE: When the UDM receives an array of more than one SUPIs from the UDR, the supi attribute shall convey the first received array element and the additionalSupis attribute shall convey subsequent received array elements.
When the UDM receives an array of more than one GPSIs from the UDR, the gpsi attribute shall convey the first received array element and the additionalGpsis attribute shall convey subsequent received array elements. | | | | | + +6.1.6.2.19 Void + +6.1.6.2.20 Void + +6.1.6.2.21 Type: ModificationNotification + +**Table 6.1.6.2.21-1: Definition of type ModificationNotification** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifyItems | array(NotifyItem) | M | 1..N |

The NotifyItem indicates the Notification information correlated with the subscription for the NF consumer (e.g. SMF).

Example:
To remove or replace the SM Subscription Data for a specific DNN and S-NSSAI, the path in the ChangeItem included in the NotifyItem may set an empty value (e.g. "path":""") to indicate to remove or replace the information correlated with the subscription for the specific DNN and S-NSSAI for the NF consumer. The subscription is correlated with the information which is retrieved via GET service operation by the NF consumer.

| +| subscriptionId | string | C | 0..1 | A UDM complying with this release of the specification shall include the Subscription ID that was allocated by the UDM when the subscribe request was received. It may be used by the consumer of the UDM to correlate the received notification with the active subscription. | + +When the NF Service Consumer creates multiple subscriptions, it should use distinct callback URIs for each subscription. + +6.1.6.2.22 Type: IpAddress + +**Table 6.1.6.2.22-1: Definition of type IpAddress** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------|------------|---|-------------|-------------| +| ipv4Addr | Ipv4Addr | C | 0..1 | | +| ipv6Addr | Ipv6Addr | C | 0..1 | | +| ipv6Prefix | Ipv6Prefix | C | 0..1 | | +| NOTE: Either ipv4Addr, or ipv6Addr, or ipv6Prefix shall be present. | | | | | + +6.1.6.2.23 Type: UeContextInSmsfData + +**Table 6.1.6.2.23-1: Definition of type UeContextInSmsfData** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------| +| smsfInfo3GppAccess | SmsfInfo | O | 0..1 | SMSF Info for 3GPP Access | +| smsfInfoNon3GppAccess | SmsfInfo | O | 0..1 | SMSF Info for Non 3GPP Access | + +##### 6.1.6.2.24 Type: SmsfInfo + +**Table 6.1.6.2.24-1: Definition of type SmsfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smsfInstanceId | NfInstanceId | M | 1 | NF Instance Id of the SMSF | +| plmnId | PlmnId | M | 1 | PLMN Id of the SMSF | +| smsfSetId | NfSetId | C | 0..1 | NF Set Id of SMSF Set the registered SMSF instance belongs to; it shall be present if provided in SMSF registration procedure (see clauses 5.3.2.2.5 and 5.3.2.2.6) | + +##### 6.1.6.2.25 Type: AcknowledgeInfo + +**Table 6.1.6.2.25: Definition of type AcknowledgeInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| sorMacIuIe | SorMac | C | 0..1 | Shall be present when the Acknowledgement is sent to acknowledge receipt of SorInfo. Shall be absent when sorTransparentContainer is present. | | +| upuMacIuIe | UpuMac | C | 0..1 | Shall be present when the Acknowledgement is sent to acknowledge receipt of UpuInfo. Shall be absent when upuTransparentContainer is present. | | +| provisioningTime | DateTime | M | 1 | the provisioning time is used to correlate the acknowledgement with the modification request, to address glare cases when multiple modifications are ongoing simultaneously. | | +| sorTransparentContainer | SorTransparentContainer | C | 0..1 | This attribute contains SoR transparent container as received from UE, encoded as defined in clause 6.1.6.3.2 and shall be present when sent to acknowledge receipt of SorInfo, if the UDM supports receiving SoR Transparent Container. | sorTransparentSupport | +| ueNotReachable | boolean | O | 0..1 | Transmission of SorInfo / UE Parameter Update data to the UE was not successful due to the UE not being reachable.
default: false
may be present if sorMacIuIe and upuMacIuIe and sorTransparentContainer are absent. | | +| upuTransparentContainer | UpuTransparentContainer | C | 0..1 | This attribute contains UE Parameter Update transparent container as received from UE, encoded as defined in clause 6.1.6.3.2 and shall be present when sent to acknowledge receipt of UpuInfo, if the UDM supports receiving UE Parameter Update Transparent Container. | upuTransparentSupport | + +##### 6.1.6.2.26 Type: SorInfo + +**Table 6.1.6.2.26: Definition of type SorInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| ackInd | AckInd | M | 1 | Contains the indication on whether an acknowledgement from UE is to be requested to the UE.
If sorTransparentContainer is present, the AMF should ignore the value of ackInd on Nudm. | | +| sorMacIausf | SorMac | C | 0..1 | Contains the SoR-MAC-IAUSF. Shall be present when SorInfo is sent within AccessAndMobilitySubscriptionData on Nudm, and shall be absent when sent on Nudr or within PpData. Shall be absent when sorTransparentContainer is present. | | +| countersor | CounterSor | C | 0..1 | Contains the CounterSoR. Shall be present when SorInfo is sent within AccessAndMobilitySubscription on Nudm, and shall be absent when sent on Nudr or within PpData.
Shall be absent when sorTransparentContainer is present. | | +| steeringContainer | SteeringContainer | C | 0..1 | When present, this information contains the information needed to update the "Operator Controlled PLMN Selector with Access Technology" list stored in the USIM either as an array of preferred PLMN/AccessTechnologies combinations in priority order (with the first entry in the array indicating the highest priority and the last entry indicating the lowest) or a secured packet.
If no change of the "Operator Controlled PLMN Selector with Access Technology" list stored in the USIM is needed, then this attribute shall be absent.
This attribute shall be present when SorInfo is sent within PpData.
Shall be absent when sorTransparentContainer is present. | | +| provisioningTime | DateTime | M | 1 | Point in time of SorInfo provisioning at the UDR or SOR-AF. | | +| sorTransparentContainer | SorTransparentContainer | C | 0..1 | This attribute contains protected SoR transparent container encoded as defined in clause 6.1.6.3.2 and shall be present when sent on Nudm, if NF Consumer (e.g. AMF) supports receiving SoR information encoded as transparent containers. Shall be absent when sent on Nudr or within PpData. | sorTransparentSupport | +| sorCmci | SorCmci | O | 0..1 | When present, provides the SOR-CMCI values as defined in 3GPP TS 24.501 [27]

This attribute may be present on Nudr, Nsoraf, PpData. Shall be absent on Nudm (since the content on Nudm is provided within sorTransparentContainer) | | + +| | | | | | +|----------------------|-------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| storeSorCmciInMe | boolean | O | 0..1 |

When present, indicates "Store the SOR-CMCI in the ME", i.e. whether to instruct UE to store SOR-CMCI in the ME as defined in 3GPP TS 23.122 [14] and 3GPP TS 24.501 [27].

  • - True: Indicates to store the SOR-CMCI in the ME
  • - False or absent: Indicates storing the SOR-CMCI in the ME is not required

This attribute may be present on Nudr, Nsoraf, PpData. Shall be absent on Nudm (since the content on Nudm is provided within sorTransparentContainer)

| +| usimSupportOfSorCmci | boolean | O | 0..1 |

When present, indicates "USIM support of SOR-CMCI" based on pre-configuration.

  • - True: Indicates that USIM supports SOR-CMCI
  • - False or absent: Indicates that USIM does not support SOR-CMCI

This attribute may be present on Nudr. Shall be absent on Nudm (since the content on Nudm is provided within sorTransparentContainer)

| +| sorSnpnSiLs | SorSnpnSiLs | O | 0..1 |

When present, provides the SOR-SNPN-SI-LS values as defined in 3GPP TS 24.501 [27].

This attribute may be present in Nudr, and Nudm_PP. Shall be absent in Nudm_SDM (since the content on Nudm is provided within sorTransparentContainer)

| +| sorSnpnSi | SorSnpnSi | O | 0..1 |

When present, provides the SOR-SNPN-SI values as defined in 3GPP TS 24.501 [27].

This attribute may be present in Nudr and Nudm_PP. Shall be absent in Nudm_SDM (since the content is provided within sorTransparentContainer).

| + +##### 6.1.6.2.27 Type: SharedData + +**Table 6.1.6.2.27-1: Definition of type SharedData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| sharedDataId | SharedDataId | M | 1 | Identifier of the shared data | | +| sharedAmData | AccessAndMobilitySubscriptionData | O | 0..1 | Shared Access and Mobility Subscription Data
sharedAmData shall not contain upuInfo, sorInfo, stnSr or cMsisdn. | | +| sharedSmsSubsData | SmsSubscriptionData | O | 0..1 | Shared SMS Subscription Data | | +| sharedSmsMngSubsData | SmsManagementSubscriptionData | O | 0..1 | Shared SMS Management Subscription Data | | +| sharedDnnConfigurations | map(DnnConfiguration) | O | 1..N | A map of shared DNN configuration (list of key-value pairs where DNN, or optionally the Wildcard DNN, serves as key) | | +| sharedTraceData | TraceData | O | 0..1 | Shared Trace Data | | +| sharedSnssaiInfos | map(SNSSAIInfo) | O | 1..N | A map of Shared SNSSAI Info (list of key-value pairs where singleNSSAI converted to string serves as key; see 3GPP TS 29.571 [7]) | | +| sharedVnGroupData | map(VnGroupData) | O | 1..N | A map of shared 5G VN group data (list of key-value pairs where GroupId serves as key; see clause 6.1.6.1). | | +| treatmentInstructions | map(SharedDataTreatmentInstruction) | O | 1..N | A map of SharedDataTreatmentInstructions (list of key-value pairs where a JSON pointer pointing to an attribute within the SharedData serves as key) | SharedDataTreatment | +| sharedSmSubsData | SessionManagementSubscriptionData | O | 0..1 | Shared Session Management Subscription Data | SharedSmSubsData | +| sharedEcsAddrConfigInfo | EcsAddrConfigInfo | O | 0..1 | Shared ECS Address Configuration Information | | + +NOTE 1: Exactly one of sharedAmData, sharedSmsSubsData, sharedSmsMngSubsData, sharedDnnConfigurations, sharedTraceData and sharedSnssaiInfos shall be present. + +NOTE 2: The attributes sharedAmData, sharedSmsSubsData and SharedSmsMngSubsData shall not contain sharedDataIds + +NOTE 3: When shared data clash with individual data, individual data shall take precedence as default treatment unless the feature SharedDataTreatment is supported and the SharedData contains treatment instructions different from the default treatment. + +##### 6.1.6.2.28 Type: PgwnInfo + +Table 6.1.6.2.28-1: Definition of type PgwnInfo + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | DNN/APN with Network Identifier only. | +| pgwFqdn | Fqdn | M | 1 | FQDN of the PGW in the "PGW-C+SMF" (NOTE) | +| pgwlpAddr | IpAddress | O | 0..1 | IP Address of the PGW in the "PGW-C+SMF" | +| plmnId | PlmnId | O | 0..1 | PLMN where the PGW-C+SMF is located | +| epdgInd | boolean | O | 0..1 | If present, it indicates whether access is from ePDG or not.
true: access is from ePDG.
false or absent: access is not from ePDG | +| pcfId | NfInstanceId | C | 0..1 | This IE shall be present if the PCF Selection Assistance Info is received from the UDM.

When present, it indicates the PCF identifier serving the PDU Session/PDN Connection that should be selected by the AMF. | +| registrationTime | DateTime | O | 0..1 | Time of PGW-C+SMF Registration (i.e. point in time when the HSS received SWx-SAR with SA_TYPE=REGISTRATION). May be present when used on Nhss within UeContextInPgwData. | +| wildcardInd | boolean | O | 0..1 | Indicates whether the PDN context is allocated for a wildcard DNN/APN case.
true: indicates that the PDN Context is allocated dynamically for a wildcard DNN/APN
false: indicates that the PDN Context is allocated for a distinct DNN/APN
Absence of this IE indicates to the receiver that the sender does not support sending this IE. | + +NOTE: This IE may contain an empty string when the PGW Information is mapped from HSS and PGW FQDN is not registered in HSS. + +##### 6.1.6.2.29 Type: TraceDataResponse + +Table 6.1.6.2.29-1: Definition of type TraceDataResponse + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------| +| traceData | TraceData | C | 0..1 | UE-individual trace data. Shall not be absent unless the feature SharedData is supported and traceData is present within shared data. | | +| sharedTraceDataId | SharedDataId | C | 0..1 | Shared data identifier. Shall be present if traceData is absent. | | + +##### 6.1.6.2.30 Type: SteeringContainer + +Table 6.1.6.2.30-1: Definition of type SteeringContainer as a list of mutually exclusive alternatives + +| Data type | Cardinality | Description | +|---------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| array(SteeringInfo) | 1..N | List of PLMN/AccessTechnologies combinations. | +| SecuredPacket | 1 | A Secured packet containing one or more APDUs commands dedicated to Remote File Management or command responses (see ETSI TS 102.225 [28]). | + +##### 6.1.6.2.31 Type: SdmSubsModification + +Table 6.1.6.2.31-1: Definition of type SdmSubsModification + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------|-----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| expires | DateTime | O | 0..1 | If present, indicates the point in time at which the subscription expires. Within a PATCH request the proposed new expiry time is conveyed. | +| monitoredResourceUris | array(Uri) | O | 1..N | If present, indicates the updated resources URIs to be monitored.
The URI shall take the form of either an absolute URI or an absolute-path reference as defined in IETF RFC 3986 [31].
See NOTE. | +| expectedUeBehaviourThresholds | map(ExpectedUeBehaviourThreshold) | O | 1..N | If present, indicates the updated expected UE behaviour threshold(s). The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | + +NOTE: The UDM should handle only the relative-path part (apiSpecificResourceUriPart, see 3GPP TS 29.501 [5] clause 4.4.1) and ignore possible inconsistencies in the base URI part. + +##### 6.1.6.2.32 Type: EmergencyInfo + +Table 6.1.6.2.32-1: Definition of type EmergencyInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| pgwFqdn | Fqdn | C | 0..1 | FQDN of the PGW-C+SMF for emergency session; either pgwFqdn or ipAddress shall be present. (NOTE) | +| pgwIpAddress | IpAddress | C | 0..1 | IP address of the PGW-C+SMF for emergency session (NOTE) | +| smfInstanceId | NfInstanceId | O | 0..1 | NF Instance Id of the SMF for emergency session (NOTE) | +| epdgInd | boolean | O | 0..1 | If present, it indicates whether access is from ePDG or not.
true: access is from ePDG.
false or absent: access is not from ePDG. | +| plmnId | PlmnId | O | 0..1 | PLMN where the PGW-C+SMF is located | + +NOTE: If the AMF fails to contact the SMF/PGW based on the provided information (pgwFqdn/pgwIpAddress/smfInstanceId) when needed, the AMF should use a locally configured SMF instance ID or SMF set ID for the SMF/PGW for emergency services. + +##### 6.1.6.2.33 Type: UpuInfo + +Table 6.1.6.2.33-1: Definition of type UpuInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| upuDataList | array(UpuData) | C | 1..N | This information defines the UE Parameters Update (UPU).
A secured packet with the Routing indicator update data is included and/or the Default configured NSSAI update data are included on Nudm.
An unsecured Routing indicator update data or secured packet with the Routing indicator update data, and/or the Default configured NSSAI update data, and/or Disaster Roaming Enabled Indication, and/or the indication of "applicability of "lists of PLMN(s) to be used in disaster condition" provided by a VPLMN" are included on Nudr.
Shall be absent when the NF Consumer (e.g. AMF) supports receiving UE Parameters Update information encoded as transparent containers, and the upuTransparentContainer attribute is present. | | +| upuRegInd | UpuRegInd | C | 0..1 | Contains the indication of whether the re-registration is requested.
Shall be absent when the NF Consumer (e.g. AMF) supports receiving UE Parameters Update information encoded as transparent containers, and the upuTransparentContainer attribute is present. | | +| upuAckInd | UpuAckInd | C | 0..1 | Contains the indication of whether the acknowledgement from UE is needed.
Shall be absent when the NF Consumer (e.g. AMF) supports receiving UE Parameters Update information encoded as transparent containers, and the upuTransparentContainer attribute is present. | | +| upuMacIausf | UpuMac | C | 0..1 | Contains the UPU-MAC-I AUSF . Shall be present when UpuInfo is sent within AccessAndMobilitySubscriptionData on Nudm, and shall be absent when sent on Nudr.
Shall be absent when the NF Consumer (e.g. AMF) supports receiving UE Parameters Update information encoded as transparent containers, and the upuTransparentContainer attribute is present. | | +| counterUpu | CounterUpu | C | 0..1 | Contains the Counter UPU . Shall be present when UpuInfo is sent within AccessAndMobilitySubscriptionData on Nudm, and shall be absent when sent on Nudr.
Shall be absent when the NF Consumer (e.g. AMF) supports receiving UE Parameters Update information encoded as transparent containers, and the upuTransparentContainer attribute is present. | | +| provisioningTime | DateTime | M | 1 | Point in time of provisioning of UPU by the UDR. | | +| upuTransparentContainer | UpuTransparent Container | C | 0..1 | This attribute contains protected UE Parameters Update transparent container encoded as defined in clause 6.1.6.3.2 and shall be present when sent on Nudm, if NF Consumer (e.g. AMF) supports receiving UE Parameters Update information encoded as transparent containers. Shall be absent when sent on Nudr or within PpData. | upuTransparent Support | + +##### 6.1.6.2.34 Type: GroupIdentifiers + +**Table 6.1.6.2.34-1: Definition of type GroupIdentifiers** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------| +| extGroupId | ExtGroupId | C | 0..1 | This IE shall contain the External Group ID associated to the provided Internal Group ID. | +| intGroupId | GroupId | C | 0..1 | This IE shall contain the Internal Group ID associated to the provided External Group ID.. | +| ueIdList | array(UeId) | C | 1..N | This IE shall contain a list of the UE identifiers that belong to the provided Internal/External Group ID if they are required. | + +##### 6.1.6.2.35 Type: NiddInformation + +**Table 6.1.6.2.35-1: Definition of type NiddInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aflId | string | M | 1 | The string identifying the AF as the owner of associated NIDD Configuration on T8 interface, which is carried in {scsAsId} URI variable in NIDD API (see clause 5.6.3.2.2 of 3GPP TS 29.122 [45]). | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier | +| extGroupId | ExternalGroupId | O | 0..1 | Indicates External Group Identifier which the user belongs to. | + +##### 6.1.6.2.36 Type: CagData + +Table 6.1.6.2.36-1: Definition of type CagData + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cagInfos | map(CagInfo) | M | 0..N |

A map (list of key-value pairs where PlmnId converted to string serves as key; see 3GPP TS 29.571 [7]) of CagInfo

An empty map indicates that for no PLMN CAG is subscribed and shall only be sent when provisioningTime is present (i.e. when acknowledgement from the UE is pending).

If provisioningTime is present (i.e. the acknowledgement from the UE is still pending), the complete map of CagInfo (i.e. for all PLMNs) shall be present; otherwise only the CagInfo relevant to the Serving PLMN should be present. (NOTE)

| +| provisioningTime | DateTime | C | 0..1 |

This attribute shall be present if the CagData is sent to the AMF while reception has not yet been acknowledged from the UE; otherwise shall be absent. Presence of this attribute indicates that the AMF needs to update the UE with the complete map of CagInfo.

This attribute serves as CAG information Subscription Change Indication

| +| conditionalCagInfos | map(ConditionalCagInfo) | C | 0..N |

A map (list of key-value pairs where PlmnId converted to string serves as key.

An empty map indicates that for no PLMN CAG is subscribed and shall only be sent when provisioningTime is present (i.e. when acknowledgement from the UE is pending).

If provisioningTime is present (i.e. the acknowledgement from the UE is still pending), the complete map of CagInfo (i.e. for all PLMNs) shall be present; otherwise only the CagInfo relevant to the Serving PLMN should be present. (NOTE)

| + +NOTE: 3GPP TS 23.501 [2] clause 5.30.3.3 indicates that the UE in a VPLMN shall ignore CAG information not relevant in the current VPLMN. Consequently, the UDM shall reset (i.e. set to "WAITING\_FOR\_ACK") the UE Update Status for CAG in the UDR when detecting a VPLMN change of the roaming UE, and the UDM shall send CAG data to the new AMF including provisioningTime (CAG information Subscription Change Indication) and the complete map of CagInfo. Similarly (see 3GPP TS 23.502 clause 5.4.1), the UDM shall reset the UE Update Status for CAG in the UDR when detecting a change of SUPI and PEI association. + +##### 6.1.6.2.37 Type: CagInfo + +Table 6.1.6.2.37-1: Definition of type CagInfo + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedCagList | array(CagId) | M | 1..N | List of allowed CAG Ids. | +| cagOnlyIndicator | boolean | O | 0..1 |

true indicates that the UE is restricted to only access 5GS via CAG cells;

absence and false indicate that the UE is not restricted to only access 5GS via CAG cells.

| + +##### 6.1.6.2.38 Type: AdditionalSnssaiData + +**Table 6.1.6.2.38-1: Definition of type AdditionalSnssaiData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| requiredAuthnAuthz | boolean | O | 0..1 | Indicates whether an S-NSSAI is subject to Network Slice-Specific Authentication and Authorization:
  • - true: subject to network slice-specific authentication and authorization
  • - false, or absent: not subject to network slice-specific authentication and authorization
| Nssaa | +| subscribedUeSliceMbr | SliceMbrRm | O | 0..1 | Indicates the subscribed UE-Slice-MBR for an S-NSSAI if the access type is 3GPP access. | Nsac | +| subscribedNsSrgList | array(NsSrg) | O | 1..N | Indicates the subscribed Network Slice Simultaneous Group values for an S-NSSAI. (NOTE 1) | Nssrg | +| nsacMode | NsacAdmissionMode | O | 0..1 | Indicates which NSAC admission mode shall be applied for roaming scenario (see 3GPP TS 23.501 [2] clause 5.15.11.3). | | +| validTimePeriod | ValidTimePeriod | O | 0..1 | If present, indicate the time period during which the S-NSSAI is valid.
If absent, indicates there is no time limitation for the S-NSSAI. | TempSliceSupport | +| deregInactTimer | DurationSec | O | 0..1 | Identifies the slice deregistration inactivity timer for the Network Slice identified by the sNssai IE (see TS 23.501 [8] clause 5.15.15.3). | | +| onDemand | boolean | O | 0..1 | Indicates whether the S-NSSAI is an On Demand slice:
  • - true: S-NSSAI is an On Demand slice.
  • - false or absent: not an On Demand slice.
| | + +NOTE 1: If the NF consumer does not support the Nssrg feature, the subset of the Subscribed S-NSSAIs as defined in clause 5.15.12 of 3GPP TS 23.501 [2], may be included without providing the subscribedNsSrgList information. i.e. UDM may send default S-NSSAIs and subscribed S-NSSAIs sharing all the NSSRGs of the Default S-NSSAIs as part of the subscription information. + +##### 6.1.6.2.39 Type: VnGroupData + +Table 6.1.6.2.39-1: Definition of type VnGroupData + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| pduSessionTypes | PduSessionTypes | O | 0..1 | Allowed session types | +| dnn | Dnn | O | 0..1 | Data Network Name with Network Identifier only.
(NOTE) | +| singleNssai | Snsai | O | 0..1 | Single Nssai | +| appDescriptors | array(AppDescriptor) | O | 1..N | List of Application Descriptors | +| secondaryAuth | boolean | O | 0..1 | Indicates whether secondary authentication and authorization is needed.
true: secondary authentication and authorization is needed.
false: secondary authentication and authorization is not needed.
If absent, it indicates that secondary authentication is not required by the NEF, but it still may be required by local policies at the SMF. | +| dnAaaIpAddressAllocation | boolean | O | 0..1 | Indicates whether the SMF is required to request the UE IP address from the DN-AAA server for PDU Session Establishment.
true: required
false: not required
If absent, it indicates that the request by SMF of the UE IP address from the DN-AAA server is not required, but it still may be required by local policies at the SMF. | +| dnAaaAddress | IpAddress | O | 0..1 | The IP address of the DN-AAA server, used for secondary authentication and authorization. | +| additionalDnAaaAddresses | array(IpAddress) | O | 1..N | Additional IP addresses of the DN-AAA server used for secondary authentication and authorization. | +| dnAaaFqdn | Fqdn | O | 0..1 | The FQDN of the DN-AAA server used for secondary authentication and authorization. | + +NOTE: Only a 1:1 mapping between DNN and 5G VN group is supported in this release + +##### 6.1.6.2.40 Type: AppDescriptor + +Table 6.1.6.2.40-1: Definition of type AppDescriptor + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------| +| osId | OsId | O | 0..1 | OS identifier, does not include an OS version number | +| appId | string | O | 0..1 | Application identifier, does not include a version number for the application | + +##### 6.1.6.2.41 Type: AppPortId + +Table 6.1.6.2.41-1: Definition of type AppPortId + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|----------------------------------------------------------------------------| +| destinationPort | Uint16 | O | 0..1 | Indicates the receiving port of application in the receiving device or AF. | +| originatorPort | Uint16 | O | 0..1 | Indicates the sending port of application in sending device. | + +##### 6.1.6.2.4.2 Type: LcsPrivacyData + +Table 6.1.6.2.4.2-1: Definition of type LcsPrivacyData + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lpi | Lpi | O | 0..1 | If present, indicates the Location Privacy Indication (see 3GPP TS 23.273 [38] clause 5.4.2.3)
If absent, indicates that location for UE is allowed. | +| unrelatedClass | UnrelatedClass | O | 0..1 | Indicates Call/Session unrelated Classes for the user (see 3GPP TS 23.273 [38] clause 5.4.2.2.3). | +| plmnOperatorClasses | array(PlmnOperatorClass) | O | 1..N | Indicates PLMN Operator Class for the user (see 3GPP TS 23.273 [38] clause 5.4.2.2.4). | +| evtRptExpectedArea | GeographicArea | O | 0..1 | Indicates the event report expected area. | +| areaUsageInd | AreaUsageInd | O | 0..1 | This IE may be present when event report expected area is present.

When present, this IE shall indicate one of the following mutually exclusive global settings on using event report expected area:
- Inside reporting (default)
- Outside reporting
(see 3GPP TS 23.273 [38] clause 5.14). | +| upLocRepIndAf | UpLocRepIndAf | O | 0..1 | Indication of one of the following mutually exclusive global settings:
- UE is allowed to report periodic or triggered location events via user plane to an LCS Client or AF
- UE is not allowed to report periodic or triggered location events via user plane to an LCS Client or AF (default)
If absent, indicates that the UE is not allowed to report periodic or triggered location events via user plane to an LCS Client or AF. | + +##### 6.1.6.2.4.3 Type: Lpi + +Table 6.1.6.2.4.3-1: Definition of type Lpi + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| locationPrivacyInd | LocationPrivacyInd | M | 1 | Indication of one of the following mutually exclusive global settings:
- Location is disallowed
- Location is allowed | +| validTimePeriod | ValidTimePeriod | O | 0..1 | If present, indicate Time period during which the Location Privacy Indication is valid.
If absent, indicates there is no time limitation. | + +##### 6.1.6.2.4.4 Type: UnrelatedClass + +Table 6.1.6.2.4.4-1: Definition of type UnrelatedClass + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|----------------------------------|---|--------------|-------------------------------------------------------------------------------------------------------------------------------| +| defaultUnrelatedClass | DefaultUnrelatedClass | M | 1 | The default Call/Session unrelated Class subscription for unidentified value added LCS clients or AFs. | +| externalUnrelatedClass | ExternalUnrelatedClass | O | 0..1 | The Call/Session unrelated Class subscriptions for identified value added LCS Clients, AFs and value added LCS Client groups. | +| serviceTypeUnrelatedClasses | array(ServiceTypeUnrelatedClass) | O | 1..X(NOTE 2) | The Call/Session unrelated Class subscriptions for identified service types for UE. (NOTE 1) | + +NOTE 1: It is possible that there are multiple serviceTypeUnrelatedClasses, whose maximum number is decided by total number of service type defined in 3GPP TS 22.071 [47]. + +NOTE 2: X indicates the total number of service type defined in 3GPP TS 22.071 [47]. + +##### 6.1.6.2.45 Type: PlmnOperatorClass + +**Table 6.1.6.2.45-1: Definition of type PlmnOperatorClass** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------| +| lcsClientClass | LcsClientClass | M | 1 | Indicated the PLMN operator class of LCS client that are allowed to locate the particular UE (see 3GPP TS 23.273 [38] clause 5.4.2.2.4). | +| lcsClientIds | array(LcsClientId) | M | 1..N | List of LCS clients for the corresponding LCS Client Class | + +##### 6.1.6.2.46 Type: ValidTimePeriod + +**Table 6.1.6.2.46-1: Definition of type ValidTimePeriod** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------| +| startTime | DateTime | O | 0..1 | If present, indicates the start time
If absent, indicates there is no start time, and it shall be valid immediately.
(NOTE 1) | +| endTime | DateTime | O | 0..1 | If present, indicates the end time.
If absent, indicates there is no end time.
(NOTE 1) | + +NOTE 1: The end time shall be later than start time. + +##### 6.1.6.2.47 Type: LcsMoData + +**Table 6.1.6.2.47-1: Definition of type LcsMoData** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|---------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------| +| allowedServiceClasses | array(LcsMoServiceClass) | M | 1..N | List of MO-LR services allowed for a UE subscriber | +| moAssistanceDataTypes | LcsBroadcastAssistanceTypesData | O | 0..1 | A list of one or more types of location assistance data that may be provided to the UE in the MO-LR procedure. | + +##### 6.1.6.2.48 Type: EcRestrictionDataWb + +**Table 6.1.6.2.48-1: Definition of type EcRestrictionDataWb** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ecModeARestricted | boolean | O | 0..1 | If present, indicates whether Enhanced Coverage Mode A is restricted or not.
true: Enhanced Coverage Mode A is restricted.
false or absent: Enhanced Coverage Mode A is not restricted. | +| ecModeBRestricted | boolean | O | 0..1 | If present, indicates whether Enhanced Coverage Mode B is restricted or not.
true: Enhanced Coverage Mode B is restricted.
false or absent: Enhanced Coverage Mode B is not restricted. | + +NOTE: At least one of the attributes ecModeARestricted and ecModeBRestricted shall be contained, and if the value of attribute ecModeARestricted is set to true, the value of attribute ecModeBRestricted shall be set to true. + +##### 6.1.6.2.49 Type: ExpectedUeBehaviourData + +**Table 6.1.6.2.49-1: Definition of type ExpectedUeBehaviourData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| stationaryIndication | StationaryIndication | O | 0..1 | Identifies whether the UE is stationary or mobile (see TS 23.502 [3] clause 4.15.6.3). | +| communicationDurationTime | DurationSec | O | 0..1 | Indicates for how long the UE will normally stay in CM-Connected for data transmission (see TS 23.502 [3] clause 4.15.6.3). | +| periodicTime | DurationSec | O | 0..1 | Identifies interval time of periodic communication (see TS 23.502 [3] clause 4.15.6.3). | +| scheduledCommunicationTime | ScheduledCommunicationTime | O | 0..1 | Identifies time and day of the week when the UE is available for communication (see TS 23.502 [3] clause 4.15.6.3). | +| scheduledCommunicationType | ScheduledCommunicationType | O | 0..1 | Indicates that the Scheduled Communication Type (see TS 23.502 [3] clause 4.15.6.3).
(NOTE 5) | +| expectedUmts | array(LocationArea) | O | 1..N | Identifies the UE's expected geographical movement. The attribute is only applicable in 5G (see TS 23.502 [3] clause 4.15.6.3).
(NOTE 3, NOTE 4) | +| trafficProfile | TrafficProfile | O | 0..1 | Identifies the type of data transmission: single packet transmission (UL or DL), dual packet transmission (UL with subsequent DL or DL with subsequent UL), multiple packets transmission | +| batteryIndication | BatteryIndication | O | 0..1 | Indicates the power consumption type(s) of the UE (see TS 23.502 [3] clause 4.15.6.3). | +| validityTime | DateTime | O | 0..1 | If present, identifies when the expected UE behaviour parameters expire and shall be deleted locally if it expires (see TS 23.502 [3] clause 4.15.6.3).
(NOTE 2) | +| confidenceLevel | string | O | 0..1 | When present, this IE indicates the Confidence level for the associated Expected UE Behaviour parameter.

The value shall be between 0.00 and 1.00 with a step size of 0.01, represented as string.

If not present, confidence level 1.00 applies.

Pattern: '^[0]\.[0-9]{2}\$ ^1.00\$' | +| accuracyLevel | string | O | 0..1 | When present, this IE indicates the accuracy level for the associated Expected UE Behaviour parameter.

The value shall be between 0.00 and 1.00 with a step size of 0.01, represented as string.

If not present, accuracy level 1.00 applies.

Pattern: '^[0]\.[0-9]{2}\$ ^1.00\$' | + +NOTE 1: At least one of optional parameters (except for validityTime) above shall be present. +NOTE 2: If this attribute is omitted, no expiry for the expected UE behaviour parameters applies. +NOTE 3: The first instance of the attribute represents the start of the location, and the last one represents the stop of the location. +NOTE 4: The parameter expectedUmts is only used by AMF. +NOTE 5: The value of attribute "scheduledCommunicationType" shall be used together with the value of "scheduledCommunicationTime". + +6.1.6.2.50 Void + +6.1.6.2.51 Void + +6.1.6.2.52 Type: SuggestedPacketNumDI + +**Table 6.1.6.2.52-1: Definition of type SuggestedPacketNumDI** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| suggestedPacketNumDI | integer | M | 1 | Value in number of packets. | +| validityTime | DateTime | O | 0..1 | If present, identifies the time to which the Network Configuration Parameters expire and shall be deleted locally if it expire (see TS 23.502 [3] clause 4.15.6.3a).
(NOTE 1) | + +NOTE 1: If this attribute is omitted, no expiry for the expected UE behaviour parameters applies. + +6.1.6.2.53 Void + +6.1.6.2.54 Type: FrameRouteInfo + +**Table 6.1.6.2.54-1: Definition of type FrameRouteInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|------------------------------| +| ipv4Mask | IPv4AddrMask | C | 0..1 | Indicates IPv4 address mask. | +| ipv6Prefix | Ipv6Prefix | C | 0..1 | Indicates IPv6 prefix. | + +NOTE: Either ipv4Mask or ipv6Prefix shall be present. + +6.1.6.2.55 Type: SorUpdateInfo + +**Table 6.1.6.2.55-1: SorUpdateInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-----------------------------| +| vplmnId | PlmnId | M | 1 | Serving node PLMN identity. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.1.8 | + +6.1.6.2.56 Type: EnhancedCoverageRestrictionData + +**Table 6.1.6.2.56-1: Definition of type EnhancedCoverageRestrictionData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| plmnEcInfoList | array(PlmnEcInfo) | O | 1..N | It may indicate a complete list of serving PLMNs where Enhanced Coverage Restriction shall be allowed and the detailed enhanced coverage restriction configuration under per the PLMN. | + +##### 6.1.6.2.57 Type: EdrxParameters + +**Table 6.1.6.2.57-1: EdrxParameters** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ratType | RatType | M | 1 | This IE shall indicate the RAT type which eDRX value are applicable to.

Only the following values are allowed:

"EUTRA"
"NBIOT"
"LTE-M"
"NR"
"NR_REDCAP" | +| edrxValue | string | M | 1 | This IE shall indicate eDRX Cycle length value, it shall be encoded as a string of bits 4 to 1 of octet 3 in the "Extended DRX parameter" IE (see Figure 10.5.5.32 of 3GPP TS 24.008 [46]).
Pattern: '^[0-1]{4}\$' | +| NOTE: The relationship between values of ratType and edrxValue shall be in line with clause 10.5.5.32 of 3GPP TS 24.008 [46]. | | | | | + +##### 6.1.6.2.58 Type: PtwParameters + +**Table 6.1.6.2.58-1: PtwParameters** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| operationMode | OperationMode | M | 1 | This IE shall indicate the Operation Mode which PTW value are applicable to. | +| ptwValue | string | M | 1 | This IE shall be applied only when the operation mode is set to WB-S1, NB-S1, and WB-N1 mode.
It shall indicate RAT specific Subscribed Paging Time Window length value, it shall be encoded as a string of bits 8 to 5 of octet 3 in the "Extended DRX parameter" IE (see Figure 10.5.5.32 of 3GPP TS 24.008 [46]).
Pattern: '^[0-1]{4}\$' | +| extendedPtwValue | string | C | 0..1 | This IE shall be applied only when the operation mode is set to NR-N1 mode.
It shall indicate RAT specific Subscribed Paging Time Window length value, it shall be encoded as a string of octet 4 in the "Extended DRX parameters" IE (see Figure 10.5.5.32 of 3GPP TS 24.008 [46]).

Pattern: '^[0-1]{8}\$'

When this IE is present, the value set in ptwValue attribute shall be omitted. | +| NOTE: The relationship between values of operationMode and ptwValue shall be in line with clause 10.5.5.32 of 3GPP TS 24.008 [46]. | | | | | + +6.1.6.2.59 Void + +6.1.6.2.60 Void + +6.1.6.2.61 Type: Void + +6.1.6.2.62 Type: ExternalUnrelatedClass + +**Table 6.1.6.2.62-1: Definition of type ExternalUnrelatedClass** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------| +| lcsClientExternals | array(LcsClientExternal) | O | 1..N | The list of Call/session Unrelated Class identified by LCS client in the external LCS client list for the list | +| afExternals | array(AfExternal) | O | 1..N | The list of Call/session Unrelated Class identified by AF in the external LCS client list | +| lcsClientGroupExternals | array(LcsClientGroupExternal) | O | 1..N | The list of Call/session Unrelated Class identified by LCS client group in the external LCS client list | + +6.1.6.2.63 Type: AfExternal + +**Table 6.1.6.2.63-1: Definition of type AfExternal** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------------------------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------| +| afId | AfId | O | 0..1 | AF Identifier (see 3GPP TS 23.273 [38] clause 5.4.2.2.3) | +| allowedGeographicArea | array(GeographicArea) | O | 1..N | Indicates Geographical area where positioning is allowed (see 3GPP TS 23.273 [38] clause 5.4.2.2.3). | +| privacyCheckRelatedAction | PrivacyCheckRelatedAction | O | 0..1 | Indicates action related to privacy check. (NOTE) | +| validTimePeriod | ValidTimePeriod | O | 0..1 | Time period when positioning is allowed | +| NOTE: "LOCATION_ALLOWED_WITHOUT_NOTIFICATION" is default value and "LOCATION_NOT_ALLOWED" is not optional for the attribute. | | | | | + +6.1.6.2.64 Type: LcsClientExternal + +**Table 6.1.6.2.64-1: Definition of type LcsClientExternal** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------------------------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------| +| lcsClientId | LcsClientId | O | 0..1 | Lcs Client Identifier (see 3GPP TS 23.273 [38] clause 5.4.2.2.3) | +| allowedGeographicArea | array(GeographicArea) | O | 1..N | Indicates Geographical area where positioning is allowed (see 3GPP TS 23.273 [38] clause 5.4.2.2.3). | +| privacyCheckRelatedAction | PrivacyCheckRelatedAction | O | 0..1 | Indicates action related to privacy check. (NOTE) | +| validTimePeriod | ValidTimePeriod | O | 0..1 | Time period when positioning is allowed | +| NOTE: "LOCATION_ALLOWED_WITHOUT_NOTIFICATION" is default value and "LOCATION_NOT_ALLOWED" is not optional for the attribute. | | | | | + +##### 6.1.6.2.65 Type: LcsClientGroupExternal + +**Table 6.1.6.2.65-1: Definition of type LcsClientGroupExternal** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------| +| lcsClientGroupId | ExtGroupId | O | 0..1 | LCS Client Group Identifier | +| allowedGeographicArea | array(GeographicArea) | O | 1..N | Indicates Geographical area where positioning is allowed (see 3GPP TS 23.273 [38] clause 5.4.2.2.3). | +| privacyCheckRelatedAction | PrivacyCheckRelatedAction | O | 0..1 | Indicates action related to privacy check.
(NOTE) | +| validTimePeriod | ValidTimePeriod | O | 0..1 | Time period when positioning is allowed | + +NOTE: "LOCATION\_ALLOWED\_WITHOUT\_NOTIFICATION" is default value and "LOCATION\_NOT\_ALLOWED" is not optional for the attribute. + +##### 6.1.6.2.66 Type: ServiceTypeUnrelatedClass + +**Table 6.1.6.2.66-1: Definition of type ServiceTypeUnrelatedClass** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| serviceType | LcsServiceType | M | 1 | One of the service type defined in 3GPP TS 22.071 [47]. | +| allowedGeographicArea | array(GeographicArea) | O | 1..N | Indicates Geographical area where positioning is allowed (see 3GPP TS 23.273 [38] clause 5.4.2.2.3). | +| privacyCheckRelatedAction | PrivacyCheckRelatedAction | O | 0..1 | Indicates action related to privacy check.
(NOTE) | +| codeWordInd | CodeWordInd | O | 0..1 | Indication that codeword shall be checked in UE or one or more codeword values to be checked in GMLC | +| validTimePeriod | ValidTimePeriod | O | 0..1 | Time period when positioning is allowed | +| codeWordList | array(CodeWord) | C | 1..N | This IE shall be present when codeWordInd is "CODEWORD_CHECK_IN_GMLC".

When present, this IE shall contain one or more CodeWords used by GMLC for verification. | + +NOTE: "LOCATION\_ALLOWED\_WITHOUT\_NOTIFICATION" is default value and "LOCATION\_NOT\_ALLOWED" is not optional for the attribute. + +##### 6.1.6.2.67 Type: Ueld + +**Table 6.1.6.2.67-1: Definition of type Ueld** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|--------------------------------------------------------------------------| +| supi | Supi | M | 1 | This IE shall indicate the SUPI. | +| gpsiList | array(Gpsi) | O | 1..N | This IE shall indicate a list of GPSIs that is associated with the SUPI. | + +##### 6.1.6.2.68 Type: DefaultUnrelatedClass + +Table 6.1.6.2.68-1: Definition of type DefaultUnrelatedClass + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedGeographicArea | array(GeographicArea) | O | 1..N | Indicates Geographical area where positioning is allowed (see 3GPP TS 23.273 [38] clause 5.4.2.2.3). | +| privacyCheckRelatedAction | PrivacyCheckRelatedAction | O | 0..1 | Indicates action related to privacy check.
(NOTE) | +| codeWordInd | CodeWordInd | O | 0..1 | Indication that codeword shall be checked in UE or one or more codeword values to be checked in GMLC | +| validTimePeriod | ValidTimePeriod | O | 0..1 | Time period when positioning is allowed | +| codeWordList | array(CodeWord) | C | 1..N | This IE shall be present when codeWordInd is present with value "CODEWORD_CHECK_IN_GMLC".

When present, this IE shall contain one or more CodeWords used by GMLC for verification. | + +NOTE: "LOCATION\_NOT\_ALLOWED" is default value and only values "LOCATION\_NOT\_ALLOWED", "LOCATION\_ALLOWED\_WITHOUT\_NOTIFICATION", "LOCATION\_ALLOWED\_WITHOUT\_RESPONSE", "LOCATION\_RESTRICTED\_WITHOUT\_RESPONSE" can be contained. + +##### 6.1.6.2.69 Type: ContextInfo + +Table 6.1.6.2.69-1: Definition of type ContextInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| origHeaders | array(string) | O | 1..N | Headers received by the UDM from NFs consuming Nudm services. The encoding of the header shall comply with clause 3.2 of IETF RFC 9110 [50] | +| requestHeaders | array(string) | O | 1..N | Headers sent by the UDM to NFs (e.g. AMF). The encoding of the header shall comply with clause 3.2 of IETF RFC 9110 [50] | + +##### 6.1.6.2.70 Type: UeContextInAmfData + +Table 6.1.6.2.70-1: Definition of type UeContextInAmfData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------|---------------| +| epsInterworkingInfo | EpsInterworkingInfo | O | 0..1 | This IE contains the associations between APN/DNN and PGW-C+SMF selected by the AMF for EPS interworking. | | +| amfInfo | array(AmfInfo) | O | 0..2 | This IE shall contain the list of AmfInfo. | ENA | + +NOTE: If sdmSubscription contains nfChangeFilter flag, then the UDM shall suppress the change notification for the epsInterworkingInfo + +##### 6.1.6.2.71 Type: V2xSubscriptionData + +**Table 6.1.6.2.71-1: Definition of type V2xSubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|------------------|----------|--------------------|-----------------------------------------------------------------------------------| +| nrV2xServicesAuth | NrV2xAuth | O | 0..1 | Indicates whether the UE is authorized to use the NR sidelink for V2X services. | +| lteV2xServicesAuth | LteV2xAuth | O | 0..1 | Indicates whether the UE is authorized to use the LTE sidelink for V2X services. | +| nrUePc5Ambr | BitRate | O | 0..1 | Indicates UE-PC5-AMBR for V2X communication over PC5 reference point for NR PC5. | +| ltePc5Ambr | BitRate | O | 0..1 | Indicates UE-PC5-AMBR for V2X communication over PC5 reference point for LTE PC5. | + +##### 6.1.6.2.72 Type: LcsBroadcastAssistanceTypesData + +**Table 6.1.6.2.72-1: Definition of type LcsBroadcastAssistanceTypesData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +|----------------|-----------|---|-------------|-------------| + +| | | | | | +|------------------------|-------|---|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| locationAssistanceType | Bytes | M | 1 |

This IE contains a bitmap ,encoded as a base64 string, which indicates the broadcast location assistance data types for which the UE is subscribed to receive ciphering keys used to decipher broadcast assistance data. A bit set to 1 indicates that the UE is subscribed to receive ciphering keys applicable to corresponding positioning SIB type.

The bits are ordered as following in the bitmap:

  • - first octet is the right-most octet. E.g. in "0x0123", "first octet" would be "0x23" and "second octet" would be "0x01"
  • - bit 1 is the right-most bit and bit 8 is the left-most bit in the octet. E.g. for octet "0x01", "bit 1" would be "1", and "bit 2" to "bit 8" would be "0"

The mapping of the bits to the positioning SIB types is as follows:

  • -- bit 8 in the first octet maps to positioning SIB Type 1-1
  • -- bit 7 in the first octet maps to positioning SIB Type 1-2
  • -- bit 6 in the first octet maps to positioning SIB Type 1-3
  • -- bit 5 in the first octet maps to positioning SIB Type 1-4
  • -- bit 4 in the first octet maps to positioning SIB Type 1-5
  • -- bit 3 in the first octet maps to positioning SIB Type 1-6
  • -- bit 2 in the first octet maps to positioning SIB Type 1-7
  • -- bit 1 in the first octet maps to positioning SIB Type 1-8
  • -- bit 8 in the second octet maps to positioning SIB Type 2-1
  • -- bit 7 in the second octet maps to positioning SIB Type 2-2
  • -- bit 6 in the second octet maps to positioning SIB Type 2-3
  • -- bit 5 in the second octet maps to positioning SIB Type 2-4
  • -- bit 4 in the second octet maps to positioning SIB Type 2-5
  • -- bit 3 in the second octet maps to positioning SIB Type 2-6
  • -- bit 2 in the second octet maps to positioning SIB Type 2-7
  • -- bit 1 in the second octet maps to positioning SIB Type 2-8
  • -- bit 8 in the third octet maps to positioning SIB Type 2-9
  • -- bit 7 in the third octet maps to positioning SIB Type 2-10
  • -- bit 6 in the third octet maps to positioning SIB Type 2-11
  • -- bit 5 in the third octet maps to positioning SIB Type 2-12
  • -- bit 4 in the third octet maps to positioning SIB Type 2-13
  • -- bit 3 in the third octet maps to positioning SIB Type 2-14
  • -- bit 2 in the third octet maps to positioning SIB Type 2-15
| +|------------------------|-------|---|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-----------------------------------------------------------------------------------------------------------------------|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | -- bit 1 in the third octet maps to positioning SIB Type 2-16
-- bit 8 in the fourth octet maps to positioning SIB Type 2-17
-- bit 7 in the fourth octet maps to positioning SIB Type 2-18
-- bit 6 in the fourth octet maps to positioning SIB Type 2-19
-- bit 5 in the fourth octet maps to positioning SIB Type 2-20
-- bit 4 in the fourth octet maps to positioning SIB Type 2-21
-- bit 3 in the fourth octet maps to positioning SIB Type 2-22
-- bit 2 in the fourth octet maps to positioning SIB Type 2-23
-- bit 1 in the fourth octet maps to positioning SIB Type 2-24

-- bit 7 in the fifth octet maps to positioning SIB Type 2-25
-- bit 6 in the fifth octet maps to positioning SIB Type 3-1
-- bit 5 in the fifth octet maps to positioning SIB Type 4-1
-- bit 4 in the fifth octet maps to positioning SIB Type 5-1
-- bit 3 in the fifth octet maps to positioning SIB Type 6-1
-- bit 2 in the fifth octet maps to positioning SIB Type 6-2
-- bit 1 in the fifth octet maps to positioning SIB Type 6-3

Any unassigned bits are spare and shall be coded as zero. Non-included bits shall be treated as being coded as zero. | +| NOTE: The mapping of posSibType to assistance data element is further described in clause 7.2 of 3GPP TS 37.355 [56]. | | | | | + +##### 6.1.6.2.73 Type: DatasetNames + +**Table 6.1.6.2.73-1: Definition of type DatasetNames** + +| Data type | Cardinality | Description | +|--------------------|-------------|--------------------------------| +| array(DataSetName) | 2..N | List of names of the data sets | + +##### 6.1.6.2.74 Type: PlmnRestriction + +**Table 6.1.6.2.74-1: Definition of type PlmnRestriction** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ratRestrictions | array(RatType) | O | 0..N | List of RAT Types that are restricted in 5GC and EPC; see 3GPP TS 29.571 [7]
Contains unique items | | +| forbiddenAreas | array(Area) | O | 0..N | List of forbidden areas in 5GS | | +| serviceAreaRestriction | ServiceAreaRestriction | O | 0..1 | Subscribed Service Area Restriction | | +| coreNetworkTypeRestrictions | array(CoreNetworkType) | O | 0..N | List of Core Network Types that are restricted. The use of the value "5GC" is deprecated on Nudm and shall be discarded by the receiving AMF. | | +| accessTypeRestrictions | array(AccessType) | O | 0..2 | List of Access Types that are restricted. | | +| primaryRatRestrictions | array(RatType) | O | 0..N | List of RAT Types that are restricted for use as primary RAT in 5GC and EPC; see 3GPP TS 29.571 [7]
Contains unique items | | +| secondaryRatRestrictions | array(RatType) | O | 0..N | List of RAT Types that are restricted for use as secondary RAT in 5GC and EPC; see 3GPP TS 29.571 [7]
Contains unique items | | + +##### 6.1.6.2.75 Type: PcfSelectionAssistanceInfo + +**Table 6.1.6.2.75-1: Definition of type PcfSelectionAssistanceInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------| +| dnn | Dnn | M | 1 | Identifies a DNN. | +| singleNssai | Snssai | M | 1 | Identifies a S-NSSAI. | + +##### 6.1.6.2.76 Type: ProseSubscriptionData + +**Table 6.1.6.2.76-1: Definition of type ProseSubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| proseServiceAuth | ProseServiceAuth | O | 0..1 | Indicates whether the UE is authorized to use ProSe related services. | +| nrUePc5Ambr | BitRate | O | 0..1 | Indicates the AMBR of UE's NR sidelink (i.e. PC5) communication for ProSe services. | +| proseAllowedPlmn | array(ProSeAllowedPlmn) | O | 1..N | Contains a list of the ProSeAllowedPlmn which contain the PLMN identities where the Prose services are authorised to use and the authorised Prose services on these given PLMNs. | + +##### 6.1.6.2.77 Type: IpIndex + +**Table 6.1.6.2.77-1: Definition of type IpIndex as a list of non-exclusive alternatives** + +| Data Type | Cardinality | Description | +|-----------|-------------|----------------------------------------| +| integer | 1 | IP Index expressed as an integer value | +| string | 1 | IP Index expressed as a string | + +##### 6.1.6.2.78 Type: AerialUeSubscriptionInfo + +Table 6.1.6.2.78-1: Definition of type AerialUeSubscriptionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| aerialUeInd | AerialUeIndication | M | 1 | This IE shall indicate Aerial service for the UE is allowed or not allowed. | | +| 3gppUavId | Gpsi | C | 0..1 | When present, this IE shall contain the 3GPP UAV ID, it is encoded as GPSI in the format of External Identifier.

If aerialUeInd indicates "AERIAL_UE_ALLOWED", this IE shall be present. | | + +##### 6.1.6.2.79 Type: SmSubsData + +Table 6.1.6.2.79-1: Definition of type SmSubsData as a list of alternatives + +| Data type | Cardinality | Description | Applicability | +|------------------------------------------|-------------|--------------------------------------------------|------------------| +| array(SessionManagementSubscriptionData) | 1..N | Individual Session Management Subscription Data. | | +| ExtendedSmSubsData | 1 | Extended Session Management Subscription Data. | SharedSmSubsData | + +##### 6.1.6.2.80 Type: ExtendedSmSubsData + +Table 6.1.6.2.80-1: Definition of type ExtendedSmSubsData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|------------------------------------------|---|-------------|----------------------------------------------------------|------------------| +| individualSmSubsData | array(SessionManagementSubscriptionData) | O | 1..N | individual Session Management Subscription Data (NOTE 1) | SharedSmSubsData | +| sharedSmSubsDataId | array(SharedDataId) | M | 1..N | Identifier of shared data | SharedSmSubsData | + +NOTE 1: A given UE-individual SessionManagementSubscriptionData (within individualSmSubsData) may clash with a shared SessionManagementSubscriptionData (i.e. both have the same singleNssai value). In this case the clashing attributes of the UE-individual SessionManagementSubscriptionData take precedence unless treatment instructions indicate otherwise. + +##### 6.1.6.2.81 Type: AmfInfo + +Table 6.1.6.2.81-1: Definition of type AmfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|--------------------------------------------------| +| amfInstanceId | NfInstanceId | M | 1 | The identity the AMF uses to register in the NRF | +| guami | Guami | M | 1 | This IE shall contain the serving AMF's GUAMI. | +| accessType | AccessType | M | 1 | This IE shall contain the access type | + +##### 6.1.6.2.82 Type: ProSeAllowedPlmn + +**Table 6.1.6.2.82-1: Definition of type ProSeAllowedPlmn** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| visitedPlmn | PlmnId | M | 1 | This IE shall contain the PLMN identity where the UE is authorised for 5G ProSe services. | +| proseDirectAllowed | array(ProseDirect Allowed) | O | 1..N | When present, this IE contains the 5G ProSe Direct services are authorised to use in the PLMN indicated by visitedPlmn for the UE.

If this IE is absent, it indicates that all the 5G ProSe Direct services are authorised to use in the PLMN indicated by visitedPlmn for the UE. | + +##### 6.1.6.2.83 Type: ImmediateReport + +**Table 6.1.6.2.83-1: Definition of type ImmediateReport as a list of alternatives** + +| Data type | Cardinality | Description | Applicability | +|----------------------|-------------|--------------------------------------------------------------------------|---------------| +| SubscriptionDataSets | 1 | UE based subscription data sets that to be monitored in SdmSubscription. | | +| array(SharedData) | 1..N | Shared subscription data sets that to be monitored in SdmSubscription. | | + +##### 6.1.6.2.84 Type: MbsSubscriptionData + +**Table 6.1.6.2.84-1: Definition of type MbsSubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsAllowed | boolean | C | 0..1 | This IE indicates whether the UE is authorized to receive multicast MBS session data.

When present, this IE shall be set as following:
- true: the UE is authorized to receive multicast MBS session data
- false (default): UE is not authorized to receive multicast MBS session data | +| mbsSessionIdList | array(MbsSessionId) | C | 1..N | This IE shall be present if available and the mbsAllowed attribute is set to "true".
If present, this IE identifies the MBS Session(s) that the UE is allowed to join. | +| ueMbsAssistanceInfo | array(MbsSessionId) | O | 1..N | When present, this IE shall contain a list of MBS session Ids which are eligible for MBS assistance as specified in 3GPP TS 23.247 [59]. | + +##### 6.1.6.2.85 Type: UcSubscriptionData + +**Table 6.1.6.2.85-1: Definition of type UcSubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------| +| userConsentPerPurposeList | map(UserConsent) | O | 1..N | A map user consent (list of key-value pairs where UcPurpose serves as key; see clause 6.1.6.3.20). | + +##### 6.1.6.2.86 Type: UeContextInSmfDataSubFilter + +Table 6.1.6.2.86-1: Definition of type UeContextInSmfDataSubFilter + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnnList | array(Dnn) | C | 1..N | This IE shall be present to get the pduSesion and pgwInfo in UeContextInSmfData for specific DNN(s).

When present, the UDM shall notify the changes of pduSesion and pgwInfo in UeContextInSmfData for the indicated DNN(s).

When this IE is not present, the UDM will not notify changes of pduSesion and pgwInfo. | +| snssaiList | array(SNSSAI) | O | 1..N | This IE may be present when dnnList IE is present.

When present, the UDM shall notify the changes of pduSesion and pgwInfo in UeContextInSmfData for the DNN(s) that are associated the indicated S-NSSAI(s). | +| emergencyInd | boolean | C | 0..1 | This IE shall be present and set to value "true" for changes on the emergencyInfo in UeContextInSmfData.

When present, this IE shall indicate whether the UDM shall notify the changes on emergencyInfo in UeContextInSmfData:
- true: changes on emergencyInfo to be notified
- false (default) changes on emergencyInfo not to be notified. | + +##### 6.1.6.2.87 Type: UeIdentifiers + +Table 6.1.6.2.87-1: Definition of type UeIdentifiers + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| ueIdList | map(SupiInfo) | C | 1..N | A map (list of key-value pairs where Gpsi serves as key; see 3GPP TS 29.571 [7]) of arrays of Supi. | + +##### 6.1.6.2.88 Type: SupiInfo + +Table 6.1.6.2.88-1: Definition of type SupiInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supiList | array(Supi) | M | 0..N | This IE shall indicate a list of SUPIs that is associated with the GPSI.
An empty array shall be returned if there is no SUPIs associated with the GPSI. | + +##### 6.1.6.2.89 Type: TimeSyncData + +**Table 6.1.6.2.89-1: Definition of type TimeSyncData** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------|---------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| authorized | boolean | M | 1 | Access Stratum Time Synchronization Service Authorization
this IE shall be set as follows:
- true: The service is authorized
- false: The service is not authorized | +| uuTimeSyncErrBdgt | UInteger | O | 0..1 | Indicates the Uu time synchronization error budget for the time synchronization service in units of nanoseconds. | +| tempVals | array(TemporalValidity) | O | 1..N | Contains start and stop times | +| coverageArea | array(Tai) | O | 1..N | List of TAI | +| clockQualityDetailLevel | ClockQualityDetailLevel | O | 0..1 | If present, clockQualityDetailLevel indicates which clock quality information is to be provided to the UE. It comprises one of the following values:
CLOCK_QUALITY_METRICS or
ACCEPT_INDICATION. | +| clockQualityAcceptanceCriteria | array(ClockQualityAcceptanceCriteria) | O | 1..N | Clock Quality Acceptance Criteria | + +##### 6.1.6.2.90 Type: TimeSyncSubscriptionData + +**Table 6.1.6.2.90-1: Definition of type TimeSyncSubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------| +| afReqAuthorizations | array(AfRequestAuthorization) | M | 1..N | Indicates whether the UE is authorized for AF-requested time synchronization services. | +| serviceIds | array(TimeSyncServiceId) | M | 1..N | Subscribed time synchronization service IDs | + +##### 6.1.6.2.91 Type: AfRequestAuthorization + +**Table 6.1.6.2.91-1: Definition of type AfRequestAuthorization** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------| +| gntpAllowedInfo | GntpAllowedInfo | C | 0..1 | Contains the information whether gntp based time synchronization services are allowed. | +| astiAllowedInfo | AstiAllowedInfo | C | 0..1 | Contains the information whether ASTI based time synchronization services are allowed. | + +NOTE: Either the GntpAllowedInfo or AstiAllowedInfo shall be present. + +##### 6.1.6.2.92 Type: TimeSyncServiceId + +**Table 6.1.6.2.92-1: Definition of type TimeSyncServiceId** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | C | 0..1 | DNN (NOTE) | +| sNssai | Snsai | C | 0..1 | Single NSSAI (NOTE) | +| reference | string | M | 1 | Reference to a PTP instance configuration | +| tempVals | array(TemporalValidity) | O | 1..N | Contains start and stop times | +| coverageArea | array(Tai) | O | 1..N | Time Synchronization Coverage Area | +| uUTimeSyncErrBdgt | UInteger | O | 0..1 | Indicates the Uu time synchronization error budget for the time synchronization service in units of nanoseconds. | + +NOTE: dnn and sNssai shall not both be absent. + +##### 6.1.6.2.93 Type: LcsSubscriptionData + +**Table 6.1.6.2.93-1: Definition of type LcsSubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| configuredLmfId | LMFIdentification | O | 0..1 | Identification of an LMF that is configured to serve the UE. | +| pruInd | PruInd | O | 0..1 | This IE indicates whether the UE is allowed to serve as a PRU.
If the UE is allowed to serve as a PRU, the IE indicates the type of PRU. | +| lpHapType | LpHapType | O | 0..1 | This IE with value set to "LOW_POW_HIGH_ACCU_POS" indicates low power and high accuracy positioning is requested for the UE. | +| userPlanePosIndLmf | boolean | O | 0..1 | This IE indicates whether the UE is allowed to use the user plane positioning between UE and LMF.

true: UE is allowed to use the user plane positioning between UE and LMF.
false or absent: UE is not allowed to use the user plane positioning between UE and LMF. | + +##### 6.1.6.2.94 Type: ConditionalCagInfo + +**Table 6.1.6.2.94-1: Definition of type ConditionalCagInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedCagList | array(CagId) | M | 1..N | List of allowed CAG Ids. | +| cagOnlyIndicator | boolean | O | 0..1 | true indicates that the UE is restricted to only access 5GS via CAG cells;

absence and false indicate that the UE is not restricted to only access 5GS via CAG cells. | +| validTimePeriod | ValidTimePeriod | O | 0..1 | When present, this IE shall include the Valid Time Period for time duration restriction indicating when the UE can access the CAG cells. | + +6.1.6.2.95 Void + +6.1.6.2.96 Void + +6.1.6.2.97 Type: RangingSIPosSubscriptionData + +**Table 6.1.6.2.97-1: Definition of type RangingSIPosSubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------| +| rangingSIPosAuth | RangingSIPosAuth | O | 0..1 | Indicates whether the UE is authorized to use Ranging/SL related services. | +| rangingSIPosPlmn | array(RangingSIPosPlmn) | O | 1..N | Contains a list of the RangingSIPosPlmn authorized for Ranging/SL Positioning services. | +| rangingSIPosQos | RangingSIPosQos | O | 0..1 | Ranging/SL positioning QoS parameters. | + +6.1.6.2.98 Type: RangingSIPosPlmn + +**Table 6.1.6.2.98-1: Definition of type RangingSIPosPlmn** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| rangingSIPosPlmn | PlmnId | M | 1 | This IE shall contain the PLMN identity where the UE is authorised for Ranging/SL Positioning services. | +| rangingSIPosAllowed | array(RangingSIPosAllowed) | O | 1..N |

When present, this IE contains the Ranging/SL Positioning services are authorised to use in the PLMN indicated by rangingSIPosPlmn for the UE.

If this IE is absent, it indicates that all the 5G Ranging/SL Positioning services are authorised to use in the PLMN indicated by rangingSIPosPlmn for the UE.

| + +##### 6.1.6.2.99 Type: AppSpecificExpectedUeBehaviourData + +**Table 6.1.6.2.99-1: Definition of type AppSpecificExpectedUeBehaviourData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| appId | ApplicationId | C | 0..1 | Application Identifier
(NOTE 2) | +| trafficFilters | array(FlowInfo) | C | 1..N | Identifies IP packet filters.
(NOTE 2) | +| expectedInactivityTime | DurationSec | C | 0..1 | Identifies the expected PDU Session Inactivity time during which the UE will not have traffic related to the application (see TS 23.502 [3] clause 4.15.6.3)

(NOTE 1) | +| validityTime | DateTime | O | 0..1 | When present, this IE identifies when the expected UE behaviour parameter expires and shall be deleted locally if it expires (see TS 23.502 [3] clause 4.15.6.3).

If not present, no expiry of the parameter applies. | +| confidenceLevel | string | O | 0..1 | When present, this IE indicates the Confidence level for the associated Expected UE Behaviour parameter.

The value shall be between 0.00 and 1.00 with a step size of 0.01, represented as string.

If not present, confidence level 1.00 applies.

Pattern: '[0]{1}[0-9]{2}\$ ^1.00\$' | +| accuracyLevel | string | O | 0..1 | When present, this IE indicates the accuracy level for the associated Expected UE Behaviour parameter.

The value shall be between 0.00 and 1.00 with a step size of 0.01, represented as string.

If not present, accuracy level 1.00 applies.

Pattern: '[0]{1}[0-9]{2}\$ ^1.00\$' | + +NOTE 1: In this version of specification, this attribute shall be present. The parameter is defined as conditional from future compatibility point of view. + +NOTE 2: At least one of "appId" or "trafficFilters" shall be present. + +6.1.6.2.100 Type: ExpectedUeBehaviourThreshold + +**Table 6.1.6.2.100-1: Definition of type ExpectedUeBehaviourThreshold** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|-----------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| expectedUeBehaviourDatasets | array(ExpectedUeBehaviourDataset) | O | 1..N | Name of the Expected UE Behaviour Parameter

This IE may not be present when parameter thresholdConditions is present. | +| singleNssais | array(Snssai) | O | 0..1 | A single Network Slice Selection Assistance Information.

This IE may be present when specifying SM specific Expected UE Behaviour Parameters. | +| dnns | array(Dnn) | O | 0..1 | Identifies a DNN.

This IE may be present when specifying SM specific Expected UE Behaviour Parameters. | +| confidenceLevel | string | C | 0..1 | When present, this IE indicates the Confidence level for the associated Expected UE Behaviour parameter.

The confidence level is a string formatted as {operator}+{value}.

The following operators shall be supported:

"=" match parameter value equal to the value indicated.
">" match parameter value greater than the value indicated
">=" match parameter value greater than or equal to the value indicated
"<" match parameter value less than the value indicated
"<=" match parameter value less than or equal to the value indicated

If no operator or an unknown operator is provided, "=" operator is applied.

The value shall be between 0.01 and 1.00 with a step size of 0.01.

The string can be extended by using '&' operator as below:

{operator}+{value}&{operator}+{value}

Examples:

Case1: "=0.5" or "0.5" means matching the value "0.5"
Case2: ">0.6" means value greater than "0.6"
Case3: ">0.2&<0.4" means the value in the range of "0.2" and "0.4".
(NOTE 1) | + +| | | | | | +|---------------|--------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| accuracyLevel | string | C | 0..1 |

When present, this IE indicates the accuracy level for the associated Expected UE Behaviour parameter.

The accuracy level is a string formatted as {operator}+{value}.

The following operators shall be supported:

"=" match parameter value equal to the value indicated.
">" match parameter value greater than the value indicated
">=" match parameter value greater than or equal to the value indicated
"<" match parameter value less than the value indicated
"<=" match parameter value less than or equal to the value indicated

If no operator or an unknown operator is provided, "=" operator is applied.

The value shall be between 0.01 and 1.00 with a step size of 0.01.

The string can be extended by using '&' operator as below:

{operator}+{value}&{operator}+{value}

Examples:

Case1: "=0.5" or "0.5" means matching the value "0.5"
Case2: ">0.6" means value greater than "0.6"
Case3: ">0.2&<0.4" means the value in the range of "0.2" and "0.4".
(NOTE 1)

| +|---------------|--------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +NOTE 1: At least one of these parameters shall be present. + +##### 6.1.6.2.101 Type: A2xSubscriptionData + +Table 6.1.6.2.101-1: Definition of type A2xSubscriptionData + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|------------------|----------|--------------------|-----------------------------------------------------------------------------------| +| nrA2xServicesAuth | NrA2xAuth | O | 0..1 | Indicates whether the UE is authorized to use the NR sidelink for A2X services. | +| lteA2xServicesAuth | LteA2xAuth | O | 0..1 | Indicates whether the UE is authorized to use the LTE sidelink for A2X services. | +| nrUePc5Ambr | BitRate | O | 0..1 | Indicates UE-PC5-AMBR for A2X communication over PC5 reference point for NR PC5. | +| ltePc5Ambr | BitRate | O | 0..1 | Indicates UE-PC5-AMBR for A2X communication over PC5 reference point for LTE PC5. | + +##### 6.1.6.2.102 Type: RangingSIPosQoS + +Table 6.1.6.2.102-1: Definition of type RangingSIPosQoS + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| hAccuracy | Accuracy | O | 0..1 | Horizontal accuracy | | +| vAccuracy | Accuracy | O | 0..1 | Vertical accuracy | | +| relativeHAccuracy | Accuracy | O | 0..1 | Relative Horizontal accuracy for relative positioning | | +| relativeVAccuracy | Accuracy | O | 0..1 | Relative Vertical accuracy for relative positioning | | +| distanceAccuracy | Accuracy | O | 0..1 | Distance accuracy for Ranging | | +| directionAccuracy | Accuracy | O | 0..1 | Direction accuracy for Ranging | | +| vertRequested | boolean | O | 0..1 | Vertical accuracy requested (yes/no) | | +| responseTime | ResponseTime | O | 0..1 | No delay, Low delay or Delay tolerant | | +| lcsQoSClass | LcsQoSClass | C | 0..1 | LCS QoS Class, see clause 4.1b of 3GPP TS 23.273 [19]. This IE shall be sets to either "BEST EFFORT" or "ASSURED".
This IE shall be absent if neither hAccuracy nor vAccuracy is included. | | + +Editor's note: It is FFS what the range included Ranging/SL positioning QoS parameters are. + +##### 6.1.6.2.103 Type: MbsrOperationAllowed + +Table 6.1.6.2.103-1: Definition of type MbsrOperationAllowed + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsrOperationAllowedInd | boolean | O | 0..1 | This IE shall be present if the UE is allowed for MBSR operation. It may be present otherwise.

When present, it shall indicate whether the UE is allowed for MBSR operation, as follows:
- true: indicates that the UE is allowed for MBSR operation.
- false: indicates that the UE is not allowed for MBSR operation. | +| mbsrValidTimePeriod | ValidTimePeriod | O | 0..1 | This IE may be present when MBSR operation is allowed.

When present, this IE shall include the Valid Time Period for MBSR operation. | + +Editor's note: It is FFS what's the location information for MBSR operation. + +##### 6.1.6.2.104 Type: GpsilInfo + +Table 6.1.6.2.104-1: Definition of type GpsilInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|-------------| +| NOTE: In this version of this specification, this data type does not contain any attributes, it is used to convey an empty JSON objects as the value of the entries in the membersData map.(see clause 6.5.6.2.6) | | | | | + +##### 6.1.6.2.105 Type: DnnLadnServiceAreas + +**Table 6.1.6.2.105-1: Definition of type DnnLadnServiceAreas** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------------|---|-------------|--------------------------------------| +| dnnLadnServiceAreas | array(DnnLadnServiceArea) | M | 1..N | list of LADN Service Areas for a DNN | + +##### 6.1.6.2.106 Type: DnnLadnServiceArea + +**Table 6.1.6.2.106-1: Definition of type DnnLadnServiceArea** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|------------|---|-------------|-----------------------------------------------------------------| +| dnn | Dnn | M | 1 | Data Network Name with Network Identifier only, or Wildcard DNN | +| ladnServiceArea | array(Tai) | M | 1..N | Indicates the LADN Service Area. | + +##### 6.1.6.2.107 Type: GtpAllowedInfo + +**Table 6.1.6.2.107-1: Definition of type GtpAllowedInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | C | 0..1 | DNN | +| sNssai | Snssai | C | 0..1 | S-NSSAI | +| gtpAllowed | boolean | M | 1 | This IE shall be present to indicate whether the gtp based time synchronization services is allowed.
  • - true: the gtp based time synchronization services is allowed
  • - false: the gtp based time synchronization services is not allowed
| +| coverageArea | array(Tai) | O | 1..N | This IE may be present when the gtpAllowed is set to true. When present, it shall contain the Time Synchronization Coverage Area | +| uUTimeSyncErrBdgt | Uinteger | O | 0..1 | This IE may be present when the gtpAllowed is set to true. When present, it shall contain the authorized Uu time synchronization error budget for the time synchronization service in units of nanoseconds. | +| tempVals | array(TemporalValidity) | O | 1..N | This IE may be present when the gtpAllowed is set to true. When present, it shall contain the authorized start and stop times | + +##### 6.1.6.2.108 Type: AstiAllowedInfo + +**Table 6.1.6.2.108-1: Definition of type AstiAllowedInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| astiAllowed | boolean | M | 1 | This IE shall be present to indicate whether the ASTI based time synchronization services is allowed.
  • - true: the ASTI based time synchronization services is allowed
  • - false: the ASTI based time synchronization services is not allowed
| +| coverageArea | array(Tai) | O | 1..N | This IE may be present when the astiAllowed is set to true. When present, it shall contain the Time Synchronization Coverage Area | +| uUTimeSyncErrBdgt | UInteger | O | 0..1 | This IE may be present when the astiAllowed is set to true. When present, it shall contain the authorized Uu time synchronization error budget for the time synchronization service in units of nanoseconds. | +| tempVals | array(TemporalValidity) | O | 1..N | This IE may be present when the astiAllowed is set to true. When present, it shall contain the authorized start and stop times | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|---------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DefaultDnnIndicator | boolean | Indicates whether a DNN is the default DNN | +| LboRoamingAllowed | boolean | This flag indicates whether local breakout is allowed when roaming. | +| UeUsageType | integer | Indicates the usage characteristics of the UE, enables the selection of a specific Dedicated Core Network for EPS interworking | +| MpsPriorityIndicator | boolean | Indicates whether UE is subscribed to multimedia priority service | +| McsPriorityIndicator | boolean | Indicates whether UE is subscribed to mission critical service | +| 3GppChargingChara
cteristics | string | 16-bit string identifying charging characteristics as specified in 3GPP TS 32.255 [11] Annex A and 3GPP TS 32.298 [12] clause 5.1.2.2.7, in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the charging characteristics shall appear first in the string, and the character representing the 4 least significant bits of the charging characteristics shall appear last in the string.

Example:
The charging characteristic 0x123A shall be encoded as "123A".
See also 3GPP TS 32.256 [67] Annex A | +| MicoAllowed | boolean | Indicates whether MICO mode is allowed for the UE. | +| SmsSubscribed | boolean | Indicates whether the UE subscription allows SMS delivery over NAS. | +| SharedDataId | string | Identifies globally and uniquely a piece of subscription data shared by multiple UEs. The value shall start with the HPLMN id (MCC/MNC) followed by a hyphen followed by a local Id as allocated by the home network operator.
pattern: "^[0-9]{5,6}-.+\$" | +| IwkEpsInd | boolean | Indicates whether Interworking with EPS is supported | +| SecuredPacket | string | Indicates the secured packet as specified in 3GPP TS 24.501 [27]. It is encoded using base64 and represented as a String.
Format: byte | +| UpuRegInd | boolean | true indicates that re-registration is requested after the successful UE parameters update. | +| ExtGroupId | string | String containing an External Group ID.
Pattern: "^[extgroupid-[^@]+@[^\@]+\+\$" | +| NbIoTUEPriority | integer | Unsigned integer indicating the NB-IoT UE Priority (see clause 5.31.17 of 3GPP TS 23.501 [8]), the value is between 0 and 255 and lower value indicates higher priority. | +| CodeWord | string | Indicates the codeword as specified in 3GPP TS 23.273 [38] clause 5.4.2.2.3. | +| AfId | string | AF Identifier (see 3GPP TS 23.273 [38] clause 5.4.2.2.3) | +| LcsClientId | string | Lcs Client Identifier (see 3GPP TS 23.273 [38] clause 5.4.2.2.3) | +| SorTransparentCont
ainer | Bytes | String with format "byte" as defined in OpenAPI Specification [14], i.e. base64-encoded characters, encoding the "SOR transparent container" IE as specified in clause 9.11.3.51 of 3GPP TS 24.501 [27] (starting from octet 1). | +| UpuTransparentCon
tainer | Bytes | String with format "byte" as defined in OpenAPI Specification [14], i.e. base64-encoded characters, encoding the "UE Parameters Update transparent container" IE as specified in clause 9.11.3.53A of 3GPP TS 24.501 [27] (starting from octet 1). | +| SorCmci | Bytes | String with format "byte" as defined in OpenAPI Specification [14], i.e. base64-encoded characters, encoding the "SOR-CMCI" IE as specified in Figure 9.11.3.51.7 of 3GPP TS 24.501 [27] (starting from octet 1). | +| SorSnpnSiLs | Bytes | String with format "byte" as defined in OpenAPI Specification [14], i.e. base64-encoded characters, encoding the "SOR-SNPN-SI-LS" IE as specified in Clause 9.11.3.51 of 3GPP TS 24.501 [27] (starting from octet 1). | + +| | | | +|-----------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SorSnpnSi | Bytes | String with format "byte" as defined in OpenAPI Specification [14], i.e. base64-encoded characters, encoding the "SOR-SNPN-SI" IE as specified in Figure 9.11.3.51.9A of 3GPP TS 24.501 [27] (starting from octet 1). | +|-----------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +##### 6.1.6.3.3 Enumeration: DataSetName + +**Table 6.1.6.3.3-1: Enumeration DataSetName** + +| Enumeration value | Description | +|-------------------|--------------------------------------------| +| "AM" | Access and Mobility Subscription Data | +| "SMF_SEL" | SMF Selection Subscription Data | +| "UEC_SMF" | UE Context in SMF Data | +| "UEC_SMSF" | UE Context in SMSF Data | +| "SMS_SUB" | SMS Subscription Data | +| "SM" | Session Management Subscription Data | +| "TRACE" | Trace Data | +| "SMS_MNG" | SMS Management Subscription Data | +| "LCS_PRIVACY" | LCS Privacy Subscription Data | +| "LCS_MO" | LCS Mobile Originated Subscription Data | +| "LCS_SUB" | LCS Subscription Data | +| "UEC_AMF" | UE Context in AMF Data | +| "V2X" | V2X Subscription Data | +| "LCS_BCA" | LCS Broadcast Assistance Subscription Data | +| "PROSE" | ProSe Service Subscription Data | +| "UC" | User Consent Data | +| "MBS" | 5MBS subscription data | +| "A2X" | A2X Subscription Data | + +NOTE: The current naming conventions for Enumerations (uppercase with underscore), when their intended usage is for query parameters is not consistent with the naming conventions for URI components (lowercase with hyphen). + +6.1.6.3.4 Void + +6.1.6.3.5 Void + +6.1.6.3.6 Void + +##### 6.1.6.3.7 Enumeration: PduSessionContinuityInd + +**Table 6.1.6.3.7-1: Enumeration PduSessionContinuityInd** + +| Enumeration value | Description | +|------------------------|--------------------------------------------------------| +| "MAINTAIN_PDUSESSION" | Maintain the PDU session | +| "RECONNECT_PDUSESSION" | Disconnect the PDU session with a reactivation request | +| "RELEASE_PDUSESSION" | Disconnect PDU session without reactivation request | + +##### 6.1.6.3.8 Enumeration: LocationPrivacyInd + +**Table 6.1.6.3.8-1: Enumeration LocationPrivacyInd** + +| Enumeration value | Description | +|-----------------------|-------------------------------| +| "LOCATION_DISALLOWED" | Location for UE is disallowed | +| "LOCATION_ALLOWED" | Location for UE are allowed | + +##### 6.1.6.3.9 Enumeration: PrivacyCheckRelatedAction + +**Table 6.1.6.3.9-1: Enumeration PrivacyCheckRelatedAction** + +| Enumeration value | Description | +|-----------------------------------------|-----------------------------------------------------------------------------------------| +| "LOCATION_NOT_ALLOWED" | Location not allowed | +| "LOCATION_ALLOWED_WITH_NOTIFICATION" | Location allowed with notification | +| "LOCATION_ALLOWED_WITHOUT_NOTIFICATION" | Location allowed without notification | +| "LOCATION_ALLOWED_WITHOUT_RESPONSE" | Location with notification and privacy verification; location allowed if no response | +| "LOCATION_RESTRICTED_WITHOUT_RESPONSE" | Location with notification and privacy verification; location restricted if no response | + +##### 6.1.6.3.10 Enumeration: LcsClientClass + +**Table 6.1.6.3.10-1: Enumeration LcsClientClass** + +| Enumeration value | Description | +|------------------------------|-----------------------------------------------------------------------------------------------| +| "BROADCAST_SERVICE" | LCS client broadcasting location related information | +| "OM_IN_HPLMN" | O&M LCS client in the HPLMN | +| "OM_IN_VPLMN" | O&M LCS client in the VPLMN | +| "ANONYMOUS_LOCATION_SERVICE" | LCS client recording anonymous location information | +| "SPECIFIC_SERVICE" | LCS Client supporting a bearer service, teleservice or supplementary service to the target UE | +| "NWDAF_IN_HPLMN" | NWDAF in the HPLMN | +| "NWDAF_IN_VPLMN" | NWDAF in the VPLMN | + +##### 6.1.6.3.11 Enumeration: LcsMoServiceClass + +**Table 6.1.6.3.11-1: Enumeration LcsMoServiceClass** + +| Enumeration value | Description | +|----------------------------|------------------------------------------------------------| +| "BASIC_SELF_LOCATION" | UE requests own location | +| "AUTONOMOUS_SELF_LOCATION" | UE requests location assistance data | +| "TRANSFER_TO_THIRD_PARTY" | UE requests transfer of own location to another LCS Client | + +##### 6.1.6.3.12 Enumeration: OperationMode + +**Table 6.1.6.3.12-1: Enumeration OperationMode** + +| Enumeration value | Description | +|-------------------|-------------------------------------------------| +| "WB_S1" | WB-S1 mode, i.e. EUTRAN connected to EPC | +| "NB_S1" | NB-S1 mode, i.e. EUTRAN NB-IoT connected to EPC | +| "WB_N1" | WB-N1 mode, i.e. EUTRAN connected to 5GC | +| "NB_N1" | NB-N1 mode, i.e. EUTRAN NB-IoT connected to 5GC | +| "NR_N1" | NR-N1 mode, i.e. NR connected to 5GC | + +##### 6.1.6.3.13 Enumeration: SorUpdateIndicator + +**Table 6.1.6.3.13-1: Enumeration SorUpdateIndicator** + +| Enumeration value | Description | +|--------------------------|------------------------------------------------| +| "INITIAL_REGISTRATION" | NAS registration type "Initial Registration" | +| "EMERGENCY_REGISTRATION" | NAS registration type "Emergency Registration" | + +##### 6.1.6.3.14 Enumeration: CodeWordInd + +**Table 6.1.6.3.14-1: Enumeration CodeWordInd** + +| Enumeration value | Description | +|--------------------------|---------------------------------------------------| +| "CODEWORD_CHECK_IN_UE" | codeword shall be checked in UE | +| "CODEWORD_CHECK_IN_GMLC" | one or more codeword values to be checked in GMLC | + +##### 6.1.6.3.15 Enumeration: MdtUserConsent + +**Table 6.1.6.3.15-1: Enumeration MdtUserConsent** + +| Enumeration value | Description | +|---------------------|-------------------------------------------------------------------------| +| "CONSENT_GIVEN" | It shall indicate the user has given his consent for MDT activation. | +| "CONSENT_NOT_GIVEN" | It shall indicate the user hasn't given his consent for MDT activation. | + +##### 6.1.6.3.16 Enumeration: SharedDataTreatmentInstruction + +**Table 6.1.6.3.16-1: Enumeration SharedDataTreatmentInstruction** + +| Enumeration value | Description | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "USE_IF_NO_CLASH" | If the attribute is not present in the individual data (no clash), the value of the shared data attribute shall be used. Otherwise the individual data takes precedence. (default) | +| "OVERWRITE" | The value of the shared data attribute shall be used (even when clashing with individual data).
If the shared data attribute is absent, the value of the individual attribute (if any) shall not be used, i.e. the attribute shall be handled as being absent. | +| "MAX" | If no clash (i.e. individual data is absent) the shared data attribute value shall be used. Otherwise the higher value shall be used. (NOTE) | +| "MIN" | If no clash (i.e. individual data is absent) the shared data attribute value shall be used. Otherwise the lower value shall be used. (NOTE) | +| NOTE: | Treatment instructions "MIN" and "MAX" are applicable to attributes that can take numeric values. | + +##### 6.1.6.3.17 Enumeration: GpsiType + +**Table 6.1.6.3.17-1: Enumeration GpsiType** + +| Enumeration value | Description | +|-------------------|--------------------------------------| +| "MSISDN" | GPSI type of MSISDN | +| "EXT_ID" | GPSI type of external identity | +| "EXT_GROUP_ID" | GPSI type of external group identity | + +##### 6.1.6.3.18 Enumeration: AerialUeIndication + +**Table 6.1.6.3.18-1: Enumeration AerialUeIndication** + +| Enumeration value | Description | +|-------------------------|-------------------------------------------| +| "AERIAL_UE_ALLOWED" | Aerial service for the UE is allowed. | +| "AERIAL_UE_NOT_ALLOWED" | Aerial service for the UE is not allowed. | + +##### 6.1.6.3.19 Enumeration: ProseDirectAllowed + +**Table 6.1.6.3.19-1: Enumeration ProseDirectAllowed** + +| Enumeration value | Description | +|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| "ANNOUNCE" | It indicates that the user is allowed to announce in the corresponding PLMN for open 5G Direct Discovery Model A. | +| "MONITOR" | It indicates that the user is allowed to monitor in the corresponding PLMN for open 5G Direct Discovery Model A. | +| "RESTRICTD_ANNOUNCE" | It indicates that the user is allowed to announce in the corresponding PLMN for restricted 5G ProSe Direct Discovery Model A. | +| "RESTRICTD_MONITOR" | It indicates that the user is allowed to monitor in the corresponding PLMN for restricted 5G ProSe Direct Discovery Model A. | +| "DISCOVERER" | It indicates that the user is allowed to perform discoverer operation in the corresponding PLMN for restricted 5G ProSe Direct Discovery Model B. | +| "DISCOVEREE" | It indicates that the user is allowed to perform discoveree operation in the corresponding PLMN for restricted 5G ProSe Direct Discovery Model B. | +| "BROADCAST" | It indicates that the user is allowed to perform Broadcast mode 5G ProSe Direct Communication for NR PC5 in the corresponding PLMN. | +| "GROUPCAST" | It indicates that the user is allowed to perform Groupcast mode 5G ProSe Direct Communication for NR PC5 in the corresponding PLMN. | +| "UNICAST" | It indicates that the user is allowed to perform Unicast mode 5G ProSe Direct Communication for NR PC5 in the corresponding PLMN. | +| "LAYER2_RELAY" | It indicates that the user is allowed to act as a 5G ProSe Layer-2 UE-to-Network Relay. | +| "LAYER3_RELAY" | It indicates that the user is allowed to act as a 5G ProSe Layer-3 UE-to-Network Relay. | +| "LAYER2_REMOTE" | It indicates that the user is allowed to act as a 5G ProSe Layer-2 Remote UE. | +| "LAYER2_UE_RELAY" | It indicates that the user is allowed to act as a 5G ProSe Layer-2 UE-to-UE Relay. | +| "LAYER3_UE_RELAY" | It indicates that the user is allowed to act as a 5G ProSe Layer-3 UE-to-UE Relay. | +| "LAYER2_END" | It indicates that the user is allowed to act as a 5G ProSe Layer-2 End UE. | +| "LAYER3_END" | It indicates that the user is allowed to act as a 5G ProSe Layer-3 End UE. | + +##### 6.1.6.3.20 Enumeration: UcPurpose + +**Table 6.1.6.3.20-1: Enumeration UcPurpose** + +| Enumeration value | Description | +|-----------------------|-------------------------------------------------------------------------------------------------------------------------| +| "ANALYTICS" | User consent for analytics. | +| "MODEL_TRAINING" | User consent for model training. | +| "NW_CAP_EXPOSURE" | User consent for network capability exposure. | +| "EDGEAPP_UE_LOCATION" | User consent for the manipulation of UE information for the purpose of UE Location retrieval by the EDGEAPP EAS entity. | + +##### 6.1.6.3.21 Enumeration: UserConsent + +**Table 6.1.6.3.21-1: Enumeration UserConsent** + +| Enumeration value | Description | +|---------------------|------------------------------------------------------| +| "CONSENT_NOT_GIVEN" | It shall indicate the user hasn't given his consent. | +| "CONSENT_GIVEN" | It shall indicate the user has given his consent. | + +##### 6.1.6.3.22 Enumeration: NsacAdmissionMode + +**Table 6.1.6.3.22-1: Enumeration NsacAdmissionMode** + +| Enumeration value | Description | +|-------------------------------|-------------------------------------------------| +| "VPLMN_ADMISSION" | VPLMN NSAC admission mode | +| "VPLMN_WITH_HPLMN_ASSISTANCE" | VPLMN with HPLMN assistance NSAC Admission mode | +| "HPLMN_ADMISSION" | HPLMN NSAC admission mode | + +##### 6.1.6.3.23 Enumeration: PruInd + +**Table 6.1.6.3.23-1: Enumeration PruInd** + +| Enumeration value | Description | +|----------------------|--------------------------------------------------------------| +| "NON_PRU" | Indicates the UE is not allowed to serve as a PRU | +| "STATIONARY_PRU" | Indicates the UE is allowed to serve as a stationary PRU | +| "NON_STATIONARY_PRU" | Indicates the UE is allowed to serve as a non-stationary PRU | + +##### 6.1.6.3.24 Enumeration: AreaUsageInd + +**Table 6.1.6.3.24-1: Enumeration AreaUsageInd** + +| Enumeration value | Description | +|---------------------|----------------------------------------------------------------------------------------------------------------| +| "INSIDE_REPORTING" | The UE is allowed to generate and send the event report when the UE is inside the event report expected area | +| "OUTSIDE_REPORTING" | The UE is allowed to generate and send the event report when the UE is outside the event report expected area. | + +- 6.1.6.3.25 Void +- 6.1.6.3.26 Void +- 6.1.6.3.27 Void +- 6.1.6.3.28 Enumeration: RangingSIPosAllowed + +**Table 6.1.6.3.28-1: Enumeration RangingSIPosAllowed** + +| Enumeration value | Description | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "PC5" | It indicates that the user is allowed to perform Ranging/SL positioning service over PC5 in the corresponding PLMN. | +| "ANNOUNCE" | It indicates that the user is allowed to announce in the corresponding PLMN for Ranging/SL positioning service with Direct Discovery Model A. | +| "MONITOR" | It indicates that the user is allowed to monitor in the corresponding PLMN for Ranging/SL positioning service with Direct Discovery Model A. | +| "DISCOVERER" | It indicates that the user is allowed to perform discoverer operation in the corresponding PLMN for Ranging/SL positioning service with Direct Discovery Model B. | +| "DISCOVEREE" | It indicates that the user is allowed to perform discoveree operation in the corresponding PLMN for Ranging/SL positioning service with Direct Discovery Model B. | + +- 6.1.6.3.29 Enumeration: ExpectedUeBehaviourDataset + +**Table 6.1.6.3.29-1: Enumeration ExpectedUeBehaviourDataset** + +| Enumeration value | Description | +|--------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "STATIONARY_INDICATION" | Identifies whether the UE is stationary or mobile | +| "COMMUNICATION_DURATION_TIME" | Indicates for how long the UE will normally stay in CM-Connected for data transmission | +| "PERIODIC_TIME" | Identifies interval time of periodic communication | +| "SCHEDULED_COMMUNICATION_TIME" | Identifies time and day of the week when the UE is available for communication | +| "SCHEDULED_COMMUNICATION_TYPE" | Indicates that the Scheduled Communication Type | +| "EXPECTED_UMTS" | Identifies the UE's expected geographical movement. The attribute is only applicable in 5G | +| "TRAFFIC_PROFILE" | Identifies the type of data transmission: single packet transmission (UL or DL), dual packet transmission (UL with subsequent DL or DL with subsequent UL), multiple packets transmission | +| "BATTERY_INDICATION" | Indicates the power consumption type(s) of the UE | +| "EXPECTED_INACTIVITY_TIME" | Identifies the expected PDU Session Inactivity time during which the UE will not have traffic related to the application | + +- 6.1.6.3.30 Enumeration: UpLoCReplndAf + +**Table 6.1.6.3.30-1: Enumeration UpLoCReplndAf** + +| Enumeration value | Description | +|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| "USER_PLANE_REPORT_ALLOWED" | It shall indicate the UE is allowed to report periodic or triggered location events via user plane connection to an LCS Client or AF. | +| "USER_PLANE_REPORT_NOT_ALLOWED" | It shall indicate the UE is not allowed to report periodic or triggered location events via user plane connection to an LCS Client or AF | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_SubscriberDataManagement service. The following application errors listed in Table 6.1.7.3-1 are specific for the Nudm\_SubscriberDataManagement service. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|------------------------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NF_CONSUMER_REDIRECT_ONE_TXN | 307 Temporary Redirect | The request has been asked to be redirected to a specified target for one transaction. | +| CONTEXT_NOT_FOUND | 308 Permanent Redirect | The request has been asked to be redirected to a specified target. | +| REAUTHENTICATION_REQUIRED | 403 Forbidden | Reauthentication is required based on the operator's policy, e.g. if the last authentication is considered obsolete or there is no AUSF instance id stored in the UDM during EPS to 5GS mobility. | +| DATA_NOT_FOUND | 404 Not Found | The requested UE subscription data is not found/does not exist.
This error is applicable to all Nudm_SDM GET operations. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist
This error is applicable to all Nudm_SDM GET operations. | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used during the modification of an existing subscription when no corresponding context exists. | +| GROUP_IDENTIFIER_NOT_FOUND | 404 Not Found | The requested Group Identifier does not exist. | +| SUBSCRIPTION_NOT_FOUND | 404 Not Found | The subscription does not exist. | +| UNSUPPORTED_RESOURCE_URI | 501 Not Implemented | The SDM Subscription contains unsupported resource URI to be monitored. | + +### 6.1.8 Feature Negotiation + +The optional features in table 6.1.8-1 are defined for the Nudm\_SDM API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +###### **Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | SharedData | When receiving a Nudm_SDM_Get service operation request to retrieve a UE's individual subscription data, and the request does not contain a supported-features query parameter indicating support of this feature, the UDM shall not include Shared Data Ids in the response. Instead the UDM may – based on operator policy – take no further action (i.e. allow the UE to get services based on only the UE's individual subscription data), or send the shared data as individual data (this may result in notifications of individual subscription data change – if so subscribed – when shared data, which are sent as individual data, are modified, and/or when the UE's Shared Data IDs are modified). | +| 2 | ImmediateReport | When a NF consumer detects the UDM support ImmediateReport feature, it can indicate an immediateReport flag when invoking Nudm_SDM_Subscribe service operation. If UDM supports ImmediateReport received Nudm_SDM_Subscribe service operation request, it shall return the resource representation(s) of the monitored resource(s) in the service operation response body. | +| 3 | PatchReport | If some of the modifications included in the PATCH request are not successfully implemented, the UDM reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [4]. | +| 4 | Nssaa | If the NF consumer does not support this feature, the UDM shall not include information of S-NSSAI(s) subject to Network Slice-Specific Authentication and Authorization in Get response messages, immediate reports within Subscribe response messages, or data change notifications where the data change is limited to S-NSSAI(s) subject to Network Slice-Specific Authentication and Authorization. | +| 5 | CAGFeature | If the NF consumer does not support this feature, the UDM shall not include CAG information list in the message body with "200 OK" response (clause 5.2.2.2.3). The UDM performs action as executes step 2c of clause 5.3.2.2.2 and 5.3.2.2.3 if UE is allowed to access 5GS via CAG cell(s) only. | +| 6 | SharedDataTreatment | This feature is an extension to the SharedData feature, i.e. support of SharedDataTreatment requires support of SharedData. When receiving a Nudm_SDM_Get service operation request to retrieve a UE's individual subscription data, and the request does not contain a supported-features query parameter indicating support of this feature, the UDM shall not include SharedDataTreatments in the SharedData returned in the response. Instead the UDM may – based on operator policy – take no further action (i.e. allow the UE to get services based on default treatment (i.e. individual data take precedence), or send the shared data which have non-default treatment as individual data. | +| 7 | sorTransparentSupport | This flag indicates NF Consumer (e.g. AMF) support of receiving SoR Transparent Container instead of individual IEs from NF Producer (e.g. UDM). If the NF consumer does not support this feature, the NF Producer shall not include sorTransparentContainer, as defined in clause 6.1.6.2.26.
Corresponding flag is also used by UDM to register (in NRF) its support of receiving SoR Transparent Container instead of individual IEs from the NF Consumer (e.g. AMF). If the UDM does not support this feature, the NF Consumer shall not include sorTransparentContainer, as defined in clause 6.1.6.2.25. | +| 8 | Nsac | If the NF consumer does not support this feature, the UDM shall not include network slice admission control related information for S-NSSAI(s) in the message body with "200 OK" response (See clause 5.2.2.2.3). | +| 9 | SharedSmSubsData | If the NF consumer does not support this feature, the UDM shall not take the alternative to include extendedSmSubsData in SmSubsData (clause 6.1.6.2.79). | +| 10 | ENA | Enhanced Network Automation.

If the UDM supports this feature, the UDM shall apply the nfChangeFilter IE received in the sdmSubscription and send the notifications accordingly (See clause 6.1.6.2.16 and 6.1.6.2.70). | + +| | | | +|----|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 11 | Nssrg |

The NF consumer (i.e. AMF) that supports this feature shall support handling of NSSRG information received along with the subscribed S-NSSAIs as defined in clause 5.15.12 of 3GPP TS 23.501 [2].

If the NF consumer does not support this feature, the UDM may select the subset of the compatible Subscribed S-NSSAIs without including any information of Network Slice Simultaneous Registration Group.

| +| 12 | upuTransparentSupport |

This flag indicates NF Consumer (e.g. AMF) support of receiving UE Parameters Update Transparent Container instead of individual IEs from NF Producer (e.g. UDM). If the NF consumer does not support this feature, the NF Producer shall not include upuTransparentContainer, as defined in clause 6.1.6.2.33.

Corresponding flag is also used by UDM to register (in NRF) its support of receiving UE Parameters Update Transparent Container instead of individual IEs from the NF Consumer (e.g. AMF). If the UDM does not support this feature, the NF Consumer shall not include upuTransparentContainer, as defined in clause 6.1.6.2.25.

| +| 13 | LimitedSubscriptions |

An NF consumer supporting this feature shall use one subscription for the changes of subscription data sets per UE without additional filter criteria, or with a specific filter criteria (e.g. dnn and/or singleNssai).

An NF consumer supporting this feature shall use one subscription for the changes of shared data sets.

| +| 14 | SNPN-ID |

Support of SNPN-ID

This flag indicates whether the NF Consumer (e.g. AMF) or NF producer (UDM) support receiving an SNPN-ID as an extension of the "plmn-id" query parameter, when retrieving Access And Mobility Subscription Data (either by querying the "{supi}" resource or the "{supi}/am-data" resource).

If the NF Consumer is aware (e.g. from previous interactions) that the UDM does not support this feature, the NF Consumer should not send queries on the Nudm_SDM API including SNPN-ID in the "plmn-id" query parameter.

Also, if the NF Consumer sent such query to UDM, and the UDM does not indicate support of this feature in the response, the NF Consumer should consider the response as invalid, since the response from UDM would have not considered the presence of the NID component of the SNPN-ID in the "plmn-id" parameter.

| +| 15 | UeConSmfDataSubFilter |

UE Context in Smf Data Subscription Filter

If the UDM supports this feature, the UDM shall handle the ueConSmfDataSubFilter IE received in the sdmSubscription and sends the notifications only for changes indicated in the IE.

| +| 16 | TempSliceSupport |

If the NF consumer does not support this feature, the UDM shall not include network slice validity related information in the message body with "200 OK" response (See clause 5.2.2.2.2, 5.2.2.2.3, etc.).

| +| 17 | ExpectedBehaviourMap |

This indicates that the NF Consumer (e.g. AMF/SMF) supports receiving Expected Behaviour Parameters as a map of ExpectedUeBehaviourData.

| +| 18 | SharedDataExt |

When receiving a Nudm_SDM_Get service operation request to retrieve a UE's individual session management subscription data, and the request does not contain a supported-features query parameter indicating support of this feature, the UDM shall not include additionalSharedDnnConfigurationsIds in the response. Instead the UDM may – based on operator policy – take no further action (i.e. allow the UE to get services based on only the UE's individual subscription data and a single shared DNN configurationsID), or send the additional shared data as individual data (this may result in notifications of individual subscription data change – if so subscribed – when shared data, which are sent as individual data, are modified, and/or when the UE's Shared Data IDs are modified).

| + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nudm\_SDM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nudm\_SDM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudm\_SDM service. + +The Nudm\_SDM API defines the following scopes for OAuth2 authorization. + +**Table 6.1.9-1: Oauth2 scopes defined in Nudm\_SDM API** + +| Scope | Description | +|---------------------------------------------|------------------------------------------------------| +| "nudm-sdm" | Access to the Nudm_SDM API | +| "nudm-sdm:multi-data-sets:read" | Access to read multiple data sets | +| "nudm-sdm:nssai:read" | Access to read NSSAI | +| "nudm-sdm:ue-context-in-amf-data:read" | Access to read UE context in AMF data | +| "nudm-sdm:am-data:read" | Access to read Access And Mobility Subscription data | +| "nudm-sdm:ecr-data:read" | Access to read ECR data | +| "nudm-sdm:smf-select-data:read" | Access to read SMF Selection data | +| "nudm-sdm:ue-context-in-smf-data:read" | Access to read UE context in SMF data | +| "nudm-sdm:ue-context-in-smf-data:read" | Access to read UE context in SMSF data | +| "nudm-sdm:trace-data:read" | Access to read Trace data | +| "nudm-sdm:sm-data:read" | Access to read Session Management data | +| "nudm-sdm:sms-data:read" | Access to read SMS data | +| "nudm-sdm:sms-mng-data:read" | Access to read SMS Management data | +| "nudm-sdm:lcs-privacy-data:read" | Access to read LCS privacy data | +| "nudm-sdm:lcs-mo-data:read" | Access to read LCS MO data | +| "nudm-sdm:lcs-bca-data:read" | Access to read LCS BCA data | +| "nudm-sdm:v2x-data:read" | Access to read V2X data | +| "nudm-sdm:prose-data:read" | Access to read Prose data | +| "nudm-sdm:5mbs-data:read" | Access to read 5MBS data | +| "nudm-sdm:uc-data:read" | Access to read User Consent data | +| "nudm-sdm:sdm-subscriptions:create" | Access to create SDM subscriptions | +| "nudm-sdm:sdm-subscriptions:modify" | Access to update SDM subscriptions | +| "nudm-sdm:id-translation-result:read" | Access to read ID Translation Results | +| "nudm-sdm:sor-ack:write" | Access to write SOR acknowledgements | +| "nudm-sdm:upu-ack:write" | Access to write UPU acknowledgements | +| "nudm-sdm:subscribed-nssais-ack:write" | Access to write Subscribed NSSAIs acknowledgements | +| "nudm-sdm:cag-ack:write" | Access to write CAG acknowledgements | +| "nudm-sdm:update-sor:invoke" | Access to invoke SOR info update | +| "nudm-sdm:shared-data:read" | Access to read shared data | +| "nudm-sdm:shared-data-subscriptions:create" | Access to create shared data subscriptions | +| "nudm-sdm:shared-data-subscriptions:modify" | Access to update shared data subscriptions | +| "nudm-sdm:group-identifiers:read" | Access to read Group Identifiers | +| "nudm-sdm:multiple-identifiers:read" | Access to read multiple Identifiers | +| "nudm-sdm:ranging-slpos-data:read" | Access to read Ranging and Sidelink Positioning data | +| "nudm-sdm:a2x-data:read" | Access to read A2X data | + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different UDM service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UDM producer instance will return the NF Instance ID of the new UDM producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UDM redirects a service request to a different UDM using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UDM towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Nudm\_UEContextManagement Service API + +### 6.2.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion} + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot}/{apiName}/{apiVersion}/{apiSpecificResourceUriPart} + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nudm-uecm". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [13], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nudm\_UECM service shall comply with the OpenAPI [14] specification contained in Annex A3. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.2.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 9457 [16]) signalled by the content type "application/problem+json" + +JSON Merge Patch, as defined in IETF RFC 7396 [17], signalled by the content type "application/merge-patch+json" + +#### 6.2.2.3 HTTP custom headers + +##### 6.2.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.2.3.1-1 depicts the resource URIs structure for the Nudm\_UECM API. + +![API tree diagram for {apiRoot}/nudm-uecm/v1 showing various registration and access endpoints.](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +``` +graph TD; Root["{apiRoot}/nudm-uecm/v1"] --- ueId["/{ueId}"]; ueId --- registrations["/registrations"]; registrations --- amf3gpp["/amf-3gpp-access"]; amf3gpp --- deregAmf["/dereg-amf"]; amf3gpp --- peiUpdate["/pei-update"]; amf3gpp --- roamingInfoUpdate["/roaming-info-update"]; registrations --- amfNon3gpp["/amf-non-3gpp-access"]; registrations --- smfRegistrations["/smf-registrations"]; smfRegistrations --- pduSessionId["/{pduSessionId}"]; registrations --- smf3gpp["/smf-3gpp-access"]; registrations --- smfNon3gpp["/smf-non-3gpp-access"]; registrations --- sendRoutingInfoSm["/send-routing-info-sm"]; registrations --- location["/location"]; registrations --- ipSmGw["/ip-sm-gw"]; registrations --- nwDafRegistrations["/nwDaf-registrations"]; nwDafRegistrations --- nwDafRegistrationId["/{nwDafRegistrationId}"]; registrations --- authTrigger["/auth-trigger"]; +``` + +The diagram illustrates the API structure for {apiRoot}/nudm-uecm/v1. It starts with the root path, which branches into a placeholder for {ueId}. This placeholder then leads to the /registrations path. From /registrations, several sub-paths are available: /amf-3gpp-access, /amf-non-3gpp-access, /smf-registrations, /smf-3gpp-access, /smf-non-3gpp-access, /send-routing-info-sm, /location, /ip-sm-gw, /nwDaf-registrations, and /auth-trigger. The /amf-3gpp-access path further branches into /dereg-amf, /pei-update, and /roaming-info-update. The /smf-registrations path branches into /{pduSessionId}. The /nwDaf-registrations path branches into /{nwDafRegistrationId}. The /send-routing-info-sm and /auth-trigger paths are shown with dashed borders. + +API tree diagram for {apiRoot}/nudm-uecm/v1 showing various registration and access endpoints. + +###### **Figure 6.2.3.1-1: Resource URI structure of the Nudm\_UECM API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +###### **Table 6.2.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|------------------------------------------|-----------------------------------------------------------|---------------------------------|-------------------------------------------------------------------------| +| Registrations (Document) | /{ueld}/registrations | GET | Retrieve UE's registration data sets | +| | /{ueld}/registrations/send-routing-info-sm | send-routing-info-sm (POST) | Retrieve addressing information for SMS delivery | +| Amf3GppAccessRegistration (Document) | /{ueld}/registrations/amf-3gpp-access | PUT | Update the AMF registration for 3GPP access | +| | | PATCH | Modify the AMF registration for 3GPP access | +| | | GET | Retrieve the AMF registration information for 3GPP access | +| | /{ueld}/registrations/amf-3gpp-access/dereg-amf | dereg-amf (POST) | Trigger AMF deregistration due to mobility from 5GC to EPC | +| | /{ueld}/registrations/amf-3gpp-access/pei-update | pei-update (POST) | Updates the PEI in the 3GPP Access Registration context | +| | /{ueld}/registrations/amf-3gpp-access/roaming-info-update | roaming-info-update (POST) | Updates the Roaming Information in the AMF 3GPP Registration context | +| AmfNon3GppAccessRegistration (Document) | /{ueld}/registrations/amf-non-3gpp-access | PUT | Update the AMF registration for non 3GPP access | +| | | PATCH | Modify the AMF registration for non 3GPP access | +| | | GET | Retrieve the AMF registration information for non 3GPP access | +| SmfRegistrations (Store) | /{ueld}/registrations/smf-registrations | GET | Retrieve the SMF registration information | +| IndividualSmfRegistration (Document) | /{ueld}/registrations/smf-registrations/{pduSessionId} | PUT | Create an SMF registration identified by PDU Session Id | +| | | DELETE | Delete an individual SMF registration | +| | | GET | Retrieve the SMF registration information identified by PDU Session Id. | +| | | PATCH | Modify the SMF registration | +| Smsf3GppAccessRegistration (Document) | /{ueld}/registrations/smsf-3gpp-access | PUT | Create or Update the SMSF registration | +| | | DELETE | Delete the SMSF registration for 3GPP access | +| | | GET | Retrieve the SMSF registration information | +| | | PATCH | Modify the SMSF registration for 3GPP access | +| SmsfNon3GppAccessRegistration (Document) | /{ueld}/registrations/smsf-non-3gpp-access | PUT | Create or Update the SMSF registration for non 3GPP access | +| | | DELETE | Delete the SMSF registration for non 3GPP access | + +| | | | | +|-------------------------------|---------------------------------------------------------------|---------------------|----------------------------------------------------------------| +| | | GET | Retrieve the SMSF registration information for non 3GPP access | +| | | PATCH | Modify the SMSF registration for non-3GPP access | +| Location(Document) | /{ueId}/registrations/location | GET | Retrieve the UE's location information by GMLC or NEF | +| IpSmGwRegistration (Document) | /{ueId}/registrations/ip-sm-gw | PUT | Create or Update the IP-SM-GW registration | +| | | DELETE | Delete the IP-SM-GW registration | +| | | GET | Retrieve the IP-SM-GW registration information | +| NwdaRegistration (Document) | /{ueId}/registrations/nwda-registrations/{nwdaRegistrationId} | PUT | Create an NWDAF registration | +| | | DELETE | Delete an individual NWDAF registration | +| | | PATCH | Modify the NWDAF registration | +| NwdaRegistrations (Store) | /{ueId}/registrations/nwda-registrations | GET | Retrieve the NWDAF registration(s) information | +| AuthTrigger | /{ueId}/registrations/auth-trigger | auth-trigger (POST) | Trigger the primary (re-)authentication | + +#### 6.2.3.2 Resource: Amf3GppAccessRegistration (Document) + +##### 6.2.3.2.1 Description + +This resource represents the registered AMF for 3GPP access. + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/amf-3gpp-access + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2). SUPI (i.e. imsi or nai or gli or gci) is used with the PUT and PATCH methods; SUPI (i.e. imsi or nai) or GPSI (i.e. msisdn or extid) is used with the GET method.
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7] | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|---------------------------------------------------------------------------------| +| Amf3GppAccess Registration | M | 1 | The AMF registration for 3GPP access is replaced with the received information. | + +**Table 6.2.3.2.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Amf3GppAccess Registration | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual Amf3GppAccessRegistration resource shall be returned. | +| Amf3GppAccess Registration | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual Amf3GppAccessRegistration resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNKNOWN_5GS_SUBSCRIPTION
- NO_PS_SUBSCRIPTION
- ROAMING_NOT_ALLOWED
- ACCESS_NOT_ALLOWED
- RAT_NOT_ALLOWED
- REAUTHENTICATION_REQUIRED
- SNPN_NOT_ALLOWED | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueid}/registrations/amf-3gpp-access | + +###### 6.2.3.2.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.2.3.2-1. + +**Table 6.2.3.2.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.2.3.2-2 and the response data structures and response codes specified in table 6.2.3.2.3.2-3. + +**Table 6.2.3.2.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------------------|---|-------------|---------------------------------------------------------------------------------| +| Amf3GppAccess RegistrationModification | M | 1 | The AMF registration for 3GPP access is modified with the received information. | + +**Table 6.2.3.2.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body is returned. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- INVALID_GUAMI | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 422 Unprocessable Entity | The "cause" attribute may be used to indicate one of the following application errors:
- UNPROCESSABLE_REQUEST | + +NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with PatchResult. + +###### 6.2.3.2.3.3 GET + +This method shall support the URI query parameters specified in table 6.2.3.2.3.3-1. + +**Table 6.2.3.2.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.2.3.3-2 and the response data structures and response codes specified in table 6.2.3.2.3.3-3. + +**Table 6.2.3.2.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------| +| Amf3GppAccess Registration | M | 1 | 200 OK | Upon success, a response body containing the Amf3GppAccessRegistration shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +##### 6.2.3.2.4 Resource Custom Operations + +###### 6.2.3.2.4.1 Overview + +**Table 6.2.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|---------------------|-----------------------------------------------------------|--------------------|----------------------------------------------------------------------| +| dereg-amf | /{ueId}/registrations/amf-3gpp-access/dereg-amf | POST | Trigger AMF deregistration due to mobility from 5GC to EPC | +| pei-update | /{ueId}/registrations/amf-3gpp-access/pei-update | POST | Updates the stored PEI | +| roaming-info-update | /{ueId}/registrations/amf-3gpp-access/roaming-info-update | POST | Updates the Roaming information in the AMF 3GPP Registration context | + +###### 6.2.3.2.4.2 Operation: dereg-amf + +###### 6.2.3.2.4.2.1 Description + +The dereg-amf custom operation is used by the NF service consumer (HSS) to trigger AMF deregistration due to mobility from 5GS to EPC. For details see 3GPP TS 23.632 [32]. + +###### 6.2.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.2.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.2.3.2.4.2.2-2. + +**Table 6.2.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|------------------------------------| +| AmfDeregInfo | M | 1 | Contains the deregistration reason | + +**Table 6.2.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +###### 6.2.3.2.4.3 Operation: pei-update + +###### 6.2.3.2.4.3.1 Description + +The pei-update custom operation is used by the NF service consumer (HSS) to trigger an update of the stored PEI . For details see 3GPP TS 23.632 [32]. + +###### 6.2.3.2.4.3.2 Operation Definition + +This operation shall support the request data structures specified in table 6.2.3.2.4.3.2-1 and the response data structure and response codes specified in table 6.2.3.2.4.3.2-2. + +**Table 6.2.3.2.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|------------------------------------------------------| +| PeiUpdateInfo | M | 1 | Contains the PEI provided by the NF service consumer | + +**Table 6.2.3.2.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +###### 6.2.3.2.4.4 Operation: roaming-info-update + +###### 6.2.3.2.4.4.1 Description + +The roaming-info-update custom operation is used by the NF service consumer (HSS) to trigger an update of the Roaming Information stored in the 3GPP Registration context. For details see 3GPP TS 23.632 [32]. + +###### 6.2.3.2.4.4.2 Operation Definition + +This operation shall support the request data structures specified in table 6.2.3.2.4.4.2-1 and the response data structure and response codes specified in table 6.2.3.2.4.4.2-2. + +**Table 6.2.3.2.4.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-----------------------------------------------------------------------| +| RoamingInfoUpdate | M | 1 | Contains the roaming information provided by the NF service consumer. | + +**Table 6.2.3.2.4.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------| +| RoamingInfoUpdate | M | 1 | 201 Created | Upon success, a response body containing a representation of the resource of the created Roaming Information shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate any of the following application errors:
- USER_NOT_FOUND | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +#### 6.2.3.3 Resource: AmfNon3GppAccessRegistration (Document) + +##### 6.2.3.3.1 Description + +This resource represents the registered AMF for non 3GPP access. + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/amf-non-3gpp-access/ + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
SUPI (i.e. imsi or nai or gli or gci) is used with the PUT and PATCH methods; SUPI (i.e. imsi or nai) or GPSI (i.e. msisdn or extid) is used with the GET method.
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7] | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|-------------------------------------------------------------------------------------| +| AmfNon3GppAccessRegistration | M | 1 | The AMF registration for non 3GPP access is replaced with the received information. | + +**Table 6.2.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AmfNon3GppAccessRegistration | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual AmfNon3GppAccessRegistration resource shall be returned. | +| AmfNon3GppAccessRegistration | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual AmfNon3GppAccessRegistration resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNKNOWN_5GS_SUBSCRIPTION
- NO_PS_SUBSCRIPTION
- ROAMING_NOT_ALLOWED
- ACCESS_NOT_ALLOWED
- RAT_NOT_ALLOWED
- REAUTHENTICATION_REQUIRED
- SNPN_NOT_ALLOWED | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.3.3.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/amf-non-3gpp-access | + +###### 6.2.3.3.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.3.3.2-1. + +**Table 6.2.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3. + +**Table 6.2.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------------------|---|-------------|-------------------------------------------------------------------------------------| +| AmfNon3GppAccessRegistrationModification | M | 1 | The AMF registration for non 3GPP access is modified with the received information. | + +**Table 6.2.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 422 Unprocessable Entity | The "cause" attribute may be used to indicate one of the following application errors:
- UNPROCESSABLE_REQUEST | +| NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.
NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with PatchResult. | | | | | + +###### 6.2.3.3.3.3 GET + +This method shall support the URI query parameters specified in table 6.2.3.3.3.3-1. + +**Table 6.2.3.3.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.3-2 and the response data structures and response codes specified in table 6.2.3.3.3.3-3. + +**Table 6.2.3.3.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------| +| AmfNon3GppAccessRegistration | M | 1 | 200 OK | Upon success, a response body containing the AmfNon3GppAccessRegistration shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.2.3.4 Resource: SmfRegistrations + +##### 6.2.3.4.1 Description + +This resource is used to represent SMF registrations. + +##### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smf-registrations + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 6.2.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.4.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7] | + +##### 6.2.3.4.3 Resource Standard Methods + +###### 6.2.3.4.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.4.3.1-1. + +**Table 6.2.3.4.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| single-nssai | Snssai | O | 0..1 | When present without Slice Differentiator (sd), all slices identified by the given Slice/Service Type (sst) and any sd value (if any) shall be considered matching the query parameter.
When present with the reserved sd value of FFFFFFFF (see 3GPP TS 23.003 [8] clause 28.4.2) only the slice identified by the given sst value and absent sd value shall be considered matching the query parameter. | +| dnn | Dnn | O | 0..1 | The DNN shall be the DNN Network Identifier only. | + +JSON objects (such as Snssai, Dnn...) shall be included directly as part of the URI query parameters by specifying in the OpenAPI file that the "Content-Type" of such parameters is "application/json". + +If "single-nssai" is not included, and "dnn" is not included, UDM shall return all SMF registrations for all DNN(s) and network slice(s). + +If "single-nssai" is included, and "dnn" is not included, UDM shall return all SMF registrations for all DNN(s) and the requested network slice identified by "single-nssai". + +If "single-nssai" is not included, and "dnn" is included, UDM shall return all SMF registrations for all network slices where such DNN is available. + +If "single-nssai" is included, and "dnn" is included, UDM shall return the all SMF registrations identified by "dnn" and "single-nssai". + +This method shall support the request data structures specified in table 6.2.3.4.3.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3. + +**Table 6.2.3.4.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.4.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| SmfRegistrationInfo | M | 1 | 200 OK | Upon success, a response body containing the SmfRegistrationInfo shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be set to one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.2.3.5 Resource: IndividualSmfRegistration (Document) + +##### 6.2.3.5.1 Resource Definition + +Resource URI: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smf-registrations/{pduSessionId} + +This resource shall support the resource URI variables defined in table 6.2.3.5.1-1. + +**Table 6.2.3.5.1-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
SUPI (i.e. imsi or nai or gli or gci) is used with the PUT, DELETE and PATCH methods;
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7] | +| pduSessionId | PduSessionId | The pduSessionId identifies an individual SMF registration. | + +##### 6.2.3.5.2 Resource Standard Methods + +###### 6.2.3.5.2.1 PUT + +This method shall support the URI query parameters specified in table 6.2.3.5.2.1-1. + +**Table 6.2.3.5.2.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.5.2.1-2 and the response data structures and response codes specified in table 6.2.3.5.2.1-3. + +**Table 6.2.3.5.2.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|----------------------------------------| +| SmfRegistration | M | 1 | The registration that is to be created | + +**Table 6.2.3.5.2.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmfRegistration | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual SmfRegistration resource shall be returned. | +| SmfRegistration | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual SmfRegistration resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- ROAMING NOT ALLOWED
- DNN NOT ALLOWED
- SNPN NOT ALLOWED | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.2.3.5.2.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueid}/registrations/smf-registrations/{pduSessionId} | + +###### 6.2.3.5.2.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.5.2.2-1. + +**Table 6.2.3.5.2.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------------------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smf-set-id | NfSetId | O | 0..1 | The smf-set-id may be used by the UDM to guard against deletion of registrations by NFs that do not belong to the same NF set as the registered SMF. | +| smf-instance-id | NfInstanceId | O | 0..1 | If smf-set-id is not present, the smf-instance-id may be used by the UDM to guard against deletion of registrations by NF that is not the registered SMF. | +| smf-events-implicitly-unsubscribed | boolean | C | 0..1 |

This IE should be present with the value "true" when the SMF deregisters the last PDU session for the UE from the UDM, if the SMF event subscriptions on the SMF for the UE have been implicitly removed by the SMF.

When present, this IE shall be set as following:
- true: SMF event subscriptions on the SMF for the UE have been implicitly removed.

If the UDM received this IE with the value "true", the UDM should not send service request(s) to the SMF to unsubscribe the SMF event subscription(s) previously created on the SMF for the UE.

| + +This method shall support the request data structures specified in table 6.2.3.5.2.2-2 and the response data structures and response codes specified in table 6.2.3.5.2.2-3. + +**Table 6.2.3.5.2.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.5.2.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +###### 6.2.3.5.2.3 + +###### GET + +This method shall support the URI query parameters specified in table 6.2.3.5.2.3-1. + +**Table 6.2.3.5.2.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.5.2.3-2 and the response data structures and response codes specified in table 6.2.3.5.2.3-3. + +**Table 6.2.3.5.2.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.5.2.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| SmfRegistration | M | 1 | 200 OK | Upon success, a response body containing the SmfRegistration shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be set to one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +###### 6.2.3.5.2.4 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.5.2.4-1. + +**Table 6.2.3.5.2.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.5.2.4-2 and the response data structures and response codes specified in table 6.2.3.5.2.4-3. + +**Table 6.2.3.5.2.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|-----------------------------------------------------------------| +| SmfRegistrationModification | M | 1 | The SMF registration is modified with the received information. | + +**Table 6.2.3.5.2.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| n/a | | | 204 No Content | Upon success, an empty response body is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 422 Unprocessable Entity | The "cause" attribute may be used to indicate one of the following application errors:
- UNPROCESSABLE_REQUEST | +| NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.
NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with PatchResult. | | | | | + +#### 6.2.3.6 Resource: Smsf3GppAccessRegistration (Document) + +##### 6.2.3.6.1 Description + +This resource represents the registered SMSF for 3GPP access. + +##### 6.2.3.6.2 Resource Definition + +Resource URI: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smsf-3gpp-access + +This resource shall support the resource URI variables defined in table 6.2.3.6.2-1. + +**Table 6.2.3.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2). SUPI (i.e. imsi or nai or gli or gci) is used with the PUT and DELETE methods; GPSI (i.e. msisdn or extid) is used with the GET method.
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7] | + +##### 6.2.3.6.3 Resource Standard Methods + +###### 6.2.3.6.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.3.6.3.1-1. + +**Table 6.2.3.6.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.6.3.1-2 and the response data structures and response codes specified in table 6.2.3.6.3.1-3. + +**Table 6.2.3.6.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------| +| SmsfRegistration | M | 1 | The SMSF registration for 3GPP access is created or updated with the received information. | + +**Table 6.2.3.6.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmsfRegistration | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual SmsfRegistration resource shall be returned. | +| SmsfRegistration | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual SmsfRegistration resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNKNOWN_5GS_SUBSCRIPTION
- ACCESS_NOT_ALLOWED
- ROAMING_NOT_ALLOWED
- SNPN_NOT_ALLOWED | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.3.6.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smsf-3gpp-access | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3. | + +**Table 6.2.3.6.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3. | + +**Table 6.2.3.6.3.1-6: Headers supported by the 204 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3. | + +###### 6.2.3.6.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.6.3.2-1. + +**Table 6.2.3.6.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| smsf-set-id | NfSetId | O | 0..1 | The smsf-set-id may be used by the UDM to guard against deletion of registrations by NFs that do not belong to the same NF set as the registered SMSF. | + +This method shall support the request data structures specified in table 6.2.3.6.3.2-2 and the response data structures and response codes specified in table 6.2.3.6.3.2-3. + +**Table 6.2.3.6.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.6.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.2.3.6.3.2-4: Headers supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.1 | + +###### 6.2.3.6.3.3 GET + +This method shall support the URI query parameters specified in table 6.2.3.6.3.3-1. + +**Table 6.2.3.6.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.6.3.3-2 and the response data structures and response codes specified in table 6.2.3.6.3.3-3. + +**Table 6.2.3.6.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.6.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmsfRegistration | M | 1 | 200 OK | Upon success, a response body containing the SmsfRegistration shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND
- ABSENT_SUBSCRIBER_SM | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- SERVICE_NOT_ALLOWED
- SERVICE_NOT_PROVISIONED | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +###### 6.2.3.6.3.4 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.6.3.4-1. + +**Table 6.2.3.6.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.6.3.4-2 and the response data structures and response codes specified in table 6.2.3.6.3.4-3. + +**Table 6.2.3.6.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------------|---|-------------|----------------------------------------------------------------------------------| +| SmsfRegistration Modification | M | 1 | The SMSF registration for 3GPP access is modified with the received information. | + +**Table 6.2.3.6.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 422 Unprocessable Entity | The "cause" attribute may be used to indicate one of the following application errors:
- UNPROCESSABLE_REQUEST | + +NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with PatchResult. + +#### 6.2.3.7 Resource: SmsfNon3GppAccessRegistration (Document) + +##### 6.2.3.7.1 Description + +This resource represents the registered SMSF for non 3GPP access. + +##### 6.2.3.7.2 Resource Definition + +Resource URI: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smsf-non-3gpp-access + +This resource shall support the resource URI variables defined in table 6.2.3.7.2-1. + +**Table 6.2.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2). SUPI (i.e. imsi or nai or gli or gci) is used with the PUT and DELETE methods; GPSI (i.e. msisdn or extid) is used with the GET method.
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7] | + +##### 6.2.3.7.3 Resource Standard Methods + +###### 6.2.3.7.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.3.7.3.1-1. + +**Table 6.2.3.7.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.7.3.1-2 and the response data structures and response codes specified in table 6.2.3.7.3.1-3. + +**Table 6.2.3.7.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------------------------------------------| +| SmsfRegistration | M | 1 | The SMSF registration for non 3GPP access is created or updated with the received information. | + +**Table 6.2.3.7.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmsfRegistration | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual SmsfRegistration for non 3GPP access resource shall be returned. | +| SmsfRegistration | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual SmsfRegistration for non 3GPP access resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors: The "cause" attribute shall be set to the following application error:
- USER NOT FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNKNOWN_5GS_SUBSCRIPTION
- ACCESS_NOT_ALLOWED
- ROAMING_NOT_ALLOWED
- SNPN_NOT_ALLOWED | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.3.7.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-uecm/v1/{ueid}/registrations/smsf-non-3gpp-access | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3. | + +**Table 6.2.3.7.3.1-5: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3. | + +**Table 6.2.3.7.3.1-6: Headers supported by the 204 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [50], clause 2.3. | + +###### 6.2.3.7.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.7.3.2-1. + +**Table 6.2.3.7.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smsf-set-id | NfSetId | O | 0..1 | The smsf-set-id may be used by the UDM to guard against deletion of registrations by NFs that do not belong to the same NF set as than the registered SMSF. | + +This method shall support the request data structures specified in table 6.2.3.7.2.2-2 and the response data structures and response codes specified in table 6.2.3.5.2.2-3. + +**Table 6.2.3.7.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.7.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.2.3.7.3.2-4: Headers supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-Match | string | O | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [50], clause 3.1 | + +###### 6.2.3.7.3.3 GET + +This method shall support the URI query parameters specified in table 6.2.3.7.3.3-1. + +**Table 6.2.3.7.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.7.3.3-2 and the response data structures and response codes specified in table 6.2.3.7.3.3-3. + +**Table 6.2.3.7.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.7.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmsfRegistration | M | 1 | 200 OK | Upon success, a response body containing the SmsfRegistration shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND
- ABSENT_SUBSCRIBER_SM | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- SERVICE_NOT_ALLOWED
- SERVICE_NOT_PROVISIONED | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +###### 6.2.3.7.3.4 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.7.3.4-1. + +**Table 6.2.3.7.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.7.3.4-2 and the response data structures and response codes specified in table 6.2.3.7.3.4-3. + +**Table 6.2.3.7.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------------|---|-------------|--------------------------------------------------------------------------------------| +| SmsfRegistration Modification | M | 1 | The SMSF registration for non-3GPP access is modified with the received information. | + +**Table 6.2.3.7.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 422 Unprocessable Entity | The "cause" attribute may be used to indicate one of the following application errors:
- UNPROCESSABLE_REQUEST | +| NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported.
NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with PatchResult. | | | | | + +#### 6.2.3.8 Resource: Location + +##### 6.2.3.8.1 Description + +This resource is used to represent UE's location information. + +##### 6.2.3.8.2 Resource Definition + +Resource URI: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/location + +This resource shall support the resource URI variables defined in table 6.2.3.8.2-1. + +**Table 6.2.3.8.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.4.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7] | + +##### 6.2.3.8.3 Resource Standard Methods + +###### 6.2.3.8.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.8.3.1-1. + +**Table 6.2.3.8.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.8.3.1-2 and the response data structures and response codes specified in table 6.2.3.8.3.1-3. + +**Table 6.2.3.8.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.8.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------| +| LocationInfo | M | 1 | 200 OK | Upon success, a response body containing the locationInfo shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.2.3.9 Resource: Registrations + +##### 6.2.3.9.1 Description + +This resource represents the UE's registration data sets. + +##### 6.2.3.9.2 Resource Definition + +Resource URI: {apiRoot}/nudm-uecm/v1/{ueId}/registrations + +This resource shall support the resource URI variables defined in table 6.2.3.9.2-1. + +**Table 6.2.3.9.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2) SUPI (i.e. imsi or nai) or GPSI (i.e. msisdn or extid) is used with the GET method.
pattern: "(imsi-[0-9]{5,15} nai-.+ msisdn-[0-9]{5,15} extid-[^@]+@[0-9]+ .+)" | + +##### 6.2.3.9.3 Resource Standard Methods + +###### 6.2.3.9.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.9.3.1-1. + +NOTE: The retrieval of these registration data sets can also be achieved by sending individual GET requests to the corresponding sub-resources under the {ueId}/registrations resource. When multiple registration data sets need to be retrieved by the NF Service consumer, it is recommended to use a single GET request with query parameters rather than issuing multiple GET requests. + +**Table 6.2.3.9.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| registration-dataset-names | array(RegistrationDataSetName) | O | 2..N | If included, this IE shall contain the names of registration data sets to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| single-nssai | Snssai | O | 0..1 | Only applicable if registration-dataset-names contains SMF_PDU_SESSIONS
When present without Slice Differentiator (sd), all slices identified by the given Slice/Service Type (sst) and any sd value (if any) shall be considered matching the query parameter.
When present with the reserved sd value of FFFFFFFF (see 3GPP TS 23.003 [8] clause 28.4.2) only the slice identified by the given sst value and absent sd value shall be considered matching the query parameter. | +| dnn | Dnn | O | 0..1 | The DNN shall be the DNN Network Identifier only.
Only applicable if registration-dataset-names contains SMF_PDU_SESSIONS | + +This method shall support the request data structures specified in table 6.2.3.9.3.1-2 and the response data structures and response codes specified in table 6.2.3.9.3.1-3. + +**Table 6.2.3.9.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.9.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|----------|--------------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RegistrationData Sets | M | 1 | 200 OK | Upon success, a response body containing all the requested UE registration data sets shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute shall be set to one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND
- ABSENT_SUBSCRIBER_SM (applicable to SMSF registration data sets retrieval) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors for SMSF data sets retrieval:
- SERVICE_NOT_ALLOWED
- SERVICE_NOT_PROVISIONED | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +##### 6.2.3.9.4 Resource Custom Operations + +###### 6.2.3.9.4.1 Overview + +**Table 6.2.3.9.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|-----------------------|--------------------------------------------|---------------------------|--------------------------------------------------| +| send-routing-info-sm | /{ueid}/registrations/send-routing-info-sm | POST | Retrieve addressing information for SMS delivery | + +###### 6.2.3.9.4.2 Operation: send-routing-info-sm + +###### 6.2.3.9.4.2.1 Description + +The send-routing-info-sm custom operation is used by the NF service consumer (e.g. SMS-GMSC, HSS...) to retrieve addressing information of those nodes (e.g. registered SMSFs) that are currently available for sending terminating SMS to the receipt UE, for both 3GPP and non-3GPP accesses. + +###### 6.2.3.9.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.2.3.9.4.2.2-1 and the response data structure and response codes specified in table 6.2.3.9.4.2.2-2. + +**Table 6.2.3.9.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|----------|--------------------|------------------------------------------------------------------------| +| RoutingInfoSmRequest | M | 1 | It may contain supported features, if any, of the NF Service Consumer. | + +**Table 6.2.3.9.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| RoutingInfoSmResponse | M | 1 | 200 OK | Upon success, a response body containing the Routing Information for SM shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- ABSENT_SUBSCRIBER_SM | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- SERVICE_NOT_ALLOWED
- SERVICE_NOT_PROVISIONED | +| NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +#### 6.2.3.10 Resource: IpSmGwRegistration + +##### 6.2.3.10.1 Description + +This resource represents the registered IP-SM-GW. + +##### 6.2.3.10.2 Resource Definition + +Resource URI: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/ip-sm-gw + +This resource shall support the resource URI variables defined in table 6.2.3.10.2-1. + +**Table 6.2.3.10.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| ueId | Represents the Subscription Identifier (SUPI).
pattern: "(imsi-[0-9]{5,15} nai-.[ +])" | + +##### 6.2.3.10.3 Resource Standard Methods + +###### 6.2.3.10.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.3.10.3.1-1. + +**Table 6.2.3.10.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.10.3.1-2 and the response data structures and response codes specified in table 6.2.3.10.3.1-3. + +**Table 6.2.3.10.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|--------------------------------------------------------------------------------| +| IpSmGwRegistration | M | 1 | The IP-SM-GW registration is created or updated with the received information. | + +**Table 6.2.3.10.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| lpSmGwRegistration | M | 1 | 201 Created | Upon success, a response body containing a representation of the created lpSmGwRegistration resource shall be returned. | +| lpSmGwRegistration | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated lpSmGwRegistration resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate any of the following application errors:
- UNKNOWN_5GS_SUBSCRIPTION | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate any of the following application errors:
- USER_NOT_FOUND | + +###### 6.2.3.10.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.10.3.2-1. + +**Table 6.2.3.10.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.10.3.2-2 and the response data structures and response codes specified in table 6.2.3.10.3.2-3. + +**Table 6.2.3.10.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.10.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | + +###### 6.2.3.10.3.3 GET + +This method shall support the URI query parameters specified in table 6.2.3.10.3.3-1. + +**Table 6.2.3.10.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.10.3.3-2 and the response data structures and response codes specified in table 6.2.3.10.3.3-3. + +**Table 6.2.3.10.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.10.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------| +| lpSmGwRegistration | M | 1 | 200 OK | Upon success, a response body containing the lpSmGwRegistration shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be set to indicate any of the following application errors:
- USER_NOT_FOUND
- CONTEXT_NOT_FOUND | + +#### 6.2.3.11 Resource: NwdafRegistration (Document) + +##### 6.2.3.11.1 Resource Definition + +Resource URI: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/nwdaf-registrations/{nwdafRegistrationId} + +This resource shall support the resource URI variables defined in table 6.2.3.11.1-1. + +**Table 6.2.3.11.1-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) SUPI (i.e. imsi or nai or gli or gci) is used with the PUT, DELETE and PATCH methods;
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7] | +| nwdafRegistrationId | string | nwdafRegistrationId could be the NfInstanceId, the combination of NfSetId and NfInstanceId or other identifier forms of the NWDAF. NWDAF implementation shall secure the global uniqueness of this resource ID. | + +##### 6.2.3.11.2 Resource Standard Methods + +###### 6.2.3.11.2.1 PUT + +This method shall support the URI query parameters specified in table 6.2.3.11.2.1-1. + +**Table 6.2.3.11.2.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.11.2.1-2 and the response data structures and response codes specified in table 6.2.3.11.2.1-3. + +**Table 6.2.3.11.2.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|----------------------------------------| +| NwdafRegistration | M | 1 | The registration that is to be created | + +**Table 6.2.3.11.2.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------| +| NwdafRegistration | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual NwdafRegistration resource shall be returned. | +| NwdafRegistration | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual NwdafRegistration resource shall be returned. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNKNOWN 5GS SUBSCRIPTION | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +###### 6.2.3.11.2.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.11.2.2-1. + +**Table 6.2.3.11.2.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.11.2.2-2 and the response data structures and response codes specified in table 6.2.3.11.2.2-3. + +**Table 6.2.3.11.2.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.11.2.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +###### 6.2.3.11.2.3 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.11.2.4-1. + +**Table 6.2.3.11.2.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.11.2.4-2 and the response data structures and response codes specified in table 6.2.3.11.2.4-3. + +**Table 6.2.3.11.2.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------------|---|-------------|--------------------------------------------------------------------| +| NwdafRegistrationModification | M | 1 | The NWDCAF registration is modified with the received information. | + +**Table 6.2.3.11.2.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|----------|--------------------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NwdafRegistration | C | 0..1 | 200 OK | Upon partial success, if the NF service consumer does not support the "PatchReport" feature, the UDM shall return an NwdafRegistration object in the response.
(NOTE 2) | +| PatchResult | C | 0..1 | 200 OK | Upon success, if the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature, and in case some of the requested modifications are discarded while the rest of the modification instructions are fully accepted, UDM may return the execution report instead of the whole NwdafRegistration.
(NOTE 2) | +| n/a | | | 204 No Content | Upon success, an empty response body is returned indicating that all the modification instructions in the PATCH request have been implemented. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 422 Unprocessable Entity | The "cause" attribute may be used to indicate one of the following application errors:
- UNPROCESSABLE_REQUEST | + +NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. +NOTE 2: One of NwdafRegistration or PatchResult shall be returned. + +#### 6.2.3.12 Resource: NwdafRegistrations + +##### 6.2.3.12.1 Description + +This resource is used to represent NWDAF registrations. + +##### 6.2.3.12.2 Resource Definition + +Resource URI: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/nwdaf-registrations + +This resource shall support the resource URI variables defined in table 6.2.3.12.2-1. + +**Table 6.2.3.12.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
SUPI (i.e. imsi or nai or gli or gci) is used with the GET method;
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [7] | + +##### 6.2.3.12.3 Resource Standard Methods + +###### 6.2.3.12.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.12.3.1-1. + +**Table 6.2.3.12.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|----------|--------------------|----------------------------------------------------------------------------------------------------------------| +| analytics-ids | array(EventId) | O | 0..N | Represents the List of analytics Id(s) supplied by NWDAF, see EventId data type defined in 3GPP TS 29.520 [58] | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.2.3.12.3.1-2 and the response data structures and response codes specified in table 6.2.3.12.3.1-3. + +**Table 6.2.3.12.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.3.12.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| array(NwdafRegistration) | M | 1..N | 200 OK | Upon success, a response body containing the NwdafRegistration(s) shall be returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be set to one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | + +NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. +NOTE 2: If there are multiple NwdafRegistration for the same UE, all matched NwdafRegistration(s) will be returned. + +#### 6.2.3.13 Resource: AuthTrigger + +##### 6.2.3.13.1 Description + +This resource represents the auth trigger. + +##### 6.2.3.13.2 Resource Definition + +Resource URI: {apiRoot}/nudm-uecm/v1/{ueId}/registrations + +This resource shall support the resource URI variables defined in table 6.2.3.13.2-1. + +**Table 6.2.3.13.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|--------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.2.1 | +| ueId | Represents the Subscription Identifier (SUPI).
pattern: "(imsi-[0-9]{5,15} nai-.[ .]+)" | + +##### 6.2.3.13.3 Resource Standard Methods + +No HTTP method has been defined for the AuthTrigger resource. + +##### 6.2.3.13.4 Resource Custom Operations + +###### 6.2.3.13.4.1 Overview + +**Table 6.2.3.13.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|------------------------------------|--------------------|-----------------------------------------| +| auth-trigger | /{ueId}/registrations/auth-trigger | POST | Trigger the primary (re-)authentication | + +###### 6.2.3.13.4.2 Operation: auth-trigger + +###### 6.2.3.13.4.2.1 Description + +The auth-trigger operation is used by the NF service consumer (e.g. AAnF) to trigger a primary (re-)authentication. + +###### 6.2.3.13.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.2.3.13.4.2.2-1 and the response data structure and response codes specified in table 6.2.3.13.4.2.2-2. + +**Table 6.2.3.13.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|--------------------| +| AuthTriggerInfo | M | 1 | Contains the SUPI. | + +**Table 6.2.3.13.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- REAUTHENTICATION NOT ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND
- CONTEXT NOT FOUND | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +### 6.2.4 Custom Operations without associated resources + +#### 6.2.4.1 Overview + +**Table 6.2.4.1-1: Custom operations without associated resources** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------------------|----------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Trigger P-CSCF Restoration | /restore-pcsf | POST | The HSS triggers the UDM to notify the registered AMFs or SMFs that have subscribed (implicitly by providing a callback URI during registration) to receive notifications about P-CSCF Restoration. | + +#### 6.2.4.2 Operation: Trigger P-CSCF Restoration + +##### 6.2.4.2.1 Description + +This custom operation is used by the NF service consumer (HSS) to trigger P-CSCF restoration. + +##### 6.2.4.2.2 Operation Definition + +This operation shall support the data structures and response codes specified in tables 6.2.4.2.2-1 and 6.2.4.2.2-2. + +**Table 6.2.4.2.2-1: Data structures supported by the Request Body** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|--------------------------------------------------------------------| +| TriggerRequest | M | 1 | Identifies the subscriber for whom P-CSCF Restoration is requested | + +**Table 6.2.4.2.2-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND | + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +This clause will specify the use of notifications and corresponding protocol details if required for the specific service. When notifications are supported by the API, it will include a reference to the general description of notifications support over the 5G SBIs specified in TS 29.500 / TS 29.501. + +**Table 6.2.5.1-1: Notifications overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------|-------------------------------|---------------------------------|---------------------------------| +| Deregistration Notification | {deregCallbackUri} | POST | | +| P-CSCF Restoration Notification | {pcscfRestorationCallbackUri} | POST | | +| Data Restoration Notification | {dataRestorationCallbackUri} | POST | | +| Stale Check Notification | {staleCheckCallbackUri} | POST | | +| Reauth Notification | {reauthNotifyCallbackUri} | POST | | + +#### 6.2.5.2 Deregistration Notification + +The POST method shall be used for Deregistration Notifications and the URI shall be as provided during the registration procedure. + +Resource URI: {deregCallbackUri} + +Support of URI query parameters is specified in table 6.2.5.2-1. + +**Table 6.2.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.2-2 and of response data structures and response codes is specified in table 6.2.5.2-3. + +**Table 6.2.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|--------------------------------| +| DeregistrationData | M | 1 | Includes Deregistration Reason | + +**Table 6.2.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| DeregistrationResponseData | M | 1 | 200 OK | Upon success, the response body includes the information to be sent to the UDM. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT NOT FOUND | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.2.5.3 P-CSCF Restoration Notification + +The POST method shall be used for P-CSCF Restoration Notifications and the URI shall be as provided during the registration procedure. + +Resource URI: {pcscfRestorationCallbackUri} + +Support of URI query parameters is specified in table 6.2.5.3-1. + +**Table 6.2.5.3-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.3-2 and of response data structures and response codes is specified in table 6.2.5.3-3. + +**Table 6.2.5.3-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|--------------------------------------------------------------------| +| PscfRestoration Notification | M | 1 | Contains the SUPI and optionally the address of the failed P-CSCF. | + +**Table 6.2.5.3-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT NOT FOUND | +| ProblemDetails | O | 0..1 | 409 Conflict | The "cause" attribute may be used to indicate one of the following application errors:
- TEMPORARY_REJECT_REGISTRATION_ONGOING
- TEMPORARY_REJECT_HANDOVER_ONGOING | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.5.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.5.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.2.5.4 Data Restoration Notification + +The POST method shall be used to inform the NF Service Consumer about a potential data-loss event occurred at the UDR, and the callback URI may be provided during the registration procedure, or dynamically discovered by UDM by querying NRF for a default notification URI. + +Resource URI: {dataRestorationCallbackUri} + +Support of URI query parameters is specified in table 6.2.5.4-1. + +**Table 6.2.5.4-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.4-2 and of response data structures and response codes is specified in table 6.2.5.4-3. + +**Table 6.2.5.4-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------| +| DataRestorationNotification | M | 1 | Contains identifiers representing those UEs potentially affected by a data-loss event at the UDR. | + +**Table 6.2.5.4-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.2.5.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.5.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.2.5.5 Stale Check Notification + +The POST method shall be used for Stale Check Notifications and the URI shall be as provided during the registration procedure. + +Resource URI: {staleCheckCallbackUri} + +Support of URI query parameters is specified in table 6.2.5.5-1. + +**Table 6.2.5.5-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.5-2 and of response data structures and response codes is specified in table 6.2.5.5-3. + +**Table 6.2.5.5-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| PduSessionIds | M | 1 | Includes a list of PDU Session IDs, identifying SMF registrations suspected to be stale in the UDM/UDR. | + +**Table 6.2.5.5-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| PduSessionIds | M | 1 | 200 OK | Upon partial success, a list of unknown (i.e. stale) PDU session IDs shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same NF or NF (service) set. If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same NF or NF (service) set. If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT NOT FOUND | + +NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. +NOTE 2: In partial success cases and failure cases the UDM shall use the Nudr\_DR\_Delete service operation to delete the stale SMF registrations from the UDR. + +**Table 6.2.5.5-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer (e.g. SMF) to which the request is redirected | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.5.5-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer (e.g. SMF) to which the request is redirected | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.2.5.6 Re-AuthenticationNotification Notification + +The POST method shall be used for Re-Authentication Notifications and the URI shall be as provided during the registration procedure. + +Resource URI: {reauthNotifyCallbackUri} + +Support of URI query parameters is specified in table 6.2.5.6-1. + +**Table 6.2.5.6-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.6-2 and of response data structures and response codes is specified in table 6.2.5.6-3. + +**Table 6.2.5.6-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-------------------| +| ReauthNotificationInfo | M | 1 | Includes the SUPI | + +**Table 6.2.5.6-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- REAUTHENTICATION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +**Table 6.2.5.6-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.5.6-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nudm\_UECM service API. + +**Table 6.2.6.1-1: Nudm\_UECM specific Data Types** + +| Data type | Clause defined | Description | +|------------------------------------------|----------------|----------------------------------------------------------------------------------------------------------------------------| +| Amf3GppAccessRegistration | 6.2.6.2.2 | The complete set of information relevant to the AMF where the UE has registered via 3GPP access. | +| AmfNon3GppAccessRegistration | 6.2.6.2.3 | The complete set of information relevant to the AMF where the UE has registered via non 3GPP access. | +| SmfRegistration | 6.2.6.2.4 | The complete set of information relevant to an SMF serving the UE | +| SmsfRegistration | 6.2.6.2.6 | The complete set of information relevant to the SMSF serving the UE. | +| DeregistrationData | 6.2.6.2.5 | Data sent with the Deregistration Notification | +| Amf3GppAccessRegistrationModification | 6.2.6.2.7 | Contains attributes of Amf3GppAccessRegistration that can be modified using PATCH | +| AmfNon3GppAccessRegistrationModification | 6.2.6.2.8 | Contains attributes of AmfNon3GppAccessRegistration that can be modified using PATCH | +| PscfRestorationNotification | 6.2.6.2.9 | Information sent to the AMF or SMF when P-CSCF restoration is triggered. | +| NetworkNodeDiameterAddress | 6.2.6.2.10 | | +| EpsLwkPgw | 6.2.6.2.11 | | +| TriggerRequest | 6.2.6.2.12 | | +| AmfDeregInfo | 6.2.6.2.13 | | +| EpsInterworkingInfo | 6.2.6.2.14 | | +| LocationInfo | 6.2.6.2.15 | Information used by (H)GMLC to send Location Service Request | +| RegistrationLocationInfo | 6.2.6.2.16 | Serving AMF, optional VGMLC and access type related informations used by (H)GMLC to send Location Request | +| VgmlcAddress | 6.2.6.2.17 | The address(es) of VGMLC | +| PeiUpdateInfo | 6.2.6.2.18 | | +| RegistrationDataSets | 6.2.6.2.19 | | +| IpSmGwRegistration | 6.2.6.2.20 | | +| SmfRegistrationInfo | 6.2.6.2.20A | SMF Registration Information | +| NwdafRegistration | 6.2.6.2.21 | The complete set of information relevant to an NWDAF serving the UE | +| NwdafRegistrationModification | 6.2.6.2.22 | Contains attributes of NwdafRegistration that can be modified using PATCH | +| SmfRegistrationModification | 6.2.6.2.23 | Contains attributes of SmfRegistration that can be modified using PATCH | +| RoamingInfoUpdate | 6.2.6.2.24 | Roaming Information Update | +| DataRestorationNotification | 6.2.6.2.25 | Contains identities representing those UEs potentially affected by a data-loss event at the UDR | +| PscfAddress | 6.2.6.2.26 | Contains the addressing information (IP addresses and/or FQDN) of the P-CSCF | +| NwdafRegistrationInfo | 6.2.6.2.27 | List of NwdafRegistration | +| RoutingInfoSmRequest | 6.2.6.2.28 | Request body of the send-routing-info-sm custom operation. | +| RoutingInfoSmResponse | 6.2.6.2.29 | Addressing information of available nodes for SMS delivery. | +| IpSmGwInfo | 6.2.6.2.30 | Addressing information of the IP-SM-GW. | +| IpSmGwGuidance | 6.2.6.2.31 | Contains guidance information (e.g. minimum and recommended delivery times) of the IP-SM-GW. | +| SmsRouterInfo | 6.2.6.2.32 | Addressing information of the SMS Router configured at the UDM. | +| SmsfRegistrationModification | 6.2.6.2.33 | Contains attributes of SmsfRegistration that can be modified using PATCH | +| PduSessionIds | 6.2.6.2.34 | Contains a list of PDU Session IDs | +| ReauthNotificationInfo | 6.2.6.2.35 | Data sent with the Reauth Notification | +| AuthTriggerInfo | 6.2.6.2.36 | Contains SUPI | +| DeregistrationRespData | 6.2.6.2.37 | Deregistration Response Data, containing the information sent to the UDM in a successful UECM Deregistration Notification. | + +| | | | +|-------------------------|-----------|-------------------------------------------------------------| +| PurgeFlag | 6.2.6.3.2 | This flag indicates whether or not the NF has deregistered. | +| E164Number | 6.2.6.3.2 | | +| DualRegistrationFlag | 6.2.6.3.2 | Dual Registration Flag | +| DeregistrationReason | 6.2.6.3.3 | | +| ImsVoPs | 6.2.6.3.4 | | +| RegistrationReason | 6.2.6.3.5 | | +| RegistrationDataSetName | 6.2.6.3.6 | | +| UeReachableInd | 6.2.6.3.7 | UE Reachable Indication | + +Table 6.2.6.1-2 specifies data types re-used by the Nudm\_uecm service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudm\_uecm service API. + +**Table 6.2.6.1-2: Nudm\_UECM re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|-------------------------------------------------------------------------------| +| Dnn | 3GPP TS 29.571 [7] | Data Network Name with Network Identifier only. | +| NfInstanceId | 3GPP TS 29.571 [7] | Network Function Instance Identifier | +| PduSessionId | 3GPP TS 29.571 [7] | PDU Session ID | +| Pei | 3GPP TS 29.571 [7] | Permanent Equipment Identifier | +| ProblemDetails | 3GPP TS 29.571 [7] | Common data type used in response bodies | +| Uri | 3GPP TS 29.571 [7] | Uniform Resource Identifier | +| SupportedFeatures | 3GPP TS 29.571 [7] | see 3GPP TS 29.500 [4] clause 6.6 | +| Supi | 3GPP TS 29.571 [7] | see 3GPP TS 23.501 [2] clause 5.9.2 | +| Guami | 3GPP TS 29.571 [7] | Globally Unique AMF Identifier | +| PlmnId | 3GPP TS 29.571 [7] | PLMN Identity | +| DiameterIdentity | 3GPP TS 29.571 [7] | | +| AccessType | 3GPP TS 29.571 [7] | Access Type | +| BackupAmfInfo | 3GPP TS 29.571 [7] | Backup AMFs | +| PatchResult | 3GPP TS 29.571 [7] | | +| Gpsi | 3GPP TS 29.571 [7] | Generic Public Subscription Identifier | +| Ipv4Addr | 3GPP TS 29.571 [7] | IPv4 address | +| Ipv6Addr | 3GPP TS 29.571 [7] | IPv6 address | +| Snssai | 3GPP TS 29.571 [7] | Single NSSAI | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of the redirect response message | +| Fqdn | 3GPP TS 29.571 [7] | Fully Qualified Domain Name | +| FqdnRm | 3GPP TS 29.571 [7] | Fully Qualified Domain Name, nullable | +| NfGroupId | 3GPP TS 29.571 [7] | NF Group ID | +| ServiceName | 3GPP TS 29.510 [19] | | +| SupiRange | 3GPP TS 29.510 [19] | | +| IdentityRange | 3GPP TS 29.510 [19] | | +| EventId | 3GPP TS 29.520 [58] | Describes the type of analytics. | +| ContextInfo | 6.1.6.2.69 | Defined in the Nudm_SDM API.
Contains the HTTP Headers received by the NFs | + +#### 6.2.6.2 Structured data types + +#### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 6.2.6.2.2 Type: Amf3GppAccessRegistration + +**Table 6.2.6.2.2-1: Definition of type Amf3GppAccessRegistration** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| amfInstanceId | NfInstanceId | M | 1 | The identity the AMF uses to register in the NRF. | +| deregCallbackUri | Uri | M | 1 | A URI provided by the AMF to receive (implicitly subscribed) notifications on deregistration. The deregistration callback URI shall have unique information within AMF set to identify the UE to be deregistered. | +| guami | Guami | M | 1 | This IE shall contain the serving AMF's GUAMI. | +| ratType | RatType | M | 1 | This IE shall indicate the current RAT type of the UE. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.2.8
These are the features supported by the AMF. | +| purgeFlag | PurgeFlag | O | 0..1 | This flag indicates whether or not the AMF has deregistered. It shall not be included in the Registration service operation. | +| pei | Pei | O | 0..1 | Permanent Equipment Identifier.
Absence of PEI indicates that the PEI is not available at the AMF. In this case the UDM/UDR shall not delete the PEI value stored from a previous registration.
If the UDR supports the PeiResource feature, the UDM shall also use the PeiInfo resource of the UDR to store the received PEI if it is different from the previously stored PEI or if the PeiInfo resource does not exist. | +| imsVoPs | ImsVoPs | O | 0..1 | Indicates per UE if "IMS Voice over PS Sessions" is homogeneously supported in all TAs in the serving AMF for the current PLMN and access type, or homogeneously not supported, or if support is non-homogeneous/unknown. Absence of this attribute shall be interpreted as "non homogenous or unknown" support. | +| amfServiceNameDereg | ServiceName | O | 0..1 | When present, this IE shall contain the name of the AMF service to which the Deregistration Notification is to be sent (see clause 6.5.2.2 of 3GPP TS 29.500 [4]). | +| pcscfRestorationCallbackUri | Uri | O | 0..1 | A URI provided by the AMF to receive (implicitly subscribed) notifications on the need for P-CSCF Restoration. | +| amfServiceNamePscfRest | ServiceName | O | 0..1 | When present, this IE shall contain the name of the AMF service to which P-CSCF Restoration Notifications are to be sent (see clause 6.5.2.2 of 3GPP TS 29.500 [4]). This IE may be included if pcscfRestorationCallbackUri is present. | +| initialRegistrationInd | boolean | C | 0..1 | This IE shall be included by the AMF and set to true if the UE performs an Initial Registration. If the UE does not perform initial registration it shall be absent or set to false. When present and true, the UDM+HSS is requested to cancel previous registration in SGSN, if any.
Not applicable for Nudr and Nudm_UECM GET operation.
(NOTE 2) | +| emergencyRegistrationInd | boolean | C | 0..1 | This IE shall be included by the AMF and set to true if the UE performs an emergency Registration. Not applicable for Nudr and Nudm_UECM GET operation. | +| backupAmfInfo | array(BackupAmfInfo) | C | 1..N | This IE shall be included if the NF service consumer is an AMF and the AMF supports the AMF management without UDSF.
The UDM uses this attribute to do an NRF query in order to invoke later services in a backup AMF, e.g. Namf_EventExposure. | + +| | | | | | +|---------------------|-----------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| drFlag | DualRegistration Flag | O | 0..1 | Dual Registration flag. When present and true, this flag indicates that the UDM+HSS is requested not to send S6a-CLR to the registered MME/SGSN (if any). Otherwise, the registered MME (if any) shall be cancelled.
Not applicable for Nudr and Nudm_UECM GET operation. | +| urrpIndicator | boolean | O | 0..1 | This IE indicates whether "UE_REACHABILITY_FOR_SMS" event or "UE_REACHABILITY_FOR_DATA" event for One-Time UE Activity notification (i.e. Max Number Of reports =1) with configuration "INDIRECT_REPORT" for this user has been subscribed or not:
- true: the event has been subscribed
- false, or absence of this attribute: the event for this user is currently not subscribed (NOTE 1) | +| amfEeSubscriptionId | Uri | C | 0..1 | Shall be present if urrpIndicator is true and the UDM has subscribed (e.g. on behalf of NEF) to ReachabilityReport event for "UE Reachability for DL Traffic" at the AMF to receive One-Time UE Activity notification. It contains the subscription Id URI allocated by the AMF as received by the UDM in the HTTP "Location" header of the Namf_EventExposure_Subscribe response.
The UDM shall make use of the Nudr_DataRepository Update service operation (see 3GPP TS 29.504 [9]) to store the amfEeSubscription Id in the UDR. | +| epsInterworkingInfo | EpsInterworkingInfo | C | 0..1 | This IE shall be included if the AMF has determined per APN/DNN which PGW-C+SMF is selected for EPS interworking with N26 and the AMF supports EPS interworking of non-3GPP access. For each APN/DNN, only one PGW-C+SMF shall be selected by the AMF for EPS interworking. | +| ueSrvccCapability | boolean | O | 0..1 | This IE indicates whether the UE supports 5G SRVCC:
- true: 5G SRVCC is supported by the UE and AMF;
- false, or absence of this attribute: 5G SRVCC is not supported. | +| registrationTime | DateTime | C | 0..1 | Time of Amf3GppAccessRegistration.
Shall be present when used on Nudr. | +| vgmlcAddress | VgmlcAddress | O | 0..1 | Address of the VGMLC | +| contextInfo | ContextInfo | C | 0..1 | This IE if present may contain e.g. the headers received by the UDM along with the Amf3GppAccessRegistration.
Shall be absent on Nudm and may be present on Nudr | +| noEeSubscriptionInd | boolean | O | 0..1 | This IE shall be absent on Nudr and may be present on Nudm. This indication is used by UDM to restore any possible ongoing subscription lost, as specified in clause 5.3.2.2.2.

When present, this IE shall indicate whether AMF does not have event exposure subscriptions in UE Context:
- true: No Event Exposure subscription existing in UE Context in AMF.
- false: Event Exposure subscription(s) exist in UE Context in AMF. | +| supi | Supi | C | 0..1 | This IE may be included by the AMF in registration requests and should be included by UDM in GET responses when the corresponding GET request provided a GPSI UE identity. | + +| | | | | | +|----------------------------|----------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueReachableInd | UeReachableInd | C | 0..1 |

This IE shall be present if the UE is currently not reachable (e.g. in not allowed areas) or the UE reachability is unknown (e.g. service restriction area of the UE is not received at the AMF during initial registration).

When the UE is not reachable (and based on operator policy when the UE reachability is unknown), the UDM shall keep the urrplndicator and amfEeSubscriptionId attributes and not generate Reachability Report for the UE.

Absence of this IE shall be interpreted as "REACHABLE".

| +| reRegistrationRequired | boolean | C | 0..1 |

This IE is only applicable to Nudr interface and shall not be included over the Nudm interface.

This attribute may be included in notifications sent by the UDR to the UDM if purgeFlag is also set to true in the same notification.

When Nudr Data Change Notification is received including this attribute and the purgeFlag, both set to true, the UDM uses "REREGISTRATION_REQUIRED" as DeregistrationReason towards AMF.

This attribute shall not be included and set to true if the adminDeregSubWithdrawn attribute is present and set to true.

Absence of this IE shall be interpreted as false.

| +| adminDeregSubWithdrawn | boolean | C | 0..1 |

This IE is only applicable to Nudr interface and shall not be included over the Nudm interface.

This attribute may be included in notifications sent by the UDR to the UDM if the purgeFlag is also set to true in the same notification.

When Nudr Data Change Notification is received including this attribute and the purgeFlag, both set to true, the UDM uses "SUBSCRIPTION_WITHDRAWN" as DeregistrationReason towards AMF.

This attribute shall not be included and set to true if the reRegistrationRequired attribute is present and set to true.

Absence of this IE shall be interpreted as false.

| +| dataRestorationCallbackUri | Uri | O | 0..1 |

If present, it contains the URI where notifications about UDR-initiated data restoration shall be sent by UDM.

| +| resetIds | array(string) | O | 1..N |

May be present in registration response messages. The AMF may decide to re-register at the UDM when receiving a data restoration notification containing a matching resetId.

| +| disasterRoamingInd | boolean | O | 0..1 |

Disaster Roaming Indicator (see 3GPP TS 23.502 [3]).

When present, this IE shall be set as follows:

  • - true: Disaster Roaming service is applied;
  • - false (default): Disaster Roaming service is not applied.
| +| ueMINTCapability | boolean | O | 0..1 |

This IE indicates whether the UE supports MINT:

  • - true: MINT is supported by the UE;
  • - false, or absence of this attribute: MINT is not supported.
| + +| | | | | | +|-------------------------|----------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sorSnpnSiSupported | boolean | O | 0..1 | This IE may be included by the AMF in registration requests; if present, it shall contain the capability of the UE or ME to support "Steering of Roaming SNPN Selection Information" (SOR-SNPN-SI).
- true: SOR-SNPN-SI is supported
- false or absent: SOR-SNPN-SI is not supported | +| udrRestartInd | boolean | O | 0..1 | May be present in request messages from the AMF to the UDM.
If present:
- true: indicates that the registration message sent by the AMF is due to a re-synchronization event, motivated by a previous reception at the AMF of a Data Restoration Notification from the UDM
- false (or absent): indicates that this is a normal registration message (i.e., not motivated by a data restoration notification event) | +| lastSynchronizationTime | DateTime | O | 0..1 | This IE is only applicable to the Nudm API and shall not be used on the Nudr API.
It may only be included when "udrRestartInd" attribute is present and set to true.
When present, it contains the timestamp (previously stored by AMF locally, after successful registration at UDM) when profiles in the AMF and in UDM/UDR were synchronized. | +| reauthNotifyCallbackUri | Uri | O | 0..1 | A URI provided by the AMF to receive (implicitly subscribed) notifications on reauthentication requests. | + +NOTE 1: The urrpIndicator attribute shall only be exposed over the Nudr SBI, and it shall not be included by the AMF. +NOTE 2: Regardless of the Dual Registration Flag, the SGSN, if any, is required to be cancelled (see 3GPP TS 23.502 [3] clause 4.11.5.2) + +#### 6.2.6.2.3 Type: AmfNon3GppAccessRegistration + +##### **Table 6.2.6.2.3-1: Definition of type AmfNon3GppAccessRegistration** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| amfInstanceId | NfInstanceId | M | 1 | The identity the AMF uses to register in the NRF. | +| deregCallbackUri | Uri | M | 1 | A URI provided by the AMF to receive (implicitly subscribed) notifications on deregistration.
The deregistration callback URI shall have unique information within AMF set to identify the UE to be deregistered. | +| guami | Guami | M | 1 | This IE shall contain the serving AMF's GUAMI. | +| ratType | RatType | M | 1 | This IE shall indicate the current RAT type of the UE. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.2.8
These are the features supported by the AMF. | +| purgeFlag | PurgeFlag | O | 0..1 | This flag indicates whether or not the AMF has deregistered. It shall not be included in the Registration service operation. | +| pei | Pei | O | 0..1 | Permanent Equipment Identifier
Absence of PEI indicates that the PEI is not available at the AMF. In this case the UDM/UDR shall not delete the PEI value stored from a previous registration.
If the UDR supports the PeiResource feature and the received PEI is of type IMEI(SV), the UDM shall also use the PeiInfo resource of the UDR to store the received PEI if it is different from the previously stored PEI or if the PeiInfo resource does not exist. | +| imsVoPs | ImsVoPs | M | 1 | Indicates per UE if "IMS Voice over PS Sessions" is supported, or not supported.
The value NON_HOMOGENEOUS_OR_UNKNOWN is not applicable. | +| amfServiceNameDereg | ServiceName | O | 0..1 | When present, this IE shall contain the name of the AMF service to which the Deregistration Notification is to be sent (see clause 6.5.2.2 of 3GPP TS 29.500 [4]). | +| pcscfRestorationCallbackUri | Uri | O | 0..1 | A URI provided by the AMF to receive (implicitly subscribed) notifications on the need for P-CSCF Restoration. | +| amfServiceNamePcscfRest | ServiceName | O | 0..1 | When present, this IE shall contain the name of the AMF service to which P-CSCF Restoration Notifications are to be sent (see clause 6.5.2.2 of 3GPP TS 29.500 [4]). This IE may be included if pcscfRestorationCallbackUri is present. | +| backupAmfInfo | array(BackupAmfInfo) | C | 1..N | This IE shall be included if the NF service consumer is an AMF and the AMF supports the AMF management without UDSF.
The UDM uses this attribute to do an NRF query in order to invoke later services in a backup AMF, e.g. Namf_EventExposure. | +| urrpIndicator | boolean | O | 0..1 | This IE indicates whether "UE_REACHABILITY_FOR_SMS" event or "UE_REACHABILITY_FOR_DATA" event for One-Time UE Activity notification (i.e. Max Number Of reports =1) with configuration "INDIRECT_REPORT" for this user has been subscribed or not:
- true: the event has been subscribed
- false, or absence of this attribute: the event for this user is currently not subscribed | + +| | | | | | +|------------------------|--------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| amfEeSubscriptionId | Uri | C | 0..1 | Shall be present if urrplndicator is true and the UDM has subscribed (e.g. on behalf of NEF) to Reachability-Report event for "UE Reachable for DL Traffic" at the AMF to receive One-Time UE Activity notification. It contains the subscription Id URI allocated by the AMF as received by the UDM in the HTTP "Location" header of the Namf_EventExposure_Subscribe response. The UDM shall make use of the Nudr_DataRepository Update service operation (see 3GPP TS 29.504 [9]) to store the amfEeSubscription Id in the UDR. | +| registrationTime | DateTime | C | 0..1 | Time of AmfNon3GppAccessRegistration. Shall be present when used on Nudr. | +| vgmlcAddress | VgmlcAddress | O | 0..1 | Address of the VGMLC | +| contextInfo | ContextInfo | C | 0..1 | This IE if present may contain e.g. the headers received by the UDM along with AmfNon3GppAccessRegistration. Shall be absent on Nudm and may be present on Nudr. | +| noEeSubscriptionInd | boolean | O | 0..1 | This IE shall be absent on Nudr and may be present on Nudm. This indication is used by UDM to restore any possible ongoing subscription lost, as specified in clause 5.3.2.2.3.

When present, this IE shall indicate whether AMF does not have event exposure subscriptions in UE Context:
- true: No Event Exposure subscription existing in UE Context in AMF.
- false: Event Exposure subscription(s) exist in UE Context in AMF. | +| supi | Supi | C | 0..1 | This IE may be included by the AMF in registration requests and should be included by UDM in GET responses when the corresponding GET request provided a GPSI UE identity. | +| reRegistrationRequired | boolean | C | 0..1 | This IE is only applicable to Nudr interface and shall not be included over the Nudm interface.

This attribute may be included in notifications sent by the UDR to the UDM if the purgeFlag is also set to true in the same notification.

When Nudr Data Change Notification is received including this attribute and the purgeFlag, both set to true, the UDM uses "REREGISTRATION_REQUIRED" as DeregistrationReason towards AMF.

This attribute shall not be included and set to true if the adminDeregSubWithdrawn attribute is present and set to true.

Absence of this IE shall be interpreted as false. | + +| | | | | | +|----------------------------|---------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| adminDeregSubWithdrawn | boolean | C | 0..1 |

This IE is only applicable to Nudr interface and shall not be included over the Nudm interface.

This attribute may be included in notifications sent by the UDR to the UDM if the purgeFlag is also set to true in the same notification.

When Nudr Data Change Notification is received including this attribute and the purgeFlag, both set to true, the UDM uses "SUBSCRIPTION_WITHDRAWN" as DeregistrationReason towards AMF.

This attribute shall not be included and set to true if the reRegistrationRequired attribute is present and set to true.

Absence of this IE shall be interpreted as false.

| +| dataRestorationCallbackUri | Uri | O | 0..1 | If present, it contains the URI where notifications about UDR-initiated data restoration shall be sent by UDM. | +| resetIds | array(string) | O | 1..N |

May be present in registration response messages.

The AMF may decide to re-register at the UDM when receiving a data restoration notification containing a matching resetId.

| +| disasterRoamingInd | boolean | O | 0..1 |

Disaster Roaming Indicator (see 3GPP TS 23.502 [3]).

When present, this IE shall be set as follows:

  • - true: Disaster Roaming service is applied;
  • - false (default): Disaster Roaming service is not applied.
| +| sorSnpnSiSupported | boolean | O | 0..1 |

This IE may be included by the AMF in registration requests; if present, it shall contain the capability of the UE or ME to support "Steering of Roaming SNPN Selection Information" (SOR-SNPN-SI).

  • - true: SOR-SNPN-SI is supported
  • - false or absent: SOR-SNPN-SI is not supported
| +| udrRestartInd | boolean | O | 0..1 |

May be present in request messages from the AMF to the UDM.

If present:

  • - true: indicates that the registration message sent by the AMF is due to a re-synchronization event, motivated by a previous reception at the AMF of a Data Restoration Notification from the UDM
  • - false (or absent): indicates that this is a normal registration message (i.e., not motivated by a data restoration notification event)
| +| lastSynchronizationTime | DateTime | O | 0..1 |

This IE is only applicable to the Nudm API and shall not be used on the Nudr API.

It may only be included when "udrRestartInd" attribute is present and set to true.

When present, it contains the timestamp (previously stored by AMF locally, after successful registration at UDM) when profiles in the AMF and in UDM/UDR were synchronized.

| +| reauthNotifyCallbackUri | Uri | O | 0..1 | A URI provided by the AMF to receive (implicitly subscribed) notifications on reauthentication requests. | + +| | +|----------------------------------------------------------------------------------------------------------------------------| +| NOTE: The urrpIndicator attribute shall only be exposed over the Nudr SBI, and it shall not be included by the AMF. | +|----------------------------------------------------------------------------------------------------------------------------| + +#### 6.2.6.2.4 Type: SmfRegistration + +**Table 6.2.6.2.4-1: Definition of type SmfRegistration** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|--------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smfInstanceId | NfInstanceId | M | 1 | NF Instance Id of the SMF | +| smfSetId | NfSetId | C | 0..1 | This IE shall be present if the SMF belongs to a SMF SET.
If present, it indicates the NF Set ID of SMF Set. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.2.8
These are the features supported by the SMF. | +| pduSessionId | PduSessionId | M | 1 | PDU Session ID | +| singleNssai | Snssai | M | 1 | A single Network Slice Selection Assistance Information.
It shall contain the HPLMN S-NSSAI of the LBO or HR roaming PDU session, or the S-NSSAI in the serving PLMN of the non roaming PDU session. | +| dnn | Dnn | C | 0..1 | Data Network Name; shall be present if emergencyServices is false or absent.
When present, this IE shall contain the Network Identifier only. | +| emergencyServices | boolean | C | 0..1 | Indication of Emergency Services; absence indicates false. | +| pcscfRestorationCallbackUri | Uri | O | 0..1 | a URI provided by the SMF to receive (implicitly subscribed) notifications on the need for P-CSCF Restoration | +| plmnId | PlmnId | M | 1 | Serving node PLMN identity.

For a HR PDU session, this IE shall include the PLMN ID of the home network of the UE. For a LBO PDU session, this IE shall include the PLMN ID of the serving network where the UE is registered from. | +| pgwFqdn | Fqdn | C | 0..1 | FQDN of the PGW in the "PGW-C+SMF", to be included for interworking with EPS. | +| pgwIpAddr | IpAddress | O | 0..1 | IP Address of the PGW in the "PGW-C+SMF", to be included for interworking with EPS. | +| epdgInd | boolean | O | 0..1 | Indicate whether access is from ePDG.
true: access from ePDG.
false or absent: not access from ePDG | +| deregCallbackUri | Uri | O | 0..1 | A URI provided by the SMF to receive (implicitly subscribed) notifications on deregistration.
The deregistration callback URI shall have unique information within SMF set to identify the UE to be deregistered. | +| registrationReason | RegistrationReason | O | 0..1 | Indicates registration reason. | +| registrationTime | DateTime | C | 0..1 | Time of SmfRegistration.
Shall be present when used on Nudr. | +| contextInfo | ContextInfo | C | 0..1 | This IE if present may contain e.g. the headers received by the UDM along with the SmfRegistration.
Shall be absent on Nudm and may be present on Nudr. | +| pcfId | NfInstanceId | C | 0..1 | This IE shall be present if the SMF is indicated to select the same PCF instance for SM Policy Control.
When present, it indicates the PCF Identifier that serving the PDU Session/PDN Connection. | +| dataRestorationCallbackUri | Uri | O | 0..1 | If present, it contains the URI where notifications about UDR-initiated data restoration shall be sent by UDM. | +| resetIds | array(string) | O | 1..N | May be present in registration response messages.
The SMF may decide to re-register at the UDM when receiving a data restoration notification containing a matching resetId. | + +| | | | | | +|--------------------------------|----------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| udrRestartInd | boolean | O | 0..1 | May be present in request messages from the SMF to the UDM.
If present:
- true: indicates that the registration message sent by the SMF is due to a re-synchronization event, motivated by a previous reception at the SMF of a Data Restoration Notification from the UDM.
- false (or absent): indicates that this is a normal registration message (i.e., not motivated by a data restoration notification event) | +| lastSynchronizationTime | DateTime | O | 0..1 | This IE is only applicable to the Nudm API and shall not be used on the Nudr API.
It may only be included when "udrRestartInd" attribute is present and set to true.
When present, it contains the timestamp (previously stored by SMF locally, after successful registration at UDM) when profiles in the SMF and in UDM/UDR were synchronized. | +| pduSessionReActivationRequired | boolean | C | 0..1 | This IE is only applicable to Nudr interface and shall not be included over the Nudm interface.

This attribute may be included in notifications sent by the UDR to the UDM.

When Nudr Data Change Notification is received including this attribute set to true, the UDM uses "PDU_SESSION_REACTIVATION_REQUIRED" as DeregistrationReason towards SMF. In this case, the SMF shall trigger a network-initiated PDU session release procedure (see clause 4.3.4 of 3GPP TS 23.502 [3]) with 5GSM cause "Reactivation requested" (see clause 8.3.14 of 3GPP TS 24.501 [27]).

Absence of this IE shall be interpreted as false. | +| staleCheckCallbackUri | Uri | O | 0..1 | A URI provided by the SMF to receive (implicitly subscribed) stale check notifications. The URI should contain a UE identifier allowing the SMF to correlate received notifications. | +| udmStaleCheckCallbackUri | Uri | O | 0..1 | May be present on Nudr and shall be absent on Nudm.
A URI provided by the UDM to receive (implicitly subscribed) stale check notifications from the UDR. The URI should contain a UE identifier allowing the UDM to correlate received notifications.
When the UDM receives a Stale Check Notification from the UDR, the UDM shall notify the SMF accordingly. If, as a result, the SMF replies with a list of unknown (stale) PDU session IDs, the UDM shall delete the indicated stale SMF registrations from the UDR using the Nudr_DR_Delete service operation. | +| wildcardInd | boolean | O | 0..1 | This IE is only applicable to the Nudr API and shall not be used on the Nudm API.
If present it indicates whether the PDN context is allocated for a wildcard DNN/APN case.
true: indicates that the PDN Context is allocated dynamically for a wildcard DNN/APN
false: indicates that the PDN Context is allocated for a distinct DNN/APN
Absence of this IE indicates to the receiver that the sender does not support sending this IE. | + +#### 6.2.6.2.5 Type: DeregistrationData + +**Table 6.2.6.2.5-1: Definition of type DeregistrationData** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------|----------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| deregReason | Deregistration Reason | M | 1 | String; see clause 6.2.6.3.3 | +| accessType | AccessType | C | 0..1 | Access type where the UE is deregistered. Shall be present in Deregistration Notifications sent to the AMF. | +| pduSessionId | PduSessionId | C | 0..1 | It shall be present if the deregistration of SMF happens.
If present, indicates PDU Session ID for which old SMF is deregistered. | +| newSmfInstanceId | NfInstanceId | O | 0..1 | NF Instance Id of the new SMF to which the SMF context is transferred. | + +#### 6.2.6.2.6 Type: SmsfRegistration + +**Table 6.2.6.2.6-1: Definition of type SmsfRegistration** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------|----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smsfInstanceId | NfInstanceId | M | 1 | NF Instance Id of the SMSF | +| smsfSetId | NfSetId | C | 0..1 | This IE shall be present if the SMSF belongs to an SMSF SET.
If present, it indicates the NF Set ID of SMSF Set. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.2.8
These are the features supported by the SMSF. | +| plmnId | PlmnId | M | 1 | Serving PLMN identity

This IE shall include the PLMN ID of the serving network where the UE is registered from. | +| smsfMAPAddress | E164Number | C | 0..1 | International E.164 number of the SMSF; shall be present if the SMSF supports MAP (see 3GPP TS 29.002 [21]) | +| smsfDiameterAddress | NetworkNodeDiameterAddress | C | 0..1 | shall be present if the SMSF supports Diameter (see 3GPP TS 29.338 [22]) | +| registrationTime | DateTime | C | 0..1 | Time of SmsfRegistration.
Shall be present when used on Nudr. | +| contextInfo | ContextInfo | C | 0..1 | This IE if present may contain e.g. the headers received by the UDM along with the SmsfRegistration.
Shall be absent on Nudm and may be present on Nudr.. | +| smsfSbiSupInd | boolean | C | 0..1 | SBI Support Indication of the SMSF. it shall be present if the SMSF support SBI-based MT SM transmit (see clauses 5.3.2.2.5 and 5.3.2.2.6).
Contains the indication on whether or not the SMSF is expecting to support SBI-based MT SM transmit.
- true: the SMSF supports SBI for MT SM transmit.
- false, or absence of this attribute: the SMSF do not support SBI for MT SM transmit. | +| dataRestorationCallbackUri | Uri | O | 0..1 | If present, it contains the URI where notifications about UDR-initiated data restoration shall be sent by UDM. | +| resetIds | array(string) | O | 1..N | May be present in registration response messages.
The SMSF may decide to re-register at the UDM when receiving a data restoration notification containing a matching resetId. | +| udrRestartInd | boolean | O | 0..1 | May be present in request messages from the SMSF to the UDM.
If present:
- true: indicates that the registration message sent by the SMSF is due to a re-synchronization event, motivated by a previous reception at the SMSF of a Data Restoration Notification from the UDM
- false (or absent): indicates that this is a normal registration message (i.e., not motivated by a data restoration notification event) | +| lastSynchronizationTime | DateTime | O | 0..1 | This IE is only applicable to the Nudm API and shall not be used on the Nudr API.
It may only be included when "udrRestartInd" attribute is present and set to true.
When present, it contains the timestamp (previously stored by SMSF locally, after successful registration at UDM) when profiles in the SMSF and in UDM/UDR were synchronized. | + +| | | | | | +|----------------------|---------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ueMemoryAvailableInd | boolean | C | 0..1 | When the SMSF detects that the UE has memory available for SMS, the SMSF shall send the registration message with ueMemoryAvailableInd set to true. Otherwise shall be absent.
When present and true, the UDM shall trigger Alert for SMS. Storing the ueMemoryAvailableInd in the UDR is not applicable. | +|----------------------|---------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +#### 6.2.6.2.7 Type: Amf3GppAccessRegistrationModification + +This type is derived from the type Amf3GppAccessRegistration by deleting all attributes that are not subject to modification by means of the HTTP PATCH method. + +**Table 6.2.6.2.7-1: Definition of type Amf3GppAccessRegistrationModification** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| guami | Guami | M | 1 | Guami of the AMF requesting the modification. If the MCC, MNC, AMF Region ID and AMF Set ID within the guami do not match the stored value, the modification request shall be rejected. | +| purgeFlag | PurgeFlag | O | 0..1 | This flag indicates whether or not the AMF has deregistered. It shall be included in the Deregistration service operation with a value of "TRUE". | +| pei | Pei | O | 0..1 | Permanent Equipment Identifier.
If the UDR supports the PeiResource feature and the received PEI is of type IMEI(SV), the UDM shall in addition to updating the Amf3GppAccessRegistration resource also update the PeiInfo resource of the UDR to store the received PEI if it is different from the previously stored PEI. | +| imsVoPs | ImsVoPs | O | 0..1 | Indicates per UE if "IMS Voice over PS Sessions" is homogeneously supported in all TAs in the serving AMF for the current PLMN and access type, or homogeneously not supported, or if support is non-homogeneous/unknown | +| backupAmfInfo | array(BackupAmfInfo) | C | 0..N | This IE shall be included if the NF service consumer is an AMF and the AMF supports the AMF management without UDSF for the Modification of the BackupAmfInfo.
The UDM uses this attribute to do an NRF query in order to invoke later services in a backup AMF, e.g. Namf_EventExposure.
An empty array indicates that the complete backupAmfInfo shall be deleted. | +| epsInterworkingInfo | EpsInterworkingInfo | C | 0..1 | This IE shall be included if the AMF has determined per APN/DNN which PGW-C+SMF is selected for EPS interworking with N26 and the AMF supports EPS interworking of non-3GPP access. This IE shall also be included to update the PGW-C+SMF information if the AMF selects another PGW-C+SMF for EPS interworking with N26 for the same DNN. For each APN/DNN, only one PGW-C+SMF shall be selected by the AMF for EPS interworking. | +| ueSrvccCapability | boolean | O | 0..1 | This IE indicates whether the UE supports 5G SRVCC:
- true: 5G SRVCC is supported by the UE and AMF;
- false: 5G SRVCC is not supported. | +| ueMINTCapability | boolean | O | 0..1 | This IE indicates whether the UE supports MINT:
- true: MINT is supported by the UE;
- false: MINT is not supported. | +| NOTE: Absence of optional attributes indicates: no modification. Attributes of this type are not marked "nullable: true" in the OpenAPI file as deletion of these attributes is not applicable. | | | | | + +#### 6.2.6.2.8 Type: AmfNon3GppAccessRegistrationModification + +This type is derived from the type AmfNon3GppAccessRegistration by deleting all attributes that are not subject to modification by means of the HTTP PATCH method. + +**Table 6.2.6.2.8-1: Definition of type AmfNon3GppAccessRegistrationModification** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| guami | Guami | M | 1 | Guami of the AMF requesting the modification. If the MCC, MNC, AMF Region ID and AMF Set ID within the guami do not match the stored value, the modification request shall be rejected. | +| purgeFlag | PurgeFlag | O | 0..1 | This flag indicates whether or not the AMF has deregistered. It shall be included in the Deregistration service operation with a value of "TRUE". | +| pei | Pei | O | 0..1 | Permanent Equipment Identifier.
If the UDR supports the PeiResource feature and the PEI is of type IMEI(SV), the UDM shall in addition to updating the AmfNon3GppAccessRegistration resource also update the PeiInfo resource of the UDR to store the received PEI if it is different from the previously stored PEI. | +| imsVoPs | ImsVoPs | O | 0..1 | If present indicates per UE that support of "IMS Voice over PS Sessions" has been modified to supported or not supported".
The value NON_HOMOGENEOUS_OR_UNKNOWN is not applicable. | +| backupAmfInfo | array(BackupAmfInfo) | C | 0..N | This IE shall be included if the NF service consumer is an AMF and the AMF supports the AMF management without UDSF for the Modification of the BackupAmfInfo.
The UDM uses this attribute to do an NRF query in order to invoke later services in a backup AMF, e.g. Namf_EventExposure.
An empty array indicates that the complete backupAmfInfo shall be deleted. | + +NOTE: Absence of optional attributes indicates: no modification. Attributes of this type are not marked "nullable: true" in the OpenAPI file as deletion of these attributes is not applicable. + +#### 6.2.6.2.9 Type: PscfRestorationNotification + +**Table 6.2.6.2.9-1: Definition of type PscfRestorationNotification** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|--------------------------------------------| +| supi | Supi | M | 1 | A SUPI that is served by the failed P-CSCF | +| failedPscf | PscfAddress | C | 0..1 | Information about the failed P-CSCF | + +#### 6.2.6.2.10 Type: NetworkNodeDiameterAddress + +**Table 6.2.6.2.10-1: Definition of type NetworkNodeDiameterAddress** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|-------------| +| name | DiameterIdentity | M | 1 | | +| realm | DiameterIdentity | M | 1 | | + +#### 6.2.6.2.11 Type: EpslwkPgw + +**Table 6.2.6.2.11-1: Definition of type EpslwkPgw** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|----------------------------------------| +| pgwFqdn | Fqdn | M | 1 | The PGW FQDN of the "PGW-C+SMF" | +| smfInstanceId | NfInstanceId | M | 1 | The SMF Instance Id of the "PGW-C+SMF" | +| plmnId | PlmnId | O | 0..1 | PLMN where the PGW-C+SMF is located | + +#### 6.2.6.2.12 Type: TriggerRequest + +**Table 6.2.6.2.12-1: Definition of type TriggerRequest** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-------------------------------------| +| supi | Supi | M | 1 | | +| failedPscf | PscfAddress | C | 0..1 | Information about the failed P-CSCF | + +#### 6.2.6.2.13 Type: AmfDeregInfo + +**Table 6.2.6.2.13-1: Definition of type AmfDeregInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|------------------------------| +| deregReason | Deregistration Reason | M | 1 | String; see clause 6.2.6.3.3 | + +#### 6.2.6.2.14 Type: EpsInterworkingInfo + +**Table 6.2.6.2.14-1: Definition of type EpsInterworkingInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| epsIwkPgws | map(EpsIwkPgw) | O | 0..N | A map (list of key-value pairs where dnn serves as key) of EpsIwkPgws.
An empty map is used in Amf3GppAccessRegistrationModification to delete the epsIwkPgws. | + +#### 6.2.6.2.15 Type: LocationInfo + +**Table 6.2.6.2.15-1: Definition of type LocationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------|---------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------| +| supi | Supi | O | 0..1 | Subscription Permanent Identifier (NOTE 1) | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier (NOTE 1) | +| registrationLocationInfoList | array(RegistrationLocationInfo) | M | 1..2 | Serving AMF, optional VGMLC and access type related informations used by (H)GMLC to send Location Request (NOTE 2) | +| supportedFeatures | SupportedFeatures | O | 0..1 | supported-features of the UDM | + +NOTE 1: One of both shall be included to identify the target UE. +NOTE 2: At least, one of 3GPP and Non-3GPP access types shall be included to describe the location related information of the target UE for the access type. + +#### 6.2.6.2.16 Type: RegistrationLocationInfo + +**Table 6.2.6.2.16-1: Definition of type RegistrationLocationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| amfInstanceId | NfInstanceId | M | 1 | The NF instance identity of the serving. | +| guami | Guami | O | 0..1 | The GUAMI served by the serving AMF. | +| plmnId | PlmnId | C | 0..1 | Serving node PLMN identity is included if the target UE is in roaming case for the serving AMF.
This attribute shall be present if the VGMLC address was registered by the serving AMF. Otherwise shall be absent.
(NOTE) | +| vgmlcAddress | VgmlcAddress | C | 0..1 | The address(es) of VGMLC. (NOTE) | +| accessTypeList | array(AccessType) | M | 1..2 | Access type(s) where the UE is registered | + +NOTE: The two IEs are only be included if the target UE is registered in VPLMN via the serving AMF. + +#### 6.2.6.2.17 Type: VgmlcAddress + +**Table 6.2.6.2.17-1: Definition of type VgmlcAddress** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|---------------------------------------------------------| +| vgmlcAddressIpv4 | Ipv4Addr | O | 0..1 | When present, indicates VGMLC IPv4 address. | +| vgmlcAddressIpv6 | Ipv6Addr | O | 0..1 | When present, indicates VGMLC IPv6 address. | +| vgmlcFqdn | Fqdn | O | 0..1 | When present, indicates FQDN of the VGMLC IPv6 address. | + +NOTE: At least, one of VGMLC addresses should be included. + +#### 6.2.6.2.18 Type: PeiUpdateInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| pei | Pei | M | 1 | | + +#### 6.2.6.2.19 Type: RegistrationDataSets + +**Table 6.2.6.2.19-1: Definition of type RegistrationDataSets** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------------------|---|-------------|-----------------------------------| +| amf3Gpp | Amf3GppAccessRegistration | O | 0..1 | AMF 3GPP Access Registration | +| amfNon3Gpp | AmfNon3GppAccessRegistration | O | 0..1 | AMF Non 3GPP Access Registration | +| smfRegistration | SmfRegistrationInfo | O | 0..1 | SMF Registration Information | +| smsf3Gpp | SmsfRegistration | O | 0..1 | SMSF 3GPP Access Registration | +| smsfNon3Gpp | SmsfRegistration | O | 0..1 | SMSF Non 3GPP Access Registration | +| ipSmGw | IpSmGwRegistration | O | 0..1 | IP-SM-GW Registration | +| nwdafRegistration | NwdafRegistrationInfo | O | 0..1 | NWDAF Registration Information | + +#### 6.2.6.2.20 Type: IpSmGwRegistration + +Table 6.2.6.2.20-1: Definition of type IpSmGwRegistration + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipSmGwMapAddress | E164Number | C | 0..1 | International E.164 number of the IP-SM-GW; it shall be present if the IP-SM-GW supports MAP (see 3GPP TS 29.002 [21])
(NOTE 1) | +| ipSmGwDiameterAddress | NetworkNodeDiameterAddress | C | 0..1 | Diameter Identity of the IP-SM-GW; it shall be present if the IP-SM-GW supports Diameter (see 3GPP TS 29.328 [52])
(NOTE 1) | +| ipsmgwlpv4 | Ipv4Addr | C | 0..1 | This IE shall be present if available. When present, this IE indicates the IPv4 address of the IP-SM-GW.
(NOTE 1) | +| ipsmgwlpv6 | Ipv6Addr | C | 0..1 | This IE shall be present if available. When present, this IE indicates the IPv6 address of the IP-SM-GW.
(NOTE 1) | +| ipsmgwFqdn | Fqdn | C | 0..1 | This IE shall be present if available. When present, this IE indicates the FQDN of the IP-SM-GW.
(NOTE 1) | +| ipSmGwSbiSupInd | boolean | C | 0..1 | SBI Support Indication of the IP-SM-GW. it shall be present if provided in IP-SM-GW registration procedure (see clauses 5.3.2.2.7)
Contains the indication on whether or not the IP-SM-GW is expecting to support SBI-based MT SM transmit.
- true: the IP-SM-GW supports SBI for MT SM transmit.
- false, or absence of this attribute: the IP-SM-GW do not support SBI for MT SM transmit. | +| nflInstanceId | NflInstanceId | C | 0..1 | NF Instance ID of the SBI-capable IP-SM-GW | +| unrIlIndicator | boolean | O | 0..1 | UE-Not-Reachable-for-IP (UNRI) flag as defined in 3GPP TS 23.040 [53]. This IE indicates whether the address list of MWD contains one or more entries because an attempt to deliver a short message to a UE via an IP-SM-GW has failed with a cause of Absent Subscriber:
- true: the MWD contains one or more list elements due to an SMS delivery failure
- false, or absence of this attribute: the MWD does not contain any list element | +| resetIds | array(string) | O | 1..N | May be present in registration response messages.
The IP-SM-GW may decide to re-register at the UDM when receiving a data restoration notification containing a matching resetId. | + +NOTE 1: At least one of the properties, ipSmGwMapAddress or ipSmGwDiameterAddress or ipsmgwlpv4 or ipsmgwlpv6 or ipsmgwFqdn, shall be present. If the IP-SM-GW supports SBI, the nflInstanceId property shall be present. + +NOTE 2: The unrIlIndicator attribute shall only be exposed over the Nudr SBI. + +##### 6.2.6.2.20A Type: SmfRegistrationInfo + +Table 6.2.6.2.20A-1: Definition of type SmfRegistrationInfo + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------|---|-------------|--------------------------| +| smfRegistrationList | array(SmfRegistration) | M | 1..N | List of SmfRegistration. | + +#### 6.2.6.2.21 Type: NwdafRegistration + +**Table 6.2.6.2.21-1: Definition of type NwdafRegistration** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nwdafInstanceId | NfInstanceId | M | 1 | NF Instance Id of the NWDAF. | +| analyticsIds | array(EventId) | M | 1..N | List of analytics Id(s) provided by the consumers of NWDAF. | +| nwdafSetId | NfSetId | C | 0..1 | This IE shall be present if the NWDAF belongs to an NWDAF SET.
If present, it indicates the NF Set ID of NWDAF Set. | +| registrationTime | DateTime | C | 0..1 | Time of NwdafRegistration. Shall be present when used on Nudr. | +| contextInfo | ContextInfo | C | 0..1 | This IE if present may contain e.g. the headers received by the UDM along with the NwdafRegistration.
Shall be absent on Nudm and may be present on Nudr. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.2.8
These are the features supported by the NWDAF. | +| resetIds | array(string) | O | 1..N | May be present in registration response messages.
The NWDAF may decide to re-register at the UDM when receiving a data restoration notification containing a matching resetId. | + +#### 6.2.6.2.22 Type: NwdafRegistrationModification + +**Table 6.2.6.2.22-1: Definition of type NwdafRegistrationModification** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------| +| nwdafInstanceId | NfInstanceId | M | 1 | NF Instance Id of the NWDAF | +| nwdafSetId | NfSetId | C | 0..1 | This IE shall be present if the NWDAF belongs to an NWDAF SET.
If present, it indicates the NF Set ID of NWDAF Set. | +| analyticsIds | array(EventId) | O | 0..N | List of analytics Id(s) supplied by NWDAF. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.2.8
These are the features supported by the NWDAF. | +| NOTE: Absence of optional attributes indicates: no modification. Attributes of this type are not marked "nullable: true" in the OpenAPI file as deletion of these attributes is not applicable. | | | | | + +#### 6.2.6.2.23 Type: SmfRegistrationModification + +This type is derived from the type SmfRegistration by deleting all attributes that are not subject to modification by means of the HTTP PATCH method. + +**Table 6.2.6.2.23-1: Definition of type SmfRegistrationModification** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smfInstanceId | NfInstanceId | M | 1 | NF Instance Id of the SMF requesting the modification. If the NF Set Id is absent and the NF Instance Id does not match the stored NF Instance Id value, the modification request shall be rejected. | +| smfSetId | NfSetId | O | 0..1 | NF Set Id of the SMF requesting the modification. If the NF Set Id is present and does not match the stored NF Set Id value, the modification request shall be rejected. | +| pgwFqdn | FqdnRm | C | 0..1 | FQDN of the PGW in the "PGW-C+SMF", to be included for interworking with EPS. For deletion of the PGW FQDN, the value of the pgwFqdn shall be set to null. | + +NOTE: Absence of optional attributes indicates: no modification. Attributes of this type are not marked "nullable: true" in the OpenAPI file as deletion of these attributes is not applicable. + +6.2.6.2.24 Type: RoamingInfoUpdate + +**Table 6.2.6.2.24-1: Definition of type RoamingInfoUpdate** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servingPlmn | PlmnId | M | 1 | the new Serving PLMN | +| roaming | boolean | C | 0..1 | This IE shall be included if the roaming status changes (from roaming to non-roaming or vice versa).
True: The new serving PLMN is different from the HPLMN;
False: The new serving PLMN is the HPLMN | + +#### 6.2.6.2.25 Type: DataRestorationNotification + +**Table 6.2.6.2.25-1: Definition of type DataRestorationNotification** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lastReplicationTime | DateTime | O | 0..1 | If present, it contains the timestamp of the most recent instant when the data was assumed to be consistent at UDR (i.e. the potential data loss event at UDR did not occur before this instant). | +| recoveryTime | DateTime | O | 0..1 | If present, it contains the timestamp of the instant when the potential data loss event was recovered at UDR (i.e. all data records stored by UDR after this time are assumed to be consistent). | +| plmnId | PlmnId | C | 0..1 | If present, it shall contain the PLMN-ID of the UDM/UDR that originated the Data Restoration Notification.
It shall be included in notifications sent by UDM to its NF consumers located in other PLMNs. | +| supiRanges | array(SupiRange) | O | 1..N | If present, it contains the list of SUPIs potentially subject to a data-loss event at the UDR. | +| gpsiRanges | array(IdentityRange) | O | 1..N | If present, it contains the list of GPSIs potentially subject to a data-loss event at the UDR. | +| resetIds | array(string) | O | 1..N | If present, it contains the list of Reset-IDs of those UEs potentially subject to a data-loss event at the UDR. | +| sNssaiList | array(Snssai) | O | 1..N | If present, it contains the list of slices (S-NSSAIs) potentially subject to a data-loss event at the UDR. | +| dnnList | array(Dnn) | O | 1..N | If present, it contains the list of DNNs potentially subject to a data-loss event at the UDR. | +| udmGroupId | NfGroupId | O | 1..N | If present, it contains the ID of the UDM Group whose UEs have been potentially subject to a data loss event at the UDR. | + +#### 6.2.6.2.26 Type: PscfAddress + +**Table 6.2.6.2.26-1: Definition of type PscfAddress** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|------------------------------------------------------------------| +| ipv4Addrs | array(Ipv4Addr) | O | 1..N | If present, it contains IPv4 address(es) of the P-CSCF (NOTE 2). | +| ipv6Addrs | array(Ipv6Addr) | O | 1..N | If present, it contains IPv6 address(es) of the P-CSCF (NOTE 2). | +| fqdn | Fqdn | O | 0..1 | If present, it contains the FQDN of the P-CSCF. | + +NOTE 1: At least, one of these P-CSCF addressing attributes shall be included. +NOTE 2: Several addresses may be included (in ipv4Addrs or ipv6Addrs) to convey multiple redundant IP endpoints on the Mw interface of the P-CSCF. + +#### 6.2.6.2.27 Type: NwdafRegistrationInfo + +**Table 6.2.6.2.27-1: Definition of type NwdafRegistrationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|--------------------------|---|-------------|----------------------------| +| nwdafRegistrationList | array(NwdafRegistration) | M | 1..N | List of NwdafRegistration. | + +#### 6.2.6.2.28 Type: RoutingInfoSmRequest + +**Table 6.2.6.2.28-1: Definition of type RoutingInfoSmRequest** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipSmGwInd | boolean | C | 0..1 | This IE indicates whether the SMS-GMSC is prepared to receive IP-SM-GW guidance information in the response:
- true: receiving IP-SM-GW guidance in the response is supported;
- false, or absence: receiving IP-SM-GW guidance in the response is not supported. | +| supportedFeatures | SupportedFeatures | O | 0..1 | Features of the Nudm_UECM API supported by the NF Service Consumer. | + +#### 6.2.6.2.29 Type: RoutingInfoSmResponse + +**Table 6.2.6.2.29-1: Definition of type RoutingInfoSmResponse** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|-----------------------------------| +| supi | Supi | O | 0..1 | Contains the SUPI of the UE | +| smsf3Gpp | SmsfRegistration | O | 0..1 | SMSF 3GPP Access Registration | +| smsfNon3Gpp | SmsfRegistration | O | 0..1 | SMSF Non 3GPP Access Registration | +| ipSmGw | IpSmGwInfo | O | 0..1 | IP-SM-GW Registration | +| smsRouter | SmsRouterInfo | O | 0..1 | SMS Router address | + +#### 6.2.6.2.30 Type: IpSmGwInfo + +**Table 6.2.6.2.30-1: Definition of type IpSmGwInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipSmGwRegistration | IpSmGwRegistration | M | 1 | IP-SM-GW routing information | +| ipSmGwGuidance | IpSmGwGuidance | C | 0..1 | Contains the recommended and the minimum timer values for supervision of MT SMS response. It shall be present if the ipSmGwInd attribute in the request is set to true. | + +#### 6.2.6.2.31 Type: IpSmGwGuidance + +**Table 6.2.6.2.31-1: Definition of type IpSmGwGuidance** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------|---|-------------|----------------------------------------------------------------------------------| +| minDeliveryTime | integer | M | 1 | The minimum timer value in units of seconds.
Minimum = 30. Maximum = 600. | +| recommDeliveryTime | integer | M | 1 | The recommended timer value in units of seconds.
Minimum = 30. Maximum = 600. | + +#### 6.2.6.2.32 Type: SmsRouterInfo + +**Table 6.2.6.2.32-1: Definition of type SmsRouterInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| nflInstanceId | NflInstanceId | O | 0..1 | NF Instance ID of the SMS Router | +| diameterAddress | NetworkNodeDiameterAddress | O | 0..1 | Diameter address of the SMS Router | +| mapAddress | E164Number | O | 0..1 | MAP address of the SMS Router | +| routerIpv4 | Ipv4Addr | O | 0..1 | This IE shall be present if available. When present, this IE indicates the IPv4 address of the SMS Router. | +| routerIpv6 | Ipv6Addr | O | 0..1 | This IE shall be present if available. When present, this IE indicates the IPv6 address of the SMS Router. | +| routerFqdn | Fqdn | O | 0..1 | This IE shall be present if available. When present, this IE indicates the FQDN of the SMS Router. | + +#### 6.2.6.2.33 Type: SmSFRegistrationModification + +This type is derived from the type SmSFRegistration by deleting all attributes that are not subject to modification by means of the HTTP PATCH method. + +**Table 6.2.6.2.33-1: Definition of type SmSFRegistrationModification** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smSFInstanceId | NflInstanceId | M | 1 | NF Instance Id of the SMF requesting the modification. If the NF Set Id is absent and the NF Instance Id does not match the stored NF Instance Id value, the modification request shall be rejected. | +| smfSetId | NfSetId | O | 0..1 | NF Set Id of the SMF requesting the modification. If the NF Set Id is present and does not match the stored NF Set Id value, the modification request shall be rejected. | +| ueMemoryAvailableInd | boolean | C | 0..1 | When the SMF detects that the UE has memory available for SMS, the SMF shall send the update message with ueMemoryAvailableInd set to true. Otherwise shall be absent. When present and true, the UDM shall trigger Alert for SMS. Storing the ueMemoryAvailableInd in the UDR is not applicable. | + +#### 6.2.6.2.34 Type: PduSessionIds + +**Table 6.2.6.2.34-1: Definition of type PduSessionIds** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|---------------------|---|-------------|--------------------------| +| pduSessionIdList | array(PduSessionId) | O | 1..N | A list of PDUSession IDs | + +#### 6.2.6.2.35 Type: ReauthNotificationInfo + +**Table 6.2.6.2.35-1: Definition of type ReauthNotificationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------| +| supi | Supi | M | 1 | Subscription Permanent Identifier | + +#### 6.2.6.2.36 Type: AuthTriggerInfo + +**Table 6.2.6.2.36-1: Definition of type AuthTriggerInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| supi | Supi | O | 0..1 | SUPI | + +#### 6.2.6.2.37 Type: DeregistrationRespData + +**Table 6.2.6.2.37-1: Definition of type DeregistrationRespData** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smfEventRemovedInd | boolean | C | 0..1 | When present, this IE shall be set to the value "true" indicating the SMF event subscriptions on the SMF for the UE have been implicitly removed by the SMF.

The presence of this IE with the value "false" is prohibited. | + +### 6.2.6.3 Simple data types and enumerations + +#### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|----------------------|-----------------|----------------------------------------------------------------| +| PurgeFlag | boolean | This flag indicates whether or not the NF has deregistered. | +| E164Number | string | see ITU-T Recommendation E.164 [23]
pattern: ^[0-9]{1,15}\$ | +| DualRegistrationFlag | boolean | Dual Registration Flag | + +#### 6.2.6.3.3 Enumeration: DeregistrationReason + +The enumeration DeregistrationReason represents the reason for the Deregistration Notification. It shall comply with the provisions defined in table 6.2.6.3.3-1. + +**Table 6.2.6.3.3-1: Enumeration DeregistrationReason** + +| Enumeration value | Description | +|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "UE_INITIAL_REGISTRATION" | When sent by the HSS; indicates that the deregistration towards the UDM is due to an initial attach in EPS.
When sent by the UDM; indicates that the deregistration in the old AMF is due to a new AMF serving the UE during an initial registration
See 3GPP TS 23.502 [3] and 3GPP TS 23.632 [32]. | +| "UE_REGISTRATION_AREA_CHANGE" | see 3GPP TS 23.502 [3] | +| "SUBSCRIPTION_WITHDRAWN" | see 3GPP TS 23.502 [3] | +| "5GS_TO_EPS_MOBILITY" | see 3GPP TS 23.502 [3] and 3GPP TS 23.632 [32]. | +| "5GS_TO_EPS_MOBILITY_UE_INITIAL_REGISTRATION" | This value shall only be sent by the UDM. It indicates that the deregistration in AMF is due to an initial attach in EPS, See 3GPP TS 23.502 [3] and 3GPP TS 23.632 [32]. | +| "REREGISTRATION_REQUIRED" | see 3GPP TS 23.502 [3] | +| "SMF_CONTEXT_TRANSFERRED" | see 3GPP TS 23.502 [3] | +| "DUPLICATE_PDU_SESSION" | This value shall only be sent by the UDM to an SMF. It indicates that the deregistration in the SMF is due to a new PDU session with the same PDU session ID has been established in another SMF. | +| "PDU_SESSION_REACTIVATION_REQUIRED" | This value shall only be sent by the UDM to an SMF. It indicates that the PDU session being released is requested to be re-activated. | +| "DISASTER_CONDITION_TERMINATED" | This value shall be used by the UDM when the disaster condition ceases. | +| "OPERATOR_DETERMINED_BARRING" | This value indicates that the deregistration is due to ODB (see 3GPP TS 23.015 [71]). | + +#### 6.2.6.3.4 Enumeration: ImsVoPs + +The enumeration ImsVoPs represents information indicating homogeneity of IMS Voice over PS Sessions support for the UE. It shall comply with the provisions defined in table 6.2.6.3.4-1. + +**Table 6.2.6.3.4-1: Enumeration ImsVoPs** + +| Enumeration value | Description | +|------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| "HOMOGENEOUS_SUPPORT" | "IMS Voice over PS Sessions" is homogeneously supported in all TAs in the serving AMF. | +| "HOMOGENEOUS_NON_SUPPORT" | "IMS Voice over PS Sessions" is homogeneously not supported in all TAs in the serving AMF. | +| "NON_HOMOGENEOUS_OR_UNKNOWN" | "IMS Voice over PS Sessions" is not homogeneously supported in all TAs in the serving AMF, or its support is unknown. | + +#### 6.2.6.3.5 Enumeration: RegistrationReason + +The enumeration RegistrationCause represents the reason for the NF Registration. It shall comply with the provisions defined in table 6.2.6.3.5-1. + +**Table 6.2.6.3.5-1: Enumeration RegistrationReason** + +| Enumeration value | Description | +|---------------------------|-----------------| +| "SMF_CONTEXT_TRANSFERRED" | SMF transferred | + +##### 6.2.6.3.6 Enumeration: RegistrationDataSetName + +**Table 6.2.6.3.6-1: Enumeration RegistrationDataSetName** + +| Enumeration value | Description | +|--------------------|-----------------------------------| +| "AMF_3GPP" | AMF 3GPP Access Registration | +| "AMF_NON_3GPP" | AMF Non 3GPP Access Registration | +| "SMF_PDU_SESSIONS" | SMF PDU Session Registration | +| "SMSF_3GPP" | SMSF 3GPP Access Registration | +| "SMSF_NON_3GPP" | SMSF Non 3GPP Access Registration | +| "IP_SM_GW" | IP-SM-GW Registration | +| "NWDAF" | NWDAF Registration | + +NOTE: The current naming conventions for Enumerations (uppercase with underscore), when their intended usage is for query parameters is not consistent with the naming conventions for URI components (lowercase with hyphen). + +#### 6.2.6.3.7 Enumeration: UeReachableInd + +**Table 6.2.6.3.7-1: Enumeration UeReachableInd** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "REACHABLE" | Indicates the UE is currently reachable for services, i.e. the UE is in allowed areas. | +| "NOT_REACHABLE" | Indicates the UE is currently not reachable for services, i.e. the UE is in not allowed areas. | +| "UNKNOWN" | Indicates whether UE is in not allowed area is unknown, e.g. the AMF does not have the UE subscription data including the Service Area Restriction Configuration for the UE when performing UECM Registration. | + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +The Cause codes mapping performed by AMF between the following HTTP responses returned by the UDM services to the AMF and the 5GMM related values is specified in clause 4.4.2 of 3GPP TS 29.524 [44]. + +#### 6.2.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.2.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_UEContextManagement service. The following application errors listed in Table 6.2.7.3-1 are specific for the Nudm\_UEContextManagement service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NF_CONSUMER_REDIRECT_ONE_TXN | 307 Temporary Redirect | The request has been asked to be redirected to a specified target for one transaction. | +| CONTEXT_NOT_FOUND | 308 Permanent Redirect | The request has been asked to be redirected to a specified target. | +| UNKNOWN_5GS_SUBSCRIPTION | 403 Forbidden | No 5GS subscription is associated with the user. | +| NO_PS_SUBSCRIPTION | 403 Forbidden | No PS (5GS, EPS, GPRS) subscription is associated with the user. | +| ROAMING_NOT_ALLOWED | 403 Forbidden | The subscriber is not allowed to roam within that PLMN | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used when no corresponding context exists. | +| ACCESS_NOT_ALLOWED | 403 Forbidden | Access type not allowed for the user. | +| RAT_NOT_ALLOWED | 403 Forbidden | RAT is not allowed for the user | +| DNN_NOT_ALLOWED | 403 Forbidden | DNN not authorized for the user | +| REAUTHENTICATION_REQUIRED | 403 Forbidden | Due to operator policies the user needs to be re-authenticated, e.g. if the last authentication is considered obsolete, or there is no AUSF instance id stored in the UDM during EPS to 5GS mobility. | +| INVALID_GUAMI | 403 Forbidden | The AMF is not allowed to modify the registration information stored in the UDM, as it is not the registered AMF. | +| SERVICE_NOT_PROVISIONED | 403 Forbidden | The request is related to a service that is not provisioned for the user in the 5GS subscription data (e.g. MT-SMS not provisioned). | +| SERVICE_NOT_ALLOWED | 403 Forbidden | The request is related to a service that is not allowed for the user in the 5GS subscription data (e.g. MT-SMS is barred). | +| SNPN_NOT_ALLOWED | 403 Forbidden | The user is not authorized to access an SNPN, when the registration to the SNPN is performed by using credentials from the Credentials Holder. | +| REAUTHENTICATION_NOT_ALLOWED | 403 Forbidden | The serving AMF does not allow the UE to be re-authenticated, or the UDM does not allow to trigger a primary authentication procedure. | +| TEMPORARY_REJECT_REGISTRATION_ONGOING | 409 Conflict | The request cannot be processed due to an ongoing registration procedure. | +| TEMPORARY_REJECT_HANDOVER_ONGOING | 409 Conflict | The request cannot be processed due to an ongoing N2 handover procedure. | +| UNPROCESSABLE_REQUEST | 422 Unprocessable Entity | The request cannot be processed due to semantic errors when trying to process a patch method | +| ABSENT_SUBSCRIBER_SM | 404 Not Found | The UE is not reachable for MT-SMS (e.g. SMSF registered but not reachable as indicated by SMS message waiting data or by URRP flag) | +| DATA_NOT_FOUND | 404 Not Found | The requested data associated to the UE or Group does not exist | +| AF_NOT_ALLOWED | 403 Forbidden | This AF is not allowed to perform monitoring configuration. | +| GROUP_IDENTIFIER_NOT_FOUND | 404 Not Found | The group does not exist | + +### 6.2.8 Feature Negotiation + +The optional features in table 6.2.8-1 are defined for the Nudm\_UECM API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | SharedData | When receiving a Nudm_UECM_Registration service operation request for a UE that shares subscription data with other UEs, and the request does not indicate support of this feature by the service consumer, the UDM may – based on operator policy – decide to reject the registration. | +| 2 | PatchReport | If some of the modifications included in the PATCH request are not successfully implemented, the UDM reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [4]. | +| 3 | SharedDataTreatment | This feature is an extension to the SharedData feature, i.e. support of SharedDataTreatment requires support of SharedData. When receiving a Nudm_UECM_Registration service operation request for a UE that shares subscription data with treatment instruction with other UEs, and the request does not indicate support of this feature by the service consumer, the UDM may – based on operator policy – decide to reject the registration. | +| 4 | CAGFeature | If the NF consumer (AMF) does not support this feature and the UE is allowed to access 5GS via CAG cell(s) only, the UDM shall reject AMF registration. | +| 5 | DeregistrationResponseBody | The UDM and the NF consumer (e.g. SMF) supporting this feature shall support sending information in Deregistration Notification body with "200 OK" response (e.g. the indication that the SMF event subscriptions on the SMF for the UE have been implicitly removed). | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nudm\_UECM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nudm\_UECM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudm\_UECM service. + +The Nudm\_UECM API defines the following scopes for OAuth2 authorization: + +**Table 6.2.9-1: OAuth2 scopes defined in Nudm\_UECM API** + +| Scope | Description | +|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| "nudm-uecm" | Access to the Nudm UE Context Management API | +| "nudm-uecm:amf-registration:write" | Write access (update/modify) to representations of the Amf3GppAccessRegistration and AmfNon3GppAccessRegistration resources. | +| "nudm-uecm:smf-registration:write" | Write access (create/delete/modify) to the representations of a individualSmfRegistration resources. | +| "nudm-uecm:smsf-registration:write" | Write access (create/delete/modify) to representations of the Smsf3GppAccessRegistration and SmsfNon3GppAccessRegistration resources. | +| "nudm-uecm:ip-sm-gw-registration:write" | Write access (create/delete/modify) to the representation of the IpSmGwRegistration resource. | + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different UDM service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UDM producer instance will return the NF Instance ID of the new UDM producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UDM redirects a service request to a different UDM using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UDM towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.3 Nudm\_UEAuthentication Service API + +### 6.3.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion} + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot}
+ +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nudm-ueau". +- The shall be "v1". +- The shall be set as described in clause 6.3.3. + +### 6.3.2 Usage of HTTP + +#### 6.3.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [13], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nudm\_UEAU service shall comply with the OpenAPI [14] specification contained in Annex A4. + +#### 6.3.2.2 HTTP standard headers + +##### 6.3.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.3.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 9457 [16]) signalled by the content type "application/problem+json" + +#### 6.3.2.3 HTTP custom headers + +##### 6.3.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.3.3 Resources + +#### 6.3.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.3.3.1-1 depicts the resource URIs structure for the Nudm\_UEAU API. + +//{apiRoot}/nudm-ueau/v1 + +![API tree diagram for nudm-ueau/v1 showing endpoints for {supiOrSuci} and {supi}.](b58cedaf15ad4f0edee5621820865ccc_img.jpg) + +``` +graph TD; Root[//{apiRoot}/nudm-ueau/v1] --- SupiOrSuci[/{supiOrSuci}]; Root --- Supi[/{supi}]; SupiOrSuci --- SecInfo[/security-information]; SupiOrSuci --- SecInfoRg[/security-information-rg]; SupiOrSuci --- AuthEvent[/auth-event]; SupiOrSuci --- ProseSecInfo[/prose-security-information]; SecInfo --- GenAuthData[/generate-auth-data]; AuthEvent --- AuthEventId[/authEventId]; ProseSecInfo --- GenAv1[/generate-av]; Supi --- HssSecInfo[/hss-security-information]; Supi --- GbaSecInfo[/gba-security-information]; HssSecInfo --- HssAuthType[/auth-type]; HssAuthType --- GenAv2[/generate-av]; GbaSecInfo --- GenAv3[/generate-av]; +``` + +The diagram illustrates the API structure for nudm-ueau/v1. It branches into two main paths: `/{supiOrSuci}` and `/{supi}`. The `/{supiOrSuci}` path includes endpoints for `/security-information` (with a `/generate-auth-data` sub-endpoint), `/security-information-rg`, `/auth-event` (with a `/{authEventId}` sub-endpoint), and `/prose-security-information` (with a `/generate-av` sub-endpoint). The `/{supi}` path includes endpoints for `/hss-security-information` (with a `/{auth-type}` sub-endpoint and a `/generate-av` sub-endpoint) and `/gba-security-information` (with a `/generate-av` sub-endpoint). Solid boxes represent primary endpoints, while dashed boxes represent sub-endpoints. + +API tree diagram for nudm-ueau/v1 showing endpoints for {supiOrSuci} and {supi}. + +**Figure 6.3.3.1-1: Resource URI structure of the Nudm\_UEAU API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name
(Archetype)
| Resource URI | HTTP
method
or
custom
operation
| Description | +|------------------------------------------------|------------------------------------------------------------|--------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SecurityInformation
(Custom operation) | /{supiOrSuci}/security-information/generate-auth-data | generate-auth-data
(POST) | If the variable {supiOrSuci} takes the value of a SUCI, the UDM calculates the corresponding SUPI. If the variable {supiOrSuci} takes the value of an anonymous SUCI, the UDM calculates the corresponding anonymous SUPI. The UDM calculates a fresh authentication vector based on the received information and the stored security information for the SUPI if 5G-AKA or EAP-AKA' is selected. Otherwise, UDM provides corresponding authentication information. | +| SecurityInformationForRg | /{supiOrSuci}/security-information-rg | GET | If the variable {supiOrSuci} takes the value of a SUCI, the UDM calculates the corresponding SUPI. The UDM decides, based on the received information and the stored authentication profile of the SUPI, that authentication by the home network is not required for the FN-RG. | +| AuthEvents
(Collection) | /{supi}/auth-events | POST | Create an Authentication Event | +| Individual AuthEvent
(Document) | /{supi}/auth-events/{authEventId} | PUT | Update an Authentication Event | +| HssSecurityInformation
(Custom operation) | /{supi}/hss-security-information/{hssAuthType}/generate-av | generate-av
(POST) | The UDM generates the authentication vector(s) of the requested type based on stored security information for the SUPI. | +| GbaSecurityInformation
(Custom operation) | /{supi}/gba-security-information/generate-av | generate-av
(POST) | The UDM generates the authentication vector(s) of the requested type based on stored security information for the SUPI. | +| ProSeSecurityInformation
(Custom operation) | /{supiOrSuci}/prose-security-information/generate-av | generate-av
(POST) | If the variable {supiOrSuci} takes the value of a SUCI, the UDM calculates the corresponding SUPI. The UDM decides, based on the received information and the stored authentication profile of the SUPI. | + +#### 6.3.3.2 Resource: SecurityInformation (Custom operation) + +#### 6.3.3.2.1 Description + +This resource represents the information that is needed together with the serving network name and the access type to calculate a fresh authentication vector. See 3GPP TS 33.501 [6]. + +##### 6.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nudm-ueau/v1/{supiOrSuci}/security-information + +This resource shall support the resource URI variables defined in table 6.3.3.2.2-1. + +**Table 6.3.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| supiOrSuci | string | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2), or Subscription Concealed Identifier (see 3GPP TS 23.003 [8]).

Pattern: See pattern of type SupiOrSuci in 3GPP TS 29.571 [7]

(See NOTE 1, NOTE 2, NOTE 3). | + +NOTE 1: The format for SUCI, when the corresponding SUPI is NAI-based, contains a realm that may include a "minus" character ("-"), which is also used as field separator. Given that the NAI and its realm shall conform to IETF RFC 7542 [29], the regular expression defined here allows for non-ambiguous matching of the different fields of the SUCI, even when the realm contains the "minus" character. + +NOTE 2: When the SUCI corresponds to a SUPI of type IMSI, and the Null protection scheme is used, the MSIN of the IMSI (which is formatted by the UE and sent over the NAS protocol as Binary Coded Decimal, BCD) shall be formatted in the SUCI as an UTF-8 string containing all decimal digits of the MSIN; see Annex C for SUCI encoding examples. + +NOTE 3: If the anonymous SUCI contain the realm part, the UDM calculates the corresponding anonymous SUPI. + +#### 6.3.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +#### 6.3.3.2.4 Resource Custom Operations + +##### 6.3.3.2.4.1 Overview + +**Table 6.3.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|--------------------|----------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| generate-auth-data | /generate-auth-data | POST | Select the authentication method and calculate a fresh AV if 5G-AKA or EAP-AKA' is selected or provides corresponding authentication information. | + +##### 6.3.3.2.4.2 Operation: generate-auth-data + +###### 6.3.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (AUSF) to request authentication information data for the SUPI/SUCI from the UDM. If SUCI is provided, the UDM calculates the SUPI from the SUCI (see 3GPP TS 33.501 [6]). The UDM calculates an authentication vector taking into account the information received from the NF service consumer (AUSF) and the current representation of this resource if 5G AKA or EAP-AKA' is selected. For details see 3GPP TS 33.501 [6]. + +###### 6.3.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.3.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.3.3.2.4.2.2-2. + +**Table 6.3.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|---------------------------------------------------------------------| +| AuthenticationInfoRequest | M | 1 | Contains the serving network name and Resynchronization Information | + +**Table 6.3.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthenticationInfoResult | M | 1 | 200 OK | Upon success, a response body containing the selected authentication method and an authentication vector if 5G AKA or EAP-AKA' has been selected shall be returned | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED
- INVALID_HN_PUBLIC_KEY_IDENTIFIER
- INVALID_SCHEME_OUTPUT | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate one of the following application errors:
- UNSUPPORTED_PROTECTION_SCHEME

This response shall not be cached. | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.3.3.3 Resource: AuthEvents (Collection) + +#### 6.3.3.3.1 Description + +This resource represents the collection of UE authentication events. + +##### 6.3.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nudm-ueau/v1/{supi}/auth-events + +This resource shall support the resource URI variables defined in table 6.3.3.3.2-1. + +**Table 6.3.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +#### 6.3.3.3.3 Resource Standard Methods + +##### 6.3.3.3.3.1 POST + +This method shall support the URI query parameters specified in table 6.3.3.3.3.1-1. + +**Table 6.3.3.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.3.3.3.3.1-2 and the response data structures and response codes specified in table 6.3.3.3.3.1-3. + +**Table 6.3.3.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-----------------------------| +| AuthEvent | M | 1 | The UE Authentication Event | + +**Table 6.3.3.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthEvent | O | 0..1 | 201 Created | Upon success, a response body containing a representation of the created Authentication Event may be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.3.3.3.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-ueau/v1/{supi}/auth-events/{authEventId} | + +#### 6.3.3.4 Resource: SecurityInformationForRg + +#### 6.3.3.4.1 Description + +This resource represents the security information of FN-RG, see 3GPP TS 33.501 [6]. + +##### 6.3.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nudm-ueau/v1/{supiOrSuci}/security-information-rg + +This resource shall support the resource URI variables defined in table 6.3.3.4.2-1. + +**Table 6.3.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| supiOrSuci | string | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2), or Subscription Concealed Identifier (see 3GPP TS 23.003 [8]).

Pattern: See pattern of type SupiOrSuci in 3GPP TS 29.571 [7].

(See NOTE 1, NOTE 2). | +| NOTE 1: The format for SUCI, when the corresponding SUPI is NAI-based, contains a realm that may include a "minus" character ("-"), which is also used as field separator. Given that the NAI and its realm shall conform to IETF RFC 7542 [29], the regular expression defined here allows for non-ambiguous matching of the different fields of the SUCI, even when the realm contains the "minus" character. | | | +| NOTE 2: When the SUCI corresponds to a SUPI of type IMSI, and the Null protection scheme is used, the MSIN of the IMSI (which is formatted by the UE and sent over the NAS protocol as Binary Coded Decimal, BCD) shall be formatted in the SUCI as an UTF-8 string containing all decimal digits of the MSIN; see Annex C for SUCI encoding examples. | | | + +#### 6.3.3.4.3 Resource Standard Methods + +##### 6.3.3.4.3.1 GET + +This method shall support the URI query parameters specified in table 6.3.3.4.3.1-1. + +**Table 6.3.3.4.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|------------------------------------------------------| +| authenticated-ind | AuthenticatedInd | M | 1 | Indicates whether authenticated by the W-AGF or not: | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | +| plmn-id | PlmnId | O | 0..1 | PLMN identity of the PLMN serving the UE | + +If "plmn-id" is included, UDM shall return the authentication data of FN-RG in the PLMN identified by "plmn-id". + +If "plmn-id" is not included, UDM shall return the authentication data of FN-RG for HPLMN. + +This method shall support the request data structures specified in table 6.3.3.4.3.1-2 and the response data structures and response codes specified in table 6.3.3.4.3.1-3. + +**Table 6.3.3.4.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.3.3.4.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| RgAuthCtx | M | 1 | 200 OK | Upon success, a response body containing the authentication indication. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED
- INVALID_SCHEME_OUTPUT | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.3.3.5 Resource: HssSecurityInformation (Custom operation) + +#### 6.3.3.5.1 Description + +This resource represents the information that is needed together with the serving network id and requested authentication method to calculate authentication vector(s) for PS/EPS or IMS domain. See 3GPP TS 23.632 [32]. + +##### 6.3.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nudm-ueau/v1/{supi}/hss-security-information/{hssAuthType} + +This resource shall support the resource URI variables defined in table 6.3.3.5.2-1. + +**Table 6.3.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|----------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| supi | Supi | Represents the mobile subscription identity (see 3GPP TS 23.003 [8]).
On this resource, only the IMSI format of SUPI is used. | +| hssAuthType | | Represents the type of AVs requested by the HSS.
It is defined as an enumeration of type "HssAuthTypeInUri". | + +#### 6.3.3.5.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +#### 6.3.3.5.4 Resource Custom Operations + +##### 6.3.3.5.4.1 Overview + +**Table 6.3.3.5.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | CaDescription | +|----------------|----------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| generate-av | /generate-av | POST | Calculate the authentication vector(s) according to the requested information (authentication method, serving network id, resync info) | + +##### 6.3.3.5.4.2 Operation: generate-av + +###### 6.3.3.5.4.2.1 Description + +This custom operation is used by the NF service consumer (HSS) to request calculation of authentication vector(s) for the provided SUPI and the requested authentication method. + +###### 6.3.3.5.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.3.3.5.4.2.2-1 and the response data structure and response codes specified in table 6.3.3.5.4.2.2-2. + +**Table 6.3.3.5.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------| +| HssAuthenticationInfoRequest | M | 1 | Contains the authentication method, number of requested vectors, serving network id and resynchronization information | + +**Table 6.3.3.5.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| HssAuthenticationInfoResult | M | 1 | 200 OK | Upon success, a response body containing authentication vector(s) shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate the following application error:
- UNSUPPORTED_AUTHENTICATION_METHOD

This response shall not be cached. | +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.3.3.6 Resource: Individual AuthEvent + +#### 6.3.3.6.1 Resource Definition + +Resource URI: {apiRoot}/nudm-ueau/v1/{supi}/auth-events/{authEventId} + +This resource shall support the resource URI variables defined in table 6.3.3.6.1-1. + +**Table 6.3.3.6.1-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | +| authEventId | string | Represents the authEvent Id per UE per serving network assigned by the UDM during ResultConfirmation service operation. | + +#### 6.3.3.6.2 Resource Standard Methods + +##### 6.3.3.6.2.1 PUT + +This method shall support the URI query parameters specified in table 6.3.3.6.2.1-1. + +**Table 6.3.3.6.2.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.3.3.6.2.1-2 and the response data structures and response codes specified in table 6.3.3.6.2.1-3. + +**Table 6.3.3.6.2.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-----------------------------| +| AuthEvent | M | 1 | The UE Authentication Event | + +**Table 6.3.3.6.2.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | If the resource corresponding to the authEventId does not exist, a response code of 404 Not Found shall be returned.

The "cause" attribute may be set to:
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.3.3.7 Resource: GbaSecurityInformation (Custom operation) + +##### 6.3.3.7.1 Description + +This resource represents the information that is needed to calculate authentication vector(s) for GBA's BSF. See 3GPP TS 33.220 [61]. + +##### 6.3.3.7.2 Resource Definition + +Resource URI: {apiRoot}/nudm-ueau/v1/{supi}/gba-security-information + +This resource shall support the resource URI variables defined in table 6.3.3.7.2-1. + +**Table 6.3.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-----------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| supi | Supi | Represents the mobile subscription identity (see 3GPP TS 23.003 [8]). | + +#### 6.3.3.7.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +#### 6.3.3.7.4 Resource Custom Operations + +##### 6.3.3.7.4.1 Overview + +**Table 6.3.3.7.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | CaDescription | +|----------------|----------------------|--------------------|----------------------------------------| +| generate-av | /generate-av | POST | Calculate the authentication vector(s) | + +##### 6.3.3.7.4.2 Operation: generate-av + +###### 6.3.3.7.4.2.1 Description + +This custom operation is used by the NF service consumer (GBA's BSF) to request calculation of authentication vector(s) for the provided SUPI. + +###### 6.3.3.7.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.3.3.7.4.2.2-1 and the response data structure and response codes specified in table 6.3.3.7.4.2.2-2. + +**Table 6.3.3.7.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|----------------------------------------------------------------------------------------| +| GbaAuthenticationInfoRequest | M | 1 | It contains the requested authentication type and, optionally, resynchronization info. | + +**Table 6.3.3.7.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| GbaAuthenticationInfoResult | M | 1 | 200 OK | Upon success, a response body containing an authentication vector of the requested type shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate the following application error:
- UNSUPPORTED_AUTHENTICATION_METHOD

This response shall not be cached. | + +NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +#### 6.3.3.8 Resource: ProSeSecurityInformation (Custom operation) + +##### 6.3.3.8.1 Description + +This resource represents the 5G ProSe security information, see 3GPP TS 33.503 [64]. + +##### 6.3.3.8.2 Resource Definition + +Resource URI: {apiRoot}/nudm-ueau/v1/{supiOrSuci}/prose-security-information + +This resource shall support the resource URI variables defined in table 6.3.3.8.2-1. + +**Table 6.3.3.8.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| supiOrSuci | string | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2), or Subscription Concealed Identifier (see 3GPP TS 23.003 [8]).

Pattern: See pattern of type SupiOrSuci in 3GPP TS 29.571 [7]

(See NOTE 1, NOTE 2). | + +NOTE 1: The format for SUCI, when the corresponding SUPI is NAI-based, contains a realm that may include a "minus" character ("-"), which is also used as field separator. Given that the NAI and its realm shall conform to IETF RFC 7542 [29], the regular expression defined here allows for non-ambiguous matching of the different fields of the SUCI, even when the realm contains the "minus" character. + +NOTE 2: When the SUCI corresponds to a SUPI of type IMSI, and the Null protection scheme is used, the MSIN of the IMSI (which is formatted by the UE and sent over the NAS protocol as Binary Coded Decimal, BCD) shall be formatted in the SUCI as an UTF-8 string containing all decimal digits of the MSIN; see Annex C for SUCI encoding examples. + +##### 6.3.3.8.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +#### 6.3.3.8.4 Resource Custom Operations + +##### 6.3.3.8.4.1 Overview + +**Table 6.3.3.8.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|---------------------------------------------| +| generate-av | /generate-av | POST | Generates the 5G ProSe authentication data. | + +##### 6.3.3.8.4.2 Operation: generate-av + +###### 6.3.3.8.4.2.1 Description + +This custom operation is used by the NF service consumer (AUSF) to request ProSe authentication vector(s) for the 5G ProSe Remote UE or for the 5G ProSe End UE from the UDM. If SUCI is provided, the UDM calculates the SUPI from the SUCI (see 3GPP TS 33.501 [6]). The UDM calculates an authentication vector taking into account the information received from the NF service consumer (AUSF) and the current representation of this resource if EAP-AKA' is selected. For details see 3GPP TS 33.501 [6]. + +###### 6.3.3.8.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.3.3.8.4.2.2-1 and the response data structure and response codes specified in table 6.3.3.8.4.2.2-2. + +**Table 6.3.3.8.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|--------------------------------------------------------------------------| +| ProSeAuthenticationInfoRequest | M | 1 | Contains the relay service code and, optionally, resynchronization info. | + +**Table 6.3.3.8.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProSeAuthenticationInfoResult | M | 1 | 200 OK | Upon success, a response body containing authentication vector(s) shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER NOT FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION REJECTED | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate the following application error:
- UNSUPPORTED_AUTHENTICATION_METHOD
This response shall not be cached. | +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +### 6.3.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nudm\_UEAuthentication Service. + +### 6.3.5 Notifications + +#### 6.3.5.1 General + +This clause will specify the use of notifications and corresponding protocol details if required for the specific service. When notifications are supported by the API, it will include a reference to the general description of notifications support over the 5G SBIs specified in 3GPP TS 29.500 [4] / 3GPP TS 29.501 [5]. + +**Table 6.3.5.1-1: Notifications overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|-------------------------------|------------------------------|---------------------------------|---------------------------------| +| Data Restoration Notification | {dataRestorationCallbackUri} | POST | | + +#### 6.3.5.2 Data Restoration Notification + +The POST method shall be used to inform the NF Service Consumer about a potential data-loss event occurred at the UDR, and the callback URI may be provided during the confirmation of a successful authentication event, or dynamically discovered by UDM by querying NRF for a default notification URI. + +Resource URI: {dataRestorationCallbackUri} + +Support of URI query parameters is specified in table 6.3.5.2-1. + +**Table 6.3.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.3.5.2-2 and of response data structures and response codes is specified in table 6.3.5.2-3. + +**Table 6.3.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------| +| DataRestorationNotification | M | 1 | Contains identifiers representing those UEs potentially affected by a data-loss event at the UDR. | + +**Table 6.3.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.3.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.3.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.3.6 Data Model + +### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.1-1 specifies the data types defined for the Nudm\_UEAU service API. + +**Table 6.3.6.1-1: Nudm\_UEAU specific Data Types** + +| Data type | Clause defined | Description | +|--------------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------------| +| AuthenticationInfoRequest | 6.3.6.2.2 | Contains Serving Network Name and Resynchronization Information | +| AuthenticationInfoResult | 6.3.6.2.3 | Contains an Authentication Vector (AV) | +| AvEapAkaPrime | 6.3.6.2.4 | Contains RAND, XRES, AUTN, CK', and IK' | +| Av5GHeAka | 6.3.6.2.5 | Contains RAND, XRES*, AUTN, KAUSF | +| ResynchronizationInfo | 6.3.6.2.6 | Contains RAND and AUTS | +| AuthEvent | 6.3.6.2.7 | Authentication Event | +| AuthenticationVector | 6.3.6.2.8 | | +| RgAuthCtx | 6.3.6.2.9 | Contains the UE id (i.e. SUPI) and the authentication indication. | +| HssAuthenticationInfoRequest | 6.3.6.2.10 | Contains authentication method, serving network id, number of requested vectors and resynchronization information | +| HssAuthenticationInfoResult | 6.3.6.2.11 | Contains the authentication vectors for EPS/IMS domain | +| HssAuthenticationVectors | 6.3.6.2.12 | | +| AvEpsAka | 6.3.6.2.13 | Contains RAND, XRES, AUTN, KASME | +| AvImseAka | 6.3.6.2.14 | Contains RAND, XRES, AUTN, CK, and IK | +| GbaAuthenticationInfoRequest | 6.3.6.2.15 | Contains authentication method and resynchronization information | +| GbaAuthenticationInfoResult | 6.3.6.2.16 | Contains the authentication vectors for GBA's BSF domain | +| ProSeAuthenticationInfoRequest | 6.3.6.2.17 | Contains RSC and resynchronization information | +| ProSeAuthenticationInfoResult | 6.3.6.2.18 | Contains the authentication vectors for ProSe | +| ProSeAuthenticationVectors | 6.3.6.2.19 | Contains the authentication vectors for ProSe | +| Autn | 6.3.6.3.2 | | +| Auts | 6.3.6.3.2 | | +| CkPrime | 6.3.6.3.2 | | +| IkPrime | 6.3.6.3.2 | | +| Kausf | 6.3.6.3.2 | | +| Rand | 6.3.6.3.2 | | +| ServingNetworkName | 6.3.6.3.2 | | +| Success | 6.3.6.3.2 | | +| Xres | 6.3.6.3.2 | | +| XresStar | 6.3.6.3.2 | | +| AuthenticatedInd | 6.3.6.3.2 | | +| ConfidentialityKey | 6.3.6.3.2 | | +| IntegrityKey | 6.3.6.3.2 | | +| Kasme | 6.3.6.3.2 | | +| NumOfRequestedVectors | 6.3.6.3.2 | | +| Autn | 6.3.6.3.2 | | +| AuthType | 6.3.6.3.3 | | +| AvType | 6.3.6.3.4 | | +| HssAuthType | 6.3.6.3.5 | | +| HssAvType | 6.3.6.3.6 | | +| HssAuthTypeInUri | 6.3.6.3.7 | | +| AccessNetworkId | 6.3.6.3.8 | | +| GbaAuthType | 6.3.6.3.10 | | + +Table 6.3.6.1-2 specifies data types re-used by the Nudm\_UEAU service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudm\_UEAU service API. + +**Table 6.3.6.1-2: Nudm\_UEAU re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------------|---------------------|------------------------------------------------------------------------------------------------------| +| ProblemDetails | 3GPP TS 29.571 [7] | Common data type used in response bodies | +| NfInstanceId | 3GPP TS 29.571 [7] | Network Function Instance Identifier | +| NfSetId | 3GPP TS 29.571 [7] | Network Function Set Identifier | +| DateTime | 3GPP TS 29.571 [7] | | +| SupportedFeatures | 3GPP TS 29.571 [7] | see 3GPP TS 29.500 [4] clause 6.6 | +| Supi | 3GPP TS 29.571 [7] | | +| CagId | 3GPP TS 29.571 [7] | | +| ServerAddressingInfo | 3GPP TS 29.571 [7] | Server address info, which in this specification contains information of a Provisioning Server (PVS) | +| 3GAkaAv | 3GPP TS 29.562 [65] | See clause 6.3.6.2.5 of 3GPP TS 29.562 | +| ResynchronizationInfo | 3GPP TS 29.562 [65] | See clause 6.3.6.2.4 of 3GPP TS 29.562 | +| RelayServiceCode | 3GPP TS 29.571 [7] | | +| DataRestorationNotification | 6.2.6.2.25 | Contains identities representing those UEs potentially affected by a data-loss event at the UDR | + +#### 6.3.6.2 Structured data types + +#### 6.3.6.2.1 Introduction + +This clause defines the structures to be used in POST request / response bodies. + +#### 6.3.6.2.2 Type: AuthenticationInfoRequest + +**Table 6.3.6.2.2-1: Definition of type AuthenticationInfoRequest** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servingNetworkName | ServingNetworkName | M | 1 | See 3GPP TS 33.501 [6] clause 6.1.1.4 | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | Contains RAND and AUTS; see 3GPP TS 33.501 [6] clause 6.1.3.3.2 | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.3.8 | +| ausfInstanceId | NfInstanceId | M | 1 | NF Instance Id of the AUSF | +| cellCagInfo | array(CagId) | O | 1..N | CAG List of the CAG cell.
If the cellCagInfo is absent, the UDM shall not assume the UE is accessing from the PLMN. | +| n5gcInd | boolean | O | 0..1 | N5GC device Indicator indicates whether the user uses a N5GC device:
See 3GPP TS 33.501 [6]
true: N5GC device
false (default): used device is 5G capable
See NOTE | +| nswoInd | boolean | O | 0..1 | NSWO Indicator (see 3GPP TS 33.501 [6])
When present, this IE shall be set as follows:
- true: Non-Seamless WLAN Offload is applied;
- false (default): Non-Seamless WLAN Offload is not applied. | +| disasterRoamingInd | boolean | O | 0..1 | Disaster Roaming Indicator (see 3GPP TS 23.502 [3]).
When present, this IE shall be set as follows:
- true: Disaster Roaming service is applied;
- false (default): Disaster Roaming service is not applied. | +| aun3Ind | boolean | O | 0..1 | AUN3 Indicator (see 3GPP TS 33.501 [8])
When present, this IE shall be set as follows:
- true: authentication is for an AUN3 device behind RG;
- false (default): authentication is not for an AUN3 device behind RG. | +| NOTE: The attribute n5gcInd is used for EAP-TLS, which is described in the informative annex O of 3GPP TS 33.501 [6] and is not mandatory to support. | | | | | + +#### 6.3.6.2.3 + +##### Type: AuthenticationInfoResult + +**Table 6.3.6.2.3-1: Definition of type AuthenticationInfoResult** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| authType | AuthType | M | 1 | Indicates the authentication method | +| authenticationVector | AuthenticationVector | C | 0..1 | contains an authentication vector if 5G AKA or EAP-AKA's is selected | +| supi | Supi | C | 0..1 | SUPI shall be present if the request contained the SUCI within the request URI
SUPI or anonymous SUPI shall be present if the request contained the anonymous SUCI within the request URI | +| akmaInd | boolean | C | 0..1 | When present, this IE shall be set as follows:
  • - true: AKMA keys need to be generated for the UE;
  • - false (default): AKMA keys are not needed.
| +| authAaa | boolean | C | 0..1 | When present, this IE shall be set as follows:
  • - true: Primary authentication with AAA Server that acts as the EAP server is required, i.e. the AUSF is required to act as EAP proxy towards the AAA Server, or if the UDM receives an anonymous SUCI, the AUSF is indicated to run primary authentication with an external Credentials holder;
  • - false (default): Primary authentication with AAA Server that acts as the EAP server is not required, i.e. the AUSF is required to act as EAP server according to the EAP method defined in authType attribute. See clause 6.3.6.3.3.
| +| routingId | string | C | 0..1 | This IE shall be present if the akmaInd is set to "true".
When present, this IE shall include the Routing Indicator contained in the SUCI (see 3GPP TS 23.003 [8], clause 2.2B). | +| pvsInfo | array(ServerAddressingInfo) | C | 1..N | When present, this IE shall contain the remote Provisioning Server(s) information (PVS FQDN(s) and/or IP address(es)). This is used for the case of SNPN onboarding with DCS hosting AUSF and UDM. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.3.8 | +| mskInd | boolean | O | 0..1 | When present, this IE shall be set as follows:
  • - true: AUN3 device does not support the 5G key hierarchy.
  • - false (default) or absent: AUN3 device support the 5G key hierarchy;
| + +#### 6.3.6.2.4 Type: AvEapAkaPrime + +**Table 6.3.6.2.4-1: Definition of type AvEapAkaPrime** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------| +| avType | AvType | M | 1 | Type of authentication vector | +| rand | Rand | M | 1 | | +| xres | Xres | M | 1 | | +| autn | Autn | M | 1 | | +| ckPrime | CkPrime | M | 1 | | +| ikPrime | IkPrime | M | 1 | | + +#### 6.3.6.2.5 Type: Av5GHeAka + +**Table 6.3.6.2.5-1: Definition of type Av5GHeAka** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------| +| avType | AvType | M | 1 | Type of authentication vector | +| rand | Rand | M | 1 | | +| xresStar | XresStar | M | 1 | | +| autn | Autn | M | 1 | | +| kausf | Kausf | M | 1 | | + +##### 6.3.6.2.6 Type: ResynchronizationInfo + +**Table 6.3.6.2.6-1: Definition of type ResynchronizationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| rand | Rand | M | 1 | | +| auts | Auts | M | 1 | | + +#### 6.3.6.2.7 Type: AuthEvent + +Table 6.3.6.2.7-1: Definition of type AuthEvent + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nfInstanceId | NfInstanceId | M | 1 | Identifier of the NF instance where the authentication occurred (e.g. AUSF) | +| success | Success | M | 1 | true indicates success; false indicates no success. Set to false in case of authentication result removal. | +| timeStamp | DateTime | M | 1 | time stamp of the authentication | +| authType | AuthType | M | 1 | string
Authentication Type | +| servingNetworkName | ServingNetworkName | M | 1 | See 3GPP TS 33.501 [6] clause 6.1.1.4 | +| authRemovalInd | boolean | O | 0..1 | When present, it shall indicate the authentication result in the UDM shall be removed.
This IE shall be set as follows:
- true: authentication result in the UDM shall be removed;
- false (default): authentication result in the UDM shall not be removed. | +| nfSetId | NfSetId | O | 0..1 | If present, it indicates the NF Set ID where the authentication occurred (e.g. AUSF Set) | +| resetIds | array(string) | O | 1..N | May be present in Authentication Confirmation response messages.
The AUSF may decide to re-confirm the authentication at the UDM when receiving a data restoration notification containing a matching resetId. | +| dataRestorationCallbackUri | Uri | O | 0..1 | If present, it contains the URI where notifications about UDR-initiated data restoration shall be sent by UDM. | +| udrRestartInd | boolean | O | 0..1 | May be present in request messages from the AUSF to the UDM.
If present:
- true: indicates that the registration message sent by the AUSF is due to a re-synchronization event, motivated by a previous reception at the AUSF of a Data Restoration Notification from the UDM
- false (or absent): indicates that this is a normal request message (i.e., not motivated by a data restoration notification event) | + +#### 6.3.6.2.8 Type: AuthenticationVector + +Table 6.3.6.2.8-1: Definition of type AuthenticationVector as a list of alternatives + +| Data type | Cardinality | Description | +|---------------|-------------|-------------| +| AvEapAkaPrime | 1 | | +| Av5GHeAka | 1 | | + +#### 6.3.6.2.9 Type: RgAuthCtx + +Table 6.3.6.2.9-1: Definition of type RgAuthCtx + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------| +| authInd | boolean | M | 1 | This IE shall be set as follows:
- true: authentication is not required;
- false (default): authentication is required. | +| supi | Supi | C | 0..1 | SUPI shall be present if the request contained the SUCI within the request URI | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.3.8 | + +##### 6.3.6.2.10 Type: HssAuthenticationInfoRequest + +Table 6.3.6.2.10-1: Definition of type HssAuthenticationInfoRequest + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------| +| hssAuthType | HssAuthType | M | 1 | Indicates the authentication method. | +| numOfRequestedVectors | NumOfRequestedVectors | M | 1 | Maximum 5 vectors are allowed per service request. | +| requestingNodeType | NodeType | C | 0..1 | Indicates the requesting node type. Should be included when known by the HSS. | +| servingNetworkId | PlmnId | C | 0..1 | Shall be present if the authentication method is EPS AKA. | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | Contains RAND and AUTS. | +| anId | AccessNetworkId | O | 0..1 | Contains the Access Network ID used in the derivation of authentication vectors in EAP-AKA'. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.3.8 | +| NOTE: For GBA authentication type, the number of requested vectors shall be set to 1; for other authentication types, the number of generated vectors by UDM, may be less than the number of requested vectors. | | | | | + +#### 6.3.6.2.11 Type: HssAuthenticationInfoResult + +Table 6.3.6.2.11-1: Definition of type HssAuthenticationInfoResult + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|--------------------------|---|-------------|------------------| +| hssAuthenticationVectors | HssAuthenticationVectors | M | 1 | | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.3.8 | + +#### 6.3.6.2.12 Type: HssAuthenticationVectors + +Table 6.3.6.2.12-1: Definition of type HssAuthenticationVectors as a list of alternatives + +| Data type | Cardinality | Description | +|-----------------------|-------------|-------------------------------------------| +| array(AvEpsAka) | 1..5 | | +| array(AvImSgbaEapAka) | 1..5 | This data type is also used for UMTS AKA. | +| array(AvEapAkaPrime) | 1..5 | | + +6.3.6.2.13 Type: AvEpsAka + +**Table 6.3.6.2.13-1: Definition of type AvEpsAka** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| avType | HssAvType | M | 1 | | +| rand | Rand | M | 1 | | +| xres | Xres | M | 1 | | +| autn | Autn | M | 1 | | +| kasme | Kasme | M | 1 | | + +6.3.6.2.14 Type: AvlmsGbaEapAka + +**Table 6.3.6.2.14-1: Definition of type AvlmsGbaEapAka** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------|---|-------------|-------------| +| avType | HssAvType | M | 1 | | +| rand | Rand | M | 1 | | +| xres | Xres | M | 1 | | +| autn | Autn | M | 1 | | +| ck | ConfidentialityKey | M | 1 | | +| ik | IntegrityKey | M | 1 | | + +6.3.6.2.15 Type: GbaAuthenticationInfoRequest + +**Table 6.3.6.2.15-1: Definition of type GbaAuthenticationInfoRequest** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------|---|-------------|--------------------------------------| +| authType | GbaAuthType | M | 1 | Indicates the authentication method. | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | Contains RAND and AUTS. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.3.8 | + +6.3.6.2.16 Type: GbaAuthenticationInfoResult + +**Table 6.3.6.2.16-1: Definition of type GbaAuthenticationInfoResult** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-----------------------------------------------------------------------------| +| 3gAkaAv | 3GAkaAv | O | 0..1 | Contains an AV when the requested authentication type is "DIGEST_AKAV1_MD5" | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.3.8 | + +6.3.6.2.17 Type: ProSeAuthenticationInfoRequest + +**Table 6.3.6.2.17-1: Definition of type ProSeAuthenticationInfoRequest** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------|---|-------------|-------------------------------------------------------------------| +| servingNetworkName | ServingNetworkName | M | 1 | See 3GPP TS 33.501 [6] clause 6.1.1.4 | +| relayServiceCode | RelayServiceCode | M | 1 | Indicates Relay Service Code. See 3GPP TS 29.571 [7] clause 5.4.2 | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | Contains RAND and AUTS. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.3.8 | + +#### 6.3.6.2.18 Type: ProSeAuthenticationInfoResult + +**Table 6.3.6.2.18-1: Definition of type ProSeAuthenticationInfoResult** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------|----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| authType | AuthType | M | 1 | Indicates the authentication method. | +| proseAuthenticationVectors | ProSeAuthenticationVectors | O | 0..1 | This IE shall be present if the AUSF of the 5G ProSe Remote UE or the 5G ProSe End UE retrieves the Authentication Vectors from the UDM. When present, this IE shall contain Authentication Vector for Prose.
See 3GPP TS 33.503 [64] clause 7.4.2.1 | +| supi | Supi | C | 0..1 | SUPI shall be present if the request contained the SUCI within the request URI | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.3.8 | + +##### 6.3.6.2.19 Type: ProSeAuthenticationVectors + +**Table 6.3.6.2.19-1: Definition of type ProSeAuthenticationVectors as a list of alternatives** + +| Data type | Cardinality | Description | +|----------------------------------------------------------------------------------------------------------------------------|-------------|-------------| +| array(AvEapAkaPrime) | 1..5 | NOTE | +| NOTE: Although a cardinality of 1..5 is specified, the UDM should send exactly one Authentication Vector within the array. | | | + +#### 6.3.6.3 Simple data types and enumerations + +#### 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +**Table 6.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Authn | string | pattern: "[A-Fa-f0-9]{32}\$" | +| Auts | string | pattern: "[A-Fa-f0-9]{28}\$" | +| CkPrime | string | pattern: "[A-Fa-f0-9]{32}\$" | +| IkPrime | string | pattern: "[A-Fa-f0-9]{32}\$" | +| Kausf | string | pattern: "[A-Fa-f0-9]{64}\$" | +| Rand | string | pattern: "[A-Fa-f0-9]{32}\$" | +| ServingNetworkName | string | See 3GPP TS 33.501 [6] clause 6.1.1.4
pattern: "(5G:mnc[0-9]{3}[.]mcc[0-9]{3}[.]3gppnetwork[.]org(:[A-F0-9]{11})? 5G:NSWO\$)" | +| Success | boolean | true indicates success, false indicates no success | +| Xres | string | pattern: "[A-Fa-f0-9]{8,32}\$" | +| XresStar | string | pattern: "[A-Fa-f0-9]{32}\$" | +| AuthenticatedInd | boolean | Indicates whether authenticated by the W-AGF or not:
- true: authenticated by the W-AGF;
- false: unauthenticated by the W-AGF. | +| ConfidentialityKey | string | pattern: "[A-Fa-f0-9]{32}\$" | +| IntegrityKey | string | pattern: "[A-Fa-f0-9]{32}\$" | +| Kasme | string | pattern: "[A-Fa-f0-9]{64}\$" | +| NumOfRequestedVectors | integer | minimum: 1
maximum: 5 | + +##### 6.3.6.3.3 Enumeration: AuthType + +Table 6.3.6.3.3-1: Enumeration AuthType + +| Enumeration value | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| "EAP_AKA_PRIME" | EAP-AKA' | +| "5G_AKA" | 5G AKA | +| "EAP_TLS" | EAP-TLS. See NOTE 1 | +| "NONE" | No specific EAP method type is signalled. See NOTE 2 | +| "EAP_TTLS" | EAP-TTLS. See NOTE 3. | +| NOTE 1: EAP-TLS is described in the Informative Annex B and Annex O of 3GPP TS 33.501 [6] and is not mandatory to support. | | +| NOTE 2: NONE indicates that EAP method type is not signalled, because of the following scenario.
Primary authentication with AAA Server that acts as the EAP server is required for the UEs that use credentials from an AAA Server in a Credentials Holder, as described in clause 5.30.2.9.2 of 3GPP TS 23.501 [2]. This value is necessary when authAaa attribute is included in the AuthenticationInfoResult type and because authType is a mandatory attribute. | | +| NOTE 3: EAP-TTLS is described in the Informative Annex U of 3GPP TS 33.501 [6] and is optional to support. | | + +##### 6.3.6.3.4 Enumeration: AvType + +Table 6.3.6.3.4-1: Enumeration AvType + +| Enumeration value | Description | +|-------------------|-------------| +| "5G HE_AKA" | | +| "EAP_AKA_PRIME" | | + +##### 6.3.6.3.5 Enumeration: HssAuthType + +Table 6.3.6.3.5-1: Enumeration HssAuthType + +| Enumeration value | Description | +|-------------------|-------------| +| "EPS_AKA" | | +| "EAP_AKA" | | +| "EAP_AKA_PRIME" | EAP-AKA' | +| "IMS_AKA" | | +| "GBA_AKA" | | +| "UMTS_AKA" | | + +##### 6.3.6.3.6 Enumeration: HssAvType + +Table 6.3.6.3.6-1: Enumeration HssAvType + +| Enumeration value | Description | +|-------------------|-------------| +| "EPS_AKA" | | +| "EAP_AKA" | | +| "IMS_AKA" | | +| "GBA_AKA" | | +| "UMTS_AKA" | | + +##### 6.3.6.3.7 Enumeration: HssAuthTypeInUri + +**Table 6.3.6.3.7-1: Enumeration HssAuthTypeInUri** + +| Enumeration value | Description | +|-------------------|--------------------------------| +| "eps-aka" | EPS-AKA authentication method | +| "eap-aka" | EAP-AKA authentication method | +| "eap-aka-prime" | EAP-AKA' authentication method | +| "ims-aka" | IMS-AKA authentication method | +| "gba-aka" | GBA-AKA authentication method | + +NOTE: This enumeration is used as a variable part of resource URIs, and therefore it follows the naming convention used in URIs (lower case with hyphens); see 3GPP TS 29.501 [5], clause 5.1. + +##### 6.3.6.3.8 Enumeration: AccessNetworkId + +This data type contains the values for the Access Network Identities defined by 3GPP in the context of non-3GPP access to EPC, used in the generation of EAP-AKA' authentication vectors. The possible values are originally defined in 3GPP TS 24.302 [49]. + +**Table 6.3.6.3.8-1: Enumeration AccessNetworkId** + +| Enumeration value | Description | +|-------------------|------------------------------| +| "HRPD" | Access Network: HRPD | +| "WiMAX" | Access Network: WiMAX | +| "WLAN" | Access Network: Wireless LAN | +| "ETHERNET" | Access Network: Ethernet | + +##### 6.3.6.3.9 Enumeration: NodeType + +**Table 6.3.6.3.9-1: Enumeration NodeType** + +| Enumeration value | Description | +|-------------------|------------------------------------------| +| "AUSF" | This value is not applicable to the HSS. | +| "VLR" | | +| "SGSN" | | +| "S_CSCF" | | +| "BSF" | | +| "GAN AAA SERVER" | | +| "WLAN AAA SERVER" | | +| "MME" | | + +##### 6.3.6.3.10 Enumeration: GbaAuthType + +**Table 6.3.6.3.10-1: Enumeration GbaAuthType** + +| Enumeration value | Description | +|--------------------|-------------------------------| +| "DIGEST_AKAV1_MD5" | IMS-AKA authentication scheme | + +### 6.3.7 Error Handling + +#### 6.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.3.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.3.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_UEAuthentication service. The following application errors listed in Table 6.3.7.3-1 are specific for the Nudm\_UEAuthentication service. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------------|---------------------|--------------------------------------------------------------------------------------------------| +| AUTHENTICATION_REJECTED | 403 Forbidden | The user is cannot be authenticated with this authentication method e.g. only SIM data available | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| UNSUPPORTED_PROTECTION_SCHEME | 501 Not implemented | The received protection scheme is not supported by HPLMN | +| UNSUPPORTED_AUTHENTICATION_METHOD | 501 Not implemented | The requested authentication method is not supported | +| INVALID_HN_PUBLIC_KEY_IDENTIFIER | 403 Forbidden | Invalid HN public key identifier received | +| INVALID_SCHEME_OUTPUT | 403 Forbidden | SUCI cannot be decrypted with received data | +| DATA_NOT_FOUND | 404 Not Found | Resource corresponding to the authEventId does not exist | + +### 6.3.8 Feature Negotiation + +The optional features in table 6.3.8-1 are defined for the Nudm\_UEAU API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.3.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.3.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nudm\_UEAU API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nudm\_UEAU API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudm\_UEAU service. + +The Nudm\_UEAU API defines the following scopes for OAuth2 authorization: + +**Table 6.3.9-1: Oauth2 scopes defined in Nudm\_UEAU API** + +| Scope | Description | +|------------------------------------------------------------|---------------------------------------------------------------------------------------------------| +| "nudm-ueau" | Access to the Nudm_UEAU API | +| "nudm-ueau:security-information:generate-auth-data:invoke" | Access to invoke the "generate-auth-data" custom operation on the "security-information" resource | +| "nudm-ueau:security-information-rg:read" | Access to read the "security-information-rg" resource | +| "nudm-ueau:auth-events:create" | Access to create a new child resource on the "auth-events" collection resource | +| "nudm-ueau:auth-event-id:modify" | Access to modify (delete) an "auth-event-id" individual resource | +| "nudm-ueau:hss-security-information:generate-av:invoke" | Access to invoke the "generate-av" custom operation on the "hss-security-information" resource | +| "nudm-ueau:gba-security-information:generate-av:invoke" | Access to invoke the "generate-av" custom operation on the "gba-security-information" resource | + +### 6.3.10 HTTP redirection + +An HTTP request may be redirected to a different UDM service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UDM producer instance will return the NF Instance ID of the new UDM producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UDM redirects a service request to a different UDM using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UDM towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.4 Nudm\_EventExposure Service API + +### 6.4.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}// + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot}/// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nudm-ee". +- The shall be "v1". +- The shall be set as described in clause 6.4.3. + +### 6.4.2 Usage of HTTP + +#### 6.4.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [13], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nudm\_EE service shall comply with the OpenAPI [14] specification contained in Annex A5. + +#### 6.4.2.2 HTTP standard headers + +##### 6.4.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.4.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 9457 [16]) signalled by the content type "application/problem+json" + +JSON Patch (IETF RFC 6902 [41]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". + +#### 6.4.2.3 HTTP custom headers + +##### 6.4.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.4.3 Resources + +#### 6.4.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.4.3.1-1 depicts the resource URIs structure for the Nudm\_EE API. + +![Diagram showing the hierarchical structure of Resource URIs for the Nudm_EE API. The root URI is //{apiRoot}/nudm-ee/v1. It branches to //{ueIdentity}, which then branches to /ee-subscriptions, which finally branches to //{subscriptionId}.](0a83cda688278bb05ef5134e66bdaf6e_img.jpg) + +``` +graph TD; Root["//{apiRoot}/nudm-ee/v1"] --- UEIdentity["//{ueIdentity}"]; UEIdentity --- EESubscriptions["/ee-subscriptions"]; EESubscriptions --- SubscriptionId["//{subscriptionId}"]; +``` + +Diagram showing the hierarchical structure of Resource URIs for the Nudm\_EE API. The root URI is //{apiRoot}/nudm-ee/v1. It branches to //{ueIdentity}, which then branches to /ee-subscriptions, which finally branches to //{subscriptionId}. + +**Figure 6.4.3.1-1: Resource URI structure of the Nudm\_EE API** + +Table 6.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.4.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|------------------------------------|-------------------------------------------------|---------------------------------|--------------------------------------------------------------------------| +| EeSubscriptions (Collection) | /{ueIdentity}/ee-subscriptions | POST | Create a subscription | +| Individual subscription (Document) | /{ueIdentity}/ee-subscriptions/{subscriptionId} | PATCH | Update the subscription identified by {subscriptionId} | +| | | DELETE | Delete the subscription identified by {subscriptionId}, i.e. unsubscribe | + +#### 6.4.3.2 Resource: EeSubscriptions (Collection) + +##### 6.4.3.2.1 Description + +This resource is used to represent subscriptions to notifications. + +##### 6.4.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nudm-ee/v1/{ueIdentity}/ee-subscriptions + +This resource shall support the resource URI variables defined in table 6.4.3.2.2-1. + +**Table 6.4.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.4.1 | +| ueIdentity | string | Represents a single UE or a group of UEs or any UE.
  • - If representing a single UE, this parameter shall contain the Generic Public Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.8)
    pattern: "(msisdn-[0-9]{5,15} extid-[^@]+@[^\@]+\+ \+)"
  • - If representing a group of UEs, this parameter shall contain the External GroupId.
    pattern: "^[^\@]+\+@[^\@]+\+@"
  • - If representing any UE, this parameter shall contain "anyUE".
    pattern: "^[^\@]+\+@"
| + +#### 6.4.3.2.3 Resource Standard Methods + +##### 6.4.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.4.3.2.3.1-1. + +**Table 6.4.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.4.3.2.3.1-2 and the response data structures and response codes specified in table 6.4.3.2.3.1-3. + +**Table 6.4.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|----------------------------------------| +| EeSubscription | M | 1 | The subscription that is to be created | + +**Table 6.4.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedEeSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. When stateless UDM is deployed, the stateless UDM may use an FQDN identifying the UDM group to which the UDM belongs as the host part of the resource URI. | +| EeSubscriptionError | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- MONITORING_NOT_ALLOWED
- AF_NOT_ALLOWED
- MTC_PROVIDER_NOT_ALLOWED
- MUTING_EXC_INSTR_NOT_ACCEPTED | +| EeSubscriptionError | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| EeSubscriptionError | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate one of the following application errors:
- UNSUPPORTED_MONITORING_EVENT_TYPE
- UNSUPPORTED_MONITORING_REPORT_OPTIONS

This response shall not be cached. | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +NOTE: In the scenario of stateless UDM deployment, it is assumed that stateless UDMs are organized into several UDM groups, and for each UDM group an FQDN can be allocated. + +**Table 6.4.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nudm-ee//{ueIdentity}/ee-subscriptions/{subscriptionId} | + +#### 6.4.3.3 Resource: Individual subscription (Document) + +#### 6.4.3.3.1 Resource Definition + +Resource URI: {apiRoot}/nudm-ee/v1/{ueIdentity}/ee-subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.4.3.3.1-1. + +**Table 6.4.3.3.1-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueIdentity | string | Represents a single UE or a group of UEs or any UE.
  • - If representing a single UE, this parameter shall contain the Generic Public Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.8)
    pattern: "^(msisdn-[0-9]{5,15} extid-[^@]+@[^\@]+\.[\+])\$"
  • - If representing a group of UEs, this parameter shall contain the External GroupId.
    pattern: "^(extgroupid-[^@]+\@[^\@]+\.[\+])\$"
  • - If representing any UE, this parameter shall contain "anyUE".
    pattern: "^(anyUE)\$"
| +| subscriptionId | string | The subscriptionId identifies an individual subscription to notifications. | + +##### 6.4.3.3.2 Resource Standard Methods + +##### 6.4.3.3.2.1 DELETE + +This method shall support the URI query parameters specified in table 6.4.3.3.2.1-1. + +**Table 6.4.3.3.1.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.4.3.3.2.1-2 and the response data structures and response codes specified in table 6.4.3.3.2.1-3. + +**Table 6.4.3.3.2.1-2: Data structures supported by the Delete Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.4.3.3.2.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +##### 6.4.3.3.2.2 PATCH + +This method shall support the URI query parameters specified in table 6.4.3.3.2.2-1. + +**Table 6.4.3.3.2.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.4.3.3.2.2-2 and the response data structures and response codes specified in table 6.4.3.3.2.2-3. + +**Table 6.4.3.3.2.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the Event Subscription | + +**Table 6.4.3.3.2.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1.
- MUTING_EXC_INSTR_NOT_ACCEPTED | + +NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with PatchResult. + +### 6.4.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nudm\_EventExposure Service. + +### 6.4.5 Notifications + +#### 6.4.5.1 General + +This clause will specify the use of notifications and corresponding protocol details if required for the specific service. When notifications are supported by the API, it will include a reference to the general description of notifications support over the 5G SBIs specified in TS 29.500 / TS 29.501. + +**Table 6.4.5.1-1: Notifications overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|------------------------------------|------------------------------|---------------------------------|---------------------------------| +| Event Occurrence Notification | {callbackReference} | POST | | +| Monitoring Revocation Notification | {secondCallbackRef} | POST | | +| Data Restoration Notification | {dataRestorationCallbackUri} | POST | | + +### 6.4.5.2 Event Occurrence Notification + +The POST method shall be used for Event Occurrence Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 6.4.5.2-1. + +**Table 6.4.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.4.5.2-2 and of response data structures and response codes is specified in table 6.4.5.2-3. + +**Table 6.4.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|---------------------------------------------------------------------------------------------| +| array(MonitoringReport) | M | 1..N | A list of MonitoringReports each of which contains information regarding the occurred event | + +**Table 6.4.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.4.5.3 Monitoring Revocation Notification + +The POST method shall be used for Monitoring Revocation Notification and the URI shall be as provided during the subscription procedure. + +Resource URI: {secondCallbackRef} + +Support of URI query parameters is specified in table 6.4.5.3-1. + +**Table 6.4.5.3-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.4.5.3-2 and of response data structures and response codes is specified in table 6.4.5.3-3. + +**Table 6.4.5.3-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|----------------------------------------------| +| EeMonitoringRevoked | M | 0..1 | The monitoring events that is to be revoked. | + +**Table 6.4.5.3-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT NOT FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.4.5.4 Data Restoration Notification + +The POST method shall be used to inform the NF Service Consumer about a potential data-loss event occurred at the UDR, and the callback URI may be provided during the subscription procedure, or dynamically discovered by UDM by querying NRF for a default notification URI. + +Resource URI: {dataRestorationCallbackUri} + +Support of URI query parameters is specified in table 6.4.5.4-1. + +**Table 6.4.5.4-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.4.5.4-2 and of response data structures and response codes is specified in table 6.4.5.4-3. + +**Table 6.4.5.4-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------| +| DataRestorationNotification | M | 1 | Contains identifiers representing those UEs potentially affected by a data-loss event at the UDR. | + +**Table 6.4.5.4-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +**Table 6.4.5.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.4.5.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer to which the request is redirected. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.4.6 Data Model + +### 6.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.6.1-1 specifies the data types defined for the Nudm\_EE service API. + +**Table 6.4.6.1-1: Nudm\_EE specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------------|-----------------------|----------------------------------------------------------------------------| +| EeSubscription | 6.4.6.2.2 | A subscription to Notifications | +| MonitoringConfiguration | 6.4.6.2.3 | Monitoring Configuration | +| MonitoringReport | 6.4.6.2.4 | Monitoring Report | +| Report | 6.4.6.2.5 | Event report | +| ReportingOptions | 6.4.6.2.6 | Report options | +| ChangeOfSupiPeiAssociationReport | 6.4.6.2.7 | Report for change of SUPI/PEI association | +| RoamingStatusReport | 6.4.6.2.8 | Report for roaming status retrieval | +| CreatedEeSubscription | 6.4.6.2.9 | Created subscription for event exposure | +| LocationReportingConfiguration | 6.4.6.2.10 | Configuration for location reporting | +| CnTypeChangeReport | 6.4.6.2.11 | Report for CN type change | +| ReachabilityForSmsReport | 6.4.6.2.12 | Report for reachability status for SMS | +| DatalinkReportingConfiguration | 6.4.6.2.13 | Reporting configuration for events related to data link | +| CmlInfoReport | 6.4.6.2.14 | Reporting UE's Connection Management State information per access type | +| LossConnectivityCfg | 6.4.6.2.15 | Configuration for loss of connectivity event | +| PduSessionStatusCfg | 6.4.6.2.16 | Reporting configuration for events related to PDU session Status | +| LossConnectivityReport | 6.4.6.2.17 | Report of "LOSS_OF_CONNECTIVITY" event | +| LocationReport | 6.4.6.2.18 | Report of "LOCATION_REPORTING" event | +| PdnConnectivityStatReport | 6.4.6.2.19 | Report of "PDN_CONNECTIVITY_STATUS" event | +| ReachabilityReport | 6.4.6.2.20 | Reachability report | +| ReachabilityForDataConfiguration | 6.4.6.2.21 | Reachability for Data Configuration | +| EeMonitoringRevoked | 6.4.6.2.22 | Revoked monitoring events information | +| MonitoringEvent | 6.4.6.2.23 | Monitoring Event | +| FailedMonitoringConfiguration | 6.4.6.2.24 | Failed Monitoring Configuration in the EE subscription | +| MonitoringSuspension | 6.4.6.2.25 | Monitoring Suspension | +| GroupMembListChanges | 6.4.6.2.26 | Represents information on the change(s) to a group's members list. | +| EeSubscriptionErrorAddInfo | 6.4.6.2.27 | EE Subscription Error Additional Information | +| EeSubscriptionError | 6.4.6.2.28 | EE Subscription Error | +| MaxNumOfReports | 6.4.6.3.2 | Maximum number of reports | +| ReferenceId | 6.4.6.3.2 | Reference Identity | +| EventType | 6.4.6.3.3 | Event type of UDM Event Exposure service | +| LocationAccuracy | 6.4.6.3.4 | Location Accuracy definition | +| CnType | 6.4.6.3.5 | Core Network Type | +| AssociationType | 6.4.6.3.6 | Association type | +| EventReportMode | 6.4.6.3.7 | Event report mode | +| ReachabilityForSmsConfiguration | 6.4.6.3.8 | Configuration for report of reachability status for SMS | +| PdnConnectivityStatus | 6.4.6.3.9 | PDN Connectivity Status | +| ReachabilityForDataReportConfig | 6.4.6.3.10 | Configuration for report of reachability status for data | +| RevokedCause | 6.4.6.3.11 | Revocation Cause for the monitoring event | +| FailedCause | 6.4.6.3.12 | Failed cause of the failed Monitoring Configuration in the EE subscription | +| SubscriptionType | 6.4.6.3.13 | Subscription Type | + +Table 6.4.6.1-2 specifies data types re-used by the Nudm\_EE service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudm\_EE service API. + +**Table 6.4.6.1-2: Nudm\_EE re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------------|---------------------|-------------------------------------------------------------------------------------------------| +| Uri | 3GPP TS 29.571 [7] | Uniform Resource Identifier | +| SupportedFeatures | 3GPP TS 29.571 [7] | see 3GPP TS 29.500 [4] clause 6.6 | +| DateTime | 3GPP TS 29.571 [7] | DateTime | +| Pei | 3GPP TS 29.571 [7] | Permanent Equipment Identifier | +| PlmnId | 3GPP TS 29.571 [7] | PLMN ID | +| Gpsi | 3GPP TS 29.571 [7] | Generic Public Subscription Identifier | +| AccessType | 3GPP TS 29.571 [7] | Access Type | +| PatchItem | 3GPP TS 29.571 [7] | Patch item of JSON PATCH | +| PatchResult | 3GPP TS 29.571 [7] | Patch result of JSON PATCH | +| DddTrafficDescriptor | 3GPP TS 29.571 [7] | Traffic description for downlink data delivery | +| SamplingRatio | 3GPP TS 29.571 [7] | Sampling ratio | +| DurationSec | 3GPP TS 29.571 [7] | A duration expressed in seconds | +| DIDataDeliveryStatus | 3GPP TS 29.571 [7] | Downlink data delivery status | +| Dnn | 3GPP TS 29.571 [7] | Data Network Name with Network Identifier only. | +| Snsai | 3GPP TS 29.571 [7] | Single NSSAI | +| DiameterIdentity | 3GPP TS 29.571 [7] | Diameter Identity (FQDN) | +| CmInfo | 3GPP TS 29.518 [36] | Describe the Connection Management state information for an access type | +| MtcProviderInformation | 3GPP TS 29.571 [7] | MTC Provider Information | +| NfInstanceId | 3GPP TS 29.571 [7] | Network Function Instance Identifier | +| NotificationFlag | 3GPP TS 29.571 [7] | Notification flag | +| UeReachability | 3GPP TS 29.518 [36] | Describes the reachability of the UE | +| LossOfConnectivityReason | 3GPP TS 29.518 [36] | Describes the reason of connectivity loss | +| UserLocation | 3GPP TS 29.571 [7] | User Location | +| PduSessionId | 3GPP TS 29.571 [7] | PDU Session Id | +| Ipv4Addr | 3GPP TS 29.571 [7] | IPv4 Address | +| Ipv6Addr | 3GPP TS 29.571 [7] | IPv6 Address | +| Ipv6Prefix | 3GPP TS 29.571 [7] | IPv6 Prefix | +| PduSessionType | 3GPP TS 29.571 [7] | PDU session type. | +| ContextInfo | 6.1.6.2.69 | Contains the HTTP Headers received by the NFs | +| DataRestorationNotification | 6.2.6.2.25 | Contains identities representing those UEs potentially affected by a data-loss event at the UDR | +| IdleStatusIndication | 3GPP TS 29.518 [36] | Idle Status Indication | +| PlmnIdNid | 3GPP TS 29.571 [7] | PLMN ID or SNPN ID | +| MutingExceptionInstructions | 3GPP TS 29.571 [7] | Muting exception instructions. | +| MutingNotificationsSettings | 3GPP TS 29.571 [7] | Muting notifications settings. | +| VarRepPeriod | 3GPP TS 29.571 [7] | Variable Reporting Periodicity | +| ApplicationId | 3GPP TS 29.571 [7] | Application ID | +| Uint64 | 3GPP TS 29.571 [7] | Unsigned 64-bit integer | + +### 6.4.6.2 Structured data types + +#### 6.4.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 6.4.6.2.2 Type: EeSubscription + +**Table 6.4.6.2.2-1: Definition of type EeSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|-------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| callbackReference | Uri | M | 1 | URI provided by the NF service consumer to receive notifications | | +| monitoringConfigurations | map(Monitoring Configuration) | M | 1..N | A map (list of key-value pairs where referenceId converted from integer to string serves as key; see clause 6.4.6.3.2) of MonitoringConfigurations; see clause 6.4.6.2.3 | | +| reportingOptions | ReportingOptions | O | 0..1 | This IE may be included if the NF service consumer wants to describe how the reports of the event to be generated.

If this attribute is absent, the default report mode (see clause 6.4.6.2.6) shall be "ON_EVENT_DETECTION". | | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.4.8
These are the features supported by the NF subscribing at the UDM. | | +| subscriptionId | string | C | 0..1 | This attribute shall be present if the EeSubscription is sent in a GET response message on Nudr. It identifies the individual EeSubscription stored in the UDR and may be used by the UDM to delete an EeSubscription. | | +| contextInfo | ContextInfo | C | 0..1 | This IE if present may contain e.g. the headers received by the UDM along with the EeSubscription. Shall be absent on Nudm and may be present on Nudr. | | +| epcAppliedInd | boolean | O | 0..1 | This IE indicates whether the subscription applies also to EPC or not.

true: the subscription applies also to EPC.
false or absent: the subscription doesn't apply to EPC. | | +| scefDiamHost | DiameterIdentity | C | 0..1 | This IE shall be included if parameter epcAppliedInd is set to true and at least one of the notifications to subscription applied to EPC will be reported directly from the MME to the SCEF (e.g. event LOCATION_REPORTING).
When present, it contains the Diameter Identity (FQDN) of the SCEF to which the monitored reports may be sent in EPC. | | +| scefDiamRealm | DiameterIdentity | C | 0..1 | This IE shall be included if parameter epcAppliedInd is set to true and at least one of the notifications to subscription applied to EPC will be reported directly from the MME to the SCEF (e.g. event LOCATION_REPORTING).

When present, it contains the Diameter realm of the SCEF to which the monitored reports may be sent in EPC. | | +| notifyCorrelationId | string | C | 0..1 | This attribute identifies the notification correlation ID shall be present by NF consumer in subscription. The value of this IE shall be unique per subscription for a given NF service consumer. | | +| secondCallbackRef | Uri | O | 0..1 | URI provided by the NF service consumer to receive Monitoring Revocation Notification. | | +| gpsi | Gpsi | O | 0..1 | This IE if present may contain the GPSI used during the Event Exposure subscribe operation. This information shall be used to identify if a subscription must be cancelled in case this GPSI is no longer associated to the UE.
It shall be absent on Nudm and may be present on Nudr. | | +| excludeGpsiList | array(Gpsi) | O | 1..N | This IE may be present for a group subscription.

When present, this IE shall carry the GPSI of the group member UE(s) that are excluded from the group subscription. | DGEM | + +| | | | | | | +|----------------------------|-------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| includeGpsiList | array(Gpsi) | O | 1..N | This IE may be present for a group subscription.

When present, this IE shall carry the GPSI of the group member UE(s) that are added into the group subscription. | DGEM | +| dataRestorationCallbackUri | Uri | O | 0..1 | If present, it contains the URI where notifications about UDR-initiated data restoration shall be sent by UDM. | | +| udrRestartInd | boolean | O | 0..1 | May be present in request messages from the UDM consumer to the UDM.
If present:
- true: indicates that the registration message sent by the UDM consumer is due to a re-synchronization event, motivated by a previous reception at the UDM consumer of a Data Restoration Notification from the UDM
- false (or absent): indicates that this is a normal request message (i.e., not motivated by a data restoration notification event) | | + +#### 6.4.6.2.3 Type: MonitoringConfiguration + +**Table 6.4.6.2.3-1: Definition of type MonitoringConfiguration** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------|----------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eventType | EventType | M | 1 | String; see clause 6.4.6.3.3 | +| immediateFlag | boolean | O | 0..1 | Indicates if an immediate event report in the subscription response indicating current value / status of the event is required or not. If the flag is not present, then immediate reporting shall not be done.

If the event requested for immediate reporting is detected by the UDM, the UDM may include the current status of the event if available in the service operation response.

If the event requested for immediate reporting is detected by a remote NF (e.g. AMF) and directly notified to the NF consumer, the current status of the event shall not be included in the service operation response (the remote NF shall notify the current status of the event via event notification directly). | +| locationReportingConfiguration | LocationReportingConfiguration | C | 0..1 | shall be present if eventType is "LOCATION_REPORTING" | +| associationType | AssociationType | O | 0..1 | If the eventType indicates CHANGE_OF_SUPI_PEI_ASSOCIATION, this parameter may be included to identify whether the IMSI-IMEI or IMSI-IMEISV association shall be detected.
If the flag is not present, then a value of IMEISV shall be used | +| datalinkReportCfg | DatalinkReportingConfiguration | C | 0..1 | shall be present if eventType is "DL_DATA_DELIVERY_STATUS" "AVAILABILITY AFTER DDN FAILURE". | +| lossConnectivityCfg | LossConnectivityCfg | O | 0..1 | May be present if eventType is "LOSS_OF_CONNECTIVITY".
(NOTE 1) | +| maximumLatency | DurationSec | O | 0..1 | May be present if eventType is "UE_REACHABILITY_FOR_DATA"
When present, it indicates the configured Maximum Latency.
(NOTE 1) | +| maximumResponseTime | DurationSec | O | 0..1 | May be present if eventType is "UE_REACHABILITY_FOR_DATA"
When present, it indicates the configured Maximum Response Time.
(NOTE 1) | +| suggestedPacketNumDI | integer | O | 0..1 | May be present if eventType is "UE_REACHABILITY_FOR_DATA"
When present, it indicates the configured Suggested number of downlink packets.
(NOTE 1) | +| dnn | Dnn | O | 0..1 | May be present if suggestedPacketNumDI is present.
When present, it indicates the DNN for which the suggestedPacketNumDI is applicable. | +| singleNssai | Snssai | O | 0..1 | May be present if suggestedPacketNumDI is present.
When present, it indicates the slice for which the suggestedPacketNumDI is applicable. | +| appId | ApplicationId | C | 1..N | Application Identifier

May be present if eventType is "QOS_MON" | +| reachabilityForDataCfg | ReachabilityForDataConfiguration | O | 0..1 | May be present if eventType is "UE_REACHABILITY_FOR_DATA" | +| pduSessionStatusCfg | PduSessionStatusCfg | O | 0..1 | may be present if eventType is "PDN_CONNECTIVITY_STATUS" | +| reachabilityForSmsCfg | ReachabilityForSmsConfiguration | O | 0..1 | REACHABILITY_FOR_SMS_OVER_NAS (default)
or
REACHABILITY_FOR_SMS_OVER_IP | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for Monitoring Configuration authorization. | + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aflId | string | O | 0..1 | The string identifying the originating AF, which is carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {aflId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]). | +| idleStatusInd | boolean | O | 0..1 | Idle Status Indication request.
May be present if eventType is UE_REACHABILITY_FOR_DATA or AVAILABILITY_AFTER_DDN_FAILURE
true: Idle status indication is requested
false (default): Idle status indication is not requested | +| monitoringSuspension | MonitoringSuspension | O | 0..1 | If present this IE indicates that monitoring shall be suspended when the indicated conditions are met. Absence indicates that no suspension applies.
(NOTE 2) | +| NOTE 1: Parameters maximumLatency, maximumResponseTime, suggestedPacketNumDI and lossConnectivityCfg are not recommended to be used for the AFs that support to set them by Parameter Provision service operation via NEF.
NOTE 2: For events detectable at the AMF, the UDM shall not subscribe at the AMF as long as the monitoring is suspended.
When the UDM detects inter PLMN mobility from suspended to not-suspended PLMN, it shall subscribe at the new AMF.
When the UDM detects inter PLMN mobility from not-suspended to suspended PLMN, it shall un-subscribe from the new AMF. | | | | | + +#### 6.4.6.2.4 Type: MonitoringReport + +**Table 6.4.6.2.4-1: Definition of type MonitoringReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| referenceId | ReferenceId | M | 1 | Shall contain the Reference ID which was provided as the key of the associated monitoring configuration in subscription request. The consumer can use this IE to uniquely associate the report with the corresponding event that was requested to be monitored. | +| eventType | EventType | M | 1 | String; see clause 6.4.6.3.3
only the following values are allowed:
"UE_REACHABILITY_FOR_SMS"
"UE_REACHABILITY_FOR_DATA"
"CHANGE_OF_SUPI_PEI_ASSOCIATION"
"ROAMING_STATUS"
"CN_TYPE_CHANGE"
"UE_CONNECTION_MANAGEMENT_STATE"
"LOSS_OF_CONNECTIVITY"
"LOCATION_REPORTING"
"PDN_CONNECTIVITY_STATUS"
"UE_MEMORY_AVAILABLE_FOR_SMS"
"GROUP_MEMBER_LIST_CHANGE"
(NOTE) | +| report | Report | C | 0..1 | Shall be present if eventType is
"CHANGE_OF_SUPI_PEI_ASSOCIATION" or
"ROAMING_STATUS"
"CN_TYPE_CHANGE"
"UE_CONNECTION_MANAGEMENT_STATE"
"LOSS_OF_CONNECTIVITY"
"LOCATION_REPORTING"
"PDN_CONNECTIVITY_STATUS"
"GROUP_MEMBER_LIST_CHANGE" | +| reachabilityForSmsReport | ReachabilityForSmsReport | C | 0..1 | Should be present if eventType is
"UE_REACHABILITY_FOR_SMS" and
reachabilityForSmsCfg was absent from the
MonitoringConfiguration or indicated
REACHABILITY_FOR_SMS_OVER_NAS | +| reachabilityReport | ReachabilityReport | C | 0..1 | Should be present if eventType is
"UE_REACHABILITY_FOR_DATA" with
configuration "INDIRECT_REPORT" or
"UE_REACHABILITY_FOR_SMS" with configuration
"REACHABILITY_FOR_SMS_OVER_IP" | +| gpsi | Gpsi | C | 0..1 | shall be present if the report is associated to
exposure subscriptions for a group of UEs or any
UE. | +| timeStamp | DateTime | M | 1 | Point in time at which the event occurred | +| NOTE: "UE_CONNECTION_MANAGEMENT_STATE", "LOSS_OF_CONNECTIVITY", "LOCATION_REPORTING" and "PDN_CONNECTIVITY_STATUS" event types shall only be included in an immediate report, when NF consumer has indicated support of "IERSR" feature (see clause 6.4.8) and the immediate report has been received from HSS or AMF in subscription creation response. | | | | | + +#### 6.4.6.2.5 Type: Report + +**Table 6.4.6.2.5-1: Definition of type Report as a list of mutually exclusive alternatives** + +| Data type | Cardinality | Description | +|----------------------------------|--------------------|----------------------------------------| +| ChangeOfSupiPeiAssociationReport | 1 | Report Change of SUPI-PEI Association | +| RoamingStatusReport | 1 | Report Roaming Status | +| CnTypeChangeReport | 1 | Report new CN type after switching | +| CmInfoReport | 1 | Report the UE's CM state | +| LossConnectivityReport | 1 | Report of "LOSS_OF_CONNECTIVITY" event | +| LocationReport | 1 | "LOCATION_REPORTING" | +| PdnConnectivityStatReport | 1 | "PDN_CONNECTIVITY_STATUS" | +| GroupMembListChanges | 1 | "GROUP_MEMBER_LIST_CHANGE" | + +#### 6.4.6.2.6 Type: ReportingOptions + +**Table 6.4.6.2.6-1: Definition of type ReportingOptions** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| reportMode | EventReportMode | O | 0..1 | Indicates the mode of report (e.g, periodic reporting along with periodicity, reporting based on event detection). See clause 4.15.1 of 3GPP TS23.502 [3].

If this attribute is absent, the default reportMode shall be "ON_EVENT_DETECTION". | | +| maxNumOfReports | MaxNumOfReports | C | 0..1 | Maximum number of reports. If the event subscription is for a group of UEs, this parameter shall be applied to each individual member UE of the group.
(NOTE 2) | | +| expiry | DateTime | C | 0..1 | This IE shall be included in an event subscription response, if, based on operator policy, the UDM needs to include an expiry time, and may be included in an event subscription request. When present, this IE shall represent the time at which monitoring shall cease and the subscription becomes invalid. If the maxNumOfReports included in an event subscription response is 1 and if an event report is included in the subscription response then the value of the expiry included in the response shall be an immediate timestamp.
(NOTE 2) | | +| samplingRatio | SamplingRatio | O | 0..1 | Indicates the percentage of sampling among impacted UEs, this parameter is used for group-based monitoring configuration. See clause 4.15.1 of 3GPP TS23.502 [3].
(NOTE 1) | | +| guardTime | DurationSec | O | 0..1 | Indicates the time for which the Monitoring Event Reporting(s) detected by the UEs in a group can be aggregated before sending them to the consumer NF, this parameter is used for group-based monitoring configuration. See clause 4.15.1 of 3GPP TS23.502 [3]. | | +| reportPeriod | DurationSec | C | 0..1 | Indicates the interval time between which the event notification is reported, shall be present if reportMode is "PERIODIC".
(NOTE 4) | | +| notifFlag | NotificationFlag | O | 0..1 | Indicates the notification flag, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications.
(NOTE 3) | EneNA | +| mutingExcInstructions | MutingExceptionInstructions | O | 0..1 | This IE may be included in the event subscription request if the notifFlag IE is present and set to "DEACTIVATE".
When present, it shall indicate the instructions for the subscription and stored events when an exception (e.g. the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number) occurs at remote NF (e.g. AMF) while the events are muted.
See 3GPP TS 23.288 [35], clause 6.2.7.2.
Write-Only: true
(NOTE 3) | ENAPH3 | +| mutingNotSettings | MutingNotificationsSettings | O | 0..1 | This IE may be included if the event notifications muting is activated.
This IE Indicates the remote NF (e.g. AMF) muting notification settings.
See 3GPP TS 23.288 [35], clause 6.2.7.2.
Read-Only: true
(NOTE 3) | ENAPH3 | + +| | | | | | | +|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| varRepPeriodInfo | array(VarRepPeriod) | O | 1..N | This IE may be present if the trigger is set to "PERIODIC".
This IE Indicates the variable reporting periodicity information.
See 3GPP TS 23.502 [3], clause 4.15.1.
(NOTE 4) | | +| NOTE 1: | Parameter only applicable to certain event IDs reporting metrics (e.g. Number of UEs present in a geographical area) used and used e.g. by the NWDAF for data collection. | | | | | +| NOTE 2: | If parameter "maxNumOfReports" and "expiry" are included at the same time, the subscription will expire as soon as one of the conditions is met. If the ReportMode is set to "PERIODIC", at least one of the "maxNumOfReports" and "expiry" attributes shall be included. | | | | | +| NOTE 3: | The information is only applicable to the event detected by a remote NF (e.g. AMF) and directly notified to the NF consumer (e.g. NWDAF or DCCF), the UDM shall ignore this attribute in other scenarios. | | | | | +| NOTE 4: | If both reportPeriod and varRepPeriodInfo attributes are present, the repPeriod shall be applied if none of the conditions trigger the variable reporting is met. | | | | | + +#### 6.4.6.2.7 Type: ChangeOfSupiPeiAssociationReport + +**Table 6.4.6.2.7-1: Definition of type ChangeOfSupiPeiAssociationReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| newPei | Pei | M | 1 | the new PEI | + +#### 6.4.6.2.8 Type: RoamingStatusReport + +**Table 6.4.6.2.8-1: Definition of type RoamingStatusReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| roaming | boolean | M | 1 | True: The new serving PLMN is different from the HPLMN;
False: The new serving PLMN is the HPLMN, or the UE is de-registered for the indicated access type (as indicated by the "purged" attribute). | +| newServingPlmn | PlmnId | M | 1 | The new Serving PLMN.

If the "purged" attribute is present with value "true", the last known PLMN ID shall be reported. | +| accessType | AccessType | O | 0..1 | The access type used for accessing the new Serving PLMN

This information may be used by SoR-AF to generate updated SoR information for the UE | +| purged | boolean | O | 0..1 | This IE shall be present with value "true" to indicate that the UE is de-registered from the AMF for the indicated access type. In this case the newServingPlmn shall be set to the last known PLMN ID value. (NOTE) | +| NOTE: | A change on the "purged" status of the UE shall not trigger by itself the reporting of the Roaming Status event. This event shall be reported according to the conditions indicated in 3GPP TS 23.502 [3]. | | | | + +#### 6.4.6.2.9 Type: CreatedEeSubscription + +**Table 6.4.6.2.9-1: Definition of type CreatedEeSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eeSubscription | EeSubscription | M | 1 | This IE shall contain the representation of the created event subscription. | +| numberOfUes | Uinteger | C | 0..1 | This IE shall be included if the event subscription is for a group of UEs. When present, this IE shall represent the number of UEs in the group. | +| eventReports | array(Monitoring Report) | O | 1..N |

This IE when present, shall contain the status of events that are requested for immediate reporting as well, if those events are available at the time of subscription.

If an event requested for immediate reporting is detected by another NF (e.g. AMF or HSS) and both the UDM and the NF consumer (e.g. NEF) supports the "IERSR" feature, this UDM shall require the other NF to include the immediate reporting in subscription creation response and the UDM shall include the immediate event reports received from other NF in this IE; otherwise, the UDM shall require the other NF to directly notify to the NF consumer, thus the status of the event shall not be included in this IE.

For immediate reporting of Roaming Status, two separate MonitoringReports (one for 3GPP access, one for non-3GPP access) shall be included.

| +| epcStatusInd | boolean | C | 0..1 |

This IE indicates whether the subscription was also successful in EPC domain or not.

true: the subscription was also successful in EPC domain.
false: the subscription was not successful in EPC domain.

This IE shall be included if epcAppliedInd is true in the subscription request.

| +| 5gOnlyInd | boolean | O | 0..1 |

This IE may be present with the value true when the epcStatusInd IE is absent or with the value false.

When present with the value true, it shall indicate that the subscription is not done in EPC for the UE because the UE is 5G only. When this IE is received, the NF should not separately subscribe to EPC via HSS.

| +| failedMonitoringConfigs | map(FailedMonitoringConfiguration) | O | 1..N |

A map (list of key-value pairs where ReferenceId converted from integer to string serves as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration; see clause 6.4.6.2.24.

This IE is used to indicate the failed subscriptions of event monitoring configuration and the failed cause for them.

| + +| | | | | | +|-------------------------------|------------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| failedMoniConfigsEPC | map(FailedMonitoringConfiguration) | O | 1..N |

A map (list of key-value pairs where ReferenceId converted from integer to string serves as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration; see clause 6.4.6.2.24.

In addition to defined EventTypes, the key value "ALL" may be used to identify a map entry which contains the failed cause of the EE subscription was not successful in EPC domain.

This IE is used to indicate the failed subscriptions of event monitoring configuration in EPC and the failed cause for them.

This IE may be present when the EE subscription applies also to the EPC. When present,

  • - the key-value "ALL" shall be used and only one map entry exists if the epcStatusInd sets false;
  • - the key-values shall be ReferenceId converted from integer to string if the epcStatusInd sets true or absent.
| +| resetIds | array(string) | O | 1..N |

May be present in subscribe response messages. The NF service consumer may decide to re-subscribe at the UDM when receiving a data restoration notification containing a matching resetId.

| +| currentStatusNotAvailableList | array(EventType) | O | 1..N |

This IE should be present if immediate reporting was requested by the NF consumer, but the current status of at least one of the subscribed events is not available at the time of subscription.

When present, this IE shall list the events for which the current status is not available for immediate reporting.

| + +#### 6.4.6.2.10 Type: LocationReportingConfiguration + +**Table 6.4.6.2.10-1: Definition of type LocationReportingConfiguration** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------|------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| currentLocation | boolean | M | 1 |

When true: Indicates that current location is requested.

When false: Indicates that last known location is requested.

| +| oneTime | boolean | C | 0..1 |

When true: Indicates that a single report is requested.

When false or absent: Indicates that continuous reporting is requested.

Shall not be absent or set to false when currentLocation is false.

| +| accuracy | LocationAccuracy | C | 0..1 | Indicates whether Cell-level or TA-level accuracy is requested for 3GPP access. (NOTE 1) | +| n3gppAccuracy | LocationAccuracy | C | 0..1 | Indicates whether N3IWF or UE IP or UE PORT level accuracy is requested for non-3GPP access. (NOTE 1) | +| NOTE 1: At least one of accuracy and n3gppAccuracy shall be present if continuous reporting is required | | | | | + +#### 6.4.6.2.11 Type: CnTypeChangeReport + +**Table 6.4.6.2.11-1: Definition of type CnTypeChangeReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------| +| oldCnType | CnType | O | 0..1 | the old CN type | +| newCnType | CnType | M | 1 | the new CN type | + +#### 6.4.6.2.12 Type: ReachabilityForSmsReport + +**Table 6.4.6.2.12-1: Definition of type ReachabilityForSmsReport** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smsfAccessType | AccessType | M | 1 | | +| maxAvailabilityTime | DateTime | O | 0..1 | Indicates the time (in UTC) until which the UE is expected to be reachable.

This information may be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Message to UEs using a power saving mechanism (eDRX, PSM etc.). | + +#### 6.4.6.2.13 Type: DatalinkReportingConfiguration + +**Table 6.4.6.2.13-1: Definition of type DatalinkReportingConfiguration** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dddTrafficDes | array(DddTrafficDescriptor) | C | 1..N | This IE shall be present for event type "DL_DATA_DELIVERY_STATUS" "AVAILABILITY_AFTER_DDN_FAILURE".

When present, this IE shall indicate the traffic descriptors of the downlink data. | +| dnn | Dnn | O | 0..1 | When present, this IE shall contain the Network Identifier only and indicate the DNN of the PDU session serving the data link. | +| slice | Snssai | O | 0..1 | When present, this IE shall indicate the slice information of the PDU session serving the data link. | +| dddStatusList | array(DIDataDeliveryStatus) | O | 1..N | This IE shall be present for event type "DL_DATA_DELIVERY_STATUS".

When present, this IE shall indicate the subscribed statuses (discarded, transmitted, buffered) for the event. If omitted all stati are subscribed. | + +##### 6.4.6.2.14 Type: CmInfoReport + +**Table 6.4.6.2.11-1: Definition of type CmInfoReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|------------------------------| +| oldCmInfoList | array(CmInfo) | O | 1..2 | the old CM State information | +| newCmInfoList | array(CmInfo) | M | 1..2 | the new CM State information | + +#### 6.4.6.2.15 Type: LossConnectivityCfg + +**Table 6.4.6.2.15-1: Definition of type LossConnectivityCfg** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------|---|-------------|------------------------------------------------------------------| +| maxDetectionTime | DurationSec | O | 0..1 | When present, it indicates the configured Maximum Detection Time | + +#### 6.4.6.2.16 Type: PduSessionStatusCfg + +**Table 6.4.6.2.16-1: Definition of type PduSessionStatusCfg** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------| +| dnn | Dnn | O | 0..1 | When present, it indicates the DNN for which the event is monitored. | + +##### 6.4.6.2.17 Type: LossConnectivityReport + +**Table 6.4.6.2.17-1: Definition of type LossConnectivityReport** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|--------------------------|---|-------------|------------------------------------------------| +| lossOfConnectReason | LossOfConnectivityReason | M | 1 | Describes the reason for loss of connectivity. | + +#### 6.4.6.2.18 Type: LocationReport + +**Table 6.4.6.2.18-1: Definition of type LocationReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|---------------------------------------------------| +| location | UserLocation | M | 1 | This IE shall include all available UE locations. | + +#### 6.4.6.2.19 Type: PdnConnectivityStatReport + +**Table 6.4.6.2.19-1: Definition of type PdnConnectivityStatReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|---------------------------------| +| pdnConnStat | PdnConnectivityStatus | M | 1 | PDN Connectivity Status | +| dnn | Dnn | O | 0..1 | DNN/APN of the PDN connectivity | +| pduSessionId | PduSessionId | O | 0..1 | PDU session ID. | +| ipv4Addr | Ipv4Addr | O | 0..1 | IPv4 address. | +| ipv6Prefixes | array(Ipv6Prefix) | O | 1..N | IPv6 prefixes. | +| ipv6Addrs | array(Ipv6Addr) | O | 1..N | IPv6 addresses. | +| pduSessType | PduSessionType | O | 0..1 | PDU session type. | + +#### 6.4.6.2.20 Type: ReachabilityReport + +**Table 6.4.6.2.20-1: Definition of type ReachabilityReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|-----------------------------------------------------------------------------| +| amfInstanceId | NfInstanceId | O | 0..1 | The serving AMF which the UE is reachable. | +| accessTypeList | array(AccessType) | O | 1..N | Describes the access type(s) of the UE | +| reachability | UeReachability | O | 0..1 | Describes the reachability of the UE (NOTE) | +| maxAvailabilityTime | DateTime | O | 0..1 | Indicates the time (in UTC) until which the UE is expected to be reachable. | +| idleStatusIndication | IdleStatusIndication | O | 0..1 | Idle Status Indication | + +NOTE: Only the value "REACHABLE" is supported in this release. + +#### 6.4.6.2.21 Type: ReachabilityForDataConfiguration + +**Table 6.4.6.2.21-1: Definition of type ReachabilityForDataConfiguration** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reportCfg | ReachabilityForDataReportConfig | M | 1 | Specify the reporting configuration of Reachability for Data event. | +| minInterval | DurationSec | O | 0..1 | When present, this IE indicates the minimal interval to report the event, i.e. when an event is reported, a subsequent event report shall not be sent during the interval. (NOTE) | +| NOTE: This IE is applicable only to AMF. When received, the UDM shall forward this IE when subscribing to AMF for UE Reachability for Data event. | | | | | + +#### 6.4.6.2.22 Type: EeMonitoringRevoked + +**Table 6.4.6.2.22-1: Definition of type EeMonitoringRevoked** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| revokedMonitoringEventList | map(MonitoringEvent) | M | 1..N | Shall contain a map (list of key-value pairs where referenceId converted from integer to string serves as key; see clause 6.4.6.3.2) of the MonitoringEvents (see clause 6.4.6.2.20) that shall be revoked.

The Reference ID which was provided as the key of the associated monitoring configuration in subscription request. The consumer can use this IE to uniquely associate the revoked monitoring event with the corresponding event that was requested to be monitored. | | +| removedGpsi | Gpsi | O | 1 | This IE may be present when Network initiated explicit event notification subscription cancel procedure, as specified in clause 4.15.3.2.11 of 3GPP TS 23.502 [3].

When present, this IE shall indicate the GPSI of the individual subscription used during the Event Exposure subscribe operation and which is not associated to this subscription anymore. | | +| excludeGpsiList | array(Gpsi) | O | 1..N | This IE may be present when Network initiated explicit event notification subscription cancel procedure, as specified in clause 4.15.3.2.11 of 3GPP TS 23.502 [3].

When present, this IE shall indicate the GPSI of the group member UE(s) that are excluded from the group subscription. | DGEM | + +#### 6.4.6.2.23 Type: MonitoringEvent + +**Table 6.4.6.2.23-1: Definition of type MonitoringEvent** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------| +| eventType | EventType | M | 1 | String; see clause 6.4.6.3.3 | +| revokedCause | RevokedCause | O | 0..1 | When present, it contains the reason for revocation of the monitoring event. | + +##### 6.4.6.2.24 Type: FailedMonitoringConfiguration + +**Table 6.4.6.2.24-1: Definition of type FailedMonitoringConfiguration** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|------------------------------------------------------------------------| +| eventType | EventType | M | 1 | Contains the Event type, see clause 6.4.6.3.3 | +| failedCause | FailedCause | M | 1 | Contains the failed cause of the subscription of the event monitoring. | + +##### 6.4.6.2.25 Type: MonitoringSuspension + +**Table 6.4.6.2.25-1: Definition of type MonitoringSuspension** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| suspendedInsidePlmnList | array(PlmnIdNid) | O | 1..N | A list of PLMNs/SNPNs. When the UE is served by one of these PLMNs/SNPNs monitoring of the UE is suspended.
Shall be absent if suspendedOutsidePlmnList is present. | +| suspendedOutsidePlmnList | array(PlmnIdNid) | O | 1..N | A list of PLMNs/SNPNs. When the UE is served by none of these PLMNs/SNPNs monitoring of the UE is suspended.
Shall be absent if suspendedInsidePlmnList is present. | + +#### 6.4.6.2.26 Type: GroupMembListChanges + +**Table 6.4.6.2.26-1: Definition of type GroupMembListChanges** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------|-------------|---|-------------|----------------------------------------------| +| addedUEs | array(Gpsi) | O | 1..N | Identifies the UE(s) added to the group. | +| removedUEs | array(Gpsi) | O | 1..N | Identifies the UE(s) removed from the group. | +| NOTE: At least one of the "addedUEs" attributes and the "removedUEs" attribute shall be provided. | | | | | + +##### 6.4.6.2.27 Type: EeSubscriptionErrorAddInfo + +**Table 6.4.6.2.27-1: Definition of type EeSubscriptionErrorAddInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| subType | SubscriptionType | O | 0..1 | This IE may be present when the cause is set to the "USER_NOT_FOUND".

When present, it shall indicate in which domain(s) the UE subscription cannot be found by the UDM. When the UDM doesn't indicate the UE subscription for 4G is not found, the NF consumer may separately subscribe to EPC via HSS. | | +| failedMonitoringConfigs | map(FailedMonitoringConfiguration) | O | 1..N | A map (list of key-value pairs where ReferenceId converted from integer to string serves as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration; see clause 6.4.6.2.24.

This IE is used to indicate the failed subscriptions of event monitoring configuration and the failed cause for them. | | +| failedMoniConfigsEPC | map(FailedMonitoringConfiguration) | O | 1..N | A map (list of key-value pairs where ReferenceId converted from integer to string serves as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration; see clause 6.4.6.2.24.
In addition to defined EventTypes, the key value "ALL" may be used to identify a map entry which contains the failed cause of the EE subscription was not successful in EPC domain.

This IE is used to indicate the failed subscriptions of event monitoring configuration in EPC and the failed cause for them.
This IE may be present when the EE subscription applies also to the EPC. When present,
- the key-value "ALL" shall be used and only one map entry exists if the epcStatusInd sets false;
- the key-values shall be ReferenceId converted from integer to string if the epcStatusInd sets true or absent. | | + +##### 6.4.6.2.28 Type: EeSubscriptionError + +**Table 6.4.6.2.28-1: Definition of type EeSubscriptionError as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|----------------------------|-------------|----------------------------------------------------------|---------------| +| ProblemDetails | 1 | Detail information of the problem | | +| EeSubscriptionErrorAddInfo | 1 | Additional information to be returned in error response. | | + +### 6.4.6.3 Simple data types and enumerations + +#### 6.4.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 6.4.6.3.2 Simple data types + +The simple data types defined in table 6.4.6.3.2-1 shall be supported. + +**Table 6.4.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MaxNumOfReports | integer | Maximum number of reports.
Minimum: 1 | +| ReferenceId | Uint64 |

ReferenceId is used as key in a map of MonitoringConfigurations; see clause 6.4.6.2.2.

ReferenceId is also used as key in a map of MonitoringEvents; see clause 6.4.6.2.20.

ReferenceId is used as key in a map of FailedMonitoringConfiguration; see clause 6.4.6.2.9.

The numeric value shall not be higher than 2^{64}-1; i.e. it shall be possible to convey it in an unsigned 64 integer Information Element used in other protocols (e.g. in the Event Exposure framework in EPC).

| + +#### 6.4.6.3.3 Enumeration: EventType + +**Table 6.4.6.3.3-1: Enumeration EventType** + +| Enumeration value | Description | +|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "LOSS_OF_CONNECTIVITY" | Loss of connectivity | +| "UE_REACHABILITY_FOR_DATA" |

UE reachability for data, implements the "UE Reachability" monitoring event as specified in clause 4.15.3.1 in 3GPP TS 23.502 [3].

When this event is subscribed by an NF service consumer, the UDM subscribes to "ReachabilityReport" event for "UE Reachability for DL Traffic" on the AMF.

When this event is subscribed by an NF service consumer, the UDM shall request the AMF to directly send notification to NF, if reachabilityForDataCfg is not present or indicates "DIRECT_REPORT".

When this event is subscribed by an NF service consumer and reachabilityForDataCfg indicates "INDIRECT_REPORT", the UDM shall request the AMF to send notification via the UDM. The Event is reported to an NF service consumer by the UDM when a UE Activity notification or Nudm_UECM_Registration is received from AMF, unless the AMF indicated in UECM registration that UE is not reachable or the UE reachability is unknown and UDM is configured to not report event based on operator policy (see clause 5.3.2.2.2).

| +| "UE_REACHABILITY_FOR_SMS" |

UE reachability for SMS, implements the "UE Reachability for SMS Delivery" event as specified in clause 4.15.3.1 of 3GPP TS 23.502 [3].

This Event is reported when an SMSF is being registered in UDM for the UE, or when a UE Activity notification is received from AMF and there is an SMSF already registered for the UE.

This Event is also reported when a UE Activity notification or Nudm_UECM_Registration is received from AMF regardless of an SMSF being registered. when the request configuration is for SMS over IP, unless the AMF indicated in UECM registration that UE is not reachable or the UE reachability is unknown and UDM is configured to not report event based on operator policy (see clause 5.3.2.2.2).

This event only supports One-Time reporting.

| +| "LOCATION_REPORTING" | Location Reporting | +| "CHANGE_OF_SUPI_PEI_ASSOCIATION" | Change of SUPI-PEI association | +| "ROAMING_STATUS" | Roaming Status | +| "COMMUNICATION_FAILURE" | Communication Failure | +| "AVAILABILITY_AFTER_DDN_FAILURE" | Availability after DDN failure | +| "CN_TYPE_CHANGE" | CN type change | +| "DL_DATA_DELIVERY_STATUS" | Downlink Data Delivery Status | +| "PDN_CONNECTIVITY_STATUS" | PDU Session Status | +| "UE_CONNECTION_MANAGEMENT_STATE" | UE state of Connection Management | +| "ACCESS_TYPE_REPORT" |

The event is detected and reported by AMF (see clause 6.2.6.3.3 of 3GPP TS 29.518 [36]).

A NF subscribes to this event via UDM to receive the current access type(s) of a UE or a group of UEs, and updated access type(s) of the UE or any UE in the group when AMF becomes aware of the access type change of the UE.

| + +| | | +|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "REGISTRATION_STATE_REPORT" |

The event is detected and reported by AMF (see clause 6.2.6.3.3 of 3GPP TS 29.518 [36]).

A NF subscribes to this event via UDM to receive the current registration state of a UE or a group of UEs, and report for updated registration state of a UE or any UE in the group when AMF becomes aware of a registration state change of the UE.

| +| "CONNECTIVITY_STATE_REPORT" |

The event is detected and reported by AMF (see clause 6.2.6.3.3 of 3GPP TS 29.518 [36]).

A NF subscribes to this event via UDM to receive the current connection management state of a UE or a group of UEs, and report for updated connection management state of a UE or any UE in the group when AMF becomes aware of a connection management state change of the UE.

| +| "TYPE_ALLOCATION_CODE_REPORT" |

The event is detected and reported by AMF (see clause 6.2.6.3.3 of 3GPP TS 29.518 [36]).

A NF subscribes to this event via UDM to receive the TAC of a UE or group of UEs.

| +| "FREQUENT_MOBILITY_REGISTRATION_REPORT" |

The event is detected and reported by AMF (see clause 6.2.6.3.3 of 3GPP TS 29.518 [36]).

A NF subscribes to this event via UDM to receive the number of mobility registration procedures during a period of a UE or group of UEs.

| +| "PDU_SES_REL" |

The event is detected and reported by SMF (see clause 5.6.3.3 of 3GPP TS 29.508 [40]).

A NF subscribes to this event via UDM to receive event report when a PDU session is released of a UE or group of UEs.

| +| "PDU_SES_EST" |

The event is detected and reported by SMF (see clause 5.6.3.3 of 3GPP TS 29.508 [40]).

A NF subscribes to this event via UDM to receive event report when a PDU session is established of a UE or group of UEs.

| +| "UE_MEMORY_AVAILABLE_FOR_SMS" |

The event is detected and reported by SMS-GMSC/IWMSC (see clause 5.1.8 of 3GPP TS 29.540 [66]).

A NF subscribes to this event via UDM to receive event report when UE memory capacity is exceeded.

| +| "GROUP_MEMBER_LIST_CHANGE" |

Indicates Group Member List Change event.

This event is detected and reported by the UDM.

| +| "QOS_MON" |

The event is detected and reported by SMF (see clause 4.15.13 of 3GPP TS 23.502 [3]).

A NF subscribes to this event via UDM to receive event report a UE matches QoS filtering criteria.

| + +#### 6.4.6.3.4 Enumeration: LocationAccuracy + +**Table 6.4.6.3.4-1: Enumeration LocationAccuracy** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------------------------------------------| +| "CELL_LEVEL" | change of cell shall be reported for 3GPP access | +| "RAN_NODE_LEVEL" | change of serving RAN node shall be reported for 3GPP access | +| "TA_LEVEL" | change of TA shall be reported for 3GPP access | +| "N3IWF_LEVEL" | Change of N3IWF node shall be reported for non-3GPP access | +| "UE_IP" | change of UE IP address (used to reach the N3IWF) shall be reported for non-3GPP access | +| "UE_PORT" | Change of UE source port shall be reported for non-3GPP access | + +#### 6.4.6.3.5 Enumeration: CnType + +**Table 6.4.6.3.5-1: Enumeration CnType** + +| Enumeration value | Description | +|-------------------|--------------------------------| +| "SINGLE_4G" | Single registration in 4G | +| "SINGLE_5G" | Single registration in 5G | +| "DUAL_4G5G" | Dual registration in 4G and 5G | + +#### 6.4.6.3.6 Enumeration: AssociationType + +**Table 6.4.6.3.6-1: Enumeration AssociationType** + +| Enumeration value | Description | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "IMEI_CHANGE" | The event shall be reported if the association between IMSI and IMEI has changed; if only the Software Version (SV) has changed, no event shall be reported. | +| "IMEISV_CHANGE" | The event shall be reported if the association between IMSI and IMEI, or SV, or both, has changed (this includes the case where only the SV has changed). | + +#### 6.4.6.3.7 Enumeration: EventReportMode + +**Table 6.4.6.3.7-1: Enumeration EventReportMode** + +| Enumeration value | Description | +|-----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------| +| "PERIODIC" | The notification is periodically sent. (NOTE) | +| "ON_EVENT_DETECTION" | The notification is sent based on event detection. | +| NOTE: The "PERIODIC" reporting mode shall only be applicable to the following event types:
- "LOCATION_REPORTING". | | + +##### 6.4.6.3.8 Enumeration: ReachabilityForSmsConfiguration + +**Table 6.4.6.3.8-1: Enumeration ReachabilityForSmsConfiguration** + +| Enumeration value | Description | +|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "REACHABILITY_FOR_SMS_OVER_NAS" | Indicates that the Monitoring Configuration with Event Type UE_REACHABILITY_FOR_SMS requests a notification when the UE is reachable for SMS via a registered SMSF (default) | +| "REACHABILITY_FOR_SMS_OVER_IP" | Indicates that the Monitoring Configuration with Event Type UE_REACHABILITY_FOR_SMS requests a notification when the UE is reachable for SMS over IP, i.e. regardless of an SMSF being registered. | + +##### 6.4.6.3.9 Enumeration: PdnConnectivityStatus + +**Table 6.4.6.3.9-1: PdnConnectivityStatus** + +| Enumeration value | Description | +|-------------------|-----------------------------| +| "ESTABLISHED" | PDN Connection established. | +| "RELEASED" | PDN Connection released. | + +#### 6.4.6.3.10 Enumeration: ReachabilityForDataReportConfig + +**Table 6.4.6.3.10-1: Enumeration ReachabilityForDataReportConfig** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "DIRECT_REPORT" | It indicates UE reachability is detected in AMF and reported directly to the consumer NF by AMF (default). | +| "INDIRECT_REPORT" | It indicates UE reachability is detected in AMF and UDM and reported to the consumer NF by the UDM. The UDM shall send reporting of "UE_REACHABILITY_FOR_DATA" to the consumer NF when it receives "UE Reachability for DL Traffic" report or Nudm_UECM_Registration from the AMF (see TS 23.502 [3] clause 4.2.5.3). | + +#### 6.4.6.3.11 Enumeration: RevokedCause + +**Table 6.4.6.3.11-1: Enumeration RevokedCause** + +| Enumeration value | Description | +|-----------------------|-------------------------------------------------------------------------------------------------------| +| "NOT_ALLOWED" | Monitoring is not allowed | +| "EXCLUDED_FROM_GROUP" | Group member UE(s) are removed from a group subscription | +| "GPSI_REMOVED" | The GPSI used in the Event Exposure subscription is not longer valid for this individual subscription | + +#### 6.4.6.3.12 Enumeration: FailedCause + +**Table 6.4.6.3.12-1: Enumeration FailedCause** + +| Enumeration value | Description | +|-----------------------------------------|-------------------------------------------------------------------------------------------------------| +| "AF_NOT_ALLOWED" | This AF is not allowed to perform monitoring for the requested event type. | +| "MTC_PROVIDER_NOT_ALLOWED" | MTC Provider is not allowed to perform monitoring for the requested event type. | +| "MONITORING_NOT_ALLOWED" | The subscriber does not have the necessary subscription for monitoring with the requested Event Type. | +| "UNSUPPORTED_MONITORING_EVENT_TYPE" | The required event type is unsupported. | +| "UNSUPPORTED_MONITORING_REPORT_OPTIONS" | The monitoring configuration for the required event type contains unsupported report options. | +| "UNSPECIFIED" | The failed cause is unspecified. | + +#### 6.4.6.3.13 Enumeration: SubscriptionType + +**Table 6.4.6.3.13-1: Enumeration SubscriptionType** + +| Enumeration value | Description | +|-------------------|-------------------------------| +| "5G" | UE Subscription for 5G | +| "4G_5G" | UE Subscription for 4G and 5G | + +### 6.4.7 Error Handling + +#### 6.4.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.4.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.4.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_EventExposure service. The following application errors listed in Table 6.4.7.3-1 are specific for the Nudm\_EventExposure service. + +**Table 6.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------------------|-------------------------|-------------------------------------------------------------------------------------------------------| +| MONITORING_NOT_ALLOWED | 403 Forbidden | The subscriber does not have the necessary subscription for monitoring with the requested Event Type. | +| AF_NOT_ALLOWED | 403 Forbidden | This AF is not allowed to perform monitoring configuration. | +| MTC_PROVIDER_NOT_ALLOWED | 403 Forbidden | MTC Provider not authorized to perform monitoring configuration. | +| MUTING_EXC_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates the remote NF (e.g. AMF) does not accept the received muting exception instructions. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used when no corresponding context exists. | +| UNSUPPORTED_MONITORING_EVENT_TYPE | 501 Not Implemented | The monitoring configuration contains unsupported event type. | +| UNSUPPORTED_MONITORING_REPORT_OPTIONS | 501 Not Implemented | The monitoring configuration contains unsupported report options. | + +### 6.4.8 Feature Negotiation + +The optional features in table 6.4.8-1 are defined for the Nudm\_EE API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.4.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | PatchReport | If some of the modifications included in the PATCH request are not successfully implemented, the UDM reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [4]. | +| 2 | EneNA | Enhancement of Enablers for Network Automation for 5G
An UDM and an NF that support this feature shall support the enhancement of network data analytics specified in 3GPP TS 23.288 [35]. | +| 3 | DGEM | Dynamic Group-based Event Monitoring
An UDM supporting this feature shall allow the NF consumer to remove list of group member UE(s) from a group-based event monitoring subscription (see clause 5.5.2.5.3) and send Monitoring Revocation Notification triggered by Network initiated explicit event notification subscription cancel procedure (see clause 5.5.2.4.1).
An supporting this feature shall also allow the NF consumer to add list of group member UE(s) into a group-based event monitoring subscription (see clause 5.5.2.5.3).
An NF consumer supporting this feature shall handle the Monitoring Revocation Notification triggered by Network initiated explicit event notification subscription cancel procedure (see clause 5.5.2.4.1). | +| 4 | IERSR | Immediate Event Report in Subscription Creation Response for events detected by another NF
The UDM and the NF consumer (e.g. NEF) supporting this feature shall be able to handle the immediate event reports in the Subscription Creation Response for events with direct reporting by another NF (e.g. AMF, HSS), as specified in clause 5.5.2.2. | +| 5 | ENAPH3 | Enablers for Network Automation for 5G, Phase 3
An UDM supporting this feature shall support the handling of event muting exception instructions as specified in clause 6.2.7.2 of 3GPP TS 23.288 [35]. | + +### 6.4.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nudm\_EE API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nudm\_EE API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudm\_EE service. + +The Nudm\_EE API defines the following scopes for OAuth2 authorization: + +**Table 6.4.9-1: OAuth2 scopes defined in Nudm\_EE API** + +| Scope | Description | +|-------------------------------|-----------------------------------| +| "nudm-ee" | Access to the Nudm_EE API | +| "nudm-ee:subscription:create" | Access to create EE Subscriptions | +| "nudm-ee:subscription:modify" | Access to update EE Subscriptions | + +### 6.4.10 HTTP redirection + +An HTTP request may be redirected to a different UDM service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UDM producer instance will return the NF Instance ID of the new UDM producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UDM redirects a service request to a different UDM using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UDM towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# 6.5 Nudm\_ParameterProvision Service API + +## 6.5.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion} + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot}
+ +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nudm-pp". +- The shall be "v1". +- The shall be set as described in clause 6.5.3. + +## 6.5.2 Usage of HTTP + +### 6.5.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [13], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nudm\_PP service shall comply with the OpenAPI [14] specification contained in Annex A6. + +### 6.5.2.2 HTTP standard headers + +#### 6.5.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.5.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 9457 [16]) signalled by the content type "application/problem+json" + +JSON Merge Patch, as defined in IETF RFC 7396 [17], signalled by the content type "application/merge-patch+json" + +### 6.5.2.3 HTTP custom headers + +##### 6.5.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.5.3 Resources + +#### 6.5.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.5.3.1-1 depicts the resource URIs structure for the Nudm\_PP API. + +![Resource URI structure of the Nudm_PP API diagram](d04c50badc78d5ba47bf4e352af4a754_img.jpg) + +{apiRoot}/nudm-pp/v1 + +``` +graph TD; Root["{apiRoot}/nudm-pp/v1"] --- UeId["/{ueId}"]; Root --- G5gVnGroups["/5g-vn-groups"]; Root --- MbsGroupMembership["/mbs-group-membership"]; UeId --- PpData["/pp-data"]; UeId --- PpDataStore["/pp-data-store"]; PpDataStore --- AfInstanceId["/{afInstanceId}"]; G5gVnGroups --- ExtGroupId1["/{extGroupId}"]; MbsGroupMembership --- ExtGroupId2["/{extGroupId}"]; +``` + +The diagram illustrates the resource URI structure for the Nudm\_PP API. The root path is {apiRoot}/nudm-pp/v1. It branches into three main resource paths: /{ueId}, /5g-vn-groups, and /mbs-group-membership. The /{ueId} path further branches into /pp-data and /pp-data-store. The /pp-data-store path further branches into /{afInstanceId}. The /5g-vn-groups path branches into /{extGroupId}. The /mbs-group-membership path branches into /{extGroupId}. The /pp-data, /pp-data-store, /{afInstanceId}, /{extGroupId} (under /5g-vn-groups), and /{extGroupId} (under /mbs-group-membership) paths are represented by rounded rectangular boxes. The /pp-data-store path is represented by a dashed rounded rectangular box. + +Resource URI structure of the Nudm\_PP API diagram + +**Figure 6.5.3.1-1: Resource URI structure of the Nudm\_PP API** + +Table 6.5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------|--------------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------| +| PpData | /{ueId}/pp-data | PATCH | Modify the UE's modifiable subscription data
Send updated SoR Information for a UE to the UDM | +| 5GVnGroupConfiguration | /5g-vn-groups/{extGroupId} | PUT | Create a 5G VN Group | +| | | DELETE | Delete a 5G VN Group | +| | | PATCH | Modify a 5G VN Group | +| | | GET | Retrieve a 5G VN Group | +| ParameterProvisioningDataEntry | /{ueId}/pp-data-store/{afInstanceId} | PUT | Create or update a Parameter Provisioning Data entry per AF | +| | | DELETE | Delete a Parameter Provisioning Data entry per AF | +| | | GET | Retrieve a Parameter Provisioning Data entry per AF | +| MulticastMbsGroupMemb | /mbs-group-membership/{extGroupId} | PUT | Create a 5G MBS Group | +| | | DELETE | Delete a 5G MBS Group | +| | | PATCH | Delete a 5G MBS Group | +| | | GET | Retrieve a 5G MBS Group | + +#### 6.5.3.2 Resource: PpData + +##### 6.5.3.2.1 Description + +This resource is used to represent Parameter Provisioning Data. + +##### 6.5.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nudm-pp/v1/{ueId}/pp-data + +This resource shall support the resource URI variables defined in table 6.5.3.2.2-1. + +**Table 6.5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.5.1 | +| ueId | string | Represents a single UE or a group of UEs.

- If representing a single UE, this parameter shall contain the Generic Public Subscription Identifier (see 3GPP TS 23.501 [2] clause 5.9.8) or SUPI.
pattern: See pattern of data type VarUeId in 3GPP TS 29.571 [7]

- If representing a group of UEs, this parameter shall contain the External GroupId.
pattern: "extgroupid-[^@]+@[^\@]+\\$" | + +##### 6.5.3.2.3 Resource Standard Methods + +###### 6.5.3.2.3.1 PATCH + +This method shall support the URI query parameters specified in table 6.5.3.2.3.1-1. + +**Table 6.5.3.2.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.5.3.2.3.1-2 and the response data structures and response codes specified in table 6.5.3.2.3.1-3. + +**Table 6.5.3.2.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|--------------------------------------------------------------------------------------------| +| PpData | M | 1 | Contains the data to be provisioned or the updated SoR Information to be conveyed to a UE. | + +**Table 6.5.3.2.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned.
(NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned.

If some modification instructions were not accepted, the "reason" attribute in ReportItem may be used to indicate one of the following application errors:
- CONFIDENCE_LEVEL_NOT_SUFFICIENT
- ACCURACY_LEVEL_NOT_SUFFICIENT

(NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | If the Confidence or Accuracy level contained within the patch request is out of range, the "cause" attribute may be used to indicate one of the following application errors:
- CONFIDENCE_LEVEL_OUT_OF_RANGE
- ACCURACY_LEVEL_OUT_OF_RANGE | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED
- DETACHED_USER
- AF_NOT_ALLOWED
- MTC_PROVIDER_NOT_ALLOWED | + +NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDM shall respond with a 200 OK including PatchResult. + +#### 6.5.3.3 Resource: 5GVnGroupConfiguration + +##### 6.5.3.3.1 Description + +This resource is used to represent 5G VN Group Configuration. + +##### 6.5.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nudm-pp//5g-vn-groups/{extGroupId} + +This resource shall support the resource URI variables defined in table 6.5.3.3.2-1. + +**Table 6.5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|------------|------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.5.1 | +| extGroupId | ExtGroupId | Represents the external Identifier of the 5G VN group
pattern: "^[a-z0-9]{1,20}@[a-z0-9]{1,20}\$" | + +##### 6.5.3.3.3 Resource Standard Methods + +##### 6.5.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 6.5.3.3.3.1-1. + +**Table 6.5.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.5.3.3.3.1-2 and the response data structures and response codes specified in table 6.5.3.3.3.1-3. + +**Table 6.5.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-----------------------------------------------| +| 5GVnGroupConfiguration | M | 1 | Contains the configuration of the 5G VN Group | + +**Table 6.5.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 201
Created | Upon success, an empty response shall be returned. | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- CREATION_NOT_ALLOWED
- AF_NOT_ALLOWED
- MTC_PROVIDER_NOT_ALLOWED | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +##### 6.5.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.5.3.3.3.1-1. + +**Table 6.5.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mtc-provider-info | MtcProviderInformation | O | 0..1 | The mtc-provider-info contains the MTC Provider information that originates 5G-VN-Group deletion, it is used by the UDM to check whether the MTC Provider is allowed to perform this operation for the UE if the MTC provider authorization is required. | +| af-id | string | O | 0..1 | The af-Id contains the AF ID that originates 5G-VN-Group deletion, it is used by the UDM to check whether the AF is allowed to perform this operation for the UE if the AF authorization is required.
It is formatted as described in the definition of type MonitoringConfiguration. | + +This method shall support the request data structures specified in table 6.5.3.3.3.1-2 and the response data structures and response codes specified in table 6.5.3.3.3.1-3. + +**Table 6.5.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.5.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- GROUP_IDENTIFIER NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AF_NOT_ALLOWED
- MTC_PROVIDER_NOT_ALLOWED | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +##### 6.5.3.3.3.3 PATCH + +This method shall support the URI query parameters specified in table 6.5.3.3.3.3-1. + +**Table 6.5.3.3.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.5.3.3.3.3-2 and the response data structures and response codes specified in table 6.5.3.3.3.3-3. + +**Table 6.5.3.3.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------------|---|-------------|---------------------------------------| +| 5GVnGroupConfigurationModification | M | 1 | Contains the modification instruction | + +**Table 6.5.3.3.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- GROUP_IDENTIFIER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED
- AF_NOT_ALLOWED
- MTC_PROVIDER_NOT_ALLOWED | + +NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +###### 6.5.3.3.3.4 GET + +This method shall support the URI query parameters specified in table 6.5.3.3.3.4-1. + +**Table 6.5.3.3.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| N/A | | | | | + +This method shall support the response data structures and response codes specified in table 6.5.3.3.3.4-2. + +**Table 6.5.3.3.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| N/A | | | | + +**Table 6.5.3.3.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------| +| 5GVnGroupConfiguration | | | 200 OK | | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- GROUP_IDENTIFIER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AF_NOT_ALLOWED | + +#### 6.5.3.4 Resource: ParameterProvisioningDataEntry + +##### 6.5.3.4.1 Description + +This resource is used to allow the storage of different Parameter Provisioning entries for different Application Functions. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.5.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nudm-pp/{apiVersion}/{ueId}/pp-data-store/{afInstanceId} + +This resource shall support the resource URI variables defined in table 6.5.3.4.2-1. + +**Table 6.5.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.5.1 | +| ueId | string | Represents the Subscription Identifier SUPI, GPSI, Group Id or anyUE (see 3GPP TS 23.501 [4] clause 5.9.2)
  • - If representing a single UE, this parameter shall contain the GPSI or SUPI.
    pattern: See pattern of type VarUeId 3GPP TS 29.571 [7]
  • - If representing a group of UEs, this parameter shall contain the External GroupId.
    pattern: "^extgroupid-[^@]+@[^\@]+\+\$"
  • - If representing any UE, this parameter shall contain "anyUE".
    pattern: "^anyUE\$"
| +| afInstanceId | string | The string identifying the originating AF. (NOTE) | +| NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE. | | | + +##### 6.5.3.4.3 Resource Standard Methods + +##### 6.5.3.4.3.1 PUT + +This method shall support the URI query parameters specified in table 6.5.3.4.3.1-1. + +**Table 6.5.3.4.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.5.3.4.3.1-2 and the response data structures and response codes specified in table 6.5.3.4.3.1-3. + +**Table 6.5.3.4.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|----------------------------------------------| +| PpDataEntry | M | 1 | Contains a Parameter Provisioning Data entry | + +**Table 6.5.3.4.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PpDataEntry | M | 1 | 201
Created | Indicates a successful creation of the resource. | +| n/a | | | 204 No Content | Indicates a successful update of the resource. An empty response shall be returned. | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
  • - CREATION_NOT_ALLOWED
  • - AF_NOT_ALLOWED
  • - MTC_PROVIDER_NOT_ALLOWED
| +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
  • - USER_NOT_FOUND
| +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +##### 6.5.3.4.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.5.3.4.3.2-1. + +**Table 6.5.3.4.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.5.3.4.3.2-2 and the response data structures and response codes specified in table 6.5.3.4.3.2-3. + +**Table 6.5.3.4.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.5.3.4.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AF_NOT_ALLOWED
- MTC_PROVIDER_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND | + +NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +##### 6.5.3.4.3.3 GET + +This method shall support the URI query parameters specified in table 6.5.3.4.3.3-1. + +**Table 6.5.3.4.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the response data structures and response codes specified in table 6.5.3.4.3.3-3. + +**Table 6.5.3.4.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.5.3.4.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------| +| PpDataEntry | M | 1 | 200 OK | Upon success, the request body contain the target PpDataEntry. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AF_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND | + +#### 6.5.3.5 Resource: MulticastMbsGroupMemb + +##### 6.5.3.5.1 Description + +This resource is used to represent Multicast MBS Group Membership. + +##### 6.5.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nudm-pp//mbs-group-membership/{ExtGroupId} + +This resource shall support the resource URI variables defined in table 6.5.3.5.2-1. + +**Table 6.5.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|------------|----------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.5.1 | +| extGroupId | ExtGroupId | Represents the external Identifier of the 5G MBS group
pattern: "^[a-z0-9]{1,20}\$" | + +##### 6.5.3.5.3 Resource Standard Methods + +##### 6.5.3.5.3.1 PUT + +This method shall support the URI query parameters specified in table 6.5.3.5.3.1-1. + +**Table 6.5.3.5.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.5.3.5.3.1-2 and the response data structures and response codes specified in table 6.5.3.5.3.1-3. + +**Table 6.5.3.5.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|---------------------------| +| MulticastMbsGroupMemb | M | 1 | Contains the 5G MBS Group | + +**Table 6.5.3.5.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 201
Created | Upon success, an empty response shall be returned. | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- CREATION_NOT_ALLOWED
- AF_NOT_ALLOWED | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +##### 6.5.3.5.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.5.3.5.3.1-1. + +**Table 6.5.3.5.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| af-id | string | O | 0..1 | The af-Id contains the AF ID that originates 5G-MBS-Group deletion, it is used by the UDM to check whether the AF is allowed to perform this operation for the UE if the AF authorization is required.
It is formatted as described in the definition of type MonitoringConfiguration. | + +This method shall support the request data structures specified in table 6.5.3.5.3.1-2 and the response data structures and response codes specified in table 6.5.3.5.3.1-3. + +**Table 6.5.3.5.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.5.3.5.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- GROUP_IDENTIFIER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AF_NOT_ALLOWED | + +NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +##### 6.5.3.5.3.3 PATCH + +This method shall support the URI query parameters specified in table 6.5.3.5.3.3-1. + +**Table 6.5.3.5.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.5.3.5.3.3-2 and the response data structures and response codes specified in table 6.5.3.5.3.3-3. + +**Table 6.5.3.5.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|---------------------------------------| +| MulticastMbsGroupMemb | M | 1 | Contains the modification instruction | + +**Table 6.5.3.5.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- GROUP_IDENTIFIER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED
- AF_NOT_ALLOWED | + +NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDM shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +##### 6.5.3.5.3.4 GET + +This method shall support the URI query parameters specified in table 6.5.3.5.3.4-1. + +**Table 6.5.3.5.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| N/A | | | | | + +This method shall support the response data structures and response codes specified in table 6.5.3.5.3.4-2. + +**Table 6.5.3.5.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| N/A | | | | + +**Table 6.5.3.5.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------| +| MulticastMbsGroupMemb | | | 200 OK | | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- GROUP_IDENTIFIER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- AF_NOT_ALLOWED | + +### 6.5.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nudm\_ParameterProvision Service. + +### 6.5.5 Notifications + +In this release of this specification, no notifications are defined for the Nudm\_ParameterProvision Service. + +### 6.5.6 Data Model + +#### 6.5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.5.6.1-1 specifies the data types defined for the Nudm\_PP service API. + +**Table 6.5.6.1-1: Nudm\_PP specific Data Types** + +| Data type | Clause defined | Description | +|------------------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| PpData | 6.5.6.2.2 | Parameter Provision Data | +| CommunicationCharacteristics | 6.5.6.2.3 | Communication Characteristics | +| PpSubsRegTimer | 6.5.6.2.4 | | +| PpActiveTime | 6.5.6.2.5 | | +| 5GVnGroupConfiguration | 6.5.6.2.6 | | +| 5GVnGroupData | 6.5.6.2.7 | | +| ExpectedUeBehaviour | 6.5.6.2.8 | Expected UE Behaviour Parameters | +| LocationArea | 6.5.6.2.10 | Location Area | +| NetworkAreaInfo | 6.5.6.2.11 | Network Area Information | +| EcRestriction | 6.5.6.2.12 | | +| PlmnEcInfo | 6.5.6.2.13 | | +| PpDIPacketCountExt | 6.5.6.2.14 | | +| PpMaximumResponseTime | 6.5.6.2.15 | | +| PpMaximumLatency | 6.5.6.2.16 | | +| LcsPrivacy | 6.5.6.2.17 | | +| UmtTime | 6.5.6.2.18 | | +| PpDataEntry | 6.5.6.2.19 | Provisioning Parameter Data Entry | +| CommunicationCharacteristicsAF | 6.5.6.2.20 | Communication Characteristics per AF | +| EcsAddrConfigInfo | 6.5.6.2.21 | ECS Address Configuration Information | +| 5MbsAuthorizationInfo | 6.5.6.2.22 | 5MBS Session Authorization Information | +| MulticastMbsGroupMemb | 6.5.6.2.23 | Multicast MBS group membership management | +| DnnSnssaiSpecificGroup | 6.5.6.2.24 | DNN and S-NSSAI specific Group | +| AfReqDefaultQoS | 6.5.6.2.25 | AF-requested default QoS | +| ExpectedUeBehaviourExtension | 6.5.6.2.26 | Expected UE Behaviour Parameters | +| MbsAssistanceInfo | 6.5.6.2.27 | MBS Assistance Information | +| AppSpecificExpectedUeBehaviour | 6.5.6.2.28 | Application Specific Expected UE Behaviour Data | +| MaxGroupDataRate | 6.5.6.2.29 | Maximum data rate for a 5G VN Group (uplink and downlink) | +| 5GVnGroupConfigurationModification | 6.5.6.2.30 | Contains the attributes to modify on the 5GVnGroupConfiguration data structure; the attributes to be deleted need to be set to the null value. | +| 5GVnGroupDataModification | 6.5.6.2.31 | Contains the attributes to modify on the 5GVnGroupData data structure; the attributes to be deleted need to be set to the null value. | +| PpDIPacketCount | 6.5.6.3.2 | | + +Table 6.5.6.1-2 specifies data types re-used by the Nudm\_PP service API from other APIs, including a reference and when needed, a short description of their use within the Nudm\_PP service API. + +**Table 6.5.6.1-2: Nudm\_PP re-used Data Types** + +| Data type | Reference | Comments | +|------------------------------------|---------------------|------------------------------------------------------------------------------| +| DurationSec | 3GPP TS 29.571 [7] | Time value in seconds | +| DurationSecRm | 3GPP TS 29.571 [7] | Time value in seconds; nullable | +| SupportedFeatures | 3GPP TS 29.571 [7] | | +| NfInstanceId | 3GPP TS 29.571 [7] | | +| ProblemDetails | 3GPP TS 29.571 [7] | | +| Gpsi | 3GPP TS 29.571 [7] | | +| PatchResult | 3GPP TS 29.571 [7] | | +| DateTime | 3GPP TS 29.571 [7] | | +| Ecgi | 3GPP TS 29.571 [7] | an EUTRA cell identifier | +| Ncgi | 3GPP TS 29.571 [7] | an NR cell identifier | +| GlobalRanNodeId | 3GPP TS 29.571 [7] | an identity of the NG-RAN node | +| Tai | 3GPP TS 29.571 [7] | a tracking area identity | +| GeographicArea | 3GPP TS 29.572 [34] | Identifies the geographical information of the user(s). | +| CivicAddress | 3GPP TS 29.572 [34] | Identifies the civic address information of the user(s). | +| PduSessionType | 3GPP TS 29.571 [7] | | +| AcsInfoRm | 3GPP TS 29.571 [7] | | +| StnSrRm | 3GPP TS 29.571 [7] | Session Transfer Number for SRVCC | +| Supi | 3GPP TS 29.571 [7] | | +| MtcProviderInformation | 3GPP TS 29.571 [7] | MTC Provider Information | +| StationaryIndicationRm | 3GPP TS 29.571 [7] | | +| ScheduledCommunicationTimeRm | 3GPP TS 29.571 [7] | | +| ScheduledCommunicationTypeRm | 3GPP TS 29.571 [7] | | +| TrafficProfileRm | 3GPP TS 29.571 [7] | | +| BatteryIndicationRm | 3GPP TS 29.571 [7] | | +| EcsServerAddr | 3GPP TS 29.571 [7] | | +| Fqdn | 3GPP TS 29.571 [7] | Fully Qualified Domain Name | +| SpatialValidityCond | 3GPP TS 29.571 [7] | | +| MbsSessionId | 3GPP TS 29.571 [7] | 5MBS Session Identifier | +| GroupId | 3GPP TS 29.571 [7] | | +| 5Qi | 3GPP TS 29.571 [7] | | +| Arp | 3GPP TS 29.571 [7] | | +| 5QIPriorityLevel | 3GPP TS 29.571 [7] | | +| BitRate | 3GPP TS 29.571 [7] | | +| SliceUsageControlInfo | 3GPP TS 29.571 [7] | | +| AppDescriptor | 6.1.6.2.40 | | +| Lpi | 6.1.6.2.43 | | +| ExpectedUeBehaviourData | 6.1.6.2.49 | Expected UE Behaviour Parameters | +| AppSpecificExpectedUeBehaviourData | 6.1.6.2.99 | Application Specific Expected UE Behaviour Parameters | +| AreaUsageInd | 6.1.6.3.24 | Area Usage Indication | +| ReferenceId | 6.4.6.3.2 | Reference ID defined in Nudm_EE API. It shall contain a 64-bit long integer. | +| UpUpLocRepIndAf | 6.1.6.3.30 | Indication of location reporting via user plane to an LCS client or AF | + +#### 6.5.6.2 Structured data types + +##### 6.5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.5.6.2.2 Type: PpData + +Table 6.5.6.2.2-1: Definition of type PpData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| supportedFeatures | SupportedFeatures | O | 0..1 | | | +| communicationCharacteristics | CommunicationCharacteristics | O | 0..1 | communication characteristics | | +| expectedUeBehaviour | ExpectedUeBehaviour | O | 0..1 | Expected UE Behaviour Parameters.

This IE, if present, shall be ignored if the expectedUeBehaviourExtension attribute is present in ppData. | | +| expectedUeBehaviourExtension | ExpectedUeBehaviourExtension | O | 0..1 | Expected UE Behaviour data, optionally with corresponding confidence level and/or accuracy levels. | ExpectedBehaviourMap | +| ecRestriction | EcRestriction | O | 0..1 | Enhanced Coverage Restriction Parameters | | +| acsInfo | AcsInfoRm | O | 0..1 | Identifies the ACS Information (see TS 23.316 [37] clause 9.6.3); nullable. | | +| stnSr | StnSrRm | O | 0..1 | Session Transfer Number for SRVCC | | +| lcsPrivacy | LcsPrivacy | O | 0..1 | LCS Privacy Parameters (see clause 5.4.3 of 3GPP TS 23.273 [38]) | | +| sorInfo | SorInfo | O | 0..1 | Steering of Roaming information to be conveyed to a UE
See NOTE o1 and NOTE o2 . | | +| 5mbsAuthorizationInfo | 5MbsAuthorizationInfo | O | 0..1 | When present, this IE shall include the 5MBS Session Authorization Information as specified in 3GPP TS 23.247 [59] | | +| dnnSnssaiSpecificGroup | DnnSnssaiSpecificGroup | O | 0..1 | This attribute is applicable only if the {ueId} within the resource URI takes the value of an external group ID.
When present, this IE shall include DNN and S-NSSAI specific Group Parameters (See clause 4.15.6.3e of TS 23.502 [31]) | | +| mbsAssistanceInfo | MbsAssistanceInfo | O | 0..1 | When present, this IE contains the MBS Session Assistance Information for a MBS session. (NOTE 3) | | +| appSpecificExpectedUeBehaviour | AppSpecificExpectedUeBehaviour | O | 0..1 | Application specific expected UE Behaviour Parameters | | +| sliceUsageControlInfos | array(SliceUsageControlInfo) | O | 1..N | Network Slice usage behaviour control Information | | +| NOTE o1 : If the UDM is not able to immediately (after conducting integrity protection with the AUSF) convey the received Steering of Roaming information to the concerned UE for any reason (e.g. no AMF registered for the UE), it shall discard it. | | | | | | +| NOTE o2 : The behaviour of the UDM at reception of Steering of Roaming information within PpData is specified in Annex C.3 of 3GPP TS o23.122 [20]. | | | | | | +| NOTE 3: Before the mbsAssistanceInfo for a MBS session can be provisioned using the external group id, an external group shall be selected by the AF/NEF. | | | | | | + +Editor's note: It is FFS how to handle Expected UE behaviour Parameters for multiple AFs, pending stage-2 clarification. + +Editor's note: it is FFS whether the dnnSnssaiSpecificGroup parameter applies as well to individual UEs (i.e. not only to group of UEs); if this is confirmed, the attribute name could be changed in the future. + +##### 6.5.6.2.3 Type: CommunicationCharacteristics + +**Table 6.5.6.2.3-1: Definition of type CommunicationCharacteristics** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ppSubsRegTimer | PpSubsRegTimer | O | 0..1 | AF provisionedSubscribed periodic registration timer; nullable (NOTE 2) | +| ppActiveTime | PpActiveTime | O | 0..1 | AF provisioned active time; nullable (NOTE 2) | +| ppDIPacketCount | PpDIPacketCount | O | 0..1 | AF provisioned DL Buffering Suggested Packet Count; nullable | +| ppDIPacketCountExt | PpDIPacketCountExt | C | 0..1 | AF provisioned DL Buffering Suggested Packet Count Extension; nullable.
Shall be absent if ppDIPacketCount is absent, and shall be null if ppDIPacketCount is null. | +| ppMaximumResponseTi
me | PpMaximumResp
onseTime | O | 0..1 | AF provisioned Maximum Response Time; nullable | +| ppMaximumLatency | PpMaximumLate
ncy | O | 0..1 | AF provisioned Maximum Latency; nullable | + +NOTE 1: If ppDIPacketCountExt is absent and ppDIPacketCount (whether the value is null or not) is present in a modification request, it shall result in deletion of ppDIPacketCountExt. +NOTE 2: These IEs are deprecated. An NF service consumer (i.e. AF) supporting this release shall use ppMaximumResponseTime IE to influence the Subscribed Active Time of the UE; use ppMaximumLatency IE to influence the Subscribed Periodic Registration Timer of the UE. + +##### 6.5.6.2.4 Type: PpSubsRegTimer + +**Table 6.5.6.2.4-1: Definition of type PpSubsRegTimer** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subsRegTimer | DurationSec | M | 1 | value in seconds | +| afInstanceId | string | M | 1 | The string identifying the originating AF (NOTE) | +| referenceId | ReferenceId | M | 1 | Transaction Reference ID | +| validityTime | DateTime | O | 0..1 | Identifies the point of time up to which the subsRegTimer parameter expires and it shall be deleted. If absent, it indicates that there is no expiration time for these expected UE parameters.
If this IE is in request body, it indicates the expected validity time by consumer.
If this IE is in response body, it indicates the confirmed validity time by UDM. | +| mtcProviderInformation | MtcProviderInfor
mation | O | 0..1 | Indicates MTC provider information for Parameter Provisioning authorization. | + +NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE. + +##### 6.5.6.2.5 Type: PpActiveTime + +Table 6.5.6.2.5-1: Definition of type PpActiveTime + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| activeTime | DurationSec | M | 1 | value in seconds | +| aflnstanceId | string | M | 1 | The string identifying the originating AF (NOTE). | +| referenceId | ReferenceId | M | 1 | Transaction Reference ID | +| validityTime | DateTime | O | 0..1 | Identifies the point of time up to which the activeTime parameter expires and it shall be deleted. If absent, it indicates that there is no expiration time for these expected UE parameters. If this IE is in request body, it indicates the expected validity time by consumer. If this IE is in response body, it indicates the confirmed validity time by UDM. | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for Parameter Provisioning authorization. | + +NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {aflId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE. + +##### 6.5.6.2.6 Type: 5GVnGroupConfiguration + +Table 6.5.6.2.6-1: Definition of type 5GVnGroupConfiguration + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| 5gVnGroupData | 5GVnGroupData | C | 0..1 | Data of the 5G VN Group; it shall be present in creation requests. (NOTE 2) | | +| members | array(Gpsi) | C | 1..N | List of group members; it shall be present in creation requests.

This IE, if present, shall be ignored if attribute "membersData" is present in 5GVnGroupConfiguration. | | +| referenceId | ReferenceId | C | 1 | Transaction Reference ID; ; it shall be present in creation requests. | | +| aflnstanceId | string | C | 1 | The string identifying the originating AF. (NOTE 1) | | +| internalGroupId | GroupId | C | 0..1 | The internalGroupId is allocated by the UDM and hence shall be absent on Nudm. On Nudr it shall be present in PUT requests, successful PUT responses and GET responses.

The internalGroupId shall be unique within the PLMN. If the UDR detects that the value received in a PUT request already exists, it shall deny creation of the 5GVnGroup and return "403 Forbidden" with application error "INTERNAL_GROUP_ID_NOT_UNIQUE" to the UDM. | | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for 5G VN Group Configuration authorization. | | +| membersData | map(GpsiInfo) | C | 1..N | Represents the list of 5G VN Group members, each member is identified by GPSI. A map (list of key-value pairs where Gpsi serves as key) of GpsiInfo. The value in each entry of the map shall be an empty JSON object. | MembersData | + +NOTE 1: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {aflId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE. + +NOTE 2: When the 5G VN Group is used for PIN, the 5GVnGroupData shall contain information for the PIN. + +###### EXAMPLE: + +The following example shows the creation of a 5G VN group (whose External Group ID is "newgroup@operator.com"), containing a list of members in the "membersData" attribute; note that the key of the membersData object/map is the GPSI (MSISDNs of a PLMN with CC=88 and NDC=017, in this example), and the value of the key is an empty JSON object: + +``` +PUT .../nudm-pp/v1/5g-vn-groups/extgroupid-newgroup@operator.com +Content-Type: application/json + +{ + "5gVnGroupData": { + "dnn": "5gvn.operator.com", + "sNssai": { "sst": 1, "sd": "0012ab" } + }, + "referenceId": 123847298, + "afInstanceId": "AF-1", + "membersData": { + "msisdn-8801724847575": {}, + "msisdn-8801724847576": {}, + "msisdn-8801724847577": {} + } +} +``` + +Then, a modification of the list of members, to add a new member (SN="24847578"), and to delete one of the existing members (SN="24847576"), would be as follows: + +``` +PATCH .../nudm-pp/v1/5g-vn-groups/extgroupid-newgroup@operator.com +Content-Type: application/merge-patch+json + +{ + "membersData": { + "msisdn-8801724847578": {}, + "msisdn-8801724847576": null + } +} +``` + +##### 6.5.6.2.7 Type: 5GVnGroupData + +**Table 6.5.6.2.7-1: Definition of type 5GVnGroupData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | DNN of the 5G VN group, shall contain the Network Identifier only. | +| sNssai | Snssai | M | 1 | S-NSSAI of the 5G VN group's communication session | +| pduSessionTypes | array(PduSessionType) | O | 1..N | List of PDU Session Types allowed for 5G VN group's communication session | +| appDescriptors | array(AppDescriptor) | O | 1..N | List of Application Descriptors allowed for 5G VN group's communication session | +| secondaryAuth | boolean | O | 0..1 | Indicates whether secondary authentication and authorization is needed.
true: secondary authentication and authorization is needed.
false: secondary authentication and authorization is not needed.
If absent, it indicates that secondary authentication is not required by the NEF, but it still may be required by local policies at the SMF. | +| dnAaaIpAddressAllocation | boolean | O | 0..1 | Indicates whether the SMF is required to request the UE IP address from the DN-AAA server for PDU Session Establishment.
true: required
false: not required
If absent, it indicates that the request by SMF of the UE IP address from the DN-AAA server is not required, but it still may be required by local policies at the SMF. | +| dnAaaAddress | IpAddress | O | 0..1 | The IP address of the DN-AAA server, used for secondary authentication and authorization. | +| additionalDnAaaAddresses | array(IpAddress) | O | 1..N | Additional IP addresses of the DN-AAA server used for secondary authentication and authorization. | +| dnAaaFqdn | Fqdn | O | 0..1 | The FQDN of the DN-AAA server used for secondary authentication and authorization. | +| 5gVnGroupCommunicationInd | boolean | O | 0..1 | When present, this IE shall indicate whether 5G VN group is associated with 5G VN group communication:
- true: 5G VN group is associated with 5G VN group communication
- false: 5G VN group is not associated with 5G VN group communication. | +| maxGroupDataRate | MaxGroupDataRate | O | 0..1 | The limits of the total bit rate across all sessions of the 5G VN group (uplink and downlink). | + +##### 6.5.6.2.8 Type: ExpectedUeBehaviour + +Table 6.5.6.2.8-1: Definition of type ExpectedUeBehaviour + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------|------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aflInstanceId | string | M | 1 | The string identifying the originating AF (NOTE 5) | +| referenceId | ReferenceId | M | 1 | Identifies transaction reference ID generated by NEF. | +| stationaryIndication | StationaryIndicationRm | O | 0..1 | Identifies whether the UE is stationary or mobile (see TS 23.502 [3] clause 4.15.6.3); nullable. | +| communicationDurationTime | DurationSecRm | O | 0..1 | Indicates for how long the UE will normally stay in CM-Connected for data transmission (see TS 23.502 [3] clause 4.15.6.3); nullable. | +| periodicTime | DurationSecRm | O | 0..1 | Identifies interval time of periodic communication (see TS 23.502 [3] clause 4.15.6.3); nullable. | +| scheduledCommunicationTime | ScheduledCommunicationTimeRm | O | 0..1 | Identifies time and day of the week when the UE is available for communication (see TS 23.502 [3] clause 4.15.6.3); nullable. | +| scheduledCommunicationType | ScheduledCommunicationTypeRm | O | 0..1 | Indicates that the Scheduled Communication Type (see TS 23.502 [3] clause 4.15.6.3); nullable. (NOTE 4) | +| expectedUmts | array(LocationArea) | O | 1..N | Identifies the UE's expected geographical movement. The attribute is only applicable in 5G (see TS 23.502 [3] clause 4.15.6.3); nullable. (NOTE 3) | +| trafficProfile | TrafficProfileRm | O | 0..1 | Identifies the type of data transmission: single packet transmission (UL or DL), dual packet transmission (UL with subsequent DL or DL with subsequent UL), multiple packets transmission; nullable | +| batteryIndication | BatteryIndicationRm | O | 0..1 | Indicates the power consumption type(s) of the UE (see TS 23.502 [3] clause 4.15.6.3); nullable. | +| validityTime | DateTime | O | 0..1 | If present, identifies when the expected UE behaviour parameters expire and shall be deleted locally if it expires (see TS 23.502 [3] clause 4.15.6.3).
If this IE is in request body, it indicates the expected validity time by consumer.
If this IE is in response body, it indicates the confirmed validity time by UDM. (NOTE 2) | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for UE Parameter Configuration authorization. | + +NOTE 1: At least one of optional parameters (except for validityTime) above shall be present. + +NOTE 2: If this attribute is omitted, no expiry for the expected UE behaviour parameters applies. + +NOTE 3: The first instance of the attribute represents the start of the location, and the last one represents the stop of the location. + +NOTE 4: The parameter "scheduledCommunicationType" shall be used together with the parameter "scheduledCommunicationTime". + +NOTE 5: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE. + +##### 6.5.6.2.9 Void + +##### 6.5.6.2.10 Type: LocationArea + +**Table 6.5.6.2.10-1: Definition of type LocationArea** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| geographicAreas | array(Geographic Area) | O | 0..N | Identifies a list of geographic area of the user where the UE is located. | +| civicAddresses | array(CivicAddresses) | O | 0..N | Identifies a list of civic addresses of the user where the UE is located. | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | This IE represents the network area information of the user where the UE is located. | +| umtTime | UmtTime | O | 0..1 | This IE identifies the time when the UE is expected to arrive at the location.
May be present when LocationArea is part of the UE's expected geographical movement. | + +##### 6.5.6.2.11 Type: NetworkAreaInfo + +**Table 6.5.6.2.11-1: Definition of type NetworkAreaInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------| +| ecgis | array(Ecgi) | O | 0..N | This IE contains a list of E-UTRA cell identities. | +| ncgis | array(Ncgi) | O | 0..N | This IE contains a list of NR cell identities. | +| gRanNodeIds | array(GlobalRan NodeId) | O | 0..N | This IE contains a list of the NG-RAN nodes.
The "n3IwflId" attribute within the "GlobalRanNodeId" data type shall not be supplied. | +| tais | array(Tai) | O | 0..N | This IE contains a list of tracking area identities. | + +NOTE: The NetworkAreaInfo data type allows any combination of defined properties. + +##### 6.5.6.2.12 Type: EcRestriction + +**Table 6.5.6.2.12-1: Definition of type EcRestriction** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aflInstanceId | string | M | 1 | The string identifying the originating AF (NOTE) | +| referenceId | ReferenceId | M | 1 | Transaction Reference ID | +| plmnEcInfos | array(PlmnEcInfo) | O | 1..N | It may indicate a complete list of serving PLMNs where Enhanced Coverage shall be allowed and the detailed enhanced coverage restriction configuration under per the PLMN. | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for UE Parameter Configuration authorization. | + +NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in scsAsId attribute in ECRControl structured data type (see clause 5.12.2.1.2 of 3GPP TS 29.122 [45]) can be used as the value for this IE. If the scsAsId value is not received in T8, the aflInstanceId attribute shall contain an empty string value (""). + +##### 6.5.6.2.13 Type: PlmnEcInfo + +Table 6.5.6.2.13-1: Definition of type PlmnEcInfo + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| plmnId | PlmnId | M | 1 | Indicates PLMN where Enhanced Coverage shall be restricted. | +| ecRestrictionDataWb | EcRestrictionDataWb | O | 0..1 | If present, it shall contain Enhanced Coverage Restriction Data for WB-N1 mode .
If absent, it shall indicate that Enhanced Coverage is not restricted for WB-N1 mode . | +| ecRestrictionDataNb | boolean | O | 0..1 | If present, this IE shall indicate whether Enhanced Coverage for NB-N1 mode is restricted or not.

true: Enhanced Coverage for NB-N1 mode is restricted.
false or absent: Enhanced Coverage for NB-N1 mode is allowed. | + +NOTE: At least one of the properties "ecRestrictionDataWb" and "ecRestrictionDataNb" shall be included. + +##### 6.5.6.2.14 Type: PpDIPacketCountExt + +Table 6.5.6.2.14-1: Definition of type PpDIPacketCountExt + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| afInstanceId | string | M | 1 | The string identifying the originating AF (NOTE) | +| referenceId | ReferenceId | M | 1 | Transaction Reference ID | +| dnn | Dnn | O | 0..1 | When present, it indicates the DNN for which the ppDIPacketCount is applicable. | +| singleNssai | Snsai | O | 0..1 | When present, it indicates the slice for which the ppDIPacketCount is applicable. | +| validityTime | DateTime | O | 0..1 | Identifies the point of time up to which the value of parameter ppDIPacketCount expires and it shall be deleted. If absent, it indicates that there is no expiration time for these expected UE parameters.
If this IE is in request body, it indicates the expected validity time by consumer.
If this IE is in response body, it indicates the confirmed validity time by UDM. | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for Parameter Provisioning authorization. | + +NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE. + +##### 6.5.6.2.15 Type: PpMaximumResponseTime + +Table 6.5.6.2.15-1: Definition of type PpMaximumResponseTime + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| maximumResponseTime | DurationSec | M | 1 | This IE shall contain value of Maximum Response Time in seconds.
Maximum Response Time identifies the time for which the UE stays reachable to allow the AF to reliably deliver the required downlink data, see clause 4.15.6.3a of 3GPP TS 23.502 [3]. | +| aflInstanceId | string | M | 1 | The string identifying the originating AF (NOTE) | +| referenceId | ReferenceId | M | 1 | Transaction Reference ID | +| validityTime | DateTime | O | 0..1 | Identifies the point of time up to which the value of maximumResponseTime expires and it shall be deleted. If absent, it indicates that there is no expiration time.
If this IE is in request body, it indicates the expected validity time by consumer.
If this IE is in response body, it indicates the confirmed validity time by UDM. | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for Parameter Provisioning authorization. | + +NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {aflId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE. + +##### 6.5.6.2.16 Type: PpMaximumLatency + +Table 6.5.6.2.16-1: Definition of type PpMaximumLatency + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| maximumLatency | DurationSec | M | 1 | This IE shall contain value of Maximum Latency in seconds.
Maximum Latency identifies maximum delay acceptable for downlink data transfers, see clause 4.15.6.3a of 3GPP TS 23.502 [3]. | +| aflInstanceId | string | M | 1 | The string identifying the originating AF (NOTE). | +| referenceId | ReferenceId | M | 1 | Transaction Reference ID | +| validityTime | DateTime | O | 0..1 | Identifies the point of time up to which the value of maximumLatency expires and it shall be deleted. If absent, it indicates that there is no expiration time.
If this IE is in request body, it indicates the expected validity time by consumer.
If this IE is in response body, it indicates the confirmed validity time by UDM. | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for Parameter Provisioning authorization. | + +NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {aflId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE. + +##### 6.5.6.2.17 Type: LcsPrivacy + +Table 6.5.6.2.17-1: Definition of type LcsPrivacy + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| afInstanceId | string | C | 0..1 | When present, indicates NF Instance Id of the originating AF/NF.
(NOTE) | +| referenceId | ReferenceId | C | 0..1 | This IE shall be present if LCS privacy parameters are provisioned by an AF.

When present, indicates Transaction Reference ID
(NOTE) | +| lpi | Lpi | O | 0..1 | If present, indicates the Location Privacy Indication | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for LCS privacy parameter configuration authorization. | +| evtRptExpectedArea | GeographicArea | O | 0..1 | Indicates the event report expected area. | +| areaUsageInd | AreaUsageInd | O | 0..1 | This IE may be present when event report expected area is present.

When present, this IE shall indicate one of the following mutually exclusive global settings on using event report expected area:
- Inside reporting (default)
- Outside reporting
(see 3GPP TS 23.273 [38] clause 5.14). | +| upLocRepIndAf | UpLocRepIndAf | O | 0..1 | If present, this IE shall indicate one of the following mutually exclusive global settings:
- UE is allowed to report periodic or triggered location events via user plane to an LCS Client or AF
- UE is not allowed to report periodic or triggered location events via user plane to an LCS Client or AF (default) | + +NOTE: If LCS privacy parameters are provisioned by UE, parameters afInstanceId and referenceId shall be not included, and if LCS privacy parameters are provisioned by AF, parameters afInstanceId and referenceId shall be included. The string identifying the originating AF, which is carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {afId} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]). + +##### 6.5.6.2.18 Type: UmtTime + +Table 6.5.6.2.18-1: Definition of type UmtTime + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------| +| timeOfDay | TimeOfDay | M | 1 | see 3GPP TS 29.571 [7] | +| dayOfWeek | DayOfWeek | M | 1 | see 3GPP TS 29.571 [7] | + +##### 6.5.6.2.19 Type: PpDataEntry + +Table 6.5.6.2.19-1: Definition of type PpDataEntry + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| communicationCharacteristics | CommunicationCharacteristicsAF | O | 0..1 | Communication characteristics for the AF | +| referenceId | ReferenceId | M | 1 | Transaction Reference ID | +| validityTime | DateTime | O | 0..1 |

When present, this IE shall identify the point of time up to which the provisioned parameters will be expire and shall be deleted. If absent, it indicates that there is no expiration time for the provisioned parameters.

If this IE is in request body, it indicates the expected validity time by consumer.

If this IE is in response body, it indicates the confirmed validity time by UDM.

| +| mtoProviderInformation | MtcProviderInformation | O | 0..1 | When present, this IE shall indicate the MTC provider information for Parameter Provisioning authorization. | +| supportedFeatures | SupportedFeatures | O | 0..1 | Supported Features | +| ecsAddrConfigInfo | EcsAddrConfigInfo | O | 0..1 | ECS Address ConfigurationInformation Parameters; see 3GPP TS 23.502 [3] | +| additionalEcsAddrConfigInfos | array(EcsAddrConfigInfo) | O | 1..N | Additional ECS Address Configuration Information Parameters. See 3GPP TS 23.548 [60] | +| ecsAddrConfigInfoPerPlmn | map(array(EcsAddrConfigInfo)) | O | 1..N | A map of ECS Address ConfigurationInformation Parameters per serving PLMNs, where the key of the map is the serving PLMN id and the value is an array of EcsAddrConfigInfo for that serving PLMN. | +| ecRestriction | EcRestriction | O | 0..1 | Enhanced Coverage Restriction Parameters | +| sliceUsageControlInfos | array(SliceUsageControlInfo) | O | 1..N | Network Slice usage behaviour control Information | + +##### 6.5.6.2.20 Type: CommunicationCharacteristicsAF + +**Table 6.5.6.2.20-1: Definition of type CommunicationCharacteristicsAF** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ppDIPacketCount | PpDIPacketCount | O | 0..1 | AF provisioned DL Buffering Suggested Packet Count; nullable | +| maximumResponseTime | DurationSec | O | 0..1 | When present, this IE shall contain value of Maximum Response Time in seconds.

Maximum Response Time identifies the time for which the UE stays reachable to allow the AF to reliably deliver the required downlink data, see clause 4.15.6.3a of 3GPP TS 23.502 [3]. | +| maximumLatency | DurationSec | O | 0..1 | When present, this IE shall contain value of Maximum Latency in seconds.

Maximum Latency identifies maximum delay acceptable for downlink data transfers, see clause 4.15.6.3a of 3GPP TS 23.502 [3]. | + +##### 6.5.6.2.21 Type: EcsAddrConfigInfo + +**Table 6.5.6.2.21-1: Definition of type EcsAddrConfigInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------| +| ecsServerAddr | EcsServerAddr | O | 0..1 | This IE shall include address information of the Edge Configuration Server(s). | +| spatialValidityCond | SpatialValidityCond | O | 0..1 | When present, this IE shall include the Spatial Validity Condition as defined in clause 4.15.6.3d of 3GPP TS 23.502 [3] | + +NOTE: When the UDR receives ECS Address Configuration Information from the UDM for a group of UEs (or anyUE), it may need to modify the shared ECS Address Configuration Information shared by members of the group (or by any UE). + +##### 6.5.6.2.22 Type: 5MbsAuthorizationInfo + +**Table 6.5.6.2.22-1: Definition of type 5MbsAuthorizationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------------|---|-------------|----------------------------------------| +| 5mbsSessionIds | array(MbsSessionId) | M | 1..N | 5MBS Session Identifiers (TMGI or SSM) | + +##### 6.5.6.2.23 Type: MulticastMbsGroupMemb + +**Table 6.5.6.2.23-1: Definition of type MulticastMbsGroupMemb** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| multicastGroupMemb | array(Gpsi) | M | 1..N | When present, this IE shall indicate a list of multicast group members, each member is identified by GPSI. | +| afInstanceId | string | C | 1 | The string identifying the originating AF | +| internalGroupId | GroupId | C | 0..1 | Shall be present in successful PUT requests and GET responses on Nudr; otherwise shall be absent. | + +##### 6.5.6.2.24 Type: DnnSnssaiSpecificGroup + +Table 6.5.6.2.24-1: Definition of type DnnSnssaiSpecificGroup + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Represents the concerned DNN. | +| snssai | Snssai | M | 1 | Represents the concerned S-NSSAI. | +| defQos | AfReqDefaultQoS | C | 0..1 | Represents the AF-requested default QoS parameters applicable to each UE within the targeted group. | +| afReqServArea | array(Tai) | C | 1..N | Represents the AF-requested Service Area applicable to each UE within the group. | + +##### 6.5.6.2.25 Type: AfReqDefaultQoS + +Table 6.5.6.2.25-1: Definition of type AfReqDefaultQoS + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|------------------------------------------------------------------------| +| 5qi | 5Qi | M | 1 | Represents the AF requested default 5G QoS Identifier. | +| arp | Arp | M | 1 | Represents the AF requested default Allocation and Retention Priority. | +| priorityLevel | 5QIPriorityLevel | O | 0..1 | Represents the AF requested 5QI Priority Level. | + +##### 6.5.6.2.26 Type: ExpectedUeBehaviourExtension + +Table 6.5.6.2.26-1: Definition of type ExpectedUeBehaviourExtension + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| afInstanceId | string | M | 1 | The string identifying the originating AF.
(NOTE 1) | +| referenceId | ReferenceId | M | 1 | Identifies transaction reference ID generated by NEF. | +| expectedUeBehaviourData | map(ExpectedUeBehaviourData) | C | 1..N | A map of expected UE Behaviour data parameters. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters.

Each attribute in the ExpectedUeBehaviourData shall only be present in one entry of the map.
(NOTE 2) | +| mtcProviderInformation | MtcProviderInformation | C | 0..1 | Indicates MTC provider information for UE Parameter Configuration authorization.
(NOTE 2) | + +NOTE 1: When the service operation is originated by external AF on the T8/N33 interfaces, the information carried in the {scsAsId} URI variable on the T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in the {afId} URI variable on the N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE. + +NOTE 2: At least one of these attributes shall be present. + +##### 6.5.6.2.27 Type: MbsAssistanceInfo + +**Table 6.5.6.2.27-1: Definition of type MbsAssistanceInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | The IE shall contain the MBS session id of the MBS session for which the MBS Session Assistance Information is applicable. | +| assistanceInfo | array(Gpsi) | C | 1..N | The IE shall be present to contain a list of UEs eligible for MBS Session assistance for the MBS session except for the case when all UEs in the external group are eligible for MBS Session assistance. | + +##### 6.5.6.2.28 Type: AppSpecificExpectedUeBehaviour + +**Table 6.5.6.2.28-1: Definition of type AppSpecificExpectedUeBehaviour** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------|-----------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| afInstanceId | string | M | 1 | The string identifying the originating AF (NOTE) | +| referenceId | ReferenceId | M | 1 | Identifies transaction reference ID generated by NEF. | +| appSpecificExpectedUeBehaviourData | map(AppSpecificExpectedUeBehaviourData) | M | 1..N | A map of application specific expected UE Behaviour parameters. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. | + +NOTE: When the service operation is originated by external AF on the T8/N33 interfaces, the information carried in the {scsAsId} URI variable on the T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in the {afId} URI variable on the N33 interface (see clause 5 of 3GPP TS 29.522 [54]) can be used as the value for this IE. + +##### 6.5.6.2.29 Type: MaxGroupDataRate + +**Table 6.5.6.2.29-1: Definition of type MaxGroupDataRate** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------| +| uplink | BitRate | O | 0..1 | Maximum uplink data rate for a 5G VN Group | +| downlink | BitRate | O | 0..1 | Maximum downlink data rate for a 5G VN Group | + +##### 6.5.6.2.30 Type: 5GVnGroupConfigurationModification + +Table 6.5.6.2.30-1: Definition of type 5GVnGroupConfigurationModification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| 5gVnGroupData | 5GVnGroupData Modification | O | 0..1 | Data of the 5G VN Group.

nullable: true | | +| afInstanceId | string | O | 0..1 | The string identifying the originating AF. | | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for 5G VN Group Configuration authorization. | | +| members | array(Gpsi) | O | 1..N | List of group members.

This IE, if present, shall be ignored if attribute "membersData" is present in 5GVnGroupConfigurationModification.

nullable: true | | +| membersData | map(GpsiInfo) | O | 1..N | Represents the list of 5G VN Group members, each member is identified by GPSI.

A map (list of key-value pairs where Gpsi serves as key) of GpsiInfo. The value in each entry of the map shall be an empty JSON object.

To delete a member (key) from the map, its value shall be set to null.

nullable: true | MembersData | + +##### 6.5.6.2.31 Type: 5GVnGroupDataModification + +**Table 6.5.6.2.31-1: Definition of type 5GVnGroupDataModification** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| appDescriptors | array(AppDescriptor) | O | 1..N | List of Application Descriptors allowed for 5G VN group's communication session.

nullable: true | +| secondaryAuth | boolean | O | 0..1 | Indicates whether secondary authentication and authorization is needed.
true: secondary authentication and authorization is needed.
false: secondary authentication and authorization is not needed.
If absent, it indicates that secondary authentication is not required by the NEF, but it still may be required by local policies at the SMF.

nullable: true | +| dnAaIpAddressAllocation | boolean | O | 0..1 | Indicates whether the SMF is required to request the UE IP address from the DN-AAA server for PDU Session Establishment.
true: required
false: not required
If absent, it indicates that the request by SMF of the UE IP address from the DN-AAA server is not required, but it still may be required by local policies at the SMF.

nullable: true | +| dnAaaAddress | IpAddress | O | 0..1 | The IP address of the DN-AAA server, used for secondary authentication and authorization.

nullable: true | +| additionalDnAaaAddresses | array(IpAddress) | O | 1..N | Additional IP addresses of the DN-AAA server used for secondary authentication and authorization.

nullable: true | +| dnAaaFqdn | FqdnRm | O | 0..1 | The FQDN of the DN-AAA server used for secondary authentication and authorization.

nullable: true | +| 5gVnGroupCommunicationInd | boolean | O | 0..1 | When present, this IE shall indicate whether 5G VN group is associated with 5G VN group communication:
- true: 5G VN group is associated with 5G VN group communication
- false: 5G VN group is not associated with 5G VN group communication.

nullable: true | +| maxGroupDataRate | MaxGroupDataRate | O | 0..1 | The limits of the total bit rate across all sessions of the 5G VN group (uplink and downlink).

nullable: true | + +#### 6.5.6.3 Simple data types and enumerations + +##### 6.5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.5.6.3.2 Simple data types + +The simple data types defined in table 6.5.6.3.2-1 shall be supported. + +**Table 6.5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------------|-----------------|-------------| +| PpDIPacketCount | integer | nullable | + +6.5.6.3.3 Void + +6.5.6.3.4 Void + +### 6.5.7 Error Handling + +#### 6.5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.5.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.5.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_ParameterProvision service. The following application errors listed in Table 6.5.7.3-1 are specific for the Nudm\_ParameterProvision service. + +The application errors defined for the Nudm\_UECM service are listed in Table 6.5.7.3-1. + +**Table 6.5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------------|------------------|-----------------------------------------------------------------------------------------------| +| CONFIDENCE_LEVEL_OUT_OF_RANGE | 400 Bad Request | Confidence Level of the Expected UE Behaviour Parameter is out of range (e.g. <0.00 or >1.00) | +| ACCURACY_LEVEL_OUT_OF_RANGE | 400 Bad Request | Accuracy Level of the Expected UE Behaviour Parameter is out of range (e.g. <0.00 or >1.00) | +| MODIFICATION_NOT_ALLOWED | 403 Forbidden | The subscriber does not have the necessary subscription for external parameter provisioning. | +| USER_NOT_FOUND | 404 Not Found | The User does not exist. | +| CREATION_NOT_ALLOWED | 403 Forbidden | Creation of a 5G VN Group is not allowed. | +| DETACHED_USER | 403 Forbidden | The user is detached in the Network. | +| GROUP_IDENTIFIER_NOT_FOUND | 404 Not Found | The group does not exist | +| AF_NOT_ALLOWED | 403 Forbidden | This AF is not allowed to perform external provisioning or 5G VN Group creation. | +| MTC_PROVIDER_NOT_ALLOWED | 403 Forbidden | MTC Provider not authorized to perform external provisioning or 5G VN Group creation. | + +### 6.5.8 Feature Negotiation + +The optional features in table 6.5.8-1 are defined for the Nudm\_PP API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | PatchReport | If some of the modifications included in the PATCH request are not successfully implemented, the UDM reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [4]. | +| 2 | ExpectedBehaviourMap | This indicates that the UDM supports receiving Expected Behaviour Parameters as a map of ExpectedUeBehaviourData. | +| 3 | MembersData | This indicates that the UDM supports receiving Gpsi(s) as a map of Gpsi for 5G VN Group. | + +### 6.5.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nudm\_PP API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nudm\_PP API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.8.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudm\_PP service. + +The Nudm\_PP API defines a single scope "nudm-pp" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +### 6.5.10 HTTP redirection + +An HTTP request may be redirected to a different UDM service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UDM producer instance will return the NF Instance ID of the new UDM producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UDM redirects a service request to a different UDM using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UDM towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.6 Nudm\_NIDDAuthorization Service API + +### 6.6.1 API URI + +The Nudm\_NIDDAuthorization service shall use the Nudm\_NIDDAU API. + +The API URI of the Nudm\_NIDDAU API shall be: + +**{apiRoot}
** + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. + +- The shall be "nudm-niddau". +- The shall be "v1". +- The shall be set as described in clause 6.6.3. + +### 6.6.2 Usage of HTTP + +#### 6.6.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [13], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nudm\_NIDDAuthorization service shall comply with the OpenAPI [14] specification contained in Annex A.7. + +#### 6.6.2.2 HTTP standard headers + +##### 6.6.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.6.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 9457 [16]) signalled by the content type "application/problem+json" + +#### 6.6.2.3 HTTP custom headers + +##### 6.6.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.6.3 Resources + +#### 6.6.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.6.3.1-1 depicts the resource URIs structure for the Nudm\_NIDDAU API. + +![Diagram showing the resource URI structure for the Nudm-NIDDAU API. The root URI is //{apiRoot}/nudm-niddau/v1. It branches into //{ueldentity}, which further branches into //authorize. The //authorize path is enclosed in a dashed box.](8bc528a620af2b7f493359b4ddbd8c7e_img.jpg) + +``` +graph TD; Root["//{apiRoot}/nudm-niddau/v1"] --> Ueldentity["//{ueldentity}"]; Ueldentity --> Authorize["//authorize"]; style Authorize stroke-dasharray: 5 5; +``` + +Diagram showing the resource URI structure for the Nudm-NIDDAU API. The root URI is //{apiRoot}/nudm-niddau/v1. It branches into //{ueldentity}, which further branches into //authorize. The //authorize path is enclosed in a dashed box. + +**Figure 6.6.3.1-1: Resource URI structure of the Nudm-NIDDAU API** + +Table 6.6.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.6.3.1-1: Resources and methods overview** + +| Resource name
(Archetype) | Resource URI | HTTP
method
or
custom
operation | Description | +|------------------------------|--------------------------|---------------------------------------------|-------------------------------------------| +| ueIdentity
(Document) | //{ueIdentity}/authorize | authorize
(POST) | Authorize the NIDD configuration request. | + +#### 6.6.3.2 Resource: ueIdentity (Document) + +##### 6.6.3.2.1 Description + +This resource represents the UE's subscribed NIDD authorization information for a GPSI or External Group Identifier. + +##### 6.6.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nudm-niddau//{ueIdentity} + +This resource shall support the resource URI variables defined in table 6.6.3.2.2-1. + +**Table 6.6.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.6.1 | +| ueIdentity | string | Represents the GPSI or External Group Identifier (see 3GPP TS 23.501 [2] clause 7.2.5)
pattern: "^(msisdn-[0-9]{5,15} extid-[^@]+@[^\@]+\+ extgroupid-[^@]+@[^\@]+\+ .+)\$" | + +##### 6.6.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +##### 6.6.3.2.4 Resource Custom Operations + +###### 6.6.3.2.4.1 Overview + +**Table 6.6.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP
method | Description | +|----------------|----------------------|-----------------------|-------------------------------------------| +| authorize | /authorize | POST | Authorize the NIDD configuration request. | + +###### 6.6.3.2.4.2 Operation: authorize + +###### 6.6.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (NEF) to request UDM to authorize the NIDD configuration request for the GPSI/External Group Identifier. + +###### 6.6.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.6.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.6.3.2.4.2.2-2. + +**Table 6.6.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|----------------------------------------------------------------| +| AuthorizationInfo | M | 1 | Contains S-NSSAI, DNN, MTC Provider Information, callback URI. | + +**Table 6.6.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthorizationData | M | 1 | 200 OK | Upon success, a response body containing the SUPI(s) and GPSI shall be returned. | +| ProblemDetails | O | 1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- DNN_NOT_ALLOWED
- MTC_PROVIDER_NOT_ALLOWED
- AF_INSTANCE_NOT_ALLOWED
- SNSSAI_NOT_ALLOWED | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +### 6.6.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nudm\_SubscriberDataManagement Service. + +### 6.6.5 Notifications + +#### 6.6.5.1 General + +This clause will specify the use of notifications and corresponding protocol details if required for the specific service. When notifications are supported by the API, it will include a reference to the general description of notifications support over the 5G SBIs specified in 3GPP TS 29.500 [4] / 3GPP TS 29.501 [5]. + +**Table 6.6.5.1-1: Notifications overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|----------------------------------------|-------------------------|---------------------------------|---------------------------------| +| Authorization Data Update Notification | {authUpdateCallbackUri} | POST | | + +#### 6.6.5.2 Nidd Authorization Data Update Notification + +The POST method shall be used for Nidd Authorization Data Update Notifications and the Call-back URI shall be provided during the NIDD Authorization Data Retrieval procedure. UDM should continuously generate NIDD authorization Data Update Notifications to service consumer (NEF) for UE for the event until validity time related to the UE expires, and if validity time expires, it indicates unsubscription to notification for the UE. + +Resource URI: {authUpdateCallbackUri} + +Support of URI query parameters is specified in table 6.6.5.2-1. + +**Table 6.6.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.6.5.2-2 and of response data structures and response codes is specified in table 6.6.5.2-3. + +**Table 6.1.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-------------| +| NiddAuthUpdateNotification | M | 1 | | + +**Table 6.6.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 6.6.7-1 are supported. | | | | | + +### 6.6.6 Data Model + +#### 6.6.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.6.6.1-1 specifies the structured data types defined for the Nudm\_NIDDAU service API. For simple data types defined for the Nudm\_NIDDAU service API see table 6.6.6.3.2-1. + +**Table 6.6.6.1-1: Nudm\_NIDDAU specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------|----------------|-------------| +| AuthorizationData | 6.6.6.2.2 | | +| UserIdentifier | 6.6.6.2.3 | | +| NiddAuthUpdateInfo | 6.6.6.2.4 | | +| NiddAuthUpdateNotification | 6.6.6.2.5 | | +| AuthorizationInfo | 6.6.6.2.6 | | +| NiddCause | 6.6.6.3.3 | | + +Table 6.6.6.1-2 specifies data types re-used by the Nudm\_NIDDAU service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudm\_NIDDAU service API. + +**Table 6.6.6.1-2: Nudm\_NIDDAU re-used Data Types** + +| Data type | Reference | Comments | +|------------------------|---------------------|-------------------------------------------------| +| Nssai | 6.1.6.2.2 | Network Slice Selection Assistance Information | +| Gpsi | 3GPP TS 29.571 [7] | Generic Public Subscription Identifier | +| Supi | 3GPP TS 29.571 [7] | | +| Dnn | 3GPP TS 29.571 [7] | Data Network Name with Network Identifier only. | +| MtcProviderInformation | 3GPP TS 29.571 [7] | | +| DateTime | 3GPP TS 29.571 [7] | | +| Snsai | 3GPP TS 29.571 [7] | | +| Uri | 3GPP TS 29.571 [7] | | +| NefId | 3GPP TS 29.510 [19] | NEF ID | + +#### 6.6.6.2 Structured data types + +##### 6.6.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.6.6.2.2 Type: AuthorizationData + +**Table 6.6.6.2.2-1: Definition of type AuthorizationData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| authorizationData | array(UserIdentifier) | M | 1..N | May contain a single value or list of (SUPI and GPSI). Contains unique items. | +| validityTime | DateTime | O | 0..1 | Indicates the granted validity time of the authorisation result.
If absent, it indicates the authorisation result is valid permanently | + +##### 6.6.6.2.3 Type: UserIdentifier + +**Table 6.6.6.2.3-1: Definition of type UserIdentifier** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supi | Supi | M | 1 | | +| gpsI | Gpsi | O | 0..1 | | +| validityTime | DateTime | O | 0..1 | Indicates the granted validity time of the authorisation result for this user.
If absent, the value of the validity time in the AuthorizationData is used for this user if it is present in AuthorizationData.
If present, this value has higher priority than the value in the AuthorizationData. | + +##### 6.6.6.2.4 Type: NiddAuthUpdateInfo + +**Table 6.6.6.2.4-1: Definition of type NiddAuthUpdateInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| authorizationData | AuthorizationData | M | 1 | This IE shall include the Authorization data. | +| invalidityInd | boolean | O | 0..1 | Indicates whether the authorized NIDD authoration data is still valid or not.
true: the authorized NIDD authoration data is not valid.
false or absent: the authorized NIDD authoration data is valid. | +| snssai | Snssai | O | 0..1 | Indicates Single Network Slice Selection Assistance Information for NIDD authorization. When absent it indicates authorization for all subscribed S-NSSAIs. | +| dnn | Dnn | O | 0..1 | Indicates DNN for NIDD authorization, shall contain the Network Identifier only. When absent it indicates authorization for all subscribed DNNs. | +| niddCause | NiddCause | O | 0..1 | NIDD Cause | + +##### 6.6.6.2.5 Type: NiddAuthUpdateNotification + +**Table 6.6.6.2.5-1: Definition of type NiddAuthUpdateNotification** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|---------------------------|---|-------------|-----------------------------| +| niddAuthUpdateInfoList | array(NiddAuthUpdateInfo) | M | 1..N | List of NiddAuthUpdateInfo. | + +##### 6.6.6.2.6 Type: AuthorizationInfo + +**Table 6.6.6.2.6-1: Definition of type AuthorizationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| snssai | Snssai | M | 1 | Indicates Single Network Slice Selection Assistance Information for NIDD authorization. | +| dnn | Dnn | M | 1 | Indicates DNN for NIDD authorization, shall contain the Network Identifier only. | +| mtcProviderInformation | MtcProviderInformation | M | 1 | Indicates MTC provider information for NIDD authorization. (NOTE) | +| authUpdateCallbackUri | Uri | M | 1 | A URI provided by NEF to receive (implicitly subscribed) notifications on authorization data update.
The authUpdateCallbackUri URI shall have unique information within NEF to identify the authorized result. | +| aflid | string | O | 0..1 | When present, indicates the string identifying the originating AF, which is carried in {scsAsId} URI variable in resource URIs on T8/N33 interface (see clause 5 of 3GPP TS 29.122 [45]) or in {aflid} URI variable in resource URIs on N33 interface (see clause 5 of 3GPP TS 29.522 [54]). | +| neflid | NefId | O | 0..1 | When present, this IE shall contain the ID of the requesting NEF.

The UDM shall update the NIDD NEF ID for the DNN and Slice in corresponding subscription data after successful NIDD authorization, as specified in clause 4.25.3 of 3GPP TS 23.502 [3]. | +| validityTime | DateTime | O | 0..1 | Indicates the requested validity time of the authorization request.
If absent, it indicates that permanent authorization is requested. | +| contextInfo | ContextInfo | O | 0..1 | This IE if present may contain e.g. the headers received by the UDM along with the Authorization Data Retrieval request.
Shall be absent on Nudr and may be present on Nudr. | + +NOTE: When the service operation is originated by external AF via T8/N33 interface, information carried in mtcProviderId attribute in NiddConfiguration structured data type (see clause 5.6.2.1.2 of 3GPP TS 29.122 [45]) can be used as the value for this IE. If the value is not received via T8/N33, the value for the mtcProviderInformation attribute shall be the empty string. + +#### 6.6.6.3 Simple data types and enumerations + +##### 6.6.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.6.6.3.2 Simple data types + +The simple data types defined in table 6.6.6.3.2-1 shall be supported. + +**Table 6.6.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +##### 6.6.6.3.3 Enumeration: NiddCause + +**Table 6.6.6.3.3-1: Enumeration NiddCause** + +| Enumeration value | Description | +|---------------------------|---------------------------------------------------------------| +| "SUBSCRIPTION WITHDRAWAL" | Subscription Withdrawal | +| "DNN_REMOVED" | DNN used for NIDD service is removed from the UE subscription | + +### 6.6.7 Error Handling + +#### 6.6.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.6.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.6.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_NIDD Authorization service. The following application errors listed in Table 6.6.7.3-1 are specific for the Nudm\_NIDD Authorization service. + +**Table 6.6.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------------|------------------|--------------------------------------------------| +| UNKNOWN_5GS_SUBSCRIPTION | 403 Forbidden | No 5GS subscription is associated with the user. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| DNN_NOT_ALLOWED | 403 Forbidden | DNN not authorized for the user | +| MTC_PROVIDER_NOT_ALLOWED | 403 Forbidden | MTC Provider not authorized | +| AF_INSTANCE_NOT_ALLOWED | 403 Forbidden | This AF instance is not authorized | +| SNSSAI_NOT_ALLOWED | 403 Forbidden | This SNSSAI is not authorized to this user | +| DATA_NOT_FOUND | 404 Not Found | There is no valid authorization data for the UE | + +### 6.6.8 Feature Negotiation + +The optional features in table 6.6.8-1 are defined for the Nudm\_NIDDAU API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.6.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.6.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nudm\_NIDDAU API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nudm\_NIDDAU API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudm\_NIDDAU service. + +The Nudm\_NIDDAU API defines a single scope "nudm-niddau" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +### 6.6.10 HTTP redirection + +An HTTP request may be redirected to a different UDM service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UDM producer instance will return the NF Instance ID of the new UDM producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UDM redirects a service request to a different UDM using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UDM towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-NF-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.7 Nudm\_MT Service API + +### 6.7.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion} + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot}
+ +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nudm-mt". +- The shall be "v1". +- The shall be set as described in clause 6.7.3. + +### 6.7.2 Usage of HTTP + +#### 6.7.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [13], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nudm\_MT service shall comply with the OpenAPI [14] specification contained in Annex A4. + +#### 6.7.2.2 HTTP standard headers + +##### 6.7.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.7.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 9457 [16]) signalled by the content type "application/problem+json" + +#### 6.7.2.3 HTTP custom headers + +##### 6.7.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.7.3 Resources + +#### 6.7.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.7.3.1-1 depicts the resource URIs structure for the Nudm\_MT API. + +![Figure 6.7.3.1-1: Resource URI structure of the Nudm-MT API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nudm-mt/v1. It branches to //{supi}, which then branches to /loc-info, which finally branches to /provide-loc-info (indicated by a dashed box).](82755aa51734b65461f50bf3361c8ab2_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nudm-mt/v1"] --> Supi["//{supi}"] + Supi --> LocInfo["/loc-info"] + LocInfo --> ProvideLocInfo["/provide-loc-info"] + +``` + +Figure 6.7.3.1-1: Resource URI structure of the Nudm-MT API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nudm-mt/v1. It branches to //{supi}, which then branches to /loc-info, which finally branches to /provide-loc-info (indicated by a dashed box). + +**Figure 6.7.3.1-1: Resource URI structure of the Nudm-MT API** + +Table 6.7.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.7.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|---------------------------------|------------------------------------|---------------------------------|--------------------------------------------------------------| +| UeInfo (Document) | //{supi} | GET | Retrieve UE's TADS Info and/or User State and/or 5GSRVCCInfo | +| LocationInfo (Custom Operation) | //{supi}/loc-info/provide-loc-info | provide-loc-info (POST) | Request UE's location | + +#### 6.7.3.2 Resource: UeInfo + +##### 6.7.3.2.1 Description + +This resource represents the 5GC TADS Info and/or User State and/or 5GSRVCCInfo for a SUPI. It is queried by the HSS (see 3GPP TS 23.632 [32] clause 5.4.1). + +##### 6.7.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nudm-mt// + +This resource shall support the resource URI variables defined in table 6.7.3.2.2-1. + +**Table 6.7.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.7.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [7] | + +##### 6.7.3.2.3 Resource Standard Methods + +###### 6.7.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.7.3.2.3.1-1. + +**Table 6.7.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | M | 1..N | The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. See attribute names of type UeInfo. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.7.3.2.3.1-2 and the response data structures and response codes specified in table 6.7.3.2.3.1-3. + +**Table 6.7.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.7.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------| +| UeInfo | M | 1 | 200 OK | Upon success, a response body containing the UeInfo shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to convey the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +#### 6.7.3.3 Resource: LocationInfo + +##### 6.7.3.3.1 Description + +This resource represents the UE's location information in 5GC. See 3GPP TS 23.632 [32] clause 5.4.3. + +##### 6.7.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nudm-mt///loc-info + +This resource shall support the resource URI variables defined in table 6.7.3.3.2-1. + +**Table 6.7.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.7.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "(imsi-[0-9]{5,15} nai-.[+.+])" | + +##### 6.7.3.3.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +##### 6.7.3.3.4 Resource Custom Operations + +###### 6.7.3.3.4.1 Overview + +**Table 6.7.3.3.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|------------------|----------------------|--------------------|-----------------------------------------| +| provide-loc-info | /provide-loc-info | POST | Request UE location information in 5GC. | + +###### 6.7.3.3.4.2 Operation: provide-loc-info + +###### 6.7.3.3.4.2.1 Description + +This custom operation is used by the NF service consumer (HSS) to request the UE location information in 5GC. + +###### 6.7.3.3.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.7.3.3.4.2.2-1 and the response data structure and response codes specified in table 6.7.3.3.4.2.2-2. + +**Table 6.7.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------| +| LocationInfoRequest | M | 1 | Contains the requested information: current location, local time zone, RAT type, or serving node identity only | + +**Table 6.7.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|----------|--------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------| +| LocationInfoResult | M | 1 | 200 OK | Upon success, a response body containing requested information shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +### 6.7.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nudm\_MT Service. + +### 6.7.5 Notifications + +In this release of this specification, no notifications are defined for the Nudm\_MT Service. + +### 6.7.6 Data Model + +#### 6.7.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.7.6.1-1 specifies the structured data types defined for the Nudm\_MT service API. For simple data types defined for the Nudm\_MT service API see table 6.7.6.3.2-1. + +**Table 6.7.6.1-1: Nudm\_MT specific Data Types** + +| Data type | Clause defined | Description | +|---------------------|-----------------------|--------------------| +| UeInfo | 6.7.6.2.2 | | +| LocationInfoRequest | 6.7.6.2.3 | | +| LocationInfoResult | 6.7.6.2.4 | | +| 5GSrvccInfo | 6.7.6.2.5 | | + +Table 6.7.6.1-2 specifies data types re-used by the Nudm\_MT service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudm\_MT service API. + +**Table 6.7.6.1-2: Nudm\_MT re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------|---------------------|--------------------------------------| +| UeContextInfo | 3GPP TS 29.518 [36] | | +| Supi | 3GPP TS 29.571 [7] | | +| 5GsUserState | 3GPP TS 29.518 [36] | | +| NfInstanceId | 3GPP TS 29.571 [7] | Network Function Instance Identifier | +| PlmnId | 3GPP TS 29.571 [7] | PLMN Identity | +| Ecgi | 3GPP TS 29.571 [7] | EUTRAN cell identity | +| Ncgi | 3GPP TS 29.571 [7] | NR cell identity | +| Tai | 3GPP TS 29.571 [7] | Tracking area identity | +| GeographicArea | 3GPP TS 29.572 [34] | Estimate of the location of the UE | +| AgeOfLocationEstimate | 3GPP TS 29.572 [34] | Age Of Location Estimate | +| RatType | 3GPP TS 29.571 [7] | RAT type | +| TimeZone | 3GPP TS 29.571 [7] | Time Zone | +| SupportedFeatures | 3GPP TS 29.571 [7] | | +| ProblemDetails | 3GPP TS 29.571 [7] | | +| StnSr | 3GPP TS 29.571 [7] | Session Transfer Number for 5G-SRVCC | +| CMSisdn | 3GPP TS 29.571 [7] | Correlation MSISDN | + +#### 6.7.6.2 Structured data types + +##### 6.7.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.7.6.2.2 Type: UeInfo + +**Table 6.7.6.2.2-1: Definition of type UeInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|------------------|----------|--------------------|-------------------------| +| tadsInfo | UeContextInfo | O | 0..1 | See 3GPP TS 29.518 [36] | +| userState | 5GsUserState | O | 0..1 | See 3GPP TS 29.518 [36] | +| 5gSrvccInfo | 5GSrvccInfo | O | 0..1 | | + +##### 6.7.6.2.3 Type: LocationInfoRequest + +**Table 6.7.6.2.3-1: Definition of type LocationInfoRequest** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| req5gsLoc | boolean | C | 0..1 | This IE shall be present and set to "true", if 5GS location information is requested.

When present, the IE shall be set as following:
- true: the location of the UE is requested
- false (default): the location of the UE is not requested | +| reqCurrentLoc | boolean | C | 0..1 | This IE may be present if location information is requested.

When present, the IE shall be set as following:
- true: the current location of the UE is requested
- false (default): the current location of the UE is not requested | +| reqRatType | boolean | C | 0..1 | This IE shall be present and set to "true", if the RAT Type of the UE is requested.

When present, the IE shall be set as following:
- true: the RAT type of the UE is requested
- false (default): the RAT type of the UE is not requested | +| reqTimeZone | boolean | C | 0..1 | This IE shall be present and set to "true", if the local timezone of the UE is requested.

When present, the IE shall be set as following:
- true: the local timezone of the UE is requested
- false (default): the local timezone of the UE is not requested. | +| reqServingNode | boolean | C | 0..1 | This IE shall be present and set to "true", if only serving node(s) address/identity is requested as location information.
When present, the IE shall be set as following:
- true: only serving node(s) identity is requested
- false(default) | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.7.8 | + +##### 6.7.6.2.4 Type: LocationInfoResult + +**Table 6.7.6.2.4-1: Definition of type LocationInfoResult** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| vPlmnId | PlmnId | M | 1 | Visiting PLMN Identity | +| amfInstanceId | NfInstanceId | O | 0..1 | NF instance ID of the serving AMF for 3GPP access | +| smsfInstanceId | NfInstanceId | O | 0..1 | NF instance ID of the serving SMSF | +| ecgi | Ecgi | O | 0..1 | E-UTRA Cell Identity | +| ncgi | Ncgi | O | 0..1 | NR Cell Identity | +| tai | Tai | O | 0..1 | Tracking Area Identity | +| currentLoc | boolean | O | 0..1 | When present, this IE shall be set as following:
- true: the current location of the UE is returned
- false: the last known location of the UE is returned. | +| geoInfo | GeographicArea | O | 0..1 | If present, this IE shall contain the geographical information of the UE. | +| locationAge | AgeOfLocationEstimate | O | 0..1 | If present, this IE shall contain the age of the location information. | +| ratType | RatType | O | 0..1 | If present, this IE shall contain the current RAT type of the UE. | +| timezone | TimeZone | O | 0..1 | If present, this IE shall contain the local time zone of the UE. | +| supportedFeatures | SupportedFeatures | O | 0..1 | See clause 6.7.8 | + +NOTE: Either the "ecgi" attribute or the "ncgi" attribute may be included. + +##### 6.7.6.2.5 Type: 5GSrvccInfo + +**Table 6.7.6.2.5-1: Definition of type 5GSrvccInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| ue5GSrvccCapability | boolean | M | 1 | This IE indicates whether the UE supports 5G SRVCC:
- true: 5G SRVCC is supported by the UE
- false: 5G SRVCC is not supported. | +| stnSr | StnSr | O | 0..1 | Session Transfer Number for 5G-SRVCC | +| cMsisdn | CMsisdn | O | 0..1 | Correlation MSISDN of the UE. | + +#### 6.7.6.3 Simple data types and enumerations + +In this release of this specification, no simple data types and enumerations are defined for the Nudm\_MT Service. + +### 6.7.7 Error Handling + +#### 6.7.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.7.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.7.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_MT service. The following application errors listed in Table 6.7.7.3-1 are specific for the Nudm\_MT service. + +**Table 6.7.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------------|-------------------------|----------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist | +| DATA_NOT_FOUND | 404 Not Found | The requested UE data is not found/does not exist. | + +### 6.7.8 Feature Negotiation + +The optional features in table 6.7.8-1 are defined for the Nudm\_MT API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.7.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|-----------------------|---------------------|--------------------| +| | | | + +### 6.7.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nudm\_MT API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nudm\_MT API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudm\_MT service. + +The Nudm\_MT API defines a single scope "nudm-mt" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +### 6.7.10 HTTP redirection + +An HTTP request may be redirected to a different UDM service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UDM producer instance will return the NF Instance ID of the new UDM producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UDM redirects a service request to a different UDM using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UDM towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.8 Nudm\_ServiceSpecificAuthorization Service API + +### 6.8.1 API URI + +The Nudm\_ServiceSpecificAuthorization service shall use the Nudm\_SSAU API. + +The API URI of the Nudm\_SSAU API shall be: + +{apiRoot}
+ +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nudm-ssau". +- The shall be "v1". +- The shall be set as described in clause 6.8.3. + +### 6.8.2 Usage of HTTP + +#### 6.8.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [13], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nudm\_ServiceSpecificAuthorization service shall comply with the OpenAPI [14] specification contained in Annex A.9. + +#### 6.8.2.2 HTTP standard headers + +##### 6.8.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.8.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 9457 [16]) signalled by the content type "application/problem+json" + +#### 6.8.2.3 HTTP custom headers + +##### 6.8.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.8.3 Resources + +#### 6.8.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.8.3.1-1 depicts the resource URIs structure for the Nudm\_SSAU API. + +![Figure 6.8.3.1-1: Resource URI structure of the Nudm-SSAU API. The diagram shows a hierarchical tree structure starting with //apiRoot/nudm-ssau/v1. It branches to {ueIdentity}, which then branches to {serviceType}. From {serviceType}, two dashed boxes represent sub-resources: /authorize and /remove.](be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg) + +``` + +graph TD + Root[//apiRoot/nudm-ssau/v1] --> ueIdentity[{ueIdentity}] + ueIdentity --> serviceType[{serviceType}] + serviceType --> authorize[/authorize] + serviceType --> remove[/remove] + +``` + +Figure 6.8.3.1-1: Resource URI structure of the Nudm-SSAU API. The diagram shows a hierarchical tree structure starting with //apiRoot/nudm-ssau/v1. It branches to {ueIdentity}, which then branches to {serviceType}. From {serviceType}, two dashed boxes represent sub-resources: /authorize and /remove. + +**Figure 6.8.3.1-1: Resource URI structure of the Nudm-SSAU API** + +Table 6.8.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.8.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|---------------------------|----------------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------| +| ServiceType (Document) | //{ueIdentity}/{serviceType}/authorize | authorize (POST) | Authorize the configuration request for the specific service identified by the serviceType. | +| | //{ueIdentity}/{serviceType}/remove | remove (POST) | Remove the authorization of configuration request for the specific service identified by the serviceType. | + +#### 6.8.3.2 Resource: ServiceType (Document) + +##### 6.8.3.2.1 Description + +This resource represents the subscribed authorization information of a specific service for a GPSI or External Group Identifier. + +##### 6.8.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nudm-ssau//{ueIdentity}/{serviceType} + +This resource shall support the resource URI variables defined in table 6.8.3.2.2-1. + +**Table 6.8.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.8.1 | +| ueIdentity | string | Represents the GPSI or External Group Identifier (see 3GPP TS 23.501 [2] clause 7.2.5) pattern: "^(msisdn-[0-9]{5,15} extid-[^@]+\+@[^@]+\+ extgroupid-[^@]+\+@[^@]+\+ .+)\$" | +| serviceType | ServiceType | In this release the only defined Service Type is "AF guidance for URSP" | + +##### 6.8.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +##### 6.8.3.2.4 Resource Custom Operations + +###### 6.8.3.2.4.1 Overview + +**Table 6.8.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|---------------------------------------|--------------------|----------------------------------------------------| +| authorize | /{ueIdentity}/{serviceType}/authorize | POST | Authorize the configuration request. | +| remove | /{ueIdentity}/{serviceType}/remove | POST | Remove the authorization of configuration request. | + +###### 6.8.3.2.4.2 Operation: authorize + +###### 6.8.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (NEF) to request UDM to authorize a specific service's configuration for the GPSI/External Group Identifier. + +###### 6.8.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.8.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.8.3.2.4.2.2-2. + +**Table 6.8.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceSpecificAuthorizationInfo | M | 1 | This IE shall indicate the information for service specific authorization, which should contain the callback URI and may contain S-NSSAI, DNN, MTC Provider Information, AF-ID. | + +**Table 6.8.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceSpecificAuthorizationData | M | 1 | 200 OK | Upon success, a response body containing the GPSI and SUPI or Internal Group Identifier mapped from External Group ID, and Service Specific Authorization Id shall be returned. | +| ProblemDetails | O | 1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- DNN_NOT_ALLOWED
- MTC_PROVIDER_NOT_ALLOWED
- AF_INSTANCE_NOT_ALLOWED
- SNSSAI_NOT_ALLOWED
- SERVICE_TYPE_NOT_ALLOWED | +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +###### 6.8.3.2.4.3 Operation: remove + +###### 6.8.3.2.4.3.1 Description + +This custom operation is used by the NF service consumer (NEF) to request UDM to remove the authorization of a specific service's configuration for the GPSI/External Group Identifier. + +###### 6.8.3.2.4.3.2 Operation Definition + +This operation shall support the request data structures specified in table 6.8.3.2.4.3.2-1 and the response data structure and response codes specified in table 6.8.3.2.4.3.2-2. + +**Table 6.8.3.2.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| ServiceSpecificAuthorizationRemoveData | M | 1 | This IE shall indicate the information to remove the authorization of specific service's configuration. | + +**Table 6.8.3.2.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successfully removed the authorization of specific service's configuration. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- AUTHORIZATION NOT_FOUND | + +NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +### 6.8.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nudm\_ServiceSpecificAuthorization Service. + +### 6.8.5 Notifications + +#### 6.8.5.1 General + +This clause will specify the use of notifications and corresponding protocol details if required for the specific service. When notifications are supported by the API, it will include a reference to the general description of notifications support over the 5G SBIs specified in 3GPP TS 29.500 [4] / 3GPP TS 29.501 [5]. + +**Table 6.8.5.1-1: Notifications overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|-------------------------------------------|-------------------------|---------------------------------|---------------------------------| +| Service Specific Data Update Notification | {authUpdateCallbackUri} | POST | | + +#### 6.8.5.2 Service Specific Data Update Notification + +The POST method shall be used for Service Specific Data Update Notifications and the Call-back URI shall be provided during the Service Specific Authorization Data Retrieval procedure. + +Resource URI: {authUpdateCallbackUri} + +Support of URI query parameters are specified in table 6.8.5.2-1. + +**Table 6.8.5.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.8.5.2-2 and of response data structures and response codes is specified in table 6.8.5.2-3. + +**Table 6.8.5.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-------------| +| AuthUpdateNotification | M | 1 | | + +**Table 6.8.5.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT NOT FOUND | +| NOTE: In addition common data structures as listed in table 6.8.7-1 are supported. | | | | | + +### 6.8.6 Data Model + +#### 6.8.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.8.6.1-1 specifies the structured data types defined for the Nudm\_SSAU service API. For simple data types defined for the Nudm\_SSAU service API see table 6.8.6.3.2-1. + +**Table 6.8.6.1-1: Nudm\_SSAU specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------------------|----------------|-------------------------------------------------------------| +| AuthUpdateNotification | 6.8.6.2.2 | | +| AuthUpdateInfo | 6.8.6.2.3 | | +| ServiceSpecificAuthorizationInfo | 6.8.6.2.4 | | +| ServiceSpecificAuthorizationData | 6.8.6.2.5 | Authorization Response for a specific service | +| AuthorizationUeId | 6.8.6.2.6 | UE Id of the Authorization Data | +| ServiceSpecificAuthorizationRemoveData | 6.8.6.2.7 | Information for Authorization removal of a specific service | +| ServiceType | 6.8.6.3.2 | Service Type of the Authorization | +| InvalidCause | 6.8.6.3.3 | Authorization Invalid Cause | + +Table 6.8.6.1-2 specifies data types re-used by the Nudm\_SSAU service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudm\_SSAU service API. + +**Table 6.8.6.1-2: Nudm\_SSAU re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|--------------------|-------------------------------------------------| +| AuthorizationData | 6.6.6.2.2 | | +| Dnn | 3GPP TS 29.571 [7] | Data Network Name with Network Identifier only. | +| Snssai | 3GPP TS 29.571 [7] | | +| ExternalGroupId | 3GPP TS 29.571 [7] | | +| GroupId | 3GPP TS 29.571 [7] | | + +#### 6.8.6.2 Structured data types + +##### 6.8.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.8.6.2.2 Type: AuthUpdateNotification + +**Table 6.8.6.2.2-1: Definition of type AuthUpdateNotification** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|----------|--------------------|-----------------------------------------------------------------------------------------------------------| +| serviceType | ServiceType | M | 1 | Specific service for which the authorization is updated | +| snssai | Snssai | C | 0..1 | Identifies the Single Network Slice. | +| dnn | Dnn | C | 0..1 | Identifies the DNN, shall contain the Network Identifier only. | +| authUpdateInfoList | array(AuthUpdateInfo) | M | 1..N | List of AuthUpdateInfo. | +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | When present, this IE shall indicate the MTC provider information for the Service Specific authorization. | +| aflid | string | O | 0..1 | When present, this IE shall indicate the string identifying the originating AF. | + +##### 6.8.6.2.3 Type: AuthUpdateInfo + +**Table 6.8.6.2.4-1: Definition of type AuthUpdateInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|---------------------------------|----------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| authorizationData | ServicepecificAuthorizationData | M | 1 | This IE shall include the Authorization data. | +| invalidityInd | boolean | O | 0..1 | Indicates whether the authorized Service Specific authoraton data is still valid or not.
true: the authorized Service Specific authoraton data is not valid.
false or absent: the authorized Service Specific authoraton data is valid. | +| invalidCause | InvalidCause | O | 0..1 | This IE may be included when invalidityInd IE is included with the value true.

When present, this IE shall indicate the cause why the authorization becomes invalid. | + +##### 6.8.6.2.4 Type: ServiceSpecificAuthorizationInfo + +Table 6.8.6.2.4-1: Definition of type ServiceSpecificAuthorizationInfo + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| snssai | Snssai | C | 0..1 | This IE shall be included for following service type(s):
- AF_GUIDANCE_FOR_URSP
When present, this IE shall indicate the Single Network Slice Selection Assistance Information for the Service Specific authorization. (NOTE 2) | +| dnn | Dnn | C | 0..1 | This IE shall be included for following service type(s):
- AF_GUIDANCE_FOR_URSP
When present, this IE shall indicate the DNN for the Service Specific authorization, shall contain the Network Identifier only. (NOTE 2) | +| mtcProviderInformation | MtcProviderInformation | C | 0..1 | This IE shall be included if available.
When present, this IE shall indicate the MTC provider information for the Service Specific authorization. | +| authUpdateCallbackUri | Uri | O | 0..1 | A URI provided by NEF to receive (implicitly subscribed) notifications on authorization data update.
The authUpdateCallbackUri URI shall have unique information within NEF to identify the authorized result.
(NOTE 1) | +| aflid | string | O | 0..1 | When present, indicates the string identifying the originating AF. | +| neflid | Nefld | O | 0..1 | When present, this IE shall contain the ID of the requesting NEF. | + +NOTE 1: The NEF should always include the authUpdateCallbackUri IE to receive the change of Service Specific Authorization Data from the UDM. +NOTE 2: The Snssai and Dnn are allocated for PIN when AF provides application guidance for URSP determination for PIN service. + +##### 6.8.6.2.5 Type: ServicepecificAuthorizationData + +Table 6.8.6.2.5x-1: Definition of type ServiceSpecificAuthorizationData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| authorizationUeld | AuthorizationUeld | C | 0..1 | This IE shall be present for the service specific authorisation of the individual UE. | +| extGroupId | ExternalGroupId | C | 0..1 | This IE shall be present for the service specific authorisation of the group of UEs. | +| IntGroupId | GroupId | C | 0..1 | This IE shall be present for the service specific authorisation of the group of UEs.

When present, this IE shall indicate the Internal Group identifier mapped from the External Group Identifier indicated by extGroupId IE. | +| authId | string | C | 0..1 | This IE shall be included in a successful Service Specific Authorization response.

When present, this IE shall indicate the Id of the Service Specific Authorization. | + +##### 6.8.6.2.6 Type: AuthorizationUeld + +**Table 6.8.6.2.6-1: Definition of type AuthorizationUeld** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| supi | Supi | M | 1 | | +| gpsi | Gpsi | O | 0..1 | | + +##### 6.8.6.2.7 Type: ServicepecificAuthorizationRemoveData + +**Table 6.8.6.2.7-1: Definition of type ServiceSpecificAuthorizationRemoveData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------| +| authId | string | M | 1 | Indicates the Id of the authorization of specific service's configuration to be removed. | + +#### 6.8.6.3 Simple data types and enumerations + +##### 6.8.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.8.6.3.2 Enumeration: ServiceType + +**Table 6.8.6.3.2-1: Enumeration ServiceType** + +| Enumeration value | Description | +|------------------------|---------------------------------------------------| +| "AF_GUIDANCE_FOR_URSP" | AF guidance for URSP allowed for the subscription | + +##### 6.8.6.3.3 Enumeration: InvalidCause + +**Table 6.8.6.3.2-1: Enumeration InvalidCause** + +| Enumeration value | Description | +|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| "SUBSCRIPTION_WITHDRAWAL" | Indicates that the authorization becomes invalid due to UE Subscription withdrawal. | +| "DNN_REMOVED" | Indicates that the authorization becomes invalid because the DNN associated to the authorization is removed from UE subscription. | +| "SLICE_REMOVED" | Indicates that the authorization becomes invalid because the Slice associated to the authorization is removed from UE subscription. | +| "AUTHORIZATION_REVOKED" | Indicates that the authorization is revoked at the UDM. | + +### 6.8.7 Error Handling + +#### 6.8.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.8.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.8.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_ServiceSpecificAuthorization service. The following application errors listed in Table 6.8.7.3-1 are specific for the Nudm\_ServiceSpecificAuthorization service. + +**Table 6.8.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------------|------------------|-------------------------------------------------------------------------------------------------| +| UNKNOWN_5GS_SUBSCRIPTION | 403 Forbidden | No 5GS subscription is associated with the user. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| DNN_NOT_ALLOWED | 403 Forbidden | DNN not authorized for the user | +| MTC_PROVIDER_NOT_ALLOWED | 403 Forbidden | MTC Provider not authorized | +| AF_INSTANCE_NOT_ALLOWED | 403 Forbidden | This AF instance is not authorized | +| SNSSAI_NOT_ALLOWED | 403 Forbidden | This SNSSAI is not authorized to this user | +| SERVICE_TYPE_NOT_ALLOWED | 403 Forbidden | This serviceType is not authorized to this user. | +| CONTEXT_NOT_FOUND | 404 Not Found | It is used when no corresponding context exists. | +| AUTHORIZATION_NOT_FOUND | 404 Not Found | The authorization for specific service's configuration to be removed does not exist in the UDM. | + +### 6.8.8 Feature Negotiation + +The optional features in table 6.8.8-1 are defined for the Nudm\_SSAU API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.8.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.8.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nudm\_SSAU API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nudm\_SSAU API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudm\_SSAU service. + +The Nudm\_SSAU API defines a single scope "nudm-ssau" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +### 6.8.10 HTTP redirection + +An HTTP request may be redirected to a different UDM service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UDM producer instance will return the NF Instance ID of the new UDM producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UDM redirects a service request to a different UDM using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UDM towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.9 Nudm\_ReportSMDeliveryStatus Service API + +### 6.9.1 API URI + +The Nudm\_ReportSMDeliveryStatus service shall use the Nudm\_RSDS API. + +The API URI of the Nudm\_RSDS API shall be: + +**{apiRoot}
** + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nudm-rsds". +- The shall be "v1". +- The shall be set as described in clause 6.8.3. + +### 6.9.2 Usage of HTTP + +#### 6.9.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [13], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nudm\_ReportSMDeliveryStatus service shall comply with the OpenAPI [14] specification contained in Annex A.9. + +#### 6.9.2.2 HTTP standard headers + +##### 6.9.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.9.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 9457 [16]) signalled by the content type "application/problem+json" + +#### 6.9.2.3 HTTP custom headers + +##### 6.9.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.9.3 Resources + +#### 6.9.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.9.3.1-1 depicts the resource URIs structure for the Nudm\_RSDS API. + +![](0997dbaa9dfecedd60029d70b53327b8_img.jpg) + +``` + +//{apiRoot}/nudm-rsds/v1 +└── /{ueIdentity} + └── /smdelivery-report-status + +``` + +**Figure 6.9.3.1-1: Resource URI structure of the nudm-rsds API** + +Table 6.9.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.9.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|-----------------------------|----------------------------------|---------------------------------|--------------------------------| +| SmDeliveryStatus (Document) | /{ueidentity}/sm-delivery-status | sm-delivery-status (POST) | Report the SM-Delivery Status. | + +#### 6.9.3.2 Resource: SmDeliveryStatus (Document) + +##### 6.9.3.2.1 Description + +This resource represents the SM-Delivery Status for a GPSI. + +##### 6.9.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nudm-rsds//{ueIdentity}/sm-delivery-status + +This resource shall support the resource URI variables defined in table 6.9.3.2.2-1. + +**Table 6.9.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.8.1 | +| ueIdentity | string | Represents the GPSI (see 3GPP TS 23.501 [2] clause 7.2.5)
pattern: "^(msisdn-[0-9]{5,15} extid-[^@]+\@[^\@]+\+ extgroupid-[^@]+\@[^\@]+\+ .+)\$" | + +##### 6.9.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +##### 6.9.3.2.4 Resource Custom Operations + +###### 6.9.3.2.4.1 Overview + +**Table 6.9.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|--------------------|----------------------------------|--------------------|--------------------------------| +| sm-delivery-status | /{ueIdentity}/sm-delivery-status | POST | Report the SM-Delivery Status. | + +###### 6.9.3.2.4.2 Operation: sm-delivery-status + +###### 6.9.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (SMS-GMSC, IP-SM-GW) to report the SM-Delivery Status to UDM for the GPSI. + +###### 6.9.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.9.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.9.3.2.4.2.2-2. + +**Table 6.9.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------| +| SmDeliveryStatus | M | 1 | This IE shall indicate the SM-Delivery Status. | + +**Table 6.9.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| NOTE: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +### 6.9.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nudm\_ReportSMDeliveryStatus Service. + +### 6.9.5 Notifications + +In this release of this specification, no notifications are defined for the Nudm\_ReportSMDeliveryStatus Service. + +### 6.9.6 Data Model + +#### 6.9.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.9.6.1-1 specifies the structured data types defined for the Nudm\_RSDS service API. For simple data types defined for the Nudm\_RSDS service API see table 6.9.6.3.2-1. + +**Table 6.9.6.1-1: Nudm\_RSDS specific Data Types** + +| Data type | Clause defined | Description | +|------------------|-----------------------|---------------------------| +| SmDeliveryStatus | 6.9.6.2.2 | SM Delivery Status-Report | + +Table 6.9.6.1-2 specifies data types re-used by the Nudm\_RSDS service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudm\_RSDS service API. + +**Table 6.9.6.1-2: Nudm\_RSDS re-used Data Types** + +| Data type | Reference | Comments | +|------------------|--------------------|----------------------------------------| +| Gpsi | 3GPP TS 29.571 [7] | Generic Public Subscription Identifier | + +#### 6.9.6.2 Structured data types + +##### 6.9.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.9.6.2.2 Type: SmDeliveryStatus + +**Table 6.9.6.2.2-1: Definition of type SmDeliveryStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|------------------|----------|--------------------|---------------------------------------------------------------| +| gpsi | Gpsi | M | 1 | Generic Public Subscription Identifier | +| smStatusReport | string | M | 1 | Indicates SMS-STATUS-REPORT as defined in 3GPP TS 23.040 [53] | + +#### 6.9.6.3 Simple data types and enumerations + +##### 6.9.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 6.9.7 Error Handling + +#### 6.9.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.9.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.9.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_ReportSMDeliveryStatus service. The following application errors listed in Table 6.8.7.3-1 are specific for the Nudm\_ReportSMDeliveryStatus service. + +**Table 6.9.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------------|-------------------------|--------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The provided subscriber identifier is not found. | + +### 6.9.8 Feature Negotiation + +The optional features in table 6.9.8-1 are defined for the Nudm\_RSDS API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.9.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|-----------------------|---------------------|--------------------| +| | | | + +### 6.9.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nudm\_RSDS API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nudm\_RSDS API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudm\_RSDS service. + +The Nudm\_RSDS API defines a single scope "nudm-rsds" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +### 6.9.10 HTTP redirection + +An HTTP request may be redirected to a different UDM service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different UDM producer instance will return the NF Instance ID of the new UDM producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UDM redirects a service request to a different UDM using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UDM towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.10 Nudm\_UEIdentifier Service API + +### 6.10.1 API URI + +The Nudm\_UEIdentifier service shall use the Nudm\_UEID API. + +The API URI of the Nudm\_UEID API shall be: + +**{apiRoot}//** + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nudm-ueid". +- The shall be "v1". +- The shall be set as described in clause 6.8.3. + +### 6.10.2 Usage of HTTP + +#### 6.10.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [13], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nudm\_UEIdentifier service shall comply with the OpenAPI [14] specification contained in Annex A.11. + +#### 6.10.2.2 HTTP standard headers + +##### 6.10.2.2.1 General + +The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.10.2.2.2 Content type + +The following content types shall be supported: + +JSON, as defined in IETF RFC 8259 [15], signalled by the content type "application/json". + +The Problem Details JSON Object (IETF RFC 9457 [16]) signalled by the content type "application/problem+json" + +#### 6.10.2.3 HTTP custom headers + +##### 6.10.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.10.3 Resources + +#### 6.10.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.10.3.1-1 depicts the resource URIs structure for the Nudm\_UEID API. + +![](65e8c0628536d6d4245e9ab46ba070c3_img.jpg) + +``` + +//{apiRoot}/nudm-ueid/v1 +└── /deconceal + +``` + +**Figure 6.10.3.1-1: Resource URI structure of the nudm-ueid API** + +Table 6.10.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.10.3.1-1: Resources and methods overview** + +| Resource name (Archetype) | Resource URI | HTTP method or custom operation | Description | +|---------------------------|--------------|---------------------------------|-------------| +| | | | | + +There is no resource defined for the Nudm\_UEIdentifier Service. + +### 6.10.4 Custom Operations without associated resources + +#### 6.10.4.1 Overview + +**Table 6.10.4.1-1: Custom operations without associated resources** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|------------------------| +| Deconceal | /deconceal | POST | Deconceal SUCI to SUPI | + +#### 6.10.4.2 Operation: Deconceal + +##### 6.10.4.2.1 Description + +This custom operation is used by the NF service consumer (i.e. 5G PKMF) to deconceal the SUCI of the 5G ProSe Remote UE to the SUPI. + +##### 6.10.4.2.2 Operation Definition + +This operation shall support the data structures and response codes specified in tables 6.10.4.2.2-1 and 6.10.4.2.2-2. + +**Table 6.10.4.2.2-1: Data structures supported by the Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------------------------------------| +| DeconcealReqData | M | 1 | Deconceal request data, including the SUCI of the UE to be deconcealed. | + +**Table 6.10.4.2.2-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|----------|--------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| DeconcealRspData | M | 1 | 200 OK | Upon success, the response data contain the SUPI of the UE that deconcealed from the input SUCI. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- INVALID_HN_PUBLIC_KEY_IDENTIFIER
- INVALID_SCHEME_OUTPUT | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 501 Not implemented | The "cause" attribute may be used to indicate one of the following application errors:
- UNSUPPORTED_PROTECTION_SCHEME | + +### 6.10.5 Notifications + +In this release of this specification, no notifications are defined for the Nudm\_UEIdentifier Service. + +### 6.10.6 Data Model + +#### 6.10.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.10.6.1-1 specifies the structured data types defined for the Nudm\_UEID service API. For simple data types defined for the Nudm\_UEID service API see table 6.10.6.3.2-1. + +**Table 6.10.6.1-1: Nudm\_UEID specific Data Types** + +| Data type | Clause defined | Description | +|------------------|-----------------------|-------------------------| +| DeconcealReqData | 6.10.6.2.2 | Deconceal Request Data | +| DeconcealRspData | 6.10.6.2.3 | Deconceal Response Data | + +Table 6.10.6.1-2 specifies data types re-used by the Nudm\_UEID service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudm\_UEID service API. + +**Table 6.10.6.1-2: Nudm\_UEID re-used Data Types** + +| Data type | Reference | Comments | +|------------------|---------------------|-----------------------------------| +| Suci | 3GPP TS 29.509 [24] | Subscription Concealed Identifier | +| Supi | 3GPP TS 29.571 [7] | Subscription Permanent Identifier | + +#### 6.10.6.2 Structured data types + +##### 6.10.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.10.6.2.2 Type: DeconcealReqData + +**Table 6.10.6.2.2-1: Definition of type DeconcealReqData** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|------------------|----------|--------------------|--------------------------------------------------| +| suci | Suci | M | 1 | This IE shall contain the SUCI to be deconcealed | + +##### 6.10.6.2.3 Type: DeconcealRspData + +**Table 6.10.6.2.2-1: Definition of type DeconcealRspData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------| +| supi | Supi | M | 1 | This IE shall contain the SUPI that is deconcealed from the input SUCI. | + +#### 6.10.6.3 Simple data types and enumerations + +##### 6.10.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 6.10.7 Error Handling + +### 6.10.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.10.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.10.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nudm\_UEIdentifier service. The following application errors listed in Table 6.8.7.3-1 are specific for the Nudm\_UEIdentifier service. + +**Table 6.10.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------|---------------------|----------------------------------------------------------| +| INVALID_HN_PUBLIC_KEY_IDENTIFIER | 403 Forbidden | Invalid HN public key identifier received | +| INVALID_SCHEME_OUTPUT | 403 Forbidden | SUCI cannot be decrypted with received data | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| UNSUPPORTED_PROTECTION_SCHEME | 501 Not implemented | The received protection scheme is not supported by HPLMN | + +### 6.10.8 Feature Negotiation + +The optional features in table 6.10.8-1 are defined for the Nudm\_UEID API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.10.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.10.9 Security + +As indicated in 3GPP TS 33.501 [6] and 3GPP TS 29.500 [4], the access to the Nudm\_UEID API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [18]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [19]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nudm\_UEID API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [19], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudm\_UEID service. + +The Nudm\_UEID API defines a single scope "nudm-ueid" for OAuth2 authorization (as specified in 3GPP TS 33.501 [6]) for the entire API, and it does not define any additional scopes at resource or operation level. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nudm Service API(s). It consists of OpenAPI 3.0.0 specifications, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [30]). + +## --- A.2 Nudm\_SDM API + +``` +openapi: 3.0.0 + +info: + version: '2.3.0-alpha.5' + title: 'Nudm_SDM' + description: | + Nudm Subscriber Data Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.503 Unified Data Management Services, version 18.4.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' + +servers: + - url: '{apiRoot}/nudm-sdm/v2' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: +``` + +``` +- nudm-sdm +- {} + +paths: + /{supi}: + get: + summary: retrieve multiple data sets + operationId: GetDataSets + tags: + - Retrieval of multiple data sets + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:multi-data-sets:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: dataset-names + in: query + style: form + explode: false + description: List of dataset names + required: true + schema: + $ref: '#/components/schemas/DatasetNames' + - name: plmn-id + in: query + description: serving PLMN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: adjacent-plmns + in: query + description: List of PLMNs adjacent to the UE's serving PLMN + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + - name: single-nssai + in: query + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + - name: dnn + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: uc-purpose + in: query + description: User consent purpose + schema: + $ref: '#/components/schemas/UcPurpose' + - name: disaster-roaming-ind + in: query + description: Indication whether Disaster Roaming service is applied or not + required: false + schema: + type: boolean + default: false + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header +``` + +``` + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionDataSets' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{supi}/nssai: + get: + summary: retrieve a UE's subscribed NSSAI + operationId: GetNSSAI + tags: + - Slice Selection Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:nssai:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: serving PLMN ID + content: +``` + +``` + + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +- name: disaster-roaming-ind + in: query + description: Indication whether Disaster Roaming service is applied or not + required: false + schema: + type: boolean + default: false +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/Nssai' +headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +/{supi}/ue-context-in-amf-data: + get: + summary: retrieve a UE's UE Context In AMF Data + operationId: GetUeCtxInAmfData + tags: + - UE Context In AMF Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:ue-context-in-amf-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + +``` + +``` + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextInAmfData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{supi}/am-data: + get: + summary: retrieve a UE's Access and Mobility Subscription Data + operationId: GetAmData + tags: + - Access and Mobility Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:am-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: Serving PLMN ID or SNPN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + - name: adjacent-plmns + in: query + description: List of PLMNs adjacent to the UE's serving PLMN + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + - name: disaster-roaming-ind +``` + +``` +in: query +description: Indication whether Disaster Roaming service is applied or not +required: false +schema: + type: boolean + default: false +- name: shared-data-ids + in: query + description: > + List of IDs identifying shared Access and Mobility Subscription Data already + available at the NF service consumer + schema: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + style: form + explode: false +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AccessAndMobilitySubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{supi}/am-data/ecr-data: + get: + summary: retrieve a UE's subscribed Enhanced Coverage Restriction Data + operationId: GetEcrData + tags: + - Enhanced Coverage Restriction Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm +``` + +``` + +- oAuth2ClientCredentials: +- nudm-sdm +- nudm-sdm:ecr-data:read +parameters: +- name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string +responses: +'200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedCoverageRestrictionData' +headers: +Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string +ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string +Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'466': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +/{supi}/smf-select-data: +get: + summary: retrieve a UE's SMF Selection Subscription Data + operationId: GetSmfSelData + tags: + - SMF Selection Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + +``` + +``` + - nudm-sdm:smf-select-data:read +parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: serving PLMN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + - name: disaster-roaming-ind + in: query + description: Indication whether Disaster Roaming service is applied or not + required: false + schema: + type: boolean + default: false + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmfSelectionSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +``` + +``` +/{supi}/ue-context-in-smf-data: + get: + summary: retrieve a UE's UE Context In SMF Data + operationId: GetUeCtxInSmfData + tags: + - UE Context In SMF Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:ue-context-in-smf-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextInSmfData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{supi}/ue-context-in-smsf-data: + get: + summary: retrieve a UE's UE Context In SMSF Data + operationId: GetUeCtxInSmsfData + tags: + - UE Context In SMSF Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:ue-context-in-smsf-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: +``` + +``` +'200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeContextInSmsfData' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +/{supi}/trace-data: + get: + summary: retrieve a UE's Trace Configuration Data + operationId: GetTraceConfigData + tags: + - Trace Configuration Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:trace-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: serving PLMN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/TraceDataResponse' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 +``` + +``` + + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{supi}/sm-data: + get: + summary: retrieve a UE's Session Management Subscription Data + operationId: GetSmData + tags: + - Session Management Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sm-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: single-nssai + in: query + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + - name: dnn + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: plmn-id + in: query + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + - name: disaster-roaming-ind + in: query + description: Indication whether Disaster Roaming service is applied or not + required: false + schema: + type: boolean + +``` + +``` + + default: false + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmSubsData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + /{supi}/sms-data: + get: + summary: retrieve a UE's SMS Subscription Data + operationId: GetSmsData + tags: + - SMS Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sms-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + +``` + +``` +in: query +content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsSubscriptionData' +headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +/{supi}/sms-mng-data: +get: + summary: retrieve a UE's SMS Management Subscription Data + operationId: GetSmsMngtData + tags: + - SMS Management Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sms-mng-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query +``` + +``` + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: plmn-id + in: query + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsManagementSubscriptionData' +headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{ueId}/lcs-privacy-data: + get: + summary: retrieve a UE's LCS Privacy Subscription Data + operationId: GetLcsPrivacyData + tags: + - LCS Privacy Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:lcs-privacy-data:read + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LcsPrivacyData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{supi}/lcs-mo-data: + get: + summary: retrieve a UE's LCS Mobile Originated Subscription Data + operationId: GetLcsMoData + tags: + - LCS Mobile Originated Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:lcs-mo-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LcsMoData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +``` + +``` + +default: + description: Unexpected error +/{supi}/lcs-bca-data: + get: + summary: retrieve a UE's LCS Broadcast Assistance Data Types Subscription Data + operationId: GetLcsBcaData + tags: + - LCS Broadcast Assistance Data Types Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:lcs-bca-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LcsBroadcastAssistanceTypesData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + +``` + +``` +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{supi}/lcs-subscription-data: + get: + summary: retrieve a UE's LCS Subscription Data + operationId: GetLcsSubscriptionData + tags: + - LCS Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:lcs-subscription-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LcsSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{supi}/v2x-data: + get: + summary: retrieve a UE's V2X Subscription Data + operationId: GetV2xData + tags: + - V2X Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:v2x-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/V2xSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{supi}/prose-data: + get: + summary: retrieve a UE's ProSe Subscription Data + operationId: GetProseData + tags: + - Prose Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:prose-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ProseSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{supi}/5mbs-data: + get: + summary: retrieve a UE's 5MBS Subscription Data + operationId: GetMbsData + tags: + - 5MBS Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:5mbs-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/MbsSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +``` + +``` + default: + description: Unexpected error + +/{supi}/uc-data: + get: + summary: retrieve a UE's User Consent Subscription Data + operationId: GetUcData + tags: + - User Consent Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:uc-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: uc-purpose + in: query + description: User consent purpose + schema: + $ref: '#/components/schemas/UcPurpose' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UcSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +``` + +``` + + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/sdm-subscriptions: + post: + summary: subscribe to notifications + operationId: Subscribe + tags: + - Subscription Creation + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sdm-subscriptions:create + parameters: + - name: ueId + in: path + description: Identity of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: shared-data-ids + in: query + description: > + List of IDs identifying shared Data already available at and + subscribed by the NF service consumer + schema: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + style: form + explode: false + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SdmSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SdmSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudm-sdm/{apiVersion}/{ueId}/sdm-subscriptions/{subscriptionId}' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + +``` + +``` +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +callbacks: + datachangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + dataRestorationNotification: + '{request.body#/dataRestorationCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/DataRestorationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/sdm-subscriptions/{subscriptionId}: + delete: +``` + +``` +summary: unsubscribe from notifications +operationId: Unsubscribe +tags: + - Subscription Deletion +security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sdm-subscriptions:modify +parameters: + - name: ueId + in: path + description: Identity of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subscriptionId + in: path + description: Id of the SDM Subscription + required: true + schema: + type: string +responses: + '204': + description: Successful response + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +patch: + summary: modify the subscription + operationId: Modify + tags: + - Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sdm-subscriptions:modify + parameters: + - name: ueId + in: path + description: Identity of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subscriptionId + in: path + description: Id of the SDM Subscription + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/merge-patch+json: +``` + +``` + schema: + $ref: '#/components/schemas/SdmSubsModification' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SdmSubscription' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{ueId}/id-translation-result: + get: + summary: retrieve a UE's SUPI or GPSI + operationId: GetSupiOrGpsi + tags: + - GPSI to SUPI Translation or SUPI to GPSI translation + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:id-translation-result:read + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: af-id + in: query + description: AF identifier + schema: + type: string + - name: app-port-id + in: query + description: Application port identifier + content: + application/json: + schema: + $ref: '#/components/schemas/AppPortId' + - name: af-service-id + in: query + description: AF Service Identifier + schema: + type: string +``` + +``` +- name: mtc-provider-info + in: query + description: MTC Provider Information + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' +- name: requested-gpsi-type + in: query + description: Requested GPSI Type + schema: + $ref: '#/components/schemas/GpsiType' +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/IdTranslationResult' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{supi}/am-data/sor-ack: + put: + summary: Nudm_Sdm_Info service operation + operationId: SorAckInfo + tags: + - Providing acknowledgement of Steering of Roaming + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:sor-ack:write + parameters: + - name: supi + in: path + description: Identifier of the UE +``` + +``` + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcknowledgeInfo' +responses: + '204': + description: Successful acknowledgement + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{supi}/am-data/upu-ack: +``` + +``` +put: + summary: Nudm_Sdm_Info for UPU service operation + operationId: UpuAck + tags: + - Providing acknowledgement of UE Parameters Update + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:upu-ack:write + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcknowledgeInfo' + responses: + '204': + description: Successful acknowledgement + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{supi}/am-data/subscribed-snssais-ack: + put: + summary: Nudm_Sdm_Info operation for S-NSSAIs acknowledgement + operationId: S-NSSAIs Ack + tags: + - Providing acknowledgement of S-NSSAIs Update + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:subscribed-nssais-ack:write + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcknowledgeInfo' + responses: + '204': +``` + +``` + description: Successful acknowledgement + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{supi}/am-data/cag-ack: + put: + summary: Nudm_Sdm_Info operation for CAG acknowledgement + operationId: CAG Ack + tags: + - Providing acknowledgement of CAG Update + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:cag-ack:write + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcknowledgeInfo' + responses: + '204': + description: Successful acknowledgement + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{supi}/am-data/update-sor: + post: + summary: Nudm_Sdm custom operation to trigger SOR info update + operationId: Update SOR Info + tags: + - Trigger SOR info update + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:update-sor:invoke + parameters: + - name: supi + in: path + description: Identifier of the UE +``` + +``` + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SorUpdateInfo' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SorInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/shared-data: + get: + summary: retrieve shared data + operationId: GetSharedData + tags: + - Retrieval of shared data + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:shared-data:read + parameters: + - name: shared-data-ids + in: query + description: List of shared data ids + required: true + style: form + explode: false + schema: + $ref: '#/components/schemas/SharedDataIds' + - name: supportedFeatures + in: query + deprecated: true + description: Supported Features; this query parameter should not be used + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since +``` + +``` +in: header +description: Validator for conditional requests, as described in RFC 9110, 3.3 +schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SharedData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/shared-data-subscriptions: + post: + summary: subscribe to notifications for shared data + operationId: SubscribeToSharedData + tags: + - Subscription Creation for shared data + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:shared-data-subscriptions:create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SdmSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SdmSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudm-sdm//shared-data-subscriptions/{subscriptionId}' + required: true +``` + +``` + + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + dataChangeNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ModificationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/shared-data-subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications for shared data + operationId: UnsubscribeForSharedData + tags: + - Subscription Deletion for shared data + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + +``` + +``` + + - nudm-sdm + - nudm-sdm:shared-data-subscriptions:modify +parameters: + - name: subscriptionId + in: path + description: Id of the Shared data Subscription + required: true + schema: + type: string +responses: + '204': + description: Successful response + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +patch: + summary: modify the subscription + operationId: ModifySharedDataSubs + tags: + - Subscription Modification + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:shared-data-subscriptions:modify +parameters: + - name: subscriptionId + in: path + description: Id of the SDM Subscription + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SdmSubsModification' + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SdmSubscription' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/group-data/group-identifiers: + get: + summary: Mapping of Group Identifiers + operationId: GetGroupIdentifiers + tags: + - Group Identifiers + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:group-identifiers:read + parameters: + - name: ext-group-id + in: query + description: External Group Identifier + required: false + schema: + $ref: '#/components/schemas/ExtGroupId' + - name: int-group-id + in: query + description: Internal Group Identifier + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + - name: ue-id-ind + in: query + description: Indication whether UE identifiers are required or not + required: false + schema: + type: boolean + default: false + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: af-id + in: query + description: AF identifier + schema: + type: string + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/GroupIdentifiers' + headers: + Cache-Control: +``` + +``` + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/shared-data/{sharedDataId}: + get: + summary: retrieve the individual shared data + operationId: GetIndividualSharedData + tags: + - Retrieval of the individual shared data + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:shared-data:read + parameters: + - name: sharedDataId + in: path + description: Id of the Shared data + required: true + schema: + $ref: '#/components/schemas/SharedDataIds' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SharedData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 +``` + +``` + + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/multiple-identifiers: + get: + summary: Mapping of UE Identifiers + operationId: GetMultipleIdentifiers + tags: + - Multiple Identifiers + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:multiple-identifiers:read + parameters: + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: gpsi-list + in: query + description: list of the GPSIs + required: true + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + style: form + explode: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UEIdentifiers' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + +``` + +``` + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{supi}/time-sync-data: + get: + summary: retrieve a UE's Time Synchronization Subscription Data + operationId: GetTimeSyncSubscriptionData + tags: + - Time Sync Subscription Data Retrieval + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSyncSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +``` + +``` +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{supi}/ranging-slpos-data: + get: + summary: retrieve a UE's Ranging and Sidelink Positioning Subscription Data + operationId: GetRangingSlPosData + tags: + - Ranging and Sidelink Positioning Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:ranging-slpos:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/RangingSlPosSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{supi}/a2x-data: + get: + summary: retrieve a UE's A2X Subscription Data + operationId: GetA2xData + tags: + - A2X Subscription Data Retrieval + security: + - {} + - oAuth2ClientCredentials: + - nudm-sdm + - oAuth2ClientCredentials: + - nudm-sdm + - nudm-sdm:a2x-data:read + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/A2xSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, 2.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 2.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +``` + +``` +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudm-sdm: Access to the nudm-sdm API + nudm-sdm:multi-data-sets:read: Access to read multiple data sets + nudm-sdm:nssai:read: Access to read NSSAI + nudm-sdm:ue-context-in-amf-data:read: Access to read UE context in AMF data + nudm-sdm:am-data:read: Access to read Access and Mobility Subscription data + nudm-sdm:ecr-data:read: Access to read ECR data + nudm-sdm:smf-select-data:read: Access to read SMF Selection data + nudm-sdm:ue-context-in-smf-data:read: Access to read UE context in SMF data + nudm-sdm:ue-context-in-smf-data:read: Access to read UE context in SMSF data + nudm-sdm:trace-data:read: Access to read Trace data + nudm-sdm:sm-data:read: Access to read Session Management data + nudm-sdm:sms-data:read: Access to read SMS data + nudm-sdm:sms-mng-data:read: Access to read SMS Management data + nudm-sdm:lcs-privacy-data:read: Access to read LCS privacy data + nudm-sdm:lcs-mo-data:read: Access to read LCS MO data + nudm-sdm:lcs-subscription-data:read: Access to read (other) LCS Subscription data + nudm-sdm:lcs-bca-data:read: Access to read LCS BCA data + nudm-sdm:v2x-data:read: Access to read V2X data + nudm-sdm:prose-data:read: Access to read Prose data + nudm-sdm:5mbs-data:read: Access to read 5MBS data + nudm-sdm:uc-data:read: Access to read User Consent data + nudm-sdm:sdm-subscriptions:create: Access create SDM subscriptions + nudm-sdm:sdm-subscriptions:modify: Access to update SDM subscriptions + nudm-sdm:id-translation-result:read: Access to read ID Translation Results + nudm-sdm:sor-ack:write: Access to write SOR acknowledgements + nudm-sdm:upu-ack:write: Access to write UPU acknowledgements + nudm-sdm:subscribed-nssais-ack:write: Access to write Subscribed NSSAIs acknowledgements + nudm-sdm:cag-ack:write: Access to write CAG acknowledgements + nudm-sdm:update-sor:invoke: Access to invoke SOR info update + nudm-sdm:shared-data:read: Access to read Shared Data + nudm-sdm:shared-data-subscriptions:create: Access to create shared data subscriptions + nudm-sdm:shared-data-subscriptions:modify: Access to update shared data subscriptions + nudm-sdm:group-identifiers:read: Access to read Group Identifiers + nudm-sdm:multiple-identifiers:read: Access to read multiple Identifiers + nudm-sdm:ranging-slpos-data:read: Access to read Ranging and Sidelink Positioning data + nudm-sdm:a2x-data:read: Access to read A2X data + +schemas: + +# COMPLEX TYPES: + +DataSetNames: + type: array + items: + $ref: '#/components/schemas/DataSetName' + minItems: 2 + uniqueItems: true + +SubscriptionDataSets: + type: object + properties: + amData: + $ref: '#/components/schemas/AccessAndMobilitySubscriptionData' + smfSelData: + $ref: '#/components/schemas/SmfSelectionSubscriptionData' + uecAmfData: + $ref: '#/components/schemas/UeContextInAmfData' +``` + +``` +uecSmfData: + $ref: '#/components/schemas/UeContextInSmfData' +uecSmsfData: + $ref: '#/components/schemas/UeContextInSmsfData' +smsSubsData: + $ref: '#/components/schemas/SmsSubscriptionData' +smData: + $ref: '#/components/schemas/SmSubsData' +traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' +smsMngData: + $ref: '#/components/schemas/SmsManagementSubscriptionData' +lcsPrivacyData: + $ref: '#/components/schemas/LcsPrivacyData' +lcsMoData: + $ref: '#/components/schemas/LcsMoData' +lcsSubscriptionData: + $ref: '#/components/schemas/LcsSubscriptionData' +v2xData: + $ref: '#/components/schemas/V2xSubscriptionData' +lcsBroadcastAssistanceTypesData: + $ref: '#/components/schemas/LcsBroadcastAssistanceTypesData' +proseData: + $ref: '#/components/schemas/ProseSubscriptionData' +mbsData: + $ref: '#/components/schemas/MbsSubscriptionData' +ucData: + $ref: '#/components/schemas/UcSubscriptionData' +a2xData: + $ref: '#/components/schemas/A2xSubscriptionData' + +UeContextInSmsfData: + type: object + properties: +``` + +``` +smmfInfo3GppAccess: + $ref: '#/components/schemas/SmsfInfo' +smmfInfoNon3GppAccess: + $ref: '#/components/schemas/SmsfInfo' + +SmsfInfo: + type: object + required: + - smsfInstanceId + - plmnId + properties: + smsfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + smsfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + +AccessAndMobilitySubscriptionData: + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + gsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + hssGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + internalGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + sharedVnGroupDataIds: + description: A map(list of key-value pairs) where GroupId serves as key of SharedDataId + type: object + additionalProperties: + $ref: '#/components/schemas/SharedDataId' + minProperties: 1 + subscribedUeAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmbrRm' + nssai: + $ref: '#/components/schemas/Nssai' + ratRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true + forbiddenAreas: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Area' + serviceAreaRestriction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' + coreNetworkTypeRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CoreNetworkType' + accessTypeRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + maxItems: 2 + rfspIndex: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RfspIndexRm' + subsRegTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + ueUsageType: + $ref: '#/components/schemas/UeUsageType' + mpsPriority: + $ref: '#/components/schemas/MpsPriorityIndicator' + mcsPriority: + $ref: '#/components/schemas/McsPriorityIndicator' + activeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + sorInfo: +``` + +``` +$ref: '#/components/schemas/SorInfo' +sorInfoExpectInd: + type: boolean +sorafRetrieval: + type: boolean + default: false +sorUpdateIndicatorList: + type: array + items: + $ref: '#/components/schemas/SorUpdateIndicator' + minItems: 1 +upuInfo: + $ref: '#/components/schemas/UpuInfo' +routingIndicator: + type: string + pattern: '^[0-9]{1,4}$' +micoAllowed: + $ref: '#/components/schemas/MicoAllowed' +sharedAmDataIds: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + minItems: 1 +odbPacketServices: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OdbPacketServices' +subscribedDnnList: + type: array + items: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' +serviceGapTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +mdtUserConsent: + $ref: '#/components/schemas/MdtUserConsent' +mdtConfiguration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MdtConfiguration' +traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' +cagData: + $ref: '#/components/schemas/CagData' +stnSr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StnSr' +cMsisdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CMsisdn' +nbIoTUEPriority: + $ref: '#/components/schemas/NbIoTUEPriority' +nssaiInclusionAllowed: + type: boolean + default: false +rgWirelineCharacteristics: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RgWirelineCharacteristics' +aun3DeviceConnectivityAllowed: + type: boolean + default: false +ecRestrictionDataWb: + $ref: '#/components/schemas/EcRestrictionDataWb' +ecRestrictionDataNb: + type: boolean + default: false +expectedUeBehaviourList: + $ref: '#/components/schemas/ExpectedUeBehaviourData' +expectedUeBehaviourData: + description: A map(list of key-value pairs) where a valid JSON pointer serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/ExpectedUeBehaviourData' + minProperties: 1 +primaryRatRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true +secondaryRatRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true +``` + +``` + +edrxParametersList: + type: array + items: + $ref: '#/components/schemas/EdrxParameters' + minItems: 1 +ptwParametersList: + type: array + items: + $ref: '#/components/schemas/PtwParameters' + minItems: 1 +iabOperationAllowed: + type: boolean + default: false +adjacentPlmnRestrictions: + description: A map (list of key-value pairs where PlmnId serves as key) of PlmnRestriction + type: object + additionalProperties: + $ref: '#/components/schemas/PlmnRestriction' + minProperties: 1 +wirelineForbiddenAreas: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WirelineArea' +wirelineServiceAreaRestriction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/WirelineServiceAreaRestriction' +pcfSelectionAssistanceInfos: + type: array + items: + $ref: '#/components/schemas/PcfSelectionAssistanceInfo' + minItems: 1 +aerialUeSubInfo: + $ref: '#/components/schemas/AerialUeSubscriptionInfo' +roamingRestrictions: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RoamingRestrictions' +remoteProvInd: + type: boolean + default: false +3gppChargingCharacteristics: + $ref: '#/components/schemas/3GppChargingCharacteristics' +timeSyncData: + $ref: '#/components/schemas/TimeSyncData' +sharedDataList: + type: array + items: + $ref: '#/components/schemas/SharedData' + minItems: 1 +qmcConfigInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/QmcConfigInfo' +mbsrOperationAllowed: + $ref: '#/components/schemas/MbsrOperationAllowed' +ladnServiceAreas: + description: A map(list of key-value pairs where singleNssai serves as key) of +DnnLadnServiceAreas + type: object + additionalProperties: + $ref: '#/components/schemas/DnnLadnServiceAreas' + +DnnLadnServiceAreas: + type: object + required: + - dnnLadnServiceAreas + properties: + dnnLadnServiceAreas: + type: array + items: + $ref: '#/components/schemas/DnnLadnServiceArea' + minItems: 1 + +DnnLadnServiceArea: + type: object + required: + - dnn + - ladnServiceArea + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + +``` + +``` +ladnServiceArea: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + +TimeSyncData: + type: object + required: + - authorized + properties: + authorized: + type: boolean + uuTimeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + tempVals: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + minItems: 1 + coverageArea: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + clockQualityDetailLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityDetailLevel' + clockQualityAcceptanceCriteria: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ClockQualityAcceptanceCriterion' + minItems: 1 + +PcfSelectionAssistanceInfo: + type: object + required: + - dnn + - singleNssai + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +PlmnRestriction: + type: object + properties: + ratRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true + forbiddenAreas: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Area' + serviceAreaRestriction: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction' + coreNetworkTypeRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CoreNetworkType' + accessTypeRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + maxItems: 2 + primaryRatRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true + secondaryRatRestrictions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + uniqueItems: true +``` + +``` +ProseSubscriptionData: + description: Contains the ProSe Subscription Data. + type: object + properties: + proseServiceAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProseServiceAuth' + nrUePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + proseAllowedPlmn: + type: array + items: + $ref: '#/components/schemas/ProseAllowedPlmn' + minItems: 1 + +ProseAllowedPlmn: + description: Contains the PLMN identities where the Prose services are authorised to use and +the authorised Prose services on this given PLMNs. + type: object + required: + - visitedPlmn + properties: + visitedPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + proseDirectAllowed: + type: array + items: + $ref: '#/components/schemas/ProseDirectAllowed' + minItems: 1 + +CagData: + type: object + required: + - cagInfos + properties: + cagInfos: + description: A map (list of key-value pairs where PlmnId serves as key) of CagInfo + type: object + additionalProperties: + $ref: '#/components/schemas/CagInfo' + conditionalCagInfos: + description: A map (list of key-value pairs where PlmnId serves as key) of CagInfo + type: object + additionalProperties: + $ref: '#/components/schemas/ConditionalCagInfo' + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +CagInfo: + type: object + required: + - allowedCagList + properties: + allowedCagList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CagId' + cagOnlyIndicator: + type: boolean + +SmfSelectionSubscriptionData: + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + subscribedSnssaiInfos: + description: A map(list of key-value pairs) where singleNssai serves as key of SnssaiInfo + type: object + additionalProperties: + $ref: '#/components/schemas/SNSSAIInfo' + sharedSnssaiInfosId: + $ref: '#/components/schemas/SharedDataId' + hssGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + +SnssaiInfo: + type: object + required: +``` + +``` + - dnnInfos +properties: + dnnInfos: + type: array + items: + $ref: '#/components/schemas/DnnInfo' + minItems: 1 + +DnnInfo: + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + defaultDnnIndicator: + $ref: '#/components/schemas/DnnIndicator' + lboRoamingAllowed: + $ref: '#/components/schemas/LboRoamingAllowed' + iwkEpsInd: + $ref: '#/components/schemas/IwkEpsInd' + dnnBarred: + type: boolean + invokeNefInd: + type: boolean + smfList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + sameSmfInd: + type: boolean + hrSboAllowed: + type: boolean + default: false + +Nssai: + type: object + required: + - defaultSingleNssais + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + defaultSingleNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + singleNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + additionalSnssaiData: + description: A map(list of key-value pairs) where singleNssai serves as key of +AdditionalSnssaiData + type: object + additionalProperties: + $ref: '#/components/schemas/AdditionalSnssaiData' + minProperties: 1 + suppressNsrrgInd: + type: boolean + nullable: true + +UeContextInAmfData: + type: object + properties: + epsInterworkingInfo: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/EpsInterworkingInfo' + amfInfo: + description: AMF information + type: array + items: + $ref: '#/components/schemas/AmfInfo' +``` + +``` + minItems: 1 + maxItems: 2 + +UeContextInSmfData: + type: object + properties: + pduSessions: + description: A map (list of key-value pairs where PduSessionId serves as key) of +PduSessions + type: object + additionalProperties: + $ref: '#/components/schemas/PduSession' + pgwInfo: + type: array + items: + $ref: '#/components/schemas/PgwInfo' + minItems: 1 + emergencyInfo: + $ref: '#/components/schemas/EmergencyInfo' + +EmergencyInfo: + type: object + oneOf: + - required: + - pgwFqdn + - required: + - pgwIpAddress + properties: + pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pgwIpAddress: + $ref: '#/components/schemas/IpAddress' + smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + epdgInd: + type: boolean + default: false + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + +PduSession: + type: object + required: + - dnn + - smfInstanceId + - plmnId + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + singleNsai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +AmfInfo: + type: object + required: + - amfInstanceId + - guami + properties: + amfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + +PgwInfo: + type: object + required: + - dnn + - pgwFqdn + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +``` + +``` + +pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +pgwIpAddress: + $ref: '#/components/schemas/IpAddress' +plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +epdgInd: + type: boolean + default: false +pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +registrationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +wildcardInd: + type: boolean + +SessionManagementSubscriptionData: + type: object + required: + - singleNssai + properties: + singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnnConfigurations: + description: A map (list of key-value pairs where Dnn, or optionally the Wildcard DNN, serves as key) of DnnConfigurations + type: object + additionalProperties: + $ref: '#/components/schemas/DnnConfiguration' + internalGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + sharedVnGroupDataIds: + description: A map(list of key-value pairs) where GroupId serves as key of SharedDataId + type: object + additionalProperties: + $ref: '#/components/schemas/SharedDataId' + minProperties: 1 + sharedDnnConfigurationsId: + $ref: '#/components/schemas/SharedDataId' + odbPacketServices: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OdbPacketServices' + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + sharedTraceDataId: + $ref: '#/components/schemas/SharedDataId' + expectedUeBehavioursList: + description: A map(list of key-value pairs) where Dnn serves as key of +ExpectedUeBehaviourData + type: object + additionalProperties: + $ref: '#/components/schemas/ExpectedUeBehaviourData' + minProperties: 1 + expectedUeBehaviourData: + description: A map(list of key-value pairs) where DNN serves as key + type: object + additionalProperties: + description: A map(list of key-value pairs) where a valid JSON Pointer serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/ExpectedUeBehaviourData' + minProperties: 1 + minProperties: 1 + appSpecificExpectedUeBehaviourData: + description: A map(list of key-value pairs) where DNN serves as key + type: object + additionalProperties: + description: A map(list of key-value pairs) where a valid JSON Pointer serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/AppSpecificExpectedUeBehaviourData' + minProperties: 1 + minProperties: 1 + suggestedPacketNumDlList: + description: A map(list of key-value pairs) where Dnn serves as key of +SuggestedPacketNumDl + +``` + +``` +type: object +additionalProperties: + $ref: '#/components/schemas/SuggestedPacketNumDl' +minProperties: 1 +3gppChargingCharacteristics: + $ref: '#/components/schemas/3GppChargingCharacteristics' +nsacMode: + $ref: '#/components/schemas/NsacAdmissionMode' +sessInactTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +onDemand: + type: boolean + default: false +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +additionalSharedDnnConfigurationsIds: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + minItems: 1 + +DnnConfiguration: + type: object + required: + - pduSessionTypes + - sscModes + properties: + pduSessionTypes: + $ref: '#/components/schemas/PduSessionTypes' + sscModes: + $ref: '#/components/schemas/SscModes' + iwkEpsInd: + $ref: '#/components/schemas/IwkEpsInd' + 5gQosProfile: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos' + sessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + 3gppChargingCharacteristics: + $ref: '#/components/schemas/3GppChargingCharacteristics' + staticIpAddress: + type: array + items: + $ref: '#/components/schemas/IpAddress' + minItems: 1 + maxItems: 2 + upSecurity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UpSecurity' + pduSessionContinuityInd: + $ref: '#/components/schemas/PduSessionContinuityInd' + niddNefId: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefId' + niddInfo: + $ref: '#/components/schemas/NiddInformation' + redundantSessionAllowed: + type: boolean + acsInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AcsInfo' + ipv4FrameRouteList: + type: array + items: + $ref: '#/components/schemas/FrameRouteInfo' + minItems: 1 + ipv6FrameRouteList: + type: array + items: + $ref: '#/components/schemas/FrameRouteInfo' + minItems: 1 + atsssAllowed: + type: boolean + default: false + secondaryAuth: + type: boolean + uavSecondaryAuth: + type: boolean + default: false + dnAaaIpAddressAllocation: + type: boolean + dnAaaAddress: +``` + +``` + $ref: '#/components/schemas/IpAddress' + additionalDnAaaAddresses: + type: array + items: + $ref: '#/components/schemas/IpAddress' + minItems: 1 + dnAaaFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + iptvAccCtrlInfo: + type: string + ipv4Index: + $ref: '#/components/schemas/IpIndex' + ipv6Index: + $ref: '#/components/schemas/IpIndex' + ecsAddrConfigInfo: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/EcsAddrConfigInfo' + additionalEcsAddrConfigInfos: + type: array + items: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/EcsAddrConfigInfo' + minItems: 1 + sharedEcsAddrConfigInfo: + $ref: '#/components/schemas/SharedDataId' + additionalSharedEcsAddrConfigInfoIds: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + minItems: 1 + easDiscoveryAuthorized: + type: boolean + default: false + onboardingInd: + type: boolean + default: false + aerialUeInd: + $ref: '#/components/schemas/AerialUeIndication' + subscribedMaxIpv6PrefixSize: + type: integer + hrSboAuthorized: + type: boolean + default: false + +NiddInformation: + type: object + required: + - afId + properties: + afId: + type: string + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + extGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + +IpAddress: + type: object + oneOf: + - required: + - ipv4Addr + - required: + - ipv6Addr + - required: + - ipv6Prefix + properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + ipv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + +PduSessionTypes: + type: object + properties: + defaultSessionType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + allowedSessionTypes: + type: array +``` + +``` + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + +SscModes: + type: object + required: + - defaultSscMode + properties: + defaultSscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' + allowedSscModes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' + minItems: 1 + maxItems: 2 + +SmsSubscriptionData: + type: object + properties: + smsSubscribed: + $ref: '#/components/schemas/SmsSubscribed' + sharedSmsSubsDataId: + $ref: '#/components/schemas/SharedDataId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +SmsManagementSubscriptionData: + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + mtSmsSubscribed: + type: boolean + mtSmsBarringAll: + type: boolean + mtSmsBarringRoaming: + type: boolean + moSmsSubscribed: + type: boolean + moSmsBarringAll: + type: boolean + moSmsBarringRoaming: + type: boolean + sharedSmsMngDataIds: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + minItems: 1 + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + +SdmSubscription: + type: object + required: + - nfInstanceId + - callbackReference + - monitoredResourceUris + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + implicitUnsubscribe: + type: boolean + expires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + amfServiceName: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +subscriptionId: + type: string +plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +immediateReport: + type: boolean + default: false +report: + $ref: '#/components/schemas/ImmediateReport' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +contextInfo: + $ref: '#/components/schemas/ContextInfo' +nfChangeFilter: + type: boolean + default: false +uniqueSubscription: + type: boolean +resetIds: + type: array + items: + type: string + minItems: 1 +ueConSmfDataSubFilter: + $ref: '#/components/schemas/UeContextInSmfDataSubFilter' +adjacentPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 +disasterRoamingInd: + type: boolean + default: false +dataRestorationCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +udrRestartInd: + type: boolean + default: false +expectedUeBehaviourThresholds: + description: A map(list of key-value pairs) where a valid JSON pointer serves as key of +expectedUeBehaviourThresholds + type: object + additionalProperties: + $ref: '#/components/schemas/ExpectedUeBehaviourThreshold' + minProperties: 1 + +SdmSubsModification: + type: object + properties: + expires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + expectedUeBehaviourThresholds: + description: A map(list of key-value pairs) where a valid JSON pointer serves as key of +expectedUeBehaviourThresholds + type: object + additionalProperties: + $ref: '#/components/schemas/ExpectedUeBehaviourThreshold' + minProperties: 1 + +ModificationNotification: + type: object + required: + - notifyItems + properties: + notifyItems: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotifyItem' + minItems: 1 + subscriptionId: + type: string +``` + +``` +IdTranslationResult: + type: object + required: + - supi + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + additionalSupis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + additionalGsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + +AcknowledgeInfo: + type: object + required: + - provisioningTime + properties: + sorMacIue: + $ref: 'TS29509_Nausf_SorProtection.yaml#/components/schemas/SorMac' + upuMacIue: + $ref: 'TS29509_Nausf_UPUProtection.yaml#/components/schemas/UpuMac' + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + sorTransparentContainer: + $ref: '#/components/schemas/SorTransparentContainer' + ueNotReachable: + type: boolean + default: false + upuTransparentContainer: + $ref: '#/components/schemas/UpuTransparentContainer' + +SorInfo: + type: object + properties: + steeringContainer: + $ref: '#/components/schemas/SteeringContainer' + ackInd: + $ref: 'TS29509_Nausf_SorProtection.yaml#/components/schemas/AckInd' + sorMacIausf: + $ref: 'TS29509_Nausf_SorProtection.yaml#/components/schemas/SorMac' + countersor: + $ref: 'TS29509_Nausf_SorProtection.yaml#/components/schemas/CounterSor' + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + sorTransparentContainer: + $ref: '#/components/schemas/SorTransparentContainer' + sorCmci: + $ref: '#/components/schemas/SorCmci' + sorSnpnSi: + $ref: '#/components/schemas/SorSnpnSi' + sorSnpnSiLs: + $ref: '#/components/schemas/SorSnpnSiLs' + storeSorCmciInMe: + type: boolean + usimSupportOfSorCmci: + type: boolean + required: + - ackInd + - provisioningTime + +SharedDataIds: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + minItems: 1 + uniqueItems: true + +UpuInfo: +``` + +``` +type: object +properties: + upuDataList: + type: array + items: + $ref: 'TS29509_Nausf_UPUProtection.yaml#/components/schemas/UpuData' + minItems: 1 + upuRegInd: + $ref: '#/components/schemas/UpuRegInd' + upuAckInd: + $ref: 'TS29509_Nausf_UPUProtection.yaml#/components/schemas/UpuAckInd' + upuMacIausf: + $ref: 'TS29509_Nausf_UPUProtection.yaml#/components/schemas/UpuMac' + counterUpu: + $ref: 'TS29509_Nausf_UPUProtection.yaml#/components/schemas/CounterUpu' + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + upuTransparentContainer: + $ref: '#/components/schemas/UpuTransparentContainer' +required: +- provisioningTime + +SharedData: +type: object +required: +- sharedDataId +properties: + sharedDataId: + $ref: '#/components/schemas/SharedDataId' + sharedAmData: + $ref: '#/components/schemas/AccessAndMobilitySubscriptionData' + sharedSmsSubsData: + $ref: '#/components/schemas/SmsSubscriptionData' + sharedSmsMngSubsData: +``` + +``` +$ref: '#/components/schemas/SmsManagementSubscriptionData' +sharedDnnConfigurations: + description: A map(list of key-value pairs) where Dnn, or optionally the Wildcard DNN, +serves as key of DnnConfiguration + type: object + additionalProperties: + $ref: '#/components/schemas/DnnConfiguration' + minProperties: 1 +sharedTraceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' +sharedSnssaiInfos: + description: A map(list of key-value pairs) where singleNssai serves as key of SnssaiInfo + type: object + additionalProperties: + $ref: '#/components/schemas/SnssaiInfo' + minProperties: 1 +sharedVnGroupData: + description: A map(list of key-value pairs) where GroupId serves as key of VnGroupData + type: object + additionalProperties: + $ref: '#/components/schemas/VnGroupData' + minProperties: 1 +treatmentInstructions: + description: A map(list of key-value pairs) where JSON pointer pointing to an attribute +within the SharedData serves as key of SharedDataTreatmentInstruction + type: object + additionalProperties: + $ref: '#/components/schemas/SharedDataTreatmentInstruction' + minProperties: 1 +sharedSmSubsData: + $ref: '#/components/schemas/SessionManagementSubscriptionData' +sharedEcsAddrConfigInfo: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/EcsAddrConfigInfo' + +TraceDataResponse: + type: object + properties: + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + sharedTraceDataId: + $ref: '#/components/schemas/SharedDataId' + +SteeringContainer: + oneOf: + - type: array + items: + $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo' + minItems: 1 + - $ref: '#/components/schemas/SecuredPacket' + +GroupIdentifiers: + type: object + properties: + extGroupId: + $ref: '#/components/schemas/ExtGroupId' + intGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + ueIdList: + type: array + items: + $ref: '#/components/schemas/UeId' + minItems: 1 + +VnGroupData: + type: object + properties: + pduSessionTypes: + $ref: '#/components/schemas/PduSessionTypes' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + appDescriptors: + type: array + items: + $ref: '#/components/schemas/AppDescriptor' + minItems: 1 + secondaryAuth: +``` + +``` + type: boolean +dnAaaIpAddressAllocation: + type: boolean +dnAaaAddress: + $ref: '#/components/schemas/IpAddress' +additionalDnAaaAddresses: + type: array + items: + $ref: '#/components/schemas/IpAddress' + minItems: 1 +dnAaaFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + +AppDescriptor: + type: object + properties: + osId: + $ref: 'TS29519_Policy_Data.yaml#/components/schemas/OsId' + appId: + type: string + +AdditionalSnssaiData: + type: object + properties: + requiredAuthnAuthz: + type: boolean + subscribedUeSliceMbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceMbrRm' + subscribedNsSrgList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsSrg' + minItems: 1 + nsacMode: + $ref: '#/components/schemas/NsacAdmissionMode' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + deregInactTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + onDemand: + type: boolean + default: false + +AppPortId: + type: object + properties: + destinationPort: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + originatorPort: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + +LcsPrivacyData: + type: object + properties: + lpi: + $ref: '#/components/schemas/Lpi' + unrelatedClass: + $ref: '#/components/schemas/UnrelatedClass' + plmnOperatorClasses: + type: array + items: + $ref: '#/components/schemas/PlmnOperatorClass' + minItems: 1 + evtRptExpectedArea: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + areaUsageInd: + allOf: + - $ref: '#/components/schemas/AreaUsageInd' + default: INSIDE_REPORTING + upLocRepIndAf: + allOf: + - $ref: '#/components/schemas/UpLocRepIndAf' + default: USER_PLANE_REPORT_NOT_ALLOWED + +Lpi: + type: object + required: + - locationPrivacyInd +``` + +``` +properties: + locationPrivacyInd: + $ref: '#/components/schemas/LocationPrivacyInd' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + +UnrelatedClass: + type: object + required: + - defaultUnrelatedClass + properties: + defaultUnrelatedClass: + $ref: '#/components/schemas/DefaultUnrelatedClass' + externalUnrelatedClass: + $ref: '#/components/schemas/ExternalUnrelatedClass' + serviceTypeUnrelatedClasses: + type: array + items: + $ref: '#/components/schemas/ServiceTypeUnrelatedClass' + minItems: 1 + +PlmnOperatorClass: + type: object + required: + - lcsClientClass + - lcsClientIds + properties: + lcsClientClass: + $ref: '#/components/schemas/LcsClientClass' + lcsClientIds: + type: array + items: + $ref: '#/components/schemas/LcsClientId' + minItems: 1 + +ValidTimePeriod: + type: object + properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +ExternalUnrelatedClass: + properties: + lcsClientExternals: + type: array + items: + $ref: '#/components/schemas/LcsClientExternal' + minItems: 1 + afExternals: + type: array + items: + $ref: '#/components/schemas/AfExternal' + minItems: 1 + lcsClientGroupExternals: + type: array + items: + $ref: '#/components/schemas/LcsClientGroupExternal' + minItems: 1 + +AfExternal: + type: object + properties: + afId: + $ref: '#/components/schemas/AfId' + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + privacyCheckRelatedAction: + $ref: '#/components/schemas/PrivacyCheckRelatedAction' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + +LcsClientExternal: + type: object +``` + +``` +properties: + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + privacyCheckRelatedAction: + $ref: '#/components/schemas/PrivacyCheckRelatedAction' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + +LcsClientGroupExternal: + type: object + properties: + lcsClientGroupId: + $ref: '#/components/schemas/ExtGroupId' + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + privacyCheckRelatedAction: + $ref: '#/components/schemas/PrivacyCheckRelatedAction' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + +ServiceTypeUnrelatedClass: + type: object + required: + - serviceType + properties: + serviceType: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsServiceType' + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + privacyCheckRelatedAction: + $ref: '#/components/schemas/PrivacyCheckRelatedAction' + codeWordInd: + $ref: '#/components/schemas/CodeWordInd' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + codeWordList: + type: array + items: + $ref: '#/components/schemas/CodeWord' + minItems: 1 + +LcsMoData: + type: object + required: + - allowedServiceClasses + properties: + allowedServiceClasses: + type: array + items: + $ref: '#/components/schemas/LcsMoServiceClass' + minItems: 1 + moAssistanceDataTypes: + $ref: '#/components/schemas/LcsBroadcastAssistanceTypesData' + +LcsSubscriptionData: + type: object + properties: + configuredLmfId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + pruInd: + $ref: '#/components/schemas/PruInd' + lpHapType: + $ref: 'TS29518_Namf_Location.yaml#/components/schemas/LpHapType' + userPlanePosIndLmf: + type: boolean + default: false + +LcsBroadcastAssistanceTypesData: +``` + +``` +type: object +required: +- locationAssistanceType +properties: + locationAssistanceType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Binary' + +EcRestrictionDataWb: +type: object +anyOf: +- required: [ ecModeARestricted ] +- required: [ ecModeBRestricted ] +properties: + ecModeARestricted: + type: boolean + ecModeBRestricted: + type: boolean + +ExpectedUeBehaviourData: +type: object +properties: + stationaryIndication: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StationaryIndication' + communicationDurationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + periodicTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + scheduledCommunicationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime' + scheduledCommunicationType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationType' + expectedUmts: + type: array + items: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/LocationArea' + minItems: 1 + description: Identifies the UE's expected geographical movement. The attribute is only +applicable in 5G. + trafficProfile: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficProfile' + batteryIndication: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BatteryIndication' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + confidenceLevel: + type: string + pattern: '^[0]\.[0-9]{2}$|^1\.00$' + accuracyLevel: + type: string + pattern: '^[0]\.[0-9]{2}$|^1\.00$' + +SuggestedPacketNumDl: +type: object +required: +- suggestedPacketNumDl +properties: + suggestedPacketNumDl: + type: integer + minimum: 1 + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +FrameRouteInfo: +type: object +properties: + ipv4Mask: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrMask' + ipv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + +SorUpdateInfo: +type: object +required: +- vplmnId +properties: + vplmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + supportedFeatures: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +EnhancedCoverageRestrictionData: + type: object + properties: + plmnEcInfoList: + type: array + items: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/PlmnEcInfo' + minItems: 1 + +EdrxParameters: + type: object + required: + - ratType + - edrxValue + properties: + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + edrxValue: + type: string + pattern: '^([0-1]{4})$' + +PtwParameters: + type: object + required: + - operationMode + - ptwValue + properties: + operationMode: + $ref: '#/components/schemas/OperationMode' + ptwValue: + type: string + pattern: '^([0-1]{4})$' + extendedPtwValue: + type: string + pattern: '^([0-1]{8})$' + +UeId: + type: object + required: + - supi + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + +V2xSubscriptionData: + type: object + properties: + nrV2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrV2xAuth' + lteV2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LteV2xAuth' + nrUePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ltePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + +DefaultUnrelatedClass: + type: object + properties: + allowedGeographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + privacyCheckRelatedAction: + $ref: '#/components/schemas/PrivacyCheckRelatedAction' + codeWordInd: + $ref: '#/components/schemas/CodeWordInd' + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + codeWordList: +``` + +``` + type: array + items: + $ref: '#/components/schemas/CodeWord' + minItems: 1 + +ContextInfo: + type: object + properties: + origHeaders: + type: array + items: + type: string + minItems: 1 + requestHeaders: + type: array + items: + type: string + minItems: 1 + +AerialUeSubscriptionInfo: + description: Contains the Aerial UE Subscription Information, it at least contains the Aerial + UE Indication. + type: object + required: + - aerialUeInd + properties: + aerialUeInd: + $ref: '#/components/schemas/AerialUeIndication' + 3gppUavId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + +SmSubsData: + oneOf: + - type: array + items: + $ref: '#/components/schemas/SessionManagementSubscriptionData' + minItems: 1 + - $ref: '#/components/schemas/ExtendedSmSubsData' + +ExtendedSmSubsData: + description: Contains identifiers of shared Session Management Subscription Data and + optionally individual Session Management Subscription Data. + type: object + required: + - sharedSmSubsDataIds + properties: + sharedSmSubsDataIds: + type: array + items: + $ref: '#/components/schemas/SharedDataId' + minItems: 1 + individualSmSubsData: + type: array + items: + $ref: '#/components/schemas/SessionManagementSubscriptionData' + +ImmediateReport: + oneOf: + - $ref: '#/components/schemas/SubscriptionDataSets' + - type: array + items: + $ref: '#/components/schemas/SharedData' + minItems: 0 + +MbsSubscriptionData: + description: Contains the 5MBS Subscription Data. + type: object + properties: + mbsAllowed: + type: boolean + default: false + mbsSessionIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + minItems: 1 + ueMbsAssistanceInfo: + type: array +``` + +``` + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + minItems: 1 + +UcSubscriptionData: + description: Contains the User Consent Subscription Data. + type: object + properties: + userConsentPerPurposeList: + description: A map(list of key-value pairs) where user consent purpose serves as key of +user consent + type: object + additionalProperties: + $ref: '#/components/schemas/UserConsent' + minProperties: 1 + +UeContextInSmfDataSubFilter: + description: UE Context In Smf Data Subscription Filter. + type: object + properties: + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 + emergencyInd: + type: boolean + default: false + +UeIdentifiers: + description: A map(list of key-value pairs) where Gpsi serves as key of arrays of Supi + type: object + additionalProperties: + $ref: '#/components/schemas/SupiInfo' + minProperties: 1 + +SupiInfo: + description: List of Supis. + type: object + required: + - supiList + properties: + supiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + +TimeSyncSubscriptionData: + description: UE Time Synchronization Subscription Data + type: object + required: + - afReqAuthorizations + - serviceIds + properties: + afReqAuthorizations: + type: array + items: + $ref: '#/components/schemas/AfRequestAuthorization' + minItems: 1 + serviceIds: + type: array + items: + $ref: '#/components/schemas/TimeSyncServiceId' + minItems: 1 + +AfRequestAuthorization: + description: AF Request Authorization + type: object + properties: + gftpAllowedInfo: + $ref: '#/components/schemas/GftpAllowedInfo' + astiAllowedInfo: + $ref: '#/components/schemas/AstiAllowedInfo' +``` + +``` +oneOf: + - required: [ gtpAllowedInfo ] + - required: [ astiAllowedInfo ] + +GtpAllowedInfo: + description: AF authorization information for gPTP + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + gtpAllowed: + type: boolean + coverageArea: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + uuTimeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + tempVals: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + minItems: 1 + required: + - gtpAllowed + +AstiAllowedInfo: + description: AF authorization information for ASTI + type: object + properties: + astiAllowed: + type: boolean + coverageArea: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + uuTimeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + tempVals: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + minItems: 1 + required: + - astiAllowed + +TimeSyncServiceId: + description: Time Synchronization Service ID + type: object + required: + - reference + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + reference: + type: string + tempVals: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + minItems: 1 + coverageArea: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + uuTimeSyncErrBdgt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +ConditionalCagInfo: + type: object + required: +``` + +``` +- allowedCagList +properties: + allowedCagList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CagId' + minItems: 1 + cagOnlyIndicator: + type: boolean + validTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' + +AppSpecificExpectedUeBehaviourData: + type: object + anyOf: + - required: [ appId ] + - required: [ trafficFilters ] + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + trafficFilters: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + expectedInactivityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + confidenceLevel: + type: string + pattern: '^[0]\.[0-9]{2}$|^1\.00$' + accuracyLevel: + type: string + pattern: '^[0]\.[0-9]{2}$|^1\.00$' + +ExpectedUeBehaviourThreshold: + type: object + properties: + expectedUeBehaviourDatasets: + type: array + items: + $ref: '#/components/schemas/ExpectedUeBehaviourDataset' + minItems: 1 + singleNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + dnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + confidenceLevel: + type: string + accuracyLevel: + type: string + +A2xSubscriptionData: + type: object + properties: + nrA2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NrA2xAuth' + lteA2xServicesAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LteA2xAuth' + nrUePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ltePc5Ambr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + +RangingSlPosQos: + type: object + properties: + hAccuracy: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy' + vAccuracy: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy' +``` + +``` + relativeHAccuracy: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy' + relativeVAccuracy: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy' + distanceAccuracy: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy' + directionAccuracy: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy' + verticalRequested: + type: boolean + responseTime: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ResponseTime' + lcsQosClass: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsQosClass' + +MbsrOperationAllowed: + type: object + properties: + mbsrOperationAllowedInd: + type: boolean + mbsrValidTimePeriod: + $ref: '#/components/schemas/ValidTimePeriod' +``` + +# # SIMPLE TYPES: + +``` +UeUsageType: + type: integer + +MpsPriorityIndicator: + type: boolean + +McsPriorityIndicator: + type: boolean + +DnnIndicator: + type: boolean + +LboRoamingAllowed: + type: boolean + +SmsSubscribed: + type: boolean + +3GppChargingCharacteristics: + type: string + +MicoAllowed: + type: boolean + +SharedDataId: + type: string + pattern: '^[0-9]{5,6}-.+$' + +IwkEpsInd: + type: boolean + +SecuredPacket: + type: string + format: byte + +UpuRegInd: + type: boolean + +ExtGroupId: + type: string + pattern: '^extgroupid-[^@]+@[^\@]+\+$' + +NbIoTUEPriority: + type: integer + minimum: 0 + maximum: 255 + +CodeWord: + type: string + +AfId: + type: string +``` + +``` +LcsClientId: + type: string + +SorTransparentContainer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +UpuTransparentContainer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +IpIndex: + description: Represents the IP Index to be sent from UDM to the SMF (its value can be either +an integer or a string) + anyOf: + - type: integer + - type: string + +SorCmci: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +SorSnpnSi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +SorSnpnSiLs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +RangingSlPosSubscriptionData: + description: Contains the Ranging/SL positioning Subscription Data. + type: object + properties: + rangingSlPosAuth: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RangingSlPosAuth' + rangingSlPosPlmn: + type: array + items: + $ref: '#/components/schemas/RangingSlPosPlmn' + minItems: 1 + rangingSlPosQos: + $ref: '#/components/schemas/RangingSlPosQos' + +RangingSlPosPlmn: + description: Contains the PLMN identities where the Ranging/SL Positioning services are +authorised to use and the authorised Ranging/SL Positioning services on this given PLMNs. + type: object + required: + - rangingSlPosPlmn + properties: + rangingSlPosPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + rangingSlPosAllowed: + type: array + items: + $ref: '#/components/schemas/RangingSlPosAllowed' + minItems: 1 + +# ENUMS: + +DataSetName: + description: Indicates the requested data set name. + anyOf: + - type: string + enum: + - AM + - SMF_SEL + - UEC_SMF + - UEC_SMSF + - SMS_SUB + - SM + - TRACE + - SMS_MNG + - LCS_PRIVACY + - LCS_MO + - LCS_SUB + - UEC_AMF + - V2X + - LCS_BCA + - PROSE + - UC +``` + +- MBS +- A2X +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +UcPurpose: +description: Indicates the purpose of the user consent. +anyOf: +- type: string +enum: +- ANALYTICS +- MODEL\_TRAINING +- NW\_CAP\_EXPOSURE +- EDGEAPP\_UE\_LOCATION +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +UserConsent: +description: Indicates user's consent. +anyOf: +- type: string +enum: +- CONSENT\_NOT\_GIVEN +- CONSENT\_GIVEN +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +PduSessionContinuityInd: +description: > +It indicates the handling of PDU session when the UE moves in and out of NB-IoT. +In its absence, the local policy should be used. +anyOf: +- type: string +enum: +- MAINTAIN\_PDUSESSION +- RECONNECT\_PDUSESSION +- RELEASE\_PDUSESSION +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +LocationPrivacyInd: +description: > +Indicates one of the mutually exclusive global settings (if the location is allowed or disallowed). +anyOf: +- type: string +enum: +- LOCATION\_DISALLOWED +- LOCATION\_ALLOWED +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +PrivacyCheckRelatedAction: +description: Indicates actions related to privacy check. +anyOf: +- type: string +enum: +- LOCATION\_NOT\_ALLOWED +- LOCATION\_ALLOWED\_WITH\_NOTIFICATION +- LOCATION\_ALLOWED\_WITHOUT\_NOTIFICATION +- LOCATION\_ALLOWED\_WITHOUT\_RESPONSE + +``` +- LOCATION_RESTRICTED_WITHOUT_RESPONSE +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +LcsClientClass: + description: Indicates LCS Client class. + anyOf: + - type: string + enum: + - BROADCAST_SERVICE + - OM_IN_HPLMN + - OM_IN_VPLMN + - ANONYMOUS_LOCATION_SERVICE + - SPECIFIC_SERVICE + - NWDAF_IN_HPLMN + - NWDAF_IN_VPLMN + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +LcsMoServiceClass: + description: > + Indicates the requirement of the UE to request + its own location. + anyOf: + - type: string + enum: + - BASIC_SELF_LOCATION + - AUTONOMOUS_SELF_LOCATION +``` + +``` +- TRANSFER_TO_THIRD_PARTY +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +OperationMode: +description: > +Indicates the Operation Mode. +anyOf: +- type: string +enum: +- WB_S1 +- NB_S1 +- WB_N1 +- NB_N1 +- NR_N1 +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +SorUpdateIndicator: +description: Indicates serving node PLMN identity. +anyOf: +- type: string +enum: +- INITIAL_REGISTRATION +- EMERGENCY_REGISTRATION +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +CodeWordInd: +description: > +Indicates that the codeword shall be checked in UE +or one or more codeword values to be checked in GMLC. +anyOf: +- type: string +enum: +- CODEWORD_CHECK_IN_UE +- CODEWORD_CHECK_IN_GMLC +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +MdtUserConsent: +description: > +Indicates the user has given his consent for MDT activation. +anyOf: +- type: string +enum: +- CONSENT_NOT_GIVEN +- CONSENT_GIVEN +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +SharedDataTreatmentInstruction: +description: > +Indicates the presence of this attribute in the individual data. +Otherwise, the individual data takes precedence, by default. +anyOf: +- type: string +enum: +- USE_IF_NO_CLASH +- OVERWRITE +- MAX +- MIN +``` + +``` +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +GpsiType: + description: Type of GPSI (MSISDN or External-ID) + anyOf: + - type: string + enum: + - MSISDN + - EXT_ID + - EXT_GROUP_ID + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +AerialUeIndication: + description: > + Indicates the Aerial service for the UE is allowed or not allowed, possible values are + - AERIAL_UE_ALLOWED: Aerial service for the UE is allowed. + - AERIAL_UE_NOT_ALLOWED: Aerial service for the UE is not allowed. + anyOf: + - type: string + enum: + - AERIAL_UE_ALLOWED + - AERIAL_UE_NOT_ALLOWED + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +ProseDirectAllowed: + description: > + Indicates the 5G ProSe Direct services that can be authorised to + use in the given PLMN for the UE. + anyOf: + - type: string + enum: + - ANNOUNCE + - MONITOR + - RESTRICTD_ANNOUNCE + - RESTRICTD_MONITOR + - DISCOVERER + - DISCOVEREE + - BROADCAST + - GROUPCAST + - UNICAST + - LAYER2_RELAY + - LAYER3_RELAY + - LAYER3_REMOTE + - LAYER2_UE_RELAY + - LAYER3_UE_RELAY + - LAYER2_END + - LAYER3_END + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +NsacAdmissionMode: + description: > + Indicates the NSAC admission mode applied in roaming case. + anyOf: + - type: string + enum: + - VPLMN_ADMISSION + - VPLMN_WITH_HPLMN_ASSISTANCE + - HPLMN_ADMISSION + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode +``` + +content defined in the present version of this API. + +### **PruInd:** + +description: > + +Indicates whether the UE can act as a PRU or the type of PRU. + +#### **anyOf:** + +- type: string + +#### **enum:** + +- NON\_PRU + +- STATIONARY\_PRU + +- NON\_STATIONARY\_PRU + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +### **AreaUsageInd:** + +description: > + +Indicates one of the mutually exclusive global settings + +(whether the UE is allowed to generate and send the reports inside or outside the event report expected area). + +#### **anyOf:** + +- type: string + +#### **enum:** + +- INSIDE\_REPORTING + +- OUTSIDE\_REPORTING + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +### **RangingSlPosAllowed:** + +description: > + +Indicates the Ranging/SL positioning services that can be authorised to use in the given PLMN for the UE. + +#### **anyOf:** + +- type: string + +#### **enum:** + +- PC5 + +- ANNOUNCE + +- MONITOR + +- DISCOVERER + +- DISCOVEREE + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +### **ExpectedUeBehaviourDataset:** + +#### **anyOf:** + +- type: string + +#### **enum:** + +- STATIONARY\_INDICATION + +- COMMUNICATION\_DURATION\_TIME + +- PERIODIC\_TIME + +- SCHEDULED\_COMMUNICATION\_TIME + +- SCHEDULED\_COMMUNICATION\_TYPE + +- EXPECTED\_UMTS + +- TRAFFIC\_PROFILE + +- BATTERY\_INDICATION + +- EXPECTED\_INACTIVITY\_TIME + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +### **UpLocRepIndAf:** + +description: > + +Indicates one of the mutually exclusive global settings for location reporting over user plane connectivity to an LCS client or AF. + +#### **anyOf:** + +- type: string + +#### **enum:** + +``` + +- USER_PLANE_REPORT_ALLOWED +- USER_PLANE_REPORT_NOT_ALLOWED +- type: string +description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +``` + +## --- A.3 Nudm\_UECM API + +``` + +openapi: 3.0.0 + +info: + version: '1.3.0-alpha.5' + title: 'Nudm_UECM' + description: | + Nudm Context Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.503 Unified Data Management Services, version 18.4.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' + +servers: +- url: '{apiRoot}/nudm-uecm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: +- oAuth2ClientCredentials: + - nudm-uecm +- {} + +paths: + /{ueId}/registrations: + get: + summary: retrieve UE registration data sets + operationId: GetRegistrations + tags: + - UECM Registration Info Retrieval + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: registration-dataset-names + in: query + style: form + explode: false + description: List of UECM registration dataset names + required: true + schema: + $ref: '#/components/schemas/RegistrationDatasetNames' + - name: single-nssai + in: query + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + - name: dnn + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + responses: + '200': + description: Expected response to a valid request + +``` + +``` + + content: + application/json: + schema: + $ref: '#/components/schemas/RegistrationDataSets' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/registrations/send-routing-info-sm: + post: + summary: Retrieve addressing information for SMS delivery + operationId: SendRoutingInfoSm + tags: + - SendRoutingInfoSM (Custom Operation) + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingInfoSmRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingInfoSmResponse' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/registrations/amf-3gpp-access: + put: + +``` + +``` +summary: register as AMF for 3GPP access +operationId: 3GppRegistration +tags: + - AMF registration for 3GPP access +security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:amf-registration:write +parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Amf3GppAccessRegistration' + required: true +responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/Amf3GppAccessRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/amf-3gpp-access' + required: true + schema: + type: string + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Amf3GppAccessRegistration' + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +callbacks: + deregistrationNotification: + '{request.body#/deregCallbackUri}': + post: + requestBody: + required: true + content: + application/json: +``` + +``` + schema: + $ref: '#/components/schemas/DeregistrationData' + responses: + '204': + description: Successful Notification response + '200': + description: Successful Notification response with information to UDM + content: + application/json: + schema: + $ref: '#/components/schemas/DeregistrationRespData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + pscsfRestorationNotification: + '{request.body#/pcscfRestorationCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcscfRestorationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + dataRestorationNotification: + '{request.body#/dataRestorationCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataRestorationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + reauthNotification: + '{request.body#/reauthNotifyCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ReauthNotificationInfo' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +patch: + summary: Update a parameter in the AMF registration for 3GPP access + operationId: Update3GppRegistration + tags: + - Parameter update in the AMF registration for 3GPP access + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:amf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/Amf3GppAccessRegistrationModification' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +get: +``` + +``` +summary: retrieve the AMF registration for 3GPP access information +operationId: Get3GppRegistration +tags: + - AMF 3Gpp-access Registration Info Retrieval +parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/Amf3GppAccessRegistration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{ueId}/registrations/amf-3gpp-access/dereg-amf: + post: + summary: trigger AMF for 3GPP access deregistration + operationId: deregAMF + tags: + - Trigger AMF for 3GPP access deregistration + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:amf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AmfDeregInfo' + required: true + responses: + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +``` + +``` +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{ueId}/registrations/amf-3gpp-access/pei-update: + post: + summary: Updates the PEI in the 3GPP access registration context + operationId: PeiUpdate + tags: + - PEI Update + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:amf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PeiUpdateInfo' + required: true + responses: + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/registrations/amf-3gpp-access/roaming-info-update: + post: + summary: Update the Roaming Information + operationId: UpdateRoamingInformation + tags: +``` + +``` + - Roaming Information Update + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:roaming-info-update:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingInfoUpdate' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingInfoUpdate' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudm-uecm/{apiVersion}/{ueId}/registrations/amf-3gpp-access/roaming-info- +update' + required: true + schema: + type: string + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/registrations/amf-non-3gpp-access: + put: + summary: register as AMF for non-3GPP access + operationId: Non3GppRegistration + tags: + - AMF registration for non-3GPP access + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:amf-registration:write + parameters: + - name: ueId +``` + +``` + +in: path +description: Identifier of the UE +required: true +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +requestBody: +content: + application/json: + schema: + $ref: '#/components/schemas/AmfNon3GppAccessRegistration' +required: true +responses: +'201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/AmfNon3GppAccessRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/amf-non-3gpp-access' + required: true + schema: + type: string +'200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AmfNon3GppAccessRegistration' +'204': + description: No Content +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +callbacks: + deregistrationNotification: + '{request.body#/deregCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeregistrationData' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + +``` + +``` +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +pcscfRestorationNotification: + '{request.body#/pcscfRestorationCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcscfRestorationNotification' +responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +dataRestorationNotification: + '{request.body#/dataRestorationCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataRestorationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +reauthNotification: + '{request.body#/reauthNotifyCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ReauthNotificationInfo' + responses: + '204': +``` + +``` + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +patch: + summary: update a parameter in the AMF registration for non-3GPP access + operationId: UpdateNon3GppRegistration + tags: + - Parameter update in the AMF registration for non-3GPP access + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:amf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AmfNon3GppAccessRegistrationModification' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +get: + summary: retrieve the AMF registration for non-3GPP access information + operationId: GetNon3GppRegistration + tags: + - AMF non-3GPP-access Registration Info Retrieval + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AmfNon3GppAccessRegistration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/registrations/smf-registrations: + get: + summary: retrieve the SMF registration information + operationId: GetSmfRegistration + tags: + - SMF SmfRegistration + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +``` + +``` +- name: single-nssai + in: query + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +- name: dnn + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +- name: supported-features + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmfRegistrationInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{ueId}/registrations/smf-registrations/{pduSessionId}: + put: + summary: register as SMF + operationId: Registration + tags: + - SMF SmfRegistration + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:smf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: pduSessionId + in: path + description: Identifier of the PDU session + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmfRegistration' + required: true + responses: + '201': + description: Created + content: +``` + +``` + + application/json: + schema: + $ref: '#/components/schemas/SmfRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smf-registrations/{pduSessionId}' + required: true + schema: + type: string + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmfRegistration' + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + deregistrationNotification: + '{request.body#/deregCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeregistrationData' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + pscsfRestorationNotification: + '{request.body#/pscsfRestorationCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PscsfRestorationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + dataRestorationNotification: + '{request.body#/dataRestorationCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataRestorationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + staleCheckNotification: + '{request.body#/staleCheckCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionIds' + responses: + '200': + description: Partial Success + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionIds' + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + delete: + summary: delete an SMF registration + operationId: SmfDeregistration + tags: + - SMF Deregistration + security: + - {} + - OAuth2ClientCredentials: + - nudm-uecm + - OAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:smf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: pduSessionId + in: path + description: Identifier of the PDU session + required: true +``` + +``` + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + - name: smf-set-id + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + - name: smf-instance-id + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + - name: smf-events-implicitly-unsubscribed + in: query + description: Indication on SMF event subscriptions implicitly unsubscribed. + required: false + schema: + type: boolean + enum: + - true +responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +get: + summary: get an SMF registration + operationId: RetrieveSmfRegistration + tags: + - Retrieve SMF Registration + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: pduSessionId + in: path + description: Identifier of the PDU session + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmfRegistration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +``` + +``` +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +patch: + summary: update a parameter in the SMF registration + operationId: UpdateSmfRegistration + tags: + - Parameter update in the SMF registration + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:smf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: pduSessionId + in: path + description: Identifier of the PDU session + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SmfRegistrationModification' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/registrations/smsf-3gpp-access: + put: + summary: register as SMSF for 3GPP access + operationId: 3GppSmsfRegistration + tags: + - SMSF registration for 3GPP access + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:smsf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smsf-3gpp-access' + required: true + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110, +2.3 + schema: + type: string + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + headers: + ETag: + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110, +2.3 + schema: + type: string + '204': + description: No content + headers: + ETag: + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110, +2.3 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + dataRestorationNotification: + '{request.body#/dataRestorationCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataRestorationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + delete: + summary: delete the SMSF registration for 3GPP access + operationId: 3GppSmsfDeregistration + tags: + - SMSF Deregistration for 3GPP Access + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:smsf-registration:write + parameters: + - name: ueId +``` + +``` +in: path +description: Identifier of the UE +required: true +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +- name: smsf-set-id + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +- name: If-Match + in: header + description: Validator for conditional requests, as described in IETF RFC 9110, 3.1 + schema: + type: string +responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +get: + summary: retrieve the SMSF registration for 3GPP access information + operationId: Get3GppSmsfRegistration + tags: + - SMSF 3GPP access Registration Info Retrieval + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + - name: supported-features + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +``` + +``` + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +patch: + summary: update a parameter in the SMSF registration for 3GPP access + operationId: UpdateSmsf3GppRegistration + tags: + - Parameter update in the SMSF registration for 3GPP access + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:smsf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SmsfRegistrationModification' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/registrations/smsf-non-3gpp-access: + put: +``` + +``` +summary: register as SMSF for non-3GPP access +operationId: Non3GppSmsfRegistration +tags: + - SMSF registration for non-3GPP access +security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:smsf-registration:write +parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + required: true +responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' +``` + +``` +headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/smsf-non-3gpp-access' + required: true + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110, +2.3 + schema: + type: string +'200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + headers: + ETag: + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110, +2.3 + schema: + type: string +'204': + description: No content + headers: + ETag: + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110, +2.3 + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +callbacks: + dataRestorationNotification: + '{request.body#/dataRestorationCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataRestorationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +delete: + summary: delete SMSF registration for non 3GPP access + operationId: Non3GppSmsfDeregistration + tags: + - SMSF Deregistration for non-3GPP access + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:smsf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: smsf-set-id + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + - name: If-Match + in: header + description: Validator for conditional requests, as described in IETF RFC 9110, 3.1 + schema: + type: string + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +get: + summary: retrieve the SMSF registration for non-3GPP access information +``` + +``` +operationId: GetNon3GppSmsfRegistration +tags: + - SMSF non-3GPP access Registration Info Retrieval +parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + - name: supported-features + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +patch: + summary: update a parameter in the SMSF registration for non-3GPP access + operationId: UpdateSmsfNon3GppRegistration + tags: + - Parameter update in the SMSF registration for non-3GPP access + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:smsf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SmsfRegistrationModification' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' +``` + +``` +'204': + description: Expected response to a valid request +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{ueId}/registrations/ip-sm-gw: + put: + summary: Register an IP-SM-GW + operationId: IpSmGwRegistration + tags: + - IP-SM-GW registration + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:ip-sm-gw-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IpSmGwRegistration' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/IpSmGwRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudm-uecm/v1/{ueId}/registrations/ip-sm-gw' + required: true + schema: + type: string + '200': + description: Expected response to a valid request + content: + application/json: + schema: +``` + +``` + $ref: '#/components/schemas/IpSmGwRegistration' + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +delete: + summary: Delete the IP-SM-GW registration + operationId: IpSmGwDeregistration + tags: + - IP-SM-GW Deregistration + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:ip-sm-gw-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +get: + summary: Retrieve the IP-SM-GW registration information + operationId: GetIpSmGwRegistration + tags: + - IP-SM-GW Registration Info Retrieval + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/IpSmGwRegistration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/restore-pcscf: + post: + summary: Trigger the Restoration of the P-CSCF + operationId: Trigger P-CSCF Restoration + tags: + - Trigger P-CSCF Restoration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TriggerRequest' + required: true + responses: + '204': + description: Successful response + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/registrations/location: + get: + summary: retrieve the target UE's location information + operationId: GetLocationInfo + tags: + - UE Location Information retrieval + parameters: +``` + +``` +- name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: supported-features + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LocationInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{ueId}/registrations/nwdaf-registrations: + get: + summary: retrieve the NWDAF registration + operationId: GetNwdafRegistration + tags: + - NWDAF Registration Info Retrieval + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: analytics-ids + in: query + description: List of analytics Id(s) provided by the consumers of NWDAF. + schema: + type: array + items: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NwdafRegistration' + minItems: 1 + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{ueId}/registrations/nwdaf-registrations/{nwdafRegistrationId}: + put: + summary: register as NWDAF + operationId: NwdafRegistration + tags: + - NWDAF registration + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:nwdaf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: nwdafRegistrationId + in: path + description: NWDAF registration identifier + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafRegistration' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafRegistration' + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafRegistration' + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +delete: + summary: delete an NWDAF registration + operationId: NwdafDeregistration + tags: + - NWDAF Deregistration + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:nwdaf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: nwdafRegistrationId + in: path + description: NWDAF registration identifier + required: true + schema: + type: string + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +patch: + summary: Update a parameter in the NWDAF registration + operationId: UpdateNwdafRegistration + tags: + - Parameter update in the NWDAF registration + security: + - {} + - oAuth2ClientCredentials: + - nudm-uecm + - oAuth2ClientCredentials: + - nudm-uecm + - nudm-uecm:nwdaf-registration:write + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: nwdafRegistrationId + in: path +``` + +``` + description: NWDAF registration identifier + required: true + schema: + type: string + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/NwdafRegistrationModification' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/NwdafRegistration' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/registrations/auth-trigger: + get: + summary: trigger the primary (re-)authentication + operationId: authTrigger + tags: + - Trigger the primary (re-)authentication + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthTriggerInfo' + required: true + responses: + '204': +``` + +``` + + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudm-uecm: Access to the nudm-uecm API + nudm_uecm:amf-registration:write: Write access (update/modify) to representations of the +Amf3GppAccessRegistration and AmfNon3GppAccessRegistration resources + nudm_uecm:smf-registration:write: Write access (create/delete/modify) to the +representations of individualSmfRegistration resources + nudm_uecm:smsf-registration:write: Write access (create/delete/modify) to +representations of the Smsf3GppAccessRegistration and SmsfNon3GppAccessRegistration resources + nudm_uecm:ip-sm-gw-registration:write: Write access (create/delete/modify) to the +representation of the IpSmGwRegistration resource + nudm_uecm:nwdaif-registration:write: Write access (create/delete/modify) to the +representation of the NwdaifRegistration resource + +schemas: + +# COMPLEX TYPES: + +Amf3GppAccessRegistration: + description: > + This datatype contains the set of information relevant to the AMF where the UE + has registered via 3GPP access. + type: object + required: + - amfInstanceId + - deregCallbackUri + - guami + - ratType + properties: + amfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + purgeFlag: + $ref: '#/components/schemas/PurgeFlag' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + imsVoPs: + $ref: '#/components/schemas/ImsVoPs' + deregCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + amfServiceNameDereg: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + pcsfRestorationCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +``` + +``` +amfServiceNamePscsfRest: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' +initialRegistrationInd: + type: boolean +emergencyRegistrationInd: + type: boolean +guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +backupAmfInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' + minItems: 1 +drFlag: + $ref: '#/components/schemas/DualRegistrationFlag' +ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +urrrpIndicator: + type: boolean +amfEeSubscriptionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +epsInterworkingInfo: + $ref: '#/components/schemas/EpsInterworkingInfo' +ueSrvccCapability: + type: boolean +registrationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +vgmlcAddress: + $ref: '#/components/schemas/VgmlcAddress' +contextInfo: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo' +noEeSubscriptionInd: + type: boolean +supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +ueReachableInd: + $ref: '#/components/schemas/UeReachableInd' +reRegistrationRequired: + type: boolean +adminDeregSubWithdrawn: + type: boolean +dataRestorationCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +resetIds: + type: array + items: + type: string + minItems: 1 +disasterRoamingInd: + type: boolean + default: false +ueMINTCapability: + type: boolean +sorSnpnSiSupported: + type: boolean + default: false +udrRestartInd: + type: boolean + default: false +lastSynchronizationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +Amf3GppAccessRegistrationModification: + description: > + This datatype contains the set of attributes obtained from type + Amf3GppAccessRegistration by deleting attributes that are not subject to + modification by HTTP PATCH method. + type: object + required: + - guami + properties: + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + purgeFlag: + $ref: '#/components/schemas/PurgeFlag' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' +``` + +``` + +imsVoPs: + $ref: '#/components/schemas/ImsVoPs' +backupAmfInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' +epsInterworkingInfo: + $ref: '#/components/schemas/EpsInterworkingInfo' +ueSrvccCapability: + type: boolean + nullable: true +ueMINTCapability: + type: boolean + +EpsInterworkingInfo: + description: > + This information element contains the associations between APN/DNN and PGW-C+SMF + selected by the AMF for EPS interworking. + type: object + properties: + epsIwkPgws: + description: A map (list of key-value pairs where Dnn serves as key) of EpsIwkPgws + type: object + additionalProperties: + $ref: '#/components/schemas/EpsIwkPgw' + +EpsIwkPgw: + description: > + This datatype signifies the PGW FQDN, SMF instance ID and the PLMNId location. + type: object + required: + - pgwFqdn + - smfInstanceId + properties: + pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + +AmfNon3GppAccessRegistration: + description: > + Represents the complete set of information relevant to the AMF when the UE has registered + via non 3GPP access. + type: object + required: + - amfInstanceId + - imsVoPs + - deregCallbackUri + - guami + - ratType + properties: + amfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + purgeFlag: + $ref: '#/components/schemas/PurgeFlag' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + imsVoPs: + $ref: '#/components/schemas/ImsVoPs' + deregCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + amfServiceNameDereg: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + pscfRestorationCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + amfServiceNamePscfRest: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + backupAmfInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' + minItems: 1 + +``` + +``` +ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +urrpIndicator: + type: boolean +amfEeSubscriptionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +registrationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +vgmlcAddress: + $ref: '#/components/schemas/VgmlcAddress' +contextInfo: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo' +noEeSubscriptionInd: + type: boolean +supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +reRegistrationRequired: + type: boolean +adminDeregSubWithdrawn: + type: boolean +dataRestorationCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +resetIds: + type: array + items: + type: string + minItems: 1 +disasterRoamingInd: + type: boolean + default: false +sorSnpnSiSupported: + type: boolean + default: false +udrRestartInd: + type: boolean + default: false +``` + +``` + lastSynchronizationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +AmfNon3GppAccessRegistrationModification: + description: > + This data type contains attributes of AmfNon3GppAccessRegistration that can be + modified using PATCH. + type: object + required: + - guami + properties: + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + purgeFlag: + $ref: '#/components/schemas/PurgeFlag' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + imsVoPs: + $ref: '#/components/schemas/ImsVoPs' + backupAmfInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BackupAmfInfo' + +SmfRegistration: + description: > + This datatype contains a complete set of mandatory information relevant to an SMF + serving the UE. + type: object + required: + - smfInstanceId + - pduSessionId + - singleNssai + - plmnId + properties: + smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + smfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + emergencyServices: + type: boolean + pscfRestorationCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pgwIpAddress: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpAddress' + epdgInd: + type: boolean + default: false + deregCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + registrationReason: + $ref: '#/components/schemas/RegistrationReason' + registrationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + contextInfo: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo' + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + dataRestorationCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + resetIds: + type: array + items: + type: string + minItems: 1 + udrRestartInd: +``` + +``` + type: boolean + default: false + lastSynchronizationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + pduSessionReActivationRequired: + type: boolean + default: false + staleCheckCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + udmStaleCheckCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + wildcardInd: + type: boolean + +PduSessionIds: + type: object + properties: + pduSessionIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + minItems: 1 + +SmsfRegistration: + description: > + This datatype contains SMSF registration for 3GPP access that is created or updated + with the received information. + type: object + required: + - smsfInstanceId + - plmnId + properties: + smsfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + smsfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + smsfMAPAddress: + $ref: '#/components/schemas/E164Number' + smsfDiameterAddress: + $ref: '#/components/schemas/NetworkNodeDiameterAddress' + registrationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + contextInfo: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo' + dataRestorationCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + resetIds: + type: array + items: + type: string + minItems: 1 + smsfSbiSupInd: + type: boolean + default: false + udrRestartInd: + type: boolean + default: false + lastSynchronizationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ueMemoryAvailableInd: + type: boolean + enum: + - true + +DeregistrationData: + description: > + This datatype is supported by the POST HTTP method, and it includes the + deregistration data. + type: object + required: + - deregReason + properties: + deregReason: + $ref: '#/components/schemas/DeregistrationReason' +``` + +``` + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + newSmfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +PscsfRestorationNotification: + description: > + This datatype contains the SUPI optionally addresses the failed P-CSCF. It is + supported by the POST HTTP method. + type: object + required: + - supi + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + failedPscsf: + $ref: '#/components/schemas/PscsfAddress' + +NetworkNodeDiameterAddress: + description: > + This data type is a part of smfDiameterAddress and it should be present + whenever smf supports Diameter protocol. + type: object + required: + - name + - realm + properties: + name: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + realm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + +TriggerRequest: + description: > + This data type identifies if the NF service consumer requires to trigger P-CSCF + restoration. + type: object + required: + - supi + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + failedPscsf: + $ref: '#/components/schemas/PscsfAddress' + +SmfRegistrationInfo: + description: This data type provides information about the SMF registration information. + type: object + required: + - smfRegistrationList + properties: + smfRegistrationList: + type: array + items: + $ref: '#/components/schemas/SmfRegistration' + minItems: 1 + +IpSmGwRegistration: + description: This data type contains the IP-SW-GW routing information. + type: object + anyOf: + - required: [ ipSmGwMapAddress ] + - required: [ ipSmGwDiameterAddress ] + - required: [ ipsmgwIpv4 ] + - required: [ ipsmgwIpv6 ] + - required: [ ipsmgwFqdn ] + properties: + ipSmGwMapAddress: + $ref: '#/components/schemas/E164Number' + ipSmGwDiameterAddress: + $ref: '#/components/schemas/NetworkNodeDiameterAddress' + ipsmgwIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipsmgwIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + ipsmgwFqdn: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + unriIndicator: + type: boolean + default: false + resetIds: + type: array + items: + type: string + minItems: 1 + ipSmGwSbiSupInd: + type: boolean + default: false + +AmfDeregInfo: + description: This data type contains the reason of deregistration. + type: object + required: + - deregReason + properties: + deregReason: + $ref: '#/components/schemas/DeregistrationReason' + +LocationInfo: + description: This data type contains the UE's location information in 5GC. + type: object + required: + - registrationLocationInfoList + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + registrationLocationInfoList: + type: array + items: + $ref: '#/components/schemas/RegistrationLocationInfo' + minItems: 1 + maxItems: 2 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +RegistrationLocationInfo: + description: > + This data type contains the information about serving AMF, optional VGMLC and + access type related information used by (H)GMLC. + type: object + required: + - amfInstanceId + - accessTypeList + properties: + amfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + vgmlcAddress: + $ref: '#/components/schemas/VgmlcAddress' + accessTypeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + maxItems: 2 + +VgmlcAddress: + description: > + This data type contains the address(es) of VGMLC. + Depending on the names of Vgmlcaddress, it could indicate either VGMLC IPv4 or IPv6 + address. + type: object + properties: + vgmlcAddressIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + vgmlcAddressIpv6: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + vgm1cFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + +PeiUpdateInfo: + description: This data type contains information about the PEI. + type: object + required: + - pei + properties: + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + +RegistrationDatasetNames: + description: Represents the UECM registration dataset names. + type: array + items: + $ref: '#/components/schemas/RegistrationDataSetName' + minItems: 2 + uniqueItems: true + +RegistrationDataSets: + description: > + This data type contains all the attributes related to 3GPP access and + non-access registration. + type: object + properties: + amf3Gpp: + $ref: '#/components/schemas/Amf3GppAccessRegistration' + amfNon3Gpp: + $ref: '#/components/schemas/AmfNon3GppAccessRegistration' + smfRegistration: + $ref: '#/components/schemas/SmfRegistrationInfo' + smsf3Gpp: + $ref: '#/components/schemas/SmsfRegistration' + smsfNon3Gpp: + $ref: '#/components/schemas/SmsfRegistration' + ipSmGw: + $ref: '#/components/schemas/IpSmGwRegistration' + nwdaRegistration: + $ref: '#/components/schemas/NwdaRegistrationInfo' + +NwdaRegistration: + description: The complete set of information relevant to an NWDAF serving the UE + type: object + required: + - nwdaInstanceId + - analyticsIds + properties: + nwdaInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + analyticsIds: + type: array + items: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventId' + minItems: 1 + nwdaSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + registrationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + contextInfo: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + +NwdaRegistrationModification: + description: Contains attributes of NwdaRegistration that can be modified using PATCH + type: object + required: + - nwdaInstanceId + properties: + nwdaInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +``` + +``` + nwDafSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + analyticsIds: + type: array + items: + $ref: 'TS29520_NnwDaf_AnalyticsInfo.yaml#/components/schemas/EventId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +SmfRegistrationModification: + description: Contains attributes of SmfRegistration that can be modified using PATCH + type: object + required: + - smfInstanceId + properties: + smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + smfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FqdnRm' + +DataRestorationNotification: + description: Contains identities representing those UEs potentially affected by a data-loss + event at the UDR + type: object + properties: + lastReplicationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + supiRanges: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IdentityRange' + minItems: 1 + resetIds: + type: array + items: + type: string + minItems: 1 + sNssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + +RoamingInfoUpdate: + description: Contains the Roaming Information Update + type: object + required: + - servingPlmn + properties: + roaming: + type: + boolean + servingPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + +PscfAddress: + description: Contains the addressing information (IP addresses and/or FQDN) of the P-CSCF + type: object + anyOf: + - required: [ipv4Addrs] +``` + +``` +- required: [ipv6Addrs] +- required: [fqdn] +properties: + ipv4Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + +NwdafRegistrationInfo: + description: List of NwdafRegistration + type: object + required: + - nwdafRegistrationList + properties: + nwdafRegistrationList: + type: array + items: + $ref: '#/components/schemas/NwdafRegistration' + minItems: 1 + +RoutingInfoSmRequest: + description: Request body of the send-routing-info-sm custom operation + type: object + properties: + ipSmGwInd: + type: boolean + default: false + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +RoutingInfoSmResponse: + description: Addressing information of available nodes for SMS delivery + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + smsf3Gpp: + $ref: '#/components/schemas/SmsfRegistration' + smsfNon3Gpp: + $ref: '#/components/schemas/SmsfRegistration' + ipSmGw: + $ref: '#/components/schemas/IpSmGwInfo' + smsRouter: + $ref: '#/components/schemas/SmsRouterInfo' + +IpSmGwInfo: + description: Contains the IP-SM-GW Information + type: object + properties: + ipSmGwRegistration: + $ref: '#/components/schemas/IpSmGwRegistration' + ipSmGwGuidance: + $ref: '#/components/schemas/IpSmGwGuidance' + +IpSmGwGuidance: + description: > + Contains guidance information (e.g. minimum and recommended delivery times) of the IP-SM-GW + type: object + required: + - minDeliveryTime + - recommDeliveryTime + properties: + minDeliveryTime: + type: integer + minimum: 30 + maximum: 600 + recommDeliveryTime: + type: integer + minimum: 30 + maximum: 600 +``` + +``` +SmsRouterInfo: + description: Addressing information of the SMS Router configured at the UDM + type: object + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + diameterAddress: + $ref: '#/components/schemas/NetworkNodeDiameterAddress' + mapAddress: + $ref: '#/components/schemas/E164Number' + routerIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + routerIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + routerFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + +SmsfRegistrationModification: + description: Contains attributes of SmsfRegistration that can be modified using PATCH + type: object + required: + - smsfInstanceId + properties: + smsfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + smsfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + ueMemoryAvailableInd: + type: boolean + enum: + - true + +ReauthNotificationInfo: + description: Contains the SUPI to identify the UE that is subject to reauthentication + type: object + required: + - supi + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + +AuthTriggerInfo: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + +DeregistrationRespData: + type: object + properties: + smfEventRemovedInd: + type: boolean + enum: + - true +``` + +# # SIMPLE TYPES: + +``` +PurgeFlag: + description: > + This flag indicates whether an AMF is deregistered. This attribute may be included + in notifications sent by the UDR to the UDM if purgeFlag is also set to true in the + same notification. + type: boolean + +E164Number: + description: > + This data type mentions International E.164 number of the SMSF; shall be present if + the SMSF supports MAP. + type: string + pattern: '^[0-9]{1,15}$' + +DualRegistrationFlag: + description: > + This data type indicates that the UDM+HSS is requested not to send S6a-CLR + to the registered MME/SGSN (if any). + type: boolean +``` + +## # ENUMS: + +ImsVoPs: +description: > +It represents the information indicating homogeneity of +IMS Voice over PS Sessions support for the UE +anyOf: +- type: string +enum: +- HOMOGENEOUS\_SUPPORT +- HOMOGENEOUS\_NON\_SUPPORT +- NON\_HOMOGENEOUS\_OR\_UNKNOWN +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +DeregistrationReason: +description: > +It represents the reason of Deregistration Notification. +anyOf: +- type: string +enum: +- UE\_INITIAL\_REGISTRATION +- UE\_REGISTRATION\_AREA\_CHANGE +- SUBSCRIPTION\_WITHDRAWN +- 5GS TO EPS MOBILITY +- 5GS TO EPS MOBILITY\_UE\_INITIAL\_REGISTRATION +- REREGISTRATION\_REQUIRED +- SMF\_CONTEXT\_TRANSFERRED +- DUPLICATE\_PDU\_SESSION +- PDU\_SESSION\_REACTIVATION\_REQUIRED +- DISASTER\_CONDITION\_TERMINATED +- OPERATOR\_DETERMINED\_BARRING +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +RegistrationReason: +description: > +Indicates NF registration reason. +anyOf: +- type: string +enum: +- SMF\_CONTEXT\_TRANSFERRED +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +RegistrationDataSetName: +description: > +Indicates the names of registration data sets to be retrieved. +anyOf: +- type: string +enum: +- AMF\_3GPP +- AMF\_NON\_3GPP +- SMF\_PDU\_SESSIONS +- SMSF\_3GPP +- SMSF\_NON\_3GPP +- IP\_SM\_GW +- NWDAF +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +UeReachableInd: +description: UE Reachable Indication +anyOf: +- type: string + +``` +enum: + - REACHABLE + - NOT_REACHABLE + - UNKNOWN +- type: string +description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +``` + +## --- A.4 Nudm\_UEAU API + +``` +openapi: 3.0.0 +info: + version: '1.3.0-alpha.4' + title: 'Nudm_UEAU' + description: | + UDM UE Authentication Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.503 Unified Data Management Services, version 18.4.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' + +servers: +- url: '{apiRoot}/nudm-ueau/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: +- oAuth2ClientCredentials: + - nudm-ueau +- {} + +paths: + /{supiOrSuci}/security-information/generate-auth-data: + post: + summary: Generate authentication data for the UE + operationId: GenerateAuthData + tags: + - Generate Auth Data + security: + - {} + - oAuth2ClientCredentials: + - nudm-ueau + - oAuth2ClientCredentials: + - nudm-ueau + - nudm-ueau:security-information:generate-auth-data:invoke + parameters: + - name: supiOrSuci + in: path + description: SUPI or SUCI of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupiOrSuci' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticationInfoRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticationInfoResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +``` + +``` +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{supiOrSuci}/security-information-rg: + get: + summary: Get authentication data for the FN-RG + operationId: GetRgAuthData + tags: + - Get Auth Data for FN-RG + security: + - {} + - oAuth2ClientCredentials: + - nudm-ueau + - oAuth2ClientCredentials: + - nudm-ueau + - nudm-ueau:security-information-rg:read + parameters: + - name: supiOrSuci + in: path + description: SUPI or SUCI of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupiOrSuci' + - name: authenticated-ind + in: query + description: Authenticated indication + required: true + schema: + $ref: '#/components/schemas/AuthenticatedInd' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: serving PLMN ID + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 3.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/RgAuthCtx' +``` + +``` +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{supi}/auth-events: + post: + summary: Create a new confirmation event + operationId: ConfirmAuth + tags: + - Confirm Auth + security: + - {} + - oAuth2ClientCredentials: + - nudm-ueau + - oAuth2ClientCredentials: + - nudm-ueau + - nudm-ueau:auth-events:create + parameters: + - name: supi + in: path + description: SUPI of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthEvent' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AuthEvent' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudm-ueau/v1/{supi}/auth-events/{authEventId}' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + dataRestorationNotification: + '{request.body#/dataRestorationCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/DataRestorationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{supi}/hss-security-information/{hssAuthType}/generate-av: + post: + summary: Generate authentication data for the UE in EPS or IMS domain + operationId: GenerateAv + tags: + - Generate HSS Authentication Vectors + security: + - {} + - oAuth2ClientCredentials: + - nudm-ueau + - oAuth2ClientCredentials: + - nudm-ueau + - nudm-ueau:hss-security-information:generate-av:invoke + parameters: + - name: supi + in: path + description: SUPI of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: hssAuthType + in: path + description: Type of AV requested by HSS + required: true + schema: + $ref: '#/components/schemas/HssAuthTypeInUri' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HssAuthenticationInfoRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/HssAuthenticationInfoResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +``` + +``` +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{supi}/auth-events/{authEventId}: + put: + summary: Deletes the authentication result in the UDM + operationId: DeleteAuth + tags: + - Delete Auth +``` + +``` +security: +- {} +- oAuth2ClientCredentials: +- nudm-ueau +- oAuth2ClientCredentials: +- nudm-ueau +- nudm-ueau:auth-event-id:modify +parameters: +- name: supi + in: path + description: SUPI of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +- name: authEventId + in: path + description: authEvent Id + required: true + schema: + type: string +requestBody: +content: + application/json: + schema: + $ref: '#/components/schemas/AuthEvent' +required: true +responses: +'204': + description: Expected response to a successful authentication result removal +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/{supi}/gba-security-information/generate-av: +post: + summary: Generate authentication data for the UE in GBA domain + operationId: GenerateGbaAv + tags: + - Generate GBA Authentication Vectors + security: + - {} + - oAuth2ClientCredentials: + - nudm-ueau + - oAuth2ClientCredentials: + - nudm-ueau + - nudm-ueau:gba-security-information:generate-av:invoke + parameters: + - name: supi + in: path + description: SUPI of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: +``` + +``` + $ref: '#/components/schemas/GbaAuthenticationInfoRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/GbaAuthenticationInfoResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +{/supiOrSuci}/prose-security-information/generate-av: + post: + summary: Generate authentication data for ProSe + operationId: GenerateProseAV + tags: + - Generate ProSe Authentication Vectors + parameters: + - name: supiOrSuci + in: path + description: SUPI or SUCI of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupiOrSuci' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProSeAuthenticationInfoRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ProSeAuthenticationInfoResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +``` + +``` + + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudm-ueau: Access to the nudm-ueau API + nudm-ueau:security-information:generate-auth-data:invoke: Access to invoke the "generate- +auth-data" custom operation on the "security-information" resource + nudm-ueau:security-information-rg:read: Access to read the "security-information-rg" +resource + nudm-ueau:auth-events:create: Access to create a new child resource on the "auth-events" +collection resource + nudm-ueau:auth-event-id:modify: Access to modify (delete) an "auth-event-id" individual +resource + nudm-ueau:hss-security-information:generate-av:invoke: Access to invoke the "generate-av" +custom operation on the "hss-security-information" resource + nudm-ueau:gba-security-information:generate-av:invoke: Access to invoke the "generate-av" +custom operation on the "gba-security-information" resource + +schemas: + +# COMPLEX TYPES: + + AuthenticationInfoRequest: + type: object + required: + - servingNetworkName + - ausfInstanceId + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + servingNetworkName: + $ref: '#/components/schemas/ServingNetworkName' + resynchronizationInfo: + $ref: '#/components/schemas/ResynchronizationInfo' + ausfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + cellCagInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CagId' + minItems: 1 + n5gcInd: + type: boolean + default: false + nswoInd: + type: boolean + default: false + disasterRoamingInd: + type: boolean + default: false + aun3Ind: + type: boolean + default: false + + AuthenticationInfoResult: + type: object + required: + - authType + properties: + authType: + $ref: '#/components/schemas/AuthType' + supportedFeatures: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + authenticationVector: + $ref: '#/components/schemas/AuthenticationVector' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + akmaInd: + type: boolean + default: false + authAaa: + type: boolean + default: false + routingId: + type: string + pattern: '^[0-9]{1,4}$' + pvsInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServerAddressingInfo' + minItems: 1 + mskInd: + type: boolean + default: false + +AuthenticationVector: + oneOf: + - $ref: '#/components/schemas/AvEapAkaPrime' + - $ref: '#/components/schemas/Av5GHeAka' + discriminator: + propertyName: avType + mapping: + 5G_HE_AKA: '#/components/schemas/Av5GHeAka' + EAP_AKA_PRIME: '#/components/schemas/AvEapAkaPrime' + +AvEapAkaPrime: + type: object + required: + - avType + - rand + - xres + - autn + - ckPrime + - ikPrime + properties: + avType: + $ref: '#/components/schemas/AvType' + rand: + $ref: '#/components/schemas/Rand' + xres: + $ref: '#/components/schemas/Xres' + autn: + $ref: '#/components/schemas/Autn' + ckPrime: + $ref: '#/components/schemas/CkPrime' + ikPrime: + $ref: '#/components/schemas/IkPrime' + +Av5GHeAka: + type: object + required: + - avType + - rand + - xresStar + - autn + - kausf + properties: + avType: + $ref: '#/components/schemas/AvType' + rand: + $ref: '#/components/schemas/Rand' + xresStar: + $ref: '#/components/schemas/XresStar' + autn: + $ref: '#/components/schemas/Autn' + kausf: + $ref: '#/components/schemas/Kausf' + +ResynchronizationInfo: + type: object +``` + +``` +required: + - rand + - autos +properties: + rand: + $ref: '#/components/schemas/Rand' + autos: + $ref: '#/components/schemas/Auts' + +AuthEvent: + type: object + required: + - nfInstanceId + - success + - timeStamp + - authType + - servingNetworkName + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + success: + $ref: '#/components/schemas/Success' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + authType: + $ref: '#/components/schemas/AuthType' + servingNetworkName: + $ref: '#/components/schemas/ServingNetworkName' + authRemovalInd: + type: boolean + default: false + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + resetIds: + type: array + items: + type: string + minItems: 1 + dataRestorationCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + udrRestartInd: + type: boolean + default: false + +RgAuthCtx: + type: object + required: + - authInd + properties: + authInd: + type: boolean + default: false + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +HssAuthenticationInfoRequest: + type: object + required: + - hssAuthType + - numOfRequestedVectors + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + hssAuthType: + $ref: '#/components/schemas/HssAuthType' + numOfRequestedVectors: + $ref: '#/components/schemas/NumOfRequestedVectors' + requestingNodeType: + $ref: '#/components/schemas/NodeType' + servingNetworkId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + resynchronizationInfo: + $ref: '#/components/schemas/ResynchronizationInfo' + anId: + $ref: '#/components/schemas/AccessNetworkId' +``` + +``` +HssAuthenticationInfoResult: + type: object + required: + - hssAuthenticationVectors + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + hssAuthenticationVectors: + $ref: '#/components/schemas/HssAuthenticationVectors' + +HssAuthenticationVectors: + oneOf: + - type: array + items: + $ref: '#/components/schemas/AvEpsAka' + minItems: 1 + maxItems: 5 + - type: array + items: + $ref: '#/components/schemas/AvImsGbaEapAka' + minItems: 1 + maxItems: 5 + - type: array + items: + $ref: '#/components/schemas/AvEapAkaPrime' + minItems: 1 + maxItems: 5 + +AvEpsAka: + type: object + required: + - avType + - rand + - xres + - autn + - kasme + properties: + avType: + $ref: '#/components/schemas/HssAvType' + rand: + $ref: '#/components/schemas/Rand' + xres: + $ref: '#/components/schemas/Xres' + autn: + $ref: '#/components/schemas/Autn' + kasme: + $ref: '#/components/schemas/Kasme' + +AvImsGbaEapAka: + type: object + required: + - avType + - rand + - xres + - autn + - ck + - ik + properties: + avType: + $ref: '#/components/schemas/HssAvType' + rand: + $ref: '#/components/schemas/Rand' + xres: + $ref: '#/components/schemas/Xres' + autn: + $ref: '#/components/schemas/Autn' + ck: + $ref: '#/components/schemas/ConfidentialityKey' + ik: + $ref: '#/components/schemas/IntegrityKey' + +GbaAuthenticationInfoRequest: + type: object + required: + - authType + properties: + authType: + $ref: '#/components/schemas/GbaAuthType' +``` + +``` + resynchronizationInfo: + $ref: 'TS29562_Nhss_imsUEAU.yaml#/components/schemas/ResynchronizationInfo' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +GbaAuthenticationInfoResult: + type: object + properties: + 3gAkaAv: + $ref: 'TS29562_Nhss_imsUEAU.yaml#/components/schemas/3GAkaAv' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +ProSeAuthenticationInfoRequest: + type: object + required: + - servingNetworkName + - relayServiceCode + properties: + servingNetworkName: + $ref: '#/components/schemas/ServingNetworkName' + relayServiceCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RelayServiceCode' + resynchronizationInfo: + $ref: '#/components/schemas/ResynchronizationInfo' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +ProSeAuthenticationInfoResult: + type: object + required: + - authType + properties: + authType: + $ref: '#/components/schemas/AuthType' + proseAuthenticationVectors: + $ref: '#/components/schemas/ProSeAuthenticationVectors' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +ProSeAuthenticationVectors: + oneOf: + - type: array + items: + $ref: '#/components/schemas/AvEapAkaPrime' + minItems: 1 + maxItems: 5 + +# SIMPLE TYPES: + +Autn: + type: string + pattern: '^[A-Fa-f0-9]{32}$' + +Auts: + type: string + pattern: '^[A-Fa-f0-9]{28}$' + +CkPrime: + type: string + pattern: '^[A-Fa-f0-9]{32}$' + +IkPrime: + type: string + pattern: '^[A-Fa-f0-9]{32}$' + +Kausf: + type: string + pattern: '^[A-Fa-f0-9]{64}$' + +Rand: + type: string + pattern: '^[A-Fa-f0-9]{32}$' +``` + +Xres: +type: string +pattern: '^[A-Fa-f0-9]{8,32}\$' + +XresStar: +type: string +pattern: '^[A-Fa-f0-9]{32}\$' + +ServingNetworkName: +type: string +pattern: '(5G:mnc[0-9]{3}[.]mcc[0-9]{3}[.]3gppnetwork[.]org(:[A-F0-9]{11})?)|5G:NSWO\$' + +Success: +type: boolean + +AuthenticatedInd: +type: boolean + +ConfidentialityKey: +type: string +pattern: '^[A-Fa-f0-9]{32}\$' + +IntegrityKey: +type: string +pattern: '^[A-Fa-f0-9]{32}\$' + +Kasme: +type: string +pattern: '^[A-Fa-f0-9]{64}\$' + +NumOfRequestedVectors: +type: integer +minimum: 1 +maximum: 5 + +# # ENUMS: + +AuthType: +description: Indicates the authentication method. +anyOf: +- type: string +enum: +- 5G\_AKA +- EAP\_AKA\_PRIME +- EAP\_TLS +- NONE +- EAP\_TTLS +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +AvType: +description: Indicates the type of authentication vector. +anyOf: +- type: string +enum: +- 5G\_HE\_AKA +- EAP\_AKA\_PRIME +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +HssAuthType: +description: Indicates the authentication method. +anyOf: +- type: string +enum: +- EPS\_AKA +- EAP\_AKA +- EAP\_AKA\_PRIME +- IMS\_AKA +- GBA\_AKA +- UMTS\_AKA + +``` +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +HssAvType: + description: Indicates a type of authentication vector. + anyOf: + - type: string + enum: + - EPS_AKA + - EAP_AKA + - IMS_AKA + - GBA_AKA + - UMTS_AKA + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +HssAuthTypeInUri: + description: Indicates a type of authentication method. + anyOf: + - type: string + enum: + - eps-aka + - eap-aka + - eap-aka-prime + - ims-aka + - gba-aka + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +AccessNetworkId: + description: > + Indicates the contents of Access Network ID. + Used in the derivation of authentication vectors in EAP-AKA. + anyOf: + - type: string + enum: + - HRPD + - WIMAX + - WLAN + - ETHERNET + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +NodeType: + description: > + Indicates Indicates the requesting node type. + anyOf: + - type: string + enum: + - AUSF + - VLR + - SGSN + - S_CSCF + - BSF + - GAN_AAA_SERVER + - WLAN_AAA_SERVER + - MME + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +GbaAuthType: + description: Indicates the authentication method. + anyOf: +``` + +``` + +- type: string +enum: +- DIGEST_AKAV1_MD5 +- type: string +description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + +``` + +## A.5 Nudm\_EE API + +openapi: 3.0.0 + +``` + +info: + version: '1.3.0-alpha.5' + title: 'Nudm_EE' + description: | + Nudm Event Exposure Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.503 Unified Data Management Services, version 18.4.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' + +servers: +- url: '{apiRoot}/nudm-ee/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: +- oAuth2ClientCredentials: +- nudm-ee +- {} + +paths: + /{ueIdentity}/ee-subscriptions: + post: + summary: Subscribe + operationId: CreateEeSubscription + tags: + - Create EE Subscription + security: + - {} + - oAuth2ClientCredentials: + - nudm-ee + - oAuth2ClientCredentials: + - nudm-ee + - nudm-ee:subscription:create + parameters: + - name: ueIdentity + in: path + description: Represents the scope of the UE for which the subscription is applied. + Contains the GPSI of the user or the external group ID or any UE. + required: true + schema: + type: string + pattern: '^^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^\@]+\+|extgroupid-[^@]+@[^\@]+\+|anyUE)$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EeSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedEeSubscription' + +``` + +``` +headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudm-ee/v1/{ueIdentity}/ee-subscriptions/{subscriptionId}' + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/EeSubscriptionError' +'404': + description: Not Found + content: + application/problem+json: + schema: + $ref: '#/components/schemas/EeSubscriptionError' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + description: Not Implemented + content: + application/problem+json: + schema: + $ref: '#/components/schemas/EeSubscriptionError' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +callbacks: + eventOccurrenceNotification: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MonitoringReport' + minItems: 1 +responses: + '204': + description: Successful Notification response + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +monitoringRevocationNotification: + '{request.body#/secondCallbackRef}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EeMonitoringRevoked' + responses: + '204': + description: Successful Notification response + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +dataRestorationNotification: + '{request.body#/dataRestorationCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/DataRestorationNotification' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueIdentity}/ee-subscriptions/{subscriptionId}: + delete: + summary: Unsubscribe + operationId: DeleteEeSubscription + tags: + - Delete EE Subscription + security: + - {} + - oAuth2ClientCredentials: + - nudm-ee + - oAuth2ClientCredentials: + - nudm-ee + - nudm-ee:subscription:modify + parameters: + - name: ueIdentity + in: path + description: Represents the scope of the UE for which the subscription is applied. + Contains the GPSI of the user or the external group ID or any UE. + required: true + schema: + type: string + pattern: '^^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^\@]+\+|extgroupid-[^@]+@[^\@]+\+|anyUE)$' + - name: subscriptionId + in: path + description: Id of the EE Subscription + required: true + schema: + type: string + responses: + '204': + description: Successful response + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + patch: + summary: Patch + operationId: UpdateEeSubscription + tags: + - Update EE Subscription + security: + - {} + - oAuth2ClientCredentials: + - nudm-ee + - oAuth2ClientCredentials: + - nudm-ee + - nudm-ee:subscription:modify + parameters: + - name: ueIdentity + in: path + description: Represents the scope of the UE for which the subscription is applied. + Contains the GPSI of the user or the external group ID or any UE. + required: true + schema: + +``` + +``` + type: string + pattern: '^^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^\@]+\|extgroupid-[^@]+\|@[^\@]+\|anyUE)$' +- name: subscriptionId + in: path + description: Id of the EE Subscription + required: true + schema: + type: string +- name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful response + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudm-ee: Access to the nudm-ee API + nudm-ee:subscription:create: Access to create EE Subscriptions + nudm-ee:subscription:modify: Access to update EE Subscriptions + +schemas: + +# COMPLEX TYPES: + +CreatedEeSubscription: + type: object + required: + - eeSubscription + properties: + eeSubscription: + $ref: '#/components/schemas/EeSubscription' + numberOfUes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + eventReports: + type: array + items: + $ref: '#/components/schemas/MonitoringReport' + minItems: 1 + epcStatusInd: + type: boolean + 5gOnlyInd: + type: boolean + enum: + - true + failedMonitoringConfigs: + description: > + A map (list of key-value pairs where referenceId converted from integer to string serves + as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration + type: object + additionalProperties: + $ref: '#/components/schemas/FailedMonitoringConfiguration' + minProperties: 1 + failedMoniConfigsEPC: + description: > + A map (list of key-value pairs where referenceId converted from integer to string serves + as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration, the key value "ALL" may + be used to identify a map entry which contains the failed cause of the EE subscription + was not successful in EPC domain. + type: object + additionalProperties: + $ref: '#/components/schemas/FailedMonitoringConfiguration' + minProperties: 1 + resetIds: + type: array + items: + type: string + minItems: 1 + currentStatusNotAvailableList: + type: array +``` + +``` +items: + $ref: '#/components/schemas/EventType' +minItems: 1 +``` + +``` +FailedMonitoringConfiguration: + description: Contains the event type and failed cause of the failed Monitoring Configuration + in the EE subscription + type: object + required: + - eventType + - failedCause + properties: + eventType: + $ref: '#/components/schemas/EventType' + failedCause: + $ref: '#/components/schemas/FailedCause' +``` + +``` +EeSubscription: + type: object + required: + - callbackReference + - monitoringConfigurations + properties: + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monitoringConfigurations: + description: A map (list of key-value pairs where ReferenceId serves as key) of +MonitoringConfigurations + type: object + additionalProperties: + $ref: '#/components/schemas/MonitoringConfiguration' + minProperties: 1 + reportingOptions: + $ref: '#/components/schemas/ReportingOptions' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + subscriptionId: + type: string + contextInfo: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo' + epcAppliedInd: + type: boolean + default: false + scefdiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + scefdiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + notifyCorrelationId: + type: string + secondCallbackRef: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + excludeGpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + includeGpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + dataRestorationCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + udrRestartInd: + type: boolean + default: false +``` + +``` +MonitoringConfiguration: + type: object + required: + - eventType + properties: + eventType: + $ref: '#/components/schemas/EventType' +``` + +``` +immediateFlag: + type: boolean +locationReportingConfiguration: + $ref: '#/components/schemas/LocationReportingConfiguration' +associationType: + $ref: '#/components/schemas/AssociationType' +datalinkReportCfg: + $ref: '#/components/schemas/DatalinkReportingConfiguration' +lossConnectivityCfg: + $ref: '#/components/schemas/LossConnectivityCfg' +maximumLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +maximumResponseTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +suggestedPacketNumDl: + type: integer + minimum: 1 +dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' +pduSessionStatusCfg: + $ref: '#/components/schemas/PduSessionStatusCfg' +reachabilityForSmsCfg: + $ref: '#/components/schemas/ReachabilityForSmsConfiguration' +mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' +afId: + type: string +reachabilityForDataCfg: + $ref: '#/components/schemas/ReachabilityForDataConfiguration' +idleStatusInd: + type: boolean + default: false +monitoringSuspension: + $ref: '#/components/schemas/MonitoringSuspension' + +MonitoringSuspension: + type: object + properties: + suspendedInsidePlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + suspendedOutsidePlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + +LossConnectivityCfg: + type: object + properties: + maxDetectionTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +LocationReportingConfiguration: + type: object + required: + - currentLocation + properties: + currentLocation: + type: boolean + oneTime: + type: boolean + accuracy: + $ref: '#/components/schemas/LocationAccuracy' + n3gppAccuracy: + $ref: '#/components/schemas/LocationAccuracy' + +ReportingOptions: + type: object + properties: + reportMode: + $ref: '#/components/schemas/EventReportMode' +``` + +``` +maxNumOfReports: + $ref: '#/components/schemas/MaxNumOfReports' +expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +samplingRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' +guardTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +reportPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +notifFlag: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag' +mutingExcInstructions: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingExceptionInstructions' +mutingNotSettings: + readOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingNotificationsSettings' +varRepPeriodInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarRepPeriod' + minItems: 1 + +MonitoringReport: + type: object + required: + - referenceId + - eventType + - timeStamp + properties: + referenceId: + $ref: '#/components/schemas/ReferenceId' + eventType: + $ref: '#/components/schemas/EventType' + report: + $ref: '#/components/schemas/Report' + reachabilityForSmsReport: + $ref: '#/components/schemas/ReachabilityForSmsReport' + gps: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reachabilityReport: + $ref: '#/components/schemas/ReachabilityReport' + +Report: + oneOf: + - $ref: '#/components/schemas/ChangeOfSupiPeiAssociationReport' + - $ref: '#/components/schemas/RoamingStatusReport' + - $ref: '#/components/schemas/CnTypeChangeReport' + - $ref: '#/components/schemas/CmInfoReport' + - $ref: '#/components/schemas/LossConnectivityReport' + - $ref: '#/components/schemas/LocationReport' + - $ref: '#/components/schemas/PdnConnectivityStatReport' + - $ref: '#/components/schemas/GroupMembListChanges' + +ReachabilityForSmsReport: + type: object + required: + - smsfAccessType + properties: + smsfAccessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + maxAvailabilityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +ChangeOfSupiPeiAssociationReport: + type: object + required: + - newPei + properties: + newPei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + +RoamingStatusReport: + type: object +``` + +``` +required: + - roaming + - newServingPlmn +properties: + roaming: + type: boolean + newServingPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + purged: + type: boolean + enum: + - true + +CnTypeChangeReport: + type: object + required: + - newCnType + properties: + newCnType: + $ref: '#/components/schemas/CnType' + oldCnType: + $ref: '#/components/schemas/CnType' + +DatalinkReportingConfiguration: + type: object + properties: + dddTrafficDes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' + minItems: 1 + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + slice: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dddStatusList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' + minItems: 1 + +CmInfoReport: + type: object + properties: + oldCmInfoList: + type: array + items: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmInfo' + minItems: 1 + maxItems: 2 + newCmInfoList: + type: array + items: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmInfo' + minItems: 1 + maxItems: 2 + required: + - newCmInfoList + +PduSessionStatusCfg: + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + +ReachabilityReport: + type: object + properties: + amfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + accessTypeList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + reachability: +``` + +``` + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability' + maxAvailabilityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + idleStatusIndication: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/IdleStatusIndication' + +ReachabilityForDataConfiguration: + type: object + required: + - reportCfg + properties: + reportCfg: + $ref: '#/components/schemas/ReachabilityForDataReportConfig' + minInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +EeMonitoringRevoked: + type: object + required: + - revokedMonitoringEventList + properties: + revokedMonitoringEventList: + description: A map (list of key-value pairs where ReferenceId serves as key) of +MonitoringEvents + type: object + additionalProperties: + $ref: '#/components/schemas/MonitoringEvent' + minProperties: 1 + removedGpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + excludeGpsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + +MonitoringEvent: + type: object + required: + - eventType + properties: + eventType: + $ref: '#/components/schemas/EventType' + revokedCause: + $ref: '#/components/schemas/RevokedCause' + +LossConnectivityReport: + type: object + required: + - lossOfConnectReason + properties: + lossOfConnectReason: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/LossOfConnectivityReason' + +LocationReport: + type: object + required: + - location + properties: + location: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + +PdnConnectivityStatReport: + type: object + required: + - pdnConnStat + properties: + pdnConnStat: + $ref: '#/components/schemas/PdnConnectivityStatus' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + pduSeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Prefixes: + type: array + items: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + ipv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + pduSessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + +GroupMembListChanges: + description: Represents information on the change(s) to a group's members list. + type: object + properties: + addedUEs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + removedUEs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + anyOf: + - required: [addedUEs] + - required: [removedUEs] + +EeSubscriptionErrorAddInfo: + description: Additional Information for EE Subscription Error. + type: object + properties: + subType: + $ref: '#/components/schemas/SubscriptionType' + failedMonitoringConfigs: + description: > + A map (list of key-value pairs where referenceId converted from integer to string serves + as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration + type: object + additionalProperties: + $ref: '#/components/schemas/FailedMonitoringConfiguration' + minProperties: 1 + failedMoniConfigsEPC: + description: > + A map (list of key-value pairs where referenceId converted from integer to string serves + as key; see clause 6.4.6.3.2) of FailedMonitoringConfiguration, the key value "ALL" may + be used to identify a map entry which contains the failed cause of the EE subscription + was not successful in EPC domain. + type: object + additionalProperties: + $ref: '#/components/schemas/FailedMonitoringConfiguration' + minProperties: 1 + +EeSubscriptionError: + description: EE Subscription Error. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/EeSubscriptionErrorAddInfo' + +# SIMPLE TYPES: + +ReferenceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + +MaxNumOfReports: + type: integer + +# ENUMS: + +ReachabilityForSmsConfiguration: + description: > + Indicates the configuration for report of reachability status for SMS. + anyOf: + - type: string + enum: + - REACHABILITY_FOR_SMS_OVER_NAS +``` + +``` +- REACHABILITY_FOR_SMS_OVER_IP +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +EventType: +description: Indicates the event type of UDM Event Exposure service. +anyOf: +- type: string +enum: +- LOSS_OF_CONNECTIVITY +- UE_REACHABILITY_FOR_DATA +- UE_REACHABILITY_FOR_SMS +- LOCATION_REPORTING +- CHANGE_OF_SUPI_PEI_ASSOCIATION +- ROAMING_STATUS +- COMMUNICATION_FAILURE +- AVAILABILITY_AFTER_DDN_FAILURE +- CN_TYPE_CHANGE +- DL_DATA_DELIVERY_STATUS +- PDN_CONNECTIVITY_STATUS +- UE_CONNECTION_MANAGEMENT_STATE +- ACCESS_TYPE_REPORT +- REGISTRATION_STATE_REPORT +- CONNECTIVITY_STATE_REPORT +- TYPE ALLOCATION CODE REPORT +- FREQUENT_MOBILITY_REGISTRATION_REPORT +- PDU_SES_REL +- PDU_SES_EST +- UE_MEMORY_AVAILABLE_FOR_SMS +- GROUP_MEMBER_LIST_CHANGE +- QOS_MON +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +LocationAccuracy: +description: Indicates the location accuracy level. +anyOf: +- type: string +enum: +- CELL_LEVEL +- RAN_NODE_LEVEL +- TA_LEVEL +- N3IWF_LEVEL +- UE_IP +- UE_PORT +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +CnType: +description: Indicates the core network type. +anyOf: +- type: string +enum: +- SINGLE_4G +- SINGLE_5G +- DUAL_4G5G +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +AssociationType: +description: > +Indicates association type to be included to identify +whether it is IMSI-IMEI or IMSI-IMEISV. +anyOf: +- type: string +enum: +``` + +``` +- IMEI_CHANGE +- IMEISV_CHANGE +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +EventReportMode: +description: Event report mode. +anyOf: +- type: string +enum: +- PERIODIC +- ON_EVENT_DETECTION +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +ReachabilityForDataReportConfig: +description: > +Indicates the configuration for report of +reachability status for data. +anyOf: +- type: string +enum: +- DIRECT_REPORT +- INDIRECT_REPORT +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +RevokedCause: +description: Revocation Cause for the monitoring event. +anyOf: +- type: string +enum: +- NOT_ALLOWED +- EXCLUDED_FROM_GROUP +- GPSI_REMOVED +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +FailedCause: +description: > +Contains the Failed cause of the failed monitoring configuration in the EE subscription. +event monitoring. +anyOf: +- type: string +enum: +- AF_NOT_ALLOWED +- MTC_PROVIDER_NOT_ALLOWED +- MONITORING_NOT_ALLOWED +- UNSUPPORTED_MONITORING_EVENT_TYPE +- UNSUPPORTED_MONITORING_REPORT_OPTIONS +- UNSPECIFIED +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration but is not used to encode +content defined in the present version of this API. + +PdnConnectivityStatus: +description: PDN Connectivity Status. +anyOf: +- type: string +enum: +- ESTABLISHED +- RELEASED +- type: string +description: > +``` + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API. + +``` +SubscriptionType: + description: UE Subscription Type. + anyOf: + - type: string + enum: + - 5G + - 4G_5G + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +``` + +## A.6 Nudm\_PP API + +``` +openapi: 3.0.0 + +info: + version: '1.3.0-alpha.4' + title: 'Nudm_PP' + description: | + Nudm Parameter Provision Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.503 Unified Data Management Services, version 18.4.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' + +servers: + - url: '{apiRoot}/nudm-pp/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nudm-pp + - {} + +paths: + /{ueId}/pp-data: + patch: + summary: provision parameters + operationId: Update + tags: + - Subscription Data Update + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PpData' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/5g-vn-groups/{extGroupId}: + put: + summary: create a 5G VN Group + operationId: Create 5G VN Group + tags: + - 5G VN Group Creation + parameters: + - name: extGroupId + in: path + description: External Identifier of the Group + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/5GVnGroupConfiguration' + required: true + responses: + '201': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + delete: + summary: delete a 5G VN Group + operationId: Delete 5G VN Group + tags: + - 5G VN Group Deletion + parameters: + - name: extGroupId + in: path + description: External Identifier of the Group + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - name: mtc-provider-info + in: query + description: MTC Provider Information that originated the service operation + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + - name: af-id + in: query + description: AF ID that originated the service operation + schema: +``` + +``` + type: string + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + patch: + summary: modify a 5G VN Group + operationId: Modify 5G VN Group + tags: + - 5G VN Group Modification + parameters: + - name: extGroupId + in: path + description: External Identifier of the group + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/5GVnGroupConfigurationModification' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +``` + +``` +get: + summary: get 5G VN Group + operationId: Get 5G VN Group + tags: + - 5G VN Group Modification + parameters: + - name: extGroupId + in: path + description: External Identifier of the group + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/5GVnGroupConfiguration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueId}/pp-data-store/{afInstanceId}: + put: + summary: Create a Provisioning Parameter Data Entry + operationId: Create PP Data Entry + tags: + - ParameterProvisioningDataEntry (Document) + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - type: string + pattern: '^anyUE$' + - name: afInstanceId + in: path + description: Application Function Instance Identifier + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PpDataEntry' + required: true + responses: + '201': + description: Indicating a successful creation of the resource + content: + application/json: + schema: + $ref: '#/components/schemas/PpDataEntry' + '204': + description: Indicating a successful update of the resource +``` + +``` +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +delete: + summary: Delete a Provisioning Parameter Data Entry + operationId: Delete PP Data Entry + tags: + - ParameterProvisioningDataEntry (Document) + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - type: string + pattern: '^anyUE$' + - name: afInstanceId + in: path + description: Application Function Instance Identifier + required: true + schema: + type: string + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +get: + summary: get Parameter Provisioning Data Entry + operationId: Get PP Data Entry + tags: + - ParameterProvisioningDataEntry (Document) + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - type: string + pattern: '^anyUE$' + - name: afInstanceId + in: path + description: Application Function Instance Identifier + required: true + schema: + type: string + - name: supported-features + in: query +``` + +``` + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PpDataEntry' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/mbs-group-membership/{extGroupId}: + put: + summary: create a 5G MBS Group + operationId: Create 5G MBS Group + tags: + - 5G MBS Group Creation + parameters: + - name: extGroupId + in: path + description: External Identifier of the Group + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MulticastMbsGroupMemb' + required: true + responses: + '201': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +``` + +``` +delete: + summary: delete a 5G MBS Group + operationId: Delete 5G MBS Group + tags: + - 5G MBS Group Deletion + parameters: + - name: extGroupId + in: path + description: External Identifier of the Group + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +patch: + summary: modify a 5G MBS Group + operationId: Modify 5G MBS Group + tags: + - 5G MBS Group Modification + parameters: + - name: extGroupId + in: path + description: External Identifier of the group + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/MulticastMbsGroupMemb' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +get: + summary: get 5G MBS Group + operationId: Get 5G MBS Group + tags: + - 5G MBS Group Modification + parameters: + - name: extGroupId + in: path + description: External Identifier of the group + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/MulticastMbsGroupMemb' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudm-pp: Access to the nudm-pp API + +schemas: + +# COMPLEX TYPES: + +PpData: + type: object + properties: + communicationCharacteristics: + $ref: '#/components/schemas/CommunicationCharacteristics' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + expectedUeBehaviourParameters: + $ref: '#/components/schemas/ExpectedUeBehaviour' + expectedUeBehaviourExtension: + $ref: '#/components/schemas/ExpectedUeBehaviourExtension' +``` + +``` +ecRestriction: + $ref: '#/components/schemas/EcRestriction' +acsInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AcsInfoRm' +stnSr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StnSrRm' +lcsPrivacy: + $ref: '#/components/schemas/LcsPrivacy' +sorInfo: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SorInfo' +5mbsAuthorizationInfo: + $ref: '#/components/schemas/5MbsAuthorizationInfo' +dnnSnssaiSpecificGroup: + $ref: '#/components/schemas/DnnSnssaiSpecificGroup' +mbsAssistanceInfo: + $ref: '#/components/schemas/MbsAssistanceInfo' +appSpecificExpectedUeBehaviour: + $ref: '#/components/schemas/AppSpecificExpectedUeBehaviour' +sliceUsageControlInfos: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceUsageControlInfo' + minItems: 1 + nullable: true + +MbsAssistanceInfo: + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + assistanceInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + required: + - mbsSessionId + +CommunicationCharacteristics: + type: object + properties: + ppSubsRegTimer: + $ref: '#/components/schemas/PpSubsRegTimer' + ppActiveTime: + $ref: '#/components/schemas/PpActiveTime' + ppDlPacketCount: + $ref: '#/components/schemas/PpDlPacketCount' + ppDlPacketCountExt: + $ref: '#/components/schemas/PpDlPacketCountExt' + ppMaximumResponseTime: + $ref: '#/components/schemas/PpMaximumResponseTime' + ppMaximumLatency: + $ref: '#/components/schemas/PpMaximumLatency' + nullable: true + +PpSubsRegTimer: + type: object + required: + - subsRegTimer + - afInstanceId + - referenceId + properties: + subsRegTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + afInstanceId: + type: string + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + nullable: true + +PpActiveTime: + type: object + required: + - activeTime +``` + +``` +- afInstanceId +- referenceId +properties: + activeTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + afInstanceId: + type: string + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' +nullable: true + +5GVnGroupConfiguration: + type: object + properties: + 5gVnGroupData: + $ref: '#/components/schemas/5GVnGroupData' + members: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + afInstanceId: + type: string + internalGroupIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + membersData: + description: > + Contains the list of 5G VN Group members, each member is identified by GPSI. + A map (list of key-value pairs where Gpsi serves as key) of GpsiInfo. + The value in each entries of the map shall be an empty JSON object. + type: object + additionalProperties: + $ref: '#/components/schemas/GpsiInfo' + minProperties: 1 + +5GVnGroupConfigurationModification: + description: > + Contains the attributes to modify on the 5GVnGroupConfiguration data structure; + the attributes to be deleted need to be set to the null value. + type: object + properties: + 5gVnGroupData: + $ref: '#/components/schemas/5GVnGroupDataModification' + afInstanceId: + type: string + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + members: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + nullable: true + membersData: + description: > + Contains the list of 5G VN Group members, each member is identified by GPSI. + A map (list of key-value pairs where Gpsi serves as key) of GpsiInfo. + The value in each entries of the map shall be an empty JSON object. + type: object + additionalProperties: + $ref: '#/components/schemas/GpsiInfo' + minProperties: 1 + nullable: true + +5GVnGroupData: + type: object + required: + - dnn + - sNSSAI + properties: +``` + +``` +dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +pduSessionTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 +appDescriptors: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/AppDescriptor' + minItems: 1 +secondaryAuth: + type: boolean +dnAaaIpAddressAllocation: + type: boolean +dnAaaAddress: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpAddress' +additionalDnAaaAddresses: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpAddress' + minItems: 1 +dnAaaFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +5gVnGroupCommunicationInd: + type: boolean +maxGroupDataRate: + $ref: '#/components/schemas/MaxGroupDataRate' + +5GVnGroupDataModification: + description: > + Contains the attributes to modify on the 5GVnGroupData data structure; + the attributes to be deleted need to be set to the null value. + type: object + properties: + appDescriptors: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/AppDescriptor' + minItems: 1 + nullable: true + secondaryAuth: + type: boolean + nullable: true + dnAaaIpAddressAllocation: + type: boolean + nullable: true + dnAaaAddress: + type: object + nullable: true + allOf: + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpAddress' + additionalDnAaaAddresses: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpAddress' + minItems: 1 + nullable: true + dnAaaFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FqdnRm' + 5gVnGroupCommunicationInd: + type: boolean + nullable: true + maxGroupDataRate: + type: object + nullable: true + allOf: + - $ref: '#/components/schemas/MaxGroupDataRate' + nullable: true + +ExpectedUeBehaviour: + type: object + required: + - afInstanceId + - referenceId +``` + +``` +properties: + afInstanceId: + type: string + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + stationaryIndication: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StationaryIndicationRm' + communicationDurationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + scheduledCommunicationType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTypeRm' + periodicTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + scheduledCommunicationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTimeRm' + expectedUmts: + type: array + items: + $ref: '#/components/schemas/LocationArea' + minItems: 1 + nullable: true + description: > + Identifies the UE's expected geographical movement. The attribute is only + applicable in 5G. + trafficProfile: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TrafficProfileRm' + batteryIndication: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BatteryIndicationRm' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + nullable: true + +LocationArea: + type: object + properties: + geographicAreas: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 0 + description: Identifies a list of geographic area of the user where the UE is located. + civicAddresses: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + minItems: 0 + description: Identifies a list of civic addresses of the user where the UE is located. + nwAreaInfo: + $ref: '#/components/schemas/NetworkAreaInfo' + umtTime: + $ref: '#/components/schemas/UmtTime' + +UmtTime: + type: object + required: + - timeOfDay + - dayOfWeek + properties: + timeOfDay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeOfDay' + dayOfWeek: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DayOfWeek' + +NetworkAreaInfo: + description: > + Describes a network area information in which the NF service consumer requests + the number of UEs. + type: object + properties: + ecgis: + description: Contains a list of E-UTRA cell identities. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + minItems: 1 + ncgis: +``` + +``` + description: Contains a list of NR cell identities. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + minItems: 1 + gRanNodeIds: + description: Contains a list of NG RAN nodes. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + minItems: 1 + tais: + description: Contains a list of tracking area identities. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + +EcRestriction: + type: object + required: + - afInstanceId + - referenceId + properties: + afInstanceId: + type: string + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + plmnEcInfos: + type: array + items: + $ref: '#/components/schemas/PlmnEcInfo' + minItems: 1 + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + nullable: true + +PlmnEcInfo: + type: object + required: + - plmnId + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + ecRestrictionDataWb: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/EcRestrictionDataWb' + ecRestrictionDataNb: + type: boolean + default: false + +PpDlPacketCountExt: + type: object + required: + - afInstanceId + - referenceId + properties: + afInstanceId: + type: string + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + singleNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + nullable: true + +PpMaximumResponseTime: + type: object + required: + - maximumResponseTime + - afInstanceId + - referenceId + properties: +``` + +``` +maximumResponseTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +afInstanceId: + type: string +referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' +validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' +nullable: true + +PpMaximumLatency: + type: object + required: + - maximumLatency + - afInstanceId + - referenceId + properties: + maximumLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + afInstanceId: + type: string + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + nullable: true + +LcsPrivacy: + type: object + properties: + afInstanceId: + type: string + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + lpi: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/Lpi' + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + evtRptExpectedArea: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + areaUsageInd: + allOf: + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/AreaUsageInd' + default: POSITIVE_SENSE + upLocRepIndAf: + allOf: + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/UpLocRepIndAf' + default: USER_PLANE_REPORT_NOT_ALLOWED + nullable: true + +PpDataEntry: + type: object + properties: + communicationCharacteristics: + $ref: '#/components/schemas/CommunicationCharacteristicsAF' + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + ecsAddrConfigInfo: + $ref: '#/components/schemas/EcsAddrConfigInfo' + additionalEcsAddrConfigInfos: + type: array + items: + $ref: '#/components/schemas/EcsAddrConfigInfo' + minItems: 1 + ecsAddrConfigInfoPerPlmn: + description: > + A map (list of key-value pairs) where the key of the map is the serving PLMN id; + and the value is an array of EcsAddrConfigInfo for that serving PLMN. +``` + +``` +type: object +additionalProperties: + type: array + items: + $ref: '#/components/schemas/EcsAddrConfigInfo' + minItems: 1 +minProperties: 1 +ecRestriction: + $ref: '#/components/schemas/EcRestriction' +sliceUsageControlInfos: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceUsageControlInfo' + minItems: 1 +nullable: true + +CommunicationCharacteristicsAF: + type: object + properties: + ppDlPacketCount: + $ref: '#/components/schemas/PpDlPacketCount' + maximumResponseTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + maximumLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + nullable: true + +EcsAddrConfigInfo: + type: object + properties: + ecsServerAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EcsServerAddr' + spatialValidityCond: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SpatialValidityCond' + nullable: true + +5MbsAuthorizationInfo: + type: object + properties: + 5mbsSessionIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + minItems: 1 + nullable: true + +MulticastMbsGroupMemb: + type: object + required: + - multicastGroupMemb + properties: + multicastGroupMemb: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + afInstanceId: + type: string + internalGroupIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + +DnnSnssaiSpecificGroup: + type: object + required: + - dnn + - snssai + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + defQos: + $ref: '#/components/schemas/AfReqDefaultQoS' + afReqServArea: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' +``` + +``` + + minItems: 1 + nullable: true + +AfReqDefaultQoS: + type: object + required: + - 5qi + - arp + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + priorityLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel' + +ExpectedUeBehaviourExtension: + type: object + required: + - afInstanceId + - referenceId + properties: + afInstanceId: + type: string + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + expectedUeBehaviourData: + description: A map(list of key-value pairs) where a valid JSON pointer serves as key + type: object + additionalProperties: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExpectedUeBehaviourData' + minProperties: 1 + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + nullable: true + +AppSpecificExpectedUeBehaviour: + type: object + required: + - afInstanceId + - referenceId + - appSpecificExpectedUeBehaviourData + properties: + afInstanceId: + type: string + referenceId: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/ReferenceId' + appSpecificExpectedUeBehaviourData: + description: A map(list of key-value pairs) where a valid JSON pointer serves as key + type: object + additionalProperties: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/AppSpecificExpectedUeBehaviourData' + minProperties: 1 + nullable: true + +MaxGroupDataRate: + description: > + The limits of the total bit rate across all sessions of the 5G VN group + (uplink and downlink) + type: object + properties: + uplink: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + downlink: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + +GpsiInfo: + description: > + In this version of this specification, this data type does not contain any attributes, + it is used to convey an empty JSON objects as the value of the entries in the membersData +map. + type: object + nullable: true + +# SIMPLE TYPES: + +``` + +``` +PpDlPacketCount: + type: integer + nullable: true +``` + +``` +# ENUMS: +``` + +## --- A.7 Nudm\_NIDDAU API + +``` +openapi: 3.0.0 +``` + +### ``` info: ``` + +``` + version: '1.2.0-alpha.2' + title: 'Nudm_NIDDAU' + description: | + Nudm NIDD Authorization Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +``` + +### ``` externalDocs: ``` + +``` + description: 3GPP TS 29.503 Unified Data Management Services, version 18.1.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' +``` + +### ``` servers: ``` + +``` + - url: '{apiRoot}/nudm-niddau/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. +``` + +### ``` security: ``` + +``` + - oAuth2ClientCredentials: + - nudm-niddau + - {} +``` + +### ``` paths: ``` + +``` + /{ueIdentity}/authorize: + post: + summary: Authorize the NIDD configuration request. + operationId: AuthorizeNiddData + tags: + - Authorize the NIDD configuration request + parameters: + - name: ueIdentity + in: path + description: Represents the scope of the UE for which the NIDD configuration are +authorized. Contains the GPSI of the user or the external group ID. + required: true + schema: + type: string + pattern: '^((msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^\@]+\+|extgroupid-[^@]+@[^\@]+\+))$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationInfo' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +``` + +``` +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +callbacks: + niddAuthUpdateNotification: + '{request.body#/authUpdateCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NiddAuthUpdateNotification' +responses: + '204': + description: Expected response to a valid request + '400': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudm-niddau: Access to the nudm-niddau API + +schemas: + +# COMPLEX TYPES: +# + AuthorizationData: + description: Represents NIDD authorization data. + type: object + required: + - authorizationData + properties: + authorizationData: + type: array + items: + $ref: '#/components/schemas/UserIdentifier' + minItems: 1 + uniqueItems: true + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + + UserIdentifier: + description: Represents the user identifier. + type: object + required: + - supi + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + + NiddAuthUpdateInfo: + description: Represents NIDD authorization update information. + type: object + required: + - authorizationData + properties: + authorizationData: + $ref: '#/components/schemas/AuthorizationData' + invalidityInd: + type: boolean + snssai: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + niddCause: + $ref: '#/components/schemas/NiddCause' + +NiddAuthUpdateNotification: + description: Represents a NIDD authorization update notification. + type: object + required: + - niddAuthUpdateInfoList + properties: + niddAuthUpdateInfoList: + type: array + items: + $ref: '#/components/schemas/NiddAuthUpdateInfo' + minItems: 1 + +AuthorizationInfo: + description: Represents NIDD authorization information. + type: object + required: + - snssai + - dnn + - mtcProviderInformation + - authUpdateCallbackUri + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + authUpdateCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + afId: + type: string + nefId: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefId' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + contextInfo: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo' + +# SIMPLE TYPES: + +# ENUMS: + +NiddCause: + description: Indicates the usage for Subscription Withdrawal. + anyOf: + - type: string + enum: + - SUBSCRIPTION_WITHDRAWAL + - DNN_REMOVED + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. +``` + +## --- A.8 Nudm\_MT API + +``` +openapi: 3.0.0 +info: + version: '1.2.0-alpha.1' + title: 'Nudm_MT' + description: | + UDM MT Service. +``` + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +``` +externalDocs: + description: 3GPP TS 29.503 Unified Data Management Services, version 18.0.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' + +servers: + - url: '{apiRoot}/nudm-mt/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nudm-mt + - {} + +paths: + /{supi}: + get: + summary: Query Information for the UE + operationId: QueryUeInfo + tags: + - Query UE Info + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: fields + in: query + description: attributes to be retrieved + required: true + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + /{supi}/loc-info/provide-loc-info: + post: +``` + +``` +summary: Provides the UE's 5GS location information +operationId: ProvideLocationInfo +tags: + - Provide UE Location +parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocationInfoRequest' + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LocationInfoResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudm-mt: Access to the nudm-mt API + +schemas: + +# COMPLEX TYPES: + +UeInfo: + description: Represents UE information. + type: object + properties: + tadsInfo: + $ref: 'TS29518_Namf_MT.yaml#/components/schemas/UeContextInfo' + userState: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/5GSUserState' + 5gSrvccInfo: + $ref: '#/components/schemas/5GSrvccInfo' +``` + +``` +5GSrvccInfo: + description: Represents 5G SRVCC information for a UE. + type: object + required: + - ue5GSrvccCapability + properties: + ue5GSrvccCapability: + type: boolean + stnSr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/StnSr' + cMsisdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CMsisdn' + +LocationInfoRequest: + description: Represents information to be sent in a location information request. It contains +the requested information, i.e. current location, local time zone, RAT type, or serving node +identity only. + type: object + properties: + req5gsLoc: + type: boolean + default: false + reqCurrentLoc: + type: boolean + default: false + reqRatType: + type: boolean + default: false + reqTimeZone: + type: boolean + default: false + reqServingNode: + type: boolean + default: false + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +LocationInfoResult: + description: Represents the requested location information. + type: object + properties: + vPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + amfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + smsfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + currentLoc: + type: boolean + geoInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + locationAge: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + timezone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +# SIMPLE TYPES: + +# ENUMS: +``` + +## --- A.9 Nudm\_SSAU API + +openapi: 3.0.0 + +``` +info: + version: '1.1.0-alpha.1' + title: 'Nudm_SSAU' + description: | + Nudm Service Specific Authorization Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.503 Unified Data Management Services, version 18.0.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' + +servers: + - url: '{apiRoot}/nudm-ssau/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nudm-ssau + - {} + +paths: + /{ueIdentity}/{serviceType}/authorize: + post: + summary: Authorization for the Service specific parameters in the request. + operationId: ServiceSpecificAuthorization + tags: + - Service specific authorization request + parameters: + - name: ueIdentity + in: path + description: Represents the scope of the UE for which the Service Specific Parameters are authorized. Contains the GPSI of the user or the external group ID. + required: true + schema: + type: string + pattern: '^^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^\@]+\+|extgroupid-[^@]+\+@[^\@]+\+)$' + - name: serviceType + in: path + description: Represents the specific service for which the Service Specific Parameters are authorized. + required: true + schema: + $ref: '#/components/schemas/ServiceType' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSpecificAuthorizationInfo' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSpecificAuthorizationData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +``` + +``` + + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + callbacks: + authUpdateNotification: + '{request.body#/authUpdateCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AuthUpdateNotification' + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/{ueIdentity}/{serviceType}/remove: + post: + summary: Remove the authorization of specific service's configuration. + operationId: ServiceSpecificAuthorizationRemoval + tags: + - Service specific authorization remove + parameters: + - name: ueIdentity + in: path + description: Represents the scope of the UE for which the Service Specific configuration +authorization to be removed. Contains the GPSI of the user or the external group ID. + required: true + schema: + type: string + pattern: '^(\msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^\@]+\+|extgroupid-[^@]+\+@[^\@]+\+)$' + - name: serviceType + in: path + description: Represents the specific service for which the Service Specific configuration +authorization to be removed. + required: true + schema: + $ref: '#/components/schemas/ServiceType' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSpecificAuthorizationRemoveData' + required: true + responses: + '204': + description: Successful response + '400': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudm-ssau: Access to the nudm-ssau API + +schemas: + +# COMPLEX TYPES: +# + AuthUpdateNotification: + description: Represents an authorization update notification. + type: object + required: + - serviceType + - authUpdateInfoList + properties: + serviceType: + $ref: '#/components/schemas/ServiceType' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + authUpdateInfoList: + type: array + items: + $ref: '#/components/schemas/AuthUpdateInfo' + minItems: 1 + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + afId: + type: string + + AuthUpdateInfo: + description: Represents authorization update information. + type: object + required: + - authorizationData + properties: + authorizationData: + $ref: '#/components/schemas/ServiceSpecificAuthorizationData' + invalidityInd: + type: boolean + invalidCause: + $ref: '#/components/schemas/InvalidCause' +``` + +``` +ServiceSpecificAuthorizationInfo: + description: Authorization information for a specific service + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DNN' + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + authUpdateCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + afId: + type: string + nefId: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefId' + +ServiceSpecificAuthorizationData: + description: Authorization Response for a specific service. + type: object + properties: + authorizationUeId: + $ref: '#/components/schemas/AuthorizationUeId' + extGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + intGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + authId: + type: string + +AuthorizationUeId: + description: UE Id of the Authorization Data. + type: object + required: + - supi + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + +ServiceSpecificAuthorizationRemoveData: + description: Information for Authorization removal of a specific service. + type: object + required: + - authId + properties: + authId: + type: string +``` + +# SIMPLE TYPES: + +# ENUMS: + +``` +ServiceType: + anyOf: + - type: string + enum: + - AF_GUIDANCE_FOR_URSP + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - AF_GUIDANCE_FOR_URSP + +InvalidCause: + anyOf: + - type: string + enum: + - SUBSCRIPTION_WITHDRAWAL + - DNN_REMOVED +``` + +``` + + - SLICE_REMOVED + - AUTHORIZATION_REVOKED + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - SUBSCRIPTION_WITHDRAWAL + - DNN_REMOVED + - SLICE_REMOVED + - AUTHORIZATION_REVOKED + +``` + +## A.10 Nudm\_ReportSMDeliveryStatus API + +``` + +openapi: 3.0.0 +info: + version: '1.2.0-alpha.1' + title: 'Nudm_ReportSMDeliveryStatus' + description: | + UDM Report SM Delivery Status Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.503 Unified Data Management Services, version 18.0.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' + +servers: + - url: '{apiRoot}/nudm-rsds/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nudm-rsds + - {} + +paths: + /{ueIdentity}/sm-delivery-status: + post: + summary: Report the SM Delivery Status + operationId: ReportSMDeliveryStatus + tags: + - Report SM Delivery Status + parameters: + - name: ueIdentity + in: path + description: Represents the scope of the UE for which the Service Specific Parameters are + authorized. Contains the GPSI of the user or the external group ID. + required: true + schema: + type: string + pattern: '^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^\@]+\+|extgroupid-[^@]+\+@[^\@]+\+)$' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmDeliveryStatus' + required: true + responses: + '204': + description: Successful response + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudm-rsds: Access to the nudm-rsds API + +schemas: + +# COMPLEX TYPES: + + SmDeliveryStatus: + description: Represents SM Delivery Status. + type: object + required: + - gpsi + - smStatusReport + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + smStatusReport: + type: string + +# SIMPLE TYPES: + +# ENUMS: +``` + +## --- A.11 Nudm\_UEIdentifier API + +``` +openapi: 3.0.0 +info: + version: '1.0.0' + title: 'Nudm_UEIdentifier' + description: | + UDM UE Identifier Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.503 Unified Data Management Services, version 17.10.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/' + +servers: +- url: '{apiRoot}/nudm-ueid/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: +- oAuth2ClientCredentials: + - nudm-ueid +``` + +``` +- {} + +paths: + /deconceal: + post: + summary: Deconceal the SUCI to the SUPI + operationId: Deconceal + tags: + - Deconceal + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeconcealReqData' + required: true + responses: + '200': + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/DeconcealRspData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudm-ueid: Access to the nudm-ueid API + +schemas: + +# COMPLEX TYPES: + +DeconcealReqData: + description: Deconceal Request Data + type: object + required: + - suci + properties: + suci: + $ref: 'TS29509_Nausf_UEAuthentication.yaml#/components/schemas/Suci' + +DeconcealRspData: + description: Deconceal Response Data + type: object + required: + - supi + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + +# SIMPLE TYPES: + +# ENUMS: +``` + +# Annex B (informative): Stateless UDMs + +Figure B-1 shows a scenario where the stateless UDM receives and processes a request from an NF. + +![Sequence diagram illustrating the interaction between an NF, UDM, and UDR for a stateless UDM. The sequence starts with the NF sending a '1. Request' to the UDM. The UDM then sends a '2. retrieve data' request to the UDR. The UDM performs internal steps '3. process the request' and '4. delete data'.](410562339ce067fdc6fa41940c118658_img.jpg) + +``` +sequenceDiagram + participant NF + participant UDM + participant UDR + Note right of UDM: 3. process the request + Note right of UDM: 4. delete data + NF->>UDM: 1. Request + UDM->>UDR: 2. retrieve data +``` + +Sequence diagram illustrating the interaction between an NF, UDM, and UDR for a stateless UDM. The sequence starts with the NF sending a '1. Request' to the UDM. The UDM then sends a '2. retrieve data' request to the UDR. The UDM performs internal steps '3. process the request' and '4. delete data'. + +**Figure B-1: Stateless UDM** + +1. The stateless UDM receives a request from an NF. This can be a request to perform a Nudm service, or a Notification that the UDM has previously subscribed to at the NF by means of a service the UDM consumes from the NF. In the later case the NF can be the UDR. +2. The UDM retrieves data from the UDR that are required to process the request. This step can be skipped if the request was a notification from the UDR and contained enough information so that the UDM can process the request. +3. The UDM processes the received request. This can include consuming services from other NFs, consuming services from the UDR (e.g. to update data or subscribe to notifications), and sending notifications to NFs that have subscribed at the UDM to receive notifications, and includes sending the response to the NF (all not shown in the figure). +4. The UDM locally deletes the data retrieved in step 2 and/or received in step 1. + +Figure B-2 shows a scenario where an AMF subscribes to notifications of data change (permanent provisioned subscription data) at the stateless UDM. The UDM (UDM 1) stores the subscription to notification in the UE's context data at the UDR. + +![Sequence diagram for Subscription to notification. Lifelines: AMF, UDM 1, UDM 2, and UDR. The sequence starts with AMF sending Nudm_SDM_Subscribe to UDM 1. UDM 1 sends Nudr_DR_Query to UDR, which responds with 200 OK. UDM 1 then sends Nudr_DR_Subscribe to UDR, which responds with 201 Created. UDM 1 sends 201 Created to AMF. A 'data change' event occurs at UDR. UDR sends Nudr_DR_Notify to UDM 2, which responds with 204 No Content. UDM 2 sends Nudm_SDM_Notify to AMF, which responds with 204 No Content.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM1 as UDM 1 + participant UDM2 as UDM 2 + participant UDR + + AMF->>UDM1: 1. Nudm_SDM_Subscribe + UDM1->>UDR: 2. Nudr_DR_Query + UDR-->>UDM1: 3. 200 OK + UDM1->>UDR: 4. Nudr_DR_Subscribe + UDR-->>UDM1: 5. 201 Created + UDM1-->>AMF: 6. 201 Created + Note right of UDR: 7. data change + UDR->>UDM2: 8. Nudr_DR_Notify + UDM2-->>UDR: 9. 204 No Content + UDM2->>AMF: 10. Nudm_SDM_Notify + AMF-->>UDM2: 11. 204 No Content + +``` + +Sequence diagram for Subscription to notification. Lifelines: AMF, UDM 1, UDM 2, and UDR. The sequence starts with AMF sending Nudm\_SDM\_Subscribe to UDM 1. UDM 1 sends Nudr\_DR\_Query to UDR, which responds with 200 OK. UDM 1 then sends Nudr\_DR\_Subscribe to UDR, which responds with 201 Created. UDM 1 sends 201 Created to AMF. A 'data change' event occurs at UDR. UDR sends Nudr\_DR\_Notify to UDM 2, which responds with 204 No Content. UDM 2 sends Nudm\_SDM\_Notify to AMF, which responds with 204 No Content. + +**Figure B-2: Subscription to notification** + +1. The stateless UDM 1 receives a subscribe request from an AMF; see clause 5.2.2.3.2. +- 2.-3 The UDM retrieves UE context data from the UDR to be able to perform required plausibility checks; see 3GPP TS 29.504 [9] clause 5.2.2.2.2. +4. The UDM creates a new sdm subscription at the UDR; see 3GPP TS 29.504 [9] clause 5.2.2.6.3. +5. The UDR sends a 201 Created response containing a subscription ID +6. The UDM send a 201 Created response passing the subscription ID received in step 5 to the AMF. +7. Permanent provisioned Subscription data are modified at the UDR. +8. The UDR selects a suitable UDM and sends a Notification; see 3GPP TS 29.504 [9] clause 5.2.2.8. In addition to the data that have changed, the Notification request message can contain enough (unchanged) information (e.g. the information that has been created in step 4) allowing the UDM to perform step 10 without the need to additionally retrieve information from the UDR. +9. The UDM responds with 204 No Content. +10. The UDM notifies the AMF according to the callback URI of the AMF contained in the Notification received in step 8; see clause 5.2.2.5.2. +11. The AMF responds with 204 No Content. + +Figure B-3 shows a scenario where an AMF registers at the stateless UDM. The UDM (UDM 1) stores the registration in the UE's context data at the UDR. The AMF then requests to update the registration e.g. due to change of PEI. This request is sent to UDM2, which is either: + +- an UDM instance that belongs to the same UDM group as UDM1 (if there are UDM groups defined in the PLMN), or +- any other UDM instance in the PLMN (if there are no UDM groups defined in the PLMN). + +![Sequence diagram showing AMF Registration and Update. The diagram involves four lifelines: AMF, UDM 1, UDM 2, and UDR. The sequence of messages is: 1. AMF to UDM 1: Nudm_UECM_Register; 2. UDM 1 to UDR: Nudr_DR_Query; 3. UDR to UDM 1: 200 OK; 4. UDM 1 to UDR: Nudr_DR_Update; 5. UDR to UDM 1: update response; 6. UDM 1 to AMF: register response; 7. AMF to UDM 2: Nudm_UECM_Update; 8. UDM 2 to UDR: Nudr_DR_Query; 9. UDR to UDM 2: 200 OK; 10. UDM 2 to UDR: Nudr_DR_Update; 11. UDR to UDM 2: update response; 12. UDM 2 to AMF: update response.](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM1 as UDM 1 + participant UDM2 as UDM 2 + participant UDR + Note right of UDM1: UDM 1 + Note right of UDM2: UDM 2 + AMF->>UDM1: 1. Nudm_UECM_Register + UDM1->>UDR: 2. Nudr_DR_Query + UDR-->>UDM1: 3. 200 OK + UDM1->>UDR: 4. Nudr_DR_Update + UDR-->>UDM1: 5. update response + UDM1-->>AMF: 6. register response + AMF->>UDM2: 7. Nudm_UECM_Update + UDM2->>UDR: 8. Nudr_DR_Query + UDR-->>UDM2: 9. 200 OK + UDM2->>UDR: 10. Nudr_DR_Update + UDR-->>UDM2: 11. update response + UDM2-->>AMF: 12. update response + +``` + +Sequence diagram showing AMF Registration and Update. The diagram involves four lifelines: AMF, UDM 1, UDM 2, and UDR. The sequence of messages is: 1. AMF to UDM 1: Nudm\_UECM\_Register; 2. UDM 1 to UDR: Nudr\_DR\_Query; 3. UDR to UDM 1: 200 OK; 4. UDM 1 to UDR: Nudr\_DR\_Update; 5. UDR to UDM 1: update response; 6. UDM 1 to AMF: register response; 7. AMF to UDM 2: Nudm\_UECM\_Update; 8. UDM 2 to UDR: Nudr\_DR\_Query; 9. UDR to UDM 2: 200 OK; 10. UDM 2 to UDR: Nudr\_DR\_Update; 11. UDR to UDM 2: update response; 12. UDM 2 to AMF: update response. + +**Figure B-3: AMF Registration and Update** + +1. The AMF discovers (by means of NRF query) and selects an UDM and sends the register request; +- 2-3 The UDM retrieves UE context data from the UDR e.g. to be able to perform required plausibility checks; +- 4-5 The UDM updates UE context data in the UDR. The UDM also performs other actions not shown in the figure, e.g. deregister an old AMF or notify a subscribed NEF. +6. The UDM acknowledges the AMF registration. The AMF stores the UDM group ID if any, as discovered and selected in step 1. The UDM locally deletes the data retrieved in step 3. +7. The AMF sends an update request (e.g. change of PEI) to one of the suitable UDMs (UDM2) e.g. that belongs to the same UDM group as UDM1. +- 8-9. The UDM retrieves UE context data from the UDR e.g. to be able to perform required plausibility checks; +- 10-11. The UDM updates UE context data in the UDR. The UDM also performs other actions not shown in the figure, e.g. notify a subscribed NEF, ... +12. The UDM sends update response to the AMF and locally deletes the data retrieved in step 9. + +NOTE: When a previously received Location Header or Callback URI is used for a subsequent UDM contact, the authority part may need to be replaced to point to the selected UDM. + +Figure B-4 shows a scenario where an AF requests a subscription for all UEs ("Any UE") for a given network event. The NEF discovers all UDM NFs providing the necessary service to perform a bulk subscription. If one or several + +UDM Group IDs are received, NEF selects only one instance of UDM for each Group ID in order to perform the bulk subscription. If there are no UDM groups discovered, NEF selects any UDM instance from the discovered instances. + +![Sequence diagram for Any UE Subscription showing interactions between AF, NEF, UDM 1, UDM 2, UDR, and AMF.](16152cf1d84aea10848758f51a91ff6a_img.jpg) + +``` + +sequenceDiagram + participant AF + participant NEF + participant UDM1 as UDM 1 + participant UDM2 as UDM 2 + participant UDR + participant AMF + + Note left of AF: 1. Nnef EventExposure Subscribe (Any UE) + AF->>NEF: 1. Nnef EventExposure Subscribe (Any UE) + Note left of NEF: 2. Nudm EventExposure Subscribe (Any UE) + NEF->>UDM1: 2. Nudm EventExposure Subscribe (Any UE) + Note left of UDM1: 3. Nudr_DR_Query (Any UE) + UDM1->>UDR: 3. Nudr_DR_Query (Any UE) + Note left of UDR: 4. 200 OK + UDR->>UDM1: 4. 200 OK + Note left of UDM1: 5. Nudr_DR_Update (Any UE) + UDM1->>UDR: 5. Nudr_DR_Update (Any UE) + Note left of UDR: 6. Nudr_DR_Update_Response + UDR->>UDM1: 6. Nudr_DR_Update_Response + Note left of UDM1: 7. Nudm EventExposure Subscribe Response + UDM1->>NEF: 7. Nudm EventExposure Subscribe Response + +``` + +Sequence diagram for Any UE Subscription showing interactions between AF, NEF, UDM 1, UDM 2, UDR, and AMF. + +**Figure B-4: Any UE Subscription** + +1. An AF subscribes to a network event (e.g. SUPI-PEI association change) for "Any UE" (i.e. all UEs) +2. The NEF discovers (by means of NRF query) all UDM instances supporting the required service (e.g. nudm-ee). The NEF selects an UDM instance (e.g. UDM 1) from each UDM Group ID discovered (UDM 1 and UDM 2 are in the same UDM Group ID) or any UDM instance in case there are no UDM groups discovered, and sends the subscribe request. The NEF also stores the UDM Group ID information, if any, to select a UDM for subsequent subscriptions. +- 3-4. The UDM retrieves data from the UDR for "Any UE", e.g. to be able to perform required plausibility checks +- 5-6. The UDM stores data for "Any UE" in the UDR. +7. The UDM acknowledges the NEF subscription request. The UDM locally deletes the data retrieved in step 3. + +Steps 7-12 in Figure B-3 are performed. The UDM instance that detects the network event (e.g. change of PEI) for each individual UE, checks in UDR whether subscription to the network event for this individual UE or for "Any UE" exists. As result of the subscription to the detected network event for any UE, NEF is notified by the UDM instance that detects the network event for each individual UE, i.e. UDM 2 in this example. + +# Annex C (informative): SUCI encoding + +The structure of the Subscription Concealed Identifier (SUCI) is defined in 3GPP TS 23.003 [8]. + +When SUCI needs to be sent as a character string (e.g. as a string in a JSON content of any of the service operations defined in the APIs defined in this specification), the SUCI is composed as an UTF-8 character string, where the different components are separated by the "minus" character "-" (UTF-8 0x2D). + +These components shall be formatted as follows: + +- 1) SUPI Type: a single decimal digit, from 0 to 7, formatted as a single UTF-8 character (UTF-8 0x30 to 0x37) + +- 2) Home Network Identifier. + +When the SUPI Type is an IMSI, the Home Network Identifier consists on 2 components: MCC and MNC, separated by the "minus" character; these components are formatted as a string of 3 characters for MCC and a string of 2 or 3 characters for MNC (UTF-8 0x30 to 0x39). + +When the SUPI type is a Network Specific Identifier, Global Line Identifier (GLI) or Global Cable Identifier (GCI) the Home Network Identifier consists of a string of characters with a variable length, formatted as an UTF-8 character string. + +- 3) Routing Indicator, consisting of 1 to 4 decimal digits formatted as a string of 1 to 4 characters (UTF-8 0x30 to 0x39). +- 4) Protection Scheme Identifier, consisting in a value in the range of 0 to 15, representing a single hexadecimal digit, formatted as a single UTF-8 character (UTF-8 0x30 to 0x39, or 0x41 to 0x46, or 0x61 to 0x66). +- 5) Home Network Public Key Identifier, consisting in a value in the range 0 to 255, formatted as a sequence of 1 to 3 decimal digits, formatted of 1 to 3 UTF-8 characters (UTF-8 0x30 to 0x39). +- 6) Scheme Output, consisting of a string of UTF-8 characters with a variable length, or a sequence of hexadecimal digits, dependent on the used protection scheme. It represents the output of a public key protection scheme specified in Annex C of 3GPP TS 33.501 [6] or the output of a protection scheme specified by the HPLMN. + +Finally, the above structure is prefixed by the string "suci-", when the SUCI is sent in the "SupiOrSuci" data type definition, as described in 3GPP TS 29.571 [7], Table 5.3.2-1. + +For the SUPI types "Network Specific Identifier (NSI)", "Global Line Identifier (GLI)", and "Global Cable Identifier (GCI)", the SUCI sent by the UE to the AMF is always formatted as a NAI (see 3GPP TS 23.003 [8], clauses 28.7.3, 28.15.5 and 28.16.5). In those cases, before sending such SUCI to the UDM or AUSF, the AMF needs to re-encode the received SUCI, and format it according to the structure described above (as an UTF-8 character string, where the different components are separated by the "minus" character "-"). + +### EXAMPLES: + +- 1) SUPI is IMSI-based; MCC=123, MNC=45, MSIN: 0123456789 + +SUPI type: 0 (IMSI) + +Routing Indicator: 012 + +Protection Scheme: 0 (NULL scheme) + +Home Network Public Key Identifier: 0 + +Scheme output = MSIN (cleartext) + +- SUCI UTF-8 string, as sent on the UDM APIs: + +"suci-0-123-45-012-0-0-0123456789" + +**NOTE:** According to 3GPP TS 33.501 [6] (see annex C.2) the NULL scheme returns the same output as the input (i.e. MSIN in this example), which can be packed BCD coded. However, when formatted as character string in JSON, the scheme output is expected to be reformatted from packed BCD (5 octets in this example) to a sequence of decimal digits in UTF-8 (10 characters in this example). + +- 2) SUPI is IMSI-based, MCC=123, MNC=45, MSIN: 9876543210 (coded as 10 hexadecimal digits using 5 octets packed BCD coding: 89, 67, 45, 23, 01) + +SUPI type: 0 (IMSI) + +Routing Indicator: 0002 + +Protection Scheme: 1 (Profile A) + +Home Network Public Key Identifier: 17 + +Scheme output = ECC ephemeral public key (32 octets, first bolded part below) + Encrypted MSIN (where MSIN has 10 digits, i.e. 5 octets coded as hexadecimal digits using packed BCD coding, italic part below) + MAC tag (8 octets, last bolded part below) = 50 octets = 100 hexadecimal characters + +(NOTE: the keys and encrypted content below is fictitious). + +- SUCI UTF-8 string, as sent on the UDM APIs: + +`"suci-0-123-45-0002-1-17-e9b9916c911f448d8792e6b2f387f85d3ecab9040049427d9edbb5431b0bc711023be6a057b45d936238aebeb7"` + +- 3) SUPI is NAI-based, SUPI = alice@example.com + +SUPI type = 1 (Network Specific Identifier) + +Routing Indicator: 84 + +Protection Scheme: 2 (Profile B) + +Home Network Public Key Identifier: 250 + +ECC ephemeral public key (33 octets, first bolded part below, in field "ecckey") + +Encrypted username of NAI "alice" (5 octets, italic part below, in field "cip") + +MAC tag (8 octets, last bolded part below, in field "mac") + +(NOTE: the keys and encrypted content below is fictitious) + +- SUCI in NAI format as sent by the UE to the AMF: + +`"type1.rid84.schid2.hnkey250.ecckeye9b9916c911f448d8792e6b2f387f85d3ecab9040049427d9edbb5431b0bc71195.cip023be6a057.macb45d936238aebeb7@example.com"` + +- SUCI UTF-8 string, as sent on the UDM APIs: + +`"suci-1-example.com-84-2-250-e9b9916c911f448d8792e6b2f387f85d3ecab9040049427d9edbb5431b0bc71195023be6a057b45d936238aebeb7"` + +- 4) SUPI is NAI-based; SUPI = 00-00-5E-00-53-00@operator.com + +SUPI type: 3 (GCI) + +Routing Indicator: 012 + +Protection Scheme: 0 (NULL scheme) + +Home Network Public Key Identifier: 0 + +Username = 00-00-5E-00-53-00 (in field "userid" below) + +- SUCI in NAI format as sent by the UE to the AMF: + +`"type3.rid012.schid0.userid00-00-5E-00-53-00@operator.com"` + +- SUCI UTF-8 string, as sent on the UDM APIs: + +"suci-3-operator.com-012-0-0-00-00-5E-00-53-00" + +#### 5) Anonymous SUCI + +SUPI type: 1 (Network Specific Identifier) + +Operator realm = operator.com + +Routing Indicator: 3456 + +Protection Scheme: 0 (NULL scheme) + +Home Network Public Key Identifier: 0 + +- Alternative with username = anonymous + +- SUCI in NAI format as sent by the UE to the AMF: + +"type1.rid3456.schid0.useridanonymous@operator.com" + +- SUCI UTF-8 string, as sent on the UDM APIs: + +"suci-1-operator.com-3456-0-0-anonymous" + +- Alternative with omitted username + +- SUCI in NAI format as sent by the UE to the AMF: + +"type1.rid3456.schid0.userid@operator.com" + +- SUCI UTF-8 string, as sent on the UDM APIs: + +"suci-1-operator.com-3456-0-0-" + +# --- Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|-----|-----|------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | CT4#80 | C4-175320 | | | | TS skeleton | 0.1.0 | +| 2017-10 | CT4#80 | C4-175362 | | | | Implementation of pCRs agreed at CT4#80. | 0.2.0 | +| 2017-12 | CT4#81 | C4-176150
C4-176153
C4-176423
C4-176365
C4-176424
C4-176425 | | | | Implementation of pCRs agreed at CT4#81 | 0.3.0 | +| 2018-01 | CT4#82 | C4-181277
C4-181278
C4-181239
C4-181241
C4-181245
C4-181280
C4-181282
C4-181131
C4-181247
C4-181284
C4-181250
C4-181273
C4-181252
C4-181254 | | | | Implementation of pCRs agreed at CT4#82 | 0.4.0 | +| 2018-03 | CT4#83 | C4-182178
C4-182270
C4-182354
C4-182352
C4-182274
C4-182400
C4-182402
C4-182356
C4-182351
C4-182401
C4-182268 | | | | Implementation of pCRs agreed at CT4#83 | 0.5.0 | +| 2018-04 | CT4#84 | C4-183124
C4-183143
C4-183221
C4-183225
C4-183228
C4-183230
C4-183232
C4-183234
C4-183244
C4-183300
C4-183302
C4-183304
C4-183305
C4-183306
C4-183307
C4-183308
C4-183374
C4-183381
C4-183382
C4-183425
C4-183427
C4-183430
C4-183480
C4-183483
C4-183486
C4-183508
C4-183509 | | | | Implementation of pCRs agreed at CT4#84 | 0.6.0 | +| 2018-05 | | | | | | "yaml files" added into the zip-file | 0.6.1 | + +| | | | | | | | | +|---------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|---|---|-----------------------------------------------------------------------------------------------------|--------| +| 2018-05 | CT4#85 | C4-184351
C4-184356
C4-184210
C4-184211
C4-184358
C4-184359
C4-184558
C4-184559
C4-184381
C4-184556
C4-184423
C4-184557
C4-184310
C4-184572
C4-184622 | | | | Implementation of pCRs agreed at CT4#85 | 0.7.0 | +| 2018-06 | CT#80 | CP-181001 | | | | Presented for information and approval. | 1.0.0 | +| 2018-06 | CT#80 | CP-181196 | | | | Approved in CT#80 | 15.0.0 | +| 2018-09 | CT#81 | CP-182056 | 0001 | 3 | B | UDM receives notification of target/new AMF after AMF planned removal | 15.1.0 | +| 2018-09 | CT#81 | CP-182170 | 0002 | 1 | F | DeregistrationData alignment with stage 2 | 15.1.0 | +| 2018-09 | CT#81 | CP-182172 | 0003 | 6 | F | Event subscription alignment with stage 2 | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0005 | 5 | F | Data Change Notification | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0004 | 1 | F | NfInstanceId | 15.1.0 | +| 2018-09 | CT#81 | CP-182049 | 0006 | 3 | F | UDM support for dynamic 5QIs and for standard 5QIs whose default QoS characteristics are overridden | 15.1.0 | +| 2018-09 | CT#81 | CP-182068 | 0007 | 4 | B | Add support for 5G Trace to Nudm_SDM | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0008 | 4 | B | Shared Data | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0009 | 1 | F | Feature Negotiation | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0010 | 2 | F | Nudm_SDM_Get | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0011 | 1 | F | Allowing multiple monitoring reports in a single event occurrence notification | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0015 | 1 | F | UDM Data change notification | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0016 | 3 | F | Nudm_SDM_Info Service Operation Description | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0022 | | F | Authentication Info Result | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0025 | 2 | B | Add MicoAllowed in am-data | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0026 | 2 | B | Introduction of PLMN Id in UECM & UE Authentication Services | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0028 | 2 | F | Mobility Restriction | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0029 | 1 | F | SMSF addresses | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0030 | 4 | F | SMS subscription data | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0031 | | F | Clause Numbering | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0032 | 1 | F | Formal OpenAPI corrections | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0033 | | F | GMLC | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0034 | | F | AUSF Instance Id | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0036 | 2 | F | Avoid stale sdm-subscriptions | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0037 | | B | Nudm_SDM retrieval of SMS Management Subscription data | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0038 | 1 | F | Nudm_UECM Errors | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0039 | | F | P-CSCF restoration callbacks | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0040 | 1 | F | Nudm_UEAU Errors | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0041 | 1 | F | Nudm_EE Errors | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0042 | 1 | F | Nudm_PP Errors | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0043 | 2 | F | UDM Group | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0045 | 1 | F | SUCI coding | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0046 | 2 | F | BackUp AMF Info | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0047 | 2 | F | Interworking with EPS indication | 15.1.0 | +| 2018-09 | CT#81 | CP-182171 | 0048 | 2 | F | Nudm_SDM_Subscribe for SMF | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0050 | 1 | F | User Plane Security Policy | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0051 | | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0054 | 1 | F | Provide DNN with LADN indicator per NSSAI | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0055 | | F | UE Context In SMF Data Retrieval | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0057 | | F | Time Stamp in EE Notify | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0058 | | F | Naming Conventions | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0059 | | F | Storage and retrieval of PGW FQDN | 15.1.0 | +| 2018-09 | CT#81 | CP-182056 | 0060 | | F | API version number update | 15.1.0 | +| 2018-12 | CT#82 | CP-183014 | 0061 | 1 | F | Remove key attributes from map elements | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0062 | 2 | F | imsVoPS for non-3GPP access | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0063 | 2 | F | Internal-Group Identifier | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0064 | 2 | F | Stateless AMF support updates | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0065 | 2 | F | Location Reporting Configuration in Nudm_EE service | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0066 | 1 | F | Nudm_SDM Errors | 15.2.0 | +| 2018-12 | CT#82 | CP-183164 | 0067 | 4 | F | Shared Data completion | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0068 | 1 | F | Cardinality for arrays | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0069 | 5 | F | Single Registration Flag | 15.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------------|--------| +| 2018-12 | CT#82 | CP-183014 | 0070 | 2 | F | Adding headers for cache control and conditional request to the Nudm_SubscriberDataManagement Service API | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0072 | 3 | F | Initial Registration | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0076 | 1 | F | Correcting Nudm_UEAuthentication service description | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0078 | 1 | F | Add Serving Network Name to AuthEvent | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0079 | 2 | F | Remove PLMN-ID from AMF registration in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0080 | | F | Make ARP mandatory in QoS parameters | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0081 | 1 | F | RAT type | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0082 | 1 | F | Correction in UDM error and response codes | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0083 | 1 | F | Retrieving UE SMSF Context with its own URI | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0084 | 1 | F | Data type associated with Subscribed Default QoS for Default QoS Flow | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0085 | 1 | F | Alignment of pattern for External identifier | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0086 | 1 | F | Callback URI for Deregistration Notification | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0088 | 1 | F | Static Ip Address in DNN Configuration | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0090 | | F | ImsVoPs type and attribute name correction | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0091 | 1 | F | Clarification on nullable attributes in AmfRegistration types | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0092 | | F | Retrieval of multiple datasets | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0094 | 2 | F | DeRegistration Reason: Re-registration Required | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0095 | | F | APIRoot Clarification | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0098 | | F | Shared Data Ids | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0099 | 1 | F | Subscription lifetime | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0100 | 3 | F | Secured packet in SORInfo | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0103 | 1 | F | Abbreviations | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0104 | 1 | F | Nudm_UECM_Deregistration clarification | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0105 | | F | Location Header | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0107 | 1 | F | SUCI Encoding | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0108 | 1 | F | S-NSSAI information in SmfRegistration | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0109 | | F | SUCI NAI Clarification | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0110 | 1 | F | Bulk subscriptions in UDM NF correction | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0111 | 1 | F | Introduction of Barring | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0112 | | F | UDM Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0114 | 2 | F | Optionality of OAuth2 | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0115 | | F | Implement MCS priority indicator | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0116 | | F | API version | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0117 | 1 | F | Shared Authentication Subscription | 15.2.0 | +| 2018-12 | CT#82 | CP-183014 | 0118 | | F | ExternalDocs update | 15.2.0 | +| 2018-12 | | | | | | 'TS29505_Nudr_DataRepository.yaml' changed to 'TS29505_Subscription_Data.yaml' in Nudm_SDM API | 15.2.1 | +| 2019-03 | CT#83 | CP-190019 | 0119 | 1 | F | Content of attribute singleNssais | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0120 | 1 | F | Formal OpenAPI corrections | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0121 | 1 | F | SdmSubscription identification | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0122 | 1 | F | Clarification on SMS barring | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0123 | 1 | F | Allow retrieval of AMF registrations with SUPI | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0125 | | F | Address Editor's Note on naming conventions | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0126 | | F | Remove Editor's Note on authorization | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0127 | | F | Remove Editor's Note on data retrieval | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0128 | 1 | F | Sdm Subscription Modification | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0130 | 1 | F | LADN Indicator removal | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0131 | 1 | F | Subscribed DNN List | 15.3.0 | +| 2019-03 | CT#83 | CP-190065 | 0134 | 2 | F | Emergency Session | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0137 | 1 | F | Application Errors | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0138 | 1 | F | Plmn ID in SdmSubscriptions | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0139 | 1 | F | URRP Indicator | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0141 | 1 | F | Handling of Multi-PDU during EPS Interworking | 15.3.0 | +| 2019-03 | CT#83 | CP-190152 | 0143 | 4 | F | UE parameters update support | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0144 | 1 | F | Cardinality of Dataset-names | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0145 | 2 | F | Removal of SharedAuthenticationSubscription | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0146 | 1 | F | Update method for event subscription | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0147 | 2 | F | SOR correction | 15.3.0 | +| 2019-03 | CT#83 | CP-190019 | 0148 | 1 | F | Storage of OpenAPI specification files | 15.3.0 | +| 2019-03 | CT#83 | CP-190204 | 0149 | 1 | F | API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191030 | 0150 | 1 | F | Location Header Description | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0151 | | F | OperationId | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0154 | 1 | F | Adding SubsId to EESubscription | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0155 | 2 | F | Essential Corrections and Re-arrange Clause Structure | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0156 | 2 | F | Partial Deletion of Monitored Resources | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0158 | 1 | F | Correct the reference in ServingNetworkName in AuthenticationInfoRequest | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0160 | 3 | F | Add trace data retrieval procedure | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0161 | 1 | F | Group Identifier Translation | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0162 | | F | SUCI with Null Protection Scheme | 15.4.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|---------------------------------------------------------------------------------------------|--------| +| 2019-06 | CT#84 | CP-191030 | 0164 | | F | CR 0128r1 was not correctly implemented | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0166 | 1 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0167 | 1 | F | Sdm-Subscription incorrect attribute name | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0168 | 1 | F | Location header in redirect response | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0169 | | F | Application error correction | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0193 | 1 | F | Storage of SubscriptionId | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0195 | 1 | F | Shared Data Ids | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0196 | 1 | F | Copyright Note in YAML files | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0201 | | F | ODB for SMF | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0202 | 2 | F | SUCI encoding | 15.4.0 | +| 2019-06 | CT#84 | CP-191030 | 0204 | | F | 3GPP TS 29.503 API version update | 15.4.0 | +| 2019-06 | CT#84 | CP-191050 | 0163 | 3 | B | Nudm_NIDDAuthorization service | 16.0.0 | +| 2019-06 | CT#84 | CP-191957 | 0170 | 1 | B | Non cacheable 501 response | 16.0.0 | +| 2019-06 | CT#84 | CP-191050 | 0176 | 2 | B | Add PDU Session continuity at inter RAT mobility to and from NB-IoT in SM Subscription data | 16.0.0 | +| 2019-06 | CT#84 | CP-191050 | 0177 | 2 | B | Add Service Gap timer in AM subscription Data t to support Overload Control for small data | 16.0.0 | +| 2019-06 | CT#84 | CP-191050 | 0178 | 2 | B | Update SM data supporting small data transfer | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0197 | 1 | B | Subscription to event "Change of Core Network Type" | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0199 | | B | Subscription Data for Tracing | 16.0.0 | +| 2019-06 | CT#84 | CP-191048 | 0203 | | F | 3GPP TS 29.503 API version update | 16.0.0 | +| 2019-09 | CT#85 | CP-192103 | 0211 | 1 | A | DNN Barring | 16.1.0 | +| 2019-09 | CT#85 | CP-192103 | 0221 | 1 | A | Monitored Resource URI | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0206 | 1 | B | Network Slicing Subscription Change | 16.1.0 | +| 2019-09 | CT#85 | CP-192191 | 0207 | 2 | B | P-CSCF Restoration Trigger | 16.1.0 | +| 2019-09 | CT#85 | CP-192191 | 0209 | | B | SMS Alerting | 16.1.0 | +| 2019-09 | CT#85 | CP-192032 | 0212 | 1 | B | Closed Access Group | 16.1.0 | +| 2019-09 | CT#85 | CP-192133 | 0213 | 2 | B | VN-Group parameter provisioning | 16.1.0 | +| 2019-09 | CT#85 | CP-192188 | 0214 | 1 | B | Providing 5G SRVCC Related Subscription to AMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192188 | 0215 | 1 | B | Report 5G SRVCC Capability to UDM | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0216 | | F | Retrieve Subscribed S-NSSAI from UDM by PGW+SMF | 16.1.0 | +| 2019-09 | CT#85 | CP-192187 | 0217 | 1 | B | Subscription on redundant sessions | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0219 | 2 | B | Indicating partially implemented PATCH | 16.1.0 | +| 2019-09 | CT#85 | CP-192026 | 0222 | 3 | B | Slice Specific Authentication and Authorization Data | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0223 | 1 | F | UDM Application errors | 16.1.0 | +| 2019-09 | CT#85 | CP-192025 | 0224 | 2 | B | 5G VN group data | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0225 | 2 | F | Correction on the subscription Id sent to the consumer | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0228 | 3 | B | Add NB-IoT UE Priority in AM subscription data | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0229 | 3 | B | Granted Validity Time for NIDD authorisation | 16.1.0 | +| 2019-09 | CT#85 | CP-102132 | 0232 | | F | Correction of CN Type change event | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0233 | 2 | B | Network configuration Parameters Provisioning | 16.1.0 | +| 2019-09 | CT#85 | CP-192092 | 0234 | 3 | B | Expected UE Behaviour Parameters provision | 16.1.0 | +| 2019-09 | CT#85 | CP-192132 | 0235 | 2 | B | Id translation for MSISDN-less MO SMS service | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0239 | | F | Correction to sharedDataSubscription description | 16.1.0 | +| 2019-09 | CT#85 | CP-192135 | 0241 | | B | Services invoked by NWDAF | 16.1.0 | +| 2019-09 | CT#85 | CP-192120 | 0243 | | F | API Version Update | 16.1.0 | +| 2019-12 | CT#86 | CP-193027 | 0268 | 2 | A | Missing AssociationType parameter | 16.2.0 | +| 2019-12 | CT#86 | CP-193054 | 0208 | 5 | B | Domain Selection Info Retrieval | 16.2.0 | +| 2019-12 | CT#86 | CP-193048 | 0247 | | B | Subscribed NSSAI from the UDM | 16.2.0 | +| 2019-12 | CT#86 | CP-193050 | 0250 | 2 | B | Serving Network Name in SNPn | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0252 | 3 | B | QoS for wireline access network | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0253 | 2 | B | LCS privacy | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0254 | 1 | B | Mobile Originated Data | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0255 | 4 | B | Retrieve Enhance Coverage Restriction Data | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0256 | 5 | B | Update Enhance Coverage Restriction Data | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0258 | 6 | B | BatteryIndication and scheduledCommunicationType parameter provision | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0259 | 2 | F | Correct Identifier Translation in Resource Overview | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0260 | 1 | B | Extend PpDIPacketCount | 16.2.0 | +| 2019-12 | CT#86 | CP-193279 | 0261 | 6 | B | UE expected behaviour in SDM | 16.2.0 | +| 2019-12 | CT#86 | CP-193050 | 0262 | 2 | B | 5G VN group data in SharedData | 16.2.0 | +| 2019-12 | CT#86 | CP-193050 | 0263 | 1 | B | 5G VN group data in PP | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0265 | 4 | B | Network Configuration Parameters in SDM | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0266 | 1 | B | Location report for non-3GPP access | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0269 | | B | Downlink Data Delivery Status Event | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0270 | 2 | F | Correction on notifications for AMF registration in UDM | 16.2.0 | +| 2019-12 | CT#86 | CP-193027 | 0272 | 1 | A | Nssai Inclusion Allowed | 16.2.0 | +| 2019-12 | CT#86 | CP-193027 | 0280 | | A | Regular Expression of SuciOrSupi | 16.2.0 | +| 2019-12 | CT#86 | CP-193027 | 0299 | | A | Availability after DDN Failure | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0300 | 1 | A | Wildcard DNN | 16.2.0 | +| 2019-12 | CT#86 | CP-193027 | 0302 | | A | Content Types in Nudm_ EE | 16.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193050 | 0275 | | B | NID in AMF Registration | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0276 | | F | Registration Time | 16.2.0 | +| 2019-12 | CT#86 | CP-193053 | 0281 | | B | Group Identifier Translation | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0282 | 1 | B | Updating support for subscription-based access restriction | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0283 | 2 | B | NIDD Authorization Update Notify | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0284 | 1 | B | NIDD Authorization Authorize | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0287 | 1 | B | Subscription level Charging Characteristics | 16.2.0 | +| 2019-12 | CT#86 | CP-193281 | 0288 | 4 | B | SMF Instance Id retrieval | 16.2.0 | +| 2019-12 | CT#86 | CP-193280 | 0289 | 4 | B | Expected UE Behaviour parameters | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0290 | 1 | B | ACS information in ParameterProvision | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0291 | 1 | B | ACS information | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0292 | 2 | B | Authentication Indication from W-AGF | 16.2.0 | +| 2019-12 | CT#86 | CP-193039 | 0293 | | B | Indication of access from ePDG | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0294 | 1 | B | DeregistrationNotification for SMF Context Transfer | 16.2.0 | +| 2019-12 | CT#86 | CP-193052 | 0295 | 2 | B | Group Reporting Guard Time | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0296 | 1 | F | Add reference to TS 29.524 | 16.2.0 | +| 2019-12 | CT#86 | CP-193282 | 0297 | 5 | B | Frame Routes | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0303 | 2 | B | Subscription Data Consistency with Immediate Report | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0305 | | F | Revisions on UDM Reference Model Figure | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0306 | 1 | F | NIDD Configuration | 16.2.0 | +| 2019-12 | CT#86 | CP-193054 | 0307 | 2 | B | Retrieval of Authentication Vectors for HSS | 16.2.0 | +| 2019-12 | CT#86 | CP-193044 | 0310 | | F | API version update | 16.2.0 | +| 2020-03 | CT#87e | CP-200019 | 0244 | 2 | B | AMF Deregistration | 16.3.0 | +| 2020-03 | CT#87e | CP-200039 | 0311 | 1 | F | Add Corresponding API descriptions in clause 5.1 | 16.3.0 | +| 2020-03 | CT#87e | CP-200032 | 0312 | 1 | F | NID | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0313 | 1 | F | Copyright Note | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0314 | 1 | F | References | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0315 | 2 | F | Eps Interworking Info | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0317 | 1 | F | Presence condition of monitoredResourceUris in SdmSubsModification | 16.3.0 | +| 2020-03 | CT#87e | CP-200176 | 0318 | 3 | B | Nudm_MT service completion | 16.3.0 | +| 2020-03 | CT#87e | CP-200019 | 0319 | 1 | B | Nudm_MT_ProvideLocationInfo service operation | 16.3.0 | +| 2020-03 | CT#87e | CP-200035 | 0320 | 1 | F | Spare Data Type Definition of RgAuthenticationInfo | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0321 | 1 | F | Clarification on SM-Data Retrieval | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0322 | 2 | B | NF deregistrations | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0323 | 1 | F | Supported Features in PATCH | 16.3.0 | +| 2020-03 | CT#87e | CP-200019 | 0324 | 1 | B | STN-SR | 16.3.0 | +| 2020-03 | CT#87e | CP-200029 | 0327 | 2 | F | Dynamic SOR update trigger | 16.3.0 | +| 2020-03 | CT#87e | CP-200033 | 0328 | 1 | B | Availability after DDN Failure Event | 16.3.0 | +| 2020-03 | CT#87e | CP-200033 | 0329 | 1 | B | Configuration of Downlink data delivery status Events | 16.3.0 | +| 2020-03 | CT#87e | CP-200240 | 0330 | 1 | B | External Group Identifier in NIDD information | 16.3.0 | +| 2020-03 | CT#87e | CP-200033 | 0331 | 3 | B | Retrieve the status of Enhanced Coverage Restriction | 16.3.0 | +| 2020-03 | CT#87e | CP-200239 | 0332 | 3 | B | Subscribed eDRX and PTW value | 16.3.0 | +| 2020-03 | CT#87e | CP-200033 | 0333 | | B | Provision of parameters Maximum Response Time and Maximum Latency | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0334 | 2 | B | Optionality of ProblemDetails | 16.3.0 | +| 2020-03 | CT#87e | CP-200031 | 0335 | 2 | B | ATSSS Support Indication in UE Subscription | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0336 | 1 | B | SMF Set ID in SMF Registration | 16.3.0 | +| 2020-03 | CT#87e | CP-200016 | 0337 | 1 | B | SMSF Set ID in SMSF Registration | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0338 | | B | SMF Registration Retrieval | 16.3.0 | +| 2020-03 | CT#87e | CP-200045 | 0339 | | B | Clarification on ODB Setting | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0340 | 1 | F | Registration Time for NF Registration | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0341 | 1 | B | Patch Result for partial PATCH | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0342 | | F | EpsIwkPgw for EPS interworking | 16.3.0 | +| 2020-03 | CT#87e | CP-200031 | 0345 | | B | Update on additionalSnssaiData | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0346 | | F | DNN includes DNN NI | 16.3.0 | +| 2020-03 | CT#87e | CP-200039 | 0347 | 1 | D | Editorial corrections | 16.3.0 | +| 2020-03 | CT#87e | CP-200039 | 0348 | 1 | F | Correction-add type definition in the Table title | 16.3.0 | +| 2020-03 | CT#87e | CP-200039 | 0349 | 1 | F | Correction-specify resource type in the clause title | 16.3.0 | +| 2020-03 | CT#87e | CP-200039 | 0350 | 1 | F | Miscellaneous corrections and clarifications | 16.3.0 | +| 2020-03 | CT#87e | CP-200029 | 0352 | 3 | B | SoR Update Indicator | 16.3.0 | +| 2020-03 | CT#87e | CP-200035 | 0353 | 1 | B | SUPI pattern | 16.3.0 | +| 2020-03 | CT#87e | CP-200027 | 0354 | 1 | B | Addition of IAB-Operation Allowed indication to AccessAndMobilitySubscriptionData | 16.3.0 | +| 2020-03 | CT#87e | CP-200036 | 0355 | | B | Subscription data for V2X | 16.3.0 | +| 2020-03 | CT#87e | CP-200183 | 0357 | 1 | F | Initial Registration procedure on a CAG Cell | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0358 | 1 | F | UDM service update for the authentication result removal | 16.3.0 | +| 2020-03 | CT#87e | CP-200037 | 0359 | 1 | B | PDN connectivity Status event | 16.3.0 | +| 2020-03 | CT#87e | CP-200018 | 0360 | 3 | B | UE Location Privacy Profile Update | 16.3.0 | +| 2020-03 | CT#87e | CP-200272 | 0362 | 5 | F | Corrections on LCS related Data Type | 16.3.0 | +| 2020-03 | CT#87e | CP-200271 | 0363 | 4 | B | Location information retrieval for GMLC | 16.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------|--------| +| 2020-03 | CT#87e | CP-200018 | 0365 | 3 | B | Provision of UE LCS privacy profile | 16.3.0 | +| 2020-03 | CT#87e | CP-200238 | 0366 | 1 | B | Translation of Group Id to UE identifier list | 16.3.0 | +| 2020-03 | CT#87e | CP-200018 | 0368 | 1 | B | VGMLC address registration | 16.3.0 | +| 2020-03 | CT#87e | CP-200019 | 0369 | | B | PEI Update | 16.3.0 | +| 2020-03 | CT#87e | CP-200020 | 0372 | | F | Attributes and its applicability for specific procedures or operations | 16.3.0 | +| 2020-03 | CT#87e | CP-200052 | 0374 | | F | API version and External doc update | 16.3.0 | +| 2020-07 | CT#88e | CP-201033 | 0377 | 1 | B | 5G SRVCC Info retrieval | 16.4.0 | +| 2020-07 | CT#88e | CP-201032 | 0379 | | F | Afid | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0380 | | F | EpsInterworkingInfo | 16.4.0 | +| 2020-07 | CT#88e | CP-201032 | 0381 | | F | CmlInfoReport | 16.4.0 | +| 2020-07 | CT#88e | CP-201032 | 0382 | | F | VgmlcAddress | 16.4.0 | +| 2020-07 | CT#88e | CP-201056 | 0384 | 1 | F | Supported Headers Tables for Request and Response codes | 16.4.0 | +| 2020-07 | CT#88e | CP-201056 | 0385 | 1 | F | Add new Notifications Overview Tables | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0386 | | F | Core Network Restrictions | 16.4.0 | +| 2020-07 | CT#88e | CP-201067 | 0387 | 1 | B | MDT user consent | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0388 | | F | SDM data re-synchronization | 16.4.0 | +| 2020-07 | CT#88e | CP-201033 | 0389 | | C | UDM Authn. Vector Generation for HSS | 16.4.0 | +| 2020-07 | CT#88e | CP-201056 | 0390 | 2 | F | Clarification on nflInstanceId in AuthEvent in Nudm_UEAuthentication | 16.4.0 | +| 2020-07 | CT#88e | CP-201047 | 0392 | 1 | B | Feature negotiation for NW slice specific authentication and authorization | 16.4.0 | +| 2020-07 | CT#88e | CP-201046 | 0393 | 1 | B | Define the value range of NB-IoT UE priority | 16.4.0 | +| 2020-07 | CT#88e | CP-201046 | 0394 | 3 | B | Monitoring Configuration for event Loss of Connectivity | 16.4.0 | +| 2020-07 | CT#88e | CP-201056 | 0396 | 1 | F | Support of inter-RAT HO from NR SA to EN-DC | 16.4.0 | +| 2020-07 | CT#88e | CP-201032 | 0397 | 2 | F | Correct the definition of LCS Privacy in SDM service | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0398 | 1 | B | Ongoing registration or handover during P-CSCF Restoration | 16.4.0 | +| 2020-07 | CT#88e | CP-201042 | 0399 | | F | Correct Cardinality of sorInfoExpectInd | 16.4.0 | +| 2020-07 | CT#88e | CP-201033 | 0400 | 1 | F | ePDG Indication in UeContextInSmfData | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0401 | 1 | F | UDM Initiated AUSF Service Invocation | 16.4.0 | +| 2020-07 | CT#88e | CP-201045 | 0402 | 1 | B | Secondary Authentication and Authorization Information in 5G VN Group Data | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0403 | | F | Clarification of Implicit Unsubscribe | 16.4.0 | +| 2020-07 | CT#88e | CP-201046 | 0404 | 1 | F | Notification Correlation ID in sub-notify of EE service | 16.4.0 | +| 2020-07 | CT#88e | CP-201033 | 0407 | 1 | B | HSS Authentication Info Request | 16.4.0 | +| 2020-07 | CT#88e | CP-201019 | 0408 | 3 | B | UE Reachability Event | 16.4.0 | +| 2020-07 | CT#88e | CP-201019 | 0409 | 3 | F | UE Reachability for SMS | 16.4.0 | +| 2020-07 | CT#88e | CP-201056 | 0410 | 1 | F | Datatype column in Resource URI variables Table | 16.4.0 | +| 2020-07 | CT#88e | CP-201056 | 0411 | 1 | F | Add Operation Name column in Custom Operations table | 16.4.0 | +| 2020-07 | CT#88e | CP-201045 | 0412 | 1 | F | Add a CAG information Subscription Change Indicator in AccessAndMobilitySubscriptionData | 16.4.0 | +| 2020-07 | CT#88e | CP-201046 | 0416 | 1 | B | Report of UE Max availability time | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0417 | 1 | B | UECM multiple registration data sets retrieval | 16.4.0 | +| 2020-07 | CT#88e | CP-201032 | 0418 | 1 | F | OpenAPI file description on RegistrationLocationInfo data type | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0420 | 1 | F | Implicit Unsubscribe | 16.4.0 | +| 2020-07 | CT#88e | CP-201067 | 0421 | 1 | B | MDT Configuration data for 5G | 16.4.0 | +| 2020-07 | CT#88e | CP-201042 | 0325 | 2 | B | SoR Info parameter Provisioning | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0383 | 2 | F | PEI | 16.4.0 | +| 2020-07 | CT#88e | CP-201191 | 0415 | 3 | F | HTTP Header storage in UDR | 16.4.0 | +| 2020-07 | CT#88e | CP-201176 | 0423 | 1 | F | UE Context in AMF Data | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0424 | | F | List of specific data types | 16.4.0 | +| 2020-07 | CT#88e | CP-201045 | 0425 | | F | NID in AMF-registrations | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0427 | | F | Retrieval of multiple data sets | 16.4.0 | +| 2020-07 | CT#88e | CP-201019 | 0429 | 1 | A | Correct Data Type Names | 16.4.0 | +| 2020-07 | CT#88e | CP-201048 | 0430 | 1 | B | N5GC device Authentication | 16.4.0 | +| 2020-07 | CT#88e | CP-201030 | 0431 | | F | DeregistrationData | 16.4.0 | +| 2020-07 | CT#88e | CP-201019 | 0434 | 1 | A | Shared Data Clarification | 16.4.0 | +| 2020-07 | CT#88e | CP-201048 | 0436 | 1 | F | Removal of RG-TMBR | 16.4.0 | +| 2020-07 | CT#88e | CP-201056 | 0437 | | F | RAT Type Restriction | 16.4.0 | +| 2020-07 | CT#88e | CP-201056 | 0438 | | F | implicitUnsubscribe for SMF | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0439 | 1 | F | Authentication results for multiple registrations | 16.4.0 | +| 2020-07 | CT#88e | CP-201342 | 0440 | 3 | F | Corrections of Enhance Coverage Restriction | 16.4.0 | +| 2020-07 | CT#88e | CP-201042 | 0441 | 1 | B | Timer needed for the SOR-AF to respond | 16.4.0 | +| 2020-07 | CT#88e | CP-201049 | 0443 | | F | Correction on V2X Subscription data | 16.4.0 | +| 2020-07 | CT#88e | CP-201032 | 0444 | 1 | B | Implementing LCS Broadcast Assistance API | 16.4.0 | +| 2020-07 | CT#88e | CP-201046 | 0445 | 3 | B | Monitoring Configuration for event UE reachability | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0446 | | F | Miscellaneous Corrections | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0447 | 1 | F | Corrections on resouce Supi of SDM service | 16.4.0 | +| 2020-07 | CT#88e | CP-201045 | 0448 | | F | 5G VN Group Data Correction | 16.4.0 | +| 2020-07 | CT#88e | CP-201034 | 0449 | | F | Cardinality of ProblemDetails | 16.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------|--------| +| 2020-07 | CT#88e | CP-201034 | 0450 | | F | Removal of error "SERVING_NETWORK_NOT_AUTHORIZED" | 16.4.0 | +| 2020-07 | CT#88e | CP-201033 | 0452 | 1 | F | Initial Registration | 16.4.0 | +| 2020-07 | CT#88e | CP-201033 | 0453 | 1 | B | Support of SMSoIP | 16.4.0 | +| 2020-07 | CT#88e | CP-201045 | 0454 | 1 | F | Handling of CAG capable UE at legacy AMF | 16.4.0 | +| 2020-07 | CT#88e | CP-201032 | 0455 | 1 | F | Mobile Originated Data retrieval | 16.4.0 | +| 2020-07 | CT#88e | CP-201073 | 0459 | | F | 3GPP TS 29.503 API Version and External doc Update | 16.4.0 | +| 2020-09 | CT#89e | CP-202043 | 0478 | | A | Introduction of NOTE for "freeze 5G-TMSI" in case of Purge | 16.5.0 | +| 2020-09 | CT#89e | CP-202043 | 0480 | | A | Correction of creation of subscription by UDM at UDR | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0460 | | F | UE Context Retrieval | 16.5.0 | +| 2020-09 | CT#89e | CP-202111 | 0461 | | F | Deregistration Reason Clarification | 16.5.0 | +| 2020-09 | CT#89e | CP-202091 | 0462 | 1 | F | Deregistration Notification | 16.5.0 | +| 2020-09 | CT#89e | CP-202231 | 0463 | 3 | F | NodeType in HssAuthenticationInfoRequest | 16.5.0 | +| 2020-09 | CT#89e | CP-202106 | 0465 | 1 | F | DN-AAA secondary authentication | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0467 | | F | UDM parameter provision datakey | 16.5.0 | +| 2020-09 | CT#89e | CP-202111 | 0468 | | F | Definition of missing error conditions in SMSF registration information retrieval | 16.5.0 | +| 2020-09 | CT#89e | CP-202091 | 0469 | 1 | F | S-NSSAI in SM Context Retrieval | 16.5.0 | +| 2020-09 | CT#89e | CP-202091 | 0470 | 1 | F | Clarification on Max Number of Reports | 16.5.0 | +| 2020-09 | CT#89e | CP-202123 | 0472 | 1 | F | Network Slices in AMF registrations | 16.5.0 | +| 2020-09 | CT#89e | CP-202105 | 0474 | | F | Invoke NEF indication | 16.5.0 | +| 2020-09 | CT#89e | CP-202105 | 0475 | 1 | F | Maximum response time/latency time | 16.5.0 | +| 2020-09 | CT#89e | CP-202091 | 0476 | 1 | F | Dedicated SMF selection | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0482 | 1 | F | Corrections on reference of common data structures | 16.5.0 | +| 2020-09 | CT#89e | CP-202115 | 0483 | 1 | F | Corrections on 5G SoR | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0484 | 1 | F | Storage of YAML files in 3GPP Forge | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0485 | 1 | F | Corrections on UPU | 16.5.0 | +| 2020-09 | CT#89e | CP-202110 | 0486 | | F | Miscellaneous corrections | 16.5.0 | +| 2020-09 | CT#89e | CP-202096 | 0489 | | F | API version and External doc update | 16.5.0 | +| 2020-09 | CT#89e | CP-202123 | 0471 | | B | Adjacent PLMN restrictions | 17.0.0 | +| 2020-09 | CT#89e | CP-202123 | 0473 | | B | Resource Level Authorization for UECM registrations | 17.0.0 | +| 2020-09 | CT#89e | CP-202017 | 0487 | 1 | B | Shared Data Treatment | 17.0.0 | +| 2020-09 | CT#89e | CP-202120 | 0488 | | F | API version and External doc update | 17.0.0 | +| 2020-12 | CT#90e | CP-203221 | 0493 | 3 | A | Initial Registration procedure on a CAG Cell | 17.1.0 | +| 2020-12 | CT#90e | CP-203050 | 0495 | 1 | A | Essential corrections | 17.1.0 | +| 2020-12 | CT#90e | CP-203044 | 0497 | 1 | A | Config DNN for PDU session status event | 17.1.0 | +| 2020-12 | CT#90e | CP-203049 | 0499 | 1 | A | Subscription applies also to EPC in EE service | 17.1.0 | +| 2020-12 | CT#90e | CP-203063 | 0500 | 1 | C | Evolution of SoR delivery mechanism – UDM API Changes | 17.1.0 | +| 2020-12 | CT#90e | CP-203064 | 0502 | 1 | A | Remove Network Slices in AMF registrations | 17.1.0 | +| 2020-12 | CT#90e | CP-203040 | 0505 | 1 | A | AMF Registration Retrieval by NSSAAF | 17.1.0 | +| 2020-12 | CT#90e | CP-203027 | 0507 | | A | Reference for NSSAI Inclusion Allowed | 17.1.0 | +| 2020-12 | CT#90e | CP-203061 | 0510 | 1 | F | SMSF Registration / Deregistration for One Access Type | 17.1.0 | +| 2020-12 | CT#90e | CP-203054 | 0512 | | A | HTTP 3xx redirection | 17.1.0 | +| 2020-12 | CT#90e | CP-203048 | 0514 | | A | SNSSAI query parameter | 17.1.0 | +| 2020-12 | CT#90e | CP-203017 | 0516 | 2 | A | UE Reachability for IP | 17.1.0 | +| 2020-12 | CT#90e | CP-203039 | 0522 | | A | Service Area Restriction in wireline | 17.1.0 | +| 2020-12 | CT#90e | CP-203062 | 0523 | | B | AKMA Indication | 17.1.0 | +| 2020-12 | CT#90e | CP-203045 | 0525 | | | Correction on event exposure | 17.1.0 | +| 2020-12 | CT#90e | CP-203061 | 0526 | | F | Incorrect reference | 17.1.0 | +| 2020-12 | CT#90e | CP-203048 | 0528 | | A | Reference ID | 17.1.0 | +| 2020-12 | CT#90e | CP-203042 | 0530 | 1 | A | Parameter Provisioning Get operation for 5G VN Group | 17.1.0 | +| 2020-12 | CT#90e | CP-203048 | 0532 | | A | Removal of SMF Individual Registration PATCH method | 17.1.0 | +| 2020-12 | CT#90e | CP-203049 | 0534 | | A | HSS Authentication HTTP 403 Error | 17.1.0 | +| 2020-12 | CT#90e | CP-203048 | 0535 | | A | Essential corrections | 17.1.0 | +| 2020-12 | CT#90e | CP-203049 | 0538 | | A | Define UE Context In AMF Data Retrieval service operation | 17.1.0 | +| 2020-12 | CT#90e | CP-203041 | 0540 | 1 | A | Essential Correction on AF ID | 17.1.0 | +| 2020-12 | CT#90e | CP-203041 | 0542 | 1 | A | Event Configuration Synchronization between 4G&5G | 17.1.0 | +| 2020-12 | CT#90e | CP-203041 | 0544 | 2 | A | Introduction of MTC Provider authorization | 17.1.0 | +| 2020-12 | CT#90e | CP-203064 | 0552 | 1 | F | Update to subscription of the notification of data change | 17.1.0 | +| 2020-12 | CT#90e | CP-203041 | 0555 | | A | Network Configuration Parameter Aggregation | 17.1.0 | +| 2020-12 | CT#90e | CP-203055 | 0558 | | F | 29.503 Rel-17 API version and External doc update | 17.1.0 | +| 2021-03 | CT#91e | CP-210024 | 0559 | 1 | C | SoR Transparent Container in Uplink | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0562 | 1 | F | EmergencyInfo | 17.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------------------------------------|--------| +| 2021-03 | CT#91e | CP-210043 | 0563 | 2 | A | Monitored resource URI | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0564 | | F | LcsBroadcastAssistanceSubscriptionData | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0565 | 1 | F | Status Code for successful Authentication Result Removal | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0566 | | F | Applicability of mtcProviderInformation and afd in MonitoringConfiguration | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0568 | | F | Clarification on subscription expiry | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0570 | | F | PpData Removal | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0571 | 1 | F | Expected UE movement | 17.2.0 | +| 2021-03 | CT#91e | CP-210043 | 0573 | | A | DIPacketCount | 17.2.0 | +| 2021-03 | CT#91e | CP-210043 | 0576 | 1 | A | Degistration Notification to Old SMF | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0577 | | F | HSS Group Id | 17.2.0 | +| 2021-03 | CT#91e | CP-210048 | 0579 | | A | AF ID for ECR Control | 17.2.0 | +| 2021-03 | CT#91e | CP-210089 | 0581 | 2 | F | Correction on UE Reachability Event | 17.2.0 | +| 2021-03 | CT#91e | CP-210049 | 0583 | | A | Slice Information for PDN Connection Setup | 17.2.0 | +| 2021-03 | CT#91e | CP-210043 | 0585 | | A | Corrections on reference of data type | 17.2.0 | +| 2021-03 | CT#91e | CP-210048 | 0587 | 1 | A | Corrections on 403 forbidden with the proper Application Errors | 17.2.0 | +| 2021-03 | CT#91e | CP-210021 | 0588 | 1 | F | Notify the revert of authorisation in EE | 17.2.0 | +| 2021-03 | CT#91e | CP-210061 | 0590 | 1 | A | Wildcard DNN in subscriptionDataSubscription | 17.2.0 | +| 2021-03 | CT#91e | CP-210050 | 0592 | 1 | A | IPTV access control information | 17.2.0 | +| 2021-03 | CT#91e | CP-210046 | 0594 | 1 | A | Support of Last known location | 17.2.0 | +| 2021-03 | CT#91e | CP-210035 | 0595 | | B | SMS routing info retrieval by UECM GET service | 17.2.0 | +| 2021-03 | CT#91e | CP-210041 | 0597 | | A | Corrected service consumer for LCS Broadcast Assistance data | 17.2.0 | +| 2021-03 | CT#91e | CP-210029 | 0599 | | F | 29.503 Rel-17 API version and External doc update | 17.2.0 | +| 2021-06 | CT#92e | CP-211028 | 0602 | | F | SmsManagementSubscriptionData | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0604 | 1 | F | Trigger P-CSCF Restoration Description and Callback URIs | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0605 | | F | UE Id in UDM SDM SubscriptionId URI | 17.3.0 | +| 2021-06 | CT#92e | CP-211022 | 0606 | 1 | B | Adding data types in Nudm_SubscriberDataManagement Service to support SPSFAS | 17.3.0 | +| 2021-06 | CT#92e | CP-211022 | 0607 | 1 | B | Adding PCF ID in Nudm_UEContextManagement Service to support SPSFAS | 17.3.0 | +| 2021-06 | CT#92e | CP-211065 | 0609 | 2 | A | SUPI in UECM GET Responses | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0610 | 1 | B | IP Index in UDM | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0612 | 1 | F | Superfluous PATCH method for Smsf3GppAccessRegistration and SmsfNon3GppAccessRegistration | 17.3.0 | +| 2021-06 | CT#92e | CP-211039 | 0613 | 1 | B | Add 5G DDNMF and ProSe Subscription Data | 17.3.0 | +| 2021-06 | CT#92e | CP-211026 | 0614 | 1 | B | Add List of Assistance Data Types for MO-LR | 17.3.0 | +| 2021-06 | CT#92e | CP-211054 | 0615 | 3 | B | API Extension of PP service for Multiple AFs | 17.3.0 | +| 2021-06 | CT#92e | CP-211083 | 0619 | 1 | A | Identifier Translation for MTLR | 17.3.0 | +| 2021-06 | CT#92e | CP-211067 | 0621 | | A | Requesting NEF ID for NIDD Authorization | 17.3.0 | +| 2021-06 | CT#92e | CP-211047 | 0622 | 1 | F | RAN Node Level Location Accuracy | 17.3.0 | +| 2021-06 | CT#92e | CP-211054 | 0623 | 1 | F | UE Reachability with Not Allowed Area | 17.3.0 | +| 2021-06 | CT#92e | CP-211031 | 0627 | 1 | B | ECS Address Information | 17.3.0 | +| 2021-06 | CT#92e | CP-211056 | 0628 | | F | OpenAPI Reference and description field for map data types | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0629 | | B | NF Set Support in SMSF Info | 17.3.0 | +| 2021-06 | CT#92e | CP-211065 | 0631 | 1 | A | UPU and SOR negative ack | 17.3.0 | +| 2021-06 | CT#92e | CP-211039 | 0632 | | B | Add DNNMF in Reference model | 17.3.0 | +| 2021-06 | CT#92e | CP-211069 | 0634 | | A | Correction on V2X Subscription Data Retrieval | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0635 | | F | Corrections on figure | 17.3.0 | +| 2021-06 | CT#92e | CP-211078 | 0637 | 1 | A | MTC Provider Info in 5G-VN-Group deletion | 17.3.0 | +| 2021-06 | CT#92e | CP-211044 | 0638 | | F | Subscribed EE profile data for a group | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0639 | 1 | F | Adding some missing description fields to data type definitions in the OpenAPI specification file of the Nudm_MT API | 17.3.0 | +| 2021-06 | CT#92e | CP-211030 | 0640 | 1 | B | New parameter Subscribed-UE-Slice-MBR added | 17.3.0 | +| 2021-06 | CT#92e | CP-211059 | 0642 | 1 | A | Redirect Responses | 17.3.0 | +| 2021-06 | CT#92e | CP-211065 | 0645 | 1 | A | amfEeSubscriptionId | 17.3.0 | +| 2021-06 | CT#92e | CP-211031 | 0646 | | B | ECS Address Information | 17.3.0 | +| 2021-06 | CT#92e | CP-211036 | 0647 | 1 | B | Support of Mute Reporting | 17.3.0 | +| 2021-06 | CT#92e | CP-211054 | 0650 | 1 | B | Service Descriptions of PP API for Multiple AFs Support | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0652 | | F | Wildcard DNN | 17.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------|--------| +| 2021-06 | CT#92e | CP-211028 | 0653 | 1 | B | AAA Server FQDN | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0654 | 1 | B | Identifier Translation | 17.3.0 | +| 2021-06 | CT#92e | CP-211038 | 0655 | 1 | F | Negotiation of Feature sorTransparentSupport | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0656 | | F | Correction on EE Modification of a subscription | 17.3.0 | +| 2021-06 | CT#92e | CP-211028 | 0657 | | F | Headers for EE service | 17.3.0 | +| 2021-06 | CT#92e | CP-211041 | 0658 | 2 | B | Aerial UE subscription data | 17.3.0 | +| 2021-06 | CT#92e | CP-211050 | 0659 | | F | 29.503 Rel-17 API version and External doc update | 17.3.0 | +| 2021-09 | CT#93e | CP-212068 | 0664 | | A | Authentication for the UE accesses from CAG cell | 17.4.0 | +| 2021-09 | CT#93e | CP-212060 | 0680 | | A | 3xx description correction for SCP | 17.4.0 | +| 2021-09 | CT#93e | CP-212064 | 0688 | | A | Encoding of binary attributes in JSON objects | 17.4.0 | +| 2021-09 | CT#93e | CP-212072 | 0692 | 1 | A | EC Restriction | 17.4.0 | +| 2021-09 | CT#93e | CP-212069 | 0704 | 1 | A | Missing Event Reports | 17.4.0 | +| 2021-09 | CT#93e | CP-212071 | 0711 | | A | Correct V2xSubscriptionData | 17.4.0 | +| 2021-09 | CT#93e | CP-212078 | 0714 | 3 | A | Sub-Notify shared data | 17.4.0 | +| 2021-09 | CT#93e | CP-212041 | 0649 | 3 | B | NWDAF register into UDM | 17.4.0 | +| 2021-09 | CT#93e | CP-212039 | 0661 | 1 | B | Network access control in SNPN | 17.4.0 | +| 2021-09 | CT#93e | CP-212039 | 0662 | 2 | B | Authentication by AAA server in CH | 17.4.0 | +| 2021-09 | CT#93e | CP-212048 | 0665 | 1 | F | Update PGW FQDN in the SMF registration | 17.4.0 | +| 2021-09 | CT#93e | CP-212031 | 0669 | | B | Spatial Validity Condition | 17.4.0 | +| 2021-09 | CT#93e | CP-212041 | 0670 | 1 | B | NF Services consumed by DCCF | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0671 | | F | Expected UE Behaviour | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0672 | | F | ImsVoPs clarification | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0673 | 1 | F | Clarification on the number of Subscribed S-NSSAIs | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0674 | | F | Routing Indicator | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0675 | 1 | F | PGW-C+SMF registration time | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0676 | | F | ContextInfo storage | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0678 | 1 | B | Shared Session Management Subscription Data | 17.4.0 | +| 2021-09 | CT#93e | CP-212041 | 0682 | 1 | B | Serving AMF and SMF change notification | 17.4.0 | +| 2021-09 | CT#93e | CP-212030 | 0683 | 2 | B | NSSRG value | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0684 | 1 | B | Evolution of UPU delivery mechanism | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0685 | | F | SUCI examples | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0686 | | F | Correction to AcknowledgeInfo Data Type Definition | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0689 | | B | Roaming status report with access type | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0690 | 1 | F | Re-Registration Required | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0693 | | F | Authorization of Identifier Translation | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0694 | | B | Authorization of Group Identifier Translation | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0695 | 1 | F | MTC Provider in NIDD Authorization | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0696 | | F | NIDD Authorization based on S-NSSAI | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0697 | 1 | B | Retrieval of RegistrationDataSets containing IP-SM-GW | 17.4.0 | +| 2021-09 | CT#93e | CP-212048 | 0698 | | F | Corrections on Update A Parameter in the AMF Registration | 17.4.0 | +| 2021-09 | CT#93e | CP-212048 | 0699 | 1 | F | Corrections on SMF registration service operation | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0700 | | F | Description of data type Report-r17 | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0701 | | F | Add missing ContextInfo in re-used Data Types tables- | 17.4.0 | +| 2021-09 | CT#93e | CP-212037 | 0702 | | B | Dynamic management of group based event monitoring | 17.4.0 | +| 2021-09 | CT#93e | CP-212041 | 0705 | | B | Persistent Data Collection via UDM | 17.4.0 | +| 2021-09 | CT#93e | CP-212159 | 0706 | 1 | F | PGW IP Address | 17.4.0 | +| 2021-09 | CT#93e | CP-212036 | 0707 | | B | Extends Multiple Data Sets for ProSe Subscription Data | 17.4.0 | +| 2021-09 | CT#93e | CP-212036 | 0708 | 1 | B | ProSe Subscription Data | 17.4.0 | +| 2021-09 | CT#93e | CP-212056 | 0712 | | F | EE subscription mapping to EPC | 17.4.0 | +| 2021-09 | CT#93e | CP-212057 | 0715 | 1 | B | Partial success on EE subscription | 17.4.0 | +| 2021-09 | CT#93e | CP-212057 | 0716 | | B | Partial success on EE subscription in EPC | 17.4.0 | +| 2021-09 | CT#93e | CP-212048 | 0717 | 1 | F | backupAmfInfo removal | 17.4.0 | +| 2021-09 | CT#93e | CP-212032 | 0718 | 1 | F | Selecting the same PCF for AMF and SMF in the EPS to 5GS mobility scenario | 17.4.0 | +| 2021-09 | CT#93e | CP-212030 | 0719 | | F | Corrections to the Nudm_SDM re-used Data Types table | 17.4.0 | +| 2021-09 | CT#93e | CP-212026 | 0720 | 1 | F | UeReachableInd | 17.4.0 | +| 2021-09 | CT#93e | CP-212059 | 0723 | | F | 29.503 Rel-17 API version and External doc update | 17.4.0 | +| 2021-12 | CT#94e | CP-213109 | 0725 | | F | Update the reference point between 5G DDNMF and UDM in Overview | 17.5.0 | +| 2021-12 | CT#94e | CP-213092 | 0726 | 2 | B | Instruction to AMF to provide all subscribed S-NSSAIs to UE | 17.5.0 | +| 2021-12 | CT#94e | CP-213093 | 0727 | 1 | B | AF Specific UE ID Retrieval | 17.5.0 | +| 2021-12 | CT#94e | CP-213093 | 0728 | 3 | B | Support for Service Specific Authorization | 17.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213085 | 0729 | 1 | F | Clarification of the response to modification of sdmSubscription | 17.5.0 | +| 2021-12 | CT#94e | CP-213085 | 0730 | 1 | F | Corrections on the Data type of pduSessionTypes in 5GVnGroupData | 17.5.0 | +| 2021-12 | CT#94e | CP-213086 | 0735 | 2 | F | ReRegistration Update | 17.5.0 | +| 2021-12 | CT#94e | CP-213086 | 0736 | 2 | C | Immediate Shared Data Report | 17.5.0 | +| 2021-12 | CT#94e | CP-213097 | 0737 | | B | 5MBS Subscription Data | 17.5.0 | +| 2021-12 | CT#94e | CP-213107 | 0738 | 1 | B | Routing Indicator | 17.5.0 | +| 2021-12 | CT#94e | CP-213085 | 0740 | 1 | F | Correction on deregistrationNotification | 17.5.0 | +| 2021-12 | CT#94e | CP-213093 | 0741 | 2 | F | ECS Address Configuration | 17.5.0 | +| 2021-12 | CT#94e | CP-213086 | 0742 | 1 | F | RAT restrictions | 17.5.0 | +| 2021-12 | CT#94e | CP-213102 | 0747 | 3 | B | Corrections on NWDAF registration | 17.5.0 | +| 2021-12 | CT#94e | CP-213088 | 0750 | | A | Removal of an Editor's Note | 17.5.0 | +| 2021-12 | CT#94e | CP-213088 | 0752 | 1 | A | CR implementation correction | 17.5.0 | +| 2021-12 | CT#94e | CP-213148 | 0759 | 1 | A | Supported Features query parameter | 17.5.0 | +| 2021-12 | CT#94e | CP-213138 | 0762 | 1 | A | Idle Status Indication | 17.5.0 | +| 2021-12 | CT#94e | CP-213088 | 0764 | | A | Wrong spelling of "locationAge" attribute in OpenAPI | 17.5.0 | +| 2021-12 | CT#94e | CP-213143 | 0775 | | A | Correction on SMF Registration Information | 17.5.0 | +| 2021-12 | CT#94e | CP-213188 | 0733 | 3 | B | Provisioning Session Authorization Information in UDM | 17.5.0 | +| 2021-12 | CT#94e | CP-213114 | 0748 | 2 | B | Send Routing Indicator to AMF after UPU | 17.5.0 | +| 2021-12 | CT#94e | CP-213087 | 0754 | 3 | F | Typo correction | 17.5.0 | +| 2021-12 | CT#94e | CP-213093 | 0755 | | B | UE authorization for 5GC assisted EAS discovery | 17.5.0 | +| 2021-12 | CT#94e | CP-213087 | 0760 | 1 | F | Naming Conventions | 17.5.0 | +| 2021-12 | CT#94e | CP-213087 | 0769 | 1 | F | Correction of miscellaneous typos and spelling errors | 17.5.0 | +| 2021-12 | CT#94e | CP-213088 | 0771 | 1 | F | SMF Registration operations | 17.5.0 | +| 2021-12 | CT#94e | CP-213113 | 0772 | | F | Corrections to the Nudm_SDM re-used Data Types | 17.5.0 | +| 2021-12 | CT#94e | CP-213086 | 0773 | | B | Minimal Reporting Interval | 17.5.0 | +| 2021-12 | CT#94e | CP-213106 | 0776 | 1 | B | SOR-CMCI support | 17.5.0 | +| 2021-12 | CT#94e | CP-213086 | 0777 | | F | 422 Unprocessable Entity | 17.5.0 | +| 2021-12 | CT#94e | CP-213110 | 0779 | 1 | B | Addition of UEs for group based event subscription | 17.5.0 | +| 2021-12 | CT#94e | CP-213087 | 0780 | 1 | F | Clarification of the response to modification of sdmSubscription | 17.5.0 | +| 2021-12 | CT#94e | CP-213189 | 0781 | 2 | B | Update Roaming Information in EPC | 17.5.0 | +| 2021-12 | CT#94e | CP-213120 | 0782 | | F | 307/308 redirection | 17.5.0 | +| 2021-12 | CT#94e | CP-213121 | 0783 | | F | 29.503 Rel-17 API version and External doc update | 17.5.0 | +| 2022-03 | CT#95e | CP-220047 | 0756 | 2 | F | UE registration in SNPN using credentials from CH | 17.6.0 | +| 2022-03 | CT#95e | CP-220047 | 0786 | 1 | F | SNPN impacts on UDM - onboarding | 17.6.0 | +| 2022-03 | CT#95e | CP-220342 | 0787 | 2 | F | SNPN impacts on UDM - PVS information | 17.6.0 | +| 2022-03 | CT#95e | CP-220041 | 0788 | | B | Emergency Registration Indication during Nudm_UECM | 17.6.0 | +| 2022-03 | CT#95e | CP-220049 | 0789 | 2 | B | User consent for analytics and model training | 17.6.0 | +| 2022-03 | CT#95e | CP-220053 | 0790 | | B | NSWO authentication | 17.6.0 | +| 2022-03 | CT#95e | CP-220036 | 0792 | 1 | B | Data Restoration Notification | 17.6.0 | +| 2022-03 | CT#95e | CP-220030 | 0793 | 1 | B | GetGbaAv Service Operation | 17.6.0 | +| 2022-03 | CT#95e | CP-220047 | 0794 | | B | Conveying the SNPN-ID on the PLMN-ID Query Parameter | 17.6.0 | +| 2022-03 | CT#95e | CP-220054 | 0795 | 1 | B | P-CSCF Restoration | 17.6.0 | +| 2022-03 | CT#95e | CP-220023 | 0797 | | F | Clarification of BackupAmfInfo | 17.6.0 | +| 2022-03 | CT#95e | CP-220023 | 0798 | | F | Removal of the redundant NOTE | 17.6.0 | +| 2022-03 | CT#95e | CP-220029 | 0800 | | B | Resource-based authorization on the Nudm_UEAU API | 17.6.0 | +| 2022-03 | CT#95e | CP-220024 | 0801 | 1 | F | Corrections related to the description fields in the OpenAPI descriptions | 17.6.0 | +| 2022-03 | CT#95e | CP-220074 | 0807 | 1 | A | Default value for noEeSubscriptionInd | 17.6.0 | +| 2022-03 | CT#95e | CP-220075 | 0812 | 1 | A | Nssaa feature description | 17.6.0 | +| 2022-03 | CT#95e | CP-220078 | 0824 | 1 | A | Correction on SDM Subscription | 17.6.0 | +| 2022-03 | CT#95e | CP-220074 | 0826 | 1 | A | Immediate Reporting in EE Subscription Response | 17.6.0 | +| 2022-03 | CT#95e | CP-220073 | 0822 | 1 | A | Routing Indicator Update in Nudm_SDM notifications | 17.6.0 | +| 2022-03 | CT#95e | CP-220025 | 0803 | 1 | F | Re-used data type is missing | 17.6.0 | +| 2022-03 | CT#95e | CP-220050 | 0810 | 1 | B | HPLMN Control in disaster roaming | 17.6.0 | +| 2022-03 | CT#95e | CP-220024 | 0813 | | F | Conditional SMSF de-registration | 17.6.0 | +| 2022-03 | CT#95e | CP-220036 | 0814 | 1 | B | Reset Ids | 17.6.0 | +| 2022-03 | CT#95e | CP-220145 | 0815 | 2 | F | Reuse of type Fqdn from 29.571 | 17.6.0 | +| 2022-03 | CT#95e | CP-220062 | 0816 | 1 | F | Minor corrections | 17.6.0 | +| 2022-03 | CT#95e | CP-220031 | 0817 | 1 | F | Service Specific Authorization Corrections | 17.6.0 | +| 2022-03 | CT#95e | CP-220062 | 0818 | 1 | F | PLMN Id of PGW-C+SMF | 17.6.0 | +| 2022-03 | CT#95e | CP-220024 | 0819 | | F | Query parameters in Monitored Resource URIs | 17.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95e | CP-220166 | 0821 | 2 | F | Event Exposure subscription revocation due to removal of GPSI | 17.6.0 | +| 2022-03 | CT#95e | CP-220025 | 0827 | 1 | B | Improvement on UeContextInSmfData Subscription | 17.6.0 | +| 2022-03 | CT#95e | CP-220049 | 0828 | | B | Registration Data Sets retrieval | 17.6.0 | +| 2022-03 | CT#95e | CP-220035 | 0829 | | B | Subscription Data Sets retrieval | 17.6.0 | +| 2022-03 | CT#95e | CP-220044 | 0832 | | B | Aerial service indication in UUAA-SM | 17.6.0 | +| 2022-03 | CT#95e | CP-220062 | 0834 | | | Update incorrect NOTE format | 17.6.0 | +| 2022-03 | CT#95e | CP-220036 | 0836 | 1 | B | Usage of registrationTime on Nudm | 17.6.0 | +| 2022-03 | CT#95e | CP-220047 | 0835 | 1 | B | EAP-TTLS support in SNPN (TS 29.503) | 17.6.0 | +| 2022-03 | CT#95e | CP-220066 | 0839 | | F | API version and External doc update | 17.6.0 | +| 2022-06 | CT#96 | CP-221052 | 0842 | 1 | F | SMF Deregistration for Duplicated PDU Session | 17.7.0 | +| 2022-06 | CT#96 | CP-221028 | 0843 | 1 | F | IP address allocation paramer provisioning for 5G VN group data | 17.7.0 | +| 2022-06 | CT#96 | CP-221036 | 0844 | | F | SUCI Regular Expression Pattern | 17.7.0 | +| 2022-06 | CT#96 | CP-221027 | 0845 | | F | Correction of typos in description fields | 17.7.0 | +| 2022-06 | CT#96 | CP-221033 | 0846 | 1 | F | Default subscribed S-NSSAI not subject to NSAC | 17.7.0 | +| 2022-06 | CT#96 | CP-221040 | 0847 | | B | eDRX parameter for Redcap | 17.7.0 | +| 2022-06 | CT#96 | CP-221034 | 0848 | 1 | F | Data Type descriptions in Nudm SSAU | 17.7.0 | +| 2022-06 | CT#96 | CP-221027 | 0849 | | F | FQDN in PscfAddress | 17.7.0 | +| 2022-06 | CT#96 | CP-221027 | 0850 | 1 | F | IdTranslationResult | 17.7.0 | +| 2022-06 | CT#96 | CP-221027 | 0851 | | F | Retrieval Of Multiple UE Registration Data Sets | 17.7.0 | +| 2022-06 | CT#96 | CP-221027 | 0852 | | F | Shared Data clarification | 17.7.0 | +| 2022-06 | CT#96 | CP-221027 | 0853 | 1 | F | Maximum IPv6 prefix size | 17.7.0 | +| 2022-06 | CT#96 | CP-221045 | 0854 | 1 | F | EES as the consent enforcing entity | 17.7.0 | +| 2022-06 | CT#96 | CP-221034 | 0855 | 1 | F | Service Specific Authorization | 17.7.0 | +| 2022-06 | CT#96 | CP-221039 | 0856 | 1 | B | Disaster Roaming Indicator | 17.7.0 | +| 2022-06 | CT#96 | CP-221052 | 0857 | | F | Cardinality of the data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221043 | 0858 | 1 | B | New GetProseAv service operation in Nudm_UEAuthentication | 17.7.0 | +| 2022-06 | CT#96 | CP-221043 | 0859 | | B | Overview of New GetProseAv service operation | 17.7.0 | +| 2022-06 | CT#96 | CP-221032 | 0860 | | F | Update the introduction and reference for GetGbaAv | 17.7.0 | +| 2022-06 | CT#96 | CP-221052 | 0861 | 1 | F | Update on SMF+PGW-C assigned PDU Session ID | 17.7.0 | +| 2022-06 | CT#96 | CP-221028 | 0863 | | F | Correction of incorrect data types reference in Amf3GppAccessRegistration and AmfNon3GppAccessRegistration | 17.7.0 | +| 2022-06 | CT#96 | CP-221031 | 0864 | 1 | B | Add SBI support Indication for IP-SM-GW. | 17.7.0 | +| 2022-06 | CT#96 | CP-221031 | 0865 | 1 | B | Add SBI support Indication for SMSF. | 17.7.0 | +| 2022-06 | CT#96 | CP-221064 | 0868 | | A | AUSF Set Id in AuthEvent | 17.7.0 | +| 2022-06 | CT#96 | CP-221038 | 0869 | | | eNA Supported Features Description | 17.7.0 | +| 2022-06 | CT#96 | CP-221039 | 0870 | 2 | B | UE MINT support indicator | 17.7.0 | +| 2022-06 | CT#96 | CP-221043 | 0873 | | F | Update the reference point between DDNMF and UDM | 17.7.0 | +| 2022-06 | CT#96 | CP-221037 | 0875 | 1 | B | Update Nudm_SDM_Get to support TSCTSF | 17.7.0 | +| 2022-06 | CT#96 | CP-221037 | 0876 | | F | Update the reference point between TSCTSF and UDM | 17.7.0 | +| 2022-06 | CT#96 | CP-221029 | 0877 | 1 | F | Remove the apiVersion placeholder from the resource URI variables table | 17.7.0 | +| 2022-06 | CT#96 | CP-221235 | 0878 | 3 | B | Nudm_ReportSMDeliveryStatus service API | 17.7.0 | +| 2022-06 | CT#96 | CP-221031 | 0880 | 1 | B | Update EventExposure for SMS | 17.7.0 | +| 2022-06 | CT#96 | CP-221029 | 0881 | 1 | F | Nudm_UEAU Reused Data Types | 17.7.0 | +| 2022-06 | CT#96 | CP-221039 | 0882 | | F | Network-initiated Deregistration if disaster condition is no longer being applicable | 17.7.0 | +| 2022-06 | CT#96 | CP-221052 | 0887 | | F | Correction on enumeration values | 17.7.0 | +| 2022-06 | CT#96 | CP-221044 | 0888 | 1 | F | SBI-based Secondary Authentication and Authorization | 17.7.0 | +| 2022-06 | CT#96 | CP-221031 | 0889 | 1 | B | Send Routing Info For SM | 17.7.0 | +| 2022-06 | CT#96 | CP-221036 | 0890 | 1 | F | SOR-SNPN-SI Support Indication | 17.7.0 | +| 2022-06 | CT#96 | CP-221025 | 0891 | 1 | F | UDR Restoration | 17.7.0 | +| 2022-06 | CT#96 | CP-221059 | 0893 | | B | Updating the UcPurpose data type for EDGEAPP | 17.7.0 | +| 2022-06 | CT#96 | CP-221051 | 0894 | | F | API version and External doc update | 17.7.0 | +| 2022-09 | CT#97e | CP-222065 | 0926 | 1 | A | Clarification of NIDD Authorization | 17.8.0 | +| 2022-09 | CT#97e | CP-222037 | 0874 | 2 | F | Support Anonymous SUCI | 17.8.0 | +| 2022-09 | CT#97e | CP-222037 | 0896 | | F | PVS related alignment | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0898 | | F | ContextInfo in AuthorizationInfo on Nudr | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0899 | | F | DATA NOT FOUND | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0900 | | F | EC restriction | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0901 | | F | Allow empty array in 200 OK | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0903 | | F | Idle Status Indication | 17.8.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------|--------| +| 2022-09 | CT#97e | CP-222027 | 0905 | | F | Security scope for Nudm_RSDS | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0906 | | F | Shared AccessAndMobilitySubscriptionData clarification | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0907 | | F | Query parameter shared-data-ids | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0908 | | F | Supported Features query parameter for individual shared data retrieval | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0910 | | F | DeregistrationReason | 17.8.0 | +| 2022-09 | CT#97e | CP-222047 | 0911 | 1 | F | Monitoring Event Configuration | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0912 | | F | SupportedFeatures in SmsSubscriptionData and SessionManagementSubscriptionData | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0913 | | F | UPU clarification | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0914 | 1 | F | Empty UeContextInSmfData | 17.8.0 | +| 2022-09 | CT#97e | CP-222035 | 0917 | 1 | F | Resolve EN for 5G ProSe Services Operations | 17.8.0 | +| 2022-09 | CT#97e | CP-222026 | 0918 | 1 | F | AreaCode for Forbidden Areas | 17.8.0 | +| 2022-09 | CT#97e | CP-222029 | 0919 | 1 | F | Correction of ECS Address Configuration Information | 17.8.0 | +| 2022-09 | CT#97e | CP-222029 | 0920 | 1 | F | Correction of ServiceSpecificAuthorization | 17.8.0 | +| 2022-09 | CT#97e | CP-222044 | 0923 | | F | Nwdaif Registration Modification | 17.8.0 | +| 2022-09 | CT#97e | CP-222044 | 0924 | | F | S-NSSAI of PDU Session registered to UDM | 17.8.0 | +| 2022-09 | CT#97e | CP-222027 | 0929 | | B | Update on IP-SM-GW and SMS router address | 17.8.0 | +| 2022-09 | CT#97e | CP-222057 | 0931 | | F | Roaming Info Update | 17.8.0 | +| 2022-09 | CT#97e | CP-222057 | 0932 | 2 | F | PEI Information | 17.8.0 | +| 2022-09 | CT#97e | CP-222058 | 0933 | | F | API version and External doc update | 17.8.0 | +| 2022-12 | CT#98e | CP-223067 | 0948 | 1 | A | Return GUAMI of Serving AMF to GMLC | 17.9.0 | +| 2022-12 | CT#98e | CP-223054 | 0936 | 1 | F | Serving Network Name in ProSeAuthenticationInfoRequest | 17.9.0 | +| 2022-12 | CT#98e | CP-223061 | 0946 | 1 | F | Correction on Batch Operation for Subscription Retrieval | 17.9.0 | +| 2022-12 | CT#98e | CP-223094 | 0949 | 2 | F | Service Specific Authorization Remove | 17.9.0 | +| 2022-12 | CT#98e | CP-223045 | 0950 | 1 | F | Update to Service Specific Authorization Create and UpdateNotify | 17.9.0 | +| 2022-12 | CT#98e | CP-223060 | 0951 | | F | Correction on PLMN IDs in UECM service | 17.9.0 | +| 2022-12 | CT#98e | CP-223061 | 0952 | | F | Essential Clarification for SMF Deregistration | 17.9.0 | +| 2022-12 | CT#98e | CP-223050 | 0956 | 3 | F | Mapping GPSIs and Group Identifiers to a SUPI list | 17.9.0 | +| 2022-12 | CT#98e | CP-223047 | 0958 | 1 | F | Data Restoration Notification for Nudm_ EE | 17.9.0 | +| 2022-12 | CT#98e | CP-223054 | 0965 | 3 | F | Update on ProSeAuthenticationInfoResult | 17.9.0 | +| 2022-12 | CT#98e | CP-223066 | 0971 | | F | 29.503 Rel-17 API version and External doc update | 17.9.0 | +| 2022-12 | CT#98e | CP-223029 | 0938 | 1 | F | Access Type Restriction | 18.0.0 | +| 2022-12 | CT#98e | CP-223034 | 0940 | | F | CAG feature support in UECM | 18.0.0 | +| 2022-12 | CT#98e | CP-223034 | 0941 | | F | Authentication Information Retrieval | 18.0.0 | +| 2022-12 | CT#98e | CP-223029 | 0942 | 2 | F | ProSe Authentication Vector Cardinality | 18.0.0 | +| 2022-12 | CT#98e | CP-223029 | 0943 | 2 | F | Additional Filter for Immediate Report in SdmSubscription | 18.0.0 | +| 2022-12 | CT#98e | CP-223029 | 0944 | 1 | B | SubscriptionId in ModificationNotification | 18.0.0 | +| 2022-12 | CT#98e | CP-223027 | 0945 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98e | CP-223027 | 0953 | | F | requestHeaders in ContextInfo | 18.0.0 | +| 2022-12 | CT#98e | CP-223027 | 0957 | | F | Correction on Internal Group Id creation | 18.0.0 | +| 2022-12 | CT#98e | CP-223027 | 0959 | | B | Improvement to UDM-triggered PDU Session deregistration procedure | 18.0.0 | +| 2022-12 | CT#98e | CP-223096 | 0960 | 2 | F | Correction of boolean type IEs | 18.0.0 | +| 2022-12 | CT#98e | CP-223068 | 0969 | 2 | F | Update on vgm1cAddress | 18.0.0 | +| 2022-12 | CT#98e | CP-223033 | 0970 | | F | 29.503 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230072 | 0975 | 1 | A | 3GppChargingCharacteristics in AccessAndMobilitySubscriptionData | 18.1.0 | +| 2023-03 | CT#99 | CP-230073 | 0977 | | A | UE Memory Capacity for SMS | 18.1.0 | +| 2023-03 | CT#99 | CP-230084 | 0981 | | A | NwdaifRegistrationmodification yaml correction | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0989 | | A | MDT user consent | 18.1.0 | +| 2023-03 | CT#99 | CP-230085 | 0996 | 1 | A | Extend subscribed PTW length value to support NR connected to 5GC scenario | 18.1.0 | +| 2023-03 | CT#99 | CP-230081 | 1002 | 1 | A | Update proseServiceAuth description | 18.1.0 | +| 2023-03 | CT#99 | CP-230081 | 1004 | 1 | A | Nudm_UE Identifier Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230081 | 1014 | | A | Update the Prose Subscription Data Retrieval | 18.1.0 | +| 2023-03 | CT#99 | CP-230078 | 1019 | | A | Corrections of UDR Restoration procedures over Nudm_ EE service | 18.1.0 | +| 2023-03 | CT#99 | CP-230078 | 1022 | | A | Corrections of UDR Restoration procedures over Nudm_ SDM service | 18.1.0 | +| 2023-03 | CT#99 | CP-230078 | 1024 | 1 | A | Corrections of UDR Restoration procedures over Nudm_ UEAU service | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0939 | 1 | B | Monitoring Suspension | 18.1.0 | +| 2023-03 | CT#99 | CP-230053 | 0978 | 2 | B | Time Sync Data in AccessAndMobilitySubscriptionData | 18.1.0 | +| 2023-03 | CT#99 | CP-230055 | 0979 | 4 | B | Time Sync Subscription Data | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0982 | | F | Nudm_ MT service operation names | 18.1.0 | +| 2023-03 | CT#99 | CP-230033 | 0983 | 1 | B | SMF Selection data for HR SBO in VPLMN | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0984 | 1 | B | OAuth2 scopes in the Nudm_ SDM API | 18.1.0 | +| 2023-03 | CT#99 | CP-230033 | 0985 | 1 | B | Session Management Subscription data for HR SBO in VPLMN | 18.1.0 | +| 2023-03 | CT#99 | CP-230037 | 0986 | | F | SNPN NOT_ALLOWED | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0992 | | F | CAG information subscription change | 18.1.0 | +| 2023-03 | CT#99 | CP-230275 | 0993 | 3 | B | Other LCS Subscription Data | 18.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------|--------| +| 2023-03 | CT#99 | CP-230263 | 0998 | 1 | F | Adding description of Enumerations in open API files of 29.503 | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 1005 | 2 | B | Implicit Unsubscribe for SMF Events | 18.1.0 | +| 2023-03 | CT#99 | CP-230048 | 1006 | 2 | B | Support of Group Member List Change event | 18.1.0 | +| 2023-03 | CT#99 | CP-230063 | 1007 | 1 | F | Correction on the table name and data type | 18.1.0 | +| 2023-03 | CT#99 | CP-230071 | 1026 | | F | 29.503 Rel-18 API version and External doc update | 18.1.0 | +| 2023-06 | CT#100 | CP-231089 | 1030 | | A | DnnConfiguration description | 18.2.0 | +| 2023-06 | CT#100 | CP-231077 | 1052 | | A | Response message of Data Restoration notifications | 18.2.0 | +| 2023-06 | CT#100 | CP-231076 | 1062 | 3 | A | Update on Multicast MBS group membership management parameters | 18.2.0 | +| 2023-06 | CT#100 | CP-231037 | 0997 | 3 | B | MBS assistance information | 18.2.0 | +| 2023-06 | CT#100 | CP-231027 | 1020 | 4 | F | Location header and missing Redirection clause | 18.2.0 | +| 2023-06 | CT#100 | CP-231059 | 1031 | | F | VnGroupData | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 1032 | | F | Multiple data sets retrieval with query parameters | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 1033 | | F | Removal of unsuccessful Network Slicing Subscription Change Indication | 18.2.0 | +| 2023-06 | CT#100 | CP-231059 | 1034 | | F | Nudm_PP 5GVnGroup retrieval | 18.2.0 | +| 2023-06 | CT#100 | CP-231061 | 1035 | 1 | F | Disaster Roaming | 18.2.0 | +| 2023-06 | CT#100 | CP-231048 | 1036 | 1 | B | Subscribed NSAC Admission Mode | 18.2.0 | +| 2023-06 | CT#100 | CP-231048 | 1037 | 1 | B | S-NSSAI Validity Time | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 1038 | 1 | B | Resource and Service Operation for LCS Subscription Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231033 | 1039 | 1 | B | ECS Address Configuration Information delivery in roaming | 18.2.0 | +| 2023-06 | CT#100 | CP-231053 | 1040 | 5 | B | Support Confidence/Accuracy levels in Nudm_SDM API | 18.2.0 | +| 2023-06 | CT#100 | CP-231053 | 1041 | 5 | B | Support Confidence/Accuracy levels in Nudm_PP API | 18.2.0 | +| 2023-06 | CT#100 | CP-231029 | 1042 | 3 | F | Adding description to Enumerations for Nudm_UECM API in 29.503 | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 1043 | | F | InternalGroupIdIdentifier in 5GVnGroupConfiguration | 18.2.0 | +| 2023-06 | CT#100 | CP-231059 | 1044 | | F | SharedVnGroupDataIds on Nudr | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 1047 | | B | Add new types for PLMN Operator Class | 18.2.0 | +| 2023-06 | CT#100 | CP-231047 | 1048 | 1 | B | Enhancement of Event muting mechanism | 18.2.0 | +| 2023-06 | CT#100 | CP-231058 | 1053 | 2 | B | Indication of "Memory Available" from SMSF | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 1060 | 2 | B | Support of event report allowed area | 18.2.0 | +| 2023-06 | CT#100 | CP-231049 | 1066 | 1 | B | Support of 5G VN group communication indication | 18.2.0 | +| 2023-06 | CT#100 | CP-231049 | 1067 | 5 | B | Update on DNN and S-NSSAI specific Group Parameters | 18.2.0 | +| 2023-06 | CT#100 | CP-231043 | 1068 | 2 | B | Update on Time Sync Subscription Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231055 | 1070 | 2 | B | Support of CAG enhancement for UE access control via MBSR | 18.2.0 | +| 2023-06 | CT#100 | CP-231087 | 1086 | | A | LcsBroadcastAssistanceTypesData Bit Order | 18.2.0 | +| 2023-06 | CT#100 | CP-231028 | 1087 | | F | Periodic Reporting Mode | 18.2.0 | +| 2023-06 | CT#100 | CP-231029 | 1098 | 1 | F | Correction of data-type Boolean in 29.503 | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 1081 | 1 | F | Change the type of prulnd to enum | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 1088 | 3 | B | Add area usage indication | 18.2.0 | +| 2023-06 | CT#100 | CP-231032 | 1076 | 1 | B | Shared Data optimization | 18.2.0 | +| 2023-06 | CT#100 | CP-231033 | 1090 | 1 | F | Update the description of hrSboAllowed | 18.2.0 | +| 2023-06 | CT#100 | CP-231037 | 1079 | 3 | B | Provisioning of MBS Session Assistance Information per External Group Id | 18.2.0 | +| 2023-06 | CT#100 | CP-231042 | 1089 | 1 | B | Update on U2U relay capabilities and subscription | 18.2.0 | +| 2023-06 | CT#100 | CP-231043 | 1075 | 1 | B | Clock Quality parameters | 18.2.0 | +| 2023-06 | CT#100 | CP-231047 | 1091 | 1 | B | Variable reporting periodicity | 18.2.0 | +| 2023-06 | CT#100 | CP-231049 | 1092 | 2 | B | Update on cross-SMF VN group communication | 18.2.0 | +| 2023-06 | CT#100 | CP-231052 | 1094 | 2 | B | Ranging Sidelink Positioning Subscription data | 18.2.0 | +| 2023-06 | CT#100 | CP-231053 | 1072 | 1 | B | Support Application Specific UE Behaviour Data in Nudm_PP API | 18.2.0 | +| 2023-06 | CT#100 | CP-231053 | 1073 | 3 | B | Support Application Specific UE Behaviour Data in SM Subscription Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231053 | 1074 | 1 | B | Support Confidence/Accuracy levels in SdmSubscription | 18.2.0 | +| 2023-06 | CT#100 | CP-231053 | 1080 | 1 | B | Support UE Member Selection with QoS filtering criteria in Nudm_EE API | 18.2.0 | +| 2023-06 | CT#100 | CP-231029 | 1095 | 1 | F | Error correction for 5G VN group | 18.2.0 | +| 2023-06 | CT#100 | CP-231070 | 1099 | | F | 29.503 Rel-18 API version and External doc update | 18.2.0 | +| 2023-09 | CT#101 | CP-232061 | 1124 | | A | Removal of 5G_SRVCC_TO_UTRAN_MOBILITY Deregistration reason | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 1077 | 3 | B | SMF registration stale check | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 1102 | | B | OAuth2 scopes in the Nudm_EE API | 18.3.0 | +| 2023-09 | CT#101 | CP-232056 | 1103 | | B | Authentication of AUN3 devices behind RG | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 1107 | | B | Additional Shared DNN Config IDs in Session Management Subscription Data | 18.3.0 | +| 2023-09 | CT#101 | CP-232040 | 1108 | | C | Common Time Sync Data | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 1109 | 1 | B | Wildcard Indication in PgwnInfo | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 1110 | 1 | B | Wildcard Indication in SmfRegistration on Nudr | 18.3.0 | +| 2023-09 | CT#101 | CP-232059 | 1112 | 2 | B | Nudm_UECM ReauthNotification service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232050 | 1113 | 1 | B | Out of Range Error for Confidence/Accuracy Levels | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 1116 | 1 | F | Correction to figure 5.3.2.6.2-1 | 18.3.0 | +| 2023-09 | CT#101 | CP-232044 | 1119 | 1 | B | Maximum Group Data Rate | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 1120 | | B | QoE Measurements Collection (QMC) Configuration Information | 18.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232033 | 1121 | 1 | C | NEF Reference ID | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 1122 | 1 | F | Roaming-Info-Update service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232147 | 1125 | 2 | B | Subscription data for A2X | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 1126 | 1 | B | Indication for periodic or triggered location events via user plane | 18.3.0 | +| 2023-09 | CT#101 | CP-232051 | 1127 | 1 | B | Clarify the parameter provisioning related service operation for PIN | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 1128 | 1 | F | Correction on Area Usage Indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 1129 | | F | Indication for 4G Subscription in UDM Responses | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 1130 | 1 | F | NoEeSubscription Indication for Event Synchronization | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 1131 | 1 | F | Immediate Reporting Handling | 18.3.0 | +| 2023-09 | CT#101 | CP-232059 | 1133 | 1 | B | New Nudm_UECM AuthTrigger service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232059 | 1134 | | B | Update the Reference model | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 1135 | 1 | B | Support on Indication of user plane positioning between UE and LMF | 18.3.0 | +| 2023-09 | CT#101 | CP-232056 | 1136 | 1 | B | Support on MSK Indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232049 | 1137 | 2 | B | Resolve Editor's Note | 18.3.0 | +| 2023-09 | CT#101 | CP-232040 | 1138 | 1 | F | Clarification on AfRequestAuthorization | 18.3.0 | +| 2023-09 | CT#101 | CP-232053 | 1139 | 3 | B | Add MBSR Operation allowed | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 1140 | 3 | F | Update on 5G VN Group modification | 18.3.0 | +| 2023-09 | CT#101 | CP-232048 | 1142 | 2 | B | An update of CP-SOR (SOR-SNPN-SI-LS) Information for SNPNs | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 1144 | 1 | B | Network-based per UE Network Slice usage behaviour control in Nudm_PP | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 1145 | 1 | B | Network-based per UE Network Slice usage behaviour control in Nudm_SDM | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 1146 | | F | Adding the missing description fields | 18.3.0 | +| 2023-09 | CT#101 | CP-232060 | 1147 | | F | 29.503 Rel-18 API version and External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233062 | 1155 | | A | Adjacent PLMNs query parameter format | 18.4.0 | +| 2023-12 | CT#102 | CP-233047 | 1153 | | F | Wrong CR implementation | 18.4.0 | +| 2023-12 | CT#102 | CP-233027 | 1160 | | F | 5G VN Group Modification | 18.4.0 | +| 2023-12 | CT#102 | CP-233027 | 1161 | | D | Editorial corrections | 18.4.0 | +| 2023-12 | CT#102 | CP-233055 | 1163 | | B | Support the 5G ProSe End UE | 18.4.0 | +| 2023-12 | CT#102 | CP-233035 | 1166 | | F | Update the service operation name | 18.4.0 | +| 2023-12 | CT#102 | CP-233033 | 1170 | | B | Corrections on the MbsSubscriptionData | 18.4.0 | +| 2023-12 | CT#102 | CP-233027 | 1172 | | B | Per Monitoring Configuration Failure Cause in Error Response | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 1173 | | F | Missed Data Types in Index Table | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 1174 | | F | Consistent ODB Configuration | 18.4.0 | +| 2023-12 | CT#102 | CP-233028 | 1177 | | F | Clarification of Stateless UDMs | 18.4.0 | +| 2023-12 | CT#102 | CP-233050 | 1178 | | B | Update to support SLPKMF | 18.4.0 | +| 2023-12 | CT#102 | CP-233051 | 1171 | 1 | B | Packet Filters in App Specific UE Behaviour Data | 18.4.0 | +| 2023-12 | CT#102 | CP-233028 | 1149 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233028 | 1106 | 4 | F | Reporting of roaming status | 18.4.0 | +| 2023-12 | CT#102 | CP-233029 | 1167 | 1 | F | Clarification on the SM subscription data Notification | 18.4.0 | +| 2023-12 | CT#102 | CP-233029 | 1175 | 1 | B | Update on the Data Change Notification to NF | 18.4.0 | +| 2023-12 | CT#102 | CP-233035 | 1159 | 1 | F | Reauthentication ongoing when receiving Auth Trigger | 18.4.0 | +| 2023-12 | CT#102 | CP-233076 | 1169 | 1 | B | Clarification for AfRequestAuthorization | 18.4.0 | +| 2023-12 | CT#102 | CP-233035 | 1180 | 1 | F | Addition of "AaNF" in Nudm Subscriber management service | 18.4.0 | +| 2023-12 | CT#102 | CP-233049 | 1179 | 1 | B | Addition of SOR-SNPN-SI in SoR information update | 18.4.0 | +| 2023-12 | CT#102 | CP-233045 | 1164 | 1 | B | Muting enhancements | 18.4.0 | +| 2023-12 | CT#102 | CP-233044 | 1152 | 1 | F | Validity Time in AuthorizationInfo | 18.4.0 | +| 2023-12 | CT#102 | CP-233029 | 1151 | 2 | F | single-nssai query parameter clarification | 18.4.0 | +| 2023-12 | CT#102 | CP-233035 | 1156 | 3 | F | Reauthentication required during EPS to 5GS mobility | 18.4.0 | +| 2023-12 | CT#102 | CP-233071 | 1198 | | A | Update the description of MTC_PROVIDER_NOT_ALLOWED | 18.4.0 | +| 2023-12 | CT#102 | CP-233029 | 1181 | | F | UECM deregistration due to ODB | 18.4.0 | +| 2023-12 | CT#102 | CP-233029 | 1182 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233047 | 1183 | 2 | F | LADN Service Area in AccessAndMobilitySubscriptionData | 18.4.0 | +| 2023-12 | CT#102 | CP-233054 | 1184 | 1 | F | Access restriction for AUN3 devices | 18.4.0 | +| 2023-12 | CT#102 | CP-233047 | 1187 | 1 | F | Correction to DNN and S-NSSAI specific Group Parameters | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 1188 | 1 | F | Area Usage Indication Definition Alignment to Stage 2 | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 1189 | 1 | F | Trace Data Retrieval | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 1190 | 1 | B | UDM initiated SMF Deregistration and Implicit Unsubscribe for SMF Events | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 1191 | | B | Addition of examples to 5G VN Configuration | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 1193 | | F | Correction of Disaster Roaming Indication | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 1200 | | F | 29.503 Rel-18 API version and External doc update | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29504/raw.md b/raw/rel-18/29_series/29504/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..98660441d6e7c022b26dceb2353ed90b85fc00bc --- /dev/null +++ b/raw/rel-18/29_series/29504/raw.md @@ -0,0 +1,2864 @@ + + +# 3GPP TS 29.504 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Unified Data Repository Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 5 Services offered by the UDR ..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Nudr_DataRepository Service..... | 10 | +| 5.2.1 Service Description ..... | 10 | +| 5.2.1.1 Service and operation description..... | 10 | +| 5.2.1.2 Service operation and data access authorization..... | 10 | +| 5.2.2 Service Operations..... | 11 | +| 5.2.2.1 Introduction..... | 11 | +| 5.2.2.2 Query ..... | 11 | +| 5.2.2.2.1 General ..... | 11 | +| 5.2.2.2.2 Data retrieval ..... | 11 | +| 5.2.2.2.3 Retrieval of subset of a resource ..... | 12 | +| 5.2.2.3 Create ..... | 13 | +| 5.2.2.3.1 General ..... | 13 | +| 5.2.2.3.2 Data Creation using PUT ..... | 14 | +| 5.2.2.3.3 Data Creation using POST ..... | 14 | +| 5.2.2.4 Delete ..... | 15 | +| 5.2.2.4.1 General ..... | 15 | +| 5.2.2.4.2 Deleting Data..... | 15 | +| 5.2.2.5 Update ..... | 15 | +| 5.2.2.5.1 General ..... | 15 | +| 5.2.2.5.2 Data Update using PATCH..... | 15 | +| 5.2.2.5.3 Data Update using PUT..... | 16 | +| 5.2.2.6 Subscribe..... | 16 | +| 5.2.2.6.1 General ..... | 16 | +| 5.2.2.6.2 NF service consumer subscribes to notifications to UDR..... | 17 | +| 5.2.2.6.3 Stateless UDM subscribes to notifications to UDR..... | 17 | +| 5.2.2.7 Unsubscribe ..... | 18 | +| 5.2.2.7.1 General ..... | 18 | +| 5.2.2.7.2 Unsubscribe service operation ..... | 18 | +| 5.2.2.8 Notify ..... | 19 | +| 5.2.2.8.1 General ..... | 19 | +| 5.2.2.8.2 Notification to NF service consumer on data change ..... | 19 | +| 5.2.2.8.3 Notification to stateless UDM on data change..... | 19 | +| 5.2.2.9 DataRestorationNotification ..... | 20 | +| 5.2.2.9.1 General ..... | 20 | +| 5.2.2.9.2 Notification on Data Restoration..... | 20 | +| 5.3 Nudr_GroupIDmap Service ..... | 21 | +| 5.3.1 Service Description ..... | 21 | +| 5.3.1.1 Service and operation description..... | 21 | +| 5.3.2 Service Operations..... | 21 | +| 5.3.2.1 Introduction..... | 21 | +| 5.3.2.2 Query ..... | 21 | +| 5.3.2.2.1 General ..... | 21 | +| 5.3.2.2.2 NF Group ID retrieval ..... | 22 | +| 5.3.2.3 QueryRID..... | 22 | +| 5.3.2.3.1 General ..... | 22 | + +| | | | +|------------|-------------------------------------------------------|----| +| 5.3.2.3.2 | Routing IDs retrieval..... | 22 | +| 6 | API Definitions ..... | 23 | +| 6.1 | Nudr_DataRepository Service API..... | 23 | +| 6.1.1 | API URI..... | 23 | +| 6.1.2 | Usage of HTTP..... | 23 | +| 6.1.2.1 | General..... | 23 | +| 6.1.2.2 | HTTP standard headers..... | 23 | +| 6.1.2.2.1 | General ..... | 23 | +| 6.1.2.2.2 | Content type ..... | 23 | +| 6.1.2.2.3 | Cache-Control ..... | 24 | +| 6.1.2.2.4 | ETag ..... | 24 | +| 6.1.2.2.5 | If-None-Match..... | 24 | +| 6.1.2.2.5a | If-Match..... | 24 | +| 6.1.2.2.6 | Last-Modified..... | 24 | +| 6.1.2.2.7 | If-Modified-Since..... | 24 | +| 6.1.2.2.8 | When to Use Entity-Tags and Last-Modified Dates ..... | 24 | +| 6.1.2.3 | HTTP custom headers..... | 24 | +| 6.1.2.3.1 | General ..... | 24 | +| 6.1.2.3.2 | 3gpp-Sbi-Message-Priority ..... | 25 | +| 6.1.2.3.3 | 3gpp-Sbi-Notification-Correlation..... | 25 | +| 6.1.2.3.4 | 3gpp-Sbi-Etags ..... | 25 | +| 6.1.3 | Resources..... | 26 | +| 6.1.3.1 | Overview..... | 26 | +| 6.1.3.2 | SubscriptionData..... | 27 | +| 6.1.3.3 | PolicyData..... | 27 | +| 6.1.3.4 | StructuredDataForExposure..... | 27 | +| 6.1.3.5 | ApplicationData ..... | 27 | +| 6.1.3.6 | Resource: DataRestorationEvents..... | 27 | +| 6.1.3.6.1 | Description ..... | 27 | +| 6.1.3.6.2 | Resource Definition..... | 27 | +| 6.1.3.6.3 | Resource Standard Methods..... | 27 | +| 6.1.4 | Custom Operations without associated resources ..... | 28 | +| 6.1.5 | Notifications ..... | 28 | +| 6.1.5.1 | General..... | 28 | +| 6.1.5.2 | Data Change Notification ..... | 28 | +| 6.1.5.3 | Data Restoration Notification ..... | 28 | +| 6.1.5a | Data Model ..... | 30 | +| 6.1.5a.1 | General..... | 30 | +| 6.1.5a.2 | Structured data types..... | 30 | +| 6.1.5a.2.1 | Introduction ..... | 30 | +| 6.1.5a.2.2 | Type: DataRestorationNotification ..... | 31 | +| 6.1.6 | Error Handling ..... | 31 | +| 6.1.7 | Security..... | 32 | +| 6.1.8 | Feature negotiation ..... | 36 | +| 6.2 | Nudr_GroupIDmap Service API..... | 40 | +| 6.2.1 | API URI..... | 40 | +| 6.2.2 | Usage of HTTP..... | 40 | +| 6.2.2.1 | General..... | 40 | +| 6.2.2.2 | HTTP standard headers..... | 41 | +| 6.2.2.2.1 | General ..... | 41 | +| 6.2.2.2.2 | Content type ..... | 41 | +| 6.2.2.2.3 | Cache-Control ..... | 41 | +| 6.2.2.2.4 | ETag ..... | 41 | +| 6.2.2.2.5 | If-None-Match..... | 41 | +| 6.2.2.2.6 | Last-Modified..... | 41 | +| 6.2.2.2.7 | If-Modified-Since..... | 41 | +| 6.2.2.2.8 | When to Use Entity-Tags and Last-Modified Dates ..... | 41 | +| 6.2.2.3 | HTTP custom headers..... | 42 | +| 6.2.2.3.1 | General ..... | 42 | +| 6.2.3 | Resources..... | 42 | +| 6.2.3.1 | Overview..... | 42 | + +| | | | +|-------------------------------|----------------------------------------------------------------|-----------| +| 6.2.3.2 | Resource NfGroupIds ..... | 42 | +| 6.2.3.2.1 | Description ..... | 42 | +| 6.2.3.2.2 | Resource Definition..... | 42 | +| 6.2.3.2.3 | Resource Standard Methods..... | 43 | +| 6.2.3.3 | Resource RoutingIds..... | 43 | +| 6.2.3.3.1 | Description ..... | 43 | +| 6.2.3.3.2 | Resource Definition..... | 43 | +| 6.2.3.3.3 | Resource Standard Methods..... | 44 | +| 6.2.4 | Custom Operations without associated resources ..... | 44 | +| 6.2.5 | Notifications ..... | 44 | +| 6.2.6 | Data Model ..... | 44 | +| 6.2.6.1 | General..... | 44 | +| 6.2.6.2 | Structured data types..... | 45 | +| 6.2.6.2.1 | Introduction ..... | 45 | +| 6.2.6.2.2 | Type: NfGroupIdMapResult ..... | 45 | +| 6.2.6.2.3 | Type: RoutingIdResult..... | 45 | +| 6.2.6.3 | Simple data types and enumerations..... | 45 | +| 6.2.6.3.1 | Introduction ..... | 45 | +| 6.2.6.3.2 | Simple data types ..... | 45 | +| 6.2.7 | Error Handling ..... | 46 | +| 6.2.7.1 | General..... | 46 | +| 6.2.7.2 | Protocol Errors ..... | 46 | +| 6.2.7.3 | Application Errors..... | 46 | +| 6.2.8 | Security ..... | 46 | +| 6.2.9 | Feature Negotiation ..... | 46 | +| Annex A (normative): | OpenAPI specification ..... | 47 | +| A.1 | General..... | 47 | +| A.2 | Nudr_DataRepository API..... | 47 | +| A.3 | Nudr_GroupIDmap API..... | 54 | +| Annex B (Normative): | ABNF grammar for 3GPP SBI HTTP custom headers..... | 57 | +| B.1 | General..... | 57 | +| B.2 | ABNF definitions (Filename: "TS29504_CustomHeaders.abnf")..... | 57 | +| Annex C (informative): | Change history..... | 59 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and high level data model for the Nudr Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the Unified Data Repository (UDR). The data model and usage of the subscription data is specified in 3GPP TS 29.505 [2], and the data model and usage of the policy data, structured data for exposure and application data are specified in 3GPP TS 29.519 [3]. + +The 5G System architecture is specified in 3GPP TS 23.501 [4]. The stage 2 definition and related procedures for Nudr SBI service are specified in 3GPP TS 23.502 [5] and 3GPP TS 23.503 [6]. + +The Technical Realization of the Service Based Architecture is specified in 3GPP TS 29.500 [7] and the Principles and Guidelines for Services Definition is specified in 3GPP TS 29.501 [8]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 29.505: "5G System; Usage of the Unified Data Repository Services for Subscription Data; Stage 3". +- [3] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository Service for Policy Data, Structured Data for Exposure and Application Data; Stage 3". +- [4] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [5] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [6] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [7] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [8] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [9] IETF RFC 6901(April 2013): "JavaScript Object Notation (JSON) Pointer". +- [10] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [11] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". + +- [12] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [13] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [14] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [15] IETF RFC 9110: "HTTP Semantics ". +- [16] IETF RFC 9111: "HTTP Caching". +- [17] IETF RFC 9457: "Problem Details for HTTP APIs". +- [18] IETF RFC 7396: "JSON Merge Patch". +- [19] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [20] 3GPP TR 21.900: "Technical Specification Group working methods". +- [21] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", +- [22] IETF RFC 9113: "HTTP/2". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|----------------------------------------| +| GPSI | Generic Public Subscription Identifier | +| NEF | Network Exposure Function | +| PCF | Policy Control Function | +| SUPI | Subscription Permanent Identifier | +| UDM | Unified Data Management | +| UDR | Unified Data Repository | + +# --- 4 Overview + +The Unified Data Repository (UDR) is the network entity in the 5G Core Network (5GC) supporting the following functionalities: + +- Storage and retrieval of subscription data as specified in 3GPP TS 29.505 [2]; +- Storage and retrieval of policy data as specified in 3GPP TS 29.519 [3]; +- Storage and retrieval of structured data for exposure as specified in 3GPP TS 29.519 [3]; +- Storage and retrieval of application data (including Packet Flow Descriptions (PFDs) for application detection, application request information for multiple UEs) as specified in 3GPP TS 29.519 [3]; +- Subscription to notification and the notification of subscribed data changes. +- Storage and retrieval of NF-Group Id mapping data. + +Figures 4-1 shows the data storage architecture for the 5GC: + +![Figure 4-1: Data storage architecture diagram showing network functions (UDM, PCF, NEF, NRF, SCP) connected to a Unified Data Repository (UDR) via the Nudr interface. The UDR contains Subscription Data, Policy Data, Structured Data for exposure, Application Data, and Group ID mapping data.](7a0db9703b68b3d06cdaeefc084c0006_img.jpg) + +The diagram illustrates the data storage architecture for the 5GC. On the left, five network functions (UDM, PCF, NEF, NRF, and SCP) are shown in a vertical stack. The UDM, PCF, NEF, and NRF are connected to a central vertical bus labeled 'Nudr' via interfaces N35, N36, N37, and an unlabeled interface respectively. The SCP is also connected to this bus. The 'Nudr' bus is connected to a large box labeled 'UDR' (Unified Data Repository) on the right. Inside the UDR box, there is a cylinder representing a database, which contains the following data types: Subscription Data, Policy Data, Structured Data for exposure, Application Data, and Group ID mapping data. + +Figure 4-1: Data storage architecture diagram showing network functions (UDM, PCF, NEF, NRF, SCP) connected to a Unified Data Repository (UDR) via the Nudr interface. The UDR contains Subscription Data, Policy Data, Structured Data for exposure, Application Data, and Group ID mapping data. + +**Figure 4-1: Data storage architecture** + +The Nudr interface is used by the network functions (i.e. UDM, PCF, NEF and NRF) to access a particular set of the data stored in the UDR. + +NOTE: Services offered by the UDR via the Nudr service-based interface can also be consumed by the HSS as specified in 3GPP TS 23.632 clause 5.2.4. + +# 5 Services offered by the UDR + +## 5.1 Introduction + +The UDR offers the following services via the Nudr interface: + +- Nudr\_DataRepository Service + +NOTE: This service corresponds to the Nudr\_DataManagement service in 3GPP TS 23.501 [4], 3GPP TS 23.502 [5] and 3GPP TS 23.503 [6]. + +- Nudr\_GroupIDmap Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------|--------|-----------------------------------------------------------|------------------------------|-------------------|-------| +| Nudr_DataRepository | 6.1 | Unified Data Repository Service | TS29504_Nudr_DR.yaml | nudr-dr | A.2 | +| Nudr_GroupIDmap | 6.2 | Unified Data Repository Service for NF-Group ID retrieval | TS29504_Nudr_GroupIDmap.yaml | nudr-group-id-map | A.3 | + +## 5.2 Nudr\_DataRepository Service + +### 5.2.1 Service Description + +#### 5.2.1.1 Service and operation description + +The UDR is acting as NF Service Producer. It provides Unified Data Repository service to the NF service consumer. The known NF Service Consumers are the UDM, PCF and NEF. + +For the Nudr\_DataRepository service, the following service operations are defined: + +- Query +- Create +- Delete +- Update +- Subscribe +- Unsubscribe +- Notify +- DataRestorationNotification + +This service allows NF service consumers to retrieve, create, update, modify and delete data stored in the UDR. + +This service allows the NF service consumers to subscribe/unsubscribe the data change notification and to be notified of the data change. + +This service allows the NF service consumers to be notified upon the UDR restoration. + +#### 5.2.1.2 Service operation and data access authorization + +UDR provides one Nudr\_DataRepository service to all of the NF consumers, while different types of data may have different data access authorizations, the UDR shall be able to have the authorization management mechanism to guarantee the safety of data access. + +And the information in the Nudr\_DataRepository service operation should be able to identify the NF type of the consumer and the service operation type or name, and to indicate the requested data information including the data set and data subset, and the resource/data identifier. All HTTP methods for the service operation shall include the information in the appropriate place of the HTTP message. + +If there is an illegal service operation or data access request initiated by a NF consumer, the service failure response should be returned through the Nudr interface with an explicit cause value. + +NOTE: For allowed service operations or data access requests initiated by an NF consumer it is not expected (unless explicitly specified otherwise) that the UDR performs any consumer-specific application logic to check whether a requested service operation should be rejected. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +This clause specifies the generic Nudr\_DataRepository service operations towards the different data sets as shown in Figure 4-1. + +The HTTP request of the service operations contains a resource URI where the {apiSpecificResourceUriPart} (see clause 4.4.2 in 3GPP TS 29.501 [8]) consists of a top-level segment and sub-level segment(s), followed by query parameters (optional or required). + +If multiple query parameters are defined for a method on the resource, the default logical relationship between the different query parameters shall be the logical "AND", unless explicitly indicated on each specific resource and operation on the Nudr\_DataRepository API. + +NOTE: Not all query parameters imply necessarily a logical relationship with other parameters (e.g. "supported-features"); whether or not such logical relationship exists, is determined by the semantics of the different query parameters in each resource and operation. + +For Create, Query, Update and Delete operations, the top-level segment indicates one top level resource representing one of the data sets, which are defined as "/subscription-data", "/policy-data", "/exposure-data" and "/application-data" in Figure 6.1.3.1-1. And a certain child resource is indicated by of the end URI of the sub-level segments, which are defined in 3GPP TS 29.505 [2] for use when the top-level segment is "/subscription-data" and in 3GPP TS 29.519 [3] for use when the top-level segment is "/policy-data", "/exposure-data" or "/application-data". + +For Subscribe/Unsubscribe to data change notification operations, the resource of the subscription to the notification should be as the child resource of each of the data sets (i.e. "/subscription-data", "/policy-data", "/exposure-data" and "/application-data"), which are indicated by the top-level segment in the URI. And the resource representation of the subscription to the notification should be indicated by the sub-level segment of each data set. + +The following procedures for each operation should be taken as the common procedures and applicable to corresponding detail procedures with the same service operation in 3GPP TS 29.505 [2] and 3GPP TS 29.519 [3]. + +#### 5.2.2.2 Query + +##### 5.2.2.2.1 General + +The Query service operation is used to retrieve the data stored in the UDR. HTTP GET method shall be used for the service operation to request the certain data record(s). One piece of data records should be a data set, a data subset, a group of data in one data subset, or a specific data. If the data record(s) are the attribute(s), query parameter or the combination of query parameters should be used as the filters to control the content of result. + +##### 5.2.2.2.2 Data retrieval + +Figure 5.2.2.2.2-1 shows a scenario where the NF service consumer (e.g. UDM, PCF or NEF) sends a request to the UDR to retrieve data. + +Query parameters may be used for data retrieval: + +- i) Clause 5.2.2.2.3 specifies the query parameter used for retrieving subset of a resource; +- ii) Other query parameters are defined in 3GPP TS 29.505 [2] and 3GPP TS 29.519 [3]. + +![Sequence diagram showing the interaction between an NF service consumer and a UDR for retrieving data. The consumer sends a GET request to the UDR, and the UDR responds with a 200 OK containing the requested data.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant UDR + Note left of NF service consumer: 1. GET ...? + NF service consumer->>UDR: Request + Note right of UDR: 2. 200 OK (Requested Data) + UDR-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDR for retrieving data. The consumer sends a GET request to the UDR, and the UDR responds with a 200 OK containing the requested data. + +**Figure 5.2.2.2.2-1: Retrieving Data** + +1. The NF service consumer shall send a GET request to the resource representing the data. Query parameters may be used to restrict the response to the requested data record(s) of the resource's representation. Query parameters may also indicate the features that the NF service consumer supports as described in clause 6.6.2 of 3GPP TS 29.500 [7]. +2. On success, the UDR shall respond with "200 OK" with the message body containing the requested data record(s) restricted to the query parameters. (and thus also to the indicated features supported by the NF service consumer). + +On failure, the UDR shall return an appropriated error code with the error cause information. + +The error codes of corresponding service operations in 3GPP TS 29.505 [2] and 3GPP TS 29.519 [3] shall align and comply with the failure response mechanism which is defined in 3GPP TS 29.500 [7]. + +##### 5.2.2.2.3 Retrieval of subset of a resource + +When a resource has multiple attributes, it is allowed for the NFs to retrieve a subset of the attributes. When the attribute is of type map, it is allowed for the NFs to retrieve individual member(s) of that map. For retrieval of subset of a resource, a new query parameter "fields" is defined to carry the identities of the attributes to be retrieved. The definition of "fields" query parameter is: + +- 1) "fields" query parameter is of type array; and +- 2) each element of the array is of type string encoded as a JSON pointer as defined IETF RFC 6901 [9]. + +NOTE: identifying an individual element in the array is supported by JSON pointer, however it is not recommended to use this feature if the client is not exactly aware of the order of the members in the array. + +If retrieval of subset of a particular resource is supported, then all the attributes of the corresponding data type of that resource shall be optional or conditional. + +###### EXAMPLE 1: + +Given the following representation of ExResource: + +``` + +{ + "lv1Attr1": "value1" + "lv1Attr2": "value2" + "lv1Attr3": { + "lv2Attr1": "value3" + "lv2Attr2": "value4" + } +} + +``` + +To retrieve "lv1Attr1" and "lv2Attr2", the NF sends the following request: + +GET /ExResource?fields=/lv1Attr1, /lv1Attr3/lv2Attr2 + +Upon success, the UDR then returns the following representation: + +``` +{ + "lv1Attr1": "value1" + "lv1Attr3": { + "lv2Attr2": "value4" + } +} +``` + +###### EXAMPLE 2: + +Given the following representation of ExResource: + +``` +{ + "Attr1": "value1" + "Attr2": "value2" + "AttrMap": { + "Key1": {ExObject1} + "Key2": {ExObject2} + } +} +``` + +To retrieve "Attr1" and the second member of "AttrMap ", the NF sends the following request: + +GET /ExResource?fields=/Attr1, /AttrMap/Key2 + +Upon success, the UDR then returns the following representation: + +``` +{ + "Attr1": "value1" + "AttrMap": { + "Key2": {ExObject2} + } +} +``` + +#### 5.2.2.3 Create + +##### 5.2.2.3.1 General + +The Create service operation is used by the NF service consumer (e.g. NEF) to create the data into the UDR. + +The following procedures using the Create service operation are supported: + +- Data creation using PUT +- Data creation using POST + +##### 5.2.2.3.2 Data Creation using PUT + +Figure 5.2.2.3.2-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDR to create data. The parent resource of the resource identified by the resource URI shall be of archetype Store (see clause C.3 in 3GPP TS 29.501 [8]). + +![Sequence diagram for Data Creation using PUT](1b5a812c8aa20fd5cba28e97001d32de_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDR + Note left of NF service consumer: 1. PUT ... (new data) + NF service consumer->>UDR: 1. PUT ... (new data) + Note right of UDR: 2. 201 Created + UDR-->>NF service consumer: 2. 201 Created +``` + +The diagram illustrates the interaction for data creation using PUT. It features two lifelines: 'NF service consumer' on the left and 'UDR' on the right. The first message is a PUT request from the consumer to the UDR, labeled '1. PUT ... (new data)'. The second message is a '201 Created' response from the UDR back to the consumer, labeled '2. 201 Created'. + +Sequence diagram for Data Creation using PUT + +**Figure 5.2.2.3.2-1: Creating Data using PUT** + +1. The NF service consumer shall send a PUT request to the resource representing the data. The content of the PUT request shall contain the representation of the new data. +2. On success, the UDR shall respond with "201 Created" with the content containing the representation of the created data, and the "Location" header shall be present and contains the URI of the created data. + +On failure, the UDR shall return an appropriated error code with the error cause information. + +##### 5.2.2.3.3 Data Creation using POST + +Figure 5.2.2.3.3-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDR to create data. The resource identified by the resource URI shall be of archetype Collection (see clause C.2 in 3GPP TS 29.501 [8]). + +![Sequence diagram for Data Creation using POST](66c2bf11a8f117cddf67eff92d4c736c_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDR + Note left of NF service consumer: 1. POST... (new data) + NF service consumer->>UDR: 1. POST... (new data) + Note right of UDR: 2. 201 Created + UDR-->>NF service consumer: 2. 201 Created +``` + +The diagram illustrates the interaction for data creation using POST. It features two lifelines: 'NF service consumer' on the left and 'UDR' on the right. The first message is a POST request from the consumer to the UDR, labeled '1. POST... (new data)'. The second message is a '201 Created' response from the UDR back to the consumer, labeled '2. 201 Created'. + +Sequence diagram for Data Creation using POST + +**Figure 5.2.2.3.3-1: Creating Data using POST** + +1. The NF service consumer shall send a POST request to create the new data record as the child resource of the parent resource in the UDR. The content of the POST request shall contain the representation of the new data. +2. The UDR generates the data identifier and constructs the URI for the created data record by appending the data identifier to the parent resource URI received as request URI of the POST request. + +On success, the UDR shall respond with "201 Created" with the content containing the representation of the created data, and the "Location" header shall be present and contains the URI of the created data. + +On failure, the UDR shall return an appropriated error code with the error cause information. + +#### 5.2.2.4 Delete + +##### 5.2.2.4.1 General + +The Delete service operation is used by the NF service consumer (e.g. NEF) to remove the data from the UDR. + +The following procedures using the Delete service operation are supported: + +- Data Deletion + +HTTP DELETE method shall be used. + +##### 5.2.2.4.2 Deleting Data + +Figure 5.2.2.4.2-1 shows a scenario where the NF service consumer (e.g. NEF) sends a request to the UDR to delete a data record. + +![Sequence diagram showing the interaction between an NF service consumer and a UDR for deleting data. The consumer sends a DELETE request with top-level and sub-level segments, and the UDR responds with a 204 No Content status.](3f1987804d7d78bc3b3bc560e974280a_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UDR as UDR + Note right of NF: 1. DELETE ...() + NF->>UDR: Request + Note left of UDR: 2. 204 No Content() + UDR-->>NF: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and a UDR for deleting data. The consumer sends a DELETE request with top-level and sub-level segments, and the UDR responds with a 204 No Content status. + +Figure 5.2.2.4.2-1: Deleting Data + +1. The NF service consumer shall send a DELETE request to the resource representing the data. The content of the request shall be empty. +2. On success, the UDR shall respond with "204 No Content", the content of the DELETE response shall be empty. + +On failure, the UDR shall return an appropriated error code with the error cause information. + +#### 5.2.2.5 Update + +##### 5.2.2.5.1 General + +The Update service operation is used by the NF service consumer (e.g. UDM, PCF or NEF) to update the data stored in the UDR. + +The following procedures using the Update service operation are supported: + +- Data Update using PATCH +- Data Update using PUT + +HTTP PATCH method shall be used to add/create, delete or modify part of the value(s) in the data record (e.g. a specific data or a group of data in one data subset). HTTP PUT method shall be used to replace a complete data record. + +##### 5.2.2.5.2 Data Update using PATCH + +Figure 5.2.2.5.2-1 shows a scenario where the NF service consumer (e.g. UDM, PCF or NEF) sends a request to the UDR to update some parts of the data record. + +![Sequence diagram for Figure 5.2.2.5.2-1: Data Updating using PATCH. The diagram shows two lifelines: 'NF service consumer' and 'UDR'. Step 1: The NF service consumer sends a '1. PATCH... (Modification instruction)' request to the UDR. Step 2: The UDR responds with '2. 204 No Content ()'.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant UDR as UDR + Note left of NF: 1. PATCH... (Modification instruction) + NF->>UDR: 1. PATCH... (Modification instruction) + Note right of UDR: 2. 204 No Content () + UDR-->>NF: 2. 204 No Content () + +``` + +Sequence diagram for Figure 5.2.2.5.2-1: Data Updating using PATCH. The diagram shows two lifelines: 'NF service consumer' and 'UDR'. Step 1: The NF service consumer sends a '1. PATCH... (Modification instruction)' request to the UDR. Step 2: The UDR responds with '2. 204 No Content ()'. + +**Figure 5.2.2.5.2-1: Data Updating using PATCH** + +1. The NF service consumer shall send a PATCH request to the resource representing the data record. The content contains the modification instruction towards the data record. +2. On success, the UDR shall respond with "204 No Content". + +On failure, the UDR shall return an appropriated error code with the error cause information. + +##### 5.2.2.5.3 Data Update using PUT + +Figure 5.2.2.5.3-1 shows a scenario where the NF service consumer (e.g. UDM, PCF or NEF) sends a request to the UDR to update the whole data record. + +![Sequence diagram for Figure 5.2.2.5.3-1: Data Updating using PUT. The diagram shows two lifelines: 'NF service consumer' and 'UDR'. Step 1: The NF service consumer sends a '1. PUT... (replacement with new data )' request to the UDR. Step 2: The UDR responds with '2. 204 No Content () Or 200 OK'.](6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant UDR as UDR + Note left of NF: 1. PUT... (replacement with new data ) + NF->>UDR: 1. PUT... (replacement with new data ) + Note right of UDR: 2. 204 No Content () Or 200 OK + UDR-->>NF: 2. 204 No Content () Or 200 OK + +``` + +Sequence diagram for Figure 5.2.2.5.3-1: Data Updating using PUT. The diagram shows two lifelines: 'NF service consumer' and 'UDR'. Step 1: The NF service consumer sends a '1. PUT... (replacement with new data )' request to the UDR. Step 2: The UDR responds with '2. 204 No Content () Or 200 OK'. + +**Figure 5.2.2.5.3-1: Data Updating using PUT** + +1. The NF service consumer shall send a PUT request to the resource representing the data record. The content contains the new data for the resource. +2. On success, the UDR shall respond with "204 No Content" or "200 OK". + +On failure, the UDR shall return an appropriated error code with the error cause information. + +#### 5.2.2.6 Subscribe + +##### 5.2.2.6.1 General + +The Subscribe service operation is used for the NF service consumer to explicitly subscribe to the data change notification from the UDR. + +Permanent Subscription Data i.e. sub-resources of the ProvisionedData resource (see 3GPP TS 29.505 [2]) can be modified only by means of provisioning at the UDR and may be (as a deployment option) implicitly subscribed by the UDM as described in 3GPP TS 29.501 [8] clause 4.6.2.2.1. If so and when a data modification of permanent subscription data occurs by means of provisioning and there is the need to notify at least one serving node (e.g. AMF, SMF, SMSF), the UDR shall select one of the suitable and available UDMs (as discovered via the NRF) and send a notification using the callback URI provided by the NRF during UDM discovery. + +##### 5.2.2.6.2 NF service consumer subscribes to notifications to UDR + +Figure 5.2.2.6.2-1 shows a scenario where the NF service consumer (e.g. UDM, PCF or NEF) sends a request to the UDR to subscribe to data change notifications. + +![Sequence diagram showing the interaction between an NF service consumer and a UDR for subscribing to data change notifications.](33a8f3f01dfa8bce75d23017855a13c5_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDR + Note left of NF service consumer: + NF service consumer->>UDR: 1. POST.../subs-to-notif (SubData) + Note right of UDR: + UDR-->>NF service consumer: 2. 201 Created (SubData) +``` + +The diagram illustrates a sequence of two messages between an 'NF service consumer' and a 'UDR'. The first message, labeled '1. POST.../subs-to-notif (SubData)', is sent from the NF service consumer to the UDR. The second message, labeled '2. 201 Created (SubData)', is sent from the UDR back to the NF service consumer. + +Sequence diagram showing the interaction between an NF service consumer and a UDR for subscribing to data change notifications. + +**Figure 5.2.2.6.2-1: subscribing to data change notifications** + +1. The NF service consumer sends a POST request to the parent resource (.../subs-to-notif). The NF service consumer describes the notifications it wants to receive, and it also indicates the features it supports (see clause 6.6.2 of 3GPP TS 29.500 [7]). The request may contain an expiry time, suggested by the NF Service Consumer as a hint, representing the time upto which the subscription is desired to be kept active. +2. On success, the UDR responds with "201 Created" with the message body containing a representation of the created subscription and indicating the supported features (see clause 6.6.2 of 3GPP TS 29.500 [7]). The Location HTTP header shall contain the URI of the created subscription. In subsequent notifications according to clause 5.2.2.8.2, the UDR only uses the indicated supported features. + +The response based on operator policies and taking into account the expiry time included in the request, may contain an expiry time (i.e a future timestamp), as determined by the UDR, after which the subscription becomes invalid. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the UDR. The UDR shall not provide the same expiry time (i.e a future timestamp) for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +On failure, the UDR returns an appropriated error code with the error cause information. + +Once the subscription has been created, an NF Service Consumer may request the update of the subscription in UDR (e.g., to request an extension of the subscription lifetime before the subscription expires) by issuing a PUT or PATCH request, as described in 3GPP TS 29.501 [8], clause 4.6.2.2.3. + +##### 5.2.2.6.3 Stateless UDM subscribes to notifications to UDR + +Figure 5.2.2.6.3-1 shows a scenario where the stateless UDM subscribes to notification to the UDR. + +![Sequence diagram showing the interaction between a Stateless UDM and a UDR for subscribing to data change notifications. The Stateless UDM sends a POST request to the UDR, and the UDR responds with a 201 Created status.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` + +sequenceDiagram + participant Stateless UDM + participant UDR + Note left of Stateless UDM: Subscribe to data change notifications + Stateless UDM->>UDR: 1. POST .../subs-to-notif (SubData) + UDR-->>Stateless UDM: 2. 201 Created (SubData) + +``` + +Sequence diagram showing the interaction between a Stateless UDM and a UDR for subscribing to data change notifications. The Stateless UDM sends a POST request to the UDR, and the UDR responds with a 201 Created status. + +**Figure 5.2.2.6.3-1: subscribing to data change notifications via stateless UDM** + +1. The stateless UDM sends a POST request to the UDR to subscribe to the notifications. + +The SubData in the POST request body shall indicate the same data for which a change will trigger a notification. + +The SubData in the POST request body shall contain a callbackReference URI to which the notifications will be sent to. The host part of the callbackReference URI shall be set to the FQDN of the UDM set to which the stateless UDM belongs. + +The SubData in the POST request body shall contain an original callbackReference URI of the NF which initially triggers the subscription. + +The request may contain an expiry time, suggested by the NF Service Consumer as a hint, representing the time upto which the subscription is desired to be kept active. + +2. On success, the UDR responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription and that URI shall contain the subscription ID allocated by the UDR. + +The response based on operator policies and taking into account the expiry time included in the request, may contain an expiry time (i.e a future timestamp), as determined by the UDR, after which the subscription becomes invalid. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the UDR. The UDR shall not provide the same expiry time (i.e a future timestamp) for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +On failure, the UDR returns an appropriated error code with the error cause information. + +Once the subscription has been created, the stateless UDM may request the update of the subscription in UDR (e.g., to request an extension of the subscription lifetime before the subscription expires) by issuing a PUT or PATCH request, as described in 3GPP TS 29.501 [8], clause 4.6.2.2.3. + +#### 5.2.2.7 Unsubscribe + +##### 5.2.2.7.1 General + +The Unsubscribe service operation is used for the NF service consumer to unsubscribe to the data change notification from the UDR. + +##### 5.2.2.7.2 Unsubscribe service operation + +Figure 5.2.2.7.2-1 shows a scenario where the NF service consumer (e.g. UDM, PCF or NEF) sends a request to the UDR to unsubscribe to data change notifications. + +![Sequence diagram for Unsubscribing to the data change notifications](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDR + Note left of NF service consumer: 1. DELETE .../subs-to-notif/ + NF service consumer->>UDR: 1. DELETE .../subs-to-notif/ + UDR-->>NF service consumer: 2. 204 No Content +``` + +The diagram illustrates the interaction for unsubscribing to data change notifications. It features two lifelines: 'NF service consumer' on the left and 'UDR' on the right. The sequence begins with the NF service consumer sending a 'DELETE' request to the UDR, labeled as step 1. The request URI is shown as '/subs-to-notif/'. The UDR responds with a '204 No Content' status, labeled as step 2. + +Sequence diagram for Unsubscribing to the data change notifications + +**Figure 5.2.2.7.2-1: Unsubscribing to the data change notifications** + +1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation, i.e. in the Location header field of the HTTP 201 Created response. +2. On success, the UDR responds with "204 No Content". + +On failure, the UDR returns an appropriated error code with the error cause information. + +#### 5.2.2.8 Notify + +##### 5.2.2.8.1 General + +The Notify service operation is used for the UDR to notify the data change notification to the previous subscribe operation requestor. + +##### 5.2.2.8.2 Notification to NF service consumer on data change + +Figure 5.2.2.8.2-1 shows a scenario where the UDR notifies the NF service consumer about the subscribed data change. The request contains the CallbackReference URI as previously received in the subscribe operation (see clause 5.2.2.6). + +![Sequence diagram for Data Change Notification](f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDR + Note right of UDR: 1. POST {callbackReference} (Notification) + UDR->>NF service consumer: 1. POST {callbackReference} (Notification) + NF service consumer-->>UDR: 2. 204 No Content +``` + +The diagram illustrates the data change notification process. It features two lifelines: 'NF service consumer' on the left and 'UDR' on the right. The sequence begins with the UDR sending a 'POST' request to the NF service consumer, labeled as step 1. The request is identified as '{callbackReference} (Notification)'. The NF service consumer responds with a '204 No Content' status, labeled as step 2. + +Sequence diagram for Data Change Notification + +**Figure 5.2.2.8.2-1: Data Change Notification** + +1. The UDR sends a POST request to the callbackReference URI as provided by the NF service consumer in the subscribe operation. +2. On success, the NF service consumer responds with "204 No Content". + +On failure, the NF service consumer responds an appropriated error code with the error cause information. + +##### 5.2.2.8.3 Notification to stateless UDM on data change + +Figure 5.2.2.8.3-1 shows a scenario where the UDR notifies the NF service consumer about the subscribed data change. + +![Sequence diagram showing Data Change Notification to stateless UDM. The diagram shows two lifelines: Stateless UDM and UDR. Step 1: UDR sends a POST {callback Reference} (notification) to Stateless UDM. Step 2: Stateless UDM responds with 204 No Content to UDR.](81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg) + +``` +sequenceDiagram + participant UDR + participant UDM as Stateless UDM + Note left of UDM: 1. POST {callback Reference} (notification) + UDR->>UDM: 1. POST {callback Reference} (notification) + Note right of UDM: 2. 204 No Content + UDM-->>UDR: 2. 204 No Content +``` + +Sequence diagram showing Data Change Notification to stateless UDM. The diagram shows two lifelines: Stateless UDM and UDR. Step 1: UDR sends a POST {callback Reference} (notification) to Stateless UDM. Step 2: Stateless UDM responds with 204 No Content to UDR. + +**Figure 5.2.2.8.3-1: Data Change Notification to stateless UDM** + +1. The UDR sends a POST request to the callbackReference URI as provided by the stateless UDM in the subscribe operation. + +The notification in the POST request body shall contain the original callbackReference URI which is received in step 1 of Figure 5.2.2.6.3-1. + +When the notification in the POST request body includes one or more arrays, the UDR shall use the complete replacement representation of the arrays, see 3GPP TS29.501 [4], Annex E. + +When the notification in the POST request body includes one or more arrays where all the array elements have been removed, the UDR shall include the original array representation, i.e. in the origValue attribute of the ChangeItem. + +2. On success, the stateless UDM responds with "204 No Content". + +On failure, the stateless UDM responds an appropriated error code with the error cause information. + +#### 5.2.2.9 DataRestorationNotification + +##### 5.2.2.9.1 General + +The DataRestorationNotification service operation is used for the UDR to send notifications on UDR restoration event to one or a set of NFs which are subject to the data restoration procedure. + +##### 5.2.2.9.2 Notification on Data Restoration + +The notification on data restoration may be based on implicit subscription to data restoration event. When the NF service consumer (e.g. UDM) access UDR (i.e. to access the data stored in the UDR) for the first time, the UDR shall identify the identity of the NF service consumer via the NF instance ID contained in the 3gpp-Sbi-NF-Peer-Info header field of the request, then the UDR may create a default subscription on data restoration for that NF service consumer accordingly. + +Figure 5.2.2.9.2-1 shows a scenario where the UDR notifies the NF service consumer about the need to restore data due to a potential data-loss event occurred at the UDR. The dataRestorationCallbackUri contained in the request is the default callback URI as discovered from NRF. + +![Sequence diagram for Data Restoration Notification. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDR' on the right. Step 1: An arrow points from the UDR to the NF service consumer with the text '1. POST {dataRestorationCallbackUri} (Notification)'. Step 2: An arrow points from the NF service consumer to the UDR with the text '2. 204 No Content'.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +Sequence diagram for Data Restoration Notification. The diagram shows two lifelines: 'NF service consumer' on the left and 'UDR' on the right. Step 1: An arrow points from the UDR to the NF service consumer with the text '1. POST {dataRestorationCallbackUri} (Notification)'. Step 2: An arrow points from the NF service consumer to the UDR with the text '2. 204 No Content'. + +**Figure 5.2.2.9.2-1: Data Restoration Notification** + +1. The UDR sends a POST request to the dataRestorationCallbackUri as discovered from NRF. +2. On success, the NF service consumer responds with "204 No Content". + +On failure, the NF service consumer responds an appropriated error code with the error cause information. + +## 5.3 Nudr\_GroupIDmap Service + +### 5.3.1 Service Description + +#### 5.3.1.1 Service and operation description + +The Nudr\_GroupIDmap service may be used by NF service consumers (e.g. NRF or SCP) to retrieve the NF Group ID for a given NF type and subscriber identifier (or information related to a set of subscribers served by a same NF Group ID, such as the Routing Indicator); see 3GPP TS 23.501 [4] and 3GPP TS 23.502 [5]. + +It may also be used to retrieve the list of Routing Indicators served by a given NF Group. + +For the Nudr\_GroupIDmap service, the following service operations are defined: + +- Query + +This service allows NF service consumers to retrieve, NF GroupID data stored in the UDR. + +- QueryRID + +This service allows NF service consumers to retrieve Routing Indicator data stored in the UDR. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operations defined for the Nudr\_GroupIDmap service are as follows: + +- Query: It allows an NF consumer (e.g. NRF) to retrieve the NF Group ID for a given NF type and subscriber-related information. + +#### 5.3.2.2 Query + +##### 5.3.2.2.1 General + +The following procedure using the Query service operation is supported: + +- NF-Group ID Retrieval + +##### 5.3.2.2.2 NF Group ID retrieval + +Figure 5.3.2.2.2-1 shows a scenario where the NF service consumer (e.g. NRF) sends a request to the UDR to retrieve the NF Group ID. + +![Sequence diagram for NF Group ID retrieval](7d3d5fb5d09c0cd35a9d637be241651e_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDR + Note left of NF service consumer: 1. GET .../nf-group-id?nf-type=, subscriber-id= + NF service consumer->>UDR: Request + Note right of UDR: 2. 200 OK (NfGroupIdMapResult) + UDR-->>NF service consumer: Response +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDR. The NF service consumer sends a GET request to the UDR with the path .../nf-group-id and query parameters nf-type= and subscriber-id=. The UDR responds with a 200 OK status and a message body containing the NfGroupIdMapResult. + +Sequence diagram for NF Group ID retrieval + +Figure 5.3.2.2.2-1: Retrieving NF Group ID + +1. The NF service consumer shall send a GET request to the resource representing the data. Query parameters shall be used to identify the NF type (e.g. UDM) of the requested NF Group ID (e.g. UDM Group ID) and the subscriber-id, or information related to a set of subscribers. + 2. On success, the UDR shall respond with "200 OK" with the message body containing the requested data +- On failure, the UDR shall return an appropriated error code with the error cause information. + +#### 5.3.2.3 QueryRID + +##### 5.3.2.3.1 General + +The following procedure using the QueryRID service operation is supported: + +- Routing IDs Retrieval + +##### 5.3.2.3.2 Routing IDs retrieval + +Figure 5.3.2.x.2-1 shows a scenario where the NF service consumer (e.g. NRF) sends a request to the UDR to retrieve the Routing Indicators served by a given NF Group (identified by its NF type and its NF Group ID). + +![Sequence diagram for Routing IDs retrieval](db7cb51aac8519daab50e2171cecae82_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UDR + Note left of NF service consumer: 1. GET .../routing-ids?nf-type=, nf-group-id= + NF service consumer->>UDR: Request + Note right of UDR: 2. 200 OK (RoutingIdResult) + UDR-->>NF service consumer: Response +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a UDR. The NF service consumer sends a GET request to the UDR with the path .../routing-ids and query parameters nf-type= and nf-group-id=. The UDR responds with a 200 OK status and a message body containing the RoutingIdResult. + +Sequence diagram for Routing IDs retrieval + +Figure 5.3.2.3.2-1: Retrieving Routing Ids + +1. The NF service consumer shall send a GET request to the resource representing the data. Query parameters shall be used to identify the NF type (e.g. UDM) and the NF Group ID (e.g. UDM Group ID). +2. On success, the UDR shall respond with "200 OK" with the message body containing the requested data. + +On failure, the UDR shall return an appropriated error code with the error cause information. + +# --- 6 API Definitions + +## 6.1 Nudr\_DataRepository Service API + +### 6.1.1 API URI + +The Nudr-dr shall use the Nudr-dr API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [8], i.e.: + +**{apiRoot}
//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [8]. +- The shall be "nudr-dr". +- The shall be "v2". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +Nudr service shall comply with the usage of HTTP/2.0 protocol over Service Based Interfaces. (See Clause 5, 3GPP TS 29.500[7]). + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported on Nudr interface as defined in clause 5.2.2 of 3GPP TS 29.500 [7]. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [11], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [7]. +- The Problem Details JSON Object (IETF RFC 9457 [17]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". +- JSON Merge Patch (IETF RFC 7396 [18]). The use of the JSON Merge Patch format in a HTTP request body shall be signalled by the content type "application/merge-patch+json". +- JSON Patch (IETF RFC 6902 [19]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". + +##### 6.1.2.2.3 Cache-Control + +As described in IETF RFC 9111 [16] clause 5.2, a "Cache-Control" header should be included in HTTP responses carrying a representation of cacheable resources (e.g. SessionManagementSubscriptionData). If it is included, it shall contain a "max-age" value, indicating the amount of time in seconds after which the received response is considered stale. + +The "max-age" value shall be configurable by operator policy. + +##### 6.1.2.2.4 ETag + +As described in IETF RFC 9110 [15] clause 8.8.3, an "ETag" (entity-tag) header should be included in HTTP responses carrying a representation of cacheable resources (e.g. AccessAndMobilitySubscriptionData) or modifiable resources (e.g. Amf3GppAccessRegistration) to allow an NF Service Consumer performing a conditional GET request with "If-None-Match" header or a conditional POST / PUT / PATCH / DELETE request with "If-Match" header. If it is included, it shall contain a server-generated strong validator, that allows further matching of this value (included in subsequent client requests) with a given resource representation stored in the server or in a cache. + +##### 6.1.2.2.5 If-None-Match + +As described in IETF RFC 9110 [15] clause 13.1.2, an NF Service Consumer may issue conditional GET request towards UDR by including an "If-None-Match" header in HTTP requests containing one or several entity tags received in previous responses for the same resource. + +##### 6.1.2.2.5a If-Match + +As described in IETF RFC 9110 [15] clause 13.1.1, an NF Service Consumer may issue conditional POST / PUT / PATCH / DELETE request towards UDR by including an "If-Match" header in HTTP requests containing an entity tag received in previous responses for the same resource. + +##### 6.1.2.2.6 Last-Modified + +As described in IETF RFC 9110 [15] clause 13.1.3, a "Last-Modified" header should be included in HTTP responses carrying a representation of cacheable resources (e.g. SmfSelectionSubscriptionData) to allow an NF Service Consumer performing a conditional request with "If-Modified-Since" header. + +##### 6.1.2.2.7 If-Modified-Since + +As described in IETF RFC 7232 [15] clause 3.3, an NF Service Consumer may issue conditional GET request towards UDR, by including an "If-Modified-Since" header in HTTP requests. + +##### 6.1.2.2.8 When to Use Entity-Tags and Last-Modified Dates + +Both "ETag" and "Last-Modified" headers should be sent in the same HTTP response as stated in IETF RFC 9110 [15] clause 15.3.1. + +NOTE: "ETag" is a stronger validator than "Last-Modified" and is preferred. + +If the UDR included an "ETag" header with the resource then a conditional GET request for this resource shall be performed with the "If-None-Match" header, and a POST / PUT / PATCH / DELETE request for this resource shall be performed with the "If-Match" header. + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +The custom HTTP headers applicable to Nudr service are specified in the following clauses. + +##### 6.1.2.3.2 3gpp-Sbi-Message-Priority + +Nudr interface shall support 3gpp-Sbi-Message-Priority custom header. The header contains the HTTP/2 message priority value. See details in Clause 5.2.3.2.2 of 3GPP TS 29.500 [7]. + +##### 6.1.2.3.3 3gpp-Sbi-Notification-Correlation + +The 3gpp-Sbi-Notification-Correlation header field is used by a NF in a UDR resource create/update/delete request to indicate the subscription context(s) whose notification needs to be disabled when triggered as consequence of a request including this header. Subsequent create/update/delete requests that do not include the 3gpp-Sbi-Notification-Correlation header trigger the corresponding notifications as per currently defined procedures. + +This header contains subscription identifier(s), as provided by the UDR during the subscribe operation. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [15]. + +``` +Sbi-Notification-Correlation-Header = "3gpp-Sbi-Notification-Correlation:" OWS subscriptionId *(OWS +"," OWS subscriptionId ) OWS + +subscriptionId = token +``` + +See clause 5.6.2 of IETF RFC 9110 [15] for the "token" definition. + +EXAMPLE: 3gpp-Sbi-Notification-Correlation: subsid123, subsid345. + +##### 6.1.2.3.4 3gpp-Sbi-Etags + +The 3gpp-Sbi-Etags header field is used by the UDR in 200 OK responses to GET requests for multiple data set retrieval, allowing to convey one Etag per retrieved data set. The consumer may make use of a received Etag for a given data set in If-Match/If-None-Match headers of subsequent requests individually accessing the given data set. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [15]. + +``` +Sbi-Etags-Header = "3gpp-Sbi-Etags:" OWS datasetEtag *(OWS "," OWS datasetEtag) OWS + +datasetEtag = dataSetName "=" entity-tag + +dataSetName = UeSubscribedDataSetName + +UeSubscribedDataSetName = 1*( ALPHA / DIGIT / "-" ) +``` + +See clause 5.4.3.11 of 3GPP TS 29.505 [2] for the "UeSubscribedDataSetName" definition. + +See IETF RFC 9110 [15] section 8.8.3 for the "entity-tag" definition. + +EXAMPLE: 3gpp-Sbi-Etags: AM="xxx", SM="yyy" + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Resource URI structure of the Nudr_DataRepository API](e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg) + +``` +graph TD; Root[//{apiRoot}/nudr-dr/v2] --- SD[/subscription-data]; Root --- PD[/policy-data]; Root --- ED[/exposure-data]; Root --- AD[/application-data]; Root --- DRE[/data-restoration-events]; SD --- SD_SLR[]; PD --- PD_SLR[]; ED --- ED_SLR[]; AD --- AD_SLR[]; +``` + +The diagram illustrates the resource URI structure of the Nudr\_DataRepository API. It starts with the base URI `//{apiRoot}/nudr-dr/v2`. From this base, five main resource paths branch out: `/subscription-data`, `/policy-data`, `/exposure-data`, `/application-data`, and `/data-restoration-events`. Each of the first four paths leads to a box labeled ``, indicating further sub-resources. The `/data-restoration-events` path leads directly to a box labeled `/data-restoration-events`. + +Resource URI structure of the Nudr\_DataRepository API + +**Figure 6.1.3.1-1: Resource URI structure of the Nudr\_DataRepository API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 6.1.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------------|--------------------------|---------------------------------|-------------------------------------------------------------------------------------| +| SubscriptionData | /subscription-data | none | For sub-level resource names, resource URIs and HTTP methods see 3GPP TS 29.505 [2] | +| PolicyData | /policy-data | none | For sub-level resource names, resource URIs and HTTP methods see 3GPP TS 29.519 [3] | +| StructuredDataForExposure | /exposure-data | none | For sub-level resource names, resource URIs and HTTP methods see 3GPP TS 29.519 [3] | +| ApplicationData | /application-data | none | For sub-level resource names, resource URIs and HTTP methods see 3GPP TS 29.519 [3] | +| DataRestorationEvents | /data-restoration-events | POST | This is a pseudo operation. | + +#### 6.1.3.2 SubscriptionData + +See 3GPP TS 29.505 [2]. + +#### 6.1.3.3 PolicyData + +See 3GPP TS 29.519 [3]. + +#### 6.1.3.4 StructuredDataForExposure + +See 3GPP TS 29.519 [3]. + +#### 6.1.3.5 ApplicationData + +See 3GPP TS 29.519 [3]. + +#### 6.1.3.6 Resource: DataRestorationEvents + +##### 6.1.3.6.1 Description + +##### 6.1.3.6.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//data-restoration-events + +This resource shall support the resource URI variables defined in table 6.1.3.6.2-1. + +Table 6.1.3.6.2-1: Resource URI variables for this resource + +| Name | Data type | Definition | +|------------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1 | + +##### 6.1.3.6.3 Resource Standard Methods + +###### 6.1.3.6.3.1 POST + +This method will not be actually invoked. + +This method shall support the URI query parameters specified in table 6.1.3.6.3.1-1. + +**Table 6.1.3.6.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.6.3.1-2 and the response data structures and response codes specified in table 6.1.3.6.3.1-3. + +**Table 6.1.3.6.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| Any | | | | + +**Table 6.1.3.6.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|-------------| +| n/a | | | | | + +### 6.1.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nudr\_DataRepository Service. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +This clause specifies the general mechanism of notifications in the following scenarios: + +- notification of changed data which are stored in the UDR; +- notification of data restoration. + +The mechanism shall be applicable to the data specified in 3GPP TS 29.505[2] and 3GPP TS 29.519[3]. + +#### 6.1.5.2 Data Change Notification + +The POST method shall be used for Data Change Notifications and the URI shall be as provided during the subscription procedure. + +Resource URI: {callbackReference} + +Support of POST request data structures should contain the object of changed data and conditionally the URI of original Callback reference, which is received from the original subscribed NF. + +#### 6.1.5.3 Data Restoration Notification + +The POST method shall be used to inform the NF Service Consumer about a potential data-loss event occurred at the UDR, and the callback URI shall be dynamically discovered by UDR by querying NRF for a default notification URI. + +Resource URI: {dataRestorationCallbackUri} + +Support of URI query parameters is specified in table 6.1.5.3-1. + +**Table 6.1.5.3-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.1.5.3-2 and of response data structures and response codes is specified in table 6.1.5.3-3. + +**Table 6.1.5.3-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------| +| DataRestorationNotification | M | 1 | Contains identifiers representing those UEs potentially affected by a data-loss event at the UDR. | + +**Table 6.1.5.3-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same NF or NF (service) set.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same NF or NF (service) set.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT NOT FOUND | + +NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [7] are supported. + +**Table 6.1.5.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer (e.g. UDM) to which the request is redirected | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the Callback URI of the target NF Service Consumer (e.g. AMF) to which the request is redirected | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.5a Data Model + +#### 6.1.5a.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.5a.1-1 specifies the data types defined for the Nudr\_DataRepository API. + +**Table 6.1.5a.1-1: Nudr\_DataRepository specific Data Types** + +| Data type | Clause defined | Description | +|-----------------------------|----------------|-------------------------------------------------------------------------------------------------| +| DataRestorationNotification | 6.2.5a.2.2 | Contains identities representing those UEs potentially affected by a data-loss event at the UDR | + +Table 6.1.5a.1-2 specifies data types re-used by the Nudr\_DataRepository service-based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudr\_DataRepository service-based interface. + +**Table 6.1.5a.1-2: Nudr\_DataRepository re-used Data Types** + +| Data type | Reference | Comments | +|---------------|---------------------|-------------------------------------------------| +| Dnn | 3GPP TS 29.571 [10] | Data Network Name with Network Identifier only. | +| Snssai | 3GPP TS 29.571 [10] | Single NSSAI | +| NfGroupId | 3GPP TS 29.571 [10] | NF Group ID | +| IdentityRange | 3GPP TS 29.510 [14] | Identity Range | +| SupiRange | 3GPP TS 29.510 [14] | SUPI Range | + +#### 6.1.5a.2 Structured data types + +##### 6.1.5a.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.5a.2.2 Type: DataRestorationNotification + +Table 6.2.5a.2.2-1: Definition of type DataRestorationNotification + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supiRanges | array(SupiRange) | O | 1..N | If present, it contains the list of SUPIs potentially subject to a data-loss event at the UDR. | +| gpsiRanges | array(IdentityRange) | O | 1..N | If present, it contains the list of GPSIs potentially subject to a data-loss event at the UDR. | +| resetIds | array(string) | O | 1..N | If present, it contains the list of Reset-IDs of those UEs potentially subject to a data-loss event at the UDR. | +| sNssaiList | array(Snssai) | O | 1..N | If present, it contains the list of slices (S-NSSAIs) potentially subject to a data-loss event at the UDR. | +| dnnList | array(Dnn) | O | 1..N | If present, it contains the list of DNNs potentially subject to a data-loss event at the UDR. | +| lastReplicationTime | DateTime | O | 0..1 | If present, it contains the timestamp of the most recent instant when the data was assumed to be consistent at UDR (i.e. the potential data loss event at UDR did not occur before this instant). | +| recoveryTime | DateTime | O | 0..1 | If present, it contains the timestamp of the instant when the potential data loss event was recovered at UDR (i.e. all data records stored by UDR after this time are assumed to be consistent). | +| udrGroupId | NfGroupId | O | 0..1 | If present, it contains the ID of the UDR Group whose UEs have been potentially subject to a data loss event at the UDR. | + +### 6.1.6 Error Handling + +Table 6.1.6-1 lists common response body data structures used within the nudr-dr (Nudr\_DataRepository) API + +Table 6.1.6-1: Common Response Body Data Structures + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------|---|-------------|--------------------|-------------------------------------------------------------------| +| ProblemDetails | O | 0..1 | 4xx, 5xx responses | For error status codes, the UDR may provide detailed information. | +| NOTE: In addition common data structures as defined in 3GPP TS 29.500 [7] are supported. | | | | | + +The "ProblemDetails" data structure may contain a "cause" attribute to indicate the application error, see 3GPP TS 29.571 [10]. The values for "cause" attribute are defined in table 6.1.6-2. + +**Table 6.1.6-2: Application Errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NF_TYPE_NOT_ALLOWED | 403 Forbidden | The target data set is not permitted to access for the NF type of the NF consumer. | +| UNSUPPORTED_MONITORED_URI | 501 Not Implemented | The subscribe service operation is not able to be implemented due to invalid resource URI to be monitored). | +| USER_NOT_FOUND | 404 Not Found | The user indicated in the HTTP/2 request does not exist in the UDR. | +| DATA_NOT_FOUND | 404 Not Found | The data indicated in the HTTP/2 request is unavailable in the UDR. | +| INCORRECT_CONDITIONAL_GET_REQUEST | 412 Precondition Failed | One or more conditions given in the request header fields evaluated to false when tested in the UDR. | +| UNPROCESSABLE_REQUEST | 422 Unprocessable Entity | The request cannot be processed due to semantic errors when trying to process a patch method. | +| DATABASE_INCONSISTENCY | 500 Internal Server Error | Requested data cannot be returned due to database inconsistency | +| RESOURCE_TEMP_MOVED | 307 Temporary Redirect | The resource is unavailable in the current target URI but can be temporarily found in an alternative URI. | +| RESOURCE_MOVED | 308 Permanent Redirect | The resource is unavailable in the current target URI but can be permanently found in an alternative URI. | +| GROUP_IDENTIFIER_NOT_FOUND | 404 Not Found | The group identifier does not exist. | +| MODIFICATION_NOT_ALLOWED | 403 Forbidden | Modification of the target resource representation is not permitted. | +| PLMN_NOT_FOUND | 404 Not Found | The 'servingPlmnId' indicated in the HTTP/2 query is unavailable in the UDR. This status code is also used when 'servingPlmnId' path variable contains SNPN ID, see Table 5.2.3.2-1 in 3GPP TS 29.505 [2]. | +| INTERNAL_GROUP_ID_NOT_UNIQUE | 403 Forbidden | The internal group ID allocated by the UDM for a newly created 5G VN Group already exists in the UDR. | +| NOTE: The error codes shall apply to both 3GPP TS 29.505 [2] and 3GPP TS 29.519 [3]. In addition error codes shall comply with the definition in clause 5.2.7.2 of 3GPP TS 29.500 [7]. | | | + +### 6.1.7 Security + +As indicated in 3GPP TS 33.501 [12], the access to the Nudr\_DataRepository API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [13]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [14]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nudr\_DataRepository API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [14], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudr\_DataRepository service. + +The Nudr\_DataRepository API defines the following scopes for OAuth2 authorization: + +**Table 6.1.7-1: Oauth2 scopes defined in Nudr\_DataRepository API** + +| Scope | Description | +|----------------------------------------------------------------|--------------------------------------------------------------------------------------------| +| "nudr-dr" | Access to the Nudr DataRepository API | +| "nudr-dr:subscription-data" | Access to the SubscriptionData data set. | +| "nudr-dr:subscription-data:authentication-subscription:read" | Access to read the AuthenticationSubscription resource of the SubscriptionData data set. | +| "nudr-dr:subscription-data:authentication-subscription:modify" | Access to update the AuthenticationSubscription resource of the SubscriptionData data set. | +| "nudr-dr:subscription-data:registrations:write" | Write access to NF registration resources of the SubscriptionData data set. | +| "nudr-dr:policy-data" | Access to the PolicyData data set. | +| "nudr-dr:policy-data:ues:read" | Access to read the UEs resource. | +| "nudr-dr:policy-data:ues:am-data:read" | Access to read the UEs Access and Mobility Policy data. | +| "nudr-dr:policy-data:ues:ue-policy-set:read" | Access to read the UEs Policy Set data. | +| "nudr-dr:policy-data:ues:ue-policy-set:create" | Access to create the UEs Policy Set data. | +| "nudr-dr:policy-data:ues:ue-policy-set:modify" | Access to update the UEs Policy Set data. | +| "nudr-dr:policy-data:ues:sm-data:read" | Access to read the UEs Session Management policy data. | +| "nudr-dr:policy-data:ues:sm-data:modify" | Access to update the UEs Session Management policy data. | +| "nudr-dr:policy-data:ues:sm-data:create" | Access to create the UEs Session Management policy data. | +| "nudr-dr:policy-data:sponsor-connectivity-data:read" | Access to read the sponsored connectivity data. | +| "nudr-dr:policy-data:bdtd-data:read" | Access to read the BDT data resource. | +| "nudr-dr:policy-data:bdtd-data:create" | Access to create the BDT data resource. | +| "nudr-dr:policy-data:bdtd-data:modify" | Access to update the BDT data resource. | +| "nudr-dr:policy-data:subs-to-notify:create" | Access to create Subscriptions resources. | +| "nudr-dr:policy-data:subs-to-notify:modify" | Access to update Subscriptions resources. | +| "nudr-dr:policy-data:ues:operator-specific-data:read" | Access to read the UEs operator specific policy data. | +| "nudr-dr:policy-data:ues:operator-specific-data:modify" | Access to update the UEs operator specific policy data. | +| "nudr-dr:policy-data:ues:operator-specific-data:create" | Access to create the UEs operator specific policy data. | +| "nudr-dr:policy-data:slice-control-data:read" | Access to read Slice specific Policy Control Data. | +| "nudr-dr:policy-data:slice-control-data:modify" | Access to update Slice specific Policy Control Data. | +| "nudr-dr:policy-data:group-control-data:read" | Access to read Group Control Data. | +| "nudr-dr:policy-data:group-control-data:modify" | Access to update Group Control Data. | +| "nudr-dr:exposure-data" | Access to the ExposureData data set. | +| "nudr-dr:exposure-data:access-and-mobility-data:create" | Access to create Access and Mobility data. | +| "nudr-dr:exposure-data:access-and-mobility-data:read" | Access to read Access and Mobility data. | +| "nudr-dr:exposure-data:access-and-mobility-data:modify" | Access to update Access and Mobility data. | +| "nudr-dr:exposure-data:session-management-data:create" | Access to create Session Management data. | +| "nudr-dr:exposure-data:session-management-data:read" | Access to read Session Management data. | +| "nudr-dr:exposure-data:session-management-data:modify" | Access to update Session Management data. | +| "nudr-dr:exposure-data:subs-to-notify:create" | Access to create Subscriptions resources. | +| "nudr-dr:exposure-data:subs-to-notify:modify" | Access to update Subscriptions resources. | +| "nudr-dr:application-data" | Access to the ApplicationData data set. | +| "nudr-dr:application-data:pfds:read" | Access to read PFDData. | + +| | | +|----------------------------------------------------------------|--------------------------------------------------------| +| "nudr-dr:application-data:pfds:modify" | Access to update PFDData. | +| "nudr-dr:application-data:pfds:create" | Access to create PFDData. | +| "nudr-dr:application-data:influence-data:read" | Access to read Traffic Influence Data. | +| "nudr-dr:application-data:influence-data:create" | Access to create Traffic Influence Data. | +| "nudr-dr:application-data:influence-data:modify" | Access to update Traffic Influence Data. | +| "nudr-dr:application-data:influence-data:subscriptions:create" | Access to create Traffic Influence Data Subscriptions. | +| "nudr-dr:application-data:influence-data:subscriptions:read" | Access to read Traffic Influence Data Subscriptions. | +| "nudr-dr:application-data:influence-data:subscriptions:modify" | Access to update Traffic Influence Data Subscriptions. | +| "nudr-dr:application-data:bdtpolicy-data:read" | Access to read BDT Policy Data. | +| "nudr-dr:application-data:bdtpolicy-data:create" | Access to create BDT Policy Data. | +| "nudr-dr:application-data:bdtpolicy-data:modify" | Access to update BDT Policy Data. | +| "nudr-dr:application-data:iptv-config-data:read" | Access to read IPTV Configuration Data. | +| "nudr-dr:application-data:iptv-config-data:create" | Access to create IPTV Configuration Data. | +| "nudr-dr:application-data:iptv-config-data:modify" | Access to update IPTV Configuration Data. | +| "nudr-dr:application-data:service-param-data:read" | Access to read Service Parameter Data. | +| "nudr-dr:application-data:service-param-data:create" | Access to create Service Parameter Data. | +| "nudr-dr:application-data:service-param-data:modify" | Access to update Service Parameter Data. | +| "nudr-dr:application-data:am-influence-data:read" | Access to read AM Influence Data. | +| "nudr-dr:application-data:am-influence-data:create" | Access to create AM Influence Data. | +| "nudr-dr:application-data:am-influence-data:modify" | Access to update AM Influence Data. | +| "nudr-dr:application-data:subs-to-notify:create" | Access to create Subscriptions resources. | +| "nudr-dr:application-data:subs-to-notify:read" | Access to read Subscriptions resources. | +| "nudr-dr:application-data:subs-to-notify:modify" | Access to update Subscriptions resources. | +| "nudr-dr:application-data:eas-deploy-data:read" | Access to read EAS Deployment Information Data. | +| "nudr-dr:application-data:eas-deploy-data:create" | Access to create EAS Deployment Information Data. | +| "nudr-dr:application-data:eas-deploy-data:modify" | Access to update EAS Deployment Information Data. | +| "nudr-dr:application-data:ecs-address-roaming:read" | Access to read ECS Address Roaming Data resources | +| "nudr-dr:application-data:ecs-address-roaming:create" | Access to create ECS Address Roaming Data resources | +| "nudr-dr:application-data:ecs-address-roaming:modify" | Access to update ECS Address Roaming Data resources | +| "nudr-dr:application-data:dnaieas:read" | Access to read DNAI-EAS mapping resources. | +| "nudr-dr:application-data:af-qos-data-sets:read" | Access to read AF QoS Data Sets | +| "nudr-dr:application-data:af-qos-data-sets:create" | Access to create AF QoS Data Sets | +| "nudr-dr:application-data:af-qos-data-sets:modify" | Access to update AF QoS Data Sets | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nudr\_DataRepository API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [7]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ResourceRemovalNotificationPolicyData | This feature indicates the support of the complete removal of a Policy Data resource. | +| 2 | ResourceNotificationExposureDataFix | This feature indicates the support of corrections to Notifications of data changes in the Exposure Data resource. | +| 3 | DomainNameProtocol | This feature supports the additional protocol matching condition for the domain name in PFD data. | +| 4 | EnhancedBackgroundDataTransfer | This feature indicates the support of applying the Background Data Transfer Policy to a future PDU session requested by the AF for Policy Data resource and Application Data resource as defined in 3GPP TS 29.519 [3]. This feature requires the support of SessionManagementPolicyDataPatch feature to update Background Data Transfer data within the Session Management Policy Data. | +| 5 | MacAddressRange | This feature indicates the support of a set of MAC addresses with a specific range for the traffic filter in the application data resource as specified in 3GPP TS 29.519 [3]. | +| 6 | MultiTemporalCondition | This feature indicates the support of multiple temporal validity conditions in the Traffic Influence Data resource as specified in 3GPP TS 29.519 [3]. | +| 7 | PatchReport | If some of the modifications included in the PATCH request are not successfully implemented, the UDM reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [7]. | +| 8 | URLLC | This feature indicates support of Ultra Reliable Low Latency Communication (URLLC) requirements, i.e. AF application relocation and UE address(es) preservation in the Application Data resource as specified in 3GPP TS 29.519 [3]. | +| 9 | SessionManagementPolicyDataPatch | This feature indicates the support of the HTTP PATCH method to update the session management policy data defined in a Policy Data resource as specified in 3GPP TS 29.519 [3]. | +| 10 | ConditionalSubscriptionwithPartialNotification | This feature indicates the support of subscription to notification of resource data changes conditioned to the change occurs in a fragment of the resource. It applies for Policy Data resources as specified in 3GPP TS 29.519 [3]. | +| 11 | EnhancedInfluDataNotification | This feature indicates the support of enhancement of data change Notifications in the Influence Data resource as specified in 3GPP TS 29.519 [3]. | +| 12 | PerUePerSnAuthStatus | This feature indicates the support of the Individual authentication status per UE per serving network as specified in 3GPP TS 29.505 [2]. | +| 13 | OpSpecDataMapNotification | This feature indicates the support of the notification of data changes in the OperatorSpecificData resource by including the complete map of Operator Specific Data Containers. It applies to Policy Data resources as specified in 3GPP TS 29.519 [3]. | +| 14 | | Reserved | +| 15 | OSDResource_Create_Delete | This feature indicates the support of the creation and the removal of the OperatorSpecificData resource by a Policy Data NF service consumer. It applies to Policy Data resources as specified in 3GPP TS 29.519 [3]. | +| 16 | AF_latency | This feature indicates the support for Edge relocation considering user plane latency. It applies for Influence Data resource as specified in 3GPP TS 29.519 [3]. | +| 17 | CHFsetSupport | This feature indicates the support of CHF redundancy and failover mechanisms based on CHF instance availability within a CHF Set, (i.e. secondary CHF address may be omitted). It applies to Policy Data resources as specified in 3GPP TS 29.519 [3]. | +| 18 | ConditionalSubscriptionWithExcludeNotification | This feature indicates the support in the subscription to notification of data changes of the indication of the properties whose changes do not trigger a notification. It applies to Policy Data resources as specified in 3GPP TS 29.519 [3]. It requires the support of OpSpecDataMapNotification feature | +| 19 | ProSe | This feature indicates the support of UE 5G ProSe policies and subscription information. It applies for Policy Data resources as specified in 3GPP TS 29.519 [3]. | + +| | | | +|----|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 20 | NSAC | This feature indicates the support of NSAC (Network Slice Admission Control) related policy subscription information. It applies to Policy Data resources as specified in 3GPP TS 29.519 [3]. | +| 21 | UESubDataSetRetrieve | This feature indicates the support of the UE Subscription Data Sets Retrieve as specified in clause 5.2.47 of 3GPP TS 29.505 [2]. | +| 22 | SharedSmSubsData | This feature indicates the support of shared Session Management Subscription Data. If the NF consumer (UDM) does not support this feature, the UDR shall not take the alternative to include extendedSmSubsData in SmSubsData. It applies to Subscription Data resources as specified in 3GPP TS 29.505 [2]. | +| 23 | DeliveryOutcome | This feature indicates the support of functionality to allow PCF notifications about the outcome of the UE Policy delivery related to the invocation of AF provisioned service parameters as specified in 3GPP TS 29.519 [3]. | +| 24 | AfGuideURSP | This feature indicates the support of Application guidance for URSP determination related application data as specified in 3GPP TS 29.519 [3]. | +| 25 | EasDeployment | This feature indicates the support of EAS Deployment Information Data and Subscription related application data as specified in 3GPP TS 29.519 [3]. | +| 26 | DCAMP | This feature indicates the support of DCAMP related application data. It applies to Application Data resources as specified in 3GPP TS 29.519 [3]. | +| 27 | FilterAnyUE | This feature indicates the support of queries and subscriptions to service parameter data resource filtered by the any UE indication as specified in 3GPP TS 29.519 [3]. | +| 28 | SimultConnectivity | This feature indicates the support of temporary simultaneously connectivity at edge relocation. It applies for Influence Data resource as specified in 3GPP TS 29.519 [3]. | +| 29 | EeSubscriptionExt | This feature indicates the support of handling EE subscription data along with associated subscription resources as specified in 3GPP TS 29.505 [2]. | +| 30 | PeiResource | This feature indicates the support of storing PEI in the PeiInfo resource as specified in 3GPP TS 29.505 [2]. | +| 31 | ImmediateReportPcc | This feature indicates support of ImmediateReport within a PolicyDataSubscription in 3GPP TS 29.519 [3]. When a UDR consumer detects that the UDR supports the ImmediateReportPcc feature, it can indicate an immediateReport flag when invoking the Subscribe service operation. If the UDR receives the ImmediateReport flag in the received Subscribe service operation request, it shall return the resource's representation(s) of the monitored resource(s) in the service operation response body. | +| 32 | ImmediateReport | This feature indicates support of ImmediateReport within an SubscriptionDataSubscription in 3GPP TS 29.505 [2]. When a UDR consumer detects that the UDR supports the ImmediateReport feature, it can indicate an immediateReport flag when invoking the Subscribe service operation. If the UDR receives the ImmediateReport flag in the received Subscribe service operation request, it shall return the resource's representation(s) of the monitored resource(s) in the service operation response body. | +| 33 | UESubDataSetRetrieveExt | This feature indicates the support of the Extended UE Subscription Data Sets Retrieve as specified in clause 5.2.47 of 3GPP TS 29.505 [2]. | +| 34 | SFC | This feature indicates support of Service Function Chaining functionality. It applies for Influence Data resource as specified in 3GPP TS 29.519 [3]. | +| 35 | SubscribedV2XPolicy | This feature indicates the support of subscribed V2X policy data as specified in 3GPP TS 29.519 [3]. | +| 36 | CommonEASDNAI | This feature indicates the support of the common EAS/DNAI selection as specified in 3GPP TS 29.519 [3]. | +| 37 | PolSubscRetrieval | This feature indicates the support of the indication, within the PolicyDataSubscription data type, of the variable part of the Individual Policy Data subscription. It applies to Policy Data subscription resources as specified in 3GPP TS 29.519 [3]. | + +| | | | +|----|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 38 | A2X | This feature indicates the support of A2X communication as specified in 3GPP TS 29.519 [3]. | +| 39 | EpsUrsp | This feature indicates support of epsUrspInd within UePolicySet and UePolicySetPatch in 3GPP TS 29.519 [3]. | +| 40 | DCAMP_Roaming_LBO | This feature indicates support for dynamically changing AM policy for inbound roaming UE using LBO as specified in 3GPP TS 29.519 [3]. | +| 41 | GMEC | This feature indicates support of Generic Group Management, Exposure and Communication functionality. It applies to Policy Data resource and Application Data resource as specified in 3GPP TS 29.519 [3]. | +| 42 | PatchCorrection | This feature introduces the correction to the PATCH method to support the service parameter urspGuidance to guide the URSP as specified in 3GPP TS 29.519 [3]. | +| 43 | EnhancedUePolicy | This feature indicates the support of enhancement of the UE policy (e.g. Tracing Requirements). It applies to Policy Data resource as specified in 3GPP TS 29.519 [3]. | +| 44 | ProSe_Ph2 | This feature indicates the support of UE 5G ProSe policies and subscription information for UE-to-UE relay service. It applies for Policy Data resources as specified in 3GPP TS 29.519 [3]. | +| 45 | OpSpecAmPolicyData | This feature indicates the support of the operator specific data changes in the AccessAndMobilityPolicyData resource. It applies to AM Policy Data resource as specified in 3GPP TS 29.519 [3]. | +| 46 | CHFInformation | This feature indicates the support of provisioning of CHF information. It applies to Policy Data resource as specified in 3GPP TS 29.519 [3]. | +| 47 | SLAMUP | This feature indicates support of Spending Limits for AM and UE Policies in the 5GC. It applies to Policy Data resource as specified in 3GPP TS 29.519 [3].
This feature requires the support of the CHFInformation feature. | +| 48 | AfGuideTNAPs | This feature is used in 3GPP TS 29.519 [3] and indicates the support of AF-provided guidance to the HPLMN of the UE of the list of TNAP(s) collocated with a 5G-RG. | +| 49 | URSPEnforcement | This feature indicates support of urspEnfInd within UePolicySet and UePolicySetPatch in 3GPP TS 29.519 [3]. | +| 50 | VPLMNSpecificURSP | This feature indicates support of vpsUrspInd within UePolicySet and UePolicySetPatch in 3GPP TS 29.519 [3]. | +| 51 | DnaiEasMappings | This feature indicates support of OAM-configured DNAI-EAS mapping information as specified in 3GPP TS 29.519 [3]. | +| 52 | RoamingEACI | This feature indicates support of provisioning ECS Address Configuration Information for Roaming UEs to the V-NEF in 3GPP TS 29.519 [3]. | +| 53 | FinerGranUEs | This feature indicates support of finer granular UE sets as specified in 3GPP TS 29.519 [3]. | + +## 6.2 Nudr\_GroupIDmap Service API + +### 6.2.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}
+ +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [8], the "apiName" shall be set to "nudr-group-id-map" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [22], shall be used as specified in clause 5 of 3GPP TS 29.500 [7]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [7]. + +HTTP messages and bodies for the Nudr\_GroupIDmap service shall comply with the OpenAPI [21] specification contained in Annex A3. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +The usage of HTTP standard headers shall be supported on Nudr interface as defined in clause 5.2.2 of 3GPP TS 29.500 [7]. + +##### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [11], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [7]. +- The Problem Details JSON Object (IETF RFC 9457 [17]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +##### 6.2.2.2.3 Cache-Control + +As described in IETF RFC 9111 [16] clause 5.2, a "Cache-Control" header should be included in HTTP responses carrying a representation of cacheable resources. If it is included, it shall contain a "max-age" value, indicating the amount of time in seconds after which the received response is considered stale. + +The "max-age" value shall be configurable by operator policy. + +##### 6.2.2.2.4 ETag + +As described in IETF RFC 9110 [15] clause 8.8.3, an "ETag" (entity-tag) header should be included in HTTP responses carrying a representation of cacheable resources to allow an NF Service Consumer performing a conditional GET request with "If-None-Match" header. If it is included, it shall contain a server-generated strong validator, that allows further matching of this value (included in subsequent client requests) with a given resource representation stored in the server or in a cache. + +##### 6.2.2.2.5 If-None-Match + +As described in IETF RFC 9110 [15] clause 13.1.2, an NF Service Consumer may issue conditional GET request towards UDR by including an "If-None-Match" header in HTTP requests containing one or several entity tags received in previous responses for the same resource. + +##### 6.2.2.2.6 Last-Modified + +As described in IETF RFC 9110 [15] clause 8.8.2, a "Last-Modified" header should be included in HTTP responses carrying a representation of cacheable resources (e.g. SmfSelectionSubscriptionData) to allow an NF Service Consumer performing a conditional request with "If-Modified-Since" header. + +##### 6.2.2.2.7 If-Modified-Since + +As described in IETF RFC 9110 [15] clause 13.1.3, an NF Service Consumer may issue conditional GET request towards UDR, by including an "If-Modified-Since" header in HTTP requests. + +##### 6.2.2.2.8 When to Use Entity-Tags and Last-Modified Dates + +Both "ETag" and "Last-Modified" headers should be sent in the same HTTP response as stated in IETF RFC 9110 [15] clause 15.3.1. + +NOTE: "ETag" is a stronger validator than "Last-Modified" and is preferred. + +If the UDR included an "ETag" header with the resource then a conditional GET request for this resource shall be performed with the "If-None-Match" header. + +#### 6.2.2.3 HTTP custom headers + +##### 6.2.2.3.1 General + +In this release of this specification, no custom headers specific to the Nudr\_GroupIDmap service are defined. For 3GPP specific HTTP custom headers used across all service-based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [7]. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +![Diagram showing the resource URI structure for the nudr-group-id-map API. A vertical line descends from the root URI and branches to two boxes: '/nf-group-ids' and '/routing-ids'.](23b48e0b60d0b6deb0cc9862ff4b8ead_img.jpg) + +{apiRoot}/nudr-group-id-map/ + +``` + +graph TD + Root["{apiRoot}/nudr-group-id-map/"] --> NFGroupIds["/nf-group-ids"] + Root --> RoutingIds["/routing-ids"] + +``` + +Diagram showing the resource URI structure for the nudr-group-id-map API. A vertical line descends from the root URI and branches to two boxes: '/nf-group-ids' and '/routing-ids'. + +**Figure 6.2.3.1-1: Resource URI structure of the nudr-group-id-map API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description | +|---------------|---------------|-------------|-----------------------------------------------------------| +| NfGroupIds | /nf-group-ids | GET | | +| RoutingIds | /routing-ids | GET | Obtain the list of Routing IDs served by a given NF Group | + +#### 6.2.3.2 Resource NfGroupIds + +##### 6.2.3.2.1 Description + +This resource represents the NF Group IDs for the provided subscriber information (e.g. the subscriber identifier, or information related to a set of subscribers, such as the Routing Indicator). + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nudr-group-id-map//nf-group-ids + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------| +| apiRoot | See clause 6.2.1 | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nf-type | array(NFType) | M | 1..N | see 3GPP TS 29.510 [14] | +| subscriberId | SubscriberId | M | 1 | Represents the Subscription Identifier SUPI or GPSI or IMPI or IMPU (see 3GPP TS 23.501 [4] clause 5.9.2 and clause 5.9.8) or Routing Indicator
pattern: ^(imsi-[0-9]{5,15} nai-\.+[msisdnn-[0-9]{5,15} extid-[^\@]+\@[^\@]+\+ impi-\.+ impu-\.+ rid-[0-9]{1,4} \+)\$ | + +NOTE 1: The format of the query parameter subscriberId is in line with the yaml and thus does not follow the lower-with-hyphen format specified in 3GPP TS 29.501 [8]. + +NOTE 2: If the UDR does not support a certain alternative in the regular expression pattern of the subscriberId query parameter (e.g. "rid-xxxx"), it returns an HTTP 404 error response. + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------| +| NfGroupIdMapResult | M | 1 | 200 OK | Upon success, a response body containing the NF Group IDs for the requested NF types shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be set to one of the following application errors:
- USER_NOT_FOUND | + +NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 are supported. + +#### 6.2.3.3 Resource RoutingIds + +##### 6.2.3.3.1 Description + +This resource represents the Routing Indicators served by an NF Group. + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nudr-group-id-map//routing-ids + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------| +| apiRoot | See clause 6.2.1 | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------|---|-------------|---------------------------------------| +| nf-type | NFType | M | 1 | see 3GPP TS 29.510 [14] | +| nf-group-id | NfGroupId | M | 1 | Contains the identity of the NF Group | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------| +| RoutingIdResult | M | 1 | 200 OK | Upon success, a response body containing the Routing IDs for the requested NF type and NF Group ID shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 are supported. | | | | | + +### 6.2.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nudr\_GroupIDmap Service. + +### 6.2.5 Notifications + +In this release of this specification, no notifications are defined for the Nudr\_GroupIDmap Service. + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the structured data types defined for the Nudr\_GroupIDmap service API. For simple data types defined for the Nudr\_GroupIDmap service API see table 6.2.6.3.2-1. + +**Table 6.2.6.1-1: Nudr\_GroupIDmap specific Data Types** + +| Data type | Clause defined | Description | +|--------------------|----------------|------------------------------------------------------------------------------------------| +| NfGroupIdMapResult | 6.2.6.2.2 | NF-Group IDs for the requested NF types | +| RoutingIdResult | 6.2.6.2.3 | Routing Indicators for the requested NF type and NF Group ID | +| SubscriberId | 6.2.6.3.2 | Represents the Subscription Identifier SUPI or GPSI or IMPI or IMPU or Routing Indicator | + +Table 6.2.6.1-2 specifies data types re-used by the Nudr\_GroupIDmap service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudr\_GroupIDmap service API. + +**Table 6.2.6.1-2: Nudr\_GroupIDmap re-used Data Types** + +| Data type | Reference | Comments | +|----------------|---------------------|------------------------------------------| +| ProblemDetails | 3GPP TS 29.571 [10] | Common data type used in response bodies | +| NFType | 3GPP TS 29.510 [14] | | +| NfGroupId | 3GPP TS 29.571 [10] | | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: NfGroupIdMapResult + +**Table 6.2.6.2.2-1: Definition of type NfGroupIdMapResult** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|--------------------------------------------------------------------------| +| nfGroupIds | map(NfGroupId) | M | 1..N | A map (list of key-value pairs where NFType serves as key) of NFGroupIds | + +##### 6.2.6.2.3 Type: RoutingIdResult + +**Table 6.2.6.2.3-1: Definition of type NfGroupIdMapResult** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------|---|-------------|------------------------------------------------------------------------------| +| routingIndicators | array(string) | M | 1..N | An array of Routing Indicators.
pattern (of each item): '^([0-9]{1,4})\$' | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|--------------|-----------------|-----------------------------------------------------------------------------------------------------------------| +| SubscriberId | string | Pattern: ^(imsi-[0-9]{5,15} nai-.+ msisdn-[0-9]{5,15} extid-[^@]+@[^\@]+\+ impi-.+ impu-.+ rid-[0-9]{1,4}.\+)\$ | + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [7]. + +#### 6.2.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [7]. + +#### 6.2.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [7] may also be used for the Nudr\_GroupIDmap service. The following application errors listed in Table 6.2.7.3-1 are specific for the Nudr\_GroupIDmap service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|--------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | + +### 6.2.8 Security + +As indicated in 3GPP TS 33.501 [12], the access to the Nudr\_GroupIDmap API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [13]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [14]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nudr\_GroupIDmap API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [14], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nudr\_GroupIDmap service. + +The Nudr\_GroupIDmap API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [12]; it defines a single scope consisting on the name of the service (i.e., "nudr-group-id-map"), and it does not define any additional scopes at resource or operation level. + +### 6.2.9 Feature Negotiation + +The optional features in table 6.2.9-1 are defined for the Nudr\_GroupIDmap API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [7]. + +**Table 6.2.9-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This document specifies the common service operations and the top level data model for Nudr\_DataRepository Service Based Interface. There are no specific HTTP methods or custom operations on the four top level resources in Table 6.1.3.1-1. Hence, the top level OpenAPI specification is not needed. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [8] clause 5.3.1 and 3GPP TR 21.900 [20] clause 5B). + +## A.2 Nudr\_DataRepository API + +This Annex specifies the formal definition of the Nudr\_DataRepository service. It consists of OpenAPI 3.0.0 specifications, in YAML format. + +The OpenAPI 3.0.0 definition related to SubscriptionData shall comply with the definition in 3GPP TS 29.505 [2]. + +The OpenAPI 3.0.0 definition related to PolicyData, StructuredDataForExposure and ApplicationData shall comply with the definition in 3GPP TS 29.519 [3]. + +The OpenAPI file for the Nudr\_DataRepository API is defined as follows: + +``` +openapi: 3.0.0 + +info: + version: 2.3.0-alpha.5 + title: 'Nudr_DataRepository API OpenAPI file' + description: | + Unified Data Repository Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.504 V18.4.0; 5G System; Unified Data Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.504/' + +servers: + - description: API root + url: '{apiRoot}/nudr-dr/v2' + variables: + apiRoot: + default: https://example.com + +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + +paths: + /subscription-data/{ueId}/authentication-data/authentication-subscription: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1authentication-data~1authentication-subscription' + /subscription-data/{ueId}/authentication-data/authentication-status: +``` + +``` +$ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lauthentication-data~lauthentication-status' + /subscription-data/{ueId}/authentication-data/authentication-status/{servingNetworkName}: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lauthentication-data~lauthentication-status~l%7BservingNetworkName%7D' + /subscription-data/{ueId}/ue-update-confirmation-data/sor-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lue-update-confirmation-data~lsor-data' + /subscription-data/{ueId}/ue-update-confirmation-data/upu-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lue-update-confirmation-data~lupu-data' + /subscription-data/{ueId}/ue-update-confirmation-data/subscribed-cag: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lue-update-confirmation-data~lsubscribed-cag' + /subscription-data/{ueId}/ue-update-confirmation-data/subscribed-snssais: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lue-update-confirmation-data~lsubscribed-snssais' + /subscription-data/{ueId}/{servingPlmnId}/provisioned-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l%7BservingPlmnId%7D~lprovisioned-data' + /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/am-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l%7BservingPlmnId%7D~lprovisioned-data~lam-data' + /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/smf-selection-subscription-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l%7BservingPlmnId%7D~lprovisioned-data~lsmf-selection-subscription-data' + /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sm-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l%7BservingPlmnId%7D~lprovisioned-data~lsm-data' + /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/lcs-bca-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l%7BservingPlmnId%7D~lprovisioned-data~llcs-bca-data' + /subscription-data/{ueId}/context-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lcontext-data' + /subscription-data/{ueId}/context-data/amf-3gpp-access: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lcontext-data~lamf-3gpp-access' + /subscription-data/{ueId}/context-data/amf-non-3gpp-access: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lcontext-data~lamf-non-3gpp-access' + /subscription-data/{ueId}/context-data/smf-registrations: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lcontext-data~lsmf-registrations' + /subscription-data/{ueId}/context-data/smf-registrations/{pduSessionId}: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lcontext-data~lsmf-registrations~l%7BpduSessionId%7D' + /subscription-data/{ueId}/operator-specific-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~loperator-specific-data' + /subscription-data/{ueId}/context-data/smsf-3gpp-access: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lcontext-data~lsmsf-3gpp-access' + /subscription-data/{ueId}/context-data/smsf-non-3gpp-access: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lcontext-data~lsmsf-non-3gpp-access' + /subscription-data/{ueId}/context-data/location: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lcontext-data~llocation' + /subscription-data/{ueId}/context-data/ip-sm-gw: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lcontext-data~lip-sm-gw' + /subscription-data/{ueId}/context-data/mwd: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lcontext-data~lmwd' + /subscription-data/{ueId}/context-data/roaming-information: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lcontext-data~lroaming-information' + /subscription-data/{ueId}/context-data/pei-info: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lcontext-data~lpei-info' + /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sms-mng-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l%7BservingPlmnId%7D~lprovisioned-data~lsms-mng-data' + /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sms-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l%7BservingPlmnId%7D~lprovisioned-data~lsms-data' + /subscription-data/{ueId}/lcs-privacy-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~llcs-privacy-data' + /subscription-data/{ueId}/lcs-mo-data: +``` + +``` +$ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l1cs-mo-data' +/subscription-data/{ueId}/1cs-subscription-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l1cs-subscription- +data' +/subscription-data/{ueId}/pp-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l1pp-data' +/subscription-data/{ueId}/context-data/ee-subscriptions: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l1context-data~lee- +subscriptions' +/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l1context-data~lee- +subscriptions~l%7BsubsId%7D' +/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/amf-subscriptions: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l1context-data~lee- +subscriptions~l%7BsubsId%7D~l1amf-subscriptions' +/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/smf-subscriptions: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l1context-data~lee- +subscriptions~l%7BsubsId%7D~l1smf-subscriptions' +/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/hss-subscriptions: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l1context-data~lee- +subscriptions~l%7BsubsId%7D~l1hss-subscriptions' +/subscription-data/group-data/{ueGroupId}/ee-subscriptions: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup- +data~l%7BueGroupId%7D~lee-subscriptions' +/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup- +data~l%7BueGroupId%7D~lee-subscriptions~l%7BsubsId%7D' +/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/amf-subscriptions: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup- +data~l%7BueGroupId%7D~lee-subscriptions~l%7BsubsId%7D~l1amf-subscriptions' +/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/smf-subscriptions: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup- +data~l%7BueGroupId%7D~lee-subscriptions~l%7BsubsId%7D~l1smf-subscriptions' +/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/hss-subscriptions: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup- +data~l%7BueGroupId%7D~lee-subscriptions~l%7BsubsId%7D~l1hss-subscriptions' +/subscription-data/group-data/{ueGroupId}/ee-profile-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup- +data~l%7BueGroupId%7D~lee-profile-data' +/subscription-data/group-data/5g-vn-groups: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup-data~l5g-vn-groups' +/subscription-data/group-data/5g-vn-groups/{externalGroupId}: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup-data~l5g-vn- +groups~l%7BexternalGroupId%7D' +/subscription-data/group-data/5g-vn-groups/internal: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup-data~l5g-vn- +groups~linternal' +/subscription-data/group-data/5g-vn-groups/pp-profile-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup-data~l5g-vn-groups~lpp- +profile-data' +/subscription-data/group-data/mbs-group-membership: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup-data~lmbs-group- +membership' +/subscription-data/group-data/mbs-group-membership/{externalGroupId}: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup-data~lmbs-group- +membership~l%7BexternalGroupId%7D' +/subscription-data/group-data/mbs-group-membership/internal: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup-data~lmbs-group- +membership~linternal' +/subscription-data/group-data/mbs-group-membership/pp-profile-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lgroup-data~lmbs-group- +membership~lpp-profile-data' +/subscription-data/{ueId}/ee-profile-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~lee-profile-data' +/subscription-data/{ueId}/context-data/sdm-subscriptions: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l1context-data~lsdm- +subscriptions' +/subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId}: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l1context-data~lsdm- +subscriptions~l%7BsubsId%7D' +/subscription-data/{ueId}/context-data/nidd-authorizations: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l1context- +data~lnidd-authorizations' +/subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId}/hss-sdm-subscriptions: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~l%7BueId%7D~l1context-data~lsdm- +subscriptions~l%7BsubsId%7D~lhss-sdm-subscriptions' +/subscription-data/shared-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~lsubscription-data~lshared-data' +``` + +``` + +/subscription-data/shared-data/{sharedDataId}: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1shared- +data~1%7BsharedDataId%7D' +/subscription-data/subs-to-notify: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1subs-to-notify' +/subscription-data/subs-to-notify/{subsId}: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1subs-to-notify~1%7BsubsId%7D' +/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/trace-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription- +data~1%7BueId%7D~1%7BservingPlmnId%7D~1provisioned-data~1trace-data' +/subscription-data/{ueId}/identity-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1identity-data' +/subscription-data/{ueId}/operator-determined-barring-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1operator- +determined-barring-data' +/subscription-data/{ueId}/nidd-authorization-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1nidd- +authorization-data' +/subscription-data/{ueId}/service-specific-authorization-data/{serviceType}: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1service-specific- +authorization-data~1%7BserviceType%7D' +/subscription-data/{ueId}/v2x-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1v2x-data' +/subscription-data/{ueId}/pp-profile-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1pp-profile-data' +/subscription-data/{ueId}/coverage-restriction-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1coverage- +restriction-data' +/subscription-data/group-data/group-identifiers: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1group-data~1group-identifiers' +/subscription-data/{ueId}/prose-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1prose-data' +/subscription-data/{ueId}/pp-data-store: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1pp-data-store' +/subscription-data/{ueId}/context-data/service-specific-authorizations/{serviceType}: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1context- +data~1service-specific-authorizations~1%7BserviceType%7D' +/subscription-data/{ueId}/5mbs-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~15mbs-data' +/subscription-data/{ueId}/uc-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1uc-data' +/subscription-data/{ueId}/time-sync-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1time-sync-data' +/subscription-data/{ueId}/ranging-slpos-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1ranging-slpos- +data' +/subscription-data/{ueId}/a2x-data: + $ref: 'TS29505_Subscription_Data.yaml#/paths/~1subscription-data~1%7BueId%7D~1a2x-data' +/policy-data/ues/{ueId}: + $ref: 'TS29519_Policy_Data.yaml#/paths/~1policy-data~1ues~1%7BueId%7D' +/policy-data/ues/{ueId}/am-data: + $ref: 'TS29519_Policy_Data.yaml#/paths/~1policy-data~1ues~1%7BueId%7D~1am-data' +/policy-data/ues/{ueId}/ue-policy-set: + $ref: 'TS29519_Policy_Data.yaml#/paths/~1policy-data~1ues~1%7BueId%7D~1ue-policy-set' +/policy-data/ues/{ueId}/sm-data: + $ref: 'TS29519_Policy_Data.yaml#/paths/~1policy-data~1ues~1%7BueId%7D~1sm-data' +/policy-data/ues/{ueId}/sm-data/{usageMonId}: + $ref: 'TS29519_Policy_Data.yaml#/paths/~1policy-data~1ues~1%7BueId%7D~1sm- +data~1%7BusageMonId%7D' +/policy-data/sponsor-connectivity-data/{sponsorId}: + $ref: 'TS29519_Policy_Data.yaml#/paths/~1policy-data~1sponsor-connectivity- +data~1%7BsponsorId%7D' +/policy-data/bdt-data: + $ref: 'TS29519_Policy_Data.yaml#/paths/~1policy-data~1bdt-data' +/policy-data/bdt-data/{bdtReferenceId}: + $ref: 'TS29519_Policy_Data.yaml#/paths/~1policy-data~1bdt-data~1%7BbdtReferenceId%7D' +/policy-data/subs-to-notify: + $ref: 'TS29519_Policy_Data.yaml#/paths/~1policy-data~1subs-to-notify' +/policy-data/subs-to-notify/{subsId}: + $ref: 'TS29519_Policy_Data.yaml#/paths/~1policy-data~1subs-to-notify~1%7BsubsId%7D' +/policy-data/ues/{ueId}/operator-specific-data: + $ref: 'TS29519_Policy_Data.yaml#/paths/~1policy-data~1ues~1%7BueId%7D~1operator-specific-data' +/application-data/pfds: + $ref: 'TS29519_Application_Data.yaml#/paths/~1application-data~1pfds' +/application-data/pfds/{appId}: + $ref: 'TS29519_Application_Data.yaml#/paths/~1application-data~1pfds~1%7BappId%7D' +/application-data/influenceData: + $ref: 'TS29519_Application_Data.yaml#/paths/~1application-data~1influenceData' + +``` + +``` + +# The path segment is left not following the naming convention as defined in 3GPP TS 29.501 due to +backward compatibility consideration. +/application-data/influenceData/{influenceId}: + $ref: 'TS29519_Application_Data.yaml#/paths/~lapplication- +data~linfluenceData~l%7BinfluenceId%7D' +# The path segment is left not following the naming convention as defined in 3GPP TS 29.501 due to +backward compatibility consideration. +/policy-data/plmns/{plmnId}/ue-policy-set: + $ref: 'TS29519_Policy_Data.yaml#/paths/~lpolicy-data~lplmns~l%7BplmnId%7D~lue-policy-set' +/application-data/bdtPolicyData: + $ref: 'TS29519_Application_Data.yaml#/paths/~lapplication-data~lbdtPolicyData' +# The path segment is left not following the naming convention as defined in 3GPP TS 29.501 due to +backward compatibility consideration. +/application-data/bdtPolicyData/{bdtPolicyId}: + $ref: 'TS29519_Application_Data.yaml#/paths/~lapplication- +data~lbdtPolicyData~l%7BbdtPolicyId%7D' +# The path segment is left not following the naming convention as defined in 3GPP TS 29.501 due to +backward compatibility consideration. +/application-data/iptvConfigData: + $ref: 'TS29519_Application_Data.yaml#/paths/~lapplication-data~liptvConfigData' +# The path segment is left not following the naming convention as defined in 3GPP TS 29.501 due to +backward compatibility consideration. +/application-data/iptvConfigData/{configurationId}: + $ref: 'TS29519_Application_Data.yaml#/paths/~lapplication- +data~liptvConfigData~l%7BconfigurationId%7D' +# The path segment is left not following the naming convention as defined in 3GPP TS 29.501 due to +backward compatibility consideration. +/application-data/serviceParamData: + $ref: 'TS29519_Application_Data.yaml#/paths/~lapplication-data~lserviceParamData' +# The path segment is left not following the naming convention as defined in 3GPP TS 29.501 due to +backward compatibility consideration. +/application-data/serviceParamData/{serviceParamId}: + $ref: 'TS29519_Application_Data.yaml#/paths/~lapplication- +data~lserviceParamData~l%7BserviceParamId%7D' +# The path segment is left not following the naming convention as defined in 3GPP TS 29.501 due to +backward compatibility consideration. +/application-data/influenceData/subs-to-notify: + $ref: 'TS29519_Application_Data.yaml#/paths/~lapplication-data~linfluenceData~lsubs-to-notify' +# The path segment is left not following the naming convention as defined in 3GPP TS 29.501 due to +backward compatibility consideration. +/application-data/influenceData/subs-to-notify/{subscriptionId}: + $ref: 'TS29519_Application_Data.yaml#/paths/~lapplication-data~linfluenceData~lsubs-to- +notify~l%7BsubscriptionId%7D' +# The path segment is left not following the naming convention as defined in 3GPP TS 29.501 due to +backward compatibility consideration. +/application-data/subs-to-notify: + $ref: 'TS29519_Application_Data.yaml#/paths/~lapplication-data~lsubs-to-notify' +/application-data/subs-to-notify/{subsId}: + $ref: 'TS29519_Application_Data.yaml#/paths/~lapplication-data~lsubs-to-notify~l%7BsubsId%7D' +/exposure-data/{ueId}/access-and-mobility-data: + $ref: 'TS29519_Exposure_Data.yaml#/paths/~lexposure-data~l%7BueId%7D~laccess-and-mobility-data' +/exposure-data/{ueId}/session-management-data/{pduSessionId}: + $ref: 'TS29519_Exposure_Data.yaml#/paths/~lexposure-data~l%7BueId%7D~lsession-management- +data~l%7BpduSessionId%7D' +/exposure-data/subs-to-notify: + $ref: 'TS29519_Exposure_Data.yaml#/paths/~lexposure-data~lsubs-to-notify' +/exposure-data/subs-to-notify/{subId}: + $ref: 'TS29519_Exposure_Data.yaml#/paths/~lexposure-data~lsubs-to-notify~l%7BsubId%7D' +/data-restoration-events: + post: + # This is a pseudo operation, clients shall NOT invoke this method! + summary: subscribe to data restoration notifications + operationId: CreateIndividualSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: {} + responses: + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + restorationNotification: + '{dataRestorationCallbackUri}': + # The URI in {dataRestorationCallbackUri} is the default endpoint discovered from NRF. + post: + +``` + +``` + + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataRestorationNotification' + responses: + '204': + description: No Content, Notification was successful + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + NF service consumer' + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + NF service consumer' + required: true + schema: + type: string + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudr-dr: Access to the Nudr_DataRepository API + nudr-dr:subscription-data: Access to the SubscriptionData data set + nudr-dr:subscription-data:authentication-subscription:read: Access to read the +AuthenticationSubscription resource of the SubscriptionData data set + nudr-dr:subscription-data:authentication-subscription:modify: Access to update the +AuthenticationSubscription resource of the SubscriptionData data set + nudr-dr:subscription-data:registrations:write: Write access to NF registration resources +of the SubscriptionData data set + nudr-dr:policy-data: Access to the PolicyData data set + nudr-dr:policy-data:ues:read: Access to read the UEs resource + nudr-dr:policy-data:ues:am-data:read: Access to read the UEs Access and Mobility policy +data + nudr-dr:policy-data:ues:ue-policy-set:read: Access to read the UEs Policy Set data + nudr-dr:policy-data:ues:ue-policy-set:create: Access to create the UEs Policy Set data + nudr-dr:policy-data:ues:ue-policy-set:modify: Access to update the UEs Policy Set data + nudr-dr:policy-data:ues:sm-data:read: Access to read the UEs Session Management Policy +data + nudr-dr:policy-data:ues:sm-data:modify: Access to update the UEs Session Management +Policy data + nudr-dr:policy-data:ues:sm-data:create: Access to create the UEs Session Management +Policy data + nudr-dr:policy-data:sponsor-connectivity-data:read: Access to read the sponsored +Connectivity Data + nudr-dr:policy-data:bdtd-data:read: Access to read the BDT data resource + nudr-dr:policy-data:bdtd-data:create: Access to create the BDT data resource + nudr-dr:policy-data:bdtd-data:modify: Access to update the BDT data resource + nudr-dr:policy-data:subs-to-notify:create: Access to create Subscriptions resources + nudr-dr:policy-data:subs-to-notify:modify: Access to update Subscriptions resources + nudr-dr:policy-data:ues:operator-specific-data:read: Access to read the UEs operator +specific policy data + +``` + +nudr-dr:policy-data:ues:operator-specific-data:modify: Access to update the UEs operator specific policy data + nudr-dr:policy-data:ues:operator-specific-data:create: Access to create the UEs operator specific policy data + nudr-dr:policy-data:slice-control-data:read: Access to read Slice specific Policy Control Data + nudr-dr:policy-data:slice-control-data:modify: Access to update Slice specific Policy Control Data + nudr-dr:policy-data:group-control-data:read: Access to read Group Control Data + nudr-dr:policy-data:group-control-data:modify: Access to update Group Control Data + nudr-dr:exposure-data: Access to the ExposureData data set + nudr-dr:exposure-data:access-and-mobility-data:create: Access to create ExposureData + nudr-dr:exposure-data:access-and-mobility-data:read: Access to read ExposureData + nudr-dr:exposure-data:access-and-mobility-data:modify: Access to update ExposureData + nudr-dr:exposure-data:session-management-data:create: Access to create ExposureData + nudr-dr:exposure-data:session-management-data:read: Access to read ExposureData + nudr-dr:exposure-data:session-management-data:modify: Access to update ExposureData + nudr-dr:exposure-data:subs-to-notify:create: Access to create Subscriptions resources + nudr-dr:exposure-data:subs-to-notify:modify: Access to update Subscriptions resources + nudr-dr:application-data: Access to the ApplicationData data set + nudr-dr:application-data:pfds:read: Access to read PFDData + nudr-dr:application-data:pfds:modify: Access to update PFDData + nudr-dr:application-data:pfds:create: Access to create PFDData + nudr-dr:application-data:influence-data:read: Access to read Traffic Influence Data + nudr-dr:application-data:influence-data:create: Access to create Traffic Influence Data. + nudr-dr:application-data:influence-data:modify: Access to update Traffic Influence Data + nudr-dr:application-data:influence-data:subscriptions:read: Access to read Traffic Influence Data Subscriptions + nudr-dr:application-data:influence-data:subscriptions:create: Access to create Traffic Influence Data Subscriptions + nudr-dr:application-data:influence-data:subscriptions:modify: Access to update Traffic Influence Data Subscriptions + nudr-dr:application-data:bdtpolicy-data:read: Access to read BDT Policy Data + nudr-dr:application-data:bdtpolicy-data:create: Access to create BDT Policy Data + nudr-dr:application-data:bdtpolicy-data:modify: Access to update BDT Policy Data + nudr-dr:application-data:iptv-config-data:read: Access to read IPTV Configuration Data + nudr-dr:application-data:iptv-config-data:create: Access to create IPTV Configuration Data + nudr-dr:application-data:iptv-config-data:modify: Access to update IPTV Configuration Data + nudr-dr:application-data:service-param-data:read: Access to read Service Parameter Data + nudr-dr:application-data:service-param-data:create: Access to create Service Parameter Data + nudr-dr:application-data:service-param-data:modify: Access to update Service Parameter Data + nudr-dr:application-data:am-influence-data:read: Access to read AM Influence Data + nudr-dr:application-data:am-influence-data:create: Access to create AM Influence Data + nudr-dr:application-data:am-influence-data:modify: Access to update AM Influence Data + nudr-dr:application-data:subs-to-notify:create: Access to create Subscriptions resources + nudr-dr:application-data:subs-to-notify:read: Access to read Subscriptions resources + nudr-dr:application-data:subs-to-notify:modify: Access to update Subscriptions resources + nudr-dr:application-data:eas-deploy-data:read: Access to read EAS Deployment Information Data + nudr-dr:application-data:eas-deploy-data:create: Access to create EAS Deployment Information Data + nudr-dr:application-data:eas-deploy-data:modify: Access to update EAS Deployment Information Data + nudr-dr:application-data:ecs-address-roaming:read: Access to read ECS Address Roaming Data + nudr-dr:application-data:ecs-address-roaming:create: Access to create ECS Address Roaming Data + nudr-dr:application-data:ecs-address-roaming:modify: Access to update ECS Address Roaming Data + nudr-dr:application-data:dnaieas:read: Access to read DNAI-EAS Mapping Data + nudr-dr:application-data:af-qos-data-sets:read: Access to read AF Qos Data Sets + nudr-dr:application-data:af-qos-data-sets:create: Access to create AF Qos Data Sets + nudr-dr:application-data:af-qos-data-sets:modify: Access to update AF Qos Data Sets + +schemas: + DataRestorationNotification: + description: Contains identities representing those UEs potentially affected by a data-loss event at the UDR + type: object + properties: + supiRanges: + type: array + items: + \$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/SupiRange' + +``` + minItems: 1 + gsiRanges: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IdentityRange' + minItems: 1 + resetIds: + type: array + items: + type: string + minItems: 1 + sNssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + udrGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' +``` + +## --- A.3 Nudr\_GroupIDmap API + +``` +openapi: 3.0.0 + +info: + version: 1.2.0-alpha.2 + title: 'Nudr_GroupIDmap' + description: | + Unified Data Repository Service for NF-Group ID retrieval. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.504 V18.4.0; 5G System; Unified Data Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.504/' + +servers: + - description: API root + url: '{apiRoot}/nudr-group-id-map/v1' + variables: + apiRoot: + default: https://example.com + +security: + - {} + - oAuth2ClientCredentials: + - nudr-group-id-map + +paths: + /nf-group-ids: + get: + summary: Retrieves NF-Group IDs for provided Subscriber and NF types + operationId: GetNfGroupIDs + tags: + - NF Group IDs (Document) + parameters: + - name: nf-type + in: query + description: Type of NF + required: true + style: form + explode: false + schema: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + minItems: 1 + - name: subscriberId +# The name of this query parameter is left not following the naming convention as defined in 3GPP TS +29.501 due to backward compatibility consideration. +``` + +``` +in: query +description: Identifier of the subscriber +required: true +schema: + $ref: '#/components/schemas/SubscriberId' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/NfGroupIdMapResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/routing-ids: + get: + summary: Retrieves Routing Indicators for the provided NF type and NF Group ID + operationId: GetRoutingIDs + tags: + - Routing IDs (Document) + parameters: + - name: nf-type + in: query + description: Type of NF + required: true + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + - name: nf-group-id + in: query + description: Identifier of the NF Group + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingIdResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: +``` + +``` + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nudr-group-id-map: Access to the Nudr_GroupIDmap API + +schemas: + +# STRUCTURED TYPES: + + NfGroupIdMapResult: + description: > + Contains the NfGroupIds for the requested NF types. The NFType is the key of the map. + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + minProperties: 1 + + RoutingIdResult: + description: > + Contains the Routing Indicators for the requested NF type and NF Group ID. + type: object + properties: + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + +# SIMPLE TYPES: + + SubscriberId: + description: > + Represents the Subscription Identifier SUPI or GPSI or IMPI or IMPU, or Routing Indicator. + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^\@]+\+|impi-.+|impu-.+|rid-[0-9]{1,4}|.+)$' + +# ENUMS: +``` + +# Annex B (Normative): ABNF grammar for 3GPP SBI HTTP custom headers + +## B.1 General + +This Annex contains a self-contained set of ABNF rules, comprising the re-used rules from IETF RFCs, and the rules defined by the 3GPP custom headers defined in this specification (see clause 6.1.2.3). + +This grammar may be used as input to existing tools to help implementations to parse 3GPP custom headers. + +## B.2 ABNF definitions (Filename: "TS29504\_CustomHeaders.abnf") + +``` +; ----- +; RFC 5234 +; ----- + +HTAB = %x09 ; horizontal tab + +LF = %x0A ; linefeed + +CR = %x0D ; carriage return + +SP = %x20 + +DQUOTE = %x22 ; " (Double Quote) + +DIGIT = %x30-39 ; 0-9 + +ALPHA = %x41-5A / %x61-7A ; A-Z / a-z + +VCHAR = %x21-7E ; visible (printing) characters + +WSP = SP / HTAB ; white space + +CRLF = CR LF ; Internet standard newline + +; ----- +; RFC 5322 +; ----- + +obs-FWS = 1*WSP *( CRLF 1*WSP ) + +FWS = ( [ *WSP CRLF ] 1*WSP ) / obs-FWS + +obs-NO-WS-CTL = %d1-8 / %d11 / %d12 / %d14-31 / %d127 + +obs-ctext = obs-NO-WS-CTL + +ctext = %d33-39 / %d42-91 / %d93-126 / obs-ctext + +obs-qp = "\" ( obs-NO-WS-CTL / LF / CR ) + +quoted-pair = ( "\" ( VCHAR / WSP ) ) / obs-qp + +ccontent = ctext / quoted-pair / comment + +comment = "(" *( [ FWS ] ccontent ) [ FWS ] ")" + +; ----- +; RFC 9110 +; ----- +``` + +``` + +OWS = *( SP / HTAB ) + +tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" + / "." / "^" / "_" / "`" / "|" / "~" / DIGIT / ALPHA + +token = 1*tchar + +obs-text = %x80-FF + +; ----- +; RFC 9110 +; ----- + +entity-tag = [ weak ] opaque-tag + +weak = %x57.2F ; "W/", case-sensitive + +opaque-tag = DQUOTE *etagc DQUOTE + +etagc = %x21 / %x23-7E / obs-text ; VCHAR except double quotes, plus obs-text + +; ----- +; 3GPP TS 29.504 +; +; Version: 18.3.0 (September 2023) +; +; (c) 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +; ----- + +; +; Header: 3gpp-Sbi-Notification-Correlation +; + +Sbi-Notification-Correlation-Header = "3gpp-Sbi-Notification-Correlation:" OWS subscriptionId + *( OWS "," OWS subscriptionId ) OWS + +subscriptionId = token + +; +; Header: 3gpp-Sbi-Etags +; + +Sbi-Etags-Header = "3gpp-Sbi-Etags:" OWS datasetEtag *( OWS "," OWS datasetEtag ) OWS + +datasetEtag = dataSetName "=" entity-tag + +dataSetName = UeSubscribedDataSetName + +UeSubscribedDataSetName = 1*( ALPHA / DIGIT / "_" ) + +``` + +# --- Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-01 | CT4#82 | C4-181365 | | | | TS skeleton | 0.0.0 | +| 2018-01 | CT4#82 | C4-181396 | | | | Inclusion of pCRs agreed at CT4#82, including C4-181366, C4-181367, C4-181323 and C4-181385. | 0.1.0 | +| 2018-03 | CT4#83 | C4-182441 | | | | Inclusion of pCRs agreed at CT4#83, including C4-182337, C4-182429. | 0.2.0 | +| 2018-04 | CT4#84 | C4-183522 | | | | Inclusion of pCRs agreed at CT4#84, including C4-183497, C4-183295, C4-183296, C4-183297, C4-183102, C4-183420, C4-183498. | 0.3.0 | +| 2018-05 | CT4#85 | C4-184636 | | | | Inclusion of pCRs agreed at CT4#85, including C4-184482, C4-184484, C4-184167, C4-184168, C4-184489, C4-184564, C4-184637. | 0.4.0 | +| 2018-06 | CT#80 | CP-181102 | | | | Presented for information and approval | 1.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | +| 2018-09 | CT#81 | CP-182057 | 0002 | 1 | F | Service Name | 15.1.0 | +| 2018-09 | CT#81 | CP-182057 | 0006 | 2 | F | Supported Features Negotiation | 15.1.0 | +| 2018-09 | CT#81 | CP-182057 | 0004 | 2 | F | Error handling in UDR | 15.1.0 | +| 2018-09 | CT#81 | CP-182211 | 0003 | 4 | | OpenAPI file for Nudr_DataRepository API | 15.1.0 | +| 2018-10 | CT#82 | CP-183015 | 0008 | - | F | Update the Reference point name | 15.2.0 | +| 2018-10 | CT#82 | CP-183015 | 0009 | - | F | Introduction of Barring of Roaming in 5GC | 15.2.0 | +| 2018-10 | CT#82 | CP-183015 | 0010 | 1 | F | Shared Data | 15.2.0 | +| 2018-10 | CT#82 | CP-183015 | 0011 | - | | Get multiple datasets for ProvisionedData | 15.2.0 | +| 2018-10 | CT#82 | CP-183015 | 0012 | 1 | F | Definition of Authentication Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183015 | 0013 | 1 | F | Adding headers for cache control and conditional request to the Nudr Services API | 15.2.0 | +| 2018-12 | CT#82 | CP-183015 | 0014 | - | | APIRoot Clarification | 15.2.0 | +| 2018-12 | CT#82 | CP-183015 | 0015 | 2 | F | lifetime of subscription | 15.2.0 | +| 2018-12 | CT#82 | CP-183015 | 0016 | 1 | F | Authorized Event Types | 15.2.0 | +| 2018-12 | CT#82 | CP-183015 | 0017 | - | | Group Subscription Path | 15.2.0 | +| 2018-12 | CT#82 | CP-183177 | 0018 | 2 | F | PLMN ID as key for UE data sets | 15.2.0 | +| 2018-12 | CT#82 | CP-183241 | 0020 | 1 | F | Correction to Nudr_DataRepository service OpenAPI | 15.2.0 | +| 2019-03 | CT#83 | CP-190020 | 0021 | 1 | | CR 0018r2 was not implemented | 15.3.0 | +| 2019-03 | CT#83 | CP-190020 | 0022 | 2 | | Corrections on openAPI | 15.3.0 | +| 2019-03 | CT#83 | CP-190020 | 0023 | | | UDR Application Errors | 15.3.0 | +| 2019-03 | CT#83 | CP-190020 | 0025 | 1 | | Missing URLs in UDR API | 15.3.0 | +| 2019-03 | CT#83 | CP-190172 | 0026 | 1 | | 3GPP TS 29.504 API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191031 | 0027 | - | F | Content Type | 15.4.0 | +| 2019-06 | CT#84 | CP-191031 | 0028 | - | F | UE Parameter Update (UPU) | 15.4.0 | +| 2019-06 | CT#84 | CP-191031 | 0030 | 1 | F | Group Identifier Translation | 15.4.0 | +| 2019-06 | CT#84 | CP-191031 | 0032 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191031 | 0034 | 1 | F | Missing Context Path | 15.4.0 | +| 2019-06 | CT#84 | CP-191031 | 0035 | - | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CT#84 | CP-191031 | 0038 | - | F | 3GPP TS 29.504 API version update | 15.4.0 | +| 2019-06 | CT#84 | CP-191031 | 0036 | 1 | F | Resource notification features for Policy and Exposure Data | 15.4.0 | +| 2019-06 | CT#84 | CP-191048 | 0037 | - | F | 3GPP TS 29.504 API version update | 16.0.0 | +| 2019-06 | CT#84 | CP-191051 | 0029 | 1 | B | PFD extension for domain name | 16.0.0 | +| 2019-09 | CT#85 | CP-192133 | 0040 | - | B | Closed Access Group | 16.1.0 | +| 2019-09 | CT#85 | CP-192133 | 0041 | - | B | VN-Group parameter provisioning | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0042 | - | B | Conditional POST / PUT / PATCH / DELETE requests | 16.1.0 | +| 2019-09 | CT#85 | CP-192190 | 0048 | 1 | B | New supported features for xBDT | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0049 | 1 | B | Support a set of MAC addresses in traffic filter | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0050 | 1 | B | Multiple temporal validity conditions for AF traffic influence | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0039 | 1 | B | Network Slicing Subscription Change | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0044 | 1 | F | UDR Application Errors | 16.1.0 | +| 2019-09 | CT#85 | CP-192104 | 0054 | 1 | A | Correction on Feature numbers | 16.1.0 | +| 2019-09 | CT#85 | CP-192120 | 0056 | - | F | 3GPP TS 29.504 API version update | 16.1.0 | +| 2019-10 | - | - | - | - | - | TS outlook fixed | 16.1.1 | +| 2019-12 | CT#86 | CP-193028 | 0066 | | A | Wrong YAML Structure of OpenAPI 'info' Clause | 16.2.0 | +| 2019-12 | CT#86 | CP-193028 | 0068 | | A | CR 0026r1 was not correctly implemented | 16.2.0 | +| 2019-12 | CT#86 | CP-193039 | 0070 | 1 | B | Update Application Data Resources | 16.2.0 | +| 2019-12 | CT#86 | CP-193044 | 0073 | | F | 3GPP TS 29.504 API version update | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0069 | 1 | B | NIDD Authorization Data | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0060 | 1 | B | LCS Private | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0061 | 1 | B | Mobile Originated Data | 16.2.0 | +| 2019-12 | CT#86 | CP-193060 | 0058 | 1 | B | Missed URLLC feature from Application Data | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0059 | | B | Patch Report Feature | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0057 | 2 | F | Clarification on Implicit Subscriptions to Notifications | 16.2.0 | +| 2019-12 | CT#86 | CP-193130 | 0064 | 2 | B | Nudr_GroupIDmap Service | 16.2.0 | +| 2019-12 | CT#86 | CP-193064 | 0063 | 1 | B | Definition of SessionManagementPolicyDataPatch feature | 16.2.0 | +| 2020-03 | CT#87 | CP-200020 | 0079 | | B | Mute Notifications | 16.3.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|---------------------------------------------------------------------------------|--------| +| 2020-03 | CT#87 | CP-200039 | 0074 | 2 | F | Add Corresponding API descriptions in clause 5.1 | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0080 | 1 | B | Definition of ConditionalSubscription and NotificationResourceFragment features | 16.3.0 | +| 2020-03 | CT#87 | CP-200052 | 0082 | | F | 3GPP TS 29.504 Rel16 API version and External doc update | 16.3.0 | +| 2020-03 | CT#87 | CP-200098 | 0083 | | B | Definition of EnhancedInfluDataNotification feature | 16.3.0 | +| 2020-06 | CT#88-e | CP-201046 | 0084 | | B | Coverage restriction data resource | 16.4.0 | +| 2020-06 | CT#88-e | CP-201032 | 0086 | | B | Location information retrieval for GMLC | 16.4.0 | +| 2020-06 | CT#88-e | CP-201032 | 0087 | | B | Resource LcsPrivacySubscriptionData | 16.4.0 | +| 2020-06 | CT#88-e | CP-201071 | 0088 | | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88-e | CP-201020 | 0090 | | A | Definition of OpSpecDataMapNotification feature | 16.4.0 | +| 2020-06 | CT#88-e | CP-201049 | 0091 | | B | Correction on V2X Subscription data | 16.4.0 | +| 2020-06 | CT#88-e | CP-201034 | 0093 | | F | Cardinality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88-e | CP-201034 | 0094 | | B | Resource Level Authorization | 16.4.0 | +| 2020-06 | CT#88-e | CP-201033 | 0095 | | B | Support of SMSIoP | 16.4.0 | +| 2020-06 | CT#88-e | CP-201032 | 0096 | | F | Mobile Originated Data retrieval | 16.4.0 | +| 2020-06 | CT#88-e | CP-201034 | 0097 | | F | New feature of per UE per serving network authEvent | 16.4.0 | +| 2020-06 | CT#88-e | CP-201073 | 0098 | | F | 29.504 Rel16 API version and External doc update | 16.4.0 | +| 2020-09 | CT#89-e | CP-202110 | 100 | | F | Scopes for Resource Level Authorization | 16.5.0 | +| 2020-09 | CT#89-e | CP-202112 | 104 | | F | Store Broadcast Location Assistance Data | 16.5.0 | +| 2020-09 | CT#89-e | CP-202110 | 105 | 1 | F | Corrections with regard to references | 16.5.0 | +| 2020-09 | CT#89-e | CP-202096 | 107 | | F | API version and External doc update | 16.5.0 | +| 2020-09 | CT#89-e | CP-202123 | 101 | | B | Resource Level Authorization for Data Sets | 17.0.0 | +| 2020-09 | CT#89-e | CP-202123 | 102 | | B | Resource Level Authorization for registrations | 17.0.0 | +| 2020-09 | CT#89-e | CP-202120 | 106 | | B | API version and External doc update | 17.0.0 | +| 2020-12 | CT#90-e | CP-203049 | 0111 | 1 | A | HSS can consume UDR services | 17.1.0 | +| 2020-12 | CT#90-e | CP-203042 | 0113 | | A | 5G VN Groups | 17.1.0 | +| 2020-12 | CT#90-e | CP-203035 | 0115 | | A | Storage of YAML files in 3GPP Forge | 17.1.0 | +| 2020-12 | CT#90-e | CP-203061 | 0117 | | B | Data retrieval of multiple policy data sets | 17.1.0 | +| 2020-12 | CT#90-e | CP-203055 | 0119 | | F | Rel17 API version and External doc update | 17.1.0 | +| 2021-03 | CT#91-e | CP-210021 | 0120 | | F | SCP may consume Nudr service | 17.2.0 | +| 2021-03 | CT#91-e | CP-210043 | 0122 | 1 | A | Incorrect NfGroupIds definition and missing UDR access paths | 17.2.0 | +| 2021-03 | CT#91-e | CP-210021 | 0123 | 1 | B | Add Feature for Session Management Policy Data per PLMN | 17.2.0 | +| 2021-03 | CT#91-e | CP-210034 | 0124 | 1 | F | OpenAPI Reference and description field for map data types | 17.2.0 | +| 2021-03 | CT#91-e | CP-210048 | 0126 | | A | SMF Events Storage Resource Path | 17.2.0 | +| 2021-03 | CT#91-e | CP-210029 | 0127 | | F | 29.504 Rel-17 API version and External doc update | 17.2.0 | +| 2021-06 | CT#92-e | CP-211028 | 0130 | 1 | F | Change Notification of Array to Stateless UDM | 17.3.0 | +| 2021-06 | CT#92-e | CP-211028 | 0142 | | F | Data Types Descriptions | 17.3.0 | +| 2021-06 | CT#92-e | CP-211031 | 0131 | 1 | B | Support of User Plane Latency requirements | 17.3.0 | +| 2021-06 | CT#92-e | CP-211039 | 0132 | | B | Store ProSe Subscription Data | 17.3.0 | +| 2021-06 | CT#92-e | CP-211039 | 0144 | | B | Add new ProSe feature | 17.3.0 | +| 2021-06 | CT#92-e | CP-211045 | 0141 | | B | Correction to OSD Handling | 17.3.0 | +| 2021-06 | CT#92-e | CP-211045 | 0143 | | B | New feature ConditionalSubscriptionWithExcludeNotification | 17.3.0 | +| 2021-06 | CT#92-e | CP-211050 | 0145 | | F | 29.504 Rel-17 API version and External doc update | 17.3.0 | +| 2021-06 | CT#92-e | CP-211059 | 0140 | 1 | F | Correction to Charging Information | 17.3.0 | +| 2021-06 | CT#92-e | CP-211079 | 0134 | | A | Subscribed EE profile data for a group | 17.3.0 | +| 2021-06 | CT#92-e | CP-211079 | 0136 | | A | Subscribed PP profile data for 5g-VN-group | 17.3.0 | +| 2021-06 | CT#92-e | CP-211079 | 0138 | | A | Subscribed PP profile data | 17.3.0 | +| 2021-09 | CT#93-e | CP-212030 | 0148 | 1 | B | New feature for NSAC | 17.4.0 | +| 2021-09 | CT#93-e | CP-212049 | 0150 | 1 | B | Get the PP data of multiple Afs | 17.4.0 | +| 2021-09 | CT#93-e | CP-212059 | 0151 | | F | 29.504 Rel-17 API version and External doc update | 17.4.0 | +| 2021-09 | CT#93-e | CP-212064 | 0154 | | A | SharedDataId Resource | 17.4.0 | +| 2021-12 | CT#94-e | CP-213085 | 0156 | | B | UE Subscription Data Sets Retrieve | 17.5.0 | +| 2021-12 | CT#94-e | CP-213085 | 0157 | | F | Corrections to the API URI | 17.5.0 | +| 2021-12 | CT#94-e | CP-213085 | 0159 | | B | Share Session Management Subscription Data | 17.5.0 | +| 2021-12 | CT#94-e | CP-213086 | 0163 | | F | NIDD Authorization data storage | 17.5.0 | +| 2021-12 | CT#94-e | CP-213086 | 0167 | | F | Subscription update | 17.5.0 | +| 2021-12 | CT#94-e | CP-213087 | 0168 | | B | Update Roaming Status in EPC | 17.5.0 | +| 2021-12 | CT#94-e | CP-213087 | 0162 | 1 | F | Consumer service logic | 17.5.0 | +| 2021-12 | CT#94-e | CP-213088 | 0166 | 1 | A | Naming Convention | 17.5.0 | +| 2021-12 | CT#94-e | CP-213093 | 0155 | 1 | B | Support for Service Specific Authorization | 17.5.0 | +| 2021-12 | CT#94-e | CP-213093 | 0164 | | B | Supported Features needed for the Enhanced Edge Computing functionality | 17.5.0 | +| 2021-12 | CT#94-e | CP-213097 | 0158 | | B | Store 5MBS Subscription Data | 17.5.0 | +| 2021-12 | CT#94-e | CP-213121 | 0169 | | F | 29.504 Rel-17 API version and External doc update | 17.5.0 | +| 2021-12 | CT#94-e | CP-213136 | 0161 | | A | Path definitions | 17.5.0 | +| 2022-03 | CT#95-e | CP-220023 | 0176 | | F | Resource paths in Group Subscription Storage | 17.6.0 | +| 2022-03 | CT#95-e | CP-220031 | 0179 | 1 | B | Handling of supported features for Edge Computing | 17.6.0 | +| 2022-03 | CT#95-e | CP-220036 | 0174 | 1 | B | UDR restoration notification | 17.6.0 | +| 2022-03 | CT#95-e | CP-220041 | 0173 | | B | SOR-AF as NF consumer of UDR | 17.6.0 | +| 2022-03 | CT#95-e | CP-220042 | 0178 | 1 | B | UDR features for TSC and DCAMP | 17.6.0 | +| 2022-03 | CT#95-e | CP-220047 | 0172 | 1 | B | New value for 404 status code | 17.6.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|---------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95-e | CP-220049 | 0175 | 1 | B | User Consent subscription | 17.6.0 | +| 2022-03 | CT#95-e | CP-220066 | 0181 | | F | 29.504 Rel-17 API version and External doc update | 17.6.0 | +| 2022-03 | CT#95-e | CP-220090 | 0180 | | F | Update incorrect NOTE format | 17.6.0 | +| 2022-06 | CT#96-e | CP-221025 | 0191 | 1 | F | UDR Restoration | 17.7.0 | +| 2022-06 | CT#96-e | CP-221028 | 0185 | 1 | F | Logical Relationship of Query Parameters | 17.7.0 | +| 2022-06 | CT#96-e | CP-221028 | 0186 | 1 | F | OAuth2 scopes for policy data | 17.7.0 | +| 2022-06 | CT#96-e | CP-221028 | 0189 | | F | OAuth2 scopes for exposure data | 17.7.0 | +| 2022-06 | CT#96-e | CP-221029 | 0188 | 1 | F | OAuth2 scopes for application data | 17.7.0 | +| 2022-06 | CT#96-e | CP-221029 | 0190 | 1 | F | UDM to support Optimized EventExposure Subscriptions Data access over Nudr | 17.7.0 | +| 2022-06 | CT#96-e | CP-221034 | 0184 | 1 | F | Missing supported features in Nudr service | 17.7.0 | +| 2022-06 | CT#96-e | CP-221051 | 0193 | | F | 29.504 Rel-17 API version and External doc update | 17.7.0 | +| 2022-06 | CT#96-e | CP-221052 | 0192 | | F | Update of description of feature ConditionalSubscriptionWithExcludeNotification | 17.7.0 | +| 2022-06 | CT#96-e | CP-221057 | 0183 | | F | FilterAnyUE feature | 17.7.0 | +| 2022-09 | CT#97-e | CP-222057 | 0194 | | F | PEI Information | 17.8.0 | +| 2022-09 | CT#97-e | CP-222058 | 0195 | | F | 29.504 Rel-17 API version and External doc update | 17.8.0 | +| 2022-12 | CT#98-e | CP-223027 | 0198 | | B | Immediate reporting for policy data | 18.0.0 | +| 2022-12 | CT#98-e | CP-223027 | 0197 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98-e | CP-223029 | 0196 | 1 | B | Immediate Report in subscribe response | 18.0.0 | +| 2022-12 | CT#98-e | CP-223033 | 0199 | | F | 29.504 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230029 | 0204 | | B | Retrieval of Provisioned data and Context data with a single GET request | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0205 | 1 | B | SuppFeatExt feature | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0206 | 2 | B | Granular UE Sets | 18.1.0 | +| 2023-03 | CT#99 | CP-230042 | 0201 | | B | Time Sync Subscription Data | 18.1.0 | +| 2023-03 | CT#99 | CP-230044 | 0208 | | B | Service Function Chaining support in Nudr interface | 18.1.0 | +| 2023-03 | CT#99 | CP-230071 | 0209 | | F | 29.504 Rel-18 API version and External doc update | 18.1.0 | +| 2023-03 | CT#99 | CP-230072 | 0203 | 1 | A | Removing of unnecessary feature | 18.1.0 | +| 2023-06 | CT#100 | CP-231025 | 0213 | | F | InternalGroupIdIdentifier in 5GVnGroupConfiguration | 18.2.0 | +| 2023-06 | CT#100 | CP-231026 | 0216 | | B | Definition of PolSubsRetrieval feature for Policy Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231029 | 0222 | 2 | B | Multiple Data Set retrieval with Etags | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0212 | 1 | B | Storage and Retrieval of LCS Subscription Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231033 | 0215 | | B | Add CommonEASDNAI feature | 18.2.0 | +| 2023-06 | CT#100 | CP-231049 | 0223 | 1 | B | Support of new feature "GMEC" in UDR | 18.2.0 | +| 2023-06 | CT#100 | CP-231051 | 0210 | 1 | B | Support for A2X service parameters provisioning | 18.2.0 | +| 2023-06 | CT#100 | CP-231052 | 0224 | | B | Ranging Sidelink Positioning Subscription data | 18.2.0 | +| 2023-06 | CT#100 | CP-231054 | 0214 | 2 | B | New feature URSP provisioning in EPS | 18.2.0 | +| 2023-06 | CT#100 | CP-231060 | 0211 | | B | Support for subscribed V2X policy data | 18.2.0 | +| 2023-06 | CT#100 | CP-231068 | 0221 | | B | DCAMP Roaming LBO feature | 18.2.0 | +| 2023-06 | CT#100 | CP-231070 | 0225 | | F | 29.504 Rel-18 API version and External doc update | 18.2.0 | +| 2023-06 | CT#100 | CP-231076 | 0220 | 1 | A | Update on Multicast MBS group membership management parameters | 18.2.0 | +| 2023-09 | CT#101 | CP-232033 | 0227 | 1 | F | Custom Header ABNF | 18.3.0 | +| 2023-09 | CT#101 | CP-232052 | 0236 | 1 | B | New feature for URSP enforcement and VPLMN specific URSP | 18.3.0 | +| 2023-09 | CT#101 | CP-232056 | 0228 | 1 | B | TNAP IDs support | 18.3.0 | +| 2023-09 | CT#101 | CP-232057 | 0233 | 1 | B | Add new feature for 5G ProSe Ph2 | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0234 | | B | New feature EnhancedUePolicy for Policy Data | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0237 | 1 | B | Feature support for Operator Specific Data in AccessandMobilityPolicyData | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0235 | 1 | B | New feature SLAMUP for Policy Data | 18.3.0 | +| 2023-09 | CT#101 | CP-232060 | 0238 | | F | 29.504 Rel-18 API version and External doc update | 18.3.0 | +| 2023-09 | CT#101 | CP-232067 | 0232 | 1 | A | Correction to ServiceParameterDataPatch data type | 18.3.0 | +| 2023-12 | CT#102 | CP-233029 | 0248 | | F | 3gpp-Sbi-Etags header clarification | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0252 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0245 | 2 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0255 | | F | Granular UE Sets | 18.4.0 | +| 2023-12 | CT#102 | CP-233038 | 0241 | 1 | B | DNAI-EAS Mappings data subset in the UDR | 18.4.0 | +| 2023-12 | CT#102 | CP-233038 | 0251 | | B | ECSAddressRoaming data subset | 18.4.0 | +| 2023-12 | CT#102 | CP-233047 | 0247 | 1 | B | Support the change of the PDU Session Type for a 5G VN group | 18.4.0 | +| 2023-12 | CT#102 | CP-233047 | 0249 | | B | Security Scopes for access to AF QoS Data | 18.4.0 | +| 2023-12 | CT#102 | CP-233047 | 0250 | | F | Security Scopes for group policy control data | 18.4.0 | +| 2023-12 | CT#102 | CP-233059 | 0244 | 1 | B | Mapping between Routing Indicator and NF Group ID | 18.4.0 | +| 2023-12 | CT#102 | CP-233059 | 0253 | 1 | B | Mapping between NF Group ID and list of Routing Indicators | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 0256 | | F | 29.504 Rel-18 API version and External doc update | 18.4.0 | +| 2023-12 | CT#102 | CP-233068 | 0243 | | A | Removal of SOR-AF as UDR consumer | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29505/raw.md b/raw/rel-18/29_series/29505/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..278ef489e0cf1629e899cb7f3b347d119f9afaa0 --- /dev/null +++ b/raw/rel-18/29_series/29505/raw.md @@ -0,0 +1,20247 @@ + + +# 3GPP TS 29.505 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Usage of the Unified Data Repository services for Subscription Data; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the letters is a red signal wave icon, and at the bottom, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------|----| +| Foreword..... | 13 | +| 1 Scope..... | 14 | +| 2 References..... | 14 | +| 3 Definitions and abbreviations..... | 15 | +| 3.1 Definitions..... | 15 | +| 3.2 Abbreviations..... | 15 | +| 4 Overview..... | 15 | +| 5 Usage of Nudr_DataRepository Service..... | 16 | +| 5.1 Introduction..... | 16 | +| 5.2 Resources..... | 17 | +| 5.2.1 Overview..... | 17 | +| 5.2.2 Resource: AuthenticationSubscription..... | 29 | +| 5.2.2.1 Description..... | 29 | +| 5.2.2.2 Resource Definition..... | 29 | +| 5.2.2.3 Resource Standard Methods..... | 30 | +| 5.2.2.3.1 GET..... | 30 | +| 5.2.2.3.2 PATCH..... | 30 | +| 5.2.3 Resource: AccessAndMobilitySubscriptionData..... | 31 | +| 5.2.3.1 Description..... | 31 | +| 5.2.3.2 Resource Definition..... | 31 | +| 5.2.3.3 Resource Standard Methods..... | 31 | +| 5.2.3.3.1 GET..... | 31 | +| 5.2.4 Resource: SmfSelectionSubscriptionData..... | 32 | +| 5.2.4.1 Description..... | 32 | +| 5.2.4.2 Resource Definition..... | 32 | +| 5.2.4.3 Resource Standard Methods..... | 33 | +| 5.2.4.3.1 GET..... | 33 | +| 5.2.5 Resource: SessionManagementSubscriptionData..... | 33 | +| 5.2.5.1 Description..... | 33 | +| 5.2.5.2 Resource Definition..... | 33 | +| 5.2.5.3 Resource Standard Methods..... | 34 | +| 5.2.5.3.1 GET..... | 34 | +| 5.2.6 Resource: Amf3GppAccessRegistration..... | 34 | +| 5.2.6.1 Description..... | 34 | +| 5.2.6.2 Resource Definition..... | 34 | +| 5.2.6.3 Resource Standard Methods..... | 35 | +| 5.2.6.3.1 PUT..... | 35 | +| 5.2.6.3.2 PATCH..... | 35 | +| 5.2.6.3.3 GET..... | 36 | +| 5.2.7 Resource: AmfNon3GppAccessRegistration..... | 36 | +| 5.2.7.1 Description..... | 36 | +| 5.2.7.2 Resource Definition..... | 37 | +| 5.2.7.3 Resource Standard Methods..... | 37 | +| 5.2.7.3.1 PUT..... | 37 | +| 5.2.7.3.2 PATCH..... | 37 | +| 5.2.7.3.3 GET..... | 38 | +| 5.2.8 Resource: SmfRegistrations..... | 39 | +| 5.2.8.1 Description..... | 39 | +| 5.2.8.2 Resource Definition..... | 39 | +| 5.2.8.3 Resource Standard Methods..... | 39 | +| 5.2.8.3.1 GET..... | 39 | +| 5.2.9 Resource: IndividualSmfRegistration..... | 39 | +| 5.2.9.1 Description..... | 39 | +| 5.2.9.2 Resource Definition..... | 40 | +| 5.2.9.3 Resource Standard Methods..... | 40 | + +| | | | +|-------------|----------------------------------------------|----| +| 5.2.9.3.1 | PUT..... | 40 | +| 5.2.9.3.2 | DELETE..... | 40 | +| 5.2.9.3.3 | GET..... | 41 | +| 5.2.9.3.4 | PATCH..... | 41 | +| 5.2.10 | Resource: OperatorSpecificData..... | 42 | +| 5.2.10.1 | Description..... | 42 | +| 5.2.10.2 | Resource Definition..... | 42 | +| 5.2.10.3 | Resource Standard Methods..... | 42 | +| 5.2.10.3.1 | GET..... | 42 | +| 5.2.10.3.2 | PATCH..... | 43 | +| 5.2.10.3.3 | PUT..... | 44 | +| 5.2.10.3.4 | DELETE..... | 44 | +| 5.2.11 | Resource: Smsf3GppAccessRegistration..... | 45 | +| 5.2.11.1 | Description..... | 45 | +| 5.2.11.2 | Resource Definition..... | 45 | +| 5.2.11.3 | Resource Standard Methods..... | 45 | +| 5.2.11.3.1 | PUT..... | 45 | +| 5.2.11.3.2 | DELETE..... | 46 | +| 5.2.11.3.4 | GET..... | 46 | +| 5.2.12 | Resource: SmsfNon3GppAccessRegistration..... | 47 | +| 5.2.12.1 | Description..... | 47 | +| 5.2.12.2 | Resource Definition..... | 47 | +| 5.2.12.3 | Resource Standard Methods..... | 47 | +| 5.2.12.3.1 | PUT..... | 47 | +| 5.2.12.3.2 | DELETE..... | 48 | +| 5.2.12.3.4 | GET..... | 48 | +| 5.2.12A | Resource: IpSmGwRegistration..... | 49 | +| 5.2.12A.1 | Description..... | 49 | +| 5.2.12A.2 | Resource Definition..... | 49 | +| 5.2.12A.3 | Resource Standard Methods..... | 49 | +| 5.2.12A.3.1 | PUT..... | 49 | +| 5.2.12A.3.2 | DELETE..... | 50 | +| 5.2.12A.3.3 | PATCH..... | 50 | +| 5.2.12A.3.4 | GET..... | 51 | +| 5.2.12B | Resource: MessageWaitingData..... | 51 | +| 5.2.12B.1 | Description..... | 51 | +| 5.2.12B.2 | Resource Definition..... | 52 | +| 5.2.12B.3 | Resource Standard Methods..... | 52 | +| 5.2.12B.3.1 | PUT..... | 52 | +| 5.2.12B.3.2 | DELETE..... | 52 | +| 5.2.12B.3.3 | PATCH..... | 53 | +| 5.2.12B.3.4 | GET..... | 53 | +| 5.2.13 | Resource: SMSManagementSubscriptionData..... | 54 | +| 5.2.13.1 | Description..... | 54 | +| 5.2.13.2 | Resource Definition..... | 54 | +| 5.2.13.3 | Resource Standard Methods..... | 54 | +| 5.2.13.3.1 | GET..... | 54 | +| 5.2.14 | Resource: ProvisionedParameterData..... | 55 | +| 5.2.14.1 | Description..... | 55 | +| 5.2.14.2 | Resource Definition..... | 55 | +| 5.2.14.3 | Resource Standard Methods..... | 55 | +| 5.2.14.3.1 | GET..... | 55 | +| 5.2.14.3.2 | PATCH..... | 56 | +| 5.2.14A | Resource: PpProfileData..... | 57 | +| 5.2.14A.1 | Description..... | 57 | +| 5.2.14A.2 | Resource Definition..... | 57 | +| 5.2.14A.3 | Resource Standard Methods..... | 57 | +| 5.2.14A.3.1 | GET..... | 57 | +| 5.2.14B | Resource: ProvisionedParameterDataEntry..... | 57 | +| 5.2.14B.1 | Description..... | 57 | +| 5.2.14B.2 | Resource Definition..... | 58 | + +| | | | +|-------------|------------------------------------------------|----| +| 5.2.14B.3 | Resource Standard Methods..... | 58 | +| 5.2.14B.3.1 | PUT..... | 58 | +| 5.2.14B.3.2 | DELETE..... | 59 | +| 5.2.14B.3.3 | GET..... | 59 | +| 5.2.14C | Resource: ProvisionedParameterDataEntries..... | 60 | +| 5.2.14C.1 | Description..... | 60 | +| 5.2.14C.2 | Resource Definition..... | 60 | +| 5.2.14C.3.1 | GET..... | 60 | +| 5.2.15 | Resource: SMSSubscriptionData..... | 61 | +| 5.2.15.1 | Description..... | 61 | +| 5.2.15.2 | Resource Definition..... | 61 | +| 5.2.15.3 | Resource Standard Methods..... | 61 | +| 5.2.15.3.1 | GET..... | 61 | +| 5.2.16 | Resource: SdmSubscriptions..... | 62 | +| 5.2.16.1 | Description..... | 62 | +| 5.2.16.2 | Resource Definition..... | 62 | +| 5.2.16.3 | Resource Standard Methods..... | 62 | +| 5.2.16.3.1 | GET..... | 62 | +| 5.2.16.3.2 | POST..... | 62 | +| 5.2.17 | Resource: IndividualSdmSubscription..... | 63 | +| 5.2.17.1 | Description..... | 63 | +| 5.2.17.2 | Resource Definition..... | 63 | +| 5.2.17.3 | Resource Standard Methods..... | 63 | +| 5.2.17.3.1 | PUT..... | 63 | +| 5.2.17.3.2 | DELETE..... | 64 | +| 5.2.17.3.3 | PATCH..... | 64 | +| 5.2.17.3.4 | GET..... | 65 | +| 5.2.17A | Resource: HssSdmSubscriptionInfo..... | 66 | +| 5.2.17A.1 | Description..... | 66 | +| 5.2.17A.2 | Resource Definition..... | 66 | +| 5.2.17A.3 | Resource Standard Methods..... | 66 | +| 5.2.17A.3.1 | PUT..... | 66 | +| 5.2.17A.3.2 | DELETE..... | 67 | +| 5.2.17A.3.3 | GET..... | 67 | +| 5.2.17A.3.4 | PATCH..... | 68 | +| 5.2.18 | Resource: EeSubscriptions..... | 68 | +| 5.2.18.1 | Description..... | 68 | +| 5.2.18.2 | Resource Definition..... | 68 | +| 5.2.18.3 | Resource Standard Methods..... | 69 | +| 5.2.18.3.1 | GET..... | 69 | +| 5.2.18.3.2 | POST..... | 69 | +| 5.2.19 | Resource: IndividualEeSubscription..... | 70 | +| 5.2.19.1 | Description..... | 70 | +| 5.2.19.2 | Resource Definition..... | 70 | +| 5.2.19.3 | Resource Standard Methods..... | 70 | +| 5.2.19.3.1 | PUT..... | 70 | +| 5.2.19.3.2 | DELETE..... | 71 | +| 5.2.19.3.3 | PATCH..... | 71 | +| 5.2.19.3.4 | GET..... | 72 | +| 5.2.19A | Resource: IndividualEeGroupSubscription..... | 72 | +| 5.2.19A.1 | Description..... | 72 | +| 5.2.19A.2 | Resource Definition..... | 72 | +| 5.2.19A.3 | Resource Standard Methods..... | 73 | +| 5.2.19A.3.1 | PUT..... | 73 | +| 5.2.19A.3.2 | DELETE..... | 73 | +| 5.2.19A.3.3 | PATCH..... | 74 | +| 5.2.19A.3.4 | GET..... | 74 | +| 5.2.19B | Resource: EeGroupProfileData..... | 75 | +| 5.2.19B.1 | Description..... | 75 | +| 5.2.19B.2 | Resource Definition..... | 75 | +| 5.2.19B.3 | Resource Standard Methods..... | 75 | + +| | | | +|-------------|-------------------------------------------------------|----| +| 5.2.19B.3.1 | GET..... | 75 | +| 5.2.19C | Resource: AmfGroupSubscriptionInfo..... | 76 | +| 5.2.19C.1 | Description..... | 76 | +| 5.2.19C.2 | Resource Definition..... | 76 | +| 5.2.19C.3 | Resource Standard Methods..... | 76 | +| 5.2.19C.3.1 | PUT..... | 76 | +| 5.2.19C.3.2 | DELETE..... | 77 | +| 5.2.19C.3.3 | GET..... | 77 | +| 5.2.31.3.4 | PATCH..... | 78 | +| 5.2.19D | Resource: SmfGroupSubscriptionInfo..... | 78 | +| 5.2.19D.1 | Description..... | 78 | +| 5.2.19D.2 | Resource Definition..... | 79 | +| 5.2.19D.3 | Resource Standard Methods..... | 79 | +| 5.2.19D.3.1 | PUT..... | 79 | +| 5.2.19D.3.2 | DELETE..... | 79 | +| 5.2.19D.3.3 | GET..... | 80 | +| 5.2.19D.3.4 | PATCH..... | 80 | +| 5.2.19E | Resource: HssGroupSubscriptionInfo..... | 81 | +| 5.2.19E.1 | Description..... | 81 | +| 5.2.19E.2 | Resource Definition..... | 81 | +| 5.2.19E.3 | Resource Standard Methods..... | 81 | +| 5.2.19E.3.1 | PUT..... | 81 | +| 5.2.19E.3.2 | DELETE..... | 82 | +| 5.2.19E.3.3 | GET..... | 82 | +| 5.2.19E.3.4 | PATCH..... | 83 | +| 5.2.20 | Resource: SubscriptionDataSubscriptions..... | 83 | +| 5.2.20.1 | Description..... | 83 | +| 5.2.20.2 | Resource Definition..... | 84 | +| 5.2.20.3 | Resource Standard Methods..... | 84 | +| 5.2.20.3.1 | POST..... | 84 | +| 5.2.20.3.2 | GET..... | 85 | +| 5.2.20.3.3 | DELETE..... | 85 | +| 5.2.21 | Resource: IndividualSubscriptionDataSubscription..... | 86 | +| 5.2.21.1 | Description..... | 86 | +| 5.2.21.2 | Resource Definition..... | 86 | +| 5.2.21.3 | Resource Standard Methods..... | 87 | +| 5.2.21.3.1 | DELETE..... | 87 | +| 5.2.21.3.2 | PATCH..... | 87 | +| 5.2.21.3.3 | GET..... | 88 | +| 5.2.22 | Resource: TraceData..... | 89 | +| 5.2.22.1 | Description..... | 89 | +| 5.2.22.2 | Resource Definition..... | 89 | +| 5.2.22.3 | Resource Standard Methods..... | 89 | +| 5.2.22.3.1 | GET..... | 89 | +| 5.2.23 | Resource: IdentityData..... | 90 | +| 5.2.23.1 | Description..... | 90 | +| 5.2.23.2 | Resource Definition..... | 90 | +| 5.2.23.3 | Resource Standard Methods..... | 90 | +| 5.2.23.3.1 | GET..... | 90 | +| 5.2.24 | Resource: AuthenticationStatus..... | 91 | +| 5.2.24.1 | Description..... | 91 | +| 5.2.24.2 | Resource Definition..... | 91 | +| 5.2.24.3 | Resource Standard Methods..... | 91 | +| 5.2.24.3.1 | PUT..... | 91 | +| 5.2.24.3.2 | GET..... | 92 | +| 5.2.24.3.3 | DELETE..... | 92 | +| 5.2.24A | Resource: IndividualAuthenticationStatus..... | 93 | +| 5.2.24A.1 | Description..... | 93 | +| 5.2.24A.2 | Resource Definition..... | 93 | +| 5.2.24A.3 | Resource Standard Methods..... | 93 | +| 5.2.24A.3.1 | PUT..... | 93 | + +| | | | +|-------------|----------------------------------------------|-----| +| 5.2.24A.3.2 | GET..... | 94 | +| 5.2.24A.3.3 | DELETE..... | 94 | +| 5.2.25 | Resource: AuthenticationSoR..... | 95 | +| 5.2.25.1 | Description..... | 95 | +| 5.2.25.2 | Resource Definition..... | 95 | +| 5.2.25.3 | Resource Standard Methods..... | 95 | +| 5.2.25.3.1 | PUT..... | 95 | +| 5.2.25.3.2 | GET..... | 95 | +| 5.2.25.3.3 | PATCH..... | 96 | +| 5.2.25A | Resource: AuthenticationUPU..... | 97 | +| 5.2.25A.1 | Description..... | 97 | +| 5.2.25A.2 | Resource Definition..... | 97 | +| 5.2.25A.3 | Resource Standard Methods..... | 97 | +| 5.2.25A.3.1 | PUT..... | 97 | +| 5.2.25A.3.2 | GET..... | 98 | +| 5.2.25B | Resource: SubscribedSNSSAIs..... | 98 | +| 5.2.25B.1 | Description..... | 98 | +| 5.2.25B.2 | Resource Definition..... | 98 | +| 5.2.25B.3 | Resource Standard Methods..... | 99 | +| 5.2.25B.3.1 | PUT..... | 99 | +| 5.2.25B.3.2 | GET..... | 99 | +| 5.2.25C | Resource: SubscribedCAG..... | 100 | +| 5.2.25C.1 | Description..... | 100 | +| 5.2.25C.2 | Resource Definition..... | 100 | +| 5.2.25C.3 | Resource Standard Methods..... | 100 | +| 5.2.25C.3.1 | PUT..... | 100 | +| 5.2.25C.3.2 | GET..... | 100 | +| 5.2.26 | Resource: ProvisionedData..... | 101 | +| 5.2.26.1 | Description..... | 101 | +| 5.2.26.2 | Resource Definition..... | 101 | +| 5.2.26.3 | Resource Standard Methods..... | 101 | +| 5.2.26.3.1 | GET..... | 101 | +| 5.2.27 | Resource: OperatorDeterminedBarringData..... | 102 | +| 5.2.27.1 | Description..... | 102 | +| 5.2.27.2 | Resource Definition..... | 103 | +| 5.2.27.3 | Resource Standard Methods..... | 103 | +| 5.2.27.3.1 | GET..... | 103 | +| 5.2.28 | Resource: EeProfileData..... | 103 | +| 5.2.28.1 | Description..... | 103 | +| 5.2.28.2 | Resource Definition..... | 103 | +| 5.2.28.3 | Resource Standard Methods..... | 104 | +| 5.2.28.3.1 | GET..... | 104 | +| 5.2.29 | Resource: EeGroupSubscriptions..... | 104 | +| 5.2.29.1 | Description..... | 104 | +| 5.2.29.2 | Resource Definition..... | 104 | +| 5.2.29.3 | Resource Standard Methods..... | 105 | +| 5.2.29.3.1 | GET..... | 105 | +| 5.2.29.3.2 | POST..... | 105 | +| 5.2.30 | Resource: SharedData..... | 106 | +| 5.2.30.1 | Description..... | 106 | +| 5.2.30.2 | Resource Definition..... | 106 | +| 5.2.30.3 | Resource Standard Methods..... | 106 | +| 5.2.30.3.1 | GET..... | 106 | +| 5.2.30A | Resource: IndividualSharedData..... | 107 | +| 5.2.30A.1 | Description..... | 107 | +| 5.2.30A.2 | Resource Definition..... | 107 | +| 5.2.30A.3 | Resource Standard Methods..... | 107 | +| 5.2.30A.3.1 | GET..... | 107 | +| 5.2.31 | Resource: AmfSubscriptionInfo..... | 107 | +| 5.2.31.1 | Description..... | 107 | +| 5.2.31.2 | Resource Definition..... | 108 | + +| | | | +|-------------|----------------------------------------------------|-----| +| 5.2.31.3 | Resource Standard Methods..... | 108 | +| 5.2.31.3.1 | PUT..... | 108 | +| 5.2.31.3.2 | DELETE..... | 108 | +| 5.2.31.3.3 | GET..... | 109 | +| 5.2.31.3.4 | PATCH..... | 109 | +| 5.2.31A | Resource: SmfSubscriptionInfo..... | 110 | +| 5.2.31A.1 | Description..... | 110 | +| 5.2.31A.2 | Resource Definition..... | 110 | +| 5.2.31A.3 | Resource Standard Methods..... | 110 | +| 5.2.31A.3.1 | PUT..... | 110 | +| 5.2.31A.3.2 | DELETE..... | 111 | +| 5.2.31A.3.3 | GET..... | 111 | +| 5.2.31A.3.4 | PATCH..... | 112 | +| 5.2.31B | Resource: HssSubscriptionInfo..... | 113 | +| 5.2.31B.1 | Description..... | 113 | +| 5.2.31B.2 | Resource Definition..... | 113 | +| 5.2.31B.3 | Resource Standard Methods..... | 113 | +| 5.2.31B.3.1 | PUT..... | 113 | +| 5.2.31B.3.2 | DELETE..... | 114 | +| 5.2.31B.3.3 | GET..... | 114 | +| 5.2.31B.3.4 | PATCH..... | 114 | +| 5.2.32 | Resource: ContextData..... | 115 | +| 5.2.32.1 | Description..... | 115 | +| 5.2.32.2 | Resource Definition..... | 115 | +| 5.2.32.3 | Resource Standard Methods..... | 115 | +| 5.2.32.3.1 | GET..... | 115 | +| 5.2.33 | Resource: GroupIdentifiers..... | 116 | +| 5.2.33.1 | Description..... | 116 | +| 5.2.33.2 | Resource Definition..... | 116 | +| 5.2.33.3 | Resource Standard Methods..... | 116 | +| 5.2.33.3.1 | GET..... | 116 | +| 5.2.34 | Resource: 5GVnGroups..... | 117 | +| 5.2.34.1 | Description..... | 117 | +| 5.2.34.2 | Resource Definition..... | 117 | +| 5.2.34.3 | Resource Standard Methods..... | 117 | +| 5.2.34.3.1 | GET..... | 117 | +| 5.2.35 | Resource: Individual5GVnGroup..... | 118 | +| 5.2.35.1 | Description..... | 118 | +| 5.2.35.2 | Resource Definition..... | 118 | +| 5.2.35.3 | Resource Standard Methods..... | 118 | +| 5.2.35.3.1 | PUT..... | 118 | +| 5.2.35.3.2 | DELETE..... | 119 | +| 5.2.35.3.3 | PATCH..... | 120 | +| 5.2.35.3.4 | GET..... | 120 | +| 5.2.36 | Resource: LcsPrivacySubscriptionData..... | 121 | +| 5.2.36.1 | Description..... | 121 | +| 5.2.36.2 | Resource Definition..... | 121 | +| 5.2.36.3 | Resource Standard Methods..... | 121 | +| 5.2.36.3.1 | GET..... | 121 | +| 5.2.37 | Resource: LcsMobileOriginatedSubscriptionData..... | 122 | +| 5.2.37.1 | Description..... | 122 | +| 5.2.37.2 | Resource Definition..... | 122 | +| 5.2.37.3 | Resource Standard Methods..... | 122 | +| 5.2.37.3.1 | GET..... | 122 | +| 5.2.38 | Resource: NiddAuthorizationData..... | 123 | +| 5.2.38.1 | Description..... | 123 | +| 5.2.38.2 | Resource Definition..... | 123 | +| 5.2.38.3 | Resource Standard Methods..... | 123 | +| 5.2.38.3.1 | GET..... | 123 | +| 5.2.39 | Resource: CoverageRestrictionData..... | 124 | +| 5.2.39.1 | Description..... | 124 | + +| | | | +|-------------|-------------------------------------------------------|-----| +| 5.2.39.2 | Resource Definition..... | 124 | +| 5.2.39.3 | Resource Standard Methods..... | 124 | +| 5.2.39.3.1 | GET..... | 124 | +| 5.2.40 | Resource: Location..... | 125 | +| 5.2.40.1 | Description..... | 125 | +| 5.2.40.2 | Resource Definition..... | 125 | +| 5.2.40.3 | Resource Standard Methods..... | 125 | +| 5.2.40.3.1 | GET..... | 125 | +| 5.2.41 | Resource: V2xSubscriptionData..... | 126 | +| 5.2.41.1 | Description..... | 126 | +| 5.2.41.2 | Resource Definition..... | 126 | +| 5.2.41.3 | Resource Standard Methods..... | 126 | +| 5.2.41.3.1 | GET..... | 126 | +| 5.2.41A | Resource: ProseSubscriptionData..... | 127 | +| 5.2.41A.1 | Description..... | 127 | +| 5.2.41A.2 | Resource Definition..... | 127 | +| 5.2.41A.3 | Resource Standard Methods..... | 127 | +| 5.2.41A.3.1 | GET..... | 127 | +| 5.2.42 | Resource: LcsBroadcastAssistanceSubscriptionData..... | 128 | +| 5.2.42.1 | Description..... | 128 | +| 5.2.42.2 | Resource Definition..... | 128 | +| 5.2.42.3 | Resource Standard Methods..... | 128 | +| 5.2.42.3.1 | GET..... | 128 | +| 5.2.43 | Resource: 5GVnGroupsInternal..... | 129 | +| 5.2.43.1 | Description..... | 129 | +| 5.2.43.2 | Resource Definition..... | 129 | +| 5.2.43.3 | Resource Standard Methods..... | 129 | +| 5.2.43.3.1 | GET..... | 129 | +| 5.2.44 | Resource: Pp5gVnGroupProfileData..... | 130 | +| 5.2.44.1 | Description..... | 130 | +| 5.2.44.2 | Resource Definition..... | 130 | +| 5.2.44.3 | Resource Standard Methods..... | 130 | +| 5.2.44.3.1 | GET..... | 130 | +| 5.2.45 | Resource: NiddAuthorizations..... | 131 | +| 5.2.45.1 | Description..... | 131 | +| 5.2.45.2 | Resource Definition..... | 131 | +| 5.2.45.3 | Resource Standard Methods..... | 131 | +| 5.2.45.3.1 | PUT..... | 131 | +| 5.2.45.3.2 | DELETE..... | 131 | +| 5.2.45.3.3 | GET..... | 132 | +| 5.2.45.3.4 | PATCH..... | 132 | +| 5.2.46 | Resource: 5MBSSubscriptionData..... | 133 | +| 5.2.46.1 | Description..... | 133 | +| 5.2.46.2 | Resource Definition..... | 133 | +| 5.2.46.3 | Resource Standard Methods..... | 133 | +| 5.2.46.3.1 | GET..... | 133 | +| 5.2.47 | Resource: UeSubscriptionData..... | 134 | +| 5.2.47.1 | Description..... | 134 | +| 5.2.47.2 | Resource Definition..... | 134 | +| 5.2.47.3 | Resource Standard Methods..... | 134 | +| 5.2.47.3.1 | GET..... | 134 | +| 5.2.48 | Resource: ServiceSpecificAuthorizationData..... | 136 | +| 5.2.48.1 | Description..... | 136 | +| 5.2.48.2 | Resource Definition..... | 136 | +| 5.2.48.3 | Resource Standard Methods..... | 136 | +| 5.2.48.3.1 | GET..... | 136 | +| 5.2.49 | Resource: SpecificServiceAuthorizations..... | 137 | +| 5.2.49.1 | Description..... | 137 | +| 5.2.49.2 | Resource Definition..... | 137 | +| 5.2.49.3 | Resource Standard Methods..... | 137 | +| 5.2.49.3.1 | PUT..... | 137 | + +| | | | +|------------|---------------------------------------------|-----| +| 5.2.49.3.2 | DELETE..... | 138 | +| 5.2.49.3.3 | GET..... | 138 | +| 5.2.49.3.4 | PATCH..... | 139 | +| 5.2.50 | Resource: RoamingInfo..... | 139 | +| 5.2.50.1 | Description..... | 139 | +| 5.2.50.2 | Resource Definition..... | 140 | +| 5.2.50.3 | Resource Standard Methods..... | 140 | +| 5.2.50.3.1 | PUT..... | 140 | +| 5.2.50.3.2 | GET..... | 140 | +| 5.2.51 | Resource: UserConsentData..... | 141 | +| 5.2.51.1 | Description..... | 141 | +| 5.2.51.2 | Resource Definition..... | 141 | +| 5.2.51.3 | Resource Standard Methods..... | 141 | +| 5.2.51.3.1 | GET..... | 141 | +| 5.2.52 | Resource: PeiInfo..... | 142 | +| 5.2.52.1 | Description..... | 142 | +| 5.2.52.2 | Resource Definition..... | 142 | +| 5.2.52.3 | Resource Standard Methods..... | 142 | +| 5.2.52.3.1 | PUT..... | 142 | +| 5.2.52.3.2 | GET..... | 143 | +| 5.2.53 | Resource: TimeSyncSubscriptionData..... | 143 | +| 5.2.53.1 | Description..... | 143 | +| 5.2.53.2 | Resource Definition..... | 143 | +| 5.2.53.3 | Resource Standard Methods..... | 144 | +| 5.2.53.3.1 | GET..... | 144 | +| 5.2.54 | Resource: 5GMbsGroup..... | 144 | +| 5.2.54.1 | Description..... | 144 | +| 5.2.54.2 | Resource Definition..... | 144 | +| 5.2.54.3 | Resource Standard Methods..... | 144 | +| 5.2.54.3.1 | GET..... | 144 | +| 5.2.55 | Resource: Individual5GmbsGroup..... | 145 | +| 5.2.55.1 | Description..... | 145 | +| 5.2.55.2 | Resource Definition..... | 145 | +| 5.2.55.3 | Resource Standard Methods..... | 145 | +| 5.2.55.3.1 | PUT..... | 145 | +| 5.2.55.3.2 | DELETE..... | 146 | +| 5.2.55.3.3 | PATCH..... | 146 | +| 5.2.55.3.4 | GET..... | 147 | +| 5.2.56 | Resource: 5GMbsGroupsInternal..... | 148 | +| 5.2.56.1 | Description..... | 148 | +| 5.2.56.2 | Resource Definition..... | 148 | +| 5.2.56.3 | Resource Standard Methods..... | 148 | +| 5.2.56.3.1 | GET..... | 148 | +| 5.2.57 | Resource: Pp5gMbsGroupProfileData..... | 148 | +| 5.2.57.1 | Description..... | 148 | +| 5.2.57.2 | Resource Definition..... | 149 | +| 5.2.57.3 | Resource Standard Methods..... | 149 | +| 5.2.57.3.1 | GET..... | 149 | +| 5.2.58 | Resource: UeUpdateConfirmation..... | 149 | +| 5.2.58.1 | Description..... | 149 | +| 5.2.58.2 | Resource Definition..... | 149 | +| 5.2.58.3 | Resource Standard Methods..... | 150 | +| 5.2.58.3.1 | GET..... | 150 | +| 5.2.59 | Resource: LcsSubscriptionData..... | 150 | +| 5.2.59.1 | Description..... | 150 | +| 5.2.59.2 | Resource Definition..... | 150 | +| 5.2.59.3 | Resource Standard Methods..... | 151 | +| 5.2.59.3.1 | GET..... | 151 | +| 5.2.60 | Resource: RangingSIPosSubscriptionData..... | 151 | +| 5.2.60.1 | Description..... | 151 | +| 5.2.60.2 | Resource Definition..... | 151 | + +| | | | +|------------|---------------------------------------------|-----| +| 5.2.60.3 | Resource Standard Methods..... | 152 | +| 5.2.60.3.1 | GET..... | 152 | +| 5.2.61 | Resource: A2xSubscriptionData..... | 152 | +| 5.2.61.1 | Description..... | 152 | +| 5.2.61.2 | Resource Definition..... | 152 | +| 5.2.61.3 | Resource Standard Methods..... | 152 | +| 5.3 | Notifications..... | 153 | +| 5.3.1 | General..... | 153 | +| 5.3.2 | Data Change Notification..... | 153 | +| 5.3.3 | Data Removal Notification..... | 154 | +| 5.3.4 | Stale Check Notification..... | 155 | +| 5.4 | Data Model..... | 156 | +| 5.4.1 | General..... | 156 | +| 5.4.2 | Structured data types..... | 161 | +| 5.4.2.1 | Introduction..... | 161 | +| 5.4.2.2 | Type: AuthenticationSubscription..... | 162 | +| 5.4.2.3 | Type: OperatorSpecificDataContainer..... | 164 | +| 5.4.2.4 | Type: SmfRegList..... | 165 | +| 5.4.2.5 | Type: SubscriptionDataSubscriptions..... | 166 | +| 5.4.2.6 | Type: DataChangeNotify..... | 169 | +| 5.4.2.7 | Type: IdentityData..... | 169 | +| 5.4.2.8 | Type: ProvisionedDataSets..... | 170 | +| 5.4.2.9 | Type: SorData..... | 171 | +| 5.4.2.9A | Type: UpuData..... | 171 | +| 5.4.2.9B | Type: NssaiAckData..... | 171 | +| 5.4.2.9C | Type: CagAckData..... | 172 | +| 5.4.2.10 | Void..... | 172 | +| 5.4.2.11 | Void..... | 172 | +| 5.4.2.12 | Void..... | 172 | +| 5.4.2.13 | Void..... | 172 | +| 5.4.2.14 | Void..... | 172 | +| 5.4.2.15 | Void..... | 172 | +| 5.4.2.16 | Void..... | 172 | +| 5.4.2.17 | Void..... | 172 | +| 5.4.2.18 | Void..... | 172 | +| 5.4.2.19 | Type: AmfSubscriptionInfo..... | 173 | +| 5.4.2.20 | Type: EeProfileData..... | 173 | +| 5.4.2.21 | Void..... | 173 | +| 5.4.2.22 | Type: ContextDataSets..... | 174 | +| 5.4.2.23 | Type: SequenceNumber..... | 175 | +| 5.4.2.24 | Type: MessageWaitingData..... | 175 | +| 5.4.2.25 | Type: SmscData..... | 176 | +| 5.4.2.26 | Type: SmfSubscriptionInfo..... | 176 | +| 5.4.2.27 | Type: SmfSubscriptionItem..... | 176 | +| 5.4.2.28 | Type: MtcProvider..... | 176 | +| 5.4.2.29 | Type: HssSubscriptionInfo..... | 176 | +| 5.4.2.30 | Type: HssSubscriptionItem..... | 177 | +| 5.4.2.31 | Type: EeGroupProfileData..... | 177 | +| 5.4.2.32 | Type: Pp5gVnGroupProfileData..... | 178 | +| 5.4.2.33 | Type: PpProfileData..... | 178 | +| 5.4.2.34 | Type: AllowedMtcProviderInfo..... | 178 | +| 5.4.2.35 | Type: GroupIdentifiers..... | 179 | +| 5.4.2.36 | Type: AuthorizationData..... | 179 | +| 5.4.2.37 | Type: NiddAuthorizationInfo..... | 179 | +| 5.4.2.38 | Type: PpDataEntryList..... | 179 | +| 5.4.2.39 | Type: UeSubscribedDataSets..... | 180 | +| 5.4.2.40 | Type: ServiceSpecificAuthorizationInfo..... | 180 | +| 5.4.2.41 | Type: NfIdentifier..... | 180 | +| 5.4.2.42 | Type: EeSubscriptionExt..... | 180 | +| 5.4.2.43 | Type: AdditionalEeSubsInfo..... | 180 | +| 5.4.2.44 | Type: ImmediateReport..... | 180 | + +| | | | +|-------------------------------|----------------------------------------------------|------------| +| 5.4.2.47 | Type: UeUpdConfData..... | 181 | +| 5.4.2.48 | Type: AdditionalDataRef..... | 181 | +| 5.4.3 | Simple data types and enumerations..... | 181 | +| 5.4.3.1 | Introduction..... | 181 | +| 5.4.3.2 | Simple data types..... | 181 | +| 5.4.3.3 | Enumeration: AuthMethod..... | 181 | +| 5.4.3.4 | Enumeration: ProvisionedDataSetName..... | 182 | +| 5.4.3.5 | Void..... | 182 | +| 5.4.3.6 | Enumeration: ContextDataSetName..... | 182 | +| 5.4.3.7 | Enumeration: SqnScheme..... | 183 | +| 5.4.3.8 | Enumeration: Sign..... | 183 | +| 5.4.3.9 | Enumeration: UeUpdateStatus..... | 183 | +| 5.4.3.10 | Enumeration: PpDataType..... | 184 | +| 5.4.3.11 | Enumeration: UeSubscribedDataSetName..... | 184 | +| 5.4.4 | Binary data..... | 184 | +| 5.5 | Error handling..... | 184 | +| 5.6 | Feature negotiation..... | 184 | +| Annex A (normative): | OpenAPI specification..... | 185 | +| A.1 | General..... | 185 | +| A.2 | Nudr_DataRepository API for Subscription Data..... | 185 | +| Annex B (informative): | Change history..... | 330 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the usage of the Unified Data Repository services for subscription data. It provides the resource definition and data model for subscription data used over the Nudr Service Based Interface. The protocol definition for Nudr Service Based Interface which is specific to subscription data is also specified in the present document. + +The stage 3 protocol definition for Nudr Service Based Interface which is common for subscription data, policy data, structure data and application data for exposure is specified in 3GPP TS 29.504 [2]. + +--- + +## 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 29.504: "5G System; Unified Data Repository Services; Stage 3". +- [3] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [4] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [5] 3GPP TS 23.003: "Numbering, addressing and identification". +- [6] 3GPP TS 29.503: "Unified Data Management Services". +- [7] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [8] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [9] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [10] 3GPP TS 33.102: "3G Security; Security architecture". +- [11] 3GPP TS 35.206: "An example algorithm set for the 3GPP authentication and key generation functions f1, f1\*, f2, f3, f4, f5 and f5\*; Document 2: Algorithm specification". +- [12] 3GPP TS 35.231: "A second example algorithm set for the 3GPP authentication and key generation functions f1, f1\*, f2, f3, f4, f5 and f5\*; Document 1: Algorithm specification ". +- [13] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". + +- [14] 3GPP TR 21.900: "Technical Specification Group working methods". +- [15] 3GPP TS 29.509: "Authentication Server Services; Stage 3". +- [16] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [17] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure; Stage 3". +- [18] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS); Stage 2". +- [19] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [20] 3GPP TS 29.563: "Home Subscriber Server (HSS) services for interworking with Unified Data Management (UDM); Stage 3". +- [21] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**pointer of attribute:** The pointer of the attribute identifies the location of the attribute in the JSON object. The pointer of the attribute is a string with one or more segments, each segment is the name of an attribute within that JSON object, different segments are separated with a "/". + +### 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|-----------------------------------------| +| 5GC | 5G Core | +| AMF | Access and Mobility Management Function | +| DNN | Data Network Name | +| GPSI | Generic Public Subscription Identifier | +| JSON | Javascript Object Notation | +| SMF | Session Management Function | +| SMS | Short Message Service | +| SMSF | SMS Function | +| SUPI | Subscription Permanent Identifier | +| UDM | Unified Data Management | +| UDR | Unified Data Repository | + +--- + +## 4 Overview + +The resources, data model and usage defined in the present document are used by the 5GC NFs (e.g. UDM) to access the subscription data via the Unified Data Repository services specified in 3GPP TS 29.504 [2]. + +--- + +## 5 Usage of Nudr\_DataRepository Service + +### 5.1 Introduction + +The following clauses specify the usage of Nudr\_DataRepository service for subscription data. The principles specified in 3GPP TS 29.504 [2] are followed unless explicitly specified otherwise in the following clauses. + +## 5.2 Resources + +### 5.2.1 Overview + +![A hierarchical tree diagram showing the structure of /subscription-data. The root node is /subscription-data, which branches into /{ueId}. /{ueId} has multiple child nodes: /authentication-data, /ue-update-comfirmation-data, /ee-profile-data, /identity-data, /operator-specific-data, /pp-data, /pp-profile-data, /pp-profile-store, /operator-determined-barring, /nidd-authorization-data, /coverage-restriction-data, /lcs-privacy-data, /lcs-mo-data, /v2x-data, /prose-data, /service-specific-authorization-data, /5mbs-data, /time-sync-data, /lcs-subscription-data, and /ranging-slpos-data. /authentication-data branches into /authentication-subscription and /authentication-status. /authentication-status branches into /{servingNetworkName}. /ue-update-comfirmation-data branches into /sor-data, /upu-data, /subscribed-snssais, and /subscribed-cag. /pp-profile-store branches into /{afInstanceId}. /service-specific-authorization-data branches into /{serviceType}.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` +graph TD; A[/subscription-data] --- B[/<{ueId}>]; B --- C[/authentication-data]; B --- D[/ue-update-comfirmation-data]; B --- E[/ee-profile-data]; B --- F[/identity-data]; B --- G[/operator-specific-data]; B --- H[/pp-data]; B --- I[/pp-profile-data]; B --- J[/pp-profile-store]; B --- K[/operator-determined-barring]; B --- L[/nidd-authorization-data]; B --- M[/coverage-restriction-data]; B --- N[/lcs-privacy-data]; B --- O[/lcs-mo-data]; B --- P[/v2x-data]; B --- Q[/prose-data]; B --- R[/service-specific-authorization-data]; B --- S[/5mbs-data]; B --- T[/time-sync-data]; B --- U[/lcs-subscription-data]; B --- V[/ranging-slpos-data]; C --- C1[/authentication-subscription]; C --- C2[/authentication-status]; C2 --- C2_1[/<{servingNetworkName}>]; D --- D1[/sor-data]; D --- D2[/upu-data]; D --- D3[/subscribed-snssais]; D --- D4[/subscribed-cag]; J --- J1[/<{afInstanceId}>]; R --- R1[/<{serviceType}>]; +``` + +A hierarchical tree diagram showing the structure of /subscription-data. The root node is /subscription-data, which branches into /{ueId}. /{ueId} has multiple child nodes: /authentication-data, /ue-update-comfirmation-data, /ee-profile-data, /identity-data, /operator-specific-data, /pp-data, /pp-profile-data, /pp-profile-store, /operator-determined-barring, /nidd-authorization-data, /coverage-restriction-data, /lcs-privacy-data, /lcs-mo-data, /v2x-data, /prose-data, /service-specific-authorization-data, /5mbs-data, /time-sync-data, /lcs-subscription-data, and /ranging-slpos-data. /authentication-data branches into /authentication-subscription and /authentication-status. /authentication-status branches into /{servingNetworkName}. /ue-update-comfirmation-data branches into /sor-data, /upu-data, /subscribed-snssais, and /subscribed-cag. /pp-profile-store branches into /{afInstanceId}. /service-specific-authorization-data branches into /{serviceType}. + +**Figure 5.2.1-1: Resource URI sub-level structure for subscription data** + +![Hierarchical tree diagram of subscription and context data paths.](81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg) + +``` +graph TD; A[/subscription-data] --> B[/]{ueId}]; B --> C[/]{servingPlmnId}]; C --> D[/provisioned-data]; D --> D1[/am-data]; D --> D2[/trace-data]; D --> D3[/smf-selection-data]; D --> D4[/sm-data]; D --> D5[/sms-mng-data]; D --> D6[/sms-data]; D --> D7[/lcs-bca-data]; B --> E[/context-data]; E --> E1[/amf-3gpp-access]; E --> E2[/amf-non-3gpp-access]; E --> E3[/smf-registrations]; E3 --> E3_1[/]{pduSessionId}]; E --> E4[/smf-3gpp-access]; E --> E5[/smf-non-3gpp-access]; E --> E6[/location]; E --> E7[/sdm-subscriptions]; E7 --> E7_1[/]{subsId}]; E7_1 --> E7_2[/hss-sdm-subscriptions]; E --> E8[/ee-subscriptions]; E8 --> E8_1[/]{subsId}]; E8_1 --> E8_2[/amf-subscriptions]; E8_1 --> E8_3[/smf-subscriptions]; E8_1 --> E8_4[/hss-subscriptions]; E --> E9[/ip-sm-gw]; E --> E10[/mwd]; E --> E11[/nidd-authorizations]; E --> E12[/service-specific-authorizations]; E12 --> E12_1[/]{serviceType}]; E --> E13[/roaming-information]; E --> E14[/pei-info]; +``` + +The diagram illustrates a hierarchical tree structure of data paths, starting from `/subscription-data`. The root path branches into `/]{ueId}`, which further branches into `/]{servingPlmnId}`. From `/]{servingPlmnId}`, the path splits into `/provisioned-data` and `/context-data`. `/provisioned-data` contains sub-paths: `/am-data`, `/trace-data`, `/smf-selection-data`, `/sm-data`, `/sms-mng-data`, `/sms-data`, and `/lcs-bca-data`. `/context-data` contains sub-paths: `/amf-3gpp-access`, `/amf-non-3gpp-access`, `/smf-registrations` (with `/]{pduSessionId}`), `/smf-3gpp-access`, `/smf-non-3gpp-access`, `/location`, `/sdm-subscriptions` (with `/]{subsId}` leading to `/hss-sdm-subscriptions`), `/ee-subscriptions` (with `/]{subsId}` leading to `/amf-subscriptions`, `/smf-subscriptions`, and `/hss-subscriptions`), `/ip-sm-gw`, `/mwd`, `/nidd-authorizations`, `/service-specific-authorizations` (with `/]{serviceType}`), `/roaming-information`, and `/pei-info`. + +Hierarchical tree diagram of subscription and context data paths. + +**Figure 5.2.1-2: Resource URI sub-level structure for subscription data (cont.)**![Resource URI sub-level structure for subscription data (cont.)](a3472689858b068ef469213682965325_img.jpg) + +``` +graph TD; A[/subscription-data] --> B[/group-data]; A --> C[/group-identifiers]; A --> D[/5g-vn-groups]; A --> E[/mbs-group-membership]; A --> F[/shared-data]; A --> G[/subs-to-notify]; B --> B1[/<{ueGroupId}>]; B1 --> B1a[/ee-subscriptions]; B1a --> B1a1[/<{subsId}>]; B1 --> B1b[/ee-profile-data]; D --> D1[/<{externalGroupId}>]; D --> D2[/internal]; D --> D3[/pp-profile-data]; E --> E1[/<{externalGroupId}>]; E --> E2[/internal]; E --> E3[/pp-profile-data]; F --> F1[/<{sharedDataId}>]; G --> G1[/<{subsId}>]; +``` + +The diagram illustrates the hierarchical structure of Resource URIs for subscription data. The root is `/subscription-data`. It branches into several sub-levels: `/group-data`, `/group-identifiers`, `/5g-vn-groups`, `/mbs-group-membership`, `/shared-data`, and `/subs-to-notify`. `/group-data` further branches into `/<{ueGroupId}>`, which then branches into `/ee-subscriptions` (with a sub-level `/<{subsId}>`) and `/ee-profile-data`. `/5g-vn-groups` branches into `/<{externalGroupId}>`, `/internal`, and `/pp-profile-data`. `/mbs-group-membership` branches into `/<{externalGroupId}>`, `/internal`, and `/pp-profile-data`. `/shared-data` branches into `/<{sharedDataId}>`. `/subs-to-notify` branches into `/<{subsId}>`. + +Resource URI sub-level structure for subscription data (cont.) + +**Figure 5.2.1-3: Resource URI sub-level structure for subscription data (cont.)** + +Table 5.2.1-1 provides an overview of the resources, applicable HTTP methods and whether subscribe (implicit and explicit) to be notified about data change applies. + +**Table 5.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | Subscribe to be notified about data change supported | HTTP method | Description | +|---------------------------------------|---------------------------------------------------------------------------|------------------------------------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthenticationSubscription (Document) | /subscription-data/{ueId}/authentication-data/authentication-subscription | N | GET | Retrieve a UE's authentication subscription data | +| | | | PATCH | Update a UE's authentication subscription data Updates shall be limited to the sequenceNumber attribute. Attempts to patch any other attribute shall be rejected by the UDR. | +| UeUpdateConfirmation | /subscription-data/{ueId}/ue-update-confirmation-data | Y | GET | Retrieve the complete UE-acknowledgement info | +| AuthenticationSoR (Document) | /subscription-data/{ueId}/ue-update-confirmation-data/sor-data | Y | PUT | Store UE's SoR acknowledgement information (SoR-XMAC-IUE), "ME support of SOR-CMCI" "ME support of SOR-SNPN-SI" and, "ME support of SOR-SNPN-SI-LS". | +| | | | GET | Retrieve UE's SoR acknowledgement information, "ME support of SOR-CMCI", "ME support of SOR-SNPN-SI" and, "ME support of SOR-SNPN-SI-LS". | +| | | | PATCH | Update "ME support of SOR-CMCI" and "ME support of SOR-SNPN-SI" and, "ME support of SOR-SNPN-SI-LS". | +| AuthenticationUPU (Document) | /subscription-data/{ueId}/ue-update-confirmation-data/upu-data | Y | PUT | Store UE Parameter Update acknowledgement information (UPU-XMAC-IUE) | +| | | | GET | Retrieve UE Parameter Update acknowledgement information | +| SubscribedSNSSAIs (Document) | /subscription-data/{ueId}/ue-update-confirmation-data/subscribed-snssais | Y | PUT | Store UE-acknowledgement info for change of subscribed S-NSSAIs | +| | | | GET | Retrieve UE-acknowledgement info for change of subscribed S-NSSAIs | + +| | | | | | +|----------------------------------------------|--------------------------------------------------------------------------------------------|---|--------|--------------------------------------------------------------------------------------------------------| +| SubscribedCAG (Document) | /subscription-data/{ueId}/ue-update-confirmation-data/subscribed-cag | Y | PUT | Store UE-acknowledgement info for change of subscribed CAG | +| | | | GET | Retrieve UE-acknowledgement info for change of subscribed CAG | +| AuthenticationStatus (Document) | /subscription-data/{ueId}/authentication-data/authentication-status | N | PUT | Store a UE's authentication status | +| | | | GET | Retrieve a UE's authentication status | +| | | | DELETE | Delete a UE's authentication status | +| IndividualAuthenticationStatus (Document) | /subscription-data/{ueId}/authentication-data/authentication-status/{servingNetworkName} | Y | PUT | When the feature "PerUePerSnAuthStatus" is supported, store a UE's Individual authentication status | +| | | | GET | When the feature "PerUePerSnAuthStatus" is supported, retrieve a UE's Individual authentication status | +| | | | DELETE | When the feature "PerUePerSnAuthStatus" is supported, delete a UE's Individual authentication status | +| ProvisionedData (Document) | /subscription-data/{ueId}/{servingPlmnId}/provisioned-data | N | GET | Retrieve the UE's subscribed Provisioned Data | +| AccessAndMobilitySubscriptionData (Document) | /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/am-data | Y | GET | Retrieve the UE's subscribed Access and Mobility Data | +| SmfSelectionSubscriptionData (Document) | /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/smf-selection-subscription-data | Y | GET | Retrieve the UE's subscribed SMF Selection Data | +| SessionManagementSubscriptionData (Document) | /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sm-data | Y | GET | Retrieve the UE's subscribed SM Subscription Data | +| ContextData (Document) | /subscription-data/{ueId}/context-data | N | GET | Retrieve the UE's context Data | +| Amf3GppAccessRegistration (Document) | /subscription-data/{ueId}/context-data/amf-3gpp-access | Y | PUT | Create and Update the AMF registration for 3GPP access | +| | | | PATCH | Modify the AMF registration for 3GPP access | +| | | | GET | Retrieve the AMF registration information for 3GPP access | +| AmfNon3GppAccessRegistration (Document) | /subscription-data/{ueId}/context-data/amf-non-3gpp-access | Y | PUT | Update the AMF registration for non 3GPP access | +| | | | PATCH | Modify the AMF registration for non 3GPP access | +| | | | GET | Retrieve the AMF registration information for non 3GPP access | + +| | | | | | +|---------------------------------------------|-------------------------------------------------------------------------|---|--------|-------------------------------------------------------------------| +| SmfRegistrations
(Store) | /subscription-data/{ueId}/context-data/smf-registrations | Y | GET | Retrieve the list of the SMF registrations | +| | | Y | PUT | Store an individual SMF registration identified by PDU Session Id | +| | | | DELETE | Delete an individual SMF registration | +| | | | GET | Retrieve individual SMF registration | +| | | | PATCH | Modify the individual SMF registration | +| IndividualSmfRegistration
(Document) | /subscription-data/{ueId}/context-data/smf-registrations/{pduSessionId} | Y | GET | retrieve the operator specific subscription data of a UE | +| | | | PATCH | modify the operator specific subscription data of a UE | +| OperatorSpecificData
(Document) | /subscription-data/{ueId}/operator-specific-data | | PUT | create/update the operator specific subscription data of a UE | +| | | | DELETE | delete the operator specific subscription data of a UE | +| OperatorDeterminedBarringData
(Document) | /subscription-data/{ueId}/operator-determined-barring-data | Y | GET | Retrieve the UE's Operator Determined Barring | +| SMSManagementSubscriptionData
(Document) | /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sms-mng-data | Y | GET | Retrieve the UE's subscribed SMS management subscription data. | +| | | Y | PUT | Create or Update the SMSF registration | +| | | | DELETE | Delete the SMSF registration for 3GPP access | +| Smsf3GppAccessRegistration
(Document) | /subscription-data/{ueId}/context-data/smsf-3gpp-access | | GET | Retrieve the SMSF registration information | +| | | Y | PUT | Create or Update the SMSF registration for non 3GPP access | +| | | | DELETE | Delete the SMSF registration for non 3GPP access | +| SmsfNon3GppAccessRegistration
(Document) | /subscription-data/{ueId}/context-data/smsf-non-3gpp-access | | GET | Retrieve the SMSF registration information for non 3GPP access | +| | | Y | PUT | Create or Update the IP-SM-GW registration | +| | | | DELETE | Delete the IP-SM-GW registration | +| | | | PATCH | Modify the IP-SM-GW registration | +| IpSmGwRegistration
(Document) | /subscription-data/{ueId}/context-data/ip-sm-gw | Y | GET | Retrieve the IP-SM-GW registration information | +| | | | PUT | Create or Update the SMS Message Waiting Data | +| | | | DELETE | Delete the SMS Message Waiting Data | +| | | | PATCH | Modify the SMS | +| MessageWaitingData
(Document) | /subscription-data/{ueId}/context-data/mwd | Y | PUT | Create or Update the SMS Message Waiting Data | +| | | | DELETE | Delete the SMS Message Waiting Data | +| | | | PATCH | Modify the SMS | + +| | | | | | +|--------------------------------------|-----------------------------------------------------------------------------------------|---|--------|------------------------------------------------------------------------| +| | | | H | Message Waiting Data | +| | | | GET | Retrieve the SMS Message Waiting Data | +| SdmSubscriptions (Collection) | /subscription-data/{ueId}/context-data/sdm-subscriptions | N | GET | Retrieve SDM subscriptions | +| | | | POST | Create an individual SDM subscription | +| IndividualSdmSubscription (Document) | /subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId} | N | PUT | Update an individual SDM subscription | +| | | | DELETE | Delete an individual SDM subscription | +| | | | PATCH | Update an individual SDM Subscription | +| | | | GET | Retrieve an individual SDM subscription | +| HssSdmSubscriptionInfo (Document) | /subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId}/hss-sdm-subscriptions | N | PUT | Store information related to the Hss-SDM-Subscriptions | +| | | | DELETE | Delete the Hss-SDM-subscriptions | +| | | | GET | Retrieve Hss-SDM-subscriptions | +| | | | PATCH | Update Hss-SDM-subscriptions | +| EeSubscriptions (Collection) | /subscription-data/{ueId}/context-data/ee-subscriptions | N | GET | Retrieve EE subscriptions | +| | | | POST | Create an EE subscription | +| IndividualEeSubscription (Document) | /subscription-data/{ueId}/context-data/ee-subscriptions/{subsId} | N | PUT | Update an individual EE subscription | +| | | | DELETE | Delete an individual EE subscription | +| | | | PATCH | Update an individual EE subscription | +| | | | GET | Retrieve an individual EE subscription | +| AmfSubscriptionInfo (Document) | /subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/amf-subscriptions | N | PUT | Store information related to the Amf-EE-Subscription response | +| | | | DELETE | Delete the Amf-EE-subscriptions | +| | | | GET | Retrieve AMF-subscriptions | +| | | | PATCH | Update AMF-subscriptions | +| SmfSubscriptionInfo (Document) | /subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/smf-subscriptions | N | PUT | Store information related to the received Smf-EE-Subscription response | +| | | | DELETE | Delete the Smf-EE-subscriptions | +| | | | GET | Retrieve SMF-subscriptions | +| | | | PATCH | Update SMF-subscriptions | +| HssSubscriptionInfo (Document) | /subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/hss-subscriptions | N | PUT | Store information related to the Hss-EE-Subscriptions | + +| | | | | | +|---------------------------------------------------|---------------------------------------------------------------------|---|--------|--------------------------------------------------------------------------------------------------------------------| +| | | | DELETE | Delete the Hss-EE-subscriptions | +| | | | GET | Retrieve Hss-EE-subscriptions | +| | | | PATCH | Update Hss-EE-subscriptions | +| EeProfileData (Document) | /subscription-data/{ueId}/ee-profile-data | Y | GET | Retrieve the UE's subscribed EE profile data. | +| ProvisionedParameterData (Document) | /subscription-data/{ueId}/pp-data | y | PATCH | Update of provisioned parameters. | +| | | | GET | Retrieves the UE's provisioned parameters. | +| PpProfileData (Document) | /subscription-data/{ueId}/pp-profile-data | Y | GET | Retrieve the UE's subscribed PP profile data. | +| ProvisionedParameterDataEntries (Store) | /subscription-data/{ueId}/pp-data-store | Y | GET | Retrieve a Provisioned Parameter Data of multiple Entries | +| ProvisionedParameterDataEntry (Document) | /subscription-data/{ueId}/pp-data-store/{afInstanceId} | Y | PUT | Create a Provisioned Parameter Data Entry | +| | | | DELETE | Delete a Provisioned Parameter Data Entry | +| | | | GET | Retrieve a Provisioned Parameter Data Entry | +| SMSSubscriptionData (Document) | /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sms-data | Y | GET | Retrieve the UE's subscribed SMS subscription data. | +| SubscriptionDataSubscriptions (Collection) | /subscription-data/subs-to-notify | N | GET | Retrieve existing subscriptions | +| | | | POST | Create a subscription, i.e. subscribe a node to receive notification for change of data | +| | | | DELETE | Deletes multiple subscriptions for a given UE. | +| IndividualSubscriptionDataSubscription (Document) | /subscription-data/subs-to-notify/{subsId} | N | DELETE | Delete the subscription identified by {subsId}, i.e. unsubscribe a node to receive notification for change of data | +| | | | PATCH | Update an individual Subscription to notification | +| | | | GET | Retrieve an individual Subscription to notification | +| EeGroupSubscriptions (Collection) | /subscription-data/group-data/{ueGroupId}/ee-subscriptions | N | GET | Retrieve EE subscriptions for groups of UEs | +| | | | POST | Create an EE subscription for groups of UEs | +| IndividualEeGroupSubscription (Document) | /subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId} | N | PUT | Update an individual EE subscription for a group of UEs | +| | | | DELETE | Delete an individual EE subscription for a group of UEs | +| | | | PATCH | Update an individual EE subscription for a | + +| | | | | | +|-------------------------------------|---------------------------------------------------------------------------------------|---|--------|-------------------------------------------------------------------------------------------| +| | | | GET | group of UEs
Retrieve an individual EE subscription for a group of UEs | +| AmfGroupSubscriptionInfo (Document) | /subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/amf-subscriptions | N | PUT | Store information related to the Amf-EE-Subscription response for a group of UEs | +| | | | DELETE | Delete the Amf-EE-subscriptions for a group of UEs | +| | | | GET | Retrieve AMF-subscriptions for a group of UEs | +| | | | PATCH | Update AMF-subscriptions for a group of UEs | +| SmfGroupSubscriptionInfo (Document) | /subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/smf-subscriptions | N | PUT | Store information related to the received Smf-EE-Subscription response for a group of UEs | +| | | | DELETE | Delete the Smf-EE-subscriptions for a group of UEs | +| | | | GET | Retrieve SMF-subscriptions for a group of UEs | +| | | | PATCH | Update SMF-subscriptions for a group of UEs | +| HssGroupSubscriptionInfo (Document) | /subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/hss-subscriptions | N | PUT | Store information related to the Hss-EE-Subscriptions for a group of UEs | +| | | | DELETE | Delete the Hss-EE-subscriptions for a group of UEs | +| | | | GET | Retrieve Hss-EE-subscriptions for a group of UEs | +| | | | PATCH | Update Hss-EE-subscriptions for a group of UEs | +| EeGroupProfileData (Document) | /subscription-data/group-data/{ueGroupId}/ee-profile-data | Y | GET | Retrieve the subscribed EE profile data for a group of UEs. | +| TraceData (Document) | /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/trace-data | Y | GET | Retrieve the UE's trace configuration data | +| IdentityData (Document) | /subscription-data/{ueId}/identity-data | Y | GET | Retrieve identity data that corresponds to the provided ueId | +| SharedData (Collection) | /subscription-data/shared-data | N | GET | Retrieve shared data | +| IndividualSharedData (Document) | /subscription-data/shared-data/{sharedDataId} | Y | GET | Retrieve the individual Shared Data | +| GroupIdentifiers (Document) | /subscription-data/group-data/group-identifiers | Y | GET | Retrieve group identifiers and the UE identifiers belong to the group identifiers. | +| 5GvnGroups (Store) | /subscription-data/group-data/5g-vn-groups | Y | GET | Retrieve 5G VN Groups | +| Individual5GvnGroup (Document) | /subscription-data/group-data/5g-vn-groups/{externalGroupId} | Y | PUT | Create a 5G VN Group | + +| | | | | | +|---------------------------------------------------|--------------------------------------------------------------------------------------|---|--------|---------------------------------------------------------------------------------------------| +| | | | PATCH | Update a 5G VN Group | +| | | | DELETE | Delete a 5G VN Group | +| | | | GET | Retrieve a 5G VN Group | +| 5GVnGroupsInternal (Document) | /subscription-data/group-data/5g-vn-groups/internal | Y | GET | Retrieve 5G VN Group Data based on Internal Group Identifier(s) | +| Pp5gVnGroupProfileData (Document) | /subscription-data/group-data/5g-vn-groups/pp-profile-data | Y | GET | Retrieve the UE's subscribed PP profile data for accessing 5G VN Groups service operations. | +| LcsPrivacySubscriptionData (Document) | /subscription-data/{ueId}/lcs-privacy-data | Y | GET | Retrieve the UE's subscribed LCS privacy Subscription Data | +| LcsMobileOriginatedSubscriptionData (Document) | /subscription-data/{ueId}/lcs-mo-data | Y | GET | Retrieve the UE's subscribed LCS Mobile Originated Subscription Data | +| LcsSubscriptionData (Document) | /subscription-data/{ueId}/lcs-subscription-data | Y | GET | Retrieve the UE's LCS Subscription Data | +| NiddAuthorizationData (Document) | /subscription-data/{ueId}/nidd-authorization-data | Y | GET | Retrieve the UE's NIDD Authorization Data | +| ServiceSpecificAuthorizationData (Document) | /subscription-data/{ueId}/service-specific-authorization-data/{serviceType} | Y | GET | Retrieve the UE's Authorization Data for a specific service | +| CoverageRestrictionData (Document) | /subscription-data/{ueId}/coverage-restriction-data | Y | GET | Retrieve the UE's subscribed enhanced Coverage Restriction Data | +| Location (Document) | /subscription-data/{ueId}/context-data/location | Y | GET | Retrieve the UE's Location Information | +| V2xSubscriptionData (Document) | /subscription-data/{ueId}/v2x-data | Y | GET | Retrieve the UE's subscribed V2X Data | +| ProseSubscriptionData (Document) | /subscription-data/{ueId}/prose-data | Y | GET | Retrieve the UE's subscribed ProSe Service Data | +| 5MBSSubscriptionData (Document) | /subscription-data/{ueId}/5mbs-data | Y | GET | Retrieve the UE's 5MBS Subscription Data | +| UcSubscriptionData (Document) | /subscription-data/{ueId}/uc-data | Y | GET | Retrieve the UE's User Consent Data | +| LcsBroadcastAssistanceSubscriptionData (Document) | /subscription-data/{ueId}/{servingPlmnId}/provisioned-data/lcs-bca-data | Y | GET | Retrieve the UE's subscribed LCS Broadcast Assistance subscription data | +| NiddAuthorizations (Document) | /subscription-data/{ueId}/context-data/nidd-authorizations | Y | PUT | Store information related to the NIDD Authorization | +| | | | DELETE | Delete the NIDD Authorizations | +| | | | GET | Retrieve NIDD Authorizations | +| | | | PATCH | Update a specific NIDD Authorization | +| UeSubscriptionData (Document) | /subscription-data/{ueId} | N | GET | Retrieve data set(s) from the UE's subscription data | +| SpecificServiceAuthorizations (Document) | /subscription-data/{ueId}/context-data/service-specific-authorizations/{serviceType} | Y | PUT | Store information related to the service specific Authorization | + +| | | | | | +|-----------------------------------------|----------------------------------------------------------------------|---|--------|---------------------------------------------------------------------------------------------| +| | | | DELETE | Delete the service specific Authorization | +| | | | GET | Retrieve service specific Authorizations | +| | | | PATCH | Update a service specific Authorization | +| RoamingInfo (Document) | /subscription-data/{ueId}/context-data/roaming-information | Y | GET | Retrieve the last 5GC/EPC common Roaming Information in the 3GPP access | +| | | | PUT | Update or create the last 5GC/EPC common Roaming Information in the 3GPP access | +| PeiInfo (Document) | /subscription-data/{ueId}/context-data/pei-info | Y | GET | Retrieve the PEI of the 5GC/EPC domains | +| | | | PUT | Update or create the PEI of the 5GC/EPC domains | +| TimeSyncSubscriptionData (Document) | /subscription-data/{ueId}/time-sync-data | N | GET | Retrieve the UE's Time Synchronization Subscription Data | +| 5GMbsGroup (Store) | /subscription-data/group-data/mbs-group-membership | Y | GET | Retrieve 5G MBS Group | +| Individual5GmbsGroup (Document) | /subscription-data/group-data/mbs-group-membership/{externalGroupId} | Y | PUT | Create a 5G MBS Group | +| | | | PATCH | Update a 5G MBS Group | +| | | | DELETE | Delete a 5G MBS Group | +| | | | GET | Retrieve a 5G MBS Group | +| 5GMbsGroupsInternal (Document) | /subscription-data/group-data/mbs-group-membership/internal | Y | GET | Retrieve 5G MBS Group Data based on Internal Group Identifier(s) | +| Pp5gMbsGroupProfileData (Document) | /subscription-data/group-data/mbs-group-membership/pp-profile-data | Y | GET | Retrieve the UE's subscribed PP profile data for accessing 5G MBS Group service operations. | +| RangingSIPosSubscriptionData (Document) | /subscription-data/{ueId}/ranging-sipos-data | Y | GET | Retrieve the UE's subscribed Ranging and Sidelink Positioning Data | +| A2xSubscriptionData (Document) | /subscription-data/{ueId}/a2x-data | Y | GET | Retrieve the UE's subscribed A2X Data | + +## 5.2.2 Resource: AuthenticationSubscription + +### 5.2.2.1 Description + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +NOTE 1: This resource contains security-sensitive attributes, such as the long-term key of the UE (see "encPermanentKey" attribute of the AuthenticationSubscription data type in clause 5.4.2.2). Read/write access can be authorized by means of OAuth2. + +NOTE 2: Although these security-sensitive attributes are stored in an encrypted form in the UDR, operators can consider its storage separately from other types of subscription data. How to achieve this in a secure way is implementation-specific; a description of a typical mechanism can be found in the informative Annex X in 3GPP TS 29.500 [8]. + +### 5.2.2.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/authentication-data/authentication-subscription + +This resource shall support the resource URI variables defined in table 5.2.2.2-1. + +**Table 5.2.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier of the UE.
It may be the SUPI (see 3GPP TS 23.501 [4], clause 5.9.2) of the UE or a pseudonym in SUPI format (e.g. the GLI or GCI of the UE; see 3GPP TS 23.316 [18], clauses 4.7.3 and 4.7.4).
Pattern: See pattern of type Supi in 3GPP TS 29.571 [3]. | + +### 5.2.2.3 Resource Standard Methods + +#### 5.2.2.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.2.3.1-1. + +**Table 5.2.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.2.3.1-2 and the response data structures and response codes specified in table 5.2.2.3.1-3. + +**Table 5.2.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------| +| AuthenticationSubscription | M | 1 | 200 OK | Upon success, a response body containing the AuthenticationSubscription shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +#### 5.2.2.3.2 PATCH + +This method is used to modify the authentication data of UE in the UDR. + +This method shall support the URI query parameters specified in table 5.2.2.3.2-1. + +**Table 5.2.2.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.2.3.2-2 and the response data structures and response codes specified in table 5.2.2.3.2-3. + +**Table 5.2.2.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the authentication subscription of a UE | + +**Table 5.2.2.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +## 5.2.3 Resource: AccessAndMobilitySubscriptionData + +### 5.2.3.1 Description + +This resource represents the subscribed AccessAndMobilitySubscriptionData for a SUPI for use in a serving PLMN. It is queried by the AMF via the UDM after registering. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.3.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/am-data + +This resource shall support the resource URI variables defined in table 5.2.3.2-1. + +**Table 5.2.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | +| servingPlmnId | Represents the Serving PLMN ID (consisting of MCC, MNC) or SNPN (consisting of MCC, MNC and NID); see clauses 12.1 and 17.2 in 3GPP TS 23.003 [5]. pattern: "[0-9]{5,6}(-[A-Fa-f0-9]{11})?S" | + +### 5.2.3.3 Resource Standard Methods + +#### 5.2.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.3.3.1-1. + +**Table 5.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields " query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| adjacent-plmns | array(PlmnId) | O | 1..N | PLMN identities of PLMNs adjacent to the PLMN serving the UE. If present the GET response may contain adjacentPlmnRestrictions for the indicated PLMNs. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.3.3.1-2 and the response data structures and response codes specified in table 5.2.3.3.1-3. + +**Table 5.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AccessAndMobilitySubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the Access and Mobility Subscription Data shall be returned.
For the roaming and SNPN scenarios, see the description of the 'roamingRestrictions' attribute in the Table 6.1.6.2.4-1 of 3GPP TS 29.503 [6]. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.4 Resource: SmfSelectionSubscriptionData + +### 5.2.4.1 Description + +This resource represents the subscribed SmfSelectionSubscriptionData for a SUPI. It is queried by the UDM triggered by the AMF after registering. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.4.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/smf-selection-subscription-data + +This resource shall support the resource URI variables defined in table 5.2.4.2-1. + +**Table 5.2.4.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | +| servingPlmnId | Represents the Serving PLMN ID (consisting of MCC, MNC) or SNPN (consisting of MCC, MNC and NID); see clauses 12.1 and 17.2 in 3GPP TS 23.003 [5]. pattern: "[0-9]{5,6}(-[A-Fa-f0-9]{11})? \$" | + +## 5.2.4.3 Resource Standard Methods + +### 5.2.4.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.4.3.1-1. + +**Table 5.2.4.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the " fields " query parameter shall be included. The " fields " query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.4.3.1-2 and the response data structures and response codes specified in table 5.2.4.3.1-3. + +**Table 5.2.4.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.4.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------| +| SmfSelectionSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the SMF Selection Subscription Data for the user shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.5 Resource: SessionManagementSubscriptionData + +### 5.2.5.1 Description + +This resource represents the subscribed SessionManagementSubscriptionData for a SUPI. It is queried by the UDM triggered by the SMF during session setup, using one or both of query parameters representing the selected network slice and the DNN. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.5.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sm-data + +This resource shall support the resource URI variables defined in table 5.2.5.2-1. + +**Table 5.2.5.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | +| servingPlmnId | Represents the Serving PLMN ID (consisting of MCC, MNC) or SNPN (consisting of MCC, MNC and NID); see clauses 12.1 and 17.2 in 3GPP TS 23.003 [5].
pattern: "[0-9]{5,6}(-[A-Fa-f0-9]{11})? \$" | + +## 5.2.5.3 Resource Standard Methods + +### 5.2.5.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.5.3.1-1. + +**Table 5.2.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| single-nssai | Snssai | O | 0..1 | When present without Slice Differentiator (sd), all slices identified by the given Slice/Service Type (sst) and any sd value (if any) shall be considered matching the query parameter. | +| dnn | Dnn | O | 0..1 | | +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +If "single-nssai" is not included, and "dnn" is not included, UDR shall return all DNN configurations for all network slice(s). + +If "single-nssai" is included, and "dnn" is not included, UDR shall return all DNN configurations for the requested network slice identified by "single-nssai". + +If "single-nssai" is not included, and "dnn" is included, UDR shall return all DNN configurations identified by "dnn" for all network slices where such DNN is available. + +If "single-nssai" is included, and "dnn" is included, UDR shall return the DNN configuration identified by "dnn", if such DNN is available in the network slice identified by "single-nssai". + +This method shall support the request data structures specified in table 5.2.5.3.1-2 and the response data structures and response codes specified in table 5.2.5.3.1-3. + +**Table 5.2.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------| +| SmSubsData | M | 1 | 200 OK | Upon success, a response body containing the Session Management Subscription data shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.6 Resource: Amf3GppAccessRegistration + +### 5.2.6.1 Description + +This resource is used to represent AMF registrations to be stored in the UDR by the UDM. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.6.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/amf-3gpp-access + +This resource shall support the resource URI variables defined in table 5.2.6.2-1. + +**Table 5.2.6.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +### 5.2.6.3 Resource Standard Methods + +#### 5.2.6.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.6.3.1-1. + +**Table 5.2.6.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.6.3.1-2 and the response data structures and response codes specified in table 5.2.6.3.1-3. + +**Table 5.2.6.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|---------------------------------------------------------------------------------| +| Amf3GppAccessRegistration | M | 1 | The AMF registration for 3GPP access is replaced with the received information. | + +**Table 5.2.6.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| Amf3GppAccessRegistration | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual Amf3GppAccessRegistration resource shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +#### 5.2.6.3.2 PATCH + +This method is used to modify AMF registration data for 3GPP access in the UDR. + +This method shall support the URI query parameters specified in table 5.2.6.3.2-1. + +**Table 5.2.6.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.6.3.2-2 and the response data structures and response codes specified in table 5.2.6.3.2-3. + +**Table 5.2.6.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|----------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the AMF registration data for 3GPP access | + +**Table 5.2.6.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +### 5.2.6.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.6.3.1-1. + +**Table 5.2.6.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.6.3.3-2 and the response data structures and response codes specified in table 5.2.6.3.3-3. + +**Table 5.2.6.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.6.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------| +| Amf3GppAccessRegistration | M | 1 | 200 OK | Upon success, a response body containing the Amf3GppAccessRegistration shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.7 Resource: AmfNon3GppAccessRegistration + +### 5.2.7.1 Description + +This resource is used to represent AMF registrations to be stored in the UDR. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.7.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/amf-non-3gpp-access + +This resource shall support the resource URI variables defined in table 5.2.7.2-1. + +**Table 5.2.7.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +### 5.2.7.3 Resource Standard Methods + +#### 5.2.7.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.7.3.1-1. + +**Table 5.2.7.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.7.3.1-2 and the response data structures and response codes specified in table 5.2.7.3.1-3. + +**Table 5.2.7.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|-------------------------------------------------------------------------------------| +| AmfNon3GppAccessRegistration | M | 1 | The AMF registration for non 3GPP access is replaced with the received information. | + +**Table 5.2.7.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| AmfNon3GppAccessRegistration | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual AmfNon3GppAccessRegistration resource shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +### 5.2.7.3.2 PATCH + +This method is used to modify AMF registration data for non-3GPP access in the UDR. + +This method shall support the URI query parameters specified in table 5.2.7.3.2-1. + +**Table 5.2.7.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.7.3.2-2 and the response data structures and response codes specified in table 5.2.7.3.2-3. + +**Table 5.2.7.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the AMF registration data for non-3GPP access | + +**Table 5.2.7.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +### 5.2.7.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.7.3.1-1. + +**Table 5.2.7.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.7.3.3-2 and the response data structures and response codes specified in table 5.2.7.3.3-3. + +**Table 5.2.7.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.7.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------| +| AmfNon3GppAccessRegistration | M | 1 | 200 OK | Upon success, a response body containing the Amf3GppAccessRegistration shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.8 Resource: SmfRegistrations + +### 5.2.8.1 Description + +This resource is used to represent SMF registrations to be stored in the UDR. + +This resource is modelled with the Store resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.8.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/context-data/smf-registrations + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 5.2.8.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +### 5.2.8.3 Resource Standard Methods + +#### 5.2.8.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.8.3.1-1. + +**Table 5.2.8.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.8.3.1-2 and the response data structures and response codes specified in table 5.2.8.3.1-3. + +**Table 5.2.8.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.8.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------| +| SmfRegList | M | 1 | 200 OK | Upon success, a response body containing the (possibly empty) list of SMF registrations of the relevant UE shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.9 Resource: IndividualSmfRegistration + +### 5.2.9.1 Description + +This resource is used to represent individual PDU session SMF registrations to be stored in the UDR. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.9.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/context-data/smf-registrations/{pduSessionId} + +This resource shall support the resource URI variables defined in table 5.2.9.2-1. + +**Table 5.2.9.2-1: Resource URI variables for this resource** + +| Name | Definition | +|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | +| pduSessionId | The pduSessionId identifies an individual SMF registration. | + +### 5.2.9.3 Resource Standard Methods + +#### 5.2.9.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.9.3.1-1. + +**Table 5.2.9.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.9.3.1-2 and the response data structures and response codes specified in table 5.2.9.3.1-3. + +**Table 5.2.9.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|----------------------------------------| +| SmfRegistration | M | 1 | The registration that is to be created | + +**Table 5.2.9.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------| +| SmfRegistration | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual SmfRegistration resource shall be returned. | +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.9.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.9.3.2-1. + +**Table 5.2.9.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.9.3.2-2 and the response data structures and response codes specified in table 5.2.9.3.2-3. + +**Table 5.2.9.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.9.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.9.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.9.3.3-1. + +**Table 5.2.9.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.9.3.3-2 and the response data structures and response codes specified in table 5.2.9.3.3-3. + +**Table 5.2.9.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.9.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------| +| SmfRegistration | M | 1 | 200 OK | The SMF registration that is to be retrieved | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.9.3.4 PATCH + +This method is used to modify SMF registration data in the UDR. + +This method shall support the URI query parameters specified in table 5.2.9.3.4-1. + +**Table 5.2.9.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | See 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.9.3.4-2 and the response data structures and response codes specified in table 5.2.9.3.4-3. + +**Table 5.2.9.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|------------------|---|-------------|------------------------------------------------------|--| +| array(PatchItem) | M | 1..N | Contains the delta data to the SMF registration data | | + +**Table 5.2.9.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | +| NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. | | | | | +| NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. | | | | | + +## 5.2.10 Resource: OperatorSpecificData + +### 5.2.10.1 Description + +This resource represents the UE's operator specific data. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +## 5.2.10.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/operator-specific-data + +This resource shall support the resource URI variables defined in table 5.2.10.2-1. + +**Table 5.2.10.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | +| NOTE: The content of ueId SUPI or GPSI depends on the service. | | + +## 5.2.10.3 Resource Standard Methods + +### 5.2.10.3.1 GET + +This method is used to retrieve operator specific data from the UDR. + +This method shall support the URI query parameters specified in table 5.2.10.3.1-1. + +**Table 5.2.10.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.10.3.1-2 and the response data structures and response codes specified in table 5.2.10.3.1-3. + +**Table 5.2.10.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.10.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| map(OperatorSpecificDataContainer) | M | 0..N | 200 OK | Upon success, a response body containing a map shall be returned. The key of the map is an operator-specific data element name and the value is the operator-specific data of such data element, for the current UE (identified by the {ueId} variable in the resource path).
If the resource does not contain any keys, the response consists of an empty JSON object (empty map). | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.10.3.2 PATCH + +This method is used to modify operator specific data in the UDR. + +This method shall support the URI query parameters specified in table 5.2.10.3.2-1. + +**Table 5.2.10.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.10.3.2-2 and the response data structures and response codes specified in table 5.2.10.3.2-3. + +**Table 5.2.10.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the operator specific data | + +**Table 5.2.10.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +### 5.2.10.3.3 PUT + +This method shall support the URI query parameters specified in table 5.2.10.3.3-1. + +**Table 5.2.10.3.3-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.10.3.3-2 and the response data structure, and response codes specified in table 5.2.10.3.3-3. + +**Table 5.2.10.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------------|---|-------------|-------------| +| map(OperatorSpecificDataContainer) | M | 1..N | | + +**Table 5.2.10.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| map(OperatorSpecificDataContainer) | O | 1..N | 201 Created | Upon successful creation of this resource, a representation of the created resource containing a map of OperatorSpecificDataContainer shall be returned. The key of the map is operator specific data element name and the value is the operator specific data of the UE. | +| n/a | O | | 204 No Content | Upon successful update of this resource, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.10.3.4 DELETE + +This method shall support the URI query parameters specified in table 5.2.10.3.4-1. + +**Table 5.2.10.3.4-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.10.3.4-2 and the response data structure, and response codes specified in table 5.2.10.3.4-3. + +**Table 5.2.10.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.10.3.4-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.11 Resource: Smsf3GppAccessRegistration + +### 5.2.11.1 Description + +This resource represents registered SMSF for 3GPP access. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]).- + +### 5.2.11.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/smsf-3gpp-access + +This resource shall support the resource URI variables defined in table 5.2.11.2-1. + +**Table 5.2.11.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +### 5.2.11.3 Resource Standard Methods + +#### 5.2.11.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.11.3.1-1. + +**Table 5.2.11.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.11.3.1-2 and the response data structures and response codes specified in table 5.2.11.3.1-3. + +**Table 5.2.11.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------| +| SmsfRegistration | M | 1 | The SMSF registration for 3GPP access is created or updated with the received information. | + +**Table 5.2.11.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| SmsfRegistration | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual SmsfRegistration for 3GPP access resource shall be returned. | +| SmsfRegistration | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual SmsfRegistration for 3GPP access resource shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +#### 5.2.11.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.11.3.2-1. + +**Table 5.2.11.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.11.3.2-2 and the response data structures and response codes specified in table 5.2.11.3.2-3. + +**Table 5.2.11.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 5.2.11.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +### 5.2.11.3.4 GET + +This method shall support the URI query parameters specified in table 5.2.11.3.4-1. + +**Table 5.2.11.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.11.3.4-2 and the response data structures and response codes specified in table 5.2.11.3.4-3. + +**Table 5.2.11.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.11.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------| +| SmsfRegistration | M | 1 | 200 OK | Upon success, a response body containing the SMSF registration for 3GPP access Data shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.12 Resource: SmsfNon3GppAccessRegistration + +### 5.2.12.1 Description + +This resource represents registered SMSF for Non 3GPP access. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.12.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/context-data/smsf-non-3gpp-access + +This resource shall support the resource URI variables defined in table 5.2.12.2-1. + +**Table 5.2.12.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +## 5.2.12.3 Resource Standard Methods + +### 5.2.12.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.12.3.1-1. + +**Table 5.2.12.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.12.3.1-2 and the response data structures and response codes specified in table 5.2.12.3.1-3. + +**Table 5.2.12.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------------------------------------------| +| SmsfRegistration | M | 1 | The SMSF registration for non 3GPP access is created or updated with the received information. | + +**Table 5.2.12.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| SmsfRegistration | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Individual SmsfRegistration for non 3GPP access resource shall be returned. | +| SmsfRegistration | M | 1 | 200 OK | Upon success, a response body containing a representation of the updated Individual SmsfRegistration for non 3GPP access resource shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +### 5.2.12.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.12.3.2-1. + +**Table 5.2.12.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.12.3.2-2 and the response data structures and response codes specified in table 5.2.12.3.2-3. + +**Table 5.2.12.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 5.2.12.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +### 5.2.12.3.4 GET + +This method shall support the URI query parameters specified in table 5.2.12.3.4-1. + +**Table 5.2.12.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.12.3.4-2 and the response data structures and response codes specified in table 5.2.12.3.4-3. + +**Table 5.2.12.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.12.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| SmsfRegistration | M | 1 | 200 OK | Upon success, a response body containing the SMSF registration for non 3GPP access Data shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.12A Resource: IpSmGwRegistration + +### 5.2.12A.1 Description + +This resource represents the registered IP-SM-GW. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.12A.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/context-data/ip-sm-gw + +This resource shall support the resource URI variables defined in table 5.2.12A.2-1. + +**Table 5.2.12A.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +### 5.2.12A.3 Resource Standard Methods + +#### 5.2.12A.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.12A.3.1-1. + +**Table 5.2.12A.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.12A.3.1-2 and the response data structures and response codes specified in table 5.2.12A.3.1-3. + +**Table 5.2.12A.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|--------------------------------------------------------------------------------| +| IpSmGwRegistration | M | 1 | The IP-SM-GW registration is created or updated with the received information. | + +**Table 5.2.12A.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.12A.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.12A.3.2-1. + +**Table 5.2.12A.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.12A.3.2-2 and the response data structures and response codes specified in table 5.2.12A.3.2-3. + +**Table 5.2.12A.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 5.2.12A.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.12A.3.3 PATCH + +This method shall support the URI query parameters specified in table 5.2.12A.3.3-1. + +**Table 5.2.12A.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.12A.3.3-2 and the response data structures and response codes specified in table 5.2.12A.3.3-3. + +**Table 5.2.12A.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the authentication subscription of a UE | + +**Table 5.2.12A.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified according to e.g. policy or local configuration.
The invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified.
The cause attribute may be used to convey any of the following errors:
- "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition, common data structures as listed in table 5.5-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +## 5.2.12A.3.4 GET + +This method shall support the URI query parameters specified in table 5.2.12A.3.4-1. + +**Table 5.2.12A.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.12A.3.4-2 and the response data structures and response codes specified in table 5.2.12A.3.4-3. + +**Table 5.2.12A.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.12A.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------| +| lpSmGwRegistration | M | 1 | 200 OK | Upon success, a response body containing the IP-SM-GW Registration Data shall be returned. | + +NOTE: In addition, common data structures as listed in table 5.5-1 are supported. + +## 5.2.12B Resource: MessageWaitingData + +### 5.2.12B.1 Description + +This resource represents the Message Waiting Data list for a given UE. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.12B.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/mwd + +This resource shall support the resource URI variables defined in table 5.2.12B.2-1. + +**Table 5.2.12B.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +### 5.2.12B.3 Resource Standard Methods + +#### 5.2.12B.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.12B.3.1-1. + +**Table 5.2.12B.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.12B.3.1-2 and the response data structures and response codes specified in table 5.2.12B.3.1-3. + +**Table 5.2.12B.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|------------------------------------------------------------------------------------| +| MessageWaitingData | M | 1 | The Message Waiting Data list is created or updated with the received information. | + +**Table 5.2.12B.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| MessageWaitingData | M | 1 | 201 Created | If the resource did not already exist, and it is successfully created, a response body containing a representation of the created Individual MessageWaitingData resource shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +#### 5.2.12B.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.12B.3.2-1. + +**Table 5.2.12B.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.12B.3.2-2 and the response data structures and response codes specified in table 5.2.12B.3.2-3. + +**Table 5.2.12B.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 5.2.12B.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.12B.3.3 PATCH + +This method shall support the URI query parameters specified in table 5.2.12B.3.3-1. + +**Table 5.2.12B.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.12B.3.3-2 and the response data structures and response codes specified in table 5.2.12B.3.3-3. + +**Table 5.2.12B.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the authentication subscription of a UE | + +**Table 5.2.12B.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified according to e.g. policy or local configuration.
The invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified.
The cause attribute may be used to convey any of the following errors:
- "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | +| NOTE 1: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | +| NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. | | | | | + +### 5.2.12B.3.4 GET + +This method shall support the URI query parameters specified in table 5.2.12B.3.4-1. + +**Table 5.2.12B.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.12B.3.4-2 and the response data structures and response codes specified in table 5.2.12B.3.4-3. + +**Table 5.2.12B.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.12B.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------| +| MessageWaitingData | M | 1 | 200 OK | Upon success, a response body containing the Message Waiting Data shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.13 Resource: SMSManagementSubscriptionData + +### 5.2.13.1 Description + +This resource represents the subscribed SMSManagementSubscriptionData for a SUPI for use in a serving PLMN. It is queried by the SMSF via the UDM after registering. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.13.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sms-mng-data + +This resource shall support the resource URI variables defined in table 5.2.13.2-1. + +**Table 5.2.13.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeld 3GPP TS 29.571 [3] | +| servingPlmnId | Represents the Serving PLMN ID (consisting of MCC, MNC) or SNPN (consisting of MCC, MNC and NID); see clauses 12.1 and 17.2 in 3GPP TS 23.003 [5]. pattern: "[0-9]{5,6}(-[A-Fa-f0-9]{11})?S" | + +## 5.2.13.3 Resource Standard Methods + +### 5.2.13.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.13.3.1-1. + +**Table 5.2.13.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.13.3.1-2 and the response data structures and response codes specified in table 5.2.13.3.1-3. + +**Table 5.2.13.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.13.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------| +| SmsManagementSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the SMS Management Subscription Data shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.14 Resource: ProvisionedParameterData + +### 5.2.14.1 Description + +This resource represents the subscribed ProvisionedParameterData for a GPSI. It is triggered by the AF/NEF via the UDM to update provisioned data stored for the subscriber. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.14.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/pp-data + +This resource shall support the resource URI variables defined in table 5.2.14.2-1. + +**Table 5.2.14.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +## 5.2.14.3 Resource Standard Methods + +### 5.2.14.3.1 GET + +This method retrieves the provisioned data of a given UE. + +This method shall support the URI query parameters specified in table 5.2.14.3.1-1. + +**Table 5.2.14.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.14.3.1-2 and the response data structures and response codes specified in table 5.2.14.3.1-3. + +**Table 5.2.14.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.14.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|----------------------------------------------------------------------------------------| +| PpData | M | 1 | 200 OK | Upon success, a response body is returned containing the provisioned data of the GPSI. | + +## 5.2.14.3.2 PATCH + +This method is used to modify the provisioned parameter data in the UDR. + +This method shall support the URI query parameters specified in table 5.2.14.3.2-1. + +**Table 5.2.14.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.14.3.2-2 and the response data structures and response codes specified in table 5.2.14.3.2-3. + +**Table 5.2.14.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the provisioned parameter data | + +**Table 5.2.14.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. + +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +## 5.2.14A Resource: PpProfileData + +### 5.2.14A.1 Description + +This resource represents the subscribed Parameter Provision Profile Data for a UE. It is queried by the UDM. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.14A.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/pp-profile-data + +This resource shall support the resource URI variables defined in table 5.2.14A.2-1. + +**Table 5.2.14A.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +### 5.2.14A.3 Resource Standard Methods + +#### 5.2.14A.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.14A.3.1-1. + +**Table 5.2.14A.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.14A.3.1-2 and the response data structures and response codes specified in table 5.2.14A.3.1-3. + +**Table 5.2.14A.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.14A.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------| +| PpProfileData | M | 1 | 200 OK | Upon success, a response body containing the Parameter Provision Profile that corresponds to the provided ueId | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.14B Resource: ProvisionedParameterDataEntry + +### 5.2.14B.1 Description + +This resource represents an Entry under the Provisioned Parameter Data store for a UE. It is triggered by the AF/NEF via the UDM to update or retrieve the provisioned data stored for the subscriber. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +## 5.2.14B.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/pp-data-store/{afInstanceId} + +This resource shall support the resource URI variables defined in table 5.2.14B.2-1. + +**Table 5.2.14B.2-1: Resource URI variables for this resource** + +| Name | Definition | +|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI, GPSI or Group Id or anyUE (see 3GPP TS 23.501 [4] clause 5.9.2)
- If representing a single UE, this parameter shall contain the GPSI or SUPI.
pattern: See pattern of type VarUeId 3GPP TS 29.571 [3]
- If representing a group of UEs, this parameter shall contain the External GroupId.
pattern: "^extgroupid-[^@]+@[^\@]+\+\$"
- If representing any UE, this parameter shall contain "anyUE".
pattern: "anyUE\$" | +| afInstanceId | The string identifying the originating AF | + +## 5.2.14B.3 Resource Standard Methods + +### 5.2.14B.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.14B.3.1-1. + +**Table 5.2.14B.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.14B.3.1-2 and the response data structures and response codes specified in table 5.2.14B.3.1-3. + +**Table 5.2.14B.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|----------------------------------------------| +| PpDataEntry | M | 1 | Contains a Parameter Provisioning Data entry | + +**Table 5.2.14B.3.1-4: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|------------------|------------------------------------------------------------------------------------------------------------------| +| PpDataEntry | M | 1 | 201
Created | Indicates a successful creation of the resource. | +| n/a | | | 204 No Content | Indicates a successful update of the resource. An empty response shall be returned. | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- CREATION NOT ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. | | | | | + +### 5.2.14B.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.14B.3.2-1. + +**Table 5.2.14B.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.14B.3.2-2 and the response data structures and response codes specified in table 5.2.14B.3.2-3. + +**Table 5.2.14B.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.14B.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | + +NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. + +### 5.2.14B.3.3 GET + +This method retrieves the provisioned data of a given UE. + +This method shall support the URI query parameters specified in table 5.2.14B.3.3-1. + +**Table 5.2.14B.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.14B.4.1-2 and the response data structures and response codes specified in table 5.2.14B.4.1-3. + +**Table 5.2.14B.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| N/A | | | | + +**Table 5.2.14B.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------|---|-------------|----------------|--------------------------------------------------------------------------------------------| +| PpDataEntry | M | 1 | 200 OK | Upon success, a response body is returned containing the provisioned data entry of the UE. | + +## 5.2.14C Resource: ProvisionedParameterDataEntries + +### 5.2.14C.1 Description + +This resource represents all the Entries under the Provisioned Parameter Data store for a UE. It is invoked by the UDM to obtain all or multiple Entries under the Provisioned Parameter Data store for a UE. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.14C.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/pp-data-store + +This resource shall support the resource URI variables defined in table 5.2.14C.2-1. + +**Table 5.2.14C.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI, GPSI or Group Id or anyUE (see 3GPP TS 23.501 [4] clause 5.9.2)
- If representing a single UE, this parameter shall contain the GPSI or SUPI.
pattern: See pattern of type VarUeId 3GPP TS 29.571 [3]
- If representing a group of UEs, this parameter shall contain the External GroupId.
pattern: "extgroupid-[^@]+@[^\@]+\+"
- If representing any UE, this parameter shall contain "anyUE".
pattern: "anyUE\$" | + +### 5.2.14C.3.1 GET + +This method retrieves the provisioned data of a given UE. + +This method shall support the URI query parameters specified in table 5.2.14C.3.1-1. + +**Table 5.2.14C.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.14C.4.1-2 and the response data structures and response codes specified in table 5.2.14C.4.1-3. + +**Table 5.2.14C.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| N/A | | | | + +**Table 5.2.14C.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------| +| PpDataEntryList | M | 1 | 200 OK | Upon success, a response body is returned containing the provisioned data entry of the UE. | + +## 5.2.15 Resource: SMSSubscriptionData + +### 5.2.15.1 Description + +This resource represents the subscribed SMS Subscription Data for a SUPI for use in a serving PLMN. It is queried by the AMF via the UDM after registering. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.15.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/{serving-plmn-id}/provisioned-data/sms-data + +This resource shall support the resource URI variables defined in table 5.2.15.2-1. + +**Table 5.2.15.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| Ueld | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeld 3GPP TS 29.571 [3] | +| servingPlmnId | Represents the Serving PLMN ID (consisting of MCC, MNC) or SNPn (consisting of MCC, MNC and NID); see clauses 12.1 and 17.2 in 3GPP TS 23.003 [5].
pattern: "[0-9]{5,6}(-[A-Fa-f0-9]{11})? \$" | + +### 5.2.15.3 Resource Standard Methods + +#### 5.2.15.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.15.3.1-1. + +**Table 5.2.15.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.15.3.1-2 and the response data structures and response codes specified in table 5.2.15.3.1-3. + +**Table 5.2.15.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.15.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------| +| SmsSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the SMS Management Subscription Data shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.16 Resource: SdmSubscriptions + +### 5.2.16.1 Description + +This resource represents the collection of SDM Subscriptions for a UE. + +This resource is modelled with the Collection resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.16.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/sdm-subscriptions + +This resource shall support the resource URI variables defined in table 5.2.16.2-1. + +**Table 5.2.16.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +### 5.2.16.3 Resource Standard Methods + +#### 5.2.16.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.16.3.1-1. + +**Table 5.2.16.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.16.3.1-2 and the response data structures and response codes specified in table 5.2.16.3.1-3. + +**Table 5.2.16.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.16.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------| +| array(SdmSubscription) | M | 1..N | 200 OK | Upon success, a response body containing the individual SDM subscriptions shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +#### 5.2.16.3.2 POST + +This method shall support the URI query parameters specified in table 5.2.16.3.2-1. + +**Table 5.2.16.3.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.16.3.1-2 and the response data structures and response codes specified in table 5.2.16.3.1-3. + +**Table 5.2.16.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|----------------------------------------------------------------------| +| SdmSubscription | M | 1 | Identifies the subscriber data subscription to be stored in the UDR. | + +If the uniqueSubscription attribute is set to true in the sdmSubscription object, the UDR shall only allow one UE based sdmSubscription per UE per NF service consumer identified by the ueId in URI and NfInstanceId in SdmSubscription, and if additional filter criteria (e.g. dnn and/or singleNssai) are present in the sdmSubscription, per filter criteria (see 3GPP TS 29.503 [6], clause 5.2.2.3.2). + +If the UDR detects that a subscription for the criteria already exist in the UDR, the UDR shall replace the old SdmSubscription with the new one. + +**Table 5.2.16.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SdmSubscription | M | 1 | 201
Created | Upon success, a response body containing a representation of the Ueld's Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.17 Resource: IndividualSdmSubscription + +### 5.2.17.1 Description + +This resource represents an individual SDM Subscription for a UE. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.17.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId} + +This resource shall support the resource URI variables defined in table 5.2.17.2-1. + +**Table 5.2.17.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeld 3GPP TS 29.571 [3] | +| subsId | Identifier of the subscription (as allocated by the UDR) | + +### 5.2.17.3 Resource Standard Methods + +#### 5.2.17.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.17.3.1-1. + +**Table 5.2.17.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.17.3.1-2 and the response data structures and response codes specified in table 5.2.17.3.1-3. + +**Table 5.2.17.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|------------------------------------------------------| +| SdmSubscription | M | 1 | The individual SDM subscription that is to be stored | + +**Table 5.2.17.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | If the resource does not exist, a response code of 404 Not Found shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.17.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.17.3.2-1. + +**Table 5.2.17.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.17.3.2-2 and the response data structures and response codes specified in table 5.2.17.3.2-3. + +**Table 5.2.17.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.17.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.17.3.3 PATCH + +This method shall support the URI query parameters specified in table 5.2.17.3.3-1. + +**Table 5.2.17.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.17.3.3-2 and the response data structures and response codes specified in table 5.2.17.3.3-3. + +**Table 5.2.17.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the Individual SDM Subscription data. | + +**Table 5.2.17.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification, there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +#### 5.2.17.3.4 GET + +This method shall support the URI query parameters specified in table 5.2.17.3.4-1. + +**Table 5.2.17.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.17.3.4-2 and the response data structures and response codes specified in table 5.2.17.3.4-3. + +**Table 5.2.17.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.17.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|----------------|----------------------------------------------------------------------------------------------| +| SdmSubscription | M | 1 | 200 OK | Upon success, a response body containing the individual SDM subscriptions shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.17A Resource: HssSdmSubscriptionInfo + +### 5.2.17A.1 Description + +This resource represents information relevant to an individual SDM Subscription for a UE. The UDM may need to consume the Nhss\_SDM\_Subscribe service operation to subscribe at the HSS (see 3GPP TS 29.563 [20]). After successful subscription at the HSS, the UDM needs to store within the UDR related information, e.g. the SubscriptionId allocated by the HSS. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.17A.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId}/hss-sdm-subscriptions + +This resource shall support the resource URI variables defined in table 5.2.17A.2-1. + +**Table 5.2.17A.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | +| subsId | Identifier of the subscription (allocated by the UDM) | + +### 5.2.17A.3 Resource Standard Methods + +#### 5.2.17A.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.17A.3.1-1. + +**Table 5.2.17A.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.17A.3.1-2 and the response data structures, and response codes specified in table 5.2.17A.3.1-3. + +**Table 5.2.17A.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|---------------------------| +| HssSubscriptionInfo | M | 1 | HSS SDM subscription info | + +**Table 5.2.17A.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +#### 5.2.17A.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.17A.3.2-1. + +**Table 5.2.17A.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.17A.3.2-2 and the response data structures, and response codes specified in table 5.2.17A.3.2-3. + +**Table 5.2.17A.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.17A.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.17A.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.17A.3.3-1. + +**Table 5.2.17A.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.17A.3.3-2 and the response data structures and response codes specified in table 5.2.17A.3.3-3. + +**Table 5.2.17A.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.17A.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------| +| HssSubscriptionInfo | M | 1 | 200 OK | Upon success, a response body containing HSS SDM Subscription Info shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.17A.3.4 PATCH + +This method shall support the URI query parameters specified in table 5.2.17A.3.4-1. + +**Table 5.2.17A.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.17A.3.2-2 and the response data structures, and response codes specified in table 5.2.17A.3.4-3. + +**Table 5.2.17A.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the provisioned parameter data | + +**Table 5.2.17A.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. + +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +## 5.2.18 Resource: EeSubscriptions + +### 5.2.18.1 Description + +This resource represents the collection of EE Subscriptions for a UE. + +This resource is modelled with the Collection resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.18.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/ee-subscriptions + +This resource shall support the resource URI variables defined in table 5.2.18.2-1. + +**Table 5.2.18.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +### 5.2.18.3 Resource Standard Methods + +#### 5.2.18.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.18.3.1-1. + +**Table 5.2.18.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | +| event-types | array(EventType) | O | 1..N | Indicates only to return the EE subscription data which contains at least one of the indicated Event Types and returned monitoring configuration data in EE subscription data only contains the data related to the indicated event types. | +| nf-identifiers | array(NfIdentifier) | O | 1..N | Indicates to return relevant EE subscription data along with associated Subscription resources created and stored while initiating subscriptions to NFs identified by NfType and NfInstanceId | + +This method shall support the request data structures specified in table 5.2.18.3.1-2 and the response data structures and response codes specified in table 5.2.18.3.1-3. + +**Table 5.2.18.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.18.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------| +| array(EeSubscriptionExt) | M | 1..N | 200 OK | Upon success, a response body containing the individual EE subscriptions shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.18.3.2 POST + +This method shall support the URI query parameters specified in table 5.2.18.3.2-1. + +**Table 5.2.18.3.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.18.3.1-2 and the response data structures and response codes specified in table 5.2.18.3.1-3. + +**Table 5.2.18.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|----------------------------------------------------------------------| +| EeSubscription | M | 1 | Identifies the subscriber data subscription to be stored in the UDR. | + +**Table 5.2.18.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EeSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the UeId's Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.19 Resource: IndividualEeSubscription + +### 5.2.19.1 Description + +This resource represents an individual EE Subscription for a UE. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.19.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/ee-subscriptions/{subsId} + +This resource shall support the resource URI variables defined in table 5.2.19.2-1. + +**Table 5.2.19.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | +| subsId | Identifier of the subscription (allocated by the UDR) | + +### 5.2.19.3 Resource Standard Methods + +#### 5.2.19.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.19.3.1-1. + +**Table 5.2.19.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19.3.1-2 and the response data structures and response codes specified in table 5.2.19.3.1-3. + +**Table 5.2.19.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-----------------------------------------------------| +| EeSubscription | M | 1 | The individual EE subscription that is to be stored | + +**Table 5.2.19.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | If the resource does not exist, a response code of 404 Not Found shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +#### 5.2.19.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.19.3.2-1. + +**Table 5.2.19.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19.3.2-2 and the response data structures and response codes specified in table 5.2.19.3.2-3. + +**Table 5.2.19.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.19.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.19.3.3 PATCH + +This method shall support the URI query parameters specified in table 5.2.19.3.3-1. + +**Table 5.2.19.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.19.3.3-2 and the response data structures and response codes specified in table 5.2.19.3.3-3. + +**Table 5.2.19.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|----------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the Individual EE Subscription data | + +**Table 5.2.19.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification, there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | +| NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. | | | | | +| NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. | | | | | + +### 5.2.19.3.4 GET + +This method shall support the URI query parameters specified in table 5.2.19.3.4-1. + +**Table 5.2.19.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19.3.4-2 and the response data structures and response codes specified in table 5.2.19.3.4-3. + +**Table 5.2.19.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.19.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------| +| EeSubscription | M | 1 | 200 OK | Upon success, a response body containing the individual EE subscriptions shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.19A Resource: IndividualEeGroupSubscription + +### 5.2.19A.1 Description + +This resource represents an individual EE Subscription for a group of UEs or any UE (i.e. all UEs). + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.19A.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId} + +This resource shall support the resource URI variables defined in table 5.2.19A.2-1. + +**Table 5.2.19A.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueGroupId | Represents the identifier of the Group of UEs. For this resource, either External Group Identifier or any UE shall be present.
Pattern: '^(extgroupid-[^@]+ @[^\@]+\+ anyUE)\$' | +| subsId | Identifier of the subscription (allocated by the UDM) | + +### 5.2.19A.3 Resource Standard Methods + +#### 5.2.19A.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.19A.3.1-1. + +**Table 5.2.19A.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19A.3.1-2 and the response data structures and response codes specified in table 5.2.19A.3.1-3. + +**Table 5.2.19A.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|--------------------------------------------------------------------------| +| EeSubscription | M | 1 | The individual EE subscription for the group of UEs that is to be stored | + +**Table 5.2.19A.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | If the resource does not exist, a response code of 404 Not Found shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.19A.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.19A.3.2-1. + +**Table 5.2.19A.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19A.3.2-2 and the response data structures and response codes specified in table 5.2.19A.3.2-3. + +**Table 5.2.19A.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.19A.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.19A.3.3 PATCH + +This method shall support the URI query parameters specified in table 5.2.19A.3.3-1. + +**Table 5.2.19A.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.19A.3.3-2 and the response data structures and response codes specified in table 5.2.19A.3.3-3. + +**Table 5.2.19A.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|----------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the Individual EE Group Subscription data | + +**Table 5.2.19A.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification, there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +## 5.2.19A.3.4 GET + +This method shall support the URI query parameters specified in table 5.2.19A.3.4-1. + +**Table 5.2.19A.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19A.3.4-2 and the response data structures and response codes specified in table 5.2.19A.3.4-3. + +**Table 5.2.19A.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.19A.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------| +| EeSubscription | M | 1 | 204 OK | Upon success, a response body containing the individual EE subscriptions for the groups of UEs shall be returned.. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.19B Resource: EeGroupProfileData + +### 5.2.19B.1 Description + +This resource represents the subscribed Event Exposure Profile Data for a group of UEs or any UE (i.e. all UEs). It is queried by the UDM by either external group identifier or anyUE. + +## 5.2.19B.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/group-data/{ueGroupId}/ee-profile-data + +This resource shall support the resource URI variables defined in table 5.2.19B.2-1. + +**Table 5.2.19B.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| ueGroupId | Represents the identifier of the Group of UEs. For this resource, either External Group Identifier or any UE shall be present.
pattern: See pattern of type VarUeGroupId | + +## 5.2.19B.3 Resource Standard Methods + +### 5.2.19B.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.19B.3.1-1. + +**Table 5.2.19B.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.19B.3.1-2 and the response data structures and response codes specified in table 5.2.19B.3.1-3. + +**Table 5.2.19B.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.19B.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| EeGroupProfileData | M | 1 | 200 OK | Upon success, a response body containing the Event Exposure Profile Data for a group of UEs, which corresponds to the provided ueGroupId. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.19C Resource: AmfGroupSubscriptionInfo + +### 5.2.19C.1 Description + +This resource represents information relevant to an individual EE Subscription for a group of UE or any UE. Depending on the Event Types of the EeSubscription, the UDM may need to consume the Namf\_EventExposure\_Subscribe service operation to subscribe at the AMF (see 3GPP TS 29.518 [13]). After successful subscription at the AMF, the UDM needs to store within the UDR related information, e.g. the SubscriptionId allocated by the AMF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.19C.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/amf-subscriptions + +This resource shall support the resource URI variables defined in table 5.2.19C.2-1. + +**Table 5.2.19C.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueGroupId | Represents the identifier of the Group of UEs. For this resource, either External Group Identifier or any UE shall be present.
Pattern: '^(extgroupid-[^@]+ @[^\@]+\+ anyUE)\$' | +| subsId | Identifier of the subscription (allocated by the UDR) | + +## 5.2.19C.3 Resource Standard Methods + +### 5.2.19C.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.19C.3.1-1. + +**Table 5.2.19C.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19C.3.1-2 and the response data structures, and response codes specified in table 5.2.19C.3.1-3. + +**Table 5.2.19C.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-------------------------------------------| +| array(AmfSubscriptionInfo) | M | 1..N | AMF subscription info for one or two AMFs | + +**Table 5.2.19C.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful update of this resource, an empty response body shall be returned. | +| array(AmfSubscriptionInfo) | M | 1..N | 201 Created | Upon successful update of this resource, a representation of the created resource containing an array of the AmfSubscriptionInfo as allocated by the UDR shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.19C.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.19C.3.2-1. + +**Table 5.2.19C.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19C.3.2-2 and the response data structures, and response codes specified in table 5.2.19C.3.2-3. + +**Table 5.2.19C.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.19C.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.19C.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.19C.3.3-1. + +**Table 5.2.19C.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19C.3.3-2 and the response data structure and response codes specified in table 5.2.31.3.3-3. + +**Table 5.2.19C.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.19C.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------| +| array(AmfSubscriptionInfo) | M | 1..N | 200 OK | Upon success, a response body containing AMF Subscription Infos shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.31.3.4 PATCH + +This method is used to modify the AMF subscription Infos in the UDR. + +This method shall support the URI query parameters specified in table 5.2.19C.3.4-1. + +**Table 5.2.19C.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.19C.3.2-2 and the response data structures and response codes specified in table 5.2.19C.3.4-3. + +**Table 5.2.19C.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|------------------|---|-------------|-----------------------------------------------------------|--| +| array(PatchItem) | M | 1..N | Contains the delta data to the provisioned parameter data | | + +**Table 5.2.19C.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +## 5.2.19D Resource: SmfGroupSubscriptionInfo + +### 5.2.19D.1 Description + +This resource represents information relevant to an individual EE Subscription for a group of UE or any UE. Depending on the Event Types of the EeSubscription, the UDM may need to consume the Nsmf\_EventExposure\_Subscribe service operation to subscribe at the SMF (see 3GPP TS 29.508 [21]). After successful subscription at the SMF, the UDM needs to store within the UDR related information, e.g. the SubscriptionId allocated by the SMF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.19D.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dt/{apiVersion}/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/smf-subscriptions + +This resource shall support the resource URI variables defined in table 5.2.19D.2-1. + +**Table 5.2.19D.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueGroupId | Represents the identifier of the Group of UEs. For this resource, either External Group Identifier or any UE shall be present.
Pattern: '^(extgroupid-[^@]+ @[^\@]+\+ anyUE)\$' | +| subsId | Identifier of the subscription (allocated by the UDR) | + +### 5.2.19D.3 Resource Standard Methods + +#### 5.2.19D.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.19D.3.1-1. + +**Table 5.2.31A.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19D.3.1-2 and the response data structures, and response codes specified in table 5.2.19D.3.1-3. + +**Table 5.2.19D.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-----------------------| +| SmfSubscriptionInfo | M | 1 | SMF subscription info | + +**Table 5.2.19D.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful update of this resource, an empty response body shall be returned. | +| SmfSubscriptionInfo | M | 1 | 201 Created | Upon successful creation of this resource, a representation of the created resource containing the SmfSubscriptionInfo as allocated by the UDR shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.19D.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.19D.3.2-1. + +**Table 5.2.19D.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19D.3.2-2 and the response data structure, and response codes specified in table 5.2.19D.3.2-3. + +**Table 5.2.19D.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.19D.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.19D.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.19D.3.3-1. + +**Table 5.2.19D.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19D.3.3-2 and the response data structures and response codes specified in table 5.2.19D.3.3-3. + +**Table 5.2.19D.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.19D.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------| +| SmfSubscriptionInfo | M | 1 | 200 OK | Upon success, a response body containing SMF Subscription Infos shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.19D.3.4 PATCH + +This method is used to modify the SMF subscription Infos in the UDR. + +This method shall support the URI query parameters specified in table 5.2.19D.3.4-1. + +**Table 5.2.19D.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.19D.3.2-2 and the response data structures, and response codes specified in table 5.2.19D.3.4-3. + +**Table 5.2.19D.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the provisioned parameter data | + +**Table 5.2.19D.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | +| NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. | | | | | +| NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. | | | | | + +## 5.2.19E Resource: HssGroupSubscriptionInfo + +### 5.2.19E.1 Description + +This resource represents information relevant to an individual EE Subscription for a group of UE. Depending on the Event Types of the EeSubscription, the UDM may need to consume the Nhss\_EventExposure\_Subscribe service operation to subscribe at the HSS (see 3GPP TS 29.562 [20]). After successful subscription at the HSS, the UDM needs to store within the UDR related information, e.g. the SubscriptionId allocated by the HSS. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +## 5.2.19E.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/hss-subscriptions + +This resource shall support the resource URI variables defined in table 5.2.19E.2-1. + +**Table 5.2.19E.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueGroupId | Represents the identifier of the Group of UEs. For this resource, an External Group Identifier shall be present.
Pattern: '^(extgroupid-[^@]+@[^\@])\$' | +| subsId | Identifier of the subscription (allocated by the UDR) | + +## 5.2.19E.3 Resource Standard Methods + +### 5.2.19E.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.19E.3.1-1. + +**Table 5.2.19E.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19E.3.1-2 and the response data structures, and response codes specified in table 5.2.19E.3.1-3. + +**Table 5.2.19E.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-----------------------| +| HssSubscriptionInfo | M | 1 | HSS subscription info | + +**Table 5.2.19E.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| HssSubscriptionInfo | M | 1 | 201 Created | Upon successful creation of this resource, a representation of the created resource containing the HssSubscriptionInfo as allocated by the UDR shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.19E.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.19E.3.2-1. + +**Table 5.2.19E.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19E.3.2-2 and the response data structures, and response codes specified in table 5.2.19E.3.2-3. + +**Table 5.2.19E.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.19E.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.19E.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.19E.3.3-1. + +**Table 5.2.19E.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19E.3.3-2 and the response data structures and response codes specified in table 5.2.19E.3.3-3. + +**Table 5.2.19E.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.19E.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------| +| HssSubscriptionInfo | M | 1 | 200 OK | Upon success, a response body containing HSS Subscription Infos shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.19E.3.4 PATCH + +This method is used to modify the HSS subscription Infos in the UDR. + +This method shall support the URI query parameters specified in table 5.2.19E.3.4-1. + +**Table 5.2.19E.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.19E.3.2-2 and the response data structures, and response codes specified in table 5.2.19E.3.4-3. + +**Table 5.2.19E.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|------------------|---|-------------|-----------------------------------------------------------|--| +| array(PatchItem) | M | 1..N | Contains the delta data to the provisioned parameter data | | + +**Table 5.2.19E.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +## 5.2.20 Resource: SubscriptionDataSubscriptions + +### 5.2.20.1 Description + +This resource is used to represent explicit subscriber data subscriptions to notifications. + +### 5.2.20.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/subs-to-notify + +This resource shall support the resource URI variables defined in table 5.2.20.2-1. + +**Table 5.2.20.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | + +### 5.2.20.3 Resource Standard Methods + +#### 5.2.20.3.1 POST + +This method shall support the URI query parameters specified in table 5.2.20.3.1-1. + +**Table 5.2.20.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.20.3.1-2 and the response data structures and response codes specified in table 5.2.20.3.1-3. + +**Table 5.2.20.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|----------------------------------------------------------------------| +| SubscriptionData Subscriptions | M | 1 | Identifies the subscriber data subscription to be stored in the UDR. | + +The UDR shall limit the number of subscriptions created based on the following criteria: + +- For the UE based sdmSubscriptions: if the sdmSubscription object is present with the uniqueSubscription attribute is set to true, the UDR shall only allow one UE based SubscriptionDataSubscriptions per UE per NF service consumer identified by the ueId in the URI and the NfInstanceId in SdmSubscription, and if additional filter criteria (e.g. dnn and/or singleNssai) are present in the sdmSubscription, per filter criteria (see 3GPP TS 29.503 [6], clause 5.2.2.3.2). +- For shared data sdmSubscriptions: if the sdmSubscription object is present with the uniqueSubscription attribute is set to true, there shall be only one SubscriptionDataSubscriptions per NF service consumer identified by nfInstanceId inside sdmSubscription (see 3GPP TS 29.503 [6], clause 5.2.2.3.2). +- For UE based UDM subscriptions: if the uniqueSubscription attribute is set to true in the SubscriptionDataSubscription object, the UDR shall only allow one UE based SubscriptionDataSubscriptions identified by the ueId attribute. + +If the UDR detects that a subscription for the criteria already exist in the UDR, the UDR shall replace the old SubscriptionDataSubscriptions with the new one. + +**Table 5.2.20.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionDataSubscriptions | M | 1 | 201
Created | Upon success, a response body containing a representation of the UeId's Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.20.3.2 GET + +This method shall support the URI query parameters specified in table 5.2.20.3.2-1. + +**Table 5.2.20.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| ue-id | VarUeId | M | 1 | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.20.3.2-2 and the response data structures and response codes specified in table 5.2.20.3.2-3. + +**Table 5.2.20.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.20.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------| +| array(SubscriptionDataSubscriptions) | M | 0..N | 200 OK | Upon success, a response body containing the individual subscriptions shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.20.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.2.20.3.3-1. + +**Table 5.2.20.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------------------------|--------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ue-id | VarUeld | M | 1 | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) of the UE associated to this subscription.

Pattern: See pattern of type VarUeld 3GPP TS 29.571 [3] | +| nf-instance-id | NfInstanceId | C | 0..1 | If included, this IE shall contain the Instance ID of the original NF Service Consumer of the UDM that created the subscription, and the UDR shall delete all subscriptions associated to the ue-id that were created by this specific nf-instance-id.

If not included, the UDR shall delete all subscriptions matching the rest of query parameters.

(See NOTE) | +| delete-all-nfs | boolean | C | 0..1 | If included, this IE indicates that the UDR shall delete all subscriptions associated to the ue-id.

(See NOTE) | +| implicit-unsubscribe-indication | boolean | O | 0..1 | If included, this IE shall contain the content of the "implicitUnsubscribe" attribute sent during the creation of the subscription in UDM.

If it is set to true, it means that the UDR shall delete all those subscriptions from NF Service Consumers of UDM, whose implicitUnsubscribe value is set to true.

It not included, or set to false, the UDR shall delete all subscriptions matching the rest of query parameters. | + +NOTE: Either "nf-instance-id" or "delete-all-nfs" shall be included in the request. + +This method shall support the request data structures specified in table 5.2.20.3.3-2 and the response data structures and response codes specified in table 5.2.20.3.3-3. + +**Table 5.2.20.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 5.2.20.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | + +NOTE: In addition, common data structures as listed in table 5.5-1 are supported. + +## 5.2.21 Resource: IndividualSubscriptionDataSubscription + +### 5.2.21.1 Description + +This resource is used to represent an individual subscriber data subscriptions to notifications. + +## 5.2.21.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/subs-to-notify/{subsId} + +This resource shall support the resource URI variables defined in table 5.2.21.2-1. + +**Table 5.2.21.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| subsId | The subsId identifies an individual SubscriptionDataSubscriptions to notifications. The value is allocated by the UDR during creation of the SubscriptionDataSubscriptions resource. | + +## 5.2.21.3 Resource Standard Methods + +### 5.2.21.3.1 DELETE + +This method shall support the URI query parameters specified in table 5.2.21.3.1-1. + +**Table 5.2.21.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.21.3.1-2 and the response data structures and response codes specified in table 5.2.21.3.1-3. + +**Table 5.2.21.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 5.2.21.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.21.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.2.21.3.2-1. + +**Table 5.2.21.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.21.3.2-2 and the response data structures and response codes specified in table 5.2.21.3.2-3. + +**Table 5.2.21.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|---------------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the Individual Subscription Data Subscription. | + +**Table 5.2.21.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification, when all the modification instructions in the PATCH request have been implemented, there is no body in the response message. | +| SubscriptionDataSubscriptions | C | 0..1 | 200 OK | Upon partial success, if any of the requested modifications have not been accepted, but the server has set different values than those requested by the client, in any of the attributes of the resource, the modified individual SubscriptionDataSubscriptions is returned with the accepted/confirmed values, e.g. the confirmed expiry time.
Also, upon partial success, if the NF service consumer does not support the "PatchReport" feature, the UDR shall return a SubscriptionDataSubscriptions object in the response.
(NOTE 2) | +| PatchResult | C | 0..1 | 200 OK | Upon partial success, if the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number and if some of the modification instructions in the PATCH request have been discarded while the rest are accepted, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. +NOTE 2: One of SubscriptionDataSubscriptions or PatchResult shall be returned. + +### 5.2.21.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.21.3.3-1. + +**Table 5.2.21.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.21.3.3-2 and the response data structures and response codes specified in table 5.2.21.3.3-3. + +**Table 5.2.21.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 5.2.21.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------| +| SubscriptionDataSubscriptions | M | 1 | 200 OK | Upon success, a response body containing the individual subscriptions shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.22 Resource: TraceData + +### 5.2.22.1 Description + +This resource represents the trace configuration data for a SUPI for use in a serving PLMN. It is queried by the AMF via the UDM after registering. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.22.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dt/{apiVersion}/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/trace-data + +This resource shall support the resource URI variables defined in table 5.2.22.2-1. + +**Table 5.2.22.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | +| servingPlmnId | Represents the Serving PLMN ID (consisting of MCC, MNC) or SNPN (consisting of MCC, MNC and NID); see clauses 12.1 and 17.2 in 3GPP TS 23.003 [5].
pattern: "[0-9]{5,6}(-[A-Fa-f0-9]{11})? \$" | + +### 5.2.22.3 Resource Standard Methods + +#### 5.2.22.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.22.3.1-1. + +**Table 5.2.22.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.22.3.1-2 and the response data structures and response codes specified in table 5.2.22.3.1-3. + +**Table 5.2.22.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.22.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------| +| TraceDataOrSharedTraceDataId | M | 1 | 200 OK | Upon success, a response body containing the Trace Configuration Data or a shared trace data ID shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.23 Resource: IdentityData + +### 5.2.23.1 Description + +This resource represents the identity data. It is queried by the UDM by GPSI or SUPI. + +### 5.2.23.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/identity-data + +This resource shall support the resource URI variables defined in table 5.2.23.2-1. + +**Table 5.2.23.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +### 5.2.23.3 Resource Standard Methods + +#### 5.2.23.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.23.3.1-1. + +**Table 5.2.23.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------|---|-------------|----------------------------------------------------------------| +| app-port-id | AppPortId | O | 0..1 | Application port identity, see 3GPP TS 23.501 [4] clause 4.4.7 | + +This method shall support the request data structures specified in table 5.2.23.3.1-2 and the response data structures and response codes specified in table 5.2.23.3.1-3. + +**Table 5.2.23.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.23.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IdentityData | M | 1 | 200 OK | Upon success, a response body containing the identity data that corresponds to the provided ueId | +| ProblemDetails | O | 0..1 | 404 Not Found | If the ueId does not exist, a response code of 404 Not Found shall be returned. The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | + +NOTE: In addition, common data structures as listed in table 5.5-1 are supported. + +## 5.2.24 Resource: AuthenticationStatus + +### 5.2.24.1 Description + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.24.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/authentication-data/authentication-status + +This resource shall support the resource URI variables defined in table 5.2.24.2-1. + +**Table 5.2.24.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [3] | + +### 5.2.24.3 Resource Standard Methods + +#### 5.2.24.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.24.3.1-1. + +**Table 5.2.24.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.24.3.1-2 and the response data structures and response codes specified in table 5.2.24.3.1-3. + +**Table 5.2.24.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-----------------------------------------------| +| AuthEvent | M | 1 | To store the authentication status of the UE. | + +**Table 5.2.24.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|--------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +### 5.2.24.3.2 GET + +This method shall support the URI query parameters specified in table 5.2.24.3.2-1. + +**Table 5.2.24.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.24.3.2-2 and the response data structures and response codes specified in table 5.2.24.3.2-3. + +**Table 5.2.24.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.24.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------| +| AuthEvent | M | 1 | 200 OK | Upon success, a response body containing the AuthEvent shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.24.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.2.24.3.3-1. + +**Table 5.2.24.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.24.3.3-2 and the response data structures and response codes specified in table 5.2.24.3.3-3. + +**Table 5.2.24.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.24.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.24A Resource: IndividualAuthenticationStatus + +### 5.2.24A.1 Description + +This resource is used to represent individual Authentication Status to be stored in the UDR. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.24A.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/authentication-data/authentication-status/{servingNetworkName} + +This resource shall support the resource URI variables defined in table 5.2.24A.2-1. + +**Table 5.2.24A.2-1: Resource URI variables for this resource** + +| Name | Definition | +|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.4.1 | +| ueId | Represents the Subscription Identifier SUPI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [3] | +| servingNetworkName | Represents the Serving Network Name.
pattern: See pattern of type ServingNetworkName in 3GPP TS 29.503 [6] | + +### 5.2.24A.3 Resource Standard Methods + +#### 5.2.24A.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.24A.3.1-1. + +**Table 5.2.24A.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.24A.3.1-2 and the response data structures and response codes specified in table 5.2.24A.3.1-3. + +**Table 5.2.24A.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-----------------------------------------------| +| AuthEvent | M | 1 | To store the authentication status of the UE. | + +**Table 5.2.24A.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +#### 5.2.24A.3.2 GET + +This method shall support the URI query parameters specified in table 5.2.24A.3.2-1. + +**Table 5.2.24A.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.24A.3.2-2 and the response data structures and response codes specified in table 5.2.24A.3.2-3. + +**Table 5.2.24A.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.24A.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------| +| AuthEvent | M | 1 | 200 OK | Upon success, a response body containing the AuthEvent shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.24A.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.2.24A.3.3-1. + +**Table 5.2.24A.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.24A.3.3-2 and the response data structures and response codes specified in table 5.2.24A.3.3-3. + +**Table 5.2.24A.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.24A.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.25 Resource: AuthenticationSoR + +### 5.2.25.1 Description + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +## 5.2.25.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/ue-update-confirmation-data/sor-data + +This resource shall support the resource URI variables defined in table 5.2.25.2-1. + +**Table 5.2.25.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|----------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [3] | + +## 5.2.25.3 Resource Standard Methods + +### 5.2.25.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.25.3.1-1. + +**Table 5.2.25.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.25.3.1-2 and the response data structures and response codes specified in table 5.2.25.3.1-3. + +**Table 5.2.25.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|---------------------------------------------------------------| +| SorData | M | 1 | The SoR acknowledgement information to be stored temporarily. | + +**Table 5.2.25.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.25.3.2 GET + +This method shall support the URI query parameters specified in table 5.2.25.3.2-1. + +**Table 5.2.25.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.25.3.2-2 and the response data structures and response codes specified in table 5.2.25.3.2-3. + +**Table 5.2.25.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.25.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|-------------------------------------------------------------------------| +| SorData | M | 1 | 200 OK | Upon success, a response body containing the SorData shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +### 5.2.25.3.3 PATCH + +This method is used to modify the "ME support of SOR-CMCI", "ME support of SOR-SNPN-SI" and "ME support of SOR-SNPN-SI-LS" stored in the UDR. + +This method shall support the URI query parameters specified in table 5.2.25.3.3-1. + +**Table 5.2.25.3.3-1.: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.25.3.3-2 and the response data structures, and response codes specified in table 5.2.25.3.3-3. + +**Table 5.2.25.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|----------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the contents of SorData | + +**Table 5.2.25.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +## 5.2.25A Resource: AuthenticationUPU + +### 5.2.25A.1 Description + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.25A.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/ue-update-confirmation-data/upu-data + +This resource shall support the resource URI variables defined in table 5.2.25A.2-1. + +**Table 5.2.25A.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|----------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [3] | + +## 5.2.25A.3 Resource Standard Methods + +### 5.2.25A.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.25A.3.1-1. + +**Table 5.2.25A.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.25A.3.1-2 and the response data structures and response codes specified in table 5.2.25A.3.1-3. + +**Table 5.2.25A.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|---------------------------------------------------------------| +| UpuData | M | 1 | The UPU acknowledgement information to be stored temporarily. | + +**Table 5.2.25A.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|--------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +### 5.2.25A.3.2 GET + +This method shall support the URI query parameters specified in table 5.2.25A.3.2-1. + +**Table 5.2.25A.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.25A.3.2-2 and the response data structures and response codes specified in table 5.2.25A.3.2-3. + +**Table 5.2.25A.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.25A.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------| +| UpuData | M | 1 | 200 OK | Upon success, a response body containing the UpuData shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.25B Resource: SubscribedSNSSAIs + +### 5.2.25B.1 Description + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.25B.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/ue-update-confirmation-data/subscribed-snssais + +This resource shall support the resource URI variables defined in table 5.2.25B.2-1. + +**Table 5.2.25B.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [3] | + +### 5.2.25B.3 Resource Standard Methods + +#### 5.2.25B.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.25B.3.1-1. + +**Table 5.2.25B.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.25B.3.1-2 and the response data structures and response codes specified in table 5.2.25B.3.1-3. + +**Table 5.2.25B.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|------------------------------------------------------------------------------| +| NssaiAckData | M | 1 | Contains the provisioning time stamp of the acknowledged subscribed S-NSSAIs | + +**Table 5.2.25B.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.25B.3.2 GET + +This method shall support the URI query parameters specified in table 5.2.25B.3.2-1. + +**Table 5.2.25B.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.25B.3.2-2 and the response data structures and response codes specified in table 5.2.25B.3.2-3. + +**Table 5.2.25B.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.25B.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------| +| NssaiAckData | M | 1 | 200 OK | Upon success, a response body containing the NssaiAckData shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.25C Resource: SubscribedCAG + +### 5.2.25C.1 Description + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.25C.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/ue-update-confirmation-data/subscribed-cag + +This resource shall support the resource URI variables defined in table 5.2.25C.2-1. + +**Table 5.2.25C.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|----------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [3] | + +### 5.2.25C.3 Resource Standard Methods + +#### 5.2.25C.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.25C.3.1-1. + +**Table 5.2.25C.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.25C.3.1-2 and the response data structures and response codes specified in table 5.2.25C.3.1-3. + +**Table 5.2.25C.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|------------|---|-------------|--------------------------------------------------------------|--| +| CagAckData | M | 1 | Contains the provisioning time stamp of the acknowledged CAG | | + +**Table 5.2.25C.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|--------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.25C.3.2 GET + +This method shall support the URI query parameters specified in table 5.2.25C.3.2-1. + +**Table 5.2.25C.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.25C.3.2-2 and the response data structures and response codes specified in table 5.2.25C.3.2-3. + +**Table 5.2.25C.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.25C.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------|---|-------------|----------------|----------------------------------------------------------------------------| +| CagAckData | M | 1 | 200 OK | Upon success, a response body containing the CagAckData shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.26 Resource: ProvisionedData + +### 5.2.26.1 Description + +This resource represents the subscribed ProvisionedData for a UE ID for use in a serving PLMN. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.26.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/{servingPlmnId}/provisioned-data + +This resource shall support the resource URI variables defined in table 5.2.26.2-1. + +**Table 5.2.26.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | +| servingPlmnId | Represents the Serving PLMN ID (consisting of MCC, MNC) or SNPN (consisting of MCC, MNC and NID); see clauses 12.1 and 17.2 in 3GPP TS 23.003 [5].
pattern: "[0-9]{5,6}(-[A-Fa-f0-9]{11})? \$" | + +## 5.2.26.3 Resource Standard Methods + +### 5.2.26.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.26.3.1-1. + +**Table 5.2.26.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------|-------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dataset-names | array(ProvisionedDataSetName) | O | 1..N | If included, this IE shall contain the names of data sets to be retrieved. If not included, all provisioned data sets shall be returned. | +| adjacent-plmns | array(PlmnId) | O | 1..N | PLMN identities of PLMNs adjacent to the PLMN serving the UE. If present the GET response may contain adjacentPlmnRestrictions for the indicated PLMNs.
May be present if dataset-names contains Access And Mobility Subscription Data | +| single-nssai | Snssai | O | 0..1 | When present without Slice Differentiator (sd), all slices identified by the given Slice/Service Type (sst) and any sd value (if any) shall be considered matching the query parameter.
May be present if dataset-names contains Session Management Subscription Data | +| dnn | Dnn | O | 0..1 | May be present if dataset-names contains Session Management Subscription Data | +| ext-group-ids | array(ExtGroupId) | O | 1..N | If included, this IE contain a list of external VN group identifiers for which the profiles are retrieved.
May be present if dataset-names contains Parameter Provisioning Profile Data | +| uc-purpose | UcPurpose | O | 0..1 | Represents the user consent purpose.
pattern: See pattern of type UcPurpose in 3GPP TS 29.503 [6]
May be present if dataset-names contains User Consent Data | + +NOTE: To retrieve data sets that are not specific to serving PLMNs (e.g., LCS\_PRIVACY, LCS\_MO, V2X, A2X, PROSE, ODB, EE\_PROF, PP\_PROF and NIDD\_AUTH), an NF service consumer should use UE Subscription Data Retrieve operation (see clause 5.2.47). + +This method shall support the request data structures specified in table 5.2.26.3.1-2 and the response data structures and response codes specified in table 5.2.26.3.1-3. + +**Table 5.2.26.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.26.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|----------------|-------------------------------------------------------------------------------------| +| ProvisionedDataSets | M | 1 | 200 OK | Upon success, a response body containing the requested data sets shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +**Table 5.2.26.3.1-4: Headers supported by the 200 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------| +| 3gpp-Sbi-Etags | string | O | 0..1 | See 3GPP TS 29.504 [2] | + +## 5.2.27 Resource: OperatorDeterminedBarringData + +### 5.2.27.1 Description + +This resource represents the subscribed OperatorDeterminedBarringData for a SUPI. It is queried by the UDM during registration. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.27.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/operator-determined-barring-data + +This resource shall support the resource URI variables defined in table 5.2.27.2-1. + +**Table 5.2.27.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +### 5.2.27.3 Resource Standard Methods + +#### 5.2.27.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.27.3.1-1. + +**Table 5.2.27.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.27.3.1-2 and the response data structures and response codes specified in table 5.2.27.3.1-3. + +**Table 5.2.27.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.27.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------| +| OdbData | M | 1 | 200 OK | Upon success, a response body containing the Operator Determined Barring Data shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.28 Resource: EeProfileData + +### 5.2.28.1 Description + +This resource represents a list of the Event Exposure Profile Data. It is queried by the UDM by either GPSI or SUPI. + +### 5.2.28.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/ee-profile-data + +This resource shall support the resource URI variables defined in table 5.2.28.2-1. + +**Table 5.2.28.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +### 5.2.28.3 Resource Standard Methods + +#### 5.2.28.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.28.3.1-1. + +**Table 5.2.28.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the " fields " query parameter shall be included. The " fields " query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.28.3.1-2 and the response data structures and response codes specified in table 5.2.28.3.1-3. + +**Table 5.2.28.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.28.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------| +| EeProfileData | M | 1 | 200 OK | Upon success, a response body containing the Event Exposure Profile that corresponds to the provided ueId | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.29 Resource: EeGroupSubscriptions + +### 5.2.29.1 Description + +This resource represents the collection of EE Subscriptions for a group of UEs or any UE (i.e. all UEs). + +This resource is modelled with the Collection resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.29.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/group-data/{ueGroupId}/ee-subscriptions + +This resource shall support the resource URI variables defined in table 5.2.29.2-1. + +**Table 5.2.29.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueGroupId | Represents the identifier of the Group of UEs. For this resource, either External Group Identifier or any UE shall be present.
pattern: ^(extgroupid-[^@]+ @[^\@]+\+ anyUE)\$ | + +### 5.2.29.3 Resource Standard Methods + +#### 5.2.29.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.29.3.1-1. + +**Table 5.2.29.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.29.3.1-2 and the response data structures and response codes specified in table 5.2.29.3.1-3. + +**Table 5.2.29.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.29.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------| +| array(EeSubscription) | M | 1..N | 200 OK | Upon success, a response body containing the individual EE subscriptions for the groups of UEs shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +#### 5.2.29.3.2 POST + +This method shall support the URI query parameters specified in table 5.2.29.3.2-1. + +**Table 5.2.29.3.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.19.3.2-2 and the response data structures and response codes specified in table 5.2.29.3.2-3. + +**Table 5.2.29.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-----------------------------------------------------------| +| EeSubscription | M | 1 | Identifies the data subscription to be stored in the UDR. | + +**Table 5.2.29.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EeSubscription | M | 1 | 201
Created | Upon success, a response body containing a representation of the Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | + +NOTE: In addition, common data structures as listed in table 5.5-1 are supported. + +## 5.2.30 Resource: SharedData + +### 5.2.30.1 Description + +This resource represents the collection of data that can be shared by multiple UEs. + +### 5.2.30.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/shared-data + +This resource shall support the resource URI variables defined in table 5.2.30.2-1. + +**Table 5.2.30.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | + +### 5.2.30.3 Resource Standard Methods + +#### 5.2.30.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.30.3.1-1. + +**Table 5.2.30.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|---------------------|---|-------------|-----------------------------------| +| shared-data-ids | array(SharedDataId) | M | 1..N | | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.30.3.1-2 and the response data structures and response codes specified in table 5.2.30.3.1-3. + +**Table 5.2.30.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.30.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------| +| array(SharedData) | M | 0..N | 200 OK | Upon success, a response body containing a list of SharedData shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.30A Resource: IndividualSharedData + +### 5.2.30A.1 Description + +This resource represents the individual shared data. + +### 5.2.30A.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/shared-data/{sharedDataId} + +This resource shall support the resource URI variables defined in table 5.2.30A.2-1. + +**Table 5.2.30A.2-1: Resource URI variables for this resource** + +| Name | Definition | +|--------------|-------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| sharedDataId | Contains the individual Shared Data Identifier. | + +### 5.2.30A.3 Resource Standard Methods + +#### 5.2.30A.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.30A.3.1-1. + +**Table 5.2.30A.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.30A.3.1-2 and the response data structures and response codes specified in table 5.2.30A.3.1-3. + +**Table 5.2.30A.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.30A.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| SharedData | M | 1 | 200 OK | Upon success, a response body containing SharedData shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- DATA_NOT_FOUND | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.31 Resource: AmfSubscriptionInfo + +### 5.2.31.1 Description + +This resource represents information relevant to an individual EE Subscription for a UE. Depending on the Event Types of the EeSubscription, the UDM may need to consume the Namf\_EventExposure\_Subscribe service operation to subscribe at the AMF (see 3GPP TS 29.518 [13]). After successful subscription at the AMF, the UDM needs to store within the UDR related information, e.g. the SubscriptionId allocated by the AMF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.31.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/amf-subscriptions + +This resource shall support the resource URI variables defined in table 5.2.31.2-1. + +**Table 5.2.31.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | +| subsId | Identifier of the subscription (allocated by the UDM) | + +### 5.2.31.3 Resource Standard Methods + +#### 5.2.31.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.31.3.1-1. + +**Table 5.2.31.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.31.3.1-2 and the response data structures and response codes specified in table 5.2.31.3.1-3. + +**Table 5.2.31.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-------------------------------------------| +| array(AmfSubscriptionInfo) | M | 1..N | AMF subscription info for one or two AMFs | + +**Table 5.2.31.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful update of this resource, an empty response body shall be returned. | +| array(AmfSubscriptionInfo) | M | 1..N | 201 Created | Upon successful update of this resource, a representation of the created resource containing an array of the AmfSubscriptionInfo as allocated by the UDR shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +### 5.2.31.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.31.3.2-1. + +**Table 5.2.31.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.31.3.2-2 and the response data structures and response codes specified in table 5.2.31.3.2-3. + +**Table 5.2.31.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.31.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +### 5.2.31.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.31.3.3-1. + +**Table 5.2.31.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.31.3.3-2 and the response data structures and response codes specified in table 5.2.31.3.3-3. + +**Table 5.2.31.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.31.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------| +| array(AmfSubscriptionInfo) | M | 1..N | 200 OK | Upon success, a response body containing AMF Subscription Infos shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.31.3.4 PATCH + +This method is used to modify the AMF subscription Infos in the UDR. + +This method shall support the URI query parameters specified in table 5.2.31.3.4-1. + +**Table 5.2.31.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.31.3.2-2 and the response data structures and response codes specified in table 5.2.31.3.4-3. + +**Table 5.2.31.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the provisioned parameter data | + +**Table 5.2.31.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | +| NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. | | | | | +| NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. | | | | | + +## 5.2.31A Resource: SmfSubscriptionInfo + +### 5.2.31A.1 Description + +This resource represents information relevant to an individual EE Subscription for a UE. Depending on the Event Types of the EeSubscription, the UDM may need to consume the Nsmf\_EventExposure\_Subscribe service operation to subscribe at the SMF (see 3GPP TS 29.508 [21]). After successful subscription at the SMF, the UDM needs to store within the UDR related information, e.g. the SubscriptionId allocated by the SMF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +## 5.2.31A.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/smf-subscriptions + +This resource shall support the resource URI variables defined in table 5.2.31A.2-1. + +**Table 5.2.31A.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | +| subsId | Identifier of the subscription (allocated by the UDM) | + +## 5.2.31A.3 Resource Standard Methods + +### 5.2.31A.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.31A.3.1-1. + +**Table 5.2.31A.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.31A.3.1-2 and the response data structures, and response codes specified in table 5.2.31A.3.1-3. + +**Table 5.2.31A.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-----------------------| +| SmfSubscriptionInfo | M | 1 | SMF subscription info | + +**Table 5.2.31A.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful update of this resource, an empty response body shall be returned. | +| SmfSubscriptionInfo | M | 1 | 201 Created | Upon successful creation of this resource, a representation of the created resource containing the SmfSubscriptionInfo as allocated by the UDR shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.31A.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.31A.3.2-1. + +**Table 5.2.31A.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.31A.3.2-2 and the response data structures, and response codes specified in table 5.2.31A.3.2-3. + +**Table 5.2.31A.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.31A.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.31A.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.31A.3.3-1. + +**Table 5.2.31A.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.31A.3.3-2 and the response data structures and response codes specified in table 5.2.31A.3.3-3. + +**Table 5.2.31A.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.31A.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------| +| SmfSubscriptionInfo | M | 1 | 200 OK | Upon success, a response body containing SMF Subscription Infos shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.31A.3.4 PATCH + +This method is used to modify the SMF subscription Infos in the UDR. + +This method shall support the URI query parameters specified in table 5.2.31A.3.4-1. + +**Table 5.2.31A.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.31A.3.2-2 and the response data structures, and response codes specified in table 5.2.31A.3.4-3. + +**Table 5.2.31A.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|------------------|---|-------------|-----------------------------------------------------------|--| +| array(PatchItem) | M | 1..N | Contains the delta data to the provisioned parameter data | | + +**Table 5.2.31A.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +## 5.2.31B Resource: HssSubscriptionInfo + +### 5.2.31B.1 Description + +This resource represents information relevant to an individual EE Subscription for a UE. Depending on the Event Types of the EeSubscription, the UDM may need to consume the Nhss\_EventExposure\_Subscribe service operation to subscribe at the HSS (see 3GPP TS 29.562 [20]). After successful subscription at the HSS, the UDM needs to store within the UDR related information, e.g. the SubscriptionId allocated by the HSS. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.31B.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/hss-subscriptions + +This resource shall support the resource URI variables defined in table 5.2.31B.2-1. + +**Table 5.2.31B.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | +| subsId | Identifier of the subscription (allocated by the UDM) | + +### 5.2.31B.3 Resource Standard Methods + +#### 5.2.31B.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.31B.3.1-1. + +**Table 5.2.31B.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.31B.3.1-2 and the response data structures, and response codes specified in table 5.2.31B.3.1-3. + +**Table 5.2.31B.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-----------------------| +| HssSubscriptionInfo | M | 1 | HSS subscription info | + +**Table 5.2.31B.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| HssSubscriptionInfo | M | 1 | 201 Created | Upon successful creation of this resource, a representation of the created resource containing the HssSubscriptionInfo as allocated by the UDR shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.31B.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.31B.3.2-1. + +**Table 5.2.31B.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.31B.3.2-2 and the response data structures, and response codes specified in table 5.2.31B.3.2-3. + +**Table 5.2.31B.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.31B.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.31B.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.31B.3.3-1. + +**Table 5.2.31B.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.31B.3.3-2 and the response data structures and response codes specified in table 5.2.31B.3.3-3. + +**Table 5.2.31B.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.31B.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------| +| HssSubscriptionInfo | M | 1 | 200 OK | Upon success, a response body containing HSS Subscription Infos shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.31B.3.4 PATCH + +This method is used to modify the HSS subscription Infos in the UDR. + +This method shall support the URI query parameters specified in table 5.2.31B.3.4-1. + +**Table 5.2.31B.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.31B.3.2-2 and the response data structures, and response codes specified in table 5.2.31B.3.4-3. + +**Table 5.2.31B.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the provisioned parameter data | + +**Table 5.2.31B.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | +| NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. | | | | | +| NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. | | | | | + +## 5.2.32 Resource: ContextData + +### 5.2.32.1 Description + +This resource represents the ContextData for a UE ID. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +## 5.2.32.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/context-data + +This resource shall support the resource URI variables defined in table 5.2.32.2-1. + +**Table 5.2.32.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +## 5.2.32.3 Resource Standard Methods + +### 5.2.32.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.32.3.1-1. + +**Table 5.2.32.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------| +| context-dataset-names | array(ContextDataSetName) | M | 2..N | If included, this IE shall contain the names of context data sets to be retrieved. | + +This method shall support the request data structures specified in table 5.2.32.3.1-2 and the response data structures and response codes specified in table 5.2.32.3.1-3. + +**Table 5.2.32.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.32.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------| +| ContextDataSets | M | 1 | 200 OK | Upon success, a response body containing the requested context data sets shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +**Table 5.2.32.3.1-4: Headers supported by the 200 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------| +| 3gpp-Sbi-Etags | string | O | 0..1 | See 3GPP TS 29.504 [2] | + +## 5.2.33 Resource: GroupIdentifiers + +### 5.2.33.1 Description + +This resource represents the collection of data that can be shared by multiple UEs. + +### 5.2.33.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/group-data/group-identifiers + +This resource shall support the resource URI variables defined in table 5.2.33.2-1. + +**Table 5.2.33.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | + +## 5.2.33.3 Resource Standard Methods + +### 5.2.33.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.33.3.1-1. + +**Table 5.2.33.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | +| ext-group-id | ExtGroupId | C | 0..1 | External Group ID | +| int-group-id | GroupId | C | 0..1 | Internal Group ID | +| ue-id-ind | boolean | C | 0..1 | Indication whether UE identifiers are required or not.
When present, it shall be set as following:
- true: UE identifiers are required
- false (default): UE identifiers are not required | + +NOTE: Either ext-group-id or int-group-id shall be present in the request. + +Either the ext-group-id or the int-group-id shall be present in the request. + +This method shall support the request data structures specified in table 5.2.33.3.1-2 and the response data structures and response codes specified in table 5.2.33.3.1-3. + +**Table 5.2.33.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.33.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| GroupIdentifiers | M | 1 | 200 OK | Upon success, a response body containing the group identifier(s) shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | If the ueld does not exist, a response code of 404 Not Found shall be returned. The "cause" attribute may be used to indicate one of the following application errors:
- GROUP_IDENTIFIER_NOT_FOUND
- DATA_NOT_FOUND | + +NOTE: In addition, common data structures as listed in table 5.5-1 are supported. + +## 5.2.34 Resource: 5GVnGroups + +### 5.2.34.1 Description + +This resource represents the store of 5G VN Group data. + +## 5.2.34.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/group-data/5g-vn-groups + +This resource shall support the resource URI variables defined in table 5.2.34.2-1. + +**Table 5.2.34.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | + +## 5.2.34.3 Resource Standard Methods + +### 5.2.34.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.34.3.1-1. + +**Table 5.2.34.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-------------|---|-------------|--------------------------------------------------------------------------------------| +| gpsi | array(Gpsi) | O | 0..N | Only those group's data are retrieved of which at least one of the GPSIs is a member | + +This method shall support the request data structures specified in table 5.2.34.3.1-2 and the response data structures and response codes specified in table 5.2.34.3.1-3. + +**Table 5.2.34.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.34.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| map(5GVnGroupConfiguration) | M | 0..N | 200 OK | Upon success, a response body containing the map (list of key-value pairs where ExtGroupId (see 3GPP TS 29.503 [6] serves as key) of 5GVnGroupConfiguration shall be returned. If the resource does not contain any keys, the response consists of an empty JSON object (empty map). | + +NOTE: In addition, common data structures as listed in table 5.5-1 are supported. + +## 5.2.35 Resource: Individual5GVnGroup + +### 5.2.35.1 Description + +This resource represents an individual 5G VN Group. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.35.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/group-data/5g-vn-groups/{externalGroupId} + +This resource shall support the resource URI variables defined in table 5.2.35.2-1. + +**Table 5.2.35.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------------|-------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| externalGroupId | Represents the External Identifier of the group | + +## 5.2.35.3 Resource Standard Methods + +### 5.2.35.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.35.3.1-1. + +**Table 5.2.35.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.35.3.1-2 and the response data structures and response codes specified in table 5.2.35.3.1-3. + +**Table 5.2.35.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|------------------------| +| 5GVnGroupConfiguration | M | 1 | See 3GPP TS 29.503 [6] | + +**Table 5.2.35.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5GVnGroupConfiguration | M | 1 | 201
Created | Upon success, a representation of the created resource shall be returned. | +| ProblemDetails | O | 0..1 | 403
Forbidden | If the resource already exists, a response code of 403 Forbidden shall be returned. | +| ProblemDetails | O | 0..1 | 403
Forbidden | If the internal group identifier allocated by the UDM is not unique (i.e. already exists in a 5GVnGroup identified by a different external group ID) a response code of 403 Forbidden shall be returned with application error INTERNAL_GROUP_ID_NOT_UNIQUE. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +NOTE: Creation of an Individual5GVnGroup has impacts to the UDR, to ensure consistency with other resources. These consistencies can be ensured by UDR-internal solutions. + After successful creation of an Individual5GVnGroup, representations of the resources AccessAndMobilitySubscriptionData and SessionManagementSubscriptionData associated to group member UEs may be retrieved by UDR-consumers (see clause 5.2.3.3.1 and 5.2.5.3.1). It is expected that the retrieved AccessAndMobilitySubscriptionData and the retrieved SessionManagementSubscriptionData contain group relevant information (e.g. the internal group id) of the Individual5GVnGroup the UE belongs to. + Similarly, the representation of the resource GroupIdentifiers may be retrieved by UDR consumers (see clause 5.2.33.3.1). It is expected that the retrieved GroupIdentifiers contain 5GVnGroup related information (e.g. external group Id, Internal Group Id, group member UEs) as part of the created 5GVnGroupConfiguration. + +### 5.2.35.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.35.3.2-1. + +**Table 5.2.35.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.35.3.2-2 and the response data structures and response codes specified in table 5.2.19.3.2-3. + +**Table 5.2.35.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.35.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.35.3.3 PATCH + +This method shall support the URI query parameters specified in table 5.2.35.3.3-1. + +**Table 5.2.35.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.35.3.3-2 and the response data structures and response codes specified in table 5.2.35.3.3-3. + +**Table 5.2.35.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the Individual 5GNvGroup | + +**Table 5.2.35.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification, there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | If the resource corresponding to the ExternalGroupId can't be found, the "cause" attribute shall be set to:
- GROUP_IDENTIFIER_NOT_FOUND | +| | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1 | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. + +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +#### 5.2.35.3.4 GET + +This method shall support the URI query parameters specified in table 5.2.35.3.4-1. + +**Table 5.2.35.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.35.3.4-2 and the response data structures and response codes specified in table 5.2.35.3.4-3. + +**Table 5.2.35.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.35.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------| +| 5GVnGroupConfiguration | M | 1 | 200 OK | Upon success, a response body containing the group configuration of the individual 5G VN Group shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.36 Resource: LcsPrivacySubscriptionData + +#### 5.2.36.1 Description + +This resource represents the subscribed LcsPrivacySubscriptionData for an UE. It is queried by the HGMLC or NEF via the UDM. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +#### 5.2.36.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/lcs-privacy-data + +This resource shall support the resource URI variables defined in table 5.2.36.2-1. + +**Table 5.2.36.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3]. | + +## 5.2.36.3 Resource Standard Methods + +### 5.2.36.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.36.3.1-1. + +**Table 5.2.36.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the " fields " query parameter shall be included. The " fields " query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.36.3.1-2 and the response data structures and response codes specified in table 5.2.36.3.1-3. + +**Table 5.2.36.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.36.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------| +| LcsPrivacyData | M | 1 | 200 OK | Upon success, a response body containing the LCS Privacy Subscription Data shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.37 Resource: LcsMobileOriginatedSubscriptionData + +### 5.2.37.1 Description + +This resource represents the subscribed LcsMobileOriginatedSubscriptionData for a SUPI. It is queried by the AMF via the UDM after registering. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.37.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/lcs-mo-data + +This resource shall support the resource URI variables defined in table 5.2.37.2-1. + +**Table 5.2.37.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +### 5.2.37.3 Resource Standard Methods + +#### 5.2.37.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.37.3.1-1. + +**Table 5.2.37.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the " fields " query parameter shall be included. The " fields " query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.37.3.1-2 and the response data structures and response codes specified in table 5.2.37.3.1-3. + +**Table 5.2.37.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.37.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------| +| LcsMoData | M | 1 | 200 OK | Upon success, a response body containing the LCS Mobile Originated Subscription Data shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.38 Resource: NiddAuthorizationData + +#### 5.2.38.1 Description + +This resource represents the subscribed NiddAuthorizationData for a GPSI. It is queried by the UDM during NIDD Authorization Data Retrieval and NIDD Authorization Data Update Notification. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +#### 5.2.38.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/nidd-authorization-data + +This resource shall support the resource URI variables defined in table 5.2.38.2-1. + +**Table 5.2.38.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Generic Public Subscription Identifier (see 3GPP TS 23.501 [4] clause 5.9.8) pattern: ^\^(msisdn-[0-9]{5,15} .+ extid-[^@]+ @[^\@]+\+ extgroupid-[^@]+\+ @[^\@]+\+)\$ | + +## 5.2.38.3 Resource Standard Methods + +### 5.2.38.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.38.3.1-1. + +**Table 5.2.38.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------------------------------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| single-nssai | Snssai | M | 1 | When present without Slice Differentiator (sd), all slices identified by the given Slice/Service Type (sst) and any sd value (if any) shall be considered matching the query parameter. | +| dnn | Dnn | M | 1 | | +| mtc-provider-information | MtcProviderInformation | M | 1 | | +| af-id | string | O | 0..1 | When present, indicates the string identifying the originating AF. | +| NOTE: This attribute shall contain an empty string when no MTC Provider information is available to the UDR service consumer. | | | | | + +This method shall support the request data structures specified in table 5.2.38.3.1-2 and the response data structures and response codes specified in table 5.2.38.3.1-3. + +**Table 5.2.38.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.38.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthorizationData | M | 1 | 200 OK | Upon success, a response body containing the NIDD Authorization Data shall be returned. | +| ProblemDetails | O | 1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- DNN_NOT_ALLOWED
- MTC_PROVIDER_NOT_ALLOWED
- AF_INSTANCE_NOT_ALLOWED
- SNNSAI_NOT_ALLOWED | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.39 Resource: CoverageRestrictionData + +### 5.2.39.1 Description + +This resource represents UE's subscribed enhanced Coverage Restriction Data for a UE identifier. It is queried by the UDM during Enhanced Coverage Restriction Data Retrieval. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.39.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dt/{apiVersion}/subscription-data/{ueId}/coverage-restriction-data + +This resource shall support the resource URI variables defined in table 5.2.39.2-1. + +**Table 5.2.39.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Generic Public Subscription Identifier (see 3GPP TS 23.501 [4] clause 5.9.8)
pattern: ^{msisdn-[0-9]{5,15} extid-[^@]+@[^\@]+\.[+]}\$ | + +## 5.2.39.3 Resource Standard Methods + +### 5.2.39.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.39.3.1-1. + +**Table 5.2.39.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.39.3.1-2 and the response data structures and response codes specified in table 5.2.39.3.1-3. + +**Table 5.2.39.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.39.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------| +| EnhancedCoverageRestrictionData | M | 1 | 200 OK | Upon success, a response body containing UE's subscribed enhanced Coverage Restriction Data. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.40 Resource: Location + +### 5.2.40.1 Description + +This resource represents the UE's Location Information for UE's identity (e.g. SUPI or GPSI). + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.40.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/location + +This resource shall support the resource URI variables defined in table 5.2.40.2-1. + +**Table 5.2.40.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +## 5.2.40.3 Resource Standard Methods + +### 5.2.40.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.40.3.1-1. + +**Table 5.2.40.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.40.3.1-2 and the response data structures and response codes specified in table 5.2.40.3.1-3. + +**Table 5.2.40.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.40.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------| +| LocationInfo | M | 1 | 200 OK | Upon success, a response body containing the LocationInfo shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.41 Resource: V2xSubscriptionData + +### 5.2.41.1 Description + +This resource represents UE's subscribed V2X Data for a UE identifier. It is queried by the UDM during V2X Subscription Data Retrieval. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.41.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/v2x-data + +This resource shall support the resource URI variables defined in table 5.2.41.2-1. + +**Table 5.2.41.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [4] clause 5.9.2) or the Generic Public Subscription Identifier (see 3GPP TS 23.501 [4] clause 5.9.8).
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +### 5.2.41.3 Resource Standard Methods + +#### 5.2.41.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.41.3.1-1. + +**Table 5.2.41.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.41.3.1-2 and the response data structures and response codes specified in table 5.2.41.3.1-3. + +**Table 5.2.41.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.41.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------| +| V2xSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing UE's subscribed V2X Data. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.41A Resource: ProseSubscriptionData + +### 5.2.41A.1 Description + +This resource represents UE's subscribed ProSe Service Data for a UE identifier. It is queried by the UDM during ProSe Subscription Data Data Retrieval. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.41A.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/prose-data + +This resource shall support the resource URI variables defined in table 5.2.41A.2-1. + +**Table 5.2.41A.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [4] clause 5.9.2) or the Generic Public Subscription Identifier (see 3GPP TS 23.501 [4] clause 5.9.8).
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +### 5.2.41A.3 Resource Standard Methods + +#### 5.2.41A.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.41A.3.1-1. + +**Table 5.2.41A.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.41A.3.1-2 and the response data structures and response codes specified in table 5.2.41A.3.1-3. + +**Table 5.2.41A.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.41A.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------| +| ProseSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing UE's subscribed ProSe Service Data. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.42 Resource: LcsBroadcastAssistanceSubscriptionData + +### 5.2.42.1 Description + +This resource represents the subscribed LcsBroadcast Assistance Subscription Data for an UE for use in a serving PLMN. It is queried by the LMF via the UDM. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.42.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/lcs-bca-data + +This resource shall support the resource URI variables defined in table 5.2.42.2-1. + +**Table 5.2.42.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2 and 5.9.8)
See pattern of type VarUeId in 3GPP TS 29.571 [3] | +| servingPlmnId | Represents the Serving PLMN ID (consisting of MCC, MNC) or SNPN (consisting of MCC, MNC and NID); see clauses 12.1 and 17.2 in 3GPP TS 23.003 [5].
pattern: "[0-9]{5,6}(-[A-Fa-f0-9]{11})?S" | + +### 5.2.42.3 Resource Standard Methods + +#### 5.2.42.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.42.3.1-1. + +**Table 5.2.42.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.42.3.1-2 and the response data structures and response codes specified in table 5.2.42.3.1-3. + +**Table 5.2.42.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.42.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------| +| LcsBroadcastAssistanceTypesData | M | 1 | 200 OK | Upon success, a response body containing the LCS Broadcast Assistance Data Subscription Data shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.43 Resource: 5GVnGroupsInternal + +### 5.2.43.1 Description + +This resource represents a read-only view of the collection resource of 5G VN Group data, so it can be queried based on the Internal Group Id from NF Service Consumers having such Id as the only way to identify a group (e.g. PCF). + +### 5.2.43.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/group-data/5g-vn-groups/internal + +This resource shall support the resource URI variables defined in table 5.2.43.2-1. + +**Table 5.2.43.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | + +### 5.2.43.3 Resource Standard Methods + +#### 5.2.43.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.43.3.1-1. + +**Table 5.2.43.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------------| +| internal-group-ids | array(GroupId) | M | 1..N | Return those 5G VN groups whose Internal Group ID corresponds with any of the Group IDs in this list. | + +This method shall support the request data structures specified in table 5.2.43.3.1-2 and the response data structures and response codes specified in table 5.2.43.3.1-3. + +**Table 5.2.43.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.43.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| map(5GVnGroupConfiguration) | M | 0..N | 200 OK | Upon success, a response body containing the map (list of key-value pairs where ExtGroupId (see 3GPP TS 29.503 [6] serves as key) of 5GVnGroupConfiguration shall be returned. If the resource does not contain any keys, the response consists of an empty JSON object (empty map). | + +## 5.2.44 Resource: Pp5gVnGroupProfileData + +### 5.2.44.1 Description + +This resource represents the Parameter Provision Profile Data for the 5G VN Groups. It is queried by the UDM. + +### 5.2.44.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/group-data/5g-vn-groups/pp-profile-data + +This resource shall support the resource URI variables defined in table 5.2.44.2-1. + +**Table 5.2.44.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------| +| apiRoot | See clause 6.1.1 | + +### 5.2.44.3 Resource Standard Methods + +#### 5.2.44.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.44.3.1-1. + +**Table 5.2.44.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| ext-group-ids | array(ExtGroupId) | O | 1..N | If included, this IE Contain a list of external VN group identifiers for which the profiles are retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.44.3.1-2 and the response data structures and response codes specified in table 5.2.44.3.1-3. + +**Table 5.2.44.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.44.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------| +| Pp5gVnGroupProfileData | M | 1 | 200 OK | Upon success, a response body containing the Parameter Provision Profile for 5G VN Groups. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.45 Resource: NiddAuthorizations + +### 5.2.45.1 Description + +This resource represents information relevant to NIDD authorizations. After successful NIDD authorization, the UDM needs to store within the UDR related information (e.g. authUpdateCallbackUri), so that it is possible to notify the UDM consumer later on if something has changed affecting these authorizations. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.45.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/nidd-authorizations + +This resource shall support the resource URI variables defined in table 5.2.45.2-1. + +**Table 5.2.45.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +### 5.2.45.3 Resource Standard Methods + +#### 5.2.45.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.45.3.1-1. + +**Table 5.2.45.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.45.3.1-2 and the response data structure, and response codes specified in table 5.2.45.3.1-3. + +**Table 5.2.45.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-------------------------| +| NiddAuthorizationInfo | M | 1 | NIDD Authorization Data | + +**Table 5.2.45.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful update of this resource, an empty response body shall be returned. | +| NiddAuthorizationInfo | M | 1 | 201 Created | Upon successful creation of this resource, a representation of the created resource containing an array of the NiddAuthorizationData as allocated by the UDR shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +#### 5.2.45.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.45.3.2-1. + +**Table 5.2.45.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.45.3.2-2 and the response data structure, and response codes specified in table 5.2.45.3.2-3. + +**Table 5.2.45.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.45.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.45.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.45.3.3-1. + +**Table 5.2.45.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.45.3.3-2 and the response data structure and response codes specified in table 5.2.45.3.3-3. + +**Table 5.2.45.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.45.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------| +| NiddAuthorizationInfo | M | 1 | 200 OK | Upon success, a response body containing NIDD Authorization Info shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.45.3.4 PATCH + +This method is used to modify the NIDD active authorizations in the UDR. + +This method shall support the URI query parameters specified in table 5.2.45.3.4-1. + +**Table 5.2.45.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.45.3.2-2 and the response data structures, and response codes specified in table 5.2.45.3.4-3. + +**Table 5.2.45.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the provisioned parameter data | + +**Table 5.2.45.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. + +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +## 5.2.46 Resource: 5MBSSubscriptionData + +### 5.2.46.1 Description + +This resource represents the subscribed 5MBS Data for a UE. SMF queries this data from UDM. + +### 5.2.46.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/5mbs-data + +This resource shall support the resource URI variables defined in table 5.2.46.2-1. + +**Table 5.2.46.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|----------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +### 5.2.46.3 Resource Standard Methods + +#### 5.2.46.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.46.3.1-1. + +**Table 5.2.46.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.46.3.1-2 and the response data structures and response codes specified in table 5.2.46.3.1-3. + +**Table 5.2.46.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.46.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------| +| MbsSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the 5MBS Subscription Data shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.47 Resource: UeSubscriptionData + +### 5.2.47.1 Description + +This resource represents the subscription data for a UE ID. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.47.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId} + +This resource shall support the resource URI variables defined in table 5.2.47.2-1. + +**Table 5.2.47.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +### 5.2.47.3 Resource Standard Methods + +#### 5.2.47.3.1 GET + +When the NF service consumer (e.g. UDM) and the UDR both support the UESubDataSetRetrieve feature (see clause 6.1.8 of 3GPP TS 29.504 [2]), then NF service consumer may send a GET method towards the UE subscription data resource URI (.../subscription-data/{ueId}) to retrieve the provisioned data sets of the UE subscription data sets. + +When the NF service consumer (e.g. UDM) and the UDR both also support the UESubDataSetRetrieveExt feature (see clause 6.1.8 of 3GPP TS 29.504 [2]) in addition to the UESubDataSetRetrieve feature, then NF service consumer may send a GET method towards the UE subscription data resource URI (.../subscription-data/{ueId}) to retrieve the provisioned data sets and/or context data sets of the UE subscription data sets. + +This method shall support the URI query parameters specified in table 5.2.47.3.1-1. + +**Table 5.2.47.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dataset-names | array(UeSubscribedDataSetName) | M | 1..N | This IE shall contain the names of data sets to the retrieved. | +| serving-plmn | PlmnId | C | 0..1 | This IE shall be present when at least one of the following serving PLMN specific data sets are indicated in the dataset-names IE:
- AM
- SMF_SEL
- SMS_SUB
- SM
- TRACE
- SMS_MNG
- LCS_BCA | +| adjacent-plmns | array(PlmnId) | O | 1..N | PLMN identities of PLMNs adjacent to the PLMN serving the UE. If present the GET response may contain adjacentPlmnRestrictions for the indicated PLMNs.
May be present if dataset-names contains Access And Mobility Subscription Data | +| single-nssai | Snssai | O | 0..1 | When present without Slice Differentiator (sd), all slices identified by the given Slice/Service Type (sst) and any sd value (if any) shall be considered matching the query parameter.
May be present if dataset-names contains Session Management Subscription Data | +| dnn | Dnn | O | 0..1 | May be present if dataset-names contains Session Management Subscription Data | +| ext-group-ids | array(ExtGroupId) | O | 1..N | If included, this IE Contain a list of external VN group identifiers for which the profiles are retrieved.
May be present if dataset-names contains Parameter Provisioning Profile Data | +| uc-purpose | UcPurpose | O | 0..1 | Represents the user consent purpose.
pattern: See pattern of type UcPurpose in 3GPP TS 29.503 [6]
May be present if dataset-names contains User Consent Data | + +This method shall support the request data structures specified in table 5.2.47.3.1-2 and the response data structures and response codes specified in table 5.2.47.3.1-3. + +**Table 5.2.47.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.47.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------| +| UeSubscribedDataSets | M | 1 | 200 OK | Upon success, a response body containing the requested data sets shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +**Table 5.2.47.3.1-4: Headers supported by the 200 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------| +| 3gpp-Sbi-Etags | string | O | 0..1 | See 3GPP TS 29.504 [2] | + +## 5.2.48 Resource: ServiceSpecificAuthorizationData + +### 5.2.48.1 Description + +This resource represents a GPSI's subscribed AuthorizationData for a specific service. It is queried by the UDM during Authorization Data Retrieval for a specific service and Service Specific Authorization Data Update Notification. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.48.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/service-specific-authorization-data/{serviceType} + +This resource shall support the resource URI variables defined in table 5.2.48.2-1. + +**Table 5.2.48.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Generic Public Subscription Identifier (see 3GPP TS 23.501 [4] clause 5.9.8)
pattern: ^(\msisdn-[0-9]{5,15} .+ extid-[^@]+@[^\@]+\+ extgroupid-[^@]+\+@[^\@]+\+)\$ | +| serviceType | In this release the only defined Service Type is "AF_GUIDANCE_FOR_URSP" | + +### 5.2.48.3 Resource Standard Methods + +#### 5.2.48.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.48.3.1-1. + +**Table 5.2.48.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| single-nssai | Snssai | O | 0..1 | When present without Slice Differentiator (sd), all slices identified by the given Slice/Service Type (sst) and any sd value (if any) shall be considered matching the query parameter. | +| dnn | Dnn | O | 0..1 | | +| mtc-provider-information | MtcProviderInformation | O | 0..1 | | +| af-id | string | O | 0..1 | When present, indicates the string identifying the originating AF. | + +This method shall support the request data structures specified in table 5.2.48.3.1-2 and the response data structures and response codes specified in table 5.2.48.3.1-3. + +**Table 5.2.48.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.48.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthorizationData | M | 1 | 200 OK | Upon success, a response body containing the Authorization Data shall be returned. | +| ProblemDetails | O | 1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- DATA_NOT_FOUND | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- DNN_NOT_ALLOWED
- MTC_PROVIDER_NOT_ALLOWED
- AF_INSTANCE_NOT_ALLOWED
- SNSSAI_NOT_ALLOWED | + +NOTE: In addition, common data structures as listed in table 5.5-1 are supported. + +## 5.2.49 Resource: SpecificServiceAuthorizations + +### 5.2.49.1 Description + +This resource represents information relevant to authorizations for specific services. After successful authorization, the UDM needs to store within the UDR related information (e.g. authUpdateCallbackUri), so that it is possible to notify the UDM consumer later on if something has changed affecting these authorizations. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.49.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/service-specific-authorizations/{serviceType} + +This resource shall support the resource URI variables defined in table 5.2.49.2-1. + +**Table 5.2.49.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | +| serviceType | In this release the only defined Service Type is "AF_GUIDANCE_FOR_URSP" | + +### 5.2.49.3 Resource Standard Methods + +#### 5.2.49.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.49.3.1-1. + +**Table 5.2.49.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.49.3.1-2 and the response data structure, and response codes specified in table 5.2.49.3.1-3. + +**Table 5.2.49.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------------|---|-------------|-------------------------------------| +| ServiceSpecificAuthorizationInfo | M | 1 | Specific Service Authorization Data | + +**Table 5.2.49.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful update of this resource, an empty response body shall be returned. | +| ServiceSpecificAuthorizationInfo | M | 1 | 201 Created | Upon successful creation of this resource, a representation of the created resource containing an array of the AuthorizationData for the specific service as allocated by the UDR shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.49.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.49.3.2-1. + +**Table 5.2.49.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.49.3.2-2 and the response data structure, and response codes specified in table 5.2.49.3.2-3. + +**Table 5.2.49.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.49.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.49.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.49.3.3-1. + +**Table 5.2.49.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.49.3.3-2 and the response data structure and response codes specified in table 5.2.49.3.3-3. + +**Table 5.2.49.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.49.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------| +| ServiceSpecificAuthorizationInfo | M | 1 | 200 OK | Upon success, a response body containing the authorization info for the specific service shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [8] are supported. | | | | | + +### 5.2.49.3.4 PATCH + +This method is used to modify the Service Specific active authorizations in the UDR. + +This method shall support the URI query parameters specified in table 5.2.49.3.4-1. + +**Table 5.2.49.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.49.3.2-2 and the response data structures, and response codes specified in table 5.2.49.3.4-3. + +**Table 5.2.49.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the provisioned parameter data | + +**Table 5.2.49.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1. | +| NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [8] are supported.
NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. | | | | | + +## 5.2.50 Resource: RoamingInfo + +### 5.2.50.1 Description + +This resource is used to represent the last 5GC/EPC common Roaming Information in the 3GPP access to be stored in the UDR by the UDM. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +## 5.2.50.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/context-data/roaming-information + +This resource shall support the resource URI variables defined in table 5.2.50.2-1. + +**Table 5.2.50.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +## 5.2.50.3 Resource Standard Methods + +### 5.2.50.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.50.3.1-1. + +**Table 5.2.50.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.50.3.1-2 and the response data structures and response codes specified in table 5.2.50.3.1-3. + +**Table 5.2.50.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------------------------| +| RoamingInfoUpdate | M | 1 | Contains the last 5GC/EPC common Roaming Information in the 3GPP access. | + +**Table 5.2.50.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| RoamingInfoUpdate | M | 1 | 201 Created | Upon success, a response body containing a representation of the created Roaming Information resource shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.50.3.2 GET + +This method shall support the URI query parameters specified in table 5.2.50.3.2-1. + +**Table 5.2.50.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.50.3.2-2 and the response data structures and response codes specified in table 5.2.50.3.2-3. + +**Table 5.2.50.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.50.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------| +| RoamingInfoUpdate | M | 1 | 200 OK | Upon success, a response body containing the last 5GC/EPC common Roaming Information in the 3GPP access shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.51 Resource: UserConsentData + +### 5.2.51.1 Description + +This resource represents UE's subscribed User Consent Data for a UE identifier. It is queried by the UDM during User Consent Data Retrieval. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.51.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/uc-data + +This resource shall support the resource URI variables defined in table 5.2.51.2-1. + +**Table 5.2.51.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [4] clause 5.9.2).
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +### 5.2.51.3 Resource Standard Methods + +#### 5.2.51.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.51.3.1-1. + +**Table 5.2.51.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | +| uc-purpose | UcPurpose | O | 0..1 | Represents the user consent purpose.
pattern: See pattern of type UcPurpose in 3GPP TS 29.503 [6] | + +This method shall support the request data structures specified in table 5.2.51.3.1-2 and the response data structures and response codes specified in table 5.2.51.3.1-3. + +**Table 5.2.51.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.51.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------| +| UcSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing UE's subscribed User Consent Data. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.52 Resource: PeiInfo + +### 5.2.52.1 Description + +This resource is used to represent the PEI Update Information of the 5GC/EPC domains to be stored in the UDR by the UDM. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.52.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/context-data/pei-info + +This resource shall support the resource URI variables defined in table 5.2.52.2-1. + +**Table 5.2.52.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +### 5.2.52.3 Resource Standard Methods + +#### 5.2.52.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.52.3.1-1. + +**Table 5.2.52.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.52.3.1-2 and the response data structures and response codes specified in table 5.2.52.3.1-3. + +**Table 5.2.52.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-----------------------------| +| PeiUpdateInfo | M | 1 | The PEI Update Information. | + +The UDM shall create or update this resource when the PEI is received from the AMF (3gpp access or non-3gpp access) or from the HSS. + +**Table 5.2.52.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned | +| PeiUpdateInfo | M | 1 | 201 Created | Upon success, a response body containing a representation of the resource of the created PEI Update Information shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.52.3.2 GET + +This method shall support the URI query parameters specified in table 5.2.52.3.2-1. + +**Table 5.2.52.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.52.3.2-2 and the response data structures and response codes specified in table 5.2.52.3.2-3. + +**Table 5.2.52.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.52.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------| +| PeiUpdateInfo | M | 1 | 200 OK | Upon success, a response body containing the PEI Update Information shall be returned. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.53 Resource: TimeSyncSubscriptionData + +### 5.2.53.1 Description + +This resource represents the subscribed Time Synchronization Subscription Data for a UE. This data is queried from UDM. + +### 5.2.53.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/time-sync-data + +This resource shall support the resource URI variables defined in table 5.2.53.2-1. + +**Table 5.2.53.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +### 5.2.53.3 Resource Standard Methods + +#### 5.2.53.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.53.3.1-1. + +**Table 5.2.53.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.53.3.1-2 and the response data structures and response codes specified in table 5.2.53.3.1-3. + +**Table 5.2.53.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.53.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------| +| TimeSyncSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the Time Synchronization Subscription Data shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.54 Resource: 5GMbsGroup + +#### 5.2.54.1 Description + +This resource represents the store of 5G MBS Group data. + +#### 5.2.54.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/group-data/mbs-group-membership + +This resource shall support the resource URI variables defined in table 5.2.54.2-1. + +**Table 5.2.54.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | + +#### 5.2.54.3 Resource Standard Methods + +##### 5.2.54.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.54.3.1-1. + +**Table 5.2.54.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-------------|---|-------------|--------------------------------------------------------------------------------------| +| gpsi | array(Gpsi) | O | 0..N | Only those group's data are retrieved of which at least one of the GPSIs is a member | + +This method shall support the request data structures specified in table 5.2.54.3.1-2 and the response data structures and response codes specified in table 5.2.54.3.1-3. + +**Table 5.2.54.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.54.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| map(MulticastMbsGroupMemb) | M | 0..N | 200 OK | Upon success, a response body containing the map (list of key-value pairs where ExtGroupId (see 3GPP TS 29.503 [6] serves as key) of MulticastMbsGroupMemb shall be returned. If the resource does not contain any keys, the response consists of an empty JSON object (empty map). | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.55 Resource: Individual5GmbsGroup + +### 5.2.55.1 Description + +This resource represents an individual 5G MBS Group. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.55.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/group-data/mbs-group-membership/{externalGroupId} + +This resource shall support the resource URI variables defined in table 5.2.55.2-1. + +**Table 5.2.55.2-1: Resource URI variables for this resource** + +| Name | Definition | +|-----------------|-------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| externalGroupId | Represents the External Identifier of the group | + +### 5.2.55.3 Resource Standard Methods + +#### 5.2.55.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.55.3.1-1. + +**Table 5.2.55.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.55.3.1-2 and the response data structures and response codes specified in table 5.2.55.3.1-3. + +**Table 5.2.55.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------| +| MulticastMbsGroupMemb | M | 1 | See 3GPP TS 29.503 [6] | + +**Table 5.2.55.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|------------------|-------------------------------------------------------------------------------------| +| MulticastMbsGroupMemb | M | 1 | 201
Created | Upon success, a representation of the created resource shall be returned. | +| ProblemDetails | O | 0..1 | 403
Forbidden | If the resource already exists, a response code of 403 Forbidden shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.55.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.55.3.2-1. + +**Table 5.2.55.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.2.55.3.2-2 and the response data structures and response codes specified in table 5.2.55.3.2-3. + +**Table 5.2.55.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.55.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +### 5.2.55.3.3 PATCH + +This method shall support the URI query parameters specified in table 5.2.55.3.3-1. + +**Table 5.2.55.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.55.3.3-2 and the response data structures and response codes specified in table 5.2.55.3.3-3. + +**Table 5.2.55.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the Individual 5GNNVGroup | + +**Table 5.2.55.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon successful modification, there is no body in the response message. (NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | If the resource corresponding to the ExternalGroupId can't be found, the "cause" attribute shall be set to:
- GROUP_IDENTIFIER_NOT_FOUND | +| | O | 0..1 | 403 Forbidden | If one or more attributes are not allowed to be modified according to e.g. policy or local configuration, then the invalidParams attribute shall contain the JSON pointers of attributes which are not allowed to be modified, and the cause attribute shall be set to "MODIFICATION_NOT_ALLOWED", see 3GPP TS 29.500 [8] table 5.2.7.2-1 | + +NOTE 1: In addition common data structures as listed in table 5.5-1 are supported. +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature number, the UDR shall respond with PatchResult. + +## 5.2.55.3.4 GET + +This method shall support the URI query parameters specified in table 5.2.55.3.4-1. + +**Table 5.2.55.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.55.3.4-2 and the response data structures and response codes specified in table 5.2.55.3.4-3. + +**Table 5.2.55.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.55.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------| +| MulticastMbsGroupMemb | M | 1 | 200 OK | Upon success, a response body containing the group configuration of the individual 5G MBS Group shall be returned. | + +NOTE: In addition, common data structures as listed in table 5.5-1 are supported. + +## 5.2.56 Resource: 5GMbsGroupsInternal + +### 5.2.56.1 Description + +This resource represents a read-only view of the collection resource of 5G MBS Group data, so it can be queried based on the Internal Group Id from NF Service Consumers having such Id as the only way to identify a group (e.g. PCF). + +## 5.2.56.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/group-data/mbs-group-membership/internal + +This resource shall support the resource URI variables defined in table 5.2.56.2-1. + +**Table 5.2.56.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | + +## 5.2.56.3 Resource Standard Methods + +### 5.2.56.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.56.3.1-1. + +**Table 5.2.56.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|----------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| internal-group-ids | array(GroupId) | M | 1..N | Return those 5G MBS groups whose Internal Group ID corresponds with any of the Group IDs in this list. | + +This method shall support the request data structures specified in table 5.2.56.3.1-2 and the response data structures and response codes specified in table 5.2.56.3.1-3. + +**Table 5.2.56.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.56.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| map(MulticastMbsGroupMemb) | M | 0..N | 200 OK | Upon success, a response body containing the map (list of key-value pairs where ExtGroupId (see 3GPP TS 29.503 [6] serves as key) of MulticastMbsGroupMemb shall be returned. If the resource does not contain any keys, the response consists of an empty JSON object (empty map). | + +## 5.2.57 Resource: Pp5gMbsGroupProfileData + +### 5.2.57.1 Description + +This resource represents the Parameter Provision Profile Data for the 5G MBS Groups. It is queried by the UDM. + +### 5.2.57.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/group-data/mbs-group-membership/pp-profile-data + +This resource shall support the resource URI variables defined in table 5.2.57.2-1. + +**Table 5.2.57.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------| +| apiRoot | See clause 6.1.1 | + +## 5.2.57.3 Resource Standard Methods + +### 5.2.57.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.57.3.1-1. + +**Table 5.2.57.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------| +| ext-group-ids | array(ExtGroupId) | O | 1..N | If included, this IE Contain a list of external MBS group identifiers for which the profiles are retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.57.3.1-2 and the response data structures and response codes specified in table 5.2.57.3.1-3. + +**Table 5.2.57.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.57.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------| +| Pp5gMbsGroupProfileData | M | 1 | 200 OK | Upon success, a response body containing the Parameter Provision Profile for 5G MBS Groups. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.58 Resource: UeUpdateConfirmation + +### 5.2.58.1 Description + +This resource represents the complete UE Update Confirmation Information. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.58.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/ue-update-confirmation-data + +This resource shall support the resource URI variables defined in table 5.2.58.2-1. + +**Table 5.2.58.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2) pattern: See pattern of type VarUeId 3GPP TS 29.571 [3] | + +## 5.2.58.3 Resource Standard Methods + +### 5.2.58.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.58.3.1-1. + +**Table 5.2.58.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.58.3.1-2 and the response data structures and response codes specified in table 5.2.58.3.1-3. + +**Table 5.2.58.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.58.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------|---|-------------|----------------|---------------------------------------------------------------------------------------------| +| UeUpdConfData | M | 1 | 200 OK | Upon success, a response body containing the UE Update Confirmation Data shall be returned. | + +NOTE: In addition common data structures as listed in table 5.5-1 are supported. + +## 5.2.59 Resource: LcsSubscriptionData + +### 5.2.59.1 Description + +This resource represents the subscribed LcsSubscriptionData for a SUPI. It is queried by the AMF or H-GMLC via the UDM after registering. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.59.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/lcs-susbscription-data + +This resource shall support the resource URI variables defined in table 5.2.59.2-1. + +**Table 5.2.59.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [4] clause 5.9.2)
See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +## 5.2.59.3 Resource Standard Methods + +### 5.2.59.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.59.3.1-1. + +**Table 5.2.59.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.59.3.1-2 and the response data structures and response codes specified in table 5.2.59.3.1-3. + +**Table 5.2.59.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.59.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------| +| LcsSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing the LCS Mobile Originated Subscription Data shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.60 Resource: RangingSIPosSubscriptionData + +### 5.2.60.1 Description + +This resource represents UE's subscribed Ranging and Sidelink Positioning Service Data for a UE identifier. It is queried by the UDM during Ranging and Sidelink Positioning Subscription Data Data Retrieval. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.60.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/ranging-slpos-data + +This resource shall support the resource URI variables defined in table 5.2.60.2-1. + +**Table 5.2.60.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [4] clause 5.9.2) or the Generic Public Subscription Identifier (see 3GPP TS 23.501 [4] clause 5.9.8).
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +### 5.2.60.3 Resource Standard Methods + +#### 5.2.60.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.60.3.1-1. + +**Table 5.2.60.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.60.3.1-2 and the response data structures and response codes specified in table 5.2.60.3.1-3. + +**Table 5.2.60.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.60.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------| +| RangingSIPosSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing UE's subscribed Ranging and Sidelink Positioning Service Data. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.2.61 Resource: A2xSubscriptionData + +### 5.2.61.1 Description + +This resource represents UE's subscribed A2X Data for a UE identifier. It is queried by the UDM during A2X Subscription Data Retrieval. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [7]). + +### 5.2.61.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//subscription-data/{ueId}/a2x-data + +This resource shall support the resource URI variables defined in table 5.2.61.2-1. + +**Table 5.2.61.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See 3GPP TS 29.504 [2] clause 6.1.1 | +| ueId | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [4] clause 5.9.2) or the Generic Public Subscription Identifier (see 3GPP TS 23.501 [4] clause 5.9.8).
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [3] | + +### 5.2.61.3 Resource Standard Methods + +#### 5.2.61.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.61.3.1-1. + +**Table 5.2.61.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [8] clause 6.6 | + +This method shall support the request data structures specified in table 5.2.61.3.1-2 and the response data structures and response codes specified in table 5.2.61.3.1-3. + +**Table 5.2.61.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.61.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------| +| A2xSubscriptionData | M | 1 | 200 OK | Upon success, a response body containing UE's subscribed A2X Data. | +| NOTE: In addition, common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.3 Notifications + +### 5.3.1 General + +This clause describes the resources to provide Notification to NF service consumers which have explicitly or implicitly subscribed to UDR to be notified when data is changed or removed, or when a stale check shall be triggered. + +### 5.3.2 Data Change Notification + +The POST method shall be used for Data Change Notifications. + +- For explicit subscriptions (i.e., subscriptions created under the "subs-to-notif" collection resource, the URI shall be as provided during the subscription procedure; +- For implicit subscriptions, the UDR shall use either a locally configured callback URI of the UDM, or the UDR may retrieve from NRF a default notification URI stored by UDM in NRF during the NF registration procedure. +- If the UDM uses implicit subscriptions to receive notifications from UDR, the UDM shall register in NRF a default notification URI globally at NF Profile level (see 3GPP TS 29.510 [19], clause 6.1.6.2.2), rather than registering individual default notification URIs per NF Service. + +The "callback" clause of the OpenAPI specification found in Annex A.2 associated to the POST method of the "subs-to-notif" resource shall be used as the notification request for both explicit and implicit subscriptions. + +NOTE: For explicit subscriptions, a stateless UDM/NF provides a URI which identifies a set of UDMs/NFs; a stateful UDM/NF provides a specific URI identifying a node. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 5.3.2-1. + +**Table 5.3.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 5.3.2-2 and of response data structures and response codes is specified in table 5.3.2-3. + +**Table 5.3.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | | +|------------------|---|-------------|-------------|--| +| DataChangeNotify | M | 1 | | | + +**Table 5.3.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | + +The structure of the Notifications from changes on the explicitly subscribed resources (i.e. the resource indicated by the MonitoredResourceUri) or implicitly subscribed resources of type Collection or Store, are described in Table 5.3.2-4. + +NOTE: Table 5.3.2-4 follows the considerations for handling JSON arrays described in 3GPP TS 29.501 Annex E. + +**Table 5.3.2-4: The structure of the Notifications of type Collection or Store** + +| Subscribed Resource name | DataChangeNotify Content Type | Description | +|--------------------------------------------|--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| SmfRegistrations (Store) | SmfRegList | The complete replacement array representation of the SmfRegList shall be included in the DataChangeNotify. | +| ProvisionedParameterDataEntries (Store) | PpDataEntryList | The complete replacement array representation of the PpDataEntryList shall be included in the DataChangeNotify. | +| SubscriptionDataSubscriptions (Collection) | array(SubscriptionDataSubscriptions) | The complete replacement array representation of the SubscriptionDataSubscriptions shall be included in the DataChangeNotify. | +| 5GVnGroups (Store) | map(5GVnGroupConfiguration) | The complete map representation shall be included in the DataChangeNotify. | + +### 5.3.3 Data Removal Notification + +The POST method shall be used for Data Removal Notifications. + +Data Removal Notifications are used for subscription withdraw cases implicitly subscribed by the UDM. + +- The UDR shall use either a locally configured callback URI of the UDM, or the UDR may retrieve from NRF a default notification URI stored by UDM in NRF during the NF registration procedure. +- The UDM should register in NRF a default notification URI globally at NF Profile level, rather than registering individual default notification URIs per NF Service. + +The "callback" clause of the OpenAPI specification found in Annex A.2 associated to the POST method of the "subs-to-notif" resource shall be used as the notification request. + +Resource URI: {callbackReference} + +Support of URI query parameters is specified in table 5.3.3-1. + +**Table 5.3.3-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 5.3.3-2 and of response data structures and response codes is specified in table 5.3.3-3. + +**Table 5.3.3-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| DataChangeNotify | M | 1 | notifyItems within the DataChangeNotify type shall indicate deletion of the resources Amf3GppAccessRegistration and/or AmfNon3GppAccessRegistration | + +**Table 5.3.3-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| NOTE: In addition common data structures as listed in table 5.5-1 are supported. | | | | | + +## 5.3.4 Stale Check Notification + +The POST method shall be used for Stale Check Notifications. + +Stale Check Notifications are used if one or several IndividualSmfRegistration resources for a given UeId are assumed/suspected to be stale e.g. due to a lost deregistration and are implicitly subscribed by the UDM. + +The UDR may use an internal, e.g. time based mechanism to determine when and whether a given IndividualSmfRegistration is assumed/suspected to be stale. + +Resource URI: {udmStaleCheckCallbackUri} + +Support of URI query parameters is specified in table 5.3.4-1. + +**Table 5.3.4-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 5.3.4-2 and of response data structures and response codes is specified in table 5.3.4-3. + +**Table 5.3.4-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-------------------------------------------------------------------| +| SmfRegistrationInfo | M | 1 | Contains a list of SMF registrations that are assumed to be stale | + +**Table 5.3.4-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | + +## 5.4 Data Model + +### 5.4.1 General + +This clause specifies the application data model supported by the API. + +Table 5.4.1-1 specifies the data types defined for the Nudr service based interface protocol. + +**Table 5.4.1-1: Nudr Subscriber Data specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------------|----------------|--------------------------------------------------------------------------------------------| +| AuthenticationSubscription | 5.4.2.2 | A UE's authentication data | +| OperatorSpecificDataContainer | 5.4.2.3 | Container for operator specific data | +| SmfRegList | 5.4.2.4 | The list of all the SMF registrations of a UE | +| SubscriptionDataSubscriptions | 5.4.2.5 | A subscription to notifications. | +| DataChangeNotify | 5.4.2.6 | Container for data which have changed and notification was requested when changed. | +| IdentityData | 5.4.2.7 | Identity data corresponds to the provided ueld | +| ProvisionedDataSets | 5.4.2.8 | Contains the provisioned data sets | +| SorData | 5.4.2.9 | Used to store the status of the latest SOR data update | +| UpuData | 5.4.2.9A | Used to store the status of the latest UPU data update | +| NssaiAckData | 5.4.2.9B | Used to store the status of the latest NSSAI data update | +| CagAckData | 5.4.2.9C | Used to store the status of the latest CAG data update | +| AmfSubscriptionInfo | 5.4.2.19 | Information the UDR stores and retrieves related to active subscriptions at the AMF(s) | +| EeProfileData | 5.4.2.20 | Event Exposure Profile Data | +| ContextDataSets | 5.4.2.22 | Contains the context data sets | +| SequenceNumber | 5.4.2.23 | Contains the SQN | +| MessageWaitingData | 5.4.2.24 | Message Waiting Data list | +| SmscData | 5.4.2.25 | Addresses of SM-Service Center entities with SMS waiting to be delivered to the UE | +| SmfSubscriptionInfo | 5.4.2.26 | Information the UDR stores and retrieves related to active subscriptions at the SMF(s) | +| SmfSubscriptionItem | 5.4.2.27 | Contains info about a single SMF event subscription | +| MtcProvider | 5.4.2.28 | MTC provider information | +| HssSubscriptionInfo | 5.4.2.29 | Information the UDR stores related to active subscriptions at the HSS(s) | +| HssSubscriptionItem | 5.4.2.30 | Contains info about a single HSS event subscription | +| EeGroupProfileData | 5.4.2.31 | The Event Exposure Profile Data for a group of UEs | +| Pp5gVnGroupProfileData | 5.4.2.32 | The Parameter Provision Profile Data for 5G VN groups | +| PpProfileData | 5.4.2.33 | The Parameter Provision Profile Data | +| AllowedMtcProviderInfo | 5.4.2.34 | Allowed MTC Providers or AFs Information to provision parameters for UE. | +| GroupIdentifiers | 5.4.2.35 | External or Internal Group Identifier with a list of group members | +| AuthorizationData | 5.4.2.36 | Authorization Information | +| NiddAuthorizationInfo | 5.4.2.37 | Information the UDR stores and retrieves related to active NIDD authorizations | +| PpDataEntryList | 5.4.2.38 | A list of the Provisioned Parameters entries. | +| UeSubscribedDataSets | 5.4.2.39 | Contains the subscribed data sets of a UE | +| ServiceSpecificAuthorizationInfo | 5.4.2.40 | Information the UDR stores and retrieves related to active Service Specific authorizations | +| NfIdentifier | 5.4.2.41 | Network Function Identifier | +| EeSubscriptionExt | 5.4.2.42 | Extended Event Exposure Subscription | +| AdditionalEeSubsInfo | 5.4.2.43 | Additional EE-Subscription Information | +| ImmediateReport | 5.4.2.44 | Immediate Report | +| Pp5gMbsGroupProfileData | 5.4.2.45 | The Parameter Provision Profile Data for 5G MBS groups | +| AllowedMbsInfo | 5.4.2.46 | Allowed AFs Information to provision parameters for UE. | +| UeUpdConfData | 5.4.2.47 | UE Update Confirmation Data | +| AdditionalDataRef | 5.4.2.48 | Additional Data Reference | +| VarPlmnId | 5.4.3.2 | String identifying a PLMN ID or an SNPN ID. | +| AuthMethod | 5.4.3.3 | Contains the Authentication Method | +| ProvisionedDataSetName | 5.4.3.4 | The name of data set | +| ContextDataSetName | 5.4.3.6 | The name of context data set | +| SqnScheme | 5.4.3.7 | Scheme for generation of Sequence Numbers | +| Sign | 5.4.3.8 | Sign of the DIF value | +| UeUpdateStatus | 5.4.3.9 | Status of the procedure | +| PpDataType | 5.4.3.10 | The data type of the Provisioned Parameters | +| UeSubscribedDataSetName | 5.4.3.11 | The name of subscribed data set | + +Table 5.4.1-2 specifies data types re-used by the Nudr service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nudr service based interface. + +**Table 5.4.1-2: Nudr re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------------------|---------------------|------------------------------------------------------------------------------------------------------| +| AccessAndMobilitySubscriptionData | 3GPP TS 29.503 [6] | Access and Mobility Subscription Data | +| SmfSelectionSubscriptionData | 3GPP TS 29.503 [6] | SMF Selection Subscription Data | +| SmSubsData | 3GPP TS 29.503 [6] | Session Management Subscription Data | +| Amf3GppAccessRegistration | 3GPP TS 29.503 [6] | The complete set of information relevant to the AMF where the UE has registered via 3GPP access. | +| AmfNon3GppAccessRegistration | 3GPP TS 29.503 [6] | The complete set of information relevant to the AMF where the UE has registered via non 3GPP access. | +| SmfRegistration | 3GPP TS 29.503 [6] | The complete set of information relevant to an SMF serving the UE | +| SmsfRegistration | 3GPP TS 29.503 [6] | The complete set of information relevant to the SMSF serving the UE. | +| SmsManagementSubscriptionData | 3GPP TS 29.503 [6] | SMS Management Subscription Data | +| SupportedFeatures | 3GPP TS 29.571 [3] | Used to negotiate the applicability of the optional features | +| ProblemDetails | 3GPP TS 29.571 [3] | Detailed information about the status code. | +| PpData | 3GPP TS 29.503 [6] | Parameter Provision Data | +| PpDataEntry | 3GPP TS 29.503 [6] | Provisioned Parameter Data Entry | +| SmsSubscriptionData | 3GPP TS 29.503 [6] | SMS Subscription Data | +| PatchItem | 3GPP TS 29.571 [3] | Data structure used for JSON patch. | +| SdmSubscription | 3GPP TS 29.503 [6] | A subscription to notifications | +| EeSubscription | 3GPP TS 29.503 [6] | A subscription to Notifications of event exposure | +| Uri | 3GPP TS 29.571 [3] | URI | +| TraceData | 3GPP TS 29.571 [3] | Trace Data | +| Dnn | 3GPP TS 29.571 [3] | Data Network Name | +| Snssai | 3GPP TS 29.571 [3] | Single NSSAI | +| VarUeld | 3GPP TS 29.571 [3] | String represents the SUPI or GPSI. | +| NfInstanceId | 3GPP TS 29.571 [3] | NF Instance Identifier | +| NotifyItem | 3GPP TS 29.571 [3] | Common data type used for data change notification. | +| OdbData | 3GPP TS 29.571 [3] | Operator Determined Barring Data | +| EventType | 3GPP TS 29.503 [6] | Event Type | +| ExtGroupId | 3GPP TS 29.503 [6] | External Group Identifier | +| PduSessionId | 3GPP TS 29.571 [3] | PDU Session ID which identifies a PDU session | +| DateTime | 3GPP TS 29.571 [3] | Date Time | +| UpuMac | 3GPP TS 29.509 [15] | MAC value for protecting UPU procedure (UPU-MAC-I AUSF and UPU-MAC-I UE ) | +| 5GVnGroupConfiguration | 3GPP TS 29.503 [6] | 5G VN Group Configuration data | +| PatchResult | 3GPP TS 29.571 [3] | Patch Result | +| SupportedFeatures | 3GPP TS 29.571 [3] | Supported Features | +| AppPortId | 3GPP TS 29.503 [6] | Application Port Identifier | +| LcsPrivacyData | 3GPP TS 29.503 [6] | LCS Privacy Subscription Data | +| LcsMoData | 3GPP TS 29.503 [6] | LCS Mobile Originated Subscription Data | +| MtcProviderInformation | 3GPP TS 29.571 [3] | An ID uniquely identifying MTC provider information | +| EnhancedCoverageRestrictionData | 3GPP TS 29.503 [6] | Enhanced Coverage Restriction Data | +| LocationInfo | 3GPP TS 29.503 [6] | Location Information | +| V2xSubscriptionData | 3GPP TS 29.503 [6] | V2X Subscription Data | +| E164Number | 3GPP TS 29.503 [6] | E164Number | +| NetworkNodeDiameterAddress | 3GPP TS 29.503 [6] | Diameter Address of an Network Node | +| IpSmGwRegistration | 3GPP TS 29.503 [6] | The complete set of information | + +| | | | +|---------------------------------|--------------------|------------------------------------------------------------| +| | | relevant to the IP-SM-GW where the UE has registered. | +| LcsBroadcastAssistanceTypesData | 3GPP TS 29.503 [6] | LCS Broadcast Assistance Data Types | +| ContextInfo | 3GPP TS 29.503 [6] | Contains the headers received by an NF. | +| NfGroupId | 3GPP TS 29.571 [3] | NF Group ID | +| ProseSubscriptionData | 3GPP TS 29.503 [6] | ProSe Service Subscription Data | +| PlmnId | 3GPP TS 29.571 [3] | PLMN ID | +| AppPortId | 3GPP TS 29.503 [6] | Application Port Id | +| AuthorizationInfo | 3GPP TS 29.503 [6] | Contains Authorization Information | +| MbsSubscriptionData | 3GPP TS 29.503 [6] | Contains 5MBS Subscription Data | +| ServiceType | 3GPP TS 29.503 [6] | Service Type | +| RoamingInfoUpdate | 3GPP TS 29.503 [6] | Roaming Information in EPC domain | +| UcSubscriptionData | 3GPP TS 29.503 [6] | User Consent Data | +| UcPurpose | 3GPP TS 29.503 [6] | User Consent Purpose | +| PeiUpdateInfo | 3GPP TS 29.503 [6] | PEI Update Information | +| SharedData | 3GPP TS 29.503 [6] | Shared Data | +| TimeSyncSubscriptionData | 3GPP TS 29.503 [6] | Contains Time Synchronization Subscription Data | +| LcsSubscriptionData | 3GPP TS 29.503 [6] | UE's other LCS Subscription Data | +| RangingSIPosSubscriptionData | 3GPP TS 29.503 [6] | Ranging and Sidelink Positioning Service Subscription Data | +| SmfRegistrationInfo | 3GPP TS 29.503 [6] | SMF Registration Information | +| A2xSubscriptionData | 3GPP TS 29.503 [6] | A2X Subscription Data | + +## 5.4.2 Structured data types + +### 5.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.4.2.2 Type: AuthenticationSubscription + +**Table 5.4.2.2-1: Definition of type AuthenticationSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| authenticationMethod | AuthMethod | M | 1 | String containing the Authentication Method ("5G_AKA", "EAP_AKA_PRIME", "EAP_TLS"...) that shall be used when the UE's device is 5G capable.

If AV generation for HSS is required in UDM, this attribute shall take any 5G AKA-based value (i.e. "5G_AKA" or "EAP_AKA_PRIME"). | +| encPermanentKey | string | C | 0..1 | The encrypted value (hexstring) of the permanent authentication key (K) (see 3GPP TS 33.501 [9]). It shall be present if the authentication method is "5G_AKA" or "EAP_AKA_PRIME" unless vector generation is to be done in the HSS. | +| protectionParameterId | string | C | 0..1 | Identifies a parameter set securely stored in the UDM (ARPF) that can be used to decrypt the encPermanentKey (and encOpcKey or encTopcKey if present). Values and their meaning are HPLMN-operator specific.
It shall be present if the authentication method is "5G_AKA" or "EAP_AKA_PRIME" unless vector generation is to be done in the HSS. | +| sequenceNumber | SequenceNumber | C | 0..1 | String containing the SQN as defined in 3GPP TS 33.102 [10].
It shall be present if the authentication method is "5G_AKA" or "EAP_AKA_PRIME" unless vector generation is to be done in the HSS. | +| authenticationManagementField | string | C | 0..1 | Hexstring containing the Authentication management field as defined in 3GPP TS 33.501 [9].
It shall be present if the authentication method is "5G_AKA" or "EAP_AKA_PRIME" unless vector generation is to be done in the HSS.
Pattern: "[A-Fa-f0-9]{4}\$" | +| algorithmId | string | C | 0..1 | Identifies a parameter set securely stored in the UDM (ARPF) that provides details on the algorithm and parameters used to generate authentication vectors. Values and their meaning are HPLMN-operator specific.
It shall be present if the authentication method is "5G_AKA" or "EAP_AKA_PRIME" unless vector generation is to be done in the HSS. | +| encOpcKey | string | O | 0..1 | Hexstring of the encrypted OPC Key. Presence indicates that the provided value (decrypted) shall be used instead of the value derived from OP and K. | +| encTopcKey | string | O | 0..1 | Hexstring of the encrypted TOPC Key. Presence indicates that the provided value (decrypted) shall be used instead of the value derived from TOP and K. | +| hssGroupId | NfGroupId | O | 0..1 | Identity of the HSS group associated with the subscription that might be used by the UDM to discover the HSS; see 3GPP TS 29.510 [19]. This attribute may be present if the vectorGenerationInHss attribute is present and set to True. | +| vectorGenerationInHss | boolean | O | 0..1 | True indicates that the UDM needs to retrieve an Authentication Vector from the HSS; False and absence indicates that vector generation shall be performed in the UDM. | +| n5gcDeviceAuthMethod | AuthMethod | O | 0..1 | String containing the Authentication Method that shall be used when the UE's device is Non-5G-Capable behind Cable RGs in private networks or in isolated deployment scenarios with wireline access. See NOTE. | +| rgAuthenticationInd | boolean | O | 0..1 | true: indicates that authentication by the home network is not required if authentication has been completed by the W-5GAN. See 3GPP TS 33.501 [9] clause 7b.
false (default): otherwise. | + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supi | Supi | C | 0..1 | If present, this IE shall contain the UE's SUPI which shall contain an IMSI.
It shall be present if the subscription is allowed to be identified by a pseudonym of the SUPI e.g. by a GCI or GLI that is not the SUPI. | +| akmaAllowed | boolean | O | 0..1 | This IE indicates whether or not the subscriber is allowed to use AKMA:
- true: subscriber is allowed to use AKMA
- absent or false: subscriber is not allowed to use AKMA | +| routingId | string | C | 0..1 | This IE shall be present if the akmaAllowed is set to "true".
When present, this IE shall include the Routing Indicator contained in the SUCI (see 3GPP TS 23.003 [5], clause 2.2B). | +| NOTE: The attribute n5gcDeviceAuthMethod is used for EAP-TLS, which is described in the informative annex O of 3GPP TS 33.501 [9] and is not mandatory to support. | | | | | + +### 5.4.2.3 Type: OperatorSpecificDataContainer + +**Table 5.4.2.3-1: Definition of type OperatorSpecificDataContainer** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dataType | string | M | 1 | This attribute value must be a string equals to the name of the actual data type of the "Value" attribute. | +| value | any type | M | 1 | | +| dataTypeDefinition | string | O | 0..1 | If present, this attribute is applicable when "dataType" takes value "object" or "array" and it shall contain a JSON Pointer expression referencing a JSON Schema data type definition (same as how the attribute "\$ref" is used in JSON Schema specifications), which the "value" attribute must conform to. | +| supportedFeatures | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features. This parameter shall be supplied by the UDR in the response to the GET request when the GET request includes the "supported-features" query parameter and the UDR supports feature negotiation for the OperatorSpecificData resource defined in this specification and in 3GPP TS 29.519 [17]. | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource. This attribute may be provided in the response of successful resource creation. | + +EXAMPLE 1: A JSON object of type "OperatorSpecificDataContainer" can be as follows: + +``` +{ + "dataType": "object", + "value": { + "operatorData1": "foo", + "operatorData2": 123, + "operatorData3": false + }, + "dataTypeDefinition": "https://operator.com/definitions.json#/OpSpecificDataType" +} +``` + +And where the file "/definitions.json" contains a fragment as follows: + +``` +{ + "OpSpecificDataType": { + "type": "object", + "properties": { + "operatorData1": { + "type": "string" + }, + "operatorData2": { +``` + +``` + + "type": "integer" + }, + "operatorData3": { + "type": "boolean" + } +} +} +} + +``` + +EXAMPLE 2: A JSON object of type "OperatorSpecificDataContainer" can be as follows: + +``` + +{ + "dataType": "array", + "value": [ "foo", "bar" ], + "dataTypeDefinition": "https://operator.com/definitions.json#/OpSpecificDataType2" +} + +``` + +And where the file "/definitions.json" contains a fragment as follows: + +``` + +{ + "OpSpecificDataType2": { + "type": "array", + "items": { + "type": "string", + "minLength": 3 + }, + "minItems": 1 + } +} + +``` + +#### 5.4.2.4 Type: SmfRegList + +**Table 5.4.2.4-1: Definition of type SmfRegList** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| N/A | array(SmfRegistration) | M | 0..N | Each member of the array (if any) is an individual SMF registration of the UE.
An empty array indicates absence of any SmfRegistration. | + +## 5.4.2.5 Type: SubscriptionDataSubscriptions + +**Table 5.4.2.5-1: Definition of type SubscriptionDataSubscriptions** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| callbackReference | Uri | M | 1 | Identifies the UDM/NF pool or an individual UDM/NF which should be used by the UDR to send notification to UDM/NF. | | +| originalCallbackReference | Uri | O | 0..1 | URI provided by the NF service consumer to the UDM to receive notifications from the UDR.

If "sdmSubscription" is present, this attribute may be absent (and, if it is also present, it shall take the same value as the attribute "callbackReference" of "sdmSubscription"). | | +| ueId | VarUeId | O | 0..1 | User identity if subscription to notifications is related to a user. | | +| monitoredResourceUris | array(Uri) | M | 1..N | A set of URIs that identify the resources for which a modification of the representation triggers a notification.
The URI shall take the form of either an absolute URI or an absolute-path reference as defined in IETF RFC 3986 [16].
The URI shall not contain query parameters.
See NOTE 1. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in a subscription response, if, based on operator policy and taking into account the expiry time included in the request, the UDR needs to include an expiry time.
This IE may be included in a subscription request. When present, this IE shall represent the time after which the subscription becomes invalid.
The absence of this attribute in the subscription response means the subscription to be valid without an expiry time. | | +| sdmSubscription | SdmSubscription | O | 0..1 | Data related to the subscription to changes on SDM data, created by the NF Service Consumer of the UDM (see 3GPP TS 29.503 [6], clause 6.1.6.2.3). | | +| hssSubscriptionInfo | HssSubscriptionInfo | O | 0..1 | HSS Subscription Info associated with the sdmSubscription. | | +| subscriptionId | string | C | 0..1 | This attribute shall be present if the SubscriptionDataSubscriptions is sent in a GET response message or in a Notification. It identifies the individual SubscriptionDataSubscriptions stored in the UDR and may be used by the UDM to e.g. delete or update a SubscriptionDataSubscriptions.

Read Only: true | | +| uniqueSubscription | boolean | C | 0..1 | This attribute shall be present and set to true if the UDM requests the UDR to maintain a single UDM subscription per UE.

The attribute shall not be set to true if the sdmSubscription attribute is present.

The attribute shall not be set to true if the sdmSubscription and UeId attributes are not present. | | + +| | | | | | | +|--------------------|--------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| | | | | See clause 5.2.20.3.1. | | +| supportedFeatures | SupportedFeatures | O | 0..1 | Used to negotiate the applicability of optional features | | +| immediateReport | boolean | O | 0..1 | This IE indicates whether immediate report is requested or not.

When present, this IE shall be set as following:
- true: immediate report is required
- false (default) immediate report is not required | ImmediateReport | +| report | ImmediateReport | C | 0..1 | This IE shall be present in Subscribe response, if the immediateReport attribute is set to "true" in Subscribe request.

When present, this IE shall contain the representation of subscription data sets that need to be monitored, i.e. listed in monitoredResourceUris attribute. | ImmediateReport | +| additionalDataRefs | array(AdditionalDataRef) | O | 1..N | A list of URIs (associated to monitoredResourceURIs) identifying resources in the UDR. The representations of these resources may be included in the notification request as additionalData, when the notification for the associated monitoredResourceURI is sent. | | + +NOTE 1: The UDR should handle only the relative-path part (apiSpecificResourceUriPart, see 3GPP TS 29.501 [7] clause 4.4.1) and ignore possible inconsistencies (caused by e.g. an SCP) in the base URI part. + +NOTE: Consumers can choose not to request an Immediate Report when subscribing to large collection resources to avoid potential too long response messages. + +#### 5.4.2.6 Type: DataChangeNotify + +**Table 5.4.2.6-1: Definition of type DataChangeNotify** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------|--------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| originalCallbackReference | array(Uri) | C | 1..N | Original Callback Reference shall be present if a UDM has subscribed to notification due to an request from an NF. If present it is Identifying the NF to which the UDM has to provide the notification of data change. | +| ueld | VarUeld | C | 0..1 | User identity if subscription to notifications is related to a user that may be provided e.g. in case OriginalCallback URI is not included. | +| notifyItems | array(NotifyItem) | O | 1..N | This attribute contains the changes which have been applied on the resources. | +| sdmSubscription | SdmSubscription | O | 0..1 | Data related to the subscription to changes on SDM data created by the NF Service Consumer of the UDM (see 3GPP TS 29.503 [6], clause 6.1.6.2.3). This attribute should be omitted if the SubscriptionsDataSubscriptions array is included. | +| additionalSdmSubscriptions | array(SdmSubscription) | C | 1..N | Shall be present if more than one subscription to changes on SDM data created by different NF service consumers of the UDM exist. This attribute if present shall convey sdm subscriptions in addition to and different from the sdm subscription present in the sdmSubscription attribute. | +| subscriptionDataSubscriptions | array(SubscriptionDataSubscriptions) | O | 1..N | This attribute contain the Subscription Data Subscriptions (subs-to-notify) associated with the Notification. | +| additionalData | map(AnyType) | O | 1..N | A map of additional data (list of key-value pairs where the data's resource URI serves as key). | + +### 5.4.2.7 Type: IdentityData + +**Table 5.4.2.7-1: Definition of type IdentityData** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supiList | array(Supi) | C | 1..N | Supi list corresponding to the provided gpsi ueld. | +| gpsiList | array(Gpsi) | C | 1..N | Gpsi list corresponding to the provided supi ueld. Zero or one MSISDN and/or zero or more external Identifiers may be included. | +| allowedAflDs | array(string) | O | 1..N | A list of Application Function Identifiers authorized to retrieve this Identities lists. The absence of this IE indicates that any AF is allowed to retrieve them. | +| applicationPortIds | map(Gpsi) | O | 1..N | A map (list of key-value pairs where AppPortId serves as key) of GPSIs. | + +### 5.4.2.8 Type: ProvisionedDataSets + +**Table 5.4.2.8-1: ProvisionedDataSets** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------------------------------|---|-------------|----------------------------------------------------------------| +| amData | AccessAndMobilitySubscriptionData | O | 0..1 | Access and Mobility Subscription Data | +| smfSelData | SmfSelectionSubscriptionData | O | 0..1 | SMF Selection Subscription Data | +| smsSubsData | SmsSubscriptionData | O | 0..1 | SMS Subscription Data | +| smData | SmSubsData | O | 0..1 | Session Management Subscription Data | +| traceData | TraceData | O | 0..1 | Trace Data. The Null value indicates that trace is not active. | +| smsMngData | SmsManagementSubscriptionData | O | 0..1 | SMS Management Subscription Data | +| lcsPrivacyData | LcsPrivacyData | O | 0..1 | LCS Privacy Subscription Data | +| lcsMoData | LcsMoData | O | 0..1 | LCS Mobile Originated Subscription Data | +| lcsSubscriptionData | LcsSubscriptionData | O | 0..1 | Other LCS Subscription Data | +| lcsBcaData | LcsBroadcastAssistanceTypesData | O | 0..1 | LCS Broadcast Assistance Subscription Data | +| v2xData | V2xSubscriptionData | O | 0..1 | V2X Subscription Data | +| proseData | ProseSubscriptionData | O | 0..1 | ProSe service Subscription Data | +| odbData | OdbData | O | 0..1 | Operator Determined Barring Subscription Data | +| eeProfileData | EeProfileData | O | 0..1 | Event Exposure Profile Data | +| ppProfileData | PpProfileData | O | 0..1 | Parameter Provisioning Profile Data | +| niddAuthData | AuthorizationData | O | 0..1 | NIDD Authorization Data | +| ucData | UcSubscriptionData | O | 0..1 | User Consent Data | +| mbsSubscriptionData | MbsSubscriptionData | O | 0..1 | 5MBS Subscription Data | +| ppData | PpData | O | 0..1 | Parameter Provisioning Data | +| a2xData | A2xSubscriptionData | O | 0..1 | A2X Subscription Data | + +### 5.4.2.9 Type: SorData + +**Table 5.4.2.9-1: Definition of type SorData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| provisioningTime | DateTime | M | 1 | Point in time of provisioning | +| ueUpdateStatus | UeUpdateStatus | M | 1 | status of the SOR data update procedure | +| sorXmaclue | SorMac | C | 0..1 | String containing SoR-XMAC-IUE as specified in 3GPP TS 33.501 [9]. Shall be present if UeUpdateStatus is "WAITING_FOR_ACK" or "ACK_RECEIVED". | +| sorMaclue | SorMac | C | 0..1 | String containing SoR-MAC-IUE as specified in 3GPP TS 33.501 [9]. Shall be preset if UeUpdateStatus is "ACK_RECEIVED". | +| meSupportOfSorCmci | boolean | C | 0..1 | When present, indicates "ME support of SOR-CMCI" sent from UE as defined in 3GPP TS 23.122 [14] and 3GPP TS 24.501 [27].
As described in 3GPP TS 23.122 [14] Annex C.2 step 3a, this attribute will be deleted (set to False) during UE initiates initial registration or emergency registration.

- True: ME supports SOR-CMCI
- False or absent: ME does not support SOR-CMCI | +| meSupportOfSorSnpnSi | boolean | C | 0..1 | When present, it indicates "ME support of SOR-SNPN-SI" as defined in Clause C.5 of 3GPP TS 23.122 [14].
- true: ME supports SOR-SNPN-SI.
- false or absent: ME does not support SOR-SNPN-SI. | +| meSupportOfSorSnpnSiLs | boolean | C | 0..1 | When present, it indicates "ME support of SOR-SNPN-SI-LS" as defined in Clause C.5 of 3GPP TS 23.122 [14].
- true: ME supports SOR-SNPN-SI-LS.
- false or absent: ME does not support SOR-SNPN-SI-LS. | + +### 5.4.2.9A Type: UpuData + +**Table 5.4.2.9A-1: Definition of type UpuData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| provisioningTime | DateTime | M | 1 | Point in time of provisioning | +| ueUpdateStatus | UeUpdateStatus | M | 1 | status of the UPU data update procedure | +| upuXmaclue | UpuMac | C | 0..1 | String containing UPU-XMAC-IUE as specified in 3GPP TS 33.501 [9]. Shall be present if UeUpdateStatus is "WAITING_FOR_ACK" or "ACK_RECEIVED". | +| upuMaclue | UpuMac | C | 0..1 | String containing UPU-MAC-IUE as specified in 3GPP TS 33.501 [9]. Shall be preset if UeUpdateStatus is "ACK_RECEIVED". | + +### 5.4.2.9B Type: NssaiAckData + +**Table 5.4.2.9B-1: Definition of type NssaiAckData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|----------------|---|-------------|--------------------------------------| +| provisioningTime | DateTime | M | 1 | Point in time of provisioning | +| ueUpdateStatus | UeUpdateStatus | M | 1 | status of the Nssai update procedure | + +## 5.4.2.9C Type: CagAckData + +**Table 5.4.2.9C-1: Definition of type CagAckData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|----------------|---|-------------|------------------------------------| +| provisioningTime | DateTime | M | 1 | Point in time of provisioning | +| ueUpdateStatus | UeUpdateStatus | M | 1 | status of the Cag update procedure | + +5.4.2.10 Void + +5.4.2.11 Void + +5.4.2.12 Void + +5.4.2.13 Void + +5.4.2.14 Void + +5.4.2.15 Void + +5.4.2.16 Void + +5.4.2.17 Void + +5.4.2.18 Void + +## 5.4.2.19 Type: AmfSubscriptionInfo + +Table 5.4.2.19-1: Definition of type AmfSubscriptionInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------|--------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| amfInstanceId | NfInstanceId | M | 1 | InstanceId of the AMF to which the subscription was sent | +| subscriptionId | Uri | M | 1 | The Subscription Id allocated by the AMF as received by the UDM in the HTTP "Location" header of the Namf_EventExposure_Subscribe response | +| subsChangeNotifyCorrelationId | string | O | 1 | The Correlation Id allocated by the UDM and sent to the AMF for correlation of subscriptionId-change-notifications | +| contextInfo | ContextInfo | O | 0..1 | This IE if present may contain e.g. the headers sent/received by the UDM during AMF Event Exposure subscription. | + +## 5.4.2.20 Type: EeProfileData + +Table 5.4.2.20-1: Definition of type EeProfileData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| restrictedEventTypes | array(EventType) | O | 1..N | List of the event types that are restricted (if any) for the UE.
The absence of this IE indicates that all event types are authorized for the UE. | +| supportedFeatures | SupportedFeatures | O | 0..1 | | +| allowedMtcProvider | map(array(MtcProvider)) | O | 1..N(1..M) | A map (list of key-value pairs where EventType (see 3GPP TS 29.503 [6] serves as key) of MTC Provider.
In addition to defined EventTypes, the key value "ALL" may be used to identify a map entry which contains a list of MtcProviders that are allowed monitoring all Event Types.
The absence of this IE indicates that monitoring by any MTC provider is allowed for any non restricted event type. | +| iwkEpcRestricted | boolean | O | 0..1 | If set to True, indicates that interworking with EPC is restricted. Set to False or not present means that the UE is not restricted in the EPC. | +| imsi | string | O | 0..1 | This IE contains the IMSI of the UE and should be present if the iwkEpcRestricted attribute is not set to True.
pattern: "^[0-9]{5,15}\$" | +| hssGroupId | NfGroupId | O | 0..1 | Identity of the HSS group associated with the subscription that might be used by the UDM to discover the HSS; see 3GPP TS 29.510 [19]. This attribute may be present if the iwkEpcRestricted attribute is not present or present and set to False. | + +## 5.4.2.21 Void + +## 5.4.2.22 Type: ContextDataSets + +**Table 5.4.2.22-1: ContextDataSets** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------|--------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------| +| amf3Gpp | Amf3GppAccessRegistration | O | 0..1 | AMF 3GPP Access registration | +| amfNon3Gpp | AmfNon3GppAccessRegistration | O | 0..1 | AMF Non 3GPP Access registration | +| sdmSubscriptions | array(SdmSubscription) | O | 1..N | SDM-Subscriptions | +| eeSubscriptions | array(EeSubscription) | O | 1..N | Event Exposure Subscriptions | +| smsf3GppAccess | SmsfRegistration | O | 0..1 | SMSF 3GPP Access registration | +| smsfNon3GppAccess | SmsfRegistration | O | 0..1 | SMSF Non 3GPP Access registration | +| subscriptionDataSubscriptions | array(SubscriptionDataSubscriptions) | O | 1..N | This attribute contain the Subscription Data Subscriptions (subs-to-notify) associated with the Notification. | +| smfRegistrations | SmfRegList | O | 0..1 | SMF Registrations | +| ipSmGw | IpSmGwRegistration | O | 0..1 | IP-SM-GW Registration | +| roamingInfo | RoamingInfoUpdate | O | 0..1 | Roaming Information | +| peiInfo | PeiUpdateInfo | O | 0..1 | PEI Information | + +## 5.4.2.23 Type: SequenceNumber + +Table 5.4.2.23-1: Definition of type SequenceNumber + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sqnScheme | SqnScheme | M | 1 | The scheme used to generate the sequence numbers, as described in 3GPP TS 33.102 [10], clause C.1.1. | +| sqn | string | C | 0..1 |

A 48-bit hex string containing the SEQ part of SQN (most significant bits), as specified in 3GPP TS 33.102 [10], and where the IND part (least significant bits) is filled with 0's.

When the sqnScheme is "TIME_BASED", the SEQ part (most significant bits) of this attribute contains the DIF value.

This IE may be absent, if it does not exist in UDR (e.g. right after the subscriber is provisioned); otherwise, it shall be present.

Pattern: '[A-Fa-f0-9]{12}\$'

| +| lastIndexes | map(integer) | C | 1..N |

A map of integer values, where the key of the map is the type of node that is requesting the generation of an authentication vector in UDM, and the integer is the last used value of IND for the corresponding type of node.

The types of nodes currently defined are:
- "ausf"
- "vlr"
- "sgsn"
- "s-cscf"
- "bsf",
- "gan-aaa-server"
- "wlan-aaa-server"
- "mme"

This IE may be absent, if it does not exist in UDR (e.g. right after the subscriber is provisioned); otherwise, it shall be present.

| +| indLength | integer | O | 1 |

Number of bits of the IND part of SQN. The length of the SEQ part is, therefore, (48 - indLength) bits.

If not present, the default value is 5.

| +| difSign | Sign | O | 1 |

Sign of the DIF value. It is applicable when the sqnScheme is "TIME_BASED".

If not present, the default value is "NEGATIVE".

| + +## 5.4.2.24 Type: MessageWaitingData + +Table 5.4.2.24-1: Definition of type MessageWaitingData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------| +| mwdList | array(SmscData) | O | 1..N | List of addresses of SM-Service Center entities with SMS waiting to be delivered to the UE. | + +#### 5.4.2.25 Type: SmscData + +**Table 5.4.2.25-1: Definition of type SmscData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------| +| smscMapAddress | E164Number | C | 0..1 | International E.164 number of the SM-SC; it shall be present if the SM-SC supports the MAP protocol. | +| smscDiameterAddress | NetworkNodeDiameterAddress | C | 0..1 | Diameter Identity of the SM-SC; it shall be present if the SM-SC supports the Diameter protocol. | +| NOTE: At least one of the properties, smscMapAddress or smscDiameterAddress, shall be present. | | | | | + +#### 5.4.2.26 Type: SmfSubscriptionInfo + +**Table 5.4.2.26-1: Definition of type SmfSubscriptionInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|----------------------------|---|-------------|-------------------------------------| +| smfSubscriptionList | array(SmfSubscriptionItem) | M | 1..N | List of SmfSubscriptionItem objects | + +#### 5.4.2.27 Type: SmfSubscriptionItem + +**Table 5.4.2.27-1: Definition of type SmfSubscriptionItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| smfInstanceId | NfInstanceId | M | 1 | InstanceId of the SMF to which the subscription was sent | +| subscriptionId | Uri | M | 1 | The Subscription Id allocated by the SMF as received by the UDM in the HTTP "Location" header of the Nsmf_EventExposure_Subscribe response | +| contextInfo | ContextInfo | O | 0..1 | This IE if present may contain e.g. the headers received by the UDM along with consuming Nsmf_EventExposure_Subscribe service operation. | + +#### 5.4.2.28 Type: MtcProvider + +**Table 5.4.2.28-1: Definition of type MtcProvider** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| mtcProviderInformation | MtcProviderInformation | O | 0..1 | Indicates MTC provider information for Monitoring Configuration authorization. | +| afId | string | O | 0..1 | ID of the AF. The string identifying the originating AF, formatted as described in the definition of type MonitoringConfiguration in 3GPP TS 29.503 [6]. | + +#### 5.4.2.29 Type: HssSubscriptionInfo + +**Table 5.4.2.29-1: Definition of type HssSubscriptionInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|----------------------------|---|-------------|-------------------------------------| +| hssSubscriptionList | array(HssSubscriptionItem) | M | 1..N | List of hssSubscriptionItem objects | + +## 5.4.2.30 Type: HssSubscriptionItem + +Table 5.4.2.30-1: Definition of type HssSubscriptionItem + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| hssInstanceId | NfInstanceId | M | 1 | InstanceId of the HSS to which the subscription was sent. | +| subscriptionId | Uri | M | 1 | The Subscription Id allocated by the HSS as received by the UDM in the HTTP "Location" header of the Nhss_EventExposure_Subscribe response or the Nhss_SDM_Subscribe response. | +| contextInfo | ContextInfo | O | 0..1 | This IE if present may contain e.g. the headers received by the UDM along with consuming Nhss_EventExposure_Subscribe service operation or the Nhss_SDM_Subscribe response. | + +## 5.4.2.31 Type: EeGroupProfileData + +Table 5.4.2.31-1: Definition of type EeGroupProfileData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| restrictedEventTypes | array(EventType) | O | 1..N | List of the event types that are restricted (if any) for the group.
The absence of this IE indicates that all event types are authorized for the group. | +| allowedMtcProvider | map(array(MtcProvider)) | O | 1..N | A map (list of key-value pairs where EventType (see 3GPP TS 29.503 [6] serves as key) of MTC Provider.
In addition to defined EventTypes, the key value "ALL" may be used to identify a map entry which contains a list of MtcProviders that are allowed monitoring all Event Types.
The absence of this IE indicates that monitoring by any MTC provider is allowed for any non restricted event type. | +| supportedFeatures | SupportedFeatures | O | 0..1 | | +| iwkEpcRestricted | boolean | O | 0..1 | If set to True, indicates that interworking with EPC is restricted. Set to False or not present means that the UE is not restricted in the EPC. | +| extGroupId | string | O | 0..1 | This IE contains the External Group Identifier and should be present if the iwkEpcRestricted attribute is not set to True.

pattern: "^extgroupid-[^@]+@[^\@]+\+\$" | +| hssGroupId | NfGroupId | O | 0..1 | Identity of the HSS group associated with the subscription that might be used by the UDM to discover the HSS; see 3GPP TS 29.510 [19]. This attribute may be present if the iwkEpcRestricted attribute is not present or present and set to False. | + +## 5.4.2.32 Type: Pp5gVnGroupProfileData + +Table 5.4.2.32-1: Definition of type Pp5gVnGroupProfileData + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedMtcProviders | map(array(AllowedMtcProviderInfo)) | O | 1..N |

A map (list of key-value pairs where ExtGroupId (see 3GPP TS 29.503 [6]) serves as key of a list of AllowedMtcProviderInfos which include MTC provider informations or AF IDs that are allowed to create, update and delete a 5G VN Group for the user using UDM ParameterProvision service.

In addition to defined external group identifier, the key value "ALL" may be used to identify a map entry which contains a list of AllowedMtcProviderInfos that are allowed operating all the external group identifiers.

The absence of this IE indicates that all the MTC Providers and AFs are authorized to create, update and delete any 5G VN Group.

| +| supportedFeatures | SupportedFeatures | O | 0..1 | | + +## 5.4.2.33 Type: PpProfileData + +Table 5.4.2.33-1: Definition of type PpProfileData + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedMtcProviders | map(array(AllowedMtcProviderInfo)) | O | 1..N |

A map (list of key-value pairs where PpDataType (see 5.4.3.10) serves as key of a list of AllowedMtcProviderInfos which include MTC provider informations or AF IDs that are allowed to provision the parameters for the user using UDM ParameterProvision service.

In addition to defined external group identifier, the key value "ALL" may be used to identify a map entry which contains a list of AllowedMtcProviderInfos that are allowed provisioning all types of PP data.

The absence of this IE indicates that all the MTC Providers and AFs are authorized to provision all types of PP data for the UE

| +| supportedFeatures | SupportedFeatures | O | 0..1 | | + +## 5.4.2.34 Type: AllowedMtcProviderInfo + +Table 5.4.2.34-1: Definition of type AllowedMtcProviderInfo + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mtcProviderInformation | MtcProviderInformation | C | 0..1 | Indicates MTC provider information for Parameters Provision authorization. | +| aflid | string | C | 0..1 |

Indicates ID of the AF for Parameters Provision authorization.

The string identifying the originating AF, formatted as described in the definition of type MonitoringConfiguration in 3GPP TS 29.503 [6].

| + +### 5.4.2.35 Type: GroupIdentifiers + +**Table 5.4.2.35-1: Definition of type GroupIdentifiers** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| extGroupId | ExtGroupId | C | 0..1 | This IE shall contain the External Group ID associated to the provided Internal Group ID. | +| intGroupId | GroupId | C | 0..1 | This IE shall contain the Internal Group ID associated to the provided External Group ID.. | +| ueIdList | array(UeId) | C | 1..N | This IE shall contain a list of the UE identifiers that belong to the provided Internal/External Group ID if they are required. | +| allowedAflDs | array(string) | O | 1..N | A list of Application Function Identifiers authorized to retrieve this Identities lists. The absence of this IE indicates that any AF is allowed to retrieve them. | + +### 5.4.2.36 Type: AuthorizationData + +**Table 5.4.2.36-1: Definition of type AuthorizationData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| authorizationData | array(UserIdentifier) | M | 1..N | May contain a single value or list of (SUPI and GPSI). Contains unique items. | +| allowedDnnList | array(Dnn) | O | 0..N | List of the allowed DNNs that this user can use for NIDD or other specific service | +| allowedSnssaiList | array(SNSSAI) | O | 0..N | List of the allowed SNSSAIs that this user can use for NIDD or other specific service | +| allowedMtcProviders | array(AllowedMtcProviderInfo) | O | 0..N | List of AllowedMtcProviderInfos which include MTC provider informations or AF IDs that are allowed for NIDD or other specific service | +| validityTime | DateTime | O | 0..1 | Indicates the granted validity time of the AuthorizationData. Absence indicates permanent validity. | + +### 5.4.2.37 Type: NiddAuthorizationInfo + +**Table 5.4.2.37-1: Definition of type NiddAuthorizationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|--------------------------|---|-------------|-------------------------------------| +| niddAuthorizationList | array(AuthorizationInfo) | M | 1..N | List of NiddAuthorizationInfo items | + +### 5.4.2.38 Type: PpDataEntryList + +**Table 5.4.2.38-1: Definition of type PpDataEntryList** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|--------------------|---|-------------|--------------------------------------------------------------------------| +| ppDataEntryList | array(PpDataEntry) | O | 0..N | List of the Entries under the Provisioned Parameter Data store for a UE. | +| supportedFeatures | SupportedFeatures | O | 0..1 | Contains SupportedFeatures. | + +#### 5.4.2.39 Type: UeSubscribedDataSets + +**Table 5.4.2.39-1: UeSubscribedDataSets as a list of "to be combined data types"** + +| Data type | Cardinality | Description | Applicability | +|---------------------|-------------|---------------------|-----------------| +| ProvisionedDataSets | 0..1 | See clause 5.4.2.8 | | +| ContextDataSets | 0..1 | See clause 5.4.2.22 | UESubDataSetExt | +| UeUpdConfData | 0..1 | See clause 5.4.2.47 | | + +#### 5.4.2.40 Type: ServiceSpecificAuthorizationInfo + +**Table 5.4.2.40-1: Definition of type ServiceSpecificAuthorizationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------|--------------------------|---|-------------|------------------------------------------------| +| serviceSpecificAuthorizationList | array(AuthorizationInfo) | M | 1..N | List of ServiceSpecificAuthorizationInfo items | + +#### 5.4.2.41 Type: NfIdentifier + +**Table 5.4.2.41-1: Definition of type NfIdentifier** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|-----------------------------------------------------| +| nfType | NFType | M | 1 | NF Type as defined in 3gpp TS 29.510. | +| nfInstanceId | NfInstanceId | O | 0..1 | Instance ID of the NF as defined in 3GPP TS 29.571. | + +#### 5.4.2.42 Type: EeSubscriptionExt + +**Table 5.4.2.42-1: Definition of type EeSubscriptionExt as a list of "to be combined data types"** + +| Data type | Cardinality | Description | Applicability | +|----------------------|-------------|------------------------|-------------------| +| EeSubscription | 1 | see 3GPP TS 29.503 [6] | | +| AdditionalEeSubsInfo | 0..1 | | EeSubscriptionExt | + +#### 5.4.2.43 Type: AdditionalEeSubsInfo + +**Table 5.4.2.43-1: Definition of type AdditionalEeSubsInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|----------------------------|---|-------------|-------------------------------------------------------------------------------|-------------------| +| amfSubscriptionInfoList | array(AmfSubscriptionInfo) | O | 1..2 | List AMF subscription info
May be present on Nudr in GET response messages | EeSubscriptionExt | +| smfSubscriptionInfo | SmfSubscriptionInfo | O | 0..1 | SMF subscription info
May be present on Nudr in GET response messages | EeSubscriptionExt | +| hssSubscriptionInfo | HssSubscriptionInfo | O | 0..1 | HSS subscription info
May be present on Nudr in GET response messages | EeSubscriptionExt | + +#### 5.4.2.44 Type: ImmediateReport + +**Table 5.4.2.44-1: Definition of type ImmediateReport as a list of alternatives** + +| Data type | Cardinality | Description | Applicability | +|---------------------|-------------|------------------------------------------------------------------------------------------|---------------| +| ProvisionedDataSets | 1 | UE based provisioned data sets. | | +| array(SharedData) | 1..N | Shared subscription data sets that need to be monitored in SubscriptionDataSubscription. | | + +#### 5.4.2.47 Type: UeUpdConfData + +**Table 5.4.2.47-1: Definition of type UeUpdConfData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|---------------------------------------|---------------| +| sorData | SorData | O | 0..1 | UE Update Confirmation Data for SOR | | +| upuData | UpuData | O | 0..1 | UE Update Confirmation Data for UPU | | +| nssaiAckData | NssaiAckData | O | 0..1 | UE Update Confirmation Data for NSSAI | | +| cagAckData | CagAckData | O | 0..1 | UE Update Confirmation Data for CAG | | + +#### 5.4.2.48 Type: AdditionalDataRef + +**Table 5.4.2.48-1: Definition of type AdditionalDataRef** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| monitoredResourceUris | array(Uri) | M | 1..N | List of monitored resource URIs | | +| additionalDataUris | array(Uri) | M | 1..N | List of URIs identifying resources, representations of which are requested to be included in notification messages sent when one of the monitoredResource's representation is modified. | | + +### 5.4.3 Simple data types and enumerations + +#### 5.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 5.4.3.2 Simple data types + +The simple data types defined in table 5.4.3.2-1 shall be supported. + +**Table 5.4.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|--------------|-----------------|-----------------------------------------------------------------------------------------------------------| +| VarUeGroupId | string | String identifying an external Group of UEs or any UE.
Pattern: '^(extgroupid-[^@]+@[^\@]+\+ anyUE)\$' | +| VarPlmnId | string | String identifying a PLMN ID or an SNPN ID.
Pattern: '^[0-9]{5,6}(-[A-Fa-f0-9]{11})?\$', | + +#### 5.4.3.3 Enumeration: AuthMethod + +**Table 5.4.3.3-1: Enumeration AuthMethod** + +| Enumeration value | Description | +|-------------------|-------------------------------------------| +| "5G_AKA" | 5G AKA | +| "EAP_AKA_PRIME" | EAP AKA' | +| "EAP-TLS" | EAP TLS | +| "EAP_TTLS" | EAP TTLS | +| "NONE" | No specific EAP method type is signalled. | + +### 5.4.3.4 Enumeration: ProvisionedDataSetName + +**Table 5.4.3.4-1: Enumeration ProvisionedDataSetName** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------| +| "AM" | Access and Mobility Subscription Data | +| "SMF_SEL" | SMF Selection Subscription Data | +| "SMS_SUB" | SMS Subscription Data | +| "SM" | Session Management Subscription Data | +| "TRACE" | Trace Data | +| "SMS_MNG" | SMS Management Subscription Data | +| "LCS_PRIVACY" | LCS Privacy Subscription Data | +| "LCS_MO" | LCS Mobile Originated Subscription Data | +| "LCS_BCA" | LCS Broadcast Assistance Subscription Data | +| "LCS_SUB" | LCS Subscription Data | +| "V2X" | V2X Subscription Data | +| "PROSE" | ProSe service Subscription Data | +| "ODB" | Operator Determined Barring Subscription Data | +| "EE_PROF" | Event Exposure Profile Data | +| "PP_PROF" | Parameter Provisioning Profile Data | +| "NIDD_AUTH" | NIDD Authorization Data | +| "USER_CONSENT" | User Consent Data | +| "MBS" | 5MBS Subscription Data | +| "PP_DATA" | Parameter Provisioning Data | +| "A2X" | A2X Subscription Data | + +### 5.4.3.5 Void + +### 5.4.3.6 Enumeration: ContextDataSetName + +**Table 5.4.3.6-1: Enumeration ContextDataSetName** + +| Enumeration value | Description | +|---------------------|-----------------------------------| +| "AMF_3GPP" | AMF 3GPP Access Registration | +| "AMF_NON_3GPP" | SMF Non 3GPP Access Registration | +| "SDM_SUBSCRIPTIONS" | SDM Subscriptions | +| "EE_SUBSCRIPTIONS" | EE Subscriptions | +| "SMSF_3GPP" | SMSF 3GPP Access Registration | +| "SMSF_NON_3GPP" | SMSF Non 3GPP Access Registration | +| "SUBS_TO_NOTIFY" | UDR Subscriptions | +| "SMF_REG" | SMF Registrations | +| "IP_SM_GW" | IP-SM-GW Registration | +| "ROAMING_INFO" | Roaming Information | +| "PEI_INFO" | PEI information | + +### 5.4.3.7 Enumeration: SqnScheme + +**Table 5.4.3.7-1: Enumeration SqnScheme** + +| Enumeration value | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| "GENERAL" | Scheme for generation of Sequence Numbers (partially time-based), as described in 3GPP TS 33.102 [10], clause C.1.1.1 | +| "NON_TIME_BASED" | Scheme for generation of Sequence Numbers (non-time-based), as described in 3GPP TS 33.102 [10], clause C.1.1.2 | +| "TIME_BASED" | Scheme for generation of Sequence Numbers (entirely time-based), as described in 3GPP TS 33.102 [10], clause C.1.1.3 | +| NOTE: These schemes for Sequence Number generation are documented in an informative Annex in 3GPP TS 33.102 [10]; having these different schemes listed in this Enumeration type does not imply that UDM implementations are required to support all of them; the Sequence Number generation schemes that need to be supported by UDM is deployment-specific. | | + +### 5.4.3.8 Enumeration: Sign + +**Table 5.4.3.8-1: Enumeration Sign** + +| Enumeration value | Description | +|-------------------|-------------| +| "POSITIVE" | | +| "NEGATIVE" | | + +### 5.4.3.9 Enumeration: UeUpdateStatus + +**Table 5.4.3.9-1: Enumeration UeUpdateStatus** + +| Enumeration value | Description | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "NOT_SENT" | SOR data update / UPU data update / NSSAI update / CAG update has not been sent to the AMF e.g. because no AMF was registered at provisioning time | +| "SENT_NO_ACK_REQUIRED" | SOR data update / UPU data update has been sent to the AMF; Acknowledgement was not requested
This state is not applicable for NSSAI update / CAG update | +| "WAITING_FOR_ACK" | SOR data update has been sent to the AMF; Acknowledgement has been requested. In this state sorXmaclue shall be present;
or
UPU data update has been sent to the AMF; Acknowledgement has been requested. In this state upuXmaclue shall be present;
or
NSSAI has been sent to the AMF
or
CAG has been sent to the AMF. | +| "ACK_RECEIVED" | SOR data update has been acknowledged by the UE. In this state sorXmaclue and sorMaclue shall be present;
or
UPU data update has been acknowledged by the UE. In this state upuXmaclue and upuMaclue shall be present;
or
NSSAI data update has been acknowledged by the UE
or
CAG data update has been acknowledged by the UE. | +| "NEGATIVE_ACK_RECEIVED" | SOR data update / UPU data update has been sent to the AMF, but could not be forwarded to the UE due to the UE not being reachable. | + +### 5.4.3.10 Enumeration: PpDataType + +**Table 5.4.3.10-1: Enumeration PpDataType** + +| Enumeration value | Description | +|---------------------------------|--------------------------------------------------------| +| "COMMUNICATION_CHARACTERISTICS" | Communication Characteristics Parameters | +| "EXPECTED_UE_BEHAVIOUR" | Expected UE Behaviour Parameters | +| "EC_RESTRICTION" | Enhanced Coverage Restriction Parameters | +| "ACS_INFO" | ACS Information | +| "TRACE" | Trace Data | +| "STN_SR" | Session Transfer Number for SRVCC | +| "LCS_PRIVACY" | LCS Privacy Parameters | +| "SOR_INFO" | Steering of Roaming information to be conveyed to a UE | + +### 5.4.3.11 Enumeration: UeSubscribedDataSetName + +Applicable values are those defined as ProvisionedDataSetName or ContextDataSetName, see clauses 5.4.3.4 and 5.4.3.6, and values defined in table 5.4.3.11-1. + +**Table 5.4.3.11-1: Enumeration UeSubscribedDataSetName** + +| Enumeration value | Description | +|-------------------|-----------------------------| +| "UE_UPD_CONF" | UE Update Confirmation Data | + +## 5.4.4 Binary data + +N/A + +## 5.5 Error handling + +Table 5.5-1 lists common response body data structures used within the nudr-dr (Nudr\_DataRepository) API + +**Table 5.5-1: Common Response Body Data Structures** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------|---|-------------|--------------------|--------------------------------------------------------------------------| +| ProblemDetails | O | 0..1 | 4xx, 5xx responses | For unsuccessful status codes, the UDR may provide detailed information. | +| NOTE: In addition common data structures as defined in 3GPP TS 29.500 [8] are supported. | | | | | + +The application layer error handling shall follow 3GPP TS 29.504 [2] clause 6.1.6 unless explicitly specified in this document. + +## 5.6 Feature negotiation + +The optional features in table 6.1.8-1 of 3GPP TS 29.504 [2] are defined for the Nudr\_DataRepository API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [8]. + +## Annex A (normative): OpenAPI specification + +### A.1 General + +This Annex specifies the formal definition of the Nudr\_DataRepository service API for Subscription Data. It consists of OpenAPI 3.0.0 specifications, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [7] clause 5.3.1 and 3GPP TR 21.900 [14] clause 5B). + +### A.2 Nudr\_DataRepository API for Subscription Data + +For the purpose of referencing entities in the Open API file defined in this Annex, it shall be assumed that this Open API file is contained in a physical file named "TS29505\_Subscription\_Data.yaml". + +``` +openapi: 3.0.0 +info: + version: '-' + title: 'Unified Data Repository Service API file for subscription data' + description: | + Unified Data Repository Service (subscription data). + The API version is defined in 3GPP TS 29.504. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.505 V18.4.0; 5G System; Usage of the Unified Data Repository Service for + subscription data; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.505/' + +paths: + + /subscription-data/{ueId}/authentication-data/authentication-subscription: + get: + summary: Retrieves the authentication subscription data of a UE + operationId: QueryAuthSubsData + tags: + - Authentication Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:authentication-subscription:read + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticationSubscription' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: modify the authentication subscription data of a UE + operationId: ModifyAuthenticationSubscription + tags: + - Authentication Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:authentication-subscription:modify + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +``` + +``` + + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/authentication-data/authentication-status: + put: + summary: To store the Authentication Status data of a UE + operationId: CreateAuthenticationStatus + tags: + - Authentication Status (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AuthEvent' + required: true + responses: + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + get: + summary: Retrieves the Authentication Status of a UE + operationId: QueryAuthenticationStatus + +``` + +``` +tags: + - AuthEvent (Document) +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: supported-features + description: Supported Features + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AuthEvent' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: To remove the Authentication Status of a UE + operationId: DeleteAuthenticationStatus + tags: + - AuthEvent (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + responses: + '204': + description: Upon success, an empty response body shall be returned. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/authentication-data/authentication-status/{servingNetworkName}: + put: + summary: To store the individual Authentication Status data of a UE + operationId: CreateIndividualAuthenticationStatus + tags: + - Individual Authentication Status (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: servingNetworkName + in: path + description: Serving Network Name + required: true + schema: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName' + requestBody: + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AuthEvent' + required: true + responses: + '204': + description: Upon success, an empty response body shall be returned. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + +``` + +``` +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieves the Individual Authentication Status of a UE + operationId: QueryIndividualAuthenticationStatus + tags: + - Individual AuthEvent (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: servingNetworkName + in: path + description: Serving Network Name + required: true + schema: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: supported-features + description: Supported Features + in: query + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/AuthEvent' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: To remove the Individual Authentication Status of a UE + operationId: DeleteIndividualAuthenticationStatus + tags: +``` + +``` +- Individual AuthEvent (Document) +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:subscription-data +parameters: +- name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +- name: servingNetworkName + in: path + description: Serving Network Name + required: true + schema: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName' +responses: +'204': + description: Upon success, an empty response body shall be returned. +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/ue-update-confirmation-data: +get: + summary: Retrieves the complete UE Update Confirmation data + operationId: QueryUeUpdConf + tags: + - UE Update Confirmation (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeUpdConfData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/ue-update-confirmation-data/sor-data: + put: + summary: > + To store the SoR acknowledgement information of a UE, ME support of SOR CMCI, + and ME support of SOR-SNPN-SI and ME support of SOR-SNPN-SI-LS. + operationId: CreateAuthenticationSoR + tags: + - Authentication SoR (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SorData' + required: true + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +``` + +``` +get: + summary: > + Retrieves the SoR acknowledgement information of a UE, ME support of SOR CMCI + ME support of SOR-SNPN-SI and ME support of SOR-SNPN-SI-LS + operationId: QueryAuthSoR + tags: + - Authentication SoR (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SorData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: > + Updates the ME support of SOR CMCI ME support of SOR-SNPN-SI + and ME support of SOR-SNPN-SI-LS information of a UE + operationId: UpdateAuthenticationSoR + tags: + - Authentication SoR (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Features required to be supported by the target NF +``` + +``` + + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/ue-update-confirmation-data/upu-data: + put: + summary: To store the UPU acknowledgement information of a UE + operationId: CreateAuthenticationUPU + tags: + - Authentication UPU (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpuData' + +``` + +``` + required: true + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieves the UPU acknowledgement information of a UE + operationId: QueryAuthUPU + tags: + - Authentication UPU (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UpuData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +``` + +``` +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/ue-update-confirmation-data/subscribed-snssais: + put: + summary: To store the NSSAI update acknowledgement information of a UE + operationId: CreateOrUpdateNssaiAck + tags: + - NSSAI update ack (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NssaiAckData' + required: true + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + get: + summary: Retrieves the UPU acknowledgement information of a UE + operationId: QueryNssaiAck + tags: + - NSSAI ACK (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id +``` + +``` + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/NssaiAckData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/ue-update-confirmation-data/subscribed-cag: + put: + summary: To store the CAG update acknowledgement information of a UE + operationId: CreateCagUpdateAck + tags: + - CAG update ack (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CagAckData' + required: true + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +``` + +``` + + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieves the CAG acknowledgement information of a UE + operationId: QueryCagAck + tags: + - CAG ACK (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CagAckData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/{servingPlmnId}/provisioned-data: +get: + summary: Retrieve multiple provisioned data sets of a UE + operationId: QueryProvisionedData + tags: + - Provisioned Data (Document) + security: + - {} + - oAuth2ClientCredentials: + +``` + +``` +- nudr-dr +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: +- name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUEId' +- name: servingPlmnId + in: path + description: PLMN ID + required: true + schema: + $ref: '#/components/schemas/VarPlmnId' +- name: dataset-names + in: query + description: List of dataset names + style: form + explode: false + schema: + $ref: '#/components/schemas/ProvisionedDatasetNames' +- name: adjacent-plmns + in: query + description: List of PLMNs adjacent to the UE's serving PLMN + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + style: form + explode: false +- name: single-nssai + in: query + content: + application/json: + schema: + $ref: '#/components/schemas/VarSnssai' + description: single NSSAI + required: false +- name: dnn + in: query + description: DNN + required: false + schema: + $ref: '#/components/schemas/Dnn' +- name: ext-group-ids + in: query + description: List of external VN group identifiers + schema: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + minItems: 1 + style: form + explode: false +- name: uc-purpose + in: query + description: User consent purpose + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/UcPurpose' +responses: +'200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ProvisionedDataSets' + headers: + 3gpp-Sbi-Etags: + description: A comma-separated list of ProvisionedDatasetName = Etag pairs + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +``` + +/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/am-data: + +get: + +summary: Retrieves the access and mobility subscription data of a UE + +operationId: QueryAmData + +tags: + +- Access And Mobility Subscription Data (Document) + +security: + +- {} +- oAuth2ClientCredentials: + - nudr-dr +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + +parameters: + +- name: ueId + - in: path + - description: UE id + - required: true + - schema: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/VarUeId' +- name: servingPlmnId + - in: path + - description: PLMN ID + - required: true + - schema: + - \$ref: '#/components/schemas/VarPlmnId' +- name: fields + - in: query + - description: attributes to be retrieved + - required: false + - schema: + - type: array + - items: + - type: string + - minItems: 1 + - style: form + - explode: false +- name: supported-features + - in: query + - description: Supported Features + - schema: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: adjacent-plmns + - in: query + - description: List of PLMNs adjacent to the UE's serving PLMN + - schema: + - type: array + - items: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnId' + - minItems: 1 + - style: form + - explode: false +- name: If-None-Match + - in: header + - description: Validator for conditional requests, as described in RFC 9110, 13.1.2.9110, + +13.1.2 + +- schema: + - type: string +- name: If-Modified-Since + - in: header + +``` + +13.1.3 description: Validator for conditional requests, as described in RFC 9110, 13.1.3.9110, + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AccessAndMobilitySubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3.9110, 8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2.9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/smf-selection-subscription-data: +get: + summary: Retrieves the SMF selection subscription data of a UE + operationId: QuerySmfSelectData + tags: + - SMF Selection Subscription Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: servingPlmnId + in: path + description: PLMN ID + required: true + schema: + $ref: '#/components/schemas/VarPlmnId' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + +``` + +``` + + type: array + items: + type: string + minItems: 1 + style: form + explode: false +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2.9110, +13.1.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3.9110, +13.1.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmfSelectionSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111.9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3.9110, 8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2.9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sm-data: + get: + summary: Retrieves the Session Management subscription data of a UE + operationId: QuerySmData + tags: + - Session Management Subscription Data + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + +``` + +``` + + - nudr-dr:subscription-data +parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUEId' + - name: servingPlmnId + in: path + description: PLMN ID + required: true + schema: + $ref: '#/components/schemas/VarPlmnId' + - name: single-nssai + in: query + content: + application/json: + schema: + $ref: '#/components/schemas/VarSnssai' + description: single NSSAI + required: false + - name: dnn + in: query + description: DNN + required: false + schema: + $ref: '#/components/schemas/Dnn' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2.9110, +13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3.9110, +13.1.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmSubsData' +headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111.9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3.9110, 8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2.9110, 8.8.2 + schema: + type: string + +``` + +``` +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/amf-3gpp-access: + get: + summary: Retrieves the AMF context data of a UE using 3gpp access + operationId: QueryAmfContext3gpp + tags: + - AMF 3GPP Access Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/Amf3GppAccessRegistration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +``` + +``` + + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +put: + summary: To store the AMF context data of a UE using 3gpp access in the UDR + operationId: CreateAmfContext3gpp + tags: + - AMF 3GPP Access Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:registrations:write + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Amf3GppAccessRegistration' + required: true + responses: + '204': + description: Upon success, an empty response body shall be returned + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/Amf3GppAccessRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/amf-3gpp-access' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: To modify the AMF context data of a UE using 3gpp access in the UDR + +``` + +``` + +operationId: AmfContext3gpp +tags: + - AMF 3GPP Access Registration (Document) +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:registrations:write +parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true +responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/amf-non-3gpp-access: + get: + summary: Retrieves the AMF context data of a UE using non-3gpp access + operationId: QueryAmfContextNon3gpp + tags: + - AMF Non-3GPP Access Registration (Document) + security: + +``` + +``` + +- {} +- oAuth2ClientCredentials: + - nudr-dr +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: +- name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: +'200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AmfNon3GppAccessRegistration' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +put: + summary: To store the AMF context data of a UE using non-3gpp access in the UDR + operationId: CreateAmfContextNon3gpp + tags: + - AMF Non-3GPP Access Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:registrations:write + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AmfNon3GppAccessRegistration' + required: true + responses: + '204': + description: Upon success, an empty response body shall be returned + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/Amf3GppAccessRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/amf-non-3gpp-access' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: To modify the AMF context data of a UE using non 3gpp access in the UDR + operationId: AmfContextNon3gpp + tags: + - AMF Non-3GPP Access Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:registrations:write + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + +``` + +``` + + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/smf-registrations: + get: + summary: Retrieves the SMF registration list of a UE + operationId: QuerySmfRegList + tags: + - SMF Registrations (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmfRegList' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/smf-registrations/{pduSessionId}: + get: + summary: Retrieves the individual SMF registration of a UE + operationId: QuerySmfRegistration + tags: + - SMF Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: pduSessionId + in: path + description: PDU session id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmfRegistration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +put: + summary: To create an individual SMF context data of a UE in the UDR + operationId: CreateOrUpdateSmfRegistration + tags: + - SMF Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:registrations:write + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUEId' + - name: pduSessionId + in: path + description: PDU session id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmfRegistration' + required: true + responses: + '201': + description: Upon success, a response body containing a representation of the created + Individual SmfRegistration resource shall be returned + content: + application/json: + schema: + $ref: '#/components/schemas/SmfRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the + structure: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/smf-registrations/ + {pduSessionId}' + required: true + schema: + type: string + '204': + description: No content + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + +``` + +``` + + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + staleCheckNotification: + '{request.body#/udmStaleCheckCallbackUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/SmfRegistrationInfo' + responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +delete: + summary: To remove an individual SMF context data of a UE the UDR + operationId: DeleteSmfRegistration + tags: + - SMF Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:registrations:write + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUEId' + - name: pduSessionId + in: path + description: PDU session id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + +``` + +``` +responses: + '204': + description: Upon success, an empty response body shall be returned. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: To modify the SMF context data of a UE in the UDR + operationId: UpdateSmfContext + tags: + - SMF Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:registrations:write + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: pduSessionId + in: path + description: PDU session id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected +``` + +``` + +content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/operator-specific-data: + get: + summary: Retrieves the operator specific data of a UE + operationId: QueryOperSpecData + tags: + - Operator-Specific Data Container (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + description: A map(list of key-value pairs) where operator specific data element +name serves as key + +``` + +``` + + additionalProperties: + $ref: '#/components/schemas/OperatorSpecificDataContainer' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: To modify operator specific data of a UE + operationId: ModifyOperSpecData + tags: + - Operator-Specific Data Container (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +put: + summary: To create an operator-specific data resource of a UE + operationId: CreateOperSpecData + tags: + - Operator-Specific Data Container (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json: + schema: + type: object + description: A map (list of key-value pairs) where operator specific data element name +serves as key + additionalProperties: + $ref: '#/components/schemas/OperatorSpecificDataContainer' + required: true + responses: + '201': + description: Upon success, a response body containing a representation of the created +Operator Specific Data resource shall be returned + content: + application/json: + schema: + type: object + description: A map (list of key-value pairs) where operator specific data element +name serves as key + additionalProperties: + $ref: '#/components/schemas/OperatorSpecificDataContainer' + headers: + Location: + +``` + +``` + + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudr-dr//subscription-data/{ueId}/operator-specific-data' + required: true + schema: + type: string +'204': + description: No content +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: To remove an operator-specific data resource of a UE + operationId: DeleteOperSpecData + tags: + - Operator-Specific Data Container (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + responses: + '204': + description: Upon success, an empty response body shall be returned. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/smsf-3gpp-access: + put: + summary: Create the SMSF context data of a UE via 3GPP access + operationId: CreateSmsfContext3gpp + tags: + +``` + +``` + + - SMSF 3GPP Registration (Document) +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:subscription-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:subscription-data:registrations:write +parameters: +- name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUEId' +requestBody: +content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + required: true +responses: +'204': + description: Upon success, an empty response body shall be returned +'201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/smsf-3gpp-access' + required: true + schema: + type: string +'200': + description: Updated + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: +summary: To remove the SMSF context data of a UE via 3GPP access +operationId: DeleteSmsfContext3gpp +tags: +- SMSF 3GPP Registration (Document) +security: +- {} + +``` + +``` +- oAuth2ClientCredentials: + - nudr-dr +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:registrations:write +parameters: +- name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +responses: + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieves the SMSF context data of a UE using 3gpp access + operationId: QuerySmsfContext3gpp + tags: + - SMSF 3GPP Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: +``` + +``` + + $ref: '#/components/schemas/SmsfRegistration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/smsf-non-3gpp-access: + put: + summary: Create the SMSF context data of a UE via non-3GPP access + operationId: CreateSmsfContextNon3gpp + tags: + - SMSF Non-3GPP Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:registrations:write + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + required: true + responses: + '204': + description: Upon success, an empty response body shall be returned + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/smsf-non-3gpp- +access' + required: true + schema: + type: string + '200': + description: Updated + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + +``` + +``` + + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: To remove the SMSF context data of a UE via non-3GPP access + operationId: DeleteSmsfContextNon3gpp + tags: + - SMSF Non-3GPP Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:registrations:write + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + responses: + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieves the SMSF context data of a UE using non-3gpp access + operationId: QuerySmsfContextNon3gpp + tags: + - SMSF Non-3GPP Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + +``` + +``` +- name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsfRegistration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/ip-sm-gw: + put: + summary: Create the IP-SM-GW context data of a UE + operationId: CreateIpSmGwContext + tags: + - IP-SM-GW Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:registrations:write + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IpSmGwRegistration' +``` + +``` + required: true + responses: + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: To remove the IP-SM-GW context data of a UE + operationId: DeleteIpSmGwContext + tags: + - IP-SM-GW Registration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data:registrations:write + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + responses: + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify the IP-SM-GW context data of a UE + operationId: ModifyIpSmGwContext + tags: + - IP-SM-GW Registration (Document) +``` + +``` +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:subscription-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:subscription-data:registrations:write +parameters: +- name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +requestBody: +content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: +'204': + description: Successful response +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: +summary: Retrieves the IP-SM-GW context data of a UE +operationId: QueryIpSmGwContext +tags: +- IP-SM-GW Registration (Document) +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:subscription-data +parameters: +- name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: fields + in: query + description: attributes to be retrieved + required: false + schema: +``` + +``` + + type: array + items: + type: string + minItems: 1 + style: form + explode: false +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/IpSmGwRegistration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/mwd: + put: + summary: Create the Message Waiting Data of the UE + operationId: CreateMessageWaitingData + tags: + - Message Waiting Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MessageWaitingData' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/MessageWaitingData' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudr-dr/{apiVersion}/subscription-data/{ueId}/context-data/mwd' + required: true + schema: + +``` + +``` + type: string + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +delete: + summary: To remove the Message Waiting Data of the UE + operationId: DeleteMessageWaitingData + tags: + - Message Waiting Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + responses: + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify the Message Waiting Data of the UE + operationId: ModifyMessageWaitingData + tags: + - Message Waiting Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr +``` + +``` +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: + '204': + description: Successful response + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieves the Message Waiting Data of the UE + operationId: QueryMessageWaitingData + tags: + - Message Waiting Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: supported-features +``` + +``` +in: query +description: Supported Features +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/MessageWaitingData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sms-mng-data: + get: + summary: Retrieves the SMS management subscription data of a UE + operationId: QuerySmsMngData + tags: + - SMS Management Subscription Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: servingPlmnId + in: path + description: PLMN ID + required: true + schema: + $ref: '#/components/schemas/VarPlmnId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: +``` + +``` + + schema: + $ref: '#/components/schemas/SmsManagementSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/sms-data: + get: + summary: Retrieves the SMS subscription data of a UE + operationId: QuerySmsData + tags: + - SMS Subscription Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: servingPlmnId + in: path + description: PLMN ID + required: true + schema: + $ref: '#/components/schemas/VarPlmnId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + +``` + +``` + + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmsSubscriptionData' +headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/pp-data: +get: + summary: Read the profile of a given UE + operationId: GetppData + tags: + - Parameter Provision (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: pp data for a UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + +``` + +``` + + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PpData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + patch: + summary: modify the provisioned parameter data + operationId: ModifyPpData + tags: + - ProvisionedParameterData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: pp data for a UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/pp-profile-data: + get: + summary: Retrieves the parameter provision profile data of a UE + operationId: QueryPPData + tags: + - Parameter Provision profile Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PpProfileData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + +``` + +``` + + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/pp-data-store/{afInstanceId}: + put: + summary: create a Provisioning Parameter Data Entry + operationId: Create PP Data Entry + tags: + - ProvisionedParameterDataEntry (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - type: string + pattern: '^anyUE$' + - name: afInstanceId + in: path + description: Application Function Instance Identifier + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/PpDataEntry' + required: true + responses: + '201': + description: Indicating a successful creation of the resource. + content: + application/json: + schema: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/PpDataEntry' + '204': + description: Indicating a successful creation of the resource. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + +``` + +``` +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +delete: + summary: Delete a Provisioning Parameter Data Entry + operationId: Delete PP Data Entry + tags: + - ProvisionedParameterDataEntry (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - type: string + pattern: '^anyUE$' + - name: afInstanceId + in: path + description: Application Function Instance Identifier + required: true + schema: + type: string + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +get: + summary: get a Parameter Provisioning Data Entry + operationId: Get PP Data Entry + tags: + - ProvisionedParameterDataEntry (Document) + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - type: string + pattern: '^anyUE$' + - name: afInstanceId + in: path + description: Application Function Instance Identifier + required: true +``` + +``` + + schema: + type: string +- name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/PpDataEntry' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/subscription-data/{ueId}/pp-data-store: + get: + summary: get a list of Parameter Provisioning Data Entries + operationId: Get Multiple PP Data Entries + tags: + - ProvisionedParameterDataEntries (Collection) + parameters: + - name: ueId + in: path + description: Identifier of the UE + required: true + schema: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - type: string + pattern: '^anyUE$' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PpDataEntryList' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + +``` + +``` + + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/subscription-data/{ueId}/context-data/ee-subscriptions: + get: + summary: Retrieves the ee subscriptions of a UE + operationId: Queryeesubscriptions + tags: + - Event Exposure Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: event-types + in: query + required: false + description: Event Types + schema: + type: array + items: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/EventType' + minItems: 1 + style: form + explode: false + - name: nf-identifiers + in: query + description: NF Identifiers + schema: + type: array + items: + $ref: '#/components/schemas/NfIdentifier' + minItems: 1 + style: form + explode: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EeSubscriptionExt' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + +``` + +``` + + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +post: + summary: Create individual EE subscription + operationId: CreateEeSubscriptions + tags: + - Event Exposure Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE ID + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EeSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/EeSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/ee-subscriptions/ +{subsId}' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}: + put: + summary: Update an individual ee subscriptions of a UE + operationId: UpdateEesubscriptions + tags: + - Event Exposure Subscription (Document) + security: + - {} + +``` + +``` +- oAuth2ClientCredentials: + - nudr-dr +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: +- name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: subsId + in: path + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EeSubscription' + required: true +responses: + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + description: update of non-existing resource is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes a eeSubscription + operationId: RemoveeeSubscriptions + tags: + - Event Exposure Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + description: Unique ID of the subscription to remove + schema: + type: string +``` + +``` +responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an individual ee subscription of a UE + operationId: ModifyEesSubscription + tags: + - Event Exposure Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '204': + description: Successful response + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve a eeSubscription + operationId: QueryeeSubscription + tags: + - Event Exposure Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + description: Unique ID of the subscription to remove + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + items: + $ref: '#/components/schemas/EeSubscription' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/amf-subscriptions: + put: + summary: Create AmfSubscriptions for an individual ee subscriptions of a UE + operationId: Create AMF Subscriptions + tags: + - AMF Subscription Info (Document) + security: + - {} + - oAuth2ClientCredentials: + +``` + +``` +- nudr-dr +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: +- name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: subsId + in: path + required: true + schema: + type: string +requestBody: +content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AmfSubscriptionInfo' + minItems: 1 + required: true +responses: +'204': + description: Upon success, an empty response body shall be returned +'201': + description: Upon successful creation, the created resource shall be returned + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AmfSubscriptionInfo' + minItems: 1 +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: +summary: Deletes AMF Subscription Info for an eeSubscription +operationId: RemoveAmfSubscriptionsInfo +tags: +- Event AMF Subscription Info (Document) +security: +- {} +- oAuth2ClientCredentials: + - nudr-dr +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: +- name: ueId + in: path + required: true + schema: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: modify the AMF Subscription Info + operationId: ModifyAmfSubscriptionInfo + tags: + - AmfSubscriptionInfo (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': +``` + +``` + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve AMF subscription Info + operationId: GetAmfSubscriptionInfo + tags: + - Query AMF Subscription Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AmfSubscriptionInfo' + minItems: 1 + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +``` +/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/smf-subscriptions: + put: + summary: Create SMF Subscription Info + operationId: Create SMF Subscriptions + tags: + - SMF Event Subscription Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmfSubscriptionInfo' + required: true + responses: + '204': + description: Upon success, an empty response body shall be returned + '201': + description: Upon successful creation, the created resource shall be returned + content: + application/json: + schema: + $ref: '#/components/schemas/SmfSubscriptionInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + delete: + summary: Delete SMF Subscription Info + operationId: RemoveSmfSubscriptionsInfo + tags: + - SMF Event Subscription Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId +``` + +``` +in: path +required: true +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: subsId + in: path + required: true + schema: + type: string +responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify SMF Subscription Info + operationId: ModifySmfSubscriptionInfo + tags: + - SMF Event Subscription Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +``` + +``` +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve SMF Subscription Info + operationId: GetSmfSubscriptionInfo + tags: + - SMF Event Subscription Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SmfSubscriptionInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +``` +/subscription-data/{ueId}/context-data/ee-subscriptions/{subsId}/hss-subscriptions: + put: + summary: Create HSS Subscription Info + operationId: Create HSS Subscriptions + tags: + - HSS Event Subscription Info (Document) + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HssSubscriptionInfo' + required: true + responses: + '204': + description: Upon success, an empty response body shall be returned + '201': + description: Upon successful creation, the created resource shall be returned + content: + application/json: + schema: + $ref: '#/components/schemas/HssSubscriptionInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + delete: + summary: Delete HSS Subscription Info + operationId: RemoveHssSubscriptionsInfo + tags: + - HSS Event Subscription Info (Document) + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +``` + +``` +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify HSS Subscription Info + operationId: ModifyHssSubscriptionInfo + tags: + - HSS Event Subscription Info (Document) + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve HSS Subscription Info + operationId: GetHssSubscriptionInfo + tags: + - HSS Event Subscription Info (Document) + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SmfSubscriptionInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/{ueGroupId}/ee-subscriptions: +get: + summary: Retrieves the ee subscriptions of a group of UEs or any UE + operationId: QueryEeGroupSubscriptions + tags: + - Event Exposure Group Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueGroupId + in: path + description: Group of UEs or any UE + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + +``` + +``` + + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EeSubscription' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +post: + summary: Create individual EE subscription for a group of UEs or any UE + operationId: CreateEeGroupSubscriptions + tags: + - Event Exposure Group Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueGroupId + in: path + description: Group of UEs or any UE + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EeSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/EeSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudr-dr//subscription-data/group-data/{ueGroupId}/ee-subscriptions' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + +``` + +``` + + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}: + put: + summary: Update an individual ee subscription of a group of UEs or any UE + operationId: UpdateEeGroupSubscriptions + tags: + - Event Exposure Group Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueGroupId + in: path + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: subsId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EeSubscription' + required: true + responses: + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + description: update of non-existing resource is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + delete: + summary: Deletes a eeSubscription for a group of UEs or any UE + operationId: RemoveEeGroupSubscriptions + +``` + +``` + +tags: + - Event Exposure Group Subscription (Document) +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: + - name: ueGroupId + in: path + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: subsId + in: path + required: true + description: Unique ID of the subscription to remove + schema: + type: string +responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an individual ee subscription for a group of a UEs + operationId: ModifyEeGroupSubscription + tags: + - Event Exposure Group Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueGroupId + in: path + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: subsId + in: path + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + +``` + +``` + + minItems: 1 + required: true + responses: + '204': + description: Successful response + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve a individual eeSubscription for a group of UEs or any UE + operationId: QueryEeGroupSubscription + tags: + - Event Exposure Group Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueGroupId + in: path + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: subsId + in: path + required: true + description: Unique ID of the subscription to remove + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + items: + $ref: '#/components/schemas/EeSubscription' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + +``` + +``` +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/{ueGroupId}/ee-profile-data: +get: + summary: Retrieves the ee profile data profile data of a group or anyUE + operationId: QueryGroupEEData + tags: + - Event Exposure Data for a group (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueGroupId + in: path + description: Group of UEs or any UE + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/EeGroupProfileData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/ee-profile-data: +get: + summary: Retrieves the ee profile data of a UE + operationId: QueryEEData + tags: + - Event Exposure Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: +``` + +``` + +- name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + style: form + explode: false +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/EeProfileData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/sdm-subscriptions: + get: + summary: Retrieves the sdm subscriptions of a UE + operationId: Querysdmsubscriptions + tags: + - SDM Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + +``` + +``` + + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SdmSubscription' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +post: + summary: Create individual sdm subscription + operationId: CreateSdmSubscriptions + tags: + - SDM Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE ID + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SdmSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SdmSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/sdm-subscriptions/ +{subsId}' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + +``` + +``` + + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId}: + put: + summary: Update an individual sdm subscriptions of a UE + operationId: Updatesdmsubscriptions + tags: + - SDM Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SdmSubscription' + required: true + responses: + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + description: update of non-existing resource is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + delete: + summary: Deletes a sdmsubscriptions + operationId: RemovesdmSubscriptions + +``` + +``` +tags: + - SDM Subscription (Document) +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + description: Unique ID of the subscription to remove + schema: + type: string +responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an individual sdm subscription + operationId: ModifysdmSubscription + tags: + - SDM Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '204': + description: Successful response + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieves a individual sdmSubscription identified by subsId + operationId: QuerysdmSubscription + tags: + - SDM Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + description: Unique ID of the subscription to retrieve + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + items: + $ref: '#/components/schemas/SdmSubscription' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/sdm-subscriptions/{subsId}/hss-sdm-subscriptions: + put: + summary: Create HSS SDM Subscription Info + operationId: Create HSS SDM Subscriptions + tags: + - HSS SDM Subscription Info (Document) + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HssSubscriptionInfo' + required: true + responses: + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + delete: + summary: Delete HSS SDM Subscription Info + operationId: RemoveHssSDMSubscriptionsInfo + tags: + - HSS SDM Subscription Info (Document) + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: +``` + +``` + type: string + responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify HSS SDM Subscription Info + operationId: ModifyHssSDMSubscriptionInfo + tags: + - HSS SDM Subscription Info (Document) + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve HSS SDM Subscription Info + operationId: GetHssSDMSubscriptionInfo + tags: + - HSS SDM Subscription Info (Document) + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: subsId + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SmfSubscriptionInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/shared-data: +get: + summary: retrieve shared data + operationId: GetSharedData + tags: + - Retrieval of shared data + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: shared-data-ids + in: query + description: List of shared data ids + required: true + style: form + explode: false + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedDataIds' + +``` + +``` + +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/shared-data/{sharedDataId}: + get: + summary: retrieve individual shared data + operationId: GetIndividualSharedData + tags: + - Retrieval of individual shared data + parameters: + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + - name: sharedDataId + in: path + description: Id of the Shared Data + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedDataId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + +``` + +``` + + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/subs-to-notify: + post: + summary: Subscription data subscriptions + operationId: SubscriptionDataSubscriptions + tags: + - Subs To Notify (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionDataSubscriptions' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionDataSubscriptions' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudr-dr//subscription-data/subs-to-notify/{subsId}' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +``` + +``` +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + onDataChange: + '{request.body#/callbackReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DataChangeNotify' + responses: + '204': + description: Expected response to a valid request + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieves the list of subscriptions + operationId: QuerySubsToNotify + tags: + - Subs To Notify (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ue-id + in: query + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SubscriptionDataSubscriptions' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes subscriptions identified by a given ue-id parameter + operationId: RemoveMultipleSubscriptionDataSubscriptions + tags: + - Subs To Notify (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ue-id + in: query + required: true + description: UE ID + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: nf-instance-id + in: query + required: false + description: NF Instance ID + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + - name: delete-all-nfs + in: query + required: false + description: Flag to delete subscriptions from all NFs + schema: + type: boolean + - name: implicit-unsubscribe-indication + in: query + required: false + description: Implicit Unsubscribe Indication + schema: + type: boolean + responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/subs-to-notify/{subsId}: + delete: + summary: Deletes a subscriptionDataSubscriptions + +``` + +``` +operationId: RemovesubscriptionDataSubscriptions +tags: + - Subs To Notify (Document) +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: + - name: subsId + in: path + required: true + description: Unique ID of the subscription to remove + schema: + type: string +responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an individual subscriptionDataSubscription + operationId: ModifysubscriptionDataSubscription + tags: + - Subs To Notify (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: subsId + in: path + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '204': + description: Successful response + '200': + description: Expected response to a valid request + content: + application/json: +``` + +``` + + schema: + oneOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + - $ref: '#/components/schemas/SubscriptionDataSubscriptions' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieves a individual subscriptionDataSubscription identified by subsId + operationId: QuerySubscriptionDataSubscriptions + tags: + - Subs To Notify (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: subsId + in: path + required: true + description: Unique ID of the subscription to retrieve + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + items: + $ref: '#/components/schemas/SubscriptionDataSubscriptions' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/trace-data: + +``` + +``` + +get: + summary: Retrieves the trace configuration data of a UE + operationId: QueryTraceData + tags: + - Trace Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: servingPlmnId + in: path + description: PLMN ID + required: true + schema: + $ref: '#/components/schemas/VarPlmnId' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/TraceDataOrSharedTraceDataId' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +``` + +``` + +/subscription-data/{ueId}/identity-data: + get: + summary: Retrieve identity data by SUPI or GPSI + operationId: GetIdentityData + tags: + - Query Identity Data by SUPI or GPSI (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE ID + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUEId' + - name: app-port-id + in: query + description: Application port identifier + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/AppPortId' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/IdentityData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/operator-determined-barring-data: + get: + summary: Retrieve ODB Data data by SUPI or GPSI + operationId: GetOdbData + tags: + - Query ODB Data by SUPI or GPSI (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE ID + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OdbData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data: + get: + summary: Retrieve multiple context data sets of a UE + operationId: QueryContextData + tags: + - Context Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: context-dataset-names + in: query + description: List of context dataset names + style: form + explode: false + required: true + schema: + $ref: '#/components/schemas/ContextDatasetNames' +``` + +``` +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ContextDataSets' + headers: + 3gpp-Sbi-Etags: + description: A comma-separated list of ProvisionedDatasetName = Etag pairs + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/group-identifiers: + get: + summary: Mapping of Group Identifiers + operationId: GetGroupIdentifiers + tags: + - Group Identifiers + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ext-group-id + in: query + description: External Group Identifier + required: false + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - name: int-group-id + in: query + description: Internal Group Identifier + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + - name: ue-id-ind + in: query + description: Indication whether UE identifiers are required or not + required: false + schema: + type: boolean + default: false + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/GroupIdentifiers' +``` + +``` + + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/5g-vn-groups: + get: + summary: Retrieves the data of a 5G VN Group + operationId: Query5GVnGroup + tags: + - 5G-VN-Groups (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: gpsis + in: query + description: List of GPSIs + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + style: form + explode: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + description: A map(list of key-value pairs) where ExtGroupId serves as key + additionalProperties: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/5GVnGroupConfiguration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/5g-vn-groups/{externalGroupId}: + put: + summary: Create an individual 5G VN Group + +``` + +``` +operationId: Create5GVnGroup +tags: + - 5GVnGroupConfiguration (Document) +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: + - name: externalGroupId + in: path + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' +requestBody: + content: + application/json: + schema: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/5GVnGroupConfiguration' + required: true +responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/5GVnGroupConfiguration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes the 5GVnGroup + operationId: Delete5GVnGroup + tags: + - Delete 5GVnGroup + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: externalGroupId + in: path + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + responses: + '204': + description: Expected response to a successful group removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: modify the 5GVnGroup + operationId: Modify5GVnGroup + tags: + - Modify 5GVnGroup + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: externalGroupId + in: path + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +``` + +``` + + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve a 5GVnGroup configuration + operationId: Get5GVnGroupConfiguration + tags: + - Query 5GVnGroupConfiguration (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: externalGroupId + in: path + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/5GVnGroupConfiguration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/lcs-privacy-data: + get: + summary: Retrieves the LCS Privacy subscription data of a UE + operationId: QueryLcsPrivacyData + tags: + - LCS Privacy Subscription Data + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + +``` + +``` + + type: array + items: + type: string + minItems: 1 + style: form + explode: false +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LcsPrivacyData' +headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/lcs-subscription-data: +get: + summary: Retrieves the LCS subscription data of a UE + operationId: QueryLcsSubscriptionData + tags: + - LCS Subscription Data + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + +``` + +``` +- name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LcsSubscriptionData' +headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/lcs-mo-data: + get: + summary: Retrieves the LCS Mobile Originated subscription data of a UE +``` + +``` +operationId: QueryLcsMoData +tags: + - LCS Mobile Originated Subscription Data +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LcsMoData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/nidd-authorization-data: + get: + summary: Retrieve NIDD Authorization Data GPSI or External Group identifier + operationId: GetNiddAuData + tags: + - Query NIDD Authorization Data GPSI or External Group identifier (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE ID + required: true + schema: + type: string + pattern: '^^(msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^\@]+\+|extgroupid-[^@]+\+@[^\@]+\+)$' + - name: single-nssai + in: query + content: + application/json: + schema: + $ref: '#/components/schemas/VarSnssai' + description: single NSSAI + required: true + - name: dnn + in: query + description: DNN + required: true + schema: + $ref: '#/components/schemas/Dnn' + - name: mtc-provider-information + in: query + description: MTC Provider Information + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + - name: af-id + in: query + description: Application Function Identifier + schema: + type: string + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + +``` + +``` + +8.8.3 + description: Entity Tag, containing a strong validator, as described in RFC 9110, + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/coverage-restriction-data: + get: + summary: Retrieves the subscribed enhanced Coverage Restriction Data of a UE + operationId: QueryCoverageRestrictionData + tags: + - Enhanced Coverage Restriction Data + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedCoverageRestrictionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + +``` + +8.8.3 description: Entity Tag, containing a strong validator, as described in RFC 9110, + +schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC + 9110, 8.8.2 + +schema: + type: string + '400': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/400' + '401': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/401' + '403': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/403' + '404': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/404' + '406': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/406' + '429': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/429' + '500': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/500' + '502': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/502' + '503': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/503' + default: + \$ref: 'TS29571\_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/location: + get: + summary: Retrieves the UE's Location Information + operationId: QueryUeLocation + tags: + - UE's Location Information (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + \$ref: '#/components/schemas/LocationInfo' + '400': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/400' + '401': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/401' + '403': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/403' + '404': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/404' + '406': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/406' + '429': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/429' + '500': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/500' + '502': + \$ref: 'TS29571\_CommonData.yaml#/components/responses/502' + +``` +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/v2x-data: + get: + summary: Retrieves the subscribed V2X Data of a UE + operationId: QueryV2xData + tags: + - V2X Subscription Data + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/V2xSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/prose-data: + get: + summary: Retrieves the subscribed ProSe service Data of a UE + operationId: QueryPorseData + tags: + - ProSe Service Subscription Data + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ProseSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` + + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/{servingPlmnId}/provisioned-data/lcs-bca-data: + get: + summary: Retrieves the LCS Broadcast Assistance subscription data of a UE + operationId: QueryLcsBcaData + tags: + - LCS Broadcast Assistance Subscription Data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: servingPlmnId + in: path + description: PLMN ID + required: true + schema: + $ref: '#/components/schemas/VarPlmnId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LcsBroadcastAssistanceTypesData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + +/subscription-data/group-data/5g-vn-groups/internal: + get: + summary: Retrieves the data of 5G VN Group + operationId: Query5GVnGroupInternal + tags: + - 5G-VN-Groups-Internal (Document) + parameters: + - name: internal-group-ids + in: query + description: List of Internal Group IDs + required: true + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + style: form + explode: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + description: A map (list of key-value pairs) where ExtGroupId serves as key + additionalProperties: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/5GVnGroupConfiguration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/5g-vn-groups/pp-profile-data: + get: + summary: Retrieves the parameter provision profile data for 5G VN Group + operationId: Query5GVNGroupPPData + tags: + - Parameter Provision profile Data for 5G VN Group (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ext-group-ids + in: query + description: List of external VN group identifiers + schema: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + minItems: 1 + +``` + +``` + + style: form + explode: false +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/Pp5gVnGroupProfileData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/nidd-authorizations: + put: + summary: Create NIDD Authorization Info + operationId: CreateNIDDAuthorizationInfo + tags: + - NIDD Authorization Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NiddAuthorizationInfo' + required: true + responses: + '204': + description: Upon success, an empty response body shall be returned + '201': + description: Upon successful creation, the created resource shall be returned + content: + application/json: + schema: + $ref: '#/components/schemas/NiddAuthorizationInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete NIDD Authorization Info + operationId: RemoveNiddAuthorizationInfo + tags: + - NIDD Authorization Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify NIDD Authorization Info + operationId: ModifyNiddAuthorizationInfo + tags: + - NIDD Authorization Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve NIDD Authorization Info + operationId: GetNiddAuthorizationInfo + tags: + - NIDD Authorization Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NiddAuthorizationInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +``` + +``` + + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/5mbs-data: + get: + summary: Retrieves the 5mbs subscription data of a UE + operationId: Query5mbsData + tags: + - 5MBSSubscriptionData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/MbsSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + +``` + +``` + +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}: + get: + summary: Retrieve multiple subscribed data sets of a UE + operationId: QueryUeSubscribedData + tags: + - UE Subscribed Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE Id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: dataset-names + in: query + description: List of dataset names + style: form + explode: false + schema: + $ref: '#/components/schemas/UeSubscribedDatasetNames' + - name: serving-plmn + in: query + description: Serving PLMN Id + schema: + $ref: '#/components/schemas/VarPlmnId' + - name: adjacent-plmns + in: query + description: List of PLMNs adjacent to the UE's serving PLMN + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + style: form + explode: false + - name: single-nssai + in: query + content: + application/json: + schema: + $ref: '#/components/schemas/VarSnssai' + description: single NSSAI + required: false + - name: dnn + in: query + description: DNN + required: false + schema: + $ref: '#/components/schemas/Dnn' + - name: ext-group-ids + in: query + description: List of external VN group identifiers + schema: + type: array + items: + +``` + +``` + + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + minItems: 1 + style: form + explode: false +- name: uc-purpose + in: query + description: User consent purpose + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/UcPurpose' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/UeSubscribedDataSets' + headers: + 3gpp-Sbi-Etags: + description: A comma-separated list of ProvisionedDatasetName = Etag pairs + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/service-specific-authorization-data/{serviceType}: + get: + summary: Retrieve ServiceSpecific Authorization Data + operationId: GetSSAuData + tags: + - Query Service Specific Authorization Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE ID + required: true + schema: + type: string + pattern: '^([msisdn-[0-9]{5,15}|.+|extid-[^@]+@[^\@]+\+|extgroupid-[^@]+@[^\@]+\+)$' + - name: serviceType + in: path + description: Service Type + required: true + schema: + $ref: 'TS29503_Nudm_SSAU.yaml#/components/schemas/ServiceType' + - name: single-nssai + in: query + content: + application/json: + schema: + $ref: '#/components/schemas/VarSnssai' + description: single NSSAI + required: true + - name: dnn + +``` + +``` + +in: query +description: DNN +required: true +schema: + $ref: '#/components/schemas/Dnn' +- name: mtc-provider-information + in: query + description: MTC Provider Information + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' +- name: af-id + in: query + description: Application Function Identifier + schema: + type: string +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string +- name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string +responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizationData' +headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/service-specific-authorizations/{serviceType}: + put: + summary: Create Service Specific Authorization Info + operationId: CreateServiceSpecificAuthorizationInfo + tags: + - Service Specific Authorization Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + +``` + +``` +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: +- name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: serviceType + in: path + description: Service Type + required: true + schema: + $ref: 'TS29503_Nudm_SSAU.yaml#/components/schemas/ServiceType' +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSpecificAuthorizationInfo' + required: true +responses: + '204': + description: Upon success, an empty response body shall be returned + '201': + description: Upon successful creation, the created resource shall be returned + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSpecificAuthorizationInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete Service Specific Authorization Info + operationId: RemoveServiceSpecificAuthorizationInfo + tags: + - Service Specific Authorization Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: serviceType + in: path + description: Service Type + required: true + schema: +``` + +``` + $ref: 'TS29503_Nudm_SSAU.yaml#/components/schemas/ServiceType' + responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + patch: + summary: Modify Service Specific Authorization Info + operationId: ModifyServiceSpecificAuthorizationInfo + tags: + - Service Specific Authorization Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: serviceType + in: path + description: Service Type + required: true + schema: + $ref: 'TS29503_Nudm_SSAU.yaml#/components/schemas/ServiceType' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: + schema: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve Service Specific Authorization Info + operationId: GetServiceSpecificAuthorizationInfo + tags: + - Service Specific Authorization Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: serviceType + in: path + description: Service Type + required: true + schema: + $ref: 'TS29503_Nudm_SSAU.yaml#/components/schemas/ServiceType' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSpecificAuthorizationInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/roaming-information: + put: + summary: Update the Roaming Information of the EPC domain + operationId: UpdateRoamingInformation + tags: + - Update the Roaming Information of the EPC domain (Document) + +``` + +``` + +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +requestBody: + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/RoamingInfoUpdate' + required: true +responses: + '201': + description: Created + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/RoamingInfoUpdate' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudr-dr/{apiVersion}>/subscription-data/{ueId}/context-data/roaming-information' + required: true + schema: + type: string + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +get: + summary: Retrieves the Roaming Information of the EPC domain + operationId: QueryRoamingInformation + tags: + - Retrieve the Roaming Information of the EPC domain (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + +``` + +``` + + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/RoamingInfoUpdate' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/context-data/pei-info: + put: + summary: Update the PEI Information of the 5GC/EPC domains + operationId: CreateOrUpdatePeiInformation + tags: + - Update the PEI Information of the 5GC/EPC domains (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/PeiUpdateInfo' + required: true + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/PeiUpdateInfo' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nudr-dr//subscription-data/{ueId}/context-data/pei-info' + required: true + schema: + type: string + '204': + description: Upon success, an empty response body shall be returned + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + +``` + +``` + + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +get: + summary: Retrieves the PEI Information of the 5GC/EPC domains + operationId: QueryPeiInformation + tags: + - Retrieve the Roaming Information of the 5GC/EPC domains (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUEId' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/PeiUpdateInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/amf-subscriptions: + put: + summary: Create AmfSubscriptions for a group of UEs or any UE + operationId: CreateAmfGroupSubscriptions + tags: + - AMF Group Subscription Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + +``` + +``` + + - nudr-dr:subscription-data +parameters: + - name: ueGroupId + in: path + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: subsId + in: path + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AmfSubscriptionInfo' + minItems: 1 + required: true +responses: + '204': + description: Upon success, an empty response body shall be returned + '201': + description: Upon successful creation, the created resource shall be returned + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AmfSubscriptionInfo' + minItems: 1 + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes AMF Subscription Info for an eeSubscription for a group of UEs or any UE + operationId: RemoveAmfGroupSubscriptions + tags: + - Event AMF Subscription Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueGroupId + in: path + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: subsId + in: path + +``` + +``` + required: true + schema: + type: string +responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: modify the AMF Subscription Info + operationId: ModifyAmfGroupSubscriptions + tags: + - AmfSubscriptionInfo (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueGroupId + in: path + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: subsId + in: path + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: +``` + +``` + + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve AMF subscription Info for a group of UEs or any UE + operationId: GetAmfGroupSubscriptions + tags: + - Query AMF Subscription Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueGroupId + in: path + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: subsId + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AmfSubscriptionInfo' + minItems: 1 + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/smf-subscriptions: + put: + summary: Create SMF Subscription Info for a group of UEs or any UE + +``` + +``` +operationId: CreateSmfGroupSubscriptions +tags: + - SMF Event Group Subscription Info (Document) +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data +parameters: + - name: ueGroupId + in: path + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: subsId + in: path + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmfSubscriptionInfo' + required: true +responses: + '204': + description: Upon success, an empty response body shall be returned + '201': + description: Upon successful creation, the created resource shall be returned + content: + application/json: + schema: + $ref: '#/components/schemas/SmfSubscriptionInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete SMF Subscription Info for a group of UEs or any UE + operationId: RemoveSmfGroupSubscriptions + tags: + - SMF Event Subscription Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueGroupId + in: path + required: true + schema: +``` + +``` + $ref: '#/components/schemas/VarUeGroupId' + - name: subsId + in: path + required: true + schema: + type: string + responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify SMF Subscription Info for a group of UEs or any UE + operationId: ModifySmfGroupSubscriptions + tags: + - SMF Event Subscription Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueGroupId + in: path + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: subsId + in: path + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': +``` + +``` + +description: modification is rejected +content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve SMF Subscription Info for a group of UEs or any UE + operationId: GetSmfGroupSubscriptions + tags: + - SMF Event Subscription Info (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueGroupId + in: path + required: true + schema: + $ref: '#/components/schemas/VarUeGroupId' + - name: subsId + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SmfSubscriptionInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/{ueGroupId}/ee-subscriptions/{subsId}/hss-subscriptions: + put: + summary: Create HSS Subscription Info for a group of UEs + +``` + +``` +operationId: CreateHssGroupSubscriptions +tags: + - HSS Event Group Subscription Info (Document) +parameters: + - name: externalGroupId + in: path + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - name: subsId + in: path + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HssSubscriptionInfo' + required: true +responses: + '204': + description: Upon success, an empty response body shall be returned + '201': + description: Upon successful creation, the created resource shall be returned + content: + application/json: + schema: + $ref: '#/components/schemas/HssSubscriptionInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete HSS Subscription Info + operationId: RemoveHssGroupSubscriptions + tags: + - HSS Event Subscription Info (Document) + parameters: + - name: externalGroupId + in: path + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - name: subsId + in: path + required: true + schema: + type: string + responses: + '204': + description: Expected response to a successful subscription removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify HSS Subscription Info + operationId: ModifyHssGroupSubscriptions + tags: + - HSS Event Subscription Info (Document) + parameters: + - name: externalGroupId + in: path + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - name: subsId + in: path + required: true + schema: + type: string + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +``` + +``` + +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve HSS Subscription Info + operationId: GetHssGroupSubscriptions + tags: + - HSS Event Subscription Info (Document) + parameters: + - name: externalGroupId + in: path + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - name: subsId + in: path + required: true + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/HssSubscriptionInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/uc-data: + get: + summary: Retrieves the subscribed User Consent Data of a UE + operationId: QueryUserConsentData + tags: + - User Consent Data + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: ucPurpose + in: query + description: User consent purpose + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/UcPurpose' + - name: If-None-Match + +``` + +``` + +in: header +description: Validator for conditional requests, as described in RFC 9110, 13.1.2 +schema: + type: string +- name: If-Modified-Since +in: header +description: Validator for conditional requests, as described in RFC 9110, 13.1.3 +schema: + type: string +responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/UcSubscriptionData' +headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/time-sync-data: +get: + summary: Retrieves the time synchronization subscription data of a UE + operationId: QueryTimeSyncSubscriptionData + tags: + - TimeSyncSubscriptionData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + +``` + +``` + +in: header +description: Validator for conditional requests, as described in RFC 9110, 13.1.2 +schema: + type: string +- name: If-Modified-Since +in: header +description: Validator for conditional requests, as described in RFC 9110, 13.1.3 +schema: + type: string +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/TimeSyncSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/subscription-data/group-data/mbs-group-membership: +get: + summary: Retrieves the data of a 5G MBS Group + operationId: Query5GmbsGroup + tags: + - 5G-MBS-Group (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: gpsis + in: query + description: List of GPSIs + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + style: form + explode: false + responses: + '200': + description: Expected response to a valid request + +``` + +``` + +content: + application/json: + schema: + type: object + description: A map(list of key-value pairs) where ExtGroupId serves as key + additionalProperties: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/MulticastMbsGroupMemb' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/mbs-group-membership/{externalGroupId}: + put: + summary: Create an individual 5G MBS Group + operationId: Create5GmbsGroup + tags: + - MulticastMbsGroupMemb (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: externalGroupId + in: path + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + requestBody: + content: + application/json: + schema: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/MulticastMbsGroupMemb' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/MulticastMbsGroupMemb' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + +``` + +``` +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes the 5GmbsGroup + operationId: Delete5GmbsGroup + tags: + - Delete 5GmbsGroup + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: externalGroupId + in: path + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + responses: + '204': + description: Expected response to a successful group removal + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: modify the 5GmbsGroup + operationId: Modify5GmbsGroup + tags: + - Modify 5GmbsGroup + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: externalGroupId + in: path + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + - name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true +``` + +``` +responses: + '204': + description: Expected response to a valid request + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: modification is rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieve a 5GmbsGroup + operationId: GetMulticastMbsGroupMemb + tags: + - Query MulticastMbsGroupMemb (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: externalGroupId + in: path + required: true + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/MulticastMbsGroupMemb' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/mbs-group-membership/internal: + get: + summary: Retrieves the data of 5G MBS Group + operationId: Query5GMbsGroupInternal + tags: + - 5G-MBS-Groups-Internal (Document) + parameters: + - name: internal-group-ids + in: query + description: List of Internal Group IDs + required: true + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + style: form + explode: false + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + description: A map (list of key-value pairs) where ExtGroupId serves as key + additionalProperties: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/MulticastMbsGroupMemb' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/group-data/mbs-group-membership/pp-profile-data: + get: + summary: Retrieves the parameter provision profile data for 5G MBS Group + operationId: Query5GMbsGroupPPData + tags: + - Parameter Provision profile Data for 5G MBS Group(Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ext-group-ids + in: query + description: List of external MBS group identifiers + schema: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + minItems: 1 + style: form + explode: false +``` + +``` +- name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/Pp5gMbsGroupProfileData' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/ranging-slpos-data: + get: + summary: Retrieves the subscribed Ranging and Sidelink Positioning service Data of a UE + operationId: QueryRangingSlPosData + tags: + - Ranging and Sidelink Positioning Service Subscription Data + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/RangingSlPosSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 +``` + +``` + + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription-data/{ueId}/a2x-data: + get: + summary: Retrieves the subscribed A2X Data of a UE + operationId: QueryA2xData + tags: + - A2X Subscription Data + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:subscription-data + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.2 + schema: + type: string + - name: If-Modified-Since + in: header + description: Validator for conditional requests, as described in RFC 9110, 13.1.3 + schema: + type: string + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/A2xSubscriptionData' + headers: + Cache-Control: + description: Cache-Control containing max-age, as described in RFC 9111, 5.2 + +``` + +``` + + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in RFC 9110, +8.8.3 + schema: + type: string + Last-Modified: + description: Timestamp for last modification of the resource, as described in RFC +9110, 8.8.2 + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + schemas: + AuthenticationSubscription: + description: A UE's authentication data. + type: object + required: + - authenticationMethod + properties: + authenticationMethod: + $ref: '#/components/schemas/AuthMethod' + encPermanentKey: + type: string + protectionParameterId: + type: string + sequenceNumber: + $ref: '#/components/schemas/SequenceNumber' + authenticationManagementField: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + algorithmId: + type: string + encOpcKey: + type: string + encTopcKey: + type: string + vectorGenerationInHss: + type: boolean + default: false + hssGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + n5gcAuthMethod: + $ref: '#/components/schemas/AuthMethod' + rgAuthenticationInd: + type: boolean + default: false + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + akmaAllowed: + type: boolean + default: false + routingId: + type: string + pattern: '^[0-9]{1,4}$' + + SequenceNumber: + +``` + +``` +description: Contains the SQN. +type: object +properties: + sqnScheme: + $ref: '#/components/schemas/SqnScheme' + sqn: + type: string + pattern: '^[A-Fa-f0-9]{12}$' + lastIndexes: + type: object + additionalProperties: + type: integer + minimum: 0 + description: A map(list of key-value pairs) where type of node serves as key + indLength: + type: integer + minimum: 0 + difSign: + $ref: '#/components/schemas/Sign' + +SqnScheme: +description: Scheme for generation of Sequence Numbers. +anyOf: +- type: string + enum: + - GENERAL + - NON_TIME_BASED + - TIME_BASED +- type: string + +Sign: +description: Sign of the DIF value. +type: string +enum: +- POSITIVE +- NEGATIVE + +VarPlmnId: +description: PLMN Id (MCC, MNC) or SNPN Id (MCC, MNC, NID). +type: string +pattern: '^[0-9]{5,6}(-[A-Fa-f0-9]{11})?$' + +ProvisionedDatasetNames: +description: The list of names of data sets. +type: array +items: + $ref: '#/components/schemas/ProvisionedDataSetName' +minItems: 1 +uniqueItems: true + +ProvisionedDataSetName: +description: The name of data set. +anyOf: +- type: string + enum: + - AM + - SMF_SEL + - SMS_SUB + - SM + - TRACE + - SMS_MNG + - LCS_PRIVACY + - LCS_MO + - LCS_BCA + - LCS_SUB + - V2X + - PROSE + - ODB + - EE_PROF + - PP_PROF + - NIDD_AUTH + - USER_CONSENT + - MBS + - PP_DATA + - A2X +- type: string + +UeSubscribedDatasetNames: +description: The list of names of data sets. +type: array +items: +``` + +``` + + $ref: '#/components/schemas/UeSubscribedDataSetName' + minItems: 1 + uniqueItems: true + +UeSubscribedDataSetName: + description: All values defined as ProvisionedDataSetName or ContextDataSetName are applicable + anyOf: + - $ref: '#/components/schemas/ContextDataSetName' + - $ref: '#/components/schemas/ProvisionedDataSetName' + - type: string + enum: + - UE_UPD_CONF + +ProvisionedDataSets: + description: Contains the provisioned data sets. + type: object + properties: + amData: + $ref: '#/components/schemas/AccessAndMobilitySubscriptionData' + smfSelData: + $ref: '#/components/schemas/SmfSelectionSubscriptionData' + smsSubsData: + $ref: '#/components/schemas/SmsSubscriptionData' + smData: + $ref: '#/components/schemas/SmSubsData' + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + smsMngData: + $ref: '#/components/schemas/SmsManagementSubscriptionData' + lcsPrivacyData: + $ref: '#/components/schemas/LcsPrivacyData' + lcsMoData: + $ref: '#/components/schemas/LcsMoData' + lcsSubscriptionData: + $ref: '#/components/schemas/LcsSubscriptionData' + lcsBcaData: + $ref: '#/components/schemas/LcsBroadcastAssistanceTypesData' + v2xData: + $ref: '#/components/schemas/V2xSubscriptionData' + proseData: + $ref: '#/components/schemas/ProseSubscriptionData' + odbData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/OdbData' + eeProfileData: + $ref: '#/components/schemas/EeProfileData' + ppProfileData: + $ref: '#/components/schemas/PpProfileData' + niddAuthData: + $ref: '#/components/schemas/AuthorizationData' + ucData: + $ref: '#/components/schemas/UcSubscriptionData' + mbsSubscriptionData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/MbsSubscriptionData' + ppData: + $ref: '#/components/schemas/PpData' + a2xData: + $ref: '#/components/schemas/A2xSubscriptionData' + +AccessAndMobilitySubscriptionData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/AccessAndMobilitySubscriptionData' +SmfSelectionSubscriptionData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SmfSelectionSubscriptionData' +VarSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' +Dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +SmSubsData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SmSubsData' +Amf3GppAccessRegistration: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/Amf3GppAccessRegistration' +AmfNon3GppAccessRegistration: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/AmfNon3GppAccessRegistration' +SmfRegistration: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/SmfRegistration' +SmsfRegistration: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/SmsfRegistration' +LocationInfo: + +``` + +``` +$ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/LocationInfo' +SmsManagementSubscriptionData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SmsManagementSubscriptionData' +SmsSubscriptionData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SmsSubscriptionData' +LcsPrivacyData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/LcsPrivacyData' +LcsMoData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/LcsMoData' +LcsSubscriptionData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/LcsSubscriptionData' +A2xSubscriptionData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/A2xSubscriptionData' + +AuthorizationData: + description: NIDD Authorization Information + required: + - authorizationData + properties: + authorizationData: + type: array + items: + $ref: 'TS29503_Nudm_NIDDAU.yaml#/components/schemas/UserIdentifier' + minItems: 1 + uniqueItems: true + allowedDnnList: + type: array + items: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + allowedSnssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + allowedMtcProviders: + type: array + items: + $ref: '#/components/schemas/MtcProvider' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +EnhancedCoverageRestrictionData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/EnhancedCoverageRestrictionData' +V2xSubscriptionData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/V2xSubscriptionData' +ProseSubscriptionData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ProseSubscriptionData' +UcSubscriptionData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/UcSubscriptionData' +LcsBroadcastAssistanceTypesData: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/LcsBroadcastAssistanceTypesData' + +OperatorSpecificDataContainer: + description: Container for operator specific data. + type: object + required: + - dataType + - value + properties: + dataType: + type: string + enum: + - string + - integer + - number + - boolean + - object + - array + dataTypeDefinition: + type: string + value: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + - type: object + - type: array + supportedFeatures: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +resetIds: + type: array + items: + type: string + minItems: 1 + +AuthMethod: + description: Contains the Authentication Method. + anyOf: + - type: string + enum: + - 5G_AKA + - EAP_AKA_PRIME + - EAP_TLS + - EAP_TTLS + - NONE + - type: string + +PpData: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/PpData' + +EeSubscription: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/EeSubscription' + +VarUeGroupId: + description: UE group Id or any UE. + type: string + pattern: '(^|extgroupid-[^@]+\@[^\@]+\|anyUE)$' + +SdmSubscription: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SdmSubscription' + +SmfRegList: + description: The list of all the SMF registrations of a UE. + type: array + items: + $ref: '#/components/schemas/SmfRegistration' + +SubscriptionDataSubscriptions: + description: A subscription to notifications. + type: object + required: + - monitoredResourceUris + - callbackReference + properties: + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + callbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + originalCallbackReference: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + sdmSubscription: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SdmSubscription' + hssSubscriptionInfo: + $ref: '#/components/schemas/HssSubscriptionInfo' + subscriptionId: + type: string + uniqueSubscription: + type: boolean + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + immediateReport: + type: boolean + default: false + report: + $ref: '#/components/schemas/ImmediateReport' + additionalDataRefs: + type: array + items: + $ref: '#/components/schemas/AdditionalDataRef' + +AdditionalDataRef: + description: References to additional data requested to be sent in notifications + type: object + required: + - monitoredResourceUris + - additionalDataUris +``` + +``` +properties: + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + additionalDataUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + +DataChangeNotify: + description: Container for data which have changed and notification was requested when + changed. + type: object + properties: + originalCallbackReference: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + notifyItems: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotifyItem' + minItems: 1 + sdmSubscription: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SdmSubscription' + additionalSdmSubscriptions: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SdmSubscription' + minItems: 1 + subscriptionDataSubscriptions: + type: array + items: + $ref: '#/components/schemas/SubscriptionDataSubscriptions' + additionalData: + description: A map (list of key-value pairs where URI serves as key) of Any Type. + type: object + additionalProperties: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + - type: object + - type: array + minProperties: 1 + +IdentityData: + description: Identity data corresponds to the provided ueId. + type: object + properties: + supiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gsiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + allowedAfIds: + type: array + items: + type: string + minItems: 1 + applicationPortIds: + description: A map (list of key-value pairs where AppPortId serves as key) of GPSIs. + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minProperties: 1 +``` + +``` +UeUpdConfData: + description: The complete UE Update Confirmation Data. + type: object + properties: + sorData: + $ref: '#/components/schemas/SorData' + upuData: + $ref: '#/components/schemas/UpuData' + nssaiAckData: + $ref: '#/components/schemas/NssaiAckData' + cagAckData: + $ref: '#/components/schemas/CagAckData' + +SorData: + description: Used to store the status of the latest SOR data update. + type: object + properties: + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ueUpdateStatus: + $ref: '#/components/schemas/UeUpdateStatus' + sorXmacIue: + $ref: 'TS29509_Nausf_SorProtection.yaml#/components/schemas/SorMac' + sorMacIue: + $ref: 'TS29509_Nausf_SorProtection.yaml#/components/schemas/SorMac' + meSupportOfSorCmci: + type: boolean + meSupportOfSorSnpnSi: + type: boolean + default: false + meSupportOfSorSnpnSiLs: + type: boolean + default: false + required: + - provisioningTime + - ueUpdateStatus + +UpuData: + description: Used to store the status of the latest UPU data update. + type: object + properties: + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ueUpdateStatus: + $ref: '#/components/schemas/UeUpdateStatus' + upuXmacIue: + $ref: 'TS29509_Nausf_UPUProtection.yaml#/components/schemas/UpuMac' + upuMacIue: + $ref: 'TS29509_Nausf_UPUProtection.yaml#/components/schemas/UpuMac' + required: + - provisioningTime + - ueUpdateStatus + +NssaiAckData: + description: Used to store the status of the latest NSSAI data update. + type: object + properties: + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ueUpdateStatus: + $ref: '#/components/schemas/UeUpdateStatus' + required: + - provisioningTime + - ueUpdateStatus + +CagAckData: + description: Used to store the status of the latest CAG data update. + type: object + properties: + provisioningTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ueUpdateStatus: + $ref: '#/components/schemas/UeUpdateStatus' + required: + - provisioningTime + - ueUpdateStatus +``` + +``` + +UeUpdateStatus: + description: Status of the procedure. + type: string + enum: + - NOT_SENT + - SENT_NO_ACK_REQUIRED + - WAITING_FOR_ACK + - ACK_RECEIVED + - NEGATIVE_ACK_RECEIVED + +EeProfileData: + description: Event Exposure Profile Data. + type: object + properties: + restrictedEventTypes: + type: array + items: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/EventType' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + allowedMtcProvider: + description: A map (list of key-value pairs where EventType serves as key) of MTC provider + lists. In addition to defined EventTypes, the key value "ALL" may be used to identify a map entry + which contains a list of MtcProviders that are allowed monitoring all Event Types. + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/MtcProvider' + minItems: 1 + minProperties: 1 + iwkEpcRestricted: + type: boolean + default: false + imsi: + type: string + pattern: '^[0-9]{5,15}$' + hssGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + +AmfSubscriptionInfo: + description: Information the UDR stores and retrieves related to active subscriptions at the + AMF(s). + type: object + required: + - amfInstanceId + - subscriptionId + properties: + amfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + subscriptionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + subsChangeNotifyCorrelationId: + type: string + contextInfo: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo' + +ContextDatasetNames: + description: The name of context data set. + type: array + items: + $ref: '#/components/schemas/ContextDataSetName' + minItems: 2 + uniqueItems: true +ContextDataSetName: + anyOf: + - type: string + enum: + - AMF_3GPP + - AMF_NON_3GPP + - SDM_SUBSCRIPTIONS + - EE_SUBSCRIPTIONS + - SMSF_3GPP + - SMSF_NON_3GPP + - SUBS_TO_NOTIFY + - SMF_REG + - IP_SM_GW + - ROAMING_INFO + +``` + +``` +- PEI_INFO +- type: string +ContextDataSets: + description: Contains the context data sets. + type: object + properties: + amf3Gpp: + $ref: '#/components/schemas/Amf3GppAccessRegistration' + amfNon3Gpp: + $ref: '#/components/schemas/AmfNon3GppAccessRegistration' + sdmSubscriptions: + type: array + items: + $ref: '#/components/schemas/SdmSubscription' + minItems: 1 + eeSubscriptions: + type: array + items: + $ref: '#/components/schemas/EeSubscription' + minItems: 1 + smsf3GppAccess: + $ref: '#/components/schemas/SmsfRegistration' + smsfNon3GppAccess: + $ref: '#/components/schemas/SmsfRegistration' + subscriptionDataSubscriptions: + type: array + items: + $ref: '#/components/schemas/SubscriptionDataSubscriptions' + minItems: 1 + smfRegistrations: + $ref: '#/components/schemas/SmfRegList' + ipSmGw: + $ref: '#/components/schemas/IpSmGwRegistration' + roamingInfo: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/RoamingInfoUpdate' + peiInfo: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/PeiUpdateInfo' + +IpSmGwRegistration: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/IpSmGwRegistration' + +MessageWaitingData: + description: Message Waiting Data list. + type: object + properties: + mwdList: + type: array + items: + $ref: '#/components/schemas/SmscData' + minItems: 1 + +SmscData: + description: Addresses of SM-Service Center entities with SMS waiting to be delivered to the +UE. + type: object + anyOf: + - required: [ smscMapAddress ] + - required: [ smscDiameterAddress ] + properties: + smscMapAddress: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/E164Number' + smscDiameterAddress: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/NetworkNodeDiameterAddress' + +SmfSubscriptionInfo: + description: Information related to active subscriptions at the SMF(s) + type: object + required: + - smfSubscriptionList + properties: + smfSubscriptionList: + type: array + items: + $ref: '#/components/schemas/SmfSubscriptionItem' + minItems: 1 + +SmfSubscriptionItem: + description: Contains info about a single SMF event subscription +``` + +``` + +type: object +required: + - smfInstanceId + - subscriptionId +properties: + smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + subscriptionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + contextInfo: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo' + +MtcProvider: + description: MTC provider information. + type: object + properties: + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + afId: + type: string + +HssSubscriptionInfo: + description: Information related to active subscriptions at the HSS(s) + type: object + required: + - hssSubscriptionList + properties: + hssSubscriptionList: + type: array + items: + $ref: '#/components/schemas/HssSubscriptionItem' + minItems: 1 + +HssSubscriptionItem: + description: Contains info about a single HSS event subscription + type: object + required: + - hssInstanceId + - subscriptionId + properties: + hssInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + subscriptionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + contextInfo: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ContextInfo' + +EeGroupProfileData: + type: object + properties: + restrictedEventTypes: + type: array + items: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/EventType' + allowedMtcProvider: + description: A map (list of key-value pairs where EventType serves as key) of MTC provider +lists. In addition to defined EventTypes, the key value "ALL" may be used to identify a map entry +which contains a list of MtcProviders that are allowed monitoring all Event Types. + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/MtcProvider' + minItems: 1 + minProperties: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + iwkEpcRestricted: + type: boolean + default: false + extGroupId: + type: string + pattern: '^extgroupid-[^@]+@[^\@]+\$' + hssGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + +Pp5gVnGroupProfileData: + type: object + +``` + +``` +properties: + allowedMtcProviders: + description: A map (list of key-value pairs where external VN group identifier serves as +key) of AllowedMtcProviderInfo lists. In addition to defined external VN group identifier, the key +value "ALL" may be used to identify a map entry which contains a list of AllowedMtcProviderInfo that +are allowed operating all the external group identifiers. + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/AllowedMtcProviderInfo' + minItems: 1 + minProperties: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +PpProfileData: + type: object + properties: + allowedMtcProviders: + description: A map (list of key-value pairs where PpDataType serves as key) of +AllowedMtcProviderInfo lists. In addition to defined PpDataType, the key value "ALL" may be used to +identify a map entry which contains a list of AllowedMtcProviderInfo that are allowed to provision +all types of the PP data for the user using UDM ParameterProvision service. + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/AllowedMtcProviderInfo' + minItems: 1 + minProperties: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +AllowedMtcProviderInfo: + type: object + properties: + mtcProviderInformation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation' + afId: + type: string + +PpDataType: + anyOf: + - type: string + enum: + - COMMUNICATION_CHARACTERISTICS + - EXPECTED_UE_BEHAVIOUR + - EC_RESTRICTION + - ACS_INFO + - TRACE + - STN_SR + - LCS_PRIVACY + - SOR_INFO + - type: string + +GroupIdentifiers: + description: External or Internal Group Identifier with a list of group members + type: object + properties: + extGroupId: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + intGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + ueIdList: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/UeId' + minItems: 1 + allowedAfIds: + type: array + items: + type: string + minItems: 1 + +NiddAuthorizationInfo: + description: Information related to active NIDD Authorizations + type: object +``` + +``` +required: + - niddAuthorizationList +properties: + niddAuthorizationList: + type: array + items: + $ref: 'TS29503_Nudm_NIDDAU.yaml#/components/schemas/AuthorizationInfo' + minItems: 1 + +PpDataEntryList: + description: Contains a list of the Provisioned Parameters entries + type: object + properties: + ppDataEntryList: + type: array + items: + $ref: 'TS29503_Nudm_PP.yaml#/components/schemas/PpDataEntry' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +UeSubscribedDataSets: + description: Contains the subscribed data sets of a UE. + allOf: + - $ref: '#/components/schemas/ProvisionedDataSets' + - $ref: '#/components/schemas/ContextDataSets' + - $ref: '#/components/schemas/UeUpdConfData' + +ServiceSpecificAuthorizationInfo: + description: Information related to active Service Specific Authorizations + type: object + required: + - serviceSpecificAuthorizationList + properties: + serviceSpecificAuthorizationList: + type: array + items: + $ref: 'TS29503_Nudm_NIDDAU.yaml#/components/schemas/AuthorizationInfo' + minItems: 1 + +NfIdentifier: + type: object + required: + - nfType + properties: + nfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +EeSubscriptionExt: + allOf: + - $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/EeSubscription' + - $ref: '#/components/schemas/AdditionalEeSubsInfo' + +AdditionalEeSubsInfo: + type: object + properties: + amfSubscriptionInfoList: + type: array + items: + $ref: '#/components/schemas/AmfSubscriptionInfo' + minItems: 1 + maxItems: 2 + smfSubscriptionInfo: + $ref: '#/components/schemas/SmfSubscriptionInfo' + hssSubscriptionInfo: + $ref: '#/components/schemas/HssSubscriptionInfo' + +ImmediateReport: + oneOf: + - $ref: '#/components/schemas/ProvisionedDataSets' + - type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedData' + minItems: 0 + +Pp5gMbsGroupProfileData: + type: object +``` + +``` +properties: + allowedMbsInfos: + description: A map (list of key-value pairs where external VN group identifier serves as +key) of AllowedMbsInfos lists. In addition to defined external MBS group identifier, the key value +"ALL" may be used to identify a map entry which contains a list of AllowedMbsInfo that are allowed +operating all the external group identifiers. + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/AllowedMbsInfo' + minItems: 1 + minProperties: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +AllowedMbsInfo: + type: object + properties: + afId: + type: string + +TraceDataOrSharedTraceDataId: + oneOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + - $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedDataId' +``` + +--- + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-01 | CT4#82 | | | | | TS skeleton of Usage of the Unified Data Repository service for Subscription Data | 0.0.0 | +| 2018-01 | CT4#82 | C4-181397 | | | | Version after CT4#82 including agreed pCRs | 0.1.0 | +| 2018-03 | CT4#83 | C4-182442 | | | | Version after CT4#83 including agreed pCRs | 0.2.0 | +| 2018-04 | CT4#84 | C4-183523 | | | | Version after CT4#84 including agreed pCRs | 0.3.0 | +| 2018-05 | CT4#85 | C4-184638 | | | | Version after CT4#85 including agreed pCRs | 0.4.0 | +| 2018-06 | CT#80 | CP-181103 | | | | Presented for information and approval | 1.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | +| 2018-09 | CT#81 | CP-182058 | 0004 | - | F | Path Segment Correction | 15.1.0 | +| 2018-09 | CT#81 | CP-182058 | 0005 | - | F | URI variables for the Resource OperatorSpecificData | 15.1.0 | +| 2018-09 | CT#81 | CP-182058 | 0008 | - | F | Formatting of query parameter | 15.1.0 | +| 2018-09 | CT#81 | CP-182212 | 0009 | 2 | B | PATCH method for ProvisionedParameterData | 15.1.0 | +| 2018-09 | CT#81 | CP-182058 | 0010 | - | F | JSON structure in query and missing data type reference | 15.1.0 | +| 2018-09 | CT#81 | CP-182058 | 0014 | - | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182058 | 0016 | - | F | Implicit Subscriptions | 15.1.0 | +| 2018-09 | CT#81 | CP-182058 | 0011 | 1 | F | Align security and servers clause in openAPI | 15.1.0 | +| 2018-09 | CT#81 | CP-182058 | 0013 | 1 | F | VarUeld used in TS 29.505 | 15.1.0 | +| 2018-09 | CT#81 | CP-182058 | 0012 | 2 | F | OpenAPI schema for SubscriptionData | 15.1.0 | +| 2018-09 | CT#81 | CP-182058 | 0018 | 1 | F | Supported Features Negotiation | 15.1.0 | +| 2018-09 | CT#81 | CP-182041 | 0015 | 1 | B | Nudr Id Translation | 15.1.0 | +| 2018-09 | CT#81 | CP-182043 | 0001 | 2 | B | Add support for 5G Trace to Nudr | 15.1.0 | +| 2018-12 | CT#82 | CP-183016 | 0026 | - | F | Corrections in Query Parameters | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0030 | - | F | 29505 CR data change notification data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0021 | 1 | F | Pattern correction | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0022 | 1 | F | Session Management Subscription Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0019 | 1 | F | Shared Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0029 | 1 | F | 29505 CR cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0025 | 2 | F | Clarification of contents of SUP1 list | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0032 | - | F | Cache control and conditional request header addition | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0024 | 3 | F | Introduction of Barring of Roaming in 5GC | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0037 | 1 | F | Session Management Subscription Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0039 | 1 | F | Authorized Event Types | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0040 | 1 | F | Group Subscriptions | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0041 | 1 | F | Location header in 201 response | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0038 | 2 | F | Active AmfSubscriptions storage | 15.2.0 | +| 2018-12 | CT#82 | CP-183016 | 0036 | 2 | F | lifetime of subscription | 15.2.0 | +| 2018-12 | CT#82 | CP-183158 | 0028 | 3 | F | Definition of Authentication Data for steering of roaming | 15.2.0 | +| 2018-12 | CT#82 | CP-183159 | 0027 | 4 | F | Definition of Authentication Status | 15.2.0 | +| 2018-12 | CT#82 | CP-183160 | 0020 | 5 | F | Definition of Authentication data | 15.2.0 | +| 2018-12 | CT#82 | CP-183187 | 0023 | 3 | F | Get multiple datasets for ProvisionedData | 15.2.0 | +| 2018-12 | CT#82 | CP-183249 | 0042 | - | F | Corrections on openAPI | 15.2.0 | +| 2019-03 | CT#83 | CP-190179 | 0043 | | F | CR 0019r1 was not correctly implemented | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0044 | | F | CR 0020r5 was not correctly implemented | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0045 | | F | CR 0021r1 was not correctly implemented | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0046 | | F | CR 0023r3 was not correctly implemented | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0047 | | F | CR 0038r2 was not correctly implemented | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0048 | | F | CR 0039r1 was not correctly implemented | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0049 | | F | CR 0040r1 was not correctly implemented | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0050 | | F | Correction of annex B | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0052 | 2 | F | Clarification on use of PUT | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0054 | | F | Missing Headlines | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0055 | 2 | F | Sequence Number | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0056 | 1 | F | Retrieval of multiple context data sets | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0057 | 3 | F | UDR Subscriptions | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0058 | 1 | F | Data Set Names in URI Query Parameters | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0060 | 2 | F | AuthenticationSubscription correction | 15.3.0 | +| 2019-03 | CT#83 | CP-190179 | 0061 | 2 | F | SOR data update status | 15.3.0 | +| 2019-03 | CT#83 | CP-190168 | 0062 | 1 | F | 3GPP TS 29.505 API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191032 | 0065 | | F | CR 0049 was not correctly implemented | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0066 | | F | CR 0050 was not correctly implemented | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0067 | | F | CR 0054 was not correctly implemented | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0068 | | F | CR 0056r1 was not correctly implemented | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0070 | | F | Update of the SubsToNotify | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0071 | | F | Update of the EESubscription | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0064 | 1 | F | Update Individual Subscription | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0072 | 1 | F | missing entries of data type summary table | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0073 | 1 | F | correction on operationId | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0074 | 1 | F | 404 error response | 15.4.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|-----------------------------------------------------------------------|--------| +| 2019-06 | CT#84 | CP-191032 | 0076 | 1 | F | Correct the GET Request Body of AmfNon3GppAccessRegistration resource | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0077 | 1 | F | Default Notification URI | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0081 | 1 | F | OdbData Correction | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0086 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0075 | 3 | F | CR 0062r1 was not correctly implemented | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0079 | 2 | F | Subscriptions Deletion | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0087 | | F | PduSessionId | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0063 | 2 | F | UE Parameter Update (UPU) | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0078 | 2 | F | Group Identifier Translation | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0080 | 2 | F | Authentication Subscription | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0069 | 2 | F | CR 0062r1 was not correctly implemented | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0088 | 1 | F | Protection Parameter ID | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0089 | 1 | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CT#84 | CP-191032 | 0083 | 6 | F | SubscriptionDataSubscriptions identification | 15.4.0 | +| 2019-09 | CT#85 | CP-192229 | 0094 | 1 | B | Definition of OperatorSpecificDataContainer | 16.0.0 | +| 2019-09 | CT#85 | CP-192123 | 0100 | - | F | Missing supportedFeatures | 16.0.0 | +| 2019-09 | CT#85 | CP-192123 | 0090 | 1 | B | Network Slicing Subscription Change | 16.0.0 | +| 2019-09 | CT#85 | CP-192123 | 0098 | 1 | F | UDR Application Errors | 16.0.0 | +| 2019-09 | CT#85 | CP-192123 | 0101 | 1 | B | Application errors for DELETE method | 16.0.0 | +| 2019-09 | CT#85 | CP-192133 | 0095 | 1 | B | Closed Access Group | 16.0.0 | +| 2019-09 | CT#85 | CP-192027 | 0096 | 2 | B | VN-Group parameter provisioning | 16.0.0 | +| 2019-09 | CT#85 | CP-192120 | 0104 | - | F | 3GPP TS 29.505 externalDoc correction | 16.0.0 | +| 2019-10 | | | | | | Corrupted references fixed | 16.0.1 | +| 2019-12 | CT#86 | CP-193029 | 0108 | | A | Monitored Resource URI | 16.1.0 | +| 2019-12 | CT#86 | CP-193029 | 0263 | 1 | A | GroupIdentifier resource URI | 16.1.0 | +| 2019-12 | CT#86 | CP-193049 | 0112 | 1 | B | Id translation for MSISDN-less MO SMS service | 16.1.0 | +| 2019-12 | CT#86 | CP-193278 | 0258 | 4 | B | NIDD Authorization Data | 16.1.0 | +| 2019-12 | CT#86 | CP-193131 | 0257 | 1 | B | Authentication Subscription Data | 16.1.0 | +| 2019-12 | CT#86 | CP-193055 | 0109 | 2 | B | LCS Private | 16.1.0 | +| 2019-12 | CT#86 | CP-193055 | 0110 | 3 | B | Mobile Originated Data | 16.1.0 | +| 2019-12 | CT#86 | CP-193063 | 0105 | 1 | F | DataChangeNotify | 16.1.0 | +| 2019-12 | CT#86 | CP-193063 | 0106 | 1 | B | Patch Report | 16.1.0 | +| 2019-12 | CT#86 | CP-193063 | 0259 | 1 | B | Feature Negotiation for OperatorSpecificData resource | 16.1.0 | +| 2019-12 | CT#86 | CP-193124 | 0265 | - | F | externalDocs correction | 16.1.0 | +| 2020-03 | CT#87 | CP-200018 | 0269 | | B | Translation of Group Id to UE identifier list | 16.2.0 | +| 2020-03 | CT#87 | CP-200020 | 0271 | 1 | F | GET Method to subscriptions | 16.2.0 | +| 2020-03 | CT#87 | CP-200020 | 0272 | | F | Add SMFRegistration to ContextDataSet | 16.2.0 | +| 2020-03 | CT#87 | CP-200020 | 0266 | 2 | F | AuthEvent deletion | 16.2.0 | +| 2020-03 | CT#87 | CP-200033 | 0267 | 1 | B | Retrieve the status of Enhanced Coverage Restriction | 16.2.0 | +| 2020-03 | CT#87 | CP-200020 | 0268 | 1 | B | 29505 CR optionality of ProblemDetails | 16.2.0 | +| 2020-03 | CT#87 | CP-200052 | 0273 | | F | 3GPP TS 29.505 Rel16 External doc update | 16.2.0 | +| 2020-06 | CT#88-e | CP-201032 | 0275 | | B | Location information retrieval for GMLC | 16.3.0 | +| 2020-06 | CT#88-e | CP-201032 | 0276 | 1 | B | Resource LcsPrivacySubscriptionData | 16.3.0 | +| 2020-06 | CT#88-e | CP-201071 | 0281 | | F | Storage of YAML files in ETSI Forge | 16.3.0 | +| 2020-06 | CT#88-e | CP-201049 | 0283 | | B | Correction on V2X Subscription data | 16.3.0 | +| 2020-06 | CT#88-e | CP-201033 | 0285 | | B | Auth Vector Generation for HSS | 16.3.0 | +| 2020-06 | CT#88-e | CP-201034 | 0286 | | B | Resource Level Authorization | 16.3.0 | +| 2020-06 | CT#88-e | CP-201034 | 0282 | 1 | F | Authentication results for multiple registrations | 16.3.0 | +| 2020-06 | CT#88-e | CP-201032 | 0288 | 1 | F | Mobile Originated Data retrieval | 16.3.0 | +| 2020-06 | CT#88-e | CP-201048 | 0280 | 1 | B | N5GC device Authentication | 16.3.0 | +| 2020-06 | CT#88-e | CP-201033 | 0287 | 1 | B | Support of SMSIoP | 16.3.0 | +| 2020-06 | CT#88-e | CP-201073 | 0290 | | F | 29.505 Rel16 External doc update | 16.3.0 | +| 2020-06 | CT#88-e | CP-201021 | 0279 | 1 | A | Correction of PUT responses | 16.3.0 | +| 2020-09 | CT#89-e | CP-202110 | 0291 | | F | Security for Authentication Subscription Data | 16.4.0 | +| 2020-09 | CT#89-e | CP-202110 | 0294 | | F | Corrections to default responses | 16.4.0 | +| 2020-09 | CT#89-e | CP-202110 | 0295 | | F | Corrections to the Event Group Subscription | 16.4.0 | +| 2020-09 | CT#89-e | CP-202112 | 0297 | 1 | F | Store Broadcast Location Assistance Data | 16.4.0 | +| 2020-09 | CT#89-e | CP-202110 | 0298 | | F | Correct mismatches of definition between table and yaml | 16.4.0 | +| 2020-09 | CT#89-e | CP-202111 | 0299 | | F | Incorrect index type | 16.4.0 | +| 2020-09 | CT#89-e | CP-202096 | 0301 | | F | API version and External doc update | 16.4.0 | +| 2020-09 | CT#89-e | CP-202123 | 0292 | | B | Resource Level Authorization for SubscriptionData | 17.0.0 | +| 2020-09 | CT#89-e | CP-202123 | 0293 | | B | Resource Level Authorization for registrations | 17.0.0 | +| 2020-09 | CT#89-e | CP-202120 | 0300 | | F | API version and External doc update | 17.0.0 | +| 2020-12 | CT#90-e | CP-203048 | 0303 | | A | Data Removal Notification | 17.1.0 | +| 2020-12 | CT#90-e | CP-203039 | 0305 | | A | Retrieval of SUPI from Authentication Data | 17.1.0 | +| 2020-12 | CT#90-e | CP-203048 | 0307 | | A | Retrieve Context Data | 17.1.0 | +| 2020-12 | CT#90-e | CP-203042 | 0309 | 1 | A | 5G VN Groups | 17.1.0 | +| 2020-12 | CT#90-e | CP-203064 | 0310 | | F | Default Notifications | 17.1.0 | +| 2020-12 | CT#90-e | CP-203039 | 0312 | 1 | A | Pattern alignment for ueld in resource URIs | 17.1.0 | +| 2020-12 | CT#90-e | CP-203035 | 0314 | | A | Storage of YAML files in 3GPP Forge | 17.1.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|--------------------------------------------------------------------------------|--------| +| 2020-12 | CT#90-e | CP-203048 | 0316 | | A | Subs-To-Notify Tag Description | 17.1.0 | +| 2020-12 | CT#90-e | CP-203048 | 0318 | | A | Snsai query parameter | 17.1.0 | +| 2020-12 | CT#90-e | CP-203055 | 0320 | | F | External doc update | 17.1.0 | +| 2021-03 | CT#91-e | CP-210021 | 0321 | 1 | F | ContextInfo in AMF SubscriptionInfo | 17.2.0 | +| 2021-03 | CT#91-e | CP-210021 | 0322 | 1 | F | EE Profile Data | 17.2.0 | +| 2021-03 | CT#91-e | CP-210043 | 0324 | | A | Missing requestBody required indication in PUT operations | 17.2.0 | +| 2021-03 | CT#91-e | CP-210021 | 0325 | 1 | F | HSS Group Id | 17.2.0 | +| 2021-03 | CT#91-e | CP-210034 | 0326 | 1 | F | Description field for map data types | 17.2.0 | +| 2021-03 | CT#91-e | CP-210048 | 0328 | 2 | A | Event Subscription Storage for SMF | 17.2.0 | +| 2021-03 | CT#91-e | CP-210021 | 0329 | | F | Response 200 OK for SMSF registration | 17.2.0 | +| 2021-03 | CT#91-e | CP-210026 | 0330 | 1 | B | AKMA Subscription Data | 17.2.0 | +| 2021-03 | CT#91-e | CP-210029 | 0331 | | F | 29.505 Rel-17 External doc update | 17.2.0 | +| 2021-06 | CT#92-e | CP-211028 | 0339 | | F | Resource Structure | 17.3.0 | +| 2021-06 | CT#92-e | CP-211028 | 0345 | | F | Corrections on reference | 17.3.0 | +| 2021-06 | CT#92-e | CP-211028 | 0346 | 1 | F | Corrections on Cardinality | 17.3.0 | +| 2021-06 | CT#92-e | CP-211028 | 0338 | 1 | F | GroupIdentifiers | 17.3.0 | +| 2021-06 | CT#92-e | CP-211028 | 0340 | 1 | F | Response for MWD resource creation | 17.3.0 | +| 2021-06 | CT#92-e | CP-211028 | 0355 | | F | Nested cardinality | 17.3.0 | +| 2021-06 | CT#92-e | CP-211028 | 0358 | | F | Data Types Descriptions | 17.3.0 | +| 2021-06 | CT#92-e | CP-211039 | 0344 | 1 | B | Store ProSe Subscription Data | 17.3.0 | +| 2021-06 | CT#92-e | CP-211045 | 0360 | | F | AmfSubscriptionInfo and SmfSubscriptionInfo creation providing 201 result code | 17.3.0 | +| 2021-06 | CT#92-e | CP-211050 | 0361 | | F | 29.505 Rel-17 External doc update | 17.3.0 | +| 2021-06 | CT#92-e | CP-211054 | 0341 | 3 | B | API Extension of PP service for Multiple AFs | 17.3.0 | +| 2021-06 | CT#92-e | CP-211064 | 0334 | | A | Event subscription Storage for HSS | 17.3.0 | +| 2021-06 | CT#92-e | CP-211065 | 0343 | | A | UPU and SOR negative ack | 17.3.0 | +| 2021-06 | CT#92-e | CP-211065 | 0357 | 1 | A | Monitored Resource URI | 17.3.0 | +| 2021-06 | CT#92-e | CP-211067 | 0337 | | A | References | 17.3.0 | +| 2021-06 | CT#92-e | CP-211079 | 0354 | | A | Subscribed PP profile data | 17.3.0 | +| 2021-06 | CT#92-e | CP-211079 | 0350 | 1 | A | Subscribed EE profile data for a group | 17.3.0 | +| 2021-06 | CT#92-e | CP-211079 | 0352 | 1 | A | Subscribed PP profile data for 5g-VN-group | 17.3.0 | +| 2021-09 | CT#93-e | CP-212026 | 0364 | | F | ContextInfo storage | 17.4.0 | +| 2021-09 | CT#93-e | CP-212026 | 0368 | | B | Authorization of Identifier Translation | 17.4.0 | +| 2021-09 | CT#93-e | CP-212026 | 0370 | | F | MTC Provider and Application ID in NIDD Authorization Data Retrieval | 17.4.0 | +| 2021-09 | CT#93-e | CP-212026 | 0375 | | F | ContextInfo in SmfSubscriptionInfo and HssSubscriptionInfo | 17.4.0 | +| 2021-09 | CT#93-e | CP-212026 | 0363 | 1 | F | Application Port ID | 17.4.0 | +| 2021-09 | CT#93-e | CP-212026 | 0367 | 1 | B | Retrieval of odbData as ProvisionedDataSet | 17.4.0 | +| 2021-09 | CT#93-e | CP-212026 | 0369 | 1 | B | Authorization of Group Identifier Translation | 17.4.0 | +| 2021-09 | CT#93-e | CP-212026 | 0371 | 1 | F | Allow changing NIDD Authorization data | 17.4.0 | +| 2021-09 | CT#93-e | CP-212026 | 0372 | 1 | F | NIDD Authorization data storage | 17.4.0 | +| 2021-09 | CT#93-e | CP-212026 | 0374 | 1 | B | Batch Fetching of Service Profiles | 17.4.0 | +| 2021-09 | CT#93-e | CP-212026 | 0377 | 1 | F | HssSubscriptionInfo creation providing 201 result code | 17.4.0 | +| 2021-09 | CT#93-e | CP-212026 | 0379 | 1 | F | Corrections on ProvisionedParameterDataEntry | 17.4.0 | +| 2021-09 | CT#93-e | CP-212049 | 0380 | 1 | B | Get the PP data of multiple AFs | 17.4.0 | +| 2021-09 | CT#93-e | CP-212049 | 0381 | 1 | B | Get the specific EE data | 17.4.0 | +| 2021-09 | CT#93-e | CP-212056 | 0373 | | F | EE profile of the EPC Domain for a group | 17.4.0 | +| 2021-09 | CT#93-e | CP-212059 | 0384 | | F | 29.505 Rel-17 External doc update | 17.4.0 | +| 2021-09 | CT#93-e | CP-212063 | 0366 | | A | SDM subscription Storage for HSS | 17.4.0 | +| 2021-09 | CT#93-e | CP-212064 | 0387 | 1 | A | SharedDataId Resource | 17.4.0 | +| 2021-12 | CT#94-e | CP-213085 | 0390 | | F | Error responses to the modification of SubscriptionDataSubscription | 17.5.0 | +| 2021-12 | CT#94-e | CP-213085 | 0398 | | F | Shared Session Management Subscription Data | 17.5.0 | +| 2021-12 | CT#94-e | CP-213085 | 0395 | 1 | B | Update of SMF Registration | 17.5.0 | +| 2021-12 | CT#94-e | CP-213085 | 0389 | 1 | F | Correction of the response to modification of SubscriptionDataSubscription | 17.5.0 | +| 2021-12 | CT#94-e | CP-213086 | 0397 | 1 | B | UE Subscription Data Sets Retrieve | 17.5.0 | +| 2021-12 | CT#94-e | CP-213086 | 0399 | | F | Alignment of GET response data type | 17.5.0 | +| 2021-12 | CT#94-e | CP-213086 | 0405 | | B | Missing operations on Operator Specific Data resource | 17.5.0 | +| 2021-12 | CT#94-e | CP-213087 | 0408 | | B | Update Roaming Status in EPC | 17.5.0 | +| 2021-12 | CT#94-e | CP-213088 | 0403 | 1 | A | Naming Convention | 17.5.0 | +| 2021-12 | CT#94-e | CP-213093 | 0396 | | F | ECS Address Configuration | 17.5.0 | +| 2021-12 | CT#94-e | CP-213093 | 0391 | 3 | B | Support for Service Specific Authorization | 17.5.0 | +| 2021-12 | CT#94-e | CP-213097 | 0388 | 1 | B | 5MBS Subscription Data | 17.5.0 | +| 2021-12 | CT#94-e | CP-213106 | 0406 | 1 | B | SOR-CMCI support | 17.5.0 | +| 2021-12 | CT#94-e | CP-213107 | 0407 | 1 | B | Routing Indicator | 17.5.0 | +| 2021-12 | CT#94-e | CP-213121 | 0409 | | F | 29.505 Rel-17 External doc update | 17.5.0 | +| 2022-03 | CT#95-e | CP-220023 | 0414 | | F | Operator-Specific Data | 17.6.0 | +| 2022-03 | CT#95-e | CP-220023 | 0415 | | F | Style corrections and missing clauses | 17.6.0 | +| 2022-03 | CT#95-e | CP-220023 | 0417 | 1 | F | Update on missing roaming information | 17.6.0 | +| 2022-03 | CT#95-e | CP-220024 | 0413 | 1 | B | Group Subscription Storage | 17.6.0 | +| 2022-03 | CT#95-e | CP-220026 | 0419 | | A | Missing path parameter | 17.6.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|-------------------------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95-e | CP-220026 | 0423 | 1 | A | Chapter and OperationId Updates | 17.6.0 | +| 2022-03 | CT#95-e | CP-220026 | 0424 | 1 | A | One SDM Subscription | 17.6.0 | +| 2022-03 | CT#95-e | CP-220031 | 0421 | | F | serviceType naming convention | 17.6.0 | +| 2022-03 | CT#95-e | CP-220035 | 0425 | | B | 5MBS Subscription Data Storage | 17.6.0 | +| 2022-03 | CT#95-e | CP-220047 | 0400 | 2 | F | UDM retrieving SNPN info | 17.6.0 | +| 2022-03 | CT#95-e | CP-220047 | 0426 | 1 | B | EAP-TTLS support in SNPN (TS 29.505) | 17.6.0 | +| 2022-03 | CT#95-e | CP-220049 | 0416 | 1 | B | User Consent subscription | 17.6.0 | +| 2022-03 | CT#95-e | CP-220066 | 0428 | | F | 29.505 Rel-17 External doc update | 17.6.0 | +| 2022-06 | CT#96-e | CP-221025 | 0431 | | F | resetId assignment to OperatorSpecificDataContainer in UDR consumer (PCF) | 17.7.0 | +| 2022-06 | CT#96-e | CP-221027 | 0430 | | F | Support for arrays in Operator Specific Data | 17.7.0 | +| 2022-06 | CT#96-e | CP-221029 | 0435 | 1 | F | RoamingInfo Correction | 17.7.0 | +| 2022-06 | CT#96-e | CP-221029 | 0434 | 1 | F | Subscribable Resources and Notifications to Store and Collection resources | 17.7.0 | +| 2022-06 | CT#96-e | CP-221029 | 0433 | 1 | F | EE-Subscription retrieval optimization | 17.7.0 | +| 2022-06 | CT#96-e | CP-221051 | 0436 | | F | 29.505 Rel-17 External doc update | 17.7.0 | +| 2022-09 | CT#97-e | CP-222026 | 0437 | | F | CR implementation error | 17.8.0 | +| 2022-09 | CT#97-e | CP-222026 | 0438 | | F | Allow empty array in 200 OK | 17.8.0 | +| 2022-09 | CT#97-e | CP-222026 | 0441 | | F | ValidityTime in AuthorizationData | 17.8.0 | +| 2022-09 | CT#97-e | CP-222057 | 0445 | | F | PEI Information | 17.8.0 | +| 2022-09 | CT#97-e | CP-222057 | 0446 | 1 | F | Roaming Information Correction | 17.8.0 | +| 2022-09 | CT#97-e | CP-222058 | 0447 | | F | 29.505 Rel-17 External doc update | 17.8.0 | +| 2022-09 | CT#97-e | CP-222059 | 0443 | | A | Corrections on the Cardinality of map(5GVnGroupConfiguration) | 17.8.0 | +| 2022-12 | CT#98-e | CP-223027 | 0449 | | F | URI parameter alignment with yaml definitions | 18.0.0 | +| 2022-12 | CT#98-e | CP-223027 | 0453 | | F | Correction on Internal Group Id creation | 18.0.0 | +| 2022-12 | CT#98-e | CP-223029 | 0450 | 1 | F | Cardinality of SmfRegList alignment with yaml | 18.0.0 | +| 2022-12 | CT#98-e | CP-223029 | 0451 | 1 | B | Immediate Report | 18.0.0 | +| 2022-12 | CT#98-e | CP-223033 | 0454 | | F | 29.505 Rel-18 External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230029 | 0457 | | F | Missing Mandatory Status Codes in OpenAPI | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0458 | | B | Retrieval of Provisioned data and Context data with a single GET request | 18.1.0 | +| 2023-03 | CT#99 | CP-230042 | 0456 | 1 | B | Time Sync Subscription Data | 18.1.0 | +| 2023-03 | CT#99 | CP-230071 | 0460 | | F | 29.505 Rel-18 External doc update | 18.1.0 | +| 2023-06 | CT#100 | CP-231025 | 0462 | | F | Adjacent PLMN-ID query param | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 0463 | | F | Multiple data sets retrieval with PP_Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 0465 | | B | Retrieval of UE Update Confirmation Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 0467 | | F | InternalGroupIdIdentifier in 5GVnGroupConfiguration | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 0468 | | F | 5GVnGroup consistency | 18.2.0 | +| 2023-06 | CT#100 | CP-231026 | 0469 | | B | Additional data in notifications | 18.2.0 | +| 2023-06 | CT#100 | CP-231027 | 0461 | 1 | F | Multiple data sets retrieval with query parameters | 18.2.0 | +| 2023-06 | CT#100 | CP-231027 | 0464 | 1 | F | Shared Trace Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231029 | 0473 | 1 | B | Multiple Data Set retrieval with Etags | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0466 | 1 | B | Storage and Retrieval of LCS Subscription Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231052 | 0474 | 1 | B | Ranging Sidelink Positioning Subscription data | 18.2.0 | +| 2023-06 | CT#100 | CP-231070 | 0475 | | F | 29.505 Rel-18 External doc update | 18.2.0 | +| 2023-06 | CT#100 | CP-231076 | 0472 | 2 | A | Update on Multicast MBS group membership management parameters | 18.2.0 | +| 2023-09 | CT#101 | CP-232033 | 0478 | | B | SMF registration stale check | 18.3.0 | +| 2023-09 | CT#101 | CP-232046 | 0481 | 1 | B | Subscription data for A2X | 18.3.0 | +| 2023-09 | CT#101 | CP-232060 | 0484 | | F | 29.505 Rel-18 External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233029 | 0485 | 1 | B | HTTP RFCs obsoleted by IETF RFC 9110 and 9111 | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0489 | 1 | F | Editorial Correction | 18.4.0 | +| 2023-12 | CT#102 | CP-233049 | 0486 | 4 | B | Adding Subscription Data for the "ME Support of SOR-SNPN-SI" and "ME Support of SOR-SNPN-SI-LS" | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 0490 | | F | 29.505 Rel-18 External doc update | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29508/26d664119ad25250780f554633444e54_img.jpg b/raw/rel-18/29_series/29508/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..21d5bf85413f44d45085f8bc228162fada32ac0d --- /dev/null +++ b/raw/rel-18/29_series/29508/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:64f1107cb842920f0eef30c1b5036025a4aab6d78be455bf7eb36e6b6a2f026b +size 16862 diff --git a/raw/rel-18/29_series/29508/5a24ac755b962fd5f0183f13de0726de_img.jpg b/raw/rel-18/29_series/29508/5a24ac755b962fd5f0183f13de0726de_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f3e751f99eb7d609943daaecab5abfa7c71e3a18 --- /dev/null +++ b/raw/rel-18/29_series/29508/5a24ac755b962fd5f0183f13de0726de_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c5cbec679f9e1ba5c9bff75adc176e323479f494a430e14300f20e8ecbf0aa6c +size 29202 diff --git a/raw/rel-18/29_series/29508/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29508/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4de7dd97b9337b3aaf072e746405ad520d5d45de --- /dev/null +++ b/raw/rel-18/29_series/29508/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b42d116d8c2d814c86377d52a84e0f5d4ef04fd6b66457e5edf7e3dd2ea4cb7 +size 9370 diff --git a/raw/rel-18/29_series/29508/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29508/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bfa0d229082ecb7f2e23102ee7673d2a2cf03c76 --- /dev/null +++ b/raw/rel-18/29_series/29508/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ccb776af0de14b4c8128e6942a0e4c9865e7e854af32e2934cb82ad5032d68eb +size 5342 diff --git a/raw/rel-18/29_series/29508/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg b/raw/rel-18/29_series/29508/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..29507d6e81e7a2b27556e763f8cb6107fc2ad31a --- /dev/null +++ b/raw/rel-18/29_series/29508/7d3d5fb5d09c0cd35a9d637be241651e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:446c636e8405a610d80f5ba95b14fe8ef7e7a1935612715f99ae87357c09bf67 +size 31821 diff --git a/raw/rel-18/29_series/29508/7f17c430b9598e4d748a8041457810b3_img.jpg b/raw/rel-18/29_series/29508/7f17c430b9598e4d748a8041457810b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..29ad9784641196589b33bd9c649c251d505bc943 --- /dev/null +++ b/raw/rel-18/29_series/29508/7f17c430b9598e4d748a8041457810b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:40b8690a16166e581db0b48d8c3cfc553e9183a6ec554b19fd78dca3b7450d92 +size 30970 diff --git a/raw/rel-18/29_series/29508/90ee16ccc0ad16aeca48087797d7b07f_img.jpg b/raw/rel-18/29_series/29508/90ee16ccc0ad16aeca48087797d7b07f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fffefb2bdb231939e8b77c84db985fdee2793707 --- /dev/null +++ b/raw/rel-18/29_series/29508/90ee16ccc0ad16aeca48087797d7b07f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9e9a7e085f6d8fd794b8de54874272eeb667111051d66856b6f647f7a0aab9f2 +size 28805 diff --git a/raw/rel-18/29_series/29508/a51105b2031bad93b818b82f071c6add_img.jpg b/raw/rel-18/29_series/29508/a51105b2031bad93b818b82f071c6add_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..327137103273d38f9267ba523bdb1d7afc4e5e30 --- /dev/null +++ b/raw/rel-18/29_series/29508/a51105b2031bad93b818b82f071c6add_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3470e53bd1cd0a97c04c5cce7e31e4e70fefc95da0857faadc4d5b6b1039dc56 +size 23288 diff --git a/raw/rel-18/29_series/29508/e6df2733626a85205c1db682e6259c46_img.jpg b/raw/rel-18/29_series/29508/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0a573a9207f05a98ef1390a8c4a33b8fdd6f0374 --- /dev/null +++ b/raw/rel-18/29_series/29508/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5f546ac00fdb0e007ee0c0c740b6070bc7c99731e6bf489c5211eed58d897d5b +size 31908 diff --git a/raw/rel-18/29_series/29508/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/raw/rel-18/29_series/29508/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..331eedddd860cd61293be75323eb106d97d5c1fb --- /dev/null +++ b/raw/rel-18/29_series/29508/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6c76d83bf844be219018c97094d637f2c77830e84957c4b78373ee11514ca247 +size 28701 diff --git a/raw/rel-18/29_series/29512/096a620f7a0b1b639a9da9618c1a3801_img.jpg b/raw/rel-18/29_series/29512/096a620f7a0b1b639a9da9618c1a3801_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e3bc155800eeb756c471f78fa99f4a769dbb0e22 --- /dev/null +++ b/raw/rel-18/29_series/29512/096a620f7a0b1b639a9da9618c1a3801_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:155e8f61af355a23630b8c014e65f5889d43580c19b1a6163be75950a0a517d7 +size 6389 diff --git a/raw/rel-18/29_series/29512/18291be12b470a557e8c9f3a74e021be_img.jpg b/raw/rel-18/29_series/29512/18291be12b470a557e8c9f3a74e021be_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8319951b21282bd495d98aa1cd7fd17669872303 --- /dev/null +++ b/raw/rel-18/29_series/29512/18291be12b470a557e8c9f3a74e021be_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e264b84d2e1b47d4bbfb95cf36bada48ef57e958227ac24f2dca3e2254c9f1c7 +size 27092 diff --git a/raw/rel-18/29_series/29512/18d7d8de298d79e7bc87af5217f11203_img.jpg b/raw/rel-18/29_series/29512/18d7d8de298d79e7bc87af5217f11203_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..39708f7deba1a9b90e701e9ee52f51eb2c13d717 --- /dev/null +++ b/raw/rel-18/29_series/29512/18d7d8de298d79e7bc87af5217f11203_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b6373bff39367a6528d5bd71ebb7529c684d750946163196b1327cb6ab50dcfe +size 26325 diff --git a/raw/rel-18/29_series/29512/1c9a5a80a4ed18fdfda1c8ae915966bf_img.jpg b/raw/rel-18/29_series/29512/1c9a5a80a4ed18fdfda1c8ae915966bf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0c702b462de9e0256e1182a763b2368819959e11 --- /dev/null +++ b/raw/rel-18/29_series/29512/1c9a5a80a4ed18fdfda1c8ae915966bf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bccf5c62c34c25582c76d74b9a572fffadaaf86c87611b4b0b5b517c716cf129 +size 21288 diff --git a/raw/rel-18/29_series/29512/376f80eb8a41369e87da63a0210d173e_img.jpg b/raw/rel-18/29_series/29512/376f80eb8a41369e87da63a0210d173e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6059312e2588ae991819e1ed94befab742159565 --- /dev/null +++ b/raw/rel-18/29_series/29512/376f80eb8a41369e87da63a0210d173e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cd294a929ad29b86aeea139b323c4f1bb9f517930067b3d6932df3bed0c2f862 +size 28304 diff --git a/raw/rel-18/29_series/29512/51db757d054ce1ce83c436a3578b56ca_img.jpg b/raw/rel-18/29_series/29512/51db757d054ce1ce83c436a3578b56ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..41875eb026402fb012d5726b0d42c0be930490b5 --- /dev/null +++ b/raw/rel-18/29_series/29512/51db757d054ce1ce83c436a3578b56ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:733575f7eb4ea4084249a06a76cc264dd0482d8ada45c2f9cd6901f379de83d8 +size 5503 diff --git a/raw/rel-18/29_series/29512/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29512/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1f0de36ddd236f46ef93b9aaeab3a2e72c8b62c0 --- /dev/null +++ b/raw/rel-18/29_series/29512/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f0a189a1ea4c41df0b8d5c9c3fd8648a2ddefe5783f306101e1483e724345824 +size 9534 diff --git a/raw/rel-18/29_series/29512/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29512/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e4a391c17b63ccda67c3e9e1919a5dc8b14b7314 --- /dev/null +++ b/raw/rel-18/29_series/29512/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:64b34a5c1fd03af687e6fff6a36c1ccccae9728bd722d0e99824804ed1f7ca8f +size 6050 diff --git a/raw/rel-18/29_series/29512/67d03c9e89620d73e3786c869e559752_img.jpg b/raw/rel-18/29_series/29512/67d03c9e89620d73e3786c869e559752_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f2a11488c3eb8cd2884198ec3d828a559809188b --- /dev/null +++ b/raw/rel-18/29_series/29512/67d03c9e89620d73e3786c869e559752_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:14eae2b48c66427e15ea2417e5c69e1dcfd2c6a6092b97be1ae1e4ef3e950a46 +size 26843 diff --git a/raw/rel-18/29_series/29512/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg b/raw/rel-18/29_series/29512/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2ed961f302a2d025b72020f5780b49df3ca9b11e --- /dev/null +++ b/raw/rel-18/29_series/29512/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b42afa30aed6766cfdfeaaf3648a87dc9d7f69adbdbd77c894e547ab9792c72a +size 9867 diff --git a/raw/rel-18/29_series/29512/bf9abec3605f1a8d00ae6524a9af02ed_img.jpg b/raw/rel-18/29_series/29512/bf9abec3605f1a8d00ae6524a9af02ed_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..471b0d64d3dbe03277f2bb860ab16784aa606223 --- /dev/null +++ b/raw/rel-18/29_series/29512/bf9abec3605f1a8d00ae6524a9af02ed_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dcac69e558bfc121b3e806cee86944ba2a5a90e4b870c069a123f0304cd811db +size 10168 diff --git a/raw/rel-18/29_series/29512/cd0f8f598fb2fa15165967e75378f42a_img.jpg b/raw/rel-18/29_series/29512/cd0f8f598fb2fa15165967e75378f42a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ff9cec83d2735877994d44cacece6bb5e8fc8f31 --- /dev/null +++ b/raw/rel-18/29_series/29512/cd0f8f598fb2fa15165967e75378f42a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9a5679ecd9507d1cb416feac3b5d5e12a2cdfe61ae158d622114269f240c3aa +size 33981 diff --git a/raw/rel-18/29_series/29513/053f1077d592e6622cd21dc4bb4cb366_img.jpg b/raw/rel-18/29_series/29513/053f1077d592e6622cd21dc4bb4cb366_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b6a6ffd77255b3a57ace3fc2322c54a4cb5c1064 --- /dev/null +++ b/raw/rel-18/29_series/29513/053f1077d592e6622cd21dc4bb4cb366_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2a00879e4b51c022048e0f3ee0e613516fd2795a1332344acb1f04331886c0ed +size 73978 diff --git a/raw/rel-18/29_series/29513/09955ff8214ffb6947951fc0f60eb6ab_img.jpg b/raw/rel-18/29_series/29513/09955ff8214ffb6947951fc0f60eb6ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..49bdf08bee03fe53eed83ea9e05b10149009ed00 --- /dev/null +++ b/raw/rel-18/29_series/29513/09955ff8214ffb6947951fc0f60eb6ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6cc8326c999fae61809b106b34bacfa43cfd94757320a2798eec9b45893cc153 +size 119884 diff --git a/raw/rel-18/29_series/29513/10781f43062bf3e9601a1e086710556c_img.jpg b/raw/rel-18/29_series/29513/10781f43062bf3e9601a1e086710556c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e20fdc2a5c249939b4caf53ab13374d99b267434 --- /dev/null +++ b/raw/rel-18/29_series/29513/10781f43062bf3e9601a1e086710556c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:846877a762400531d8be9e79038c2b281ab8448e3bdf87771aa11b0d48f87cbb +size 93443 diff --git a/raw/rel-18/29_series/29513/1174e0fd3f2c73de8e5c6ce8ea6bdda1_img.jpg b/raw/rel-18/29_series/29513/1174e0fd3f2c73de8e5c6ce8ea6bdda1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ba54b01e4f40c1f32ce86bf0e34622390a54cdcc --- /dev/null +++ b/raw/rel-18/29_series/29513/1174e0fd3f2c73de8e5c6ce8ea6bdda1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e3d0904823edd012addd7cf3d9009ff806000d19a0f7f52aecfb1fdda6dea010 +size 16340 diff --git a/raw/rel-18/29_series/29513/16152cf1d84aea10848758f51a91ff6a_img.jpg b/raw/rel-18/29_series/29513/16152cf1d84aea10848758f51a91ff6a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f2b60379110e2f832413278657aa3faf016a7b9d --- /dev/null +++ b/raw/rel-18/29_series/29513/16152cf1d84aea10848758f51a91ff6a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a381ad787455c1b6e394b87732d58e0fb916609180f617802d35a9d19b64b8a4 +size 154065 diff --git a/raw/rel-18/29_series/29513/163688ca8da9787f5d48edd68d8cc75b_img.jpg b/raw/rel-18/29_series/29513/163688ca8da9787f5d48edd68d8cc75b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a69f28fe2f159c6a7e2949fff661d830bcebb17a --- /dev/null +++ b/raw/rel-18/29_series/29513/163688ca8da9787f5d48edd68d8cc75b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0f51fc1791a4f790a8ce879e25c981fac81973e6b7f3cdfc170e92c86fcf1f4c +size 20404 diff --git a/raw/rel-18/29_series/29513/21ad58fee90f2be50708ff541d225507_img.jpg b/raw/rel-18/29_series/29513/21ad58fee90f2be50708ff541d225507_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5dcdb0b32eace3f70ca6502b7a636ba7280ab95f --- /dev/null +++ b/raw/rel-18/29_series/29513/21ad58fee90f2be50708ff541d225507_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:06dfb200002e1210d0f3f4052a4557d68ce73bdcb4580e58be2ffa2f6c5a393b +size 147412 diff --git a/raw/rel-18/29_series/29513/22b2fd4b8672ad8b02cf6cd4de5809cd_img.jpg b/raw/rel-18/29_series/29513/22b2fd4b8672ad8b02cf6cd4de5809cd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6239e145051fe76d8ad17789cd08df4703a99daa --- /dev/null +++ b/raw/rel-18/29_series/29513/22b2fd4b8672ad8b02cf6cd4de5809cd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a03d856c20f79039294fa2b10955d7c29b99908003fa55089a25ee18afa6de65 +size 20197 diff --git a/raw/rel-18/29_series/29513/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/raw/rel-18/29_series/29513/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ef8763b82adb9561cb114f186184bee0a6595e24 --- /dev/null +++ b/raw/rel-18/29_series/29513/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:73079d615683fea36b83d9bf26bc3f35b295a67c13da8582cf2416802e88712e +size 29015 diff --git a/raw/rel-18/29_series/29513/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg b/raw/rel-18/29_series/29513/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..20445c14dc2ed8924c386b506c16df55f17c0e00 --- /dev/null +++ b/raw/rel-18/29_series/29513/3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85c6ea27c241de9357efc40017c307cbc686979d998f1a998e3cf809372a5907 +size 83379 diff --git a/raw/rel-18/29_series/29513/4792a2ccd62226861fadc22117edb7b1_img.jpg b/raw/rel-18/29_series/29513/4792a2ccd62226861fadc22117edb7b1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a980bfa43faaa010c25fe3ee1a842dad80271876 --- /dev/null +++ b/raw/rel-18/29_series/29513/4792a2ccd62226861fadc22117edb7b1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f598e3bab0971c0e680c6ee6b5d8d3b4a5ef900731ff4c1e619215e46bced9b1 +size 158663 diff --git a/raw/rel-18/29_series/29513/53f1f7d17b3e7aae62169c41d2a88a77_img.jpg b/raw/rel-18/29_series/29513/53f1f7d17b3e7aae62169c41d2a88a77_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1b968db0c83ef4a02e3ed4cec22766418329d510 --- /dev/null +++ b/raw/rel-18/29_series/29513/53f1f7d17b3e7aae62169c41d2a88a77_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e8559a0389a5ec80712975c08487e6753191ff68e0323b1f15e50390855b8a77 +size 164193 diff --git a/raw/rel-18/29_series/29513/573c8f9e728e343b6864e1070c14b8cf_img.jpg b/raw/rel-18/29_series/29513/573c8f9e728e343b6864e1070c14b8cf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b6e28532311ba1d61b81ca09382cdc8c80c325ce --- /dev/null +++ b/raw/rel-18/29_series/29513/573c8f9e728e343b6864e1070c14b8cf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:214624257f53a0a5020df8dedcc645a2bc3d9cc8be2e2fee73335699e34c934b +size 19510 diff --git a/raw/rel-18/29_series/29513/6324b252294c0f5d4e34dad4a1202075_img.jpg b/raw/rel-18/29_series/29513/6324b252294c0f5d4e34dad4a1202075_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4634c718a953860849918f7d03215e7a98ba7943 --- /dev/null +++ b/raw/rel-18/29_series/29513/6324b252294c0f5d4e34dad4a1202075_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:29c408a79ef915216b82d42514b256485e4e8196d0c0703fed5c7bc54cde85e9 +size 16497 diff --git a/raw/rel-18/29_series/29513/78ffccd66df9bafd96e3e081110d09dd_img.jpg b/raw/rel-18/29_series/29513/78ffccd66df9bafd96e3e081110d09dd_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..14fd1e13d38df3e1cc2452d018e706fca2702892 --- /dev/null +++ b/raw/rel-18/29_series/29513/78ffccd66df9bafd96e3e081110d09dd_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae3410b50fbb99c5a528e54de611465e6bfdca33e5ecf50957c584a7e57c45ee +size 69634 diff --git a/raw/rel-18/29_series/29513/79e1709a7317ead45379cbb8ff3ba802_img.jpg b/raw/rel-18/29_series/29513/79e1709a7317ead45379cbb8ff3ba802_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dee6944dbe768ad384eefff98f7b1fe21b54ef37 --- /dev/null +++ b/raw/rel-18/29_series/29513/79e1709a7317ead45379cbb8ff3ba802_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:85c1814e66bda08e1c0f20e6443cd2af9a66ceede7117496ba0eae3e3c1931de +size 181828 diff --git a/raw/rel-18/29_series/29513/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/raw/rel-18/29_series/29513/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..853513933b8d160ae7697108972241b986c969ac --- /dev/null +++ b/raw/rel-18/29_series/29513/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:00c1a49a84a386a0de7e331a0178a964ee6d635fe9529091768754bd1cb44455 +size 91622 diff --git a/raw/rel-18/29_series/29513/868ef3e0abb37916a7af1e923995f329_img.jpg b/raw/rel-18/29_series/29513/868ef3e0abb37916a7af1e923995f329_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a2770733af66564b238879cb0f5894ae54cb2240 --- /dev/null +++ b/raw/rel-18/29_series/29513/868ef3e0abb37916a7af1e923995f329_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:17781514ef1adf36649a60bb2d9a44271776e5395daa9de19c3506406dc1629e +size 21538 diff --git a/raw/rel-18/29_series/29513/8fa679f79a1bb1f527cba9f29e784e89_img.jpg b/raw/rel-18/29_series/29513/8fa679f79a1bb1f527cba9f29e784e89_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d0319743fc1752fb55be5407c69363745f4e6d80 --- /dev/null +++ b/raw/rel-18/29_series/29513/8fa679f79a1bb1f527cba9f29e784e89_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c0247f93f00b3fe80e4569a58f4b7edc3da6cb1767f96142d4067b2a66bf7e80 +size 86522 diff --git a/raw/rel-18/29_series/29513/9791722d75115ddcc599b07d7bc35d73_img.jpg b/raw/rel-18/29_series/29513/9791722d75115ddcc599b07d7bc35d73_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aea2d744616e82bfe4b91100bd01c7581cb4fb0c --- /dev/null +++ b/raw/rel-18/29_series/29513/9791722d75115ddcc599b07d7bc35d73_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e8155f0c4bca89428039a996fe416064006b82473732ecbd778f5458edef488c +size 45969 diff --git a/raw/rel-18/29_series/29513/9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg b/raw/rel-18/29_series/29513/9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2005db27ce0d423d5cabb94b042139be54a6fd8c --- /dev/null +++ b/raw/rel-18/29_series/29513/9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e19e93c497c7dc7ad81bee1f400e33b47337113cf9eb11f3267be3ba2942f315 +size 58401 diff --git a/raw/rel-18/29_series/29513/a3472689858b068ef469213682965325_img.jpg b/raw/rel-18/29_series/29513/a3472689858b068ef469213682965325_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b53460c629d28b00d78cfdbc58abbf94920aafb --- /dev/null +++ b/raw/rel-18/29_series/29513/a3472689858b068ef469213682965325_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:52a4041f70146671f97030705bc85e71e5bd6d672d5ff9d5f0587f96b0a7a410 +size 60640 diff --git a/raw/rel-18/29_series/29513/aa81b9b80bd1e3d723922b3a033564a2_img.jpg b/raw/rel-18/29_series/29513/aa81b9b80bd1e3d723922b3a033564a2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..95d47e8403b22c312ebef0cf2255454044a08f46 --- /dev/null +++ b/raw/rel-18/29_series/29513/aa81b9b80bd1e3d723922b3a033564a2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1b55e276aadb26d354fed32a74b7e62aefceaa6b37cde34aeef3aad1611ae94d +size 185822 diff --git a/raw/rel-18/29_series/29513/bd671b21db63e6fdb2196e9b18502aac_img.jpg b/raw/rel-18/29_series/29513/bd671b21db63e6fdb2196e9b18502aac_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c8534e1f08d2e2da2b689f1850b6585c24de1c54 --- /dev/null +++ b/raw/rel-18/29_series/29513/bd671b21db63e6fdb2196e9b18502aac_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c3d2e434d50cb5f2a1f4ba4fdf9226818606295c85457cd93f1b42a06f125e2f +size 83182 diff --git a/raw/rel-18/29_series/29513/c78c2eefd86269d1740ab85a916f24f2_img.jpg b/raw/rel-18/29_series/29513/c78c2eefd86269d1740ab85a916f24f2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..da141d8eba403cf23331c9e182585b86b0d12db4 --- /dev/null +++ b/raw/rel-18/29_series/29513/c78c2eefd86269d1740ab85a916f24f2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:467dc6cb068e30e0efd5523ecce436f38f8a48cf63b8e31ee7ff5aba011aa53d +size 95143 diff --git a/raw/rel-18/29_series/29513/cab0834804fb031b43865554cc8d06ab_img.jpg b/raw/rel-18/29_series/29513/cab0834804fb031b43865554cc8d06ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4a1e6aa36296be566f82883f3da1e2c7ecefcb9f --- /dev/null +++ b/raw/rel-18/29_series/29513/cab0834804fb031b43865554cc8d06ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c872d555f89b114806106a79ab493d5294f7d4b522feb0668d8320d7a6ff51a5 +size 51929 diff --git a/raw/rel-18/29_series/29513/cd141897aa368dbbaa398ace230cdd85_img.jpg b/raw/rel-18/29_series/29513/cd141897aa368dbbaa398ace230cdd85_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e79bbc245f5ed4ddce26ffca505e808154d05bbb --- /dev/null +++ b/raw/rel-18/29_series/29513/cd141897aa368dbbaa398ace230cdd85_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:68d9a54ed3ccb2d1c818e9051965015455c3d770e341a98a0e86cc471c39c2be +size 107043 diff --git a/raw/rel-18/29_series/29513/d0abac95583b52a3b35f74a215567334_img.jpg b/raw/rel-18/29_series/29513/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f3cb6b2f2d03b5103e1056e0020084d8ead387d0 --- /dev/null +++ b/raw/rel-18/29_series/29513/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a9088b8a198b46809b6d2548fb0cb87fc9952d8cfab7e65027dc70087966a5fb +size 112543 diff --git a/raw/rel-18/29_series/29513/e6df2733626a85205c1db682e6259c46_img.jpg b/raw/rel-18/29_series/29513/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5332e44166421ae7a26969cfdc57a8595d0e7f4c --- /dev/null +++ b/raw/rel-18/29_series/29513/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:96717a047fd0393ae38009c57b2e7c1568dee6edb7c9243c64ab2e07b2b4139a +size 53276 diff --git a/raw/rel-18/29_series/29513/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/raw/rel-18/29_series/29513/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4bcb9d1d98913a781329c2827fbb1f7a638c70f5 --- /dev/null +++ b/raw/rel-18/29_series/29513/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:29987b915002e5497a9644380352df8a5fa4035ba7da596c5d6c3a613368a8f1 +size 210985 diff --git a/raw/rel-18/29_series/29513/ff0952ef692c9d960ce5f6708bcc9711_img.jpg b/raw/rel-18/29_series/29513/ff0952ef692c9d960ce5f6708bcc9711_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..efb7aa394514b1960f70841ec85871fcb69c7933 --- /dev/null +++ b/raw/rel-18/29_series/29513/ff0952ef692c9d960ce5f6708bcc9711_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b54544470fe58d2df192d99381a191ecb631af74f3a70f9144dc331964f104bb +size 83682 diff --git a/raw/rel-18/29_series/29514/0c5f3d0d14479b9e784d595fecd6dba5_img.jpg b/raw/rel-18/29_series/29514/0c5f3d0d14479b9e784d595fecd6dba5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ab232a9eb86ddc47a9335d7614b77c2c33761f55 --- /dev/null +++ b/raw/rel-18/29_series/29514/0c5f3d0d14479b9e784d595fecd6dba5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:601f9cd52547de9a116c282b124387880647701356ba69533cc0893ad80d6e89 +size 30094 diff --git a/raw/rel-18/29_series/29514/107cbeda15ddd53da92c2f677b441c93_img.jpg b/raw/rel-18/29_series/29514/107cbeda15ddd53da92c2f677b441c93_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e2e30e7dc71f080ee845152d21e650737b25bbb7 --- /dev/null +++ b/raw/rel-18/29_series/29514/107cbeda15ddd53da92c2f677b441c93_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fbe0a57858695884ecaf79924c923523c3e533341334c8cc65d5f67914d04a81 +size 27547 diff --git a/raw/rel-18/29_series/29514/11f18bf0233d812ad2604f88f3385d60_img.jpg b/raw/rel-18/29_series/29514/11f18bf0233d812ad2604f88f3385d60_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8c637f03f2e13d4e83e04ee57d43adac7ea075a3 --- /dev/null +++ b/raw/rel-18/29_series/29514/11f18bf0233d812ad2604f88f3385d60_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a56a29d9f8a39e82762454ec319409c6894826c86f73c06edc8d54f774c94853 +size 34897 diff --git a/raw/rel-18/29_series/29514/33a8f3f01dfa8bce75d23017855a13c5_img.jpg b/raw/rel-18/29_series/29514/33a8f3f01dfa8bce75d23017855a13c5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..39d28828de9f55bffbfd3210c76ff167acc67477 --- /dev/null +++ b/raw/rel-18/29_series/29514/33a8f3f01dfa8bce75d23017855a13c5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b9bf7119fed03dca3956673492bddc2432a3b8f939d4342388d2d720a3421304 +size 19284 diff --git a/raw/rel-18/29_series/29514/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg b/raw/rel-18/29_series/29514/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..daac3debe6234e02d1fc51c040660ab37322d89a --- /dev/null +++ b/raw/rel-18/29_series/29514/4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e5e431212c69dbca99912279ef7ee98d7472c1acfc1dc68d54b27eeb3358c210 +size 27093 diff --git a/raw/rel-18/29_series/29514/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29514/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f05292f7828cf69ee875a85eb0c64ef7288ddf4d --- /dev/null +++ b/raw/rel-18/29_series/29514/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:338cf2ce29350c6b629433f9cd0b0c35025bdc96800b7a0f955b590d768c0890 +size 9324 diff --git a/raw/rel-18/29_series/29514/6231ba981d3d1ab7ce0cae71abd08c17_img.jpg b/raw/rel-18/29_series/29514/6231ba981d3d1ab7ce0cae71abd08c17_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..be4b6418c718dc91145a207ec291f4a0f7ee6071 --- /dev/null +++ b/raw/rel-18/29_series/29514/6231ba981d3d1ab7ce0cae71abd08c17_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6731e00c74c9d15131c494c0b36fb0285f00be3a960bd81f892095859ef98eba +size 30031 diff --git a/raw/rel-18/29_series/29514/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29514/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..165d6b2a32ff675437cf1cd496a43e1671dcadca --- /dev/null +++ b/raw/rel-18/29_series/29514/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a1f8db982a32b56e11f20e3a53415766a194668048f6c29d2c7b8d9c92b45c8a +size 5672 diff --git a/raw/rel-18/29_series/29514/8307f6b04df072c9332f9987e034272c_img.jpg b/raw/rel-18/29_series/29514/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..75077544d2727c5906d812c1dc4e6ac8cbe49ac7 --- /dev/null +++ b/raw/rel-18/29_series/29514/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:838d9b5d72817c9071e4e1a98b465d794f8942aae44d448bd88151a112d57638 +size 23148 diff --git a/raw/rel-18/29_series/29514/8395ccdee8a80af834aca2bdfd7f9a9b_img.jpg b/raw/rel-18/29_series/29514/8395ccdee8a80af834aca2bdfd7f9a9b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..398dfd30a3b1a70ee2b06cfb6d650b7b2978758a --- /dev/null +++ b/raw/rel-18/29_series/29514/8395ccdee8a80af834aca2bdfd7f9a9b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d6f71e666833daa45d3795ffda4420701518aa102d4d4cd8cd122149fe2ad2e7 +size 31124 diff --git a/raw/rel-18/29_series/29514/85e7d6eb95be2fe34f09499ca16536de_img.jpg b/raw/rel-18/29_series/29514/85e7d6eb95be2fe34f09499ca16536de_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fbf4e5a17f3175a62215f1aae7faa0768dc6f6c0 --- /dev/null +++ b/raw/rel-18/29_series/29514/85e7d6eb95be2fe34f09499ca16536de_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b7cffe5e4a007cb561e4572124c6024f46180d22f60128a5228bb0639639d5d4 +size 36321 diff --git a/raw/rel-18/29_series/29514/8d66c9c295023a1380f9986d3663bb1e_img.jpg b/raw/rel-18/29_series/29514/8d66c9c295023a1380f9986d3663bb1e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..19f3f9dc1c6feeed6f1a56093669691900295aca --- /dev/null +++ b/raw/rel-18/29_series/29514/8d66c9c295023a1380f9986d3663bb1e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:afee52d6e233051de54952849ace2b790f64359248b41d9547caa51672ef3c97 +size 30132 diff --git a/raw/rel-18/29_series/29514/ada2aa7cce9cff9cf116d9ae2b8b7c27_img.jpg b/raw/rel-18/29_series/29514/ada2aa7cce9cff9cf116d9ae2b8b7c27_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2114c177e21058460b95bc19de07562afc814853 --- /dev/null +++ b/raw/rel-18/29_series/29514/ada2aa7cce9cff9cf116d9ae2b8b7c27_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e45e2f23460d6fa5e042b4c2385c388c87d142da111f37ab1473cad2c5e8e03b +size 34164 diff --git a/raw/rel-18/29_series/29514/b0666d7acc98c96f24d88c97bbd7cae7_img.jpg b/raw/rel-18/29_series/29514/b0666d7acc98c96f24d88c97bbd7cae7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4ee46afb64f7e8571bfc6bb2c1cfa88747d4cfb6 --- /dev/null +++ b/raw/rel-18/29_series/29514/b0666d7acc98c96f24d88c97bbd7cae7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c50f8e7d777caf2b37a43aace4dcdbfbcc610407c7bf8455de52d73c127a3d92 +size 29516 diff --git a/raw/rel-18/29_series/29514/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg b/raw/rel-18/29_series/29514/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d1c7c2715d8816bd7ed153704d306178c9189e50 --- /dev/null +++ b/raw/rel-18/29_series/29514/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:901db84a24d0fa38e958ec7784d06aa6f05b7729250bdf15f07e0fcb92f68988 +size 29652 diff --git a/raw/rel-18/29_series/29514/da5a8f834706c8119a47c5eb732feabe_img.jpg b/raw/rel-18/29_series/29514/da5a8f834706c8119a47c5eb732feabe_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..38d98e45deae3a63dfcf7e2d74b186c52524e9a8 --- /dev/null +++ b/raw/rel-18/29_series/29514/da5a8f834706c8119a47c5eb732feabe_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:16b34b54fca5282c938351fcbd21ed13a3240fd59826b013ed4b7aaa46ac5f17 +size 38606 diff --git a/raw/rel-18/29_series/29514/f2486d5031b55e42b300903a716b0a00_img.jpg b/raw/rel-18/29_series/29514/f2486d5031b55e42b300903a716b0a00_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..72198d16d7afaee865c181311d99d5f189aada50 --- /dev/null +++ b/raw/rel-18/29_series/29514/f2486d5031b55e42b300903a716b0a00_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a3b3281085e631cf27dd848edbf3714c0fc3ee808f535d5171528bb570e6a39a +size 36689 diff --git a/raw/rel-18/29_series/29515/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg b/raw/rel-18/29_series/29515/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9c87be3652f5362f5aedeb19aeae20110b333be2 --- /dev/null +++ b/raw/rel-18/29_series/29515/16c1175b5f05a4b55e6d396fc51b15b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ed54e54aeb15e6c60e52e1aaff52327d384ab93135c995681cddef7230a554f2 +size 31762 diff --git a/raw/rel-18/29_series/29515/21ad58fee90f2be50708ff541d225507_img.jpg b/raw/rel-18/29_series/29515/21ad58fee90f2be50708ff541d225507_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..825d413f9153ce365aab195bd155bf153b508fa6 --- /dev/null +++ b/raw/rel-18/29_series/29515/21ad58fee90f2be50708ff541d225507_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6306192146faddcc311a311b3204f814fa7d422397fb55eaf0c45b9c3b50c079 +size 39001 diff --git a/raw/rel-18/29_series/29515/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/raw/rel-18/29_series/29515/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aa719a7a9649ae6d91071aee0abedda2b08928e9 --- /dev/null +++ b/raw/rel-18/29_series/29515/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:edf087e6c3fef63ffd415315942188310b851efb064b0cdedad67dff2e94e3c2 +size 25378 diff --git a/raw/rel-18/29_series/29515/4636adff5682a064f0ae5f13a1d464a6_img.jpg b/raw/rel-18/29_series/29515/4636adff5682a064f0ae5f13a1d464a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1dac80e6e82a9b7f6a10631887916a1074d4300c --- /dev/null +++ b/raw/rel-18/29_series/29515/4636adff5682a064f0ae5f13a1d464a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bcee1f7ec4083e7c8753da2fd0b323e746cd5c4ab0439461b6a589924d59b182 +size 30900 diff --git a/raw/rel-18/29_series/29515/5a4e62bead259c258d069fd3663ea670_img.jpg b/raw/rel-18/29_series/29515/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..574796e08eb342a5910efa070d31728aca637809 --- /dev/null +++ b/raw/rel-18/29_series/29515/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bb01f2912d1aa6b8b858798ea7ad94e6521e52ca31e54bcf451b7db4f08cd7d8 +size 32016 diff --git a/raw/rel-18/29_series/29515/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29515/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bb78c9aa892eb3d5961da78b99bc36acda77f428 --- /dev/null +++ b/raw/rel-18/29_series/29515/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9d9ab813191e2b460924019e20079f724b2a6b992843bbe7b8c57e4ea94e260b +size 9572 diff --git a/raw/rel-18/29_series/29515/63e0c22852c26699d0bd095a2d796bab_img.jpg b/raw/rel-18/29_series/29515/63e0c22852c26699d0bd095a2d796bab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..012ababc584efa6aeb05c69da9daf05cb4df932d --- /dev/null +++ b/raw/rel-18/29_series/29515/63e0c22852c26699d0bd095a2d796bab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:72b2ea69f7baf7688d144d9f9d30877de3c210d7439e2cf66b0b85926d37637a +size 29226 diff --git a/raw/rel-18/29_series/29515/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29515/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c9d66ba5008d5ccb0b01c19bdbc34acf27eebab3 --- /dev/null +++ b/raw/rel-18/29_series/29515/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d50ef26c2b02be8a5e320ea71e7bd2eb7462235a9ce61c4027288b88db39ac92 +size 5750 diff --git a/raw/rel-18/29_series/29515/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/raw/rel-18/29_series/29515/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..13033c970e26c00064ef06a7fbd1de5a4137e4d4 --- /dev/null +++ b/raw/rel-18/29_series/29515/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bdc75607839c7108ffe194245230c010ac8a48129badea0b173ba5ab23daa511 +size 30093 diff --git a/raw/rel-18/29_series/29515/d0abac95583b52a3b35f74a215567334_img.jpg b/raw/rel-18/29_series/29515/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4eaaa8a24da37e25ad6597b4ff929872ddae9930 --- /dev/null +++ b/raw/rel-18/29_series/29515/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c6009480a70ab30e928bd1f1d3b9ecb47a7a53f7fa2fad8054835b75086652e7 +size 26002 diff --git a/raw/rel-18/29_series/29515/e4c6fa93821e3546ee9fcae897ae2771_img.jpg b/raw/rel-18/29_series/29515/e4c6fa93821e3546ee9fcae897ae2771_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f6b82bbe88011a322d1b198887b51a90a3f0815b --- /dev/null +++ b/raw/rel-18/29_series/29515/e4c6fa93821e3546ee9fcae897ae2771_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1cc4e99281a0b8e0b323f5c3fde7ea5fe0bfcd9d08d452fa2acc053e94b9e059 +size 31037 diff --git a/raw/rel-18/29_series/29515/e6df2733626a85205c1db682e6259c46_img.jpg b/raw/rel-18/29_series/29515/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1ce045368c93a810e6424075e2df1f73dd83160b --- /dev/null +++ b/raw/rel-18/29_series/29515/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa380a9d73521c7c7ad9b5cc944549eb85a896190fd8d92508354cce1d9c5079 +size 32479 diff --git a/raw/rel-18/29_series/29523/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/raw/rel-18/29_series/29523/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5db38696899680d2d051cf2f686f9c7e3714c777 --- /dev/null +++ b/raw/rel-18/29_series/29523/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f945898fa0dc0cede30aabd006140773ab66b37b9cd4eabeb293dc43ab4751e +size 28409 diff --git a/raw/rel-18/29_series/29523/367926125450c2bc3f4bdca9d59a62ba_img.jpg b/raw/rel-18/29_series/29523/367926125450c2bc3f4bdca9d59a62ba_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8a2769d7cb7392aeaa81102dd5c1734e5e2f9e4c --- /dev/null +++ b/raw/rel-18/29_series/29523/367926125450c2bc3f4bdca9d59a62ba_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:33dd88d7cd9e54af587e72fb3ec8967a0c53855bf2e8021b09577868c2cdf0d1 +size 10660 diff --git a/raw/rel-18/29_series/29523/5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg b/raw/rel-18/29_series/29523/5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b778cb88b68c45eb28783d224f3ca661c52310c2 --- /dev/null +++ b/raw/rel-18/29_series/29523/5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c8273248762ca16348c7a51a6f9a65d2ed29e1807c6cddb2f133873b87320ed6 +size 33161 diff --git a/raw/rel-18/29_series/29523/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29523/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4de7dd97b9337b3aaf072e746405ad520d5d45de --- /dev/null +++ b/raw/rel-18/29_series/29523/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b42d116d8c2d814c86377d52a84e0f5d4ef04fd6b66457e5edf7e3dd2ea4cb7 +size 9370 diff --git a/raw/rel-18/29_series/29523/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29523/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bfa0d229082ecb7f2e23102ee7673d2a2cf03c76 --- /dev/null +++ b/raw/rel-18/29_series/29523/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ccb776af0de14b4c8128e6942a0e4c9865e7e854af32e2934cb82ad5032d68eb +size 5342 diff --git a/raw/rel-18/29_series/29523/7c6d9bfe9c31ce872722d60b73d20df1_img.jpg b/raw/rel-18/29_series/29523/7c6d9bfe9c31ce872722d60b73d20df1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9f9cb6c3786eec496ff185f2d6ac1b223446d637 --- /dev/null +++ b/raw/rel-18/29_series/29523/7c6d9bfe9c31ce872722d60b73d20df1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:53f3da66440a9ffb93de1be378cdc49c155182780760b49699c312c2e159b259 +size 29650 diff --git a/raw/rel-18/29_series/29523/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/raw/rel-18/29_series/29523/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..42c5ad754fb00018e70716d179c26616ac4949ab --- /dev/null +++ b/raw/rel-18/29_series/29523/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8599ab21b386de517141f9e31883abf02b49fad1d1171d5381e5929a29612c7e +size 34586 diff --git a/raw/rel-18/29_series/29523/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/raw/rel-18/29_series/29523/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bb4d40bd7091a087477bd9adb5ae68426eccdee9 --- /dev/null +++ b/raw/rel-18/29_series/29523/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:65da7f28f810d97a8d6bd14ad751a55239d4c47f8fa57f837f22cdb1df9c3569 +size 14147 diff --git a/raw/rel-18/29_series/29523/f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg b/raw/rel-18/29_series/29523/f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e012378b0cda5d709dfdbcd42f51464f292f0200 --- /dev/null +++ b/raw/rel-18/29_series/29523/f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:11e89e30ab81ca7bca20bd5d5d065a207ec7e78a36cf9d5740a828477b7037d6 +size 16361 diff --git a/raw/rel-18/29_series/29524/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29524/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..53477f58a34211509e4867645b8943533630660d --- /dev/null +++ b/raw/rel-18/29_series/29524/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d897a1064980c69166d37c65b4ee5979c75d0e06ede25f81d324ca0236da9f6d +size 9449 diff --git a/raw/rel-18/29_series/29524/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29524/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..143bf48602de6ddc8ab0d6d6023636249ac224eb --- /dev/null +++ b/raw/rel-18/29_series/29524/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:db1b2d41c2717e3d915583e0560d712bd647c1124bf523f156742bbbe20b1629 +size 5702 diff --git a/raw/rel-18/29_series/29525/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/raw/rel-18/29_series/29525/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cc393b3530687d129a49a3340c5e03915f56a984 --- /dev/null +++ b/raw/rel-18/29_series/29525/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1a842458b25e18149e58fd68cb2cb6c5365cbf6e29d6bef26d3ad74f813cd5d5 +size 22696 diff --git a/raw/rel-18/29_series/29525/3f1987804d7d78bc3b3bc560e974280a_img.jpg b/raw/rel-18/29_series/29525/3f1987804d7d78bc3b3bc560e974280a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..55aa3f14f5d0e9a11ec109da20316849ac4e8d2e --- /dev/null +++ b/raw/rel-18/29_series/29525/3f1987804d7d78bc3b3bc560e974280a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1adc42f6d11fabce9fa7be28397310fb7cb4abe53569586e615dfde12f17757c +size 27259 diff --git a/raw/rel-18/29_series/29525/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29525/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..01d955e85ce4b36b12507d7a1aa2af028fb68b3a --- /dev/null +++ b/raw/rel-18/29_series/29525/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e3bb8c49c893cfd5d1b755529afd464d0fca4c4d92fe06ebb419bc9ecc7d432e +size 9482 diff --git a/raw/rel-18/29_series/29525/63a2519518616620ef0e53d98b923c05_img.jpg b/raw/rel-18/29_series/29525/63a2519518616620ef0e53d98b923c05_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f0e290035151a6005941836aaf091abb338a148d --- /dev/null +++ b/raw/rel-18/29_series/29525/63a2519518616620ef0e53d98b923c05_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9ab2af2f6641789e6f0c013c306384ab43faa79e5478bbe434b0d17027b47dc8 +size 32674 diff --git a/raw/rel-18/29_series/29525/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29525/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bfa0d229082ecb7f2e23102ee7673d2a2cf03c76 --- /dev/null +++ b/raw/rel-18/29_series/29525/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ccb776af0de14b4c8128e6942a0e4c9865e7e854af32e2934cb82ad5032d68eb +size 5342 diff --git a/raw/rel-18/29_series/29525/7c6d9bfe9c31ce872722d60b73d20df1_img.jpg b/raw/rel-18/29_series/29525/7c6d9bfe9c31ce872722d60b73d20df1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4e0917b2131e038cbfa6aa41c490472d98f733b5 --- /dev/null +++ b/raw/rel-18/29_series/29525/7c6d9bfe9c31ce872722d60b73d20df1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:459e877cf96c9964d9873ee421815e8f3f90d2a0a77b89d35e07a5fc7d505602 +size 19830 diff --git a/raw/rel-18/29_series/29525/b3c108e7145f2017957569d06ea359cb_img.jpg b/raw/rel-18/29_series/29525/b3c108e7145f2017957569d06ea359cb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e4afbfa70785669b49ee721ba2bd7ce173efbbeb --- /dev/null +++ b/raw/rel-18/29_series/29525/b3c108e7145f2017957569d06ea359cb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e9283afbc5b61d1feeb5084d20daa79e860b29e5e9ece0a9a4efc1b2f188b868 +size 14523 diff --git a/raw/rel-18/29_series/29525/b44f89b176c971c7dd264c07bfef2c2a_img.jpg b/raw/rel-18/29_series/29525/b44f89b176c971c7dd264c07bfef2c2a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..49decd449877df0c73a61962cdacf32590c22347 --- /dev/null +++ b/raw/rel-18/29_series/29525/b44f89b176c971c7dd264c07bfef2c2a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45f3bab14bb145a6c771408a879376931611715e789b55f4bb30eed31ec45bd9 +size 32091 diff --git a/raw/rel-18/29_series/29525/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg b/raw/rel-18/29_series/29525/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6b4ee0bccb37d7c6b1bcbcf93b9a98bb28ab4f08 --- /dev/null +++ b/raw/rel-18/29_series/29525/c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:591cb2de8e6160a1f2f3deaaa9fefc76c9b707d453c1d23a7a7598bda628c834 +size 32458 diff --git a/raw/rel-18/29_series/29525/f324fbc5d5af1e4da9cd932389f0064c_img.jpg b/raw/rel-18/29_series/29525/f324fbc5d5af1e4da9cd932389f0064c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d548dd45b81bb9e258db43d9eeb640c73458c011 --- /dev/null +++ b/raw/rel-18/29_series/29525/f324fbc5d5af1e4da9cd932389f0064c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:86235da37d4993943e6cef1891a7ea58991b810e21aec10b6890076c720fb1ed +size 31152 diff --git a/raw/rel-18/29_series/29525/f943b07ab747bfd85e302e5a31c20ba8_img.jpg b/raw/rel-18/29_series/29525/f943b07ab747bfd85e302e5a31c20ba8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cdcb2f5a48d96ca279c1740fa665b34d62a60200 --- /dev/null +++ b/raw/rel-18/29_series/29525/f943b07ab747bfd85e302e5a31c20ba8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8273c49f9e8b3b29022d3fd38de4bc8a608c4664e2375ff7e9217bd6e9bb6245 +size 22548 diff --git a/raw/rel-18/29_series/29531/0f985b39edc1d52ba3600c438bc8f0a5_img.jpg b/raw/rel-18/29_series/29531/0f985b39edc1d52ba3600c438bc8f0a5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8db903991a9c7b2d85c3137d093a6376a21125d8 --- /dev/null +++ b/raw/rel-18/29_series/29531/0f985b39edc1d52ba3600c438bc8f0a5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f988d0a5cf21e7e1af284f7a5788441ab5ee5a468d6ad3a11e4f8a02ca87c804 +size 35170 diff --git a/raw/rel-18/29_series/29531/21ad58fee90f2be50708ff541d225507_img.jpg b/raw/rel-18/29_series/29531/21ad58fee90f2be50708ff541d225507_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6ace738fa941d668f23057cfbf6ef4c4952be561 --- /dev/null +++ b/raw/rel-18/29_series/29531/21ad58fee90f2be50708ff541d225507_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5a36c9975625b60e2f002d6dbd400ccfaab67764ea10790e8fc76b9327a9563b +size 31062 diff --git a/raw/rel-18/29_series/29531/3da1a07cb87051bf616c9876db958cf0_img.jpg b/raw/rel-18/29_series/29531/3da1a07cb87051bf616c9876db958cf0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ab2e1c3b7844deb316809290d32e21f559d23f67 --- /dev/null +++ b/raw/rel-18/29_series/29531/3da1a07cb87051bf616c9876db958cf0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2b933a3c4db73a3c3eb0bbd924a96a5815f9465ea1fa8e5a11cc02b3cfbaf7ac +size 29921 diff --git a/raw/rel-18/29_series/29531/3fa8bfee86764e3c3a1a6fbbe61bbd52_img.jpg b/raw/rel-18/29_series/29531/3fa8bfee86764e3c3a1a6fbbe61bbd52_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9ad77e4709fc07599676429cbf01a1c36ea74f3e --- /dev/null +++ b/raw/rel-18/29_series/29531/3fa8bfee86764e3c3a1a6fbbe61bbd52_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e2ba5a1d4f96dcfebf209798dab76c3d503af89dddc7898661260cf1d3566c1e +size 28928 diff --git a/raw/rel-18/29_series/29531/5a4e62bead259c258d069fd3663ea670_img.jpg b/raw/rel-18/29_series/29531/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec250a10b9dc9791c464e5ab27e58082545da380 --- /dev/null +++ b/raw/rel-18/29_series/29531/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5e8e04cedd64a6548cd8f105c91125d8a7249fbf7c0c30fdcb8d382c474e23ed +size 36378 diff --git a/raw/rel-18/29_series/29531/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29531/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..feb7a8d4464312774beb14a8180a8be7e5435bf8 --- /dev/null +++ b/raw/rel-18/29_series/29531/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:73c74357488b52bfd95b704372fdb58986fb57811790bf002a2d1466e772da2a +size 9603 diff --git a/raw/rel-18/29_series/29531/63e0c22852c26699d0bd095a2d796bab_img.jpg b/raw/rel-18/29_series/29531/63e0c22852c26699d0bd095a2d796bab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d82b47348821baf6f1ceee3a9a50dd2a458f2d09 --- /dev/null +++ b/raw/rel-18/29_series/29531/63e0c22852c26699d0bd095a2d796bab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e88e1652d4226a5a4b2b0939624b217357bd4d1b069ab278697839f2355a854c +size 35239 diff --git a/raw/rel-18/29_series/29531/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29531/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2f03be4692623b464217c7bcef32314ba835a641 --- /dev/null +++ b/raw/rel-18/29_series/29531/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8fb16725a6428052596a6edec61b07d5a43287c9a6beeae6f02fc0b9deabdea6 +size 5648 diff --git a/raw/rel-18/29_series/29531/740442c999390734911677f01af0316d_img.jpg b/raw/rel-18/29_series/29531/740442c999390734911677f01af0316d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b340c667090d76484e452985337050b398bda600 --- /dev/null +++ b/raw/rel-18/29_series/29531/740442c999390734911677f01af0316d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c43dbf253a90533e143f2680e3e8c8fd47c58983efee4615e552c375cc93f2fd +size 14311 diff --git a/raw/rel-18/29_series/29531/834fb96b114b8fdc001625e1ae28e8b1_img.jpg b/raw/rel-18/29_series/29531/834fb96b114b8fdc001625e1ae28e8b1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6d72ad8e11cac5e562c1d9fea1e97e2777ce0bca --- /dev/null +++ b/raw/rel-18/29_series/29531/834fb96b114b8fdc001625e1ae28e8b1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e6a4a726b539f28158a1127453a3e972bd5481fe81ac67194773426d3f4294db +size 25990 diff --git a/raw/rel-18/29_series/29531/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg b/raw/rel-18/29_series/29531/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d57fa44b88b553c69318900ebd385c2de09e9941 --- /dev/null +++ b/raw/rel-18/29_series/29531/9ae17964ddd9b814c7d905b1af2fddf2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bb605be285559b0bdb24e7b0fe50186b0853c065b74d961f3940c6f5503380d6 +size 41550 diff --git a/raw/rel-18/29_series/29531/cdd4dfacab004e9979caed3fffea69e5_img.jpg b/raw/rel-18/29_series/29531/cdd4dfacab004e9979caed3fffea69e5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d9da1eaded64066e6370d90f66a7b57f306e1caa --- /dev/null +++ b/raw/rel-18/29_series/29531/cdd4dfacab004e9979caed3fffea69e5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c144c2064967a028210b4440742bef79652f3861c62e603e84abd8bc286d93b0 +size 26880 diff --git a/raw/rel-18/29_series/29531/ddc7460821484f1ae2835c67955c554c_img.jpg b/raw/rel-18/29_series/29531/ddc7460821484f1ae2835c67955c554c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6b2b61bc36e6cd7786eeb0a66b1bb1691a19cb26 --- /dev/null +++ b/raw/rel-18/29_series/29531/ddc7460821484f1ae2835c67955c554c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:674c432a00aa83f78c4534a24a9744dc1ab83c94857ae4d2ad69cce51fe4ae14 +size 33958 diff --git a/raw/rel-18/29_series/29531/dfe556fea00682b09a59427aaf72051c_img.jpg b/raw/rel-18/29_series/29531/dfe556fea00682b09a59427aaf72051c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a20ad543cf9c964a10c3866d2a7af16be88d823b --- /dev/null +++ b/raw/rel-18/29_series/29531/dfe556fea00682b09a59427aaf72051c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8dc2014e7055ca3e8c43fbd5267de9b25971d37d3150dcbfaa88514c8f0e1c3b +size 28181 diff --git a/raw/rel-18/29_series/29531/f41910d93b5ae4cc7def1eb267229d50_img.jpg b/raw/rel-18/29_series/29531/f41910d93b5ae4cc7def1eb267229d50_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3ab7147350ef67556bc26d7ef294d8f0131f7233 --- /dev/null +++ b/raw/rel-18/29_series/29531/f41910d93b5ae4cc7def1eb267229d50_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5181dc92ee62917c09fe6d3f46059d433b3de24dbc2de0f3b303cbd9c20f6fd4 +size 8954 diff --git a/raw/rel-18/29_series/29532/raw.md b/raw/rel-18/29_series/29532/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..f93659bdd5b09d9d0b452d3b01367fa511b3e276 --- /dev/null +++ b/raw/rel-18/29_series/29532/raw.md @@ -0,0 +1,4461 @@ + + +# 3GPP TS 29.532 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; 5G Multicast-Broadcast Session Management Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | | +|------------|----------------------------------------------|----| +| 1 | Scope..... | 9 | +| 2 | References..... | 9 | +| 3 | Definitions, symbols and abbreviations ..... | 10 | +| 3.1 | Definitions..... | 10 | +| 3.2 | Abbreviations ..... | 10 | +| 4 | Overview..... | 11 | +| 4.1 | Introduction ..... | 11 | +| 5 | Services offered by the MB-SMF ..... | 11 | +| 5.1 | Introduction ..... | 11 | +| 5.2 | Nmbsmf_TMGI Service..... | 12 | +| 5.2.1 | Service Description ..... | 12 | +| 5.2.2 | Service Operations..... | 13 | +| 5.2.2.1 | Introduction..... | 13 | +| 5.2.2.2 | TMGI Allocate service operation ..... | 13 | +| 5.2.2.2.1 | General ..... | 13 | +| 5.2.2.3 | TMGI Deallocate service operation..... | 13 | +| 5.2.2.3.1 | General ..... | 13 | +| 5.3 | Nmbsmf_MBSSession Service ..... | 14 | +| 5.3.1 | Service Description ..... | 14 | +| 5.3.2 | Service Operations..... | 15 | +| 5.3.2.1 | Introduction..... | 15 | +| 5.3.2.2 | Create ..... | 15 | +| 5.3.2.2.1 | General ..... | 15 | +| 5.3.2.3 | Update ..... | 17 | +| 5.3.2.3.1 | General ..... | 17 | +| 5.3.2.4 | Release ..... | 18 | +| 5.3.2.4.1 | General ..... | 18 | +| 5.3.2.5 | ContextUpdate ..... | 19 | +| 5.3.2.5.1 | General ..... | 19 | +| 5.3.2.6 | StatusSubscribe service operation ..... | 21 | +| 5.3.2.6.1 | General ..... | 21 | +| 5.3.2.6.2 | Subscription creation..... | 21 | +| 5.3.2.6.3 | Subscription update ..... | 22 | +| 5.3.2.7 | StatusUnsubscribe..... | 23 | +| 5.3.2.7.1 | General ..... | 23 | +| 5.3.2.8 | StatusNotify ..... | 23 | +| 5.3.2.8.1 | General ..... | 23 | +| 5.3.2.9 | ContextStatusSubscribe ..... | 24 | +| 5.3.2.9.1 | General ..... | 24 | +| 5.3.2.9.2 | Creation of a subscription ..... | 24 | +| 5.3.2.9.3 | Modification of a Subscription..... | 26 | +| 5.3.2.10 | ContextStatusUnSubscribe ..... | 27 | +| 5.3.2.10.1 | General ..... | 27 | +| 5.3.2.11 | ContextStatusNotify..... | 27 | +| 5.3.2.11.1 | General ..... | 27 | +| 6 | API Definitions ..... | 28 | +| 6.1 | Nmbsmf_TMGI Service API ..... | 28 | +| 6.1.1 | Introduction ..... | 28 | +| 6.1.2 | Usage of HTTP..... | 29 | +| 6.1.2.1 | General ..... | 29 | +| 6.1.2.2 | HTTP standard headers..... | 29 | +| 6.1.2.2.1 | General ..... | 29 | +| 6.1.2.2.2 | Content type ..... | 29 | +| 6.1.2.3 | HTTP custom headers..... | 29 | + +| | | | +|-----------|----------------------------------------------------------------------------------|----| +| 6.1.3 | Resources..... | 29 | +| 6.1.3.1 | Overview..... | 29 | +| 6.1.3.2 | Resource: TMGI collection ..... | 30 | +| 6.1.3.2.1 | Description ..... | 30 | +| 6.1.3.2.2 | Resource Definition..... | 30 | +| 6.1.3.2.3 | Resource Standard Methods..... | 30 | +| 6.1.3.2.4 | Resource Custom Operations ..... | 33 | +| 6.1.4 | Custom Operations without associated resources ..... | 33 | +| 6.1.5 | Notifications ..... | 33 | +| 6.1.6 | Data Model ..... | 33 | +| 6.1.6.1 | General..... | 33 | +| 6.1.6.2 | Structured data types..... | 34 | +| 6.1.6.2.1 | Introduction ..... | 34 | +| 6.1.6.2.2 | Type: TmgiAllocate ..... | 34 | +| 6.1.6.2.3 | Type: TmgiAllocated ..... | 34 | +| 6.1.6.3 | Simple data types and enumerations..... | 35 | +| 6.1.6.3.1 | Introduction ..... | 35 | +| 6.1.6.3.2 | Simple data types ..... | 35 | +| 6.1.6.3.3 | Enumeration: ..... | 35 | +| 6.1.6.3.4 | Void..... | 35 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 35 | +| 6.1.6.5 | Binary data ..... | 35 | +| 6.1.7 | Error Handling..... | 35 | +| 6.1.7.1 | General..... | 35 | +| 6.1.7.2 | Protocol Errors ..... | 35 | +| 6.1.7.3 | Application Errors..... | 35 | +| 6.1.8 | Feature negotiation ..... | 36 | +| 6.1.9 | Security..... | 36 | +| 6.1.10 | HTTP redirection..... | 36 | +| 6.2 | Nmbsmf_MBSSession Service API..... | 36 | +| 6.2.1 | Introduction ..... | 36 | +| 6.2.2 | Usage of HTTP..... | 37 | +| 6.2.2.1 | General..... | 37 | +| 6.2.2.2 | HTTP standard headers..... | 37 | +| 6.2.2.2.1 | General ..... | 37 | +| 6.2.2.2.2 | Content type ..... | 37 | +| 6.2.2.3 | HTTP custom headers..... | 37 | +| 6.2.2.4 | HTTP multipart messages..... | 37 | +| 6.2.3 | Resources..... | 38 | +| 6.2.3.1 | Overview..... | 38 | +| 6.2.3.2 | Resource: MBS sessions collection (Collection)..... | 39 | +| 6.2.3.2.1 | Description ..... | 39 | +| 6.2.3.2.2 | Resource Definition..... | 39 | +| 6.2.3.2.3 | Resource Standard Methods..... | 39 | +| 6.2.3.2.4 | Resource Custom Operations ..... | 44 | +| 6.2.3.3 | Resource: Individual MBS session (Document)..... | 45 | +| 6.2.3.3.1 | Description ..... | 45 | +| 6.2.3.3.2 | Resource Definition..... | 45 | +| 6.2.3.3.3 | Resource Standard Methods..... | 45 | +| 6.2.3.3.4 | Resource Custom Operations ..... | 49 | +| 6.2.3.4 | Resource: Subscriptions collection for MBS sessions (Collection) ..... | 49 | +| 6.2.3.4.1 | Description ..... | 49 | +| 6.2.3.4.2 | Resource Definition..... | 49 | +| 6.2.3.4.3 | Resource Standard Methods..... | 50 | +| 6.2.3.4.4 | Resource Custom Operations ..... | 51 | +| 6.2.3.5 | Resource: Individual subscription for an MBS session (Document)..... | 51 | +| 6.2.3.5.1 | Description ..... | 51 | +| 6.2.3.5.2 | Resource Definition..... | 51 | +| 6.2.3.5.3 | Resource Standard Methods..... | 52 | +| 6.2.3.5.4 | Resource Custom Operations ..... | 54 | +| 6.2.3.6 | Resource: Subscriptions collection for MBS contexts (Collection) ..... | 54 | +| 6.2.3.6.1 | Description ..... | 54 | + +| | | | +|------------|----------------------------------------------------------------------------------|----| +| 6.2.3.6.2 | Resource Definition..... | 54 | +| 6.2.3.6.3 | Resource Standard Methods..... | 54 | +| 6.2.3.6.4 | Resource Custom Operations..... | 56 | +| 6.2.3.7 | Resource: Individual subscription for an MBS context (Document) ..... | 56 | +| 6.2.3.7.1 | Description ..... | 56 | +| 6.2.3.7.2 | Resource Definition..... | 56 | +| 6.2.3.7.3 | Resource Standard Methods..... | 56 | +| 6.2.3.7.4 | Resource Custom Operations..... | 58 | +| 6.2.4 | Custom Operations without associated resources ..... | 59 | +| 6.2.5 | Notifications ..... | 59 | +| 6.2.5.1 | General..... | 59 | +| 6.2.5.2 | StatusNotify ..... | 59 | +| 6.2.5.2.1 | Description ..... | 59 | +| 6.2.5.2.2 | Target URI..... | 59 | +| 6.2.5.2.3 | Standard Methods..... | 59 | +| 6.2.5.3 | ContextStatusNotify..... | 60 | +| 6.2.5.3.1 | Description ..... | 60 | +| 6.2.5.3.2 | Target URI..... | 60 | +| 6.2.5.3.3 | Standard Methods..... | 60 | +| 6.2.6 | Data Model ..... | 61 | +| 6.2.6.1 | General..... | 61 | +| 6.2.6.2 | Structured data types..... | 63 | +| 6.2.6.2.1 | Introduction ..... | 63 | +| 6.2.6.2.2 | Type: CreateReqData ..... | 63 | +| 6.2.6.2.3 | Type: CreateRspData ..... | 64 | +| 6.2.6.2.4 | Type: MbsSessionExtension ..... | 64 | +| 6.2.6.2.5 | Type: ContextUpdateReqData ..... | 65 | +| 6.2.6.2.6 | Type: ContextUpdateRspData..... | 65 | +| 6.2.6.2.7 | Type: StatusSubscribeReqData ..... | 66 | +| 6.2.6.2.8 | Type: StatusSubscribeRspData ..... | 66 | +| 6.2.6.2.9 | Type: N2MbsSmInfo..... | 66 | +| 6.2.6.2.10 | Type: ContextStatusNotifyReqData..... | 66 | +| 6.2.6.2.11 | Type: StatusNotifyReqData ..... | 66 | +| 6.2.6.2.12 | Type: ContextStatusSubscribeReqData ..... | 67 | +| 6.2.6.2.13 | Type: ContextStatusSubscription..... | 67 | +| 6.2.6.2.14 | Type: ContextStatusEvent..... | 67 | +| 6.2.6.2.15 | Type: ContextStatusSubscribeRspData..... | 68 | +| 6.2.6.2.16 | Type: MbsContextInfo ..... | 68 | +| 6.2.6.2.17 | Type: ContextStatusEventReport..... | 69 | +| 6.2.6.2.18 | Type: MulticastTransportAddressChangeInfo ..... | 69 | +| 6.2.6.2.19 | Type: QosInfo ..... | 70 | +| 6.2.6.2.20 | Type: QosFlowAddModifyRequestItem..... | 70 | +| 6.2.6.2.21 | Type: QosFlowProfile ..... | 70 | +| 6.2.6.2.22 | Type: GbrQosFlowInformation..... | 71 | +| 6.2.6.2.23 | Type: ProblemDetailsExtension..... | 71 | +| 6.2.6.2.24 | Type: UpdateRspData ..... | 71 | +| 6.2.6.3 | Simple data types and enumerations..... | 71 | +| 6.2.6.3.1 | Introduction ..... | 71 | +| 6.2.6.3.2 | Simple data types ..... | 71 | +| 6.2.6.3.3 | Enumeration: ContextUpdateAction ..... | 71 | +| 6.2.6.3.4 | Enumeration: ContextStatusEventType ..... | 72 | +| 6.2.6.3.5 | Enumeration: ReportingMode..... | 72 | +| 6.2.6.3.6 | Enumeration: NgapIeType ..... | 72 | +| 6.2.6.4 | Data types describing alternative data types or combinations of data types ..... | 72 | +| 6.2.6.4.1 | Type: ExtMbsSession..... | 72 | +| 6.2.6.4.2 | Type: ExtProblemDetails ..... | 73 | +| 6.2.6.5 | Binary data ..... | 73 | +| 6.2.6.5.1 | Introduction ..... | 73 | +| 6.2.6.5.2 | N2 MBS Session Management Information ..... | 73 | +| 6.2.6.5.3 | Void..... | 73 | +| 6.2.7 | Error Handling ..... | 73 | +| 6.2.7.1 | General..... | 73 | + +6.2.7.2 Protocol Errors ........................................................................................................................................ 74 + +6.2.7.3 Application Errors.................................................................................................................................. 74 + +6.2.8 Feature negotiation ................................................................................................................................... 74 + +6.2.9 Security ..................................................................................................................................................... 75 + +6.2.10 HTTP redirection...................................................................................................................................... 75 + +A.1 General......................................................................................................................................................... 75 + +A.2 Nmbsmf\_TMGI API ................................................................................................................................... 76 + +A.3 Nmbsmf\_MBSSession API......................................................................................................................... 78 + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document +- might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nmbsmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the MB-SMF with the exception of the MB-SMF Event Exposure service. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. The 5G Multicast-Broadcast Session Management Services for 5G System is specified in 3GPP TS 23.247 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services; Stage 2". +- [16] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [17] 3GPP TS 29.281: "General Packet Radio System (GPRS) Tunnelling Protocol User Plane (GTPv1-U)". +- [18] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [19] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". + +- [20] 3GPP TS 38.413: "NG Radio Access Network (NG-RAN); NG Application Protocol (NGAP)". +- [21] IETF RFC 2387: "The MIME Multipart/Related Content-type". +- [22] IETF RFC 2045: "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies". +- [23] 3GPP TS 29.537: "5G System; Multicast/Broadcast Policy Control Services; Stage 3". +- [24] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +For the definitions of the basic SBI notions (e.g. apiRoot, API URI, Callback URI, etc.), SBI specific abbreviations (e.g. CRUD, YAML, etc.), special characters, operators and delimiters that are used by SBI specifications, see clause 3 in 3GPP TS 29.501 [5]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|---------|-------------------------------------------------------| +| 5MBS | 5G Multicast-Broadcast Services | +| AF/AS | Application Function / Application server | +| AMF | Access and Mobility Management Function | +| C-TEID | Common Tunnel Endpoint IDentifier | +| DNN | Data Network Name | +| FSA | Frequency Selection Area | +| F-TEID | Fully Qualified TEID (i.e. IP address and TEID) | +| GTP-U | GTP User plane | +| MBS | Multicast/Broadcast Service | +| MBSF | Multicast/Broadcast Service Function | +| MBSTF | Multicast/Broadcast Service Transport Function | +| MB-SMF | Multicast/Broadcast Session Management Function | +| MB-UPF | Multicast/Broadcast User Plane Function | +| NEF | Network Exposure Function | +| NF | Network Function | +| NG-RAN | Next Generation (5G) RAN | +| SMF | Session Management Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| TEID | Tunnel Endpoint IDentifier | +| TMGI | Temporary Mobile Group Identity | +| UPF | User Plane Function | +| URI | Uniform Resource Identifier | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the MB-SMF offers services to the SMF, AMF, AF/AS, MBSF and NEF via the Nmbsmf service based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.247 [14]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the MB-SMF and the scope of the present specification. + +![Figure 4.1-1: Reference model – MB-SMF. This diagram shows the MB-SMF as a central component connected to several other network functions. On the left, AMF, SMF, MBSF, and NEF are connected to a central point labeled Nmbsmf. The connections are labeled N11mb (AMF to Nmbsmf), N16mb (SMF to Nmbsmf), Nmb1 (MBSF to Nmbsmf), and N29mb (NEF to Nmbsmf). Above the Nmbsmf point, AF/AS is connected via Nmb13. Below the Nmbsmf point, PCF is connected via N7mb. The MB-SMF is shown as a large rectangle on the right, connected to the Nmbsmf point.](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +Figure 4.1-1: Reference model – MB-SMF. This diagram shows the MB-SMF as a central component connected to several other network functions. On the left, AMF, SMF, MBSF, and NEF are connected to a central point labeled Nmbsmf. The connections are labeled N11mb (AMF to Nmbsmf), N16mb (SMF to Nmbsmf), Nmb1 (MBSF to Nmbsmf), and N29mb (NEF to Nmbsmf). Above the Nmbsmf point, AF/AS is connected via Nmb13. Below the Nmbsmf point, PCF is connected via N7mb. The MB-SMF is shown as a large rectangle on the right, connected to the Nmbsmf point. + +**Figure 4.1-1: Reference model – MB-SMF** + +N11mb is the reference point between MB-SMF and AMF. + +N16mb is the reference point between MB-SMF and SMF. + +N29mb is the reference point between MB-SMF and NEF. + +Nmb1 is the reference point between MB-SMF and MBSF. + +Nmb13 is the reference point between MB-SMF and AF/AS. + +The functionalities supported by the MB-SMF are listed in clause 5.3.2.2 of 3GPP TS 23.247 [14]. + +# 5 Services offered by the MB-SMF + +## 5.1 Introduction + +Table 5.1-1 summarizes the SBI services produced by an MB-SMF. + +**Table 5.1-1: NF Services provided by MB-SMF** + +| Service Name | Description | Example Consumers | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------| +| Nmbsmf_TMGI | This service enables to request the allocation or release of TMGI(s). Applicable to both Broadcast and Multicast services. | NEF, MBSF, AF | +| Nmbsmf_MBSSession | This service enables:
  • - to create, modify, activate, deactivate and release a multicast MBS session
  • - create, modify and release a broadcast MBS session
  • - request the start or termination of MBS data reception for a multicast MBS session
  • - query information (e.g. QoS information) about a multicast MBS session and subscribe and unsubscribe to notifications of events about the multicast MBS session context and notify corresponding events to the subscribed NFs
  • - subscribe and unsubscribe to notifications of events about status change of a broadcast or multicast MBS session and notify corresponding events to the subscribed NFs
| NEF, MBSF, AF
NEF, MBSF, AF
SMF, AMF
SMF
NEF, MBSF, AF | + +Table 5.1-2 summarizes the corresponding MB-SMF APIs defined in this specification (see Annex A). + +**Table 5.1-2: MB-SMF API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-------------------|--------|---------------------------|--------------------------------|-------------------|-------| +| Nmbsmf_TMGI | 5.2 | MB-SMF TMGI Service | TS29532_Nmbsmf_TMGI.yaml | nmbsmf_tmgi | A.2 | +| Nmbsmf_MBSSession | 5.3 | MB-SMF MBSSession Service | TS29532_Nmbsmf_MBSSession.yaml | nmbsmf_mbssession | A.3 | + +## 5.2 Nmbsmf\_TMGI Service + +### 5.2.1 Service Description + +The Nmbsmf\_TMGI service operates on TMGI resources. It is applicable to both Broadcast and Multicast services. The service operations exposed by this service allow other NFs to request the allocation and release of TMGIs. The following are the key functionalities of this NF service, as specified in clause 9.1.2 of 3GPP TS23.247 [14]: + +- Requesting the allocation of one or more TMGI values, or requesting to refresh the expiration time of the previous allocated TMGI(s); +- Requesting the deallocation of one or more TMGI values. + +Table 5.2.1-1 lists the service operations that are supported by the Nmbsmf\_TMGI service. + +**Table 5.2.1-1: Service operations supported by the Nmbsmf\_TMGI service** + +| Service Operations | Description | Operation Semantics | Example Consumers | +|--------------------|------------------------------------------------------------------------------------------------------------------------|---------------------|-------------------| +| Allocate | Request the allocation of one or more TMGI values, or refresh the expiration time of the previously allocated TMGI(s). | Request / Response | NEF, MBSF, AF | +| Deallocate | Request the deallocation of one or more TMGI values. | Request / Response | NEF, MBSF, AF | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +See Table 5.2.1-1 for an overview of the service operations supported by the Nmbsmf\_TMGI service. + +#### 5.2.2.2 TMGI Allocate service operation + +##### 5.2.2.2.1 General + +The TMGI Allocate service operation (Nmbsmf\_TMGI\_Allocate) shall be used by NF Service Consumers to request the allocation of TMGI(s). The TMGI Allocate service operation shall also be used to refresh the expiration time of the previously allocated TMGI(s). + +It is used in the following procedures: + +- MBS Session Creation with and without PCC (see clauses 7.1.1.2 and 7.1.1.3 in 3GPP TS 23.247 [14]). + +The NF Service Consumer (e.g. NEF, MBSF and AF) shall trigger the allocation of one or more TMGIs by using the HTTP POST method on the TMGI collection resource (/tmgi), as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram showing TMGI allocation and refresh operations between an NF Service Consumer and an MB-SMF.](5dfc130b129ace4df375839020a5700d_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note left of NF Service Consumer: Request + NF Service Consumer->>MB-SMF: 1. POST .../tmgi (TmgiAllocate) + Note right of MB-SMF: Success + MB-SMF-->>NF Service Consumer: 2a. 200 OK (TmgiAllocated) + Note right of MB-SMF: Failure + MB-SMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +Sequence diagram showing TMGI allocation and refresh operations between an NF Service Consumer and an MB-SMF. + +**Figure 5.2.2.2.1-1: TMGI allocation and TMGI refresh operations** + +1. The NF Service Consumer shall send a POST request to the resource representing the TMGI collection resource (/tmgi) of the MB-SMF. The content (TmgiAllocate data structure) of the POST request shall contain: + - the number of TMGIs to be allocated, if TMGI allocation is requested; + - one or more TMGIs, if the expiration time of the previously allocated TMGI(s) needs to be refreshed. +- 2a. On success, the MB-SMF shall return a 200 OK response with a content (TmgiAllocated data structure), which contains the allocated TMGI(s) and their expiration time, i.e. one expiration time for all TMGIs. +- 2b. On failure, or redirection, one of the HTTP status codes listed in Table 6.1.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails data structure with ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.3.1-3. + +#### 5.2.2.3 TMGI Deallocate service operation + +##### 5.2.2.3.1 General + +The TMGI Deallocate service operation (Nmbsmf\_TMGI\_Deallocate) shall be used by NF Service Consumers to request the deallocation of one or more TMGI(s). + +It is used in the following procedures: + +- MBS Session Deletion with and without PCC (see clauses 7.1.1.4 and 7.1.1.5 in 3GPP TS 23.247 [14]); +- MBS Session Release for Broadcast (see clause 7.3.2 in 3GPP TS 23.247 [14]). + +The NF Service Consumer (e.g. NEF, MBSF and AF) shall trigger the deallocation of one or more TMGIs by using the HTTP DELETE method on the TMGI collection resource (/tmgi), as shown in Figure 5.2.2.3.1-1. + +![Sequence diagram showing TMGI deallocation between an NF service consumer and an MB-SMF.](bd671b21db63e6fdb2196e9b18502aac_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant MB-SMF + Note left of NF service consumer: + NF service consumer->>MB-SMF: 1. DELETE .../tmgi () ?tmgi-list= + Note right of MB-SMF: + MB-SMF-->>NF service consumer: 2a. 204 No Content () + Note right of MB-SMF: + MB-SMF-->>NF service consumer: 2b. 4xx/5xx (ProblemDetails) / 3xx +``` + +The diagram illustrates the interaction for TMGI deallocation. It starts with the 'NF service consumer' sending a 'DELETE .../tmgi () ?tmgi-list= ' request to the 'MB-SMF'. The 'MB-SMF' responds with either '2a. 204 No Content ()' on success or '2b. 4xx/5xx (ProblemDetails) / 3xx' on failure or redirection. The return messages are shown as arrows from the MB-SMF back to the NF service consumer, with the failure path being a dashed line. + +Sequence diagram showing TMGI deallocation between an NF service consumer and an MB-SMF. + +Figure 5.2.2.3.1-1: TMGI deallocation + +1. The NF Service Consumer shall send a DELETE request to the resource representing the TMGIs collection. Query parameters shall be used to indicate the TMGI(s) to be deallocated. The NF Service Consumer may request to deallocate all previously allocated TMGIs, or one or more specific TMGIs previously allocated. +- 2a. On success, "204 No Content" shall be returned with empty message body. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.3.2-3. + +## 5.3 Nmbsmf\_MBSSession Service + +### 5.3.1 Service Description + +The Nmbsmf\_MBSSession service operates on MBS Sessions. It is applicable to both Broadcast and Multicast services. The service operations exposed by this service allow other NFs to create, update and release MBS sessions. The following are the key functionalities of this NF service, as specified in clause 9.1.3 of 3GPP TS23.247 [14]: + +- Creation, modification and release of MBS contexts for MBS Sessions; +- Requesting the start or termination of MBS data reception for a multicast MBS session; +- Subscribing to or unsubscribing from notifications of status change of multicast MBS session context; +- Subscribing to or unsubscribing from notifications of status change of a broadcast or multicast MBS session. + +Table 5.3.1-1 lists the service operations that are supported by Nmbsmf\_MBSSession service. + +**Table 5.3.1-1: Service operations supported by the Nmbsmf\_MBSSession service** + +| Service Operations | Description | Operation Semantics | Example Consumers | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|-------------------| +| Create | Create a multicast or broadcast MBS session | Request / Response | NEF, MBSF, AF | +| Update | Update a multicast or broadcast MBS session | Request / Response | NEF, MBSF, AF | +| Delete | Delete a multicast or broadcast MBS session | Request / Response | NEF, MBSF, AF | +| ContextUpdate | Request the start or termination of MBS data reception for a multicast MBS session | Request / Response | AMF, SMF | +| ContextStatusSubscribe | Request information (e.g. QoS information) about a multicast MBS session and subscribe to notification of events about the multicast MBS session context | Subscribe/Notify | SMF | +| ContextStatusUnsubscribe | Unsubscribe to notification of events about the multicast MBS session context | | SMF | +| ContextStatusNotify | Notify events about the multicast MBS session context | | SMF | +| StatusSubscribe | Subscribe to notifications of status change of a broadcast or multicast MBS session | Subscribe/Notify | NEF, MBSF, AF | +| StatusUnsubscribe | Unsubscribe to notifications of status change of a broadcast or multicast MBS session | | NEF, MBSF, AF | +| StatusNotify | Notify status changes of a multicast or broadcast or multicast MBS session | | NEF, MBSF, AF | + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +See Table 5.3.1-1 for an overview of the service operations supported by the Nmbsmf\_MBSSession service. + +#### 5.3.2.2 Create + +##### 5.3.2.2.1 General + +The Create service operation shall be used to create a multicast or a broadcast MBS session, or for a location dependent MBS session, the part of an MBS Session within an MBS service area. + +NOTE 1: For a location dependent MBS service, the Create service operation is performed per MBS service area of the MBS session. + +It is used in the following procedures: + +- MBS Session Creation with or without PCC (see clauses 7.1.1.2 and 7.1.1.3 of 3GPP TS 23.247 [14]); and +- MBS Session Start for Broadcast (see clause 7.3.1 of 3GPP TS 23.247 [14]). + +For a location dependent MBS service, TMGI shall be used to identify the MBS Session within 5GS. Different MBS Service Areas shall use different SSM (source specific IP multicast) addresses if multicast transport is used over N6mb. + +For a location dependent broadcast MBS session, based on operator's policy, the MB-SMF shall accept a TMGI value allocated by another MB-SMF. + +NOTE 2: Different MB-SMFs can be assigned for different MBS service areas belonging to different MB-SMF service areas for a location dependent broadcast MBS session (see clause 7.3.4 of 3GPP TS 23.247 [14]). + +The NF Service Consumer (e.g. NEF, MBSF or AF) shall create an MBS session, or for a location dependent MBS session, the part of an MBS Session within an MBS service area, by using the HTTP POST method as shown in Figure 5.3.2.2.1-1. + +![Sequence diagram showing MBS session creation between NF Service Consumer and MB-SMF. The NF Service Consumer sends a POST request (CreateReqData) to the MB-SMF. The MB-SMF responds with either a 201 Created (CreateRspData) or a 4xx/5xx (ProblemDetails) or 3xx response.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note left of NF Service Consumer: + NF Service Consumer->>MB-SMF: 1. POST .../mbs-sessions (CreateReqData) + Note right of MB-SMF: + MB-SMF-->>NF Service Consumer: 2a. 201 Created (CreateRspData) + Note right of MB-SMF: + MB-SMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing MBS session creation between NF Service Consumer and MB-SMF. The NF Service Consumer sends a POST request (CreateReqData) to the MB-SMF. The MB-SMF responds with either a 201 Created (CreateRspData) or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.3.2.2.1-1: MBS session creation** + +- The NF Service Consumer shall send a POST request (CreateReqData structure) targeting the MBS Sessions collection resource of the MB-SMF. The content of the POST request shall contain the following information: + - MBS Session ID (source specific IP multicast address or TMGI) and/or TMGI allocation request indication; + - MBS service type (either multicast or broadcast service); + - the locationDependent IE set to true, for a location dependent MBS service; + - MBS Service Area, for a location dependent MBS service or for a Local MBS service; + - Area Session Policy ID, for a location dependent MBS service, if the AF/NEF/MBSF has obtained the Area Session Policy ID from the PCF (see clause 7.1.1.3 of 3GPP TS 23.247 [14]). + +The content of the POST request may further contain the following parameters: + +- for a multicast or a broadcast MBS session: + - ingress transport address request indication, if the allocation of an ingress transport address is requested; + - DNN; + - S-NSSAI; + - MBS start time; + - MBS termination time; + - MBS service information; + - an MBS session status subscription request, including the list of MBS session events requested to be subscribed, a Notify Correlation ID, the Notification URI where to receive MBS session status notifications and the NF instance ID of the subscribing NF, for subscribing to notifications of events about the MBS session. +- for a multicast MBS session: + - session activity status (active/inactive); + - indication that any UE may join the MBS session, for a multicast MBS session; + - if security protection is applied, the multicast session security context containing MBS Service Key (MSK), MBS Traffic Key (MTK) and the corresponding key IDs. +- for a broadcast MBS session: + - list of MBS FSA IDs; + - Associated Session ID to enable NG-RAN to identify multiple MBS sessions delivering the same content when an AF creates multiple broadcast MBS Sessions via different Core Networks in network sharing scenarios. + +- 2a. On success, the MB-SMF shall reserve ingress resources for the MBS session and shall return a "201 Created" response. The "Location" header shall be present and shall contain the URI of the created resource. The content of the POST response (CreateRspData structure) shall contain a representation of the created MBS session, including the following parameters: +- the TMGI allocated to the MBS session and its expiration time, if the request included a TMGI allocation request; + - the Area Session ID allocated by the MB-SMF for the MBS session and MBS service area, for a location-dependent MBS session; + - MB-UPF tunnel information used between MB-UPF and MBSTF over Nmb9, or between MB-UPF and AF/AS if unicast transport is used over N6mb; + - list of MBS FSA IDs, if any, for a broadcast MBS session; and + - a representation of the created MBS session status subscription, including the list of MBS session events successfully subscribed, the URI of the created subscription and the expiry time after which the subscription becomes invalid, if the Create request includes the subscription to events about the MBS session and the subscription was created successfully. + +The POST response may also contain: + +- a list of event reports, if corresponding information is available. + +For a location dependent MBS service, the MB-SMF shall allocate a unique Area Session ID within the MBS session for the MBS Service Area. + +If the MBS service area received in the request cannot be entirely covered by the MB-SMF service area, the MB-SMF shall reduce the MBS service area to be within the MB-SMF service area and continue the Create service operation using the reduced MBS service area. In this case, the MB-SMF shall indicate in the response the reduced MBS service area in the redMbsServArea attribute set to the part of the requested MBS service area that is within the MB-SMF service area in which the MBS session has been created. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.3.2.3.1-3. + +#### 5.3.2.3 Update + +##### 5.3.2.3.1 General + +The Update service operation shall be used to update a multicast or a broadcast MBS session, or for a location dependent MBS session, the part of an MBS Session within an MBS service area. + +NOTE: For a location dependent MBS service, the Update service operation is performed per MBS service area of the MBS session. + +It is used in the following procedures: + +- MBS Session Update with or without PCC (see clauses 7.1.1.6 and 7.1.1.7 of 3GPP TS 23.247 [14]); and +- MBS Session Update for Broadcast (see clause 7.3.3 of 3GPP TS 23.247 [14]). + +The NF Service Consumer (e.g. NEF, MBSF or AF) shall update an MBS session by using the HTTP PATCH method with the URI of the individual MBS session as shown in Figure 5.3.2.3.1-1. + +![Sequence diagram for MBS session update. The NF Service Consumer sends a PATCH request to the MB-SMF. The MB-SMF responds with either a 204 No Content, a 200 OK (UpdateRspData), or a 4xx/5xx (ProblemDetails) or 3xx response.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note left of NF Service Consumer: 1. PATCH .../mbs-sessions/{mbsSessionRef} (PatchData) + NF Service Consumer->>MB-SMF: Request + Note right of MB-SMF: 2a. 204 No Content + MB-SMF-->>NF Service Consumer: Response 2a + Note right of MB-SMF: 2b. 200 OK (UpdateRspData) + MB-SMF-->>NF Service Consumer: Response 2b + Note right of MB-SMF: 2c. 4xx/5xx (ProblemDetails) or 3xx + MB-SMF-->>NF Service Consumer: Response 2c + +``` + +Sequence diagram for MBS session update. The NF Service Consumer sends a PATCH request to the MB-SMF. The MB-SMF responds with either a 204 No Content, a 200 OK (UpdateRspData), or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.3.2.3.1-1: MBS session update** + +- The NF Service Consumer shall send a PATCH request (PatchData) to update the MBS session. The following parameters may be modified: + +- for a multicast or a broadcast MBS session: + - MBS Service Area and/or; + - MBS service information. +- for a multicast MBS session: + - session activity status (active/inactive) to activate or deactivate an MBS session; and/or + - if security protection is applied, the multicast session security context containing MBS Service Key (MSK), MBS Traffic Key (MTK) and the corresponding key IDs. +- for a broadcast MBS session: + - list of MBS FSA IDs. + +If the "indication that the PCF has to be contacted" shall be conveyed in the update request as defined in 3GPP TS 23.247 [14], the NF service consumer shall include the corresponding "contactPcfInd" attribute within the set of requested modifications. + +- On success, the MB-SMF shall return a "204 No Content" response. + +- If the MBS service area received in the request cannot be entirely covered by the MB-SMF service area, the MB-SMF shall reduce the MBS service area to be within the MB-SMF service area and continue the Update service operation using the reduced MBS service area. In this case, the MB-SMF shall return a "200 OK" response and provide in the response the representation of the updated MBS session including the reduced MBS service area in the redMbsServArea attribute set to the part of the requested MBS service area that is within the MB-SMF service area in which the MBS session has been updated. + +- On failure or redirection, one of the HTTP status code listed in Table 6.2.3.3.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.3.3.3.1-3. + +#### 5.3.2.4 Release + +##### 5.3.2.4.1 General + +The Release service operation shall be used to delete a multicast or broadcast MBS session, or for a location dependent MBS session, the part of an MBS Session within an MBS service area. + +NOTE: For a location dependent MBS service, the Release service operation is performed per MBS service area of the MBS session. + +It is used in the following procedures: + +- MBS Session Deletion with or without PCC (see clauses 7.1.1.4 and 7.1.1.5 of 3GPP TS 23.247 [14]); and +- MBS Session Release for Broadcast (see clause 7.3.2 of 3GPP TS 23.247 [14]). + +The NF Service Consumer (e.g. NEF, MBSF or AF) shall release an MBS session by using the HTTP DELETE method with the URI of the individual MBS session as shown in Figure 5.3.2.4.1-1. + +![Sequence diagram showing MBS session release between NF Service Consumer and MB-SMF.](10781f43062bf3e9601a1e086710556c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note left of NF Service Consumer: 1. DELETE .../mbs-sessions/{mbsSessionRef} + NF Service Consumer->>MB-SMF: 1. DELETE .../mbs-sessions/{mbsSessionRef} + Note right of MB-SMF: 2a. 204 No Content + MB-SMF-->>NF Service Consumer: 2a. 204 No Content + Note right of MB-SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + MB-SMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +The diagram illustrates the interaction for MBS session release. It starts with the NF Service Consumer sending a DELETE request (step 1) to the MB-SMF. The MB-SMF then responds with either a 204 No Content (step 2a) on success or a 4xx/5xx (ProblemDetails) or 3xx (step 2b) on failure or redirection. + +Sequence diagram showing MBS session release between NF Service Consumer and MB-SMF. + +Figure 5.3.2.4.1-1: MBS session release + +1. The NF Service Consumer shall send a DELETE request (mbsSessionRef) to release the MBS session. +- 2a. On success, the MB-SMF shall release ingress resource for the MBS session and return a "204 No Content" response. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.3.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.3.3.3.2-3. + +#### 5.3.2.5 ContextUpdate + +##### 5.3.2.5.1 General + +The ContextUpdate service operation shall be used to start or terminate MBS data reception of a multicast MBS session, or for a location dependent multicast MBS session, for the part of an MBS session within an MBS service area. + +NOTE: For a location dependent multicast MBS service, the ContextUpdate service operation is performed per MBS service area of the MBS session. + +It is used in the following procedures: + +- to start MBS data reception: + - Multicast session join and session establishment procedure (see clause 7.2.1.3 of 3GPP TS 23.247 [14]) + - Establishment of shared delivery toward RAN node (see clause 7.2.1.4 of 3GPP TS 23.247 [14]) + - Xn based handover from MBS supporting NG-RAN node (see clause 7.2.3.2 of 3GPP TS 23.247 [14]) + - N2 based handover from MBS supporting NG-RAN node (see clause 7.2.3.3 of 3GPP TS 23.247 [14]) + - MBS session activation procedure (see clause 7.2.5.2 of 3GPP TS 23.247 [14]) +- to terminate MBS data reception: + - MBS session Leave (see clause 7.2.2.2 of 3GPP TS 23.247 [14]) + - SMF removing joined UEs from MBS session (see clause 7.2.2.3 of 3GPP TS 23.247 [14]) + - Release of shared delivery toward RAN node (see clause 7.2.2.4 of 3GPP TS 23.247 [14]) + - MBS session deactivation procedure (see clause 7.2.5.3 of 3GPP TS 23.247 [14]) + +The NF Service Consumer (e.g. AMF or SMF) shall update the MBS session context to start or terminate the MBS data reception of an MBS session by using the HTTP POST method as shown in Figure 5.3.2.5.1-1. + +![Sequence diagram showing the Multicast MBS session Context Update interaction between an NF Service Consumer and an MB-SMF. The NF Service Consumer sends a POST request to the MB-SMF. The MB-SMF responds with either a 200 OK, 204 No Content, or a 4xx/5xx/3xx error message.](81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note right of NF Service Consumer: 1. POST .../mbs-sessions/contexts/update (ContextUpdateReqData) + NF Service Consumer->>MB-SMF: Request + Note left of MB-SMF: 2a. 200 OK (ContextUpdateRspData) + Note left of MB-SMF: 2b. 204 No Content + Note left of MB-SMF: 2c. 4xx/5xx (ProblemDetails) or 3xx + MB-SMF-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the Multicast MBS session Context Update interaction between an NF Service Consumer and an MB-SMF. The NF Service Consumer sends a POST request to the MB-SMF. The MB-SMF responds with either a 200 OK, 204 No Content, or a 4xx/5xx/3xx error message. + +**Figure 5.3.2.5.1-1: Multicast MBS session Context Update** + +1. The NF Service Consumer shall send a POST request targeting the `/mbs-sessions/contexts/update` resource. The content of the POST request (`ContextUpdateReqData` structure) shall contain the following information: + - NF Instance ID of the NF Service Consumer; + - MBS Session ID; + - Area Session ID, for a location dependent MBS session; + - if the NF Service Consumer is the SMF: + - requested action (i.e. Start or terminate MBS data reception); + - the (UPF) DL GTP-U F-TEID, to be used for starting or terminating MBS data reception, if unicast transport is used over N19mb. + - if the NF Service Consumer is the AMF: + - RAN Node ID; + - N2 MBS Session Management Container (see MBS Distribution Setup Request Transfer IE and MBS Distribution Release Request Transfer IE specified in clauses 9.3.5.7 and 9.3.5.10 of 3GPP TS 38.413 [20]), if an N2 MBS Session Management Container has been received from the NG-RAN; + - a Leave Indication, if it is the last NG-RAN controlled by the AMF serving the multicast MBS session. +- 2a. On success, a "200 OK" response shall be returned, if additional information needs to be returned in the response. The content of the POST response (`ContextUpdateRspData` structure) may contain the following parameters: + - if the NF Service Consumer is the SMF and it was requested to start MBS data reception: + - the GTP-U Common TEID (C-TEID, see 3GPP TS 29.281 [17]) and the related IP multicast source address of the MB-UPF, for data reception over N19mb using multicast transport, if no DL GTP-U F-TEID was received in the request for unicast transport; + - if the NF Service Consumer is the AMF: + - N2 MBS Session Management Container (see MBS Distribution Setup Response Transfer IE or MBS Distribution Setup Unsuccessful Transfer IE specified in clauses 9.3.5.8 and 9.3.5.9 of 3GPP TS 38.413 [20]), if an N2 MBS Session Management Container needs to be sent to the NG-RAN. + +If the MB-SMF supports a deployment where NG-U termination can be shared by multiple NG-RAN nodes, the MB-SMF shall check the information (e.g. NG-RAN Node ID, NG-U DL F-TEID, etc.) carried in the N2 MBS Session Management Container in step 1, and accordingly determine whether to maintain the existing shared NG-U tunnel or request the MB-UPF to establish new shared NG-U tunnel or release the existing shared NG-U tunnel, as specified in clause 7.2.1.4 and clause 7.2.2.4 of 3GPP TS 23.247 [14]. + +If the Leave indication was received in the request, the MB-SMF shall remove the information of the AMF from the context of the multicast MBS session. + +NOTE: The user plane from the MB-UPF to NG-RAN (for 5GC Shared MBS traffic delivery) and the user plane from MB-UPF to UPFs (5GC Individual MBS traffic delivery) may use multicast transport via a common GTP-U tunnel per MBS session or use unicast transport via separate GTP-U tunnels at NG-RAN or at UPF per MBS session. + +2b. Otherwise, the MB-SMF shall return a "204 No Content" response if no additional information needs to be returned in the response + +2c. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.3.2.4.2.2-2. + +#### 5.3.2.6 StatusSubscribe service operation + +##### 5.3.2.6.1 General + +The StatusSubscribe service operation shall be used by an NF Service Consumer (e.g. NEF, MBSF or AF) to create or to update a subscription to the MB-SMF notifications related to the status of an MBS session or, for a location dependent MBS session, the part of an MBS session within an MBS service area. + +NOTE: For a location dependent MBS service, one StatusSubscribe service operation is performed per MBS Service Area of the MBS session. + +##### 5.3.2.6.2 Subscription creation + +When the StatusSubscribe service operation is used for creating a subscription, the NF Service Consumer (e.g. NEF, MBSF or AF) shall subscribe to MB-SMF service notifications by using the HTTP POST method as shown in Figure 5.3.2.6.2-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an MB-SMF for subscription creation. The NF Service Consumer sends a POST request to the MB-SMF. The MB-SMF responds with either a 201 Created (StatusSubscribeRspData) or a 4xx/5xx (ProblemDetails) or 3xx response.](35127fe87029df6f5f0b2ee85f6193f1_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note left of NF Service Consumer: POST .../mbs-sessions/subscriptions + NF Service Consumer->>MB-SMF: 1. POST .../mbs-sessions/subscriptions (StatusSubscribeReqData) + Note right of MB-SMF: -2a. 201 Created (StatusSubscribeRspData) + MB-SMF-->>NF Service Consumer: -2a. 201 Created (StatusSubscribeRspData) + Note right of MB-SMF: -2b. 4xx/5xx (ProblemDetails) or 3xx + MB-SMF-->>NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an MB-SMF for subscription creation. The NF Service Consumer sends a POST request to the MB-SMF. The MB-SMF responds with either a 201 Created (StatusSubscribeRspData) or a 4xx/5xx (ProblemDetails) or 3xx response. + +Figure 5.3.2.6.2-1: Subscribing to MB-SMF notifications + +1. The NF Service Consumer shall send a POST request to the resource URI representing the "/subscriptions" collection resource in the MB-SMF (/mbs-sessions/subscriptions). The request body shall include the data indicating the type of notifications that the NF Service Consumer is interested in receiving. The content of the POST request (StatusSubscribeReqData data structure, see clause 6.2.6.2.7) shall contain: + +- the MBS Session ID (source specific IP multicast address or TMGI); +- Area Session ID, for a location dependent MBS session; +- the list of MBS session events requested to be subscribed. +- the Notification URI, indicating the address where the MB-SMF shall send the MBS session status notifications; and +- the NF instance ID of the subscribing NF, if available. + +The request body may also contain: + +- an expiry time suggested by the NF Service Consumer, representing the time span during which the subscription is desired to be kept active; and + +- a Notification Correlation ID indicating the correlation identity to be carried in event notifications generated by the subscription. +- 2a. On success, the MB-SMF shall return a "201 Created" response. The "Location" header shall be present and shall contain the URI of the created resource. The content of the POST response shall include a representation of the created subscription (StatusSubscribeRspData data structure, see clause 6.2.6.2.8), with the following parameters: +- MBS Session ID (source specific IP multicast address or TMGI); + - Area Session ID, for a location dependent MBS session; + - the list of MBS session events successfully subscribed; and + - the expiry time after which the subscription becomes invalid. +- The POST response may also contain: +- a list of event reports, if corresponding information is available. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.4.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in the same Table 6.2.3.4.3.1-3). + +##### 5.3.2.6.3 Subscription update + +When the StatusSubscribe service operation is used for updating a subscription, the NF Service Consumer (e.g. NEF, MBSF or AF) shall update its subscription to MB-SMF notifications by using the HTTP PATCH method as shown in Figure 5.3.2.6.3-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an MB-SMF for updating a subscription. The NF Service Consumer sends a PATCH request to the MB-SMF. The MB-SMF responds with either a 200 OK (StatusSubscription) or a 4xx/5xx (ProblemDetails) or 3xx response.](5793a44ffdadd039928e2f9fe6daae06_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note right of NF Service Consumer: 1. PATCH .../mbs-sessions/subscriptions/{subscriptionId} +(array(PatchItem)) + NF Service Consumer->>MB-SMF: Request + Note left of MB-SMF: 2a. 200 OK (StatusSubscription) + MB-SMF-->>NF Service Consumer: Response + Note left of MB-SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + MB-SMF-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an MB-SMF for updating a subscription. The NF Service Consumer sends a PATCH request to the MB-SMF. The MB-SMF responds with either a 200 OK (StatusSubscription) or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.3.2.6.2-1: Updating a subscription to MB-SMF notifications** + +1. The NF Service Consumer shall send a PATCH request to update the individual subscription resource at the MB-SMF (`/mbs-sessions/subscriptions/{subscriptionId}`). The message body contains an `array(PatchItem)`, where each `PatchItem` type indicates a requested change to the `MbsSessionSubscriptiondata` (see clause 5.2.4.3 in 3GPP TS 29.571 [18]). The following information may be requested to be modified with `array(PatchItem)` structure (see Table 6.2.3.5.3.1-2): + - Notification URI (callback URI), indicating the address where the MB-SMF shall send the notifications; + - Notification Correlation ID, indicating the correlation identity to be carried in event notifications generated by the subscription; + - New expiration time; and/or + - List of MBS Session events. +- 2a. On success, the MB-SMF shall return a "200 Ok" response with a representation of the modified subscription (`MbsSessionSubscription` data structure, see clause 5.2.4.3 in 3GPP TS 29.571 [18]). +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.5.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a `ProblemDetails` structure with the "cause" attribute set to one of the application error listed in the same Table 6.2.3.5.3.1-3. + +#### 5.3.2.7 StatusUnsubscribe + +##### 5.3.2.7.1 General + +The StatusUnsubscribe service operation shall be used by an NF Service Consumer (e.g. NEF, MBSF or AF) to unsubscribe from the MB-SMF notifications related to the status of the MBS session, or for a location dependent MBS session, of the part of an MBS session within an MBS service area. + +NOTE: For a location dependent multicast MBS service, the StatusUnsubscribe service operation is performed per MBS service area of the MBS session. + +The NF Service Consumer (e.g. NEF, MBSF or AF) shall unsubscribe from MB-SMF service notifications by using the HTTP DELETE method as shown in Figure 5.3.2.7.1-1. + +![Sequence diagram for Figure 5.3.2.7.1-1: Unsubscribing from MB-SMF notifications. The diagram shows two lifelines: NF Service Consumer and MB-SMF. The NF Service Consumer sends a DELETE request to the MB-SMF. The MB-SMF responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx response.](6f31cdb576d2f15c35c3f266e5f59211_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note left of NF Service Consumer: 1. DELETE .../mbs-sessions/subscriptions/{subscriptionId} + NF Service Consumer->>MB-SMF: 1. DELETE .../mbs-sessions/subscriptions/{subscriptionId} + Note right of MB-SMF: 2a. 204 No Content + MB-SMF-->>NF Service Consumer: 2a. 204 No Content + Note right of MB-SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + MB-SMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Figure 5.3.2.7.1-1: Unsubscribing from MB-SMF notifications. The diagram shows two lifelines: NF Service Consumer and MB-SMF. The NF Service Consumer sends a DELETE request to the MB-SMF. The MB-SMF responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx response. + +Figure 5.3.2.7.1-1: Unsubscribing from MB-SMF notifications + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the individual subscription document resource in the MB-SMF (/subscriptions/{subscriptionID}). +2. On success, the MB-SMF shall return a "204 No Content" response. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.5.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in the same Table 6.2.3.5.3.2-3. + +#### 5.3.2.8 StatusNotify + +##### 5.3.2.8.1 General + +The StatusNotify service operation shall be used by the MB-SMF to notify a subscribed NF Service Consumer (e.g. NEF, MBSF or AF) about the change in the status of the MBS session, or for a location dependent MBS session, of the part of an MBS session within an MBS service area. + +NOTE: For a location dependent multicast MBS service, the StatusNotify service operation is performed per MBS service area of the MBS session. + +The MB-SMF shall notify the NF Service Consumer (e.g. NEF, MBSF or AF) by using the HTTP POST method to the callback URI received earlier in the subscription as shown in Figure 5.3.2.8.1-1. + +![Sequence diagram for Figure 5.3.2.8.1-1: MB-SMF notifications. The diagram shows two lifelines: NF Service Consumer and MB-SMF. The MB-SMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx response.](836008eb3303ade9e269f93c04dc0a2e_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note right of MB-SMF: 1. POST {notifUri} (StatusNotifyReqData) + MB-SMF->>NF Service Consumer: 1. POST {notifUri} (StatusNotifyReqData) + Note left of NF Service Consumer: 2a. 204 No Content () + NF Service Consumer-->>MB-SMF: 2a. 204 No Content () + Note left of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>MB-SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Figure 5.3.2.8.1-1: MB-SMF notifications. The diagram shows two lifelines: NF Service Consumer and MB-SMF. The MB-SMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content or a 4xx/5xx (ProblemDetails) or 3xx response. + +Figure 5.3.2.8.1-1: MB-SMF notifications + +1. The MB-SMF shall send a POST request to the callback URI ({notifUri}) of the subscribed NF Service Consumer. The content of the POST request (StatusNotifyReqData data structure) shall contain: + - Notification Correlation ID, if this information is available in the MBS session status subscription; + - the list of MBS session events to be reported; + - When reporting a BROADCAST\_DELIVERY\_STATUS event: + - the new broadcast delivery status (e.g. the MBS session has been STARTED or TERMINATED); + - When reporting a INGRESS\_TUNNEL\_ADD\_CHANGE event: + - new ingress tunnel address used over the N6mb/Nmb9 reference point. +- 2a. On success, the MB-SMF shall return a "204 No Content" response. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.5.2.3.1-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in the same Table 6.2.5.2.3.1-2). + +#### 5.3.2.9 ContextStatusSubscribe + +##### 5.3.2.9.1 General + +The ContextStatusSubscribe service operation enables to create and modify a subscription to notifications of events about a multicast MBS session context. + +NOTE: For a location dependent MBS service, the ContextStatusSubscribe service operation is performed per MBS session. + +##### 5.3.2.9.2 Creation of a subscription + +The ContextStatusSubscribe service operation shall be used to request information (e.g. QoS information) about a multicast MBS session and subscribe to notifications of events about the multicast MBS session context. + +It is used in the following procedures: + +- Multicast session join and session establishment procedure (see clause 7.2.1.3 of 3GPP TS 23.247 [14]). + +The NF Service Consumer may subscribe to multiple events in a subscription. A subscription shall be specific to a multicast MBS session context. + +The NF Service Consumer (e.g. SMF) shall request information (e.g. QoS information) about a multicast MBS session and create a subscription to notification of events about the multicast MBS session context by using the HTTP POST method with the URI of the Subscriptions collection for MBS contexts resource as shown in Figure 5.3.2.9.2-1. + +![Sequence diagram showing the creation of a subscription. The NF Service Consumer sends a POST request to the MB-SMF. The MB-SMF responds with either a 201 Created response or a 4xx/5xx error response.](4412857e90dfaa9a3df8836bcbde534b_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note left of NF Service Consumer: NF Service Consumer + Note right of MB-SMF: MB-SMF + NF Service Consumer->>MB-SMF: 1. POST ../mbs-sessions/contexts/subscriptions (ContextStatusSubscribeReqData) + MB-SMF-->>NF Service Consumer: 2a. 201 Created (ContextStatusSubscribeRspData) + MB-SMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the creation of a subscription. The NF Service Consumer sends a POST request to the MB-SMF. The MB-SMF responds with either a 201 Created response or a 4xx/5xx error response. + +**Figure 5.3.2.9.2-1: Creation of a subscription for a multicast MBS session context** + +1. The NF Service Consumer shall send a POST request. The content of the POST request (ContextStatusSubscribeReqData structure) shall contain the description of the subscription requested to be created: + - NF Instance ID of the NF Service Consumer creating the subscription; + +- MBS Session ID (i.e. TMGI or source specific multicast address) being the target of the subscription; +- Event ID(s) of the events to which the NF service consumer requests to subscribe; and +- Notification URI, indicating the address where to send the events notifications generated by the subscription; + +The content of the POST request may further contain the following parameters: + +- Notification Correlation ID, indicating the correlation identity to be carried in event notifications generated by the subscription. +- For each subscribed event: + - Immediate Report Indication, to request to receive an immediate report in the response with the current event status; + - Reporting Mode, to indicate how event shall be reported (One-time Reporting or Continuous); +- Expiry time, indicating the time up to which the subscription is desired to be kept active and after which the subscribed events shall stop generating notifications. + +In this release of the specification, the SMF shall subscribe to the "QOS\_INFO", "STATUS\_INFO", "SERVICE\_AREA\_INFO", "SESSION\_RELEASE", "SECURITY\_INFO" and "MULT\_TRANS\_ADD\_CHANGE" events, with the Reporting Mode set to "Continuous event reporting". + +- 2a. On success, the MB-SMF shall return a "201 Created" response, with an HTTP Location header providing the URI of the newly created resource. + +The content of the POST response (ContextStatusSubscribeRspData structure) shall include a representation of the created subscription. If the NF Service Consumer has included more than one event in the subscription creation request and some of the events cannot be subscribed, the MB-SMF shall accept the request and indicate the successfully subscribed event(s) in the response. + +If the NF Service Consumer has requested an Immediate Report, the MB-SMF shall include the current status of the events subscribed in the response, if available: + +- list of MBS QoS flows to set up (in the qosFlowsAddModRequestList IE) for the multicast MBS session; +- multicast MBS session's status (activated/deactivated); +- multicast MBS session service area for local multicast service; and +- if security protection is applied, the multicast session security context containing MBS Service Key (MSK), MBS Traffic Key (MTK) and the corresponding key IDs. + +NOTE: No immediate report is generated for the MULT\_TRANS\_ADD\_CHANGE event type. + +If the NF Service Consumer has requested One-time Reporting and if the MB-SMF has included the current status of the events subscribed in the response, then the MB-SMF shall not do any subsequent event notification for the subscribed events. + +The content of the POST response shall also contain the following parameters: + +- the MBS Service Areas and their respective Area Session IDs, for a location dependent MBS session; or +- the MBS Service Area, for a local MBS session. + +The content of the POST response may also contain the following parameters: + +- start time of the multicast MBS session; +- the GTP-U Common TEID (C-TEID, see 3GPP TS 29.281 [17]) and the related IP multicast source address of the MB-UPF, for data reception over N19mb using multicast transport, if IP multicast transport may apply over N19mb; +- MBS session authorization information (i.e. indication whether the multicast MBS session allows any UE to join); + +- Expiry time after which the subscription becomes invalid, determined based on operator policies and taking into account the expiry time included in the request if any. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. The NF Service Consumer may update the subscription before the Expiry time to extend the subscription lifetime. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the MB-SMF. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.6.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.3.6.3.1-3. + +##### 5.3.2.9.3 Modification of a Subscription + +The ContextStatusSubscribe service operation shall be used to modify an existing subscription or extends the lifetime of an existing subscription to notifications of events about a multicast MBS session context. + +The NF Service Consumer shall modify the subscription by using HTTP method PATCH with the URI of the individual subscription resource to be modified as shown in Figure 5.3.2.9.3-1. + +![Sequence diagram showing the modification of a subscription. The NF Service Consumer sends a PATCH request to the MB-SMF. The MB-SMF responds with either a 200 OK (ContextStatusSubscription) or a 4xx/5xx (ProblemDetails) or 3xx response.](20136850feb70fd71c7d41cdae203ebb_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note right of NF Service Consumer: 1. PATCH .../mbs-sessions/contexts/subscriptions/{subscriptionId} (PatchData) + NF Service Consumer->>MB-SMF: Request + Note left of MB-SMF: 2a. 200 OK (ContextStatusSubscription) + MB-SMF-->>NF Service Consumer: Response 2a + Note left of MB-SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + MB-SMF-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram showing the modification of a subscription. The NF Service Consumer sends a PATCH request to the MB-SMF. The MB-SMF responds with either a 200 OK (ContextStatusSubscription) or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.3.2.9.3-1: Modification of a subscription for a multicast MBS session context** + +1. The NF Service Consumer shall send a PATCH request (PatchData) targeting the URI of the individual subscription resource to be modified. The content of the PATCH request shall contain the description of the modifications to apply to the subscription. The following information may be requested to be modified: + - NF Instance ID of the NF Service Consumer; + - Notification URI, indicating the address where to send the events notifications generated by the subscription; + - Event ID(s) of the events to which the NF service consumer requests to subscribe; + - Notification Correlation ID, indicating the correlation identity to be carried in event notifications generated by the subscription. + - Expiry time, indicating the time up to which the subscription is desired to be kept active and after which the subscribed events shall stop generating notifications. + +NOTE: A subscription can be modified e.g. when it is taken over by another SMF in the same SMF set, or before the Expiry time expires. + +- 2a. On success, the MB-SMF shall return a "200 OK" response, with the content (ContextStatusSubscription) containing a representation of the modified subscription. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.7.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.3.7.3.1-3. + +#### 5.3.2.10 ContextStatusUnSubscribe + +##### 5.3.2.10.1 General + +The ContextStatusUnSubscribe service operation shall be used to unsubscribe to notifications of events about a multicast MBS session context. + +NOTE: For a location dependent MBS service, the ContextStatusUnSubscribe service operation is performed per MBS session. + +The NF Service Consumer (e.g. SMF) shall unsubscribe to notification of events about a multicast MBS session context by using the HTTP DELETE method as shown in Figure 5.3.2.10.1-1. + +![Sequence diagram showing the deletion of a subscription for a multicast MBS session context. The NF Service Consumer sends a DELETE request to the MB-SMF. The MB-SMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response.](356eb99ab9489bbd647223390a913903_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note left of NF Service Consumer: 1. DELETE .../mbs-sessions/contexts/subscriptions/{subscriptionId} + NF Service Consumer->>MB-SMF: 1. DELETE .../mbs-sessions/contexts/subscriptions/{subscriptionId} + Note right of MB-SMF: 2a. 204 No Content + MB-SMF-->>NF Service Consumer: 2a. 204 No Content + Note right of MB-SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + MB-SMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the deletion of a subscription for a multicast MBS session context. The NF Service Consumer sends a DELETE request to the MB-SMF. The MB-SMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response. + +**Figure 5.3.2.10.1-1: Deletion of a subscription for a multicast MBS session context** + +1. The NF Service Consumer shall send a DELETE request (subscriptionId) targeting the subscription resource to be deleted. +- 2a. On success, the MB-SMF shall return a "204 No Content" response. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.7.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.3.7.3.2-3. + +#### 5.3.2.11 ContextStatusNotify + +##### 5.3.2.11.1 General + +The ContextStatusNotify service operation shall be invoked by the MB-SMF to send a notification about event(s), when events about the multicast MBS session context included in the subscription occur. + +NOTE: For a location dependent MBS service, the ContextStatusNotify service operation is performed per MBS session. + +It is used in the following procedures: + +- Multicast session leave requested by the network or MBS session release (see clause 7.2.2.3 of 3GPP TS 23.247 [14]); +- MBS session activation procedure (see clause 7.2.5.2 of 3GPP TS 23.247 [14]); +- MBS session deactivation procedure (see clause 7.2.5.3 of 3GPP TS 23.247 [14]); and +- Multicast session update procedure (see clause 7.2.6 of 3GPP TS 23.247 [14]). + +The MB-SMF shall notify event(s) about the multicast MBS session context by using the HTTP POST method targeting the notification URI received in the subscription as shown in Figure 5.3.2.11.1-1. + +![Sequence diagram showing the notification of a multicast MBS session context event. The NF Service Consumer sends a POST {notificationURI} (ContextStatusNotifyReqData) to the MB-SMF. The MB-SMF responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MB-SMF + Note left of NF Service Consumer: 1. POST {notificationURI} (ContextStatusNotifyReqData) + NF Service Consumer->>MB-SMF: 1. POST {notificationURI} (ContextStatusNotifyReqData) + Note right of MB-SMF: 2a. 204 No Content + MB-SMF-->>NF Service Consumer: 2a. 204 No Content + Note right of MB-SMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + MB-SMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the notification of a multicast MBS session context event. The NF Service Consumer sends a POST {notificationURI} (ContextStatusNotifyReqData) to the MB-SMF. The MB-SMF responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx. + +**Figure 5.3.2.11.1-1: Notification of a multicast MBS session context event** + +1. The MB-SMF shall send a POST request targeting the notification URI. The notification, i.e. the content of the POST request (ContextStatusNotifyReqData structure) shall contain the following information: + - Notification Correlation ID, if available in the subscription; + - List of event(s) which occurred; + - When reporting a MULT\_TRANS\_ADD\_CHANGE event: + - new multicast transport address (Low Layer SSM and C-TEID) used over the N19mb reference point; + - area session Id of the part of the location dependent MBS session for which the new multicast transport address is provided, for a location dependent MBS session; + - When reporting a QOS\_INFO event: + - list of MBS QoS flows to add, modify and/or release (in the qosFlowsAddModRequestList IE and/or qosFlowsRelRequestList) for the multicast MBS session. + - When reporting a SECURITY\_INFO event: + - if security protection is applied, the multicast session security context containing MBS Service Key (MSK), MBS Traffic Key (MTK) and the corresponding key IDs. +- 2a. On success, a "204 No Content" response shall be returned. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.5.3.3.1-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.5.3.3.1-2. + +# 6 API Definitions + +## 6.1 Nmbsmf\_TMGI Service API + +### 6.1.1 Introduction + +The Nmbsmf\_TMGI service shall use the Nmbsmf\_TMGI API. + +The API URI of the Nmbsmf\_TMGI API shall be: + +**{apiRoot}
** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nmbsmf-tmgi". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nmbsmf\_TMGI API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +Figure 6.1.3.1-1 describes the resource URI structure of the Nmbsmf\_TMGI API. + +![Diagram showing the resource URI structure of the Nmbsmf_TMGI API. The base URI is {apiRoot}/Nmbsmf-tmgi/. A line branches from the base URI to a rounded rectangle containing the path /tmgi.](e50de31fbc76748a552755ee72dfbf2f_img.jpg) + +``` +graph TD; A["{apiRoot}/Nmbsmf-tmgi/"] --> B["/tmgi"]; +``` + +Diagram showing the resource URI structure of the Nmbsmf\_TMGI API. The base URI is {apiRoot}/Nmbsmf-tmgi/. A line branches from the base URI to a rounded rectangle containing the path /tmgi. + +**Figure 6.1.3.1-1: Resource URI structure of the Nmbsmf\_TMGI API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | | +|-----------------------|--------------------------------------------|---------------------------------|---------------------------------|--| +| TMGI collection | /tmgis | POST | Allocate | | +| | | DELETE | Deallocate | | + +#### 6.1.3.2 Resource: TMGI collection + +##### 6.1.3.2.1 Description + +This resource represents the collection of the individual TMGI values that can be assigned by the MB-SMF. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nmbsmf-tmgis/{apiVersion}/tmgis + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method requests the MB-SMF to allocate one or more TMGIs with Nmbsmf\_TMGI\_Allocate service operation. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TmgiAllocate | M | 1 | Representation of one or more TMGIs to be allocated by the MB-SMF. The Request Body shall contain:
- the requested number of TMGIs (one or more), if TMGIs are requested to be allocated; or
- a list of TMGIs, if the expiration time of previously allocated TMGI(s) needs to be refreshed. | + +Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TmgiAllocated | C | 1 | 200 OK | Successful allocation of one or more TMGI(s) and their expiration time. Alternatively, if the expiration time of the previously allocated TMGI(s) needs to be refreshed, the Response Body shall contain the list of the TMGI(s) and their new expiration time. | +| ProblemDetails | O | 0..1 | 403 Forbidden | When used to represent an unsuccessful TMGI allocation or TMGI refreshment, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
- MANDATORY_IE_INCORRECT, if the required TMGI number for TMGI allocation is not valid. | +| ProblemDetails | O | 0..1 | 404 Not Found | When used to represent an unsuccessful TMGI allocation or TMGI refreshment, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
- UNKNOWN_TMGI, if the TMGI to be refreshed is expired or not found in the MB-SMF. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.1.3.2.3.1-4: Headers supported by the POST method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +Table 6.1.3.2.3.1-5: Headers supported by the 200 response code on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +Table 6.1.3.2.3.1-6: Links supported by the 200 Response Code on this endpoint + +| Name | Resource name | HTTP method or custom operation | Link parameter(s) | Description | +|------|---------------|---------------------------------|-------------------|-------------| +| | | | | | + +Table 6.1.3.2.3.1-7: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-8: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +###### 6.1.3.2.3.2 DELETE + +This method deallocates one or more of the previously allocated individual TMGIs in the MB-SMF with Nmbsmf\_TMGI\_Deallocate service operation. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.2-1. + +**Table 6.1.3.2.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|-----------|-------------|---|-------------|--------------------------------------------------------------|---------------| +| tmgi-list | array(Tmgi) | M | 1..N | The list of the TMGIs, which shall be deallocated by MB-SMF. | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.2.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful deletion of TMGI list. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | When used to represent an unsuccessful deletion of TMGI, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
  • - UNKNOWN_TMGI, if the TMGI to be deleted is not found in MB-SMF.
| + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.2-4: Headers supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +**Table 6.1.3.2.3.2-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.2-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.2.4 Resource Custom Operations + +None. + +### 6.1.4 Custom Operations without associated resources + +None. + +### 6.1.5 Notifications + +None. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nmbsmf\_TMGI service based interface protocol. + +**Table 6.1.6.1-1: Nmbsmf\_TMGI specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------|----------------|-----------------------------------|---------------| +| TmgiAllocate | 6.1.6.2.2 | TMGI Allocation Request Content. | | +| TmgiAllocated | 6.1.6.2.3 | TMGI Allocation Response Content. | | + +Table 6.1.6.1-2 specifies data types re-used by the Nmbsmf\_TMGI service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nmbsmf service based interface. + +**Table 6.1.6.1-2: Nmbsmf\_TMGI re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------|---------------------|--------------------------------------|---------------| +| Tmgi | 3GPP TS 29.571 [18] | TMGI | | +| DateTime | 3GPP TS 29.571 [18] | Date and time | | +| Nid | 3GPP TS 29.571 [18] | NID, which is used in SNPn scenarios | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: TmgiAllocate + +**Table 6.1.6.2.2-1: Definition of type TmgiAllocate** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tmgiNumber | integer | C | 0..1 | This IE shall be present if TMGI allocation is requested.
When present, this IE shall indicate the number of TMGIs requested to be allocated.
Minimum: 1. Maximum: 255. | | +| tmgiList | array(Tmgi) | C | 1..N | This IE shall be present if the expiration time of previously allocated TMGIs needs to be refreshed.
When present, this IE shall contain the list of TMGI(s) to be refreshed. | | + +##### 6.1.6.2.3 Type: TmgiAllocated + +**Table 6.1.6.2.3-1: Definition of type TmgiAllocated** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tmgiList | array(Tmgi) | M | 1..N | One or more TMGIs allocated by MB-SMF.
(NOTE) | | +| expirationTime | DateTime | M | 1 | Expiration time (in UTC) for the allocated TMGI(s).
(NOTE) | | +| nid | Nid | O | 0..1 | When present, this IE shall contain the NID, which together with the PLMN ID included in the TMGIs, identifies the SNPn which allocated the TMGIs. (see 3GPP TS 23.003 [7] and 3GPP TS 23.501 [8] clause 5.30.2.1). | | + +NOTE: This attribute is necessary if the MB-SMF allocates TMGI(s) and also if the MB-SMF refreshes the expiration time of earlier allocated TMGIs. + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The Nmbsmf\_TMGI API does not define any simple data types in this release of the specification. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +##### 6.1.6.3.3 Enumeration: + +The Nmbsmf\_TMGI API does not define any enumerations in this release of the specification. + +##### 6.1.6.3.4 Void + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +None. + +#### 6.1.6.5 Binary data + +None. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nmbsmf\_TMGI API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nmbsmf\_TMGI API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nmbsmf\_TMGI service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nmbsmf\_TMGI service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------| +| UNKNOWN_TMGI | 404 Not Found | The requested TMGI Allocate or TMGI Deallocate service operation failed, because requested TMGI expired or cannot be found. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nmbsmf\_TMGI API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nmbsmf\_TMGI API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nmbsmf\_TMGI API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nmbsmf\_TMGI service. + +The Nmbsmf\_TMGI API defines a single scope "nmbsmf-tmgi" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different MB-SMF service instance, within the same MB-SMF or a different MB-SMF of an MB-SMF set, e.g. when an MB-SMF service instance is part of an MB-SMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different MB-SMF producer instance will return the NF Instance ID of the new MB-SMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an MB-SMF within an MB-SMF set redirects a service request to a different MB-SMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new MB-SMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Nmbsmf\_MBSSession Service API + +### 6.2.1 Introduction + +The Nmbsmf\_MBSSession shall use the Nmbsmf\_MBSSession API. + +The API URI of the Nmbsmf\_MBSSession API shall be: + +**{apiRoot}
/** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nmbsmf\_mbssession". + +- The shall be "v1". +- The shall be set as described in clause 5.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nmbsmf\_MBSSession API is contained in Annex A. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". +- The "Problem Details" JSON object, as defined in IETF RFC 9457 [13], shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json". + +Multipart messages shall also be supported (see clause 6.2.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one binary body part with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.5.2.2.2-1 shall be supported. + +**Table 6.2.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| vnd.3gpp.ngap | Binary encoded content, encoding NG Application Protocol (NGAP) IEs, as specified in clause 9.3 of 3GPP TS 38.413 [20] (ASN.1 encoded). | +| NOTE: | Using 3GPP vendor content subtypes allows to describe the nature of the opaque content (i.e. NGAP information) without having to rely on metadata in the JSON content. | + +See clause 6.2.2.4 for the binary content supported in the binary body part of multipart messages. + +#### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +#### 6.2.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque N2 Information in the following service operations (and HTTP messages): + +- ContextUpdate Request and Response (POST). + +HTTP multipart messages shall include one JSON body part and one binary body parts comprising: + +- N2 MBS Session Management information (see clause 6.2.6.5). + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [21]) specifying the media type of the root body part, i.e. "application/json". + +NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [21]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [22]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +Figure 6.2.3.1-1 describes the resource URI structure of the Nmbsmf\_MBSSession API. + +![Resource URI structure of the Nmbsmf_MBSSession API diagram](144e1d61e8738b22dcf4a683f869ac6f_img.jpg) + +``` +graph TD; Root["{apiRoot}/nmbsmf-mbssession/{apiVersion}"] --- MBS["/mbs-sessions"]; MBS --- SessionRef["/{mbsSessionRef}"]; MBS --- Subscriptions1["/subscriptions"]; Subscriptions1 --- SubscriptionId1["/{subscriptionId}"]; MBS --- Contexts["/contexts"]; Contexts --- Update["/update"]; Contexts --- Subscriptions2["/subscriptions"]; Subscriptions2 --- SubscriptionId2["/{subscriptionId}"]; +``` + +The diagram illustrates the hierarchical structure of resource URIs for the Nmbsmf\_MBSSession API. It starts with a root path: {apiRoot}/nmbsmf-mbssession/{apiVersion}. From this root, three main branches emerge: /mbs-sessions, /contexts, and /subscriptions (under /mbs-sessions). The /mbs-sessions branch further splits into /{mbsSessionRef}, /subscriptions (which leads to /{subscriptionId}), and /contexts. The /contexts branch under /mbs-sessions splits into /update (represented by a dashed box) and /subscriptions (which leads to /{subscriptionId}). + +Resource URI structure of the Nmbsmf\_MBSSession API diagram + +Figure 6.2.3.1-1: Resource URI structure of the Nmbsmf\_MBSSession API + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI (relative path under API URI) | HTTP method or custom operation | Description (service operation) | +|--------------------------------------------|-------------------------------------------------------|---------------------------------|-------------------------------------------------------------| +| MBS sessions collection | /mbs-sessions | POST | Create | +| | /mbs-sessions/contexts/update | update (POST) | ContextUpdate | +| Individual MBS session | /mbs-sessions/{mbsSessionRef} | PATCH | Update | +| | | DELETE | Delete | +| Subscriptions collection for MBS sessions | /mbs-sessions/subscriptions | POST | StatusSubscribe (to create a subscription) (NOTE 1, NOTE 2) | +| Individual subscription for an MBS session | /mbs-sessions/subscriptions/{subscriptionId} | PATCH | StatusSubscribe (to update or renew a subscription) | +| | | DELETE | StatusUnsubscribe | +| Subscriptions collection for MBS contexts | /mbs-sessions/contexts/subscriptions | POST | ContextStatusSubscribe (to create a subscription) (NOTE 2) | +| Individual subscription for an MBS context | /mbs-sessions/contexts/subscriptions/{subscriptionId} | PATCH | ContextStatusSubscribe (to update or renew a subscription) | +| | | DELETE | ContextStatusUnsubscribe | + +NOTE 1: A subscription to an MBS session may be performed after the MBS session is created using the POST method on this resource, or alternatively during the creation of the MBS session. +NOTE 2: The StatusNotify and ContextStatusNotify service operations are defined in clause 6.2.6.1. + +#### 6.2.3.2 Resource: MBS sessions collection (Collection) + +##### 6.2.3.2.1 Description + +This resource represents the collection of the individual MBS sessions created in the MB-SMF. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nmbsmf-mbssession/{apiVersion}/mbs-sessions + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.2.1 | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 POST + +This method creates an individual MBS session resource in the MB-SMF. + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|---------------------------------------------------------------| +| CreateReqData | M | 1 | Representation of the MBS session to be created in the MB-SMF | + +**Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreateRspData | M | 1 | 201
Created | Successful creation of an MBS session | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | When used to represent an unsuccessful MBS session creation, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
  • - INVALID_MBS_SERVICE_INFO, if the provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient to perform MBS policy authorization, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23])
  • - FILTER_RESTRICTIONS_NOT_RESPECTED, if the MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [24] not being respected, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23])
  • - ERROR_INPUT_PARAMETERS, if the provided set of input parameters are incomplete, erroneous or missing necessary information to perform MBS policy control, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23])
| +| ExtProblemDetails | O | 0..1 | 403
Forbidden | When used to represent an unsuccessful MBS session creation, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
  • - MBS_SESSION_ALREADY_CREATED, if MBS session to be created has already been created in the MB-SMF.
  • - OVERLAPPING_MBS_SERVICE_AREA, if the new MBS service area overlaps with the service area of any MBS session with the same MBS session identifier.
  • - MBS_SERVICE_INFO_NOT_AUTHORIZED, if the provided MBS Service Information is not authorized to perform MBS policy authorization, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23])
  • - MBS_POLICY_CONTEXT_DENIED, if the request is rejected due to operator policies and/or local configuration, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23])
| + +| | | | | | +|------------------------------------------------------------------------------------------------------------------------------|---|------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProblemDetails | O | 0..1 | 404 Not Found | When used to represent an unsuccessful MBS session creation, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
- UNKNOWN_TMGI, if the TMGI indicated in the mbsSessionId IE is not found in the MB-SMF. This application error shall not apply to a location dependent broadcast MBS session if, based on operator's policy, the MB-SMF shall accept a TMGI value allocated by another MB-SMF. | +| NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | +| NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. | | | | | + +Table 6.2.3.2.3.1-4: Headers supported by the POST method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +Table 6.2.3.2.3.1-5: Headers supported by the 201 response code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nmbsmf-mbssession//mbs-sessions/{mbsSessionRef} | + +Table 6.2.3.2.3.1-6: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +Table 6.2.3.2.3.1-7: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +##### 6.2.3.2.4 Resource Custom Operations + +###### 6.2.3.2.4.1 Overview + +**Table 6.2.3.2.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|-------------------------------|--------------------|---------------------------------| +| update | /mbs-sessions/contexts/update | POST | ContextUpdate service operation | + +###### 6.2.3.2.4.2 Operation: update + +###### 6.2.3.2.4.2.1 Description + +See clause 5.3.2.5.1. + +###### 6.2.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.2.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.2.3.2.4.2.2-2. + +**Table 6.2.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|---------------------------------------| +| ContextUpdateReqData | M | 1 | Data within the ContextUpdate Request | + +**Table 6.2.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ContextUpdateRspData | M | 1 | 200 OK | Data in the ContextUpdate Response | +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | When used to represent an unsuccessful MBS session context update, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
- UNKNOWN_TMGI, if the TMGI provided in the request does not exist in the MB-SMF.
- UNKNOWN_MBS_SESSION, if the indicated MBS session is not found in the MB-SMF.
- UNKNOWN_MBS_SERVICE_AREA, if the MBS Area Session ID in the request cannot be found for a location dependent MBS session. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +#### 6.2.3.3 Resource: Individual MBS session (Document) + +##### 6.2.3.3.1 Description + +This resource represents an individual MBS session created in the MB-SMF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nmbsmf-mbssession//mbs-sessions/{mbsSessionRef} + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------------|-----------|----------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| mbsSessionRef | string | MBS session reference assigned by the MB-SMF during the Create service operation | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 PATCH + +This method updates an individual MBS session resource in the MB-SMF. + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | List of changes to be made to the MBS session resource (i.e. ExtMbsSession data type), according to the JSON PATCH format specified in IETF RFC 6902 [16]. | + +Table 6.2.3.3.3.1-3: Data structures supported by the PATCH Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful response | +| UpdateRspData | M | 1 | 200 OK | Successful update of the MBS session if additional information needs to be returned in the response. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | When used to represent an unsuccessful MBS session update, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
  • - INVALID_MBS_SERVICE_INFO, if the provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient to perform MBS policy authorization, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23])
  • - FILTER_RESTRICTIONS_NOT_RESPECTED, if the MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [24] not being respected, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23])
  • - ERROR_INPUT_PARAMETERS, if the provided set of input parameters are incomplete, erroneous or missing necessary information to perform MBS policy control, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23])
| +| ExtProblemDetails | O | 0..1 | 403 Forbidden | When used to represent an unsuccessful MBS session update, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
  • - MBS_SERVICE_INFO_NOT_AUTHORIZED, if the provided MBS Service Information is not authorized to perform MBS policy authorization, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23])
  • - MBS_POLICY_CONTEXT_DENIED, if the request is rejected due to operator policies and/or local configuration, e.g. if the PCF rejected the creation or update of an MBS Policy Association with the same error (see 3GPP TS 29.537 [23])
| +| ProblemDetails | O | 0..1 | 404 Not Found | When used to represent an unsuccessful MBS session update, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
  • - UNKNOWN_MBS_SESSION, if the indicated MBS session is not found in the MB-SMF.
  • - UNKNOWN_MBS_SERVICE_AREA, if the indicated MBS Area Session ID is not found for a location dependent MBS session.
| + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +##### 6.2.3.3.3.2 DELETE + +This method deletes an individual MBS session resource in the MB-SMF. + +This method shall support the URI query parameters specified in table 6.2.3.2.3.2-1. + +**Table 6.2.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3. + +**Table 6.2.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful response | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | When used to represent an unsuccessful MBS session delete, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
- UNKNOWN_MBS_SESSION, if the indicated MBS session is not found in the MB-SMF. | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +##### 6.2.3.3.4 Resource Custom Operations + +None. + +#### 6.2.3.4 Resource: Subscriptions collection for MBS sessions (Collection) + +##### 6.2.3.4.1 Description + +This resource represents the collection of the individual subscriptions for MBS sessions that are created in the MB-SMF with StatusSubscribe service operation. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nmbsmf-mbssession//mbs-sessions/subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 6.2.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.2.1 | + +##### 6.2.3.4.3 Resource Standard Methods + +###### 6.2.3.4.3.1 POST + +This method creates an individual subscription resource for an MBS session in the MB-SMF with StatusSubscribe service operation. + +This method shall support the URI query parameters specified in table 6.2.3.4.3.1-1. + +**Table 6.2.3.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.4.3.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3. + +**Table 6.2.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-----------------------------------------| +| StatusSubscribeReqData | M | 1 | Data within the StatusSubscribe Request | + +**Table 6.2.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| StatusSubscribeRspData | M | 1 | 201
Created | Data within the StatusSubscribe Response | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | When used to represent an unsuccessful subscription to MBS session, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
- UNKNOWN_MBS_SESSION, if the indicated MBS session is not found in the MB-SMF.
- UNKNOWN_MBS_SERVICE_AREA, if the requested MBS Area Session ID is not found for a location dependent MBS session. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.4.3.1-4: Headers supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +**Table 6.2.3.4.3.1-5: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nmbsmf-mbssession//mbs-sessions/subscriptions/{subscriptionId} | + +**Table 6.2.3.4.3.1-6: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.4.3.1-7: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +##### 6.2.3.4.4 Resource Custom Operations + +None. + +#### 6.2.3.5 Resource: Individual subscription for an MBS session (Document) + +##### 6.2.3.5.1 Description + +This resource represents an individual subscription for an MBS session in the MB-SMF, which are updated with StatusSubscribe service operation, or are deleted with StatusUnsubscribe service operation. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.2.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nmbsmf-mbssession//mbs-sessions/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.5.2-1. + +**Table 6.2.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| subscriptionId | string | Subscription identifier assigned by the MB-SMF during the creation of the subscription | + +##### 6.2.3.5.3 Resource Standard Methods + +###### 6.2.3.5.3.1 PATCH + +This method updates an individual subscription resource for an MBS session in the MB-SMF with StatusSubscribe service operation for the subscription update (see clause 5.3.2.6.3). + +This method shall support the URI query parameters specified in table 6.2.3.5.3.1-1. + +**Table 6.2.3.5.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.5.3.1-2 and the response data structures and response codes specified in table 6.2.3.5.3.1-3. + +**Table 6.2.3.5.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It shall contain the list of changes to be made to the Status Subscription (i.e. MbsSessionSubscription data type), according to the JSON PATCH format specified in IETF RFC 6902 [16]. | + +**Table 6.2.3.5.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------| +| MbsSessionSubscription | M | 1 | 200 OK | Upon success, a response body shall be returned containing the updated Status Subscription. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.5.3.1-4: Headers supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +**Table 6.2.3.5.3.1-5: Headers supported by the 200 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +**Table 6.2.3.5.3.1-6: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.5.3.1-7: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +###### 6.2.3.5.3.2 DELETE + +This method deletes an individual subscription resource for an MBS session in the MB-SMF with StatusUnsubscribe service operation. + +This method shall support the URI query parameters specified in table 6.2.3.5.3.2-1. + +**Table 6.2.3.5.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.5.3.2-2 and the response data structures and response codes specified in table 6.2.3.5.3.2-3. + +**Table 6.2.3.5.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.5.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | Successful deletion | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.5.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.5.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +##### 6.2.3.5.4 Resource Custom Operations + +None. + +#### 6.2.3.6 Resource: Subscriptions collection for MBS contexts (Collection) + +##### 6.2.3.6.1 Description + +This resource represents the collection of the individual subscriptions for MBS contexts created in the MB-SMF. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.2.3.6.2 Resource Definition + +Resource URI: {apiRoot}/nmbsmf-mbssession//mbs-sessions/contexts/subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.6.2-1. + +**Table 6.2.3.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.2.1 | + +##### 6.2.3.6.3 Resource Standard Methods + +###### 6.2.3.6.3.1 POST + +This method creates an individual subscription resource for an MBS context in the MB-SMF. + +This method shall support the URI query parameters specified in table 6.2.3.6.3.1-1. + +**Table 6.2.3.6.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.6.3.1-2 and the response data structures and response codes specified in table 6.2.3.6.3.1-3. + +**Table 6.2.3.6.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|------------------------------------------------| +| ContextStatusSubscribeReq Data | M | 1 | Data within the ContextStatusSubscribe Request | + +**Table 6.2.3.6.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ContextStatusSubscribeRsp Data | M | 1 | 201 Created | Data within the ContextStatusSubscribe Response | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | When used to represent an unsuccessful subscription to MBS session context, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
- UNKNOWN_MBS_SESSION, if indicated the MBS session is not found in the MB-SMF. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.6.3.1-4: Headers supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +**Table 6.2.3.6.3.1-5: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nmbsmf-mbssession//mbs-sessions/contexts/subscriptions/{subscriptionId} | + +**Table 6.2.3.6.3.1-6: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.6.3.1-7: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +##### 6.2.3.6.4 Resource Custom Operations + +None. + +#### 6.2.3.7 Resource: Individual subscription for an MBS context (Document) + +##### 6.2.3.7.1 Description + +This resource represents an individual subscription for an MBS context created in the MB-SMF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.2.3.7.2 Resource Definition + +Resource URI: {apiRoot}/nmbsmf-mbssession/{apiVersion}/mbs-sessions/contexts/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.7.2-1. + +**Table 6.2.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| subscriptionId | string | Subscription identifier assigned by the MB-SMF during the creation of the subscription | + +##### 6.2.3.7.3 Resource Standard Methods + +###### 6.2.3.7.3.1 PATCH + +This method modifies an individual subscription resource for an MBS context in the MB-SMF. + +This method shall support the URI query parameters specified in table 6.2.3.7.3.1-1. + +**Table 6.2.3.7.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.7.3.1-2 and the response data structures and response codes specified in table 6.2.3.7.3.1-3. + +**Table 6.2.3.7.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It shall contain the list of changes to be made to the Context Status Subscription (i.e. ContextStatusSubscription data type), according to the JSON PATCH format specified in IETF RFC 6902 [16]. | + +**Table 6.2.3.7.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------| +| ContextStatusSubscription | M | 1 | 200 OK | Upon success, a response body shall be returned containing the updated Context Status Subscription. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.7.3.1-4: Headers supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +**Table 6.2.3.7.3.1-5: Headers supported by the 200 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +**Table 6.2.3.7.3.1-6: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.7.3.1-7: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +###### 6.2.3.7.3.2 DELETE + +This method deletes an individual subscription resource for an MBS context in the MB-SMF. + +This method shall support the URI query parameters specified in table 6.2.3.7.3.1-1. + +**Table 6.2.3.7.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.7.3.1-2 and the response data structures and response codes specified in table 6.2.3.7.3.1-3. + +**Table 6.2.3.7.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.7.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | Successful deletion | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.7.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.7.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MB-SMF or MB-SMF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-SMF (service) instance ID towards which the request is redirected | + +##### 6.2.3.7.4 Resource Custom Operations + +None. + +### 6.2.4 Custom Operations without associated resources + +None + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.2.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------|--------------|---------------------------------|---------------------------------| +| Status Notification | {notifUri} | POST | StatusNotify | +| Context Status Notification | {notifUri} | POST | ContextStatusNotify | + +#### 6.2.5.2 StatusNotify + +##### 6.2.5.2.1 Description + +The Event Notification is used by the MB-SMF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications. + +##### 6.2.5.2.2 Target URI + +The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 6.2.5.2.2-1. + +**Table 6.2.5.2.2-1: Callback URI variables** + +| Name | Definition | +|----------|-----------------------------------------------| +| notifUri | String formatted as URI with the Callback Uri | + +##### 6.2.5.2.3 Standard Methods + +###### 6.2.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.2.5.2.3.1-1 and the response data structures and response codes specified in table 6.2.5.2.3.1-2. + +**Table 6.2.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|--------------------------------------| +| StatusNotifyReqData | M | 1 | Data within the StatusNotify Request | + +**Table 6.2.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------| +| n/a | | | 204 No Content | Successful response | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 6.2.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.2.5.3 ContextStatusNotify + +##### 6.2.5.3.1 Description + +The Event Notification is used by the MB-SMF to report one or several observed Events to a NF Service Consumer that has subscribed to such notifications. + +##### 6.2.5.3.2 Target URI + +The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 6.2.5.3.2-1. + +**Table 6.2.5.3.2-1: Callback URI variables** + +| Name | Definition | +|----------|-----------------------------------------------| +| notifUri | String formatted as URI with the Callback URI | + +##### 6.2.5.3.3 Standard Methods + +###### 6.2.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.2.5.3.3.1-1 and the response data structures and response codes specified in table 6.2.5.3.3.1-2. + +**Table 6.2.5.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|---------------------------------------------| +| ContextStatusNotifyReqData | M | 1 | Data within the ContextStatusNotify Request | + +**Table 6.2.5.3.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------| +| n/a | | | 204 No Content | Successful response | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 6.2.5.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.5.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nmbsmf\_MBSSession service based interface protocol. + +Table 6.2.6.1-1: Nmbsmf\_MBSSession specific Data Types + +| Data type | Clause defined | Description | Applicability | +|-------------------------------------|----------------|----------------------------------------------------------------------------------------------------------------------------------|---------------| +| CreateReqData | 6.2.6.2.2 | Data within the Create Request | | +| CreateRspData | 6.2.6.2.3 | Data within the Create Response | | +| MbsSessionExtension | 6.2.6.2.4 | MB-SMF API specific MbsSession data type extensions | | +| ContextUpdateReqData | 6.2.6.2.5 | Data within the ContextUpdate Request | | +| ContextUpdateRspData | 6.2.6.2.6 | Data within the ContextUpdate Response | | +| StatusSubscribeReqData | 6.2.6.2.7 | Data within the Create Subscription Request for the collection of MBS Session subscriptions (StatusSubscribe service operation). | | +| StatusSubscribeRspData | 6.2.6.2.8 | Data within the Create Subscription Response (StatusSubscribe service operation). | | +| N2MbsSmInfo | 6.2.6.2.9 | N2 MBS Session Management Information | | +| ContextStatusNotifyReqData | 6.2.6.2.10 | Data within ContextStatusNotify Request | | +| StatusNotifyReqData | 6.2.6.2.11 | Data within StatusNotify Request | | +| ContextStatusSubscribeReqData | 6.2.6.2.12 | Data within ContextStatusSubscribe Request | | +| ContextStatusSubscription | 6.2.6.2.13 | Context Status Subscription | | +| ContextStatusEvent | 6.2.6.2.14 | Context Status Event | | +| ContextStatusSubscribeRspData | 6.2.6.2.15 | Data within ContextStatusSubscribe Response | | +| MbsContextInfo | 6.2.6.2.16 | MBS Context Information | | +| ContextStatusEventReport | 6.2.6.2.17 | Context Status Event Report | | +| MulticastTransportAddressChangeInfo | 6.2.6.2.18 | Multicast Transport Address Change Information | | +| QosInfo | 6.2.6.2.19 | QoS Information | | +| QosFlowAddModifyRequestItem | 6.2.6.2.20 | Individual MBS QoS flow requested to be created or modified | | +| QosFlowProfile | 6.2.6.2.21 | MBS QoS flow profile | | +| GbrQosFlowInformation | 6.2.6.2.22 | GBR MBS QoS flow information | | +| ProblemDetailsExtension | 6.2.6.2.23 | Extensions to the ProblemDetails common data | | +| UpdateRspData | 6.2.6.2.24 | Data within the Update Response | | +| ContextUpdateAction | 6.2.6.3.3 | The requested action for the MBS session context | | +| ContextStatusEventType | 6.2.6.3.4 | Context Status Event Type | | +| ReportingMode | 6.2.6.3.5 | Reporting Mode | | +| NgapleType | 6.2.6.3.6 | NGAP Information Element Type | | +| ExtMbsSession | 6.2.6.4.1 | MbsSession common data type extended with MB-SMF API specific extensions | | +| ExtProblemDetails | 6.2.6.4.2 | ProblemDetails common data type with extensions | | + +Table 6.2.6.1-2 specifies data types re-used by the Nmbsmf\_MBSSession service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nmbsmf\_MBSSession service based interface. + +**Table 6.2.6.1-2: Nmbsmf\_MBSsession re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------------------|---------------------|------------------------------------------------------------------------------------------------------------|----------------------| +| MbsSession | 3GPP TS 29.571 [18] | MBS session | | +| Tmgi | 3GPP TS 29.571 [18] | TMGI | | +| TunnelAddress | 3GPP TS 29.571 [18] | Tunnel Address (UDP/IP) | | +| MbsSessionId | 3GPP TS 29.571 [18] | MBS Session Identifier | | +| AreaSessionId | 3GPP TS 29.571 [18] | Area Session Identifier used for MBS session with location dependent content | | +| AreaSessionPolicyId | 3GPP TS 29.571 [18] | Area Session Policy Identifier used for MBS session with location dependent content | | +| Ssm | 3GPP TS 29.571 [18] | Source specific IP multicast address | | +| Uint32 | 3GPP TS 29.571 [18] | Unsigned 32-bit integer | | +| NfInstanceId | 3GPP TS 29.571 [18] | NF Instance Identifier | | +| Bytes | 3GPP TS 29.571 [18] | Base64-encoded characters | | +| RefToBinaryData | 3GPP TS 29.571 [18] | Cross-Reference to binary data encoded within a binary body part in an HTTP multipart message | | +| GlobalRanNodeId | 3GPP TS 29.571 [18] | Global RAN Node Identity | | +| DateTime | 3GPP TS 29.571 [18] | Date and time | | +| Uri | 3GPP TS 29.571 [18] | URI | | +| MbsSessionActivityStatus | 3GPP TS 29.571 [18] | MBS Session Activity Status | | +| MbsServiceArea | 3GPP TS 29.571 [18] | MBS Service Area | | +| MbsServiceAreaInfo | 3GPP TS 29.571 [18] | MBS Service Area Information for a location dependent MBS session | | +| MbsSessionSubscription | 3GPP TS 29.571 [18] | MBS Session Subscription | | +| MbsSessionEventReportList | 3GPP TS 29.571 [18] | MBS Session Event Report List | | +| Qfi | 3GPP TS 29.571 [13] | QoS Flow Identifier | | +| Arp | 3GPP TS 29.571 [13] | Allocation and Retention Priority | | +| Dynamic5Qi | 3GPP TS 29.571 [13] | QoS characteristics for a 5QI that is neither standardized nor pre-configured. | | +| NonDynamic5Qi | 3GPP TS 29.571 [13] | QoS characteristics that replace the default QoS characteristics for a standardized or pre-configured 5QI. | | +| 5Qi | 3GPP TS 29.571 [13] | 5G QoS Identifier | | +| BitRate | 3GPP TS 29.571 [13] | Bit rate | | +| PacketLossRate | 3GPP TS 29.571 [13] | Packet loss rate | | +| MbsSecurityContext | 3GPP TS 29.571 [18] | MBS Security Context | | +| AcceptableMbsServInfo | 3GPP TS 29.537 [23] | MBS Service Information that can be accepted by the PCF | | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: CreateReqData + +**Table 6.2.6.2.2-1: Definition of type CreateReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|------------------|----------|--------------------|---------------------------|----------------------| +| mbsSession | ExtMbsSession | M | 1 | MBS session to be created | | + +##### 6.2.6.2.3 Type: CreateRspData + +Table 6.2.6.2.3-1: Definition of type CreateRspData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-----------------------------------------------------------|---------------| +| mbsSession | ExtMbsSession | M | 1 | Representation of the created MBS session | | +| eventList | MbsSessionEventReportList | C | 0..1 | Event reports, if corresponding information is available. | | + +##### 6.2.6.2.4 Type: MbsSessionExtension + +Table 6.2.6.2.4-1: Definition of type MbsSessionExtension + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsSecurityContext | MbsSecurityContext | O | 0..1 | This IE may be present if security protection is applied to the MBS Session. When present, it shall contain the MBS Service Key (MSK), MBS Traffic Key (MTK) and the corresponding key IDs. | | +| contactPcfInd | boolean | O | 0..1 | Indicates whether the PCF shall be contacted or not, i.e.:
  • - "true" means that the PCF shall be contacted; and
  • - "false" means that the PCF shall not be contacted.
When this attribute is not present, the default value is "false".

This attribute may only be present in an MBS Session update request. | | +| areaSessionPolicyId | AreaSessionPolicyId | C | 0..1 | This IE shall be present for a location-dependent MBS session if the AF/NEF/MBSF has obtained the Area Session Policy ID from the PCF (see clause 7.1.1.3 of 3GPP TS 23.247 [14]). When present, it shall contain the Area Session Policy ID assigned by the PCF to the location-dependent MBS session. | | + +##### 6.2.6.2.5 Type: ContextUpdateReqData + +Table 6.2.6.2.5-1: Definition of type ContextUpdateReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| nfcInstanceId | NfcInstanceId | M | 1 | NF Instance ID of the NF Service Consumer (e.g. AMF or SMF) | | +| mbsSessionId | MbsSessionId | M | 1 | MBS session identifier (TMGI and/or SSM, and NID for an SNPN) | | +| areaSessionId | AreaSessionId | C | 0..1 | This IE shall be present if this is a location dependent multicast MBS session. | | +| requestedAction | ContextUpdateAction | C | 0..1 | This IE shall be set by an SMF. When present, this IE shall indicate whether to start or terminate MBS data reception. | | +| dlTunnelInfo | Bytes | C | 0..1 | This IE shall be included by the SMF if the mbsSessionId IE is present and unicast transport is used over N19mb.
When present, it shall contain Base64-encoded characters, encoding the DL F-TEID of the UPF as specified in Figure 8.22-1 of 3GPP TS 29.274 [19] (starting from octet 1).
(NOTE) | | +| n2MbsSmInfo | N2MbsSmInfo | C | 0..1 | This IE shall be included by the AMF if N2 MBS Session Management Information (container) needs to be sent to the MB-SMF. | | +| ranNodeId | GlobalRanNodeId | C | 0..1 | This IE shall be included by the AMF. When present, it shall indicate the RAN Node ID of the RAN having sent the N2 information. | | +| leaveInd | boolean | C | 0..1 | Leave Indication
This IE shall be included by the AMF and set to true during a Release of shared delivery toward RAN node procedure, if it is the last NG-RAN controlled by the AMF serving the multicast MBS session.

- true: the AMF does not control any more NG-RAN node for the multicast MBS session. | | + +NOTE: The SMF shall set the Interface Type in octet 5 indicating N19mb as specified in clause 8.22 of 3GPP TS 29.274 [19]. + +##### 6.2.6.2.6 Type: ContextUpdateRspData + +Table 6.2.6.2.6-1: Definition of type ContextUpdateRspData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| l1Ssm | Ssm | C | 0..1 | This IE shall be present if the n2Info IE is absent and multicast transport is used over N19mb.
When present, it shall contain the Low Layer Source Specific Multicast Address allocated by the MB-UPF. | | +| cTeid | Uint32 | C | 0..1 | This IE shall be present if the n2Info IE is absent and multicast transport is used over N19mb.
When present, it shall contain the Common TEID allocated by the MB-UPF. | | +| n2MbsSmInfo | N2MbsSmInfo | C | 0..1 | This IE shall be present if N2 MBS Session Management Information (container) needs to be sent to the NF Service Consumer. | | + +6.2.6.2.7 Type: StatusSubscribeReqData + +**Table 6.2.6.2.7-1: Definition of type StatusSubscribeReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|----------------------------------------------|---------------| +| subscription | MbsSessionSubscription | M | 1 | MbsSession Status subscription to be created | | + +6.2.6.2.8 Type: StatusSubscribeRspData + +**Table 6.2.6.2.8-1: Definition of type StatusSubscribeRspData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|----------------------------------------------------------|---------------| +| subscription | MbsSessionSubscription | M | 1 | MBS Session Status subscription created | | +| eventList | MbsSessionEventReportList | C | 0..1 | Event reports if corresponding information is available. | | + +6.2.6.2.9 Type: N2MbsSmInfo + +**Table 6.2.6.2.9-1: Definition of type N2MbsSmInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------|---------------| +| ngapType | NgapType | M | 1 | This IE shall indicate the NGAP IE type of the ngapData as specified in clause 6.2.6.3.6. | | +| ngapData | RefToBinaryData | M | 1 | This IE shall contain the reference to the binary data part carrying the NGAP data. See clause 6.2.6.5.2 for details. | | + +6.2.6.2.10 Type: ContextStatusNotifyReqData + +**Table 6.2.6.2.10-1: Definition of type ContextStatusNotifyReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------|---------------| +| reportList | array(ContextStatusEventReport) | M | 1..N | Events to be reported | | +| notifyCorrelationId | string | C | 0..1 | Notification Correlation ID.
This IE shall be present if a Notification Correlation ID is available in the subscription. | | + +6.2.6.2.11 Type: StatusNotifyReqData + +**Table 6.2.6.2.11-1: Definition of type StatusNotifyReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-----------------------------|---------------| +| eventList | MbsSessionEventReportList | M | 1 | Reported MBS session events | | + +6.2.6.2.12 Type: ContextStatusSubscribeReqData + +**Table 6.2.6.2.12-1: Definition of type ContextStatusSubscribeReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-------------------------------------------|---------------| +| subscription | ContextStatusSubscription | M | 1 | Context Status subscription to be created | | + +6.2.6.2.13 Type: ContextStatusSubscription + +**Table 6.2.6.2.13-1: Definition of type ContextStatusSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| nfInstanceId | NfInstanceId | M | 1 | NF Instance ID of the NF Service Consumer | | +| mbsSessionId | MbsSessionId | M | 1 | MBS Session Identifier (i.e. TMGI or source specific IP multicast address) | | +| eventList | array(ContextStatusEvent) | M | 1..N | Events subscribed | | +| notifyUri | Uri | M | 1 | URI where to send event notifications | | +| notifyCorrelationId | string | O | 0..1 | Notification Correlation ID | | +| expiryTime | DateTime | O | 0..1 | When present in a subscription creation or modification request, it shall indicate the time (in UTC) up to which the subscription is desired to be kept active and after which the subscribed events shall stop generating notifications.

When present in a subscription or modification response, it shall indicate the expiry time after which the subscription becomes invalid. | | + +6.2.6.2.14 Type: ContextStatusEvent + +**Table 6.2.6.2.14-1: Definition of type ContextStatusEvent** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventType | ContextStatusEventType | M | 1 | MBS session context status event type (NOTE) | | +| immediateReportInd | boolean | O | 0..1 | Immediate Report Indication
When present, it shall be set as follows:
- true: an immediate report is requested

- false (default): no immediate report is requested | | +| reportingMode | ReportingMode | O | 0..1 | When present, it shall indicate whether the events shall be reported continuously or one time only. (NOTE) | | + +NOTE: In this release of the specification, the SMF shall subscribe to the "QOS\_INFO", "STATUS\_INFO", "SERVICE\_AREA\_INFO", "SECURITY\_INFO", "SESSION\_RELEASE" and "MULT\_TRANS\_ADD\_CHANGE" events, with the Reporting Mode set to "Continuous event reporting". + +6.2.6.2.15 Type: ContextStatusSubscribeRspData + +**Table 6.2.6.2.15-1: Definition of type ContextStatusSubscribeRspData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------|---------------| +| subscription | ContextStatusSubscription | M | 1 | Representation of the Context Status Subscription resource that has been created. | | +| reportList | Array(ContextStatusEventReport) | C | 1..N | Immediate event reports, if requested in the request and if corresponding information is available. | | +| mbsContextInfo | MbsContextInfo | O | 0..1 | MBS context information | | + +6.2.6.2.16 Type: MbsContextInfo + +**Table 6.2.6.2.16-1: Definition of type MbsContextInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| startTime | DateTime | O | 0..1 | Start time (in UTC) of the multicast MBS session | | +| anyUeInd | boolean | O | 0..1 | Indication that the multicast MBS session allows any UE to join.
When present, it shall be set as follows:
- true: any UE may join

- false (default): the MBS session is not open to any UE | | +| llSsm | Ssm | O | 0..1 | This IE may be present if multicast transport may be used over N19mb.
When present, it shall contain the Low Layer Source Specific Multicast Address allocated by the MB-UPF. | | +| cTeid | Uint32 | O | 0..1 | This IE may be present if multicast transport may be used over N19mb.
When present, it shall contain the Common TEID allocated by the MB-UPF. | | +| mbsServiceArea | MbsServiceArea | C | 0..1 | This IE shall be present for a Local MBS session. | | +| mbsServiceAreaInfoList | map(MbsServiceAreaInfo) | C | 1..N | This IE shall be present for a location dependent MBS service.
When present, one map entry shall be provided for each MBS Service Area served by the MBS session.
The key of the map shall be the areaSessionId. | | + +##### 6.2.6.2.17 Type: ContextStatusEventReport + +Table 6.2.6.2.17-1: Definition of type ContextStatusEventReport + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|-------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventType | ContextStatusEventType | M | 1 | MBS session context status event type | | +| timeStamp | DateTime | M | 1 | This IE shall contain the time (in UTC) at which the event is generated. | | +| qosInfo | QosInfo | C | 0..1 | This IE shall be present if the eventType IE indicates "QOS_INFO". | | +| statusInfo | MbsSessionActivityStatus | C | 0..1 | This IE shall be present if the eventType IE indicates "STATUS_INFO". | | +| mbsServiceArea | MbsServiceArea | C | 0..1 | This IE shall be present for a Local MBS session if the eventType IE indicates "SERVICE_AREA_INFO".
The receiver of this IE shall overwrite any previously stored value with the value received in this IE. | | +| mbsServiceAreaInfoList | map(MbsServiceAreaInfo) | C | 1..N | This IE shall be present for a location dependent MBS service if the eventType IE indicates "SERVICE_AREA_INFO".
When present, one map entry shall be provided for each MBS Service Area served by the MBS session.
The key of the map shall be the areaSessionId.
The receiver of this IE shall overwrite any previously stored value with the value received in this IE. | | +| multicastTransAddrInfo | MulticastTransportAddressChangeInfo | C | 0..1 | Multicast Transport Address Change Information
This IE shall be present if the eventType IE indicates "MULT_TRANS_ADD_CHANGE". | | +| mbsSecurityContext | MbsSecurityContext | C | 0..1 | This IE shall be present in the eventType IE indicates "SECURITY_INFO".
The receiver of this IE shall overwrite any previously stored value with the value received in this IE. | | + +##### 6.2.6.2.18 Type: MulticastTransportAddressChangeInfo + +Table 6.2.6.2.18-1: Definition of type MulticastTransportAddressChangeInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| lISsm | Ssm | M | 1 | This IE shall indicate the new multicast transport address (i.e. source IP address and destination multicast address) allocated by the MB-UPF to receive the MBS session data over the N19mb reference point. | | +| cTeid | Uint32 | M | 1 | This IE shall contain the new Common TEID allocated by the MB-UPF to receive the MBS session data over the N19mb reference point. | | +| areaSessionId | AreaSessionId | C | 0..1 | This IE shall be present for a location dependent MBS session.
When present, it shall indicate the Area Session ID of the part of the location dependent MBS session for which the new multicast transport address is provided. | | + +6.2.6.2.19 Type: QosInfo + +**Table 6.2.6.2.19-1: Definition of type QosInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| qosFlowsAddModRequestList | array(QosFlowAddModifyRequestItem) | C | 1..N | This IE shall be present if the eventType IE indicates "QOS_INFO" and MBS QoS flows are requested to be established or modified. | | +| qosFlowsRelRequestList | array(Qfi) | C | 1..N | This IE shall be present if the eventType IE indicates "QOS_INFO" and MBS QoS flows are requested to be released. When present, it shall indicate the MBS QoS flows to be released. | | + +6.2.6.2.20 Type: QosFlowAddModifyRequestItem + +**Table 6.2.6.2.20-1: Definition of type QosFlowAddModifyRequestItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| qfi | Qfi | M | 1 | This IE shall contain the MBS QoS Flow Identifier. | | +| qosFlowProfile | QosFlowProfile | O | 0..1 | When present, this IE shall contain the description of the MBS QoS Flow level QoS parameters. When modifying an MBS QoS flow, the IE shall only contain the MBS QoS Flow profile's attributes which are modified. | | + +6.2.6.2.21 Type: QosFlowProfile + +**Table 6.2.6.2.21-1: Definition of type QosFlowProfile** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5qi | 5Qi | M | 1 | This IE shall contain the 5G QoS Identifier (5QI) of the MBS QoS flow. | +| nonDynamic5Qi | NonDynamic5Qi | C | 0..1 | When present, this IE shall indicate the QoS Characteristics for a standardized or pre-configured 5QI for downlink. (NOTE) | +| dynamic5Qi | Dynamic5Qi | C | 0..1 | When present, this IE shall indicate the QoS Characteristics for a Non-standardised or not pre-configured 5QI for downlink. (NOTE) | +| arp | Arp | C | 0..1 | This IE shall be present when establishing an MBS QoS flow; it may be present when modifying an MBS QoS flow. When present, this IE shall contain the Allocation and Retention Priority (ARP) assigned to the MBS QoS flow. | +| gbrQosFlowInfo | GbrQosFlowInformation | C | 0..1 | This IE shall be present when establishing a GBR MBS QoS flow or if the GBR MBS QoS flow information is modified. | + +NOTE: Either the nonDynamic5Qi IE or the dynamic5Qi IE may be present when establishing a QoS flow. Either the nonDynamic5Qi IE or the dynamic5Qi IE may be present when modifying a QoS flow; when present, the received nonDynamic5Qi IE or dynamic5Qi IE shall replace any value received previously for this IE. + +6.2.6.2.22 Type: GbrQosFlowInformation + +**Table 6.2.6.2.22-1: Definition of type GbrQosFlowInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|----------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| maxFbrDI | BitRate | M | 1 | Maximum Bit Rate in Downlink. See 3GPP TS 23.501 [2]. | +| guaFbrDI | BitRate | M | 1 | Guaranteed Bit Rate in Downlink. See 3GPP TS 23.501 [2]. | +| maxPacketLossRateDI | PacketLossRate | O | 0..1 | Maximum rate for lost packets that can be tolerated in the downlink direction. See 3GPP TS 23.501 [2]. | + +6.2.6.2.23 Type: ProblemDetailsExtension + +**Table 6.2.6.2.23-1: Definition of type ProblemDetailsExtension** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------------|---|-------------|---------------------------------------------------------|---------------| +| accMbsServiceInfo | AcceptableMbsServInfo | O | 0..1 | MBS Service Information that can be accepted by the PCF | | + +6.2.6.2.24 Type: UpdateRspData + +**Table 6.2.6.2.24-1: Definition of type UpdateRspData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsSession | ExtMbsSession | M | 1 | Representation of the updated MBS session

if the MB-SMF has reduced the MBS service area to be within the MB-SMF service area (see clause 5.3.2.3.1), the MB-SMF shall provide in the response the representation of the updated MBS session including the reduced MBS service area in the redMbsServArea attribute. | | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.2.6.3.2 Simple data types + +The Nmbsmf\_MBSSession API does not define any simple data type in this release of the specification. + +##### 6.2.6.3.3 Enumeration: ContextUpdateAction + +The enumeration ContextUpdateAction indicates the requested action for the MBS session context. It shall comply with the provisions defined in table 6.2.6.3.3-1. + +**Table 6.2.6.3.3-1: Enumeration ContextUpdateAction** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------|---------------| +| "START" | Start MBS data reception | | +| "TERMINATE" | Terminate MBS data reception | | + +##### 6.2.6.3.4 Enumeration: ContextStatusEventType + +**Table 6.2.6.3.4-1: Enumeration ContextStatusEventType** + +| Enumeration value | Description | Applicability | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "QOS_INFO" | Subscription to be notified about the current MBS Session's QoS information and/or change of this information (e.g. addition, modification or removal of QoS flows) | | +| "STATUS_INFO " | Subscription to be notified about the current MBS Session's status (activated or deactivated) and/or change of this information. | | +| "SERVICE_AREA_INFO" | Subscription to be notified about the current MBS Service Area and/or change of this information. | | +| "SESSION_RELEASE" | Subscription to be notified when the MBS session is released. | | +| "MULT_TRANS_ADD_CHANGE" | Subscription to be notified about change of the N19mb multicast transport address. | | +| "SECURITY_INFO" | Subscription to be notified about the current MBS Session's Security Context information and/or change of this information | | + +##### 6.2.6.3.5 Enumeration: ReportingMode + +**Table 6.2.6.3.5-1: Enumeration ReportingMode** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------|---------------| +| "CONTINUOUS" | Continuous event reporting | | +| "ONE_TIME" | One-time event reporting | | + +##### 6.2.6.3.6 Enumeration: NgapleType + +**Table 6.5.6.3.6-1: Enumeration NgapleType** + +| Enumeration value | Description | +|----------------------|----------------------------------------------| +| "MBS_DIS_SETUP_REQ" | MBS Distribution Setup Request Transfer | +| "MBS_DIS_SETUP_RSP" | MBS Distribution Setup Response Transfer | +| "MBS_DIS_SETUP_FAIL" | MBS Distribution Setup Unsuccessful Transfer | +| "MBS_DIS_REL_REQ" | MBS Distribution Release Request Transfer | + +#### 6.2.6.4 Data types describing alternative data types or combinations of data types + +##### 6.2.6.4.1 Type: ExtMbsSession + +**6.2.6.4.1-1: Definition of type ExtMbsSession as a list of to be combined data types** + +| Data type | Cardinality | Description | +|---------------------|-------------|-----------------------------------------------| +| MbsSession | 1 | MbsSession common data type | +| MbsSessionExtension | 1 | Extensions to the MbsSession common data type | + +##### 6.2.6.4.2 Type: ExtProblemDetails + +###### 6.2.6.4.2-1: Definition of type ExtProblemDetails as a list of to be combined data types + +| Data type | Cardinality | Description | +|-------------------------|-------------|------------------------------------------------------------------------| +| ProblemDetails | 1 | Details of the encountered problem, as defined in 3GPP TS 29.571 [18]. | +| ProblemDetailsExtension | 1 | Extensions to the ProblemDetails common data type | + +#### 6.2.6.5 Binary data + +##### 6.2.6.5.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.2.2.2.2 and 6.2.2.4). + +**Table 6.2.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|---------------------------------------|----------------|---------------| +| N2 MBS Session Management Information | 6.2.6.5.2 | vnd.3gpp.ngap | + +##### 6.2.6.5.2 N2 MBS Session Management Information + +N2 MBS Session Management Information shall encode NG Application Protocol (NGAP) IEs, as specified in clause 9.3.5 of 3GPP TS 38.413 [20] (ASN.1 encoded), using the vnd.3gpp.ngap content-type. + +N2 MBS Session Management Information may encode following NGAP IE related to MBS Session Management specified in in clause 9.3.5 of 3GPP TS 38.413 [20], as summarized in Table 6.5.6.4.2-1. + +**Table 6.5.6.4.2-1: N2 MBS Session Management Information content** + +| NGAP IE | Reference (3GPP TS 38.413 [20]) | Related NGAP message | +|----------------------------------------------|---------------------------------|------------------------------| +| MBS Distribution Setup Request Transfer | 9.3.5.7 | DISTRIBUTION SETUP REQUEST | +| MBS Distribution Setup Response Transfer | 9.3.5.8 | DISTRIBUTION SETUP RESPONSE | +| MBS Distribution Setup Unsuccessful Transfer | 9.3.5.9 | DISTRIBUTION SETUP FAILURE | +| MBS Distribution Release Request Transfer | 9.3.5.10 | DISTRIBUTION RELEASE REQUEST | + +##### 6.2.6.5.3 Void + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +For the Nmbsmf\_MBSSession API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nmbsmf\_MBSSession API. + +#### 6.2.7.2 Protocol Errors + +No specific procedures for the Nmbsmf\_MBSSession service are specified. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Nmbsmf\_MBSSession service are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| INVALID_MBS_SERVICE_INFO | 400 Bad Request | The HTTP request is rejected because the provided MBS Service Information is invalid (e.g. invalid QoS reference), incorrect or insufficient to perform MBS policy authorization. | +| FILTER_RESTRICTIONS_NOT_RESPECTED | 400 Bad Request | The HTTP request is rejected because the MBS IP flow(s) description provided within the MBS Service Information cannot be handled due to the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [24] not being respected. | +| ERROR_INPUT_PARAMETERS | 400 Bad Request | The HTTP request is rejected because the provided set of input parameters are incomplete, erroneous or missing necessary information to perform MBS policy control. | +| MBS_SERVICE_INFO_NOT_AUTHORIZED | 403 Forbidden | The HTTP request is rejected because the provided MBS Service Information is not authorized to perform MBS policy authorization. | +| MBS_POLICY_CONTEXT_DENIED | 403 Forbidden | The HTTP request is rejected due to operator policies and/or local configuration. | +| MBS_SESSION_ALREADY_CREATED | 403 Forbidden | This error indicates an unsuccessful of MBS session creation, if the MBS session to be created has already been created in the MB-SMF. For a location dependent MBS session, this error shall be used if the MBS session associated to the indicated MBS session identifier and MBS service area has already been created in the MB-SMF. For non location dependent MBS session, this error shall be used if the MBS session indicated by the MBS session identifier has been created in the MB-SMF. | +| OVERLAPPING_MBS_SERVICE_AREA | 403 Forbidden | This error indicates an unsuccessful of MBS session creation, if the new MBS service area overlaps with the service area of any MBS session with the same MBS session identifier. | +| UNKNOWN_TMGI | 404 Not Found | This error indicates an unsuccessful of MBS session creation, if the TMGI provided in the request does not exist in the MB-SMF. This application error shall not apply to a location dependent broadcast MBS session if, based on operator's policy, the MB-SMF shall accept a TMGI value allocated by another MB-SMF. | +| UNKNOWN_MBS_SESSION | 404 Not Found | This error indicates an unsuccessful MBS session update or release, if the MBS session to be updated or deleted is not found in the MB-SMF. | +| UNKNOWN_MBS_SERVICE_AREA | 404 Not Found | This error indicates an unsuccessful MBS session update, context update or status subscribe procedure for a location dependent MBS session, if the requested MBS Area Session ID cannot be found. | + +### 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the Nmbsmf\_MBSSession API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nmbsmf\_MBSSession API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nmbsmf\_MBSSession API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nmbsmf\_MBSSession service. + +The Nmbsmf\_MBSSession API defines the following scopes for OAuth2 authorization. + +**Table 6.2.9-1: OAuth2 scopes defined in Nmbsmf\_MBSSession API** + +| Scope | Description | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| "nmbsmf-mbssession" | Access to the Nmbsmf_MBSSession API | +| "nmbsmf-mbssession:mbs-sessions" | Access to service operations applying to MBS session resources, i.e. Create, Update, Delete, StatusSubscribe, StatusUnsubscribe | +| "nmbsmf-mbssession:mbs-contexts" | Access to service operations applying to MBS session context resources, i.e. ContextUpdate, ContextStatusSubscribe, ContextStatusUnsubscribe | + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different MB-SMF service instance, within the same MB-SMF or a different MB-SMF of an MB-SMF set, e.g. when an MB-SMF service instance is part of an MB-SMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different MB-SMF producer instance will return the NF Instance ID of the new MB-SMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an MB-SMF within an MB-SMF set redirects a service request to a different MB-SMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new MB-SMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the MB-SMF Service APIs defined in the present specification - Nmbsmf\_TMGI and Nmbsmf\_MBSSession APIs. This Annex consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## --- A.2 Nmbsmf\_TMGI API + +``` +openapi: 3.0.0 + +info: + title: 'Nmbsmf_TMGI' + version: 1.0.1 + description: | + MB-SMF TMGI Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.532 V17.3.0; 5G System; 5G Multicast-Broadcast Session Management Services; + Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.532/ + +servers: + - url: '{apiRoot}/nmbsmf-tmgi/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nmbsmf-tmgi + +paths: + /tmgi: + post: + summary: Allocate TMGIs + tags: + - TMGI collection + operationId: AllocateTmgi + requestBody: + description: representation of the TMGIs to be created in the MB-SMF + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TmgiAllocate' + responses: + '200': + description: successful allocation of TMGIs + content: + application/json: + schema: + $ref: '#/components/schemas/TmgiAllocated' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deallocate one or more TMGIs + operationId: TMGIDeallocate + tags: + - TMGI collection + parameters: + - name: tmgi-list + in: query + description: One of more TMGIs to be deallocated + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tmgi' + minItems: 1 + responses: + '204': + description: successful deallocation of TMGIs + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nmbsmf-tmgi: Access to the nmbsmf-tmgi API + +schemas: + # API specific definitions +# +# STRUCTURED DATA TYPES +# +TmgiAllocate: + description: Data within TMGI Allocate Request + type: object + properties: + tmgiNumber: + description: The number of requested TMGIs + type: integer + minimum: 1 + +``` + +``` + + maximum: 255 + tmgiList: + description: The list of TMGIs to be refreshed + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tmgi' + minItems: 1 + + TmgiAllocated: + description: Data within TMGI Allocate Response + type: object + properties: + tmgiList: + description: One or more TMGI values + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tmgi' + minItems: 1 + expirationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' + required: + - tmgiList + - expirationTime + +# +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + +``` + +## A.3 Nmbsmf\_MBSSession API + +``` + +openapi: 3.0.0 + +info: + title: 'Nmbsmf-MBSSession' + version: 1.2.0-alpha.2 + description: | + MB-SMF MBSSession Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.532 V18.3.0; 5G System; 5G Multicast-Broadcast Session Management Services; + Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.532/ + +servers: + - url: '{apiRoot}/nmbsmf-mbssession/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nmbsmf-mbssession + +paths: + /mbs-sessions: + post: + summary: Create + tags: + - MBS sessions collection + operationId: Create + security: + - {} + - oAuth2ClientCredentials: + +``` + +``` + + - nmbsmf-mbssession + - OAuth2ClientCredentials: + - nmbsmf-mbssession + - nmbsmf-mbssession:mbs-sessions +requestBody: + description: > + Representation of the MBS session to be created in the MB-SMF + Creates an individual MBS session resource in the MB-SMF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateReqData' +responses: + '201': + description: > + Successful creation of an MBS session + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRspData' + headers: + Location: + description: > + 'Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nmbsmf-mbssession/{apiVersion}/mbs-sessions/{mbsSessionRef}' + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-sessions/{mbsSessionRef}: + patch: + summary: Updates an individual MBS session resource in the MB-SMF. + tags: + - Individual MBS session + operationId: Update + security: + - {} + - OAuth2ClientCredentials: + - nmbsmf-mbssession + - OAuth2ClientCredentials: + - nmbsmf-mbssession + - nmbsmf-mbssession:mbs-sessions + parameters: + - name: mbsSessionRef + in: path + +``` + +``` + required: true + description: Unique ID of the MBS session to be modified + schema: + type: string + requestBody: + description: Data within the Update Request + required: true + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + responses: + '204': + description: > + Successful modification of the MBS session without content in the response. + '200': + description: > + Successful modification of the MBS session with content in the response + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes an individual MBS session resource in the MB-SMF. + tags: + - Individual MBS session + operationId: Release + security: + - {} + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - nmbsmf-mbssession:mbs-sessions + parameters: + - name: mbsSessionRef + in: path + required: true + description: Unique ID of the MBS session to be released + schema: + type: string + responses: +``` + +``` +'204': + description: > + Successful release of the MBS session without content in the response. +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-sessions/contexts/update: + post: + summary: ContextUpdate + tags: + - MBS sessions collection + operationId: ContextUpdate + security: + - {} + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - nmbsmf-mbssession:mbs-contexts + requestBody: + description: Data within the ContextUpdate Request + required: true + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/ContextUpdateReqData' + multipart/related: # message with binary body part + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/ContextUpdateReqData' + binaryDataN2Information: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + responses: + '200': + description: Successful response with content in the response + content: + application/json: # message without binary body part + schema: + $ref: '#/components/schemas/ContextUpdateRspData' + multipart/related: # message with binary body part + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/ContextUpdateRspData' + binaryDataN2Information: +``` + +``` + + type: string + format: binary +encoding: + jsonData: + contentType: application/json + binaryDataN2Information: + contentType: application/vnd.3gpp.ngap +headers: + Content-Id: + schema: + type: string +'204': + description: Successful response without content in the response +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-sessions/subscriptions: + post: + summary: StatusSubscribe creating a subscription + tags: + - Subscriptions collection for MBS sessions + operationId: StatusSubscribe + security: + - {} + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - nmbsmf-mbssession:mbs-sessions + requestBody: + description: Data within the StatusSubscribe Request + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/StatusSubscribeReqData' + responses: + '201': + description: Data within a successful StatusSubscribe Response + content: + application/json: + schema: + $ref: '#/components/schemas/StatusSubscribeRspData' + '204': + description: Successful response without content in the response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +callbacks: + statusNotification: + '{ $request.body#/notifUri }': + post: + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: Notification Content + content: + application/json: + schema: + $ref: '#/components/schemas/StatusNotifyReqData' + responses: + '204': + description: Expected response to a successful callback processing + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-sessions/subscriptions/{subscriptionId}: + +``` + +``` +patch: + summary: StatusSubscribe to modify (update or renew) an individual subscription + tags: + - Individual Subscription for an MBS session + operationId: StatusSubscribeMod + security: + - {} + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - nmbsmf-mbssession:mbs-sessions + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the individual subscription to be modified + schema: + type: string + requestBody: + description: Data to be modified in the MBSSessionSubscription + required: true + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + responses: + '200': + description: Successful modification of the individual Status Subscription + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionSubscription' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: StatusUnSubscribe to unsubscribe from the Status Subscription + tags: + - Individual Subscription for an MBS session + operationId: StatusUnSubscribe + security: + - {} + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - nmbsmf-mbssession:mbs-sessions + parameters: +``` + +``` +- name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be deleted + schema: + type: string +responses: + '204': + description: Successful deletion of the subscription + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-sessions/contexts/subscriptions: + post: + summary: ContextStatusSubscribe creating a subscription + tags: + - Subscriptions collection for MBS contexts + operationId: ContextStatusSubscribe + security: + - {} + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - nmbsmf-mbssession:mbs-contexts + requestBody: + description: Data within the ContextStatusSubscribe Request + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ContextStatusSubscribeReqData' + responses: + '201': + description: successful creation of a Context Status Subscription + content: + application/json: + schema: + $ref: '#/components/schemas/ContextStatusSubscribeRspData' + '204': + description: Successful response without content in the response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +callbacks: + contextStatusNotification: + '{ $request.body#/subscription/notifUri }': + post: + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: Notification Content + content: + application/json: + schema: + $ref: '#/components/schemas/ContextStatusNotifyReqData' + responses: + '204': + description: Expected response to a successful callback processing + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/mbs-sessions/contexts/subscriptions/{subscriptionId}: + patch: + summary: ContextStatusSubscribe modifying an individual subscription + tags: + - Individual Subscription for an MBS context + operationId: ContextStatusSubscribeMod + security: + - {} + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - oAuth2ClientCredentials: + +``` + +``` + - nmbsmf-mbssession + - nmbsmf-mbssession:mbs-contexts +parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be modified + schema: + type: string +requestBody: + description: Data to be modified in the ContextStatusSubscription + required: true + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 +responses: + '200': + description: Successful modification of a Context Status Subscription + content: + application/json: + schema: + $ref: '#/components/schemas/ContextStatusSubscription' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: ContextStatusUnSubscribe + tags: + - Individual Subscription for an MBS context + operationId: ContextStatusUnSubscribe + security: + - {} + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - oAuth2ClientCredentials: + - nmbsmf-mbssession + - nmbsmf-mbssession:mbs-contexts + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be deleted + schema: + type: string + responses: + '204': + description: Successful deletion + '307': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nmbsmf-mbssession: Access to the Nmbsmf-MBSSession API + nmbsmf-mbssession:mbs-sessions: > + Access to service operations applying to MBS session resources, i.e. Create, Update, + Delete, StatusSubscribe, StatusUnsubscribe + nmbsmf-mbssession:mbs-contexts: > + Access to service operations applying to MBS session context resources, i.e. + ContextUpdate, ContextStatusSubscribe and ContextStatusUnsubscribe + +schemas: +# +# STRUCTURED DATA TYPES +# + + CreateReqData: + description: Data within Create Request + type: object + properties: + mbsSession: + $ref: '#/components/schemas/ExtMbsSession' + required: + - mbsSession + + CreateRspData: + description: Data within Create Response + type: object + properties: + mbsSession: + $ref: '#/components/schemas/ExtMbsSession' + eventList: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionEventReportList' + required: + - mbsSession + + ExtMbsSession: + description: MbsSession common data type with MB-SMF API specific extensions + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSession' + - $ref: '#/components/schemas/MbsSessionExtension' + + MbsSessionExtension: + description: MB-SMF API specific extensions to the MbsSession common data type + type: object + properties: + mbsSecurityContext: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSecurityContext' + contactPcfInd: + type: boolean + default: false + areaSessionPolicyId: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionPolicyId' + +ContextUpdateReqData: + description: Data within ContextUpdate Request + type: object + properties: + nfcInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + areaSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionId' + requestedAction: + $ref: '#/components/schemas/ContextUpdateAction' + dlTunnelInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + n2MbsSmInfo: + $ref: '#/components/schemas/N2MbsSmInfo' + ranNodeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId' + leaveInd: + type: boolean + enum: + - true + required: + - nfcInstanceId + - mbsSessionId + +ContextUpdateRspData: + description: Data within ContextUpdate Response + type: object + properties: + llSsm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ssm' + cTeid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + n2MbsSmInfo: + $ref: '#/components/schemas/N2MbsSmInfo' + +ContextStatusSubscribeReqData: + description: Data within ContextStatusSubscribe Request + type: object + properties: + subscription: + $ref: '#/components/schemas/ContextStatusSubscription' + required: + - subscription + +ContextStatusSubscription: + description: Context Status Subscription + type: object + properties: + nfcInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + eventList: + type: array + items: + $ref: '#/components/schemas/ContextStatusEvent' + minItems: 1 + notifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorrelationId: + type: string + expiryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - nfcInstanceId + - mbsSessionId + - eventList + - notifyUri + +ContextStatusEvent: + description: Context Status Event + type: object + properties: +``` + +``` + eventType: + $ref: '#/components/schemas/ContextStatusEventType' + immediateReportInd: + type: boolean + default: false + reportingMode: + $ref: '#/components/schemas/ReportingMode' + required: + - eventType + +ContextStatusSubscribeRspData: + description: Data within ContextStatusSubscribe Response + type: object + properties: + subscription: + $ref: '#/components/schemas/ContextStatusSubscription' + reportList: + type: array + items: + $ref: '#/components/schemas/ContextStatusEventReport' + minItems: 1 + mbsContextInfo: + $ref: '#/components/schemas/MbsContextInfo' + required: + - subscription + +MbsContextInfo: + description: MBS context information + type: object + properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + anyUeInd: + type: boolean + default: false + llSsm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ssm' + cTeid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + mbsServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea' + mbsServiceAreaInfoList: + description: > + A map (list of key-value pairs) where the key identifies an areaSessionId + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceAreaInfo' + minProperties: 1 + +ContextStatusEventReport: + description: Context Status Event Report + type: object + properties: + eventType: + $ref: '#/components/schemas/ContextStatusEventType' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + qosInfo: + $ref: '#/components/schemas/QosInfo' + statusInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionActivityStatus' + mbsServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceArea' + mbsServiceAreaInfoList: + description: > + A map (list of key-value pairs) where the key identifies an areaSessionId + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceAreaInfo' + minProperties: 1 + multicastTransAddInfo: + $ref: '#/components/schemas/MulticastTransportAddressChangeInfo' + mbsSecurityContext: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSecurityContext' + required: + - eventType + - timeStamp + +ContextStatusNotifyReqData: +``` + +``` +description: Context Status Notification +type: object +properties: + reportList: + type: array + items: + $ref: '#/components/schemas/ContextStatusEventReport' + minItems: 1 + notifyCorrelationId: + type: string +required: +- reportList + +StatusSubscribeReqData: +description: Data within the StatusSubscribe Request +type: object +properties: + subscription: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionSubscription' +required: +- subscription + +StatusSubscribeRspData: +description: Data within StatusSubscribe Response +type: object +properties: + subscription: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionSubscription' + eventList: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionEventReportList' +required: +- subscription + +StatusNotifyReqData: +description: Status Notification +type: object +properties: + eventList: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionEventReportList' +required: +- eventList + +N2MbsSmInfo: +description: N2 MBS Session Management information +type: object +properties: + ngapIeType: + $ref: '#/components/schemas/NgapIeType' + ngapData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +required: +- ngapIeType +- ngapData + +MulticastTransportAddressChangeInfo: +description: Multicast Transport Address Change Information +type: object +properties: + llSsm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ssm' + cTeid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + areaSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AreaSessionId' +required: +- llSsm +- cTeid + +QosInfo: +description: QoS Information +type: object +properties: + qosFlowsAddModRequestList: + type: array + items: +``` + +``` + $ref: '#/components/schemas/QosFlowAddModifyRequestItem' + minItems: 1 + qosFlowsRelRequestList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + minItems: 1 + +QosFlowAddModifyRequestItem: + description: Individual MBS QoS flow requested to be created or modified + type: object + properties: + qfi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi' + qosFlowProfile: + $ref: '#/components/schemas/QosFlowProfile' + required: + - qfi + +QosFlowProfile: + description: MBS QoS flow profile + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + nonDynamic5Qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NonDynamic5Qi' + dynamic5Qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dynamic5Qi' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + gbrQosFlowInfo: + $ref: '#/components/schemas/GbrQosFlowInformation' + required: + - 5qi + +GbrQosFlowInformation: + description: GBR MBS QoS flow information + type: object + properties: + maxFbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + guaFbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxPacketLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + required: + - maxFbrDl + - guaFbrDl + +ExtProblemDetails: + description: Extended Problem Details data structure + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/ProblemDetailsExtension' + +ProblemDetailsExtension: + description: Extensions to ProblemDetails + type: object + properties: + accMbsServiceInfo: + $ref: 'TS29537_Npcf_MBSPolicyAuthorization.yaml#/components/schemas/AcceptableMbsServInfo' + +UpdateRspData: + description: Data within Update Response + type: object + properties: + mbsSession: + $ref: '#/components/schemas/ExtMbsSession' + required: + - mbsSession + +# +# SIMPLE DATA TYPES +# +# +``` + +``` +# ENUMERATIONS +# + +ContextUpdateAction: + description: Start or Terminate MBS data reception + anyOf: + - type: string + enum: + - START + - TERMINATE + - type: string + +ContextStatusEventType: + description: Context Status Event Type + anyOf: + - type: string + enum: + - QOS_INFO + - STATUS_INFO + - SERVICE_AREA_INFO + - SESSION_RELEASE + - MULT_TRANS_ADD_CHANGE + - SECURITY_INFO + - type: string + +ReportingMode: + description: Reporting Mode + anyOf: + - type: string + enum: + - CONTINUOUS + - ONE_TIME + - type: string + +NgapIeType: + description: NGAP Information Element Type + anyOf: + - type: string + enum: + - MBS_DIS_SETUP_REQ + - MBS_DIS_SETUP_RSP + - MBS_DIS_SETUP_FAIL + - MBS_DIS_REL_REQ + - type: string +``` + +# --- Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-08 | CT4#105e | C4-214755 | | | | Following pCRs are implemented into the skeleton of the TS 29.532 v0.0.0 (C4-214118): C4-214026, C4-214032, C4-214188, C4-214190, C4-214191, C4-214236, C4-214237, C4-214238, C4-214239, C4-214547, C4-214549, C4-214551, C4-214554, C4-214683, C4-214684, C4-214685 and C4-214686. | 0.1.0 | +| 2021-10 | CT4#106e | C4-215519 | | | | Following pCRs are implemented:
C4-21-5015, C4-21-5017, C4-21-5071, C4-21-5075, C4-21-5076, C4-21-5077, C4-21-5078, C4-21-5079, C4-21-5080, C4-21-5081, C4-21-5083, C4-21-5335, C4-21-5337, C4-21-5338, C4-21-5339, C4-21-5340, C4-21-5341, C4-21-5374, C4-21-5375, C4-21-5376, C4-21-5377, C4-21-5498, C4-21-5500. | 0.2.0 | +| 2021-11 | CT4#107e | C4-216472 | | | | Following pCRs are implemented:
C4-216019, C4-216139, C4-216210, C4-216424, C4-216425, C4-216601, C4-216604, C4-216605. | 0.3.0 | +| 2021-12 | CT#94 | CP-213158 | | | | V1.0.0 presented for information | 1.0.0 | +| 2022-01 | CT4#107e-bis | CP-220454 | | | | Following pCRs are implemented:
C4-220097, C4-220098, C4-220327, C4-220352, C4-220416, C4-220417 and C4-220418. | 1.1.0 | +| 2022-02 | CT4#108e | C4-221592 | | | | Following pCRs are implemented:
C4-221123, C4-221138, C4-221140, C4-221147, C4-221380, C4-221419, C4-221420, C4-221531, C4-221546. | 1.2.0 | +| 2022-03 | CT#95e | CP-220107 | | | | TS presented for approval | 2.0.0 | +| 2022-03 | CT#95e | | | | | TS approved | 17.0.0 | +| 2022-06 | CT#96 | CP-221023 | 0006 | | F | Nmbsmf miscellaneous corrections | 17.1.0 | +| 2022-06 | CT#96 | CP-221023 | 0008 | | B | MBS Frequency Selection Area Identifier | 17.1.0 | +| 2022-06 | CT#96 | CP-221023 | 0010 | | F | MBS Service Area Information for Location dependent MBS session | 17.1.0 | +| 2022-06 | CT#96 | CP-221023 | 0011 | | F | Granularity of MBSSession service operations for Location dependent MBS session | 17.1.0 | +| 2022-06 | CT#96 | CP-221023 | 0012 | | B | Broadcast Delivery Status event | 17.1.0 | +| 2022-06 | CT#96 | CP-221023 | 0013 | | B | Ingress Tunnel Address Change Status Event | 17.1.0 | +| 2022-06 | CT#96 | CP-221023 | 0007 | 1 | F | NGAP MB-SMF related les | 17.1.0 | +| 2022-06 | CT#96 | CP-221023 | 0002 | 2 | F | Simple data types and enumerations for Nmbsmf_TMGI Service | 17.1.0 | +| 2022-06 | CT#96 | CP-221023 | 0004 | 2 | F | Simple data types for Nmbsmf_MBSSession Service | 17.1.0 | +| 2022-06 | CT#96 | CP-221023 | 0005 | 1 | F | Corrections to Nmbsmf data models | 17.1.0 | +| 2022-06 | CT#96 | CP-221023 | 0014 | 1 | B | Multicast Transport Address Change Context Status event | 17.1.0 | +| 2022-06 | CT#96 | CP-221236 | 0009 | 3 | B | QoS information in Context Status Event Report | 17.1.0 | +| 2022-06 | CT#96 | CP-221024 | 0001 | 3 | B | MBS Security Context Delivery | 17.1.0 | +| 2022-06 | CT#96 | CP-221024 | 0017 | 1 | F | Updates to Service Description | 17.1.0 | +| 2022-06 | CT#96 | CP-221024 | 0020 | 1 | F | Corrections on HTTP Response | 17.1.0 | +| 2022-06 | CT#96 | CP-221024 | 0018 | 2 | F | Application Error for TMGI Service | 17.1.0 | +| 2022-06 | CT#96 | CP-221024 | 0019 | 2 | F | Application Error for MBS Session Service | 17.1.0 | +| 2022-06 | CT#96 | CP-221051 | 0025 | | F | 29.532 Rel-17 API version and External doc update | 17.1.0 | +| 2022-09 | CT#97e | CP-222031 | 0029 | | F | Event reports in Create response and Status Subscribe Response | 17.2.0 | +| 2022-09 | CT#97e | CP-222058 | 0033 | | F | 29.532 0033 Rel-17 API version and External doc update | 17.2.0 | +| 2022-09 | CT#97e | CP-222031 | 0027 | 2 | F | Change of MBS session authorization | 17.2.0 | +| 2022-09 | CT#97e | CP-222031 | 0031 | 1 | F | Clarification on the tunnel information | 17.2.0 | +| 2022-09 | CT#97e | CP-222031 | 0034 | | B | Defining the "indication that the PCF has to be contacted" | 17.2.0 | +| 2022-12 | CT#98e | CP-223036 | 0037 | | F | Complete the applicable procedure for the ContextStatusNotify service operation | 17.3.0 | +| 2022-12 | CT#98e | CP-223036 | 0042 | | F | Corrections for MBS session with PCC | 17.3.0 | +| 2022-12 | CT#98e | CP-223036 | 0043 | 1 | F | Miscellaneous corrections (OpenAPI errors, incorrect IEs and references, etc) | 17.3.0 | +| 2022-12 | CT#98e | CP-223036 | 0044 | 1 | F | Corrections to N2 MBS Session Management Information | 17.3.0 | +| 2022-12 | CT#98e | CP-223042 | 0041 | 1 | F | Missing mandatory status codes and 307/308 codes in OpenAPI | 17.3.0 | +| 2022-12 | CT#98e | CP-223225 | 0039 | 3 | F | Adding NID to TmgiAllocated type | 17.3.0 | +| 2022-12 | CT#98e | CP-223225 | 0036 | 2 | F | Complete the description for ProblemDetails in the Nmbsmf_MBSSession API | 17.3.0 | +| 2022-12 | CT#98e | CP-223066 | 0046 | | F | 29.532 0046 Rel-17 API version and External doc update | 17.3.0 | +| 2022-12 | CT#98e | CP-223036 | 0045 | 2 | F | Clarification on MB-SMF behaviour on handling shared NG-U tunnel | 17.3.0 | +| 2023-03 | CT#99 | CP-230029 | 0048 | | F | OAuth2 scopes in the MBSSession API | 18.0.0 | +| 2023-03 | CT#99 | CP-230049 | 0049 | 1 | F | Correct string datatype and StatusNotify service operation description | 18.0.0 | +| 2023-03 | CT#99 | CP-230071 | 0052 | | F | 29.532 Rel18 API version and External doc update | 18.0.0 | +| 2023-06 | CT#100 | CP-231026 | 0050 | 2 | F | Location header description | 18.1.0 | +| 2023-06 | CT#100 | CP-231037 | 0054 | 1 | B | Adding Associated Session ID to Nmbsmf_MBSSession_Create Request | 18.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------|--------| +| 2023-06 | CT#100 | CP-231076 | 0057 | 1 | A | Essential Correction for the usage of the cause "UNKNOWN_MBS_SERVICE_AREA" | 18.1.0 | +| 2023-09 | CT#101 | CP-232065 | 0063 | 1 | F | Correct callback URI for mbsSession service | 18.2.0 | +| 2023-09 | CT#101 | CP-232058 | 0064 | | F | EventType attribute correction | 18.2.0 | +| 2023-12 | CT#102 | CP-233044 | 0067 | | F | Editorial corrections and DateTime clarification | 18.3.0 | +| 2023-12 | CT#102 | CP-233027 | 0068 | | F | Update and replace obsoleted HTTP RFCs | 18.3.0 | +| 2023-12 | CT#102 | CP-233063 | 0073 | 1 | A | Area Session Policy ID in Nmbsmf_MBSSession_Create request | 18.3.0 | +| 2023-12 | CT#102 | CP-233063 | 0075 | 1 | A | MBS Service Area not contained within the MB-SMF service area | 18.3.0 | +| 2023-12 | CT#102 | CP-233063 | 0077 | 2 | A | Location Dependent MBS broadcast session with multiple MB-SMFs | 18.3.0 | +| 2023-12 | CT#102 | CP-233030 | 0079 | | F | 29.532: Replacing obsoleted HTTP RFC 7807 with 9457 | 18.3.0 | +| 2023-12 | CT#102 | CP-233060 | 0082 | | F | 29.532 Rel-18 API version and External doc update | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29535/raw.md b/raw/rel-18/29_series/29535/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..974948807690c86fef20d8d12e5d91ac347d30b4 --- /dev/null +++ b/raw/rel-18/29_series/29535/raw.md @@ -0,0 +1,1164 @@ + + +# 3GPP TS 29.535 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; AKMA Anchor Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font with a red signal wave icon below the 'P', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Services offered by the AAnF..... | 8 | +| 4.1 Introduction ..... | 8 | +| 4.2 Naanf_AKMA Service..... | 9 | +| 4.2.1 Service Description ..... | 9 | +| 4.2.1.1 Overview..... | 9 | +| 4.2.1.2 Service Architecture ..... | 9 | +| 4.2.1.3 Network Functions..... | 10 | +| 4.2.1.3.1 AKMA Anchor Function (AAnF)..... | 10 | +| 4.2.1.3.2 NF Service Consumers..... | 10 | +| 4.2.2 Service Operations..... | 10 | +| 4.2.2.1 Introduction..... | 10 | +| 4.2.2.2 Naanf_AKMA_AnchorKey_Register service operation ..... | 11 | +| 4.2.2.2.1 General ..... | 11 | +| 4.2.2.2.2 Store the AKMA related key material..... | 11 | +| 4.2.2.3 Naanf_AKMA_ApplicationKey_Get service operation..... | 11 | +| 4.2.2.3.1 General ..... | 11 | +| 4.2.2.3.2 AKMA Application Key request..... | 11 | +| 4.2.2.4 Naanf_AKMA_ContextRemove service operation..... | 12 | +| 4.2.2.4.1 General ..... | 12 | +| 4.2.2.4.2 AKMA Context removal..... | 13 | +| 5 API Definitions ..... | 13 | +| 5.1 Naanf_AKMA Service API ..... | 13 | +| 5.1.1 Introduction ..... | 13 | +| 5.1.2 Usage of HTTP..... | 14 | +| 5.1.2.1 General..... | 14 | +| 5.1.2.2 HTTP standard headers..... | 14 | +| 5.1.2.2.1 General ..... | 14 | +| 5.1.2.2.2 Content type ..... | 14 | +| 5.1.2.3 HTTP custom headers..... | 14 | +| 5.1.3 Resources..... | 14 | +| 5.1.4 Custom Operations without associated resources ..... | 14 | +| 5.1.4.1 Overview..... | 14 | +| 5.1.4.2 Operation: Register ..... | 15 | +| 5.1.4.2.1 Description ..... | 15 | +| 5.1.4.2.2 Operation Definition ..... | 15 | +| 5.1.4.3 Operation: Retrieve..... | 16 | +| 5.1.4.3.1 Description ..... | 16 | +| 5.1.4.3.2 Operation Definition ..... | 16 | +| 5.1.4.4 Operation: Remove..... | 17 | +| 5.1.4.4.1 Description ..... | 17 | +| 5.1.4.4.2 Operation Definition ..... | 17 | +| 5.1.5 Notifications ..... | 18 | +| 5.1.6 Data Model ..... | 18 | +| 5.1.6.1 General..... | 18 | +| 5.1.6.2 Structured data types..... | 18 | +| 5.1.6.2.1 Introduction ..... | 18 | +| 5.1.6.2.2 Type: AkmaKeyInfo ..... | 19 | + +| | | | +|--------------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 5.1.6.2.3 | Type: CtxRemove ..... | 19 | +| 5.1.6.3 | Simple data types and enumerations..... | 19 | +| 5.1.6.3.1 | Introduction ..... | 19 | +| 5.1.6.3.2 | Simple data types ..... | 19 | +| 5.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 19 | +| 5.1.6.5 | Binary data..... | 19 | +| 5.1.7 | Error Handling..... | 19 | +| 5.1.7.1 | General..... | 19 | +| 5.1.7.2 | Protocol Errors ..... | 19 | +| 5.1.7.3 | Application Errors..... | 20 | +| 5.1.8 | Feature negotiation ..... | 20 | +| 5.1.9 | Security..... | 20 | +| Annex A (normative): OpenAPI specification..... | | 21 | +| A.1 | General..... | 21 | +| A.2 | Naanf_AKMA API..... | 21 | +| Annex B (informative): Change history..... | | 25 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# 1 Scope + +The present document specifies the stage 3 protocol and data model for the AAnF Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the AAnF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 33.535 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 33.535: "Authentication and Key Management for Applications (AKMA) based on 3GPP credentials in the 5G System (5GS)". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [16] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [17] 3GPP TS 29.503: "5G System; Network Exposure Function Northbound APIs; Stage 3". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Symbols + +No symbol applies in this release of the specification. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|----------------------------------------------------| +| AAnF | AKMA Anchor Function | +| AF | Application Function | +| AKMA | Authentication and Key Management for Applications | +| A-KID | AKMA Key Identifier | +| AUSF | Authentication Server Function | +| NEF | Network Exposure Function | +| GPSI | Generic Public Subscription Identifier | + +# 4 Services offered by the AAnF + +## 4.1 Introduction + +The AKMA Anchor Service is used for the AAnF to store AKMA related key material and provide AKMA Application Key information. The AAnF offers to other NFs the following service: + +- Naanf\_AKMA. + +**Table 4.1-1: Service provided by AAnF** + +| Service Name | Description | Service Operations | Operation Semantics | Example Consumer(s) | | +|------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|---------------------|---------------------|--| +| Naanf_AKMA | This service enables the NF service consumers to request the AAnF to store the AKMA related key material or get the AKMA Application Key information from the AAnF. | AnchorKey_Register | Request/Response | AUSF | | +| | | ApplicationKey_Get | Request/Response | AF, NEF | | +| | | ApplicationKey_AnonUser_Get
(NOTE 2) | Request/Response | AF | | +| | | ContextRemove | Request/Response | AUSF | | +| NOTE 1: The service corresponds to the Naanf_AKMA service as defined in 3GPP TS 33.535 [14]. | | | | | | +| NOTE 2: The ApplicationKey_AnonUser_Get service operation is defined reusing the ApplicationKey_Get service operation. | | | | | | + +Table 4.1-2 summarizes the corresponding APIs defined for this specification. + +Table 4.1-2: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------|--------|--------------------|----------------------------|------------|--------------------------------| +| Naanf_AKMA | 4.2 | API for Naanf_AKMA | TS29535_Naanf_AKMA.yaml | naanf-akma | Annex A.2
Naanf_AKMA
API | + +## 4.2 Naanf\_AKMA Service + +### 4.2.1 Service Description + +#### 4.2.1.1 Overview + +The Naanf\_AKMA, as defined in 3GPP TS 33.535 [14] is provided by the AKMA Anchor Function (AAnF). + +This service: + +- allows consumer NFs to store the AKMA related key material. +- allows consumer NFs and the AFs to request the AKMA Application Key information for the UE. + +#### 4.2.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Authentication and Key Management for Applications architecture is defined in 3GPP TS 33.535 [14]. + +The Naanf\_AKMA service is part of the Naanf service-based interface exhibited by the AAnF. + +Known consumers of the Naanf\_AKMA service are: + +- AUthentication Server Function (AUSF) +- Application Function (AF) +- Network Exposure Function (NEF) + +![Reference Architecture for the Naanf_AKMA Service; SBI representation diagram showing AAnF providing Naanf service to AUSF, AF, and NEF.](a92b1fdf37a74b707e9f03087c8f1377_img.jpg) + +``` + +graph TD + subgraph AAnF + Naanf((Naanf)) + end + Naanf --- SBI[Service Based Interface] + SBI --- AUSF[AUSF] + SBI --- AF[AF] + SBI --- NEF[NEF] + style Naanf fill:#fff,stroke:#000 + style AAnF fill:#fff,stroke:#000 + style AUSF fill:#fff,stroke:#000 + style AF fill:#fff,stroke:#000 + style NEF fill:#fff,stroke:#000 + style SBI fill:none,stroke:none + +``` + +The diagram illustrates the service architecture for Naanf\_AKMA. At the top, a rectangular box labeled 'AAnF' contains an oval labeled 'Naanf'. A vertical line descends from the 'Naanf' oval to a horizontal line representing the Service Based Interface (SBI). To the right of this horizontal line is the label 'Naanf\_AKMA'. Below the horizontal line, three rectangular boxes labeled 'AUSF', 'AF', and 'NEF' are connected via vertical lines, indicating they are consumers of the Naanf\_AKMA service. + +Reference Architecture for the Naanf\_AKMA Service; SBI representation diagram showing AAnF providing Naanf service to AUSF, AF, and NEF. + +Figure 4.2.1.2-1: Reference Architecture for the Naanf\_AKMA Service; SBI representation + +![Reference Architecture for the Naanf_AKMA Service; reference point representation. The diagram shows a central box labeled 'AAnF' connected to three boxes below it: 'AUSF', 'AF', and 'NEF'. The connections are labeled N61, N62, and N63 respectively. Each connection line has a small horizontal tick mark near the bottom box.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph TD + AAnF[AAnF] ---|N61| AUSF[AUSF] + AAnF ---|N62| AF[AF] + AAnF ---|N63| NEF[NEF] + +``` + +Reference Architecture for the Naanf\_AKMA Service; reference point representation. The diagram shows a central box labeled 'AAnF' connected to three boxes below it: 'AUSF', 'AF', and 'NEF'. The connections are labeled N61, N62, and N63 respectively. Each connection line has a small horizontal tick mark near the bottom box. + +**Figure 4.2.1.2-2: Reference Architecture for the Naanf\_AKMA Service; reference point representation** + +#### 4.2.1.3 Network Functions + +##### 4.2.1.3.1 AKMA Anchor Function (AAnF) + +The AKMA Anchor Function (AAnF) is a functional element that stores the AKMA Anchor Key ( $K_{AKMA}$ ), A-KID for AKMA service, which is received from the AUSF after the UE completes a successful 5G primary authentication. The AAnF also generates the key material to be used between the UE and the Application Function (AF) and maintains the UE AKMA context as defined in 3GPP TS 33.535 [14]. + +##### 4.2.1.3.2 NF Service Consumers + +The known NF service consumers are as follows: + +The AUthentication Server Function (AUSF): + +- provides the AKMA key material of the UE to the AAnF. + +The Network Exposure Function (NEF): + +- enables and authorizes the external AF accessing AKMA service and forwards the request towards the AAnF; +- performs the AAnF selection. + +The Application Function (AF): + +- requests for AKMA Application Key from the AAnF; +- shall be authenticated and authorized by the operator network before receiving the $K_{AF}$ from the AAnF; +- performs the AAnF selection if the AF located inside the operator's network. + +### 4.2.2 Service Operations + +#### 4.2.2.1 Introduction + +**Table 4.2.2.1-1: Operations of the Naanf\_AKMA Service** + +| Service operation name | Description | Initiated by | +|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Naanf_AKMA_AnchorKey_Register | This service operation is used by an NF to store the AKMA related key material. | AUSF | +| Naanf_AKMA_ApplicationKey_Get | This service operation is used by an NF to request the AKMA Application Key information for the UE | NEF, AF | +| Naanf_AKMA_ApplicationKey_Anon User_Get | This service operation is used by an AF to request the AKMA Application Key information for the UE when authorized AF are not expected to receive the SUPI of the UE | AF | +| Naanf_AKMA_ContextRemove | This service operation is used by an NF to delete the AKMA related key material. | AUSF | + +#### 4.2.2.2 Naanf\_AKMA\_AnchorKey\_Register service operation + +##### 4.2.2.2.1 General + +The procedures support: + +- store the AKMA related key material by the NF service consumer to the AAnF as described in 3GPP TS 33.535 [14]; + +##### 4.2.2.2.2 Store the AKMA related key material + +Figure 4.2.2.2.2-1 illustrates the registration of AKMA related key material at the AAnF. + +![Sequence diagram showing the registration of AKMA related key material. An NF service consumer sends a POST request to the AAnF, and the AAnF responds with a 200 OK status code.](7c6d9bfe9c31ce872722d60b73d20df1_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant AAnF + Note right of NF service consumer: 1. POST .../register-anchorkey + NF service consumer->>AAnF: Request + Note left of AAnF: 2. "200 OK" + AAnF-->>NF service consumer: Response +``` + +Sequence diagram showing the registration of AKMA related key material. An NF service consumer sends a POST request to the AAnF, and the AAnF responds with a 200 OK status code. + +**Figure 4.2.2.2.2-1: Registration of AKMA related key material** + +In order to store the AKMA related key material, the NF service consumer shall send an HTTP POST request message to the resource URI "{apiRoot}/naanf-akma//register-anchorkey" as shown in step 1 of figure 4.2.2.2.2-1, and the AkmaKeyInfo data structure as request body. + +The AkmaKeyInfo data structure shall include: + +- SUPI as "supi" attribute; +- A-KID as "aKid" attribute; and +- $K_{AKMA}$ as "kAkma" attribute. + +If the AAnF cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the AAnF shall send an HTTP error response as specified in clause 5.1.7. + +If the AAnF determines the received HTTP POST request needs to be redirected, the AAnF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +Upon successful reception of an HTTP POST request, the AAnF shall store the key material information and respond to the NF service consumer with a 200 OK status code, including the AkmaKeyInfo data structure as response body. + +#### 4.2.2.3 Naanf\_AKMA\_ApplicationKey\_Get service operation + +##### 4.2.2.3.1 General + +The Naanf\_AKMA\_ApplicationKey\_Get service operation is used by an NF service consumer to request the AKMA Application Key information for the UE. + +##### 4.2.2.3.2 AKMA Application Key request + +Figure 4.2.2.3.2-1 shows a scenario where the NF service consumer sends a request to the AAnF to request and get the AKMA Application Key information for the UE (as shown in 3GPP TS 33.535 [14]). + +![Sequence diagram showing the interaction between an NF service consumer and an AAnF. Step 1: The consumer sends a POST request to /retrieve-applicationkey. Step 2: The AAnF responds with a 200 OK status.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant AAnF + Note right of NF service consumer: 1. POST .../retrieve-applicationkey + NF service consumer->>AAnF: Request + Note left of AAnF: 2. "200 OK" + AAnF-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an AAnF. Step 1: The consumer sends a POST request to /retrieve-applicationkey. Step 2: The AAnF responds with a 200 OK status. + +**Figure 4.2.2.3.2-1: NF service consumer retrieve AKMA Application Key information** + +The NF service consumer shall invoke the Naanf\_AKMA\_ApplicationKey\_Get service operation to retrieve the AKMA Application Key information. The NF service consumer shall send for this purpose an HTTP POST request with "{apiRoot}/naanf-akma//retrieve-applicationkey" as Resource URI, as shown in step 1 of figure 4.2.2.3.2-1, and the request body containing the AkmaAfKeyRequest data structure. + +If the request corresponds to a Naanf\_AKMA\_ApplicationKey\_AnonUser\_Get request, then the AkmaAfKeyRequest shall contain the "anonInd" attribute set to "true". + +If the AAnF determines the received HTTP POST request needs to be redirected, the AAnF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +If the AAnF cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the AAnF shall send an HTTP error response as specified in clause 5.1.7. + +The AAnF shall also verify the presence of the UE specific KAKMA key identified by the A-KID. + +- If KAKMA is not present in the AAnF, the AAnF shall reply with an HTTP "403 Forbidden" status code and the response message body including a ProblemDetails data structure with the "cause" attribute set to the "K\_AKMA\_NOT\_PRESENT" application error specified in table 5.1.7.3-1. +- If KAKMA is present in the AAnF, the AAnF shall continue and process the request as specified below. + +Upon the reception of the HTTP POST request, the AAnF shall respond with an HTTP "200 OK" status code and the response message body containing the AkmaAfKeyData data structure which shall include: + +- KAF as "kaf" attribute; +- KAF expiration time as "expiry" attribute; and +- if the "anonInd" attribute was not present in the request or it was present and set to "false", the SUPI within the "supi" attribute or, if the "AKMA\_GPSI\_Support" feature is supported, either the SUPI within the "supi" attribute or the GPSI within the "gpsi" attribute. + +If the requested AKMA Application Key information for the UE does not exist, the AAnF shall respond with "204 No Content". + +If the NF service consumer is an NEF, and if UE identifier is required to relay to the AF based on local policy, the NEF invokes the Nudm\_SubscriberDataManagement service defined in 3GPP TS 29.503 [17] to translate the SUPI to a GPSI (External Id), and then invoke the AKMA API to include the GPSI (External Id) in the response to the AF as defined in 3GPP TS 29.522 [16]. The NEF shall not send the SUPI to the AF. + +#### 4.2.2.4 Naanf\_AKMA\_ContextRemove service operation + +##### 4.2.2.4.1 General + +The Naanf\_AKMA\_ContextRemove service operation is used by an NF service consumer to request the AAnF to remove the AKMA related key material. + +##### 4.2.2.4.2 AKMA Context removal + +Figure 4.2.2.4.2-1 shows a scenario where the NF service consumer sends a request to the AAnF to delete the AKMA related key material (as shown in 3GPP TS 33.535 [14]). + +![Sequence diagram showing the interaction between an NF service consumer and an AAnF for AKMA context removal. The consumer sends a POST request to /remove-context. The AAnF responds with either a 204 No Content or a 404 Not Found status.](410562339ce067fdc6fa41940c118658_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant AAnF + Note right of AAnF: 1. POST .../remove-context + AAnF->>NF service consumer: 2a. "204 No Content" +2b. "404 Not Found" + +``` + +Sequence diagram showing the interaction between an NF service consumer and an AAnF for AKMA context removal. The consumer sends a POST request to /remove-context. The AAnF responds with either a 204 No Content or a 404 Not Found status. + +Figure 4.2.2.4.2-1: NF service consumer request to remove the AKMA related key material + +The NF service consumer shall invoke the Naanf\_AKMA\_ContextRemove service operation to request the AAnF to remove the AKMA related key material. The NF service consumer shall send an HTTP POST request with "{apiRoot}/naanf-akma//remove-context" as Resource URI, as shown in figure 4.2.2.4.2-1, step 1, to request to remove AKMA related key material according to the value of the "CtxRemove" data type in the request body. + +If errors occur when processing the HTTP POST request, the AAnF shall send an HTTP error response as specified in clause 5.1.7. + +If the AAnF determines the received HTTP POST request needs to be redirected, the AAnF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +Upon the reception of the HTTP POST request, if the AKMA context (e.g. A-KID, KAKMA) for the UE has been removed successfully, the AAnF shall send an HTTP "204 No Content" response. + +If the AKMA Context resource does not exist, the AAnF shall respond with "404 Not Found" and the "cause" attribute of the "ProblemDetails" data structure set to "AKMA\_CONTEXT\_NOT\_FOUND". + +# 5 API Definitions + +## 5.1 Naanf\_AKMA Service API + +### 5.1.1 Introduction + +The Naanf\_AKMA service shall use the Naanf\_AKMA API. + +The API URI of the Naanf\_AKMA API shall be: + +**{apiRoot}
** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "naanf-akma". +- The shall be "v1". + +- The shall be set as described in clause 5.1.3 and 5.1.4. + +### 5.1.2 Usage of HTTP + +#### 5.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Naanf\_AKMA API is contained in Annex A. + +#### 5.1.2.2 HTTP standard headers + +##### 5.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 5.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 5.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +In this release of the specification, no specific custom headers are defined for the Naanf\_AKMA Service API. + +### 5.1.3 Resources + +There are no resources defined for this API in this release of the specification. + +### 5.1.4 Custom Operations without associated resources + +#### 5.1.4.1 Overview + +The structure of the custom operation URIs of the Naanf\_AKMA API is shown in figure 5.1.4.1-1. + +![Diagram showing the custom operation URI structure of the Naanf_AKMA API. The root path is {apiRoot}/naanf-akma/v1. Below this root, three custom operations are listed: /register-anchorkey, /retrieve-applicationkey, and /remove-context. Each operation is enclosed in a dashed box, and they are all connected to the root path by a vertical line.](1ce753126302304d15aa14ed37e8ac15_img.jpg) + +``` +graph TD; Root["{apiRoot}/naanf-akma/v1"] --- Op1["/register-anchorkey"]; Root --- Op2["/retrieve-applicationkey"]; Root --- Op3["/remove-context"]; +``` + +Diagram showing the custom operation URI structure of the Naanf\_AKMA API. The root path is {apiRoot}/naanf-akma/v1. Below this root, three custom operations are listed: /register-anchorkey, /retrieve-applicationkey, and /remove-context. Each operation is enclosed in a dashed box, and they are all connected to the root path by a vertical line. + +Figure 5.1.4.1-1: Custom operation URI structure of the Naanf\_AKMA API + +Table 5.1.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the Naanf\_AKMA API. + +**Table 5.1.4.1-1: Custom operations without associated resources** + +| Operation | Custom operation URI | Mapped HTTP method | Description | +|-------------------------|--------------------------|--------------------|---------------------------------------------------------| +| register-anchorkey | /register-anchorkey | POST | Request to store AKMA related key material in the AAnF. | +| retrieve-applicationkey | /retrieve-applicationkey | POST | Request to retrieve AKMA Application Key information. | +| remove-context | /remove-context | POST | Request to remove AKMA context in the AAnF. | + +#### 5.1.4.2 Operation: Register + +##### 5.1.4.2.1 Description + +The custom operation allows a NF service consumer to store AKMA related key material in the AAnF. + +##### 5.1.4.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 5.1.4.2.2-1 and 5.1.4.2.2-2. + +**Table 5.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|-----------------------------------------------------------------------| +| AkmaKeyInfo | M | 1 | AKMA related key material which is requested to be stored in the AAnF | + +**Table 5.1.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------| +| AkmaKeyInfo | M | 1 | 200 OK | The AKMA related key material was stored successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during the retrieval notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the retrieval notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.1.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 5.1.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +#### 5.1.4.3 Operation: Retrieve + +##### 5.1.4.3.1 Description + +The custom operation allows a NF service consumer to retrieve AKMA Application Key information for the UE. + +##### 5.1.4.3.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 5.1.4.3.2-1 and 5.1.4.3.2-2. + +**Table 5.1.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|---------------------------------------------------------------------| +| AkmaAfKeyRequest | M | 1 | Parameters to request to retrieve AKMA Application Key information. | + +**Table 5.1.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------| +| AkmaAfKeyData | M | 1 | 200 OK | The requested AKMA Application Key information was returned successfully. (NOTE 2) | +| n/a | | | 204 No Content | If the requested data does not exist, the AAnF shall respond with "204 No Content". | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during the retrieval notification.
(NOTE 4) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the retrieval notification.
(NOTE 4) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 3) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: For the "AkmaAfKeyData" data structure used in the current release of this specification, the "gps" attribute is not applicable and the "supi" attribute shall be included, except in the case of the anonymous user access procedure using the Naanf\_AKMA\_ApplicationKey\_AnonUser\_Get service operation, as defined in clause 6.2.2 of 3GPP TS 33.535 [14]. +NOTE 3: Failure cases are described in clause 5.1.7.3 +NOTE 4: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.1.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 5.1.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +#### 5.1.4.4 Operation: Remove + +##### 5.1.4.4.1 Description + +The custom operation allows a NF service consumer to delete the AKMA context for the UE. + +##### 5.1.4.4.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 5.1.4.4.2-1 and 5.1.4.4.2-2. + +**Table 5.1.4.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|--------------------------------------------------------------| +| CtxRemove | M | 1 | Parameters to request to delete the AKMA context for the UE. | + +**Table 5.1.4.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case: The AKMA context matching the "CtxRemove" in the request body was deleted, the AAnF shall respond with "204 No Content". | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during remove procedure. The response shall include a Location header field containing an alternative URI of the resource located in an alternative AAnF (service) instance. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during remove procedure. The response shall include a Location header field containing an alternative URI of the resource located in an alternative AAnF (service) instance. | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 5.1.7.3 + +**Table 5.1.4.4.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------| +| Location | String | M | 1 | An alternative URI of the resource located in an alternative AAnF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | String | O | 0..1 | Identifier of the target AAnF (service) instance towards which the request is redirected. | + +**Table 5.1.4.4.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative AAnF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target AAnF (service) instance towards which the request is redirected. | + +### 5.1.5 Notifications + +Notifications are not applicable to this API. + +### 5.1.6 Data Model + +#### 5.1.6.1 General + +This clause specifies the application data model supported by the Naanf\_AKMA API. + +Table 5.1.6.1-1 specifies the data types defined for the Naanf\_AKMA service based interface protocol. + +**Table 5.1.6.1-1: Naanf\_AKMA specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------|----------------|-----------------------------------------|---------------| +| AkmaKeyInfo | 5.1.6.2.2 | AKMA related key material. | | +| CtxRemove | 5.1.6.2.3 | Indicate the AKMA context to be remove. | | + +Table 5.1.6.1-2 specifies data types re-used by the Naanf\_AKMA service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Naanf\_AKMA service based interface. + +**Table 5.1.6.1-2: Naanf\_AKMA re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|---------------------------------------------------------------------|---------------| +| AKId | 3GPP TS 29.522 [16] | | | +| AkmaAfKeyData | 3GPP TS 29.522 [16] | Parameters to present AKMA Application Key information. | | +| AkmaAfKeyRequest | 3GPP TS 29.522 [16] | Parameters to request to retrieve AKMA Application Key information. | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information. | | +| Supi | 3GPP TS 29.571 [15] | Represents the SUPI. | | +| Gpsi | 3GPP TS 29.571 [15] | Represents the GPSI. | | +| SupportedFeatures | 3GPP TS 29.571 [15] | Used to negotiate the applicability of the optional features. | | + +#### 5.1.6.2 Structured data types + +##### 5.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 5.1.6.2.2 Type: AkmaKeyInfo + +Table 5.1.6.2.2-1: Definition of type AkmaKeyInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------|-------------------| +| supi | Supi | C | 0..1 | SUPI of the UE.

(NOTE) | | +| aKid | AKId | M | 1 | A-KID | | +| kAkma | string | M | 1 | KAKMA | | +| gpsi | Gpsi | C | 0..1 | GPSI of the UE.

(NOTE) | AKMA_GPSI_Support | +| suppFeat | SupportedFeatures | O | 0..1 | Indicates the list of Supported features used as described in clause 5.1.8. | | + +NOTE: When the "AKMA\_GPSI\_Support" feature is supported, the presence of "supi" attribute and the "gpsi" attribute are mutually exclusive. When the "AKMA\_GPSI\_Support" feature is not supported, only the "supi" attribute shall be present. + +##### 5.1.6.2.3 Type: CtxRemove + +Table 5.1.6.2.3-1: Definition of type CtxRemove + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| supi | Supi | C | 0..1 | SUPI of UE | | + +NOTE: In current release of specification, only "supi" can be used to indicate the AKMA context to be remove. The "supi" attribute shall be included. + +#### 5.1.6.3 Simple data types and enumerations + +##### 5.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 5.1.6.3.2 Simple data types + +None in this release of the specification. + +#### 5.1.6.4 Data types describing alternative data types or combinations of data types + +None in this release of the specification. + +#### 5.1.6.5 Binary data + +None in this release of the specification. + +### 5.1.7 Error Handling + +#### 5.1.7.1 General + +For the Naanf\_AKMA API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Naanf\_AKMA API. + +#### 5.1.7.2 Protocol Errors + +No specific procedures for the Naanf\_AKMA service are specified. + +#### 5.1.7.3 Application Errors + +The application errors defined for the Naanf\_AKMA service are listed in Table 5.1.7.3-1. + +**Table 5.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| K_AKMA_NOT_PRESENT | 403 Forbidden | Indicates that the K AKMA identified by the A-KID provided in the AKMA Application Key retrieval request body is not present at the AAnF. | +| AKMA_CONTEXT_NOT_FOUND | 404 Not Found | Indicates that the AKMA context to be deleted indicated by the "CtxRemove" Data type in the request body is not found. | + +### 5.1.8 Feature negotiation + +The optional features in table 5.1.8-1 are defined for the Naanf\_AKMA API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------|-------------------------------------------------------------------------------------------------------------------------| +| 1 | AKMA_GPSI_Support | This feature indicates the support of sending the GPSI as an alternative UE ID to an internal AF based on local policy. | + +### 5.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Naanf\_AKMA API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Naanf\_AKMA API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Naanf\_AKMA service. + +The Naanf\_AKMA API defines the following scopes for OAuth2 authorization as described in clause 4.10 of 3GPP TS 29.501 [5]. + +**Table 5.1.9-1: OAuth2 scopes defined in Naanf\_AKMA API** + +| Scope | Description | +|--------------------------------------------|------------------------------------------------------------------------------------------------------------------| +| "naanf-akma" | Access to the Naanf_AKMA API | +| "naanf-akma:anchorkey" | Access to service operations applying to store and remove the AKMA related key material. | +| "naanf-akma:applicationkeyget" | Access to service operations applying to request the AKMA Application Key information for the UE. | +| "naanf-akma:applicationkeyget:supi-access" | Access to the Naanf_AKMA API to enable the returning of SUPI in the AKMA Application Key information for the UE. | + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Naanf\_AKMA API + +``` +openapi: 3.0.0 +info: + title: 3gpp-akma + version: 1.1.0-alpha.4 + description: | + API for Naanf_AKMA. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.535 V18.3.0; 5G System; AKMA Anchor Services. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.535/' + +security: +- {} +- oAuth2ClientCredentials: + - naanf-akma + +servers: +- url: '{apiRoot}/naanf-akma/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +paths: + /register-anchorkey: + post: + summary: Store AKMA related key material. + operationId: RegisterAKMAKey + tags: + - Register the AKMA related key material + security: + - {} + - oAuth2ClientCredentials: + - naanf-akma + - oAuth2ClientCredentials: + - naanf-akma + - naanf-akma:anchorkey + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AkmaKeyInfo' + responses: + '200': + description: The requested information was returned successfully. +``` + +``` + +content: + application/json: + schema: + $ref: '#/components/schemas/AkmaKeyInfo' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/retrieve-applicationkey: + post: + summary: Request to retrieve AKMA Application Key information. + operationId: GetAKMAAPPKeyMaterial + tags: + - Retrieve the AKMA Application key material (Collection) + security: + - {} + - oAuth2ClientCredentials: + - naanf-akma + - oAuth2ClientCredentials: + - naanf-akma + - naanf-akma:applicationkeyget + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29522_AKMA.yaml#/components/schemas/AkmaAfKeyRequest' + responses: + '200': + description: The requested information was returned successfully. + content: + application/json: + schema: + $ref: 'TS29522_AKMA.yaml#/components/schemas/AkmaAfKeyData' + '204': + description: No Content (The requested AKMA Application material does not exist.) + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/remove-context: + post: + summary: Request to remove the AKMA related key material. + operationId: RemoveContext + tags: + - Remove the AKMA Application key material (deletion) + security: + - {} + - oAuth2ClientCredentials: + - naanf-akma + - oAuth2ClientCredentials: + - naanf-akma + - naanf-akma:anchorkey + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CtxRemove' + responses: + '204': + description: No Content (The AKMA context for the UE has been removed successfully.) + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + naanf_akma: Access to the Naanf_AKMA API + naanf_akma:anchorkey: > + Access to service operations applying to store or remove the AKMA related key + material. + naanf_akma:applicationkeyget: > + Access to service operations applying to request the AKMA Application Key information +``` + +``` + for the UE. + naanf-akma:applicationkeyget:supi-access: > + Return SUPI in the AKMA Application Key information for the UE. + +schemas: + AkmaKeyInfo: + description: Represents AKMA related key material. + type: object + properties: + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + aKId: + $ref: 'TS29522_AKMA.yaml#/components/schemas/AKId' + kAkma: + type: string + required: + - aKId + - kAkma + oneOf: + - required: [supi] + - required: [gpsi] + +CtxRemove: + description: > + Parameters to request to delete the AKMA context for the UE, the "supi" attribute shall be + included. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2020-11 | CT3#112e | | | | | TS skeleton of AKMA Anchor Services. | 0.0.0 | +| 2020-11 | CT3#112e | | | | | Inclusion of documents agreed in CT3#112e C3-205585, C3-205586. | 0.1.0 | +| 2021-01 | CT3#113e | | | | | Inclusion of documents agreed in CT3#113e C3-210291, C3-210292, C3-210222, C3-210293, C3-210294, C3-210295. | 0.2.0 | +| 2021-01 | CT3#113e | | | | | Inclusion of documents agreed in CT3#114e C3-211238, C3-21396, C3-211397, C3-211398, C3-211399, C3-211400, and C3-211401. | 0.3.0 | +| 2021-03 | CT#91e | CP-210182 | | | | Sent to plenary for Approval | 1.0.0 | +| 2021-03 | CT#91e | CP-210182 | | | | TS approved by plenary | 17.0.0 | +| 2021-06 | CT#92e | CP-211234 | 0001 | 1 | F | Adding a missing description field to data type definitions in OpenAPI specification files of the Naanf_AKMA API | 17.1.0 | +| 2021-06 | CT#92e | CP-211214 | 0002 | 1 | F | Adding a missing description field to data type definitions in OpenAPI specification files of the Naanf_AKMA API | 17.1.0 | +| 2021-06 | CT#92e | CP-211214 | 0003 | | F | Adding Clause 5.1.4.3.1 | 17.1.0 | +| 2021-06 | CT#92e | CP-211214 | 0005 | 1 | F | Custom operation URI | 17.1.0 | +| 2021-06 | CT#92e | CP-211214 | 0006 | | F | Terminology alignment of AKMA Application Key information | 17.1.0 | +| 2021-06 | CT#92e | CP-211234 | 0007 | 1 | F | Redirect responses with "application/json" media type | 17.1.0 | +| 2021-06 | CT#92e | CP-211234 | 0008 | 1 | F | Optional header clarification | 17.1.0 | +| 2021-06 | CT#92e | CP-211265 | 0009 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-09 | CT#93e | CP-212220 | 0011 | 1 | F | CR 0011 29.535 Rel-17 Correcting CR #0007 implementation | 17.2.0 | +| 2021-12 | CT#94e | CP-213218 | 0012 | 2 | B | Naanf_AKMA_ContextRemove service operation | 17.3.0 | +| 2021-12 | CT#94e | CP-213218 | 0014 | 2 | F | Correction on Naanf_AKMA_ApplicationKey_Get service operation on sending UE ID to the AKMA AF | 17.3.0 | +| 2021-12 | CT#94e | CP-213246 | 0015 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2022-01 | | | | | | Update of specification filename in the zip | 17.3.1 | +| 2022-03 | CT#95e | CP-220180 | 0016 | | B | Specifying the error case of KAKMA key not present in the AAnF | 17.4.0 | +| 2022-03 | CT#95e | CP-220180 | 0017 | 1 | F | Miscellaneous corrections | 17.4.0 | +| 2022-03 | CT#95e | CP-220194 | 0018 | | F | Update of info and externalDocs fields | 17.4.0 | +| 2022-06 | CT#96 | CP-221159 | 0019 | | F | Update of info and externalDocs fields | 17.5.0 | +| 2022-09 | CT#97e | CP-222096 | 0020 | 2 | F | Application errors reference update in the tables defining methods on the resources for Naanf_AKMA API | 17.6.0 | +| 2022-09 | CT#97e | CP-222096 | 0021 | 1 | F | Support for Naanf_AKMA_ApplicationKey_AnonUser_Get service operation | 17.6.0 | +| 2022-09 | CT#97e | CP-222096 | 0023 | | F | Missing redirection in AKMA Context removal procedure | 17.6.0 | +| 2022-09 | CT#97e | CP-222121 | 0024 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-12 | CT#98e | CP-223168 | 0026 | 1 | F | Correction for AKMA Application Key Request | 17.7.0 | +| 2022-12 | CT#98e | CP-223168 | 0027 | 1 | F | Cardinality for CtxRemove | 17.7.0 | +| 2022-12 | CT#98e | CP-223188 | 0028 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-12 | CT#98e | CP-223191 | 0025 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0029 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230167 | 0030 | 1 | B | OAuth2 scopes in Naanf_AKMA API | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0031 | | F | Miscellaneous changes in Naanf_AKMA API | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0033 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231131 | 0034 | 1 | F | Correction of a referenced clause number | 18.2.0 | +| 2023-06 | CT#100 | CP-231261 | 0037 | 2 | B | Including GPSI attribute support | 18.2.0 | +| 2023-06 | CT#100 | CP-231132 | 0040 | 1 | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0041 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232086 | 0039 | 2 | F | Support for SUPI access in AKMA Application Key information | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0042 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233229 | 0044 | 1 | F | IETF RFC 7540, RFC 7807 obsoleted by RFC 9113 and RFC 9457 respectively | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29536/1b893df61c2b73b7a85e65fc1f58e203_img.jpg b/raw/rel-18/29_series/29536/1b893df61c2b73b7a85e65fc1f58e203_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f111d8d889d96db0c6bf29e977e208be23912fde --- /dev/null +++ b/raw/rel-18/29_series/29536/1b893df61c2b73b7a85e65fc1f58e203_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:694904758b11130cf995a96d314ad0f4dcf4a35e01d4d8d7c91354951797bd4b +size 36351 diff --git a/raw/rel-18/29_series/29536/1c29dadab94c3fa552d270434db09c81_img.jpg b/raw/rel-18/29_series/29536/1c29dadab94c3fa552d270434db09c81_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..09d928840e3538313ed5ca8d1049d47318ebdc1b --- /dev/null +++ b/raw/rel-18/29_series/29536/1c29dadab94c3fa552d270434db09c81_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:766fa55e969094bd2c926e528a817141b105e7a1e290bf312060b24be27d66d7 +size 35472 diff --git a/raw/rel-18/29_series/29536/2834bdd6eb8540277e609decbb924003_img.jpg b/raw/rel-18/29_series/29536/2834bdd6eb8540277e609decbb924003_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3fbb970f5d8f294bad52d5e733c65c5b37bd083b --- /dev/null +++ b/raw/rel-18/29_series/29536/2834bdd6eb8540277e609decbb924003_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f263babd30896cfb8eae7cdb9eb12e056910ff06620e18eaf653a70b59fc616d +size 43294 diff --git a/raw/rel-18/29_series/29536/35127fe87029df6f5f0b2ee85f6193f1_img.jpg b/raw/rel-18/29_series/29536/35127fe87029df6f5f0b2ee85f6193f1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8950c8db05ce390c006a7ba2bcccbb4b4c13f99b --- /dev/null +++ b/raw/rel-18/29_series/29536/35127fe87029df6f5f0b2ee85f6193f1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:104e81043b7aefc4b48b299328605633d238e6b1b1dd16100e070a2b943fea71 +size 38150 diff --git a/raw/rel-18/29_series/29536/6be06b7dc72bb42afcb3465394667c3b_img.jpg b/raw/rel-18/29_series/29536/6be06b7dc72bb42afcb3465394667c3b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4c0603dd0b9550e2041599d4d8ce6c52ff0d77df --- /dev/null +++ b/raw/rel-18/29_series/29536/6be06b7dc72bb42afcb3465394667c3b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7801a73cff36035130c4b788f35664a719946c3ce5a506211509ebfdeb3fcf20 +size 22793 diff --git a/raw/rel-18/29_series/29536/6f659142d4789aa889184459f884787e_img.jpg b/raw/rel-18/29_series/29536/6f659142d4789aa889184459f884787e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..958f558ad830db8e9665392ebe7f05be75c3d9a6 --- /dev/null +++ b/raw/rel-18/29_series/29536/6f659142d4789aa889184459f884787e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cdb88c6ce90c323d03730cb49448affa915530cfbd3784ae140322aa7de9dd87 +size 64786 diff --git a/raw/rel-18/29_series/29536/7efae06af3af43ffe5d4b956a679cf54_img.jpg b/raw/rel-18/29_series/29536/7efae06af3af43ffe5d4b956a679cf54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..db2788ca35454e2a5b8a515dc737c5893d641d45 --- /dev/null +++ b/raw/rel-18/29_series/29536/7efae06af3af43ffe5d4b956a679cf54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ba31d44bdb31796ccc446d87761905422b60b0c1648de391980e91076956c960 +size 43599 diff --git a/raw/rel-18/29_series/29536/a0739aaf13fa5a632d4faa830f6b2708_img.jpg b/raw/rel-18/29_series/29536/a0739aaf13fa5a632d4faa830f6b2708_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0c6d03b0bf31b265ac7ed3d822ee12f3fbdddabc --- /dev/null +++ b/raw/rel-18/29_series/29536/a0739aaf13fa5a632d4faa830f6b2708_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ba6fd467b88b4b36c2ee03b67c2e43bd92ff93433b350be1ad5adea285e4f58 +size 57548 diff --git a/raw/rel-18/29_series/29536/e90987faabad6a6665cd8ed1151dc474_img.jpg b/raw/rel-18/29_series/29536/e90987faabad6a6665cd8ed1151dc474_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..345a559296b15491575972e07d0cc6c00f46519b --- /dev/null +++ b/raw/rel-18/29_series/29536/e90987faabad6a6665cd8ed1151dc474_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:640f6a7665167ce9b05857f252e9774f2be223acdc8d9ad20440826c10e96e84 +size 61453 diff --git a/raw/rel-18/29_series/29537/3f36a9a4e71c8afdba94d0eb5b2ebab8_img.jpg b/raw/rel-18/29_series/29537/3f36a9a4e71c8afdba94d0eb5b2ebab8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ed61bcc7f94d1a4f0664c2fe3ac7c48d62bd8286 --- /dev/null +++ b/raw/rel-18/29_series/29537/3f36a9a4e71c8afdba94d0eb5b2ebab8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cfbbb1c6ee41325e857265e0c231c5f9e173ce3b00fa17473eb921614fefb5a4 +size 25383 diff --git a/raw/rel-18/29_series/29537/58f4167687de8d7339594e5f6fbe0bc6_img.jpg b/raw/rel-18/29_series/29537/58f4167687de8d7339594e5f6fbe0bc6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..31ddb87ba0d47354455dabe687f487ff61b6bcfb --- /dev/null +++ b/raw/rel-18/29_series/29537/58f4167687de8d7339594e5f6fbe0bc6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6691c7e87a74f275f628e0f10d1bfa1e398108ca6b8b61667ff3cd55d74a031f +size 22988 diff --git a/raw/rel-18/29_series/29537/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29537/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bf7cc2dd5b314634a48452e47f50ce2f92a92702 --- /dev/null +++ b/raw/rel-18/29_series/29537/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b8814de1fbff7ae292705b01c7038296972bd3c605b2642eb93b4961bc7f5ab1 +size 9912 diff --git a/raw/rel-18/29_series/29537/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29537/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..24c60362643fc90d4226c106b880bb314f8c0b9d --- /dev/null +++ b/raw/rel-18/29_series/29537/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a63f70c1a812a534cbb5a37e04fb4614e5004bf260eab66035c88a881df1f9ad +size 5396 diff --git a/raw/rel-18/29_series/29537/6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg b/raw/rel-18/29_series/29537/6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c5ad8c7b686d18d6bb68677e6f3e5dd9fcadc97e --- /dev/null +++ b/raw/rel-18/29_series/29537/6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:49bfcccb2f99e984eced83d4a2d1af0023428815e34daa94f314d0d38f966354 +size 23890 diff --git a/raw/rel-18/29_series/29537/805c475f0859e607af0530ba43194bf1_img.jpg b/raw/rel-18/29_series/29537/805c475f0859e607af0530ba43194bf1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c6745985d8cdd7b23474e0ef11aa6d2ef893f7dd --- /dev/null +++ b/raw/rel-18/29_series/29537/805c475f0859e607af0530ba43194bf1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e5ca367a247f8e7671c4ffe1f48c33f6f0153fd9ee19f8a266c9ce15552b567c +size 24050 diff --git a/raw/rel-18/29_series/29537/a7079ddb124df3f1ee13ae406c7c8982_img.jpg b/raw/rel-18/29_series/29537/a7079ddb124df3f1ee13ae406c7c8982_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dde39db9c69ec517db57ca78d989c6523452e39e --- /dev/null +++ b/raw/rel-18/29_series/29537/a7079ddb124df3f1ee13ae406c7c8982_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b1783025e5bddca4f96e7736a1339b23ea727223a76037fbdf45ce16fc4a3f96 +size 25778 diff --git a/raw/rel-18/29_series/29537/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg b/raw/rel-18/29_series/29537/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a7203b9a9dd0bc00c555606357c7bdd19a1a2613 --- /dev/null +++ b/raw/rel-18/29_series/29537/b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:90c00d7f727369469b06d90f9127ed71ab75c15ffb195de7d8224961eb17c279 +size 22323 diff --git a/raw/rel-18/29_series/29537/c036e2540a94b31357ceb0002f0cacab_img.jpg b/raw/rel-18/29_series/29537/c036e2540a94b31357ceb0002f0cacab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b0dd8fc84c13c84ffb7be9ea8c95b119a6d6980b --- /dev/null +++ b/raw/rel-18/29_series/29537/c036e2540a94b31357ceb0002f0cacab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b868aac07ad7a54be99cb348653fa61d5d1ee0bb306f0315c3eed0b9954ab91d +size 29719 diff --git a/raw/rel-18/29_series/29537/d3b5eac55166fc428a223bba5c46961b_img.jpg b/raw/rel-18/29_series/29537/d3b5eac55166fc428a223bba5c46961b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e6f10b06b0ed8aa530b30c7b18af19362240e409 --- /dev/null +++ b/raw/rel-18/29_series/29537/d3b5eac55166fc428a223bba5c46961b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:823af855c6364cb4c85da22d0ff89995687031cd27a8cd7b2f1a04c196d30372 +size 26659 diff --git a/raw/rel-18/29_series/29537/e6df2733626a85205c1db682e6259c46_img.jpg b/raw/rel-18/29_series/29537/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5619f896dc8766810193f78628b7762998e3a2ea --- /dev/null +++ b/raw/rel-18/29_series/29537/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:862f78c599642e2a9cc15bd78a88559f11ab9bc9c7bc73a359716e26a82f4917 +size 14589 diff --git a/raw/rel-18/29_series/29537/ff5f89b660edddb67971d7d3d4ce87ef_img.jpg b/raw/rel-18/29_series/29537/ff5f89b660edddb67971d7d3d4ce87ef_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..26ab84df54b40899ada8a21266c3ea6dba5c950b --- /dev/null +++ b/raw/rel-18/29_series/29537/ff5f89b660edddb67971d7d3d4ce87ef_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aca305ec0a0e8280574cd430ac6653cfc0deddcc1d4b594820de7a6beca227ef +size 17553 diff --git a/raw/rel-18/29_series/29540/5a4e62bead259c258d069fd3663ea670_img.jpg b/raw/rel-18/29_series/29540/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..07313d9a84e55a224423a0061ee77b96901e6ff6 --- /dev/null +++ b/raw/rel-18/29_series/29540/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ca2ae979e89be65a49ff43fdd33021906d635c848d2a3587b6f07053baf609d7 +size 50338 diff --git a/raw/rel-18/29_series/29540/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29540/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2b3671bab63f21fbdc7430f89ae29551c96dba14 --- /dev/null +++ b/raw/rel-18/29_series/29540/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4942b386e3e5a523418d752c92b6e66d6a7ca15ae1a4eda836cd8cb018aad8b0 +size 9551 diff --git a/raw/rel-18/29_series/29540/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29540/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..702d6f4169aee6fa70c9f3184c931c4080e8dbf3 --- /dev/null +++ b/raw/rel-18/29_series/29540/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fc97316c5fafdad0e3c9f0296d983b6bd81ef7c0e853562fc0161f1272fb6841 +size 5654 diff --git a/raw/rel-18/29_series/29540/66c2bf11a8f117cddf67eff92d4c736c_img.jpg b/raw/rel-18/29_series/29540/66c2bf11a8f117cddf67eff92d4c736c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d2cc7e9793b268498464ed535ac8649931c11427 --- /dev/null +++ b/raw/rel-18/29_series/29540/66c2bf11a8f117cddf67eff92d4c736c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee9a911c096a0c40a045b50a82c431e91d4349feb98b21b2ffd3cdc698843eb8 +size 42753 diff --git a/raw/rel-18/29_series/29540/7f17c430b9598e4d748a8041457810b3_img.jpg b/raw/rel-18/29_series/29540/7f17c430b9598e4d748a8041457810b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a849d05ba6f5d0a33ab0ad9b4ea90b8c754d7269 --- /dev/null +++ b/raw/rel-18/29_series/29540/7f17c430b9598e4d748a8041457810b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:42544c859d0b7a1fd3f0f3510bb30994745f3f84c0738664964224a2a9ceb194 +size 38823 diff --git a/raw/rel-18/29_series/29540/8307f6b04df072c9332f9987e034272c_img.jpg b/raw/rel-18/29_series/29540/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1b9b332d986308b30ab672c79a9822241e288da8 --- /dev/null +++ b/raw/rel-18/29_series/29540/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b8f3905b0e7960240ac164e63da167512daddfeda24d859b9dbbec1ff2b58daf +size 19311 diff --git a/raw/rel-18/29_series/29540/af6be343f0c0a8f155f965dcf337b8af_img.jpg b/raw/rel-18/29_series/29540/af6be343f0c0a8f155f965dcf337b8af_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..af542d57a4b71c62903972cb5b7bea843872c5a1 --- /dev/null +++ b/raw/rel-18/29_series/29540/af6be343f0c0a8f155f965dcf337b8af_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c24a465238ca28a69ba4bec504cd7575afaa02d069b1cbfb5ea321e1da4a642f +size 41911 diff --git a/raw/rel-18/29_series/29540/cce70c739081f63a6af83dc9483f98ce_img.jpg b/raw/rel-18/29_series/29540/cce70c739081f63a6af83dc9483f98ce_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aab7cc59d881693d7bf5e1a4ec38a529425d30d7 --- /dev/null +++ b/raw/rel-18/29_series/29540/cce70c739081f63a6af83dc9483f98ce_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:da8ea55bb1e5c425532c4841dd52221e88ed098f2f2bf7a534b7771732d4d34c +size 42305 diff --git a/raw/rel-18/29_series/29540/d0abac95583b52a3b35f74a215567334_img.jpg b/raw/rel-18/29_series/29540/d0abac95583b52a3b35f74a215567334_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b299a4c80c4f25c73c63d93aad360d7d6d4f14ce --- /dev/null +++ b/raw/rel-18/29_series/29540/d0abac95583b52a3b35f74a215567334_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:50eeb893cdd9a0df6e058cf3b7e2ae97ec60762818adbe92c208ab3c0ce475f2 +size 18999 diff --git a/raw/rel-18/29_series/29540/e6df2733626a85205c1db682e6259c46_img.jpg b/raw/rel-18/29_series/29540/e6df2733626a85205c1db682e6259c46_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5b0e24c91064aa73815d53aca5043cc31c6b2107 --- /dev/null +++ b/raw/rel-18/29_series/29540/e6df2733626a85205c1db682e6259c46_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:26091fe706c795215225b71f7bf5c9c269fe4c84b6df08cdb1728a10eae40b21 +size 45146 diff --git a/raw/rel-18/29_series/29549/02d7901f2a570d0c08f8b2b310ec6826_img.jpg b/raw/rel-18/29_series/29549/02d7901f2a570d0c08f8b2b310ec6826_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f1e8e67ae25ec34d002e6c39df32775fde2e9ea8 --- /dev/null +++ b/raw/rel-18/29_series/29549/02d7901f2a570d0c08f8b2b310ec6826_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5ed8bf8defeb69a337784cca082ce94a22201be91cf5306ffa2a4bdde85ee7e1 +size 17221 diff --git a/raw/rel-18/29_series/29549/18bb06865e2dada3656ea3d57f290f7f_img.jpg b/raw/rel-18/29_series/29549/18bb06865e2dada3656ea3d57f290f7f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1baf2597c7922f752a7ba973ad6be3f43ecf2ddd --- /dev/null +++ b/raw/rel-18/29_series/29549/18bb06865e2dada3656ea3d57f290f7f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:689de27f86a0a30506b7bb36fb03913672559e422b579a1423e7d173e95047e4 +size 12356 diff --git a/raw/rel-18/29_series/29549/1dc67137b361f5ed5f660a282155a4ed_img.jpg b/raw/rel-18/29_series/29549/1dc67137b361f5ed5f660a282155a4ed_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..687f43b538a3a4109cb229b188ffaed5623f8346 --- /dev/null +++ b/raw/rel-18/29_series/29549/1dc67137b361f5ed5f660a282155a4ed_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5f5a54e9ed6e23b7bfe9106d5dddff5b1960a2bd8fea55de417f83c40913d900 +size 18816 diff --git a/raw/rel-18/29_series/29549/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29549/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1638b06d52c5d1dfec3ced77b45b4a01530a1f16 --- /dev/null +++ b/raw/rel-18/29_series/29549/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20accf7ca410f3a9ac2cb7473b623bfbc4df0ca44f89ca66f32ef38aa9d42073 +size 9330 diff --git a/raw/rel-18/29_series/29549/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29549/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1066c0e5300415bdc586bfbe59d580dfc5f26c17 --- /dev/null +++ b/raw/rel-18/29_series/29549/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d3b60e06186f89fda3711a10bc5c4264d738422b2027f1c292d0f2306e1df872 +size 6234 diff --git a/raw/rel-18/29_series/29549/64cda8ce20067bc360ce2f3a5c9352b7_img.jpg b/raw/rel-18/29_series/29549/64cda8ce20067bc360ce2f3a5c9352b7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2207647f71c0cbf50a6d14a2c3bd642ef9d6710a --- /dev/null +++ b/raw/rel-18/29_series/29549/64cda8ce20067bc360ce2f3a5c9352b7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:091b1c4a30ae7be3f1d83482727ffcfbbbabf7fdca6e9fe9c87bad369447576f +size 29293 diff --git a/raw/rel-18/29_series/29549/728a02fe4a04e7f91835147194997cd4_img.jpg b/raw/rel-18/29_series/29549/728a02fe4a04e7f91835147194997cd4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ac0da7a1b924554726c5765b9d19c8f4e10c0392 --- /dev/null +++ b/raw/rel-18/29_series/29549/728a02fe4a04e7f91835147194997cd4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:968f35c89f301cfd74cce7a83f07bde8969f9969cc0506de5f51ca6020a2cb5d +size 21432 diff --git a/raw/rel-18/29_series/29549/741c2d8e08326c0614ebad35520ce985_img.jpg b/raw/rel-18/29_series/29549/741c2d8e08326c0614ebad35520ce985_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7ba7c9cd5bfda21b34ea60eb7150e2e7329a8727 --- /dev/null +++ b/raw/rel-18/29_series/29549/741c2d8e08326c0614ebad35520ce985_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1271d4806910d380a6fa921a59e71d749b032efd697db2bd38abb89728930903 +size 15794 diff --git a/raw/rel-18/29_series/29549/856d74cd46a3f383d2ffd19352028610_img.jpg b/raw/rel-18/29_series/29549/856d74cd46a3f383d2ffd19352028610_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..08a349ae8585416196fc1c8d92d38cb319b5d6ac --- /dev/null +++ b/raw/rel-18/29_series/29549/856d74cd46a3f383d2ffd19352028610_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:98e4427c8ea6c731b3b5fc177b7cacb05dd44e1b10737c2c7380e0711735baca +size 19930 diff --git a/raw/rel-18/29_series/29549/889982a45a70fa2e605a553842ce8952_img.jpg b/raw/rel-18/29_series/29549/889982a45a70fa2e605a553842ce8952_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c9af4b34cd1137909e2a1c44d807d4413f1f105a --- /dev/null +++ b/raw/rel-18/29_series/29549/889982a45a70fa2e605a553842ce8952_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:94e88e1a281f9e5a1fc0bca9c2cd92bf3bbe2e56faca0658095e6e8bda865f37 +size 20470 diff --git a/raw/rel-18/29_series/29549/8c01a58cf16e04fe66144b4f6a4e9cd4_img.jpg b/raw/rel-18/29_series/29549/8c01a58cf16e04fe66144b4f6a4e9cd4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d2265d39e70603115aef9cf85f0d3006c79a7384 --- /dev/null +++ b/raw/rel-18/29_series/29549/8c01a58cf16e04fe66144b4f6a4e9cd4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa3f3bbf2f50b7d185883d2f8440c6f9e356bfb630d2086f54d073551b849087 +size 17144 diff --git a/raw/rel-18/29_series/29549/98d0322515464572a78f3e4ee94105ed_img.jpg b/raw/rel-18/29_series/29549/98d0322515464572a78f3e4ee94105ed_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cc00d8ab12a233f4590ecab1f9c14dcd211aacfe --- /dev/null +++ b/raw/rel-18/29_series/29549/98d0322515464572a78f3e4ee94105ed_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9eb2d2e3bac6835737f16cf3ab5a630a781c65a48a7bf31b4e05e9b44187f1b1 +size 25909 diff --git a/raw/rel-18/29_series/29549/9c12d7993e786817c8c569e6f2d5a0a9_img.jpg b/raw/rel-18/29_series/29549/9c12d7993e786817c8c569e6f2d5a0a9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f0af511f0e8cd0821a257ed8ea68b098d0586618 --- /dev/null +++ b/raw/rel-18/29_series/29549/9c12d7993e786817c8c569e6f2d5a0a9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f986f1ec6c5553caeee10a87fcd79de8f965752fab0466cdbf2e7c93a120257f +size 16174 diff --git a/raw/rel-18/29_series/29549/9fd6e7ee2ef576eea5eb455b7ee80ed6_img.jpg b/raw/rel-18/29_series/29549/9fd6e7ee2ef576eea5eb455b7ee80ed6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..60a547ec103420d1a6875c56e4336142c86ef478 --- /dev/null +++ b/raw/rel-18/29_series/29549/9fd6e7ee2ef576eea5eb455b7ee80ed6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:da5b1e1c4907f7922fd6a8375d554716588694c403abeeb0d4d23877b2da1c69 +size 7794 diff --git a/raw/rel-18/29_series/29549/a3c1310e720178d2450a3748c7c75422_img.jpg b/raw/rel-18/29_series/29549/a3c1310e720178d2450a3748c7c75422_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..207804f3e044ec2fe312840231c63045549e3cd2 --- /dev/null +++ b/raw/rel-18/29_series/29549/a3c1310e720178d2450a3748c7c75422_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:82b5e6b818cb4de63e393811718ac77b6e6ce948afb380d7cf4dc192eb9f89d5 +size 27484 diff --git a/raw/rel-18/29_series/29549/bc41ad2c9e0c15b7e0564466eb61621f_img.jpg b/raw/rel-18/29_series/29549/bc41ad2c9e0c15b7e0564466eb61621f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..44823c80583d518e5e7da46df75d12572e8c4bb4 --- /dev/null +++ b/raw/rel-18/29_series/29549/bc41ad2c9e0c15b7e0564466eb61621f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa7a409fedf8c758a72655f84786a1642ac0745ba11fb77bb90e8e36025b0d41 +size 14951 diff --git a/raw/rel-18/29_series/29549/c21bad844b5cb6026c067a1f43ce67c3_img.jpg b/raw/rel-18/29_series/29549/c21bad844b5cb6026c067a1f43ce67c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..aaf025ebc5b6c642274fdda9d7f4364f6b977593 --- /dev/null +++ b/raw/rel-18/29_series/29549/c21bad844b5cb6026c067a1f43ce67c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1752e0f0b28faaab289fd3acc4488bc6d1cebc584bc06d3df5af92a82179d6a5 +size 88649 diff --git a/raw/rel-18/29_series/29549/cd359a6b82fb57f2445df4087b8b1423_img.jpg b/raw/rel-18/29_series/29549/cd359a6b82fb57f2445df4087b8b1423_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5f98c7b5f1fd9411786fae080999fc7a416db380 --- /dev/null +++ b/raw/rel-18/29_series/29549/cd359a6b82fb57f2445df4087b8b1423_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ef2da3760e2b9908cb3f95d13cb40703ef73bf9fe02a19301a9cb2a348103ac +size 11044 diff --git a/raw/rel-18/29_series/29549/daa086b264328b888e9d54b9bbad081e_img.jpg b/raw/rel-18/29_series/29549/daa086b264328b888e9d54b9bbad081e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b87a5d6cdaa435b9a9ed9b0ca681f9ec108942a9 --- /dev/null +++ b/raw/rel-18/29_series/29549/daa086b264328b888e9d54b9bbad081e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0ea8e75b16059f685b3d6bd8e2269ccbfc69070f3abd151fdf0f1e4548cc6572 +size 23737 diff --git a/raw/rel-18/29_series/29549/e002d1b87dc447584fd9829eac949a12_img.jpg b/raw/rel-18/29_series/29549/e002d1b87dc447584fd9829eac949a12_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..de99b9aab3c4efe0caa5aa69027e5001f84ef7e0 --- /dev/null +++ b/raw/rel-18/29_series/29549/e002d1b87dc447584fd9829eac949a12_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9d76ff79ceb6ba9a6773ea4bec7b32e3babc26ad645d0cd67a6e694aa8700385 +size 19334 diff --git a/raw/rel-18/29_series/29549/ed8597fae2e67db43518ae8bc46b6908_img.jpg b/raw/rel-18/29_series/29549/ed8597fae2e67db43518ae8bc46b6908_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a7c6cb9e2320050cfe0f6e5139adeb4b4848ee99 --- /dev/null +++ b/raw/rel-18/29_series/29549/ed8597fae2e67db43518ae8bc46b6908_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cb596baaedec54589d55d794838ca9f488dbcc69ca6811491696bdfc0d799167 +size 23405 diff --git a/raw/rel-18/29_series/29550/raw.md b/raw/rel-18/29_series/29550/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e60e845a2bd7bcfce79333642138477cf49c8a04 --- /dev/null +++ b/raw/rel-18/29_series/29550/raw.md @@ -0,0 +1,1115 @@ + + +# 3GPP TS 29.550 V18.2.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Steering of roaming application function services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Overview..... | 8 | +| 4.1 Introduction ..... | 8 | +| 5 Services offered by the SOR-AF ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Nsoraf_SteeringOfRoaming Service..... | 8 | +| 5.2.1 Service Description ..... | 8 | +| 5.2.2 Service Operations..... | 8 | +| 5.2.2.1 Introduction..... | 8 | +| 5.2.2.2 Get..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 SoR Information Retrieval ..... | 9 | +| 5.2.2.3 Info ..... | 10 | +| 5.2.2.3.1 General ..... | 10 | +| 5.2.2.3.2 SoR Acknowledgment Reception Notification ..... | 10 | +| 6 API Definitions ..... | 11 | +| 6.1 Nsoraf_SteeringOfRoaming Service API ..... | 11 | +| 6.1.1 Introduction ..... | 11 | +| 6.1.2 Usage of HTTP..... | 11 | +| 6.1.2.1 General..... | 11 | +| 6.1.2.2 HTTP standard headers..... | 11 | +| 6.1.2.2.1 General ..... | 11 | +| 6.1.2.2.2 Content type ..... | 11 | +| 6.1.2.2.3 Cache-Control ..... | 11 | +| 6.1.2.3 HTTP custom headers..... | 12 | +| 6.1.3 Resources..... | 12 | +| 6.1.3.1 Overview..... | 12 | +| 6.1.3.2 Resource: sor-information ..... | 12 | +| 6.1.3.2.1 Description ..... | 12 | +| 6.1.3.2.2 Resource Definition..... | 13 | +| 6.1.3.2.3 Resource Standard Methods..... | 13 | +| 6.1.3.2.3.1 GET ..... | 13 | +| 6.1.3.3 Resource: sor-ack..... | 14 | +| 6.1.3.3.1 Description ..... | 14 | +| 6.1.3.3.2 Resource Definition..... | 14 | +| 6.1.3.3.3 Resource Standard Methods..... | 14 | +| 6.1.3.3.3.1 PUT..... | 14 | +| 6.1.4 Custom Operations without associated resources ..... | 15 | +| 6.1.5 Notifications ..... | 15 | +| 6.1.5.1 General..... | 15 | +| 6.1.6 Data Model ..... | 16 | +| 6.1.6.1 General..... | 16 | +| 6.1.6.2 Structured data types..... | 16 | +| 6.1.6.2.1 Introduction ..... | 16 | +| 6.1.6.2.2 Type: SorInformation..... | 17 | +| 6.1.6.2.3 Type: SorAckInfo..... | 20 | +| 6.1.6.2.4 Type: SteeringContainer ..... | 20 | + +| | | | +|-------------------------------|-----------------------------------------|-----------| +| 6.1.6.2.5 | Type: SteeringInfo..... | 21 | +| 6.1.6.3 | Simple data types and enumerations..... | 21 | +| 6.1.6.3.1 | Introduction ..... | 21 | +| 6.1.6.3.2 | Simple data types ..... | 21 | +| 6.1.6.3.3 | Enumeration: SorAckStatus ..... | 21 | +| 6.1.7 | Error Handling ..... | 22 | +| 6.1.7.1 | General ..... | 22 | +| 6.1.7.2 | Protocol Errors ..... | 22 | +| 6.1.7.3 | Application Errors..... | 22 | +| 6.1.8 | Feature negotiation ..... | 22 | +| 6.1.9 | Security ..... | 22 | +| 6.1.10 | HTTP redirection..... | 23 | +| Annex A (normative): | OpenAPI specification ..... | 24 | +| A.1 | General..... | 24 | +| A.2 | Nsoraf_SOR API..... | 24 | +| Annex B (informative): | Change history..... | 28 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nsoraf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the SOR-AF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. The stage 2 architecture and procedures for 5G Steering of Roaming are specified in 3GPP TS 23.122 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: HTTP/2. +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". + +- [14] 3GPP TS 23.122: "Non-Access-Stratum (NAS) functions related to Mobile Station (MS) in idle mode". +- [15] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [17] 3GPP TS 31.115: "Secured packet structure for (Universal) Subscriber Identity Module (U)SIM Toolkit applications". +- [18] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [19] 3GPP TS 29.544: "5G System; Secured Packet Application Function (SP-AF) services; Stage 3". +- [20] 3GPP TS 29.509: "Authentication Server Services; Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Terms + +**SoR Information:** In this specification, this refers to the following HPLMN information: + +- a) an indication of whether the SOR-AF requires the UDM to request an acknowledgement from the UE for successful reception of the Steering of Roaming information; and +- b) one of the following: + - a list of preferred PLMN/access technology combinations with an indication that it is included; + - a secured packet with an indication that it is included; or + - the HPLMN indication that 'no change of the "Operator Controlled PLMN Selector with Access Technology" list stored in the UE is needed and thus no list of preferred PLMN/access technology combinations is provided'. + +NOTE: The secured packet contains the list of preferred PLMN/access technology combinations encapsulated with a security mechanism as described in 3GPP TS 31.115 [17]. + +## 3.2 Symbols + +Void. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|------------------------------------------| +| JSON | Javascript Object Notation | +| NF | Network Function | +| SOR-AF | Steering Of Roaming Application Function | +| SoR | Steering of Roaming | +| SUPI | Subscription Permanent Identifier | +| UDM | Unified Data Management | +| UE | User Equipment | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the Steering Of Roaming Application Function (SOR-AF) provides services (see 3GPP TS 23.122 [14]) to NF service consumers (e.g. UDM) via the Nsoraf service based interface. + +NOTE: The generation and calculation of the SoR information and associated roaming business logic are out of scope of this document. + +Figure 4.1-1 depicts the reference architecture of the SOR-AF. + +![Figure 4.1-1: Reference model – SOR-AF. A diagram showing an 'NF Service Consumer' box connected to a green 'SOR-AF' box via a line labeled 'Nsoraf'.](e1a0d046fbe7f28f5e93a47091851747_img.jpg) + +``` + +graph LR + A[NF Service Consumer] -- Nsoraf --> B[SOR-AF] + +``` + +Figure 4.1-1: Reference model – SOR-AF. A diagram showing an 'NF Service Consumer' box connected to a green 'SOR-AF' box via a line labeled 'Nsoraf'. + +Figure 4.1-1: Reference model – SOR-AF + +# 5 Services offered by the SOR-AF + +## 5.1 Introduction + +The SOR-AF offers the following services to NF consumers (e.g. UDM) via the Nsoraf service based interface: + +- Nsoraf\_SteeringOfRoaming + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +Table 5.1-1: APIs Description + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------------------|--------|------------------------------------|----------------------------|------------|-------| +| Nsoraf_SteeringOfRoaming | 6.1 | Nsoraf Steering Of Roaming Service | TS29550_Nsoraf_SOR.yaml | nsoraf-sor | A.2 | + +## 5.2 Nsoraf\_SteeringOfRoaming Service + +### 5.2.1 Service Description + +The Nsoraf\_SteeringOfRoaming (Nsoraf\_SOR) service provides Steering of Roaming services to NF consumers (e.g. UDM) to enable the retrieval of SoR information (i.e. the list of preferred PLMN/access technology combinations or an indication that no update to the list of preferred PLMN/access technology combinations is needed) to be conveyed to the UE, as specified in Annex C of 3GPP TS 23.122 [14]. The latter specifies the 5GS control plane mechanism for Steering of Roaming that aims at allowing the HPLMN to update the "Operator Controlled PLMN Selector with Access Technology" list in the UE by providing and updating this list of preferred PLMN/access technology combinations. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nsoraf\_SteeringOfRoaming service, the following service operations are defined: + +- Get +- Info + +#### 5.2.2.2 Get + +##### 5.2.2.2.1 General + +This service operation is used by a NF consumer (e.g. UDM) to retrieve SoR information. + +The returned information can consist of either: + +- a list of preferred PLMN/access technology combinations; +- a secured packet; +- neither of them. + +NOTE: The secured packet contains the list of preferred PLMN/access technology combinations encapsulated with a security mechanism as described in 3GPP TS 31.115 [17]. + +The following procedures are supported using the "Get" service operation: + +- SoR Information Retrieval + +##### 5.2.2.2.2 SoR Information Retrieval + +Figure 5.2.2.2.2-1 depicts a scenario where a NF consumer (e.g. UDM) sends a request to the SOR-AF to retrieve the SoR information for a UE (see also clause C.2 and C.5 in Annex C of 3GPP TS 23.122°[14]). + +The request contains the UE's identity (/{supi}) and a set of query parameters (e.g. PLMN ID of the visited PLMN the UE is roaming in, or SNPN ID of the visited SNPN). + +![Sequence diagram of SoR Information Retrieval Procedure](9283a3f6b39120df9dc9aee4712b3a0a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant SOR-AF + Note left of NF service consumer: + NF service consumer->>SOR-AF: 1. GET .../{supi}/sor-information? + SOR-AF-->>NF service consumer: 2a. 200 OK (SorInformation) + SOR-AF-->>NF service consumer: 2b. 404 Not Found +``` + +The diagram illustrates the interaction between an NF service consumer and the SOR-AF. The consumer sends a GET request to the SOR-AF. The SOR-AF responds with either a 200 OK status with the SoR information or a 404 Not Found status. + +Sequence diagram of SoR Information Retrieval Procedure + +**Figure 5.2.2.2.2-1: SoR Information Retrieval Procedure** + +1. The NF service consumer (e.g. UDM) sends a GET request to the resource representing the SoR information (sor-information), with query parameters indicating the PLMN ID or SNPN ID and other relevant information (e.g. Access type). +- 2a. On success, the SOR-AF responds with the HTTP status code "200 OK" with the message body containing the SoR information (i.e. list of preferred PLMN/access technology combinations, the SOR-CMCI, if any, the "Store the SOR-CMCI in the ME" indicator, if any, SOR-SNPN-SI, if any and SOR-SNPN-SI-LS, if any, or a secured packet by consuming Nspaf services as specified in 3GPP TS 29.544 [19]) for the concerned UE. The response also contains a Cache-Control HTTP header set to the value "no-cache" instructing the NF consumer (e.g. UDM) to not cache the received SoR information. +- 2b. If there is no valid SoR information for the UE (e.g. the resource does not exist, the SUPI is unknown to the SOR-AF), the SOR-AF responds with the HTTP status code "404 Not Found" including additional error information in the response body (within the "ProblemDetails" IE). + +NOTE: An operator configurable timer shall be used by the NF Service Consumer (e.g. UDM) to control the acceptable time during which it shall wait for the GET response from the SOR-AF, as specified in clause C.2 of 3GPP TS 23.122°[14] (step 3d of the procedure description). The default value and range of this timer is operator specific and shall take into account the importance of the related procedure (e.g. registration procedure). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +#### 5.2.2.3 Info + +##### 5.2.2.3.1 General + +This service operation is used by a NF consumer (e.g. UDM) to provide the SOR-AF with the reception status of the acknowledgment on successful reception of SoR information by the UE, in case an acknowledgment was requested to the UE. + +The following procedures are supported using the "Info" service operation: + +- SoR Acknowledgment Reception Notification + +##### 5.2.2.3.2 SoR Acknowledgment Reception Notification + +Figure 5.2.2.3.2-1 depicts a scenario where a NF consumer (e.g. UDM) sends an indication to the SOR-AF on the reception status of SoR information by the UE (see also clauses C.2 C.3, C.5 and C.6 in Annex C of 3GPP TS 23.122°[14]). + +The request contains the UE's identity (/{supi}), the type of acknowledgment (/sor-information/sor-ack) and the indication (SorAckInfo). + +![Sequence diagram showing the SoR Acknowledgment Reception Notification procedure between an NF service consumer and SOR-AF.](4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant SOR-AF + Note left of NF service consumer: 1. PUT.../{supi}/sor-information/sor-ack (SorAckInfo) + NF service consumer->>SOR-AF: 1. PUT.../{supi}/sor-information/sor-ack (SorAckInfo) + Note right of SOR-AF: 2a. 204 No Content + SOR-AF-->>NF service consumer: 2a. 204 No Content + Note right of SOR-AF: 2b. 404 Not Found + SOR-AF-->>NF service consumer: 2b. 404 Not Found +``` + +Sequence diagram showing the SoR Acknowledgment Reception Notification procedure between an NF service consumer and SOR-AF. + +Figure 5.2.2.3.2-1: SoR Acknowledgment Reception Notification procedure + +1. The NF service consumer (e.g. UDM) sends a PUT request to the resource representing the SoR information acknowledgment (/{supi}/sor-information/sor-ack) with the SorAckInfo containing an indication on the reception status of SoR information by the UE, and "ME support of SOR-CMCI", "ME support of SOR-SNPN-SI-LS" and, "ME support of SOR-SNPN-SI" if available. +- 2a. The SOR-AF responds with the HTTP status code "204 No Content". +- 2b. If there is an error (e.g. the SUPI is unknown to the SOR-AF), the SOR-AF shall respond with the HTTP status code "404 Not Found" including additional error information in the response body (within the "ProblemDetails" IE). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PUT response body. + +# 6 API Definitions + +## 6.1 Nsoraf\_SteeringOfRoaming Service API + +### 6.1.1 Introduction + +The Nsoraf\_SOR service shall use the Nsoraf\_SOR service API. + +The API URI of the Nsoraf\_SOR API shall be: + +**{apiRoot}//** + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nsoraf-sor". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nsoraf\_SOR API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +##### 6.1.2.2.3 Cache-Control + +The "Cache-Control" header set to the value "no-cache" shall be included in HTTP responses for resources that shall not be cached (e.g. SorInformation). + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +The structure of the Resource URIs of the "Nsoraf\_SOR" service is depicted in Figure 6.1.3.1-1. + +![Figure 6.1.3.1-1: Resource URI structure of the Nsoraf_SOR API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/nsoraf-sor/. It branches to /{supi}, which branches to /sor-information, which branches to /sor-ack.](78ffccd66df9bafd96e3e081110d09dd_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nsoraf-sor/"] --> Supi["/{supi}"] + Supi --> SorInfo["/sor-information"] + SorInfo --> SorAck["/sor-ack"] + +``` + +Figure 6.1.3.1-1: Resource URI structure of the Nsoraf\_SOR API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/nsoraf-sor/. It branches to /{supi}, which branches to /sor-information, which branches to /sor-ack. + +**Figure 6.1.3.1-1: Resource URI structure of the Nsoraf\_SOR API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------|----------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| sor-information (Document) | //{supi}/sor-information | GET | Retrieve the SoR information. | +| sor-ack (Document) | //{supi}/sor-information/sor-ack | PUT | Inform the SOR-AF of the reception status of the Acknowledgment of successful reception of SoR information by the UE. | + +#### 6.1.3.2 Resource: sor-information + +##### 6.1.3.2.1 Description + +This resource represents the SoR information for a SUPI. It is used by NF consumers (e.g. UDM) to: + +- request the retrieval of the SoR information during registration in a VPLMN as specified in clause C.2 in Annex C of 3GPP TS 23.122 [14]. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nsoraf-sor///{supi}/sor-information + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "^(imsi-[0-9]{5,15} nai-.[+ +])\$" | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|------------------------------------------------------|---------------| +| supported-features | SupportedFeatures | O | 0..1 | See clause 6.1.8, and 3GPP TS 29.500 [4] clause 6.6. | | +| plmn-id | PlmnIdNid | M | 1 | Identity of the PLMN or SNPN serving the UE. | | +| access-type | AccessType | O | 0..1 | Access type used by the UE. | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SorInformation | M | 1 | 200 OK | Upon success, a response with "200 OK" status code and a response body containing the SoR information as requested by the NF consumer (e.g. UDM) shall be returned by the SOR-AF. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be set to one of the following application errors:
- USER NOT FOUND | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponses may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.1-4: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Cache-Control | string | M | 1 | The Cache-Control HTTP header is set to the value "no-cache" instructing the NF consumer (e.g. UDM) to not cache the received SoR information. | + +**Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to a resource located on alternative SOR-AF. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | + +**Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to a resource located on alternative SOR-AF. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | + +#### 6.1.3.3 Resource: sor-ack + +##### 6.1.3.3.1 Description + +This resource represents the notification from the NF consumer (e.g. UDM) of the reception status of the acknowledgment of successful reception of SoR information by the UE as specified in Annex C of 3GPP TS 23.122 [14]. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nsoraf-sor///{supi}/sor-information/sor-ack + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "^(imsi-[0-9]{5,15} nai-.[.+]\$)" | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------| +| SorAckInfo | M | 1 | Contains an indication on the reception status of the acknowledgment of successful reception of SoR information by the UE. | + +**Table 6.1.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, a response with "204 No Content" status code shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be set to the following application error:
- USER NOT FOUND | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponses may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to a resource located on alternative SOR-AF. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to a resource located on alternative SOR-AF. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | + +### 6.1.4 Custom Operations without associated resources + +No custom operations without associated resources are defined for the Nsoraf\_SOR Service. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +In this release of this specification, no notifications are defined for the Nsoraf\_SOR Service. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nsoraf\_SOR service based interface protocol. + +**Table 6.1.6.1-1: Nsoraf specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| SorInformation | 6.1.6.2.2 | Contains the SoR information to be conveyed to the UE. | | +| SorAckInfo | 6.1.6.2.3 | Contains an indication to the SOR-AF on the reception status of the acknowledgment of successful reception of SoR Information by the UE. | | +| SteeringContainer | 6.1.6.2.x | It consists of either a list (array) of SteeringInfo objects, or a Secured Packet. | | +| SteeringInfo | 6.1.6.2.x | Contains a PLMN-ID, or SNPN-ID or a GIN, and, for the case of PLMNs, the preferred access technologies. | | +| SorAckStatus | 6.1.6.3.3 | Contains the reception status of the acknowledgment of successful reception of SoR Information by the UE. | | + +Table 6.1.6.1-2 specifies data types re-used by the Nsoraf\_SOR service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nsoraf service based interface. + +**Table 6.1.6.1-2: Nsoraf re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|-----------------------------------------------------|---------------| +| PlmnId | 3GPP TS 29.571 [16] | PLMN Identity | | +| PlmnIdNid | 3GPP TS 29.571 [16] | SNPN Identity or GIN | | +| ProblemDetails | 3GPP TS 29.571 [16] | Common data type used in response bodies | | +| RedirectResponse | 3GPP TS 29.571 [10] | Redirect Response | | +| SupportedFeatures | 3GPP TS 29.571 [16] | see 3GPP TS 29.500 [4] clause 6.6 | | +| Supi | 3GPP TS 29.571 [16] | Contains the SUPI information. | | +| DateTime | 3GPP TS 29.571 [16] | Date Time | | +| AccessType | 3GPP TS 29.571 [16] | Access type (e.g. 3GPP) | | +| SorCmoi | 3GPP TS 29.503 [15] | Contains SOR-CMCI as defined in 3GPP TS 24.501 [18] | | +| AccessTech | 3GPP TS 29.509 [20] | List of access technologies | | +| SecuredPacket | 3GPP TS 29.509 [20] | Secured Packet | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: SorInformation + +**Table 6.1.6.2.2-1: Definition of type SorInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supportedFeatures | SupportedFeatures | O | 0..1 | Features supported by the SOR-AF (see clause 6.1.8). | | +| steeringContainer | SteeringContainer | C | 0..1 |

When present, this attribute contains the information needed to update the "Operator Controlled PLMN Selector with Access Technology" list stored in the UE, either as an array of preferred PLMN/Access Technologies combinations in priority order (with the first entry in the array indicating the highest priority and the last entry indicating the lowest) or a secured packet.

If no change of the "Operator Controlled PLMN Selector with Access Technology" list stored in the UE is needed, then this attribute shall be absent.

When the eNPN feature is supported, this IE may contain SOR information for SNPNS or GINs.

| | +| sorAckIndication | boolean | M | 1 | This attribute indicates to the NF consumer (e.g. UDM) whether an Acknowledgment of successful reception of SoR information shall be requested to the UE (when set to "True") or not (when set to "False"). | | +| sorCmci | SorCmci | O | 0..1 |

When present, provides the SOR-CMCI values as defined in 3GPP TS 24.501 [18]

If "ME Support of SOR-CMCI" as provided in meSupportOfSorCmci from UE to SOR-AF via AMF and UDM is not stored as "supported", then this attribute shall be absent.

Shall be absent if steeringContainer is provided with contents in secured packet.

| | + +| | | | | | +|------------------|----------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| storeSorCmciInMe | boolean | O | 0..1 |

When present, indicates "Store the SOR-CMCI in the ME" as supported as defined in 3GPP TS 23.122 [14] and 3GPP TS 24.501 [18].

If sorCmci is absent, then this attribute shall also be absent.

  • - True: Indicates to store the SOR-CMCI in the ME
  • - False or absent: Indicates storing the SOR-CMCI in the ME is not required

Shall be absent if steeringContainer is provided with contents in secured packet.

| +| sorSendingTime | DateTime | M | 1 |

Contains the date and time at which SOR-AF returns SorInformation.

It is used to correlate the SoR acknowledgement with the associated SoR information.

| +| sorSnpnSi | Bytes | O | 0..1 |

When present, provides the SOR-SNPN-SI values as defined in 3GPP TS 24.501 [18].

If "ME Support of SOR-SNPN-SI-LS" as provided in meSupportOfSorSnpnSi from UE to SOR-AF via AMF and UDM is not stored as "supported", then this attribute shall be absent.

| +| sorSnpnSiLs | Bytes | O | 0..1 |

When present, provides the SOR-SNPN-SI-LS values as defined in 3GPP TS 24.501 [18]

If "ME Support of SOR-SNPN-SI-LS" as provided in meSupportOfSorSnpnSiLs from UE to SOR-AF via AMF and UDM is not stored as "supported", then this attribute shall be absent.

| + +##### 6.1.6.2.3 Type: SorAckInfo + +Table 6.1.6.2.3-1: Definition of type SorAckInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|--------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| sorAckStatus | SorAckStatus | M | 1 | Contains the reception status of the acknowledgment of successful reception of SoR Information by the UE. | | +| sorSendingTime | DateTime | M | 1 | Contains the date and time at which SOR-AF sent the SorInformation to which the acknowledgment status relates. | | +| meSupportOfSorCmci | boolean | O | 0..1 | When present, indicates "ME support of SOR-CMCI" sent from UE to SOR-AF via AMF and UDM as defined in 3GPP TS 23.122 [14] and 3GPP TS 24.501 [18].

  • - True: ME supports SOR-CMCI
  • - False or absent: ME does not support SOR-CMCI
| | +| meSupportOfSorSnpnSi | boolean | O | 0..1 | When present, it indicates the "ME support for SOR-SNPN-SI" sent from UE to SOR-AF of SNPN vas described in 3GPP TS 23.122 [14].

  • - True: ME supports SOR-SNPN-SI
  • - False or absent: ME does not support SOR-SNPN-SI
| | +| meSupportOfSorSnpnSiLs | boolean | O | 0..1 | When present, it indicates the "ME support for SOR-SNPN-SI-LS" sent from UE to SOR-AF of SNPN vas described in 3GPP TS 23.122 [14].

  • - True: ME supports SOR-SNPN-SI-LS
  • - False or absent: ME does not support SOR-SNPN-SI_LS.
| | + +##### 6.1.6.2.4 Type: SteeringContainer + +Table 6.1.6.2.4.-1: Definition of type SteeringContainer as a list of mutually exclusive alternatives + +| Data type | Cardinality | Description | +|---------------------|-------------|---------------------------------------------------------------------------------------------| +| array(SteeringInfo) | 1..N | List of PLMN/AccessTechnologies combinations. | +| SecuredPacket | 1 | A secured packet containing one or more APDUs commands dedicated to Remote File Management. | + +##### 6.1.6.2.5 Type: SteeringInfo + +Table 6.1.6.2.5-1: Definition of type SteeringInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| plmnId | PlmnId | C | 0..1 | Contains a preferred PLMN identity.
(NOTE) | +| snpnId | PlmnIdNid | C | 0..1 | Contains a preferred SNPN identity.
(NOTE) | +| gin | PlmnIdNid | C | 0..1 | Contains a preferred Group ID for Network Selection.
(NOTE) | +| accessTechList | array(AccessTech) | O | 1..N | This IE is only applicable when plmnId is present, and it shall be absent when snpnId or gin are present.
It contains the preferred access technologies for such PLMN, as listed in clause 6.2.6.3.3 of 3GPP TS 29.509 [20]. If absent it means that all access technologies are equivalently preferred in such PLMN. | + +NOTE: Exactly one of plmnId, snpnId or gin shall be present. + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +Table 6.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| n/a | | | | + +##### 6.1.6.3.3 Enumeration: SorAckStatus + +The enumeration SorAckStatus represents an indication to the SOR-AF on whether the acknowledgment of successful reception of SoR information was received from the UE. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +Table 6.1.6.3.3-1: Enumeration SorAckStatus + +| Enumeration value | Description | Applicability | +|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "ACK_SUCCESSFUL" | Indicates to the SOR-AF that the acknowledgment of successful reception of SoR information was received from the UE and the integrity check was successful. | | +| "ACK_NOT_RECEIVED" | Indicates to the SOR-AF that the acknowledgment of successful reception of SoR information was NOT received from the UE. | | +| "ACK_NOT_SUCCESSFUL" | Indicates to the SOR-AF that the acknowledgment of successful reception of SoR information was received from the UE and the integrity check was NOT successful. | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nsoraf\_SOR API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nsoraf\_SOR API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nsoraf\_SOR service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nsoraf\_SOR service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-----------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist
This error is applicable to all Nsoraf_SOR operations. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nsoraf\_SOR API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | eNPN |

If this feature is supported, the query parameter "plmn-id" (see Table 6.1.3.2.3.1-1) is recognized by the SOR-AF as a PLMN-ID or an SNPN-ID, and the steeringContainer attribute (see clause 6.1.6.2.2) returned by the SOR-AF may include SOR information for SNPNs.

If this feature is not supported, such query parameter is recognized by the SOR-AF as a PLMN-ID, and the steeringContainer attribute contains only SOR information for PLMNs.

| + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nsoraf\_SOR API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nsoraf\_SOR API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nsoraf\_SOR service. + +The Nsoraf\_SOR API defines a single scope "nsoraf-sor" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different SOR-AF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different SOR-AF producer instance will return the NF Instance ID of the new SOR-AF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an SOR-AF redirects a service request to a different SOR-AF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new SOR-AF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based , that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nsoraf\_SOR API + +``` +openapi: 3.0.0 +info: + title: 'Nsoraf_SOR' + version: 1.2.0-alpha.3 + description: | + Nsoraf Steering Of Roaming Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.550 V18.2.0; Steering Of Roaming Application Function Services. + url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.550/ +servers: + - url: '{apiRoot}/nsoraf-sor/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: + - {} + - oAuth2ClientCredentials: + - nsoraf-sor +paths: + /{supi}/sor-information: + get: + summary: retrieve the steering of roaming information for a UE + operationId: GetSorInformation + tags: + - SoR Information Retrieval + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: supported-features + in: query + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: plmn-id + in: query + description: serving PLMN ID or SNPN ID + required: true + content: +``` + +``` + + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' +- name: access-type + in: query + description: Access type used by the UE + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SorInformation' + headers: + Cache-Control: + description: Cache-Control (as described in RFC 9111) with value "no-cache" to +indicate that the returned SoR information should not be cached + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +/{supi}/sor-information/sor-ack: + put: + summary: SoR Acknowledgment Reception Notification + operationId: SorAckInfo + tags: + - Providing the reception status of the acknowledgement of Steering of Roaming information +reception by the UE + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SorAckInfo' + responses: + '204': + description: Successful reception of the indication + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + +``` + +``` +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nsoraf-sor: Access to the Nsoraf_SOR API +schemas: + +# +# COMPLEX DATA TYPES +# + +SorInformation: + description: Represents the SoR information to be conveyed to a UE. + type: object + required: + - sorAckIndication + - sorSendingTime + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + steeringContainer: + $ref: '#/components/schemas/SteeringContainer' + sorAckIndication: + type: boolean + sorCmci: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SorCmci' + storeSorCmciInMe: + type: boolean + sorSendingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + sorSnpnSi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + sorSnpnSiLs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +SorAckInfo: + description: > + Represents an indication to the SOR-AF on the reception status of the + acknowledgment of successful reception of SoR Information by a UE. + type: object + required: + - sorAckStatus + - sorSendingTime + properties: + sorAckStatus: + $ref: '#/components/schemas/SorAckStatus' + sorSendingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + meSupportOfSorCmci: + type: boolean + meSupportOfSorSnpnSi: + type: boolean + meSupportOfSorSnpnSiLs: + type: boolean + +SteeringContainer: + description: It consists of either a list (array) of SteeringInfo objects or a Secured Packet + oneOf: + - type: array + items: + $ref: '#/components/schemas/SteeringInfo' + minItems: 1 +``` + +- \$ref: 'TS29509\_Nausf\_SoRProtection.yaml#/components/schemas/SecuredPacket' + +SteeringInfo: + description: > + Contains either a PLMN-ID, an SNPN-ID or a GIN and, for the case of PLMNs, zero or more preferred access technologies for accessing such PLMN + type: object + oneOf: + - required: [ plmnId ] + - required: [ snpnId ] + - required: [ gin ] + properties: + plmnId: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnId' + snpnId: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnIdNid' + gin: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnIdNid' + accessTechList: + type: array + items: + \$ref: 'TS29509\_Nausf\_SoRProtection.yaml#/components/schemas/AccessTech' + minItems: 1 + +# +# +# + +# ENUMS + +SorAckStatus: + description: > + Represents the reception status of the acknowledgment of successful reception of SoR Information by a UE. + + anyOf: + - type: string + enum: + - ACK\_SUCCESSFUL + - ACK\_NOT\_RECEIVED + - ACK\_NOT\_SUCCESSFUL + - type: string + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-11 | CT4#95 | C4-195242 | | | | Initial Draft. | 0.1.0 | +| 2020-03 | CT4#96e | C4-200833 | | | | Pseudo-CR on the scope part of SOR-AF API | 0.2.0 | +| 2020-03 | CT4#96e | C4-201197 | | | | Pseudo-CR on the overview part of SOR-AF API | 0.2.0 | +| 2020-03 | CT4#96e | C4-201198 | | | | Pseudo-CR on the definition of Nsoraf service | 0.2.0 | +| 2020-03 | CT4#96e | C4-201206 | | | | Pseudo-CR on the resources part of SOR-AF API | 0.2.0 | +| 2020-03 | CT4#96e | C4-201208 | | | | Pseudo-CR on the data model aspects of SOR-AF API | 0.2.0 | +| 2020-03 | CT4#96e | C4-201209 | | | | Pseudo-CR on the OpenAPI part of SOR-AF API | 0.2.0 | +| 2020-03 | CT-87e | CP-200063 | | | | TS presented for information and approval | 1.0.0 | +| 2020-03 | CT-87e | | | | | Approved at CT#87e | 16.0.0 | +| 2020-07 | CT#88e | CP-201042 | 0001 | | F | SoR Information wording clarification | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0002 | 1 | F | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0003 | | F | Miscellaneous Corrections | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0006 | 1 | F | Add Data type column in the URI variables tables | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0007 | 1 | F | Add supported headers tables | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0008 | | F | Add API descriptions table | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0009 | 2 | B | Remaining input parameters to Nsoraf_SOR_Get service operation | 16.1.0 | +| 2020-07 | CT#88e | CP-201042 | 0010 | 1 | B | SoR retrieval response timing control | 16.1.0 | +| 2020-07 | CT#88e | CP-201073 | 0011 | | F | 29.550 Rel-16 API version and External doc update | 16.1.0 | +| 2020-09 | CT#89e | CP-202115 | 0012 | | F | Miscellaneous Corrections | 16.2.0 | +| 2020-11 | CT#90e | CP-203035 | 0015 | | F | Removal of the reference to ETSI forge | 16.3.0 | +| 2021-03 | CT#91e | CP-210034 | 0018 | 1 | F | OpenAPI Reference | 17.0.0 | +| 2021-06 | CT#92e | | 0021 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the Nsoraf_SOR API | 17.1.0 | +| 2021-09 | CT#93e | CP-212247 | 0023 | 3 | F | Redirect Response | 17.2.0 | +| 2021-12 | CT#94e | | 0027 | 1 | B | SOR-CMCI support | 17.3.0 | +| 2022-06 | CT#96 | CP-221064 | 0030 | | A | access-type query parameter format | 17.4.0 | +| 2022-06 | CT#96 | CP-221301 | 0031 | 2 | F | SOR functionality with SNPNS | 17.4.0 | +| 2022-06 | CT#96 | CP-221302 | 0032 | 1 | F | 29.550 Rel-17 API version and External doc update | 17.4.0 | +| 2022-12 | CT#98 | CP-223028 | 0035 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0036 | | F | 29.550 Rel-18 API version and External doc update | 18.0.0 | +| 2023-06 | CT#100 | | 0037 | 4 | F | Location header and missing Redirection clause | 18.1.0 | +| 2023-06 | CT#100 | | 0039 | 4 | F | SOR update information for localized services in SNPNS | 18.1.0 | +| 2023-12 | CT#102 | CP-233044 | 0042 | 1 | F | Major API version | 18.2.0 | +| 2023-12 | CT#102 | CP-233029 | 0043 | 1 | F | Update and replace obsoleted HTTP RFCs | 18.2.0 | +| 2023-12 | CT#102 | CP-233031 | 0045 | | F | Replacing obsoleted HTTP RFC 7807 with 9457 | 18.2.0 | +| 2023-12 | 2023-12 | CP-233060 | 0047 | | F | API version and External doc update | 18.2.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29551/raw.md b/raw/rel-18/29_series/29551/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..f6ae18273125693cf739e4248b1c13049f2203cf --- /dev/null +++ b/raw/rel-18/29_series/29551/raw.md @@ -0,0 +1,2156 @@ + + +# 3GPP TS 29.551 V18.3.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Packet Flow Description Management Service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green signal wave icon above the 'G', and the word 'ADVANCED' in small capital letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'G' has a red signal wave icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in small capital letters. + +3GPP logo + +## --- Keywords --- + +## **3GPP** + +## --- Postal address --- + +### 3GPP support office address --- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## Internet --- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions, symbols and abbreviations ..... | 6 | +| 3.1 Definitions..... | 6 | +| 3.2 Abbreviations ..... | 6 | +| 4 Packet Flow Description Management Service ..... | 7 | +| 4.1 Service Description ..... | 7 | +| 4.1.1 Overview ..... | 7 | +| 4.1.2 Service Architecture ..... | 7 | +| 4.1.3 Network Functions ..... | 8 | +| 4.1.3.1 Packet Flow Description Function (PFDF) ..... | 8 | +| 4.1.3.2 NF Service Consumers ..... | 8 | +| 4.2 Service Operations ..... | 8 | +| 4.2.1 Introduction ..... | 8 | +| 4.2.2 Nnef_PFDmanagement_Fetch Service Operation ..... | 8 | +| 4.2.2.1 General..... | 8 | +| 4.2.2.1.1 When the NF service consumer is SMF..... | 8 | +| 4.2.2.1.2 When the NF service consumer is NWDAF ..... | 9 | +| 4.2.2.2 Retrieval of PFDs by the full pull..... | 9 | +| 4.2.2.3 Retrieval of PFDs by the partial pull ..... | 10 | +| 4.2.3 Nnef_PFDmanagement_Subscribe Service Operation..... | 11 | +| 4.2.3.1 General..... | 11 | +| 4.2.3.2 Subscription for event notifications on PFDs change..... | 11 | +| 4.2.3.3 Subscription update for event notifications on PFDs change ..... | 12 | +| 4.2.4 Nnef_PFDmanagement_Notify Service Operation..... | 13 | +| 4.2.4.1 General..... | 13 | +| 4.2.4.2 Notification of PFD change ..... | 13 | +| 4.2.4.3 Notification PUSH..... | 14 | +| 4.2.5 Nnef_PFDmanagement_Unsubscribe Service Operation ..... | 15 | +| 4.2.5.1 General..... | 15 | +| 4.2.5.2 Unsubscribe from event notifications on PFDs change..... | 15 | +| 5 Nnef_PFDmanagement API ..... | 15 | +| 5.1 Introduction ..... | 15 | +| 5.2 Usage of HTTP..... | 16 | +| 5.2.1 General ..... | 16 | +| 5.2.2 HTTP standard headers ..... | 16 | +| 5.2.2.1 General..... | 16 | +| 5.2.2.2 Content type ..... | 16 | +| 5.2.3 HTTP custom headers ..... | 16 | +| 5.2.3.1 General..... | 16 | +| 5.3 Resources ..... | 17 | +| 5.3.1 Resource Structure..... | 17 | +| 5.3.2 Resource: PFD of applications ..... | 17 | +| 5.3.2.1 Description..... | 17 | +| 5.3.2.2 Resource definition..... | 18 | +| 5.3.2.3 Resource Standard Methods ..... | 18 | +| 5.3.2.3.1 GET ..... | 18 | +| 5.3.2.4 Resource Custom Operations..... | 19 | +| 5.3.2.4.1 Overview ..... | 19 | +| 5.3.2.4.2 Operation: partialpull ..... | 19 | +| 5.3.2.4.2.1 Description ..... | 19 | +| 5.3.2.4.2.2 Operation Definition..... | 19 | +| 5.3.3 Resource: Individual application PFD..... | 19 | + +| | | | +|--------------------------------------------------------|------------------------------------------------------|-----------| +| 5.3.3.1 | Description..... | 19 | +| 5.3.3.2 | Resource definition..... | 19 | +| 5.3.3.3 | Resource Standard Methods ..... | 20 | +| 5.3.3.3.1 | GET ..... | 20 | +| 5.3.3.4 | Resource Custom Operations..... | 21 | +| 5.3.4 | Resource: PFD subscriptions..... | 21 | +| 5.3.4.1 | Description..... | 21 | +| 5.3.4.2 | Resource definition..... | 21 | +| 5.3.4.3 | Resource Standard Methods ..... | 21 | +| 5.3.4.3.1 | POST ..... | 21 | +| 5.3.4.4 | Resource Custom Operations..... | 22 | +| 5.3.5 | Resource: Individual PFD subscription..... | 22 | +| 5.3.5.1 | Description..... | 22 | +| 5.3.5.2 | Resource definition..... | 22 | +| 5.3.5.3 | Resource Standard Methods ..... | 22 | +| 5.3.5.3.1 | DELETE..... | 22 | +| 5.3.5.3.2 | PUT ..... | 23 | +| 5.3.5.4 | Resource Custom Operations..... | 24 | +| 5.4 | Custom Operations without associated resources ..... | 25 | +| 5.5 | Notifications ..... | 25 | +| 5.5.1 | General ..... | 25 | +| 5.5.2 | PFD Change Notification ..... | 25 | +| 5.5.2.1 | Description..... | 25 | +| 5.5.2.2 | Target URI..... | 25 | +| 5.5.2.3 | Standard Methods ..... | 25 | +| 5.5.2.3.1 | POST ..... | 25 | +| 5.5.3 | Notification Push..... | 26 | +| 5.5.3.1 | Description..... | 26 | +| 5.5.3.2 | Target URI..... | 27 | +| 5.5.3.3 | Standard Methods ..... | 27 | +| 5.5.3.3.1 | POST ..... | 27 | +| 5.6 | Data Model..... | 28 | +| 5.6.1 | General ..... | 28 | +| 5.6.2 | Structured data types ..... | 29 | +| 5.6.2.1 | Introduction..... | 29 | +| 5.6.2.2 | Type: PfdDataForApp..... | 29 | +| 5.6.2.3 | Type: PfdSubscription ..... | 30 | +| 5.6.2.4 | Type: PfdChangeNotification..... | 30 | +| 5.6.2.5 | Type: PfdContent..... | 31 | +| 5.6.2.6 | Type: PfdChangeReport ..... | 31 | +| 5.6.2.7 | Type: NotificationPush..... | 32 | +| 5.6.2.8 | Type: ApplicationForPfdRequest..... | 32 | +| 5.6.3 | Simple data types and enumerations ..... | 32 | +| 5.6.3.1 | Introduction..... | 32 | +| 5.6.3.2 | Simple data types..... | 32 | +| 5.6.3.3 | Enumeration: PfdOperation ..... | 32 | +| 5.7 | Error handling ..... | 33 | +| 5.7.1 | General ..... | 33 | +| 5.7.2 | Protocol Errors..... | 33 | +| 5.7.3 | Application Errors ..... | 33 | +| 5.8 | Feature negotiation..... | 33 | +| 5.9 | Security..... | 34 | +| Annex A (normative): OpenAPI specification..... | | 35 | +| A.1 | General..... | 35 | +| A.2 | Nnef_PFDmanagement API ..... | 35 | +| Annex B (informative): Change history ..... | | 44 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document provides the stage 3 specification of the PFD Management Service of the 5G system. + +The stage 2 definition and related procedures of the PFD Management Service are contained in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition of the 5G System are specified in 3GPP TS 29.500 [5] and 3GPP TS 29.501 [6]. + +The Packet Flow Description Function (PFDF) provides the PFD Management Service to NF service consumers (e.g. Session Management Function). The PFDF is functionality within the NEF. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". + +- [5] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [6] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [7] IETF RFC 9113: "HTTP/2". +- [8] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [9] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [10] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [11] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [12] 3GPP TS 29.251: "Gw and Gwn reference points for sponsored data connectivity". +- [13] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [14] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [15] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [16] IETF RFC 9457: "Problem Details for HTTP APIs". +- [17] 3GPP TR 21.900: "Technical Specification Group working methods". +- [18] IETF RFC 6733: "Diameter Base Protocol". +- [19] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|----------------------------------| +| JSON | JavaScript Object Notation | +| NEF | Network Exposure Function | +| NRF | Network Repository Function | +| NWDAF | Network Data Analytics Function | +| PFD | Packet Flow Description | +| PFDf | Packet Flow Description Function | +| SBI | Service Based Interface | +| SMF | Session Management Function | + +# 4 Packet Flow Description Management Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The PFD Management Service, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4], and the NWDAF retrieves the existing PFDs from the NEF(PFDF) as described in 3GPP TS 23.288 [19], is provided by the Packet Flow Description Function (PFDF). + +The known NF service consumers are: + +- Session Management Function (SMF); +- Network Data Analytics Function (NWDAF). + +This service: + +- allows a NF service consumer (e.g. SMF) to subscribe to and unsubscribe from PFD changes; +- notifies a NF service consumer (e.g. SMF) about changes of PFDs; +- notifies a NF service consumer (e.g. SMF) to retrieve the PFDs; and +- allows a NF service consumer (e.g. SMF, NWDAF) to retrieve PFDs. + +### 4.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Policy and Charging related 5G architecture is also described in 3GPP TS 23.503 [4]. + +The PFD Management Service is provided by the PFDF to NF service consumers (e.g. SMF) and shown in the SBI representation model in Figure 4.1.2-1. The PFDF is a functionality within the NEF. + +![Figure 4.1.2-1: Reference Architecture for the Nnef_PFDmanagement Service; SBI representation](4ba34b7c8f0b8799dc89462e0c71c52c_img.jpg) + +This diagram illustrates the Service Based Interface (SBI) representation of the architecture. At the top, a box labeled 'NEF' contains a smaller box labeled 'PFDF'. Below the 'PFDF' box is an oval labeled 'Nnef'. A line labeled 'Nnef\_PFDmanagement' connects this oval to two boxes at the bottom: 'SMF' on the left and 'NWDAF' on the right. + +Figure 4.1.2-1: Reference Architecture for the Nnef\_PFDmanagement Service; SBI representation + +Figure 4.1.2-1: Reference Architecture for the Nnef\_PFDmanagement Service; SBI representation + +![Figure 4.1.2-2: Reference Architecture for the Nnef_PFDmanagement Service; reference point representation](ba9d6e1a75eb6672d04e61a86e1b8a61_img.jpg) + +This diagram illustrates the reference point representation of the architecture. On the left, a box labeled 'NEF' contains a smaller box labeled 'PFDF'. A line labeled 'N29' connects the 'PFDF' box to two boxes on the right: 'SMF' at the top and 'NWDAF' at the bottom. The 'N29' line has two tick marks on it, one for each connection to 'SMF' and 'NWDAF'. + +Figure 4.1.2-2: Reference Architecture for the Nnef\_PFDmanagement Service; reference point representation + +Figure 4.1.2-2: Reference Architecture for the Nnef\_PFDmanagement Service; reference point representation + +### 4.1.3 Network Functions + +#### 4.1.3.1 Packet Flow Description Function (PFDF) + +The Packet Flow Description Function (PFDF): + +- provides PFDs associated with one or more Application Identifiers; +- notifies a NF service consumer to retrieve the PFDs; and +- allows NF service consumers to subscribe to and unsubscribe from notifications on changes of PFDs for Application Identifier. + +#### 4.1.3.2 NF Service Consumers + +The SMF shall support: + +- requesting and receiving the PFD(s) for one or more Application Identifiers. + +The NWDAF shall support: + +- retrieving the PFD(s) for one or more Application Identifiers. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +Service operations defined for the Nnef\_PFDmanagement Service are shown in table 4.2.1-1. + +**Table 4.2.1-1: Nnef\_PFDmanagement Service Operations** + +| Service Operation Name | Description | Initiated by | +|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| +| Nnef_PFDmanagement_Fetch | Provides the PFDs for application identifier(s) to the NF service consumer by the full pull or partial pull. | NF service consumer (e.g. SMF, NWDAF) | +| Nnef_PFDmanagement_Subscribe | Allows NF service consumers to subscribe to notifications on events when the PFDs for application identifier(s) change. | NF service consumer (e.g. SMF) | +| Nnef_PFDmanagement_Notify | Notifies NF service consumers to update and/or delete the PFDs for application identifier(s) or notifies NF service consumer to retrieve the PFDs for application identifier(s). | PFDF | +| Nnef_PFDmanagement_Unsubscribe | Allows NF service consumers to unsubscribe from notifications on PFDs change events. | NF service consumer (e.g. SMF) | + +### 4.2.2 Nnef\_PFDmanagement\_Fetch Service Operation + +#### 4.2.2.1 General + +The Nnef\_PFDmanagement\_Fetch service operation provides means for the NF service consumer to retrieve the PFDs for one or more application identifier(s). + +##### 4.2.2.1.1 When the NF service consumer is SMF + +This service operation enables the NF service consumer to retrieve PFDs for an Application Identifier(s) from the PFDF when: + +- a PCC rule with this application identifier is provided/activated by the PCF and the PFDs provided by the PFDF are not available at the NF service consumer; or +- the caching timer for an application identifier elapses and a PCC rule for this application identifier is still active. + +When the NF service consumer removes the last PCC rule that refers to the corresponding application identifier, or when the caching timer expires and no PCC rule refers to the application identifier, the NF service consumer may remove the PFD(s) related with the application identifier. + +The PFDs retrieved from PFDF take precedence over any PFDs pre-configured in the NF service consumer. If all PFDs retrieved from the PFDF are removed for an application identifier, the pre-configured PFDs shall be applied again for the application identifier. + +The PFDF may provide caching time value via the "cachingTime" attribute or, if the feature CachingTimer is supported, via the "cachingTimer" attribute, together with the PFDs for an application identifier. The caching time value retrieved from the PFDF takes precedence over the default caching time value configured in the NF service consumer. If no caching time value is received from the PFDF, the configured default caching time value shall be applied. + +NOTE 1: The NF service consumer(s) and the PFDF(s) within an operator network are configured with the same default caching time value to be applied for all application identifiers. + +NOTE 2: The configuration of a caching time value per application identifier in the PFDF is based on the SLA between the operator and the ASP. + +The following procedures using the Nnef\_PFDmanagement\_Fetch service operation are supported: + +- Retrieval of PFDs by the full pull. +- Retrieval of PFDs by the partial pull. + +##### 4.2.2.1.2 When the NF service consumer is NWDAF + +This service operation enables the NF service consumer to retrieve PFDs for the known Application Identifier(s) from the PFDF. + +The following procedure using the Nnef\_PFDmanagement\_Fetch service operation is supported: + +- Retrieval of PFDs by the full pull. + +#### 4.2.2.2 Retrieval of PFDs by the full pull + +This procedure, as shown in Figure 4.2.2.2-1, is used to retrieve PFDs from the PFDF by the full pull for requested application identifier(s). + +![Sequence diagram showing the retrieval of PFDs by the full pull. The NF Service Consumer sends a GET request to the PFDF, and the PFDF responds with a 200 OK.](2a0f333f04f8e672bebf288c511c1db5_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant PFDF + Note right of NF Service Consumer: 1a.GET .../applications/{appId} +1b. GET .../applications + NF Service Consumer->>PFDF: Request + PFDF-->>NF Service Consumer: 2. 200 OK + +``` + +Sequence diagram showing the retrieval of PFDs by the full pull. The NF Service Consumer sends a GET request to the PFDF, and the PFDF responds with a 200 OK. + +Figure 4.2.2.2-1: Retrieval of PFDs by the full pull + +- The NF service consumer (e.g. SMF, NWDAF) shall send a GET request to the resource representing the PFDs for the requested application identifier(s): + - for PFDs of an individual application identifier, the request URI shall be set to "{apiRoot}/nnef-pfdmanagement/v1/applications/{appId}" (as shown in figure 4.2.2.2-1, step 1a); and + +- for PFD of a collection of application identifiers, the request URI shall be set to "{apiRoot}/nnef-pfdmanagement/v1/applications" (as shown in figure 4.2.2.2-1, step 1b) with query parameters indicating the requested application identifier(s). +2. On success, an HTTP "200 OK" response shall be returned, with the content containing a representation of an "Individual application PFD" resource or a "PFD of applications" resource for the requested application identifier(s). When the NF service consumer is SMF, it shall replace the stored PFD(s) retrieved from the PFDF with the new received PFD(s) for the requested application identifier(s). If the PFD(s) of one or more requested application identifier(s) are not provided in the response, the NF service consumer shall remove the PFD(s) of these requested application identifier(s) and re-apply the pre-configured PFDs. + +If errors occur when processing the HTTP GET request, the PFDF shall send an HTTP error response as specified in clause 5.7. For "404 Not Found", when the NF service consumer is SMF, it shall remove the PFD(s) of the requested application identifier(s) in the NF service consumer and re-apply the pre-configured PFDs. + +If the feature "ES3XX" is supported, and the PFDF determines the received HTTP GET request needs to be redirected, the PFDF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +#### 4.2.2.3 Retrieval of PFDs by the partial pull + +This procedure, as shown in Figure 4.2.2.3-1, is used to retrieve PFDs from the PFDF by the partial pull for requested application identifier(s) if the "PartialPull" feature defined in clause 5.8 is supported both by NF service consumer and PFDF. + +![Sequence diagram showing the retrieval of PFDs by the partial pull. The NF service consumer sends a POST request to the PFDF. The PFDF responds with either a 200 OK or a 204 No Content.](54fabc351eda5228d2fa28cd9ba07971_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PFDF + Note left of NF service consumer: NF service consumer + Note right of PFDF: PFDF + NF service consumer->>PFDF: 1. POST .../applications/partial-pull + PFDF-->>NF service consumer: 2a. 200 OK + PFDF-->>NF service consumer: 2b. 204 No Content + +``` + +Sequence diagram showing the retrieval of PFDs by the partial pull. The NF service consumer sends a POST request to the PFDF. The PFDF responds with either a 200 OK or a 204 No Content. + +**Figure 4.2.2.3-1: Retrieval of PFDs by the partial pull** + +1. The NF service consumer (e.g. SMF) shall send an HTTP POST message to the resource "{apiRoot}/nnef-pfdmanagement/v1/applications/partialpull". The NF service consumer shall include one or more ApplicationForPfdRequest data structure in the content of the HTTP POST. With the ApplicationForPfdRequest data structure, the NF service consumer shall include the application identifier within the "applicationId" attribute and the timestamp of the PFDs received in the last provisioning for the application identifier within the "pfdTimestamp" attribute. The NF service consumer may also request full set of PFD(s) of an application identifier without including the timestamp if it is not available. +2. If the PFDF accepted the HTTP POST request, the PFDF shall send to the NF service consumer: + - the HTTP "200 OK" response (as shown in figure 4.2.2.3-1, step 2a) including one or more PfdDataForApp data structure if the NF service consumer requests the PFD(s) for an application identifier(s) without the timestamp or if the NF service consumer requests PFD(s) for an application identifier(s) with timestamp and the PFDF determines that corresponding PFD(s) is changed since the last request based on the timestamp received in the request for the application identifier. Within the PfdDataForApp data type, the PFDF shall include the application identifier within the "applicationId" attribute, the new timestamp within the "pfdTimestamp" attribute, the "partialFlag" attribute if applicable and create/update/remove the PFDs as follows: + - include the full list of the PFD(s) within the "pfd" attribute for the application identifier which is requested without the timestamp; + - include the full list of the PFD(s) within the "pfd" attribute for the application identifier if all the PFD(s) are changed for the application identifier since the last request based on the timestamp; + +- for the application identifier whose PFD(s) are partially changed: + - include the new PFD(s) with new PFD identifier(s) within the "pfd" attribute if the new PFD(s) is added for the application identifier and the "partialFlag" attribute set to true; + - include the new PFD(s) with existing PFD identifier(s) within the "pfd" attribute if the existing PFD(s) is updated for the application identifier and the "partialFlag" attribute set to true; + - include the existing PFD identifier(s) without any content within the "pfd" attribute if the existing PFD(s) is removed for the application identifier and the "partialFlag" attribute set to true; +- not include the "pfd" attribute if the PFD(s) is removed for the application identifier. + +NOTE 1: The PFDF does not include the PfdDataForApp data type for the application identifier whose PFD(s) is not updated since last request. + +NOTE 2: If the PFDF determines that the PFDs are changed since the last request but cannot determine what changes have been applied to the individual PFD(s) for an application identifier, the PFDF can include the full list of the PFD(s) in the PfdDataForApp data type. + +- the HTTP "204 No Content" response (as shown in figure 4.2.2.3-1, step 2b) if the PFD(s) for all the requested application identifier(s) are not changed since last request. + +When the NF service consumer receives the response with "200 OK" status code, the NF service consumer shall + +- remove the all existing PFD(s) (if available) and install all the new provided PFD(s) for an application identifier if full list of PFD(s) is received but "partialFlag" attribute is not received; +- delete the existing PFD(s) for an application identifier(s) where no PFD(s) is received; +- for an application identifier(s) where the PFD(s) is provided and "partialFlag" attribute is also provided and set to true: + - install a new PFD(s) if the new PFD(s) with a new PFD identifier(s) is received; + - update an existing PFD(s) if a new PFD(s) with the same PFD identifier(s) is received; + - delete an existing PFD(s) if the same PFD identifier(s) without any content is received; + - reserve an existing PFD(s) if the PFD identifier(s) is not received. + +### 4.2.3 Nnef\_PFDmanagement\_Subscribe Service Operation + +#### 4.2.3.1 General + +The Nnef\_PFDmanagement\_Subscribe service operation enables the NF service consumer to subscribe to notifications on events when the PFDs for application identifier(s) change. + +The following procedures using the Nnef\_PFDmanagement\_Subscribe service operation are supported: + +- Subscription for event notifications on PFDs change; +- Subscription update for event notifications on PFD change. + +#### 4.2.3.2 Subscription for event notifications on PFDs change + +This procedure, as shown in Figure 4.2.3.2-1, is used to subscribe to notifications on events when the PFDs for application identifier(s) change. + +![Sequence diagram for Figure 4.2.3.2-1: Creation of a subscription for event notifications on PFDs change. The diagram shows two lifelines: 'NF service consumer' on the left and 'PFDF' on the right. Step 1: A solid arrow points from the NF service consumer to the PFDF with the text '1. POST... /subscriptions'. Step 2: A solid arrow points from the PFDF back to the NF service consumer with the text '2. 201 Created'.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PFDF + Note left of NF service consumer: 1. POST... /subscriptions + NF service consumer->>PFDF: 1. POST... /subscriptions + Note right of PFDF: 2. 201 Created + PFDF-->>NF service consumer: 2. 201 Created +``` + +Sequence diagram for Figure 4.2.3.2-1: Creation of a subscription for event notifications on PFDs change. The diagram shows two lifelines: 'NF service consumer' on the left and 'PFDF' on the right. Step 1: A solid arrow points from the NF service consumer to the PFDF with the text '1. POST... /subscriptions'. Step 2: A solid arrow points from the PFDF back to the NF service consumer with the text '2. 201 Created'. + +**Figure 4.2.3.2-1: Creation of a subscription for event notifications on PFDs change** + +1. The NF service consumer (e.g. SMF) shall send a POST request to the request URI representing the collection of PFD subscriptions resource "{apiRoot}/nnef-pfdmanagement/v1/subscriptions". The NF service consumer shall include the PfdSubscription data type in the request content. Within the PfdSubscription data type, the NF service consumer shall include: + - an URI where to receive the requested notifications as "notifyUri" attribute;and may include: + - subscribed application identifier(s) within the "applicationIds" attribute. +2. If the request is accepted, the PFDF shall: + - create a new subscription; + - assign a subscriptionId; + - store the subscription; and + - send an HTTP "201 Created" response, with the content containing a representation of the created subscription, and the Location header containing the resource URI of the created subscription "{apiRoot}/nnef-pfdmanagement/v1/subscriptions/{subscriptionId}". + +Otherwise, one of the HTTP status codes listed in table 5.3.4.3.1-3 shall be returned. + +**NOTE:** The PFDs that have been provisioned to the PFDF before the NF service consumer performs the subscription are not notified to the NF service consumer as a result of this subscription, but the NF service consumer can retrieve them before performing the subscription by invoking Nnef\_PFDmanagement\_Fetch Service Operation. + +#### 4.2.3.3 Subscription update for event notifications on PFDs change + +This procedure, as shown in Figure 4.2.3.3-1, is used to update an existing subscription to notifications on events when the PFDs for application identifier(s) change. + +![Sequence diagram for Figure 4.2.3.3-1: Update of a subscription for event notifications on PFDs change. The diagram shows two lifelines: 'NF service consumer' on the left and 'PFDF' on the right. Step 1: A solid arrow points from the NF service consumer to the PFDF with the text '1. PUT... /subscriptions/{subscriptionId}'. Step 2: A solid arrow points from the PFDF back to the NF service consumer with the text '2. 200 OK'.](af6be343f0c0a8f155f965dcf337b8af_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PFDF + Note left of NF service consumer: 1. PUT... /subscriptions/{subscriptionId} + NF service consumer->>PFDF: 1. PUT... /subscriptions/{subscriptionId} + Note right of PFDF: 2. 200 OK + PFDF-->>NF service consumer: 2. 200 OK +``` + +Sequence diagram for Figure 4.2.3.3-1: Update of a subscription for event notifications on PFDs change. The diagram shows two lifelines: 'NF service consumer' on the left and 'PFDF' on the right. Step 1: A solid arrow points from the NF service consumer to the PFDF with the text '1. PUT... /subscriptions/{subscriptionId}'. Step 2: A solid arrow points from the PFDF back to the NF service consumer with the text '2. 200 OK'. + +**Figure 4.2.3.3-1: Update of a subscription for event notifications on PFDs change** + +1. If the feature PfdChgSubsUpdate is supported, the NF service consumer (e.g. SMF) shall send a PUT request to the resource URI representing the targeted PFD subscription resource "{apiRoot}/nnef-pfdmanagement/v1/subscriptions/{subscriptionId}". The NF service consumer shall include the PfdSubscription data type in the request content. Within the PfdSubscription data type, the NF service consumer shall include: + +- an URI where to receive the requested notifications as "notifyUri" attribute; and may include: +- subscribed application identifier(s) within the "applicationIds" attribute. + +NOTE 1: The "notifyUri" attribute within the PfdSubscription data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +2. If the feature PfdChgSubsUpdate is supported and the request is accepted, the PFDF shall: + +- update the subscription; and +- send an HTTP "200 OK" response with the content containing a representation of the updated subscription. + +Otherwise, if errors occur when processing the HTTP PUT request, the PFDF shall send an HTTP error response as specified in clause 5.7. If the feature "ES3XX" is supported, and the PFDF determines the received HTTP PUT request needs to be redirected, the PFDF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +NOTE 2: The PFDs that have been provisioned to the PFDF before the NF service consumer performs the subscription are not notified to the NF service consumer as a result of this subscription, but the NF service consumer can retrieve them before performing the subscription by invoking Nnef\_PFDmanagement\_Fetch Service Operation. + +### 4.2.4 Nnef\_PFDmanagement\_Notify Service Operation + +#### 4.2.4.1 General + +The Nnef\_PFDmanagement\_Notify service operation notifies the NF service consumer to update, delete or retrieve the PFDs for application identifier(s). + +The following procedures using the Nnef\_PFDmanagement\_Notify service operation are supported: + +- Notification of PFD change. +- Notification PUSH + +#### 4.2.4.2 Notification of PFD change + +![Sequence diagram showing the notification of PFD change between an NF service consumer and a PFDF. The PFDF sends a POST request to the NF service consumer, and the NF service consumer responds with either a 200 OK or a 204 No Content.](ea37ab05b033e59cfdf7b074161aaf5a_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PFDF + Note right of PFDF: 1. POST{notifyUri}(array(PfdChangeNotification)) + PFDF->>NF service consumer: 1. POST{notifyUri}(array(PfdChangeNotification)) + Note left of NF service consumer: 2a. 200 OK +2b. 204 No Content + NF service consumer-->>PFDF: 2a. 200 OK +2b. 204 No Content + +``` + +Sequence diagram showing the notification of PFD change between an NF service consumer and a PFDF. The PFDF sends a POST request to the NF service consumer, and the NF service consumer responds with either a 200 OK or a 204 No Content. + +Figure 4.2.4.2-1: Notification of PFD change + +1. The PFDF shall send a POST request to the NF service consumer (e.g. SMF) targeting the URI "{notifyUri}", where {notifyUri} is the notification URI provided during the creation or modification of the subscription + +resource as specified in clause 4.2.3. The content of the POST request shall contain one or more PfdChangeNotification data structure(s). + +2 If the notification is accepted, the NF service consumer shall reply with: + +- "204 No Content" indicating the successful provisioning of all PFDs; or +- "200 OK" and the content of the response shall contain "PfdChangeReport" data structure with detailed information of failed application(s). + +Otherwise, if errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.7. If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +#### 4.2.4.3 Notification PUSH + +![Sequence diagram for Notification PUSH](f6e8acf9f931452d01688d311b5c0364_img.jpg) + +``` +sequenceDiagram + participant PFDF + participant NF as NF service consumer + Note right of PFDF: 1. POST {notifyUri}/notifypush + PFDF->>NF: 1. POST {notifyUri}/notifypush + Note left of NF: 2. 204 No Content + NF->>PFDF: 2. 204 No Content +``` + +The diagram illustrates the interaction between a PFDF and an NF service consumer for a Notification PUSH. The PFDF sends a POST request to the NF service consumer's notifyUri. The NF service consumer responds with a 204 No Content status. + +Sequence diagram for Notification PUSH + +**Figure 4.2.4.3-1: Notification PUSH** + +1. If the NotificationPush feature defined in clause 5.8 is supported, and when the PFDF only notifies the NF service consumer to retrieve or remove the PFDs for application identifier(s), then the PFDF shall send a POST request to the NF service consumer (e.g. SMF) with "{notifyUri}/notifypush" as URI (where the "notifyUri" was previously supplied by the NF service consumer) and one or more NotificationPush data structure as request body. Each NotificationPush data structure shall include the application identifier(s) within the "appId" attribute, the "pfdOp" attribute set to the applicable value and may include the "allowedDelay" attribute containing the allowed delay time if received when the "pfdOp" attribute is set to "RETRIEVE", "FULLPULL" or "PARTIALPULL". +- 2 If the NF service consumer accepts the received POST request, the NF service consumer shall send an HTTP "204 No Content" response. + +After the successful processing of the HTTP POST request, + +- if the PFDF requests the NF service consumer to retrieve the PFD(s) with the "pfdOp" attribute set to the value "RETRIEVE" or without the "pfdOp" attribute, the NF service consumer shall determine to invoke the full pull procedure defined in clause 4.2.2.2 or invoke the partial pull procedure defined in clause 4.2.2.3 if the "PartialPull" feature is supported to retrieve the PFD(s) for the application identifier(s). +- if the "PartialPull" feature is supported and if the PFDF requests the NF service consumer to retrieve the PFD(s) with the "pfdOp" attribute set to the value "FULLPULL", the NF service consumer shall invoke the full pull procedure defined in clause 4.2.2.2. +- if the "PartialPull" feature is supported and if the PFDF indicates the NF service consumer to retrieve the PFD(s) with the "pfdOp" attribute set to the value "PARTIALPULL", the NF service consumer may invoke the partial full procedure defined in clause 4.2.2.3. +- for all above cases, if the "allowedDelay" attribute is provided for one or more application(s), the NF service consumer shall retrieve the PFD(s) within the allowed delay time. + +- if the PFDF requests the NF service consumer to remove the PFD(s) with the "pfdOp" attribute set to the value "REMOVE", the NF service consumer shall remove the PFD(s) for the application identifier(s) and re-apply the pre-configured PFDs. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +### 4.2.5 Nnef\_PFDmanagement\_Unsubscribe Service Operation + +#### 4.2.5.1 General + +The Nnef\_PFDmanagement\_Unsubscribe service operation is used by the NF service consumer to unsubscribe from notifications on PFD change events. + +The following procedures using the Nnef\_PFDmanagement\_Unsubscribe service operation are supported: + +- Unsubscribe from event notifications on PFDs change. + +#### 4.2.5.2 Unsubscribe from event notifications on PFDs change + +![Sequence diagram showing the unsubscribe process. The NF service consumer sends a DELETE request to the PFDF, and the PFDF responds with a 204 No Content.](18722c46c9e8475524e634dedd08bac2_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PFDF + Note left of NF service consumer: 1. DELETE... /subscriptions/{subscriptionId} + NF service consumer->>PFDF: 1. DELETE... /subscriptions/{subscriptionId} + Note right of PFDF: 2. 204 No Content + PFDF-->>NF service consumer: 2. 204 No Content +``` + +Sequence diagram showing the unsubscribe process. The NF service consumer sends a DELETE request to the PFDF, and the PFDF responds with a 204 No Content. + +Figure 4.2.5.2-1: Unsubscribe from event notifications on PFDs change + +1. The NF service consumer (e.g. SMF) shall send a DELETE request to the resource URI representing the individual PFD subscription. The request body shall be empty. +2. If the request is accepted, an HTTP "204 No Content" response shall be returned. The response body shall be empty. + +Otherwise, if errors occur when processing the HTTP DELETE request, the PFDF consumer shall send an HTTP error response as specified in clause 5.7. If the feature "ES3XX" is supported, and the PFDF determines the received HTTP DELETE request needs to be redirected, the PFDF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +# 5 Nnef\_PFDmanagement API + +## 5.1 Introduction + +The Packet Flow Description Management Service shall use the Nnef\_PFDmanagement API. + +The API URI of the Nnef\_PFDmanagement API shall be: + +{apiRoot}// + +The request URIs used in HTTP requests from the NF service consumer towards the PFDF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "nnef-pfdmanagement". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 9113 [7], shall be used as specified in clause 5.2 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [9] specification of HTTP messages and content bodies for the Nnef\_PFDmanagement service is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification, as specified in clause 5.4 of 3GPP TS 29.500 [5]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [16]. + +### 5.2.3 HTTP custom headers + +#### 5.2.3.1 General + +The Nnef\_PFDmanagement API shall support HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4]. + +In this Release of the specification, no specific custom headers are defined for the Nnef\_PFDmanagement API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +![A hierarchical tree diagram showing the resource URI structure of the Nnef_PFDmanagement API. The root is {apiRoot}/nnef-pfdmanagement/v1. It branches into /applications and /subscriptions. /applications further branches into /{appId} and /partialpull (the latter is in a dashed box). /subscriptions further branches into /{subscriptionId}.](33a8f3f01dfa8bce75d23017855a13c5_img.jpg) + +{apiRoot}/nnef-pfdmanagement/v1 + +``` + +graph TD + Root["{apiRoot}/nnef-pfdmanagement/v1"] --> Applications["/applications"] + Root --> Subscriptions["/subscriptions"] + Applications --> AppId["/{appId}"] + Applications --> PartialPull["/partialpull"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + style PartialPull stroke-dasharray: 5 5 + +``` + +A hierarchical tree diagram showing the resource URI structure of the Nnef\_PFDmanagement API. The root is {apiRoot}/nnef-pfdmanagement/v1. It branches into /applications and /subscriptions. /applications further branches into /{appId} and /partialpull (the latter is in a dashed box). /subscriptions further branches into /{subscriptionId}. + +**Figure 5.3.1-1: Resource URI structure of the Nnef\_PFDmanagement API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------------|---------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------| +| PFD of applications | /applications | GET | Nnef_PFDmanagement_Fetch.
Retrieve PFDs for one or multiple applications using query parameters. | +| | /applications/partialpull | partialpull (POST) | Request PFDs for one or multiple application identifier(s) by the partial update. | +| Individual application PFD | /applications/{appId} | GET | Nnef_PFDmanagement_Fetch.
Retrieve the PFD for an application. | +| PFD subscriptions | /subscriptions | POST | Nnef_PFDmanagement_Subscribe.
Subscribe the notification of PFD changes. | +| Individual PFD subscription | /subscriptions/{subscriptionId} | PUT | Nnef_PFDmanagement_Subscribe.
Update a subscription to PFD change notifications. | +| Individual PFD subscription | /subscriptions/{subscriptionId} | DELETE | Nnef_PFDmanagement_Unsubscribe.
Delete a subscription to PFD change notifications. | + +### 5.3.2 Resource: PFD of applications + +#### 5.3.2.1 Description + +This resource represents PFDs for all applications. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/nnelf-pfdmanagement/v1/applications + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|----------------------|---|-------------|-----------------------------------------------------------------------------| +| application-ids | array(ApplicationId) | M | 1..N | The requested application identifier(s) for which PFD(s) shall be returned. | +| supported-features | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------| +| array(PfdDataForApp) | M | 0..N | 200 OK | The PFDs for one or more application identifier(s) provided in the request URI are returned. | +| NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the GET method shall also apply. | | | | | + +#### 5.3.2.4 Resource Custom Operations + +##### 5.3.2.4.1 Overview + +**Table 5.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | HTTP method or custom operation | Description | +|----------------|---------------------------|---------------------------------|-----------------------------------------------------------------------------------| +| Partialpull | /applications/partialpull | partialpull (POST) | Request PFDs for one or multiple application identifier(s) by the partial update. | + +##### 5.3.2.4.2 Operation: partialpull + +###### 5.3.2.4.2.1 Description + +###### 5.3.2.4.2.2 Operation Definition + +This custom operation requests PFDs for one or multiple application identifier(s) by the partial update.. + +This operation shall support the request data structures specified in table 5.3.2.4.2.2-1 and the response data structure and response codes specified in table 5.3.2.4.2.2-2. + +**Table 5.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------------|---|-------------|----------------------------------------------------------| +| array(ApplicationForPfdRequest) | M | 1 | Contains the application Identifier(s) for PFDs request. | + +**Table 5.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------| +| array(PfdDataForApp) | M | 0..N | 200 OK | The PFDs for one or more application identifier(s) are returned. | +| n/a | | | 204 No Content | | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply. | | | | | + +### 5.3.3 Resource: Individual application PFD + +#### 5.3.3.1 Description + +This resource represents the PFD identified by an application identifier. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnef-pfdmanagement/v1/applications/{appId} + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------------------------| +| apiRoot | string | See clause 5.1. | +| appId | string | Identifies a set of PFD for an application identifier. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. | + +This method shall support the request data structures specified in table 5.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| PfdDataForApp | M | 1 | 200 OK | A representation of PFDs for an application in the request URI is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PFD subscription retrieval.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PFD subscription retrieval.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the GET method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PFDF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PFDF (service) instance towards which the request is redirected | + +**Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PFDF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PFDF (service) instance towards which the request is redirected | + +#### 5.3.3.4 Resource Custom Operations + +None. + +### 5.3.4 Resource: PFD subscriptions + +#### 5.3.4.1 Description + +This resource represents a collection of subscriptions created by NF service consumers of Nnef\_PFDmanagement service. + +#### 5.3.4.2 Resource definition + +Resource URI: {apiRoot}/nnef-pfdmanagement/v1/subscriptions + +This resource shall support the resource URI variables defined in table 5.3.4.2-1. + +**Table 5.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.4.3 Resource Standard Methods + +##### 5.3.4.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.4.3.1-1. + +**Table 5.3.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.4.3.1-2 and the response data structures and response codes specified in table 5.3.4.3.1-3. + +**Table 5.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|------------------------------------| +| PfdSubscription | M | 1 | Create a PfdSubscription resource. | + +**Table 5.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| PfdSubscription | M | 1 | 201 Created | The creation of a PfdSubscription resource is confirmed and a representation of that resource is returned. | +| NOTE: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. | | | | | + +**Table 5.3.4.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnef-pfdmanagement/v1/subscriptions/{subscriptionId} | + +#### 5.3.4.4 Resource Custom Operations + +None. + +### 5.3.5 Resource: Individual PFD subscription + +#### 5.3.5.1 Description + +This resource represents an individual PFD subscription created by an NF service consumer of the Nnef\_PFDmanagement service. + +#### 5.3.5.2 Resource definition + +Resource URI: {apiRoot}/nnef-pfdmanagement/v1/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.3.5.2-1. + +**Table 5.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|---------------------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| subscriptionId | string | Identifies an individual subscription to the PFD management service | + +#### 5.3.5.3 Resource Standard Methods + +##### 5.3.5.3.1 DELETE + +This method shall support the URI query parameters specified in table 5.3.5.3.1-1. + +**Table 5.3.5.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.5.3.1-2 and the response data structures and response codes specified in table 5.3.5.3.1-3. + +Table 5.3.5.3.1-2: Data structures supported by the DELETE Request Body on this resource + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +Table 5.3.5.3.1-3: Data structures supported by the DELETE Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The PfdSubscription resource matching the subscriptionId was deleted successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PFD subscription deletion.
Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PFD subscription deletion.
Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the DELETE method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +Table 5.3.5.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PFDF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PFDF (service) instance towards which the request is redirected | + +Table 5.3.5.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PFDF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PFDF (service) instance towards which the request is redirected | + +##### 5.3.5.3.2 PUT + +This method shall support the URI query parameters specified in table 5.3.5.3.2-1. + +Table 5.3.5.3.2-1: URI query parameters supported by the PUT method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.5.3.2-2 and the response data structures and response codes specified in table 5.3.5.3.2-3. + +**Table 5.3.5.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|------------------------------------| +| PfdSubscription | M | 1 | Update a PfdSubscription resource. | + +**Table 5.3.5.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| PfdSubscription | M | 1 | 200 OK | The update of a PfdSubscription resource is confirmed and a representation of that resource is returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection, during Individual PFD subscription modification.
Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection, during Individual PFD subscription modification.
Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the PUT method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.5.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PFDF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PFDF (service) instance towards which the request is redirected | + +**Table 5.3.5.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PFDF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PFDF (service) instance towards which the request is redirected | + +#### 5.3.5.4 Resource Custom Operations + +None. + +## 5.4 Custom Operations without associated resources + +None + +## 5.5 Notifications + +### 5.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [5] and clause 4.6.2.3 of 3GPP TS 29.501 [6]. + +**Table 5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------------|------------------------|---------------------------------|----------------------------------------------------------------------------------| +| PFD Change Notification | {notifyUri} | POST | Notification of PFD change. | +| Notification Push | {notifyUri}/notifypush | notifypush (POST) | Notifies NF service consumer to retrieve the PFDs for application identifier(s). | + +### 5.5.2 PFD Change Notification + +#### 5.5.2.1 Description + +The PFD Change Notification is used by the PFDF to inform the NF service consumer, which has subscribed to this Notification via the PFD subscriptions resource. + +#### 5.5.2.2 Target URI + +The Callback URI "{notifyUri}" shall be used with the callback URI variables defined in table 5.5.2.2-1. + +**Table 5.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| notifyUri | Uri | The Notification Uri as assigned within the PFD subscriptions resource and described within the PfdSubscription data type (see table 5.6.2.3-1). | + +#### 5.5.2.3 Standard Methods + +##### 5.5.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.2.3.1-1. + +**Table 5.5.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.2.3.1-2 and the response data structures and response codes specified in table 5.5.2.3.1-3. + +**Table 5.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|----------------------------------| +| array(PfdChangeNotification) | M | 1..N | Provides PFD change information. | + +**Table 5.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The PFD operation in the notification is performed successfully, i.e. all PFD changes are accepted by the NF service consumer. | +| array(PfdChangeReport) | M | 1..N | 200 OK | The PFD operation in the notification is performed and the PfdChangeReport indicates failure reason for each failed application in the partial success. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during PFD Change Notification.
Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during PFD Change Notification.
Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | The server encountered an unexpected condition that prevented it from fulfilling the request. PFDs for all applications are not accepted by the NF service consumer. (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 5.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +### 5.5.3 Notification Push + +#### 5.5.3.1 Description + +The Notification Push is used by the PFDF to inform the NF service consumer, which has subscribed to this Notification via the PFD subscriptions resource. + +#### 5.5.3.2 Target URI + +The Callback URI "{notifyUri}/notifypush" shall be used with the callback URI variables defined in table 5.5.3.2-1. + +**Table 5.5.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| notifyUri | Uri | The Notification Uri as assigned within the PFD subscriptions resource and described within the PfdSubscription data type (see table 5.6.2.3-1). | + +#### 5.5.3.3 Standard Methods + +##### 5.5.3.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.3.3.1-1. + +**Table 5.5.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.3.3.1-2 and the response data structures and response codes specified in table 5.5.3.3.1-3. + +**Table 5.5.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|------------------------------------------------------------------------------------------| +| array(NotificationPush) | M | 1..N | Provides the information for the NF service consumer to retrieve and/or remove the PFDs. | + +**Table 5.5.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Notification PUSH is accepted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during PFD Change Notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during PFD Change Notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | +| NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.7. | | | | | +| NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). | | | | | + +**Table 5.5.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 5.5.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Nnef\_PFDmanagement service based interface protocol. + +**Table 5.6.1-1: Nnef\_PFDmanagement specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| ApplicationForPfdRequest | 5.6.2.8 | Contains the application identifier(s) for the PFDs request. | PartialPull | +| NotificationPush | 5.6.2.7 | Provides the information for the NF service consumer to retrieve the PFDs and/or remove the PFDs of the applicable application identifier(s). | NotificationPush | +| PfdChangeNotification | 5.6.2.4 | Represents PFD change information. | | +| PfdChangeReport | 5.6.2.6 | Represents error of PFD change. | | +| PfdContent | 5.6.2.5 | Represents the content of a PFD for an application identifier. | | +| PfdDataForApp | 5.6.2.2 | Represents the PFDs for an application identifier. | | +| PfdOperation | 5.6.3.3 | Indicates the operation of the PFDs. | NotificationPush | +| PfdSubscription | 5.6.2.3 | Represents a PFD subscription. | | + +Table 5.6.1-2 specifies data types re-used by the Nnef\_PFDmanagement service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnef\_PFDmanagement service based interface. + +Table 5.6.1-2: Nnef\_PFDmanagement re-used Data Types + +| Data type | Reference | Comments | Applicability | +|--------------------|---------------------|--------------------------------------------------------------------------------------|--------------------| +| ApplicationId | 3GPP TS 29.571 [10] | | | +| DateTime | 3GPP TS 29.571 [10] | | | +| DomainNameProtocol | 3GPP TS 29.122 [11] | Indicates the additional protocol and protocol field for domain names to be matched. | DomainNameProtocol | +| DurationSec | 3GPP TS 29.571 [10] | Identifies a period of time in units of seconds. | NotificationPush | +| RedirectResponse | 3GPP TS 29.571 [10] | Contains redirection related information. | ES3XX | +| SupportedFeatures | 3GPP TS 29.571 [10] | | | +| Uri | 3GPP TS 29.571 [10] | | | + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +Allowed structures are: array, object. + +#### 5.6.2.2 Type: PfdDataForApp + +Table 5.6.2.2-1: Definition of type PfdDataForApp + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| applicationId | ApplicationId | M | 1 | Identifier of an application. | | +| pfds | array(PfdContent) | C | 1..N | PFDs for the application identifier. | | +| cachingTime | DateTime | O | 0..1 | Caching time for an application identifier. | | +| cachingTimer | DurationSec | O | 0..1 | Caching timer for an application identifier expressed as duration with unit of second. | CachingTimer | +| pfdTimestamp | DateTime | O | 0..1 | The value represents the UTC time set for the PFD(s) of the application identifier provisioning by the PFDF. | PartialPull | +| partialFlag | boolean | O | 0..1 | Indication of partial update of PFDs for an existing application identifier if it is included and set to "true". Otherwise set to "false" indicates not supporting partial update of PFDs for an existing application identifier. The default value "false" applies if the attribute is not present. | PartialPull | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of the optional features.

This attribute shall be present in in the HTTP GET response if the "supported-features" attribute query parameter is included in the HTTP GET request. | | + +NOTE: The "pfds" attribute shall be included if the "PartialPull" feature is not supported. + +#### 5.6.2.3 Type: PfdSubscription + +Table 5.6.2.3-1: Definition of type PfdSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------|---|-------------|-------------------------------------------------------------------------------|---------------| +| applicationIds | array(ApplicationId) | O | 1..N | Identifiers of applications with PFDs change. | | +| notifyUri | Uri | M | 1 | Identifies the recipient of notifications sent by PPDF for this subscription. | | +| supportedFeatures | SupportedFeatures | M | 1 | List of supported features used as described in clause 5.8. | | + +#### 5.6.2.4 Type: PfdChangeNotification + +Table 5.6.2.4-1: Definition of type PfdChangeNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| applicationId | ApplicationId | M | 1 | Identifier of an application. | | +| removalFlag | boolean | O | 0..1 | Indication of removal of PFDs for an existing application identifier. Set to "true" indicates the PFDs are removed. Set to "false" indicates the PFDs are not removed. Default value is "false" if omitted. | | +| partialFlag | boolean | O | 0..1 | Indication of partial update of PFDs for an existing application identifier if this operation is supported according to feature negotiation. Set to "true" indicates partial update of PFDs for the included application identifier. Set to "false" indicates not partial update of PFDs for the included application identifier. Default value is "false" if omitted. | PartialUpdate | +| pfds | array(PfdContent) | O | 1..N | PFD creation/update for the application identifier as specified in clause 6.3.3.5 of 3GPP TS 29.251 [12]. | | + +#### 5.6.2.5 Type: PfdContent + +Table 5.6.2.5-1: Definition of type PfdContent + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| pfdId | string | C | 0..1 | Identifies a PDF of an application identifier. If PartialUpdate or PartialPull feature is supported, this attribute shall be provided by the PFDF. | | +| flowDescriptions | array(string) | O | 1..N | Represents a 3-tuple with protocol, server ip and server port for UL/DL application traffic. The content of the string has the same encoding as the IPFilterRule AVP value as defined in IETF RFC 6733 [18]. (NOTE) | | +| urls | array(string) | O | 1..N | Indicates a URL or a regular expression which is used to match the significant parts of the URL. (NOTE) | | +| domainNames | array(string) | O | 1..N | Indicates an FQDN or a regular expression as a domain name matching criteria. (NOTE) | | +| dnProtocol | DomainNameProtocol | C | 0..1 | Indicates the additional protocol and protocol field for domain names to be matched, it may only be provided when domainNames attribute is present. | DomainNameProtocol | + +NOTE: If a PFD contains multiple filter types, the PFD is only matched when every filter type contained in the PFD has a matching value. + +#### 5.6.2.6 Type: PfdChangeReport + +Table 5.6.2.6-1: PfdChangeReport + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pfdError | ProblemDetails | M | 1 | More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure.
The "cause" attribute in the ProblemDetails shall be set to one of following application errors (see table 5.2.7.1-1 of 3GPP TS 29.500 [5]):
- SYSTEM_FAILURE
- INSUFFICIENT_RESOURCES
- UNSPECIFIED_NF_FAILURE | | +| applicationId | array(ApplicationId) | M | 1..N | Indicates the application identifier(s) which PFD(s) are failed to be added or modified. | | + +#### 5.6.2.7 Type: NotificationPush + +**Table 5.6.2.7-1: Definition of type NotificationPush** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|----------------------------------------------------------------------------------|---------------| +| appIds | array(ApplicationId) | M | 1..N | Identifiers of one or more applications. | | +| allowedDelay | DurationSec | O | 0..1 | Indicates the time limit that the NF service consumer shall retrieve the PFD(s). | | +| pfdOp | PfdOperation | O | 0..1 | Indication the operation of the PFDs. | | + +#### 5.6.2.8 Type: ApplicationForPfdRequest + +**Table 5.6.2.8-1: Definition of ApplicationForPfdRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------|---------------| +| applicationId | ApplicationId | M | 1 | Identifier of an application. | | +| pfdTimestamp | DateTime | O | 1 | The value represents the UTC time set for the PFD(s) of the application identifier provisioning by the PFDF. | | + +### 5.6.3 Simple data types and enumerations + +#### 5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 5.6.3.3 Enumeration: PfdOperation + +**Table 5.6.3.3-1: Enumeration PfdOperation** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| RETRIEVE | Indicates to retrieve the PFD(s) for the application identifier(s). The NF service consumer determines which pull procedure can be applied to retrieve the PFD(s). | | +| FULLPULL | Indicates to retrieve the PFD(s) for the application identifier(s) by the full pull procedure. | | +| PARTIALPULL | Indicates to retrieve the PFD(s) for the application identifier(s) by the partial pull procedure. The NF consumer may decide to use full pull procedure instead if needed. | | +| REMOVE | Indicates to remove the PFD(s) for the application identifier(s). | | + +## 5.7 Error handling + +### 5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [5]. + +For the Nnef\_PFDmanagement API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [5]. + +In addition, the requirements in the following clauses shall apply. + +### 5.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnef\_PFDmanagement API. + +### 5.7.3 Application Errors + +The application errors defined for the Nnef\_PFDmanagement service are listed in table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------| +| SYSTEM_FAILURE | 500 Internal Server Error | Something functions wrongly in PFD provisioning or the PFD provisioning does not function at all. (NOTE) | +| INSUFFICIENT_RESOURCE | 500 Internal Server Error | There is limitation for resource storage. (NOTE) | +| UNSPECIFIED_NF_FAILURE | 500 Internal Server Error | Unspecified reason. (NOTE) | +| NOTE: This application error is included in the responses to the POST request of PFD change notification/Notification PUSH. | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Nnef\_PFDmanagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5]. + +**Table 5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | PartialUpdate | The PFDf can use this feature for partial update of PFDs. | +| 2 | DomainNameProtocol | This feature supports the additional protocol matching condition for the domain name in PFD data. | +| 3 | PfdChgSubsUpdate | The NF service consumer can use this feature for updating the PFD change subscription. | +| 4 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [5] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. | +| 5 | PartialPull | The NF service consumer can use this feature to retrieve the PFDs by the partial update. | +| 6 | NotificationPush | The PFDf can use this feature to notify the NF service consumer to retrieve the PFDs. | +| 7 | CachingTimer | The PFDf and the NF service consumer can use this feature to support caching timer with unit of duration second. | + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [14] and 3GPP TS 29.500 [5], the access to the Nnef\_PFDmanagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [15]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnef\_PFDmanagement API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [13], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF service consumer used for discovering the Nnef\_PFDmanagement service. + +The Nnef\_PFDmanagement API defines a single scope "nnef-pfdmanagement" for OAuth2 authorization (as specified in 3GPP TS 33.501 [14]) for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +The present Annex contains an OpenAPI [9] specification of HTTP messages and content bodies used by the Nnef\_PFDmanagement API. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [17] and clause 5.3.1 of the 3GPP TS 29.501 [6] for further information).: + +## A.2 Nnef\_PFDmanagement API + +``` +openapi: 3.0.0 +info: + title: Nnef_PFDmanagement Service API + version: 1.3.0-alpha.2 + description: | + Packet Flow Description Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +# +externalDocs: + description: 3GPP TS 29.551 v18.3.0, 5G System; Packet Flow Description Management Service + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.551/' +# +servers: + - url: '{apiRoot}/nnef-pfdmanagement/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: + - {} + - oAuth2ClientCredentials: + - nnef-pfdmanagement +paths: + /applications: + get: + summary: Retrieve PFDs for all applications or for one or multiple applications with query +parameter. + tags: + - PFD of applications + operationId: Nnef_PFDmanagement_AllFetch + parameters: + - name: application-ids + description: The required application identifier(s) for the returned PFDs. + in: query + required: true + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + - name: supported-features + in: query + description: To filter irrelevant responses related to unsupported features + schema: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: > + The PFDs for one or more application identifier(s) in the request URI are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PfdDataForApp' + minItems: 0 + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/applications/partialpull: + post: + summary: retrieve the PFD(s) by partial update + operationId: Nnef_PFDmanagement_AppFetchPartialUpdate + tags: + - PFD of applications by partial update + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ApplicationForPfdRequest' + minItems: 1 + responses: + '200': + description: OK. Changed PFD(s) is returned + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PfdDataForApp' + minItems: 1 + '204': + description: The PFD(s) is not changed + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + +``` + +``` +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/applications/{appId}: + get: + summary: Retrieve the PFD for an application. + tags: + - Individual application PFD + operationId: Nnef_PFDmanagement_IndAppFetch + parameters: + - name: appId + description: The required application identifier(s) for the returned PFDs. + in: path + required: true + schema: + type: string + - name: supported-features + in: query + description: To filter irrelevant responses related to unsupported features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: A representation of PFDs for an application in the request URI is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdDataForApp' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions: + post: + summary: Subscribe the notification of PFD changes. + tags: + - PFD subscriptions + operationId: Nnef_PFDmanagement_CreateSubscr + requestBody: + description: a PfdSubscription resource to be created. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PfdSubscription' + callbacks: + PfdChangeNotification: + '{request.body#/notifyUri}': + post: +``` + +``` + +summary: Notification of PFD change. +tags: + - PfdChangeNotification data +operationId: Nnef_PFDmanagement_Notify +requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PfdChangeNotification' + minItems: 1 +responses: + '200': + description: > + The PFD operation in the notification is performed and the + PfdChangeReport indicates failure reason. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PfdChangeReport' + minItems: 1 + '204': + description: The PFD operation in the notification is performed successfully. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +NotificationPush: + '{request.body#/notifyUri}/notifypush': + post: + summary: Notification Push. + tags: + - NotificationPush data + operationId: Nnef_PFDmanagement_PushNotify + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationPush' + minItems: 1 + responses: + '204': + description: Notification PUSH is accepted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +responses: + '201': + description: > + The creation of a PfdSubscription resource is confirmed and a representation of + that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdSubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnef-pfdmanagement/v1/subscriptions/{subscriptionId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription/{subscriptionId}: + put: + summary: Updates/replaces an existing subscription resource + tags: + - Individual PFD subscription + operationId: Nnef_PFDmanagement_ModifySubscr + parameters: + - name: subscriptionId + description: Identify the subscription. + in: path + +``` + +``` + required: true + schema: + type: string + requestBody: + description: Parameters to update/replace the existing subscription + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PfdSubscription' + responses: + '200': + description: OK (Successful update of the subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/PfdSubscription' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete a subscription of PFD change notification. + tags: + - Individual PFD subscription + operationId: Nnef_PFDmanagement_Unsubscribe + parameters: + - name: subscriptionId + description: Identify the subscription. + in: path + required: true + schema: + type: string + responses: + '204': + description: > + The PfdSubscription resource matching the subscriptionId was deleted successfully. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +``` + +``` +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnef-pfdmanagement: Access to the Nnef_PFDmanagement API + schemas: +# +# STRUCTURED DATA TYPES +# + + PfdContent: + description: Represents the content of a PFD for an application identifier. + type: object + properties: + pfdId: + type: string + description: Identifies a PDF of an application identifier. + flowDescriptions: + type: array + items: + type: string + minItems: 1 + description: > + Represents a 3-tuple with protocol, server ip and server port for UL/DL + application traffic. + urls: + type: array + items: + type: string + minItems: 1 + description: > + Indicates a URL or a regular expression which is used to match the significant parts + of the URL. + domainNames: + type: array + items: + type: string + minItems: 1 + description: Indicates an FQDN or a regular expression as a domain name matching criteria. + dnProtocol: + $ref: 'TS29122_PfdManagement.yaml#/components/schemas/DomainNameProtocol' + + PfdDataForApp: + description: Represents the PFDs for an application identifier. + type: object + properties: + applicationId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + pfdS: + type: array + items: + $ref: '#/components/schemas/PfdContent' + minItems: 1 + cachingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + cachingTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + pfdTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + partialFlag: + type: boolean + description: > + Indication of partial update of PFDs for an existing application identifier if it is + included and set to true. Otherwise set to false indicates not supporting partial + update of PFDs for an existing application identifier. The default value false + applies if the attribute is not present. + default: false + supportedFeatures: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - applicationId + +PfdSubscription: + description: Represents a PFD subscription. + type: object + properties: + applicationIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + notifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - notifyUri + - supportedFeatures + +PfdChangeNotification: + description: Represents information related to a notification of PFD change. + type: object + properties: + applicationId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + removalFlag: + type: boolean + description: > + Indication of removal of PFDs for an existing application identifier. + Set to true indicates the PFDs are removed. + Set to false indicates the PFDs are not removed. + Default value is false if omitted. + default: false + partialFlag: + type: boolean + description: > + Indication of partial update of PFDs for an existing application identifier + if this operation is supported according to feature negotiation. + Set to true indicates partial update PFDs for the included application identifier. + Set to false indicates not partial update PFDs for the included application identifier. + Default value is "false" if omitted. + default: false + pfdS: + type: array + items: + $ref: '#/components/schemas/PfdContent' + minItems: 1 + required: + - applicationId + +NotificationPush: + description: > + Represents the information to be used by the NF service consumer to retrieve the + PFDs and/or remove the PFDs of the applicable application identifier(s). + type: object + properties: + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + allowedDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + pfdOp: + $ref: '#/components/schemas/PfdOperation' + required: + - appIds + +PfdChangeReport: + description: Represents an error report on PFD change. + type: object + properties: + pfdError: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + applicationId: + type: array +``` + +``` + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + required: + - pfdError + - applicationId + +ApplicationForPfdRequest: + description: Contains the application identifier(s) for the PFD(s) request. + type: object + properties: + applicationId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + pfdTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - applicationId + +# +# ENUMERATIONS +# + +PfdOperation: + description: Indicates the operation to be applied on PFD(s). + anyOf: + - type: string + enum: + - RETRIEVE + - FULLPULL + - PARTIALPULL + - REMOVE + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-01 | | | | | | TS skeleton of PFD Management Service specification | 0.0.0 | +| 2018-01 | CT3#94 | | | | | Includes the following contribution agreed by CT3 at CT3#94: C3-180045, C3-180270, C3-180271. | 0.1.0 | +| 2018-03 | CT3#95 | | | | | Includes the following contribution agreed by CT3 at CT3#95: C3-181100, C3-181262, C3-181102, C3-181103, C3-181314. | 0.2.0 | +| 2018-04 | CT3#96 | | | | | Includes the following contribution agreed by CT3 at CT3#96: C3-182153, C3-182411, C3-182412, C3-182413, C3-182414, C3-182477, C3-182478. | 0.3.0 | +| 2018-05 | CT3#97 | | | | | Includes the following contribution agreed by CT3 at CT3#97: C3-183115, C3-183557, C3-183558, C3-183560. | 0.4.0 | +| 2018-06 | CT#80 | CP-181029 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181029 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 2 | F | Protocol error statement | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0002 | 1 | F | Description of Structured data types | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0003 | | F | Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0004 | 3 | F | Cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0005 | 1 | F | Correct Nnef_PFDmanagement API | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0006 | | F | Location Header | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0007 | 1 | F | Alignment of openAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0008 | | F | API version update | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0009 | | F | Security | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0010 | | F | Content type | 15.2.0 | +| 2019-03 | CT#83 | CP-190116 | 0011 | 1 | F | Fetch PFD for all applications | 15.3.0 | +| 2019-03 | CT#83 | CP-190116 | 0014 | 1 | F | Correction of resource URIs | 15.3.0 | +| 2019-03 | CT#83 | CP-190130 | 0010 | 1 | B | PUT for PFD change subscription | 16.0.0 | +| 2019-03 | CT#83 | CP-190121 | 0012 | 3 | B | PFD extension | 16.0.0 | +| 2019-03 | CT#83 | | | | | Open API version update by MCC | 16.0.0 | +| 2019-06 | CT#84 | CP-191083 | 0016 | 2 | A | Precedence of OpenAPI file | 16.1.0 | +| 2019-06 | CT#84 | CP-191083 | 0019 | | A | Correction to Notification of PFD change | 16.1.0 | +| 2019-06 | CT#84 | CP-191083 | 0021 | | A | Copyright Note in YAML file | 16.1.0 | +| 2019-06 | CT#84 | CP-191101 | 0023 | 2 | F | API version Update | 16.1.0 | +| 2019-09 | CT#85 | CP-192149 | 0025 | 2 | A | Correct presence condition in PFD definition | 16.2.0 | +| 2020-03 | CT#87e | CP-200215 | 0026 | | F | Reference of Error code | 16.3.0 | +| 2020-03 | CT#87e | CP-200216 | 0027 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-06 | CT#88e | CP-201244 | 0028 | | F | Non-unique operation identifiers | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0029 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0030 | 1 | F | URI of the Nnef_PFDmanagement service | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0031 | 1 | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0032 | 1 | F | Supported headers, Resource Data type and yaml mapping | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0033 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-09 | CT#89e | CP-202056 | 0035 | | A | Correction to the PFD change notification | 16.5.0 | +| 2020-09 | CT#89e | CP-202205 | 0038 | 2 | B | Notification PUSH | 17.0.0 | +| 2020-09 | CT#89e | CP-202085 | 0039 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.0.0 | +| 2020-12 | CT#90e | CP-203078 | 0041 | 2 | A | Essential corrections and alignments | 17.1.0 | +| 2020-12 | CT#90e | CP-203135 | 0042 | 1 | F | Corrections to Notification Push procedure | 17.1.0 | +| 2020-12 | CT#90e | CP-203120 | 0046 | 1 | A | Correction to PFD retrieval in PULL mode | 17.1.0 | +| 2020-12 | CT#90e | CP-203120 | 0049 | | A | Correction to notification URI of PFD change notification | 17.1.0 | +| 2020-12 | CT#90e | CP-203135 | 0050 | 1 | B | PULL mode enhancement | 17.1.0 | +| 2020-12 | CT#90e | CP-203135 | 0051 | 1 | B | Remove the EN within the PushNotification | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0053 | 1 | A | Storage of YAML files in 3GPP Forge | 17.1.0 | +| 2020-12 | CT#90e | CP-203135 | 0054 | | F | NotificationPush data type definition | 17.1.0 | +| 2020-12 | CT#90e | CP-203141 | 0055 | 1 | F | Non-unique operation identifiers | 17.1.0 | +| 2020-12 | CT#90e | CP-203153 | 0056 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-03 | CT#91e | CP-210191 | 0058 | 1 | A | Support of stateless NFs | 17.2.0 | +| 2021-03 | CT#91e | CP-210215 | 0059 | 5 | B | Resolve the FFS for notification push | 17.2.0 | +| 2021-03 | CT#91e | CP-210215 | 0060 | 3 | B | Partial pull update | 17.2.0 | +| 2021-03 | CT#91e | CP-210215 | 0061 | 5 | F | Corrections on partial pull | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0062 | | F | OpenAPI reference | 17.2.0 | +| 2021-03 | CT#91e | CP-210222 | 0064 | 1 | A | notifyUri used by notification | 17.2.0 | +| 2021-03 | CT#91e | CP-210215 | 0065 | | F | Invalid Nnef_PFDmanagement OpenAPI file | 17.2.0 | +| 2021-03 | CT#91e | CP-210215 | 0066 | | B | Correction to the name of custom operation | 17.2.0 | +| 2021-03 | CT#91e | CP-210215 | 0067 | 1 | B | Overall description of notification push | 17.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------|--------| +| 2021-03 | CT#91e | CP-210219 | 0069 | | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.2.0 | +| 2021-03 | CT#91e | CP-210200 | 0072 | | A | Datatype and figure corrections | 17.2.0 | +| 2021-03 | CT#91e | CP-210220 | 0073 | | F | Custom header clarification | 17.2.0 | +| 2021-03 | CT#91e | CP-210221 | 0074 | 1 | F | Terminology alignment usage of NF service consumer | 17.2.0 | +| 2021-03 | CT#91e | CP-210240 | 0076 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-06 | CT#92e | CP-211208 | 0079 | 1 | A | Correction of request URI in 4.2.2.2 | 17.3.0 | +| 2021-06 | CT#92e | CP-211200 | 0081 | 1 | A | Temporary and Permanent Redirection | 17.3.0 | +| 2021-06 | CT#92e | CP-211265 | 0083 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-09 | CT#93e | CP-212084 | 0084 | 1 | F | Correction to custom operation partialpull | 17.4.0 | +| 2021-09 | CT#93e | CP-212217 | 0085 | 1 | F | mandate the attribute pfdOp | 17.4.0 | +| 2021-09 | CT#93e | CP-212190 | 0088 | | A | default caching time value | 17.4.0 | +| 2021-09 | CT#93e | CP-212190 | 0091 | | A | Presentation condition of pfdId attribute | 17.4.0 | +| 2021-09 | CT#93e | CP-212223 | 0092 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.4.0 | +| 2021-12 | CT#94e | CP-213239 | 0093 | | F | Aligning API URI with SBI template | 17.5.0 | +| 2021-12 | CT#94e | CP-213243 | 0094 | | F | Correction to presence condition of supportedFeatures in PfdSubscription | 17.5.0 | +| 2021-12 | CT#94e | CP-213215 | 0097 | 1 | A | Correction to PFD management in push mode | 17.5.0 | +| 2021-12 | CT#94e | CP-213224 | 0099 | 1 | A | Adding supported features in GET response | 17.5.0 | +| 2021-12 | CT#94e | CP-213246 | 0101 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.5.0 | +| 2022-03 | CT#95e | CP-220201 | 0102 | 1 | F | Description fields format alignment | 17.6.0 | +| 2022-03 | CT#95e | CP-220194 | 0103 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221119 | 0106 | 1 | F | Correcting the description of the encoding used for flow descriptions | 17.7.0 | +| 2022-06 | CT#96 | CP-221152 | 0107 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-09 | CT#97e | CP-222122 | 0108 | 1 | F | Corrections to caching timer | 17.8.0 | +| 2022-09 | CT#97e | CP-222121 | 0109 | | F | Update of info and externalDocs fields | 17.8.0 | +| 2022-12 | CT#98e | CP-223191 | 0110 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0111 | 1 | F | PfdOperation enumeration definition in the OpenAPI file | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0112 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230147 | 0113 | 1 | B | Support NWDAF fetches PFD information in Nnef_PFDmanagement API | 18.1.0 | +| 2023-06 | CT#100 | CP-231131 | 0114 | 1 | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0115 | 1 | F | Error response for Notification PUSH | 18.2.0 | +| 2023-12 | CT#102 | CP-233278 | 0117 | | A | Corrections to boolean type definitions | 18.3.0 | +| 2023-12 | CT#102 | CP-233229 | 0118 | 1 | F | Updating the obsoleted IETF HTTP RFCs | 18.3.0 | +| 2023-12 | CT#102 | CP-233237 | 0120 | | F | Update of info and externalDocs fields | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29552/05eb72d372e4bf78e3d6a64949d77bcc_img.jpg b/raw/rel-18/29_series/29552/05eb72d372e4bf78e3d6a64949d77bcc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b00acec7127d07a50edd7f71a3cf13efb3dff90b --- /dev/null +++ b/raw/rel-18/29_series/29552/05eb72d372e4bf78e3d6a64949d77bcc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:30b710441aa2bb5702c0242d4d8a120499593bcb78d26e6f3a95af03982b1e71 +size 215098 diff --git a/raw/rel-18/29_series/29552/0f7871077bba48a2c97f7859a5edda0d_img.jpg b/raw/rel-18/29_series/29552/0f7871077bba48a2c97f7859a5edda0d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4e1678bfa9a45d6a6fffa14a3ca02d62697f5a26 --- /dev/null +++ b/raw/rel-18/29_series/29552/0f7871077bba48a2c97f7859a5edda0d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6186472e22bf129a3676c999b63699172ee813d5492b0f4820cefa6f8aa292e0 +size 136554 diff --git a/raw/rel-18/29_series/29552/1069cea91549f4b971298888e7982f53_img.jpg b/raw/rel-18/29_series/29552/1069cea91549f4b971298888e7982f53_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ef950532e3864574d415114832b909c7b892d8f2 --- /dev/null +++ b/raw/rel-18/29_series/29552/1069cea91549f4b971298888e7982f53_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3cc52ca3f8bd8b8341374fe6f89f41fb2f73bd9e03012d581c3ae74e918a923c +size 19933 diff --git a/raw/rel-18/29_series/29552/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg b/raw/rel-18/29_series/29552/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f6114bd247f224fe9711989b3bdce70de6e31752 --- /dev/null +++ b/raw/rel-18/29_series/29552/1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1534e2f985d99f9c82fd90ce0e22e31883eb06911d9c280353efb3a70665f9d1 +size 191214 diff --git a/raw/rel-18/29_series/29552/257c8341b41f1f4a287f27d33227974c_img.jpg b/raw/rel-18/29_series/29552/257c8341b41f1f4a287f27d33227974c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9fac37a06604c0569618180df9dc604977ecdede --- /dev/null +++ b/raw/rel-18/29_series/29552/257c8341b41f1f4a287f27d33227974c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e918c118f3f0e6d0152f38a500301e3dbdfeb63794e521a586ca26f576b4ad61 +size 112792 diff --git a/raw/rel-18/29_series/29552/28d75f39a24203712ee907b32cf0bbe5_img.jpg b/raw/rel-18/29_series/29552/28d75f39a24203712ee907b32cf0bbe5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e043c5636efa4e5807014ef5e855b7b03a05aa6a --- /dev/null +++ b/raw/rel-18/29_series/29552/28d75f39a24203712ee907b32cf0bbe5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f418a5f3a21e78569f54a41c74654b5512f286b93e12e73627f4d41f0cb9254e +size 168192 diff --git a/raw/rel-18/29_series/29552/2957154f4dc666a6cafb7b4d2d882910_img.jpg b/raw/rel-18/29_series/29552/2957154f4dc666a6cafb7b4d2d882910_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..db15e478ab054a34a7b438fa9ff87bc290c27cc4 --- /dev/null +++ b/raw/rel-18/29_series/29552/2957154f4dc666a6cafb7b4d2d882910_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bed1f296c46780ce9fd60959bca674f24f5a9b017584fddd511fec9f86bed0c5 +size 21785 diff --git a/raw/rel-18/29_series/29552/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg b/raw/rel-18/29_series/29552/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..df90d6a17bc5ca0255d057fe692a1941643e1c31 --- /dev/null +++ b/raw/rel-18/29_series/29552/2ae3eae1bd80a90f192f568ae246a9a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:82220acc1b34485af873f247775dc20fb6ad1b0e26f5c9d9c64f179e3f5e5277 +size 156934 diff --git a/raw/rel-18/29_series/29552/2f587210e4f97c32758c5972e2e83d20_img.jpg b/raw/rel-18/29_series/29552/2f587210e4f97c32758c5972e2e83d20_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c58888f978e65cfe12892990f096d1f9df4c5489 --- /dev/null +++ b/raw/rel-18/29_series/29552/2f587210e4f97c32758c5972e2e83d20_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5f93ecced4900438d07fcec93f1bed5f39b2c91dc2fe3b06c108ed12096ddcf0 +size 280152 diff --git a/raw/rel-18/29_series/29552/329c96049bb432e9c2cbda4e224a0c9c_img.jpg b/raw/rel-18/29_series/29552/329c96049bb432e9c2cbda4e224a0c9c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..96fd0811c34e59078581632e7fee79cf02a693fb --- /dev/null +++ b/raw/rel-18/29_series/29552/329c96049bb432e9c2cbda4e224a0c9c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:457e334f7f39443ef97ab3a66417c0c1ad07e28cb60df48460ae3c8c6e17dd4b +size 68063 diff --git a/raw/rel-18/29_series/29552/346324c08906e6d9320f632ab916f73e_img.jpg b/raw/rel-18/29_series/29552/346324c08906e6d9320f632ab916f73e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f703be3a995ec6081abf75bcb5c2e6a5503d582c --- /dev/null +++ b/raw/rel-18/29_series/29552/346324c08906e6d9320f632ab916f73e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:74bfff11562698a53342af063718fddfdddee5ec9f65d22305544c5f4f627e72 +size 160199 diff --git a/raw/rel-18/29_series/29552/38d82ffe820e339811b396206f40a201_img.jpg b/raw/rel-18/29_series/29552/38d82ffe820e339811b396206f40a201_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c9e916b8e22076a8d74eb12a40910d27218773b0 --- /dev/null +++ b/raw/rel-18/29_series/29552/38d82ffe820e339811b396206f40a201_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9c613ba1e59c6dfb338daf8d04d4100dbef1a5ae0504556be2675c2e2057a2f6 +size 153911 diff --git a/raw/rel-18/29_series/29552/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg b/raw/rel-18/29_series/29552/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7ce4dc3528a8fa0a5e865f758ed72ddb220fe3d6 --- /dev/null +++ b/raw/rel-18/29_series/29552/40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3c5b72783b6fc0e0cf15be9a22db078d9259e10e9ee797f468fd67ba342518c7 +size 88878 diff --git a/raw/rel-18/29_series/29552/4806f9f95fff13a30d6523bd6ffeac63_img.jpg b/raw/rel-18/29_series/29552/4806f9f95fff13a30d6523bd6ffeac63_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fdb688088c8e6a9de755e2d1d54a92e32dea40ca --- /dev/null +++ b/raw/rel-18/29_series/29552/4806f9f95fff13a30d6523bd6ffeac63_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c37ca0b0a1f354da3ca69ed2015e99ac52dc0fdca10d4f785f6f227c98fbd771 +size 230190 diff --git a/raw/rel-18/29_series/29552/49fe8fe978c0f7e73112d231feb377eb_img.jpg b/raw/rel-18/29_series/29552/49fe8fe978c0f7e73112d231feb377eb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4dfb250ee08ae45866d6e49eb252e960c1581835 --- /dev/null +++ b/raw/rel-18/29_series/29552/49fe8fe978c0f7e73112d231feb377eb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:749dff086ef2bc905edf68b8401c56ac8d6659893fa8cd66ca56c5eb576d4c5b +size 283474 diff --git a/raw/rel-18/29_series/29552/5492fadb32a8df1ee9f2528a053c9862_img.jpg b/raw/rel-18/29_series/29552/5492fadb32a8df1ee9f2528a053c9862_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c79847da76978fc7efd103c1a4d21b1fa99284b2 --- /dev/null +++ b/raw/rel-18/29_series/29552/5492fadb32a8df1ee9f2528a053c9862_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:50b5d6bf8f2824c6f50f8efd6450d48b477367a23fdca748d98e828a4ef6fc01 +size 69556 diff --git a/raw/rel-18/29_series/29552/57134800ac3a97b6212b27b93aa196ac_img.jpg b/raw/rel-18/29_series/29552/57134800ac3a97b6212b27b93aa196ac_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d62ca5239174b63023847b773098b73057e2a238 --- /dev/null +++ b/raw/rel-18/29_series/29552/57134800ac3a97b6212b27b93aa196ac_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9c3335d41789b7008a110d383b642ed82a8d0a783984aac343ee2e2396f25d84 +size 104014 diff --git a/raw/rel-18/29_series/29552/5e9af8986a5845504f251d3079da8078_img.jpg b/raw/rel-18/29_series/29552/5e9af8986a5845504f251d3079da8078_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b5794054829b095c1a359c9c4738aafce643a036 --- /dev/null +++ b/raw/rel-18/29_series/29552/5e9af8986a5845504f251d3079da8078_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:196028c11ee510104529b0a030e5ab765f22494d86450d0a948344b5f9c6413e +size 300020 diff --git a/raw/rel-18/29_series/29552/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29552/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..782a57c5a1b6b3621eb176ec0bb337efbf5003b5 --- /dev/null +++ b/raw/rel-18/29_series/29552/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:364ea0cc3b44fe271b5ad3a2256b5c876d8c60fc09fd14c164189b454d5c7c19 +size 9374 diff --git a/raw/rel-18/29_series/29552/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29552/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5f07a39c72993712648368a3ef946fe5ef66fb0b --- /dev/null +++ b/raw/rel-18/29_series/29552/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0f7c16c8e5cde8d9ae5a3a783252218541351cbe765da56a368e3a1a94ba097c +size 5692 diff --git a/raw/rel-18/29_series/29552/694df81535f89c7bfb9ef0df6f130dc0_img.jpg b/raw/rel-18/29_series/29552/694df81535f89c7bfb9ef0df6f130dc0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..725b4da0a325a72f02395e9d0f6001e09cb3ad70 --- /dev/null +++ b/raw/rel-18/29_series/29552/694df81535f89c7bfb9ef0df6f130dc0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa7329308485cc5eed2b70fdb4f0e3e93230f9207312aef8a28843b1e6a62af4 +size 135923 diff --git a/raw/rel-18/29_series/29552/70de8885bd7de15723aaad5eb5c5febf_img.jpg b/raw/rel-18/29_series/29552/70de8885bd7de15723aaad5eb5c5febf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7dbfcd74b1dc11eac0f9ddb30f31ad87a8edf2f7 --- /dev/null +++ b/raw/rel-18/29_series/29552/70de8885bd7de15723aaad5eb5c5febf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:176f82197f2140194d87ad1a86a255730433f0073e3674453a7c3996c45fac0a +size 22059 diff --git a/raw/rel-18/29_series/29552/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg b/raw/rel-18/29_series/29552/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cfd11d59ab6d39d8457dceb1fad1ee9d02865069 --- /dev/null +++ b/raw/rel-18/29_series/29552/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1a74991de29dbb6ff9ef82de49edd6e075bd47689e17d758fd70c8439ba06e05 +size 157808 diff --git a/raw/rel-18/29_series/29552/79e1709a7317ead45379cbb8ff3ba802_img.jpg b/raw/rel-18/29_series/29552/79e1709a7317ead45379cbb8ff3ba802_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b60c59784a6f284d0bffae9d43ef8f22cf9c89ed --- /dev/null +++ b/raw/rel-18/29_series/29552/79e1709a7317ead45379cbb8ff3ba802_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:807c5ed67633fc0936917dae379270240dec4ee55557b64217c8e9d4ca176b16 +size 300326 diff --git a/raw/rel-18/29_series/29552/7ed5d5770331f31ade15439a21c31425_img.jpg b/raw/rel-18/29_series/29552/7ed5d5770331f31ade15439a21c31425_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..887dad77adb853fe142debe7135581dccb09cca6 --- /dev/null +++ b/raw/rel-18/29_series/29552/7ed5d5770331f31ade15439a21c31425_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9f655c6ef8751a86f2ee4f0c497aae8131e9216457ef41157699cd1a1343fc97 +size 287096 diff --git a/raw/rel-18/29_series/29552/7f17c430b9598e4d748a8041457810b3_img.jpg b/raw/rel-18/29_series/29552/7f17c430b9598e4d748a8041457810b3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8265536f99a6724a9b536105567642806c58635b --- /dev/null +++ b/raw/rel-18/29_series/29552/7f17c430b9598e4d748a8041457810b3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3cf43fd5bdac4a48d7fccce3d53bd35de9ed4f982a9f37e6a6dfd0bcb4880a05 +size 29273 diff --git a/raw/rel-18/29_series/29552/7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg b/raw/rel-18/29_series/29552/7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4d8ddeb7b62b13c1819b7c9a791e4b2e93478eb9 --- /dev/null +++ b/raw/rel-18/29_series/29552/7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0d209697d2d9341c67765f43e5da18c886d439fdd45365b56b54b379603b3229 +size 135793 diff --git a/raw/rel-18/29_series/29552/8198a1ee0b1f6ef1c5f1bf702dc74eca_img.jpg b/raw/rel-18/29_series/29552/8198a1ee0b1f6ef1c5f1bf702dc74eca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..84003f4bc9f73987d9198b39afc6b83df472ea52 --- /dev/null +++ b/raw/rel-18/29_series/29552/8198a1ee0b1f6ef1c5f1bf702dc74eca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b5d32ccfd100214f99f22c1ae283356b7a98d95c2ce7dba0a65d9191a67a4e40 +size 17855 diff --git a/raw/rel-18/29_series/29552/8307f6b04df072c9332f9987e034272c_img.jpg b/raw/rel-18/29_series/29552/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f70306437f5a4bbd0720e42ab3e9c84fe1e876d3 --- /dev/null +++ b/raw/rel-18/29_series/29552/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f2bab9d72dd8477556982303fe5e3faa268b4cef8438e520821f8bc97e8f9b46 +size 246343 diff --git a/raw/rel-18/29_series/29552/8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg b/raw/rel-18/29_series/29552/8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..28493dc2906c83c72299a3db11b0f4a46e6ac191 --- /dev/null +++ b/raw/rel-18/29_series/29552/8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eeab238b2144870229797f0a1d67e041ce3bfac39a4834590540409802039565 +size 151658 diff --git a/raw/rel-18/29_series/29552/8e14350b4b669119a3bdfca7869110ca_img.jpg b/raw/rel-18/29_series/29552/8e14350b4b669119a3bdfca7869110ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4d0ee2a0433f3ad2ced75792156bca87902016af --- /dev/null +++ b/raw/rel-18/29_series/29552/8e14350b4b669119a3bdfca7869110ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:beba337e66f203703ae51413002a2222980c813b342d9b6d0b8a26c4d5f0eb8c +size 46262 diff --git a/raw/rel-18/29_series/29552/8edfc370769207831f060f44d2281084_img.jpg b/raw/rel-18/29_series/29552/8edfc370769207831f060f44d2281084_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f2e4a0e00d4990f297fedbdab747572070bac2c6 --- /dev/null +++ b/raw/rel-18/29_series/29552/8edfc370769207831f060f44d2281084_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cf4a36735510cba5ed44b116919d9deb1ec661daf1a1f44b7b7955b1c5786313 +size 56705 diff --git a/raw/rel-18/29_series/29552/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg b/raw/rel-18/29_series/29552/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f59b00978fb6add20b76bcd60c4ae62eb34e10ef --- /dev/null +++ b/raw/rel-18/29_series/29552/9252ccfbbe9e34cb108f0060f2b563f1_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f37d237ec9d9c17eac84ab19bf7469400d6e4c984a5e127880ddd0ed20bfa8ae +size 295381 diff --git a/raw/rel-18/29_series/29552/9c45844d796e85ae05505870a54e4eb4_img.jpg b/raw/rel-18/29_series/29552/9c45844d796e85ae05505870a54e4eb4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b85061f17196c012d75a9429bcb945bf2d394e7d --- /dev/null +++ b/raw/rel-18/29_series/29552/9c45844d796e85ae05505870a54e4eb4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7948e1e4e273bd78f6cb1b271615cf7650444ff2243f55a335125fd898bd1e7b +size 99445 diff --git a/raw/rel-18/29_series/29552/a4eb9fe011f0e6dc8405f777c5f3f766_img.jpg b/raw/rel-18/29_series/29552/a4eb9fe011f0e6dc8405f777c5f3f766_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..91dfa270c51b15a5de5e73c44296374e84a80eb8 --- /dev/null +++ b/raw/rel-18/29_series/29552/a4eb9fe011f0e6dc8405f777c5f3f766_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6bdcb3633e120979430afc78834aa94406371d6ed93e928a9d37e567bd65310a +size 140775 diff --git a/raw/rel-18/29_series/29552/a5404b7275b06497eecf9b5883604753_img.jpg b/raw/rel-18/29_series/29552/a5404b7275b06497eecf9b5883604753_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1229e697faffd616325fa50c358aa64f4cc0e61c --- /dev/null +++ b/raw/rel-18/29_series/29552/a5404b7275b06497eecf9b5883604753_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bdd0ba902ea3e3a2580847854415c9be985a05b0c402058a3a418f78b9495da9 +size 162396 diff --git a/raw/rel-18/29_series/29552/b34c69e1ec326b01c3a485b27b1df5f6_img.jpg b/raw/rel-18/29_series/29552/b34c69e1ec326b01c3a485b27b1df5f6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..432968f5eaed9a53a5f86d7b1cddba9b9d3b9ea6 --- /dev/null +++ b/raw/rel-18/29_series/29552/b34c69e1ec326b01c3a485b27b1df5f6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1389f534a1b188d72c635d29181c03a56860c943cc339dd12757ae44b6f075e9 +size 302171 diff --git a/raw/rel-18/29_series/29552/be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg b/raw/rel-18/29_series/29552/be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c0f59b037205990364207d31653c8c5d8e2dcba1 --- /dev/null +++ b/raw/rel-18/29_series/29552/be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7df7130f92e62e29d5d3224628fbf7a3fbc6edc72485a9161d45b7f8657f250f +size 280967 diff --git a/raw/rel-18/29_series/29552/c00d3fb4f9d9609639a6e7d7a356afd3_img.jpg b/raw/rel-18/29_series/29552/c00d3fb4f9d9609639a6e7d7a356afd3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..021b8767ce19123772da5c665a0494ad565f9b25 --- /dev/null +++ b/raw/rel-18/29_series/29552/c00d3fb4f9d9609639a6e7d7a356afd3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:86a84ba21dc1126cb7e2b7a0f54d570acbd900749e3a0e86ad810cf91f3b8c19 +size 18414 diff --git a/raw/rel-18/29_series/29552/c2fc2621e8206d24427b56bcb2398fc0_img.jpg b/raw/rel-18/29_series/29552/c2fc2621e8206d24427b56bcb2398fc0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bd9d4381749ffd0973cab7cd8fc472e6b698673c --- /dev/null +++ b/raw/rel-18/29_series/29552/c2fc2621e8206d24427b56bcb2398fc0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:caa74018e5ddf1b1c1c8211f1578ac4c9dac258ba5776a87c9cd29007706361e +size 70528 diff --git a/raw/rel-18/29_series/29552/cb4cfa42ce34febde7bdb882f3fc3094_img.jpg b/raw/rel-18/29_series/29552/cb4cfa42ce34febde7bdb882f3fc3094_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bdc7978a1b029aee77bf143e7fbea3d19bcddd67 --- /dev/null +++ b/raw/rel-18/29_series/29552/cb4cfa42ce34febde7bdb882f3fc3094_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c36311903461e0869dee6bae3fe5c82e6c9f75840d5454f17c161398ccfa67f0 +size 44921 diff --git a/raw/rel-18/29_series/29552/db39acbd11df5eb7e79ab84562fb8f74_img.jpg b/raw/rel-18/29_series/29552/db39acbd11df5eb7e79ab84562fb8f74_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e8b0fbf724e1805476ae95015290a8cd0697b810 --- /dev/null +++ b/raw/rel-18/29_series/29552/db39acbd11df5eb7e79ab84562fb8f74_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ca4287e49da50d62563b42610486439ebc5afb37f785dceb39118b6940d6afa3 +size 252457 diff --git a/raw/rel-18/29_series/29552/dc37a040cf9e2add7488c7c37cbf3687_img.jpg b/raw/rel-18/29_series/29552/dc37a040cf9e2add7488c7c37cbf3687_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..42ac566b4a47f689544dc7bb5a428d4e307bf095 --- /dev/null +++ b/raw/rel-18/29_series/29552/dc37a040cf9e2add7488c7c37cbf3687_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:33ccd564407a870fba02eed67a586b539198a1487cd6475c0a51f5c58ab1b41b +size 64035 diff --git a/raw/rel-18/29_series/29552/df1966d80c74bc127f159a48f38b13ee_img.jpg b/raw/rel-18/29_series/29552/df1966d80c74bc127f159a48f38b13ee_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1c0fc3f8dab02f2a59c5859c8e8bb737ced4e8ea --- /dev/null +++ b/raw/rel-18/29_series/29552/df1966d80c74bc127f159a48f38b13ee_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ca07f5f5838caaaae5b11c2fb7de1a39f87b34a41ce4fd037656896a018337ad +size 87403 diff --git a/raw/rel-18/29_series/29552/e05b36c0d46549e681ce6581422c66b2_img.jpg b/raw/rel-18/29_series/29552/e05b36c0d46549e681ce6581422c66b2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bc5912f4daa8dc9b6e1ac3731b19e3af42ae45b5 --- /dev/null +++ b/raw/rel-18/29_series/29552/e05b36c0d46549e681ce6581422c66b2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:05a791acc969a428750762feec5231435fe123834a848c870f6a57845a1e3e41 +size 80725 diff --git a/raw/rel-18/29_series/29552/e18841eb4a995df8354a793459e12fd0_img.jpg b/raw/rel-18/29_series/29552/e18841eb4a995df8354a793459e12fd0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d7c1161a014618b9ad468516ae9cf2cf5e55642c --- /dev/null +++ b/raw/rel-18/29_series/29552/e18841eb4a995df8354a793459e12fd0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fabade6bfcecdabd895ae3cdd89fd9d8af146f0415baaade51ecd71e999c94a9 +size 103644 diff --git a/raw/rel-18/29_series/29552/e3eebf9854831ba50eca8b26c468f65e_img.jpg b/raw/rel-18/29_series/29552/e3eebf9854831ba50eca8b26c468f65e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c55ae8c23505b8e9d7b1fe5022073cad8b5211ef --- /dev/null +++ b/raw/rel-18/29_series/29552/e3eebf9854831ba50eca8b26c468f65e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1414bb1eadac74b66aa12cb4502d2bc720ac43450141641c115e39e3726a947c +size 62162 diff --git a/raw/rel-18/29_series/29552/e9d825d87c5f85c8dba0664eace96ef4_img.jpg b/raw/rel-18/29_series/29552/e9d825d87c5f85c8dba0664eace96ef4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..071e09e868fe59f035e4c81dc7103d7f9871f3ba --- /dev/null +++ b/raw/rel-18/29_series/29552/e9d825d87c5f85c8dba0664eace96ef4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:567fd791c955caaa30480aee374a7d9eb5e081bf78e302a5b383f7d991f40a44 +size 52846 diff --git a/raw/rel-18/29_series/29552/f61d0925551545b5938b3a4d1bbf63c3_img.jpg b/raw/rel-18/29_series/29552/f61d0925551545b5938b3a4d1bbf63c3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..644a42e3466e75ef9a55b063b63d0e6c6671f07d --- /dev/null +++ b/raw/rel-18/29_series/29552/f61d0925551545b5938b3a4d1bbf63c3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:60595e881b30eadde181f89817ad62df171f4fe9ff67a6888e4b2f4debf010fa +size 195954 diff --git a/raw/rel-18/29_series/29552/f6e8acf9f931452d01688d311b5c0364_img.jpg b/raw/rel-18/29_series/29552/f6e8acf9f931452d01688d311b5c0364_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b07e34aa352e14597c572b17bff8a60287014bc1 --- /dev/null +++ b/raw/rel-18/29_series/29552/f6e8acf9f931452d01688d311b5c0364_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9bd9f300466d306cda94733801148830afd7458255f8ed18f503cb22cc0b7d2c +size 96289 diff --git a/raw/rel-18/29_series/29552/fbfa653853daf5541118a9ddecb92284_img.jpg b/raw/rel-18/29_series/29552/fbfa653853daf5541118a9ddecb92284_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d8691a0ecdd9e758a1cb32193a1aecac2aa063b8 --- /dev/null +++ b/raw/rel-18/29_series/29552/fbfa653853daf5541118a9ddecb92284_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5f06066ed1633b06e8237a575acbb0877897dbf3056da0a940c8d2a6e210f927 +size 17990 diff --git a/raw/rel-18/29_series/29552/fc3e2b49a9f850951570e502393b697f_img.jpg b/raw/rel-18/29_series/29552/fc3e2b49a9f850951570e502393b697f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..807ba3679a16b3abf8450a9a0d12fd10144ab6c9 --- /dev/null +++ b/raw/rel-18/29_series/29552/fc3e2b49a9f850951570e502393b697f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bce7f8ebaf2759fd6c357de2022365d9f111dba38dbb59cd0eda902b67ab7d22 +size 21494 diff --git a/raw/rel-18/29_series/29552/fcc757566216206ceddbd6c775e8db02_img.jpg b/raw/rel-18/29_series/29552/fcc757566216206ceddbd6c775e8db02_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..95644f572fe151f05ceaa9a5603e92141c3f0dd8 --- /dev/null +++ b/raw/rel-18/29_series/29552/fcc757566216206ceddbd6c775e8db02_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1b69a84ad8f74039ab6485ad9176853134a89f3f6ad01eb49d2251bbb5ae5288 +size 198889 diff --git a/raw/rel-18/29_series/29552/fd3cbb53e991f8209ba17b398f426e13_img.jpg b/raw/rel-18/29_series/29552/fd3cbb53e991f8209ba17b398f426e13_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f2b430eb2a34f8582ff446403fbc94f1d91fc1ae --- /dev/null +++ b/raw/rel-18/29_series/29552/fd3cbb53e991f8209ba17b398f426e13_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:807065186c8a6b073ef1b9f7518b585be1dbea3e0f25e881ce9ca3aff61c2325 +size 264569 diff --git a/raw/rel-18/29_series/29552/ff1a293f8118c0f00dbfeb0ab843d6e6_img.jpg b/raw/rel-18/29_series/29552/ff1a293f8118c0f00dbfeb0ab843d6e6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b59f3ac1ce63e6c7fa139fba1caa62ee3c600498 --- /dev/null +++ b/raw/rel-18/29_series/29552/ff1a293f8118c0f00dbfeb0ab843d6e6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:93a889c47434bf7959b43e69bc2e737ebf396fd7c9ef3def340e385af8c56375 +size 15754 diff --git a/raw/rel-18/29_series/29552/ffb6acd27b8e3a54392840948a75869f_img.jpg b/raw/rel-18/29_series/29552/ffb6acd27b8e3a54392840948a75869f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cb224855d5b9a24b3e37d9c9ead9c53181dab08c --- /dev/null +++ b/raw/rel-18/29_series/29552/ffb6acd27b8e3a54392840948a75869f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:800a8e523577f587ba945512c5cbf9d1cf41f1192e82a8eafd0dec2756491db0 +size 256391 diff --git a/raw/rel-18/29_series/29552/ffd8c2986aabedc8b6db2d8f2ed7a994_img.jpg b/raw/rel-18/29_series/29552/ffd8c2986aabedc8b6db2d8f2ed7a994_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5e8cf238463caff844510e5ab9d6280e1d597620 --- /dev/null +++ b/raw/rel-18/29_series/29552/ffd8c2986aabedc8b6db2d8f2ed7a994_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eee3f5dc97080e4d4ccd9a0bbe79b8bfdab309e8e025367e8bf0e60f927057bf +size 98298 diff --git a/raw/rel-18/29_series/29552/ffe0fef452a0ae9a20253c319c54e13c_img.jpg b/raw/rel-18/29_series/29552/ffe0fef452a0ae9a20253c319c54e13c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..59ceb66ed0aedaba3245ab416df3911e5753cb94 --- /dev/null +++ b/raw/rel-18/29_series/29552/ffe0fef452a0ae9a20253c319c54e13c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:86bea451a95c8cf4e03139008b158486543d2291191cefa73caf9dfc4ed32830 +size 246910 diff --git a/raw/rel-18/29_series/29555/3f1987804d7d78bc3b3bc560e974280a_img.jpg b/raw/rel-18/29_series/29555/3f1987804d7d78bc3b3bc560e974280a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bc193918f3a281a3dbf73f8288374dbb48b1d02f --- /dev/null +++ b/raw/rel-18/29_series/29555/3f1987804d7d78bc3b3bc560e974280a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:82dc2fb2428b79ea452b81ea8b313f1bc48a2b09801cdf6924c1985f8c3a136b +size 31975 diff --git a/raw/rel-18/29_series/29555/4356776ca004ecba5d599667a155d7d4_img.jpg b/raw/rel-18/29_series/29555/4356776ca004ecba5d599667a155d7d4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1ff53bb560cff4a3472600ccb8c2dd6f372a5cbd --- /dev/null +++ b/raw/rel-18/29_series/29555/4356776ca004ecba5d599667a155d7d4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:851c8fbbf7b2bf71dafdc9ad3fc5667050bfdb37076935d5a9175e87eed7f992 +size 50638 diff --git a/raw/rel-18/29_series/29555/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29555/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b96c7779704bd1fb7de3e3c3a32235088ade48f0 --- /dev/null +++ b/raw/rel-18/29_series/29555/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c11361bc4dcdd375b90794aa625e4f446e18aa98d91b836edd3aec3e3d458c6a +size 9443 diff --git a/raw/rel-18/29_series/29555/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29555/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..32abd44dadbb592975352736356d783d605be821 --- /dev/null +++ b/raw/rel-18/29_series/29555/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8e38bd647792109e8f9003c7c8684d732ce50c2cff8f050edb4a491353e8f58f +size 5719 diff --git a/raw/rel-18/29_series/29555/66c2bf11a8f117cddf67eff92d4c736c_img.jpg b/raw/rel-18/29_series/29555/66c2bf11a8f117cddf67eff92d4c736c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4c6c6344247e528ac423005562246a7c782aec5c --- /dev/null +++ b/raw/rel-18/29_series/29555/66c2bf11a8f117cddf67eff92d4c736c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9790a6e84b6027840a71a7ebf18517989f87443ad77e6c4a2d88100bdd24063 +size 41149 diff --git a/raw/rel-18/29_series/29555/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/raw/rel-18/29_series/29555/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a5b5db551663e1c0f0ef827aa2f4eb75c05dac37 --- /dev/null +++ b/raw/rel-18/29_series/29555/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e35cf55bc4f73781309056fb322653c617d52e1b511998b75d8c3db6d5feb14a +size 35938 diff --git a/raw/rel-18/29_series/29555/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg b/raw/rel-18/29_series/29555/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..33ef5cb3d5c8707732ef06bb6bcaeab8e9cbcb97 --- /dev/null +++ b/raw/rel-18/29_series/29555/a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:307b4e9ea099c17d67fc1c971d1d27289219ceca226f36e1e893c7d8f7dbb164 +size 32574 diff --git a/raw/rel-18/29_series/29555/af6be343f0c0a8f155f965dcf337b8af_img.jpg b/raw/rel-18/29_series/29555/af6be343f0c0a8f155f965dcf337b8af_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ec76d17ddf2518a5d720570500792505d1cf2782 --- /dev/null +++ b/raw/rel-18/29_series/29555/af6be343f0c0a8f155f965dcf337b8af_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6432835c2c98d2349af6914a4f0b325d6aaaeb0a58fc642640089d590e06519a +size 40221 diff --git a/raw/rel-18/29_series/29555/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg b/raw/rel-18/29_series/29555/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..38f48249a23edd2510a42a476259d818f9ef7231 --- /dev/null +++ b/raw/rel-18/29_series/29555/b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1302802cb72def90f8001bc4986c36e7361c597f1f31c97e3bca3728f86795a1 +size 58839 diff --git a/raw/rel-18/29_series/29555/d26959f4514c26ca19c3d6f00da85956_img.jpg b/raw/rel-18/29_series/29555/d26959f4514c26ca19c3d6f00da85956_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..132fe397fe0baa8f4cddce61b564bc2634372780 --- /dev/null +++ b/raw/rel-18/29_series/29555/d26959f4514c26ca19c3d6f00da85956_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6de471e558f62b308b8d22b005365ed7a83136dbeb96385c55ec6a285a21b2cb +size 36451 diff --git a/raw/rel-18/29_series/29555/e9d825d87c5f85c8dba0664eace96ef4_img.jpg b/raw/rel-18/29_series/29555/e9d825d87c5f85c8dba0664eace96ef4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..65906e9dd9bb410d6f7bec0d46412def04f647e0 --- /dev/null +++ b/raw/rel-18/29_series/29555/e9d825d87c5f85c8dba0664eace96ef4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a6d156b88ecd5ad1ca3bb34dfb6c982a7dd1b6c2399111e210199520a3a60cb8 +size 35239 diff --git a/raw/rel-18/29_series/29555/f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg b/raw/rel-18/29_series/29555/f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fc1b32d10ee7c878036c4627d9906fcef64a186d --- /dev/null +++ b/raw/rel-18/29_series/29555/f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:994df9a38e6c54730667cea1428f703495b9ef10fb8816085f30c678ac524214 +size 35884 diff --git a/raw/rel-18/29_series/29556/raw.md b/raw/rel-18/29_series/29556/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..89083c42940f6bd6cc323d8943ecf80aa923368e --- /dev/null +++ b/raw/rel-18/29_series/29556/raw.md @@ -0,0 +1,3460 @@ + + +# 3GPP TS 29.556 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Edge Application Server Discovery Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | | +|-----------|------------------------------------------------------------------------------------------------------------|----| +| 1 | Scope..... | 7 | +| 2 | References..... | 7 | +| 3 | Definitions, symbols and abbreviations ..... | 8 | +| 3.1 | Definitions ..... | 8 | +| 3.2 | Abbreviations ..... | 8 | +| 4 | Overview ..... | 8 | +| 4.1 | Introduction ..... | 8 | +| 5 | Services offered by the EASDF ..... | 9 | +| 5.1 | Introduction ..... | 9 | +| 5.2 | Neasdf_DNSContext Service..... | 9 | +| 5.2.1 | Service Description ..... | 9 | +| 5.2.2 | Service Operations..... | 10 | +| 5.2.2.1 | Introduction..... | 10 | +| 5.2.2.2 | Create ..... | 10 | +| 5.2.2.2.1 | General ..... | 10 | +| 5.2.2.3 | Update ..... | 11 | +| 5.2.2.3.1 | General ..... | 11 | +| 5.2.2.4 | Delete ..... | 12 | +| 5.2.2.4.1 | General ..... | 12 | +| 5.2.2.5 | Notify ..... | 13 | +| 5.2.2.5.1 | General ..... | 13 | +| 5.2.3 | DNS messages processing by EASDF ..... | 13 | +| 5.2.3.1 | Introduction..... | 13 | +| 5.2.3.2 | DNS message processing model..... | 13 | +| 5.2.3.2.1 | DNS Context ..... | 13 | +| 5.2.3.2.2 | DNS Rule ..... | 14 | +| 5.2.3.2.3 | Processing flow for incoming DNS messages ..... | 15 | +| 5.2.3.2.4 | Processing of a One-Time DNS Rule applicable to a specific DNS message earlier buffered in the EASDF ..... | 17 | +| 5.2.3.3 | DNS Message Detection Template..... | 17 | +| 5.2.3.3.1 | General ..... | 17 | +| 5.2.3.3.2 | DNS Query MDT ..... | 17 | +| 5.2.3.3.3 | DNS Response MDT..... | 18 | +| 5.2.3.4 | Actions applicable to DNS message..... | 18 | +| 5.2.3.4.1 | General ..... | 18 | +| 5.2.3.4.2 | Event reporting by EASDF ..... | 19 | +| 5.2.3.5 | Baseline DNS Patterns..... | 19 | +| 5.2.3.5.1 | General ..... | 19 | +| 5.3 | Neasdf_BaselineDNSPattern Service ..... | 20 | +| 5.3.1 | Service Description ..... | 20 | +| 5.3.2 | Service Operations..... | 20 | +| 5.3.2.1 | Introduction..... | 20 | +| 5.3.2.2 | Create ..... | 20 | +| 5.3.2.2.1 | General ..... | 20 | +| 5.3.2.3 | Update ..... | 21 | +| 5.3.2.3.1 | General ..... | 21 | +| 5.3.2.4 | Delete ..... | 22 | +| 5.3.2.4.1 | General ..... | 22 | +| 6 | API Definitions ..... | 23 | +| 6.1 | Neasdf_DNSContext Service API ..... | 23 | +| 6.1.1 | Introduction ..... | 23 | +| 6.1.2 | Usage of HTTP..... | 23 | +| 6.1.2.1 | General ..... | 23 | +| 6.1.2.2 | HTTP standard headers..... | 23 | + +| | | | +|------------|----------------------------------------------------------------------------------|----| +| 6.1.2.2.1 | General ..... | 23 | +| 6.1.2.2.2 | Content type ..... | 23 | +| 6.1.2.3 | HTTP custom headers..... | 24 | +| 6.1.3 | Resources..... | 24 | +| 6.1.3.1 | Overview..... | 24 | +| 6.1.3.2 | Resource: DNS contexts collection ..... | 24 | +| 6.1.3.2.1 | Description ..... | 24 | +| 6.1.3.2.2 | Resource Definition..... | 24 | +| 6.1.3.2.3 | Resource Standard Methods..... | 25 | +| 6.1.3.2.4 | Resource Custom Operations ..... | 26 | +| 6.1.3.3 | Resource: Individual DNS context ..... | 26 | +| 6.1.3.3.1 | Description ..... | 26 | +| 6.1.3.3.2 | Resource Definition..... | 26 | +| 6.1.3.3.3 | Resource Standard Methods..... | 26 | +| 6.1.3.3.4 | Resource Custom Operations..... | 30 | +| 6.1.4 | Custom Operations without associated resources ..... | 30 | +| 6.1.5 | Notifications ..... | 30 | +| 6.1.5.1 | General..... | 30 | +| 6.1.5.2 | DNS Context Notify ..... | 30 | +| 6.1.5.2.1 | Description ..... | 30 | +| 6.1.5.2.2 | Target URI..... | 30 | +| 6.1.5.2.3 | Standard Methods..... | 31 | +| 6.1.6 | Data Model ..... | 31 | +| 6.1.6.1 | General..... | 31 | +| 6.1.6.2 | Structured data types..... | 32 | +| 6.1.6.2.1 | Introduction ..... | 32 | +| 6.1.6.2.2 | Type: DnsContextCreateData ..... | 33 | +| 6.1.6.2.3 | Type: DnsContextCreatedData ..... | 33 | +| 6.1.6.2.4 | Type: DnsRule..... | 34 | +| 6.1.6.2.5 | Type: DnsQueryMdt ..... | 36 | +| 6.1.6.2.6 | Type: DnsRspMdt..... | 36 | +| 6.1.6.2.7 | Type: Ipv4AddressRange..... | 37 | +| 6.1.6.2.8 | Type: Ipv6PrefixRange ..... | 37 | +| 6.1.6.2.9 | Type: Action..... | 37 | +| 6.1.6.2.10 | Type: DnsContextNotification ..... | 38 | +| 6.1.6.2.11 | Type: ForwardingParameters ..... | 38 | +| 6.1.6.2.12 | Type: EcsOption..... | 38 | +| 6.1.6.2.13 | Type: DnsContextEventReport ..... | 38 | +| 6.1.6.2.14 | Type: DnsQueryReport ..... | 39 | +| 6.1.6.2.15 | Type: DnsRspReport..... | 39 | +| 6.1.6.2.16 | Type: EcsOptionInfo ..... | 39 | +| 6.1.6.2.17 | Type: DnsServerAddressInfo..... | 39 | +| 6.1.6.2.18 | Type: BaselineDnsMdtId ..... | 40 | +| 6.1.6.2.19 | Type: BaselineDnsAitId..... | 40 | +| 6.1.6.2.20 | Type: BaselineDnsQueryMdtInfo ..... | 40 | +| 6.1.6.2.21 | Type: BaselineDnsRspMdtInfo..... | 40 | +| 6.1.6.2.22 | Type: RespondParameters..... | 40 | +| 6.1.6.2.23 | Type: N6RoutingInfo ..... | 41 | +| 6.1.6.3 | Simple data types and enumerations..... | 41 | +| 6.1.6.3.1 | Introduction ..... | 41 | +| 6.1.6.3.2 | Simple data types ..... | 41 | +| 6.1.6.3.3 | Enumeration: ApplyAction ..... | 41 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 41 | +| 6.1.6.5 | Binary data ..... | 42 | +| 6.1.7 | Error Handling ..... | 42 | +| 6.1.7.1 | General..... | 42 | +| 6.1.7.2 | Protocol Errors ..... | 42 | +| 6.1.7.3 | Application Errors..... | 42 | +| 6.1.8 | Feature negotiation ..... | 42 | +| 6.1.9 | Security ..... | 43 | +| 6.1.10 | HTTP redirection..... | 43 | +| 6.2 | Neasdf_BaselineDNSPattern Service API ..... | 44 | + +| | | | +|-------------------------------|------------------------------------------------------|-----------| +| 6.2.1 | Introduction ..... | 44 | +| 6.2.2 | Usage of HTTP ..... | 44 | +| 6.2.2.1 | General ..... | 44 | +| 6.2.2.2 | HTTP standard headers ..... | 44 | +| 6.2.2.2.1 | General ..... | 44 | +| 6.2.2.2.2 | Content type ..... | 44 | +| 6.2.2.3 | HTTP custom headers ..... | 44 | +| 6.2.3 | Resources ..... | 45 | +| 6.2.3.1 | Overview ..... | 45 | +| 6.2.3.2 | Resource: Individual Baseline DNS Pattern ..... | 45 | +| 6.2.3.2.1 | Description ..... | 45 | +| 6.2.3.2.2 | Resource Definition ..... | 45 | +| 6.2.3.2.3 | Resource Standard Methods ..... | 46 | +| 6.2.3.3.4 | Resource Custom Operations ..... | 49 | +| 6.2.4 | Custom Operations without associated resources ..... | 50 | +| 6.2.5 | Notifications ..... | 50 | +| 6.2.6 | Data Model ..... | 50 | +| 6.2.6.1 | General ..... | 50 | +| 6.2.6.2 | Structured data types ..... | 50 | +| 6.2.6.2.1 | Introduction ..... | 50 | +| 6.2.6.2.2 | Type: BaseDnsPatternCreateData ..... | 51 | +| 6.2.6.2.3 | Type: BaseDnsPatternCreatedData ..... | 51 | +| 6.2.6.2.4 | Type: BaselineDnsMdt ..... | 52 | +| 6.2.6.2.5 | Type: BaselineDnsAit ..... | 52 | +| 6.2.6.2.6 | Type: VarNfld ..... | 53 | +| 6.2.7 | Error Handling ..... | 53 | +| 6.2.7.1 | General ..... | 53 | +| 6.2.7.2 | Protocol Errors ..... | 53 | +| 6.2.7.3 | Application Errors ..... | 53 | +| 6.2.8 | Feature negotiation ..... | 54 | +| 6.2.9 | Security ..... | 54 | +| 6.2.10 | HTTP redirection ..... | 54 | +| Annex A (normative): | OpenAPI specification ..... | 55 | +| A.1 | General ..... | 55 | +| A.2 | Neasdf_DNSContext API ..... | 55 | +| A.3 | Neasdf_BaselineDNSPattern API ..... | 64 | +| Annex B (informative): | Change history ..... | 70 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- Y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- Should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- Can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- Will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document +- might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Neasdf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the EASDF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.548 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.548: "5G System Enhancements for Edge Computing; Stage 2". +- [15] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". + +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [17] Void. +- [18] IETF RFC 7871: "Client Subnet in DNS Queries". +- [19] 3GPP TS 23.003: "Numbering, addressing and identification". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**One-Time DNS Rule:** A DNS Rule that applies only once to a specific DNS message earlier buffered in the EASDF and reported to the SMF (see clause 5.2.3.2.4). + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|--------------------------------------------------------| +| BD AIT | Baseline DNS Action Information Template | +| BD MDT | Baseline DNS Message Detection Template | +| EASDF | Edge Application Server Discovery Function | +| ECS | EDNS Client Subnet | +| EDNS | Extension mechanisms for DNS | +| HR-SBO | Home Routed Session BreakOut | +| MDT | (DNS Query or DNS Response) Message Detection Template | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the EASDF offers services to the SMF via the Neasdf service based interface (see 3GPP TS 23.548 [14], 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the EASDF and the scope of the present specification. + +![Reference model diagram showing SMF connected to EASDF via the Neasdf service based interface.](ef7a88e04d1939ee09bafd5c3072adf8_img.jpg) + +The diagram illustrates the reference model for the EASDF. It consists of two main components: the SMF (Service Management Function) and the EASDF (Edge Application Server Discovery Function). The SMF is represented by a light green rectangular box on the left. The EASDF is represented by a light green rectangular box on the right. A horizontal line connects the SMF to the EASDF. This line is labeled with 'N88' at the SMF end and 'Neasdf' at the EASDF end. The connection point on the EASDF side is marked with a small circle, indicating a service based interface. + +Reference model diagram showing SMF connected to EASDF via the Neasdf service based interface. + +**Figure 4.1-1: Reference model – EASDF** + +The functionalities supported by the EASDF are listed in clause 5.1.1 of 3GPP TS 23.548 [14]. + +In roaming scenarios, the V-EASDF offers service to the SMF in the VPLMN in both LBO roaming and HR with Session Breakout (HR-SBO) roaming scenarios (see clause 4.2 of 3GPP TS 23.548 [14]). + +# 5 Services offered by the EASDF + +## 5.1 Introduction + +The EASDF offers to other NFs the following service: + +**Table 5.1-1: NF Service provided by EASDF** + +| Service Name | Description | Example Consumer | +|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------|------------------| +| Neasdf_DNSContext | This service enables the consumer to create, update and delete DNS context in EASDF, or subscribe to DNS message reporting from EASDF. | SMF, V-SMF | +| Neasdf_BaselineDNSPattern | This service enables the consumer to create, update and delete Baseline DNS pattern in EASDF. | SMF, V-SMF | + +The Neasdf\_DNSContext service and Neasdf\_BaselineDNSPattern service are specified in 3GPP TS 23.548 [14]. + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------------|--------|----------------------------------|----------------------------------------|---------------------------|-------| +| Neasdf_DNSContext | 6.1 | EASDF DNSContext Service | TS29556_Neasdf_DNSContext.yaml | neasdf-dnscontext | A.2 | +| Neasdf_BaselineDNSPattern | 6.2 | EASDF BaselineDNSPattern Service | TS29556_Neasdf_BaselineDNSPattern.yaml | neasdf-baselinednspattern | A.3 | + +## 5.2 Neasdf\_DNSContext Service + +### 5.2.1 Service Description + +The Neasdf\_DNSContext service operates on the DNS contexts. The EASDF is acting as NF Service Producer, while the SMF is the NF Service Consumer. + +Following functionalities are provided by the Neasdf\_DNSContext service: + +- Create a DNS context in EASDF; +- Update a DNS context in EASDF; +- Delete a DNS context in EASDF; +- Enable the EASDF to report DNS signalling related information to the NF service consumer when receiving DNS Query or DNS Response. + +The Neasdf\_DNSContext service supports the following service operations. + +**Table 5.2.1-1: Service operations supported by the Neasdf\_DNSContext service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|-----------------------------------------------------------------------------------------------------------------------|---------------------|---------------------| +| Create | Create a DNS context in EASDF. | Request/Response | SMF, V-SMF | +| Update | Update a DNS context in EASDF. | Request/Response | SMF, V-SMF | +| Delete | Delete a DNS context in EASDF. | Request/Response | SMF, V-SMF | +| Notify | EASDF reports DNS signalling related information to the NF service consumer when receiving DNS Query or DNS Response. | Subscribe/Notify | SMF, V-SMF | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +See Table 5.2.1-1 for an overview of the service operations supported by the Neasdf\_DNSContext service. + +#### 5.2.2.2 Create + +##### 5.2.2.2.1 General + +The Create service operation shall be used to create an individual DNS context for a given PDU Session in the EASDF. + +It is used in the following procedures: + +- EAS Discovery Procedure with EASDF (see clause 6.2.3.2.2 of 3GPP TS 23.548 [14]); and +- EAS Discovery Procedure with V-EASDF for HR-SBO (see clauses 6.7.2.2 and 6.7.2.3) of 3GPP TS 23.548 [14]. + +There shall be only one individual DNS context created in an EASDF per PDU session. + +The NF Service Consumer (e.g. SMF) shall create a DNS context by using the HTTP POST method as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram showing DNS context creation. The NF Service Consumer sends a POST request to the EASDF. The EASDF responds with either a 201 Created status or an error status (4xx/5xx or 3xx).](cd48273072c5c3a23e11fde892d1b6b6_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer + participant EASDF + Note left of NFSC: + NFSC->>EASDF: 1. POST .../dns-contexts (DnsContextCreateData) + Note right of EASDF: + EASDF-->>NFSC: 2a. 201 Created (DnsContextCreatedData) + Note right of EASDF: + EASDF-->>NFSC: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing DNS context creation. The NF Service Consumer sends a POST request to the EASDF. The EASDF responds with either a 201 Created status or an error status (4xx/5xx or 3xx). + +**Figure 5.2.2.2.1-1: DNS context creation** + +1. The NF Service Consumer shall send a POST request to the resource representing the DNS contexts collection resource of the EASDF. The content of the POST request shall contain: + - the UE IP address, S-NSSAI and the DNN of the related PDU session; + - a notification URI for receiving DNS context related event notifications, if notifications are requested; + - one or more DNS rules. + +In addition, for a DNS context creation in the V-EASDF for HR-SBO in VPLMN: + +- the UE IP address shall be set to an unspecified address, i.e. to the IPv4 address 0.0.0.0, or the IPv6 address ::/128, if the IP address of the UE's PDU session is not known yet, or to a mapped address (when using UE source IP address mapping at the Local PSA-UPF); +- the S-NSSAI shall correspond to the VPLMN S-NSSAI value; and +- the content of the POST request shall contain the HPLMN ID. + +The payload body of the POST request may further contain: + +- N6 traffic routing information that may contain the IP address and optional port number of the Local PSA-UPF, for HR-SBO in VPLMN, when using N6 tunneling between the L-PSA and V-EASDF, to disambiguate the DNS traffic using a private UE IP address from a certain HPLMN using a specific L-PSA UPF address of the N6 tunnel between the Local PSA-UPF and the V-EASDF. + +- 2a. On success, a "201 Created" response shall be returned with the "Location" header containing the URI of the created resource. + +The POST response body shall include: + +- the IP address of the EASDF (to be sent by the SMF to the UE). + +- 2b. On failure, or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.1-3 shall be returned. + +#### 5.2.2.3 Update + +##### 5.2.2.3.1 General + +The Update service operation shall be used to update an individual DNS context previously created in the EASDF. The update operation may apply to the whole DNS context (complete replacement of the data of the existing DNS context by new data), or it may apply to modify a subset of the parameters of the DNS context. + +It is used in the following procedures: + +- EAS Discovery Procedure with EASDF (see clause 6.2.3.2.2 of 3GPP TS 23.548 [14]); and +- EAS Discovery Procedure with V-EASDF for HR-SBO (see clauses 6.7.2.2 and 6.7.2.3) of 3GPP TS 23.548 [14]. + +To perform a partial update of the DNS context of a given DNS context Id, the NF Service Consumer shall issue an HTTP PATCH request, as shown in Figure 5.2.2.3.1-1. This partial update shall be used to add, delete and/or replace individual parameters of the DNS context. + +![Sequence diagram showing the DNS context Partial Update interaction between an NF Service Consumer and an EASDF. The NF Service Consumer sends a PATCH request to the EASDF. The EASDF responds with either 2a. 204 No Content, 2b. 200 OK (PatchResult), or 2c. 4xx/5xx (ProblemDetails) or 3xx.](e58a867750e4ae01604318506b79df7a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant EASDF + Note left of NF Service Consumer: 1. PATCH ../dns-contexts/{dnsContextId} (PatchData) + NF Service Consumer->>EASDF: 1. PATCH ../dns-contexts/{dnsContextId} (PatchData) + Note right of EASDF: 2a. 204 No Content + EASDF-->>NF Service Consumer: 2a. 204 No Content + Note right of EASDF: 2b. 200 OK (PatchResult) + EASDF-->>NF Service Consumer: 2b. 200 OK (PatchResult) + Note right of EASDF: 2c. 4xx/5xx (ProblemDetails) or 3xx + EASDF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the DNS context Partial Update interaction between an NF Service Consumer and an EASDF. The NF Service Consumer sends a PATCH request to the EASDF. The EASDF responds with either 2a. 204 No Content, 2b. 200 OK (PatchResult), or 2c. 4xx/5xx (ProblemDetails) or 3xx. + +Figure 5.2.2.3.1-1: DNS context Partial Update + +1. The NF Service Consumer (e.g. SMF) shall send a PATCH request to the resource URI representing the individual DNS context, identified by the {dnsContextId}. The content of the PATCH request shall contain the list of operations (add/delete/replace) to be applied to parameters in the individual DNS context. +- 2a. On success, if all the modification instructions in the PATCH request have been implemented, "204 No Content" shall be returned. + +2b. If some of the modification instructions for unknown attribute(s) in the PATCH request have been ignored, the EASDF shall respond with "200 OK" with the response body containing PatchResult, as specified in clause 5.2.7.2 of 3GPP TS 29.500 [4]. + +2c. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.2-3 shall be returned. + +To perform a complete replacement of the data of the DNS context of a given DNS context Id, the NF Service Consumer shall issue an HTTP PUT request, as shown in Figure 5.2.2.3.1-2: + +![Sequence diagram for DNS context Complete Replacement. The NF Service Consumer sends a PUT request to the EASDF. The EASDF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](08441fa90c5fd11994626f662ac13f19_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant EASDF + Note left of NF Service Consumer: 1. PUT.../dns-contexts/{dnsContextId} (DnsContextCreateData) + NF Service Consumer->>EASDF: Request + Note right of EASDF: 2a. 204 No Content + EASDF-->>NF Service Consumer: Success Response + Note right of EASDF: 2b. 4xx/5xx (ProblemDetails) or 3xx + EASDF-->>NF Service Consumer: Error Response + +``` + +Sequence diagram for DNS context Complete Replacement. The NF Service Consumer sends a PUT request to the EASDF. The EASDF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +Figure 5.2.2.3.1-2: DNS context Complete Replacement + +1. The NF service consumer (e.g. SMF) shall send a PUT request to the resource URI representing the individual DNS context, identified by the {dnsContextId}. The content of the PUT request shall contain a representation of the individual DNS context to be completely replaced in the EASDF. + +2a. On success, "204 No Content" shall be returned. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.3-3 shall be returned. + +For HR-SBO in VPLMN, if the V-SMF has created the DNS context with an unspecified UE IP address, the V-SMF shall use either of the procedures above including the UE IP address assigned by the HPLMN to complete the configuration of the context in the V-EASDF. + +#### 5.2.2.4 Delete + +##### 5.2.2.4.1 General + +The Delete Service operation shall be used by the NF service consumer (e.g. SMF) to delete the individual DNS context in the EASDF. + +![Sequence diagram for DNS context deletion. The NF Service Consumer sends a DELETE request to the EASDF. The EASDF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant EASDF + Note left of NF Service Consumer: 1. DELETE .../dns-contexts/{dnsContextId} + NF Service Consumer->>EASDF: Request + Note right of EASDF: 2a. 204 No Content + EASDF-->>NF Service Consumer: Success Response + Note right of EASDF: 2b. 4xx/5xx (ProblemDetails) or 3xx + EASDF-->>NF Service Consumer: Error Response + +``` + +Sequence diagram for DNS context deletion. The NF Service Consumer sends a DELETE request to the EASDF. The EASDF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +Figure 5.2.2.4.1-1: DNS context deletion + +1. The NF Service Consumer (e.g. SMF) shall send a DELETE request to delete the individual DNS context represented by the {dnsContextId}. The request body shall be empty. + +2a. On success, "204 No Content" shall be returned. The response body shall be empty. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.1-3 shall be returned. + +#### 5.2.2.5 Notify + +##### 5.2.2.5.1 General + +The Notify service operation shall be used to notify the NF Service Consumer (e.g. SMF or V-SMF) about a DNS context related event, e.g. if a received DNS Query message or DNS response message matches a DNS detection template of an DNS rule and the associated action requires to report the message to the NF service producer. + +It is used in the following procedures: + +- EAS Discovery Procedure with EASDF (see clause 6.2.3.2.2 of 3GPP TS 23.548 [14]); and +- EAS Discovery Procedure with V-EASDF for HR-SBO (see clauses 6.7.2.2 and 6.7.2.3) of 3GPP TS 23.548 [14]. + +The EASDF shall send an HTTP POST request targeting the DNS context notification URI provided by the NF Service Consumer in the Create or Update service operation (see clause 5.2.2.2.1). See also Figure 5.2.2.5.1-1. + +![Sequence diagram illustrating the DNS Context Notify process. The NF Service Consumer sends a POST request to the EASDF. The EASDF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant EASDF + Note left of NF Service Consumer: NF Service Consumer + Note right of EASDF: EASDF + NF Service Consumer->>EASDF: 1. POST {dnsContextnotifUri} (DnsContextNotification) + EASDF-->>NF Service Consumer: 2a. 204 No Content + EASDF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram illustrating the DNS Context Notify process. The NF Service Consumer sends a POST request to the EASDF. The EASDF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +**Figure 5.2.2.5.1-1: DNS Context Notify** + +1. The EASDF shall send a HTTP POST request to the DNS context notification URI, and the content of the POST request shall contain a DnsContextNotification data structure, with the DNS message report that was subscribed by the NF Service Consumer. +- 2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.2.3.1-3 shall be returned. + +If the EASDF receives a "404 Not Found" response with the application error "DNS\_CONTEXT\_NOT\_FOUND", the EASDF should consider that the DNS context is no longer valid and delete the DNS context. + +The EASDF should not keep on sending notification requests to an NF service consumer and may consider that the DNS context is no longer valid and delete the DNS context, if it receives one or more "404 Not Found" responses without an application error or with other application errors. + +### 5.2.3 DNS messages processing by EASDF + +#### 5.2.3.1 Introduction + +This clause specifies how the EASDF shall process DNS messages according to the instructions received from the SMF. + +#### 5.2.3.2 DNS message processing model + +##### 5.2.3.2.1 DNS Context + +The SMF shall control how the EASDF processes DNS messages received for a particular UE's PDU session by creating one single DNS context per PDU session including the following information: + +- the UE IP address, S-NSSAI and DNN of the PDU session; +- the H-PLMN ID for a PDU session supporting HR-SBO in VPLMN; and +- one or more DNS rules. + +There shall be at most one DNS context created in the EASDF with the same UE IP address, S-NSSAI and DNN, and for HR-SBO in VPLMN, in addition with the same H-PLMN ID. If the EASDF receives a request to create a DNS context for which another DNS context already exists with the same UE IP address, S-NSSAI and DNN, and for HR-SBO in VPLMN, in addition with the same H-PLMN ID,, the EASDF shall proceed with creating the DNS context and shall delete the earlier existing DNS context with the same UE IP address, S-NSSAI and DNN, and for HR-SBO in VPLMN, in addition with the same H-PLMN ID. + +As an exception, for HR-SBO in VPLMN, several DNS contexts may be created in the V-EASDF with an unspecified UE IP address and the same S-NSSAI, DNN and H-PLMN ID (see clause 5.2.2.2.1). The V-EASDF shall support creating such DNS contexts without deleting earlier DNS contexts with the same unspecified UE IP address, S-NSSAI, DNN and H-PLMN ID. + +##### 5.2.3.2.2 DNS Rule + +A DNS rule shall apply either to DNS Query messages or DNS Response messages. A DNS rule shall contain: + +- the DNS Rule ID uniquely identifying the DNS rule within the DNS context, for a DNS rule other than a One-Time DNS rule; +- precedence information, indicating the order in which the EASDF shall attempt to match DNS messages against all the DNS rules provisioned in the DNS context, for a DNS rule other than a One-Time DNS rule; +- for a DNS rule provisioned for DNS Query messages: + - for a DNS rule other than a One-Time DNS rule: + - at least one DNS Query Message Detection Template (MDT) or Baseline DNS Query Message Detection Template (BD MDT) ID referring to a BD MDT provisioned in a baseline DNS pattern; such a DNS rule may contain one or more DNS Query MDTs and/or BD MDT IDs referring to BD MDTs provisioned in one or more baseline DNS patterns; or + - for a One-Time DNS rule: + - the DNS message identifier uniquely identifying the DNS message buffered in the EASDF; +- for a DNS rule provisioned for DNS Response messages: + - for a DNS rule other than a One-Time DNS rule: + - at least one DNS Response MDT or Baseline DNS Response MDT ID referring to a BD MDT provisioned in a baseline DNS pattern; a DNS rule may contain one or more DNS Response MDTs and/or BD MDT IDs referring to BD MDTs provisioned in one or more baseline DNS patterns; + - for a One-Time DNS rule: + - the DNS message identifier uniquely identifying the DNS message buffered in the EASDF; +- a list of actions to apply to all DNS messages matching at least one DNS MDT of the DNS rule or one BD MDT referred by the DNS rule. + +See clauses 5.2.3.5 and 5.2.3.2.4 for the description of baseline DNS patterns and One-Time DNS rules respectively. + +Figure 5.2.3.2-1 provides an overview of DNS contexts, DNS rules (other than One-Time DNS rules) and baseline DNS patterns, depicting one DNS context created with N DNS rules, some of them referring to baseline DNS patterns. + +![Figure 5.2.3.2-1: Overview of DNS contexts, DNS rules and Baseline DNS Patterns. The diagram shows two main components: 'DNS context (per PDU session)' and 'Baseline DNS Patterns'. 'DNS context (per PDU session)' points to a list of 'DNS Rule 1', 'DNS Rule 2', 'DNS Rule ...', and 'DNS Rule N'. 'Baseline DNS Patterns' points to a list of 'Baseline DNS Pattern 1', 'Baseline DNS Pattern 2', 'Baseline DNS Pattern ...', and 'Baseline DNS Pattern M'. To the right, two detailed boxes are shown. The top box, 'DNS Rule X (1, 2 ... N)', contains fields for 'DNS Rule ID', 'Precedence', 'DNS MDTs and/or BD MDT IDs (either for DNS Query or Response messages)', and 'List of Actions, optionally with BD AIT IDs'. The bottom box, 'Baseline DNS Pattern Y (1, 2, ..., M)', contains dashed boxes for 'Baseline DNS Query MDT', 'Baseline DNS Response MDT', and 'Baseline DNS AIT'. Arrows indicate that 'DNS Rule X' and 'Baseline DNS Pattern Y' are associated with the 'DNS context' and 'Baseline DNS Patterns' respectively.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +Figure 5.2.3.2-1: Overview of DNS contexts, DNS rules and Baseline DNS Patterns. The diagram shows two main components: 'DNS context (per PDU session)' and 'Baseline DNS Patterns'. 'DNS context (per PDU session)' points to a list of 'DNS Rule 1', 'DNS Rule 2', 'DNS Rule ...', and 'DNS Rule N'. 'Baseline DNS Patterns' points to a list of 'Baseline DNS Pattern 1', 'Baseline DNS Pattern 2', 'Baseline DNS Pattern ...', and 'Baseline DNS Pattern M'. To the right, two detailed boxes are shown. The top box, 'DNS Rule X (1, 2 ... N)', contains fields for 'DNS Rule ID', 'Precedence', 'DNS MDTs and/or BD MDT IDs (either for DNS Query or Response messages)', and 'List of Actions, optionally with BD AIT IDs'. The bottom box, 'Baseline DNS Pattern Y (1, 2, ..., M)', contains dashed boxes for 'Baseline DNS Query MDT', 'Baseline DNS Response MDT', and 'Baseline DNS AIT'. Arrows indicate that 'DNS Rule X' and 'Baseline DNS Pattern Y' are associated with the 'DNS context' and 'Baseline DNS Patterns' respectively. + +**Figure 5.2.3.2-1: Overview of DNS contexts, DNS rules and Baseline DNS Patterns** + +##### 5.2.3.2.3 Processing flow for incoming DNS messages + +Upon receipt of a DNS message, the EASDF shall first identify the DNS context corresponding to the DNS message as follows: + +- for DNS Query message: by using the source IP address of the DNS Query message and by matching it with the UE IP address provisioned in the DNS Query MDTs if any or with the UE IP address provisioned in the DNS context; and +- for a DNS Response message: by matching the DNS response with the DNS Query (either by the EASDF assigning a specific Transaction ID when forwarding the DNS Query message and by matching the Transaction ID in the DNS Query and DNS Response, or by the EASDF using a unique couple of source IP address and UDP port per DNS context when forwarding the DNS Query message and by matching the DNS Response message using the destination IP address and UDP port) and by retrieving the DNS context that is associated with the DNS query. + +NOTE 1: The EASDF has direct user plane connectivity (i.e., without any NAT) with the PSA UPF over N6 for the transmission of DNS signalling exchanged with the UE. The deployment of a NAT between EASDF and PSA UPF is not supported. + +The following options may be used to support DNS contexts with the same (private) UE IP address from different S-NSSAI and DNNs: + +- the EASDF may associate a specific EASDF address with a specific S-NSSAI and DNN and provide this address to the SMF during the creation of a DNS context associated with this S-NSSAI and DNN. If so, the EASDF shall also use the destination IP address of DNS Query messages to identify the DNS context matching an incoming DNS request; +- the SMF may set the UE IP address to a mapped N6 address, when using UE source IP address mapping at the Local PSA-UPF; +- the SMF may provide N6 traffic routing information (in the DNS context information) that may contain the IP address and optional port number of the Local PSA-UPF, for HR-SBO in VPLMN, when using N6 tunneling + +between the L-PSA and V-EASDF. If so, the V-EASDF shall also use the N6 traffic routing information of DNS Query messages to identify the DNS context matching an incoming DNS request. + +To support DNS contexts with the same (private) UE IP address from different PLMNs and from different S-NSSAI and DNNs, the V-EASDF may associate a specific V-EASDF address with a specific HPLMN ID, S-NSSAI and DNN and provide this address to the V-SMF during the creation of a DNS context associated with this HPLMN ID, S-NSSAI and DNN. If so, the V-EASDF shall also use the destination IP address of DNS Query messages to identify the DNS context matching an incoming DNS request. + +A DNS context containing an unspecified UE IP address shall be considered to never match any DNS Query message. + +If there is no DNS context matching a DNS Query or Response message, the EASDF should forward the DNS Query message towards a preconfigured DNS server and the DNS response towards the UE. + +After finding the DNS context, the EASDF shall look up for a DNS rule matching the DNS message, among all DNS rules provisioned in the DNS Context, starting with the DNS rules with the highest precedence and continuing then with DNS rules with a lower precedence, in decreasing order of precedence. If there is no DNS rule matching the DNS message, the EASDF should forward the DNS Query message towards a preconfigured DNS server/resolver for resolution. + +NOTE 2: The SMF can provision in the DNS context a DNS rule with the lowest precedence and with a DNS Query MDT or a DNS Response MDT containing a wildcard FQDN, such as to associate a default behavior to all DNS messages not matching any other DNS rule, e.g. forward DNS Query messages to a specific DNS Server. + +After having found a matching DNS rule, the EASDF shall stop looking up for other DNS rules and shall apply the list of actions provisioned in the matching DNS rule. + +A DNS message matches a DNS rule if it matches at least one MDT of the DNS Rule or one BD MDT referred by the DNS rule. + +The DNS message processing models for DNS Query and DNS Response are depicted in Figure 5.2.3.2-2 and 5.2.3.2-3 respectively. + +![Flowchart of DNS Query processing flow in the EASDF](df1d0e45191302de72176e4390224c16_img.jpg) + +``` +graph LR; A[DNS Query in] --> B["DNS Context look up (find DNS context with matching UE IP@)"]; B --> C["DNS Rule look up (find matching DNS rule with highest precedence)"]; C --> D["DNS Query MDT
DNS Query MDT
..."]; D --> E["Apply List of Actions set in the DNS Rule"]; E --> F[DNS Query out]; +``` + +The diagram illustrates the DNS Query processing flow within the EASDF. It begins with an incoming 'DNS Query in' arrow pointing to a box labeled 'DNS Context look up (find DNS context with matching UE IP@)'. This box points to another labeled 'DNS Rule look up (find matching DNS rule with highest precedence)'. From this second box, an arrow points to a stack of three boxes, each labeled 'DNS Query MDT', with an ellipsis between the second and third. This stack points to a box labeled 'Apply List of Actions set in the DNS Rule'. Finally, an arrow points from this box to 'DNS Query out', which is represented by a dashed line and an arrowhead. + +Flowchart of DNS Query processing flow in the EASDF + +Figure 5.2.3.2-2: DNS Query processing flow in the EASDF + +![Figure 5.2.3.2-3: DNS Response processing flow in the EASDF. The diagram shows a flow starting with 'DNS Response in' entering a box. Inside the box, the flow goes to 'DNS Context look up (derive DNS context from the matching DNS Query)', then to 'DNS Rule look up (find matching DNS rule with highest precedence)'. From the 'DNS Rule look up' block, three arrows point to three separate 'DNS Response MDT' boxes, with an ellipsis between the second and third. All three 'DNS Response MDT' boxes point to a single 'Apply List of Actions set in the DNS Rule' box. Finally, an arrow labeled 'DNS Response out' exits the box.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +graph LR + subgraph EASDF + direction LR + A[DNS Context look up +(derive DNS context from the matching DNS Query)] --> B[DNS Rule look up +(find matching DNS rule with highest precedence)] + B --> C1[DNS Response MDT] + B --> C2[DNS Response MDT] + B --> C3[DNS Response MDT] + C1 --> D[Apply List of Actions set in the DNS Rule] + C2 --> D + C3 --> D + end + In[DNS Response in] --> A + D --> Out[DNS Response out] + +``` + +Figure 5.2.3.2-3: DNS Response processing flow in the EASDF. The diagram shows a flow starting with 'DNS Response in' entering a box. Inside the box, the flow goes to 'DNS Context look up (derive DNS context from the matching DNS Query)', then to 'DNS Rule look up (find matching DNS rule with highest precedence)'. From the 'DNS Rule look up' block, three arrows point to three separate 'DNS Response MDT' boxes, with an ellipsis between the second and third. All three 'DNS Response MDT' boxes point to a single 'Apply List of Actions set in the DNS Rule' box. Finally, an arrow labeled 'DNS Response out' exits the box. + +**Figure 5.2.3.2-3: DNS Response processing flow in the EASDF** + +##### 5.2.3.2.4 Processing of a One-Time DNS Rule applicable to a specific DNS message earlier buffered in the EASDF + +The SMF may instruct the EASDF to apply certain actions (e.g. forward, drop or respond to a DNS message) to a specific DNS message, that has been earlier buffered in the EASDF and reported to the SMF, by creating a new DNS rule in the DNS context that includes: + +- the DNS message identifier uniquely identifying the DNS message within the DNS context, as reported earlier by the EASDF in the DNSContext Notify request; and +- the requested actions to apply to the DNS message. + +Such a DNS rule shall not contain any DNS Rule ID, precedence, MBT nor BD MDT. + +Upon receipt of an DNSContext Update request that creates such a DNS rule, the EASDF shall apply the requested actions to the specific DNS message identified by the DNS message identifier and then delete the DNS Rule. If there is no buffered DNS message corresponding to the DNS message identifier received in the DNS rule, the EASDF shall reject the request with an error. + +NOTE: A DNS rule that includes a DNS message identifier is referred as a "One-Time" DNS rule throughout this specification since the DNS rule is applied only once for the indicated DNS message and the DNS rule is not further stored by the EASDF. + +#### 5.2.3.3 DNS Message Detection Template + +##### 5.2.3.3.1 General + +The contents of a DNS Query MDT or a DNS Response MDT may be provisioned directly in a DNS rule itself or in a BD MDT provisioned in a baseline DNS pattern. In the latter case, a DNS rule may refer to one or more BD MDTs (that are all either DNS Query MDTs or DNS Response MDTs) of one or more baseline DNS patterns by referencing the BD MDT IDs of the BD MDTs of the baseline DNS patterns. + +The following clauses define the contents of DNS Query MDTs and DNS Response MDTs, provisioned in a DNS rule or in a BD MDT. + +##### 5.2.3.3.2 DNS Query MDT + +A DNS Query Message Detection Template may include: + +- a UE IP address; +- a list of FQDN ranges or a wildcard FQDN representing "any FQDN" (see clauses 6.1.6.2.5 and 6.1.6.2.6). + +A UE IP address may only be provisioned in a DNS Query MDT, i.e. it cannot be provisioned in a Baseline DNS MDT. However, a DNS rule may be provisioned with a reference to one or more Baseline DNS Query MDTs together with a UE IP address (see clause 6.1.6.2.20), in which case the referenced Baseline DNS Query MDTs shall be matched for the specific UE IP address. + +When present in a DNS Query MDT, or together with the reference to a Baseline DNS Query MDT, the UE IP address shall be used for matching the DNS Query message with the related DNS rule (see clause 5.2.3.2). Otherwise, the UE IP address provisioned in the DNS context shall be used. + +FQDNs shall be matched against the Query Domain Name of DNS Query messages. + +##### 5.2.3.3.3 DNS Response MDT + +A DNS Response Message Detection Template may include: + +- a list of FQDN ranges or a wildcard FQDN representing "any FQDN"; and/or +- a list of EAS IP addresses ranges. + +FQDNs shall be matched against the Domain Names in the Answers of DNS Response messages. + +EAS IP addresses ranges shall be matched against the IP addresses returned in the Answers of DNS Response messages. + +#### 5.2.3.4 Actions applicable to DNS message + +##### 5.2.3.4.1 General + +Each DNS rule shall be provisioned with the list of actions to apply to all DNS messages matching the DNS rule. + +The SMF may request the EASDF to apply one or more of the following actions: + +- 1) REPORT DNS message content to the SMF. + +The SMF may further request the EASDF to send a report only once to the SMF, i.e. only when a first DNS message matches any MDT of the DNS rule. If so, the EASDF shall skip this action (i.e. report to SMF) for any subsequent DNS message matching the DNS rule. + +The SMF may further request the EASDF to reset the reporting-once indication, in which case the EASDF shall send (only) one more report at the next DNS message that matches the DNS rule. + +- 2) BUFFER DNS message. +- 3) FORWARD DNS message. + +The SMF may further request the EASDF to set the destination IP address of the DNS Query message to a specific DNS Server address. The DNS Server address may either be included in the DNS rule or in a Baseline DNS Action Information Template (BD AIT); in the latter case, the DNS rule shall refer to the corresponding BD AIT ID. If no DNS Server address is provided by the SMF, the EASDF shall forward the DNS message to a locally pre-configured DNS server/resolver. + +The SMF may request the EASDF to build an EDNS Client Subnet (ECS) option to be included in the DNS Query message as defined in IETF RFC 7871 [18], or to be used for replacing the ECS option if an ECS option is received in the DNS Query message from the UE. The information for the EASDF to build the ECS option may either be included in the DNS rule or in a Baseline DNS Action Information Template (BD AIT); in the latter case, the DNS rule shall refer to the corresponding BD AIT ID. + +When forwarding a DNS Query message, if the SMF did not request the EASDF to build an ECS option, the EASDF shall remove the ECS option received from the UE in the DNS Query, if any. + +When forwarding a DNS Response message to the UE, based on configuration, the EASDF shall either remove any received ECS option or, if an ECS option was received in the DNS Query from the UE, replace it with the latter ECS option. + +- 4) DISCARD DNS message. +- 5) RESPOND to DNS Query message. + +If both the SMF and the EASDF support the CEASD feature (see clause 6.1.8), the SMF may instruct the + +EASDF to build a DNS Response message to a DNS Query message and to send it to the UE by setting the applyAction to the value "RESPOND", e.g. when a set of UEs shall use the same EAS (see clause 6.2.3.2.5 of 3GPP TS 23.548 [14]). When requesting so, the SMF shall indicate to the EASDF the EAS IP address(es) that the DNS response shall contain. + +Upon receipt of such a request, the EASDF shall build a DNS Response message to the DNS Query message, that includes the EAS IP address(es) indicated by the SMF and send it to the UE. + +The SMF may change the list of actions associated to a DNS rule (other than a One-Time DNS rule), e.g. to replace the actions to REPORT and BUFFER DNS Query messages to the SMF by the action to FORWARD the DNS messages. In such a case, any earlier buffered DNS message (matching the DNS rule) and any further incoming DNS message shall be processed according to the new instructions received from the SMF, e.g. they shall all be forwarded. The SMF may alternatively request the EASDF to apply certain actions to a specific DNS message by creating a One-Time DNS rule as defined in clause 5.2.3.2.4. + +##### 5.2.3.4.2 Event reporting by EASDF + +The EASDF shall send a report to the SMF: + +- to report the contents of DNS (Query or Response) messages matching a DNS rule provisioned with the action to report the DNS message contents. + +The EASDF shall send reports to the SMF as defined in clause 5.2.2.5. The notification request sent to the SMF may contain one or more reports, for DNS Query and/or DNS Response messages matching one or more DNS rules provisioned in the DNS context. For each report, the EASDF may provide a DNS message identifier uniquely identifying the DNS message reported to the SMF within the DNS context (see clause 5.2.3.2.4). + +#### 5.2.3.5 Baseline DNS Patterns + +##### 5.2.3.5.1 General + +The SMF may create, modify or delete baseline DNS patterns in the EASDF using the Neasdf\_BaselineDnsPattern service (see clause 5.3). + +A baseline DNS pattern contains baseline DNS information that may apply to multiple PDU sessions, e.g. to all PDU sessions with a certain DNN and S-NSSAI. + +A baseline DNS pattern may contain: + +- one or several BD MDTs; and/or +- one or several BD AITs. + +A baseline DNS pattern may contain BD MDTs for DNS Query messages and BD MDTs for DNS Response messages. One BD MDT shall be either a DNS Query MDT or a DNS Response MDT (see clause 5.2.3.3). + +A BD AIT may include: + +- one or more local DNS Server IP address(es); and/or +- ECS option information. + +NOTE 1: Multiple DNS Server IP addresses can be provided for resiliency. + +A BD MDT and a BD AIT shall be uniquely identified in the EASDF by the combination of the following information: + +- the URI of the baseline DNS pattern in which the BD MDT or BD AIT is defined; the URI shall be chosen by the SMF when creating the baseline DNS pattern (see clause 6.2.3); and +- an MDT or AIT identifier (string) uniquely identifying the MDT or AIT within the baseline DNS pattern; this identifier shall be chosen by the SMF when creating the BD MDT or BD AIT. + +The URI of a baseline DNS pattern shall be unique per SMF set, if an SMF set controls the EASDF, or unique per SMF otherwise. + +NOTE 2: The URI of a baseline DNS pattern includes an identifier of the SMF or SMF set (see clause 6.2.3.1) and SMF implementation specific information. This ensures the uniqueness of the URI in the EASDF when several SMFs or SMF sets control the same EASDF. As an example, an SMF can encode the URI of the baseline DNS pattern and the MDT or AIT identifier to include the DNAI or a sequence number. The EASDF is not meant to understand the structure of this information. + +When a BD MDT or BD AIT of a baseline DNS pattern is modified by the SMF, the modified BD MDT or BD AIT shall apply to all DNS rules of all DNS contexts referring to that BD MDT or BD AIT. + +## 5.3 Neasdf\_BaselineDNSPattern Service + +### 5.3.1 Service Description + +The Neasdf\_BaselineDNSPattern service operates on the Baseline DNS patterns in EASDF, which contains the DNS base information that may apply to multiple PDU sessions, e.g. DNS Query and Response MDTs applicable to all PDU sessions with a certain DNN and S-NSSAI. The EASDF is acting as NF Service Producer, while the SMF is the NF Service Consumer. + +Following functionalities are provided by the Neasdf\_BaselineDNSPattern service: + +- Create a Baseline DNS Pattern in EASDF; +- Update the Baseline DNS Pattern in EASDF; +- Delete the Baseline DNS Pattern in EASDF. + +The Neasdf\_BaselineDNSPattern service supports the following service operations. + +**Table 5.3.1-1: Service operations supported by the Neasdf\_BaselineDNSPattern service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|-------------------------------------------|---------------------|---------------------| +| Create | Create a Baseline DNS Pattern in EASDF. | Request/Response | SMF, V-SMF | +| Update | Update the Baseline DNS Pattern in EASDF. | Request/Response | SMF, V-SMF | +| Delete | Delete the Baseline DNS Pattern in EASDF. | Request/Response | SMF, V-SMF | + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +See Table 5.3.1-1 for an overview of the service operations supported by the Neasdf\_BaselineDNSPattern service. + +#### 5.3.2.2 Create + +##### 5.3.2.2.1 General + +The Create service operation shall be used to create the Baseline DNS Pattern in the EASDF. + +It is used in the following procedures: + +- BaselineDNSPattern management in the EASDF procedure (see clause 6.2.3.4.4 of 3GPP TS 23.548 [14]). + +The NF Service Consumer (e.g. SMF) shall create the Baseline DNS Pattern by using the HTTP PUT method as shown in Figure 5.3.2.2.1-1. + +![Sequence diagram for Baseline DNS Pattern creation. The NF Service Consumer sends a PUT request to the EASDF. The EASDF responds with either a 201 Created status (2a) or a 4xx/5xx or 3xx status (2b).](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant EASDF + Note right of NF Service Consumer: 1. PUT ../base-dns-patterns/{smfld}/{smfImplementationSegmentPaths}(BaseDnsPatternCreateData) + NF Service Consumer->>EASDF: Request + EASDF-->>NF Service Consumer: 2a. 201 Created (BaseDnsPatternCreatedData) + EASDF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx- + +``` + +Sequence diagram for Baseline DNS Pattern creation. The NF Service Consumer sends a PUT request to the EASDF. The EASDF responds with either a 201 Created status (2a) or a 4xx/5xx or 3xx status (2b). + +Figure 5.3.2.2.1-1: Baseline DNS Pattern creation + +- The NF Service Consumer shall send a PUT request to create the Baseline DNS Pattern in the EASDF. The content of the PUT request may contain: + - one or more Baseline DNS message detection templates (MDTs); + - one or more Baseline DNS action information templates (AITs). +- On success, a "201 Created" response shall be returned with the "Location" header containing the URI of the created resource. +- On failure, or redirection, one of the HTTP status code listed in Table 6.2.3.2.3.2-3 shall be returned. + +#### 5.3.2.3 Update + +##### 5.3.2.3.1 General + +The Update service operation shall be used to update an individual Baseline DNS Pattern previously created in the EASDF. The update operation may apply to the whole Baseline DNS Pattern (complete replacement of the data of the existing Baseline DNS Pattern by new data), or it may apply to modify a subset of the parameters of the Baseline DNS Pattern. + +It is used in the following procedures: + +- BaselineDNSPattern management in the EASDF procedure (see clause 6.2.3.4.4 of 3GPP TS 23.548 [14]). + +To perform a partial update of the Baseline DNS Pattern, the NF Service Consumer shall issue an HTTP PATCH request, as shown in Figure 5.3.2.3.1-1. This partial update shall be used to add, delete and/or replace individual parameters of the Baseline DNS Pattern. + +![Sequence diagram for Baseline DNS Pattern Partial Update. The NF Service Consumer sends a PATCH request to the EASDF. The EASDF responds with either a 204 No Content (2a), a 200 OK status (2b), or a 4xx/5xx or 3xx status (2c).](35127fe87029df6f5f0b2ee85f6193f1_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant EASDF + Note right of NF Service Consumer: 1. PATCH ../base-dns-patterns/{smfld}/{smfImplementationSegmentPaths}(PatchData) + NF Service Consumer->>EASDF: Request + EASDF-->>NF Service Consumer: 2a. 204 No Content + EASDF-->>NF Service Consumer: 2b. 200 OK (PatchResult) + EASDF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) or 3xx- + +``` + +Sequence diagram for Baseline DNS Pattern Partial Update. The NF Service Consumer sends a PATCH request to the EASDF. The EASDF responds with either a 204 No Content (2a), a 200 OK status (2b), or a 4xx/5xx or 3xx status (2c). + +Figure 5.3.2.3.1-1: Baseline DNS Pattern Partial Update + +- The NF Service Consumer (e.g. SMF) shall send a PATCH request to the resource URI representing the individual Baseline DNS Pattern. The content of the PATCH request shall contain the list of operations (add/delete/replace) to be applied to parameters in the individual Baseline DNS Pattern. +- On success, if all the modification instructions in the PATCH request have been implemented, "204 No Content" shall be returned. + +2b. If some of the modification instructions for unknown attribute(s) in the PATCH request have been ignored, the EASDF shall respond with "200 OK" with the response body containing PatchResult, as specified in clause 5.2.7.2 of 3GPP TS 29.500 [4]. + +2c. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.2.3.1-3 shall be returned. + +To perform a complete replacement of the data of the Baseline DNS Pattern, the NF Service Consumer shall issue an HTTP PUT request, as shown in Figure 5.3.2.3.1-2: + +![Sequence diagram for Baseline DNS Pattern Complete Replacement. The NF Service Consumer sends a PUT request to the EASDF. The EASDF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](5793a44ffdadd039928e2f9fe6daae06_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant EASDF + Note right of NF Service Consumer: 1. PUT.../dns-base-patterns/{smfId}/{smfImplementationSegmentPaths} +(BaseDnsPatternCreateData) + NF Service Consumer->>EASDF: Request + Note left of EASDF: --2a. 204 No Content + EASDF-->>NF Service Consumer: Response + Note left of EASDF: --2b. 4xx/5xx (ProblemDetails) or 3xx + EASDF-->>NF Service Consumer: Response + +``` + +Sequence diagram for Baseline DNS Pattern Complete Replacement. The NF Service Consumer sends a PUT request to the EASDF. The EASDF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +**Figure 5.3.2.3.1-2: Baseline DNS Pattern Complete Replacement** + +1. The NF service consumer (e.g. SMF) shall send a PUT request to the resource URI representing the individual Baseline DNS Pattern. The content of the PUT request shall contain a representation of the individual Baseline DNS Pattern to be completely replaced in the EASDF. + +2a. On success, "204 No Content" shall be returned. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.2.3.2-3 shall be returned. + +#### 5.3.2.4 Delete + +##### 5.3.2.4.1 General + +The Delete service operation shall be used to delete an individual Baseline DNS Pattern previously created in the EASDF. + +It is used in the following procedures: + +- BaselineDNSPattern management in the EASDF procedure (see clause 6.2.3.4.4 of 3GPP TS 23.548 [14]). + +To perform a deletion of the Baseline DNS Pattern, the NF Service Consumer shall issue an HTTP DELETE request, as shown in Figure 5.3.2.4.1-1. + +![Sequence diagram for Baseline DNS Pattern Deletion. The NF Service Consumer sends a DELETE request to the EASDF. The EASDF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](6efcea66501271e9ea36cf33982f08d5_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant EASDF + Note right of NF Service Consumer: 1. DELETE ../base-dns-patterns/{smfId}/{smfImplementationSegmentPaths} + NF Service Consumer->>EASDF: Request + Note left of EASDF: --2a. 204 No Content + EASDF-->>NF Service Consumer: Response + Note left of EASDF: --2b. 4xx/5xx (ProblemDetails) or 3xx + EASDF-->>NF Service Consumer: Response + +``` + +Sequence diagram for Baseline DNS Pattern Deletion. The NF Service Consumer sends a DELETE request to the EASDF. The EASDF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +**Figure 5.3.2.4.1-1: Baseline DNS Pattern Deletion** + +1. The NF Service Consumer (e.g. SMF) shall send a DELETE request to delete the individual Baseline DNS Pattern. The request body shall be empty. + +2a. On success, "204 No Content" shall be returned. The response body shall be empty. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.2.3.3-3 shall be returned. + +# --- 6 API Definitions + +## 6.1 Neasdf\_DNSContext Service API + +### 6.1.1 Introduction + +The Neasdf\_DNSContext shall use the Neasdf\_DNSContext API. + +The API URI of the Neasdf\_DNSContext API shall be: + +**{apiRoot}
** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "neasdf-dnscontext". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Neasdf\_DNSContext API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". +- "Problem Details" JSON Object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]; +- JSON Patch (IETF RFC 6902 [15]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. In this release of this specification, no custom headers specific to the Neasdf\_DNSContext service are defined. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +Figure 6.1.3.1-1 describes the resource URI structure of the Neasdf\_DNSContext API. + +![Diagram showing the resource URI structure of the Neasdf_DNSContext API. The root path is //{apiRoot}/neasdf-dnscontext/. A callout box points to the /dns-contexts path, and another callout box points to the/{dnsContextId} path.](19a5f0db57a21a0e82a7f326083e96fd_img.jpg) + +``` + + graph TD + Root[" //{apiRoot}/neasdf-dnscontext/"] --> DNSContexts["/dns-contexts"] + DNSContexts --> DNSContextId["/{dnsContextId}"] + +``` + +Diagram showing the resource URI structure of the Neasdf\_DNSContext API. The root path is //{apiRoot}/neasdf-dnscontext/. A callout box points to the /dns-contexts path, and another callout box points to the/{dnsContextId} path. + +**Figure 6.1.3.1-1: Resource URI structure of the Neasdf\_DNSContext API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description (service operation) | +|-------------------------|------------------------------|-------------|---------------------------------| +| DNS contexts collection | /dns-contexts | POST | Create | +| Individual DNS context | /dns-contexts/{dnsContextId} | PATCH | Update (partial update) | +| | | PUT | Update (complete replacement) | +| | | DELETE | Delete | + +#### 6.1.3.2 Resource: DNS contexts collection + +##### 6.1.3.2.1 Description + +This resource represents the collection of the individual DNS contexts created in the EASDF. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/neasdf-dnscontext//dns-contexts + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method creates an individual DNS context resource in the EASDF. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|--------------------------------------------------------------| +| DnsContextCreatedData | M | 1 | Representation of the DNS context to be created in the EASDF | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DnsContextCreatedData | M | 1 | 201 Created | Successful creation of a DNS context | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | The "cause" attribute may be set to one of the following application errors:
- BASELINE_DNS_PATTERN_UNKNOWN
- BASELINE_DNS_MDT_UNKNOWN
- BASELINE_DNS_AIT_UNKNOWN | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.1-4: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/neasdf-dnscontext//dns-contexts/{dnsContextId} | + +**Table 6.1.3.2.3.1-5: Headers supported by the 307 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-6: Headers supported by the 308 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +##### 6.1.3.2.4 Resource Custom Operations + +None. + +#### 6.1.3.3 Resource: Individual DNS context + +##### 6.1.3.3.1 Description + +This resource represents an individual DNS context created in the EASDF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/neasdf-dnscontext/{apiVersion}/dns-contexts/{dnsContextId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|-----------|-----------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1. | +| apiVersion | string | See clause 6.1.1. | +| dnsContextId | string | DNS context Identifier assigned by the EASDF during the Create service operation. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 DELETE + +This method deletes an individual DNS context resource in the EASDF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful deletion of the DNS context. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates that the deletion of the DNS context failed due to an application error.

The "cause" attribute may be used to indicate one of the following application errors:
- DNS_CONTEXT_NOT_FOUND. | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +###### 6.1.3.3.3.2 PATCH + +This method updates (partial update) an individual DNS context resource in the EASDF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | It contains the list of changes to be made to the DNS context, according to the JSON PATCH format specified in IETF RFC 6902 [15]. | + +**Table 6.1.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PatchResult | M | 1 | 200 OK | Upon partial success, e.g. some of the requested modifications for unknown attribute(s) are discarded while the rest of the modification instructions are fully accepted, the EASDF shall return the execution report. | +| n/a | | | 204 No Content | Successful update of the DNS context. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates that the modification of the DNS context failed due to an application error.

The "cause" attribute may be used to indicate one of the following application errors:
- DNS CONTEXT NOT FOUND. | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +###### 6.1.3.3.3.3 PUT + +This method updates (complete replacement) an individual DNS context resource in the EASDF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.3-1. + +**Table 6.1.3.3.3.3-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.3-2 and the response data structures and response codes specified in table 6.1.3.3.3.3-3. + +**Table 6.1.3.3.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------| +| DnsContextCreateData | M | 1 | DNS Context Data to replace the existing DNS context data | + +**Table 6.1.3.3.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------| +| n/a | | | 204 No Content | Successful update of the DNS context. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +##### 6.1.3.3.4 Resource Custom Operations + +There are no resource custom operations for the Neasdf\_DNSContext service in this release of the specification. + +### 6.1.4 Custom Operations without associated resources + +There are no custom operations defined without any associated resources for the Neasdf\_DNSContext service in this release of this specification. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +This clause specifies the notifications supported by the Neasdf\_DNSContext service. + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------|-------------------------------------------------------------------|---------------------------------|---------------------------------| +| DNS Context Notification | {notifyUri}
(Notification URI provided by NF Service Consumer) | POST | DNS Context Notify | + +#### 6.1.5.2 DNS Context Notify + +##### 6.1.5.2.1 Description + +The Event Notification is used by the EASDF to report one or several observed Events to a NF service consumer (e.g. SMF) that has subscribed to such Notifications. + +##### 6.1.5.2.2 Target URI + +The Callback URI "{notifyUri}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables** + +| Name | Definition | +|-----------|-----------------------------------------------| +| notifyUri | String formatted as URI with the Callback Uri | + +##### 6.1.5.2.3 Standard Methods + +###### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-1. + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|------------------------------------------------| +| DnsContextNotification | M | 1 | Representation of the DNS context notification | + +**Table 6.1.5.2.3.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful notification of the DNS context change | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates that the notification for the DNS context failed due to an application error.

The "cause" attribute may be used to indicate one of the following application errors:
- DNS_CONTEXT_NOT_FOUND. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +**Table 6.1.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance. For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Neasdf\_DNSContext service based interface protocol. + +**Table 6.1.6.1-1: Neasdf\_DNSContext specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|-----------------------------------------------------------------------|---------------| +| DnsContextCreateData | 6.1.6.2.2 | Data in DNS Context Create request | | +| DnsContextCreatedData | 6.1.6.2.3 | Data in DNS Context Create response | | +| DnsRule | 6.1.6.2.4 | DNS handling rule | | +| DnsQueryMdt | 6.1.6.2.5 | DNS Query Message Detection Template | | +| DnsRspMdt | 6.1.6.2.6 | DNS Response Message Detection Template | | +| Ipv4AddressRange | 6.1.6.2.7 | IPv4 addresses range | | +| Ipv6PrefixRange | 6.1.6.2.8 | IPv6 addresses range | | +| Action | 6.1.6.2.9 | Action to apply to DNS messages matching a message detection template | | +| DnsContextNotification | 6.1.6.2.10 | DNS context notification | | +| ForwardingParameters | 6.1.6.2.11 | Forwarding instructions | | +| EcsOption | 6.1.6.2.12 | ECS Option information | | +| DnsContextEventReport | 6.1.6.2.13 | DNS context Event report | | +| DnsQueryReport | 6.1.6.2.14 | DNS Query Event Report | | +| DnsRspReport | 6.1.6.2.15 | DNS Response Event Report | | +| EcsOptionInfo | 6.1.6.2.16 | ECS option information | | +| DnsServerAddressInfo | 6.1.6.2.17 | DNS Server address information | | +| BaselineDnsMdtId | 6.1.6.2.18 | Baseline DNS Message Detection Template Identifier | | +| BaselineDnsAitId | 6.1.6.2.19 | Baseline DNS Action Information Template Identifier | | +| BaselineDnsQueryMdtInfo | 6.1.6.2.20 | Baseline DNS Query MDT ID and optionally associated information | | +| BaselineDnsRspMdtInfo | 6.1.6.2.21 | Baseline DNS Response MDT ID and optionally associated information | | +| RespondParameters | 6.1.6.2.22 | Instructions to apply to build a DNS response message | | +| N6RoutingInfo | 6.1.6.2.23 | N6 traffic routing information | | +| ApplyAction | 6.1.6.3.3 | Action to apply to the DNS packet | | + +Table 6.1.6.1-2 specifies data types re-used by the Neasdf service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Neasdf\_DNSContext service based interface. + +**Table 6.1.6.1-2: Neasdf\_DNSContext re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------------|---------------------|----------------------------|---------------| +| IPv4Addr | 3GPP TS 29.571 [16] | IPv4 address | | +| IPv6Prefix | 3GPP TS 29.571 [16] | IPv6 prefix | | +| Dnn | 3GPP TS 29.571 [16] | DNN | | +| Uri | 3GPP TS 29.571 [16] | URI | | +| Uint32 | 3GPP TS 29.571 [16] | Unsigned 32-bit integer | | +| IpAddr | 3GPP TS 29.571 [16] | IP address | | +| IPv6Addr | 3GPP TS 29.571 [16] | IPv6 address | | +| SupportedFeatures | 3GPP TS 29.571 [16] | Supported features | | +| DateTime | 3GPP TS 29.571 [16] | Date and time | | +| PatchResult | 3GPP TS 29.571 [16] | | | +| FqdnPatternMatchingRule | 3GPP TS 29.571 [16] | FQDN Pattern Matching Rule | | +| Fqdn | 3GPP TS 29.571 [16] | | | +| Snsai | 3GPP TS 29.571 [16] | | | +| PlmnId | 3GPP TS 29.571 [16] | PLMN Identity | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: DnsContextCreateData + +Table 6.1.6.2.2-1: Definition of type DnsContextCreateData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uelpv4Addr | Ipv4Addr | C | 0..1 | UE IPv4 address (NOTE 1) | | +| uelpv6Prefix | Ipv6Prefix | C | 0..1 | UE IPv6 prefix (NOTE 1) | | +| dnn | Dnn | M | 1 | DNN of the PDU session (NOTE 2) | | +| sNssai | Snssai | M | 1 | S-NSSAI of the PDU session (NOTE 2) | | +| hplmnId | PlmnId | C | 0..1 | This IE shall be included by the V-SMF towards the V-EASDF, for a PDU session supporting HR-SBO. When present, it shall be set to the H-PLMN ID of the PDU session. | HR-SBO | +| n6RoutingInfo | N6RoutingInfo | O | 0..1 | This IE may be present when using N6 tunneling between the L-PSA and V-EASDF, to disambiguate the DNS traffic using a private UE IP address from a certain HPLMN using a specific L-PSA UPF IP address and optional port number of the N6 tunnel between the Local PSA-UPF and V-EASDF | HR-SBO | +| dnsRules | map(DnsRule) | M | 1..N | Map of DNS message handling rules. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], with a maximum of 32 characters. | | +| notifyUri | Uri | C | 0..1 | Callback URI to receive notifications. This IE shall be present if the NF service consumer subscribes to receive DNS context notifications. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +NOTE 1: At least one of the uelpv4Addr and uelpv6Prefix attributes shall be present. If the EASDF supports the HR-SBO feature (i.e. if it supports acting as a V-EASDF), for a PDU session supporting HR-SBO, the V-SMF shall set the uelpv4Addr IE and/or uelpv6Prefix to an unspecified address (see clause 5.2.2.2.1) if the UE IP address is not yet known. + +NOTE 2: The UE IP address shall be used together with the DNN and S-NSSAI to uniquely identify the DNS context associated with a PDU session (e.g. in deployments where the same EASDF is used for PDU sessions to DNs with overlapping IP address spaces) and to associate the DNS context with a specific DN (and e.g. related tunnels connecting to the DN). + +##### 6.1.6.2.3 Type: DnsContextCreatedData + +Table 6.1.6.2.3-1: Definition of type DnsContextCreatedData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------------------------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| easedfpv4Addr | IPv4Addr | C | 0..1 | EASDF IPv4 address | | +| easedfpv6Addr | IPv6Addr | C | 0..1 | EASDF IPv6 address | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | +| NOTE: At least one of the easedfpv4Addr and easedfpv6Addr attributes shall be present. | | | | | | + +##### 6.1.6.2.4 Type: DnsRule + +**Table 6.1.6.2.4-1: Definition of type DnsRule** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dnsRuleId | string | C | 0..1 | Unique Identifier of the DNS rule within the DNS context

This IE shall be present for a DNS rule other than a One-Time DNS rule. | | +| label | string | O | 0..1 | DNS rule's label
(NOTE 5) | | +| precedence | Uint32 | C | 0..1 | Precedence of the DNS message handling rule.

This IE shall be present for a DNS rule other than a One-Time DNS rule.

The lower precedence values indicate higher precedence of the DNS rule, and the higher precedence values indicate lower precedence of the DNS rule when matching a DNS message. | | +| dnsQueryMdtList | map(DnsQueryMdt) | C | 1..N | Map of DNS Query message detection templates.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], with a maximum of 32 characters.
(NOTE 3) | | +| baseDnsQueryMdtList | array(BaselineDnsQueryMdtInfo) | C | 1..N | List of Baseline DNS Query Message Detection Template IDs and optionally associated information.
(NOTE 3) | | +| dnsRspMdtList | map(DnsRspMdt) | C | 1..N | Map of DNS Response message detection templates.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], with a maximum of 32 characters.
(NOTE 4) | | +| baseDnsRspMdtList | array(BaselineDnsRspMdtInfo) | C | 1..N | List of Baseline DNS Response Message Detection Template IDs and optionally associated information.
(NOTE 4) | | +| dnsMsgId | string | C | 0..1 | DNS message identifier

This IE shall be present for a One-Time DNS Rule and it shall be set to the identifier of the DNS message buffered in the EASDF for which the DNS rule shall apply (see clause 5.2.3.2.4).

(NOTE 6) | | +| actionList | map(Action) | M | 1..N | Map of Actions to apply to DNS messages matching the DNS message detection templates.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], with a maximum of 32 characters. | | + +NOTE 1: A DNS rule shall be provisioned either for DNS Query messages or for DNS Response messages. + +NOTE 2: A DNS rule including the dnsMsgId IE shall be considered as a One-Time DNS Rule (see clause 5.2.3.2.4). + +NOTE 3: For a DNS rule other than a One-Time DNS rule provisioned for DNS Query messages, at least one of the dnsQueryMdtList and baseDnsQueryMdtList IEs shall be present. + +NOTE 4: For a DNS Rule other than a One-Time DNS rule provisioned for DNS Response messages, at least one of the dnsRspMdtList and baseDnsRspMdtList IEs shall be present. + +NOTE 5: This attribute may contain free information describing the scope of the DNS rule. It may be used e.g. for trouble-shooting. + +NOTE 6: An EASDF can encode the DNS message identifier as the ID field in the header of the DNS message, or as any other string uniquely identifying the DNS message within the DNS context. + +##### 6.1.6.2.5 Type: DnsQueryMdt + +Table 6.1.6.2.5-1: Definition of type DnsQueryMdt + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mdtId | string | M | 1 | Identifier of the DNS Query message detection template, with a maximum of 32 characters. | | +| label | string | O | 0..1 | DNS Query MDT's label (NOTE 2) | | +| sourceIpv4Addr | Ipv4Addr | O | 0..1 | UE IPv4 address (NOTE 1) | | +| sourceIpv6Prefix | Ipv6Prefix | O | 0..1 | UE IPv6 prefix (NOTE 1) | | +| fqdnPatternList | array(FqdnPatternMatchingRule) | O | 1..N | List of FQDN patterns, where each FQDN pattern is described by a FQDN Pattern Matching Rule.

An FQDN value is considered part of the template if and only if the FQDN in the Queries field in the DNS Query message fully matches at least one FQDN pattern. (NOTE 3) | | + +NOTE 1: If neither the sourceIpv4Addr IE nor the sourceIpv6Prefix IE is present, the UE IP address in the DNS Context Data shall be assumed. + +NOTE 2: This attribute may contain free information describing the scope of the DNS Query MDT. It may be used e.g. for trouble-shooting. + +NOTE 3: The list of FQDN patterns may encode some FQDN patterns with a string matching rule and others with a regular expression (when the FQDN patterns cannot be described by a string matching rule). + +##### 6.1.6.2.6 Type: DnsRspMdt + +Table 6.1.6.2.6-1: Definition of type DnsRspMdt + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|--------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mdtId | string | M | 1 | Identifier of the DNS Response message detection template, with a maximum of 32 characters. | | +| label | string | O | 0..1 | DNS Response MDT's label (NOTE 1) | | +| fqdnPatternList | array(FqdnPatternMatchingRule) | O | 1..N | List of FQDN patterns, where each FQDN pattern is described by a FQDN Pattern Matching Rule.

An FQDN value is considered part of the template if and only if the FQDN in the Queries field in the DNS Response message fully matches at least one FQDN pattern. (NOTE 2) | | +| easIpv4AddrRanges | array(Ipv4AddressRange) | O | 1..N | List of EAS IPv4 addresses ranges | | +| easIpv6PrefixRanges | array(Ipv6PrefixRange) | O | 1..N | List of EAS IPv6 prefixes ranges | | + +NOTE 1: This attribute may contain free information describing the scope of the DNS Response MDT. It may be used e.g. for trouble-shooting. + +NOTE 2: The list of FQDN patterns may encode some FQDN patterns with a string matching rule and others with a regular expression (when the FQDN patterns cannot be described by a string matching rule). + +6.1.6.2.7 Type: Ipv4AddressRange + +**Table 6.1.6.2.7-1: Definition of type IPv4AddressRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------| +| start | Ipv4Addr | M | 1 | First value identifying the start of an IPv4 address range | +| end | Ipv4Addr | M | 1 | Last value identifying the end of an IPv4 address range | + +6.1.6.2.8 Type: Ipv6PrefixRange + +**Table 6.1.6.2.8-1: Definition of type IPv6PrefixRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|-----------------------------------------------------------| +| start | Ipv6Prefix | M | 1 | First value identifying the start of an IPv6 prefix range | +| end | Ipv6Prefix | M | 1 | Last value identifying the end of an IPv6 prefix range | + +6.1.6.2.9 Type: Action + +**Table 6.1.6.2.9-1: Definition of type Action** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| applyAction | ApplyAction | M | 1 | Action to apply to the DNS message | | +| fwdParas | ForwardingParameters | O | 0..1 | This IE may be present if the applyAction IE is set to " FORWARD".
When present, it shall contain forward instructions to apply to the DNS message before forwarding it. | | +| reportingOnceInd | boolean | O | 0..1 | Reporting-once Indication
This IE may be present if the applyAction is set to "REPORT".
When present, it shall be set as follows:
- true: only one report shall be sent to the SMF, i.e. one report shall only be sent when a first DNS message matches any Message Detection Template of the DNS rule.

- false (default): a report shall be sent to the SMF for any DNS message matching any Message Detection Template of the DNS rule. | | +| resetReportingOnceInd | boolean | O | 0..1 | Reset the Reporting-once Indication
This IE may be present in a request modifying a DNS rule, if the applyAction is set to "REPORT" and the reportingOnceInd is set to "true".
When present, it shall be set as follows:
- true: reset the Reporting-once Indication, i.e. send (only) one more report to the SMF when a next first DNS message matches any Message Detection Template of the DNS rule.

- false (default): do not reset the Reporting-once Indication | | +| respParas | RespondParameters | C | 0..1 | This IE shall be present if the applyAction IE is set to " RESPOND".
When present, it shall contain instructions to apply to build the DNS response message. | CEASD | + +##### 6.1.6.2.10 Type: DnsContextNotification + +Table 6.1.6.2.10-1: Definition of type DnsContextNotification + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|------------------------------|---|-------------|-----------------------| +| eventreportList | array(DnsContextEventReport) | O | 1..N | List of event reports | + +##### 6.1.6.2.11 Type: ForwardingParameters + +Table 6.1.6.2.11-1: Definition of type ForwardingParameters + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ecsOptionInfo | EcsOptionInfo | O | 0..1 | Information to build optional EDNS Client Subnet (ECS) option to be included in the DNS Query as defined in IETF RFC 7871 [18], or to be used for replacing the ECS option received in the DNS Query message from the UE. | +| dnsServerAddressInfo | DnsServerAddressInfo | O | 0..1 | DNS Server Address Information to be used as destination address of the outgoing DNS Query | + +##### 6.1.6.2.12 Type: EcsOption + +Table 6.1.6.2.12-1: Definition of type EcsOption + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sourcePrefixLength | integer | M | 1 | Leftmost number of significant bits of the IP address as defined for the SOURCE PREFIX-LENGTH in clause 6 of IETF RFC 7871 [18].
Minimum=0. Maximum=128 | +| scopePrefixLength | integer | O | 0..1 | Leftmost number of bits of the IP address that the DNS response covers as defined for the SCOPE PREFIX-LENGTH in clause 6 of IETF RFC 7871 [18]. This attribute shall only be sent in EASDF notification to the SMF.
Minimum=0. Maximum=128 | +| ipAddr | IpAddr | M | 1 | IP address as defined for the ADDRESS in clause 6 of IETF RFC 7871 [18] | + +##### 6.1.6.2.13 Type: DnsContextEventReport + +Table 6.1.6.2.13-1: Definition of type DnsContextEventReport + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| timestamp | DateTime | M | 1 | Time of detection of the event | +| dnsRuleId | Uint32 | C | 0..1 | Identifies the DNS rule that triggered the report. This IE shall be present if the report is triggered by an event matching a DNS rule. | +| dnsQueryReport | DnsQueryReport | O | 0..1 | DNS Query Report | +| dnsRspReport | DnsRspReport | O | 0..1 | DNS Response Report | +| dnsMsgId | string | O | 0..1 | DNS message identifier
When present, this IE shall be set to a unique identifier of the DNS message for which the event is reported (see clause 5.2.3.2.4) | + +6.1.6.2.14 Type: DnsQueryReport + +**Table 6.1.6.2.14-1: Definition of type DnsQueryReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------| +| fqdn | Fqdn | O | 0..1 | FQDN received in the DNS Query | + +6.1.6.2.15 Type: DnsRspReport + +**Table 6.1.6.2.15-1: Definition of type DnsRspReport** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------------|---|-------------|-------------------------------------------------------------------------------------------------| +| fqdn | Fqdn | O | 0..1 | FQDN received in the DNS Response | +| easIpv4Addresses | array(Ipv4Addr) | O | 1..N | EAS IPv4 address(es) received in the DNS Response | +| easIpv6Addresses | array(Ipv6Addr) | O | 1..N | EAS IPv6 address(es) received in the DNS Response | +| ecsOption | EcsOption | O | 0..1 | EDNS Client Subnet (ECS) option received in the DNS Response (as defined in IETF RFC 7871 [18]) | + +6.1.6.2.16 Type: EcsOptionInfo + +**Table 6.1.6.2.16-1: Definition of type EcsOptionInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ecsOption | EcsOption | C | 0..1 | Information to build optional EDNS Client Subnet (ECS) option to be included in the DNS Query as defined in IETF RFC 7871 [18], or to be used for replacing the ECS option received in the DNS Query message from the UE. (NOTE 1) | +| baseDnsAitId | BaselineDnsAitId | C | 0..1 | Identifier of the Baseline DNS Action Information Template that contains information to build optional EDNS Client Subnet (ECS) option to be included in the DNS Query as defined in IETF RFC 7871 [18], or to be used for replacing the ECS option received in the DNS Query message from the UE. (NOTE 1, NOTE 2) | + +NOTE 1: Either the ecsOption IE or the baseDnsAitId IE shall be present. +NOTE 2: The referenced baseline DNS Action Information Template may contain other information beyond the information to build the ECS option, in which case the EADSF shall only apply the information to build the ECS option. + +6.1.6.2.17 Type: DnsServerAddressInfo + +**Table 6.1.6.2.17-1: Definition of type DnsServerAddressInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnsServerAddressList | array(IpAddr) | C | 1..N | DNS Server Address to be used as destination address of the outgoing DNS Query. More than one IP address may be provided for resiliency. (NOTE 1) | +| baseDnsAitId | BaselineDnsAitId | C | 0..1 | Identifier of the Baseline DNS Action Information Template that contains DNS Server Address to be used as destination address of the outgoing DNS Query. (NOTE 1, NOTE 2) | + +NOTE 1: Either the dnsServerAddressList IE or the baseDnsAitId IE shall be present. +NOTE 2: The referenced baseline DNS Action Information Template may contain other information beyond the DNS Server Address information, in which case the EADSF shall only apply the DNS Server Address information. + +6.1.6.2.18 Type: BaselineDnsMdtld + +**Table 6.1.6.2.18-1: Definition of type BaselineDnsMdtld** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------|---------------| +| baseDnsPatternUri | Uri | M | 1 | URI of the baseline DNS pattern returned in the Location header in the baseline DNS pattern creation response | | +| mdtld | string | M | 1 | Identifier of the baseline DNS Message Detection Template ID within the baseline DNS pattern | | + +6.1.6.2.19 Type: BaselineDnsAitld + +**Table 6.1.6.2.19-1: Definition of type BaselineDnsAitld** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------|---------------| +| baseDnsPatternUri | Uri | M | 1 | URI of the baseline DNS pattern returned in the Location header in the baseline DNS pattern creation response | | +| aitld | string | M | 1 | Identifier of the baseline DNS Action Information Template ID within the baseline DNS pattern | | + +6.1.6.2.20 Type: BaselineDnsQueryMdtlInfo + +**Table 6.1.6.2.20-1: Definition of type BaselineDnsQueryMdtlInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------------|---|-------------|------------------------------------------------------------|---------------| +| sourceIpv4Addr | Ipv4Addr | O | 0..1 | UE IPv4 address (NOTE) | | +| sourceIpv6Prefix | Ipv6Prefix | O | 0..1 | UE IPv6 prefix (NOTE) | | +| baseDnsMdtlList | array(BaselineDnsMdtld) | M | 1..N | List of Baseline DNS Query Message Detection Template IDs. | | + +NOTE: If neither the sourceIpv4Addr IE nor the sourceIpv6Prefix IE is present, the UE IP address in the DNS Context Data shall be assumed. + +6.1.6.2.21 Type: BaselineDnsRspMdtlInfo + +**Table 6.1.6.2.21-1: Definition of type BaselineDnsRspMdtlInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------|---|-------------|---------------------------------------------------------------|---------------| +| baseDnsMdtlList | array(BaselineDnsMdtld) | M | 1..N | List of Baseline DNS Response Message Detection Template IDs. | | + +6.1.6.2.22 Type: RespondParameters + +**Table 6.1.6.2.22-1: Definition of type RespondParameters** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------|---|-------------|---------------------------------------------------------|---------------| +| easIpv4Addresses | array(Ipv4Addr) | O | 1..N | EAS IPv4 address(es) to be included in the DNS Response | | +| easIpv6Addresses | array(Ipv6Addr) | O | 1..N | EAS IPv6 address(es) to be included in the DNS Response | | + +##### 6.1.6.2.23 Type: N6RoutingInfo + +**Table 6.1.6.2.23-1: Definition of type N6RoutingInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------| +| ipv4Address | Ipv4Addr | O | 0..1 | IPv4 address of the Local PSA-UPF for the N6 tunnel between the Local PSA-UPF and V-EASDF | +| ipv6Address | Ipv6Addr | O | 0..1 | IPv6 address of the Local PSA-UPF for the N6 tunnel between the Local PSA-UPF and V-EASDF | +| portNumber | UInteger | O | 0..1 | Port number of the Local PSA-UPF for the N6 tunnel between the Local PSA-UPF and V-EASDF. | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|------------------------------------------------------------------|-------------|---------------| +| | | | | + +##### 6.1.6.3.3 Enumeration: ApplyAction + +The enumeration ApplyAction represents an action to apply to the DNS packet. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration ApplyAction** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "BUFFER" | Buffer the DNS Query or Response message | | +| "REPORT" | Report the DNS Query or Response message content to the SMF | | +| "FORWARD" | Forward the DNS Query or Response message, after applying the instructions indicated in the forwarding parameters if any | | +| "DISCARD" | Discard DNS messages | | +| "RESPOND" | Respond to a DNS Query message, i.e. build and send a DNS Response message to the UE, after applying the instructions indicated in the respond parameters. | CEASD | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There is no alternative data types or combinations of data types used for the Neasdf\_DNSContext service in this version of the API. + +#### 6.1.6.5 Binary data + +There is no binary data used for the Neasdf\_DNSContext service in this version of the API. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Neasdf\_DNSContext API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Neasdf\_DNSContext API. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. No further specific procedures for the Neasdf\_DNSContext service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Neasdf\_DNSContext service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BASELINE_DNS_PATTERN_UNKNOWN | 400 Bad Request | The request to create or modify a DNS context is rejected due to a baseline DNS pattern being unknown to the EASDF (i.e the URI of the baseline DNS pattern is unknown). | +| BASELINE_DNS_MDT_UNKNOWN | 400 Bad Request | The request to create or modify a DNS context is rejected due to a baseline DNS Message Detection Template being unknown to the EASDF (the baseline DNS pattern is known). | +| BASELINE_DNS_AIT_UNKNOWN | 400 Bad Request | The request to create or modify a DNS context is rejected due to a baseline DNS Action Information Template being unknown to the EASDF (the baseline DNS pattern is known). | +| DNS_CONTEXT_NOT_FOUND | 404 Not Found | The request to modify or delete a DNS context, or the notification about an event of a DNS context, is rejected because the DNS context is not found. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Neasdf\_DNSContext API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +Table 6.1.8-1: Supported Features + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | CEASD | O |

Support of Common EAS Discovery for a set of UEs defined as part of EDGE Phase 2 in 3GPP Release 18.

An NF Service Consumer and EASDF which support this feature shall support DNS rules with an applyAction requesting the EASDF to respond to a DNS query with EAS IP addresses provided by the NF Service Consumer, i.e. with the ApplyAction value "RESPOND". See clauses 5.2.3.4.1 and 6.1.6.3.3.

| +| 2 | HR-SBO | O |

Support of EAS Discovery Procedure with V-EASDF for HR-SBO

An EASDF which supports this feature shall support behaving as a V-EASDF including support of:

  • - DNS context creation with an unspecified UE IP address and DNS context update with the UE IP address assigned by the H-PLMN; and
  • - DNS context creation and handling with the H-PLMN ID of the H-PLMN of the HR PDU session.
| + +Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1). +Feature: A short name that can be used to refer to the bit and to the feature. +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Neasdf\_DNSContext API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Neasdf\_DNSContext API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Neasdf\_DNSContext service. + +The Neasdf\_DNSContext API defines a single scope "neasdf-dnscontext" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different EASDF service instance within the same EASDF, or to a different EASDF of an EASDF set, when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different EASDF producer instance will return the NF Instance ID of the new EASDF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an EASDF redirects a service request to a different EASDF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new EASDF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Neasdf\_BaselineDNSPattern Service API + +### 6.2.1 Introduction + +The Neasdf\_BaselineDNSPattern service shall use the Neasdf\_BaselineDNSPattern API. + +The API URI of the Neasdf\_BaselineDNSPattern API shall be: + +**{apiRoot}
** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "neasdf-baselinednspattern". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Neasdf\_BaselineDNSPattern API is contained in Annex A. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". +- "Problem Details" JSON Object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. +- JSON Patch (IETF RFC 6902 [15]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". + +#### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +Figure 6.2.3.1-1 describes the resource URI structure of the Neasdf\_BaselineDNSPattern API. + +![Figure 6.2.3.1-1: Resource URI structure of the Neasdf_BaselineDNSPattern API. The diagram shows a hierarchical tree structure starting with ///neasdf-baselinednspattern/. It branches to /base-dns-patterns, which then branches to /, which finally branches to /.](1e8c50ad4fca7f315a407347dd5091cc_img.jpg) + +``` + + ///neasdf-baselinednspattern/ + | + +-- /base-dns-patterns + | + +-- / + | + +-- / + +``` + +Figure 6.2.3.1-1: Resource URI structure of the Neasdf\_BaselineDNSPattern API. The diagram shows a hierarchical tree structure starting with ///neasdf-baselinednspattern/. It branches to /base-dns-patterns, which then branches to /, which finally branches to /. + +**Figure 6.2.3.1-1: Resource URI structure of the Neasdf\_BaselineDNSPattern API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description (service operation) | +|---------------------------------|------------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------| +| Individual Baseline DNS Pattern | /base-dns-patterns// | PUT | Create a new Baseline DNS pattern, or replace the existing Baseline DNS pattern, by providing an Baseline DNS pattern | +| | | PATCH | Update (partial update) | +| | | DELETE | Delete | + +#### 6.2.3.2 Resource: Individual Baseline DNS Pattern + +##### 6.2.3.2.1 Description + +This resource represents an individual Baseline DNS Pattern created in the EASDF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/neasdf-baselinednspattern//base-dns-patterns// + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1. | +| apiVersion | string | See clause 6.2.1. | +| smfId | VarNfId |

Represents the SMF Set Identifier (see NF Set Identifier in clause 28.12 of 3GPP TS 23.003 [19]) or the Set ID part within the SMF Set Identifier (see <Set Id> within the NF Set Identifier in clause 28.12 of 3GPP TS 23.003 [19]) or NF Instance Id of the SMF.

The SMF Set Identifier or the Set ID part within the SMF Set ID shall be included if the EASDF is controlled by the SMF set, or the NF Instance Id of the SMF shall be included if the EASDF is controlled by a SMF.

| + +EXAMPLE 1: .../base-dns-patterns/smfInstanceId=4947a69a-f61b-4bc1-b9da-47c9c5d14b64/{smfImplementationSegmentPaths} + +EXAMPLE 2: .../base-dns-patterns/smfSetId=set1.smfset.5gc.mnc012.mcc345/{smfImplementationSegmentPaths} + +EXAMPLE 3: .../base-dns-patterns/setId=set1/{smfImplementationSegmentPaths} + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 PATCH + +This method updates (partial update) an individual Baseline DNS Pattern resource in the EASDF. + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | It contains the list of changes to be made to the Baseline DNS pattern, according to the JSON PATCH format specified in IETF RFC 6902 [15]. | + +**Table 6.2.3.2.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PatchResult | M | 1 | 200 OK | Upon partial success, e.g. some of the requested modifications for unknown attribute(s) are discarded while the rest of the modification instructions are fully accepted, the EASDF shall return the execution report. | +| n/a | | | 204 No Content | Successful update of the Baseline DNS Pattern. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates that the modification of the baseline DNS pattern failed due to an application error.

The "cause" attribute may be used to indicate one of the following application errors:
- BASELINE DNS PATTERN NOT FOUND. | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +###### 6.2.3.2.3.2 PUT + +This method creates or updates (complete replacement) an individual Baseline DNS Pattern resource in the EASDF. + +This method shall support the URI query parameters specified in table 6.2.3.2.3.2-1. + +**Table 6.2.3.2.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.2-2 and the response data structures and response codes specified in table 6.2.3.2.3.2-3. + +**Table 6.2.3.2.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|----------------------------------------------------------------------------------------------| +| BaseDnsPatternCreateData | M | 1 | Baseline DNS Pattern Data to be created or to replace the existing Baseline DNS Pattern data | + +**Table 6.2.3.2.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|------------------------|------------------------------------------------| +| DnsBasePatternCreatedData | M | 1 | 201 Created | Successful creation of a Baseline DNS Pattern | +| n/a | | | 204 No Content | Successful update of the Baseline DNS Pattern. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.2.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.2.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +###### 6.2.3.2.3.3 DELETE + +This method deletes an individual Baseline DNS Pattern resource in the EASDF. + +This method shall support the URI query parameters specified in table 6.2.3.2.3.3-1. + +**Table 6.2.3.2.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3-2 and the response data structures and response codes specified in table 6.2.3.2.3.3-3. + +**Table 6.2.3.2.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful deletion of the Baseline DNS Pattern. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection..
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection..
(NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates that the deletion of the baseline DNS pattern failed due to an application error.

The "cause" attribute may be used to indicate one of the following application errors:
- BASELINE_DNS_PATTERN_NOT_FOUND. | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.2.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.2.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same EASDF or EASDF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target EASDF (service) instance ID towards which the request is redirected | + +##### 6.2.3.3.4 Resource Custom Operations + +###### 6.2.3.3.4.1 Overview + +**Table 6.2.3.3.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description (Service operation) | +|----------------|----------------------|--------------------|---------------------------------| +| | | | | + +### 6.2.4 Custom Operations without associated resources + +There are no custom operations defined without any associated resources for the Neasdf\_BaselineDNSPattern service in this release of this specification. + +### 6.2.5 Notifications + +There are no notifications defined for the Neasdf\_BaselineDNSPattern service in this release of the specification. + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Neasdf\_BaselineDNSPattern service based interface protocol. + +**Table 6.2.6.1-1: Neasdf\_BaselineDNSPattern specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------------------|----------------|--------------------------------------------------------|---------------| +| BaseDnsPatternCreateData | 6.2.6.2.2 | Data in Baseline DNS Pattern Create request | | +| BaseDnsPatternCreatedData | 6.2.6.2.3 | Data in Baseline DNS Pattern Create response | | +| BaselineDnsMdt | 6.2.6.2.4 | Baseline DNS message detection template | | +| BaselineDnsAit | 6.2.6.2.5 | Baseline DNS action information Template | | +| VarNfld | 6.2.6.2.6 | SMF or SMF Set Id or Set Id part in SMF set identifier | | + +Table 6.2.6.1-2 specifies data types re-used by the Neasdf service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Neasdf\_BaselineDNSPattern service based interface. + +**Table 6.2.6.1-2: Neasdf\_BaselineDNSPattern re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|--------------|---------------------|-----------------------------------------|---------------| +| DnsQueryMdt | 6.1.6.2.5 | DNS Query Message Detection Template | | +| DnsRspMdt | 6.1.6.2.6 | DNS Response Message Detection Template | | +| EcsOption | 6.1.6.2.12 | ECS Option information | | +| IpAddr | 3GPP TS 29.571 [16] | IP address | | +| NfSetId | 3GPP TS 29.571 [16] | NF Set Id | | +| NfInstanceId | 3GPP TS 29.571 [16] | NF Instance Id | | +| PatchResult | 3GPP TS 29.571 [16] | | | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: BaseDnsPatternCreateData + +Table 6.2.6.2.2-1: Definition of type BaseDnsPatternCreateData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| label | string | O | 0..1 | Baseline DNS pattern's label (NOTE) | | +| baseDnsMdtList | map(BaselineDnsMdt) | O | 1..N | When present, this IE contains the map of DNS message detection templates. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], carrying the identifier of the baseline DNS Message Detection Template, with a maximum of 32 characters. | | +| baseDnsAitList | map(BaselineDnsAit) | O | 1..N | When present, this IE contains the map of Baseline DNS action information Templates. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], carrying the identifier of the baseline DNS Message Detection Template, with a maximum of 32 characters. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported. | | + +NOTE: This attribute may contain free information describing the scope of the baseline DNS pattern. It may be used e.g. for trouble-shooting. + +##### 6.2.6.2.3 Type: BaseDnsPatternCreatedData + +Table 6.2.6.2.3-1: Definition of type BaseDnsPatternCreatedData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported. | | + +##### 6.2.6.2.4 Type: BaselineDnsMdt + +Table 6.2.6.2.4-1: Definition of type BaselineDnsMdt + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mdtId | string | M | 1 | Identifier of the DNS message detection template within the baseline DNS pattern, with a maximum of 32 characters. | | +| label | string | O | 0..1 | Baseline DNS MDT's label
(NOTE 2) | | +| dnsQueryMdtList | map(DnsQueryMdt) | C | 1..N | Map of DNS Query message detection templates.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], carrying the identifier of the DNS Query message detection template, with a maximum of 32 characters.
If present, only fqdnList attribute shall be included in the DNS Query message detection template.
(NOTE 1) | | +| dnsRspMdtList | map(DnsRspMdt) | C | 1..N | Map of DNS Response message detection templates.
The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [12], carrying the identifier of the DNS Response message detection template, with a maximum of 32 characters.
(NOTE 1) | | + +NOTE 1: Either the dnsQueryMdtList IE or the dnsRspMdtList IE shall be present. + +NOTE 2: This attribute may contain free information describing the scope of the baseline DNS MDT. It may be used e.g. for trouble-shooting. + +##### 6.2.6.2.5 Type: BaselineDnsAit + +Table 6.2.6.2.5-1: Definition of type BaselineDnsAit + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| aitId | string | M | 1 | Identifier of the DNS message handling action within the baseline DNS pattern | | +| label | string | O | 0..1 | Baseline DNS AIT's label
(NOTE) | | +| ecsOption | EcsOption | C | 0..1 | Information to build optional EDNS Client Subnet (ECS) option to be included in the DNS Query as defined in IETF RFC 7871 [18], or to be used for replacing the ECS option received in the DNS Query message from the UE. | | +| dnsServerAddressList | array(IpAddr) | C | 1..N | DNS Server Address to be used as destination address of the outgoing DNS Query More than one IP address may be provided for resiliency. | | + +NOTE: This attribute may contain free information describing the scope of the baseline DNS AIT. It may be used e.g. for trouble-shooting. + +##### 6.2.6.2.6 Type: VarNfld + +Table 6.2.6.2.6-1: Definition of type VarNfld + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| smfSetId | NfSetId | C | 0..1 | This IE shall be present if available.
When present, this IE includes the SMF Set Id (NOTE) | | +| setId | string | C | 0..1 | This IE shall be present if available.
When present, this IE includes Set Id part in NF Set Identifier (see clause 28.12 of 3GPP TS 23.003 [7]), formatted as the following string:

"set"

with
encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.
Pattern: '^[A-Za-z0-9-]*[A-Za-z0-9])\$'

Examples:
"setxyz"
"set12"
(NOTE) | | +| smfInstanceId | NfInstanceId | C | 0..1 | This IE shall be present if available.
When present, this IE includes SMF Instance Id (NOTE) | | + +NOTE: Either smfSetId attribute or setId or smfInstanceId attribute shall be included. + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +For the Neasdf\_BaselineDNSPattern API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Neasdf\_BaselineDNSPattern API. + +#### 6.2.7.2 Protocol Errors + +No specific procedures for the Neasdf\_BaselineDNSPattern API service are specified. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Neasdf\_BaselineDNSPattern service are listed in Table 6.2.7.3-1. + +Table 6.2.7.3-1: Application errors + +| Application Error | HTTP status code | Description | +|--------------------------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BASELINE_DNS_PATTERN_NOT_FOUND | 404 Not Found | The request to modify or delete a baseline DNS pattern is rejected because the baseline DNS pattern is not found (i.e. the URI of the baseline DNS pattern is not found). | + +### 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the Neasdf\_BaselineDNSPattern API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Neasdf\_BaselineDNSPattern API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Neasdf\_BaselineDNSPattern API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Neasdf\_BaselineDNSPattern service. + +The Neasdf\_BaselineDNSPattern API defines a single scope "neasdf-baselinednspattern" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different EASDF service instance within the same EASDF, or to a different EASDF of an EASDF set, when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different EASDF producer instance will return the NF Instance ID of the new EASDF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an EASDF redirects a service request to a different EASDF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new EASDF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## --- A.2 Neasdf\_DNSContext API + +``` +openapi: 3.0.0 + +info: + version: '1.1.0-alpha.4' + title: 'Neasdf_DNSContext' + description: | + EASDF DNS Context Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.556 V18.4.0; 5G System; Edge Application Server Discovery Services; Stage3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.556/ + +servers: + - url: '{apiRoot}/neasdf-dnscontext/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - neasdf-dnscontext + +paths: + + /dns-contexts: + post: + summary: Create + tags: + - DNS contexts collection + operationId: CreateDnsContext + requestBody: + description: representation of the DNS context to be created in the EASDF + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DnsContextCreateData' + callbacks: + dnsContextNotification: + '{$request.body#/notifyUri}': + post: +``` + +``` + requestBody: # contents of the DNS context Notify request + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DnsContextNotification' + responses: + '204': + description: successful notification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +responses: + '201': + description: successful creation of a DNS context + content: + application/json: + schema: + $ref: '#/components/schemas/DnsContextCreatedData' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/neasdf-dnscontext/{apiVersion}/dns-contexts/{dnsContextId}' + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +``` +/dns-contexts/{dnsContextId}: + delete: + summary: Delete the DNS Context + tags: + - Individual DNS context + operationId: DeleteDnsContext + parameters: + - name: dnsContextId + in: path + description: DNS context Identifier + required: true + schema: + type: string + responses: + '204': + description: successful deletion of an SM context + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + + patch: + summary: Updates the DNS context + operationId: UpdateDnsContext + tags: + - Individual DNS context + parameters: + - name: dnsContextId + in: path + description: DNS context Identifier + required: true + schema: + type: string + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 7231 + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '200': + description: Partial update of the DNS context + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' +``` + +``` +'204': + description: Successful update of the DNS context + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 7694 + schema: + type: string +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +put: + summary: Updates the DNS context (complete replacement) + operationId: ReplaceDnsContext + tags: + - Individual DNS context + parameters: + - name: dnsContextId + in: path + description: DNS context Identifier + required: true + schema: + type: string + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 7231 + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DnsContextCreateData' + responses: + '204': + description: Successful update of the DNS context + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 7694 + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + neasdf-dnscontext: Access to the neasdf-dnscontext API + +schemas: +# +# STRUCTURED DATA TYPES +# + DnsContextCreateData: + description: Data within Create request + type: object + properties: + ueIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + hplmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + n6RoutingInfo: + $ref: '#/components/schemas/N6RoutingInfo' + dnsRules: + description: map of DNS message handling rules where a valid JSON string serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/DnsRule' + minProperties: 1 + notifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - dnn + - sNssai + - dnsRules + anyOf: + - required: [ ueIpv4Addr ] + - required: [ ueIpv6Prefix ] + + DnsContextCreatedData: + description: Data within Create response + type: object + properties: + easdfIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +``` + +``` + easdfIpv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + anyOf: + - required: [ easdfIpv4Addr ] + - required: [ easdfIpv6Addr ] + +DnsRule: + description: DNS message handling rule + type: object + properties: + dnsRuleId: + type: string + label: + type: string + precedence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + dnsQueryMdtList: + description: map of DNS query message detection templates where a valid JSON string serves +as key + type: object + additionalProperties: + $ref: '#/components/schemas/DnsQueryMdt' + minProperties: 1 + baseDnsQueryMdtList: + type: array + items: + $ref: '#/components/schemas/BaselineDnsQueryMdtInfo' + minItems: 1 + dnsRspMdtList: + description: map of DNS response message detection templates where a valid JSON string +serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/DnsRspMdt' + minProperties: 1 + baseDnsRspMdtList: + type: array + items: + $ref: '#/components/schemas/BaselineDnsRspMdtInfo' + minItems: 1 + dnsMsgId: + type: string + actionList: + description: map of actions where a valid JSON string serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/Action' + minProperties: 1 + required: + - actionList + allOf: + - not: + - required: [ dnsQueryMdtList, dnsRspMdtList ] + - not: + - required: [ dnsQueryMdtList, baseDnsRspMdtList ] + - not: + - required: [ baseDnsQueryMdtList, dnsRspMdtList ] + - not: + - required: [ baseDnsQueryMdtList, baseDnsRspMdtList ] + +DnsQueryMdt: + description: DNS Query message detection template + type: object + properties: + mdtId: + type: string + label: + type: string + sourceIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + sourceIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + fqdnPatternList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FqdnPatternMatchingRule' +``` + +``` + minItems: 1 + required: + - mdtId + +DnsRspMdt: + description: DNS Response message detection template + type: object + properties: + mdtId: + type: string + label: + type: string + fqdnPatternList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FqdnPatternMatchingRule' + minItems: 1 + easIpv4AddrRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + easIpv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + required: + - mdtId + +Ipv4AddressRange: + description: Range of IPv4 addresses + type: object + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + end: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + required: + - start + - end + +Ipv6PrefixRange: + description: Range of IPv6 prefixes + type: object + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + end: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + required: + - start + - end + +Action: + description: Action to apply to DNS messages matching a message detection template + type: object + properties: + applyAction: + $ref: '#/components/schemas/ApplyAction' + fwdParas: + $ref: '#/components/schemas/ForwardingParameters' + reportingOnceInd: + type: boolean + default: false + resetReportingOnceInd: + type: boolean + default: false + respParas: + $ref: '#/components/schemas/RespondParameters' + required: + - applyAction + +DnsContextNotification: + description: Data within DNS Context Notify + type: object + properties: + eventReportList: +``` + +``` +type: array +items: + $ref: '#/components/schemas/DnsContextEventReport' +minItems: 1 + +ForwardingParameters: +description: Forwarding instructions +type: object +properties: + ecsOptionInfo: + $ref: '#/components/schemas/EcsOptionInfo' + dnsServerAddressInfo: + $ref: '#/components/schemas/DnsServerAddressInfo' + +EcsOptionInfo: +description: ECS Option Information +type: object +properties: + ecsOption: + $ref: '#/components/schemas/EcsOption' + baseDnsAitId: + $ref: '#/components/schemas/BaselineDnsAitId' +oneOf: +- required: [ ecsOption ] +- required: [ baseDnsAitId ] + +DnsServerAddressInfo: +description: DNS Server Address Information +type: object +properties: + dnsServerAddressList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + baseDnsAitId: + $ref: '#/components/schemas/BaselineDnsAitId' +oneOf: +- required: [ dnsServerAddressList ] +- required: [ baseDnsAitId ] + +BaselineDnsMdtId: +description: Baseline DNS Message Detection Template Identifier +type: object +properties: + baseDnsPatternUri: + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + mdtId: + type: string +required: +- baseDnsPatternUri +- mdtId + +BaselineDnsAitId: +description: Baseline DNS Action Information Template Identifier +type: object +properties: + baseDnsPatternUri: + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + aitId: + type: string +required: +- baseDnsPatternUri +- aitId + +EcsOption: +description: ECS Option Information +type: object +properties: + sourcePrefixLength: + type: integer + minimum: 0 + maximum: 128 + scopePrefixLength: + type: integer + minimum: 0 +``` + +``` + maximum: 128 + ipAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + required: + - sourcePrefixLength + - ipAddr + +DnsContextEventReport: + description: DNS context event report + type: object + properties: + timestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + dnsRuleId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + dnsQueryReport: + $ref: '#/components/schemas/DnsQueryReport' + dnsRspReport: + $ref: '#/components/schemas/DnsRspReport' + dnsMsgId: + type: string + required: + - timestamp + +DnsQueryReport: + description: DNS Query Event Report + type: object + properties: + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + +DnsRspReport: + description: DNS Response Event Report + type: object + properties: + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + easIpv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + easIpv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + ecsOption: + $ref: '#/components/schemas/EcsOption' + +BaselineDnsQueryMdtInfo: + description: Baseline DNS Query MDT Information + type: object + properties: + sourceIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + sourceIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + baseDnsMdtList: + type: array + items: + $ref: '#/components/schemas/BaselineDnsMdtId' + minItems: 1 + required: + - baseDnsMdtList + +BaselineDnsRspMdtInfo: + description: Baseline DNS Response MDT Information + type: object + properties: + baseDnsMdtList: + type: array + items: + $ref: '#/components/schemas/BaselineDnsMdtId' + minItems: 1 + required: + - baseDnsMdtList +``` + +``` + +RespondParameters: + description: Respond instructions + type: object + properties: + easIpv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + easIpv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + +N6RoutingInfo: + description: N6 traffic routing information + type: object + properties: + ipv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + portNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + +# +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + +ApplyAction: + anyOf: + - type: string + enum: + - BUFFER + - REPORT + - FORWARD + - DISCARD + - RESPOND + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Action to apply to the DNS packet + +``` + +## A.3 Neasdf\_BaselineDNSPattern API + +openapi: 3.0.0 + +### info: + +``` + + version: '1.1.0-alpha.2' + title: 'Neasdf_BaselineDNSPattern' + description: | + EASDF Baseline DNS Pattern Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +### externalDocs: + +``` + + description: 3GPP TS 29.556 V18.1.0; 5G System; Edge Application Server Discovery Services; Stage +3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.556/' + +``` + +### servers: + +``` + + - url: '{apiRoot}/neasdf-baselinednspattern/v1' + +``` + +``` +variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: +- {} +- oAuth2ClientCredentials: + - neasdf-baselinednspattern + +paths: + +/base-dns-patterns/{smfId}/{smfImplementationSegmentPaths}: + patch: + summary: Updates the Baseline DNS Pattern + operationId: UpdateBaseDNSPattern + tags: + - Individual Baseline DNS Pattern + parameters: + - name: smfId + in: path + description: SMF or SMF set identifier or Set Id part in SMF set identifier + required: true + schema: + $ref: '#/components/schemas/VarNfId' + style: simple + explode: true + - name: smfImplementationSegmentPaths + in: path + description: SMF Implementation Dependent Segment Paths + required: true + schema: + type: string + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 7231 + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '200': + description: Partial update of the Baseline DNS Pattern + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '204': + description: Successful update of the Baseline DNS Pattern + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 7694 + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +``` + +``` + + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +put: + summary: Creates or Updates the Baseline DNS Pattern (complete replacement) + operationId: CreateOrReplaceBaseDnsPattern + tags: + - Individual Baseline DNS Pattern + parameters: + - name: smfId + in: path + description: SMF or SMF set identifier or Set Id part in SMF set identifier + required: true + schema: + $ref: '#/components/schemas/VarNfId' + style: simple + explode: true + - name: smfImplementationSegmentPaths + in: path + description: SMF Implementation Dependent Segment Paths + required: true + schema: + type: string + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 7231 + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BaseDnsPatternCreateData' + responses: + '201': + description: successful creation of a Baseline DNS pattern + content: + application/json: + schema: + $ref: '#/components/schemas/BaseDnsPatternCreatedData' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/neasdf-baselinednspattern/{apiVersion}/base-dns- +patterns/{smfId}/{smfImplementationSegmentPaths}' + required: true + schema: + type: string + '204': + description: Successful update of the Baseline DNS Pattern + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 7694 + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + +``` + +``` +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes a Baseline DNS Pattern + tags: + - Individual Baseline DNS Pattern + operationId: DeleteBaseDnsPattern + parameters: + - name: smfId + in: path + description: SMF or SMF set identifier or Set Id part in SMF set identifier + required: true + schema: + $ref: '#/components/schemas/VarNfId' + style: simple + explode: true + - name: smfImplementationSegmentPaths + in: path + description: SMF Implementation Dependent Segment Paths + required: true + schema: + type: string + responses: + '204': + description: successful deletion of a Baseline DNS Pattern + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' +``` + +``` +scopes: + neasdf-baselinednspattern: Access to the neasdf-baselinednspattern API + +schemas: +# +# STRUCTURED DATA TYPES +# + +BaseDnsPatternCreateData: + description: Data in Baseline DNS Pattern Create request + type: object + properties: + label: + type: string + baseDnsMdtList: + description: map of baseline DNS message detection templates where a valid JSON string +serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/BaselineDnsMdt' + minProperties: 1 + baseDnsAitList: + description: map of Baseline DNS action information Template where a valid JSON string +serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/BaselineDnsAit' + minProperties: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +BaseDnsPatternCreatedData: + description: Data in Baseline DNS Pattern Create response + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +BaselineDnsMdt: + description: Baseline DNS message detection template + type: object + properties: + mdtId: + type: string + label: + type: string + dnsQueryMdtList: + description: map of DNS query message detection templates where a valid JSON string serves +as key + type: object + additionalProperties: + $ref: 'TS29556_Neasdf_DNSContext.yaml#/components/schemas/DnsQueryMdt' + minProperties: 1 + dnsRspMdtList: + description: map of DNS response message detection templates where a valid JSON string +serves as key + type: object + additionalProperties: + $ref: 'TS29556_Neasdf_DNSContext.yaml#/components/schemas/DnsRspMdt' + minProperties: 1 + required: + - mdtId + oneOf: + - required: [ dnsQueryMdtList ] + - required: [ dnsRspMdtList ] + +BaselineDnsAit: + description: Baseline DNS action information Template + type: object + properties: + aitId: + type: string + label: + type: string + ecsOption: + $ref: 'TS29556_Neasdf_DNSContext.yaml#/components/schemas/EcsOption' + dnsServerAddressList: + type: array + items: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + required: + - altId + +VarNfId: + description: SMF or SMF Set Id or Set Id part in NF Set Id + type: object + properties: + smfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + setId: + type: string + pattern: '^( [A-Za-z0-9\-\-]* [A-Za-z0-9] ) $' + smfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +``` + +``` +# +# SIMPLE DATA TYPES +# +``` + +``` +# +# ENUMERATIONS +# +``` + +# --- Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-04 | CT4#103e | C4-212440 | | | | TS skeleton | 0.0.0 | +| 2021-04 | CT4#103e | C4-212441
C4-212442 | | | | Implementation of pCRs agreed in CT4#103E | 0.1.0 | +| 2021-06 | CT4#104e | C4-213092
C4-213093
C4-213094
C4-213095
C4-213096
C4-213182
C4-213184
C4-213185
C4-213429
C4-213430
C4-213479 | | | | Implementation of pCRs agreed in CT4#104E | 0.2.0 | +| 2021-09 | CT4#105e | C4-214676 | | | | Implementation of pCRs agreed in CT4#105E | 0.3.0 | +| 2021-10 | CT4#106e | C4-215049
C4-215365
C4-215366
C4-215488
C4-215489
C4-215246
C4-215429
C4-215430
C4-215431
C4-215432
C4-215433
C4-215434 | | | | Implementation of pCRs agreed in CT4#106E | 0.4.0 | +| 2021-11 | CT4#107e | C4-216189
C4-216551
C4-216303
C4-216304
C4-216305
C4-216306
C4-216307 | | | | Implementation of pCRs agreed in CT4#107E | 0.5.0 | +| 2021-12 | CT#94 | CP-213156 | | | | V1.0.0 presented for information | 1.0.0 | +| 2022-01 | CT4#107bisE | C4-220101
C4-220103
C4-220239
C4-220399
C4-220419
C4-220452 | | | | Implementation of pCRs agreed in CT4#107bisE | 1.1.0 | +| 2022-03 | CT4#108e | C4-221136
C4-221296
C4-221482 | | | | Implementation of pCRs agreed in CT4#108E | 1.2.0 | +| 2022-03 | CT#95e | CP-220105 | | | | TS send for approval | 2.0.0 | +| 2022-03 | CT#95e | | | | | TS approved | 17.0.0 | +| 2022-06 | CT#96 | CP-221034 | 0001 | 2 | F | Key of Map in Data Structure for Baseline DNS Pattern | 17.1.0 | +| 2022-06 | CT#96 | CP-221034 | 0002 | | F | Reference point between SMF and EASDF | 17.1.0 | +| 2022-06 | CT#96 | CP-221034 | 0003 | 1 | B | Using FQDN Pattern Matching Rule for fqdnPatternList | 17.1.0 | +| 2022-06 | CT#96 | CP-221034 | 0004 | | F | Reuse of type Fgdn from 29.571 | 17.1.0 | +| 2022-06 | CT#96 | CP-221034 | 0005 | | F | S-NSSAI in Create DNS context | 17.1.0 | +| 2022-06 | CT#96 | CP-221051 | 0006 | | F | 29.556 Rel-17 API version and External doc update | 17.1.0 | +| 2022-12 | CT#98e | CP-223045 | 0009 | 1 | F | Handling of EDNS Client Subnet option by EASDF | 17.2.0 | +| 2022-12 | CT#98e | CP-223045 | 0010 | | F | Corrections on DnsServerAddressInfo | 17.2.0 | +| 2022-12 | CT#98e | CP-223029 | 0008 | 1 | F | Missing mandatory status codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98e | CP-223033 | 0012 | | F | 29.556 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230033 | 0013 | 2 | B | Common EAS discovery for a set of UEs | 18.1.0 | +| 2023-03 | CT#99 | CP-230060 | 0014 | 1 | F | Application errors of Neasdf_DNSContext API | 18.1.0 | +| 2023-03 | CT#99 | CP-230075 | 0016 | 1 | A | Misalignments between OpenAPI definitions and normative tables | 18.1.0 | +| 2023-03 | CT#99 | CP-230033 | 0019 | 1 | B | Support of edge computing in roaming | 18.1.0 | +| 2023-03 | CT#99 | CP-230071 | 0023 | | F | 29.556 Rel-18 API version and External doc update | 18.1.0 | +| 2023-06 | CT#100 | CP-231027 | 0022 | 4 | F | Location header and missing Redirection clause | 18.2.0 | +| 2023-06 | CT#100 | CP-231033 | 0025 | 3 | B | HR-SBO impacts on Neasdf_DNSContext service | 18.2.0 | +| 2023-06 | CT#100 | CP-231070 | 0026 | | F | 29.556 Rel-18 API version and External doc update | 18.2.0 | +| 2023-09 | CT#101 | CP-232036 | 0027 | | B | BaselineDNSPattern for HR-SBO roaming | 18.3.0 | +| 2023-12 | CT#102 | CP-233027 | 0028 | | F | HTTP RFC obsoleted by IETF RFC 9113 | 18.4.0 | +| 2023-12 | CT#102 | | | | | DNS traffic routing between UE and V-EASDF where multiple DNN networks with the same IP address range are deployed | 18.4.0 | +| | | CP-233038 | 0030 | 1 | B | | | +| 2023-12 | CT#102 | CP-233038 | 0031 | | B | Remove editor note for unspecified IPv6 Prefix | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|--|---|---------------------------------------------------|--------| +| 2023-12 | CT#102 | CP-233030 | 0032 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 0033 | | F | 29.556 Rel-18 API version and External doc update | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29557/raw.md b/raw/rel-18/29_series/29557/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..920bda1115baea219a4562f1384753bc19ab941f --- /dev/null +++ b/raw/rel-18/29_series/29557/raw.md @@ -0,0 +1,1557 @@ + + +# 3GPP TS 29.557 V18.2.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Application Function ProSe Service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 5 Naf_ProSe Service offered by the AF..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Naf_ProSe Service ..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 10 | +| 5.2.2.1 Introduction..... | 10 | +| 5.2.2.2 DiscoveryAuthorization..... | 10 | +| 5.2.2.2.1 General ..... | 10 | +| 5.2.2.2.2 Auth Request procedures using DiscoveryAuthorization service operation..... | 10 | +| 5.2.2.2.3 Open 5G ProSe Direct Discovery (Model A) with application-controlled extension..... | 11 | +| 5.2.2.2.4 Restricted 5G ProSe Direct Discovery (Model A)..... | 12 | +| 5.2.2.2.5 Restricted 5G ProSe Direct Discovery (Model A) with application-controlled extension..... | 13 | +| 5.2.2.2.6 Restricted 5G ProSe Direct Discovery (Model B)..... | 14 | +| 5.2.2.2.7 Restricted 5G ProSe Direct Discovery match report ..... | 15 | +| 5.2.2.3 DiscoveryAuthorizationUpdateNotify..... | 15 | +| 5.2.2.3.1 General ..... | 15 | +| 5.2.2.4 DiscoveryAuthorizationResultUpdate ..... | 16 | +| 5.2.2.4.1 General ..... | 16 | +| 6 API Definitions ..... | 17 | +| 6.1 Naf_ProSe Service API..... | 17 | +| 6.1.1 Introduction ..... | 17 | +| 6.1.2 Usage of HTTP..... | 17 | +| 6.1.2.1 General..... | 17 | +| 6.1.2.2 HTTP standard headers..... | 17 | +| 6.1.2.2.1 General ..... | 17 | +| 6.1.2.2.2 Content type ..... | 17 | +| 6.1.2.3 HTTP custom headers..... | 17 | +| 6.1.3 Resources..... | 18 | +| 6.1.4 Custom Operations without associated resources ..... | 18 | +| 6.1.4.1 Overview..... | 18 | +| 6.1.4.2 Operation: authorize-discovery..... | 18 | +| 6.1.4.2.1 Description ..... | 18 | +| 6.1.4.2.2 Operation Definition ..... | 18 | +| 6.1.4.3 Operation: authorization-update-result ..... | 19 | +| 6.1.4.3.1 Description ..... | 19 | +| 6.1.4.3.2 Operation Definition ..... | 19 | +| 6.1.5 Notifications ..... | 20 | +| 6.1.5.1 General..... | 20 | +| 6.1.5.2 DiscoveryAuthorizationUpdateNotify..... | 20 | +| 6.1.5.2.1 Description ..... | 20 | +| 6.1.5.2.2 Notification Definition ..... | 20 | +| 6.1.5.2.3 Notification Standard Methods ..... | 21 | +| 6.1.5.2.3.1 POST ..... | 21 | +| 6.1.6 Data Model..... | 21 | +| 6.1.6.1 General..... | 21 | + +| | | | +|--------------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 6.1.6.2 | Structured data types..... | 23 | +| 6.1.6.2.1 | Introduction ..... | 23 | +| 6.1.6.2.2 | Type: AuthDisReqData ..... | 23 | +| 6.1.6.2.3 | Type: AuthDisResData ..... | 24 | +| 6.1.6.2.4 | Type: TargetData..... | 24 | +| 6.1.6.2.5 | Type: AuthUpdateData ..... | 25 | +| 6.1.6.2.6 | Type: BannedAuthData..... | 25 | +| 6.1.6.3 | Simple data types and enumerations..... | 25 | +| 6.1.6.3.1 | Introduction ..... | 25 | +| 6.1.6.3.2 | Simple data types ..... | 25 | +| 6.1.6.3.3 | Enumeration: AuthRequestType..... | 26 | +| 6.1.6.3.4 | Enumeration: AuthResponseType..... | 26 | +| 6.1.6.3.5 | Enumeration: MetadataIndic ..... | 27 | +| 6.1.6.3.6 | Enumeration: RevocationResult..... | 27 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 28 | +| 6.1.6.5 | Binary data..... | 28 | +| 6.1.7 | Error Handling ..... | 28 | +| 6.1.7.1 | General ..... | 28 | +| 6.1.7.2 | Protocol Errors ..... | 28 | +| 6.1.7.3 | Application Errors..... | 28 | +| 6.1.8 | Feature negotiation ..... | 28 | +| 6.1.9 | Security ..... | 28 | +| Annex A (normative): OpenAPI specification..... | | 30 | +| A.1 | General..... | 30 | +| A.2 | Naf_ProSe API..... | 30 | +| Annex B (informative): Change history ..... | | 36 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Application Function ProSe Service of the 5G System. It provides stage 3 protocol definitions and message flows, and specifies the API for the Naf\_ProSe service. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.304 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +The Application Function ProSe Service is provided by the Application Function (AF). This service supports 5G ProSe Direct Discovery authorization. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.304: "Proximity based Services (ProSe) in the 5G System (5GS); Stage 2". +- [15] 3GPP TS 23.303: "Proximity-based services (ProSe); Stage 2". +- [16] 3GPP TS 29.555: "5G System; 5G Direct Discovery Name Management Services; Stage 3". +- [17] IETF RFC 7396: "JSON Merge Patch". +- [18] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**example:** text used to clarify abstract rules by applying them literally. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + + + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|----------------------------------------------| +| 5G DDNMF | 5G Direct Discovery Name Management Function | +| 5G ProSe | 5G Proximity-based Services | +| RPAUID | Restricted ProSe Application User ID | +| PDUID | ProSe Discovery UE ID | + +# 4 Overview + +The Application Function ProSe (Naf\_ProSe) Service, as defined in clause 7.2.2 of 3GPP TS 23.304 [14], is provided by the Application Function (AF) which owns the functionality of ProSe Application Server. + +Figure 4-1 and figure 4-2 provide the reference architecture (in service based interface representation and reference point representation), with focus on the ProSe Service of the Application Function. + +![Diagram of Naf_ProSe Service architecture, SBI representation. The diagram shows an AF (Application Function) box containing a 'ProSe Application Server' box. Below the AF box is an oval labeled 'Naf'. A vertical line connects the 'Naf' oval to a horizontal line labeled 'Naf_ProSe'. Below this horizontal line is a box labeled '5G DDNMF'.](6078636a87fbe0e699aab4a6fddd15d7_img.jpg) + +``` + +graph TD + subgraph AF [AF] + PAS[ProSe Application Server] + end + PAS --- Naf((Naf)) + Naf --- Naf_ProSe[Naf_ProSe] + Naf_ProSe --- DDNMF[5G DDNMF] + +``` + +Diagram of Naf\_ProSe Service architecture, SBI representation. The diagram shows an AF (Application Function) box containing a 'ProSe Application Server' box. Below the AF box is an oval labeled 'Naf'. A vertical line connects the 'Naf' oval to a horizontal line labeled 'Naf\_ProSe'. Below this horizontal line is a box labeled '5G DDNMF'. + +Figure 4-1: Naf\_ProSe Service architecture, SBI representation + +The Naf\_ProSe Service is part of the Naf service-based interface exhibited by the AF. The service is provided by the AF and consumed by NF service consumers (e.g. 5G DDNMF), as shown in figure 4-1 for the SBI representation and figure 4-2 for the reference point model. + +![Figure 4-2: Naf_ProSe Service architecture, reference point representation. The diagram shows a 5G DDNMF connected via an Npc2 reference point to a ProSe Application Server, which is part of the AF (Application Function).](7a0db9703b68b3d06cdaeefc084c0006_img.jpg) + +``` + +graph LR + 5GDDNMF[5G DDNMF] -- Npc2 --> PAS[ProSe Application Server] + subgraph AF [AF] + PAS + end + +``` + +Figure 4-2: Naf\_ProSe Service architecture, reference point representation. The diagram shows a 5G DDNMF connected via an Npc2 reference point to a ProSe Application Server, which is part of the AF (Application Function). + +Figure 4-2: Naf\_ProSe Service architecture, reference point representation + +# 5 Naf\_ProSe Service offered by the AF + +## 5.1 Introduction + +Table 5.1-1 shows the Application Function ProSe Service and the corresponding Service Operations. + +Table 5.1-1: Application Function ProSe Service + +| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | +|--------------|------------------------------------|---------------------|---------------------| +| Naf_ProSe | DiscoveryAuthorization | Request/Response | 5G DDNMF | +| | DiscoveryAuthorizationUpdateNotify | Subscribe/Notify | 5G DDNMF | +| | DiscoveryAuthorizationResultUpdate | Request/Response | 5G DDNMF | + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +Table 5.1-2: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------|--------|------------------------------------|----------------------------|-----------|-------| +| Naf_ProSe | 6.1 | Application Function ProSe Service | TS29557_Naf_ProSe | naf-prose | A.2 | + +## 5.2 Naf\_ProSe Service + +### 5.2.1 Service Description + +The Naf\_ProSe Service enables NF service consumers (e.g. 5G DDNMF) to request authorization for a UE of a 5G ProSe Discovery request. + +This service hence supports the following functionalities: + +- mapping of RPAUID and PDUID and authentication of the RPAUID(s) for restricted 5G ProSe Direct Discovery; +- allocation of a ProSe Application Code Suffix pool, if open 5G ProSe Direct Discovery with application-controlled extension is used; +- allocation of mask(s) for the ProSe Application Code Suffix(es), if open 5G ProSe Direct Discovery with application-controlled extension is used; +- allocation of a ProSe Restricted Code Suffix pool, if restricted 5G ProSe Direct Discovery with application-controlled extension is used; and + +- allocation of mask(s) for ProSe Restricted Code Suffix, if restricted 5G ProSe Direct Discovery with application-controlled extension is used; and +- update of authorization information to revoke Restricted ProSe Direct Discovery permission(s). + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operations defined for the Naf\_ProSe Service are as follows: + +- DiscoveryAuthorization: It allows a NF service consumer (e.g. 5G DDNMF) to request the authorization for a UE of a 5G ProSe Direct Discovery request; +- DiscoveryAuthorizationUpdateNotify: It allows an AF to update the authorization information to revoke discovery permissions related to some other users at the NF service consumer for Restricted ProSe Direct Discovery; +- DiscoveryAuthorizationResultUpdate: It allows a NF service consumer (e.g. 5G DDNMF) to inform the AF of the revocation result associated to the update of authorization information for Restricted ProSe Direct Discovery. + +#### 5.2.2.2 DiscoveryAuthorization + +##### 5.2.2.2.1 General + +The DiscoveryAuthorization service operation is used by a NF service consumer (e.g. 5G DDNMF) to obtain the authorization for a UE of a 5G ProSe Direct Discovery request, i.e. detect and identify other UEs in proximity using NR radio signals. + +The following procedures are supported using the DiscoveryAuthorization Service Operation: + +- Auth Request procedures (see 3GPP TS 23.304 [14], clause 6.3, and 3GPP TS 23.303 [15], clause 5.3). + +##### 5.2.2.2.2 Auth Request procedures using DiscoveryAuthorization service operation + +These procedures are invoked by a NF service consumer (e.g. HPLMN 5G DDNMF) towards an AF to request the authorization for a UE to perform 5G ProSe Direct Discovery. + +![Sequence diagram showing the authorization process between an NF Service Consumer and an AF. The NF Service Consumer sends a POST request to the AF. The AF responds with either a 200 OK (AuthDisResData) or a 4xx/5xx (ProblemDetails).](cd48273072c5c3a23e11fde892d1b6b6_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant AF + Note left of NF Service Consumer: Request authorization for a UE + NF Service Consumer->>AF: 1. POST ../authorize-discovery(AuthDisReqData) + AF-->>NF Service Consumer: 2a. 200 OK (AuthDisResData) + Note right of AF: or + AF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) +``` + +Sequence diagram showing the authorization process between an NF Service Consumer and an AF. The NF Service Consumer sends a POST request to the AF. The AF responds with either a 200 OK (AuthDisResData) or a 4xx/5xx (ProblemDetails). + +**Figure 5.2.2.2.2-1: Authorization of Discovery Request for a UE** + +1. In order to request the authorization for a UE of a 5G ProSe Direct Discovery request, the NF service consumer shall send an HTTP POST request with the request URI set to "{apiRoot}/naf-prose/{apiVersion}/authorize-discovery" and the request body containing the AuthDisReqData data structure, as described in figure 5.2.2.2.2-1. + +The AuthDisReqData data structure shall contain the authorization request type related to the received 5G ProSe Direct Discovery request within the "authRequestType" attribute. The remaining content of the AuthDisReqData data structure differs according to the following cases, as defined in clauses 5.2.2.2.3, 5.2.2.2.4, 5.2.2.2.5, 5.2.2.2.6 and 5.2.2.2.7. + +- Open 5G ProSe Direct Discovery request with application-controlled extension initiated by an announcing UE (see clause 5.3.3 of 3GPP TS 23.303 [15]). This is defined in clause 5.2.2.2.3. + - Open 5G ProSe Direct Discovery request with application-controlled extension initiated by a monitoring UE (see clause 5.3.3 of 3GPP TS 23.303 [15]). This is defined in clause 5.2.2.2.3. + - Restricted 5G ProSe Direct Discovery request initiated by an announcing UE (see clause 5.3.3 of 3GPP TS 23.303 [15]). This is defined in clause 5.2.2.2.4. + - Restricted 5G ProSe Direct Discovery request with application-controlled extension initiated by an announcing UE (see clause 5.3.3 of 3GPP TS 23.303 [15]). This is defined in clause 5.2.2.2.5. + - Restricted 5G ProSe Direct Discovery request initiated by a monitoring UE (see clause 5.3.3 of 3GPP TS 23.303 [15]). This is defined in clause 5.2.2.2.4. + - Restricted 5G ProSe Direct Discovery request with application-controlled extension initiated by a monitoring UE (see clause 5.3.3 of 3GPP TS 23.303 [15]). This is defined in clause 5.2.2.2.5. + - Restricted 5G ProSe Direct Discovery request initiated by a discoveree UE (see clause 5.3.3A of 3GPP TS 23.303 [15]). This is defined in clause 5.2.2.2.6. + - Restricted 5G ProSe Direct Discovery request initiated by a discoverer UE (see clause 5.3.3A of 3GPP TS 23.303 [15]). This is defined in clause 5.2.2.2.7. + - Restricted 5G ProSe Direct Discovery match report (see clauses 5.3.4 and 5.3.4A of 3GPP TS 23.303 [15]). This is defined in clause 5.2.2.2.3. +- 2a On success, a response with HTTP "200 OK" status code shall be returned. The response body shall contain the parameters related to the 5G ProSe Direct Discovery authorization response data within the AuthDisResData data structure, which shall contain the authorization response type related to the received 5G ProSe Direct Discovery request within the "authResponseType" attribute. The remaining content of the AuthDisResData data structure also differs according to the above listed cases in step 1, as defined in clauses 5.2.2.2.3, 5.2.2.2.4, 5.2.2.2.5, 5.2.2.2.6 and 5.2.2.2.7. +- 2b On failure, one of the HTTP status codes listed in table 6.1.4.2.2-2 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in table 6.1.7.3-1. + +##### 5.2.2.2.3 Open 5G ProSe Direct Discovery (Model A) with application-controlled extension + +When Open 5G ProSe Direct Discovery (Model A) with application-controlled extension is used, the NF service consumer (e.g. 5G DDNMF) shall provide the following attributes within the AuthDisReqData data structure, as specified in clause 6.3 of 3GPP TS 23.304 [14] and clauses 5.3.3.2, 5.3.3.3, 5.3.3.4 and 5.3.3.5 of 3GPP TS 23.303 [15]. + +- When the 5G ProSe Direct Discovery request is initiated by an announcing UE: + - the ProSe Application ID within the "proseAppId" attribute, indicating what the UE is interested to announce; + - the allowed number of suffixes within the "allowedSuffixNum" attribute, indicating how many ProSe Application Code Suffixes the ProSe Application Server can assign for the UE; + - the application level container within the "appLevelContainer" attribute, containing the request and any relevant information for the 5G ProSe AF to assign a (set of) ProSe Application Code Suffix(es); and + - the authorization request type set to "OPEN\_DISCOVERY\_EXTENSION\_ANNOUNCE" within the "authRequestType" attribute. +- When the 5G ProSe Direct Discovery request is initiated by a monitoring UE: + - the ProSe Application ID(s) within the "proseAppId" attribute, indicating what the UE is interested to monitor; + - the application level container within the "appLevelContainer" attribute, containing the request and information corresponding to the ProSe Application Code Suffix; and + +- the authorization request type set to "OPEN\_DISCOVERY\_EXTENSION\_MONITOR" within the "authRequestType" attribute. + +If the processing of the request is successful, the 5G ProSe AF shall provide the following attributes within the AuthDisResData data structure, also as specified in clause 6.3 of 3GPP TS 23.304 [14] and clauses 5.3.3.2, 5.3.3.3, 5.3.3.4 and 5.3.3.5 of 3GPP TS 23.303 [15]: + +- When the 5G ProSe Direct Discovery request is initiated by an announcing UE: + - the ProSe Application Code Suffix Pool within the "proseAppCodeSuffixPool" attribute, containing the Suffix(es) allocated by the 5G ProSe AF based on the inputs provided by the NF service consumer (e.g. 5G DDNMF) in the associated request; + - the authorization response type set to "OPEN\_DISCOVERY\_EXTENSION\_ANNOUNCE\_ACK" within the "authResponseType" attribute. +- When the 5G ProSe Direct Discovery request is initiated by a monitoring UE: + - the mask(s) for the ProSe Application Code Suffix(es) within the "proseAppMasks" attribute, corresponding to ProSe Application ID provided by the NF service consumer (e.g. 5G DDNMF) in the related request; + - the authorization response type set to "OPEN\_DISCOVERY\_EXTENSION\_MONITOR\_ACK" within the "authResponseType" attribute. + +##### 5.2.2.2.4 Restricted 5G ProSe Direct Discovery (Model A) + +When Restricted 5G ProSe Direct Discovery (Model A) is used, the NF service consumer (e.g. 5G DDNMF) shall provide the following attributes within the AuthDisReqData data structure, as specified in clause 6.3 of 3GPP TS 23.304 [14] and clauses 5.3.3.2A, 5.3.3.3A, 5.3.3.4A and 5.3.3.5A of 3GPP TS 23.303 [15]. + +- When the 5G ProSe Direct Discovery request is initiated by an announcing UE: + - the RPAUID within the "rpauid" attribute, indicating what the UE is interested to announce; and + - the authorization request type set to "RESTRICTED\_DISCOVERY\_ANNOUNCE" within the "authRequestType" attribute. +- When the 5G ProSe Direct Discovery request is initiated by a monitoring UE: + - the authorization request type set to either "RESTRICTED\_DISCOVERY\_MONITOR" or "RESTRICTED\_DISCOVERY\_PERMISSION" within the "authRequestType" attribute; and + - if the authorization request type is set to "RESTRICTED\_DISCOVERY\_MONITOR": + - the RPAUID within the "rpauid" attribute, indicating the identity that the UE uses to obtain the permission to monitor; and + - the application level container within the "appLevelContainer" attribute, containing the Target RPAUID(s) indicating what the UE is interested to monitor; + +otherwise, + +- if the authorization request type is set to "RESTRICTED\_DISCOVERY\_PERMISSION": + - the RPAUID within the "rpauid" attribute, indicating the identity that the UE uses to obtain the permission to monitor; + - the target RPAUID within the "targetRpauid" attribute, containing the Target RPAUID; + +If the processing of the request is successful, the 5G ProSe AF shall provide the following attributes within the AuthDisResData data structure, also as specified in clause 6.3 of 3GPP TS 23.304 [14] and clauses 5.3.3.2A, 5.3.3.3A, 5.3.3.4A and 5.3.3.5A of 3GPP TS 23.303 [15]: + +- When the 5G ProSe Direct Discovery request is initiated by an announcing UE: + +- the PDUID(s) within the "pduids" attribute, containing the PDUID(s) corresponding to the provided RPAUID; and +- the authorization response type set to "RESTRICTED\_DISCOVERY\_ANNOUNCE\_ACK" within the "authResponseType" attribute. +- When the 5G ProSe Direct Discovery request is initiated by a monitoring UE: + - the authorization response type set to either "RESTRICTED\_DISCOVERY\_MONITOR\_ACK" or "RESTRICTED\_DISCOVERY\_PERMISSION\_ACK" within the "authResponseType" attribute; and + - if the authorization response type is set to "RESTRICTED\_DISCOVERY\_MONITOR\_ACK": + - the PDUID within the "pduids" attribute, containing the PDUID corresponding to the provided RPAUID; + - a response application level container within the "appLevelContainer" attribute, containing the successfully authenticated Target RPAUID(s); and + - N sets of Target PDUID - Target RPAUID - Metadata Indicator within the "targetDataSet" attribute, containing N sets of Target PDUID - Target RPAUID - Metadata Indicator (Each Target PDUID is returned with the corresponding Target RPAUID(s) that the RPAUID is allowed to discover); + +NOTE: The Metadata Indicator is optional. It indicates whether there is metadata associated with the RPAUID, and if so, whether updating this metadata is allowed. + +otherwise, + +- if the authorization response type is set to "RESTRICTED\_DISCOVERY\_PERMISSION\_ACK": + - the target PDUID within the "targetPduid" attribute, containing the Target PDUID; + +##### 5.2.2.2.5 Restricted 5G ProSe Direct Discovery (Model A) with application-controlled extension + +When Restricted 5G ProSe Direct Discovery (Model A) is used, the NF service consumer (e.g. 5G DDNMF) shall provide the following attributes within the AuthDisReqData data structure, as specified in clause 6.3 of 3GPP TS 23.304 [14] and clauses 5.3.3.2A, 5.3.3.3A, 5.3.3.4A and 5.3.3.5A of 3GPP TS 23.303 [15]. + +- When the 5G ProSe Direct Discovery request is initiated by an announcing UE: + - the RPAUID within the "rpauid" attribute, indicating what the UE is interested to announce; + - the allowed number of suffixes within the "allowedSuffixNum" attribute, indicating how many ProSe Restricted Code Suffixes the ProSe Application Server can assign for the UE; + - the authorization request type set to "RESTRICTED\_DISCOVERY\_EXTENSION\_ANNOUNCE" within the "authRequestType" attribute. +- When the 5G ProSe Direct Discovery request is initiated by a monitoring UE: + - the RPAUID within the "rpauid" attribute, indicating the identity that the UE uses to obtain the permission to monitor; and + - the application level container within the "appLevelContainer" attribute, containing the Target RPAUID(s) indicating what the UE is interested to monitor; and + - the authorization request type set to "RESTRICTED\_DISCOVERY\_EXTENSION\_MONITOR" within the "authRequestType" attribute. + +If the processing of the request is successful, the 5G ProSe AF shall provide the following attributes within the AuthDisResData data structure, also as specified in clause 6.3 of 3GPP TS 23.304 [14] and clauses 5.3.3.2A, 5.3.3.3A, 5.3.3.4A and 5.3.3.5A of 3GPP TS 23.303 [15]: + +- When the 5G ProSe Direct Discovery request is initiated by an announcing UE: + +- the PDUID(s) within the "pduids" attribute, containing the PDUID(s) corresponding to the provided RPAUID; and +- the ProSe Restricted Code Suffix Pool within the "restrictedCodeSuffixPool" attribute, containing the Suffix(es) allocated by the 5G ProSe AF based on the inputs provided by the NF service consumer (e.g. 5G DDNMF) in the associated request; +- the authorization response type set to "RESTRICTED\_DISCOVERY\_EXTENSION\_ANNOUNCE\_ACK" within the "authResponseType" attribute. +- When the 5G ProSe Direct Discovery request is initiated by a monitoring UE: + - the PDUID within the "pduids" attribute, containing the PDUID corresponding to the provided RPAUID; + - a response application level container within the "appLevelContainer" attribute, containing the successfully authenticated Target RPAUID(s); + - N sets of Target PDUID - Target RPAUID - Metadata Indicator within the "targetDataSet" attribute, containing N sets of Target PDUID - Target RPAUID - Metadata Indicator (Each Target PDUID is returned with the corresponding Target RPAUID(s) that the RPAUID is allowed to discover); and + +NOTE: The Metadata Indicator is optional. It indicates whether there is metadata associated with the RPAUID, and if so, whether updating this metadata is allowed. + +- the authorization response type set to "RESTRICTED\_DISCOVERY\_EXTENSION\_MONITOR\_ACK" within the "authResponseType" attribute. + +The AuthDisResData data structure may also include in this case: + +- the mask(s) for the ProSe Restricted Code Suffix(es) within the "proSeRestrictedMasks" attribute, corresponding to each of the provided Target RPAUID(s); + +##### 5.2.2.2.6 Restricted 5G ProSe Direct Discovery (Model B) + +When Restricted 5G ProSe Direct Discovery (Model B) is used, the NF service consumer (e.g. 5G DDNMF) shall provide the following attributes within the AuthDisReqData data structure, as specified in clause 6.3 of 3GPP TS 23.304 [14] and clauses 5.3.3A.2, 5.3.3A.3, 5.3.3A.4 and 5.3.3A.5 of 3GPP TS 23.303 [15]. + +- When the 5G ProSe Direct Discovery request is initiated by a discoveree UE: + - the RPAUID within the "rpauid" attribute, indicating what the UE is interested to announce; and + - the authorization request type set to "RESTRICTED\_DISCOVERY\_RESPONSE" within the "authRequestType" attribute. +- When the 5G ProSe Direct Discovery request is initiated by a discoverer UE: + - the RPAUID within the "rpauid" attribute, indicating the identity that the UE uses to obtain the permission to discover; and + - either: + - the application level container within the "appLevelContainer" attribute (e.g. if the NF service consumer is the HPLMN 5G DDNMF), containing the Target RPAUID(s) indicating what the UE is interested to discover; or + - the target RPAUID within the "targetRpauid" attribute (if the NF service consumer is a 5G DDNMF located in another PLMN), containing the Target RPAUID; and + - the authorization request type set to "RESTRICTED\_DISCOVERY\_QUERY" within the "authRequestType" attribute. + +If the processing of the request is successful, the 5G ProSe AF shall provide the following attributes within the AuthDisResData data structure, also as specified in clause 6.3 of 3GPP TS 23.304 [14] and clauses 5.3.3A.2, 5.3.3A.3, 5.3.3A.4 and 5.3.3A.5 of 3GPP TS 23.303 [15]: + +- When the 5G ProSe Direct Discovery request is initiated by a discoveree UE: + - the PDUID(s) within the "pduids" attribute, containing the PDUID(s) corresponding to the provided RPAUID; and + - the authorization response type set to "RESTRICTED\_DISCOVERY\_RESPONSE\_ACK" within the "authResponseType" attribute. +- When the 5G ProSe Direct Discovery request is initiated by a discoverer UE: + - the PDUID within the "pduids" attribute, containing the PDUID corresponding to the provided RPAUID; + - either: + - N sets of Target PDUID - Target RPAUID within the "targetDataSet" attribute (e.g. if the NF service consumer is the HPLMN 5G DDNMF and an application level container was received in the associated request), containing N sets of Target PDUID - Target RPAUID (Each Target PDUID is returned with the corresponding Target RPAUID(s) that the RPAUID is allowed to discover); or + - the target PDUID within the "targetPduid" attribute (if the NF service consumer is a 5G DDNMF located in another PLMN and only one target RPAUID was received in the associated request), containing the Target PDUID; and + - the authorization response type set to "RESTRICTED\_DISCOVERY\_QUERY\_ACK" within the "authResponseType" attribute. + +##### 5.2.2.2.7 Restricted 5G ProSe Direct Discovery match report + +For a Restricted 5G ProSe Direct Discovery match report, the NF service consumer (e.g. 5G DDNMF) shall provide the following attributes within the AuthDisReqData data structure, as specified in clause 6.3 of 3GPP TS 23.304 [14] and clauses 5.3.4.1A, 5.3.4.2A, 5.3.4A.1 and 5.3.4A.2 of 3GPP TS 23.303 [15]. + +- the RPAUID within the "rpauid" attribute, indicating what the UE is interested to announce; and +- the target RPAUID within the "targetRpauid" attribute (if the NF service consumer is a 5G DDNMF located in another PLMN), containing the Target RPAUID; and +- the authorization request type set to "RESTRICTED\_DISCOVERY\_MATCH" within the "authRequestType" attribute. + +If the processing of the request is successful, the 5G ProSe AF shall provide the following attributes within the AuthDisResData data structure, also as specified in clause 6.3 of 3GPP TS 23.304 [14] and clauses 5.3.4.1A, 5.3.4.2A, 5.3.4A.1 and 5.3.4A.2 of 3GPP TS 23.303 [15]: + +- the PDUID within the "pduids" attribute, containing the PDUID corresponding to the provided RPAUID; +- the target PDUID within the "targetPduid" attribute, containing the Target PDUID; +- the metadata within the "metaData" attribute, corresponding to the Target PDUID; and +- the authorization response type set to "RESTRICTED\_DISCOVERY\_MATCH\_ACK" within the "authResponseType" attribute. + +#### 5.2.2.3 DiscoveryAuthorizationUpdateNotify + +##### 5.2.2.3.1 General + +The DiscoveryAuthorizationUpdateNotify service operation is used by an AF to update the authorization information to revoke discovery permissions relating to some other users at the NF service consumer (e.g. 5G DDNMF) for Restricted ProSe Direct Discovery. See Figure 5.2.2.3.1-1. + +The following procedures are supported using the DiscoveryAuthorizationUpdateNotify Service Operation: + +- Auth Update procedures (see 3GPP TS 23.303 [15], clause 5.3.6A.2). + +![Sequence diagram for DiscoveryAuthorizationUpdate Notification. The AF sends a POST {authUpdateCallbackUri}(AuthUpdateData) request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails).](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant AF + participant NF Service Consumer + Note left of AF: 1. POST {authUpdateCallbackUri}(AuthUpdateData) + AF->>NF Service Consumer: Request + Note right of NF Service Consumer: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) + NF Service Consumer-->>AF: Response + +``` + +Sequence diagram for DiscoveryAuthorizationUpdate Notification. The AF sends a POST {authUpdateCallbackUri}(AuthUpdateData) request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails). + +**Figure 5.2.2.3.1-1: DiscoveryAuthorizationUpdate Notification** + +1. The AF shall send an HTTP POST request to the callback URI of the NF consumer (e.g. 5G DDNMF). The request body shall contain the AuthUpdateData data structure. + +The callback URI is provided to the AF during the Auth Request procedures defined in clause 5.2.2.2. + +- 2a. On success, a response with an HTTP "204 No content" status code shall be returned by the NF service consumer. +- 2b. On failure, one of the HTTP status codes listed in Table 6.1.5.2.3.1-2 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails data structure with the "cause" attribute set to one of the application errors listed in Table 6.1.5.2.3.1-2. + +#### 5.2.2.4 DiscoveryAuthorizationResultUpdate + +##### 5.2.2.4.1 General + +The DiscoveryAuthorizationResultUpdate service operation is used by a NF service consumer (e.g. 5G DDNMF) to inform the AF of the result of the revocation request to update the authorization information for Restricted ProSe Direct Discovery. See Figure 5.2.2.4.1-1. + +The following procedures are supported using the DiscoveryAuthorizationResultUpdate Service Operation: + +- Auth Update Result procedures (see 3GPP TS 23.303 [15], clause 5.3.6A.2). + +![Sequence diagram for DiscoveryAuthorizationResultUpdate Request/Response. The NF Service Consumer sends a POST ../authorization-update-result(AuthUpdateData) request to the AF. The AF responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails).](2de714cedbbdd36f901f71bafa78f75a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AF + Note left of NF Service Consumer: 1. POST ../authorization-update-result(AuthUpdateData) + NF Service Consumer->>AF: Request + Note right of AF: 2a. 204 No Content + Note right of AF: 2b. 4xx/5xx (ProblemDetails) + AF-->>NF Service Consumer: Response + +``` + +Sequence diagram for DiscoveryAuthorizationResultUpdate Request/Response. The NF Service Consumer sends a POST ../authorization-update-result(AuthUpdateData) request to the AF. The AF responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails). + +**Figure 5.2.2.4.1-1: DiscoveryAuthorizationResultUpdate Request/Response** + +1. In order to inform the AF of the result of the revocation related to discovery authorization update, the NF service consumer shall send an HTTP POST request with the request URI set to "{apiRoot}/naf-prose//authorize-update-result" and the request body containing the AuthUpdateData data structure, as described in figure 5.2.2.4.1-1. +- 2a. On success, a response with an HTTP "204 No Content" status code shall be returned by the AF. +- 2b. On failure, one of the HTTP status codes listed in Table 6.1.4.3.2-2 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.4.3.2-2. + +# 6 API Definitions + +## 6.1 Naf\_ProSe Service API + +### 6.1.1 Introduction + +The Naf\_ProSe shall use the Naf\_ProSe API. + +The API URI of the Naf\_ProSe API shall be: + +**{apiRoot}
/** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "naf-prose ". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the naf-prose API is contained in Annex A.2. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +JSON Merge Patch, as defined in IETF RFC 7396 [17], signalled by the content type "application/merge-patch+json". + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +In this release of this specification, no resource is defined for the Naf\_ProSe Service. + +### 6.1.4 Custom Operations without associated resources + +#### 6.1.4.1 Overview + +The structure of the custom operation URIs of the Naf\_ProSe Service is shown in figure 6.1.4.1-1. + +![Diagram showing the resource URI structure of the Naf_ProSe API. A box labeled '{apiRoot}/naf-prose/' branches into two dashed boxes labeled '/authorize-discovery' and '/authorization-update-result'.](51db757d054ce1ce83c436a3578b56ca_img.jpg) + +``` + +graph TD + Root["{apiRoot}/naf-prose/"] --> Path1["/authorize-discovery"] + Root --> Path2["/authorization-update-result"] + style Path1 stroke-dasharray: 5 5 + style Path2 stroke-dasharray: 5 5 + +``` + +Diagram showing the resource URI structure of the Naf\_ProSe API. A box labeled '{apiRoot}/naf-prose/' branches into two dashed boxes labeled '/authorize-discovery' and '/authorization-update-result'. + +**Figure 6.1.4.1-1: Resource URI structure of the Naf\_ProSe API** + +Table 6.1.4.1-1 provides an overview of the custom operations and applicable HTTP methods. + +**Table 6.1.4.1-1: Custom operations** + +| Custom operation URI | Mapped HTTP method | Description | +|------------------------------|--------------------|-------------------------------------------------------------------------------------------| +| /authorize-discovery | POST | Obtain the authorization of Discovery Request from the 5G DDNMF for a UE. | +| /authorization-update-result | POST | Inform the AF of the result of the revocation request to update authorization information | + +#### 6.1.4.2 Operation: authorize-discovery + +##### 6.1.4.2.1 Description + +This clause represents the custom operation and what it is used for, and the custom operation URI. + +##### 6.1.4.2.2 Operation Definition + +This operation shall support request data structures specified in table 6.1.4.2.2-1 and response data structures specified in table 6.1.4.2.2-2. + +**Table 6.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-------------------------------------------------------------------------------------------------| +| AuthDisReqData | M | 1 | Contains the request data to obtain the authorization for a UE of a 5G ProSe Discovery Request. | + +**Table 6.1.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthDisResData | M | 1 | 200 OK | Contains the response data for the authorization of a 5G ProSe Direct Discovery Request for a UE. | +| N/A | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative AF. | +| N/A | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative AF. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.1.7.3. + +**Table 6.1.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative AF. | + +**Table 6.1.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative AF. | + +#### 6.1.4.3 Operation: authorization-update-result + +##### 6.1.4.3.1 Description + +This clause represents the custom operation and what it is used for, and the custom operation URI. + +##### 6.1.4.3.2 Operation Definition + +This operation shall support request data structures specified in table 6.1.4.3.2-1 and response data structures specified in table 6.1.4.3.2-2. + +**Table 6.1.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| AuthUpdateData | M | 1 | Contains the result of the revocation request to update authorization information for Restricted ProSe Direct Discovery. | + +**Table 6.1.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful report of discovery authorization update result. | +| N/A | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative AF. | +| N/A | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative AF. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.1.7.3. + +**Table 6.1.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative AF. | + +**Table 6.1.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative AF. | + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +Table 6.1.5.1-1 provides an overview of the notification operation and applicable HTTP method. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method | Description | +|------------------------------------|-------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| DiscoveryAuthorizationUpdateNotify | {authUpdateCallbackUri} | POST | Update the authorization information to revoke discovery permissions related to some other users in the NF service consumer (e.g. 5G DDNMF). | + +#### 6.1.5.2 DiscoveryAuthorizationUpdateNotify + +##### 6.1.5.2.1 Description + +The DiscoveryAuthorizationUpdateNotify service operation is used to update the authorization information to revoke discovery permissions related to some other users in the NF service consumer (e.g. 5G DDNMF). + +##### 6.1.5.2.2 Notification Definition + +Call-back URI: {authUpdateCallbackUri} + +See clause 5.2.2.2.1 for the description of how the AF obtains the Call-back URI of the NF service consumer. + +##### 6.1.5.2.3 Notification Standard Methods + +###### 6.1.5.2.3.1 POST + +This method sends a discovery authorization update notification to the NF service consumer. + +This method shall support the request and response data structures and response codes specified in table 6.1.5.2.3.1-1 and table 6.1.5.2.3.1-2. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthUpdateData | M | 1 | Input parameters to the "DiscoveryAuthorizationUpdateNotify" service operation, including the updated authorization information for Restricted ProSe Direct Discovery. | + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful notification of the event. | +| N/A | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative AF. | +| N/A | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative AF. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 6.1.7.3. + +**Table 6.1.5.2.3-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative AF. | + +**Table 6.1.5.2.3-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative AF. | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the Naf\_ProSe API. + +Table 6.1.6.1-1 specifies the data types defined for the Naf\_ProSe service based interface. + +**Table 6.1.6.1-1: Naf\_ProSe specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| AuthDisReqData | 6.1.6.2.2 | Represents Data used to request the authorization for a UE of 5G ProSe Direct Discovery Request. | | +| AuthDisResData | 6.1.6.2.3 | Represents the obtained authorization Data for a UE of 5G ProSe Direct Discovery Request. | | +| TargetData | 6.1.6.2.4 | Represents a combination of Target PDUID - Target RPAUID - Metadata Indicator. | | +| AllowedSuffixNum | 6.1.6.3.2 | Represents the allowed number of suffixes. | | +| AppLevelContainer | 6.1.6.3.2 | Represents an Application Layer Container. | | +| MetadataIndic | 6.1.6.3.5 | Contains Metadata Indicator. | | +| AuthRequestType | 6.1.6.3.3 | Represents the authorization request type. | | +| AuthResponseType | 6.1.6.3.4 | Represents the authorization response type. | | +| ProSeRestrictedMask | 6.1.6.3.2 | Represents a Prose Restricted Mask. | | +| AuthUpdateData | 6.1.6.2.5 | Represents the updated authorization information for Restricted ProSe Direct Discovery. | | +| BannedAuthData | 6.1.6.2.6 | Represents a set of Banned RPAUID - Banned PDUID that are no longer allowed to discover the ProSe Restricted Code corresponding to the user's RPAUID for the Application ID associated with that AF. | | +| RevocationResult | 6.1.6.3.6 | Represents the revocation result of a set of Banned RPAUID - Banned PDUID for Restricted ProSe Direct Discovery. | | + +Table 6.1.6.1-2 specifies data types re-used by the Naf\_ProSe service based interface from other specifications, including a reference to their respective specifications, and when needed, a short description of their use within the Naf\_ProSe Service based interface. + +**Table 6.1.6.1-2: Naf\_ProSe re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|--------------------------------|---------------------|------------------------------------------------------------------------------------------------|----------------------| +| ProseApplicationId | 3GPP TS 29.555 [16] | A string representing the ProSe Application ID. | | +| ProseApplicationCodeSuffixPool | 3GPP TS 29.555 [16] | Contains a ProSe Application Code Suffix Pool. | | +| Rpauid | 3GPP TS 29.555 [16] | Represents a Restricted ProSe Application User ID. | | +| Pduid | 3GPP TS 29.555 [16] | Represents a ProSe Discovery UE ID. | | +| ProseApplicationMask | 3GPP TS 29.555 [16] | Represents a Mask for a ProSe Application Code Suffix corresponding to a ProSe Application ID. | | +| MetaData | 3GPP TS 29.555 [16] | Contains Metadata. | | +| RestrictedCodeSuffixPool | 3GPP TS 29.555 [16] | Contains a ProSe Restricted Code Suffix pool. | | +| Uri | 3GPP TS 29.571 [18] | Contains a URI. | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: AuthDisReqData + +**Table 6.1.6.2.2-1: Definition of type AuthDisReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| authRequestType | AuthRequestType | M | 1 | This attribute contains the authorization request type for 5G ProSe Direct Discovery. | | +| proseAppId | array(ProseApplicationId) | O | 0..N | This attribute contains the ProSe Application ID(s).
(NOTE) | | +| allowedSuffixNum | AllowedSuffixNum | O | 0..1 | This attribute contains the allowed number of suffixes. | | +| appLevelContainer | AppLevelContainer | O | 0..1 | This attribute contains an application level container. | | +| rpauid | Rpauid | O | 0..1 | This attribute contains the RPAUID. | | +| targetRpauid | Rpauid | O | 0..1 | This attribute contains the Target RPAUID. | | +| authUpdateCallbackUri | Uri | O | 0..1 | The call-back URI of the NF service consumer (i.e. 5G DDNMF) for implicit subscription to notification of DiscoveryAuthorizationUpdateNotify. | | + +NOTE: If provided, at least one element shall be present in the attribute "proseAppId". + +##### 6.1.6.2.3 Type: AuthDisResData + +Table 6.1.6.2.3-1: Definition of type AuthDisResData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|---------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------|---------------| +| authResponseType | AuthResponseType | M | 1 | This attribute contains the authorization response type for 5G ProSe Direct Discovery. | | +| proseAppCodeSuffixPool | ProseApplicationCodeSuffixPool | O | 0..1 | This attribute contains the ProSe Application Code Suffix Pool. | | +| pduids | array(Pduid) | O | 0..N | This attribute contains the PDUID(s) corresponding to the provided RPAUID. | | +| restrictedCodeSuffixPool | array(RestrictedCodeSuffixPool) | O | 0..N | This attribute contains a ProSe Restricted Code Suffix pool. (NOTE) | | +| proseAppMasks | array(ProseApplicationMask) | O | 0..N | This attribute contains the mask(s) for the ProSe Application Code Suffix(es) corresponding to the ProSe Application ID. | | +| proSeRestrictedMasks | array(ProSeRestrictedMask) | O | 0..N | This attribute contains the mask(s) for the ProSe Restricted Code Suffix(es) corresponding to each of the Target RPAUID(s). | | +| resAppLevelContainer | AppLevelContainer | O | 0..1 | This attribute contains the Application Level Container. | | +| targetDataSet | array(TargetData) | O | 0..N | This attribute contains N sets of Target PDUID - Target RPAUID - Metadata Indicator. | | +| targetPduid | Pduid | O | 0..1 | This attribute contains the Target PDUID. | | +| metaData | MetaData | O | 0..1 | This attribute contains metadata corresponding to the Target PDUID. | | + +NOTE: If provided, exactly one element shall be present in the attribute. + +##### 6.1.6.2.4 Type: TargetData + +Table 6.1.6.2.4-1: Definition of type TargetData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| targetRpauid | Rpauid | M | 1 | This attribute contains the RPAUID. | | +| pduid | Pduid | M | 1 | This attribute contains the Target PDUID. | | +| metadataIndic | MetadataIndic | O | 0..1 | This attribute is optional and contains the Metadata Indicator to indicate whether there is metadata associated with the RPAUID, and if so, whether updates of metadata is allowed. (NOTE) | | + +NOTE: The default value of metadataIndic is "NO\_METADATA" if this attribute is not supplied. + +##### 6.1.6.2.5 Type: AuthUpdateData + +Table 6.1.6.2.5-1: Definition of type AuthUpdateData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| targetRpauid | Rpauid | M | 1 | This attribute contains the RPAUID of the user that would like to revoke discovery permissions of some other users in the AF. | | +| bannedAuthData | array(BannedAuthData) | M | 1..N | The attribute contains N sets of Banned RPAUID - Banned PDUID that are no longer allowed to discover the ProSe Restricted Code corresponding to the user's RPAUID for the Application ID associated with that AF. | | + +##### 6.1.6.2.6 Type: BannedAuthData + +Table 6.1.6.2.6-1: Definition of type BannedAuthData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| bannedRpauid | Rpauid | M | 1 | The attribute contains a RPAUID within a Banned RPAUID - Banned PDUID set that is no longer allowed to discover the ProSe Restricted Code corresponding to the user's RPAUID for the Application ID associated with the AF. | | +| bannedPduid | Pduid | M | 1 | The attribute contains the PDUID within a Banned RPAUID - Banned PDUID set that is no longer allowed to discover the ProSe Restricted Code corresponding to the user's RPAUID for the Application ID associated with the AF. | | +| revocationResult | RevocationResult | C | 0..1 | The attribute contains the revocation result of a set of Banned RPAUID - Banned PDUID for Restricted ProSe Direct Discovery, which is only conveyed in within a DiscoveryAuthorizationResultUpdate service operation | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|---------------------|-----------------|-------------------------------------------|---------------| +| AllowedSuffixNum | integer | Contains the allowed number of suffixes. | | +| AppLevelContainer | string | Contains the Application Level Container. | | +| ProSeRestrictedMask | string | Contains a ProSe Restricted Mask. | | + +##### 6.1.6.3.3 Enumeration: AuthRequestType + +The enumeration AuthRequestType represents the Authorization Request Type. It shall comply with the provisions of table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration AuthRequestType** + +| Enumeration value | Description | Applicability | +|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------------|---------------| +| OPEN_DISCOVERY_EXTENSION_ANNOUNCE | Indicates that the Authorization Request Type is "open discovery with application-controlled extension/announce". | | +| RESTRICTED_DISCOVERY_ANNOUNCE | Indicates that the Authorization Request Type is "restricted discovery/announce". | | +| RESTRICTED_DISCOVERY_EXTENSION_ANNOUNCE | Indicates that the Authorization Request Type is "restricted discovery with application-controlled extension/announce". | | +| OPEN_DISCOVERY_EXTENSION_MONITOR | Indicates that the Authorization Request Type is "open discovery with application-controlled extension/monitor". | | +| RESTRICTED_DISCOVERY_MONITOR | Indicates that the Authorization Request Type is "restricted discovery/monitor". | | +| RESTRICTED_DISCOVERY_EXTENSION_MONITOR | Indicates that the Authorization Request Type is "restricted discovery with application-controlled extension/monitor". | | +| RESTRICTED_DISCOVERY_PERMISSION | Indicates that the Authorization Request Type is "restricted discovery/permission". | | +| RESTRICTED_DISCOVERY_RESPONSE | Indicates that the Authorization Request Type is "restricted discovery/response". | | +| RESTRICTED_DISCOVERY_QUERY | Indicates that the Authorization Response Type is "restricted discovery/query". | | +| RESTRICTED_DISCOVERY_MATCH | Indicates that the Authorization Response Type is "restricted discovery/match". | | + +##### 6.1.6.3.4 Enumeration: AuthResponseType + +The enumeration AuthRequestType represents the Authorization Response Type. It shall comply with the provisions defined in table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: Enumeration AuthResponseType** + +| Enumeration value | Description | Applicability | +|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|---------------| +| OPEN_DISCOVERY_EXTENSION_ANNOUNCE_ACK | Indicates that the Authorization Response Type is "open discovery with application-controlled extension/announce ack". | | +| RESTRICTED_DISCOVERY_ANNOUNCE_ACK | Indicates that the Authorization Response Type is "restricted discovery/announce ack". | | +| RESTRICTED_DISCOVERY_EXTENSION_ANNOUNCE_ACK | Indicates that the Authorization Response Type is "restricted discovery with application-controlled extension/announce ack". | | +| OPEN_DISCOVERY_EXTENSION_MONITOR_ACK | Indicates that the Authorization Response Type is "open discovery with application-controlled extension/monitor ack". | | +| RESTRICTED_DISCOVERY_MONITOR_ACK | Indicates that the Authorization Response Type is "restricted discovery/monitor ack". | | +| RESTRICTED_DISCOVERY_EXTENSION_MONITOR_ACK | Indicates that the Authorization Response Type is "restricted discovery with application-controlled extension/monitor ack". | | +| RESTRICTED_DISCOVERY_PERMISSION_ACK | Indicates that the Authorization Response Type is "restricted discovery /permission ack". | | +| RESTRICTED_DISCOVERY_RESPONSE_ACK | Indicates that the Authorization Response Type is "restricted discovery /response ack". | | +| RESTRICTED_DISCOVERY_QUERY_ACK | Indicates that the Authorization Response Type is "restricted discovery /query ack". | | +| RESTRICTED_DISCOVERY_MATCH_ACK | Indicates that the Authorization Response Type is "restricted discovery /match ack". | | + +##### 6.1.6.3.5 Enumeration: MetadataIndic + +The enumeration MetadataIndic represents the possible options for metadata associated with a particular target RPAUID. It shall comply with the provisions of table 6.1.6.3.5-1. + +**Table 6.1.6.3.5-1: Enumeration MetadataIndic** + +| Enumeration value | Description | Applicability | +|----------------------------|--------------------------------------------------------------------------------------------------------------------|---------------| +| NO_METADATA | Indicates that there is no metadata associated with the target RPAUID. | | +| METADATA_UPDATE_DISALLOWED | Indicates that there is metadata associated with the target RPAUID, but it is not allowed to update this metadata. | | +| METADATA_UPDATE_ALLOWED | Indicates that there is metadata associated with the target RPAUID, and it is allowed to update this metadata. | | + +##### 6.1.6.3.6 Enumeration: RevocationResult + +The enumeration RevocationResult represents the revocation result of a set of Banned RPAUID - Banned PDUID for Restricted ProSe Direct Discovery. It shall comply with the provisions of table 6.1.6.3.6-1. + +**Table 6.1.6.3.6-1: Enumeration MetadataIndic** + +| Enumeration value | Description | Applicability | +|---------------------------|-------------------------------------------------------------------------------------------------------------------------|---------------| +| REVOCATION_SUCCESSFUL | Indicates the successful revocation for a set of Banned RPAUID - Banned PDUID for Restricted ProSe Direct Discovery. | | +| REVOCATION_NOT_SUCCESSFUL | Indicates that unsuccessful revocation for a set of Banned RPAUID - Banned PDUID for Restricted ProSe Direct Discovery. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +None. + +#### 6.1.6.5 Binary data + +None. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Naf\_ProSe API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Naf\_ProSe API. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Naf\_ProSe service are listed in table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-----------------------------------------------------| +| UNSPECIFIED | 403 Forbidden | The request is rejected due to unspecified reasons. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Naf\_ProSe API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Naf\_ProSe API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Naf\_ProSe API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF service consumer used for discovering the Naf\_ProSe service. + +The Naf\_ProSe API defines a single scope "naf\_prose" for OAuth2 authorization (as specified in 3GPP TS 33.501 [8]) for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]). + +## A.2 Naf\_ProSe API + +``` +openapi: 3.0.0 + +info: + title: Naf_ProSe API + version: 1.1.0-alpha.2 + description: | + Naf_ProSe Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.557 V18.1.0; 5G System; Application Function ProSe Service; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.557/ + +servers: + - url: '{apiRoot}/naf-prose/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - naf-prose + +paths: + /authorize-discovery: + post: + summary: Obtain the authorization of Discovery Request from 5G DDNMF for a UE + operationId: ObtainDiscAuth + tags: + - Obtain the authorization of Discovery Request for a UE + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthDisReqData' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/AuthDisResData' +``` + +``` +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error +callbacks: + DiscoveryAuthorizationUpdateNotify: + '{ $request.body#/authUpdateCallbackUri }': + post: + requestBody: + description: > + update of authorization information to revoke discovery permissions + relating to some other users in the NF consumer for Restricted ProSe Direct Discovery + content: + application/json: + schema: + $ref: '#/components/schemas/AuthUpdateData' +responses: + '204': + description: Expected response to a valid notification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/authorization-update-result: + post: + summary: > + report the result of update of authorization information to revoke discovery + permissions relating to some other users in the NF consumer for Restricted ProSe Direct +``` + +``` + + Discovery + operationId: AuthorizationUpdateResult + tags: + - Authorization Information Update Result + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthUpdateData' + required: true + responses: + '204': + description: Expected response to a successful cancellation + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + naf-prose: Access to the Naf_ProSe API + +schemas: + +# COMPLEX TYPES: + +AuthDisReqData: + type: object + description: > + Represents Data used to request the authorization for a UE of a 5G ProSe Direct + Discovery request. + required: + - authRequestType + properties: + authRequestType: + $ref: '#/components/schemas/AuthRequestType' + proseAppId: + type: array + items: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/ProseApplicationId' + allowedSuffixNum: + $ref: '#/components/schemas/AllowedSuffixNum' + appLevelContainer: + $ref: '#/components/schemas/AppLevelContainer' + rpauid: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/Rpauid' + +``` + +``` +targetRpauid: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/Rpauid' +authUpdateCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +AuthDisResData: + type: object + description: > + Represents the obtained authorization Data for a UE of a 5G ProSe Direct Discovery + request. + required: + - authResponseType + properties: + authResponseType: + $ref: '#/components/schemas/AuthResponseType' + proseAppCodeSuffixPool: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/ProseApplicationCodeSuffixPool' + pduids: + type: array + items: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/Pduid' + restrictedCodeSuffixPool: + type: array + items: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/RestrictedCodeSuffixPool' + proseAppMasks: + type: array + items: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/ProseApplicationMask' + proSeRestrictedMasks: + type: array + items: + $ref: '#/components/schemas/ProSeRestrictedMask' + resAppLevelContainer: + $ref: '#/components/schemas/AppLevelContainer' + targetDataSet: + type: array + items: + $ref: '#/components/schemas/TargetData' + targetPduid: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/Pduid' + metaData: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/MetaData' + +TargetData: + type: object + description: Represents a set of Target PDUID - Target RPAUID - Metadata Indicator. + required: + - targetRpauid + - pduid + properties: + targetRpauid: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/Rpauid' + pduid: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/Pduid' + metadataIndic: + $ref: '#/components/schemas/MetadataIndic' + +AuthUpdateData: + type: object + description: > + Represents the update data and resulting update data of authorization information + for Restricted ProSe Direct Discovery. + required: + - targetRpauid + - bannedAuthData + properties: + targetRpauid: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/Rpauid' + bannedAuthData: + type: array + items: + $ref: '#/components/schemas/BannedAuthData' + minItems: 1 + +BannedAuthData: + type: object + description: Represents a set of Banned PDUID - Banned RPAUID. +``` + +``` +required: + - bannedRpuid + - bannedPduid +properties: + bannedRpuid: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/Rpuid' + bannedPduid: + $ref: 'TS29555_N5g-ddnmf_Discovery.yaml#/components/schemas/Pduid' + revocationResult: + $ref: '#/components/schemas/RevocationResult' +``` + +### # SIMPLE TYPES: + +``` +AllowedSuffixNum: + description: contains the allowed number of suffixes. + type: integer + +AppLevelContainer: + description: Contains the Application Level Container. + type: string + +ProSeRestrictedMask: + description: Contains a ProSe Restricted Mask. + type: string +``` + +### # ENUMS: + +``` +AuthRequestType: + anyOf: + - type: string + enum: + - OPEN_DISCOVERY_EXTENSION_ANNOUNCE + - RESTRICTED_DISCOVERY_ANNOUNCE + - RESTRICTED_DISCOVERY_EXTENSION_ANNOUNCE + - OPEN_DISCOVERY_EXTENSION_MONITOR + - RESTRICTED_DISCOVERY_MONITOR + - RESTRICTED_DISCOVERY_EXTENSION_MONITOR + - RESTRICTED_DISCOVERY_PERMISSION + - RESTRICTED_DISCOVERY_RESPONSE + - RESTRICTED_DISCOVERY_QUERY + - RESTRICTED_DISCOVERY_MATCH + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents the authorization request type. + Possible values are: + - OPEN_DISCOVERY_EXTENSION_ANNOUNCE: Indicates that the Authorization Request Type is + open discovery with application-controlled extension/announce. + - RESTRICTED_DISCOVERY_ANNOUNCE: Indicates that the Authorization Request Type is restricted + discovery/announce. + - RESTRICTED_DISCOVERY_EXTENSION_ANNOUNCE: Indicates that the Authorization Request Type is + restricted discovery with application-controlled extension/announce. + - OPEN_DISCOVERY_EXTENSION_MONITOR: Indicates that the Authorization Request Type is open + discovery with application-controlled extension/monitor. + - RESTRICTED_DISCOVERY_MONITOR: Indicates that the Authorization Request Type is restricted + discovery/monitor. + - RESTRICTED_DISCOVERY_EXTENSION_MONITOR: Indicates that the Authorization Request Type is + restricted discovery with application-controlled extension/monitor. + - RESTRICTED_DISCOVERY_PERMISSION: Indicates that the Authorization Request Type is + restricted discovery/permission. + - RESTRICTED_DISCOVERY_RESPONSE: Indicates that the Authorization Request Type is restricted + discovery/response. + - RESTRICTED_DISCOVERY_QUERY: Indicates that the Authorization Request Type is restricted + discovery/query. + - RESTRICTED_DISCOVERY_MATCH: Indicates that the Authorization Request Type is restricted + discovery/match. +``` + +``` +AuthResponseType: + anyOf: + - type: string + enum: + - OPEN_DISCOVERY_EXTENSION_ANNOUNCE_ACK + - RESTRICTED_DISCOVERY_ANNOUNCE_ACK + - RESTRICTED_DISCOVERY_EXTENSION_ANNOUNCE_ACK + - OPEN_DISCOVERY_EXTENSION_MONITOR_ACK + - RESTRICTED_DISCOVERY_MONITOR_ACK +``` + +- RESTRICTED\_DISCOVERY\_EXTENSION\_MONITOR\_ACK +- RESTRICTED\_DISCOVERY\_PERMISSION\_ACK +- RESTRICTED\_DISCOVERY\_RESPONSE\_ACK +- RESTRICTED\_DISCOVERY\_QUERY\_ACK +- RESTRICTED\_DISCOVERY\_MATCH\_ACK +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. +- description: | +Represents the authorization response type. +Possible values are: + - OPEN\_DISCOVERY\_EXTENSION\_ANNOUNCE\_ACK: Indicates that the Authorization Response Type is open discovery with application-controlled extension/announce ack. + - RESTRICTED\_DISCOVERY\_ANNOUNCE\_ACK: Indicates that the Authorization Response Type is restricted discovery/announce ack. + - RESTRICTED\_DISCOVERY\_EXTENSION\_ANNOUNCE\_ACK: Indicates that the Authorization Response Type is restricted discovery with application-controlled extension/announce ack. + - OPEN\_DISCOVERY\_EXTENSION\_MONITOR\_ACK: Indicates that the Authorization Response Type is open discovery with application-controlled extension/monitor ack. + - RESTRICTED\_DISCOVERY\_MONITOR\_ACK: Indicates that the Authorization Response Type is restricted discovery/monitor ack. + - RESTRICTED\_DISCOVERY\_EXTENSION\_MONITOR\_ACK: Indicates that the Authorization Response Type is restricted discovery with application-controlled extension/monitor ack. + - RESTRICTED\_DISCOVERY\_PERMISSION\_ACK: Indicates that the Authorization Response Type is restricted discovery/permission ack. + - RESTRICTED\_DISCOVERY\_RESPONSE\_ACK: Indicates that the Authorization Response Type is restricted discovery/response ack. + - RESTRICTED\_DISCOVERY\_QUERY\_ACK: Indicates that the Authorization Response Type is restricted discovery/query ack. + - RESTRICTED\_DISCOVERY\_MATCH\_ACK: Indicates that the Authorization Response Type is restricted discovery/match ack. + +### MetadataIndic: + +- anyOf: + - type: string +enum: + - NO\_METADATA + - METADATA\_UPDATE\_DISALLOWED + - METADATA\_UPDATE\_ALLOWED + - type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. +- description: | +Represents the Metadata Indicator. +Possible values are: + - NO\_METADATA: This value may be used to indicate that there is no metadata associated with the target RPAUID. This is the default value applicable if this IE is not supplied. + - METADATA\_UPDATE\_DISALLOWED: This value shall be used to indicate that there exists metadata associated with the target RPAUID, but the metadata is not allowed to be updated. + - METADATA\_UPDATE\_ALLOWED: This value shall be used to indicate that there exists metadata associated with the target RPAUID, and the metadata is allowed to be updated. + +### RevocationResult: + +- anyOf: + - type: string +enum: + - REVOCATION\_SUCCESSFUL + - REVOCATION\_NOT\_SUCCESSFUL + - type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. +- description: | +Represents the revocation result of a set of Banned RPAUID - Banned PDUUID for Restricted ProSe Direct Discovery. +Possible values are: + - REVOCATION\_SUCCESSFUL: Indicates the successful revocation for a set of Banned RPAUID - Banned PDUUID for Restricted ProSe Direct Discovery. + - REVOCATION\_NOT\_SUCCESSFUL: Indicates that unsuccessful revocation for a set of Banned RPAUID - Banned PDUUID for Restricted ProSe Direct Discovery. + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|------------------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-04 | CT3#115-e | C3-212446 | | | | Draft skeleton provided by the rapporteur. | 0.0.0 | +| 2021-05 | CT3#116-e | C3-213504 | | | | Implementing the following p-CR agreed by CT3:
C3-212447
Editorial change from the rapporteur.
Specification number added. | 0.1.0 | +| 2021-08 | CT3#117-e | C3-214590 | | | | Implementing the following p-CR agreed by CT3:
C3-214021 and C3-214022.
Editorial change from the rapporteur. | 0.2.0 | +| 2021-09 | CT3#117-e | C3-214590 | | | | Change filename – removed Stable | 0.2.1 | +| 2021-09 | CT#93-e | CP-212188 | | | | The p-CRs are agreed in CT#93-e. | 0.2.1 | +| 2021-10 | CT3#118-e | C3-215453 | | | | Implementing the following p-CR agreed by CT3:
C3-215453 | 0.3.0 | +| 2021-12 | CT#94-e | CP-213209 | | | | Presentation for information | 1.0.0 | +| 2022-01 | CT3#119bis
-e | C3-220451 | | | | Implementing the following p-CR agreed by CT3:
C3-220417 | 1.1.0 | +| 2022-02 | CT3#120-e | C3-221556 | | | | Implementing the following p-CR agreed by CT3:
C3-221166 | 1.2.0 | +| 2022-03 | CT#95e | CP-220157 | | | | Presentation to TSG CT for approval | 2.0.0 | +| 2022-03 | CT#95e | CP-220157 | | | | Approved by TSG CT | 17.0.0 | +| 2022-06 | CT#96 | CP-221116 | 0001 | 1 | F | Adding the missing description fields in the OpenAPI file | 17.1.0 | +| 2022-06 | CT#96 | CP-221116 | 0002 | 1 | F | Miscellaneous corrections | 17.1.0 | +| 2022-06 | CT#96 | CP-221116 | 0003 | | F | API URI of the Naf_ProSe API | 17.1.0 | +| 2022-06 | CT#96 | CP-221152 | 0004 | | F | Update of info and externalDocs fields | 17.1.0 | +| 2022-09 | CT#97e | CP-222132 | 0005 | 1 | F | Application errors reference update in the tables defining methods on the resources for Naf_ProSe API | 17.2.0 | +| 2022-12 | CT#98e | CP-223162 | 0007 | 1 | F | Correction to AuthDisResData data type | 17.3.0 | +| 2022-12 | CT#98e | CP-223162 | 0008 | 1 | F | Correction to AuthDisReqData data type | 17.3.0 | +| 2022-12 | CT#98e | CP-223162 | 0009 | 1 | F | Corrections to DiscoveryAuthorization service operation | 17.3.0 | +| 2022-12 | CT#98e | CP-223162 | 0011 | 1 | F | Add the missing status codes for the HTTP operations | 17.3.0 | +| 2022-12 | CT#98e | CP-223162 | 0012 | 1 | F | Corrections for data types and API of Naf_ProSe service | 17.3.0 | +| 2022-12 | CT#98e | CP-223188 | 0017 | | F | Update of info and externalDocs fields | 17.3.0 | +| 2022-12 | CT#98e | CP-223191 | 0006 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0010 | 1 | F | Enumeration definitions in the OpenAPI file | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0013 | 1 | F | Update for the Naf_ProSe Service architecture | 18.0.0 | +| 2022-12 | CT#98e | CP-223190 | 0018 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230166 | 0019 | | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0020 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-12 | CT#102 | CP-233229 | 0021 | 1 | F | HTTP RFC uplifting | 18.2.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29558/raw.md b/raw/rel-18/29_series/29558/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..9d03fe3a90a48a506070c44d77254e07c1f7a922 --- /dev/null +++ b/raw/rel-18/29_series/29558/raw.md @@ -0,0 +1,13738 @@ + + +# 3GPP TS 29.558 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Enabling Edge Applications; Application Programming Interface (API) specification; Stage 3; (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green wave-like signal icon above the 'G', and the word 'ADVANCED' in smaller black letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'P' has a red signal icon at its base. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, sans-serif font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. + +The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. + +This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword..... | 16 | +| 1 Scope..... | 18 | +| 2 References..... | 18 | +| 3 Definitions of terms, symbols and abbreviations..... | 19 | +| 3.1 Terms..... | 19 | +| 3.2 Symbols..... | 19 | +| 3.3 Abbreviations..... | 19 | +| 4 Overview..... | 20 | +| 5 Services offered by Edge Enabler Server..... | 20 | +| 5.1 Introduction..... | 20 | +| 5.2 Eees_EASRegistration Service..... | 22 | +| 5.2.1 Service Description..... | 22 | +| 5.2.2 Service Operations..... | 22 | +| 5.2.2.1 Introduction..... | 22 | +| 5.2.2.2 Eees_EASRegistration_Request..... | 23 | +| 5.2.2.2.1 General..... | 23 | +| 5.2.2.2.2 EAS registering to EES using Eees_EASRegistration_Request operation..... | 23 | +| 5.2.2.3 Eees_EASRegistration_Update..... | 23 | +| 5.2.2.3.1 General..... | 23 | +| 5.2.2.3.2 EAS updating registration information using Eees_EASRegistration_Update operation..... | 23 | +| 5.2.2.4 Eees_EASRegistration_Deregister..... | 24 | +| 5.2.2.4.1 General..... | 24 | +| 5.2.2.4.2 EAS deregistering from EES using Eees_EASRegistration_Deregister operation..... | 24 | +| 5.3 Eees_UELocation Service..... | 25 | +| 5.3.1 Service Description..... | 25 | +| 5.3.2 Service Operations..... | 25 | +| 5.3.2.1 Introduction..... | 25 | +| 5.3.2.2 Eees_UELocation_Get..... | 25 | +| 5.3.2.2.1 General..... | 25 | +| 5.3.2.2.2 EAS obtaining UE location information from EES using Eees_UELocation_Get operation..... | 25 | +| 5.3.2.2.3 User consent management..... | 26 | +| 5.3.2.3 Eees_UELocation_Subscribe..... | 26 | +| 5.3.2.3.1 General..... | 26 | +| 5.3.2.3.2 EAS subscribing to continuous UE(s) location reporting from EES using Eees_UELocation_Subscribe operation..... | 26 | +| 5.3.2.3.3 User consent management..... | 27 | +| 5.3.2.4 Eees_UELocation_Notify..... | 28 | +| 5.3.2.4.1 General..... | 28 | +| 5.3.2.4.2 EES notifying the UE(s) location reporting to EAS using Eees_UELocation_Notify operation..... | 28 | +| 5.3.2.4.3 EES notifying the EAS about user consent revocation using Eees_UELocation_Notify operation..... | 28 | +| 5.3.2.5 Eees_UELocation_UpdateSubscription..... | 29 | +| 5.3.2.5.1 General..... | 29 | +| 5.3.2.5.2 EAS updating continuous UE(s) location reporting subscription at EES using Eees_UELocation_UpdateSubscribe operation..... | 29 | +| 5.3.2.5.3 User consent management..... | 29 | +| 5.3.2.6 Eees_UELocation_Unsubscribe..... | 30 | +| 5.3.2.6.1 General..... | 30 | +| 5.3.2.6.2 EAS unsubscribing to continuous UE(s) location reporting from EES using Eees_UELocation_Unsubscribe operation..... | 30 | +| 5.4 Eees_UEIdentifier Service..... | 31 | +| 5.4.1 Service Description..... | 31 | +| 5.4.2 Service Operations..... | 31 | +| 5.4.2.1 Introduction..... | 31 | +| 5.4.2.2 Eees_UEIdentifier_Get..... | 31 | + +| | | | +|------------|---------------------------------------------------------------------------------------------------------------------------------------------|----| +| 5.4.2.2.1 | General..... | 31 | +| 5.4.2.2.1A | EAS obtaining UE Identifier Information using "Get" custom operation..... | 31 | +| 5.4.2.2.2 | EAS obtaining UE identifier from EES using Eees_UEIdentifier_"Fetch" custom operation..... | 32 | +| 5.5 | Eees_AppClientInformation Service..... | 32 | +| 5.5.1 | Service Description..... | 32 | +| 5.5.2 | Service Operations..... | 32 | +| 5.5.2.1 | Introduction..... | 32 | +| 5.5.2.2 | Eees_AppClientInformation_Subscribe..... | 33 | +| 5.5.2.2.1 | General..... | 33 | +| 5.5.2.2.2 | EAS subscribing to AC information reporting from EES using
Eees_AppClientInformation_Subscribe operation..... | 33 | +| 5.5.2.3 | Eees_AppClientInformation_Notify..... | 33 | +| 5.5.2.3.1 | General..... | 33 | +| 5.5.2.3.2 | EES notifying the AC information to EAS using Eees_AppClientInformation_Notify
operation..... | 34 | +| 5.5.2.4 | Eees_AppClientInformation_UpdateSubscription..... | 34 | +| 5.5.2.4.1 | General..... | 34 | +| 5.5.2.4.2 | EAS updating AC information reporting subscription at EES using
Eees_AppClientInformation_UpdateSubscribe operation..... | 34 | +| 5.5.2.5 | Eees_AppClientInformation_Unsubscribe..... | 35 | +| 5.5.2.5.1 | General..... | 35 | +| 5.5.2.5.2 | EAS unsubscribing to AC information reporting from EES using
Eees_AppClientInformation_Unsubscribe operation..... | 35 | +| 5.6 | Eees_SessionWithQoS Service..... | 35 | +| 5.6.1 | Service Description..... | 35 | +| 5.6.2 | Service Operations..... | 35 | +| 5.6.2.1 | Introduction..... | 35 | +| 5.6.2.2 | Eees_SessionWithQoS_Create..... | 36 | +| 5.6.2.2.1 | General..... | 36 | +| 5.6.2.2.2 | EAS requesting reservation of resources for a data session between AC and EAS with
specific QoS using Eees_SessionWithQoS operation..... | 36 | +| 5.6.2.3 | Eees_SessionWithQoS_Update..... | 37 | +| 5.6.2.3.1 | General..... | 37 | +| 5.6.2.3.2 | EAS updating QoS of a data session between AC and EAS using
Eees_SessionWithQoS_Update operation..... | 37 | +| 5.6.2.4 | Eees_SessionWithQoS_Revoke..... | 38 | +| 5.6.2.4.1 | General..... | 38 | +| 5.6.2.4.2 | EAS revoking QoS of a data session between AC and EAS using
Eees_SessionWithQoS_Revoke operation..... | 38 | +| 5.6.2.5 | Eees_SessionWithQoS_Notify..... | 38 | +| 5.6.2.5.1 | General..... | 38 | +| 5.6.2.5.2 | EES notifying QoS of a data session between AC and EAS using
Eees_SessionWithQoS_Notify operation..... | 39 | +| 5.7 | Eees_EASDiscovery Service..... | 39 | +| 5.7.1 | Service Description..... | 39 | +| 5.7.2 | Service Operations..... | 39 | +| 5.7.2.1 | Introduction..... | 39 | +| 5.7.2.2 | Eees_EASDiscovery_TEasDiscRequest..... | 39 | +| 5.7.2.2.1 | General..... | 39 | +| 5.7.2.2.2 | EES or EAS requesting T-EAS discovery information using
Eees_EASDiscovery_TEasDiscRequest operation..... | 39 | +| 5.8 | Eees_ACRManagementEvent Service..... | 40 | +| 5.8.1 | Service Description..... | 40 | +| 5.8.2 | Service Operations..... | 40 | +| 5.8.2.1 | Introduction..... | 40 | +| 5.8.2.2 | Eees_ACRManagementEvent_Subscribe..... | 40 | +| 5.8.2.2.1 | General..... | 40 | +| 5.8.2.2.2 | EAS requesting to get notifications of ACR management events using
Eees_ACRManagementEvent_Subscribe service operation..... | 41 | +| 5.8.2.3 | Eees_ACRManagementEvent_UpdateSubscription..... | 42 | +| 5.8.2.3.1 | General..... | 42 | + +| | | | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| 5.8.2.3.2 | EAS updating an existing Individual ACR Management Events Subscription using Eees_ACRManagementEvent_UpdateSubscription service operation..... | 42 | +| 5.8.2.4 | Eees_ACRManagementEvent_Unsubscribe..... | 43 | +| 5.8.2.4.1 | General..... | 43 | +| 5.8.2.4.2 | EAS deleting an existing Individual ACR Management Events Subscription using Eees_ACRManagementEvent_Unsubscribe service operation..... | 43 | +| 5.8.2.5 | Eees_ACRManagementEvent_Notify..... | 43 | +| 5.8.2.5.1 | General..... | 43 | +| 5.8.2.5.2 | EES notifying ACR management events using Eees_ACRManagementEvent_Notify operation..... | 44 | +| 5.8.2.5.3 | EES notifying the availability of user path management events monitoring via the 3GPP 5GC network using Eees_ACRManagementEvent_Notify operation..... | 44 | +| 5.9 | Eees_AppContextRelocation Service..... | 44 | +| 5.9.1 | Service Description..... | 44 | +| 5.9.2 | Service Operations..... | 44 | +| 5.9.2.1 | Introduction..... | 44 | +| 5.9.2.2 | Eees_AppContextRelocation_SelectedTargetEAS_Declare..... | 45 | +| 5.9.2.2.1 | General..... | 45 | +| 5.9.2.2.2 | S-EAS informing the S-EES about the selected T-EAS using Eees_AppContextRelocation_SelectedTargetEAS_Declare operation..... | 45 | +| 5.9.2.3 | Eees_AppContextRelocation_ACRDetermination_Request..... | 45 | +| 5.9.2.3.1 | General..... | 45 | +| 5.9.2.3.2 | S-EAS request the S-EES to determine the ACR using Eees_AppContextRelocation_ACRDetermination_Request operation..... | 45 | +| 5.10 | Eees_EECContextRelocation Service..... | 46 | +| 5.10.1 | Service Description..... | 46 | +| 5.10.2 | Service Operations..... | 46 | +| 5.10.2.1 | Introduction..... | 46 | +| 5.10.2.2 | Eees_EECContextRelocation_Pull..... | 46 | +| 5.10.2.2.1 | General..... | 46 | +| 5.10.2.2.2 | T-EES relocating EEC context information from a service consumer S-EES or CES to T-EES using Eees_EECContextRelocation_Pull operation..... | 47 | +| 5.10.2.3 | Eees_EECContextRelocation_Push..... | 47 | +| 5.10.2.3.1 | General..... | 47 | +| 5.10.2.3.2 | Service consumer relocating EEC context information from the service consumer to T-EES using Eees_EECContextRelocation_Push operation..... | 47 | +| 5.11 | Eees_EELManagedACR Service..... | 48 | +| 5.11.1 | Service Description..... | 48 | +| 5.11.2 | Service Operations..... | 48 | +| 5.11.2.1 | Introduction..... | 48 | +| 5.11.2.2 | Eees_EELManagedACR_Request..... | 48 | +| 5.11.2.2.1 | General..... | 48 | +| 5.11.2.2.2 | EEL Managed ACR Request..... | 48 | +| 5.11.2.3 | Eees_EELManagedACR_Subscribe..... | 49 | +| 5.11.2.3.1 | General..... | 49 | +| 5.11.2.3.2 | Subscribe to ACT status information reporting..... | 49 | +| 5.11.2.4 | Eees_EELManagedACR_Notify..... | 49 | +| 5.11.2.4.1 | General..... | 49 | +| 5.11.2.4.2 | ACT Status Notification..... | 49 | +| 5.12 | Eees_ACRStatusUpdate Service..... | 50 | +| 5.12.1 | Service Description..... | 50 | +| 5.12.2 | Service Operations..... | 50 | +| 5.12.2.1 | Introduction..... | 50 | +| 5.12.2.2 | Eees_ACRStatusUpdate_Request..... | 50 | +| 5.12.2.2.1 | General..... | 50 | +| 5.12.2.2.2 | ACR Status Update Request..... | 50 | +| 5.13 | Eees_ACRParameterInformation Service..... | 51 | +| 5.13.1 | Service Description..... | 51 | +| 5.13.2 | Service Operations..... | 51 | +| 5.13.2.1 | Introduction..... | 51 | +| 5.13.2.2 | Eees_ACRParameterInformation_Request..... | 51 | + +| | | | +|------------|----------------------------------------------------------------------------------------------------------------------|----| +| 5.13.2.2.1 | General..... | 51 | +| 5.13.2.2.2 | ACR Parameter Information Request..... | 51 | +| 5.14 | Eees_CommonEASAnnouncement Service..... | 52 | +| 5.14.1 | Service Description..... | 52 | +| 5.14.2 | Service Operations..... | 52 | +| 5.14.2.1 | Introduction..... | 52 | +| 5.14.2.2 | Eees_CommonEASAnnouncement_Declare..... | 52 | +| 5.14.2.2.1 | General..... | 52 | +| 5.14.2.2.2 | Declare Common EAS Information Request..... | 52 | +| 6 | Services offered by Edge Configuration Server..... | 53 | +| 6.1 | Introduction..... | 53 | +| 6.2 | Eecs_EESRegistration Service..... | 53 | +| 6.2.1 | Service Description..... | 53 | +| 6.2.2 | Service Operations..... | 53 | +| 6.2.2.1 | Introduction..... | 53 | +| 6.2.2.2 | Eecs_EESRegistration_Request..... | 54 | +| 6.2.2.2.1 | General..... | 54 | +| 6.2.2.2.2 | EES registering to ECS using Eecs_EESRegistration_Request operation..... | 54 | +| 6.2.2.3 | Eecs_EESRegistration_Update..... | 54 | +| 6.2.2.3.1 | General..... | 54 | +| 6.2.2.3.2 | EES updating registration information using Eecs_EESRegistration_Update operation..... | 54 | +| 6.2.2.4 | Eecs_EESRegistration_Deregister..... | 55 | +| 6.2.2.4.1 | General..... | 55 | +| 6.2.2.4.2 | EES deregistering from ECS using Eecs_EESRegistration_Deregister operation..... | 55 | +| 6.3 | Eecs_TargetEESDiscovery Service..... | 56 | +| 6.3.1 | Service Description..... | 56 | +| 6.3.2 | Service Operations..... | 56 | +| 6.3.2.1 | Introduction..... | 56 | +| 6.3.2.2 | Eecs_TargetEESDiscovery_Request..... | 56 | +| 6.3.2.2.1 | General..... | 56 | +| 6.3.2.2.2 | Service consumer fetching the T-EES information from the ECS using
Eecs_TargetEESDiscovery_Request operation..... | 56 | +| 6A | Service offered by CAS..... | 57 | +| 6A.1 | Introduction..... | 57 | +| 6A.2 | Ecas_SelectedEES Service..... | 57 | +| 6A.2.1 | Service Description..... | 57 | +| 6A.2.2 | Service Operations..... | 57 | +| 6A.2.2.1 | Introduction..... | 57 | +| 6A.2.2.2 | Ecas_SelectedEES_Request..... | 57 | +| 6A.2.2.2.1 | General..... | 57 | +| 6A.2.2.2.2 | Service consumer inform the CAS of the selected EES using Ecas_SelectedEES_Declare
operation..... | 58 | +| 7 | Information applicable to several APIs..... | 58 | +| 7.1 | General..... | 58 | +| 7.2 | Data Types..... | 58 | +| 7.2.1 | General..... | 58 | +| 7.2.2 | Referenced structured data types..... | 59 | +| 7.2.3 | Referenced simple data types and enumerations..... | 59 | +| 7.3 | Usage of HTTP..... | 59 | +| 7.4 | Content type..... | 59 | +| 7.5 | URI structure..... | 59 | +| 7.5.1 | Resource URI structure..... | 59 | +| 7.5.2 | Custom operations URI structure..... | 59 | +| 7.6 | Notifications..... | 60 | +| 7.7 | Error handling..... | 60 | +| 7.8 | Feature negotiation..... | 60 | +| 7.9 | HTTP headers..... | 60 | +| 7.10 | Conventions for Open API specification files..... | 60 | + +| | | | +|-------------|-------------------------------------------------------------|----| +| 8 | Edge Enabler Server API Definitions..... | 60 | +| 8.1 | Eees_EASRegistration API..... | 60 | +| 8.1.1 | Introduction..... | 60 | +| 8.1.2 | Resources..... | 61 | +| 8.1.2.1 | Overview..... | 61 | +| 8.1.2.2 | Resource: EAS Registrations..... | 62 | +| 8.1.2.2.1 | Description..... | 62 | +| 8.1.2.2.2 | Resource Definition..... | 62 | +| 8.1.2.2.3 | Resource Standard Methods..... | 62 | +| 8.1.2.2.3.1 | POST..... | 62 | +| 8.1.2.2.4 | Resource Custom Operations..... | 63 | +| 8.1.2.3 | Resource: Individual EAS Registration..... | 63 | +| 8.1.2.3.1 | Description..... | 63 | +| 8.1.2.3.2 | Resource Definition..... | 63 | +| 8.1.2.3.3 | Resource Standard Methods..... | 63 | +| 8.1.2.3.3.1 | GET..... | 63 | +| 8.1.2.3.3.2 | PUT..... | 64 | +| 8.1.2.3.3.3 | DELETE..... | 65 | +| 8.1.2.3.3.4 | PATCH..... | 66 | +| 8.1.2.3.4 | Resource Custom Operations..... | 67 | +| 8.1.3 | Custom Operations without associated resources..... | 67 | +| 8.1.4 | Notifications..... | 67 | +| 8.1.5 | Data Model..... | 67 | +| 8.1.5.1 | General..... | 67 | +| 8.1.5.2 | Structured data types..... | 69 | +| 8.1.5.2.1 | Introduction..... | 69 | +| 8.1.5.2.2 | Type: EASRegistration..... | 69 | +| 8.1.5.2.3 | Type: EASProfile..... | 70 | +| 8.1.5.2.4 | Type: EASServiceKPI..... | 72 | +| 8.1.5.2.5 | Type: EndPoint..... | 73 | +| 8.1.5.2.6 | Type: EASRegistrationPatch..... | 73 | +| 8.1.5.2.7 | Type: TransContSuppDetails..... | 73 | +| 8.1.5.2.8 | Type: EASBundleInfo..... | 73 | +| 8.1.5.2.9 | Type: EASBdlReqs..... | 74 | +| 8.1.5.2.10 | Type: CoordinatedAcrReqs..... | 74 | +| 8.1.5.3 | Simple data types and enumerations..... | 74 | +| 8.1.5.3.1 | Introduction..... | 74 | +| 8.1.5.3.2 | Simple data types..... | 74 | +| 8.1.5.3.3 | Enumeration: PermissionLevel..... | 75 | +| 8.1.5.3.4 | Enumeration: EASCategory..... | 75 | +| 8.1.5.3.5 | Enumeration: TransportProtocol..... | 75 | +| 8.1.5.3.6 | Enumeration: BdlType..... | 75 | +| 8.1.5.3.7 | Enumeration: Affinity..... | 76 | +| 8.1.5.3.8 | Enumeration: FailureAction..... | 76 | +| 8.1.6 | Error Handling..... | 76 | +| 8.1.7 | Feature negotiation..... | 76 | +| 8.2 | Eees_UELocation API..... | 76 | +| 8.2.1 | Introduction..... | 76 | +| 8.2.2 | Resources..... | 77 | +| 8.2.2.1 | Overview..... | 77 | +| 8.2.2.2 | Resource: Location Information Subscriptions..... | 78 | +| 8.2.2.2.1 | Description..... | 78 | +| 8.2.2.2.2 | Resource Definition..... | 78 | +| 8.2.2.2.3 | Resource Standard Methods..... | 78 | +| 8.2.2.2.3.1 | POST..... | 78 | +| 8.2.2.2.4 | Resource Custom Operations..... | 79 | +| 8.2.2.3 | Resource: Individual Location Information Subscription..... | 79 | +| 8.2.2.3.1 | Description..... | 79 | +| 8.2.2.3.2 | Resource Definition..... | 79 | +| 8.2.2.3.3 | Resource Standard Methods..... | 79 | +| 8.2.2.3.3.1 | GET..... | 79 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 8.2.2.3.3.2 | PATCH..... | 80 | +| 8.2.2.3.3.3 | PUT..... | 81 | +| 8.2.2.3.3.4 | DELETE..... | 82 | +| 8.2.2.3.4 | Resource Custom Operations..... | 83 | +| 8.2.3 | Custom Operations without associated resources..... | 83 | +| 8.2.3.1 | Overview..... | 83 | +| 8.2.3.2 | Operation: Fetch..... | 84 | +| 8.2.3.2.1 | Description..... | 84 | +| 8.2.3.2.2 | Operation Definition..... | 84 | +| 8.2.4 | Notifications..... | 85 | +| 8.2.4.1 | General..... | 85 | +| 8.2.4.2 | Location Information Notification..... | 86 | +| 8.2.4.2.1 | Description..... | 86 | +| 8.2.4.2.2 | Target URI..... | 86 | +| 8.2.4.2.3 | Standard Methods..... | 86 | +| 8.2.4.2.3.1 | POST..... | 86 | +| 8.2.4.3 | User Consent Revocation Notification..... | 87 | +| 8.2.4.3.1 | Description..... | 87 | +| 8.2.4.3.2 | Target URI..... | 87 | +| 8.2.4.3.3 | Standard Methods..... | 87 | +| 8.2.5 | Data Model..... | 88 | +| 8.2.5.1 | General..... | 88 | +| 8.2.5.2 | Structured data types..... | 90 | +| 8.2.5.2.1 | Introduction..... | 90 | +| 8.2.5.2.2 | Type: LocationSubscription..... | 90 | +| 8.2.5.2.3 | Type: LocationSubscriptionPatch..... | 92 | +| 8.2.5.2.4 | Type: LocationNotification..... | 92 | +| 8.2.5.2.5 | Type: LocationEvent..... | 92 | +| 8.2.5.2.6 | Type: LocationRequest..... | 93 | +| 8.2.5.2.7 | Type: LocationResponse..... | 93 | +| 8.2.5.2.8 | Type: ConsentRevocNotif..... | 93 | +| 8.2.5.2.9 | Type: ConsentRevoked..... | 94 | +| 8.2.5.3 | Simple data types and enumerations..... | 94 | +| 8.2.6 | Error Handling..... | 94 | +| 8.2.6.1 | General..... | 94 | +| 8.2.6.2 | Protocol Errors..... | 94 | +| 8.2.6.3 | Application Errors..... | 94 | +| 8.2.7 | Feature negotiation..... | 94 | +| 8.3 | Eees_UEIdentifier API..... | 95 | +| 8.3.1 | Introduction..... | 95 | +| 8.3.2 | Resources..... | 95 | +| 8.3.3 | Custom Operations without associated resources..... | 95 | +| 8.3.3.1 | Overview..... | 95 | +| 8.3.3.2 | Operation: Fetch..... | 96 | +| 8.3.3.2.1 | Description..... | 96 | +| 8.3.3.2.2 | Operation Definition..... | 96 | +| 8.3.3.3 | Operation: Get..... | 97 | +| 8.3.3.3.1 | Description..... | 97 | +| 8.3.3.3.2 | Operation Definition..... | 97 | +| 8.3.4 | Notifications..... | 98 | +| 8.3.5 | Data Model..... | 98 | +| 8.3.5.1 | General..... | 98 | +| 8.3.5.2 | Structured data types..... | 99 | +| 8.3.5.2.1 | Introduction..... | 99 | +| 8.3.5.2.2 | Type: UserInfo..... | 99 | +| 8.3.5.2.3 | Type: UserIdInfo..... | 100 | +| 8.3.5.2.4 | Type: UeIdInfo..... | 100 | +| 8.3.5.2.5 | Type: UeId..... | 101 | +| 8.3.5.3 | Simple data types and enumerations..... | 101 | +| 8.3.5.3.1 | Introduction..... | 101 | +| 8.3.5.3.2 | Simple data types..... | 101 | + +| | | | +|-------------|-----------------------------------------------------------------------|-----| +| 8.3.6 | Error Handling..... | 101 | +| 8.3.7 | Feature negotiation..... | 101 | +| 8.4 | Eees_AppClientInformation API..... | 102 | +| 8.4.1 | Introduction..... | 102 | +| 8.4.2 | Resources..... | 102 | +| 8.4.2.1 | Overview..... | 102 | +| 8.4.2.2 | Resource: Application Client Information Subscriptions..... | 103 | +| 8.4.2.2.1 | Description..... | 103 | +| 8.4.2.2.2 | Resource Definition..... | 103 | +| 8.4.2.2.3 | Resource Standard Methods..... | 103 | +| 8.4.2.2.3.1 | POST..... | 103 | +| 8.4.2.2.4 | Resource Custom Operations..... | 104 | +| 8.4.2.3 | Resource: Individual Application Client Information Subscription..... | 104 | +| 8.4.2.3.1 | Description..... | 104 | +| 8.4.2.3.2 | Resource Definition..... | 104 | +| 8.4.2.3.3 | Resource Standard Methods..... | 104 | +| 8.4.2.3.3.1 | GET..... | 104 | +| 8.4.2.3.3.2 | PATCH..... | 105 | +| 8.4.2.3.3.3 | PUT..... | 106 | +| 8.4.2.3.3.4 | DELETE..... | 107 | +| 8.4.2.3.4 | Resource Custom Operations..... | 108 | +| 8.4.3 | Custom Operations without associated resources..... | 108 | +| 8.4.4 | Notifications..... | 109 | +| 8.4.4.1 | General..... | 109 | +| 8.4.4.2 | AC Information Notification..... | 109 | +| 8.4.4.2.1 | Description..... | 109 | +| 8.4.4.2.2 | Target URI..... | 109 | +| 8.4.4.2.3 | Standard Methods..... | 109 | +| 8.4.4.2.3.1 | POST..... | 109 | +| 8.4.5 | Data Model..... | 110 | +| 8.4.5.1 | General..... | 110 | +| 8.4.5.2 | Structured data types..... | 112 | +| 8.4.5.2.1 | Introduction..... | 112 | +| 8.4.5.2.2 | Type: ACInfoSubscription..... | 112 | +| 8.4.5.2.3 | Type: ACInfoSubscriptionPatch..... | 112 | +| 8.4.5.2.4 | Type: ACFilters..... | 113 | +| 8.4.5.2.5 | Type: ACInfoNotification..... | 113 | +| 8.4.5.2.6 | Type: ACInformation..... | 113 | +| 8.4.5.3 | Simple data types and enumerations..... | 114 | +| 8.4.6 | Error Handling..... | 114 | +| 8.4.6.1 | General..... | 114 | +| 8.4.6.2 | Protocol Errors..... | 114 | +| 8.4.6.3 | Application Errors..... | 114 | +| 8.4.7 | Feature negotiation..... | 114 | +| 8.5 | Eees_SessionWithQoS API..... | 114 | +| 8.5.1 | Introduction..... | 114 | +| 8.5.2 | Resources..... | 115 | +| 8.5.2.1 | Overview..... | 115 | +| 8.5.2.2 | Resource: Sessions with QoS..... | 116 | +| 8.5.2.2.1 | Description..... | 116 | +| 8.5.2.2.2 | Resource Definition..... | 116 | +| 8.5.2.2.3 | Resource Standard Methods..... | 116 | +| 8.5.2.2.3.1 | POST..... | 116 | +| 8.5.2.2.3.2 | GET..... | 117 | +| 8.5.2.2.4 | Resource Custom Operations..... | 118 | +| 8.5.2.3 | Resource: Individual Session with QoS..... | 118 | +| 8.5.2.3.1 | Description..... | 118 | +| 8.5.2.3.2 | Resource Definition..... | 118 | +| 8.5.2.3.3 | Resource Standard Methods..... | 118 | +| 8.5.2.3.3.1 | PATCH..... | 118 | +| 8.5.2.3.3.2 | PUT..... | 119 | + +| | | | +|-------------|--------------------------------------------------------------|-----| +| 8.5.2.3.3.3 | DELETE..... | 120 | +| 8.5.2.3.3.4 | GET..... | 121 | +| 8.5.2.3.4 | Resource Custom Operations..... | 122 | +| 8.5.3 | Custom Operations without associated resources..... | 122 | +| 8.5.4 | Notifications..... | 123 | +| 8.5.4.1 | General..... | 123 | +| 8.5.4.2 | User Plane Event Notification..... | 123 | +| 8.5.4.2.1 | Description..... | 123 | +| 8.5.4.2.2 | TargetURI..... | 123 | +| 8.5.4.2.3 | Standard Methods..... | 123 | +| 8.5.4.2.3.1 | POST..... | 123 | +| 8.5.5 | Data Model..... | 124 | +| 8.5.5.1 | General..... | 124 | +| 8.5.5.2 | Structured data types..... | 126 | +| 8.5.5.2.1 | Introduction..... | 126 | +| 8.5.5.2.2 | Type: SessionWithQoS..... | 126 | +| 8.5.5.2.3 | Type: SessionWithQoSPatch..... | 129 | +| 8.5.5.2.4 | Type: UserPlaneEventNotification..... | 129 | +| 8.5.5.3 | Simple data types and enumerations..... | 129 | +| 8.5.6 | Error Handling..... | 130 | +| 8.5.6.1 | General..... | 130 | +| 8.5.6.2 | Protocol Errors..... | 130 | +| 8.5.6.3 | Application Errors..... | 130 | +| 8.5.7 | Feature negotiation..... | 130 | +| 8.6 | Eees_ACRManagementEvent API..... | 130 | +| 8.6.1 | Introduction..... | 130 | +| 8.6.2 | Resources..... | 131 | +| 8.6.2.1 | Overview..... | 131 | +| 8.6.2.2 | Resource: ACR Management Events Subscriptions..... | 132 | +| 8.6.2.2.1 | Description..... | 132 | +| 8.6.2.2.2 | Resource Definition..... | 132 | +| 8.6.2.2.3 | Resource Standard Methods..... | 132 | +| 8.6.2.2.3.1 | POST..... | 132 | +| 8.6.2.2.3.2 | GET..... | 133 | +| 8.6.2.2.4 | Resource Custom Operations..... | 134 | +| 8.6.2.3 | Resource: Individual ACR Management Events Subscription..... | 134 | +| 8.6.2.3.1 | Description..... | 134 | +| 8.6.2.3.2 | Resource Definition..... | 134 | +| 8.6.2.3.3 | Resource Standard Methods..... | 134 | +| 8.6.2.3.3.1 | PATCH..... | 134 | +| 8.6.2.3.3.2 | PUT..... | 135 | +| 8.6.2.3.3.3 | DELETE..... | 136 | +| 8.6.2.3.3.4 | GET..... | 137 | +| 8.6.2.3.4 | Resource Custom Operations..... | 138 | +| 8.6.3 | Custom Operations without associated resources..... | 138 | +| 8.6.4 | Notifications..... | 139 | +| 8.6.4.1 | General..... | 139 | +| 8.6.4.2 | ACR Management Events Notification..... | 139 | +| 8.6.4.2.1 | Description..... | 139 | +| 8.6.4.2.2 | Notification definition..... | 139 | +| 8.6.4.3 | User Plane Path Change Availability Notification..... | 140 | +| 8.6.4.3.1 | Description..... | 140 | +| 8.6.4.3.2 | Target URI..... | 140 | +| 8.6.4.3.3 | Standard Methods..... | 141 | +| 8.6.5 | Data Model..... | 141 | +| 8.6.5.1 | General..... | 141 | +| 8.6.5.2 | Structured data types..... | 144 | +| 8.6.5.2.1 | Introduction..... | 144 | +| 8.6.5.2.2 | Type: AcrMgntEventsSubscription..... | 144 | +| 8.6.5.2.3 | Type: AcrMgntEventSubsc..... | 146 | +| 8.6.5.2.4 | Type: AcrMgntEventsSubscriptionPatch..... | 148 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 8.6.5.2.5 | Type: AcrMgmtEventsNotification..... | 148 | +| 8.6.5.2.6 | Type: AcrMgmtEventReport..... | 149 | +| 8.6.5.2.7 | Type: FailureAcrMgmtEventInfo..... | 151 | +| 8.6.5.2.8 | Type: TargetUeIdentification..... | 151 | +| 8.6.5.2.9 | Type: UpPathChangeInfo..... | 152 | +| 8.6.5.2.10 | Type: IndUeIdentification..... | 152 | +| 8.6.5.2.11 | Type: AvailabilityNotif..... | 152 | +| 8.6.5.2.12 | Type: SelectedACRScenarios..... | 153 | +| 8.6.5.2.13 | Type: ACRParameters..... | 153 | +| 8.6.5.2.14 | Type: TrafficFilterInfo..... | 153 | +| 8.6.5.2.15 | Type: EasAckInformation..... | 154 | +| 8.6.5.2.16 | Type: EasInBundleInfo..... | 154 | +| 8.6.5.3 | Simple data types and enumerations..... | 154 | +| 8.6.5.3.1 | Introduction..... | 154 | +| 8.6.5.3.2 | Simple data types..... | 154 | +| 8.6.5.3.3 | Enumeration: AcrMgmtEvent..... | 154 | +| 8.6.5.3.4 | Enumeration: AcrMgmtEventFilter..... | 155 | +| 8.6.5.3.5 | Enumeration: ActStatus..... | 155 | +| 8.6.5.3.6 | Enumeration: AcrMgmtEventFailureCode..... | 155 | +| 8.6.5.3.7 | Enumeration: AvailabilityStatus..... | 155 | +| 8.6.5.3.8 | Enumeration: ResultCode..... | 155 | +| 8.6.6 | Error Handling..... | 156 | +| 8.6.6.1 | General..... | 156 | +| 8.6.6.2 | Protocol Errors..... | 156 | +| 8.6.6.3 | Application Errors..... | 156 | +| 8.6.7 | Feature negotiation..... | 156 | +| 8.7 | Eees_EECContextRelocation API..... | 156 | +| 8.7.1 | API URI..... | 156 | +| 8.7.2 | Resources..... | 157 | +| 8.7.2.1 | Overview..... | 157 | +| 8.7.2.2 | Resource: Collection of EEC Contexts..... | 157 | +| 8.7.2.2.1 | Description..... | 157 | +| 8.7.2.2.2 | Resource Definition..... | 157 | +| 8.7.2.2.3 | Resource Standard Methods..... | 158 | +| 8.7.2.2.3.1 | GET..... | 158 | +| 8.7.2.2.3.2 | POST..... | 158 | +| 8.7.2.2.4 | Resource Custom Operations..... | 159 | +| 8.7.3 | Custom Operations without associated resources..... | 159 | +| 8.7.4 | Notifications..... | 159 | +| 8.7.5 | Data Model..... | 159 | +| 8.7.5.1 | General..... | 159 | +| 8.7.5.2 | Structured data types..... | 160 | +| 8.7.5.2.1 | Introduction..... | 160 | +| 8.7.5.2.2 | Type: SessionContexts..... | 160 | +| 8.7.5.2.3 | Type: IndividualSessionContext..... | 160 | +| 8.7.5.2.4 | Type: EECContextPush..... | 161 | +| 8.7.5.2.5 | Type: EECContext..... | 161 | +| 8.7.5.2.6 | Type: EECContextPushRes..... | 162 | +| 8.7.5.2.7 | Type: ImplicitRegDetails..... | 162 | +| 8.7.5.2.8 | Type: EECsrvContinuitySupport..... | 162 | +| 8.7.5.3 | Simple data types and enumerations..... | 162 | +| 8.7.6 | Error Handling..... | 162 | +| 8.7.7 | Feature negotiation..... | 163 | +| 8.8 | Eees_EELManagedACR API..... | 163 | +| 8.8.1 | Introduction..... | 163 | +| 8.8.2 | Usage of HTTP..... | 163 | +| 8.8.3 | Resources..... | 163 | +| 8.8.3.1 | Overview..... | 163 | +| 8.8.3.2 | Resource: ACT Status Subscriptions..... | 164 | +| 8.8.3.2.1 | Description..... | 164 | +| 8.8.3.2.2 | Resource Definition..... | 164 | + +| | | | +|-------------|---------------------------------------------------------------------------------|-----| +| 8.8.3.2.3 | Resource Standard Methods..... | 164 | +| 8.8.3.2.3.1 | GET..... | 165 | +| 8.8.3.2.3.2 | POST..... | 165 | +| 8.8.3.2.4 | Resource Custom Operations..... | 166 | +| 8.8.3.3 | Resource: Individual ACT Status Subscription..... | 166 | +| 8.8.3.3.1 | Description..... | 166 | +| 8.8.3.3.2 | Resource Definition..... | 166 | +| 8.8.3.3.3 | Resource Standard Methods..... | 166 | +| 8.8.3.3.3.1 | GET..... | 167 | +| 8.8.3.3.4 | Resource Custom Operations..... | 167 | +| 8.8.4 | Custom Operations without associated resources..... | 168 | +| 8.8.4.1 | Overview..... | 168 | +| 8.8.4.2 | Operation: RequestEELManagedACR..... | 168 | +| 8.8.4.2.1 | Description..... | 168 | +| 8.8.4.2.2 | Operation Definition..... | 168 | +| 8.8.5 | Notifications..... | 169 | +| 8.8.5.1 | General..... | 169 | +| 8.8.5.2 | ACT Status Notification..... | 169 | +| 8.8.5.2.1 | Description..... | 169 | +| 8.8.5.2.2 | Target URI..... | 169 | +| 8.8.5.2.3 | Standard Methods..... | 170 | +| 8.8.5.2.3.1 | POST..... | 170 | +| 8.8.6 | Data Model..... | 170 | +| 8.8.6.1 | General..... | 170 | +| 8.8.6.2 | Structured data types..... | 171 | +| 8.8.6.2.1 | Introduction..... | 171 | +| 8.8.6.2.2 | Type: EELACRReq..... | 171 | +| 8.8.6.2.3 | Type: EELACRResp..... | 172 | +| 8.8.6.2.4 | Type: ACTStatusSubsc..... | 172 | +| 8.8.6.2.5 | Type: ACTStatusNotif..... | 172 | +| 8.8.6.3 | Simple data types and enumerations..... | 172 | +| 8.8.6.3.1 | Introduction..... | 172 | +| 8.8.6.3.2 | Simple data types..... | 172 | +| 8.8.6.4 | Data types describing alternative data types or combinations of data types..... | 173 | +| 8.8.6.5 | Binary data..... | 173 | +| 8.8.6.5.1 | Binary Data Types..... | 173 | +| 8.8.7 | Error Handling..... | 173 | +| 8.8.7.1 | General..... | 173 | +| 8.8.7.2 | Protocol Errors..... | 173 | +| 8.8.7.3 | Application Errors..... | 173 | +| 8.8.8 | Feature negotiation..... | 173 | +| 8.9 | Eees_ACRStatusUpdate API..... | 173 | +| 8.9.1 | Introduction..... | 173 | +| 8.9.2 | Usage of HTTP..... | 174 | +| 8.9.3 | Resources..... | 174 | +| 8.9.4 | Custom Operations without associated resources..... | 174 | +| 8.9.4.1 | Overview..... | 174 | +| 8.9.4.2 | Operation: RequestACRUpdate..... | 175 | +| 8.9.4.2.1 | Description..... | 175 | +| 8.9.4.2.2 | Operation Definition..... | 175 | +| 8.9.5 | Notifications..... | 175 | +| 8.9.6 | Data Model..... | 176 | +| 8.9.6.1 | General..... | 176 | +| 8.9.6.2 | Structured data types..... | 176 | +| 8.9.6.2.1 | Introduction..... | 176 | +| 8.9.6.2.2 | Type: ACRUpdateData..... | 177 | +| 8.9.6.2.3 | Type: ACRDataStatus..... | 177 | +| 8.9.6.2.4 | Type: ACTResultInfo..... | 178 | +| 8.9.6.3 | Simple data types and enumerations..... | 178 | +| 8.9.6.3.1 | Introduction..... | 178 | +| 8.9.6.3.2 | Simple data types..... | 178 | + +| | | | +|------------|---------------------------------------------------------------------------------|-----| +| 8.9.6.3.3 | Enumeration: ACTResult..... | 178 | +| 8.9.6.3.4 | Enumeration: E3SubscsStatus..... | 178 | +| 8.9.6.3.5 | Enumeration: ACTFailureCause..... | 179 | +| 8.9.6.4 | Data types describing alternative data types or combinations of data types..... | 179 | +| 8.9.6.5 | Binary data..... | 179 | +| 8.9.6.5.1 | Binary Data Types..... | 179 | +| 8.9.7 | Error Handling..... | 179 | +| 8.9.7.1 | General..... | 179 | +| 8.9.7.2 | Protocol Errors..... | 179 | +| 8.9.7.3 | Application Errors..... | 179 | +| 8.9.8 | Feature negotiation..... | 179 | +| 8.10 | Eees_ACRParameterInformation API..... | 180 | +| 8.10.1 | Introduction..... | 180 | +| 8.10.2 | Usage of HTTP..... | 180 | +| 8.10.3 | Resources..... | 180 | +| 8.10.4 | Custom Operations without associated resources..... | 180 | +| 8.10.4.1 | Overview..... | 180 | +| 8.10.4.2 | Operation: Request..... | 181 | +| 8.10.4.2.1 | Description..... | 181 | +| 8.10.4.2.2 | Operation Definition..... | 181 | +| 8.10.5 | Notifications..... | 182 | +| 8.10.6 | Data Model..... | 182 | +| 8.10.6.1 | General..... | 182 | +| 8.10.6.2 | Structured data types..... | 182 | +| 8.10.6.2.1 | Introduction..... | 182 | +| 8.10.6.2.2 | Type: ACRParamsInfo..... | 182 | +| 8.10.6.3 | Simple data types and enumerations..... | 183 | +| 8.10.6.3.1 | Introduction..... | 183 | +| 8.10.6.3.2 | Simple data types..... | 183 | +| 8.10.6.4 | Data types describing alternative data types or combinations of data types..... | 183 | +| 8.10.6.5 | Binary data..... | 183 | +| 8.10.6.5.1 | Binary Data Types..... | 183 | +| 8.10.7 | Error Handling..... | 183 | +| 8.10.7.1 | General..... | 183 | +| 8.10.7.2 | Protocol Errors..... | 183 | +| 8.10.7.3 | Application Errors..... | 183 | +| 8.10.8 | Feature negotiation..... | 184 | +| 8.11 | Eees_CommonEASAnnouncement API..... | 184 | +| 8.11.1 | Introduction..... | 184 | +| 8.11.2 | Usage of HTTP..... | 184 | +| 8.11.3 | Resources..... | 184 | +| 8.11.4 | Custom Operations without associated resources..... | 184 | +| 8.11.4.1 | Overview..... | 184 | +| 8.11.4.2 | Operation: Declare..... | 185 | +| 8.11.4.2.1 | Description..... | 185 | +| 8.11.4.2.2 | Operation Definition..... | 185 | +| 8.11.5 | Notifications..... | 186 | +| 8.11.6 | Data Model..... | 186 | +| 8.11.6.1 | General..... | 186 | +| 8.11.6.2 | Structured data types..... | 187 | +| 8.11.6.2.1 | Introduction..... | 187 | +| 8.11.6.2.2 | Type: CommonEASInfo..... | 187 | +| 8.11.6.3 | Simple data types and enumerations..... | 187 | +| 8.11.6.3.1 | Introduction..... | 187 | +| 8.11.6.3.2 | Simple data types..... | 187 | +| 8.11.6.4 | Data types describing alternative data types or combinations of data types..... | 187 | +| 8.11.6.5 | Binary data..... | 187 | +| 8.11.6.5.1 | Binary Data Types..... | 187 | +| 8.11.7 | Error Handling..... | 188 | +| 8.11.7.1 | General..... | 188 | +| 8.11.7.2 | Protocol Errors..... | 188 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 8.11.7.3 | Application Errors..... | 188 | +| 8.11.8 | Feature negotiation..... | 188 | +| 8A | CAS API Definitions..... | 188 | +| 8A.1 | Ecas_SelectedEES API..... | 188 | +| 8A.1.1 | Introduction..... | 188 | +| 8A.1.2 | Usage of HTTP..... | 189 | +| 8A.1.3 | Resources..... | 189 | +| 8A.1.4 | Custom Operations without associated resources..... | 189 | +| 8A.1.4.1 | Overview..... | 189 | +| 8A.1.4.2 | Operation: Declare..... | 189 | +| 8A.1.4.2.1 | Description..... | 189 | +| 8A.1.4.2.2 | Operation Definition..... | 189 | +| 8A.1.5 | Notifications..... | 190 | +| 8A.1.6 | Data Model..... | 190 | +| 8A.1.6.1 | General..... | 190 | +| 8A.1.6.2 | Structured data types..... | 191 | +| 8A.1.6.2.1 | Introduction..... | 191 | +| 8A.1.6.2.2 | Type: SelEESDeclInfo..... | 191 | +| 8A.1.6.3 | Simple data types and enumerations..... | 191 | +| 8A.1.7 | Error Handling..... | 191 | +| 8A.1.7.1 | General..... | 191 | +| 8A.1.7.2 | Protocol Errors..... | 191 | +| 8A.1.7.3 | Application Errors..... | 191 | +| 8A.1.8 | Feature negotiation..... | 192 | +| 9 | Edge Configuration Server API Definitions..... | 192 | +| 9.1 | Eecs_EESRegistration API..... | 192 | +| 9.1.1 | Introduction..... | 192 | +| 9.1.2 | Resources..... | 192 | +| 9.1.2.1 | Overview..... | 192 | +| 9.1.2.2 | Resource: EES Registrations..... | 193 | +| 9.1.2.2.1 | Description..... | 193 | +| 9.1.2.2.2 | Resource Definition..... | 193 | +| 9.1.2.2.3 | Resource Standard Methods..... | 194 | +| 9.1.2.2.3.1 | POST..... | 194 | +| 9.1.2.2.4 | Resource Custom Operations..... | 194 | +| 9.1.2.3 | Resource: Individual EES Registration..... | 194 | +| 9.1.2.3.1 | Description..... | 194 | +| 9.1.2.3.2 | Resource Definition..... | 194 | +| 9.1.2.3.3 | Resource Standard Methods..... | 195 | +| 9.1.2.3.3.1 | GET..... | 195 | +| 9.1.2.3.3.2 | PUT..... | 196 | +| 9.1.2.3.3.3 | DELETE..... | 197 | +| 9.1.2.3.3.4 | PATCH..... | 198 | +| 9.1.2.3.4 | Resource Custom Operations..... | 199 | +| 9.1.3 | Custom Operations without associated resources..... | 199 | +| 9.1.4 | Notifications..... | 199 | +| 9.1.5 | Data Model..... | 199 | +| 9.1.5.1 | General..... | 199 | +| 9.1.5.2 | Structured data types..... | 200 | +| 9.1.5.2.1 | Introduction..... | 200 | +| 9.1.5.2.2 | Type: EESRegistration..... | 200 | +| 9.1.5.2.3 | Type: EESProfile..... | 201 | +| 9.1.5.2.4 | Type: EESRegistrationPatch..... | 202 | +| 9.1.5.2.5 | Type: ServiceArea..... | 202 | +| 9.1.5.2.6 | Type: TopologicalServiceArea..... | 202 | +| 9.1.5.2.7 | Type: GeographicalServiceArea..... | 202 | +| 9.1.5.2.8 | Type: EASInstantiationInfo..... | 203 | +| 9.1.5.2.9 | Type: InstantiationCriteria..... | 203 | +| 9.1.5.2.10 | Type: EDNInfo..... | 203 | +| 9.1.5.3 | Simple data types and enumerations..... | 203 | + +| | | | +|--------------------------------------------------------|-----------------------------------------------------|------------| +| 9.1.5.3.1 | Introduction..... | 203 | +| 9.1.5.3.2 | Simple data types..... | 203 | +| 9.1.5.3.3 | Enumeration: ACRScenario..... | 204 | +| 9.1.5.3.4 | Enumeration: InstantiationStatus..... | 204 | +| 9.1.6 | Error Handling..... | 204 | +| 9.1.7 | Feature negotiation..... | 204 | +| 9.2 | Eecs_TargetEESDiscovery API..... | 205 | +| 9.2.1 | Introduction..... | 205 | +| 9.2.2 | Resources..... | 205 | +| 9.2.2.1 | Overview..... | 205 | +| 9.2.2.2 | Resource: EES Profiles..... | 206 | +| 9.2.2.2.1 | Description..... | 206 | +| 9.2.2.2.2 | Resource Definition..... | 206 | +| 9.2.2.2.3 | Resource Standard Methods..... | 206 | +| 9.2.2.2.3.1 | GET..... | 206 | +| 9.2.2.2.4 | Resource Custom Operations..... | 207 | +| 9.2.3 | Custom Operations without associated resources..... | 207 | +| 9.2.4 | Notifications..... | 207 | +| 9.2.5 | Data Model..... | 207 | +| 9.2.5.1 | General..... | 207 | +| 9.2.5.2 | Structured data types..... | 208 | +| 9.2.5.3 | Simple data types and enumerations..... | 208 | +| 9.2.6 | Error Handling..... | 208 | +| 9.2.7 | Feature negotiation..... | 208 | +| 10 | Using Common API Framework..... | 208 | +| 10.1 | General..... | 209 | +| 10.2 | Security..... | 209 | +| 11 | Security..... | 210 | +| Annex A (normative): OpenAPI specification..... | | 210 | +| A.1 | General..... | 210 | +| A.2 | Eees_EASRegistration API..... | 210 | +| A.3 | Eees_UELocation API..... | 218 | +| A.4 | Eees_UEIdentifier API..... | 226 | +| A.5 | Eees_AppClientInformation API..... | 229 | +| A.6 | Eees_SessionWithQoS API..... | 234 | +| A.7 | Eees_ACRManagementEvent API..... | 241 | +| A.8 | Eees_EECContextRelocation API..... | 252 | +| A.9 | Eees_EELManagedACR API..... | 256 | +| A.10 | Eees_ACRStatusUpdate API..... | 260 | +| A.11 | Eecs_EESRegistration API..... | 262 | +| A.12 | Eecs_TargetEESDiscovery API..... | 269 | +| A.13 | Eees_ACRParameterInformation API..... | 271 | +| A.14 | Ecas_SelectedEES API..... | 273 | +| A.15 | Eees_CommonEASAnnouncement API..... | 274 | +| Annex B (informative): Change history..... | | 277 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# 1 Scope + +The present document specifies the APIs for enabling the edge applications over 3GPP networks. The application layer architecture, functional requirements, procedures and information flows necessary for enabling edge applications over 3GPP networks are specified in 3GPP TS 23.558 [2]. The APIs are specified as RESTful APIs except for custom operations wherever required. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.558: "Architecture for enabling Edge Applications". +- [3] Open API: "OpenAPI Specification Version 3.0.0.", . +- [4] 3GPP TR 21.900: "Technical Specification Group working methods". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 29.122: "T8 reference point for Northbound Application Programming Interfaces (APIs)". +- [7] IETF RFC 6455: "The Websocket Protocol". +- [8] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [9] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [10] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [11] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". +- [12] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [13] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [14] 3GPP TS 24.558: "Enabling Edge Applications; Protocol specification". +- [15] 3GPP TS 29.214: "Policy and charging control over Rx reference point". +- [16] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [17] 3GPP TS 29.222: "Common API Framework for 3GPP Northbound APIs". +- [18] 3GPP TS 33.122: "Security Aspects of Common API Framework for 3GPP Northbound APIs". +- [19] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [20] 3GPP TS 33.558: "Security aspects of enhancement of support for enabling edge applications; Stage 2". +- [21] Void. + +- [22] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [23] 3GPP TS 23.271: "Functional stage 2 description of Location Services (LCS)". +- [24] 3GPP TS 23.273: "5G System (5GS) Location Services (LCS); Stage 2". +- [25] IETF RFC 6733: "Diameter Base Protocol". + +--- + +## 3 Definitions of terms, symbols and abbreviations + +### 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +For the purposes of the present document, the following terms and its definitions given in 3GPP TS 23.558 [2] shall apply: + +**Application Context** + +**Application Context Relocation** + +**Application Context Transfer** + +**Application Server** + +**Edge Computing Service Provider** + +**Edge Data Network** + +**EEC Context** + +**Edge Hosting Environment** + +**Instantiable EAS** + +### 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----------|---------------| +| | | +|----------|---------------| + +### 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|-----------------------------------| +| AC | Application Client | +| ACID | Application Client Identification | +| ACR | Application Context Relocation | +| AEF | API Exposing Function | +| AF | Application Function | +| ASP | Application Service Provider | +| CAPIF | Common API Framework | +| CAS | Cloud Application Server | +| CES | Cloud Enabler Server | +| DN | Data Network | + +| | | +|--------|--------------------------------------------------| +| DNAI | Data Network Access Identifier | +| DNN | Data Network Name | +| EAS | Edge Application Server | +| EASID | Edge Application Server Identification | +| ECI | Edge and Cloud Interworking | +| ECS | Edge Configuration Server | +| ECSP | Edge Computing Service Provider | +| EDN | Edge Data Network | +| EEC | Edge Enabler Client | +| EECID | Edge Enabler Client Identification | +| EEL | Edge Enabler Layer | +| EES | Edge Enabler Server | +| EESID | Edge Enabler Server Identification | +| EHE | Edge Hosting Environment | +| FQDN | Fully Qualified Domain Name | +| GPSI | Generic Public Subscription Identifier | +| LADN | Local Area Data Network | +| NEF | Network Exposure Function | +| NID | Network Identifier | +| PCF | Policy Control Function | +| S-EAS | Source Edge Application Server | +| S-EES | Source Edge Enabler Server | +| SCEF | Service Capability Exposure Function | +| SEAL | Service Enabler Architecture Layer for Verticals | +| SEALDD | SEAL Data Delivery | +| SMF | Session Management Function | +| SNPN | Stand-alone Non-Public Network | +| SSID | Service Set Identifier | +| T-EAS | Target Edge Application Server | +| T-EES | Target Edge Enabler Server | +| TAI | Tracking Area Identity | +| UAS | Uncrewed Aerial System | + +--- + +## 4 Overview + +3GPP TS 23.558 [2] has specified the application layer architecture, requirements, procedures, information flows and the APIs, in order to support the edge applications over the 3GPP systems. Various features are defined to ensure the efficient use and deployment of edge applications, some of which include, registration, discovery, service provisioning, capability exposure, support for service continuity and support for roaming and federation. + +The present document specifies the north-bound APIs in detail, needed to support the services offered by EES and ECS over EDGE-3/6/9/10 interfaces and by CES and CAS over ECI-1/2/3/4 interfaces for enabling the edge applications over 3GPP network. + +*Editor's note: The ECI interfaces' naming is FFS.* + +--- + +## 5 Services offered by Edge Enabler Server + +### 5.1 Introduction + +The table 5.1-1 lists the Edge Enabler Server APIs below the service name. A service description clause for each API gives a general description of the related API. + +**Table 5.1-1: List of EES Service APIs** + +| Service Name | Service Operations | Operation Semantics | Consumer(s) | +|------------------------------|---------------------------|---------------------|-------------| +| Eees_EASRegistration | Request | Request/Response | EAS | +| | Update | Request/Response | EAS | +| | Deregister | Request/Response | EAS | +| Eees_UELocation | Get | Request/Response | EAS | +| | Subscribe | Subscribe/Notify | EAS | +| | Notify | | | +| | UpdateSubscription | | | +| | Unsubscribe | | | +| Eees_UEIdentifier | Get | Request/Response | EAS, EEC | +| Eees_AppClientInformation | Subscribe | Subscribe/Notify | EAS | +| | Notify | | | +| | UpdateSubscription | | | +| | Unsubscribe | | | +| Eees_SessionWithQoS | Create | Request/Response | EAS | +| | Update | Request/Response | EAS | +| | Revoke | Request/Response | EAS | +| | Notify | Subscribe/Notify | EAS | +| Eees_EASDiscovery | TEasDiscRequest | Request/Response | EAS, EES | +| Eees_ACRManagementEvent | Subscribe | Subscribe/Notify | EAS | +| | Notify | | | +| | UpdateSubscription | | | +| | Unsubscribe | | | +| Eees_EECContextRelocation | Push | Request/Response | EES, CES | +| | Pull | Request/Response | EES | +| Eees_EELManagedACR | Request | Request/Response | EAS | +| | Subscribe | Subscribe/Notify | EAS | +| | Notify | | | +| Eees_ACRStatusUpdate | Request | Request/Response | EAS | +| Eees_AppContextRelocation | ACRDetermination_Request | Request/Response | EAS | +| | SelectedTargetEAS_Declare | Request/Response | EAS | +| Eees_ACRParameterInformation | Request | Request/Response | EES, CES | +| Eees_CommonEASAnnouncement | Declare | Request/Response | EES | + +Editor's note: whether the CES is a consumer of the Eees\_ACRParameterInformation service is FFS. + +Editor's note: whether the CES is a consumer of the Eees\_EECContextRelocation service is FFS. + +Table 5.1-2 summarizes the corresponding Edge Enabler Server APIs defined in this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------|--------|-------------|----------------------------|---------|-------| +|--------------|--------|-------------|----------------------------|---------|-------| + +| | | | | | | +|------------------------------|------|------------------------------------------------------------------------------------------|-------------------------------------------|--------------------------|------| +| Eees_EASRegistration | 5.2 | EAS registration service | TS29558_Eees_EASRegistration.yaml | ees-easregistration | A.2 | +| Eees_UELocation | 5.3 | Service for fetching UE location information | TS29558_Eees_UELocation.yaml | ees-uelocation | A.3 | +| Eees_UEIdentifier | 5.4 | Service for fetching UE identifier. | TS29558_Eees_UEIdentifier.yaml | ees-ueidentifier | A.4 | +| Eees_AppClientInformation | 5.5 | Service to obtain the capabilities of the ACs. | TS29558_Eees_AppClientInformation.yaml | ees-appclientinformation | A.5 | +| Eees_SessionWithQoS | 5.6 | Service to setup data session between AC and EAS with specific QoS. | TS29558_Eees_SessionWithQoS.yaml | ees-session-with-qos | A.6 | +| Eees_ACRManagementEvent | 5.8 | Service to receive notification related to ACR management events. | TS29558_Eees_ACRManagementEvent.yaml | ees-acrmgmtevent | A.7 | +| Eees_EECContextRelocation | 5.10 | Service to push or pull EEC context information. | TS29558_Eees_EECContextRelocation.yaml | ees-eecontextreloc | A.8 | +| Eees_EELManagedACR | 5.11 | Service to request for handling of ACR related operations and receive ACT notifications. | TS29558_Eees_EELManagedACR.yaml | ees-eel-acr | A.9 | +| Eees_ACRStatusUpdate | 5.12 | Service to update the status of ACR. | TS29558_Eees_ACRStatusUpdate.yaml | ees-acrstatus-update | A.10 | +| Eees_ACRParameterInformation | 5.13 | Service to send ACR parameters information. | TS29558_Eees_ACRParameterInformation.yaml | ees-acr-param | A.13 | +| Eees_CommonEASAnnouncement | 5.14 | Service to announce common EAS information. | TS29558_Eees_CommonEASAnnouncement.yaml | ees-common-eas | A.15 | + +## 5.2 Eees\_EASRegistration Service + +### 5.2.1 Service Description + +The Eees\_EASRegistration API, as defined in 3GPP TS 23.558 [2], allows an Edge Application Server via Eees interface to register, update its registration and unregister at a given Edge Enabler Server. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operation defined for Eees\_EASRegistration API is shown in the table 5.2.2.1-1. + +**Table 5.2.2.1-1: Operations of the Eees\_EASRegistration API** + +| Service operation name | Description | Initiated by | +|---------------------------------|------------------------------------------------------------------------------------------|--------------| +| Eees_EASRegistration_Request | This service operation is used by the EAS to register itself to a given EES. | EAS | +| Eees_EASRegistration_Update | This service operation is used by the EAS to update its registration information at EES. | EAS | +| Eees_EASRegistration_Deregister | This service operation is used by the EAS to deregister itself from a given EES. | EAS | + +## 5.2.2.2 Eees\_EASRegistration\_Request + +### 5.2.2.2.1 General + +This service operation is used by EAS to register itself to a given EES. + +### 5.2.2.2.2 EAS registering to EES using Eees\_EASRegistration\_Request operation + +To register itself as an Edge Application Server at the EES, the EAS shall send an HTTP POST message to the Edge Enabler Server on the "EAS Registrations" collection resource. The body of the HTTP POST message shall include the EAS profile information, may include proposed expiration time for the registration, as specified in clause 8.1.2.2.3.1. + +Upon receiving the HTTP POST message from the EAS, the EES shall: + +1. Process the EAS registration request information; +2. verify the identity of the Edge Application Server and check if the EAS is authorized to register itself at EES ; +3. if the EAS is authorized to register to EES, then the EES shall; + - a. store the EAS profile and create a new resource with the EAS registration information as specified in clause 8.1.2.1; + - b. return the EAS registration information, the resource URI of the EAS registration information, in the "201 Created" response message. The EES shall include a Location HTTP header field. The Location header field shall contain the URI of the created registration i.e. +`{apiRoot}/ees-easregistration//registrations/{registrationId}`. + +The response message may include expiration time to indicate when the EAS registration will automatically expire. + +On failure, the EES shall take proper error handling actions, as specified in clause 8.1.6, and respond to the EAS with an appropriate error status code. + +If the expiration time is provided, then to maintain the registration, the EAS shall send a registration update request (as described in clause 5.2.2.3) prior to the expiration time. If the registration update request is not sent before the expiry time, then the EES shall treat the EAS as deregistered and remove the corresponding EAS registration resource. + +## 5.2.2.3 Eees\_EASRegistration\_Update + +### 5.2.2.3.1 General + +This service operation is used by EAS to update its registration information at a given EES. + +### 5.2.2.3.2 EAS updating registration information using Eees\_EASRegistration\_Update operation + +To update the EAS registration information at the EES, the EAS shall send a HTTP PUT or PATCH message to the Edge Enabler Server on resource URI identifying the Individual EAS registration resource representation, as specified in clause 8.1.2.3.3.2 for HTTP PUT message and in clause 8.1.2.3.3.4 for HTTP PATCH message. + +The HTTP PUT message shall replace all properties in the existing resource with the EAS registration information in the request. The EASRegistration data type in the request body of the HTTP PUT message shall include the EAS profile information, may include proposed expiration time to update the registration. This request shall not replace the easId property of the existing resource. + +The HTTP PATCH message includes parameters (EAS Profile, expiry time) in the EASRegistrationPatch data type that need to modify the existing Individual EAS registration resource. This request shall not replace the easId property of the existing resource. + +Upon receiving the HTTP PUT or PATCH message from the EAS, the EES shall: + +1. check the registration update message from the EAS to see if the EAS is authorized to modify the requested registration resource; +2. if the EAS is authorized to update the registration information, then the EES shall: + - a. update the resource identified by Resource URI of the EAS registration information with the updated EAS registration information received in the HTTP PUT or PATCH request message; + - b. upon successful update of EAS registration information, respond to the EAS with "204 No Content", or "200 OK" along with the updated EAS registration information in the response. In the response message, the EES may provide an updated expiration time to indicate to the EAS when the updated registration will automatically expire. + +On failure, the EES shall take proper error handling actions, as specified in clause 8.1.6, and respond to the EAS with an appropriate error status code. + +If the EES determines that the received HTTP PUT or PATCH request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +If the expiration time is provided, then to maintain the registration, the EAS shall send a registration update prior to registration expiry time. If the registration update request is not sent before the expiry time, then the EES shall treat EAS as deregistered and remove the corresponding EAS registration resource. + +#### 5.2.2.4 Eees\_EASRegistration\_Deregister + +##### 5.2.2.4.1 General + +This service operation is used by EAS to deregister itself from a given EES. + +##### 5.2.2.4.2 EAS deregistering from EES using Eees\_EASRegistration\_Deregister operation + +To deregister itself from the EES, the EAS shall send HTTP DELETE message to the EES, on the resource URI identifying the Individual EAS registration resource representation as specified in clause 8.1.2.3.3.3. Upon receiving the HTTP DELETE request, the EES shall: + +1. verify the identity of the EAS and check if the EAS is authorized to deregister the EAS registration information; +2. if the EAS is authorized to deregister the EAS registration information, then the EES shall deregister the EAS profile from the EES and delete the resource representing EAS registration information; +3. return the "204 Not Content" message to the EAS, indicating the successful deregistration of the EAS information. + +On failure, the EES shall take proper error handling actions, as specified in clause 8.1.6, and respond to the EAS with an appropriate error status code. + +If the EES determines that the received HTTP DELETE request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +## 5.3 Eees\_UELocation Service + +### 5.3.1 Service Description + +The Eees\_UELocation API, as defined in 3GPP TS 23.558 [2], allows an Edge Application Server via Eees interface to obtain the UE location information as one time request or subscribe for continuous reporting. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operation defined for Eees\_UELocation API is shown in the table 5.3.2.1-1. + +**Table 5.3.2.1-1: Operations of the Eees\_UELocation API** + +| Service operation name | Description | Initiated by | +|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Eees_UELocation_Get | This service operation is used by the EAS to request UE location information from a given EES. | EAS | +| Eees_UELocation_Subscribe | This service operation is used by the EAS to subscribe to EES, for continuous reporting of UE location information. | EAS | +| Eees_UELocation_Notify | This service operation is used by the EES to notify the EAS about the UE location information. | EES | +| Eees_UELocation_UpdateSubscription | This service operation is used by the EAS to update its subscription at EES, for continuous reporting of UE location information. | EAS | +| Eees_UELocation_Unsubscribe | This service operation is used by the EAS to remove its subscription from EES, for continuous reporting of UE location information. | EAS | + +#### 5.3.2.2 Eees\_UELocation\_Get + +##### 5.3.2.2.1 General + +This service operation is used by EAS to obtain a UE's location information from a given EES. + +##### 5.3.2.2.2 EAS obtaining UE location information from EES using Eees\_UELocation\_Get operation + +To obtain an UE's location information from the EES, the EAS shall send an HTTP POST message to the EES on the URI "{apiRoot}/ees-uelocation//fetch" as specified in clause 8.2.3.2. The POST request includes: + +- the identifier of the UE for which location information is requested; +- the accuracy of the requested location in terms of granularity and location QoS. + +Upon reception of the HTTP POST request from the EAS, the EES shall: + +1. process the EAS UE location information request; +2. verify the identity of the Edge Application Server and check if the EAS is authorized to obtain UE location information; +3. if the EAS is authorized to obtain the UE's location information, then the EES shall: + - a. consider the location granularity information received in the request message to obtain the UE's location information; + +- b. check if a valid locally cached UE location information is available, and if available then the EES shall return the UE location information in the format requested by the EAS along with the location accuracy and its timestamp; +- c. if valid UE location information is not available in local cache, then the EES shall obtain the UE location information by consuming the 3GPP core network capabilities. The EES shall return the UE location information to EAS in the format requested by the EAS along with the location accuracy and its timestamp as a 200 OK response. + +On failure, the EES shall take proper error handling actions, as specified in clause 8.2.6, and respond to the EAS with an appropriate error status code. + +If the EES determines that the received HTTP POST request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +### 5.3.2.2.3 User consent management + +Based on local regulations' requirements and/or operator policies, user consent management specified in Annex V of 3GPP TS 33.501 [6] may be required for accessing the Eees\_UELocation API. When it is the case and the EES is accessing the 3GPP 5GC network services directly, the EES shall act as the consent enforcement entity, as specified in clause 5.1.3 of 3GPP TS 33.558 [20]. + +When user consent management and enforcement shall be undertaken for the Eees\_UELocation API, then: + +- the EES shall check user consent for the targeted UE by retrieving the user consent subscription data via the Nudm\_SDM service API of the UDM, as specified in clause 5.2.2.2.24 of 3GPP TS 29.503 [22] and: +- if user consent is not granted for the targeted UE, the EES shall reject the request and respond to the EAS with an HTTP "403 Forbidden" status code with the response body containing a ProblemDetails data structure with the "cause" attribute including the "USER\_CONSENT\_NOT\_GRANTED" application error; and +- if user consent is granted for the targeted UE, the EES shall accept the request to retrieve UE location information and process it as specified in clause 5.3.2.2.2. + +### 5.3.2.3 Eees\_UELocation\_Subscribe + +#### 5.3.2.3.1 General + +This service operation is used by the EAS to subscribe for continuous UE(s) location reporting. + +#### 5.3.2.3.2 EAS subscribing to continuous UE(s) location reporting from EES using Eees\_UELocation\_Subscribe operation + +To subscribe to continuous UE(s) location information reporting at the EES, the EAS shall send a HTTP POST message to the EES on the "Location Information Subscriptions" resource. The body of the POST message shall include EAS identifier, the identifier of the UE or the identifier of the group uniquely identifying a group of UEs, Notification Destination URI and may include location format that is understood by EAS, location QoS, proposed expiry time of the subscription and reporting requirements, as specified in clause 8.2.2.2.3.1. + +Upon receiving the HTTP POST message from the EAS, the EES shall: + +1. Process the EAS UE location information subscription request; +2. verify the identity of the Edge Application Server and check if the EAS is authorized to subscribe for the continuous UE(s) location reporting; +3. if the EAS is authorized to subscribe for the continuous UE(s) location information reporting, then the EES shall; + - a. create a new resource with the Location Information Subscription as specified in clause 8.2.2.1; + +- b. return the EAS's location subscription information, the resource URI of the EAS location subscription, in the response message. The response message may include expiration time to indicate when the location information subscription will automatically expire; + +On failure, the EES shall take proper error handling actions, as specified in clause 8.2.6, and respond to the EAS with an appropriate error status code. + +EES shall obtain the UE location information by consuming the 3GPP core network capabilities from NEF as specified in 3GPP TS 29.522 [10], or from SCEF as specified in 3GPP TS 29.122 [6] or from LCS (Location Service) as specified in 3GPP TS 23.271 [23] or 3GPP TS 23.273 [24]. The EES may also consume the UE mobility analytics from NEF as specified in 3GPP TS 29.522 [10] or from NWDAF as specified in 3GPP TS 29.520 [12]. + +If the expiration time is provided, then to maintain the registration, the EAS shall send a subscription update request (as described in clause 5.3.2.5) prior to the expiration time. If the subscription update request is not sent before the expiry time, then the EES shall treat the subscription as unsubscribed and remove the corresponding EAS's Individual Location Information Subscription resource. + +### 5.3.2.3.3 User consent management + +Based on local regulations' requirements and/or operator policies, user consent management specified in Annex V of 3GPP TS 33.501 [6] may be required for accessing the Eees\_UELocation API. When it is the case and the EES is accessing the 3GPP 5GC network services directly, the EES shall act as the consent enforcement entity, as specified in clause 5.1.3 of 3GPP TS 33.558 [20]. + +When user consent management and enforcement shall be undertaken for the Eees\_UELocation API, then: + +- if the EAS does not support the "UserConsentRevocation" feature or does not indicate its support for this feature in the HTTP POST request to create a new "Individual Location Information Subscription" resource, the EES shall reject the request and respond to the EAS with an HTTP "403 Forbidden" status code with the response body containing a ProblemDetails data structure with the "cause" attribute including the "CONSENT\_REVOCATION\_NOT\_SUPPORTED" application error; +- if the EAS indicates its support for the "UserConsentRevocation" feature in the HTTP POST request to create a new "Individual Location Information Subscription" resource, the EES shall check user consent for the targeted UE(s) by retrieving the user consent subscription data via the Nudm\_SDM service API of the UDM as specified in clause 5.2.2.2.24 of 3GPP TS 29.503 [22], subscribe to user consent revocation notifications only for those UE(s) for which user consent is granted also using the Nudm\_SDM service API of the UDM and accept the request for the creation of the UE location information subscription only for the UE(s) for which user consent is granted; +- if user consent is not granted for all the targeted UE(s), the EES shall reject the request and respond to the EAS with an HTTP "403 Forbidden" status code with the response body containing a ProblemDetails data structure with the "cause" attribute including the "USER\_CONSENT\_NOT\_GRANTED" application error; +- the EAS shall provide within the payload body of the HTTP POST request to create a new UE location information subscription the URI via which it desires to receive user consent revocation notifications within the "revocationNotifUri" attribute. The EAS may update this URI in subsequent HTTP PUT/PATCH requests to update/modify the corresponding "Individual Location Information Subscription" resource; +- when becoming aware of user consent revocation for one or several UE(s), the EES shall: + - stop processing the data related to the concerned UE(s); + - send a user consent revocation notification to the EAS by sending an HTTP POST request with the request body including the ConsentRevocNotif data structure that shall contain the user consent revocation information (e.g. UE(s) for which user consent was revoked, etc.); and + - remove the concerned UE(s) from the "Individual Location Information Subscription" resource and from the related subscriptions at the 3GPP 5GC network entities, if any; + - unsubscribe from user consent revocation notifications for the concerned UE(s) at the UDM; + +and + +- at the reception of the user consent revocation notification from the EES, the EAS shall take the necessary actions to stop processing the data related to the concerned UE(s); and +- if user consent is revoked for all the UE(s), the EAS shall delete the corresponding "Individual Location Information Subscription" resource, as specified in clause 5.3.2.6. + +#### 5.3.2.4 Eees\_UELocation\_Notify + +##### 5.3.2.4.1 General + +This service operation is used by the EES to send UE(s) location information notifications or user consent revocation notifications to the EAS. + +##### 5.3.2.4.2 EES notifying the UE(s) location reporting to EAS using Eees\_UELocation\_Notify operation + +The EES determines to notify the EAS with the UE location information, when the UE location information is available either locally cached or from the 3GPP core network. + +To notify the UE(s) location information events, the EES shall send an HTTP POST message using the Notification Destination URI received in the subscription request. The body of the HTTP POST message shall include LocationNotification. LocationNotification includes location information of each UE with accuracy, and timestamp. The location information of each UE may be actual location change or predictive location report from the UE mobility analytics report from NEF as specified in 3GPP TS 29.522 [10], or from SCEF as specified in 3GPP TS 29.122 [6], or from LCS (Location Service) as specified in 3GPP TS 29.271 [23] or 3GPP TS 29.273 [24] or from NWDAF as specified in 3GPP TS 29.520 [12]. The EES may modify the UE location information in the format requested by the EAS in the subscription request. + +Upon receiving the HTTP POST message, the EAS shall process the Location Notification. + +On failure, the EAS shall take proper error handling actions, as specified in clause 8.2.6, and respond to the EES with an appropriate error status code. + +If the EAS determines that the received HTTP POST message needs to be redirected, the EAS may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EAS where the notification should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +##### 5.3.2.4.3 EES notifying the EAS about user consent revocation using Eees\_UELocation\_Notify operation + +The EES determines to notify the EAS about user consent revocation, when becoming aware of user consent revocation for one or several UE(s) from the UDM as specified in 3GPP TS 29.503 [22]. + +To notify user consent revocation, the EES shall send an HTTP POST message using the revocation notification URI received from the EAS in the UE location information subscription creation/update/modification request as specified in clause 5.3.2.3.3. The body of the HTTP POST message shall include ConsentRevocNotif data structure. + +Upon reception of the HTTP POST request, the EAS shall take the necessary actions to stop processing the data related to the UE(s) for which user consent was revoked. + +On failure, the EAS shall take proper error handling actions, as specified in clause 8.2.6, and respond to the EES with an appropriate error status code. + +If the EAS determines that the received HTTP POST message needs to be redirected, the EAS may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EAS where the notification should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +### 5.3.2.5 Eees\_UELocation\_UpdateSubscription + +#### 5.3.2.5.1 General + +This service operation is used by the EAS to update its location information subscription at the EES. + +#### 5.3.2.5.2 EAS updating continuous UE(s) location reporting subscription at EES using Eees\_UELocation\_UpdateSubscribe operation + +To update continuous UE(s) location information reporting subscription at the EES, the EAS shall send a HTTP PATCH or PUT message to the EES on resource URI identifying the "Individual Location Information" Subscription resource representation, as specified in clause 8.2.2.3.3.2 for HTTP PATCH message and in clause 8.2.2.3.3.3 for HTTP PUT message. + +The PATCH message includes the parameters (location QoS, location granularity, Notification Destination, Reporting requirements and proposed expiry time) that need to be replaced in the existing subscription resource. + +The PUT message shall replace all the properties of the existing resource with the location subscription information in the request. The request shall not replace the easId, ueId and groupId properties of the existing resource. + +Upon receiving the HTTP PATCH or PUT message from the EAS, the EES shall: + +1. check the update subscription message from the EAS to see if the EAS is authorized to modify the requested subscription resource; +2. if the EAS is authorized to update the location information subscription, then the EES shall: + - a. update the resource identified by Resource URI of the EAS location information subscription with the updated information received in the HTTP PATCH or PUT request message; + - b. return the updated EAS Location information subscription in the response. In the response message, the EES may provide an updated expiration time to indicate to the EAS when the updated subscription will automatically expire. + +On failure, the EES shall take proper error handling actions, as specified in clause 8.2.6, and respond to the EAS with an appropriate error status code. + +If the EES determines that the received HTTP PATCH or PUT request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +If the expiration time is provided, then to maintain the subscription, the EAS shall send an update subscription prior to subscription expiry time. If the update subscription request is not sent before the expiry time, then the EES shall treat EAS subscription as unsubscribed and remove the corresponding EAS location information subscription resource. + +#### 5.3.2.5.3 User consent management + +Based on local regulations' requirements and/or operator policies, user consent management specified in Annex V of 3GPP TS 33.501 [6] may be required for accessing the Eees\_UELocation API. When it is the case and the EES is accessing the 3GPP 5GC network services directly, the EES shall act as the consent enforcement entity, as specified in clause 5.1.3 of 3GPP TS 33.558 [20]. + +When user consent management and enforcement shall be undertaken for the Eees\_UELocation API, then: + +- the EAS may update/modify the revocation notification URI when updating/modifying an existing "Individual Location Information Subscription" resource; +- if user consent is still granted for the concerned UE(s), i.e. no user consent revocation notification is received by the EES from the UDM, then the EES shall process the request as specified in clause 5.3.2.5.2; +- if user consent is granted for only a subset of the UE(s), process the request as specified in clause 5.3.2.5.2 only for this subset of UE(s); + +- otherwise, if the EES is made aware by the UDM that user consent is not granted for one or several UE(s) at the reception of the Eees\_UELocation\_UpdateSubscribe request, then the EES shall: + - stop processing the data related to the concerned UE(s); + - if user consent is not anymore granted for all the UE(s), reject the request and respond to the EAS with an HTTP "403 Forbidden" status code with the response body containing a ProblemDetails data structure with the "cause" attribute including the "USER\_CONSENT\_NOT\_GRANTED" application error; + - send a user consent revocation notification to the EAS by sending an HTTP POST request with the request body including the ConsentRevocNotif data structure that shall contain the user consent revocation information (e.g. UE(s) for which user consent was revoked, etc.); and + - remove the concerned UE(s) from the concerned "Individual Location Information Subscription" resource and from the related subscriptions at the 3GPP 5GC network entities, if any; and + - unsubscribe from user consent revocation notifications for the concerned UE(s) at the UDM; +- and the EAS shall: +- at the reception of the user consent revocation notification from the EES, take the necessary actions to stop processing the data related to the concerned UE(s); and + - if user consent is revoked for all the UE(s), delete the corresponding "Individual Location Information Subscription" resource, as specified in clause 5.3.2.6. + +### 5.3.2.6 Eees\_UELocation\_Unsubscribe + +#### 5.3.2.6.1 General + +This service operation is used by the EAS to unsubscribe from an existing UE(s) location information subscription. + +#### 5.3.2.6.2 EAS unsubscribing to continuous UE(s) location reporting from EES using Eees\_UELocation\_Unsubscribe operation + +To unsubscribe its location information subscription from the EES, the EAS shall send HTTP DELETE message to the EES, on the resource URI identifying the "Individual Location Information Subscription" resource representation as specified in clause 8.2.2.3.3.4. Upon receiving the HTTP DELETE request, the EES shall: + +1. verify the identity of the EAS and check if the EAS is authorized to unsubscribe the Individual Location Information Subscription resource; +2. if the EAS is authorized to unsubscribe the Individual Location Information Subscription resource, then the EES shall unsubscribe the EAS subscription identified by the subscriptionId from the EES and delete the resource representing Individual Location Information Subscription resource represented by subscriptionId; +3. return the "204 Not Content" message to the EAS, indicating the successful removal of the subscription information and may unsubscribe to the corresponding 3GPP core network service subscriptions. + +On failure, the EES shall take proper error handling actions, as specified in clause 8.2.6, and respond to the EAS with an appropriate error status code. + +If the EES determines that the received HTTP DELETE message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +## 5.4 Eees\_UEIdentifier Service + +### 5.4.1 Service Description + +The Eees\_UEIdentifier API, as defined in 3GPP TS 23.558 [2], allows an Edge Application Server via Eees interface to obtain an identifier uniquely identifying a UE from the EES. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +The service operation defined for Eees\_UEIdentifier API is shown in the table 5.4.2.1-1. + +**Table 5.4.2.1-1: Operations of the Eees\_UEIdentifier API** + +| Service operation name | Description | Initiated by | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Eees_UEIdentifier_Get | This service operation is used by the EAS to request UE identifier information from a given EES that uses 3GPP CN capability to retrieve UE Identifier which is specific to the EAS. | EAS | + +The Eees\_UEIdentifier\_Get service operation as defined in 3GPP TS 23.558 [2] is used by a service consumer to retrieve UE Identifier Information. + +The following procedures using the Eees\_UEIdentifier\_Get service operation service operation are supported: + +- EAS obtaining UE Identifier Information using the Get custom operation. + +#### 5.4.2.2 Eees\_UEIdentifier\_Get + +##### 5.4.2.2.1 General + +This service operation is used by EAS to obtain a UE's identifier (UE ID, as specified in 3GPP TS 23.558 [2]) from a given EES that uses 3GPP CN capability to retrieve UE Identifier which is specific to the EAS. + +##### 5.4.2.2.1A EAS obtaining UE Identifier Information using "Get" custom operation + +In order to obtain an UE Identifier from the EES, the EAS shall send a HTTP POST request message to the EES with the request custom operation URI set to "{apiRoot}/ees-ueidentifier//get" and the request body including the UserInfo data structure as defined in clause 8.3.5.2.3. + +Upon receiving the HTTP POST message from the EAS, the EES shall: + +1. verify the identity of the EAS and check if the EAS is authorized to obtain the UE Identifier; and +2. if the EAS is authorized to obtain the UE's Identifier information, the EES shall: + - a. invoke the Nnef\_UEId service as specified in clause 4.4.32 of 3GPP TS 29.522 [10] to obtain the UE identifier based on the user information received, and may derive the corresponding DNN and/or S-NSSAI based on the verified identity of the EAS; and + - b. upon successful retrieval of the UE identifier, respond with "200 OK" along with the retrieved UE identifier information in the UeIdInformation data type to the EAS. If an error occurs when processing the request, the EES shall send an HTTP error response as specified in clause 7.7. + +If the EES determines the received HTTP POST request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP + +"Location" header containing an alternative URI representing the end point of an alternative EES where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +#### 5.4.2.2.2 EAS obtaining UE identifier from EES using Eees\_UEIdentifier\_Fetch custom operation + +This procedure and the corresponding custom operation are deprecated. The procedure in clause 5.4.2.2.1A should be used instead. + +To obtain an UE's Identifier from the EES, the EAS shall send a HTTP POST message to the EES with the request URI set to "{apiRoot}/ees-ueidentifier//fetch" and the request body with the UserInformation data structure including the information about the user or UE available with EAS, for which the UE identifier is requested. + +Upon receiving the HTTP POST message from the EAS, the EES shall: + +1. Process the EAS UE Identifier request; +2. verify the identity of the EAS and check if the EAS is authorized to obtain the UE Identifier; +3. if the EAS is authorized to obtain the UE's Identifier information, then the EES shall; + - a. invoke the Nnef\_UEId service as specified in clause 4.4.32 of 3GPP TS 29.522 [10] to obtain the UE identifier based on the user information received, and may derive the corresponding DNN and/or S-NSSAI based on the verified identity of the EAS; + - b. upon successful retrieval of UE identifier, respond with "200 OK" along with the retrieved UE identifier to the EAS. If the UE identifier cannot be successfully retrieved or an internal error or an error in the HTTP POST request, the EES shall send an HTTP error response as specified in clause 7.7. + +If the EES determines the received HTTP POST request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +## 5.5 Eees\_AppClientInformation Service + +### 5.5.1 Service Description + +The Eees\_AppClientInformation API, as defined in 3GPP TS 23.558 [2], allows an Edge Application Server via Eees interface to obtain the information about the capabilities of the ACs based on certain filter criteria. + +### 5.5.2 Service Operations + +#### 5.5.2.1 Introduction + +The service operation defined for Eees\_AppClientInformation API is shown in the table 5.5.2.1-1. + +**Table 5.5.2.1-1: Operations of the Eees\_AppClientInformation API** + +| Service operation name | Description | Initiated by | +|----------------------------------------------|-----------------------------------------------------------------------------------------------------------------|--------------| +| Eees_AppClientInformation_Subscribe | This service operation is used by the EAS to subscribe to EES, for reporting of AC information. | EAS | +| Eees_AppClientInformation_Notify | This service operation is used by the EES to notify the EAS about the AC information. | EES | +| Eees_AppClientInformation_UpdateSubscription | This service operation is used by the EAS to update its subscription at EES, for reporting of AC information. | EAS | +| Eees_AppClientInformation_Unsubscribe | This service operation is used by the EAS to remove its subscription from EES, for reporting of AC information. | EAS | + +## 5.5.2.2 Eees\_AppClientInformation\_Subscribe + +### 5.5.2.2.1 General + +This service operation is used by the EAS to subscribe for AC(s) information reporting. + +### 5.5.2.2.2 EAS subscribing to AC information reporting from EES using Eees\_AppClientInformation\_Subscribe operation + +To subscribe to AC information reporting at the EES, the EAS shall send an HTTP POST request to the EES targeting the "Application Client Information Subscriptions" resource, with the request body containing the ACInfoSubscription data structure, as specified in clause 8.4.2.2.3.1. + +Upon receiving the HTTP POST request from the EAS, the EES shall: + +1. Process the EAS AC information subscription request; +2. verify the identity of the Edge Application Server and check if the EAS is authorized to subscribe for the AC information reporting; +3. if the EAS is authorized to subscribe for the AC information reporting, then the EES shall; + - a. create a new resource with the AC Information Subscription as specified in clause 8.4.2.1; and + - b. respond to the EAS with an HTTP "201 Created" status code including an HTTP Location header field containing the URI of the created "Individual Application Client Information Subscription" resource, and the response body containing a representation of the created resource within the ACInfoSubscription data structure. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. If the EAS is not registered at the EES when sending the AC information reporting subscription creation request, the EES shall respond with an HTTP "403 Forbidden" status code with the response body containing the ProblemDetails data structure with the "cause" attribute set to "REGISTRATION\_REQUIRED". + +The EES determines the matching AC information corresponding to the filter criteria information in the subscription request to compose the AC information to the EAS. + +If the expiration time is provided, then to maintain the registration, the EAS shall send a subscription update request (as described in clause 5.5.2.4) prior to the expiration time. If the subscription update request is not sent before the expiry time, then the EES shall treat the subscription as unsubscribed and remove the corresponding EAS's Individual Application Client Information Subscription resource. + +## 5.5.2.3 Eees\_AppClientInformation\_Notify + +### 5.5.2.3.1 General + +This service operation is used by the EES to send AC information notifications to the EAS. + +### 5.5.2.3.2 EES notifying the AC information to EAS using Eees\_AppClientInformation\_Notify operation + +The EES determines to notify the EAS with the AC information matching the filter criteria, when the AC information updates are available to EES, e.g. EES receives registration request from EEC. + +To notify the AC(s) information, the EES shall send an HTTP POST message using the Notification Destination URI received in the subscription request. The body of the HTTP POST message shall include "ACInfoNotification". "ACInfoNotification" includes AC(s) information matching the filter criteria. The AC(s) information consist of AC(s) profiles, UE identifiers hosting the AC(s) and the location information of the UE(s) hosting the AC(s). + +Upon receiving the HTTP POST message, the EAS shall process the AC Information Notification and shall respond to the EES with "204 No Content" message. + +On failure, the EAS shall take proper error handling actions, as specified in clause 8.4.6, and respond to the EES with an appropriate error status code. + +If the EAS determines that the received HTTP POST message needs to be redirected, the EAS may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EAS where the notification should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +### 5.5.2.4 Eees\_AppClientInformation\_UpdateSubscription + +#### 5.5.2.4.1 General + +This service operation is used by the EAS to update its AC information subscription at the EES. + +#### 5.5.2.4.2 EAS updating AC information reporting subscription at EES using Eees\_AppClientInformation\_UpdateSubscribe operation + +To update AC information reporting subscription at the EES, the EAS shall send a HTTP PATCH or PUT message to the EES on resource URI identifying the "Individual Application Client Information" Subscription resource representation, as specified in clause 8.4.2.3.3.2 for HTTP PATCH message and in clause 8.4.2.3.3.3 for HTTP PUT message. + +The PATCH message includes the parameters (AC filter criteria, Notification Destination, Reporting requirements and proposed expiry time) that need to be replaced in the existing subscription resource. + +The PUT message shall replace all the properties of the existing resource with the AC subscription information in the request. The request shall not replace the "easId" property of the existing resource. + +Upon receiving the HTTP PATCH or PUT message from the EAS, the EES shall: + +1. check the update subscription message from the EAS to see if the EAS is authorized to modify the requested subscription resource; +2. if the EAS is authorized to update the AC information subscription, then the EES shall: + - a. update the resource identified by Resource URI of the EAS AC information subscription with the updated information received in the HTTP PATCH or PUT request message; + - b. return the updated EAS AC information subscription in the "200 OK" response message or respond with the "204 No Content" message indicating to the EAS that the EAS AC information subscription is updated successfully. In the response message, the EES may provide an updated expiration time to indicate to the EAS when the updated subscription will automatically expire. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP PATCH or PUT response body. If the EAS is not registered at the EES when sending the AC information reporting subscription update request, the EES shall respond with an HTTP "403 Forbidden" status code with the response body containing the ProblemDetails data structure with the "cause" attribute set to "REGISTRATION\_REQUIRED". + +If the EES determines that the received HTTP PATCH or PUT message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +If the expiration time is provided, then to maintain the subscription, the EAS shall send an update subscription prior to subscription expiry time. If the update subscription request is not sent before the expiry time, then the EES shall treat EAS subscription as unsubscribed and remove the corresponding EAS AC information subscription resource. + +## 5.5.2.5 Eees\_AppClientInformation\_Unsubscribe + +### 5.5.2.5.1 General + +This service operation is used by the EAS to unsubscribe from an existing AC information subscription. + +### 5.5.2.5.2 EAS unsubscribing to AC information reporting from EES using Eees\_AppClientInformation\_Unsubscribe operation + +To unsubscribe its AC information subscription from the EES, the EAS shall send HTTP DELETE message to the EES, on the resource URI identifying the "Individual Application Client Information Subscription" resource representation as specified in clause 8.4.2.3.3.4. Upon receiving the HTTP DELETE request, the EES shall: + +1. verify the identity of the EAS and check if the EAS is authorized to unsubscribe the Individual Application Client Information Subscription resource; +2. if the EAS is authorized to unsubscribe the Individual Application Client Information Subscription resource, then the EES shall unsubscribe the EAS subscription identified by the "subscriptionId" from the EES and delete the resource representing Individual Application Client Information Subscription resource represented by "subscriptionId"; +3. return the "204 Not Content" message to the EAS, indicating the successful removal of the subscription information. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. If the EAS is not registered at the EES when sending the AC information reporting subscription deletion request, the EES shall respond with an HTTP "403 Forbidden" status code with the response body containing the ProblemDetails data structure with the "cause" attribute set to "REGISTRATION\_REQUIRED". + +If the EES determines that the received HTTP DELETE request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +## 5.6 Eees\_SessionWithQoS Service + +### 5.6.1 Service Description + +The Eees\_SessionWithQoS API, as defined in 3GPP TS 23.558 [2], allows an Edge Application Server via Eees interface to support the setup of a data session between AC and EAS with a specific QoS and the modification of the QoS of this data session. + +### 5.6.2 Service Operations + +#### 5.6.2.1 Introduction + +The service operation defined for Eees\_SessionWithQoS API is shown in the table 5.6.2.1-1. + +**Table 5.6.2.1-1: Operations of the Eees\_SessionWithQoS API** + +| Service operation name | Description | Initiated by | +|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Eees_SessionWithQoS_Create | The service operation is used by the EAS to request reservation of resources for a data session between AC and EAS with a specific QoS and to subscribe to certain session with user plane event notifications. | EAS | +| Eees_SessionWithQoS_Update | The service operation is used by the EAS to request a modification of the QoS of the data session between AC and EAS. | EAS | +| Eees_SessionWithQoS_Revoke | The service operation is used by the EAS to revoke the data session between AC and EAS with a specific QoS and to unsubscribe to the related session with user plane event notifications. | EAS | +| Eees_SessionWithQoS_Notify | The service operation is used by the EES to notify the EAS about a user plane event associated with the established session between an AC and the EAS. | EES | + +## 5.6.2.2 Eees\_SessionWithQoS\_Create + +### 5.6.2.2.1 General + +This service operation is used by EAS to request reservation of resources for a data session between AC and EAS with a specific QoS and to subscribe to certain session with user plane event notifications. + +### 5.6.2.2.2 EAS requesting reservation of resources for a data session between AC and EAS with specific QoS using Eees\_SessionWithQoS operation + +To request establishment of a data session between AC and EAS with a specific QoS, the EAS shall send a HTTP POST message to the Edge Enabler Server on the "Sessions with QoS" resource as specified in clause 8.5.2.2.3.1. The body of POST message shall include the EAS identifier, only one of the UE's IP address or the Identifier of the UE or the identifier of the group uniquely identifying a group of UEs, IP flow description, and at least one of requested QoS reference. The body of POST message may include a list of associated events which the EAS subscribes, and if the event list is included, a Notification Destination URI shall also be provided. + +Upon receiving the HTTP POST message from the EAS: + +1. the EES shall process the EAS Session with QoS Create request; +2. the EES shall verify the identity of the EAS and check if the EAS is authorized to request reservation of resources for a data session between AC and EAS with a specific QoS; +3. if the EAS is authorized, then the EES shall; + - a. create a new resource "Individual Session with QoS"; + - b. if the request is for a group of UEs identified by group ID (i.e., via the "intGrpId" or "extGrpId") or for a single UE identified via the "ueId" attribute, interact with the SCEF (as specified in 3GPP TS 29.122 [6]) or the NEF (as specified in 3GPP TS 29.522 [10]) by invoking the MonitoringEvent API with the monitoring type sets to "PDN\_CONNECTIVITY\_STATUS" to request to be notified when the 3GPP network detects the UE's PDN connection or PDU session is set up or torn down. If the IP address for the single UE or, the IP address(es) for one or more UEs within the group are received from the 3GPP network, then execute step 3c; and + - c. if the request is for a single UE identified by the IP address or the IP address is obtained in step 3b, interact directly with the PCRF (as specified in 3GPP TS 29.214 [15]) or the PCF (as specified in 3GPP TS 29.514 [16]), or via the SCEF (as specified in 3GPP TS 29.122 [6]) or the NEF (as specified in 3GPP TS 29.522 [10]) by invoking the AsSessionWithQoS API, to provide the specific QoS information to the PCF. +4. if the EAS is authorized, then if one of the subscribed event(s) is "UP\_PATH\_CHG", "ACR\_MONITORING" and/or "ACR\_FACILITATION" event: + +- a) if the "EdgeApp\_2" feature is supported, the EAS may provide the traffic filter information in the "trafFilterInfo" attribute in the request body: + - i) the EES may invoke the Nnef\_PfdManagement API as described in clause 4.4.6 of 3GPP TS 29.522 [10] and clause 4.4.10 of 3GPP TS 29.122 [18] with the same Application Identifier that is used for requesting user plane path management events monitoring as defined further below; + - ii) if the Application Identifier is not provided by the EAS, the EES may map the EASID into the Application Identifier that is used to invoke the Nnef\_PfdManagement API; and + - iii) if the invocation of the PFD Management procedures towards the 3GPP network fails (e.g. the PFD Management service is not supported by the 3GPP Core Network), the EES shall reject the request in step 6 with an appropriate error response + - iv) if the PFD Management service is not supported by the 3GPP Core Network, the EES shall reject the request with an HTTP "403 Forbidden" status code with the response content containing a ProblemDetails data structure with the "cause" attribute including the "PFD\_MNGT\_NOT\_SUPPORTED" application error; +- 5. upon receipt of successful response from 3GPP network, respond to the EAS with "201 Created" and include the session with QoS context information. The new created resource URI shall also be included in the Location header field of the HTTP response message. + +On failure, the EES shall take proper error handling actions, as specified in clause 8.5.6, and respond to the EAS with an appropriate error status code. + +### 5.6.2.3 Eees\_SessionWithQoS\_Update + +#### 5.6.2.3.1 General + +This service operation is used by EAS to request updating QoS of a data session between AC and EAS and to modify the subscription of the session with user plane event notifications. + +#### 5.6.2.3.2 EAS updating QoS of a data session between AC and EAS using Eees\_SessionWithQoS\_Update operation + +To request modification of the QoS of the data session between AC and EAS, the EAS shall send a HTTP PATCH or PUT message to the EES on resource URI "Individual Session with QoS" resource as specified in clause 8.5.2.3.3.1 for HTTP PATCH message and in clause 8.5.2.3.3.2 for HTTP PUT message. + +The PUT message shall replace all the QoS settings of the data session in the existing context. The request shall not change the values of the "easId", "ueId", "ueIpv4Addr", "ueIpv6Addr", "ipDomain", "intGrpId", "extGrpId", "dnn" and/or "snssai" attributes. + +Upon receiving the HTTP PATCH or PUT message from the EAS: + +1. the EES shall check the update of the existing Individual Session with QoS from the EAS is authorized or not; +2. if the EAS is authorized, then if one of the subscribed event(s) is "UP\_PATH\_CHG", "ACR\_MONITORING" and/or "ACR\_FACILITATION" event: + - a) if the "EdgeApp\_2" the EAS may provide the traffic filter information in the "trafFilterInfo" attribute in the request body: + - i) the EES may invoke the Nnef\_PfdManagement API as described in clause 4.4.6 of 3GPP TS 29.522 [10] and clause 4.4.10 of 3GPP TS 29.122 [18] with the same Application Identifier that is used for requesting user plane path management events monitoring as defined further below; + - ii) if the Application Identifier is not provided by the EAS, the EES may map the EASID into the Application Identifier that is used to invoke the Nnef\_PfdManagement API; and + - iii) if the invocation of the PFD Management procedures towards the 3GPP network fails (e.g. the PFD Management service is not supported by the 3GPP Core Network), the EES shall reject the request in step 6 with an appropriate error response + +iv) , e.g. with an HTTP "403 Forbidden" status code with the response content containing a ProblemDetails data structure with the "cause" attribute including the "PFD\_MNGT\_NOT\_SUPPORTED" application error if the PFD Management service is not supported by the 3GPP Core Network; + +3. if the EAS is authorized, and to update the QoS setting, then the EES shall: + +- a. interact with the 3GPP network to update the associated data session; and +- b. upon receipt of successful response from 3GPP network, respond to the EAS with "204 No Content", or "200 OK" with the updated Individual session with QoS context in the response message. + +On failure, the EES shall take proper error handling actions, as specified in clause 8.5.6, and respond to the EAS with an appropriate error status code. + +If the EES determines that the received HTTP PATCH or PUT message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +## 5.6.2.4 Eees\_SessionWithQoS\_Revoke + +### 5.6.2.4.1 General + +This service operation is used by EAS to revoke the data session between AC and EAS with a specific QoS and to unsubscribe to the related session with user plane event notifications. + +### 5.6.2.4.2 EAS revoking QoS of a data session between AC and EAS using Eees\_SessionWithQoS\_Revoke operation + +To revoke the data session between AC and EAS with a specific QoS and unsubscribe the user plane event notifications, the EAS shall send a HTTP DELETE message to the EES targeting the Individual Session with QoS resource as specified in clause 8.5.2.3.3.3. Upon receiving the HTTP DELETE request, the EES shall: + +1. verify the identity of the EAS and check if the EAS is authorized to revoke the data session between AC and EAS with a specific QoS; +2. if the EAS is authorized and the resource exists, then the EES shall interact with the 3GPP network to delete the associated data session. +3. upon receipt of successful response from 3GPP network, delete the Individual Session with QoS resource corresponding to the individual Session with QoS; and +4. return "204 No Content" message to the EAS, indicating the successful removal. + +On failure, the EES shall take proper error handling actions, as specified in clause 8.5.6, and respond to the EAS with an appropriate error status code. + +If the EES determines that the received HTTP DELETE message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +## 5.6.2.5 Eees\_SessionWithQoS\_Notify + +### 5.6.2.5.1 General + +This service operation is used by EES to send user plane event notification information of the data session between AC and EAS with a specific QoS to the EAS. + +#### 5.6.2.5.2 EES notifying QoS of a data session between AC and EAS using Eees\_SessionWithQoS\_Notify operation + +The EES determines to notify the user plane event notification information to the EAS, when the EES receives the notification of the user plane event information from the 3GPP core network. + +To notify the user plane event notification information, the EES shall send an HTTP POST message using the Notification Destination URI received during the creation or modification of resource request. The body of POST message shall include the event report information (e.g., resource allocation outcome or information that the QoS targets can no longer (or can again) be fulfilled). + +Upon receiving the HTTP POST message, the EAS shall process the event report information and return "204 No Content" message to the EES. + +On failure, the EAS shall take proper error handling actions, as specified in clause 8.5.6, and respond to the EES with an appropriate error status code. + +If the EAS determines that the received HTTP POST message needs to be redirected, the EAS may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EAS where the notification should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +### 5.7 Eees\_EASDiscovery Service + +#### 5.7.1 Service Description + +The Eees\_EASDiscovery service API enables a service consumer (i.e. EAS, EES) to: + +- request EAS discovery. + +#### 5.7.2 Service Operations + +##### 5.7.2.1 Introduction + +The service operations defined for Eees\_EASDiscovery API are shown in the table 5.7.2.1-1. + +**Table 5.7.2.1-1: Operations of the Eees\_EASDiscovery API** + +| Service operation name | Description | Initiated by | +|-----------------------------------|----------------------------------------------------------------------------------------|--------------| +| Eees_EASDiscovery_TEasDiscRequest | This service operation is used by the EAS or EES to request EAS discovery information. | EES, EAS | + +##### 5.7.2.2 Eees\_EASDiscovery\_TEasDiscRequest + +###### 5.7.2.2.1 General + +This service operation is used by the S-EES or S-EAS to request for T-EAS discovery information, as specified for the Eees\_TargetEASDiscovery API defined in 3GPP TS 23.558 [2]. + +###### 5.7.2.2.2 EES or EAS requesting T-EAS discovery information using Eees\_EASDiscovery\_TEasDiscRequest operation + +To request for T-EAS discovery, the service consumer (i.e. EAS or EES) shall send an HTTP POST request to the EES as specified in clause 6.3.2.4.4.2 of 3GPP TS 24.558 [14]. The body of the POST message shall include the EasDiscoveryReq data structure as specified in clause 6.3.5.2.2 of 3GPP TS 24.558 [14]. + +Upon reception of the HTTP POST request from the service consumer (i.e. EAS or EES), the EES shall: + +- a) process the EAS discovery request information; + +- b) the EES verifies and checks if the service consumer (i.e. EAS or EES) is authorized to discover the requested EAS(s) from the EES; +- c) if the service consumer (i.e. EAS or EES) is authorized to discover the requested EAS(s) from the EES, then upon successful processing of the request, the EES responds with an HTTP "200 OK" status code with the response body including the EasDiscoveryResp data structure as specified in clause 6.3.5.2.3 of 3GPP TS 24.558 [14] and in clause 8.8.3.2 of 3GPP TS 23.558 [2]. If the successful processing of the request does not result in finding a matching EAS (i.e. there is no client side error), the EES responds with an HTTP "204 No Content" status code. + +If the EES determines that the received HTTP POST request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the notification should be sent. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +On failure, the EES shall take proper error handling actions, as specified in clause 6.3.6 of 3GPP TS 24.558 [14], and respond to the EAS or EES with an appropriate error status code. + +## 5.8 Eees\_ACRManagementEvent Service + +### 5.8.1 Service Description + +The Eees\_ACRManagementEvent API, as defined in 3GPP TS 23.558 [2], allows an Edge Application Server via Eees interface to support (un)subscription to the notifications of ACR management events. + +### 5.8.2 Service Operations + +#### 5.8.2.1 Introduction + +The service operation defined for Eees\_ACRManagementEvent API is shown in the table 5.8.2.1-1. + +**Table 5.8.2.1-1: Operations of the Eees\_ACRManagementEvent API** + +| Service operation name | Description | Initiated by | +|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Eees_ACRManagementEvent_Subscribe | The service operation is used by the EAS to subscribe to notifications of ACR management event(s). | EAS | +| Eees_ACRManagementEvent_UpdateSubscription | The service operation is used by the EAS to request a modification of an existing subscription of notifications of ACR management event(s). | EAS | +| Eees_ACRManagementEvent_Unsubscribe | The service operation is used by the EAS to unsubscribe to an existing subscription of notifications of ACR management event(s). | EAS | +| Eees_ACRManagementEvent_Notify | The service operation is used by the EES to notify the EAS about ACR management event(s) if detected. | EES | + +#### 5.8.2.2 Eees\_ACRManagementEvent\_Subscribe + +##### 5.8.2.2.1 General + +This service operation is used by EAS to subscribe to notifications of ACR management events. + +#### 5.8.2.2.2 EAS requesting to get notifications of ACR management events using Eees\_ACRManagementEvent\_Subscribe service operation + +In order to subscribe to notifications of ACR management events, the EAS shall send a HTTP POST request message to the EES targeting the "ACR Management Events Subscriptions" resource as specified in clause 8.6.2.2.3.1. The body of the HTTP POST request message shall include the AcrMgmtEventsSubscription data type as specified in clause 8.6.5.2.2. + +Upon reception of the HTTP POST request message from the EAS: + +1. the EES shall process the ACR management events subscription request; + 2. the EES shall verify the identity of the EAS and check if the EAS is authorized to subscribe to notifications of ACR management events; + 3. if the EAS is authorized, then if one of the subscribed event(s) is "UP\_PATH\_CHG", "ACR\_MONITORING" and/or "ACR\_FACILITATION" event: + - a) if the "EdgeApp\_2" feature is supported, the EAS may provide the traffic filter information in the "trafFilterInfo" attribute in the request body. Then: + - i) the EES may invoke the Nnef\_PfdManagement API as described in clause 4.4.6 of 3GPP TS 29.522 [10] and clause 4.4.10 of 3GPP TS 29.122 [18] with the same Application Identifier that is used for requesting UP path management events monitoring as defined further below; + - ii) if the Application Identifier is not provided by the EAS, the EES may map the EAS ID into the Application Identifier that is used to invoke the Nnef\_PfdManagement API; and + - iii) if the invocation of the PFD Management procedures towards the 3GPP network fails (e.g. the PFD Management service is not supported by the 3GPP Core Network), the EES shall reject the request in step 6 with an appropriate error response + - iv) if the PFD Management service is not supported by the 3GPP Core Network, the EES shall reject the request with an HTTP "403 Forbidden" status code with the response content containing a ProblemDetails data structure with the "cause" attribute including the "PFD\_MNGT\_NOT\_SUPPORTED" application error; + 4. if the EAS is authorized, then if one of the subscribed event(s) is the UP path change event, or when the "EdgeApp\_2" feature is supported, at least one of the "UP\_PATH\_CHG", "ACR\_MONITORING" and/or "ACR\_FACILITATION" event, the EES shall: + - a) if already subscribed to the 3GPP core network (i.e. either directly through the PCF or via the NEF TrafficInfluence API) on UP path management events and there is locally cached UP path change event information, perform step 6, and include the locally cached UP path change event information in the HTTP POST response body; or + - b) if not yet subscribed to the 3GPP core network on UP path management events, interact with the NEF by invoking the TrafficInfluence API as specified in 3GPP TS 29.522 [10] or directly towards the PCF to request to be notified of the UP path change event. Upon receipt of a successful response from the NEF, the EES shall perform step 6; +- NOTE: Only the trusted EES can subscribe to the 3GPP core network directly through the PCF, the untrusted EES needs to subscribe to the 3GPP core network via the NEF. +- 5 the EES may interact with the NEF by invoking the AnalyticsExposure API as specified in 3GPP TS 29.522 [10] to subscribe to notifications of, or retrieve the UE mobility and UE communication events; + - 6a. on success, the EES shall create a new resource "Individual ACR Management Events Subscription" and respond to the EAS with "201 Created" and include the Individual ACR Management Events Subscription information. The new created resource URI shall also be included in the Location header field of the HTTP response message; + - 6b. on failure, the EES shall take proper error handling actions, as specified in clause 8.6.6, and respond to the EAS with an appropriate error status code; + +and + +7. if the target UE and the 3GPP network supports mobility between 5GC and EPC, interact with the SCEF+NEF by invoking the MonitoringEvent API as specified in 3GPP TS 29.122 [6] with the monitoring type sets to "API\_SUPPORT\_CAPABILITY" or interact with the CAPIF core function by invoking the CAPIF\_Events\_API service as specified in 3GPP TS 29.222 [17] to request to be notified the availability of the TrafficInfluence API. + +On failure, the EES shall take proper error handling actions, as specified in clause 8.6.6, and respond to the EAS with an appropriate error status code. + +### 5.8.2.3 Eees\_ACRManagementEvent\_UpdateSubscription + +#### 5.8.2.3.1 General + +This service operation is used by EAS to request updating an existing Individual ACR Management Events Subscription. + +#### 5.8.2.3.2 EAS updating an existing Individual ACR Management Events Subscription using Eees\_ACRManagementEvent\_UpdateSubscription service operation + +To request modification of an existing Individual ACR Management Events Subscription, the EAS shall send a HTTP PATCH request (for partial modification) or PUT request (for fully replacement) message to the EES on resource URI "Individual ACR Management Events Subscription" resource as specified in clause 8.6.2.3.3.1 for HTTP PATCH message and in clause 8.6.2.3.3.2 for HTTP PUT message. This request shall not replace the easId property of the existing resource. + +Upon receiving the HTTP PATCH or PUT message from the EAS: + +1. the EES shall check the update of the existing Individual ACR Management Events Subscription from the EAS is authorized or not; +2. if the EAS is authorized, then if one of the subscribed event(s) is UP path change event, the EES shall: + - a) if already successful subscribed to the 3GPP core network and there is local cached UP path change event information, perform step 3, and include the local cached UP path change event information in the HTTP PUT or PATCH response; or + - b) if not subscribed to the 3GPP core network yet, interact with the NEF by invoking the TrafficInfluence API as specified in 3GPP TS 29.522 [10] to request to be notified of the UP path change event. Upon receipt of successful response from the NEF, then the EES shall perform step 3. + +The EES may interact with the NEF by invoking the AnalyticsExposure API as specified in 3GPP TS 29.522 [10] to subscribe to notifications of, or retrieve the UE mobility and UE communication events. + +3. if the EAS is authorized, then if one of the subscribed event(s) is "UP\_PATH\_CHG", "ACR\_MONITORING" and/or "ACR\_FACILITATION" event: + - a) if the "EdgeApp\_2", the EAS may update/modify/provide the traffic filter information within the "trafFilterInfo" attribute in the request body. Then: + - i) the EES may invoke the Nnef\_PfdManagement API as described in clause 4.4.6 of 3GPP TS 29.522 [10] and clause 4.4.10 of 3GPP TS 29.122 [18] with the same Application Identifier that is used for requesting or updating/modifying UP path management events monitoring as defined further below; + - ii) if the Application Identifier is not provided by the EAS, the EES may map the EAS ID into the Application Identifier that is used to invoke the Nnef\_PfdManagement API; and + - iii) if the invocation of the PFD Management procedures towards the 3GPP network fails (e.g. the PFD Management service is not supported by the 3GPP Core Network), the EES shall reject the request in step 6 with an appropriate error response + - iv) if the PFD Management service is not supported by the 3GPP Core Network, the EES shall reject the request with an HTTP "403 Forbidden" status code with the response content containing a + +ProblemDetails data structure with the "cause" attribute including the "PFD\_MNGT\_NOT\_SUPPORTED" application error; + +4. on success, the EES shall update the existing resource "Individual ACR Management Events Subscription", respond to the EAS with "204 No Content", or "200 OK" with the updated Individual ACR Management Events Subscription message. + +On failure, the EES shall take proper error handling actions, as specified in clause 8.6.6, and respond to the EAS with an appropriate error status code. + +If the EES determines that the received HTTP PATCH or PUT message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +#### 5.8.2.4 Eees\_ACRManagementEvent\_Unsubscribe + +##### 5.8.2.4.1 General + +This service operation is used by EAS to delete an existing ACR Management Events Subscription. + +##### 5.8.2.4.2 EAS deleting an existing Individual ACR Management Events Subscription using Eees\_ACRManagementEvent\_Unsubscribe service operation + +To delete an existing "Individual ACR Management Events Subscription", the EAS shall send a HTTP DELETE request message to the EES targeting the concerned "Individual ACR Management Events Subscription" resource as specified in clause 8.6.2.3.3.3. Upon receiving the HTTP DELETE request: + +1. the EES shall verify the identity of the EAS and check if the EAS is authorized to delete the concerned ACR Management Events Subscription; +2. if the EAS is authorized and the resource exists, then the EES may interact with the 3GPP network to delete the associated Subscription(s), if needed; And + +NOTE: The EES can keep the existing subscription(s) with the 3GPP network, e.g. if they are useful for other existing ACR Management Events subscriptions from other EASs. + +3. upon successful processing of the request and the receipt of a successful response from 3GPP network, if needed as per step 2 above, the EES shall delete the Individual ACR Management Events Subscription; and respond with an HTTP "204 No Content" status code to the EAS, indicating the successful deletion of the concerned "Individual ACR Management Events Subscription" resource. + +On failure, the EES shall take proper error handling actions, as specified in clause 8.6.6, and respond to the EAS with an appropriate error status code. + +If the EES determines that the received HTTP DELETE message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +#### 5.8.2.5 Eees\_ACRManagementEvent\_Notify + +##### 5.8.2.5.1 General + +This service operation is used by EES to send ACR management event notification information or the availability of user path management events monitoring via the 3GPP 5GC network to the EAS. + +#### 5.8.2.5.2 EES notifying ACR management events using Eees\_ACRManagementEvent\_Notify operation + +In order to notify the ACR management event information, the EES shall send an HTTP POST message using the Notification Destination URI received during the creation or modification of subscription. The body of POST message shall include the AcrMgmtEventsNotification data type as specified in clause 8.6.5.2.4. + +Upon receiving the HTTP POST message, the EAS shall process the event report information and return to the EES, either: + +1. "204 No Content" message; or +2. "200 OK" message including EasAckInformation data type as specified in clause 8.6.5.2.15. + +On failure, the EAS shall take proper error handling actions, as specified in clause 8.6.6, and respond to the EES with an appropriate error status code. + +If the EAS determines that the received HTTP POST request needs to be redirected, the EAS may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EAS where the notification should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +#### 5.8.2.5.3 EES notifying the availability of user path management events monitoring via the 3GPP 5GC network using Eees\_ACRManagementEvent\_Notify operation + +In order to notify of the availability of user path management events monitoring via the 3GPP 5GC network, the EES shall send an HTTP POST request message targeting the URI "{notificationDestination}/report-availability", where the Notification Destination URI is the one received during the creation or modification of the ACR management event subscription. The body of HTTP POST request message shall include the AvailabilityNotif data type as specified in clause 8.6.5.2.11. + +NOTE: The EAS is subscribed by default to the reception of notifications on the availability of user path management events monitoring via the 3GPP 5GC network. + +Upon receiving the HTTP POST request message, the EAS shall process the received information and respond to the EES with an HTTP "204 No Content" status code. + +On failure, the EAS shall take proper error handling actions, as specified in clause 8.6.6, and respond to the EES with an appropriate error status code. + +If the EAS determines that the received HTTP POST request needs to be redirected, the EAS may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EAS where the notification should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +### 5.9 Eees\_AppContextRelocation Service + +#### 5.9.1 Service Description + +The Eees\_AppContextRelocation API, allows S-EAS to declare to the S-EES about the T-EAS selected by the S-EAS or allows S-EAS to request ACR determination to the S-EES. + +#### 5.9.2 Service Operations + +##### 5.9.2.1 Introduction + +The service operation defined for Eees\_AppContextRelocation API is shown in the table 5.9.2.1-1. + +**Table 5.9.2.1-1: Operations of the Eees\_AppContextRelocation API** + +| Service operation name | Description | Initiated by | +|-----------------------------------------------------|-----------------------------------------------------------------------------------------------|--------------| +| Eees_AppContextRelocation_SelectedTargetEAS_Declare | This service operation is used by the S-EAS to inform the S-EES about selection of the T-EAS. | EAS | +| Eees_AppContextRelocation_ACRDetermination_Request | This service operation is used by the S-EAS to request the S-EES to determine the ACR. | EAS | + +## 5.9.2.2 Eees\_AppContextRelocation\_SelectedTargetEAS\_Declare + +### 5.9.2.2.1 General + +This service operation is used by S-EAS to declare the selected T-EAS information to the S-EES, as specified in 3GPP TS 23.558 [2]. + +#### 5.9.2.2.2 S-EAS informing the S-EES about the selected T-EAS using Eees\_AppContextRelocation\_SelectedTargetEAS\_Declare operation + +To declare the selected T-EAS information to the S-EES, the S-EAS shall send an HTTP POST request message to the S-EES targeting the URI "{apiRoot}/ees-appctxtreloc/v1/declare" as specified in clause 6.5.3.4 of 3GPP TS 24.558 [14]. The request body of the POST request message (i.e. "Declare" custom operation) includes the AcrDecReq data structure as specified in clause 6.5.5.2.4 of 3GPP TS 24.558 [14]. + +Upon receiving the HTTP POST message from the EAS, the EES shall: + +1. Process the EAS request; +2. verify the identity of the EAS and check if the EAS is authorized to declare the T-EAS information; +3. if the EAS is authorized to declare T-EAS information, then the EES shall send successful declaration response message to S-EAS. + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +If the EES determines that the received HTTP POST message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +## 5.9.2.3 Eees\_AppContextRelocation\_ACRDetermination\_Request + +### 5.9.2.3.1 General + +This service operation is used by S-EAS to request the S-EES to determine the ACR, as specified in the Eees\_AppContextRelocation\_Request operation with ACR determination part in 3GPP TS 23.558 [2]. + +#### 5.9.2.3.2 S-EAS request the S-EES to determine the ACR using Eees\_AppContextRelocation\_ACRDetermination\_Request operation + +To request the S-EES to determine the ACR, the S-EAS shall send a HTTP POST message to the S-EES on the custom URI "{apiRoot}/ees-appctxtreloc/v1/determine" as specified in clause 6.5.3.2 of 3GPP TS 24.558 [14]. The request body of the POST message includes the AcrDetermReq data structure with information about the S-EAS end point information and may include other optional information on UE and/or EASID as specified in clause 6.5.5.2.2 of 3GPP TS 24.558 [14]. + +Upon receiving the HTTP POST message from the EAS, the EES shall: + +1. process the EAS request; +2. verify the identity of the EAS and check if the EAS is authorized to request ACR determination; + +3. if the EAS is authorized to request the ACR , then the EES shall; + - a. send successful ACR determination response to S-EAS with an HTTP "204 No Content" status code; + - b. additionally, the S-EES determines the T-EES via the Discover T-EAS procedure and may notify the EEC with target information and/or ACR result notification as specified in 3GPP TS 24.558 [14]; + - c. if the ACR determination handling met with failure case , the S-EES shall send a proper HTTP error status code and may include additional error information in the POST response body. + +If the EES determines that the received HTTP POST message needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +## 5.10 Eees\_EECContextRelocation Service + +### 5.10.1 Service Description + +The Eees\_EECContextRelocation API enables the EEC context relocation from a service consumer (e.g.S-EES or CES) to T-EES, as defined in 3GPP TS 23.558 [2]. The Eees\_EECContextRelocation\_Pull service operation enables EEC context relocation from service consumer (e.g., S-EES or CES) to T-EES, upon request from the T-EES to S-EES or CES, as specified by Eees\_EECContextPull API in 3GPP TS 23.558 [2]. The Eees\_EECContextRelocation\_Push service operation enables EEC context relocation from a service consumer (e.g., S-EES, CES) to T-EES, upon a request from the service consumer to T-EES, as specified by Eees\_EECContextPush API in 3GPP TS 23.558 [2]. + +### 5.10.2 Service Operations + +#### 5.10.2.1 Introduction + +The service operation defined for Eees\_EECContextRelocation API is shown in the table 5.10.2.1-1. + +**Table 5.10.2.1-1: Operations of the Eees\_EECContextRelocation API** + +| Service operation name | Description | Initiated by | +|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Eees_EECContextRelocation_Pull | This service operation is used by the T-EES to fetch the EEC context information from a service consumer (e.g., S-EES or CES) to relocate the EEC context information from the service consumer to T-EES. | EES, CES | +| Eees_EECContextRelocation_Push | This service operation is used by the service consumer (e.g., S-EES, CES) to push the EEC context information to T-EES to relocate the EEC context information form the service consumer to T-EES. | EES, CES | + +#### 5.10.2.2 Eees\_EECContextRelocation\_Pull + +##### 5.10.2.2.1 General + +This service operation is used by T-EES to relocate the EEC context information from the S-EES or CES, as specified in 3GPP TS 23.558 [2]. + +#### 5.10.2.2.2 T-EES relocating EEC context information from a service consumer S-EES or CES to T-EES using Eees\_EECContextRelocation\_Pull operation + +To relocate the EEC context information from a service consumer (e.g., S-EES or CES) to the T-EES, the T-EES shall send HTTP GET message to the service consumer S-EES or CES, with the request URI set to "{apiRoot}/ees-eecontextreloc/v1/ee-contexts" as specified in the clause 8.7.2.2.3.1. The query parameters shall include EEC context identifier, identifier of the requesting T-EES and may include the list of service context information. + +Upon receiving the HTTP GET message from the T-EES, the service consumer S-EES or CES shall: + +1. Validate the request and verifies if the T-EES is authorized to relocate the EEC context; +2. if the T-EES is authorised, then authorizes the EEC context relocation, based on EEC context identifier in the request; +3. respond with HTTP "200 OK" status code, with the response body including the EECContext data type, containing the EEC context information corresponding to the query parameters provided in the HTTP GET message. + +On failure, the service consumer S-EES or CES shall take proper error handling actions, as specified in clause 8.7.6, and respond to the T-EES with an appropriate error status code. + +#### 5.10.2.3 Eees\_EECContextRelocation\_Push + +##### 5.10.2.3.1 General + +This service operation is used by a service consumer (e.g., S-EES, CES) to relocate the EEC context information to the T-EES, as specified in 3GPP TS 23.558 [2]. + +##### 5.10.2.3.2 Service consumer relocating EEC context information from the service consumer to T-EES using Eees\_EECContextRelocation\_Push operation + +To transfer the EEC context information from a service consumer (e.g., S-EES, CES) to the T-EES, the service consumer shall send HTTP POST message to the T-EES, with the request URI set to "{apiRoot}/ees-eecontextreloc/v1/ee-contexts" as specified in the clause 8.7.2.2.3.2. The request body shall include the EEC Context information and identifier of the service consumer requesting to relocate the EEC Context. + +Upon receiving the HTTP POST message from the service consumer, the T-EES shall: + +1. Validate the request and verifies if the service consumer is authorized to transfer the EEC context; +2. if the service consumer is authorised, then authorizes the EEC context relocation, based on EEC context identifier in the request; +3. if authorized, the T-EES stores the EEC Context and respond with either: + - an HTTP "200 OK" status code with the response body including the EECContextPushRes data structure containing the EEC registration identifier, and if available, the associated expiration time, if implicit registration of the EEC at the T-EES is performed, i.e. in the case of S-EAS decided ACR scenario specified in clause 8.8.2.4 and 8.8.2B.2.4 of 3GPP TS 23.558 [2] or S-EES executed ACR scenarios specified in clause 8.8.2.5 and 8.8.2B.2.5 of 3GPP TS 23.558 [2]; or + - an HTTP "204 No content" status code, indicating that the EEC Context transfer is successful, if implicit registration of the EEC at the T-EES is not performed. + +NOTE: If the EEC, for which the EEC context is pushed by the service consumer, is not registered with the T-EES, then the T-EES determines that the push request is for S-EAS decided ACR in clause 8.8.2.4 and 8.8.2B.2.4 of 3GPP TS 23.558 [2] or S-EES executed ACR scenarios defined in clauses 8.8.2.5 and 8.8.2B.2.5 of 3GPP TS 23.558 [2]. + +On failure, the T-EES shall take proper error handling actions, as specified in clause 8.7.6, and respond to the service consumers with an appropriate error status code. + +On success, if the EEC registration ID and the associated expiration time are provided by the T-EES in the EEC context push response, then the service consumer stores them, and when required, includes them in the subsequent ACR information notification towards the EEC. + +## 5.11 Eees\_EELManagedACR Service + +### 5.11.1 Service Description + +The Eees\_EELManagedACR service exposed by the EES enables a service consumer (i.e. EAS) to: + +- request the EES (i.e. S-EES) to handle all the operations of an ACR; +- subscribe to ACT status reporting during an EEL Managed ACR; and +- receive notifications from the EES (i.e. T-EES) on ACT status during an EEL Managed ACR. + +### 5.11.2 Service Operations + +#### 5.11.2.1 Introduction + +The service operations defined for Eees\_EELManagedACR API are shown in the table 5.11.2.1-1. + +**Table 5.11.2.1-1: Eees\_EELManagedACR Service Operations** + +| Service operation name | Description | Initiated by | +|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Eees_EELManagedACR_Request | This service operation enables a service consumer (i.e. S-EAS) to request the EES (i.e. S-EES) to handle all the operations of an ACR. | EAS | +| Eees_EELManagedACR_Subscribe | This service operation enables a service consumer (i.e. T-EAS) to subscribe to ACT status reporting during an EEL Managed ACR. | EAS | +| Eees_EELManagedACR_Notify | This service operation enables a service consumer (i.e. T-EAS) to receive notifications from the EES (i.e. T-EES) on ACT status during an EEL Managed ACR. | EES | + +#### 5.11.2.2 Eees\_EELManagedACR\_Request + +##### 5.11.2.2.1 General + +This service operation is used by a service consumer (i.e. S-EAS) to request the EES (i.e. S-EES) to handle all the operations of an ACR. + +The following procedures are supported by the "Eees\_EELManagedACR\_Request" service operation: + +- EEL Managed ACR Request procedure. + +##### 5.11.2.2.2 EEL Managed ACR Request + +The EEL Managed ACR Request procedure enables a service consumer (i.e. S-EAS) to request the EES (i.e. S-EES) to handle all the operations of an ACR (see also clause 8.8.3.6 of 3GPP TS 23.558 [2]). + +1. The service consumer (i.e. S-EAS) shall send for this purpose an HTTP POST request (custom operation: "Request") to the EES, with the request URI set to "{apiRoot}/eees-eel-acr//request-eelacr" and the request body including the EELACRReq data structure as defined in clause 8.8.6.2.2. +- 2a. Upon success, the EES shall respond with an HTTP "200 OK" status code with the response body including the feedback from the EES within the EELACRResp data structure as defined in clause 8.8.6.2.3. + +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +### 5.11.2.3 Eees\_EELManagedACR\_Subscribe + +#### 5.11.2.3.1 General + +This service operation is used by a service consumer (i.e. T-EAS) to subscribe to ACT status information reporting at the EES (i.e. T-EES). + +The following procedures are supported by the "Eees\_EELManagedACR\_Subscribe" service operation: + +- Subscribe to ACT status information reporting. + +#### 5.11.2.3.2 Subscribe to ACT status information reporting + +This procedure enables a service consumer (i.e. T-EAS) to request the creation of a subscription to ACT status information reporting (see also clause 8.8.3.6 of 3GPP TS 23.558[2]). + +1. In order to subscribe to ACT status reporting, the service consumer (i.e. T-EAS) shall send an HTTP POST request to the EES, with the request URI set to "{apiRoot}/eees-eel-acr//subscriptions" and the request body including the ACTStatusSubsc data structure as defined in clause 8.8.6.2.4. +- 2a. Upon success, the EES shall respond with an HTTP "201 Created" status code with the response body containing a representation of the created Individual ACT Status Subscription resource within the ACTStatusSubsc data structure as defined in clause 8.8.6.2.4. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +### 5.11.2.4 Eees\_EELManagedACR\_Notify + +#### 5.11.2.4.1 General + +This service operation is used by an EES (i.e. T-EES) to notify a previously subscribed service consumer (i.e. T-EAS) on ACT status information. + +The following procedures are supported by the "Eees\_EELManagedACR\_Notify" service operation: + +- ACT Status Notification. + +#### 5.11.2.4.2 ACT Status Notification + +The ACT Status Notification procedure enables an EES (i.e. T-EES) to notify a previously subscribed service consumer (i.e. T-EAS) on ACT status information (see also clause 8.8.3.6 of 3GPP TS 23.558[2]). + +1. The EES (i.e. T-EES) shall send for this purpose an HTTP POST request to the service consumer (i.e. T-EAS) with the request URI set to "{notificationUri}/act-status", where the "notificationUri" is set to the value received from the service consumer (i.e. T-EAS) during the ACT status reporting subscription procedure defined in clause 5.11.2.3, and the request body including the ACTStatusNotif data structure as defined in clause 8.8.6.2.5. +- 2a. Upon success, the service consumer (i.e. T-EAS) shall respond with an HTTP "204 No Content" status code to acknowledge the reception of the notification to the EES. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +If the service consumer (i.e. T-EAS) is not able to handle the notification request or determines that the received HTTP POST request needs to be redirected, the EAS may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EAS where the notification should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +## 5.12 Eees\_ACRStatusUpdate Service + +### 5.12.1 Service Description + +The Eees\_ACRStatusUpdate service exposed by the EES enables a service consumer (i.e. S-EAS or T-EAS) to: + +- update the information related to ACR (e.g. indicate the status of ACT, update the notification target address); and +- receive from the EES (i.e. T-EES) the status of EDGE-3 subscription relocation, including subscription ID update for EDGE-3 subscriptions. + +### 5.12.2 Service Operations + +#### 5.12.2.1 Introduction + +The service operations defined for Eees\_ACRStatusUpdate API are shown in the table 5.12.2.1-1. + +**Table 5.12.2.1-1: Eees\_ACRStatusUpdate Service Operations** + +| Service operation name | Description | Initiated by | +|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Eees_ACRStatusUpdate_Request | This service operation enables a service consumer (i.e. S-EAS or T-EAS) to update the information related to ACR (e.g. indicate the status of ACT, update the notification target address) at the EES. | EAS | + +#### 5.12.2.2 Eees\_ACRStatusUpdate\_Request + +##### 5.12.2.2.1 General + +This service operation is used by a service consumer (i.e. S-EAS or T-EAS) to update the information related to ACR (e.g. indicate the status of ACT, update the notification target address) at the EES. + +The following procedures are supported by the "Eees\_ACRStatusUpdate\_Request" service operation: + +- ACR Status Update Request procedure. + +##### 5.12.2.2.2 ACR Status Update Request + +The ACR Status Update Request procedure enables a service consumer (i.e. S-EAS or T-EAS) to request to update the EES to request to update the information related to ACR (see also clause 8.8.3.8 of 3GPP TS 23.558 [2]). + +1. The service consumer (S-EAS or T-EAS) shall send for this purpose an HTTP POST request (custom operation: "Request") to the EES, with the request URI set to "{apiRoot}/ees-acrstatus-update//request-acrupdate" and the request body including the ACRUpdateData data structure defined in clause 8.9.6.2.2. +2. Upon receiving the HTTP POST request message from the EAS, the EES shall check whether the EAS is authorized to update the ACR status. Then: + - 2a. Upon success, the EES shall respond with an HTTP "200 OK" status code with the response body including the feedback from the EES within the ACRDataStatus data structure defined in clause 8.9.6.2.3, or an HTTP "204 No Content" status code. + - 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +If the EES determines that the received HTTP POST request needs to be redirected, the EES may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative EES where the message should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +## 5.13 Eees\_ACRParameterInformation Service + +### 5.13.1 Service Description + +The Eees\_ACRParameterInformation service exposed by the EES enables a service consumer (e.g., S-EES, CES) to: + +- send ACR parameters information to the EES (i.e., T-EES). + +### 5.13.2 Service Operations + +#### 5.13.2.1 Introduction + +The service operations defined for the Eees\_ACRParameterInformation API are shown in the table 5.13.2.1-1. + +**Table 5.13.2.1-1: Eees\_ACRParameterInformation Service Operations** + +| Service operation name | Description | Initiated by | +|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------| +| Eees_ACRParameterInformation_Request | This service operation enables a service consumer (e.g., S-EES, CES) to send ACR parameters information to the EES (i.e., T-EES). | EES, CES | + +#### 5.13.2.2 Eees\_ACRParameterInformation\_Request + +##### 5.13.2.2.1 General + +This service operation is used by a service consumer (e.g., S-EES, CES) to send ACR parameters information to the EES (i.e., T-EES). + +The following procedures are supported by the "Eees\_ACRParameterInformation\_Request" service operation: + +- ACR Parameters Information Request procedure. + +##### 5.13.2.2.2 ACR Parameter Information Request + +The ACR Parameter Information Request procedure enables a service consumer (e.g., S-EES, CES) to send ACR parameters information to the EES (i.e., T-EES) (see clause 8.8.3.9 of 3GPP TS 23.558[2]). + +1. The service consumer (e.g., S-EES, CES) shall send for this purpose an HTTP POST request (custom operation: "Request") to the EES (i.e., T-EES), targeting the custom operation URI "{apiRoot}/ees-acr-param//send-acrparamsinfo" and the request body including the ACRParamsInfo data structure defined in clause 8.10.6.2.2. +2. Upon reception of the HTTP POST request message from the service consumer (e.g., S-EES, CES), the EES (i.e., T-EES) shall check whether the S-EES is authorized to send the ACR parameter information. Then: + - 2a. upon success, the EES (i.e., T-EES) shall respond with an HTTP "200 OK" status code with the response body including the ACRParamsInfo data structure defined in clause 8.10.6.2.3, or an HTTP "204 No Content" status code; and + - 2b. on failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information, as defined in clause 8.10.7, should be returned in the HTTP POST response body. + +If the EES (i.e., T-EES) is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative target URI of the custom operation in an alternative EES (i.e. T-EES), as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +## 5.14 Eees\_CommonEASAnnouncement Service + +### 5.14.1 Service Description + +The Eees\_CommonEASAnnouncement service exposed by the EES enables a service consumer (i.e. announcing EES) to: + +- send common EAS information to the receiving EES. + +### 5.14.2 Service Operations + +#### 5.14.2.1 Introduction + +The service operations defined for the Eees\_CommonEASAnnouncement API are shown in the table 5.14.2.1-1. + +**Table 5.14.2.1-1: Eees\_CommonEASAnnouncement Service Operations** + +| Service operation name | Description | Initiated by | +|------------------------------------|------------------------------------------------------------------------------------------------------------------------------|--------------| +| Eees_CommonEASAnnouncement_Declare | This service operation enables a service consumer (i.e. announcing EES) to send common EAS information to the receiving EES. | EES | + +#### 5.14.2.2 Eees\_CommonEASAnnouncement\_Declare + +##### 5.14.2.2.1 General + +This service operation is used by a service consumer (i.e. announcing EES) to send common EAS information to the receiving EES. + +The following procedures are supported by the "Eees\_CommonEASAnnouncement\_Declare" service operation: + +- Declare Common EAS Information Request procedure. + +##### 5.14.2.2.2 Declare Common EAS Information Request + +The Declare Common EAS Information Request procedure enables a service consumer (i.e. announcing EES) to send common EAS information to the receiving EES (see clause 8.19.2 of 3GPP TS 23.558[2]). + +1. The service consumer (i.e. announcing EES) shall send for this purpose an HTTP POST request (custom operation: "Declare") to the EES (i.e. receiving EES), with the request URI set to "{apiRoot}/ees-common-eas//declare" and the request body including the CommonEASInfo data structure defined in clause 8.11.6.2.2. +2. Upon reception of the HTTP POST request message from the service consumer (i.e. announcing EES), the EES (i.e. receiving EES) shall check whether the declaring EES is authorized to declare the common EAS information. Then: + - 2a. upon success, the EES (i.e. announcing EES) shall respond with an HTTP "204 No Content" status code indicating that the common EAS information is successfully received.; and + - 2b. on failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information, as defined in clause 8.11.7, should be returned in the HTTP POST response body. + +If the receiving EES is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative target URI of the custom operation in an alternative EES (i.e. T-EES), as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +## 6 Services offered by Edge Configuration Server + +### 6.1 Introduction + +The table 6.1-1 lists the Edge Configuration Server APIs below the service name. A service description clause for each API gives a general description of the related API. + +**Table 6.1-1: List of ECS Service APIs** + +| Service Name | Service Operations | Operation Semantics | Consumer(s) | +|-------------------------|--------------------|---------------------|-------------| +| Eecs_EESRegistration | Request | Request/Response | EES | +| | Update | Request/Response | EES | +| | Deregister | Request/Response | EES | +| Eecs_TargetEESDiscovery | Request | Request/Response | EES, CES | + +*Editor's note: whether the CES is a consumer of the Eecs\_TargetEESDiscovery is FFS.* + +Table 6.1-2 summarizes the corresponding Edge Configuration Server APIs defined in this specification. + +**Table 6.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-------------------------|--------|-------------------------------------------------|--------------------------------------|-------------------------|-------| +| Eecs_EESRegistration | 9.1 | EES registration service. | TS29558_Eecs_EESRegistration.yaml | eecs-eesregistration | A.11 | +| Eecs_TargetEESDiscovery | 9.2 | Service to discover the target EES information. | TS29558_Eecs_TargetEESDiscovery.yaml | eecs-targeteesdiscovery | A.12 | + +## 6.2 Eecs\_EESRegistration Service + +### 6.2.1 Service Description + +The Eecs\_EESRegistration API, as defined in 3GPP TS 23.558 [2], allows an Edge Enabler Server via Eecs interface to register, update its registration and deregister at a given Edge Configuration Server. + +### 6.2.2 Service Operations + +#### 6.2.2.1 Introduction + +The service operation defined for Eecs\_EESRegistration API is shown in the table 6.2.2.1-1. + +**Table 6.2.2.1-1: Operations of the Eecs\_EESRegistration API** + +| Service operation name | Description | Initiated by | +|---------------------------------|------------------------------------------------------------------------------------------|--------------| +| Eecs_EESRegistration_Request | This service operation is used by the EES to register itself to a given ECS. | EES | +| Eecs_EESRegistration_Update | This service operation is used by the EES to update its registration information at ECS. | EES | +| Eecs_EESRegistration_Deregister | This service operation is used by the EES to deregister itself from a given ECS. | EES | + +## 6.2.2.2 Eecs\_EESRegistration\_Request + +### 6.2.2.2.1 General + +This service operation is used by EES to register itself to a given ECS. + +### 6.2.2.2.2 EES registering to ECS using Eecs\_EESRegistration\_Request operation + +To register itself as an Edge Enabler Server at the ECS, the EES shall send an HTTP POST message to the Edge Configuration Server on the "EES Registrations" collection resource. The body of the HTTP POST message shall include the EES profile information, may include proposed expiration time for the registration, as specified in clause 9.1.2.3.1. + +Upon receiving the HTTP POST message from the EES, the ECS shall: + +1. Process the EES registration request information; +2. verify the identity of the Edge Enabler Server and check if the EES is authorized to register itself at ECS ; +3. if the EES is authorized to register to ECS, then the ECS shall; + - a. store the EES profile and create a new resource with the EES registration information as specified in clause 9.1.2.1; + - b. return the EES registration information, the resource URI of the EES registration information, in the "201 Created" response message. It shall include a Location HTTP header field. The Location header field shall contain the URI of the created registration i.e. +{apiRoot}/eecs-eesregistration//registrations/{registrationId}. The response message may include expiration time to indicate when the EES registration will automatically expire. + +On failure, the ECS shall take proper error handling actions, as specified in clause 9.1.6, and respond to the EES with an appropriate error status code. + +If the expiration time is provided, then to maintain the registration, the EES shall send a registration update request (as described in clause 6.2.2.3) prior to the expiration time. If the registration update request is not sent before the expiry time, then the ECS shall treat the EES as deregistered and remove the corresponding EES registration resource. + +## 6.2.2.3 Eecs\_EESRegistration\_Update + +### 6.2.2.3.1 General + +This service operation is used by EES to update its registration information at a given ECS. + +### 6.2.2.3.2 EES updating registration information using Eecs\_EESRegistration\_Update operation + +To update the EES registration information at the ECS, the EES shall send a HTTP PUT or PATCH message to the Edge Configuration Server on resource URI identifying the individual EES registration resource representation, as specified in clause 9.1.2.3.3.2 for HTTP PUT message and in clause 9.1.2.3.3.4 for HTTP PATCH message. The HTTP PUT message shall replace all properties in the existing resource with the EES registration information in the request. The EESRegistration data type in the request body of the HTTP PUT message shall include the EES profile information, and may include proposed expiration time to update the registration. This request shall not replace the eesId property of the existing resource. + +The HTTP PATCH request message in the EESRegistrationPatch data type includes parameters (EES Profile, and/or expiry time) that need to be replaced in the existing Individual EAS registration resource. This request shall not replace the eesId property of the existing resource. + +Upon receiving the HTTP PUT or PATCH message from the EES, the ECS shall: + +1. check the registration update message from the EES to see if the EES is authorized to modify the requested registration resource; +2. if the EES is authorized to update the registration information: + - a. update the resource identified by Resource URI of the EES registration information with the updated EES registration information received in the HTTP PUT or PATCH request message; + - b. return the updated EES registration information in the "200 OK" response message or respond with the "204 No Content" message indicating to the EES that the EES registration information is updated successfully. In the response message, the ECS may provide an updated expiration time to indicate to the EES when the updated registration will automatically expire. + +On failure, the ECS shall take proper error handling actions, as specified in clause 9.1.6, and respond to the EES with an appropriate error status code. + +If the ECS determines that the received HTTP PUT or PATCH request needs to be redirected, the ECS may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative ECS where the message should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +If the expiration time is provided, then to maintain the registration, the EES shall send a registration update prior to registration expiry time. If the registration update request is not sent before the expiry time, then the ECS shall treat EES as deregistered and remove the corresponding EES registration resource. + +#### 6.2.2.4 Eecs\_EESRegistration\_Deregister + +##### 6.2.2.4.1 General + +This service operation is used by EES to deregister itself from a given ECS. + +##### 6.2.2.4.2 EES deregistering from ECS using Eecs\_EESRegistration\_Deregister operation + +To deregister itself from the ECS, the EES shall send HTTP DELETE message to the ECS, on the resource URI identifying the individual EES registration resource representation as specified in clause 9.1.2.3.3.3. Upon receiving the HTTP DELETE request, the ECS shall: + +1. verify the identity of the EES and check if the EES is authorized to deregister the EES registration information; +2. if the EES is authorized to deregister the EES registration information, then the ECS shall deregister the EES profile from the ECS and delete the resource representing EES registration information. +3. return the "204 Not Content" message to the EES, indicating the successful deregistration of the EES information. + +On failure, the ECS shall take proper error handling actions, as specified in clause 9.1.6, and respond to the EES with an appropriate error status code. + +If the ECS determines that the received HTTP DELETE request needs to be redirected, the ECS may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative ECS where the message should be redirected. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. + +### 6.3 Eecs\_TargetEESDiscovery Service + +#### 6.3.1 Service Description + +The Eecs\_TargetEESDiscovery API, as defined in 3GPP TS 23.558 [2], allows an Edge Enabler Server or a Cloud Enabler Server via Eecs interface to retrieve the target EES (T-EES) information at a given ECS. + +## 6.3.2 Service Operations + +### 6.3.2.1 Introduction + +The service operation defined for Eecs\_TargetEESDiscovery API is shown in the table 6.3.2.1-1. + +**Table 6.3.2.1-1: Operations of the Eecs\_TargetEESDiscovery API** + +| Service operation name | Description | Initiated by | +|---------------------------------|--------------------------------------------------------------------------------------------------------------|--------------| +| Eecs_TargetEESDiscovery_Request | This service operation is used by the service consumer (e.g., S-EES, CES) to retrieve the T-EES information. | EES, CES | + +### 6.3.2.2 Eecs\_TargetEESDiscovery\_Request + +#### 6.3.2.2.1 General + +This service operation is used by the service consumer (e.g., S-EES, CES) to retrieve the T-EES information from the ECS. + +#### 6.3.2.2.2 Service consumer fetching the T-EES information from the ECS using Eecs\_TargetEESDiscovery\_Request operation + +To retrieve the T-EES information from the ECS, the service consumer shall send a HTTP GET message to the Edge Configuration Server on the "EES Profiles" collection resource as specified in clause 9.2.2.2.3.1. The service consumer includes the discovery filter information in the query parameters of the GET message, as specified in clause 9.2.2.2.3.1, to assist the ECS to determine the T-EES that has the EAS available to serve the given AC in the UE. + +Upon receiving the HTTP GET message from the service consumer, the ECS shall: + +1. Process the request information; +2. verify the identity of the service consumer and check if it is authorized to retrieve the T-EES information; +3. if the service consumer is authorized to retrieve the T-EES information, then the ECS shall; + - a. determine the T-EES(s) based on the provided query parameters in the request. If UE location information is not included in the request or not known to the ECS, then the ECS may fetch the UE location information from the 3GPP core network as specified in 3GPP TS 29.522 [10]; + - b. returns the 200 OK message including the EDN configuration and the list of T-EES(s) information to the service consumer. The list of T-EES(s) includes the endpoint information to reach the T-EES(s). + +On failure, the ECS shall take proper error handling actions, as specified in clause 9.2.6, and respond to the service consumer with an appropriate error status code. + +## 6A Service offered by CAS + +### 6A.1 Introduction + +The table 6A.1-1 lists the CAS APIs below with the service name. A service description clause for each API gives a general description of the related API. + +**Table 6A.1-1: List of CAS Service APIs** + +| Service Name | Service Operations | Operation Semantics | Consumer(s) | +|------------------|--------------------|---------------------|-------------| +| Ecas_SelectedEES | Declare | Request/Response | EES | + +Table 6A.1-2 summarizes the corresponding CAS APIs defined in this specification. + +**Table 6A.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|------------------|--------|------------------------------------------------------------------------|-------------------------------|-------------------|-------| +| Ecas_SelectedEES | 8A.1 | The service consumer declares the selected EES information to the CAS. | TS29558_Ecas_SelectedEES.yaml | Ecas-selected-ees | A.14 | + +## 6A.2 Ecas\_SelectedEES Service + +### 6A.2.1 Service Description + +The Ecas\_SelectedEES API, as defined in 3GPP TS 23.558 [2], allows an service consumer to inform the CAS of the selected EES during the ACR from EAS to CAS. + +### 6A.2.2 Service Operations + +#### 6A.2.2.1 Introduction + +The service operation defined for Ecas\_SelectedEES API is shown in the table 6A.2.2.1-1. + +**Table 6A.2.2.1-1: Operations of the Ecas\_SelectedEES API** + +| Service operation name | Description | Initiated by | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Ecas_SelectedEES_Declare | This service operation is used by the service consumer (e.g., EES) to inform the CAS of the selected EES during the ACR from EAS to CAS. | EES | + +#### 6A.2.2.2 Ecas\_SelectedEES\_Request + +##### 6A.2.2.2.1 General + +This service operation is used by the service consumer (e.g., EES) to inform the CAS of the selected EES. + +##### 6A.2.2.2.2 Service consumer inform the CAS of the selected EES using Ecas\_SelectedEES\_Declare operation + +To inform the CAS of the selected EES during the ACR from EAS to CAS, the service consumer (e.g., EES) shall send a HTTP POST request (custom operation "Declare") to the CAS with the request URI set to "{apiRoot}/ecas-selected-ees//declare" and the request body shall include the SelEESDecInfo data structure defined in clause 8a.1.6.2.2. + +Upon receiving the HTTP POST request message from the service consumer, the CAS shall: + +1. process the service consumer request information; +2. check if the service consumer is authorized to declare the selected EES information; +3. if the service consumer is authorized, the CAS stores the received information and respond with the "204 No Content" status code. + +On failure, the CAS shall take proper error handling actions, as specified in clause 8A.1.7, and respond to the service consumer with an appropriate error status code. + +## 7 Information applicable to several APIs + +*This clause will provide the design aspects that are common for several APIs.* + +### 7.1 General + +The EDGEAPP APIs as specified in this document allow secure access to the capabilities provided by the functional entities, Edge Enabler Server and Edge Configuration Server. + +This document specifies the procedures triggered at different functional entities as a result of API invocation requests and event notifications. The stage-2 level requirements and signalling flows are defined in 3GPP TS 23.558 [2]. + +Several design aspects, as mentioned in the following clauses, are specified in 3GPP TS 29.122 [6] and referenced by this specification. + +### 7.2 Data Types + +#### 7.2.1 General + +This clause defines structured data types, simple data types and enumerations that are applicable to several APIs defined in the present specification and can be referenced from data structures defined in the subsequent clauses. + +In addition, data types that are defined in OpenAPI 3.0.0 Specification [3] can also be referenced from data structures defined in the subsequent clauses. + +NOTE: As a convention, data type's names in the present specification are with an upper-case letter in the beginning. Parameters are with a lower-case letter in the beginning. As an exception, data types that are also defined in OpenAPI 3.0.0 Specification [3] can use a lower-case case letter in the beginning for consistency. + +Table 7.2.1-1 specifies data types re-used by APIs in this specification from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the APIs of this specification. + +**Table 7.2.1-1: Re-used Data Types** + +| Data type | Reference | Comments | +|-----------|--------------------|----------| +| Uri | 3GPP TS 29.122 [6] | | + +#### 7.2.2 Referenced structured data types + +Table 7.2.2-1 lists structured data types defined in this specification referenced by multiple services: + +**Table 7.2.2-1: Referenced Structured Data Types** + +| Data type | Reference | Description | +|-----------|-----------|-------------| +| | | | + +#### 7.2.3 Referenced simple data types and enumerations + +Following simple data types defined in Table 7.2.3-1 are applicable to several APIs in this document: + +**Table 7.2.3-1: Simple data types applicable to several APIs** + +| Type name | Reference | Description | +|-----------|-----------|-------------| +| | | | + +## 7.3 Usage of HTTP + +For all the APIs in this document, the usage of HTTP shall be as specified in clause 5.2.2 of 3GPP TS 29.122 [6], with the clarification that SCA/AS is the functional entity invoking an EDGEAPP API. + +For all the APIs, to provide the interface protection over EDGE-3/6/9/10 interfaces, HTTP over TLS shall be used as specified in 3GPP TS 33.558 [20]. + +## 7.4 Content type + +The content type for the HTTP messages shall be as specified in clause 5.2.3 of 3GPP TS 29.122 [6]. + +## 7.5 URI structure + +### 7.5.1 Resource URI structure + +The resource URI structure of all the APIs specified in this document shall be as specified in clause 5.2.4 of 3GPP TS 29.122 [6]. + +### 7.5.2 Custom operations URI structure + +The custom operation definition is in Annex C of 3GPP TS 29.501 [5]. + +The URI of a custom operation which is associated with a resource shall have the following structure: + +**{apiRoot}
** + +Custom operations can also be associated with the service instead of a resource. The URI of a custom operation which is not associated with a resource shall have the following structure: + +**{apiRoot}
** + +In the above URI structures, "apiRoot", "apiName", "apiVersion" and "apiSpecificResourceUriPart" are as defined in clause 7.5.1 and "custOpName" represents the name of the custom operation as defined in clause 5.1.3.2 of 3GPP TS 29.501 [5]. + +## 7.6 Notifications + +The functional entities + +- shall support the delivery of notifications using a separate HTTP connection towards an address; +- may support testing delivery of notifications; and +- may support the delivery of notification using WebSocket protocol (see IETF RFC 6455 [7]), + +as described in 3GPP TS 29.122 [6], with the following clarifications: + +- the SCEF is EES for Eees APIs; and +- the SCS/AS is the Subscriber entity invoking an EDGEAPP API. + +## 7.7 Error handling + +Response bodies for error handling, as described in clause 5.2.6 of 3GPP TS 29.122 [6], are applicable to all APIs in the present specification unless specified otherwise, with the following clarifications: + +- the SCEF is EES for Eees APIs or ECS for Eecs APIs ; and +- the SCS/AS is the functional entity invoking an EDGEAPP API + +## 7.8 Feature negotiation + +The functional entity invoking an API (i.e. the EAS server) and the EDGEAPP server use feature negotiation procedures defined in clause 5.2.7 of 3GPP TS 29.122 [6] to negotiate the supported features, with the following clarifications: + +- description of the SCEF applies to the EES for Eees APIs or ECS for Eecs APIs; and +- description of the SCS/AS applies to the functional entity invoking an EDGEAPP API. + +## 7.9 HTTP headers + +The HTTP headers described in 3GPP TS 29.122 [6] are applicable to all APIs in this document. + +## 7.10 Conventions for Open API specification files + +The conventions for Open API specification files as specified in clause 5.2.9 of 3GPP TS 29.122 [6] shall be applicable for all APIs in this document. + +--- + +# 8 Edge Enabler Server API Definitions + +## 8.1 Eees\_EASRegistration API + +### 8.1.1 Introduction + +The Eees\_EASRegistration service shall use the Eees\_EASRegistration API. + +The API URI of the Eees\_EASRegistration API shall be: + +**{apiRoot}
** + +The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5, i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in clause 7.5. +- The shall be "ees-easregistration". +- The shall be "v1". +- The shall be set as described in clause 8.1.2. + +## 8.1.2 Resources + +### 8.1.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.1.2.1-1 depicts the resource URIs structure for the Eees\_EASRegistration API. + +![Figure 8.1.2.1-1: Resource URI structure of the Eees_EASRegistration API. The diagram shows a hierarchical structure of URI components in boxes connected by lines. The root is '{apiRoot}/eees-easregistration/', which branches to '/registrations', which in turn branches to '/{registrationId}'.](ad555483986d7170a46ce72d164b5bc8_img.jpg) + +``` + +graph TD + Root["{apiRoot}/eees-easregistration/"] --- Registrations["/registrations"] + Registrations --- RegistrationId["/{registrationId}"] + +``` + +Figure 8.1.2.1-1: Resource URI structure of the Eees\_EASRegistration API. The diagram shows a hierarchical structure of URI components in boxes connected by lines. The root is '{apiRoot}/eees-easregistration/', which branches to '/registrations', which in turn branches to '/{registrationId}'. + +**Figure 8.1.2.1-1: Resource URI structure of the Eees\_EASRegistration API** + +Table 8.1.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.1.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------------|---------------------------------|---------------------------------|-----------------------------------------------------------| +| EAS Registrations | /registrations | POST | Registers a new EAS at the Edge Enabler Server. | +| Individual EAS Registration | /registrations/{registrationId} | GET | Fetch an individual EAS registration resource. | +| | | PUT | Fully replace an individual EAS registration resource. | +| | | DELETE | Remove an individual EAS registration resource. | +| | | PATCH | Partially update an individual EAS registration resource. | + +### 8.1.2.2 Resource: EAS Registrations + +#### 8.1.2.2.1 Description + +This resource represents all the Edge Application Servers that are registered at a given Edge Enabler Server. + +#### 8.1.2.2.2 Resource Definition + +Resource URI: {apiRoot}/eees-easregistration//registrations + +This resource shall support the resource URI variables defined in the table 8.1.2.2.2-1. + +**Table 8.1.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 8.1.2.2.3 Resource Standard Methods + +#### 8.1.2.2.3.1 POST + +This method shall support the URI query parameters specified in table 8.1.2.2.3.1-1. + +**Table 8.1.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.1.2.2.3.1-2 and the response data structures and response codes specified in table 8.1.2.2.3.1-3. + +**Table 8.1.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|---------------------------------------| +| EASRegistration | M | 1 | EAS registration request information. | + +**Table 8.1.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EASRegistration | M | 1 | 201 Created | EAS information is registered successfully at EES. EAS information registered with EES is provided in the response body.

The URI of the created resource shall be returned in the "Location" HTTP header. | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.1.2.2.3.1-4: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/eess-easregistration//registrations/{registrationId} | + +### 8.1.2.2.4 Resource Custom Operations + +None. + +## 8.1.2.3 Resource: Individual EAS Registration + +### 8.1.2.3.1 Description + +This Individual EAS Registration resource represents an individual EAS registered at a given Edge Enabler Server. + +### 8.1.2.3.2 Resource Definition + +Resource URI: {apiRoot}/ees-easregistration//registrations/{registrationId} + +This resource shall support the resource URI variables defined in the table 8.1.2.3.2-1. + +**Table 8.1.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------------|-----------|----------------------------------| +| apiRoot | string | See clause 7.5 | +| registrationId | string | The EAS registration identifier. | + +### 8.1.2.3.3 Resource Standard Methods + +#### 8.1.2.3.3.1 GET + +This method retrieves the EAS information registered at Edge Enabler Server. This method shall support the URI query parameters specified in table 8.1.2.3.3.1-1. + +**Table 8.1.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.1.2.3.3.1-2 and the response data structures and response codes specified in table 8.1.2.3.3.1-3. + +**Table 8.1.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.1.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EASRegistration | M | 1 | 200 OK | The EAS registration information at the Edge Enabler Server. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. | | | | | + +**Table 8.1.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.1.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.1.2.3.3.2 PUT + +This method updates the EAS registration information at Edge Enabler Server by completely replacing the existing registration data (except the value of "suppFeat" attribute within the EASRegistration data type, and the value of "easId" attribute within the EASProfile data type). This method shall support the URI query parameters specified in the table 8.1.2.3.3.2-1. + +**Table 8.1.2.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.1.2.3.3.2-2 and the response data structures and response codes specified in table 8.1.2.3.3.2-3. + +**Table 8.1.2.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-----------------------------------------------------------| +| EASRegistration | M | 1 | Details of the EAS registration information to be updated | + +**Table 8.1.2.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EASRegistration | M | 1 | 200 OK | The EAS registration information updated successfully and the updated EAS registration information is returned in the response. | +| n/a | | | 204 No Content | The EAS registration information was updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.1.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.1.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.1.2.3.3.3 DELETE + +This method deregisters an EAS registration from the EES. This method shall support the URI query parameters specified in the table 8.1.2.3.3.3-1. + +**Table 8.1.2.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.1.2.3.3.3-2 and the response data structures and response codes specified in table 8.1.2.3.3.3-3. + +**Table 8.1.2.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.1.2.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The individual EAS registration information matching the registrationId is deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.1.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.1.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.1.2.3.3.4 PATCH + +This method partially updates the EAS registration information (except the easId) at Edge Enabler Server. This method shall support the URI query parameters specified in the table 8.1.2.3.3.4-1. + +**Table 8.1.2.3.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.1.2.3.3.4-2 and the response data structures and response codes specified in table 8.1.2.3.3.4-3. + +**Table 8.1.2.3.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------| +| EASRegistrationPatch | M | 1 | Details of the EAS registration information to be updated | + +**Table 8.1.2.3.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EASRegistration | M | 1 | 200 OK | The Individual EAS registration information was updated successfully and the updated EAS registration information is returned in the response. | +| n/a | | | 204 No Content | The Individual EAS registration information was updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.1.2.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.1.2.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.1.2.3.4 Resource Custom Operations + +None. + +### 8.1.3 Custom Operations without associated resources + +None. + +### 8.1.4 Notifications + +None. + +### 8.1.5 Data Model + +#### 8.1.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API + +Table 8.1.5.1-1 specifies the data types defined specifically for the Eees\_EASRegistration API service. + +**Table 8.1.5.1-1: Eees\_EASRegistration API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|----------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------|---------------| +| Affinity | 8.1.5.3.7 | Represents the affinity requirements of an EAS bundle. | EdgeApp_2 | +| BdlType | 8.1.5.3.6 | Represents the EAS bundle type. | EdgeApp_2 | +| CoordinatedAcrReq | 8.1.5.2.10 | Represents the coordinated ACR related requirements for an EAS bundle. | EdgeApp_2 | +| EASBdlReqs | 8.1.5.2.9 | Represents EAS bundle requirements. | EdgeApp_2 | +| EASBundleInfo | 8.1.5.2.8 | Represents EAS bundle information. | EdgeApp_2 | +| EASCategory | 8.1.5.3.4 | Used to indicate the category or type of the EAS. | | +| EASProfile | 8.1.5.2.3 | The profile information related to the EAS in the EASRegistration data type. | | +| EASRegistration | 8.1.5.2.2 | The EAS registration information on EES. | | +| EASRegistrationPatch | 8.1.5.2.6 | To partially update the EAS Registration information. | | +| EASServiceKPI | 8.1.5.2.4 | Service characteristics provided by EAS, captured in EAS profile information. | | +| EndPoint | 8.1.5.2.5 | The end point information of the Edge Application Server in the EAS profile. | | +| FailureAction | 8.1.5.3.8 | Represents the EAS bundle related failure action during ACR. | | +| PermissionLevel | 8.1.5.3.3 | Used to indicate the level of service permissions supported by the EAS. | | +| TransContSuppDetails | 8.1.5.2.7 | Represents the detailed information about the EAS (e.g. SEALDD Server) capability for seamless transport layer service continuity. | SEALDDSupport | +| TransportProtocol | 8.1.5.3.5 | Indicates the supported transport layer protocol for EAS context transfer. | SEALDDSupport | + +Table 8.1.5.1-2 specifies data types re-used by the Eees\_EASRegistration API service. + +**Table 8.1.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|--------------------|--------------------------------------------------------------------------------------------------------------|----------------------| +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of optional features defined in table 8.1.7-1. | | +| DateTime | 3GPP TS 29.122 [6] | Used to capture the expiration time of EAS registration. | | +| DateTimeRm | 3GPP TS 29.571 [8] | Used to capture the expiration time EAS registration patch. | | +| ScheduledCommunicationTime | 3GPP TS 29.122 [6] | Used to define the schedule of EAS availability. | | +| RouteToLocation | 3GPP TS 29.571 [8] | Used to define the DNAls associated with EAS and the corresponding N6 routing information for each EAS DNAl. | | +| DurationSec | 3GPP TS 29.122 [6] | Duration in seconds, used to define the availability reporting period for EES to check EAS availability. | | +| BitRate | 3GPP TS 29.571 [8] | Used to express the connection bandwidth of EAS service KPI. | | +| Ipv4Addr | 3GPP TS 29.122 [6] | Identifying the IPv4 address of the Edge Application Server. | | +| Ipv6Addr | 3GPP TS 29.122 [6] | Identifying the IPv6 address of the Edge Application Server. | | +| ServiceArea | Clause 9.1.5.2.5 | Represents the topological and geographical service area information of the EAS. | | +| UInteger | 3GPP TS 29.571 [8] | Used to express the maximum response time of EAS service KPI. | | +| Fqdn | 3GPP TS 29.571 [8] | Used to express the Fully Qualified Domain Name of EAS end point. | | + +## 8.1.5.2 Structured data types + +### 8.1.5.2.1 Introduction + +### 8.1.5.2.2 Type: EASRegistration + +**Table 8.1.5.2.2-1: Definition of type EASRegistration** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|--------------------|----------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| easProf | EASProfile | M | 1 | The profile information of the EAS. | | +| expTime | DateTime | O | 0..1 | Identifies the expiration time for the EAS registration. If the expiration time is not present, then it indicates that the registration of EAS never expires. | | +| suppFeat | Supported Features | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.
This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | + +8.1.5.2.3 Type: EASProfile + +**Table 8.1.5.2.3-1: Definition of type EASProfile** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| easId | string | M | 1 | The application identifier of the EAS (e.g. URI, FQDN). | | +| endPt | EndPoint | M | 1 | Endpoint information (URI, FQDN, IP address) used to communicate with the EAS. This information maybe discovered by EEC and exposed to ACs so that ACs can establish contact with the EAS. | | +| easBdlInfos | array(EASBundleInfo) | O | 1..N | Represents the list of EAS bundle(s) to which the EAS (identified by the "easId" attribute) belongs, and for each one of them, the corresponding EAS bundle information. | EdgeApp_2 | +| acIds | array(string) | O | 1..N | Identities of the Application Clients that can be served by the EAS | | +| provId | string | O | 0..1 | Identifier of the ASP that provides the EAS. | | +| type | EASCategory | O | 0..1 | The EAS type with the 3GPP standardized value set.

(NOTE). | | +| flexEasType | string | O | 0..1 | The EAS type with the flexible value set.

(NOTE) | | +| scheds | array(ScheduledCommunicationTime) | O | 1..N | The availability schedule of the EAS. | | +| svcArea | ServiceArea | O | 0..1 | The list of geographical and topological areas that the EAS serves. ACs in the UE that are outside the area shall not be served. | | +| svcKpi | EASServiceKPI | O | 0..1 | Service characteristics provided by the EAS. | | +| permLvl | array(PermissionLevel) | O | 1..N | Level of service permissions supported by the EAS. | | +| easFeats | array(string) | O | 1..N | Service specific features supported by the EAS (e.g. single vs multi-player gaming service). | | +| svcContSupp | array(ACRScenario) | O | 1..N | The ACR scenarios supported by the EAS for service continuity. If this attribute is not present, then the EAS does not support service continuity. | | +| svcContSuppExt1 | array(EASBundleInfo) | O | 1..N | Represents the information related to the EAS ability to handle bundled EAS ACRs.

This attribute may be present only when the "svcContSupp" attribute is also present.

When this attribute is present, it indicates that the EAS (identified by the "easId" attribute) is able to handle bundled EAS ACRs and contains the information of the EAS bundle(s) for which the EAS is able to handle bundled EAS ACRs. | EdgeApp_2 | +| transContSupp | TransContSuppDetails | O | 0..1 | Represents the detailed information about the EAS (e.g. SEALDD Server) capability for seamless transport layer service continuity.

If this attribute is not present, then the EAS does not support the seamless transport layer service continuity capability. | SEALDDSupport | +| appLocs | array(Route) | O | 1..N | List of DNAI(s) and the corresponding N6 | | + +| | | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| | ToLocation) | | | traffic routing information/routing profile ID, associated with the EAS.

It is a subset of the DNAI(s) associated with the EDN where the EAS resides. | | +| avlRep | DurationSec | O | 0..1 | The period indicating to the EES, how often the EES needs to check the EAS's availability after a successful registration. | | +| status | string | O | 0..1 | EAS status (e.g. Enabled, Disabled etc.) | | +| genCtxDur | DurationSec | O | 0..1 | Contains the general context holding time duration, which indicates the time duration during which the EAS holds the application context in case of an ACR for service continuity planning. | EdgeApp_2 | +| easSyncSupp | boolean | O | 0..1 | Indicates whether the EAS supports content synchronization between EASs.

  • - When set to "true", it indicates that content synchronization between EASs is supported by the EAS.
  • - When set to "false", it indicates that content synchronization between EASs is not supported by the EAS.
  • - The default value when this attribute is omitted is "false".
| EdgeApp_2 | +| NOTE: The "flexEasType" attribute and the "type" attribute are mutually exclusive. Either one of them may be provided. The same attribute should be used when this data type is conveyed over the EDGE-1 and EDGE-3 interfaces (i.e. for the Eees_EASRegistration and the Eees_EASDiscovery APIs).NOTE 2: Void. | | | | | | + +#### 8.1.5.2.4 Type: EASServiceKPI + +**Table 8.1.5.2.4-1: Definition of type EASServiceKPI** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| maxReqRate | UInteger | O | 0..1 | Maximum request rate from the Application Client supported by the EAS. The minimum and maximum value shall be 0 and 100 respectively. | | +| maxRespTime | UInteger | O | 0..1 | The maximum response time, in the units of milliseconds, advertised for the AC's service requests. This includes the round trip time of the request and response packet, the processing time at the EAS and time required by EAS to consume any 3GPP core network capabilities. | | +| avail | UInteger | O | 0..1 | Advertised percentage of time the server is available for the AC's use. The minimum and maximum value shall be 0 and 100 respectively. | | +| avlComp | UInteger | O | 0..1 | The maximum compute resource available for the AC. | | +| avlGraComp | UInteger | O | 0..1 | The maximum graphical compute resource available for the AC. | | +| avlMem | UInteger | O | 0..1 | The maximum memory resource available for the AC. | | +| avlStrg | UInteger | O | 0..1 | The maximum storage resource available for the AC. | | +| connBand | BitRate | O | 0..1 | The connection bandwidth in Kbit/s advertised for the AC's use. | | + +## 8.1.5.2.5 Type: EndPoint + +Table 8.1.5.2.5-1: Definition of type EndPoint + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|--------------------------------------------------------|---------------| +| fqdn | Fqdn | C | 0..1 | Fully Qualified Domain Name of the Edge server. (NOTE) | | +| ipv4Addrs | array(Ipv4Addr) | C | 1..N | IPv4 addresses of the Edge server. (NOTE) | | +| ipv6Addrs | array(Ipv6Addr) | C | 1..N | IPv6 addresses of the Edge server. (NOTE) | | +| uri | Uri | C | 0..1 | URI information of the Edge server (NOTE) | | + +NOTE: One of the addressing parameters (fqdn, ipv4Addrs, ipv6Addrs, uri attributes) shall be included. + +## 8.1.5.2.6 Type: EASRegistrationPatch + +Table 8.1.5.2.6-1: Definition of type EASRegistrationPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| easProf | EASProfile | O | 0..1 | The profile information of the EAS. | | +| expTime | DateTimeRm | O | 0..1 | Identifies the expiration time for the EAS registration. If the expiration time is not present, then it indicates that the registration of EAS never expires. | | + +## 8.1.5.2.7 Type: TransContSuppDetails + +Table 8.1.5.2.7-1: Definition of type TransContSuppDetails + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| transProtocs | array(TransportProtocol) | M | 1..N | Indicates the transport layer protocols supported for EAS (e.g. SEALDD Server) context transfer using the seamless transport layer service continuity capability. | | + +## 8.1.5.2.8 Type: EASBundleInfo + +Table 8.1.5.2.8-1: Definition of type EASBundleInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| bdType | BdType | M | 1 | Represents the EAS bundle type. | | +| bdId | string | C | 0..1 | Contains the identifier of the EAS bundle.
(NOTE) | | +| easIdsList | array(string) | C | 1..N | Contains the list of the identifier(s) of the EAS(s) constituting the EAS bundle.
(NOTE) | | +| easBdlReqs | EASBdlReqs | O | 0..1 | Contains the EAS Bundle Requirements. | | +| mainEasId | string | O | 0..1 | Represents the identifier of the EAS that plays the role of the main EAS within the EAS bundle. | | + +NOTE: At least one of these attributes shall be present. + +## 8.1.5.2.9 Type: EASBdlReqs + +**Table 8.1.5.2.9-1: Definition of type EASBdlReqs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| coordinatedEasDisc | boolean | O | 0..1 | Indicates whether or not coordinated EAS discovery is required (i.e., when the EAS discovery request for one of the EAS(s) of the bundle is processed, then the corresponding EAS discovery response should include information of all the EAS(s) of the bundle).
  • - When set to "true", it indicates that coordinated EAS discovery is required.
  • - When set to "false", it indicates that coordinated EAS discovery is not required.
  • - The default value when this attribute is omitted is "false".
| | +| coordinatedAcr | CoordinatedAcrReqs | O | 0..1 | Represents the coordinated ACR requirements for the EAS bundle. | | +| affinity | Affinity | O | 0..1 | Represents the affinity requirements of the EAS bundle. | | + +## 8.1.5.2.10 Type: CoordinatedAcrReqs + +**Table 8.1.5.2.10-1: Definition of type CoordinatedAcrReqs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| coordinatedAcrInd | boolean | M | 1 | Indicates whether or not coordinated ACR is required (i.e., when ACR is initiated for one of the EAS(s) of the bundle, then ACR should be initiated for all the other EAS(s) of the bundle).
  • - When set to "true", it indicates that coordinated ACR is required.
  • - When set to "false", it indicates that coordinated ACR is not required.
  • - The default value when this attribute is omitted is "false".
| | +| failureAction | FailureAction | O | 0..1 | Indicates the action to be taken when ACR for one or more EAS(s) of the EAS bundle fails, i.e., whether the ACR for all the other EAS(s) of the bundle shall proceed or be cancelled. | | + +## 8.1.5.3 Simple data types and enumerations + +## 8.1.5.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 8.1.5.3.2 Simple data types + +The simple data types defined in table 8.1.5.3.2-1 shall be supported. + +**Table 8.1.5.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 8.1.5.3.3 Enumeration: PermissionLevel + +**Table 8.1.5.3.3-1: Enumeration PermissionLevel** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------|---------------| +| TRIAL | Level of service permission supported is TRIAL. | | +| GOLD | Level of service permission supported is GOLD. | | +| SILVER | Level of service permission supported is SILVER. | | +| OTHER | Any other level of service permissions supported. | | + +## 8.1.5.3.4 Enumeration: EASCategory + +**Table 8.1.5.3.3-1: Enumeration EASCategory** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------|---------------| +| UAS | Indicates that the EAS category is for UAS services. | | +| V2X | Category of EAS is for V2X Services. | | +| OTHER | Any other type of EAS category | | + +## 8.1.5.3.5 Enumeration: TransportProtocol + +**Table 8.1.5.3.5-1: Enumeration TransportProtocol** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------------------------------|---------------| +| QUIC | Indicates the QUIC protocol. | | +| TCP | Indicate the Transmission Control Protocol.(TCP) protocol | | +| TCP_TLS | Indicates the Transmission Control Protocol (TCP) with Transport Layer Security (TLS) protocol. | | + +## 8.1.5.3.6 Enumeration: BdType + +**Table 8.1.5.3.6-1: Enumeration BdType** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| DIRECT | Indicates that the EAS Bundle type is direct bundle.

The AC interacts with multiple EASs of the EAS bundle directly (i.e., with no coordination between the EAS(s)). | | +| PROXY | Indicates that the EAS Bundle type is proxy bundle.

The AC interacts with only one EAS of the EAS bundle, which in turn coordinates with the other EAS(s) of the EAS bundle to provide the services required by the AC. | | + +#### 8.1.5.3.7 Enumeration: Affinity + +**Table 8.1.5.3.7-1: Enumeration Affinity** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| STRONG | Indicates that the affinity is strong, i.e., all the EASs of the bundle shall be in the same EDN. | | +| PREFERRED | Indicates that the affinity is preferred, i.e., it is nice to have all the EASs of the bundle in the same EDN, but it is not essential. | | +| WEAK | Indicates that the affinity is weak, i.e., it is not essential to have all the EASs of the bundle in the same EDN. | | + +#### 8.1.5.3.8 Enumeration: FailureAction + +**Table 8.1.5.3.8-1: Enumeration FailureAction** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------------------------------------|---------------| +| CANCEL | Indicates that ACR shall be cancelled for the other EAS(s) of the bundle for which ACR is not failed. | | +| PROCEED | Indicates that ACR shall proceed for the other EAS(s) of the bundle for which ACR is not failed. | | + +### 8.1.6 Error Handling + +General error responses are defined in clause 7.7. + +### 8.1.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.1.7-1 lists the supported features for Eees\_EASRegistration API. + +**Table 8.1.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | SEALDDSupport |

This feature indicates the support of the SEALDD functionality related enhancements.

The following functionalities are supported:

  • - Support the EAS capability for seamless transport layer service continuity within the EAS profile.
| +| 2 | EdgeApp_2 |

This feature indicates the support of the enhancements to the Edge Applications.

The following functionalities are supported:

  • - Support of the indication of the general context holding time.
  • - Support of the EAS bundle functionality.
  • - Support of the indication of the EAS ability to handle bundled EAS ACRs within the EAS profile.
| + +## 8.2 Eees\_UELocation API + +### 8.2.1 Introduction + +The Eees\_UELocation service shall use the Eees\_UELocation API. + +The API URI of the Eees\_UELocation API shall be: + +{apiRoot}// + +The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5, i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in clause 7.5. +- The shall be "ees-uelocation". +- The shall be "v1". +- The shall be set as described in clause 8.2.2. + +## 8.2.2 Resources + +### 8.2.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.2.2.1-1 depicts the resource URIs structure for the Eees\_UELocation API. + +![Diagram showing the hierarchical structure of Resource URIs for the Eees_UELocation API. The root URI is {apiRoot}/ees-uelocation/. It branches into /subscriptions, which further branches into /{subscriptionId}.](b882c54d92390b4ca523f230e3e07617_img.jpg) + +``` +graph TD; A["{apiRoot}/ees-uelocation/"] --- B["/subscriptions"]; B --- C["/{subscriptionId}"]; +``` + +Diagram showing the hierarchical structure of Resource URIs for the Eees\_UELocation API. The root URI is {apiRoot}/ees-uelocation/. It branches into /subscriptions, which further branches into /{subscriptionId}. + +**Figure 8.2.2.1-1: Resource URI structure of the Eees\_UELocation API** + +Table 8.2.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.2.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------------------|---------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------| +| Location Information Subscriptions | /subscriptions | POST | Creates a subscription for continuous reporting of UE(s) location information to the EAS. | +| Individual Location Information Subscription | /subscriptions/{subscriptionId} | GET | Retrieves the Individual location information subscription identified by subscriptionId. | +| | | PATCH | Partially updates the Individual location information subscription identified by subscriptionId. | +| | | PUT | Fully replace the Individual location information subscription identified by subscriptionId. | +| | | DELETE | Removes the Individual location information subscription identified by subscriptionId. | + +## 8.2.2.2 Resource: Location Information Subscriptions + +### 8.2.2.2.1 Description + +This resource represents all location information subscriptions at a given EES. + +### 8.2.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ees-uolocation//subscriptions + +This resource shall support the resource URI variables defined in the table 8.2.2.2.2-1. + +**Table 8.2.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 8.2.2.2.3 Resource Standard Methods + +#### 8.2.2.2.3.1 POST + +This method creates the location information subscription at the EES for continuous reporting of UE(s) location information. This method shall support the URI query parameters specified in the table 8.2.2.2.3.1-1. + +**Table 8.2.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.2.2.2.3.1-2 and the response data structures and response codes specified in table 8.2.2.2.3.1-3. + +**Table 8.2.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-------------------------------------------------| +| LocationSubscription | M | 1 | Create a new location information subscription. | + +**Table 8.2.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocationSubscription | M | 1 | 201 Created | The individual location information subscription resource created successfully. The information about the confirmed subscription at the EES is provided in the response body.

The URI of the created resource shall be returned in the "Location" HTTP header. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +NOTE 2: Failure cases are described in clause 8.2.6.3. + +**Table 8.2.2.2.3.1-4: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/eees-uelocation//subscriptions/{subscriptionId} | + +## 8.2.2.2.4 Resource Custom Operations + +None. + +## 8.2.2.3 Resource: Individual Location Information Subscription + +### 8.2.2.3.1 Description + +This resource represents the individual location information subscription of an EAS at a given EES. + +### 8.2.2.3.2 Resource Definition + +Resource URI: {apiRoot}/eees-uelocation//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in the table 8.2.2.3.2-1. + +**Table 8.2.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------------|-----------|-------------------------------------------------------------| +| apiRoot | string | See clause 7.5 | +| subscriptionId | string | Identifies an individual location information subscription. | + +## 8.2.2.3.3 Resource Standard Methods + +### 8.2.2.3.3.1 GET + +This method retrieves the location information subscription information at EES. This method shall support the URI query parameters specified in the table 8.2.2.3.3.1-1. + +**Table 8.2.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.2.2.3.3.1-2 and the response data structures and response codes specified in table 8.2.2.3.3.1-3. + +**Table 8.2.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.2.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocationSubscription | M | 1 | 200 OK | The location information subscription information is returned by the EES. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.2.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.2.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.2.2.3.3.2 PATCH + +This method partially updates the location information subscription information at the EES. This method shall support the URI query parameters specified in the table 8.2.2.3.3.2-1. + +**Table 8.2.2.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.2.2.3.3.2-2 and the response data structures and response codes specified in table 8.2.2.3.3.2-3. + +**Table 8.2.2.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------| +| LocationSubscriptionPatch | M | 1 | Request to partially update the individual location information subscription matching the subscriptionId at the EES. | + +**Table 8.2.2.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocationSubscription | M | 1 | 200 OK | The individual Location information subscription matching the subscriptionId was modified successfully and the updated Location subscription information is returned in the response. | +| n/a | | | 204 No Content | The individual Location information subscription matching the subscriptionId was modified successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +NOTE 2: Failure cases are described in clause 8.2.6.3. + +**Table 8.2.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.2.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +### 8.2.2.3.3.3 PUT + +This method updates the location information subscription information at the EES by completely replacing the existing subscription data (except easId, ueId, groupId). This method shall support the URI query parameters specified in the table 8.2.2.3.3.3-1. + +**Table 8.2.2.3.3.3-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.2.2.3.3.3-2 and the response data structures and response codes specified in table 8.2.2.3.3.3-3. + +**Table 8.2.2.3.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------| +| LocationSubscription | M | 1 | Details of individual location information subscription matching the subscriptionId to be updated at the EES. | + +**Table 8.2.2.3.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocationSubscription | M | 1 | 200 OK | The individual Location information subscription matching the subscriptionId was modified successfully and the updated Location subscription information is returned in the response. | +| n/a | | | 204 No Content | The individual Location information subscription matching the subscriptionId was modified successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +NOTE 2: Failure cases are described in clause 8.2.6.3. + +**Table 8.2.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.2.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.2.2.3.3.4 DELETE + +This method removes the location information subscription information from the EES. This method shall support the URI query parameters specified in the table 8.2.2.3.3.4-1. + +**Table 8.2.2.3.3.4-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.2.2.3.3.4-2 and the response data structures and response codes specified in table 8.2.2.3.3.4-3. + +**Table 8.2.2.3.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.2.2.3.3.4-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | M | 1 | 204 No Content | The individual Location information subscription matching the subscriptionId is deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.2.2.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.2.2.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.2.2.3.4 Resource Custom Operations + +None. + +### 8.2.3 Custom Operations without associated resources + +#### 8.2.3.1 Overview + +The structure of the custom operation URIs of the Eees\_UELocation API is shown in Figure 8.2.3.1-1. + +![Diagram showing the custom operation URI structure for the Eees_UELocation API. A rounded rectangle contains the text '{apiRoot}/ees-uelocation/'. A line extends from the bottom of this rectangle to a second, dashed rounded rectangle containing the text '/fetch'.](dbd4bab54b57e8d1abf80e3de6471130_img.jpg) + +Diagram showing the custom operation URI structure for the Eees\_UELocation API. A rounded rectangle contains the text '{apiRoot}/ees-uelocation/'. A line extends from the bottom of this rectangle to a second, dashed rounded rectangle containing the text '/fetch'. + +**Figure 8.2.3.1-1: Custom operation URI structure of the Eees\_UELocation API** + +Custom operations used for this API are summarized in table 8.2.3.1-1. + +**Table 8.2.3.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|-----------------------------------| +| Fetch | /fetch | POST | Fetch an UE location information. | + +## 8.2.3.2 Operation: Fetch + +### 8.2.3.2.1 Description + +This custom operation allows the EAS to fetch an UE's location information from the EES. + +### 8.2.3.2.2 Operation Definition + +This operation shall support the request data structures and response codes and data structures specified in tables 8.2.3.2.2-1 and 8.2.3.2.2-2. + +**Table 8.2.3.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-------------------------------------------------------------| +| LocationRequest | M | 1 | Parameters to request to fetch the UE location information. | + +**Table 8.2.3.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocationResponse | M | 1 | 200 OK | Upon success, the UE location information returned by the EES. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in the Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. +NOTE 2: Failure cases are described in clause 8.2.6.3. + +**Table 8.2.3.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.2.3.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +## 8.2.4 Notifications + +### 8.2.4.1 General + +**Table 8.2.4.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------------|---------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| Location Information Notification | {notificationDestination} | POST | Notifies the subscriber EAS the UE(s) location information. | +| User Consent Revocation Notification | {revocationNotifUri} | POST | The user consent revocation notification from the EES to the EAS to inform about the revocation of user consent for one or several UE(s). | + +## 8.2.4.2 Location Information Notification + +### 8.2.4.2.1 Description + +Location Information Notification is used by the EES to notify an EAS with location information of UE(s). The EES shall subscribe to the location information for UE(s) via the Individual Location Information Subscription resource. + +### 8.2.4.2.2 Target URI + +The callback URI {**notificationDestination**} shall be used with the callback URI variables defined in table 8.2.4.2.2-1. + +**Table 8.2.4.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------| +| notificationDestination | Uri | Callback reference provided by the EAS during the UE location information subscription creation/update/modification procedure. | + +### 8.2.4.2.3 Standard Methods + +#### 8.2.4.2.3.1 POST + +This method shall support the request data structures specified in table 8.2.4.2.3.1-1 and the response data structures and response codes specified in table 8.2.4.2.3.1-2. + +**Table 8.2.4.2.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|---------------------------------------------| +| LocationNotification | M | 1 | Notification of UE(s) location information. | + +**Table 8.2.4.2.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.2.4.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +**Table 8.2.4.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +## 8.2.4.3 User Consent Revocation Notification + +### 8.2.4.3.1 Description + +The User Consent Revocation Notification is used by the EES to report the revocation of user consent for one or several UE(s) to the EAS. + +### 8.2.4.3.2 Target URI + +The Callback URI "{revocationNotifUri}" shall be used with the callback URI variables defined in table 8.2.4.3.2-1. + +**Table 8.2.4.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|--------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| revocationNotifUri | Uri | Callback reference provided by the EAS during the UE location information subscription creation or modification procedure if the UserConsentRevocation feature is supported, within the LocationSubscription data structure as specified in clauses 8.2.2.2.3.1, 8.2.2.3.3.3 and 8.2.5.2.2, or the LocationSubscriptionPatch data structure as specified in clauses 8.2.2.3.3.2, and 8.2.5.2.3. | + +### 8.2.4.3.3 Standard Methods + +#### 8.2.4.3.3.1 POST + +This method shall support the request data structures specified in table 8.2.4.3.3.1-1 and the response data structures and response codes specified in table 8.2.4.3.3.1-2. + +**Table 8.2.4.3.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|---------------------------------------------------| +| ConsentRevocNotif | M | 1 | Contains the user consent revocation information. | + +**8.2.4.3.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The user consent revocation notification is successfully received. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the HTTP POST method listed in Table 5.2.6-1 of TS 29.122 [6] also apply. + +**Table 8.2.4.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | Cardinality | Description | +|----------|-----------|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +**Table 8.2.4.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | Cardinality | Description | +|----------|-----------|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +## 8.2.5 Data Model + +### 8.2.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API + +Table 8.2.5.1-1 specifies the data types defined specifically for the Eees\_UELocation API service. + +**Table 8.2.5.1-1: Eees\_UELocation API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|---------------------------|-----------------|--------------------------------------------------------------------------------------------------------|-----------------------| +| ConsentRevoked | 8.2.5.2.9 | Represents the information related to revoked user consent(s). | UserConsentRevocation | +| ConsentRevocNotif | 8.2.5.2.8 | Represents the user consent revocation information conveyed in a user consent revocation notification. | UserConsentRevocation | +| LocationSubscription | 8.2.5.2.2 | Represents the location information subscription. | | +| LocationSubscriptionPatch | 8.2.5.2.3 | Used to request the partial update of location information subscription. | | +| LocationNotification | 8.2.5.2.4 | UE location information notification from EES to EAS. | | +| LocationEvent | 8.2.5.2.5 | Location information related an Individual UE. | | +| LocationRequest | 8.2.5.2.6 | UE location information request | | +| LocationResponse | 8.2.5.2.7 | Contains the response to a UE location information retrieval request. | | + +Table 8.2.5.1-2 specifies data types re-used by the Eees\_UELocation API service. + +**Table 8.2.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| Gpsi | 3GPP TS 29.571 [8] | Used to identify the UE in the query parameter, for which location information is queried. | | +| LocationQoS | 3GPP TS 29.572 [11] | Used to indicate the location quality of service, of the location information queried. | | +| LocationInfo | 3GPP TS 29.122 [6] | The location information related to the UE . | | +| DateTime | 3GPP TS 29.122 [6] | Used to capture the expiration time of EAS subscription for location information reporting. | | +| ReportingInformation | 3GPP TS 29.523 [13] | Used to indicate the reporting requirement, only the following information are applicable:
- immRep
- notifMethod
- maxReportNbr
- monDur
- repPeriod | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of optional features. | | +| TestNotification | 3GPP TS 29.122 [6] | Following differences apply:
- The SCEF is the EES; and
- The SCS/AS is the subscribing EAS. | | +| UcPurpose | 3GPP TS 29.503 [22] | Represents the purpose of a user consent. | UserConsentRevocation | +| Uri | 3GPP TS 29.122 [6] | | | +| WebsockNotifConfig | 3GPP TS 29.122 [6] | Following differences apply:
- The SCEF is the EES; and
- The SCS/AS is the subscribing EAS. | | +| UeMobilityExposure | 3GPP TS 29.522 [10] | The predictive location information related to the UE, | | +| GroupId | 3GPP TS 29.571 [8] | Used to present the internal group identifier in location subscription. | | +| ExternalId | TS 29.122 [6] | Represents an external identifier. | | +| ExternalGroupId | 3GPP TS 29.571 [8] | Used to present the external group identifier in location subscription. | | +| Accuracy | 3GPP TS 29.122 [6] | Used by EAS to indicate the desired granularity of the requested location information. | | + +## 8.2.5.2 Structured data types + +### 8.2.5.2.1 Introduction + +### 8.2.5.2.2 Type: LocationSubscription + +**Table 8.2.5.2.2-1: Definition of type LocationSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| easId | string | M | 1 | The application identifier of the EAS (e.g. URI, FQDN) subscribing for location information report. | | +| ueId | Gpsi | O | 0..1 | Identifier of the UE for which the location information reporting is subscribed for.
(NOTE) | | +| intGrpId | GroupId | O | 0..1 | The internal group identifier, identifying the group of UEs for which the location information reporting is subscribed for.
(NOTE) | | +| extGrpId | ExternalGroupId | O | 0..1 | The external group identifier, identifying the group of UEs for which the location information reporting is subscribed for.
(NOTE) | | +| expTime | DateTime | O | 0..1 | Indicates the expiration time of the subscription. If the expiration time is not present, then it indicates that the EAS subscription never expires. | | +| locGran | Accuracy | O | 0..1 | Indicates the format of the location information that the EAS supports. EAS wishes to receive the location information report from the EES in the indicated format. | | +| locQoS | LocationQoS | O | 0..1 | Indicates the location QoS as specified in 3GPP TS 29.572 [11]. | | +| eventReq | ReportingInformation | O | 0..1 | Represents the reporting requirements of the location information event subscription. | | +| notificationDestination | Uri | C | 0..1 | URI where the location information notification should be delivered to. This attribute shall be present in HTTP POST message to EES and shall be present in HTTP PUT request. | | +| revocationNotifUri | Uri | C | 0..1 | Contains the URI via which the EAS desires to receive user consent revocation notifications.

If the "UserConsentRevocation" feature is supported by the EAS, this attribute shall be present in an HTTP POST request/response, and HTTP PUT request/response, and HTTP PATCH responses, and may be present in an HTTP PATCH request, if the revocation notification needs to be updated. | UserConsentRevocation | +| requestTestNotification | boolean | O | 0..1 | Set to true by Subscriber to request the EES to send a test notification as defined in clause 7.6. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | O | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 7.6. | Notification_websocket | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.
This attribute shall be provided in the HTTP POST request to create a new subscription resource, if at least one feature is supported, and in the HTTP POST response of successful resource creation, if it was present in the associated HTTP POST request. | | + +NOTE: Only one of UE Identifier (ueId), Internal group identifier (intGrpId), and External group identifier (extGrpId) shall be included. + +NOTE: To protect the privacy of the user, the MSISDN can be used as GPSI only after obtaining user's consent. + +#### 8.2.5.2.3 Type: LocationSubscriptionPatch + +**Table 8.2.5.2.3-1: Definition of type LocationSubscriptionPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| eventReq | ReportingInformation | O | 0..1 | The reporting requirements of the location information event subscription to be updated. | | +| expTime | DateTime | O | 0..1 | Indicates the proposed expiration time of the subscription. | | +| notificationDestination | Uri | O | 0..1 | Updated URI where the location information notification should be delivered to. | | +| revocationNotifUri | Uri | O | 0..1 | Contains the updated URI via which the EAS desires to receive user consent revocation notifications.

This attribute may be present if the "UserConsentRevocation" feature is supported by the EAS. | UserConsentRevocation | +| locGran | Accuracy | O | 0..1 | Updated format of the location information that the EAS supports. | | +| locQoS | LocationQoS | O | 0..1 | Updated location QoS, as specified in 3GPP TS 29.572 [11]. | | + +#### 8.2.5.2.4 Type: LocationNotification + +**Table 8.2.5.2.4-1: Definition of type LocationNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------|---------------| +| subId | string | M | 1 | String identifying the individual Location information subscription for which the location notification is delivered. | | +| locEvs | array(LocationEvent) | M | 1..N | List of notifications that include the location information of the UE(s). | | + +#### 8.2.5.2.5 Type: LocationEvent + +**Table 8.2.5.2.5-1: Definition of type LocationEvent** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------------|--------------------|---|-------------|----------------------------------------------------------------------|---------------| +| ueId | Gpsi | M | 1 | Identifier of the UE for which the location information is reported. | | +| locInf | LocationInfo | C | 0..1 | Actual Location information of the UE.
(NOTE) | | +| locInfPred | UeMobilityExposure | C | 0..1 | Predictive location information of the UE.
(NOTE) | | +| NOTE: Only one of "locInf" or "locInfPred" shall be included. | | | | | | + +## 8.2.5.2.6 Type: LocationRequest + +Table 8.2.5.2.6-1: Definition of type LocationRequest + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueId | Gpsi | M | 1 | Identifier of the UE for which the location information is requested. | | +| gran | Accuracy | O | 0..1 | Format in which the location information is requested by the EAS. | | +| locQoS | LocationQoS | O | 0..1 | Indicates the location quality of service of the requested location information. | | +| suppFeat | Supported Features | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.

This attribute shall be provided in the HTTP POST request to retrieve UE location information, if at least one feature is supported. | | + +## 8.2.5.2.7 Type: LocationResponse + +Table 8.2.5.2.7-1: Definition of type LocationResponse + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueLocation | LocationInfo | M | 1 | Contains the requested UE location information. | | +| suppFeat | Supported Features | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.

This attribute shall be provided in the HTTP POST response for UE location information retrieval, if it was present in the associated HTTP POST request. | | + +## 8.2.5.2.8 Type: ConsentRevocNotif + +Table 8.2.5.2.8-1: Definition of type ConsentRevocNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| subscriptionId | string | M | 1 | Contains the identifier of the subscription to which the notification is related. | | +| consentsRevoked | array(ConsentRevoked) | M | 1..N | Indicates the revoked user consents. | | + +### 8.2.5.2.9 Type: ConsentRevoked + +**Table 8.2.5.2.9-1: Definition of type ConsentRevoked** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|---------------------------------------------------------------------------------------|---------------| +| ucPurpose | UcPurpose | M | 1 | Identifies the purpose of the revoked user consent. | | +| ueld | Gpsi | C | 0..1 | Contains the identifier(s) of the UE(s) for which user consent was revoked.
(NOTE) | | +| externalId | ExternalId | C | 0..1 | Indicates the user(s) for which user consent was revoked.
(NOTE) | | + +NOTE: One of the "ueld" or "externalId" attributes shall be present. + +### 8.2.5.3 Simple data types and enumerations + +None. + +## 8.2.6 Error Handling + +### 8.2.6.1 General + +For the Eees\_UELocation API, HTTP error handling shall be supported as specified in clause 7.7. In addition, the requirements in the following clauses are applicable for the Eees\_UELocation API. + +### 8.2.6.2 Protocol Errors + +No specific protocol errors for the Eees\_UELocation API are specified. + +### 8.2.6.3 Application Errors + +The application errors defined for the Eees\_UELocation API are listed in Table 8.2.6.3-1. + +**Table 8.2.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------| +| CONSENT_REVOCATION_NOT_SUPPORTED | 403 Forbidden | Indicates that the request is rejected because user consent management and enforcement is not supported by the client. | +| USER_CONSENT_NOT_GRANTED | 403 Forbidden | Indicates that the request is rejected because user consent is not granted. | + +## 8.2.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.2.7-1 lists the supported features for Eees\_UELocation API. + +**Table 8.2.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_test_event | Testing of notification connection is supported according to clause 7.6. | +| 2 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 7.6. This feature requires that the Notification_test_event feature is also supported. | +| 3 | UserConsentRevocation | This feature indicates the support of user consent revocation management and enforcement (e.g. stop data processing). | +| 4 | enNB1 | This feature indicates the support of enhancements to this application layer API in Rel-18. | + +## 8.3 Eees\_UEIdentifier API + +### 8.3.1 Introduction + +The Eees\_UEIdentifier service shall use the Eees\_UEIdentifier API. + +The API URI of the Eees\_UEIdentifier API shall be: + +**{apiRoot}
** + +The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5, i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in clause 7.5. +- The shall be "ees-ueidentifier". +- The shall be "v1". +- The shall be set as described in clause 8.3.2. + +### 8.3.2 Resources + +There are no resources defined for this API in this release of the specification. + +### 8.3.3 Custom Operations without associated resources + +#### 8.3.3.1 Overview + +The structure of the custom operation URIs of the Eees\_UEIdentifier API is shown in Figure 8.3.3.1-1. + +![Diagram showing the custom operation URI structure of the Eees_UEIdentifier API. The root URI is {apiRoot}/eees-ueidentifier/. It branches into two operations: /fetch (deprecated) and /get.](d2417b04116c354deccb25d98a84a0fb_img.jpg) + +``` + +graph TD + Root["{apiRoot}/eees-ueidentifier/"] --> Fetch["/fetch (deprecated)"] + Root --> Get["/get"] + +``` + +Diagram showing the custom operation URI structure of the Eees\_UEIdentifier API. The root URI is {apiRoot}/eees-ueidentifier/. It branches into two operations: /fetch (deprecated) and /get. + +**Figure 8.3.3.1-1: Custom operation URI structure of the Eees\_UEIdentifier API** + +Table 8.3.3.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the Eees\_UEIdentifier API. + +**Table 8.3.3.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|-------------------------------------------------------------------------------------------------------------------| +| Fetch | /fetch | POST | Fetch the identifier of a UE.
This custom operation is deprecated. The "Get" operation should be used instead. | +| Get | /get | POST | EAS fetch the UE Identifier information. | + +NOTE 1: Based on SA3 specified security mechanisms for EDGE-1 and EDGE-3 interfaces, the EES can identify the initiator of the API (EEC or EAS) and apply the appropriate security procedures as specified in 3GPP TS 33.558 [20]. + +NOTE 2: The same service API can be implemented on two different interfaces, i.e. EDGE-1 and EDGE-3, which are for separate endpoints, i.e. the EEC and the EAS. + +### 8.3.3.2 Operation: Fetch + +This operation is deprecated. The operation defined in clause 8.3.3.3 should be used instead. + +#### 8.3.3.2.1 Description + +This custom operation allows the EAS to fetch a UE's identifier, which is UE ID as specified in 3GPP TS 23.558 [2], from the EES for a given UE information. + +#### 8.3.3.2.2 Operation Definition + +This operation shall support the request data structures and the response data structure and response codes specified in the tables 8.3.3.2.2-1 and 8.3.3.2.2-2. + +**Table 8.3.3.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-------------------------------------------------------------| +| UserInformation | M | 1 | Information about the User or the UE, available at the EAS. | + +**Table 8.3.3.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Gpsi | M | 1 | 200 OK | The UE Identifier (UE ID), returned by the Edge Enabler Server. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.3.3.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative EES. | + +**Table 8.3.3.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative EES. | + +### 8.3.3.3 Operation: Get + +#### 8.3.3.3.1 Description + +This custom operation allows the service consumer to retrieve UE Identifier information from the EES for a given User information as specified in 3GPP TS 23.558 [2]. + +#### 8.3.3.3.2 Operation Definition + +This operation shall support the request data structures and the response data structure and response codes specified in the tables 8.3.3.3.2-1 and 8.3.3.3.2-2. + +**Table 8.3.3.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------------------------------------------------------------------| +| UserInfo | M | 1 | Information about the User or the UE, provided by the service consumer. | + +**Table 8.3.3.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeldInfo | M | 1 | 200 OK | The operation is successful and the corresponding UE Identifier information, returned by the Edge Enabler Server is included in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.3.3.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative EES. | + +**Table 8.3.3.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative EES. | + +## 8.3.4 Notifications + +None. + +## 8.3.5 Data Model + +### 8.3.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API + +Table 8.3.5.1-1 specifies the data types defined specifically for the Eees\_UEIdentifier API service. + +**Table 8.3.5.1-1: Eees\_UEIdentifier API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-----------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| UserInformation | 8.3.5.2.2 | Information about the User or the UE, that used by EES to use 3GPP CN capability to retrieve the EAS specific UE identifier. Deprecated. | | +| UserInfo | 8.3.5.2.3 | Information about the User or the UE, that used by EES to retrieve the UE identifier Information. | | +| UeldInfo | 8.3.5.2.4 | UE Identifier Information, including list of UE Identifier related information. | | +| Ueld | 8.3.5.2.5 | UE identifier. | | +| UeldType | 8.3.5.3.3 | Identifies the UE Identifier type. | | + +Table 8.3.5.1-2 specifies data types re-used by the Eees\_UEIdentifier API service. + +**Table 8.3.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|--------------------|------------------------------------------------------------------------------------|----------------------| +| Gpsi | 3GPP TS 29.571 [8] | Used to identify the UE with GPSI. | | +| lpAddr | 3GPP TS 29.571 [8] | IP address of the UE. | | +| Port | 3GPP TS 29.122 [6] | Identifies a port, unsigned integer with valid values between 0 and 65535. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of optional features defined in table 8.3.7-1. | | + +### 8.3.5.2 Structured data types + +#### 8.3.5.2.1 Introduction + +#### 8.3.5.2.2 Type: UserInfoInformation + +This data type is deprecated. + +**Table 8.3.5.2.2-1: Definition of type UserInfoInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|--------------------|----------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| easId | string | M | 1 | The application identifier of the EAS (e.g. URI, FQDN) requesting the UE Identifier information. | | +| easProviderId | string | O | 0..1 | Identifier of the ASP that provides the EAS. | | +| ipAddr | lpAddr | M | 1 | IP address of the UE. | | +| suppFeat | Supported Features | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.
This attribute shall be provided in the HTTP POST request and success response. | | + +## 8.3.5.2.3 Type: UserInfo + +Table 8.3.5.2.3-1: Definition of type UserInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| easIds | array(string) | C | 1..N | The list of EAS Identifiers for which the UE IDs are requested by the service consumer for the given user information (e.g. IP address).

(NOTE 1) | | +| easProviderId | string | O | 0..1 | Identifier of the ASP that provides the EAS. | | +| ueId | Gpsi | O | 0..1 | Identify the UE with GPSI.
(NOTE 2, NOTE 4) | | +| ipAddr | IpAddr | C | 1 | IP address of the UE.
(NOTE 3, NOTE 4) | | +| portNumber | Port | C | 0..1 | Indicates the UDP or TCP port number associated with the UE IP address as provided in the "ipAddr" attribute.
(NOTE 5) | | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.
This attribute shall be provided in the HTTP POST request and success response. | | + +NOTE 1: This attribute shall be present when the service consumer is an EAS. If this attribute is not present, it shall be interpreted by the EES that it is an EEC that is requesting the UE ID. + +NOTE 2: This attribute may be present only if the service consumer is an EEC. + +NOTE 3: This attribute shall be present when the service consumer is an EAS. When the service consumer is an EEC, this attribute, if provided, may contain both UE's private IPv6 address and UE's private IPv4 address. + +NOTE 4: At least one of these attributes shall be present. + +NOTE 5: This attribute shall be present only when the service consumer is an EAS and the EAS recognizes the UE IP address is a public IP address different from the actual UE IP address (private IP address). + +## 8.3.5.2.4 Type: UeIdInfo + +Table 8.3.5.2.4-1: Definition of type UeIdInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|----------------------------------|---------------| +| ueIds | array(UeId) | C | 1..N | Represents the UE Identifier(s). | | + +### 8.3.5.2.5 Type: Ueld + +**Table 8.3.5.2.5-1: Definition of type Ueld** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| edgeUeld | string | C | 0..1 | Represents the EES generated EDGE UE Identifier of the UE.

This attribute shall be provided only if it is the Edge UE ID that needs to be returned.

(NOTE) | | +| afSpecUeld | Gpsi | C | 0..1 | Identifier of the AF specific UE Identifier in the GPSI format of External ID.

This attribute shall be provided only if it is the AF-specific UE ID that needs to be returned.

(NOTE) | | +| easId | string | M | 0..1 | Represents the identifier of the EAS for which the provided UE ID is related.

This attribute shall be present only if the "easIds" attribute was provided in the corresponding request. | | + +NOTE: These attributes are mutually exclusive. Either one of them shall be present. + +### 8.3.5.3 Simple data types and enumerations + +#### 8.3.5.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 8.3.5.3.2 Simple data types + +The simple data types defined in table 8.3.5.3.2-1 shall be supported. + +**Table 8.3.5.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 8.3.6 Error Handling + +General error responses are defined in clause 7.7. + +## 8.3.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.3.7-1 lists the supported features for Eees\_UEIdentifier API. + +**Table 8.3.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 8.4 Eees\_AppClientInformation API + +### 8.4.1 Introduction + +The Eees\_AppClientInformation service shall use the Eees\_AppClientInformation API. + +The API URI of the Eees\_AppClientInformation API shall be: + +**{apiRoot}
/** + +The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5, i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in clause 7.5. +- The shall be "ees-appclientinformation". +- The shall be "v1". +- The shall be set as described in clause 8.4.2. + +### 8.4.2 Resources + +#### 8.4.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.4.2.1-1 depicts the resource URIs structure for the Eees\_AppClientInformation API. + +![Diagram showing the hierarchical structure of resource URIs for the Eees_AppClientInformation API. The root URI is {apiRoot}/ees-appclientinformation/. It branches into /subscriptions, which further branches into /{subscriptionId}.](d6f4ba0e72f3631816d733b5cff14c3f_img.jpg) + +``` +graph TD; Root["{apiRoot}/ees-appclientinformation/"] --- Subscriptions["/subscriptions"]; Subscriptions --- SubscriptionId["/{subscriptionId}"]; +``` + +Diagram showing the hierarchical structure of resource URIs for the Eees\_AppClientInformation API. The root URI is {apiRoot}/ees-appclientinformation/. It branches into /subscriptions, which further branches into /{subscriptionId}. + +**Figure 8.4.2.1-1: Resource URI structure of the Eees\_AppClientInformation API** + +Table 8.4.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.4.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------------------|---------------------------------|---------------------------------|------------------------------------------------------------------------------------------------| +| Application Client Information Subscriptions | /subscriptions | POST | Creates a subscription for reporting of AC information to the EAS. | +| Individual Application Client Information Subscription | /subscriptions/{subscriptionId} | GET | Retrieves the Individual AC information subscription information identified by subscriptionId. | +| | | PATCH | Partially updates the Individual AC information subscription identified by subscriptionId. | +| | | PUT | Fully replaces the Individual AC information subscription identified by subscriptionId. | +| | | DELETE | Removes the Individual AC information subscription identified by subscriptionId. | + +## 8.4.2.2 Resource: Application Client Information Subscriptions + +### 8.4.2.2.1 Description + +This resource represents all AC information subscriptions at a given EES. + +### 8.4.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ees-applicationinformation//subscriptions + +This resource shall support the resource URI variables defined in the table 8.4.2.2.2-1. + +**Table 8.4.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 8.4.2.2.3 Resource Standard Methods + +#### 8.4.2.2.3.1 POST + +This method creates the AC information subscription at the EES for reporting of the AC capabilities. This method shall support the URI query parameters specified in the table 8.4.2.2.3.1-1. + +**Table 8.4.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.4.2.2.3.1-2 and the response data structures and response codes specified in table 8.4.2.2.3.1-3. + +**Table 8.4.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-------------------------------------------| +| ACInfoSubscription | M | 1 | Create a new AC information subscription. | + +**Table 8.4.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ACInfoSubscription | M | 1 | 201 Created | The individual AC information subscription resource created successfully. The information about the confirmed subscription at the EES is provided in the response body.

The URI of the created resource shall be returned in the "Location" HTTP header. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. | | | | | + +**Table 8.4.2.2.3.1-4: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/eees-appclientinformation//subscriptions/{subscriptionId} | + +#### 8.4.2.2.4 Resource Custom Operations + +None. + +#### 8.4.2.3 Resource: Individual Application Client Information Subscription + +##### 8.4.2.3.1 Description + +This resource represents the individual application client information subscription of an EAS at a given EES. + +##### 8.4.2.3.2 Resource Definition + +Resource URI: {apiRoot}/eees-appclientinformation//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in the table 8.4.2.3.2-1. + +**Table 8.4.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------------|-----------|-------------------------------------------------------| +| apiRoot | string | See clause 7.5 | +| subscriptionId | string | Identifies an individual AC information subscription. | + +#### 8.4.2.3.3 Resource Standard Methods + +##### 8.4.2.3.3.1 GET + +This method retrieves the AC information subscription information at EES. This method shall support the URI query parameters specified in the table 8.4.2.3.3.1-1. + +**Table 8.4.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.4.2.3.3.1-2 and the response data structures and response codes specified in table 8.4.2.3.3.1-3. + +**Table 8.4.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.4.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ACInfoSubscription | M | 1 | 200 OK | The AC information subscription information is returned by the EES. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.4.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.4.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.4.2.3.3.2 PATCH + +This method partially updates the individual AC information subscription information at the EES. This method shall support the URI query parameters specified in the table 8.4.2.3.3.2-1. + +**Table 8.4.2.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.4.2.3.3.2-2 and the response data structures and response codes specified in table 8.4.2.3.3.2-3. + +**Table 8.4.2.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------| +| ACInfoSubscriptionPatch | M | 1 | Request to partially update the individual AC information subscription matching the subscriptionId at the EES. | + +**Table 8.4.2.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ACInfoSubscription | M | 1 | 200 OK | The individual AC information subscription matching the subscriptionId was modified successfully and the updated AC information subscription information is returned in the response. | +| n/a | | | 204 No Content | The individual AC information subscription matching the subscriptionId was modified successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.4.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.4.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.4.2.3.3.3 PUT + +This method updates the AC information subscription information at the EES by completely replacing the existing subscription data (except easId). This method shall support the URI query parameters specified in the table 8.4.2.3.3.3-1. + +**Table 8.4.2.3.3.3-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.4.2.3.3.3-2 and the response data structures and response codes specified in table 8.4.2.3.3.3-3. + +**Table 8.4.2.3.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| ACInfoSubscription | M | 1 | Details of individual AC information subscription matching the subscriptionId to be updated at the EES. | + +**Table 8.4.2.3.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ACInfoSubscription | M | 1 | 200 OK | The individual AC information subscription matching the subscriptionId was modified successfully and the updated AC subscription information is returned in the response. | +| n/a | | | 204 No Content | The individual AC information subscription matching the subscriptionId was modified successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.4.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.4.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.4.2.3.3.4 DELETE + +This method removes the AC information subscription information from the EES. This method shall support the URI query parameters specified in the table 8.4.2.3.3.4-1. + +**Table 8.4.2.3.3.4-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.4.2.3.3.4-2 and the response data structures and response codes specified in table 8.4.2.3.3.4-3. + +**Table 8.4.2.3.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.4.2.3.3.4-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | M | 1 | 204 No Content | The individual AC information subscription matching the subscriptionId is deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.4.2.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.4.2.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.4.2.3.4 Resource Custom Operations + +None. + +### 8.4.3 Custom Operations without associated resources + +None. + +## 8.4.4 Notifications + +### 8.4.4.1 General + +**Table 8.4.4.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------|---------------------------|---------------------------------|-------------------------------------------------| +| AC Information Notification | {notificationDestination} | POST | Notifies the subscriber EAS the AC information. | + +### 8.4.4.2 AC Information Notification + +#### 8.4.4.2.1 Description + +AC Information Notification is used by the EES to notify an EAS with AC information matching the filter criteria. + +#### 8.4.4.2.2 Target URI + +The callback URI {notificationDestination} shall be used with the callback URI variables defined in table 8.4.4.2.2-1. + +**Table 8.4.4.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-------------------------|-----------|-------------------------------------------------------------------------------------------------------------------| +| notificationDestination | Uri | Callback reference provided by the EAS during AC information subscription creation/update/modification procedure. | + +#### 8.4.4.2.3 Standard Methods + +##### 8.4.4.2.3.1 POST + +This method shall support the request data structures specified in table 8.4.4.2.3.1-1 and the response data structures and response codes specified in table 8.4.4.2.3.1-2. + +**Table 8.4.4.2.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|------------------------------------| +| ACInfoNotification | M | 1 | Notification of AC(s) information. | + +**Table 8.4.4.2.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.2.4.4.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +**Table 8.2.4.4.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +## 8.4.5 Data Model + +### 8.4.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API + +Table 8.4.5.1-1 specifies the data types defined specifically for the Eees\_AppClientInformation API service. + +**Table 8.4.5.1-1: Eees\_AppClientInformation API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-------------------------|-----------------|--------------------------------------------------------------------------|---------------| +| ACInfoSubscription | 8.4.5.2.2 | Represents the AC information subscription. | | +| ACInfoSubscriptionPatch | 8.4.5.2.3 | Used to request the partial update of AC information subscription. | | +| ACFilters | 8.4.5.2.4 | Used to list the set of characteristics to discover the ACs. | | +| ACInfoNotification | 8.4.5.2.5 | AC information notification matching the filter criteria. | | +| ACInformation | 8.4.5.2.6 | Used to represent the AC information in the AC information notification. | | + +Table 8.4.5.1-2 specifies data types re-used by the Eecs\_AppClientInformation API service. + +**Table 8.4.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| DateTime | 3GPP TS 29.122 [6] | Used to capture the expiration time of EAS subscription for application client information reporting. | | +| ReportingInformation | 3GPP TS 29.523 [13] | Used to indicate the reporting requirement, only the following information are applicable:
- immRep
- notifMethod
- maxReportNbr
- monDur
- repPeriod | | +| Uri | 3GPP TS 29.122 [6] | | | +| WebsockNotifConfig | 3GPP TS 29.122 [6] | Following differences apply:
- The SCEF is the EES; and
- The SCS/AS is the subscribing EAS. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of optional features. | | +| TestNotification | 3GPP TS 29.122 [6] | Following differences apply:
- The SCEF is the EES; and
- The SCS/AS is the subscribing EAS. | | +| LocationArea5G | 3GPP TS 29.122 [6] | Used to define the geographic and topological area. | | +| ScheduledCommunicationTime | 3GPP TS 29.122 [6] | Used to define the operation schedule of AC. | | +| Gpsi | 3GPP TS 29.571 [8] | Used to identify the UE in the query parameter, for which location information is queried. | | +| ACProfile | 3GPP TS 24.558 [14] | Used to represent the profile the information of the Application Client. | | +| ServiceArea | Clause 9.1.5.2.5 | Used to represent the EAS service area in ACFilters data type. | | +| ACServiceKPIs | 3GPP TS 24.558 [14] | Used to represent the minimum and maximum AC service KPI information of the Application Client. | | + +## 8.4.5.2 Structured data types + +### 8.4.5.2.1 Introduction + +### 8.4.5.2.2 Type: ACInfoSubscription + +**Table 8.4.5.2.2-1: Definition of type ACInfoSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| easId | string | M | 1 | The application identifier of the EAS (e.g. URI, FQDN) subscribing for AC information report. | | +| acFltrs | array(ACFilters) | O | 1..N | Filters to retrieve the information about particular ACs. | | +| expTime | DateTime | O | 0..1 | Indicates the expiration time of the subscription. If the expiration time is not present, then it indicates that the EAS subscription never expires. | | +| eventReq | ReportingInformation | O | 0..1 | Represents the reporting requirements of the AC information subscription. (NOTE) | | +| notificationDestination | Uri | C | 0..1 | URI where the notification on information about particular ACs should be delivered to. This attribute shall be present in HTTP POST message to EES and maybe present in HTTP PUT request. | | +| requestTestNotification | boolean | O | 0..1 | Set to true by Subscriber to request the EES to send a test notification as defined in clause 7.6. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | O | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 7.6. | Notification_websocket | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.
This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | + +NOTE: The applicable values of the ReportingInformation data type are, "immRep", "notifMethod", "maxReportNbr", "monDur", "repPeriod". + +### 8.4.5.2.3 Type: ACInfoSubscriptionPatch + +**Table 8.4.5.2.3-1: Definition of type ACInfoSubscriptionPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|----------------------|---|-------------|------------------------------------------------------------------------------------|---------------| +| eventReq | ReportingInformation | O | 0..1 | The reporting requirements of the AC information event subscription to be updated. | | +| expTime | DateTime | O | 0..1 | Indicates the proposed expiration time of the subscription. | | +| notificationDestination | Uri | O | 0..1 | Updated URI where the AC information notification should be delivered to. | | +| acFltrs | array(ACFilters) | O | 1..N | Filters to retrieve the information about particular ACs. | | + +## 8.4.5.2.4 Type: ACFilters + +Table 8.4.5.2.4-1: Definition of type ACFilters + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| acTypes | array(string) | O | 1..N | List of AC types or categories to be matched. | | +| ecspIds | array(string) | O | 1..N | The list of identifiers of the ECSPs associated with the EEC. | | +| acIds | array(string) | O | 1..N | List of the identifiers of the AC(s) to be matched. | | +| svcArea | ServiceArea | O | 0..1 | EAS service area for identifying the UEs with matching expected geographical and topological location(s). | | +| maxAcKpi | ACServiceKPIs | O | 0..1 | Maximum value of the AC service KPIs to identify the matched ACs. The service KPI values in this attribute need to be higher than the service KPIs information of the AC profiles provided during registrations and/or discovery need to be lower. | | +| minAcKpi | ACServiceKPIs | O | 0..1 | Minimum value of the AC service KPIs to identify the matched ACs. The service KPI values in this attribute need to be lower than the service KPIs information of the AC profiles provided during registrations and/or discovery need to be lower. | | +| opSchds | array(ScheduledCommunicationTime) | O | 1..N | The operation schedule of the EAS to be matched with operation schedule of the AC. | | +| ueIds | array(Gpsi) | O | 1..N | List of UE identifiers hosting the AC. | | +| locInfs | LocationArea5G | O | 0..1 | List of location(s) of the UE(s) hosting the AC. | | + +## 8.4.5.2.5 Type: ACInfoNotification + +Table 8.4.5.2.5-1: Definition of type ACInfoNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------|---------------| +| subId | string | M | 1 | String identifying the individual AC information subscription for which the AC information notification is delivered. | | +| acInfs | array(ACInformation) | M | 1..N | List of notifications that include the information of the ACs matching the filter criteria. | | + +## 8.4.5.2.6 Type: ACInformation + +Table 8.4.5.2.6-1: Definition of type ACInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|-------------------------------------------------|---------------| +| acProfs | array(ACProfile) | M | 1..N | List of ACs profile information. | | +| ueIds | array(Gpsi) | O | 1..N | List of UE identifiers hosting the ACs. | | +| ueLocInfs | LocationArea5G | O | 0..1 | Location information of the UEs hosting the AC. | | + +### 8.4.5.3 Simple data types and enumerations + +None. + +## 8.4.6 Error Handling + +### 8.4.6.1 General + +For the Eees\_AppClientInformation API, HTTP error responses, protocol errors and application errors shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses are applicable for the Eees\_AppClientInformation API. + +### 8.4.6.2 Protocol Errors + +No specific protocol errors for the Eees\_AppClientInformation API are specified. + +### 8.4.6.3 Application Errors + +The application errors defined for the Eees\_AppClientInformation API are listed in Table 8.4.6.3-1. + +**Table 8.4.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|------------------|-----------------------------------------------------------------------------------------------------------| +| REGISTRATION_REQUIRED | 403 Forbidden | Indicates that registration at the EES is required for the EAS to be authorized to perform the operation. | + +## 8.4.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.4.7-1 lists the supported features for Eees\_AppClientInformation API. + +**Table 8.4.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_test_event | Testing of notification connection is supported according to clause 7.6. | +| 2 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 7.6. This feature requires that the Notification_test_event feature is also supported. | + +## 8.5 Eees\_SessionWithQoS API + +### 8.5.1 Introduction + +The Eees\_SessionWithQoS service shall use the Eees\_SessionWithQoS API. + +The API URI of the Eees\_SessionWithQoS API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5, i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in clause 7.5. +- The shall be "ees-session-with-qos". +- The shall be "v1". +- The shall be set as described in clause 8.5.2. + +## 8.5.2 Resources + +### 8.5.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.5.2.1-1 depicts the resource URIs structure for the Eees\_SessionWithQoS API. + +![Diagram showing the hierarchical structure of Resource URIs for the Eees_SessionWithQoS API. The root URI is {apiRoot}/ees-session-with-qos/. It branches to /sessions, which further branches to /{sessionId}.](1b2ce053624064d94a4143854da46702_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ees-session-with-qos/"] --> Sessions["/sessions"] + Sessions --> SessionId["/{sessionId}"] + +``` + +Diagram showing the hierarchical structure of Resource URIs for the Eees\_SessionWithQoS API. The root URI is {apiRoot}/ees-session-with-qos/. It branches to /sessions, which further branches to /{sessionId}. + +**Figure 8.5.2.1-1: Resource URI structure of the Eees\_SessionWithQoS API** + +Table 8.5.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.5.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------------|-----------------------|---------------------------------|---------------------------------------------------------------------------------------------| +| Sessions with QoS | /sessions | POST | Create a new individual Session with QoS | +| | | GET | Read all subscription resources for given EAS. | +| Individual Session with QoS | /sessions/{sessionId} | PUT | Fully replace an existing Individual Session with QoS resource identified by a sessionId. | +| | | PATCH | Partially update an existing Individual Session with QoS resource identified by a sessionId | +| | | DELETE | Remove an Individual Session with QoS resource identified by a sessionId. | +| | | GET | Read a subscription resource for a sessionId. | + +## 8.5.2.2 Resource: Sessions with QoS + +### 8.5.2.2.1 Description + +This resource represents session information of all the data sessions with a specific QoS setting at a given Edge Enabler Server. + +### 8.5.2.2.2 Resource Definition + +Resource URI: {apiRoot}/eecs-session-with-qos//sessions + +This resource shall support the resource URI variables defined in the table 8.5.2.2.2-1. + +**Table 8.5.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 8.5.2.2.3 Resource Standard Methods + +#### 8.5.2.2.3.1 POST + +This method requests resources for a data session between AC and EAS with a specific QoS and may create the session information subscription at the Edge Enabler Server for receiving the user plane event notification of the session information. This method shall support the URI query parameters specified in table 8.5.2.2.3.1-1. + +**Table 8.5.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.5.2.2.3.1-2 and the response data structures and response codes specified in table 8.5.2.2.3.1-3. + +**Table 8.5.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|--------------------------------------------------------------------------------------------------| +| SessionWithQoS | M | 1 | Parameters to create a subscription for a session with required QoS for the service requirement. | + +**Table 8.5.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SessionWithQoS | M | 1 | 201 Created | The session is successfully set up with requested QoS, and the session information is provided in the response body.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. | | | | | +| NOTE 2: Failure cases are described in clause 8.5.6.3. | | | | | + +**Table 8.5.2.2.3.1-4: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ eees-session-with-qos//sessions/{sessionId} | + +#### 8.5.2.2.3.2 GET + +The GET method allows to read all active subscriptions for a given EAS. The EAS shall initiate the HTTP GET request message and the EES shall respond to the message. This method shall support the URI query parameters specified in table 8.5.2.2.3.2-1. + +**Table 8.5.2.2.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| eas-id | string | M | 1 | Represents the application identifier of the EAS , e.g. URI, FQDN, that is querying the status of subscriptions. | + +This method shall support the request data structures specified in table 8.5.2.2.3.2-2 and the response data structures and response codes specified in table 8.5.2.2.3.2-3. + +**Table 8.5.2.2.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.5.2.2.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(SessionWithQoS) | M | 1..N | 200 OK | The subscription information related to the request URI is returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.5.2.2.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.5.2.2.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.5.2.2.4 Resource Custom Operations + +None. + +#### 8.5.2.3 Resource: Individual Session with QoS + +##### 8.5.2.3.1 Description + +This resource represents an individual session information of the data session with a specific QoS setting at a given Edge Enabler Server. + +##### 8.5.2.3.2 Resource Definition + +Resource URI: {apiRoot}/eecs-session-with-qos//sessions/{sessionId} + +This resource shall support the resource URI variables defined in the table 8.5.2.3.2-1. + +**Table 8.5.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|-----------|-----------|------------------------------------------------| +| apiRoot | string | See clause 7.5. | +| sessionId | string | Contains the identifier of a Session with QoS. | + +##### 8.5.2.3.3 Resource Standard Methods + +###### 8.5.2.3.3.1 PATCH + +This method partially updates the QoS of the data session between AC and EAS. This method shall support the URI query parameters specified in the table 8.5.2.3.3.1-1. + +**Table 8.5.2.3.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.5.2.3.3.1-2 and the response data structures and response codes specified in table 8.5.2.3.3.1-3. + +**Table 8.5.2.3.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|-------------------------------------------------------------------------------------| +| SessionWithQoS
Patch | M | 1 | Request to partially update the data session between AC and EAS with a specific QoS | + +**Table 8.5.2.3.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SessionWithQoS | M | 1 | 200 OK | The individual Session with QoS is successfully modified and the updated session with QoS context information is returned in the response | +| n/a | | | 204 No Content | The individual Session with QoS is successfully modified. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +NOTE 2: Failure cases are described in clause 8.5.6.3. + +**Table 8.5.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.5.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +### 8.5.2.3.3.2 PUT + +This method requests modification of QoS of the data session between AC and EAS and may modify the subscription of the event monitoring by subscribing to new events or removing subscriptions to existing events at the Edge Enabler Server for receiving the user plane event notification of the session information. This method shall support the URI query parameters specified in the table 8.5.2.3.3.2-1. + +**Table 8.5.2.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.5.2.3.3.2-2 and the response data structures and response codes specified in table 8.5.2.3.3.2-3. + +**Table 8.5.2.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|--------------------------------------------------------------------------------------------------| +| SessionWithQoS | M | 1 | Parameters to create a subscription for a session with required QoS for the service requirement. | + +**Table 8.5.2.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SessionWithQoS | M | 1 | 200 OK | The individual Session with QoS is successfully modified and the updated session with QoS context information is returned in the response. | +| n/a | | | 204 No Content | The individual Session with QoS is successfully modified. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +NOTE 2: Failure cases are described in clause 8.5.6.3. + +**Table 8.5.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.5.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +### 8.5.2.3.3.3 DELETE + +This method revokes the data session between AC and EAS with a specific QoS and unsubscribes to the related session with user plane event notification. This method shall support the URI query parameters specified in table 8.5.2.3.3.3-1. + +**Table 8.5.2.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.5.2.3.3.3-2 and the response data structures and response codes specified in table 8.5.2.3.3.3-3. + +**Table 8.5.2.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.5.2.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | M | 1 | 204 No Content | The individual Session with QoS resource matching the sessionId is successfully deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.5.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.5.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.5.2.3.3.4 GET + +The GET method allows to read a subscription. The EAS shall initiate the HTTP GET request message and the EES shall respond to the message. This method shall support the URI query parameters specified in table 8.5.2.3.3.4-1. + +**Table 8.5.2.3.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.5.2.3.3.4-2 and the response data structures and response codes specified in table 8.5.2.3.3.4-3. + +**Table 8.5.2.3.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.5.2.3.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SessionWithQoS | M | 1 | 200 OK | The subscription information related to the request URI is returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.5.2.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.5.2.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.5.2.3.4 Resource Custom Operations + +None. + +### 8.5.3 Custom Operations without associated resources + +None. + +### 8.5.4 Notifications + +#### 8.5.4.1 General + +**Table 8.5.4.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------------------|---------------------------|---------------------------------|------------------------------------------------------| +| User Plane Event Notification | {notificationDestination} | POST | Notifies the EAS the subscribed user plane event(s). | + +## 8.5.4.2 User Plane Event Notification + +### 8.5.4.2.1 Description + +### 8.5.4.2.2 TargetURI + +The callback URI {**notificationDestination**} shall be used with the callback URI variables defined in table 8.5.4.2.2-1. + +**Table 8.5.4.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-------------------------|-----------|--------------------------------------------------------------------------------------------------------| +| notificationDestination | Uri | Callback reference provided by the EAS during session with QoS creation/update/modification procedure. | + +### 8.5.4.2.3 Standard Methods + +#### 8.5.4.2.3.1 POST + +This method shall support the request data structures specified in table 8.5.4.2.3.1-1 and the response data structures and response codes specified in table 8.5.4.2.3.1-2. + +**Table 8.5.4.2.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-----------------------------------------------------------| +| UserPlaneEventNotification | M | 1 | Notification of the user plane event on the data session. | + +**Table 8.5.4.2.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.5.4.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +**Table 8.5.4.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +## 8.5.5 Data Model + +### 8.5.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API + +Table 8.5.5.1-1 specifies the data types defined specifically for the Eees\_SessionWithQoS API service. + +**Table 8.5.5.1-1: Eees\_SessionWithQoS API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|----------------------------|-----------------|-------------|---------------| +| SessionWithQoS | 8.5.5.2.2 | | | +| SessionWithQoSPatch | 8.5.5.2.3 | | | +| UserPlaneEventNotification | 8.5.5.2.4 | | | + +Table 8.5.5.1-2 specifies data types re-used by the Eees\_SessionWithQoS API service. + +**Table 8.5.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|--------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------|----------------------| +| Gpsi | 3GPP TS 29.571 [8] | Used to identify the UE, for which the related session with QoS is requested to. | | +| Ipv4Addr | 3GPP TS 29.122 [6] | Identifying the IPv4 address of the UE. | | +| Ipv6Addr | 3GPP TS 29.122 [6] | Identifying the IPv6 address of the UE. | | +| UserPlaneEvent | 3GPP TS 29.122 [6] | Indicates the event reported by the EES. | | +| SponsorInformation | 3GPP TS 29.122 [6] | Indicates a sponsor information | | +| QosMonitoringInformation | 3GPP TS 29.122 [6] | Indicates the QoS Monitoring information | | +| DurationSecRm | 3GPP TS 29.571 [8] | This data type is defined in the same way as the "DurationSec" data type, but with the OpenAPI "nullable: true" property. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of optional features. | | +| TestNotification | 3GPP TS 29.122 [6] | This type represents a notification that can be sent to test whether a chosen notification mechanism works | | +| Uri | 3GPP TS 29.122 [6] | | | +| WebsockNotifConfig | 3GPP TS 29.122 [6] | This type represents configuration for the delivery of notifications over Websockets. | | +| Dnn | 3GPP TS 29.571 [8] | Identifies a DNN. | | +| GroupId | 3GPP TS 29.571 [8] | Used to present the internal group identifier in the AS session with QoS subscription/request. | | +| ExternalGroupId | 3GPP TS 29.571 [8] | Used to present the external group identifier in the AS session with QoS subscription/request. | | +| Snssai | 3GPP TS 29.571 [8] | Identifies a S-NSSAI | | +| FlowDescription | 3GPP TS 29.514 [16] | Identifies an IP flow description. | | +| BitRateRm | 3GPP TS 29.571 [8] | This data type is defined in the same way as the "BitRate" data type, but with the OpenAPI "nullable: true" property. | | +| UserPlaneEventReport | 3GPP TS 29.122 [6] | Represents an event report for user plane. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of optional features. | | +| TrafficFilterInfo | 8.6.5.2.12 | Represents the traffic filter information. | EdgeApp_2 | + +## 8.5.5.2 Structured data types + +### 8.5.5.2.1 Introduction + +### 8.5.5.2.2 Type: SessionWithQoS + +**Table 8.5.5.2.2-1: Definition of type SessionWithQoS** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| self | Uri | C | 0..1 | Link to the "Individual Session with QoS" resource.
Shall only be present in the HTTP GET response on the "Sessions with QoS" resource. | | +| easId | string | M | 1 | The application identifier of the EAS (e.g. URI, FQDN). | | +| uelpv4Addr | Ipv4Addr | O | 0..1 | IPv4 address of the UE. (NOTE 1) | | +| uelpv6Addr | Ipv6Addr | O | 0..1 | IPv6 address of the UE. (NOTE 1) | | +| ipDomain | string | O | 0..1 | Identifies the IP domain.
The attribute may only be provided if the uelpv4Addr attribute is present. | | +| ueId | Gpsi | O | 0..1 | Identifier of the UE for which related session with QoS is requested to. (NOTE 1) | | +| intGrpId | GroupId | O | 0..1 | The internal group identifier, identifying the group of UEs for which related session with QoS is requested to. (NOTE 1) | | +| extGrpId | ExternalGroupId | O | 0..1 | The external group identifier, identifying the group of UEs for which the related session with QoS is requested to. (NOTE 1) | | +| ipFlows | array(Flow Description) | M | 1..N | Contains the flow description for the Uplink and/or Downlink IP flows. (NOTE 3) | | +| qosReference | string | O | 0..1 | Identifies a pre-defined QoS information (NOTE 2) | | +| trafFilterInfo | TrafficFilterInfo | O | 0..1 | Represents the traffic filter information.

This attribute may be present only if the "event" attribute is set to "UP_PATH_CHG", "ACR_MONITORING" and/or "ACR_FACILITATION". (NOTE 3) | EdgeApp_2 | +| altQosReference | array(string) | O | 1..N | Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. | | +| events | array(UserPlaneEvent) | O | 1..N | Indicates the events subscribed by the EAS. | | +| sponsorInformation | SponsorInformation | O | 0..1 | Describes the sponsor information. | | +| qosMonInfo | QosMonitoringInformation | O | 0..1 | Qos Monitoring information. It may be present when the event "QOS_MONITORING" is subscribed. | | +| notificationDestination | Uri | C | 0..1 | URI where the event notification shall be delivered to.
This attribute shall be present if the "events" attribute is included. | | +| dnn | Dnn | O | 0..1 | Dnn of the PDU session, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. | | +| snssai | Snssai | O | 0..1 | S-NSSAI of the PDU session. | | +| maxbrUl | BitRate | O | 0..1 | Indicates the (requested) maximum bandwidth in uplink. (NOTE 2) | | +| maxbrDl | BitRate | O | 0..1 | Indicates the (requested) maximum bandwidth in downlink. (NOTE 2) | | +| disUeNotif | boolean | O | 0..1 | Indicates to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation when it is included and set to "true". The fulfilled situation is | | + +| | | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| | | | | either the QoS profile or an Alternative QoS Profile. The default value "false" shall apply, if the attribute is not present and has not been supplied previously. | | +| requestTestNotification | boolean | O | 0..1 | Set to true by Subscriber to request the EES to send a test notification as defined in 3GPP TS 29.122 [6]. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | Websock
NotifConfig | O | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in 3GPP TS 29.122 [6]. | Notification_websocket | +| suppFeat | Supported
Features | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.
This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | +| NOTE 1: Only one of UE IP address (ipv4Addr or ipv6Addr), UE Identifier (ueId), Internal group identifier (intGrpId), or External group identifier (extGrpId) shall be included. | | | | | | +| NOTE 2: Only one of requested QoS (qosReference) or Requested bandwidth (maxbuUl and/or maxbtDl) shall be included. | | | | | | +| NOTE 3: If the "EdgeApp_2" feature is supported, the "ipFlows" attribute within the "trafFilterInfo" attribute take the precedence over the "ipFlows" attribute when both are provided. | | | | | | + +## 8.5.5.2.3 Type: SessionWithQoSPatch + +Table 8.5.5.2.3-1: Definition of type SessionWithQoSPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ipFlows | array(Flow Description) | O | 1..N | Contains the flow description for the Uplink and/or Downlink IP flows.
(NOTE) | | +| trafFilterInfo | TrafficFilterInfo | O | 0..1 | Represents the traffic filter information.

This attribute may be present only if the "event" attribute is set to "UP_PATH_CHG", "ACR_MONITORING" and/or "ACR_FACILITATION".
(NOTE) | EdgeApp_2 | +| qosReference | string | O | 0..1 | Identifies a pre-defined QoS information. | | +| altQosReference | array(string) | O | 1..N | Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. | | +| Events | array(UserPlaneEvent) | O | 1..N | Indicates the event subscribed by the EAS. | | +| sponsorInformation | SponsorInformation | O | 0..1 | Describes the sponsor information such as who is sponsoring the traffic. | | +| qosMonInfo | QosMonitoringInformationRm | O | 0..1 | Qos Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed. | | +| notificationDestination | Uri | O | 0..1 | URI where the monitoring event notification should be delivered to. | | +| maxbrUl | BitRateRm | O | 0..1 | Indicates the (requested) maximum bandwidth in uplink. | | +| maxbrDl | BitRateRm | O | 0..1 | Indicates the (requested) maximum bandwidth in downlink. | | +| disUeNotif | boolean | O | 0..1 | Indicates to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation when it is included and set to "true". The fulfilled situation is either the QoS profile or an Alternative QoS Profile. The default value "false" shall apply, if the attribute is not present and has not been supplied previously. | | + +NOTE: If the "EdgeApp\_2" feature is supported, the "ipFlows" attribute within the "trafFilterInfo" attribute take the precedence over the "ipFlows" attribute when both are provided. + +## 8.5.5.2.4 Type: UserPlaneEventNotification + +Table 8.5.5.2.4-1: Definition of type UserPlaneEventNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| sessionId | string | M | 1 | String identifying the individual data session information for which the QoS event notification is delivered. | | +| eventReports | array(UserPlaneEventReport) | M | 1..N | List of user plane event reports and application information that include the QoS event information of the data session. | | + +## 8.5.5.3 Simple data types and enumerations + +None. + +## 8.5.6 Error Handling + +### 8.5.6.1 General + +For the Eees\_SessionWithQoS API, HTTP error handling shall be supported as specified in clause 7.7. In addition, the requirements in the following clauses are applicable for the Eees\_SessionWithQoS API. + +### 8.5.6.2 Protocol Errors + +No specific protocol errors for the Eees\_SessionWithQoS API are specified. + +### 8.5.6.3 Application Errors + +The application errors defined for the Eees\_SessionWithQoS API are listed in Table 8.5.6.3-1. + +**Table 8.5.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PFD_MNGT_NOT_SUPPORTED | 403 Forbidden | Indicates that the AS Session with QoS Subscription creation/update is rejected because PFD Management is needed to fulfill the request but it is not supported by the 3GPP network. | + +## 8.5.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.5.7-1 lists the supported features for Eees\_SessionWithQoS API. + +**Table 8.5.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_test_event | Testing of notification connection is supported according to clause 7.6. | +| 2 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 7.6. This feature requires that the Notification_test_event feature is also supported. | + +## 8.6 Eees\_ACRManagementEvent API + +### 8.6.1 Introduction + +The Eees\_ACRManagementEvent service shall use the Eees\_ACRManagementEvent API. + +The API URI of the Eees\_ACRManagementEvent API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5, i.e: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in clause 7.5. +- The shall be "ees-acrmgntevent". + +- The shall be "v1". +- The shall be set as described in clause 8.6.2. + +## 8.6.2 Resources + +### 8.6.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.6.2.1-1 depicts the resource URIs structure for the Eees\_ACRManagementEvent API. + +![Figure 8.6.2.1-1: Resource URI structure of the Eees_ACRManagementEvent API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/eeses-acrmgntevent/. It branches to /subscriptions, which in turn branches to /{subscriptionId}.](1c051a3d61003bc7d513e03015245317_img.jpg) + +``` + +graph TD + Root["{apiRoot}/eeses-acrmgntevent/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Figure 8.6.2.1-1: Resource URI structure of the Eees\_ACRManagementEvent API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/eeses-acrmgntevent/. It branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 8.6.2.1-1: Resource URI structure of the Eees\_ACRManagementEvent API** + +Table 8.6.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.6.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------------------------------|---------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------| +| ACR Management Events Subscriptions | /subscriptions | GET | Query all the subscriptions. | +| | | POST | Create a new Individual ACR Management Events Subscription resource. | +| Individual ACR Management Events Subscription | /subscriptions/{subscriptionId} | GET | Query an existing Individual ACR Management Events Subscription resource identified by a subscriptionId. | +| | | PUT | Fully replace an existing Individual ACR Management Events Subscription resource identified by a subscriptionId. | +| | | PATCH | Partially update an existing Individual ACR Management Events Subscription resource identified by a subscriptionId. | +| | | DELETE | Remove an Individual ACR Management Events Subscription resource identified by a subscriptionId. | + +## 8.6.2.2 Resource: ACR Management Events Subscriptions + +### 8.6.2.2.1 Description + +This resource represents ACR Management Events Subscriptions at a given Edge Enabler Server. + +### 8.6.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ees-acrmgntevent//subscriptions + +This resource shall support the resource URI variables defined in the table 8.6.2.2.2-1. + +**Table 8.6.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 8.6.2.2.3 Resource Standard Methods + +#### 8.6.2.2.3.1 POST + +This method requests to create an Individual ACR Management Event Subscription resource at the EES for receiving the notifications of ACR management events. This method shall support the URI query parameters specified in table 8.6.2.2.3.1-1. + +**Table 8.6.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.6.2.2.3.1-2 and the response data structures and response codes specified in table 8.6.2.2.3.1-3. + +**Table 8.6.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|---------------------------------------------------------------------------------| +| AcrMgmtEventsSubscription | M | 1 | Parameters to create a subscription for notifications of ACR management events. | + +**Table 8.6.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AcrMgmtEventsSubscription | M | 1 | 201 Created | An Individual ACR Management Events Subscription resource is successfully created, and the subscription information is provided in the response body.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. | | | | | +| NOTE 2: Failure cases are described in clause 8.6.6.3. | | | | | + +**Table 8.6.2.2.3.1-4: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/eees-acrmgntevent//subscriptions/{subscriptionId} | + +#### 8.6.2.2.3.2 GET + +This method retrieves all the ACR Management Events Subscriptions information at EES. This method shall support the URI query parameters specified in the table 8.6.2.2.3.2-1. + +**Table 8.6.2.2.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the EAS. | + +This method shall support the request data structures specified in table 8.6.2.2.3.2-2 and the response data structures and response codes specified in table 8.6.2.2.3.2-3. + +**Table 8.6.2.2.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.6.2.2.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(AcrMgmtEventsSubscription) | M | 1..N | 200 OK | All the ACR Management Events Subscriptions information is returned by the EES. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.6.2.2.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.6.2.2.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.6.2.2.4 Resource Custom Operations + +None. + +#### 8.6.2.3 Resource: Individual ACR Management Events Subscription + +##### 8.6.2.3.1 Description + +This resource represents an existing Individual ACR Management Events Subscription at a given EES. + +##### 8.6.2.3.2 Resource Definition + +Resource URI: {apiRoot}/ees-acrmgntevent//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in the table 8.6.2.3.2-1. + +**Table 8.6.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------------|-----------|-------------------------------------------------------------------| +| apiRoot | string | See clause 7.5. | +| subscriptionId | string | Contains the identifier of an ACR Management Events Subscription. | + +#### 8.6.2.3.3 Resource Standard Methods + +##### 8.6.2.3.3.1 PATCH + +This method partially updates an existing Individual ACR Management Events Subscription. This method shall support the URI query parameters specified in the table 8.6.2.3.3.1-1. + +**Table 8.6.2.3.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.6.2.3.3.1-2 and the response data structures and response codes specified in table 8.6.2.3.3.1-3. + +**Table 8.6.2.3.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|----------------------------------------------------------------------------------------| +| AcrMgmtEventsSubscriptionPatch | M | 1 | Request to partially update an existing Individual ACR Management Events Subscription. | + +**Table 8.6.2.3.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AcrMgmtEventsSubscription | M | 1 | 200 OK | The Individual ACR Management Events Subscription is successfully modified and the updated subscription information is returned in the response. | +| n/a | | | 204 No Content | The Individual ACR Management Events Subscription is successfully modified. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +NOTE 2: Failure cases are described in clause 8.6.6.3. + +**Table 8.6.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.6.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.6.2.3.3.2 PUT + +This method requests fully replacement of an existing Individual ACR Management Events Subscription at the EES. The request shall not change the values of the "easId", "tgtUeId", "requestTestNotification", "websocketNotifConfig" and/or "suppFeat" attributes within the AcrMgmtEventsSubscription data type. This method shall support the URI query parameters specified in the table 8.6.2.3.3.2-1. + +**Table 8.6.2.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.6.2.3.3.2-2 and the response data structures and response codes specified in table 8.6.2.3.3.2-3. + +**Table 8.6.2.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|----------------------------------------------------------------------------------| +| AcrMgmtEventsSubscription | M | 1 | Parameters to replace an existing Individual ACR Management Events Subscription. | + +**Table 8.6.2.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AcrMgmtEventsSubscription | M | 1 | 200 OK | The existing Individual ACR Management Events Subscription is successfully replaced and the updated subscription information is returned in the response. | +| n/a | | | 204 No Content | The existing Individual ACR Management Events Subscription is successfully modified. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +NOTE 2: Failure cases are described in clause 8.6.6.3 + +**Table 8.6.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.6.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.6.2.3.3.3 DELETE + +This method deletes an existing Individual ACR Management Events Subscription. This method shall support the URI query parameters specified in table 8.6.2.3.3.3-1. + +**Table 8.6.2.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.6.2.3.3.3-2 and the response data structures and response codes specified in table 8.6.2.3.3.3-3. + +**Table 8.6.2.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.6.2.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The existing Individual ACR Management Events Subscription is successfully deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.6.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.6.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.6.2.3.3.4 GET + +This method retrieves the location information subscription information at EES. This method shall support the URI query parameters specified in the table 8.6.2.3.3.4-1. + +**Table 8.6.2.3.3.4-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the EAS. | + +This method shall support the request data structures specified in table 8.6.2.3.3.4-2 and the response data structures and response codes specified in table 8.6.2.3.3.4-3. + +**Table 8.6.2.3.3.4-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.6.2.3.3.4-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|----------|--------------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AcrMgmtEventsSubscription | M | 1 | 200 OK | The Individual ACR Management Events Subscription is returned by the EES. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.6.2.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.6.2.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.6.2.3.4 Resource Custom Operations + +None. + +#### 8.6.3 Custom Operations without associated resources + +None. + +## 8.6.4 Notifications + +### 8.6.4.1 General + +**Table 8.6.4.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------------------------|-----------------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| ACR Management Events Notification | {notificationDestination} | POST | Notifies the EAS the subscribed ACR management event(s). | +| User Plane Path Change Availability Notification | {notificationDestination}/report-availability | report-availability (POST) | Notifies the EAS of the availability of user plane path management events monitoring via the 3GPP 5GC network (e.g. due to UE mobility from 5GC to EPC). | + +### 8.6.4.2 ACR Management Events Notification + +#### 8.6.4.2.1 Description + +#### 8.6.4.2.2 Notification definition + +The POST method is used by the EES for the notifications of subscribed ACR management event(s) and the callback URI shall be provided by the EAS during the creation of the Individual ACR Management Events Subscription resource. + +Callback URI: {notificationDestination} + +This method shall support the URI query parameters specified in table 8.6.4.2.2-1. + +**Table 8.6.4.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 8.6.4.2.2-2 and the response data structures and response codes specified in table 8.6.4.2.2-3. + +**Table 8.6.4.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|--------------------------------------------| +| AcrMgmtEventsNotification | M | 1 | Notification of the ACR management events. | + +**Table 8.6.4.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| EasAckInformation | M | 1 | 200 OK | The receipt of the Notification is acknowledged and includes the acknowledgement information. | +| N/A | | | 307 Temporary Redirect | Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| N/A | | | 308 Permanent Redirect | Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.6.4.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +**Table 8.6.4.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +## 8.6.4.3 User Plane Path Change Availability Notification + +### 8.6.4.3.1 Description + +The User Plane Path Change Availability Notification is used by the EES to notify the EAS of the availability of user plane path management events monitoring via the 3GPP 5GC network (e.g. due to UE mobility from 5GC to EPC). + +### 8.6.4.3.2 Target URI + +The Callback URI "{notificationDestination}/report-availability" shall be used with the callback URI variables defined in table 8.6.4.3.2-1. + +**Table 8.6.4.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------| +| notificationDestination | Uri | Callback reference provided by the EAS during the ACR Management Event subscription creation/update/modification procedure. | + +### 8.6.4.3.3 Standard Methods + +#### 8.6.4.3.3.1 POST + +This method shall support the request data structures specified in table 8.6.4.3.3.1-1 and the response data structures and response codes specified in table 8.6.4.3.3.1-2. + +**Table 8.6.4.3.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------| +| AvailabilityNotif | M | 1 | Notification of the ACR management events. | + +**Table 8.6.4.3.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The notification is successfully received. | +| N/A | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| N/A | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.6.4.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +**Table 8.6.4.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +## 8.6.5 Data Model + +### 8.6.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API. Table 8.6.5.1-1 specifies the data types defined specifically for the Eees\_ACRManagementEvent API service. + +**Table 8.6.5.1-1: Eees\_ACRManagementEvent API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------------------------|------------------------|-------------------------------------------------------------------------------------------------------------------|----------------------| +| AcrMgntEventFailureCode | 8.6.5.3.6 | Represents the reason for ACR Management subscription failure for an event. | | +| AcrMgntEventFilter | 8.6.5.3.4 | Represents the ACR Management Event filter. | | +| AcrMgntEventsSubscription | 8.6.5.2.2 | | | +| AcrMgntEventSubsc | 8.6.5.2.3 | | | +| AcrMgntEventsSubscriptionPatch | 8.6.5.2.4 | | | +| AcrMgntEventsNotification | 8.6.5.2.5 | | | +| AcrMgntEventReport | 8.6.5.2.6 | | | +| ACRParameters | 8.6.5.2.13 | Represents ACR parameters. | EdgeApp_2 | +| ActStatus | 8.6.5.3.5 | Represents ACT status, i.e. ACT start or stop. | | +| AvailabilityNotif | 8.6.5.2.11 | Represents the availability information of user plane path management events monitoring via the 3GPP 5GC network. | | +| AvailabilityStatus | 8.6.5.3.7 | Represents the availability status. | | +| EasAckInformation | 8.6.5.2.15 | Represents the acknowledgement information from EAS in response to ACR notifications. | EdgeApp_2 | +| EasInBundleInfo | 8.6.5.2.16 | Represents EAS in a bundle information. | EdgeApp_2 | +| FailureAcrMgntEventInfo | 8.6.5.2.7 | | | +| AcrMgntEvent | 8.6.5.3.3 | | | +| IndtUeIdentification | 8.6.5.2.10 | Contains individual UE identification information. | | +| ResultCode | 8.6.5.3.8 | Contains the EAS acknowledgement response message. | EdgeApp_2 | +| SelectedACRScenarios | 8.6.5.2.12 | Represents the selected ACR scenario(s) applicable for a given combination of AC and UE. | EdgeApp_2 | +| TargetUeIdentification | 8.6.5.2.8 | Contains target UE(s) identification information. | | +| TrafficFilterInfo | 8.6.5.2.14 | Represents the traffic filter information. | EdgeApp_2 | +| UpPathChangeInfo | 8.6.5.2.9 | Contains user plane path change information. | | + +Table 8.6.5.1-2 specifies data types re-used by the Eees\_ACRManagementEvent API service. + +**Table 8.6.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|------------------------------------------------------------------------------------------------------------|----------------------| +| ACRScenario | 9.1.5.3.3 | Represent the ACR scenarios. | EdgeApp_2 | +| EasCharacteristics | 3GPP TS 24.558 [14] | Represents the EAS characteristics. | | +| DateTime | 3GPP TS 29.122 [6] | | | +| Dnai | 3GPP TS 29.571 [8] | Identifies a DNAI. | | +| DnaiChangeType | 3GPP TS 29.571 [8] | | | +| DnaiChangeTypeRm | 3GPP TS 29.571 [8] | | | +| DomainNameProtocol | 3GPP TS 29.122 [6] | Indicates the additional protocol and protocol field for domain names to be matched. | EdgeApp_2 | +| Endpoint | Clause 8.1.5.2.5 | Represents the endpoint information. | | +| ExternalGroupId | 3GPP TS 29.571 [8] | Represents an external group of UEs. | | +| ExternalId | 3GPP TS 29.122 [6] | Represents an external identifier of a UE. | | +| Gpsi | 3GPP TS 29.571 [8] | | | +| GroupId | 3GPP TS 29.571 [8] | Represents an internal group of UEs. | | +| IpAddr | 3GPP TS 29.571 [8] | | | +| Ipv4Addr | 3GPP TS 29.122 [6] | Identifying the IPv4 address of the UE. | | +| Ipv6Prefix | 3GPP TS 29.571 [8] | Identifies an IPv6 Prefix. | | +| ReportingInformation | 3GPP TS 29.523 [13] | | | +| RouteToLocation | 3GPP TS 29.571 [8] | Describes the traffic routes to the locations of the application. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of optional features. | | +| ServiceArea | 9.1.5.2.5 | Represents the topological and geographic areas. | EdgeApp_2 | +| TestNotification | 3GPP TS 29.122 [6] | This type represents a notification that can be sent to test whether a chosen notification mechanism works | | +| Uri | 3GPP TS 29.122 [6] | | | +| WebsockNotifConfig | 3GPP TS 29.122 [6] | This type represents configuration for the delivery of notifications over Websockets. | | + +## 8.6.5.2 Structured data types + +### 8.6.5.2.1 Introduction + +### 8.6.5.2.2 Type: AcrMgntEventsSubscription + +#### **Table 8.6.5.2.2-1: Definition of type AcrMgntEventsSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| self | Uri | C | 0..1 | Link to the "Individual ACR Management Events Subscription" resource.

Shall only be present in the HTTP GET response on the "ACR Management Events Subscriptions" resource. | | +| easId | string | M | 1 | Contains the application identifier of the EAS (e.g. URI, FQDN). | | +| eventSubscs | array(AcrMgmtEventSubsc) | M | 1..N | Indicates the subscribed ACR management events and the related information. | | +| evtReq | ReportingInformation | O | 0..1 | Indicates the event reporting information.

(NOTE 1, NOTE 2) | | +| notificationDestination | Uri | M | 1 | Contains the URI towards which the event notifications shall be delivered. | | +| eventReports | array(AcrMgmtEventReport) | C | 1..N | Represents ACR management event report(s).

This attribute shall be present in an HTTP POST response if the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute sets to true in the corresponding HTTP POST request, and the report(s) are available.

This attribute may be present in an HTTP PUT or PATCH response when the report(s) are available. | | +| availabilityInfo | AvailabilityNotif | C | 0..1 | Indicates the availability information of user plane path management events monitoring via the 3GPP 5GC network.

This attribute may only be present in an HTTP POST/PUT/PATCH response, if the availability status information is available. | | +| failEventReports | array(FailureAcrMgmtEventInfo) | O | 1..N | Represents the event(s) for which the subscription is not successful including the failure reason(s). | | +| requestTestNotification | boolean | O | 0..1 | Set to true by the EAS to request the EES to send a test notification as defined in 3GPP TS 29.122 [6]. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | O | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in 3GPP TS 29.122 [6]. | Notification_websocket | +| suppFeat | SupportedFeatures | C | 0..1 | Represents the list of Supported features.

This attribute shall be present in the HTTP POST request if at least one feature is supported by the consumer. It shall be present in an HTTP POST response if it was provided in the corresponding HTTP POST request, or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the corresponding HTTP GET request. | | + +NOTE 1: The "evtReq" of an AcrMgmtEventSubsc data structure within the "eventSubscs" attribute takes precedence over the "evtReq" attribute defined in this data structure when both are present. + +NOTE 2: When the "evtReq" is not provided in an AcrMgmtEventSubsc data structure within the "eventSubscs" attribute, the "evtReq" attribute defined in this data structure applies for the corresponding ACR management event subscription. + +## 8.6.5.2.3 Type: AcrMgntEventSubsc + +**Table 8.6.5.2.3-1: Definition of type AcrMgntEventSubsc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| event | AcrMgmtEvent | M | 1 | Indicates the subscribed ACR management event. | | +| eventFilter | AcrMgmtEventFilter | O | 0..1 | Represents the event filter for the subscribed ACR management event.

This attribute may be provided only if the "event" attribute is set to "ACR_MONITORING". | | +| evtReq | ReportingInformation | O | 0..1 | Indicates the event reporting requirements (e.g. reporting periodicity, immediate reporting indication, etc).

(NOTE) | | +| tgtUeId | TargetUeIdentification | C | 0..1 | Contains the UE identification information.

This attribute shall be provided only if the "event" attribute is set to either "UP_PATH_CHG", "ACR_MONITORING" or "ACR_FACILITATION". | | +| dnaiChgType | DnaiChangetype | O | 0..1 | Identifies a type of notification regarding UP path management event.

This attribute may be provided only if the "event" attribute is set to "UP_PATH_CHG". | | +| easAckInd | boolean | O | 0..1 | Identifies whether EAS acknowledgement of UP path change event notifications is to be expected.
Set to "true" if the EAS acknowledgement is expected.
Set to "false" if the EAS acknowledgement is not expected.
Default value is "false".

This attribute may be provided only if the "event" attribute is set to "UP_PATH_CHG". | | +| easChars | array(Eas Characteristics) | O | 1..N | Represents a list of EAS characteristics.

This attribute may be provided only if the "event" attribute is set to either "ACR_MONITORING" or "ACR_FACILITATION". | | +| trafFilterInfo | TrafficFilterInfo | O | 0..1 | Represents the traffic filter information.

This attribute may be present only if the "event" attribute is set to "UP_PATH_CHG", "ACR_MONITORING" and/or "ACR_FACILITATION". | EdgeApp_2 | +| servContPlanInd | boolean | O | 0..1 | Contains the service continuity planning indication (i.e., whether or not the EES shall monitor whether the UE(s) enter the predicted location).

  • - When set to "true", it indicates that service continuity planning is required.
  • - When set to "false", it indicates that service continuity planning is not required.
  • - The default value when this attribute is omitted is false.

This attribute may be present only when | EdgeApp_2 | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------|---------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| | | | | the "event" attribute is set to "ACR_MONITORING" or "ACR_FACILITATION". | | +| easAckSvcCont | boolean | O | 0..1 | Indicates that the EAS will provide an acknowledgement as a response to the notification of ACR management notification related to service continuity planning.

Set to "true" if the EAS acknowledgement is expected. Set to "false" if the EAS acknowledgement is not expected. Default value is "false".

This attribute may be provided only if the "event" attribute is set to "ACR_MONITORING" and/or "ACR_FACILITATION". | EdgeApp_2 | +| NOTE: The "evtReq" takes precedence over the "evtReq" attribute of the AcrMgmtEventsSubscription data structure when both are present. | | | | | | + +#### 8.6.5.2.4 Type: AcrMgmtEventsSubscriptionPatch + +**Table 8.6.5.2.4-1: Definition of type AcrMgmtEventsSubscriptionPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|--------------------------|---|-------------|---------------------------------------------------------|---------------| +| eventSubscs | array(AcrMgmtEventSubsc) | O | 1..N | Indicates the subscribed ACR management events. | | +| evtReq | ReportingInformation | O | 0..1 | Indicates the event reporting information. | | +| notificationDestination | Uri | O | 0..1 | URI where the event notification shall be delivered to. | | + +#### 8.6.5.2.5 Type: AcrMgmtEventsNotification + +**Table 8.6.5.2.5-1: Definition of type AcrMgmtEventsNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------------|---------------| +| subpld | string | M | 1 | String identifying the Individual ACR Management Events Subscription to which the notification is related. | | +| eventReports | array(AcrMgmtEventReport) | M | 1..N | Represents a list of ACR management event `report(s). | | + +8.6.5.2.6 Type: AcrMgntEventReport + +**Table 8.6.5.2.6-1: Definition of type AcrMgntEventReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| event | AcrMgmtEvent | M | 1 | Indicates the subscribed ACR management event. | | +| timeStamp | DateTime | O | 0..1 | Represents the time stamp of the detected event. | | +| easEndPoint | EndPoint | C | 0..1 | Represents the endpoint information of the EAS.
This attribute shall be provided either:
- when the "event" attribute is set to either "ACR_MONITORING" or "ACR_FACILITATION". In such case, it shall contain the endpoint information of the T-EAS; or
- when the "event" attribute is set to "ACT_START_STOP". In such case, it shall contain the endpoint information of the EAS to/from which the ACT needs to be started/stopped. | | +| actStatus | ActStatus | C | 0..1 | Represents the reported ACT status, i.e. ACT start or ACT stop.

This attribute shall be provided only when the "event" attribute is set to "ACT_START_STOP". | | +| acId | string | C | 0..1 | Represents the identifier of the concerned AC.

This attribute shall be provided only when the "event" attribute is set to "ACT_START_STOP". | | +| gpsI | Gpsi | C | 0..1 | Represents external UE identifier.

This attribute shall be provided only when the "event" attribute is set to "ACT_START_STOP". | EdgeApp_2 | +| selACRScen | array(SelectedACRS scenarios) | C | 1..N | Represents the selected ACR scenario(s) for a given combination of AC and UE.

This attribute shall be provided only when the "event" attribute is set to "ACR_SELECTION". | EdgeApp_2 | +| easInBdlInfoList | array(EasInBundleInfo) | C | 1..N | Represents the list of EAS in a bundle related information.

This attribute shall be provided only when the "event" attribute is set to "ACR_SELECTION". | EdgeApp_2 | +| acrParams | ACRParameters | O | 0..1 | Represents the ACR Parameters.

This attribute may only be present when the "actStatus" attribute is present and set to "ACT_START". | EdgeApp_2 | +| upPathChgInfo | UpPathChangeInfo | C | 0..1 | Represents the UP Path change information.
This attribute shall be provided when the "event" attribute is set to "UP_PATH_CHG". | | +| servContPlanInd | boolean | O | 0..1 | Contains the service continuity planning indication (i.e., whether or not the EES will monitor whether the UE(s) enter the predicted location or not).

- When set to "true", it indicates that service continuity planning will be performed.
- When set to "false", it indicates that service continuity planning will not be | EdgeApp_2 | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

performed.

  • - The default value when this attribute is omitted is false.

This attribute may be present only when the "event" attribute is set to "ACR_MONITORING" or "ACR_FACILITATION".

| | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +Editor's Note: The definition and encoding of the "gps" attribute and whether they are needed or not is FFS and pending stage 2 progress. + +#### 8.6.5.2.7 Type: FailureAcrMgmtEventInfo + +**Table 8.6.5.2.7-1: Definition of type FailureAcrMgmtEventInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|------------------------------------------------|---------------| +| event | AcrMgmtEvent | M | 1 | Indicates the subscribed ACR management event. | | +| failureCode | AcrMgmtEventFailureCode | M | 1 | Identifies the failure reason. | | + +#### 8.6.5.2.8 Type: TargetUeIdentification + +**Table 8.6.5.2.8-1: Definition of type TargetUeIdentification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|-----------------------------------------------------------------------|---------------| +| gps | Gps | O | 0..1 | Represents external UE identifier. | | +| intGrpId | GroupId | O | 0..1 | Represents a group of UEs identified by an Internal Group Identifier. | | +| extGrpId | ExternalGroupId | O | 0..1 | Represents a group of UEs identified by an External Group Identifier. | | +| ueIpAddr | IpAddr | O | 0..1 | Represents the UE IP address. | | + +NOTE: Only one of the above attributes shall be present. + +#### 8.6.5.2.9 Type: UpPathChangeInfo + +**Table 8.6.5.2.9-1: Definition of type UpPathChangeInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|---------------------|---|-------------|------------------------------------------------------------------------------|---------------| +| ueId | IndUeIdentification | M | 1 | Contains the concerned UE's identification information. | | +| dnaiChgType | DnaiChangeType | M | 1 | Identifies the type of notification regarding UP path management event. | | +| sourceTrafficRoute | RouteToLocation | O | 0..1 | Identifies the N6 traffic routing information associated to the source DNAI. | | +| targetTrafficRoute | RouteToLocation | O | 0..1 | Identifies the N6 traffic routing information associated to the target DNAI. | | +| sourceDnai | Dnai | O | 0..1 | Source DN Access Identifier. | | +| targetDnai | Dnai | O | 0..1 | Target DN Access Identifier. | | +| srcUelpv4Addr | Ipv4Addr | O | 0..1 | The IPv4 Address of the served UE for the source DNAI. | | +| srcUelpv6Prefix | Ipv6Prefix | O | 0..1 | The Ipv6 Address Prefix of the served UE for the source DNAI. | | +| tgtUelpv4Addr | Ipv4Addr | O | 0..1 | The IPv4 Address of the served UE for the target DNAI. | | +| tgtUelpv6Prefix | Ipv6Prefix | O | 0..1 | The Ipv6 Address Prefix of the served UE for the target DNAI. | | + +8.6.5.2.10 Type: IndUeIdentification + +**Table 8.6.5.2.10-1: Definition of type IndUeIdentification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|-----------------------------------------------|---------------| +| gpsi | Gpsi | O | 0..1 | Represents the GPSI of the UE. | | +| externalId | ExternalId | O | 0..1 | Represents the External Identifier of the UE. | | +| ueIpAddr | IpAddr | O | 0..1 | Represents the UE IP address. | | + +NOTE: Only one of the above attributes shall be present. + +8.6.5.2.11 Type: AvailabilityNotif + +**Table 8.6.5.2.11-1: Definition of type AvailabilityNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------|---------------| +| availabilityStatus | AvailabilityStatus | M | 1 | Indicates the availability information of user plane path management events monitoring via the 3GPP 5GC network. | | + +8.6.5.2.12 Type: SelectedACRScenarios + +**Table 8.6.5.2.12-1: Definition of type SelectedACRScenarios** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| acrList | array(ACRScenario) | M | 0..N | Indicates the list of selected ACR scenario(s) for the combination of AC (identified by the "acld" attribute) and UE (identified by the "ueId" attribute).

If no ACR scenario applies, an empty array is provided within this attribute. | | +| acld | string | M | 1 | The identifier of the AC for which the selected ACR scenario(s) provided within the "acrList" attribute apply. | | +| ueId | Gpsi | M | 1 | Represents identifier of the UE for which the selected ACR scenario(s) provided within the "acrList" attribute apply. | | + +8.6.5.2.13 Type: ACRParameters + +**Table 8.6.5.2.13-1: Definition of type ACRParameters** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------|---------------| +| predictExpTime | DateTime | O | 0..1 | The estimated time at which the UE may reach the Predicted/Expected UE location or EAS service area at the latest. | | + +## 8.6.5.2.14 Type: TrafficFilterInfo + +Table 8.6.5.2.14-1: Definition of type TrafficFilterInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ipFlows | array(string) | C | 1..N | Represents a 3-tuple with protocol, server ip and server port for UL/DL application traffic. The content of the string has the same encoding as the IPFilterRule AVP value as defined in IETF RFC 6733 [25].

(NOTE) | | +| urls | array(string) | C | 1..N | Indicates URL(s) matching criteria.

(NOTE) | | +| domainNames | array(string) | C | 1..N | Indicates domain name(s) matching criteria.

(NOTE) | | +| dnProtocol | DomainNameProtocol | C | 0..1 | Indicates the additional protocol and protocol field for domain names to be matched.

This attribute may only be provided when "domainNames" attribute is present. | | + +NOTE: At least one of these attributes shall be present. If more than one of these attributes are present, the traffic flow is matched only when every provided attribute has a matching value. + +## 8.6.5.2.15 Type: EasAckInformation + +Table 8.6.5.2.15-1: Definition of type EasAckInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|---------------------------------------------------|---------------| +| resCode | ResultCode | M | 1 | Indicates the acceptance or rejection of the ACT. | | + +## 8.6.5.2.16 Type: EasInBundleInfo + +Table 8.6.5.2.16-1: Definition of type EasInBundleInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| easId | string | O | 0..1 | Contains the identifier of the EAS that is within an EAS bundle. | | +| dnais | array(Dnai) | O | 1..N | Contains the List of DNAI(s) associated with the EAS. | | +| svcArea | ServiceArea | O | 0..1 | Contains the list of geographical and/or topological area(s) that the EAS serves. | | + +## 8.6.5.3 Simple data types and enumerations + +## 8.6.5.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 8.6.5.3.2 Simple data types + +The simple data types defined in table 8.6.5.3.2-1 shall be supported. + +**Table 8.6.5.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 8.6.5.3.3 Enumeration: AcrMgmtEvent + +**Table 8.6.5.3.3-1: Enumeration AcrMgmtEvent** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------|---------------| +| UP_PATH_CHG | Indicates that the ACR Management Event is user plane path change. | | +| ACR_MONITORING | Indicates that the ACR Management Event is ACR monitoring. | | +| ACR_FACILITATION | Indicates that the ACR Management Event is ACR facilitation. | | +| ACT_START_STOP | Indicates that the ACR Management Event is ACT start/stop. | | +| ACR_SELECTION | Indicates that the ACR Management Event is ACR selection. | EdgeApp_2 | + +## 8.6.5.3.4 Enumeration: AcrMgmtEventFilter + +**Table 8.6.5.3.4-1: Enumeration AcrMgmtEventFilter** + +| Enumeration value | Description | Applicability | +|--------------------|-----------------------------------------------------------------------|---------------| +| INTRA_EDN_MOBILITY | Indicates that the ACR Management Event filter is intra-EDN mobility. | | +| INTER_EDN_MOBILITY | Indicates that the ACR Management Event filter is inter-EDN mobility. | | + +## 8.6.5.3.5 Enumeration: ActStatus + +**Table 8.6.5.3.5-1: Enumeration ActStatus** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------|---------------| +| ACT_START | Indicates ACT start. | | +| ACT_STOP | Indicates ACT stop. | | + +## 8.6.5.3.6 Enumeration: AcrMgmtEventFailureCode + +**Table 8.6.5.3.6-1: Enumeration AcrMgmtEventFailureCode** + +| Enumeration value | Description | Applicability | +|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| 3GPP_UP_PATH_CHANGE_MON_NOT_AVAILABLE | Indicates that the ACR Management Event Subscription failed because user plane path management event notifications from the 3GPP network is NOT available.

This value is only applicable for the "UP_PATH_CHG", "ACR_MONITORING" and "ACR_FACILITATION" events. | | +| OTHER_REASONS | Indicates that the ACR Management Event Subscription failed for other reasons.

This value is applicable for all events. | | + +#### 8.6.5.3.7 Enumeration: AvailabilityStatus + +**Table 8.6.5.3.7-1: Enumeration AvailabilityStatus** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------|---------------| +| AVAILABLE | Indicates availability. | | +| NOT_AVAILABLE | Indicates unavailability. | | + +#### 8.6.5.3.8 Enumeration: ResultCode + +**Table 8.6.5.3.8-1: Enumeration ResultCode** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------|---------------| +| ACCEPTED | Indicates acceptance of the ACT. | | +| REJECTED | Indicates rejection of the ACT. | | + +### 8.6.6 Error Handling + +#### 8.6.6.1 General + +For the Eees\_ACRManagementEvent API, HTTP error handling shall be supported as specified in clause 7.7. In addition, the requirements in the following clauses are applicable for the Eees\_ACRManagementEvent API. + +#### 8.6.6.2 Protocol Errors + +No specific protocol errors for the Eees\_ACRManagementEvent API are specified. + +#### 8.6.6.3 Application Errors + +The application errors defined for the Eees\_ACRManagementEvent API are listed in Table 8.6.6.3-1. + +**Table 8.6.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|------------------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PFD_MNGT_NOT_SUPPORTED | 403 Forbidden | Indicates that the ACR Management Events Subscription creation/update is rejected because PFD Management is needed to fulfill the request but it is not supported by the 3GPP network. | + +### 8.6.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.6.7-1 lists the supported features for Eees\_ACRManagementEvent API. + +**Table 8.6.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_test_event | Testing of notification connection is supported according to clause 7.6. | +| 2 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 7.6. This feature requires that the Notification_test_event feature is also supported. | +| 3 | EdgeApp_2 | This feature indicates the support of the enhancements to the Edge Applications. Within this feature the following enhancements are covered:
  • - Support of ACR selection event reporting.
  • - Support of additional ACT start/stop event related information.
  • - Support of service continuity planning support indication.
  • - Support of EAS acknowledgement for service continuity planning.
  • - Support of EAS bundle information reporting.
| + +## 8.7 Eees\_EECContextRelocation API + +### 8.7.1 API URI + +The Eees\_EECContextRelocation service shall use the Eees\_EECContextRelocation API. + +The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "ees-eecontextreloc". +- The shall be "v1". +- The shall be set as described in clause 8.7.2. + +### 8.7.2 Resources + +#### 8.7.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.7.2.1-1 depicts the resource URIs structure for the Eees\_EECContextRelocation API. + +![Diagram showing the Resource URI structure for the Eees_EECContextRelocation API. The root URI is {apiRoot}/ees-eecontextreloc/, which branches to the resource URI /eec-contexts.](33a69b428f4353e782c54a7aaa4eb260_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ees-eecontextreloc/"] --> Resource["/eec-contexts"] + +``` + +Diagram showing the Resource URI structure for the Eees\_EECContextRelocation API. The root URI is {apiRoot}/ees-eecontextreloc/, which branches to the resource URI /eec-contexts. + +**Figure 8.7.2.1-1: Resource URI structure of the Eees\_EECContextRelocation API** + +Table 8.7.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.7.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------|---------------|---------------------------------|-----------------------------------------------------------------------------------| +| Collection of EEC contexts | /eec-contexts | GET | Retrieve the EEC Context information from a service consumer (e.g., S-EES or CES) | +| | | POST | Push the EEC Context information to the T-EES. | + +## 8.7.2.2 Resource: Collection of EEC Contexts + +### 8.7.2.2.1 Description + +This resource allows to transfer the EEC Context from an service consumer (e.g. S-EES or CES) to the T-EES, for EEC context relocation. + +### 8.7.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ees-eecontextreloc//eec-contexts + +This resource shall support the resource URI variables defined in the table 8.7.2.2.2-1. + +**Table 8.7.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 8.7.2.2.3 Resource Standard Methods + +#### 8.7.2.2.3.1 GET + +This method allows a T-EES to pull the EEC Context from the service consumer (e.g. S-EES or CES as specified in 3GPP TS 23.558 [2], based on the information in the discovery filters. This method shall support the URI query parameters specified in table 8.7.2.2.3.1-1. + +**Table 8.7.2.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------------|---|-------------|-----------------------------------------------------------------| +| ees-id | string | M | 1 | The identifier of the requesting EES (T-EES). | +| eec-cntx-id | string | M | 1 | Unique identifier of the EEC Context to authorize the transfer. | +| sess-cntxs | SessionContexts | O | 0..1 | List of service session context information being requested. | + +This method shall support the request data structures specified in table 8.7.2.2.3.1-2 and the response data structures and response codes specified in table 8.7.2.2.3.1-3. + +**Table 8.7.2.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.7.2.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------| +| EEContext | M | 1 | 200 OK | The EEC context information matching the input parameters in the request is returned by the service consumer (e.g. S-EES or CES). | +| NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. | | | | | + +#### 8.7.2.2.3.2 POST + +This method allows the service consumer (e.g. S-EES, CES) to transfer the EEC Context to T-EES to relocate the EEC Context, as specified in 3GPP TS 23.558 [2]. This method shall support the URI query parameters specified in table 8.7.2.2.3.2-1. + +**Table 8.7.2.2.3.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.7.2.2.3.2-2 and the response data structures and response codes specified in table 8.7.2.2.3.2-3. + +**Table 8.7.2.2.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|----------------------------------------------------------------------| +| EEContextPush | M | 1 | EEC Context information of an EEC available at the service consumer. | + +**Table 8.7.2.2.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The EEC context has been successfully transferred to the T-EES. | +| EEContextPush Res | M | 1 | 200 OK | The EEC context has been successfully transferred to the T-EES and the EEC is implicitly registered. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. | | | | | + +#### 8.7.2.2.4 Resource Custom Operations + +None. + +### 8.7.3 Custom Operations without associated resources + +None. + +### 8.7.4 Notifications + +None. + +## 8.7.5 Data Model + +### 8.7.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API + +Table 8.7.5.1-1 specifies the data types defined specifically for the Eees\_EEContextRelocation API service. + +**Table 8.7.5.1-1: Eees\_EEContextRelocation API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------------------|-----------------|------------------------------------------------------------------------------------|---------------| +| EEContext | 8.7.5.2.5 | To represent the EEC context information to be relocated. | | +| EEContextPush | 8.7.5.2.4 | To represent the EEC context information to be pushed to the T-EES. | | +| EEContextPushRes | 8.7.5.2.6 | Represents the EEC context push relocation response. | | +| EECSrvContinuitySupport | 8.7.5.2.8 | Represents the EEC service continuity support and the supported ACR scenarios. | | +| ImplicitRegDetails | 8.7.5.2.7 | Represents the EEC implicit registration information. | | +| IndividualSessionContext | 8.7.5.2.3 | To represent single Service session context information. | | +| SessionContexts | 8.7.5.2.2 | To represent the Service session contexts information in EEC context pull request. | | + +Table 8.7.5.1-2 specifies data types re-used by the Eees\_EEContextRelocation API service. + +**Table 8.7.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------|---------------------|-------------------------------------------------------------------------------------------|---------------| +| EndPoint | 8.1.5.2.5 | To represent the end point information of the EAS in service session context information. | | +| ACProfile | 3GPP TS 24.558 [14] | Used to represent the application clients profiles in EEC context. | | +| ACRScenario | 9.1.5.3.3 | Represents the ACR scenarios. | EdgeApp_2 | +| EndPoint | 8.1.5.2.5 | Represents the end point information. | EdgeApp_2 | +| Gpsi | 3GPP TS 29.571 [8] | Used to indicate the identifier of the UE. | | +| LocationArea5G | 3GPP TS 29.122 [6] | Used to indicate the location information of the UE in the EEC context. | | +| DateTime | 3GPP TS 29.122 [6] | To indicate the expiry time of the implicit registration. | | + +### 8.7.5.2 Structured data types + +#### 8.7.5.2.1 Introduction + +The data type for the Eees\_EEContextRelocation API are defined in the clauses below. + +## 8.7.5.2.2 Type: SessionContexts + +Table 8.7.5.2.2-1: Definition of type SessionContexts + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------------|---|-------------|----------------------------------------------|---------------| +| sessCntxs | array(IndividualSessionContext) | M | 1..N | List of service session context information. | | + +## 8.7.5.2.3 Type: IndividualSessionContext + +Table 8.7.5.2.3-1: Definition of type IndividualSessionContext + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|--------------------------------------------------------------------------------------------|---------------| +| easId | string | M | 1 | The application identifier of the EAS (e.g. URI, FQDN) providing the application services. | | +| endPt | EndPoint | M | 1 | End point information of the EAS in easId attribute. | | +| acId | string | O | 0..1 | Identifier of the AC for which the service session information is provided. | | +| acrList | array(ACRScenario) | O | 1..N | List of the selected ACR scenarios. | EdgeApp_2 | + +## 8.7.5.2.4 Type: EECContextPush + +Table 8.7.5.2.4-1: Definition of type EECContextPush + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eesId | string | M | 1 | Identifier of the S-EES pushing the EEC context. | | +| eecCntx | EEContext | M | 1 | EEC Context to be relocated to T-EES. | | +| tgtEas | EndPoint | O | 0..1 | Contains the endpoint information of the selected T-EAS. | EdgeApp_2 | +| acrScenariosSelReq | boolean | O | 0..1 | Contains the ACR scenarios selection request.

When set to "true", this attribute indicates to the T-EES to select the ACR scenarios list. When set to "false" or omitted, this attribute indicates to the T-EES that ACR scenarios selection is not needed.

The default value when omitted is "false". | EdgeApp_2 | + +## 8.7.5.2.5 Type: EECContext + +Table 8.7.5.2.5-1: Definition of type EECContext + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eeclD | string | M | 1 | Unique identifier of the EEC | | +| cntxld | string | M | 1 | Unique identifier assigned to the EEC Context | | +| ueId | Gpsi | O | 0..1 | The identifier of the UE hosting the EEC. | | +| e1Subs | array(string) | O | 1..N | List of subscription IDs for the capability exposure for the EEC ID. | | +| ueLoc | LocationArea5G | O | 0..1 | Latest location information of the UE hosting the EEC, that is available at the EES. | | +| acProfs | array(ACProfile) | O | 1..N | List of ACs profiles | | +| sessCntxs | SessionContexts | O | 0..1 | List of associated Service Session Contexts. Each Service Session Context includes information maintained by the EES for the services (involving UE related resources) received from an EAS registered to the EES. | | +| eecSrvContSupport | EECSrvContSupport | O | 0..1 | Represent service continuity support related information. | EdgeApp_2 | +| ueMobSupport | boolean | O | 0..1 | Contains the UE Mobility Support indication.

When set to "true", this attribute indicates that UE Mobility Support is required.
When set to "false" or omitted, this attribute indicates that UE Mobility Support is not required.

The default value when omitted is "false". | EdgeApp_2 | + +## 8.7.5.2.6 Type: EECContextPushRes + +Table 8.7.5.2.6-1: Definition of type EECContextPushRes + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------|--------------------|---|-------------|-----------------------------------------------------------|---------------| +| implReg | ImplicitRegDetails | C | 0..1 | Provides implicit registration details.

(NOTE) | | +| selAcrScenariosList | array(ACRScenario) | O | 1..N | Contains the list of ACR scenarios selected by the T-EES. | EdgeApp_2 | +| NOTE: This attribute shall be included if the T-EES has performed implicit registration of the EEC. | | | | | | + +## 8.7.5.2.7 Type: ImplicitRegDetails + +Table 8.7.5.2.7-1: Definition of type ImplicitRegDetails + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------|---------------| +| regId | string | M | 1 | Represents registration ID of the EEC whose EEC context is pushed | | +| expTime | DateTime | O | 0..1 | Represents the expiration time of the registration. If absent, then it indicates that the registration of the EEC never expires. | | + +### 8.7.5.2.8 Type: EECsrvContinuitySupport + +**Table 8.7.5.2.8-1: Definition of type EECsrvContinuitySupport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| srvContSupp | boolean | M | 1 | This attribute is to indicate EEC service continuity support.

When set to "true", this attribute indicates EEC supports service continuity.

When set to "false", this attribute indicates EEC does not support service continuity.

The default value when omitted is "false". | | +| acrScenarios | array(ACR scenario) | C | 1..N | This attribute indicates the list of ACR scenarios supported by EEC.

This attribute shall be present only when the "srvContSupp" attribute is set to "true". | | + +### 8.7.5.3 Simple data types and enumerations + +None. + +## 8.7.6 Error Handling + +General error responses are defined in clause 7.7. + +## 8.7.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.7.7-1 lists the supported features for Eees\_EECContextRelocation API. + +**Table 8.7.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | EdgeApp_2 | This feature indicates the support of the phase 2 of the definition of EDGE applications support. Within this feature, the following enhancements are covered:
- support the "ACR Selection" event subscription and reporting. | + +# 8.8 Eees\_EELManagedACR API + +## 8.8.1 Introduction + +The Eees\_EELManagedACR service shall use the Eees\_ACRStatusUpdate API. + +The API URI of the Eees\_EELManagedACR API shall be: + +**{apiRoot}
** + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [6], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [6]. +- The shall be "ees-eel-acr". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [6]. + +## 8.8.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [6] shall apply for the Eees\_EELManagedACR API. + +## 8.8.3 Resources + +### 8.8.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.8.3.1-1 depicts the resource URIs structure for the Eees\_EELManagedACR API. + +![A hierarchical diagram showing the structure of resource URIs. The root is {apiRoot}/ees-eel-acr/, which branches to /subscriptions, which in turn branches to /{subscriptionId}.](0bad255f79e25d544189cfab0e84bf3a_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ees-eel-acr/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +A hierarchical diagram showing the structure of resource URIs. The root is {apiRoot}/ees-eel-acr/, which branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 8.8.3.1-1: Resource URIs structure of the Eees\_EELManagedACR API** + +Table 8.8.3.1-1 provides an overview of the resources and applicable HTTP methods for the Eees\_EELManagedACR API. + +**Table 8.8.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------|---------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------| +| ACT Status Subscriptions | /subscriptions | GET | Retrieve all the active ACT Status Subscription resources managed by the EES. | +| | | POST | Request the creation of a subscription to ACT status reporting during an EEL Managed ACR. | +| Individual ACT Status Subscription | /subscriptions/{subscriptionId} | GET | Retrieve an Individual ACT Status Subscription resource identified by the provided subscription identifier. | + +### 8.8.3.2 Resource: ACT Status Subscriptions + +#### 8.8.3.2.1 Description + +This resource represents the collection of ACT Status Subscriptions managed by the EES. + +#### 8.8.3.2.2 Resource Definition + +Resource URI: {apiRoot}/eecs-eel-acr//subscriptions + +This resource shall support the resource URI variables defined in table 8.8.3.2.2-1. + +**Table 8.8.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-----------------------------------------| +| apiRoot | string | See clause 5.2.4 of 3GPP TS 29.122 [6]. | + +#### 8.8.3.2.3 Resource Standard Methods + +The following clauses specify the standard methods supported by the resource. + +##### 8.8.3.2.3.1 GET + +The GET method allows a service consumer to retrieve all the active ACT Status Subscriptions managed by the EES. This method shall support the URI query parameters specified in table 8.8.3.2.3.1-1. + +**Table 8.8.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 8.8.3.2.3.1-2 and the response data structures and response codes specified in table 8.8.3.2.3.1-3. + +**Table 8.8.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.8.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(ACTStatusSubscriptions) | M | 0..N | 200 OK | Successful case. All the active ACT Status Subscriptions managed by the EES are returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. | | | | | + +**Table 8.8.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.8.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +#### 8.8.3.2.3.2 POST + +The POST method allows a service consumer (i.e. T-EAS) to request the creation of a subscription to ACT status reporting at the EES (i.e. T-EES). This method shall support the URI query parameters specified in table 8.8.3.2.3.2-1. + +**Table 8.8.3.2.3.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 8.8.3.2.3.2-2 and the response data structures and response codes specified in table 8.8.3.2.3.2-3. + +**Table 8.8.3.2.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|----------------------------------------------------------------------------------------------| +| ACTStatusSubsc | M | 1 | Represents the parameters to request the creation of a subscription to ACT status reporting. | + +**Table 8.8.3.2.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ACTStatusSubsc | M | 1 | 201 Created |

Successful case. The subscription is successfully created and a representation of the created Individual ACT Status Subscription resource is returned.

An HTTP "Location" header that contains the resource URI of the created Individual ACT Status Subscription resource shall also be included.

| +| NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. | | | | | + +**Table 8.8.3.2.3.2-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/eecs-eel-act//subscriptions/{subscriptionId} | + +#### 8.8.3.2.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +### 8.8.3.3 Resource: Individual ACT Status Subscription + +#### 8.8.3.3.1 Description + +This resource represents an Individual ACT Status subscription managed by the EES. + +#### 8.8.3.3.2 Resource Definition + +Resource URI: {apiRoot}/eees-eel-acr//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 8.8.3.3.2-1. + +**Table 8.8.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|-----------------------------------------| +| apiRoot | string | See clause 5.2.4 of 3GPP TS 29.122 [6]. | +| subscriptionId | string | Represents the subscription identifier. | + +#### 8.8.3.3.3 Resource Standard Methods + +The following clauses specify the standard methods supported by the resource. + +##### 8.8.3.3.3.1 GET + +The GET method allows a service consumer to retrieve an ACT status subscription identified by the subscription identifier included in the request URI (i.e. within the "{subscriptionId}" path segment). This method shall support the URI query parameters specified in table 8.8.3.3.3.1-1. + +**Table 8.8.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 8.8.3.3.3.1-2 and the response data structures and response codes specified in table 8.8.3.3.3.1-3. + +**Table 8.8.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.8.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ACTStatusSubsc | M | 1 | 200 OK | Successful case. The requested Individual ACT Status Subscription resource is returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative EES. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. | | | | | + +**Table 8.8.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +**Table 8.8.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative EES. | + +### 8.8.3.3.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +## 8.8.4 Custom Operations without associated resources + +### 8.8.4.1 Overview + +The structure of the custom operation URIs of the Eees\_EELManagedACR API is shown in Figure 8.8.4.1-1. + +![Diagram showing the custom operation URI structure. A box contains '{apiRoot}/ees-eel-acr/{apiVersion}' and a dashed box contains '/request-eelacr', with a line connecting them to indicate the full URI path.](f19a4dced8649e66cfd4d71fff6463d4_img.jpg) + +``` + +graph TD + A["{apiRoot}/ees-eel-acr/{apiVersion}"] --- B["/request-eelacr"] + style B stroke-dasharray: 5 5 + +``` + +Diagram showing the custom operation URI structure. A box contains '{apiRoot}/ees-eel-acr/{apiVersion}' and a dashed box contains '/request-eelacr', with a line connecting them to indicate the full URI path. + +**Figure 8.8.4.1-1: Custom operation URI structure of the Eees\_EELManagedACR API** + +Table 8.8.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the Eees\_EELManagedACR API. + +**Table 8.8.4.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------------|----------------------|--------------------|-----------------------------------------------------------------------------------------------------------------| +| RequestEELManagedACR | /request-eelacr | POST | Enables a service consumer (i.e. S-EAS) to request the EES (i.e. S-EES) to handle all the operations of an ACR. | + +### 8.8.4.2 Operation: RequestEELManagedACR + +#### 8.8.4.2.1 Description + +The custom operation enables a service consumer (i.e. S-EAS) to request the EES (i.e. S-EES) to handle all the operations of an ACR. + +### 8.8.4.2.2 Operation Definition + +This operation shall support the request data structures and the response data structures and response codes specified in tables 8.8.4.2.2-1 and 8.8.4.2.2-2. + +**Table 8.8.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|------------------------------------------------------------------------------------| +| EELACRReq | M | 1 | Parameters to request the EES (i.e. S-EES) to handle all the operations of an ACR. | + +**Table 8.8.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EELACRResp | M | 1 | 200 OK | The requested EEL Managed ACR initiation was successfully received and processed.
The response body contains the feedback of the EES. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the HTTP POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.8.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative EES. | + +**Table 8.8.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative EES. | + +## 8.8.5 Notifications + +### 8.8.5.1 General + +Notifications shall comply to clause 5.2.5 of 3GPP TS 29.122 [6]. + +**Table 8.8.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------------|------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| ACT Status Notification | {notificationUri}/act-status | act-status (POST) | This service operation enables an EES to notify a previously subscribed a service consumer (i.e. EAS) on ACT status information. | + +## 8.8.5.2 ACT Status Notification + +### 8.8.5.2.1 Description + +The ACT Status Notification is used by an EES to notify a previously subscribed service consumer (i.e. EAS) on ACT status information. + +### 8.8.5.2.2 Target URI + +The Callback URI "{notificationUri}/act-status" shall be used with the callback URI variables defined in table 8.8.5.2.2-1. + +**Table 8.8.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------| +| notificationUri | Uri | String formatted as a URI containing the Callback URI. | + +### 8.8.5.2.3 Standard Methods + +#### 8.8.5.2.3.1 POST + +This method shall support the request data structures specified in table 8.8.5.2.3.1-1 and the response data structures and response codes specified in table 8.8.5.2.3.1-2. + +**Table 8.8.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|----------------------------------------| +| ACTStatusNotif | M | 1 | Represents an ACT status notification. | + +**Table 8.8.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The ACT status notification is successfully received and acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EAS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.8.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +**Table 8.8.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative EAS towards which the notification should be redirected. | + +## 8.8.6 Data Model + +### 8.8.6.1 General + +This clause specifies the application data model supported by the API. + +Table 8.8.6.1-1 specifies the data types defined for the Eees\_EELManagedACR API. + +**Table 8.8.6.1-1: Eees\_EELManagedACR API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------|----------------|---------------------------------------------------------------------------------------------------|---------------| +| EELACRReq | 8.8.6.2.2 | Represents the parameters to request the EES (e.g. S-EES) to handle all the operations of an ACR. | | +| EELACRResp | 8.8.6.2.3 | Represents the feedback of the EES on EEL Managed ACR request. | | +| ACTStatusSubsc | 8.8.6.2.4 | Represents the parameters to request the creation of a subscription to ACT status reporting. | | +| ACTStatusNotif | 8.8.6.2.5 | Represents an ACT status notification. | | + +Table 8.8.6.1-2 specifies data types re-used by the Eees\_EELManagedACR API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Eees\_EELManagedACR API. + +**Table 8.8.6.1-2: Eees\_EELManagedACR API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|--------------------|---------------------|---------------------------------------------------------------|---------------| +| ACTResult | Clause 8.11.6.3.3 | Represents the result of ACT. | | +| EasCharacteristics | 3GPP TS 24.558 [14] | Represents the EAS characteristics. | | +| Gpsi | 3GPP TS 29.571 [8] | Represents the identifier of a UE. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of the optional features. | | +| Uri | 3GPP TS 29.122 [6] | Represents a URI. | | + +### 8.8.6.2 Structured data types + +#### 8.8.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 8.8.6.2.2 Type: EELACRReq + +Table 8.8.6.2.2-1: Definition of type EELACRReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueId | Gpsi | M | 1 | Contains the UE identifier in the form of a GPSI. | | +| easCharacs | array(EasCharacteristics) | M | 1 | Contains a set of EAS characteristics to be used to determine the required EASs. | | +| appCtxtStoreAddr | Uri | O | 0..1 | Contains the URI via which the Application Context can be accessed for ACT. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 8.8.8.

This parameter shall be provided if at least one feature is supported by the EAS. | | + +## 8.8.6.2.3 Type: EELACRResp + +Table 8.8.6.2.3-1: Definition of type EELACRResp + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appCtxtStoreAddr | Uri | C | 0..1 | Contains the URI via which the Application Context can be accessed for ACT.

This attribute shall be included if it was not received from the EAS in the related EEL Managed ACR request. | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.

This parameter shall be provided by the EES in the response to a request in which the EAS provided the list of features that it supports. | | + +## 8.8.6.2.4 Type: ACTStatusSubsc + +Table 8.8.6.2.4-1: Definition of type ACTStatusSubsc + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| easId | string | M | 1 | Contains the application identifier of the EAS (e.g. URI, FQDN). | | +| notificationUri | Uri | M | 1 | Contains the URI via which the EAS desires to receive ACT status notifications. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 8.8.8.

This parameter shall be provided if at least one feature is supported by the EAS. | | + +## 8.8.6.2.5 Type: ACTStatusNotif + +Table 8.8.6.2.5-1: Definition of type ACTStatusNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------|---------------| +| subscriptionId | string | M | 1 | Subscription identifier. | | +| actStatus | ACTResult | M | 1 | Contains the reported ACT status. | | + +### 8.8.6.3 Simple data types and enumerations + +#### 8.8.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 8.8.6.3.2 Simple data types + +The simple data types defined in table 8.8.6.3.2-1 shall be supported. + +**Table 8.8.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +### 8.8.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +### 8.8.6.5 Binary data + +#### 8.8.6.5.1 Binary Data Types + +**Table 8.8.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +## 8.8.7 Error Handling + +### 8.8.7.1 General + +For the Eees\_EELManagedACR API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [6]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [6] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [6]. + +In addition, the requirements in the following clauses are applicable for the Eees\_EELManagedACR API. + +### 8.8.7.2 Protocol Errors + +No specific protocol errors for the Eees\_EELManagedACR API are specified. + +### 8.8.7.3 Application Errors + +The application errors defined for the Eees\_EELManagedACR API are listed in Table 8.8.7.3-1. + +**Table 8.8.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 8.8.8 Feature negotiation + +The optional features in table 8.8.8-1 are defined for the Eees\_EELManagedACR API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [6]. + +**Table 8.8.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 8.9 Eees\_ACRStatusUpdate API + +### 8.9.1 Introduction + +The Eees\_ACRStatusUpdate service shall use the Eees\_ACRStatusUpdate API. + +The API URI of the Eees\_ACRStatusUpdate API shall be: + +**{apiRoot}
/** + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [6], i.e.: + +**{apiRoot}
//** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [6]. +- The shall be "ees-acrstatus-update". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [6]. + +### 8.9.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [6] shall apply for the Eees\_ACRStatusUpdate API. + +### 8.9.3 Resources + +There are no resources defined for this API in this release of the specification. + +### 8.9.4 Custom Operations without associated resources + +#### 8.9.4.1 Overview + +The structure of the custom operation URIs of the Eees\_ACRStatusUpdate API is shown in Figure 8.9.4.1-1. + +![Diagram showing the custom operation URI structure. A box contains {apiRoot}/ees-acrstatus-update/. A line connects this box to another box containing /request-acrupdate, which is enclosed in a dashed border.](dfd09f348b50c9255f3cfe67985db9bc_img.jpg) + +``` + +graph TD + A["{apiRoot}/ees-acrstatus-update/"] --> B["/request-acrupdate"] + style B stroke-dasharray: 5 5 + +``` + +Diagram showing the custom operation URI structure. A box contains {apiRoot}/ees-acrstatus-update/. A line connects this box to another box containing /request-acrupdate, which is enclosed in a dashed border. + +**Figure 8.9.4.1-1: Custom operation URI structure of the Eees\_ACRStatusUpdate API** + +Table 8.9.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the Eees\_ACRStatusUpdate API. + +**Table 8.9.4.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|------------------|----------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RequestACRUpdate | /request-acrupdate | POST | Enables a service consumer (i.e. S-EAS or T-EAS) to update the information related to ACR (e.g. indicate the status of ACT, update the notification target address) at the EES. | + +## 8.9.4.2 Operation: RequestACRUpdate + +### 8.9.4.2.1 Description + +The custom operation enables a service consumer (i.e. S-EAS or T-EAS) to update the information related to ACR (e.g. indicate the status of ACT, update the notification target address) at the EES. + +### 8.9.4.2.2 Operation Definition + +This operation shall support the request data structures and the response data structures and response codes specified in tables 8.9.4.2.2-1 and 8.9.4.2.2-2. + +**Table 8.9.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------| +| ACRUpdateData | M | 1 | Parameters to update the information related to ACR (e.g. indicate the status of ACT, update the notification target address). | + +**Table 8.9.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ACRDataStatus | M | 1 | 200 OK | The communicated ACR update information was successfully received.
The response body contains the feedback of the EES. | +| n/a | | | 204 No Content | The communicated ACR update information was successfully received. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| NOTE: The mandatory HTTP error status code for the HTTP POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. | | | | | + +**Table 8.9.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative EES. | + +**Table 8.9.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative EES. | + +## 8.9.5 Notifications + +There are no notifications defined for this API in this release of the specification. + +## 8.9.6 Data Model + +### 8.9.6.1 General + +This clause specifies the application data model supported by the API. + +Table 8.9.6.1-1 specifies the data types defined for the Eees\_ACRStatusUpdate API. + +**Table 8.9.6.1-1: Eees\_ACRStatusUpdate API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ACRUpdateData | 8.9.6.2.2 | Represents the parameters to update the information related to ACR (e.g. indicate the status of ACT, update the notification target address). | | +| ACRDataStatus | 8.9.6.2.3 | Represents the ACR status information. | | +| ACTFailureCause | 8.9.6.3.5 | Represents the cause of ACT failure. | | +| ACTResult | 8.9.6.3.3 | Represents the result of ACT. | | +| ACTResultInfo | 8.9.6.2.4 | Represents the result of ACT and the related information. | | +| E3SubscsStatus | 8.9.6.3.4 | Represents the status of the initialization of EDGE-3 subscriptions. | | + +Table 8.9.6.1-2 specifies data types re-used by the Eees\_ACRStatusUpdate API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Eees\_ACRStatusUpdate API. + +**Table 8.9.6.1-2: Eees\_ACRStatusUpdate API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------|--------------------|--------------------------------------|---------------| +| EndPoint | Clause 8.1.5.2.5 | Represents the endpoint information. | | +| Gpsi | 3GPP TS 29.571 [8] | Represents the identifier of a UE. | | +| Uri | 3GPP TS 29.122 [6] | Represents a URI. | | + +## 8.9.6.2 Structured data types + +### 8.9.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 8.9.6.2.2 Type: ACUpdateData + +**Table 8.9.6.2.2-1: Definition of type ACUpdateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| easId | string | M | 1 | Contains the application identifier of the EAS (e.g. URI, FQDN) that is sending the ACR status update request. | | +| acId | string | O | 0..1 | Contains the identifier of the concerned AC. | | +| actResultInfo | ACTResultInfo | O | 0..1 | Contains the status of ACT, i.e. whether it was successful or failed, and the related information.

This attribute may be included if the service consumer is the S-EAS or the T-EAS. In the case of an EEL Managed ACR, this attribute shall not be included by a T-EAS acting as the service consumer.

(NOTE) | | +| e3SubsIds | array(string) | O | 1..N | Contains a list of EDGE-3 subscription identifiers.

This attribute may be included only if the service consumer sending the request is the T-EAS.

(NOTE) | | +| e3NotificationUri | Uri | O | 0..1 | Contains the updated notification URI via which the EAS desires to receive notifications (related to EDGE-3 subscriptions) from the EES.

This attribute may be included only if the service consumer sending the request is the T-EAS.

(NOTE) | | +| NOTE: At least one of the "actResultInfo", "e3SubsIds" or "e3NotificationUri" attributes shall be present. | | | | | | + +## 8.9.6.2.3 Type: ACRDataStatus + +Table 8.9.6.2.3-1: Definition of type ACRDataStatus + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| e3SubscsStatus | E3SubscsStatus | M | 1 | Contains the status of the initialization of EDGE-3 subscriptions, i.e. whether it was successful or failed. | | +| e3Subsclds | array(string) | O | 1..N | Contains an updated list of EDGE-3 subscription identifiers. The absence of a subscription identifier implies no change for this subscription identifier.

This attribute may be provided if the "e3SubscsStatus" attribute is set to "SUCCESSFUL". | | + +## 8.9.6.2.4 Type: ACTResultInfo + +Table 8.9.6.2.4-1: Definition of type ACTResultInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------|---------------| +| actResult | ACTResult | M | 1 | Contains the status of ACT, i.e. whether it was successful or failed. | | +| actFailureCause | ACTFailureCause | C | 0..1 | Contains the cause of ACT failure.

This attribute shall be provided only if the "actResult" attribute is set to "FAILED". | | +| ueId | Gpsi | M | 1 | Contains the identifier of the concerned UE. | | +| easEndPoint | EndPoint | M | 1 | Contains the endpoint of the other EAS to or from which the ACT was performed. | | + +## 8.9.6.3 Simple data types and enumerations + +## 8.9.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 8.9.6.3.2 Simple data types + +The simple data types defined in table 8.9.6.3.2-1 shall be supported. + +Table 8.9.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 8.9.6.3.3 Enumeration: ACTResult + +The enumeration ACTResult represents the result of ACT. It shall comply with the provisions defined in table 8.9.6.3.3-1. + +Table 8.9.6.3.3-1: Enumeration ACTResult + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------|---------------| +| SUCCESSFUL | Indicates that the ACT was successful. | | +| FAILED | Indicates that the ACT failed. | | + +#### 8.9.6.3.4 Enumeration: E3SubscsStatus + +The enumeration E3SubscsStatus represents the status of the initialization of EDGE-3 subscriptions. It shall comply with the provisions defined in table 8.9.6.3.4-1. + +**Table 8.9.6.3.4-1: Enumeration E3SubscsStatus** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------|---------------| +| SUCCESSFUL | Indicates that the initialization of EDGE-3 subscriptions was successful. | | +| FAILED | Indicates that the initialization of EDGE-3 subscriptions failed. | | + +#### 8.9.6.3.5 Enumeration: ACTFailureCause + +The enumeration ACTFailureCause represents the cause of ACT failure. It shall comply with the provisions defined in table 8.9.6.3.5-1. + +**Table 8.9.6.3.5-1: Enumeration ACTFailureCause** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------|---------------| +| ACR_CANCELLATION | Indicates that the ACT failed due to the cancellation of the ACR. | | +| OTHER | Indicates that the ACT failed for other reasons. | | + +#### 8.9.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +#### 8.9.6.5 Binary data + +##### 8.9.6.5.1 Binary Data Types + +**Table 8.9.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +### 8.9.7 Error Handling + +#### 8.9.7.1 General + +For the Eees\_ACRStatusUpdate API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [6]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [6] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [6]. + +In addition, the requirements in the following clauses are applicable for the Eees\_ACRStatusUpdate API. + +#### 8.9.7.2 Protocol Errors + +No specific protocol errors for the Eees\_ACRStatusUpdate API are specified. + +#### 8.9.7.3 Application Errors + +The application errors defined for the Eees\_ACRStatusUpdate API are listed in Table 8.9.7.3-1. + +**Table 8.9.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------------|-------------------------|--------------------| +| | | | + +## 8.9.8 Feature negotiation + +The optional features in table 8.9.8-1 are defined for the Eees\_ACRStatusUpdate API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [6]. + +**Table 8.9.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|-----------------------|---------------------|--------------------| +| | | | + +# 8.10 Eees\_ACRParameterInformation API + +## 8.10.1 Introduction + +The Eees\_ACRParameterInformation service shall use the Eees\_ACRParameterInformation API. + +The API URI of the Eees\_ACRParameterInformation API shall be: + +**{apiRoot}
** + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [6], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [6]. +- The shall be "ees-acr-param". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [6]. + +## 8.10.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [6] shall apply for the Eees\_ACRParameterInformation API. + +## 8.10.3 Resources + +There are no resources defined for this API in this release of the specification. + +## 8.10.4 Custom Operations without associated resources + +### 8.10.4.1 Overview + +The structure of the custom operation URIs of the Eees\_ACRParameterInformation API is shown in Figure 8.10.4.1-1. + +![Diagram showing the custom operation URI structure for the Eees_ACRParameterInformation API. A box contains '{apiRoot}/ees-acr-param/'. A line connects this box to a dashed box containing '/send-acrparamsinfo'.](d884367c84ba50f250499f79c4b4b950_img.jpg) + +``` + +graph TD + A["{apiRoot}/ees-acr-param/"] --> B[/send-acrparamsinfo] + style B stroke-dasharray: 5 5 + +``` + +Diagram showing the custom operation URI structure for the Eees\_ACRParameterInformation API. A box contains '{apiRoot}/ees-acr-param/'. A line connects this box to a dashed box containing '/send-acrparamsinfo'. + +**Figure 8.10.4.1-1: Custom operation URI structure of the Eees\_ACRParameterInformation API** + +Table 8.10.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the Eees\_ACRParameterInformation API. + +**Table 8.10.4.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|-----------------------------------------------------------------------------------------------| +| Request | /send-acrparamsinfo | POST | Enables a service consumer (e.g. S-EES, CES) to send ACR parameters information to the T-EES. | + +## 8.10.4.2 Operation: Request + +### 8.10.4.2.1 Description + +The custom operation enables a service consumer (e.g., S-EES, CES) to send ACR parameters information to the T-EES. + +### 8.10.4.2.2 Operation Definition + +This operation shall support the request data structures and the response data structures and response codes specified in tables 8.10.4.2.2-1 and 8.10.4.2.2-2. + +**Table 8.10.4.2.2-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|--------------------------------------------------------------------| +| ACRParamsInfo | M | 1 | Contains the ACR parameters information to be provisioned/updated. | + +**Table 8.10.4.2.2-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|---------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ACRParamsInfo | M | 1 | 200 OK | Successful case. The ACR parameters information is successfully received and the content of these ACR parameters information is returned in the response body. | +| n/a | | | 204 No Content | Successful case. The ACR parameter information is successfully received and no content is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the HTTP POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.10.4.2.2-3: Headers supported by the 307 Response Code** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative target URI located in an alternative EES. | + +**Table 8.10.4.2.2-4: Headers supported by the 308 Response Code** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative target URI located in an alternative EES. | + +## 8.10.5 Notifications + +There are no notifications defined for this API in this release of the specification. + +## 8.10.6 Data Model + +### 8.10.6.1 General + +This clause specifies the application data model supported by the API. + +Table 8.10.6.1-1 specifies the data types defined for the Eees\_ACRParameterInformation API. + +**Table 8.10.6.1-1: Eees\_ACRParameterInformation API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------|----------------|--------------------------------------------|---------------| +| ACRParamsInfo | 8.10.6.2.2 | Represents the ACR parameters information. | | + +Table 8.10.6.1-2 specifies data types re-used by the Eees\_ACRParameterInformation API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Eees\_ACRParameterInformation API. + +**Table 8.10.6.1-2: Eees\_ACRParameterInformation API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------|-------------------|--------------------------------------|---------------| +| ACRParameters | Clause 8.6.5.2.13 | Represents ACR parameters. | | +| EndPoint | Clause 8.1.5.2.5 | Represents the endpoint information. | | + +## 8.10.6.2 Structured data types + +### 8.10.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 8.10.6.2.2 Type: ACRParamsInfo + +**Table 8.10.6.2.2-1: Definition of type ACRParamsInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| eesId | string | M | 1 | Contains the identifier of the service consumer (e.g., S-EES, CES) that is sending the request. | | +| eeclD | string | M | 1 | Contains the identifier of the concerned EEC. | | +| aclD | string | M | 1 | Contains the identifier of the concerned AC. | | +| sEasEndPoint | EndPoint | M | 1 | Contains the endpoint information of the S-EAS. | | +| tEasEndPoint | EndPoint | M | 1 | Contains the endpoint information of the T-EAS. | | +| acrParams | ACRParameters | M | 1 | Contains the ACR Parameters. | | + +## 8.10.6.3 Simple data types and enumerations + +### 8.10.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 8.10.6.3.2 Simple data types + +The simple data types defined in table 8.10.6.3.2-1 shall be supported. + +**Table 8.10.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 8.10.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +## 8.10.6.5 Binary data + +### 8.10.6.5.1 Binary Data Types + +**Table 8.10.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +## 8.10.7 Error Handling + +### 8.10.7.1 General + +For the Eees\_ACRParameterInformation API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [6]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [6] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [6]. + +In addition, the requirements in the following clauses are applicable for the Eees\_ACRParameterInformation API. + +### 8.10.7.2 Protocol Errors + +No specific protocol errors for the Eees\_ACRParameterInformation API are specified. + +### 8.10.7.3 Application Errors + +The application errors defined for the Eees\_ACRParameterInformation API are listed in Table 8.10.7.3-1. + +**Table 8.10.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 8.10.8 Feature negotiation + +The optional features in table 8.10.8-1 are defined for the Eees\_ACRParameterInformation API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [6]. + +**Table 8.10.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 8.11 Eees\_CommonEASAnnouncement API + +### 8.11.1 Introduction + +The Eees\_CommonEASAnnouncement service shall use the Eees\_CommonEASAnnouncement API. + +The API URI of the Eees\_CommonEASAnnouncement API shall be: + +{apiRoot}// + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [6], i.e.: + +{apiRoot}/// + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [6]. +- The shall be "ees-common-eas". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [6]. + +## 8.11.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [6] shall apply for the Eees\_CommonEASAnnouncement API. + +## 8.11.3 Resources + +There are no resources defined for this API in this release of the specification. + +## 8.11.4 Custom Operations without associated resources + +### 8.11.4.1 Overview + +The structure of the custom operation URIs of the Eees\_CommonEASAnnouncement API is shown in Figure 8.11.4.1-1. + +![Diagram showing the custom operation URI structure. A box contains '{apiRoot}/ees-common-eas/'. A line connects this box to a dashed box containing '/announce-common-eas'.](ede4f38e16d526d5b1af095b73d72713_img.jpg) + +``` + +graph TD + A["{apiRoot}/ees-common-eas/"] --> B[/announce-common-eas] + style B stroke-dasharray: 5 5 + +``` + +Diagram showing the custom operation URI structure. A box contains '{apiRoot}/ees-common-eas/'. A line connects this box to a dashed box containing '/announce-common-eas'. + +**Figure 8.11.4.1-1: Custom operation URI structure of the Eees\_CommonEASAnnouncement API** + +Table 8.11.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the Eees\_CommonEASAnnouncement API. + +**Table 8.11.4.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|-------------------------------------------------------------------------------------------------------| +| Declare | /declare | POST | Enables a service consumer (i.e. announcing EES) to send common EAS information to the receiving EES. | + +### 8.11.4.2 Operation: Declare + +#### 8.11.4.2.1 Description + +The custom operation enables a service consumer (i.e. announcing EES) to send common EAS information to the receiving EES. + +#### 8.11.4.2.2 Operation Definition + +This operation shall support the request data structures and the response data structures and response codes specified in tables 8.11.4.2.2-1 and 8.11.4.2.2-2. + +**Table 8.11.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|--------------------------------------------------------| +| CommonEASInfo | M | 1 | Contains the common EAS information that is announced. | + +**Table 8.11.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The common EAS information is successfully received and no content is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative EES.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the HTTP POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8.11.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative target URI located in an alternative EES. | + +**Table 8.11.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative target URI located in an alternative EES. | + +## 8.11.5 Notifications + +There are no notifications defined for this API in this release of the specification. + +## 8.11.6 Data Model + +### 8.11.6.1 General + +This clause specifies the application data model supported by the API. + +Table 8.11.6.1-1 specifies the data types defined for the Eees\_CommonEASAnnouncement API. + +**Table 8.10.6.1-1: Eees\_CommonEASAnnouncement API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------|----------------|----------------------------------------|---------------| +| CommonEASInfo | 8.11.6.2.2 | Represents the common EAS information. | | + +Table 8.11.6.1-2 specifies data types re-used by the Eees\_CommonEASAnnouncement API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Eees\_CommonEASAnnouncement API. + +**Table 8.11.6.1-2: Eees\_CommonEASAnnouncement API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------|-----------|----------------------------------------------------------|---------------| +| EndPoint | 8.1.5.2.5 | To indicate the end point information of the common EAS. | | + +## 8.11.6.2 Structured data types + +### 8.11.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 8.11.6.2.2 Type: CommonEASInfo + +**Table 8.11.6.2.2-1: Definition of type CommonEASInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------|---------------| +| requestorId | string | M | 1 | Contains the identifier of the service consumer (i.e. announcing EES) that is sending the request. | | +| easId | string | M | 1 | Contains the identifier of the selected common EAS. | | +| appGrpId | string | M | 1 | The application group identifier. | | +| endPt | EndPoint | M | 1 | The endpoint information of the selected common EAS. | | + +## 8.11.6.3 Simple data types and enumerations + +### 8.11.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 8.11.6.3.2 Simple data types + +The simple data types defined in table 8.11.6.3.2-1 shall be supported. + +**Table 8.11.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 8.11.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +### 8.11.6.5 Binary data + +#### 8.11.6.5.1 Binary Data Types + +**Table 8.11.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +### 8.11.7 Error Handling + +#### 8.11.7.1 General + +For the Eees\_CommonEASAnnouncement API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [6]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [6] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [6]. + +In addition, the requirements in the following clauses are applicable for the Eees\_CommonEASAnnouncement API. + +#### 8.11.7.2 Protocol Errors + +No specific protocol errors for the Eees\_CommonEASAnnouncement API are specified. + +#### 8.11.7.3 Application Errors + +The application errors defined for the Eees\_CommonEASAnnouncement API are listed in Table 8.11.7.3-1. + +**Table 8.11.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 8.11.8 Feature negotiation + +The optional features in table 8.10.8-1 are defined for the Eees\_CommonEASAnnouncement API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [6]. + +**Table 8.11.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +--- + +## 8A CAS API Definitions + +### 8A.1 Ecas\_SelectedEES API + +#### 8A.1.1 Introduction + +The Ecas\_SelectedEES service shall use the Ecas\_SelectedEES API. + +The API URI of the Ecas\_SelectedEES API shall be: + +{apiRoot}// + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [6], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [6]. +- The shall be "ecas-selected-ees". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [6]. + +NOTE: When 3GPP TS 29.122 [2] is referenced for the common protocol and interface aspects for API definition in the clauses under clause 5, the service producer (i.e. CAS) takes the role of the SCEF and the service consumer (e.g., EES) takes the role of the SCS/AS. + +## 8A.1.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [6] shall apply for the Ecas\_SelectedEES API. + +## 8A.1.3 Resources + +There are no resources defined for this API in this release of the specification. + +## 8A.1.4 Custom Operations without associated resources + +### 8A.1.4.1 Overview + +The structure of the custom operation URIs of the Ecas\_SelectedEES API is shown in Figure 8A.1.4.1-1. + +![Diagram showing the custom operation URI structure. The base URI is {apiRoot}/ecas-selected-ees/. A dashed box labeled /declare is connected to the base URI by a line, indicating it is a custom operation URI.](92171b3c1fa1c46db587486e1a4a260f_img.jpg) + +The diagram illustrates the URI structure for custom operations. It shows the base path `{apiRoot}/ecas-selected-ees/`. A dashed rectangular box containing the text `/declare` is connected to the base path by a line, indicating that this specific path is a custom operation URI. + +Diagram showing the custom operation URI structure. The base URI is {apiRoot}/ecas-selected-ees/. A dashed box labeled /declare is connected to the base URI by a line, indicating it is a custom operation URI. + +**Figure 8A.1.4.1-1: Custom operation URI structure of the Ecas\_SelectedEES API** + +Table 8A.1.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the Ecas\_SelectedEES API. + +**Table 8A.1.4.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|-------------------------------------------------------------------------------------------------| +| Declare | /declare | POST | Enables the service consumer (e.g. EES) to declare the selected target EES related information. | + +## 8A.1.4.2 Operation: Declare + +### 8A.1.4.2.1 Description + +The custom operation enables the service consumer (e.g.; EES) to inform the selected EES to the CAS during the ACR from EAS to CAS. + +### 8A.1.4.2.2 Operation Definition + +This operation shall support the request data structures and the response data structures and response codes specified in tables 8A.1.4.2.2-1 and 8A.1.4.2.2-2. + +**Table 8A.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|---------------------------------------------------------------------------------| +| SeIEESDeclInfo | M | 1 | Contains the parameters to declare the selected target EES related information. | + +**Table 8A.1.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The selected EES declaration request is successfully received. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative CAS. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative CAS. Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the HTTP POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 8A.1.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative CAS. | + +**Table 8A.1.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------| +| Location | string | M | 1 | An alternative target URI located in an alternative CAS. | + +## 8A.1.5 Notifications + +There are no notifications defined for this API in this release of the specification. + +## 8A.1.6 Data Model + +### 8A.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 8A.1.6.1-1 specifies the data types defined for the Ecas\_SelectedEES API. + +**Table 8A.1.6.1-1: Ecas\_SelectedEES API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------|----------------|--------------------------------------------------------|---------------| +| SelEESDeclInfo | 8A.1.6.2.2 | Represent the selected target EES related information. | | + +Table 8A.1.6.1-2 specifies data types re-used by the Ecas\_SelectedEES API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Ecas\_SelectedEES API. + +**Table 8A.1.6.1-2: Ecas\_SelectedEES API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|--------------------|--------------------------------------|---------------| +| EndPoint | Clause 8.1.5.2.5 | Represents the endpoint information. | | +| Gpsi | 3GPP TS 29.571 [8] | Used to identify the UE with GPSI. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Indicates the features supported. | | + +## 8A.1.6.2 Structured data types + +### 8A.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 8A.1.6.2.2 Type: SelEESDeclInfo + +**Table 8A.1.6.2.2-1: Definition of type SelEESDeclInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------|---------------| +| ueId | Gpsi | M | 1 | Contains the identifier of the UE. | | +| seleEesId | string | M | 1 | Contains the identifier of the selected EES. | | +| seleEesEndPoint | EndPoint | M | 1 | Contains Endpoint information (e.g. URI, FQDN, IP address) used to communicate with the selected EES. | | +| easId | string | M | 1 | Contains the identifier of the concerned EAS. | | +| acId | string | O | 0..1 | Contains the identifier of the concerned AC. | | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of the optional features if applicable. | | + +## 8A.1.6.3 Simple data types and enumerations + +None, + +## 8A.1.7 Error Handling + +### 8A.1.7.1 General + +For the Ecas\_SelectedEES API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [6]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [6] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [6]. + +In addition, the requirements in the following clauses are applicable for the Ecas\_SelectedEES API. + +### 8A.1.7.2 Protocol Errors + +No specific protocol errors for the Ecas\_SelectedEES API are specified. + +### 8A.1.7.3 Application Errors + +The application errors defined for the Ecas\_SelectedEES API are listed in Table 8A.1.7.3-1. + +**Table 8A.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 8A.1.8 Feature negotiation + +The optional features in table 8A.1.8-1 are defined for the Ecas\_SelectedEES API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [6]. + +**Table 8A.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 9 Edge Configuration Server API Definitions + +### 9.1 Eecs\_EESRegistration API + +#### 9.1.1 Introduction + +The Eecs\_EESRegistration service shall use the Eecs\_EESRegistration API. + +The API URI of the Eecs\_EESRegistration API shall be: + +**{apiRoot}/** + +The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5, i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in clause 7.5. +- The shall be "eecs-eesregistration". +- The shall be "v1". +- The shall be set as described in clause 9.1.2. + +#### 9.1.2 Resources + +##### 9.1.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 9.1.2.1-1 depicts the resource URIs structure for the Eecs\_EESRegistration API. + +![Figure 9.1.2.1-1: Resource URI structure of the Eecs_EESRegistration API. The diagram shows a hierarchical structure of URI components in boxes connected by lines. The root box contains '{apiRoot}/eecs-eesregistration/'. A line descends from this box to a second box containing '/registrations'. Another line descends from the second box to a third box containing '/{registrationId}'.](1750e325061d2206b5af0af175793d79_img.jpg) + +``` + +graph TD + Root["{apiRoot}/eecs-eesregistration/"] --> Registrations["/registrations"] + Registrations --> RegistrationId["/{registrationId}"] + +``` + +Figure 9.1.2.1-1: Resource URI structure of the Eecs\_EESRegistration API. The diagram shows a hierarchical structure of URI components in boxes connected by lines. The root box contains '{apiRoot}/eecs-eesregistration/'. A line descends from this box to a second box containing '/registrations'. Another line descends from the second box to a third box containing '/{registrationId}'. + +**Figure 9.1.2.1-1: Resource URI structure of the Eecs\_EESRegistration API** + +Table 9.1.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 9.1.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------------|---------------------------------|---------------------------------|-----------------------------------------------------------| +| EES Registrations | /registrations | POST | Registers a new EES at the Edge Configuration Server. | +| Individual EES Registration | /registrations/{registrationId} | GET | Fetch an individual EES registration resource. | +| | | PUT | Fully replace an individual EES registration resource. | +| | | DELETE | Remove an individual EES registration resource. | +| | | PATCH | Partially update an individual EES registration resource. | + +## 9.1.2.2 Resource: EES Registrations + +### 9.1.2.2.1 Description + +This resource represents all the Edge Enabler Servers that are registered at a given Edge Configuration Server. + +### 9.1.2.2.2 Resource Definition + +Resource URI: {apiRoot}/eecs-eesregistration//registrations + +This resource shall support the resource URI variables defined in the table 9.1.2.2.2-1. + +**Table 9.1.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 9.1.2.2.3 Resource Standard Methods + +#### 9.1.2.2.3.1 POST + +This method shall support the URI query parameters specified in table 9.1.2.2.3.1-1. + +**Table 9.1.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 9.1.2.2.3.1-2 and the response data structures and response codes specified in table 9.1.2.2.3.1-3. + +**Table 9.1.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|---------------------------------------| +| EESRegistration | M | 1 | EES registration request information. | + +**Table 9.1.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EESRegistration | M | 1 | 201 Created | EES information is registered successfully at ECS. EES information registered with ECS is provided in the response body.

The URI of the created resource shall be returned in the "Location" HTTP header. | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 9.1.2.2.3.1-4: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/eecs-eesregistration//registrations/{registrationId} | + +### 9.1.2.2.4 Resource Custom Operations + +None. + +## 9.1.2.3 Resource: Individual EES Registration + +### 9.1.2.3.1 Description + +This Individual EES Registration resource represents an individual EES registered at a given Edge Configuration Server. + +### 9.1.2.3.2 Resource Definition + +Resource URI: {apiRoot}/eecs-eesregistration//registrations/{registrationId} + +This resource shall support the resource URI variables defined in the table 9.1.2.3.2-1. + +**Table 9.1.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------------|-----------|----------------------------------| +| apiRoot | string | See clause 7.5 | +| registrationId | string | The EES registration identifier. | + +### 9.1.2.3.3 Resource Standard Methods + +#### 9.1.2.3.3.1 GET + +This method retrieves the EES information registered at Edge Configuration Server. This method shall support the URI query parameters specified in table 9.1.2.3.3.1-1. + +**Table 9.1.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 9.1.2.3.3.1-2 and the response data structures and response codes specified in table 9.1.2.3.3.1-3. + +**Table 9.1.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 9.1.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EESRegistration | M | 1 | 200 OK | The EES registration information at the Edge Configuration Server. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 9.1.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative ECS. | + +**Table 9.1.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative ECS. | + +#### 9.1.2.3.3.2 PUT + +This method updates the EES registration information at Edge Configuration Server by completely replacing the existing registration data (except the value of "eesId" within EESProfile data type and the value of "suppFeat" attribute within the EESRegistration data type). This method shall support the URI query parameters specified in the table 9.1.2.3.3.2-1. + +**Table 9.1.2.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 9.1.2.3.3.2-2 and the response data structures and response codes specified in table 9.1.2.3.3.2-3. + +**Table 9.1.2.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-----------------------------------------------------------| +| EESRegistration | M | 1 | Details of the EES registration information to be updated | + +**Table 9.1.2.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EESRegistration | M | 1 | 200 OK | The EES registration information updated successfully and the updated EES registration information is returned in the response. | +| n/a | | | 204 No Content | The EES registration information was updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 9.1.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative ECS. | + +**Table 9.1.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative ECS. | + +#### 9.1.2.3.3.3 DELETE + +This method deregisters an EES registration from the ECS. This method shall support the URI query parameters specified in the table 9.1.2.3.3.3-1. + +**Table 9.1.2.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 9.1.2.3.3.3-2 and the response data structures and response codes specified in table 9.1.2.3.3.3-3. + +**Table 9.1.2.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 9.1.2.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The individual EES registration information matching the registrationId is deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 9.1.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative ECS. | + +**Table 9.1.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative ECS. | + +#### 9.1.2.3.3.4 PATCH + +This method partially updates the EES registration information at Edge Configuration Server. This method shall support the URI query parameters specified in the table 9.1.2.3.3.4-1. + +**Table 9.1.2.3.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 9.1.2.3.3.4-2 and the response data structures and response codes specified in table 9.1.2.3.3.4-3. + +**Table 9.1.2.3.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------| +| EESRegistrationPatch | M | 1 | Details of the EES registration information to be updated | + +**Table 9.1.2.3.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EESRegistration | M | 1 | 200 OK | The Individual EES registration information was updated successfully and the updated EES registration information is returned in the response. | +| n/a | | | 204 No Content | The Individual EES registration information was updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS.

Redirection handling is described in clause 5.2.10 of TS 29.122 [6]. | + +NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. + +**Table 9.1.2.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative ECS. | + +**Table 9.1.2.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative ECS. | + +#### 9.1.2.3.4 Resource Custom Operations + +None. + +### 9.1.3 Custom Operations without associated resources + +None. + +### 9.1.4 Notifications + +None. + +### 9.1.5 Data Model + +#### 9.1.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API + +Table 9.1.5.1-1 specifies the data types defined specifically for the Eecs\_EESRegistration API service. + +**Table 9.1.5.1-1: Eecs\_EESRegistration API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-------------------------|-----------------|------------------------------------------------------------------------------|---------------| +| EDNInfo | 9.1.5.2.10 | Represents EDN related information | EdgeApp_2 | +| EESRegistration | 9.1.5.2.2 | The EES registration information on ECS. | | +| EESProfile | 9.1.5.2.3 | The profile information related to the EES in the EESRegistration data type. | | +| ACRScenario | 9.1.5.3.3 | The ACR scenarios supported by EES. | | +| EESRegistrationPatch | 9.1.5.2.4 | To partially update the EES Registration information. | | +| ServiceArea | 9.1.5.2.5 | The topological and geographic areas served by EES. | | +| TopologicalServiceArea | 9.1.5.2.6 | The topological areas served by EES. | | +| GeographicalServiceArea | 9.1.5.2.7 | The geographic areas served by EES. | | +| EASInstantiationInfo | 9.1.5.2.8 | Represents the EAS instantiation information. | EdgeApp_2 | +| InstantiationCriteria | 9.1.5.2.9 | Represents the instantiation criteria. | EdgeApp_2 | +| InstantiationStatus | 9.1.5.3.4 | Represents the instantiation status. | EdgeApp_2 | + +Table 9.1.5.1-2 specifies data types re-used by the Eecs\_EESRegistration API service. + +**Table 9.1.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of optional features defined in table 9.1.7-1. | | +| ScheduledCommunicationTime | 3GPP TS 29.122 [6] | Represents the schedule information. | | +| DateTime | 3GPP TS 29.122 [6] | Represents a date and a time. | | +| Ecgi | 3GPP TS 29.571 [8] | Represents an EUTRA cell identifier. | | +| Ncgi | 3GPP TS 29.571 [8] | Represents an NR cell identifier. | | +| Tai | 3GPP TS 29.571 [8] | Represents a tracking area identity. | | +| GeographicArea | 3GPP TS 29.572 [11] | Identifies the geographical information of the user(s). | | +| CivicAddress | 3GPP TS 29.572 [11] | Identifies the civic address information of the user(s). | | +| PlmnIdNid | 3GPP TS 29.571 [8] | Identifies the network: PLMN Identifier or the SNPN Identifier (the PLMN Identifier and the NID). Used to indicate the serving network as part of topological service areas. | | +| Dnn | 3GPP TS 29.571 [8] | Represents a DNN. | EdgeApp_2 | +| Dnai | 3GPP TS 29.571 [8] | Used to represent the list of DNAI(s) information associated with EES. | | +| TimeWindow | 3GPP TS 29.122 [6] | Represents the time window. | | +| DateTimeRm | 3GPP TS 29.571 [8] | Used to capture the expiration time EES registration patch. | | +| EndPoint | 8.1.5.2.5 | The end point information of the Edge Enabler Server in the EES profile. | | +| EASBundleInfo | 8.1.5.3.8 | Represents EAS bundle information. | EdgeApp_2 | + +## 9.1.5.2 Structured data types + +### 9.1.5.2.1 Introduction + +### 9.1.5.2.2 Type: EESRegistration + +**Table 9.1.5.2.2-1: Definition of type EESRegistration** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|--------------------|----------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| eesProf | EESProfile | M | 1 | The profile information of the EES. | | +| expTime | DateTime | O | 0..1 | Identifies the expiration time for the EES registration. If the expiration time is not present, then it indicates that the registration of EES never expires. | | +| suppFeat | Supported Features | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.
This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | + +## 9.1.5.2.3 Type: EESProfile + +Table 9.1.5.2.3-1: Definition of type EESProfile + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eesId | string | M | 1 | The identifier of the EES | | +| endPt | EndPoint | M | 1 | Endpoint information (e.g. URI, FQDN, IP address) used to communicate with the EES. This information is provided to the EEC to connect to the EES. | | +| easIds | array(string) | O | 1..N | The application identities of the Edge Application Servers (e.g. URI, FQDN) registered with the EES or expected to be registered with the EES. | | +| easBdlInfos | map(array(EASBundleInfo)) | O | 1..N(1..M) | Represents the list of EAS bundles to which each EAS among the ones identified by the "easIds" attribute belongs.

The key of the map shall be the identifier of the EAS to which the provided EAS bundle information within the map value corresponds.

(NOTE) | EdgeApp_2 | +| ednInfoSets | EDNInfo | O | 1..N | Contains information related to the EDN where the EES resides. | EdgeApp_2 | +| easInstInfo | map(EASInstantiationInfo) | O | 1..N | Contains the EAS instantiation information for each EAS identified by the "easIds" attribute.

The key of the map shall be the EAS ID to which the provided instantiation information within the map value relates. | EdgeApp_2 | +| provId | string | O | 0..1 | Identifier of the ECSP that provides the EES provider. | | +| svcArea | ServiceArea | O | 0..1 | The list of geographical and topological areas that the EES serves. EECs in the UE that are outside the area shall not be served. | | +| appLocs | array(Dnai) | O | 1..N | List of DNAI(s) associated with the EES. This is a list of potential locations of the applications.
It is a subset of the DNAI(s) associated with the EDN, where the EES resides. | | +| svcContSupp | array(ACRScenario) | O | 1..N | The ACR scenarios supported by the EES for service continuity. If this attribute is not present, then the EES does not support service continuity. | | +| svcContSuppExt1 | array(EASBundleInfo) | O | 1..N | Represents the information related to the EES ability to handle bundled EAS ACRs.

This attribute may be present only when the "svcContSupp" attribute is also present.

When this attribute is present, it indicates that the EES (identified by the "eesId" attribute) is able to handle bundled EAS ACRs and contains the information of the EAS bundle(s) for which the EES is able to handle bundled EAS ACRs. | EdgeApp_2 | +| eecRegConf | boolean | M | 1 | Set to "true" if the EEC is required to register on the EES to use edge services. Set to "false" if EEC is not required to register on the EES to use edge services. Default value is "false" if omitted. | | + +NOTE: Within each EASBundleInfo encoded map entry of this attribute, the "mainEasId" attribute shall not be present. + +## 9.1.5.2.4 Type: EESRegistrationPatch + +Table 9.1.5.2.4-1: Definition of type EESRegistrationPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eesProf | EESProfile | O | 0..1 | The profile information of the EES. | | +| expTime | DateTimeRm | O | 0..1 | Identifies the expiration time for the EES registration. If the expiration time is not present, then it indicates that the registration of EES never expires. | | +| NOTE: The value of the "eesId" attribute within the EESProfile data type shall be the same as the one within the EES Registration data type during the creation of resource procedure. | | | | | | + +## 9.1.5.2.5 Type: ServiceArea + +Table 9.1.5.2.5-1: Definition of type ServiceArea + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|---|-------------|---------------------------------------|---------------| +| topServAr | Topological ServiceArea | O | 0..1 | The topological service areas. (NOTE) | | +| geoServAr | Geographical ServiceArea | O | 0..1 | The geographical service areas. | | +| NOTE: The "topServAr" attribute is not applicable for untrusted functional elements (EESs and/or EASs deployed outside the MNO trust domain). | | | | | | + +## 9.1.5.2.6 Type: TopologicalServiceArea + +Table 9.1.5.2.6-1: Definition of type TopologicalServiceArea + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------|---------------| +| ecgis | array(Ecgi) | O | 1..N | This IE contains a list of E-UTRA cell identities. | | +| ncgis | array(Ncgi) | O | 1..N | This IE contains a list of NR cell identities. | | +| tais | array(Tai) | O | 1..N | This IE contains a list of tracking area identities. | | +| plmnIds | array(PlmnIdNid) | O | 1..N | List of serving network (PLMN or SNPN) identities . For a SNPN, a NID together with a PLMN ID identifies the SNPN. (NOTE) | | +| NOTE: A combination of these information elements should not have duplicate or overlapping information for the same topological Service Area. | | | | | | + +## 9.1.5.2.7 Type: GeographicalServiceArea + +Table 9.1.5.2.7-1: Definition of type GeographicalServiceArea + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|---------------------------------------------------------------------------|---------------| +| geoArs | array(GeographicArea) | O | 1..N | Identifies a list of geographic area of the user where the UE is located. | | +| civicAddrs | array(Civic Address) | O | 1..N | Identifies a list of civic addresses of the user where the UE is located. | | + +## 9.1.5.2.8 Type: EASInstantiationInfo + +Table 9.1.5.2.8-1: Definition of type EASInstantiationInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| easId | string | M | 1 | The application identities of the Edge Application Servers. | | +| status | Instantiation Status | M | 1 | Contains the instantiation status of the EAS. | | +| instCrit | Instantiation Criteria | C | 0..1 | Contains the criteria information upon which the EAS can be instantiated.

This attribute shall be present only when the value of the "status" attribute is set to "INSTANTIABLE". | | + +## 9.1.5.2.9 Type: InstantiationCriteria + +Table 9.1.5.2.9-1: Definition of type InstantiationCriteria + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------------------------|---|-------------|---------------------------------------------------------------------------|---------------| +| instantiationTime | DateTime | C | 0..1 | Identifies the time at which the EAS shall be instantiated.

(NOTE) | | +| instWindows | array(Time Window) | C | 1..N | The time windows at which the EAS shall be instantiated.

(NOTE) | | +| scheds | array(ScheduledCommunicationTime) | C | 1..N | The schedules at which the EAS shall be instantiated.

(NOTE) | | + +NOTE : These attributes are mutually exclusive. Either one of them shall be present. + +## 9.1.5.2.10 Type: EDNInfo + +Table 9.1.5.2.10-1: Definition of type EDNInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-----------------------------------------------|---------------| +| dnn | Dnn | M | 1 | Contains the DNN identifying the EDN | | +| dnais | array(Dnai) | O | 1..N | Contains the DNAI(s) associated with the EDN. | | + +## 9.1.5.3 Simple data types and enumerations + +## 9.1.5.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 9.1.5.3.2 Simple data types + +The simple data types defined in table 9.1.5.3.2-1 shall be supported. + +Table 9.1.5.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 9.1.5.3.3 Enumeration: ACRScenario + +The enumeration ACRScenario represents the ACR scenarios supported. It shall comply with the provisions defined in table 9.1.5.3.3-1. + +**Table 9.1.5.3.3-1: Enumeration ACRScenario** + +| Enumeration value | Description | Applicability | +|-----------------------------|-------------------------------------------------------------------------------------|---------------| +| EEC_INITIATED | Represents the EEC initiated ACR scenario. | | +| EEC_EXECUTED_VIA_SOURCE_EES | Represents the EEC ACR scenario executed via the S-EES. | | +| EEC_EXECUTED_VIA_TARGET_EES | Represents the EEC ACR scenario executed via the T-EES. | | +| SOURCE_EAS_DECIDED | Represents the EEC ACR scenario where the S-EAS decides to perform ACR. | | +| SOURCE_EES_EXECUTED | Represents the EEC ACR scenario where S-EES executes the ACR. | | +| EEL_MANAGED_ACR | Represents the EEC ACR scenario where the ACR is managed by the Edge Enabler Layer. | | + +#### 9.1.5.3.4 Enumeration: InstantiationStatus + +The enumeration InstantiationStatus represents the instantiation status of the EAS. It shall comply with the provisions defined in table 9.1.5.3.4-1. + +**Table 9.1.5.3.4-1: Enumeration InstantiationStatus** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------|---------------| +| INSTANTIATED | Indicates that the EAS is instantiated. | | +| INSTANTIABLE | Indicates that the EAS is instantiable but not yet instantiated. | | + +### 9.1.6 Error Handling + +General error responses are defined in clause 7.7. + +### 9.1.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8 Table 9.1.7-1 lists the supported features for Eecs\_EESRegistration API. + +**Table 9.1.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | EdgeApp_2 | This feature indicates the support of the enhancements to the Edge Applications. Within this feature, the following enhancements are covered:
  • - support of EAS bundle information.
  • - support of EAS instantiation information management.
  • - support of EDN information provisioning within the EES profile.
  • - Support of the indication of the EAS ability to handle bundled EAS ACRs within the EAS profile.
| + +## 9.2 Eecs\_TargetEESDiscovery API + +### 9.2.1 Introduction + +The Eecs\_TargetEESDiscovery service shall use the Eecs\_TargetEESDiscovery API. + +The API URI of the Eecs\_TargetEESDiscovery API shall be: + +**{apiRoot}
/** + +The request URIs used in HTTP requests shall have the Resource URI structure as defined in clause 7.5, i.e.: + +**{apiRoot}
//** + +with the following components: + +- The {apiRoot} shall be set as described in clause 7.5. +- The shall be "eecs-targeteesdiscovery". +- The shall be "v1". +- The shall be set as described in clause 9.2.2. + +### 9.2.2 Resources + +#### 9.2.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 9.2.2.1-1 depicts the resource URIs structure for the Eecs\_TargetEESDiscovery API. + +![Diagram showing the resource URI structure for the Eecs_TargetEESDiscovery API. A box contains the base URI '{apiRoot}/eecs-targeteesdiscovery/'. A line branches from this box to another box containing the resource path '/ees-profiles'.](fadb105fd6214a1deb66e4d35b94f3e3_img.jpg) + +``` + +graph TD + A["{apiRoot}/eecs-targeteesdiscovery/"] --> B["/ees-profiles"] + +``` + +Diagram showing the resource URI structure for the Eecs\_TargetEESDiscovery API. A box contains the base URI '{apiRoot}/eecs-targeteesdiscovery/'. A line branches from this box to another box containing the resource path '/ees-profiles'. + +**Figure 9.2.2.1-1: Resource URI structure of the Eecs\_TargetEESDiscovery API** + +Table 9.2.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 9.2.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|---------------|---------------------------------|---------------------------------| +| EES Profiles | /ees-profiles | GET | Retrieve the T-EES information. | + +## 9.2.2.2 Resource: EES Profiles + +### 9.2.2.2.1 Description + +This resource allows the source service consumer (e.g., EES (S-EES) , CES) to retrieve the target (T-EES) information from the ECS. + +### 9.2.2.2.2 Resource Definition + +Resource URI: {apiRoot}/eecs-targeteedsdiscovery//ees-profiles + +This resource shall support the resource URI variables defined in the table 9.2.2.2.2-1. + +**Table 9.2.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 9.2.2.2.3 Resource Standard Methods + +#### 9.2.2.2.3.1 GET + +This method allows the service consumer to fetch the T-EES information as specified in 3GPP TS 23.558 [2], from the ECS with a given discovery filters. This method shall support the URI query parameters specified in table 9.2.2.2.3.1-1. + +**Table 9.2.2.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ees-id | string | M | 1 | Unique identifier of the T-EES. | | +| eas-id | string | M | 1 | Represents the application identifier of the S-EAS, e.g. URI, FQDN. | | +| target-dnai | Dnai | O | 0..1 | The DNAI information associated with the potential T-EES(s) and/or T-EAS(s). | | +| ue-id | Gpsi | O | 0..1 | Identifier of the UE. | | +| ue-location | LocationArea5G | O | 0..1 | The location information of the UE. | | +| eec-srv-cont-supp | EECSrvContinuitySupport | O | 0..1 | Indicates whether the EEC supports service continuity or not and the related service continuity support information. | EdgeApp_2 | +| ac-svc-cont-supp | array(ACRScenario) | O | 1..N | Indicates that the AC supports service continuity and contains the related service continuity support information (i.e., supported ACR scenarios). | EdgeApp_2 | +| bdl-id | string | O | 0..1 | Contains the identifier of the EAS bundle. | EdgeApp_2 | +| bdl-type | BdlType | O | 0..1 | Contains the EAS bundle type. | EdgeApp_2 | +| ens-ind | boolean | O | 0..1 | Indicates whether edge node sharing is requested.

When set to "true", it indicates that edge node sharing is requested.
When set to "false" (default if omitted), it indicates that node sharing is not requested. | EdgeApp_2 | +| app-grp-id | string | O | 0..1 | Contains the application group identifier.

When this query parameter is provided, then it indicates that the request is for the retrieval of an EES list for the announcement of common EAS. | EdgeApp_2 | + +This method shall support the request data structures specified in table 9.2.2.2.3.1-2 and the response data structures and response codes specified in table 9.2.2.2.3.1-3. + +**Table 9.2.2.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 9.2.2.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------| +| ECSServProvRes
p | M | 1 | 200 OK | The EDN configuration and the T-EES information determined by the ECS based on the query parameters. | +| NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.6-1 of 3GPP TS 29.122 [6] also apply. | | | | | + +#### 9.2.2.2.4 Resource Custom Operations + +None. + +### 9.2.3 Custom Operations without associated resources + +None. + +### 9.2.4 Notifications + +None. + +### 9.2.5 Data Model + +#### 9.2.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API. + +Table 9.2.5.1-1 specifies the data types defined specifically for the Eecs\_TargetEESDiscovery API. + +**Table 9.2.5.1-1: Eecs\_TargetEESDiscovery API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +Table 9.2.5.1-2 specifies data types re-used by the Eecs\_TargetEESDiscovery API service. + +**Table 9.2.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------|----------------------| +| ACRScenario | Clause 9.1.5.3.3 | Represents ACR scenarios. | EdgeApp_2 | +| Dnai | 3GPP TS 29.571 [8] | Used to indicate the target DNAI information. | | +| BdlType | Clause 8.1.5.3.6 | Represent EAS Bundle type. | EdgeApp_2 | +| EECSrvContinuitySupport | Clause 8.7.5.2.8 | Represent service continuity support related information for an EEC. | EdgeApp_2 | +| Gpsi | 3GPP TS 29.571 [8] | Used to identify the UE in the query parameter. | | +| LocationArea5G | 3GPP TS 29.122 [6] | Used to indicate the location information of the UE in the query parameter. | | +| ECSServProvResp | 3GPP TS 24.558 [14] | The response to the target EES discovery request, which includes the EDN configuration along with list of EES(s) information. | | + +### 9.2.5.2 Structured data types + +None. + +### 9.2.5.3 Simple data types and enumerations + +None. + +## 9.2.6 Error Handling + +General error responses are defined in clause 7.7. + +## 9.2.7 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 9.2.7-1 lists the supported features for Eecs\_TargetEESDiscovery API. + +**Table 9.2.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|-----------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | EdgeApp_2 | This feature indicates the support of the enhancements to the Edge Applications. Within this feature, the following enhancements are covered:
  • - Support T-EAS discovery based on EEC service continuity information and/or AC service continuity information.
  • - Support EAS bundle information management.
  • - Support of requesting edge node sharing.
  • - Support of T-EES discovery based on application group identifier.
| + +--- + +# 10 Using Common API Framework + +## 10.1 General + +EES may expose its services to EAS with support of CAPIF. Also, the EES may also re-expose the network capabilities of the 3GPP core network to the EAS(s) with support of CAPIF architecture, as specified in 3GPP TS 23.558 [2]. When CAPIF is used with EES services, the EES shall support the following as defined in 3GPP TS 29.222 [17]: + +- the API exposing function and related APIs over CAPIF-2/2e and CAPIF-3/3e reference points; +- the API publishing function and related APIs over CAPIF-4/4e reference point; +- the API management function and related APIs over CAPIF-5/5e reference point; and +- at least one of the security methods for authentication and authorization, and related security mechanisms. + +The EAS supports the role of API Invoker as specified in 3GPP TS 29.222 [17]. In a centralized deployment as defined in 3GPP TS 23.222 [17], where the CAPIF core function and API provider domain functions are co-located, the interactions between the CAPIF core function and API provider domain functions may be independent of CAPIF-3/3e, CAPIF-4/4e and CAPIF-5/5e reference points. + +When CAPIF is used with an EES service, the EES shall register all the features for northbound APIs in the CAPIF Core Function. + +The EAS may expose its services to other EAS(s) using CAPIF as specified in 3GPP TS 23.558 [2]. When CAPIF is used for exposure of EAS services to other EAS(s), the above procedure shall be applicable with the following differences: + +- the provisions related to the EES apply to the EAS; +- the provisions related to the EAS apply to the other EAS(s) as consumer(s) of the exposed EAS service APIs. + +## 10.2 Security + +When CAPIF is used for external exposure of EES services to EAS, before invoking the API exposed by the EES, the EAS as API invoker shall negotiate the security method (PKI, TLS-PSK or OAuth2) with CAPIF core function and ensure the EAS has enough credential to authenticate the EAS (see 3GPP TS 29.222 [17], clause 5.6.2.2 and clause 6.2.2.2). + +If PKI or TLS-PSK is used as the selected security method between the EAS and the EES, upon API invocation, the EES shall retrieve the authorization information from the CAPIF core function as described in 3GPP TS 29.222 [17], clause 5.6.2.4. + +As indicated in 3GPP TS 33.122 [18], the access to the EES APIs may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [19]), where the CAPIF core function (see 3GPP TS 29.222 [17]) plays the role of the authorization server. + +If OAuth2 is used as the selected security method between the EAS and the EES, then the EAS, prior to consuming services offered by the EES APIs, shall obtain a "token" from the authorization server, by invoking the Obtain\_Authorization service, as described in 3GPP TS 29.222 [17], clause 5.6.2.3.2. + +The EES APIs do not define any scopes for OAuth2 authorization. It is the EES responsibility to check whether the EAS is authorized to use an API based on the "token". Once the EES verifies the "token", it shall check whether the EES identifier in the "token" matches its own published identifier, and whether the API name in the "token" matches its own published API name. If those checks are passed, the EAS has full authority to access any resource or operation for the invoked API + +- NOTE: For aforementioned security methods, the EES needs to apply admission control according to access control policies after performing the authorization checks. + +When CAPIF is used for exposure of EAS services to other EAS(s), the above security procedure shall be applicable with the following differences: + +- the provisions related to the EES apply to the EAS; + +- the provisions related to the EAS apply to the other EAS(s) as consumer(s) of the exposed EAS service APIs. + +--- + +## 11 Security + +The authentication and authorization between EES and ECS shall be as specified in 3GPP TS 33.558 [20]. + +The authentication and authorization in EES capability exposure shall be as specified in 3GPP TS 33.558 [20]. When CAPIF is used, the aspects specified in clause 10 shall be used. + +The security credentials to be used for verification and authorization of various API requests from EAS and EES shall be as specified in 3GPP TS 33.558 [20]. + +--- + +## Annex A (normative): OpenAPI specification + +--- + +### A.1 General + +This annex is based on the OpenAPI 3.0.0 specification [3] and provides corresponding representations of all APIs defined in the present specification in YAML format. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [4] and clause 5.3.1 of the 3GPP TS 29.501 [5] for further information). + +--- + +### A.2 Eees\_EASRegistration API + +``` +openapi: 3.0.0 + +info: + title: EES EAS Registration_API + description: | + API for EAS Registration. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: 1.1.0-alpha.5 + +externalDocs: + description: > + 3GPP TS 29.558 V18.4.0 Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ + +servers: + - url: '{apiRoot}/eees-easregistration/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558. + +security: + - {} +``` + +``` +- oAuth2ClientCredentials: [] + +paths: + /registrations: + post: + summary: Creates a new Individual EAS Registration resource + operationId: CreateEASRegistration + tags: + - EAS Registrations (Collection) + description: Registers a new EAS at an EES. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EASRegistration' + responses: + '201': + description: EAS information is registered successfully at EES. + content: + application/json: + schema: + $ref: '#/components/schemas/EASRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /registrations/{registrationId}: + get: + summary: Read an Individual EAS Registration resource + operationId: ReadIndEASRegistration + tags: + - Individual EAS Registration (Document) + description: Retrieve an Individual EAS registration resource. + parameters: + - name: registrationId + in: path + description: Registration Id. + required: true + schema: + type: string + responses: + '200': + description: OK (The EAS registration information at the EES). + content: + application/json: + schema: + $ref: '#/components/schemas/EASRegistration' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +put: + summary: Update an Individual EAS Registration resource + operationId: UpdateIndEASRegistration + tags: + - Individual EAS Registration (Document) + description: Fully replace an existing EAS Registration resource. + parameters: + - name: registrationId + in: path + description: EAS registration Id. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EASRegistration' + responses: + '200': + description: OK (The EAS registration information is updated successfully). + content: + application/json: + schema: + $ref: '#/components/schemas/EASRegistration' + '204': + description: > + No Content. The individual EAS registration information is updated successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an Individual EAS Registration resource + operationId: ModifyIndEASRegistration + tags: +``` + +``` + +- Individual EAS Registration (Document) +description: Partially update an existing EAS Registration resource. +parameters: +- name: registrationId + in: path + description: EAS registration Id. + required: true + schema: + type: string +requestBody: +description: Partial update of an existing EAS registration resource. +required: true +content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/EASRegistrationPatch' +responses: +'200': + description: > + The Individual EAS registration is successfully modified and the updated + registration information is returned in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/EASRegistration' +'204': + description: > + No Content. The individual EAS registration information is updated successfully. +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: +summary: Delete an Individual EAS Registration resource +operationId: DeleteIndEASRegistration +tags: +- Individual EAS Registration (Document) +description: Delete an existing EAS registration at EES. +parameters: +- name: registrationId + in: path + description: EAS registration Id. + required: true + schema: + type: string +responses: +'204': + description: The individual EAS registration is deleted. +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + EASRegistration: + type: object + description: Represents an EAS registration information. + properties: + easProf: + $ref: '#/components/schemas/EASProfile' + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - easProf + + EASProfile: + type: object + description: Represents the EAS profile information. + properties: + easId: + type: string + description: Identifier of the EAS. + endPt: + $ref: '#/components/schemas/EndPoint' + easBdlInfos: + type: array + items: + $ref: '#/components/schemas/EASBundleInfo' + minItems: 1 + acIds: + type: array + items: + type: string + minItems: 1 + description: Identities of application clients that are served by the EAS. + provId: + type: string + description: Identifier of the ASP that provides the EAS. + type: + $ref: '#/components/schemas/EASCategory' + flexEasType: + type: string + description: The EAS type with flexible value set. + scheds: + type: array + items: + $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime' + minItems: 1 + description: The availability schedule of the EAS. + svcArea: + $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea' + svcKpi: + $ref: '#/components/schemas/EASServiceKPI' + permLvl: + type: array + items: +``` + +``` + + $ref: '#/components/schemas/PermissionLevel' + minItems: 1 + description: level of service permissions supported by the EAS. + easFeats: + type: array + items: + type: string + minItems: 1 + description: Service specific features supported by EAS. + appLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + description: List of DNAI(s) and the N6 traffic information associated with the EAS. + svcContSupp: + type: array + items: + $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario' + minItems: 1 + description: The ACR scenarios supported by the EAS for service continuity. + svcContSuppExt1: + type: array + items: + $ref: '#/components/schemas/EASBundleInfo' + minItems: 1 + description: > + Represents the information related to the EAS ability to handle bundled EAS ACRs. + This attribute may be present only when the "svcContSupp" attribute is also present. + When this attribute is present, it indicates that the EAS (identified by the "easId" + attribute) is able to handle bundled EAS ACRs and contains the information of the EAS + bundle(s) for which the EAS is able to handle bundled EAS ACRs. + transContSupp: + $ref: '#/components/schemas/TransContSuppDetails' + avlRep: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + status: + type: string + description: EAS status information. + genCtxDur: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + easSyncSupp: + type: boolean + default: false + description: > + Set to true to indicate that content synchronization between EASs is supported. + Set to false to indicate that content synchronization between EASs is not supported. + The default value when this attribute is omitted is false. + required: + - easId + - endPt + not: + required: [ type, flexEasType ] + +EASRegistrationPatch: + type: object + description: Represents partial update request of individual EAS registration information. + properties: + easProf: + $ref: '#/components/schemas/EASProfile' + expTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm' + +EASServiceKPI: + type: object + description: Represents the EAS service KPI information. + properties: + maxReqRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + maxRespTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + avail: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + avlComp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + avlGraComp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + avlMem: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +avlStrg: +$ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +connBand: +$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + +EASBundleInfo: +type: object +description: Represents the EAS bundle information. +properties: + bdlType: + $ref: '#/components/schemas/BdlType' + bdlId: + type: string + description: Indicates a bundle ID. + easIdsList: + type: array + items: + type: string + minItems: 1 + easBdlReqs: + $ref: '#/components/schemas/EASBdlReqs' + mainEasId: + type: string +required: +- bdlType +anyOf: +- required: [bdlId] +- required: [easIdsList] + +EASBdlReqs: +type: object +description: Represents the EAS bundle requirements. +properties: + coordinatedEasDisc: + type: boolean + default: false + description: > + Set to true to indicate that coordinated EAS discovery is required. + Set to false to indicate that coordinated EAS discovery is not required. + The default value when this attribute is omitted is false. + coordinatedAcr: + $ref: '#/components/schemas/CoordinatedAcrReqs' + affinity: + $ref: '#/components/schemas/Affinity' + +CoordinatedAcrReqs: +type: object +description: Represents the coordinated ACR related requirements for an EAS bundle. +properties: + coordinatedAcrInd: + type: boolean + default: false + description: > + Set to true to indicate that coordinated ACR is required. + Set to false to indicate that coordinated ACR is not required. + The default value when this attribute is omitted is false. + failureAction: + $ref: '#/components/schemas/FailureAction' +required: +- coordinatedAcrInd + +EndPoint: +type: object +description: The end point information to reach EAS. +properties: + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + ipv4Addrs: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + description: IPv4 addresses of the edge server. + ipv6Addrs: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' +``` + +``` + minItems: 1 + description: IPv6 addresses of the edge server. + uri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + oneOf: + - required: [uri] + - required: [fqdn] + - required: [ipv4Addrs] + - required: [ipv6Addrs] + +PermissionLevel: + anyOf: + - type: string + enum: + - TRIAL + - GOLD + - SILVER + - OTHER + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Indicates the level of service permissions supported by the EAS. + Possible values are: + - TRIAL: Level of service permission supported is TRIAL. + - GOLD: Level of service permission supported is GOLD. + - SILVER: Level of service permission supported is SILVER. + - OTHER: Any other level of service permissions supported. + +EASCategory: + anyOf: + - type: string + enum: + - UAS + - V2X + - SEALD_SERVERS + - OTHER + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Indicates the category or type of the EAS. + Possible values are: + - UAS: Indicates that the EAS category is for UAS services. + - V2X: Category of EAS is for V2X Services. + - SEALDD: Indicates that the EAS category is SEALDD Server for SEALDD services. + - OTHER: Any other type of EAS category. + +TransContSuppDetails: + type: object + description: > + Represents the detailed information about the EAS (e.g. SEALDD Server) capability for + seamless transport layer service continuity. + properties: + transProtocs: + type: array + items: + $ref: '#/components/schemas/TransportProtocol' + minItems: 1 + description: > + Indicates the transport layer protocols supported for EAS context transfer using + the seamless transport layer service continuity capability. + required: + - transProtocs + +TransportProtocol: + anyOf: + - type: string + enum: + - QUIC + - TCP + - TCP_TLS + - type: string + description: > +``` + +``` + + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Indicates the transport layer protocol. + Possible values are: + - QUIC: Indicates the QUIC protocol. + - TCP: Indicates the Transmission Control (TCP) Protocol. + - TCP_TLS: Indicates the Transmission Control Protocol (TCP) with Transport Layer Security + (TLS) protocol. + + BdlType: + anyOf: + - type: string + enum: + - DIRECT + - PROXY + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration and + is not used to encode content defined in the present version of this API. + description: | + Represents the EAS Bundle type. + Possible values are: + - DIRECT: Indicates that the EAS Bundle type is direct bundle. + - PROXY: Indicates that the EAS Bundle type is proxy bundle. + + Affinity: + anyOf: + - type: string + enum: + - STRONG + - PREFERRED + - WEAK + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration and + is not used to encode content defined in the present version of this API. + description: | + Represents the affinity requirements of an EAS bundle. + Possible values are: + - STRONG: Indicates that the affinity is strong, i.e., all the EASs of the bundle shall be + in the same EDN. + - PREFERRED: Indicates that the affinity is preferred, i.e., it is nice to have all the EASs + of the bundle in the same EDN, but it is not essential. + - WEAK: Indicates that the affinity is weak, i.e., it is not essential to have all the EASs + of the bundle in the same EDN. + + FailureAction: + anyOf: + - type: string + enum: + - CANCEL + - PROCEED + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration and + is not used to encode content defined in the present version of this API. + description: | + Represents the EAS bundle related failure action during ACR. + Possible values are: + - CANCEL: Indicates that ACR shall be cancelled for the other EAS(s) of the bundle for which + ACR is not failed. + - PROCEED: Indicates that ACR shall proceed for the other EAS(s) of the bundle for which + ACR is not failed. + +``` + +## A.3 Eees\_UELocation API + +``` + +openapi: 3.0.0 +info: + title: EES UE Location Information_API + description: | + API for EES UE Location Information. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: 1.1.0-alpha.2 + +``` + +``` +externalDocs: + description: > + 3GPP TS 29.558 V18.1.0 Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ +security: + - {} + - oAuth2ClientCredentials: [] +servers: + - url: '{apiRoot}/eees-uelocation/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558. + +paths: + /fetch: + post: + summary: Fetch an UE location information. + operationId: FetchUELocation + tags: + - Fetch an UE location information + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LocationRequest' + responses: + '200': + description: OK (The requested location information) + content: + application/json: + schema: + $ref: '#/components/schemas/LocationResponse' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + /subscriptions: + post: + summary: Creates a new Individual Location Information Subscription resource + operationId: CreateLocationInfoSubscription + tags: + - Location Information Subscriptions (Collection) + description: > + Create a Subscription resource for continous reporting of UE location + information to the EAS. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LocationSubscription' + responses: + '201': +``` + +``` + +description: > + Created (The individual location information subscription resource + is created successfully) +content: + application/json: + schema: + $ref: '#/components/schemas/LocationSubscription' +headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +callbacks: + LocationInformationNotification: + '{request.body#/notificationDestination}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LocationNotification' +responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +UserConsentRevocationNotif: + '{request.body#/revocationNotifUri}': + post: + requestBody: + +``` + +``` + + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ConsentRevocNotif' + responses: + '204': + description: No Content (successful notification). + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + get: + summary: Read an Individual Location Information Subscription resource + operationId: ReadIndLocationInfoSubscription + tags: + - Individual Location Information Subscription (Document) + description: Retrieve an Individual location information subscription information. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + responses: + '200': + description: OK (Successfully get the location information subscription). + content: + application/json: + schema: + $ref: '#/components/schemas/LocationSubscription' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +``` + +``` +put: + summary: Update an Individual Location Information Subscription resource + operationId: UpdateIndLocationInfoSubscription + tags: + - Individual Location Information Subscription (Document) + description: Fully replace an existing Individual location information Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LocationSubscription' + responses: + '200': + description: OK (The individual location information subscription was modified +successfully). + content: + application/json: + schema: + $ref: '#/components/schemas/LocationSubscription' + '204': + description: No Content. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an Individual Location Information Subscription resource + operationId: ModifyIndLocationInfoSubscription + tags: + - Individual Location Information Subscription (Document) + description: Partially update an existing Individual location information Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + requestBody: + description: Partial update an existing Individual AC information Subscription. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/LocationSubscriptionPatch' + responses: + '200': + description: > +``` + +``` + + OK (The Individual location information Subscription is successfully + modified and the updated subscription information is returned in the response). +content: + application/json: + schema: + $ref: '#/components/schemas/LocationSubscription' +'204': + description: > + No Content (The individual location information subscription was modified successfully). +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an Individual Location Information Subscription resource + operationId: DeleteIndLocationInfoSubscription + tags: + - Individual Location Information Subscription (Document) + description: Delete an existing Individual location information Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + responses: + '204': + description: The individual subscription is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +# Components + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + +``` + +``` +flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + LocationSubscription: + type: object + description: Represents an Individual Location Information Subscription. + properties: + easId: + type: string + description: Identifier of the EAS subscribing for location information report. + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + intGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + extGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + locGran: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/Accuracy' + locQos: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS' + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + requestTestNotification: + type: boolean + description: > + Set to true by the EAS to request the EES to send a test notification. + Set to false or omitted otherwise. + revocationNotifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oneOf: + - required: [ueId] + - required: [intGrpId] + - required: [extGrpId] + required: + - easId + + LocationSubscriptionPatch: + type: object + description: Represents the partial update of Individual AC Information Subscription. + properties: + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + revocationNotifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + locGran: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/Accuracy' + locQos: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS' + + LocationNotification: + type: object + description: Represents the filters information for AC Information Subscription. + properties: + subId: + type: string + description: > + Identifier of the location information subscription for which the + location information notification is related to. + locEvts: + type: array + items: + $ref: '#/components/schemas/LocationEvent' + minItems: 1 +``` + +``` + description: List of notifications with location information. + required: + - subId + - locEvs + +LocationEvent: + type: object + description: Location Information event notification. + properties: + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + locInf: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + locInfPred: + $ref: 'TS29522_AnalyticsExposure.yaml#/components/schemas/UeMobilityExposure' + oneOf: + - required: [locInf] + - required: [locInfPred] + required: + - ueId + +LocationRequest: + type: object + description: To request location information request. + properties: + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + gran: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/Accuracy' + locQos: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ueId + +LocationResponse: + type: object + description: Contains the response location information request. + properties: + ueLocation: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ueLocation + +ConsentRevocNotif: + description: > + Represents the user consent revocation information conveyed in a user consent + revocation notification. + type: object + properties: + subscriptionId: + type: string + description: > + Contains the identifier of the subscription to which the notification is related. + consentsRevoked: + type: array + items: + $ref: '#/components/schemas/ConsentRevoked' + minItems: 1 + required: + - subscriptionId + - consentsRevoked + +ConsentRevoked: + description: Represents the information related to a revoked user consent. + type: object + properties: + ucPurpose: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/UcPurpose' + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + required: + - ucPurpose +``` + +``` + +oneOf: +- required: [externalId] +- required: [ueId] + +``` + +## A.4 Eees\_UEIdentifier API + +``` + +openapi: 3.0.0 + +info: + title: EES UE Identifier Service + version: 1.1.0-alpha.2 + description: | + EES UE Identifier Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.558 V18.4.0; Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ + +security: +- {} +- oAuth2ClientCredentials: [] + +servers: +- url: '{apiRoot}/eees-ueidentifier/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +paths: + /fetch: + post: + deprecated: true + summary: Fetch the identifier of an UE. + operationId: FetchUEId + tags: + - Fetch UE Identifier + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserInformation' + responses: + '200': + description: > + The communicated ACR update information was successfully received. + The response body contains the feedback of the EES. + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/get: + post: + summary: Get the identifier of an UE. + operationId: GetUEId + tags: + - Get UE Identifier + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserInfo' + responses: + '200': + description: > + The operation is successful and the corresponding UE Identifier information, returned + by the Edge Enabler Server is included in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/UEIdInfo' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + UserInfo: + deprecated: true + description: > + Represents information about the User or the UE, that used by EES to use 3GPP CN capability + to retrieve the EAS specific UE identifier. + type: object + properties: + easId: + description: > + +``` + +``` + The application identifier of the EAS, e.g. URI, FQDN, requesting the UE Identifier + information + type: string + easProviderId: + description: Identifier of the ASP that provides the EAS. + type: string + ipAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - easId + - ipAddr + +UserInfo: + description: > + Represents information about the User or the UE, that used by EES to retrieve the UE + Identifier information. + type: object + properties: + easIds: + type: array + items: + type: string + minItems: 1 + description: > + The additional list of EAS Identifier for which the UE IDs are requested for by EAS or + EEC given the User information (e.g. IP address). + easProviderId: + description: Identifier of the ASP that provides the EAS. + type: string + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + ipAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + anyOf: + - required: [ueId] + - required: [ipAddr] + +UeIdInfo: + description: > + Represents UE Identifier Information, including list of UE Identifier related information. + type: object + properties: + ueIds: + type: array + items: + $ref: '#/components/schemas/UeId' + minItems: 1 + required: + - ueIds + +UeId: + description: > + Represents UE Identifier Information, including list of UE Identifier related information. + type: object + properties: + edgeUeId: + description: Represents EDGE UE Identifier. + type: string + afSpecUeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + easId: + description: > + The application identifier of the EAS, e.g. URI, FQDN, requesting the UE Identifier + Information. + type: string + oneOf: + - required: [edgeUeId] + - required: [afSpecUeId] +``` + +## A.5 Eees\_AppClientInformation API + +``` + +openapi: 3.0.0 +info: + title: EES Application Client Information_API + description: | + API for EES Application Client Information. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: 1.1.0-alpha.2 +externalDocs: + description: > + 3GPP TS 29.558 V18.1.0 Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ +security: + - {} + - oAuth2ClientCredentials: [] +servers: + - url: '{apiRoot}/eees-appclientinformation/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558. + +paths: + /subscriptions: + post: + summary: Creates a new Individual Application Client Information Subscriptions resource + operationId: CreateAppClientInfoSubscription + tags: + - Application Client Information Subscriptions (Collection) + description: Create a Subscription resource for reporting of AC information to the EAS. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ACInfoSubscription' + responses: + '201': + description: > + Created (The individual AC information subscription resource is created successfully) + content: + application/json: + schema: + $ref: '#/components/schemas/ACInfoSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + ACInformationNotification: + +``` + +``` + + '{request.body#/notificationDestination}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ACInfoNotification' + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + get: + summary: Read an Individual Application Client Information Subscriptions resource + operationId: ReadIndAppClientInfoSubscription + tags: + - Individual Application Client Information Subscription (Document) + description: Retrieve an Individual AC information subscription information. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + responses: + '200': + description: OK (Successfully get the AC information subscription). + content: + application/json: + schema: + $ref: '#/components/schemas/ACInfoSubscription' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + +``` + +``` +$ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +put: + summary: Update an Individual Application Client Information Subscriptions resource + operationId: UpdateIndAppClientInfoSubscription + tags: + - Individual Application Client Information Subscription (Document) + description: Fully replace an existing Individual AC information Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ACInfoSubscription' + responses: + '200': + description: OK (The individual AC information subscription was modified successfully). + content: + application/json: + schema: + $ref: '#/components/schemas/ACInfoSubscription' + '204': + description: No Content. + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an Individual Application Client Information Subscriptions resource + operationId: ModifyIndAppClientInfoSubscription + tags: + - Individual Application Client Information Subscription (Document) + description: Partially update an existing Individual AC information Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + requestBody: + description: Partial update an existing Individual AC information Subscription. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/ACInfoSubscriptionPatch' + responses: + '200': + description: > +``` + +``` + + OK (The Individual AC information Subscription is successfully modified + and the updated subscription information is returned in the response). + content: + application/json: + schema: + $ref: '#/components/schemas/ACInfoSubscription' + '204': + description: > + No Content (The individual AC information subscription was modified successfully). + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete an Individual Application Client Information Subscriptions resource + operationId: DeleteIndAppClientInfoSubscription + tags: + - Individual Application Client Information Subscription (Document) + description: Delete an existing Individual AC information Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + responses: + '204': + description: The individual subscription is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +# Components + +components: + securitySchemes: + OAuth2ClientCredentials: + +``` + +``` +type: oauth2 +flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + ACInfoSubscription: + type: object + description: Represents an Individual AC Information Subscription. + properties: + easId: + type: string + description: Identifier of the EAS subscribing for AC information report. + acFltrs: + type: array + items: + $ref: '#/components/schemas/ACFilters' + minItems: 1 + description: Filters to retrieve the information about specific ACs. + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + requestTestNotification: + type: boolean + description: > + Set to true by the EAS to request the EES to send a test notification. + Set to false or omitted otherwise. + websockNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - easId + + ACInfoSubscriptionPatch: + type: object + description: Represents the partial update of Individual AC Information Subscription. + properties: + acFltrs: + type: array + items: + $ref: '#/components/schemas/ACFilters' + minItems: 1 + description: Filters to retrieve the information about specific ACs. + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + + ACFilters: + type: object + description: Represents the filters information for AC Information Subscription. + properties: + acTypes: + items: + type: string + minItems: 1 + description: List of AC Types or categories. + ecspIds: + items: + type: string + minItems: 1 + description: The list of identifiers of ECSPs associated with the EEC. + acIds: + items: + type: string + minItems: 1 + description: List of identifiers of ACs to be matched. + svcArea: + $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea' + maxAcKpi: + $ref: 'TS24558_Eees_EECRegistration.yaml#/components/schemas/ACServiceKPIs' +``` + +``` + +minAckPpi: + $ref: 'TS24558_Eees_EECRegistration.yaml#/components/schemas/ACServiceKPIs' +opSchds: + type: array + items: + $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime' + minItems: 1 + description: Operation schedule of EAS to be matched with operation schedule of the AC. +ueIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + description: List of UE identifiers hosting the AC. +locInfs: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + +ACInfoNotification: + type: object + description: AC Information notification. + properties: + subId: + type: string + description: > + Identifier of the AC information subscription for which this notification is related to. + acInfs: + type: array + items: + $ref: '#/components/schemas/ACInformation' + minItems: 1 + description: Notifications that include the ACs information matching filter criteria. + required: + - subId + - acInfs + +ACInformation: + type: object + description: AC Information matching the filter criteria. + properties: + acProfs: + type: array + items: + $ref: 'TS24558_Eees_EECRegistration.yaml#/components/schemas/ACProfile' + minItems: 1 + description: List of profile information of ACs. + ueIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + description: List of UE identifiers hosting the AC. + ueLocInfs: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + required: + - acProfs + +``` + +## A.6 Eees\_SessionWithQoS API + +``` + +openapi: 3.0.0 +info: + title: EES Session with QoS API + description: | + API for EES Session with QoS service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: 1.1.0-alpha.2 +externalDocs: + description: > + 3GPP TS 29.558 V18.2.0 Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ +security: + - {} + - oAuth2ClientCredentials: [] +servers: + - url: '{apiRoot}/ees-session-with-qos/v1' + +``` + +``` +variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558. + +paths: + /sessions: + post: + summary: Create a new Individual Session with QoS resource + operationId: CreateIndSessionWithQoS + tags: + - Sessions with QoS (Collection) + description: > + Request reservation of resources for a data session between AC and EAS with a specific QoS. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SessionWithQoS' + responses: + '201': + description: Created (Successful creation) + content: + application/json: + schema: + $ref: '#/components/schemas/SessionWithQoS' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + notificationDestination: + '{request.body#/notificationDestination}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserPlaneEventNotification' + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +``` + +``` + + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +get: + summary: Read all Sessions with QoS resource + operationId: ReadAllSessionsWithQoS + tags: + - Sessions with QoS (Collection) + description: Retrieve all the Session With QoS information. + parameters: + - name: eas-id + in: query + description: Identifier of the EAS which querying the status of subscriptions. + required: true + schema: + type: string + responses: + '200': + description: OK (Successful get all of the active subscriptions) + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SessionWithQoS' + minItems: 1 + description: > + All the subscription information related to the request URI is returned + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/sessions/{sessionId}: + put: + summary: Update an Individual Session with QoS resource + operationId: UpdateIndSessionWithQoS + tags: + - Individual Session with QoS (Document) + description: > + Fully replace an existing Individual Session with QoS resource identified by a sessionId. + parameters: + - name: sessionId + in: path + description: Session Id. + required: true + +``` + +``` + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SessionWithQoS' + responses: + '200': + description: > + The individual Session with QoS is successfully modified and the updated + session with QoS context information is returned in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/SessionWithQoS' + '204': + description: No Content + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an Individual Session with QoS resource + operationId: ModifyIndSessionWithQoS + tags: + - Individual Session with QoS (Document) + parameters: + - name: sessionId + in: path + description: session Id. + required: true + schema: + type: string + requestBody: + description: > + Partial update an existing Individual Session with QoS resource identified by a sessionId. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SessionWithQoSPatch' + responses: + '200': + description: > + The individual Session with QoS is successfully modified and the updated + session with QoS context information is returned in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/SessionWithQoS' + '204': + description: No Content. + '307': +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete an Individual Session with QoS resource + operationId: DeleteIndSessionWithQoS + tags: + - Individual Session with QoS (Document) + description: Remove an Individual Session with QoS resource identified by a sessionId. + parameters: + - name: sessionId + in: path + description: session Id. + required: true + schema: + type: string + responses: + '204': + description: > + The individual Session with QoS resource matching the sessionId is successfully deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +get: + summary: Read Individual Session with QoS resource + operationId: ReadIndSessionWithQoS + tags: + - Individual Session with QoS (Document) + description: Read a subscription resource for a sessionId. + parameters: + - name: sessionId + in: path + description: Session Id. + required: true + schema: + type: string + responses: + '200': +``` + +``` + +description: The subscription information related to the request URI is returned. +content: + application/json: + schema: + $ref: '#/components/schemas/SessionWithQoS' +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +``` + +#### # Components + +``` + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + SessionWithQoS: + type: object + description: Represents an Individual Session with QoS Subscription. + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + easId: + type: string + description: Identifier of an EAS. + ueIpv4Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' + ipDomain: + type: string + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + intGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + extGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + ipFlows: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + description: Contains the flow description for the Uplink and/or Downlink IP flows. + trafFilterInfo: + $ref: 'TS29558_Eees_ACRManagementEvent.yaml#/components/schemas/TrafficFilterInfo' + qosReference: + type: string + description: Identifies a pre-defined QoS information. + altQosReference: + type: array + items: + type: string + description: > + +``` + +``` + Identifies an ordered list of pre-defined QoS information. + The lower the index of the array for a given entry, the higher the priority. +events: + type: array + items: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/UserPlaneEvent' + description: Indicates the events subscribed by the EAS. +sponsorInformation: + $ref: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation' +qosMonInfo: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/QosMonitoringInformation' +notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' +dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +maxbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' +maxbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' +disUeNotif: + type: boolean + description: > + Indicates to disable QoS flow parameters signalling to the UE when the SMF is notified + by the NG-RAN of changes in the fulfilled QoS situation when it is included and set to + "true". The fulfilled situation is either the QoS profile or an Alternative QoS Profile. + The default value "false" shall apply, if the attribute is not present and has not been + supplied previously. +requestTestNotification: + type: boolean + description: > + Set to true by Subscriber to request the EES to send a test notification + as defined in 3GPP TS 29.122. Set to false or omitted otherwise. +websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +required: + - easId + - ipFlows + +SessionWithQoSPatch: + type: object + description: Represents a modification request of Individual Session with QoS Subscription. + properties: + ipFlows: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + description: Contains the flow description for the Uplink and/or Downlink IP flows. + trafFilterInfo: + $ref: 'TS29558_Eees_ACRManagementEvent.yaml#/components/schemas/TrafficFilterInfo' + qosReference: + type: string + description: Identifies a pre-defined QoS information. + altQosReference: + type: array + items: + type: string + description: > + Identifies an ordered list of pre-defined QoS information. + The lower the index of the array for a given entry, the higher the priority. + events: + type: array + items: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/UserPlaneEvent' + description: Indicates the events subscribed by the EAS. + sponsorInformation: + $ref: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation' + qosMonInfo: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/QosMonitoringInformationRm' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + maxbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxbrDl: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + disUeNotif: + type: boolean + + UserPlaneEventNotification: + type: object + description: Represents the user plane event notification. + properties: + sessionId: + type: string + description: > + String identifying the individual data session information for which + the QoS event notification is delivered. + eventReports: + type: array + items: + $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/UserPlaneEventReport' + minItems: 1 + description: > + Contains the flow description for the Uplink and/or Downlink IP flows. + required: + - sessionId + - eventReports + +``` + +## A.7 Ees\_ACRManagementEvent API + +openapi: 3.0.0 + +``` + +info: + title: EES ACR Management Event_API + description: | + API for EES ACR Management Event. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: 1.1.0-alpha.5 + +externalDocs: + description: > + 3GPP TS 29.558 V18.4.0 Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/ees-acrmgntevent/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558. + +paths: + /subscriptions: + post: + summary: Creates a new Individual ACR Management Events Subscription + operationId: CreateACRMngEventSubscr + tags: + - ACR Management Events Subscriptions (Collection) + description: Create an Individual ACR Management Event Subscription resource. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AcrMgmtEventsSubscription' + callbacks: + ACRManagementEventsNotification: + '{request.body#/notificationDestination}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + +``` + +``` + schema: + $ref: '#/components/schemas/AcrMgmtEventsNotification' + responses: + '200': + description: OK (The notification is received successfully) + content: + application/json: + schema: + $ref: '#/components/schemas/EasAckInformation' + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +UPPathChangeAvailabilityNotif: + '{request.body#/notificationDestination}/report-availability': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AvailabilityNotif' + responses: + '204': + description: No Content. The notification is successful received. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +responses: + '201': + description: Created (Successful creation) +``` + +``` + +content: + application/json: + schema: + $ref: '#/components/schemas/AcrMgntEventsSubscription' +headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string +'204': + description: > + Successful case. The resource has been successfully created and no + additional content is to be sent in the response message. +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +get: + summary: Read all ACR Management Events Subscriptions + operationId: GetACRMngEventSubscrs + tags: + - ACR Management Events Subscriptions (Collection) + description: Retrieve all the ACR Management Events Subscriptions information. + parameters: + - name: supp-feat + in: query + description: Features supported by the EAS. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: OK (Successful get all of the active subscriptions) + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AcrMgntEventsSubscription' + minItems: 1 + description: All the active ACR management events subscriptions + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + get: + summary: Read an Individual ACR Management Events Subscription + operationId: GetIndACRMngEventSubscr + tags: + - Individual ACR Management Events Subscription (Document) + description: Retrieve an Individual ACR Management Events Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + - name: supp-feat + in: query + description: Features supported by the EAS. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: OK (Successful get the active subscription). + content: + application/json: + schema: + $ref: '#/components/schemas/AcrMgntEventsSubscription' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Update an Individual ACR Management Events Subscription + operationId: UpdateIndACRMngEventSubscr + tags: + - Individual ACR Management Events Subscription (Document) + description: Fully replace an existing Individual ACR Management Events Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AcrMgntEventsSubscription' + responses: + '200': + description: OK (Successful get the active subscription). +``` + +``` +content: + application/json: + schema: + $ref: '#/components/schemas/AcrMgmtEventsSubscription' +'204': + description: No Content +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an Individual ACR Management Events Subscription + operationId: ModifyIndACRMngEventSubscr + tags: + - Individual ACR Management Events Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + requestBody: + description: Partial update an existing Individual ACR Management Events Subscription. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AcrMgmtEventsSubscriptionPatch' + responses: + '200': + description: > + The Individual ACR Management Events Subscription is successfully modified + and the updated subscription information is returned in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/AcrMgmtEventsSubscription' + '204': + description: No Content. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete an Individual ACR Management Events Subscription + operationId: DeleteIndACRMngEventSubscr + tags: + - Individual ACR Management Events Subscription (Document) + description: Delete an existing Individual ACR Management Events Subscription. + parameters: + - name: subscriptionId + in: path + description: Subscription Id. + required: true + schema: + type: string + responses: + '204': + description: The individual subscription is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +# Components + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + + AcrMgmtEventsSubscription: + type: object + description: Represents an Individual ACR Management Events Subscription. + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + easId: + type: string + description: Identifier of an EAS. + eventSubscs: + type: array + items: + $ref: '#/components/schemas/AcrMgmtEventSubsc' + minItems: 1 + description: The subscribed ACR management events. + evtReq: + +``` + +``` +$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' +notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' +eventReports: + type: array + items: + $ref: '#/components/schemas/AcrMgmtEventReport' + minItems: 1 + description: The ACR management event report(s). +availabilityInfo: + $ref: '#/components/schemas/AvailabilityNotif' +failEventReports: + type: array + items: + $ref: '#/components/schemas/FailureAcrMgmtEventInfo' + minItems: 1 + description: Failure event reports. +requestTestNotification: + type: boolean + description: > + Set to true by the EAS to request the EES to send a test notification. + Set to false or omitted otherwise. +websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +required: +- easId +- eventSubs +- notificationDestination + +AcrMgmtEventSubsc: + type: object + description: Represents an ACR Management Event Subscription. + properties: + event: + $ref: '#/components/schemas/AcrMgmtEvent' + eventFilter: + $ref: '#/components/schemas/AcrMgmtEventFilter' + evtReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + tgtUeId: + $ref: '#/components/schemas/TargetUeIdentification' + dnaIChgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' + easAckInd: + type: boolean + description: > + Identifies whether EAS acknowledgement of UP path change event notifications is to be + expected. Set to "true" if the EAS acknowledgement is expected. Set to "false" if + the EAS acknowledgement is not expected. Default value is "false" if omitted. + This attribute may be provided only if the "event" attribute is set to "UP_PATH_CHG". + easChars: + type: array + items: + $ref: 'TS24558_Eees_EASDiscovery.yaml#/components/schemas/EasCharacteristics' + minItems: 1 + description: A list of EAS characteristics. + trafFilterInfo: + $ref: '#/components/schemas/TrafficFilterInfo' + servContPlanInd: + type: boolean + description: > + Represents the service continuity planning indication (i.e., whether or not the EES + shall monitor whether the UE(s) enter the predicted location). + When set to true, it indicates that service continuity planning is required. + When set to false, it indicates that Service continuity planning is not required. + The default value when this attribute is omitted is false. + easAckSvcCont: + type: boolean + description: > + Indicates that the EAS will provide an acknowledgement as a response to the notification + of ACR management notification related to service continuity planning. Set to "true" if + the EAS acknowledgement is expected. Default value is "false". This attribute may be + provided only if the "event" attribute is set to "ACR_MONITORING" and/or + "ACR_FACILITATION". + required: + - event +``` + +``` +AcrMgmtEventsSubscriptionPatch: + type: object + description: > + Represents a modification request of Individual ACR Management Events Subscription. + properties: + eventSubscs: + type: array + items: + $ref: '#/components/schemas/AcrMgmtEventSubsc' + minItems: 1 + description: The subscribed ACR management events. + evtReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + +AcrMgmtEventsNotification: + type: object + description: Represents the ACR management events notification. + properties: + subpId: + type: string + description: > + String identifying the Individual ACR Management Events Subscription + for which the notification is delivered. + eventReports: + type: array + items: + $ref: '#/components/schemas/AcrMgmtEventReport' + minItems: 1 + description: A list of ACR management event reports. + required: + - subpId + - eventReports + +AcrMgmtEventReport: + type: object + description: Represents an ACR management event report. + properties: + event: + $ref: '#/components/schemas/AcrMgmtEvent' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + upPathChgInfo: + $ref: '#/components/schemas/UpPathChangeInfo' + easEndPoint: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint' + actStatus: + $ref: '#/components/schemas/ActStatus' + acrParams: + $ref: '#/components/schemas/ACRParameters' + acId: + type: string + selACRScen: + type: array + items: + $ref: '#/components/schemas/SelectedACRScenarios' + minItems: 1 + easInBdlInfoList: + type: array + items: + $ref: '#/components/schemas/EasInBundleInfo' + minItems: 1 + description: Represents the list of EAS in a bundle related information. + servContPlanInd: + type: boolean + description: > + Represents the service continuity planning indication (i.e., whether or not the EES will + monitor whether the UE(s) enter the predicted location). + When set to true, it indicates that service continuity planning will be performed. + When set to false, it indicates that Service continuity planning will not be performed. + The default value when this attribute is omitted is false. + required: + - event + +ACRParameters: + type: object +``` + +``` +description: Represents the ACR parameters. +properties: + predictExpTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + +FailureAcrMgmtEventInfo: + type: object + description: Represents a failure ACR management event. + properties: + event: + $ref: '#/components/schemas/AcrMgmtEvent' + failureCode: + $ref: '#/components/schemas/AcrMgmtEventFailureCode' + required: + - event + - failureCode + +TargetUeIdentification: + description: Identifies the target UE information. + type: object + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + intGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + extGrpId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + ueIpAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddress' + oneOf: + - required: [gpsi] + - required: [intGrpId] + - required: [extGrpId] + - required: [ueIpAddress] + +AvailabilityNotif: + type: object + description: > + Represents the availability information of user plane path management events monitoring + via the 3GPP 5GC network. + properties: + availabilityStatus: + $ref: '#/components/schemas/AvailabilityStatus' + required: + - availabilityStatus + +UpPathChangeInfo: + description: Represents user plane path change information. + type: object + properties: + ueId: + $ref: '#/components/schemas/IndUeIdentification' + dnaiChgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' + sourceTrafficRoute: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + targetTrafficRoute: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + sourceDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + targetDnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + srcUeIpv4Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + srcUeIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + tgtUeIpv4Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + tgtUeIpv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + required: + - ueId + - dnaiChgType + +IndUeIdentification: + description: Represents identification information of a UE. + type: object + properties: +``` + +``` + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + ueIpAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddress' + oneOf: + - required: [gsi] + - required: [externalId] + - required: [ueIpAddress] + +TrafficFilterInfo: + description: Represents the Traffic Filter Information. + type: object + properties: + ipFlows: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + description: Contains the flow description for the Uplink and/or Downlink IP flows. + uris: + type: array + items: + type: string + minItems: 1 + description: Indicates URI(s) matching criteria. + domainNames: + type: array + items: + type: string + minItems: 1 + description: Indicates Domain Name matching criteria. + dnProtocol: + $ref: 'TS29122_PfdManagement.yaml#/components/schemas/DomainNameProtocol' + anyOf: + - required: [ipFlows] + - required: [uris] + - required: [domainNames] + +SelectedACRScenarios: + type: object + description: > + Represents the selected ACR scenario(s) applicable for a given combination of AC and UE. + properties: + acrList: + type: array + items: + $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario' + minItems: 0 + acId: + type: string + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + required: + - acrList + - acId + - ueId + +EasAckInformation: + type: object + description: Represents the EAS acknowledgement information. + properties: + resCode: + $ref: '#/components/schemas/ResultCode' + required: + - resCode + +EasInBundleInfo: + type: object + description: > + Represents EAS in a bundle information. + properties: + easId: + type: string + description: Contains the identifier of the EAS that is within an EAS bundle. + dnais: + type: array +``` + +``` +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' +minItems: 1 +svcArea: + $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea' +``` + +``` +# +# ENUMERATIONS DATA TYPES +# +``` + +#### AcrMgmtEvent: + +``` +anyOf: +- type: string + enum: + - UP_PATH_CHG + - ACR_MONITORING + - ACR_FACILITATION + - ACT_START_STOP + - ACR_SELECTION +- type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +description: | + Represents the ACR Management event. +Possible values are: +- UP_PATH_CHG: Indicates that ACR Management Event is the User plane path change event. +- ACR_MONITORING: Indicates that ACR Management Event is the ACR monitoring event. +- ACR_FACILITATION: Indicates that ACR Management Event is the ACR facilitation event. +- ACT_START_STOP: Indicates that ACR Management Event is the ACT start/stop event. +- ACR_SELECTION: Indicates that ACR Management Event is the ACR selection event. +``` + +#### AcrMgmtEventFilter: + +``` +anyOf: +- type: string + enum: + - INTRA_EDN_MOBILITY + - INTER_EDN_MOBILITY +- type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +description: | + Represents the filtering criteria for the ACR Management event. +Possible values are: +- INTRA_EDN_MOBILITY: Indicates that the ACR Management Event filter is intra-EDN mobility. +- INTER_EDN_MOBILITY: Indicates that the ACR Management Event filter is inter-EDN mobility. +``` + +#### ActStatus: + +``` +anyOf: +- type: string + enum: + - ACT_START + - ACT_STOP +- type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +description: | + Represents the ACT status. +Possible values are: +- ACT_START: Indicates ACT start. +- ACT_STOP: Indicates ACT stop. +``` + +#### AcrMgmtEventFailureCode: + +``` +anyOf: +- type: string + enum: + - 3GPP_UP_PATH_CHANGE_MON_NOT_AVAILABLE + - OTHER_REASONS +- type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +description: | + Represents the failure reason for the ACR Management event. +Possible values are: +- 3GPP_UP_PATH_CHANGE_MON_NOT_AVAILABLE: Indicates that the ACR Management Event +``` + +``` + +Subscription failed because user plane path management event notifications from the 3GPP +network is NOT available. This value is only applicable for the "UP_PATH_CHG", +"ACR_MONITORING" and "ACR_FACILITATION" events. +- OTHER_REASONS: Indicates that the ACR Management Event Subscription failed for other +reasons. This value is applicable for all events. + +AvailabilityStatus: + anyOf: + - type: string + enum: + - AVAILABLE + - NOT_AVAILABLE + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents the availability status. + Possible values are: + - AVAILABLE: Indicates availability. + - NOT_AVAILABLE: Indicates unavailability. + +ResultCode: + anyOf: + - type: string + enum: + - ACCEPTED + - REJECTED + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents the result code of ACT acceptance by EAS. + Possible values are: + - ACCEPTED: Indicates acceptance of the ACT. + - REJECTED: Indicates rejection of the ACT. + +``` + +## A.8 Eees\_EECContextRelocation API + +``` + +openapi: 3.0.0 +info: + title: EES EEC Context Relocation API + description: | + API for EEC Context Relocation. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: 1.1.0-alpha.3 +externalDocs: + description: > + 3GPP TS 29.558 V18.2.0 Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ +security: +- {} +- oAuth2ClientCredentials: [] +servers: +- url: '{apiRoot}/ees-eecontextreloc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558. + +paths: + /eec-contexts: + post: + summary: Push EEC Context information + operationId: PushEecContexts + tags: + - Collection of EEC contexts (Collection) + description: S-EES transfers the EEC context information to T-EES. + requestBody: + required: true + content: + +``` + +``` + application/json: + schema: + $ref: '#/components/schemas/EEContextPush' +responses: + '200': + description: > + OK. The EEC context has been successfully transferred to the T-EEs and + the EEC is implicitly registered. + content: + application/json: + schema: + $ref: '#/components/schemas/EEContextPushRes' + '204': + description: No Content. The EEC context has been successfully transferred to the T-EEs. + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +get: + summary: Pull EEC Context information + operationId: PullEecContexts + tags: + - Collection of EEC contexts (Collection) + description: T-EEs pulls an EEC context information from S-EEs. + parameters: + - name: ees-id + in: query + description: Unique identifier of the requesting EES. + required: true + schema: + type: string + - name: eec-cntx-id + in: query + description: Unique identifier of the EEC context. + required: true + schema: + type: string + - name: sess-cntxs + in: query + description: List of service session context information being requested. + required: false + schema: + $ref: '#/components/schemas/SessionContexts' + responses: + '200': + description: > + OK (The EEC context information matching the input parameters in the request + is returned by the S-EEs). + content: + application/json: + schema: + $ref: '#/components/schemas/EEContext' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +``` + +``` +'406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + SessionContexts: + type: object + description: Represents the list of service session contexts information. + properties: + sessCntxs: + type: array + items: + $ref: '#/components/schemas/IndividualSessionContext' + minItems: 1 + description: List of service session contexts information. + required: + - sessCntxs + +IndividualSessionContext: + type: object + description: Represents a single service session context information. + properties: + easId: + type: string + description: Identifier of the EAS providing the application services. + endPt: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint' + acId: + type: string + description: Identifier of the AC for which the service session information is provided. + acrList: + type: array + items: + $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario' + minItems: 1 + description: The list of selected ACR scenarios. + required: + - easId + - endPt + +EEContextPush: + type: object + description: Represents the EEC context push request data. + properties: + eesId: + type: string + description: Identifier of the S-EES pushing the EEC context information. + eecCntx: + $ref: '#/components/schemas/EEContext' + tgtEas: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint' + acrScenariosSelReq: + type: boolean + description: > + Set to true if the EEC indicates the T-EES to select the ACR scenarios. + Set to false if the T-EES is not required to select the ACR scenarios. + The default value when omitted is false. + required: + - eesId + - eecCntx +``` + +``` +EEContextPushRes: + type: object + description: Represents the EEC context push response data. + properties: + implReg: + $ref: '#/components/schemas/ImplicitRegDetails' + selAcrScenariosList: + type: array + items: + $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario' + minItems: 1 + description: The list of ACR scenarios selected by T-EES. + +ImplicitRegDetails: + type: object + description: Represents the EEC implicit registration details. + properties: + regId: + type: string + description: Identifier of the EEC registration. + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + required: + - regId + +EEContext: + type: object + description: Represents the EEC context information. + properties: + eecId: + type: string + description: Unique identifier of the EEC. + cntxId: + type: string + description: Unique identifier assigned to the EEC context. + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + elSubs: + type: array + items: + type: string + minItems: 1 + description: List of subscription IDs for the capability exposure for the EEC ID. + ueLoc: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + acProfs: + type: array + items: + $ref: 'TS24558_Eecs_EECRegistration.yaml#/components/schemas/ACProfile' + minItems: 1 + description: List AC profiles. + sessCntxs: + $ref: '#/components/schemas/SessionContexts' + eecSrvContSupp: + $ref: '#/components/schemas/EECSrvContinuitySupport' + ueMobSuppInd: + type: boolean + description: > + Set to true to indicate that UE Mobility support is required. + Set to false to indicate that UE mobility support is not required. + The default value when omitted is false. + required: + - eecId + - cntxId + +EECSrvContinuitySupport: + type: object + description: Represents the EEC service continuity support details. + properties: + srvContSupp: + type: boolean + description: > + Set to true if EEC supports service continuity. + Set to false if EEC does not support service continuity. + The default value when omitted is false. +``` + +``` + +acrScenarios: + type: array + items: + $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario' + minItems: 1 + description: The list of ACR scenarios supported by EEC. + required: + - srvContSupp + +``` + +## A.9 Eees\_EELManagedACR API + +``` + +openapi: 3.0.0 +info: + title: EES EEL Managed ACR Service + version: 1.1.0-alpha.2 + description: | + EES EEL Managed ACR Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.558 V18.1.0; Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/eees-eel-acr/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +paths: + /request-eelacr: + post: + summary: Request the EES (e.g. S-EES) to handle all the operations of an ACR. + operationId: RequestEELManagedACR + tags: + - Request EEL Managed ACR + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EELACRReq' + responses: + '200': + description: > + The requested EEL Managed ACR initiation was successfully received and + processed. The response body contains the feedback of the EES. + content: + application/json: + schema: + $ref: '#/components/schemas/EELACRResp' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + +``` + +``` +$ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/subscriptions: + get: + summary: Retrieve all the active ACT Status Subscriptions managed by the EES. + operationId: GetACTStatusSubscriptions + tags: + - ACT Status Subscriptions (Collection) + responses: + '200': + description: > + OK. All the active ACT status subscriptions managed by the EES shall + be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ACTStatusSubsc' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + post: + summary: Request the creation of a subscription to ACT status reporting. + operationId: CreateACTStatusSubsc + tags: + - ACT Status Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ACTStatusSubsc' + responses: + '201': + description: > + Created. The subscription is successfully created and a representation of the + created Individual ACT Status Subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ACTStatusSubsc' + headers: + Location: + description: > + Contains the URI of the created Individual ACT Status Subscription resource. + required: true + schema: + type: string + '400': +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +callbacks: + ACTStatusNotification: + "{$request.body#/notificationUri}/act-status": + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ACTStatusNotif' + responses: + '204': + description: > + No Content. The ACT status notification is successfully received + and acknowledged. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + get: + summary: Retrieve an ACT status subscription resource. + operationId: GetACTStatusSubscription + tags: + - Individual ACT Status Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Individual ACT Status Subscription identifier. + required: true + schema: + type: string + responses: + '200': + +``` + +``` +description: > + OK. The requested real-time UAV status subscription resource is returned. +content: + application/json: + schema: + $ref: '#/components/schemas/ACTStatusSubsc' +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + EELACRReq: + description: > + Represents the parameters to request the EES (e.g. S-EES) to handle all the + operations of an ACR. + type: object + properties: + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + easCharacs: + type: array + items: + $ref: 'TS24558_Eees_EASDiscovery.yaml#/components/schemas/EasCharacteristics' + minItems: 1 + appCtxtStoreAddr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ueId + - easCharacs + + EELACRResp: + description: Represents the feedback of the EES on EEL Managed ACR request. + type: object + properties: + appCtxtStoreAddr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + ACTStatusSubsc: + description: > + Represents the parameters to request the creation of a subscription to ACT + status reporting. + type: object + properties: + easId: + type: string + description: Contains the application identifier of the EAS, e.g. URI, FQDN. +``` + +``` + +notificationUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +required: +- easId +- notificationUri + +ACTStatusNotif: + description: Represents an ACT status notification. + type: object + properties: + subscriptionId: + type: string + description: Subscription identifier. + actStatus: + $ref: 'TS29558_Eees_ACRStatusUpdate.yaml#/components/schemas/ACTResult' + required: + - subscriptionId + - actStatus + +``` + +# ENUMS: + +## A.10 Eees\_ACRStatusUpdate API + +openapi: 3.0.0 + +``` + +info: + title: EES ACR Status Update Service + version: 1.1.0-alpha.2 + description: | + EES ACR Status Update Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.558 V18.1.0; Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ + +security: +- {} +- oAuth2ClientCredentials: [] + +servers: +- url: '{apiRoot}/eees-acrstatus-update/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +paths: +/request-acrupdate: + post: + summary: Request to update the information related to ACR (e.g. indicate the status of ACT, +update the notification target address). + operationId: RequestACRUpdate + tags: + - Request ACR Update + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ACRUpdateData' + responses: + '200': + description: > + The communicated ACR update information was successfully received. + The response body contains the feedback of the EES. + content: + application/json: + schema: + $ref: '#/components/schemas/ACRDataStatus' + +``` + +``` + +'204': + description: > + No Content. The communicated ACR update information was successfully + received. +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + ACRUpdateData: + description: > + Represents the parameters to update the information related to ACR (e.g. indicate + the status of ACT, update the notification target address). + type: object + properties: + easId: + type: string + acId: + type: string + actResultInfo: + $ref: '#/components/schemas/ACTResultInfo' + e3SubscIds: + type: array + items: + type: string + minItems: 1 + e3NotificationUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + required: + - easId + anyOf: + - required: [actResultInfo] + - required: [e3SubscIds] + - required: [e3NotificationUri] + + ACRDataStatus: + description: Represents the ACR status information. + type: object + properties: + e3SubscsStatus: + $ref: '#/components/schemas/E3SubscsStatus' + e3SubscIds: + type: array + items: + type: string + +``` + +``` + + minItems: 1 + required: + - e3SubscsStatus + +ACTResultInfo: + description: Represents the result of ACT and the related information. + type: object + properties: + actResult: + $ref: '#/components/schemas/ACTResult' + actFailureCause: + $ref: '#/components/schemas/ACTFailureCause' + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + easEndPoint: + $ref: 'TS29558_Eecs_EASRegistration.yaml#/components/schemas/EndPoint' + required: + - actResult + - ueId + - easEndPoint + +# ENUMS: + +ACTResult: + anyOf: + - type: string + enum: + - SUCCESSFUL + - FAILED + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents the result of ACT. + Possible values are: + - SUCCESSFUL: Indicates that the ACT was successful. + - FAILED: Indicates that the ACT failed. + +E3SubscsStatus: + anyOf: + - type: string + enum: + - SUCCESSFUL + - FAILED + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents the status of the initialization of EDGE-3 subscriptions. + Possible values are: + - SUCCESSFUL: Indicates that the initialization of EDGE-3 subscriptions was successful. + - FAILED: Indicates that the initialization of EDGE-3 subscriptions failed. + +ACTFailureCause: + anyOf: + - type: string + enum: + - ACR_CANCELLATION + - OTHER + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents the cause of ACT failure. + Possible values are: + - ACR_CANCELLATION: Indicates that the ACT failed due to the cancellation of the ACR. + - OTHER: Indicates that the ACT failed for other reasons. + +``` + +## A.11 Eecs\_EESRegistration API + +openapi: 3.0.0 + +info: + +``` +title: ECS EES Registration_API +description: | + API for EES Registration. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +version: 1.1.0-alpha.5 + +externalDocs: + description: > + 3GPP TS 29.558 V18.4.0 Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/eecs-eesregistration/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558. + +paths: + /registrations: + post: + summary: Create a new EES Registration + operationId: CreateEESRegistration + tags: + - EES Registrations (Collection) + description: Registers a new EES at the Edge Configuration Server. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EESRegistration' + responses: + '201': + description: EES information is registered successfully at ECS. + content: + application/json: + schema: + $ref: '#/components/schemas/EESRegistration' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /registrations/{registrationId}: + get: + summary: Get an Individual EES Registration + operationId: GetIndEESReg +``` + +``` +tags: + - Individual EES Registration (Document) +description: Retrieve an Individual EES registration resource. +parameters: + - name: registrationId + in: path + description: Registration Id. + required: true + schema: + type: string +responses: + '200': + description: OK (The EES registration information at the Edge Configuration Server). + content: + application/json: + schema: + $ref: '#/components/schemas/EESRegistration' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +put: + summary: Update an Individual EES Registration + operationId: UpdateIndEESReg + tags: + - Individual EES Registration (Document) + description: Fully replace an existing EES Registration resource. + parameters: + - name: registrationId + in: path + description: EES Registration Id. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EESRegistration' + responses: + '200': + description: OK (The EES registration information is updated successfully). + content: + application/json: + schema: + $ref: '#/components/schemas/EESRegistration' + '204': + description: > + No Content. The individual EES registration information is updated successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +``` + +``` +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +patch: + summary: Modify an Individual EES Registration + operationId: ModifyIndEESReg + tags: + - Individual EES Registration (Document) + description: Partially update an existing EES Registration resource. + parameters: + - name: registrationId + in: path + description: EES registration Id. + required: true + schema: + type: string + requestBody: + description: Partial update an existing EES registration resource. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/EESRegistrationPatch' + responses: + '200': + description: > + The Individual EES registration is successfully modified and + the updated registration information is returned in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/EESRegistration' + '204': + description: > + No Content. The individual EES registration information is updated successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an Individual EES Registration + operationId: DeleteIndEESReg + tags: +``` + +``` +- Individual EES Registration (Document) +description: Delete an existing EES registration at ECS. +parameters: +- name: registrationId + in: path + description: Registration Id. + required: true + schema: + type: string +responses: +'204': + description: The individual EES registration is deleted. +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + EESRegistration: + type: object + description: Represents an EES registration information. + properties: + eesProf: + $ref: '#/components/schemas/EESProfile' + expTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - eesProf + + EESProfile: + type: object + description: Represents the EES profile information. + properties: + eesId: + type: string + description: Identifier of the EES. + endPt: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint' + easIds: + type: array + items: + type: string + minItems: 1 + description: Application identifiers of EASs that are registered with EES. + easBdlInfos: + type: object + additionalProperties: + type: array + items: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EASBundleInfo' + minItems: 1 +``` + +``` +minProperties: 1 +description: > + The key used in this map for each entry is the EAS ID of the concerned EAS. + Within each EASBundleInfo encoded map entry of this attribute, the "mainEasId" attribute + shall not be present. +ednInfoSets: + $ref: '#/components/schemas/EDNInfo' +easInstInfo: + type: object + additionalProperties: + $ref: '#/components/schemas/EASInstantiationInfo' + minProperties: 1 + description: > + Represents the EAS instantiation information for the EAS(s) registered at the EES. + The key of the map shall be the EAS ID to which the provided instantiation information + within the map value relates. +provId: + type: string + description: Identifier of the ECSP that provides the EES provider. +svcArea: + $ref: '#/components/schemas/ServiceArea' +appLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + description: List of DNAI(s) associated with the EES. +svcContSupp: + type: array + items: + $ref: '#/components/schemas/ACRScenario' + minItems: 1 + description: The ACR scenarios supported by the EES for service continuity. +svcContSuppExt1: + type: array + items: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EASBundleInfo' + minItems: 1 + description: > + Represents the information related to the EES ability to handle bundled EAS ACRs. + This attribute may be present only when the "svcContSupp" attribute is also present. + When this attribute is present, it indicates that the EES (identified by the "eesId" + attribute) is able to handle bundled EAS ACRs and contains the information of the EAS + bundle(s) for which the EES is able to handle bundled EAS ACRs. +eecRegConf: + type: boolean + description: > + Set to true if the EEC is required to register to the EES to use edge service. + Set to false if the EEC is not required to register to use edge services. Default + Value is false if omitted. +required: +- eesId +- endPt +- eecRegConf + +EESRegistrationPatch: + type: object + description: Represents partial update request of individual EES registration information. + properties: + eesProf: + $ref: '#/components/schemas/EESProfile' + expTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm' + +ServiceArea: + type: object + description: Represents a service area information of the EdgeApp entity. + properties: + topServAr: + $ref: '#/components/schemas/TopologicalServiceArea' + geoServAr: + $ref: '#/components/schemas/GeographicalServiceArea' + +TopologicalServiceArea: + type: object + description: Represents topological service area information. + properties: + ecgis: +``` + +``` + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + minItems: 1 + description: A list of E-UTRA cell identities. + ncgis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + minItems: 1 + description: A list of NR cell identities. + tais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + description: A list of tracking area identities. + plmnIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + description: A list of serving network identities. + +GeographicalServiceArea: + type: object + description: Represents geographical service area information. + properties: + geoArs: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + description: A list of geographic area information. + civicAddrs: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + minItems: 1 + description: A list of civic address information. + +EASInstantiationInfo: + type: object + description: Represents the EAS instantiation information. + properties: + easId: + type: string + description: Identifier of the EAS. + status: + $ref: '#/components/schemas/InstantiationStatus' + instCrit: + $ref: '#/components/schemas/InstantiationCriteria' + required: + - easId + - status + +InstantiationCriteria: + type: object + description: Represents the instantiation criteria for an EAS. + properties: + instantiationTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + instWindows: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + minItems: 1 + description: A list time windows at which the EAS is instantiated. + scheds: + type: array + items: + $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime' + minItems: 1 + description: Represents the EAS instantiation schedule. + oneOf: + - required: [instantiationTime] + - required: [instWindows] + - required: [scheds] +``` + +``` + +EDNInfo: + type: object + description: Represents EDN related information. + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + required: + - dnn + +ACRScenario: + anyOf: + - type: string + enum: + - EEC_INITIATED + - EEC_EXECUTED_VIA_SOURCE_EES + - EEC_EXECUTED_VIA_TARGET_EES + - SOURCE_EAS_DECIDED + - SOURCE_EES_EXECUTED + - EEL_MANAGED_ACR + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represents the ACR scenarios supported by EES. + Possible values are: + - EEC_INITIATED: Represents the EEC initiated ACR scenario. + - EEC_EXECUTED_VIA_SOURCE_EES: Represents the EEC ACR scenario executed via the S-EES. + - EEC_EXECUTED_VIA_TARGET_EES: Represents the EEC ACR scenario executed via the T-EES. + - SOURCE_EAS_DECIDED: Represents the EEC ACR scenario where the S-EAS decides to perform + ACR. + - SOURCE_EES_EXECUTED: Represents the EEC ACR scenario where S-EES executes the ACR. + - EEL_MANAGED_ACR: Represents the EEC ACR scenario where the ACR is managed by the + + Edge Enabler Layer. + +InstantiationStatus: + anyOf: + - type: string + enum: + - INSTANTIATED + - INSTANTIABLE + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represents the instantiation status information of an EAS. + Possible values are: + - INSTANTIATED: Indicates that the EAS status is instantiated. + - INSTANTIABLE: Indicates that the EAS status is instantiable but not yet instantiated. + +``` + +## A.12 Eecs\_TargetEESDiscovery API + +``` + +openapi: 3.0.0 +info: + title: ECS Target EES Discovery API + description: | + API for Target EES Discovery. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: 1.1.0-alpha.3 +externalDocs: + description: > + 3GPP TS 29.558 V18.4.0 Enabling Edge Applications; + +``` + +``` +Application Programming Interface (API) specification; Stage 3 +url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ +security: +- {} +- oAuth2ClientCredentials: [] +servers: +- url: '{apiRoot}/eecs-targeteesdiscovery/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558. + +paths: +/ees-profiles: + get: + summary: Read all EES Profiles + operationId: GetEESProfiles + tags: + - EES Profiles (Collection) + description: Retrieve the T-EES information. + parameters: + - name: ees-id + in: query + description: Unique identifier of the S-EES. + required: true + schema: + type: string + - name: eas-id + in: query + description: Unique identifier of the S-EAS. + required: true + schema: + type: string + - name: target-dnai + in: query + description: The DNAI information associated with the potential T-EES(s) and/or T-EAS(s). + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + - name: ue-id + in: query + description: Identifier of the UE. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + - name: ue-location + in: query + description: The location information of the UE. + required: false + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + - name: eec-srv-cont-supp + in: query + description: > + Indicates whether the EEC supports service continuity or not and the related service + continuity support information. + required: false + schema: + $ref: + 'TS29558_Eees_EECContextRelocation.yaml#/components/schemas/EECSrvContinuitySupport' + - name: ac-svc-cont-supp + in: query + description: > + Indicates that the AC supports service continuity and contains the related service + continuity support information (i.e., supported ACR scenarios). + required: false + schema: + type: array + items: + $ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario' + minItems: 1 + - name: bdl-id + in: query + description: > + Contains EAS bundle identifier. + required: false + schema: + type: string +``` + +``` + +- name: bdl-type + in: query + description: > + Contains EAS bundle type. + required: false + schema: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/BdlType' +- name: ens-ind + in: query + description: indicates whether edge node sharing is requested. + required: false + schema: + type: boolean + description: > + Set to true if edge node sharing is requested. + Set to false if edge node sharing is not requested. + The default value when omitted is false. +- name: app-grp-id + in: query + description: > + Contains the application group identifier. + required: false + schema: + type: string +responses: + '200': + description: The EDN configuration and the T-EES information determined by ECS. + content: + application/json: + schema: + $ref: 'TS24558_Eecs_ServiceProvisioning.yaml#/components/schemas/ECSServProvResp' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +``` + +## A.13 Eees\_ACRParameterInformation API + +openapi: 3.0.0 + +``` + +info: + title: EES ACR Parameters Information Service + version: 1.0.0-alpha.2 + description: | + EES ACR Parameters Information Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.558 V18.3.0; Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3. + +``` + +``` +url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/eees-acr-param/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +paths: + /send-acrparamsinfo: + post: + summary: Request to send ACR parameters information. + operationId: Request + tags: + - Send ACR Parameter Information + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ACRParamsInfo' + responses: + '200': + description: > + The ACR parameters information is successfully received and the content of these ACR + parameters information is returned in the response body + content: + application/json: + schema: + $ref: '#/components/schemas/ACRParamsInfo' + '204': + description: > + No Content. The ACR parameter information is successfully received and no content is + returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + ACRParamsInfo: +``` + +``` + +description: > + Represents the ACR parameters information. +type: object +properties: + eesId: + type: string + description: Represents the EES ID. + eecId: + type: string + description: Represents the EEC ID. + acId: + type: string + description: Represents the AC ID. + sEasEndPoint: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint' + tEasEndPoint: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint' + acrParams: + $ref: 'TS29558_Eees_ACRManagementEvent.yaml#/components/schemas/ACRParameters' +required: +- eesId +- eecId +- acId +- sEasEndPoint +- tEasEndPoint +- acrParams + +``` + +## A.14 Ecas\_SelectedEES API + +openapi: 3.0.0 + +``` + +info: + title: Selected EES Service + version: 1.0.0-alpha.1 + description: | + Selected EES Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.558 V18.3.0; Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29\_series/29.558/ + +security: +- {} +- oAuth2ClientCredentials: [] + +servers: +- url: '{apiRoot}/ecas-selected-ees/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +paths: +/declare: + post: + summary: Declare the selected EES to the CAS. + operationId: DeclareSelectedEES + tags: + - Declare Selected EES + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SeleESDecInfo' + responses: + '204': + description: > + No Content. The Selected EES Declaration request is received + successfully. + +``` + +``` + + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + SeleESDecInfo: + description: > + Represents the information elements for the selected EES declaration. + type: object + properties: + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + seleEesId: + type: string + seleEndpoint: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint' + easId: + type: string + acId: + type: string + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ueId + - seleEesId + - seleEndpoint + - easId + +``` + +## A.15 Eees\_CommonEASAnnouncement API + +openapi: 3.0.0 + +``` + +info: + title: EES Announce Common EAS Information Service + version: 1.0.0-alpha.2 + description: | + EES Announce Common EAS Information Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + +``` + +``` +description: > + 3GPP TS 29.558 V18.4.0; Enabling Edge Applications; + Application Programming Interface (API) specification; Stage 3. +url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.558/ + +security: +- {} +- oAuth2ClientCredentials: [] + +servers: +- url: '{apiRoot}/eees-common-eas/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +paths: +/declare: + post: + summary: Request to declare common EAS information. + operationId: Declare + tags: + - Declare common EAS Information + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CommonEASInfo' + responses: + '204': + description: > + No Content. The common EAS information is successfully received and no content is + returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + CommonEASInfo: + description: > + Represents the common EAS information. + type: object + properties: + requestorId: +``` + +``` + type: string + description: Represents the identifier of the announcing EES sending the request. + easId: + type: string + description: Represents the EAS ID of the selected common EAS + appGrpId: + type: string + description: Represents the application group identifier. + endPt: + $ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint' + required: + - requestorId + - easId + - appGrpId + - endPt +``` + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-01 | CT3#113e | C3-210300 | | | | TS skeleton for Enabling Edge Applications, Application Programming Interface (API) specification; Stage 3. | 0.0.0 | +| 2021-01 | CT3#113e | C3-210322 | | | | Inclusion of documents agreed in CT3#113e:
C3-210182, C3-210301, C3-210321 | 0.1.0 | +| 2021-03 | CT3#114e | C3-211508 | | | | Inclusion of documents agreed in CT3#114e:
C3-211365, C3-211503, C3-211504, C3-211505, C3-211506, C3-211507 | 0.2.0 | +| 2021-04 | CT3#115e | C3-212520 | | | | Inclusion of documents agreed in CT3#115e:
C3-212367, C3-212368, C3-212369, C3-212370 | 0.3.0 | +| 2021-05 | CT3#116e | C3-213328 | | | | Inclusion of documents agreed in CT3#116e:
C3-213324, C3-213325, C3-213326, C3-213327, C3-213547 | 0.4.0 | +| 2021-08 | CT3#117e | C3-214571 | | | | Inclusion of documents agreed in CT3#117e:
C3-214387, C3-214513, C3-214389, C3-214570, C3-214388, C3-214390, C3-214391, C3-214392 | 0.5.0 | +| 2021-09 | CT#93e | CP-212164 | | | | Version 1.0.0 created for presentation for information. | 1.0.0 | +| 2021-10 | CT3#118e | C3-215471 | | | | Inclusion of documents agreed in CT3#118e:
C3-215236, C3-215338, C3-215339, C3-215340, C3-215341, C3-215342, C3-215377, C3-215378 | 1.1.0 | +| 2021-11 | CT3#119e | C3-216515 | | | | Inclusion of documents agreed in CT3#119e:
C3-216182, C3-216347, C3-216348, C3-216385, C3-216386, C3-216396 | 1.2.0 | +| 2022-01 | CT3#119-Bis-e | C3-220447 | | | | Inclusion of documents agreed in CT3#119-Bis-e:
C3-220133, C3-220419, C3-220420, C3-220421, C3-220459, C3-220275, C3-220276 | 1.3.0 | +| 2022-02 | CT3#120e | C3-221510 | | | | Inclusion of documents agreed in CT3#120e:
C3-221401, C3-221635, C3-221408, C3-221636, C3-221407, C3-221637, C3-221630, C3-221631, C3-221632, C3-221633, C3-221634, C3-221410, C3-221726, C3-221727, C3-221687 | 1.4.0 | +| 2022-04 | CT3#121e | C3-222481 | | | | Inclusion of documents agreed in CT3#121e:
C3-222136, C3-222137, C3-222139, C3-222141, C3-222143, C3-222362, C3-222363, C3-222364, C3-222409, C3-222410, C3-222411, C3-222449, C3-222508, C3-222576 | 1.5.0 | +| 2022-05 | CT3#122e | C3-223504 | | | | Inclusion of documents agreed in CT3#122e:
C3-223195, C3-223321, C3-223323, C3-223325, C3-223326, C3-223327, C3-223331, C3-223334, C3-223336, C3-223337, C3-223575, C3-223606, C3-223607, C3-223608, C3-223646, C3-223647, C3-223648, C3-223649, C3-223650, C3-223675, C3-223676, C3-223677, C3-223691, C3-223756, C3-223781, C3-223792, C3-223793, C3-223794 | 1.6.0 | +| 2022-06 | CT#96 | CP-221100 | | | | Presentation to TSG CT for approval | 2.0.0 | +| 2022-06 | CT#96 | CP-221100 | | | | Approved by TSG CT | 17.0.0 | +| 2022-09 | CT#97e | CP-222097 | 0001 | 1 | F | Corrections to Eees_EASDiscovery_TeasDiscRequest operation | 17.1.0 | +| 2022-09 | CT#97e | CP-222097 | 0002 | 1 | F | Add failure handling descriptions for EES services | 17.1.0 | +| 2022-09 | CT#97e | CP-222097 | 0003 | 1 | F | Add failure handling descriptions for ECS services | 17.1.0 | +| 2022-09 | CT#97e | CP-222097 | 0004 | 1 | F | Add redirect descriptions for EES services | 17.1.0 | +| 2022-09 | CT#97e | CP-222097 | 0005 | 1 | F | Add redirect descriptions for ECS services | 17.1.0 | +| 2022-09 | CT#97e | CP-222097 | 0006 | 1 | F | Corrections on ACRDataStatus and ACTResultInfo | 17.1.0 | +| 2022-09 | CT#97e | CP-222097 | 0007 | | F | Corrections on HTTP methods in EES services | 17.1.0 | +| 2022-09 | CT#97e | CP-222097 | 0008 | | F | Correction on OpenenAPI Eees_EECContextRelocation | 17.1.0 | +| 2022-09 | CT#97e | CP-222097 | 0009 | | F | Corrections on OpenAPI Eees_EELManagedACR | 17.1.0 | +| 2022-09 | CT#97e | CP-222098 | 0010 | 1 | F | Corrections to EES APIs definition | 17.1.0 | +| 2022-09 | CT#97e | CP-222098 | 0011 | 1 | F | Corrections to Eees_EELManagedACR API definition | 17.1.0 | +| 2022-09 | CT#97e | CP-222097 | 0012 | | F | Remove unused reference to OMA | 17.1.0 | +| 2022-09 | CT#97e | CP-222205 | 0014 | 1 | F | Correcting the name of the data type related to availability status information | 17.1.0 | +| 2022-09 | CT#97e | CP-222206 | 0015 | 2 | F | Clarifications to the "easld" | 17.1.0 | +| 2022-09 | CT#97e | CP-222098 | 0017 | 1 | F | Corrections to user consent revocation management for the Eees_UELocation API | 17.1.0 | +| 2022-09 | CT#97e | CP-222121 | 0018 | | F | Update of info and externalDocs fields | 17.1.0 | +| 2022-12 | CT#98e | CP-223170 | 0020 | 1 | F | Miscellaneous corrections in EES, ECS services | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0021 | 1 | F | Correction in Eees_EECContextRelocation, Eees_EELManagedACR API | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0022 | 1 | F | Correction in Eees_UEIdentifier, Eees_ACRManagementEvent API | 17.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------------|--------| +| 2022-12 | CT#98e | CP-223170 | 0023 | 1 | F | Corrections on easId verification in update procedures in EES services | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0027 | 1 | F | Correction on user consent procedure description | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0033 | 1 | F | Editor's note resolution for Eees_UEIdentifier | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0034 | | F | Essential correction to Application Client Information | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0035 | | F | Correction on attribute name within EndPoint | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0036 | | F | Correction on request URI for Eees_EECContextRelocation_Push | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0037 | 1 | F | Corrections on Location information report | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0039 | 1 | F | Corrections on the Notification Destination URI | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0040 | 1 | F | Corrections on the Revocation Notification URI | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0041 | 1 | F | Missing supported features for Eees_UEIdentifier API | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0042 | 1 | F | Corrections for data types of Eees_ACRManagementEvent service | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0043 | | F | Corrections for data types of Eees_SessionWithQoS service | 17.2.0 | +| 2022-12 | CT#98e | CP-223170 | 0044 | 1 | F | Corrections on presence of the attribute in UserInfo data type | 17.2.0 | +| 2022-12 | CT#98e | CP-223188 | 0050 | | F | Update of info and externalDocs fields | 17.2.0 | +| 2022-12 | CT#98e | CP-223200 | 0024 | 1 | F | Correction on eesId verification in update procedure in ECS service | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0025 | 1 | F | Correction on ACRManagementEvent_Subscribe service operation | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0026 | 1 | F | Corrections on EES UE location information description | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0028 | | F | Remove duplicated description for EELManagedACR | 18.0.0 | +| 2022-12 | CT#98e | CP-223185 | 0029 | 1 | F | Adding operationId and tags fields | 18.0.0 | +| 2022-12 | CT#98e | CP-223185 | 0030 | 1 | F | Eees_ACRManagementEvent and Eees_ACRStatusUpdate APIs: enumeration definitions | 18.0.0 | +| 2022-12 | CT#98e | CP-223185 | 0031 | 1 | F | Corrections on the description of PUT and PATCH | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0038 | 1 | F | Corrections on the apiNames | 18.0.0 | +| 2022-12 | CT#98e | CP-223185 | 0045 | 1 | F | Add the missing description fields of some attributes in the OpenAPI file | 18.0.0 | +| 2022-12 | CT#98e | CP-223190 | 0051 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230156 | 0055 | 1 | B | Updates on location reporting in Eees_UELocation API | 18.1.0 | +| 2023-03 | CT#99 | CP-230156 | 0056 | 1 | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230169 | 0057 | 1 | B | Seamless service continuity support for transport layer in the EAS | 18.1.0 | +| 2023-03 | CT#99 | CP-230138 | 0060 | 1 | A | Corrections to the EAS Type definition | 18.1.0 | +| 2023-03 | CT#99 | CP-230139 | 0061 | 1 | B | EAS profile update with general context holding time | 18.1.0 | +| 2023-03 | CT#99 | CP-230162 | 0063 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231139 | 0064 | 1 | F | Updates to the EAS type for UAS services | 18.2.0 | +| 2023-06 | CT#100 | CP-231185 | 0065 | 1 | B | Completing the support of the seamless transport layer service continuity functionality | 18.2.0 | +| 2023-06 | CT#100 | CP-231144 | 0068 | 3 | B | ACR scenario re-selection after successful ACR | 18.2.0 | +| 2023-06 | CT#100 | CP-231310 | 0069 | 2 | B | ACR Selection event and update ACR start stop event | 18.2.0 | +| 2023-06 | CT#100 | CP-231144 | 0070 | 1 | B | EEC context update with UE mobility requirement | 18.2.0 | +| 2023-06 | CT#100 | CP-231237 | 0071 | 4 | B | Update EES Profile with Instantiable EAS information | 18.2.0 | +| 2023-06 | CT#100 | CP-231144 | 0072 | 1 | B | Completion of the definition of the general context holding time duration | 18.2.0 | +| 2023-06 | CT#100 | CP-231321 | 0073 | 3 | B | Defining the EAS bundle information | 18.2.0 | +| 2023-06 | CT#100 | CP-231328 | 0075 | 2 | B | Enhancements to ACR management events | 18.2.0 | +| 2023-06 | CT#100 | CP-231144 | 0076 | 1 | B | Exposure of EAS service APIs via CAPIF | 18.2.0 | +| 2023-06 | CT#100 | CP-231144 | 0077 | | B | Support for federation and roaming | 18.2.0 | +| 2023-06 | CT#100 | CP-231312 | 0078 | 2 | B | Updates to Eees_ACRManagementEvent API | 18.2.0 | +| 2023-06 | CT#100 | CP-231144 | 0079 | 1 | B | Updates to Eees_SessionWithQoS API | 18.2.0 | +| 2023-06 | CT#100 | CP-231144 | 0080 | | B | Supporting SNPN for the EES Topological Service Area | 18.2.0 | +| 2023-06 | CT#100 | CP-231153 | 0084 | 1 | A | Correction to EndPoint | 18.2.0 | +| 2023-06 | CT#100 | CP-231153 | 0086 | | A | Correct data type in Eees_EASRegistration API | 18.2.0 | +| 2023-06 | CT#100 | CP-231144 | 0088 | 1 | B | Add consumer for Eees_UEIdentifier and support EDGE-10 | 18.2.0 | +| 2023-06 | CT#100 | CP-231139 | 0090 | | F | Corrections on certain terminology | 18.2.0 | +| 2023-06 | CT#100 | CP-231139 | 0091 | | F | Corrections on supported feature in EDGEAPP APIs | 18.2.0 | +| 2023-06 | CT#100 | CP-231144 | 0093 | 1 | B | Definition of the service description clauses of the Eees_ACRParameterInformation API | 18.2.0 | +| 2023-06 | CT#100 | CP-231144 | 0094 | 1 | B | Definition of the API clauses of the Eees_ACRParameterInformation API | 18.2.0 | +| 2023-06 | CT#100 | CP-231144 | 0095 | 1 | B | Definition of the OpenAPI description of the Eees_ACRParameterInformation API | 18.2.0 | +| 2023-06 | CT#100 | CP-231320 | 0097 | 1 | A | Corrections to the ACT start/stop event related information | 18.2.0 | +| 2023-06 | CT#100 | CP-231134 | 0098 | 1 | D | Clarifications to the EAS ID definition | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0100 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232089 | 0101 | 1 | B | Service continuity support related updates
Eecs_TargetEESDiscovery_Request service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232089 | 0102 | 1 | B | Composite EAS support related updates | 18.3.0 | +| 2023-09 | CT#101 | CP-232089 | 0103 | 1 | B | Resolving the SelectedACRScenarios data type Editor's Notes | 18.3.0 | +| 2023-09 | CT#101 | CP-232089 | 0104 | | B | Supporting the indication of service continuity planning | 18.3.0 | +| 2023-09 | CT#101 | CP-232089 | 0105 | 1 | F | Corrections to the definition of the Eees_ACRParameterInformation API | 18.3.0 | +| 2023-09 | CT#101 | CP-232089 | 0106 | | F | Instantiable EAS information related updates | 18.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232089 | 0107 | 1 | B | Selected EES declaration service descriptions and procedures | 18.3.0 | +| 2023-09 | CT#101 | CP-232089 | 0108 | 1 | B | Selected EES declaration service API Definitions | 18.3.0 | +| 2023-09 | CT#101 | CP-232254 | 0109 | 2 | B | Selected EES declaration service OpenAPI file definitions | 18.3.0 | +| 2023-09 | CT#101 | CP-232089 | 0113 | 1 | B | Update the Eecs_TargetEESDiscovery to support ECI-3 | 18.3.0 | +| 2023-09 | CT#101 | CP-232253 | 0114 | 2 | B | Update the Eecs_TargetEESDiscovery API to support ENS | 18.3.0 | +| 2023-09 | CT#101 | CP-232089 | 0115 | 1 | B | Update the Eees_EASDiscovery_TEasDiscRequest to support EAS synchronization | 18.3.0 | +| 2023-09 | CT#101 | CP-232089 | 0116 | 1 | B | Update to ACR parameter information procedure to support ECI-4 | 18.3.0 | +| 2023-09 | CT#101 | CP-232089 | 0117 | 1 | B | Update to EEC context relocation to support ECI-4 | 18.3.0 | +| 2023-09 | CT#101 | CP-232089 | 0118 | | B | Common EAS announcement | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0121 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233241 | 0089 | 5 | B | Updates to Eees_UEIdentifier API | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0122 | | B | Remove the remaining Editor's Note on EAS bundle requirements | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0123 | | B | Remove the remaining Editor's Note on the ACRScenario data type | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0124 | 3 | B | Remove the remaining Editor's Notes on the "servContPlanInd" attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0125 | | B | Remove the remaining Editor's Note on the "aclids" attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0126 | 2 | B | Complete the definition of the ACR Selection event | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0127 | | B | Resolve the remaining Editor's Note on the "teasEndPoint" attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233273 | 0129 | 1 | A | Corrections to boolean type definitions | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0130 | 1 | B | ACR Management subscription API update | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0132 | 1 | B | ACRManagementEvent - EAS ack and service continuity | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0133 | 1 | B | Updates to Common EAS Announcement service | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0134 | 1 | B | Eees_EASRegistration - EAS sync and Bundle updates | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0136 | 1 | B | Retreive EES using application group identifier | 18.4.0 | +| 2023-12 | CT#102 | CP-233287 | 0138 | 1 | F | SEALDD feature related updates | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0139 | 1 | B | Corrections and updates to the EAS bundle information | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0140 | 1 | B | Adding EDN information to the EES profile | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0141 | 1 | B | Support indicating the EAS ability of handling bundled EAS ACR | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0142 | | F | Corrections to the definition of the general context holding time duration | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0143 | 1 | B | Resolve ENs in Eees_ACRManagementEvent API | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0144 | 1 | B | Resolve ENs in Eees_SessionWithQoS API | 18.4.0 | +| 2023-12 | CT#102 | CP-233242 | 0145 | 1 | B | Update ACR management event notification | 18.4.0 | +| 2023-12 | CT#102 | CP-233231 | 0146 | | F | Miscellaneous Corrections | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0147 | 1 | B | Instantiation criteria update and add missing abbreviations | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0149 | | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29559/raw.md b/raw/rel-18/29_series/29559/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4e4fde406953d4f631d73c4e190563cf50e46013 --- /dev/null +++ b/raw/rel-18/29_series/29559/raw.md @@ -0,0 +1,2362 @@ + + +# 3GPP TS 29.559 V18.2.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; 5G ProSe Key Management Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller black letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'G' has a red signal wave icon at its base, and a small 'TM' trademark symbol is located to the right of the 'P'. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 5 Services offered by the 5G PKMF..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Npkmf_PKMFKeyRequest Service..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 ProseKey ..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.3 Npkmf_ResolveRemoteUserId Service ..... | 10 | +| 5.3.1 Service Description ..... | 10 | +| 5.3.2 Service Operations..... | 11 | +| 5.3.2.1 Introduction..... | 11 | +| 5.3.2.2 Retrieve..... | 11 | +| 5.3.2.2.1 General ..... | 11 | +| 5.4 Npkmf_Discovery Service ..... | 11 | +| 5.4.1 Service Description ..... | 11 | +| 5.4.2 Service Operations..... | 12 | +| 5.4.2.1 Introduction..... | 12 | +| 5.4.2.2 AnnounceAuthorize ..... | 12 | +| 5.4.2.2.1 General ..... | 12 | +| 5.4.2.3 MonitorKey..... | 12 | +| 5.4.2.3.1 General ..... | 12 | +| 5.4.2.4 DiscoverKey ..... | 13 | +| 5.4.2.4.1 General ..... | 13 | +| 6 API Definitions ..... | 14 | +| 6.1 Npkmf_PKMFKeyRequest Service API..... | 14 | +| 6.1.1 Introduction ..... | 14 | +| 6.1.2 Usage of HTTP..... | 14 | +| 6.1.2.1 General..... | 14 | +| 6.1.2.2 HTTP standard headers..... | 14 | +| 6.1.2.2.1 General ..... | 14 | +| 6.1.2.2.2 Content type ..... | 14 | +| 6.1.2.3 HTTP custom headers..... | 15 | +| 6.1.3 Resources..... | 15 | +| 6.1.3.1 Overview..... | 15 | +| 6.1.3.2 Resource: ProSe Keys Collection..... | 15 | +| 6.1.3.2.1 Description ..... | 15 | +| 6.1.3.2.2 Resource Definition..... | 15 | +| 6.1.3.2.3 Resource Standard Methods..... | 16 | +| 6.1.3.2.4 Resource Custom Operations..... | 16 | +| 6.1.3.2.4.1 Overview ..... | 16 | +| 6.1.3.2.4.2 Operation: request ..... | 16 | +| 6.1.3.2.4.2.1 Description..... | 16 | +| 6.1.3.2.4.2.2 Operation Definition..... | 16 | +| 6.1.4 Custom Operations without associated resources ..... | 17 | + +| | | | +|-----------|----------------------------------------------------------------------------------|----| +| 6.1.5 | Notifications ..... | 17 | +| 6.1.6 | Data Model ..... | 17 | +| 6.1.6.1 | General ..... | 17 | +| 6.1.6.2 | Structured data types ..... | 18 | +| 6.1.6.2.1 | Introduction ..... | 18 | +| 6.1.6.2.2 | Type: ProseKeyReqData ..... | 18 | +| 6.1.6.2.3 | Type: ProseKeyRspData ..... | 19 | +| 6.1.6.3 | Simple data types and enumerations ..... | 19 | +| 6.1.6.3.1 | Introduction ..... | 19 | +| 6.1.6.3.2 | Simple data types ..... | 19 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 20 | +| 6.1.6.5 | Binary data ..... | 20 | +| 6.1.7 | Error Handling ..... | 20 | +| 6.1.7.1 | General ..... | 20 | +| 6.1.7.2 | Protocol Errors ..... | 21 | +| 6.1.7.3 | Application Errors ..... | 21 | +| 6.1.8 | Feature negotiation ..... | 21 | +| 6.1.9 | Security ..... | 21 | +| 6.1.10 | HTTP redirection ..... | 21 | +| 6.2 | Npkmf_ResolveRemoteUserId Service API ..... | 22 | +| 6.2.1 | Introduction ..... | 22 | +| 6.2.2 | Usage of HTTP ..... | 22 | +| 6.2.2.1 | General ..... | 22 | +| 6.2.2.2 | HTTP standard headers ..... | 22 | +| 6.2.2.2.1 | General ..... | 22 | +| 6.2.2.2.2 | Content type ..... | 22 | +| 6.2.2.3 | HTTP custom headers ..... | 22 | +| 6.2.3 | Resources ..... | 23 | +| 6.2.3.1 | Overview ..... | 23 | +| 6.2.4 | Custom Operations without associated resources ..... | 23 | +| 6.2.4.1 | Overview ..... | 23 | +| 6.2.4.2 | Operation: resolve-id ..... | 23 | +| 6.2.4.2.1 | Description ..... | 23 | +| 6.2.4.2.2 | Operation Definition ..... | 23 | +| 6.2.5 | Notifications ..... | 24 | +| 6.2.6 | Data Model ..... | 24 | +| 6.2.6.1 | General ..... | 24 | +| 6.2.6.2 | Structured data types ..... | 25 | +| 6.2.6.2.1 | Introduction ..... | 25 | +| 6.2.6.2.2 | Type: ResolveRequest ..... | 25 | +| 6.2.6.2.3 | Type: ResolveResponse ..... | 25 | +| 6.2.6.3 | Simple data types and enumerations ..... | 25 | +| 6.2.6.4 | Data types describing alternative data types or combinations of data types ..... | 25 | +| 6.2.6.5 | Binary data ..... | 25 | +| 6.2.7 | Error Handling ..... | 26 | +| 6.2.7.1 | General ..... | 26 | +| 6.2.7.2 | Protocol Errors ..... | 26 | +| 6.2.7.3 | Application Errors ..... | 26 | +| 6.2.8 | Feature negotiation ..... | 26 | +| 6.2.9 | Security ..... | 26 | +| 6.2.10 | HTTP redirection ..... | 26 | +| 6.3 | Npkmf_Discovery Service API ..... | 27 | +| 6.3.1 | Introduction ..... | 27 | +| 6.3.2 | Usage of HTTP ..... | 27 | +| 6.3.2.1 | General ..... | 27 | +| 6.3.2.2 | HTTP standard headers ..... | 27 | +| 6.3.2.2.1 | General ..... | 27 | +| 6.3.2.2.2 | Content type ..... | 27 | +| 6.3.2.3 | HTTP custom headers ..... | 28 | +| 6.3.3 | Resources ..... | 28 | +| 6.3.3.1 | Overview ..... | 28 | + +| | | | +|-------------------------------|----------------------------------------------------------------------------------|-----------| +| 6.3.3.2 | Resource: AnnounceAuthorize ..... | 29 | +| 6.3.3.2.1 | Description ..... | 29 | +| 6.3.3.2.2 | Resource Definition..... | 29 | +| 6.3.3.2.3 | Resource Standard Methods..... | 29 | +| 6.3.3.3 | Resource: MonitorKey..... | 31 | +| 6.3.3.3.1 | Description ..... | 31 | +| 6.3.3.3.2 | Resource Definition..... | 31 | +| 6.3.3.3.3 | Resource Standard Methods..... | 31 | +| 6.3.3.4 | Resource: DiscoveryKey ..... | 33 | +| 6.3.3.4.1 | Description ..... | 33 | +| 6.3.3.4.2 | Resource Definition..... | 33 | +| 6.3.3.4.3 | Resource Standard Methods..... | 33 | +| 6.3.4 | Custom Operations without associated resources ..... | 35 | +| 6.3.5 | Notifications ..... | 35 | +| 6.3.6 | Data Model ..... | 35 | +| 6.3.6.1 | General..... | 35 | +| 6.3.6.2 | Structured data types..... | 36 | +| 6.3.6.2.1 | Introduction ..... | 36 | +| 6.3.6.2.2 | Type: AnnounceAuthData..... | 36 | +| 6.3.6.2.3 | Type: MonitorKeyReqData..... | 36 | +| 6.3.6.2.4 | Type: MonitorKeyRespData ..... | 36 | +| 6.3.6.2.5 | Type: DiscoveryKeyReqData ..... | 36 | +| 6.3.6.2.6 | Type: DiscoveryKeyRespData..... | 36 | +| 6.3.6.2.7 | Type: DiscSecMaterials ..... | 37 | +| 6.3.6.3 | Simple data types and enumerations..... | 37 | +| 6.3.6.3.1 | Introduction ..... | 37 | +| 6.3.6.3.2 | Simple data types ..... | 37 | +| 6.3.6.4 | Data types describing alternative data types or combinations of data types ..... | 37 | +| 6.3.6.5 | Binary data..... | 38 | +| 6.3.7 | Error Handling..... | 38 | +| 6.3.7.1 | General..... | 38 | +| 6.3.7.2 | Protocol Errors ..... | 38 | +| 6.3.7.3 | Application Errors..... | 38 | +| 6.3.8 | Feature negotiation ..... | 38 | +| 6.3.9 | Security..... | 38 | +| 6.3.10 | HTTP redirection..... | 39 | +| Annex A (normative): | OpenAPI specification ..... | 39 | +| A.1 | General..... | 39 | +| A.2 | Npkmf_PKMFKeyRequest API ..... | 39 | +| A.3 | Npkmf_ResolveRemoteUserId API..... | 41 | +| A.4 | Npkmf_Discovery API ..... | 43 | +| Annex B (informative): | Change history..... | 49 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document +- might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +- is** (or any other verb in the indicative mood) indicates a statement of fact +- is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Npkmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the 5G PKMF as specified in 3GPP TS 33.503 [4]. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [5] and 3GPP TS 29.501 [6]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 33.503: "Security Aspects of Proximity based Services (ProSe) in the 5G System (5GS)". +- [5] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [6] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [7] OpenAPI : "OpenAPI Specification Version 3.0.0", . +- [8] IETF RFC 9113: "HTTP/2". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] IETF RFC 9457: "Problem Details for HTTP APIs". +- [11] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [12] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [13] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [14] 3GPP TR 21.900: "Technical Specification Group working methods". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [16] 3GPP TS 24.554: "Proximity-services (ProSe) in 5G System (5GS) protocol aspects; Stage 3". +- [17] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [18] 3GPP TS 29.509: "5G System; Authentication Server Services; Stage 3". + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Symbols + +Void + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|--------------------------------------| +| 5G PKMF | 5G ProSe Key Management Function | +| 5G ProSe | 5G Proximity based Services | +| RPAUID | Restricted ProSe Application User ID | +| PDUID | ProSe Discovery UE ID | +| UP-PRUK | User Plane ProSe Remote User Key | + +# 4 Overview + +The 5G ProSe Key Management Function (5G PKMF) is the logical function handling network related actions required for the key management and the security material for discovery of a 5G ProSe UE-to-Network Relay by a 5G ProSe Remote UE, for establishing a secure PC5 communication link between a 5G ProSe Remote UE and 5G ProSe UE-to-Network Relay, for discovery of a 5G ProSe UE-to-UE Relay by a 5G ProSe End UE, and for establishing a secure PC5 communication link between a 5G ProSe End UE and a 5G ProSe UE-to-UE Relay (see 3GPP TS 33.503 [4]). + +Figure 4-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the 5G PKMF: + +![Figure 4-1: Reference model – 5G PKMF. The diagram shows two entities on the left, PKMF and SMF, connected to a single entity on the right, PKMF. The top connection is labeled Npc9 and the bottom connection is labeled Npc13. The right PKMF entity is highlighted with a green background.](18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg) + +``` + +graph LR + PKMF_L[PKMF] -- Npc9 --> PKMF_R((Npkmf | PKMF)) + SMF[SMF] -- Npc13 --> PKMF_R + style PKMF_R fill:#90EE90 + +``` + +Figure 4-1: Reference model – 5G PKMF. The diagram shows two entities on the left, PKMF and SMF, connected to a single entity on the right, PKMF. The top connection is labeled Npc9 and the bottom connection is labeled Npc13. The right PKMF entity is highlighted with a green background. + +Figure 4-1: Reference model – 5G PKMF + +The functionalities supported by the 5G PKMF are listed in clause 4.2.1.2 of 3GPP TS 33.503 [4]. + +# 5 Services offered by the 5G PKMF + +## 5.1 Introduction + +The table 5.1-1 shows the 5G PKMF Services and 5G PKMF Service Operations: + +**Table 5.1-1: List of 5G PKMF Services** + +| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | +|---------------------------|--------------------|---------------------|---------------------| +| Npkmf_PKMFKeyRequest | ProseKey | Request/Response | 5G PKMF | +| Npkmf_ResolveRemoteUserId | Retrieve | Request/Response | SMF, 5G PKMF | +| Npkmf_Discovery | AnnounceAuthorize | Request/Response | 5G PKMF | +| | MonitorKey | Request/Response | 5G PKMF | +| | DiscoveryKey | Request/Response | 5G PKMF | + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------------|--------|-------------------------------------|-----------------------------------|------------------|-------| +| Npkmf_PKMFKeyRequest | 6.1 | PKMF Key Request Service | TS29559_Npkmf_PKMFKeyRequest.yaml | npkmf-keyrequest | A.2 | +| Npkmf_ResolveRemoteUserId | 6.2 | PKMF Resolve Remote User ID Service | TS29559_Npkmf_UserId.yaml | npkmf-userid | A.3 | +| Npkmf_Discovery | 6.3 | PKMF Discovery Service | TS29559_Npkmf_Discovery.yaml | npkmf-disc | A.4 | + +## 5.2 Npkmf\_PKMFKeyRequest Service + +### 5.2.1 Service Description + +This service enables an NF (i.e. another 5G PKMF in another PLMN) to request information related to 5G ProSe keying. The following are the key functionalities of this NF service. + +- Provide 5G ProSe related keying material + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +#### 5.2.2.2 ProseKey + +##### 5.2.2.2.1 General + +The ProseKey service operation is invoked by a NF Service Consumer, i.e. another 5G PKMF in another PLMN, towards the 5G PKMF to retrieve the keying material related to 5G ProSe. + +The ProseKey service operation is used during the following procedure: + +- PC5 security establishment for 5G ProSe UE-to-Network relay communication over User Plane (see 3GPP TS 33.503 [4], clause 6.3.3.2.2) + +The NF Service Consumer (i.e. another 5G PKMF in another PLMN) shall retrieve the 5G ProSe related keying material by invoking the "request" custom method on the resource URI of "Prose Keys Collection" resource, see clause 6.1.3.2.4. See also Figure 5.2.2.2.1-1. + +![Sequence diagram showing the ProseKey service operation between an NF Service Consumer and a 5G PKMF. The sequence consists of four steps: 1. POST .../prose-keys/request (ProseKeyReqData) from NF Service Consumer to 5G PKMF; 2a. 200 OK (ProseKeyRspData) from 5G PKMF to NF Service Consumer; 2b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) from 5G PKMF to NF Service Consumer; 3. POST .../prose-keys/request (ProseKeyReqData) from NF Service Consumer to 5G PKMF; 4a. 200 OK (ProseKeyRspData) from 5G PKMF to NF Service Consumer; 4b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) from 5G PKMF to NF Service Consumer.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G PKMF + Note left of NF Service Consumer: 1. POST .../prose-keys/request (ProseKeyReqData) + NF Service Consumer->>5G PKMF: 1. POST .../prose-keys/request (ProseKeyReqData) + Note right of 5G PKMF: 2a. 200 OK (ProseKeyRspData) + 5G PKMF-->>NF Service Consumer: 2a. 200 OK (ProseKeyRspData) + Note right of 5G PKMF: 2b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) + 5G PKMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) + Note left of NF Service Consumer: 3. POST .../prose-keys/request (ProseKeyReqData) + NF Service Consumer->>5G PKMF: 3. POST .../prose-keys/request (ProseKeyReqData) + Note right of 5G PKMF: 4a. 200 OK (ProseKeyRspData) + 5G PKMF-->>NF Service Consumer: 4a. 200 OK (ProseKeyRspData) + Note right of 5G PKMF: 4b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) + 5G PKMF-->>NF Service Consumer: 4b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) + +``` + +Sequence diagram showing the ProseKey service operation between an NF Service Consumer and a 5G PKMF. The sequence consists of four steps: 1. POST .../prose-keys/request (ProseKeyReqData) from NF Service Consumer to 5G PKMF; 2a. 200 OK (ProseKeyRspData) from 5G PKMF to NF Service Consumer; 2b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) from 5G PKMF to NF Service Consumer; 3. POST .../prose-keys/request (ProseKeyReqData) from NF Service Consumer to 5G PKMF; 4a. 200 OK (ProseKeyRspData) from 5G PKMF to NF Service Consumer; 4b. 4xx/5xx (ProblemDetails) or 3xx (RedirectResponse) from 5G PKMF to NF Service Consumer. + +**Figure 5.2.2.2.1-1 ProseKey service operation** + +1. The NF Service Consumer shall send a HTTP POST request to invoke "request" custom method. The payload of the request shall be an object of "ProseKeyReqData" data type. The payload shall include the Relay Service Code, the KNRP freshness parameter 1, and either the SUCI of the 5G ProSe UE (Remote UE or End UE) or the UP-PRUK ID. +- 2a. On success, the 5G PKMF shall respond with the status code "200 OK". The payload of the response shall be an object of "ProseKeyRspData" data type. They payload shall include the KNRP, the KNRP freshness parameter 2 and optionally the GPI. +- 2b. On failure or redirection, one of the HTTP status codes listed in table 6.1.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in table 6.1.3.2.4.2.2-2. +3. [conditional] If synchronization failed when UE processes the authentication challenge in the GPI and a subsequent Key Request is send for resynchronization, the NF Service Consumer shall send a HTTP POST request to invoke "request" custom method. The payload of the request shall be an object of "ProseKeyReqData" data type. The payload shall include the Relay Service Code, the KNRP freshness parameter 1, the information for resynchronization (RAND and AUTS). +- 4a. On success, the 5G PKMF shall respond with the status code "200 OK". The payload of the response shall be an object of "ProseKeyRspData" data type. They payload shall include the KNRP, the KNRP freshness parameter 2 and the GPI. +- 4b. On failure or redirection, one of the HTTP status codes listed in table 6.1.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in table 6.1.3.2.4.2.2-2. + +## 5.3 Npkmf\_ResolveRemoteUserId Service + +### 5.3.1 Service Description + +The Npkmf\_ResolveRemoteUserId service enables a NF to request the 5G PKMF to resolve Remote User ID (i.e., UP-PRUK ID) to SUPI. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operation defined for the Npkmf\_ResolveRemoteUserId service is as follows: + +- Retrieve: It allows a consumer NF to get an user's SUPI from Remote User ID. + +#### 5.3.2.2 Retrieve + +##### 5.3.2.2.1 General + +The Retrieve service operation is used during the following procedure: + +- PC5 security establishment for 5G ProSe UE-to-Network relay communication over User Plane (see 3GPP TS 33.503 [4], clause 6.3.3.2.2) + +The NF Service Consumer (e.g., SMF, 5G PKMF) shall request the 5G PKMF to get the SUPI of a 5G ProSe Remote UE as shown in Figure 5.3.2.2.1-1 + +![Sequence diagram showing the request and response between an NF service consumer and a 5G PKMF for resolving a remote user ID.](ca7c7526ec57cd5a2f278c194c0a6a00_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant 5G PKMF + Note left of NF service consumer: Requesting the SUPI of a ProSe Remote UE + NF service consumer->>5G PKMF: 1. POST.../resolve-id (ResolveRequest) + Note right of 5G PKMF: 2a. 200 OK (ResolveResponse) + Note right of 5G PKMF: 2b. 404 Not Found + 5G PKMF-->>NF service consumer: 2a. 200 OK (ResolveResponse) + 5G PKMF-->>NF service consumer: 2b. 404 Not Found +``` + +Sequence diagram showing the request and response between an NF service consumer and a 5G PKMF for resolving a remote user ID. + +**Figure 5.3.2.2.1-1: Requesting the SUPI of a ProSe Remote UE** + +1. The NF service consumer (e.g., SMF, 5G PKMF) sends a POST request to the resource representing the resolve-id custom operation. The request body shall contain the UP-PRUK ID. +- 2a. On success, the 5G PKMF responds with "200 OK" with the message body containing the corresponding SUPI. +- 2b. If there is no valid data, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body. + +## 5.4 Npkmf\_ Discovery Service + +### 5.4.1 Service Description + +This service enables an NF (i.e. another 5G PKMF in another PLMN) to request authorization information. The following are the key functionalities of this NF service. + +- Provide the authorization from the 5G PKMF for announcing in the PLMN +- Provide the discovery key from the 5G PKMF for monitoring in the PLMN +- Provide the discovery key from the 5G PKMF for a discoverer UE in the PLMN to operate Model B restricted discovery + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +The Npkmf\_Discovery service supports following service operations: + +- AnnounceAuthorize +- MonitorKey +- DiscoveryKey + +#### 5.4.2.2 AnnounceAuthorize + +##### 5.4.2.2.1 General + +The AnnounceAuthorize service operation is invoked by a NF Service Consumer, i.e. another 5G PKMF in another PLMN, towards the 5G PKMF to retrieve the authorization from the 5G PKMF for announcing in the PLMN. + +The NF Service Consumer (e.g., 5G PKMF) shall request the 5G PKMF to get authorization as shown in Figure 5.4.2.2.1-1 + +![Sequence diagram for AnnounceAuthorize service operation. The diagram shows an NF service consumer sending a PUT request to a 5G PKMF. The request is labeled '1. PUT.../{ueId}/announce-authorize/{userInfoId} (AnnounceAuthData)'. The 5G PKMF responds with three possible options: '2a. 201 Created (AnnounceAuthData)', '2b. 204 No Content', and '2c. 4xx/5xx (ProblemDetails) Or 3xx'. The responses are shown as arrows pointing back to the consumer.](63e0c22852c26699d0bd095a2d796bab_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant 5G PKMF + Note right of NF service consumer: 1. PUT.../{ueId}/announce-authorize/{userInfoId} +(AnnounceAuthData) + NF service consumer->>5G PKMF: Request + Note right of 5G PKMF: 2a. 201 Created (AnnounceAuthData) +2b. 204 No Content +2c. 4xx/5xx (ProblemDetails) Or 3xx + 5G PKMF-->>NF service consumer: Response + +``` + +Sequence diagram for AnnounceAuthorize service operation. The diagram shows an NF service consumer sending a PUT request to a 5G PKMF. The request is labeled '1. PUT.../{ueId}/announce-authorize/{userInfoId} (AnnounceAuthData)'. The 5G PKMF responds with three possible options: '2a. 201 Created (AnnounceAuthData)', '2b. 204 No Content', and '2c. 4xx/5xx (ProblemDetails) Or 3xx'. The responses are shown as arrows pointing back to the consumer. + +**Figure 5.4.2.2.1-1: Announce Authorize** + +1. The NF service consumer (e.g., 5G PKMF) sends a HTTP PUT request to the resource representing the announce-authorize custom operation. The request body shall contain the RSC. +- 2a. If the context indicated by the userInfoId doesn't exist, the 5G PKMF shall create the new resource, and upon success of creation of the resource, "201 created" shall be returned. +- 2b. If the context indicated by the userInfoId already exists, the 5G PKMF shall replace the stored data using the received data, and upon success of the update of the resource, "204 No Content" shall be returned. +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.3.3.2.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.3.3.2.3.1-3. + +#### 5.4.2.3 MonitorKey + +##### 5.4.2.3.1 General + +The MonitorKey service operation is invoked by a NF Service Consumer, i.e. another 5G PKMF in another PLMN, towards the 5G PKMF to retrieve the discovery key from the 5G PKMF for monitoring in the PLMN. + +The NF Service Consumer (e.g., 5G PKMF) shall request the 5G PKMF to get authorization as shown in Figure 5.4.2.3.1-1 + +![Sequence diagram for Figure 5.4.2.3.2-1: Monitor Key. The diagram shows an NF Service Consumer sending a PUT request to a 5G PKMF. The request is '1. PUT .../{ueId}/monitor-key/{userInfoId} (MonitorKeyReqData)'. The 5G PKMF responds with '2a. 201 Created (MonitorKeyRespData)', '2b. 204 No Content', or '2c. 4xx/5xx (ProblemDetails) Or 3xx'.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G PKMF + Note left of NF Service Consumer: 1. PUT .../{ueId}/monitor-key/{userInfoId} (MonitorKeyReqData) + NF Service Consumer->>5G PKMF: Request + Note right of 5G PKMF: 2a. 201 Created (MonitorKeyRespData) +2b. 204 No Content +2c. 4xx/5xx (ProblemDetails) Or 3xx + 5G PKMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for Figure 5.4.2.3.2-1: Monitor Key. The diagram shows an NF Service Consumer sending a PUT request to a 5G PKMF. The request is '1. PUT .../{ueId}/monitor-key/{userInfoId} (MonitorKeyReqData)'. The 5G PKMF responds with '2a. 201 Created (MonitorKeyRespData)', '2b. 204 No Content', or '2c. 4xx/5xx (ProblemDetails) Or 3xx'. + +Figure 5.4.2.3.2-1: Monitor Key + +1. The NF Service Consumer (e.g., 5G PKMF) shall send an HTTP PUT request to the resource representing the monitor-key custom operation. The request body shall contain the RSC and PC5 UE security capability. +- 2a. If the context indicated by the userInfoId doesn't exist, the 5G PKMF shall create the new resource, and upon success of creation of the resource, "201 created" shall be returned. +- 2b. If the context indicated by the userInfoId already exists, the 5G PKMF shall replace the stored data using the received data, and upon success of the update of the resource, "204 No Content" shall be returned. +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.3.3.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.3.3.3.1-3. + +#### 5.4.2.4 DiscoverKey + +##### 5.4.2.4.1 General + +The DiscoverKey service operation is invoked by a NF Service Consumer, i.e. another 5G PKMF in another PLMN, towards the 5G PKMF to retrieve the discovery key from the 5G PKMF for a discoverer UE in the PLMN to operate Model B restricted discovery. + +The NF Service Consumer (e.g., 5G PKMF) shall request the 5G PKMF to get authorization as shown in Figure 5.4.2.4.1-1 + +![Sequence diagram for Figure 5.4.2.4.2-1: Discover Key. The diagram shows an NF Service Consumer sending a PUT request to a 5G PKMF. The request is '1. PUT .../{ueId}/discovery-key/{userInfoId} (DiscoveryKeyReqData)'. The 5G PKMF responds with '2a. 201 Created (DiscoveryKeyRespData)', '2b. 204 No Content', or '2c. 4xx/5xx (ProblemDetails) Or 3xx'.](2e399449b7f62d40167a65ca88888917_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant 5G PKMF + Note left of NF Service Consumer: 1. PUT .../{ueId}/discovery-key/{userInfoId} (DiscoveryKeyReqData) + NF Service Consumer->>5G PKMF: Request + Note right of 5G PKMF: 2a. 201 Created (DiscoveryKeyRespData) +2b. 204 No Content +2c. 4xx/5xx (ProblemDetails) Or 3xx + 5G PKMF-->>NF Service Consumer: Response + +``` + +Sequence diagram for Figure 5.4.2.4.2-1: Discover Key. The diagram shows an NF Service Consumer sending a PUT request to a 5G PKMF. The request is '1. PUT .../{ueId}/discovery-key/{userInfoId} (DiscoveryKeyReqData)'. The 5G PKMF responds with '2a. 201 Created (DiscoveryKeyRespData)', '2b. 204 No Content', or '2c. 4xx/5xx (ProblemDetails) Or 3xx'. + +Figure 5.4.2.4.2-1: Discover Key + +1. The NF Service Consumer (e.g., 5G PKMF) shall send an HTTP PUT request to the resource representing the monitor-key custom operation. The request body shall contain the RSC and PC5 UE security capability. +- 2a. If the context indicated by the userInfoId doesn't exist, the 5G PKMF shall create the new resource, and upon success of creation of the resource, "201 created" shall be returned. +- 2b. If the context indicated by the userInfoId already exists, the 5G PKMF shall replace the stored data using the received data, and upon success of the update of the resource, "204 No Content" shall be returned. +- 2c. On failure or redirection, one of the HTTP status code listed in Table 6.3.3.3.1-3 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.3.3.3.1-3. + +# --- 6 API Definitions + +## 6.1 Npkmf\_PKMFKeyRequest Service API + +### 6.1.1 Introduction + +The Npkmf\_PKMFKeyRequest shall use the Npkmf\_PKMFKeyRequest API. + +The API URI of the Npkmf\_PKMFKeyRequest API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "npkmf-keyrequest". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [7] specification of HTTP messages and content bodies for the Npkmf\_PKMFKeyRequest API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [9], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [5]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [10]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [5] shall be applicable, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [5] may be supported. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 describes the resource URI structure of the Npkmf\_PKMFKeyRequest API. + +![Diagram showing the resource URI structure of the Npkmf_PKMFKeyRequest API. The root is {apiRoot}/npkmf-keyrequest/. A branch from this root leads to /prose-keys. From /prose-keys, another branch leads to /request, which is enclosed in a dashed box.](a7c51c18111139f9aca2805114108565_img.jpg) + +``` + + {apiRoot}/npkmf-keyrequest/ + | + └─ /prose-keys + | + └─ /request + +``` + +Diagram showing the resource URI structure of the Npkmf\_PKMFKeyRequest API. The root is {apiRoot}/npkmf-keyrequest/. A branch from this root leads to /prose-keys. From /prose-keys, another branch leads to /request, which is enclosed in a dashed box. + +**Figure 6.1.3.1-1: Resource URI structure of the Npkmf\_PKMFKeyRequest API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------|--------------|---------------------------------|----------------------------| +| ProSe Keys Collection | /prose-keys | request (POST) | ProseKey service operation | + +#### 6.1.3.2 Resource: ProSe Keys Collection + +##### 6.1.3.2.1 Description + +This resource represents the collection of the ProSe Keys managed by the 5G PKMF. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}///prose-keys + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +There is no standard method supported by the resource. + +##### 6.1.3.2.4 Resource Custom Operations + +##### 6.1.3.2.4.1 Overview + +**Table 6.1.3.2.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|-----------------------|--------------------|----------------------------| +| request | {resourceUri}/request | POST | ProseKey service operation | + +###### 6.1.3.2.4.2 Operation: request + +###### 6.1.3.2.4.2.1 Description + +This custom operation requests the keying material related to 5G ProSe in the 5G PKMF. + +###### 6.1.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2. + +**Table 6.1.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-------------------------------------------------------------| +| ProseKeyReqData | M | 1 | Representation of the input to request the keying material. | + +**Table 6.1.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProseKeyRspData | M | 1 | 200 OK | Representation of the successfully requested keying material. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Not Found | The "cause" attribute shall be set to one of the following application error:
- UE_NOT_AUTHORIZED
See table 6.1.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute shall be set to one of the following application error:
- UE_NOT_FOUND
See table 6.1.7.3-1 for the description of these errors. | + +NOTE1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G PKMF or 5G PKMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target 5G PKMF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G PKMF or 5G PKMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target 5G PKMF (service) instance ID towards which the request is redirected | + +### 6.1.4 Custom Operations without associated resources + +There is no custom operation without associated resources supported in Npkmf\_PKMFKeyRequest Service. + +### 6.1.5 Notifications + +There is no notification defined for Npkmf\_PKMFKeyRequest service. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Npkmf\_PKMFKeyRequest service based interface protocol. + +**Table 6.1.6.1-1: Npkmf\_PKMFKeyRequest specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|---------------------------------------------------------------|---------------| +| ProseKeyReqData | 6.1.6.2.2 | Representation of the input to request the keying material. | | +| ProseKeyRspData | 6.1.6.2.3 | Representation of the successfully requested keying material. | | +| PrukId | 6.1.6.3 | User Plane Prose Remote User Key ID | | +| Knrp | 6.1.6.3 | Key for NR PC5 | | +| KnrpFreshnessParameter1 | 6.1.6.3 | KNRP Freshness Parameter 1 | | +| KnrpFreshnessParameter2 | 6.1.6.3 | KNRP Freshness Parameter 2 | | +| Gpi | 6.1.6.3 | GBA Push Information | | + +Table 6.1.6.1-2 specifies data types re-used by the Npkmf\_PKMFKeyRequest service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Npkmf\_PKMFKeyRequest service based interface. + +Table 6.1.6.1-2: Npkmf\_PKMFKeyRequest re-used Data Types + +| Data type | Reference | Comments | Applicability | +|-----------------------|---------------------|-------------------------------|---------------| +| RelayServiceCode | 3GPP TS 29.571 [15] | Relay Service Code | | +| ResynchronizationInfo | 3GPP TS 29.503 [17] | Resynchronization Information | | +| Suci | 3GPP TS 29.509 [18] | String contains the SUCI | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: ProseKeyReqData + +Table 6.1.6.2.2-1: Definition of type ProseKeyReqData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| relayServCode | RelayServiceCode | M | 1 | This IE shall indicate the Relay Service Code from the 5G ProSe Remote UE or the 5G ProSe End UE. | | +| knrpFreshness1 | KnrpFreshness Parameter1 | M | 1 | This IE shall carry the KNRP Freshness Parameter 1 in the 5G ProSe Remote UE or the 5G ProSe End UE. | | +| resyncInfo | ResynchronizationInfo | C | 0..1 | This IE shall be present in service request for subsequent key request handling synchronization failure.

When present, this IE shall carry information (RAND, AUTS) from the 5G ProSe Remote UE or the 5G ProSe End UE related to the synchronization Failure. | | +| prukId | PrukId | C | 0..1 | This IE may be present in service request for initial key request.

When present, this IE shall indicate the UP-PRUK ID from the 5G ProSe Remote UE or the 5G ProSe End UE.
(See NOTE) | | +| suci | Suci | C | 0..1 | This IE may be present in service request for initial key request.

When present, this IE shall carry the SUCI of the 5G ProSe Remote UE or the 5G ProSe End UE
(See NOTE). | | + +NOTE: Either prukId IE or suci IE shall be present in service request for initial key request. + +##### 6.1.6.2.3 Type: ProseKeyRspData + +Table 6.1.6.2.3-1: Definition of type ProseKeyRspData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------|---------------| +| knrp | Knrp | M | 1 | This IE shall carry the K NRP derived by the 5G PKMF. | | +| knrpFreshness2 | KnrpFreshness Parameter2 | M | 1 | This IE shall carry the K NRP Freshness Parameter 2 generated by the 5G PKMF. | | +| gpi | Gpi | C | 0..1 | This IE shall be present if GPI is generated or requested.

When present, this IE shall carry the GPI. | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +Table 6.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| PrukId | string | User Plane Prose Remote User Key ID

String type as defined in OpenAPI Specification [7], carrying the value of the "UP-PRUK ID" parameter via PC8 (with "xs:string" type in XML schema) as specified in clause 11.6.2.3 of 3GPP TS 24.554 [16]. | | +| Knrp | string | Key for NR PC5

String type as defined in OpenAPI Specification [7], carrying the value of the "KNRP" parameter via PC8 (with "xs:hexBinary" type in XML schema) as specified in clause 11.6.2.25 of 3GPP TS 24.554 [16]. | | +| KnrpFreshnessParameter1 | string | KNRP Freshness Parameter 1

String type as defined in OpenAPI Specification [7], carrying the value of the "KNRP freshness parameter 1" parameter via PC8 (with "xs:hexBinary" type in XML schema) as specified in clause 11.6.2.22 of 3GPP TS 24.554 [16]. | | +| KnrpFreshnessParameter2 | string | KNRP Freshness Parameter 2

String type as defined in OpenAPI Specification [7], carrying the value of the "KNRP freshness parameter 2" parameter via PC8 (with "xs:hexBinary" type in XML schema) as specified in clause 11.6.2.26 of 3GPP TS 24.554 [16]. | | +| Gpi | string | GBA Push Information

String type as defined in OpenAPI Specification [7], carrying the value of the "GPI" parameter via PC8 (with "xs:hexBinary" type in XML schema) as specified in clause 11.6.2.16 of 3GPP TS 24.554 [16]. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There is no data type describing alternative data types or combinations of data types in Npkmf\_PKMFKeyRequest Service. + +#### 6.1.6.5 Binary data + +There is no binary data type in Npkmf\_PKMFKeyRequest Service. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Npkmf\_PKMFKeyRequest API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [5]. + +In addition, the requirements in the following clauses are applicable for the Npkmf\_PKMFKeyRequest API. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [5]. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Npkmf\_PKMFKeyRequest service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|----------------------------------------------------------------------------------------| +| UE_NOT_AUTHORIZED | 403 Forbidden | The UE is not authorized for the requested service. | +| UE_NOT_FOUND | 404 Not Found | The UE indicated by the SUCI or related to the UP-PRUK ID is not found in the 5G PKMF. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Npkmf\_PKMFKeyRequest API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| N/A | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [11] and 3GPP TS 29.500 [5], the access to the Npkmf\_PKMFKeyRequest API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [12]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Npkmf\_PKMFKeyRequest API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [13], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Npkmf\_PKMFKeyRequest service. + +The Npkmf\_PKMFKeyRequest API defines a single scope "npkmf-keyrequest" for OAuth2 authorization (as specified in 3GPP TS 33.501 [11]) for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different 5G PKMF service instance, within the same 5G PKMF or a different 5G PKMF of an 5G PKMF set, e.g. when an 5G PKMF service instance is part of an 5G PKMF (service) set or when using indirect communications (see 3GPP TS 29.500 [5]). + +An SCP that reselects a different 5G PKMF producer instance will return the NF Instance ID of the new 5G PKMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [5]. + +If an 5G PKMF within an 5G PKMF set redirects a service request to a different 5G PKMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new 5G PKMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +## 6.2 Npkmf\_ResolveRemoteUserId Service API + +### 6.2.1 Introduction + +The Npkmf\_ResolveRemoteUserId service shall use the Npkmf\_ResolveRemoteUserId API. + +The API URI of the Npkmf\_ResolveRemoteUserId API shall be: + +**{apiRoot}
** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "npkmf-userid". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [7] specification of HTTP messages and content bodies for the Npkmf\_ResolveRemoteUserId API is contained in Annex A.3. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +##### 6.2.2.2.2 Content type + +JSON, IETF RFC 8259 [9], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [5]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [10]. + +#### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [5] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [5] may be supported. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.2.3.1-1 depicts the resource URIs structure for the Npkmf\_ResolveRemoteUserId API. + +![Diagram showing the resource URI structure for the Npkmf_ResolveRemoteUserId API. It consists of two rounded rectangular boxes. The top box contains the text '{apiRoot}/npkmf-userid/{apiVersion}'. A line descends from the bottom of this box and turns right to point at the second box, which contains the text '/resolve-id'.](86b4670fc1a5a694821ee92b99c1209a_img.jpg) + +Diagram showing the resource URI structure for the Npkmf\_ResolveRemoteUserId API. It consists of two rounded rectangular boxes. The top box contains the text '{apiRoot}/npkmf-userid/{apiVersion}'. A line descends from the bottom of this box and turns right to point at the second box, which contains the text '/resolve-id'. + +**Figure 6.2.3.1-1: Resource URI structure of the Npkmf\_ResolveRemoteUserId API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|--------------|---------------------------------|-------------| +| | | | | + +### 6.2.4 Custom Operations without associated resources + +#### 6.2.4.1 Overview + +The URI structure for Custom Operations without associated resources is included as part of the Figure 6.2.3.1-1 + +**Table 6.2.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|----------------------|--------------------|---------------------------------------------------------| +| resolve-id | POST | Resolve ProSe Remote User ID (i.e., UP-PRUK ID) to SUPI | + +#### 6.2.4.2 Operation: resolve-id + +##### 6.2.4.2.1 Description + +This custom operation is used by the NF service consumer (e.g., SMF, 5G PKMF) to request to resolve ProSe Remote User ID (i.e., UP-PRUK) to SUPI. + +The URI of this custom operation is: {apiRoot}/npkmf-userid/{apiVersion}/resolve-id + +##### 6.2.4.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.2.4.2.2-1 and 6.2.4.2.2-2. + +Table 6.2.4.2.2-1: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-----------------------| +| ResolveRequest | M | 1 | Resolve Request data. | + +Table 6.2.4.2.2-2: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ResolveResponse | M | 1 | 200 OK | Upon success, the response data contain the SUPI of the ProSe Remote UE. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
See table 6.2.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +Table 6.2.4.2.2-3: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G PKMF or 5G PKMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target 5G PKMF (service) instance ID towards which the request is redirected | + +Table 6.2.4.2.2-4: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G PKMF or 5G PKMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target 5G PKMF (service) instance ID towards which the request is redirected | + +### 6.2.5 Notifications + +There is no notification defined for Npkmf\_ResolveRemoteUserId service. + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Npkmf\_ResolveRemoteUserId service based interface protocol. + +**Table 6.2.6.1-1: Npkmf\_ResolveRemoteUserId specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------------|----------------|---------------|---------------| +| ResolveRequest | 6.2.6.2.2 | Request Data | | +| ResolveResponse | 6.2.6.2.3 | Response Data | | + +Table 6.2.6.1-2 specifies data types re-used by the Npkmf\_ResolveRemoteUserId service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Npkmf\_ResolveRemoteUserId service based interface. + +**Table 6.2.6.1-2: Npkmf\_ResolveRemoteUserId re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------|---------------------|-----------------------------------|---------------| +| PruKId | 3GPP TS 29.559 | See clause 6.1.6.3.2 | | +| PlmnId | 3GPP TS 29.571 [15] | PLMN ID | | +| Supi | 3GPP TS 29.571 [15] | Subscription Permanent Identifier | | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: ResolveRequest + +**Table 6.2.6.2.2-1: Definition of type ResolveRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------|---------------| +| upPruKId | PruKId | M | 1 | UP-PRUK ID of the ProSe Remote UE | | +| plmnId | PlmnId | O | 0..1 | HPLMN ID of the 5G ProSe Remote UE | | + +##### 6.2.6.2.3 Type: ResolveResponse + +**Table 6.2.6.2.2-1: Definition of type ResolveResponse** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------|---------------| +| supi | Supi | M | 1 | The SUPI of the UE | | + +#### 6.2.6.3 Simple data types and enumerations + +There are no simply data types and enumerations defined in Npkmf\_ResolveRemoteUserId Service. + +#### 6.2.6.4 Data types describing alternative data types or combinations of data types + +There is no data type describing alternative data types or combinations of data types in Npkmf\_ResolveRemoteUserId Service. + +#### 6.2.6.5 Binary data + +There is no binary data type in Npkmf\_ResolveRemoteUserId Service. + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +For the Npkmf\_ResolveRemoteUserId API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [5]. + +In addition, the requirements in the following clauses are applicable for the Npkmf\_ResolveRemoteUserId API. + +#### 6.2.7.2 Protocol Errors + +No specific procedures for the Npkmf\_ResolveRemoteUserId service are specified. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Npkmf\_ResolveRemoteUserId service are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|--------------------------------------------------| +| USER NOT FOUND | 404 Not Found | The provided subscriber identifier is not found. | + +### 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the Npkmf\_ResolveRemoteUserId API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [5], the access to the Npkmf\_ResolveRemoteUserId API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Npkmf\_ResolveRemoteUserId API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [13], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Npkmf\_ResolveRemoteUserId service. + +The Npkmf\_ResolveRemoteUserId API defines a single scope "npkmf-userid" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different 5G PKMF service instance, within the same 5G PKMF or a different 5G PKMF of an 5G PKMF set, e.g. when an 5G PKMF service instance is part of an 5G PKMF (service) set or when using indirect communications (see 3GPP TS 29.500 [5]). + +An SCP that reselects a different 5G PKMF producer instance will return the NF Instance ID of the new 5G PKMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [5]. + +If an 5G PKMF within an 5G PKMF set redirects a service request to a different 5G PKMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new 5G PKMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +## 6.3 Npkmf\_Discovery Service API + +### 6.3.1 Introduction + +The Npkmf\_Discovery shall use the Npkmf\_Discovery API. + +The API URI of the Npkmf\_Discovery API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "npkmf-discovery". +- The shall be "v1". +- The shall be set as described in clause 6.3.3. + +### 6.3.2 Usage of HTTP + +#### 6.3.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [7] specification of HTTP messages and content bodies for the Npkmf\_Discovery API is contained in Annex A. + +#### 6.3.2.2 HTTP standard headers + +##### 6.3.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +##### 6.3.2.2.2 Content type + +JSON, IETF RFC 8259 [9], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [5]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [10]. + +#### 6.3.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [5] shall be applicable, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [5] may be supported. + +### 6.3.3 Resources + +#### 6.3.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.3.3.1-1 describes the resource URI structure of the Npkmf\_Discovery API. + +![Figure 6.3.3.1-1: Resource URI structure of the Npkmf_Discovery API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/npkmf-disc/. It branches into /{ueId}, which further branches into /announce-authorize, /monitor-key, and /discovery-key. Each of these three branches further branches into /{userId}.](9ee1a10ae91d4878e24b2e7dbaa95c2e_img.jpg) + +``` + +graph TD + Root["{apiRoot}/npkmf-disc/"] --> ueId["/{ueId}"] + ueId --> announce["/announce-authorize"] + ueId --> monitor["/monitor-key"] + ueId --> discovery["/discovery-key"] + announce --> userId1["/{userId}"] + monitor --> userId2["/{userId}"] + discovery --> userId3["/{userId}"] + +``` + +Figure 6.3.3.1-1: Resource URI structure of the Npkmf\_Discovery API. The diagram shows a hierarchical tree structure of URIs. The root is {apiRoot}/npkmf-disc/. It branches into /{ueId}, which further branches into /announce-authorize, /monitor-key, and /discovery-key. Each of these three branches further branches into /{userId}. + +**Figure 6.3.3.1-1: Resource URI structure of the Npkmf\_Discovery API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------|-------------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------| +| AnnounceAuthorize | /{ueId}/announce-authorize/{userId} | PUT | Obtain the authorization from the 5G PKMF for announcing in the PLMN | +| MonitorKey | /{ueId}/monitor-key/{userId} | PUT | Obtain the discovery key from the 5G PKMF for monitoring in the PLMN | +| DiscoveryKey | /{ueId}/discovery-key/{userId} | PUT | Obtain the discovery key from the 5G PKMF for a discoverer UE in the PLMN to operate Model B restricted discovery | + +#### 6.3.3.2 Resource: AnnounceAuthorize + +##### 6.3.3.2.1 Description + +##### 6.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/npkmf-disc//{ueId}/announce-authorize/{userInfoId} + +This resource shall support the resource URI variables defined in table 6.3.3.2.2-1. + +**Table 6.3.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [16] | +| userInfoId | UserInfoId | Represents User Info Id. | + +##### 6.3.3.2.3 Resource Standard Methods + +###### 6.3.3.2.3.1 PUT + +This method shall support the URI query parameters specified in table 6.3.3.2.3.1-1. + +**Table 6.3.3.2.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.3.3.2.3.1-2 and the response data structures and response codes specified in table 6.3.3.2.3.1-3. + +**Table 6.3.3.2.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------------------------------------------------------| +| AnnounceAuthData | M | 1 | Contains the Announce Authorization Data for the indicated UE and indicated user info id. | + +**Table 6.3.3.2.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AnnounceAuthData | M | 1 | 201
Created | Upon success of creation of the resource, a response body shall be returned.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| n/a | | | 204 No Content | Upon success of the update of the resource, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- PROSE_SERVICE_UNAUTHORIZED

See table 6.3.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +**Table 6.3.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/npkmf-disc///announce-authorize/{userId} | + +**Table 6.3.3.2.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G PKMF or 5G PKMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target 5G PKMF (service) instance ID towards which the request is redirected | + +**Table 6.3.3.2.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G PKMF or 5G PKMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target 5G PKMF (service) instance ID towards which the request is redirected | + +#### 6.3.3.3 Resource: MonitorKey + +##### 6.3.3.3.1 Description + +This resource represents the Monitor Key. + +##### 6.3.3.3.2 Resource Definition + +Resource URI: {apiRoot}/npkmf-disc//{ueId}/monitor-key/{userInfoId} + +This resource shall support the resource URI variables defined in table 6.3.3.3.2-1. + +**Table 6.3.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [16] | +| userInfoId | UserInfoId | Represents User Info Id. | + +##### 6.3.3.3.3 Resource Standard Methods + +###### 6.3.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 6.3.3.3.3.1-1. + +**Table 6.3.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.3.3.3.3.1-2 and the response data structures and response codes specified in table 6.3.3.3.3.1-3. + +**Table 6.3.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------------------------------| +| MonitorKeyReqData | M | 1 | Contains the Monitor Key Data for the indicated UE and indicated user info id. | + +Table 6.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MonitorKeyRespData | M | 1 | 201
Created | Upon success of creation of the resource, a response body containing a representation of the discovery key data to monitor for the UE shall be returned.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| n/a | | | 204 No Content | Upon success of the update of the resource, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- PROSE_SERVICE_UNAUTHORIZED

See table 6.3.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- APPLICATION_NOT_FOUND

See table 6.3.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +Table 6.3.3.3.1-4: Headers supported by the 201 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/npkmf-disc//{ueId}/monitor-key/{userId} | + +Table 6.3.3.3.1-5: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G PKMF or 5G PKMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target 5G PKMF (service) instance ID towards which the request is redirected | + +**Table 6.3.3.3.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G PKMF or 5G PKMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target 5G PKMF (service) instance ID towards which the request is redirected | + +#### 6.3.3.4 Resource: DiscoveryKey + +##### 6.3.3.4.1 Description + +This resource represents the Discovery Key. + +##### 6.3.3.4.2 Resource Definition + +Resource URI: {apiRoot}/npkmf-disc///discovery-key/ + +This resource shall support the resource URI variables defined in table 6.3.3.4.2-1. + +**Table 6.3.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type VarUeId in 3GPP TS 29.571 [16] | +| userInfoId | UserInfoId | Represents User Info Id. | + +##### 6.3.3.4.3 Resource Standard Methods + +###### 6.3.3.4.3.1 PUT + +This method shall support the URI query parameters specified in table 6.3.3.4.3.1-1. + +**Table 6.3.3.4.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.3.3.4.3.1-2 and the response data structures and response codes specified in table 6.3.3.4.3.1-3. + +**Table 6.3.3.4.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|----------------------------------------------------------------------------------| +| DiscoveryKeyReq Data | M | 1 | Contains the Discovery Key Data for the indicated UE and indicated user info id. | + +Table 6.3.3.4.3.1-3: Data structures supported by the PUT Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DiscoveryKeyRespData | M | 1 | 201
Created | Upon success of creation of the resource, a response body containing a representation of the discovery key data for the discoverer UE in the PLMN to operate Model B restricted discovery shall be returned.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| n/a | | | 204 No Content | Upon success of the update of the resource, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403
Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- PROSE_SERVICE_UNAUTHORIZED

See table 6.3.7.3-1 for the description of these errors. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- APPLICATION_NOT_FOUND

See table 6.3.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +Table 6.3.3.4.3.1-4: Headers supported by the 201 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/npkmf-disc///discovery-key/ | + +Table 6.3.3.4.3.1-5: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G PKMF or 5G PKMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target 5G PKMF (service) instance ID towards which the request is redirected | + +**Table 6.3.3.4.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same 5G PKMF or 5G PKMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target 5G PKMF (service) instance ID towards which the request is redirected | + +### 6.3.4 Custom Operations without associated resources + +There is no custom operation without associated resources supported in Npkmf\_Discovery Service. + +### 6.3.5 Notifications + +There is no notification defined for Npkmf\_Discovery service. + +### 6.3.6 Data Model + +#### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.1-1 specifies the data types defined for the Npkmf\_Discovery service based interface protocol. + +**Table 6.3.6.1-1: Npkmf\_Discovery specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------------------------|----------------|----------------------------------------------------------------------------|---------------| +| AnnounceAuthData | 6.3.6.2.2 | Represents Data used to request the authorization to announce for a UE | | +| MonitorKeyReqData | 6.3.6.2.3 | Represents Data used to request the discovery key data to monitor for a UE | | +| MonitorKeyRespData | 6.3.6.2.4 | Represents the obtained Monitor discovery key data for a UE | | +| DiscoveryKeyReqData | 6.3.6.2.5 | Represents Data used to request the discovery key data for a discoverer UE | | +| DiscoveryKeyRespData | 6.3.6.2.6 | Represents the obtained the discovery key data for a discoverer UE. | | +| DiscSecMaterials | 6.3.6.2.7 | Represents the discovery security materials | | +| UeSecurityCapability | 6.3.6.3 | PC5 UE security capability | | +| ChosenPc5CipheringAlgorithm | 6.3.6.3 | The chosen PC5 ciphering algorithm | | +| Duik | 6.3.6.3 | Discovery User Integrity Key | | +| Duck | 6.3.6.3 | Discovery User Confidentiality Key | | +| Dusk | 6.3.6.3 | Discovery User Scrambling Key | | +| UserInfoId | 6.3.6.3 | User Info ID | | + +Table 6.3.6.1-2 specifies data types re-used by the Npkmf\_Discovery service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Npkmf\_Discovery service based interface. + +**Table 6.3.6.1-2: Npkmf\_Discovery re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|---------------------|-------------------------------------|---------------| +| VarUeld | 3GPP TS 29.571 [15] | String represents the SUPI or GPSI. | | +| RelayServiceCode | 3GPP TS 29.571 [15] | Relay Service Code | | + +#### 6.3.6.2 Structured data types + +##### 6.3.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.3.6.2.2 Type: AnnounceAuthData + +**Table 6.3.6.2.2-1: Definition of type AnnounceAuthData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|------------------------------------------------|---------------| +| relayServCode | RelayServiceCode | M | 1 | This IE shall indicate the Relay Service Code. | | + +##### 6.3.6.2.3 Type: MonitorKeyReqData + +**Table 6.3.6.2.3-1: Definition of type MonitorKeyReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|----------------------|---|-------------|-------------------------------------------------------|---------------| +| relayServCode | RelayServiceCode | M | 1 | This IE shall indicate the Relay Service Code. | | +| ueSecurityCapability | UeSecurityCapability | M | 1 | This IE shall indicate the PC5 UE security capability | | + +##### 6.3.6.2.4 Type: MonitorKeyRespData + +**Table 6.3.6.2.4-1: Definition of type MonitorKeyRespData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|-----------------------------|---|-------------|-----------------------------------------------------------|---------------| +| chosenPc5CipheringAlgorithm | ChosenPc5CipheringAlgorithm | M | 1 | This IE shall indicate the chosen PC5 ciphering algorithm | | +| discSecMaterials | DiscSecMaterials | M | 1 | This IE shall indicate the discovery security materials | | + +##### 6.3.6.2.5 Type: DiscoveryKeyReqData + +**Table 6.3.6.2.5-1: Definition of type DiscoveryKeyReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|----------------------|---|-------------|-------------------------------------------------------|---------------| +| relayServCode | RelayServiceCode | M | 1 | This IE shall indicate the Relay Service Code. | | +| ueSecurityCapability | UeSecurityCapability | M | 1 | This IE shall indicate the PC5 UE security capability | | + +##### 6.3.6.2.6 Type: DiscoveryKeyRespData + +**Table 6.3.6.2.6-1: Definition of type DiscoveryKeyRespData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|-----------------------------|---|-------------|-----------------------------------------------------------|---------------| +| chosenPc5CipheringAlgorithm | ChosenPc5CipheringAlgorithm | M | 1 | This IE shall indicate the chosen PC5 ciphering algorithm | | +| discSecMaterials | DiscSecMaterials | M | 1 | This IE shall indicate the discovery security materials | | + +##### 6.3.6.2.7 Type: DiscSecMaterials + +Table 6.3.6.2.7-1: Definition of type DiscSecMaterials + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------|---------------| +| duik | Duik | O | 0..1 | Discovery User Integrity Key | | +| duck | Duck | O | 0..1 | Discovery User Confidentiality Key | | +| dusk | Dusk | O | 0..1 | Discovery User Scrambling Key | | + +#### 6.3.6.3 Simple data types and enumerations + +##### 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.3.6.3.2 Simple data types + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +Table 6.3.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| UserInfolnd | string | User Info ID is a string of hexadecimal characters, encoding the value of the user info ID parameter which is a 48-bit long bit string. | | +| UeSecurityCapability | Bytes | String with format "byte" as defined in OpenAPI Specification [7], i.e. base64-encoded characters, encoding the "UE security capability" IE as specified in clause 11.3.11 of 3GPP TS 24.554 [16] (starting from octet 1). | | +| ChosenPc5CipheringAlgorithm | integer | This IE shall indicate the chosen PC5 ciphering algorithm as specified in clause 11.4.2.51 of 3GPP TS 24.554 [16] | | +| Duik | Bytes | String with format "byte" as defined in OpenAPI Specification [7], i.e. base64-encoded characters, encoding the "DUIK" IE as specified in clause 11.6.2.13 of 3GPP TS 24.554 [16]. | | +| Duck | Bytes | String with format "byte" as defined in OpenAPI Specification [7], i.e. base64-encoded characters, encoding the "DUCK" IE as specified in clause 11.6.2.14 of 3GPP TS 24.554 [16]. | | +| Dusk | Bytes | String with format "byte" as defined in OpenAPI Specification [7], i.e. base64-encoded characters, encoding the "DUSK" IE as specified in clause 11.6.2.12 of 3GPP TS 24.554 [16]. | | + +#### 6.3.6.4 Data types describing alternative data types or combinations of data types + +There is no data type describing alternative data types or combinations of data types in Npkmf\_Discovery Service. + +#### 6.3.6.5 Binary data + +There is no binary data type in Npkmf\_Discovery Service. + +### 6.3.7 Error Handling + +#### 6.3.7.1 General + +For the Npkmf\_Discovery API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [5]. + +In addition, the requirements in the following clauses are applicable for the Npkmf\_Discovery API. + +#### 6.3.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [5]. + +#### 6.3.7.3 Application Errors + +The application errors defined for the Npkmf\_Discovery service are listed in Table 6.3.7.3-1. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------|------------------|-------------------------------------------------------------------------------------| +| PROSE_SERVICE_UNAUTHORIZED | 403 Forbidden | It is used when the requested ProSe service is not authorized for this UE Identity. | +| APPLICATION_NOT_FOUND | 404 Not Found | It is used when the requested ProSe Application doesn't exist | + +### 6.3.8 Feature negotiation + +The optional features in table 6.3.8-1 are defined for the Npkmf\_Discovery API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5]. + +**Table 6.3.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| N/A | | | + +### 6.3.9 Security + +As indicated in 3GPP TS 33.501 [11] and 3GPP TS 29.500 [5], the access to the Npkmf\_Discovery API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [12]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Npkmf\_Discovery API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [13], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Npkmf\_Discovery service. + +The Npkmf\_Discovery API defines the following scopes "npkmf-keyrequest" for OAuth2 authorization as specified in 3GPP TS 33.501 [8]: + +**Table 6.3.9-1: OAuth2 scopes defined in Npanf\_ProseKey API** + +| Scope | Description | +|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| "npkmf-disc" | Access to the Npkmf_Discovery API | +| "npkmf-disc:announce-authorize:modify" | Access to modify the authorization to announce for a UE in the PLMN | +| "npkmf-disc:monitor-key:modify" | Access to modify the authorization for monitoring for an UE in the PLMN | +| "npkmf-disc:discovery-authorize:modify" | Access to modify the authorization from the 5G DDNMF for a discoverer UE in the PLMN to operate Model B restricted discovery | + +### 6.3.10 HTTP redirection + +An HTTP request may be redirected to a different 5G PKMF service instance, within the same 5G PKMF or a different 5G PKMF of an 5G PKMF set, e.g. when an 5G PKMF service instance is part of an 5G PKMF (service) set or when using indirect communications (see 3GPP TS 29.500 [5]). + +An SCP that reselects a different 5G PKMF producer instance will return the NF Instance ID of the new 5G PKMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [5]. + +If an 5G PKMF within an 5G PKMF set redirects a service request to a different 5G PKMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new 5G PKMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [6] and clause 5B 3GPP TR 21.900 [14]). + +## --- A.2 Npkmf\_PKMFKeyRequest API + +openapi: 3.0.0 + +``` +info: + title: Npkmf_PKMFKeyRequest + version: 1.0.1 + description: | + PKMF KeyRequest Service. +``` + +© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +``` +externalDocs: + description: 3GPP TS 29.559 V17.2.0; 5G System; 5G ProSe Key Management Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.559/ + +servers: + - url: '{apiRoot}/npkmf-keyrequest/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npkmf-keyrequest + +paths: + /prose-keys/request: + post: + summary: Request Keying Materials for 5G ProSe + operationId: ProseKey + tags: + - ProSe Keys Collection (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ProseKeyReqData' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ProseKeyRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npkmf-keyrequest: Access to the Npkmf_PKMFKeyRequest API +``` + +``` +schemas: +# +# Structured Data Types +# +ProseKeyReqData: + description: Representation of the input to request the keying material. + type: object + properties: + relayServCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RelayServiceCode' + knrpFreshness1: + $ref: '#/components/schemas/KnrpFreshnessParameter1' + resyncInfo: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ResynchronizationInfo' + prukId: + $ref: '#/components/schemas/PrukId' + suci: + $ref: 'TS29509_Nausf_UEAuthentication.yaml#/components/schemas/Suci' + required: + - relayServCode + - knrpFreshness1 + +ProseKeyRspData: + description: Representation of the successfully requested keying material. + type: object + properties: + knrp: + $ref: '#/components/schemas/Knrp' + knrpFreshness2: + $ref: '#/components/schemas/KnrpFreshnessParameter2' + mpi: + $ref: '#/components/schemas/Gpi' + required: + - knrp + - knrpFreshness2 + +# +# Simple Data Types +# +PrukId: + description: User Plane Prose Remote User Key ID + type: string + +Knrp: + description: Key for NR PC5 + type: string + +KnrpFreshnessParameter1: + description: KNRP Freshness Parameter 1 + type: string + +KnrpFreshnessParameter2: + description: KNRP Freshness Parameter 2 + type: string + +Gpi: + description: GBA Pushing Information + type: string + +# +# Enumeration Data Types +# +``` + +## A.3 Npkmf\_ResolveRemoteUserId API + +openapi: 3.0.0 + +``` +info: + title: Npkmf_ResolveRemoteUserId + version: 1.0.0 + description: | + PKMF Resolve Remote User Id Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +``` + +``` +externalDocs: + description: 3GPP TS 29.559 V17.3.0; 5G System; 5G ProSe Anchor Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.559/ + +servers: + - url: '{apiRoot}/npkmf-userid/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npkmf-userid + +paths: + /resolve-id: + post: + summary: Retrieve the SUPI of the ProSe Remote UE + operationId: RetrieveSUPI + tags: + - SUPI Retrieval + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResolveRequest' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ResolveResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npkmf-userid: Access to the Npkmf_ResolveRemoteUserId API + +schemas: +# +# Structured Data Types +``` + +``` +# + +ResolveRequest: + description: Request Data + type: object + properties: + upPrukId: + $ref: 'TS29559_Npkmf_PKMFKeyRequest.yaml#/components/schemas/PrukId' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + required: + - upPrukId + +ResolveResponse: + description: Response Data + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + required: + - supi + +# +# Simple Data Types +# + +# +# Enumeration Data Types +# +``` + +## A.4 Npkmf\_Discovery API + +``` +openapi: 3.0.0 + +info: + title: Npkmf_Discovery API + version: '1.0.0' + description: | + Npkmf_Discovery Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.559 V17.5.0; 5G System; 5G ProSe Key Management Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29\_series/29.559/ + +servers: + - url: '{apiRoot}/npkmf-discovery/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npkmf-discovery + +paths: + /{ueId}/announce-authorize/{userInfoId}: + put: + summary: Obtain the authorization from the 5G PKMF for announcing in the PLMN + operationId: ObtainAnnounceAuth + tags: + - Obtain the authorization from the 5G PKMF for announcing in the PLMN + security: + - {} + - oAuth2ClientCredentials: + - npkmf-disc + - oAuth2ClientCredentials: + - npkmf-disc + - npkmf-disc:announce-authorize:modify + parameters: + - name: ueId +``` + +``` + +in: path +description: Identifier of the UE +required: true +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: userInfoId +in: path +description: User Info Id +required: true +schema: + $ref: '#/components/schemas/UserInfoId' +requestBody: +content: + application/json: + schema: + $ref: '#/components/schemas/AnnounceAuthData' + required: true +responses: +'201': + description: Successful creation of the resource + content: + application/json: + schema: + $ref: '#/components/schemas/AnnounceAuthData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/npkmf-disc>/{apiVersion>/{ueId}/announce-authorize/{userInfoId} + required: true + schema: + type: string +'204': + description: Successful update of the resource. +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{ueId}/monitor-key/{userInfoId}: +put: + summary: Obtain the discovery key from the 5G PKMF for monitoring in the PLMN + operationId: ObtainMonitorKey + tags: + - Obtain the discovery key from the 5G PKMF for monitoring in the PLMN + security: + - {} + - oAuth2ClientCredentials: + - npkmf-disc + - oAuth2ClientCredentials: + - npkmf-disc + - npkmf-disc:monitor-key:modify + parameters: + - name: ueId + +``` + +``` + +in: path +description: Identifier of the UE +required: true +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: userInfoId +in: path +description: User Info Id +required: true +schema: + $ref: '#/components/schemas/UserInfoId' +requestBody: +content: + application/json: + schema: + $ref: '#/components/schemas/MonitorKeyReqData' + required: true +responses: +'201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/MonitorKeyRespData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/npkmf-disc>/{apiVersion>/{ueId}/monitor-key/{userInfoId} + required: true + schema: + type: string +'204': + description: Successful update of the resource. +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +/{ueId}/discovery-key/{userInfoId}: +put: + summary: Obtain the discovery key from the 5G PKMF for a discoverer UE + operationId: ObtainDiscKey + tags: + - Obtain the discovery key for a discoverer UE + security: + - {} + - oAuth2ClientCredentials: + - npkmf-disc + - oAuth2ClientCredentials: + - npkmf-disc + - npkmf-disc:discovery-authorize:modify + parameters: + - name: ueId + +``` + +``` +in: path +description: Identifier of the UE +required: true +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: userInfoId +in: path +description: User Info Id +required: true +schema: + $ref: '#/components/schemas/UserInfoId' +requestBody: +content: + application/json: + schema: + $ref: '#/components/schemas/DiscoveryKeyReqData' + required: true +responses: +'201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoveryKeyRespData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/npkmf-disc>/{apiVersion>/{ueId}/discovery-key/{userInfoId} + required: true + schema: + type: string +'204': + description: Successful update of the resource. +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oAuth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npkmf-disc: Access to the Npkmf_Discovery API + npkmf-disc:announce-authorize:modify: > + Access to modify the authorization to announce for a UE in the PLMN + npkmf-disc:monitor-key:modify: > + Access to modify the authorization for monitoring for an UE in the PLMN + npkmf-disc:discovery-key:modify: > +``` + +Access to modify the authorization from the 5G DDNMF for a discoverer UE +in the PLMN to operate Model B restricted discovery + +schemas: + +# STRUCTURED TYPES: + +``` +AnnounceAuthData: + type: object + description: Represents Data used to request the authorization to announce for a UE + required: + - relayServCode + properties: + relayServCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RelayServiceCode' + +MonitorKeyReqData: + type: object + description: Data used to request the discovery key to monitor for a UE + required: + - relayServCode + - ueSecurityCapability + properties: + relayServCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RelayServiceCode' + ueSecurityCapability: + $ref: '#/components/schemas/UeSecurityCapability' + +MonitorKeyRespData: + type: object + description: Represents the obtained Monitor Discovery Key Data for a UE + required: + - chosenPc5CipheringAlgorithm + - discSecMaterials + properties: + chosenPc5CipheringAlgorithm: + $ref: '#/components/schemas/ChosenPc5CipheringAlgorithm' + discSecMaterials: + $ref: '#/components/schemas/DiscSecMaterials' + +DiscoveryKeyReqData: + type: object + description: Data used to request the discovery key to monitor for a discoverer UE + required: + - relayServCode + - ueSecurityCapability + properties: + relayServCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RelayServiceCode' + ueSecurityCapability: + $ref: '#/components/schemas/UeSecurityCapability' + +DiscoveryKeyRespData: + type: object + description: Represents the obtained Monitor Discovery Key Data for a discoverer UE + required: + - chosenPc5CipheringAlgorithm + - discSecMaterials + properties: + chosenPc5CipheringAlgorithm: + $ref: '#/components/schemas/ChosenPc5CipheringAlgorithm' + discSecMaterials: + $ref: '#/components/schemas/DiscSecMaterials' + +DiscSecMaterials: + type: object + description: Represents the discovery security materials + properties: + duik: + $ref: '#/components/schemas/Duik' + dusk: + $ref: '#/components/schemas/Dusk' + duck: + $ref: '#/components/schemas/Duck' +``` + +# SIMPLE TYPES: + +``` +UserInfoId: + type: string +``` + +``` +UeSecurityCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +ChosenPc5CipheringAlgorithm: + description: Contains the chosen PC5 ciphering algorithm. + type: integer + +Duik: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +Dusk: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +Duck: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' +``` + +# ENUMS: + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2022-04 | C4#109-e | C4-222345 | | | | Implementation of pCRs agreed in CT4#109-e including C4-222355, C4-222356, C4-222023, C4-222024, C4-222025, C4-222026, C4-222027, C4-222028, C4-222029, C4-222031, C4-222409, C4-222410, C4-222411, C4-222412, C4-222413, C4-222414 | 0.1.0 | +| 2022-05 | C4#110-e | C4-223454 | | | | Implementation of pCRs agreed in CT4#110-e including C4-223135, C4-223157, C4-223158, C4-223160, C4-223351, C4-223352, C4-223416, C4-223417 | 0.2.0 | +| 2022-06 | CT#96 | CP-221082 | | | | TS presented for information and approval | 1.0.0 | +| 2022-06 | CT#96 | CP-221082 | | | | TS approved in CT#96 | 17.0.0 | +| 2022-09 | CT#97e | CP-222035 | 0001 | - | F | Alignment on the service name used with template | 17.1.0 | +| 2022-12 | CT#98e | CP-223054 | 0003 | 2 | F | PRUK Name Alignment | 17.2.0 | +| 2022-12 | CT#98e | CP-223054 | 0004 | - | F | Correct the server url and some table styles | 17.2.0 | +| 2022-12 | CT#98e | CP-223054 | 0006 | - | F | Update on the procedure title | 17.2.0 | +| 2022-12 | CT#98e | CP-223066 | 0007 | - | F | 29.559 Rel-17 API version and External doc update | 17.2.0 | +| 2023-06 | CT#100 | CP-231202 | 0010 | 3 | F | Add service Npkmf_ResolveRemoteUserId | 18.0.0 | +| 2023-06 | CT#100 | CP-231026 | 0008 | 3 | F | Location header description | 18.0.0 | +| 2023-09 | CT#101 | CP-232071 | 0018 | 1 | A | Remove the EN and add the missing reference point | 18.1.0 | +| 2023-12 | CT#102 | CP-233069 | 0024 | 3 | A | Npkmf_Discovery_AnnounceAuthorize service operation | 18.2.0 | +| 2023-12 | CT#102 | CP-233069 | 0026 | 1 | A | Npkmf_Discovery_MonitorKey service operation | 18.2.0 | +| 2023-12 | CT#102 | CP-233069 | 0028 | 1 | A | Npkmf_Discovery_DiscoveryKey service operation | 18.2.0 | +| 2023-12 | CT#102 | CP-233055 | 0029 | - | F | Align with the SBI template | 18.2.0 | +| 2023-12 | CT#102 | CP-233055 | 0031 | - | F | PKMF replace by 5G PKMF | 18.2.0 | +| 2023-12 | CT#102 | CP-233028 | 0032 | 1 | F | RFC7540 obsoleted by RFC9113 | 18.2.0 | +| 2023-12 | CT#102 | CP-233055 | 0033 | 1 | B | Enhancement to support UE-to-UE relay | 18.2.0 | +| 2023-12 | CT#102 | CP-233030 | 0035 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.2.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29561/raw.md b/raw/rel-18/29_series/29561/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..674e7bcfdd66bcc006d56a6cb87ccbd93ec5319c --- /dev/null +++ b/raw/rel-18/29_series/29561/raw.md @@ -0,0 +1,3928 @@ + + +# 3GPP TS 29.561 V18.2.0 (2023-09) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Interworking between 5G Network and external Data Networks; Stage 3 (Release 18)** --- + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +## --- Keywords --- + +### **3GPP** + +### --- Postal address --- + +### 3GPP support office address --- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## Internet --- + + + +--- + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 Network Characteristics..... | 10 | +| 4.1 Key characteristics of PLMN..... | 10 | +| 4.2 Key characteristics of IP Networks..... | 11 | +| 4.3 Key characteristics of Ethernet ..... | 11 | +| 5 Interworking Classifications ..... | 11 | +| 5.1 Service Interworking..... | 11 | +| 5.2 Network Interworking..... | 11 | +| 6 Reference Architecture ..... | 11 | +| 7 Interface to 5G Network services (User Plane) ..... | 12 | +| 8 Interworking with DN (IP)..... | 12 | +| 8.1 General ..... | 12 | +| 8.2 DN Interworking Model..... | 12 | +| 8.2.1 General ..... | 12 | +| 8.2.2 Access to DN through 5G Network..... | 13 | +| 8.2.2.1 Transparent access to DN ..... | 13 | +| 8.2.2.2 IPv4 Non-transparent access to DN..... | 14 | +| 8.2.2.3 IPv6 Non-transparent access to DN..... | 15 | +| 8.3 Transport Level Marking ..... | 17 | +| 9 Interworking with DN (Unstructured) ..... | 17 | +| 9.1 General ..... | 17 | +| 9.2 N6 PtP tunnelling based on UDP/IP ..... | 17 | +| 9.3 Other N6 tunnelling mechanism ..... | 18 | +| 10 Interworking with DN (DHCP)..... | 19 | +| 10.1 General ..... | 19 | +| 10.2 DN interworking Model of SMF or SMF+PGW-C for DHCP..... | 19 | +| 10.2.2 IPv4 Address allocation and IPv4 parameter configuration via DHCPv4 ..... | 20 | +| 10.2.3 IPv6 Prefix allocation via IPv6 stateless address autoconfiguration via DHCPv6 ..... | 21 | +| 10.2.4 IPv6 parameter configuration via stateless DHCPv6 ..... | 22 | +| 10.2.5 IPv6 Prefix Delegation via DHCPv6..... | 23 | +| 10.2.5.1 General requirement ..... | 23 | +| 10.2.5.2 Additional requirement to support RG ..... | 23 | +| 10.3 3GPP Vendor-Specific Options ..... | 24 | +| 11 Interworking with DN-AAA (RADIUS) ..... | 25 | +| 11.1 RADIUS procedures ..... | 25 | +| 11.1.1 RADIUS Authentication and Authorization in 5GC..... | 25 | +| 11.1.1a RADIUS Authentication and Authorization in EPC Interworking ..... | 26 | +| 11.1.2 RADIUS Accounting..... | 27 | +| 11.2 Message flows on N6 interface ..... | 28 | +| 11.2.1 Authentication, Authorization and Accounting procedures in 5GC ..... | 28 | +| 11.2.1a Authentication and Authorization procedures in EPC Interworking..... | 31 | +| 11.2.2 Accounting Update..... | 34 | +| 11.2.3 DN-AAA initiated QoS flow termination ..... | 35 | +| 11.2.4 DN-AAA initiated re-authorization in 5GC ..... | 36 | +| 11.2.4a DN-AAA initiated re-authorization in EPC Interworking ..... | 37 | + +| | | | +|----------|-----------------------------------------------------------------------------------|----| +| 11.3 | List of RADIUS attributes..... | 38 | +| 11.3.1 | General ..... | 38 | +| 11.3.2 | Change-of-Authorization Request (optionally sent from DN-AAA server to SMF) ..... | 53 | +| 11.3.3 | Access-Challenge (sent from DN-AAA server to SMF)..... | 54 | +| 12 | Interworking with DN-AAA (Diameter) ..... | 54 | +| 12.1 | Diameter Procedures ..... | 54 | +| 12.1.1 | Diameter Authentication and Authorization..... | 54 | +| 12.1.1a | Diameter Authentication and Authorization in EPC Interworking ..... | 55 | +| 12.1.2 | Diameter Accounting..... | 57 | +| 12.2 | Message flows on N6 interface ..... | 57 | +| 12.2.1 | Authentication, Authorization and Accounting procedures ..... | 57 | +| 12.2.1a | Authentication and Authorization procedures in EPC Interworking..... | 61 | +| 12.2.2 | Accounting Update ..... | 63 | +| 12.2.3 | DN-AAA initiated QoS flow termination ..... | 64 | +| 12.2.4 | DN-AAA initiated re-authorization in 5GC ..... | 65 | +| 12.2.4a | DN-AAA initiated re-authorization in EPC Interworking ..... | 66 | +| 12.2.5 | DN-AAA initiated re-authentication and re-authorization in 5GC ..... | 66 | +| 12.2.5a | DN-AAA initiated re-authentication and re-authorization in EPC Interworking ..... | 67 | +| 12.3 | N6 specific AVPs..... | 68 | +| 12.4 | N6 re-used AVPs..... | 68 | +| 12.4.0 | General ..... | 68 | +| 12.4.1 | Use of the Supported-Features AVP on the N6 reference point..... | 71 | +| 12.5 | N6 specific Experimental-Result-Code AVP..... | 72 | +| 12.6 | N6 Diameter messages ..... | 72 | +| 12.6.1 | General ..... | 72 | +| 12.6.2 | DER Command ..... | 73 | +| 12.6.3 | DEA Command ..... | 74 | +| 12.6.4 | RAR Command ..... | 75 | +| 12.6.5 | RAA Command ..... | 76 | +| 13 | Interworking with IMS..... | 76 | +| 13.1 | General ..... | 76 | +| 13.2 | IMS interworking Model..... | 77 | +| 13.2.1 | Introduction ..... | 77 | +| 13.2.2 | IMS specific configuration in the SMF ..... | 77 | +| 13.2.3 | IMS specific procedures in the SMF ..... | 78 | +| 13.2.3.1 | Provisioning of Signalling Server Address..... | 78 | +| 13.2.3.2 | Failure of Signalling Server Address..... | 78 | +| 14 | Interworking with DN (Ethernet)..... | 78 | +| 15 | Interworking with DN (Multicast Routing Protocol)..... | 79 | +| 15.1 | General ..... | 79 | +| 15.2 | DN interworking Model of UPF for PIM..... | 79 | +| 16 | Interworking with NSS-AAA (RADIUS)..... | 80 | +| 16.1 | RADIUS procedures ..... | 80 | +| 16.1.1 | General ..... | 80 | +| 16.1.2 | RADIUS Authentication and Authorization ..... | 80 | +| 16.2 | Message flows for network slice specific authentication..... | 81 | +| 16.2.1 | Authentication and Authorization procedures..... | 81 | +| 16.2.2 | NSS-AAA initiated revocation of network slice authorization ..... | 82 | +| 16.3 | List of RADIUS attributes..... | 83 | +| 16.3.1 | General ..... | 83 | +| 17 | Interworking with NSS-AAA (Diameter)..... | 84 | +| 17.1 | Diameter procedures ..... | 84 | +| 17.1.1 | General ..... | 84 | +| 17.1.2 | Diameter Authentication and Authorization..... | 84 | +| 17.2 | Message flows for network slice specific authentication..... | 84 | +| 17.2.1 | Authentication and Authorization procedures..... | 84 | +| 17.2.2 | NSS-AAA initiated revocation of network slice authorization ..... | 86 | +| 17.2.3 | NSS-AAA initiated re-authentication and re-authorization ..... | 87 | + +| | | | +|-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|------------| +| 17.3 | Specific AVPs ..... | 87 | +| 17.4 | re-used AVPs..... | 88 | +| 17.4.1 | General ..... | 88 | +| 17.4.2 | Use of the Supported-Features AVP ..... | 88 | +| 17.5 | Specific Experimental-Result-Code AVP..... | 89 | +| 17.6 | Diameter messages..... | 89 | +| 17.6.1 | General ..... | 89 | +| 18 | Interworking with DN (L2TP tunnel)..... | 89 | +| 18.1 | Support L2TP for CUPS across N6..... | 89 | +| 19 | Interworking with Credentials Holder using AAA server ..... | 93 | +| 19.1 | Credentials Holder using AAA server for primary authentication and authorization..... | 93 | +| 19.2 | Credentials Holder using AAA server for primary authentication procedure ..... | 93 | +| 20 | Interworking with MBS Application Provider (AF/AS)..... | 94 | +| 20.1 | General ..... | 94 | +| 20.2 | MBS interworking user plane reference point architecture ..... | 94 | +| 20.3 | User Plane Protocol between MB-UPF and MBS AF/AS or MBSTF..... | 95 | +| 20.4 | User Plane Protocol between MBSTF and MBS AF/AS or NEF ..... | 96 | +| 21 | Interworking with AAA server in DCS for UE onboarding in SNPNs ..... | 97 | +| 21.0 | General ..... | 97 | +| 21.1 | Primary authentication using AAA server in DCS ..... | 97 | +| 21.2 | Secondary authentication using AAA server in DCS ..... | 97 | +| Annex A (normative): Rate control related to 5G Cellular Internet of Things (CIoT) optimisations ... | | 98 | +| A.1 | General..... | 98 | +| A.2 | Support of rate control of user data..... | 98 | +| A.2.1 | General ..... | 98 | +| A.2.2 | Small Data Rate Control ..... | 98 | +| A.2.3 | Serving PLMN Rate Control information handling ..... | 99 | +| Annex B (informative): Change history ..... | | 100 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present specification defines the stage 3 interworking procedures for 5G Network interworking between PLMN and external DN or Network Slice Specific AAA. + +The stage 2 requirements and procedures are contained in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +For interworking between 5G PLMN and external DNs, the present document is valid for both 3GPP accesses and non-3GPP accesses. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.281: "General Packet Radio System (GPRS) Tunnelling Protocol User Plane (GTPv1-U)". +- [5] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [6] IETF RFC 3748: "Extensible Authentication Protocol (EAP)". +- [7] IETF RFC 3579: "RADIUS (Remote Authentication Dial In User Service) Support For Extensible Authentication Protocol (EAP)". +- [8] IETF RFC 2865: "Remote Authentication Dial In User Service (RADIUS)". +- [9] IETF RFC 3162: "RADIUS and IPv6". +- [10] IETF RFC 4818: "RADIUS Delegated-IPv6-Prefix Attribute". +- [11] IETF RFC 5216: "The EAP-TLS Authentication Protocol". +- [12] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [13] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP; Stage 3". +- [14] IETF RFC 2132: "DHCP Options and BOOTP Vendor Extensions". +- [15] IETF RFC 3361: "Dynamic Host Configuration Protocol (DHCP-for-IPv4) Option for Session Initiation Protocol (SIP) Servers". +- [16] IETF RFC 3646: "DNS Configuration options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6)". +- [17] IETF RFC 3319: "Dynamic Host Configuration Protocol (DHCPv6) Options for Session Initiation Protocol (SIP) Servers". + +- [18] IETF RFC 2131: "Dynamic Host Configuration Protocol". +- [19] IETF RFC 1542: "Clarification and Extensions for the Bootstrap Protocol". +- [20] IETF RFC 4039: "Rapid Commit Option for the Dynamic Host Configuration Protocol version 4 (DHCPv4)". +- [21] IETF RFC 3315: "Dynamic Host Configuration Protocol for IPv6 (DHCPv6)". +- [22] IETF RFC 3736: "Stateless Dynamic Host Configuration Protocol (DHCP) Service for IPv6". +- [23] IETF RFC 7155: "Diameter Network Access Server Application". +- [24] IETF RFC 6733: "Diameter Base Protocol". +- [25] IETF RFC 4072: "Diameter Extensible Authentication Protocol (EAP) Application". +- [26] IETF RFC 2866: "RADIUS Accounting". +- [27] IETF RFC 5176: "Dynamic Authorization Extensions to Remote Authentication Dial In User Service (RADIUS)". +- [28] 3GPP TS 23.003: "Numbering, addressing and identification". +- [29] IETF RFC 1825: "Security Architecture for the Internet Protocol". +- [30] IETF RFC 1826: "IP Authentication Header". +- [31] IETF RFC 1827: "IP Encapsulating Security Payload (ESP)". +- [32] IETF RFC 4291: "IP Version 6 Addressing Architecture". +- [33] IETF RFC 4861: "Neighbor Discovery for IP Version 6 (IPv6)". +- [34] IETF RFC 4862: "IPv6 Stateless Address Autoconfiguration". +- [35] IETF RFC 1027: "Using ARP to Implement Transparent Subnet Gateways". +- [36] 802.3-2015 - IEEE Standard for Ethernet. +- [37] IETF RFC 5281: "Extensible Authentication Protocol Tunneled Transport Layer Security Authenticated Protocol Version 0 (EAP-TTLSv0)". +- [38] 3GPP TS 23.380: "IMS Restoration Procedures". +- [39] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [40] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [41] 3GPP TS 29.229: "Cx and Dx interfaces based on Diameter protocol; Protocol details". +- [42] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [43] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [44] IETF RFC 7761: "Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised)". +- [45] IETF RFC 3973: "Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised)". +- [46] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [47] IETF RFC 2132: "DHCP Options and BOOTP Vendor Extensions". +- [48] IETF RFC 3925: "Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4 (DHCPv4)". + +- [49] IETF RFC 8415: "Dynamic Host Configuration Protocol for IPv6 (DHCPv6)". +- [50] 3GPP TS 29.274: "3GPP Evolved Packet System. Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [51] CableLabs WR-TR-5WWC-ARCH: "5G Wireless Wireline Converged Core Architecture". +- [52] BBF WT-470: "5G FMC Architecture". +- [53] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [54] BBF TR-456: "AGF Functional Requirements". +- [55] CableLabs DOCSIS MULPI: "Data-Over-Cable Service Interface Specifications DOCSIS 3.1, MAC and Upper Layer Protocols Interface Specification". +- [56] IETF RFC 7542: "The Network Access Identifier". +- [57] IETF RFC 2661: " Layer Two Tunneling Protocol "L2TP". +- [58] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane of EPC Nodes; Stage 3". +- [59] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [60] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services; Stage 2". +- [61] 3GPP TS 26.502: "5G Multicast-Broadcast User Service Architecture". +- [62] IETF RFC 6603: "Prefix Exclude Option for DHCPv6-based Prefix Delegation". +- [63] 3GPP TS 23.434: "Service Enabler Architecture Layer for Verticals (SEAL); Functional architecture and information flows". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|---------|---------------------------------------------------| +| 5G-BRG | 5G Broadband Residential Gateway | +| 5G-CRG | 5G Cable Residential Gateway | +| AMF | Access and Mobility Management Function | +| BBF | Broadband Forum | +| CH | Credentials Holder | +| CHAP | Challenge Handshake Authentication Protocol | +| CHF | Charging Function | +| CSMA/CD | Carrier Sense Multiple Access/Collision Detection | +| DCS | Default Credentials Server | +| DHCPv4 | Dynamic Host Configuration Protocol version 4 | +| DHCPv6 | Dynamic Host Configuration Protocol version 6 | +| DN | Data Network | + +| | | +|---------|------------------------------------------------------------------| +| DNAI | DN Access Identifier | +| DR | Designated Router | +| DSL | Digital Subscriber Line | +| FN-BRG | Fixed Network Broadband RG | +| FN-CRG | Fixed Network Cable RG | +| FQDN | Fully Qualified Domain Name | +| GCI | Global Cable Identifier | +| GLI | Global Line Identifier | +| GPSI | Generic Public Subscription Identifier | +| HFC | Hybrid Fiber Coax | +| I-SMF | Intermediate SMF | +| L2TP | Layer Two Tunneling Protocol | +| LAC | L2TP Access Concentrator | +| LNS | L2TP Network Server | +| MBS | Multicast/Broadcast Service. | +| MBSTF | Multicast/Broadcast Service Transport Function. | +| MB-UPF | Multicast/Broadcast User Plane Function | +| N3IWF | Non-3GPP InterWorking Function | +| NGAP | NG Application Protocol | +| NRM | Network Resource Management | +| NSS | Network Slice Specific | +| NSSAAF | Network Slice-Specific Authentication and Authorization Function | +| ON-SNPN | Onboarding Standalone Non-Public Network | +| PAP | Password Authentication Protocol | +| PIM | Protocol-Independent Multicast | +| PIM-DM | Protocol-Independent Multicast- Dense Mode | +| PIM-SM | Protocol-Independent Multicast- Sparse Mode | +| PON | Passive Optical Network | +| PtP | Point-to-Point | +| RG | Residential Gateway | +| RP | Rendezvous Point | +| RSN | Redundancy Sequence Number | +| RTP | Real-time Transport Protocol | +| SD | Slice Differentiator | +| SEAL | Service Enabler Architecture Layer for Verticals | +| SFD | Start Frame Delimiter | +| SMF | Session Management Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SNPN | Stand-alone Non-Public Network | +| SO-SNPN | Subscription Owner Standalone Non-Public Network | +| SSC | Session and Service Continuity | +| SST | Slice/Service Type | +| TCP | Transmission Control Protocol | +| TNAP | Trusted Non-3GPP Access Point | +| TWAP | Trusted WLAN Access Point | +| UDP | User Datagram Protocol | +| UPF | User Plane Function | +| V-SMF | Visited SMF | +| VAL | Vertical Application Layer | +| WAN | Wide Area Network | + +# --- 4 Network Characteristics + +## 4.1 Key characteristics of PLMN + +The PLMN is fully defined in the 3GPP technical specifications. The 5G Network related key characteristics are defined in 3GPP TS 23.501 [2]. + +## 4.2 Key characteristics of IP Networks + +The Internet is a conglomeration of networks utilising a common set of protocols. IP protocols are defined in the relevant IETF RFCs. The networks topologies may be based on LANs (e.g. Ethernet), Point to Point leased lines, PSTN, ISDN, X.25 or WANs using switched technology (e.g. SMDS, ATM). + +## 4.3 Key characteristics of Ethernet + +The Ethernet is a family of computer networking technologies commonly used in LAN and is often used to refer to all Carrier Sense Multiple Access/Collision Detection (CSMA/CD) LANs that generally conform to Ethernet Specifications, including IEEE 802.3 [36]. The key characteristics for Ethernet are defined in IEEE 802.3 [36]. + +# 5 Interworking Classifications + +## 5.1 Service Interworking + +Service interworking is required when the Teleservice at the calling and called terminals are different. No service interworking is specified in this specification. + +## 5.2 Network Interworking + +Network interworking is required whenever a PLMN is involved in communications with another network to provide end-to-end communications. The PLMN shall interconnect in a manner consistent with that of a normal Data Network (type defined by the requirements e.g. IP). Interworking appears exactly like that of Data Networks. + +# 6 Reference Architecture + +Figure 6-1 shows the access interfaces for the 5G Network. Figure 6-2 shows the access interfaces for the 5G and EPC interworking network. + +The 5G Network includes both the 3GPP access and the non-3GPP access. + +The NSS-AAA may belong to the H-PLMN in the 5G Network (without AAA-P interworking) or a 3rd party (with AAA-P interworking). + +![Reference Architecture for 5G Network Interworking diagram](e58a867750e4ae01604318506b79df7a_img.jpg) + +The diagram illustrates the reference architecture for 5G network interworking. A large light blue oval labeled '5G network' contains several functional blocks: 'UE' (User Equipment) connected to 'NG-RAN'; 'NG-RAN' connected to 'AMF' and 'UPF'; 'AMF' connected to 'NSSAAF/AAA-P'; 'NSSAAF/AAA-P' connected to 'NSS-AAA' (outside the 5G network oval); and 'SMF' connected to 'UPF'. The 'UPF' is connected to 'Data Networks' (represented by a light blue oval) via an 'N6' interface. Inside the 'Data Networks' oval, there is a 'DN-AAA/DHCP' block. The 'NSS-AAA' block is also connected to the 'Data Networks' oval. + +Reference Architecture for 5G Network Interworking diagram + +Figure 6-1: Reference Architecture for 5G Network Interworking + +![Figure 6-2: Reference Architecture for 5G and EPC Interworking. The diagram shows a 5G network (shaded oval) containing a UE, E-UTRAN, NG-RAN, AMF, NSSAAF/AAA-P, SMF+PGW-C, and UPF+PGW-U. The UE is connected to E-UTRAN and NG-RAN. E-UTRAN and NG-RAN are connected to the AMF. The AMF is connected to the NSSAAF/AAA-P. The NSSAAF/AAA-P is connected to an external NSS-AAA. The AMF is also connected to the SMF+PGW-C and the UPF+PGW-U. The SMF+PGW-C is connected to the UPF+PGW-U. The UPF+PGW-U is connected to the SMF+PGW-C and has an N6 interface leading to external Data Networks (DN-AAA/DHCP).](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +Figure 6-2: Reference Architecture for 5G and EPC Interworking. The diagram shows a 5G network (shaded oval) containing a UE, E-UTRAN, NG-RAN, AMF, NSSAAF/AAA-P, SMF+PGW-C, and UPF+PGW-U. The UE is connected to E-UTRAN and NG-RAN. E-UTRAN and NG-RAN are connected to the AMF. The AMF is connected to the NSSAAF/AAA-P. The NSSAAF/AAA-P is connected to an external NSS-AAA. The AMF is also connected to the SMF+PGW-C and the UPF+PGW-U. The SMF+PGW-C is connected to the UPF+PGW-U. The UPF+PGW-U is connected to the SMF+PGW-C and has an N6 interface leading to external Data Networks (DN-AAA/DHCP). + +**Figure 6-2: Reference Architecture for 5G and EPC Interworking** + +NOTE 1: The SMF represents the H-SMF and the SMF+PGW-C represents the H-SMF+ H-PGW-C in the home routed scenario. + +NOTE 2: If the DN-AAA server or the DHCP server located in 5GC or in the external PDN is reachable directly, then the SMF or SMF+PGW-C can communicate with the DN-AAA server directly without involving the UPF or UPF+PGW-U, applicable to all the message flows on N6 interface in clause 11 and clause 12 in this specification. + +NOTE 3: In the follow clauses, the description on SMF also applies to SMF+PGW-C, the description on UPF also applies to UPF+PGW-U, unless otherwise specified. + +# 7 Interface to 5G Network services (User Plane) + +The user plane for 5G Network services is defined in clause 8.3 of 3GPP TS 23.501 [2] and 3GPP TS 29.281 [4]. + +# 8 Interworking with DN (IP) + +## 8.1 General + +5GS shall support interworking with DNs based on the Internet Protocol (IP). These interworked networks may be either intranets or the Internet. + +## 8.2 DN Interworking Model + +### 8.2.1 General + +When interworking with the IP networks, the 5GS can operate IPv4 and/or IPv6. The interworking point is shown in clause 6. + +The UPF for interworking with the IP network is the 5GS access point (see figure 8.2.1-1). + +![Figure 8.2.1-1: The protocol stacks of UPF for the IP network interworking. The diagram shows the UPF (User Plane Function) containing a stack of layers: IP (top), L2 (middle), and L1 (bottom). The IP layer is split into two paths. The L2 and L1 layers are part of the 5G protocol layers. The N6 reference point is shown as a vertical line to the right of the UPF, indicating the interface to the external IP network.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +Figure 8.2.1-1: The protocol stacks of UPF for the IP network interworking. The diagram shows the UPF (User Plane Function) containing a stack of layers: IP (top), L2 (middle), and L1 (bottom). The IP layer is split into two paths. The L2 and L1 layers are part of the 5G protocol layers. The N6 reference point is shown as a vertical line to the right of the UPF, indicating the interface to the external IP network. + +**Figure 8.2.1-1: The protocol stacks of UPF for the IP network interworking** + +Typically, in the IP networks, the interworking with subnetworks is done via IP routers. The N6 reference point is between the UPF and the external IP network. From the external IP network's point of view, the UPF is seen as a normal IP router. The L2 and L1 layers are operator specific. + +It is out of the scope of the present document to standardise the router functions and the used protocols in the N6 reference point. + +Interworking with user defined ISPs and private/public IP networks is subject to interconnect agreements between the network operators. + +### 8.2.2 Access to DN through 5G Network + +#### 8.2.2.1 Transparent access to DN + +![Figure 8.2.2.1-1: Example of the DN Interworking Model, transparent case. The diagram shows the 5GS (5G System) connected to the UPF. The UPF is connected to the Operator specific IP Network via the N6 reference point. The Operator specific IP Network is connected to the External IP Network via a Firewall / Proxy. The Operator specific IP Network also includes DHCP and DNS components.](2e399449b7f62d40167a65ca88888917_img.jpg) + +Figure 8.2.2.1-1: Example of the DN Interworking Model, transparent case. The diagram shows the 5GS (5G System) connected to the UPF. The UPF is connected to the Operator specific IP Network via the N6 reference point. The Operator specific IP Network is connected to the External IP Network via a Firewall / Proxy. The Operator specific IP Network also includes DHCP and DNS components. + +**Figure 8.2.2.1-1: Example of the DN Interworking Model, transparent case** + +In figure 8.2.2.1-1, an example DN interworking model for transparent access to the Internet is provided for an UPF in the 5GS and its N6 reference point. + +In transparent access to the Internet case: + +- the UE is given an IPv4 address and/or an IPv6 prefix belonging to the operator addressing space. The IPv4 address and/or IPv6 prefix is assigned either at subscription in which case it is a static address or at PDU session establishment in which case it is a dynamic address. This IPv4 address and/or IPv6 prefix if applicable is used for packet forwarding between the Internet and the UPF and within the 5GS. With IPv6, Stateless Address Autoconfiguration shall be used to assign an IPv6 address to the UE. These procedures are as described in the IPv6 non-transparent access case except that the addresses belong to the operator addressing space. + +- the UE need not send any authentication request at PDU session establishment procedure and the SMF/UPF need not take any part in the user authentication/authorization process. + +The transparent case provides at least a basic ISP service. As a consequence of this it may therefore provide a QoS flow service for a tunnel to a private Intranet. The user level configuration may be carried out between the UE and the intranet, the 5GS is transparent to this procedure. The used protocol stack is depicted in figure 8.2.2.1-2. + +![Figure 8.2.2.1-2: Transparent access to an Intranet. The diagram shows three entities: UE, UPF, and Intranet. The UE has a stack of 'Intranet protocol', 'IP', and '5G protocol layers'. The UPF has a stack of 'IP' (split into two paths) and 'L2/L1', with '5G protocol layers' on its left side. The Intranet has a stack of 'Intranet protocol', 'IP', and 'L2/L1'. Double-headed arrows connect the UE to the UPF and the UPF to the Intranet.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +Figure 8.2.2.1-2: Transparent access to an Intranet. The diagram shows three entities: UE, UPF, and Intranet. The UE has a stack of 'Intranet protocol', 'IP', and '5G protocol layers'. The UPF has a stack of 'IP' (split into two paths) and 'L2/L1', with '5G protocol layers' on its left side. The Intranet has a stack of 'Intranet protocol', 'IP', and 'L2/L1'. Double-headed arrows connect the UE to the UPF and the UPF to the Intranet. + +**Figure 8.2.2.1-2: Transparent access to an Intranet** + +The communication between the PLMN and the Intranet may be performed over any network, even an insecure network e.g. the Internet. There is no specific security protocol between the UPF and the Intranet because security is ensured on an end to end basis between the UE and the intranet by the "Intranet Protocol". + +User authentication and encryption of user data are done within the "Intranet Protocol" if either of them is needed. This "Intranet Protocol" may also carry private (IP) addresses belonging to the address space of the Intranet. + +An example of an "Intranet Protocol" is IPsec (see IETF RFC 1825 [29]). If IPsec is used for this purpose, then IPsec authentication header or security header may be used for user (data) authentication and for the confidentiality of user data (see IETF RFC 1826 [30] and IETF RFC 1827 [31]). In this case private IP tunnelling within public IP takes place. + +#### 8.2.2.2 IPv4 Non-transparent access to DN + +In this case: + +- a static or a dynamic IPv4 address belonging to the Intranet/ISP addressing space is allocated to a UE at PDU session establishment. The methods of allocating IP address to the UE are specified in 3GPP TS 23.501 [2]. The allocated IPv4 address is used for packet forwarding within the UPF or UPF+PGW-U and for packet forwarding on the Intranet/ISP; +- as a part of the PDU session establishment, the SMF or SMF+PGW-C may request user authentication from an external DN-AAA server (i.e. RADIUS, Diameter) belonging to the Intranet/ISP; +- the IPv4 address allocation to the UE may be performed based on the subscription or a local address pool, which belongs to the Intranet/ISP addressing space, provisioned in the SMF or SMF+PGW-C; provisioned in the UPF or UPF+PGW-U or via the address allocation servers (i.e. DHCPv4, RADIUS DN-AAA, Diameter DN-AAA) belonging to the Intranet/ISP; +- if requested by the UE at PDU session establishment, the SMF or SMF+PGW-C may retrieve the Protocol Configuration Options or IPv4 configuration parameters from a locally provisioned database in SMF or SMF+PGW-C and/or from some external server (i.e. DHCPv4, RADIUS DN-AAA, Diameter DN-AAA) belonging to the Intranet/ISP; +- the communication between the 5GS and the Intranet/ISP may be performed over any network, even an insecure network, e.g. the Internet. In case of an insecure connection between the UPF or UPF+PGW-U and the Intranet/ISP, there may be a specific security protocol in between. This security protocol is defined by mutual agreement between PLMN operator and Intranet/ISP administrator. + +Table 8.2.2.2-1 summarizes the IPv4 address allocation and parameter configuration use cases between the UE and the SMF or SMF+PGW-C that may lead the SMF or SMF+PGW-C to interwork with the external DHCPv4, DN-AAA servers. For detailed description of the signalling flows between the UE and the SMF or SMF+PGW-C, see the references in the table. + +Table 8.2.2.2-1: IPv4 address allocation and parameter configuration use cases + +| Signalling use cases between UE and SMF or SMF+PGW-C | Signalling use cases between SMF or SMF+PGW-C and external servers | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| | Authentication via RADIUS or Diameter DN-AAA server (clauses 11 or 12) (NOTE 1 NOTE 2 and NOTE 4) | IPv4 Address allocation via DHCPv4 or RADIUS or Diameter DN-AAA server (clauses 10, 11 or 12) (NOTE 1 and NOTE 2) | IPv4 parameter configuration via DHCPv4 or RADIUS or Diameter DN-AAA server (clauses 10, 11 or 12) (NOTE 1 and NOTE 2) | +| (1) IPv4 address allocation and parameter configuration via activation of QoS flow associated with the default QoS rule
(2) IPv4 address allocation and parameter configuration via DHCPv4 signalling from UE towards SMF or SMF+PGW-C (NOTE 3) | X | X | X | +| (3) IPv4 address allocation and parameter configuration in untrusted non-3GPP IP access | X | X | X | + +NOTE 1: When the SMF or SMF+PGW-C interworks with AAA servers, the DNN may be configured to interwork with either Diameter DN-AAA or RADIUS DN-AAA server. + +NOTE 2: If RADIUS DN-AAA or Diameter DN-AAA server is used, the authentication, IPv4 address allocation and parameter configuration signalling may be combined. Similarly, if DHCPv4 server is used for IPv4 address allocation and parameter configuration, the signalling towards the DHCPv4 server may be combined. + +NOTE 3: If the authentication and authorization procedure towards RADIUS DN-AAA or Diameter DN-AAA is required, it is performed by the SMF or SMF+PGW-C before the DHCPv4 signalling when it receives the initial access request (i.e. Nsmf\_PDUSession\_CreateSMContext). + +NOTE 4: The UEs may provide PAP/CHAP user credentials in the ePCO IE when accessing to 5GS or 5GS interworking with EPS on 3GPP and non-3GPP IP accesses. If such information is provided to the SMF or SMF+PGW-C, the SMF or SMF+PGW-C may perform user authentication with the DN-AAA server based on these credentials. + +NOTE: External network operators intending to use PAP/CHAP without proper underlying protection for authentication are warned about the respective vulnerabilities of PAP and CHAP protocols from a security point of view. It's up to the external network operator to perform the risk assessment if PAP/CHAP is used for authentication. + +#### 8.2.2.3 IPv6 Non-transparent access to DN + +When using IPv6 Address Autoconfiguration, the process of setting up the access to an Intranet or ISP involves two signalling phases. The first signalling phase is done in the control plane and consists of the PDU session establishment for 5GS 3GPP or non-3GPP based access, followed by a second signalling phase done in the user plane. + +The user plane signalling phase shall be stateless. The stateless procedure, which involves only the UE and the SMF or SMF+PGW-C, is described in clause 10.2.3. + +For DNNs that are configured for IPv6 address allocation, the SMF or SMF+PGW-C shall only use the Prefix part of the IPv6 address for forwarding of mobile terminated IP packets. The size of the prefix shall be according to the maximum prefix length for a global IPv6 address as specified in the IPv6 Addressing Architecture, see IETF RFC 4291 [32]. + +The SMF or SMF+PGW-C indicates to the UE that Stateless Autoconfiguration shall be performed by sending Router Advertisements as described in clause 10.2.3 and according to the principles defined in IETF RFC 4861 [33] and IETF RFC 4862 [34]. + +For UE supporting IPv6, IPv6 Stateless Address Autoconfiguration is mandatory. + +In this case, the SMF or SMF+PGW-C provides the UE with an IPv6 Prefix belonging to the Intranet/ISP addressing space. A dynamic IPv6 address is given using stateless address autoconfiguration. This IPv6 address is used for packet forwarding within the UPF and for packet forwarding on the Intranet/ISP. + +When an SMF or SMF+PGW-C receives an initial access request (i.e. Nsmf\_PDUSession\_CreateSMContext) message, the SMF or SMF+PGW-C deduces from local configuration data associated with the DNN: + +- The source of IPv6 Prefixes (SMF or SMF+PGW-C internal prefix pool, or external address allocation server); +- Any server(s) to be used for address allocation, authentication and/or protocol configuration options retrieval (e.g. IMS related configuration, see 3GPP TS 24.229 [13]); +- The protocol, i.e. RADIUS, Diameter or DHCPv6, to be used with the server(s); +- The communication and security feature needed to communicate with the server(s). + +As an example, the SMF or SMF+PGW-C may use one of the following options: + +- SMF or SMF+PGW-C internal Prefix pool for IPv6 prefixes allocation and no authentication; +- SMF or SMF+PGW-C internal Prefix pool for IPv6 prefixes allocation and RADIUS for authentication. The RADIUS DN-AAA server responds with either an Access-Accept or an Access-Reject to the RADIUS client in the SMF or SMF+PGW-C; +- RADIUS for authentication and IPv6 prefix allocation. The RADIUS DN-AAA server responds with either an Access-Accept or an Access-Reject to the RADIUS client in the SMF or SMF+PGW-C. +- RADIUS for authentication. DHCPv6 for IPv6 prefix allocation and may support IPv6 prefix delegation for allocating additional IPv6 prefix(es). The details of IPv6 prefix delegation are described in clause 10.2.5. + +The SMF or SMF+PGW-C includes the IPv6 address composed of a Prefix and an Interface-Identifier in the initial access response (Namf\_Communication\_N1N2MessageTransfer). The Interface-Identifier may have any value and it does not need to be unique within or across DNNs. It shall however not conflict with the Interface-Identifier that the SMF or SMF+PGW-C has selected for its own side of the UE-SMF link. The Prefix assigned by the SMF or SMF+PGW-C or the external DN-AAA server shall be globally or site-local unique (see the Note in clause 11.3 of this document regarding the usage of site-local addresses). + +Table 8.2.2.3-1 summarizes the IPv6 prefix allocation and parameter configuration use cases between the UE and the SMF or SMF+PGW-C that may lead the SMF or SMF+PGW-C to interwork with the external RADIUS DN-AAA, Diameter DN-AAA and DHCPv6 servers. For detailed description of the signalling flows between the UE and the SMF or SMF+PGW-C, see the references in the table. + +**Table 8.2.2.3-1: IPv6 prefix allocation and parameter configuration use cases** + +| Signalling use cases between UE and SMF or SMF+PGW-C | Signalling use cases between SMF or SMF+PGW-C and external servers | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| +| | Authentication via RADIUS or Diameter DN-AAA server (clauses 11 or 12) (NOTE 1 NOTE 2 and NOTE 3) | IPv6 prefix allocation via DHCPv6 or RADIUS or Diameter DN-AAA server (clauses 10, 11 or 12) (NOTE 1 and NOTE 2) | IPv6 parameter configuration via DHCPv6 or RADIUS or Diameter DN-AAA server (clauses 10, 11 or 12) (NOTE 1 and NOTE 2) | +| (1) IPv6 address allocation and parameter configuration | X | X | X | +| (2) IPv6 parameter configuration via stateless DHCPv6 | | | | +| (3) IPv6 address allocation and parameter configuration in untrusted non-3GPP IP access | X | X | X | +| NOTE 1: When the SMF or SMF+PGW-C interworks with DN-AAA servers, the DNN may be configured to interwork with either Diameter DN-AAA or RADIUS DN-AAA server. | | | | +| NOTE 2: If RADIUS DN-AAA or Diameter DN-AAA server is used, the authentication, IPv6 prefix allocation and parameter configuration signalling may be combined. Similarly, if DHCPv6 server is used for IPv6 prefix allocation and parameter configuration, the signalling towards the DHCPv6 server may be combined. | | | | +| NOTE 3: The UEs may provide PAP/CHAP user credentials in the ePCO IE when accessing to 5GS or 5GS interworking with EPS on 3GPP and non-3GPP IP accesses. If such information is provided to the SMF or SMF+PGW-C, the SMF or SMF+PGW-C may perform user authentication with the DN-AAA server based on these credentials. | | | | + +NOTE: External network operators intending to use PAP/CHAP without proper underlying protection for authentication are warned about the respective vulnerabilities of PAP and CHAP protocols from a security point of view. It's up to the external network operator to perform the risk assessment if PAP/CHAP is used for authentication. + +For IPv6 the PDU session establishment phase is followed by an address autoconfiguration phase. IPv6 prefix is delivered to UE in Router Advertisement message from the SMF or SMF+PGW-C which acts as an access router, in the process of IPv6 Stateless Address Autoconfiguration as described in clause 10.2.2. Besides DHCPv6 protocol, the SMF or PGW-C may also use RADIUS or Diameter protocol for the retrieval of an IPv6 prefix from external DN. + +## 8.3 Transport Level Marking + +Based on operator policy, the transport level packet marking (e.g. setting the DiffServ Code Point) by the SMF/UPF in the uplink may be based on the 5QI, the Priority Level (if explicitly signalled), and optionally the ARP priority level, of the associated QoS flow. + +# --- 9 Interworking with DN (Unstructured) + +## 9.1 General + +When support of unstructured PDU type data is provided at the N6 interface, different Point-to-Point (PtP) tunneling techniques may be used. When using PtP tunneling by UDP/IPv6 encapsulation clause 9.2 below shall be followed. Other techniques as described in clause 9.3 below may be used. + +In the following clauses, the AS is used as an example for the destination in the external DN. + +## 9.2 N6 PtP tunnelling based on UDP/IP + +N6 PtP tunnelling based on UDP/IPv6 may be used to deliver unstructured PDU type data to the AS. + +The PtP tunnel is set up by configuration of tunnel parameters in both end of the tunnel. The following parameters are pre-configured in the UPF per DNN: + +- the UDP destination port number to use when sending unstructured PDU type data; +- the UDP port number it wants to receive unstructured PDU type data; +- the destination IP address to be used for sending unstructured PDU type data. + +The following is pre-configured in the AS: + +- the UDP destination port number to use when sending unstructured PDU type data; +- the UDP port number it wants to receive unstructured PDU type data. + +NOTE 1: The UPF as well as the AS can use any UDP port numbers not assigned by IANA. The port numbers used need to be aligned between peers. + +IP address allocation procedures for the UE (i.e. PDU session) are performed by the SMF as described in clause 6.3.2, but the IPv6 prefix is not provided to the UE, i.e. Router Advertisements and DHCPv6 are not performed. The SMF assigns a suffix (i.e. IPv6 Interface Identifier) for the PDU session. For the N6 PtP tunnel, the IPv6 prefix allocated for the PDU session plus suffix assigned for the PtP tunnel is used as source address for the uplink data and as destination address for the downlink data. + +During the PDU session establishment, the UPF associates the GTP-U tunnel for the PDU session with the N6 PtP tunnel. + +The UPF acts as a transparent forwarding node between the UE and the AS. + +For uplink delivery, if the uplink data is received from the GTP-U tunnel, the UPF shall forward the received data to the AS over the N6 PtP tunnel associated with the GTP-U tunnel with the destination address of the AS and the configured UDP destination port number for unstructured PDU type data. + +For downlink delivery, the AS shall send the data using UDP/IP encapsulation with the IPv6 prefix plus suffix as destination address and the configured UDP destination port number for unstructured PDU type data. + +NOTE 2: The UPF decapsulates the received data (i.e. removes the UDP/IPv6 headers) and forwards the data on the GTP-U tunnel identified by the IPv6 prefix of the UE (i.e. PDU session) for delivery to the UE. + +![Diagram illustrating the protocol configuration for unstructured PDU type data (user plane) using N6 UDP/IPv6 PtP tunneling. The diagram shows the protocol stack at the UPF (User Plane Function) and the DN (Data Network) separated by the N6 interface. The UPF stack includes layers L1, L2, UDP/IP, GTP-U, and UDP, with a 'Relay' function indicated at the top. The DN stack includes layers L1, L2, IP, UDP, and Unstructured data. The N6 interface is shown as a vertical dashed line between the UPF and DN stacks.](8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg) + +| | | | | +|-----|--------|-----|-------------------| +| | | | Unstructured data | +| | | | UDP | +| | | | IP | +| | | | L2 | +| | | | L1 | +| N3 | Relay | | | +| | GTP-U | UDP | | +| | UDP/IP | IP | | +| | L2 | L2 | | +| | L1 | L1 | | +| UPF | | N6 | DN | + +Diagram illustrating the protocol configuration for unstructured PDU type data (user plane) using N6 UDP/IPv6 PtP tunneling. The diagram shows the protocol stack at the UPF (User Plane Function) and the DN (Data Network) separated by the N6 interface. The UPF stack includes layers L1, L2, UDP/IP, GTP-U, and UDP, with a 'Relay' function indicated at the top. The DN stack includes layers L1, L2, IP, UDP, and Unstructured data. The N6 interface is shown as a vertical dashed line between the UPF and DN stacks. + +**Figure 9.2-1: Protocol configuration for unstructured PDU type data (user plane) using N6 UDP/IPv6 PtP tunneling** + +## 9.3 Other N6 tunnelling mechanism + +N6 PtP tunnelling mechanisms such as PMIPv6/GRE, L2TP, etc, may be used to deliver unstructured PDU type data to AS. The general handling of such delivery mechanisms is as described below. + +A PtP tunnel is established by the UPF towards the AS. Depending on the type of protocol employed on the N6 PtP tunnel, the N6 PtP tunnel setup may be done at the time of PDU Session establishment or at the time of first MO datagram being sent by the UE. The UPF selects the AS based on its configuration (e.g. per DNN, or per PtP tunnel type, etc). However, IP address allocation procedures for the UE (according to clause 6.3.2) are not performed by the SMF. + +NOTE: An AS can be dedicated for handling a specific protocol for unstructured PDU type data. + +The UPF acts as a transparent forwarding node between the UE and the AS. + +For uplink delivery, the UPF forwards the received data to the AS over the established N6 PtP tunnel. + +For downlink delivery, the AS locates the right N6 PtP tunnel for the UE (using information such as UE identifiers in the unstructured PDU type protocol itself, etc) to forward the data. The AS sends the data to UPF over the established N6 PtP tunnel. The UPF in turn sends the data on the GTP-U tunnel identified by the associated N6 PtP tunnel for delivery to the UE. + +# 10 Interworking with DN (DHCP) + +## 10.1 General + +In current LAN environments the most commonly used configuration protocol is DHCP (Dynamic Host Configuration Protocol, IETF RFC 2131 [18]) and DHCPv6 (Dynamic Host Configuration Protocol for IPv6, IETF RFC 3315 [21]). It provides a mechanism for passing a large set of configuration parameters to hosts connected to a TCP/IP network (IP address, sub-net mask, domain name, MTU, etc.) in an automatic manner. Moreover, DHCP may assign IP addresses to clients for a finite lease time, allowing for sequential reassignment of addresses to different users. + +The lease time is chosen by the administrator of the DHCP server (in the external network), and is therefore out of the scope of the present document. + +The 3GPP network may obtain IP address via external DHCP server during the PDU establishment procedure, the SMF or SMF+PGW-C acts a DHCP server towards the UE and it acts as a DHCP client towards the external DHCP server. + +In the following cases the PDU session associated with the allocated IPv4 address or IPv6 prefix shall be released: + +- if the DHCP lease expires; +- if the DHCP renewal is rejected by the DHCP server; +- if the IP address is changed during the renewal process. Usually when the lease is renewed, the IP address remains unchanged. However, if for any reason (e.g. poor configuration of the DHCP server), a different IP address is allocated during the lease renewal process the associated PDU session shall be released. + +A RG may request DHCP signalling for a UE behind the RG as specified in 3GPP TS 23.316 [43]. When handling DHCP signalling coming from the wireline BBF access, the SMF or SMF+PGW-C shall support the DHCP signalling as described in BBF TR-456 [54]. + +## 10.2 DN interworking Model of SMF or SMF+PGW-C for DHCP + +A DHCP client shall be located in the SMF or SMF+PGW-C used for interworking with the IP network as illustrated in figure 10.2.1-1. + +![Diagram showing the protocol stack for the N6 reference point for DHCP. On the left, a box labeled 'SMF or SMF+PGW-C' contains a vertical stack of five layers: 'DHCP Client', 'UDP', 'IP', 'L2', and 'L1'. An arrow points from the 'IP' layer of this stack to the right. In the center, a box labeled 'UPF' is shown. The arrow from the SMF/SMF+PGW-C points into the 'UPF' box. From the 'UPF' box, another arrow points to the right, towards a vertical line labeled 'N6'.](cf4ac1058c52bc3ca37737740afb7f2c_img.jpg) + +The diagram illustrates the protocol stack for the N6 reference point for DHCP. On the left, a box labeled 'SMF or SMF+PGW-C' contains a vertical stack of five layers: 'DHCP Client', 'UDP', 'IP', 'L2', and 'L1'. An arrow points from the 'IP' layer of this stack to the right. In the center, a box labeled 'UPF' is shown. The arrow from the SMF/SMF+PGW-C points into the 'UPF' box. From the 'UPF' box, another arrow points to the right, towards a vertical line labeled 'N6'. + +Diagram showing the protocol stack for the N6 reference point for DHCP. On the left, a box labeled 'SMF or SMF+PGW-C' contains a vertical stack of five layers: 'DHCP Client', 'UDP', 'IP', 'L2', and 'L1'. An arrow points from the 'IP' layer of this stack to the right. In the center, a box labeled 'UPF' is shown. The arrow from the SMF/SMF+PGW-C points into the 'UPF' box. From the 'UPF' box, another arrow points to the right, towards a vertical line labeled 'N6'. + +**Figure 10.2.1-1: The protocol stacks for the N6 reference point for DHCP** + +The DHCP client function in the SMF or SMF+PGW-C shall be used to allocate IPv4 address or IPv6 prefix to the UE and/or to configure associated parameters via external DHCP servers. The SMF or SMF+PGW-C shall have both DHCPv4 and DHCPv6 client functions. + +The procedures where the DHCP client function in the SMF or SMF+PGW-C is used are further described in 3GPP TS 23.501 [2]. The procedures are IPv4 address allocation and IPv4 parameter configuration via an external DHCPv4 server; IPv6 Prefix allocation via stateless address autoconfiguration; and IPv6 parameter configuration via stateless DHCPv6. These procedures are detailed in the clauses below. + +### 10.2.2 IPv4 Address allocation and IPv4 parameter configuration via DHCPv4 + +The UE may obtain the IPv4 address and/or its configuration parameters at or after the initial access signalling (i.e. Nsmf\_PDUSession\_CreateSMContext) to the 3GPP network. The request for IPv4 address and/or configuration parameters from the UE may trigger the SMF or SMF+PGW-C acting as a DHCPv4 client to request the IPv4 address and/or configuration parameters from an external DHCPv4 server and deliver them to the UE. The DHCPv4 functions in the SMF or SMF+PGW-C, the UE and the external DHCPv4 server shall be compliant to IETF RFC 2131 [18], IETF RFC 1542 [19] and IETF RFC 4039 [20]. + +The following system procedure describes the successful IPv4 address allocation and parameter configuration signalling flow between the SMF or SMF+PGW-C and the external DHCPv4 server as depicted in figure 10.2.2-1. For a detailed description of the DHCPv4 messages, refer to IETF RFC 2131 [18], IETF RFC 1542 [19] and IETF RFC 4039 [20]. + +- 1) The DHCPv4 client function in the SMF or SMF+PGW-C sends a DHCPDISCOVER as an IP limited broadcast message, i.e. the destination address 255.255.255.255, towards the external DN. If the SMF or SMF+PGW-C has the DHCPv4 server IP addresses configured for the DNN, the DHCPDISCOVER shall be sent as unicast (or even multicast) to the external DHCPv4 servers. +- 2) Upon receiving the DHCPDISCOVER request message, the external DHCPv4 servers reply by sending a DHCPOFFER message including an offered IP address. Several DHCPOFFER messages may be received by the SMF or SMF+PGW-C if multiple DHCPv4 servers respond to the DHCPDISCOVER. +- 3) The DHCPv4 client function in the SMF or SMF+PGW-C processes the messages and sends a DHCPREQUEST towards the selected external DHCPv4 server. + +NOTE: If the optimized signalling (Rapid Commit Option) is used as per IETF RFC 4039 [20], the messages 2-3 can be eliminated. + +- 4) Upon receiving the DHCPREQUEST message, the selected external DHCPv4 server acknowledges the address allocation by sending a DHCPACK containing the lease period (T1), the time-out time (T2) and the configuration information requested in DHCPREQUEST. The SMF or SMF+PGW-C stores the allocated IPv4 address, the lease timers and the configuration parameters. The SMF or SMF+PGW-C shall further deliver the IPv4 address and the configuration parameters to the UE by SM NAS message. + +![Sequence diagram showing the signalling flow for IPv4 address allocation and parameter configuration using DHCPv4 between the SMF or SMF+PGW-C (DHCPv4 Client) and the DHCPv4 Server.](552ca016af3d6240648ab5a2cad97f60_img.jpg) + +``` +sequenceDiagram + participant Client as SMF or SMF+PGW-C (DHCPv4 Client) + participant Server as DHCPv4 Server + Note left of Client: UE triggers the process + Client->>Server: 1. DHCPDISCOVER + Server-->>Client: 2. DHCPOFFER + Client->>Server: 3. DHCPREQUEST + Server-->>Client: 4. DHCPACK + Note right of Server: UE receives configuration +``` + +Sequence diagram showing the signalling flow for IPv4 address allocation and parameter configuration using DHCPv4 between the SMF or SMF+PGW-C (DHCPv4 Client) and the DHCPv4 Server. + +**Figure 10.2.2-1: The signalling flow for IPv4 address allocation and parameter configuration using DHCPv4** + +Figure 10.2.2-2 is a signalling flow for IPv4 address lease renew by using DHCPv4 protocol as specified in IETF RFC 2131 [18]. + +- 1) The DHCPv4 client function in the SMF or SMF+PGW-C sends a unicast DHCPREQUEST towards the external DHCPv4 server to extend the lease period of the allocated IPv4 address. + +- 2) The external DHCPv4 server replies with a DHCPACK message confirming the renewed lease and the T1 and T2 timers are restarted. + +![Diagram showing the signalling flow for IPv4 address lease renewal. A DHCPv4 Client (SMF or SMF+PGW-C) sends a DHCPREQUEST message to a DHCPv4 Server. The server responds with a DHCPACK message.](a3472689858b068ef469213682965325_img.jpg) + +``` + +sequenceDiagram + participant Client as SMF or SMF+PGW-C (DHCPv4 Client) + participant Server as DHCPv4 Server + Note left of Client: + Client->>Server: 1. DHCPREQUEST + Note right of Server: + Server-->>Client: 2. DHCPACK + +``` + +Diagram showing the signalling flow for IPv4 address lease renewal. A DHCPv4 Client (SMF or SMF+PGW-C) sends a DHCPREQUEST message to a DHCPv4 Server. The server responds with a DHCPACK message. + +Figure 10.2.2-2: The signalling flow for IPv4 address lease renew using DHCPv4 + +### 10.2.3 IPv6 Prefix allocation via IPv6 stateless address autoconfiguration via DHCPv6 + +When the IPv6 prefix is allocated from the external DN, the SMF or SMF+PGW-C is responsible to obtain the IPv6 prefix for external DN, allocate and release the IPv6 prefix. The SMF or SMF+PGW-C may use DHCPv6 to obtain the IPv6 prefix from the external DN. In this context, the SMF or SMF+PGW-C shall act as a DHCP client as per IETF RFC 3315 [21] towards the external DHCPv6 server. + +The SMF or SMF+PGW-C may allocate a second IPv6 prefix for routing traffic via a second UPF or UPF+PGW-U to enable simultaneous access via remote and local networks or to enable SSC mode 3 (i.e. make-before-break) mobility, as described in clause 4.3.5.3 of 3GPP TS 23.502 [3]. + +The following system procedure describes the signalling flows for the IPv6 Stateless Address Autoconfiguration procedures for 5G system. The procedures are based on the descriptions in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +1. UE initiates the PDU Session Establishment procedure, indicating IPv6 address is required. +2. The AMF sends PDU Session Establishment Request in Nsmf\_PDUSession\_CreateSMContext to the SMF or SMF+PGW-C. +3. The SMF or SMF+PGW-C may retrieve IPv6 prefix using DHCPv6 mechanism. This procedure is performed when an external DN allocates an IPv6 prefix, the signaling between the SMF or SMF+PGW-C and external DN is exchanged via UPF or UPF+PGW-U which is omitted in the figure 10.2.3-1. +4. The SMF or SMF+PGW-C sends PDU Session Establishment Accept included in Namf\_Communication\_N1N2MessageTransfer to the AMF. It includes the IPv6 prefix. +5. The AMF sends PDU Session Establishment Accept message to the UE without the IPv6 prefix. The UE shall ignore the IPv6 prefix if it receives it in the message. +6. The UE may send a Router Solicitation to the SMF or SMF+PGW-C via the UPF or UPF+PGW-U to solicit a Router Advertisement message. +7. The SMF or SMF+PGW-C sends a Router Advertisement message to the UE via the UPF or UPF+PGW-U, solicited or unsolicited. It shall include an IPv6 prefix in Prefix Information option field of the message. The prefix is the same as the one in the PDU Session Establishment Accept message, if it is provided during the previous PDU Session Establishment procedure. +8. At any time after PDU session establishment, the SMF or SMF+PGW-C may trigger the establishment on an alternative route via UPF2 or UPF+PGW-U2 for access to a local data network or for SSC mode 3 mobility. +9. Like step 3, the SMF or SMF+PGW-C may retrieve a second IPv6 prefix using DHCPv6 mechanism. +10. The SMF or SMF+PGW-C sends a Router Advertisement to the UE via UPF2 or UPF+PGW-U2 to update the UE. Note that this will occur without a Router Solicitation since the UE is unaware of the network's decision to form an alternative Route. + +11. Specific to the case of SSC mode 3 mobility, the SMF or SMF+PGW-C sends a Router Advertisement to the UE via UPF1 or UPF+PGW-U1 with zero value in the preferred lifetime field and a value in the valid lifetime field according to IETF RFC 4862 [34]. The UE shall update the valid lifetime of the old IPv6 prefix to the signalled value, regardless of the remaining lifetime. The signalled lifetime value indicates how long the SMF or SMF+PGW-C is willing to keep the old IPv6 prefix. + +NOTE: Alternative routes can be established repeatedly through additional UPFs or UPF+PGW-U's and old routes can be terminated when required by the SMF or SMF+PGW-C. More complex scenarios are not described here for the sake of simplicity. + +![Sequence diagram for IPv6 Stateless Address Autoconfiguration. Lifelines: UE, AMF, UPF1 or UPF+PGW-U1, UPF2 or UPF+PGW-U2, SMF or SMF+PGW-C, External PDN. The sequence shows 11 steps: 1. PDU Session Establishment Request (UE to AMF); 2. Nsmf_PDUSession_CreateSMContext (AMF to SMF); 3. DHCPv6 (SMF to External PDN); 4. Namf_Communication_N1N2MessageTransfer (SMF to AMF); 5. PDU Session Establishment Accept (AMF to UE); 6. Router Solicitation (through UPF1) (UE to SMF); 7. Router Advertisement (through UPF1) (SMF to UE); 8. Create a 2nd IPv6 Prefix tunneled through UPF2 for the existing PDU session (SMF to UPF2); 9. DHCPv6 (SMF to External PDN); 10. Router Advertisement (through UPF2) (UPF2 to UE); 11. Router Advertisement (through UPF1) (SMF to UE).](7d3d5fb5d09c0cd35a9d637be241651e_img.jpg) + +``` + +sequenceDiagram + participant UE + participant AMF + participant UPF1 as UPF1 or UPF+PGW-U1 + participant UPF2 as UPF2 or UPF+PGW-U2 + participant SMF as SMF or SMF+PGW-C + participant ExternalPDN as External PDN + + Note left of UE: 1. PDU Session Establishment Request + UE->>AMF: 1. PDU Session Establishment Request + Note right of AMF: 2. Nsmf_PDUSession_CreateSMContext (PDU Session Establishment Request) + AMF->>SMF: 2. Nsmf_PDUSession_CreateSMContext (PDU Session Establishment Request) + Note right of SMF: 3. DHCPv6 + SMF-->>ExternalPDN: 3. DHCPv6 + Note right of SMF: 4. Namf_Communication_N1N2MessageTransfer (PDU Session Establishment Accept) + SMF->>AMF: 4. Namf_Communication_N1N2MessageTransfer (PDU Session Establishment Accept) + Note left of AMF: 5. PDU Session Establishment Accept + AMF->>UE: 5. PDU Session Establishment Accept + Note left of UE: 6. Router Solicitation (through UPF1) + UE-->>SMF: 6. Router Solicitation (through UPF1) + Note right of SMF: 7. Router Advertisement (through UPF1) + SMF->>UE: 7. Router Advertisement (through UPF1) + Note right of SMF: 8. Create a 2nd IPv6 Prefix tunneled through UPF2 for the existing PDU session + SMF->>UPF2: 8. Create a 2nd IPv6 Prefix tunneled through UPF2 for the existing PDU session + Note right of SMF: 9. DHCPv6 + SMF-->>ExternalPDN: 9. DHCPv6 + Note right of UPF2: 10. Router Advertisement (through UPF2) + UPF2->>UE: 10. Router Advertisement (through UPF2) + Note right of SMF: 11. Router Advertisement (through UPF1) + SMF->>UE: 11. Router Advertisement (through UPF1) + +``` + +Sequence diagram for IPv6 Stateless Address Autoconfiguration. Lifelines: UE, AMF, UPF1 or UPF+PGW-U1, UPF2 or UPF+PGW-U2, SMF or SMF+PGW-C, External PDN. The sequence shows 11 steps: 1. PDU Session Establishment Request (UE to AMF); 2. Nsmf\_PDUSession\_CreateSMContext (AMF to SMF); 3. DHCPv6 (SMF to External PDN); 4. Namf\_Communication\_N1N2MessageTransfer (SMF to AMF); 5. PDU Session Establishment Accept (AMF to UE); 6. Router Solicitation (through UPF1) (UE to SMF); 7. Router Advertisement (through UPF1) (SMF to UE); 8. Create a 2nd IPv6 Prefix tunneled through UPF2 for the existing PDU session (SMF to UPF2); 9. DHCPv6 (SMF to External PDN); 10. Router Advertisement (through UPF2) (UPF2 to UE); 11. Router Advertisement (through UPF1) (SMF to UE). + +Figure 10.2.3-1: IPv6 Stateless Address Autoconfiguration + +### 10.2.4 IPv6 parameter configuration via stateless DHCPv6 + +A UE that has obtained an IPv6 address may use stateless DHCP to request other configuration information such as a list of DNS recursive name servers or SIP servers. + +For 3GPP networks, when an external DHCPv6 server in a DN is used to obtain the requested parameters, the SMF acts as a DHCPv6 client towards the external DHCPv6 server while acting a DHCPv6 server towards the UE. + +The IPv6 parameter configuration via stateless DHCPv6 function in the UE, the SMF and the external DHCPv6 Server shall be compliant to IETF RFC 3736 [22]. The following system procedure describes the signalling flows for the IPv6 parameter configuration via stateless DHCPv6 procedures for 5G system. All messages in the following steps between the UE and the SMF are sent via the UPF. + +- 1) A Router Advertisement with the O-flag set, is sent from SMF to UE to indicate to it to retrieve other configuration information. +- 2) The UE sends an INFORMATION-REQUEST message with the IP destination address set to the All\_DHCP\_Relay\_Agents\_and\_Servers multicast address defined in the DHCPv6 IETF RFC 3315 [21]. The source address shall be the link-local address of the UE. The DHCP relay agent in the SMF shall forward the message. + +- 3) DHCP servers receiving the forwarded INFORMATION-REQUEST message, reply by sending a RELAY-REPLY message, with the "Relay Message" option including a REPLY message with the requested configuration parameters. + +The UE chooses one of the possibly several REPLY messages and extracts the configuration information. + +![Sequence diagram showing DHCPv6 Other configuration signal flow between UE, SMF DHCP Relay Agent, and Intranet or ISP DHCP Server(s).](d9c0a780cd22626253dab4aa41699e2f_img.jpg) + +``` + +sequenceDiagram + participant UE + participant SMF as SMF DHCP Relay Agent + participant Intranet or ISP as Intranet or ISP DHCP Server(s) + Note left of UE: + SMF->>UE: 1. Router Advertisement ( O-flag=1 ) + Note right of UE: + UE->>SMF: 2. INFORMATION-REQUEST + SMF->>Intranet or ISP: RELAY-FORWARD( INFORMATION-REQUEST ) + Note right of Intranet or ISP: + Intranet or ISP-->>SMF: 3. REPLY (maybe several) + SMF-->>UE: RELAY-REPLY( REPLY ) + +``` + +Sequence diagram showing DHCPv6 Other configuration signal flow between UE, SMF DHCP Relay Agent, and Intranet or ISP DHCP Server(s). + +Figure 10.2.4-1: DHCPv6 Other configuration signal flow + +### 10.2.5 IPv6 Prefix Delegation via DHCPv6 + +#### 10.2.5.1 General requirement + +SMF or SMF+PGW-C may (depending on the configuration for the DNN/S-NSSAI) assign a single network prefix shorter than the default /64 prefix to a PDU Session from the internal IPv6 Prefix pool or via DHCPv6. In this case, the /64 default prefix used for IPv6 stateless autoconfiguration shall be allocated from this network prefix, except for RG may have different shorter IPv6 prefix(es) delegated via DHCPv6 not including the allocated /64 default prefix; the remaining address space from the network prefix may be delegated to the PDU Session using prefix delegation after the PDU Session establishment and IPv6 prefix allocation via IPv6 stateless address autoconfiguration as defined in clause 10.2.3. + +Depending on configuration, the SMF may obtain the prefix from a locally provisioned pool, from the PSA UPF or from the external DN. + +If the UE had indicated that it supports prefix exclusion and the prefix to be delegated to the UE includes the /64 prefix that was allocated to the PDU Session, the SMF or SMF+PGW shall utilize the prefix exclusion feature as specified for DHCPv6 Prefix Delegation in RFC 6603 [62]. + +The UE uses DHCPv6 to request additional IPv6 prefix (i.e.: prefix in addition to the default prefix) from the SMF or SMF+PGW-C after completing stateless IPv6 address autoconfiguration procedures. The UE acts as a "Requesting Router" as described in RFC 8415 [49] and inserts one or more IA\_PD option(s) into a DHCPv6 Solicit message sent from the UE to the SMF or SMF+PGW-C via the user plane and the UPF or UPF+PGW-U. The SMF or SMF+PGW-C acts as the DHCP server and fulfils the role of a "Delegating Router" according to RFC 8415 [49]. The UE optionally includes the RAPID\_COMMIT option in the DHCPv6 Solicit message to trigger two-message DHCPv6 procedure instead of the four-message DHCPv6 procedure. The UE shall include OPTION\_PD\_EXCLUDE option code in an OPTION\_ORO option to indicate support for prefix exclusion. In response to the DHCPv6 Solicit message, the UE receives a DHCPv6 Reply message with one or more IA\_PD prefix(es) for every IA\_PD option that it sent in the DHCPv6 Solicit message. The SMF or SMF+PGW-C delegates a prefix excluding the default prefix with help of OPTION\_PD\_EXCLUDE, except for RG as UE when different shorter IPv6 prefix(es) is delegated via DHCPv6. Prefix exclusion procedures shall follow RFC 6603 [62]. + +The additional requirement for RG connecting to 5GC with IPv6 Prefix Delegation via DHCPv6 is defined in clause 10.2.5.2. + +#### 10.2.5.2 Additional requirement to support RG + +Besides the general support to IPv6 prefix delegation as described in clause 10.2.5.1, a RG may request IPv6 prefix allocation for UE behind the RG as specified in 3GPP TS 23.316 [43]. A SMF or SMF+PGW-C may receive both DHCP options for IA\_NA and IA\_PD together in a single DHCPv6 message, the SMF or SMF+PGW-C may provide a + +reply to both IA\_NA and IA\_PD in the same message or alternatively process the DHCPv6 IA\_NA before the DHCPv6 IA\_PD. + +For the detailed description of the RG uses DHCPv6 to request additional IPv6 prefix(es) refer to clause 4.6.2.3 of 3GPP TS 23.316 [43]. The prefix exclude option is optionally used to exclude the default /64 prefix allocated to the PDU Session within the same shorter prefix of the DHCPv6 delegated prefix, and it is possible for SMF or SMF+PGW-C to assign a /64 prefix using stateless address autoconfiguration and one or more completely different shorter prefix(es) using DHCPv6 Prefix Delegation without use of prefix exclude option. + +## 10.3 3GPP Vendor-Specific Options + +This clause describes 3GPP Vendor-Specific Options that will be included in DHCP messages exchanged between SMF or SMF+PGW-C and DHCP Server. Other DHCP options may be used as defined in DHCP RFC(s). Unless otherwise stated, when the encoding scheme of an attribute is specified as UTF-8 encoding, this shall be interpreted as UTF-8 hexadecimal encoding. + +The DHCPv4 vendor specific option is encoded as per IETF RFC 2132 [47] or IETF RFC 3925 [48]. The DHCPv6 vendor specific option is encoded as per IETF RFC 8415 [49]. For DHCP vendor specific option code 17 or 125, the Enterprise Number shall be set to value 10415. + +The table 10.3-1 lists the encapsulated 3GPP Vendor-Specific Options in DHCP vendor specific option (17/43/125). + +**Table 10.3-1: List of the encapsulated 3GPP Vendor-Specific sub-options** + +| Sub-opt # | Sub-option Name | Presence | +|-----------|-------------------|----------| +| 1 | 3GPP-IP-Pool-Info | Optional | + +### 1 – 3GPP-IP-Pool-Info + +| DHCPv4 | | Bits | | | | | | | | +|--------|--|--------------------|---|---|---|---|---|---|---| +| Octets | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | | VS option code = 1 | | | | | | | | +| 2 | | VS option length | | | | | | | | +| 3-m | | IP address pool ID | | | | | | | | + +| DHCPv6 | | Bits | | | | | | | | +|--------|--|--------------------|---|---|---|---|---|---|---| +| Octets | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-2 | | VS option code = 1 | | | | | | | | +| 3-4 | | VS option length | | | | | | | | +| 5-m | | IP address pool ID | | | | | | | | + +VS option code: 1 + +Length: m-2 or m-4 + +The IP address pool ID is of Octet String type. + +The SMF or SMF+PGW-C may determine an IP address pool ID based on UPF ID, S-NSSAI, DNN, and IP version as described in clause 5.8.2.2.1 in 3GPP TS 23.501 [2] and includes the IP address pool ID within 3GPP Vendor-Specific-Option and send it to the DHCP server. The DHCP server assigns IPv6 prefix or IPv4 address from the requested IP address pool. Multiple 3GPP-IP-Pool-Info sub-options may be sent in a DHCP request message. The DHCP server shall return the selected IP address pool ID within 3GPP Vendor-Specific-Option to the SMF or SMF+PGW-C in the DHCP successful response message (e.g. DHCPACK). + +# 11 Interworking with DN-AAA (RADIUS) + +## 11.1 RADIUS procedures + +### 11.1.1 RADIUS Authentication and Authorization in 5GC + +The SMF also represents the H-SMF in the home routed scenario in this clause unless specified otherwise. + +RADIUS Authentication and Authorization shall be used according to IETF RFC 2865 [8], IETF RFC 3162 [9] and IETF RFC 4818 [10]. In 5G, multiple authentication methods using Extensible Authentication Protocol (EAP) may be used such as EAP-TLS (see IETF RFC 5216 [11]), EAP-TTLS (see IETF RFC 5281 [37]). The SMF shall implement the RADIUS extension to support EAP as specified in IETF RFC 3579 [7]. + +The RADIUS client function may reside in an SMF. When the SMF receives an initial access request (i.e. the SMF receives the Nsmf\_PDUSession\_CreateSMContext request with type "Initial request" for non-roaming case or local breakout case, or the H-SMF receives the Nsmf\_PDUSession\_Create Request with type "Initial request" for home routed case), the RADIUS client function may send the authentication information to a DN-AAA server, which is identified during the DNN provisioning. + +When the legacy applications require PAP/CHAP authentication with the UE accessing to the 5GS and the legacy DN-AAA server does not support EAP, PAP/CHAP may be used as the authentication protocol, with the external network performing the risk assessment. + +The DN-AAA server performs authentication and authorization. The response (when positive) may contain network information, such as an IPv4 address and/or IPv6 prefix for the user when the SMF is interworking with the DN-AAA server. + +The information delivered during the RADIUS authentication can be used to automatically correlate the user identity (e.g. SUPI) to the IPv4 address and/or IPv6 prefix, if applicable, assigned/confirmed by the SMF or the DN-AAA server respectively. The same procedure applies, in case of sending the authentication to a 'proxy' DN-AAA server. + +For 5G, RADIUS Authentication is applicable to the initial access request. When the SMF receives an Access-Accept message from the DN-AAA server it shall complete the initial access procedure. If Access-Reject or no response is received, the SMF shall reject the initial access procedure with a suitable cause code. + +When DN-AAA server authorizes the PDU Session Establishment, it may send DN authorization data for the established PDU Session to the SMF. The DN authorization data for the established PDU Session may include one or more of the following: + +- a reference to authorization data for policy and charging control locally configured in the SMF or PCF; +- a list of allowed MAC addresses (maximum 16) for the Ethernet PDU Session; +- a list of allowed VLAN Ids (maximum 16) for the Ethernet PDU Session; +- Session-AMBR for the PDU Session; +- L2TP information, such as LNS IP address and/or LNS host name; and +- Framed Route information for the PDU Session. + +NOTE: If the DN-AAA server send L2TP information to SMF, the L2TP information can e.g. be provisioned per DNN/S-NSSAI or per SUPI or GPSI by configuration which is out of the scope of 3GPP specifications. + +SMF policies may require DN authorization without DN authentication. In that case, when contacting the DN-AAA server for authorization, the SMF shall provide the GPSI of the UE if available. + +The SMF may also use the RADIUS re-authorization procedure for the purpose of IPv4 address and/or IPv6 prefix allocation to the UE. The use cases that may lead this procedure are: + +- IPv4 address and/or IPv6 prefix allocation after UPF selection during PDU session establishment procedure. +- IPv6 prefix allocation during adding additional PDU Session Anchor procedure for IPv6 multi-homing. + +- IPv4 address allocation via DHCPv4 procedure after successful PDU session establishment procedure. + +The SMF may also trigger request for DN authentication/authorization and/or IP address/prefix allocation based on UE subscription data retrieve from the UDM as defined in clause 5.2.2.2.5 of 3GPP TS 29.503. + +When an IPv4 address and/or IPv6 prefix (including any additional IPv6 prefix of IPv6 multi-homing) is (re-)allocated or de-allocated (not causing the PDU session to be released) by using a method not via the DN-AAA server and if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the authentication session that was established before to inform the DN-AAA server by sending RADIUS Access-Request with the latest list of IPv4 address and/or IPv6 prefix(es). + +When the SMF is notified by the UPF regarding the UE MAC address change (a new one is detected or a used one is inactive), if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the authentication session that was established before to inform the DN-AAA server by sending RADIUS Access-Request with the latest list of UE MAC addresses in use. + +DN-AAA may initiate QoS flow termination, re-authorization and re-authentication, see details in clause 11.2.3, clause 11.2.4 and clause 11.2.5. + +#### 11.1.1a RADIUS Authentication and Authorization in EPC Interworking + +RADIUS Authentication and Authorization shall be used according to IETF RFC 2865 [8], IETF RFC 3162 [9] and IETF RFC 4818 [10]. The SMF+PGW-C shall implement the RADIUS extension to support EAP as specified in IETF RFC 3579 [7]. + +When the SMF+PGW-C receives a new Create Session Request and the Session Management Subscription Data from the UDM or local configuration indicate the need for EAP-based secondary authentication and authorization by DN-AAA, the RADIUS client function may send the authentication information to a DN-AAA server, which is identified during the DNN provisioning. + +When the legacy applications require PAP/CHAP authentication with the UE accessing the 5GC and EPC interworking scenario and the legacy DN-AAA server does not support EAP, PAP/CHAP may be used as the authentication protocol, with the external network performing the risk assessment. + +The DN-AAA server performs authentication and authorization. The response (when positive) may contain network information, such as an IPv4 address and/or IPv6 prefix for the user when the SMF+PGW-C is interworking with the DN-AAA server. + +The information delivered during the RADIUS authentication can be used to automatically correlate the user identity (e.g. SUPI) to the IPv4 address and/or IPv6 prefix, if applicable, assigned/confirmed by the SMF+PGW-C or the DN-AAA server respectively. The same procedure applies, in case of sending the authentication to a 'proxy' DN-AAA server. + +When the SMF+PGW-C receives an Access-Accept message from the DN-AAA server it shall complete the initial access procedure. If Access-Reject or no response is received, the SMF+PGW-C shall reject the PDN Connection procedure with a suitable cause code. + +When DN-AAA server authorizes the PDN Connection Establishment, it may send DN authorization data for the established PDN Connection to the SMF+PGW-C. The DN authorization data for the established PDN Connection may include one or more of the following: + +- a reference to authorization data for policy and charging control locally configured in the SMF+PGW-C or PCF; +- a list of allowed MAC addresses (maximum 16) for the Ethernet PDN Connection; +- a list of allowed VLAN Ids (maximum 16) for the Ethernet PDN Connection; +- Session-AMBR for the PDN Connection; +- L2TP information, such as LNS IP address and/or LNS host name; and +- Framed Route information for the PDN Connection. + +NOTE: If the DN-AAA server send L2TP information to SMF+PGW-C, the L2TP information can e.g. be provisioned per DNN/S-NSSAI or per SUPI or GPSI by configuration which is out of the scope of 3GPP specifications. + +SMF+PGW-C policies may require DN authorization without DN authentication. In that case, when contacting the DN-AAA server for authorization, the SMF+PGW-C shall provide the GPSI of the UE if available. + +The SMF may also use the RADIUS re-authorization procedure for the purpose of IPv4 address and/or IPv6 prefix allocation to the UE. The use cases that may lead this procedure are: + +- IPv4 address and/or IPv6 prefix allocation after UPF+PGW-U selection during PDN connection establishment procedure. +- IPv6 prefix allocation during adding additional PDN Connection Anchor procedure for IPv6 multi-homing. +- IPv4 address allocation via DHCPv4 procedure after successful PDN connection establishment procedure. + +The SMF+PGW-C may also trigger request for DN authentication/authorization and/or IP address/prefix allocation based on UE subscription data retrieve from the UDM as defined in clause 5.2.2.2.5 of 3GPP TS 29.503. + +When an IPv4 address and/or IPv6 prefix (including any additional IPv6 prefix of IPv6 multi-homing) is (re-)allocated or de-allocated (not causing the PDN connection to be released) by using a method not via the DN-AAA server and if the SMF+PGW-C was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF+PGW-C shall, if applicable, use the authentication session that was established before to inform the DN-AAA server by sending RADIUS Access-Request with the latest list of IPv4 address and/or IPv6 prefix(es). + +When the SMF+PGW-C is notified by the UPF+PGW-U regarding the UE MAC address change (a new one is detected or a used one is inactive), if the SMF+PGW-C was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF+PGW-C shall, if applicable, use the authentication session that was established before to inform the DN-AAA server by sending RADIUS Access-Request with the latest list of UE MAC addresses in use. + +DN-AAA may initiate QoS flow termination, re-authorization and re-authentication, see details in clause 11.2.3, clause 11.2.4 and clause 11.2.5. In case EAP based authentication and authorization has been performed for the PDU Session while the UE was in 5GS, and if SMF+PGW-C determines that the UE has moved to the EPS (i.e. the SMF+PGW-C receives the modify bearer request or create session request from the S-GW), the following applies: + +- the SMF+PGW-C may initiate RADIUS re-authorization procedure without re-authentication with the DN-AAA server based on local policy. +- DN-AAA initiated re-authorization without re-authentication may be performed. + +### 11.1.2 RADIUS Accounting + +RADIUS Accounting shall be used according to IETF RFC 2866 [26], IETF RFC 3162 [9] and IETF RFC 4818 [10]. + +The RADIUS accounting client function may reside in an SMF. The RADIUS accounting client may send information to a DN-AAA server, which is identified during the DNN provisioning. The DN-AAA server may store this information and use it to automatically identify the user. This information can be trusted because the 3GPP network has authenticated the subscriber (i.e. USIM card and possibly other authentication methods). + +The SMF may use the RADIUS Accounting-Request Start and Stop messages during QoS flow (e.g. QoS flow associated with the default QoS rule) establishment and termination procedures, respectively. + +The use of Accounting-Request STOP and in addition the Accounting ON and Accounting OFF messages may be used to ensure that information stored in the DN-AAA server is synchronised with the SMF information. + +If the DN-AAA server is used for IPv4 address and/or IPv6 prefix assignment, then, upon reception of a RADIUS Accounting-Request STOP message for all QoS flows associated to a PDU session defined by DNN and SUPI or GPSI, the DN-AAA server may make the associated IPv4 address and/or IPv6 prefix available for assignment. + +When an IPv4 address and/or IPv6 prefix (including any additional IPv6 prefix of IPv6 multi-homing) is (re-)allocated or de-allocated (not causing the PDU session to be released) by using a method not via the DN-AAA server and if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local + +configuration, the SMF shall, if applicable, use the accounting session that was established before to inform the DN-AAA server by sending RADIUS Accounting-Request Interim-Update with the latest list of IPv4 address and/or IPv6 prefix(es). + +When the SMF is notified by the UPF regarding the UE MAC address change (a new one is detected or a used one is inactive), if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the accounting session that was established before to inform the DN-AAA server by sending RADIUS Accounting-Request Interim-Update with the latest list of UE MAC addresses in use. + +In order to avoid race conditions, the SMF shall include a 3GPP Vendor-Specific sub-attribute "Session Stop indicator" when it sends the Accounting-Request STOP for the last QoS flow of a PDU session and the PDU session is terminated (i.e. the IPv4 address and/or IPv6 prefix and any associated GTP tunnel can be released). The DN-AAA server shall not assume the PDU session terminated until an Accounting-Request STOP with the Session Stop indicator is received. + +## 11.2 Message flows on N6 interface + +### 11.2.1 Authentication, Authorization and Accounting procedures in 5GC + +The SMF also represents the H-SMF in the home routed scenario in this clause unless specified otherwise. + +When an SMF receives an initial access request (i.e. the SMF receives the Nsmf\_PDUSession\_CreateSMContext request with type "Initial request" for non-roaming case or local breakout case, or the H-SMF receives the Nsmf\_PDUSession\_Create Request with type "Initial request" for home routed case) message for a given DNN, the SMF may (depending on the configuration for this DNN) send a RADIUS Access-Request message with EAP extension to a DN-AAA server. The SMF may also (depending on the configuration for this DNN) send the S-NSSAI and the PDU Session ID that are associated with the PDU Session, respectively in the 3GPP-Session-S-NSSAI VSA and the 3GPP-Session-Id VSA, to a DN-AAA server. Upon receipt of the Access-Request message, the DN-AAA server shall respond with an Access-Challenge message. Multi-round authentication using the Access-Challenge (sent by DN-AAA) and Access-Request messages may be used. The DN-AAA server finally authenticates and authorizes the user by replying with an Access Accept message. If the DN-AAA server is also responsible for IPv4 address and/or IPv6 prefix allocation, the DN-AAA server shall return the allocated IPv4 address and/or IPv6 prefix in the Access-Accept message. + +For re-authentication and re-authorization, the SMF shall send a RADIUS Access-Request message with EAP extension and the DN-AAA shall respond with an Access-Challenge message. Multi-round authentication using the Access-Challenge (sent by DN-AAA) and Access-Request messages may be used. The DN-AAA server finally authenticates and authorizes the user by replying with an Access Accept message. + +The SMF may initiate RADIUS re-authorization procedures for the purpose of IPv4 address and/or IPv6 prefix allocation (or renew the lease). In this case, the SMF shall set the Service-Type attribute to "Authorize Only" and the 3GPP-Allocate-IP-Type subattribute to the type of IP address to be allocated in the Access-Request message sent to the DN-AAA server. If the SMF is using DHCP signalling towards the UE and the DN-AAA server includes the Session-Timeout attribute in the Access-Accept, the SMF may use the Session-Timeout value as the DHCP lease time. The SMF shall not set the DHCP lease time value higher than the Session-Timeout value. The SMF may renew the DHCP lease to the UE without re-authorization towards the DN-AAA server providing that the new lease expiry is no later than the Session-Timeout timer expiry. If the SMF wishes to extend the lease time beyond the current Session-Timeout expiry, it shall initiate a new AAA re-authorization. + +Even if the SMF was not involved in user authentication, it may send a RADIUS Accounting-Request (START) message to a DN-AAA server. This message may contain parameters, e.g. the tuple which includes the user ID and IPv4 address and/or IPv6 prefix, to be used by application servers (e.g. WAP gateway) in order to identify the user, the 3GPP-Charging-Id VSA or 3GPP-Charging-Id-v2 VSA according to the length of the Charging Id for the user session. This message may also (depending on the configuration for the DNN) contains the S-NSSAI and the PDU Session ID that are associated with the PDU Session, respectively in the 3GPP-Session-S-NSSAI VSA and the 3GPP-Session-Id VSA, and/or AF traffic influence PCC rule provisioned and then SMF used DNAI in the 3GPP-DNAI VSA, to a DN-AAA server. This message also indicates to the AAA server that the user session has started. The user session is uniquely identified by the Acct-Session-Id that is composed of the Charging ID and the SMF IP address. + +NOTE: If the accounting session is required by the DN-AAA server to be created per QoS flow, how to identify the different accounting sessions is implementation specific. The SMF can include the Acct-Session-Id which is extended to include the QFI of the QoS flow or the Acct-Session-Id without QFI extension and with 3GPP-NSAPI combination in the RADIUS Accounting-Request (START). + +If some external applications require RADIUS Accounting-Request (START) information before they can process user packets, then the selected DNN (SMF) may be configured in such a way that the UPF is instructed to drop user data until the Accounting-Response (START) is received from the AAA server. The SMF may wait for the Accounting-Response (START) before sending the final authentication response message in Namf\_Communication\_N1N2MessageTransfer service operation. The SMF may reject the initial access request if the Accounting-Response (START) is not received. The authentication and accounting servers may be separately configured for each DNN. + +For IPv4 PDU type, if IPv4 address is allocated via DHCPv4 signalling between the UE and the DN-AAA after PDU session establishment, the SMF may wait to send the Accounting-Request (START) message until the UE receives its IPv4 address in a DHCPACK. + +When the SMF receives a message indicating a QoS flow or PDU session release request and providing a RADIUS Accounting-Request (START) message was sent previously, the SMF shall send a RADIUS Accounting-Request (STOP) message to the DN-AAA server, which indicates the termination of this particular QoS flow or PDU session. The SMF shall immediately send the corresponding response (e.g. Nsmf\_PDUSession\_UpdateSMContext response) to the AMF, without waiting for an Accounting-Response (STOP) message from the DN-AAA server. + +The DN-AAA server shall deallocate the IPv4 address and/or IPv6 prefix initially allocated to the subscriber, if there is no session for the subscriber. + +Accounting-Request (ON) and Accounting-Request (OFF) messages may be sent from the SMF to the DN-AAA server to ensure the correct synchronization of the session information in the SMF and the DN-AAA server. + +The SMF may send an Accounting-Request (ON) message to the DN-AAA server to indicate that a restart has occurred. The DN-AAA server may then release the associated resources. + +Prior to a scheduled restart, the SMF may send Accounting-Request (OFF) message to the DN-AAA server. The DN-AAA server may then release the associated resources. + +The following figure 11.2.1-1 is an example message flow to show the procedure of RADIUS Authentication and Accounting between an SMF and a DN-AAA server: + +1. UE initiates the PDU Session Establishment procedure, including authentication/authorization information. +2. The AMF sends Nsmf\_PDUSession\_CreateSMContext Request including the authentication/authorization information to the SMF and the SMF responds to the service operation. + +According to the configuration in the SMF, step 6 to step 9 are executed before step 3 if the SMF needs to send an EAP-Request message to the UE. + +In the case of home routed, the AMF sends Nsmf\_PDUSession\_CreateSMContext Request including the authentication/authorization information to the V-SMF and the V-SMF sends Nsmf\_PDUSession\_Create Request including the authentication/authorization information to the H-SMF. + +3. If the N4 session has not been established before, the SMF triggers the N4 Session Establishment procedure to the UPF. + +In the case of home routed, the V-SMF triggers the N4 Session Establishment procedure to the V-UPF and the H-SMF triggers the N4 Session Establishment procedure to the H-UPF. + +4. The SMF sends the Access-Request message to the DN-AAA via the UPF, the message is forwarded from the SMF to the DN-AAA by the UPF in N4 user plane message. + +In the case of home routed, the H-SMF sends the Access-Request message to the DN-AAA via the H-UPF, the message is forwarded from the H-SMF to the DN-AAA by the H-UPF in N4 user plane message. + +- 5-10. The DN-AAA responds with the Access-Challenge message to the SMF via the UPF, the message is forwarded from the DN-AAA to the SMF by the UPF in N4 user plane message. The authentication/authorization information is further transferred to UE via + +Namf\_Communication\_N1N2MessageTransfer service and NAS SM Transport message. UE responds to the received authentication/authorization data and such information is transferred in NAS SM Transport message and Nsmf\_PDUSession\_UpdateSMContext service, then finally sent to the DN-AAA by the SMF, via the UPF, in the Access-Request message. + +In the case of home routed, the DN-AAA responds with the Access-Challenge message to the H-SMF via the H-UPF, the message is forwarded from the DN-AAA to the H-SMF by the H-UPF in N4 user plane message. The authentication/authorization information is transferred to V-SMF via Nsmf\_PDUSession\_Update service and is further transferred to UE via Namf\_Communication\_N1N2MessageTransfer service and NAS SM Transport message. UE responds to the received authentication/authorization data and such information is transferred in NAS SM Transport message, Nsmf\_PDUSession\_UpdateSMContext service and Nsmf\_PDUSession\_Update service, then finally sent to the DN-AAA by the H-SMF, via the H-UPF, in the Access-Request message. + +NOTE: Step 5 to step 10 can be repeated depending on the authentication/authorization mechanism used (e.g. EAP-TLS). + +11. The SMF receives the final result of authentication/authorization from the DN-AAA in the Access-Accept message, via the UPF. +12. The SMF requests to start accounting by sending the Accounting-Request (START) message to the DN-AAA via the UPF. +13. The SMF proceeds with the PDU session establishment procedure and includes the authentication/authorization information in Namf\_Communication\_N1N2MessageTransfer service. + +In the case of home routed, the H-SMF proceeds with the PDU session establishment procedure and includes the authentication/authorization information is transferred to V-SMF via Nsmf\_PDUSession\_Update service and is further transferred to the AMF via Namf\_Communication\_N1N2MessageTransfer service. + +14. The DN-AAA responds with the Accounting-Response (START) message. The SMF may wait for the Accounting-Response (START) before sending the Namf\_Communication\_N1N2MessageTransfer request in step 13. + +In the case of home routed, the H-SMF may wait for the Accounting-Response (START) before sending the Nsmf\_PDUSession\_Update service in step 13. + +15. The AMF sends the NAS PDU Session Establishment Request with the authentication/authorization information to the UE. +16. The UE sends a NAS message Deregistration Request to the AMF. +17. The AMF sends Nsmf\_PDUSession\_ReleaseSMContext Request to the SMF and the SMF responds to the service operation. + +In the case of home routed, the AMF sends Nsmf\_PDUSession\_ReleaseSMContext Request to the V-SMF and the V-SMF sends the Nsmf\_PDUSession\_Release Request to the H-SMF. + +- 18-19. The SMF requests to stop accounting by sending the Accounting-Request (STOP) message to the DN-AAA via the UPF and the DN-AAA responds with the Accounting-Response (STOP) message. + +![Sequence diagram illustrating RADIUS Authentication and Accounting example (successful case) between UE, AMF, SMF, UPF, and DN-AAA.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant UE + participant AMF + participant SMF + participant UPF + participant DN-AAA + + Note left of UE: 1.NAS PDU Session Establishment Request (Authentication message) + UE->>AMF: 1.NAS PDU Session Establishment Request (Authentication message) + AMF->>SMF: 2.Nsmf_PDUSession_Create SMContext (Authentication message) + SMF-->>UPF: 3.N4 Session Establishment + SMF->>DN-AAA: 4.Access-Request + DN-AAA-->>SMF: 5.Access-Challenge + SMF->>AMF: 6.Namf_Communication_N1N2MessageTransfer (Authentication message) + AMF->>UE: 7.NAS SM Transport (Authentication message) + UE->>AMF: 8.NAS SM Transport (Authentication message) + AMF->>SMF: 9.Nsmf_PDUSession_Update SMContext (Authentication message) + SMF->>DN-AAA: 10.Access-Request + DN-AAA-->>SMF: 11.Access-Accept + SMF->>AMF: 13.Namf_Communication_N1N2MessageTransfer (Authentication message) + AMF->>UE: 15.NAS PDU Session Establishment Accept (Authentication message) + Note right of UE: User data + UE->>AMF: 16.NAS Deregistration Request + AMF->>SMF: 17.Nsmf_PDUSession_Release SMContext + SMF->>DN-AAA: 18.Accounting-Request (STOP) + DN-AAA-->>SMF: 19.Accounting-Response (STOP) + +``` + +Sequence diagram illustrating RADIUS Authentication and Accounting example (successful case) between UE, AMF, SMF, UPF, and DN-AAA. + +**Figure 11.2.1-1: RADIUS Authentication and Accounting example (successful case)** + +When PAP/CHAP is used as the authentication protocol with the external DN-AAA server which does not support EAP for the 5GS or for the 5GC, the RADIUS Authentication procedures refer to the non transparent access procedures in clause 11.2.1 and the related RADIUS Authentication description in clause 16.3a.1 in 3GPP TS 29.061 [5] are reused with the following differences: + +- the SMF performs the actions specified for the P-GW; +- the external DN-AAA server performs the actions specified for AAA; +- PDU Session Establishment request is sent from the UE to the SMF instead of the Activate PDN connection request being sent from the UE to the S-GW and the Create Session request being sent from S-GW to P-GW; +- PDU Session Establishment accept is sent from the SMF to the UE instead of the Create Session Response message being sent from the P-GW to S-GW and the Activate PDN Connection Accept being sent from S-GW to the UE; and +- PDU Session Establishment reject is sent from the SMF to the UE instead of the Create Session Response message being sent from the P-GW to the S-GW and the Activate PDN Connection Reject being sent from S-GW to the UE. + +### 11.2.1a Authentication and Authorization procedures in EPC Interworking + +When an SMF+PGW-C receives a Create Session Request message for a given DNN from the MME, the SMF+PGW-C may (depending on the configuration for this DNN) send a RADIUS Access-Request message with EAP extension to a DN-AAA server. Upon receipt of the Access-Request message, the DN-AAA server shall respond with an Access-Challenge message. Multi-round authentication using the Access-Challenge (sent by DN-AAA) and Access-Request messages may be used. The DN-AAA server finally authenticates and authorizes the user by replying with an Access Accept message. If the DN-AAA server is also responsible for IPv4 address and/or IPv6 prefix allocation, the DN-AAA server shall return the allocated IPv4 address and/or IPv6 prefix in the Access-Accept message. + +For re-authentication and re-authorization, the SMF+PGW-C shall send a RADIUS Access-Request message with EAP extension and the DN-AAA shall respond with an Access-Challenge message. Multi-round authentication using the Access-Challenge (sent by DN-AAA) and Access-Request messages may be used. The DN-AAA server finally authenticates and authorizes the user by replying with an Access Accept message. + +The SMF+PGW-C may initiate RADIUS re-authorization procedures for the purpose of IPv4 address and/or IPv6 prefix allocation (or renew the lease). In this case, the SMF+PGW-C shall set the Service-Type attribute to "Authorize Only" and the 3GPP-Allocate-IP-Type attribute to the type of IP address to be allocated in the Access-Request message sent to the DN-AAA server. If the SMF+PGW-C is using DHCP signalling towards the UE and the DN-AAA server includes the Session-Timeout attribute in the Access-Accept, the SMF+PGW-C may use the Session-Timeout value as the DHCP lease time. The SMF+PGW-C shall not set the DHCP lease time value higher than the Session-Timeout value. The SMF+PGW-C may renew the DHCP lease to the UE without re-authorization towards the DN-AAA server providing that the new lease expiry is no later than the Session-Timeout timer expiry. If the SMF+PGW-C wishes to extend the lease time beyond the current Session-Timeout expiry, it shall initiate a new AAA re-authorization. + +When the SMF+PGW-C receives a message indicating a QoS flow or PDN connection release request, the SMF+PGW-C shall send a RADIUS Accounting-Request (STOP) message to the DN-AAA server, which indicates the termination of this particular QoS flow or PDN connection. The SMF+PGW-C shall immediately send the corresponding response to the MME, without waiting for an Accounting-Response (STOP) message from the DN-AAA server. + +The DN-AAA server shall deallocate the IPv4 address and/or IPv6 prefix initially allocated to the subscriber, if there is no session for the subscriber. + +Accounting-Request (ON) and Accounting-Request (OFF) messages may be sent from the SMF+PGW-C to the DN-AAA server to ensure the correct synchronization of the session information in the SMF+PGW-C and the DN-AAA server. + +The SMF+PGW-C may send an Accounting-Request (ON) message to the DN-AAA server to indicate that a restart has occurred. The DN-AAA server may then release the associated resources. + +Prior to a scheduled restart, the SMF+PGW-C may send Accounting-Request (OFF) message to the DN-AAA server. The DN-AAA server may then release the associated resources. + +![Sequence diagram showing RADIUS Authentication and Accounting example (successful case) between UE, MME, SMF+PGW-C, UPF+PGW-U, and DN-AAA.](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +``` + +sequenceDiagram + participant UE + participant MME + participant SMF+PGW-C + participant UPF+PGW-U + participant DN-AAA + + Note left of UE: 1.PDN Connectivity Request (PCO: Authentication message) + UE->>MME: 1.PDN Connectivity Request (PCO: Authentication message) + MME->>SMF+PGW-C: 2.Create Session Request (PCO: Authentication message) + SMF+PGW-C->>UPF+PGW-U: 3.N4 Session Establishment (N4 rules: Block User traffic) + SMF+PGW-C->>DN-AAA: 4.Access-Request + DN-AAA->>SMF+PGW-C: 5.Access-Challenge + SMF+PGW-C->>MME: 6.Create Session Response (PCO: Uplink Data Not allowed, Authentication message) + MME->>UE: 7.Downlink NAS Transport (PCO: Uplink Data Not allowed, Authentication message) + UE->>MME: 8.Uplink NAS Transport (PCO: Authentication message) + MME->>SMF+PGW-C: 9.Modify Bearer Request (PCO: Authentication message) + SMF+PGW-C->>MME: 10.Modify Bearer Response + SMF+PGW-C->>DN-AAA: 11.Access-Request + DN-AAA->>SMF+PGW-C: 12.Access-Challenge + SMF+PGW-C->>MME: 13. Update Bearer Request (PCO: Authentication message) + MME->>UE: 14.Downlink NAS Transport (PCO: Authentication message) + UE->>MME: 15. Uplink NAS Transport (PCO: Authentication message) + MME->>SMF+PGW-C: 16. Update Bearer Response (PCO: Authentication message) + SMF+PGW-C->>DN-AAA: 17. Access-Request + DN-AAA->>SMF+PGW-C: 18. Access-Accept + SMF+PGW-C->>UPF+PGW-U: 19. N4 Session update (N4 rules: Allow User Traffic) + SMF+PGW-C->>DN-AAA: 20. Accounting-Request (START) + DN-AAA->>SMF+PGW-C: 22. Accounting-Response (START) + SMF+PGW-C->>MME: 21. Update Bearer Request (PCO: Uplink Data allowed) + MME->>UE: 23. Downlink NAS Transport (Session Management Request) + UE->>MME: 24. Uplink NAS Transport (Session Management Response) + MME->>SMF+PGW-C: 25. Update Bearer Response + Note right of SMF+PGW-C: User data + UE->>MME: 26.NAS Detach Request + MME->>SMF+PGW-C: 27.Delete Session Request + SMF+PGW-C->>DN-AAA: 28.Accounting-Request (STOP) + DN-AAA->>SMF+PGW-C: 30.Accounting-Response (STOP) + SMF+PGW-C->>MME: 29. Delete Session Response + +``` + +Sequence diagram showing RADIUS Authentication and Accounting example (successful case) between UE, MME, SMF+PGW-C, UPF+PGW-U, and DN-AAA. + +**Figure 11.2.1a-1: RADIUS Authentication and Accounting example (successful case)** + +The above figure 11.2.1a-1 is an example message flow to show the procedure of RADIUS Authentication and Accounting between an SMF+PGW-C and a DN-AAA server: + +1. UE initiates the PDN Connection Establishment procedure, including authentication/authorization information. +2. The MME sends Create Session Request including the authentication/authorization information to the SMF+PGW-C. + +According to the configuration in the SMF+PGW-C, step 6 to step 10 are executed before step 3 if the SMF+PGW-C needs to send an EAP-Request message to the UE. + +3. If the N4 session has not been established before, the SMF+PGW-C triggers the N4 Session Establishment procedure to the UPF+PGW-U and sets the N4 rules to block any UE traffic over the PDN Connection (until the Secondary DN authentication and authorization has been completed successfully). + +4. The SMF+PGW-C sends the Access-Request message to the DN-AAA via the UPF+PGW-U in the N4 user plane. + - 5-11. The DN-AAA responds with the Access-Challenge message to the SMF+PGW-C via the UPF+PGW-U in the N4 use plane message. The authentication/authorization information is further transferred to UE via Create Session Response and Downlink NAS Transport message, along with uplink data not allowed indication within the PCO attribute. UE responds to the received authentication/authorization data and such information is transferred in Uplink NAS Transport message and Modify Bearer Request, then finally sent to the DN-AAA by the SMF+PGW-C, via the UPF+PGW-U, in the Access-Request message. + - 12-17. The DN-AAA responds with the Access-Challenge message to the SMF+PGW-C via the UPF+PGW-U in the N4 use plane message. The authentication/authorization information is further transferred to UE via Update bearer Response and Downlink NAS Transport message. UE responds to the received authentication/authorization data and such information is transferred in Uplink NAS Transport message and Update Bearer Response, then finally sent to the DN-AAA by the SMF+PGW-C, via the UPF+PGW-U, in the Access-Request message. +- NOTE: Step 12 to step 17 can be repeated depending on the authentication/authorization mechanism used (e.g. EAP-TLS). +18. The SMF+PGW-C receives the final result of authentication/authorization from the DN-AAA in the Access-Accept message, via the UPF+PGW-U. + 19. The SMF+PGW-C updates the N4 rules to allow UE traffic over the PDN connection. + 20. The SMF+PGW-C requests to start accounting by sending the Accounting-Request (START) message to the DN-AAA via the UPF+PGW-U. + 21. The SMF+PGW-C proceeds with PDN connection establishment procedure and includes the authentication/authorization information in the Update Bearer Request message with uplink data allowed indication within the PCO attribute, sent to the MME. + 22. The DN-AAA responds with the Accounting-Response (START) message. The SMF+PGW-C may wait for the Accounting-Response (START) before sending the Update Bearer Request in step 21. + 23. The MME sends the Downlink NAS Transport message with Session Management Request with the authentication/authorization information to the UE. + 24. The UE sends a Uplink NAS Transport message with Session Management Response to the MME. + 25. The MME sends Update Bearer Response to the SMF+PGW-C, after which user data is allowed over the PDN connection. + - 26-30. At any point, if the UE triggers Detach procedure and send Detach request to the MME then MME sends Delete Session Request message to the SMF+PGW-C, which responds with Delete Session Response message. The SMF+PGW-C requests to stop accounting by sending the Accounting-Request (STOP) message to the DN-AAA via the UPF+PGW-U and the DN-AAA responds with the Accounting-Response (STOP) message. + +### 11.2.2 Accounting Update + +During the life of a QoS flow some information related to this QoS flow may change. The SMF may send RADIUS Accounting Request Interim-Update to the DN-AAA server upon occurrence of a chargeable event, e.g. RAT change, DNAI change or QoS change. Interim updates are also used when the IPv4 address and/or IPv6 prefix is allocated/released/re-allocated. + +NOTE: DNAI change is only applicable when application relocation possible indicated in the AF traffic influenced PCC rule as described in clause 5.6.7 of TS 23.501 [2], align with the DNAI change in UP path management events as described in clause 4.3.6.3 of TS 23.502 [3]. Only the target DNAI is provided in the ACR message. The change from the UP path status where a DNAI applies to a status where no DNAI applies indicating the de-activation of the AF request for AF influence on traffic routing is not supported in this release. + +When the SMF receives a signalling request (i.e. Nsmf\_PDUSession\_UpdateSMContext) that indicates the occurrence of one of these chargeable events, the SMF may send an Accounting Request Interim-Update to the DN-AAA server to + +update the necessary information related to this QoS flow. It is not necessary for the SMF to wait for the RADIUS AccountingResponse message from the DN-AAA server before sending the response for the triggering signalling message (i.e. Namf\_Communication\_N1N2MessageTransfer). The SMF may delete the QoS flow if the AccountingResponse is not received from the DN-AAA server. + +The SMF may also send interim updates at the expiry of an operator configured time limit. + +Figure 11.2.2-1 is an example message flow to show the procedure of RADIUS accounting update, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram showing RADIUS accounting update message flow between AMF, SMF, UPF, and DN-AAA.](a5b9392ecb96e6b5e0b4ee0664210f72_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + Note left of AMF: Nsmf_PDUSession_Update SMContext + AMF->>SMF: Nsmf_PDUSession_Update SMContext + SMF->>AMF: Nsmf_PDUSession_Update SMContext + Note left of SMF: Namf_Communication_N1 N2MessageTransfer + SMF->>AMF: Namf_Communication_N1 N2MessageTransfer + AMF->>SMF: Namf_Communication_N1 N2MessageTransfer + SMF->>DN-AAA: Accounting-Request (Interim-Update) + DN-AAA->>SMF: Accounting-Response (Interim-Update) + +``` + +The diagram illustrates the message flow for a RADIUS accounting update. It involves four entities: AMF, SMF, UPF, and DN-AAA. The sequence starts with the AMF sending an 'Nsmf\_PDUSession\_Update SMContext' message to the SMF, which is then responded to by the SMF. Next, the SMF sends a 'Namf\_Communication\_N1 N2MessageTransfer' message to the AMF, which is responded to by the AMF. The SMF then sends an 'Accounting-Request (Interim-Update)' message to the DN-AAA via the UPF. The DN-AAA responds with an 'Accounting-Response (Interim-Update)' message back to the SMF via the UPF. + +Sequence diagram showing RADIUS accounting update message flow between AMF, SMF, UPF, and DN-AAA. + +Figure 11.2.2-1: RADIUS accounting update + +For the 5GC and EPC interworking scenario without authentication, authorization, re-authentication and/or re-authorization impacts, if the UE establishes the PDU session through the 5GC and initiates the accounting session, when the SMF+PGW-C determines that the UE has moved to the EPS (i.e. the SMF+PGW-C receives the modify bearer request or create session request from the S-GW), the SMF+PGW-C may perform the accounting session update with the following modifications: + +- for the case that the accounting session is initiated per PDU session, the SMF+PGW-C may update the accounting session by including the identifier of the accounting session within the Acct-Session-Id, the "EUTRA" within the 3GPP-RAT-Type, the IPv4 address of S-GW within the 3GPP-SGSN-Address, the default EPS bearer id within the 3GPP-NSAPI, the user location in the EPC within the 3GPP-User-Location-Info if available and the new QoS profile within the 3GPP-GPRS-Negotiated-QoS-Profile if changed. +- for the case that the accounting session is initiated per QoS flow: + - if the SMF+PGW-C mapped a QoS flow to an EPS bearer, the SMF may update the accounting session corresponding to the QoS flow with the information of the EPS bearer by including the identifier of the accounting session within the Acct-Session-Id, the "EUTRA" within the 3GPP-RAT-Type, the IPv4 address of S-GW within the 3GPP-SGSN-Address, the EPS bearer id within the 3GPP-NSAPI, the user location in the EPC within the 3GPP-User-Location-Info if available, the new QoS profile within the 3GPP-GPRS-Negotiated-QoS-Profile if changed, the new charging id within the 3GPP-Charging-Id VSA or 3GPP-Charging-Id-v2 VSA according to the length of the Charging Id if allocated and the new packet filters within the 3GPP-Packet-Filter if changed; + - if the SMF+PGW-C mapped multiple QoS flows to one EPS bearer, the SMF shall select one of the accounting sessions corresponding to these QoS flows to update it as above and terminate the accounting session(s) corresponding to the other QoS flow(s). + - if the SMF+PGW-C did not map a QoS flow to any EPS bearer, the SMF may decide to associate the corresponding account session to the default EPS bearer or terminate the corresponding accounting session. + +### 11.2.3 DN-AAA initiated QoS flow termination + +RADIUS is used as the protocol between the SMF and the DN-AAA server or proxy for applications (e.g. MMS) to deliver information related to user session. However some IP applications could need to interwork with the SMF to release the corresponding resource (e.g. terminate a particular QoS flow). For this purpose, the DN-AAA server or proxy may send a RADIUS Disconnect-Request to the SMF. On receipt of the Disconnect-Request from the DN-AAA + +server, the SMF shall release the corresponding resources and reply with a Disconnect-ACK. If the SMF is unable to release the corresponding resources, it shall reply to the DN-AAA server with a Disconnect-NAK. For more information on RADIUS Disconnect, see IETF RFC 5176 [27]. If the SMF deletes the corresponding QoS flow, it is not necessary for the SMF to wait for the response (i.e. Nsmf\_PDUSession\_UpdateSMContext) from the AMF before sending the RADIUS Disconnect-ACK to the DN-AAA server. The DN-AAA shall include the identification of the QoS flow to be disconnected within the Disconnect-Request. How to identify the QoS flow to be deleted is implementation specific. + +NOTE: The QoS flow can be identified by the Acct-Session-Id which is extended to include QFI or by the Acct-Session-Id and 3GPP-NSAPI combination if provided by the SMF. + +The Teardown-Indicator in the RADIUS Disconnect Request message indicates to the SMF that all QoS flows for this particular user and sharing the same user session shall be deleted. The QoS flows that belong to the same PDU session can be identified by the Acct-Session-Id. The SMF is able to find out all the related QoS flows sharing the same user session once it has found the exact QoS flow from the Acct-Session-Id. If a user has the same user IP address for different sets of QoS flows towards different networks, only the QoS flows linked to the one identified by the Acct-Session-Id shall be deleted. If the value of Teardown-Indicator is set to "0" or if TI is missing, and if the Acct-Session-Id and 3GPP-NSAPI if provided identifies the QoS flow associated with the default QoS rule, the SMF shall tear down all the QoS flows that share the same user session identified by the Acct-Session-Id. + +Figure 11.2.3-1 is an example message flow to show the procedure of DN-AAA initiated QoS flow termination, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram showing DN-AAA initiated QoS flow termination with RADIUS. The diagram involves four entities: AMF, SMF, UPF, and DN-AAA. The sequence of messages is: 1. DN-AAA sends a 'Disconnect Request' to the SMF via the UPF. 2. SMF sends a 'Nsmf_PDUSession_UpdateSMContext' message to the AMF. 3. AMF sends a response 'Nsmf_Communication_N1N2MessageTransfer' back to the SMF. 4. SMF sends a 'Disconnect Response' to the DN-AAA via the UPF.](315bdbeafb39026e19b77c26b19d9d1f_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + Note right of DN-AAA: Disconnect Request + DN-AAA->>SMF: Disconnect Request (via UPF) + SMF->>AMF: Nsmf_PDUSession_UpdateSMContext + AMF-->>SMF: Nsmf_Communication_N1N2MessageTransfer + Note right of SMF: Disconnect Response + SMF->>DN-AAA: Disconnect Response (via UPF) + +``` + +Sequence diagram showing DN-AAA initiated QoS flow termination with RADIUS. The diagram involves four entities: AMF, SMF, UPF, and DN-AAA. The sequence of messages is: 1. DN-AAA sends a 'Disconnect Request' to the SMF via the UPF. 2. SMF sends a 'Nsmf\_PDUSession\_UpdateSMContext' message to the AMF. 3. AMF sends a response 'Nsmf\_Communication\_N1N2MessageTransfer' back to the SMF. 4. SMF sends a 'Disconnect Response' to the DN-AAA via the UPF. + +**Figure 11.2.3-1: DN-AAA initiated QoS flow termination with RADIUS** + +For the 5GC and EPC interworking scenario, when the DN-AAA server initiates the QoS flow termination, the SMF+PGW-C shall send the delete bearer request to the S-GW as defined in clause 5.4.4.1 of 3GPP TS 23.401 [53] to delete the EPS bearer corresponding to the accounting session if the UE has moved to the EPS. + +### 11.2.4 DN-AAA initiated re-authorization in 5GC + +Some IP applications could need to interwork with the SMF to update the PDU session authorization attributes. For this purpose, the DN-AAA server or proxy may send a RADIUS CoA-Request to the SMF. On receipt of the CoA-Request from the DN-AAA server, if the service-type value of "Authorize Only" is not included, the SMF shall update the corresponding PDU session authorization attributes and reply with a CoA-ACK; otherwise it shall follow the procedure described in IETF RFC 5176 [27]. DN-AAA may also use CoA procedure to revoke the authorization of a PDU session, or to update the authorization data (e.g. allowed UE MAC addresses). + +If the SMF updates/deletes the corresponding PDU session, it is not necessary for the SMF to wait for Nsmf\_PDUSession\_UpdateSMContext from the AMF before sending the RADIUS CoA-ACK to the DN-AAA server. + +Figure 11.2.4-1 is an example message flow to show the procedure of DN-AAA initiated re-authorization, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram for DN-AAA initiated re-authorization with RADIUS. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with a CoA Request from DN-AAA to SMF. SMF then sends Nsmf_PDUSession_Update SMContext to AMF. AMF responds with Namf_Communication_N1 N2MessageTransfer to SMF. SMF then sends a CoA Response to DN-AAA.](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + Note left of SMF: CoA Request + DN-AAA->>SMF: CoA Request + SMF->>AMF: Nsmf_PDUSession_Update SMContext + AMF-->>SMF: Namf_Communication_N1 N2MessageTransfer + SMF->>DN-AAA: CoA Response + +``` + +Sequence diagram for DN-AAA initiated re-authorization with RADIUS. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with a CoA Request from DN-AAA to SMF. SMF then sends Nsmf\_PDUSession\_Update SMContext to AMF. AMF responds with Namf\_Communication\_N1 N2MessageTransfer to SMF. SMF then sends a CoA Response to DN-AAA. + +Figure 11.2.4-1: DN-AAA initiated re-authorization with RADIUS + +NOTE: The DN-AAA initiated re-authorization procedure is not applicable for legacy DN-AAA supporting the RADIUS procedures over SGi interface as specified in 3GPP TS 29.061 [5]. + +#### 11.2.4a DN-AAA initiated re-authorization in EPC Interworking + +Some IP applications could need to interwork with the SMF+PGW-C to update the PDN connection authorization attributes. For this purpose, the DN-AAA server or proxy may send a RADIUS CoA-Request to the SMF+PGW-C. On receipt of the CoA-Request from the DN-AAA server, if the service-type value of "Authorize Only" is not included, the SMF shall update the corresponding PDN connection authorization attributes and reply with a CoA-ACK; otherwise it shall follow the procedure described in IETF RFC 5176 [27]. DN-AAA may also use CoA procedure to revoke the authorization of a PDN connection, or to update the authorization data (e.g. allowed UE MAC addresses). + +If the SMF+PGW-C updates/deletes the corresponding PDN connection, it is not necessary for the SMF+PGW-C to wait for Update Bearer Response from the MME before sending the RADIUS CoA-ACK to the DN-AAA server. + +Figure 11.2.4-1 is an example message flow to show the procedure of DN-AAA initiated re-authorization, messages between the SMF+PGW-C and DN-AAA are forwarded by the UPF+PGW-U in N4 user plane message. + +![Sequence diagram for DN-AAA initiated re-authorization in EPC Interworking. Lifelines: MME, SMF+PGW-C, UPF+PGW-U, DN-AAA. The sequence starts with a CoA Request from DN-AAA to SMF+PGW-C. SMF+PGW-C then sends an Update Bearer Request (PCO Authentication message) to MME. MME responds with an Update Bearer Response (PCO Authentication message) to SMF+PGW-C. SMF+PGW-C then sends a CoA Response to DN-AAA.](02d0c8a07c481d880b73a25d02050fad_img.jpg) + +``` + +sequenceDiagram + participant MME + participant SMF+PGW-C + participant UPF+PGW-U + participant DN-AAA + Note left of SMF+PGW-C: CoA Request + DN-AAA->>SMF+PGW-C: CoA Request + SMF+PGW-C->>MME: Update Bearer Request (PCO Authentication message) + MME-->>SMF+PGW-C: Update Bearer Response (PCO Authentication message) + SMF+PGW-C->>DN-AAA: CoA Response + +``` + +Sequence diagram for DN-AAA initiated re-authorization in EPC Interworking. Lifelines: MME, SMF+PGW-C, UPF+PGW-U, DN-AAA. The sequence starts with a CoA Request from DN-AAA to SMF+PGW-C. SMF+PGW-C then sends an Update Bearer Request (PCO Authentication message) to MME. MME responds with an Update Bearer Response (PCO Authentication message) to SMF+PGW-C. SMF+PGW-C then sends a CoA Response to DN-AAA. + +Figure 11.2.4a-1: DN-AAA initiated re-authorization with RADIUS + +NOTE: The DN-AAA initiated re-authorization procedure is not applicable for legacy DN-AAA supporting the RADIUS procedures over SGi interface as specified in 3GPP TS 29.061 [5]. + +## 11.3 List of RADIUS attributes + +### 11.3.1 General + +RADIUS attributes as defined in clause 16.4 of 3GPP TS 29.061 [5] are re-used in 5G with the following differences: + +- SMF or SMF+PGW-C replaces P-GW. GGSN and PPP PDP type related description are not applicable for 5G. +- 5G QoS flow replaces IP-CAN bearer and PDU session replaces IP-CAN session. +- N6 replaces Gi/Sgi and UE replaces MS. +- DNN replaces APN. +- Detailed information needed for 5G compared to 3GPP TS 29.061 [5] is described below. + +**Table 11.3-1: Additional information needed for 5G compared to the RADIUS attributes defined in 3GPP TS 29.061 [5]** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | Applicable message | +|--------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|---------|----------------------|---------------------------------------------------------------------------------------------------------------------------------| +| 79 | EAP-Message | This attribute encapsulates EAP message (as defined in IETF RFC 3748 [6]) exchanged between the SMF and DN-AAA, see IETF RFC 3579 [7] for details. | String | Conditional NOTE | Access-Request, Access-Accept, Access-Reject, CoA-Request, CoA-ACK, Disconnect-Request, Disconnect-ACK | +| | | | | Mandatory | Access-Challenge | +| 80 | Message-Authenticator | This attribute includes the message authenticator, see IETF RFC 3579 [7] for details. | String | Conditional NOTE | Access-Request, Access-Accept, Access-Reject, CoA-Request, CoA-ACK, CoA-NAK, Disconnect-Request, Disconnect-ACK, Disconnect-NAK | +| | | | | Mandatory | Access-Challenge | + +NOTE: Shall be present if EAP is used. + +**Table 11.3-2: Different information needed for 5G compared to the RADIUS VSA defined in clause 16.4.7 of 3GPP TS 29.061 [5]** + +| Sub-attr # | Sub-attribute Name | Differences | +|------------|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | 3GPP-IMSI | Re-used. | +| 2 | 3GPP-Charging-Id | Charging ID for this PDU Session. | +| 3 | 3GPP-PDP-Type | Re-used. For SMF, this sub-attribute represents PDU session type and only the values "0", "2", "3", "5" and "6" are applicable. | +| 4 | 3GPP-CG-Address | Re-used. IPv4 address of CHF. | +| 5 | 3GPP-GPRS-Negotiated-QoS-Profile | Re-used. For SMF, it uses the format for Release indicator value "15" as defined in 3GPP TS 29.061 [5]. | +| 6 | 3GPP-SGSN-Address | Re-used. It includes AMF, I-SMF or V-SMF control plane IPv4 address. | +| 7 | 3GPP-GGSN-Address | Re-used. It includes (home) SMF control plane IPv4 address providing the Nsmf_PDUSession service. | +| 8 | 3GPP-IMSI-MCC-MNC | Re-used. | +| 9 | 3GPP-GGSN-MCC-MNC | Re-used. MCC and MNC of the network the (home) SMF belongs to. | +| 10 | 3GPP-NSAPI | Re-used. It identifies QFI with value range 0-255. | +| 11 | 3GPP-Session-Stop-Indicator | Re-used. | +| 12 | 3GPP-Selection-Mode | Re-used. SMF maps the selection mode value from the enumeration value of DnnSelectionMode in 3GPP TS 29.502 [40]. | +| 13 | 3GPP-Charging-Characteristics | Re-used. | +| 14 | 3GPP-CG-IPv6-Address | Re-used. IPv6 address of CHF. | +| 15 | 3GPP-SGSN-IPv6-Address | Re-used. It includes AMF, I-SMF or V-SMF control plane IPv6 address. | +| 16 | 3GPP-GGSN-IPv6-Address | Re-used. It includes (home) SMF control plane IPv6 address providing the Nsmf_PDUSession service. | +| 17 | 3GPP-IPv6-DNS-Servers | Re-used. | +| 18 | 3GPP-SGSN-MCC-MNC | Re-used. MCC and MNC of the network the AMF belongs to | +| 19 | 3GPP-Teardown-Indicator | Re-used. | +| 20 | 3GPP-IMEISV | Re-used. | +| 21 | 3GPP-RAT-Type | Re-used. For SMF, it uses the sub-attribute definition for P-GW and only the values "3", "6" - "9", and "51" - "58" are applicable. | +| 22 | 3GPP-User-Location-Info | Re-used. For SMF, only the values "128", "129", "130", "135" and "136" of Geographic Location Type are applicable. | +| 23 | 3GPP-MS-TimeZone | Re-used. | +| 24 | 3GPP-CAMEL-Charging-Info | Not applicable. | +| 25 | 3GPP-Packet-Filter | Re-used. | +| 26 | 3GPP-Negotiated-DSCP | Re-used. | +| 27 | 3GPP-Allocate-IP-Type | Re-used. | +| 28 | External-Identifier | Re-used. | +| 29 | TWAN-Identifier | Re-used by TWAP Identifier field, supporting ssid, bssid and/or civicAddress. | +| 30 | 3GPP-User-Location-Info-Time | Re-used. | +| 31 | 3GPP-Secondary-RAT-Usage | Re-used. For SMF, the RAT values "0", "1", "2" and "3" are applicable, and the SESS field is used to indicate secondary RAT usage of the PDU session. | +| 32 | 3GPP-UE-Local-IP-Address | Re-used. Extended with TWAN applicability. | +| 33 | 3GPP-UE-Source-Port | Re-used. Extended with TWAN applicability. | +| 110 | 3GPP-Notification | Added. | +| 111 | 3GPP-UE-MAC-Address | Added. | +| 112 | 3GPP-Authorization-Reference | Added. | +| 113 | 3GPP-Policy-Reference | Added. It is not used in this release. | +| 114 | 3GPP-Session-AMBR | Added. | +| 115 | 3GPP-NAI | Added. | +| 116 | 3GPP-Session-AMBR-v2 | Added. | +| 117 | 3GPP-Supported-Features | Added. | +| 118 | 3GPP-IP-Address-Pool-Info | Added. | +| 119 | 3GPP-VLAN-Id | Added. | +| 120 | 3GPP-TNAP-Identifier | Added. | +| 121 | 3GPP-HFC-NodeId | Added. | +| 122 | 3GPP-GLI | Added. | +| 123 | 3GPP-Line-Type | Added. | +| 124 | 3GPP-NID | Added. | +| 125 | 3GPP-Session-S-NSSAI | Added. | +| 126 | 3GPP-CHF-FQDN | Added. FQDN of CHF. | +| 127 | 3GPP-Serving-NF-FQDN | Added. It includes AMF, I-SMF or V-SMF FQDN address. | + +| Sub-attr # | Sub-attribute Name | Differences | +|------------------------------------------------------|----------------------|-------------------------------------------------------------------------------------------------------------| +| 128 | 3GPP-Session-Id | Added. | +| 129 | 3GPP-GCI | Added. | +| 130 | 3GPP-DNAI | Added. | +| 131 | 3GPP-RSN | Added. | +| 132 | 3GPP-Session-Pair-Id | Added. | +| 133 | 3GPP-Charging-Id-v2 | Added. Charging ID for this PDU Session, supporting charging Id length longer than unsigned integer 32 bit. | +| NOTE: 5G specific RADIUS VSAs are numbered from 110. | | | + +#### 110 – 3GPP-Notification + +| Octets | Bits | | | | | | | | +|--------|-----------------|---|---|---|---|---|-----|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 110 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | Spare | | | | | | ACC | AUTH | + +3GPP Type: 110 + +Length: 3 + +Octet 3 is Octet String type. + +For bit 1 AUTH, + +- if the value of AUTH is set to "1", and there is IPv4 address and/or IPv6 prefix change (not allocated/de-allocated by the DN-AAA itself) and the PDU session is not terminated, the SMF shall send Access-Request message to the DN-AAA with GPSI in Calling-Station-Id or External-Identifier attribute and IP address in: + - 1) Framed-IP-Address and Framed-IPv6-Prefix, if both IPv4 address and IPv6 prefix(es) exist for the PDU session; or + - 2) Framed-IP-Address, if only IPv4 address exists for the PDU session; or + - 3) Framed-IPv6-Prefix, if only IPv6 prefix(es) exists for the PDU session. + +For Ethernet PDU session, if there is UE MAC address change, the SMF shall send Access-Request message to the DN-AAA with GPSI in Calling-Station-Id or External-Identifier attribute and the complete list of used UE MAC addresses in the 3GPP-UE-MAC-Address attribute. + +- if the value is set to "0", the SMF may notify authentication DN-AAA with the UE address and GPSI based on local configuration. + +For bit 2 ACC, + +- if the value is set to "1", and there is IPv4 address and/or IPv6 prefix change (not allocated/de-allocated by the DN-AAA itself) and the PDU session is not terminated, the SMF shall send Accounting-Request Interim-Update message to the DN-AAA with GPSI in Calling-Station-Id or External-Identifier attribute and IP address in: + - 1) Framed-IP-Address and Framed-IPv6-Prefix, if both IPv4 address and IPv6 prefix(es) exist for the PDU session; or + - 2) Framed-IP-Address, if only IPv4 address exists for the PDU session; or + - 3) Framed-IPv6-Prefix, if only IPv6 prefix(es) exists for the PDU session. + +For Ethernet PDU session, if there is UE MAC address change, the SMF shall send Accounting-Request Interim-Update message to the DN-AAA with GPSI in Calling-Station-Id or External-Identifier attribute and the complete list of used UE MAC addresses in the 3GPP-UE-MAC-Address attribute. + +- if the value is set to "0", the SMF may notify accounting DN-AAA with the UE address and GPSI based on local configuration. + +#### 111 – 3GPP-UE-MAC-Address + +| Octets | Bits | | | | | | | | +|--------|----------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 111 | | | | | | | | +| 2 | 3GPP Length= 8 | | | | | | | | +| 3-8 | MAC Address (octet string) | | | | | | | | + +3GPP Type: 111 + +Length: 8 + +It is sent from the DN-AAA to authorize UE MAC addresses. Multiple 3GPP- UE-MAC-Address sub-attributes (maximum 16) may be sent in one RADIUS CoA or Access-Accept message. The DN-AAA shall always provide the full list of allowed MAC addresses, and SMF shall replace the existing list with the newly received one. When omitted, there is no restriction and all UE MAC addresses are permitted for the Ethernet PDU session. + +When sending from the SMF to the DN-AAA, it indicates UE MAC addresses in use. Multiple 3GPP- UE-MAC-Address sub-attributes may be sent in one RADIUS Access-Request or Accounting-Request Interim-Update message. + +MAC address is Octet String type. The encoding is defined as MacAddr48 in 3GPP TS 29.571 [39] without dashes as delimiter, encoded as 12-digit hexadecimal numbers. + +#### 112 – 3GPP-Authorization-Reference + +| Octets | Bits | | | | | | | | +|--------|---------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 112 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | Authorization Data Reference (octet string) | | | | | | | | + +3GPP Type: 112 + +Length: m + +Authorization Data Reference: Octet String. It is sent from the DN-AAA to refer to the local authorization data in the SMF or PCF. + +#### 113 – 3GPP-Policy-Reference + +| Octets | Bits | | | | | | | | +|--------|--------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 113 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | Policy Data Reference (octet string) | | | | | | | | + +3GPP Type: 113 + +Length: m + +Policy Data Reference: Octet String. It is sent from the DN-AAA and used by the SMF to retrieve the SM or QoS policy data from the PCF. It is not used in this release. + +#### 114 – 3GPP-Session-AMBR + +Bits + +| Octets | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------|-----------------------------|---|---|---|---|---|---|---| +| 1 | 3GPP type = 114 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | Session AMBR (octet string) | | | | | | | | + +3GPP Type: 114 + +Length: m + +Session AMBR: Octet String. It is sent from the DN-AAA to authorize the PDU Session AMBR in the downlink and uplink direction. The encoding is defined as BitRate in 3GPP TS 29.571 [39]. Same value is applied to downlink and uplink via this VSA. + +#### 115 – 3GPP-NAI + +| Octets | Bits | | | | | | | | +|--------|--------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 115 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | NAI (octet string) | | | | | | | | + +3GPP Type: 115 + +Length: m + +NAI: Octet String. It shall be formatted according to clause 14.3 of 3GPP TS 23.003 [28] that describes an NAI. + +#### 116 – 3GPP-Session-AMBR-v2 + +| Octets | Bits | | | | | | | | +|-----------------|---------------------------------------|---|---|---|---|---|----|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 116 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3 | Spare | | | | | | DL | UL | +| 4-5 | UL Session-AMBR length (octet string) | | | | | | | | +| 6-m | UL Session-AMBR (octet string) | | | | | | | | +| (m+1)-
(m+2) | DL Session-AMBR length (octet string) | | | | | | | | +| (m+3)-n | DL Session-AMBR (octet string) | | | | | | | | + +3GPP Type: 116 + +Length: m + +Octet 3 is Octet String type. + +Bit 1 UL and bit 2 DL indicate if the corresponding UL and DL Session-AMBR shall be present in a respective field or not. If one of these bits is set to "0", the corresponding field shall not be present at all. + +UL/DL Session AMBR: Octet String. It is sent from the DN-AAA to authorize the PDU Session AMBR. The encoding is defined as BitRate in 3GPP TS 29.571 [39]. + +If the feature eSessionAMBR is supported and if applicable, the DN-AAA shall send this VSA; otherwise, the DN-AAA shall send the VSA 3GPP-Session-AMBR. + +#### 117 – 3GPP-Supported-Features + +| Octets | Bits | | | | | | | | +|--------|--------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 117 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-6 | Vendor ID (octet string) | | | | | | | | +| 7-10 | Feature List ID (octet string) | | | | | | | | +| 11-14 | Feature List (octet string) | | | | | | | | + +3GPP Type: 117 + +Length: m + +This VSA may be present in the Access-Request (initial one) message and either the Access-Challenge (initial one) or the Access-Accept message. If present, this VSA informs the destination entity about the features that the origin entity requires to successfully complete the message exchange. The Vendor ID, Feature List ID and Feature List are encoded according to 3GPP TS 29.229 [41]. See clause 12.4.1 for more detailed information regarding the general principle of the feature negotiation with the difference that RADIUS terms replace Diameter terms. The table 12.4.1-1 defines the features applicable to the RADIUS N6 interfaces for the feature lists with a Feature-List-ID of 1. + +#### 118 – 3GPP-IP-Address-Pool-Info + +| Octets | Bits | | | | | | | | | | +|--------|------------------------------------------|---|---|---|---|---|------------|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 | 3GPP type = 118 | | | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | | | +| 3 | Spare | | | | | | IP version | | | | +| 4-5 | IP address pool id length (octet string) | | | | | | | | | | +| 6-m | IP address pool id (octet string) | | | | | | | | | | + +3GPP Type: 118 + +Length: m + +Octet 3 is Octet String type. + +For bit 1 and bit 2 IP version:- if the value is set to "0", it indicates the IP address pool id is applicable for both IPv4 and IPv6; + +- if the value is set to "1", it indicates the IP address pool id is applicable for IPv4; +- if the value is set to "2", it indicates the IP address pool id is applicable for IPv6; and +- value "3" is reserved. + +The SMF may determine an IP address pool ID based on UPF ID, S-NSSAI, DNN, and IP version as described in clause 5.8.2.2.1 in 3GPP TS 23.501 [2] and includes the IP address pool ID within 3GPP-IP-Address-Pool-Info and send it to the DN-AAA. The DN-AAA assigns IPv6 prefix or IPv4 address from the requested IP address pool. Multiple 3GPP-IP-Address-Pool-Info sub-attributes may be sent in the RADIUS Access-Request message. The DN-AAA shall include the selected IP address pool in the 3GPP-IP-Address-Pool-Info sub-attribute of the RADIUS Access-Accept message. For accounting, if Framed-IP-Address or Framed-IPv6-Prefix attribute is included in RADIUS Accounting-Request (START/Interim-Update/STOP), the SMF shall also include the 3GPP-IP-Address-Pool-Info sub-attribute. + +#### 119 – 3GPP-VLAN-Id + +Bits + +| Octets | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------|-----------------|---|---|---|-------|---|---|---| +| 1 | 3GPP type = 119 | | | | | | | | +| 2 | 3GPP Length= 4 | | | | | | | | +| 3 | VID value | | | | Spare | | | | +| 4 | VID value | | | | | | | | + +3GPP Type: 119 + +Length: 4 + +VLAN Id: Octet String. Octet 3/ Bit 1 to Bit 4 shall be zero, Octet 3 / Bit 8 shall be the most significant bit of the VLAN Id and Octet 4 / Bit 1 shall be the least significant bit. + +It is sent from the DN-AAA to authorize the allowed VLAN Ids for the Ethernet PDU session. Multiple 3GPP-VLAN-Id sub-attributes (maximum 16) may be sent in one RADIUS CoA or Access-Accept message. The DN-AAA shall always provide the full list of allowed VLAN Ids, and SMF shall replace the existing list with the newly received one. When omitted, there is no restriction and all VLAN Ids are permitted for the Ethernet PDU session. + +#### 120 – 3GPP-TNAP-Identifier + +| Octets | Bits | | | | | | | | +|--------|--------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 120 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | TNAP Identifier (octet string) | | | | | | | | + +3GPP Type: 120 + +Length: m, where m depends on the type of location that is present as described in 3GPP TS 29.274 [50]. + +TNAP Identifier field is used to convey the location information in a Trusted Non-3GPP Access Network. The coding of this field shall be the same as for the GTP TWAN Identifier starting with Octet 5, till Octet (q+r) +2 as per clause 8.100 in 3GPP TS 29.274 [50], with LAII flag, OPNAI flag and PLMNI flag in Octet 5 shall be set as zero. + +TNAP Identifier field is Octet String type. + +The SMF may indicate the UE location in a Trusted Non-3GPP Access Network, in Access-Request, Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. + +#### 121 – 3GPP-HFC-NodeId + +| Octets | Bits | | | | | | | | +|--------|--------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 121 | | | | | | | | +| 2 | 3GPP Length= n | | | | | | | | +| 3-n | HFCNodeId (octet string) | | | | | | | | + +3GPP Type: 121 + +Length: $n \leq 6+2$ + +HFCNodeId field is the identifier of the HFC node Id as specified in CableLabs WR-TR-5WWC-ARCH [51]. It is provisioned by the wireline operator as part of wireline operations and may contain up to six characters. + +HFCNodeId field is Octet String type. + +The SMF may indicate the HFC Node Identifier received over NGAP. Present for a 5G-CRG accessing the 5GC via wireline access network, in Access-Request, Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. Present for a FN-CRG accessing the 5GC via wireline access network, in Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. + +#### 122 – 3GPP-GLI + +| Octets | Bits | | | | | | | | +|--------|--------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 122 | | | | | | | | +| 2 | 3GPP Length= n | | | | | | | | +| 3-n | GLI (octet string) | | | | | | | | + +3GPP Type: 122 + +Length: $n \leq 150+2$ + +GLI field is the Global Line Identifier uniquely identifying the line connecting the 5G-BRG or FN-BRG to the 5GS. See clause 28.16.3 of 3GPP TS 23.003 [28]. Shall be encoded as a string with format "byte", i.e. base64-encoded characters, representing the GLI value (up to 150 bytes) encoded as specified in BBF WT-470 [52]. + +GLI field is Octet String type. + +The SMF may indicate the Global Line Identifier. Present for a 5G-BRG accessing the 5GC via wireline access network, in Access-Request, Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. Present for a 5G-BRG accessing the 5GC via wireline access network, in Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. + +#### 123 – 3GPP-Line-Type + +| Octets | Bits | | | | | | | | +|--------|--------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 123 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | Line-Type (octet string) | | | | | | | | + +3GPP Type: 123 + +The Line-Type sub-attribute may be present for a 5G-BRG/FN-BRG accessing the 5GC via wireline access network. + +When present, it shall indicate the type of the wireline (DSL or PON). + +Line-Type field is Octet String type. It shall be coded as follows: + +0 (DSL): + +This value shall be used to indicate DSL line. + +1 (PON): + +This value shall be used to indicate PON line. + +The SMF may indicate the type of the wireline (DSL or PON). Present for a 5G-BRG accessing the 5GC via wireline access network, in Access-Request, Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. Present for a FN-BRG accessing the 5GC via wireline access network, in Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. + +#### 124 – 3GPP-NID + +Bits + +| Octets | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------|---------------------------|---|---|---|---|---|---|---| +| 1 | 3GPP type = 124 | | | | | | | | +| 2 | 3GPP Length= 13 | | | | | | | | +| 3-13 | Network ID (octet string) | | | | | | | | + +3GPP Type: 124 + +Length: 13 + +The Network ID field is Octet String type. The encoding is defined as Nid in 3GPP TS 29.571 [39]. + +Table 11.3-3 describes the sub-attributes of the 3GPP Vendor-Specific attribute described above in different RADIUS messages. + +#### ***125 – 3GPP-Session-S-NSSAI*** + +| Octets | Bits | | | | | | | | +|--------|-------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 125 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3 | SST | | | | | | | | +| 4-6 | SD (octet string) | | | | | | | | + +3GPP Type: 125 + +Length: 3 or 6 + +SST: the Slice/Service Type with value range 0 to 255. + +SD: 3-octet string, representing the Slice Differentiator, the encoding follows sd attribute specified in clause 5.4.4.2 of 3GPP TS 29.571 [46]. Its presence depends on the Length field. + +It is sent from the SMF to the DN-AAA server to indicate the S-NSSAI that is associated with the PDU Session. + +#### ***126 – 3GPP-CHF-FQDN*** + +| Octets | Bits | | | | | | | | +|--------|-----------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 126 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | CHF FQDN | | | | | | | | + +3GPP Type: 126 + +Length: m + +CHF FQDN: string, indicates the FQDN of the CHF. + +It is sent from the SMF to the DN-AAA server to indicate the FQDN of the CHF. + +#### ***127 – 3GPP-Serving-NF-FQDN*** + +| Octets | Bits | | | | | | | | +|--------|-----------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 127 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | Serving NF FQDN | | | | | | | | + +3GPP Type: 127 + +Length: m + +Serving NF FQDN: string, indicates the FQDN of the Serving NF (including AMF, I-SMF or V-SMF). + +It is sent from the SMF to the DN-AAA server to indicate the Serving NF FQDN address. + +#### 128 – 3GPP-Session-Id + +| Octets | Bits | | | | | | | | +|--------|-----------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 128 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | PduSessionId | | | | | | | | + +3GPP Type: 128 + +Length: 3 + +PduSessionId: 1-octet unsigned integer identifying a PDU session, within the range 0 to 255, as specified in clause 5.4.2 of 3GPP TS 29.571 [46]. + +It is sent from the SMF to the DN-AAA server to indicate the PDU Session Identifier. + +#### 129 – 3GPP-GCI + +| Octets | Bits | | | | | | | | +|--------|--------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 129 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | GCI (octet string) | | | | | | | | + +3GPP Type: 129 + +Length: m + +GCI field is Octet String type. + +The GCI is the Global Cable Identifier uniquely identifies the line connecting the 5G-CRG or FN-CRG to the 5GS. See clause 28.15.4 of 3GPP TS 23.003 [28]. + +The GCI is a variable length opaque identifier, shall be encoded as specified in CableLabs WR-TR-5WWC-ARCH [51] and CableLabs DOCSIS MULPI [55]. It shall comply with the syntax specified in clause 2.2 of IETF RFC 7542 [56] for the username part of a NAI. + +The SMF may indicate the Global Cable Identifier. Present for a 5G-CRG accessing the 5GC via wireline access network, in Access-Request, Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. Present for a FN-CRG accessing the 5GC via wireline access network, in Accounting-Request START, Accounting-Request STOP, or Accounting-Request Interim-Update messages. + +#### 130 – 3GPP-DNAI + +| Octets | Bits | | | | | | | | +|--------|-----------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 130 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | DNAI (string) | | | | | | | | + +3GPP Type: 130 + +Length: m + +DNAI: string, indicates the Data Network Access Identifier. + +It is sent from SMF to DN-AAA server to indicate the SMF selected or used DNAI interworking with the external DN. + +#### ***131 – 3GPP-RSN*** + +| Octets | Bits | | | | | | | | +|--------|-----------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 131 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | RSN | | | | | | | | + +3GPP Type: 131 + +Length: 3 + +RSN: 1-octet unsigned integer identifying a RSN (see 3GPP TS 24.501 [42] for encoding). + +It is sent from the SMF to the DN-AAA accounting server to indicate the RSN. + +#### ***132 – 3GPP-Session-Pair-Id*** + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 132 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | PDU Session Pair Id | | | | | | | | + +3GPP Type: 132 + +Length: 3 + +PDU Session Pair Id: 1-octet unsigned integer identifying a PDU session pair information (see 3GPP TS 24.501 [42] for encoding). + +It is sent from the SMF to the DN-AAA accounting server to indicate the PDU Session Pair Identifier. Two redundant PDU sessions share the same PDU Session Pair Identifier. + +#### ***133 – 3GPP-Charging ID-v2*** + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 133 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | Charging ID (string) | | | | | | | | + +3GPP Type: 133 + +Length: m + +Charging ID value: string, indicates the Charging Identifier. + +Table 11.3-3: List of the 3GPP Vendor-Specific sub-attributes for N6 + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicability | +|------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---------------------------------------------------------------------------------------------------------------------|---------------| +| 110 | 3GPP-Notification | It includes all notifications that the DN-AAA wants to receive from the SMF. | Optional | Access-Accept | | +| 111 | 3GPP-UE-MAC-Address | It is sent from the DN-AAA to authorize UE MAC addresses, or it indicates UE MAC addresses in use when sending from the SMF to the DN-AAA. | Optional | Access-Request, Access-Accept, Accounting-Request Interim-Update, Change-of-Authorization | | +| 112 | 3GPP-Authorization-Reference | It is sent from the DN-AAA to refer to the local authorization data in the SMF. | Optional | Access-Accept, Change-of-Authorization | | +| 113 | 3GPP-Policy-Reference | It is sent from the DN-AAA and used by the SMF to retrieve the SM or QoS policy data from the PCF. It is not used in this release. | Optional | Access-Accept, Change-of-Authorization | | +| 114 | 3GPP-Session-AMBR | It is sent from the DN-AAA to authorize the PDU Session AMBR in the downlink and uplink. | Optional | Access-Accept, Change-of-Authorization | | +| 115 | 3GPP-NAI | The Network Access Identifier identifying the UE. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | | +| 116 | 3GPP-Session-AMBR-v2 | It is sent from the DN-AAA to authorize the PDU Session AMBR, it includes separate session AMBR for UL and DL. | Optional | Access-Accept, Change-of-Authorization | eSession AMBR | +| 117 | 3GPP-Supported-Features | It indicates the supported features as specified in clause 12.4.1. | Optional | Access-Request, Access-Accept, Access-Challenge, Accounting-Request START, Accounting-Response START | | +| 118 | 3GPP-IP-Address-Pool-Info | It indicates the IP address pool identifier. | Optional | Access-Request, Access-Accept, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | | +| 119 | 3GPP-VLAN-Id | It is sent from the DN-AAA to authorize the allowed VLAN Id for the Ethernet PDU session. | Optional | Access-Accept, Change-of-Authorization | | +| 120 | 3GPP-TNAP-Identifier | Indicates the UE location in a Trusted | Optional | Access-Request, Accounting-Request START, | | + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicability | +|------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------|----------------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| | | Non-3GPP Access Network. | | Accounting-Request STOP,
Accounting-Request Interim-Update | | +| 121 | 3GPP-HFC-NodeId | Indicates the HFC Node Identifier received over NGAP. Present for a 5G-CRG/FN-CRG accessing the 5GC via wireline access network | Optional | Access-Request (NOTE 1),
Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update | | +| 122 | 3GPP-GLI | Indicates the Global Line Identifier. Present for a 5G-BRG/FN-BRG accessing the 5GC via wireline access network. | Optional | Access-Request (NOTE 1),
Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update | | +| 123 | 3GPP-Line-Type | Indicates the type of the wireline (DLS or PON). Present for a 5G-BRG/FN-BRG accessing the 5GC via wireline access network. | Optional | Access-Request (NOTE 1),
Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update | | +| 124 | 3GPP-NID | Indicates the network identifier. It shall only be present together with 3GPP-SGSN-MCC-MNC to identify an SNPN. | Optional | Access-Request,
Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update | | +| 125 | 3GPP-Session-S-NSSAI | Indicates the S-NSSAI that is associated with the PDU Session. | Optional | Access-Request
Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update (NOTE 2) | | +| 126 | 3GPP-CHF-FQDN | Indicates the FQDN of the CHF. | Optional | Access-Request
Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update | | +| 127 | 3GPP-Serving NF-FQDN | Indicates the FQDN of the Serving NF (includes AMF, I-SMF or V-SMF). | Optional | Access-Request
Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update | | +| 128 | 3GPP-Session-Id | Indicates the PDU Session Identifier. | Optional | Access-Request
Accounting-Request START, | | + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicability | +|------------|----------------------|------------------------------------------------------------------------------------------------------|----------------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| | | | | Accounting-Request STOP,
Accounting-Request Interim-Update (NOTE 2) | | +| 129 | 3GPP-GCI | Indicates the line connecting the 5G-CRG or FN-CRG to the 5GS | Optional | Access-Request (NOTE 1),
Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update | | +| 130 | 3GPP-DNAI | Indicates the SMF selected or used DN Access Identifier interworking with the external DN. | Optional | Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update | | +| 131 | 3GPP-RSN | Indicates the RSN. | Optional | Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update | | +| 132 | 3GPP-Session-Pair-Id | Indicates the PDU Session Pair Identifier | Optional | Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update | | +| 133 | 3GPP-Charging-Id-v2 | Charging ID for this PDU Session, supporting charging Id length longer than unsigned integer 32 bit. | Optional | Access-Request (NOTE 1),
Accounting-Request START,
Accounting-Request STOP,
Accounting-Request Interim-Update | | + +NOTE 1: Access-Request is not applicable for FN-CRG or FN-BRG. + +NOTE 2: This VSA is optional in the Accounting-Request Interim-Update message. + +RADIUS attributes related to the DN-AAA initiated re-authorization and authentication challenge are described in the following clauses. + +### 11.3.2 Change-of-Authorization Request (optionally sent from DN-AAA server to SMF) + +Table 11.3.2-1 describes the attributes of the Change-of-Authorization Request message. Other RADIUS attributes may be used as defined in IETF RFC 5176 [27]. + +**Table 11.3.2-1: The attributes of the Change-of-Authorization Request message** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|---------------------------------| +| 1 | User-Name | Username provided by the user (extracted from the PCO field received during PDN connection establishment). If no username is available a generic username, configurable on a per DNN basis, shall be present. If the User-Name has been sent in the Access-Accept message, this username shall be used in preference to the above | String | Optional | +| 6 | Service-Type | Indicates the type of service for this user. | 17 (Authorize Only) | Optional | +| 8 | Framed-IP-Address | User IPv4 address | Ipv4 | Conditional
NOTE 2 | +| 10 | 3GPP-NSAPI | identifies QFI with value range 0-255 in this user session. | UTF-8 encoded character | Optional | +| 30 | Called-Station-Id | Identifier for the target network | DNN (UTF-8 encoded characters) | Optional | +| 31 | Calling-Station-Id | This attribute is the identifier for the UE, and it shall be configurable on a per DNN basis. | MSISDN in international format according to 3GPP TS 23.003 [28], UTF-8 encoded decimal character. (NOTE 5) | Optional | +| 96 | Framed-Interface-Id | User IPv6 Interface Identifier | IPv6 | Conditional
NOTE 1
NOTE 2 | +| 44 | Acct-Session-Id | User session identifier. | SMF IP address (IPv4 or IPv6) and Charging-ID concatenated in a UTF-8 encoded hexadecimal characters. (NOTE 6) | Mandatory | +| 79 | EAP-Message | This attribute encapsulates EAP message (as defined in IETF RFC 3748 [6]) exchanged between the SMF and DN-AAA, see IETF RFC 3579 [7] for details. | String | Conditional
NOTE 3 | +| 80 | Message-Authenticator | This attribute includes the message authenticator, see IETF RFC 3579 [7] for details. | String | Conditional
NOTE 3 | +| 97 | Framed-IPv6-Prefix | User IPv6 prefix | IPv6 | Conditional
NOTE 2 | +| 123 | Delegated-IPv6-Prefix | Delegated IPv6 prefix to the user. | IPv6 | Conditional
NOTE 4 | +| 26/10
415 | 3GPP Vendor-Specific | Sub-attributes according clause 11.3, the encoding of this attribute is specified in 3GPP TS 29.061 [5]. | See clause 11.3 | Optional | + +NOTE 1: Included if the prefix alone is not unique for the user. This may be the case, for example, if a static IPv6 address is assigned. + +NOTE 2: If the 3GPP-PDP-Type is IPv4, IPv6 or IPv4v6, either IPv4 or IPv6 address/prefix attribute shall be present. The IP protocol version for end-user and network may be different. + +NOTE 3: Shall be present if EAP is used. + +NOTE 4: The delegated IPv6 prefix shall be present if IPv6 prefix delegation is required from the external DN-AAA server. + +NOTE 5: There are no leading characters in front of the country code. + +NOTE 6: If the accounting session is created per QoS flow, Acct-Session-Id may be extended to include the QFI of the QoS flow. + +### 11.3.3 Access-Challenge (sent from DN-AAA server to SMF) + +Table 11.3.3-1 describes the attributes of the Access-Challenge Request message. Other RADIUS attributes may be used as defined in IETF RFC 2865 [8]. + +**Table 11.3.3-1: The attributes of the Access-Challenge message** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|----------------------| +| 27 | Session-Timeout | Indicates the timeout value (in seconds) for the user session | 32 bit unsigned Integer | Optional | +| 79 | EAP-Message | This attribute encapsulates EAP message (as defined in IETF RFC 3748 [6]) exchanged between the SMF and DN-AAA, see IETF RFC 3579 [7] for details. | String | Mandatory | +| 80 | Message-Authenticator | This attribute includes the message authenticator, see IETF RFC 3579 [7] for details. | String | Mandatory | + +NOTE: Included if the prefix alone is not unique for the user. This may be the case, for example, if a static IPv6 address is assigned. + +# 12 Interworking with DN-AAA (Diameter) + +## 12.1 Diameter Procedures + +### 12.1.1 Diameter Authentication and Authorization + +The SMF also represents the H-SMF in the home routed scenario in this clause unless specified otherwise. + +Diameter Authentication and Authorization shall be used according to IETF RFC 7155 [23]. In 5G, multiple authentication methods using Extensible Authentication Protocol (EAP) may be used such as EAP-TLS (see IETF RFC 5216 [11]), EAP-TTLS (see IETF RFC 5281 [37]). The SMF shall support Diameter EAP application as specified in IETF RFC 4072 [25]. + +The SMF and the DN-AAA shall advertise the support of the Diameter NASREQ and EAP applications by including the value (1 and 5) of the application identifier in the Auth-Application-Id AVP (as specified in IETF RFC 4072 [25]) and the value of the 3GPP (10415) in the Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands as specified in IETF RFC 6733 [24], i.e. as part of the Vendor-Specific-Application-Id AVP. + +The Diameter client function may reside in an SMF. When the SMF receives an initial access request (i.e. the SMF receives the Nsmf\_PDUSession\_CreateSMContext request with type "Initial request" for non-roaming case or local breakout case, or the H-SMF receives the Nsmf\_PDUSession\_Create Request with type "Initial request" for home routed case), the Diameter client function may send the authentication information to a DN-AAA server, which is identified during the DNN provisioning. + +When the legacy applications require PAP/CHAP authentication with the UE accessing to the 5GS and the legacy DN-AAA server does not support EAP, PAP/CHAP may be used as the authentication protocol, with the external network performing the risk assessment. + +The DN-AAA server performs authentication and authorization. The response (when positive) may contain network information, such as an IPv4 address and/or IPv6 prefix for the user when the SMF is interworking with the DN-AAA server. + +The information delivered during the Diameter authentication can be used to automatically correlate the user identity (e.g. SUPI) to the IPv4 address and/or IPv6 prefix, if applicable, assigned/confirmed by the SMF or the DN-AAA server respectively. The same procedure applies, in case of sending the authentication to a 'proxy' DN-AAA server. + +For 5G, Diameter Authentication is applicable to the initial access request. When the SMF receives a positive response from the DN-AAA server it shall complete the initial access procedure. If DEA with Result-Code set to + +DIAMETER\_AUTHENTICATION\_REJECTED or no response is received, the SMF shall reject the initial access procedure with a suitable cause code. + +When DN-AAA server authorizes the PDU Session Establishment, it may send DN authorization data for the established PDU Session to the SMF. The DN authorization data for the established PDU Session may include one or more of the following: + +- a reference to authorization data for policy and charging control locally configured in the SMF; +- a list of allowed MAC addresses (maximum 16) for the Ethernet PDU Session; +- a list of allowed VLAN Ids (maximum 16) for the Ethernet PDU Session; +- Session-AMBR for the PDU Session; +- L2TP information, such as LNS IP address and/or LNS host name; and +- Framed Route information for the PDU Session. + +NOTE 1: If the DN-AAA server send L2TP information to SMF, the L2PT information can e.g. be provisioned per DNN/S-NSSAI or per SUPI or GPSI by configuration which is out of the scope of 3GPP specifications. + +SMF policies may require DN authorization without DN authentication. In that case, when contacting the DN-AAA server for authorization, the SMF shall provide the GPSI of the UE if available. + +The SMF may also use the Diameter re-authorization procedure for the purpose of IPv4 address and/or IPv6 prefix allocation to the UE. The use cases that may lead this procedure are: + +- IPv4 address and/or IPv6 prefix allocation after UPF selection during PDU session establishment procedure. +- IPv6 prefix allocation during adding additional PDU Session Anchor procedure for IPv6 multi-homing. +- IPv4 address allocation via DHCPv4 procedure after successful PDU session establishment procedure. + +The SMF may also trigger request for DN authentication/authorization and/or IP address/prefix allocation based on UE subscription data retrieve from the UDM as defined in clause 5.2.2.2.5 of 3GPP TS 29.503. + +When an IPv4 address and/or IPv6 prefix (including any additional IPv6 prefix of IPv6 multi-homing) is (re-)allocated or de-allocated (not causing the PDU session to be released) by using a method not via the DN-AAA server and if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the authentication session that was established before to inform the DN-AAA server by sending Diameter DER or AAR with the latest list of IPv4 address and/or IPv6 prefix(es). + +When the SMF is notified by the UPF regarding the UE MAC address change (a new one is detected or a used one is inactive), if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the authentication session that was established before to inform the DN-AAA server by sending Diameter DER or AAR with the latest list of UE MAC addresses in use. + +DN-AAA may initiate QoS flow termination, see details in clause 12.2.3. DN-AAA may initiate re-authorization and optional re-authentication, see details in clause 12.2.4 and 12.2.5. + +#### 12.1.1a Diameter Authentication and Authorization in EPC Interworking + +Diameter Authentication and Authorization shall be used according to IETF RFC 7155 [23]. Multiple authentication methods using Extensible Authentication Protocol (EAP) may be used such as EAP-TLS (see IETF RFC 5216 [11]), EAP-TTLS (see IETF RFC 5281 [37]). The SMF+PGW-C shall support Diameter EAP application as specified in IETF RFC 4072 [25]. + +The SMF+PGW-C and the DN-AAA shall advertise the support of the Diameter NASREQ and EAP applications by including the value (1 and 5) of the application identifier in the Auth-Application-Id AVP (as specified in IETF RFC 4072 [25]) and the value of the 3GPP (10415) in the Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands as specified in IETF RFC 6733 [24], i.e. as part of the Vendor-Specific-Application-Id AVP. + +The Diameter client function may reside in an SMF+PGW-C. When the SMF+PGW-C receives new Create Session Request and the Session Management Subscription Data from the UDM or local configuration indicate the need for EAP-based secondary authentication and authorization by DN-AAA, the Diameter client function may send the authentication information to a DN-AAA server, which is identified during the DNN provisioning. + +When the legacy applications require PAP/CHAP authentication with the UE accessing the 5GC and EPC interworking scenario and the legacy DN-AAA server does not support EAP, PAP/CHAP may be used as the authentication protocol, with the external network performing the risk assessment. + +The DN-AAA server performs authentication and authorization. The response (when positive) may contain network information, such as an IPv4 address and/or IPv6 prefix for the user when the SMF+PGW-C is interworking with the DN-AAA server. + +The information delivered during the Diameter authentication can be used to automatically correlate the user identity (e.g. SUPI) to the IPv4 address and/or IPv6 prefix, if applicable, assigned/confirmed by the SMF+PGW-C or the DN-AAA server respectively. The same procedure applies, in case of sending the authentication to a 'proxy' DN-AAA server. + +When the SMF+PGW-C receives a positive response from the DN-AAA server it shall complete the initial access procedure. If Access-Reject or no response is received, the SMF+PGW-C shall reject the initial access procedure with a suitable cause code. + +When DN-AAA server authorizes the PDN Connection Establishment, it may send DN authorization data for the established PDN Connection to the SMF+PGW-C. The DN authorization data for the established PDN Connection may include one or more of the following: + +- a reference to authorization data for policy and charging control locally configured in the SMF+PGW-C; +- a list of allowed MAC addresses (maximum 16) for the Ethernet PDN Connection; +- a list of allowed VLAN Ids (maximum 16) for the Ethernet PDN Connection; +- Session-AMBR for the PDU Connection; +- L2TP information, such as LNS IP address and/or LNS host name; and +- Framed Route information for the PDU Connection. + +NOTE 1: If the DN-AAA server send L2TP information to SMF+PGW-C, the L2TP information can e.g. be provisioned per DNN/S-NSSAI or per SUPI or GPSI by configuration which is out of the scope of 3GPP specifications. + +SMF+PGW-C policies may require DN authorization without DN authentication. In that case, when contacting the DN-AAA server for authorization, the SMF+PGW-C shall provide the GPSI of the UE if available. + +The SMF may also use the Diameter re-authorization procedure for the purpose of IPv4 address and/or IPv6 prefix allocation to the UE. The use cases that may lead this procedure are: + +- IPv4 address and/or IPv6 prefix allocation after UPF selection during PDU connection establishment procedure. +- IPv6 prefix allocation during adding additional PDN connection Anchor procedure for IPv6 multi-homing. +- IPv4 address allocation via DHCPv4 procedure after successful PDN connection establishment procedure. + +The SMF+PGW-C may also trigger request for DN authentication/authorization and/or IP address/prefix allocation based on UE subscription data retrieve from the UDM as defined in clause 5.2.2.2.5 of 3GPP TS 29.503. + +When an IPv4 address and/or IPv6 prefix (including any additional IPv6 prefix of IPv6 multi-homing) is (re-)allocated or de-allocated (not causing the PDN connection to be released) by using a method not via the DN-AAA server and if the SMF+PGW-C was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF+PGW-C shall, if applicable, use the authentication session that was established before to inform the DN-AAA server by sending Diameter DER or AAR with the latest list of IPv4 address and/or IPv6 prefix(es). + +When the SMF+PGW-C is notified by the UPF+PGW-U regarding the UE MAC address change (a new one is detected or a used one is inactive), if the SMF+PGW-C was required by the DN-AAA server to report such change during + +authentication procedure or by local configuration, the SMF+PGW-C shall, if applicable, use the authentication session that was established before to inform the DN-AAA server by sending Diameter DER or AAR with the latest list of UE MAC addresses in use. + +DN-AAA may initiate QoS flow termination, see details in clause 12.2.3. DN-AAA may initiate re-authorization and optional re-authentication, see details in clause 12.2.4 and 12.2.5. + +In case EAP based authentication and authorization has been performed for the PDU Session while the UE was in 5GS, and if SMF+PGW-C determines that the UE has moved to the EPS (i.e. the SMF+PGW-C receives the modify bearer request or create session request from the S-GW), the following applies: + +- the SMF+PGW-C may initiate Diameter re-authorization procedure without re-authentication with the DN-AAA server based on local policy. +- DN-AAA initiated re-authorization without re-authentication may be performed. +- when the SMF+PGW-C receives a re-authentication request from the DN-AAA server, the SMF+PGW-C shall execute the procedure as described in clause 12.2.5. + +NOTE 2: The DN-AAA server decided actions to take (e.g. to request another re-authorization without the association with EAP based re-authentication or release the session) are out of 3GPP scope. + +### 12.1.2 Diameter Accounting + +Diameter Accounting shall be used according to IETF RFC 7155 [23]. + +The SMF and the DN-AAA may advertise the support of the Diameter base accounting application by including the value (3) of the application identifier in the Acct-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands as specified in IETF RFC 6733 [24], i.e. as part of the Vendor-Specific-Application-Id AVP. + +The Diameter accounting client function may reside in an SMF. The Diameter accounting client may send information to a DN-AAA server, which is identified during the DNN provisioning. The DN-AAA server may store this information and use it to automatically identify the user. This information can be trusted because the 3GPP network has authenticated the subscriber (i.e. USIM card and possibly other authentication methods). + +The SMF may use the Diameter Accounting messages during QoS flow (e.g. QoS flow associated with the default QoS rule) establishment and termination procedures, respectively. + +If the DN-AAA server is used for IPv4 address and/or IPv6 prefix assignment, then, upon reception of a Diameter Accounting-Request STOP message for all QoS flows associated to a PDU session defined by DNN and SUPI or GPSI, the DN-AAA server may make the associated IPv4 address and/or IPv6 prefix available for assignment. + +When an IPv4 address and/or IPv6 prefix (including any additional IPv6 prefix of IPv6 multi-homing) is (re-)allocated or de-allocated (not causing the PDU session to be released) by using a method not via the DN-AAA server and if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the accounting session that was established before to inform the DN-AAA server by sending Diameter Accounting-Request Interim-Update with the latest list of IPv4 address and/or IPv6 prefix(es). + +When the SMF is notified by the UPF regarding the UE MAC address change (a new one is detected or a used one is inactive), if the SMF was required by the DN-AAA server to report such change during authentication procedure or by local configuration, the SMF shall, if applicable, use the accounting session that was established before to inform the DN-AAA server by sending Diameter Accounting-Request Interim-Update with the latest list of UE MAC addresses in use. + +## 12.2 Message flows on N6 interface + +### 12.2.1 Authentication, Authorization and Accounting procedures + +The SMF also represents the H-SMF in the home routed scenario in this clause unless specified otherwise. + +When an SMF receives an initial access request (i.e. the SMF receives the Nsmf\_PDUSession\_CreateSMContext request with type "Initial request" for non-roaming case or local breakout case, or the H-SMF receives the Nsmf\_PDUSession\_Create Request with type "Initial request" for home routed case) message for a given DNN, the SMF may (depending on the configuration for this DNN) send a Diameter DER message to a DN-AAA server. The SMF may also (depending on the configuration for this DNN) send the S-NSSAI and the PDU Session ID that are associated with the PDU Session, respectively in the 3GPP-Session-S-NSSAI AVP and the 3GPP-Session-Id AVP, to a DN-AAA server. Upon receipt of the DER message, the DN-AAA server shall respond with an DEA message. Multi-round authentication using the DEA (with Result-Code set to DIAMETER\_MULTI\_ROUND\_AUTH) and DER messages may be used. The DN-AAA server finally authenticates and authorizes the user by replying with the DEA message with Result-Code set to DIAMETER\_SUCCESS. If the DN-AAA server is also responsible for IPv4 address and/or IPv6 prefix allocation, the DN-AAA server shall return the allocated IPv4 address and/or IPv6 prefix in the DEA message. + +For re-authentication and re-authorization, the SMF shall send a DER message to the DN-AAA server and the DN-AAA server shall respond with a DEA message. Multi-round authentication using the DEA (with Result-Code set to DIAMETER\_MULTI\_ROUND\_AUTH) and DER messages may be used. The DN-AAA server finally authenticates and authorizes the user by replying with the DEA message with Result-Code set to DIAMETER\_SUCCESS. + +The SMF may initiate Diameter re-authorization procedures for the purpose of IPv4 address and/or IPv6 prefix allocation (or renew the lease). In this case, the SMF shall set the Session-Id to the value used in the initial request, the Auth-Request-Type AVP to "AUTHORIZE\_ONLY" and the 3GPP-Allocate-IP-Type AVP to the type of IP address to be allocated in the AA-Request message sent to the AAA server. If the SMF is using DHCP signalling towards the UE and the DN-AAA server includes the Session-Timeout attribute in the DEA, the SMF may use the Session-Timeout value as the DHCP lease time. The SMF shall not set the DHCPv4 lease time value higher than the Session-Timeout value. The SMF may renew the DHCP lease to the UE without re-authorization towards the DN-AAA server providing that the new lease expiry is no later than the Session-Timeout timer expiry. If the SMF wishes to extend the lease time beyond the current Session-Timeout expiry, it shall initiate a new AAA re-authorization. + +Even if the SMF was not involved in user authentication, it may send a Diameter Accounting-Request (START) message to a DN-AAA server. If no Diameter session is already open for the same PDU session a Diameter session needs to be activated, otherwise the existing Diameter session is used to send the Accounting-Request (START). If accounting is used per QoS flow, the QFI will identify the particular bearer this accounting message refers to. This message contains parameters, e.g. the tuple which includes the user ID and IPv4 address and/or IPv6 prefix, to be used by application servers (e.g. WAP gateway) in order to identify the user, the 3GPP-Charging-Id AVP or 3GPP-Charging-Id-v2 AVP according to the length of the Charging Id for the user session. This message may also (depending on the configuration for the DNN) contains the S-NSSAI and the PDU Session ID that are associated with the PDU Session, respectively in the 3GPP-Session-S-NSSAI AVP and the 3GPP-Session-Id AVP, and/or AF traffic influence PCC rule provisioned and then SMF used DNAI in the 3GPP-DNAI AVP, to a DN-AAA server. This message also indicates to the DN-AAA server that the user session has started. + +If some external applications require Diameter Accounting-Request (START) information before they can process user packets, then the selected DNN (SMF) may be configured in such a way that the SMF drops user data until an Accounting-Answer (START) indicating success is received from the DN-AAA server. The SMF may wait for the Accounting-Answer (START) before sending the final authentication response message in Namf\_Communication\_N1N2MessageTransfer service operation. The SMF may reject the initial access request if the Accounting-Answer (START) is not received. The authentication and accounting servers may be separately configured for each DNN. + +For IPv4 PDU type, if IPv4 address is allocated via DHCPv4 signalling between the UE and the DN-AAA after PDU session establishment, the SMF may wait to send the Accounting-Request START message until the UE receives its IPv4 address in a DHCPACK. + +When the SMF receives a message indicating a QoS flow or PDU session release request and providing a Diameter Accounting-Request START message was sent previously, the SMF shall send a Diameter Accounting-Request (STOP) message to the DN-AAA server, which indicates the termination of this particular QoS flow or PDU session. The SMF shall immediately send the corresponding response (e.g. Nsmf\_PDUSession\_UpdateSMContext response) to the AMF, without waiting for an Accounting-Answer (STOP) message from the DN-AAA server. + +If the last QoS flow of a PDU session is deactivated, the SMF shall additionally send an STR message to the DN-AAA server. The DN-AAA server shall reply with an STA message and shall deallocate the IPv4 address and/or IPv6 prefix initially allocated to the subscriber. + +The following figure 12.2.1-1 is an example message flow to show the procedure of Diameter Authentication and Accounting between an SMF and a DN-AAA server: + +1. UE initiates the PDU Session Establishment procedure, including authentication/authorization information. +2. The AMF sends Nsmf\_PDUSession\_CreateSMContext Request including the authentication/authorization information to the SMF and the SMF responds to the service operation. + +According to the configuration in the SMF, step 6 to step 9 are executed before step 3 if the SMF needs to send an EAP-Request message to the UE. + +In the case of home routed, the AMF sends Nsmf\_PDUSession\_CreateSMContext Request including the authentication/authorization information to the V-SMF and the V-SMF sends Nsmf\_PDUSession\_Create Request including the authentication/authorization information to the H-SMF. + +3. If the N4 session has not been established before, the SMF triggers the N4 Session Establishment procedure to the UPF. + +In the case of home routed, the V-SMF triggers the N4 Session Establishment procedure to the V-UPF and the H-SMF triggers the N4 Session Establishment procedure to the H-UPF. + +4. The SMF sends the DER message to the DN-AAA via the UPF, the message is forwarded from the SMF to the DN-AAA by the UPF in N4 user plane message. + +In the case of home routed, the H-SMF sends the DER message to the DN-AAA via the H-UPF, the message is forwarded from the H-SMF to the DN-AAA by the H-UPF in N4 user plane message. + +- 5-10. The DN-AAA responds with the DEA message to the SMF via the UPF, the message is forwarded from the DN-AAA to the SMF by the UPF in N4 user plane message. The authentication/authorization information is further transferred to UE via Namf\_Communication\_N1N2MessageTransfer service and NAS SM Transport message. UE responds to the received authentication/authorization data and such information is transferred in NAS SM Transport message and Nsmf\_PDUSession\_UpdateSMContext service, then finally sent to the DN-AAA by the SMF, via the UPF, in the DER message. + +In the case of home routed, the DN-AAA responds with the DEA message to the H-SMF via the H-UPF, the message is forwarded from the DN-AAA to the H-SMF by the H-UPF in N4 user plane message. The authentication/authorization information is transferred to V-SMF via Nsmf\_PDUSession\_Update service and is further transferred to UE via Namf\_Communication\_N1N2MessageTransfer service and NAS SM Transport message. UE responds to the received authentication/authorization data and such information is transferred in NAS SM Transport message, Nsmf\_PDUSession\_UpdateSMContext service and Nsmf\_PDUSession\_Update service, then finally sent to the DN-AAA by the H-SMF, via the H-UPF, in the DER message. + +NOTE: Step 5 to step 10 can be repeated depending on the authentication/authorization mechanism used (e.g. EAP-TLS). + +11. The SMF receives final result of authentication/authorization from the DN-AAA in the DEA message, via the UPF. +12. The SMF requests to start accounting by sending the Accounting-Request (START) message to the DN-AAA via the UPF. +13. The SMF proceeds with the PDU session establishment procedure and includes the authentication/authorization information in Namf\_Communication\_N1N2MessageTransfer service. + +In the case of home routed, the H-SMF proceeds with the PDU session establishment procedure and includes the authentication/authorization information is transferred to V-SMF via Nsmf\_PDUSession\_Update service and is further transferred to the AMF via Namf\_Communication\_N1N2MessageTransfer service. + +14. The DN-AAA responds with the Accounting-Response (START) message. The SMF may wait for the Accounting-Response (START) before sending the Namf\_Communication\_N1N2MessageTransfer request in step 13. + +In the case of home routed, the H-SMF may wait for the Accounting-Response (START) before sending the Nsmf\_PDUSession\_Update service in step 13. + +15. The AMF sends the NAS PDU Session Establishment Request with the authentication/authorization information to the UE. + +16. The UE sends a NAS message Deregistration Request to the AMF. + +17. The AMF sends Nsmf\_PDUSession\_ReleaseSMContext Request to the SMF and the SMF responds to the service operation. + +In the case of home routed, the AMF sends Nsmf\_PDUSession\_ReleaseSMContext Request to the V-SMF and the V-SMF sends the Nsmf\_PDUSession\_Release Request to the H-SMF. + +18-19. The SMF requests to stop accounting by sending the Accounting-Request (STOP) message to the DN-AAA via the UPF and the DN-AAA responds with the Accounting-Response (STOP) message. + +![Sequence diagram illustrating Diameter Authentication and Accounting example (successful case) between UE, AMF, SMF, UPF, and DN-AAA.](e90b25c8d90cadc3f76c376701cf27ed_img.jpg) + +``` + +sequenceDiagram + participant UE + participant AMF + participant SMF + participant UPF + participant DN-AAA + + Note left of UE: 1. NAS PDU Session Establishment Request (Authentication message) + UE->>AMF: 1. NAS PDU Session Establishment Request (Authentication message) + AMF->>SMF: 2. Nsmf_PDUSession_Create SMContext (Authentication message) + SMF->>UPF: 3. N4 Session Establishment + SMF-->>DN-AAA: 4. DER + DN-AAA-->>SMF: 5. DEA + Note left of UE: 7. NAS SM Transport (Authentication message) + UE->>AMF: 7. NAS SM Transport (Authentication message) + AMF->>SMF: 6. Namf_Communication_N1 N2MessageTransfer (Authentication message) + Note left of UE: 8. NAS SM Transport (Authentication message) + UE->>AMF: 8. NAS SM Transport (Authentication message) + AMF->>SMF: 9. Nsmf_PDUSession_Update SMContext (Authentication message) + SMF->>DN-AAA: 10. DER + DN-AAA-->>SMF: 11. DEA + SMF->>DN-AAA: 12. Accounting-Request (START) + DN-AAA-->>SMF: 14. Accounting-Response (START) + Note left of UE: 15. NAS PDU Session Establishment Accept (Authentication message) + UE->>AMF: 15. NAS PDU Session Establishment Accept (Authentication message) + AMF->>SMF: 13. Namf_Communication_N1 N2MessageTransfer (Authentication message) + Note right of SMF: User data + SMF->>DN-AAA: User data + Note left of UE: 16. NAS Deregistration Request + UE->>AMF: 16. NAS Deregistration Request + AMF->>SMF: 17. Nsmf_PDUSession_ReleaseSMContext + SMF->>DN-AAA: 18. Accounting-Request (STOP) + DN-AAA-->>SMF: 19. Accounting-Response (STOP) + +``` + +Sequence diagram illustrating Diameter Authentication and Accounting example (successful case) between UE, AMF, SMF, UPF, and DN-AAA. + +Figure 12.2.1-1: Diameter Authentication and Accounting example (successful case) + +When PAP/CHAP is used as the authentication protocol with the external DN-AAA server which does not support EAP for the 5GS, the Diameter Authentication procedures refer to the non transparent access procedures in clause 11.2.1 and related Diameter Authentication descriptions in clause 16a.3a.1 in 3GPP TS 29.061 [5] are reused with the following differences: + +- the SMF performs the actions specified for the P-GW; +- the external DN-AAA server performs the actions specified for AAA; +- PDU Session Establishment request is sent from the UE to the SMF instead of or the Activate PDN connection request being sent from the UE to the S-GW and the Create Session request being sent from S-GW to P-GW; +- PDU Session Establishment accept is sent from the SMF to the UE instead of the Create Session Response message being sent from the P-GW to S-GW and the Activate PDN Connection Accept being sent from S-GW to the UE; and + +- PDU Session Establishment reject is sent from the SMF to the UE instead of the Create Session Response message being sent from the P-GW to the S-GW and the Activate PDN Connection Reject being sent from S-GW to the UE. + +#### 12.2.1a Authentication and Authorization procedures in EPC Interworking + +When an SMF+PGW-C receives a Create Session Request message for a given DNN from the MME, the SMF+PGW-C may (depending on the configuration for this DNN) send a Diameter DER message to a DN-AAA server. Upon receipt of the DER message, the DN-AAA server shall respond with an Diameter DEA message. Multi-round authentication using the DEA (with Result-Code set to DIAMETER\_MULTI\_ROUND\_AUTH) and DER messages may be used. The DN-AAA server finally authenticates and authorizes the user by replying with a DEA message with Result-Code set to DIAMETER\_SUCCESS. If the DN-AAA server is also responsible for IPv4 address and/or IPv6 prefix allocation, the DN-AAA server shall return the allocated IPv4 address and/or IPv6 prefix in the DEA message. + +For re-authentication and re-authorization, the SMF+PGW-C shall send a Diameter DER message and the DN-AAA shall respond with an DEA message. Multi-round authentication using the DEA (with Result-Code set to DIAMETER\_MULTI\_ROUND\_AUTH) and DER messages may be used. The DN-AAA server finally authenticates and authorizes the user by replying with an DEA message with Result-Code set to DIAMETER\_SUCCESS. + +The SMF+PGW-C may initiate Diameter re-authorization procedures for the purpose of IPv4 address and/or IPv6 prefix allocation (or renew the lease). In this case, the SMF+PGW-C shall set the Session-Id to the value used in the initial request, the Auth-Request-Type AVP to "AUTHORIZE\_ONLY" and the 3GPP-Allocate-IP-Type AVP to the type of IP address to be allocated in the AA-Request message sent to the AAA server. If the SMF+PGW-C is using DHCP signalling towards the UE and the DN-AAA server includes the Session-Timeout attribute in the Access-Accept, the SMF+PGW-C may use the Session-Timeout value as the DHCP lease time. The SMF+PGW-C shall not set the DHCP lease time value higher than the Session-Timeout value. The SMF+PGW-C may renew the DHCP lease to the UE without re-authorization towards the DN-AAA server providing that the new lease expiry is no later than the Session-Timeout timer expiry. If the SMF+PGW-C wishes to extend the lease time beyond the current Session-Timeout expiry, it shall initiate a new AAA re-authorization. + +When the SMF+PGW-C receives a message indicating a QoS flow or PDN connection release request, the SMF+PGW-C shall send a Diameter Accounting-Request (STOP) message to the DN-AAA server, which indicates the termination of this particular QoS flow or PDN connection. The SMF+PGW-C shall immediately send the corresponding response to the MME, without waiting for an Accounting-Response (STOP) message from the DN-AAA server. + +The DN-AAA server shall deallocate the IPv4 address and/or IPv6 prefix initially allocated to the subscriber, if there is no session for the subscriber. + +Accounting-Request (ON) and Accounting-Request (OFF) messages may be sent from the SMF+PGW-C to the DN-AAA server to ensure the correct synchronization of the session information in the SMF+PGW-C and the DN-AAA server. + +The SMF+PGW-C may send an Accounting-Request (ON) message to the DN-AAA server to indicate that a restart has occurred. The DN-AAA server may then release the associated resources. + +Prior to a scheduled restart, the SMF+PGW-C may send Accounting-Request (OFF) message to the DN-AAA server. The DN-AAA server may then release the associated resources. + +![Sequence diagram showing RADIUS Authentication and Accounting example (successful case) between UE, MME, SMF+PGW-C, UPF+PGW-U, and DN-AAA.](56a5265d174ce056c1dbe5e7a60839fc_img.jpg) + +``` + +sequenceDiagram + participant UE + participant MME + participant SMF+PGW-C + participant UPF+PGW-U + participant DN-AAA + + Note left of UE: 1.PDN Connectivity Request (PCO: Authentication message) + UE->>MME: 1.PDN Connectivity Request (PCO: Authentication message) + MME->>SMF+PGW-C: 2.Create Session Request (PCO: Authentication message) + SMF+PGW-C->>UPF+PGW-U: 3.N4 Session Establishment (N4 rules: Block User traffic) + Note right of SMF+PGW-C: 4.DER + SMF+PGW-C->>DN-AAA: 4.DER + Note right of SMF+PGW-C: 5.DEA + SMF+PGW-C->>MME: 5.DEA + Note left of MME: 6.Create Session Response (PCO: Uplink Data Not allowed, Authentication message) + MME->>UE: 7.Downlink NAS Transport (PCO: Uplink Data Not allowed, Authentication message) + Note left of UE: 8.Uplink NAS Transport (PCO: Authentication message) + UE->>MME: 8.Uplink NAS Transport (PCO: Authentication message) + MME->>SMF+PGW-C: 9.Modify Bearer Request (PCO: Authentication message) + Note right of SMF+PGW-C: 10.Modify Bearer Response + SMF+PGW-C->>MME: 10.Modify Bearer Response + Note right of SMF+PGW-C: 11.DER + SMF+PGW-C->>DN-AAA: 11.DER + Note left of MME: 13. Update Bearer Request (PCO: Authentication message) + MME->>SMF+PGW-C: 13. Update Bearer Request (PCO: Authentication message) + Note right of SMF+PGW-C: 12.DEA + SMF+PGW-C->>DN-AAA: 12.DEA + Note left of MME: 14.Downlink NAS Transport (PCO: Authentication message) + MME->>UE: 14.Downlink NAS Transport (PCO: Authentication message) + Note left of UE: 15. Uplink NAS Transport (PCO: Authentication message) + UE->>MME: 15. Uplink NAS Transport (PCO: Authentication message) + MME->>SMF+PGW-C: 16. Update Bearer Response (PCO: Authentication message) + Note right of SMF+PGW-C: 17. DER + SMF+PGW-C->>DN-AAA: 17. DER + Note right of SMF+PGW-C: 18. DEA + SMF+PGW-C->>DN-AAA: 18. DEA + Note right of SMF+PGW-C: 19. N4 Session update (N4 rules: Allow User Traffic) + SMF+PGW-C->>UPF+PGW-U: 19. N4 Session update (N4 rules: Allow User Traffic) + Note right of SMF+PGW-C: 20. Accounting-Request (START) + SMF+PGW-C->>DN-AAA: 20. Accounting-Request (START) + Note left of MME: 21. Update Bearer Request (PCO: Uplink Data allowed) + MME->>SMF+PGW-C: 21. Update Bearer Request (PCO: Uplink Data allowed) + Note right of SMF+PGW-C: 22. Accounting-Response (START) + SMF+PGW-C->>DN-AAA: 22. Accounting-Response (START) + Note left of MME: 23. Downlink NAS Transport (Session Management Request) + MME->>UE: 23. Downlink NAS Transport (Session Management Request) + Note left of UE: 24. Uplink NAS Transport (Session Management Response) + UE->>MME: 24. Uplink NAS Transport (Session Management Response) + MME->>SMF+PGW-C: 25. Update Bearer Response + Note right of SMF+PGW-C: User data + SMF+PGW-C->>UPF+PGW-U: User data + Note left of UE: 26.NAS Detach Request + UE->>MME: 26.NAS Detach Request + MME->>SMF+PGW-C: 27.Delete Session Request + Note right of SMF+PGW-C: 28.Accounting-Request (STOP) + SMF+PGW-C->>DN-AAA: 28.Accounting-Request (STOP) + MME->>SMF+PGW-C: 29. Delete Session Response + Note right of SMF+PGW-C: 30.Accounting-Response (STOP) + SMF+PGW-C->>DN-AAA: 30.Accounting-Response (STOP) + +``` + +Sequence diagram showing RADIUS Authentication and Accounting example (successful case) between UE, MME, SMF+PGW-C, UPF+PGW-U, and DN-AAA. + +**Figure 11.2.1a-1: RADIUS Authentication and Accounting example (successful case)** + +The above figure 11.2.1a-1 is an example message flow to show the procedure of RADIUS Authentication and Accounting between an SMF+PGW-C and a DN-AAA server: + +1. UE initiates the PDN Connection Establishment procedure, including authentication/authorization information. +2. The MME sends Create Session Request including the authentication/authorization information to the SMF+PGW-C. + +According to the configuration in the SMF+PGW-C, step 6 to step 10 are executed before step 3 if the SMF+PGW-C needs to send an EAP-Request message to the UE. + +3. If the N4 session has not been established before, the SMF+PGW-C triggers the N4 Session Establishment procedure to the UPF+PGW-U and sets the N4 rules to block any UE traffic over the PDN Connection (until the Secondary DN authentication and authorization has been completed successfully). + +4. The SMF+PGW-C sends the Diameter DER message to the DN-AAA via the UPF+PGW-U in the N4 user plane. + - 5-11. The DN-AAA responds with the Diameter DEA message to the SMF+PGW-C via the UPF+PGW-U in the N4 use plane message. The authentication/authorization information is further transferred to UE via Create Session Response and Downlink NAS Transport message, along with uplink data not allowed indication within the PCO attribute. UE responds to the received authentication/authorization data and such information is transferred in Uplink NAS Transport message and Modify Bearer Request, then finally sent to the DN-AAA by the SMF+PGW-C, via the UPF+PGW-U, in the DER message. + - 12-17. The DN-AAA responds with the DEA message to the SMF+PGW-C via the UPF+PGW-U in the N4 use plane message. The authentication/authorization information is further transferred to UE via Update bearer Response and Downlink NAS Transport message. UE responds to the received authentication/authorization data and such information is transferred in Uplink NAS Transport message and Update Bearer Response, then finally sent to the DN-AAA by the SMF+PGW-C, via the UPF+PGW-U, in the DER message. +- NOTE: Step 12 to step 17 can be repeated depending on the authentication/authorization mechanism used (e.g. EAP-TLS with Result-Code set to DIAMETER\_MULTI\_ROUND\_AUTH in DEA message). +18. The SMF+PGW-C receives the final result of authentication/authorization from the DN-AAA in the DEA with Result-Code set to DIAMETER\_SUCCESS message, via the UPF+PGW-U. + 19. The SMF+PGW-C updates the N4 rules to allow UE traffic over the PDN connection. + 20. The SMF+PGW-C requests to start accounting by sending the Accounting-Request (START) message to the DN-AAA via the UPF+PGW-U. + 21. The SMF+PGW-C proceeds with PDN connection establishment procedure and includes the authentication/authorization information in the Update Bearer Request message with uplink data allowed indication within the PCO attribute, sent to the MME. + 22. The DN-AAA responds with the Accounting-Response (START) message. The SMF+PGW-C may wait for the Accounting-Response (START) before sending the Update Bearer Request in step 21. + 23. The MME sends the Downlink NAS Transport message with Session Management Request with the authentication/authorization information to the UE. + 24. The UE sends a Uplink NAS Transport message with Session Management Response to the MME. + 25. The MME sends Update Bearer Response to the SMF+PGW-C, after which user data is allowed over the PDN connection. + - 26-30. At any point, if the UE triggers Detach procedure and send Detach request to the MME then MME sends Delete Session Request message to the SMF+PGW-C, which responds with Delete Session Response message. The SMF+PGW-C requests to stop accounting by sending the Accounting-Request (STOP) message to the DN-AAA via the UPF+PGW-U and the DN-AAA responds with the Accounting-Response (STOP) message. + +### 12.2.2 Accounting Update + +During the life of a QoS flow some information related to this QoS flow may change. The SMF may send an Accounting Request (Interim) to the DN-AAA server upon occurrence of a chargeable event, e.g. RAT change, DNAI change or QoS change. Interim updates are also used when the IPv4 address and/or IPv6 prefix is allocated/released/re-allocated. + +- NOTE: DNAI change is only applicable when application relocation possible indicated in the AF traffic influenced PCC rule as described in clause 5.6.7 of TS 23.501 [2], align with the DNAI change in UP path management events as described in clause 4.3.6.3 of TS 23.502 [3]. Only the target DNAI is provided in the ACR message. The change from the UP path status where a DNAI applies to a status where no DNAI applies indicating the de-activation of the AF request for AF influence on traffic routing is not supported in this release. + +When the SMF receives a signalling request (i.e. Nsmf\_PDUSession\_UpdateSMContext) that indicates the occurrence of one of these chargeable events, the SMF may send an Accounting Request Interim-Update to the DN-AAA server to update the necessary information related to this QoS flow. It is not necessary for the SMF to wait for the Diameter + +Accounting Answer message from the DN-AAA server before sending the response for the triggering signalling message (i.e. Namf\_Communication\_N1N2MessageTransfer). The SMF may delete the QoS flow if the Accounting Answer is not received from the DN-AAA server. + +The SMF may also send interim updates at the expiry of an operator configured time limit. + +Figure 12.2.2-1 is an example message flow to show the procedure of Diameter accounting update, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram showing the Diameter accounting update procedure between AMF, SMF, UPF, and DN-AAA. The AMF sends an Nsmf_PDUSession_Update SMContext message to the SMF. The SMF then sends an Accounting Request (Interim) to the DN-AAA via the UPF. The DN-AAA responds with an Accounting Answer (Interim) to the SMF via the UPF. Finally, the SMF sends a Namf_Communication_N1N2MessageTransfer message to the AMF.](cc542843836eecb036b99cb270b54a1e_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + Note left of AMF: Nsmf_PDUSession_Update SMContext + AMF->>SMF: Nsmf_PDUSession_Update SMContext + SMF->>DN-AAA: Accounting Request (Interim) + DN-AAA-->>SMF: Accounting Answer (Interim) + SMF->>AMF: Namf_Communication_N1N2MessageTransfer + +``` + +Sequence diagram showing the Diameter accounting update procedure between AMF, SMF, UPF, and DN-AAA. The AMF sends an Nsmf\_PDUSession\_Update SMContext message to the SMF. The SMF then sends an Accounting Request (Interim) to the DN-AAA via the UPF. The DN-AAA responds with an Accounting Answer (Interim) to the SMF via the UPF. Finally, the SMF sends a Namf\_Communication\_N1N2MessageTransfer message to the AMF. + +Figure 12.2.2-1: Diameter accounting update + +For the 5GC and EPC interworking scenario without authentication, authorization, re-authentication and/or re-authorization impacts, if the UE establishes the PDU session through the 5GC and initiates the accounting session, when the SMF+PGW-C determines that the UE has moved to the EPS (i.e. the SMF+PGW-C receives the modify bearer request or create session request from the S-GW), the SMF+PGW-C may perform the accounting session update with the following modifications: + +- for the case that the accounting session is initiated per PDU session, the SMF+PGW-C may update the accounting session by including the identifier of the accounting session within the Session-Id AVP, the "EUTRA" within the 3GPP-RAT-Type AVP, the IPv4 address of S-GW within the 3GPP-SGSN-Address AVP or IPv6 address of S-GW within the 3GPP-SGSN-IPv6-Address AVP, the default EPS bearer id within the 3GPP-NSAPI AVP, the user location in the EPC within the 3GPP-User-Location-Info AVP if available and the new QoS profile within the 3GPP-GPRS-Negotiated-QoS-Profile AVP if changed. +- for the case that the accounting session is initiated per QoS flow: + - if the SMF+PGW-C mapped a QoS flow to an EPS bearer, the SMF may update the accounting session corresponding to the QoS flow with the information of the EPS bearer by including the identifier of the accounting session within the Session-Id AVP, the "EUTRA" within the 3GPP-RAT-Type AVP, the IPv4 address of S-GW within the 3GPP-SGSN-Address AVP or IPv6 address of S-GW within the 3GPP-SGSN-IPv6-Address AVP, the default EPS bearer id within the 3GPP-NSAPI AVP, the user location in the EPC within the 3GPP-User-Location-Info AVP if available and the new QoS profile within the 3GPP-GPRS-Negotiated-QoS-Profile AVP if changed, the new charging id within the 3GPP-Charging-Id AVP or 3GPP-Charging-Id-v2 AVP according to the length of the Charging Id if allocated and the new packet filters within the 3GPP-Packet-Filter AVP if changed; + - if the SMF+PGW-C mapped multiple QoS flows to one EPS bearer, the SMF shall select one of the accounting sessions corresponding to these QoS flows to update it as above and terminate the accounting session(s) corresponding to the other QoS flow(s). + - if the SMF+PGW-C did not map a QoS flow to any EPS bearer, the SMF may decide to associate the corresponding account session to the default EPS bearer or terminate the corresponding accounting session. + +### 12.2.3 DN-AAA initiated QoS flow termination + +Diameter is used as the protocol between the SMF and the DN-AAA server or proxy for applications (e.g. MMS) to deliver information related to user session. However some IP applications could need to interwork with the SMF to release the corresponding resource (e.g. terminate a particular QoS flow). For this purpose, the DN-AAA server or + +proxy may send a Diameter ASR along with the QoS flow Identifier in 3GPP-NSAPI, if available, to identify the particular QoS flow to be terminated to the SMF. The SMF should react by deleting the corresponding QoS flow and reply with ASA. If the SMF deletes the corresponding QoS flow, it is not necessary for the SMF to wait for the response (i.e. Nsmf\_PDUSession\_UpdateSMContext) from the AMF before sending the ASA to the DN-AAA server. + +The absence of the QoS flow Identifier in the Diameter ASR message indicates to the SMF that all QoS flows for this particular user and sharing the same user session shall be deleted. The QoS flows belonging to the same PDU session are identified by the Diameter Session-Id. If a user has the same user IP address for different sets of QoS flows towards different networks, only the QoS flows linked to the one identified by the Diameter Session-Id shall be deleted. + +Figure 12.2.3-1 is an example message flow to show the procedure of DN-AAA initiated QoS flow termination, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram showing DN-AAA initiated QoS flow termination. The diagram involves four entities: AMF, SMF, UPF, and DN-AAA. The sequence of messages is: 1. DN-AAA sends a Diameter ASR to the SMF (via the UPF). 2. The SMF sends a Nsmf_PDUSession_UpdateSMContext message to the AMF. 3. The AMF responds with a Namf_Communication_N1N2MessageTransfer to the SMF. 4. The SMF then sends a Diameter ASA back to the DN-AAA (via the UPF).](91134b9a38d7f73f03375473e7b706f9_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + Note right of DN-AAA: Diameter ASR + DN-AAA->>SMF: Diameter ASR (via UPF) + SMF->>AMF: Nsmf_PDUSession_UpdateSMContext + AMF-->>SMF: Namf_Communication_N1N2MessageTransfer + Note right of SMF: Diameter ASA + SMF->>DN-AAA: Diameter ASA (via UPF) + +``` + +Sequence diagram showing DN-AAA initiated QoS flow termination. The diagram involves four entities: AMF, SMF, UPF, and DN-AAA. The sequence of messages is: 1. DN-AAA sends a Diameter ASR to the SMF (via the UPF). 2. The SMF sends a Nsmf\_PDUSession\_UpdateSMContext message to the AMF. 3. The AMF responds with a Namf\_Communication\_N1N2MessageTransfer to the SMF. 4. The SMF then sends a Diameter ASA back to the DN-AAA (via the UPF). + +**Figure 12.2.3-1: DN-AAA initiated QoS flow termination with Diameter** + +For the 5GC and EPC interworking scenario, when the DN-AAA initiates the QoS flow termination, the SMF+PGW-C shall send the delete bearer request to the S-GW as defined in clause 5.4.4.1 of 3GPP TS 23.401 [53] to delete the EPS bearer corresponding to the if the UE has moved to the EPS. + +### 12.2.4 DN-AAA initiated re-authorization in 5GC + +Some IP applications could need to interwork with the SMF to update the PDU session authorization attributes. For this purpose, the DN-AAA server or proxy may send a Diameter RAR with Re-Auth-Request-Type value "AUTHORIZE\_ONLY" to the SMF. On receipt of the RAR from the DN-AAA server, the SMF shall update the corresponding PDU session authorization attributes and reply with RAA. DN-AAA may also use such procedure to revoke the authorization of a PDU session, or to update the authorization data (e.g. allowed UE MAC addresses). + +If the SMF updates/deletes the corresponding PDU session, it is not necessary for the SMF to wait for Nsmf\_PDUSession\_UpdateSMContext from the AMF before sending the RAA to the DN-AAA server. + +Figure 12.2.4-1 is an example message flow to show the procedure of DN-AAA initiated re-authorization, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +![Sequence diagram for DN-AAA initiated re-authorization with Diameter in 5GC. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with a Diameter RAR from DN-AAA to SMF. SMF then sends an Nsmf_PDUSession_Update SMContext message to AMF. AMF responds with a Namf_Communication_N1 N2MessageTransfer to SMF. SMF then sends a Diameter RAA back to DN-AAA.](fcc757566216206ceddbd6c775e8db02_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + Note right of DN-AAA: Diameter RAR + DN-AAA->>SMF: Diameter RAR + Note right of SMF: Nsmf_PDUSession_Update SMContext + SMF->>AMF: Nsmf_PDUSession_Update SMContext + Note right of AMF: Namf_Communication_N1 N2MessageTransfer + AMF->>SMF: Namf_Communication_N1 N2MessageTransfer + Note right of SMF: Diameter RAA + SMF->>DN-AAA: Diameter RAA + +``` + +Sequence diagram for DN-AAA initiated re-authorization with Diameter in 5GC. Lifelines: AMF, SMF, UPF, DN-AAA. The sequence starts with a Diameter RAR from DN-AAA to SMF. SMF then sends an Nsmf\_PDUSession\_Update SMContext message to AMF. AMF responds with a Namf\_Communication\_N1 N2MessageTransfer to SMF. SMF then sends a Diameter RAA back to DN-AAA. + +**Figure 12.2.4-1: DN-AAA initiated re-authorization with Diameter** + +NOTE: The DN-AAA initiated re-authorization procedure is not applicable for legacy DN-AAA supporting the Diameter procedures over SGi interface as specified in 3GPP TS 29.061 [5]. + +#### 12.2.4a DN-AAA initiated re-authorization in EPC Interworking + +Some IP applications could need to interwork with the SMF+PGW-C to update the PDD connection authorization attributes. For this purpose, the DN-AAA server or proxy may send a Diameter RAR with Re-Auth-Request-Type value "AUTHORIZE\_ONLY" to the SMF+PGW-C. On receipt of the RAR from the DN-AAA server, the SMF+PGW-C shall update the corresponding PDN connection authorization attributes and reply with RAA. DN-AAA may also use such procedure to revoke the authorization of a PDN connection, or to update the authorization data (e.g. allowed UE MAC addresses). + +If the SMF+PGW-C updates/deletes the corresponding PDN connection, it is not necessary for the SMF+PGW-C to wait for Update Bearer Response from the MME before sending the RAA to the DN-AAA server. + +Figure 12.2.4-1 is an example message flow to show the procedure of DN-AAA initiated re-authorization, messages between the SMF+PGW-C and DN-AAA are forwarded by the UPF+PGW-U in N4 user plane message. + +![Sequence diagram for DN-AAA initiated re-authorization with Diameter in EPC Interworking. Lifelines: MME, SMF+PGW-C, UPF+PGW-U, DN-AAA. The sequence starts with a Diameter RAR from DN-AAA to SMF+PGW-C. SMF+PGW-C sends an Update Bearer Request (PCO, Authentication message) to MME. MME responds with an Update Bearer Response (PCO, Authentication message) to SMF+PGW-C. SMF+PGW-C then sends a Diameter RAA back to DN-AAA.](b996d5a6408db9c4b3ac3aafd2ef44cf_img.jpg) + +``` + +sequenceDiagram + participant MME + participant SMF+PGW-C + participant UPF+PGW-U + participant DN-AAA + Note right of DN-AAA: Diameter RAR + DN-AAA->>SMF+PGW-C: Diameter RAR + Note right of SMF+PGW-C: Update Bearer Request (PCO, Authentication message) + SMF+PGW-C->>MME: Update Bearer Request (PCO, Authentication message) + Note right of MME: Update Bearer Response (PCO, Authentication message) + MME->>SMF+PGW-C: Update Bearer Response (PCO, Authentication message) + Note right of SMF+PGW-C: Diameter RAA + SMF+PGW-C->>DN-AAA: Diameter RAA + +``` + +Sequence diagram for DN-AAA initiated re-authorization with Diameter in EPC Interworking. Lifelines: MME, SMF+PGW-C, UPF+PGW-U, DN-AAA. The sequence starts with a Diameter RAR from DN-AAA to SMF+PGW-C. SMF+PGW-C sends an Update Bearer Request (PCO, Authentication message) to MME. MME responds with an Update Bearer Response (PCO, Authentication message) to SMF+PGW-C. SMF+PGW-C then sends a Diameter RAA back to DN-AAA. + +**Figure 12.2.4a-1: DN-AAA initiated re-authorization with Diameter** + +NOTE: The DN-AAA initiated re-authorization procedure is not applicable for legacy DN-AAA supporting the Diameter procedures over SGi interface as specified in 3GPP TS 29.061 [5]. + +### 12.2.5 DN-AAA initiated re-authentication and re-authorization in 5GC + +Some IP applications could need to interwork with the SMF to request re-authentication and re-authorization for the PDU session. For this purpose, the DN-AAA server or proxy may send a Diameter RAR with Re-Auth-Request-Type value "AUTHORIZE\_AUTHENTICATE" to the SMF. The RAR should not include any authorization attribute. + +NOTE: Since the SMF will initiate authentication procedure upon receipt of the RAR and in the end the DN-AAA will authorize the session, the DN-AAA does not have to apply authorization change immediately. + +On receipt of the RAR from the DN-AAA server, the SMF shall reply with RAA and start authentication and authorization procedure as described in figure 12.2.1-1, from step 4 to step 11, step 13 and with PDU SESSION AUTHENTICATION RESULT message (successful case) sent from the AMF to the UE. The Auth-Request-Type in the DER is set to "AUTHORIZE\_AUTHENTICATE". + +Figure 12.2.5-1 is an example message flow to show the procedure of DN-AAA initiated re-authentication and re-authorization, messages between the SMF and DN-AAA are forwarded by the UPF in N4 user plane message. + +Based on the result from the SMF, the DN-AAA server may decide to keep the PDU session or request to release the PDU session. + +NOTE: As an implementation option, when the UE becomes unreachable, the SMF can mark the re-authentication result as pending and initiate re-authentication at the next uplink activity. + +When the SMF receives a re-authentication request from the DN-AAA server, the SMF shall inform the DN-AAA server that the re-authentication is not possible with error code 3002 and optionally the "NR" within the 3GPP-RAT-Type to indicated the UE is in 5GS not reachable for re-authentication. The SMF should not initiate PDU session release. + +![Sequence diagram showing DN-AAA initiated re-authentication and re-authorization with Diameter. The diagram shows four lifelines: AMF, SMF, UPF, and DN-AAA. The sequence starts with a Diameter RAR message from DN-AAA to SMF. The SMF then sends a Diameter RAA message back to DN-AAA. Below these messages, a horizontal bar labeled 'SMF initiated authentication and authorization' spans across the SMF and UPF lifelines.](0ea87c5f55e5857d0969bc5ca36dccba_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant SMF + participant UPF + participant DN-AAA + Note right of DN-AAA: DN-AAA initiated re-authentication and re-authorization + DN-AAA->>SMF: Diameter RAR + SMF-->>DN-AAA: Diameter RAA + Note over SMF,UPF: SMF initiated authentication and authorization + +``` + +Sequence diagram showing DN-AAA initiated re-authentication and re-authorization with Diameter. The diagram shows four lifelines: AMF, SMF, UPF, and DN-AAA. The sequence starts with a Diameter RAR message from DN-AAA to SMF. The SMF then sends a Diameter RAA message back to DN-AAA. Below these messages, a horizontal bar labeled 'SMF initiated authentication and authorization' spans across the SMF and UPF lifelines. + +Figure 12.2.5-1: DN-AAA initiated re-authentication and re-authorization with Diameter + +When PAP/CHAP is used as the authentication protocol with the external DN-AAA server which does not support EAP, the Diameter DN-AAA initiated re-authentication and re-authorization procedures are not applicable. + +#### 12.2.5a DN-AAA initiated re-authentication and re-authorization in EPC Interworking + +Some IP applications could need to interwork with the SMF+PGW-C to request re-authentication and re-authorization for the PDN connection. For this purpose, the DN-AAA server or proxy may send a Diameter RAR with Re-Auth-Request-Type value "AUTHORIZE\_AUTHENTICATE" to the SMF+PGW-C. The RAR should not include any authorization attribute. + +NOTE: Since the SMF+PGW-C will initiate authentication procedure upon receipt of the RAR and in the end the DN-AAA will authorize the session, the DN-AAA does not have to apply authorization change immediately. + +On receipt of the RAR from the DN-AAA server, the SMF shall reply with RAA and start authentication and authorization procedure as described in figure 12.2.1a-1, from step 11 to step 18. The Auth-Request-Type in the DER is set to "AUTHORIZE\_AUTHENTICATE". + +Figure 12.2.5-1 is an example message flow to show the procedure of DN-AAA initiated re-authentication and re-authorization, messages between the SMF+PGW-C and DN-AAA are forwarded by the UPF+PGW-U in N4 user plane message. + +When the SMF+PGW-C receives a re-authentication request from the DN-AAA server, the SMF+PGW-C shall inform the DN-AAA server that the re-authentication is not supported with error code 3002 and optionally the "EUTRA" within the 3GPP-RAT-Type to indicated the UE is in EPS not available for re-authentication. The SMF+PGW-C should not initiate PDN connection release. Based on the result from the SMF+PGW-C, the DN-AAA server may decide to keep the PDN connection or request to release the PDN connection. + +NOTE: As an implementation option, when the UE becomes unreachable, the SMF+PGW-C can mark the re-authentication result as pending and initiate re-authentication at the next uplink activity. + +![Sequence diagram for DN-AAA initiated re-authentication and re-authorization with Diameter. The diagram shows four lifelines: MME, SMF+PGW-C, UPF+PGW-C, and DN-AAA. The SMF+PGW-C initiates authentication and authorization. The DN-AAA sends a Diameter RAR to the SMF+PGW-C, which then sends a Diameter RAA back to the DN-AAA.](bfca6639dd4b8480f2d96d2b61c806d9_img.jpg) + +``` +sequenceDiagram + participant MME + participant SMF+PGW-C + participant UPF+PGW-C + participant DN-AAA + Note over MME, UPF+PGW-C: SMF+PGW-C initiated authentication and authorization + DN-AAA->>SMF+PGW-C: Diameter RAR + SMF+PGW-C->>DN-AAA: Diameter RAA +``` + +Sequence diagram for DN-AAA initiated re-authentication and re-authorization with Diameter. The diagram shows four lifelines: MME, SMF+PGW-C, UPF+PGW-C, and DN-AAA. The SMF+PGW-C initiates authentication and authorization. The DN-AAA sends a Diameter RAR to the SMF+PGW-C, which then sends a Diameter RAA back to the DN-AAA. + +**Figure 12.2.5a-1: DN-AAA initiated re-authentication and re-authorization with Diameter** + +When PAP/CHAP is used as the authentication protocol with the external DN-AAA server which does not support EAP, the Diameter DN-AAA initiated re-authentication and re-authorization procedures are not applicable. + +## 12.3 N6 specific AVPs + +There is no specific AVP defined in the present release. + +## 12.4 N6 re-used AVPs + +### 12.4.0 General + +Table 12.4-1 lists the Diameter AVPs re-used by the N6 reference point from existing Diameter Applications, reference to the respective specifications and a short description of the usage within the N6 reference point. + +**Table 12.4-1: N6 re-used Diameter AVPs** + +| Attribute Name | AVP Code | Section defined | Value Type (NOTE 2) | AVP Flag rules (NOTE 1) | | | | May Encr. | Appli cabili ty | +|----------------------------------|----------|-----------------------------|---------------------|-------------------------|-----|------------|----------|-----------|-----------------| +| | | | | Must | May | Should not | Must not | | | +| 3GPP-IMSI | 1 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-Charging-Id | 2 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-PDP-Type | 3 | 3GPP TS 29.061 [5] (NOTE 3) | Enumerated | V | P | | M | Y | | +| 3GPP-CG-Address | 4 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-GPRS-Negotiated-QoS-Profile | 5 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-SGSN-Address | 6 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-GGSN-Address | 7 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-IMSI-MCC-MNC | 8 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-GGSN-MCC-MNC | 9 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-NSAPI | 10 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Selection-Mode | 12 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-Charging-Characteristics | 13 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-CG-IPv6-Address | 14 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-SGSN-IPv6-Address | 15 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-GGSN-IPv6-Address | 16 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-IPv6-DNS-Servers | 17 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-SGSN-MCC-MNC | 18 | 3GPP TS 29.061 [5] (NOTE 3) | UTF8String | V | P | | M | Y | | +| 3GPP-IMEISV | 20 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-RAT-Type | 21 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-User-Location-Info | 22 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-MS-TimeZone | 23 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Packet-Filter | 25 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Negotiated-DSCP | 26 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Allocate-IP-Type | 27 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| External-Identifier | 28 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| TWAN-Identifier | 29 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-User-Location-Info-Time | 30 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Secondary-RAT-Usage | 31 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-UE-Local-IP-Address | 32 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-UE-Source-Port | 33 | 3GPP TS 29.061 [5] (NOTE 3) | OctetString | V | P | | M | Y | | +| 3GPP-Notification | 110 | 11.3.1 | OctetString | V | P | | M | Y | | + +| | | | | | | | | | | +|------------------------------|-----|---------------------|-------------|---|---|--|---|---|--------------| +| 3GPP-UE-MAC-Address | 111 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-Authorization-Reference | 112 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-Policy-Reference | 113 | 11.3.1 | OctetString | V | P | | M | Y | NOTE 4 | +| 3GPP-Session-AMBR | 114 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-NAI | 115 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-Session-AMBR-v2 | 116 | 11.3.1 | OctetString | V | P | | M | Y | eSessionAMBR | +| 3GPP-IP-Address-Pool-Info | 118 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-VLAN-Id | 119 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-TNAP-Identifier | 120 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-HFC-NodeId | 121 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-GLI | 122 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-Line-Type | 123 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-NID | 124 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-Session-S-NSSAI | 125 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-CHF-FQDN | 126 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-Serving-NF-FQDN | 127 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-Session-Id | 128 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-GCI | 129 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-DNAI | 130 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-RSN | 131 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-Session-Pair-Id | 132 | 11.3.1 | OctetString | V | P | | M | Y | | +| 3GPP-Charging-Id-v2 | 133 | 11.3.1 | OctetString | V | P | | M | Y | | +| Supported-Features | 628 | 3GPP TS 29.229 [41] | Grouped | V | M | | | N | | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [24]. + +NOTE 2: The value types are defined in IETF RFC 6733 [24]. + +NOTE 3: The use of Radius VSA as a Diameter vendor AVP is described in Diameter NASREQ (IETF RFC 7155 [23]) and the P flag may be set. + +NOTE 4: It is not used in this release. + +NOTE 1: Attribute 3GPP-CAMEL-Charging-Info (24) is not applicable for 5G in the present specification. + +NOTE 2: Table 11.3-2 lists the differences between the RADIUS VSAs used in 5G and the VSAs defined in clause 16.4.7 of 3GPP TS 29.061 [5]. + +### 12.4.1 Use of the Supported-Features AVP on the N6 reference point + +The Supported-Features AVP is used during session establishment to inform the destination host about the required and optional features that the origin host supports. The client shall, in the first request in a Diameter session indicate the set of supported features. The server shall, in the first answer within the Diameter session indicate the set of features that it has in common with the client and that the server shall support within the same Diameter session. Any further command messages shall always be compliant with the list of supported features indicated in the Supported-Features AVPs during session establishment. Features that are not advertised as supported shall not be used to construct the command messages for that Diameter session. Unless otherwise stated, the use of the Supported-Features AVP on the N6 reference point shall be compliant with the requirements for dynamic discovery of supported features and associated error handling on the Cx reference point as defined in clause 7.2.1 of 3GPP TS 29.229 [41]. + +The base functionality for the N6 reference point is the 3GPP Rel-15 standard and a feature is an extension to that functionality. If the origin host does not support any features beyond the base functionality, the Supported-Features AVP may be absent from the N6 commands. As defined in clause 7.1.1 of 3GPP TS 29.229 [41], when extending the + +application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [41], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the N6 reference point, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the N6 reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +On receiving an initial request application message, the destination host shall act as defined in clause 7.2.1 of 3GPP TS 29.229 [41]. + +Once the SMF and DN-AAA have negotiated the set of supported features during session establishment, the set of common features shall be used during the lifetime of the Diameter session. + +The table below defines the features applicable to the N6 interfaces for the feature lists with a Feature-List-ID of 1. + +**Table 12.4.1-1: Features of Feature-List-ID 1 used in N6** + +| Feature bit | Feature | M/O | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | eSessionAMBR | M | This feature indicates the support of enhanced Session AMBR function. If supported, the DN-AAA authorizes DL and/or UL Session AMBR separately. | +| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "5GC".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release.
Description: A clear textual description of the feature. | | | | + +## 12.5 N6 specific Experimental-Result-Code AVP + +Diameter Base IETF RFC 6733 [24] defines a number of Result-Code AVP values that are used to report protocol errors and how those are used. Those procedures and values apply for the present specification. + +Due to the N6 specific AVPs, new application results can occur and the Experimental-Result AVP is used to transfer the 3GPP-specific result codes. The Experimental-Result AVP is a grouped AVP containing the Vendor-Id AVP set to the value of 3GPP's vendor identifier (10415) and an Experimental-Result-Code AVP. + +The following N6 specific Experimental-Result-Code value is defined: + +DIAMETER\_QOS\_FLOW\_DELETION\_INDICATION (2421) + +For SMF this is an indication to the server that the requested 5G QoS flow or PDU session has been deleted. + +## 12.6 N6 Diameter messages + +### 12.6.1 General + +This clause describes the N6 Diameter messages. + +The relevant AVPs that are of use for the N6 interface are detailed in this clause. Other Diameter AVPs as defined in IETF RFC 4072 [25] and IETF RFC 7155 [23], even if their AVP flag rules are marked with "M", are not required for being compliant with the current specification. + +Diameter messages as defined in clause 16a.4 of 3GPP TS 29.061 [5] are re-used in 5G with the following differences: + +- SMF or SMF+PGW-C replaces P-GW, and GGSN related description are not applicable for 5G. +- 5G QoS flow replaces IP-CAN/EPS bearer and PDU session replaces IP-CAN session. +- N6 replaces Gi/Sgi. + +NOTE: N6 re-used and specific AVPs are specified in clause 12.3 and clause 12.4. + +- 3GPP-NAI AVP may be included in the AAR and ACR command. +- 3GPP-NID AVP may be included together with 3GPP-SGSN-MCC-MNC AVP in the AAR and ACR command. +- 3GPP-Session-S-NSSAI AVP and/or 3GPP-Session-Id AVP may be included in the AAR and ACR command. +- 3GPP-DNAI AVP, 3GPP-RSN AVP and/or 3GPP-Session-Pair-Id AVP may be included in the ACR command. +- Multiple 3GPP-IP-Address-Pool-Info AVPs may be included in the AAR command and one or two 3GPP-IP-Address-Pool-Info AVPs may be included in the AAA and ACR command. +- Multiple 3GPP-UE-MAC-Address AVPs may be included in the AAR and ACR command. +- For indicating user location, TWAN-Identifier AVP, 3GPP-TNAP-Identifier AVP, 3GPP-HFC-NodeId AVP, 3GPP-GLI AVP, 3GPP-Line-Type AVP, 3GPP-UE-Local-IP-Address and optionally UDP or TCP source port number (if NAT is detected) may be included in the AAR and ACR command. +- Acct-Application-Id AVP shall be included in the ACR and ACA command as specified in IETF RFC 7155 [23]. +- Additional Diameter messages needed for 5G compared to the 3GPP TS 29.061 [5] are described in the following clauses. +- Multiple Supported-Features AVPs may be included in the ACR and ACA command. + +### 12.6.2 DER Command + +The DER command, defined in IETF RFC 4072 [25], is indicated by the Command-Code field set to 268 and the 'R' bit set in the Command Flags field. It is sent by the SMF to the DN-AAA server upon reception of an initial access request (e.g. Nsmf\_PDUSession\_CreateSMContext) message for a given DNN to request user authentication and authorization. + +The relevant AVPs that are of use for the N6 interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for N6 purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for N6, or modified existing AVPs. + +Message Format: + +``` + ::= < Diameter Header: 268, REQ, PXY > + < Session-Id > + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + [ Destination-Host ] + [ NAS-Port ] + [ NAS-Port-Id ] + [ NAS-Port-Type ] + [ Origin-State-Id ] + [ Port-Limit ] + [ User-Name ] + { EAP-Payload } + [ EAP-Key-Name ] + [ Service-Type ] + [ Authorization-Lifetime ] + [ Auth-Grace-Period ] + [ Auth-Session-State ] + [ Callback-Number ] + [ Called-Station-Id ] + [ Calling-Station-Id ] + [ Originating-Line-Info ] + [ Connect-Info ] + * [ Framed-Compression ] + [ Framed-Interface-Id ] + [ Framed-IP-Address ] + * [ Framed-IPv6-Prefix ] + * [ Delegated-IPv6-Prefix ] + [ Framed-IP-Netmask ] +``` + +``` + +[ Framed-MTU ] +[ Framed-Protocol ] +* [ Tunneling ] +* [ Proxy-Info ] +* [ Route-Record ] +[ External-Identifier ] +[ 3GPP-IMSI ] +[ 3GPP-NAI ] +* [ 3GPP-UE-MAC-Address ] +[ 3GPP-Charging-ID ] +[ 3GPP-Charging-ID-v2 ] +[ 3GPP-PDP-Type ] +[ 3GPP-CG-Address ] +[ 3GPP-CHF-FQDN ] +[ 3GPP-GPRS-Negotiated-QoS-Profile ] +[ 3GPP-SGSN-Address ] +[ 3GPP-GGSN-Address ] +[ 3GPP-Session-S-NSSAI ] +[ 3GPP-Session-Id ] +[ 3GPP-IMSI-MCC-MNC ] +[ 3GPP-GGSN-MCC-MNC ] +[ 3GPP-NSAPI ] +[ 3GPP-Selection-Mode ] +[ 3GPP-Charging-Characteristics ] +[ 3GPP-CG-IPv6-Address ] +[ 3GPP-SGSN-IPv6-Address ] +[ 3GPP-Serving-NF-FQDN ] +[ 3GPP-GGSN-IPv6-Address ] +[ 3GPP-SGSN-MCC-MNC ] +[ 3GPP-NID ] +[ 3GPP-User-Location-Info ] +[ 3GPP-RAT-Type ] +[ 3GPP-Negotiated-DSCP ] +[ 3GPP-Allocate-IP-Type ] +[ TWAN-Identifier ] +[ 3GPP-TNAP-Identifier ] +[ 3GPP-HFC-NodeId ] +[ 3GPP-GCI ] +[ 3GPP-GLI ] +[ 3GPP-Line-Type ] +[ 3GPP-UE-Local-IP-Address ] +[ 3GPP-UE-Source-Port ] +* [ 3GPP-IP-Address-Pool-Info ] +* [ Supported-Features ] +* [ AVP ] + +``` + +### 12.6.3 DEA Command + +The DEA command, defined in IETF RFC 4072 [25], is indicated by the Command-Code field set to 268 and the 'R' bit cleared in the Command Flags field. It is sent by the DN-AAA server to the SMF in response to the DER command. + +The relevant AVPs that are of use for the N6 interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for N6 purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for N6, or modified existing AVPs. + +Message Format: + +``` + + ::= < Diameter Header: 268, PXY > + < Session-Id > + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + [ EAP-Payload ] + [ EAP-Reissued-Payload ] + [ EAP-Master-Session-Key ] + [ EAP-Key-Name ] + [ Multi-Round-Time-Out ] + [ Accounting-EAP-Auth-Method ] + [ Service-Type ] + * [ Class ] + [ Acct-Interim-Interval ] + +``` + +``` + +[ Error-Message ] +[ Error-Reporting-Host ] +[ Failed-AVP ] +[ Idle-Timeout ] +[ Authorization-Lifetime ] +[ Auth-Grace-Period ] +[ Auth-Session-State ] +[ Re-Auth-Request-Type ] +[ Session-Timeout ] +* [ Reply-Message ] +[ Origin-State-Id ] +* [ Filter-Id ] +[ Port-Limit ] +[ Callback-Id ] +[ Callback-Number ] +* [ Framed-Compression ] +[ Framed-Interface-Id ] +[ Framed-IP-Address ] +* [ Framed-IPv6-Prefix ] +[ Framed-IPv6-Pool ] +* [ Framed-IPv6-Route ] +* [ Delegated-IPv6-Prefix ] +[ Framed-IP-Netmask ] +* [ Framed-Route ] +[ Framed-Pool ] +[ Framed-IPX-Network ] +[ Framed-MTU ] +[ Framed-Protocol ] +[ Framed-Routing ] +* [ NAS-Filter-Rule ] +* [ QoS-Filter-Rule ] +* [ Tunneling ] +* [ Redirect-Host ] +[ Redirect-Host-Usage ] +[ Redirect-Max-Cache-Time ] +* [ Proxy-Info ] +* [ External-Identifier ] +[ 3GPP-IPv6-DNS-Servers ] +[ 3GPP-Notification ] +0*16 [ 3GPP-UE-MAC-Address ] +0*16 [ 3GPP-VLAN-Id ] +[ 3GPP-Authorization-Reference ] +[ 3GPP-Policy-Reference ] +[ 3GPP-Session-AMBR ] +[ 3GPP-Session-AMBR-v2 ] +0*2 [ 3GPP-IP-Address-Pool-Info ] +* [ Supported-Features ] +* [ AVP ] + +``` + +### 12.6.4 RAR Command + +The RAR command, defined in IETF RFC 7155 [23], is indicated by the Command-Code field set to 258 and the 'R' bit set in the Command Flags field. It is sent by the DN-AAA server to the SMF to initiate re-authorization and optional re-authentication service. + +The relevant AVPs that are of use for the N6 interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for N6 purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for N6, or modified existing AVPs. + +Message Format: + +``` + + ::= < Diameter Header: 258, REQ, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + { Auth-Application-Id } + { Re-Auth-Request-Type } + [ User-Name ] + [ Origin-State-Id ] + [ NAS-Port ] + [ NAS-Port-Id ] + [ NAS-Port-Type ] + +``` + +``` + + [ Service-Type ] + [ Framed-IP-Address ] + [ Framed-IPv6-Prefix ] + [ Framed-Interface-Id ] + [ Called-Station-Id ] + [ Calling-Station-Id ] + [ Originating-Line-Info ] + [ Acct-Session-Id ] + * [ Class ] + [ Reply-Message ] + * [ Proxy-Info ] + * [ Route-Record ] +0*16 [ 3GPP-UE-MAC-Address ] +0*16 [ 3GPP-VLAN-Id ] + [ 3GPP-Authorization-Reference ] + [ 3GPP-Policy-Reference ] + [ 3GPP-Session-AMBR ] + [ 3GPP-Session-AMBR-v2 ] + * [ AVP ] + +``` + +### 12.6.5 RAA Command + +The RAA command, defined in IETF RFC 7155 [23], is indicated by the Command-Code field set to 258 and the 'R' bit set in the Command Flags field. It is sent by the SMF to the DN-AAA server in response to the RAR command. + +The relevant AVPs that are of use for the N6 interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for N6 purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for N6, or modified existing AVPs. + +Message Format: + +``` + + ::= < Diameter Header: 258, PXY > + < Session-Id > + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + [ Origin-State-Id ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + * [ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + [ Service-Type ] + [ Idle-Timeout ] + [ Authorization-Lifetime ] + [ Auth-Grace-Period ] + [ Re-Auth-Request-Type ] + * [ Class ] + * [ Reply-Message ] + * [ Proxy-Info ] + [ 3GPP-RAT-Type ] + * [ AVP ] + +``` + +# 13 Interworking with IMS + +## 13.1 General + +Interworking with the IP Multimedia Core Network Subsystem (IMS) puts specific requirements on the SMF. + +The SMF shall use the following mechanisms to support the interworking with the IMS: + +- the P-CSCF discovery; +- N7 interface for the policy and charging control of QoS flows for IMS media flows; and +- the P-CSCF restoration. + +These mechanisms are however not restricted only to the interworking with the IMS and may be used for other services that could benefit from these mechanisms. + +If the PDU Session is used for IMS (identified by DNN), the SMF/UPF shall not modify the fields Type of Service (IPv4) and Traffic Class (IPv6) of the received downlink packets.. + +NOTE: The P-CSCF can support paging policy differentiation for different traffic or service types over NG-RAN by marking the fields Type of Service (IPv4) and Traffic Class (IPv6) (see clause L.3.2.4 of 3GPP TS 24.229 [13]). + +## 13.2 IMS interworking Model + +### 13.2.1 Introduction + +The signalling interface between the UE and the P-CSCF is a logical interface, i.e. it uses 5GC as a QoS flow. The Npcf\_SMPolicyControl services, offered via N7 interface, are used for network communication between the SMF and the PCF. For a description of the IMS architecture, refer to 3GPP TS 23.228 [12]. + +### 13.2.2 IMS specific configuration in the SMF + +The SMF shall have a list of preconfigured addresses of signalling servers (the P-CSCF servers). This list shall be provided to the UE at PDU session establishment. It shall be possible to preconfigure the list of preconfigured addresses of signalling servers per DNN. + +The SMF/UPF may have the locally preconfigured packet filters, and/or the applicable PCC rules, to be applied on the QoS flow. The packet filters shall filter up-link and down-link packets, and shall only allow traffic to/from the signalling servers and to the DNS and the DHCP servers. It shall be possible to locally preconfigure the packet filters per DNN. + +It shall be possible to enable/disable the use of the services offered via N7 interface per DNN. + +The SMF shall support IPv4 and/or IPv6 addresses and protocol for IMS signalling and IMS QoS flows. + +The methods for the UE to discover the P-CSCF address(es) may vary depending on the access technology that the UE is on. The details of the P-CSCF discovery mechanisms for various accesses are specified in 3GPP TS 23.228 [12] and 3GPP TS 24.229 [13]. The P-CSCF discovery mechanisms are: + +- a 5GC procedure for the P-CSCF discovery; +- via DHCP servers i.e. the SMF shall provide the functionality of a DHCP relay agent; and +- if the UE has a P-CSCF FQDN locally configured and request the DNS IP address(es) from the SMF (via 5GC mechanism or DHCP procedures), the SMF shall be able to provide DNS IP address(es) to the UE. + +The SMF shall have similar functional support depending on the P-CSCF discovery methods supported by the UE on the access technology. For example, for the UE in 3GPP 5G access network the SMF shall have DHCP server function towards the UE while acting as a DHCP client towards external DHCP server, if the SMF is configured to request DNS and/or P-CSCF IP addresses from the external DHCP servers. + +The SMF shall be able to deliver DNS and/or P-CSCF addresses to the UE if requested by the UE via the 5G network or via DHCP procedures using the relevant DHCP options for IPv4/IPv6 DNS and SIP servers (see IETF RFC 2132 [14], IETF RFC 3361 [15], IETF RFC 3646 [16] and IETF RFC 3319 [17]). + +On DNNs providing IMS services, the information advertised in Router Advertisements from the SMF to the UEs shall be configured in the same manner as for other DNNs providing IPv6 services except that the "O-flag" shall be set. + +The "O-flag" shall be set in IPv6 Router Advertisement messages sent by the SMF for DNNs used for IMS services. This will trigger a DHCP capable UE to start a DHCPv6 session to retrieve server addresses and other configuration parameters. The UE which doesn't support DHCP shall ignore the "O-flag" and shall request the IMS specific configuration (e.g. the P-CSCF address) via other discovery methods supported in the UE (i.e. via locally configured P-CSCF address/FQDN in the UE or via 5G procedure, if applicable). + +The SMF shall have configurable policy rules for controlling QoS flows used for signalling. + +### 13.2.3 IMS specific procedures in the SMF + +#### 13.2.3.1 Provisioning of Signalling Server Address + +At a PDU Session establishment procedure related to the IMS, the SMF shall support the capability to send the P-CSCF address(es) to the UE. The P-CSCF address information is sent by the visited SMF if LBO is used. For Home routed, the P-CSCF address information is sent by the SMF in the HPLMN. The P-CSCF address(es) shall be sent transparently through the AMF, and in case of Home Routed also through the SMF in the VPLMN. + +NOTE 1: The SMF is located in the VPLMN if LBO is used. + +NOTE 2: Other options to provide the P-CSCF address(es) to the UE as defined in 3GPP TS 23.228 [12] is not excluded. + +NOTE 3: A PDU session for IMS is identified by "APN" or "DNN". + +#### 13.2.3.2 Failure of Signalling Server Address + +If the SMF detects a failure: + +- upon receiving the N4 session report from the UPF for the monitored P-CSCF address being used by the UE (as specified in 3GPP TS 23.380 [38], clause 5.8.3); or +- upon receiving a P-CSCF restoration indication from the UDM or the PCF, + +then the SMF shall act as specified in 3GPP TS 23.380 [38], clause 5.8. + +# --- 14 Interworking with DN (Ethernet) + +When support of Ethernet PDU type data is provided at the N6 interface, the SMF and UPF may support ARP proxying as specified in IETF RFC 1027 [35] and/or IPv6 Neighbour Solicitation Proxying as specified in IETF RFC 4861 [33] functionality. Based on operator configuration, during the PDU session establishment, the SMF may request the UPF acting as the PDU Session Anchor to proxy ARP/IPv6 Neighbour Solicitation or to forward the ARP/IPv6 Neighbour Solicitation traffic from the UPF to the SMF. + +Ethernet Preamble, Start Frame Delimiter (SFD) and Frame Check Sequence (FCS) are not sent over 5GS: + +- For UL traffic the UE strips the Preamble, SFD and FCS from the Ethernet frame, those fields shall be added by the UPF acting as the PDU Session Anchor. +- For DL traffic the UPF acting as the PDU Session Anchor shall strip the Preamble, SFD and FCS from the Ethernet frame. + +IP address is not allocated by the SMF to the UE for this PDU Session. The UPF shall store the MAC addresses, received from the UE, and associate those with the appropriate PDU Session. + +NOTE 1: The UE can operate in bridge mode with regard to a LAN it is connecting to the 5GS, thus different MAC addresses can be used as source address of different frames sent UL over a single PDU Session (and destination MAC address of different frames sent DL over the same PDU Session) + +NOTE 2: Entities on the LAN connected to the 5GS by the UE can have an IP address allocated by the external DN, but the IP layer is considered as an application layer which is not part of the Ethernet PDU Session. + +NOTE 3: In this Release of the specification, only the UE connected to the 5GS is authenticated, not the devices behind such UE. + +When a PDU Session of Ethernet PDU type is authorized by a DN, the DN-AAA server may, as part of authorization data, provide the SMF with a list of allowed MAC addresses (maximum 16) for this PDU Session. When such a list has been provided for a PDU Session, the SMF sets corresponding filtering rules in the UPF(s) acting as PDU Session Anchor for the PDU Session and the UPF discards any UL traffic that does not contain any of these MAC addresses as a source address. + +![Figure 14-1: Protocol stacks for Ethernet PDU type data (user plane) for N6 reference point. The diagram shows the protocol stack within a UPF (PDU Session Anchor). On the left, the stack for N3/N4/N9 interfaces consists of 'Ethernet User Payload (e.g. ARP, IP)' at the top, 'Ethernet Frame (without Preamble, SFD, FCS)' in the middle, and '5G protocol layers' at the bottom. On the right, the stack for the N6 interface consists of 'Ethernet Frame' at the top and 'L1' at the bottom. The '5G protocol layers' on the left are connected to the 'L1' layer on the right.](3198cdf0dbe501c46fe0e4073c7d8451_img.jpg) + +Figure 14-1: Protocol stacks for Ethernet PDU type data (user plane) for N6 reference point. The diagram shows the protocol stack within a UPF (PDU Session Anchor). On the left, the stack for N3/N4/N9 interfaces consists of 'Ethernet User Payload (e.g. ARP, IP)' at the top, 'Ethernet Frame (without Preamble, SFD, FCS)' in the middle, and '5G protocol layers' at the bottom. On the right, the stack for the N6 interface consists of 'Ethernet Frame' at the top and 'L1' at the bottom. The '5G protocol layers' on the left are connected to the 'L1' layer on the right. + +Figure 14-1: Protocol stacks for Ethernet PDU type data (user plane) for N6 reference point + +# 15 Interworking with DN (Multicast Routing Protocol) + +## 15.1 General + +The 3GPP network support IPTV multicast packets transmission over PDU Session as specified in 3GPP TS 23.316 [43] clause 7.7.1. When support of multicast routing protocol is provided at the N6 interface, different techniques may be used. + +## 15.2 DN interworking Model of UPF for PIM + +If PIM (Protocol-Independent Multicast) is used as Multicast Routing Protocol, including PIM-SM (Protocol-Independent Multicast-Sparse Mode, IETF RFC 7761 [44]) and PIM-DM (Protocol-Independent Multicast- Dense Mode, IETF RFC 3973 [45]), are commonly used to efficiently routing multicast groups that may span wide-area (and inter-domain) internets. + +UPF acts as the PIM router which is closest to UE and receive multicast packets originated from multicast source via perform PIM function. Based on local policy, UPF support either PIM-SM or PIM-DM or both. + +UPF shall acts as PIM router used for interworking with the IP network as illustrated in figure 15.2-1. + +![Diagram showing the protocol stack for the N6 reference point for PIM. The stack is located within the UPF (User Plane Function) and consists of five layers: PIM, UDP, IP, L2, and L1. An arrow points from the IP layer of the stack towards the N6 reference point, indicating the flow of PIM messages.](18bb06865e2dada3656ea3d57f290f7f_img.jpg) + +Diagram showing the protocol stack for the N6 reference point for PIM. The stack is located within the UPF (User Plane Function) and consists of five layers: PIM, UDP, IP, L2, and L1. An arrow points from the IP layer of the stack towards the N6 reference point, indicating the flow of PIM messages. + +**Figure 15.2-1: The protocol stacks for the N6 reference point for PIM** + +PIM function in UPF shall interact with PIM routers in IP network. + +- In case of PIM-SM, PIM router in UPF acts as DR (Designated Router) which is closest to UE and send register message to RP (Rendezvous Point). It receive multicast packets over shared tree from RP. Refer to IETF RFC 7761 [44] for more details. +- In case of PIM-DM, PIM router in UPF sends Upstream Prune Messages to indicate that designated multicast traffic is not desired, It sends Upstream Graft message to re-join a previously pruned branch to the delivery tree. Refer to IETF RFC 3973 [45] for more details. + +# 16 Interworking with NSS-AAA (RADIUS) + +## 16.1 RADIUS procedures + +### 16.1.1 General + +The Network Slice Specific Authentication and Authorization procedure is triggered for a network slice requiring Network Slice Specific Authentication and Authorization with an NSS-AAA server which may be hosted by the H-PLMN operator or by a third party which has a business relationship with the H-PLMN. An AAA Proxy (AAA-P) in the HPLMN may be involved e.g. if the NSS-AAA Server belongs to a third party. + +### 16.1.2 RADIUS Authentication and Authorization + +RADIUS Authentication and Authorization shall be used according to IETF RFC 2865 [8], IETF RFC 3162 [9] and IETF RFC 4818 [10]. In 5G, multiple authentication methods using Extensible Authentication Protocol (EAP) may be used such as EAP-TLS (see IETF RFC 5216 [11]), EAP-TTLS (see IETF RFC 5281 [37]). The NSSAAF or AAA-P shall implement the RADIUS extension to support EAP as specified in IETF RFC 3579 [7]. + +The RADIUS client function may reside in an NSSAAF. When the NSSAAF receives Nnssaaf\_NSSAA\_Authenticate request from AMF, the RADIUS client function shall send the authentication information with network slice information to a NSS-AAA server directly or via an AAA-P. + +The NSS-AAA server performs authentication and authorization for the user and requested network slice information. When the NSSAAF receives an Access-Accept message from the NSS-AAA server or AAA-P, it shall complete the network slice specific authentication procedure. If Access-Reject or no response is received, the NSSAAF shall reject the network slice specific authentication procedure with a suitable cause code. + +The NSS-AAA may revoke the authorization for the network slice, see details in clause 16.2.2. In the present release, the NSS-AAA initiated re-authentication is not supported. + +## 16.2 Message flows for network slice specific authentication + +### 16.2.1 Authentication and Authorization procedures + +When the NSSAAF receives Nnssaaf\_NSSAA\_Authenticate request from AMF, it shall send a RADIUS Access-Request message with EAP extension to an NSS-AAA server directly or via an AAA-P if AAA-P is involved. The Access-Request message shall include GPSI in Calling-Station-Id or External-Identifier attribute and network slice information in 3GPP-S-NSSAI attribute. Upon receipt of the Access-Request message, the NSS-AAA server shall respond with an Access-Challenge message. Multi-round authentication using the Access-Challenge (sent by NSS-AAA) and Access-Request messages may be used. The NSS-AAA server finally authenticates and authorizes the user and the network slice by replying with an Access Accept message. + +For re-authentication and re-authorization, the NSSAAF shall send a RADIUS Access-Request message with EAP extension to the NSS-AAA server directly or via the AAA-P if AAA-P is used and the NSS-AAA shall respond with an Access-Challenge message. Multi-round authentication using the Access-Challenge (sent by NSS-AAA) and Access-Request messages may be used. The NSS-AAA server finally authenticates and authorizes the user and the network slice by replying with an Access Accept message. + +The following figure 16.2.1-1 is an example message flow to show the procedure of RADIUS Authentication and Authorization between an AMF and a NSS-AAA server: + +1. AMF decides to trigger the start of the Network Slice Specific Authentication and Authorization procedure. +2. The AMF may send an EAP Identity Request in a NAS Network Slice-Specific Authentication Command message. +3. The UE provides the EAP Identity Response in a NAS Network Slice-Specific Authentication Complete message towards the AMF. +4. The AMF sends Nnssaaf\_NSSAA\_Authenticate Request to the NSSAAF including the authentication/authorization information. +- 5-6. If the AAA-P is present (e.g. because the NSS-AAA belongs to a third party and the operator deploys a proxy towards third parties), the NSSAAF sends the Access-Request message to the NSS-AAA via the AAA-P to forward the authentication/authorization information, otherwise the NSSAAF sends the Access-Request message directly to the NSS-AAA. +- 7-14. The NSS-AAA responds with the Access-Challenge message to the NSSAAF directly or via the AAA-P. The authentication/authorization information is further transferred to UE via AMF by Nnssaaf\_NSSAA\_Authenticate service and NAS Network Slice-Specific Authentication Command message. UE responds to the received authentication/authorization data and such information is transferred in NAS Network Slice-Specific Authentication Complete message and Nnssaaf\_NSSAA\_Authenticate service, then finally sent to the NSS-AAA by the NSSAAF, via the AAA-P if the AAA-P is used, in the Access-Request message. + +NOTE: Step 7 to step 14 can be repeated depending on the authentication/authorization mechanism used (e.g. EAP-TLS). + +- 15-16. If the AAA-P is used, the NSS-AAA sends a Access-Accept message with the final result of authentication/authorization to the NSSAAF via the AAA-P, otherwise the NSS-AAA sends the Access-Accept message directly to the NSSAAF. +17. The NSSAAF sends a Nnssaaf\_NSSAA\_Authenticate Response with the final result of authentication/authorization information to the AMF. +18. The AMF transfers the final result of authentication/authorization information in a NAS Network Slice-Specific Authentication Result message to the UE. + +![Sequence diagram showing Network slice specific authentication and Authorization procedure (RADIUS) involving UE, AMF, NSSAAF, AAA-P, and NSS-AAA.](e7010c66da16316c2935dfbbef5056b3_img.jpg) + +``` + +sequenceDiagram + participant UE + participant AMF + participant NSSAAF + participant AAA-P + participant NSS-AAA + + Note right of UE: 1. trigger to perform Network Slice-Specific Authentication and Authorization + UE->>AMF: 2. NAS Network Slice-Specific Authentication Command + AMF-->>UE: 3. NAS Network Slice-Specific Authentication Complete + AMF->>NSSAAF: 4. Nnssaaaf_NSSAA_Authentic + NSSAAF->>AAA-P: 5. Access-Request + AAA-P->>NSS-AAA: 6. Access-Request + NSS-AAA-->>AAA-P: 7. Access-Challenge + AAA-P-->>NSSAAF: 8. Access-Challenge + NSSAAF->>AMF: 9. Nnssaaaf_NSSAA_Authentic + AMF->>UE: 10. NAS Network Slice-Specific Authentication Command + UE->>AMF: 11. NAS Network Slice-Specific Authentication Complete + AMF->>NSSAAF: 12. Nnssaaaf_NSSAA_Authentic + NSSAAF->>AAA-P: 13. Access-Request + AAA-P->>NSS-AAA: 14. Access-Request + NSS-AAA-->>AAA-P: 15. Access-Accept + AAA-P-->>NSSAAF: 16. Access-Accept + NSSAAF->>AMF: 17. Nnssaaaf_NSSAA_Authentic + AMF->>UE: 18. NAS Network Slice-Specific Authentication Result + +``` + +Sequence diagram showing Network slice specific authentication and Authorization procedure (RADIUS) involving UE, AMF, NSSAAF, AAA-P, and NSS-AAA. + +Figure 16.2.1-1: Network slice specific authentication and Authorization procedure (RADIUS) + +### 16.2.2 NSS-AAA initiated revocation of network slice authorization + +The NSS-AAA server may send a RADIUS Disconnect-Request to the NSSAAF directly or via AAA-P (if AAA-P is used) asking for revocation of network slice authorization. On receipt of the Disconnect-Request from the NSS-AAA server, the NSSAAF shall check whether the NSS-AAA server is authorized to request the revocation by verifying the local configuration of the address of the NSS-AAA server per S-NSSAI, if successful, the NSSAAF shall release the resources, interact with its succeeding Network Function AMF which is got from the UDM by Nudm\_UECM\_GET service operation with GPSI and reply with a Disconnect-ACK. If the NSSAAF is unable to release the corresponding resources, it shall reply to the NSS-AAA server with a Disconnect-NAK. For more information on RADIUS Disconnect, see IETF RFC 5176 [27]. It is not necessary for the NSSAAF to wait for the response (i.e. Nudm\_UECM\_GET or Nnssaaaf\_NSSAA\_Notify response) from the succeeding Network Function before sending the RADIUS Disconnect-ACK to the NSS-AAA server or AAA-P (if AAA-P is used). + +**Editor's Note:** It is FFS whether the RADIUS is applicable. + +Figure 16.2.2-1 is an example message flow to show the procedure of NSS-AAA initiated revocation of network slice authorization. If the AAA-P is not used, the Disconnect Request and Response messages are exchanged between the NSS-AAA and the NSSAAF. + +![Sequence diagram showing NSS-AAA initiated revocation of network slice authorization with RADIUS. Lifelines: AMF, UDM, NSSAAF, AAA-P, NSS-AAA. The sequence starts with NSS-AAA sending a Disconnect-Request to AAA-P. AAA-P sends a Disconnect-Request to NSSAAF. NSSAAF sends a Nudm_UECM_GET to UDM. UDM sends a Nausf_NSSAA_Notify to AMF. AMF sends a Disconnect-Response to NSSAAF. NSSAAF sends a Disconnect-Response to AAA-P. AAA-P sends a Disconnect-Response to NSS-AAA.](dbd4bab54b57e8d1abf80e3de6471130_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM + participant NSSAAF + participant AAA-P + participant NSS-AAA + Note right of AAA-P: [AAA-P] + NSS-AAA->>AAA-P: Disconnect-Request + AAA-P-->>NSSAAF: Disconnect-Request + NSSAAF->>UDM: Nudm_UECM_GET + UDM-->>AMF: Nausf_NSSAA_Notify + AMF->>NSSAAF: Disconnect-Response + NSSAAF-->>AAA-P: Disconnect-Response + AAA-P->>NSS-AAA: Disconnect-Response + +``` + +Sequence diagram showing NSS-AAA initiated revocation of network slice authorization with RADIUS. Lifelines: AMF, UDM, NSSAAF, AAA-P, NSS-AAA. The sequence starts with NSS-AAA sending a Disconnect-Request to AAA-P. AAA-P sends a Disconnect-Request to NSSAAF. NSSAAF sends a Nudm\_UECM\_GET to UDM. UDM sends a Nausf\_NSSAA\_Notify to AMF. AMF sends a Disconnect-Response to NSSAAF. NSSAAF sends a Disconnect-Response to AAA-P. AAA-P sends a Disconnect-Response to NSS-AAA. + +Figure 16.2.2-1: NSS-AAA initiated revocation of network slice authorization with RADIUS + +## 16.3 List of RADIUS attributes + +### 16.3.1 General + +Information defined in clause 11.3 are re-used for network slice specific authentication with the following differences: + +- NSSAAF replaces SMF. +- IP, Ethernet and PDU session related descriptions and attributes are not applicable. +- RADIUS messages for accounting function (Accounting Request/Response) are not applicable. +- Additional detailed information needed for network slice specific authentication are described below. + +Table 16.3-1: Additional information needed for network slice specific authentication + +| Sub-attr # | Sub-attribute Name | Differences | +|------------------------------------------------------------------------------------------------|--------------------|-------------| +| 200 | 3GPP-S-NSSAI | Added. | +| NOTE: 5G specific RADIUS VSAs for network slice specific authentication are numbered from 200. | | | + +#### 200 – 3GPP-S-NSSAI + +| Octets | Bits | | | | | | | | +|--------|-------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 200 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3 | SST | | | | | | | | +| 4-6 | SD (octet string) | | | | | | | | + +3GPP Type: 200 + +Length: 3 or 6 + +SST: the Slice/Service Type with value range 0 to 255. + +SD: 3-octet string, representing the Slice Differentiator, the encoding follows sd attribute specified in clause 5.4.4.2 of 3GPP TS 29.571 [46]. Its presence depends on the Length field. + +Table 16.3-2 describes the sub-attributes of the 3GPP Vendor-Specific attribute described above in different RADIUS messages. + +**Table 16.3-2: List of the 3GPP Vendor-Specific sub-attributes for network slice specific authentication** + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicability | +|------------|-------------------------------------------------------------------|--------------------------|----------------------|---------------------------------------------|---------------| +| 200 | 3GPP-S-NSSAI | It includes the S-NSSAI. | Conditional (NOTE) | Access-Request | | +| NOTE: | This VSA shall be included in the initial Access-Request message. | | | | | + +# 17 Interworking with NSS-AAA (Diameter) + +## 17.1 Diameter procedures + +### 17.1.1 General + +The Network Slice Specific Authentication and Authorization procedure is triggered for a network slice requiring Network Slice Specific Authentication and Authorization with an NSS-AAA server which may be hosted by the H-PLMN operator or a third party which has a business relationship with the H-PLMN. An AAA Proxy (AAA-P) in the HPLMN may be involved e.g. if the NSS-AAA Server belongs to a third party. + +### 17.1.2 Diameter Authentication and Authorization + +Diameter Authentication and Authorization shall be used according to IETF RFC 7155 [23]. In 5G, multiple authentication methods using Extensible Authentication Protocol (EAP) may be used such as EAP-TLS (see IETF RFC 5216 [11]), EAP-TTLS (see IETF RFC 5281 [37]). The NSSAAF or AAA-P shall support Diameter EAP application as specified in IETF RFC 4072 [25]. + +The NSSAAF or AAA-P and the NSS-AAA shall advertise the support of the Diameter NASREQ and EAP applications by including the value (1 and 5) of the application identifier in the Auth-Application-Id AVP (as specified in IETF RFC 4072 [25]) and the value of the 3GPP (10415) in the Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands as specified in IETF RFC 6733 [24], i.e. as part of the Vendor-Specific-Application-Id AVP. + +The Diameter client function may reside in an NSSAAF. When the NSSAAF receives Nnssaaf\_NSSAA\_Authenticate request from AMF, the Diameter client function shall send the authentication information with network slice information to a NSS-AAA server directly or via an AAA-P (if AAA-P is used). + +The NSS-AAA server performs authentication and authorization for the requested network slice information. When the Nnssaaf receives a positive response from the NSS-AAA server or AAA-P (if AAA-P is used), it shall complete the network slice specific authentication procedure. If negative response or no response is received, the NSSAAF shall reject the network slice specific authentication procedure with a suitable cause code. + +The NSS-AAA may revoke the authorization for the network slice, see details in clause 17.2.2. NSS-AAA may initiate re-authentication and re-authorization, see details in clause 17.2.3. + +## 17.2 Message flows for network slice specific authentication + +### 17.2.1 Authentication and Authorization procedures + +For network slice specific authentication and authorization, when the NSSAAF receives Nnssaaf\_NSSAA\_Authenticate request from AMF, it shall send a Diameter DER message with GPSI in Calling-Station-Id or External-Identifier attribute and network slice information in 3GPP-S-NSSAI attribute to a NSS-AAA server directly or via AAA-P if AAA-P is involved. Upon receipt of the DER message, the DN-AAA server shall respond with an DEA message. + +Multi-round authentication using the DEA and DER messages may be used. The NSS-AAA server finally authenticates and authorizes the user and the network slice by replying with a Diameter DEA message. + +For re-authentication and re-authorization, the NSSAAF shall send a DER message to the NSS-AAA server directly or via AAA-P if AAA-P is used and the NSS-AAA server shall respond with a DEA message. Multi-round authentication using the DEA and DER messages may be used. The NSS-AAA server finally authenticates and authorizes the user and the network slice by replying with a Diameter DEA message. + +If the network slice specific authentication is not required, the NSSAAF shall send a Diameter STR message to the NSS-AAA server directly or via AAA-P if AAA-P is involved. The NSS-AAA server shall reply with a Diameter STA message. The following figure 17.2.1-1 is an example message flow to show the procedure of Diameter Authentication and Authorization between an AMF and a NSS-AAA server: + +1. AMF decides to trigger the start of the Network Slice Specific Authentication and Authorization procedure. +2. The AMF may send an EAP Identity Request in a NAS Network Slice-Specific Authentication Command message. +3. The UE provides the EAP Identity Response in a NAS Network Slice-Specific Authentication Complete message towards the AMF. +4. The AMF sends Nnssaaf\_NSSAA\_Authenticate Request to the NSSAAF including the authentication/authorization information. +- 5-6. If the AAA-P is present (e.g. because the NSS-AAA belongs to a third party and the operator deploys a proxy towards third parties), the NSSAAF sends the DER message to the NSS-AAA via the AAA-P to forward the authentication/authorization information, otherwise the NSSAAF sends the DER message directly to the NSS-AAA. +- 7-14. The NSS-AAA responds with the DEA message to the NSSAAF directly or via the AAA-P. The authentication/authorization information is further transferred to UE via AMF by Nnssaaf\_NSSAA\_Authenticate service and NAS MM Transport message. UE responds to the received authentication/authorization data and such information is transferred in NAS Network Slice-Specific Authentication Complete message and Nnssaaf\_NSSAA\_Authenticate service, then finally sent to the NSS-AAA by the NSSAAF, via the AAA-P if the AAA-P is used, in the DER message. + +NOTE: Step 7 to step 14 can be repeated depending on the authentication/authorization mechanism used (e.g. EAP-TLS). + +- 15-16. If the AAA-P is used, the NSS-AAA sends a DEA message with the final result of authentication/authorization to the NSSAAF via the AAA-P, otherwise the NSS-AAA sends the DEA message directly to the NSSAAF. +17. The NSSAAF sends a Nnssaaf\_NSSAA\_Authenticate Response with the final result of authentication/authorization information to the AMF. +18. The AMF transfers the final result of authentication/authorization information in a NAS Network Slice-Specific Authentication Result message to the UE. + +![Sequence diagram of network slice specific authentication and authorization procedure (Diameter).](9c45844d796e85ae05505870a54e4eb4_img.jpg) + +``` + +sequenceDiagram + participant UE + participant AMF + participant NSSAAF + participant AAA-P + participant NSS-AAA + + Note right of UE: 1. trigger to perform Network Slice-Specific Authentication and Authorization + UE->>AMF: 2. NAS Network Slice-Specific Authentication Command + AMF-->>UE: 3. NAS Network Slice-Specific Authentication Complete + AMF->>NSSAAF: 4. Nnssaaaf_NSSAA_Authenticate request + NSSAAF->>AAA-P: 5. DER + AAA-P->>NSSAAF: 6. DER + AAA-P->>NSS-AAA: 7. DEA + NSSAAF-->>AAA-P: 8. DEA + AMF->>NSSAAF: 9. Nnssaaaf_NSSAA_Authenticate response + AMF->>UE: 10. NAS Network Slice-Specific Authentication Command + UE->>AMF: 11. NAS Network Slice-Specific Authentication Complete + AMF->>NSSAAF: 12. Nnssaaaf_NSSAA_Authenticate request + NSSAAF->>AAA-P: 13. DER + AAA-P->>NSSAAF: 14. DER + AAA-P->>NSS-AAA: 15. DEA + NSSAAF-->>AAA-P: 16. DEA + AMF->>NSSAAF: 17. Nnssaaaf_NSSAA_Authenticate response + AMF->>UE: 18. NAS Network Slice-Specific Authentication Result + +``` + +Sequence diagram of network slice specific authentication and authorization procedure (Diameter). + +Figure 17.2.1-1: Network slice specific authentication and Authorization procedure (Diameter) + +### 17.2.2 NSS-AAA initiated revocation of network slice authorization + +The NSS-AAA server may send a Diameter ASR message to the NSSAAF directly or via AAA-P (if AAA-P is used) asking for revocation of network slice authorization. On receipt of the ASR message from the NSS-AAA server, the NSSAAF shall check whether the NSS-AAA server is authorized to request the revocation by verifying the local configuration of the address of the NSS-AAA server per S-NSSAI, if successful, the NSSAAF shall release the corresponding resources, interact with its succeeding Network Function AMF which is got from the UDM by Nudm\_UECM\_GET service operation with GPSI and reply with a Diameter ASA message. It is not necessary for the NSSAAF to wait for the response (i.e. Nudm\_UECM\_GET or Nnssaaaf\_NSSAA\_Notify response) from its succeeding Network Function before sending the ASA message to the NSS-AAA server or AAA-P. + +NOTE: In the Diameter ASR request, the Origin-Host AVP with the FQDN/domain format indicates the address of the NSS-AAA server for NSSAAF check. + +Figure 17.2.2-1 is an example message flow to show the procedure of NSS-AAA initiated revocation of network slice authorization. If the AAA-P is not used, the ASR and ASA messages are exchanged between the NSS-AAA and the NSSAAF. + +![Sequence diagram for NSS-AAA initiated revocation of network slice authorization with Diameter. Lifelines: AMF, UDM, NSSAAF, AAA-P (dashed box), NSS-AAA. The sequence starts with NSS-AAA sending a Diameter ASR to AAA-P. AAA-P sends a Diameter ASR to NSSAAF. NSSAAF sends a Nudm_UECM_GET to UDM. UDM sends a Nausf_NSSAA_Notify to AMF. AMF sends a Diameter ASA to NSSAAF. NSSAAF sends a Diameter ASA to AAA-P. AAA-P sends a Diameter ASA to NSS-AAA.](49fe8fe978c0f7e73112d231feb377eb_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM + participant NSSAAF + participant AAA-P as AAA-P + participant NSS-AAA + Note right of NSS-AAA: Diameter ASR + NSS-AAA->>AAA-P: Diameter ASR + AAA-P-->>NSSAAF: Diameter ASR + NSSAAF->>UDM: Nudm_UECM_GET + UDM->>AMF: Nausf_NSSAA_Notify + AMF->>NSSAAF: Diameter ASA + NSSAAF-->>AAA-P: Diameter ASA + AAA-P->>NSS-AAA: Diameter ASA + +``` + +Sequence diagram for NSS-AAA initiated revocation of network slice authorization with Diameter. Lifelines: AMF, UDM, NSSAAF, AAA-P (dashed box), NSS-AAA. The sequence starts with NSS-AAA sending a Diameter ASR to AAA-P. AAA-P sends a Diameter ASR to NSSAAF. NSSAAF sends a Nudm\_UECM\_GET to UDM. UDM sends a Nausf\_NSSAA\_Notify to AMF. AMF sends a Diameter ASA to NSSAAF. NSSAAF sends a Diameter ASA to AAA-P. AAA-P sends a Diameter ASA to NSS-AAA. + +Figure 17.2.2-1: NSS-AAA initiated revocation of network slice authorization with Diameter + +### 17.2.3 NSS-AAA initiated re-authentication and re-authorization + +The NSS-AAA server may send a Diameter RAR message to the NSSAAF directly or via AAA-P (if AAA-P is used) asking for re-authentication and re-authorization. On receipt of the RAR message from the NSS-AAA server, the NSSAAF shall check whether the NSS-AAA server is authorized to request the re-authentication and re-authorization by verifying the local configuration of the address of the NSS-AAA server per S-NSSAI, if successful, the NSSAAF shall interact with its succeeding Network Function AMF which is got from the UDM by Nudm\_UECM\_GET service operation with GPSI and reply with a Diameter RAA message. It is not necessary for the NSSAAF to wait for the response (i.e. Nudm\_UECM\_GET or NnssAAF\_NSSAA\_Notify response) from its succeeding Network Function before sending the RAA message to the NSS-AAA server or AAA-P. + +NOTE: In the Diameter RAR request, the Origin-Host AVP with the FQDN/domain format indicates the address of the NSS-AAA server for NSSAAF check. + +After replying NnssAAF\_NSSAA\_Notify response, the AMF shall start authentication and authorization procedure as described in clause 17.2.1. The Auth-Request-Type in the DER is set to "AUTHORIZE\_AUTHENTICATE". + +Figure 17.2.3-1 is an example message flow to show the procedure of NSS-AAA initiated re-authentication and re-authorization. If the AAA-P is not used, the RAR and RAA messages are exchanged between the NSS-AAA and the NSSAAF. + +![Sequence diagram for NSS-AAA initiated re-authentication and re-authorization with Diameter. Lifelines: AMF, UDM, NSSAAF, AAA-P (dashed box), NSS-AAA. The sequence starts with NSS-AAA sending a Diameter RAR to AAA-P. AAA-P sends a Diameter RAR to NSSAAF. NSSAAF sends a Nudm_UECM_GET to UDM. UDM sends a Nausf_NSSAA_Notify to AMF. AMF starts 'AMF initiated Network Slice-Specific Authentication and Authorization'. NSSAAF sends a Diameter RAA to AAA-P. AAA-P sends a Diameter RAA to NSS-AAA.](d15e2d3e8dd9157eb7f0cc120097484a_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UDM + participant NSSAAF + participant AAA-P as AAA-P + participant NSS-AAA + Note right of NSS-AAA: Diameter RAR + NSS-AAA->>AAA-P: Diameter RAR + AAA-P-->>NSSAAF: Diameter RAR + NSSAAF->>UDM: Nudm_UECM_GET + UDM->>AMF: Nausf_NSSAA_Notify + AMF->>AMF: AMF initiated Network Slice-Specific Authentication and Authorization + NSSAAF->>AAA-P: Diameter RAA + AAA-P->>NSS-AAA: Diameter RAA + +``` + +Sequence diagram for NSS-AAA initiated re-authentication and re-authorization with Diameter. Lifelines: AMF, UDM, NSSAAF, AAA-P (dashed box), NSS-AAA. The sequence starts with NSS-AAA sending a Diameter RAR to AAA-P. AAA-P sends a Diameter RAR to NSSAAF. NSSAAF sends a Nudm\_UECM\_GET to UDM. UDM sends a Nausf\_NSSAA\_Notify to AMF. AMF starts 'AMF initiated Network Slice-Specific Authentication and Authorization'. NSSAAF sends a Diameter RAA to AAA-P. AAA-P sends a Diameter RAA to NSS-AAA. + +Figure 17.2.3-1: NSS-AAA initiated re-authentication and re-authorization with Diameter + +## 17.3 Specific AVPs + +There is no specific AVP defined in the present release. + +## 17.4 re-used AVPs + +### 17.4.1 General + +Information defined in clause 12.4.0 are re-used for network slice specific authentication with the following differences: + +- NSSAAF replaces SMF. +- IP, Ethernet and PDU session related descriptions and AVPs are not applicable. +- Additional detailed information needed for network slice specific authentication are described below. + +**Table 17.4-1: Additional information needed for network slice specific authentication** + +| Attribute Name | AVP Code | Section defined | Value Type (NOTE 2) | AVP Flag rules (NOTE 1) | | | | May Encr. | Applicability | +|----------------|----------|-----------------|---------------------|-------------------------|-----|------------|----------|-----------|---------------| +| | | | | Must | May | Should not | Must not | | | +| 3GPP-S-NSSAI | 200 | 16.3.1 (NOTE 3) | UTF8String | V | P | | M | Y | | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [24]. + +NOTE 2: The value types are defined in IETF RFC 6733 [24]. + +NOTE 3: The use of Radius VSA as a Diameter vendor AVP is described in Diameter NASREQ (IETF RFC 7155 [23]) and the P flag may be set. + +### 17.4.2 Use of the Supported-Features AVP + +The Supported-Features AVP is used during the network slice specific authentication procedure to inform the destination host about the required and optional features that the origin host supports. The client shall, in the first request in a Diameter session indicate the set of supported features. The server shall, in the first answer within the Diameter session indicate the set of features that it has in common with the client and that the server shall support within the same Diameter session. Any further command messages shall always be compliant with the list of supported features indicated in the Supported-Features AVPs during session establishment. Features that are not advertised as supported shall not be used to construct the command messages for that Diameter session. Unless otherwise stated, the use of the Supported-Features AVP shall be compliant with the requirements for dynamic discovery of supported features and associated error handling on the Cx reference point as defined in clause 7.2.1 of 3GPP TS 29.229 [41]. + +The base functionality is the 3GPP Rel-16 standard and a feature is an extension to that functionality. If the origin host does not support any features beyond the base functionality, the Supported-Features AVP may be absent in the DER command. As defined in clause 7.1.1 of 3GPP TS 29.229 [41], when extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [41], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. The Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined, the Feature-List-ID AVP shall differentiate those lists from one another. + +On receiving an initial request application message, the destination host shall act as defined in clause 7.2.1 of 3GPP TS 29.229 [41]. + +Once the NSSAAF or AAA-P and NSS-AAA have negotiated the set of supported features during session establishment, the set of common features shall be used during the lifetime of the Diameter session. + +The table below defines the features applicable for the network slice specific authentication, for the feature lists with a Feature-List-ID of 1. + +Table 17.4.2-1: Features of Feature-List-ID 1 + +| Feature bit | Feature | M/O | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|-------------| +| Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "5GC".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release.
Description: A clear textual description of the feature. | | | | + +## 17.5 Specific Experimental-Result-Code AVP + +There is no specific experimental result code AVP defined in the present release. + +## 17.6 Diameter messages + +### 17.6.1 General + +Diameter messages as defined in clause 12.6 are re-used for network slice specific authentication with the following differences: + +- NSSAAF or AAA-P replaces SMF. +- IP, Ethernet and PDU session related descriptions and AVPs are not applicable. +- Diameter commands for accounting function (ACR and ACA) are not applicable. +- AAR and AAA commands are not applicable. +- 3GPP-S-NSSAI is included in the DER command. +- the address of NSS-AAA server is included in the Origin-Host AVP in the ASR and RAR command + +NOTE: The presence of 3GPP-S-NSSAI in the DER command is optional but it is mandatory for the NSSAAF or AAA-P to include it for the network slice specific authentication. + +# 18 Interworking with DN (L2TP tunnel) + +## 18.1 Support L2TP for CUPS across N6 + +L2TP (described in IETF RFC 2661 [57]) is a standard method for tunneling encapsulated Point-to-Point Protocol (PPP) frames over an IP network. L2TP operates between two L2TP endpoints (LAC and LNS), and tunnels PPP-encapsulated IP traffic between these endpoints. L2TP runs over UDP/IP and was originally defined for systems where PPP is used by an end-device to connect to a network (e.g. via DSL connections, or 2G/3G PPP PDP context). In these cases, a LAC could be deployed in the network (e.g. in a BNG or GGSN/PGW) to tunnel the PPP traffic to a server (LNS) over an IP network. + +For 5GC with the UE using IP PDU Session, the PPP functionality that is required to use L2TP is instead supported by the UPF or UPF+PGW-U, as illustrated in below figure. Upon receiving a PDU Session/PDN Connection establishment request from the UE via AMF or MME, SMF or SMF+PGW-C may depend on local L2TP configuration per DNN or the received L2TP information from a DN AAA server in Access-Accept message, request the UPF or UPF+PGW-U to setup L2TP tunnel towards an L2TP network server (LNS) in the external DN and tunnel the PDU Session user plane traffic in this L2TP tunnel. In this case the UPF or UPF+PGW-U acts as a L2TP access concentrator (LAC). + +To enable this, the SMF or SMF+PGW-C may provide L2TP information to the UPF or UPF+PGW-U as LAC, such as LNS IP address or FQDN, as described in 3GPP TS 29.244 [58]. This L2TP information may be configured on the SMF or SMF+PGW-C as part of the DNN configuration or received from the DN-AAA server. Alternatively, the L2TP + +tunnel parameters may be configured in the UPF or UPF+PGW-U. The L2TP tunnel parameters include necessary parameters for setting up L2TP tunnel towards the LNS (e.g. LNS address, tunnel password). + +In addition, the SMF or SMF+PGW-C may provide PAP/CHAP authentication information to the UPF or UPF+PGW-U, for use in L2TP session establishment, in case it was received from the UE in the ePCO IE of the PDU Session Establishment Request. + +When L2TP is to be used for a PDU Session, the SMF or SMF+PGW-C may select a UPF or UPF+PGW-U and requests the UE IP address to be allocated by LNS according to 3GPP TS 29.244 [58], the UPF (LAC) may retrieve this IP address from the LNS. + +![Diagram of L2TP Tunnel between 5GC and external DN](e38f0349f1b6094626cbfeab7105f029_img.jpg) + +The diagram illustrates the network architecture for an L2TP tunnel. On the left, a 'UE' (User Equipment) is connected to an 'AN' (Access Network). The 'AN' is connected to the '5GC' (5G Core) via an 'N1' interface. Inside the '5GC', the 'AN' connects to an 'AMF' (Access and Management Function), which in turn connects to an 'SMF or SMF+PGW-C' (Session Management Function) via an 'N11' interface. The 'SMF or SMF+PGW-C' connects to a 'UPF or UPF+PGW-U / LAC' (User Plane Function / L2TP Access Concentrator) via an 'N4' interface. The 'UPF or UPF+PGW-U / LAC' connects to an 'external DN' (Data Network) via an 'N6' interface. Inside the 'external DN', the 'UPF or UPF+PGW-U / LAC' connects to an 'LNS' (L2TP Network Server) via an 'L2TP Tunnel', represented by a double-headed arrow. The 'LNS' is connected to an 'AAA server' (Authentication, Authorization, Accounting) via a dashed line. + +Diagram of L2TP Tunnel between 5GC and external DN + +**Figure 18.1-1: L2TP Tunnel between 5GC and external DN** + +Below figure describes the L2TP connection procedures between 5GC and external DN, upon the UE is accessed in 5GC and the SMF or SMF+PGW-C and UPF or UPF+PGW-U has been negotiated supporting L2TP feature. + +![Sequence diagram showing L2TP connection procedures between 5GC and external DN. Lifelines: UE, SMF or SMF+PGW-C, PSA UPF or UPF+PGW-U/LAC, DN AAA server, LNS (in DN). The diagram illustrates the interaction for PDU Session/PDN Connection establishment, L2TP tunnel setup, and L2TP session setup.](3750b0149a6380885998ab3ca6a8787c_img.jpg) + +``` + +sequenceDiagram + participant UE + participant SMF as SMF or SMF+PGW-C + participant UPF as PSA UPF or UPF+PGW-U/LAC + participant AAA as DN AAA server + participant LNS as LNS (in DN) + + Note over SMF, UPF: L2TP Support Negotiation between CP and UP in 5GC + SMF->>UPF: L2TP Support Negotiation between CP and UP in 5GC + UPF-->>SMF: L2TP Support Negotiation between CP and UP in 5GC + + UE->>SMF: 1. PDU Session/PDN Connection Establishment Request (PCO:username, password) + SMF-->>UPF: Access Request/AAR + UPF-->>AAA: Access Request/AAR + AAA-->>UPF: Access Response/AAA + UPF-->>SMF: Access Response/AAA + + SMF->>UPF: 3. PFCP Session Establishment Request (L2TP Connection Information) + UPF->>LNS: SCCRQ: Start-Control-Connection-Request + LNS-->>UPF: SCCRP: Start-Control-Connection-Reply + UPF->>LNS: SCCCN: Start-Control-Connection-Connected + LNS-->>UPF: ZLB ACK: Zero-Length Body Acknowledge + + Note over SMF, UPF: 4. L2TP Tunnel Setup (if required) + SMF-->>UPF: 5. PFCP Session Establishment Response (L2TP Connection failure) + + SMF-->>UE: 6. PDU Session/PDN Connection Establishment Response + + Note over SMF, UPF: 7. L2TP Session Setup + UPF->>LNS: ICRQ: Incoming-Call-Request + LNS-->>UPF: ICRP: Incoming-Call-Reply + UPF->>LNS: ICCN: Incoming-Call-Connected + LNS-->>UPF: ZLB ACK: Zero-Length Body Acknowledge + + SMF->>UPF: 8. PFCP Session Establishment Response (Created L2TP Connection) + UPF-->>UE: 9. PDU Session/PDN Connection Establishment Response + + Note over UE, LNS: User Data Session + +``` + +Sequence diagram showing L2TP connection procedures between 5GC and external DN. Lifelines: UE, SMF or SMF+PGW-C, PSA UPF or UPF+PGW-U/LAC, DN AAA server, LNS (in DN). The diagram illustrates the interaction for PDU Session/PDN Connection establishment, L2TP tunnel setup, and L2TP session setup. + +**Figure 18.1-2: L2TP connection procedures between 5GC and external DN** + +0. The SMF or SMF+PGW-C and the UPF or UPF+PGW-U negotiated supporting L2TP feature as specified in 3GPP TS 29.244 [114]. + 1. The SMF or SMF+PGW-C receives a PDU Session or PDN Connection establishment request from the UE via AMF or MME and SGW. +- The UE may include the authentication information for PAP and/or CHAP in ePCO IE. The SMF or SMF+PGW-C may locally configure the UE authentication information for a given DNN. +- The SMF or SMF+PGW-C may determine that an L2TP session is required for the PDU Session based on local configured L2TP parameters per DNN. +2. The SMF or SMF+PGW-C may receive the L2TP Tunnel parameters (e.g. LNS IP address or FQDN, tunnel password) from the DN-AAA server in Access-Accept message or Diameter AAA message, or local configured. + +NOTE: If EAP based secondary authentication is used (e.g. DER/DEA), L2TP Proxy Authenticate Extensions for EAP is not supported in this release of the specification. + +3. If L2TP protocol is determined to support the PDU Session, the SMF or SMF+PGW-C selects a UPF or UPF+PGW-U supporting L2TP and be configured with the LAC name/addresses and then requests the UPF or UPF+PGW-U to setup an L2TP tunnel if needed and/or L2TP session towards the L2TP network server (LNS). + +The SMF or SMF+PGW-C sends PFCP Session Establishment Request to the UPF or UPF+PGW-U, which may include L2TP Tunnel Information for setting up a L2TP tunnel and L2TP session information to setup a L2TP session, together with the information for authentication used during L2TP Tunnel setup, as well as for L2TP session. + +The L2TP Tunnel Information includes LNS IPv4 address or IPv6 address of LNS, Tunnel Password. + +The L2TP Session Information includes specific information related to the PDU Session, e.g. a Calling Number which may be set to UE's GPSI, an indication to instruct that the UPF or UPF+PGW-U shall request the LNS to allocate an IP address for the PDU Session, indications to instruct that the UPF or UPF+PGW-U shall request the LNS to provide DNS server addresses or NBNS server addresses etc. as specified in 3GPP TS 29.244 [114]. + +4. The UPF or UPF+PGW-U checks if any existing L2TP tunnel can be used to serve the PDU Session according to the information provided in the L2TP Tunnel Information. + +If the UPF or UPF+PGW-U decides to setup a new L2TP tunnel, it initiates L2TP Tunnel establishment by sending an SCCRQ (Start-Control-Connection-Request) message towards the LNS, the UPF or UPF+PGW-U will allocate a Tunnel ID, and it may include a CHAP Challenge to authenticate the LNS. The Challenge and Challenge Response (to be included in SCCCN) is produced by the UPF or UPF+PGW-U using the Tunnel Password received from the SMF or SMF+PGW-C. + +The LNS responds with an SCCRP (Start-Control-Connection-Reply) message, containing its allocated Tunnel ID and a CHAP Challenge Response to the Challenge in SCCRQ. + +The UPF or UPF+PGW-U then responds with a Challenge response for tunnel authentication in the SCCCN (Start-Control-Connection-Connected) message. An L2TP tunnel is established after the tunnel authentication is successful, with the reception of the SCCCN message sent by the LAC to the LNS. + +If the UPF or UPF+PGW-U decides to use an already existing L2TP tunnel for the requested PDU Session from the UPF or UPF+PGW-C, it proceeds with step 5 below directly without current step. + +5. If the L2TP tunnel is not successfully established, then the UPF or UPF+PGW-U may respond to the SMF or SMF+PGW-C with PFCP Session Establishment Response with error cause IE value set to either 87 or 89 as specified in clause 8.2.1 of TS 29.244 [114]. The SMF, SMF+PGW-C may decide how to handle the failure associated with the received cause code based on local policy and/or O&M procedures. +6. SMF or SMF+PGW-C may reject the PDU Session/PDN Connection Establishment Request according to step 5. +7. Once the L2TP Tunnel is established (or already present) between the LAC and the LNS for the PDU Session/PDN Connection requested by the UE, the UPF or UPF+PGW-U proceeds with L2TP session setup towards the LNS. + +The UPF or UPF+PGW-U sends an ICRQ (Incoming-Call-Request) message towards the LNS, which contains the Tunnel ID assigned by the LNS, its assigned Session ID, and optionally, the Calling Number and Called Number. The LNS responds with an ICRP (Incoming-Call-Reply) message and provides the Session ID assigned by it to the LAC. + +The LAC then sends an ICCN (Incoming-Call-Connected) message. If proxy LCP and authentication are employed, the ICCN message includes link control parameters (e.g. MRU) and the UE authentication information sent from the SMF or SMF+PGW-C which was received via ePCO IE in step 1. In addition, the UPF or UPF+PGW-U (LAC) will act as a PPP endpoint to use IPCP to request UE IP Address, DNS server address and/or NBNS server address(es). + +The LCP renegotiation may be triggered by the LNS after receiving the ICCN message. If so, the LAC and LNS will use PPP LCP to communicate link specific control parameter, and indicate authentication type, then either PPP PAP/CHAP takes place. The PPP IPCP transactions takes place to retrieve UE IP Address, DNS server address and/or NBNS server address. + +8. The status of the L2TP session setup is sent by the UPF or UPF+PGW-U to the SMF or SMF+PGW-C in a PFCP Session Establishment Response. + +9. The SMF or SMF+PGW-C sends a PDU Session Establishment Response to the UE and the user data session is initiated, which may contain the DNS and NBNS Server information. + +# --- 19 Interworking with Credentials Holder using AAA server + +## 19.1 Credentials Holder using AAA server for primary authentication and authorization + +The AUSF and the UDM in SNPN may support primary authentication and authorization of UEs using credentials from an AAA Server in a Credentials Holder (CH). + +- Upon the UDM decides that the primary authentication is performed by AAA Server with credentials holder and inform the AUSF that primary authentication by a AAA server in a CH is required, the AUSF shall discover and select the NSSAAF, and then forward EAP messages to the NSSAAF. +- The NSSAAF selects AAA Server based on the domain name corresponds to the realm part of the SUPI, relays EAP messages between AUSF and AAA Server (or AAA proxy) and performs related protocol conversion. The AAA server acts as the EAP Server for the purpose of primary authentication. + +NOTE: The UDM in SNPN, based on SLA between Credentials Holder and SNPN, is pre-configured with information indicating whether the UE needs primary authentication from AAA server. + +5G System architecture with access to SNPN using credentials from Credentials Holder using AAA Server and related functions are defined in clause 5.30.2.9 of 3GPP TS 23.501 [2]. + +## 19.2 Credentials Holder using AAA server for primary authentication procedure + +The procedures described in this clause enables UEs to access an SNPN which makes use of a credential management system managed by a credential provider external to the SNPN. + +In this scenario the authentication server role is taken by the AAA Server. The AUSF acts as EAP authenticator and interacts with the AAA Server to execute the primary authentication procedure. + +![Sequence diagram for Primary authentication with external domain. The diagram shows the interaction between UE, AMF/SEAF, AUSF, UDM, NSSAAF, and AAA Server. The process involves registration, authentication requests, method selection, and EAP authentication steps.](1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg) + +``` + +sequenceDiagram + participant UE + participant AMF/SEAF + participant AUSF + participant UDM + participant NSSAAF + participant AAA Server + + Note right of UDM: 4. Authentication Method Selection + + UE->>AMF/SEAF: 1. Registration Request (SUCI in NAI format) + AMF/SEAF->>AUSF: 2. Nausf_UEAU_Authenticate Req (SUCI, SN-name) + AUSF->>UDM: 3. Nudm_UEAU_Get Req (SUCI, SN name) + Note right of UDM: 4. Authentication Method Selection + UDM->>AUSF: 5. Nudm_UEAU_Get Resp (SUPI, AuthMethod) + AUSF->>NSSAAF: 6. Nnssaaif_AIAF_Authenticate Req (SUPI) + NSSAAF->>AAA Server: 7. AAA (EAP-Response / Identity (SUPI)) + Note over UE, AAA Server: 8. EAP authentication + AAA Server->>NSSAAF: 9. AAA (EAP success, SUPI, MSK) + NSSAAF->>AUSF: 10. Nnssaaif_AIAF_Authenticate Resp (EAP succes, SUPI, MSK) + Note right of AUSF: 11. K_ausf calculated from MSK + AUSF->>AMF/SEAF: 12. Nausf_UEAU_Authenticate Resp (EAP Success, K_seaf, SUPI) + AMF/SEAF->>UE: 13. N1 (EAP Success, ngKSI, ABBA) + Note left of UE: 14. K_ausf calculated from MSK + +``` + +Sequence diagram for Primary authentication with external domain. The diagram shows the interaction between UE, AMF/SEAF, AUSF, UDM, NSSAAF, and AAA Server. The process involves registration, authentication requests, method selection, and EAP authentication steps. + +Figure 19.2-1: Primary authentication with external domain + +The detail procedures description is defined in clause I.2.2.2 of 3GPP TS 33.501 [59]. + +# 20 Interworking with MBS Application Provider (AF/AS) + +## 20.1 General + +For MBS user plane, the MB-UPF is used for interworking with the MBS AF/AS (i.e. MBS Application Provider) either directly via the N6mb reference point or via the MBSTF. In the latter case, the MB-UPF is interworking with the MBSTF via the Nmb9 reference point and the MBSTF is interworking with the MBS AF/AS via the Nmb8 reference point. + +For MBS Group Message Delivery user plane, the MB-UPF is used for interworking with the NEF via the MBSTF. The MB-UPF is interworking with the MBSTF via the Nmb9 reference point and the MBSTF is interworking with the NEF (which plays the role of the MBS AF/AS) via the Nmb14 reference point. + +## 20.2 MBS interworking user plane reference point architecture + +Figure 20.2-1 depicts the reference point representation of the MBS user plane interworking architecture. + +![Figure 20.2-1: MBS user plane interworking architecture – Reference point representation. The diagram shows four main components: MB-UPF, MBSTF, NEF, and MBS AF/AS. MB-UPF is connected to MBSTF via the Nmb9 interface. MBSTF is connected to MBS AF/AS via the Nmb8 interface. MB-UPF is also connected to MBS AF/AS via the N6mb interface. NEF is connected to MBSTF via the Nmb14 interface.](d2417b04116c354deccb25d98a84a0fb_img.jpg) + +Figure 20.2-1: MBS user plane interworking architecture – Reference point representation. The diagram shows four main components: MB-UPF, MBSTF, NEF, and MBS AF/AS. MB-UPF is connected to MBSTF via the Nmb9 interface. MBSTF is connected to MBS AF/AS via the Nmb8 interface. MB-UPF is also connected to MBS AF/AS via the N6mb interface. NEF is connected to MBSTF via the Nmb14 interface. + +**Figure 20.2-1: MBS user plane interworking architecture – Reference point representation** + +NOTE 1: From functionality point of view, Nmb9 and N6mb are identical, as specified in 3GPP TS 23.247 [60]. + +For MBS group message delivery, the NEF (playing the role of an MBS AF/AS) shall be responsible for user plane delivery of MBS group message content to the MBSTF over the Nmb14 interface, as specified in clauses 6.15 and 7.5 of 3GPP TS 23.247 [60]. + +When MBS is used to support VAL services provisioning as specified in clauses 14.2.2.1 and 14.3.4A of 3GPP TS 23.434 [63], the SEAL NRM Server shall play the role of the MBS AF/AS for MBS user plane management over the Nmb8 and Nmb9 interfaces or the N6mb interface. + +## 20.3 User Plane Protocol between MB-UPF and MBS AF/AS or MBSTF + +The MBS user plane interworking protocol stack in the case of shared MBS delivery is described in Figure 20.3-1 and Figure 20.3-2. In Figure 20.3-1, the UDP tunnel applies to N6mb and Nmb9, while in Figure 20.3-2, the plain IP multicast applies to N6mb. + +![Figure 20.3-1: User Plane Protocol Stack for N6mb/Nmb9 (UDP Tunnel). The diagram shows the protocol stack for MB-UPF and AF/MBSTF. The MB-UPF stack has four layers: Relay (containing GTP-U and UDP), UDP/IP, L2, and L1. The AF/MBSTF stack has four layers: UDP, IP (UC), L2, and L1. The two stacks are connected via the N6mb/Nmb9 interface.](2e8dcf3d807269a64340a9c292ea7f5d_img.jpg) + +| | | | +|--------|---------|----------| +| Relay | | | +| GTP-U | UDP | UDP | +| UDP/IP | IP (UC) | IP (UC) | +| L2 | L2 | L2 | +| L1 | L1 | L1 | +| MB-UPF | | AF/MBSTF | + +N6mb/Nmb9 + +Figure 20.3-1: User Plane Protocol Stack for N6mb/Nmb9 (UDP Tunnel). The diagram shows the protocol stack for MB-UPF and AF/MBSTF. The MB-UPF stack has four layers: Relay (containing GTP-U and UDP), UDP/IP, L2, and L1. The AF/MBSTF stack has four layers: UDP, IP (UC), L2, and L1. The two stacks are connected via the N6mb/Nmb9 interface. + +**Figure 20.3-1: User Plane Protocol Stack for N6mb/Nmb9 (UDP Tunnel)** + +![Figure 20.3-2: User Plane Protocol Stack for N6mb (plain IP multicast). The diagram shows two protocol stacks separated by a vertical dashed line labeled 'N6mb'. The left stack, labeled 'MB-UPF', has a 'Relay' section at the top with two 'IP (MC)' boxes. Below this are layers: 'GTP-U' and 'L2', 'UDP/IP' and 'L1', 'L2', and 'L1'. The right stack, labeled 'AF', has layers: 'IP (MC)', 'L2', and 'L1'.](18003425d0e8638dde4acc9c5c468c5c_img.jpg) + +Figure 20.3-2: User Plane Protocol Stack for N6mb (plain IP multicast). The diagram shows two protocol stacks separated by a vertical dashed line labeled 'N6mb'. The left stack, labeled 'MB-UPF', has a 'Relay' section at the top with two 'IP (MC)' boxes. Below this are layers: 'GTP-U' and 'L2', 'UDP/IP' and 'L1', 'L2', and 'L1'. The right stack, labeled 'AF', has layers: 'IP (MC)', 'L2', and 'L1'. + +Figure 20.3-2: User Plane Protocol Stack for N6mb (plain IP multicast) + +## 20.4 User Plane Protocol between MBSTF and MBS AF/AS or NEF + +The MBS user plane interworking protocol stack used over the Nmb8 reference point is described in Figure 20.4-1 for the case of TCP/IP for the Object Distribution Method, and in Figure 20.4-2 for the case of UDP/IP for the Packet Distribution Method with Proxy mode or Forward-only mode. The MBS user plane interworking protocol stack over the Nmb14 reference point shall be the same as the MBS user plane interworking protocol stack over the Nmb8 interface described in Figures 20.4-1 and 20.4-2 with the NEF playing the role of the AF/AS. + +![Figure 20.4-1: User Plane Protocol Stack for Nmb8/Nmb14 used in Object Distribution Method. The diagram shows two protocol stacks separated by a vertical dashed line labeled 'Nmb8 or Nmb14'. The left stack, labeled 'MBSTF', has layers: 'UDP' and 'TCP', 'IP (multicast)' and 'IP (unicast)', and 'MBS' and 'Lower Layers'. The right stack, labeled 'AF/AS or NEF', has layers: 'TCP', 'IP (unicast)', and 'Lower Layers'. An arrow points from the 'Lower Layers' of the right stack to the 'Lower Layers' of the left stack.](c5c767928d086da5347036f88309fc7a_img.jpg) + +Figure 20.4-1: User Plane Protocol Stack for Nmb8/Nmb14 used in Object Distribution Method. The diagram shows two protocol stacks separated by a vertical dashed line labeled 'Nmb8 or Nmb14'. The left stack, labeled 'MBSTF', has layers: 'UDP' and 'TCP', 'IP (multicast)' and 'IP (unicast)', and 'MBS' and 'Lower Layers'. The right stack, labeled 'AF/AS or NEF', has layers: 'TCP', 'IP (unicast)', and 'Lower Layers'. An arrow points from the 'Lower Layers' of the right stack to the 'Lower Layers' of the left stack. + +Figure 20.4-1: User Plane Protocol Stack for Nmb8/Nmb14 used in Object Distribution Method + +![Figure 20.4-2: User Plane Protocol Stack for Nmb8/Nmb14 used in Packet Distribution Method with Proxy mode or Forward-only mode. The diagram shows two protocol stacks separated by a vertical dashed line representing the Nmb8 or Nmb14 interface. The left stack, labeled MBSTF, consists of three layers: UDP (top), IP (middle), and Lower Layers (bottom). The right stack, labeled AF/AS or NEF, also consists of three layers: UDP (top), IP (middle), and Lower Layers (bottom). Arrows indicate data flow from the right stack to the left stack through the interface.](0dfdff10c725fe9c332b07ade9d23a5e_img.jpg) + +Figure 20.4-2: User Plane Protocol Stack for Nmb8/Nmb14 used in Packet Distribution Method with Proxy mode or Forward-only mode. The diagram shows two protocol stacks separated by a vertical dashed line representing the Nmb8 or Nmb14 interface. The left stack, labeled MBSTF, consists of three layers: UDP (top), IP (middle), and Lower Layers (bottom). The right stack, labeled AF/AS or NEF, also consists of three layers: UDP (top), IP (middle), and Lower Layers (bottom). Arrows indicate data flow from the right stack to the left stack through the interface. + +**Figure 20.4-2: User Plane Protocol Stack for Nmb8/Nmb14 used in Packet Distribution Method with Proxy mode or Forward-only mode** + +NOTE: For more details, refer to Annex B of 3GPP TS 26.502 [61]. + +# 21 Interworking with AAA server in DCS for UE onboarding in SNPNs + +## 21.0 General + +A UE configured with Default UE credentials shall consist of the credentials for primary authentication and may optionally consist of the credentials for secondary authentication, may register with an ON-SNPN for the provisioning of SO-SNPN credentials, for the purpose of provisioning the UE with SNPN credentials for primary authentication and other information to enable access to a desired SNPN, i.e. (re-)select and (re-)register with SNPN. + +The architectures for Onboarding of UEs in an ON-SNPN are defined in clause 5.30.2.10.2. of 3GPP TS 23.501 [2]. + +## 21.1 Primary authentication using AAA server in DCS + +The AUSF in SNPN may support primary authentication and authorization of UEs using default UE credentials meant only for primary authentication from a Default Credentials Server (DCS) for Onboarding of UEs in an ON-SNPN. In case of primary authentication and authorization with an AAA server in DCS the procedures defined in clause 19.1 and clause 19.2 shall apply with the AAA server in DCS taking the role of the AAA server in a CH. When AAA server in DCS is used for primary authentication, the AUSF directly selects the NSSAAF as specified in 3GPP TS 23.501 [2]. In this case, the UDM is not involved in the procedure defined in Figure 19.2-1, and the step 3 to step 5 shall be skipped. + +## 21.2 Secondary authentication using AAA server in DCS + +The SMF in SNPN may support secondary authentication with a Default Credentials Server (DCS) using default UE credentials meant only for secondary authentication upon establishment of an Onboarding PDU Session when the UE has registered successfully with primary authentication without using DCS. In case of secondary authentication with AAA server in DCS the procedures defined in clause 11 and clause 12 shall apply with the AAA server in DCS taking the role of the DN-AAA server. When AAA server in DCS is used for secondary authentication, the SMF selects the AAA server based on its configuration or using the DN-specific identity provided by the UE inside the EAP message in the PDU Session Authentication Complete message as specified in 3GPP TS 33.501 [8]. + +# --- Annex A (normative): Rate control related to 5G Cellular Internet of Things (CIoT) optimisations + +## A.1 General + +The present annex defines specific requirements for rate control related to 5G CIoT optimisations. + +## --- A.2 Support of rate control of user data + +### A.2.1 General + +The rate of user data sent to and from a UE (e.g. a UE using 5G CIoT Optimizations) can be controlled in two different ways: + +- Serving PLMN rate control +- Small data rate control + +Serving PLMN rate control is further described in 3GPP TS 23.501 [2]. + +Small data rate control allows HPLMN operators on per user to control the amount of user data sent DL and UL. This is done with help of policing user data on a maximum number of user data packets per time unit both DL and UL. Small data DL rate control policing is done in the UPF or the NEF and the small data UL rate control policing is done in the UE. The UPF or NEF can also do small data UL rate control policing. + +For further information on small data rate control in the UE, see 3GPP TS 24.501 [42]. + +NOTE 1: Existing Session-AMBR mechanisms are not suitable for such a service since, for radio efficiency and UE battery life reasons, an AMBR of e.g. > 100kbit/s is desirable and such an AMBR translates to a potentially large daily data volume. + +NOTE 2: For serving PLMN rate control and small data rate control, whether the UPF or the NEF is used for data policing depends on the CIoT Optimizations mode that UE and network support (CP or UP Optimizations) and the UE subscription data. + +### A.2.2 Small Data Rate Control + +The small data rate control is configured in the (H-)SMF. + +The small data rate control parameters, if configured, shall consist of: + +- the maximum number of DL user data packets per time unit, +- the maximum number of UL user data packets per time unit, and +- the maximum number of additional UL exception reports per time unit. + +Possible time units shall be, minute, hour, day or week. + +If the small data rate control is supported by the UE as indicated in the Extended Protocol Configuration Options (ePCO) IE included in the PDU session establishment request and if the (H-)SMF is configured to use small data rate control, the (H-)SMF shall include the configured small data UL rate control parameters in the ePCO IE of the PDU session establishment reply, and send the configured small data DL rate control parameters and optionally the UL rate control parameters to the UPF or the NEF. The small data rate control parameters sent to UE, UPF or NEF may include + +a remaining small data rate control with validity time information that shall be applied first before applying the configured small data rate control parameters. + +NOTE 1: The (H-)SMF can receive small data rate control parameters from the AMF. + +See 3GPP TS 24.501 [42] for ePCO IE definition. + +If the small data UL rate control parameters are modified, the (H-)SMF shall initiate a PDU session modification procedure and include the small data UL rate control parameters in the ePCO IE. The (H-)SMF may also send the updated small data UL rate control parameters to the UPF or the NEF. + +If the small data DL rate control parameters are modified, the (H-)SMF shall send the updated small data DL rate control parameters to the UPF or the NEF. + +The UPF or the NEF shall enforce the small data DL rate control and may enforce the small data UL rate control per UE. + +NOTE 2: The UE locally enforces this uplink small data rate control instruction. The UE considers this small data rate control instruction as valid until it receives a new one from the (H-)SMF. + +### A.2.3 Serving PLMN Rate Control information handling + +The serving PLMN rate control is configured in the (V-)SMF and it applies per PDU session. + +This rate control is operator configurable and expressed as "X NAS Data PDUs per deci hour" where X is an integer that shall not be less than 10. There are separate limits for uplink and downlink NAS Data PDUs: + +If serving PLMN rate control information is received from the SMF, the UPF or the NEF shall store this information and use that for DL rate control enforcement for this UE. + +The UE shall enforce the serving PLMN UL rate control based on the rate control information received from the (V-)SMF. + +The (V-)SMF may also enforce the serving PLMN UL and/or DL rate control. + +If the UPF or the NEF previously have received Serving PLMN rate control information, it shall behave as follows: + +- If the UPF or the NEF receives new Serving PLMN rate control information from the SMF, it shall replace the old Serving PLMN rate control information with the new Serving PLMN rate control information and use that for DL rate control enforcement for this UE. +- If the UPF or the NEF receives no Serving PLMN rate control information from the SMF, it shall still consider the latest received Serving PLMN rate control information from the SMF as valid. +- If UPF or the NEF receives an indication that Serving PLMN rate control does not apply from the SMF, it shall remove the rate control information based on Serving PLMN rate control information. + +Small data rate control, if configured, also applies for the same PDU session, see clause A.2.2. + +# --- Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | | | | | | TS skeleton of interworking between 5G Network and external Data Networks | 0.0.0 | +| 2017-11 | CT3#92 | C3-175380 | | | | Update after CT3#92; inclusion of C3-175241, C3-175286, C3-175287, C3-175288, C3-175289. | 0.1.0 | +| 2017-12 | CT3#93 | C3-176400 | | | | Update after CT3#93; TS number changed to 29.561 and inclusion of C3-176265, C3-176266. | 0.2.0 | +| 2018-01 | CT3#94 | C3-180365 | | | | Update after CT3#94; inclusion of C3-180264, C3-180126, C3-180348, C3-180129, C3-180130. | 0.3.0 | +| 2018-03 | CT3#95 | C3-181371 | | | | Update after CT3#95; inclusion of C3-181043, C3-181044, C3-181261, C3-181047, C3-181099. | 0.4.0 | +| 2018-04 | CT3#96 | C3-182519 | | | | Update after CT3#96; inclusion of C3-182183, C3-182381, C3-182382, C3-182383. | 0.5.0 | +| 2018-06 | CT3#97 | C3-183917 | | | | Update after CT3#97; inclusion of C3-183308, C3-183309, C3-183310, C3-183318, C3-183319, C3-183717, C3-183321, C3-183325, C3-183326, C3-183327, C3-183729. | 0.6.0 | +| 2018-06 | CT#80 | CP-181027 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181027 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 2 | F | Add multihoming support in IPv6 stateless address autoconfiguration | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0002 | 1 | F | IP address change | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0003 | 1 | F | MAC address change | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | - | F | Final result of authentication/authorization from the DN-AAA – Receiving entity | 15.1.0 | +| 2019-06 | CT#84 | CP-191188 | 0006 | 4 | F | Correct session AMBR | 15.2.0 | +| 2019-06 | CT#84 | CP-191070 | 0005 | - | B | Rate control for 5G C IoT | 16.0.0 | +| 2019-09 | CT#85 | CP-192150 | 0008 | | A | 3GPP VSA presence for RADIUS | 16.1.0 | +| 2019-09 | CT#85 | CP-192169 | 0010 | 1 | B | Add DN-AAA re-authentication | 16.1.0 | +| 2019-09 | CT#85 | CP-192150 | 0012 | | A | Correct DN-AAA authentication | 16.1.0 | +| 2019-09 | CT#85 | CP-192150 | 0014 | 2 | A | Correct DN-AAA authorization | 16.1.0 | +| 2019-09 | CT#85 | CP-192137 | 0017 | 1 | F | Correct small data rate control status | 16.1.0 | +| 2019-09 | CT#85 | CP-192159 | 0018 | 2 | B | IP address allocation via DHCP/AAA Server | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0019 | 1 | B | DN interworking of UPF for PIM | 16.1.0 | +| 2019-12 | CT#86 | CP-193200 | 0022 | 1 | B | Support Slice Specific authentication | 16.2.0 | +| 2020-03 | CT#87e | CP-200210 | 0023 | 2 | B | Call flows of NSSAA procedures | 16.3.0 | +| 2020-03 | CT#87e | CP-200198 | 0024 | - | F | Resolve editor note for PLMN rate control | 16.3.0 | +| 2020-03 | CT#87e | CP-200211 | 0025 | - | F | IP address pool id encoding | 16.3.0 | +| 2020-06 | CT#88e | CP-201226 | 0027 | 1 | A | Correct access challenge | 16.4.0 | +| 2020-06 | CT#88e | CP-201247 | 0028 | - | B | Support secondary RAT data usage report | 16.4.0 | +| 2020-06 | CT#88e | CP-201236 | 0030 | - | F | Replacing AUSF by NSSAAF to support NSSAA | 16.4.0 | +| 2020-06 | CT#88e | CP-201237 | 0031 | - | F | IP address pool id in accounting and its IP version | 16.4.0 | +| 2020-06 | CT#88e | CP-201247 | 0033 | 1 | F | Correct AMF and SMF address | 16.4.0 | +| 2020-06 | CT#88e | CP-201274 | 0034 | 1 | B | Subscription trigger request UE IP address from DN-AAA server | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0035 | 1 | B | Ipv6 Prefix Delegation via DHCPv6 | 16.4.0 | +| 2020-06 | CT#88e | CP-201331 | 0036 | 1 | F | Remove the feature for ip address pool | 16.4.0 | +| 2020-09 | CT#89e | CP-202057 | 0040 | 1 | A | Correction to 3GPP-UE-MAC-Address | 16.5.0 | +| 2020-09 | CT#89e | CP-202057 | 0042 | 1 | A | Correction on the authentication and authorization procedure | 16.5.0 | +| 2020-09 | CT#89e | CP-202057 | 0046 | - | A | Correction to the Session-AMBR | 16.5.0 | +| 2020-09 | CT#89e | CP-202067 | 0049 | - | F | Add missing applicable messages for IP pool info | 16.5.0 | +| 2020-09 | CT#89e | CP-202081 | 0048 | 1 | F | List of allowed VLAN Ids within DN authorization data | 16.5.0 | +| 2020-09 | CT#89e | CP-202057 | 0054 | - | A | Correction on the authorization data | 16.5.0 | +| 2020-09 | CT#89e | CP-202060 | 0055 | - | F | RAT Type extension for 5WWC | 16.5.0 | +| 2020-09 | CT#89e | CP-202059 | 0056 | - | F | User Location extension for 5WWC | 16.5.0 | +| 2020-12 | CT#90e | CP-203121 | 0060 | - | A | Correction on the Acct-Session-Id | 16.6.0 | +| 2020-12 | CT#90e | CP-203143 | 0064 | 1 | F | Correct SGSN address | 16.6.0 | +| 2020-12 | CT#90e | CP-203123 | 0066 | 1 | F | Correct applicability for User Location extension | 16.6.0 | +| 2020-12 | CT#90e | CP-203150 | 0067 | - | F | Correct network identifier for SNPn | 16.6.0 | +| 2020-12 | CT#90e | CP-203123 | 0069 | - | F | Updates to IPv6 Prefix Delegation | 16.6.0 | +| 2020-12 | CT#90e | CP-203099 | 0072 | 2 | A | Correction on PAP/CHAP supporting Rel-15 N1 mode UE | 16.6.0 | +| 2020-12 | CT#90e | CP-203134 | 0058 | 1 | B | Adding a note for IPv4/IPv6 Non-transparent access to DN using PAP/CHAP | 17.0.0 | +| 2020-12 | CT#90e | CP-203134 | 0061 | 1 | B | Adding PAP/CHAP in RADIUS message flow(successful case) | 17.0.0 | +| 2020-12 | CT#90e | CP-203134 | 0062 | 1 | B | Adding PAP/CHAP in Diameter message flow(successful case) | 17.0.0 | +| 2020-12 | CT#90e | CP-203144 | 0068 | - | F | Corrections to IPv6 | 17.0.0 | +| 2020-12 | CT#90e | CP-203147 | 0070 | 1 | F | Corrections on SMF directly connecting DN-AAA server | 17.0.0 | +| 2021-03 | CT#91e | CP-210226 | 0076 | 1 | B | Interworking scenario support | 17.1.0 | +| 2021-03 | CT#91e | CP-210226 | 0077 | 1 | B | Reporting Session S-NSSAI to RADIUS DN-AAA server | 17.1.0 | +| 2021-03 | CT#91e | CP-210226 | 0078 | 1 | B | Reporting Session S-NSSAI to Diameter DN-AAA server | 17.1.0 | +| 2021-03 | CT#91e | CP-210227 | 0079 | 3 | B | Reporting FQDN of CHF to RADIUS DN-AAA server | 17.1.0 | +| 2021-03 | CT#91e | CP-210227 | 0080 | 1 | B | Reporting FQDN of CHF to Diameter DN-AAA server | 17.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------|--------| +| 2021-03 | CT#91e | CP-210226 | 0081 | 1 | B | Reporting FQDN of Serving NF to RADIUS DN-AAA server | 17.1.0 | +| 2021-03 | CT#91e | CP-210226 | 0082 | - | B | Report FQDN of Serving NF to Diameter DN-AAA server | 17.1.0 | +| 2021-03 | CT#91e | CP-210214 | 0083 | 2 | F | Update descriptions for PAP/CHAP in RADIUS message flow | 17.1.0 | +| 2021-03 | CT#91e | CP-210214 | 0084 | 2 | F | Update descriptions for PAP/CHAP in Diameter message flow | 17.1.0 | +| 2021-03 | CT#91e | CP-210214 | 0085 | 1 | B | 5GS interworking with EPS for IPv4IPv6 Non-transparent access using PAPCHAP | 17.1.0 | +| 2021-03 | CT#91e | CP-210241 | 0088 | 1 | B | 5GS interworking with EPS for EAP based secondary AUTH in RADIUS message flow | 17.1.0 | +| 2021-03 | CT#91e | CP-210241 | 0089 | 1 | B | 5GS interworking with EPS for EAP based secondary AUTH in Diameter message flow | 17.1.0 | +| 2021-03 | CT#91e | CP-210214 | 0090 | 1 | F | Update clarification for PAP/CHAP in RADIUS message flow | 17.1.0 | +| 2021-03 | CT#91e | CP-210214 | 0091 | 1 | F | Update clarification for PAP/CHAP in Diameter message flow | 17.1.0 | +| 2021-03 | CT#91e | CP-210228 | 0092 | 1 | B | 5GC Support of DHCP signalling for RG | 17.1.0 | +| 2021-03 | CT#91e | CP-210202 | 0093 | 1 | A | Reporting GCI to RADIUS DN-AAA server | 17.1.0 | +| 2021-03 | CT#91e | CP-210202 | 0094 | 1 | A | Reporting GCI to Diameter DN-AAA server | 17.1.0 | +| 2021-06 | CT#92e | CP-211211 | 0097 | 1 | F | Clarification of accounting for the interworking scenario | 17.2.0 | +| 2021-06 | CT#92e | CP-211211 | 0102 | 1 | B | Updates 5GS interworking with EPS for EAP based re-auth in Diameter message flow | 17.2.0 | +| 2021-06 | CT#92e | CP-211209 | 0105 | 1 | A | Correction to Framed IP | 17.2.0 | +| 2021-06 | CT#92e | CP-211211 | 0106 | 1 | F | Complete AAA triggered re-authentication flow for Diameter | 17.2.0 | +| 2021-06 | CT#92e | CP-211280 | 0107 | 3 | B | Updates to support L2TP for CUPS | 17.2.0 | +| 2021-06 | CT#92e | CP-211280 | 0108 | 2 | B | Updates to support L2TP in RADIUS message flow | 17.2.0 | +| 2021-06 | CT#92e | CP-211280 | 0109 | 2 | B | Updates to support L2TP in Diameter message flow | 17.2.0 | +| 2021-06 | CT#92e | CP-211211 | 0110 | 1 | F | Correction to Framed Route information | 17.2.0 | +| 2021-06 | CT#92e | CP-211281 | 0111 | 1 | B | Adding support for providing L2TP information through N6 interface | 17.2.0 | +| 2021-06 | CT#92e | CP-211244 | 0112 | 1 | B | Reporting UE local IP to RADIUS DN-AAA server | 17.2.0 | +| 2021-06 | CT#92e | CP-211244 | 0113 | 1 | B | Reporting UE local IP to Diameter DN-AAA server | 17.2.0 | +| 2021-09 | CT#93e | CP-212197 | 0116 | 1 | B | L2TP information provision | 17.3.0 | +| 2021-09 | CT#93e | CP-212197 | 0119 | - | F | Fix L2TP procedure | 17.3.0 | +| 2021-09 | CT#93e | CP-212216 | 0121 | - | F | Correct PAP/CHAP description | 17.3.0 | +| 2021-09 | CT#93e | CP-212224 | 0122 | - | F | Fix DN-AAA initiated re-authentication | 17.3.0 | +| 2021-09 | CT#93e | CP-212224 | 0123 | 1 | F | Addressing impersonate attack from AAA-S | 17.3.0 | +| 2021-09 | CT#93e | | | | | Notes and editor notes formatting issues fixed | 17.3.1 | +| 2021-12 | CT#94e | CP-213243 | 0124 | 1 | B | Reporting DNAI to RADIUS DN-AAA server | 17.4.0 | +| 2021-12 | CT#94e | CP-213243 | 0125 | 1 | B | Reporting DNAI to Diameter DN-AAA server | 17.4.0 | +| 2022-03 | CT#95e | CP-220206 | 0127 | | B | Accounting correlation for redundant transmission | 17.5.0 | +| 2022-03 | CT#95e | CP-220196 | 0128 | | F | Correct 3GPP-Session-Id | 17.5.0 | +| 2022-03 | CT#95e | CP-220208 | 0129 | | B | Update the 3GPP-RAT-Type AVP to support NR RedCap access type | 17.5.0 | +| 2022-03 | CT#95e | CP-220182 | 0130 | | B | Interworking with CH using AAA server | 17.5.0 | +| 2022-06 | CT#96 | CP-221157 | 0131 | 1 | B | Adding Charging Id to support roaming scenario | 17.6.0 | +| 2022-06 | CT#96 | CP-221157 | 0132 | 1 | F | DN-AAA initiated re-auth when UE is not reachable in 5GS | 17.6.0 | +| 2022-06 | CT#96 | CP-221158 | 0133 | 2 | F | DN-AAA initiated re-auth when UE unreachable | 17.6.0 | +| 2022-06 | CT#96 | CP-221120 | 0134 | | B | Introduction to support 5MBS data delivery | 17.6.0 | +| 2022-06 | CT#96 | CP-221120 | 0135 | | B | N6mb and Nmb9 protocol to support 5MBS data delivery | 17.6.0 | +| 2022-06 | CT#96 | CP-221120 | 0136 | | B | Nmb8 protocol to support 5MBS data delivery | 17.6.0 | +| 2022-06 | CT#96 | CP-221138 | 0137 | 1 | B | Support for interworking with an AAA server in DCS | 17.6.0 | +| 2022-09 | CT#97e | CP-222106 | 0138 | 1 | F | UE default credentials for primary and secondary authentication | 17.7.0 | +| 2022-09 | CT#97e | CP-222125 | 0139 | 1 | F | Close the open issue related to DNAI | 17.7.0 | +| 2022-09 | CT#97e | CP-222094 | 0141 | | F | Updates on interworking with MBS AP | 17.7.0 | +| 2022-12 | CT#98e | CP-223177 | 0142 | | F | Corrections to UE default credentials for primary and secondary authentication | 17.8.0 | +| 2023-03 | CT#99 | CP-230177 | 0143 | 1 | B | Updates on IPv6 Prefix Delegation via DHCPv6 | 18.0.0 | +| 2023-03 | CT#99 | CP-230177 | 0144 | 1 | B | Updates on SMF+PGW-C interworking with DHCP | 18.0.0 | +| 2023-03 | CT#99 | CP-230175 | 0145 | 1 | F | SMF setting DSCP | 18.0.0 | +| 2023-03 | CT#99 | CP-230178 | 0146 | 1 | B | Updates on Reference Architecture | 18.0.0 | +| 2023-03 | CT#99 | CP-230178 | 0147 | 1 | B | Secondary DN authentication and authorization in EPS interworking use case related updates. | 18.0.0 | +| 2023-03 | CT#99 | CP-230178 | 0148 | | B | Secondary DN authentication and authorization in EPS interworking use case related updates. | 18.0.0 | +| 2023-06 | CT#100 | CP-231148 | 0149 | 1 | B | Support NEF playing the role of an MBS AF/AS for user plane MBS group message data delivery | 18.1.0 | +| 2023-06 | CT#100 | CP-231146 | 0150 | | B | Support the VAL server playing the role of an MBS AF | 18.1.0 | +| 2023-06 | CT#100 | CP-231181 | 0151 | | A | Enhancement to L2TP procedures | 18.1.0 | +| 2023-09 | CT#101 | CP-232096 | 0152 | 1 | B | Removing the ENs related to the NEF acting as an MBS AF for MBS Group Message Delivery | 18.2.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29563/0882d90c2036d3612040d0989282678a_img.jpg b/raw/rel-18/29_series/29563/0882d90c2036d3612040d0989282678a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..68d03a471a19535ae05906c21a4ae5f9fc3e2e8a --- /dev/null +++ b/raw/rel-18/29_series/29563/0882d90c2036d3612040d0989282678a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e1b7df4225a8dcc69066a05fea136f6c400faa477d86a9102bdf8b317e0cb144 +size 33144 diff --git a/raw/rel-18/29_series/29563/109caef02615eec1894dfc07d24deb97_img.jpg b/raw/rel-18/29_series/29563/109caef02615eec1894dfc07d24deb97_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c68179b997e8fd485f539bf3b18082dc59bc9731 --- /dev/null +++ b/raw/rel-18/29_series/29563/109caef02615eec1894dfc07d24deb97_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:90d9c563d588caf6b683425d41aff2151387d0fc36f0597efad3fa94071a7dc0 +size 12162 diff --git a/raw/rel-18/29_series/29563/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/raw/rel-18/29_series/29563/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a7c575068188da1f02c1daec79f87d7880867655 --- /dev/null +++ b/raw/rel-18/29_series/29563/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:397a5962ee4eb6f09a24a886ba97a25554ab54bc46a04589e91c7d392c84bc6d +size 28563 diff --git a/raw/rel-18/29_series/29563/40f30e4d577a17052f8b1e6dc802a0d8_img.jpg b/raw/rel-18/29_series/29563/40f30e4d577a17052f8b1e6dc802a0d8_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9bb9b208d2b95f8186c121e43148c897690f25b2 --- /dev/null +++ b/raw/rel-18/29_series/29563/40f30e4d577a17052f8b1e6dc802a0d8_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:448e1f2d0cdb34ea85d198bafef33cb11d949ae39adc02237ad2b9b9d63baa96 +size 35188 diff --git a/raw/rel-18/29_series/29563/421fc75480c21e7ebb25756826652367_img.jpg b/raw/rel-18/29_series/29563/421fc75480c21e7ebb25756826652367_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ef2818dca3d33e7f708a1c21e0d6fce6ce52c6ba --- /dev/null +++ b/raw/rel-18/29_series/29563/421fc75480c21e7ebb25756826652367_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:31912787644b7b414c9bd1e6ba4be532149394bb652dad4c924ecea2c3417a53 +size 29361 diff --git a/raw/rel-18/29_series/29563/5a4e62bead259c258d069fd3663ea670_img.jpg b/raw/rel-18/29_series/29563/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f1e59a91a30e012eb1f3234addcc845fab9c308a --- /dev/null +++ b/raw/rel-18/29_series/29563/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99da2c0786ee9f8911dbd90c6024eac2ed4483345c5b1dbece757adbaa01165e +size 6855 diff --git a/raw/rel-18/29_series/29563/5c6787bac31274e2dc992efeca74b303_img.jpg b/raw/rel-18/29_series/29563/5c6787bac31274e2dc992efeca74b303_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f7eca7740134fab92217ad038154149eb12c8c9d --- /dev/null +++ b/raw/rel-18/29_series/29563/5c6787bac31274e2dc992efeca74b303_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:051fae120e1c3bb7503759d4b96cd9badb14244dff174f68abacc7050c5ed8e1 +size 41432 diff --git a/raw/rel-18/29_series/29563/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29563/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b54cbc5504b077d968cc566bcf58b260f4bc6391 --- /dev/null +++ b/raw/rel-18/29_series/29563/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8765e1e676a63d175946804773bde215fd318cea84914059e8e006c19e48d1bf +size 9530 diff --git a/raw/rel-18/29_series/29563/63e0c22852c26699d0bd095a2d796bab_img.jpg b/raw/rel-18/29_series/29563/63e0c22852c26699d0bd095a2d796bab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3bad666e93d2505443362b011b0d59eb31387a6d --- /dev/null +++ b/raw/rel-18/29_series/29563/63e0c22852c26699d0bd095a2d796bab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:71fa0bff05a9125eacaad585a32d639b6ea9f759a78ee5d532a512d6245fca64 +size 37887 diff --git a/raw/rel-18/29_series/29563/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29563/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b731ef126f25975a7b7a95b321a3b7be5a89f769 --- /dev/null +++ b/raw/rel-18/29_series/29563/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b6fb9f03c5046347ab443fc119836686b9956aa4e72b441fdf07b88793413257 +size 5702 diff --git a/raw/rel-18/29_series/29563/69f52512bb7387a5dc9f952279513019_img.jpg b/raw/rel-18/29_series/29563/69f52512bb7387a5dc9f952279513019_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..47b3ee8331b511035aa9abaee2a0f15f2539f5f6 --- /dev/null +++ b/raw/rel-18/29_series/29563/69f52512bb7387a5dc9f952279513019_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f44b94faee6b1fec0d70e0aa18862584a392d351e652d977f065125edbba12be +size 36481 diff --git a/raw/rel-18/29_series/29563/7d2d1d3870cd224c4430d19334557716_img.jpg b/raw/rel-18/29_series/29563/7d2d1d3870cd224c4430d19334557716_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4059823f9228271806e8f0ce116e569cfcff62d1 --- /dev/null +++ b/raw/rel-18/29_series/29563/7d2d1d3870cd224c4430d19334557716_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:25592f66e77892964a4919c0d8abb41f47542ea538925911d4b81e6bb641083c +size 20807 diff --git a/raw/rel-18/29_series/29563/844077b3034f0030b404207db0ad76b4_img.jpg b/raw/rel-18/29_series/29563/844077b3034f0030b404207db0ad76b4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..791f54e3e824d12cd1f5ffbbf342150770ae9586 --- /dev/null +++ b/raw/rel-18/29_series/29563/844077b3034f0030b404207db0ad76b4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9cdd066d58778d039eb17d0acd5f65c6f8bb95d675a1a273989bdafe7ffc9c4 +size 33332 diff --git a/raw/rel-18/29_series/29563/a7c51c18111139f9aca2805114108565_img.jpg b/raw/rel-18/29_series/29563/a7c51c18111139f9aca2805114108565_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..02bc6e9617eead55cb9ce39afe81b1bb8febb725 --- /dev/null +++ b/raw/rel-18/29_series/29563/a7c51c18111139f9aca2805114108565_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c6bc3554987d769023c8e7f8f58c301f307b9dd3f6312e73fdd3f391cf12dda9 +size 31694 diff --git a/raw/rel-18/29_series/29563/b057cbcc73029e4684d3821b3f303e42_img.jpg b/raw/rel-18/29_series/29563/b057cbcc73029e4684d3821b3f303e42_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a77a3eed4d69a2228640a8f87a01662121da22ca --- /dev/null +++ b/raw/rel-18/29_series/29563/b057cbcc73029e4684d3821b3f303e42_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e6737a305ceb8120e40805673a1f96cf294fea822ea3e0ee21d5003f072e1586 +size 32052 diff --git a/raw/rel-18/29_series/29563/b978ce2c39dbbcd4c4e087eb265a830b_img.jpg b/raw/rel-18/29_series/29563/b978ce2c39dbbcd4c4e087eb265a830b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..19c88722e76e4cec43d99251c9aadee27b17fcf8 --- /dev/null +++ b/raw/rel-18/29_series/29563/b978ce2c39dbbcd4c4e087eb265a830b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:602b39be8997146e49300ce56e37111849d02ea2b9ab599b0409bf23d0355159 +size 31945 diff --git a/raw/rel-18/29_series/29563/c0e369274e53b2e5364666be6f786c7a_img.jpg b/raw/rel-18/29_series/29563/c0e369274e53b2e5364666be6f786c7a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..db21b52586f5aaa723bc6a08e372b7d5b1cf8995 --- /dev/null +++ b/raw/rel-18/29_series/29563/c0e369274e53b2e5364666be6f786c7a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:feabbcad477d47cb10df9edc7283d233ac36d8f079fbc691bd20af409f56f498 +size 31838 diff --git a/raw/rel-18/29_series/29563/e05122559f56af5699789b7118d8fe87_img.jpg b/raw/rel-18/29_series/29563/e05122559f56af5699789b7118d8fe87_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..779f7f3f632489f7515bab61ada63fd9bd2750cc --- /dev/null +++ b/raw/rel-18/29_series/29563/e05122559f56af5699789b7118d8fe87_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c83c58f2335cadb550837d9d421e45d09666c193872fab8ab26118f597ae05e9 +size 22310 diff --git a/raw/rel-18/29_series/29563/e190b6ddb7c2e64b940749a1c5612256_img.jpg b/raw/rel-18/29_series/29563/e190b6ddb7c2e64b940749a1c5612256_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c6dc7c932bdd76a620aeea8fbaa3440978384591 --- /dev/null +++ b/raw/rel-18/29_series/29563/e190b6ddb7c2e64b940749a1c5612256_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:63c9464a47bf9bdddf828d3657595a050ab43ffb8514180ff6425c527a9f2c9a +size 38235 diff --git a/raw/rel-18/29_series/29563/f9528ea5b0d2cd0192b7242e5a6af969_img.jpg b/raw/rel-18/29_series/29563/f9528ea5b0d2cd0192b7242e5a6af969_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..411340c11549baf54cf7b594e0e827ff02ce3bb3 --- /dev/null +++ b/raw/rel-18/29_series/29563/f9528ea5b0d2cd0192b7242e5a6af969_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ce5878f6e363bb8d924ae03e24cddd522e84e22a984d64d469f8fdf275d8ed90 +size 16745 diff --git a/raw/rel-18/29_series/29564/3191384ecc1531d40a00140dd21fd781_img.jpg b/raw/rel-18/29_series/29564/3191384ecc1531d40a00140dd21fd781_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..953552b985b17b3912b06177f8e4ba30f97afb9a --- /dev/null +++ b/raw/rel-18/29_series/29564/3191384ecc1531d40a00140dd21fd781_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e9821a6f59c35ad4aec5f86d9b39fd10e82d0d0732757be92bc280664200627a +size 30723 diff --git a/raw/rel-18/29_series/29564/36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg b/raw/rel-18/29_series/29564/36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4677f745c94e5b240a6e6988b94bbe2b2cf07b30 --- /dev/null +++ b/raw/rel-18/29_series/29564/36117e9cb27c58484cd8d3e5f9dc7ac3_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:016115319bb6ab6b9977564db33204ae1d325497be3f9cfec82e80182901c2c4 +size 32968 diff --git a/raw/rel-18/29_series/29564/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29564/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..afdb08f3790efa883c1d1c9748db8205e9bcdf85 --- /dev/null +++ b/raw/rel-18/29_series/29564/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8dc3b91741014f3a634e695aa72082899ba32848f881cbae3451d958ce24cf40 +size 9953 diff --git a/raw/rel-18/29_series/29564/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29564/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8100a15c900e98697870ba4c1afddbe7c9b3ee68 --- /dev/null +++ b/raw/rel-18/29_series/29564/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb40bc9f76c66728d07c34b52e7e2c983ae7e9e2ffb632d60220ebfd237c17a3 +size 5694 diff --git a/raw/rel-18/29_series/29564/69e5f1993021af230d08c08aac97d9df_img.jpg b/raw/rel-18/29_series/29564/69e5f1993021af230d08c08aac97d9df_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..91212a4366ce97e137c46e5d9db9f85f8bcea39c --- /dev/null +++ b/raw/rel-18/29_series/29564/69e5f1993021af230d08c08aac97d9df_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e0e5ce81e05ad4f322ef652b0f5598181c802004936feb46b8ed6ee44b070db2 +size 11103 diff --git a/raw/rel-18/29_series/29564/75e4b78ee25f885d73120e3066a5253e_img.jpg b/raw/rel-18/29_series/29564/75e4b78ee25f885d73120e3066a5253e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ae7b51c1a66b85bd33b70d67406d6b6e84f8e5f3 --- /dev/null +++ b/raw/rel-18/29_series/29564/75e4b78ee25f885d73120e3066a5253e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d19aff8568a914fc4941479902255a88bb89c3fcfd87d512694b124590af315e +size 17194 diff --git a/raw/rel-18/29_series/29564/7affafe7362a2d2d072e9d4bf515f0bb_img.jpg b/raw/rel-18/29_series/29564/7affafe7362a2d2d072e9d4bf515f0bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ea35c421e0cd1529cbac5617c3eb058691d24164 --- /dev/null +++ b/raw/rel-18/29_series/29564/7affafe7362a2d2d072e9d4bf515f0bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee7b260b5dd4807fafe7e16efa9317a95736ea2fe4b555b7ef8b32078188f4ab +size 26644 diff --git a/raw/rel-18/29_series/29564/96b0240f56d14453b5da05ec30fd5c6e_img.jpg b/raw/rel-18/29_series/29564/96b0240f56d14453b5da05ec30fd5c6e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b450a4438fb0caa837fe233a757dd9e0cac4d5bd --- /dev/null +++ b/raw/rel-18/29_series/29564/96b0240f56d14453b5da05ec30fd5c6e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fbe73de95101106bfe175fab1c25781fc761c95a4be131459e9664c48409e2fc +size 40843 diff --git a/raw/rel-18/29_series/29564/d17f75945bbb3feb84a153ecfedb9b81_img.jpg b/raw/rel-18/29_series/29564/d17f75945bbb3feb84a153ecfedb9b81_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a0810130124c3c4f6132c974bd069f897513ba4f --- /dev/null +++ b/raw/rel-18/29_series/29564/d17f75945bbb3feb84a153ecfedb9b81_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:beb6ea38f0114de59bf00df1a8aa9d5805b00d79bdb6218dfb9df7d49849828d +size 33939 diff --git a/raw/rel-18/29_series/29564/dc23d430e878eb71b8cd589984113940_img.jpg b/raw/rel-18/29_series/29564/dc23d430e878eb71b8cd589984113940_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6f1875f2fdd85346d5272bce9a6e2ca701cbe394 --- /dev/null +++ b/raw/rel-18/29_series/29564/dc23d430e878eb71b8cd589984113940_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c6449f125f86f15ec32aad1bc12126419b64f4e6f6afb697f28e33fe63109919 +size 31516 diff --git a/raw/rel-18/29_series/29565/c0e369274e53b2e5364666be6f786c7a_img.jpg b/raw/rel-18/29_series/29565/c0e369274e53b2e5364666be6f786c7a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..70df74674cf644c1ff7b0a55f79241ce8ba25a74 --- /dev/null +++ b/raw/rel-18/29_series/29565/c0e369274e53b2e5364666be6f786c7a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c5a628df4aaa1f3b37c7aabe79c27c854546f4513a5dcfa7957a1900f16360f9 +size 31352 diff --git a/raw/rel-18/29_series/29571/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29571/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f05ffb2945d4686f77e6bafb10fe1d6f91144b33 --- /dev/null +++ b/raw/rel-18/29_series/29571/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f37e7ace40458c46541eff36ea7e7b96df5f0659caf8ff2436fadf3fd8834495 +size 9589 diff --git a/raw/rel-18/29_series/29571/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29571/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6d2fe82a3bf59bcff442e48016a2c00ef880b54f --- /dev/null +++ b/raw/rel-18/29_series/29571/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:80926b621bf29ce38cae3bea547af69c81c95c23937a1239321b14d309e6aa0e +size 5664 diff --git a/raw/rel-18/29_series/29575/raw.md b/raw/rel-18/29_series/29575/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..f87bd2d5f6eb94807b611cc4d2ac3516b51890f5 --- /dev/null +++ b/raw/rel-18/29_series/29575/raw.md @@ -0,0 +1,4015 @@ + + +# 3GPP TS 29.575 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Analytics Data Repository Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font with a red signal wave icon below the 'P', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| Introduction ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions, symbols and abbreviations..... | 10 | +| 3.1 Definitions..... | 10 | +| 3.2 Symbols..... | 10 | +| 3.3 Abbreviations ..... | 10 | +| 4 Services offered by the ADRF ..... | 11 | +| 4.1 Introduction ..... | 11 | +| 4.2 Nadrf_DataManagement Service ..... | 12 | +| 4.2.1 Service Description ..... | 12 | +| 4.2.1.1 Overview..... | 12 | +| 4.2.1.2 Service Architecture ..... | 12 | +| 4.2.1.3 Network Functions..... | 13 | +| 4.2.1.3.1 Analytics Data Repository Function (ADRF)..... | 13 | +| 4.2.1.3.2 NF Service Consumers..... | 13 | +| 4.2.2 Service Operations..... | 13 | +| 4.2.2.1 Introduction..... | 13 | +| 4.2.2.2 Nadrf_DataManagement_StorageRequest service operation ..... | 14 | +| 4.2.2.2.1 General ..... | 14 | +| 4.2.2.2.2 Request Storage of data or analytics ..... | 14 | +| 4.2.2.3 Nadrf_DataManagement_StorageSubscriptionRequest service operation ..... | 15 | +| 4.2.2.3.1 General ..... | 15 | +| 4.2.2.3.2 Requesting subscription and storage of data or analytics ..... | 15 | +| 4.2.2.4 Nadrf_DataManagement_StorageSubscriptionRemoval service operation ..... | 16 | +| 4.2.2.4.1 General ..... | 16 | +| 4.2.2.4.2 Requesting removal of subscription of data or analytics ..... | 17 | +| 4.2.2.5 Nadrf_DataManagement_RetrievalRequest service operation..... | 17 | +| 4.2.2.5.1 General ..... | 17 | +| 4.2.2.5.2 Request and get stored data or analytics from ADRF Data Store..... | 17 | +| 4.2.2.6 Nadrf_DataManagement_RetrievalSubscribe service operation..... | 18 | +| 4.2.2.6.1 General ..... | 18 | +| 4.2.2.6.2 Requesting retrieval and subscription of data or analytics..... | 19 | +| 4.2.2.7 Nadrf_DataManagement_RetrievalUnsubscribe service operation..... | 20 | +| 4.2.2.7.1 General ..... | 20 | +| 4.2.2.7.2 Requesting removal of retrieval subscription for data or analytics..... | 20 | +| 4.2.2.8 Nadrf_DataManagement_RetrievalNotify service operation..... | 20 | +| 4.2.2.8.1 General ..... | 20 | +| 4.2.2.8.2 Notification about subscribed data or analytics ..... | 20 | +| 4.2.2.9 Nadrf_DataManagement_Delete service operation..... | 23 | +| 4.2.2.9.1 General ..... | 23 | +| 4.2.2.9.2 Requesting removal of stored data or analytics ..... | 23 | +| 4.2.2.9.3 Requesting removal of stored data or analytics using data or analytics specification ..... | 23 | +| 4.3 Nadrf_MLModelManagement Service ..... | 24 | +| 4.3.1 Service Description ..... | 24 | +| 4.3.1.1 Overview..... | 24 | +| 4.3.1.2 Service Architecture ..... | 24 | +| 4.3.1.3 Network Functions..... | 25 | +| 4.3.1.3.1 Analytics Data Repository Function (ADRF)..... | 25 | +| 4.3.1.3.2 NF Service Consumers..... | 25 | +| 4.3.2 Service Operations..... | 26 | +| 4.3.2.1 Introduction..... | 26 | +| 4.3.2.2 Nadrf_MLModelManagement_StorageRequest service operation ..... | 26 | + +| | | | +|-------------|---------------------------------------------------------------------------------|----| +| 4.3.2.2.1 | General ..... | 26 | +| 4.3.2.2.2 | Request Storage of ML model(s) ..... | 26 | +| 4.3.2.3 | Nadrf_MLModelManagement_RetrievalRequest service operation ..... | 27 | +| 4.3.2.3.1 | General ..... | 27 | +| 4.3.2.3.2 | Request and get stored ML model(s) from ADRF ML Model Store ..... | 27 | +| 4.3.2.4 | Nadrf_MLModelManagement_Delete service operation ..... | 28 | +| 4.3.2.4.1 | General ..... | 28 | +| 4.3.2.4.2 | Requesting removal of stored ML model(s) ..... | 28 | +| 4.3.2.4.3 | Requesting removal of stored ML model(s) using unique ML model identifier ..... | 29 | +| 5 | API Definitions ..... | 29 | +| 5.1 | Nadrf_DataManagement Service API ..... | 29 | +| 5.1.1 | Introduction ..... | 29 | +| 5.1.2 | Usage of HTTP ..... | 30 | +| 5.1.2.1 | General ..... | 30 | +| 5.1.2.2 | HTTP standard headers ..... | 30 | +| 5.1.2.2.1 | General ..... | 30 | +| 5.1.2.2.2 | Content type ..... | 30 | +| 5.1.2.3 | HTTP custom headers ..... | 30 | +| 5.1.3 | Resources ..... | 30 | +| 5.1.3.1 | Overview ..... | 30 | +| 5.1.3.2 | Resource: ADRF Data Store Records ..... | 31 | +| 5.1.3.2.1 | Description ..... | 31 | +| 5.1.3.2.2 | Resource Definition ..... | 31 | +| 5.1.3.2.3 | Resource Standard Methods ..... | 32 | +| 5.1.3.2.3.1 | POST ..... | 32 | +| 5.1.3.2.3.2 | GET ..... | 32 | +| 5.1.3.2.4 | Resource Custom Operations ..... | 33 | +| 5.1.3.3 | Resource: Individual ADRF Data Store Record ..... | 33 | +| 5.1.3.3.1 | Description ..... | 33 | +| 5.1.3.3.2 | Resource Definition ..... | 33 | +| 5.1.3.3.3 | Resource Standard Methods ..... | 33 | +| 5.1.3.3.3.1 | DELETE ..... | 33 | +| 5.1.3.3.4 | Resource Custom Operations ..... | 34 | +| 5.1.3.4 | Resource: ADRF Data Retrieval Subscriptions ..... | 35 | +| 5.1.3.4.1 | Description ..... | 35 | +| 5.1.3.4.2 | Resource Definition ..... | 35 | +| 5.1.3.4.3 | Resource Standard Methods ..... | 35 | +| 5.1.3.4.3.1 | POST ..... | 35 | +| 5.1.3.4.4 | Resource Custom Operations ..... | 36 | +| 5.1.3.5 | Resource: Individual ADRF Data Retrieval Subscription ..... | 36 | +| 5.1.3.5.1 | Description ..... | 36 | +| 5.1.3.5.2 | Resource Definition ..... | 36 | +| 5.1.3.5.3 | Resource Standard Methods ..... | 36 | +| 5.1.3.5.3.1 | DELETE ..... | 36 | +| 5.1.3.5.4 | Resource Custom Operations ..... | 37 | +| 5.1.4 | Custom Operations without associated resources ..... | 37 | +| 5.1.4.1 | Overview ..... | 37 | +| 5.1.4.2 | Operation: request-storage-sub ..... | 38 | +| 5.1.4.2.1 | Description ..... | 38 | +| 5.1.4.2.2 | Operation Definition ..... | 38 | +| 5.1.4.3 | Operation: request-storage-sub-removal ..... | 39 | +| 5.1.4.3.1 | Description ..... | 39 | +| 5.1.4.3.2 | Operation Definition ..... | 39 | +| 5.1.4.4 | Operation: remove-stored-data-analytics ..... | 39 | +| 5.1.4.4.1 | Description ..... | 39 | +| 5.1.4.4.2 | Operation Definition ..... | 39 | +| 5.1.5 | Notifications ..... | 40 | +| 5.1.5.1 | General ..... | 40 | +| 5.1.5.2 | Retrieval Notification ..... | 40 | +| 5.1.5.2.1 | Description ..... | 40 | +| 5.1.5.2.2 | Target URI ..... | 40 | + +| | | | +|-------------|----------------------------------------------------------------------------------|----| +| 5.1.5.2.3 | Standard Methods..... | 40 | +| 5.1.5.2.3.1 | POST ..... | 40 | +| 5.1.6 | Data Model ..... | 43 | +| 5.1.6.1 | General..... | 43 | +| 5.1.6.2 | Structured data types..... | 46 | +| 5.1.6.2.1 | Introduction ..... | 46 | +| 5.1.6.2.2 | Type: NadrfDataStoreRecord..... | 46 | +| 5.1.6.2.3 | Type: NadrfDataStoreSubscription ..... | 47 | +| 5.1.6.2.4 | Type: NadrfDataRetrievalSubscription..... | 48 | +| 5.1.6.2.5 | Type: NadrfDataRetrievalNotification..... | 49 | +| 5.1.6.2.6 | Type: NadrfDataStoreSubscriptionRef ..... | 49 | +| 5.1.6.2.7 | Type: NadrfStoredDataSpec ..... | 50 | +| 5.1.6.2.8 | Type: DataSubscription..... | 50 | +| 5.1.6.2.9 | Type: DataNotification..... | 51 | +| 5.1.6.3 | Simple data types and enumerations..... | 52 | +| 5.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 52 | +| 5.1.7 | Error Handling ..... | 52 | +| 5.1.7.1 | General..... | 52 | +| 5.1.7.2 | Protocol Errors ..... | 53 | +| 5.1.7.3 | Application Errors..... | 53 | +| 5.1.8 | Feature negotiation ..... | 53 | +| 5.1.9 | Security ..... | 53 | +| 5.2 | Nadrf_ MLModelManagement Service API..... | 54 | +| 5.2.1 | Introduction ..... | 54 | +| 5.2.2 | Usage of HTTP..... | 54 | +| 5.2.2.1 | General..... | 54 | +| 5.2.2.2 | HTTP standard headers..... | 54 | +| 5.2.2.2.1 | General ..... | 54 | +| 5.2.2.2.2 | Content type ..... | 54 | +| 5.2.2.3 | HTTP custom headers..... | 54 | +| 5.2.3 | Resources..... | 54 | +| 5.2.3.1 | Overview..... | 54 | +| 5.2.3.2 | Resource: ADRF ML Model Store Records..... | 55 | +| 5.2.3.2.1 | Description ..... | 55 | +| 5.2.3.2.2 | Resource Definition..... | 55 | +| 5.2.3.2.3 | Resource Standard Methods..... | 55 | +| 5.2.3.2.3.1 | POST ..... | 55 | +| 5.2.3.2.3.2 | GET ..... | 56 | +| 5.2.3.2.4 | Resource Custom Operations..... | 57 | +| 5.2.3.3 | Resource: Individual ADRF ML Model Store Record..... | 57 | +| 5.2.3.3.1 | Description ..... | 57 | +| 5.2.3.3.2 | Resource Definition..... | 57 | +| 5.2.3.3.3 | Resource Standard Methods..... | 57 | +| 5.2.3.3.3.1 | DELETE ..... | 57 | +| 5.2.3.3.4 | Resource Custom Operations..... | 58 | +| 5.2.4 | Custom Operations without associated resources ..... | 58 | +| 5.2.4.1 | Overview..... | 58 | +| 5.2.4.4 | Operation: remove-stored-mlmodel..... | 59 | +| 5.2.4.4.1 | Description ..... | 59 | +| 5.2.4.4.2 | Operation Definition ..... | 59 | +| 5.2.5 | Notifications ..... | 59 | +| 5.2.6 | Data Model ..... | 60 | +| 5.2.6.1 | General..... | 60 | +| 5.2.6.2 | Structured data types..... | 60 | +| 5.2.6.2.1 | Introduction ..... | 60 | +| 5.2.6.2.2 | Type: NadrfMLModelStoreRecord..... | 61 | +| 5.2.6.2.3 | Type: MLModelInfo ..... | 61 | +| 5.2.6.2.4 | Type: MLModel ..... | 61 | +| 5.2.6.2.5 | Type: MLModelDelResult ..... | 62 | +| 5.2.6.2.6 | Type: AllowedConsumer ..... | 62 | +| 5.2.6.2.7 | Type: ModelStoreResult ..... | 62 | +| 5.2.6.3 | Simple data types and enumerations..... | 62 | + +| | | | +|---------------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 5.2.6.3.2 | Enumeration: StoreResult ..... | 62 | +| 5.2.6.4 | Data types describing alternative data types or combinations of data types ..... | 63 | +| 5.2.7 | Error Handling ..... | 63 | +| 5.2.7.1 | General ..... | 63 | +| 5.2.7.2 | Protocol Errors ..... | 63 | +| 5.2.7.3 | Application Errors ..... | 63 | +| 5.2.8 | Feature negotiation ..... | 63 | +| 5.2.9 | Security ..... | 63 | +| Annex A (normative): OpenAPI specification ..... | | 65 | +| A.1 | General ..... | 65 | +| A.2 | Nadrf_DataManagement API ..... | 65 | +| A.3 | Nadrf_MLModelManagement API ..... | 77 | +| Annex B (informative): Change history ..... | | 83 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +*This clause is optional. If it exists, it is always the second unnumbered clause.* + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the ADRF Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the ADRF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. The stage 2 definition and procedures of store and retrieve the collected data and analytics are contained in 3GPP TS 23.288 [14] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs" +- [14] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [15] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [17] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [18] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". + +- [19] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [20] 3GPP TS 29.517: "5G System; Application Function Event Exposure Services; Stage 3". +- [21] 3GPP TS 29.591: "5G System; Network Exposure Function Southbound Services; Stage 3". +- [22] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [23] 3GPP TS 29.574: "5G System; Data Collection Coordination Services; Stage 3". +- [24] 3GPP TS 29.576: "5G System; Messaging Framework Adaptor Services; Stage 3". +- [25] 3GPP TS 29.536: "5G System; Network Slice Admission Control Services; Stage 3". +- [26] 3GPP TS 29.564: "5G System; User Plane Function Services; Stage 3". +- [27] 3GPP TS 29.515: "5G System; Gateway Mobile Location Services; Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +None. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +None. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|------------------------------------------| +| ADRF | Analytics Data Repository Function | +| AF | Application Function | +| AMF | Access and Mobility Management Function | +| DCCF | Data Collection Coordination Function | +| GMLC | Gateway Mobile Location Centre | +| MFAF | Messaging Framework Adaptor Function | +| NEF | Network Exposure Function | +| NF | Network Function | +| NRF | Network Repository Function | +| NWDAF | Network Data Analytics Function | +| NSACF | Network Slice Admission Control Function | +| SMF | Session Management Function | +| UDM | Unified Data Management | +| UPF | User Plane Function | + +# 4 Services offered by the ADRF + +## 4.1 Introduction + +The Analytics Data Repository Service is used for the Analytics Data Repository Function (ADRF) to storage and retrieval of data and ML model(s) by e.g. Consumers NF(s) (e.g. NWDAF) which access the data or ML model(s) using Nadrf service. The ADRF offers to other NFs the following services: + +Table 4.1-1: Service provided by ADRF + +| Service Name | Description | Service Operations | Operation Semantics | Example Consumer(s) | +|-----------------------------------|---------------------------------------------------------------------------------------------------------------|----------------------------|---------------------|---------------------| +| Nadrf_DataManagement
(NOTE 1) | This service enables the NF service consumers to store, retrieve and remove the data or analytics in an ADRF. | StorageRequest | Request / Response | DCCF, NWDAF, MFAF | +| | | StorageSubscriptionRequest | Request / Response | DCCF, NWDAF | +| | | StorageSubscriptionRemoval | Request / Response | DCCF, NWDAF | +| | | RetrievalRequest | Request / Response | DCCF, NWDAF | +| | | RetrievalSubscribe | Subscribe / Notify | DCCF, NWDAF | +| | | RetrievalUnsubscribe | Subscribe / Notify | DCCF, NWDAF | +| | | RetrievalNotify | Subscribe / Notify | DCCF, NWDAF | +| | | Delete | Request / Response | DCCF, NWDAF | +| Nadrf_ModelManagement
(NOTE 2) | This service enables the NF service consumers to store, retrieve and delete ML model(s) in an ADRF. | StorageRequest | Request / Response | NWDAF | +| | | Retrieval | Request / Response | NWDAF | +| | | Delete | Request / Response | NWDAF | + +NOTE 1: The services correspond to the Nadrf\_DataManagement service as defined in 3GPP TS 23.288 [14]. +NOTE 2: The services correspond to the Nadrf\_ModelManagement service as defined in 3GPP TS 23.288 [14]. + +Table 4.1-2 summarizes the corresponding APIs defined for this specification. + +Table 4.1-2: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-----------------------|--------|-------------------------------|----------------------------|-----------------------|-------------------------------------| +| Nadrf_DataManagement | 4.2 | API for Nadrf_DataManagement | | nadrf_datamanagement | Annex A.2 Nadrf_DataManagement API | +| Nadrf_ModelManagement | 4.3 | API for Nadrf_ModelManagement | | nadrf_modelmanagement | Annex A.3 Nadrf_ModelManagement API | + +## 4.2 Nadrf\_DataManagement Service + +### 4.2.1 Service Description + +#### 4.2.1.1 Overview + +The Nadrf\_DataManagement service as defined in 3GPP TS 23.288 [14], is provided by the Analytics Data Repository Function (ADRF). + +This service: + +- allows NF consumers to store data or analytics in the ADRF, and request/receive notifications about data or analytics that are about to be deleted; +- allows NF consumers to retrieve data or analytics from an ADRF; and +- allows NF consumers to delete data or analytics from an ADRF. + +#### 4.2.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [14]. + +The Nadrf\_DataManagement service is part of the Nadrf service-based interface exhibited by the Analytics Data Repository Function (ADRF). + +Known consumers of the Nadrf\_DataManagement service are: + +- Data Collection Coordination Function (DCCF) +- Network Data Analytics Function (NWDAF) +- Messaging Framework Adaptor Function (MFAF) + +The Nadrf\_DataManagement service is provided by the ADRF and consumed by the NF service consumers as shown in figure 4.2.1.2-1 for the SBI representation model and in figure 4.2.1.2-2 for the reference point representation model. + +![Figure 4.2.1.2-1: Reference Architecture for the Nadrf_DataManagement Service; SBI representation. The diagram shows a box labeled 'ADRF' containing an oval labeled 'Nadrf'. A line labeled 'Nadrf_DataManagement' connects this oval to a horizontal bus. Below the bus, three boxes labeled 'NWDAF', 'DCCF', and 'MFAF' are connected to the bus via vertical lines.](cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg) + +Figure 4.2.1.2-1: Reference Architecture for the Nadrf\_DataManagement Service; SBI representation. The diagram shows a box labeled 'ADRF' containing an oval labeled 'Nadrf'. A line labeled 'Nadrf\_DataManagement' connects this oval to a horizontal bus. Below the bus, three boxes labeled 'NWDAF', 'DCCF', and 'MFAF' are connected to the bus via vertical lines. + +Figure 4.2.1.2-1: Reference Architecture for the Nadrf\_DataManagement Service; SBI representation + +![Figure 4.2.1.2-2: Nadrf_DataManagement service architecture, reference point representation. The diagram shows a box labeled 'ADRF' at the top. Three lines descend from the bottom of the 'ADRF' box to three separate boxes labeled 'NWDAF', 'DCCF', and 'MFAF' at the bottom. Each line has a small horizontal tick mark near the bottom box it connects to.](bdfe4e1058d1a0e14bb838771b57254c_img.jpg) + +Figure 4.2.1.2-2: Nadrf\_DataManagement service architecture, reference point representation. The diagram shows a box labeled 'ADRF' at the top. Three lines descend from the bottom of the 'ADRF' box to three separate boxes labeled 'NWDAF', 'DCCF', and 'MFAF' at the bottom. Each line has a small horizontal tick mark near the bottom box it connects to. + +Figure 4.2.1.2-2: Nadrf\_DataManagement service architecture, reference point representation + +#### 4.2.1.3 Network Functions + +##### 4.2.1.3.1 Analytics Data Repository Function (ADRF) + +The Analytics Data Repository Function (ADRF) provides the functionality to allow NF consumers to store, retrieve, and remove data or analytics from the ADRF, and request/receive notifications about data or analytics that are about to be deleted. + +##### 4.2.1.3.2 NF Service Consumers + +The NWDAF and DCCF: + +- supports storing data or analytics in the ADRF, and requesting/receiving notifications about data or analytics that are about to be deleted; +- supports retrieving data or analytics from an ADRF; and +- supports deletion data or analytics from an ADRF. + +The MFAF: + +- supports storing data or analytics in the ADRF. + +### 4.2.2 Service Operations + +#### 4.2.2.1 Introduction + +**Table 4.2.2.1-1: Operations of the Nadrf\_DataManagement Service** + +| Service operation name | Description | Initiated by | +|-------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------| +| Nadrf_DataManagement_StorageRequest | This service operation is used by an NF to request the ADRF to store data or analytics. Data or analytics are provided to the ADRF in the request message. | NF service consumer (DCCF, NWDAF, MFAF) | +| Nadrf_DataManagement_StorageSubscriptionRequest | This service operation is used by an NF to request the ADRF to initiate a subscription for data or analytics. Data or analytics provided in notifications as a result of the subsequent subscription by the ADRF are stored in the ADRF. | NF service consumer (DCCF, NWDAF) | +| Nadrf_DataManagement_StorageSubscriptionRemoval | This service operation is used by an NF to request that the ADRF no longer subscribes to data or analytics it is collecting and storing. | NF service consumer (DCCF, NWDAF) | +| Nadrf_DataManagement_RetrievalRequest | This service operation is used by an NF to retrieve stored data or analytics from the ADRF. | NF service consumer (DCCF, NWDAF) | +| Nadrf_DataManagement_RetrievalSubscribe | This service operation is used by an NF to retrieve stored data or analytics from the ADRF and to receive future notifications containing the corresponding data or analytics received by ADRF. | NF service consumer (DCCF, NWDAF) | +| Nadrf_DataManagement_RetrievalUnsubscribe | This service operation is used by an NF to request that the ADRF no longer sends data or analytics to a notification endpoint. | NF service consumer (DCCF, NWDAF) | +| Nadrf_DataManagement_RetrievalNotify | This service operation is used by the ADRF to notify an NF with either data or analytics, or instructions to fetch the data or analytics from the ADRF. It is also used by the ADRF to notify NF service consumers about data or analytics that are about to be deleted. | ADRF | +| Nadrf_DataManagement_Delete | This service operation is used by an NF to delete stored data in ADRF. | NF service consumer (DCCF, NWDAF) | + +#### 4.2.2.2 Nadrf\_DataManagement\_StorageRequest service operation + +##### 4.2.2.2.1 General + +The Nadrf\_DataManagement\_StorageRequest service operation is used by an NF service consumer to store data or analytics. + +##### 4.2.2.2.2 Request Storage of data or analytics + +Figure 4.2.2.2.2-1 shows a scenario where the NF service consumer sends a request to the ADRF to store data or analytics. + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a POST request to the ADRF, and the ADRF responds with a 201 Created status.](f6e8acf9f931452d01688d311b5c0364_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant ADRF + Note right of NF service consumer: 1. POST ../data-store-records + NF service consumer->>ADRF: Request + Note left of ADRF: 2. "201 Created" + ADRF-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a POST request to the ADRF, and the ADRF responds with a 201 Created status. + +**Figure 4.2.2.2.2-1: NF service consumer requesting to store data or analytics** + +The NF service consumer shall invoke the Nadrf\_DataManagement\_StorageRequest service operation to store data or analytics. The NF service consumer shall send an HTTP POST request with "{apiRoot}/nadrf-datamanagement//data-store-records" as Resource URI representing the "ADRF Data Store Records" resource, as shown in figure 4.2.2.2.2-1, step 1, to create an "Individual ADRF Data Store Record" according to the information in the message body. The NadrfDataStoreRecord data structure provided in the request body shall include: + +- one of the following: + - analytics subscription notification(s) within the "anaNotifications" attribute together with the corresponding subscription information within the "anaSub" attribute; + - data subscription notification within the "dataNotif" attribute together with the corresponding subscription information within the "dataSub" attribute. + +and may include: + +- storage handling information within the "storeHandl" attribute, if the "EnhDataMgmt" feature is supported. +- a data set tag within the "dataSetTag" attribute, if the "EnhDataMgmt" feature is supported; +- data synthesis and compression information within the "dsc" attribute, if the "EnhDataMgmt" feature is supported. + +**NOTE:** The data synthesis and compression information can include an indication that the data have been generated using a data synthesis tool, an indication that the data have been generated using a data compression tool, and information about the data synthesis and/or compression technique. + +Upon the reception of an HTTP POST request with "{apiRoot}/nadrf-datamanagement//data-store-records" as Resource URI and NadrfDataStoreRecord data structure as request body, the ADRF shall: + +- create a new data store record; +- assign a storeTransId; +- store the data or analytics. + +NOTE 1: If the data and/or analytics is already stored or being stored in the ADRF, the ADRF will still create a new "Individual ADRF Data Store Record" resource and assign a new storeTransId if the ADRF intends to not really store the data again in the memory again based on the implementation. + +If the ADRF created an "Individual ADRF Data Store Record" resource, the ADRF shall respond with "201 Created" with the message body containing a representation of the created record, as shown in figure 4.2.2.2.2-1, step 2. The ADRF shall include a Location HTTP header field. The Location header field shall contain the URI of the created record i.e. "{apiRoot}/nadrf-datamanagement//data-store-records/{storeTransId}". + +If the ADRF receives storage handling information in the request but determines (e.g. based on local policy) that a different storage approach shall be followed, it indicates the determined storage approach to the consumer by setting accordingly the "storeHandl" attribute (e.g. providing a different lifetime, or omitting the deletion notification URI to indicate that no deletion alerts will be sent) in the message body of the response. When more than one consumer has requested storage lifetime for the same data or analytics, the storage approach should be based on the longest requested storage lifetime. + +NOTE 2: The default operator policy for how long data or analytics are to be stored can be longer or shorter than the lifetime requested by the consumer. A default operator policy can for example accept only consumer requested lifetimes that are shorter or longer than the default policy. + +If an error occurs when processing the HTTP POST request, the ADRF shall send an HTTP error response as specified in clause 5.1.7. + +#### 4.2.2.3 Nadrf\_DataManagement\_StorageSubscriptionRequest service operation + +##### 4.2.2.3.1 General + +The Nadrf\_DataManagement\_StorageSubscriptionRequest service operation is used by an NF service consumer to request that the ADRF creates a subscription to data or analytics and subsequently stores notified data or analytics in the ADRF. + +##### 4.2.2.3.2 Requesting subscription and storage of data or analytics + +Figure 4.2.2.3.2-1 shows a scenario where the NF service consumer sends a request to the ADRF to subscribe for data or analytics to be stored in the ADRF. + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a POST request to request-storage-sub, and the ADRF responds with a 200 OK.](e4c6fa93821e3546ee9fcae897ae2771_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant ADRF + Note left of NF service consumer: NF service consumer + Note right of ADRF: ADRF + NF service consumer->>ADRF: 1. POST .../request-storage-sub + ADRF-->>NF service consumer: 2. "200 OK" +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a POST request to request-storage-sub, and the ADRF responds with a 200 OK. + +**Figure 4.2.2.3.2-1: NF service consumer requesting that the ADRF subscribes to and subsequently stores data or analytics** + +The NF service consumer shall invoke the Nadrf\_DataManagement\_StorageSubscriptionRequest service operation to request the ADRF to subscribe to data or analytics. The NF service consumer shall send an HTTP POST request with "{apiRoot}/nadrf-datamanagement//request-storage-sub" as URI, as shown in figure 4.2.2.3.2-1, step 1. The NadrfDataStoreSubscription data structure provided in the request body shall include: + +- one of the following subscription attributes: + - analytics subscription information within the "anaSub" attribute; + +- data subscription information within the "dataSub" attribute; +- one of the following target identifiers: + - DCCF or NWDAF instance identifier within the "targetNfId" attribute; + - DCCF or NWDAF NF set identifier within the "targetNfSetId" attribute; + +and may include: + +- formatting instructions within the "formatInstruct" attribute; +- processing instructions within the "procInstruct" attribute or the "multiProcInstructs" attribute if the "MultiProcessingInstruction" feature is supported. + +NOTE 1: The parameters provided by the NF service consumer, including Formatting and Processing Instructions (if provided) are used by the ADRF when subscribing to a DCCF or NWDAF for Data or Analytics to be stored. + +- storage handling information within the "storeHandl" attribute, if the "EnhDataMgmt" feature is supported. +- a data set tag to be associated with this subscription and with the data or analytics collected based on this subscription within the "dataSetTag" attribute, if the "EnhDataMgmt" feature is supported. + +Upon the reception of an HTTP POST request with "{apiRoot}/nadrf-datamanagement//request-storage-sub" as URI and NadrfDataStoreSubscription data structure as request body, the ADRF shall assign a transaction reference identifier to this request and, if the request is successfully processed and accepted, the ADRF shall respond with "200 OK" as shown in figure 4.2.2.3.2-1 step 2, with the message body containing an NadrfDataStoreSubscriptionRef data structure, which shall include the assigned transaction reference identifier as "transRefId" attribute. + +NOTE 2: If the data and/or analytics is already stored or being stored in the ADRF, the ADRF will still assign a new transaction reference identifier if the ADRF intends to not really store the data again in the memory again based on the implementation. + +If an error occurs when processing the HTTP POST request, the ADRF shall send an HTTP error response as specified in clause 5.1.7. + +If the ADRF receives storage handling information in the request but determines (e.g. based on local policy) that a different storage approach shall be followed, it indicates the determined storage approach to the consumer by setting accordingly the "storeHandl" attribute (e.g. providing a different lifetime, or omitting the deletion notification URI to indicate that no deletion alerts will be sent) in the message body of the response. When more than one consumer has requested storage lifetime for the same data or analytics, the storage approach should be based on the longest requested storage lifetime. + +NOTE 3: The default operator policy for how long data or analytics are to be stored can be longer or shorter than the lifetime requested by the consumer. A default operator policy can for example accept only consumer requested lifetimes that are shorter or longer than the default policy. + +In the case of a successful response, the ADRF may subsequently create a data or analytics subscription (according to inputs that had been received in the NadrfDataStoreSubscription data structure; this is not performed if the ADRF determines that the data is already being stored based on an existing subscription) with a DCCF as described in 3GPP TS 29.574 [23] or with an NWDAF as described in 3GPP TS 29.520 [15], and create a mapping between the previously assigned and returned transaction reference identifier and the subscription that is used to serve the transaction. + +#### 4.2.2.4 Nadrf\_DataManagement\_StorageSubscriptionRemoval service operation + +##### 4.2.2.4.1 General + +The Nadrf\_DataManagement\_StorageSubscriptionRemoval service operation is used by an NF service consumer to request the ADRF to remove a subscription for data or analytics. + +##### 4.2.2.4.2 Requesting removal of subscription of data or analytics + +Figure 4.2.2.4.2-1 shows a scenario where the NF service consumer sends a request to the ADRF to unsubscribe for storage of data or analytics. + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF for requesting removal of subscription(s).](33a8f3f01dfa8bce75d23017855a13c5_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant ADRF + Note right of NF service consumer: 1. POST .../request-storage-sub-removal + NF service consumer->>ADRF: Request + Note left of ADRF: 2. "204 No Content" + ADRF-->>NF service consumer: Response +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and an ADRF. The first message, labeled '1. POST .../request-storage-sub-removal', is sent from the NF service consumer to the ADRF. The second message, labeled '2. "204 No Content"', is sent from the ADRF back to the NF service consumer. + +Sequence diagram showing the interaction between an NF service consumer and an ADRF for requesting removal of subscription(s). + +**Figure 4.2.2.4.2-1: NF service consumer requesting the removal of subscription(s) to storage of data or analytics** + +The NF service consumer shall invoke the Nadrf\_DataManagement\_StorageSubscriptionRemoval service operation to request the ADRF to remove subscription(s) to data or analytics that are stored in the ADRF. The NF service consumer shall send an HTTP POST request with "{apiRoot}/nadrf-datamanagement//request-storage-sub-removal" as URI, as shown in figure 4.2.2.4.2-1, step 1. The POST request body shall contain an NadrfDataStoreSubscriptionRef data structure, which shall include a transaction reference identifier as "transRefId" attribute or, if the "EnhDataMgmt" feature is supported, a data set identifier as "dataSetId" attribute. + +Upon the reception of an HTTP POST request with "{apiRoot}/nadrf-datamanagement//request-storage-sub-removal" as URI, if the ADRF successfully processed and accepted the received HTTP POST request, the ADRF shall respond with HTTP "204 No Content" status. Subsequently, the ADRF shall remove the (DCCF or NWDAF) subscription that had been created and mapped to the received transaction reference identifier or the (DCCF or NWDAF) subscription(s) associated to the received data set identifier as described in clause 4.2.2.3, unless this subscription is mapped to further transaction reference identifier(s) (of transactions that are still active) or associated with further data set identifier(s). + +If errors occur when processing the HTTP POST request, the ADRF shall send an HTTP error response as specified in clause 5.1.7. + +#### 4.2.2.5 Nadrf\_DataManagement\_RetrievalRequest service operation + +##### 4.2.2.5.1 General + +The Nadrf\_DataManagement\_RetrievalRequest service operation is used by an NF service consumer to retrieve stored data or analytics. + +##### 4.2.2.5.2 Request and get stored data or analytics from ADRF Data Store + +Figure 4.2.2.5.2-1 shows a scenario where the NF service consumer sends a request to the ADRF to retrieve stored data or analytics. + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a GET request to ../data-store-records with query parameters, and the ADRF responds with a 200 OK status.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant ADRF + Note right of NF service consumer: 1. GET ../data-store-records?query_parameters + NF service consumer->>ADRF: Request + Note left of ADRF: 2. "200 OK" + ADRF-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a GET request to ../data-store-records with query parameters, and the ADRF responds with a 200 OK status. + +**Figure 4.2.2.5.2-1: NF service consumer requesting to retrieve stored data or analytics** + +The NF service consumer shall invoke the `Nadrf_DataManagement_RetrievalRequest` service operation to retrieve stored data or analytics. The NF service consumer shall send an HTTP GET request with "{apiRoot}/nadrf-datamanagement//data-store-records" as Resource URI representing the "ADRF Data Store Records" resource, as shown in figure 4.2.2.5.2-1, step 1, to request ADRF data store records according to the query parameter value of the store transaction identifier within the "store-trans-id" attribute, the query parameter value of the fetch correlation identifier(s) within the "fetch-correlation-ids" attribute, or, if the "EnhDataMgmt" feature is supported, the query parameter value of the data set identifier within the "data-set-id" attribute. + +Upon the reception of the HTTP GET request, the ADRF shall: + +- find the data or analytics according to the requested parameters. + +If the requested data or analytics is found, the ADRF shall respond with "200 OK" status code with the message body containing the `NadrfDataStoreRecord` data structure. The `NadrfDataStoreRecord` data structure in the response body shall include: + +- one of the following: + - information about network analytics function events that occurred in the "anaNotifications" attribute together with the corresponding subscription information within the "anaSub" attribute; + - information about data event within the "dataNotif" attribute together with the corresponding subscription information within the "dataSub" attribute. + +and may include: + +- a data set tag within the "dataSetTag" attribute, if the "EnhDataMgmt" feature is supported. +- data synthesis and compression information within the "dsc" attribute, if the "EnhDataMgmt" feature is supported. + +NOTE: The data synthesis and compression information can include an indication that the data have been generated using a data synthesis tool, an indication that the data have been generated using a data compression tool, and information about the data synthesis and/or compression technique. + +If the requested analytics or data does not exist, the ADRF shall respond with "204 No Content". If an error occurs when processing the HTTP GET request, the ADRF shall send an HTTP error response as specified in clause 5.1.7. + +#### 4.2.2.6 Nadrf\_DataManagement\_RetrievalSubscribe service operation + +##### 4.2.2.6.1 General + +The `Nadrf_DataManagement_RetrievalSubscribe` service operation is used by an NF service consumer to subscribe to the ADRF to retrieve via notifications data or analytics that is stored in the ADRF and to receive future notifications with data or analytics when they are received by the ADRF. + +##### 4.2.2.6.2 Requesting retrieval and subscription of data or analytics + +Figure 4.2.2.6.2-1 shows a scenario where the NF service consumer sends a request to the ADRF to retrieve and subscribe to data or analytics. + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a POST request to /data-retrieval-subscriptions, and the ADRF responds with a 201 Created status.](898fb89a50d9ec1dfb4e425c816976a7_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant ADRF + Note right of NF service consumer: 1. POST ../data-retrieval-subscriptions + NF service consumer->>ADRF: Request + Note left of ADRF: 2. "201 Created" + ADRF-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a POST request to /data-retrieval-subscriptions, and the ADRF responds with a 201 Created status. + +**Figure 4.2.2.6.2-1: NF service consumer requesting to retrieve and subscribe to data or analytics** + +The NF service consumer shall invoke the Nadrf\_DataManagement\_RetrievalSubscribe service operation to retrieve and subscribe to data or analytics. The NF service consumer shall send an HTTP POST request with "{apiRoot}/nadrf-datamanagement//data-retrieval-subscriptions" as Resource URI representing the "ADRF Data Retrieval Subscriptions" resource, as shown in figure 4.2.2.6.2-1, step 1, to create an "Individual ADRF Data Retrieval Subscription" according to the information in the message body. The NadrfDataRetrievalSubscription data structure provided in the request body shall include: + +- notification correlation identifier within the "notifCorrId" attribute; +- one of the following: + - analytics subscription information within the "anaSub" attribute; + - data subscription information within the "dataSub" attribute; + - data set identifier within the "dataSetId" attribute, if the "EnhDataMgmt" feature is supported; +- a notification target address within the "notificationURI" attribute; +- a time window for the data retrieval and subscription within the "timePeriod" attribute; + +and may include: + +- a Consumer triggered Notification indication within the "consTrigNotif" attribute. + +Upon the reception of an HTTP POST request with "{apiRoot}/nadrf-datamanagement//data-retrieval-subscriptions" as Resource URI and NadrfDataRetrievalSubscription data structure as request body, the ADRF shall: + +- create a new subscription; +- assign a subscriptionId; +- store the subscription. + +If the ADRF created an "Individual ADRF Data Retrieval Subscription" resource, the ADRF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.2.2.6.2-1, step 2. The ADRF shall include a Location HTTP header field. The Location header field shall contain the URI of the created record i.e. "{apiRoot}/nadrf-datamanagement//data-retrieval-subscriptions/{subscriptionId}". + +If an error occurs when processing the HTTP POST request, the ADRF shall send an HTTP error response as specified in clause 5.1.7. + +**Editor's Note:** How to ensure that the consumer to comply with the user consent when retrieving data from ADRF is FFS. + +#### 4.2.2.7 Nadrf\_DataManagement\_RetrievalUnsubscribe service operation + +##### 4.2.2.7.1 General + +The Nadrf\_DataManagement\_RetrievalUnsubscribe service operation is used by an NF service consumer to remove a retrieval subscription to data or analytics. + +##### 4.2.2.7.2 Requesting removal of retrieval subscription for data or analytics + +Figure 4.2.2.7.2-1 shows a scenario where the NF service consumer sends a request to the ADRF to remove a retrieval subscription for data or analytics. + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF to remove a retrieval subscription. Step 1: The consumer sends a DELETE request to the ADRF. Step 2: The ADRF responds with a 204 No Content status.](1a85642ed2356d183ce598f2c8b3ee8b_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant ADRF + Note left of NF service consumer: + NF service consumer->>ADRF: 1. DELETE .../data-retrieval-subscriptions/{subscriptionId} + Note right of ADRF: + ADRF-->>NF service consumer: 2. "204 No Content" +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF to remove a retrieval subscription. Step 1: The consumer sends a DELETE request to the ADRF. Step 2: The ADRF responds with a 204 No Content status. + +**Figure 4.2.2.7.2-1: NF service consumer requesting to remove retrieval subscription for data or analytics** + +The NF service consumer shall invoke the Nadrf\_DataManagement\_RetrievalUnsubscribe service operation to remove a retrieval subscription for data or analytics. The NF service consumer shall send an HTTP DELETE request with "{apiRoot}/nadrf-datamanagement//data-retrieval-subscriptions/{subscriptionId}" as Resource URI representing an "Individual ADRF Data Retrieval Subscription" resource, as shown in figure 4.2.2.7.2-1, step 1, where "{subscriptionId}" is the identifier of the existing data retrieval subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request with "{apiRoot}/nadrf-datamanagement//data-retrieval-subscriptions/{subscriptionId}" as Resource URI, if the ADRF successfully processed and accepted the received HTTP DELETE request, the ADRF shall: + +- remove the corresponding subscription; +- respond with HTTP "204 No Content" status. + +If errors occur when processing the HTTP DELETE request, the ADRF shall send an HTTP error response as specified in clause 5.1.7. + +If the ADRF determines the received HTTP DELETE request needs to be redirected, the ADRF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 4.2.2.8 Nadrf\_DataManagement\_RetrievalNotify service operation + +##### 4.2.2.8.1 General + +The Nadrf\_DataManagement\_RetrievalNotify service operation is used by ADRF to notify NF service consumers about subscribed events related to data or analytics and about data or analytics that are about to be deleted. + +##### 4.2.2.8.2 Notification about subscribed data or analytics + +Figure 4.2.2.8.2-1 shows a scenario where the ADRF sends a request to the NF service consumer to notify it about data or analytics events. + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF. The NF service consumer sends a POST {notificationURI} request to the ADRF, and the ADRF responds with a 204 No Content status code.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant ADRF + Note left of NF service consumer: NF service consumer + Note right of ADRF: ADRF + NF service consumer->>ADRF: 1. POST {notificationURI} + ADRF-->>NF service consumer: 2. "204 No Content" + +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF. The NF service consumer sends a POST {notificationURI} request to the ADRF, and the ADRF responds with a 204 No Content status code. + +**Figure 4.2.2.8.2-1: ADRF notifies the NF service consumer about subscribed data or analytics** + +The ADRF shall invoke the Nadrf\_DataManagement\_RetrievalNotify service operation to notify about subscribed data or analytics events. The ADRF shall send an HTTP POST request to the "{notificationURI}" received in the subscription (see clause 5.1.5 for the definition of this notificationURI), as shown in figure 4.2.2.8.2-1, step 1. The NadrfDataRetrievalNotification data structure provided in the request body shall include: + +- notification correlation Id within the "notifCorrId" attribute; +- the time stamp which represents the time when ADRF completes preparation of the requested data or analytics within the "timeStamp" attribute; +- one of the following: + - information about network data analytics function events that occurred in the "anaNotifications" attribute; + - data collected from data sources (e.g. SMF, NEF) in the "dataNotif" attribute; + - information for fetching the data or analytics in the "fetchInstruct" attribute. + +**NOTE:** The fetch correlation identifiers included in the fetch instructions of the "fetchInstruct" attribute can be used to fetch data or analytics using the Nadrf\_DataManagement\_RetrievalRequest service operation as described in clause 4.2.2.5.2. The (mandatory) fetch URI included in the fetch instructions of the "fetchInstruct" attribute is expected to be in line with the standard resource URI defined for the Nadrf\_DataManagement\_RetrievalRequest service operation, i.e. {apiRoot}/nadrf-datamanagement//data-store-records, but it can be anything because it is actually not needed by the NF service consumer in this case. + +The NadrfDataRetrievalNotification data structure provided in the request body may include: + +- a termination request provided by the ADRF within the "terminationReq" attribute. +- data synthesis and compression information within the "dsc" attribute, if the "EnhDataMgmt" feature is supported. + +**NOTE:** The data synthesis and compression information can include an indication that the data have been generated using a data synthesis tool, an indication that the data have been generated using a data compression tool, and information about the data synthesis and/or compression technique. + +Upon the reception of an HTTP POST request with "{notificationURI}" as Resource URI and NadrfDataRetrievalNotification data structure as request body, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall: + +- store the notification; +- respond with HTTP "204 No Content" status code. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.1.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +After the successful processing of the HTTP POST request, if the ADRF requests the NF service consumer to retrieve the data or analytics with the "fetchInstruct" attribute, the NF service consumer may invoke the NadrF\_DataManagement\_RetrievalRequest service operation to retrieve the notified data or analytics as defined in clause 4.2.2.5. + +##### 4.2.2.8.3 Notification about data or analytics that are about to be deleted + +Figure 4.2.2.8.3-1 shows a scenario where the ADRF sends a request to the NF service consumer to notify it about data or analytics that are about to be deleted. + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF. The ADRF sends a POST request with {delNotificationURI} to the NF service consumer, which responds with either a 204 No Content or 200 OK status code.](90ddf538ef276510e2b631f7b96654e6_img.jpg) + +``` +sequenceDiagram + participant ADRF + participant NF as NF service consumer + Note right of ADRF: 1. POST {delNotificationURI} + ADRF->>NF: + Note left of NF: 2. "204 No Content" or "200 OK" + NF->>ADRF: +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF. The ADRF sends a POST request with {delNotificationURI} to the NF service consumer, which responds with either a 204 No Content or 200 OK status code. + +**Figure 4.2.2.8.3-1: ADRF notifies the NF service consumer about data or analytics that are about to be deleted.** + +In order to notify about data or analytics that are about to be deleted, the ADRF shall invoke the NadrF\_DataManagement\_RetrievalNotify service operation. The ADRF shall send an HTTP POST request to the "{delNotificationURI}" received as "delNotifUri" attribute in a storage request as defined in clause 4.2.2.2.2 or in a storage subscription request as defined in clause 4.2.2.3.2, as shown in figure 4.2.2.8.3-1, step 1. The NadrFAlertNotification data structure provided in the request body shall include: + +- a notification correlation identifier within the "delNotifCorrId" attribute; +- a storage transaction identifier, which may be used by the NF service consumer to retrieve the data, within the "alertStorTransId" attribute; + +NOTE: The "alertStorTransId" attribute, which is used for retrieving data prior to deletion, does not have to be the same with or related to the "storeTransId" attribute that is assigned and returned during the storage of the data. + +Upon the reception of an HTTP POST request with "{delNotificationURI}" as Resource URI and NadrFAlertNotification data structure as request body, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall either respond with HTTP "204 No Content" status code or with HTTP "200 OK" status code and the NadrFAlertNotificationResponse data structure in the message body. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.1.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +After the successful processing of the HTTP POST request, the NF service consumer may invoke the NadrF\_DataManagement\_RetrievalRequest service operation as defined in clause 4.2.2.5, using the storage transaction identifier received within the "alertStorTransId" attribute of the NadrFAlertNotification, in order to retrieve the data or analytics that are about to be deleted. + +#### 4.2.2.9 Nadrf\_DataManagement\_Delete service operation + +##### 4.2.2.9.1 General + +The Nadrf\_DataManagement\_Delete service operation is used by an NF service consumer to delete stored data or analytics. + +##### 4.2.2.9.2 Requesting removal of stored data or analytics + +Figure 4.2.2.9.2-1 shows a scenario where the NF service consumer sends a request to the ADRF to delete stored data or analytics. + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF for deleting stored data. Step 1: The consumer sends a DELETE request to the ADRF. Step 2: The ADRF responds with a 204 No Content status.](6f31cdb576d2f15c35c3f266e5f59211_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant ADRF + Note left of NF service consumer: 1. DELETE .../data-store-records/{storeTransId} + NF service consumer->>ADRF: Request + Note right of ADRF: 2. "204 No Content" + ADRF-->>NF service consumer: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF for deleting stored data. Step 1: The consumer sends a DELETE request to the ADRF. Step 2: The ADRF responds with a 204 No Content status. + +Figure 4.2.2.9.2-1: NF service consumer requesting to remove stored data or analytics + +The NF service consumer shall invoke the Nadrf\_DataManagement\_Delete service operation to remove stored data or analytics. The NF service consumer shall send an HTTP DELETE request with "{apiRoot}/nadrf-datamanagement//data-store-records/{storeTransId}" as Resource URI representing an "Individual ADRF Data Store Record" resource, as shown in figure 4.2.2.9.2-1, step 1, where "{storeTransId}" is the transaction identifier of the stored record that is to be deleted. + +Upon the reception of an HTTP DELETE request with "{apiRoot}/nadrf-datamanagement//data-store-records/{storeTransId}" as Resource URI, if the ADRF successfully processed and accepted the received HTTP DELETE request, the ADRF shall: + +- remove the corresponding stored record; +- respond with HTTP "204 No Content" status code. + +If errors occur when processing the HTTP DELETE request, the ADRF shall send an HTTP error response as specified in clause 5.1.7. + +If the ADRF determines the received HTTP DELETE request needs to be redirected, the ADRF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +##### 4.2.2.9.3 Requesting removal of stored data or analytics using data or analytics specification + +Figure 4.2.2.9.3-1 shows a scenario where the NF service consumer sends a request to the ADRF to delete stored data or analytics based on a data or analytics specification. + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a POST request to remove stored data analytics, and the ADRF responds with a 204 No Content status.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant ADRF + Note right of NF service consumer: 1. POST .../remove-stored-data-analytics + NF service consumer->>ADRF: Request + Note left of ADRF: 2. "204 No Content" + ADRF-->>NF service consumer: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a POST request to remove stored data analytics, and the ADRF responds with a 204 No Content status. + +Figure 4.2.2.9.3-1: NF service consumer requesting to remove stored data or analytics + +The NF service consumer shall invoke the Nadrf\_DataManagement\_Delete service operation to remove stored data or analytics based on a data or analytics specification. The NF service consumer shall send an HTTP POST request with "{apiRoot}/nadrf-datamanagement//remove-stored-data-analytics" as URI, as shown in figure 4.2.2.9.3-1, step 1. The POST request body shall contain an NadrfStoredDataSpec data structure. The NadrfStoredDataSpec data structure provided in the request body shall include: + +- a time window in which the data to be deleted was collected in the "timePeriod" attribute; and +- one of the following: + - a data specification in the "dataSpec" attribute; + - an analytics specification in the "anaSpec" attribute; + - a data set identifier within the "dataSetId" attribute, if the "EnhDataMgmt" feature is supported. + +Upon the reception of an HTTP POST request with "{apiRoot}/nadrf-datamanagement//remove-stored-data-analytics" as URI, if the ADRF successfully processed and accepted the received HTTP POST request, the ADRF shall respond with HTTP "204 No Content" status. The ADRF shall remove any stored analytics or data that match the analytics specification, the data specification, or the data set identifier received in the request. + +If errors occur when processing the HTTP POST request, the ADRF shall send an HTTP error response as specified in clause 5.1.7. + +## 4.3 Nadrf\_ MLModelManagement Service + +### 4.3.1 Service Description + +#### 4.3.1.1 Overview + +The Nadrf\_ MLModelManagement service as defined in 3GPP TS 23.288 [14], is provided by the Analytics Data Repository Function (ADRF). + +This service: + +- allows NF consumers to store ML model(s) in the ADRF; +- allows NF consumers to retrieve ML model(s) from an ADRF; and +- allows NF consumers to delete ML model(s) from an ADRF. + +#### 4.3.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [14]. + +The Nadrf\_MLModelManagement service is part of the Nadrf service-based interface exhibited by the Analytics Data Repository Function (ADRF). + +Known consumers of the Nadrf\_MLModelManagement service are: + +- Network Data Analytics Function (NWDAF). + +The Nadrf\_MLModelManagement service is provided by the ADRF and consumed by the NF service consumers as shown in figure 4.3.1.2-1 for the SBI representation model and in figure 4.3.1.2-2 for the reference point representation model. + +![Figure 4.3.1.2-1: Reference Architecture for the Nadrf_MLModelManagement Service; SBI representation](8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg) + +This diagram illustrates the SBI representation of the Nadrf\_MLModelManagement service. At the top, a rectangular box labeled 'ADRF' contains an oval labeled 'Nadrf'. A vertical line descends from the 'Nadrf' oval, labeled 'Nadrf\_MLModelManagement', to a rectangular box at the bottom labeled 'NWDAF'. + +Figure 4.3.1.2-1: Reference Architecture for the Nadrf\_MLModelManagement Service; SBI representation + +**Figure 4.3.1.2-1: Reference Architecture for the Nadrf\_MLModelManagement Service; SBI representation** + +![Figure 4.3.1.2-2: Nadrf_MLModelManagement service architecture, reference point representation](ea4fd10a9a501c602f2bea0f7f711877_img.jpg) + +This diagram illustrates the reference point representation of the Nadrf\_MLModelManagement service. It shows a rectangular box labeled 'ADRF' at the top connected by a vertical line to a rectangular box labeled 'NWDAF' at the bottom. The connection line has a small horizontal tick mark near the NWDAF box. + +Figure 4.3.1.2-2: Nadrf\_MLModelManagement service architecture, reference point representation + +**Figure 4.3.1.2-2: Nadrf\_MLModelManagement service architecture, reference point representation** + +#### 4.3.1.3 Network Functions + +##### 4.3.1.3.1 Analytics Data Repository Function (ADRF) + +The Analytics Data Repository Function (ADRF) provides the functionality to allow NF consumers to store, retrieve, and remove ML model(s) or ML model address(es) from the ADRF. + +##### 4.3.1.3.2 NF Service Consumers + +The NWDAF: + +- supports storing of ML model(s) in the ADRF; +- supports retrieving of ML model(s) from an ADRF; and +- supports deletion of ML model(s) from an ADRF. + +### 4.3.2 Service Operations + +#### 4.3.2.1 Introduction + +**Table 4.3.2.1-1: Operations of the Nadrf\_MLModelManagement Service** + +| Service operation name | Description | Initiated by | +|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| Nadrf_MLModelManagement_StoreRequest | This service operation is used by an NF to request the ADRF to store or update ML model(s). ML model(s) or ML model address(es) are provided to the ADRF in the request message. | NF service consumer (NWDAF) | +| Nadrf_MLModelManagement_RetrieveRequest | This service operation is used by an NF to retrieve stored ML model(s) from the ADRF. | NF service consumer (NWDAF) | +| Nadrf_MLModelManagement_Delete | This service operation is used by an NF to delete stored ML model(s) or ML model address(es) in the ADRF. | NF service consumer (NWDAF) | + +#### 4.3.2.2 Nadrf\_MLModelManagement\_StoreRequest service operation + +##### 4.3.2.2.1 General + +The Nadrf\_MLModelManagement\_StoreRequest service operation is used by an NF service consumer to store ML model(s) or ML model address(es). + +##### 4.3.2.2.2 Request Storage of ML model(s) + +Figure 4.3.2.2.2-1 shows a scenario where the NF service consumer sends a request to the ADRF to store ML model(s). + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a POST request to the ADRF, and the ADRF responds with a 201 Created status.](e05c1a13b44ab41505609d82b00cf4df_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant ADRF as ADRF + Note left of NF: + NF->>ADRF: 1. POST .../mlmodel-store-records + Note right of ADRF: + ADRF-->>NF: 2. "201 Created" + +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a POST request to the ADRF, and the ADRF responds with a 201 Created status. + +**Figure 4.3.2.2.2-1: NF service consumer requesting to store ML model(s)** + +The NF service consumer shall invoke the Nadrf\_MLModelManagement\_StoreRequest service operation to store ML model(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nadrf-mlmodelmanagement//mlmodel-store-records" as Resource URI representing the "ADRF ML Model Store Records" resource, as shown in figure 4.3.2.2.2-1, step 1, to create an "Individual ADRF ML Model Store Record" according to the information in the message body. The NadrfMLModelStoreRecord data structure provided in the request body shall include either the MLModelInfo data structure in the "mlModelInfo" attribute or the MLModel data structure in the "mlModels" attribute. If the MLModelInfo data structure is provided, the unique ML model identifier within the "modelUniqueId" attribute, the address of the ML model within the "mlFileAddr" attribute, and the storage size required for each of the ML model(s) in the "mlStorageSize" attribute shall be included. If the MLModel data structure is provided, the unique ML model identifier within the "modelUniqueId" attribute and the ML model within the "mlModel" attribute shall be included. + +Upon the reception of an HTTP POST request with "{apiRoot}/nadrf-mlmodelmanagement//mlmodel-store-records" as Resource URI and NadrfMLModelStoreRecord data structure as request body, the ADRF shall: + +- create a new ML model store record; +- assign a storeTransId; +- download and store the ML model(s). + +NOTE 1: If the ML model(s) are already stored or being stored in the ADRF, the ADRF will still create a new "Individual ADRF ML Model Store Record" resource and assign a new storeTransId if the ADRF intends to not really store the ML model(s) in the memory again based on the implementation. + +If the ADRF created an "Individual ADRF ML Model Store Record" resource, the ADRF shall respond with "201 Created" with the message body containing a representation of the created ML model record, as shown in figure 4.3.2.2.2-1, step 2. If the storage of the ML models provided in the "mlModelInfo" attribute of the request partially failed, the ADRF may include information about the models that failed to be stored within the "modelStoreResult" attribute in the response. The ADRF shall include a Location HTTP header field, which shall contain the URI of the created record i.e. "{apiRoot}/nadrfs-mlmodelmanagement//mlmodel-store-records/{storeTransId}". + +If an error occurs when processing the HTTP POST request, the ADRF shall send an HTTP error response as specified in clause 5.2.7. + +**Editor's Note:** The use of Application Errors to indicate the result of the storage operation when the operation result is erroneous and is the same for all ML models provided in the store request is FFS. + +#### 4.3.2.3 Nadrf\_MLModelManagement\_RetrievalRequest service operation + +##### 4.3.2.3.1 General + +The Nadrf\_MLModelManagement\_RetrievalRequest service operation is used by an NF service consumer to retrieve stored ML model(s). + +##### 4.3.2.3.2 Request and get stored ML model(s) from ADRF ML Model Store + +Figure 4.3.2.3.2-1 shows a scenario where the NF service consumer sends a request to the ADRF to retrieve stored ML model(s). + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a GET request to the ADRF, and the ADRF responds with a 200 OK status.](803776dff64331076ffc951fc95358ee_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant ADRF + Note right of NF service consumer: NF service consumer + Note left of ADRF: ADRF + NF service consumer->>ADRF: 1. GET .../mlmodel-store-records?query_parameters + ADRF-->>NF service consumer: 2. "200 OK" +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a GET request to the ADRF, and the ADRF responds with a 200 OK status. + +**Figure 4.3.2.3.2-1: NF service consumer requesting to retrieve stored ML model(s)** + +The NF service consumer shall invoke the Nadrf\_MLModelManagement\_RetrievalRequest service operation to retrieve stored ML model(s). The NF service consumer shall send an HTTP GET request with "{apiRoot}/nadrfs-mlmodelmanagement//mlmodel-store-records" as Resource URI representing the "ADRF ML Model Store Records" resource, as shown in figure 4.3.2.3.2-1, step 1, to request ADRF ML model store records according to the storage transaction identifier within the "store-trans-id" attribute or the unique ML model identifier within the "modelUniqueId" attribute. + +Upon the reception of the HTTP GET request, the ADRF shall: + +- find the ML model(s) according to the requested parameters. + +If one or more of the requested ML model(s) are found, the ADRF shall respond with "200 OK" status code with the message body containing the NadrfMLModelStoreRecord data structure. The NadrfMLModelStoreRecord data structure in the response body shall include the MLModelInfo data structure in the "mlModelInfo" attribute with the unique ML model identifier in the "modelUniqueId" attribute and the address of the ML model file stored in the ADRF in the "mlFileAddr" attribute. + +If the NF Service Consumer is not included in the allowed NF consumer list for the ML model and/or is not same as the NF of the NWDAF containing MTLF that stored the model, the ADRF shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "RETRIEVAL\_ML\_MODEL\_NOT\_ALLOWED". + +If none of the requested ML model(s) exist, the ADRF shall respond with "204 No Content". If an error occurs when processing the HTTP GET request, the ADRF shall send an HTTP error response as specified in clause 5.2.7. + +#### 4.3.2.4 Nadrf\_MLModelManagement\_Delete service operation + +##### 4.3.2.4.1 General + +The Nadrf\_MLModelManagement\_Delete service operation is used by an NF service consumer to delete stored ML model(s) or ML model address(es). + +##### 4.3.2.4.2 Requesting removal of stored ML model(s) + +Figure 4.3.2.4.2-1 shows a scenario where the NF service consumer sends a request to the ADRF to delete stored ML model(s). + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF for deleting a stored ML model. The consumer sends a DELETE request to the ADRF, and the ADRF responds with either a 200 OK or a 204 No Content status code.](49a49278cad196bdfe0db6b4dd1be7fd_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant ADRF + Note left of NF: + NF->>ADRF: 1. DELETE .../mlmodel-store-records/{storeTransId} + Note right of ADRF: + ADRF-->>NF: 2. "200 OK" or "204 No Content" +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF for deleting a stored ML model. The consumer sends a DELETE request to the ADRF, and the ADRF responds with either a 200 OK or a 204 No Content status code. + +Figure 4.3.2.4.2-1: NF service consumer requesting to remove stored ML model(s) + +The NF service consumer shall invoke the Nadrf\_MLModelManagement\_Delete service operation to remove the ML model(s) that are stored in the corresponding storage transaction. The NF service consumer shall send an HTTP DELETE request with "{apiRoot}/nadrf-mlmodelmanagement//mlmodel-store-records/{storeTransId}" as Resource URI representing an "Individual ADRF ML Model Store Record" resource, as shown in figure 4.3.2.4.2-1, step 1, where "{storeTransId}" is the transaction identifier of the stored record that is to be deleted. + +Upon the reception of an HTTP DELETE request with "{apiRoot}/nadrf-mlmodelmanagement//mlmodel-store-records/{storeTransId}" as Resource URI, if the ADRF successfully processed and accepted the received HTTP DELETE request, the ADRF shall: + +- remove the storage transaction corresponding stored ML model record; +- respond with HTTP "204 No Content" status code, or with HTTP "200 OK" status code with the message body containing, for each of the ML Models that had been stored under the given storage transaction identifier, the MLModelDelResult data structure with the unique ML model identifier in the "modelUniqueId" attribute and the result in the "delResult" attribute. + +If errors occur when processing the HTTP DELETE request, the ADRF shall send an HTTP error response as specified in clause 5.2.7. + +If the ADRF determines the received HTTP DELETE request needs to be redirected, the ADRF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +##### 4.3.2.4.3 Requesting removal of stored ML model(s) using unique ML model identifier + +Figure 4.3.2.4.3-1 shows a scenario where the NF service consumer sends a request to the ADRF to delete stored ML model(s) based on the unique ML model identifier. + +![Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a POST request to remove a stored ML model, and the ADRF responds with a 200 OK status.](55136bc716146672fc680fa05989f1d2_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant ADRF + Note left of NF service consumer: NF service consumer + Note right of ADRF: ADRF + NF service consumer->>ADRF: 1. POST .../remove-stored-mlmodel + ADRF-->>NF service consumer: 2. "200 OK" +``` + +Sequence diagram showing the interaction between an NF service consumer and an ADRF. The consumer sends a POST request to remove a stored ML model, and the ADRF responds with a 200 OK status. + +Figure 4.3.2.4.3-1: NF service consumer requesting to remove stored ML model(s) + +The NF service consumer shall invoke the Nadrf\_MLModelManagement\_Delete service operation to remove stored ML model(s) based on the unique ML model identifier. The NF service consumer shall send an HTTP POST request with "{apiRoot}/nadrfs-mlmodelmanagement//remove-stored-mlmodel" as URI, as shown in figure 4.3.2.4.3-1, step 1. The POST request body shall contain a NadrfMLModelStoreRecord data structure. The NadrfMLModelStoreRecord data structure provided in the request body shall include the MLModelInfo data structure in the "mlModelInfo" attribute with the unique ML model identifier in the "modelUniqueId" attribute. + +Upon the reception of an HTTP POST request with "{apiRoot}/nadrfs-mlmodelmanagement//remove-stored-mlmodel" as URI, if the ADRF successfully processed and accepted the received HTTP POST request, the ADRF shall remove any stored ML model(s) that match the unique ML model identifier received in the request and respond with HTTP "200 OK" status with the message body containing the MLModelDelResult data structure. The ADRF shall include the unique ML model identifier in the "modelUniqueId" attribute and the result in the "delResult" attribute. If errors occur when processing the HTTP POST request, the ADRF shall send an HTTP error response as specified in clause 5.2.7. + +# 5 API Definitions + +## 5.1 Nadrf\_DataManagement Service API + +### 5.1.1 Introduction + +The Nadrf\_DataManagement service shall use the Nadrf\_DataManagement API. + +The API URI of the Nadrf\_DataManagement API shall be: + +{apiRoot}// + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot}// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nadrn-datamanagement". +- The shall be "v1". +- The shall be set as described in clause 5.1.3. + +### 5.1.2 Usage of HTTP + +#### 5.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nadrn\_DataManagement API is contained in Annex A. + +#### 5.1.2.2 HTTP standard headers + +##### 5.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 5.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 5.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +### 5.1.3 Resources + +#### 5.1.3.1 Overview + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.1.3.1-1 depicts the resource URIs structure for the Nadrn\_DataManagement API. + +![Figure 5.1.3.1-1: Resource URI structure of the Nadrf_DataManagement API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nadrf-datamanagement/. It branches into /data-store-records and /data-retrieval-subscriptions. /data-store-records further branches into /{storeTransId}. /data-retrieval-subscriptions further branches into /{subscriptionId}.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nadrf-datamanagement/"] --> StoreRecords["/data-store-records"] + Root --> RetrievalSubscriptions["/data-retrieval-subscriptions"] + StoreRecords --> StoreTransId["/{storeTransId}"] + RetrievalSubscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Figure 5.1.3.1-1: Resource URI structure of the Nadrf\_DataManagement API. The diagram shows a hierarchical tree structure starting with {apiRoot}/nadrf-datamanagement/. It branches into /data-store-records and /data-retrieval-subscriptions. /data-store-records further branches into /{storeTransId}. /data-retrieval-subscriptions further branches into /{subscriptionId}. + +**Figure 5.1.3.1-1: Resource URI structure of the Nadrf\_DataManagement API** + +Table 5.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------------------------------|------------------------------------------------|---------------------------------|---------------------------------------------------------------------------------------| +| ADRF Data Store Records | /data-store-records | GET | Retrieve the stored data or analytics | +| | | POST | Create a new Individual Data Store resource. | +| Individual ADRF Data Store Record | /data-store-records/{storeTransId} | DELETE | Delete an individual ADRF Data Store Record identified by {storeTransId}. | +| ADRF Data Retrieval Subscriptions | /data-retrieval-subscriptions | POST | Create a new Individual ADRF Data Retrieval Subscription resource. | +| Individual ADRF Data Retrieval Subscription | /data-retrieval-subscriptions/{subscriptionId} | DELETE | Delete an individual ADRF Data Retrieval Subscription identified by {subscriptionId}. | + +#### 5.1.3.2 Resource: ADRF Data Store Records + +##### 5.1.3.2.1 Description + +The ADRF Data Store Records resource represents all data storage records to the Nadrf\_DataManagement Service at a given ADRF. The resource allows an NF service consumer to create a new Individual ADRF Data Store Record resource and to retrieve Individual ADRF Data Store Record resources that fulfil certain criteria. + +##### 5.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nadrf-datamanagement//data-store-records + +The shall be set as described in clause 5.1.1. + +This resource shall support the resource URI variables defined in table 5.1.3.2.2-1. + +**Table 5.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.1.1 | + +##### 5.1.3.2.3 Resource Standard Methods + +###### 5.1.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.1.3.2.3.1-1. + +**Table 5.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.1.3.2.3.1-2 and the response data structures and response codes specified in table 5.1.3.2.3.1-3. + +**Table 5.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|------------------------------------------------| +| NadrfDataStoreRecord | M | 1 | New individual Data Store Record to be created | + +**Table 5.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------| +| NadrfDataStoreRecord | M | 1 | 201
Created | The creation of an Individual Data Store Record resource is confirmed, and a representation of that resource is returned. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.1.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 5.1.3.2.3.1-4: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nadrf-datamanagement//data-store-records/{storeTransId} | + +###### 5.1.3.2.3.2 GET + +This method shall support the URI query parameters specified in table 5.1.3.2.3.2-1. + +**Table 5.1.3.2.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| store-trans-id | string | O | 0..1 | Identifies the "Storage Transaction Identifier" of data store record in ADRF. (NOTE) | +| fetch-correlation-ids | array(string) | O | 1..N | Identifies fetch correlation identifiers received as part of fetch instruction. (NOTE) | +| data-set-id | string | O | 0..1 | Identifies a data set, i.e. the data or analytics records that contain the same value in the data set identifier of their data set tag. It may only be provided if the "EnhDataMgmt" feature is supported. | +| NOTE: Exactly one of "store-trans-id", "fetch-correlation-ids", and "data-set-id" shall be provided. | | | | | + +This method shall support the request data structures specified in table 5.1.3.2.3.1-2 and the response data structures and response codes specified in table 5.1.3.2.3.1-3. + +**Table 5.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------| +| NadrfDataStoreRecord | M | 1 | 200 OK | Data Store record. | +| n/a | | | 204 No Content | If the request ADRF Data Store Record does not exist, the ADRF shall respond with "204 No Content ". | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +##### 5.1.3.2.4 Resource Custom Operations + +None. + +#### 5.1.3.3 Resource: Individual ADRF Data Store Record + +##### 5.1.3.3.1 Description + +The Individual ADRF Data Store Record resource represents data or analytics stored via the Nadrf\_DataManagement\_StorageRequest in ADRF. + +##### 5.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nadrf-datamanagement//data-store-records/{storeTransId} + +The shall be set as described in clause 5.1.1. + +This resource shall support the resource URI variables defined in table 5.1.3.3.2-1. + +**Table 5.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|-----------|---------------------------------------------| +| apiRoot | string | See clause 5.1.1. | +| storeTransId | string | Identifies an individual data store record. | + +##### 5.1.3.3.3 Resource Standard Methods + +###### 5.1.3.3.3.1 DELETE + +This method shall support the URI query parameters specified in table 5.1.3.3.3.1-1. + +**Table 5.1.3.3.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.1.3.3.3.1-2 and the response data structures and response codes specified in table 5.1.3.3.3.1-3. + +**Table 5.1.3.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.1.3.3.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The Individual ADRF Data Store Record resource was deleted successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual ADRF Data Store Record deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual ADRF Data Store Record deletion.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative ADRF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target ADRF (service) instance towards which the request is redirected. | + +**Table 5.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative ADRF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target ADRF (service) instance towards which the request is redirected. | + +##### 5.1.3.3.4 Resource Custom Operations + +None in this release of the specification. + +#### 5.1.3.4 Resource: ADRF Data Retrieval Subscriptions + +##### 5.1.3.4.1 Description + +The ADRF Data Retrieval Subscriptions resource represents all data retrieval subscriptions to the Nadrf\_DataManagement Service at a given ADRF. The resource allows an NF service consumer to create a new Individual ADRF Data Retrieval Subscription resource. + +##### 5.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nadrf-datamanagement//data-retrieval-subscriptions + +The shall be set as described in clause 5.1.1. + +This resource shall support the resource URI variables defined in table 5.1.3.4.2-1. + +**Table 5.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.1.1 | + +##### 5.1.3.4.3 Resource Standard Methods + +###### 5.1.3.4.3.1 POST + +This method shall support the URI query parameters specified in table 5.1.3.4.3.1-1. + +**Table 5.1.3.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.1.3.4.3.1-2 and the response data structures and response codes specified in table 5.1.3.4.3.1-3. + +**Table 5.1.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|---------------------------------------------------------------------| +| NadrfDataRetrievalSubscription | M | 1 | Individual ADRF Data Retrieval Subscription resource to be created. | + +**Table 5.1.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| NadrfDataRetrievalSubscription | M | 1 | 201
Created | The creation of an Individual ADRF Data Retrieval Subscription resource is confirmed and a representation of that resource is returned. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 5.1.3.4.3.1-4: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nadrf-datamanagement//data-retrieval-subscriptions/{subscriptionId} | + +##### 5.1.3.4.4 Resource Custom Operations + +None in this release of the specification. + +#### 5.1.3.5 Resource: Individual ADRF Data Retrieval Subscription + +##### 5.1.3.5.1 Description + +The Individual ADRF Data Retrieval Subscription resource represents single ADRF data retrieval subscription to the Nadrf\_DataManagement Service at a given ADRF. The resource allows an NF service consumer to delete Individual ADRF Data Retrieval Subscription resource. + +##### 5.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nadrf-datamanagement//data-retrieval-subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.1.3.5.2-1. + +**Table 5.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------| +| apiRoot | string | See clause 5.1.1 | +| subscriptionId | string | Identifies a subscription to the Nadrf_DataManagement service. | + +##### 5.1.3.5.3 Resource Standard Methods + +###### 5.1.3.5.3.1 DELETE + +This method shall support the URI query parameters specified in table 5.1.3.5.3.1-1. + +**Table 5.1.3.5.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.1.3.5.3.1-2 and the response data structures and response codes specified in table 5.1.3.5.3.1-3. + +**Table 5.1.3.5.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.1.3.5.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The Individual ADRF Data Retrieval Subscription resource was deleted successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual ADRF Data Store Record deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual ADRF Data Store Record deletion.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.1.3.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative ADRF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target ADRF (service) instance towards which the request is redirected. | + +**Table 5.1.3.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative ADRF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target ADRF (service) instance towards which the request is redirected. | + +##### 5.1.3.5.4 Resource Custom Operations + +None in this release of the specification. + +### 5.1.4 Custom Operations without associated resources + +#### 5.1.4.1 Overview + +The structure of the custom operation URIs of the Nadrf\_DataManagement service is shown in Figure 5.1.4.1-1. + +![Diagram showing the custom operation URI structure of the Nadrf_DataManagement API. A vertical line descends from the root URI to three dashed boxes representing sub-operations: /request-storage-sub, /request-storage-sub-removal, and /remove-stored-data-analytics.](6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg) + +{apiRoot}/nadrf-datamanagement/ + +``` + +graph TD + Root["{apiRoot}/nadrf-datamanagement/"] --> Sub1["/request-storage-sub"] + Root --> Sub2["/request-storage-sub-removal"] + Root --> Sub3["/remove-stored-data-analytics"] + +``` + +Diagram showing the custom operation URI structure of the Nadrf\_DataManagement API. A vertical line descends from the root URI to three dashed boxes representing sub-operations: /request-storage-sub, /request-storage-sub-removal, and /remove-stored-data-analytics. + +**Figure 5.1.4.1-1: Custom operation URI structure of the Nadrf\_DataManagement API** + +Table 5.1.4.1-1 provides an overview of the custom operations and applicable HTTP methods. + +**Table 5.1.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|--------------------------------------------------------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------| +| {apiRoot}/nadrf-datamanagement//request-storage-sub | POST | Request the ADRF to create a subscription for data or analytics and then store the received data or analytics in the ADRF. | +| {apiRoot}/nadrf-datamanagement//request-storage-sub-removal | POST | Request the ADRF to remove a subscription for data or analytics. | +| {apiRoot}/nadrf-datamanagement//remove-stored-data-analytics | POST | Request the ADRF to remove already stored data or analytics. | + +#### 5.1.4.2 Operation: request-storage-sub + +##### 5.1.4.2.1 Description + +The operation is used by the NF service consumer to request the ADRF to create a subscription for data or analytics and then store the received data or analytics in the ADRF. + +##### 5.1.4.2.2 Operation Definition + +This operation shall support the request data structures shown in Table 5.1.4.2.2-1 and the response data structures and error codes specified in Tables 5.1.4.2.2-2. + +**Table 5.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|------------------------------------------------------------------------| +| NadrfDataStoreSubscription | M | 1 | Information about the storage subscription that the ADRF shall create. | + +**Table 5.1.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------| +| NadrDataStoreS
subscriptionRef | M | 1 | 200 OK | Successful request to trigger the creation of a subscription for data or analytics at the ADRF. A reference is provided. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.1.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +#### 5.1.4.3 Operation: request-storage-sub-removal + +##### 5.1.4.3.1 Description + +The operation is used by the NF service consumer to request the ADRF to remove a subscription for data or analytics which was used to store the received data or analytics in the ADRF. + +##### 5.1.4.3.2 Operation Definition + +This operation shall support the request data structures shown in Table 5.1.4.3.2-1 and the response data structures and error codes specified in Tables 5.1.4.3.2-2. + +**Table 5.1.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------------|---|-------------|-------------------------------------------------------------------------| +| NadrDataStoreS
subscriptionRef | M | 1 | Reference used to identify the subscription that the ADRF shall remove. | + +**Table 5.1.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful request to trigger the removal of a subscription for data or analytics at the ADRF. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.1.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +#### 5.1.4.4 Operation: remove-stored-data-analytics + +##### 5.1.4.4.1 Description + +The operation is used by the NF service consumer to request the ADRF to remove stored data or analytics based on a data or analytics specification. + +##### 5.1.4.4.2 Operation Definition + +This operation shall support the request data structures shown in Table 5.1.4.4.2-1 and the response data structures and error codes specified in Tables 5.1.4.4.2-2. + +**Table 5.1.4.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|--------------------------------------------------------------------------| +| NadrfStoredData
Spec | M | 1 | Information about the specification of data or analytics stored in ADRF. | + +**Table 5.1.4.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful request to remove data or analytics at the ADRF based on a data or analytics specification. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.1.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 5.1.5 Notifications + +#### 5.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 5.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------------|----------------------|---------------------------------|--------------------------------------------------------------| +| Retrieval Notification | {notificationURI} | POST | Report data or analytics from ADRF. | +| ADRF Alert Notification | {delNotificationURI} | POST | Notify about data or analytics that are about to be deleted. | + +#### 5.1.5.2 Retrieval Notification + +##### 5.1.5.2.1 Description + +The Retrieval Notification is used by the NF service producer to report one or several data retrieval events to an NF service consumer that has subscribed to such notifications. + +##### 5.1.5.2.2 Target URI + +The Callback URI "{notificationURI}" shall be used with the callback URI variables defined in table 5.1.5.2.2-1. + +**Table 5.1.5.2.2-1: Callback URI variables** + +| Name | Definition | +|-----------------|-----------------------------------------------| +| notificationURI | String formatted as URI with the Callback Uri | + +##### 5.1.5.2.3 Standard Methods + +###### 5.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 5.1.5.2.3.1-1 and the response data structures and response codes specified in table 5.1.5.2.3.1-2. + +**Table 5.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|--------------------------------------------------------| +| NadrfDataRetrievalNotification | M | 1 | Provides information about observed data or analytics. | + +**Table 5.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during the retrieval notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the retrieval notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF service consumer (service) instance towards which the notification request is redirected. | + +**Table 5.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF service consumer (service) instance towards which the notification request is redirected. | + +#### 5.1.5.3 ADRF Alert Notification + +##### 5.1.5.3.1 Description + +The ADRF Alert Notification is used by the NF service producer to notify an NF service consumer about data or analytics that are about to be deleted. + +##### 5.1.5.3.2 Target URI + +The Callback URI "{delNotificationURI}" shall be used with the callback URI variables defined in table 5.1.5.3.2-1. + +**Table 5.1.5.3.2-1: Callback URI variables** + +| Name | Definition | +|--------------------|-----------------------------------------------| +| delNotificationURI | String formatted as URI with the Callback Uri | + +##### 5.1.5.3.3 Standard Methods + +###### 5.1.5.3.3.1 POST + +This method shall support the request data structures specified in table 5.1.5.3.3.1-1 and the response data structures and response codes specified in table 5.1.5.3.3.1-2. + +Table 5.1.5.3.3.1-1: Data structures supported by the POST Request Body + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------------------------------------------| +| NadrAlertNotification | M | 1 | Contains information about data or analytics that are about to be deleted. | + +Table 5.1.5.3.3.1-2: Data structures supported by the POST Response Body + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------| +| NadrAlertNotificationResponse | M | 1 | 200 OK | The receipt of the Notification is acknowledged and a response with information about the planned action is provided. | +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +Table 5.1.5.3.3.1-3: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +Table 5.1.5.3.3.1-4: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +### 5.1.6 Data Model + +#### 5.1.6.1 General + +This clause specifies the application data model supported by the Nadrf\_DataManagement API. + +Table 5.1.6.1-1 specifies the data types defined for the Nadrf\_DataManagement service based interface protocol. + +**Table 5.1.6.1-1: Nadrf\_DataManagement specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------------------|----------------|----------------------------------------------------------------------------------------------------------|---------------| +| DataNotification | 5.1.6.2.9 | Represents a data subscription notification of one of various possible data sources. | | +| DataSetTag | 5.1.6.2.13 | Contains an identifier and a description of associated data or analytics records. | EnhDataMgmt | +| DataSubscription | 5.1.6.2.8 | Contains information about Data specification. | | +| NadrfAlertNotification | 5.1.6.2.11 | Contains information about data or analytics that are about to be deleted. | EnhDataMgmt | +| NadrfAlertNotificationResponse | 5.1.6.2.12 | Contains information about the planned action upon receiving an alert. | EnhDataMgmt | +| NadrfDataRetrievalNotification | 5.1.6.2.5 | Represents a notification that corresponds with an Individual ADRF Data Retrieval Subscription resource. | | +| NadrfDataRetrievalSubscription | 5.1.6.2.4 | Represents an Individual ADRF Data Retrieval Subscription resource. | | +| NadrfDataStoreRecord | 5.1.6.2.2 | Represents an Individual ADRF Data Store Record resource. | | +| NadrfDataStoreSubscription | 5.1.6.2.3 | Contains information to be used by the ADRF to create a Data or Analytics subscription. | | +| NadrfDataStoreSubscriptionRef | 5.1.6.2.6 | Contains a reference to a request for a Data or Analytics subscription. | | +| NadrfStoredDataSpec | 5.1.6.2.7 | Contains information about Data or Analytics specification. | | +| StorageHandlingInfo | 5.1.6.2.10 | Contains storage handling information for data or analytics. | EnhDataMgmt | + +Table 5.1.6.1-2 specifies data types re-used by the Nadrf\_DataManagement service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nadrf\_DataManagement service based interface. + +**Table 5.1.6.1-2: Nadrft\_DataManagement re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|--------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------|---------------| +| AfEventExposureNotif | 3GPP TS 29.517 [20] | Represents notifications on AF event(s) that occurred for an Individual AF Event Subscription resource. | | +| AfEventExposureSubsc | 3GPP TS 29.517 [20] | Represents AF event subscription. | | +| AmfEventNotification | 3GPP TS 29.518 [18] | Represents notifications on AMF event(s) that occurred for an Individual AMF Event Subscription resource. | | +| AmfEventSubscription | 3GPP TS 29.518 [18] | Represents AMF event subscription. | | +| DurationSec | 3GPP TS 29.571 [16] | Unsigned integer identifying a period of time in units of seconds. | EnhDataMgmt | +| DateTime | 3GPP TS 29.571 [16] | Identifies the time. | | +| EeSubscription | 3GPP TS 29.503 [19] | Represents UDM event subscription. | | +| EventNotifyData | 3GPP TS 29.515 [27] | Represents GMLC event notification. | LocEvents | +| FetchInstruction | 3GPP TS 29.576 [24] | The fetch instruction indicates that the data or analytics can be fetched by the consumer. | | +| FormattingInstruction | 3GPP TS 29.574 [23] | DCCF formatting Instructions. | | +| InputData | 3GPP TS 29.515 [27] | Represents GMLC event subscription. | LocEvents | +| MonitoringReport | 3GPP TS 29.503 [19] | UDM Monitoring Report. | | +| NefEventExposureNotif | 3GPP TS 29.591 [21] | Represents notifications on network exposure event(s) that occurred for an Individual Network Exposure Event Subscription resource. | | +| NefEventExposureSubsc | 3GPP TS 29.591 [21] | Represents NEF event subscription. | | +| NfInstanceId | 3GPP TS 29.571 [16] | NF instance identifier. | | +| NfSetId | 3GPP TS 29.571 [16] | NF set identifier. | | +| NnwdafEventsSubscription | 3GPP TS 29.520 [15] | Represents an NWDAF analytics subscription. | | +| NnwdafEventsSubscriptionNotification | 3GPP TS 29.520 [15] | Represents an NWDAF analytics subscription notification. | | +| NotificationData | 3GPP TS 29.510 [10] | Represents an NRF event notification. | | +| NotificationData | 3GPP TS 29.564 [26] | Represents a UPF event notification. | UpEvents | +| NsmfEventExposure | 3GPP TS 29.508 [17] | Represents SMF event subscription. | | +| NsmfEventExposureNotification | 3GPP TS 29.508 [17] | Represents SMF event notification. | | +| ProcessingInstruction | 3GPP TS 29.574 [23] | DCCF processing Instructions. | | +| SACEventReport | 3GPP TS 29.536 [25] | Represents an NSACF event notification. | | +| SACEventSubscription | 3GPP TS 29.536 [25] | Represents and NSACF event subscription. | | +| SubscriptionData | 3GPP TS 29.510 [10] | Represents an NRF event subscription. | | +| SupportedFeatures | 3GPP TS 29.571 [6] | Used to negotiate the applicability of the optional features defined in table 5.1.8-1. | | +| TimeWindow | 3GPP TS 29.122 [22] | Represents a time window. | | + +| | | | | +|----------------------|---------------------|--------------------------------------|----------| +| UpfEventSubscription | 3GPP TS 29.564 [26] | Represents a UPF event subscription. | UpEvents | +| Uri | 3GPP TS 29.571 [16] | URI. | | + +#### 5.1.6.2 Structured data types + +##### 5.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 5.1.6.2.2 Type: NadrfDataStoreRecord + +**Table 5.1.6.2.2-1: Definition of type NadrfDataStoreRecord** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dataNotif | DataNotification | C | 0..1 | Data subscription notification. (NOTE 1) | | +| anaNotifications | array(NnwdafeventsSubscriptionNotification) | C | 1..N | List of analytics subscription notifications. (NOTE 1) | | +| anaSub | NnwdafeventsSubscription | C | 0..1 | Represents the subscription information of the corresponding analytics notification. Shall be present if the "anaNotifications" attribute is provided. (NOTE 2) | | +| dataSetTag | DataSetTag | O | 0..1 | Data set tag of the stored data or analytics. | EnhDataMgmt | +| dsc | string | O | 0..1 | Data synthesis and compression information. (NOTE 3) | EnhDataMgmt | +| dataSub | DataSubscription | C | 0..1 | Represents the subscription information of the corresponding data notification. Shall be present if the "dataNotif" attribute is provided. (NOTE 2) | | +| storeHandl | StorageHandlingInfo | O | 0..1 | Contains storage handling information for the data or analytics that are being stored. | EnhDataMgmt | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features as described in clause 5.1.8. It shall be present if at least one feature defined in clause 5.1.8 is supported. | | + +NOTE 1: Exactly one of the attributes "anaNotifications" and "dataNotif" shall be provided. + +NOTE 2: Exactly one of the attributes "anaSub" and "dataSub" shall be provided. + +NOTE 3: The format and the contents of this attribute are up to the implementation. + +##### 5.1.6.2.3 Type: NadrfDataStoreSubscription + +Table 5.1.6.2.3-1: Definition of type NadrfDataStoreSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| anaSub | NnwdafEventsSubscription | C | 0..1 | Subscribed analytics events. (NOTE 1) | | +| dataSetTag | DataSetTag | O | 0..1 | Data set tag of the stored data or analytics. | EnhDataMgmt | +| dataSub | DataSubscription | C | 0..1 | Represents requested Events subscription. (NOTE 1) | | +| targetNfId | NfInstanceId | C | 0..1 | DCCF or NWDAF NF instance identifier to which the ADRF shall create the requested subscription. (NOTE 2) | | +| targetNfSetId | NfSetId | C | 0..1 | DCCF or NWDAF NF set identifier to which the ADRF shall create the requested subscription. (NOTE 2) | | +| formatInstruc | FormattingInstruction | O | 0..1 | Formatting instructions to be used for sending event notifications. | | +| procInstruc | ProcessingInstruction | O | 0..1 | Processing instructions to be used for sending event notifications. (NOTE 3) | | +| multiProcInstruc | array(ProcessingInstruction) | O | 1..N | Processing instructions to be used for sending event notifications. (NOTE 3) | MultiProcessingInstruction | +| storeHandl | StorageHandlingInfo | O | 0..1 | Contains storage handling information for the data or analytics that will be collected and stored based on the requested subscription. | EnhDataMgmt | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features as described in clause 5.1.8. It shall be present if at least one feature defined in clause 5.1.8 is supported. | | + +NOTE 1: Exactly one of these attributes shall be provided. + +NOTE 2: One of "targetNfId" and "targetNfSetId" shall be provided. + +NOTE 3: The "multiProcInstruc" attribute shall be used instead of the "procInstruc" attribute when the "MultiProcessingInstruction" feature is supported. + +##### 5.1.6.2.4 Type: NadrfDataRetrievalSubscription + +Table 5.1.6.2.4-1: Definition of type NadrfDataRetrievalSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| anaSub | NnwdafEventsSubscription | C | 0..1 | Subscribed analytics events. (NOTE 1) | | +| dataSetId | string | C | 0..1 | Data set identifier of stored data or analytics records. (NOTE 1) | EnhDataMgmt | +| dataSub | DataSubscription | C | 0..1 | Represents requested Events subscription. (NOTE 1) | | +| notificationURI | Uri | M | 1 | Notification target address. | | +| timePeriod | TimeWindow | M | 1 | Represents a start time and a stop time during which the requested data is collected and/or will be collected at the data source. | | +| notifCorrId | string | M | 1 | Notification correlation identifier provided by the NF service consumer to be used later by the ADRF in the notifications that correspond with this subscription. The value of this attribute shall be unique per subscription for a given NF service consumer. | | +| consTrigNotif | boolean | O | 0..1 | If provided and set to "true", it indicates that notifications shall be buffered (sending only fetch instructions to the NF service consumer) until the NF service consumer requests their delivery using Nadrf_DataManagement Service.
The default value is "false". | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features as described in clause 5.1.8. It shall be present if at least one feature defined in clause 5.1.8 is supported. | | + +NOTE 1: Exactly one of these attributes shall be provided. + +##### 5.1.6.2.5 Type: NadrfDataRetrievalNotification + +Table 5.1.6.2.5-1: Definition of type NadrfDataRetrievalNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifCorrId | string | M | 1 | This attribute indicates the notification correlation identifier provided by the NF service consumer during the data retrieval subscription. This parameter can be useful if the NF service consumer uses a common callback URI for multiple subscriptions. | | +| anaNotifications | array(NnwdafeventsSubscriptionNotification) | C | 1..N | List of analytics subscription notifications. (NOTE 1) | | +| dataNotif | DataNotification | C | 0..1 | Data subscription notification. (NOTE 1) | | +| fetchInstruc | FetchInstruction | C | 0..1 | The fetch instruction indicates that the data or analytics can be fetched by the consumer. (NOTE 1) | | +| terminationReq | boolean | O | 0..1 | If provided and set to "true", it indicates that the subscription is requested to be terminated, i.e. no further notifications related to this subscription will be provided. The default value is "false". | | +| dsc | string | O | 0..1 | Data synthesis and compression information. (NOTE 2) | EnhDataMgmt | +| timeStamp | DateTime | M | 1 | It represents the time when ADRF completed preparation of the requested data or analytics. | | + +NOTE 1: Exactly one of these attributes shall be provided. + +NOTE 2: The format and the contents of this attribute are up to the implementation. + +##### 5.1.6.2.6 Type: NadrfDataStoreSubscriptionRef + +Table 5.1.6.2.6-1: Definition of type NadrfDataStoreSubscriptionRef + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| transRefId | string | C | 0..1 | Transaction reference identifier. (NOTE) | | +| dataSetId | string | C | 0..1 | Data set identifier associated with a storage subscription. (NOTE) | EnhDataMgmt | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features as described in clause 5.1.8. It shall be present in the POST response if the NF service consumer includes the "suppFeat" attribute in the POST request. | | + +NOTE: One of the "transRefId" and "dataSetId" attributes shall be provided. + +##### 5.1.6.2.7 Type: NadrfStoredDataSpec + +Table 5.1.6.2.7-1: Definition of type NadrfStoredDataSpec + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------|---------------| +| dataSpec | DataSubscription | C | 0..1 | Represents data specification. (NOTE) | | +| anaSpec | NnwdafEventsSubscription | C | 0..1 | Represents analytics specification. (NOTE) | | +| timePeriod | TimeWindow | M | 1 | Represents a start time and a stop time during which the requested data to be removed was collected at the data source. | | +| dataSetId | string | C | 0..1 | Data set identifier of stored data or analytics records. (NOTE) | EnhDataMgmt | + +NOTE: Exactly one of these attributes shall be provided. + +##### 5.1.6.2.8 Type: DataSubscription + +Table 5.1.6.2.8-1: Definition of type DataSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|--------------------------------------------------------|---------------| +| amfDataSub | AmfEventSubscription | C | 0..1 | Represents requested AMF Events subscription. (NOTE) | | +| smfDataSub | NsmfEventExposure | C | 0..1 | Represents requested SMF Events subscription. (NOTE) | | +| udmDataSub | EeSubscription | C | 0..1 | Represents requested UDM Events subscription. (NOTE) | | +| nefDataSub | NefEventExposureSubsc | C | 0..1 | Represents requested NEF Events subscription. (NOTE) | | +| afDataSub | AfEventExposureSubsc | C | 0..1 | Represents requested AF Events subscription. (NOTE) | | +| nrfDataSub | SubscriptionData | C | 0..1 | Represents requested NRF Events subscription. (NOTE) | | +| nsacfDataSub | SACEventSubscription | C | 0..1 | Represents requested NSACF Events subscription. (NOTE) | | +| upfDataSub | UpfEventSubscription | C | 0..1 | Represents requested UPF Events subscription. (NOTE) | UpEvents | +| gmlcDataSub | InputData | C | 0..1 | Represents requested GMLC Events subscription. (NOTE) | LocEvents | + +NOTE: Exactly one of these attributes shall be provided. + +##### 5.1.6.2.9 Type: DataNotification + +Table 5.1.6.2.9-1: Definition of type DataNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------------------------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| afEventNotifs | array(AfEventExposureNotif) | C | 1..N | List of notifications on AF event(s). (NOTE 1) | | +| amfEventNotifs | array(AmfEventNotification) | C | 1..N | List of notifications on AMF event(s). (NOTE 1) | | +| gmlcEventNotifs | array(EventNotifyData) | C | 1..N | List of notifications on GMLC event(s). (NOTE 1) | LocEvents | +| smfEventNotifs | array(NsmfEventExposureNotification) | C | 1..N | List of notifications on SMF event(s). (NOTE 1) | | +| udmEventNotifs | array(MonitoringReport) | C | 1..N | List of monitoring reports containing information about UDM event(s). (NOTE 1) | | +| nefEventNotifs | array(NefEventExposureNotif) | C | 1..N | List of notifications on network exposure event(s). (NOTE 1) | | +| nrfEventNotifs | array(NotificationData) | C | 1..N | List of notifications on NRF event(s) as defined in 3GPP TS 29.510 [10]. (NOTE 1) | | +| nsacfEventNotifs | array(SACEventReport) | C | 1..N | List of notifications on NSACF event(s). (NOTE 1) | | +| upfEventNotifs | array(NotificationData) | C | 1..N | List of notifications on UPF event(s) as defined in 3GPP TS 29.564 [26]. (NOTE 1) | UpEvents | +| timeStamp | DateTime | O | 0..1 | Indicates the timestamp for the event(s). (NOTE 2) | | + +NOTE 1: Exactly one of these attributes shall be provided. + +NOTE 2: The "timeStamp" attribute within the DataNotification data type may be provided if any of the "timeStamp" attribute within AfEventNotification contained in the AfEventExposureNotif, or within AmfEventReport contained in the AmfEventNotification, or within EventNotification contained in the NsmfEventExposureNotification, or within MonitoringReport, or within NefEventNotification contained in the NefEventExposureNotif, or within SACEventReportItem contained in the SACEventReport, or, if the UpEvents feature is supported, within the NotificationItem contained in the NotificationData data type, or, if the LocEvents feature is supported, the "timestampOfLocationEstimate" attribute within EventNotifyData, is not provided. + +##### 5.1.6.2.10 Type: StorageHandlingInfo + +Table 5.1.6.2.10-1: Definition of type StorageHandlingInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| lifetime | DurationSec | O | 0..1 | Indicates the lifetime of the provided data or analytics as a duration in seconds. | | +| delNotifUri | Uri | O | 0..1 | Notification Uri for receiving deletion alerts. Its presence indicates that the NF service consumer wants to receive such notifications. | | +| delNotifCorrId | string | C | 0..1 | Notification correlation identifier for the deletion alerts. It shall be provided if the "delNotifUri" attribute is provided. | | + +5.1.6.2.11 Type: NadrfAlertNotification + +**Table 5.1.6.2.11-1: Definition of type NadrfAlertNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------|---------------| +| alertStorTransId | string | M | 1 | Storage transaction identifier that can be used to retrieve the data or analytics that are about to be deleted. | | +| delNotifCorrId | string | M | 1 | Notification correlation identifier for the alert. | | + +5.1.6.2.12 Type: NadrfAlertNotificationResponse + +**Table 5.1.6.2.12-1: Definition of type NadrfAlertNotificationResponse** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| retrievalInd | boolean | M | 1 | If the NF service consumer had received a Data or Analytics Deletion Alert in the notification and determined to retrieve stored data or analytics prior to deletion, it shall be set to "true". Otherwise, it shall be set to "false". | | + +5.1.6.2.13 Type: DataSetTag + +**Table 5.1.6.2.13-1: Definition of type DataSetTag** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------|---------------| +| dataSetId | string | M | 1 | Data set identifier of data or analytics records. | | +| dataSetDesc | string | O | 0..1 | Human-readable data set description of data or analytics records. | | + +5.1.6.3 Simple data types and enumerations + +None. + +5.1.6.4 Data types describing alternative data types or combinations of data types + +None. + +5.1.7 Error Handling + +5.1.7.1 General + +For the Nadrf\_DataManagement API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nadrf\_DataManagement API. + +#### 5.1.7.2 Protocol Errors + +No specific procedures for the Nadr\_f\_DataManagement service are specified. + +#### 5.1.7.3 Application Errors + +The application errors defined for the Nadr\_f\_DataManagement service are listed in Table 5.1.7.3-1. + +**Table 5.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 5.1.8 Feature negotiation + +The optional features in table 5.1.8-1 are defined for the Nadr\_f\_DataManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|----------------------------|---------------------------------------------------------------| +| 1 | MultiProcessingInstruction | Indicates the support of multiple processing instructions. | +| 2 | UpEvents | Indicates the support of UPF events. | +| 3 | EnhDataMgmt | Indicates the support of enhanced data management mechanisms. | +| 4 | LocEvents | This feature indicates the support of location events. | + +### 5.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nadr\_f\_DataManagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nadr\_f\_DataManagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nadr\_f\_DataManagement API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nadr\_f\_DataManagement service. + +The Nadr\_f\_DataManagement API defines the following scopes for OAuth2 authorization as described in 3GPP TS 29.501 [5], clause 4.10. + +**Table 5.1.9-1: OAuth2 scopes defined in Nadr\_f\_DataManagement API** + +| Scope | Description | +|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "nnadr_f-datamanagement" | Access to the Nadr_f_DataManagement API | +| "nnadr_f-datamanagement:storage-read-delete-subs" | Access to service operations applying to Nadr_f_DataManagement_StorageSubscriptionRequest, Nadr_f_DataManagement_StorageSubscriptionRemoval, Nadr_f_DataManagement_RetrievalRequest, Nadr_f_DataManagement_RetrievalSubscribe, Nadr_f_DataManagement_RetrievalUnsubscribe, Nadr_f_DataManagement_RetrievalNotify, Nadr_f_DataManagement_Delete service operations. | + +## 5.2 Nadrf\_ MLModelManagement Service API + +### 5.2.1 Introduction + +The Nadrf\_ MLModelManagement service shall use the Nadrf\_ MLModelManagement API. + +The API URI of the Nadrf\_ MLModelManagement API shall be: + +**{apiRoot}
/** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nadrf-mlmodelmanagement". +- The shall be "v1". +- The shall be set as described in clause 5.2.3. + +### 5.2.2 Usage of HTTP + +#### 5.2.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nadrf\_ MLModelManagement API is contained in Annex A. + +#### 5.2.2.2 HTTP standard headers + +##### 5.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 5.2.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +##### 5.2.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +### 5.2.3 Resources + +#### 5.2.3.1 Overview + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.2.3.1-1 depicts the resource URIs structure for the Nadrf\_MLModelManagement API. + +![Diagram showing the hierarchical structure of resource URIs for the Nadrf_MLModelManagement API. The root is {apiRoot}/nadrf-mlmodelmanagement/. A line branches off to a box containing /mlmodel-store-records. From this box, another line branches off to a box containing /{storeTransId}.](fe7304192caf64cda93b580c5e7e5c06_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nadrf-mlmodelmanagement/"] --> Box1["/mlmodel-store-records"] + Box1 --> Box2["/{storeTransId}"] + +``` + +Diagram showing the hierarchical structure of resource URIs for the Nadrf\_MLModelManagement API. The root is {apiRoot}/nadrf-mlmodelmanagement/. A line branches off to a box containing /mlmodel-store-records. From this box, another line branches off to a box containing /{storeTransId}. + +**Figure 5.2.3.1-1: Resource URI structure of the Nadrf\_MLModelManagement API** + +Table 5.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------------------------|---------------------------------------|---------------------------------|-------------------------------------------------------------------------------| +| ADRF ML Model Store Records | /mlmodel-store-records | GET | Retrieve the stored ML model(s). | +| | | POST | Create a new Individual ML Model Store resource. | +| Individual ADRF ML Model Store Record | /mlmodel-store-records/{storeTransId} | DELETE | Delete an individual ADRF ML Model Store Record identified by {storeTransId}. | + +#### 5.2.3.2 Resource: ADRF ML Model Store Records + +##### 5.2.3.2.1 Description + +The ADRF ML Model Store Records resource represents all ML model storage records to the Nadrf\_MLModelManagement Service at a given ADRF. The resource allows an NF service consumer to create a new Individual ADRF ML Model Store Record resource and to retrieve Individual ADRF ML Model Store Record resources that fulfil certain criteria. + +##### 5.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nadrf-mlmodelmanagement//mlmodel-store-records + +The shall be set as described in clause 5.2.1. + +This resource shall support the resource URI variables defined in table 5.2.3.2.2-1. + +**Table 5.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.2.1 | + +##### 5.2.3.2.3 Resource Standard Methods + +###### 5.2.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.2.3.2.3.1-1. + +**Table 5.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.2.3.2.3.1-2 and the response data structures and response codes specified in table 5.2.3.2.3.1-3. + +**Table 5.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|----------------------------------------------------| +| NadrfMLModelStoreRecord | M | 1 | New individual ML Model Store Record to be created | + +**Table 5.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------| +| NadrfMLModelStoreRecord | M | 1 | 201
Created | The creation of an Individual ML Model Store Record resource is confirmed, and a representation of that resource is returned. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.1.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 5.2.3.2.3.1-4: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | O | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nadrf-mlmodelmanagement//mlmodel-store-records/{storeTransId} | + +###### 5.2.3.2.3.2 GET + +This method shall support the URI query parameters specified in table 5.2.3.2.3.2-1. + +**Table 5.2.3.2.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------|-----------|---|-------------|------------------------------------------------------------------------------------------| +| store-trans-id | string | O | 0..1 | Identifies the "Storage Transaction Identifier" of ML model store record in ADRF. (NOTE) | +| modelUniqueId | UInteger | O | 0..N | Identifies the unique ML model identifier of the ML model stored in ADRF. (NOTE) | +| NOTE: Exactly one of "store-trans-id" and "modelUniqueId" shall be provided. | | | | | + +This method shall support the request data structures specified in table 5.2.3.2.3.2-2 and the response data structures and response codes specified in table 5.2.3.2.3.2-3. + +**Table 5.2.3.2.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.3.2.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------| +| NadrfMLModelStoreRecord | M | 1 | 200 OK | ML Model Store record. | +| n/a | | | 204 No Content | If the request ADRF ML Model Store Record does not exist, the ADRF shall respond with "204 No Content". | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: Failure cases are described in clause 5.2.7. + +##### 5.2.3.2.4 Resource Custom Operations + +None. + +#### 5.2.3.3 Resource: Individual ADRF ML Model Store Record + +##### 5.2.3.3.1 Description + +The Individual ADRF ML Model Store Record resource represents ML model(s) stored via the Nadrf\_MLModelManagement\_StorageRequest in ADRF. + +##### 5.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nadrf-mlmodelmanagement//mlmodel-store-records/{storeTransId} + +The shall be set as described in clause 5.2.1. + +This resource shall support the resource URI variables defined in table 5.2.3.3.2-1. + +**Table 5.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|-----------|---------------------------------------------| +| apiRoot | string | See clause 5.2.1. | +| storeTransId | string | Identifies an individual data store record. | + +##### 5.2.3.3.3 Resource Standard Methods + +###### 5.2.3.3.3.1 DELETE + +This method shall support the URI query parameters specified in table 5.2.3.3.3.1-1. + +**Table 5.2.3.3.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.2.3.3.3.1-2 and the response data structures and response codes specified in table 5.2.3.3.3.1-3. + +**Table 5.2.3.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.3.3.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The Individual ADRF ML Model Store Record resource was deleted successfully. | +| array(MLModelDelResult) | | 1..N | 200 OK | Attempted to remove ML model(s) in the Individual ADRF ML Model Store Record resource. A representation of ML Model delete result information is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual ADRF ML Model Store Record deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual ADRF ML Model Store Record deletion.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative ADRF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target ADRF (service) instance towards which the request is redirected. | + +**Table 5.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative ADRF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target ADRF (service) instance towards which the request is redirected. | + +##### 5.2.3.3.4 Resource Custom Operations + +None in this release of the specification. + +### 5.2.4 Custom Operations without associated resources + +#### 5.2.4.1 Overview + +The structure of the custom operation URIs of the Nadrn\_ MLModelManagement service is shown in Figure 5.2.4.1-1. + +{apiRoot}/nadr-mlmodelmanagement/ + +![Diagram showing the URI structure for the Nadrf_MLModelManagement API. The base URI is {apiRoot}/nadr-mlmodelmanagement/. A dashed box highlights the custom operation path /remove-stored-mlmodel, which is connected to the base URI by a line.](03d9aaba6c1af8bfd8e42c1d2422ae5c_img.jpg) + +Diagram showing the URI structure for the Nadrf\_MLModelManagement API. The base URI is {apiRoot}/nadr-mlmodelmanagement/. A dashed box highlights the custom operation path /remove-stored-mlmodel, which is connected to the base URI by a line. + +**Figure 5.2.4.1-1: Custom operation URI structure of the Nadrf\_MLModelManagement API** + +Table 5.2.4.1-1 provides an overview of the custom operations and applicable HTTP methods. + +**Table 5.2.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|---------------------------------------------------------------------|--------------------|-----------------------------------------------------| +| {apiRoot}/nadr-mlmodelmanagement//remove-stored-mlmodel | POST | Request the ADRF to remove already stored ML model. | + +#### 5.2.4.4 Operation: remove-stored-mlmodel + +##### 5.2.4.4.1 Description + +The operation is used by the NF service consumer to request the ADRF to remove stored ML model(s) based on a unique ML model identifier. + +##### 5.2.4.4.2 Operation Definition + +This operation shall support the request data structures shown in Table 5.2.4.4.2-1 and the response data structures and error codes specified in Tables 5.2.4.4.2-2. + +**Table 5.2.4.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|------------------------------------------------------------| +| NadrfMLModelStoreRecord | M | 1 | Unique ML model identifier of the ML model stored in ADRF. | + +**Table 5.1.4.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(MLModelDelResult) | | 1..N | 200 OK | Attempted to remove ML model(s) in in the ADRF based on the unique ML model identifier. A representation of ML Model delete result information is returned. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.1.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 5.2.5 Notifications + +None in this release of the specification. + +### 5.2.6 Data Model + +#### 5.2.6.1 General + +This clause specifies the application data model supported by the Nadrf\_MLModelManagement API. + +Table 5.2.6.1-1 specifies the data types defined for the Nadrf\_MLModelManagement service based interface protocol. + +**Table 5.2.6.1-1: Nadrf\_MLModelManagement specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| AllowedConsumer | 5.2.6.2.6 | Contains the identifier of NF instance and NF set. | | +| DeleteResult | 5.2.6.3.1 | Indicates the result of the delete operation. | | +| NadrfMLModelStoreRecord | 5.2.6.2.2 | Represents an Individual ADRF ML Model Store Record resource. | | +| MLModel | 5.2.6.2.4 | Represents an ML model. | | +| MLModelDelResult | 5.2.6.2.5 | Represents information provided in the response to the ML Model Nadrf_MLModelManagement Delete service operation. | | +| MLModelInfo | 5.2.6.2.3 | Represents information of the ML Model. | | +| ModelStoreResult | 5.2.6.2.7 | Contains information about ML model storage result. | | +| StoreResult | 5.2.6.3.2 | Indicates the result of the store operation. | | + +Table 5.2.6.1-2 specifies data types re-used by the Nadrf\_MLModelManagement service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nadrf\_MLModelManagement service based interface. + +**Table 5.2.6.1-2: Nadrf\_MLModelManagement re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|----------------------------------------------------------------------------------------|---------------| +| Binary | 3GPP TS 29.571 [16] | String with format "binary". | | +| MLModelAddr | 3GPP TS 29.520 [15] | Address of ML model file | | +| NfInstanceId | 3GPP TS 29.571 [16] | NF instance identifier. | | +| NfSetId | 3GPP TS 29.571 [16] | NF set identifier. | | +| SupportedFeatures | 3GPP TS 29.571 [16] | Used to negotiate the applicability of the optional features defined in table 5.2.8-1. | | +| UInteger | 3GPP TS 29.571 [16] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. | | + +#### 5.2.6.2 Structured data types + +##### 5.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 5.2.6.2.2 Type: NadrfMLModelStoreRecord + +Table 5.2.6.2.2-1: Definition of type NadrfMLModelStoreRecord + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| nfInstanceId | NfInstanceId | C | 0..1 | NF instanceIdentifier of the NWDAF containing MTLF. (NOTE 1) | | +| nfSetId | NfSetId | C | 0..1 | NFset identifier of the NWDAF containing MTLF. (NOTE 1) | | +| mlModelInfo | array(MLModelInfo) | C | 1..N | ML Model information. (NOTE 2) | | +| mlModels | array(MLModel) | C | 1..N | Each element represents an ML model. (NOTE 2) | | +| modelStoreResult | array(ModelStoreResult) | O | 1..N | Indicates the result of the store operation. (NOTE 3) | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features as described in clause 5.2.7. It shall be present if at least one feature defined in clause 5.2.7 is supported. | | + +NOTE 1: One of "nfInstanceId" and "nfSetId" attributes shall be provided. +NOTE 2: Any of the "mlModelInfo" and "mlModels" attributes shall be provided. +NOTE 3: The "modelStoreResult" attribute is only applicable to the response to an Nadrf\_MLModelManagement\_StoreRequest service operation. + +##### 5.2.6.2.3 Type: MLModelInfo + +Table 5.2.6.2.3-1: Definition of type MLModelInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|------------------------|---|-------------|-----------------------------------------------------------|---------------| +| modelUniqueId | UInteger | M | 1 | Unique ML Model identifier | | +| mlFileAddr | MLModelAddr | M | 1 | Address (e.g. a URL or an FQDN) of the ML model file. | | +| mlStorageSize | UInteger | M | 1 | Storage size in octets required for each of the ML model. | | +| allowConsumerList | array(AllowedConsumer) | O | 1..N | The allowed NF consumer list for the ML model. | | + +##### 5.2.6.2.4 Type: MLModel + +Table 5.2.6.2.4-1: Definition of type MLModel + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|---------------------------------------------------|---------------| +| modelUniqueId | UInteger | M | 1 | Unique ML Model identifier | | +| mlModel | Binary | M | 1 | Represents an ML model. The value is out of 3GPP. | | + +##### 5.2.6.2.5 Type: MLModelDelResult + +Table 5.2.6.2.5-1: Definition of type MLModelOpResult + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|----------------------------------------------|---------------| +| modelUniqueId | Uinteger | M | 1 | Unique ML Model identifier | | +| delResult | DeleteResult | M | 1 | Indicates the result of the delete operation | | + +##### 5.2.6.2.6 Type: AllowedConsumer + +Table 5.2.6.2.6-1: Definition of type AllowedConsumer + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|------------------------------------|---------------| +| nfInstanceId | NfInstanceId | C | 0..1 | Identification of NF instance. | | +| nfSetId | NfSetId | C | 0..1 | Identification of NF instance set. | | + +NOTE: One of "nfInstanceId" and "nfSetId" attributes shall be provided. + +##### 5.2.6.2.7 Type: ModelStoreResult + +Table 5.2.6.2.7-1: Definition of type ModelStoreResult + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|---------------------------------------------|---------------| +| modelUniqueId | Uinteger | M | 1 | Unique ML Model identifier of the ML Model. | | +| storeResult | StoreResult | M | 1 | Storage result information. | | + +#### 5.2.6.3 Simple data types and enumerations + +##### 5.2.6.3.1 Enumeration: DeleteResult + +Table 5.2.6.3.1-1: Enumeration DeleteResult + +| Attribute name | Description | Applicability | +|--------------------------------|----------------------------------------------------------------|---------------| +| ML_MODEL_DELETED | Indicates that the ML model was deleted in ADRF. | | +| ML_MODEL_NOT_FOUND | Indicates that the ML model was not found in ADRF. | | +| ML_MODEL_FOUND_BUT_NOT_DELETED | Indicates that the ML model was found in ADRF but not deleted. | | + +##### 5.2.6.3.2 Enumeration: StoreResult + +Table 5.2.6.3.2-1: Enumeration StoreResult + +| Attribute name | Description | Applicability | +|---------------------------------|--------------------------------------------------------------|---------------| +| ML_MODEL_FILE_STORED_IN_ADRF | Indicates that the ML model was successfully stored in ADRF, | | +| ML_MODEL_FILE_ADDRESS_NOT_FOUND | Indicates that the ML model file address was not found. | | +| ML_MODEL_FILE_DOWNLOAD_FAILED | Indicates that the download of the ML model file failed. | | + +#### 5.2.6.4 Data types describing alternative data types or combinations of data types + +None. + +### 5.2.7 Error Handling + +#### 5.2.7.1 General + +For the Nadrf\_MLModelManagement API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nadrf\_MLModelManagement API. + +#### 5.2.7.2 Protocol Errors + +No specific procedures for the Nadrf\_MLModelManagement service are specified. + +#### 5.2.7.3 Application Errors + +The application errors defined for the Nadrf\_MLModelManagement service are listed in Table 5.2.7.3-1. + +**Table 5.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------------------|------------------|--------------------------------------------------------------| +| RETRIEVAL_ML_MODEL_NOT_ALLOWED | 403 Forbidden | Indicates that the retrieval of the ML model is not allowed. | + +### 5.2.8 Feature negotiation + +The optional features in table 5.2.8-1 are defined for the Nadrf\_MLModelManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 5.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nadrf\_MLModelManagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nadrf\_MLModelManagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nadrf\_MLModelManagement API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nadrf\_MLModelManagement service. + +The Nnwdaf\_MLModelManagement API defines a single scope "nnwdaf-mlmodelmanagement" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nadrf\_DataManagement API + +``` +openapi: 3.0.0 +info: + version: 1.1.0-alpha.5 + title: Nadrf_DataManagement + description: | + ADRF Data Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + externalDocs: + description: 3GPP TS 29.575 V18.4.0; 5G System; Analytics Data Repository Services; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.575/' +# +servers: + - url: '{apiRoot}/nadrf-datamanagement/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. +# +security: + - oAuth2ClientCredentials: + - nadrf-datamanagement + - {} +# +paths: + /data-store-records: + post: + summary: Creates a new Individual Data Store Record resource. + operationId: CreateADRFDataStoreRecord + tags: + - ADRF Data Store Records (Collection) + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfDataStoreRecord' + required: true + description: ADRF data store record to be stored. + responses: + '201': + description: Successful creation of new Individual ADRF Data Store Record resource. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure +``` + +``` +{apiRoot}/nadrf-datamanagement//data-store-records/{storeTransId} +required: true +schema: + type: string +content: + application/json: + schema: + $ref: '#/components/schemas/NadrfDataStoreRecord' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + storageAlertNotification: + '{ $request.body#/delNotifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfAlertNotification' +responses: + '200': + description: The alert receipt is acknowledged and a planned action is provided. + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfAlertNotificationResponse' + '204': + description: The alert receipt is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +get: + summary: Retrieves existing Individual ADRF Data Store Records. + operationId: GetAdrfDataStoreRecords + tags: + - ADRF Data Store Records (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nnadrf-datamanagement + - oAuth2ClientCredentials: + - nnadrf-datamanagement + - nnadrf-datamanagement:storagerequest + parameters: + - name: store-trans-id + description: A storage transaction identifier of a data store record in ADRF. + in: query + required: false + schema: + type: string + - name: fetch-correlation-ids + description: Fetch correlation identifiers received as part of fetch instruction. + in: query + required: false + style: form + explode: false + schema: + type: array + items: + type: string + minItems: 1 + - name: data-set-id + description: The data set identifier. + in: query + required: false + schema: + type: string + responses: + '200': + description: Data store records are returned. + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfDataStoreRecord' + '204': + description: No matching ADRF data were found. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/data-store-records/{storeTransId}: + delete: + summary: Delete an existing Individual ADRF Data Store Record. + operationId: DeleteADRFDataStoreRecord + tags: + - Individual ADRF Data Store Record (Document) + parameters: + - name: storeTransId + in: path + description: String identifying a Data Store Record in ADRF. + required: true + schema: +``` + +``` + + type: string + responses: + '204': + description: > + No Content. The Individual ADRF Data Store Record resource matching the + storeTransId was deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/data-retrieval-subscriptions: + post: + summary: Creates a new Individual ADRF Data Retrieval Subscription resource. + operationId: CreateADRFDataRetrievalSubscription + tags: + - ADRF Data Retrieval Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nnadrf-datamanagement + - oAuth2ClientCredentials: + - nnadrf-datamanagement + - nnadrf-datamanagement:storagerequest + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfDataRetrievalSubscription' + required: true + description: Individual ADRF Data Retrieval Subscription resource to be created. + responses: + '201': + description: Created a new Individual ADRF Data Retrieval Subscription resource. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nadrf-datamanagement/{apiVersion}/data-retrieval- + subscriptions/{subscriptionId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfDataRetrievalSubscription' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + +``` + +``` + + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + adrDataRetrievalNotification: + '{ $request.body#/notificationURI }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NadrDataRetrievalNotification' + responses: + '204': + description: The receipt of the Notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/data-retrieval-subscriptions/{subscriptionId}: + delete: + summary: Delete an existing Individual ADRF Data Retrieval Subscription resource. + operationId: DeleteADRDataRetrievalSubscription + tags: + - Individual ADRF Data Retrieval Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnadrf-datamanagement + - oAuth2ClientCredentials: + - nnadrf-datamanagement + - nnadrf-datamanagement:storagerequest + parameters: + - name: subscriptionId + in: path + description: > + String identifying a data retrieval subscription to the Nadrf_DataManagement + Service. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual ADRF Data Retrieval Subscription resource matching + the subscriptionId was deleted. + +``` + +``` + + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/request-storage-sub: + post: + summary: Triggers the creation of a new ADRF Storage Subscription. + operationId: CreateADRFStorageSubscription + tags: + - ADRF Storage Subscriptions + security: + - {} + - oAuth2ClientCredentials: + - nnadrf-datamanagement + - oAuth2ClientCredentials: + - nnadrf-datamanagement + - nnadrf-datamanagement:storagerequest + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfDataStoreSubscription' + required: true + responses: + '200': + description: > + Successful response with reference used to identify the subscription at the ADRF. + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfDataStoreSubscriptionRef' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + storageSubAlertNotification: + '{ $request.body#/delNotifUri }': + post: + requestBody: + +``` + +``` + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfAlertNotification' + responses: + '200': + description: The alert receipt is acknowledged and a planned action is provided. + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfAlertNotificationResponse' + '204': + description: The alert receipt is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/request-storage-sub-removal: + post: + summary: Triggers the removal of ADRF storage subscription. + operationId: DeleteADRFStorageSubscription + tags: + - ADRF Storage Subscriptions + security: + - {} + - oAuth2ClientCredentials: + - nnadrf-datamanagement + - oAuth2ClientCredentials: + - nnadrf-datamanagement + - nnadrf-datamanagement:storagerequest + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfDataStoreSubscriptionRef' + required: true + responses: + '204': + description: > + No Content. The ADRF Storage Subscription matching the provided reference was deleted. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/remove-stored-data-analytics: + post: + summary: Remove ADRF data based on data or analytics specification. + operationId: DeleteADRFData + tags: + - ADRF Stored Data + security: + - {} + - oAuth2ClientCredentials: + - nnadrf-datamanagement + - oAuth2ClientCredentials: + - nnadrf-datamanagement + - nnadrf-datamanagement:storagerequest + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfStoredDataSpec' + required: true + responses: + '204': + description: No Content. The ADRF data matching the provided specification is deleted. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +# +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nadrf-datamanagement: Access to the nadrf-datamanagement API +# +schemas: +# +NadrfDataStoreRecord: + description: Represents an Individual ADRF Data Store Record. + type: object + oneOf: + - allOf: + - required: [anaSub] + - required: [anaNotifications] + - allOf: +``` + +``` + + - required: [dataSub] + - required: [dataNotif] +properties: + dataNotif: + $ref: '#/components/schemas/DataNotification' + anaNotifications: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscriptionNotification' + minItems: 1 + description: List of analytics subscription notifications. + anaSub: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' + minItems: 1 + description: > + Represents the subscription information of the corresponding analytics notification. + dataSub: + type: array + items: + $ref: '#/components/schemas/DataSubscription' + minItems: 1 + description: > + Represents the subscription information of the corresponding data notification. + storeHandl: + $ref: '#/components/schemas/StorageHandlingInfo' + dataSetTag: + $ref: '#/components/schemas/DataSetTag' + dsc: + type: string + description: Data synthesis and compression information. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +# +NadrfDataStoreSubscription: + description: > + Contains information to be used by the ADRF to create a Data or Analytics subscription. + type: object + allOf: + - oneOf: + - required: [anaSub] + - required: [dataSub] + - oneOf: + - required: [targetNfId] + - required: [targetNfSetId] + properties: + anaSub: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' + dataSetTag: + $ref: '#/components/schemas/DataSetTag' + dataSub: + $ref: '#/components/schemas/DataSubscription' + targetNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + targetNfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + formatInstruct: + $ref: 'TS29574_Ndccb_DataManagement.yaml#/components/schemas/FormattingInstruction' + procInstruct: + $ref: 'TS29574_Ndccb_DataManagement.yaml#/components/schemas/ProcessingInstruction' + multiProcInstructs: + type: array + items: + $ref: 'TS29574_Ndccb_DataManagement.yaml#/components/schemas/ProcessingInstruction' + minItems: 1 + description: Processing instructions to be used for sending event notifications. + storeHandl: + $ref: '#/components/schemas/StorageHandlingInfo' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +# +NadrfDataRetrievalSubscription: + description: Represents an Individual ADRF Data Retrieval Subscription. + type: object + required: + +``` + +``` + + - notifCorrId + - notificationURI + - timePeriod +oneOf: +- required: [anaSub] +- required: [dataSub] +- required: [dataSetId] +properties: + anaSub: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/NnwdaFEventsSubscription' + dataSetId: + type: string + description: data set identifier of the data or analytics that are subscribed. + dataSub: + $ref: '#/components/schemas/DataSubscription' + notificationURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + timePeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + notifCorrId: + type: string + description: Notification correlation identifier. + consTrigNotif: + type: boolean + description: > + It indicates that notifications shall be buffered (sending only fetch instructions + to the NF service consumer) until the NF service consumer requests their delivery + using Nadrf_DataManagement Service. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +# +NadrfDataRetrievalNotification: + description: > + Represents a notification that corresponds with an Individual ADRF Data + Retrieval Subscription. + type: object + required: + - notifCorrId + - timeStamp + oneOf: + - required: [anaNotifications] + - required: [dataNotif] + - required: [fetchInstruct] + properties: + notifCorrId: + type: string + description: Notification correlation identifier. + anaNotifications: + type: array + items: + $ref: +'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/NnwdaFEventsSubscriptionNotification' + minItems: 1 + description: List of analytics subscription notifications. + dataNotif: + $ref: '#/components/schemas/DataNotification' + fetchInstruct: + $ref: 'TS29576_NmfaF_3caDataManagement.yaml#/components/schemas/FetchInstruction'# + terminationReq: + type: boolean + description: > + It indicates the termination of the data management subscription that requested by the + ADRF. + dsc: + type: string + description: Data synthesis and compression information. + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +# +NadrfDataStoreSubscriptionRef: + description: Contains a reference to a request for a Data or Analytics subscription. + type: object + oneOf: + - required: [transRefId] + - required: [dataSetId] + properties: + transRefId: + type: string + +``` + +``` + description: Transaction reference identifier. + dataSetId: + type: string + description: data set identifier of data or analytics. + +# +NadrfStoredDataSpec: + description: Contains information about Data or Analytics specification. + type: object + required: + - timePeriod + oneOf: + - required: [dataSpec] + - required: [anaSpec] + - required: [dataSetId] + properties: + dataSpec: + $ref: '#/components/schemas/DataSubscription' + anaSpec: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' + timePeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dataSetId: + type: string + description: Data set identifier of stored data or analytics records. + +# +DataSubscription: + description: Contains a data specification. + type: object + oneOf: + - required: [amfDataSub] + - required: [smfDataSub] + - required: [udmDataSub] + - required: [nefDataSub] + - required: [afDataSub] + - required: [nrfDataSub] + - required: [nsacfDataSub] + - required: [upfDataSub] + - required: [gmlcDataSub] + properties: + amfDataSub: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/AmfEventSubscription' + smfDataSub: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NsmfEventExposure' + udmDataSub: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/EeSubscription' + afDataSub: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEventExposureSubsc' + nefDataSub: + $ref: 'TS29591_Nnef_EventExposure.yaml#/components/schemas/NefEventExposureSubsc' + nrfDataSub: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SubscriptionData' + nsacfDataSub: + $ref: 'TS29536_Nnsacf_SliceEventExposure.yaml#/components/schemas/SACEEventSubscription' + upfDataSub: + $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/UpfEventSubscription' + gmlcDataSub: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/InputData' + +# +DataNotification: + description: Represents a Data Subscription Notification. + type: object + oneOf: + - required: [amfEventNotifs] + - required: [smfEventNotifs] + - required: [udmEventNotifs] + - required: [nefEventNotifs] + - required: [afEventNotifs] + - required: [nrfEventNotifs] + - required: [nsacfEventNotifs] + - required: [upfEventNotifs] + - required: [gmlcEventNotifs] + properties: + amfEventNotifs: + type: array + items: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/AmfEventNotification' + minItems: 1 + description: List of notifications of AMF events. +``` + +``` +smfEventNotifs: + type: array + items: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NsmfEventExposureNotification' + minItems: 1 + description: List of notifications of SMF events. +udmEventNotifs: + type: array + items: + $ref: 'TS29503_Nudm_EE.yaml#/components/schemas/MonitoringReport' + minItems: 1 + description: List of notifications of UDM events. +nefEventNotifs: + type: array + items: + $ref: 'TS29591_Nnef_EventExposure.yaml#/components/schemas/NefEventExposureNotif' + minItems: 1 + description: List of notifications of NEF events. +afEventNotifs: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEventExposureNotif' + minItems: 1 + description: List of notifications of AF events. +nrfEventNotifs: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NotificationData' + minItems: 1 + description: List of notifications of NRF events. +nsacfEventNotifs: + type: array + items: + $ref: 'TS29536_Nnsacf_SliceEventExposure.yaml#/components/schemas/SACEEventReport' + minItems: 1 + description: List of notifications of NSACF events. +upfEventNotifs: + type: array + items: + $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/NotificationData' + minItems: 1 + description: List of notifications of UPF events. +gmlcEventNotifs: + type: array + items: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/EventNotifyData' + minItems: 1 + description: List of notifications of GMLC events. +timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +# +StorageHandlingInfo: + description: Contains storage handling information about data or analytics. + type: object + properties: + lifetime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + delNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + delNotifCorrId: + type: string + description: Notification correlation identifier for deletion alerts. + +# +NadrfAlertNotification: + description: Contains information about data or analytics that are about to be deleted. + type: object + properties: + alertStorTransId: + type: string + description: > + Storage transaction identifier that can be used to retrieve data or analytics. + delNotifCorrId: + type: string + description: Notification correlation identifier. + required: + - alertStorTransId + - delNotifCorrId +``` + +``` + +# + NadrFAlerNotificationResponse: + description: > + Contains information about planned actions related to data or analytics + that are about to be deleted. + type: object + properties: + retrievalInd: + type: boolean + description: > + Indicates if the NF service consumer has determined to retrieve the data + or analytics that are about to be deleted. + required: + - retrievalInd +# + DataSetTag: + description: Contains an identifier and a description of associated records. + type: object + required: + - dataSetId + properties: + dataSetId: + type: string + description: Data set identifier of data or analytics records. + dataSetDesc: + type: string + description: Data set description of data or analytics records. +# + +``` + +## A.3 Nadrf\_MLModelManagement API + +``` + +openapi: 3.0.0 +info: + version: 1.0.0-alpha.2 + title: Nadrf_MLModelManagement + description: | + ADRF ML Model Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.575 V18.4.0; 5G System; Analytics Data Repository Services; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.575/' +# +servers: + - url: '{apiRoot}/nadr-mlmodelmanagement/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. +# +security: + - {} + - oAuth2ClientCredentials: + - nadrf-mlmodelmanagement +# +paths: + /mlmodel-store-records: + post: + summary: Creates a new Individual ADRF ML Model Store Record resource. + operationId: CreateADRFMLModelStoreRecord + tags: + - ADRF ML Model Store Records (Collection) + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NadrFMLModelStoreRecord' + required: true + description: ADRF ML model store record to be stored. + responses: + '201': + description: Successful creation of new Individual ADRF ML Model Store Record resource. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + +``` + +``` + + {apiRoot}/nadrf-mlmodelmanagement//mlmodel-store-records/{storeTransId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfMLModelStoreRecord' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +get: + summary: Retrieves existing Individual ADRF ML Model Store Record. + operationId: GetAdrfMLModelStoreRecord + tags: + - ADRF ML Model Store Records (Collection) + parameters: + - name: store-trans-id + description: A storage transaction identifier of a ML model store record in ADRF. + in: query + required: false + schema: + type: string + - name: modelUniqueId + description: Unique Model identifier of a ML model. + in: query + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 + responses: + '200': + description: ML model store records are returned. + content: + application/json: + schema: + $ref: '#/components/schemas/NadrfMLModelStoreRecord' + '204': + description: No matching ADRF ML Model were found. + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + +``` + +``` +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/mlmodel-store-records/{storeTransId}: + delete: + summary: Delete an existing Individual ADRF ML Model Store Record. + operationId: DeleteADRFMLModelStoreRecord + tags: + - Individual ADRF ML Model Store Record (Document) + parameters: + - name: storeTransId + in: path + description: String identifying a ML Model Store Record in ADRF. + required: true + schema: + type: string + responses: + '200': + description: > + Attempted to remove ML model(s) in the Individual ADRF ML Model Store Record resource. + The result is returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MLModelDelResult' + minItems: 1 + '204': + description: > + No Content. The Individual ADRF ML Model Store Record resource matching the + storeTransId was deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/remove-stored-mlmodel: + post: + summary: Remove stored ML model based on unique ML model identifier. + operationId: DeleteADRFMLModel + tags: + - ADRF Stored ML Model + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NadrfMLModelStoreRecord' + minItems: 1 + required: true + responses: + '200': + description: > + The ADRF ML model matching the provided unique ML model identifier + was attempted to be deleted. The result is returned. + content: + application/json: + schema: +``` + +``` + + $ref: '#/components/schemas/MLModelDelResult' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +# +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nadrf-mlmodelmanagement: Access to the nadrf-mlmodelmanagement API +# +schemas: +# +NadrfMLModelStoreRecord: + description: Represents an Individual ADRF ML Model Store Record. + type: object + allOf: + - oneOf: + - required: [nfInstanceId] + - required: [nfSetId] + - anyOf: + - required: [mlModelIdnfo] + - required: [mlModels] + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + mlModelInfo: + type: array + items: + $ref: '#/components/schemas/MLModelInfo' + minItems: 1 + description: List of ML Model Information. + mlModels: + type: array + items: + $ref: '#/components/schemas/MLModel' + minItems: 1 + description: Represents ML Model(s). + modelStoreResult: + $ref: '#/components/schemas/ModelStoreResult' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +# +MLModelInfo: + description: Represents information of the ML Model. + type: object + allOf: + - required: [modelUniqueId] + - required: [mlFileAddr] + - required: [mlStorageSize] + properties: + +``` + +``` + + modelUniqueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + mlFileAddr: + $ref: 'TS29520_Nnwdaf_MLModelProvision.yaml#/components/schemas/MLModelAddr' + mlStorageSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + allowConsumerList: + type: array + items: + $ref: '#/components/schemas/AllowedConsumer' + minItems: 1 + description: The allowed consumer list of the ML Model. +# +AllowedConsumer: + description: Represents information of the allowed consumer list of the ML Model. + type: object + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + oneOf: + - required: [nfInstanceId] + - required: [nfSetId] +# +MLModelDelResult: + description: Represents information of the ML Model. + type: object + allOf: + - required: [modelUniqueId] + - required: [DeleteResult] + properties: + modelUniqueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + deleteResult: + $ref: '#/components/schemas/DeleteResult' +# +MLModel: + description: Represents an ML Model. + type: object + allOf: + - required: [modelUniqueId] + - required: [mlModel] + properties: + modelUniqueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + mlModel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Binary' +# +ModelStoreResult: + description: Contains information about ML Model storage result. + type: object + allOf: + - required: [modelUniqueId] + - required: [storeResult] + properties: + modelUniqueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + storeResult: + $ref: '#/components/schemas/StoreResult' +# +# ENUMERATIONS DATA TYPES +# +DeleteResult: + anyOf: + - type: string + enum: + - ML_MODEL_DELETED + - ML_MODEL_NOT_FOUND + - ML_MODEL_FOUND_BUT_NOT_DELETED + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represents the store result type. + Possible values are: + +``` + +- ML\_MODEL\_DELETED: Indicates that the ML model was deleted in ADRF. +- ML\_MODEL\_FILE\_ADDRESS\_NOT\_FOUND: Indicates that the ML model was not found in ADRF. +- ML\_MODEL\_FOUND\_BUT\_NOT\_DELETED: Indicates that the ML model was found in ADRF but not deleted. + +``` +# +StoreResult: + anyOf: + - type: string + enum: + - ML_MODEL_FILE_STORED_IN_ADRF + - ML_MODEL_FILE_ADDRESS_NOT_FOUND + - ML_MODEL_FILE_DOWNLOAD_FAILED + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Represents the store result type. + Possible values are: + - ML_MODEL_FILE_STORED_IN_ADRF: Indicates that the ML model was successfully stored in ADRF. + - ML_MODEL_FILE_ADDRESS_NOT_FOUND: Indicates that the ML model file address was not found. + - ML_MODEL_FILE_DOWNLOAD_FAILED: Indicates that the download of the ML model file failed. +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-06 | CT3#116e | | | | | TS skeleton of Analytics Data Repository Services specification | 0.0.0 | +| 2021-06 | CT3#116e | C3-213501 | | | | Inclusion of documents agreed in CT3#116e C3-213537. | 0.1.0 | +| 2021-08 | CT3#117e | C3-214579 | | | | Inclusion of documents agreed in CT3#117e C3-214478. | 0.2.0 | +| 2021-11 | CT3#119e | C3-216521 | | | | Inclusion of documents agreed in CT3#119e C3-216443, C3-216455, C3-216456, C3-216457, C3-216458, C3-216459, C3-216460, C3-216462, C3-216469, C3-216591, C3-216592, C3-216593. | 0.3.0 | +| 2022-01 | CT3#119bis-e | C3-220454 | | | | Inclusion of documents agreed in CT3#119bis-e C3-220500, C3-220512, C3-220513, C3-220440, C3-220441, C3-220369. | 0.4.0 | +| 2022-02 | CT3#120 | C3-221516 | | | | Inclusion of documents agreed in CT3#120-e C3-221091, C3-221288, C3-221620, C3-221621. | 0.5.0 | +| 2022-03 | CT#95e | CP-220160 | | | | Presentation to TSG CT for approval | 1.0.0 | +| 2022-03 | CT#95e | CP-220160 | | | | Approved by TSG CT | 17.0.0 | +| 2022-06 | CT#96 | CP-221132 | 0001 | 1 | F | Adding 3XX response handling support for ADRF services | 17.1.0 | +| 2022-06 | CT#96 | CP-221136 | 0002 | 3 | B | Cleanup of Nadrf_DataManagement data model | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0003 | 1 | F | Corrections in the Nadrf_DataManagement data model | 17.1.0 | +| 2022-06 | CT#96 | CP-221129 | 0004 | | F | Correct the Cardinality of some attributes | 17.1.0 | +| 2022-06 | CT#96 | CP-221134 | 0005 | 3 | B | Support removal of stored analytics and data from ADRF according to Analytics and Data Specification | 17.1.0 | +| 2022-06 | CT#96 | CP-221132 | 0006 | 1 | B | Support carrying Fetch Instructions in Nadrf_DataManagement_RetrievalNotify service operation | 17.1.0 | +| 2022-06 | CT#96 | CP-221133 | 0008 | 2 | F | Formatting of description fields | 17.1.0 | +| 2022-06 | CT#96 | CP-221130 | 0009 | | F | Responses on DELETE method | 17.1.0 | +| 2022-06 | CT#96 | CP-221133 | 0011 | 2 | F | Clarification on duplicated data or analytics storage | 17.1.0 | +| 2022-06 | CT#96 | CP-221131 | 0012 | 1 | F | Correction on Nadrf_DataManagement_StorageRequest service operation | 17.1.0 | +| 2022-06 | CT#96 | CP-221133 | 0014 | | F | Removal of repetitive description in HTTP error response | 17.1.0 | +| 2022-06 | CT#96 | CP-221135 | 0016 | 1 | F | Update inputs of Nadrf_DataManagement_RetrievalNotify service | 17.1.0 | +| 2022-06 | CT#96 | CP-221134 | 0017 | | F | corrections to Abbreviations and Introduction | 17.1.0 | +| 2022-06 | CT#96 | CP-221134 | 0018 | | F | correction to time period | 17.1.0 | +| 2022-06 | CT#96 | CP-221155 | 0019 | 1 | F | Update the apiVersion placeholder | 17.1.0 | +| 2022-06 | CT#96 | CP-221152 | 0020 | | F | Update of info and externalDocs fields | 17.1.0 | +| 2022-09 | CT#97e | CP-222104 | 0021 | 1 | F | Update inputs of Nadrf_DataManagement_RetrievalNotify service | 17.2.0 | +| 2022-09 | CT#97e | CP-222103 | 0022 | 1 | F | Corrections in descriptions of the Nadrf_DataManagement_RetrievalRequest operation | 17.2.0 | +| 2022-09 | CT#97e | CP-222103 | 0023 | 1 | F | ADRF data retrieval notification data model updates | 17.2.0 | +| 2022-09 | CT#97e | CP-222103 | 0024 | 1 | F | Adding NRF and NSACF as data sources | 17.2.0 | +| 2022-09 | CT#97e | CP-222121 | 0027 | | F | Update of info and externalDocs fields | 17.2.0 | +| 2022-12 | CT#98e | CP-223173 | 0028 | 1 | F | ADRF Retrieval Request inputs | 17.3.0 | +| 2022-12 | CT#98e | CP-223172 | 0029 | | F | ADRF Storage Subscription Request handling inconsistencies | 17.3.0 | +| 2022-12 | CT#98e | CP-223173 | 0035 | 1 | F | The time stamp of data notification | 17.3.0 | +| 2022-12 | CT#98e | CP-223173 | 0036 | 1 | F | Miscellaneous corrections | 17.3.0 | +| 2022-12 | CT#98e | CP-223192 | 0038 | 1 | F | Update the apiVersion in the specification | 17.3.0 | +| 2022-12 | CT#98e | CP-223188 | 0043 | | F | Update of info and externalDocs fields | 17.3.0 | +| 2022-12 | CT#98e | CP-223191 | 0031 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0032 | 1 | F | Removal of non-sense statement for notificationURI | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0033 | 1 | F | adding Consumer triggered Notification indication for Nadrf_DataManagement_RetrievalSubscribe | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0034 | 1 | F | Correction of data type of procInstr | 18.0.0 | +| 2022-12 | CT#98e | CP-223190 | 0044 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230149 | 0045 | 1 | B | Adding Supported Features for data storage and retrieval subscriptions | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0046 | 1 | F | Handling of fetch Instruction | 18.1.0 | +| 2023-03 | CT#99 | CP-230162 | 0048 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231157 | 0049 | 1 | B | Adding UPF to the possible data sources for analytics | 18.2.0 | +| 2023-06 | CT#100 | CP-231132 | 0050 | 3 | B | OAuth2 scopes in Nadrf_DataManagement API | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0051 | 1 | B | Adding Storage Handling Information in ARDF Data Management requests | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0052 | 1 | B | Sending ADRF Deletion Alerts | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0053 | | B | Using DataSetTag in ADRF requests | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0054 | 1 | B | Using DataSetTag in ADRF subscriptions | 18.2.0 | +| 2023-06 | CT#100 | CP-231132 | 0055 | 1 | F | Corrections to the redirection mechanism description | 18.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------|--------| +| 2023-06 | CT#100 | CP-231141 | 0056 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232081 | 0057 | | B | Location Accuracy data sources | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0058 | | B | Data Synthesis and Compression | 18.3.0 | +| 2023-09 | CT#101 | CP-232098 | 0059 | 1 | F | Editor Note removal for Nadrf_DataManagement API OAuth2 scope. | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0060 | 1 | B | Storage of ML models in ADRF | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0061 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233225 | 0062 | 2 | B | Update the Nadrf_MLModelManagement_RetrievalRequest service | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0063 | 1 | B | Support of the storage of user consent | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0064 | 1 | F | Correction to MLModelManagement_Delete service operation | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0065 | | F | Fixing wrong reference to 29.500 | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0067 | 1 | B | Updates to Nadrf_MLModelManagement_Delete Service Operation | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0068 | 1 | B | Updates to Nadrf_MLModelManagement API for StorageRequest | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0069 | 1 | F | Updates to Nadrf_MLModelManagement_RetrievalRequest Service Operation | 18.4.0 | +| 2023-12 | CT#102 | CP-233227 | 0071 | 1 | F | Correction to MLModelManagement_StorageRequest service operation | 18.4.0 | +| 2023-12 | CT#102 | CP-233229 | 0072 | 1 | F | IETF RFC 7540, RFC 7807 obsoleted by RFC 9113 and RFC 9457 respectively | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0073 | | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29576/1a827b10290f33d4fec04d0e8ef7a897_img.jpg b/raw/rel-18/29_series/29576/1a827b10290f33d4fec04d0e8ef7a897_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..62bee84de2bf1aea47671f42e3a0b4d00eafe741 --- /dev/null +++ b/raw/rel-18/29_series/29576/1a827b10290f33d4fec04d0e8ef7a897_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b6195e6553e779b2b4fe9314cbfa0503a02d7329533fca11ea0f0e98fff2b165 +size 25186 diff --git a/raw/rel-18/29_series/29576/2e399449b7f62d40167a65ca88888917_img.jpg b/raw/rel-18/29_series/29576/2e399449b7f62d40167a65ca88888917_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e55211753032e17856f229935d6aca7e6b2bc891 --- /dev/null +++ b/raw/rel-18/29_series/29576/2e399449b7f62d40167a65ca88888917_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6763e3d892ec34cdc4b99f6b9a3a9a69ff37ece5c437c90085959107666aac50 +size 33616 diff --git a/raw/rel-18/29_series/29576/43837b056625d3d6ce615e4c02f163bb_img.jpg b/raw/rel-18/29_series/29576/43837b056625d3d6ce615e4c02f163bb_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6f148ed544df0cb68a854b7977c8abbf1e660af3 --- /dev/null +++ b/raw/rel-18/29_series/29576/43837b056625d3d6ce615e4c02f163bb_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b95f86cf920ccb429eda43222af77f3fd828366d397d53b66225ad4bf4729953 +size 21796 diff --git a/raw/rel-18/29_series/29576/5a95b187de0044da69b7322e04761b86_img.jpg b/raw/rel-18/29_series/29576/5a95b187de0044da69b7322e04761b86_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d7f672ade17741bb50b47e1e224d62a3522fb1ed --- /dev/null +++ b/raw/rel-18/29_series/29576/5a95b187de0044da69b7322e04761b86_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2c29baa8b16f431f562b47bd76eeca21f408d46732e2b81000fb65568681f71d +size 22870 diff --git a/raw/rel-18/29_series/29576/5e92d9e8e9ce204e405bff2367f88176_img.jpg b/raw/rel-18/29_series/29576/5e92d9e8e9ce204e405bff2367f88176_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..cae6231846668cbd796c7eafd6849c271414faad --- /dev/null +++ b/raw/rel-18/29_series/29576/5e92d9e8e9ce204e405bff2367f88176_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:13f79ac1220963c0f486f1ca33bc3096bda7a5fedd60456dee105cabf825dbb5 +size 15766 diff --git a/raw/rel-18/29_series/29576/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29576/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b84cf4b8de9631b2d1367c725e38f383d4d040be --- /dev/null +++ b/raw/rel-18/29_series/29576/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d526178e39086760c2b444565419e8067bd95b1e356a419644d589314e69830 +size 9474 diff --git a/raw/rel-18/29_series/29576/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29576/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..437f3720b464a637b085a3ea174486602ff2fe11 --- /dev/null +++ b/raw/rel-18/29_series/29576/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ac173c03319afa6218ce1f04a5e7960c94d32c22a235ea4c45b70f99daf00d13 +size 5724 diff --git a/raw/rel-18/29_series/29576/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg b/raw/rel-18/29_series/29576/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2cf1ff26d5ca90ad2c04389d4b55a83e9986d8be --- /dev/null +++ b/raw/rel-18/29_series/29576/8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:35233f58b1e3ca47495a79e36979e1b4f458b0c52a0369995290574440177c81 +size 32012 diff --git a/raw/rel-18/29_series/29576/9e1c95ee7eb045977f18f011f49520c7_img.jpg b/raw/rel-18/29_series/29576/9e1c95ee7eb045977f18f011f49520c7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ba43cc31e8342732284e1742060f9705a1f264a4 --- /dev/null +++ b/raw/rel-18/29_series/29576/9e1c95ee7eb045977f18f011f49520c7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:137f2dfffa320b0fa22f369178159348c50931f9a3c268de1b589f5c8f17ee95 +size 24433 diff --git a/raw/rel-18/29_series/29576/a6cf7c02a60c336e0934b5ea40e35b49_img.jpg b/raw/rel-18/29_series/29576/a6cf7c02a60c336e0934b5ea40e35b49_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..106ec225ac99e1343c41ec4f682f9c341e87ba69 --- /dev/null +++ b/raw/rel-18/29_series/29576/a6cf7c02a60c336e0934b5ea40e35b49_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:74161a52519f8f22484e65f82adb3d28e01c5306bf6d78cb9b451659a6b82261 +size 30222 diff --git a/raw/rel-18/29_series/29576/c78c2eefd86269d1740ab85a916f24f2_img.jpg b/raw/rel-18/29_series/29576/c78c2eefd86269d1740ab85a916f24f2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..461d1ee9b21cca1d9f0b939a22291a7a9720d070 --- /dev/null +++ b/raw/rel-18/29_series/29576/c78c2eefd86269d1740ab85a916f24f2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e821580b37f17569aae4c4f003682fd8d4ba5a8d52bf12a6831037360719bcea +size 8429 diff --git a/raw/rel-18/29_series/29576/e636d7ccca0ad14c6b95201404324823_img.jpg b/raw/rel-18/29_series/29576/e636d7ccca0ad14c6b95201404324823_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..f3b8d99642afa02653b47c56d5a6df8a3258f507 --- /dev/null +++ b/raw/rel-18/29_series/29576/e636d7ccca0ad14c6b95201404324823_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a991df19bc4b675db9d456d96d049c73d7fda0d85e1f78178c6bbeaf8233df2d +size 22768 diff --git a/raw/rel-18/29_series/29578/2a0f333f04f8e672bebf288c511c1db5_img.jpg b/raw/rel-18/29_series/29578/2a0f333f04f8e672bebf288c511c1db5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..af8545f6ce2d552c02677e3a86b1e21b42ef86ab --- /dev/null +++ b/raw/rel-18/29_series/29578/2a0f333f04f8e672bebf288c511c1db5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8fe503d6e64ad46c891860a14cd1f0b25623ed1fb87dac80db07ee5d275973ac +size 17331 diff --git a/raw/rel-18/29_series/29578/5a4e62bead259c258d069fd3663ea670_img.jpg b/raw/rel-18/29_series/29578/5a4e62bead259c258d069fd3663ea670_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fb11fd56778c8b0be0f32558b3d26961987c36db --- /dev/null +++ b/raw/rel-18/29_series/29578/5a4e62bead259c258d069fd3663ea670_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b1eed7cded4133a5e27d411787c44921639d1046522bcbc98365481f9e025448 +size 26025 diff --git a/raw/rel-18/29_series/29578/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29578/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..212f9def46c71e4b0640c4aaaba5e8e7b9627091 --- /dev/null +++ b/raw/rel-18/29_series/29578/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a06a638aae88648d4cde30c461e58cc01fa632af0c7c0269b2f14b5723ea9051 +size 9460 diff --git a/raw/rel-18/29_series/29578/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29578/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..e118d70db3811041b38201549773b1aa34d61cf9 --- /dev/null +++ b/raw/rel-18/29_series/29578/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f10d0c96d8c72e325d16855d98f3b1d56e6c4c80a778b4b0e35addcdedd46060 +size 5585 diff --git a/raw/rel-18/29_series/29578/e787e02d9214556476d95941bda1d350_img.jpg b/raw/rel-18/29_series/29578/e787e02d9214556476d95941bda1d350_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b9cedba0f141a36c698d5bda55dcc867e7eb5d1e --- /dev/null +++ b/raw/rel-18/29_series/29578/e787e02d9214556476d95941bda1d350_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d8141af43e338a9e563587b31ad9014707676f582537ae4245418e5ce5680199 +size 9604 diff --git a/raw/rel-18/29_series/29579/18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg b/raw/rel-18/29_series/29579/18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..29c7c021117cc912c72f0347d29568118e0354b8 --- /dev/null +++ b/raw/rel-18/29_series/29579/18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fd967c90d2b3b8c561f5df9ec8dbfc7242b88b7eafbc90fc06e630227fac3bfd +size 8945 diff --git a/raw/rel-18/29_series/29579/27b06ec9f42b5d727a2630f61a5f1861_img.jpg b/raw/rel-18/29_series/29579/27b06ec9f42b5d727a2630f61a5f1861_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..c5c061cbdc3f223c2fb6b48b70a884e9aa4e5972 --- /dev/null +++ b/raw/rel-18/29_series/29579/27b06ec9f42b5d727a2630f61a5f1861_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0a1a1ff05a0f52d5271a92dd120fe9062adcfad16a1c8d21c2dbc0e8348a3c8a +size 16454 diff --git a/raw/rel-18/29_series/29579/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29579/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9103be77ba43d8d10b30844c0b4efcca89ac6673 --- /dev/null +++ b/raw/rel-18/29_series/29579/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a5ac8224d7eb113c21ee46453892ca5269310dff6dfb094aa1989f15ee0cd9a6 +size 7738 diff --git a/raw/rel-18/29_series/29579/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29579/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ffebe6652a6e396c3b8585481e0bb375dd20bc80 --- /dev/null +++ b/raw/rel-18/29_series/29579/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2b526b7936ff4b80d02004ccd638da425c42a454b350c057a5b735c09668a946 +size 5701 diff --git a/raw/rel-18/29_series/29579/97a08abb8a43f3f8c6ce347199cd909a_img.jpg b/raw/rel-18/29_series/29579/97a08abb8a43f3f8c6ce347199cd909a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8d08d9976fc0f33a8ed8a06c6cfedbe5bc7e4730 --- /dev/null +++ b/raw/rel-18/29_series/29579/97a08abb8a43f3f8c6ce347199cd909a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c37d8169fbbceb7ac22715c50c491306f5bf15efd5b1dd38ffaacaff279534b3 +size 37024 diff --git a/raw/rel-18/29_series/29581/raw.md b/raw/rel-18/29_series/29581/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..060982b29f1b8ccc1967bd91e75acc815d1d6317 --- /dev/null +++ b/raw/rel-18/29_series/29581/raw.md @@ -0,0 +1,2501 @@ + + +# 3GPP TS 29.581 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Multicast/Broadcast Service Transport Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'P' has a red signal wave icon below it. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Overview..... | 9 | +| 4.1 General ..... | 9 | +| 5 Services offered by the MBSTF..... | 10 | +| 5.1 Introduction ..... | 10 | +| 5.2 Nmbstf_MBSDistributionSession Service..... | 10 | +| 5.2.1 Service Description ..... | 10 | +| 5.2.2 Service Operations..... | 11 | +| 5.2.2.1 Introduction..... | 11 | +| 5.2.2.2 Create ..... | 11 | +| 5.2.2.2.1 General ..... | 11 | +| 5.2.2.3 Update..... | 12 | +| 5.2.2.3.1 General ..... | 12 | +| 5.2.2.4 Destroy..... | 12 | +| 5.2.2.4.1 General ..... | 12 | +| 5.2.2.5 Retrieve..... | 13 | +| 5.2.2.5.1 General ..... | 13 | +| 5.2.2.6 StatusSubscribe service operation ..... | 14 | +| 5.2.2.6.1 General ..... | 14 | +| 5.2.2.6.2 Subscription creation..... | 14 | +| 5.2.2.6.3 Subscription update..... | 15 | +| 5.2.2.7 StatusUnsubscribe..... | 15 | +| 5.2.2.7.1 General ..... | 15 | +| 5.2.2.8 StatusNotify ..... | 16 | +| 5.2.2.8.1 General ..... | 16 | +| 6 API Definitions ..... | 17 | +| 6.1 Nmbstf_MBSDistributionSession Service API ..... | 17 | +| 6.1.1 Introduction ..... | 17 | +| 6.1.2 Usage of HTTP..... | 17 | +| 6.1.2.1 General..... | 17 | +| 6.1.2.2 HTTP standard headers..... | 17 | +| 6.1.2.2.1 General ..... | 17 | +| 6.1.2.2.2 Content type ..... | 18 | +| 6.1.2.3 HTTP custom headers..... | 18 | +| 6.1.3 Resources..... | 18 | +| 6.1.3.1 Overview..... | 18 | +| 6.1.3.2 Resource: MBS Distribution sessions collection (Collection) ..... | 19 | +| 6.1.3.2.1 Description ..... | 19 | +| 6.1.3.2.2 Resource Definition..... | 19 | +| 6.1.3.2.3 Resource Standard Methods..... | 19 | +| 6.1.3.2.3.1 POST ..... | 19 | +| 6.1.3.2.4 Resource Custom Operations..... | 20 | +| 6.1.3.3 Resource: Individual MBS distribution session (Document) ..... | 20 | +| 6.1.3.3.1 Description ..... | 20 | +| 6.1.3.3.2 Resource Definition..... | 20 | +| 6.1.3.3.3 Resource Standard Methods..... | 21 | +| 6.1.3.3.3.1 PATCH..... | 21 | + +| | | | +|-------------|------------------------------------------------------------------------------------|----| +| 6.1.3.3.3.2 | DELETE..... | 22 | +| 6.1.3.3.3.3 | GET ..... | 23 | +| 6.1.3.3.4 | Resource Custom Operations..... | 24 | +| 6.1.3.4 | Resource: Subscriptions collection for MBS distribution session (Collection) ..... | 24 | +| 6.1.3.4.1 | Description ..... | 24 | +| 6.1.3.4.2 | Resource Definition..... | 24 | +| 6.1.3.4.3 | Resource Standard Methods..... | 24 | +| 6.1.3.4.3.1 | POST ..... | 24 | +| 6.1.3.4.4 | Resource Custom Operations..... | 26 | +| 6.1.3.5 | Resource: Individual subscription for an MBS distribution session (Document) ..... | 26 | +| 6.1.3.5.1 | Description ..... | 26 | +| 6.1.3.5.2 | Resource Definition..... | 26 | +| 6.1.3.5.3 | Resource Standard Methods..... | 26 | +| 6.1.3.5.3.1 | DELETE..... | 26 | +| 6.1.3.5.3.2 | PATCH..... | 27 | +| 6.1.3.5.4 | Resource Custom Operations..... | 29 | +| 6.1.4 | Custom Operations without associated resources ..... | 29 | +| 6.1.5 | Notifications ..... | 29 | +| 6.1.5.1 | General..... | 29 | +| 6.1.5.2 | StatusNotify ..... | 29 | +| 6.1.5.2.1 | Description ..... | 29 | +| 6.1.5.2.2 | Target URI..... | 29 | +| 6.1.5.2.3 | Standard Methods..... | 29 | +| 6.1.6 | Data Model ..... | 30 | +| 6.1.6.1 | General..... | 30 | +| 6.1.6.2 | Structured data types..... | 31 | +| 6.1.6.2.1 | Introduction ..... | 31 | +| 6.1.6.2.2 | Type: CreateReqData..... | 32 | +| 6.1.6.2.3 | Type: CreateRspData ..... | 32 | +| 6.1.6.2.4 | Type: DistSession..... | 33 | +| 6.1.6.2.5 | Type: ObjDistributionData..... | 34 | +| 6.1.6.2.6 | Type: PktDistributionData ..... | 35 | +| 6.1.6.2.7 | Type: StatusSubscribeReqData..... | 35 | +| 6.1.6.2.8 | Type: StatusSubscribeRspData ..... | 35 | +| 6.1.6.2.9 | Type: StatusNotifyReqData ..... | 35 | +| 6.1.6.2.10 | Type: DistSessionSubscription ..... | 35 | +| 6.1.6.2.11 | Type: DistSessionEventReportList ..... | 36 | +| 6.1.6.2.12 | Type: DistSessionEventReport ..... | 36 | +| 6.1.6.2.13 | Type: UpTrafficFlowInfo..... | 37 | +| 6.1.6.2.14 | Type: MbStfIngestAddr ..... | 38 | +| 6.1.6.2.15 | Type: ExtSsm..... | 40 | +| 6.1.6.3 | Simple data types and enumerations..... | 40 | +| 6.1.6.3.1 | Introduction ..... | 40 | +| 6.1.6.3.2 | Simple data types ..... | 40 | +| 6.1.6.3.3 | Enumeration: DistSessionState ..... | 40 | +| 6.1.6.3.4 | Enumeration: ObjDistributionOperatingMode ..... | 40 | +| 6.1.6.3.5 | Enumeration: ObjAcquisitionMethod ..... | 40 | +| 6.1.6.3.6 | Enumeration: PktDistributionOperatingMode ..... | 41 | +| 6.1.6.3.7 | Enumeration: DistSessionEventType..... | 41 | +| 6.1.6.3.8 | Enumeration: PktIngestMethod..... | 41 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 41 | +| 6.1.6.5 | Binary data..... | 42 | +| 6.1.7 | Error Handling ..... | 42 | +| 6.1.7.1 | General..... | 42 | +| 6.1.7.2 | Protocol Errors ..... | 42 | +| 6.1.7.3 | Application Errors..... | 42 | +| 6.1.8 | Feature negotiation ..... | 42 | +| 6.1.9 | Security ..... | 42 | +| 6.1.10 | HTTP redirection..... | 43 | + +**Annex A (normative): OpenAPI specification ..... 44** +A.1 General..... 44 +A.2 Nmbstf\_DistSession API ..... 44 +**Annex B (informative): Change history..... 55** + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nmbstf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the MBSTF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. The 5G Multicast-Broadcast Session Management Services for 5G System is specified in 3GPP TS 23.247 [15] and the User Service Architecture for 5G Multicast-Broadcast Services is specified in 3GPP TS 26.502 [17]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 7807: "Problem Details for HTTP APIs". +- [14] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [15] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services; Stage 2". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [17] 3GPP TS 26.502: "5G multicast-broadcast services; User Service architecture; Stage 2". +- [18] 3GPP TS 29.580: "5G System; Multicast/Broadcast Service Function services; Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +For the definitions of the basic SBI notions (e.g. apiRoot, API URI, Callback URI, etc.), SBI specific abbreviations (e.g. CRUD, YAML, etc.), special characters, operators and delimiters that are used by SBI specifications, see clause 3 in 3GPP TS 29.501 [5]. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|---------|-------------------------------------------------------| +| 5MBS | 5G Multicast-Broadcast Services | +| AF | Application Function | +| AS | Application server | +| DNN | Data Network Name | +| MBSF | Multicast/Broadcast Service Function | +| MBSTF | Multicast/Broadcast Service Transport Function | +| MB-SMF | Multicast/Broadcast Session Management Function | +| MB-UPF | Multicast/Broadcast User Plane Function | +| NEF | Network Exposure Function | +| NF | Network Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| URI | Uniform Resource Identifier | + +# --- 4 Overview + +## 4.1 General + +Within the 5GC, the MBSTF offers services to the MBSF via the Nmbstf service based interface (see 3GPP TS 23.501 [2] and 3GPP TS 26.502 [17]). + +Figures 4.1 provides the reference model (in service based interface representation and in reference point representation), with focus on the MBSTF and the scope of the present specification. + +![Figure 4-1: Reference model – MBSTF. The diagram shows a white box labeled 'MBSF' connected to a green box labeled 'MBSTF'. The connection is labeled 'Nmb2' at the MBSF end and 'Nmbstf' at the MBSTF end. The MBSTF box has a small circle on its left side, indicating a service interface.](e6df2733626a85205c1db682e6259c46_img.jpg) + +Figure 4-1: Reference model – MBSTF. The diagram shows a white box labeled 'MBSF' connected to a green box labeled 'MBSTF'. The connection is labeled 'Nmb2' at the MBSF end and 'Nmbstf' at the MBSTF end. The MBSTF box has a small circle on its left side, indicating a service interface. + +**Figure 4-1: Reference model – MBSTF** + +Nmb2 is the reference point between MBSF and MBSTF. + +The functionalities supported by the MBSTF are listed in clause 5.3.2.12 of 3GPP TS 23.247 [15]. + +The services and service operations provided by the Nmbstf interface are listed in clause 7.3 of 3GPP TS 26.502 [17]. + +# 5 Services offered by the MBSTF + +## 5.1 Introduction + +Table 5.1-1 summarizes the SBI services produced by the MBSTF. + +**Table 5.1-1: NF Services provided by MBSTF** + +| Service Name | Description | Example Consumers | +|-------------------------------|---------------------------------------------------------------------------------------|-------------------| +| Nmbstf_MBSDistributionSession | Manage (e.g. Create, Modify, Delete) a new MBS Distribution Session within the MBSTF. | MBSF | + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-------------------------------|--------|------------------------------------|---------------------------------|--------------------|-------| +| Nmbstf_MBSDistributionSession | 5.2 | MBSTF Distribution Session Service | TS29581_Nmbstf_DistSession.yaml | nmbstf-distsession | A.2 | + +## 5.2 Nmbstf\_MBSDistributionSession Service + +### 5.2.1 Service Description + +The Nmbstf\_MBSDistributionSession service operates on MBS distribution sessions. The following are the key functionalities of this NF service: + +- Creation, modification, retrieval and deletion of MBS Distribution Sessions + +Table 5.2.1-1 lists the service operations that are supported by the Nmbstf\_MBSDistributionSession service. + +Table 5.2.1-1: Service operations supported by the Nmbstf\_MBSDistributionSession service + +| Service Operations | Description | Operation Semantics | Example Consumers | +|--------------------|-----------------------------------------------------------------------|---------------------|-------------------| +| Create | Create a new MBS Distribution Session within the MBSTF | Request / Response | MBSF | +| Update | Update an existing MBS Distribution Session | Request / Response | MBSF | +| Destroy | Delete an existing MBS Distribution Session | Request / Response | MBSF | +| Retrieve | Retrieve the parameters of an existing MBS Distribution Session | Request / Response | MBSF | +| StatusSubscribe | Subscribe to notifications related to an MBS Distribution Session | Subscribe/Notify | MBSF | +| StatusUnsubscribe | Unsubscribe from notifications related to an MBS Distribution Session | | MBSF | +| StatusNotify | Notify event(s) related to an MBS Distribution Session | | MBSF | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +See Table 5.2.1-1 for an overview of the service operations supported by the Nmbstf\_MBSDistributionSession service. + +#### 5.2.2.2 Create + +##### 5.2.2.2.1 General + +The Create service operation shall be used to create a new MBS Distribution Session within the MBSTF (see clauses 5.2, 4.5.2 of 3GPP TS 26.502 [17]). + +The NF Service Consumer (e.g. MBSF) shall create an MBS Distribution session in the MBSTF by using the HTTP POST method as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an MBSTF for creating an MBS Distribution session. The consumer sends a POST request to the dist-sessions resource. The MBSTF responds with either a 201 Created, a 4xx/5xx error, or a 3xx redirect.](ca7c7526ec57cd5a2f278c194c0a6a00_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MBSTF + Note left of NF Service Consumer: POST .../dist-sessions (CreateReqData) + NF Service Consumer->>MBSTF: 1. POST .../dist-sessions (CreateReqData) + MBSTF-->>NF Service Consumer: 2a. 201 Created (CreateRspData) + MBSTF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) + MBSTF-->>NF Service Consumer: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an MBSTF for creating an MBS Distribution session. The consumer sends a POST request to the dist-sessions resource. The MBSTF responds with either a 201 Created, a 4xx/5xx error, or a 3xx redirect. + +Figure 5.2.2.2.1-1: MBS Distribution session creation + +- The NF Service Consumer shall send a POST request (CreateReqData) targeting the MBS Distribution Sessions collection resource of the MBSTF. The content of the POST request shall contain the following information: + - The baseline parameters for an MBS Distribution Session including Distribution Session Identifier, and; + - Additional MBS Distribution Session parameters for Object Distribution Method, or; + - Additional MBS Distribution Session parameters for Packet Distribution Method; +- On success, the MBSTF shall return a "201 Created" response. The "Location" header shall be present and shall contain the URI of the created resource. The content of the POST response (CreateRspData) shall contain a representation of the created MBS session. + +- 2b. On failure, one of the HTTP status code listed in Table 6.1.3.2.3.1-3 shall be returned. The message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.3.1-3. +- 2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of POST response. + +#### 5.2.2.3 Update + +##### 5.2.2.3.1 General + +The Update service operation shall be used to update an existing MBS Distribution Session within the MBSTF (see clauses 5.2, 4.5.2 of 3GPP TS 26.502 [17]). + +The NF Service Consumer (e.g. MBSF) shall update an MBS Distribution session in the MBSTF by using the HTTP PATCH method as shown in Figure 5.2.2.3.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an MBSTF for an MBS Distribution session update. The consumer sends a PATCH request to the MBSTF. The MBSTF returns one of four possible responses: 2a. 204 No Content, 2b. 200 OK (DistSession), 2c. 4xx/5xx (ProblemDetails), or 2d. 3xx (RedirectResponse).](78ffccd66df9bafd96e3e081110d09dd_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MBSTF + Note left of NF Service Consumer: 1. PATCH .../dist-sessions/{distSessionRef} (PatchData) + NF Service Consumer->>MBSTF: 1. PATCH .../dist-sessions/{distSessionRef} (PatchData) + MBSTF-->>NF Service Consumer: 2a. 204 No Content + MBSTF-->>NF Service Consumer: 2b. 200 OK (DistSession) + MBSTF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) + MBSTF-->>NF Service Consumer: 2d. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an MBSTF for an MBS Distribution session update. The consumer sends a PATCH request to the MBSTF. The MBSTF returns one of four possible responses: 2a. 204 No Content, 2b. 200 OK (DistSession), 2c. 4xx/5xx (ProblemDetails), or 2d. 3xx (RedirectResponse). + +**Figure 5.2.2.3.1-1: MBS Distribution session update** + +1. The NF Service Consumer shall send a PATCH request (PatchData) to update the MBS distribution session. +- 2a. On success, the MBSTF shall return "204 No Content"; +- 2b. On success, the MBSTF shall return "200 OK" containing new resource representation of MBS distribution session; +- 2c. On failure, one of the HTTP status code listed in Table 6.1.3.3.1-3 shall be returned. The message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.1-3. +- 2d. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of PATCH response. + +#### 5.2.2.4 Destroy + +##### 5.2.2.4.1 General + +The Destroy service operation shall be used to delete an existing MBS Distribution Session within the MBSTF (see clauses 5.2, 4.5.2 of 3GPP TS 26.502 [17]). + +The NF Service Consumer (e.g. MBSF) shall delete an MBS Distribution session in the MBSTF by using the HTTP DELETE method as shown in Figure 5.2.2.4.1-1. + +![Sequence diagram for MBS Distribution session deletion. The NF Service Consumer sends a DELETE request to the MBSTF. The MBSTF responds with either a 204 No Content, a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MBSTF + Note left of NF Service Consumer: 1. DELETE .../dist-sessions/{distSessionRef} + NF Service Consumer->>MBSTF: Request + Note right of MBSTF: 2a. 204 No Content + MBSTF-->>NF Service Consumer: Response + Note right of MBSTF: 2b. 4xx/5xx (ProblemDetails) + MBSTF-->>NF Service Consumer: Response + Note right of MBSTF: 2c. 3xx (RedirectResponse) + MBSTF-->>NF Service Consumer: Response + +``` + +Sequence diagram for MBS Distribution session deletion. The NF Service Consumer sends a DELETE request to the MBSTF. The MBSTF responds with either a 204 No Content, a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse. + +**Figure 5.2.2.4.1-1: MBS Distribution session deletion** + +1. The NF Service Consumer shall send a DELETE request (distSessionRef) to release the MBS distribution session. +- 2a. On success, the MBSTF shall delete the MBS distribution session and return a "204 No Content" response. +- 2b. On failure, one of the HTTP status code listed in Table 6.1.3.3.2-3 shall be returned. The message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.2-3. +- 2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of DELETE response. + +#### 5.2.2.5 Retrieve + +##### 5.2.2.5.1 General + +The Retrieve service operation shall be used to retrieve the parameters of an existing MBS Distribution Session within the MBSTF (see clauses 5.2, 4.5.2 of 3GPP TS 26.502 [17]). + +The NF Service Consumer (e.g. MBSF) shall retrieve an MBS Distribution session in the MBSTF by using the HTTP GET method as shown in Figure 5.2.2.5.1-1. + +![Sequence diagram for MBS Distribution session retrieval. The NF Service Consumer sends a GET request to the MBSTF. The MBSTF responds with either a 200 OK (distSession), a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse.](2e399449b7f62d40167a65ca88888917_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MBSTF + Note left of NF Service Consumer: 1. GET .../dist-sessions/{distSessionRef} + NF Service Consumer->>MBSTF: Request + Note right of MBSTF: 2a. 200 OK (distSession) + MBSTF-->>NF Service Consumer: Response + Note right of MBSTF: 2b. 4xx/5xx (ProblemDetails) + MBSTF-->>NF Service Consumer: Response + Note right of MBSTF: 2c. 3xx (RedirectResponse) + MBSTF-->>NF Service Consumer: Response + +``` + +Sequence diagram for MBS Distribution session retrieval. The NF Service Consumer sends a GET request to the MBSTF. The MBSTF responds with either a 200 OK (distSession), a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse. + +**Figure 5.2.2.5.1-1: MBS Distribution session retrieval** + +1. The NF Service Consumer shall send a GET request to the resource representing the MBS distribution session (distSessionRef). +- 2a. On success, the MBSTF shall respond with "200 OK" with the message body containing parameters of the distribution session (distSession). +- 2b. On failure, one of the HTTP status code listed in Table 6.1.3.3.3-3 shall be returned. The message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3-3. +- 2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of GET response. + +#### 5.2.2.6 StatusSubscribe service operation + +##### 5.2.2.6.1 General + +The StatusSubscribe service operation shall be used by an NF Service Consumer (e.g. MBSF) to create a subscription to the MBSTF notifications related to the event(s) of an MBS distribution session. + +##### 5.2.2.6.2 Subscription creation + +The NF Service Consumer (e.g. MBSF) shall subscribe to MBSTF service notifications by using the HTTP POST method as shown in Figure 5.2.2.6.2-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an MBSTF for subscription creation. The consumer sends a POST request to the subscriptions collection resource. The MBSTF responds with either a 201 Created, a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse.](f6e8acf9f931452d01688d311b5c0364_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MBSTF + Note left of NF Service Consumer: 1. POST .../dist-sessions/{distSessionRef}/subscriptions (StatusSubscribeReqData) + NF Service Consumer->>MBSTF: Request + Note right of MBSTF: -2a. 201 Created (StatusSubscribeRspData) + MBSTF-->>NF Service Consumer: Response 2a + Note right of MBSTF: -2b. 4xx/5xx (ProblemDetails) + MBSTF-->>NF Service Consumer: Response 2b + Note right of MBSTF: -2c. 3xx (RedirectResponse) + MBSTF-->>NF Service Consumer: Response 2c + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an MBSTF for subscription creation. The consumer sends a POST request to the subscriptions collection resource. The MBSTF responds with either a 201 Created, a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse. + +**Figure 5.2.2.6.2-1: Subscribing to MBSTF notifications** + +- The NF Service Consumer shall send a POST request (StatusSubscribeReqData) to the resource URI representing the subscriptions collection resource in the MBSTF. The content of the POST request shall contain: + - the list of MBS distribution session events requested to be subscribed. + - the Notification URI, indicating the address where the MBSTF shall send the notifications; + +The request body may also contain: + +- an expiry time suggested by the NF Service Consumer, representing the time span during which the subscription is desired to be kept active; and + - Notification Correlation ID; +- On success, the MBSTF shall return a "201 Created" response. The "Location" header shall be present and shall contain the URI of the created resource. The content of the POST response (StatusSubscribeRspData) shall include: + - the Distribution Session Identifier; + - the list of events successfully subscribed; + - the expiry time after which the subscription becomes invalid. + - On failure, one of the HTTP status code listed in the data structures supported by the POST Response Body (see Table 6.1.3.4.3.1-3) shall be returned. The message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in the same Table 6.1.3.4.3.1-3). + - On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of POST response. + +##### 5.2.2.6.3 Subscription update + +When the StatusSubscribe service operation is used for updating a subscription, the NF Service Consumer (e.g. MBSF) shall update its subscription to MBSTF notifications by using the HTTP PATCH method as shown in Figure 5.2.2.6.3-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an MBSTF for updating a subscription. The NF Service Consumer sends a PATCH request to the MBSTF. The MBSTF responds with either a 200 OK (StatusSubscription), a 4xx/5xx (ProblemDetails), or a 3xx (RedirectResponse).](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MBSTF + Note left of NF Service Consumer: 1. PATCH .../dist-sessions/{distSessionRef}/subscriptions/{subscriptionId} (array(PatchItem)) + NF Service Consumer->>MBSTF: Request + Note right of MBSTF: 2a. 200 OK (StatusSubscription) + MBSTF-->>NF Service Consumer: Response + Note right of MBSTF: 2b. 4xx/5xx (ProblemDetails) + MBSTF-->>NF Service Consumer: Response + Note right of MBSTF: 2c. 3xx (RedirectResponse) + MBSTF-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an MBSTF for updating a subscription. The NF Service Consumer sends a PATCH request to the MBSTF. The MBSTF responds with either a 200 OK (StatusSubscription), a 4xx/5xx (ProblemDetails), or a 3xx (RedirectResponse). + +**Figure 5.2.2.6.3-1: Updating a subscription to MBSTF notifications** + +1. The NF Service Consumer shall send a PATCH request to update the individual subscription resource in the MBSTF (`/dist-sessions/{distSessionRef}/subscriptions/{subscriptionId}`). The message body contains an array(PatchItem), where each PatchItem type indicates a requested change to the DistSessionSubscription data structure (see clause 6.1.6.2.10). The following information may be requested to be modified with array(PatchItem) structure (see Table 6.1.3.5.3.2-2): + - Notification URI (callback URI), indicating the address where the MBSTF shall send the notifications; + - New expiration time; +- 2a. On success, the MBSTF shall return a "200 Ok" response with a representation of the modified subscription (DistSessionSubscription data structure (see clause 6.1.6.2.10)). +- 2b. On failure, one of the HTTP status code listed in Table 6.1.3.5.3.2-3 shall be returned. The message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.5.3.2-3. +- 2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of PATCH response. + +#### 5.2.2.7 StatusUnsubscribe + +##### 5.2.2.7.1 General + +The StatusUnsubscribe service operation shall be used by an NF Service Consumer (e.g. MBSF) to unsubscribe from the MBSTF notifications related to an MBS distribution session. + +The NF Service Consumer (e.g. MBSF) shall unsubscribe from MBSTF notifications by using the HTTP DELETE method as shown in Figure 5.2.2.7.1-1. + +![Sequence diagram for Figure 5.2.2.7.1-1: Unsubscribing from MBSTF notifications. The diagram shows an NF Service Consumer sending a DELETE request to an MBSTF. The MBSTF responds with either a 204 No Content, a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MBSTF + Note left of NF Service Consumer: 1. DELETE .../dist-sessions/{distSessionRef}/subscriptions/{subscriptionId} + NF Service Consumer->>MBSTF: Request + MBSTF-->>NF Service Consumer: 2a. 204 No Content + MBSTF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) + MBSTF-->>NF Service Consumer: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram for Figure 5.2.2.7.1-1: Unsubscribing from MBSTF notifications. The diagram shows an NF Service Consumer sending a DELETE request to an MBSTF. The MBSTF responds with either a 204 No Content, a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse. + +**Figure 5.2.2.7.1-1: Unsubscribing from MBSTF notifications** + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the individual subscription document resource in the MBSTF. +2. On success, the MBSTF shall return a "204 No Content" response. +- 2b. On failure, one of the HTTP status code listed in the data structures supported by the DELETE Response Body (see Table 6.1.3.5.3.1-3) shall be returned. The message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in the same Table 6.1.3.5.3.1-3. +- 2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of DELETE response. + +#### 5.2.2.8 StatusNotify + +##### 5.2.2.8.1 General + +The StatusNotify service operation shall be used by the MBSTF to notify a subscribed NF Service Consumer (e.g. MBSF) about the events related to an MBS distribution session. + +The MBSTF shall notify the NF Service Consumer (e.g. MBSF) by using the HTTP POST method to the callback URI received earlier in the subscription as shown in Figure 5.2.2.8.1-1. + +![Sequence diagram for Figure 5.2.2.8.1-1: MBTSMF notifications. The diagram shows an MBSTF sending a POST request to an NF Service Consumer. The NF Service Consumer responds with either a 204 No Content, a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse.](f57a881fcbcaf494a7dedc4f61224991_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MBSTF + Note right of MBSTF: 1. POST {notifUri} (StatusNotifyReqData) + MBSTF->>NF Service Consumer: Request + NF Service Consumer-->>MBSTF: 2a. 204 No Content + NF Service Consumer-->>MBSTF: 2b. 4xx/5xx (ProblemDetails) + NF Service Consumer-->>MBSTF: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram for Figure 5.2.2.8.1-1: MBTSMF notifications. The diagram shows an MBSTF sending a POST request to an NF Service Consumer. The NF Service Consumer responds with either a 204 No Content, a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse. + +**Figure 5.2.2.8.1-1: MBTSMF notifications** + +1. The MBSTF shall send a POST request (StatusNotifyReqData) to the callback URI ({notifUri}) of the subscribed NF Service Consumer. The content of the POST request shall contain: + - Notification Correlation ID, if this information was provided during subscription; + - the list of MBS distribution session events to be reported: + - report a DATA\_INGEST\_FAILURE event when the MBSTF failed to ingest data from the AF/AS; + - report a SESSION\_DEACTIVATED event when the MBS distribution session is deactivated; + - report a SESSION\_ACTIVATED event when the MBS distribution session is activated. + - report a SERVICE\_MANAGEMENT\_FAILURE event when the MBS distribution session failed to start. + +- report a DATA\_INGEST\_SESSION\_ESTABLISHED event when the User Data Ingest Session corresponding to the distribution session is successfully established. +- report a DATA\_INGEST\_SESSION\_TERMINATED event when the User Data Ingest Session corresponding to the distribution session is stopped at the end of the current active period. + +2a. On success, the MBSF shall return a "204 No Content" response. + +2b. On failure, one of the HTTP status code listed in the data structures supported by the POST Response Body (see Table 6.1.5.2.3.1-2) shall be returned. The message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in the same Table 6.1.5.2.3.1-2). + +2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of POST response. + +# --- 6 API Definitions + +## 6.1 Nmbstf\_MBSDistributionSession Service API + +### 6.1.1 Introduction + +The Nmbstf\_MBSDistributionSession service shall use the Nmbstf-distsession API. + +The API URI of the Nmbstf\_MBSDistributionSession API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nmbstf-distsession". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nmbstf-distsession API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +Figure 6.1.3.1-1 describes the resource URI structure of the Nmbstf\_MBSDistributionSession API. + +![A hierarchical diagram showing the resource URI structure of the Nmbstf_MBSDistributionSession API. The root is {apiRoot}/nmbstf-distsession/{apiVersion}. It branches into /dist-sessions, which branches into /{distSessionRef}, which branches into /subscriptions, which branches into /{subscriptionId}.](e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nmbstf-distsession/{apiVersion}"] --> DistSessions["/dist-sessions"] + DistSessions --> DistSessionRef["/{distSessionRef}"] + DistSessionRef --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +A hierarchical diagram showing the resource URI structure of the Nmbstf\_MBSDistributionSession API. The root is {apiRoot}/nmbstf-distsession/{apiVersion}. It branches into /dist-sessions, which branches into /{distSessionRef}, which branches into /subscriptions, which branches into /{subscriptionId}. + +Figure 6.1.3.1-1: Resource URI structure of the Nmbstf\_MBSDistributionSession API + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 6.1.3.1-1: Resources and methods overview + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | +|---------------------------------------------------------|----------------------------------------------------------------|---------------------------------|-----------------------------------------------------| +| MBS Distribution sessions collection | /dist-sessions | POST | Create | +| Individual MBS Distribution session | /dist-sessions/{distSessionRef} | PATCH | Update | +| | | GET | Retrieve | +| | | DELETE | Destroy | +| Subscriptions collection for MBS Distribution sessions | /dist-sessions/{distSessionRef}/subscriptions | POST | StatusSubscribe (to create a subscription) | +| Individual subscription for an MBS Distribution session | /dist-sessions/{distSessionRef}/subscriptions/{subscriptionId} | DELETE | StatusUnsubscribe | +| | | PATCH | StatusSubscribe (to update or renew a subscription) | + +#### 6.1.3.2 Resource: MBS Distribution sessions collection (Collection) + +##### 6.1.3.2.1 Description + +This resource represents the collection of the MBS Distribution sessions created in the MBSTF. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nmbstf-distSession//dist-sessions + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method creates an individual MBS distribution session resource in the MBSTF. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|---------------------------------------------------------------------------| +| CreateReqData | M | 1 | Representation of the MBS distribution session to be created in the MBSTF | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|---------------------------------------| +| CreateRspData | M | 1 | 201
Created | Successful creation of an MBS session | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.1.3.2.3.1-4: Headers supported by the POST method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +Table 6.1.3.2.3.1-5: Headers supported by the 201 response code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nmbstf-distSession//dist-sessions/{distSessionRef} | + +Table 6.1.3.2.3.1-6: Headers supported by the 307 response code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +Table 6.1.3.2.3.1-7: Headers supported by the 308 response code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +##### 6.1.3.2.4 Resource Custom Operations + +None + +#### 6.1.3.3 Resource: Individual MBS distribution session (Document) + +##### 6.1.3.3.1 Description + +This resource represents an individual MBS distribution session created in the MBSTF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nmbstf-distSession//dist-sessions/{distSessionRef} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------------------------------------| +| apiRoot | String | See clause 6.1.1 | +| apiVersion | String | See clause 6.1.1 | +| distSessionRef | String | MBS distribution session reference assigned by the MBSTF during the Create service operation | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 PATCH + +This method updates an individual MBS distribution session resource in the MBSTF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | List of changes to be made to the MBS session resource, according to the JSON PATCH format specified in IETF RFC 6902 [16]. | + +**Table 6.1.3.3.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful response | +| DistSession | M | 1 | 200 OK | Upon success, a response body containing the updated representation of Distribution Session shall be returned | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +###### 6.1.3.3.3.2 DELETE + +This method deletes an individual MBS distribution session resource in the MBSTF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------| +| n/a | | | 204 No Content | Successful response | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MB-STF (service) instance ID towards which the request is redirected | + +###### 6.1.3.3.3.3 GET + +This method retrieves an individual MBS distribution session resource in the MBSTF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.3-1. + +**Table 6.1.3.3.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.3-2 and the response data structures and response codes specified in table 6.1.3.3.3.3-3. + +**Table 6.1.3.3.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------| +| DistSession | M | 1 | 200 OK | Successful response containing representation of the MBS Distribution Session | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +##### 6.1.3.3.4 Resource Custom Operations + +None. + +#### 6.1.3.4 Resource: Subscriptions collection for MBS distribution session (Collection) + +##### 6.1.3.4.1 Description + +This resource represents the collection of the individual subscriptions for an MBS distribution session created in the MBSTF with StatusSubscribe service operation. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nmbstf-distSession//dist-sessions/{distSessionRef}/subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1 | +| distSessionRef | string | MBS distribution session reference assigned by the MBSTF during the Create service operation | + +##### 6.1.3.4.3 Resource Standard Methods + +###### 6.1.3.4.3.1 POST + +This method creates an individual subscription resource for an MBS distribution session in the MBSTF with StatusSubscribe service operation. + +This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1. + +**Table 6.1.3.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-----------------------------------------| +| StatusSubscribeReqData | M | 1 | Data within the StatusSubscribe Request | + +**Table 6.1.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|------------------------------------------| +| StatusSubscribeRspData | M | 1 | 201
Created | Data within the StatusSubscribe Response | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.4.3.1-4: Headers supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +**Table 6.1.3.4.3.1-5: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/nmbstf-distSession//dist-sessions/{distSessionRef}/subscriptions/{subscriptionId} | + +**Table 6.1.3.4.3.1-6: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.4.3.1-7: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +##### 6.1.3.4.4 Resource Custom Operations + +None. + +#### 6.1.3.5 Resource: Individual subscription for an MBS distribution session (Document) + +##### 6.1.3.5.1 Description + +This resource represents an individual subscription for an MBS distribution session in the MBSTF, which can be deleted with StatusUnsubscribe service operation or updated with StatusSubscribe service operation. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nmbstf-distsession/{apiVersion}/dist-sessions/{distSessionRef}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| apiVersion | string | See clause 6.1.1 | +| distSessionRef | string | MBS distribution session reference assigned by the MBSTF during the Create service operation | +| subscriptionId | string | Subscription identifier assigned by the MBSTF during the creation of the subscription | + +##### 6.1.3.5.3 Resource Standard Methods + +###### 6.1.3.5.3.1 DELETE + +This method deletes an individual subscription resource for an MBS distribution session in the MBSTF with StatusUnsubscribe service operation. + +This method shall support the URI query parameters specified in table 6.1.3.5.3.1-1. + +**Table 6.1.3.5.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.1-2 and the response data structures and response codes specified in table 6.1.3.5.3.1-3. + +**Table 6.1.3.5.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.5.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | Successful deletion | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +###### 6.1.3.5.3.2 PATCH + +This method updates an individual subscription resource for an MBS distribution session in the MBSTF with StatusSubscribe service operation for the subscription update (see clause 5.2.2.6.3). + +This method shall support the URI query parameters specified in table 6.1.3.5.3.2-1. + +**Table 6.1.3.5.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.2-2 and the response data structures and response codes specified in table 6.1.3.5.3.2-3. + +**Table 6.1.3.5.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1 | It shall contain the list of changes to be made to the Status Subscription (i.e. DistSessionSubscription data type), according to the JSON PATCH format specified in IETF RFC 6902 [16]. | + +**Table 6.1.3.5.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------| +| DistSessionSubscription | M | 1 | 200 OK | Upon success, a response body shall be returned containing the updated Status Subscription. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.5.3.2-4: Headers supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +**Table 6.1.3.5.3.2-5: Headers supported by the 200 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +**Table 6.1.3.5.3.2-6: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.5.3.2-7: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MBSTF (service) instance ID towards which the request is redirected | + +##### 6.1.3.5.4 Resource Custom Operations + +None. + +### 6.1.4 Custom Operations without associated resources + +None + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|--------------|---------------------------------|---------------------------------| +| Event Notification | NotifUri | POST | StatusNotify | + +#### 6.1.5.2 StatusNotify + +##### 6.1.5.2.1 Description + +The Event Notification is used by the NF service producer to report one or several observed Events to a NF service consumer that has subscribed to such Notifications. + +##### 6.1.5.2.2 Target URI + +The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables** + +| Name | Definition | +|----------|-----------------------------------------------| +| notifUri | String formatted as URI with the Callback Uri | + +##### 6.1.5.2.3 Standard Methods + +###### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-2. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|--------------------------------------| +| StatusNotifyReqData | M | 1 | Data within the StatusNotify Request | + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------| +| n/a | | | 204 No Content | Successful response | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 6.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nmbstf\_MBSDistributionSession service based interface protocol. + +**Table 6.1.6.1-1: Nmbstf\_MBSDistributionSession specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------------------|----------------|-----------------------------------------------|---------------| +| CreateReqData | 6.1.6.2.2 | Data within the Create Request | | +| CreateRspData | 6.1.6.2.3 | Data within the Create Response | | +| DistSession | 6.1.6.2.4 | Data specific to distribution session | | +| ObjDistributionData | 6.1.6.2.5 | Data specific to Object Distribution Method | | +| PktDistributionData | 6.1.6.2.6 | Data specific to Packet Distribution Method | | +| StatusSubscribeReqData | 6.1.6.2.7 | Data within Subscription creation request | | +| StatusSubscribeRspData | 6.1.6.2.8 | Data within Subscription creation response | | +| StatusNotifyReqData | 6.1.6.2.9 | Data within Notification request | | +| DistSessionSubscription | 6.1.6.2.10 | Data specific to subscription request | | +| DistSessionEventReportList | 6.1.6.2.11 | MBS distribution session event report list | | +| DistSessionEventReport | 6.1.6.2.12 | MBS distribution session event report | | +| UpTrafficFlowInfo | 6.1.6.2.13 | IP Multicast Address and Port Number | | +| MbStfIngestAddr | 6.1.6.2.14 | MBSTF Ingest Addresses | | +| ExtSsm | 6.1.6.2.15 | SSM and Port Number | | +| DistSessionState | 6.1.6.3.3 | MBS distribution session state | | +| ObjDistributionOperatingMode | 6.1.6.3.4 | Operating Mode for Object distribution method | | +| ObjAcquisitionMethod | 6.1.6.3.5 | Object acquisition method | | +| PktDistributionOperatingMode | 6.1.6.3.6 | Operating Mode for Packet distribution method | | +| DistSessionEventType | 6.1.6.3.7 | MBS distribution session event type | | +| PktIngestMethod | 6.1.6.3.8 | Packet Ingest Method | | + +Table 6.1.6.1-2 specifies data types re-used by the Nmbstf\_MBSDistributionSession service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nmbstf\_MBSDistributionSession service based interface. + +**Table 6.1.6.1-2: Nmbstf\_MBSDistributionSession re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|---------------------|-------------------------------------------|---------------| +| TunnelAddress | 3GPP TS 29.571 [16] | Tunnel Address (UDP/IP) | | +| BitRate | 3GPP TS 29.571 [16] | Bit Rate | | +| PacketDelBudget | 3GPP TS 29.571 [16] | Maximum Delay | | +| Uri | 3GPP TS 29.571 [16] | Uniform resource identifier | | +| DateTime | 3GPP TS 29.571 [16] | Data and Time | | +| NfInstanceId | 3GPP TS 29.571 [16] | NF Instance Identifier | | +| UInteger | 3GPP TS 29.571 [16] | Unsigned Integer | | +| IpAddr | 3GPP TS 29.571 [16] | IP Address | | +| Ssm | 3GPP TS 29.571 [16] | Source Specific Multicast Address | | +| FECConfig | 3GPP TS 29.580 [18] | FEC Configuration | | +| RedirectResponse | 3GPP TS 29.571 [16] | Contains redirection related information. | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +6.1.6.2.2 Type: CreateReqData + +**Table 6.1.6.2.2-1: Definition of type CreateReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-----------------------------------------|---------------| +| distSession | DistSession | M | 1 | MBS Distribution Session to be created. | | + +6.1.6.2.3 Type: CreateRspData + +**Table 6.1.6.2.3-1: Definition of type CreateRspData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-------------------------------------------|---------------| +| distSession | DistSession | M | 1 | Representation of the created MBS session | | + +##### 6.1.6.2.4 Type: DistSession + +Table 6.1.6.2.4-1: Definition of type DistSession + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| distSessionId | string | M | 1 | An identifier for this MBS Distribution Session assigned by the MBSF that is unique within the scope of the MBS User Service (see clause 4.5.3 of 3GPP TS 26.502) | | +| distSessionState | DistSessionState | M | 1 | The current state of the MBS Distribution Session (see clause 4.6.1 of 3GPP TS 26.502) | | +| mbUpfTunAddr | TunnelAddress | M | 1 | The tunnel endpoint address of the MB-UPF that supports this MBS Distribution Session at reference point Nmb9 or the tunnel endpoint address of the MBMS-GW at reference point SGi-mb.

Write-Only: true | | +| mbmsGwTunAddr | TunnelAddress | O | 0..1 | This IE may be present to contain the tunnel endpoint address of the MBMS-GW at reference point SGi-mb when the mbUpfTunAddr is also present which contains the tunnel endpoint address of the MB-UPF that supports this MBS Distribution Session at reference point Nmb9.

Write-Only: true | | +| upTrafficFlowInfo | UpTrafficFlowInfo | C | 0..1 | Details of the traffic flow to be used by the MBSTF for this MBS Distribution Session, including the multicast group destination address and port number.

Shall be present in case of Object Distribution Method and Packet Distribution Method in Packet Proxy Mode.

Write-Only: true | | +| mbr | BitRate | M | 1 | The maximum bit rate for this MBS Distribution Session

Write-Only: true | | +| maxDelay | PacketDelBudget | O | 0..1 | The maximum end-to-end distribution delay that is tolerated for this MBS Distribution Session by the MBS Application Provider

Write-Only: true | | +| objDistributionData | ObjDistributionData | C | 0..1 | Additional MBS Distribution Session parameters for Object Distribution Method (NOTE 1) | | +| pktDistributionData | PktDistributionData | C | 0..1 | Additional MBS Distribution Session parameters for Packet Distribution Method (NOTE 1) | | +| fecInformation | FECConfig | O | 0..1 | Configuration for FEC information added by the MBSTF to protect this MBS Distribution Session. | | +| dscpMarking | string | O | 0..1 | DSCP Marking to be applied to outgoing traffic.

It shall be encoded as two octet string in hexadecimal representation. The first octet shall contain the DSCP value in the IPv4 Type-of-Service or the IPv6 Traffic-Class field and the second octet shall contain the ToS/Traffic Class mask field, which shall be set to "0xFC".

Write-Only: true | | + +NOTE 1: Either the objDistributionData IE or the pktDistributionData IE shall be present in a request/response. + +##### 6.1.6.2.5 Type: ObjDistributionData + +Table 6.1.6.2.5-1: Definition of type ObjDistributionData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| objDistributionOperatingMode | ObjDistributionOperatingMode | M | 1 | Operating Mode for the Object distribution method | | +| objAcquisitionMethod | ObjAcquisitionMethod | M | 1 | Indicates whether the object(s) are to be pushed into the MBSTF by the MBS Application Provider or whether they are to be pulled from the MBS Application Provider by the MBSTF | | +| objAcquisitionIdsPull | array(Uri) | C | 1..N | Represents the URL(s) (expressed as path(es) relative to the object ingest base URL provided in the "objIngestBaseUrl" attribute) pointing to the root object(s) to be pulled by the MBSTF and then distributed during this MBS Distribution Session.

This attribute shall be provided, when available.

See clause 6.1 of 3GPP TS 26.502 [17]

(NOTE 2, NOTE 5) | | +| objAcquisitionIdsPush | Uri | C | 0..1 | Represents the URL (expressed as a path relative to the object ingest base URL provided in the "objIngestBaseUrl" attribute) pointing to the root object(s) to be pushed to the MBSTF and then distributed during this MBS Distribution Session.

This attribute shall be provided, when available.

See clause 6.1 of 3GPP TS 26.502 [17]

(NOTE 2, NOTE 5) | | +| objIngestBaseUrl | Uri | C | 0..1 | Represents the object ingest base URL. It contains a URL prefix that is replaced by the object distribution base URL by the MBSTF to derive the object distribution URI prior to the distribution of ingested objects.

Shall be present if the object Distribution base URL (within the "objDistributionBaseUrl") is present.

(NOTE 3, NOTE 4) | | +| objDistributionBaseUrl | Uri | O | 0..1 | Represents the object distribution base URL. It contains a URL prefix with which the MBSTF replaces the object ingest base URL to derive the object distribution URL prior to the distribution of ingested objects.

(NOTE 4) | | + +NOTE 1: void. + +NOTE 2: Either the "objAcquisitionIdsPull" attribute or the "objAcquisitionIdsPush" attribute shall be provided, when available. + +NOTE 3: When the "objAcquisitionMethod" attribute is set to "PULL", this attribute may be provided by the MBSF during the creation and/or update/modification of the MBS Distribution Session (if received from the AF). When the "objAcquisitionMethod" attribute is set to "PUSH", this attribute may be provided by the MBSTF in the response to the creation and/or update/modification request of the MBS Distribution Session. + +NOTE 4: When the "objDistributionBaseUrl" attribute is omitted, nothing is replaced/removed from the object ingest URL when deriving the object distribution URL. + +NOTE 5: For group message delivery, the NEF transforms the group message payload into a file, so as an object to be ingested and distributed by the MBSTF using PULL or PUSH Method as specified in 3GPP TS 23.247 [15]. + +6.1.6.2.6 Type: PktDistributionData + +**Table 6.1.6.2.6-1: Definition of type PktDistributionData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------|------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pktDistributionOperatingMode | PktDistributionOperatingMode | M | 1 | Operating Mode for the Packet distribution method | | +| pktIngestMethod | PktIngestMethod | C | 1 | Indicates whether packets are ingested using multicast or unicast ingest. It shall be present if operating mode of the packet distribution method is set to "PACKET_PROXY". | | +| mbStfIngestAddr | MbStfIngestAddr | M | 1 | The endpoint addresses used by the MBS Application Provider and MBSTF to establish a connection at reference point Nmb8 prior to the commencement of MBS User Data Ingest Session. | | + +6.1.6.2.7 Type: StatusSubscribeReqData + +**Table 6.1.6.2.7-1: Definition of type StatusSubscribeReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|----------------------------|---------------| +| subscription | DistSessionSubscription | M | 1 | Subscription to be created | | + +6.1.6.2.8 Type: StatusSubscribeRspData + +**Table 6.1.6.2.8-1: Definition of type StatusSubscribeReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------|---------------| +| subscription | DistSessionSubscription | M | 1 | Subscription created | | +| reportList | DistSessionEventReportList | C | 0..1 | Immediate event reports, if requested in the request and if corresponding information is available. | | + +6.1.6.2.9 Type: StatusNotifyReqData + +**Table 6.1.6.2.9-1: Definition of type StatusSubscribeReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|-----------------------------|---------------| +| reportList | DistSessionEventReportList | M | 1 | Reported MBS session events | | + +6.1.6.2.10 Type: DistSessionSubscription + +Table 6.1.6.2.10-1: Definition of type DistSessionSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eventList | array(DistSessionEventType) | M | 1..N | List of MBS distribution session events subscribed | +| notifyUri | Uri | M | 1 | URI where the NF service consumer requests to receive notifications.
Write-Only: true | +| notifyCorrelationId | string | O | 0..1 | Notification Correlation ID
Write-Only: true | +| expiryTime | DateTime | O | 0..1 | When present in the subscription creation request, it shall indicate the time up to which the subscription is desired to be kept active and after which the subscribed events shall stop generating notifications.

When present in a subscription response, it shall indicate the expiry time after which the subscription becomes invalid. | +| nfcInstanceId | NfInstanceId | C | 0..1 | NF Instance ID of the NF Service Consumer
This IE shall be present if available.
Write-Only: true | +| distSessionSubscUri | Uri | C | 0..1 | This IE shall be present in the response to an MBS distribution session creation request that includes a subscription to events about the MBS session and the subscription was created successfully. When present, it shall contain the URI of the individual subscription resource.

Read-Only: true
(NOTE) | + +NOTE: When an MBS distribution session status subscription is created separately (i.e. after) an MBS distribution session creation, the Location header returned in the MBS distribution session status subscription creation response contains the URI of the created subscription. + +##### 6.1.6.2.11 Type: DistSessionEventReportList + +Table 6.1.6.2.11-1: Definition of type DistSessionEventReportList + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------|---------------| +| eventReportList | array(DistSessionEventReport) | M | 1..N | List of MBS distribution session events to report | | +| notifyCorrelationId | string | C | 0..1 | Notification Correlation ID.
This IE shall be present if a Notification Correlation ID is available in the subscription. | | + +##### 6.1.6.2.12 Type: DistSessionEventReport + +Table 6.1.6.2.12-1: Definition of type DistSessionEventReport + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| eventType | DistSessionEventType | M | 1 | MBS distribution session event type | | +| timeStamp | DateTime | C | 0..1 | This IE shall contain the time at which the event is generated. This IE should be present, if available. | | + +##### 6.1.6.2.13 Type: UpTrafficFlowInfo + +Table 6.1.6.2.13-1: Definition of type UpTrafficFlowInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------|---------------| +| destIpAddr | IpAddr | M | 1 | Multicast group destination Address | | +| portNumber | Uinteger | M | 1 | Port Number | | + +6.1.6.2.14 Type: MbStfIngestAddr + +**Table 6.1.6.2.14-1: Definition of type MbStfIngestAddr** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| afEgressTunAddr | TunnelAddress | C | 0..1 |

AF side endpoint address and port for establishment of unicast tunnel at reference point Nmb8 prior to the commencement of MBS User Data Ingest Session.

The MBSTF shall use this information to validate the source IP address and port of incoming packets pertaining to the MBS User Data Ingest Session from the MBS Application Provider.

This IE shall be included if the packet distribution method is used and when the operating mode is set to "PACKET_FORWARD_ONLY", or when the operating mode is set to "PACKET_PROXY" while the packet ingest method is set to "UNICAST".

This shall be present only in the Create request over the Nmb2, Nmb10 and Nmb5 interfaces.

Write-Only: true

| | +| mbStfIngressTunAddr | TunnelAddress | C | 0..1 |

MBSTF side endpoint address and port for establishment of unicast tunnel at reference point Nmb8 prior to the commencement of MBS User Data Ingest Session.

It is applicable only if operating mode of the packet distribution method is set to "PACKET_FORWARD_ONLY".

This shall be present only in either the response to the Create (or Retrieve) request over the Nmb2, Nmb10 and Nmb5 interfaces, or a notification request over the Nmb10 and Nmb5 interfaces.

Read-Only: true

| | +| afSsm | ExtSsm | C | 0..1 |

AF side Source specific multicast address and port to which MBSTF issues an IGMP Join to ingest multicast UDP/IP datagrams.

It is applicable only if operating mode of the packet distribution method is set to "PACKET_PROXY" and packet ingest method is set to "MULTICAST".

This shall be present only in the Create request over the Nmb2, Nmb10 and Nmb5 interfaces.

Write-Only: true

| | +| mbStfListenAddr | TunnelAddress | C | 0..1 |

MBSTF side endpoint address and port for to receive unicast-addressed UDP/IP datagrams.

It is applicable only if operating mode of the packet distribution method is set to "PACKET_PROXY" and packet ingest method is set to "UNICAST".

This shall be present only in the response to the Create (or Retrieve) request over the Nmb2, Nmb10 and Nmb5 interfaces, or a notification request over the Nmb10 and Nmb5 interfaces.

Read-Only: true

| | + +##### 6.1.6.2.15 Type: ExtSsm + +Table 6.1.6.2.15-1: Definition of type ExtSsm + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| ssm | Ssm | M | 1 | Source Specific Multicast Address consisting of multicast source IP address and the destination multicast address | | +| portNumber | Uinteger | M | 1 | Source Port | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +None + +##### 6.1.6.3.3 Enumeration: DistSessionState + +The enumeration DistSessionState represents the current state of the MBS Distribution Session. It shall comply with the values defined in table 6.1.6.3.3-1. + +Table 6.1.6.3.3-1: Enumeration DistSessionState + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------|---------------| +| "INACTIVE" | Distribution Session in Inactive | | +| "ESTABLISHED" | Distribution Session in Established | | +| "ACTIVE" | Distribution Session in Active | | +| "DEACTIVATING" | Distribution Session in Released | | + +##### 6.1.6.3.4 Enumeration: ObjDistributionOperatingMode + +The enumeration ObjDistributionOperatingMode defines the mode of data ingestion for Object distribution method. It shall comply with the values defined in table 6.1.6.3.4-1. + +Table 6.1.6.3.4-1: Enumeration ObjDistributionOperatingMode + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "SINGLE" | Each object ingested by the MBSTF is distributed once | | +| "COLLECTION" | A set of objects described by a manifest is ingested by the MBSTF and distributed once | | +| "CAROUSEL" | A set of one or more objects described by a manifest is ingested by the MBSTF and distributed according to a repetition pattern specified in the manifest | | +| "STREAMING" | A sequence of objects is ingested by the MBSTF and streamed in real time | | + +##### 6.1.6.3.5 Enumeration: ObjAcquisitionMethod + +The enumeration ObjAcquisitionMethod indicates whether the objects(s) are to be pushed into the MBSTF by the MBS Application Provider or whether they are to be pulled from the MBS Application Provider by the MBSTF. It shall comply with the values defined in table 6.1.6.3.5-1. + +**Table 6.1.6.3.5-1: Enumeration ObjAcquisitionMethod** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------|---------------| +| "PULL" | MBSTF Pulls objects from AF/AS | | +| "PUSH" | AF/AS Pushes objects into MBSTF | | + +##### 6.1.6.3.6 Enumeration: PktDistributionOperatingMode + +The enumeration PktDistributionOperatingMode defines the mode of data ingestion for Packet distribution method. It shall comply with the values defined in table 6.1.6.3.6-1. + +**Table 6.1.6.3.6-1: Enumeration PktDistributionOperatingMode** + +| Enumeration value | Description | Applicability | +|-----------------------|---------------------------------------------------------------------------------------------------------------------|---------------| +| "PACKET_PROXY" | The payloads of UDP packets ingested by the MBSTF are forwarded to the MB-UPF in new UDP packets (Layer 4 proxying) | | +| "PACKET_FORWARD_ONLY" | The payloads of IP packets ingested by the MBSTF are forwarded to the MB-UPF in new IP packets (Layer 3 proxying) | | + +##### 6.1.6.3.7 Enumeration: DistSessionEventType + +The enumeration DistSessionEventType defines the status of the MBS distribution session that NF consumer wants to subscribe to. It shall comply with the values defined in table 6.1.6.3.7-1. + +**Table 6.1.6.3.7-1: Enumeration DistSessionEventType** + +| Enumeration value | Description | Applicability | +|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| +| "DATA_INGEST_FAILURE" | MBSTF failed to ingest data from AF/AS | | +| "SESSION_DEACTIVATED" | Session released in MBSTF | | +| "SESSION_ACTIVATED" | Delivery started towards MB-UPF | | +| "SERVICE_MANAGEMENT_FAILURE" | MBS distribution session failed to start | | +| "DATA_INGEST_SESSION_ESTABLISHED" | MBSTF successfully established the User Data Ingest Session corresponding to the distribution session. | | +| "DATA_INGEST_SESSION_TERMINATED" | MBSTF stopped the User Data Ingest Session corresponding to the distribution session at the end of the current active period. | | + +##### 6.1.6.3.8 Enumeration: PktIngestMethod + +The enumeration PktIngestMethod defines the mode of data ingestion for Packet distribution method. It shall comply with the values defined in table 6.1.6.3.8-1. + +**Table 6.1.6.3.8-1: Enumeration PktIngestMethod** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------|---------------| +| "MULTICAST" | Multicast Ingest Mode | | +| "UNICAST" | Unicast Ingest Mode | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +None + +#### 6.1.6.5 Binary data + +None + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nmbstf-distsession API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nmbstf-distsession API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nmbstf-distsession service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nmbstf-distsession service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nmbstf-distsession API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nmbstf-distsession API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nmbstf-distsession API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nmbstf-distsession service. + +The Nmbstf-distsession API defines a single scope "nmbstf-distsession" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different MBSTF service instance within the same MBSTF, or to a different MBSTF of an MBSTF set, when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different MBSTF producer instance will return the NF Instance ID of the new MBSTF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an MBSTF redirects a service request to a different MBSTF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new MBSTF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nmbstf\_DistSession API + +``` +openapi: 3.0.0 + +info: + title: Nmbstf-distsession + version: 1.1.0-alpha.1 + description: | + MBSTF Distribution Session Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.581 V18.3.0; 5G System; MBSDistribution Service. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.581/ + +servers: + - url: '{apiRoot}/nmbstf-distsession/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nmbstf-distsession + +paths: + /dist-sessions: + post: + summary: Create + tags: + - MBS distribution sessions collection + operationId: Create + requestBody: + description: > + Representation of the MBS distribution session to be created in the MBSTF + Creates an individual MBS distribution session resource in the MBSTF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateReqData' + responses: + '201': + description: > +``` + +``` + +Successful creation of an MBS session +content: + application/json: + schema: + $ref: '#/components/schemas/CreateRspData' +headers: + Location: + description: > + 'Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nmbstf-distsession//dist-sessions/{distSessionRef}' + required: true + schema: + type: string +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/dist-sessions/{distSessionRef}: + patch: + summary: Updates an individual MBS distribution session resource in the MBSTF. + tags: + - Individual MBS distribution session + operationId: Update + parameters: + - name: distSessionRef + in: path + required: true + description: Unique ID of the MBS distribution session + schema: + type: string + requestBody: + description: Data within the Update Request + required: true + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + responses: + '204': + description: > + Successful modification of the MBS distribution session without content in the response. + '200': + description: > + Successful response containing the updated representation of Distribution Session. + content: + application/json: + schema: + $ref: '#/components/schemas/DistSession' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + +``` + +``` +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes an individual MBS distribution session resource in the MBSTF. + tags: + - Individual MBS distribution session + operationId: Destroy + parameters: + - name: distSessionRef + in: path + required: true + description: Unique ID of the MBS distribution session + schema: + type: string + responses: + '204': + description: > + Successful release of the MBS distribution session without content in the response. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +get: + summary: Retrieves an individual MBS distribution session resource in the MBSTF. + tags: + - Individual MBS distribution session + operationId: Retrieve + parameters: + - name: distSessionRef + in: path + required: true + description: Unique ID of the MBS distribution session + schema: + type: string +``` + +``` +responses: + '200': + description: successful retrieval of MBS distribution session parameters + content: + application/json: + schema: + $ref: '#/components/schemas/DistSession' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/dist-sessions/{distSessionRef}/subscriptions: + post: + summary: StatusSubscribe creating a subscription + tags: + - Subscriptions collection for MBS distribution session + operationId: StatusSubscribe + parameters: + - name: distSessionRef + in: path + required: true + description: Unique ID of the MBS distribution session + schema: + type: string + requestBody: + description: Data within the StatusSubscribe Request + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/StatusSubscribeReqData' + responses: + '201': + description: Data within a successful StatusSubscribe Response + content: + application/json: + schema: + $ref: '#/components/schemas/StatusSubscribeRspData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +callbacks: + statusNotification: + '{ $request.body#/notifUri }': + post: + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: Notification Payload + content: + application/json: + schema: + $ref: '#/components/schemas/StatusNotifyReqData' + responses: + '204': + description: Expected response to a successful callback processing + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/dist-sessions/{distSessionRef}/subscriptions/{subscriptionId}: + delete: + summary: StatusUnSubscribe to unsubscribe from the Status Subscription + tags: + - Individual Subscription for an MBS session + operationId: StatusUnSubscribe + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription + schema: + type: string + - name: distSessionRef + in: path + required: true + description: Unique ID of the MBS distribution session + +``` + +``` + schema: + type: string + responses: + '204': + description: Successful deletion of the subscription + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: StatusSubscribe to modify (update or renew) an individual subscription + tags: + - Individual Subscription for an MBS distribution session + operationId: StatusSubscribeMod + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the individual subscription to be modified + schema: + type: string + - name: distSessionRef + in: path + required: true + description: Unique ID of the MBS distribution session + schema: + type: string + requestBody: + description: Data to be modified in the DistSessionSubscription + required: true + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + responses: + '200': + description: Successful modification of the individual Status Subscription + content: + application/json: + schema: + $ref: '#/components/schemas/DistSessionSubscription' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nmbstf-distsession: Access to the nmbstf-distsession API + +schemas: +# +# STRUCTURED DATA TYPES +# + +CreateReqData: + description: Data within Create Request + type: object + properties: + distSession: + $ref: '#/components/schemas/DistSession' + required: + - distSession + +CreateRspData: + description: Data within Create Response + type: object + properties: + distSession: + $ref: '#/components/schemas/DistSession' + required: + - distSession + +DistSession: + description: Mbs Distribution Session Information + type: object + properties: + distSessionId: + type: string + distSessionState: + $ref: '#/components/schemas/DistSessionState' + mbUpfTunAddr: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/TunnelAddress' + mbmsGwTunAddr: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/TunnelAddress' + upTrafficFlowInfo: + writeOnly: true + allOf: + - $ref: '#/components/schemas/UpTrafficFlowInfo' + mbr: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxDelay: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + objDistributionData: + $ref: '#/components/schemas/ObjDistributionData' + pktDistributionData: + $ref: '#/components/schemas/PktDistributionData' +``` + +``` +fecInformation: + $ref: 'TS29580_NmbSF_MBSUserDataIngestSession.yaml#/components/schemas/FECConfig' + dscpmarking: + type: string + writeOnly: true + required: + - distSessionId + - distSessionState + - mbUpfTunAddr + - mbr + oneOf: + - required: [ objDistributionData ] + - required: [ pktDistributionData ] + +ObjDistributionData: + description: Info for Object Distribution Method + type: object + properties: + objDistributionOperatingMode: + $ref: '#/components/schemas/ObjDistributionOperatingMode' + objAcquisitionMethod: + $ref: '#/components/schemas/ObjAcquisitionMethod' + objAcquisitionIdsPull: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + objAcquisitionIdPush: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + objIngestBaseUrl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + objDistributionBaseUrl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + required: + - objDistributionOperatingMode + - objAcquisitionMethod + not: + - required: [ objAcquisitionIdsPull, objAcquisitionIdPush ] + +PktDistributionData: + description: Info for Packet Distribution Method + type: object + properties: + pktDistributionOperatingMode: + $ref: '#/components/schemas/PktDistributionOperatingMode' + pktIngestMethod: + $ref: '#/components/schemas/PktIngestMethod' + mbStfIngestAddr: + $ref: '#/components/schemas/MbStfIngestAddr' + required: + - pktDistributionOperatingMode + - mbStfIngestAddr + +StatusSubscribeReqData: + description: Data within the StatusSubscribe Request + type: object + properties: + subscription: + $ref: '#/components/schemas/DistSessionSubscription' + required: + - subscription + +StatusSubscribeRspData: + description: Data within StatusSubscribe Response + type: object + properties: + subscription: + $ref: '#/components/schemas/DistSessionSubscription' + reportList: + $ref: '#/components/schemas/DistSessionEventReportList' + required: + - subscription + +StatusNotifyReqData: + description: Status Notification + type: object +``` + +``` +properties: + reportList: + $ref: '#/components/schemas/DistSessionEventReportList' +required: + - reportList + +DistSessionSubscription: + description: Data within the Status Subscription + type: object + properties: + nfcInstanceId: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + eventList: + type: array + items: + $ref: '#/components/schemas/DistSessionEventType' + minItems: 1 + notifyUri: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorrelationId: + type: string + writeOnly: true + expiryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + distSessionSubscUri: + readOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + required: + - eventList + - notifyUri + +DistSessionEventReportList: + description: List of Event Reports + type: object + properties: + eventReportList: + type: array + items: + $ref: '#/components/schemas/DistSessionEventReport' + minItems: 1 + notifyCorrelationId: + type: string + required: + - eventReportList + +DistSessionEventReport: + description: Data related to a specific event + type: object + properties: + eventType: + $ref: '#/components/schemas/DistSessionEventType' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - eventType + +UpTrafficFlowInfo: + description: IP Multicast Address and Port Number + type: object + properties: + destIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + portNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + required: + - destIpAddr + - portNumber + +MbStfIngestAddr: + description: MBSTF Ingest Addresses + type: object + properties: + afEgressTunAddr: +``` + +``` + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/TunnelAddress' + mbStfIngressTunAddr: + readOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/TunnelAddress' + afSsm: + writeOnly: true + allOf: + - $ref: '#/components/schemas/ExtSsm' + mbStfListenAddr: + readOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/TunnelAddress' + +ExtSsm: + description: SSM and Port Number + type: object + properties: + ssm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ssm' + portNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + required: + - ssm + - portNumber + +# +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + +DistSessionState: + description: Current State of MBS distribution session + anyOf: + - type: string + enum: + - INACTIVE + - ESTABLISHED + - ACTIVE + - DEACTIVATING + - type: string + +ObjDistributionOperatingMode: + description: Mode of data ingestion for Object distribution method + anyOf: + - type: string + enum: + - SINGLE + - COLLECTION + - CAROUSEL + - STREAMING + - type: string + +ObjAcquisitionMethod: + description: Object Acquisition Method + anyOf: + - type: string + enum: + - PULL + - PUSH + - type: string + +PktDistributionOperatingMode: + description: Mode of data ingestion for Packet distribution method + anyOf: + - type: string + enum: + - PACKET_PROXY + - PACKET_FORWARD_ONLY + - type: string + +DistSessionEventType: +``` + +``` +description: Status Event Type +anyOf: +- type: string + enum: + - DATA_INGEST_FAILURE + - SESSION_DEACTIVATED + - SESSION_ACTIVATED + - SERVICE_MANAGEMENT_FAILURE + - DATA_INGEST_SESSION_ESTABLISHED + - DATA_INGEST_SESSION_TERMINATED +- type: string + +PktIngestMethod: +description: Packet Ingest Method +anyOf: +- type: string + enum: + - MULTICAST + - UNICAST +- type: string +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-----------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2022-03 | CT4 #109e | C4-222344 | | | | Implementation of following pCRs: C4-222320, C4-222321, C4-222322, C4-222323, C4-222324, C4-222325, C4-222326 | 0.1.0 | +| 2022-05 | CT4 #110e | C4-223453 | | | | Implementation of following pCRs: C4-223027, C4-223044, C4-223047, C4-223325, C4-223326, C4-223330, C4-223423, C4-223511 | 0.2.0 | +| 2022-06 | CT#96 | CP-221081 | | | | TS presented for information and approval | 1.0.0 | +| 2022-06 | CT#96 | CP-221081 | | | | TS approved at CT#96 | 17.0.0 | +| 2022-09 | CT#97e | CP-222031 | 0003 | | F | Corrections to MBS Distribution Session parameters | 17.1.0 | +| 2022-09 | CT#97e | CP-222031 | 0004 | | F | Updates to Operating Mode Descriptions | 17.1.0 | +| 2022-09 | CT#97e | CP-222031 | 0005 | | F | Editor's Note on Security Requirements | 17.1.0 | +| 2022-09 | CT#97e | CP-222031 | 0006 | 1 | F | Description of notification events in Nmbstf_DistSession | 17.1.0 | +| 2022-09 | CT#97e | CP-222031 | 0007 | | F | Clarification on the use of afEgressTunAddr | 17.1.0 | +| 2022-09 | CT#97e | CP-222031 | 0008 | | F | Align terminology of operating mode PACKET_PROXY and PACKET_FORWARD ONLY | 17.1.0 | +| 2022-09 | CT#97e | CP-222031 | 0009 | | D | Editorial errors for the headings | 17.1.0 | +| 2022-09 | CT#97e | CP-222031 | 0010 | | F | Corrections for the StatusSubscribe service operation | 17.1.0 | +| 2022-09 | CT#97e | CP-222031 | 0011 | | F | Corrections for the Nmbstf_DistSession API | 17.1.0 | +| 2022-09 | CT#97e | CP-222031 | 0012 | 1 | F | Clarification for the attributes in the data type distSession | 17.1.0 | +| 2022-09 | CT#97e | CP-222031 | 0013 | 1 | F | Miscellaneous updates and corrections to the data model of the Nmbstf_DistSession API | 17.1.0 | +| 2022-09 | CT#97e | CP-222058 | 0014 | | F | 29.581 Rel-17 API version and External doc update | 17.1.0 | +| 2022-12 | CT#98 | CP-223036 | 0017 | | F | Clarification on Object Distribution Method | 17.2.0 | +| 2022-12 | CT#98 | CP-223036 | 0018 | | F | Miscellaneous corrections | 17.2.0 | +| 2022-12 | CT#98 | CP-223097 | 0015 | 2 | F | Add mbmsGwTunAddr attribute in DistSession data type | 17.2.0 | +| 2022-12 | CT#98 | CP-223036 | 0016 | 1 | F | Corrections on data type of the user plane traffic flow information | 17.2.0 | +| 2022-12 | CT#98 | CP-223066 | 0020 | | F | 29.581 Rel-17 API version and External doc update | 17.2.0 | +| 2023-03 | CT#99 | CP-230077 | 0021 | | F | Correct datatype and add event to DistSessionEvent | 17.3.0 | +| 2023-03 | CT#99 | CP-230077 | 0023 | | F | Datatype ObjDistributionData correction | 17.3.0 | +| 2023-03 | CT#99 | CP-230077 | 0025 | 1 | F | Essential corrections to the MBSTF APIs | 17.3.0 | +| 2023-03 | CT#99 | CP-230089 | 0027 | | F | 29.581 Rel-17 API version and External doc update | 17.3.0 | +| 2023-03 | CT#99 | CP-230036 | 0022 | 1 | B | Support of group message delivery | 18.0.0 | +| 2023-06 | CT#100 | CP-231027 | 0024 | 4 | F | Location header and missing Redirection clause | 18.1.0 | +| 2023-06 | CT#100 | CP-231038 | 0029 | 1 | A | Remove objRepairBaseUrl from OpenAPI | 18.1.0 | +| 2023-06 | CT#100 | CP-231070 | 0032 | | F | 29.581 Rel-18 API version and External doc update | 18.1.0 | +| 2023-09 | CT#101 | CP-232064 | 0037 | 1 | F | Correct the object acquisition identifier | 18.2.0 | +| 2023-12 | CT#102 | CP-233056 | 0041 | 1 | F | Additional Notification Events | 18.3.0 | +| 2023-12 | CT#102 | CP-233027 | 0044 | | F | HTTP RFCs obsoleted by IETF RFC 9113/9110 | 18.3.0 | +| 2023-12 | CT#102 | CP-233063 | 0043 | | F | Remove security key exchange between MBSF and MBSTF | 18.3.0 | +| 2023-12 | CT#102 | CP-233060 | 0045 | | F | 29.581 Rel-18 API version and External doc update | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29594/raw.md b/raw/rel-18/29_series/29594/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..50a8df3d3020365ffae398e403ad120194f8aaf5 --- /dev/null +++ b/raw/rel-18/29_series/29594/raw.md @@ -0,0 +1,1744 @@ + + +# 3GPP TS 29.594 V18.3.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Spending Limit Control Service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in small letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- Keywords --- + +## **3GPP** + +## --- Postal address --- + +## 3GPP support office address --- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- Internet --- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Nchf_SpendingLimitControl Service ..... | 9 | +| 4.1 Service Description ..... | 9 | +| 4.1.1 Overview ..... | 9 | +| 4.1.2 Service Architecture ..... | 9 | +| 4.1.3 Network Functions ..... | 10 | +| 4.1.3.1 Charging Function (CHF)..... | 10 | +| 4.1.3.2 NF Service Consumers ..... | 10 | +| 4.2 Service Operations ..... | 10 | +| 4.2.1 Introduction ..... | 10 | +| 4.2.2 Nchf_SpendingLimitControl_Subscribe service operation..... | 10 | +| 4.2.2.1 General..... | 10 | +| 4.2.2.2 Initial spending limit retrieval..... | 11 | +| 4.2.2.3 Intermediate spending limit report retrieval ..... | 12 | +| 4.2.3 Nchf_SpendingLimitControl_Unsubscribe service operation ..... | 14 | +| 4.2.3.1 General..... | 14 | +| 4.2.3.2 Unsubscribe from spending limit reporting ..... | 14 | +| 4.2.4 Nchf_SpendingLimitControl_Notify service operation..... | 15 | +| 4.2.4.1 General..... | 15 | +| 4.2.4.2 Spending limit report ..... | 15 | +| 4.2.4.3 Subscription termination request by CHF ..... | 17 | +| 5 Nchf_SpendingLimitControl Service API..... | 18 | +| 5.1 Introduction ..... | 18 | +| 5.2 Usage of HTTP..... | 18 | +| 5.2.1 General ..... | 18 | +| 5.2.2 HTTP standard headers ..... | 18 | +| 5.2.2.1 General..... | 18 | +| 5.2.2.2 Content type..... | 18 | +| 5.2.3 HTTP custom headers ..... | 19 | +| 5.2.3.1 General..... | 19 | +| 5.3 Resources ..... | 19 | +| 5.3.1 Resource Structure..... | 19 | +| 5.3.2 Resource: Spending Limit Retrieval Subscriptions (Collection) ..... | 19 | +| 5.3.2.1 Description..... | 19 | +| 5.3.2.2 Resource definition..... | 19 | +| 5.3.2.3 Resource Standard Methods ..... | 20 | +| 5.3.2.3.1 POST ..... | 20 | +| 5.3.2.4 Resource Custom Operations..... | 20 | +| 5.3.3 Resource: Individual Spending Limit Retrieval Subscription (Document)..... | 20 | +| 5.3.3.1 Description..... | 20 | +| 5.3.3.2 Resource definition..... | 21 | +| 5.3.3.3 Resource Standard Methods ..... | 21 | +| 5.3.3.3.1 PUT ..... | 21 | +| 5.3.3.3.2 DELETE..... | 22 | +| 5.4 Custom Operations without associated resources ..... | 23 | +| 5.5 Notifications ..... | 23 | +| 5.5.1 General ..... | 23 | +| 5.5.2 Spending limit notification ..... | 24 | +| 5.5.2.1 Description..... | 24 | + +| | | | +|-----------------------------|--------------------------------------------------------------|-----------| +| 5.5.2.2 | Target URI ..... | 24 | +| 5.5.2.3 | Standard Methods ..... | 24 | +| 5.5.2.3.1 | POST ..... | 24 | +| 5.5.3 | Subscription Termination ..... | 25 | +| 5.5.3.1 | Description..... | 25 | +| 5.5.3.2 | Target URI ..... | 25 | +| 5.5.3.3 | Standard Methods ..... | 26 | +| 5.5.3.3.1 | POST ..... | 26 | +| 5.6 | Data Model..... | 27 | +| 5.6.1 | General ..... | 27 | +| 5.6.2 | Structured data types ..... | 27 | +| 5.6.2.1 | Introduction..... | 27 | +| 5.6.2.2 | Type SpendingLimitContext..... | 28 | +| 5.6.2.3 | Type SpendingLimitStatus ..... | 29 | +| 5.6.2.4 | Type PolicyCounterInfo ..... | 30 | +| 5.6.2.5 | Type PendingPolicyCounterStatus ..... | 30 | +| 5.6.2.6 | Type SubscriptionTerminationInfo..... | 30 | +| 5.6.3 | Simple data types and enumerations ..... | 31 | +| 5.6.3.1 | Introduction..... | 31 | +| 5.6.3.2 | Simple data types..... | 31 | +| 5.6.3.3 | Enumeration: TerminationCause ..... | 31 | +| 5.7 | Error handling ..... | 31 | +| 5.7.1 | General ..... | 31 | +| 5.7.2 | Protocol Errors..... | 31 | +| 5.7.3 | Application Errors ..... | 31 | +| 5.8 | Feature negotiation..... | 32 | +| 5.9 | Security..... | 32 | +| Annex A (normative): | OpenAPI specification ..... | 33 | +| A.1 | General..... | 33 | +| A.2 | Nchf_SpendingLimitControl Service API..... | 33 | +| Annex B (normative): | 5GC and EPC interworking scenario support ..... | 38 | +| B.1 | Scope..... | 38 | +| B.2 | Nchf_SpendingLimitControl Service ..... | 38 | +| B.2.1 | Service Description ..... | 38 | +| B.2.1.1 | Overview ..... | 38 | +| B.2.1.2 | Service Architecture ..... | 38 | +| B.3 | Service Operation..... | 38 | +| B.3.1 | Introduction ..... | 38 | +| B.3.2 | Nchf_SpendingLimitControl_Subscribe Service Operation ..... | 38 | +| B.3.3 | Nchf_SpendingLimitControl_Unsubscribe Service Operation..... | 39 | +| B.3.4 | Nchf_SpendingLimitControl_Notify Service Operation ..... | 39 | +| Annex C (normative): | Wireless and wireline convergence access support..... | 39 | +| C.1 | Scope..... | 39 | +| C.2 | Nchf_SpendingLimitControl Service ..... | 39 | +| C.2.1 | Service Description ..... | 39 | +| C.2.1.1 | Overview ..... | 39 | +| C.2.1.2 | Service Architecture ..... | 39 | +| C.3 | Service Operation..... | 39 | +| C.3.1 | Introduction ..... | 39 | +| C.3.2 | Nchf_SpendingLimitControl_Subscribe Service Operation ..... | 39 | +| C.3.2.1 | General ..... | 39 | +| C.3.3 | Nchf_SpendingLimitControl_Unsubscribe Service Operation..... | 40 | +| C.3.4 | Nchf_SpendingLimitControl_Notify Service Operation ..... | 40 | + +**Annex D (informative): Change history..... 41** + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present specification provides the stage 3 definition of the Spending Limit Control Service of the 5G System. + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The stage 2 definition and related procedures for the Spending Limit Control Service are specified in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [6]. + +The 5G System stage 3 call flows are provided in 3GPP TS 29.513 [12]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +The Spending Limit Control Service is provided by the Charging Function (CHF) and enables the NF service consumer to retrieve policy counter status information. The internal CHF functionality for policy counter management provisioning is specified in 3GPP TS 32.240 [7]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [7] 3GPP TS 32.240: "Charging architecture and principles; Stage 2". +- [8] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [9] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [10] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [11] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces". +- [12] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [15] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [16] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". + +- [17] 3GPP TR 21.900: "Technical Specification Group working methods". +- [18] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [19] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Nchf:** Service-based interface exhibited by Charging Function. + +**Policy counter:** A mechanism within the CHF to track spending applicable to a subscriber. + +**Policy counter identifier:** A reference to a policy counter in the CHF for a subscriber. + +**Policy counter status:** A label whose values are not standardized and that is associated with a policy counter's value relative to the spending limit(s) (the number of possible policy counter status values for a policy counter is one greater than the number of thresholds associated with that policy counter, i.e. policy counter status values describe the status around the thresholds). This is used to convey information relating to subscriber spending from CHF to PCF. Specific labels are configured jointly in CHF and PCF. + +**Spending limit:** A spending limit is the usage limit of a policy counter (e.g. monetary, volume, duration) that a subscriber is allowed to consume. + +**Spending limit report:** A notification, containing the current policy counter status generated from the CHF to the PCF. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|----------------------------------------| +| 5G-RG | 5G Residential Gateway | +| CCS | Converged Charging System | +| CHF | Charging Function | +| CTS | Charging Trigger Function | +| FN-RG | Fixed Network Residential Gateway | +| GCI | Global Cable Identifier | +| GLI | Global Line Identifier | +| GPSI | Generic Public Subscription Identifier | +| NF | Network Function | +| NRF | Network Repository Function | +| PCF | Policy Control Function | +| SUPI | Subscription Permanent Identifier | +| W-AGF | Wireline Access Gateway Function | + +# 4 Nchf\_SpendingLimitControl Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The Nchf\_SpendingLimitControl service, as defined in 3GPP TS23.502 [3] and 3GPP TS23.503 [6], is provided by the Charging Function (CHF). + +The Nchf\_SpendingLimitControl service enables the NF service consumer (e.g. PCF) to retrieve policy counter status information and spending limit reporting per UE from the CHF. + +If the spending limit reporting is no more required, the Nchf\_SpendingLimitControl service enables the NF service consumer to unsubscribe from the reporting. + +Nchf\_SpendingLimitControl Service applies to the cases where the PCF interacts with the CHF in the non-roaming scenario, and for roaming scenario the H-PCF for the PDU session interacts with the H-CHF in the home-routed scenario. Roaming scenarios are not supported for the PCF for the UE in this release of the specification. + +### 4.1.2 Service Architecture + +The Nchf\_SpendingLimitControl service is provided by the CHF and consumed by the NF service consumer (e.g. PCF), as shown in figure 4.1.2-1 for the SBI representation model and in figure 4.1.2-2 for the reference point representation model. + +![Figure 4.1.2-1: Nchf_SpendingLimitControl service architecture, SBI representation. The diagram shows a CHF (Charging Function) box containing an oval labeled 'Nchf'. A vertical line labeled 'Nchf_SpendingLimitControl' connects the 'Nchf' oval to a PCF (Policy Control Function) box below it.](2ba086df3506f81bae3a9b53725dcfea_img.jpg) + +``` +graph TD; subgraph CHF; Nchf((Nchf)); end; Nchf -- Nchf_SpendingLimitControl --> PCF[PCF]; +``` + +Figure 4.1.2-1: Nchf\_SpendingLimitControl service architecture, SBI representation. The diagram shows a CHF (Charging Function) box containing an oval labeled 'Nchf'. A vertical line labeled 'Nchf\_SpendingLimitControl' connects the 'Nchf' oval to a PCF (Policy Control Function) box below it. + +Figure 4.1.2-1: Nchf\_SpendingLimitControl service architecture, SBI representation + +![Figure 4.1.2-2: Nchf_SpendingLimitControl service architecture, reference point representation. The diagram shows a CHF (Charging Function) box connected by a vertical line labeled 'N28' to a PCF (Policy Control Function) box below it.](5a24ac755b962fd5f0183f13de0726de_img.jpg) + +``` +graph TD; CHF[CHF] -- N28 --> PCF[PCF]; +``` + +Figure 4.1.2-2: Nchf\_SpendingLimitControl service architecture, reference point representation. The diagram shows a CHF (Charging Function) box connected by a vertical line labeled 'N28' to a PCF (Policy Control Function) box below it. + +Figure 4.1.2-2: Nchf\_SpendingLimitControl service architecture, reference point representation + +### 4.1.3 Network Functions + +#### 4.1.3.1 Charging Function (CHF) + +The Charging Function (CHF) is part of the Converged Charging System (CCS). The CHF provides the Nchf\_SpendingLimitControl service and is specified in 3GPP TS 32.240 [7]. + +#### 4.1.3.2 NF Service Consumers + +The PCF is the known NF service consumer, as defined in 3GPP TS 23.502 [3]. The NF service consumer accesses policy counter status information relating to the subscriber spending from the CHF and uses the status of each relevant policy counter as input to its policy decision as required by the decision logic. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +The service operations defined for the Nchf\_SpendingLimitControl service are shown in table 4.2.1-1. + +**Table 4.2.1-1: Nchf\_SpendingLimitControl Service Operations** + +| Service operation name | Description | Initiated by | +|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Nchf_SpendingLimitControl_Subscribe | This service operation is used by NF service consumers to subscribe to notification of changes in the status of the policy counters available and retrieval of the status of the policy counters for which subscription is accepted. | NF service consumer (e.g. PCF) | +| Nchf_SpendingLimitControl_Unsubscribe | This service operation is used by NF service consumers to unsubscribe from notification of changes in the status of all policy counters. | NF service consumer (e.g. PCF) | +| Nchf_SpendingLimitControl_Notify | This service operation is used by the CHF to notify the NF service consumers about the change of the status of the subscribed policy counters. Alternatively, it can be used by the CHF to notify that the status for one or multiple subscribed policy counter will change in the future, indicating the time when this change shall be applied. Alternatively, it is also used to notify the NF service consumer of the removal of a subscriber from the CHF system for the purpose that the NF service consumer can terminate the subscriptions of all policy counters of the subscriber. | CHF | + +### 4.2.2 Nchf\_SpendingLimitControl\_Subscribe service operation + +#### 4.2.2.1 General + +The Nchf\_SpendingLimitControl\_Subscribe service operation is used by the NF service consumer to subscribe to notification of changes in the status of the policy counters available and to retrieve the status of the policy counters for which the subscription is accepted. The following procedures are related to the subscribe service operation: + +- initial spending limit retrieval; and +- intermediate spending limit report retrieval. + +#### 4.2.2.2 Initial spending limit retrieval + +Figure 4.2.2.2-1 shows the scenario where the NF service consumer sends a request to the CHF to retrieve the status of policy counters available at the CHF and to subscribe to spending limit reporting (see also 3GPP TS 23.502 [3], figure 4.16.8.2.1). + +![Sequence diagram showing the interaction between an NF service consumer and a CHF. The NF service consumer sends a POST request to the CHF, and the CHF responds with a 201 Created status.](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant CHF + Note left of NF service consumer: + NF service consumer->>CHF: 1. POST.../subscriptions + CHF-->>NF service consumer: 2. 201 Created + +``` + +Sequence diagram showing the interaction between an NF service consumer and a CHF. The NF service consumer sends a POST request to the CHF, and the CHF responds with a 201 Created status. + +**Figure 4.2.2.2-1: NF service consumer subscribes to retrieve policy counter status and spending limit reporting** + +The NF service consumer shall send an HTTP POST request to the resource "{apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions" representing the "Spending Limit Retrieval Subscriptions", as shown in figure 4.2.2.2-1, step 1, to create a subscription for retrieval of the policy counter status and spending limit reporting. + +The "SpendingLimitContext" data structure provided in the request body shall include: + +- the Subscription Permanent Identifier (SUPI) encoded in the "supi" attribute; +- the notification correlation target address encoded in the "notifUri" attribute; and +- If the feature "NotificationCorrelation" is supported, a Notification Correlation Identifier assigned by the NF service consumer for the requested notifications encoded in the "notifId" attribute, if the "notifUri" does not encode within the provided URI the notification correlation Id. + +NOTE: NF service consumer (e.g. PCF) ensures the combination of notifUri and notifId is unique per subscription in the whole network, including multiple network slices scenario. + +The "SpendingLimitContext" data structure provided in the request body may include: + +- the General Public Subscription Identifier (GPSI) encoded in the "gpsi" attribute; +- Event Filter information "list of policy counter identifier(s)" encoded in the "policyCounterIds" attribute. The "policyCounterIds" attribute shall contain the list of policy counter identifiers to be subscribed to. If the "policyCounterIds" attribute is omitted, the subscription is to all available policy counters; and +- when the feature "SubscriptionExpirationTimeControl" is supported by the NF service consumer, the NF service consumer may include an expiry time encoded in the "expiry" attribute, representing the time up to which the subscription is desired to be kept active. When the "expiry" attribute is omitted in the request, it represents the NF service consumer does not have any time constraint in the duration of the subscription. + +If the CHF cannot successfully fulfil the received HTTP POST request due to an internal CHF error or due to the error in the HTTP POST request, the CHF shall send the HTTP error response as specified in clause 5.7. + +If the subscriber specified in the request is unknown to the CHF, the CHF shall indicate in an HTTP "400 Bad Request" response the cause for the rejection with the "cause" attribute set to "USER\_UNKNOWN". + +If the CHF has no available policy counters specified for the subscriber, the CHF shall indicate in an HTTP "400 Bad Request" response the cause for the rejection with the "cause" attribute set to "NO\_AVAILABLE\_POLICY\_COUNTERS". + +If one or more policy counters specified in the request in the "policyCounterIds" attribute are unknown to the CHF, and the CHF is configured to reject request, the CHF shall indicate in an HTTP "400 Bad Request" response the cause for + +the rejection with the "cause" attribute set to "UNKNOWN\_POLICY\_COUNTERS" and the unknown policy counter identifiers within the "invalidParams" attribute. + +Otherwise, upon the reception of an HTTP POST request the CHF shall: + +- create a new subscription resource, which contains the list of the policy counters included in the "policyCounterIds" attribute, or if the "policyCounterIds" attribute is omitted, all the policy counters of the subscriber; +- assign a subscriptionId; and +- store the subscription resource. + +After the CHF created an "Individual Spending Limit Retrieval Subscription" resource, the CHF shall respond with "201 Created" response with a Location header field containing the URI of the created subscription resource and the message body containing a representation of the created subscription, as shown in figure 4.2.2.2-1, step 2. + +The SpendingLimitStatus data structure provided in the response body shall include the status of the requested subscribed policy counters in the "statusInfos" map, where every PolicyCounterInfo entry shall contain: + +- the policy counter identifier in the "policyCounterId" attribute; and +- the policy counter status in the "currentStatus" attribute. + +When a requested policy counter identifier is known by the CHF, but it is not applicable to the subscriber (e.g. not provisioned), the CHF may include it in the "statusInfos" map, and set the "currentStatus" attribute to an operator configured policy counter status to indicate this to the NF service consumer. + +When one or more policy counters specified in the request in the "policyCounterIds" attribute are unknown to the CHF, and the CHF is configured to accept the request, the CHF may include the unknown policy counters in the "statusInfos" map, and set the "currentStatus" attribute to an operator configured policy counter status to indicate this to the NF service consumer. + +A PolicyCounterInfo data structure may include the list of the pending policy counter statuses and their activation times within the attribute "penPolCounterStatuses". + +When the feature "SubscriptionExpirationTimeControl" is supported, the CHF may include the "expiry" attribute, representing the time up to which the subscription shall be kept active. If an expiry time was included in the subscription request, then the expiry time shall be returned in the response, and the value shall be less than or equal to the requested value. When the "expiry" attribute is omitted in the request and in the response, it represents neither the CHF nor the NF service consumer have time constrains in the duration of the subscription and shall be kept active till the explicit subscription termination as described in clause 4.2.3.2 and clause 4.2.4.3. + +NOTE 1: If the NF Service Consumer does not include an expiry time in the request, the CHF can include an expiry time in the response that represents the time after which the subscription becomes invalid. + +NOTE 2: Once the subscription expires, if the NF service consumer wants to keep receiving notifications, it needs to create a new subscription in the CHF, as specified in this clause. + +#### 4.2.2.3 Intermediate spending limit report retrieval + +Figure 4.2.2.3-1 shows the scenario where the NF service consumer sends a request to the CHF to modify the existing subscription to the retrieval of spending limit reports (see also 3GPP TS 23.502 [3], figure 4.16.8.3.1). The NF service consumer can add or remove policy counters to retrieve the status of the counters. + +![Sequence diagram showing the interaction between an NF service consumer and a CHF. The consumer sends a PUT request to the CHF, and the CHF responds with a 200 OK.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant CHF + Note right of NF service consumer: 1. PUT.../subscriptions/{subscriptionId} + NF service consumer->>CHF: Request + Note left of CHF: 2. 200 OK + CHF-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and a CHF. The consumer sends a PUT request to the CHF, and the CHF responds with a 200 OK. + +**Figure 4.2.2.3-1: NF service consumer modifies the subscription to retrieve policy counter status and spending limit reporting** + +The NF service consumer shall send an HTTP PUT request to the resource "{apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId}" representing an existing "Individual Spending Limit Subscription" resource, as shown in figure 4.2.2.3-1, step 1, to modify the subscription for retrieval of the policy counter status and spending limit reporting. + +The "SpendingLimitContext" data structure provided in the request body: + +- shall include the Subscription Permanent Identifier (SUPI) encoded in the "supi" attribute; +- shall include the notification correlation target address encoded in the "notifUri" attribute; +- if the feature "NotificationCorrelation" is supported, a Notification Correlation Identifier assigned by the NF service consumer for the requested notifications encoded in the "notifId" attribute, if the "notifUri" does not encode within the provided URI the notification correlation Id. + +NOTE 1: If the notification correlation target address is not changed the previously provided notification correlation target address is included in the "notifUri" attribute. If the Notification Correlation Id is not changed the previously provided Notification Correlation Id is included in the "notifId" attribute. + +- if the General Public Subscription Identifier (GPSI) was provided within the initial spending limit retrieval procedure, described in clause 4.2.2.2, shall include the GPSI encoded in the "gpsi" attribute; and +- may include Event Filter information as a "list of policy counter identifier(s)" encoded in the "policyCounterIds" attribute. The "policyCounterIds" attribute shall contain the updated list of policy counter identifiers to be subscribed to. If the "policyCounterIds" attribute is omitted, the subscription is updated to all available policy counters; and +- when the feature "SubscriptionExpirationTimeControl" is supported, may include an updated expiry time encoded in the "expiry" attribute to update the duration of the subscription, representing the updated time up to which the subscription is desired to be kept active. When the "expiry" attribute is omitted in the request, it represents the NF service consumer update does not have any time constraint from this moment on in the duration of the subscription. + +NOTE 2: The "notifUri" attribute within the SpendingLimitContext data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +When the "policyCounterIds" attribute is present in the subscription request, this list of policy counters overrides a previously provisioned list. + +After the CHF modified an "Individual Spending Limit Retrieval Subscription" resource, the CHF shall respond with "200 OK" response with the message body containing a representation of the modified subscription, as shown in figure 4.2.2.3-1, step 2. + +The SpendingLimitStatus data structure provided in the response body, when the feature "SubscriptionExpirationTimeControl" is not supported, shall include the status of the requested subscribed policy counters in the "statusInfos" map, where every PolicyCounterInfo entry shall contain: + +- the policy counter identifier in the "policyCounterId" attribute; and + +- the policy counter status in the "currentStatus" attribute. + +When a requested policy counter identifier is known by the CHF, but it is not applicable to the subscriber (e.g. not provisioned), the CHF may include it in the "statusInfos" map, and set the "currentStatus" attribute to an operator configured policy counter status to indicate this to the NF service consumer. + +When one or more policy counters specified in the request in the "policyCounterIds" attribute are unknown to the CHF, and the CHF is configured to accept the request, the CHF may include the unknown policy counters in the "statusInfos" map, and set the "currentStatus" attribute to an operator configured policy counter status to indicate this to the NF service consumer. + +A PolicyCounterInfo data structure may include the list of the pending policy counter statuses and their activation times within the attribute "penPolCounterStatuses". + +When the feature "SubscriptionExpirationTimeControl" is supported, the CHF may include the "expiry" attribute, representing the time up to which the subscription shall be kept active. If an expiry time was included in the subscription update request, then the expiry time shall be returned in the response, and the value returned should be less than or equal to the value in the request. When the "expiry" attribute is omitted in the request and in the response, it represents that the subscription shall be considered valid without an expiry time. + +NOTE 3: When the NF service consumer does not include an expiry time in the request, the CHF can include an expiry time in the response that represents an update of the previously provided duration of the subscription. + +NOTE 4: Once the subscription expires, if the NF service consumer wants to keep receiving notifications, it needs to create a new subscription in the CHF, as specified in clause 4.2.2.2. + +If errors occur when processing the HTTP PUT request, the CHF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the CHF determines the received HTTP PUT request needs to be redirected, the CHF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +If the CHF has no available policy counters specified for the subscriber, the CHF shall indicate in an HTTP "400 Bad Request" response the cause for the rejection with the "cause" attribute set to "NO\_AVAILABLE\_POLICY\_COUNTERS". + +If one or more policy counters specified in the PUT request in the "policyCounterIds" attribute are unknown to the CHF, and the CHF is configured to reject request, the CHF shall indicate in an HTTP "400 Bad Request" response the cause for the rejection with the "cause" attribute set to "UNKNOWN\_POLICY\_COUNTERS" and the unknown policy counter identifiers within the "invalidParams" attribute. The PUT request shall not take effect, and the CHF shall maintain the Individual Spending Limit Retrieval resource. + +NOTE 5: In order to avoid misbehaviors due to the policy counters status maintained in the CHF and the NF service consumer, the NF service consumer can terminate the subscription invoking the Nchf\_SpendingLimitControl\_Unsubscribe service operation in clause 4.2.3.2. + +NOTE 6: The NF service consumer can terminate the subscription invoking the Nchf\_SpendingLimitControl\_Unsubscribe service operation in clause 4.2.3.2, or maintain subscription assuming that further available policy counters will be notified. + +### 4.2.3 Nchf\_SpendingLimitControl\_Unsubscribe service operation + +#### 4.2.3.1 General + +The Nchf\_SpendingLimitControl\_Unsubscribe service operation is used by the NF service consumer to cancel the subscription of status changes for all the policy counters available at the CHF. That means the complete cancellation of the spending limit reporting procedure. + +#### 4.2.3.2 Unsubscribe from spending limit reporting + +Figure 4.2.3.2-1 shows the scenario where the NF service consumer sends a request to the CHF to unsubscribe from spending limit reporting (see also 3GPP TS 23.502 [3] figure 4.16.8.4.1). + +![Sequence diagram showing the NF service consumer unsubscribing from spending limit reporting. The NF service consumer sends a DELETE request to the CHF, and the CHF responds with a 204 No Content.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant CHF + Note left of NF service consumer: 1. DELETE.../subscriptions/{subscriptionId} + NF service consumer->>CHF: 1. DELETE.../subscriptions/{subscriptionId} + Note right of CHF: 2. 204 No Content + CHF-->>NF service consumer: 2. 204 No Content +``` + +Sequence diagram showing the NF service consumer unsubscribing from spending limit reporting. The NF service consumer sends a DELETE request to the CHF, and the CHF responds with a 204 No Content. + +**Figure 4.2.3.2-1: NF service consumer unsubscribes from spending limit reporting** + +The NF service consumer shall invoke the Nchf\_SpendingLimitControl\_Unsubscribe service operation to unsubscribe from the spending limit reporting (status change for all policy counters available is no more required). The NF service consumer shall send an HTTP DELETE request to the resource "{apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId}", whereby the "{subscriptionId}" is the identification of the existing subscription to be deleted. Upon the reception of an HTTP DELETE request the CHF removes the corresponding subscription. + +If the HTTP DELETE request is accepted by the CHF, it shall respond with "204 No Content" as shown in figure 4.2.3.2-1, step 2. + +If the HTTP DELETE request is not accepted by the CHF (e.g. the HTTP DELETE request is for a non-existent subscription), it shall indicate the appropriate cause for the rejection in the HTTP response code or, if the feature "ES3XX" is supported, an HTTP redirect response to the NF service consumer. + +### 4.2.4 Nchf\_SpendingLimitControl\_Notify service operation + +#### 4.2.4.1 General + +The Nchf\_SpendingLimitControl\_Notify service operation is used by the CHF: + +- to notify the change of the status of the subscribed policy counters available at the CHF for that subscriber; and/or +- to provide one or more pending statuses for a subscribed policy counter together with the time they shall be applied; and/or +- to request the termination of the subscription of status changes for all policy counters for a subscriber (e.g. the subscriber is removed from the CHF system). + +#### 4.2.4.2 Spending limit report + +Figure 4.2.4.2-1 shows the scenario where the CHF sends a notification to the NF service consumer, when it detects that the status of a policy counter(s) has changed and the NF service consumer has subscribed to notifications of changes in the status of this policy counter(s). The CHF can also notify the NF service consumer that the status for one or multiple subscribed policy counter will change and indicate this by providing the time when this change shall be applied (see also 3GPP TS 23.502 [3], figure 4.16.8.5.1). + +![Sequence diagram showing Spending limit reporting. The NF service consumer and CHF exchange two messages: 1. POST.../{notifUri}/notify from CHF to NF service consumer, and 2. 204 No Content from NF service consumer to CHF.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant CHF + participant NF as NF service consumer + Note right of CHF: 1. POST.../{notifUri}/notify + CHF->>NF: 1. POST.../{notifUri}/notify + Note left of NF: 2. 204 No Content + NF-->>CHF: 2. 204 No Content + +``` + +Sequence diagram showing Spending limit reporting. The NF service consumer and CHF exchange two messages: 1. POST.../{notifUri}/notify from CHF to NF service consumer, and 2. 204 No Content from NF service consumer to CHF. + +**Figure 4.2.4.2-1: Spending limit reporting** + +The CHF shall send an HTTP POST request to the resource notification target address (notifUri) of the NF service consumer received in the subscription creation or modification, and shall append the "notify" segment path at the end of the URI, to indicate the NF service consumer the notification of a policy counter status change. + +The SpendingLimitStatus data structure provided in the request body: + +- shall include the Subscriber Identity in the "supi" attribute; +- shall include, if the feature "NotificationCorrelation" is supported, the notification correlation ID in the "notifId" attribute if received in the SpendingLimitContext data structure provided in the creation or update of the subscription; +- shall include, when the feature "SubscriptionExpirationTimeControl" is not supported, Policy counters status in the "statusInfos" map, where every PolicyCounterInfo entry shall include: + - a. the "policyCounterId" attribute with the policy counter identifier; and + - b. the "currentStatus" attribute with the new policy counter status when the notification is triggered by a change in the policy counter status, or the current policy counter status when the notification is triggered by a change in the pending policy counter status(es); and +- may include, when the feature "SubscriptionExpirationTimeControl" is supported, the Policy counters status in the "statusInfos" map if at this time there is change of policy counter status and/or the update of the expiry time in the "expiry". + +NOTE 1: When the feature "SubscriptionExpirationTimeControl" is supported, and the CHF includes the update of the expiry time, if at this time there is no change of policy counter status, the CHF does not include the "statusInfos" attribute. + +When a policy counter identifier is no longer applicable to the subscriber (e.g. becomes not provisioned), but still exists in the Individual Spending Control Retrieval resource, the CHF may include it in the "statusInfos" map, and set the "currentStatus" attribute to an operator configured policy counter status to indicate this to the NF service consumer. + +A PolicyCounterInfo data structure may include the list of pending policy counter statuses and their activation times within the attribute "penPolCounterStatuses". + +When the feature "SubscriptionExpirationTimeControl" is supported, the CHF may include the "expiry" attribute, representing an update in the time up to which the subscription shall be kept active. When the "expiry" attribute is omitted, it represents that the previously agreed duration of the subscription remains valid. + +NOTE 2: Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it needs to create a new subscription in the CHF, as specified in clause 4.2.2.2. + +The CHF shall not send the policy counter status for the same policy counter until it received the response of the previous status report of the policy counter. + +If the HTTP POST notification request message is accepted by the NF service consumer, it shall acknowledge the receipt of the event notification with a "204 No Content" response, as shown in figure 4.2.4.2-1, step 2. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +If the NF service consumer receives an HTTP POST notification request message for an intermediate spending limit report transaction from the CHF in which no pending policy counter statuses and their activation times are included for a policy counter, i.e., the "penPolCounterStatuses" attribute is not included, the NF service consumer shall cancel all previously provided pending policy counter statuses and their activation times for this policy counter. If the NF service consumer receives an HTTP POST notification request message for an intermediate spending limit report transaction from the CHF containing pending policy counter statuses and their activation times for a previously provided policy counter, the NF service consumer shall replace the existing pending policy counter statuses and their activation times if any. + +If the NF service consumer receives an HTTP POST request for spending limit report initiated by the CHF while it has an ongoing intermediate spending limit report retrieval transaction with the CHF, the NF service consumer shall update the policy counter information based on the HTTP POST request for spending limit report. When the corresponding response for the ongoing intermediate spending limit report retrieval transaction is eventually received, the NF service consumer shall only update policy counter information for counters that were not provided in the previously received HTTP POST request for spending limit report. + +#### 4.2.4.3 Subscription termination request by CHF + +Figure 4.2.4.3-1 shows the scenario where the CHF sends a notification to the NF service consumer, when it requests the termination of the subscription of status changes for all policy counters for a subscriber. + +![Sequence diagram showing the subscription termination request by CHF. The NF service consumer sends a POST request to the CHF, and the CHF responds with a 204 No Content.](43837b056625d3d6ce615e4c02f163bb_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant CHF + Note left of NF service consumer: NF service consumer + Note right of CHF: CHF + CHF->>NF service consumer: 1. POST.../{notifUri}/terminate + NF service consumer-->>CHF: 2. 204 No Content +``` + +Sequence diagram showing the subscription termination request by CHF. The NF service consumer sends a POST request to the CHF, and the CHF responds with a 204 No Content. + +**Figure 4.2.4.3-1: Subscription termination request by CHF** + +The CHF shall send an HTTP POST request to the resource notification target address (notifUri) of the NF service consumer received in the subscription creation or modification and shall append the "terminate" segment path at the end of the URI, to indicate the subscription termination and the removal of the Individual Spending Limit Retrieval Subscription resource to the NF service consumer. + +The SubscriptionTerminationInfo data structure provided in the request body shall include the subscriber identification encoded in the "supi" attribute, if the feature "NotificationCorrelation" is supported, the Notification Correlation Id in the "notifId" attribute if received and may include subscription termination information in the "termCause" attribute. + +When the termination request is because the subscriber identified by the SUPI has been removed from the CHF, the CHF shall set the "termCause" attribute to "REMOVED\_SUBSCRIBER". + +If the HTTP POST notification request message is accepted by the NF service consumer, it shall remove the subscription to notifications of all policy counters for a subscriber and shall acknowledge the receipt of the event notification with a "204 No Content" response, as shown in figure 4.2.4.3-1, step 2. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +# 5 Nchf\_SpendingLimitControl Service API + +## 5.1 Introduction + +The Nchf\_SpendingLimitControl service shall use the Nchf\_SpendingLimitControl API. + +The API URI of the Nchf\_SpendingLimitControl API shall be: + +**{apiRoot}
** + +The request URIs used in HTTP requests from the NF service consumer towards the CHF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS29.501 [5]. +- The shall be "nchf-spendinglimitcontrol". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 7540 [8], shall be used as specified in clause 5.2 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [9] specification of HTTP messages and content bodies for the Nchf\_SpendingLimitControl service is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [10], shall be used as content type of the HTTP bodies specified in the present specification, as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +### 5.2.3 HTTP custom headers + +#### 5.2.3.1 General + +The Nchf\_SpendingLimitControl API shall support HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4]. + +In this Release of the specification, no specific custom headers are defined for the Nchf\_SpendingLimitControl API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.3.1-1 shows the resource URI structure of the Nchf\_SpendingLimitControl API. + +![Diagram showing the resource URI structure of the Nchf_SpendingLimitControl API. The root is {apiRoot}/nchf-spendinglimitcontrol/v1. It branches to /subscriptions, which further branches to/{subscriptionId}.](40f30e4d577a17052f8b1e6dc802a0d8_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nchf-spendinglimitcontrol/v1"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the resource URI structure of the Nchf\_SpendingLimitControl API. The root is {apiRoot}/nchf-spendinglimitcontrol/v1. It branches to /subscriptions, which further branches to/{subscriptionId}. + +**Figure 5.3.1-1: Resource URI structure of the Nchf\_SpendingLimitControl API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------------|---------------------------------|---------------------------------|----------------------------------------------------------------------------------| +| Spending Limit Retrieval Subscriptions | /subscriptions | POST | Creates a new individual spending limit retrieval subscription. | +| Individual Spending Limit Retrieval Subscription | /subscriptions/{subscriptionId} | PUT | Modifies an existing subscription (e.g. addition of additional policy counters). | +| | | DELETE | Deletes an individual subscription. | + +### 5.3.2 Resource: Spending Limit Retrieval Subscriptions (Collection) + +#### 5.3.2.1 Description + +This resource represents the collection of Nchf\_SpendingLimitControl service subscriptions at a given CHF. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|------------------------------------------------------------------------------------------------------| +| SpendingLimitContext | M | 1 | Contains the information for the creation of a new individual spending limit retrieval subscription. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|-----------------|--------------------------------------------------------------------------------------| +| SpendingLimitStatus | M | 1 | 201 Created | The spending limit subscription was created and spending limit reports are provided. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the POST method shall also apply. +NOTE 2: In addition to protocol and application errors which are specified in clause 5.2.7.2 of 3GPP TS 29.500 [4], specific errors are described in clause 5.7. + +**Table 5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId} | + +#### 5.3.2.4 Resource Custom Operations + +None. + +### 5.3.3 Resource: Individual Spending Limit Retrieval Subscription (Document) + +#### 5.3.3.1 Description + +This resource represents an individual Nchf\_SpendingLimitControl service subscription at a given CHF. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| subscriptionId | string | Identifies a subscription to the CHF spending limit control retrieval service. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-------------------------------------------------------------------------| +| SpendingLimitContext | M | 1 | Modifies the existing individual spending limit retrieval subscription. | + +**Table 5.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SpendingLimitStatus | M | 1 | 200 OK | Successful case: The individual spending limit subscription was modified and spending limit reports are provided. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Spending Limit Retrieval Subscription modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Spending Limit Retrieval Subscription modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the PUT method shall also apply. | | | | | +| NOTE 2: In addition to protocol and application errors which are specified in clause 5.2.7.2 of 3GPP TS 29.500 [4], specific errors are described in clause 5.7. | | | | | +| NOTE 3: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). | | | | | + +**Table 5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative CHF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target CHF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative CHF (service) instance instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target CHF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case: The individual spending limit subscription matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Spending Limit Retrieval Subscription deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Spending Limit Retrieval Subscription deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the DELETE method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative CHF (service) instance instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target CHF (service) instance towards which the request is redirected. | + +**Table 5.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative CHF (service) instance instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target CHF (service) instance towards which the request is redirected. | + +## 5.4 Custom Operations without associated resources + +None. + +## 5.5 Notifications + +### 5.5.1 General + +Notification shall comply with clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +Table 5.5.1-1: Notifications overview + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------|----------------------|---------------------------------|-----------------------------------------| +| Spending limit notification | {notifUri}/notify | notify (POST) | Counter Status changes notification. | +| Subscription Termination | {notifUri}/terminate | terminate (POST) | Indication of subscription termination. | + +### 5.5.2 Spending limit notification + +#### 5.5.2.1 Description + +The spending limit notification is used by the CHF to notify the change of the status of the subscribed policy counters for a subscriber and/or to provide one or more pending statuses for a subscribed policy counter together with the time they shall be applied. + +#### 5.5.2.2 Target URI + +The Callback URI {notifUri}/notify shall be used with the callback URI variables defined in table 5.5.2.2-1. + +Table 5.5.2.2-1: Callback URI variables + +| Name | Data type | Definition | +|----------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned by the NF service consumer during the subscription service operation and described within the SpendingLimitContext data type (see table 5.6.2.2-1). | + +#### 5.5.2.3 Standard Methods + +##### 5.5.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.2.3.1-1. + +Table 5.5.2.3.1-1: URI query parameters supported by the POST method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.2.3.1-2 and the response data structures and response codes specified in table 5.5.2.3.1-3. + +Table 5.5.2.3.1-2: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-------------------------------------------------------------| +| SpendingLimitStatus | M | 1 | Provides information about the statuses of policy counters. | + +Table 5.5.2.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Spending limit report.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Spending limit report.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the POST method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +Table 5.3.3.3.2-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +Table 5.3.3.3.2-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +### 5.5.3 Subscription Termination + +#### 5.5.3.1 Description + +The Subscription Termination request is used by the CHF to request the NF service consumer the termination of the subscription to policy counter status changes. + +#### 5.5.3.2 Target URI + +The Callback URI {notifUri}/terminate shall be used with the callback URI variables defined in table 5.5.3.2-1. + +**Table 5.5.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned by the NF service consumer during the subscription service operation and described within the SpendingLimitContext data type (see table 5.6.2.2-1). | + +#### 5.5.3.3 Standard Methods + +##### 5.5.3.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.3.3.1-1. + +**Table 5.5.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.3.3.1-2 and the response data structures and response codes specified in table 5.5.3.3.1-3. + +**Table 5.5.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|----------------------------------------------------------| +| SubscriptionTerminationInfo | M | 1 | Provides information about the deletion of the resource. | + +**Table 5.5.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription termination.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription termination.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [4] for the POST method shall also apply.
NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). | | | | | + +**Table 5.5.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +**Table 5.5.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Nchf\_SpendingLimitControl service based interface protocol. + +**Table 5.6.1-1: Nchf\_SpendingLimitControl specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-----------------------------|-----------------|-------------------------------------------------------------------------------------------------------|---------------| +| SpendingLimitContext | 5.6.2.2 | Describes the subscription data structure required for an individual CHF spending limit subscription. | | +| SpendingLimitStatus | 5.6.2.3 | Describes the data structure presenting the statuses of policy counters. | | +| PolicyCounterInfo | 5.6.2.4 | Describes the data structure presenting the policy counter status. | | +| PendingPolicyCounterStatus | 5.6.2.5 | Describes the data structure presenting the pending policy counter status. | | +| PolicyCounterId | 5.6.3.2 | Identifies a policy counter. | | +| SubscriptionTerminationInfo | 5.6.2.6 | Describes the data structure presenting the indication of the termination of the subscription. | | +| TerminationCause | 5.6.3.3 | Represents the types of causes for requesting the termination of the subscription. | | + +Table 5.6.1-2 specifies data types re-used by the Nchf\_SpendingLimitControl service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nchf\_SpendingLimitControl service based interface. + +**Table 5.6.1-2: Nchf\_SpendingLimitControl re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|--------------------------------------------------------------------------------------|---------------| +| DateTime | 3GPP TS 29.571 [11] | String with format "date-time" as defined in OpenAPI Specification [9]. | | +| Uri | 3GPP TS 29.571 [11] | | | +| Supi | 3GPP TS 29.571 [11] | | | +| Gpsi | 3GPP TS 29.571 [11] | | | +| RedirectResponse | 3GPP TS 29.571 [11] | Contains redirection related information. | ES3XX | +| SupportedFeatures | 3GPP TS 29.571 [11] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type SpendingLimitContext + +Table 5.6.2.2-1: Definition of type SpendingLimitContext + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| supi | Supi | C | 0..1 | The Subscription Permanent Identifier (Supi) shall be present within the initial spending limit retrieval procedure (creation of a new individual subscription) and intermediate spending limit retrieval procedure (modification of an existing subscription). | | +| gpsi | Gpsi | O | 0..1 | The Generic Public Subscription Identifier (Gpsi) shall contain either an External Id or an MSISDN. It may be present within the initial spending limit retrieval procedure (creation of a new individual subscription) and intermediate spending limit retrieval procedure (modification of an existing subscription). | | +| policyCounterIds | array(PolicyCounterId) | O | 1..N | This is a list of policy counter identifier(s), which identifies policy counters maintained per subscriber within the CHF. | | +| notifUri | Uri | C | 0..1 | This attribute identifies the recipient of spending limit notifications sent to the NF service consumer by the CHF. The notifUri shall be present within the initial spending limit retrieval procedure (creation of a new individual subscription) and within the intermediate spending limit retrieval procedure (modification of an existing subscription). | | +| notifId | string | C | 0..1 | Notification Correlation ID assigned by the NF service consumer. It shall be included if the NotificationCorrelation feature is supported, the notifUri does not encode the notification correlation Id, and the NF service consumers require multiple subscriptions for the same SUPI, e.g. UE accesses multiple network slices. | NotificationCorrelation | +| expiry | DateTime | O | 0..1 | The expiry time may be included in a subscription request. When present, this IE shall represent the longest duration time after which the subscription shall become invalid. | SubscriptionExpirationTimeControl | +| supportedFeatures | SupportedFeatures | C | 0..1 | The list of supported features as described in clause 5.8 shall be supplied by the NF | | + +| | | | | | | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | service consumer in the POST request that request the creation of a spending limit report resource and intermediate spending limit retrieval procedure (modification of an existing subscription). | | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +#### 5.6.2.3 Type SpendingLimitStatus + +**Table 5.6.2.3-1: Definition of type SpendingLimitStatus** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| supi | Supi | O | 0..1 | The Subscription Permanent Identifier (Supi) shall be present within the callback notify service operation (notification of the status of subscribed policy counters). | | +| notifId | string | C | 0..1 | Notification Correlation ID assigned by the NF service consumer. It shall be included if provided during the subscription within the SpendingLimitContext data type. | NotificationCorrelation | +| statusInfos | map(PolicyCounterInfo) | C | 1..N | Status of the requested policy counters. The key of the map is the attribute "policyCounterId". It may be omitted when the feature SubscriptionExpirationTimeControl is supported and the CHF only requires to update the "expiry" attribute. | | +| expiry | DateTime | C | 0..1 | This expiry time shall be included in a subscription response, if the expiry time was included in the request. It may be included in a subscription response and notification request based on operator policies for the control in the CHF of the subscription duration. | SubscriptionExpirationTimeControl | +| supportedFeatures | SupportedFeatures | C | 0..1 | If the supportedFeatures is included in the request by the NF service consumer, it shall be supplied in the reply of the corresponding request by the CHF. | | + +#### 5.6.2.4 Type PolicyCounterInfo + +**Table 5.6.2.4-1: Definition of type PolicyCounterInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| policyCounterId | PolicyCounterId | M | 1 | Identifies the requested policy counter. | | +| currentStatus | string | M | 1 | Identifies the policy counter status applicable for a specific policy counter identified by the policyCounterId. The values (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the defined values are out of scope of 3GPP. | | +| penPolCounterStatuses | array(PendingPolicyCounterStatus) | O | 1..N | Provides the pending policy counter status. | | + +#### 5.6.2.5 Type PendingPolicyCounterStatus + +**Table 5.6.2.5-1: Definition of type PendingPolicyCounterStatus** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| policyCounterStatus | string | M | 1 | Identifies the policy counter status applicable for a specific policy counter identified by the PolicyCounterId. The values (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the defined values are out of scope of 3GPP. | | +| activationTime | DateTime | M | 1 | Indicates the time at which the pending policy counter status becomes the current status of a policy counter. | | + +#### 5.6.2.6 Type SubscriptionTerminationInfo + +**Table 5.6.2.6-1: Definition of type SubscriptionTerminationInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| supi | Supi | M | 1 | Subscription Permanent Identifier. | | +| notifId | string | C | 0..1 | Notification Correlation ID assigned by the NF service consumer. It shall be included if provided during the subscription within the SpendingLimitContext data type. | NotificationCorrelation | +| termCause | TerminationCause | O | 0..1 | Indicates the cause for requesting the termination of the subscription to policy counter status changes. | | + +### 5.6.3 Simple data types and enumerations + +#### 5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------------|-----------------|------------------------------|---------------| +| PolicyCounterId | string | Identifies a policy counter. | | + +#### 5.6.3.3 Enumeration: TerminationCause + +The enumeration "TerminationCause" represents the types of causes the CHF can report when requesting the termination of the subscription. + +**Table 5.6.3.3-1: Enumeration TerminationCause** + +| Enumeration value | Description | Applicability | +|--------------------|----------------------------------------------------------------------|---------------| +| REMOVED_SUBSCRIBER | The subscriber identified by the SUPI has been removed from the CHF. | | + +## 5.7 Error handling + +### 5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +For the Nchf\_SpendingLimitControl service API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses shall apply. + +### 5.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nchf\_SpendingLimitControl service API. + +### 5.7.3 Application Errors + +The application errors defined for the Nchf\_SpendingLimitControl service API are listed in table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|---------------------------------------------------------------------------------------------------------| +| USER_UNKNOWN | 400 Bad Request | The subscriber specified in the request is not known at the CHF and the subscription cannot be created. | +| NO_AVAILABLE_POLICY_COUNTERS | 400 Bad Request | There are no policy counters available for the subscriber at the CHF | +| UNKNOWN_POLICY_COUNTERS | 400 Bad Request | The policy counter identifiers in the request are not known at the CHF. | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Nchf\_SpendingLimitControl Service API. They shall be negotiated using the extensibility mechanism defined in clause 6.6.2 of 3GPP TS 29.500 [4]. + +**Table 5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | SubscriptionExpirationTime Control | Indicates the support of a expiry time to control the time duration of the subscription to changes of policy counters status. | +| 2 | NotificationCorrelation | Indicates the support of the explicit indication of the notification correlation id | +| 3 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [4] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. | + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [14] and 3GPP TS 29.500 [4], the access to the Nchf\_SpendingLimitControl API, based on local configuration, may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [15]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [16]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nchf\_SpendingLimitControl API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [16], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF service consumer used for discovering the Nchf\_SpendingLimitControl service. + +The Nchf\_SpendingLimitControl API defines a single scope "nchf-spendinglimitcontrol" for OAuth2 authorization (as specified in 3GPP TS 33.501 [14]) for the entire API, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +The present Annex contains an OpenAPI [9] specification of HTTP messages and content bodies used by the Nchf\_SpendingLimitControl Service API. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [17] and clause 5.3.1 of the 3GPP TS 29.501 [5] for further information). + +## A.2 Nchf\_SpendingLimitControl Service API + +``` +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.2 + title: Nchf_SpendingLimitControl + description: | + Nchf Spending Limit Control Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.594 V18.3.0; 5G System; Spending Limit Control Service. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.594/' + +servers: + - url: '{apiRoot}/nchf-spendinglimitcontrol/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nchf-spendinglimitcontrol + +paths: + + /subscriptions: + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SpendingLimitContext' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/SpendingLimitStatus' + headers: + Location: +``` + +``` +description: > + Contains the URI of the created individual spending limit resource, + according to the structure + {apiRoot}/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId} +required: true +schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + statusNotification: + '{ $request.body#/notifUri }/notify': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SpendingLimitStatus' +responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +subscriptionTermination: + '{ $request.body#/notifUri }/terminate': + post: + requestBody: + required: true + content: +``` + +``` + application/json: + schema: + $ref: '#/components/schemas/SubscriptionTerminationInfo' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscription/{subscriptionId}: + parameters: + - in: path + name: subscriptionId + description: Identifies an individual spending limit retrieval subscription. + required: true + schema: + type: string + put: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SpendingLimitContext' + responses: + '200': + description: OK. Resource was successfully modified and representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/SpendingLimitStatus' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nchf-spendinglimitcontrol: Access to the Nchf_SpendingLimitControl API + +schemas: + SpendingLimitContext: + description: > + Represents the subscription data structure required for an individual CHF spending limit + subscription. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + policyCounterIds: + type: array + items: + $ref: '#/components/schemas/PolicyCounterId' + minItems: 1 + description: > + This is a list of policy counter identifier(s), which identifies policy counters + maintained per subscriber within the CHF. + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + notifId: + type: string + +SpendingLimitStatus: + description: > + Represents the data structure presenting the statuses of policy counters. + type: object + properties: +``` + +``` +supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +notifId: + type: string +statusInfos: + type: object + additionalProperties: + $ref: '#/components/schemas/PolicyCounterInfo' + minProperties: 1 + description: > + Status of the requested policy counters. The key of the map is the attribute + "policyCounterId". +expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +PolicyCounterInfo: + description: Represents the data structure presenting the policy counter status. + type: object + properties: + policyCounterId: + $ref: '#/components/schemas/PolicyCounterId' + currentStatus: + type: string + description: > + Identifies the policy counter status applicable for a specific policy counter identified + by the policyCounterId. The values (e.g. valid, invalid or any other status) are not + specified. The interpretation and actions related to the defined values are out of scope + of 3GPP. + penPolCounterStatuses: + type: array + items: + $ref: '#/components/schemas/PendingPolicyCounterStatus' + minItems: 1 + description: Provides the pending policy counter status. + required: + - policyCounterId + - currentStatus + +PendingPolicyCounterStatus: + description: > + Represents the data structure presenting the pending policy counter status. + type: object + properties: + policyCounterStatus: + type: string + description: > + Identifies the policy counter status applicable for a specific policy counter identified + by the policyCounterId. The values (e.g. valid, invalid or any other status) are not + specified. The interpretation and actions related to the defined values are out of scope + of 3GPP. + activationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - policyCounterStatus + - activationTime + +PolicyCounterId: + type: string + description: Identifies a policy counter. +SubscriptionTerminationInfo: + description: > + Represents the data structure presenting the indication of the termination of the + subscription. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + notifId: + type: string + termCause: + $ref: '#/components/schemas/TerminationCause' + required: + - supi +``` + +# Simple data types and Enumerations + +``` +TerminationCause: + anyOf: + - type: string + enum: + - REMOVED_SUBSCRIBER + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + description: | + Represents the cause for requesting the termination of the subscription to policy counter + status changes. + Possible values are: + - REMOVED_SUBSCRIBER: The subscriber identified by the SUPI has been removed from the CHF. +``` + +# --- Annex B (normative): 5GC and EPC interworking scenario support + +## B.1 Scope + +This annex defines procedures for the Nchf\_SpendingLimitControl service for 5GC and EPC interworking scenarios specified in clause B.1 of 3GPP TS 29.512 [18]. + +## --- B.2 Nchf\_SpendingLimitControl Service + +### B.2.1 Service Description + +#### B.2.1.1 Overview + +The overview in clause 4.1.1 applies. + +#### B.2.1.2 Service Architecture + +The architecture in clause 4.1.2 applies. + +## --- B.3 Service Operation + +### B.3.1 Introduction + +The service operations defined in clause 4.2 shall be applicable. + +### B.3.2 Nchf\_SpendingLimitControl\_Subscribe Service Operation + +Clause 4.2.2.2 and clause 4.2.2.3 are applied with the differences that the NF service consumers (e.g. PCF) shall include (if available) in SpendingLimitContext data structure: + +- the IMSI of the user within the "supi" attribute; +- the MSISDN of the user within the "gpsi" attribute; + +### B.3.3 Nchf\_SpendingLimitControl\_Unsubscribe Service Operation + +Clause 4.2.3 applies. + +### B.3.4 Nchf\_SpendingLimitControl\_Notify Service Operation + +Clause 4.2.4 applies. + +# --- Annex C (normative): Wireless and wireline convergence access support + +## C.1 Scope + +This annex defines procedures for wireless and wireline convergence access support for 5GS. The specific stage 2 definition and related procedures are contained in 3GPP TS 23.316 [19]. The System Architecture for wireless and wireline convergence access is defined in 3GPP TS 23.501 [2]. + +## --- C.2 Nchf\_SpendingLimitControl Service + +### C.2.1 Service Description + +#### C.2.1.1 Overview + +Clause 4.1.1 applies with the following exceptions: + +- the UE is replaced by the 5G-RG and the W-AGF, which is acting as a UE towards the 5GC on behalf of the FN-RG; and +- roaming is only applicable to a 5G-RG connecting to the 5GC via NG RAN, i.e., the H-PCF interaction with the H-CHF for the home-routed scenario only applies to a 5G-RG connecting to the 5GC via NG RAN. + +#### C.2.1.2 Service Architecture + +The architecture in clause 4.1.2 applies. + +## --- C.3 Service Operation + +### C.3.1 Introduction + +The service operations defined in clause 4.2.1 apply. + +### C.3.2 Nchf\_SpendingLimitControl\_Subscribe Service Operation + +#### C.3.2.1 General + +Clauses 4.2.2.2 and 4.2.2.3 are applied with the differences that the NF service consumer shall include (if available) in SpendingLimitContext data structure: + +- a IMSI or a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in 3GPP TS 23.316 [19] clause 4.7, encoded as specified in 3GPP TS 29.571[11], clause 5.3.2, within the "supi" attribute. + +### C.3.3 Nchf\_SpendingLimitControl\_Unsubscribe Service Operation + +Clause 4.2.3 applies. + +### C.3.4 Nchf\_SpendingLimitControl\_Notify Service Operation + +Clause 4.2.4 applies. + +# Annex D (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|--------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2018-04 | | | | | | TS skeleton of Spending Limit Control Service specification | 0.0.0 | +| 2018-04 | CT3#96 | | | | | Inclusion of documents agreed in CT3#96: C3-182160, C3-182161, C3-182167, C3-182432, C3-182433, C3-182434, C3-182435, C3-182436, C3-182437, C3-182479 | 0.1.0 | +| 2018-05 | CT3#97 | | | | | Inclusion of documents agreed in CT3#97: C3-183138, C3-183288, C3-183538, C3-183539, C3-183541, C3-183543, C3-183544, C3-183545, C3-183546, C3-183547, C3-183548, C3-183550, C3-183552, C3-183780, C3-183782, C3-183830, C3-183831 | 0.2.0 | +| 2018-06 | CT#80 | CP-181026 | | | | TS sent for approval to TSG | 1.0.0 | +| 2018-06 | CT#80 | CP-181026 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 1 | F | Removal of possibility of confusion related to 3GPP TS 29.513, custom headers, verbal forms and OpenAPI corrections | 15.1.0 | +| 2018-09 | CT#81 | CP-182221 | 0002 | 4 | F | Introduction of the simple data type "policyCounterId" | 15.1.0 | +| 2018-09 | CT#81 | CP-182098 | 0003 | 3 | F | Update and corrections of the data model | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | 2 | F | Integration of error handling | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0007 | - | F | ED – Continuous reporting and policy counter status change | 15.1.0 | +| 2018-09 | CT#81 | CP-182099 | 0008 | 3 | F | Termination of the subscription of status changes for all policy counters by CHF | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0009 | - | F | Application of resource illustration rule | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0010 | - | F | Consolidation of the term "notificationUri" | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0011 | - | F | Clarification of "intermediate spending limit report retrieval" usage | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0012 | - | F | Correction of wrong reference for sup1 in OpenAPI doc | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0013 | - | F | Correction of the originator for application error responses | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0014 | 1 | F | Application of externalDocs field in OpenAPI doc | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0015 | 1 | F | Application of version pattern rule in OpenAPI doc | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0016 | 1 | F | Corrections to OpenAPI file | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0017 | - | F | Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0018 | - | F | Cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0019 | 2 | F | Sending of GPSI (MSISDN) in Initial Spending Limit retrieval | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0020 | 1 | F | Update of content types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0021 | 1 | F | Authorization of NF service access by OAuth 2.0 | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0022 | 1 | F | Introduction of status code 404 Not Found as mandatory status code and missing ones | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0023 | 1 | F | Location Header | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0024 | 2 | F | Correcting application error | 15.2.0 | +| 2019-03 | CT#83 | CP-190113 | 0025 | 1 | F | Correction of Resource URI | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0026 | 1 | F | Correction relating to the introduction of the General Public Subscription Identifier | 15.3.0 | +| 2019-03 | CT#83 | CP-190068 | 0027 | 2 | F | OpenAPI info version update | 15.3.0 | +| 2019-03 | CT#83 | CP-190067 | 0028 | - | F | Correction of wrong usage of key word "items" | 15.3.0 | +| 2019-06 | CT#84 | CP-191189 | 0030 | 3 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191189 | 0031 | 1 | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CT#84 | CP-191189 | 0033 | - | F | OpenAPI version number update | 15.4.0 | +| 2019-06 | CT#84 | CP-191089 | 0032 | 1 | B | Race Condition handling | 16.0.0 | +| 2019-09 | CT#85 | CP-192151 | 0035 | - | A | NF service consumer pending policy counter handling | 16.1.0 | +| 2019-09 | CT#85 | CP-192156 | 0036 | 1 | B | Support of Expiry Time | 16.1.0 | +| 2019-09 | CT#85 | CP-192151 | 0038 | - | A | Correction to Subscription Termination service operation | 16.1.0 | +| 2019-09 | CT#85 | CP-192151 | 0040 | - | A | Correction to subscription creation/update response | 16.1.0 | +| 2019-09 | CT#85 | CP-192151 | 0042 | - | A | Corrections to subscription request descriptions | 16.1.0 | +| 2019-09 | CT#85 | CP-192151 | 0044 | - | A | Handling of unknown policy counters | 16.1.0 | +| 2019-09 | CT#85 | CP-192173 | 0045 | - | F | OpenAPI version update for TS 29.594 Rel-16 | 16.1.0 | +| 2020-06 | CT#88e | CP-201233 | 0046 | - | F | Description of "activationTime" attribute | 16.2.0 | +| 2020-06 | CT#88e | CP-201233 | 0047 | - | F | Miscellaneous corrections | 16.2.0 | +| 2020-06 | CT#88e | CP-201244 | 0048 | 1 | F | Storage of YAML files in ETSI Forge | 16.2.0 | +| 2020-06 | CT#88e | CP-201256 | 0049 | 1 | F | URI of the Nchf_SpendingLimitControl service | 16.2.0 | +| 2020-06 | CT#88e | CP-201244 | 0050 | 1 | F | Optionality of ProblemDetails | 16.2.0 | +| 2020-06 | CT#88e | CP-201244 | 0052 | 1 | F | Supported headers, Resource Data type | 16.2.0 | +| 2020-06 | CT#88e | CP-201255 | 0053 | - | F | Update of OpenAPI version and TS version in externalDocs field | 16.2.0 | +| 2020-09 | CT#89e | CP-202058 | 0056 | 1 | A | Correction to spending limit subscribe and unsubscribe procedures | 16.3.0 | +| 2020-09 | CT#89e | CP-202058 | 0058 | 1 | A | Nchf_SpendingLimitControl Service support of interworking | 16.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------|--------| +| 2020-12 | CT#90e | CP-203139 | 0061 | 1 | F | Essential corrections and alignments | 16.4.0 | +| 2020-12 | CT#90e | CP-203139 | 0062 | 1 | F | Storage of YAML files in 3GPP Forge | 16.4.0 | +| 2020-12 | CT#90e | CP-203122 | 0064 | 1 | A | Correction to Intermediate spending limit report retrieval | 16.4.0 | +| 2020-12 | CT#90e | CP-203128 | 0065 | - | F | Correction to subscription's expiry time | 16.4.0 | +| 2020-12 | CT#90e | CP-203128 | 0066 | 1 | F | Correction to subscription create service operation | 16.4.0 | +| 2020-12 | CT#90e | CP-203152 | 0068 | - | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2021-03 | CT#91e | CP-210191 | 0070 | 2 | F | Support of stateless NFs | 16.5.0 | +| 2021-03 | CT#91e | CP-210202 | 0071 | 2 | F | Correction to Wireline Access information | 16.5.0 | +| 2021-03 | CT#91e | CP-210226 | 0072 | 1 | F | Definition addition to TS29.594 | 17.0.0 | +| 2021-03 | CT#91e | CP-210219 | 0073 | 1 | F | Optional header clarification | 17.0.0 | +| 2021-03 | CT#91e | CP-210221 | 0075 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI | 17.0.0 | +| 2021-03 | CT#91e | CP-210221 | 0076 | 1 | F | Ambiguous concept of NF service consumer terminology | 17.0.0 | +| 2021-03 | CT#91e | CP-210220 | 0077 | - | F | OpenAPI reference | 17.0.0 | +| 2021-03 | CT#91e | CP-210240 | 0079 | - | F | Update of OpenAPI version and TS version in externalDocs field | 17.0.0 | +| 2021-06 | CT#92e | CP-211210 | 0082 | 1 | A | Correction to policyCounterId | 17.1.0 | +| 2021-06 | CT#92e | CP-211219 | 0084 | 1 | A | Correction to expiry time | 17.1.0 | +| 2021-06 | CT#92e | CP-211219 | 0086 | 1 | A | Correction to notification correlation id | 17.1.0 | +| 2021-06 | CT#92e | CP-211219 | 0090 | 1 | A | Correction to the termination procedure | 17.1.0 | +| 2021-06 | CT#92e | CP-211200 | 0092 | 1 | A | Temporary and Permanent Redirection | 17.1.0 | +| 2021-06 | CT#92e | CP-211265 | 0094 | - | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-09 | CT#93e | CP-212220 | 0095 | 1 | F | Correction of URI structure | 17.2.0 | +| 2022-03 | CT#95e | CP-220176 | 0096 | 2 | A | Alignment of "Application Errors" clause with SBI TS template | 17.3.0 | +| 2022-06 | CT#96 | CP-221154 | 0098 | 1 | F | Formatting of description fields | 17.4.0 | +| 2022-06 | CT#96 | CP-221152 | 0099 | - | F | Update of info and externalDocs fields | 17.4.0 | +| 2022-09 | CT#97e | CP-222123 | 0100 | - | F | Alignment with the SBI template | 17.5.0 | +| 2022-12 | CT#98e | CP-223191 | 0101 | - | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0102 | 1 | F | TerminationCause enumeration definition in the OpenAPI file | 18.0.0 | +| 2022-12 | CT#98e | CP-223190 | 0103 | - | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-06 | CT#100 | CP-231132 | 0104 | 1 | F | HTTP redirection clause correction | 18.1.0 | +| 2023-09 | CT#101 | CP-232099 | 0105 | 1 | B | Clarification on Spending Limit Control Service | 18.2.0 | +| 2023-12 | CT#102 | CP-233230 | 0108 | 1 | F | Update HTTP RFC 7807 obsoleted by IETF RFC 9457 | 18.3.0 | +| 2023-12 | CT#102 | CP-233230 | 0109 | 1 | F | Corrections to the description fields of the enumerations | 18.3.0 | +| 2023-12 | CT#102 | CP-233238 | 0110 | - | F | Update of info and externalDocs fields | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29641/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29641/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9f8e34006c44c15bc4fcc2182d366aae41c1aefd --- /dev/null +++ b/raw/rel-18/29_series/29641/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:88d025b64ab426c18ed06e2e4198f6961230138f8fe4974fbed8be7909a97b0f +size 9845 diff --git a/raw/rel-18/29_series/29641/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29641/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..474088002f241fff2759ad877d40cef5e0d85323 --- /dev/null +++ b/raw/rel-18/29_series/29641/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:749cfb547ae424a3470485259f8e1b911265b6b1d1408520050ee2cb59d9cceb +size 5700 diff --git a/raw/rel-18/29_series/29673/raw.md b/raw/rel-18/29_series/29673/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6ebfa1e1018983237c6b68ffc93014410e162964 --- /dev/null +++ b/raw/rel-18/29_series/29673/raw.md @@ -0,0 +1,2068 @@ + + +# 3GPP TS 29.673 V18.2.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; UE radio capability management services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Overview..... | 7 | +| 4.1 Introduction ..... | 7 | +| 5 Services offered by the UCMF ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Nucmf_UECapabilityManagement Service..... | 8 | +| 5.2.1 Service Description ..... | 8 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 Service Operation Resolve..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 Retrieve a Dictionary Entry..... | 10 | +| 5.2.2.3 Service Operation Assign ..... | 10 | +| 5.2.2.4 Service Operation Subscribe..... | 11 | +| 5.2.2.4.1 General ..... | 11 | +| 5.2.2.5 Unsubscribe ..... | 12 | +| 5.2.2.5.1 General ..... | 12 | +| 5.2.2.6 Notify ..... | 12 | +| 5.2.2.6.1 General ..... | 12 | +| 6 API Definitions ..... | 13 | +| 6.1 Nucmf_UECapabilityManagement Service API ..... | 13 | +| 6.1.1 Introduction ..... | 13 | +| 6.1.2 Usage of HTTP..... | 13 | +| 6.1.2.1 General..... | 13 | +| 6.1.2.2 HTTP standard headers..... | 13 | +| 6.1.2.2.1 General ..... | 13 | +| 6.1.2.2.2 Content type ..... | 13 | +| 6.1.2.3 HTTP custom headers..... | 14 | +| 6.1.2.4 HTTP multipart messages..... | 14 | +| 6.1.3 Resources..... | 15 | +| 6.1.3.1 Overview..... | 15 | +| 6.1.3.2 Resource: Dictionary Entries ..... | 16 | +| 6.1.3.2.1 Description ..... | 16 | +| 6.1.3.2.2 Resource Definition..... | 16 | +| 6.1.3.2.3 Resource Standard Methods..... | 16 | +| 6.1.3.2.3.1 GET ..... | 16 | +| 6.1.3.2.3.2 POST ..... | 17 | +| 6.1.3.2.4 Resource Custom Operations..... | 18 | +| 6.1.3.3 Resource: Individual Dictionary Entry ..... | 18 | +| 6.1.3.3.1 Description ..... | 18 | +| 6.1.3.3.2 Resource Definition..... | 19 | +| 6.1.3.3.3 Resource Standard Methods..... | 19 | +| 6.1.3.3.3.1 GET ..... | 19 | +| 6.1.3.4 Resource: Subscriptions collection..... | 20 | +| 6.1.3.4.1 Description ..... | 20 | +| 6.1.3.4.2 Resource Definition..... | 20 | +| 6.1.3.4.3 Resource Standard Methods..... | 20 | + +| | | | +|-------------------------------------|----------------------------------------------------------------------------------|-----------| +| 6.1.3.4.3.1 | POST ..... | 20 | +| 6.1.3.4.4 | Resource Custom Operations ..... | 21 | +| 6.1.3.5 | Resource: Individual subscription ..... | 22 | +| 6.1.3.5.1 | Description ..... | 22 | +| 6.1.3.5.2 | Resource Definition..... | 22 | +| 6.1.3.5.3 | Resource Standard Methods..... | 22 | +| 6.1.3.5.3.2 | DELETE ..... | 22 | +| 6.1.3.5.4 | Resource Custom Operations ..... | 23 | +| 6.1.4 | Custom Operations without associated resources ..... | 23 | +| 6.1.5 | Notifications ..... | 23 | +| 6.1.5.1 | General ..... | 23 | +| 6.1.5.2 | UCMF Notification..... | 24 | +| 6.1.5.2.1 | Description ..... | 24 | +| 6.1.5.2.2 | Target URI..... | 24 | +| 6.1.5.2.3 | Standard Methods..... | 24 | +| 6.1.5.2.3.1 | POST ..... | 24 | +| 6.1.6 | Data Model ..... | 25 | +| 6.1.6.1 | General ..... | 25 | +| 6.1.6.2 | Structured data types..... | 26 | +| 6.1.6.2.1 | Introduction ..... | 26 | +| 6.1.6.2.2 | Type: DicEntryData ..... | 26 | +| 6.1.6.2.3 | Type: DicEntryCreateData..... | 27 | +| 6.1.6.2.4 | Type: DicEntryCreatedData..... | 27 | +| 6.1.6.2.5 | Type: UeRadioCapaId..... | 27 | +| 6.1.6.2.6 | Type: CreateSubscription..... | 28 | +| 6.1.6.2.7 | Type: CreatedSubscription..... | 28 | +| 6.2.6.2.8 | Type: UcmfNotification ..... | 28 | +| 6.2.6.2.9 | Type: ManAssOpRequestList..... | 29 | +| 6.1.6.3 | Simple data types and enumerations..... | 29 | +| 6.1.6.3.1 | Introduction ..... | 29 | +| 6.1.6.3.2 | Simple data types ..... | 29 | +| 6.1.6.3.3 | Enumeration: EventType..... | 29 | +| 6.1.6.3.4 | Enumeration: RacFormat ..... | 29 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 30 | +| 6.1.6.5 | Binary data ..... | 30 | +| 6.1.6.5.2 | UE Radio Capability Information ..... | 30 | +| 6.1.7 | Error Handling ..... | 30 | +| 6.1.7.1 | General ..... | 30 | +| 6.1.7.2 | Protocol Errors ..... | 30 | +| 6.1.7.3 | Application Errors..... | 30 | +| 6.1.8 | Feature negotiation ..... | 31 | +| 6.1.9 | Security ..... | 31 | +| 6.1.10 | HTTP redirection..... | 31 | +| Annex A (normative): ..... | OpenAPI specification ..... | 33 | +| A.1 | General ..... | 33 | +| A.2 | Nucmf_UECapabilityManagement API ..... | 33 | +| Annex B (informative): ..... | Change history..... | 43 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nucmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the Nucmf. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . [7] +3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [15] 3GPP TS 38.413: "NG Radio Access Network (NG-RAN); NG Application Protocol (NGAP)". + +- [16] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [17] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)" + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +void + +## 3.2 Symbols + +void + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|-----------------------------------------| +| MME | Mobility Management Entity | +| UCMF | UE radio Capability Management Function | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the UCMF offers services to the NF (e.g. AMF and MME) via the Nucmf service based interface (see 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the UCMF and the scope of the present specification. + +![Reference model diagram showing UCMF connected to AMF, MME, NEF, and AF via Nucmf interfaces N55, N56, and N57.](06da11ab76cacc38bbcd714e437797ea_img.jpg) + +The diagram illustrates the reference model for the UCMF. On the right, a large green rectangle represents the UCMF. To its left, four smaller rectangles represent network functions: AMF, MME, NEF, and AF. The MME is at the top, connected to the UCMF via a line labeled 'Nucmf' and 'N55'. The AMF is below the MME, connected via a line labeled 'N56'. The NEF is below the AMF, connected via a line labeled 'N57'. The AF is at the bottom, also connected via a line labeled 'N57'. All lines converge on the 'Nucmf' interface of the UCMF. + +Reference model diagram showing UCMF connected to AMF, MME, NEF, and AF via Nucmf interfaces N55, N56, and N57. + +Figure 4.1-1: Reference model – UCMF + +The functionalities supported by the UCMF are listed in clause 6.2.5 of 3GPP TS 23.501 [2]. + +# 5 Services offered by the UCMF + +## 5.1 Introduction + +The UCMF supports the following services. + +**Table 5.1-1: NF Services provided by UCMF** + +| Service Name | Description | Example Consumer | +|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| Nucmf_UECapabilityManagement |

Allows the NF consumer to resolve UE Radio Capability ID (either Manufacturer-assigned or PLMN-assigned) into the corresponding UE radio access capability and the corresponding UE Radio Capability for Paging.

Allows the NF consumer to obtain a PLMN-assigned UE Radio Capability ID for a specific UE radio access capability.

Allows the NF consumer to subscribe or unsubscribe for notifications of UCMF dictionary entries.

Allows the NF consumer to be notified about creation and deletion of UCMF dictionary entries.

| AMF, MME | + +## 5.2 Nucmf\_UECapabilityManagement Service + +### 5.2.1 Service Description + +The Nucmf\_UECapabilityManagement service operates on the dictionary entries for the mapping between UE Radio Capability ID and UE Radio Access Capability Information. The service operations exposed by this service allow service consumer NF, e.g. an AMF: + +- to retrieve UE radio access capability information with a UE Radio Capability ID (either Manufacturer-assigned or PLMN-assigned); +- to obtain a PLMN-assigned UE Radio Capability ID for a specific UE radio access capability information; +- to subscribe or unsubscribe for notifications of UCMF dictionary entries; +- to be notified about creation and deletion of UCMF dictionary entries; + +The Nucmf\_UECapabilityManagement service supports the following service operations; + +**Table 5.2.1-1: Service operations supported by the Nucmf\_UECapabilityManagement service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---------------------| +| Resolve | Retrieve UE radio access capability information from the dictionary entry identified by the UE Radio Capability ID (either Manufacturer-assigned or PLMN-assigned) | Request/Response | AMF, MME | +| Assign | Request to assign a UE Radio Capability ID by providing the UE Radio Capability Information. See 3GPP TS 23.502 clause 5.2.18.3.2. | Request/Response | AMF, MME | +| Subscribe | Subscribe for notifications of UCMF dictionary entries. | Subscribe/Notify | AMF, MME | +| Unsubscribe | Unsubscribe for notifications of UCMF dictionary entries. | Subscribe/Notify | AMF, MME | +| Notify | To be notified about creation and deletion of UCMF dictionary entries. | Subscribe/Notify | AMF, MME | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +See Table 5.2.1-1 for an overview of the service operations supported by the Nucmf\_UECapabilityManagement service. + +#### 5.2.2.2 Service Operation Resolve + +##### 5.2.2.2.1 General + +The Resolve service operation shall be used to retrieve UE Radio Access Capability Information from a dictionary entry stored in the UCMF, by a NF service consumer, e.g. an AMF, when: + +- it has received an unknown UE Radio Capability ID, which is either Manufacturer-assigned or PLMN-assigned; + +The NF Service Consumer (e.g. AMF) shall retrieve UE Radio Access Capability Information by using the HTTP GET method as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and the UCMF to retrieve UE Radio Access Capability Information. The consumer sends a GET request to the UCMF, and the UCMF responds with either a 200 OK (dicEntryData) or an error status (4xx/5xx or 3xx).](2ba086df3506f81bae3a9b53725dcfea_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UCMF + Note left of NF Service Consumer: Request UE Radio Access Capability Information + NF Service Consumer->>UCMF: GET .../dic-entries ? + Note right of UCMF: Processing request + UCMF-->>NF Service Consumer: 2a. 200 OK (dicEntryData) + Note left of NF Service Consumer: Success + UCMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + Note left of NF Service Consumer: Error/Redirect + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and the UCMF to retrieve UE Radio Access Capability Information. The consumer sends a GET request to the UCMF, and the UCMF responds with either a 200 OK (dicEntryData) or an error status (4xx/5xx or 3xx). + +**Figure: 5.2.2.2.1-1 Retrieve UE Radio Access Capability Information** + +1. The NF Service Consumer, e.g. an AMF, shall send an HTTP GET request to the resource URI Dictionary Entries collection resource. The query parameters are a Manufacturer-assigned or a PLMN-assigned UE Radio Capability ID, and the Coding format (e.g. 5GS or EPS) in which UE Radio Access Capability Information needs to be provided. +- 2a. On success, "200 OK" shall be returned. The response body shall contain UE Radio Access Capability Information in the requested Coding format stored in the dictionary entry that is matching the UE Radio Capability ID in query, and may contain a PLMN-assigned UE Radio Capability ID if the query parameter is a Manufacturer-assigned UE Radio Capability ID and if the PLMN-assigned UE Radio Capability ID mechanism is used in the network. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3.2-2, where applicable. + +##### 5.2.2.2.2 Retrieve a Dictionary Entry + +The Resolve service operation may be used to retrieve a dictionary entry stored in the UCMF, by a NF service consumer, e.g. an AMF, when it has the Dictionary Entry ID available. + +The NF Service Consumer (e.g. AMF) shall retrieve a Dictionary Entry by using the HTTP GET method as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram for Figure 5.2.2.2.1-1: Retrieve a dictionary entry. The diagram shows an NF Service Consumer sending a GET request to a UCMF. The UCMF responds with either a 200 OK (dicEntryData) or a 4xx/5xx (ProblemDetails) or 3xx response.](053f1077d592e6622cd21dc4bb4cb366_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UCMF + Note left of NF Service Consumer: + NF Service Consumer->>UCMF: GET .../dic-entries/{dicEntryId} + Note right of UCMF: + UCMF-->>NF Service Consumer: 2a. 200 OK (dicEntryData) + UCMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Figure 5.2.2.2.1-1: Retrieve a dictionary entry. The diagram shows an NF Service Consumer sending a GET request to a UCMF. The UCMF responds with either a 200 OK (dicEntryData) or a 4xx/5xx (ProblemDetails) or 3xx response. + +Figure 5.2.2.2.1-1 Retrieve a dictionary entry + +1. The NF Service Consumer, e.g. an AMF, shall send an HTTP GET request to an individual Dictionary Entry resource. The query parameter is the Coding Format (e.g. 5GS or EPS) in which UE Radio Access Capability Information needs to be provided. +- 2a. On success, "200 OK" shall be returned. The response body shall the dictionary entry information for the given Dictionary Entry ID. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3.2-3, where applicable. + +#### 5.2.2.3 Service Operation Assign + +The Assign service operation shall be used by the service consumer NF (e.g. AMF) to obtain a PLMN-assigned UE Radio Capability ID from the UCMF for a specific UE radio access capability information. The UCMF shall create a new dictionary entry and assign a PLMN-assigned UE Radio Capability ID unless such dictionary entry already exists and a PLMN-assigned UE Radio Capability ID has already been assigned to the given UE radio access capability information in the UCMF. The NF service consumer, e.g. an AMF, may consume the service by providing the UE Radio Access Capability Information retrieved from the UE, and Type Allocation Code of PEI of the UE, e.g. when it hasn't received any UE Radio Capability ID. + +**The NF Service Consumer (e.g. AMF) shall obtain the PLMN Assigned UE Radio Capability ID by using the HTTP POST method as shown in Figure 5.2.2.3.1-1.** + +![Sequence diagram for Figure 5.2.2.3.1-1: Create a dictionary entry. The diagram shows an NF Service Consumer (e.g. an AMF) sending a POST request to a UCMF. The UCMF responds with either a 201 Created (DicEntryCreatedData) or a 4xx/5xx (ProblemDetails) or 3xx response.](fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer as NF Service Consumer +e.g. an AMF + participant UCMF + Note left of NF Service Consumer: + NF Service Consumer->>UCMF: 1. POST .../dic-entries (DicEntryCreateData) + Note right of UCMF: + UCMF-->>NF Service Consumer: 2a. 201 Created (DicEntryCreatedData) + UCMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Figure 5.2.2.3.1-1: Create a dictionary entry. The diagram shows an NF Service Consumer (e.g. an AMF) sending a POST request to a UCMF. The UCMF responds with either a 201 Created (DicEntryCreatedData) or a 4xx/5xx (ProblemDetails) or 3xx response. + +Figure 5.2.2.3.1-1 Create a dictionary entry + +1. The NF Service Consumer shall send a POST request to the resource representing the Dictionary Entries collection resource of the UCMF. The content of the POST request shall contain: + - the UE Radio Access Capability Information for the current radio configuration of the UE in 5GS format, or EPS format, or both the formats; + - the Type Allocation Code of the PEI of the UE. +- 2a. On success, the UCMF shall check whether for the provided input a dictionary entry already exists and a PLMN Assigned UE Radio Capability ID has already been assigned. If so "201 Created" shall be returned, the content of the POST response shall contain already assigned PLMN Assigned UE Radio Capability ID included in DicEntryCreatedData and the "Location" header shall be present and shall contain the URI of the already existing resource. Otherwise a new dictionary entry shall be created and "201 Created" shall be returned, the content of the POST response shall contain the newly assigned PLMN Assigned UE Radio Capability ID included in DicEntryCreatedData and the "Location" header shall be present and shall contain the URI of the newly created resource. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.2-2, where applicable. A UCMF configured to operate in Mode of Operation A (3GPP TS 23.501, Clause 5.4.4.1a) shall reject the operation if the request does not contain UE Radio Access Capability Information in both the formats and the UCMF is not able to find match of the received UE Radio Access Capability Information in its database. + +#### 5.2.2.4 Service Operation Subscribe + +##### 5.2.2.4.1 General + +The Subscribe service operation shall be used by a NF Service Consumer, e.g. an AMF, to create a subscription in the UCMF, to get notifications for one or more new dictionary entries creation or for the deletion of one or more PLMN Assigned UE Radio Capability IDs. + +The NF Service Consumer shall request to create a new subscription by using HTTP method POST with URI of the subscriptions collection, see clause 6.1.3.4. A ucmfNotificationUri shall be provided in the CreateSubscription to be used by the UCMF to send notifications later. See Figure 5.2.2.4.1-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and a UCMF to create a subscription. The NF Service Consumer sends a POST request to the UCMF. The UCMF responds with either a 201 Created status or a 4xx/5xx status with ProblemDetails or a 3xx status.](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UCMF + Note left of NF Service Consumer: NF Service Consumer + Note right of UCMF: UCMF + NF Service Consumer->>UCMF: 1. POST .../subscriptions (CreateSubscription) + UCMF-->>NF Service Consumer: 2a. 201 Created (CreatedSubscription) + UCMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx- + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a UCMF to create a subscription. The NF Service Consumer sends a POST request to the UCMF. The UCMF responds with either a 201 Created status or a 4xx/5xx status with ProblemDetails or a 3xx status. + +Figure 5.2.2.4.1-1 Create a subscription + +1. The NF Service Consumer shall send a POST request to create a subscription resource in the UCMF. The content of the POST request shall contain a representation of the individual subscription resource to be created. The request may contain an expiry time, suggested by the NF Service Consumer as a hint, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event(s) shall stop generating report. +- 2a. On success, the request is accepted, the UCMF shall include a HTTP Location header to provide the location of a newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. The UCMF may also include the highest dictionary entry ID which has been allocated. + +The response, based on operator policy and taking into account the expiry time included in the request, may contain the expiry time, as determined by the UCMF, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new + +subscription in the UCMF. The UCMF shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.4.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.4.3.1-3. + +#### 5.2.2.5 Unsubscribe + +##### 5.2.2.5.1 General + +The Unsubscribe service operation is used by a NF Service Consumer, e.g. AMF, towards the UCMF, to remove an existing subscription previously created by itself at the UCMF. + +The NF Service Consumer shall unsubscribe to the subscription by using HTTP method DELETE with the URI of the individual subscription resource (see clause 6.1.3.5) to be deleted. See Figure 5.2.2.5.1-1. + +![Sequence diagram for Unsubscribe a subscription. The NF Service Consumer sends a DELETE request to the UCMF. The UCMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](78ffccd66df9bafd96e3e081110d09dd_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UCMF + Note left of NF Service Consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF Service Consumer->>UCMF: 1. DELETE .../subscriptions/{subscriptionId} + Note right of UCMF: -2a. 204 No Content + UCMF-->>NF Service Consumer: -2a. 204 No Content + Note right of UCMF: -2b. 4xx/5xx (ProblemDetails) or 3xx + UCMF-->>NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Unsubscribe a subscription. The NF Service Consumer sends a DELETE request to the UCMF. The UCMF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +Figure 5.2.2.5.1-1 Unsubscribe a subscription + +- The NF Service Consumer shall send a DELETE request to delete an existing subscription resource in the UCMF. +- On success, the request is accepted, the UCMF shall reply with the status code 204 indicating the resource identified by subscription ID is successfully deleted in the response message. +- On failure or redirection, one of the HTTP status code listed in Table 6.1.3.5.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.5.3.2-3. + +#### 5.2.2.6 Notify + +##### 5.2.2.6.1 General + +The Notify service operation is used by the UCMF, to send a notification, towards the notification URI, when certain event included in the subscription has taken place. + +The UCMF shall use the HTTP method POST, using the notification URI received in the subscription creation as specified in clause 5.2.2.4.1. See Figure 5.2.2.6.1-1. + +![Sequence diagram for Notify. The UCMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code.](cb8dd5eca74bbf15a81e37c23263c9a8_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant UCMF + Note right of UCMF: 1. POST {UcmfNotificationUrl}(UcmfNotification) + UCMF->>NF Service Consumer: 1. POST {UcmfNotificationUrl}(UcmfNotification) + Note left of NF Service Consumer: -2a. 204 No Content + NF Service Consumer-->>UCMF: -2a. 204 No Content + Note left of NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>UCMF: -2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Notify. The UCMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) status code. + +Figure 5.2.2.6.1-1 Notify + +1. The AMF shall send a POST request to send a notification. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, the appropriate HTTP status code listed in Table 6.1.5.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain appropriate additional error information. + +# --- 6 API Definitions + +## 6.1 Nucmf\_UECapabilityManagement Service API + +### 6.1.1 Introduction + +The Nucmf\_UECapabilityManagement service shall use the Nucmf\_UECapabilityManagement API. + +The API URI of the Nucmf\_UECapabilityManagement API shall be: + +**{apiRoot}
** + +The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nucmf-uecm". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one or more binary body parts with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported. + +**Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| vnd.3gpp.ngap | Binary encoded payload, encoding NG Application Protocol (NGAP) IEs, as specified in clause 9.3 of 3GPP TS 38.413 [15] (ASN.1 encoded). | +| vnd.3gpp.s1ap | Binary encoded payload, encoding S1 Application Protocol (S1AP) IEs, as specified in clause 9.2 of 3GPP TS 36.413 [17] (ASN.1 encoded). | +| NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (e.g. NGAP or 5GS NAS information) without having to rely on metadata in the JSON payload. | | + +See clause 6.1.2.4 for the binary payloads supported in the binary body part of multipart messages. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +#### 6.1.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported to transfer opaque UE Radio Access Capability Information, in the following service operations (and HTTP messages): + +- Resolve Response (GET Response); +- Assign Request (POST); + +HTTP multipart message shall include one JSON body part and one or more binary body parts comprising the OCTET STRING of the UE Radio Capability IE (i.e. excluding the IEI, Criticality and octet string length indicator, see also Annex B of 3GPP TS 29.274 [16]) as specified in clause 9.3.1.74 of 3GPP TS 38.413 [15]) and clause 9.2.1.27 of 3GPP TS 36.413 [17], or the UE Radio Access Capability for Paging IE as specified in clause 9.2.1.98 of 3GPP TS 36.413 [17] and as specified in clause 9.3.1.68 of 3GPP TS 38.413 [15]. + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [10]) specifying the media type of the root body part, i.e. "application/json". + +NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [10]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [12]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Diagram showing the resource URI structure of the Nucmf_UECapabilityManagement API. The root path is {apiRoot}/nucmf-ucm/. It branches into two main paths: /dic-entries and /subscriptions. /dic-entries further branches into /{dicEntryId}. /subscriptions further branches into /{subscriptionsId}.](75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg) + +{apiRoot}/nucmf-ucm/ + +``` + +graph TD + Root["{apiRoot}/nucmf-ucm/"] --> DicEntries["/dic-entries"] + Root --> Subscriptions["/subscriptions"] + DicEntries --> DicEntryId["/{dicEntryId}"] + Subscriptions --> SubscriptionsId["/{subscriptionsId}"] + +``` + +Diagram showing the resource URI structure of the Nucmf\_UECapabilityManagement API. The root path is {apiRoot}/nucmf-ucm/. It branches into two main paths: /dic-entries and /subscriptions. /dic-entries further branches into /{dicEntryId}. /subscriptions further branches into /{subscriptionsId}. + +**Figure 6.1.3.1-1: Resource URI structure of the Nucmf\_UECapabilityManagement API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------|---------------------------------|---------------------------------|------------------------------------------| +| Dictionary Entries collection | /dic-entries | POST | Nucmf_UECapabilityManagement_Assign | +| | | GET | Nucmf_UECapabilityManagement_Resolve | +| Individual Dictionary Entry | /dic-entries/{dicEntryId} | GET | Nucmf_UECapabilityManagement_Resolve | +| Subscriptions collection | /subscriptions | POST | Nucmf_UECapabilityManagement_Subscribe | +| Individual subscription | /subscriptions/{subscriptionId} | DELETE | Nucmf_UECapabilityManagement_Unsubscribe | + +#### 6.1.3.2 Resource: Dictionary Entries + +##### 6.1.3.2.1 Description + +This resource represents the collection of the individual dictionary entries created in the UCMF, where each individual dictionary entry includes the mapping information between UE Radio Capability ID and UE Radio Access Capability Information, Type Allocation Code and Software version of a PEI. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nucmf-ucm/{apiVersion}/dic-entries + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 GET + +This operation retrieves the UE Radio Access Capability Information from a dictionary entry stored in the UCMF, by querying with a Manufacturer-assigned or PLMN-assigned UE Radio Capability ID, or the TAC and the SVN as part of the IMEI/IMEISV of the UE. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------|---------------| +| ue-radio-capa-id | UeRadioCapaId | M | 1 | PLMN assigned or Manufacturer assigned UE Radio Capability ID used to retrieve a dictionary entry. | | +| rac-format | RacFormat | C | 0..1 | Coding format in which UE Radio Access Capability Information needs to be provided. See the clause 6.1.6.3.4. | | +| supported-features | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DicEntryData | M | 1 | 200 OK | The response body contains a dictionary entry that is matching the querying parameter. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 400 Bad Request | The response body contains the error reason of the request message. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- NO_DICTIONARY_ENTRY_FOUND
- OUT_DATED_VERSION_ID_IN_RAC_ID

See table 6.1.7.3-1 for the description of this error. | + +NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.2.3.2 POST + +This method creates an individual dictionary entry resource in the UCMF unless such dictionary entry already exists. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.2-1. + +**Table 6.1.3.2.3.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.2-2 and the response data structures and response codes specified in table 6.1.3.2.3.2-3. + +**Table 6.1.3.2.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|---------------------------------------------------------------------------| +| DicEntryCreateData | M | 1 | Contains UE Radio Access Capability Information and type Allocation Code. | + +**Table 6.1.3.2.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|---------------------------------------------------------------------| +| DicEntryCreatedData | M | 1 | 201 Created | The response body contains the assigned UE Radio Capability ID. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 400 Bad Request | The response body contains the error reason of the request message. | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 6.1.3.2.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.2.4 Resource Custom Operations + +None. + +#### 6.1.3.3 Resource: Individual Dictionary Entry + +##### 6.1.3.3.1 Description + +This resource represents an individual Dictionary Entry for the mapping information between UE Radio Capability ID(s) and UE Radio Access Capability information, identified by the Dictionary Entry ID. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nucmf-ucm/{apiVersion}/dic-entries/{dicEntryId} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|----------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1. | +| dicEntryId | Integer with range 1-4294967295. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 GET + +This operation retrieves an individual dictionary entry resource for the mapping information between UE Radio Capability ID(s) and UE Radio Access Capability information, stored in the UCMF, identified by the dicEntryId. + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------|---------------| +| rac-format | RacFormat | C | 0..1 | Coding format in which UE Radio Access Capability Information needs to be provided. See the clause 6.1.6.3.4. | | +| supported-features | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DicEntryData | M | 1 | 200 OK | The response body contains a dictionary entry for the given Dictionary Entry ID. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate the following application error:
- NO_DICTIONARY_ENTRY_FOUND

See table 6.1.7.3-1 for the description of this error. | +| NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). | | | | | + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.4 Resource: Subscriptions collection + +##### 6.1.3.4.1 Description + +This resource represents a collection of subscriptions in the UCMF, created by NF service consumers of Nucmf\_UECapabilityManagement service. + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nucmf-ucm//subscriptions + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|-------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1. | + +##### 6.1.3.4.3 Resource Standard Methods + +###### 6.1.3.4.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1. + +**Table 6.1.3.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------------------------------------| +| CreateSubscription | M | 1 | The Subscription to be created by a NF Service consumer, e.g. an AMF. | + +**Table 6.1.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedSubscription | M | 1 | 201 Created | Represents successful creation of a Subscription in the UCMF | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set. | +| ProblemDetails | O | 0..1 | 400 Bad Request | The response body contains the error reason of the request message. | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.4.4 Resource Custom Operations + +None. + +#### 6.1.3.5 Resource: Individual subscription + +##### 6.1.3.5.1 Description + +This resource represents an individual of subscription in the UCMF, created earlier by a NF Service Consumer of Nucmf\_UECapabilityManagement service. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nucmf-ucm//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|-----------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1. | +| subscriptionId | String identifies an individual subscription in the UCMF. | + +##### 6.1.3.5.3 Resource Standard Methods + +###### 6.1.3.5.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.5.3.2-1. + +**Table 6.1.3.5.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.2-2 and the response data structures and response codes specified in table 6.1.3.5.3.2-3. + +**Table 6.1.3.5.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.5.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate the following application error:
- SUBSCRIPTION NOT_FOUND. | + +NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +**Table 6.1.3.5.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.5.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same UCMF or UCMF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.5.4 Resource Custom Operations + +None. + +### 6.1.4 Custom Operations without associated resources + +None. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +#### 6.1.5.2 UCMF Notification + +##### 6.1.5.2.1 Description + +The UCMF Notification is used by the UCMF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications via the Individual Notification Subscription Resource. + +##### 6.1.5.2.2 Target URI + +The Callback URI "{ucmfNotificationUri}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables for this resource** + +| Name | Definition | +|---------------------|----------------------------------------------------| +| ucmfNotificationUri | String formatted as URI with the UCMF Callback Uri | + +##### 6.1.5.2.3 Standard Methods + +###### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-1. + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|---------------------------------------------| +| UcmfNotification | M | 1 | Represents the notification to be delivered | + +**Table 6.1.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 6.1.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +**Table 6.1.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nucmf\_UECapabilityManagement service based interface protocol. + +**Table 6.1.6.1-1: Nucmf\_UECapabilityManagement specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------------|----------------|-------------------------------------------------------------------|---------------| +| DicEntryData | 6.1.6.2.2 | A dictionary entry for a UE radio capability ID in the UCMF | | +| DicEntryCreateData | 6.1.6.2.3 | Data for a creating a dictionary entry request | | +| DicEntryCreatedData | 6.1.6.2.4 | Data for a creating a dictionary entry response | | +| UeRadioCapId | 6.1.6.2.5 | UE Radio Capability ID | | +| CreateSubscription | 6.1.6.2.6 | Data for a creating a subscription request | | +| CreatedSubscription | 6.1.6.2.7 | Data for a creating a subscription response | | +| UcmfNotification | 6.1.6.2.8 | Data for a notification request from a UCMF | | +| ManAssOpRequestList | 6.1.6.2.9 | Manufacturer Assigned operation requested list | | +| EventType | 6.1.6.3.3 | | | +| RacFormat | 6.1.6.3.4 | The encoding type of the UE's Radio Access Capability Information | | + +Table 6.1.6.1-2 specifies data types re-used by the Nucmf\_UECapabilityManagement service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the N service based interface. + +**Table 6.1.6.1-2: Nucmf\_UECapabilityManagement re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|---------------------------------------------------------|---------------| +| PlmnAssiUeRadioCapId | 3GPP TS 29.571 [14] | PLMN Assigned UE Radio Capability ID | | +| ManAssiUeRadioCapId | 3GPP TS 29.571 [14] | Manufacturer Assigned UE Radio Capability ID | | +| TypeAllocationCode | 3GPP TS 29.571 [14] | Type Allocation Code | | +| NfInstanceId | 3GPP TS 29.571 [14] | NF Instance ID | | +| DateTime | 3GPP TS 29.571 [14] | A date-time format defined in OpenAPI Specification [6] | | +| SupportedFeatures | 3GPP TS 29.571 [14] | Supported Features | | +| ProblemDetails | 3GPP TS 29.571 [14] | Detailed problems in failure case | | +| RedirectResponse | 3GPP TS 29.571 [14] | Response body of the redirect response message. | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: DicEntryData + +**Table 6.1.6.2.2-1: Definition of type DicEntryData** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dicEntryId | DicEntryId | C | 0..1 | Identifier of the Dictionary Entry | +| plmnAssiUeRadioCapId | PlmnAssiUeRadioCapId | C | 0..1 | This IE shall include a PLMN Assigned UE Radio Capability ID if allocated in the dictionary entry. | +| manAssiUeRadioCapId | ManAssiUeRadioCapId | C | 0..1 | This IE shall include a Manufacturer Assigned UE Radio Capability ID if available in the dictionary entry. | +| typeAllocationCode | TypeAllocationCode | M | 1 | This IE shall contain the Type Allocation Code in corresponding to the UE Radio Access Capability in the dictionary entry. | +| ueRadioCapability5GS | RefToBinaryData | C | 0..1 | This IE shall be included to contain the UE Radio Access Capability Information encoded either as OCTET STRING of UE Radio Capability IE as specified in clause 9.3.1.74 of 3GPP TS 38.413 [15], when the message is sent to AMF, otherwise it may be included. | +| ueRadioCapabilityEPS | RefToBinaryData | C | 0..1 | This IE shall be included to contain the UE Radio Access Capability Information encoded as OCTET STRING of UE Radio Capability IE as specified in clause 9.2.1.27 of 3GPP TS 36.413 [x], when the message is sent to MME, otherwise it may be included. | +| ueRadioCap5GSForPaging | RefToBinaryData | O | 0..1 | May be present if ueRadioCapability5GS is present. If present it shall contain the UE Radio Access Capability Information for paging encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.3.1.68 of 3GPP TS 38.413 [15], when the message is sent to AMF | +| ueRadioCapEPSForPaging | RefToBinaryData | O | 0..1 | May be present if ueRadioCapabilityEPS is present. If present it shall contain the UE Radio Access Capability Information for paging encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.2.1.98 of 3GPP TS 36.413 [17], when the message is sent to MME, otherwise it may be included. | +| NOTE: The information in the dictionary entry which is included as the query parameter(s) or URI variable in the request message shall not be present. | | | | | + +##### 6.1.6.2.3 Type: DicEntryCreateData + +Table 6.1.6.2.3-1: Definition of type DicEntryCreateData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| typeAllocationCode | TypeAllocationCode | M | 1 | This IE shall contain the Type Allocation Code in corresponding to the UE Radio Access Capability in the dictionary entry. | +| ueRadioCapability5GS | RefToBinaryData | C | 0..1 | This IE shall be included to contain the UE Radio Access Capability Information encoded as OCTET STRING of UE Radio Capability IE specified in clause 9.3.1.74 of 3GPP TS 38.413 [15]. | +| ueRadioCapabilityEPS | RefToBinaryData | C | 0..1 | This IE shall be included to contain the UE Radio Access Capability Information encoded as OCTET STRING of UE Radio Capability IE specified in clause 9.2.1.27 of 3GPP TS 36.413 [17]. (NOTE) | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | +| ueRadioCap5GSForPaging | RefToBinaryData | O | 0..1 | May be present if ueRadioCapability5GS is present. If present it shall contain the UE Radio Access Capability Information for paging encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.3.1.68 of 3GPP TS 38.413 [15]. | +| ueRadioCapEPSForPaging | RefToBinaryData | O | 0..1 | May be present if ueRadioCapabilityEPS is present. If present it shall contain the UE Radio Access Capability Information for paging encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.2.1.98 of 3GPP TS 36.413 [17]. | + +NOTE: At least one of ueRadioCapability5GS or ueRadioCapabilityEPS shall be present. + +##### 6.1.6.2.4 Type: DicEntryCreatedData + +Table 6.1.6.2.4-1: Definition of type DicEntryCreatedData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|----------------------------------------------------------------------------| +| plmnAssiUeRadioCapId | PlmnAssiUeRadioCapId | M | 1 | This IE shall include a PLMN Assigned UE Radio Capability ID if allocated. | + +##### 6.1.6.2.5 Type: UeRadioCapId + +Table 6.1.6.2.5-1: Definition of type UeRadioCapId + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|------------------------------------------------------------------------------| +| plmnAssiUeRadioCapId | PlmnAssiUeRadioCapId | C | 0..1 | This IE shall include a PLMN Assigned UE Radio Capability ID. (NOTE) | +| manAssiUeRadioCapId | ManAssiUeRadioCapId | C | 0..1 | This IE shall include a Manufacturer Assigned UE Radio Capability ID. (NOTE) | + +NOTE: Only one of plmnAssiUeRadioCapId and manAssiUeRadioCapId shall be present during retrieving UE Radio Access Capability Information. (See clause 6.1.3.2.3.1) + +##### 6.1.6.2.6 Type: CreateSubscription + +Table 6.1.6.2.6-1: Definition of type CreateSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------| +| nflId | NfInstanceId | C | 0..1 | This IE shall contain the NF Instance ID of the service consumer, e.g. an AMF, if it is available. | +| ucmfNotificationUri | Uri | M | 1 | This IE shall contain the callback URI on which the subscribed events shall be notified. | +| suggestedExpires | DateTime | O | 0..1 | If present, indicates the point in time at which the subscription expires, which is suggested by the service consumer. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +##### 6.1.6.2.7 Type: CreatedSubscription + +Table 6.1.6.2.7-1: Definition of type CreatedSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------| +| dicEntryId | DicEntryId | M | 1 | This IE shall contain the highest DicEntryId has been allocated in the UCMF. | +| confirmedExpires | DateTime | O | 0..1 | If present, indicates the point in time at which the subscription expires, which is confirmed by the service producer. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +##### 6.2.6.2.8 Type: UcmfNotification + +Table 6.2.6.2.8-1: Definition of type UcmfNotification + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dicEntryId | DicEntryId | M | 1 | This IE shall contain the highest DicEntryId has been allocated in the UCMF. | +| eventType | EventType | M | 1 | This IE shall contain the different events type included in the notification. | +| manAssOpRequestlist | ManAssOpRequestlist | C | 0..1 | This IE shall be present to contain the Manufacturer Assigned operation requested list which includes a list of PLMN Assigned UE Radio Capability IDs or a list of TACs if the event type indicates the deletion of one or more PLMN Assigned UE Radio Capability IDs as specified in 3GPP TS 23.501 [2]. | +| versionId | Uinteger | O | 0..1 | Uinteger with the range between 0 and 255.

This IE may be present if eventType indicates to notify a new version id of PLMN Assigned UE Radio Capability Id(s). | + +##### 6.2.6.2.9 Type: ManAssOpRequestList + +**Table 6.2.6.2.9-1: Definition of type DelPlmnAssiUeRadioCapIdData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| plmnAssiUeRadioCapId | array(PlmnAssiUeRadioCapId) | C | 0..N | This IE shall contain one or more PLMN Assigned UE Radio Capability IDs to be deleted. (NOTE)

The UCMF shall always provide a complete list of PLMN Assigned UE Radio Capability IDs to enable the AMF to overwrite the existing list. | +| typeAllocationCode | array (TypeAllocationCode) | C | 0..N | This IE shall contain one or more Type Allocation Code in corresponding to the PLMN Assigned UE Radio Capability IDs to be deleted. (NOTE)

The UCMF shall always provide a complete list of Type Allocation Codes to enable the AMF to overwrite the existing list. | + +NOTE: Either plmnAssiUeRadioCapId or typeAllocationCode shall be present, not for both. + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|------------|-----------------|----------------------------------|---------------| +| DicEntryId | Integer | integer with range 1-4294967295. | | + +##### 6.1.6.3.3 Enumeration: EventType + +The enumeration EventType represents different type of events included in a notification from the UCMF. It shall comply with the provisions defined in table 6.1.5.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration EventType** + +| Enumeration value | Description | Applicability | +|---------------------------------------|---------------------------------------------------------------------|---------------| +| "CREATION_OF_DICTIONARY_ENTRY" | New dictionary entries are created in the UCMF. | | +| "DELETION_OF_PLMN_ASSIGNED_IDS" | One or more PLMN-assigned UE Radio Capability IDs are deleted. | | +| "NEW_VERSION_ID_OF_PLMN_ASSIGNED_IDS" | Notify a new version id of PLMN Assigned UE Radio Capability Id(s). | | + +##### 6.1.6.3.4 Enumeration: RacFormat + +The enumeration RacFormat represents the encoding type of the UE's Radio Access Capability Information. + +**Table 6.1.6.3.4-1: Enumeration racFormat** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "5GS" | This value indicates UE Radio Access Capability Information shall be encoded as OCTET STRING of UE Radio Capability IE specified in clause 9.3.1.74 of 3GPP TS 38.413 [15]. | | +| "EPS" | This value indicates UE Radio Access Capability Information shall be encoded as OCTET STRING of UE Radio Capability IE specified in clause 9.2.1.27 of 3GPP TS 36.413 [17]. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +None. + +#### 6.1.6.5 Binary data + +##### 6.1.6.5.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.1.2.2.2 and 6.1.2.4). + +##### 6.1.6.5.2 UE Radio Capability Information + +UeRadioCapability5GS shall be encoded with the OCTET STRING of UE Radio Capability IE (i.e. excluding the IEI, Criticality and octet string length indicator, see also Annex B of 3GPP TS 29.274 [16]) as specified in clause 9.3.1.74 of 3GPP TS 38.413 [15], using the vnd.3gpp.ngap content-type. + +UeRadioCapabilityEPS shall be encoded with the OCTET STRING of UE Radio Capability IE (i.e. excluding the IEI, Criticality and octet string length indicator, see also Annex B of 3GPP TS 29.274 [16]) as specified in clause 9.2.1.27 of 3GPP TS 36.413 [17], using the vnd.3gpp.slap content-type. + +ueRadioCap5GSForPaging shall be encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.3.1.68 of 3GPP TS 38.413 [15]. + +ueRadioCapEPSForPaging shall be encoded as OCTET STRING of UE Radio Capability for Paging IE as specified in clause 9.2.1.98 of 3GPP TS 36.413 [17]. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nucmf\_UECapabilityManagement API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nucmf\_UECapabilityManagement API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nucmf\_UECapabilityManagement service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nucmf\_UECapabilityManagement service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------------------|------------------|------------------------------------------------------------------------------------| +| NO_DICTIONARY_ENTRY_FOUND | 404 | There is no dictionary entry matching the UE Radio Capability ID in query. | +| OUT_DATED_VERSION_ID_IN_RAC_ID | 404 | The version id in the requested PLMN Assigned UE Radio Capability Id is out-dated. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nucmf\_UECapabilityManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the UECapabilityManagement service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nucmf\_UECapabilityManagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nucmf\_UECapabilityManagement API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nucmf\_UECapabilityManagement service. + +The Nucmf\_UECapabilityManagement API defines the following scopes for OAuth2 authorization. + +**Table 6.1.9-1: Oauth2 scopes defined in Nucmf\_UECapabilityManagement API** + +| Scope | Description | +|----------------------------------|------------------------------------------------| +| "nucmf-uecm" | Access to the Nucmf_UECapabilityManagement API | +| "nucmf-uecm:dictionary:read" | Access to read dictionaries | +| "nucmf-uecm:dictionary:create" | Access to create dictionary entries | +| "nucmf-uecm:subscription:create" | Access to create subscriptions | +| "nucmf-uecm:subscription:modify" | Access to update subscriptions | + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different UCMF service instance, within the same UCMF or a different UCMF of an UCMF set, e.g. when an UCMF service instance is part of an UCMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.1.8. + +An SCP that reselects a different UCMF producer instance will return the NF Instance ID of the new UCMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an UCMF within an UCMF set redirects a service request to a different UCMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new UCMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## --- A.2 Nucmf\_UECapabilityManagement API + +``` +openapi: 3.0.0 + +info: + title: Nucmf_UECapabilityManagement + version: 1.2.0-alpha.1 + description: | + Nucmf_UECapabilityManagement Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.673 V18.0.0; 5G System; UE Radio Capability Management Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.673/' + +servers: + - url: '{apiRoot}/nucmf-uecm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nucmf-uecm + +paths: + /dic-entries: + get: + summary: retrieve a dictionary entry matching query parameters + operationId: RetrieveDictionaryEntry + tags: + - Dictionary Entry (Store) + security: + - {} + - oAuth2ClientCredentials: + - nucmf-uecm + - oAuth2ClientCredentials: + - nucmf-uecm + - nucmf-uecm:dictionary:read + parameters: + - name: ue-radio-capa-id +``` + +``` + +in: query +required: true +description: UE Radio Capability ID, either PLMN Assigned or Manufacturer Assigned +schema: + $ref: '#/components/schemas/UeRadioCapaId' +- name: rac-format + in: query + description: Encoding format of RAC Info + schema: + $ref: '#/components/schemas/RacFormat' +- name: supported-features + in: query + description: supported features of the NF consumer + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Expected response to a valid request + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/DicEntryData' + binaryDataUeRadioCapability5GS: + type: string + format: binary + binaryDataUeRadioCapabilityEPS: + type: string + format: binary + binaryDataUeRadioCap5GSForPaging: + type: string + format: binary + binaryDataUeRadioCapEPSForPaging: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataUeRadioCapability5GS: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCapabilityEPS: + contentType: application/vnd.3gpp.slap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCap5GSForPaging: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCapEPSForPaging: + contentType: application/vnd.3gpp.slap + headers: + Content-Id: + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + +``` + +``` + + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +post: + summary: Create a dictionary entry in the UCMF + tags: + - a dictionary entry (Document) + operationId: CreateDictionaryEntry + security: + - {} + - oAuth2ClientCredentials: + - nucmf-uecm + - oAuth2ClientCredentials: + - nucmf-uecm + - nucmf-uecm:dictionary:create + requestBody: + content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/DicEntryCreateData' + binaryDataUeRadioCapability5GS: + type: string + format: binary + binaryDataUeRadioCapabilityEPS: + type: string + format: binary + binaryDataUeRadioCap5GSForPaging: + type: string + format: binary + binaryDataUeRadioCapEPSForPaging: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataUeRadioCapability5GS: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCapabilityEPS: + contentType: application/vnd.3gpp.slap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCap5GSForPaging: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCapEPSForPaging: + contentType: application/vnd.3gpp.slap + headers: + Content-Id: + schema: + type: string + +``` + +``` + +responses: + '201': + description: Dictionary Created + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nucmf-uecm/{apiVersion}/dic-entries/{dicEntryId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DicEntryCreatedData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/dic-entries/{dicEntryId}: + get: + summary: Get an individual dictionary entry via dicEntryId + operationId: GetDicEntry + tags: + - dic Entry Id (Document) + security: + - {} + - oAuth2ClientCredentials: + - nucmf-uecm + - oAuth2ClientCredentials: + - nucmf-uecm + - nucmf-uecm:dictionary:read + parameters: + - name: dicEntryId + in: path + description: the ID of a dictionary entry in the UCMF + required: true + schema: + $ref: '#/components/schemas/DicEntryId' + - name: rac-format + in: query + description: Encoding format of of RAC Info + schema: + $ref: '#/components/schemas/RacFormat' + - name: supported-features + in: query + description: supported features of the NF consumer + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + +``` + +``` + +content: + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/DicEntryData' + binaryDataUeRadioCapability5GS: + type: string + format: binary + binaryDataUeRadioCapabilityEPS: + type: string + format: binary + binaryDataUeRadioCap5GSForPaging: + type: string + format: binary + binaryDataUeRadioCapEPSForPaging: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataUeRadioCapability5GS: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCapabilityEPS: + contentType: application/vnd.3gpp.slap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCap5GSForPaging: + contentType: application/vnd.3gpp.ngap + headers: + Content-Id: + schema: + type: string + binaryDataUeRadioCapEPSForPaging: + contentType: application/vnd.3gpp.slap + headers: + Content-Id: + schema: + type: string + +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +``` + +``` + +/subscriptions: + post: + summary: Nucmf_UECapabilityManagement Subscribe service Operation + operationId: CreateIndividualSubscription + tags: + - Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nucmf-uecm + - oAuth2ClientCredentials: + - nucmf-uecm + - nucmf-uecm:subscription:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSubscription' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nucmf-uecm//subscriptions/{subscriptionId}' + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + myNotification: + '{ $request.body#/ucmfNotificationUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UcmfNotification' + responses: + '204': + description: No Content, Notification was successfull + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + +``` + +``` + + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + delete: + summary: unsubscribe from notifications + operationId: DeleteIndividualSubscription + tags: + - IndividualSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nucmf-uecm + - oAuth2ClientCredentials: + - nucmf-uecm + - nucmf-uecm:subscription:modify + parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + +``` + +``` + +flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nucmf-uecm: Access to the Nucmf_UECapabilityManagement API + nucmf-uecm:dictionary:read: Access to read dictionaries + nucmf-uecm:dictionary:create: Access to create dictionary entities + nucmf-uecm:subscription:create: Access to create subscriptions + nucmf-uecm:subscription:modify: Access to update subscriptions + +schemas: + DicEntryData: + description: A dictionary entry for a UE radio capability ID in the UCMF + type: object + required: + - typeAllocationCode + properties: + dicEntryId: + $ref: '#/components/schemas/DicEntryId' + typeAllocationCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TypeAllocationCode' + plmnAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId' + manAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ManAssiUeRadioCapId' + ueRadioCapability5GS: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ueRadioCapabilityEPS: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ueRadioCap5GSForPaging: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ueRadioCapEPSForPaging: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + + DicEntryCreateData: + description: Data for a creating a dictionary entry request + type: object + required: + - typeAllocationCode + properties: + typeAllocationCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TypeAllocationCode' + ueRadioCapability5GS: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ueRadioCapabilityEPS: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + ueRadioCap5GSForPaging: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + ueRadioCapEPSForPaging: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + + DicEntryCreatedData: + description: Data for a creating a dictionary entry response + type: object + required: + - plmnAssiUeRadioCapId + properties: + plmnAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId' + + UeRadioCapaId: + description: UE Radio Capability ID + type: object + properties: + plmnAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId' + manAssiUeRadioCapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ManAssiUeRadioCapId' + + CreateSubscription: + description: Data for a creating a subscription request + type: object + required: + - ucmfNotificationUri + +``` + +``` + +properties: + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + ucmfNotificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + suggestedExpires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +CreatedSubscription: + description: Data for a creating a subscription response + type: object + required: + - dicEntryId + properties: + dicEntryId: + $ref: '#/components/schemas/DicEntryId' + confirmedExpires: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +UcmfNotification: + description: Data for a notification request from a UCMF + type: object + required: + - dicEntryId + - eventType + properties: + dicEntryId: + $ref: '#/components/schemas/DicEntryId' + eventType: + $ref: '#/components/schemas/EventType' + manAssOpRequestList: + $ref: '#/components/schemas/manAssOpRequestList' + minItems: 1 + versionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +manAssOpRequestList: + description: Manufacturer Assigned operation requested list + type: object + oneOf: + - required: [plmnAssiUeRadioCapId] + - required: [typeAllocationCod] + properties: + plmnAssiUeRadioCapId: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId' + minItems: 1 + typeAllocationCode: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TypeAllocationCode' + +# +# SIMPLE DATA TYPES +# + DicEntryId: + type: integer + minimum: 0 + maximum: 4294967295 + +# +# ENUMERATIONS +# + EventType: + anyOf: + - type: string + enum: + - CREATION_OF_DICTIONARY_ENTRY + - DELETION_OF_PLMN_ASSIGNED_IDS + - NEW_VERSION_ID_OF_PLMN_ASSIGNED_IDS + - type: string + +``` + +``` +RacFormat: + anyOf: + - type: string + enum: + - 5GS + - EPS + - type: string +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2019-09 | CT4#93 | C4-193849 | | | | Initial draft | 0.1.0 | | +| 2019-10 | CT4#94 | C4-194356 | | | | Subscribe, Unsubscribe and Notify | 0.2.0 | | +| 2019-10 | CT4#94 | C4-194357 | | | | Individual dictionary entry resource | 0.2.0 | | +| 2019-11 | CT4#95 | C4-195436 | | | | Data type and openAPI related to Resolve, Assign | 0.3.0 | | +| 2019-11 | CT4#95 | C4-195438 | | | | Data type and openAPI related to (un)Subscribe/Notify | 0.3.0 | | +| 2019-12 | CT#86 | CP-193069 | | | | TS presented for information | 1.0.0 | | +| 2020-03 | CT4#96e | C4-200622 | | | | UcmfNotification for deletion | 1.1.0 | | +| 2020-03 | CT4#96e | C4-200623 | | | | Other alignment with stage 2 requirements | 1.1.0 | | +| 2020-03 | CT#87e | CP-200067 | | | | TS presented for approval | 2.0.0 | | +| 2020-03 | CT#87e | | | | | Approved at CT#87e | 16.0.0 | | +| 2020-06 | CT#88e | CP-201279 | 0001 | 2 | B | Multiple RAC Coding Format Support in RACS Operation | 16.1.0 | | +| 2020-06 | CT#88e | CP-201035 | 0003 | | F | Storage of YAML files in ETSI Forge | 16.1.0 | | +| 2020-06 | CT#88e | CP-201035 | 0004 | | B | New application error at receiving out-dated UE RAC-ID | 16.1.0 | | +| 2020-06 | CT#88e | CP-201035 | 0005 | 1 | B | Populating New Version Id via Notification | 16.1.0 | | +| 2020-06 | CT#88e | CP-201187 | 0006 | | F | 3GPP TS 29.673 API version update Rel-16 | 16.1.0 | | +| 2020-09 | CT#89e | CP-202108 | 0007 | | F | DicEntryId in DicEntryData | 16.2.0 | | +| 2020-09 | CT#89e | CP-202108 | 0008 | | F | UE Radio Capability ID retrieval | 16.2.0 | | +| 2020-09 | CT#89e | CP-202108 | 0009 | | F | Optionality of ProblemDetails in TS29.673 cleanup | 16.2.0 | | +| 2020-09 | CT#89e | CP-202096 | 0010 | | F | 29.673 Rel-16 API version and External doc update | 16.2.0 | | +| 2020-12 | CT#90e | CP-203047 | 0011 | 1 | F | TAC is mandatory in DicEntryData | 16.3.0 | | +| 2020-12 | CT#90e | CP-203036 | 0012 | | F | 29.673 Rel-16 API version and External doc update | 16.3.0 | | +| 2021-03 | CT#91e | CP-210043 | 0014 | | F | Storage of YAML files | 17.0.0 | | +| 2021-03 | CT#91e | CP-210037 | 0015 | 1 | F | HTTP 3xx redirection | 17.0.0 | | +| 2021-03 | CT#91e | CP-210034 | 0016 | 1 | F | OpenAPI Reference | 17.0.0 | | +| 2021-03 | CT#91e | CP-210054 | 0018 | | F | 29.673 Rel-16 API version and External doc update | 17.0.0 | | +| 2021-06 | CT#92e | CP-211028 | 0019 | | F | Data Type Description for Nucmf_UECapabilityManagement Service API | 17.1.0 | | +| 2021-06 | CT#92e | CP-211028 | 0021 | 1 | F | EventType Data Type | 17.1.0 | | +| 2021-06 | CT#92e | CP-211059 | 0023 | | A | Redirect Response for Nucmf_UECapabilityManagement | 17.1.0 | | +| 2021-06 | CT#92e | CP-211050 | 0024 | | F | 29.673 Rel-17 API version and External doc update | 17.1.0 | | +| 2021-09 | CT#93e | CP-212065 | 0027 | 1 | A | Handling of UE Radio Capability for Paging | 17.2.0 | | +| 2021-09 | CT#93e | CP-212060 | 0029 | | A | 3xx description correction for SCP | 17.2.0 | | +| 2021-09 | CT#93e | CP-212059 | 0030 | | F | 29.673 Rel-17 API version and External doc update | 17.2.0 | | +| 2021-12 | CT#94e | CP-213120 | 0034 | | F | 307/308 redirection | 17.3.0 | | +| 2021-12 | CT#94e | CP-213130 | 0033 | 1 | A | Binary Information for UE Radio Capability for Paging | 17.3.0 | | +| 2021-12 | CT#94e | CP-213121 | 0035 | | F | 29.673 Rel-17 API version and External doc update | 17.3.0 | | +| 2022-06 | CT#96e | CP-221051 | 0038 | | F | 29.673 Rel-17 API version and External doc update | 17.4.0 | | +| 2022-12 | CT#98 | CP-223028 | 0040 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | | +| 2022-12 | CT#98 | CP-223033 | 0041 | | F | 29.673 Rel-18 API version and External doc update | 18.0.0 | | +| 2023-06 | CT#100 | CP-231026 | 0042 | 2 | F | Location header description | 18.1.0 | | +| 2023-06 | CT#100 | CP-231027 | 0044 | 1 | B | OAuth2 scopes in the Nucmf API | 18.1.0 | | +| 2023-12 | CT#102 | CP-233031 | 0046 | 1 | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.2.0 | | +| 2023-12 | CT#102 | CP-233031 | 0047 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.2.0 | | \ No newline at end of file diff --git a/raw/rel-18/29_series/29675/raw.md b/raw/rel-18/29_series/29675/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..625e2bf7795a368d099561393d33201521775f31 --- /dev/null +++ b/raw/rel-18/29_series/29675/raw.md @@ -0,0 +1,1308 @@ + + +# 3GPP TS 29.675 V18.3.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; User Equipment (UE) radio capability provisioning service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green wave-like graphic above the 'G', and the word 'ADVANCED' in small capital letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'G' has a red signal icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in small capital letters. + +3GPP logo + +## --- Keywords --- + +### **3GPP** + +### --- Postal address --- + +### 3GPP support office address --- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- Internet --- + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 UE Radio Capability Provisioning Service..... | 8 | +| 4.1 Service Description ..... | 8 | +| 4.1.1 Overview ..... | 8 | +| 4.1.2 Service Architecture ..... | 8 | +| 4.1.3 Network Functions ..... | 9 | +| 4.1.3.1 UCMF ..... | 9 | +| 4.1.3.2 NF Service Consumers ..... | 9 | +| 4.2 Service Operations ..... | 9 | +| 4.2.1 Introduction ..... | 9 | +| 4.2.2 Nucmf_Provisioning_Create service operation..... | 10 | +| 4.2.2.1 General..... | 10 | +| 4.2.2.2 Creating UE radio capability provisioning resource..... | 10 | +| 4.2.3 Nucmf_Provisioning_Update service operation..... | 11 | +| 4.2.3.1 General..... | 11 | +| 4.2.3.2 Modifying a UE radio capability provisioning resource ..... | 11 | +| 4.2.4 Nucmf_Provisioning_Delete service operation..... | 12 | +| 4.2.4.1 General..... | 12 | +| 4.2.4.2 Removing a UE radio capability provisioning resource..... | 12 | +| 5 Nucmf_Provisioning Service API..... | 12 | +| 5.1 Introduction ..... | 12 | +| 5.2 Usage of HTTP..... | 13 | +| 5.2.1 General ..... | 13 | +| 5.2.2 HTTP standard headers ..... | 13 | +| 5.2.2.1 General..... | 13 | +| 5.2.2.2 Content type ..... | 13 | +| 5.2.3 HTTP custom headers ..... | 13 | +| 5.3 Resources ..... | 14 | +| 5.3.1 Overview ..... | 14 | +| 5.3.2 Resource: UE radio capability provisioning (Collection)..... | 14 | +| 5.3.2.1 Description..... | 14 | +| 5.3.2.2 Resource Definition ..... | 14 | +| 5.3.2.3 Resource Standard Methods ..... | 15 | +| 5.3.2.3.1 POST ..... | 15 | +| 5.3.2.4 Resource Custom Operations..... | 15 | +| 5.3.3 Resource: Individual UE radio capability provisioning (Document)..... | 15 | +| 5.3.3.1 Description..... | 15 | +| 5.3.3.2 Resource Definition ..... | 15 | +| 5.3.3.3 Resource Standard Methods ..... | 16 | +| 5.3.3.3.1 GET ..... | 16 | +| 5.3.3.3.2 PUT ..... | 17 | +| 5.3.3.3.3 PATCH..... | 18 | +| 5.3.3.3.4 DELETE..... | 19 | +| 5.4 Custom Operations without associated resources ..... | 20 | +| 5.5 Notifications ..... | 20 | +| 5.6 Data Model..... | 21 | +| 5.6.1 General ..... | 21 | +| 5.6.2 Structured data types ..... | 21 | + +| | | | +|---------------------------------------------------------|------------------------------------------|-----------| +| 5.6.2.1 | Introduction..... | 21 | +| 5.6.2.2 | Type: RacsData..... | 21 | +| 5.6.2.3 | Type: RacsDataPatch..... | 22 | +| 5.6.3 | Simple data types and enumerations ..... | 22 | +| 5.6.3.1 | Introduction..... | 22 | +| 5.6.3.2 | Simple data types ..... | 22 | +| 5.7 | Error Handling..... | 23 | +| 5.7.1 | General ..... | 23 | +| 5.7.2 | Protocol Errors..... | 23 | +| 5.7.3 | Application Errors ..... | 23 | +| 5.8 | Feature negotiation..... | 23 | +| 5.9 | Security..... | 23 | +| Annex A (normative): OpenAPI specification ..... | | 24 | +| A.1 | General..... | 24 | +| A.2 | Nucmf_Provisioning API..... | 24 | +| Annex B (informative): Change history ..... | | 29 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- Y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +**shall** indicates a mandatory requirement to do something + +**shall not** indicates an interdiction (prohibition) to do something + +NOTE 1: The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +NOTE 2: The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +**Should** indicates a recommendation to do something + +**should not** indicates a recommendation not to do something + +**may** indicates permission to do something + +**need not** indicates permission not to do something + +NOTE 3: The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +**Can** indicates that something is possible + +**cannot** indicates that something is impossible + +NOTE 4: The constructions "can" and "cannot" shall not to be used as substitutes for "may" and "need not". + +**Will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +NOTE 5: The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nucmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the UCMF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The Oauth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [15] 3GPP TS 29.122: "T8 reference point for northbound Application Programming Interfaces (APIs)". +- [16] IETF RFC 7396: "JSON Merge Patch". +- [17] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Symbols + +No symbol is defined in the present document. + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|--------------------------------------------| +| AF | Application Function | +| IMEI-TAC | Type Allocation Code part of an IMEI | +| NEF | Network Exposure Function | +| NF | Network Function | +| RACS | Radio Capabilities Signalling optimisation | +| UCMF | UE radio Capability Management Function | + +# --- 4 UE Radio Capability Provisioning Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The UE radio capability provisioning service, as defined in 3GPP TS 23.502 [3], is provided by the UE radio Capability Management Function (UCMF). + +This service: + +- allows NF service consumers to create, update and delete UCMF dictionary entries for Manufacturer-assigned UE Radio Capability IDs. + +### 4.1.2 Service Architecture + +The Service Architecture is defined in 3GPP TS 23.501 [2]. + +The UE radio capability provisioning service (Nucmf\_Provisioning) is part of the Nucmf service-based interface exhibited by the UCMF. + +The known NF service consumers of the Nucmf\_Provisioning service are: + +- Network Exposure Function (NEF); and +- Application Function (AF). + +The Nucmf\_Provisioning service is provided by the UCMF and consumed by the NEF and the AF, as shown in figure 4.1.2-1 for the SBI representation model and in figure 4.1.2-2 for reference point representation model. + +![Figure 4.1.2-1: Nucmf_Provisioning service Architecture, SBI representation](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +A diagram showing the SBI representation of the Nucmf\_Provisioning service architecture. At the top, a box labeled 'UCMF' contains an oval labeled 'Nucmf'. A vertical line labeled 'Nucmf\_Provisioning' connects the 'Nucmf' oval to a horizontal bus line. Below the bus line, two boxes labeled 'AF' and 'NEF' are connected to it. + +Figure 4.1.2-1: Nucmf\_Provisioning service Architecture, SBI representation + +Figure 4.1.2-1: Nucmf\_Provisioning service Architecture, SBI representation + +![Figure 4.1.2-2: Nucmf_Provisioning service Architecture, reference point representation](367926125450c2bc3f4bdca9d59a62ba_img.jpg) + +A diagram showing the reference point representation of the Nucmf\_Provisioning service architecture. At the top, a box labeled 'UCMF' is connected to two boxes below it, 'AF' and 'NEF'. The connection to 'AF' is labeled 'N57' and the connection to 'NEF' is labeled 'N56'. + +Figure 4.1.2-2: Nucmf\_Provisioning service Architecture, reference point representation + +Figure 4.1.2-2: Nucmf\_Provisioning service Architecture, reference point representation + +### 4.1.3 Network Functions + +#### 4.1.3.1 UCMF + +The UCMF is a functional element that provides service to the NF service consumer. + +It allows NF consumers to provision (create, update and delete) UCMF dictionary entries for Manufacturer-assigned UE Radio Capability IDs. + +#### 4.1.3.2 NF Service Consumers + +The Network Exposure Function (NEF): + +- Provision (create, update and delete) UCMF dictionary entries for Manufacturer-assigned UE Radio Capability IDs to the UCMF, if it receives the UE Radio Capability information from the untrusted AF. + +The Application Function (AF): + +- As the trusted AF, provision (create, update and delete) UCMF dictionary entries for Manufacturer-assigned UE Radio Capability IDs to the UCMF. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +Service operations defined for the Nucmf\_Provisioning Service are shown in table 4.2.1-1. + +Table 4.2.1-1: Nucmf\_Provisioning Service Operations + +| Service Operation Name | Description | Initiated by | +|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| Nucmf_Provisioning_Create | This service operation is used by an NF service consumer to create UE radio capability provisioning resource for Manufacturer-assigned UE Radio Capability IDs. | NF service consumer (e.g. AF, NEF) | +| Nucmf_Provisioning_Update | This service operation is used by an NF service consumer to modify UE radio capability provisioning resource for Manufacturer-assigned UE Radio Capability IDs. | NF service consumer (e.g. AF, NEF) | +| Nucmf_Provisioning_Delete | This service operation is used by an NF service consumer to remove a UE radio capability provisioning resource. | NF service consumer (e.g. AF, NEF) | + +### 4.2.2 Nucmf\_Provisioning\_Create service operation + +#### 4.2.2.1 General + +This service operation is used by an NF service consumer to create UE radio capability provisioning resource for Manufacturer-assigned UE Radio Capability IDs. + +The following procedure using the Nucmf\_Provisioning\_Create service operation is supported: + +- creating a UE radio capability provisioning resource. + +#### 4.2.2.2 Creating UE radio capability provisioning resource + +This procedure is used by the NF service consumer (e.g. NEF) to create a UE radio capability provisioning resource containing UCMF dictionary entries for Manufacturer-assigned UE Radio Capability IDs, as defined in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +![Sequence diagram showing the interaction between an NF service consumer and the UCMF to create a new UE radio capability provisioning resource. Step 1: POST .../provisionings from NF service consumer to UCMF. Step 2: 201 Created response from UCMF to NF service consumer.](fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant UCMF as UCMF + Note right of NF: 1. POST .../provisionings + NF->>UCMF: Request + Note left of UCMF: 2. "201 Created" + UCMF-->>NF: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and the UCMF to create a new UE radio capability provisioning resource. Step 1: POST .../provisionings from NF service consumer to UCMF. Step 2: 201 Created response from UCMF to NF service consumer. + +Figure 4.2.2.2-1: Creating new UE radio capability provisioning resource + +To create a UE radio capability provisioning resource, the NF service consumer shall send an HTTP POST request to the UCMF with: "{apiRoot}/nucmf-provisioning//provisionings" as request URI as shown in step 1 of figure 4.2.2.2-1, and the "RacsData" data structure as request body. The "RacsData" data type shall contain one or more RACS configurations in the "racsConfigs" attribute which include: + +- a RACS ID in the "racsId" attribute; +- UE radio capability information in the "racsParamEps" and/or "racsParam5Gs" attributes; and +- the related UE model(s) IMEI-TAC value(s) in the "imeiTacs" attribute. + +Upon reception of the HTTP POST message from the NF service consumer requesting to create UCMF dictionary entries, the UCMF shall, for each requested RACS ID, check if there is any existing dictionary entry having the same RACS ID. If yes, the UCMF shall indicate "RACS\_ID\_DUPLICATED" in the "result" attribute for the requested RACS ID; otherwise if there is no other error the UCMF shall create a UCMF dictionary entry. + +After processing all requested RACS IDs, if at least one UCMF dictionary entry is successfully provisioned, the UCMF shall create the resource "Individual UE radio capability provisioning" and respond "201 Created" as shown in step 2 of figure 4.2.2.2-1 with the successfully provisioned RACS information, the UCMF may include RACS report(s) within attribute "racsReports" with a list of RACS ID(s) and the corresponding failure code for which the provisioning has failed as specified in table 5.16.2.2.3-1 of 3GPP TS 29.122 [15] in the body of the HTTP response; otherwise the UCMF shall respond "500 Internal Server Error" and may include the RACS report(s) to indicate failure details. + +### 4.2.3 Nucmf\_Provisioning\_Update service operation + +#### 4.2.3.1 General + +This service operation is used by an NF service consumer to modify UE radio capability provisioning resource for Manufacturer-assigned UE Radio Capability IDs. + +The following procedure using the Nucmf\_Provisioning\_Update service operation is supported: + +- modifying an existing UE radio capability provisioning resource. + +#### 4.2.3.2 Modifying a UE radio capability provisioning resource + +![Sequence diagram showing the interaction between an NF service consumer and a UCMF to modify a UE radio capability provisioning resource. Step 1: The consumer sends a PUT or PATCH request to the UCMF. Step 2: The UCMF responds with a 200 OK status.](18442e4e239480f0c3c95b547aa8fde2_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant UCMF as UCMF + Note right of NF: 1. PUT or PATCH .../provisionings/{provisioningId} + NF->>UCMF: Request + Note left of UCMF: 2. "200 OK" + UCMF-->>NF: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and a UCMF to modify a UE radio capability provisioning resource. Step 1: The consumer sends a PUT or PATCH request to the UCMF. Step 2: The UCMF responds with a 200 OK status. + +Figure 4.2.3.2-1: Modifying a UE radio capability provisioning resource + +In order to modify a UE radio capability provisioning resource, i.e. add new UCMF dictionary entries, update and/or remove the existing UCMF dictionary entries for one or more RACS ID(s), the NF service consumer shall send an HTTP PUT or PATCH request to the UCMF with: "{apiRoot}/nucmf-provisioning/{apiVersion}/provisionings/{provisioningId}" as request URI as shown in step 1 of figure 4.2.3.2-1, and the "RacsData" or "RacsDataPatch" data structure as request body, correspondingly. The "RacsData" or "RacsDataPatch" data type shall contain one or more RACS configurations in the "racsConfigs" attribute which include: + +- a RACS ID in the "racsId" attribute; +- UE radio capability information in the "racsParamEps" and/or "racsParam5Gs" attributes; and +- the related UE model(s) IMEI-TAC value(s) in the "imeiTacs" attribute. + +Upon reception of the HTTP PUT message from the NF service consumer, the UCMF shall start replacing the existing UE radio capability provisioning resource and update the corresponding UCMF dictionary entr(ies). + +Upon reception of the HTTP PATCH message from the NF service consumer, the UCMF shall start modifying the existing UE radio capability provisioning resource: + +- remove RACS ID and its UE radio capability information with a NULL map key value, and the corresponding UCMF dictionary entry; +- replace the UE radio capability information for any existing RACS ID in the resource, and the corresponding UCMF dictionary entry; and/or +- create a UCMF dictionary entry for any new RACS ID if there is no ID conflict with other existing resources. + +After processing all requested RACS IDs, if at least one UCMF dictionary entry is successfully provisioned, the UCMF shall respond "200 OK" as shown in step 2 of figure 4.2.3.2-1 with the successfully provisioned RACS information, the UCMF may include RACS report(s) within attribute "racsReports" with a list of RACS ID(s) and the corresponding failure code for which the provisioning has failed as specified in table 5.16.2.2.3-1 of 3GPP TS 29.122 [15] in the body of the HTTP response; otherwise the UCMF shall respond "500 Internal Server Error" and may include the RACS report(s) to indicate failure details. + +If the feature "ES3XX" is supported, and the UCMF determines the received HTTP PUT or PATCH request needs to be redirected, the UCMF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +### 4.2.4 Nucmf\_Provisioning\_Delete service operation + +#### 4.2.4.1 General + +This service operation is used by an NF service consumer to remove UE radio capability provisioning resource for Manufacturer-assigned UE Radio Capability IDs. + +The following procedure using the Nucmf\_Provisioning\_Delete service operation is supported: + +- removing an existing UE radio capability provisioning resource. + +#### 4.2.4.2 Removing a UE radio capability provisioning resource + +![Sequence diagram showing the interaction between an NF service consumer and a UCMF to remove a UE radio capability provisioning resource. Step 1: The consumer sends a DELETE request to the UCMF. Step 2: The UCMF responds with a 204 No Content status.](63e0c22852c26699d0bd095a2d796bab_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant UCMF + Note right of NF service consumer: 1. DELETE .../provisionings/{provisioningId} + NF service consumer->>UCMF: 1. DELETE .../provisionings/{provisioningId} + Note left of UCMF: 2. "204 No Content" + UCMF-->>NF service consumer: 2. "204 No Content" +``` + +Sequence diagram showing the interaction between an NF service consumer and a UCMF to remove a UE radio capability provisioning resource. Step 1: The consumer sends a DELETE request to the UCMF. Step 2: The UCMF responds with a 204 No Content status. + +Figure 4.2.4.2-1: Removing a UE radio capability provisioning resource + +In order to remove a UE radio capability provisioning resource, the NF service consumer shall send an HTTP DELETE request to the UCMF with: "{apiRoot}/nucmf-provisioning//provisionings/{provisioningId}" as request URI as shown in step 1 of figure 4.2.4.2-1. + +Upon successful reception of the HTTP DELETE, the UCMF shall remove the corresponding resource and the corresponding UCMF dictionary entries, and send an HTTP "204 No Content" response as shown in step 2 of figure 4.2.4.2-1. + +If the UCMF cannot successfully fulfil the received HTTP DELETE request due to the internal error or the error in the HTTP DELETE request, the UCMF shall send the HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the UCMF determines the received HTTP DELETE request needs to be redirected, the UCMF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +# 5 Nucmf\_Provisioning Service API + +## 5.1 Introduction + +The UE radio capability provisioning service shall use the Nucmf\_Provisioning API. + +The API URI of the Nucmf\_Provisioning API shall be: + +**{apiRoot}
/** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}
//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nucmf-provisioning". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5.2 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nucmf\_Provisioning API is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" and shall be signalled by the content type "application/merge-patch+json", as defined in IETF RFC 7396 [16]. + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +### 5.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +In this Release of the specification, no specific custom headers are defined for the Nucmf\_Provisioning API. + +## 5.3 Resources + +### 5.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.3.1-1 depicts the resource URIs structure for the Nucmf\_Provisioning API. + +![Figure 5.3.1-1: Resource URI structure of the Nucmf_Provisioning API. The diagram shows a hierarchical structure starting with {apiRoot}/nucmf-provisioning/. A line branches down to a box containing /provisionings. From this box, another line branches down to a box containing /{provisioningId}.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nucmf-provisioning/"] --> Provisionings["/provisionings"] + Provisionings --> ProvisioningId["/{provisioningId}"] + +``` + +Figure 5.3.1-1: Resource URI structure of the Nucmf\_Provisioning API. The diagram shows a hierarchical structure starting with {apiRoot}/nucmf-provisioning/. A line branches down to a box containing /provisionings. From this box, another line branches down to a box containing /{provisioningId}. + +**Figure 5.3.1-1: Resource URI structure of the Nucmf\_Provisioning API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------------------------------|---------------------------------|---------------------------------|---------------------------------------------------------------| +| UE radio capability provisionings | /provisionings | POST | Create a UE radio capability provisioning resource. | +| Individual UE radio capability provisioning | /provisionings/{provisioningId} | GET | Read an existing UE radio capability provisioning resource. | +| | | PUT | Modify an existing UE radio capability provisioning resource. | +| | | PATCH | Modify an existing UE radio capability provisioning resource. | +| | | DELETE | Remove an existing UE radio capability provisioning resource. | + +### 5.3.2 Resource: UE radio capability provisionings (Collection) + +#### 5.3.2.1 Description + +The UE radio capability provisionings resource represents all the provisionings that exist in the UE radio capability provisioning service at a given UCMF instance. + +#### 5.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nucmf-provisioning//provisionings + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-----------------| +| apiRoot | string | See clause 5.1. | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|---------------------------------------------------------------------------------------------------| +| RacsData | M | 1 | Contains information for the creation of an Individual UE radio capability provisioning resource. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| RacsData | M | 1 | 201 Created | The creation of an Individual UE radio capability provisioning resource is confirmed and a representation of that resource is returned. | +| Array(RacsFailureReport) | M | 1..N | 500 Internal Server Error | The RACS data for all RACS IDs were not provisioned successfully. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nucmf-provisioning//provisionings/{provisioningId} | + +#### 5.3.2.4 Resource Custom Operations + +None. + +### 5.3.3 Resource: Individual UE radio capability provisioning (Document) + +#### 5.3.3.1 Description + +The Individual UE radio capability provisioning resource represents a single provisioning that exist in the UE radio capability provisioning service at a given UCMF instance. + +#### 5.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nucmf-provisioning//provisionings/{provisioningId} + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1. | +| provisioningId | string | Identifies the individual UE radio capability resource in the UCMF. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5] and rules for a path segment defined in IETF RFC 3986 [14]. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------| +| RacsData | M | 1 | 200 OK | A representation of an Individual UE radio capability provisioning resource is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource retrieval. Applicable if the feature "ES3XX" is supported. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource retrieval. Applicable if the feature "ES3XX" is supported. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative UCMF (service) instance towards which the request is redirected. For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the UCMF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative UCMF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the UCMF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-----------------------------------------------------------------------------------| +| RacsData | M | 1 | Contains the modification of an Individual UE radio capability provisioning data. | + +**Table 5.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------| +| RacsData | M | 1 | 200 OK | The Individual UE radio capability provisioning resource is modified and a representation of that resource is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource modification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource modification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| Array(RacsFailureReport) | M | 1..N | 500 Internal Server Error | The RACS data for all RACS IDs were not provisioned successfully. | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative UCMF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the UCMF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative UCMF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the UCMF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.3 PATCH + +This method shall support the URI query parameters specified in table 5.3.3.3.3-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.3-2 and the response data structures and response codes specified in table 5.3.3.3.3-3. + +**Table 5.3.3.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-----------------------------------------------------------------------------------| +| RacsDataPatch | M | 1 | Contains the modification of an Individual UE radio capability provisioning data. | + +**Table 5.3.3.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------| +| RacsData | M | 1 | 200 OK | The Individual UE radio capability provisioning resource is modified and a representation of that resource is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource modification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource modification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| Array(RacsFailureReport) | M | 1..N | 500 Internal Server Error | The RACS data for all RACS IDs were not provisioned successfully. | + +NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative UCMF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the UCMF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative UCMF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the UCMF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.4 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.4-1. + +**Table 5.3.3.3.4-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.4-2 and the response data structures and response codes specified in table 5.3.3.3.4-3. + +**Table 5.3.3.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.4-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The Individual UE radio capability resource was successfully removed. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource removal. Applicable if the feature "ES3XX" is supported. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource removal. Applicable if the feature "ES3XX" is supported. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative UCMF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the UCMF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative UCMF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the UCMF (service) instance towards which the request is redirected. | + +## 5.4 Custom Operations without associated resources + +No custom operation is defined in this Release of the specification. + +## 5.5 Notifications + +Notifications are not applicable for the current Release. + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6-1 specifies the data types defined for the Nucmf\_Provisioning service based interface protocol. + +**Table 5.6-1: Nucmf\_Provisioning specific Data Types** + +| Data type | Section defined | Description | Applicability | +|---------------|-----------------|--------------------------------------------|---------------| +| RacsData | 5.6.2.2 | UE radio capability data | | +| RacsDataPatch | 5.6.2.3 | UE radio capability data for PATCH request | | + +Table 5.6-2 specifies data types re-used by the Nucmf\_Provisioning service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nucmf\_Provisioning service based interface. + +**Table 5.6-2: Nucmf\_Provisioning re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------------|---------------------|---------------------------------------------------------------------------------------|---------------| +| ProblemDetails | 3GPP TS 29.571 [17] | Used in error responses to provide more detailed information about an error. | | +| RacsConfiguration | 3GPP TS 29.122 [15] | Represents the UE radio capability data configuration. | | +| RacsConfigurationRm | 3GPP TS 29.122 [15] | Represents the UE radio capability data configuration with "nullable: true" property. | | +| RacsFailureReport | 3GPP TS 29.122 [15] | Represents the report for UE radio capability data provisioning. | | +| RedirectResponse | 3GPP TS 29.571 [17] | Contains redirection related information. | ES3XX | +| SupportedFeatures | 3GPP TS 29.571 [17] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type: RacsData + +This type represents a UE radio capability data provided by the NF service consumer to the UCMF. + +Table 5.6.2.2-1: Definition of type RacsData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7. This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| racsConfigs | map(RacsConfiguration) | M | 1..N | Identifies the configuration related to manufacturer specific UE radio capability. Each element uniquely identifies an RACS configuration for an RACS ID and is identified in the map via the RACS ID as key. The response shall include successfully provisioned RACS data. | | +| racsReports | map(RacsFailureReport) | O | 1..N | Supplied by the UCMF. Contains the RACS IDs for which the RACS data are not provisioned successfully. Any string value can be used as a key of the map. | | + +#### 5.6.2.3 Type: RacsDataPatch + +This type represents a UE radio capability data provided by the NF service consumer to the UCMF. + +Table 5.6.2.3-1: Definition of type RacsDataPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| racsConfigs | map(RacsConfigurationRm) | O | 1..N | Identifies the configuration related to manufacturer specific UE radio capability. Each element uniquely identifies an RACS configuration for an RACS ID and is identified in the map via the RACS ID as key. | | + +### 5.6.3 Simple data types and enumerations + +#### 5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +Table 5.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 5.7 Error Handling + +### 5.7.1 General + +For the Nucmf\_Provisioning API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nucmf\_Provisioning API. + +### 5.7.2 Protocol Errors + +No specific procedures for the Nucmf\_Provisioning service are specified. + +### 5.7.3 Application Errors + +The application errors defined for the Nucmf\_Provisioning service are listed in table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Nucmf\_Provisioning API. They shall be negotiated using the extensibility mechanism defined in clause 6.6.2 of 3GPP TS 29.500 [4]. + +**Table 5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [4] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. | + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nucmf\_Provisioning API may be authorized by means of the Oauth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If Oauth2 is used, an NF service consumer, prior to consuming services offered by the Nucmf\_Provisioning API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF service consumer used for discovering the Nucmf\_Provisioning service. + +The Nucmf\_Provisioning API defines a single scope "nucmf-provisioning" for the entire service, and it does not define any additional scopes at resource or operation level. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [7] for further information) and clause 5.3.1 of the 3GPP TS 29.501 [5]. + +## --- A.2 Nucmf\_Provisioning API + +``` +openapi: 3.0.0 +info: + title: Nucmf_Provisioning + version: 1.2.0-alpha.3 + description: | + UCMF_Provisioning Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + externalDocs: + description: > + 3GPP TS 29.675 V18.3.0; User Equipment (UE) radio capability provisioning service; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.675/ +servers: +- url: '{apiRoot}/nucmf-provisioning/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: +- {} +- oAuth2ClientCredentials: +- nucmf-provisioning +paths: + /provisionings: + post: + summary: Create an Individual UE radio capability provisioning + operationId: CreateProvisioning + tags: + - UE radio capability provisionings (Collection) + requestBody: + description: Create new provisionings for a given SCS/AS. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RacsData' + responses: + '201': + description: > + Created. The creation of an Individual UE radio capability provisioning + resource is confirmed and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RacsData' +``` + +``` +headers: + Location: + description: Contains the URI of the newly created resource. + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + description: The RACS data for all RACS IDs were not provisioned successfully. + content: + application/json: + schema: + type: array + items: + $ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/provisionings/{provisioningId}: + parameters: + - name: provisioningId + in: path + description: Provisioning ID + required: true + schema: + type: string + get: + summary: Get an Individual UE radio capability provisioning + operationId: GetProvisioning + tags: + - Individual UE radio capability provisioning (Document) + responses: + '200': + description: OK. The provisioning information related to the request URI is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RacsData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +``` + +``` +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: Update (PATCH) an Individual UE radio capability provisioning + operationId: UpdateProvisioning + tags: + - Individual UE radio capability provisioning (Document) + requestBody: + description: Update an existing parameter provisioning. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/RacsDataPatch' + responses: + '200': + description: > + OK. The Individual UE radio capability provisioning resource is modified + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RacsData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + description: The RACS data for all RACS IDs were not provisioned successfully. + content: + application/json: + schema: + type: array + items: + $ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Replace (PUT) an Individual UE radio capability provisioning + operationId: ReplaceProvisioning + tags: + - Individual UE radio capability provisioning (Document) + requestBody: + description: Update an existing parameter provisioning. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RacsData' + responses: +``` + +``` +'200': + description: > + OK. The Individual UE radio capability provisioning resource is modified and a + representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RacsData' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + description: The RACS data for all RACS IDs were not provisioned successfully. + content: + application/json: + schema: + type: array + items: + $ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Remove an Individual UE radio capability provisioning + operationId: RemoveProvisioning + tags: + - Individual UE radio capability provisioning (Document) + responses: + '204': + description: > + No Content. The Individual UE radio capability resource was successfully removed. + The content shall be empty. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +``` +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: + nucmf-provisioning: Access to the Nucmf_Provisioning API +schemas: + RacsData: + description: Represents a UE radio capability data provided by the NF service consumer. + type: object + properties: + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + racsConfigs: + type: object + additionalProperties: + $ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsConfiguration' + minProperties: 1 + description: > + Identifies the configuration related to manufacturer specific UE radio capability. + Each element uniquely identifies an RACS configuration for an RACS ID and is + identified in the map via the RACS ID as key. The response shall include + successfully provisioned RACS data. + racsReports: + type: object + additionalProperties: + $ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsFailureReport' + minProperties: 1 + description: > + Contains the RACS IDs for which the RACS data are not provisioned successfully. The + failure reason is also included. Any string value can be used as a key of the map. + readOnly: true + required: + - racsConfigs + RacsDataPatch: + description: > + Represents a modification of a UE radio capability data provided by the NF service + consumer. + type: object + properties: + racsConfigs: + type: object + additionalProperties: + $ref: 'TS29122_RacsParameterProvisioning.yaml#/components/schemas/RacsConfigurationRm' + minProperties: 1 + description: > + Identifies the configuration related to manufacturer specific UE radio + capability. Each element uniquely identifies an RACS configuration for an RACS ID + and is identified in the map via the RACS ID as key. +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | Tdoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-06 | | | | | | TS skeleton of UE Radio Capability Provisioning Service | 0.0.0 | +| 2019-09 | | | | | | Includes pCRs agreed in CT3#105:
C3-193417, C3-193594, C3-193648. | 0.1.0 | +| 2019-10 | | | | | | Includes pCRs agreed in CT3#106:
C3-194435. | 0.2.0 | +| 2019-11 | | | | | | Rapporteur changes:
- fill in the referred clause number of TS 29.122 in clauses 4.2.2.2 and 4.2.3.2.
- correct the TS version in externalDocs and step the openAPI file version. | 0.3.0 | +| 2019-12 | | | | | | Sent to plenary for information. | 1.0.0 | +| 2020-03 | | | | | | Includes pCRs agreed in CT3#108-e:
C3-201197. | 1.1.0 | +| 2020-03 | CT#87e | CP-200189 | | | | TS sent to plenary for approval | 2.0.0 | +| 2020-03 | CT#87e | CP-200189 | | | | TS approved by plenary | 16.0.0 | +| 2020-06 | CT#88e | CP-201243 | 0003 | - | F | Correcting errors in clause 5.6 | 16.1.0 | +| 2020-06 | CT#88e | CP-201244 | 0004 | 1 | F | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-06 | CT#88e | CP-201243 | 0002 | 1 | F | Update to UE radio capability information data type | 16.1.0 | +| 2020-06 | CT#88e | CP-201189 | 0001 | 3 | F | Addition of IMEI-TAC values for RACS operations | 16.1.0 | +| 2020-06 | CT#88e | CP-201190 | 0006 | 1 | F | Avoid using the same data type for PUT and PATCH | 16.1.0 | +| 2020-06 | CT#88e | CP-201256 | 0005 | 1 | F | URI of the Nucmf_Provisioning service | 16.1.0 | +| 2020-06 | CT#88e | CP-201243 | 0007 | 1 | F | Correct OpenAPI scope | 16.1.0 | +| 2020-06 | CT#88e | CP-201243 | 0008 | 1 | F | Supported headers, Resource Data type and yaml mapping | 16.1.0 | +| 2020-06 | CT#88e | CP-201255 | 0009 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.1.0 | +| 2020-09 | CT#89e | CP-202072 | 0011 | | F | Resource correction | 16.2.0 | +| 2020-09 | CT#89e | CP-202078 | 0012 | 1 | F | Reference point representation | 17.0.0 | +| 2020-12 | CT#90e | CP-203139 | 0014 | | A | Essential corrections and alignments | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0016 | 1 | A | Storage of YAML files in ETSI Forge | 17.1.0 | +| 2020-12 | CT#90e | CP-203136 | 0018 | 1 | A | Correct UCMF id | 17.1.0 | +| 2021-03 | CT#91e | CP-210218 | 0019 | | F | Update of "description" field for racsReports | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0020 | | F | OpenAPI reference | 17.2.0 | +| 2021-03 | CT#91e | CP-210221 | 0021 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0022 | | F | Support of optional HTTP custom header fields | 17.2.0 | +| 2021-03 | CT#91e | CP-210220 | 0023 | | F | Terminology alignment: usage of "NF service consumer" | 17.2.0 | +| 2021-03 | CT#91e | CP-210235 | 0024 | | F | Correcting the receiver of HTTP DELETE request | 17.2.0 | +| 2021-03 | CT#91e | CP-210240 | 0025 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-09 | CT#93e | CP-212218 | 0027 | | A | Correcting resource definitions | 17.3.0 | +| 2021-12 | CT#94e | CP-213239 | 0028 | | F | API URI of the Nucmf_Provisioning API | 17.4.0 | +| 2022-03 | CT#95e | CP-220201 | 0029 | 1 | F | Formatting of description fields | 17.5.0 | +| 2022-03 | CT#95e | CP-220194 | 0030 | | F | Update of info and externalDocs fields | 17.5.0 | +| 2022-06 | CT#96 | CP-221155 | 0031 | | F | Alignment with the SBI template | 17.6.0 | +| 2022-06 | CT#96 | CP-221152 | 0032 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-12 | CT#98e | CP-223213 | 0033 | 1 | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223190 | 0034 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230126 | 0037 | 1 | F | Support of temporary and permanent redirections | 18.1.0 | +| 2023-03 | CT#99 | CP-230162 | 0040 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231131 | 0041 | | F | Resolve ENs on redirection responses | 18.2.0 | +| 2023-12 | CT#102 | CP-233228 | 0042 | | B | Update obsoleted IETF HTTP RFCs | 18.3.0 | +| 2023-12 | CT#102 | CP-233228 | 0043 | | F | ProblemDetails RFC 7807 obsoleted by RFC 9457 | 18.3.0 | +| 2023-12 | CT#102 | CP-233238 | 0044 | | F | Update of info and externalDocs fields | 18.3.0 | \ No newline at end of file diff --git a/raw/rel-18/29_series/29831/08441fa90c5fd11994626f662ac13f19_img.jpg b/raw/rel-18/29_series/29831/08441fa90c5fd11994626f662ac13f19_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..03b34db6528a0966c96657ea1bec94bbb5a3eb9d --- /dev/null +++ b/raw/rel-18/29_series/29831/08441fa90c5fd11994626f662ac13f19_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:83d5139e0e47cfd5a39fcf2bb94dc8edf2cf17889fc36ed9812f12c3e7b1ce69 +size 34298 diff --git a/raw/rel-18/29_series/29831/26d664119ad25250780f554633444e54_img.jpg b/raw/rel-18/29_series/29831/26d664119ad25250780f554633444e54_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..013f2f8f0d2d590425bd89f43b22a03658980663 --- /dev/null +++ b/raw/rel-18/29_series/29831/26d664119ad25250780f554633444e54_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b36b66e4b01f8a792cf04e631ae45e6770325dfa112f90954dd81254003f6baf +size 58496 diff --git a/raw/rel-18/29_series/29831/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/raw/rel-18/29_series/29831/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..1f9ebda1490b1e3739dec75352121e4139d599bc --- /dev/null +++ b/raw/rel-18/29_series/29831/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ee563c82bd2c314b414fc3aab4feb33dad466c3d11e50509057086ade4868259 +size 9362 diff --git a/raw/rel-18/29_series/29831/64662465bba247703fdec49c8f3309f9_img.jpg b/raw/rel-18/29_series/29831/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0a187f653b1c9118cc4bd0e2fbba71424c82c547 --- /dev/null +++ b/raw/rel-18/29_series/29831/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a6661beadcef0af32d7303f6579e6e13acb28cf7e9f1b1bd6b93ace0d02245bb +size 5592 diff --git a/raw/rel-18/29_series/29831/6470d350326789d5306eabcb76533951_img.jpg b/raw/rel-18/29_series/29831/6470d350326789d5306eabcb76533951_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b90b4bb58c5e20332580c914d68582b604bf5cae --- /dev/null +++ b/raw/rel-18/29_series/29831/6470d350326789d5306eabcb76533951_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a44aec8db0f74c19c067920430423ccd3bffd4a150b66b31f4c19daa94aa78df +size 31083 diff --git a/raw/rel-18/29_series/29831/8307f6b04df072c9332f9987e034272c_img.jpg b/raw/rel-18/29_series/29831/8307f6b04df072c9332f9987e034272c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bb4e9d146547cd914450a578630f7011e5069d75 --- /dev/null +++ b/raw/rel-18/29_series/29831/8307f6b04df072c9332f9987e034272c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:24d95c9000775e1a2f2001921a72fc05247e3572de1e0862135fe6a22ca51397 +size 87639 diff --git a/raw/rel-18/29_series/29831/9cd90f495b95ad2116ff780248c26d95_img.jpg b/raw/rel-18/29_series/29831/9cd90f495b95ad2116ff780248c26d95_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..38c3e5f1bf43a6397fb4e8f075ea26449d2e0b18 --- /dev/null +++ b/raw/rel-18/29_series/29831/9cd90f495b95ad2116ff780248c26d95_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:773ea710f7a15e87cc1c1a981fe348170736ef2d0c58d3d1eacf40c876e5e13b +size 29706 diff --git a/raw/rel-18/29_series/29831/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg b/raw/rel-18/29_series/29831/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..085ba41e5873e27461b033b400414153540c7e57 --- /dev/null +++ b/raw/rel-18/29_series/29831/a33da0f14e456f92539ce3e9b7d81f9a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d95ce0d00488552d1b02bf3f6923f6cd7ed2a71f6fd38a8653350f1632283736 +size 82446 diff --git a/raw/rel-18/29_series/29831/a734898ce18e972938949637c32a34f4_img.jpg b/raw/rel-18/29_series/29831/a734898ce18e972938949637c32a34f4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4b8b8ac8e453337821a15543cd624dec046c51b9 --- /dev/null +++ b/raw/rel-18/29_series/29831/a734898ce18e972938949637c32a34f4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2f746810318d0978d08ffa957b6bba73bd34a00c38c9bfbcf298ed81d6ce659b +size 58967 diff --git a/raw/rel-18/29_series/29831/b5335262987c819d7f71ce40f99cb71b_img.jpg b/raw/rel-18/29_series/29831/b5335262987c819d7f71ce40f99cb71b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..66267212c533657f4876604275b4128f70b78dc9 --- /dev/null +++ b/raw/rel-18/29_series/29831/b5335262987c819d7f71ce40f99cb71b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2542c889470dd63c60ff1ae6533ca51cc0b75e6815cebf94265e71a7b0a88bd5 +size 34449 diff --git a/raw/rel-18/29_series/29831/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg b/raw/rel-18/29_series/29831/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..10b20a0f4dc16b5136cbcbc3c6d155ce2bea2d5f --- /dev/null +++ b/raw/rel-18/29_series/29831/c67d21fb3d9042e88cdc669f071b4e7c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5694d1e3b5fd23d25ef6e170901a616d8ffb00ed186c107bd86a35189b1ba690 +size 68359 diff --git a/raw/rel-18/29_series/29893/raw.md b/raw/rel-18/29_series/29893/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..98ed447173487690195a2d5c164e5d6bf3497c81 --- /dev/null +++ b/raw/rel-18/29_series/29893/raw.md @@ -0,0 +1,1178 @@ + + +# 3GPP TR 29.893 V18.0.0 (2023-09) + +*Technical Report* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Study on IETF QUIC Transport for 5GC Service Based Interfaces; (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font with a red signal wave icon below the 'P', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Architectural Baseline..... | 8 | +| 5 Transport Protocol Features Required For 3GPP 5GC SBI..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Requirements from Transport Protocol for 3GPP 5GC SBI ..... | 9 | +| 5.3 Features of QUIC ..... | 10 | +| 5.3.1 General ..... | 10 | +| 5.3.2 Framing and Multiplexing..... | 10 | +| 5.3.3 Improved Recovery and Acknowledgement ..... | 11 | +| 5.3.4 Encrypted and Integrity Protected Transport details ..... | 11 | +| 5.3.5 Connection Setup Improvements ..... | 11 | +| 5.3.6 0-RTT Data..... | 12 | +| 5.3.7 Connection ID ..... | 12 | +| 5.3.8 Connection Migration..... | 12 | +| 5.3.9 Stream Prioritization..... | 13 | +| 5.3.10 Flow Control..... | 13 | +| 5.3.11 Protocol Versioning..... | 13 | +| 5.3.12 QUIC Extensibility ..... | 13 | +| 5.3.13 Connection Configuration ..... | 14 | +| 5.3.14 User-Land Implementations ..... | 14 | +| 5.3.15 Pluggable Sender Side Congestion Control ..... | 14 | +| 5.3.16 Checking that the QUIC connection is alive ..... | 14 | +| 5.3.17 62 bits stream identifiers ..... | 14 | +| 5.3.18 Running atop of UDP ..... | 15 | +| 5.4 Features of QUIC Applicable to 3GPP SBI..... | 15 | +| 5.4.1 General ..... | 15 | +| 5.4.2 Framing and Multiplexing..... | 15 | +| 5.4.3 Encrypted and Integrity Protected Transport details ..... | 15 | +| 5.4.4 Connection setup improvements ..... | 15 | +| 5.4.5 Connection ID and Connection Migration ..... | 16 | +| 5.4.6 Improved Recovery and Acknowledgement ..... | 16 | +| 5.5 Features of QUIC Not Applicable to 3GPP SBI..... | 16 | +| 5.5.1 General ..... | 16 | +| 5.5.2 0-RTT DATA ..... | 16 | +| 5.6 Comparison of Applicable Features with Rel-15 Transport ..... | 17 | +| 6 HTTP/3..... | 20 | +| 6.1 Introduction ..... | 20 | +| 6.2 HTTP/3 Proxies..... | 21 | +| 6.2.1 General ..... | 21 | +| 6.2.2 When NF Service Consumer Side Uses QUIC ..... | 22 | +| 6.2.2.1 Case A: Invoking http API Supporting Only TCP Transport..... | 22 | +| 6.2.2.2 Case B: Invoking http API Supporting QUIC Transport..... | 24 | +| 6.2.2.3 Case C: Invoking https API Supporting Only TCP Transport..... | 25 | +| 6.2.2.4 Case D: Invoking https API Supporting QUIC Transport..... | 26 | +| 6.2.3 When NF Service Consumer Side Uses TCP..... | 27 | +| 6.2.3.1 Invoking http API Supporting QUIC Transport ..... | 27 | +| 6.2.3.2 Invoking https API Supporting QUIC Transport..... | 27 | +| 6.3 Considerations for HTTP/3 ..... | 28 | + +| | | | +|-------------------------------|---------------------------------------------------------------------------|-----------| +| 6.3.1 | General ..... | 28 | +| 6.3.2 | Connection setup and management..... | 28 | +| 6.3.3 | Streams, framing and multiplexing ..... | 28 | +| 6.3.4 | Prioritization ..... | 29 | +| 6.3.5 | Server Push ..... | 29 | +| 6.3.6 | Compression (HPACK vs QPACK)..... | 29 | +| 7 | Key Requirements for Supporting QUIC..... | 29 | +| 7.1 | Introduction ..... | 29 | +| 7.2 | Discovery of QUIC support ..... | 29 | +| 7.3 | Discovery of NRF's Support for QUIC ..... | 30 | +| 7.4 | Migration to QUIC ..... | 30 | +| 7.5 | Support of Indirect Communication..... | 30 | +| 8 | Solutions for Key Requirements ..... | 30 | +| 8.1 | Introduction ..... | 30 | +| 8.2 | Solutions for Discovery of QUIC support..... | 31 | +| 8.2.1 | Using the Discovery Service of the NRF ..... | 31 | +| 8.2.2 | Using Alt-Svc Header..... | 31 | +| 8.3 | Solutions for Discovery of NRF's Support for QUIC ..... | 32 | +| 8.3.1 | Providing NRF Transport Capability from NSSF ..... | 32 | +| 8.3.2 | Providing Remote PLMN NRF's Transport Capability during NF Discovery..... | 32 | +| 8.3.3 | Discovery Based On Local Configuration ..... | 32 | +| 8.4 | Solutions for Migration to QUIC ..... | 33 | +| 8.4.1 | Deployment Topologies to Introduce NF Services with QUIC Support..... | 33 | +| 8.4.2 | Steps to Follow When Introducing NF Services with QUIC Support..... | 33 | +| 8.4.3 | Use of QUIC by NF Service Consumers..... | 33 | +| 8.4.4 | Decommissioning TCP..... | 33 | +| 9 | Impacts to Service Based Architecture ..... | 34 | +| 9.1 | Introduction ..... | 34 | +| 9.2 | HTTP Proxy Traversal ..... | 34 | +| 9.3 | QUIC's Security Mechanisms ..... | 34 | +| 9.4 | TCP Decommission in Migration Impacts Architecture..... | 34 | +| 9.5 | Transport Proxy Traversal..... | 35 | +| 9.6 | Impacts on Troubleshooting..... | 35 | +| 9.6.1 | Introduction ..... | 35 | +| 9.6.2 | QUIC keying impact..... | 35 | +| 9.6.3 | Network level troubleshooting ..... | 35 | +| 9.6.4 | Application level troubleshooting ..... | 36 | +| 10 | Current Implementation and Maturity Status..... | 36 | +| 10.1 | Introduction ..... | 36 | +| 10.2 | Implementation maturity ..... | 36 | +| 10.3 | Hardware offload support..... | 37 | +| 10.4 | UDP Performance in Operating System..... | 37 | +| 11 | Evaluation and Conclusion ..... | 38 | +| 11.1 | Evaluation..... | 38 | +| 11.1.1 | Requirements for Service Based Interfaces..... | 38 | +| 11.1.2 | Expected improvements ..... | 38 | +| 11.1.3 | Issues ..... | 38 | +| 11.1.4 | Other considerations ..... | 39 | +| 11.2 | Conclusion..... | 39 | +| Annex A (informative): | HTTP/2 vs. HTTP/3 testing findings and considerations ..... | 39 | +| Annex B: | Change history..... | 41 | + +# Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document analyses the IETF QUIC protocol and its potential use as a transport protocol for the 5GC Service Based Interfaces. + +This technical report provides an analysis of the following aspects: + +- Features of transport protocol required for 5GC SBI; +- Features of QUIC applicable to 5GC SBI; +- Comparison of the applicable features of QUIC against TCP for the 5GC SBI; +- Key requirements for 5GC SBI in order to support QUIC as a transport protocol; +- Solutions for supporting the key requirements; +- Impacts to 5GC Service Based Interfaces due to introduction of QUIC. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] IETF RFC 9000: "QUIC: A UDP-Based Multiplexed and Secure Transport". +- [6] IETF RFC 9001: "Using TLS to Secure QUIC". +- [7] IETF RFC 9114: "HTTP/3". +- [8] IETF RFC 9002: "QUIC Loss Detection and Congestion Control". +- [9] IETF RFC 8999: "Version-Independent Properties of QUIC". +- [10] IETF RFC 9204: "QPACK: Header Compression for HTTP/3" + +- [11] IETF RFC 5246: "The Transport Layer Security (TLS) Protocol Version 1.2". +- [12] IETF RFC 8446: "The Transport Layer Security (TLS) Protocol Version 1.3". +- [13] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [14] IETF RFC 7541: "HPACK: Header Compression for HTTP/2". +- [15] Void +- [16] IETF RFC 5682: "Forward RTO-Recovery (F-RTO): An Algorithm for Detecting Spurious Retransmission Timeouts with TCP". +- [17] IETF draft-dukkipati-tcpm-tcp-loss-probe-01: "Tail Loss Probe (TLP): An Algorithm for Fast Recovery of Tail Losses". +- [18] IETF RFC 6582: "The NewReno Modification to TCP's Fast Recovery Algorithm". +- [19] 3GPP TS 29.510: "Network Function Repository Services". +- [20] IETF RFC 7838: "HTTP Alternative Services". +- [21] IETF draft-pardue-httpbis-http-network-tunnelling-01: "HTTP-initiated Network Tunnelling (HiNT)". +- [22] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [23] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing". +- [24] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [25] GSMA NG.113: "5GS Roaming Guidelines". +- [26] IETF RFC 8312: "CUBIC for Fast Long-Distance Networks". +- [27] 3GPP TR 23.742: "Study on Enhancements to the Service-Based Architecture". +- [28] IETF RFC 8164: "Opportunistic Security for HTTP/2". +- [29] IETF RFC 7657: "Differentiated Services (Diffserv) and Real-Time Communication". +- [30] Taking a Long Look at QUIC: "". +- [31] IETF RFC 5288: "AES Galois Counter Mode (GCM) Cipher Suits for TLS". +- [32] Developing and deploying a TCP replacement for the Web: "". +- [33] Optimizing UDP for content delivery: "[http://vger.kernel.org/lpc\\_net2018\\_talks/willemdebruijn-lpc2018-udpgso-paper-DRAFT-1.pdf](http://vger.kernel.org/lpc_net2018_talks/willemdebruijn-lpc2018-udpgso-paper-DRAFT-1.pdf)". +- [34] UDP segmentation offload: "". +- [35] IETF draft-ietf-masque-connect-ip-13: "Proxying IP in HTTP". +- [36] IETF RFC 9298: "Proxying UDP in HTTP". +- [37] IETF draft-ietf-quic-multipath-04: "Multipath Extension for QUIC". +- [38] QUIC vs TCP: Which is Better?: "". +- [39] IETF draft-ietf-quic-ack-frequency-04: "QUIC Acknowledgement Frequency", "". + +- [40] Comparison of Different QUIC Implementations: +"https://www.net.in.tum.de/fileadmin/TUM/NET/NET-2022-07-1/NET-2022-07-1\_10.pdf". +- [41] How Facebook is bringing QUIC to billions: "https://engineering.fb.com/networking-traffic/how-facebook-is-bringing-quic-to-billions". +- [42] Comparing HTTP/3 vs. HTTP/2 Performance: "https://blog.cloudflare.com/http-3-vs-http-2". +- [43] H2O the optimized HTTP/1.x, HTTP/2 server: "https://h2o.example.net/benchmarks.html". +- [44] Of the Utmost Importance: Resource Prioritization in HTTP/3 over QUIC: +"https://h3.edm.uhasselt.be/files/HTTP3\_Prioritization\_extended\_3jul2019.pdf". +- [45] Head-of-Line Blocking in QUIC and HTTP/3: The Details: +"https://calendar.perfplanet.com/2020/head-of-line-blocking-in-quic-and-http-3-the-details". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-----|--------------------------| +| RTT | Round Trip Time | +| TLS | Transport Layer Security | + +# --- 4 Architectural Baseline + +3GPP Release 16 Service Based Architecture as specified in 3GPP TS 23.501 [2] and the 3GPP Release 16 Technical Realization of the Service Based Architecture as specified in 3GPP TS 29.500 [4] shall be taken as the baseline for studying QUIC's use as a transport protocol for the 5GS Service Based Interfaces. + +In particular the following architectural assumptions shall be taken into account: + +- Replacing the transport protocol from TCP to QUIC shall not lead to any change in the semantics of the NF services and shall not lead to any change in API. +- SEPP shall be used as the security protection and edge proxy even when the NF service consumer in VPLMN and the NF service consumer in HPLMN both use QUIC as the transport. +- For inter PLMN NF service communication, even if both the NF service consumer and NF service producer support QUIC, the IPX providers and intermediaries on path between the two NF's first hop and the last hop shall not be mandated to support QUIC. In other words, the NF service consumer and the NF service producer shall be able to communicate when using QUIC as transport even in the presence of TCP based IPX or intermediaries on path between the first hop and the last hop. +- A NF Service Consumer and NF Service Producer may communicate indirectly via Service Communication Proxy (SCP). The indirect communication options defined in Annex E of 3GPP TS 23.501 [2] and listed hereafter shall be permitted: + - Option C - Indirect communication without delegated discovery; + +- Option D - Indirect communication with delegated discovery. + +SCPs act as HTTP proxies. SCPs require the ability to look into the HTTP message for delegated discovery and selection functionality. + +# --- 5 Transport Protocol Features Required For 3GPP 5GC SBI + +## 5.1 Introduction + +This clause will identify the requirements from transport protocol for the 3GPP 5GC service based interfaces and then subsequently highlights the features of the QUIC protocol. Among the features of QUIC, those features that are applicable for the 3GPP 5GC service based interfaces are then explicitly identified. + +## 5.2 Requirements from Transport Protocol for 3GPP 5GC SBI + +The following are the key requirements from transport layer protocols for the 3GPP 5GC service based interfaces. The 3GPP 5GC service based interfaces use HTTP/2 as the application layer protocol. As of 3GPP Release 15, TCP is used as the transport protocol for the 5GC service based interfaces. TCP suffers from Head of Line blocking issues and any new transport protocol that is considered as a replacement to TCP for the 3GPP 5GC service based interfaces shall not have the same limitation. + +- REQ#1: The transport layer protocol shall support reliable message delivery. +- REQ#2: The transport layer protocol shall support flow control and congestion control mechanisms. +- REQ#3: The transport layer protocol shall support connection semantics as required by IETF RFC 7540 [13]. +- REQ#4: The failure to deliver one message shall not block subsequent messages. +- REQ#5: The transport layer protocol shall have mechanisms to allow authentication of the peer transport endpoint and shall have mechanisms for the secure transfer of application layer messages. +- REQ#6: The transport layer protocol shall have mechanisms to allow processing of the HTTP/2 messages over it by intermediaries (e.g. proxies like SCP). +- REQ#7: The transport layer protocol should support troubleshooting and Monitoring, e.g. message trace and parse in the middlebox for the scenarios of testing, monitoring, troubleshooting and etc. +- REQ#8: The transport layer protocol, along with the upper layer application protocol shall support the distributed architecture for PNFs and VNFs, e.g. the front-end load-balancer and back-end service process-units architecture. +- REQ#9: The performance and resource efficiency (i.e. CPU, Memory and other processing requirements) shall be one of the evaluation criteria of the transport layer protocol. +- REQ#10: The complexity and cost of development and deployment of the transport layer protocol shall be one of the evaluation criteria. +- REQ#11: The transport layer protocol shall be mature enough for adoption of the protocol in the 5GC, e.g. fully standardized and has mature open source support, not only for the QUIC protocol, but also the full stack of HTTP/3 protocols. + +## 5.3 Features of QUIC + +### 5.3.1 General + +QUIC is a multiplexed and secure transport protocol that runs on top of UDP. QUIC aims to provide a flexible set of features that allow it to be a general-purpose secure transport for multiple applications. The main parts of QUIC are defined in a set of documents IETF RFC 9000 [5], IETF RFC 9002 [8], IETF RFC 9001 [6], IETF RFC 8999 [9]. The highly integrated HTTP/2 over QUIC specification (now called HTTP/3) IETF RFC 9114 [7] and HTTP header compression IETF RFC 9204 [10] are developed in parallel with the core protocol. The protocol is developed by the Internet Engineering Task Force (IETF). + +QUIC is mainly designed for the communication across insecure and untrusted internet, it integrates some features to tackle the performance, security and privacy related challenges, the applicability of applying QUIC in 5G Core shall be evaluated. + +### 5.3.2 Framing and Multiplexing + +Provisions in this clause are based on IETF RFC 9000 [5]. QUIC endpoints communicate by exchanging QUIC packets in UDP datagrams. One or more QUIC packets can be encapsulated in a single UDP datagram. QUIC packets may have long or short headers, for packets sent prior or after the completion of version negotiation and establishment of 1-RTT keys respectively. A sender multiplexes one or more QUIC frames of the same or different type(s) into a QUIC packet. The header contains only a limited set of fields, including Destination Connection ID field (see clause 12) and encrypted Packet Number field. Data sent by an application is encapsulated in STREAM frames which are carried in 0-RTT packets, if sent as early data during the handshake, or afterwards in 1-RTT packets. An endpoint uses the Stream ID and Offset fields in STREAM frames to place data in order. The usage of the Offset field is further explained by the below example. + +**EXAMPLE:** Let's say a QUIC transport entity sends data via three STREAM frames. The first one is e.g. 10 octets long, starts at offset 0 and ends at offset 9. The second one is e.g. 20 octets long, starts at offset 10 and ends at offset 29. The third one is e.g. 7 octets long, starts at offset 30 and ends at offset 36. Let's also assume these frames are carried by separate QUIC packets A, B and C. In a sunny day scenario all three packets arrive at the receiving entity, which successfully acknowledges them. In a rainy day scenario, retransmissions are necessary. Let's say, packets A and B were lost and only packet C is delivered and acknowledged. The sender obviously needs to retransmit the content with offset 0..9 and 10..29. The sender can do this either by resending these two frames as initially sent (i.e. the three frames) or by sending a single, 10+20=30 octets long frame with offset 0..29. + +This is one of the differences with TCP, as TCP only provides one stream and all data therefore are delivered in order, which means multiplexing is not supported in TCP. A sender can wait for a short period of time to bundle multiple frames into the same QUIC packet, e.g. to minimize the computational costs of packets sending. + +QUIC supports multiple parallel data streams multiplexed on a single QUIC connection. Streams, which can be unidirectional or bidirectional in QUIC provide a lightweight, ordered byte-stream abstraction to an application. Packets transmitted in each stream use Authenticated Encryption with Additional Data (AEAD) to provide confidentiality and integrity protection. Streams can be long-lived, even during the lifetime of a connection to increase the reusability and limit the cost of opening stream (See IETF RFC 9000 [5]). An endpoint of a bidirectional stream can terminate one direction and even encourage prompt termination in the opposite direction. + +For each stream QUIC now only supports reliable and in-order delivery, but the implementations may choose to offer the ability to deliver data out of order. However, the QUIC layer is capable of delivering to the higher layer each stream independently as the streams in QUIC are independent of each other, thus it avoids blocking the delivery of any of the other streams when a packet loss contains only part of a stream which would be the case for HTTP/2 over TCP. Note that to achieve this efficiency the implementation needs to pay attention to pack payload from one stream into a single QUIC packet. + +The HTTP/3 mapping for QUIC IETF RFC 9114 [7] utilizes this stream concept when realizing the different HTTP/2 (See IETF RFC 7540 [13]) streams. HTTP/3 also had to improve the HTTP header compression scheme HPACK (See IETF RFC 7541 [14]) into QPACK (See IETF RFC 9204 [10]). With these changes HTTP can deliver independent requests and responses in the order they are successfully delivered to endpoints, without head of line blocking between HTTP streams which would be the case for HTTP/2 over TCP. + +### 5.3.3 Improved Recovery and Acknowledgement + +The QUIC definition of its packet format and acknowledgement frame results in several improvements over TCP. The packet number is transmission-time ordered and strictly increasing. QUIC never retransmits a particular packet, only the lost data frames that need to be retransmitted. QUIC facilitates better way to calculate RTT by encoding the delay between packet reception and transmission of the acknowledgement. The QUIC acknowledgement also supports a very larger number of received and gap ranges. + +Compared to TCP, QUIC will not be limited to a three blocks of selective acknowledgement (SACK) when using the timestamp option. Each ACK Frame in QUIC can contain variable number of ACK ranges, up to 62 bits (See IETF RFC 9000 [5]), which helps to ease network throughputs in case of sending packets frequently. The strict packet numbers and explicit acknowledgement removes ambiguity between which packet is lost and which is acknowledged. Avoiding any unnecessary retransmissions of data that have reached the receiver. QUIC also avoids the retransmission uncertainty if the received packet was a delayed or retransmitted. QUIC's RTT samples are more accurate than what TCP can provide due to no ambiguity about which packets are used in measurement as well as the receiver side delay can be taken into account. + +The congestion control algorithm of the current QUIC version is based on NewReno (See IETF RFC 6582 [18]), but implementations can use other congestion control algorithms, such as Cubic (see IETF RFC 8312 [26]), and endpoints are allowed to use different algorithms from one another. QUIC can customise different congestion control algorithms for different connections of the same application, and even alter it during the lifetime of a connection, see clause 9.4. QUIC provides generic congestion control signals to support different algorithms. QUIC also uses some additional modern loss recovery mechanisms by default, such as F-RTO (See IETF RFC 5682 [16]), and Tail Loss Probing (See IETF draft-dukkipati-tcpm-tcp-loss-probe [17]). These improvements give QUIC a better recovery mechanism. + +### 5.3.4 Encrypted and Integrity Protected Transport details + +QUIC uses TLS 1.3 (See IETF RFC 9001 [6], IETF RFC 8446 [12]), for key establishment, QUIC integrates the TLS 1.3 as its own encryption and integrity layer that protects the QUIC packets, but the security capability of HTTP/3 over QUIC/UDP is consistent with HTTP/2 over TLS1.3/TCP. Each QUIC packet has a packet header, using a short or a long format with a small number of fields that are unencrypted, but integrity protected. It is primarily the connection ID that is unencrypted and three reserved bits for experimentation in the short header. Even the packet number is encrypted using an independent mechanism from the payload. + +The encryption and integrity protection provide confidentiality, privacy and source authenticity for the user of QUIC. However, the protection is also intended to prevent any middlebox in the network from interfering with the protocol, nor make assumptions about what the possible values any specific bit in the UDP payload can take. Ossification of the network has prevented a lot of improvements from being applied to TCP as middleboxes would either block or remove such changes. + +Compared to TCP, this level of encryption does make certain type of network performance monitoring using middlebox basically impossible. Due to this, the QUIC short header introduces a latency spin bit (See IETF RFC 9000 [5]) that is intended to enable middlebox to measure round-trip time between the middlebox and either endpoint of the connection if enabled by both end-points. The latency spin bit partially overcomes the drawback of impossible network performance monitoring caused by encryption in QUIC layer, but cannot support the message tracing by content inspection for the testing, monitoring and troubleshooting related scenarios. + +### 5.3.5 Connection Setup Improvements + +QUIC is capable of completing establishment of a connection between a client and a server in one and half RTT. The protocol combines TLS (See IETF RFC 8446 [12]) handshake with transport protocol level mechanisms to achieve this. A client's request to a server can be included after one RTT and be sent combined with the last step of the crypto handshake from the client to the server. + +Holding state in the server for the initial connection establishment packets prior to having verified the client's return path can expose the server to a denial of service risk. Servers that like to mitigate that risk can use the Retry packet to verify the path and not hold any state for the first round-trip. + +How big improvement this is depends on what one compares against. As 3GPP TS 33.310 makes support for TLS 1.3 (See IETF RFC 8446 [12]) mandated from Rel-15 it is reasonable to compare with both TLS 1.2 (See IETF RFC 5246 [11]) and TLS 1.3. TLS 1.2 session resumption requires that the client has talked to the server recently + +enough, so it still has session state stored. The below table indicates number of RTTs until the first HTTP request can be sent by the client. + +**Table 5.3.5-1: Number of RTTs until first HTTP request** + +| Protocol | New Connection | Connection State Exists | +|-------------|----------------|-------------------------| +| TCP/TLS 1.2 | 3 | 2 | +| TCP/TLS 1.3 | 2 | 1 | +| QUIC | 1 | 0 | + +QUIC can achieve faster connection establishment times until an HTTP request has been sent than existing TLS and TCP combinations. This improvement is significant when establishing a new connection, but not when clients have a long lived one to the server. + +### 5.3.6 0-RTT Data + +TLS 1.3 (IETF RFC 8446 [12]) includes support for early data or 0-RTT data, as it is also called. This is potentially usable by both HTTP/2 over TLS1.3/TCP as well as HTTP/3. This functionality can be used when client and server share a Pre-Shared Key (PSK), which can be arranged out of band or exist from an earlier connection. 0-RTT data has other security properties than for data sent after the handshake completes. Data sent as 0-RTT data will be possible to replay by an attacker that has seen the client to server exchange. Therefore, the use of 0-RTT data requires that the data is safe to replay. When using HTTP requests as 0-RTT data, the request performed must be one that is idempotent. Server may refuse to accept 0-RTT data for this reason. + +A server accepts 0-RTT data on a connection needs more processing and computation cost. Servers need to consider the probability of replay and all associated costs when accepting 0-RTT (See IETF RFC 9001 [6], IETF RFC 8446 [12]). + +### 5.3.7 Connection ID + +QUIC uses a set of connection IDs, one connection ID for the server and one connection ID for the client to identify a particular connection for an endpoint. During the handshake, QUIC packet with the long header is used to exchange the connection ID that each endpoint assigned. The endpoint is allowed to change the own connection ID to another available one at any time during the connection without any interruption in the transmission. This solution makes the connection not hard bound to a particular 5-tuple (Source and Destination IP, protocol, and source and destination port), instead the connection can be moved between different network interfaces on client and with some limitations on the server side. The protocol has a feature for migrating connections from using one 5-tuple to another, see clause 5.3.8. When knowingly changing the used 5-tuple a new connection ID is necessarily to be used. The peers exchange additional connection IDs when needed to ensure that the peer have one or more previously unused CIDs that can be used in case of connection migration. The middlebox is difficult to correlate the received packet to the connection as the procedure used to changing connection is in encryption. + +The length of connection ID is variable, and it provides certain flexibility in how the implementers realize network equipment architecture, e.g. front-end load-balancers, for QUIC. + +### 5.3.8 Connection Migration + +QUIC allows its connection to migrate while the HTTP/3 session progresses. This means for a client with multiple network interfaces an ongoing QUIC session can be moved to newly validated path via a newly discovered network interface, for example, in the case of a data session handover from WLAN to a 3GPP radio access technology. This is possible as QUIC sessions are identified by a set of connection IDs hence a particular QUIC session is not tightly coupled with a specific client IP address and port number. If a network interface appears with new IP addresses or an existing one disappears but the client has alternative network interfaces, the QUIC session does not need to be established again. The QUIC session can continue on a new interface after the client has validated the path to the server from the new interface address using PATH\_CHALLENGE frames, with potentially a new connection ID from the previously communicated set of connection IDs. + +NOTE: IETF RFC 9000 [5] does not mandate a new connection ID after connection migration. However such reuse is not recommended as this allows on path observers to link multiple source IP addresses to the same connection and identify the topological relationship of clients. See clause 9.5 of IETF RFC 9000 [5]. + +It is possible that the server also has multiple IP addresses and has some preferences on which interface it would like to serve a particular client for load balancing or other management. QUIC allows server to receive a connection request to one IP address and migrate the connection to a preferred address in connection response immediately, this achieves faster connection migration than HTTP redirect. Currently, QUIC does not support change of server IP address in the middle of an ongoing session however, the server preferred address can be conveyed to the client during the TLS handshake as "preferred\_address" transport parameter (see clause 9.6 of IETF RFC 9000 [5]). If the new path to the preferred server address is valid then client sends all the future packets to the new server address. Here the client also uses a new connection ID for the new connection to the server's preferred address. + +### 5.3.9 Stream Prioritization + +Being a multiplexed transport protocol, QUIC supports stream prioritization for boosting the application performance. However, QUIC itself neither provides mechanism to negotiate prioritization information nor implements any strict prioritization scheme. It relies on the application to provide priority information that QUIC will follow when it comes to packet transmission or retransmission. HTTP/3 uses the same prioritization mechanism as HTTP/2. + +### 5.3.10 Flow Control + +Flow control is a mechanism to set boundaries to the senders to avoid overwhelming receiver with data that the receiver cannot process. Like TCP, QUIC deploys connection level flow control, moreover, it applies a secondary stream level flow control to prevent a particular stream from consuming the receiver buffer for a connection. As QUIC provides multiplexing, flow control from the HTTP/2 layer is moved to the QUIC layer, avoiding head of line blocking and simplifying HTTP/3. + +### 5.3.11 Protocol Versioning + +QUIC has a 32-bit version field. It can be expected that QUIC will eventually exist in a number of proprietary and standardized versions. IETF is currently working on defining version 0x00000001. There exists a mechanism for the client to ask the server to enumerate all versions it supports. The client when requesting to create a connection it will indicate the version desired to use. If supported then that is what will be used, otherwise it triggers the version negotiation. Some of the non-encrypted fields are defined as not being changeable independent of version as defined by the document for invariants (See IETF RFC 8999 [9]). + +The QUIC versioning enables a very large degree of flexibility for future changes of QUIC. All aspects except for the invariants can be changed. This enables the tuning of QUIC to a specific use case or implementation of future improvements in transport protocol technology. This flexibility also indicates the need to be explicit about which QUIC version(s) that are to be supported by a specific SBI. Any analysis of benefits and downsides of QUIC must be explicit about which version is discussed. + +### 5.3.12 QUIC Extensibility + +QUIC payloads consist of one or more frames. Each frame starts with frame types followed by type specific flags. All the streams with data are carried over the STREAM frame type. QUIC's current specification defines a number of essential frame types. However, new frame types can be created and can be even application specific. + +QUIC allows extensions to the protocol within the constraints of the protocol invariants (see properties of the QUIC transport protocol that are expected to remain unchanged as new versions of the protocol are developed, in IETF RFC 8999 [9]). Extensions can change the semantics of existing protocol components, but they need to be negotiated before being used. Permitted extensions include new frame types, new settings, error codes and uni-directional streams. This gives QUIC a unique way of being extensible and customizable. + +The usage of new frame types does not necessarily imply using a new protocol version. A peer can use transport parameters to indicate support to the peer that it can use a new frame type. However, this has the downside that the support of a certain frame type cannot be determined before establishing the transport connection; on the other hand, using a specific protocol version can be leveraged by a peer to determine this support prior to establishing the connection. + +### 5.3.13 Connection Configuration + +QUIC allows a connection to be configured in a particular way with a set of transport parameters and frames. The transport parameters are exchanged in the cryptographic handshake. QUIC frames are used to configure how endpoints communicate. For example - the PADDING frame allow to vary the packet size, MAX\_STREAM\_ID frame indicates the maximum bidirectional or unidirectional stream ID permitted to open for the connection. Moreover, new transport parameters and frames can be added to extend the configuration. + +### 5.3.14 User-Land Implementations + +User space implementations of QUIC do not require elevated permissions. This allows application to include a QUIC implementation without any operating system changes. This simplifies deployment of QUIC, where only the application intending to use QUIC needs to be updated. This flexibility can also be used to fine tune the protocol behaviour to a particular application. However, there exists some risk with this, as even if an implementation is following the requirement of a certain QUIC version, the choices to optimize the implementation may result in poorer performance between two differently optimized implementations. Running separate QUIC applications in each application's user space has the impact on performance and resource efficiency in large-scale deployment scenario, which may not be a big problem for equipment with specific function in 5G Core. + +The implementation in user space also results in certain challenges that can affect performance. Efficiency of the API towards the UDP receive and send functions is one such case. Other complications can be access to high performance timers and operating system's scheduling granularity. + +### 5.3.15 Pluggable Sender Side Congestion Control + +As QUIC implementation can reside in an application, it allows more experiment with congestion control algorithms. QUIC can customise different congestion control algorithms for connections of the same application. Compare to TCP, pluggable sender side congestion control makes it pretty flexible and effective on updating or terminating congestion control algorithms without upgrading operation system. However, the fairness of the bandwidth competition within the same network among applications using different congestion control algorithms needs to be considered. + +Now depending on the operational environment, network and service requirement very specific congestion control algorithm can be deployed in the sender as long as the information in the acknowledgement from receiver is sufficient. + +### 5.3.16 Checking that the QUIC connection is alive + +Another difference with HTTP/2 is that each QUIC endpoint declares an idle timeout during the handshake. If the connection remains idle (no packets received) for longer than the advertised idle timeout, the peer will assume that the connection has been closed. + +HTTP clients are expected to use QUIC PING frames to keep connections open if necessary, to verify that their peers are still alive or to check reachability to the peer. Without using QUIC PING frames, an inactive connection will time out. The frequency of sending PING frames is controlled by applications. + +### 5.3.17 62 bits stream identifiers + +QUIC stream identifiers are coded as variable length integers allowing upto a length of 62 bits, instead of 31 bits with HTTP/2. Out of the available 62 bits for stream ID encoding, 2 least significant bits are used to indicate who initiates the stream (client / server) and whether the stream is unidirectional or bidirectional. Hence for client initiated bidirectional streams to carry the requests and responses of 3GPP Service Based Interfaces, the available space is $2^{60}$ stream IDs. + +**NOTE:** For variable length integer encoding the 2 MSB bits are used to derive the length of the integer. The 2 MSB bits are coded as base 2 logarithm of the total length of the variable length integer in octets. Thus for a 64 bit sized entity, the 2 MSB bits are 11 (i.e. value 3), indicating that the length of the integer is 8 octets of which only 62 bits are usable. See clause 16 and clause 2.1 of IETF RFC 9000 [5]. + +Stream ID exhaustion becomes nearly impossible during the lifetime of a QUIC connection. This may simplify the management of connections in 5GC. + +### 5.3.18 Running atop of UDP + +When comparing HTTP/3 with HTTP/2, one should compare the complete protocol stack. HTTP/2 runs either on top of TCP or on top of TLS/TCP, while HTTP/3 runs on top of QUIC/UDP, where QUIC natively incorporates TLS. In other words, the difference goes well beyond replacing TCP with UDP, as TCP is mainly replaced by QUIC/UDP from the transport layer point of view. The purpose for using UDP in HTTP/3 stack is to ensure that QUIC packets pass transparently through legacy middleboxes including OS, router, firewall etc. However, due to DDoS attack avoidance, or other network operating consideration, network operators configure the network to limit the peak rate of UDP packets, which will heavily impact the exact performance behavior of QUIC and delay the popularity of QUIC deployment in particular districts. It could be a kind of deadlock for QUIC traffic used in internet until HTTP/3 is wildly accepted. For SBI being used within Telco network, this will not be a big issue. + +## 5.4 Features of QUIC Applicable to 3GPP SBI + +### 5.4.1 General + +This clause reviews the features of HTTP/3 and QUIC that are applicable to 3GPP SBI and under which cases and conditions they are applicable. + +### 5.4.2 Framing and Multiplexing + +This feature allows QUIC to multiplex multiple streams in to a single connection and avoid head of line blocking. The upper layer protocols can use the QUIC transport in efficient ways to prioritize, parallelize and even cancel standing data sent or received without having to manage multiple connections. Hence, to get the most of a QUIC connection this feature is important. When it comes to SBI, there are definitely cases where one NF consumer will have number of multiple standing requests to one of the NF providers. The HTTP/3 and QUIC framing and multiplexing provides essential support to perform the task efficiently. The efficiency gain in HTTP/3 and QUIC, compared to HTTP/2 over TLS/TCP, exists only when the transport connection is subject to packet loss. This is when TCP's head of line blocking will not allow releasing received data to higher layer, even if the data is completely received for independent HTTP/2 requests or responses. + +### 5.4.3 Encrypted and Integrity Protected Transport details + +Encryption and integrity protection are a very important aspect of the whole SBI concept. 3GPP has mandated the support of TLS 1.2 or 1.3 for 5G core. The NF provider needs to be sure about the identity of the NF consumer before serving. Even though a higher layer authentication could serve the purpose of the NF consumer authentication, protection in the transport layer can be very important for a PLMN to function properly. Moreover, the SBI opens up the possibility to run packet core in a general-purpose cloud environment where the communication between inter PLMN and intra PLMN need to be secure and integrity protected. + +Having transport layer integrity and authentication mechanism the transport protocol is hardened against both attacks and random corruptions that could affect the transport protocols action. For example, cryptographic integrity protection is many magnitudes better at detecting modifications of the transport protocol packet. Cryptographic integrity protection captures packet modifications of both random types, as well as hostile modifications, where checksums only have a weaker protection against random errors. This improvement prevents fouling up the transport protocol state, affecting performance and loss recovery. Data errors in IP/TCP packets that the TCP checksum fails to detect will result in the corrupt data being passed to TLS. TLS integrity verification of the TLS record will detect this corruption. Normally in this case, there are no alternative to terminating the TCP connection and restart it and re-issue the outstanding HTTP requests. QUIC's integrity verification will in this case only result in the individual packet being dropped, request retransmission, and not affect the connection state. + +### 5.4.4 Connection setup improvements + +QUIC can achieve faster connection establishment compared to TCP+TLS combination. The applicability of this features depends on the model is used for inter-NF communication. When long lived connection is used in between NFs which uses SBI for communication even if QUIC provides faster connection it will not impact the performance of the inter-NF communication significantly as only the initial request for a connection will see any improvement. However, if short lived connection models are used where NF-NF connection will be created for each request and response pair, QUIC will provide a faster experience of executing task via HTTP request/response as one or two RTT are saved. + +Overall the faster connection setup time will provide faster connection between NFs in start-up and/or recovery phase while lots of connection supposed to be made at once or in parallel. + +### 5.4.5 Connection ID and Connection Migration + +The connection ID provides certain flexibility in how the implementers realize front-end load-balancers for QUIC as the QUIC connection is not bound to 5 tuples (protocols and ports). In the case of SBI, both for cloud native implementation or bare metal implementation, this connection ID will provide the ability to establish network interface agnostic connection and move the connect between the interfaces as required without terminating the QUIC connection. + +Server-side migration is currently only specified to be done shortly after connection handshake using the Server Preferred Address mechanism discussed in Clause 9.6 of IETF RFC 9000 [5]. This mechanism requests that the client sends the packet destined to the server to this preferred address instead of the original one. Future versions or extensions may specify mid connection server side migration. + +Client-side migration may occur at any point after the handshake has completed. This can be done intentionally by the client when another network interface has become available, where it first probes the new path from this other interface to the server, and after path verification starts using non-probing packet, thus completing the migration. It can also occur implicit, due to a NAT rebinding where the server-side observable source address and port has changed due to this rebinding. Here the use of non-probing packets results in immediate path migration to the new path, and at the same time the server initiates a path validation. + +### 5.4.6 Improved Recovery and Acknowledgement + +When the transport connection is subject to packet loss, QUIC recovery and acknowledgment mechanisms allow to optimally retransmit the lost frames and to avoid unnecessary retransmissions of data that have reached the receiver. + +## 5.5 Features of QUIC Not Applicable to 3GPP SBI + +### 5.5.1 General + +This clause reviews the features of QUIC that potentially are not applicable to 3GPP SBI and why they are not applicable. + +### 5.5.2 0-RTT DATA + +0-RTT Data has very limited applicability to 3GPP SBI for several reasons. The foremost is the security properties of 0-RTT data. As the 0-RTT data is protected using a Pre-Shared Key (PSK) and not a connection specific established state, the 0-RTT data is possible to replay by an adversary. It also does not have full forward secrecy, i.e. if the PSK key is later compromised, then this message can be decrypted at that point. + +The possibility for replay has multiple impacts. If the HTTP request in the 0-RTT data was not idempotent then the state of the NF could be changed (so IETF RFC 9001 [6] specifies that "0-RTT MUST NOT carry a self-contained trigger for any non-idempotent action"). Secondly, when replaying the order of requests can be changed by an adversary. Thus, changing the effect of them, e.g. moving a delete after a create. If multiple replays are allowed additional attacks are possible, including timing and measurement to attempt to determine other state. Overload concerns are also present both on the server side, as well as using 0-RTT as a method for amplifying the amount of data a spoofed source address attack results in. + +Due to that many 3GPP SBI requests are not idempotent the potential use of 0-RTT data is very limited. By not allowing its use at all several vulnerabilities are avoided, resulting in a safer and less complex systems as no mitigations are needed. + +In any case, given that the considerations on applicability of this feature are essentially related to security, it should be up to SA3 to determine whether it is recommended or not to use this feature in 3GPP networks; also, the recommendation may be dependent on intra vs inter -PLMN scenarios. + +## 5.6 Comparison of Applicable Features with Rel-15 Transport + +Table 5.6-1 provides a comparison of the features supported by HTTP/3 that are applicable to the 5GC SBI with HTTP/2 over TLS/TCP, based on the requirements from Transport Protocol for 3GPP 5GC SBI defined in clause 5.2 and additional evaluation criteria. + +**Table 5.6-1: Comparison of HTTP/3 and HTTP/2** + +| Requirement/ Evaluation Criterion | HTTP/2 over TLS/TCP | HTTP/3 | +|--------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| R1. Reliable message delivery | TCP supports reliable and order-of-transmission delivery of data. | QUIC supports reliable and order-of-transmission delivery of data per stream. | +| R2. Flow control and congestion control mechanism | Flow control is supported at connection and stream levels.

TCP provides end-to-end congestion control, but with significant throughput reduction in case of packet loss. | Flow control is supported at connection and stream levels.

QUIC supports advanced mechanisms for loss detection recommending TCP NewReno for congestion control. Implementations may use other algorithms.

QUIC treats a Congestion Explicit Congestion Notification (ECN) in the IP header as a signal of congestion. | +| R3. Support of connection semantics | One HTTP connection maps to one TCP connection. | One HTTP connection maps to one QUIC connection. | +| R4. Failure to deliver one message shall not block subsequent messages | Head-Of-Line (HOL) blocking occurs if TCP segments get lost, delaying the delivery of all subsequent HTTP requests/responses until the lost segments are retransmitted. | QUIC avoids blocking the delivery of data for any other streams when a packet loss contains only part of a stream.

How much benefits this brings depends on how much packet loss occurs in the network. | +| R5. Transport protocol supports mechanisms to authenticate peer endpoint and to secure transfer of application messages | Authentication and secure transfer of application messages are provided by TLS (unless security is provided by other means).

NF service access authorization relies on OAuth2 using TLS. | QUIC uses TLS 1.3 for key establishment, but it has its own encryption and integrity layer that protects the QUIC packets.

NF access authorisation is FFS. | +| A1. Framing and Multiplexing | HTTP/2 supports multiplexing multiple parallel requests in separate streams in a non-blocking fashion (at HTTP level) over the same TCP connection.

See also R4 for HOL at TCP level. | HTTP/3 supports multiplexing of multiple parallel requests in separate streams in a non-blocking fashion over the same QUIC connection. | +| A2. Connection Setup Improvements | 1 ½ RTT is required to setup the TCP connection. 1 ½ RTT is required to setup the TLS connection.

Clients can start sending HTTP requests after 1 RTT (without using TLS) or 2 RTT (with TLS). | By combining connection setup and TLS handshakes, QUIC improves connection setup latency and security allowing 0-RTT connection setup. However, the precondition of the improvement is that the NF service consumer has had an earlier connection with the NF service provider so that it can reuse the earlier learnt connection settings including the security keys for 0-RTT. When using stateless services, no earlier connection to the same service instance can be assumed. In addition, if the connection is persistent the impact of 0-RTT connection setup is minimal to the overall performance. | + +| | | | +|----------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| A3. Failover to Alternate Path |

TCP does not support multi-homing.

Failover to alternate paths can be supported by setting up additional TCP connections.

This requires the client to detect path failures (e.g. based on PING frames) and to switch to alternative TCP connection(s).
The server cannot send responses on an alternate path.

|

QUIC does not support multi-homing (like supported by SCTP).

QUIC supports client-side migration after the handshake has completed, and server-side migration shortly after the connection handshake, giving some flexibility to move the connection between interfaces without terminating the QUIC connection.

Failover to alternate paths can also be supported by using additional QUIC connections.

This requires the client to detect path failures (e.g. based on PING frames) and to migrate the connection to another network interface / local address, or to alternative QUIC connection(s).

There is no mechanism defined by QUIC that correlates heart beats and switching to failover paths; this has to be provided at the application layer.

The server cannot migrate the connection to a different network interface / local address during the lifetime of the connection.

The server cannot send responses on an alternative path, unless the client has migrated the connection on the client side.

| +| A4. Low Response Time |

Significant throughput reduction by TCP in overload and TCP head-of-line blocking are potential issues. See R4.

|

Throughput reduction due to congestion response for QUIC is similar to TCP's. QUIC based transport avoids head-of-line blocking. See R4.

| +| A5. Scalability | FFS | FFS | +| A6. Time of Availability of used standards | Already available. | Planned completion by July 2019. | +| A7. Ease of troubleshooting and Monitoring |

Many tools exist to trace/monitor HTTP REST APIs.

If TLS end-to-end encryption is used, this renders centralized logging at intermediates impossible.

An HTTP response follows the same path as its request as it is sent on the same TCP connection.

|

Many tools exist to trace/monitor HTTP REST APIs, but less widespread support for QUIC so far.

QUIC requires end-to-end encryption that would render centralized logging at intermediates impossible or much more complex. QUIC exposes a spin bit in short packet header to measure the RTT of a connection.

An HTTP response follows the same path as its request as it is sent on the same QUIC connection.

| +| A8. Ease of traversal of carrier-grade ALG/NAT/firewall |

Need to configure operator-grade firewalls to pass TCP/TLS/HTTP. For bidirectional communication, configuration for two connections may be required, but security gateways can reduce the number of required connections (see 3GPP TS 33.210 [24]).

|

Need to configure operator-grade firewalls to pass UDP/QUIC. For bidirectional communication, configuration for two connections may be required, but security gateways can reduce the number of required connections (see 3GPP TS 33.210 [24]).

| +| A9. Impacts to GSMA GRX/IPX |

Support being defined for Rel-15 (see GSMA NG 113 [25]).

| No HTTP/3 support so far. | +| A10. Use of proxies |

HTTP/2 supports the use of proxies in the path.

|

HTTP/3 Proxy functionality still at very early stage (see clause 6.2).

| + +| | | | +|--------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| A11. Idle HTTP connections | PING frames are used to test whether a connection is still alive. | PING frames are used to test whether a connection is still alive and to keep the connection alive.
QUIC endpoint declares an idle timeout during the handshake. If the connection remains idle (no packets received) for longer than the advertised idle timeout, the peer will assume that the connection has been closed. | +| A12. Availability of standard APIs (e.g. socket APIs) | Many libraries to choose from for HTTP/2. | QUIC support is not yet so widespread. | +| A.13 Stream IDs | HTTP/2 stream identifiers are coded with 31 bits. Stream IDs can exhaust during the lifetime of the HTTP/2 connection, which complexifies the management of connections. | QUIC stream identifiers are coded with 62 bits. Stream IDs exhaustion becomes nearly impossible during the lifetime of a QUIC connection, which simplifies the management of connections. | +| A14. Message Prioritization | Client and Server can set the priority of an HTTP request and response.

Multiple HTTP/2 connections between two HTTP/2 end points are necessary: one per DSCP value (see clause 6.8.8 of 3GPP TS 29.500 [4]), which complexifies the management of connections. | QUIC relies on receiving priority information from the application. QUIC frames do not allow to exchange priority information between peers.

Only the client is allowed to send HTTP/3 PRIORITY frames over the request or control stream.

There is an assumed integration between the HTTP/3 layer and QUIC to enable QUIC packet sender to prioritize the different streams based on what is configured on the HTTP/3 layer.

Multiple QUIC connections may still be necessary for messages with different SBI message priorities / DSCP to handle congestion control correctly, since using multiple DSCP on the same QUIC connection could confuse the congestion control algorithm, as it does not separate information on the different priority levels. The general problem is discussed in clause 5.1 of IETF RFC 7657 [29]. | + +# 6 HTTP/3 + +## 6.1 Introduction + +This clause will contain description about the mapping and usage of HTTP/3 including some of the not so well understood/documentated aspects. + +Figure 6.1-1 provides an overview of the HTTP/2 and HTTP/3 protocol stacks, highlighting key features of the HTTP and transport layers. See clause 5.3 for a detailed description of the QUIC features. + +![](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +| | | | | | | | | | | | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|--------|-----|-----|----|----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|--------|------|-----|----|----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

HTTP/2 layer

  • ● Binary framing
  • Multiplexing (frames associated to streams)
  • ● Header compression (static and dynamic tables): HPACK
  • ● Stream based transfer with priority and stream concurrency control
  • ● Flow control at connection and stream levels
  • ● Server Push
|

HTTP/2 over TLS/TCP
(TCP connection)

Application
HTTP/2
TLS
TCP
IP
L2

HTTP/2
protocol stack

| Application | HTTP/2 | TLS | TCP | IP | L2 |

HTTP/3 over QUIC/UDP
(QUIC connection/UDP)

Application
HTTP/3
QUIC
UDP
IP
L2

HTTP/3
protocol stack

| Application | HTTP/3 | QUIC | UDP | IP | L2 |

HTTP/3 layer

  • ● binary framing (modified HTTP frames)
  • ● Header compression (static and dynamic tables): QPACK
  • ● Server Push
  • ● 1 HTTP transaction (without server push) maps to 1 QUIC stream

QUIC layer

  • ● binary framing (QUIC frames)
  • Multiplexing (QUIC streams)
  • Protected transport (TLS)
  • TCP-like retransmission and congestion control
  • ● Stream based transfer with priority and stream concurrency control
  • ● Flow control at connection and stream levels
| +| Application | | | | | | | | | | | | | | | | +| HTTP/2 | | | | | | | | | | | | | | | | +| TLS | | | | | | | | | | | | | | | | +| TCP | | | | | | | | | | | | | | | | +| IP | | | | | | | | | | | | | | | | +| L2 | | | | | | | | | | | | | | | | +| Application | | | | | | | | | | | | | | | | +| HTTP/3 | | | | | | | | | | | | | | | | +| QUIC | | | | | | | | | | | | | | | | +| UDP | | | | | | | | | | | | | | | | +| IP | | | | | | | | | | | | | | | | +| L2 | | | | | | | | | | | | | | | | + +**Figure 6.1-1 HTTP/3 vs. HTTP/2 protocol stacks** + +With HTTP/2 protocol stack, TLS is used conditionally when the security is not provided by other means. + +With HTTP/3 protocol stack, TLS is integrated into QUIC and is used always, i.e. TLS is mandatory. + +## 6.2 HTTP/3 Proxies + +### 6.2.1 General + +HTTP clients can be configured to route their outgoing HTTP requests via a HTTP proxy. If the NF service consumer (i.e. HTTP client) is configured to route its message via a HTTP proxy, the NF service consumer will try to setup a transport connection towards the proxy. If the NF service consumer knows that the proxy supports QUIC based on configuration or other offline means, the transport connection towards the HTTP proxy may use QUIC. Thereafter how the HTTP/3 proxy further communicates with the NF service producer for various scenarios are explained in the clauses below. + +![Diagram illustrating NF Service Consumer to NF Service Producer Communication with HTTP/3 Proxy on Path. The diagram shows four main components: NRF, HTTP Client – NF Service Consumer, HTTP Proxy, and HTTP Server – NF Service Producer. The NRF is at the top right. The HTTP Client is on the left, with a label 'Discover HTTP Proxy Transport Offline' above it. The HTTP Proxy is in the center, represented by a globe icon. The HTTP Server is on the right, also represented by a globe icon. Arrows show the flow: 1. HTTP Client to NRF: 'Discover NF Service Producer Profile'. 2. HTTP Client to HTTP Proxy: 'HTTP/3'. 3. HTTP Proxy to HTTP Server: 'HTTP over TCP or QUIC?'. Each component has a small icon next to it representing a device or server.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +Diagram illustrating NF Service Consumer to NF Service Producer Communication with HTTP/3 Proxy on Path. The diagram shows four main components: NRF, HTTP Client – NF Service Consumer, HTTP Proxy, and HTTP Server – NF Service Producer. The NRF is at the top right. The HTTP Client is on the left, with a label 'Discover HTTP Proxy Transport Offline' above it. The HTTP Proxy is in the center, represented by a globe icon. The HTTP Server is on the right, also represented by a globe icon. Arrows show the flow: 1. HTTP Client to NRF: 'Discover NF Service Producer Profile'. 2. HTTP Client to HTTP Proxy: 'HTTP/3'. 3. HTTP Proxy to HTTP Server: 'HTTP over TCP or QUIC?'. Each component has a small icon next to it representing a device or server. + +**Figure 6.2.1-1 NF Service Consumer to NF Service Producer Communication with HTTP/3 Proxy on Path** + +### 6.2.2 When NF Service Consumer Side Uses QUIC + +#### 6.2.2.1 Case A: Invoking http API Supporting Only TCP Transport + +This case is not described in IETF RFC 9114 [7]. + +In this scenario: + +- NF service consumer supports QUIC and has established a QUIC transport connection with its next hop HTTP proxy; +- NF service consumer discovers that NF service producer supports only TCP. +- The URI scheme of the API exposed by the NF service producer is http + +In this case, the NF service consumer has the following options: + +- Option#1: The NF service consumer uses TCP transport towards the proxy as well. This implies the proxy also supports TCP transport (which is a reasonable assumption considering that during the migration from TCP to QUIC many HTTP entities will support both transports). +- Option#2: The NF service consumer uses QUIC transport towards the HTTP proxy and the proxy uses TCP transport towards the NF service producer. The HTTP proxy discovers whether the NF service producer supports TCP or QUIC based on apriori connection setup. For example, in the case of SEPP all NFs in a PLMN connect to the SEPP and establish a HTTP/2 or HTTP/3 connection depending on what transport is supported by both the SEPP and the NF service producer. IETF RFC 9114 [7], clause 3.2 specifies that HTTP/3 clients shall indicate the target domain name during the TLS handshake of QUIC connection setup. The certificate provided at connection setup shall be valid for the target domain name. + +**Editor's Notes:** It is unclear what domain name shall be used for the target domain name when the connection is with a proxy (proxy domain name or the origin server one). + +The draft also says in clause 3.3 that a connection to a server endpoint may be reused for requests with multiple different URI authority components. The client may send any requests for which the client considers the server (the one at the existing connection endpoint) authoritative. + +**Editor's Notes:** In our case the client knows that existing QUIC connection ends at a proxy and not at a server. So it is unclear if we can reuse an existing QUIC connection to a proxy endpoint. Also it is unclear if a client can consider a proxy as an authoritative server as proxies and servers are essentially different HTTP entities. + +The RFC specifies in clause 3.3 how the client knows that the server at the endpoint of the reused QUIC connection (the proxy in our case) is authoritative for requests directed to other domains. It mentions that typically the client discovers that a particular server is the authoritative HTTP/3 endpoint based on the client having received Alt-Svc HTTP response header or the HTTP/2 ALTSVC frame (see IETF RFC 7838 [20]). + +**Editor's Note:** Whether other mechanisms other than use of IETF RFC 7838 [20] can be considered to discover a particular HTTP/3 endpoint is the authoritative endpoint for a URI authoritative component is FFS. + +Finally, the clients shall check that the nominated server can present a valid certificate for the Origin Server before considering it authoritative. Therefore, the HTTP proxy has to present a certificate to the HTTP/3 client on behalf of the HTTP Origin Server (NF service producer) that is valid for multiple domain names and signed by the client network's own certificate authority. In roaming, the client network owner (the VPLMN) and the origin server network owner (the HPLMN) are different authorities and such a certificate is impossible to issue by a regular certification authority (e.g. Verisign). The only possibility is that the HTTP client should be configured to trust the HTTP proxy as the certificate authority. Only then this option#2 will work. + +- Option#3: The NF service consumer uses QUIC transport towards the HTTP proxy. The proxy provides a certificate only valid for itself at QUIC connection setup. When the NF service consumer needs to send a request to an NF Service producer it first establishes a tunnel through the proxy by sending an HTTP CONNECT message in a new stream with an ":authority" pseudo-header field identifying the NF Service producer. The proxy then creates a TCP connection towards the NF service producer. Once the TCP connection is completed, a tunnel is created between the NF service consumer and producer. This tunnel is used by the NF service consumer to create a direct HTTP/2 connection (without an end to end TLS) with the NF service producer. HTTP/2 messages can now flow between the two entities. This is illustrated by the figure below. + +![Diagram illustrating the HTTP/3 Proxy tunneling process to an NF Service Producer.](9167fa5ebcb66516d1bbb421ec9bba7b_img.jpg) + +The diagram shows three main components: HTTP/3 Client, HTTP/3 Proxy, and HTTP/TCP Server. The client is shown with a stack of layers: UDP, QUIC Transport Security, QUIC Stream, and HTTP/2 Connection. The QUIC Stream contains a CONNECT message for 'nf-producer.com'. The HTTP/3 Proxy is shown as a tunnel that receives the QUIC Stream and establishes a TCP connection to the HTTP/TCP Server. The HTTP/2 Connection is shown as a stream within the TCP connection, containing HTTP GET/PUT/POST/DELETE messages. The diagram illustrates the flow of data from the client, through the proxy, to the server. + +Diagram illustrating the HTTP/3 Proxy tunneling process to an NF Service Producer. + +**Figure 6.2.2.1-1: http via HTTP/3 Proxy to NF Service Producer Supporting TCP** + +NOTE 1: Option 3 is not described by IETF RFC 9114 [7] which only describes the use of the CONNECT method to setup a TLS session between an HTTP client and an Origin server. Most of the existing implementation also restricts the usage of CONNECT to https URIs. This option excludes the use of current implementations available on the market. However for 3GPP NF services, the HTTP clients will be the HTTP client libraries supported in various programming languages. One could program in such a way to use HTTP CONNECT via a proxy for http URI too. + +NOTE 2: IETF RFC 9114 [7] doesn't explicitly say if the verifications listed in clause 3.3 of the RFC that authorize the reuse of an existing QUIC connection are applicable to the CONNECT method. + +#### 6.2.2.2 Case B: Invoking http API Supporting QUIC Transport + +In this scenario: + +- NF service consumer supports QUIC and has established a QUIC transport connection with its next hop HTTP proxy; +- NF service consumer discovers that NF service producer also supports QUIC. +- The URI scheme of the API exposed by the NF service producer is http + +In this case the NF service consumer uses QUIC transport towards the HTTP proxy and the HTTP proxy also uses QUIC transport towards the NF service producer. The QUIC connections on the both side of the leg of HTTP proxy are separate QUIC connections. As TLS is integrated in QUIC, this means this setup would also terminate the TLS at the proxy which is undesirable. In case of proxying with HTTP/2 only the TCP connection is terminated at the proxy but the TLS connection on top of TCP is end-to-end. + +The figure below illustrates the case where the HTTP client and server are connected with two QUIC connections through an HTTP proxy. + +The connection with the HTTP proxy would be reused for requests sent to multiple domains. When the proxy needs to forward a message to a new HTTP server, it establishes a new QUIC connection with it. The server provides a valid certificate for itself. + +![Diagram illustrating HTTP via HTTP/3 Proxy to NF Service Producer Supporting QUIC. An HTTP Client and HTTP Proxy are shown within a box labeled 'Domaine name C'. A red line labeled 'QUIC connections' connects the client to the proxy. From the proxy, four red lines extend to four separate boxes: 'HTTP Server A1', 'HTTP Server A2' (grouped under 'Domaine name A'), and 'HTTP Server B1', 'HTTP Server B2' (grouped under 'Domaine name B').](303fadfb9def251d1575d6221199b158_img.jpg) + +Diagram illustrating HTTP via HTTP/3 Proxy to NF Service Producer Supporting QUIC. An HTTP Client and HTTP Proxy are shown within a box labeled 'Domaine name C'. A red line labeled 'QUIC connections' connects the client to the proxy. From the proxy, four red lines extend to four separate boxes: 'HTTP Server A1', 'HTTP Server A2' (grouped under 'Domaine name A'), and 'HTTP Server B1', 'HTTP Server B2' (grouped under 'Domaine name B'). + +Figure 6.2.2.2-1: http via HTTP/3 Proxy to NF Service Producer Supporting QUIC + +Case B is not described in IETF RFC 9114 [7] and the same questions regarding the QUIC connection with the proxy as specified for Case A remains open with Case B. + +As per IETF RFC 9114 [7], clause 3.3, a HTTP client MUST verify if the nominated HTTP server it is communicating with (i.e. HTTP proxy in this case) can present a valid certificate for the origin before considering it authoritative. Hence in order to setup an end to end QUIC connection between the HTTP client and the HTTP server via a HTTP/3 proxy, an equivalent of HTTP CONNECT to setup a tunnel is required. Currently such an option does not exist. HTTP CONNECT is used only when the URI scheme is https and upon getting a HTTP CONNECT request a HTTP/3 proxy establishes a TCP connection with the HTTP server (and not a QUIC connection) as specified in clause 4.4 of IETF RFC 9114 [7]. + +NOTE: The use of HTTP CONNECT by HTTP clients when accessing https URI via a proxy is not mandated in IETF RFC 7231 [22]. However many browsers by default use HTTP CONNECT when accessing https URIs via a proxy. For 3GPP NF services, the HTTP clients will be the HTTP client libraries supported in various programming languages. One could program in such a way not to use HTTP CONNECT via a proxy and trust the certificates issued by the proxy effectively allowing the proxy to act as man in the middle. + +IETF draft-pardue-httpbis-http-network-tunnelling-01 [21] tries to provide a solution that permits a UDP-based HTTP/3 client behind an HTTP proxy to establish an HTTP/3 session with the origin. As the successor approach, IETF is reviewing a working group formation proposal to work on a HTTP based proxying solution for end to end encrypted traffic, named MASQUE, see IETF draft-ietf-masque-connect-ip-13 [35]. This result of this work will allow the end point to communicate with end to end QUIC encryption while use the proxy on the path. This means the HTTP client (consumer) will maintain a QUIC tunnelling connection towards the HTTP/3 proxy and inside that tunnel the consumer will have an end to end QUIC connection towards the HTTP server (provider). + +#### 6.2.2.3 Case C: Invoking https API Supporting Only TCP Transport + +In this scenario: + +- NF service consumer supports QUIC and has established a QUIC transport connection with its next hop HTTP proxy; +- NF service consumer discovers that NF service producer also supports only TCP. +- The URI scheme of the API exposed by the NF service producer is https + +In this case the following sequence of events happen + +- HTTP client establishes a QUIC connection with the HTTP proxy, if not setup earlier. +- HTTP client sends a HTTP CONNECT request to the proxy with ":authority" pseudo-header set to the NF service producer FQDN or IP address. +- HTTP proxy sets up a TCP connection with NF service producer (HTTP server). +- HTTP proxy sends a HTTP CONNECT response to the HTTP client. +- HTTP client does end to end TLS connection setup with the NF service producer. An encrypted tunnel between the client and the server is now setup and HTTP/2 connection can be setup on top. + +NOTE 1: The HTTP client has to do encryption twice - one for the TLS tunnel and one for the QUIC connection with proxy. + +NOTE 2: The current design of CONNECT-based tunnelling reserves an ordered byte stream (HTTP/2 and HTTP/3) for the client-to-proxy hop. This is subject to head of-line (HoL) blocking. See IETF draft-pardue-httpbis-http-network-tunnelling-01 [21] clause 3.6. + +This scenario is illustrated in the figure below + +![Diagram illustrating the https via HTTP/3 Proxy to NF Service Producer Supporting TCP. The diagram shows three main components: HTTP/3 Client, HTTP/3 Proxy, and HTTP/TCP Server. The client sends a QUIC Stream with a CONNECT request for 'nf-producer.com' to the proxy. The proxy establishes a TCP connection to the server and tunnels the request through a TLS layer and an HTTP/2 Stream containing the HTTP GET/PUT/POST/DELETE request.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +The diagram illustrates the network architecture for https traffic via an HTTP/3 proxy. On the left, the **HTTP/3 Client** (blue hatched area) contains a **UDP** layer, which carries **QUIC Transport Security**. Inside this, a **QUIC Stream** is shown with a **CONNECT nf-producer.com** request. This request is forwarded by the **HTTP/3 Proxy** (red hatched area) to the **HTTP/TCP Server** (purple hatched area). The proxy establishes a **TCP** connection (yellow cylinder) to the server. Over this TCP connection, a **TLS** layer is established, which in turn carries an **HTTP/2 Stream** containing the **HTTP GET/PUT/POST/DELETE** request. Arrows indicate the flow of data from the client, through the proxy, to the server. + +Diagram illustrating the https via HTTP/3 Proxy to NF Service Producer Supporting TCP. The diagram shows three main components: HTTP/3 Client, HTTP/3 Proxy, and HTTP/TCP Server. The client sends a QUIC Stream with a CONNECT request for 'nf-producer.com' to the proxy. The proxy establishes a TCP connection to the server and tunnels the request through a TLS layer and an HTTP/2 Stream containing the HTTP GET/PUT/POST/DELETE request. + +**Figure 6.2.2.3-1: https via HTTP/3 Proxy to NF Service Producer Supporting TCP** + +According to RFC 7230 [23] clause 2.7.3, the client shall ensure that its connection to the origin server is secured through the use of strong encryption, end-to-end, prior to sending the first HTTP request when the https URI scheme is used. + +When an HTTP proxy is deployed, end-to-end security is ensured by setting-up a tunnel between the client and the Origin server using the HTTP CONNECT method which is then secured with TLS. + +A HTTP client implementation may decide not to enforce E2E security with TLS though the https URI scheme is used and connection to the Origin server is done via a proxy. IETF RFC 7231 [22] does not mandate the use of HTTP CONNECT for accessing https URI via a proxy. If a HTTP client decides not to use CONNECT, then it may trust the certificates issued by the HTTP/3 proxy on behalf of the HTTP/TCP server signed by the proxy's certificate authority, thus allowing the HTTP/3 proxy to act as man in the middle. This would violate the requirement for the HTTP client in RFC 7230 [23] clause 2.7.3. + +Alternatively the NF service consumer may decide to use TCP transport towards the HTTP/proxy similar to option#1 provided in clause 6.2.2.1. In this case, the NF service consumer avoids double ciphering. + +#### 6.2.2.4 Case D: Invoking https API Supporting QUIC Transport + +In this scenario: + +- NF service consumer supports QUIC and has established a QUIC transport connection with its next hop HTTP proxy; +- NF service consumer discovers that NF service producer also supports QUIC. +- The URI scheme of the API exposed by the NF service producer is https + +In this case the following sequence of events happen + +- HTTP client establishes a QUIC connection with the HTTP proxy +- HTTP client sends a HTTP CONNECT to the proxy with URI set to the NF service producer API URI. +- As specified in IETF RFC 9114 [7] clause 4.4, the proxy establishes a TCP connection to the HTTP server. However it is desirable that a mechanism is available for the HTTP/3 proxy to instruct the use of QUIC connection to a HTTP server instead of TCP. +- Currently there is no mechanism that exists in IETF RFC 9114 [7] where a HTTP/3 proxy is instructed to use a QUIC connection to a HTTP server instead of TCP. + +IETF draft-pardue-httpbis-http-network-tunnelling-01 [21] tries to provide a solution that permits a UDP-based HTTP/3 client behind an HTTP proxy to establish an HTTP/3 session with the origin. But at this moment this is an individual draft and is in very early stage. + +According to RFC 7230 [23] clause 2.7.3, the client shall ensure that its connection to the origin server is secured through the use of strong encryption, end-to-end, prior to sending the first HTTP request when the https URI scheme is used. + +A HTTP client implementation may decide not to enforce E2E security though the https URI scheme is used and connection to the Origin server is done via a proxy. IETF RFC 7231 [22] does not mandate the use of HTTP CONNECT for accessing https URI via a proxy. If a HTTP client decides not to use CONNECT, then it may trust the certificates issued by the HTTP/3 proxy on behalf of the HTTP/3 server signed by the proxy's certificate authority, thus allowing the HTTP/3 proxy to act as man in the middle. This would violate the requirement for the HTTP client in RFC 7230 [23] clause 2.7.3. + +### 6.2.3 When NF Service Consumer Side Uses TCP + +#### 6.2.3.1 Invoking http API Supporting QUIC Transport + +In this scenario: + +- NF service consumer supports only TCP and has established a TCP transport connection with its next hop HTTP proxy; +- NF service consumer discovers that NF service producer supports QUIC. +- The URI scheme of the API exposed by the NF service producer is http + +In this case the HTTP proxy has to act as a HTTP/TCP proxy on one side and as a HTTP/3 client on the other side. The proxy simply relays the message received on TCP connection to the QUIC connection. But in order for the proxy to setup a QUIC connection with the NF service producer, the proxy has to discover that the NF service producer supports QUIC. This can be achieved by using solution described in clause 8.2.2. This means the NF service producer also should support TCP. + +#### 6.2.3.2 Invoking https API Supporting QUIC Transport + +In this scenario: + +- NF service consumer supports only TCP and has established a TCP transport connection with its next hop HTTP proxy; +- NF service consumer discovers that NF service producer supports QUIC. +- The URI scheme of the API exposed by the NF service producer is https + +When https scheme is used, the HTTP client first sends a HTTP CONNECT request to the HTTP proxy. However as per IETF RFC 9114 [7], clause 4.4 and IETF RFC 7231 [22], clause 4.3.6, when a HTTP proxy receives a HTTP CONNECT method, it establishes a TCP based tunnel towards the NF service producer (the HTTP destination origin server) so that a TLS connection end to end from the HTTP client to the HTTP destination origin server can be setup. Since the semantics of HTTP CONNECT demands this, the HTTP proxy will not use QUIC towards the HTTP server (NF service producer) even if it supports QUIC. + +A HTTP client implementation may decide not to use HTTP CONNECT to access a https URI via a proxy. IETF RFC 7231 [22] does not mandate the use of HTTP CONNECT for accessing https URI via a proxy. If a HTTP client decides not to use CONNECT, then it may trust the certificates issued by the HTTP/3 proxy on behalf of the HTTP/TCP server signed by the proxy's certificate authority, thus allowing the HTTP/3 proxy to act as man in the middle. This would violate the requirement for the HTTP client in RFC 7230 [23] clause 2.7.3. + +## 6.3 Considerations for HTTP/3 + +### 6.3.1 General + +3GPP TS 29.500 [4] mandates HTTP/2 over TCP as protocols to be used for SBI. Running HTTP/3 requires special consideration as many of the HTTP/2 features can be taken care of by QUIC. HTTP/2 and QUIC contains similar features like stream, framing, multiplexing. Moving from HTTP/2 over TCP to HTTP/3 will require the application layer protocol behavior and implementation to be changed. Hence, it is important to identify the changes required both in HTTP/2 and QUIC implementations. This clause details the features and properties need special attention when HTTP/3 is used. + +### 6.3.2 Connection setup and management + +To use HTTP over QUIC requires explicit discovery of QUIC protocol support in the client and server. The server can advertise the support for the QUIC as a transport protocol then client can use some explicit information provided by the server or prior knowledge of the previous contact to the server to select QUIC as a transport protocol. Different alternatives to do the discovery of QUIC support in the NFs are discussed in clause 7.2. + +QUIC connection level settings are communicated between client and server at the crypto handshake. However, the HTTP/3 specific settings (see IETF RFC 9114 [7]) are set via SETTINGS frame sent by the client and server via the HTTP/3 control stream after QUIC connection is established. + +As QUIC allows stream multiplexing the HTTP clients can multiplex multiple HTTP/3 requests on to same QUIC connection as long as the server has the authority to serve the request. This reduces the need for multiple connections and improves performance by avoiding the time it takes to establish new connections. In case of SBI, every consuming NF will originate request to a specific provider NF. Hence, there will be one to one mapping between the server and origin. However, it is also possible to install a frontend proxy to hide a number of provider NFs that is managed by one administration. In this case the NF consumer will establish single connection towards the frontend proxy and multiplex request towards different NF providers over a single QUIC connection, treating the frontend proxy as a server endpoint. + +### 6.3.3 Streams, framing and multiplexing + +The QUIC stream number space is larger than that of HTTP/2. HTTP/3 uses a completely new framing concept. The HTTP/2 framing is completely changed, including the basic HTTP/2 Frame Header layout. Consequently HTTP/3 uses only the QUIC streams and does not have a stream Identifier in the HTTP/3 frame header.. + +Another important difference is the HTTP/3 only guarantee ordered delivery on the stream level while HTTP/2 expects absolute ordering on the frames across multiple streams. HTTP/3 will break any such ordering assumption. + +When HTTP runs over QUIC the HTTP layer does not require to do any stream multiplexing. QUIC maps each of its streams to a HTTP transaction. A stream is closed when the RESET\_STREAM is received in QUIC. In HTTP/2, a stream is half-closed when the frame with END\_STREAM bit set is received, and is closed when the RESET\_STREAM is received. The additional difference is that in the current specification, HTTP/3 does not use server initiated bidirectional stream. This means unidirectional streams are created from both the client and server with indication of the purpose of the stream as stream header at the beginning of the streams. All client initiated bidirectional streams are used for requests and responses. + +**Editor's Note:** Some aspects of connection management are still not clearly defined in the IETF drafts, such as the usage of client-initiated vs. server-initiated streams, and bi-directional vs. unidirectional streams. A more accurate description and analysis of these aspects is FFS, once the IETF drafts are further developed. + +The HTTP/3 frame type definition follows QUIC encoding concept. QUIC uses a variable length integer encoding which allows a larger number of stream IDs compared to HTTP/2 encoding. This change results in different HTTP/3 frame types and requires a mapping from HTTP/2 to HTTP/3 frame types. HTTP/3 (see IETF RFC 9114 [7]) defines this mapping of HTTP/2 over HTTP/3. + +### 6.3.4 Prioritization + +In case of HTTP/2 the clients can set stream priority as defined in IETF RFC 7540 [13], at the creation of the stream and update the priority using PRIORITY frame. However, in case of HTTP/3, only the client is allowed send PRIORITY frames over control stream. The priority clause on the HEADER frame is removed. + +### 6.3.5 Server Push + +HTTP/3 uses a different server push mechanism than what is defined for HTTP/2 in IETF RFC 7540 [13]. HTTP/3 uses two new frames to accomplish server push – a) a modified PUSH\_PROMISE frame and b) a MAX\_PUSH\_ID. The modified PUSH\_PROMISE frame does not refer to a stream as originally designed in IETF RFC 7540 [13], it uses as PUSH\_ID that uniquely identifies a server push. HTTP/3 defines the use of PUSH\_IDS in PUSH\_PROMISE frame, DUPLICATE\_PUSH frame, CANCEL\_PUSH frame and PRIORITY\_FRAME in addition to their use in Push Stream headers (a unidirectional server initiated stream) for now. The server can only push, and it can initiate pushing only one it receives a MAX\_PUSH\_ID frame from the corresponding client. Details of the modified server push mechanism is described in IETF RFC 9114 [7]. + +### 6.3.6 Compression (HPACK vs QPACK) + +The Header Compression for HTTP/2, HPACK (see IETF RFC 7541 [14]), provides compression of HTTP header fields. Significantly reducing the headers, especially for sequential HTTP/2 request responses to the same server, where repeated and redundant information is efficiently compressed. The use of HPACK in HTTP/2 is one of the more significant performance improvements compared to HTTP 1.0 or 1.1. HPACK was defined based on one important assumption, namely the TCP in-order delivery of the different HTTP/2 frame types across all the streams. Thus, the encoder knows in which order the decoder will receive and process the various frames, and how the decoder state will be updated. HTTP/3 does not provide the same deterministic and guaranteed in order delivery mechanism between different HTTP requests. HTTP/3 can avoid this head of line blocking and provide improved performance by delivering to higher layers the HTTP messages in the order they are successfully delivered to the peer. However, if one would use HPACK without modifications, this could result in the decoder blocking or producing the wrong output. Therefore, header Compression for HTTP/3, QPACK (see IETF RFC 9204 [10]), is being defined. + +QPACK is a redesigned version of HPACK that can support out-of-order delivery. It allows flexibility in the encoder to perform trade-offs between compression ratios and likelihood of head of line blocking due to out of order delivery. The changes in QPACK allows for much reduced head of line blocking at similar compression efficiency for a given packet loss rate. It also provides the implementation freedom to select how robust the transaction should be against packet loss. This at the cost of requiring HTTP/3 servers to implement the new QPACK mechanism, even if some reuse of the HPACK implementation is possible. + +# --- 7 Key Requirements for Supporting QUIC + +## 7.1 Introduction + +This clause contains the key requirements to be solved in order for QUIC to be considered as a transport replacement for 5GC SBI. For each of the key requirements listed below, solutions are described in clause 8. + +## 7.2 Discovery of QUIC support + +As Release 15 of 3GPP TS 29.500 [4] defines SBI implementation with protocol combination of HTTP over TCP, the deployment of QUIC as a replacement transport protocol for TCP will require a discovery method for the NF acting as HTTP client for both interoperability and backward compatibility. The discovery of a support of QUIC for a particular SBI must be done at the beginning of connection establishment and if QUIC is supported by the NF acting as server then QUIC should be used for all future communication towards that NF. + +## 7.3 Discovery of NRF's Support for QUIC + +One of the potential solutions for discovering the support of QUIC by an NF is to use the NF discovery service of the NRF (see clause 8.2.1). In order for an NF service consumer to use the NF discovery service of the NRF, the NF service consumer should know the transport protocol capability of the NRF itself. This key issue will address the following aspects: + +- How to discover the transport protocol capability of a NRF? +- How to provide the transport protocol capability of a remote PLMN NRF to a local PLMN NRF for home routed roaming scenarios? + +## 7.4 Migration to QUIC + +Since 5GC deployments based on release 15 will happen initially, any attempt to introduce NF service instances that support QUIC as transport protocol need to be carefully thought about in order to avoid interoperability issues. This key issue will study the following aspects with respect to the migration to QUIC. + +- Steps to follow when adding NF service instances that support QUIC as transport protocol, into the network. +- Deployment topologies where NF service instances that support QUIC as transport protocol can be introduced. +- When the NF service consumers can use the added NF services supporting QUIC? +- Steps to follow to decommission NF services that support TCP, when required. + +## 7.5 Support of Indirect Communication + +Indirect Communication refers to the communication between a NF Service Consumer and an NF Service Producer using a Service Communication Proxy (SCP), in the Rel-16 Service Based Architecture. + +Indirect communication may be supported (see 3GPP TS 23.501 [2]): + +- without delegated discovery (Option C): Based on query result, the consumer does the selection. The consumer sends the request to the SCP containing the address of the selected producer (e.g. an NF instance or NF Service instance set), the SCP may select an instance and it routes the request to the targeted producer instance. +- with delegated discovery (Option D). Consumers do not do any discovery or selection. The consumer adds any necessary discovery and selection parameters required to find a suitable producer to the request. The SCP uses the request address and the discovery and selection parameters in the request message to route the request to a suitable producer instance. In both options, the SCP needs to access and optionally modify the contents of the HTTP messages exchanged between the NF Service Consumer and NF Service Producer. This entails that the HTTP/3 connection cannot be established end to end between the NF Service Consumer and NF Service producer. Instead, standalone HTTP/3 connections need to be set up between the NF Service Consumer and the SCP, between the SCP and the NF Service Producer, and between SCPs if there is more than one SCP between the NF Service Consumer and NF Service Producer. + +This key issue will analyse how to support HTTP/3 for Indirect Communication. + +NOTE: See clause 6.2 for a general description of HTTP/3 in presence of proxies on the path. + +# --- 8 Solutions for Key Requirements + +## 8.1 Introduction + +This clause contains the solutions for the key requirements identified in clause 7. + +## 8.2 Solutions for Discovery of QUIC support + +### 8.2.1 Using the Discovery Service of the NRF + +Using the Discovery Service of the NF Repository Function (See 3GPP TS 29.510 [19]) is a possible solution for discovering if a NF instance's SBI supports using QUIC as transport protocol. + +When a consumer is performing service discovery of NF instances for a service, it will also learn which if any of the instance support using QUIC by having IpEndPoint definitions in the NFProfile with the transport protocol set to QUIC. + +This solution enables the NF consumer to know of the support even prior to attempting to establish a transport connection to the NF producer. The consumer has to use the NRF service discovery irrespectively of the determination of QUIC support. + +The realization of this solution requires definition of the QUIC as TransportProtocol in the NFProfile, see clause 6.1.6.3.5 of 3GPP TS 29.510 [19]. + +The solution will have to determine if this discovery should be only for a general support of QUIC independent of version or if also all the versions should be encoded in the NFProfile. + +A QUIC supporting NF can potentially support several different versions of QUIC, thus efficient enumeration of versions would be desired. + +However, assuming that at least one mandatory to implement version of QUIC will be defined for SBA, it might be sufficient to simply indicate that QUIC in general is supported and rely on the version negotiation mechanism built in in QUIC as that would also avoid any interoperability issues. + +For consumers of NF services that specifically want to determine which instances that support QUIC, extending the set of query parameters defined for the Nnrf\_NFDiscovery Service API (clause 6.2.3.2.3.1 of 3GPP TS 29.510 [19]) will be needed. + +A parameter such as transport-protocol which takes an array of protocol enumerations would solve this issue. + +Here enumerating individual QUIC versions would create some extra complexity. + +### 8.2.2 Using Alt-Svc Header + +The current QUIC working group draft on HTTP over QUIC (HTTP/3) (See IETF RFC 9114 [7]) defines a discovery method of QUIC support using Alt-Svc HTTP response header defined in IETF RFC 7838 [20]. In this case the NF as HTTP server can notify the NF as HTTP client about the support of QUIC protocol with a HTTP response header with any HTTP response. An example of such response will look like below: + +``` +HTTP/1.1 200 OK +Content-Type: text/html +Alt-Svc: h3=":50443";quic="1,labadaba" +``` + +Here, the "h3" is the ALPN token identifies HTTP/3 and "quic" is a new parameter defined to advertise the versions supported by the NF. The syntax of Alt-Svc is defined in IETF RFC 7838 [20] and the "quic" parameter for Alt-Svc header to provide the QUIC version hints, is defined in HTTP/3 IETF draft (See IETF RFC 9114 [7]). + +In this method, the HTTP client acting as NF consumer needs to start connection using TCP for the first contact with a HTTP server acting as NF provider. If the HTTP server response includes the Alt-Svc header then the HTTP client will re-establish HTTP connection over QUIC and save the protocol preference for further connection. After new QUIC connection established towards the HTTP server, the HTTP client must send all the requests over QUIC connection. The HTTP client then can terminate the previously established TCP connection. + +As described, the downside of this method is that the HTTP client for the first contact with a HTTP server has to establish TCP connection to discover the QUIC support and terminate the already established TCP connection. However, this should be only one-time event after discovering that one HTTP server supports QUIC the client must not repeat this discovery event. + +This method allows a gradual deployment of QUIC in the PLMNs and does not require extra information exchange at the NF service discovery phase. + +This solution requires that the HTTP server (NF Service Producer) can be reached over TCP in addition to QUIC, so a server supporting only QUIC would need additional mechanisms to let NF Service Consumers discover such support. + +## 8.3 Solutions for Discovery of NRF's Support for QUIC + +### 8.3.1 Providing NRF Transport Capability from NSSF + +When network slicing is used, the NSSF is queried during + +- Registration procedure; and/or +- PDU session establishment procedure + +to select a network slice instance for the UE / PDU session. The NSSF may optionally return the network slice instance information (NsiInformation) which contains the NRF URI to be used for that network slice instance. In this solution it is proposed to return the NRF's transport capability also as part of the NsiInformation so that the NF service consumer that gets the NRF information from the NSSF knows which transport protocol(s) can be used towards the NRF. + +The NSSF is provided the transport capability of the NRF when OAM configures the network slice instance information into the NSSF. + +### 8.3.2 Providing Remote PLMN NRF's Transport Capability during NF Discovery + +For home routed scenarios, the NRF in VPLMN contacts the NRF in HPLMN, via the SEPP. The issue of how HTTP requests over QUIC are routed when there is a proxy in between (i.e. if SEPP acts as a proxy) are specified in clause 6.2.2. Irrespective of the kind of solutions available for this issue, it may be required for the NF service consumer in VPLMN to provide the transport capability of the HNRF to the VNRF. This solution proposes the following: + +- An NF service consumer in VPLMN discovers the NRF to use in VPLMN and the HPLMN for home routed scenarios by querying the NSSF or by local configuration. If the NSSF is queried, the NF service consumer obtains the transport capability of the VNRF and the HNRF from the NSSF as specified in subclause 8.3.1. + +NOTE: As specified in clause 4.3.2.2.3.3 of 3GPP TS 23.502 [3], the discovery of VSMF/VNRF and HSMF/HNRF happen as separate procedures. The Nnssf\_NSSelection\_Get service is invoked twice in this case. + +- Once the transport capability of both the VNRF and the HNRF are obtained, the NF service consumer knows which transport to use towards the VNRF. +- When the NF service consumer invokes the NF discovery service of the VNRF, it also provides as input the transport capability of the HNRF. +- The VNRF uses this information together with the information about the transport capabilities of the SEPP, taking into consideration the scenarios specified in clause 6.2.2, to decide which transport to use for contacting the HNRF. + +### 8.3.3 Discovery Based On Local Configuration + +In this solution, the transport capability of the NRF is discovered based on local configuration at the NF service consumer. This solution can be used when network slicing is not used or during scenarios where the NSSF is not involved (e.g. AMF does network slice selection based on local configuration). + +## 8.4 Solutions for Migration to QUIC + +### 8.4.1 Deployment Topologies to Introduce NF Services with QUIC Support + +As identified in clause 6.2, HTTP/3 message traversal for http scheme APIs when a HTTP/3 proxy is involved on path is not yet clearly addressed in IETF. Similarly for https scheme APIs, the use of HTTP CONNECT from the HTTP client to the HTTP proxy, creates a TCP connection from the HTTP proxy to the NF service acting as HTTP server resulting in an end to end TLS connection from the HTTP client to the HTTP server. In this case also the presence of HTTP proxy on path implies that an NF service acting as server cannot use QUIC for https scheme APIs, until alternate mechanisms as discussed in IETF in IETF draft-pardue-httpbis-http-network-tunnelling-01 [21] reach some maturity. + +Considering this the following are the deployment topologies where NF services with QUIC support can be introduced into a network without causing any issues in working towards a HTTP client. + +- Intra PLMN NF service communication without any HTTP proxy as intermediaries. +- QUIC between HTTP client and HTTP proxy while TCP is used between HTTP proxy and the HTTP server (see Option#3, clause 6.2.2.1 and clause 6.2.2.3). + +**Editor's Note:** The benefit of using QUIC with HTTP proxy and TCP on the other side is FFS. + +For inter PLMN HTTP/3 messaging, SEPP is involved and the transport connection will have to terminate at SEPP. Hence an NF service consumer at VPLMN need to only consider the transport capabilities of SEPP and not the transport capabilities of the NF service producer in HPLMN. Irrespective of whether the NF service producer in HPLMN supports TCP or QUIC, as long as the NF service consumer in the VPLMN understands the API version of the NF service producer, it uses the transport protocol that it supports towards the SEPP in VPLMN. + +### 8.4.2 Steps to Follow When Introducing NF Services with QUIC Support + +The following steps have to be followed while introducing NF Services with QUIC support in a PLMN. + +- The support for QUIC of the NF services shall be discoverable using one or any of the mechanisms mentioned in clause 8.2. +- Existing, NF service consumers that are already using TCP towards other NF service providers shall continue to use TCP, until they are upgraded to support QUIC. +- NF services that support QUIC, may also support TCP in order to interwork with existing TCP based NF service consumers. + +### 8.4.3 Use of QUIC by NF Service Consumers + +An NF service consumer that supports QUIC can use QUIC towards NF service producers that support QUIC after ensuring the following: + +- The support of QUIC by the NF service producer is discoverable. +- There are no HTTP proxies on path or the HTTP proxy on path supports QUIC and HTTP CONNECT. + +### 8.4.4 Decommissioning TCP + +When all the NF services in a PLMN are upgraded to support QUIC a PLMN may consider to decommission the use of TCP transport. The following steps need to be followed while decommissioning + +- Ensure that no NF service consumer is still using TCP towards the NF service for which TCP is to be decommissioned in that PLMN. +- If TCP is to be decommissioned for use by a SEPP in a PLMN, then ensure that all the other SEPPs it is interacting with support QUIC and there are no IPX on path. + +- No NF service instance in the PLMN is using the solution described in clause 8.2.2 for the discovery of QUIC support. + +It is recommended that TCP is not decommissioned until it is identified that there is no need for it within a PLMN. + +# --- 9 Impacts to Service Based Architecture + +## 9.1 Introduction + +This clause identifies the impacts of introducing QUIC to service based architecture for which solutions can't be provided in 3GPP scope. + +## 9.2 HTTP Proxy Traversal + +As described in clause 6.2, IETF has not yet clearly specified how HTTP/3 works when there are proxies on path. The current drafts only define the use of HTTP CONNECT method from the client to the proxy and TCP thereafter. Hence at least until a solution for the use of hop by hop QUIC when HTTP proxies are involved is well specified in IETF, QUIC cannot be used in deployments where HTTP proxies are acting as intermediaries between NF services. + +**Editor's Note:** Other impacts are FFS. + +**Editor's Note:** Whether a specific action be sent to IETF is FFS. + +## 9.3 QUIC's Security Mechanisms + +QUIC as currently specified do not support any unencrypted mode, nor unauthenticated. This have several implications on the SBA architecture. Some of them have already been touched upon before. + +- There is a requirement (see clause 3.2 of IETF RFC 9114 [7]) of explicitly addressing the QUIC peer when establishing a connection and include the target domain in the TLS handshake using SNI or other mechanism. This prevents any type of transparent HTTP proxies, and the next hop must always be known by the client. +- Use of any HTTP proxy will require additional functionality as discussed in Clause 9.2 and where only the one type of proxying, i.e. the use HTTP Connect method to establish end-to-end TLS connections over TCP from proxy to designated target domain. The other proxy cases discussed in Clause 6 lacks mature specifications. The current implication is that to enable QUIC in Release 16 SBA Architecture needs to be capable of operating without any HTTP proxies. +- Potential use of HTTP opportunistic security (IETF RFC 8164 [28]) for any "http" scheme requests over QUIC. This requires an additional QUIC connection as "http" scheme requests and "https" scheme requests are not allowed in the same connection (see clause 2.2 of IETF RFC 8164 [28]). It also requires additional HTTP server support to indicate this capability. This could enable QUIC migrations even if there are still some SBIs that doesn't support "https" scheme requests. However, if such interfaces exist it would be seurer to upgrade them to support "https" scheme. + +To summarize, with the current version of QUIC and HTTP/3 the 3GPP SBA architecture needs to assume that all requests and SBI will only use "https" scheme requests, that they will explicitly address the target NF, and that there is no possibility to deploy HTTP Proxies or other intermediaries acting above UDP layer in between NFs. + +## 9.4 TCP Decommission in Migration Impacts Architecture + +As discussed in Clause 8.4.4 there are certain requirements to enable decommissioning of TCP in a migration to QUIC. This also have certain architectural impacts. It requires a possibility to perform the first request to any NF using QUIC. The current specifications in IETF are not yet addressing such use cases, instead they assume that one will start with retrieving alt-svc information using HTTP over TCP and TLS. Thus, to support TCP decommission there need to be specified how one instructs a client to use QUIC directly to query without any prior alt-svc phase, primarily to issue requests to the NRF. The NRF can then likely function as solution for learning that QUIC is required for the other NFs. + +## 9.5 Transport Proxy Traversal + +TCP transport proxies may be deployed on the path between HTTP clients and servers in order to optimize transport on heterogeneous networks (e.g. satellite networks). They operate the flows based on TCP headers information without interfering with the HTTPS layer. QUIC breaks this layering as the transport and the HTTPS parts cannot be dissociated. As such the transport optimization proxy function will not be possible with QUIC. + +## 9.6 Impacts on Troubleshooting + +### 9.6.1 Introduction + +This clause aims at highlighting the main impacts of QUIC introduction on maintenance and troubleshooting at network level and application level. + +Indeed, in order to improve end-to-end protection, TLS 1.3 and QUIC enforce the usage of ephemeral cipher suites and Perfect Forward Secrecy (PFS). The latter prevents an attacker that managed somehow to steal the private key of a server from decrypting the content of exchanges she/he captured in the past. In practice, the existing OAM (Operation And Maintenance) solutions which are designed to work for RSA cipher suites would hence not be able to troubleshoot PFS traffic. This clause also details the impacts of using QUIC-based signalling protocol stack between two 5G NFs for the cases introduced in annex E of 3GPP TS 23.501 [2]. + +The following three clauses point out the main identified impacts of QUIC on network level and HTTP/3 level troubleshooting. + +### 9.6.2 QUIC keying impact + +QUIC decryption is per design trickier than TLS, including TLS 1.3, because each QUIC connection has at least 3 keys (0-RTT key, 1-RTT key, packet number encryption key) and also because 1-RTT key may change dynamically. + +### 9.6.3 Network level troubleshooting + +The following impacts are foreseen for network level troubleshooting: + +- QUIC replaces both TLS and TCP. One of the main differences indeed is that QUIC encrypts the transport header in addition to the payload, which is highly relevant for the network level troubleshooting matters. The existing Network OAM (Operation And Maintenance) solutions which are designed to make use and act on TCP headers would hence not be able to troubleshoot QUIC traffic and even less be easily adaptable to perform this task. +- Moreover, QUIC includes an optional measurement bit, named spinbit, which allows in-path probes to measure both the round trip delay and the decomposition of the delay on both sides of symmetrical path. This is directly usable for options A and B for monitoring and troubleshooting the performance of the network between two NFs. Its usage for the options C and D though requires additionally the mapping of the observations on both legs of the SCP. +- As of version 19, QUIC specifications do not support packet loss measurements. Indeed, packet loss measurements by probes located on the path requires multiple probes and has more limited scope, which hence makes it much harder and resource demanding. Its deployability has still to be demonstrated. +- So as to enable an in depth analysis of the performance (e.g. flow control, etc.) between a consumer NF and a producer NF, the decryption of the entire QUIC message is often required in order to read the transport parameters of the QUIC packet header. Contrary to HTTP/2 over TLS, this has the side effect of decrypting and revealing application layer information to network probes. + +NOTE: QUIC level logging techniques are also possible for these purposes but are currently not mature enough and are not yet considered for inclusion in QUIC IETF specifications. + +- As already mentioned, options C and D flow control troubleshooting would also require streams identifiers mapping in order to get an end to end view. + +### 9.6.4 Application level troubleshooting + +The identified impacts on application level troubleshooting are depicted hereinafter for each one of the four communication options defined in annex E of 3GPP TS 23.501 [2]. + +- Option A - Direct communication without NRF interaction: + +Analysing the exchanges between a consumer NF and a producer NF requires the decryption of QUIC traffic. Debugging currently relies on the analysis of the exchanges captured by probes. As QUIC imposes the usage of PFS, the decryption of PFS traffic by a probe requires the communication of the set of session keys to the probe by one of the peers. This would hence increase the complexity of the OAM (Operation And Maintenance) solutions. + +NOTE: TLS 1.3 also mandates the use of PFS. However, the main difference with QUIC / HTTP/3 is that TLS usage is not mandatory in the current version of the specifications for HTTP/2. + +- Option B - Direct communication with NRF interaction; + +Same as option A. + +- Option C - Indirect communication without delegated discovery; + +In this option the signalling path is made of at least two legs and QUIC is hence on at least one side of the SCP. + +- When QUIC is used only in one leg of the communication path, the other side may be HTTP/2 in the clear, HTTP/2 encrypted over TLS or in a hop by hop tunnel like IPsec. When carried over TLS, HTTP/2 can use either TLS 1.2 or TLS 1.3 versions. + +As the signalling path is made of at least two legs, application level troubleshooting by external tools would require the support of the cypher suites in use and the credentials of the two sessions so as to be able to decrypt the messages exchanged and the mapping of QUIC and HTTP/2 stream identifiers. + +- Case where QUIC is used in both legs: + +There is only one version of HTTP/2. Versioning is a feature of QUIC though. Consequently, the application level troubleshooting tools must be able to decode, map and synchronize exchanges of different versions of QUIC. + +- Option D - Indirect communication with delegated discovery. + +Same as option C. + +# --- 10 Current Implementation and Maturity Status + +## 10.1 Introduction + +Being a newly developed transport protocol the viability of considering QUIC in 5GC service based interfaces has to be gauged by the current implementation and maturity status. This clause describes the current stats of QUIC from the best of the knowledge point of the view. + +## 10.2 Implementation maturity + +TCP implementations are very mature. Most of the features has been widely used and issues has been resolved in the implementations and standards. Right now, this cannot be said for QUIC implementations. As the specification has been mainly finished as IETF RFCs, the QUIC implementations are still new. IETF QUIC working group has given lots of emphasis on interoperability testing on QUIC features. Number of opensource projects of implementing QUIC has passed the interoperability testing. However, those opensource projects usually put emphasis on particular features of interest from the implementer hence cannot be treated as production ready or assuming to have all the featured required. + +It is expected that QUIC implementations will have a higher degree of issues caused by mistakes and errors in implementation. + +## 10.3 Hardware offload support + +A server's capability to handle certain amount of load can be improved by having protocol off-load function in network interfaces (NIC). For TCP, this include checksum off-loading, segmentation offloading, and crypto offloading. These functions improve the performance of the server. TCP sending operation's CPU utilization can be reduced 50 times if TCP segmentation offloading (TSO) is used compared to standard TCP configuration. While TCP offload functions are existing and available in numerous NICs, there is significant uncertainty about what functions that are possible to implement for QUIC and according to which road-maps they will be implemented in server hardware. + +When it comes to crypto acceleration via hardware offload there are both large commonalities and differences between TCP and QUIC. Both are based on TLS, but QUICs protection of its frames are using a QUIC specific format, but for modern implementations both are likely to use the same crypto primitives, i.e. most likely AES-GCM (see IETF RFC 5288 [31]) that is highly performant in a number of more capable CPUs due optimized functions. However, any more dedicated crypto off-load may be missing for QUIC. + +There has also been significant discussion in the QUIC working group mailing list about the cost of doing the packet number encryption and decryption. An encrypted packet number requires to be first decrypted before the correct initialization vector for the rest of the packet can be produced. This has been criticized in the QUIC WG for making off-load processing more difficult and require multiple stages. + +## 10.4 UDP Performance in Operating System + +The current QUIC implementation uses UDP socket APIs to send and receive QUIC traffic. Compared to TCP implementation in different operating systems, UDP implementation is not that performant. It has been reported in IETF QUIC working group mailing list that for the UDP send cost the CPU consumption could be up to 50% while crypto operation is less than 10%. Google has also reported that with possible optimization, they were able to reduce QUIC's CPU cost from 3.5 to 2 times that required for TLS/TCP when serving YouTube traffic (see "Developing and deploying a TCP replacement for the Web" [32]). + +Experiments show that a standard TCP configuration gains almost 5x speed-up over UDP in terms of cycle cost (see "Optimizing UDP for content delivery" [33]). Such gains for TCP come from the support of TCP segmentation offload (TSO) that allows the application to send larger data packet than the path Maximum Transmission Unit (MTU). TSO requires hardware support from the NICs. However, Generic Segmentation (GSO) can also perform segmentation to emulate TSO. TCP has support from both TSO and GSO. Recent experiments show promising results for UDP segmentation offloading with hardware support (see "UDP segmentation offload" [34]). UDP GSO is also available for Linux kernel and can be used via interfaces but need extensive configurations and understanding of link layer properties. The TSO operates on sender side and create a specific profile of traffic in the network. Because of that optimization can be achieved at the receiver side by consolidating multiple MTU packet side into fewer large one. Large receive offload (LRO) and generic receive offload (GRO) is used to achieve this optimization for TCP. The same is not available for UDP now. There are reports on work in progress on UDP GRO. To achieve high performance over UDP socket for SBI (some of the SBI message sizes may be large, potentially up to a maximum of 2 MB), different optimized configurations are needed and those optimizations need to be available in different operating system. + +This UDP performance issues can eventually be overcame. There are already several techniques like UDP GSO, GRO (Generic receive offload), zero copy that can help achieving performant UDP operation and networking. As these techniques are at their early stage, the UDP performance issues need to take into consideration when selecting transport protocol for service based interfaces. + +# 11 Evaluation and Conclusion + +## 11.1 Evaluation + +### 11.1.1 Requirements for Service Based Interfaces + +QUIC fulfils the transport requirements (REQ#1 to REQ#5) identified in clause 5.2 for the 5GC Service Based Interfaces. + +Using HTTP/3 instead of HTTP/2 does not change the semantics of the NF Services and does not change the API. No changes are expected either on the OpenAPI specification to support HTTP/3. + +Further study would be needed to define how to support Indirect Communication in the 5GC with Service Communication Proxies (SCP), but preliminary it seems the CONNECT UDP method and MASQUE proxy functionality [36] allows tunnelling through proxies. + +### 11.1.2 Expected improvements + +Clause 5.4 identifies features of QUIC (HTTP/3) that would be applicable to the 5GC Service Based Interfaces; the following potential (performance) improvements are anticipated in comparison to HTTP/2: + +- 1) QUIC allows to overcome HOL blocking from which HTTP/2 is suffering if a TCP packet is lost or becomes corrupted; +- 2) loss detection mechanisms of QUIC are using more accurate means to indicate lost bytes and RTT measurements resulting in assumedly more efficient recovery mechanism; +- 3) faster connection establishment compared to TLS/TCP (1 RTT instead of 2), for short lived connections; however, when using persistent connections, this will not lead to a performance improvement; +- 4) the connection may be migrated to a different network interface or local address by the client during the lifetime of the connection or by the server during the connection establishment. + +### 11.1.3 Issues + +Following issues are identified: + +- 1) The QUIC layer is end-to-end encrypted and use of proxies between end-to-end QUIC connections is not sufficiently covered. There is no support for instance to support an end-to-end QUIC connection through a proxy using HTTP CONNECT. But the CONNECT UDP method and MASQUE proxy functionality [36] allows an HTTP client to create a tunnel for UDP communications through an HTTP server that acts as a proxy and this is defined also for the HTTP/3 Requests. +- 2) The QUIC layer is end-to-end encrypted and thus allows less accurate network monitoring capabilities than TCP. The Spin bit allows a limited passive connection observation as described in IETF RFC 9000 [5]. +- 3) The server cannot migrate the connection to a different network interface / local address during the lifetime of the connection; this requires clients to still rely on alternate QUIC connections for failover to an alternate path; also solutions for ensuring availability and stability of connections (e.g. failover to a secondary path like supported in SCTP multi-homing) are not provided at the QUIC protocol layer but have to be implemented at the application layer similar to HTTP/2. The Multipath QUIC will potentially enable some of these functions, as explained in IETF draft-ietf-quic-multipath-04 [37]. +- 4) IETF RFC 9002 [8] provides recommendations on congestion control (e.g. TCP NewReno). According to that, implementations may use other congestion control algorithms than TCP NewReno and endpoints MAY use different algorithms from one another. Some measurements have shown that QUIC can overtake TCP in terms of how much bandwidth it can take leading to unfairness even if the congestion algorithm is the same (see e.g. "Taking a Long Look at QUIC" [30]). This leads to possible concerns on how fairly QUIC traffic mixes with TCP traffic, as this would be the case e.g. during migration scenarios (see clause 8.4). According to RFC 9002 [8] QUIC does allow faster iteration of changes in congestion control (compared to TCP), which can lead + +to unfairness in some cases. The issue becomes more complicated when mixing different congestion algorithms and deserves more experimentation. In case this becomes an issue in the network deployments, the related algorithms can be evolved and improved easily and faster (due to QUIC implementation runs on user space). + +### 11.1.4 Other considerations + +Following considerations also apply: + +- 1) QUIC (HTTP/3) requires extensive changes to the HTTP protocol stack (compared to HTTP/2), by moving and combining several features from the HTTP/3 and TLS layers into the QUIC layer. The header compression mechanism is re-designed to support out-of-order delivery. The application is also impacted, e.g. socket APIs of the HTTP layer, discovery of QUIC support, co-existence of HTTP/2 and HTTP/3 capable NFs. +- 2) QUIC (HTTP/3) security aspects need to be assessed by 3GPP SA3, e.g. options exist for connection establishment and connection migration, end to end security with proxies on the path, inter-PLMN signalling and N32 interface, use of OAuth with QUIC, etc. +- 3) Even though the definition of HTTP/3 and QUIC have proceeded to RFCs in IETF, the inputs from the field deployment best practices, concerning system optimization are not mature enough for adoption of the protocol in the 5GC for 5G-Advanced; +- 4) It is open when industry grade stacks (for use in 5GC) will be available. Existing implementations of QUIC are still immature and do not have the full QUIC features available (e.g. congestion control). +- 5) Due to experimental nature of current implementations there are yet no reference API which would be required for application level interoperability. The current existing implementations allow only basic proof of concepts testing but not load or stress testing of different features. +- 6) There are no standard APIs (e.g. socket APIs) for QUIC connection setup. Though there are different open source implementations of QUIC, there is a lack of uniformity in terms of the interface they expose towards application for QUIC connection setup and hence as of now implementation portability is a concern. Currently no QUIC API definition is included in the IETF QUIC WG charter. + +## 11.2 Conclusion + +QUIC provides some new promising features especially in terms of performance increase for current Internet type of traffic (web-based client-server). It should be carefully checked whether those improvements can also be harvested in 5G signalling environment. Intensive testing, however, is only possible when HTTP/3 and QUIC specifications and implementations are mature enough (see clauses 10 and 11.1 for the current implementation and maturity status). Therefore, the finalization of the work on QUIC major RFCs at IETF in May 2021 can only be considered as a first step in the evaluation of the feasibility of HTTP/3 (QUIC) for 5G control plane. + +How to support HTTP/3 (QUIC) for indirect communications via SCP (enhanced Service Based Architecture specified in 3GPP Release 16) would need to be further studied. + +Supporting QUIC (HTTP/3) for 5G control plane would cause extensive efforts (standardization efforts in 3GPP to finalize the study also including SA3 involvement and do corresponding normative work, changes to 5GC NFs implementations, testing), cause disruption to existing deployments based on HTTP/2, complicate interoperability (multiple HTTP versions, risks on implementation maturity). Besides, there is no evidence yet that HTTP/3 would bring significant performance improvements to 5GC signaling justifying these efforts. The low number of companies' contributions to the current 3GPP TR over the past years is also an indication of a limited interest in moving this work forward for the 5GC. + +It is therefore recommended to not consider HTTP/3 (QUIC) as a basis for 5GC control plane signalling. + +# --- Annex A (informative): HTTP/2 vs. HTTP/3 testing findings and considerations + +QUIC can achieve the same computational efficiency as TCP+TLS1.3 once various protocol mechanisms and system optimizations are in use [38]. The referred study was comparing only the transports used for HTTP versions, but the + +application (HTTP) part was excluded. In principle, the used transport protocol should not limit either HTTP versions by setting the hard caps due to transport specific issues. Relevant mechanisms and optimizations used in the microbenchmark includes delayed ACK [39], GSO (Generic Segmentation Offload) and the used MTU. Without any additional mechanisms or optimizations, QUIC performed over 2x better than TCP+TLS1.3, but in the real field deployments the optimizations for QUIC are not yet in place and this typically turns this performance relation to opposite figures. + +The authors of [40] concluded that most performance discrepancies are a result of the developer's design or the operator's configuration, which include topics, such as congestion control, flow control, handling of multiple streams, packet size/MTU, and client validation of the 0-RTT function. + +For video streaming [41], QUIC transport resulted 8% less errors in video requests and this could be one sign of QUIC's more resilience against HoL blockings. + +Based on the measurements in [42], 0-RTT support yields a bit over 10% better time to first byte for HTTP/3 compared to HTTP/2, which lacks the support. In the same tests, variable results where sometimes HTTP/3 did perform better and vice versa. + +Performance measurement is highly use case dependent, i.e., traffic profiles/patterns are stemming from there, and for HTTP/2, this is shown clearly by this study [43]. + +For a single resource or a small file size transmitting, the QUIC implementations outperformed TCP ones (due to improved handshaking among other things), but once the amount of transmitted data increases, the performance of both transport protocols is getting similar. For HTTP, there are also other things impacting to the overall performance and that is how resource prioritization is used as shown in [44]. Again, this emphasizes the use case dependency and most of the available performance tests are based on web browsing from public sources where typically small, medium or large amount of resources were downloaded as a single HTTP page request. One of the main KPIs measured, was the serving time of HTTP request and/or time to first byte. + +In HTTP/2, the sources of the Head-of-Line (HOL) Blocking can stem from different layers like TCP and TLS. HTTP/3 (QUIC) supports stream-awareness in transport layer, which improves the performance when one stream cannot block another one. However the QUIC's HOL blocking prevention only works if there are multiple resource streams active at the same time [45]. The improved tolerance against HOL Blocking and even the 0-RTT based connection re-establishment benefit the HTTP/3 (over the HTTP/2), but these benefits start to have the practical impact(s) with worsening networking conditions and the existence of such conditions is questionable in the closed and well-engineered 5G core signalling network. + +# Annex B: Change history + +| Change history | | | | | | | | +|----------------|--------------|-----------|----|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-07 | CT4#85bis | C4-185419 | | | | Implementation of C4-185047 (TR skeleton), C4-185420, C4-185231, C4-185421, C4-185500 and C4-185499 | 0.1.0 | +| 2018-08 | CT4#86 | C4-186339 | | | | Implementation of C4-186508 and C4-186155 agreed in CT4#86 | 0.2.0 | +| 2018-10 | CT4#86bis | C4-187646 | | | | Implementation of C4-187530, C4-187531, C4-187602, C4-187533, C4-187603, C4-187535 and C4-187536 agreed in CT4#86bis. | 0.3.0 | +| 2018-12 | CT4#87 | C4-188698 | | | | Implementation of C4-188588 and C4-188589 agreed in CT4#87 | 0.4.0 | +| 2019-03 | CT4#89 | C4-190635 | | | | Implementation of C4-190595, C4-190511, C4-190512, C4-190513, C4-190514, C4-190515, C4-190516, C4-190204 and C4-190205 agreed in CT4#89. | 0.5.0 | +| 2019-03 | CT#83 | CP-190050 | | | | Presented for information | 1.0.0 | +| 2019-04 | CT4#90 | C4-191345 | | | | General Cleanup | 1.1.0 | +| 2019-06 | CT4#91 | C4-192375 | | | | QUIC impacts on transport proxy traversal | 1.2.0 | +| 2019-06 | CT4#91 | C4-192376 | | | | Impacts of QUIC on Troubleshooting | 1.2.0 | +| 2020-03 | CT4#96E | C4-201161 | | | | Additional requirements for Transport Protocol | 1.3.0 | +| 2020-03 | CT4#96E | C4-201164 | | | | Update of QUIC features | 1.3.0 | +| 2020-06 | CT4#98E | C4-203159 | | | | Interim Conclusion on HTTP/3 (QUIC) | 1.4.0 | +| 2020-06 | CT4#98E | C4-203532 | | | | Architectural baseline requirements update | 1.4.0 | +| 2020-06 | CT4#98E | C4-203577 | | | | MASQUE | 1.4.0 | +| 2020-09 | CT4#99E | C4-204161 | | | | Update of the references | 1.5.0 | +| 2020-11 | CT4#101E | C4-205074 | | | | Miscellaneous corrections | 1.6.0 | +| 2021-02 | CT4#101bis-E | C4-210157 | | | | Clarifications to the basic HTTP/3 notions | 1.7.0 | +| 2023-08 | CT4#117 | C4-233153 | | | | HTTP/3 implementation maturity and conclusion update | 1.8.0 | +| 2023-08 | CT4#117 | C4-233479 | | | | HTTP/2 vs. HTTP/3 testing findings and considerations | 1.8.0 | +| 2023-08 | CT4#117 | C4-233496 | | | | QUIC IETF RFC references update | 1.8.0 | +| 2023-09 | CT#101 | CP-232024 | | | | TR Presented for approval | 2.0.0 | +| 2023-09 | CT#101 | | | | | TR Approved | 18.0.0 | \ No newline at end of file